View Source DocuSign.Api.UserCustomSettings (DocuSign v1.2.0)

API calls for all endpoints tagged UserCustomSettings.

Summary

Functions

user_custom_settings_delete_custom_settings(connection, account_id, user_id, opts \\ [])

Deletes custom user settings for a specified user. Deletes the specified custom user settings for a single user. If the custom user settings you want to delete are grouped, you must include the X-DocuSign-User-Settings-Key header 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 X-DocuSign-User-Settings-Key header is not included, only the custom user settings that were added without a group are deleted.

user_custom_settings_get_custom_settings(connection, account_id, user_id, opts \\ [])

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. If the custom user settings you want to retrieve are grouped, you must include the X-DocuSign-User-Settings-Key header 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 X-DocuSign-User-Settings-Key header is not included, only the custom user settings that were added without a group are retrieved.

user_custom_settings_put_custom_settings(connection, account_id, user_id, opts \\ [])

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. 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, include the X-DocuSign-User-Settings-Key header 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. When getting or deleting grouped custom user settings, you must include the X-DocuSign-User-Settings-Key header information. Grouping custom user settings is not required and if the X-DocuSign-User-Settings-Key header information is not included, the custom user settings are added normally and can be retrieved or deleted without including the X-DocuSign-User-Settings-Key header.

Functions

user_custom_settings_delete_custom_settings(connection, account_id, user_id, opts \\ [])

@spec user_custom_settings_delete_custom_settings(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, DocuSign.Model.CustomSettingsInformation.t()}
  | {:ok, DocuSign.Model.ErrorDetails.t()}
  | {:error, Tesla.Env.t()}

Parameters

connection (DocuSign.Connection): Connection to server
account_id (String.t): The external account number (int) or account ID GUID.
user_id (String.t): The ID of the user to access. Note: Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings.
opts (keyword): Optional parameters
- :body (CustomSettingsInformation):

Returns

{:ok, DocuSign.Model.CustomSettingsInformation.t} on success
{:error, Tesla.Env.t} on failure

user_custom_settings_get_custom_settings(connection, account_id, user_id, opts \\ [])

@spec user_custom_settings_get_custom_settings(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, DocuSign.Model.CustomSettingsInformation.t()}
  | {:ok, DocuSign.Model.ErrorDetails.t()}
  | {:error, Tesla.Env.t()}

Parameters

connection (DocuSign.Connection): Connection to server
account_id (String.t): The external account number (int) or account ID GUID.
user_id (String.t): The ID of the user to access. Note: Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings.
opts (keyword): Optional parameters

Returns

{:ok, DocuSign.Model.CustomSettingsInformation.t} on success
{:error, Tesla.Env.t} on failure

user_custom_settings_put_custom_settings(connection, account_id, user_id, opts \\ [])

@spec user_custom_settings_put_custom_settings(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, DocuSign.Model.CustomSettingsInformation.t()}
  | {:ok, DocuSign.Model.ErrorDetails.t()}
  | {:error, Tesla.Env.t()}

Parameters

connection (DocuSign.Connection): Connection to server
account_id (String.t): The external account number (int) or account ID GUID.
user_id (String.t): The ID of the user to access. Note: Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings.
opts (keyword): Optional parameters
- :body (CustomSettingsInformation):

Returns

{:ok, DocuSign.Model.CustomSettingsInformation.t} on success
{:error, Tesla.Env.t} on failure