Package com.docusign.esign.api

Class UsersApi

  • public class UsersApi
extends Object
    UsersApi class.

    • Constructor Detail

      • UsersApi

        public UsersApi()
        UsersApi.

      • UsersApi

        public UsersApi​(ApiClient apiClient)
        UsersApi.

    • Method Detail

      • getApiClient

        public ApiClient getApiClient()
        getApiClient Method.
        Returns:
        ApiClient

      • setApiClient

        public void setApiClient​(ApiClient apiClient)
        setApiClient Method.

      • callList

        public UserInformationList callList​(String accountId)
                             throws ApiException
        Retrieves the list of users for the specified account.. Retrieves the list of users for the specified account. The response returns the list of users for the account along with the information about the result set. If the `additional_info` query was added to the endpoint and set to **true**, the full user information is returned for each user
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        Returns:
        UserInformationList
        Throws:
        ApiException

      • callList

        public UserInformationList callList​(String accountId,
                                    UsersApi.CallListOptions options)
                             throws ApiException
        Retrieves the list of users for the specified account.. Retrieves the list of users for the specified account. The response returns the list of users for the account along with the information about the result set. If the `additional_info` query was added to the endpoint and set to **true**, the full user information is returned for each user
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        options - for modifying the method behavior.
        Returns:
        UserInformationList
        Throws:
        ApiException - if fails to make API call

      • callListWithHttpInfo

        public ApiResponse<UserInformationList> callListWithHttpInfo​(String accountId,
                                                             UsersApi.CallListOptions options)
                                                      throws ApiException
        Retrieves the list of users for the specified account. Retrieves the list of users for the specified account. The response returns the list of users for the account along with the information about the result set. If the `additional_info` query was added to the endpoint and set to **true**, the full user information is returned for each user
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        options - for modifying the method behavior.
        Returns:
        UserInformationList
        Throws:
        ApiException - if fails to make API call

      • create

        public NewUsersSummary create​(String accountId,
                              NewUsersDefinition newUsersDefinition)
                       throws ApiException
        Adds news user to the specified account.. Adds new users to your account. Set the `userSettings` property in the request to specify the actions the users can perform on the account.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        newUsersDefinition - (optional)
        Returns:
        NewUsersSummary
        Throws:
        ApiException - if fails to make API call

      • createWithHttpInfo

        public ApiResponse<NewUsersSummary> createWithHttpInfo​(String accountId,
                                                       NewUsersDefinition newUsersDefinition)
                                                throws ApiException
        Adds news user to the specified account. Adds new users to your account. Set the `userSettings` property in the request to specify the actions the users can perform on the account.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        newUsersDefinition - (optional)
        Returns:
        NewUsersSummary
        Throws:
        ApiException - if fails to make API call

      • createSignatures

        public UserSignaturesInformation createSignatures​(String accountId,
                                                  String userId,
                                                  UserSignaturesInformation userSignaturesInformation)
                                           throws ApiException
        Adds user Signature and initials images to a Signature.. Adds a user signature image and/or user initials image to the specified user. The userId property specified in the endpoint must match the authenticated user's userId and the user must be a member of the account. The rules and processes associated with this are: * If Content-Type is set to application/json, then the default behavior for creating a default signature image, based on the name and a DocuSign font, is used. * If Content-Type is set to multipart/form-data, then the request must contain a first part with the user signature information, followed by parts that contain the images. For each Image part, the Content-Disposition header has a \"filename\" value that is used to map to the `signatureName` and/or `signatureInitials` properties in the JSON to the image. For example: `Content-Disposition: file; filename=\"Ron Test20121127083900\"` If no matching image (by filename value) is found, then the image is not set. One, both, or neither of the signature and initials images can be set with this call. The Content-Transfer-Encoding: base64 header, set in the header for the part containing the image, can be set to indicate that the images are formatted as base64 instead of as binary. If successful, 200-OK is returned, and a JSON structure containing the signature information is provided, note that the signatureId can change with each API POST, PUT, or DELETE since the changes to the signature structure cause the current signature to be closed, and a new signature record to be created.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        userId - The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. (required)
        userSignaturesInformation - (optional)
        Returns:
        UserSignaturesInformation
        Throws:
        ApiException - if fails to make API call

      • createSignaturesWithHttpInfo

        public ApiResponse<UserSignaturesInformation> createSignaturesWithHttpInfo​(String accountId,
                                                                           String userId,
                                                                           UserSignaturesInformation userSignaturesInformation)
                                                                    throws ApiException
        Adds user Signature and initials images to a Signature. Adds a user signature image and/or user initials image to the specified user. The userId property specified in the endpoint must match the authenticated user's userId and the user must be a member of the account. The rules and processes associated with this are: * If Content-Type is set to application/json, then the default behavior for creating a default signature image, based on the name and a DocuSign font, is used. * If Content-Type is set to multipart/form-data, then the request must contain a first part with the user signature information, followed by parts that contain the images. For each Image part, the Content-Disposition header has a \"filename\" value that is used to map to the `signatureName` and/or `signatureInitials` properties in the JSON to the image. For example: `Content-Disposition: file; filename=\"Ron Test20121127083900\"` If no matching image (by filename value) is found, then the image is not set. One, both, or neither of the signature and initials images can be set with this call. The Content-Transfer-Encoding: base64 header, set in the header for the part containing the image, can be set to indicate that the images are formatted as base64 instead of as binary. If successful, 200-OK is returned, and a JSON structure containing the signature information is provided, note that the signatureId can change with each API POST, PUT, or DELETE since the changes to the signature structure cause the current signature to be closed, and a new signature record to be created.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        userId - The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. (required)
        userSignaturesInformation - (optional)
        Returns:
        UserSignaturesInformation
        Throws:
        ApiException - if fails to make API call

      • delete

        public UsersResponse delete​(String accountId,
                            UserInfoList userInfoList)
                     throws ApiException
        Removes users account privileges.. This closes one or more user records in the account. Users are never deleted from an account, but closing a user prevents them from using account functions. The response returns whether the API execution was successful (200 - OK) or if it failed. The response contains a user structure similar to the request and includes the user changes. If an error occurred during the DELETE operation for any of the users, the response for that user contains an `errorDetails` node with `errorCode` and `message` properties.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        userInfoList - (optional)
        Returns:
        UsersResponse
        Throws:
        ApiException

      • delete

        public UsersResponse delete​(String accountId,
                            UserInfoList userInfoList,
                            UsersApi.DeleteOptions options)
                     throws ApiException
        Removes users account privileges.. This closes one or more user records in the account. Users are never deleted from an account, but closing a user prevents them from using account functions. The response returns whether the API execution was successful (200 - OK) or if it failed. The response contains a user structure similar to the request and includes the user changes. If an error occurred during the DELETE operation for any of the users, the response for that user contains an `errorDetails` node with `errorCode` and `message` properties.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        userInfoList - (optional)
        options - for modifying the method behavior.
        Returns:
        UsersResponse
        Throws:
        ApiException - if fails to make API call

      • deleteWithHttpInfo

        public ApiResponse<UsersResponse> deleteWithHttpInfo​(String accountId,
                                                     UserInfoList userInfoList,
                                                     UsersApi.DeleteOptions options)
                                              throws ApiException
        Removes users account privileges. This closes one or more user records in the account. Users are never deleted from an account, but closing a user prevents them from using account functions. The response returns whether the API execution was successful (200 - OK) or if it failed. The response contains a user structure similar to the request and includes the user changes. If an error occurred during the DELETE operation for any of the users, the response for that user contains an `errorDetails` node with `errorCode` and `message` properties.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        userInfoList - (optional)
        options - for modifying the method behavior.
        Returns:
        UsersResponse
        Throws:
        ApiException - if fails to make API call

      • deleteContactWithId

        public ContactUpdateResponse deleteContactWithId​(String accountId,
                                                 String contactId)
                                          throws ApiException
        Replaces a particular contact associated with an account for the DocuSign service.. This method deletes a contact associated with an account.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        contactId - The unique identifier of a person in the contacts address book. (required)
        Returns:
        ContactUpdateResponse
        Throws:
        ApiException - if fails to make API call

      • deleteContactWithIdWithHttpInfo

        public ApiResponse<ContactUpdateResponse> deleteContactWithIdWithHttpInfo​(String accountId,
                                                                          String contactId)
                                                                   throws ApiException
        Replaces a particular contact associated with an account for the DocuSign service. This method deletes a contact associated with an account.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        contactId - The unique identifier of a person in the contacts address book. (required)
        Returns:
        ContactUpdateResponse
        Throws:
        ApiException - if fails to make API call

      • deleteContacts

        public ContactUpdateResponse deleteContacts​(String accountId,
                                            ContactModRequest contactModRequest)
                                     throws ApiException
        Delete contacts associated with an account for the DocuSign service.. This method deletes multiple contacts associated with an account.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        contactModRequest - (optional)
        Returns:
        ContactUpdateResponse
        Throws:
        ApiException - if fails to make API call

      • deleteContactsWithHttpInfo

        public ApiResponse<ContactUpdateResponse> deleteContactsWithHttpInfo​(String accountId,
                                                                     ContactModRequest contactModRequest)
                                                              throws ApiException
        Delete contacts associated with an account for the DocuSign service. This method deletes multiple contacts associated with an account.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        contactModRequest - (optional)
        Returns:
        ContactUpdateResponse
        Throws:
        ApiException - if fails to make API call

      • deleteCustomSettings

        public CustomSettingsInformation deleteCustomSettings​(String accountId,
                                                      String userId,
                                                      CustomSettingsInformation customSettingsInformation)
                                               throws ApiException
        Deletes custom user settings for a specified user.. Deletes the specified custom user settings for a single user. ###Deleting Grouped Custom User Settings### If the custom user settings you want to delete are grouped, you must include the following information in the header, after Content-Type, in the request: `X-DocuSign-User-Settings-Key:group_name` Where the `group_name` is your designated name for the group of customer user settings. If the extra header information is not included, only the custom user settings that were added without a group are deleted.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        userId - The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. (required)
        customSettingsInformation - (optional)
        Returns:
        CustomSettingsInformation
        Throws:
        ApiException - if fails to make API call

      • deleteCustomSettingsWithHttpInfo

        public ApiResponse<CustomSettingsInformation> deleteCustomSettingsWithHttpInfo​(String accountId,
                                                                               String userId,
                                                                               CustomSettingsInformation customSettingsInformation)
                                                                        throws ApiException
        Deletes custom user settings for a specified user. Deletes the specified custom user settings for a single user. ###Deleting Grouped Custom User Settings### If the custom user settings you want to delete are grouped, you must include the following information in the header, after Content-Type, in the request: `X-DocuSign-User-Settings-Key:group_name` Where the `group_name` is your designated name for the group of customer user settings. If the extra header information is not included, only the custom user settings that were added without a group are deleted.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        userId - The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. (required)
        customSettingsInformation - (optional)
        Returns:
        CustomSettingsInformation
        Throws:
        ApiException - if fails to make API call

      • deleteProfileImage

        public void deleteProfileImage​(String accountId,
                               String userId)
                        throws ApiException
        Deletes the user profile image for the specified user.. Deletes the user profile image from the specified user's profile. The userId parameter specified in the endpoint must match the authenticated user's user ID and the user must be a member of the specified account.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        userId - The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. (required)
        Throws:
        ApiException - if fails to make API call

      • deleteProfileImageWithHttpInfo

        public ApiResponse<Object> deleteProfileImageWithHttpInfo​(String accountId,
                                                          String userId)
                                                   throws ApiException
        Deletes the user profile image for the specified user. Deletes the user profile image from the specified user's profile. The userId parameter specified in the endpoint must match the authenticated user's user ID and the user must be a member of the specified account.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        userId - The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. (required)
        Throws:
        ApiException - if fails to make API call

      • deleteSignature

        public void deleteSignature​(String accountId,
                            String userId,
                            String signatureId)
                     throws ApiException
        Removes removes signature information for the specified user.. Removes the signature information for the user. The userId parameter specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account. The `signatureId` accepts a signature ID or a signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint. For example encode \"Bob Smith\" as \"Bob%20Smith\".
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        userId - The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. (required)
        signatureId - The ID of the signature being accessed. (required)
        Throws:
        ApiException - if fails to make API call

      • deleteSignatureWithHttpInfo

        public ApiResponse<Object> deleteSignatureWithHttpInfo​(String accountId,
                                                       String userId,
                                                       String signatureId)
                                                throws ApiException
        Removes removes signature information for the specified user. Removes the signature information for the user. The userId parameter specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account. The `signatureId` accepts a signature ID or a signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint. For example encode \"Bob Smith\" as \"Bob%20Smith\".
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        userId - The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. (required)
        signatureId - The ID of the signature being accessed. (required)
        Throws:
        ApiException - if fails to make API call

      • deleteSignatureImage

        public UserSignature deleteSignatureImage​(String accountId,
                                          String userId,
                                          String signatureId,
                                          String imageType)
                                   throws ApiException
        Deletes the user initials image or the user signature image for the specified user.. Deletes the specified initials image or signature image for the specified user. The function deletes one or the other of the image types, to delete both the initials image and signature image you must call the endpoint twice. The userId parameter specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account. The `signatureId` parameter accepts a signature ID or a signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint. For example encode \"Bob Smith\" as \"Bob%20Smith\".
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        userId - The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. (required)
        signatureId - The ID of the signature being accessed. (required)
        imageType - One of **signature_image** or **initials_image**. (required)
        Returns:
        UserSignature
        Throws:
        ApiException - if fails to make API call

      • deleteSignatureImageWithHttpInfo

        public ApiResponse<UserSignature> deleteSignatureImageWithHttpInfo​(String accountId,
                                                                   String userId,
                                                                   String signatureId,
                                                                   String imageType)
                                                            throws ApiException
        Deletes the user initials image or the user signature image for the specified user. Deletes the specified initials image or signature image for the specified user. The function deletes one or the other of the image types, to delete both the initials image and signature image you must call the endpoint twice. The userId parameter specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account. The `signatureId` parameter accepts a signature ID or a signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint. For example encode \"Bob Smith\" as \"Bob%20Smith\".
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        userId - The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. (required)
        signatureId - The ID of the signature being accessed. (required)
        imageType - One of **signature_image** or **initials_image**. (required)
        Returns:
        UserSignature
        Throws:
        ApiException - if fails to make API call

      • getContactById

        public ContactGetResponse getContactById​(String accountId,
                                         String contactId)
                                  throws ApiException
        Gets a particular contact associated with the user's account.. This method returns one or more contacts associated with a DocuSign account. You can also retrieve contacts from connected [cloud storage][CloudStorage] providers by using the `cloud_provider` query parameter. By default, contacts are retrieved from the DocuSign account's default address book. To return a specific contact, use the `contactId` query parameter. To return all contacts associated with an account, omit this parameter. [CloudStorage]: /docs/esign-rest-api/reference/cloudstorage/
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        contactId - The unique identifier of a person in the contacts address book. (required)
        Returns:
        ContactGetResponse
        Throws:
        ApiException

      • getContactById

        public ContactGetResponse getContactById​(String accountId,
                                         String contactId,
                                         UsersApi.GetContactByIdOptions options)
                                  throws ApiException
        Gets a particular contact associated with the user's account.. This method returns one or more contacts associated with a DocuSign account. You can also retrieve contacts from connected [cloud storage][CloudStorage] providers by using the `cloud_provider` query parameter. By default, contacts are retrieved from the DocuSign account's default address book. To return a specific contact, use the `contactId` query parameter. To return all contacts associated with an account, omit this parameter. [CloudStorage]: /docs/esign-rest-api/reference/cloudstorage/
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        contactId - The unique identifier of a person in the contacts address book. (required)
        options - for modifying the method behavior.
        Returns:
        ContactGetResponse
        Throws:
        ApiException - if fails to make API call

      • getContactByIdWithHttpInfo

        public ApiResponse<ContactGetResponse> getContactByIdWithHttpInfo​(String accountId,
                                                                  String contactId,
                                                                  UsersApi.GetContactByIdOptions options)
                                                           throws ApiException
        Gets a particular contact associated with the user's account. This method returns one or more contacts associated with a DocuSign account. You can also retrieve contacts from connected [cloud storage][CloudStorage] providers by using the `cloud_provider` query parameter. By default, contacts are retrieved from the DocuSign account's default address book. To return a specific contact, use the `contactId` query parameter. To return all contacts associated with an account, omit this parameter. [CloudStorage]: /docs/esign-rest-api/reference/cloudstorage/
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        contactId - The unique identifier of a person in the contacts address book. (required)
        options - for modifying the method behavior.
        Returns:
        ContactGetResponse
        Throws:
        ApiException - if fails to make API call

      • getInformation

        public UserInformation getInformation​(String accountId,
                                      String userId)
                               throws ApiException
        Gets the user information for a specified user.. Retrieves the user information for the specified user. To return additional user information that details the last login date, login status, and the user's password expiration date, set the optional `additional_info` query string parameter to **true**.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        userId - The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. (required)
        Returns:
        UserInformation
        Throws:
        ApiException

      • getInformation

        public UserInformation getInformation​(String accountId,
                                      String userId,
                                      UsersApi.GetInformationOptions options)
                               throws ApiException
        Gets the user information for a specified user.. Retrieves the user information for the specified user. To return additional user information that details the last login date, login status, and the user's password expiration date, set the optional `additional_info` query string parameter to **true**.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        userId - The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. (required)
        options - for modifying the method behavior.
        Returns:
        UserInformation
        Throws:
        ApiException - if fails to make API call

      • getInformationWithHttpInfo

        public ApiResponse<UserInformation> getInformationWithHttpInfo​(String accountId,
                                                               String userId,
                                                               UsersApi.GetInformationOptions options)
                                                        throws ApiException
        Gets the user information for a specified user. Retrieves the user information for the specified user. To return additional user information that details the last login date, login status, and the user's password expiration date, set the optional `additional_info` query string parameter to **true**.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        userId - The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. (required)
        options - for modifying the method behavior.
        Returns:
        UserInformation
        Throws:
        ApiException - if fails to make API call

      • getProfile

        public UserProfile getProfile​(String accountId,
                              String userId)
                       throws ApiException
        Retrieves the user profile for a specified user.. Retrieves the user profile information, the privacy settings and personal information (address, phone number, etc.) for the specified user. The userId parameter specified in the endpoint must match the authenticated user's user ID and the user must be a member of the specified account.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        userId - The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. (required)
        Returns:
        UserProfile
        Throws:
        ApiException - if fails to make API call

      • getProfileWithHttpInfo

        public ApiResponse<UserProfile> getProfileWithHttpInfo​(String accountId,
                                                       String userId)
                                                throws ApiException
        Retrieves the user profile for a specified user. Retrieves the user profile information, the privacy settings and personal information (address, phone number, etc.) for the specified user. The userId parameter specified in the endpoint must match the authenticated user's user ID and the user must be a member of the specified account.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        userId - The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. (required)
        Returns:
        UserProfile
        Throws:
        ApiException - if fails to make API call

      • getProfileImage

        public byte[] getProfileImage​(String accountId,
                              String userId)
                       throws ApiException
        Retrieves the user profile image for the specified user.. Retrieves the user profile picture for the specified user. The image is returned in the same format as uploaded. The userId parameter specified in the endpoint must match the authenticated user's user ID and the user must be a member of the specified account. If successful, the response returns a 200 - OK and the user profile image.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        userId - The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. (required)
        Returns:
        byte[]
        Throws:
        ApiException

      • getProfileImage

        public byte[] getProfileImage​(String accountId,
                              String userId,
                              UsersApi.GetProfileImageOptions options)
                       throws ApiException
        Retrieves the user profile image for the specified user.. Retrieves the user profile picture for the specified user. The image is returned in the same format as uploaded. The userId parameter specified in the endpoint must match the authenticated user's user ID and the user must be a member of the specified account. If successful, the response returns a 200 - OK and the user profile image.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        userId - The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. (required)
        options - for modifying the method behavior.
        Returns:
        byte[]
        Throws:
        ApiException - if fails to make API call

      • getProfileImageWithHttpInfo

        public ApiResponse<byte[]> getProfileImageWithHttpInfo​(String accountId,
                                                       String userId,
                                                       UsersApi.GetProfileImageOptions options)
                                                throws ApiException
        Retrieves the user profile image for the specified user. Retrieves the user profile picture for the specified user. The image is returned in the same format as uploaded. The userId parameter specified in the endpoint must match the authenticated user's user ID and the user must be a member of the specified account. If successful, the response returns a 200 - OK and the user profile image.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        userId - The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. (required)
        options - for modifying the method behavior.
        Returns:
        byte[]
        Throws:
        ApiException - if fails to make API call

      • getSettings

        public UserSettingsInformation getSettings​(String accountId,
                                           String userId)
                                    throws ApiException
        Gets the user account settings for a specified user.. Retrieves a list of the account settings and email notification information for the specified user. The response returns the account setting name/value information and the email notification settings for the specified user. For more information about the different user settings, see the [ML:userSettings list].
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        userId - The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. (required)
        Returns:
        UserSettingsInformation
        Throws:
        ApiException - if fails to make API call

      • getSettingsWithHttpInfo

        public ApiResponse<UserSettingsInformation> getSettingsWithHttpInfo​(String accountId,
                                                                    String userId)
                                                             throws ApiException
        Gets the user account settings for a specified user. Retrieves a list of the account settings and email notification information for the specified user. The response returns the account setting name/value information and the email notification settings for the specified user. For more information about the different user settings, see the [ML:userSettings list].
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        userId - The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. (required)
        Returns:
        UserSettingsInformation
        Throws:
        ApiException - if fails to make API call

      • getSignature

        public UserSignature getSignature​(String accountId,
                                  String userId,
                                  String signatureId)
                           throws ApiException
        Gets the user signature information for the specified user.. Retrieves the structure of a single signature with a known signature name. The userId specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account. The `signatureId` parameter accepts a signature ID or a signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint. For example encode \"Bob Smith\" as \"Bob%20Smith\".
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        userId - The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. (required)
        signatureId - The ID of the signature being accessed. (required)
        Returns:
        UserSignature
        Throws:
        ApiException - if fails to make API call

      • getSignatureWithHttpInfo

        public ApiResponse<UserSignature> getSignatureWithHttpInfo​(String accountId,
                                                           String userId,
                                                           String signatureId)
                                                    throws ApiException
        Gets the user signature information for the specified user. Retrieves the structure of a single signature with a known signature name. The userId specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account. The `signatureId` parameter accepts a signature ID or a signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint. For example encode \"Bob Smith\" as \"Bob%20Smith\".
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        userId - The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. (required)
        signatureId - The ID of the signature being accessed. (required)
        Returns:
        UserSignature
        Throws:
        ApiException - if fails to make API call

      • getSignatureImage

        public byte[] getSignatureImage​(String accountId,
                                String userId,
                                String signatureId,
                                String imageType)
                         throws ApiException
        Retrieves the user initials image or the user signature image for the specified user.. Retrieves the specified initials image or signature image for the specified user. The image is returned in the same format as uploaded. In the request you can specify if the chrome (the added line and identifier around the initial image) is returned with the image. The userId property specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account. The `signatureId` parameter accepts a signature ID or a signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint. For example encode \"Bob Smith\" as \"Bob%20Smith\". ###### Note: Older envelopes might only have chromed images. If getting the non-chromed image fails, try getting the chromed image.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        userId - The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. (required)
        signatureId - The ID of the signature being accessed. (required)
        imageType - One of **signature_image** or **initials_image**. (required)
        Returns:
        byte[]
        Throws:
        ApiException

      • getSignatureImage

        public byte[] getSignatureImage​(String accountId,
                                String userId,
                                String signatureId,
                                String imageType,
                                UsersApi.GetSignatureImageOptions options)
                         throws ApiException
        Retrieves the user initials image or the user signature image for the specified user.. Retrieves the specified initials image or signature image for the specified user. The image is returned in the same format as uploaded. In the request you can specify if the chrome (the added line and identifier around the initial image) is returned with the image. The userId property specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account. The `signatureId` parameter accepts a signature ID or a signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint. For example encode \"Bob Smith\" as \"Bob%20Smith\". ###### Note: Older envelopes might only have chromed images. If getting the non-chromed image fails, try getting the chromed image.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        userId - The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. (required)
        signatureId - The ID of the signature being accessed. (required)
        imageType - One of **signature_image** or **initials_image**. (required)
        options - for modifying the method behavior.
        Returns:
        byte[]
        Throws:
        ApiException - if fails to make API call

      • getSignatureImageWithHttpInfo

        public ApiResponse<byte[]> getSignatureImageWithHttpInfo​(String accountId,
                                                         String userId,
                                                         String signatureId,
                                                         String imageType,
                                                         UsersApi.GetSignatureImageOptions options)
                                                  throws ApiException
        Retrieves the user initials image or the user signature image for the specified user. Retrieves the specified initials image or signature image for the specified user. The image is returned in the same format as uploaded. In the request you can specify if the chrome (the added line and identifier around the initial image) is returned with the image. The userId property specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account. The `signatureId` parameter accepts a signature ID or a signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint. For example encode \"Bob Smith\" as \"Bob%20Smith\". ###### Note: Older envelopes might only have chromed images. If getting the non-chromed image fails, try getting the chromed image.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        userId - The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. (required)
        signatureId - The ID of the signature being accessed. (required)
        imageType - One of **signature_image** or **initials_image**. (required)
        options - for modifying the method behavior.
        Returns:
        byte[]
        Throws:
        ApiException - if fails to make API call

      • listCustomSettings

        public CustomSettingsInformation listCustomSettings​(String accountId,
                                                    String userId)
                                             throws ApiException
        Retrieves the custom user settings for a specified user.. Retrieves a list of custom user settings for a single user. Custom settings provide a flexible way to store and retrieve custom user information that can be used in your own system. ###### Note: Custom user settings are not the same as user account settings. ###Getting Grouped Custom User Settings### If the custom user settings you want to retrieve are grouped, you must include the following information in the header, after Content-Type, in the request: `X-DocuSign-User-Settings-Key:group_name` Where the `group_name` is your designated name for the group of customer user settings. If the extra header information is not included, only the custom user settings that were added without a group are retrieved.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        userId - The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. (required)
        Returns:
        CustomSettingsInformation
        Throws:
        ApiException - if fails to make API call

      • listCustomSettingsWithHttpInfo

        public ApiResponse<CustomSettingsInformation> listCustomSettingsWithHttpInfo​(String accountId,
                                                                             String userId)
                                                                      throws ApiException
        Retrieves the custom user settings for a specified user. Retrieves a list of custom user settings for a single user. Custom settings provide a flexible way to store and retrieve custom user information that can be used in your own system. ###### Note: Custom user settings are not the same as user account settings. ###Getting Grouped Custom User Settings### If the custom user settings you want to retrieve are grouped, you must include the following information in the header, after Content-Type, in the request: `X-DocuSign-User-Settings-Key:group_name` Where the `group_name` is your designated name for the group of customer user settings. If the extra header information is not included, only the custom user settings that were added without a group are retrieved.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        userId - The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. (required)
        Returns:
        CustomSettingsInformation
        Throws:
        ApiException - if fails to make API call

      • listSignatures

        public UserSignaturesInformation listSignatures​(String accountId,
                                                String userId)
                                         throws ApiException
        Retrieves a list of user signature definitions for a specified user.. Retrieves the signature definitions for the specified user. The userId parameter specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account. The `signatureId` parameter accepts a signature ID or a signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint. For example encode \"Bob Smith\" as \"Bob%20Smith\".
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        userId - The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. (required)
        Returns:
        UserSignaturesInformation
        Throws:
        ApiException

      • listSignatures

        public UserSignaturesInformation listSignatures​(String accountId,
                                                String userId,
                                                UsersApi.ListSignaturesOptions options)
                                         throws ApiException
        Retrieves a list of user signature definitions for a specified user.. Retrieves the signature definitions for the specified user. The userId parameter specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account. The `signatureId` parameter accepts a signature ID or a signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint. For example encode \"Bob Smith\" as \"Bob%20Smith\".
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        userId - The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. (required)
        options - for modifying the method behavior.
        Returns:
        UserSignaturesInformation
        Throws:
        ApiException - if fails to make API call

      • listSignaturesWithHttpInfo

        public ApiResponse<UserSignaturesInformation> listSignaturesWithHttpInfo​(String accountId,
                                                                         String userId,
                                                                         UsersApi.ListSignaturesOptions options)
                                                                  throws ApiException
        Retrieves a list of user signature definitions for a specified user. Retrieves the signature definitions for the specified user. The userId parameter specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account. The `signatureId` parameter accepts a signature ID or a signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint. For example encode \"Bob Smith\" as \"Bob%20Smith\".
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        userId - The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. (required)
        options - for modifying the method behavior.
        Returns:
        UserSignaturesInformation
        Throws:
        ApiException - if fails to make API call

      • postContacts

        public ContactUpdateResponse postContacts​(String accountId,
                                          ContactModRequest contactModRequest)
                                   throws ApiException
        Imports multiple new contacts into the contacts collection from CSV, JSON, or XML (based on content type).. This method adds multiple contacts into a contacts list.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        contactModRequest - (optional)
        Returns:
        ContactUpdateResponse
        Throws:
        ApiException - if fails to make API call

      • postContactsWithHttpInfo

        public ApiResponse<ContactUpdateResponse> postContactsWithHttpInfo​(String accountId,
                                                                   ContactModRequest contactModRequest)
                                                            throws ApiException
        Imports multiple new contacts into the contacts collection from CSV, JSON, or XML (based on content type). This method adds multiple contacts into a contacts list.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        contactModRequest - (optional)
        Returns:
        ContactUpdateResponse
        Throws:
        ApiException - if fails to make API call

      • putContacts

        public ContactUpdateResponse putContacts​(String accountId,
                                         ContactModRequest contactModRequest)
                                  throws ApiException
        Replaces contacts associated with an account for the DocuSign service.. This method updates one or more contacts associated with an account.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        contactModRequest - (optional)
        Returns:
        ContactUpdateResponse
        Throws:
        ApiException - if fails to make API call

      • putContactsWithHttpInfo

        public ApiResponse<ContactUpdateResponse> putContactsWithHttpInfo​(String accountId,
                                                                  ContactModRequest contactModRequest)
                                                           throws ApiException
        Replaces contacts associated with an account for the DocuSign service. This method updates one or more contacts associated with an account.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        contactModRequest - (optional)
        Returns:
        ContactUpdateResponse
        Throws:
        ApiException - if fails to make API call

      • updateCustomSettings

        public CustomSettingsInformation updateCustomSettings​(String accountId,
                                                      String userId,
                                                      CustomSettingsInformation customSettingsInformation)
                                               throws ApiException
        Adds or updates custom user settings for the specified user.. Adds or updates custom user settings for the specified user. ###### Note: Custom user settings are not the same as user account settings. Custom settings provide a flexible way to store and retrieve custom user information that you can use in your own system. **Important**: There is a limit on the size for all the custom user settings for a single user. The limit is 4,000 characters, which includes the XML and JSON structure for the settings. ### Grouping Custom User Settings ### You can group custom user settings when adding them. Grouping allows you to retrieve settings that are in a specific group, instead of retrieving all the user custom settings. To group custom user settings, add the following information in the header, after Content-Type: `X-DocuSign-User-Settings-Key:group_name` Where the `group_name` is your designated name for the group of customer user settings. Grouping is shown in the Example Request Body below. When getting or deleting grouped custom user settings, you must include the extra header information. Grouping custom user settings is not required and if the extra header information is not included, the custom user settings are added normally and can be retrieved or deleted without including the additional header.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        userId - The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. (required)
        customSettingsInformation - (optional)
        Returns:
        CustomSettingsInformation
        Throws:
        ApiException - if fails to make API call

      • updateCustomSettingsWithHttpInfo

        public ApiResponse<CustomSettingsInformation> updateCustomSettingsWithHttpInfo​(String accountId,
                                                                               String userId,
                                                                               CustomSettingsInformation customSettingsInformation)
                                                                        throws ApiException
        Adds or updates custom user settings for the specified user. Adds or updates custom user settings for the specified user. ###### Note: Custom user settings are not the same as user account settings. Custom settings provide a flexible way to store and retrieve custom user information that you can use in your own system. **Important**: There is a limit on the size for all the custom user settings for a single user. The limit is 4,000 characters, which includes the XML and JSON structure for the settings. ### Grouping Custom User Settings ### You can group custom user settings when adding them. Grouping allows you to retrieve settings that are in a specific group, instead of retrieving all the user custom settings. To group custom user settings, add the following information in the header, after Content-Type: `X-DocuSign-User-Settings-Key:group_name` Where the `group_name` is your designated name for the group of customer user settings. Grouping is shown in the Example Request Body below. When getting or deleting grouped custom user settings, you must include the extra header information. Grouping custom user settings is not required and if the extra header information is not included, the custom user settings are added normally and can be retrieved or deleted without including the additional header.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        userId - The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. (required)
        customSettingsInformation - (optional)
        Returns:
        CustomSettingsInformation
        Throws:
        ApiException - if fails to make API call

      • updateProfile

        public void updateProfile​(String accountId,
                          String userId,
                          UserProfile userProfile)
                   throws ApiException
        Updates the user profile information for the specified user.. Updates the user's detail information, profile information, privacy settings, and personal information in the user ID card. You can also change a user's name by changing the information in the `userDetails` property. When changing a user's name, you can either change the information in the `userName` property OR change the information in `firstName`, `middleName`, `lastName, suffixName`, and `title` properties. Changes to `firstName`, `middleName`, `lastName`, `suffixName`, and `title` properties take precedence over changes to the `userName` property.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        userId - The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. (required)
        userProfile - (optional)
        Throws:
        ApiException - if fails to make API call

      • updateProfileWithHttpInfo

        public ApiResponse<Object> updateProfileWithHttpInfo​(String accountId,
                                                     String userId,
                                                     UserProfile userProfile)
                                              throws ApiException
        Updates the user profile information for the specified user. Updates the user's detail information, profile information, privacy settings, and personal information in the user ID card. You can also change a user's name by changing the information in the `userDetails` property. When changing a user's name, you can either change the information in the `userName` property OR change the information in `firstName`, `middleName`, `lastName, suffixName`, and `title` properties. Changes to `firstName`, `middleName`, `lastName`, `suffixName`, and `title` properties take precedence over changes to the `userName` property.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        userId - The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. (required)
        userProfile - (optional)
        Throws:
        ApiException - if fails to make API call

      • updateProfileImage

        public void updateProfileImage​(String accountId,
                               String userId)
                        throws ApiException
        Updates the user profile image for a specified user.. Updates the user profile image by uploading an image to the user profile. The supported image formats are: gif, png, jpeg, and bmp. The file must be less than 200K. For best viewing results, DocuSign recommends that the image is no more than 79 pixels wide and high.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        userId - The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. (required)
        Throws:
        ApiException - if fails to make API call

      • updateProfileImageWithHttpInfo

        public ApiResponse<Object> updateProfileImageWithHttpInfo​(String accountId,
                                                          String userId)
                                                   throws ApiException
        Updates the user profile image for a specified user. Updates the user profile image by uploading an image to the user profile. The supported image formats are: gif, png, jpeg, and bmp. The file must be less than 200K. For best viewing results, DocuSign recommends that the image is no more than 79 pixels wide and high.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        userId - The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. (required)
        Throws:
        ApiException - if fails to make API call

      • updateSettings

        public void updateSettings​(String accountId,
                           String userId,
                           UserSettingsInformation userSettingsInformation)
                    throws ApiException
        Updates the user account settings for a specified user.. Updates the account settings list and email notification types for the specified user.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        userId - The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. (required)
        userSettingsInformation - (optional)
        Throws:
        ApiException

      • updateSettings

        public void updateSettings​(String accountId,
                           String userId,
                           UserSettingsInformation userSettingsInformation,
                           UsersApi.UpdateSettingsOptions options)
                    throws ApiException
        Updates the user account settings for a specified user.. Updates the account settings list and email notification types for the specified user.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        userId - The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. (required)
        userSettingsInformation - (optional)
        options - for modifying the method behavior.
        Throws:
        ApiException - if fails to make API call

      • updateSettingsWithHttpInfo

        public ApiResponse<Object> updateSettingsWithHttpInfo​(String accountId,
                                                      String userId,
                                                      UserSettingsInformation userSettingsInformation,
                                                      UsersApi.UpdateSettingsOptions options)
                                               throws ApiException
        Updates the user account settings for a specified user. Updates the account settings list and email notification types for the specified user.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        userId - The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. (required)
        userSettingsInformation - (optional)
        options - for modifying the method behavior.
        Throws:
        ApiException - if fails to make API call

      • updateSignature

        public UserSignature updateSignature​(String accountId,
                                     String userId,
                                     String signatureId,
                                     UserSignatureDefinition userSignatureDefinition)
                              throws ApiException
        Updates the user signature for a specified user.. Creates, or updates, the signature font and initials for the specified user. When creating a signature, you use this resource to create the signature name and then add the signature and initials images into the signature. ###### Note: This will also create a default signature for the user when one does not exist. The userId property specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account. The `signatureId` parameter accepts a signature ID or a signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint. For example encode \"Bob Smith\" as \"Bob%20Smith\".
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        userId - The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. (required)
        signatureId - The ID of the signature being accessed. (required)
        userSignatureDefinition - (optional)
        Returns:
        UserSignature
        Throws:
        ApiException

      • updateSignature

        public UserSignature updateSignature​(String accountId,
                                     String userId,
                                     String signatureId,
                                     UserSignatureDefinition userSignatureDefinition,
                                     UsersApi.UpdateSignatureOptions options)
                              throws ApiException
        Updates the user signature for a specified user.. Creates, or updates, the signature font and initials for the specified user. When creating a signature, you use this resource to create the signature name and then add the signature and initials images into the signature. ###### Note: This will also create a default signature for the user when one does not exist. The userId property specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account. The `signatureId` parameter accepts a signature ID or a signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint. For example encode \"Bob Smith\" as \"Bob%20Smith\".
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        userId - The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. (required)
        signatureId - The ID of the signature being accessed. (required)
        userSignatureDefinition - (optional)
        options - for modifying the method behavior.
        Returns:
        UserSignature
        Throws:
        ApiException - if fails to make API call

      • updateSignatureWithHttpInfo

        public ApiResponse<UserSignature> updateSignatureWithHttpInfo​(String accountId,
                                                              String userId,
                                                              String signatureId,
                                                              UserSignatureDefinition userSignatureDefinition,
                                                              UsersApi.UpdateSignatureOptions options)
                                                       throws ApiException
        Updates the user signature for a specified user. Creates, or updates, the signature font and initials for the specified user. When creating a signature, you use this resource to create the signature name and then add the signature and initials images into the signature. ###### Note: This will also create a default signature for the user when one does not exist. The userId property specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account. The `signatureId` parameter accepts a signature ID or a signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint. For example encode \"Bob Smith\" as \"Bob%20Smith\".
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        userId - The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. (required)
        signatureId - The ID of the signature being accessed. (required)
        userSignatureDefinition - (optional)
        options - for modifying the method behavior.
        Returns:
        UserSignature
        Throws:
        ApiException - if fails to make API call

      • updateSignatureImage

        public UserSignature updateSignatureImage​(String accountId,
                                          String userId,
                                          String signatureId,
                                          String imageType)
                                   throws ApiException
        Updates the user signature image or user initials image for the specified user.. Updates the user signature image or user initials image for the specified user. The supported image formats for this file are: gif, png, jpeg, and bmp. The file must be less than 200K. The userId property specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account. The `signatureId` parameter accepts a signature ID or a signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint. For example encode \"Bob Smith\" as \"Bob%20Smith\".
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        userId - The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. (required)
        signatureId - The ID of the signature being accessed. (required)
        imageType - One of **signature_image** or **initials_image**. (required)
        Returns:
        UserSignature
        Throws:
        ApiException

      • updateSignatureImage

        public UserSignature updateSignatureImage​(String accountId,
                                          String userId,
                                          String signatureId,
                                          String imageType,
                                          UsersApi.UpdateSignatureImageOptions options)
                                   throws ApiException
        Updates the user signature image or user initials image for the specified user.. Updates the user signature image or user initials image for the specified user. The supported image formats for this file are: gif, png, jpeg, and bmp. The file must be less than 200K. The userId property specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account. The `signatureId` parameter accepts a signature ID or a signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint. For example encode \"Bob Smith\" as \"Bob%20Smith\".
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        userId - The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. (required)
        signatureId - The ID of the signature being accessed. (required)
        imageType - One of **signature_image** or **initials_image**. (required)
        options - for modifying the method behavior.
        Returns:
        UserSignature
        Throws:
        ApiException - if fails to make API call

      • updateSignatureImageWithHttpInfo

        public ApiResponse<UserSignature> updateSignatureImageWithHttpInfo​(String accountId,
                                                                   String userId,
                                                                   String signatureId,
                                                                   String imageType,
                                                                   UsersApi.UpdateSignatureImageOptions options)
                                                            throws ApiException
        Updates the user signature image or user initials image for the specified user. Updates the user signature image or user initials image for the specified user. The supported image formats for this file are: gif, png, jpeg, and bmp. The file must be less than 200K. The userId property specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account. The `signatureId` parameter accepts a signature ID or a signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint. For example encode \"Bob Smith\" as \"Bob%20Smith\".
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        userId - The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. (required)
        signatureId - The ID of the signature being accessed. (required)
        imageType - One of **signature_image** or **initials_image**. (required)
        options - for modifying the method behavior.
        Returns:
        UserSignature
        Throws:
        ApiException - if fails to make API call

      • updateSignatures

        public UserSignaturesInformation updateSignatures​(String accountId,
                                                  String userId,
                                                  UserSignaturesInformation userSignaturesInformation)
                                           throws ApiException
        Adds/updates a user signature..
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        userId - The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. (required)
        userSignaturesInformation - (optional)
        Returns:
        UserSignaturesInformation
        Throws:
        ApiException - if fails to make API call

      • updateSignaturesWithHttpInfo

        public ApiResponse<UserSignaturesInformation> updateSignaturesWithHttpInfo​(String accountId,
                                                                           String userId,
                                                                           UserSignaturesInformation userSignaturesInformation)
                                                                    throws ApiException
        Adds/updates a user signature.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        userId - The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. (required)
        userSignaturesInformation - (optional)
        Returns:
        UserSignaturesInformation
        Throws:
        ApiException - if fails to make API call

      • updateUser

        public UserInformation updateUser​(String accountId,
                                  String userId,
                                  UserInformation userInformation)
                           throws ApiException
        Updates the specified user information.. To update user information for a specific user, submit a [Users](#Users) object with updated field values in the request body of this operation.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        userId - The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. (required)
        userInformation - (optional)
        Returns:
        UserInformation
        Throws:
        ApiException

      • updateUser

        public UserInformation updateUser​(String accountId,
                                  String userId,
                                  UserInformation userInformation,
                                  UsersApi.UpdateUserOptions options)
                           throws ApiException
        Updates the specified user information.. To update user information for a specific user, submit a [Users](#Users) object with updated field values in the request body of this operation.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        userId - The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. (required)
        userInformation - (optional)
        options - for modifying the method behavior.
        Returns:
        UserInformation
        Throws:
        ApiException - if fails to make API call

      • updateUserWithHttpInfo

        public ApiResponse<UserInformation> updateUserWithHttpInfo​(String accountId,
                                                           String userId,
                                                           UserInformation userInformation,
                                                           UsersApi.UpdateUserOptions options)
                                                    throws ApiException
        Updates the specified user information. To update user information for a specific user, submit a [Users](#Users) object with updated field values in the request body of this operation.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        userId - The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. (required)
        userInformation - (optional)
        options - for modifying the method behavior.
        Returns:
        UserInformation
        Throws:
        ApiException - if fails to make API call

      • updateUsers

        public UserInformationList updateUsers​(String accountId,
                                       UserInformationList userInformationList)
                                throws ApiException
        Change one or more user in the specified account.. This method updates the information about one or more account users.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        userInformationList - (optional)
        Returns:
        UserInformationList
        Throws:
        ApiException

      • updateUsers

        public UserInformationList updateUsers​(String accountId,
                                       UserInformationList userInformationList,
                                       UsersApi.UpdateUsersOptions options)
                                throws ApiException
        Change one or more user in the specified account.. This method updates the information about one or more account users.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        userInformationList - (optional)
        options - for modifying the method behavior.
        Returns:
        UserInformationList
        Throws:
        ApiException - if fails to make API call

      • updateUsersWithHttpInfo

        public ApiResponse<UserInformationList> updateUsersWithHttpInfo​(String accountId,
                                                                UserInformationList userInformationList,
                                                                UsersApi.UpdateUsersOptions options)
                                                         throws ApiException
        Change one or more user in the specified account. This method updates the information about one or more account users.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        userInformationList - (optional)
        options - for modifying the method behavior.
        Returns:
        UserInformationList
        Throws:
        ApiException - if fails to make API call