Class AffindaAPI


  • public final class AffindaAPI
    extends Object
    Initializes a new instance of the AffindaAPI type.
    • Method Detail

      • getRegion

        public Region getRegion()
        Gets region - server parameter.
        Returns:
        the region value.
      • getHttpPipeline

        public com.azure.core.http.HttpPipeline getHttpPipeline()
        Gets The HTTP pipeline to send requests through.
        Returns:
        the httpPipeline value.
      • getSerializerAdapter

        public com.azure.core.util.serializer.SerializerAdapter getSerializerAdapter()
        Gets The serializer to serialize an object into a string.
        Returns:
        the serializerAdapter value.
      • getAllWorkspacesWithResponseAsync

        public reactor.core.publisher.Mono<com.azure.core.http.rest.Response<List<Workspace>>> getAllWorkspacesWithResponseAsync​(String organization,
                                                                                                                                 String name)
        Returns your workspaces.
        Parameters:
        organization - Filter by organization.
        name - Filter by name.
        Returns:
        array of Workspace along with Response on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getAllWorkspacesAsync

        public reactor.core.publisher.Mono<List<Workspace>> getAllWorkspacesAsync​(String organization,
                                                                                  String name)
        Returns your workspaces.
        Parameters:
        organization - Filter by organization.
        name - Filter by name.
        Returns:
        array of Workspace on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getAllWorkspaces

        public List<Workspace> getAllWorkspaces​(String organization,
                                                String name)
        Returns your workspaces.
        Parameters:
        organization - Filter by organization.
        name - Filter by name.
        Returns:
        array of Workspace.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • createWorkspaceWithResponseAsync

        public reactor.core.publisher.Mono<com.azure.core.http.rest.Response<Workspace>> createWorkspaceWithResponseAsync​(WorkspaceCreate body)
        Create a workspace.
        Parameters:
        body - Workspace to create.
        Returns:
        the response body along with Response on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • createWorkspaceAsync

        public reactor.core.publisher.Mono<Workspace> createWorkspaceAsync​(WorkspaceCreate body)
        Create a workspace.
        Parameters:
        body - Workspace to create.
        Returns:
        the response body on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getWorkspaceWithResponseAsync

        public reactor.core.publisher.Mono<com.azure.core.http.rest.Response<Workspace>> getWorkspaceWithResponseAsync​(String identifier)
        Return a specific workspace.
        Parameters:
        identifier - Workspace's identifier.
        Returns:
        the response body along with Response on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getWorkspaceAsync

        public reactor.core.publisher.Mono<Workspace> getWorkspaceAsync​(String identifier)
        Return a specific workspace.
        Parameters:
        identifier - Workspace's identifier.
        Returns:
        the response body on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getWorkspace

        public Workspace getWorkspace​(String identifier)
        Return a specific workspace.
        Parameters:
        identifier - Workspace's identifier.
        Returns:
        the response.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • updateWorkspaceWithResponseAsync

        public reactor.core.publisher.Mono<com.azure.core.http.rest.Response<Workspace>> updateWorkspaceWithResponseAsync​(String identifier,
                                                                                                                          WorkspaceUpdate body)
        Update a workspace.
        Parameters:
        identifier - Workspace's identifier.
        body - Workspace data to update.
        Returns:
        the response body along with Response on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • updateWorkspaceAsync

        public reactor.core.publisher.Mono<Workspace> updateWorkspaceAsync​(String identifier,
                                                                           WorkspaceUpdate body)
        Update a workspace.
        Parameters:
        identifier - Workspace's identifier.
        body - Workspace data to update.
        Returns:
        the response body on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • deleteWorkspaceWithResponseAsync

        public reactor.core.publisher.Mono<com.azure.core.http.rest.Response<Void>> deleteWorkspaceWithResponseAsync​(String identifier)
        Deletes the specified workspace from the database.
        Parameters:
        identifier - Workspace's identifier.
        Returns:
        the Response on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • deleteWorkspaceAsync

        public reactor.core.publisher.Mono<Void> deleteWorkspaceAsync​(String identifier)
        Deletes the specified workspace from the database.
        Parameters:
        identifier - Workspace's identifier.
        Returns:
        A Mono that completes when a successful response is received.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • deleteWorkspace

        public void deleteWorkspace​(String identifier)
        Deletes the specified workspace from the database.
        Parameters:
        identifier - Workspace's identifier.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getAllWorkspaceMembershipsWithResponseAsync

        public reactor.core.publisher.Mono<com.azure.core.http.rest.Response<PathsZ1JuagV3WorkspaceMembershipsGetResponses200ContentApplicationJsonSchema>> getAllWorkspaceMembershipsWithResponseAsync​(Integer offset,
                                                                                                                                                                                                        Integer limit,
                                                                                                                                                                                                        String workspace,
                                                                                                                                                                                                        String user)
        Returns the memberships of your workspaces.
        Parameters:
        offset - The number of documents to skip before starting to collect the result set.
        limit - The numbers of results to return.
        workspace - Filter by workspace.
        user - Partial text match on user's email, case-insensitive.
        Returns:
        the response body along with Response on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • createWorkspaceMembershipWithResponseAsync

        public reactor.core.publisher.Mono<com.azure.core.http.rest.Response<WorkspaceMembership>> createWorkspaceMembershipWithResponseAsync​(WorkspaceMembershipCreate body)
        Create a workspace membership.
        Parameters:
        body - The body parameter.
        Returns:
        the response body along with Response on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getWorkspaceMembershipWithResponseAsync

        public reactor.core.publisher.Mono<com.azure.core.http.rest.Response<WorkspaceMembership>> getWorkspaceMembershipWithResponseAsync​(String identifier)
        Return a specific workspace membership.
        Parameters:
        identifier - Workspace membership's identifier.
        Returns:
        the response body along with Response on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getWorkspaceMembershipAsync

        public reactor.core.publisher.Mono<WorkspaceMembership> getWorkspaceMembershipAsync​(String identifier)
        Return a specific workspace membership.
        Parameters:
        identifier - Workspace membership's identifier.
        Returns:
        the response body on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getWorkspaceMembership

        public WorkspaceMembership getWorkspaceMembership​(String identifier)
        Return a specific workspace membership.
        Parameters:
        identifier - Workspace membership's identifier.
        Returns:
        the response.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • deleteWorkspaceMembershipWithResponseAsync

        public reactor.core.publisher.Mono<com.azure.core.http.rest.Response<Void>> deleteWorkspaceMembershipWithResponseAsync​(String identifier)
        Remove an user from a workspace.
        Parameters:
        identifier - Workspace membership's identifier.
        Returns:
        the Response on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • deleteWorkspaceMembershipAsync

        public reactor.core.publisher.Mono<Void> deleteWorkspaceMembershipAsync​(String identifier)
        Remove an user from a workspace.
        Parameters:
        identifier - Workspace membership's identifier.
        Returns:
        A Mono that completes when a successful response is received.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • deleteWorkspaceMembership

        public void deleteWorkspaceMembership​(String identifier)
        Remove an user from a workspace.
        Parameters:
        identifier - Workspace membership's identifier.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getAllCollectionsWithResponseAsync

        public reactor.core.publisher.Mono<com.azure.core.http.rest.Response<List<DocumentCollection>>> getAllCollectionsWithResponseAsync​(String workspace)
        Returns your collections.
        Parameters:
        workspace - Filter by workspace.
        Returns:
        array of DocumentCollection along with Response on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getAllCollectionsAsync

        public reactor.core.publisher.Mono<List<DocumentCollection>> getAllCollectionsAsync​(String workspace)
        Returns your collections.
        Parameters:
        workspace - Filter by workspace.
        Returns:
        array of DocumentCollection on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • createCollectionWithResponseAsync

        public reactor.core.publisher.Mono<com.azure.core.http.rest.Response<DocumentCollection>> createCollectionWithResponseAsync​(DocumentCollectionCreate body)
        Create a collection.
        Parameters:
        body - The body parameter.
        Returns:
        the response body along with Response on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getCollectionWithResponseAsync

        public reactor.core.publisher.Mono<com.azure.core.http.rest.Response<DocumentCollection>> getCollectionWithResponseAsync​(String identifier)
        Return a specific collection.
        Parameters:
        identifier - Collection's identifier.
        Returns:
        the response body along with Response on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getCollectionAsync

        public reactor.core.publisher.Mono<DocumentCollection> getCollectionAsync​(String identifier)
        Return a specific collection.
        Parameters:
        identifier - Collection's identifier.
        Returns:
        the response body on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • updateCollectionWithResponseAsync

        public reactor.core.publisher.Mono<com.azure.core.http.rest.Response<DocumentCollection>> updateCollectionWithResponseAsync​(String identifier,
                                                                                                                                    DocumentCollectionUpdate body)
        Update data of a collection.
        Parameters:
        identifier - Collection's identifier.
        body - Collection data to update.
        Returns:
        the response body along with Response on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • updateCollectionAsync

        public reactor.core.publisher.Mono<DocumentCollection> updateCollectionAsync​(String identifier,
                                                                                     DocumentCollectionUpdate body)
        Update data of a collection.
        Parameters:
        identifier - Collection's identifier.
        body - Collection data to update.
        Returns:
        the response body on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • deleteCollectionWithResponseAsync

        public reactor.core.publisher.Mono<com.azure.core.http.rest.Response<Void>> deleteCollectionWithResponseAsync​(String identifier)
        Deletes the specified collection from the database.
        Parameters:
        identifier - Collection's identifier.
        Returns:
        the Response on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • deleteCollectionAsync

        public reactor.core.publisher.Mono<Void> deleteCollectionAsync​(String identifier)
        Deletes the specified collection from the database.
        Parameters:
        identifier - Collection's identifier.
        Returns:
        A Mono that completes when a successful response is received.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • deleteCollection

        public void deleteCollection​(String identifier)
        Deletes the specified collection from the database.
        Parameters:
        identifier - Collection's identifier.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • createDataFieldForCollectionWithResponseAsync

        public reactor.core.publisher.Mono<com.azure.core.http.rest.Response<DataField>> createDataFieldForCollectionWithResponseAsync​(String identifier,
                                                                                                                                       DataFieldCreate body)
        Create data field for a collection along with a new data point.
        Parameters:
        identifier - Collection's identifier.
        body - The data field and data point to be created.
        Returns:
        the response body along with Response on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • createDataFieldForCollectionAsync

        public reactor.core.publisher.Mono<DataField> createDataFieldForCollectionAsync​(String identifier,
                                                                                        DataFieldCreate body)
        Create data field for a collection along with a new data point.
        Parameters:
        identifier - Collection's identifier.
        body - The data field and data point to be created.
        Returns:
        the response body on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • createDataFieldForCollection

        public DataField createDataFieldForCollection​(String identifier,
                                                      DataFieldCreate body)
        Create data field for a collection along with a new data point.
        Parameters:
        identifier - Collection's identifier.
        body - The data field and data point to be created.
        Returns:
        the response.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getAllDocumentsWithResponseAsync

        public reactor.core.publisher.Mono<com.azure.core.http.rest.Response<PathsOxm5M7V3DocumentsGetResponses200ContentApplicationJsonSchema>> getAllDocumentsWithResponseAsync​(Integer offset,
                                                                                                                                                                                  Integer limit,
                                                                                                                                                                                  String workspace,
                                                                                                                                                                                  String collection,
                                                                                                                                                                                  DocumentState state,
                                                                                                                                                                                  List<Integer> tags,
                                                                                                                                                                                  DateRange createdDt,
                                                                                                                                                                                  String search,
                                                                                                                                                                                  List<Get8ItemsItem> ordering,
                                                                                                                                                                                  Boolean includeData,
                                                                                                                                                                                  List<String> exclude,
                                                                                                                                                                                  Boolean inReview,
                                                                                                                                                                                  Boolean failed,
                                                                                                                                                                                  Boolean ready,
                                                                                                                                                                                  Boolean validatable,
                                                                                                                                                                                  Boolean hasChallenges)
        Returns all the document summaries for that user, limited to 300 per page.
        Parameters:
        offset - The number of documents to skip before starting to collect the result set.
        limit - The numbers of results to return.
        workspace - Filter by workspace.
        collection - Filter by collection.
        state - Filter by the document's state.
        tags - Filter by tag's IDs.
        createdDt - Filter by created datetime.
        search - Partial, case-insensitive match with file name or tag name.
        ordering - Sort the result set. A "-" at the beginning denotes DESC sort, e.g. -created_dt. Sort by multiple fields is supported.
        includeData - By default, this endpoint returns only the meta data of the documents. Set this to `true` will return a summary of the data that was parsed. If you want to retrieve the full set of data for a document, use the `GET /documents/{identifier}` endpoint.
        exclude - Exclude some documents from the result.
        inReview - Exclude documents that are currently being reviewed.
        failed - Filter by failed status.
        ready - Filter by ready status.
        validatable - Filter for validatable documents.
        hasChallenges - Filter for documents with challenges.
        Returns:
        the response body along with Response on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getAllDocumentsAsync

        public reactor.core.publisher.Mono<PathsOxm5M7V3DocumentsGetResponses200ContentApplicationJsonSchema> getAllDocumentsAsync​(Integer offset,
                                                                                                                                   Integer limit,
                                                                                                                                   String workspace,
                                                                                                                                   String collection,
                                                                                                                                   DocumentState state,
                                                                                                                                   List<Integer> tags,
                                                                                                                                   DateRange createdDt,
                                                                                                                                   String search,
                                                                                                                                   List<Get8ItemsItem> ordering,
                                                                                                                                   Boolean includeData,
                                                                                                                                   List<String> exclude,
                                                                                                                                   Boolean inReview,
                                                                                                                                   Boolean failed,
                                                                                                                                   Boolean ready,
                                                                                                                                   Boolean validatable,
                                                                                                                                   Boolean hasChallenges)
        Returns all the document summaries for that user, limited to 300 per page.
        Parameters:
        offset - The number of documents to skip before starting to collect the result set.
        limit - The numbers of results to return.
        workspace - Filter by workspace.
        collection - Filter by collection.
        state - Filter by the document's state.
        tags - Filter by tag's IDs.
        createdDt - Filter by created datetime.
        search - Partial, case-insensitive match with file name or tag name.
        ordering - Sort the result set. A "-" at the beginning denotes DESC sort, e.g. -created_dt. Sort by multiple fields is supported.
        includeData - By default, this endpoint returns only the meta data of the documents. Set this to `true` will return a summary of the data that was parsed. If you want to retrieve the full set of data for a document, use the `GET /documents/{identifier}` endpoint.
        exclude - Exclude some documents from the result.
        inReview - Exclude documents that are currently being reviewed.
        failed - Filter by failed status.
        ready - Filter by ready status.
        validatable - Filter for validatable documents.
        hasChallenges - Filter for documents with challenges.
        Returns:
        the response body on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getAllDocuments

        public PathsOxm5M7V3DocumentsGetResponses200ContentApplicationJsonSchema getAllDocuments​(Integer offset,
                                                                                                 Integer limit,
                                                                                                 String workspace,
                                                                                                 String collection,
                                                                                                 DocumentState state,
                                                                                                 List<Integer> tags,
                                                                                                 DateRange createdDt,
                                                                                                 String search,
                                                                                                 List<Get8ItemsItem> ordering,
                                                                                                 Boolean includeData,
                                                                                                 List<String> exclude,
                                                                                                 Boolean inReview,
                                                                                                 Boolean failed,
                                                                                                 Boolean ready,
                                                                                                 Boolean validatable,
                                                                                                 Boolean hasChallenges)
        Returns all the document summaries for that user, limited to 300 per page.
        Parameters:
        offset - The number of documents to skip before starting to collect the result set.
        limit - The numbers of results to return.
        workspace - Filter by workspace.
        collection - Filter by collection.
        state - Filter by the document's state.
        tags - Filter by tag's IDs.
        createdDt - Filter by created datetime.
        search - Partial, case-insensitive match with file name or tag name.
        ordering - Sort the result set. A "-" at the beginning denotes DESC sort, e.g. -created_dt. Sort by multiple fields is supported.
        includeData - By default, this endpoint returns only the meta data of the documents. Set this to `true` will return a summary of the data that was parsed. If you want to retrieve the full set of data for a document, use the `GET /documents/{identifier}` endpoint.
        exclude - Exclude some documents from the result.
        inReview - Exclude documents that are currently being reviewed.
        failed - Filter by failed status.
        ready - Filter by ready status.
        validatable - Filter for validatable documents.
        hasChallenges - Filter for documents with challenges.
        Returns:
        the response.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • createDocumentWithResponseAsync

        public reactor.core.publisher.Mono<com.azure.core.http.rest.Response<Document>> createDocumentWithResponseAsync​(DocumentCreate body)
        Uploads a document for parsing. When successful, returns an `identifier` in the response for subsequent use with the [/documents/{identifier}](#get-/v3/documents/-identifier-) endpoint to check processing status and retrieve results.<br/>.
        Parameters:
        body - Document to upload, either via file upload or URL to a file.
        Returns:
        the response body along with Response on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • createDocumentAsync

        public reactor.core.publisher.Mono<Document> createDocumentAsync​(DocumentCreate body)
        Uploads a document for parsing. When successful, returns an `identifier` in the response for subsequent use with the [/documents/{identifier}](#get-/v3/documents/-identifier-) endpoint to check processing status and retrieve results.<br/>.
        Parameters:
        body - Document to upload, either via file upload or URL to a file.
        Returns:
        the response body on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • createDocument

        public Document createDocument​(DocumentCreate body)
        Uploads a document for parsing. When successful, returns an `identifier` in the response for subsequent use with the [/documents/{identifier}](#get-/v3/documents/-identifier-) endpoint to check processing status and retrieve results.<br/>.
        Parameters:
        body - Document to upload, either via file upload or URL to a file.
        Returns:
        the response.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getDocumentWithResponseAsync

        public reactor.core.publisher.Mono<com.azure.core.http.rest.Response<Document>> getDocumentWithResponseAsync​(String identifier,
                                                                                                                     DocumentFormat format)
        Return a specific document.
        Parameters:
        identifier - Document's identifier.
        format - Specify which format you want the response to be. Default is "json".
        Returns:
        the response body along with Response on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getDocumentAsync

        public reactor.core.publisher.Mono<Document> getDocumentAsync​(String identifier,
                                                                      DocumentFormat format)
        Return a specific document.
        Parameters:
        identifier - Document's identifier.
        format - Specify which format you want the response to be. Default is "json".
        Returns:
        the response body on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getDocument

        public Document getDocument​(String identifier,
                                    DocumentFormat format)
        Return a specific document.
        Parameters:
        identifier - Document's identifier.
        format - Specify which format you want the response to be. Default is "json".
        Returns:
        the response.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • updateDocumentWithResponseAsync

        public reactor.core.publisher.Mono<com.azure.core.http.rest.Response<Document>> updateDocumentWithResponseAsync​(String identifier,
                                                                                                                        DocumentUpdate body)
        Update file name, expiry time, or move to another collection, etc.
        Parameters:
        identifier - Document's identifier.
        body - Document data to update.
        Returns:
        the response body along with Response on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • updateDocumentAsync

        public reactor.core.publisher.Mono<Document> updateDocumentAsync​(String identifier,
                                                                         DocumentUpdate body)
        Update file name, expiry time, or move to another collection, etc.
        Parameters:
        identifier - Document's identifier.
        body - Document data to update.
        Returns:
        the response body on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • updateDocument

        public Document updateDocument​(String identifier,
                                       DocumentUpdate body)
        Update file name, expiry time, or move to another collection, etc.
        Parameters:
        identifier - Document's identifier.
        body - Document data to update.
        Returns:
        the response.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • deleteDocumentWithResponseAsync

        public reactor.core.publisher.Mono<com.azure.core.http.rest.Response<Void>> deleteDocumentWithResponseAsync​(String identifier)
        Deletes the specified document from the database.
        Parameters:
        identifier - Document's identifier.
        Returns:
        the Response on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • deleteDocumentAsync

        public reactor.core.publisher.Mono<Void> deleteDocumentAsync​(String identifier)
        Deletes the specified document from the database.
        Parameters:
        identifier - Document's identifier.
        Returns:
        A Mono that completes when a successful response is received.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • deleteDocument

        public void deleteDocument​(String identifier)
        Deletes the specified document from the database.
        Parameters:
        identifier - Document's identifier.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • updateDocumentDataWithResponseAsync

        public reactor.core.publisher.Mono<com.azure.core.http.rest.Response<Document>> updateDocumentDataWithResponseAsync​(String identifier,
                                                                                                                            Object body)
        Update data of a document. Only applicable for resumes and job descriptions. For other document types, please use the `PATCH /annotations/{id}` endpoint or the `POST /annotations/batch_update` endpoint.
        Parameters:
        identifier - Resume or Job Description identifier.
        body - Resume data to update.
        Returns:
        the response body along with Response on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • updateDocumentDataAsync

        public reactor.core.publisher.Mono<Document> updateDocumentDataAsync​(String identifier,
                                                                             Object body)
        Update data of a document. Only applicable for resumes and job descriptions. For other document types, please use the `PATCH /annotations/{id}` endpoint or the `POST /annotations/batch_update` endpoint.
        Parameters:
        identifier - Resume or Job Description identifier.
        body - Resume data to update.
        Returns:
        the response body on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • updateDocumentData

        public Document updateDocumentData​(String identifier,
                                           Object body)
        Update data of a document. Only applicable for resumes and job descriptions. For other document types, please use the `PATCH /annotations/{id}` endpoint or the `POST /annotations/batch_update` endpoint.
        Parameters:
        identifier - Resume or Job Description identifier.
        body - Resume data to update.
        Returns:
        the response.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • batchAddTagWithResponseAsync

        public reactor.core.publisher.Mono<com.azure.core.http.rest.Response<Void>> batchAddTagWithResponseAsync​(BatchAddTagRequest body)
        Add a tag to documents. Tags are used to group documents together. Tags can be used to filter documents.
        Parameters:
        body - Specify the tag and the documents to tag.
        Returns:
        the Response on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • batchAddTagAsync

        public reactor.core.publisher.Mono<Void> batchAddTagAsync​(BatchAddTagRequest body)
        Add a tag to documents. Tags are used to group documents together. Tags can be used to filter documents.
        Parameters:
        body - Specify the tag and the documents to tag.
        Returns:
        A Mono that completes when a successful response is received.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • batchAddTag

        public void batchAddTag​(BatchAddTagRequest body)
        Add a tag to documents. Tags are used to group documents together. Tags can be used to filter documents.
        Parameters:
        body - Specify the tag and the documents to tag.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • batchRemoveTagWithResponseAsync

        public reactor.core.publisher.Mono<com.azure.core.http.rest.Response<Void>> batchRemoveTagWithResponseAsync​(BatchRemoveTagRequest body)
        Remove a tag from documents.
        Parameters:
        body - Specify the tag and the documents to remove the tag from.
        Returns:
        the Response on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • batchRemoveTagAsync

        public reactor.core.publisher.Mono<Void> batchRemoveTagAsync​(BatchRemoveTagRequest body)
        Remove a tag from documents.
        Parameters:
        body - Specify the tag and the documents to remove the tag from.
        Returns:
        A Mono that completes when a successful response is received.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • editDocumentPagesWithResponseAsync

        public reactor.core.publisher.Mono<com.azure.core.http.rest.Response<List<Meta>>> editDocumentPagesWithResponseAsync​(String identifier,
                                                                                                                             DocumentEditRequest body)
        Split / merge / rotate / delete pages of a document. Documents with multiple pages can be splitted into multiple documents, or merged into one document. Each page can also be rotated. Edit operations will trigger re-parsing of the documents involved.
        Parameters:
        identifier - Document's identifier.
        body - Describe how the pages should be edited.
        Returns:
        array of Meta along with Response on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • editDocumentPagesAsync

        public reactor.core.publisher.Mono<List<Meta>> editDocumentPagesAsync​(String identifier,
                                                                              DocumentEditRequest body)
        Split / merge / rotate / delete pages of a document. Documents with multiple pages can be splitted into multiple documents, or merged into one document. Each page can also be rotated. Edit operations will trigger re-parsing of the documents involved.
        Parameters:
        identifier - Document's identifier.
        body - Describe how the pages should be edited.
        Returns:
        array of Meta on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • editDocumentPages

        public List<Meta> editDocumentPages​(String identifier,
                                            DocumentEditRequest body)
        Split / merge / rotate / delete pages of a document. Documents with multiple pages can be splitted into multiple documents, or merged into one document. Each page can also be rotated. Edit operations will trigger re-parsing of the documents involved.
        Parameters:
        identifier - Document's identifier.
        body - Describe how the pages should be edited.
        Returns:
        array of Meta.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getAllExtractorsWithResponseAsync

        public reactor.core.publisher.Mono<com.azure.core.http.rest.Response<List<Extractor>>> getAllExtractorsWithResponseAsync​(String organization,
                                                                                                                                 Boolean includePublicExtractors,
                                                                                                                                 String name,
                                                                                                                                 Boolean validatable)
        Returns your custom extractors as well as Affinda's off-the-shelf extractors.
        Parameters:
        organization - Filter by organization.
        includePublicExtractors - Whether to include Affinda's off-the-shelf extractors.
        name - Filter by name.
        validatable - Filter by validatable.
        Returns:
        array of Extractor along with Response on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getAllExtractorsAsync

        public reactor.core.publisher.Mono<List<Extractor>> getAllExtractorsAsync​(String organization,
                                                                                  Boolean includePublicExtractors,
                                                                                  String name,
                                                                                  Boolean validatable)
        Returns your custom extractors as well as Affinda's off-the-shelf extractors.
        Parameters:
        organization - Filter by organization.
        includePublicExtractors - Whether to include Affinda's off-the-shelf extractors.
        name - Filter by name.
        validatable - Filter by validatable.
        Returns:
        array of Extractor on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getAllExtractors

        public List<Extractor> getAllExtractors​(String organization,
                                                Boolean includePublicExtractors,
                                                String name,
                                                Boolean validatable)
        Returns your custom extractors as well as Affinda's off-the-shelf extractors.
        Parameters:
        organization - Filter by organization.
        includePublicExtractors - Whether to include Affinda's off-the-shelf extractors.
        name - Filter by name.
        validatable - Filter by validatable.
        Returns:
        array of Extractor.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • createExtractorWithResponseAsync

        public reactor.core.publisher.Mono<com.azure.core.http.rest.Response<Extractor>> createExtractorWithResponseAsync​(ExtractorCreate body)
        Create a custom extractor.
        Parameters:
        body - The body parameter.
        Returns:
        the response body along with Response on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • createExtractorAsync

        public reactor.core.publisher.Mono<Extractor> createExtractorAsync​(ExtractorCreate body)
        Create a custom extractor.
        Parameters:
        body - The body parameter.
        Returns:
        the response body on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getExtractorWithResponseAsync

        public reactor.core.publisher.Mono<com.azure.core.http.rest.Response<Extractor>> getExtractorWithResponseAsync​(String identifier)
        Return a specific extractor.
        Parameters:
        identifier - Extractor's identifier.
        Returns:
        the response body along with Response on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getExtractorAsync

        public reactor.core.publisher.Mono<Extractor> getExtractorAsync​(String identifier)
        Return a specific extractor.
        Parameters:
        identifier - Extractor's identifier.
        Returns:
        the response body on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getExtractor

        public Extractor getExtractor​(String identifier)
        Return a specific extractor.
        Parameters:
        identifier - Extractor's identifier.
        Returns:
        the response.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • updateExtractorWithResponseAsync

        public reactor.core.publisher.Mono<com.azure.core.http.rest.Response<Extractor>> updateExtractorWithResponseAsync​(String identifier,
                                                                                                                          ExtractorUpdate body)
        Update data of an extractor.
        Parameters:
        identifier - Extractor's identifier.
        body - Extractor data to update.
        Returns:
        the response body along with Response on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • updateExtractorAsync

        public reactor.core.publisher.Mono<Extractor> updateExtractorAsync​(String identifier,
                                                                           ExtractorUpdate body)
        Update data of an extractor.
        Parameters:
        identifier - Extractor's identifier.
        body - Extractor data to update.
        Returns:
        the response body on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • updateExtractor

        public Extractor updateExtractor​(String identifier,
                                         ExtractorUpdate body)
        Update data of an extractor.
        Parameters:
        identifier - Extractor's identifier.
        body - Extractor data to update.
        Returns:
        the response.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • deleteExtractorWithResponseAsync

        public reactor.core.publisher.Mono<com.azure.core.http.rest.Response<Void>> deleteExtractorWithResponseAsync​(String identifier)
        Deletes the specified extractor from the database.
        Parameters:
        identifier - Extractor's identifier.
        Returns:
        the Response on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • deleteExtractorAsync

        public reactor.core.publisher.Mono<Void> deleteExtractorAsync​(String identifier)
        Deletes the specified extractor from the database.
        Parameters:
        identifier - Extractor's identifier.
        Returns:
        A Mono that completes when a successful response is received.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • deleteExtractor

        public void deleteExtractor​(String identifier)
        Deletes the specified extractor from the database.
        Parameters:
        identifier - Extractor's identifier.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getAllDataPointsWithResponseAsync

        public reactor.core.publisher.Mono<com.azure.core.http.rest.Response<List<DataPoint>>> getAllDataPointsWithResponseAsync​(Integer offset,
                                                                                                                                 Integer limit,
                                                                                                                                 String organization,
                                                                                                                                 Boolean includePublic,
                                                                                                                                 String extractor,
                                                                                                                                 String slug,
                                                                                                                                 String description,
                                                                                                                                 String annotationContentType,
                                                                                                                                 List<String> identifier)
        Returns your custom data points as well as Affinda's off-the-shelf data points.
        Parameters:
        offset - The number of documents to skip before starting to collect the result set.
        limit - The numbers of results to return.
        organization - Filter by organization.
        includePublic - Allows you to include public data points in the response when you're filtering by organization.
        extractor - Filter by extractor.
        slug - Filter by slug.
        description - Filter by description.
        annotationContentType - Filter by annotation content type, e.g. text, integer, float, date, etc.
        identifier - Filter by specific identifiers.
        Returns:
        array of DataPoint along with Response on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getAllDataPointsAsync

        public reactor.core.publisher.Mono<List<DataPoint>> getAllDataPointsAsync​(Integer offset,
                                                                                  Integer limit,
                                                                                  String organization,
                                                                                  Boolean includePublic,
                                                                                  String extractor,
                                                                                  String slug,
                                                                                  String description,
                                                                                  String annotationContentType,
                                                                                  List<String> identifier)
        Returns your custom data points as well as Affinda's off-the-shelf data points.
        Parameters:
        offset - The number of documents to skip before starting to collect the result set.
        limit - The numbers of results to return.
        organization - Filter by organization.
        includePublic - Allows you to include public data points in the response when you're filtering by organization.
        extractor - Filter by extractor.
        slug - Filter by slug.
        description - Filter by description.
        annotationContentType - Filter by annotation content type, e.g. text, integer, float, date, etc.
        identifier - Filter by specific identifiers.
        Returns:
        array of DataPoint on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getAllDataPoints

        public List<DataPoint> getAllDataPoints​(Integer offset,
                                                Integer limit,
                                                String organization,
                                                Boolean includePublic,
                                                String extractor,
                                                String slug,
                                                String description,
                                                String annotationContentType,
                                                List<String> identifier)
        Returns your custom data points as well as Affinda's off-the-shelf data points.
        Parameters:
        offset - The number of documents to skip before starting to collect the result set.
        limit - The numbers of results to return.
        organization - Filter by organization.
        includePublic - Allows you to include public data points in the response when you're filtering by organization.
        extractor - Filter by extractor.
        slug - Filter by slug.
        description - Filter by description.
        annotationContentType - Filter by annotation content type, e.g. text, integer, float, date, etc.
        identifier - Filter by specific identifiers.
        Returns:
        array of DataPoint.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • createDataPointWithResponseAsync

        public reactor.core.publisher.Mono<com.azure.core.http.rest.Response<DataPoint>> createDataPointWithResponseAsync​(DataPointCreate body)
        Create a custom data point.
        Parameters:
        body - The body parameter.
        Returns:
        the response body along with Response on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • createDataPointAsync

        public reactor.core.publisher.Mono<DataPoint> createDataPointAsync​(DataPointCreate body)
        Create a custom data point.
        Parameters:
        body - The body parameter.
        Returns:
        the response body on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getDataPointWithResponseAsync

        public reactor.core.publisher.Mono<com.azure.core.http.rest.Response<DataPoint>> getDataPointWithResponseAsync​(String identifier)
        Return a specific data point.
        Parameters:
        identifier - Data point's identifier.
        Returns:
        the response body along with Response on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getDataPointAsync

        public reactor.core.publisher.Mono<DataPoint> getDataPointAsync​(String identifier)
        Return a specific data point.
        Parameters:
        identifier - Data point's identifier.
        Returns:
        the response body on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getDataPoint

        public DataPoint getDataPoint​(String identifier)
        Return a specific data point.
        Parameters:
        identifier - Data point's identifier.
        Returns:
        the response.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • updateDataPointWithResponseAsync

        public reactor.core.publisher.Mono<com.azure.core.http.rest.Response<DataPoint>> updateDataPointWithResponseAsync​(String identifier,
                                                                                                                          DataPointUpdate body)
        Update data of a data point.
        Parameters:
        identifier - DataPoint's identifier.
        body - Data point to update.
        Returns:
        the response body along with Response on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • updateDataPointAsync

        public reactor.core.publisher.Mono<DataPoint> updateDataPointAsync​(String identifier,
                                                                           DataPointUpdate body)
        Update data of a data point.
        Parameters:
        identifier - DataPoint's identifier.
        body - Data point to update.
        Returns:
        the response body on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • deleteDataPointWithResponseAsync

        public reactor.core.publisher.Mono<com.azure.core.http.rest.Response<Void>> deleteDataPointWithResponseAsync​(String identifier)
        Deletes the specified data point from the database.
        Parameters:
        identifier - DataPoint's identifier.
        Returns:
        the Response on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • deleteDataPointAsync

        public reactor.core.publisher.Mono<Void> deleteDataPointAsync​(String identifier)
        Deletes the specified data point from the database.
        Parameters:
        identifier - DataPoint's identifier.
        Returns:
        A Mono that completes when a successful response is received.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • deleteDataPoint

        public void deleteDataPoint​(String identifier)
        Deletes the specified data point from the database.
        Parameters:
        identifier - DataPoint's identifier.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getDataPointChoicesWithResponseAsync

        public reactor.core.publisher.Mono<com.azure.core.http.rest.Response<PathsMnwxgV3DataPointChoicesGetResponses200ContentApplicationJsonSchema>> getDataPointChoicesWithResponseAsync​(String dataPoint,
                                                                                                                                                                                            String collection,
                                                                                                                                                                                            Integer offset,
                                                                                                                                                                                            Integer limit,
                                                                                                                                                                                            String search)
        Returns available choices for a specific enum data point.
        Parameters:
        dataPoint - The data point to get choices for.
        collection - The collection to get choices for.
        offset - The number of documents to skip before starting to collect the result set.
        limit - The numbers of results to return.
        search - Filter choices by searching for a substring.
        Returns:
        the response body along with Response on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getDataPointChoicesAsync

        public reactor.core.publisher.Mono<PathsMnwxgV3DataPointChoicesGetResponses200ContentApplicationJsonSchema> getDataPointChoicesAsync​(String dataPoint,
                                                                                                                                             String collection,
                                                                                                                                             Integer offset,
                                                                                                                                             Integer limit,
                                                                                                                                             String search)
        Returns available choices for a specific enum data point.
        Parameters:
        dataPoint - The data point to get choices for.
        collection - The collection to get choices for.
        offset - The number of documents to skip before starting to collect the result set.
        limit - The numbers of results to return.
        search - Filter choices by searching for a substring.
        Returns:
        the response body on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • createDataPointChoiceWithResponseAsync

        public reactor.core.publisher.Mono<com.azure.core.http.rest.Response<DataPointChoice>> createDataPointChoiceWithResponseAsync​(DataPointChoiceCreate body)
        Create a custom data point choice.
        Parameters:
        body - The body parameter.
        Returns:
        the response body along with Response on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • createDataPointChoiceAsync

        public reactor.core.publisher.Mono<DataPointChoice> createDataPointChoiceAsync​(DataPointChoiceCreate body)
        Create a custom data point choice.
        Parameters:
        body - The body parameter.
        Returns:
        the response body on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getDataPointChoiceWithResponseAsync

        public reactor.core.publisher.Mono<com.azure.core.http.rest.Response<DataPointChoice>> getDataPointChoiceWithResponseAsync​(int id)
        Return a specific data point choice.
        Parameters:
        id - Data point choice's ID.
        Returns:
        the response body along with Response on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getDataPointChoiceAsync

        public reactor.core.publisher.Mono<DataPointChoice> getDataPointChoiceAsync​(int id)
        Return a specific data point choice.
        Parameters:
        id - Data point choice's ID.
        Returns:
        the response body on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getDataPointChoice

        public DataPointChoice getDataPointChoice​(int id)
        Return a specific data point choice.
        Parameters:
        id - Data point choice's ID.
        Returns:
        the response.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • updateDataPointChoiceWithResponseAsync

        public reactor.core.publisher.Mono<com.azure.core.http.rest.Response<DataPointChoice>> updateDataPointChoiceWithResponseAsync​(int id,
                                                                                                                                      DataPointChoiceUpdate body)
        Update data of a data point choice.
        Parameters:
        id - Data point choice's ID.
        body - Data point choice to update.
        Returns:
        the response body along with Response on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • updateDataPointChoiceAsync

        public reactor.core.publisher.Mono<DataPointChoice> updateDataPointChoiceAsync​(int id,
                                                                                       DataPointChoiceUpdate body)
        Update data of a data point choice.
        Parameters:
        id - Data point choice's ID.
        body - Data point choice to update.
        Returns:
        the response body on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • deleteDataPointChoiceWithResponseAsync

        public reactor.core.publisher.Mono<com.azure.core.http.rest.Response<Void>> deleteDataPointChoiceWithResponseAsync​(int id)
        Deletes the specified data point choice from the database.
        Parameters:
        id - Data point choice's ID.
        Returns:
        the Response on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • deleteDataPointChoiceAsync

        public reactor.core.publisher.Mono<Void> deleteDataPointChoiceAsync​(int id)
        Deletes the specified data point choice from the database.
        Parameters:
        id - Data point choice's ID.
        Returns:
        A Mono that completes when a successful response is received.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • deleteDataPointChoice

        public void deleteDataPointChoice​(int id)
        Deletes the specified data point choice from the database.
        Parameters:
        id - Data point choice's ID.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • createAnnotationWithResponseAsync

        public reactor.core.publisher.Mono<com.azure.core.http.rest.Response<Annotation>> createAnnotationWithResponseAsync​(AnnotationCreate body)
        Create a annotation.
        Parameters:
        body - The body parameter.
        Returns:
        the response body along with Response on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • createAnnotationAsync

        public reactor.core.publisher.Mono<Annotation> createAnnotationAsync​(AnnotationCreate body)
        Create a annotation.
        Parameters:
        body - The body parameter.
        Returns:
        the response body on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getAnnotationWithResponseAsync

        public reactor.core.publisher.Mono<com.azure.core.http.rest.Response<Annotation>> getAnnotationWithResponseAsync​(int id)
        Return a specific annotation.
        Parameters:
        id - Annotation's ID.
        Returns:
        the response body along with Response on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getAnnotationAsync

        public reactor.core.publisher.Mono<Annotation> getAnnotationAsync​(int id)
        Return a specific annotation.
        Parameters:
        id - Annotation's ID.
        Returns:
        the response body on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getAnnotation

        public Annotation getAnnotation​(int id)
        Return a specific annotation.
        Parameters:
        id - Annotation's ID.
        Returns:
        the response.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • updateAnnotationWithResponseAsync

        public reactor.core.publisher.Mono<com.azure.core.http.rest.Response<Annotation>> updateAnnotationWithResponseAsync​(int id,
                                                                                                                            AnnotationUpdate body)
        Update data of an annotation.
        Parameters:
        id - Annotation's ID.
        body - Annotation data to update.
        Returns:
        the response body along with Response on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • updateAnnotationAsync

        public reactor.core.publisher.Mono<Annotation> updateAnnotationAsync​(int id,
                                                                             AnnotationUpdate body)
        Update data of an annotation.
        Parameters:
        id - Annotation's ID.
        body - Annotation data to update.
        Returns:
        the response body on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • updateAnnotation

        public Annotation updateAnnotation​(int id,
                                           AnnotationUpdate body)
        Update data of an annotation.
        Parameters:
        id - Annotation's ID.
        body - Annotation data to update.
        Returns:
        the response.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • deleteAnnotationWithResponseAsync

        public reactor.core.publisher.Mono<com.azure.core.http.rest.Response<Void>> deleteAnnotationWithResponseAsync​(int id)
        Deletes the specified annotation from the database.
        Parameters:
        id - Annotation's ID.
        Returns:
        the Response on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • deleteAnnotationAsync

        public reactor.core.publisher.Mono<Void> deleteAnnotationAsync​(int id)
        Deletes the specified annotation from the database.
        Parameters:
        id - Annotation's ID.
        Returns:
        A Mono that completes when a successful response is received.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • deleteAnnotation

        public void deleteAnnotation​(int id)
        Deletes the specified annotation from the database.
        Parameters:
        id - Annotation's ID.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • batchCreateAnnotationsWithResponseAsync

        public reactor.core.publisher.Mono<com.azure.core.http.rest.Response<List<Annotation>>> batchCreateAnnotationsWithResponseAsync​(List<AnnotationCreate> body)
        Batch create annotations.
        Parameters:
        body - Array of AnnotationCreate.
        Returns:
        array of Annotation along with Response on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • batchCreateAnnotationsAsync

        public reactor.core.publisher.Mono<List<Annotation>> batchCreateAnnotationsAsync​(List<AnnotationCreate> body)
        Batch create annotations.
        Parameters:
        body - Array of AnnotationCreate.
        Returns:
        array of Annotation on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • batchUpdateAnnotationsWithResponseAsync

        public reactor.core.publisher.Mono<com.azure.core.http.rest.Response<List<Annotation>>> batchUpdateAnnotationsWithResponseAsync​(List<AnnotationBatchUpdate> body)
        Batch update annotations.
        Parameters:
        body - Array of AnnotationBatchUpdate.
        Returns:
        array of Annotation along with Response on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • batchUpdateAnnotationsAsync

        public reactor.core.publisher.Mono<List<Annotation>> batchUpdateAnnotationsAsync​(List<AnnotationBatchUpdate> body)
        Batch update annotations.
        Parameters:
        body - Array of AnnotationBatchUpdate.
        Returns:
        array of Annotation on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • batchDeleteAnnotationsWithResponseAsync

        public reactor.core.publisher.Mono<com.azure.core.http.rest.Response<Void>> batchDeleteAnnotationsWithResponseAsync​(List<Integer> body)
        Batch delete annotations.
        Parameters:
        body - Array of annotation IDs to be deleted.
        Returns:
        the Response on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • batchDeleteAnnotationsAsync

        public reactor.core.publisher.Mono<Void> batchDeleteAnnotationsAsync​(List<Integer> body)
        Batch delete annotations.
        Parameters:
        body - Array of annotation IDs to be deleted.
        Returns:
        A Mono that completes when a successful response is received.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • batchDeleteAnnotations

        public void batchDeleteAnnotations​(List<Integer> body)
        Batch delete annotations.
        Parameters:
        body - Array of annotation IDs to be deleted.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getAllTagsWithResponseAsync

        public reactor.core.publisher.Mono<com.azure.core.http.rest.Response<List<Tag>>> getAllTagsWithResponseAsync​(Integer limit,
                                                                                                                     Integer offset,
                                                                                                                     String workspace)
        Returns your tags.
        Parameters:
        limit - The numbers of results to return.
        offset - The number of documents to skip before starting to collect the result set.
        workspace - Filter by workspace.
        Returns:
        array of Tag along with Response on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getAllTagsAsync

        public reactor.core.publisher.Mono<List<Tag>> getAllTagsAsync​(Integer limit,
                                                                      Integer offset,
                                                                      String workspace)
        Returns your tags.
        Parameters:
        limit - The numbers of results to return.
        offset - The number of documents to skip before starting to collect the result set.
        workspace - Filter by workspace.
        Returns:
        array of Tag on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getAllTags

        public List<Tag> getAllTags​(Integer limit,
                                    Integer offset,
                                    String workspace)
        Returns your tags.
        Parameters:
        limit - The numbers of results to return.
        offset - The number of documents to skip before starting to collect the result set.
        workspace - Filter by workspace.
        Returns:
        array of Tag.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • createTagWithResponseAsync

        public reactor.core.publisher.Mono<com.azure.core.http.rest.Response<Tag>> createTagWithResponseAsync​(TagCreate body)
        Create a tag.
        Parameters:
        body - The body parameter.
        Returns:
        the response body along with Response on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • createTagAsync

        public reactor.core.publisher.Mono<Tag> createTagAsync​(TagCreate body)
        Create a tag.
        Parameters:
        body - The body parameter.
        Returns:
        the response body on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getTagWithResponseAsync

        public reactor.core.publisher.Mono<com.azure.core.http.rest.Response<Tag>> getTagWithResponseAsync​(int id)
        Return a specific tag.
        Parameters:
        id - Tag's ID.
        Returns:
        the response body along with Response on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getTagAsync

        public reactor.core.publisher.Mono<Tag> getTagAsync​(int id)
        Return a specific tag.
        Parameters:
        id - Tag's ID.
        Returns:
        the response body on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getTag

        public Tag getTag​(int id)
        Return a specific tag.
        Parameters:
        id - Tag's ID.
        Returns:
        the response.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • updateTagWithResponseAsync

        public reactor.core.publisher.Mono<com.azure.core.http.rest.Response<Tag>> updateTagWithResponseAsync​(int id,
                                                                                                              TagUpdate body)
        Update data of an tag.
        Parameters:
        id - Tag's ID.
        body - Tag data to update.
        Returns:
        the response body along with Response on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • updateTagAsync

        public reactor.core.publisher.Mono<Tag> updateTagAsync​(int id,
                                                               TagUpdate body)
        Update data of an tag.
        Parameters:
        id - Tag's ID.
        body - Tag data to update.
        Returns:
        the response body on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • updateTag

        public Tag updateTag​(int id,
                             TagUpdate body)
        Update data of an tag.
        Parameters:
        id - Tag's ID.
        body - Tag data to update.
        Returns:
        the response.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • deleteTagWithResponseAsync

        public reactor.core.publisher.Mono<com.azure.core.http.rest.Response<Void>> deleteTagWithResponseAsync​(int id)
        Deletes the specified tag from the database.
        Parameters:
        id - Tag's ID.
        Returns:
        the Response on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • deleteTagAsync

        public reactor.core.publisher.Mono<Void> deleteTagAsync​(int id)
        Deletes the specified tag from the database.
        Parameters:
        id - Tag's ID.
        Returns:
        A Mono that completes when a successful response is received.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • deleteTag

        public void deleteTag​(int id)
        Deletes the specified tag from the database.
        Parameters:
        id - Tag's ID.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getAllOrganizationsWithResponseAsync

        public reactor.core.publisher.Mono<com.azure.core.http.rest.Response<List<Organization>>> getAllOrganizationsWithResponseAsync()
        Returns all the organizations.
        Returns:
        array of Organization along with Response on successful completion of Mono.
        Throws:
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getAllOrganizationsAsync

        public reactor.core.publisher.Mono<List<Organization>> getAllOrganizationsAsync()
        Returns all the organizations.
        Returns:
        array of Organization on successful completion of Mono.
        Throws:
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getAllOrganizations

        public List<Organization> getAllOrganizations()
        Returns all the organizations.
        Returns:
        array of Organization.
        Throws:
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • createOrganizationWithResponseAsync

        public reactor.core.publisher.Mono<com.azure.core.http.rest.Response<Organization>> createOrganizationWithResponseAsync​(OrganizationCreate body)
        Create a new organization.
        Parameters:
        body - Organization to create.
        Returns:
        the response body along with Response on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • createOrganizationAsync

        public reactor.core.publisher.Mono<Organization> createOrganizationAsync​(OrganizationCreate body)
        Create a new organization.
        Parameters:
        body - Organization to create.
        Returns:
        the response body on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getOrganizationWithResponseAsync

        public reactor.core.publisher.Mono<com.azure.core.http.rest.Response<Organization>> getOrganizationWithResponseAsync​(String identifier)
        Get detail of an organization.
        Parameters:
        identifier - Organization identifier.
        Returns:
        detail of an organization along with Response on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getOrganizationAsync

        public reactor.core.publisher.Mono<Organization> getOrganizationAsync​(String identifier)
        Get detail of an organization.
        Parameters:
        identifier - Organization identifier.
        Returns:
        detail of an organization on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getOrganization

        public Organization getOrganization​(String identifier)
        Get detail of an organization.
        Parameters:
        identifier - Organization identifier.
        Returns:
        detail of an organization.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • updateOrganizationWithResponseAsync

        public reactor.core.publisher.Mono<com.azure.core.http.rest.Response<Organization>> updateOrganizationWithResponseAsync​(String identifier,
                                                                                                                                String name,
                                                                                                                                reactor.core.publisher.Flux<ByteBuffer> avatar,
                                                                                                                                Long contentLength,
                                                                                                                                String resthookSignatureKey,
                                                                                                                                ValidationToolConfig validationToolConfig)
        Update the detail of an organization.
        Parameters:
        identifier - Organization identifier.
        name - The name parameter.
        avatar - Upload avatar for the organization.
        contentLength - The contentLength parameter.
        resthookSignatureKey - Used to sign webhook payloads so you can verify their integrity.
        validationToolConfig - Configuration of the embeddable validation tool.
        Returns:
        the response body along with Response on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • updateOrganizationAsync

        public reactor.core.publisher.Mono<Organization> updateOrganizationAsync​(String identifier,
                                                                                 String name,
                                                                                 reactor.core.publisher.Flux<ByteBuffer> avatar,
                                                                                 Long contentLength,
                                                                                 String resthookSignatureKey,
                                                                                 ValidationToolConfig validationToolConfig)
        Update the detail of an organization.
        Parameters:
        identifier - Organization identifier.
        name - The name parameter.
        avatar - Upload avatar for the organization.
        contentLength - The contentLength parameter.
        resthookSignatureKey - Used to sign webhook payloads so you can verify their integrity.
        validationToolConfig - Configuration of the embeddable validation tool.
        Returns:
        the response body on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • updateOrganization

        public Organization updateOrganization​(String identifier,
                                               String name,
                                               reactor.core.publisher.Flux<ByteBuffer> avatar,
                                               Long contentLength,
                                               String resthookSignatureKey,
                                               ValidationToolConfig validationToolConfig)
        Update the detail of an organization.
        Parameters:
        identifier - Organization identifier.
        name - The name parameter.
        avatar - Upload avatar for the organization.
        contentLength - The contentLength parameter.
        resthookSignatureKey - Used to sign webhook payloads so you can verify their integrity.
        validationToolConfig - Configuration of the embeddable validation tool.
        Returns:
        the response.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • deleteOrganizationWithResponseAsync

        public reactor.core.publisher.Mono<com.azure.core.http.rest.Response<Void>> deleteOrganizationWithResponseAsync​(String identifier)
        Delete the specified organization from the database.
        Parameters:
        identifier - Organization identifier.
        Returns:
        the Response on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • deleteOrganizationAsync

        public reactor.core.publisher.Mono<Void> deleteOrganizationAsync​(String identifier)
        Delete the specified organization from the database.
        Parameters:
        identifier - Organization identifier.
        Returns:
        A Mono that completes when a successful response is received.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • deleteOrganization

        public void deleteOrganization​(String identifier)
        Delete the specified organization from the database.
        Parameters:
        identifier - Organization identifier.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getOrganizationMembershipWithResponseAsync

        public reactor.core.publisher.Mono<com.azure.core.http.rest.Response<OrganizationMembership>> getOrganizationMembershipWithResponseAsync​(String identifier)
        Get detail of an organization membership.
        Parameters:
        identifier - Membership identifier.
        Returns:
        detail of an organization membership along with Response on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getOrganizationMembershipAsync

        public reactor.core.publisher.Mono<OrganizationMembership> getOrganizationMembershipAsync​(String identifier)
        Get detail of an organization membership.
        Parameters:
        identifier - Membership identifier.
        Returns:
        detail of an organization membership on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getOrganizationMembership

        public OrganizationMembership getOrganizationMembership​(String identifier)
        Get detail of an organization membership.
        Parameters:
        identifier - Membership identifier.
        Returns:
        detail of an organization membership.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • updateOrganizationMembershipWithResponseAsync

        public reactor.core.publisher.Mono<com.azure.core.http.rest.Response<OrganizationMembership>> updateOrganizationMembershipWithResponseAsync​(String identifier,
                                                                                                                                                    OrganizationMembershipUpdate body)
        The admin users can use this endpoint to update the role of the members within their organization.
        Parameters:
        identifier - Membership identifier.
        body - The body parameter.
        Returns:
        the response body along with Response on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • updateOrganizationMembershipAsync

        public reactor.core.publisher.Mono<OrganizationMembership> updateOrganizationMembershipAsync​(String identifier,
                                                                                                     OrganizationMembershipUpdate body)
        The admin users can use this endpoint to update the role of the members within their organization.
        Parameters:
        identifier - Membership identifier.
        body - The body parameter.
        Returns:
        the response body on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • deleteOrganizationMembershipWithResponseAsync

        public reactor.core.publisher.Mono<com.azure.core.http.rest.Response<Void>> deleteOrganizationMembershipWithResponseAsync​(String identifier)
        The admin users can use this endpoint to remove member from their organization. Other users can also use this to leave their organization.
        Parameters:
        identifier - Membership identifier.
        Returns:
        the Response on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • deleteOrganizationMembershipAsync

        public reactor.core.publisher.Mono<Void> deleteOrganizationMembershipAsync​(String identifier)
        The admin users can use this endpoint to remove member from their organization. Other users can also use this to leave their organization.
        Parameters:
        identifier - Membership identifier.
        Returns:
        A Mono that completes when a successful response is received.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • deleteOrganizationMembership

        public void deleteOrganizationMembership​(String identifier)
        The admin users can use this endpoint to remove member from their organization. Other users can also use this to leave their organization.
        Parameters:
        identifier - Membership identifier.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getAllInvitationsWithResponseAsync

        public reactor.core.publisher.Mono<com.azure.core.http.rest.Response<Paths18Wh2VcV3InvitationsGetResponses200ContentApplicationJsonSchema>> getAllInvitationsWithResponseAsync​(Integer offset,
                                                                                                                                                                                       Integer limit,
                                                                                                                                                                                       String organization,
                                                                                                                                                                                       InvitationStatus status,
                                                                                                                                                                                       OrganizationRole role)
        Get list of all invitations you created or sent to you.
        Parameters:
        offset - The number of documents to skip before starting to collect the result set.
        limit - The numbers of results to return.
        organization - Filter by organization.
        status - Filter by status.
        role - Filter by role.
        Returns:
        list of all invitations you created or sent to you along with Response on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • createInvitationWithResponseAsync

        public reactor.core.publisher.Mono<com.azure.core.http.rest.Response<Invitation>> createInvitationWithResponseAsync​(InvitationCreate body)
        Create a new invitation.
        Parameters:
        body - Invitation to create.
        Returns:
        the response body along with Response on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • createInvitationAsync

        public reactor.core.publisher.Mono<Invitation> createInvitationAsync​(InvitationCreate body)
        Create a new invitation.
        Parameters:
        body - Invitation to create.
        Returns:
        the response body on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getInvitationWithResponseAsync

        public reactor.core.publisher.Mono<com.azure.core.http.rest.Response<Invitation>> getInvitationWithResponseAsync​(String identifier)
        Get detail of an invitation.
        Parameters:
        identifier - Invitation identifier.
        Returns:
        detail of an invitation along with Response on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getInvitationAsync

        public reactor.core.publisher.Mono<Invitation> getInvitationAsync​(String identifier)
        Get detail of an invitation.
        Parameters:
        identifier - Invitation identifier.
        Returns:
        detail of an invitation on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getInvitation

        public Invitation getInvitation​(String identifier)
        Get detail of an invitation.
        Parameters:
        identifier - Invitation identifier.
        Returns:
        detail of an invitation.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • updateInvitationWithResponseAsync

        public reactor.core.publisher.Mono<com.azure.core.http.rest.Response<Invitation>> updateInvitationWithResponseAsync​(String identifier,
                                                                                                                            InvitationUpdate body)
        Update the detail of an invitation.
        Parameters:
        identifier - Invitation identifier.
        body - The body parameter.
        Returns:
        the response body along with Response on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • updateInvitationAsync

        public reactor.core.publisher.Mono<Invitation> updateInvitationAsync​(String identifier,
                                                                             InvitationUpdate body)
        Update the detail of an invitation.
        Parameters:
        identifier - Invitation identifier.
        body - The body parameter.
        Returns:
        the response body on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • deleteInvitationWithResponseAsync

        public reactor.core.publisher.Mono<com.azure.core.http.rest.Response<Void>> deleteInvitationWithResponseAsync​(String identifier)
        Delete the specified invitation from the database.
        Parameters:
        identifier - Invitation identifier.
        Returns:
        the Response on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • deleteInvitationAsync

        public reactor.core.publisher.Mono<Void> deleteInvitationAsync​(String identifier)
        Delete the specified invitation from the database.
        Parameters:
        identifier - Invitation identifier.
        Returns:
        A Mono that completes when a successful response is received.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • deleteInvitation

        public void deleteInvitation​(String identifier)
        Delete the specified invitation from the database.
        Parameters:
        identifier - Invitation identifier.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getInvitationByTokenWithResponseAsync

        public reactor.core.publisher.Mono<com.azure.core.http.rest.Response<Invitation>> getInvitationByTokenWithResponseAsync​(String token)
        Get detail of an invitation using a secret token. This allows users who have not registered/logged in to view the invitation.
        Parameters:
        token - Invitation token.
        Returns:
        detail of an invitation using a secret token along with Response on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getInvitationByTokenAsync

        public reactor.core.publisher.Mono<Invitation> getInvitationByTokenAsync​(String token)
        Get detail of an invitation using a secret token. This allows users who have not registered/logged in to view the invitation.
        Parameters:
        token - Invitation token.
        Returns:
        detail of an invitation using a secret token on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getInvitationByToken

        public Invitation getInvitationByToken​(String token)
        Get detail of an invitation using a secret token. This allows users who have not registered/logged in to view the invitation.
        Parameters:
        token - Invitation token.
        Returns:
        detail of an invitation using a secret token.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • respondToInvitationWithResponseAsync

        public reactor.core.publisher.Mono<com.azure.core.http.rest.Response<Invitation>> respondToInvitationWithResponseAsync​(String token,
                                                                                                                               InvitationResponse body)
        Choose to accept or decline an invitation.
        Parameters:
        token - Invitation token.
        body - The body parameter.
        Returns:
        the response body along with Response on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • respondToInvitationAsync

        public reactor.core.publisher.Mono<Invitation> respondToInvitationAsync​(String token,
                                                                                InvitationResponse body)
        Choose to accept or decline an invitation.
        Parameters:
        token - Invitation token.
        body - The body parameter.
        Returns:
        the response body on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • createApiUserWithResponseAsync

        public reactor.core.publisher.Mono<com.azure.core.http.rest.Response<ApiUserWithKey>> createApiUserWithResponseAsync​(ApiUserCreate body)
        Create an API user.
        Parameters:
        body - The body parameter.
        Returns:
        the response body along with Response on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • createApiUserAsync

        public reactor.core.publisher.Mono<ApiUserWithKey> createApiUserAsync​(ApiUserCreate body)
        Create an API user.
        Parameters:
        body - The body parameter.
        Returns:
        the response body on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getApiUserWithResponseAsync

        public reactor.core.publisher.Mono<com.azure.core.http.rest.Response<ApiUserWithoutKey>> getApiUserWithResponseAsync​(int id)
        Return a specific API user.
        Parameters:
        id - API user's ID.
        Returns:
        the response body along with Response on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getApiUserAsync

        public reactor.core.publisher.Mono<ApiUserWithoutKey> getApiUserAsync​(int id)
        Return a specific API user.
        Parameters:
        id - API user's ID.
        Returns:
        the response body on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • updateApiUserWithResponseAsync

        public reactor.core.publisher.Mono<com.azure.core.http.rest.Response<ApiUserWithoutKey>> updateApiUserWithResponseAsync​(int id,
                                                                                                                                ApiUserUpdate body)
        Update data of an API user.
        Parameters:
        id - API user's ID.
        body - API user to update.
        Returns:
        the response body along with Response on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • updateApiUserAsync

        public reactor.core.publisher.Mono<ApiUserWithoutKey> updateApiUserAsync​(int id,
                                                                                 ApiUserUpdate body)
        Update data of an API user.
        Parameters:
        id - API user's ID.
        body - API user to update.
        Returns:
        the response body on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • deleteApiUserWithResponseAsync

        public reactor.core.publisher.Mono<com.azure.core.http.rest.Response<Void>> deleteApiUserWithResponseAsync​(int id)
        Deletes the specified API user from the database.
        Parameters:
        id - API user's ID.
        Returns:
        the Response on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • deleteApiUserAsync

        public reactor.core.publisher.Mono<Void> deleteApiUserAsync​(int id)
        Deletes the specified API user from the database.
        Parameters:
        id - API user's ID.
        Returns:
        A Mono that completes when a successful response is received.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • deleteApiUser

        public void deleteApiUser​(int id)
        Deletes the specified API user from the database.
        Parameters:
        id - API user's ID.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • regenerateApiKeyForApiUserWithResponseAsync

        public reactor.core.publisher.Mono<com.azure.core.http.rest.Response<ApiUserWithKey>> regenerateApiKeyForApiUserWithResponseAsync​(int id)
        Regenerate API key for an API user.
        Parameters:
        id - API user's ID.
        Returns:
        the response body along with Response on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • regenerateApiKeyForApiUserAsync

        public reactor.core.publisher.Mono<ApiUserWithKey> regenerateApiKeyForApiUserAsync​(int id)
        Regenerate API key for an API user.
        Parameters:
        id - API user's ID.
        Returns:
        the response body on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • regenerateApiKeyForApiUser

        public ApiUserWithKey regenerateApiKeyForApiUser​(int id)
        Regenerate API key for an API user.
        Parameters:
        id - API user's ID.
        Returns:
        the response.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • createResthookSubscriptionWithResponseAsync

        public reactor.core.publisher.Mono<com.azure.core.http.rest.Response<ResthookSubscription>> createResthookSubscriptionWithResponseAsync​(ResthookSubscriptionCreate body)
        After a subscription is sucessfully created, we'll send a POST request to your target URL with a `X-Hook-Secret` header. <br /> You need to response to this request with a 200 status code to confirm your subscribe intention. <br /> Then, you need to use the `X-Hook-Secret` to activate the subscription using the [/resthook_subscriptions/activate](#post-/v3/resthook_subscriptions/activate) endpoint. <br /> For more information, see our help article here - [How do I create a webhook?](https://help.affinda.com/hc/en-au/articles/11474095148569-How-do-I-create-a-webhook).
        Parameters:
        body - The body parameter.
        Returns:
        the response body along with Response on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • createResthookSubscriptionAsync

        public reactor.core.publisher.Mono<ResthookSubscription> createResthookSubscriptionAsync​(ResthookSubscriptionCreate body)
        After a subscription is sucessfully created, we'll send a POST request to your target URL with a `X-Hook-Secret` header. <br /> You need to response to this request with a 200 status code to confirm your subscribe intention. <br /> Then, you need to use the `X-Hook-Secret` to activate the subscription using the [/resthook_subscriptions/activate](#post-/v3/resthook_subscriptions/activate) endpoint. <br /> For more information, see our help article here - [How do I create a webhook?](https://help.affinda.com/hc/en-au/articles/11474095148569-How-do-I-create-a-webhook).
        Parameters:
        body - The body parameter.
        Returns:
        the response body on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • createResthookSubscription

        public ResthookSubscription createResthookSubscription​(ResthookSubscriptionCreate body)
        After a subscription is sucessfully created, we'll send a POST request to your target URL with a `X-Hook-Secret` header. <br /> You need to response to this request with a 200 status code to confirm your subscribe intention. <br /> Then, you need to use the `X-Hook-Secret` to activate the subscription using the [/resthook_subscriptions/activate](#post-/v3/resthook_subscriptions/activate) endpoint. <br /> For more information, see our help article here - [How do I create a webhook?](https://help.affinda.com/hc/en-au/articles/11474095148569-How-do-I-create-a-webhook).
        Parameters:
        body - The body parameter.
        Returns:
        the response.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getResthookSubscriptionWithResponseAsync

        public reactor.core.publisher.Mono<com.azure.core.http.rest.Response<ResthookSubscription>> getResthookSubscriptionWithResponseAsync​(int id)
        Return a specific resthook subscription.
        Parameters:
        id - Resthook subscription's ID.
        Returns:
        the response body along with Response on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getResthookSubscriptionAsync

        public reactor.core.publisher.Mono<ResthookSubscription> getResthookSubscriptionAsync​(int id)
        Return a specific resthook subscription.
        Parameters:
        id - Resthook subscription's ID.
        Returns:
        the response body on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getResthookSubscription

        public ResthookSubscription getResthookSubscription​(int id)
        Return a specific resthook subscription.
        Parameters:
        id - Resthook subscription's ID.
        Returns:
        the response.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • updateResthookSubscriptionWithResponseAsync

        public reactor.core.publisher.Mono<com.azure.core.http.rest.Response<ResthookSubscription>> updateResthookSubscriptionWithResponseAsync​(int id,
                                                                                                                                                ResthookSubscriptionUpdate body)
        Update data of a resthook subscription.
        Parameters:
        id - ResthookSubscription's ID.
        body - ResthookSubscription data to update.
        Returns:
        the response body along with Response on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • updateResthookSubscriptionAsync

        public reactor.core.publisher.Mono<ResthookSubscription> updateResthookSubscriptionAsync​(int id,
                                                                                                 ResthookSubscriptionUpdate body)
        Update data of a resthook subscription.
        Parameters:
        id - ResthookSubscription's ID.
        body - ResthookSubscription data to update.
        Returns:
        the response body on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • deleteResthookSubscriptionWithResponseAsync

        public reactor.core.publisher.Mono<com.azure.core.http.rest.Response<Void>> deleteResthookSubscriptionWithResponseAsync​(int id)
        Deletes the specified resthook subscription from the database.
        Parameters:
        id - ResthookSubscription's ID.
        Returns:
        the Response on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • deleteResthookSubscriptionAsync

        public reactor.core.publisher.Mono<Void> deleteResthookSubscriptionAsync​(int id)
        Deletes the specified resthook subscription from the database.
        Parameters:
        id - ResthookSubscription's ID.
        Returns:
        A Mono that completes when a successful response is received.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • deleteResthookSubscription

        public void deleteResthookSubscription​(int id)
        Deletes the specified resthook subscription from the database.
        Parameters:
        id - ResthookSubscription's ID.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • activateResthookSubscriptionWithResponseAsync

        public reactor.core.publisher.Mono<com.azure.core.http.rest.Response<ResthookSubscription>> activateResthookSubscriptionWithResponseAsync​(String xHookSecret)
        After creating a subscription, we'll send a POST request to your target URL with a `X-Hook-Secret` header. <br /> You should response to this with a 200 status code, and use the value of the `X-Hook-Secret` header that you received to activate the subscription using this endpoint.
        Parameters:
        xHookSecret - The secret received when creating a subscription.
        Returns:
        the response body along with Response on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • activateResthookSubscriptionAsync

        public reactor.core.publisher.Mono<ResthookSubscription> activateResthookSubscriptionAsync​(String xHookSecret)
        After creating a subscription, we'll send a POST request to your target URL with a `X-Hook-Secret` header. <br /> You should response to this with a 200 status code, and use the value of the `X-Hook-Secret` header that you received to activate the subscription using this endpoint.
        Parameters:
        xHookSecret - The secret received when creating a subscription.
        Returns:
        the response body on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • activateResthookSubscription

        public ResthookSubscription activateResthookSubscription​(String xHookSecret)
        After creating a subscription, we'll send a POST request to your target URL with a `X-Hook-Secret` header. <br /> You should response to this with a 200 status code, and use the value of the `X-Hook-Secret` header that you received to activate the subscription using this endpoint.
        Parameters:
        xHookSecret - The secret received when creating a subscription.
        Returns:
        the response.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • listOccupationGroupsWithResponseAsync

        public reactor.core.publisher.Mono<com.azure.core.http.rest.Response<List<OccupationGroup>>> listOccupationGroupsWithResponseAsync()
        Returns the list of searchable occupation groups.
        Returns:
        array of OccupationGroup along with Response on successful completion of Mono.
        Throws:
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • listOccupationGroupsAsync

        public reactor.core.publisher.Mono<List<OccupationGroup>> listOccupationGroupsAsync()
        Returns the list of searchable occupation groups.
        Returns:
        array of OccupationGroup on successful completion of Mono.
        Throws:
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • listOccupationGroups

        public List<OccupationGroup> listOccupationGroups()
        Returns the list of searchable occupation groups.
        Returns:
        array of OccupationGroup.
        Throws:
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • createJobDescriptionSearchWithResponseAsync

        public reactor.core.publisher.Mono<com.azure.core.http.rest.Response<JobDescriptionSearch>> createJobDescriptionSearchWithResponseAsync​(JobDescriptionSearchParameters body,
                                                                                                                                                Integer offset,
                                                                                                                                                Integer limit)
        Searches through parsed job descriptions. You can search with custom criterias or a resume.
        Parameters:
        body - Search parameters.
        offset - The number of documents to skip before starting to collect the result set.
        limit - The numbers of results to return.
        Returns:
        the response body along with Response on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • createJobDescriptionSearchAsync

        public reactor.core.publisher.Mono<JobDescriptionSearch> createJobDescriptionSearchAsync​(JobDescriptionSearchParameters body,
                                                                                                 Integer offset,
                                                                                                 Integer limit)
        Searches through parsed job descriptions. You can search with custom criterias or a resume.
        Parameters:
        body - Search parameters.
        offset - The number of documents to skip before starting to collect the result set.
        limit - The numbers of results to return.
        Returns:
        the response body on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • createJobDescriptionSearch

        public JobDescriptionSearch createJobDescriptionSearch​(JobDescriptionSearchParameters body,
                                                               Integer offset,
                                                               Integer limit)
        Searches through parsed job descriptions. You can search with custom criterias or a resume.
        Parameters:
        body - Search parameters.
        offset - The number of documents to skip before starting to collect the result set.
        limit - The numbers of results to return.
        Returns:
        the response.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getJobDescriptionSearchDetailWithResponseAsync

        public reactor.core.publisher.Mono<com.azure.core.http.rest.Response<JobDescriptionSearchDetail>> getJobDescriptionSearchDetailWithResponseAsync​(String identifier,
                                                                                                                                                         JobDescriptionSearchParameters body)
        This contains more detailed information about the matching score of the search criteria, or which search criteria is missing in this job description. The `identifier` is the unique ID returned via the [/job_description_search](#post-/job_description_search) endpoint.
        Parameters:
        identifier - Job Description identifier.
        body - Search parameters.
        Returns:
        the response body along with Response on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getJobDescriptionSearchDetailAsync

        public reactor.core.publisher.Mono<JobDescriptionSearchDetail> getJobDescriptionSearchDetailAsync​(String identifier,
                                                                                                          JobDescriptionSearchParameters body)
        This contains more detailed information about the matching score of the search criteria, or which search criteria is missing in this job description. The `identifier` is the unique ID returned via the [/job_description_search](#post-/job_description_search) endpoint.
        Parameters:
        identifier - Job Description identifier.
        body - Search parameters.
        Returns:
        the response body on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getJobDescriptionSearchDetail

        public JobDescriptionSearchDetail getJobDescriptionSearchDetail​(String identifier,
                                                                        JobDescriptionSearchParameters body)
        This contains more detailed information about the matching score of the search criteria, or which search criteria is missing in this job description. The `identifier` is the unique ID returned via the [/job_description_search](#post-/job_description_search) endpoint.
        Parameters:
        identifier - Job Description identifier.
        body - Search parameters.
        Returns:
        the response.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getJobDescriptionSearchConfigWithResponseAsync

        public reactor.core.publisher.Mono<com.azure.core.http.rest.Response<JobDescriptionSearchConfig>> getJobDescriptionSearchConfigWithResponseAsync()
        Return configurations such as which fields can be displayed in the logged in user's embeddable job description search tool, what are their weights, what is the maximum number of results that can be returned, etc.
        Returns:
        the response body along with Response on successful completion of Mono.
        Throws:
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getJobDescriptionSearchConfigAsync

        public reactor.core.publisher.Mono<JobDescriptionSearchConfig> getJobDescriptionSearchConfigAsync()
        Return configurations such as which fields can be displayed in the logged in user's embeddable job description search tool, what are their weights, what is the maximum number of results that can be returned, etc.
        Returns:
        the response body on successful completion of Mono.
        Throws:
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getJobDescriptionSearchConfig

        public JobDescriptionSearchConfig getJobDescriptionSearchConfig()
        Return configurations such as which fields can be displayed in the logged in user's embeddable job description search tool, what are their weights, what is the maximum number of results that can be returned, etc.
        Returns:
        the response.
        Throws:
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • updateJobDescriptionSearchConfigWithResponseAsync

        public reactor.core.publisher.Mono<com.azure.core.http.rest.Response<JobDescriptionSearchConfig>> updateJobDescriptionSearchConfigWithResponseAsync​(JobDescriptionSearchConfig body)
        Update configurations such as which fields can be displayed in the logged in user's embeddable job description search tool, what are their weights, what is the maximum number of results that can be returned, etc.
        Parameters:
        body - The body parameter.
        Returns:
        the response body along with Response on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • updateJobDescriptionSearchConfigAsync

        public reactor.core.publisher.Mono<JobDescriptionSearchConfig> updateJobDescriptionSearchConfigAsync​(JobDescriptionSearchConfig body)
        Update configurations such as which fields can be displayed in the logged in user's embeddable job description search tool, what are their weights, what is the maximum number of results that can be returned, etc.
        Parameters:
        body - The body parameter.
        Returns:
        the response body on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • updateJobDescriptionSearchConfig

        public JobDescriptionSearchConfig updateJobDescriptionSearchConfig​(JobDescriptionSearchConfig body)
        Update configurations such as which fields can be displayed in the logged in user's embeddable job description search tool, what are their weights, what is the maximum number of results that can be returned, etc.
        Parameters:
        body - The body parameter.
        Returns:
        the response.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • createJobDescriptionSearchEmbedUrlWithResponseAsync

        public reactor.core.publisher.Mono<com.azure.core.http.rest.Response<JobDescriptionSearchEmbed>> createJobDescriptionSearchEmbedUrlWithResponseAsync​(PathsM3DzbgV3JobDescriptionSearchEmbedPostRequestbodyContentApplicationJsonSchema body)
        Create and return a signed URL of the job description search tool which then can be embedded on a web page. An optional parameter `config_override` can be passed to override the user-level configurations of the embeddable search tool.
        Parameters:
        body - The body parameter.
        Returns:
        the response body along with Response on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getAllIndexesWithResponseAsync

        public reactor.core.publisher.Mono<com.azure.core.http.rest.Response<PathsDvrcp3V3IndexGetResponses200ContentApplicationJsonSchema>> getAllIndexesWithResponseAsync​(Integer offset,
                                                                                                                                                                            Integer limit,
                                                                                                                                                                            Enum19 documentType)
        Returns all the indexes.
        Parameters:
        offset - The number of documents to skip before starting to collect the result set.
        limit - The numbers of results to return.
        documentType - Filter indices by a document type.
        Returns:
        the response body along with Response on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • deleteIndexWithResponseAsync

        public reactor.core.publisher.Mono<com.azure.core.http.rest.Response<Void>> deleteIndexWithResponseAsync​(String name)
        Deletes the specified index from the database.
        Parameters:
        name - Index name.
        Returns:
        the Response on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • deleteIndexAsync

        public reactor.core.publisher.Mono<Void> deleteIndexAsync​(String name)
        Deletes the specified index from the database.
        Parameters:
        name - Index name.
        Returns:
        A Mono that completes when a successful response is received.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • deleteIndex

        public void deleteIndex​(String name)
        Deletes the specified index from the database.
        Parameters:
        name - Index name.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • deleteIndexDocumentWithResponseAsync

        public reactor.core.publisher.Mono<com.azure.core.http.rest.Response<Void>> deleteIndexDocumentWithResponseAsync​(String name,
                                                                                                                         String identifier)
        Delete the specified indexed document from the database.
        Parameters:
        name - Index name.
        identifier - Document identifier.
        Returns:
        the Response on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • deleteIndexDocumentAsync

        public reactor.core.publisher.Mono<Void> deleteIndexDocumentAsync​(String name,
                                                                          String identifier)
        Delete the specified indexed document from the database.
        Parameters:
        name - Index name.
        identifier - Document identifier.
        Returns:
        A Mono that completes when a successful response is received.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • deleteIndexDocument

        public void deleteIndexDocument​(String name,
                                        String identifier)
        Delete the specified indexed document from the database.
        Parameters:
        name - Index name.
        identifier - Document identifier.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • createResumeSearchWithResponseAsync

        public reactor.core.publisher.Mono<com.azure.core.http.rest.Response<ResumeSearch>> createResumeSearchWithResponseAsync​(ResumeSearchParameters body,
                                                                                                                                Integer offset,
                                                                                                                                Integer limit)
        Searches through parsed resumes. Users have 3 options to create a search:<br /><br /> 1. Match to a job description - a parsed job description is used to find candidates that suit it<br /> 2. Match to a resume - a parsed resume is used to find other candidates that have similar attributes<br /> 3. Search using custom criteria<br /><br /> Users should only populate 1 of jobDescription, resume or the custom criteria.
        Parameters:
        body - Search parameters.
        offset - The number of documents to skip before starting to collect the result set.
        limit - The numbers of results to return.
        Returns:
        the response body along with Response on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • createResumeSearchAsync

        public reactor.core.publisher.Mono<ResumeSearch> createResumeSearchAsync​(ResumeSearchParameters body,
                                                                                 Integer offset,
                                                                                 Integer limit)
        Searches through parsed resumes. Users have 3 options to create a search:<br /><br /> 1. Match to a job description - a parsed job description is used to find candidates that suit it<br /> 2. Match to a resume - a parsed resume is used to find other candidates that have similar attributes<br /> 3. Search using custom criteria<br /><br /> Users should only populate 1 of jobDescription, resume or the custom criteria.
        Parameters:
        body - Search parameters.
        offset - The number of documents to skip before starting to collect the result set.
        limit - The numbers of results to return.
        Returns:
        the response body on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • createResumeSearch

        public ResumeSearch createResumeSearch​(ResumeSearchParameters body,
                                               Integer offset,
                                               Integer limit)
        Searches through parsed resumes. Users have 3 options to create a search:<br /><br /> 1. Match to a job description - a parsed job description is used to find candidates that suit it<br /> 2. Match to a resume - a parsed resume is used to find other candidates that have similar attributes<br /> 3. Search using custom criteria<br /><br /> Users should only populate 1 of jobDescription, resume or the custom criteria.
        Parameters:
        body - Search parameters.
        offset - The number of documents to skip before starting to collect the result set.
        limit - The numbers of results to return.
        Returns:
        the response.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getResumeSearchDetailWithResponseAsync

        public reactor.core.publisher.Mono<com.azure.core.http.rest.Response<ResumeSearchDetail>> getResumeSearchDetailWithResponseAsync​(String identifier,
                                                                                                                                         ResumeSearchParameters body)
        This contains more detailed information about the matching score of the search criteria, or which search criteria is missing in this resume. The `identifier` is the unique ID returned via the [/resume_search](#post-/resume_search) endpoint.
        Parameters:
        identifier - Resume identifier.
        body - Search parameters.
        Returns:
        the response body along with Response on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getResumeSearchDetailAsync

        public reactor.core.publisher.Mono<ResumeSearchDetail> getResumeSearchDetailAsync​(String identifier,
                                                                                          ResumeSearchParameters body)
        This contains more detailed information about the matching score of the search criteria, or which search criteria is missing in this resume. The `identifier` is the unique ID returned via the [/resume_search](#post-/resume_search) endpoint.
        Parameters:
        identifier - Resume identifier.
        body - Search parameters.
        Returns:
        the response body on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getResumeSearchDetail

        public ResumeSearchDetail getResumeSearchDetail​(String identifier,
                                                        ResumeSearchParameters body)
        This contains more detailed information about the matching score of the search criteria, or which search criteria is missing in this resume. The `identifier` is the unique ID returned via the [/resume_search](#post-/resume_search) endpoint.
        Parameters:
        identifier - Resume identifier.
        body - Search parameters.
        Returns:
        the response.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getResumeSearchMatchWithResponseAsync

        public reactor.core.publisher.Mono<com.azure.core.http.rest.Response<ResumeSearchMatch>> getResumeSearchMatchWithResponseAsync​(String resume,
                                                                                                                                       String jobDescription,
                                                                                                                                       String index,
                                                                                                                                       String searchExpression,
                                                                                                                                       Float jobTitlesWeight,
                                                                                                                                       Float yearsExperienceWeight,
                                                                                                                                       Float locationsWeight,
                                                                                                                                       Float languagesWeight,
                                                                                                                                       Float skillsWeight,
                                                                                                                                       Float educationWeight,
                                                                                                                                       Float searchExpressionWeight,
                                                                                                                                       Float socCodesWeight,
                                                                                                                                       Float managementLevelWeight)
        Get the matching score between a resume and a job description. The score ranges between 0 and 1, with 0 being not a match at all, and 1 being perfect match.<br/> Note, this score will not directly match the score returned from POST [/resume_search/details/{identifier}](#post-/resume_search/details/-identifier-).
        Parameters:
        resume - Identify the resume to match.
        jobDescription - Identify the job description to match.
        index - Optionally, specify an index to search in. If not specified, will search in all indexes.
        searchExpression - Add keywords to the search criteria.
        jobTitlesWeight - How important is this criteria to the matching score, range from 0 to 1.
        yearsExperienceWeight - How important is this criteria to the matching score, range from 0 to 1.
        locationsWeight - How important is this criteria to the matching score, range from 0 to 1.
        languagesWeight - How important is this criteria to the matching score, range from 0 to 1.
        skillsWeight - How important is this criteria to the matching score, range from 0 to 1.
        educationWeight - How important is this criteria to the matching score, range from 0 to 1.
        searchExpressionWeight - How important is this criteria to the matching score, range from 0 to 1.
        socCodesWeight - How important is this criteria to the matching score, range from 0 to 1.
        managementLevelWeight - How important is this criteria to the matching score, range from 0 to 1.
        Returns:
        the matching score between a resume and a job description along with Response on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getResumeSearchMatchAsync

        public reactor.core.publisher.Mono<ResumeSearchMatch> getResumeSearchMatchAsync​(String resume,
                                                                                        String jobDescription,
                                                                                        String index,
                                                                                        String searchExpression,
                                                                                        Float jobTitlesWeight,
                                                                                        Float yearsExperienceWeight,
                                                                                        Float locationsWeight,
                                                                                        Float languagesWeight,
                                                                                        Float skillsWeight,
                                                                                        Float educationWeight,
                                                                                        Float searchExpressionWeight,
                                                                                        Float socCodesWeight,
                                                                                        Float managementLevelWeight)
        Get the matching score between a resume and a job description. The score ranges between 0 and 1, with 0 being not a match at all, and 1 being perfect match.<br/> Note, this score will not directly match the score returned from POST [/resume_search/details/{identifier}](#post-/resume_search/details/-identifier-).
        Parameters:
        resume - Identify the resume to match.
        jobDescription - Identify the job description to match.
        index - Optionally, specify an index to search in. If not specified, will search in all indexes.
        searchExpression - Add keywords to the search criteria.
        jobTitlesWeight - How important is this criteria to the matching score, range from 0 to 1.
        yearsExperienceWeight - How important is this criteria to the matching score, range from 0 to 1.
        locationsWeight - How important is this criteria to the matching score, range from 0 to 1.
        languagesWeight - How important is this criteria to the matching score, range from 0 to 1.
        skillsWeight - How important is this criteria to the matching score, range from 0 to 1.
        educationWeight - How important is this criteria to the matching score, range from 0 to 1.
        searchExpressionWeight - How important is this criteria to the matching score, range from 0 to 1.
        socCodesWeight - How important is this criteria to the matching score, range from 0 to 1.
        managementLevelWeight - How important is this criteria to the matching score, range from 0 to 1.
        Returns:
        the matching score between a resume and a job description on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getResumeSearchMatch

        public ResumeSearchMatch getResumeSearchMatch​(String resume,
                                                      String jobDescription,
                                                      String index,
                                                      String searchExpression,
                                                      Float jobTitlesWeight,
                                                      Float yearsExperienceWeight,
                                                      Float locationsWeight,
                                                      Float languagesWeight,
                                                      Float skillsWeight,
                                                      Float educationWeight,
                                                      Float searchExpressionWeight,
                                                      Float socCodesWeight,
                                                      Float managementLevelWeight)
        Get the matching score between a resume and a job description. The score ranges between 0 and 1, with 0 being not a match at all, and 1 being perfect match.<br/> Note, this score will not directly match the score returned from POST [/resume_search/details/{identifier}](#post-/resume_search/details/-identifier-).
        Parameters:
        resume - Identify the resume to match.
        jobDescription - Identify the job description to match.
        index - Optionally, specify an index to search in. If not specified, will search in all indexes.
        searchExpression - Add keywords to the search criteria.
        jobTitlesWeight - How important is this criteria to the matching score, range from 0 to 1.
        yearsExperienceWeight - How important is this criteria to the matching score, range from 0 to 1.
        locationsWeight - How important is this criteria to the matching score, range from 0 to 1.
        languagesWeight - How important is this criteria to the matching score, range from 0 to 1.
        skillsWeight - How important is this criteria to the matching score, range from 0 to 1.
        educationWeight - How important is this criteria to the matching score, range from 0 to 1.
        searchExpressionWeight - How important is this criteria to the matching score, range from 0 to 1.
        socCodesWeight - How important is this criteria to the matching score, range from 0 to 1.
        managementLevelWeight - How important is this criteria to the matching score, range from 0 to 1.
        Returns:
        the matching score between a resume and a job description.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getResumeSearchConfigWithResponseAsync

        public reactor.core.publisher.Mono<com.azure.core.http.rest.Response<ResumeSearchConfig>> getResumeSearchConfigWithResponseAsync()
        Return configurations such as which fields can be displayed in the logged in user's embeddable resume search tool, what are their weights, what is the maximum number of results that can be returned, etc.
        Returns:
        the response body along with Response on successful completion of Mono.
        Throws:
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getResumeSearchConfigAsync

        public reactor.core.publisher.Mono<ResumeSearchConfig> getResumeSearchConfigAsync()
        Return configurations such as which fields can be displayed in the logged in user's embeddable resume search tool, what are their weights, what is the maximum number of results that can be returned, etc.
        Returns:
        the response body on successful completion of Mono.
        Throws:
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getResumeSearchConfig

        public ResumeSearchConfig getResumeSearchConfig()
        Return configurations such as which fields can be displayed in the logged in user's embeddable resume search tool, what are their weights, what is the maximum number of results that can be returned, etc.
        Returns:
        the response.
        Throws:
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • updateResumeSearchConfigWithResponseAsync

        public reactor.core.publisher.Mono<com.azure.core.http.rest.Response<ResumeSearchConfig>> updateResumeSearchConfigWithResponseAsync​(ResumeSearchConfig body)
        Update configurations such as which fields can be displayed in the logged in user's embeddable resume search tool, what are their weights, what is the maximum number of results that can be returned, etc.
        Parameters:
        body - The body parameter.
        Returns:
        the response body along with Response on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • updateResumeSearchConfigAsync

        public reactor.core.publisher.Mono<ResumeSearchConfig> updateResumeSearchConfigAsync​(ResumeSearchConfig body)
        Update configurations such as which fields can be displayed in the logged in user's embeddable resume search tool, what are their weights, what is the maximum number of results that can be returned, etc.
        Parameters:
        body - The body parameter.
        Returns:
        the response body on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • updateResumeSearchConfig

        public ResumeSearchConfig updateResumeSearchConfig​(ResumeSearchConfig body)
        Update configurations such as which fields can be displayed in the logged in user's embeddable resume search tool, what are their weights, what is the maximum number of results that can be returned, etc.
        Parameters:
        body - The body parameter.
        Returns:
        the response.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • createResumeSearchEmbedUrlWithResponseAsync

        public reactor.core.publisher.Mono<com.azure.core.http.rest.Response<ResumeSearchEmbed>> createResumeSearchEmbedUrlWithResponseAsync​(Paths1Czpnk1V3ResumeSearchEmbedPostRequestbodyContentApplicationJsonSchema body)
        Create and return a signed URL of the resume search tool which then can be embedded on a web page. An optional parameter `config_override` can be passed to override the user-level configurations of the embeddable resume search tool.
        Parameters:
        body - The body parameter.
        Returns:
        the response body along with Response on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getResumeSearchSuggestionJobTitleWithResponseAsync

        public reactor.core.publisher.Mono<com.azure.core.http.rest.Response<List<String>>> getResumeSearchSuggestionJobTitleWithResponseAsync​(List<String> jobTitles)
        Provided one or more job titles, get related suggestions for your search.
        Parameters:
        jobTitles - Job title to query suggestions for.
        Returns:
        array of Get200ApplicationJsonItemsItem along with Response on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getResumeSearchSuggestionJobTitleAsync

        public reactor.core.publisher.Mono<List<String>> getResumeSearchSuggestionJobTitleAsync​(List<String> jobTitles)
        Provided one or more job titles, get related suggestions for your search.
        Parameters:
        jobTitles - Job title to query suggestions for.
        Returns:
        array of Get200ApplicationJsonItemsItem on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getResumeSearchSuggestionJobTitle

        public List<String> getResumeSearchSuggestionJobTitle​(List<String> jobTitles)
        Provided one or more job titles, get related suggestions for your search.
        Parameters:
        jobTitles - Job title to query suggestions for.
        Returns:
        array of Get200ApplicationJsonItemsItem.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getResumeSearchSuggestionSkillWithResponseAsync

        public reactor.core.publisher.Mono<com.azure.core.http.rest.Response<List<String>>> getResumeSearchSuggestionSkillWithResponseAsync​(List<String> skills)
        Provided one or more skills, get related suggestions for your search.
        Parameters:
        skills - Skill to query suggestions for.
        Returns:
        array of String along with Response on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getResumeSearchSuggestionSkillAsync

        public reactor.core.publisher.Mono<List<String>> getResumeSearchSuggestionSkillAsync​(List<String> skills)
        Provided one or more skills, get related suggestions for your search.
        Parameters:
        skills - Skill to query suggestions for.
        Returns:
        array of String on successful completion of Mono.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getResumeSearchSuggestionSkill

        public List<String> getResumeSearchSuggestionSkill​(List<String> skills)
        Provided one or more skills, get related suggestions for your search.
        Parameters:
        skills - Skill to query suggestions for.
        Returns:
        array of String.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        RequestErrorException - thrown if the request is rejected by server.
        RequestErrorException - thrown if the request is rejected by server on status code 400, 401.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.