Package com.docusign.esign.api

Class NotaryApi

  • public class NotaryApi
extends Object
    NotaryApi class.

    • Constructor Detail

      • NotaryApi

        public NotaryApi()
        NotaryApi.

      • NotaryApi

        public NotaryApi​(ApiClient apiClient)
        NotaryApi.

    • Method Detail

      • getApiClient

        public ApiClient getApiClient()
        getApiClient Method.
        Returns:
        ApiClient

      • setApiClient

        public void setApiClient​(ApiClient apiClient)
        setApiClient Method.

      • createNotary

        public Notary createNotary​(Notary notary)
                    throws ApiException
        Add a notary to the system. Registers the current user as a notary.
        Parameters:
        notary - (optional)
        Returns:
        Notary
        Throws:
        ApiException - if fails to make API call

      • createNotaryWithHttpInfo

        public ApiResponse<Notary> createNotaryWithHttpInfo​(Notary notary)
                                             throws ApiException
        Add a notary to the system Registers the current user as a notary.
        Parameters:
        notary - (optional)
        Returns:
        Notary
        Throws:
        ApiException - if fails to make API call

      • createNotaryJurisdictions

        public NotaryJurisdiction createNotaryJurisdictions​(NotaryJurisdiction notaryJurisdiction)
                                             throws ApiException
        Add a notary jurisdiction to the system. Creates a jurisdiction object.
        Parameters:
        notaryJurisdiction - (optional)
        Returns:
        NotaryJurisdiction
        Throws:
        ApiException - if fails to make API call

      • createNotaryJurisdictionsWithHttpInfo

        public ApiResponse<NotaryJurisdiction> createNotaryJurisdictionsWithHttpInfo​(NotaryJurisdiction notaryJurisdiction)
                                                                      throws ApiException
        Add a notary jurisdiction to the system Creates a jurisdiction object.
        Parameters:
        notaryJurisdiction - (optional)
        Returns:
        NotaryJurisdiction
        Throws:
        ApiException - if fails to make API call

      • deleteNotaryJurisdiction

        public void deleteNotaryJurisdiction​(String jurisdictionId)
                              throws ApiException
        Delete a notary jurisdiction a specified user.. Deletes the specified jurisdiction.
        Parameters:
        jurisdictionId - (required)
        Throws:
        ApiException - if fails to make API call

      • deleteNotaryJurisdictionWithHttpInfo

        public ApiResponse<Object> deleteNotaryJurisdictionWithHttpInfo​(String jurisdictionId)
                                                         throws ApiException
        Delete a notary jurisdiction a specified user. Deletes the specified jurisdiction.
        Parameters:
        jurisdictionId - (required)
        Throws:
        ApiException - if fails to make API call

      • getNotary

        public NotaryResult getNotary()
                       throws ApiException
        Get notary settings for a user. Gets settings for a notary user. The current user must be a notary.
        Returns:
        NotaryResult
        Throws:
        ApiException

      • getNotary

        public NotaryResult getNotary​(NotaryApi.GetNotaryOptions options)
                       throws ApiException
        Get notary settings for a user. Gets settings for a notary user. The current user must be a notary.
        Parameters:
        options - for modifying the method behavior.
        Returns:
        NotaryResult
        Throws:
        ApiException - if fails to make API call

      • getNotaryWithHttpInfo

        public ApiResponse<NotaryResult> getNotaryWithHttpInfo​(NotaryApi.GetNotaryOptions options)
                                                throws ApiException
        Get notary settings for a user Gets settings for a notary user. The current user must be a notary.
        Parameters:
        options - for modifying the method behavior.
        Returns:
        NotaryResult
        Throws:
        ApiException - if fails to make API call

      • getNotaryJurisdiction

        public NotaryJurisdiction getNotaryJurisdiction​(String jurisdictionId)
                                         throws ApiException
        Get notary a jurisdiction for a user. Gets a jurisdiction object for the current user. The following restrictions apply: - The current user must be a notary. - The `jurisdictionId` must be a jurisdiction that the notary is registered for.
        Parameters:
        jurisdictionId - (required)
        Returns:
        NotaryJurisdiction
        Throws:
        ApiException - if fails to make API call

      • getNotaryJurisdictionWithHttpInfo

        public ApiResponse<NotaryJurisdiction> getNotaryJurisdictionWithHttpInfo​(String jurisdictionId)
                                                                  throws ApiException
        Get notary a jurisdiction for a user Gets a jurisdiction object for the current user. The following restrictions apply: - The current user must be a notary. - The `jurisdictionId` must be a jurisdiction that the notary is registered for.
        Parameters:
        jurisdictionId - (required)
        Returns:
        NotaryJurisdiction
        Throws:
        ApiException - if fails to make API call

      • getNotaryJurisdictionSeal

        public void getNotaryJurisdictionSeal​(String jurisdictionId)
                               throws ApiException
        Get notary seal for a jurisdiction.
        Parameters:
        jurisdictionId - (required)
        Throws:
        ApiException - if fails to make API call

      • getNotaryJurisdictionSealWithHttpInfo

        public ApiResponse<Object> getNotaryJurisdictionSealWithHttpInfo​(String jurisdictionId)
                                                          throws ApiException
        Get notary seal for a jurisdiction
        Parameters:
        jurisdictionId - (required)
        Throws:
        ApiException - if fails to make API call

      • getNotaryJurisdictions

        public NotaryJurisdictionList getNotaryJurisdictions()
                                              throws ApiException
        Get notary jurisdictions for a user. Returns a list of jurisdictions that the notary is registered in. The current user must be a notary.
        Returns:
        NotaryJurisdictionList
        Throws:
        ApiException - if fails to make API call

      • getNotaryJurisdictionsWithHttpInfo

        public ApiResponse<NotaryJurisdictionList> getNotaryJurisdictionsWithHttpInfo()
                                                                       throws ApiException
        Get notary jurisdictions for a user Returns a list of jurisdictions that the notary is registered in. The current user must be a notary.
        Returns:
        NotaryJurisdictionList
        Throws:
        ApiException - if fails to make API call

      • updateNotary

        public Notary updateNotary​(Notary notary)
                    throws ApiException
        Update a notary. Updates notary information for the current user.
        Parameters:
        notary - (optional)
        Returns:
        Notary
        Throws:
        ApiException - if fails to make API call

      • updateNotaryWithHttpInfo

        public ApiResponse<Notary> updateNotaryWithHttpInfo​(Notary notary)
                                             throws ApiException
        Update a notary Updates notary information for the current user.
        Parameters:
        notary - (optional)
        Returns:
        Notary
        Throws:
        ApiException - if fails to make API call

      • updateNotaryJurisdiction

        public NotaryJurisdiction updateNotaryJurisdiction​(String jurisdictionId,
                                                   NotaryJurisdiction notaryJurisdiction)
                                            throws ApiException
        Update a notary jurisdiction. Updates the jurisdiction information about a notary. The following restrictions apply: - The current user must be a notary. - The `jurisdictionId` path parameter must be a jurisdiction that the notary is registered for. - The `jurisdictionId` path parameter must match the request body's `jurisdiction.jurisdictionId`. The request body must have a full `jurisdiction` object for the jurisdiction property. The best way to do this is to use `getNotaryJurisdiction` to obtain the current values and update the properties you want to change. For example, assume `getNotaryJurisdiction` returns this: ``` { \"jurisdiction\": { \"jurisdictionId\": \"15\", \"name\": \"Iowa\", \"county\": \"\", \"enabled\": \"true\", \"countyInSeal\": \"false\", \"commissionIdInSeal\": \"true\", \"stateNameInSeal\": \"true\", \"notaryPublicInSeal\": \"true\", \"allowSystemCreatedSeal\": \"true\", \"allowUserUploadedSeal\": \"false\" }, \"commissionId\": \"123456\", \"commissionExpiration\": \"2020-08-31T07:00:00.0000000Z\", \"registeredName\": \"Bob Notary\", \"county\": \"Adams\", \"sealType\": \"system_created\" } ``` If you want to change the name of the notary from \"Bob Notary\" to \"Robert Notary\", your request body would be: ``` { \"jurisdiction\": { \"jurisdictionId\": \"15\", \"name\": \"Iowa\", \"county\": \"\", \"enabled\": \"true\", \"countyInSeal\": \"false\", \"commissionIdInSeal\": \"true\", \"stateNameInSeal\": \"true\", \"notaryPublicInSeal\": \"true\", \"allowSystemCreatedSeal\": \"true\", \"allowUserUploadedSeal\": \"false\" }, \"commissionId\": \"123456\", \"commissionExpiration\": \"2020-08-31T07:00:00.0000000Z\", \"registeredName\": \"Robert Notary\", \"county\": \"Adams\", \"sealType\": \"system_created\" } ```
        Parameters:
        jurisdictionId - (required)
        notaryJurisdiction - (optional)
        Returns:
        NotaryJurisdiction
        Throws:
        ApiException - if fails to make API call

      • updateNotaryJurisdictionWithHttpInfo

        public ApiResponse<NotaryJurisdiction> updateNotaryJurisdictionWithHttpInfo​(String jurisdictionId,
                                                                            NotaryJurisdiction notaryJurisdiction)
                                                                     throws ApiException
        Update a notary jurisdiction Updates the jurisdiction information about a notary. The following restrictions apply: - The current user must be a notary. - The `jurisdictionId` path parameter must be a jurisdiction that the notary is registered for. - The `jurisdictionId` path parameter must match the request body's `jurisdiction.jurisdictionId`. The request body must have a full `jurisdiction` object for the jurisdiction property. The best way to do this is to use `getNotaryJurisdiction` to obtain the current values and update the properties you want to change. For example, assume `getNotaryJurisdiction` returns this: ``` { \"jurisdiction\": { \"jurisdictionId\": \"15\", \"name\": \"Iowa\", \"county\": \"\", \"enabled\": \"true\", \"countyInSeal\": \"false\", \"commissionIdInSeal\": \"true\", \"stateNameInSeal\": \"true\", \"notaryPublicInSeal\": \"true\", \"allowSystemCreatedSeal\": \"true\", \"allowUserUploadedSeal\": \"false\" }, \"commissionId\": \"123456\", \"commissionExpiration\": \"2020-08-31T07:00:00.0000000Z\", \"registeredName\": \"Bob Notary\", \"county\": \"Adams\", \"sealType\": \"system_created\" } ``` If you want to change the name of the notary from \"Bob Notary\" to \"Robert Notary\", your request body would be: ``` { \"jurisdiction\": { \"jurisdictionId\": \"15\", \"name\": \"Iowa\", \"county\": \"\", \"enabled\": \"true\", \"countyInSeal\": \"false\", \"commissionIdInSeal\": \"true\", \"stateNameInSeal\": \"true\", \"notaryPublicInSeal\": \"true\", \"allowSystemCreatedSeal\": \"true\", \"allowUserUploadedSeal\": \"false\" }, \"commissionId\": \"123456\", \"commissionExpiration\": \"2020-08-31T07:00:00.0000000Z\", \"registeredName\": \"Robert Notary\", \"county\": \"Adams\", \"sealType\": \"system_created\" } ```
        Parameters:
        jurisdictionId - (required)
        notaryJurisdiction - (optional)
        Returns:
        NotaryJurisdiction
        Throws:
        ApiException - if fails to make API call