Package com.legislate.api

Class CollaboratorApi

  • public class CollaboratorApi
extends Object

    • Constructor Detail

      • CollaboratorApi

        public CollaboratorApi()

      • CollaboratorApi

        public CollaboratorApi​(ApiClient apiClient)

    • Method Detail

      • getApiClient

        public ApiClient getApiClient()

      • setApiClient

        public void setApiClient​(ApiClient apiClient)

      • deleteCollaboratorUsingDELETECall

        public com.squareup.okhttp.Call deleteCollaboratorUsingDELETECall​(Long collaboratorId,
                                                                  ProgressResponseBody.ProgressListener progressListener,
                                                                  ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                           throws ApiException
        Build call for deleteCollaboratorUsingDELETE
        Parameters:
        collaboratorId - The unique Id of the contract collaborator you'd like to delete. (required)
        progressListener - Progress listener
        progressRequestListener - Progress request listener
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • deleteCollaboratorUsingDELETE

        public void deleteCollaboratorUsingDELETE​(Long collaboratorId)
                                   throws ApiException
        Delete a Collaborator by its id. This operation will delete a Collaborator by its id.
        Parameters:
        collaboratorId - The unique Id of the contract collaborator you'd like to delete. (required)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • deleteCollaboratorUsingDELETEWithHttpInfo

        public ApiResponse<Void> deleteCollaboratorUsingDELETEWithHttpInfo​(Long collaboratorId)
                                                            throws ApiException
        Delete a Collaborator by its id. This operation will delete a Collaborator by its id.
        Parameters:
        collaboratorId - The unique Id of the contract collaborator you'd like to delete. (required)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • deleteCollaboratorUsingDELETEAsync

        public com.squareup.okhttp.Call deleteCollaboratorUsingDELETEAsync​(Long collaboratorId,
                                                                   ApiCallback<Void> callback)
                                                            throws ApiException
        Delete a Collaborator by its id. (asynchronously) This operation will delete a Collaborator by its id.
        Parameters:
        collaboratorId - The unique Id of the contract collaborator you'd like to delete. (required)
        callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object

      • getCollaboratorIdentityFieldsUsingGETCall

        public com.squareup.okhttp.Call getCollaboratorIdentityFieldsUsingGETCall​(Long idTemplate,
                                                                          List<String> roles,
                                                                          String side,
                                                                          ProgressResponseBody.ProgressListener progressListener,
                                                                          ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                                   throws ApiException
        Build call for getCollaboratorIdentityFieldsUsingGET
        Parameters:
        idTemplate - The unique Id of the template of the contract which is associated with the collaborator. (required)
        roles - The role of the contract collaborator. (required)
        side - The sde of the contract collaborator. (required)
        progressListener - Progress listener
        progressRequestListener - Progress request listener
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • getCollaboratorIdentityFieldsUsingGET

        public List<IdentityFieldsCollaboratorRoleDTO> getCollaboratorIdentityFieldsUsingGET​(Long idTemplate,
                                                                                     List<String> roles,
                                                                                     String side)
                                                                              throws ApiException
        Get Identity fields This operation will retrieve the fields need to be filled due to a side and a list of roles.
        Parameters:
        idTemplate - The unique Id of the template of the contract which is associated with the collaborator. (required)
        roles - The role of the contract collaborator. (required)
        side - The sde of the contract collaborator. (required)
        Returns:
        List<IdentityFieldsCollaboratorRoleDTO>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getCollaboratorIdentityFieldsUsingGETWithHttpInfo

        public ApiResponse<List<IdentityFieldsCollaboratorRoleDTO>> getCollaboratorIdentityFieldsUsingGETWithHttpInfo​(Long idTemplate,
                                                                                                              List<String> roles,
                                                                                                              String side)
                                                                                                       throws ApiException
        Get Identity fields This operation will retrieve the fields need to be filled due to a side and a list of roles.
        Parameters:
        idTemplate - The unique Id of the template of the contract which is associated with the collaborator. (required)
        roles - The role of the contract collaborator. (required)
        side - The sde of the contract collaborator. (required)
        Returns:
        ApiResponse<List<IdentityFieldsCollaboratorRoleDTO>>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getCollaboratorIdentityFieldsUsingGETAsync

        public com.squareup.okhttp.Call getCollaboratorIdentityFieldsUsingGETAsync​(Long idTemplate,
                                                                           List<String> roles,
                                                                           String side,
                                                                           ApiCallback<List<IdentityFieldsCollaboratorRoleDTO>> callback)
                                                                    throws ApiException
        Get Identity fields (asynchronously) This operation will retrieve the fields need to be filled due to a side and a list of roles.
        Parameters:
        idTemplate - The unique Id of the template of the contract which is associated with the collaborator. (required)
        roles - The role of the contract collaborator. (required)
        side - The sde of the contract collaborator. (required)
        callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object

      • getCollaboratorUsingGETCall

        public com.squareup.okhttp.Call getCollaboratorUsingGETCall​(Long collaboratorId,
                                                            ProgressResponseBody.ProgressListener progressListener,
                                                            ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                     throws ApiException
        Build call for getCollaboratorUsingGET
        Parameters:
        collaboratorId - The unique Id of the contract collaborator you'd like to look up. (required)
        progressListener - Progress listener
        progressRequestListener - Progress request listener
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • getCollaboratorUsingGET

        public ContractCollaboratorResponseDTO getCollaboratorUsingGET​(Long collaboratorId)
                                                        throws ApiException
        Get contract collaborator details
        Parameters:
        collaboratorId - The unique Id of the contract collaborator you'd like to look up. (required)
        Returns:
        ContractCollaboratorResponseDTO
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getCollaboratorUsingGETWithHttpInfo

        public ApiResponse<ContractCollaboratorResponseDTO> getCollaboratorUsingGETWithHttpInfo​(Long collaboratorId)
                                                                                 throws ApiException
        Get contract collaborator details
        Parameters:
        collaboratorId - The unique Id of the contract collaborator you'd like to look up. (required)
        Returns:
        ApiResponse<ContractCollaboratorResponseDTO>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getCollaboratorUsingGETAsync

        public com.squareup.okhttp.Call getCollaboratorUsingGETAsync​(Long collaboratorId,
                                                             ApiCallback<ContractCollaboratorResponseDTO> callback)
                                                      throws ApiException
        Get contract collaborator details (asynchronously)
        Parameters:
        collaboratorId - The unique Id of the contract collaborator you'd like to look up. (required)
        callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object

      • getCollaboratorsUsingGETCall

        public com.squareup.okhttp.Call getCollaboratorsUsingGETCall​(Long contractId,
                                                             ProgressResponseBody.ProgressListener progressListener,
                                                             ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                      throws ApiException
        Build call for getCollaboratorsUsingGET
        Parameters:
        contractId - The unique Id of the contract associated with the collaborator you'd like to look up. (required)
        progressListener - Progress listener
        progressRequestListener - Progress request listener
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • getCollaboratorsUsingGET

        public List<ContractCollaboratorResponseDTO> getCollaboratorsUsingGET​(Long contractId)
                                                               throws ApiException
        Get collaborators for a given contract
        Parameters:
        contractId - The unique Id of the contract associated with the collaborator you'd like to look up. (required)
        Returns:
        List<ContractCollaboratorResponseDTO>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getCollaboratorsUsingGETWithHttpInfo

        public ApiResponse<List<ContractCollaboratorResponseDTO>> getCollaboratorsUsingGETWithHttpInfo​(Long contractId)
                                                                                        throws ApiException
        Get collaborators for a given contract
        Parameters:
        contractId - The unique Id of the contract associated with the collaborator you'd like to look up. (required)
        Returns:
        ApiResponse<List<ContractCollaboratorResponseDTO>>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getCollaboratorsUsingGETAsync

        public com.squareup.okhttp.Call getCollaboratorsUsingGETAsync​(Long contractId,
                                                              ApiCallback<List<ContractCollaboratorResponseDTO>> callback)
                                                       throws ApiException
        Get collaborators for a given contract (asynchronously)
        Parameters:
        contractId - The unique Id of the contract associated with the collaborator you'd like to look up. (required)
        callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object

      • postCollaboratorUsingPOSTCall

        public com.squareup.okhttp.Call postCollaboratorUsingPOSTCall​(CollaboratorFieldsRequestDTO body,
                                                              Long contractId,
                                                              ProgressResponseBody.ProgressListener progressListener,
                                                              ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                       throws ApiException
        Build call for postCollaboratorUsingPOST
        Parameters:
        body - createCollaboratorRequestDTO (required)
        contractId - The unique Id of the contract associated with the collaborator you'd like to look up. (required)
        progressListener - Progress listener
        progressRequestListener - Progress request listener
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • postCollaboratorUsingPOST

        public Link postCollaboratorUsingPOST​(CollaboratorFieldsRequestDTO body,
                                      Long contractId)
                               throws ApiException
        Create a collaborator given a contract This operation will create a collaborator associated to the contract given
        Parameters:
        body - createCollaboratorRequestDTO (required)
        contractId - The unique Id of the contract associated with the collaborator you'd like to look up. (required)
        Returns:
        Link
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • postCollaboratorUsingPOSTWithHttpInfo

        public ApiResponse<Link> postCollaboratorUsingPOSTWithHttpInfo​(CollaboratorFieldsRequestDTO body,
                                                               Long contractId)
                                                        throws ApiException
        Create a collaborator given a contract This operation will create a collaborator associated to the contract given
        Parameters:
        body - createCollaboratorRequestDTO (required)
        contractId - The unique Id of the contract associated with the collaborator you'd like to look up. (required)
        Returns:
        ApiResponse<Link>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • postCollaboratorUsingPOSTAsync

        public com.squareup.okhttp.Call postCollaboratorUsingPOSTAsync​(CollaboratorFieldsRequestDTO body,
                                                               Long contractId,
                                                               ApiCallback<Link> callback)
                                                        throws ApiException
        Create a collaborator given a contract (asynchronously) This operation will create a collaborator associated to the contract given
        Parameters:
        body - createCollaboratorRequestDTO (required)
        contractId - The unique Id of the contract associated with the collaborator you'd like to look up. (required)
        callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object

      • postCompanyUsingPOST

        public CompanyCreatedResponseDTO postCompanyUsingPOST​(CompanyFieldsDTO body,
                                                      Long contractId)
                                               throws ApiException
        Create a company given a contract This operation will create a company associated to the contract given
        Parameters:
        body - companyFieldsDTORequest (required)
        contractId - The unique Id of the contract configuration. (required)
        Returns:
        CompanyCreatedResponseDTO
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • postCompanyUsingPOSTWithHttpInfo

        public ApiResponse<CompanyCreatedResponseDTO> postCompanyUsingPOSTWithHttpInfo​(CompanyFieldsDTO body,
                                                                               Long contractId)
                                                                        throws ApiException
        Create a company given a contract This operation will create a company associated to the contract given
        Parameters:
        body - companyFieldsDTORequest (required)
        contractId - The unique Id of the contract configuration. (required)
        Returns:
        ApiResponse<CompanyCreatedResponseDTO>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • postCompanyUsingPOSTAsync

        public com.squareup.okhttp.Call postCompanyUsingPOSTAsync​(CompanyFieldsDTO body,
                                                          Long contractId,
                                                          ApiCallback<CompanyCreatedResponseDTO> callback)
                                                   throws ApiException
        Create a company given a contract (asynchronously) This operation will create a company associated to the contract given
        Parameters:
        body - companyFieldsDTORequest (required)
        contractId - The unique Id of the contract configuration. (required)
        callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object

      • updateCollaboratorBinaryFileSignatureUsingPATCHCall

        public com.squareup.okhttp.Call updateCollaboratorBinaryFileSignatureUsingPATCHCall​(Long collaboratorId,
                                                                                    ProgressResponseBody.ProgressListener progressListener,
                                                                                    ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                                             throws ApiException
        Build call for updateCollaboratorBinaryFileSignatureUsingPATCH
        Parameters:
        collaboratorId - The unique Id of the contract collaborator who is signing. (required)
        progressListener - Progress listener
        progressRequestListener - Progress request listener
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • updateCollaboratorBinaryFileSignatureUsingPATCH

        public ContractCollaboratorResponseDTO updateCollaboratorBinaryFileSignatureUsingPATCH​(Long collaboratorId)
                                                                                throws ApiException
        Upload a signature to a collaborator This operation will sign a contract.
        Parameters:
        collaboratorId - The unique Id of the contract collaborator who is signing. (required)
        Returns:
        ContractCollaboratorResponseDTO
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • updateCollaboratorBinaryFileSignatureUsingPATCHWithHttpInfo

        public ApiResponse<ContractCollaboratorResponseDTO> updateCollaboratorBinaryFileSignatureUsingPATCHWithHttpInfo​(Long collaboratorId)
                                                                                                         throws ApiException
        Upload a signature to a collaborator This operation will sign a contract.
        Parameters:
        collaboratorId - The unique Id of the contract collaborator who is signing. (required)
        Returns:
        ApiResponse<ContractCollaboratorResponseDTO>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • updateCollaboratorBinaryFileSignatureUsingPATCHAsync

        public com.squareup.okhttp.Call updateCollaboratorBinaryFileSignatureUsingPATCHAsync​(Long collaboratorId,
                                                                                     ApiCallback<ContractCollaboratorResponseDTO> callback)
                                                                              throws ApiException
        Upload a signature to a collaborator (asynchronously) This operation will sign a contract.
        Parameters:
        collaboratorId - The unique Id of the contract collaborator who is signing. (required)
        callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object

      • updateCollaboratorFieldsUsingPATCH

        public ContractCollaboratorResponseDTO updateCollaboratorFieldsUsingPATCH​(UpdateCollaboratorIdentityFieldsRequestDTO body,
                                                                          Long collaboratorId)
                                                                   throws ApiException
        Update collaborator fields This operation will update a collaborator details.
        Parameters:
        body - fields (required)
        collaboratorId - The unique Id of the contract collaborator you'd like to update. (required)
        Returns:
        ContractCollaboratorResponseDTO
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • updateCollaboratorFieldsUsingPATCHWithHttpInfo

        public ApiResponse<ContractCollaboratorResponseDTO> updateCollaboratorFieldsUsingPATCHWithHttpInfo​(UpdateCollaboratorIdentityFieldsRequestDTO body,
                                                                                                   Long collaboratorId)
                                                                                            throws ApiException
        Update collaborator fields This operation will update a collaborator details.
        Parameters:
        body - fields (required)
        collaboratorId - The unique Id of the contract collaborator you'd like to update. (required)
        Returns:
        ApiResponse<ContractCollaboratorResponseDTO>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • updateCollaboratorFieldsUsingPATCHAsync

        public com.squareup.okhttp.Call updateCollaboratorFieldsUsingPATCHAsync​(UpdateCollaboratorIdentityFieldsRequestDTO body,
                                                                        Long collaboratorId,
                                                                        ApiCallback<ContractCollaboratorResponseDTO> callback)
                                                                 throws ApiException
        Update collaborator fields (asynchronously) This operation will update a collaborator details.
        Parameters:
        body - fields (required)
        collaboratorId - The unique Id of the contract collaborator you'd like to update. (required)
        callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object

      • updateCollaboratorRolesUsingPATCH

        public ContractCollaboratorResponseDTO updateCollaboratorRolesUsingPATCH​(UpdateFieldsCollaboratorDTO body,
                                                                         Long collaboratorId)
                                                                  throws ApiException
        Update collaborator role This operation will update a collaborator fields.
        Parameters:
        body - fields (required)
        collaboratorId - The unique Id of the contract collaborator who is signing. (required)
        Returns:
        ContractCollaboratorResponseDTO
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • updateCollaboratorRolesUsingPATCHWithHttpInfo

        public ApiResponse<ContractCollaboratorResponseDTO> updateCollaboratorRolesUsingPATCHWithHttpInfo​(UpdateFieldsCollaboratorDTO body,
                                                                                                  Long collaboratorId)
                                                                                           throws ApiException
        Update collaborator role This operation will update a collaborator fields.
        Parameters:
        body - fields (required)
        collaboratorId - The unique Id of the contract collaborator who is signing. (required)
        Returns:
        ApiResponse<ContractCollaboratorResponseDTO>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • updateCollaboratorRolesUsingPATCHAsync

        public com.squareup.okhttp.Call updateCollaboratorRolesUsingPATCHAsync​(UpdateFieldsCollaboratorDTO body,
                                                                       Long collaboratorId,
                                                                       ApiCallback<ContractCollaboratorResponseDTO> callback)
                                                                throws ApiException
        Update collaborator role (asynchronously) This operation will update a collaborator fields.
        Parameters:
        body - fields (required)
        collaboratorId - The unique Id of the contract collaborator who is signing. (required)
        callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object

      • updateCollaboratorSignatureUsingPATCHCall

        public com.squareup.okhttp.Call updateCollaboratorSignatureUsingPATCHCall​(Long collaboratorId,
                                                                          ProgressResponseBody.ProgressListener progressListener,
                                                                          ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                                   throws ApiException
        Build call for updateCollaboratorSignatureUsingPATCH
        Parameters:
        collaboratorId - The unique Id of the contract collaborator who is signing. (required)
        progressListener - Progress listener
        progressRequestListener - Progress request listener
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • updateCollaboratorSignatureUsingPATCH

        public ContractCollaboratorResponseDTO updateCollaboratorSignatureUsingPATCH​(Long collaboratorId)
                                                                      throws ApiException
        Upload a signature to a collaborator This operation will sign a contract.
        Parameters:
        collaboratorId - The unique Id of the contract collaborator who is signing. (required)
        Returns:
        ContractCollaboratorResponseDTO
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • updateCollaboratorSignatureUsingPATCHWithHttpInfo

        public ApiResponse<ContractCollaboratorResponseDTO> updateCollaboratorSignatureUsingPATCHWithHttpInfo​(Long collaboratorId)
                                                                                               throws ApiException
        Upload a signature to a collaborator This operation will sign a contract.
        Parameters:
        collaboratorId - The unique Id of the contract collaborator who is signing. (required)
        Returns:
        ApiResponse<ContractCollaboratorResponseDTO>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • updateCollaboratorSignatureUsingPATCHAsync

        public com.squareup.okhttp.Call updateCollaboratorSignatureUsingPATCHAsync​(Long collaboratorId,
                                                                           ApiCallback<ContractCollaboratorResponseDTO> callback)
                                                                    throws ApiException
        Upload a signature to a collaborator (asynchronously) This operation will sign a contract.
        Parameters:
        collaboratorId - The unique Id of the contract collaborator who is signing. (required)
        callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object