Package com.legislate.api

Class ContractApi

  • public class ContractApi
extends Object

    • Constructor Detail

      • ContractApi

        public ContractApi()

      • ContractApi

        public ContractApi​(ApiClient apiClient)

    • Method Detail

      • getApiClient

        public ApiClient getApiClient()

      • setApiClient

        public void setApiClient​(ApiClient apiClient)

      • deleteContractUsingDELETECall

        public com.squareup.okhttp.Call deleteContractUsingDELETECall​(Long contractId,
                                                              ProgressResponseBody.ProgressListener progressListener,
                                                              ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                       throws ApiException
        Build call for deleteContractUsingDELETE
        Parameters:
        contractId - The unique Id of the contract 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

      • deleteContractUsingDELETE

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

      • deleteContractUsingDELETEWithHttpInfo

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

      • deleteContractUsingDELETEAsync

        public com.squareup.okhttp.Call deleteContractUsingDELETEAsync​(Long contractId,
                                                               ApiCallback<CollaboratorResponseDTO> callback)
                                                        throws ApiException
        Deletes a contract by its id. (asynchronously) This operation will delete a contract by its id.
        Parameters:
        contractId - The unique Id of the contract 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

      • getContractFileUsingGETCall

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

      • getContractFileUsingGET

        public byte[] getContractFileUsingGET​(Long contractId)
                               throws ApiException
        Get contract pdf Generate the pdf of a contract
        Parameters:
        contractId - The unique Id of the contract you'd like to generate a pdf for. (required)
        Returns:
        byte[]
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getContractFileUsingGETWithHttpInfo

        public ApiResponse<byte[]> getContractFileUsingGETWithHttpInfo​(Long contractId)
                                                        throws ApiException
        Get contract pdf Generate the pdf of a contract
        Parameters:
        contractId - The unique Id of the contract you'd like to generate a pdf for. (required)
        Returns:
        ApiResponse<byte[]>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getContractFileUsingGETAsync

        public com.squareup.okhttp.Call getContractFileUsingGETAsync​(Long contractId,
                                                             ApiCallback<byte[]> callback)
                                                      throws ApiException
        Get contract pdf (asynchronously) Generate the pdf of a contract
        Parameters:
        contractId - The unique Id of the contract you'd like to generate a pdf for. (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

      • getContractHtmlUsingGETCall

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

      • getContractHtmlUsingGET

        public String getContractHtmlUsingGET​(Long contractId)
                               throws ApiException
        Get contract html Generate the html of a contract
        Parameters:
        contractId - The unique Id of the contract you'd like to generate a html for. (required)
        Returns:
        String
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getContractHtmlUsingGETWithHttpInfo

        public ApiResponse<String> getContractHtmlUsingGETWithHttpInfo​(Long contractId)
                                                        throws ApiException
        Get contract html Generate the html of a contract
        Parameters:
        contractId - The unique Id of the contract you'd like to generate a html for. (required)
        Returns:
        ApiResponse<String>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getContractHtmlUsingGETAsync

        public com.squareup.okhttp.Call getContractHtmlUsingGETAsync​(Long contractId,
                                                             ApiCallback<String> callback)
                                                      throws ApiException
        Get contract html (asynchronously) Generate the html of a contract
        Parameters:
        contractId - The unique Id of the contract you'd like to generate a html for. (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

      • getContractUsingGETCall

        public com.squareup.okhttp.Call getContractUsingGETCall​(Long contractId,
                                                        ProgressResponseBody.ProgressListener progressListener,
                                                        ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                 throws ApiException
        Build call for getContractUsingGET
        Parameters:
        contractId - The unique Id of the contract configuration 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

      • getContractUsingGET

        public ContractResponseDTO getContractUsingGET​(Long contractId)
                                        throws ApiException
        Get contract details. This operation will retrieve details about a given contract.
        Parameters:
        contractId - The unique Id of the contract configuration you'd like to look up. (required)
        Returns:
        ContractResponseDTO
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getContractUsingGETWithHttpInfo

        public ApiResponse<ContractResponseDTO> getContractUsingGETWithHttpInfo​(Long contractId)
                                                                 throws ApiException
        Get contract details. This operation will retrieve details about a given contract.
        Parameters:
        contractId - The unique Id of the contract configuration you'd like to look up. (required)
        Returns:
        ApiResponse<ContractResponseDTO>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getContractUsingGETAsync

        public com.squareup.okhttp.Call getContractUsingGETAsync​(Long contractId,
                                                         ApiCallback<ContractResponseDTO> callback)
                                                  throws ApiException
        Get contract details. (asynchronously) This operation will retrieve details about a given contract.
        Parameters:
        contractId - The unique Id of the contract configuration 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

      • getContractsUsingGETCall

        public com.squareup.okhttp.Call getContractsUsingGETCall​(Long teamId,
                                                         ProgressResponseBody.ProgressListener progressListener,
                                                         ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                  throws ApiException
        Build call for getContractsUsingGET
        Parameters:
        teamId - The unique Id of the team you'd like to search the contracts. (required)
        progressListener - Progress listener
        progressRequestListener - Progress request listener
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • getContractsUsingGET

        public List<ContractResponseDTO> getContractsUsingGET​(Long teamId)
                                               throws ApiException
        Get contracts in a team Fetch all the contracts which are part of a team
        Parameters:
        teamId - The unique Id of the team you'd like to search the contracts. (required)
        Returns:
        List<ContractResponseDTO>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getContractsUsingGETWithHttpInfo

        public ApiResponse<List<ContractResponseDTO>> getContractsUsingGETWithHttpInfo​(Long teamId)
                                                                        throws ApiException
        Get contracts in a team Fetch all the contracts which are part of a team
        Parameters:
        teamId - The unique Id of the team you'd like to search the contracts. (required)
        Returns:
        ApiResponse<List<ContractResponseDTO>>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getContractsUsingGETAsync

        public com.squareup.okhttp.Call getContractsUsingGETAsync​(Long teamId,
                                                          ApiCallback<List<ContractResponseDTO>> callback)
                                                   throws ApiException
        Get contracts in a team (asynchronously) Fetch all the contracts which are part of a team
        Parameters:
        teamId - The unique Id of the team you'd like to search the contracts. (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

      • postContractUsingPOST

        public Link postContractUsingPOST​(CreateContractRequestDTO body,
                                  Long teamId)
                           throws ApiException
        Create a contract with an auto-generated bundle. This operation will create a contract inside an automatically generated bundle.
        Parameters:
        body - createContractRequest (required)
        teamId - The unique Id of the team where the contract will be located. (required)
        Returns:
        Link
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • postContractUsingPOSTWithHttpInfo

        public ApiResponse<Link> postContractUsingPOSTWithHttpInfo​(CreateContractRequestDTO body,
                                                           Long teamId)
                                                    throws ApiException
        Create a contract with an auto-generated bundle. This operation will create a contract inside an automatically generated bundle.
        Parameters:
        body - createContractRequest (required)
        teamId - The unique Id of the team where the contract will be located. (required)
        Returns:
        ApiResponse<Link>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • postContractUsingPOSTAsync

        public com.squareup.okhttp.Call postContractUsingPOSTAsync​(CreateContractRequestDTO body,
                                                           Long teamId,
                                                           ApiCallback<Link> callback)
                                                    throws ApiException
        Create a contract with an auto-generated bundle. (asynchronously) This operation will create a contract inside an automatically generated bundle.
        Parameters:
        body - createContractRequest (required)
        teamId - The unique Id of the team where the contract will be located. (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

      • updateContractUsingPATCH

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

      • updateContractUsingPATCHWithHttpInfo

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

      • updateContractUsingPATCHAsync

        public com.squareup.okhttp.Call updateContractUsingPATCHAsync​(UpdateContractRequestDTO body,
                                                              Long contractId,
                                                              ApiCallback<ContractResponseDTO> callback)
                                                       throws ApiException
        Updates a contract. (asynchronously) This operation will update a contract details.
        Parameters:
        body - fields (required)
        contractId - The unique Id of the contract 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