Class ExternalContactsApi

java.lang.Object
com.mypurecloud.sdk.v2.api.ExternalContactsApi

public class ExternalContactsApi extends Object
  • Constructor Details

    • ExternalContactsApi

      public ExternalContactsApi()
    • ExternalContactsApi

      public ExternalContactsApi(ApiClient apiClient)
  • Method Details

    • deleteExternalcontactsContact

      public Empty deleteExternalcontactsContact(String contactId) throws IOException, ApiException
      Delete an external contact
      Parameters:
      contactId - ExternalContact ID (required)
      Returns:
      Empty
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteExternalcontactsContactWithHttpInfo

      public ApiResponse<Empty> deleteExternalcontactsContactWithHttpInfo(String contactId) throws IOException
      Delete an external contact
      Parameters:
      contactId - ExternalContact ID (required)
      Returns:
      Empty
      Throws:
      IOException - if the request fails to be processed
    • deleteExternalcontactsContact

      public Empty deleteExternalcontactsContact(DeleteExternalcontactsContactRequest request) throws IOException, ApiException
      Delete an external contact
      Parameters:
      request - The request object
      Returns:
      Empty
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteExternalcontactsContact

      public ApiResponse<Empty> deleteExternalcontactsContact(ApiRequest<Void> request) throws IOException
      Delete an external contact
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • deleteExternalcontactsContactNote

      public Empty deleteExternalcontactsContactNote(String contactId, String noteId) throws IOException, ApiException
      Delete a note for an external contact
      Parameters:
      contactId - ExternalContact Id (required)
      noteId - Note Id (required)
      Returns:
      Empty
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteExternalcontactsContactNoteWithHttpInfo

      public ApiResponse<Empty> deleteExternalcontactsContactNoteWithHttpInfo(String contactId, String noteId) throws IOException
      Delete a note for an external contact
      Parameters:
      contactId - ExternalContact Id (required)
      noteId - Note Id (required)
      Returns:
      Empty
      Throws:
      IOException - if the request fails to be processed
    • deleteExternalcontactsContactNote

      public Empty deleteExternalcontactsContactNote(DeleteExternalcontactsContactNoteRequest request) throws IOException, ApiException
      Delete a note for an external contact
      Parameters:
      request - The request object
      Returns:
      Empty
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteExternalcontactsContactNote

      public ApiResponse<Empty> deleteExternalcontactsContactNote(ApiRequest<Void> request) throws IOException
      Delete a note for an external contact
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • deleteExternalcontactsContactsSchema

      public void deleteExternalcontactsContactsSchema(String schemaId) throws IOException, ApiException
      Delete a schema
      Parameters:
      schemaId - Schema ID (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteExternalcontactsContactsSchemaWithHttpInfo

      public ApiResponse<Void> deleteExternalcontactsContactsSchemaWithHttpInfo(String schemaId) throws IOException
      Delete a schema
      Parameters:
      schemaId - Schema ID (required)
      Throws:
      IOException - if the request fails to be processed
    • deleteExternalcontactsContactsSchema

      public void deleteExternalcontactsContactsSchema(DeleteExternalcontactsContactsSchemaRequest request) throws IOException, ApiException
      Delete a schema
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteExternalcontactsContactsSchema

      public ApiResponse<Void> deleteExternalcontactsContactsSchema(ApiRequest<Void> request) throws IOException
      Delete a schema
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • deleteExternalcontactsExternalsource

      public Empty deleteExternalcontactsExternalsource(String externalSourceId) throws IOException, ApiException
      Delete an External Source. WARNING: Any records that reference this External Source will not be automatically cleaned up. Those records will still be editable, but their External IDs may not be fully viewable.
      Parameters:
      externalSourceId - External Source ID (required)
      Returns:
      Empty
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteExternalcontactsExternalsourceWithHttpInfo

      public ApiResponse<Empty> deleteExternalcontactsExternalsourceWithHttpInfo(String externalSourceId) throws IOException
      Delete an External Source. WARNING: Any records that reference this External Source will not be automatically cleaned up. Those records will still be editable, but their External IDs may not be fully viewable.
      Parameters:
      externalSourceId - External Source ID (required)
      Returns:
      Empty
      Throws:
      IOException - if the request fails to be processed
    • deleteExternalcontactsExternalsource

      public Empty deleteExternalcontactsExternalsource(DeleteExternalcontactsExternalsourceRequest request) throws IOException, ApiException
      Delete an External Source. WARNING: Any records that reference this External Source will not be automatically cleaned up. Those records will still be editable, but their External IDs may not be fully viewable.
      Parameters:
      request - The request object
      Returns:
      Empty
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteExternalcontactsExternalsource

      public ApiResponse<Empty> deleteExternalcontactsExternalsource(ApiRequest<Void> request) throws IOException
      Delete an External Source. WARNING: Any records that reference this External Source will not be automatically cleaned up. Those records will still be editable, but their External IDs may not be fully viewable.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • deleteExternalcontactsImportCsvSetting

      public void deleteExternalcontactsImportCsvSetting(String settingsId) throws IOException, ApiException
      Delete settings for CSV import
      Parameters:
      settingsId - Settings id (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteExternalcontactsImportCsvSettingWithHttpInfo

      public ApiResponse<Void> deleteExternalcontactsImportCsvSettingWithHttpInfo(String settingsId) throws IOException
      Delete settings for CSV import
      Parameters:
      settingsId - Settings id (required)
      Throws:
      IOException - if the request fails to be processed
    • deleteExternalcontactsImportCsvSetting

      public void deleteExternalcontactsImportCsvSetting(DeleteExternalcontactsImportCsvSettingRequest request) throws IOException, ApiException
      Delete settings for CSV import
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteExternalcontactsImportCsvSetting

      public ApiResponse<Void> deleteExternalcontactsImportCsvSetting(ApiRequest<Void> request) throws IOException
      Delete settings for CSV import
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • deleteExternalcontactsImportSetting

      public void deleteExternalcontactsImportSetting(String settingsId) throws IOException, ApiException
      Delete Settings
      Parameters:
      settingsId - Settings id (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteExternalcontactsImportSettingWithHttpInfo

      public ApiResponse<Void> deleteExternalcontactsImportSettingWithHttpInfo(String settingsId) throws IOException
      Delete Settings
      Parameters:
      settingsId - Settings id (required)
      Throws:
      IOException - if the request fails to be processed
    • deleteExternalcontactsImportSetting

      public void deleteExternalcontactsImportSetting(DeleteExternalcontactsImportSettingRequest request) throws IOException, ApiException
      Delete Settings
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteExternalcontactsImportSetting

      public ApiResponse<Void> deleteExternalcontactsImportSetting(ApiRequest<Void> request) throws IOException
      Delete Settings
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • deleteExternalcontactsOrganization

      public Empty deleteExternalcontactsOrganization(String externalOrganizationId) throws IOException, ApiException
      Delete an external organization
      Parameters:
      externalOrganizationId - External Organization ID (required)
      Returns:
      Empty
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteExternalcontactsOrganizationWithHttpInfo

      public ApiResponse<Empty> deleteExternalcontactsOrganizationWithHttpInfo(String externalOrganizationId) throws IOException
      Delete an external organization
      Parameters:
      externalOrganizationId - External Organization ID (required)
      Returns:
      Empty
      Throws:
      IOException - if the request fails to be processed
    • deleteExternalcontactsOrganization

      public Empty deleteExternalcontactsOrganization(DeleteExternalcontactsOrganizationRequest request) throws IOException, ApiException
      Delete an external organization
      Parameters:
      request - The request object
      Returns:
      Empty
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteExternalcontactsOrganization

      public ApiResponse<Empty> deleteExternalcontactsOrganization(ApiRequest<Void> request) throws IOException
      Delete an external organization
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • deleteExternalcontactsOrganizationNote

      public Empty deleteExternalcontactsOrganizationNote(String externalOrganizationId, String noteId) throws IOException, ApiException
      Delete a note for an external organization
      Parameters:
      externalOrganizationId - External Organization Id (required)
      noteId - Note Id (required)
      Returns:
      Empty
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteExternalcontactsOrganizationNoteWithHttpInfo

      public ApiResponse<Empty> deleteExternalcontactsOrganizationNoteWithHttpInfo(String externalOrganizationId, String noteId) throws IOException
      Delete a note for an external organization
      Parameters:
      externalOrganizationId - External Organization Id (required)
      noteId - Note Id (required)
      Returns:
      Empty
      Throws:
      IOException - if the request fails to be processed
    • deleteExternalcontactsOrganizationNote

      public Empty deleteExternalcontactsOrganizationNote(DeleteExternalcontactsOrganizationNoteRequest request) throws IOException, ApiException
      Delete a note for an external organization
      Parameters:
      request - The request object
      Returns:
      Empty
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteExternalcontactsOrganizationNote

      public ApiResponse<Empty> deleteExternalcontactsOrganizationNote(ApiRequest<Void> request) throws IOException
      Delete a note for an external organization
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • deleteExternalcontactsOrganizationTrustor

      public void deleteExternalcontactsOrganizationTrustor(String externalOrganizationId) throws IOException, ApiException
      Unlink the Trustor for this External Organization
      Parameters:
      externalOrganizationId - External Organization ID (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteExternalcontactsOrganizationTrustorWithHttpInfo

      public ApiResponse<Void> deleteExternalcontactsOrganizationTrustorWithHttpInfo(String externalOrganizationId) throws IOException
      Unlink the Trustor for this External Organization
      Parameters:
      externalOrganizationId - External Organization ID (required)
      Throws:
      IOException - if the request fails to be processed
    • deleteExternalcontactsOrganizationTrustor

      public void deleteExternalcontactsOrganizationTrustor(DeleteExternalcontactsOrganizationTrustorRequest request) throws IOException, ApiException
      Unlink the Trustor for this External Organization
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteExternalcontactsOrganizationTrustor

      public ApiResponse<Void> deleteExternalcontactsOrganizationTrustor(ApiRequest<Void> request) throws IOException
      Unlink the Trustor for this External Organization
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • deleteExternalcontactsRelationship

      public Empty deleteExternalcontactsRelationship(String relationshipId) throws IOException, ApiException
      Delete a relationship
      Parameters:
      relationshipId - Relationship Id (required)
      Returns:
      Empty
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteExternalcontactsRelationshipWithHttpInfo

      public ApiResponse<Empty> deleteExternalcontactsRelationshipWithHttpInfo(String relationshipId) throws IOException
      Delete a relationship
      Parameters:
      relationshipId - Relationship Id (required)
      Returns:
      Empty
      Throws:
      IOException - if the request fails to be processed
    • deleteExternalcontactsRelationship

      public Empty deleteExternalcontactsRelationship(DeleteExternalcontactsRelationshipRequest request) throws IOException, ApiException
      Delete a relationship
      Parameters:
      request - The request object
      Returns:
      Empty
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteExternalcontactsRelationship

      public ApiResponse<Empty> deleteExternalcontactsRelationship(ApiRequest<Void> request) throws IOException
      Delete a relationship
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getExternalcontactsContact

      public ExternalContact getExternalcontactsContact(String contactId, List<String> expand) throws IOException, ApiException
      Fetch an external contact
      Parameters:
      contactId - ExternalContact ID (required)
      expand - which fields, if any, to expand (optional)
      Returns:
      ExternalContact
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getExternalcontactsContactWithHttpInfo

      public ApiResponse<ExternalContact> getExternalcontactsContactWithHttpInfo(String contactId, List<String> expand) throws IOException
      Fetch an external contact
      Parameters:
      contactId - ExternalContact ID (required)
      expand - which fields, if any, to expand (optional)
      Returns:
      ExternalContact
      Throws:
      IOException - if the request fails to be processed
    • getExternalcontactsContact

      public ExternalContact getExternalcontactsContact(GetExternalcontactsContactRequest request) throws IOException, ApiException
      Fetch an external contact
      Parameters:
      request - The request object
      Returns:
      ExternalContact
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getExternalcontactsContact

      public ApiResponse<ExternalContact> getExternalcontactsContact(ApiRequest<Void> request) throws IOException
      Fetch an external contact
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getExternalcontactsContactIdentifiers

      public ContactIdentifierListing getExternalcontactsContactIdentifiers(String contactId) throws IOException, ApiException
      List the identifiers for a contact
      Parameters:
      contactId - ExternalContact ID (required)
      Returns:
      ContactIdentifierListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getExternalcontactsContactIdentifiersWithHttpInfo

      public ApiResponse<ContactIdentifierListing> getExternalcontactsContactIdentifiersWithHttpInfo(String contactId) throws IOException
      List the identifiers for a contact
      Parameters:
      contactId - ExternalContact ID (required)
      Returns:
      ContactIdentifierListing
      Throws:
      IOException - if the request fails to be processed
    • getExternalcontactsContactIdentifiers

      public ContactIdentifierListing getExternalcontactsContactIdentifiers(GetExternalcontactsContactIdentifiersRequest request) throws IOException, ApiException
      List the identifiers for a contact
      Parameters:
      request - The request object
      Returns:
      ContactIdentifierListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getExternalcontactsContactIdentifiers

      public ApiResponse<ContactIdentifierListing> getExternalcontactsContactIdentifiers(ApiRequest<Void> request) throws IOException
      List the identifiers for a contact
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getExternalcontactsContactJourneySegments

      public SegmentAssignmentListing getExternalcontactsContactJourneySegments(String contactId, Boolean includeMerged, Integer limit) throws IOException, ApiException
      Retrieve segment assignments by external contact ID.
      Parameters:
      contactId - ExternalContact ID (required)
      includeMerged - Indicates whether to return segment assignments from all external contacts in the merge-set of the given one. (optional)
      limit - Number of entities to return. Default of 25, maximum of 500. (optional)
      Returns:
      SegmentAssignmentListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getExternalcontactsContactJourneySegmentsWithHttpInfo

      public ApiResponse<SegmentAssignmentListing> getExternalcontactsContactJourneySegmentsWithHttpInfo(String contactId, Boolean includeMerged, Integer limit) throws IOException
      Retrieve segment assignments by external contact ID.
      Parameters:
      contactId - ExternalContact ID (required)
      includeMerged - Indicates whether to return segment assignments from all external contacts in the merge-set of the given one. (optional)
      limit - Number of entities to return. Default of 25, maximum of 500. (optional)
      Returns:
      SegmentAssignmentListing
      Throws:
      IOException - if the request fails to be processed
    • getExternalcontactsContactJourneySegments

      public SegmentAssignmentListing getExternalcontactsContactJourneySegments(GetExternalcontactsContactJourneySegmentsRequest request) throws IOException, ApiException
      Retrieve segment assignments by external contact ID.
      Parameters:
      request - The request object
      Returns:
      SegmentAssignmentListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getExternalcontactsContactJourneySegments

      public ApiResponse<SegmentAssignmentListing> getExternalcontactsContactJourneySegments(ApiRequest<Void> request) throws IOException
      Retrieve segment assignments by external contact ID.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getExternalcontactsContactJourneySessions

      public SessionListing getExternalcontactsContactJourneySessions(String contactId, String pageSize, String after, Boolean includeMerged) throws IOException, ApiException
      Retrieve all sessions for a given external contact.
      Parameters:
      contactId - ExternalContact ID (required)
      pageSize - Number of entities to return. Maximum of 200. (optional)
      after - The cursor that points to the end of the set of entities that has been returned. (optional)
      includeMerged - Indicates whether to return sessions from all external contacts in the merge-set of the given one. (optional)
      Returns:
      SessionListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getExternalcontactsContactJourneySessionsWithHttpInfo

      public ApiResponse<SessionListing> getExternalcontactsContactJourneySessionsWithHttpInfo(String contactId, String pageSize, String after, Boolean includeMerged) throws IOException
      Retrieve all sessions for a given external contact.
      Parameters:
      contactId - ExternalContact ID (required)
      pageSize - Number of entities to return. Maximum of 200. (optional)
      after - The cursor that points to the end of the set of entities that has been returned. (optional)
      includeMerged - Indicates whether to return sessions from all external contacts in the merge-set of the given one. (optional)
      Returns:
      SessionListing
      Throws:
      IOException - if the request fails to be processed
    • getExternalcontactsContactJourneySessions

      public SessionListing getExternalcontactsContactJourneySessions(GetExternalcontactsContactJourneySessionsRequest request) throws IOException, ApiException
      Retrieve all sessions for a given external contact.
      Parameters:
      request - The request object
      Returns:
      SessionListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getExternalcontactsContactJourneySessions

      public ApiResponse<SessionListing> getExternalcontactsContactJourneySessions(ApiRequest<Void> request) throws IOException
      Retrieve all sessions for a given external contact.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getExternalcontactsContactNote

      public Note getExternalcontactsContactNote(String contactId, String noteId, List<String> expand) throws IOException, ApiException
      Fetch a note for an external contact
      Parameters:
      contactId - ExternalContact Id (required)
      noteId - Note Id (required)
      expand - which fields, if any, to expand (optional)
      Returns:
      Note
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getExternalcontactsContactNoteWithHttpInfo

      public ApiResponse<Note> getExternalcontactsContactNoteWithHttpInfo(String contactId, String noteId, List<String> expand) throws IOException
      Fetch a note for an external contact
      Parameters:
      contactId - ExternalContact Id (required)
      noteId - Note Id (required)
      expand - which fields, if any, to expand (optional)
      Returns:
      Note
      Throws:
      IOException - if the request fails to be processed
    • getExternalcontactsContactNote

      public Note getExternalcontactsContactNote(GetExternalcontactsContactNoteRequest request) throws IOException, ApiException
      Fetch a note for an external contact
      Parameters:
      request - The request object
      Returns:
      Note
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getExternalcontactsContactNote

      public ApiResponse<Note> getExternalcontactsContactNote(ApiRequest<Void> request) throws IOException
      Fetch a note for an external contact
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getExternalcontactsContactNotes

      public NoteListing getExternalcontactsContactNotes(String contactId, Integer pageSize, Integer pageNumber, String sortOrder, List<String> expand) throws IOException, ApiException
      List notes for an external contact
      Parameters:
      contactId - ExternalContact Id (required)
      pageSize - Page size (limited to fetching first 1,000 records; pageSize <= 100; pageNumber * pageSize must be <= 1,000) (optional, default to 20)
      pageNumber - Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) (optional, default to 1)
      sortOrder - The Note field to sort by. Any of: [createDate]. Direction: [asc, desc]. e.g. \"createDate:asc\", \"createDate:desc\" (optional)
      expand - which fields, if any, to expand. mergeset will include notes attached to ancestor contacts which have been merged into this one. (optional)
      Returns:
      NoteListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getExternalcontactsContactNotesWithHttpInfo

      public ApiResponse<NoteListing> getExternalcontactsContactNotesWithHttpInfo(String contactId, Integer pageSize, Integer pageNumber, String sortOrder, List<String> expand) throws IOException
      List notes for an external contact
      Parameters:
      contactId - ExternalContact Id (required)
      pageSize - Page size (limited to fetching first 1,000 records; pageSize <= 100; pageNumber * pageSize must be <= 1,000) (optional, default to 20)
      pageNumber - Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) (optional, default to 1)
      sortOrder - The Note field to sort by. Any of: [createDate]. Direction: [asc, desc]. e.g. \"createDate:asc\", \"createDate:desc\" (optional)
      expand - which fields, if any, to expand. mergeset will include notes attached to ancestor contacts which have been merged into this one. (optional)
      Returns:
      NoteListing
      Throws:
      IOException - if the request fails to be processed
    • getExternalcontactsContactNotes

      public NoteListing getExternalcontactsContactNotes(GetExternalcontactsContactNotesRequest request) throws IOException, ApiException
      List notes for an external contact
      Parameters:
      request - The request object
      Returns:
      NoteListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getExternalcontactsContactNotes

      public ApiResponse<NoteListing> getExternalcontactsContactNotes(ApiRequest<Void> request) throws IOException
      List notes for an external contact
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getExternalcontactsContactUnresolved

      public ExternalContact getExternalcontactsContactUnresolved(String contactId, List<String> expand) throws IOException, ApiException
      Fetch an unresolved external contact
      Parameters:
      contactId - ExternalContact ID (required)
      expand - which fields, if any, to expand (optional)
      Returns:
      ExternalContact
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getExternalcontactsContactUnresolvedWithHttpInfo

      public ApiResponse<ExternalContact> getExternalcontactsContactUnresolvedWithHttpInfo(String contactId, List<String> expand) throws IOException
      Fetch an unresolved external contact
      Parameters:
      contactId - ExternalContact ID (required)
      expand - which fields, if any, to expand (optional)
      Returns:
      ExternalContact
      Throws:
      IOException - if the request fails to be processed
    • getExternalcontactsContactUnresolved

      public ExternalContact getExternalcontactsContactUnresolved(GetExternalcontactsContactUnresolvedRequest request) throws IOException, ApiException
      Fetch an unresolved external contact
      Parameters:
      request - The request object
      Returns:
      ExternalContact
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getExternalcontactsContactUnresolved

      public ApiResponse<ExternalContact> getExternalcontactsContactUnresolved(ApiRequest<Void> request) throws IOException
      Fetch an unresolved external contact
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getExternalcontactsContacts

      public ContactListing getExternalcontactsContacts(Integer pageSize, Integer pageNumber, String q, String sortOrder, List<String> expand, List<String> divisionIds) throws IOException, ApiException
      Search for external contacts
      Parameters:
      pageSize - Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) (optional, default to 20)
      pageNumber - Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) (optional, default to 1)
      q - User supplied search keywords (no special syntax is currently supported) (optional)
      sortOrder - The External Contact field to sort by. Any of: [firstName, lastName, middleName, title]. Direction: [asc, desc]. e.g. \"firstName:asc\", \"title:desc\" (optional)
      expand - which fields, if any, to expand (optional)
      divisionIds - which divisions to search, up to 50 (optional)
      Returns:
      ContactListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getExternalcontactsContactsWithHttpInfo

      public ApiResponse<ContactListing> getExternalcontactsContactsWithHttpInfo(Integer pageSize, Integer pageNumber, String q, String sortOrder, List<String> expand, List<String> divisionIds) throws IOException
      Search for external contacts
      Parameters:
      pageSize - Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) (optional, default to 20)
      pageNumber - Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) (optional, default to 1)
      q - User supplied search keywords (no special syntax is currently supported) (optional)
      sortOrder - The External Contact field to sort by. Any of: [firstName, lastName, middleName, title]. Direction: [asc, desc]. e.g. \"firstName:asc\", \"title:desc\" (optional)
      expand - which fields, if any, to expand (optional)
      divisionIds - which divisions to search, up to 50 (optional)
      Returns:
      ContactListing
      Throws:
      IOException - if the request fails to be processed
    • getExternalcontactsContacts

      public ContactListing getExternalcontactsContacts(GetExternalcontactsContactsRequest request) throws IOException, ApiException
      Search for external contacts
      Parameters:
      request - The request object
      Returns:
      ContactListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getExternalcontactsContacts

      public ApiResponse<ContactListing> getExternalcontactsContacts(ApiRequest<Void> request) throws IOException
      Search for external contacts
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getExternalcontactsContactsExport

      public ContactsExport getExternalcontactsContactsExport(String exportId) throws IOException, ApiException
      Get export for exportId
      Parameters:
      exportId - Export id (required)
      Returns:
      ContactsExport
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getExternalcontactsContactsExportWithHttpInfo

      public ApiResponse<ContactsExport> getExternalcontactsContactsExportWithHttpInfo(String exportId) throws IOException
      Get export for exportId
      Parameters:
      exportId - Export id (required)
      Returns:
      ContactsExport
      Throws:
      IOException - if the request fails to be processed
    • getExternalcontactsContactsExport

      public ContactsExport getExternalcontactsContactsExport(GetExternalcontactsContactsExportRequest request) throws IOException, ApiException
      Get export for exportId
      Parameters:
      request - The request object
      Returns:
      ContactsExport
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getExternalcontactsContactsExport

      public ApiResponse<ContactsExport> getExternalcontactsContactsExport(ApiRequest<Void> request) throws IOException
      Get export for exportId
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getExternalcontactsContactsExports

      public ContactsExportListing getExternalcontactsContactsExports(List<String> divisionIds, String after, Integer pageSize) throws IOException, ApiException
      List exports for organization
      Parameters:
      divisionIds - Division IDs of entities (optional)
      after - The cursor that points to the end of the set of entities (optional)
      pageSize - Number of entities to return (optional)
      Returns:
      ContactsExportListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getExternalcontactsContactsExportsWithHttpInfo

      public ApiResponse<ContactsExportListing> getExternalcontactsContactsExportsWithHttpInfo(List<String> divisionIds, String after, Integer pageSize) throws IOException
      List exports for organization
      Parameters:
      divisionIds - Division IDs of entities (optional)
      after - The cursor that points to the end of the set of entities (optional)
      pageSize - Number of entities to return (optional)
      Returns:
      ContactsExportListing
      Throws:
      IOException - if the request fails to be processed
    • getExternalcontactsContactsExports

      public ContactsExportListing getExternalcontactsContactsExports(GetExternalcontactsContactsExportsRequest request) throws IOException, ApiException
      List exports for organization
      Parameters:
      request - The request object
      Returns:
      ContactsExportListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getExternalcontactsContactsExports

      public ApiResponse<ContactsExportListing> getExternalcontactsContactsExports(ApiRequest<Void> request) throws IOException
      List exports for organization
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getExternalcontactsContactsSchema

      public DataSchema getExternalcontactsContactsSchema(String schemaId) throws IOException, ApiException
      Get a schema
      Parameters:
      schemaId - Schema ID (required)
      Returns:
      DataSchema
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getExternalcontactsContactsSchemaWithHttpInfo

      public ApiResponse<DataSchema> getExternalcontactsContactsSchemaWithHttpInfo(String schemaId) throws IOException
      Get a schema
      Parameters:
      schemaId - Schema ID (required)
      Returns:
      DataSchema
      Throws:
      IOException - if the request fails to be processed
    • getExternalcontactsContactsSchema

      public DataSchema getExternalcontactsContactsSchema(GetExternalcontactsContactsSchemaRequest request) throws IOException, ApiException
      Get a schema
      Parameters:
      request - The request object
      Returns:
      DataSchema
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getExternalcontactsContactsSchema

      public ApiResponse<DataSchema> getExternalcontactsContactsSchema(ApiRequest<Void> request) throws IOException
      Get a schema
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getExternalcontactsContactsSchemaVersion

      public DataSchema getExternalcontactsContactsSchemaVersion(String schemaId, String versionId) throws IOException, ApiException
      Get a specific version of a schema
      Parameters:
      schemaId - Schema ID (required)
      versionId - Schema version (required)
      Returns:
      DataSchema
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getExternalcontactsContactsSchemaVersionWithHttpInfo

      public ApiResponse<DataSchema> getExternalcontactsContactsSchemaVersionWithHttpInfo(String schemaId, String versionId) throws IOException
      Get a specific version of a schema
      Parameters:
      schemaId - Schema ID (required)
      versionId - Schema version (required)
      Returns:
      DataSchema
      Throws:
      IOException - if the request fails to be processed
    • getExternalcontactsContactsSchemaVersion

      public DataSchema getExternalcontactsContactsSchemaVersion(GetExternalcontactsContactsSchemaVersionRequest request) throws IOException, ApiException
      Get a specific version of a schema
      Parameters:
      request - The request object
      Returns:
      DataSchema
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getExternalcontactsContactsSchemaVersion

      public ApiResponse<DataSchema> getExternalcontactsContactsSchemaVersion(ApiRequest<Void> request) throws IOException
      Get a specific version of a schema
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getExternalcontactsContactsSchemaVersions

      public DataSchemaListing getExternalcontactsContactsSchemaVersions(String schemaId) throws IOException, ApiException
      Get all versions of an external contact's schema
      Parameters:
      schemaId - Schema ID (required)
      Returns:
      DataSchemaListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getExternalcontactsContactsSchemaVersionsWithHttpInfo

      public ApiResponse<DataSchemaListing> getExternalcontactsContactsSchemaVersionsWithHttpInfo(String schemaId) throws IOException
      Get all versions of an external contact's schema
      Parameters:
      schemaId - Schema ID (required)
      Returns:
      DataSchemaListing
      Throws:
      IOException - if the request fails to be processed
    • getExternalcontactsContactsSchemaVersions

      public DataSchemaListing getExternalcontactsContactsSchemaVersions(GetExternalcontactsContactsSchemaVersionsRequest request) throws IOException, ApiException
      Get all versions of an external contact's schema
      Parameters:
      request - The request object
      Returns:
      DataSchemaListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getExternalcontactsContactsSchemaVersions

      public ApiResponse<DataSchemaListing> getExternalcontactsContactsSchemaVersions(ApiRequest<Void> request) throws IOException
      Get all versions of an external contact's schema
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getExternalcontactsContactsSchemas

      public DataSchemaListing getExternalcontactsContactsSchemas() throws IOException, ApiException
      Get a list of schemas.
      Returns:
      DataSchemaListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getExternalcontactsContactsSchemasWithHttpInfo

      public ApiResponse<DataSchemaListing> getExternalcontactsContactsSchemasWithHttpInfo() throws IOException
      Get a list of schemas.
      Returns:
      DataSchemaListing
      Throws:
      IOException - if the request fails to be processed
    • getExternalcontactsContactsSchemas

      public DataSchemaListing getExternalcontactsContactsSchemas(GetExternalcontactsContactsSchemasRequest request) throws IOException, ApiException
      Get a list of schemas.
      Parameters:
      request - The request object
      Returns:
      DataSchemaListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getExternalcontactsContactsSchemas

      public ApiResponse<DataSchemaListing> getExternalcontactsContactsSchemas(ApiRequest<Void> request) throws IOException
      Get a list of schemas.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getExternalcontactsContactsSchemasCoretype

      public Coretype getExternalcontactsContactsSchemasCoretype(String coreTypeName) throws IOException, ApiException
      Get a specific named core type.
      Parameters:
      coreTypeName - Name of the core type (required)
      Returns:
      Coretype
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getExternalcontactsContactsSchemasCoretypeWithHttpInfo

      public ApiResponse<Coretype> getExternalcontactsContactsSchemasCoretypeWithHttpInfo(String coreTypeName) throws IOException
      Get a specific named core type.
      Parameters:
      coreTypeName - Name of the core type (required)
      Returns:
      Coretype
      Throws:
      IOException - if the request fails to be processed
    • getExternalcontactsContactsSchemasCoretype

      public Coretype getExternalcontactsContactsSchemasCoretype(GetExternalcontactsContactsSchemasCoretypeRequest request) throws IOException, ApiException
      Get a specific named core type.
      Parameters:
      request - The request object
      Returns:
      Coretype
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getExternalcontactsContactsSchemasCoretype

      public ApiResponse<Coretype> getExternalcontactsContactsSchemasCoretype(ApiRequest<Void> request) throws IOException
      Get a specific named core type.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getExternalcontactsContactsSchemasCoretypes

      public CoretypeListing getExternalcontactsContactsSchemasCoretypes() throws IOException, ApiException
      Get the core types from which all schemas are built.
      Returns:
      CoretypeListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getExternalcontactsContactsSchemasCoretypesWithHttpInfo

      public ApiResponse<CoretypeListing> getExternalcontactsContactsSchemasCoretypesWithHttpInfo() throws IOException
      Get the core types from which all schemas are built.
      Returns:
      CoretypeListing
      Throws:
      IOException - if the request fails to be processed
    • getExternalcontactsContactsSchemasCoretypes

      public CoretypeListing getExternalcontactsContactsSchemasCoretypes(GetExternalcontactsContactsSchemasCoretypesRequest request) throws IOException, ApiException
      Get the core types from which all schemas are built.
      Parameters:
      request - The request object
      Returns:
      CoretypeListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getExternalcontactsContactsSchemasCoretypes

      public ApiResponse<CoretypeListing> getExternalcontactsContactsSchemasCoretypes(ApiRequest<Void> request) throws IOException
      Get the core types from which all schemas are built.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getExternalcontactsContactsSchemasLimits

      public SchemaQuantityLimits getExternalcontactsContactsSchemasLimits() throws IOException, ApiException
      Get quantitative limits on schemas
      Returns:
      SchemaQuantityLimits
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getExternalcontactsContactsSchemasLimitsWithHttpInfo

      public ApiResponse<SchemaQuantityLimits> getExternalcontactsContactsSchemasLimitsWithHttpInfo() throws IOException
      Get quantitative limits on schemas
      Returns:
      SchemaQuantityLimits
      Throws:
      IOException - if the request fails to be processed
    • getExternalcontactsContactsSchemasLimits

      public SchemaQuantityLimits getExternalcontactsContactsSchemasLimits(GetExternalcontactsContactsSchemasLimitsRequest request) throws IOException, ApiException
      Get quantitative limits on schemas
      Parameters:
      request - The request object
      Returns:
      SchemaQuantityLimits
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getExternalcontactsContactsSchemasLimits

      public ApiResponse<SchemaQuantityLimits> getExternalcontactsContactsSchemasLimits(ApiRequest<Void> request) throws IOException
      Get quantitative limits on schemas
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getExternalcontactsExternalsource

      public ExternalSource getExternalcontactsExternalsource(String externalSourceId) throws IOException, ApiException
      Fetch an External Source
      Parameters:
      externalSourceId - External Source ID (required)
      Returns:
      ExternalSource
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getExternalcontactsExternalsourceWithHttpInfo

      public ApiResponse<ExternalSource> getExternalcontactsExternalsourceWithHttpInfo(String externalSourceId) throws IOException
      Fetch an External Source
      Parameters:
      externalSourceId - External Source ID (required)
      Returns:
      ExternalSource
      Throws:
      IOException - if the request fails to be processed
    • getExternalcontactsExternalsource

      public ExternalSource getExternalcontactsExternalsource(GetExternalcontactsExternalsourceRequest request) throws IOException, ApiException
      Fetch an External Source
      Parameters:
      request - The request object
      Returns:
      ExternalSource
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getExternalcontactsExternalsource

      public ApiResponse<ExternalSource> getExternalcontactsExternalsource(ApiRequest<Void> request) throws IOException
      Fetch an External Source
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getExternalcontactsExternalsources

      public CursorExternalSourceListing getExternalcontactsExternalsources(String cursor, Integer limit, String name, Boolean active) throws IOException, ApiException
      Fetch a list of External Sources
      Parameters:
      cursor - Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL (optional)
      limit - The number of ExternalSources per page; must be between 10 and 200, default is 100 (optional)
      name - Filter by external source name. Filtering is prefix filtering and not an exact match (optional)
      active - Filter by active status of external source (optional)
      Returns:
      CursorExternalSourceListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getExternalcontactsExternalsourcesWithHttpInfo

      public ApiResponse<CursorExternalSourceListing> getExternalcontactsExternalsourcesWithHttpInfo(String cursor, Integer limit, String name, Boolean active) throws IOException
      Fetch a list of External Sources
      Parameters:
      cursor - Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL (optional)
      limit - The number of ExternalSources per page; must be between 10 and 200, default is 100 (optional)
      name - Filter by external source name. Filtering is prefix filtering and not an exact match (optional)
      active - Filter by active status of external source (optional)
      Returns:
      CursorExternalSourceListing
      Throws:
      IOException - if the request fails to be processed
    • getExternalcontactsExternalsources

      public CursorExternalSourceListing getExternalcontactsExternalsources(GetExternalcontactsExternalsourcesRequest request) throws IOException, ApiException
      Fetch a list of External Sources
      Parameters:
      request - The request object
      Returns:
      CursorExternalSourceListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getExternalcontactsExternalsources

      public ApiResponse<CursorExternalSourceListing> getExternalcontactsExternalsources(ApiRequest<Void> request) throws IOException
      Fetch a list of External Sources
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getExternalcontactsImportCsvSetting

      public CsvSettings getExternalcontactsImportCsvSetting(String settingsId) throws IOException, ApiException
      Get settings for CSV import
      Parameters:
      settingsId - Settings id (required)
      Returns:
      CsvSettings
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getExternalcontactsImportCsvSettingWithHttpInfo

      public ApiResponse<CsvSettings> getExternalcontactsImportCsvSettingWithHttpInfo(String settingsId) throws IOException
      Get settings for CSV import
      Parameters:
      settingsId - Settings id (required)
      Returns:
      CsvSettings
      Throws:
      IOException - if the request fails to be processed
    • getExternalcontactsImportCsvSetting

      public CsvSettings getExternalcontactsImportCsvSetting(GetExternalcontactsImportCsvSettingRequest request) throws IOException, ApiException
      Get settings for CSV import
      Parameters:
      request - The request object
      Returns:
      CsvSettings
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getExternalcontactsImportCsvSetting

      public ApiResponse<CsvSettings> getExternalcontactsImportCsvSetting(ApiRequest<Void> request) throws IOException
      Get settings for CSV import
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getExternalcontactsImportCsvSettings

      public Listing getExternalcontactsImportCsvSettings(String after, String pageSize, String externalSettingsId) throws IOException, ApiException
      Retrieve all settings for organization filtered by externalSettingsId if provided
      Parameters:
      after - The cursor that points to the end of the set of entities that has been returned. (optional)
      pageSize - Number of entities to return. Maximum of 200. (optional)
      externalSettingsId - External Settings Id to filter the list. (optional)
      Returns:
      Listing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getExternalcontactsImportCsvSettingsWithHttpInfo

      public ApiResponse<Listing> getExternalcontactsImportCsvSettingsWithHttpInfo(String after, String pageSize, String externalSettingsId) throws IOException
      Retrieve all settings for organization filtered by externalSettingsId if provided
      Parameters:
      after - The cursor that points to the end of the set of entities that has been returned. (optional)
      pageSize - Number of entities to return. Maximum of 200. (optional)
      externalSettingsId - External Settings Id to filter the list. (optional)
      Returns:
      Listing
      Throws:
      IOException - if the request fails to be processed
    • getExternalcontactsImportCsvSettings

      public Listing getExternalcontactsImportCsvSettings(GetExternalcontactsImportCsvSettingsRequest request) throws IOException, ApiException
      Retrieve all settings for organization filtered by externalSettingsId if provided
      Parameters:
      request - The request object
      Returns:
      Listing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getExternalcontactsImportCsvSettings

      public ApiResponse<Listing> getExternalcontactsImportCsvSettings(ApiRequest<Void> request) throws IOException
      Retrieve all settings for organization filtered by externalSettingsId if provided
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getExternalcontactsImportCsvUploadDetails

      public CsvUploadDetailsResponse getExternalcontactsImportCsvUploadDetails(String uploadId) throws IOException, ApiException
      Get details for CSV upload
      Parameters:
      uploadId - Upload id (required)
      Returns:
      CsvUploadDetailsResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getExternalcontactsImportCsvUploadDetailsWithHttpInfo

      public ApiResponse<CsvUploadDetailsResponse> getExternalcontactsImportCsvUploadDetailsWithHttpInfo(String uploadId) throws IOException
      Get details for CSV upload
      Parameters:
      uploadId - Upload id (required)
      Returns:
      CsvUploadDetailsResponse
      Throws:
      IOException - if the request fails to be processed
    • getExternalcontactsImportCsvUploadDetails

      public CsvUploadDetailsResponse getExternalcontactsImportCsvUploadDetails(GetExternalcontactsImportCsvUploadDetailsRequest request) throws IOException, ApiException
      Get details for CSV upload
      Parameters:
      request - The request object
      Returns:
      CsvUploadDetailsResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getExternalcontactsImportCsvUploadDetails

      public ApiResponse<CsvUploadDetailsResponse> getExternalcontactsImportCsvUploadDetails(ApiRequest<Void> request) throws IOException
      Get details for CSV upload
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getExternalcontactsImportCsvUploadPreview

      public CsvUploadPreviewResponse getExternalcontactsImportCsvUploadPreview(String uploadId) throws IOException, ApiException
      Get preview for CSV upload
      Parameters:
      uploadId - Upload id (required)
      Returns:
      CsvUploadPreviewResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getExternalcontactsImportCsvUploadPreviewWithHttpInfo

      public ApiResponse<CsvUploadPreviewResponse> getExternalcontactsImportCsvUploadPreviewWithHttpInfo(String uploadId) throws IOException
      Get preview for CSV upload
      Parameters:
      uploadId - Upload id (required)
      Returns:
      CsvUploadPreviewResponse
      Throws:
      IOException - if the request fails to be processed
    • getExternalcontactsImportCsvUploadPreview

      public CsvUploadPreviewResponse getExternalcontactsImportCsvUploadPreview(GetExternalcontactsImportCsvUploadPreviewRequest request) throws IOException, ApiException
      Get preview for CSV upload
      Parameters:
      request - The request object
      Returns:
      CsvUploadPreviewResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getExternalcontactsImportCsvUploadPreview

      public ApiResponse<CsvUploadPreviewResponse> getExternalcontactsImportCsvUploadPreview(ApiRequest<Void> request) throws IOException
      Get preview for CSV upload
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getExternalcontactsImportJob

      public ContactImportJobResponse getExternalcontactsImportJob(String jobId, List<String> expand) throws IOException, ApiException
      Get job based on id
      Parameters:
      jobId - Job id (required)
      expand - which fields, if any, to expand (optional)
      Returns:
      ContactImportJobResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getExternalcontactsImportJobWithHttpInfo

      public ApiResponse<ContactImportJobResponse> getExternalcontactsImportJobWithHttpInfo(String jobId, List<String> expand) throws IOException
      Get job based on id
      Parameters:
      jobId - Job id (required)
      expand - which fields, if any, to expand (optional)
      Returns:
      ContactImportJobResponse
      Throws:
      IOException - if the request fails to be processed
    • getExternalcontactsImportJob

      public ContactImportJobResponse getExternalcontactsImportJob(GetExternalcontactsImportJobRequest request) throws IOException, ApiException
      Get job based on id
      Parameters:
      request - The request object
      Returns:
      ContactImportJobResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getExternalcontactsImportJob

      public ApiResponse<ContactImportJobResponse> getExternalcontactsImportJob(ApiRequest<Void> request) throws IOException
      Get job based on id
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getExternalcontactsImportJobs

      public ContactImportJobEntityListing getExternalcontactsImportJobs(List<String> expand, String after, String pageSize, String sortOrder, String jobStatus) throws IOException, ApiException
      List jobs for organization
      Parameters:
      expand - which fields, if any, to expand (optional)
      after - The cursor that points to the end of the set of entities that has been returned. (optional)
      pageSize - Number of entities to return. Maximum of 100. (optional, default to 25)
      sortOrder - Direction of sorting. (optional, default to Ascending)
      jobStatus - Search term to filter by jobStatus (optional)
      Returns:
      ContactImportJobEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getExternalcontactsImportJobsWithHttpInfo

      public ApiResponse<ContactImportJobEntityListing> getExternalcontactsImportJobsWithHttpInfo(List<String> expand, String after, String pageSize, String sortOrder, String jobStatus) throws IOException
      List jobs for organization
      Parameters:
      expand - which fields, if any, to expand (optional)
      after - The cursor that points to the end of the set of entities that has been returned. (optional)
      pageSize - Number of entities to return. Maximum of 100. (optional, default to 25)
      sortOrder - Direction of sorting. (optional, default to Ascending)
      jobStatus - Search term to filter by jobStatus (optional)
      Returns:
      ContactImportJobEntityListing
      Throws:
      IOException - if the request fails to be processed
    • getExternalcontactsImportJobs

      public ContactImportJobEntityListing getExternalcontactsImportJobs(GetExternalcontactsImportJobsRequest request) throws IOException, ApiException
      List jobs for organization
      Parameters:
      request - The request object
      Returns:
      ContactImportJobEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getExternalcontactsImportJobs

      public ApiResponse<ContactImportJobEntityListing> getExternalcontactsImportJobs(ApiRequest<Void> request) throws IOException
      List jobs for organization
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getExternalcontactsImportSetting

      public ContactImportSettings getExternalcontactsImportSetting(String settingsId) throws IOException, ApiException
      Get setting based on id
      Parameters:
      settingsId - Settings id (required)
      Returns:
      ContactImportSettings
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getExternalcontactsImportSettingWithHttpInfo

      public ApiResponse<ContactImportSettings> getExternalcontactsImportSettingWithHttpInfo(String settingsId) throws IOException
      Get setting based on id
      Parameters:
      settingsId - Settings id (required)
      Returns:
      ContactImportSettings
      Throws:
      IOException - if the request fails to be processed
    • getExternalcontactsImportSetting

      public ContactImportSettings getExternalcontactsImportSetting(GetExternalcontactsImportSettingRequest request) throws IOException, ApiException
      Get setting based on id
      Parameters:
      request - The request object
      Returns:
      ContactImportSettings
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getExternalcontactsImportSetting

      public ApiResponse<ContactImportSettings> getExternalcontactsImportSetting(ApiRequest<Void> request) throws IOException
      Get setting based on id
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getExternalcontactsImportSettings

      public ContactImportSettingsEntityListing getExternalcontactsImportSettings(String after, String pageSize, String sortOrder, String name) throws IOException, ApiException
      List settings for organization
      Parameters:
      after - The cursor that points to the end of the set of entities that has been returned. (optional)
      pageSize - Number of entities to return. Maximum of 100. (optional, default to 25)
      sortOrder - Direction of sorting. (optional, default to Ascending)
      name - Search term to filter by settings name (optional)
      Returns:
      ContactImportSettingsEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getExternalcontactsImportSettingsWithHttpInfo

      public ApiResponse<ContactImportSettingsEntityListing> getExternalcontactsImportSettingsWithHttpInfo(String after, String pageSize, String sortOrder, String name) throws IOException
      List settings for organization
      Parameters:
      after - The cursor that points to the end of the set of entities that has been returned. (optional)
      pageSize - Number of entities to return. Maximum of 100. (optional, default to 25)
      sortOrder - Direction of sorting. (optional, default to Ascending)
      name - Search term to filter by settings name (optional)
      Returns:
      ContactImportSettingsEntityListing
      Throws:
      IOException - if the request fails to be processed
    • getExternalcontactsImportSettings

      List settings for organization
      Parameters:
      request - The request object
      Returns:
      ContactImportSettingsEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getExternalcontactsImportSettings

      public ApiResponse<ContactImportSettingsEntityListing> getExternalcontactsImportSettings(ApiRequest<Void> request) throws IOException
      List settings for organization
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getExternalcontactsOrganization

      public ExternalOrganization getExternalcontactsOrganization(String externalOrganizationId, List<String> expand, Boolean includeTrustors) throws IOException, ApiException
      Fetch an external organization
      Parameters:
      externalOrganizationId - External Organization ID (required)
      expand - which fields, if any, to expand (optional)
      includeTrustors - (true or false) whether or not to include trustor information embedded in the externalOrganization (optional)
      Returns:
      ExternalOrganization
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getExternalcontactsOrganizationWithHttpInfo

      public ApiResponse<ExternalOrganization> getExternalcontactsOrganizationWithHttpInfo(String externalOrganizationId, List<String> expand, Boolean includeTrustors) throws IOException
      Fetch an external organization
      Parameters:
      externalOrganizationId - External Organization ID (required)
      expand - which fields, if any, to expand (optional)
      includeTrustors - (true or false) whether or not to include trustor information embedded in the externalOrganization (optional)
      Returns:
      ExternalOrganization
      Throws:
      IOException - if the request fails to be processed
    • getExternalcontactsOrganization

      public ExternalOrganization getExternalcontactsOrganization(GetExternalcontactsOrganizationRequest request) throws IOException, ApiException
      Fetch an external organization
      Parameters:
      request - The request object
      Returns:
      ExternalOrganization
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getExternalcontactsOrganization

      public ApiResponse<ExternalOrganization> getExternalcontactsOrganization(ApiRequest<Void> request) throws IOException
      Fetch an external organization
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getExternalcontactsOrganizationContacts

      public ContactListing getExternalcontactsOrganizationContacts(String externalOrganizationId, Integer pageSize, Integer pageNumber, String q, String sortOrder, List<String> expand) throws IOException, ApiException
      Search for external contacts in an external organization
      Parameters:
      externalOrganizationId - External Organization ID (required)
      pageSize - Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) (optional, default to 20)
      pageNumber - Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) (optional, default to 1)
      q - User supplied search keywords (no special syntax is currently supported) (optional)
      sortOrder - The External Contact field to sort by. Any of: [firstName, lastName, middleName, title]. Direction: [asc, desc]. e.g. \"firstName:asc\", \"title:desc\" (optional)
      expand - which fields, if any, to expand (optional)
      Returns:
      ContactListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getExternalcontactsOrganizationContactsWithHttpInfo

      public ApiResponse<ContactListing> getExternalcontactsOrganizationContactsWithHttpInfo(String externalOrganizationId, Integer pageSize, Integer pageNumber, String q, String sortOrder, List<String> expand) throws IOException
      Search for external contacts in an external organization
      Parameters:
      externalOrganizationId - External Organization ID (required)
      pageSize - Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) (optional, default to 20)
      pageNumber - Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) (optional, default to 1)
      q - User supplied search keywords (no special syntax is currently supported) (optional)
      sortOrder - The External Contact field to sort by. Any of: [firstName, lastName, middleName, title]. Direction: [asc, desc]. e.g. \"firstName:asc\", \"title:desc\" (optional)
      expand - which fields, if any, to expand (optional)
      Returns:
      ContactListing
      Throws:
      IOException - if the request fails to be processed
    • getExternalcontactsOrganizationContacts

      public ContactListing getExternalcontactsOrganizationContacts(GetExternalcontactsOrganizationContactsRequest request) throws IOException, ApiException
      Search for external contacts in an external organization
      Parameters:
      request - The request object
      Returns:
      ContactListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getExternalcontactsOrganizationContacts

      public ApiResponse<ContactListing> getExternalcontactsOrganizationContacts(ApiRequest<Void> request) throws IOException
      Search for external contacts in an external organization
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getExternalcontactsOrganizationIdentifiers

      public ExternalOrganizationIdentifierListing getExternalcontactsOrganizationIdentifiers(String externalOrganizationId) throws IOException, ApiException
      List the identifiers for an external organization
      Parameters:
      externalOrganizationId - External Organization ID (required)
      Returns:
      ExternalOrganizationIdentifierListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getExternalcontactsOrganizationIdentifiersWithHttpInfo

      public ApiResponse<ExternalOrganizationIdentifierListing> getExternalcontactsOrganizationIdentifiersWithHttpInfo(String externalOrganizationId) throws IOException
      List the identifiers for an external organization
      Parameters:
      externalOrganizationId - External Organization ID (required)
      Returns:
      ExternalOrganizationIdentifierListing
      Throws:
      IOException - if the request fails to be processed
    • getExternalcontactsOrganizationIdentifiers

      public ExternalOrganizationIdentifierListing getExternalcontactsOrganizationIdentifiers(GetExternalcontactsOrganizationIdentifiersRequest request) throws IOException, ApiException
      List the identifiers for an external organization
      Parameters:
      request - The request object
      Returns:
      ExternalOrganizationIdentifierListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getExternalcontactsOrganizationIdentifiers

      public ApiResponse<ExternalOrganizationIdentifierListing> getExternalcontactsOrganizationIdentifiers(ApiRequest<Void> request) throws IOException
      List the identifiers for an external organization
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getExternalcontactsOrganizationNote

      public Note getExternalcontactsOrganizationNote(String externalOrganizationId, String noteId, List<String> expand) throws IOException, ApiException
      Fetch a note for an external organization
      Parameters:
      externalOrganizationId - External Organization Id (required)
      noteId - Note Id (required)
      expand - which fields, if any, to expand (optional)
      Returns:
      Note
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getExternalcontactsOrganizationNoteWithHttpInfo

      public ApiResponse<Note> getExternalcontactsOrganizationNoteWithHttpInfo(String externalOrganizationId, String noteId, List<String> expand) throws IOException
      Fetch a note for an external organization
      Parameters:
      externalOrganizationId - External Organization Id (required)
      noteId - Note Id (required)
      expand - which fields, if any, to expand (optional)
      Returns:
      Note
      Throws:
      IOException - if the request fails to be processed
    • getExternalcontactsOrganizationNote

      public Note getExternalcontactsOrganizationNote(GetExternalcontactsOrganizationNoteRequest request) throws IOException, ApiException
      Fetch a note for an external organization
      Parameters:
      request - The request object
      Returns:
      Note
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getExternalcontactsOrganizationNote

      public ApiResponse<Note> getExternalcontactsOrganizationNote(ApiRequest<Void> request) throws IOException
      Fetch a note for an external organization
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getExternalcontactsOrganizationNotes

      public NoteListing getExternalcontactsOrganizationNotes(String externalOrganizationId, Integer pageSize, Integer pageNumber, String sortOrder, List<String> expand) throws IOException, ApiException
      List notes for an external organization
      Parameters:
      externalOrganizationId - External Organization Id (required)
      pageSize - Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) (optional, default to 20)
      pageNumber - Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) (optional, default to 1)
      sortOrder - The Note field to sort by. Any of: [createDate]. Direction: [asc, desc]. e.g. \"createDate:asc\", \"createDate:desc\" (optional)
      expand - which fields, if any, to expand (optional)
      Returns:
      NoteListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getExternalcontactsOrganizationNotesWithHttpInfo

      public ApiResponse<NoteListing> getExternalcontactsOrganizationNotesWithHttpInfo(String externalOrganizationId, Integer pageSize, Integer pageNumber, String sortOrder, List<String> expand) throws IOException
      List notes for an external organization
      Parameters:
      externalOrganizationId - External Organization Id (required)
      pageSize - Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) (optional, default to 20)
      pageNumber - Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) (optional, default to 1)
      sortOrder - The Note field to sort by. Any of: [createDate]. Direction: [asc, desc]. e.g. \"createDate:asc\", \"createDate:desc\" (optional)
      expand - which fields, if any, to expand (optional)
      Returns:
      NoteListing
      Throws:
      IOException - if the request fails to be processed
    • getExternalcontactsOrganizationNotes

      public NoteListing getExternalcontactsOrganizationNotes(GetExternalcontactsOrganizationNotesRequest request) throws IOException, ApiException
      List notes for an external organization
      Parameters:
      request - The request object
      Returns:
      NoteListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getExternalcontactsOrganizationNotes

      public ApiResponse<NoteListing> getExternalcontactsOrganizationNotes(ApiRequest<Void> request) throws IOException
      List notes for an external organization
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getExternalcontactsOrganizationRelationships

      public RelationshipListing getExternalcontactsOrganizationRelationships(String externalOrganizationId, Integer pageSize, Integer pageNumber, List<String> expand, String sortOrder) throws IOException, ApiException
      Fetch a relationship for an external organization
      Parameters:
      externalOrganizationId - External Organization ID (required)
      pageSize - Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) (optional, default to 20)
      pageNumber - Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) (optional, default to 1)
      expand - which fields, if any, to expand (optional)
      sortOrder - The Relationship field to sort by. Any of: [createDate, relationship]. Direction: [asc, desc]. e.g. \"createDate:asc\", \"relationship:desc\" (optional)
      Returns:
      RelationshipListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getExternalcontactsOrganizationRelationshipsWithHttpInfo

      public ApiResponse<RelationshipListing> getExternalcontactsOrganizationRelationshipsWithHttpInfo(String externalOrganizationId, Integer pageSize, Integer pageNumber, List<String> expand, String sortOrder) throws IOException
      Fetch a relationship for an external organization
      Parameters:
      externalOrganizationId - External Organization ID (required)
      pageSize - Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) (optional, default to 20)
      pageNumber - Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) (optional, default to 1)
      expand - which fields, if any, to expand (optional)
      sortOrder - The Relationship field to sort by. Any of: [createDate, relationship]. Direction: [asc, desc]. e.g. \"createDate:asc\", \"relationship:desc\" (optional)
      Returns:
      RelationshipListing
      Throws:
      IOException - if the request fails to be processed
    • getExternalcontactsOrganizationRelationships

      public RelationshipListing getExternalcontactsOrganizationRelationships(GetExternalcontactsOrganizationRelationshipsRequest request) throws IOException, ApiException
      Fetch a relationship for an external organization
      Parameters:
      request - The request object
      Returns:
      RelationshipListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getExternalcontactsOrganizationRelationships

      public ApiResponse<RelationshipListing> getExternalcontactsOrganizationRelationships(ApiRequest<Void> request) throws IOException
      Fetch a relationship for an external organization
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getExternalcontactsOrganizations

      public ExternalOrganizationListing getExternalcontactsOrganizations(Integer pageSize, Integer pageNumber, String q, List<String> trustorId, String sortOrder, List<String> expand, Boolean includeTrustors, List<String> divisionIds) throws IOException, ApiException
      Search for external organizations
      Parameters:
      pageSize - Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) (optional, default to 20)
      pageNumber - Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) (optional, default to 1)
      q - Search query (optional)
      trustorId - Search for external organizations by trustorIds (limit 25). If supplied, the 'q' parameters is ignored. Items are returned in the order requested (optional)
      sortOrder - The Organization field to sort by. Any of: [companyType, industry, name]. Direction: [asc, desc]. e.g. \"companyType:asc\", \"industry:desc\" (optional)
      expand - which fields, if any, to expand (optional)
      includeTrustors - (true or false) whether or not to include trustor information embedded in the externalOrganization (optional)
      divisionIds - which divisions to search, up to 50 (optional)
      Returns:
      ExternalOrganizationListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getExternalcontactsOrganizationsWithHttpInfo

      public ApiResponse<ExternalOrganizationListing> getExternalcontactsOrganizationsWithHttpInfo(Integer pageSize, Integer pageNumber, String q, List<String> trustorId, String sortOrder, List<String> expand, Boolean includeTrustors, List<String> divisionIds) throws IOException
      Search for external organizations
      Parameters:
      pageSize - Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) (optional, default to 20)
      pageNumber - Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) (optional, default to 1)
      q - Search query (optional)
      trustorId - Search for external organizations by trustorIds (limit 25). If supplied, the 'q' parameters is ignored. Items are returned in the order requested (optional)
      sortOrder - The Organization field to sort by. Any of: [companyType, industry, name]. Direction: [asc, desc]. e.g. \"companyType:asc\", \"industry:desc\" (optional)
      expand - which fields, if any, to expand (optional)
      includeTrustors - (true or false) whether or not to include trustor information embedded in the externalOrganization (optional)
      divisionIds - which divisions to search, up to 50 (optional)
      Returns:
      ExternalOrganizationListing
      Throws:
      IOException - if the request fails to be processed
    • getExternalcontactsOrganizations

      public ExternalOrganizationListing getExternalcontactsOrganizations(GetExternalcontactsOrganizationsRequest request) throws IOException, ApiException
      Search for external organizations
      Parameters:
      request - The request object
      Returns:
      ExternalOrganizationListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getExternalcontactsOrganizations

      public ApiResponse<ExternalOrganizationListing> getExternalcontactsOrganizations(ApiRequest<Void> request) throws IOException
      Search for external organizations
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getExternalcontactsOrganizationsSchema

      public DataSchema getExternalcontactsOrganizationsSchema(String schemaId) throws IOException, ApiException
      Get a schema
      Parameters:
      schemaId - Schema ID (required)
      Returns:
      DataSchema
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getExternalcontactsOrganizationsSchemaWithHttpInfo

      public ApiResponse<DataSchema> getExternalcontactsOrganizationsSchemaWithHttpInfo(String schemaId) throws IOException
      Get a schema
      Parameters:
      schemaId - Schema ID (required)
      Returns:
      DataSchema
      Throws:
      IOException - if the request fails to be processed
    • getExternalcontactsOrganizationsSchema

      public DataSchema getExternalcontactsOrganizationsSchema(GetExternalcontactsOrganizationsSchemaRequest request) throws IOException, ApiException
      Get a schema
      Parameters:
      request - The request object
      Returns:
      DataSchema
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getExternalcontactsOrganizationsSchema

      public ApiResponse<DataSchema> getExternalcontactsOrganizationsSchema(ApiRequest<Void> request) throws IOException
      Get a schema
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getExternalcontactsOrganizationsSchemaVersion

      public DataSchema getExternalcontactsOrganizationsSchemaVersion(String schemaId, String versionId) throws IOException, ApiException
      Get a specific version of a schema
      Parameters:
      schemaId - Schema ID (required)
      versionId - Schema version (required)
      Returns:
      DataSchema
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getExternalcontactsOrganizationsSchemaVersionWithHttpInfo

      public ApiResponse<DataSchema> getExternalcontactsOrganizationsSchemaVersionWithHttpInfo(String schemaId, String versionId) throws IOException
      Get a specific version of a schema
      Parameters:
      schemaId - Schema ID (required)
      versionId - Schema version (required)
      Returns:
      DataSchema
      Throws:
      IOException - if the request fails to be processed
    • getExternalcontactsOrganizationsSchemaVersion

      public DataSchema getExternalcontactsOrganizationsSchemaVersion(GetExternalcontactsOrganizationsSchemaVersionRequest request) throws IOException, ApiException
      Get a specific version of a schema
      Parameters:
      request - The request object
      Returns:
      DataSchema
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getExternalcontactsOrganizationsSchemaVersion

      public ApiResponse<DataSchema> getExternalcontactsOrganizationsSchemaVersion(ApiRequest<Void> request) throws IOException
      Get a specific version of a schema
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getExternalcontactsOrganizationsSchemaVersions

      public DataSchemaListing getExternalcontactsOrganizationsSchemaVersions(String schemaId) throws IOException, ApiException
      Get all versions of an external organization's schema
      Parameters:
      schemaId - Schema ID (required)
      Returns:
      DataSchemaListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getExternalcontactsOrganizationsSchemaVersionsWithHttpInfo

      public ApiResponse<DataSchemaListing> getExternalcontactsOrganizationsSchemaVersionsWithHttpInfo(String schemaId) throws IOException
      Get all versions of an external organization's schema
      Parameters:
      schemaId - Schema ID (required)
      Returns:
      DataSchemaListing
      Throws:
      IOException - if the request fails to be processed
    • getExternalcontactsOrganizationsSchemaVersions

      public DataSchemaListing getExternalcontactsOrganizationsSchemaVersions(GetExternalcontactsOrganizationsSchemaVersionsRequest request) throws IOException, ApiException
      Get all versions of an external organization's schema
      Parameters:
      request - The request object
      Returns:
      DataSchemaListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getExternalcontactsOrganizationsSchemaVersions

      public ApiResponse<DataSchemaListing> getExternalcontactsOrganizationsSchemaVersions(ApiRequest<Void> request) throws IOException
      Get all versions of an external organization's schema
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getExternalcontactsOrganizationsSchemas

      public DataSchemaListing getExternalcontactsOrganizationsSchemas() throws IOException, ApiException
      Get a list of schemas.
      Returns:
      DataSchemaListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getExternalcontactsOrganizationsSchemasWithHttpInfo

      public ApiResponse<DataSchemaListing> getExternalcontactsOrganizationsSchemasWithHttpInfo() throws IOException
      Get a list of schemas.
      Returns:
      DataSchemaListing
      Throws:
      IOException - if the request fails to be processed
    • getExternalcontactsOrganizationsSchemas

      public DataSchemaListing getExternalcontactsOrganizationsSchemas(GetExternalcontactsOrganizationsSchemasRequest request) throws IOException, ApiException
      Get a list of schemas.
      Parameters:
      request - The request object
      Returns:
      DataSchemaListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getExternalcontactsOrganizationsSchemas

      public ApiResponse<DataSchemaListing> getExternalcontactsOrganizationsSchemas(ApiRequest<Void> request) throws IOException
      Get a list of schemas.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getExternalcontactsOrganizationsSchemasCoretype

      public Coretype getExternalcontactsOrganizationsSchemasCoretype(String coreTypeName) throws IOException, ApiException
      Get a specific named core type.
      Parameters:
      coreTypeName - Name of the core type (required)
      Returns:
      Coretype
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getExternalcontactsOrganizationsSchemasCoretypeWithHttpInfo

      public ApiResponse<Coretype> getExternalcontactsOrganizationsSchemasCoretypeWithHttpInfo(String coreTypeName) throws IOException
      Get a specific named core type.
      Parameters:
      coreTypeName - Name of the core type (required)
      Returns:
      Coretype
      Throws:
      IOException - if the request fails to be processed
    • getExternalcontactsOrganizationsSchemasCoretype

      public Coretype getExternalcontactsOrganizationsSchemasCoretype(GetExternalcontactsOrganizationsSchemasCoretypeRequest request) throws IOException, ApiException
      Get a specific named core type.
      Parameters:
      request - The request object
      Returns:
      Coretype
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getExternalcontactsOrganizationsSchemasCoretype

      public ApiResponse<Coretype> getExternalcontactsOrganizationsSchemasCoretype(ApiRequest<Void> request) throws IOException
      Get a specific named core type.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getExternalcontactsOrganizationsSchemasCoretypes

      public CoretypeListing getExternalcontactsOrganizationsSchemasCoretypes() throws IOException, ApiException
      Get the core types from which all schemas are built.
      Returns:
      CoretypeListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getExternalcontactsOrganizationsSchemasCoretypesWithHttpInfo

      public ApiResponse<CoretypeListing> getExternalcontactsOrganizationsSchemasCoretypesWithHttpInfo() throws IOException
      Get the core types from which all schemas are built.
      Returns:
      CoretypeListing
      Throws:
      IOException - if the request fails to be processed
    • getExternalcontactsOrganizationsSchemasCoretypes

      public CoretypeListing getExternalcontactsOrganizationsSchemasCoretypes(GetExternalcontactsOrganizationsSchemasCoretypesRequest request) throws IOException, ApiException
      Get the core types from which all schemas are built.
      Parameters:
      request - The request object
      Returns:
      CoretypeListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getExternalcontactsOrganizationsSchemasCoretypes

      public ApiResponse<CoretypeListing> getExternalcontactsOrganizationsSchemasCoretypes(ApiRequest<Void> request) throws IOException
      Get the core types from which all schemas are built.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getExternalcontactsOrganizationsSchemasLimits

      public SchemaQuantityLimits getExternalcontactsOrganizationsSchemasLimits() throws IOException, ApiException
      Get quantitative limits on schemas
      Returns:
      SchemaQuantityLimits
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getExternalcontactsOrganizationsSchemasLimitsWithHttpInfo

      public ApiResponse<SchemaQuantityLimits> getExternalcontactsOrganizationsSchemasLimitsWithHttpInfo() throws IOException
      Get quantitative limits on schemas
      Returns:
      SchemaQuantityLimits
      Throws:
      IOException - if the request fails to be processed
    • getExternalcontactsOrganizationsSchemasLimits

      public SchemaQuantityLimits getExternalcontactsOrganizationsSchemasLimits(GetExternalcontactsOrganizationsSchemasLimitsRequest request) throws IOException, ApiException
      Get quantitative limits on schemas
      Parameters:
      request - The request object
      Returns:
      SchemaQuantityLimits
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getExternalcontactsOrganizationsSchemasLimits

      public ApiResponse<SchemaQuantityLimits> getExternalcontactsOrganizationsSchemasLimits(ApiRequest<Void> request) throws IOException
      Get quantitative limits on schemas
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getExternalcontactsRelationship

      public Relationship getExternalcontactsRelationship(String relationshipId, List<String> expand) throws IOException, ApiException
      Fetch a relationship
      Parameters:
      relationshipId - Relationship Id (required)
      expand - which fields, if any, to expand (optional)
      Returns:
      Relationship
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getExternalcontactsRelationshipWithHttpInfo

      public ApiResponse<Relationship> getExternalcontactsRelationshipWithHttpInfo(String relationshipId, List<String> expand) throws IOException
      Fetch a relationship
      Parameters:
      relationshipId - Relationship Id (required)
      expand - which fields, if any, to expand (optional)
      Returns:
      Relationship
      Throws:
      IOException - if the request fails to be processed
    • getExternalcontactsRelationship

      public Relationship getExternalcontactsRelationship(GetExternalcontactsRelationshipRequest request) throws IOException, ApiException
      Fetch a relationship
      Parameters:
      request - The request object
      Returns:
      Relationship
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getExternalcontactsRelationship

      public ApiResponse<Relationship> getExternalcontactsRelationship(ApiRequest<Void> request) throws IOException
      Fetch a relationship
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getExternalcontactsReversewhitepageslookup

      public ReverseWhitepagesLookupResult getExternalcontactsReversewhitepageslookup(String lookupVal, List<String> expand, String divisionId) throws IOException, ApiException
      Look up contacts based on an attribute. Maximum of 25 values returned.
      Parameters:
      lookupVal - User supplied value to lookup contacts (supports email addresses, e164 phone numbers, Twitter screen names) (required)
      expand - which field, if any, to expand (optional)
      divisionId - Specifies which division to lookup contacts in, for the given lookup value (optional, default to *)
      Returns:
      ReverseWhitepagesLookupResult
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getExternalcontactsReversewhitepageslookupWithHttpInfo

      public ApiResponse<ReverseWhitepagesLookupResult> getExternalcontactsReversewhitepageslookupWithHttpInfo(String lookupVal, List<String> expand, String divisionId) throws IOException
      Look up contacts based on an attribute. Maximum of 25 values returned.
      Parameters:
      lookupVal - User supplied value to lookup contacts (supports email addresses, e164 phone numbers, Twitter screen names) (required)
      expand - which field, if any, to expand (optional)
      divisionId - Specifies which division to lookup contacts in, for the given lookup value (optional, default to *)
      Returns:
      ReverseWhitepagesLookupResult
      Throws:
      IOException - if the request fails to be processed
    • getExternalcontactsReversewhitepageslookup

      public ReverseWhitepagesLookupResult getExternalcontactsReversewhitepageslookup(GetExternalcontactsReversewhitepageslookupRequest request) throws IOException, ApiException
      Look up contacts based on an attribute. Maximum of 25 values returned.
      Parameters:
      request - The request object
      Returns:
      ReverseWhitepagesLookupResult
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getExternalcontactsReversewhitepageslookup

      public ApiResponse<ReverseWhitepagesLookupResult> getExternalcontactsReversewhitepageslookup(ApiRequest<Void> request) throws IOException
      Look up contacts based on an attribute. Maximum of 25 values returned.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getExternalcontactsScanContacts

      public CursorContactListing getExternalcontactsScanContacts(Integer limit, String cursor, String divisionId) throws IOException, ApiException
      Scan for external contacts using paging
      Parameters:
      limit - The number of contacts per page; must be between 10 and 200, default is 100 (optional)
      cursor - Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL (optional)
      divisionId - The division to scan over (optional, default to *)
      Returns:
      CursorContactListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getExternalcontactsScanContactsWithHttpInfo

      public ApiResponse<CursorContactListing> getExternalcontactsScanContactsWithHttpInfo(Integer limit, String cursor, String divisionId) throws IOException
      Scan for external contacts using paging
      Parameters:
      limit - The number of contacts per page; must be between 10 and 200, default is 100 (optional)
      cursor - Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL (optional)
      divisionId - The division to scan over (optional, default to *)
      Returns:
      CursorContactListing
      Throws:
      IOException - if the request fails to be processed
    • getExternalcontactsScanContacts

      public CursorContactListing getExternalcontactsScanContacts(GetExternalcontactsScanContactsRequest request) throws IOException, ApiException
      Scan for external contacts using paging
      Parameters:
      request - The request object
      Returns:
      CursorContactListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getExternalcontactsScanContacts

      public ApiResponse<CursorContactListing> getExternalcontactsScanContacts(ApiRequest<Void> request) throws IOException
      Scan for external contacts using paging
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getExternalcontactsScanContactsDivisionviewsAll

      public CursorContactListing getExternalcontactsScanContactsDivisionviewsAll(Integer limit, String cursor) throws IOException, ApiException
      Scan for external contacts using paging
      Parameters:
      limit - The number of contacts per page; must be between 10 and 200, default is 100 (optional)
      cursor - Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL (optional)
      Returns:
      CursorContactListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getExternalcontactsScanContactsDivisionviewsAllWithHttpInfo

      public ApiResponse<CursorContactListing> getExternalcontactsScanContactsDivisionviewsAllWithHttpInfo(Integer limit, String cursor) throws IOException
      Scan for external contacts using paging
      Parameters:
      limit - The number of contacts per page; must be between 10 and 200, default is 100 (optional)
      cursor - Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL (optional)
      Returns:
      CursorContactListing
      Throws:
      IOException - if the request fails to be processed
    • getExternalcontactsScanContactsDivisionviewsAll

      public CursorContactListing getExternalcontactsScanContactsDivisionviewsAll(GetExternalcontactsScanContactsDivisionviewsAllRequest request) throws IOException, ApiException
      Scan for external contacts using paging
      Parameters:
      request - The request object
      Returns:
      CursorContactListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getExternalcontactsScanContactsDivisionviewsAll

      public ApiResponse<CursorContactListing> getExternalcontactsScanContactsDivisionviewsAll(ApiRequest<Void> request) throws IOException
      Scan for external contacts using paging
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getExternalcontactsScanNotes

      public CursorNoteListing getExternalcontactsScanNotes(Integer limit, String cursor, String divisionId) throws IOException, ApiException
      Scan for notes using paging
      Parameters:
      limit - The number of notes per page; must be between 10 and 200, default is 100 (optional)
      cursor - Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL (optional)
      divisionId - The division to scan over (optional, default to *)
      Returns:
      CursorNoteListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getExternalcontactsScanNotesWithHttpInfo

      public ApiResponse<CursorNoteListing> getExternalcontactsScanNotesWithHttpInfo(Integer limit, String cursor, String divisionId) throws IOException
      Scan for notes using paging
      Parameters:
      limit - The number of notes per page; must be between 10 and 200, default is 100 (optional)
      cursor - Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL (optional)
      divisionId - The division to scan over (optional, default to *)
      Returns:
      CursorNoteListing
      Throws:
      IOException - if the request fails to be processed
    • getExternalcontactsScanNotes

      public CursorNoteListing getExternalcontactsScanNotes(GetExternalcontactsScanNotesRequest request) throws IOException, ApiException
      Scan for notes using paging
      Parameters:
      request - The request object
      Returns:
      CursorNoteListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getExternalcontactsScanNotes

      public ApiResponse<CursorNoteListing> getExternalcontactsScanNotes(ApiRequest<Void> request) throws IOException
      Scan for notes using paging
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getExternalcontactsScanNotesDivisionviewsAll

      public CursorNoteListing getExternalcontactsScanNotesDivisionviewsAll(Integer limit, String cursor) throws IOException, ApiException
      Scan for notes using paging
      Parameters:
      limit - The number of notes per page; must be between 10 and 200, default is 100 (optional)
      cursor - Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL (optional)
      Returns:
      CursorNoteListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getExternalcontactsScanNotesDivisionviewsAllWithHttpInfo

      public ApiResponse<CursorNoteListing> getExternalcontactsScanNotesDivisionviewsAllWithHttpInfo(Integer limit, String cursor) throws IOException
      Scan for notes using paging
      Parameters:
      limit - The number of notes per page; must be between 10 and 200, default is 100 (optional)
      cursor - Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL (optional)
      Returns:
      CursorNoteListing
      Throws:
      IOException - if the request fails to be processed
    • getExternalcontactsScanNotesDivisionviewsAll

      public CursorNoteListing getExternalcontactsScanNotesDivisionviewsAll(GetExternalcontactsScanNotesDivisionviewsAllRequest request) throws IOException, ApiException
      Scan for notes using paging
      Parameters:
      request - The request object
      Returns:
      CursorNoteListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getExternalcontactsScanNotesDivisionviewsAll

      public ApiResponse<CursorNoteListing> getExternalcontactsScanNotesDivisionviewsAll(ApiRequest<Void> request) throws IOException
      Scan for notes using paging
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getExternalcontactsScanOrganizations

      public CursorOrganizationListing getExternalcontactsScanOrganizations(Integer limit, String cursor, String divisionId) throws IOException, ApiException
      Scan for external organizations using paging
      Parameters:
      limit - The number of organizations per page; must be between 10 and 200, default is 100 (optional)
      cursor - Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL (optional)
      divisionId - The division to scan over (optional, default to *)
      Returns:
      CursorOrganizationListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getExternalcontactsScanOrganizationsWithHttpInfo

      public ApiResponse<CursorOrganizationListing> getExternalcontactsScanOrganizationsWithHttpInfo(Integer limit, String cursor, String divisionId) throws IOException
      Scan for external organizations using paging
      Parameters:
      limit - The number of organizations per page; must be between 10 and 200, default is 100 (optional)
      cursor - Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL (optional)
      divisionId - The division to scan over (optional, default to *)
      Returns:
      CursorOrganizationListing
      Throws:
      IOException - if the request fails to be processed
    • getExternalcontactsScanOrganizations

      public CursorOrganizationListing getExternalcontactsScanOrganizations(GetExternalcontactsScanOrganizationsRequest request) throws IOException, ApiException
      Scan for external organizations using paging
      Parameters:
      request - The request object
      Returns:
      CursorOrganizationListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getExternalcontactsScanOrganizations

      public ApiResponse<CursorOrganizationListing> getExternalcontactsScanOrganizations(ApiRequest<Void> request) throws IOException
      Scan for external organizations using paging
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getExternalcontactsScanOrganizationsDivisionviewsAll

      public CursorOrganizationListing getExternalcontactsScanOrganizationsDivisionviewsAll(Integer limit, String cursor) throws IOException, ApiException
      Scan for external organizations using paging
      Parameters:
      limit - The number of organizations per page; must be between 10 and 200, default is 100 (optional)
      cursor - Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL (optional)
      Returns:
      CursorOrganizationListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getExternalcontactsScanOrganizationsDivisionviewsAllWithHttpInfo

      public ApiResponse<CursorOrganizationListing> getExternalcontactsScanOrganizationsDivisionviewsAllWithHttpInfo(Integer limit, String cursor) throws IOException
      Scan for external organizations using paging
      Parameters:
      limit - The number of organizations per page; must be between 10 and 200, default is 100 (optional)
      cursor - Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL (optional)
      Returns:
      CursorOrganizationListing
      Throws:
      IOException - if the request fails to be processed
    • getExternalcontactsScanOrganizationsDivisionviewsAll

      public CursorOrganizationListing getExternalcontactsScanOrganizationsDivisionviewsAll(GetExternalcontactsScanOrganizationsDivisionviewsAllRequest request) throws IOException, ApiException
      Scan for external organizations using paging
      Parameters:
      request - The request object
      Returns:
      CursorOrganizationListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getExternalcontactsScanOrganizationsDivisionviewsAll

      public ApiResponse<CursorOrganizationListing> getExternalcontactsScanOrganizationsDivisionviewsAll(ApiRequest<Void> request) throws IOException
      Scan for external organizations using paging
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getExternalcontactsScanRelationships

      public CursorRelationshipListing getExternalcontactsScanRelationships(Integer limit, String cursor, String divisionId) throws IOException, ApiException
      Scan for relationships
      Parameters:
      limit - The number of relationships per page; must be between 10 and 200, default is 100 (optional)
      cursor - Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL (optional)
      divisionId - The division to scan over (optional, default to *)
      Returns:
      CursorRelationshipListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getExternalcontactsScanRelationshipsWithHttpInfo

      public ApiResponse<CursorRelationshipListing> getExternalcontactsScanRelationshipsWithHttpInfo(Integer limit, String cursor, String divisionId) throws IOException
      Scan for relationships
      Parameters:
      limit - The number of relationships per page; must be between 10 and 200, default is 100 (optional)
      cursor - Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL (optional)
      divisionId - The division to scan over (optional, default to *)
      Returns:
      CursorRelationshipListing
      Throws:
      IOException - if the request fails to be processed
    • getExternalcontactsScanRelationships

      public CursorRelationshipListing getExternalcontactsScanRelationships(GetExternalcontactsScanRelationshipsRequest request) throws IOException, ApiException
      Scan for relationships
      Parameters:
      request - The request object
      Returns:
      CursorRelationshipListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getExternalcontactsScanRelationships

      public ApiResponse<CursorRelationshipListing> getExternalcontactsScanRelationships(ApiRequest<Void> request) throws IOException
      Scan for relationships
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getExternalcontactsScanRelationshipsDivisionviewsAll

      public CursorRelationshipListing getExternalcontactsScanRelationshipsDivisionviewsAll(Integer limit, String cursor) throws IOException, ApiException
      Scan for relationships
      Parameters:
      limit - The number of relationships per page; must be between 10 and 200, default is 100 (optional)
      cursor - Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL (optional)
      Returns:
      CursorRelationshipListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getExternalcontactsScanRelationshipsDivisionviewsAllWithHttpInfo

      public ApiResponse<CursorRelationshipListing> getExternalcontactsScanRelationshipsDivisionviewsAllWithHttpInfo(Integer limit, String cursor) throws IOException
      Scan for relationships
      Parameters:
      limit - The number of relationships per page; must be between 10 and 200, default is 100 (optional)
      cursor - Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL (optional)
      Returns:
      CursorRelationshipListing
      Throws:
      IOException - if the request fails to be processed
    • getExternalcontactsScanRelationshipsDivisionviewsAll

      public CursorRelationshipListing getExternalcontactsScanRelationshipsDivisionviewsAll(GetExternalcontactsScanRelationshipsDivisionviewsAllRequest request) throws IOException, ApiException
      Scan for relationships
      Parameters:
      request - The request object
      Returns:
      CursorRelationshipListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getExternalcontactsScanRelationshipsDivisionviewsAll

      public ApiResponse<CursorRelationshipListing> getExternalcontactsScanRelationshipsDivisionviewsAll(ApiRequest<Void> request) throws IOException
      Scan for relationships
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • patchExternalcontactsContact

      public ExternalContact patchExternalcontactsContact(String contactId, ExternalContactsPatchRequest body) throws IOException, ApiException
      Update specific fields of an external contact
      Parameters:
      contactId - ExternalContact ID (required)
      body - Contact fields to update (required)
      Returns:
      ExternalContact
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchExternalcontactsContactWithHttpInfo

      public ApiResponse<ExternalContact> patchExternalcontactsContactWithHttpInfo(String contactId, ExternalContactsPatchRequest body) throws IOException
      Update specific fields of an external contact
      Parameters:
      contactId - ExternalContact ID (required)
      body - Contact fields to update (required)
      Returns:
      ExternalContact
      Throws:
      IOException - if the request fails to be processed
    • patchExternalcontactsContact

      public ExternalContact patchExternalcontactsContact(PatchExternalcontactsContactRequest request) throws IOException, ApiException
      Update specific fields of an external contact
      Parameters:
      request - The request object
      Returns:
      ExternalContact
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchExternalcontactsContact

      public ApiResponse<ExternalContact> patchExternalcontactsContact(ApiRequest<ExternalContactsPatchRequest> request) throws IOException
      Update specific fields of an external contact
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • patchExternalcontactsContactIdentifiers

      public ContactIdentifier patchExternalcontactsContactIdentifiers(String contactId, IdentifierClaimRequest body) throws IOException, ApiException
      Claim or release identifiers for a contact
      Parameters:
      contactId - ExternalContact ID (required)
      body - ClaimRequest (required)
      Returns:
      ContactIdentifier
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchExternalcontactsContactIdentifiersWithHttpInfo

      public ApiResponse<ContactIdentifier> patchExternalcontactsContactIdentifiersWithHttpInfo(String contactId, IdentifierClaimRequest body) throws IOException
      Claim or release identifiers for a contact
      Parameters:
      contactId - ExternalContact ID (required)
      body - ClaimRequest (required)
      Returns:
      ContactIdentifier
      Throws:
      IOException - if the request fails to be processed
    • patchExternalcontactsContactIdentifiers

      public ContactIdentifier patchExternalcontactsContactIdentifiers(PatchExternalcontactsContactIdentifiersRequest request) throws IOException, ApiException
      Claim or release identifiers for a contact
      Parameters:
      request - The request object
      Returns:
      ContactIdentifier
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchExternalcontactsContactIdentifiers

      public ApiResponse<ContactIdentifier> patchExternalcontactsContactIdentifiers(ApiRequest<IdentifierClaimRequest> request) throws IOException
      Claim or release identifiers for a contact
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • patchExternalcontactsOrganizationIdentifiers

      public ExternalOrganizationIdentifier patchExternalcontactsOrganizationIdentifiers(String externalOrganizationId, ExternalOrganizationIdentifierClaimRequest body) throws IOException, ApiException
      Claim or release identifiers for an external organization
      Parameters:
      externalOrganizationId - External Organization ID (required)
      body - ClaimRequest (required)
      Returns:
      ExternalOrganizationIdentifier
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchExternalcontactsOrganizationIdentifiersWithHttpInfo

      public ApiResponse<ExternalOrganizationIdentifier> patchExternalcontactsOrganizationIdentifiersWithHttpInfo(String externalOrganizationId, ExternalOrganizationIdentifierClaimRequest body) throws IOException
      Claim or release identifiers for an external organization
      Parameters:
      externalOrganizationId - External Organization ID (required)
      body - ClaimRequest (required)
      Returns:
      ExternalOrganizationIdentifier
      Throws:
      IOException - if the request fails to be processed
    • patchExternalcontactsOrganizationIdentifiers

      public ExternalOrganizationIdentifier patchExternalcontactsOrganizationIdentifiers(PatchExternalcontactsOrganizationIdentifiersRequest request) throws IOException, ApiException
      Claim or release identifiers for an external organization
      Parameters:
      request - The request object
      Returns:
      ExternalOrganizationIdentifier
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchExternalcontactsOrganizationIdentifiers

      public ApiResponse<ExternalOrganizationIdentifier> patchExternalcontactsOrganizationIdentifiers(ApiRequest<ExternalOrganizationIdentifierClaimRequest> request) throws IOException
      Claim or release identifiers for an external organization
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postExternalcontactsBulkContacts

      public BulkFetchContactsResponse postExternalcontactsBulkContacts(BulkIdsRequest body) throws IOException, ApiException
      Bulk fetch contacts
      Parameters:
      body - Contact ids (required)
      Returns:
      BulkFetchContactsResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postExternalcontactsBulkContactsWithHttpInfo

      public ApiResponse<BulkFetchContactsResponse> postExternalcontactsBulkContactsWithHttpInfo(BulkIdsRequest body) throws IOException
      Bulk fetch contacts
      Parameters:
      body - Contact ids (required)
      Returns:
      BulkFetchContactsResponse
      Throws:
      IOException - if the request fails to be processed
    • postExternalcontactsBulkContacts

      public BulkFetchContactsResponse postExternalcontactsBulkContacts(PostExternalcontactsBulkContactsRequest request) throws IOException, ApiException
      Bulk fetch contacts
      Parameters:
      request - The request object
      Returns:
      BulkFetchContactsResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postExternalcontactsBulkContacts

      public ApiResponse<BulkFetchContactsResponse> postExternalcontactsBulkContacts(ApiRequest<BulkIdsRequest> request) throws IOException
      Bulk fetch contacts
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postExternalcontactsBulkContactsAdd

      public BulkContactsResponse postExternalcontactsBulkContactsAdd(BulkContactsRequest body) throws IOException, ApiException
      Bulk add contacts
      Parameters:
      body - Contacts (required)
      Returns:
      BulkContactsResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postExternalcontactsBulkContactsAddWithHttpInfo

      public ApiResponse<BulkContactsResponse> postExternalcontactsBulkContactsAddWithHttpInfo(BulkContactsRequest body) throws IOException
      Bulk add contacts
      Parameters:
      body - Contacts (required)
      Returns:
      BulkContactsResponse
      Throws:
      IOException - if the request fails to be processed
    • postExternalcontactsBulkContactsAdd

      public BulkContactsResponse postExternalcontactsBulkContactsAdd(PostExternalcontactsBulkContactsAddRequest request) throws IOException, ApiException
      Bulk add contacts
      Parameters:
      request - The request object
      Returns:
      BulkContactsResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postExternalcontactsBulkContactsAdd

      public ApiResponse<BulkContactsResponse> postExternalcontactsBulkContactsAdd(ApiRequest<BulkContactsRequest> request) throws IOException
      Bulk add contacts
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postExternalcontactsBulkContactsDivisionviews

      public BulkFetchContactsResponse postExternalcontactsBulkContactsDivisionviews(BulkIdsRequest body) throws IOException, ApiException
      Bulk fetch contacts across divisions
      Parameters:
      body - Contact ids (required)
      Returns:
      BulkFetchContactsResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postExternalcontactsBulkContactsDivisionviewsWithHttpInfo

      public ApiResponse<BulkFetchContactsResponse> postExternalcontactsBulkContactsDivisionviewsWithHttpInfo(BulkIdsRequest body) throws IOException
      Bulk fetch contacts across divisions
      Parameters:
      body - Contact ids (required)
      Returns:
      BulkFetchContactsResponse
      Throws:
      IOException - if the request fails to be processed
    • postExternalcontactsBulkContactsDivisionviews

      public BulkFetchContactsResponse postExternalcontactsBulkContactsDivisionviews(PostExternalcontactsBulkContactsDivisionviewsRequest request) throws IOException, ApiException
      Bulk fetch contacts across divisions
      Parameters:
      request - The request object
      Returns:
      BulkFetchContactsResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postExternalcontactsBulkContactsDivisionviews

      public ApiResponse<BulkFetchContactsResponse> postExternalcontactsBulkContactsDivisionviews(ApiRequest<BulkIdsRequest> request) throws IOException
      Bulk fetch contacts across divisions
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postExternalcontactsBulkContactsEnrich

      public BulkContactsEnrichResponse postExternalcontactsBulkContactsEnrich(BulkContactsEnrichRequest body, Boolean dryRun) throws IOException, ApiException
      Bulk Enrich Contacts - Run up to 10 Enrich operations per request See the API endpoint /externalcontacts/contacts/enrich for docs on individual Enrich operations.
      Parameters:
      body - Contact Enrich Requests (required)
      dryRun - If true, the request will not make any modifications, but will show you what the end result *would* be. (optional)
      Returns:
      BulkContactsEnrichResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postExternalcontactsBulkContactsEnrichWithHttpInfo

      public ApiResponse<BulkContactsEnrichResponse> postExternalcontactsBulkContactsEnrichWithHttpInfo(BulkContactsEnrichRequest body, Boolean dryRun) throws IOException
      Bulk Enrich Contacts - Run up to 10 Enrich operations per request See the API endpoint /externalcontacts/contacts/enrich for docs on individual Enrich operations.
      Parameters:
      body - Contact Enrich Requests (required)
      dryRun - If true, the request will not make any modifications, but will show you what the end result *would* be. (optional)
      Returns:
      BulkContactsEnrichResponse
      Throws:
      IOException - if the request fails to be processed
    • postExternalcontactsBulkContactsEnrich

      public BulkContactsEnrichResponse postExternalcontactsBulkContactsEnrich(PostExternalcontactsBulkContactsEnrichRequest request) throws IOException, ApiException
      Bulk Enrich Contacts - Run up to 10 Enrich operations per request See the API endpoint /externalcontacts/contacts/enrich for docs on individual Enrich operations.
      Parameters:
      request - The request object
      Returns:
      BulkContactsEnrichResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postExternalcontactsBulkContactsEnrich

      public ApiResponse<BulkContactsEnrichResponse> postExternalcontactsBulkContactsEnrich(ApiRequest<BulkContactsEnrichRequest> request) throws IOException
      Bulk Enrich Contacts - Run up to 10 Enrich operations per request See the API endpoint /externalcontacts/contacts/enrich for docs on individual Enrich operations.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postExternalcontactsBulkContactsRemove

      public BulkDeleteResponse postExternalcontactsBulkContactsRemove(BulkIdsRequest body) throws IOException, ApiException
      Bulk remove contacts
      Parameters:
      body - Contact ids (required)
      Returns:
      BulkDeleteResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postExternalcontactsBulkContactsRemoveWithHttpInfo

      public ApiResponse<BulkDeleteResponse> postExternalcontactsBulkContactsRemoveWithHttpInfo(BulkIdsRequest body) throws IOException
      Bulk remove contacts
      Parameters:
      body - Contact ids (required)
      Returns:
      BulkDeleteResponse
      Throws:
      IOException - if the request fails to be processed
    • postExternalcontactsBulkContactsRemove

      public BulkDeleteResponse postExternalcontactsBulkContactsRemove(PostExternalcontactsBulkContactsRemoveRequest request) throws IOException, ApiException
      Bulk remove contacts
      Parameters:
      request - The request object
      Returns:
      BulkDeleteResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postExternalcontactsBulkContactsRemove

      public ApiResponse<BulkDeleteResponse> postExternalcontactsBulkContactsRemove(ApiRequest<BulkIdsRequest> request) throws IOException
      Bulk remove contacts
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postExternalcontactsBulkContactsUnresolved

      public BulkFetchContactsResponse postExternalcontactsBulkContactsUnresolved(BulkIdsRequest body) throws IOException, ApiException
      Bulk fetch unresolved ancestor contacts
      Parameters:
      body - Contact ids (required)
      Returns:
      BulkFetchContactsResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postExternalcontactsBulkContactsUnresolvedWithHttpInfo

      public ApiResponse<BulkFetchContactsResponse> postExternalcontactsBulkContactsUnresolvedWithHttpInfo(BulkIdsRequest body) throws IOException
      Bulk fetch unresolved ancestor contacts
      Parameters:
      body - Contact ids (required)
      Returns:
      BulkFetchContactsResponse
      Throws:
      IOException - if the request fails to be processed
    • postExternalcontactsBulkContactsUnresolved

      public BulkFetchContactsResponse postExternalcontactsBulkContactsUnresolved(PostExternalcontactsBulkContactsUnresolvedRequest request) throws IOException, ApiException
      Bulk fetch unresolved ancestor contacts
      Parameters:
      request - The request object
      Returns:
      BulkFetchContactsResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postExternalcontactsBulkContactsUnresolved

      public ApiResponse<BulkFetchContactsResponse> postExternalcontactsBulkContactsUnresolved(ApiRequest<BulkIdsRequest> request) throws IOException
      Bulk fetch unresolved ancestor contacts
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postExternalcontactsBulkContactsUpdate

      public BulkContactsResponse postExternalcontactsBulkContactsUpdate(BulkContactsRequest body) throws IOException, ApiException
      Bulk update contacts
      Parameters:
      body - Contacts (required)
      Returns:
      BulkContactsResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postExternalcontactsBulkContactsUpdateWithHttpInfo

      public ApiResponse<BulkContactsResponse> postExternalcontactsBulkContactsUpdateWithHttpInfo(BulkContactsRequest body) throws IOException
      Bulk update contacts
      Parameters:
      body - Contacts (required)
      Returns:
      BulkContactsResponse
      Throws:
      IOException - if the request fails to be processed
    • postExternalcontactsBulkContactsUpdate

      public BulkContactsResponse postExternalcontactsBulkContactsUpdate(PostExternalcontactsBulkContactsUpdateRequest request) throws IOException, ApiException
      Bulk update contacts
      Parameters:
      request - The request object
      Returns:
      BulkContactsResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postExternalcontactsBulkContactsUpdate

      public ApiResponse<BulkContactsResponse> postExternalcontactsBulkContactsUpdate(ApiRequest<BulkContactsRequest> request) throws IOException
      Bulk update contacts
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postExternalcontactsBulkNotes

      public BulkFetchNotesResponse postExternalcontactsBulkNotes(BulkIdsRequest body) throws IOException, ApiException
      Bulk fetch notes
      Parameters:
      body - Note ids (required)
      Returns:
      BulkFetchNotesResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postExternalcontactsBulkNotesWithHttpInfo

      public ApiResponse<BulkFetchNotesResponse> postExternalcontactsBulkNotesWithHttpInfo(BulkIdsRequest body) throws IOException
      Bulk fetch notes
      Parameters:
      body - Note ids (required)
      Returns:
      BulkFetchNotesResponse
      Throws:
      IOException - if the request fails to be processed
    • postExternalcontactsBulkNotes

      public BulkFetchNotesResponse postExternalcontactsBulkNotes(PostExternalcontactsBulkNotesRequest request) throws IOException, ApiException
      Bulk fetch notes
      Parameters:
      request - The request object
      Returns:
      BulkFetchNotesResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postExternalcontactsBulkNotes

      public ApiResponse<BulkFetchNotesResponse> postExternalcontactsBulkNotes(ApiRequest<BulkIdsRequest> request) throws IOException
      Bulk fetch notes
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postExternalcontactsBulkNotesAdd

      public BulkNotesResponse postExternalcontactsBulkNotesAdd(BulkNotesRequest body) throws IOException, ApiException
      Bulk add notes
      Parameters:
      body - Notes (required)
      Returns:
      BulkNotesResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postExternalcontactsBulkNotesAddWithHttpInfo

      public ApiResponse<BulkNotesResponse> postExternalcontactsBulkNotesAddWithHttpInfo(BulkNotesRequest body) throws IOException
      Bulk add notes
      Parameters:
      body - Notes (required)
      Returns:
      BulkNotesResponse
      Throws:
      IOException - if the request fails to be processed
    • postExternalcontactsBulkNotesAdd

      public BulkNotesResponse postExternalcontactsBulkNotesAdd(PostExternalcontactsBulkNotesAddRequest request) throws IOException, ApiException
      Bulk add notes
      Parameters:
      request - The request object
      Returns:
      BulkNotesResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postExternalcontactsBulkNotesAdd

      public ApiResponse<BulkNotesResponse> postExternalcontactsBulkNotesAdd(ApiRequest<BulkNotesRequest> request) throws IOException
      Bulk add notes
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postExternalcontactsBulkNotesRemove

      public BulkDeleteResponse postExternalcontactsBulkNotesRemove(BulkIdsRequest body) throws IOException, ApiException
      Bulk remove notes
      Parameters:
      body - Note ids (required)
      Returns:
      BulkDeleteResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postExternalcontactsBulkNotesRemoveWithHttpInfo

      public ApiResponse<BulkDeleteResponse> postExternalcontactsBulkNotesRemoveWithHttpInfo(BulkIdsRequest body) throws IOException
      Bulk remove notes
      Parameters:
      body - Note ids (required)
      Returns:
      BulkDeleteResponse
      Throws:
      IOException - if the request fails to be processed
    • postExternalcontactsBulkNotesRemove

      public BulkDeleteResponse postExternalcontactsBulkNotesRemove(PostExternalcontactsBulkNotesRemoveRequest request) throws IOException, ApiException
      Bulk remove notes
      Parameters:
      request - The request object
      Returns:
      BulkDeleteResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postExternalcontactsBulkNotesRemove

      public ApiResponse<BulkDeleteResponse> postExternalcontactsBulkNotesRemove(ApiRequest<BulkIdsRequest> request) throws IOException
      Bulk remove notes
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postExternalcontactsBulkNotesUpdate

      public BulkNotesResponse postExternalcontactsBulkNotesUpdate(BulkNotesRequest body) throws IOException, ApiException
      Bulk update notes
      Parameters:
      body - Notes (required)
      Returns:
      BulkNotesResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postExternalcontactsBulkNotesUpdateWithHttpInfo

      public ApiResponse<BulkNotesResponse> postExternalcontactsBulkNotesUpdateWithHttpInfo(BulkNotesRequest body) throws IOException
      Bulk update notes
      Parameters:
      body - Notes (required)
      Returns:
      BulkNotesResponse
      Throws:
      IOException - if the request fails to be processed
    • postExternalcontactsBulkNotesUpdate

      public BulkNotesResponse postExternalcontactsBulkNotesUpdate(PostExternalcontactsBulkNotesUpdateRequest request) throws IOException, ApiException
      Bulk update notes
      Parameters:
      request - The request object
      Returns:
      BulkNotesResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postExternalcontactsBulkNotesUpdate

      public ApiResponse<BulkNotesResponse> postExternalcontactsBulkNotesUpdate(ApiRequest<BulkNotesRequest> request) throws IOException
      Bulk update notes
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postExternalcontactsBulkOrganizations

      public BulkFetchOrganizationsResponse postExternalcontactsBulkOrganizations(BulkIdsRequest body) throws IOException, ApiException
      Bulk fetch organizations
      Parameters:
      body - Organizations ids (required)
      Returns:
      BulkFetchOrganizationsResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postExternalcontactsBulkOrganizationsWithHttpInfo

      public ApiResponse<BulkFetchOrganizationsResponse> postExternalcontactsBulkOrganizationsWithHttpInfo(BulkIdsRequest body) throws IOException
      Bulk fetch organizations
      Parameters:
      body - Organizations ids (required)
      Returns:
      BulkFetchOrganizationsResponse
      Throws:
      IOException - if the request fails to be processed
    • postExternalcontactsBulkOrganizations

      public BulkFetchOrganizationsResponse postExternalcontactsBulkOrganizations(PostExternalcontactsBulkOrganizationsRequest request) throws IOException, ApiException
      Bulk fetch organizations
      Parameters:
      request - The request object
      Returns:
      BulkFetchOrganizationsResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postExternalcontactsBulkOrganizations

      public ApiResponse<BulkFetchOrganizationsResponse> postExternalcontactsBulkOrganizations(ApiRequest<BulkIdsRequest> request) throws IOException
      Bulk fetch organizations
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postExternalcontactsBulkOrganizationsAdd

      public BulkOrganizationsResponse postExternalcontactsBulkOrganizationsAdd(BulkOrganizationsRequest body) throws IOException, ApiException
      Bulk add organizations
      Parameters:
      body - Organizations (required)
      Returns:
      BulkOrganizationsResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postExternalcontactsBulkOrganizationsAddWithHttpInfo

      public ApiResponse<BulkOrganizationsResponse> postExternalcontactsBulkOrganizationsAddWithHttpInfo(BulkOrganizationsRequest body) throws IOException
      Bulk add organizations
      Parameters:
      body - Organizations (required)
      Returns:
      BulkOrganizationsResponse
      Throws:
      IOException - if the request fails to be processed
    • postExternalcontactsBulkOrganizationsAdd

      public BulkOrganizationsResponse postExternalcontactsBulkOrganizationsAdd(PostExternalcontactsBulkOrganizationsAddRequest request) throws IOException, ApiException
      Bulk add organizations
      Parameters:
      request - The request object
      Returns:
      BulkOrganizationsResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postExternalcontactsBulkOrganizationsAdd

      public ApiResponse<BulkOrganizationsResponse> postExternalcontactsBulkOrganizationsAdd(ApiRequest<BulkOrganizationsRequest> request) throws IOException
      Bulk add organizations
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postExternalcontactsBulkOrganizationsDivisionviews

      public BulkFetchOrganizationsResponse postExternalcontactsBulkOrganizationsDivisionviews(BulkIdsRequest body) throws IOException, ApiException
      Bulk fetch organizations across divisions
      Parameters:
      body - Organizations ids (required)
      Returns:
      BulkFetchOrganizationsResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postExternalcontactsBulkOrganizationsDivisionviewsWithHttpInfo

      public ApiResponse<BulkFetchOrganizationsResponse> postExternalcontactsBulkOrganizationsDivisionviewsWithHttpInfo(BulkIdsRequest body) throws IOException
      Bulk fetch organizations across divisions
      Parameters:
      body - Organizations ids (required)
      Returns:
      BulkFetchOrganizationsResponse
      Throws:
      IOException - if the request fails to be processed
    • postExternalcontactsBulkOrganizationsDivisionviews

      public BulkFetchOrganizationsResponse postExternalcontactsBulkOrganizationsDivisionviews(PostExternalcontactsBulkOrganizationsDivisionviewsRequest request) throws IOException, ApiException
      Bulk fetch organizations across divisions
      Parameters:
      request - The request object
      Returns:
      BulkFetchOrganizationsResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postExternalcontactsBulkOrganizationsDivisionviews

      public ApiResponse<BulkFetchOrganizationsResponse> postExternalcontactsBulkOrganizationsDivisionviews(ApiRequest<BulkIdsRequest> request) throws IOException
      Bulk fetch organizations across divisions
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postExternalcontactsBulkOrganizationsEnrich

      public BulkOrganizationsEnrichResponse postExternalcontactsBulkOrganizationsEnrich(BulkOrganizationsEnrichRequest body, Boolean dryRun) throws IOException, ApiException
      Bulk enrich external organizations - Run up to 10 Enrich operations per request See the API endpoint /externalcontacts/organizations/enrich for docs on individual Enrich operations.
      Parameters:
      body - External Organization Enrich Requests (required)
      dryRun - If true, the request will not make any modifications, but will show you what the end result *would* be. (optional)
      Returns:
      BulkOrganizationsEnrichResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postExternalcontactsBulkOrganizationsEnrichWithHttpInfo

      public ApiResponse<BulkOrganizationsEnrichResponse> postExternalcontactsBulkOrganizationsEnrichWithHttpInfo(BulkOrganizationsEnrichRequest body, Boolean dryRun) throws IOException
      Bulk enrich external organizations - Run up to 10 Enrich operations per request See the API endpoint /externalcontacts/organizations/enrich for docs on individual Enrich operations.
      Parameters:
      body - External Organization Enrich Requests (required)
      dryRun - If true, the request will not make any modifications, but will show you what the end result *would* be. (optional)
      Returns:
      BulkOrganizationsEnrichResponse
      Throws:
      IOException - if the request fails to be processed
    • postExternalcontactsBulkOrganizationsEnrich

      public BulkOrganizationsEnrichResponse postExternalcontactsBulkOrganizationsEnrich(PostExternalcontactsBulkOrganizationsEnrichRequest request) throws IOException, ApiException
      Bulk enrich external organizations - Run up to 10 Enrich operations per request See the API endpoint /externalcontacts/organizations/enrich for docs on individual Enrich operations.
      Parameters:
      request - The request object
      Returns:
      BulkOrganizationsEnrichResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postExternalcontactsBulkOrganizationsEnrich

      public ApiResponse<BulkOrganizationsEnrichResponse> postExternalcontactsBulkOrganizationsEnrich(ApiRequest<BulkOrganizationsEnrichRequest> request) throws IOException
      Bulk enrich external organizations - Run up to 10 Enrich operations per request See the API endpoint /externalcontacts/organizations/enrich for docs on individual Enrich operations.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postExternalcontactsBulkOrganizationsRemove

      public BulkDeleteResponse postExternalcontactsBulkOrganizationsRemove(BulkIdsRequest body) throws IOException, ApiException
      Bulk remove organizations
      Parameters:
      body - Organization ids (required)
      Returns:
      BulkDeleteResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postExternalcontactsBulkOrganizationsRemoveWithHttpInfo

      public ApiResponse<BulkDeleteResponse> postExternalcontactsBulkOrganizationsRemoveWithHttpInfo(BulkIdsRequest body) throws IOException
      Bulk remove organizations
      Parameters:
      body - Organization ids (required)
      Returns:
      BulkDeleteResponse
      Throws:
      IOException - if the request fails to be processed
    • postExternalcontactsBulkOrganizationsRemove

      public BulkDeleteResponse postExternalcontactsBulkOrganizationsRemove(PostExternalcontactsBulkOrganizationsRemoveRequest request) throws IOException, ApiException
      Bulk remove organizations
      Parameters:
      request - The request object
      Returns:
      BulkDeleteResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postExternalcontactsBulkOrganizationsRemove

      public ApiResponse<BulkDeleteResponse> postExternalcontactsBulkOrganizationsRemove(ApiRequest<BulkIdsRequest> request) throws IOException
      Bulk remove organizations
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postExternalcontactsBulkOrganizationsUpdate

      public BulkOrganizationsResponse postExternalcontactsBulkOrganizationsUpdate(BulkOrganizationsRequest body) throws IOException, ApiException
      Bulk update organizations
      Parameters:
      body - Organizations (required)
      Returns:
      BulkOrganizationsResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postExternalcontactsBulkOrganizationsUpdateWithHttpInfo

      public ApiResponse<BulkOrganizationsResponse> postExternalcontactsBulkOrganizationsUpdateWithHttpInfo(BulkOrganizationsRequest body) throws IOException
      Bulk update organizations
      Parameters:
      body - Organizations (required)
      Returns:
      BulkOrganizationsResponse
      Throws:
      IOException - if the request fails to be processed
    • postExternalcontactsBulkOrganizationsUpdate

      public BulkOrganizationsResponse postExternalcontactsBulkOrganizationsUpdate(PostExternalcontactsBulkOrganizationsUpdateRequest request) throws IOException, ApiException
      Bulk update organizations
      Parameters:
      request - The request object
      Returns:
      BulkOrganizationsResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postExternalcontactsBulkOrganizationsUpdate

      public ApiResponse<BulkOrganizationsResponse> postExternalcontactsBulkOrganizationsUpdate(ApiRequest<BulkOrganizationsRequest> request) throws IOException
      Bulk update organizations
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postExternalcontactsBulkRelationships

      public BulkFetchRelationshipsResponse postExternalcontactsBulkRelationships(BulkIdsRequest body) throws IOException, ApiException
      Bulk fetch relationships
      Parameters:
      body - Relationships ids (required)
      Returns:
      BulkFetchRelationshipsResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postExternalcontactsBulkRelationshipsWithHttpInfo

      public ApiResponse<BulkFetchRelationshipsResponse> postExternalcontactsBulkRelationshipsWithHttpInfo(BulkIdsRequest body) throws IOException
      Bulk fetch relationships
      Parameters:
      body - Relationships ids (required)
      Returns:
      BulkFetchRelationshipsResponse
      Throws:
      IOException - if the request fails to be processed
    • postExternalcontactsBulkRelationships

      public BulkFetchRelationshipsResponse postExternalcontactsBulkRelationships(PostExternalcontactsBulkRelationshipsRequest request) throws IOException, ApiException
      Bulk fetch relationships
      Parameters:
      request - The request object
      Returns:
      BulkFetchRelationshipsResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postExternalcontactsBulkRelationships

      public ApiResponse<BulkFetchRelationshipsResponse> postExternalcontactsBulkRelationships(ApiRequest<BulkIdsRequest> request) throws IOException
      Bulk fetch relationships
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postExternalcontactsBulkRelationshipsAdd

      public BulkRelationshipsResponse postExternalcontactsBulkRelationshipsAdd(BulkRelationshipsRequest body) throws IOException, ApiException
      Bulk add relationships
      Parameters:
      body - Relationships (required)
      Returns:
      BulkRelationshipsResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postExternalcontactsBulkRelationshipsAddWithHttpInfo

      public ApiResponse<BulkRelationshipsResponse> postExternalcontactsBulkRelationshipsAddWithHttpInfo(BulkRelationshipsRequest body) throws IOException
      Bulk add relationships
      Parameters:
      body - Relationships (required)
      Returns:
      BulkRelationshipsResponse
      Throws:
      IOException - if the request fails to be processed
    • postExternalcontactsBulkRelationshipsAdd

      public BulkRelationshipsResponse postExternalcontactsBulkRelationshipsAdd(PostExternalcontactsBulkRelationshipsAddRequest request) throws IOException, ApiException
      Bulk add relationships
      Parameters:
      request - The request object
      Returns:
      BulkRelationshipsResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postExternalcontactsBulkRelationshipsAdd

      public ApiResponse<BulkRelationshipsResponse> postExternalcontactsBulkRelationshipsAdd(ApiRequest<BulkRelationshipsRequest> request) throws IOException
      Bulk add relationships
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postExternalcontactsBulkRelationshipsRemove

      public BulkDeleteResponse postExternalcontactsBulkRelationshipsRemove(BulkIdsRequest body) throws IOException, ApiException
      Bulk remove relationships
      Parameters:
      body - Relationships ids (required)
      Returns:
      BulkDeleteResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postExternalcontactsBulkRelationshipsRemoveWithHttpInfo

      public ApiResponse<BulkDeleteResponse> postExternalcontactsBulkRelationshipsRemoveWithHttpInfo(BulkIdsRequest body) throws IOException
      Bulk remove relationships
      Parameters:
      body - Relationships ids (required)
      Returns:
      BulkDeleteResponse
      Throws:
      IOException - if the request fails to be processed
    • postExternalcontactsBulkRelationshipsRemove

      public BulkDeleteResponse postExternalcontactsBulkRelationshipsRemove(PostExternalcontactsBulkRelationshipsRemoveRequest request) throws IOException, ApiException
      Bulk remove relationships
      Parameters:
      request - The request object
      Returns:
      BulkDeleteResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postExternalcontactsBulkRelationshipsRemove

      public ApiResponse<BulkDeleteResponse> postExternalcontactsBulkRelationshipsRemove(ApiRequest<BulkIdsRequest> request) throws IOException
      Bulk remove relationships
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postExternalcontactsBulkRelationshipsUpdate

      public BulkRelationshipsResponse postExternalcontactsBulkRelationshipsUpdate(BulkRelationshipsRequest body) throws IOException, ApiException
      Bulk update relationships
      Parameters:
      body - Relationships (required)
      Returns:
      BulkRelationshipsResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postExternalcontactsBulkRelationshipsUpdateWithHttpInfo

      public ApiResponse<BulkRelationshipsResponse> postExternalcontactsBulkRelationshipsUpdateWithHttpInfo(BulkRelationshipsRequest body) throws IOException
      Bulk update relationships
      Parameters:
      body - Relationships (required)
      Returns:
      BulkRelationshipsResponse
      Throws:
      IOException - if the request fails to be processed
    • postExternalcontactsBulkRelationshipsUpdate

      public BulkRelationshipsResponse postExternalcontactsBulkRelationshipsUpdate(PostExternalcontactsBulkRelationshipsUpdateRequest request) throws IOException, ApiException
      Bulk update relationships
      Parameters:
      request - The request object
      Returns:
      BulkRelationshipsResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postExternalcontactsBulkRelationshipsUpdate

      public ApiResponse<BulkRelationshipsResponse> postExternalcontactsBulkRelationshipsUpdate(ApiRequest<BulkRelationshipsRequest> request) throws IOException
      Bulk update relationships
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postExternalcontactsContactJourneySegments

      public UpdateSegmentAssignmentResponse postExternalcontactsContactJourneySegments(String contactId, UpdateSegmentAssignmentRequest body) throws IOException, ApiException
      Assign/Unassign up to 10 segments to/from an external contact or, if a segment is already assigned, update the expiry date of the segment assignment. Any unprocessed segment assignments are returned in the body for the client to retry, in the event of a partial success.
      Parameters:
      contactId - ExternalContact ID (required)
      body - (optional)
      Returns:
      UpdateSegmentAssignmentResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postExternalcontactsContactJourneySegmentsWithHttpInfo

      public ApiResponse<UpdateSegmentAssignmentResponse> postExternalcontactsContactJourneySegmentsWithHttpInfo(String contactId, UpdateSegmentAssignmentRequest body) throws IOException
      Assign/Unassign up to 10 segments to/from an external contact or, if a segment is already assigned, update the expiry date of the segment assignment. Any unprocessed segment assignments are returned in the body for the client to retry, in the event of a partial success.
      Parameters:
      contactId - ExternalContact ID (required)
      body - (optional)
      Returns:
      UpdateSegmentAssignmentResponse
      Throws:
      IOException - if the request fails to be processed
    • postExternalcontactsContactJourneySegments

      public UpdateSegmentAssignmentResponse postExternalcontactsContactJourneySegments(PostExternalcontactsContactJourneySegmentsRequest request) throws IOException, ApiException
      Assign/Unassign up to 10 segments to/from an external contact or, if a segment is already assigned, update the expiry date of the segment assignment. Any unprocessed segment assignments are returned in the body for the client to retry, in the event of a partial success.
      Parameters:
      request - The request object
      Returns:
      UpdateSegmentAssignmentResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postExternalcontactsContactJourneySegments

      public ApiResponse<UpdateSegmentAssignmentResponse> postExternalcontactsContactJourneySegments(ApiRequest<UpdateSegmentAssignmentRequest> request) throws IOException
      Assign/Unassign up to 10 segments to/from an external contact or, if a segment is already assigned, update the expiry date of the segment assignment. Any unprocessed segment assignments are returned in the body for the client to retry, in the event of a partial success.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postExternalcontactsContactNotes

      public Note postExternalcontactsContactNotes(String contactId, Note body) throws IOException, ApiException
      Create a note for an external contact
      Parameters:
      contactId - ExternalContact Id (required)
      body - ExternalContact (required)
      Returns:
      Note
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postExternalcontactsContactNotesWithHttpInfo

      public ApiResponse<Note> postExternalcontactsContactNotesWithHttpInfo(String contactId, Note body) throws IOException
      Create a note for an external contact
      Parameters:
      contactId - ExternalContact Id (required)
      body - ExternalContact (required)
      Returns:
      Note
      Throws:
      IOException - if the request fails to be processed
    • postExternalcontactsContactNotes

      public Note postExternalcontactsContactNotes(PostExternalcontactsContactNotesRequest request) throws IOException, ApiException
      Create a note for an external contact
      Parameters:
      request - The request object
      Returns:
      Note
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postExternalcontactsContactNotes

      public ApiResponse<Note> postExternalcontactsContactNotes(ApiRequest<Note> request) throws IOException
      Create a note for an external contact
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postExternalcontactsContactPromotion

      public ExternalContact postExternalcontactsContactPromotion(String contactId) throws IOException, ApiException
      Promote an observed contact (ephemeral or identified) to a curated contact
      Parameters:
      contactId - ExternalContact ID (required)
      Returns:
      ExternalContact
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postExternalcontactsContactPromotionWithHttpInfo

      public ApiResponse<ExternalContact> postExternalcontactsContactPromotionWithHttpInfo(String contactId) throws IOException
      Promote an observed contact (ephemeral or identified) to a curated contact
      Parameters:
      contactId - ExternalContact ID (required)
      Returns:
      ExternalContact
      Throws:
      IOException - if the request fails to be processed
    • postExternalcontactsContactPromotion

      public ExternalContact postExternalcontactsContactPromotion(PostExternalcontactsContactPromotionRequest request) throws IOException, ApiException
      Promote an observed contact (ephemeral or identified) to a curated contact
      Parameters:
      request - The request object
      Returns:
      ExternalContact
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postExternalcontactsContactPromotion

      public ApiResponse<ExternalContact> postExternalcontactsContactPromotion(ApiRequest<Void> request) throws IOException
      Promote an observed contact (ephemeral or identified) to a curated contact
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postExternalcontactsContacts

      public ExternalContact postExternalcontactsContacts(ExternalContact body) throws IOException, ApiException
      Create an external contact
      Parameters:
      body - ExternalContact (required)
      Returns:
      ExternalContact
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postExternalcontactsContactsWithHttpInfo

      public ApiResponse<ExternalContact> postExternalcontactsContactsWithHttpInfo(ExternalContact body) throws IOException
      Create an external contact
      Parameters:
      body - ExternalContact (required)
      Returns:
      ExternalContact
      Throws:
      IOException - if the request fails to be processed
    • postExternalcontactsContacts

      public ExternalContact postExternalcontactsContacts(PostExternalcontactsContactsRequest request) throws IOException, ApiException
      Create an external contact
      Parameters:
      request - The request object
      Returns:
      ExternalContact
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postExternalcontactsContacts

      public ApiResponse<ExternalContact> postExternalcontactsContacts(ApiRequest<ExternalContact> request) throws IOException
      Create an external contact
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postExternalcontactsContactsEnrich

      public ExternalContact postExternalcontactsContactsEnrich(ContactEnrichRequest body, Boolean dryRun) throws IOException, ApiException
      Modify or create an External Contact, with powerful behaviors for finding and combining data with pre-existing Contacts. You may also submit multiple Enrich operations in one request via the Bulk Enrich API at /externalcontacts/bulk/contacts. A 201 response status indicates that a new Contact was created, whereas a 200 status indicates that a Contact was updated or a merge occurred.
      Parameters:
      body - ContactEnrichRequest (required)
      dryRun - If true, the request will not make any modifications, but will show you what the end result *would* be. (optional)
      Returns:
      ExternalContact
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postExternalcontactsContactsEnrichWithHttpInfo

      public ApiResponse<ExternalContact> postExternalcontactsContactsEnrichWithHttpInfo(ContactEnrichRequest body, Boolean dryRun) throws IOException
      Modify or create an External Contact, with powerful behaviors for finding and combining data with pre-existing Contacts. You may also submit multiple Enrich operations in one request via the Bulk Enrich API at /externalcontacts/bulk/contacts. A 201 response status indicates that a new Contact was created, whereas a 200 status indicates that a Contact was updated or a merge occurred.
      Parameters:
      body - ContactEnrichRequest (required)
      dryRun - If true, the request will not make any modifications, but will show you what the end result *would* be. (optional)
      Returns:
      ExternalContact
      Throws:
      IOException - if the request fails to be processed
    • postExternalcontactsContactsEnrich

      public ExternalContact postExternalcontactsContactsEnrich(PostExternalcontactsContactsEnrichRequest request) throws IOException, ApiException
      Modify or create an External Contact, with powerful behaviors for finding and combining data with pre-existing Contacts. You may also submit multiple Enrich operations in one request via the Bulk Enrich API at /externalcontacts/bulk/contacts. A 201 response status indicates that a new Contact was created, whereas a 200 status indicates that a Contact was updated or a merge occurred.
      Parameters:
      request - The request object
      Returns:
      ExternalContact
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postExternalcontactsContactsEnrich

      public ApiResponse<ExternalContact> postExternalcontactsContactsEnrich(ApiRequest<ContactEnrichRequest> request) throws IOException
      Modify or create an External Contact, with powerful behaviors for finding and combining data with pre-existing Contacts. You may also submit multiple Enrich operations in one request via the Bulk Enrich API at /externalcontacts/bulk/contacts. A 201 response status indicates that a new Contact was created, whereas a 200 status indicates that a Contact was updated or a merge occurred.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postExternalcontactsContactsExports

      public ContactsExport postExternalcontactsContactsExports(ContactsExport body) throws IOException, ApiException
      Create bulk export
      Parameters:
      body - Export (required)
      Returns:
      ContactsExport
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postExternalcontactsContactsExportsWithHttpInfo

      public ApiResponse<ContactsExport> postExternalcontactsContactsExportsWithHttpInfo(ContactsExport body) throws IOException
      Create bulk export
      Parameters:
      body - Export (required)
      Returns:
      ContactsExport
      Throws:
      IOException - if the request fails to be processed
    • postExternalcontactsContactsExports

      public ContactsExport postExternalcontactsContactsExports(PostExternalcontactsContactsExportsRequest request) throws IOException, ApiException
      Create bulk export
      Parameters:
      request - The request object
      Returns:
      ContactsExport
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postExternalcontactsContactsExports

      public ApiResponse<ContactsExport> postExternalcontactsContactsExports(ApiRequest<ContactsExport> request) throws IOException
      Create bulk export
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postExternalcontactsContactsMerge

      public ExternalContact postExternalcontactsContactsMerge(MergeContactsRequest body) throws IOException, ApiException
      Merge up to 25 contacts into a new contact record Merge operation may fail if the resulting mergeset exceeds our default limit of 52. The valueOverride field lets you override any of the Contact fields post-merge. If any Contact field is left null in `valueOverride`, it will be taken from the most recently-modified contact in the merge set. Exception for *phone/*email fields: Conflicting data will be moved to any other available phone/email fields in the merged contact.
      Parameters:
      body - MergeRequest (required)
      Returns:
      ExternalContact
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postExternalcontactsContactsMergeWithHttpInfo

      public ApiResponse<ExternalContact> postExternalcontactsContactsMergeWithHttpInfo(MergeContactsRequest body) throws IOException
      Merge up to 25 contacts into a new contact record Merge operation may fail if the resulting mergeset exceeds our default limit of 52. The valueOverride field lets you override any of the Contact fields post-merge. If any Contact field is left null in `valueOverride`, it will be taken from the most recently-modified contact in the merge set. Exception for *phone/*email fields: Conflicting data will be moved to any other available phone/email fields in the merged contact.
      Parameters:
      body - MergeRequest (required)
      Returns:
      ExternalContact
      Throws:
      IOException - if the request fails to be processed
    • postExternalcontactsContactsMerge

      public ExternalContact postExternalcontactsContactsMerge(PostExternalcontactsContactsMergeRequest request) throws IOException, ApiException
      Merge up to 25 contacts into a new contact record Merge operation may fail if the resulting mergeset exceeds our default limit of 52. The valueOverride field lets you override any of the Contact fields post-merge. If any Contact field is left null in `valueOverride`, it will be taken from the most recently-modified contact in the merge set. Exception for *phone/*email fields: Conflicting data will be moved to any other available phone/email fields in the merged contact.
      Parameters:
      request - The request object
      Returns:
      ExternalContact
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postExternalcontactsContactsMerge

      public ApiResponse<ExternalContact> postExternalcontactsContactsMerge(ApiRequest<MergeContactsRequest> request) throws IOException
      Merge up to 25 contacts into a new contact record Merge operation may fail if the resulting mergeset exceeds our default limit of 52. The valueOverride field lets you override any of the Contact fields post-merge. If any Contact field is left null in `valueOverride`, it will be taken from the most recently-modified contact in the merge set. Exception for *phone/*email fields: Conflicting data will be moved to any other available phone/email fields in the merged contact.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postExternalcontactsContactsSchemas

      public DataSchema postExternalcontactsContactsSchemas(DataSchema body) throws IOException, ApiException
      Create a schema
      Parameters:
      body - Schema (required)
      Returns:
      DataSchema
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postExternalcontactsContactsSchemasWithHttpInfo

      public ApiResponse<DataSchema> postExternalcontactsContactsSchemasWithHttpInfo(DataSchema body) throws IOException
      Create a schema
      Parameters:
      body - Schema (required)
      Returns:
      DataSchema
      Throws:
      IOException - if the request fails to be processed
    • postExternalcontactsContactsSchemas

      public DataSchema postExternalcontactsContactsSchemas(PostExternalcontactsContactsSchemasRequest request) throws IOException, ApiException
      Create a schema
      Parameters:
      request - The request object
      Returns:
      DataSchema
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postExternalcontactsContactsSchemas

      public ApiResponse<DataSchema> postExternalcontactsContactsSchemas(ApiRequest<DataSchema> request) throws IOException
      Create a schema
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postExternalcontactsExternalsources

      public ExternalSource postExternalcontactsExternalsources(ExternalSource body) throws IOException, ApiException
      Create an External Source
      Parameters:
      body - External Source (required)
      Returns:
      ExternalSource
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postExternalcontactsExternalsourcesWithHttpInfo

      public ApiResponse<ExternalSource> postExternalcontactsExternalsourcesWithHttpInfo(ExternalSource body) throws IOException
      Create an External Source
      Parameters:
      body - External Source (required)
      Returns:
      ExternalSource
      Throws:
      IOException - if the request fails to be processed
    • postExternalcontactsExternalsources

      public ExternalSource postExternalcontactsExternalsources(PostExternalcontactsExternalsourcesRequest request) throws IOException, ApiException
      Create an External Source
      Parameters:
      request - The request object
      Returns:
      ExternalSource
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postExternalcontactsExternalsources

      public ApiResponse<ExternalSource> postExternalcontactsExternalsources(ApiRequest<ExternalSource> request) throws IOException
      Create an External Source
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postExternalcontactsIdentifierlookup

      public ExternalContact postExternalcontactsIdentifierlookup(ContactIdentifier identifier, List<String> expand) throws IOException, ApiException
      Deprecated.
      Fetch a contact using an identifier type and value. NOTE: Deprecated. Please use /api/v2/externalcontacts/identifierlookup/contacts as an alternative endpoint instead. Phone number identifier values must be provided with the country code and a leading '+' symbol. Example: \"+1 704 298 4733\"
      Parameters:
      identifier - (required)
      expand - which field, if any, to expand (optional)
      Returns:
      ExternalContact
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postExternalcontactsIdentifierlookupWithHttpInfo

      public ApiResponse<ExternalContact> postExternalcontactsIdentifierlookupWithHttpInfo(ContactIdentifier identifier, List<String> expand) throws IOException
      Deprecated.
      Fetch a contact using an identifier type and value. NOTE: Deprecated. Please use /api/v2/externalcontacts/identifierlookup/contacts as an alternative endpoint instead. Phone number identifier values must be provided with the country code and a leading '+' symbol. Example: \"+1 704 298 4733\"
      Parameters:
      identifier - (required)
      expand - which field, if any, to expand (optional)
      Returns:
      ExternalContact
      Throws:
      IOException - if the request fails to be processed
    • postExternalcontactsIdentifierlookup

      public ExternalContact postExternalcontactsIdentifierlookup(PostExternalcontactsIdentifierlookupRequest request) throws IOException, ApiException
      Deprecated.
      Fetch a contact using an identifier type and value. NOTE: Deprecated. Please use /api/v2/externalcontacts/identifierlookup/contacts as an alternative endpoint instead. Phone number identifier values must be provided with the country code and a leading '+' symbol. Example: \"+1 704 298 4733\"
      Parameters:
      request - The request object
      Returns:
      ExternalContact
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postExternalcontactsIdentifierlookup

      public ApiResponse<ExternalContact> postExternalcontactsIdentifierlookup(ApiRequest<ContactIdentifier> request) throws IOException
      Deprecated.
      Fetch a contact using an identifier type and value. NOTE: Deprecated. Please use /api/v2/externalcontacts/identifierlookup/contacts as an alternative endpoint instead. Phone number identifier values must be provided with the country code and a leading '+' symbol. Example: \"+1 704 298 4733\"
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postExternalcontactsIdentifierlookupContacts

      public ExternalContact postExternalcontactsIdentifierlookupContacts(ContactIdentifier identifier, List<String> expand) throws IOException, ApiException
      Fetch a contact using an identifier type and value. Phone number identifier values must be provided with the country code and a leading '+' symbol. Example: \"+1 704 298 4733\"
      Parameters:
      identifier - (required)
      expand - which field, if any, to expand (optional)
      Returns:
      ExternalContact
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postExternalcontactsIdentifierlookupContactsWithHttpInfo

      public ApiResponse<ExternalContact> postExternalcontactsIdentifierlookupContactsWithHttpInfo(ContactIdentifier identifier, List<String> expand) throws IOException
      Fetch a contact using an identifier type and value. Phone number identifier values must be provided with the country code and a leading '+' symbol. Example: \"+1 704 298 4733\"
      Parameters:
      identifier - (required)
      expand - which field, if any, to expand (optional)
      Returns:
      ExternalContact
      Throws:
      IOException - if the request fails to be processed
    • postExternalcontactsIdentifierlookupContacts

      public ExternalContact postExternalcontactsIdentifierlookupContacts(PostExternalcontactsIdentifierlookupContactsRequest request) throws IOException, ApiException
      Fetch a contact using an identifier type and value. Phone number identifier values must be provided with the country code and a leading '+' symbol. Example: \"+1 704 298 4733\"
      Parameters:
      request - The request object
      Returns:
      ExternalContact
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postExternalcontactsIdentifierlookupContacts

      public ApiResponse<ExternalContact> postExternalcontactsIdentifierlookupContacts(ApiRequest<ContactIdentifier> request) throws IOException
      Fetch a contact using an identifier type and value. Phone number identifier values must be provided with the country code and a leading '+' symbol. Example: \"+1 704 298 4733\"
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postExternalcontactsIdentifierlookupOrganizations

      public ExternalOrganization postExternalcontactsIdentifierlookupOrganizations(ExternalOrganizationIdentifier identifier, List<String> expand) throws IOException, ApiException
      Fetch an external organization using an identifier type and value. This endpoint will only accept ExternalId type identifiers.
      Parameters:
      identifier - (required)
      expand - which field, if any, to expand (optional)
      Returns:
      ExternalOrganization
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postExternalcontactsIdentifierlookupOrganizationsWithHttpInfo

      public ApiResponse<ExternalOrganization> postExternalcontactsIdentifierlookupOrganizationsWithHttpInfo(ExternalOrganizationIdentifier identifier, List<String> expand) throws IOException
      Fetch an external organization using an identifier type and value. This endpoint will only accept ExternalId type identifiers.
      Parameters:
      identifier - (required)
      expand - which field, if any, to expand (optional)
      Returns:
      ExternalOrganization
      Throws:
      IOException - if the request fails to be processed
    • postExternalcontactsIdentifierlookupOrganizations

      public ExternalOrganization postExternalcontactsIdentifierlookupOrganizations(PostExternalcontactsIdentifierlookupOrganizationsRequest request) throws IOException, ApiException
      Fetch an external organization using an identifier type and value. This endpoint will only accept ExternalId type identifiers.
      Parameters:
      request - The request object
      Returns:
      ExternalOrganization
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postExternalcontactsIdentifierlookupOrganizations

      public ApiResponse<ExternalOrganization> postExternalcontactsIdentifierlookupOrganizations(ApiRequest<ExternalOrganizationIdentifier> request) throws IOException
      Fetch an external organization using an identifier type and value. This endpoint will only accept ExternalId type identifiers.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postExternalcontactsImportCsvJobs

      public CsvJobResponse postExternalcontactsImportCsvJobs(CsvJobRequest body) throws IOException, ApiException
      Create CSV import job
      Parameters:
      body - ImportRequest (required)
      Returns:
      CsvJobResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postExternalcontactsImportCsvJobsWithHttpInfo

      public ApiResponse<CsvJobResponse> postExternalcontactsImportCsvJobsWithHttpInfo(CsvJobRequest body) throws IOException
      Create CSV import job
      Parameters:
      body - ImportRequest (required)
      Returns:
      CsvJobResponse
      Throws:
      IOException - if the request fails to be processed
    • postExternalcontactsImportCsvJobs

      public CsvJobResponse postExternalcontactsImportCsvJobs(PostExternalcontactsImportCsvJobsRequest request) throws IOException, ApiException
      Create CSV import job
      Parameters:
      request - The request object
      Returns:
      CsvJobResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postExternalcontactsImportCsvJobs

      public ApiResponse<CsvJobResponse> postExternalcontactsImportCsvJobs(ApiRequest<CsvJobRequest> request) throws IOException
      Create CSV import job
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postExternalcontactsImportCsvSettings

      public CsvSettings postExternalcontactsImportCsvSettings(CsvSettings body) throws IOException, ApiException
      Create settings for CSV import
      Parameters:
      body - Settings (required)
      Returns:
      CsvSettings
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postExternalcontactsImportCsvSettingsWithHttpInfo

      public ApiResponse<CsvSettings> postExternalcontactsImportCsvSettingsWithHttpInfo(CsvSettings body) throws IOException
      Create settings for CSV import
      Parameters:
      body - Settings (required)
      Returns:
      CsvSettings
      Throws:
      IOException - if the request fails to be processed
    • postExternalcontactsImportCsvSettings

      public CsvSettings postExternalcontactsImportCsvSettings(PostExternalcontactsImportCsvSettingsRequest request) throws IOException, ApiException
      Create settings for CSV import
      Parameters:
      request - The request object
      Returns:
      CsvSettings
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postExternalcontactsImportCsvSettings

      public ApiResponse<CsvSettings> postExternalcontactsImportCsvSettings(ApiRequest<CsvSettings> request) throws IOException
      Create settings for CSV import
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postExternalcontactsImportCsvUploads

      public CsvUploadResponse postExternalcontactsImportCsvUploads(CsvUploadRequest body) throws IOException, ApiException
      Get url for CSV upload
      Parameters:
      body - UploadRequest (required)
      Returns:
      CsvUploadResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postExternalcontactsImportCsvUploadsWithHttpInfo

      public ApiResponse<CsvUploadResponse> postExternalcontactsImportCsvUploadsWithHttpInfo(CsvUploadRequest body) throws IOException
      Get url for CSV upload
      Parameters:
      body - UploadRequest (required)
      Returns:
      CsvUploadResponse
      Throws:
      IOException - if the request fails to be processed
    • postExternalcontactsImportCsvUploads

      public CsvUploadResponse postExternalcontactsImportCsvUploads(PostExternalcontactsImportCsvUploadsRequest request) throws IOException, ApiException
      Get url for CSV upload
      Parameters:
      request - The request object
      Returns:
      CsvUploadResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postExternalcontactsImportCsvUploads

      public ApiResponse<CsvUploadResponse> postExternalcontactsImportCsvUploads(ApiRequest<CsvUploadRequest> request) throws IOException
      Get url for CSV upload
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postExternalcontactsImportJobs

      public ContactImportJobResponse postExternalcontactsImportJobs(ContactImportJobRequest body) throws IOException, ApiException
      Create a new job
      Parameters:
      body - Job (required)
      Returns:
      ContactImportJobResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postExternalcontactsImportJobsWithHttpInfo

      public ApiResponse<ContactImportJobResponse> postExternalcontactsImportJobsWithHttpInfo(ContactImportJobRequest body) throws IOException
      Create a new job
      Parameters:
      body - Job (required)
      Returns:
      ContactImportJobResponse
      Throws:
      IOException - if the request fails to be processed
    • postExternalcontactsImportJobs

      public ContactImportJobResponse postExternalcontactsImportJobs(PostExternalcontactsImportJobsRequest request) throws IOException, ApiException
      Create a new job
      Parameters:
      request - The request object
      Returns:
      ContactImportJobResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postExternalcontactsImportJobs

      public ApiResponse<ContactImportJobResponse> postExternalcontactsImportJobs(ApiRequest<ContactImportJobRequest> request) throws IOException
      Create a new job
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postExternalcontactsImportSettings

      public ContactImportSettings postExternalcontactsImportSettings(ContactImportSettings body) throws IOException, ApiException
      Create a new settings
      Parameters:
      body - Setting (required)
      Returns:
      ContactImportSettings
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postExternalcontactsImportSettingsWithHttpInfo

      public ApiResponse<ContactImportSettings> postExternalcontactsImportSettingsWithHttpInfo(ContactImportSettings body) throws IOException
      Create a new settings
      Parameters:
      body - Setting (required)
      Returns:
      ContactImportSettings
      Throws:
      IOException - if the request fails to be processed
    • postExternalcontactsImportSettings

      public ContactImportSettings postExternalcontactsImportSettings(PostExternalcontactsImportSettingsRequest request) throws IOException, ApiException
      Create a new settings
      Parameters:
      request - The request object
      Returns:
      ContactImportSettings
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postExternalcontactsImportSettings

      public ApiResponse<ContactImportSettings> postExternalcontactsImportSettings(ApiRequest<ContactImportSettings> request) throws IOException
      Create a new settings
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postExternalcontactsMergeContacts

      public ExternalContact postExternalcontactsMergeContacts(MergeRequest body) throws IOException, ApiException
      Deprecated.
      Merge two contacts into a new contact record Two curated contacts cannot be merged. Refer to the Contact Merging article on the Developer Center for details. Deprecated: This API has been superseded by a new merge API. You are encouraged to instead use /api/v2/externalcontacts/contacts/merge, which supports merging up to 25 Contacts of any type, and overriding specific fields in the resulting Contact.
      Parameters:
      body - MergeRequest (required)
      Returns:
      ExternalContact
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postExternalcontactsMergeContactsWithHttpInfo

      public ApiResponse<ExternalContact> postExternalcontactsMergeContactsWithHttpInfo(MergeRequest body) throws IOException
      Deprecated.
      Merge two contacts into a new contact record Two curated contacts cannot be merged. Refer to the Contact Merging article on the Developer Center for details. Deprecated: This API has been superseded by a new merge API. You are encouraged to instead use /api/v2/externalcontacts/contacts/merge, which supports merging up to 25 Contacts of any type, and overriding specific fields in the resulting Contact.
      Parameters:
      body - MergeRequest (required)
      Returns:
      ExternalContact
      Throws:
      IOException - if the request fails to be processed
    • postExternalcontactsMergeContacts

      public ExternalContact postExternalcontactsMergeContacts(PostExternalcontactsMergeContactsRequest request) throws IOException, ApiException
      Deprecated.
      Merge two contacts into a new contact record Two curated contacts cannot be merged. Refer to the Contact Merging article on the Developer Center for details. Deprecated: This API has been superseded by a new merge API. You are encouraged to instead use /api/v2/externalcontacts/contacts/merge, which supports merging up to 25 Contacts of any type, and overriding specific fields in the resulting Contact.
      Parameters:
      request - The request object
      Returns:
      ExternalContact
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postExternalcontactsMergeContacts

      public ApiResponse<ExternalContact> postExternalcontactsMergeContacts(ApiRequest<MergeRequest> request) throws IOException
      Deprecated.
      Merge two contacts into a new contact record Two curated contacts cannot be merged. Refer to the Contact Merging article on the Developer Center for details. Deprecated: This API has been superseded by a new merge API. You are encouraged to instead use /api/v2/externalcontacts/contacts/merge, which supports merging up to 25 Contacts of any type, and overriding specific fields in the resulting Contact.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postExternalcontactsOrganizationNotes

      public Note postExternalcontactsOrganizationNotes(String externalOrganizationId, Note body) throws IOException, ApiException
      Create a note for an external organization
      Parameters:
      externalOrganizationId - External Organization Id (required)
      body - ExternalContact (required)
      Returns:
      Note
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postExternalcontactsOrganizationNotesWithHttpInfo

      public ApiResponse<Note> postExternalcontactsOrganizationNotesWithHttpInfo(String externalOrganizationId, Note body) throws IOException
      Create a note for an external organization
      Parameters:
      externalOrganizationId - External Organization Id (required)
      body - ExternalContact (required)
      Returns:
      Note
      Throws:
      IOException - if the request fails to be processed
    • postExternalcontactsOrganizationNotes

      public Note postExternalcontactsOrganizationNotes(PostExternalcontactsOrganizationNotesRequest request) throws IOException, ApiException
      Create a note for an external organization
      Parameters:
      request - The request object
      Returns:
      Note
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postExternalcontactsOrganizationNotes

      public ApiResponse<Note> postExternalcontactsOrganizationNotes(ApiRequest<Note> request) throws IOException
      Create a note for an external organization
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postExternalcontactsOrganizations

      public ExternalOrganization postExternalcontactsOrganizations(ExternalOrganization body) throws IOException, ApiException
      Create an external organization
      Parameters:
      body - ExternalOrganization (required)
      Returns:
      ExternalOrganization
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postExternalcontactsOrganizationsWithHttpInfo

      public ApiResponse<ExternalOrganization> postExternalcontactsOrganizationsWithHttpInfo(ExternalOrganization body) throws IOException
      Create an external organization
      Parameters:
      body - ExternalOrganization (required)
      Returns:
      ExternalOrganization
      Throws:
      IOException - if the request fails to be processed
    • postExternalcontactsOrganizations

      public ExternalOrganization postExternalcontactsOrganizations(PostExternalcontactsOrganizationsRequest request) throws IOException, ApiException
      Create an external organization
      Parameters:
      request - The request object
      Returns:
      ExternalOrganization
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postExternalcontactsOrganizations

      public ApiResponse<ExternalOrganization> postExternalcontactsOrganizations(ApiRequest<ExternalOrganization> request) throws IOException
      Create an external organization
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postExternalcontactsOrganizationsEnrich

      public ExternalOrganization postExternalcontactsOrganizationsEnrich(ExternalOrganizationEnrichRequest body, Boolean dryRun) throws IOException, ApiException
      Modify or create an External Org, with powerful behaviors for finding and combining data with pre-existing External Orgs. You may also submit multiple Enrich operations in one request via the Bulk Enrich API at /externalcontacts/bulk/organizations. A 201 response status indicates that a new External Organization was created, whereas a 200 status indicates that an External Organization was updated
      Parameters:
      body - ExternalOrgEnrichRequest (required)
      dryRun - If true, the request will not make any modifications, but will show you what the end result *would* be. (optional)
      Returns:
      ExternalOrganization
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postExternalcontactsOrganizationsEnrichWithHttpInfo

      public ApiResponse<ExternalOrganization> postExternalcontactsOrganizationsEnrichWithHttpInfo(ExternalOrganizationEnrichRequest body, Boolean dryRun) throws IOException
      Modify or create an External Org, with powerful behaviors for finding and combining data with pre-existing External Orgs. You may also submit multiple Enrich operations in one request via the Bulk Enrich API at /externalcontacts/bulk/organizations. A 201 response status indicates that a new External Organization was created, whereas a 200 status indicates that an External Organization was updated
      Parameters:
      body - ExternalOrgEnrichRequest (required)
      dryRun - If true, the request will not make any modifications, but will show you what the end result *would* be. (optional)
      Returns:
      ExternalOrganization
      Throws:
      IOException - if the request fails to be processed
    • postExternalcontactsOrganizationsEnrich

      public ExternalOrganization postExternalcontactsOrganizationsEnrich(PostExternalcontactsOrganizationsEnrichRequest request) throws IOException, ApiException
      Modify or create an External Org, with powerful behaviors for finding and combining data with pre-existing External Orgs. You may also submit multiple Enrich operations in one request via the Bulk Enrich API at /externalcontacts/bulk/organizations. A 201 response status indicates that a new External Organization was created, whereas a 200 status indicates that an External Organization was updated
      Parameters:
      request - The request object
      Returns:
      ExternalOrganization
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postExternalcontactsOrganizationsEnrich

      public ApiResponse<ExternalOrganization> postExternalcontactsOrganizationsEnrich(ApiRequest<ExternalOrganizationEnrichRequest> request) throws IOException
      Modify or create an External Org, with powerful behaviors for finding and combining data with pre-existing External Orgs. You may also submit multiple Enrich operations in one request via the Bulk Enrich API at /externalcontacts/bulk/organizations. A 201 response status indicates that a new External Organization was created, whereas a 200 status indicates that an External Organization was updated
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postExternalcontactsOrganizationsSchemas

      public DataSchema postExternalcontactsOrganizationsSchemas(DataSchema body) throws IOException, ApiException
      Create a schema
      Parameters:
      body - Schema (required)
      Returns:
      DataSchema
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postExternalcontactsOrganizationsSchemasWithHttpInfo

      public ApiResponse<DataSchema> postExternalcontactsOrganizationsSchemasWithHttpInfo(DataSchema body) throws IOException
      Create a schema
      Parameters:
      body - Schema (required)
      Returns:
      DataSchema
      Throws:
      IOException - if the request fails to be processed
    • postExternalcontactsOrganizationsSchemas

      public DataSchema postExternalcontactsOrganizationsSchemas(PostExternalcontactsOrganizationsSchemasRequest request) throws IOException, ApiException
      Create a schema
      Parameters:
      request - The request object
      Returns:
      DataSchema
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postExternalcontactsOrganizationsSchemas

      public ApiResponse<DataSchema> postExternalcontactsOrganizationsSchemas(ApiRequest<DataSchema> request) throws IOException
      Create a schema
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postExternalcontactsRelationships

      public Relationship postExternalcontactsRelationships(Relationship body) throws IOException, ApiException
      Create a relationship
      Parameters:
      body - Relationship (required)
      Returns:
      Relationship
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postExternalcontactsRelationshipsWithHttpInfo

      public ApiResponse<Relationship> postExternalcontactsRelationshipsWithHttpInfo(Relationship body) throws IOException
      Create a relationship
      Parameters:
      body - Relationship (required)
      Returns:
      Relationship
      Throws:
      IOException - if the request fails to be processed
    • postExternalcontactsRelationships

      public Relationship postExternalcontactsRelationships(PostExternalcontactsRelationshipsRequest request) throws IOException, ApiException
      Create a relationship
      Parameters:
      request - The request object
      Returns:
      Relationship
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postExternalcontactsRelationships

      public ApiResponse<Relationship> postExternalcontactsRelationships(ApiRequest<Relationship> request) throws IOException
      Create a relationship
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • putExternalcontactsContact

      public ExternalContact putExternalcontactsContact(String contactId, ExternalContact body) throws IOException, ApiException
      Update an external contact
      Parameters:
      contactId - ExternalContact ID (required)
      body - ExternalContact (required)
      Returns:
      ExternalContact
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putExternalcontactsContactWithHttpInfo

      public ApiResponse<ExternalContact> putExternalcontactsContactWithHttpInfo(String contactId, ExternalContact body) throws IOException
      Update an external contact
      Parameters:
      contactId - ExternalContact ID (required)
      body - ExternalContact (required)
      Returns:
      ExternalContact
      Throws:
      IOException - if the request fails to be processed
    • putExternalcontactsContact

      public ExternalContact putExternalcontactsContact(PutExternalcontactsContactRequest request) throws IOException, ApiException
      Update an external contact
      Parameters:
      request - The request object
      Returns:
      ExternalContact
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putExternalcontactsContact

      public ApiResponse<ExternalContact> putExternalcontactsContact(ApiRequest<ExternalContact> request) throws IOException
      Update an external contact
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • putExternalcontactsContactNote

      public Note putExternalcontactsContactNote(String contactId, String noteId, Note body) throws IOException, ApiException
      Update a note for an external contact
      Parameters:
      contactId - ExternalContact Id (required)
      noteId - Note Id (required)
      body - Note (required)
      Returns:
      Note
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putExternalcontactsContactNoteWithHttpInfo

      public ApiResponse<Note> putExternalcontactsContactNoteWithHttpInfo(String contactId, String noteId, Note body) throws IOException
      Update a note for an external contact
      Parameters:
      contactId - ExternalContact Id (required)
      noteId - Note Id (required)
      body - Note (required)
      Returns:
      Note
      Throws:
      IOException - if the request fails to be processed
    • putExternalcontactsContactNote

      public Note putExternalcontactsContactNote(PutExternalcontactsContactNoteRequest request) throws IOException, ApiException
      Update a note for an external contact
      Parameters:
      request - The request object
      Returns:
      Note
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putExternalcontactsContactNote

      public ApiResponse<Note> putExternalcontactsContactNote(ApiRequest<Note> request) throws IOException
      Update a note for an external contact
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • putExternalcontactsContactsSchema

      public DataSchema putExternalcontactsContactsSchema(String schemaId, DataSchema body) throws IOException, ApiException
      Update a schema
      Parameters:
      schemaId - Schema ID (required)
      body - Data Schema (required)
      Returns:
      DataSchema
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putExternalcontactsContactsSchemaWithHttpInfo

      public ApiResponse<DataSchema> putExternalcontactsContactsSchemaWithHttpInfo(String schemaId, DataSchema body) throws IOException
      Update a schema
      Parameters:
      schemaId - Schema ID (required)
      body - Data Schema (required)
      Returns:
      DataSchema
      Throws:
      IOException - if the request fails to be processed
    • putExternalcontactsContactsSchema

      public DataSchema putExternalcontactsContactsSchema(PutExternalcontactsContactsSchemaRequest request) throws IOException, ApiException
      Update a schema
      Parameters:
      request - The request object
      Returns:
      DataSchema
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putExternalcontactsContactsSchema

      public ApiResponse<DataSchema> putExternalcontactsContactsSchema(ApiRequest<DataSchema> request) throws IOException
      Update a schema
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • putExternalcontactsConversation

      public void putExternalcontactsConversation(String conversationId, ConversationAssociation body) throws IOException, ApiException
      Associate/disassociate an external contact with a conversation To associate, supply a value for the externalContactId. To disassociate, do not include the property at all.
      Parameters:
      conversationId - Conversation ID (required)
      body - ConversationAssociation (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putExternalcontactsConversationWithHttpInfo

      public ApiResponse<Void> putExternalcontactsConversationWithHttpInfo(String conversationId, ConversationAssociation body) throws IOException
      Associate/disassociate an external contact with a conversation To associate, supply a value for the externalContactId. To disassociate, do not include the property at all.
      Parameters:
      conversationId - Conversation ID (required)
      body - ConversationAssociation (required)
      Throws:
      IOException - if the request fails to be processed
    • putExternalcontactsConversation

      public void putExternalcontactsConversation(PutExternalcontactsConversationRequest request) throws IOException, ApiException
      Associate/disassociate an external contact with a conversation To associate, supply a value for the externalContactId. To disassociate, do not include the property at all.
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putExternalcontactsConversation

      public ApiResponse<Void> putExternalcontactsConversation(ApiRequest<ConversationAssociation> request) throws IOException
      Associate/disassociate an external contact with a conversation To associate, supply a value for the externalContactId. To disassociate, do not include the property at all.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • putExternalcontactsExternalsource

      public ExternalSource putExternalcontactsExternalsource(String externalSourceId, ExternalSource body) throws IOException, ApiException
      Update an External Source
      Parameters:
      externalSourceId - External Source ID (required)
      body - External Source (required)
      Returns:
      ExternalSource
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putExternalcontactsExternalsourceWithHttpInfo

      public ApiResponse<ExternalSource> putExternalcontactsExternalsourceWithHttpInfo(String externalSourceId, ExternalSource body) throws IOException
      Update an External Source
      Parameters:
      externalSourceId - External Source ID (required)
      body - External Source (required)
      Returns:
      ExternalSource
      Throws:
      IOException - if the request fails to be processed
    • putExternalcontactsExternalsource

      public ExternalSource putExternalcontactsExternalsource(PutExternalcontactsExternalsourceRequest request) throws IOException, ApiException
      Update an External Source
      Parameters:
      request - The request object
      Returns:
      ExternalSource
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putExternalcontactsExternalsource

      public ApiResponse<ExternalSource> putExternalcontactsExternalsource(ApiRequest<ExternalSource> request) throws IOException
      Update an External Source
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • putExternalcontactsImportCsvSetting

      public CsvSettings putExternalcontactsImportCsvSetting(String settingsId, CsvSettings body) throws IOException, ApiException
      Update settings for CSV import
      Parameters:
      settingsId - Settings id (required)
      body - Settings (required)
      Returns:
      CsvSettings
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putExternalcontactsImportCsvSettingWithHttpInfo

      public ApiResponse<CsvSettings> putExternalcontactsImportCsvSettingWithHttpInfo(String settingsId, CsvSettings body) throws IOException
      Update settings for CSV import
      Parameters:
      settingsId - Settings id (required)
      body - Settings (required)
      Returns:
      CsvSettings
      Throws:
      IOException - if the request fails to be processed
    • putExternalcontactsImportCsvSetting

      public CsvSettings putExternalcontactsImportCsvSetting(PutExternalcontactsImportCsvSettingRequest request) throws IOException, ApiException
      Update settings for CSV import
      Parameters:
      request - The request object
      Returns:
      CsvSettings
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putExternalcontactsImportCsvSetting

      public ApiResponse<CsvSettings> putExternalcontactsImportCsvSetting(ApiRequest<CsvSettings> request) throws IOException
      Update settings for CSV import
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • putExternalcontactsImportJob

      Update Job's workflow status
      Parameters:
      jobId - Job id (required)
      body - Status of the Job's workflow (required)
      Returns:
      ContactImportJobStatusUpdateResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putExternalcontactsImportJobWithHttpInfo

      public ApiResponse<ContactImportJobStatusUpdateResponse> putExternalcontactsImportJobWithHttpInfo(String jobId, ContactImportJobStatusUpdateRequest body) throws IOException
      Update Job's workflow status
      Parameters:
      jobId - Job id (required)
      body - Status of the Job's workflow (required)
      Returns:
      ContactImportJobStatusUpdateResponse
      Throws:
      IOException - if the request fails to be processed
    • putExternalcontactsImportJob

      Update Job's workflow status
      Parameters:
      request - The request object
      Returns:
      ContactImportJobStatusUpdateResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putExternalcontactsImportJob

      Update Job's workflow status
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • putExternalcontactsImportSetting

      public ContactImportSettings putExternalcontactsImportSetting(String settingsId, ContactImportSettings body) throws IOException, ApiException
      Update settings
      Parameters:
      settingsId - Settings id (required)
      body - Setting (required)
      Returns:
      ContactImportSettings
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putExternalcontactsImportSettingWithHttpInfo

      public ApiResponse<ContactImportSettings> putExternalcontactsImportSettingWithHttpInfo(String settingsId, ContactImportSettings body) throws IOException
      Update settings
      Parameters:
      settingsId - Settings id (required)
      body - Setting (required)
      Returns:
      ContactImportSettings
      Throws:
      IOException - if the request fails to be processed
    • putExternalcontactsImportSetting

      public ContactImportSettings putExternalcontactsImportSetting(PutExternalcontactsImportSettingRequest request) throws IOException, ApiException
      Update settings
      Parameters:
      request - The request object
      Returns:
      ContactImportSettings
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putExternalcontactsImportSetting

      public ApiResponse<ContactImportSettings> putExternalcontactsImportSetting(ApiRequest<ContactImportSettings> request) throws IOException
      Update settings
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • putExternalcontactsOrganization

      public ExternalOrganization putExternalcontactsOrganization(String externalOrganizationId, ExternalOrganization body) throws IOException, ApiException
      Update an external organization
      Parameters:
      externalOrganizationId - External Organization ID (required)
      body - ExternalOrganization (required)
      Returns:
      ExternalOrganization
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putExternalcontactsOrganizationWithHttpInfo

      public ApiResponse<ExternalOrganization> putExternalcontactsOrganizationWithHttpInfo(String externalOrganizationId, ExternalOrganization body) throws IOException
      Update an external organization
      Parameters:
      externalOrganizationId - External Organization ID (required)
      body - ExternalOrganization (required)
      Returns:
      ExternalOrganization
      Throws:
      IOException - if the request fails to be processed
    • putExternalcontactsOrganization

      public ExternalOrganization putExternalcontactsOrganization(PutExternalcontactsOrganizationRequest request) throws IOException, ApiException
      Update an external organization
      Parameters:
      request - The request object
      Returns:
      ExternalOrganization
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putExternalcontactsOrganization

      public ApiResponse<ExternalOrganization> putExternalcontactsOrganization(ApiRequest<ExternalOrganization> request) throws IOException
      Update an external organization
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • putExternalcontactsOrganizationNote

      public Note putExternalcontactsOrganizationNote(String externalOrganizationId, String noteId, Note body) throws IOException, ApiException
      Update a note for an external organization
      Parameters:
      externalOrganizationId - External Organization Id (required)
      noteId - Note Id (required)
      body - Note (required)
      Returns:
      Note
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putExternalcontactsOrganizationNoteWithHttpInfo

      public ApiResponse<Note> putExternalcontactsOrganizationNoteWithHttpInfo(String externalOrganizationId, String noteId, Note body) throws IOException
      Update a note for an external organization
      Parameters:
      externalOrganizationId - External Organization Id (required)
      noteId - Note Id (required)
      body - Note (required)
      Returns:
      Note
      Throws:
      IOException - if the request fails to be processed
    • putExternalcontactsOrganizationNote

      public Note putExternalcontactsOrganizationNote(PutExternalcontactsOrganizationNoteRequest request) throws IOException, ApiException
      Update a note for an external organization
      Parameters:
      request - The request object
      Returns:
      Note
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putExternalcontactsOrganizationNote

      public ApiResponse<Note> putExternalcontactsOrganizationNote(ApiRequest<Note> request) throws IOException
      Update a note for an external organization
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • putExternalcontactsOrganizationTrustorTrustorId

      public ExternalOrganizationTrustorLink putExternalcontactsOrganizationTrustorTrustorId(String externalOrganizationId, String trustorId) throws IOException, ApiException
      Links a Trustor with an External Organization
      Parameters:
      externalOrganizationId - External Organization ID (required)
      trustorId - Trustor ID (required)
      Returns:
      ExternalOrganizationTrustorLink
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putExternalcontactsOrganizationTrustorTrustorIdWithHttpInfo

      public ApiResponse<ExternalOrganizationTrustorLink> putExternalcontactsOrganizationTrustorTrustorIdWithHttpInfo(String externalOrganizationId, String trustorId) throws IOException
      Links a Trustor with an External Organization
      Parameters:
      externalOrganizationId - External Organization ID (required)
      trustorId - Trustor ID (required)
      Returns:
      ExternalOrganizationTrustorLink
      Throws:
      IOException - if the request fails to be processed
    • putExternalcontactsOrganizationTrustorTrustorId

      public ExternalOrganizationTrustorLink putExternalcontactsOrganizationTrustorTrustorId(PutExternalcontactsOrganizationTrustorTrustorIdRequest request) throws IOException, ApiException
      Links a Trustor with an External Organization
      Parameters:
      request - The request object
      Returns:
      ExternalOrganizationTrustorLink
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putExternalcontactsOrganizationTrustorTrustorId

      public ApiResponse<ExternalOrganizationTrustorLink> putExternalcontactsOrganizationTrustorTrustorId(ApiRequest<Void> request) throws IOException
      Links a Trustor with an External Organization
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • putExternalcontactsOrganizationsSchema

      public DataSchema putExternalcontactsOrganizationsSchema(String schemaId, DataSchema body) throws IOException, ApiException
      Update a schema
      Parameters:
      schemaId - Schema ID (required)
      body - Data Schema (required)
      Returns:
      DataSchema
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putExternalcontactsOrganizationsSchemaWithHttpInfo

      public ApiResponse<DataSchema> putExternalcontactsOrganizationsSchemaWithHttpInfo(String schemaId, DataSchema body) throws IOException
      Update a schema
      Parameters:
      schemaId - Schema ID (required)
      body - Data Schema (required)
      Returns:
      DataSchema
      Throws:
      IOException - if the request fails to be processed
    • putExternalcontactsOrganizationsSchema

      public DataSchema putExternalcontactsOrganizationsSchema(PutExternalcontactsOrganizationsSchemaRequest request) throws IOException, ApiException
      Update a schema
      Parameters:
      request - The request object
      Returns:
      DataSchema
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putExternalcontactsOrganizationsSchema

      public ApiResponse<DataSchema> putExternalcontactsOrganizationsSchema(ApiRequest<DataSchema> request) throws IOException
      Update a schema
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • putExternalcontactsRelationship

      public Relationship putExternalcontactsRelationship(String relationshipId, Relationship body) throws IOException, ApiException
      Update a relationship
      Parameters:
      relationshipId - Relationship Id (required)
      body - Relationship (required)
      Returns:
      Relationship
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putExternalcontactsRelationshipWithHttpInfo

      public ApiResponse<Relationship> putExternalcontactsRelationshipWithHttpInfo(String relationshipId, Relationship body) throws IOException
      Update a relationship
      Parameters:
      relationshipId - Relationship Id (required)
      body - Relationship (required)
      Returns:
      Relationship
      Throws:
      IOException - if the request fails to be processed
    • putExternalcontactsRelationship

      public Relationship putExternalcontactsRelationship(PutExternalcontactsRelationshipRequest request) throws IOException, ApiException
      Update a relationship
      Parameters:
      request - The request object
      Returns:
      Relationship
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putExternalcontactsRelationship

      public ApiResponse<Relationship> putExternalcontactsRelationship(ApiRequest<Relationship> request) throws IOException
      Update a relationship
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed