DocuSign.Api.AccountPermissionProfiles (DocuSign v0.3.3) View Source

API calls for all endpoints tagged AccountPermissionProfiles.

Link to this section Summary

Functions

Gets a list of permission profiles. Retrieves a list of Permission Profiles. Permission Profiles are a standard set of user permissions that you can apply to individual users or users in a Group. This makes it easier to manage user permissions for a large number of users, without having to change permissions on a user-by-user basis. Currently, Permission Profiles can only be created and modified in the DocuSign console.

Creates a new permission profile in the specified account.

Link to this section Functions

Link to this function

permission_profiles_delete_permission_profiles(connection, account_id, permission_profile_id, opts \\ [])

View Source

Specs

permission_profiles_delete_permission_profiles(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword()
) :: {:ok, nil} | {:error, Tesla.Env.t()}

Deletes a permissions profile within the specified account.

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID Guid.
  • permission_profile_id (String.t):
  • opts (KeywordList): [optional] Optional parameters

Returns

} on success {:error, info} on failure

Link to this function

permission_profiles_get_permission_profile(connection, account_id, permission_profile_id, opts \\ [])

View Source

Specs

permission_profiles_get_permission_profile(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, DocuSign.Model.AccountPermissionProfiles.t()} | {:error, Tesla.Env.t()}

Returns a permissions profile in the specified account.

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID Guid.
  • permission_profile_id (String.t):
  • opts (KeywordList): [optional] Optional parameters
    • :include (String.t): A comma-separated list of additional template attributes to include in the response. Valid values are: recipients, folders, documents, custom_fields, and notifications.

Returns

} on success {:error, info} on failure

Link to this function

permission_profiles_get_permission_profiles(connection, account_id, opts \\ [])

View Source

Specs

permission_profiles_get_permission_profiles(
  Tesla.Env.client(),
  String.t(),
  keyword()
) ::
  {:ok, DocuSign.Model.PermissionProfileInformation.t()}
  | {:error, Tesla.Env.t()}

Gets a list of permission profiles. Retrieves a list of Permission Profiles. Permission Profiles are a standard set of user permissions that you can apply to individual users or users in a Group. This makes it easier to manage user permissions for a large number of users, without having to change permissions on a user-by-user basis. Currently, Permission Profiles can only be created and modified in the DocuSign console.

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID Guid.
  • opts (KeywordList): [optional] Optional parameters
    • :include (String.t): Reserved for DocuSign.

Returns

} on success {:error, info} on failure

Link to this function

permission_profiles_post_permission_profiles(connection, account_id, opts \\ [])

View Source

Specs

permission_profiles_post_permission_profiles(
  Tesla.Env.client(),
  String.t(),
  keyword()
) ::
  {:ok, DocuSign.Model.AccountPermissionProfiles.t()} | {:error, Tesla.Env.t()}

Creates a new permission profile in the specified account.

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID Guid.
  • opts (KeywordList): [optional] Optional parameters
    • :include (String.t): A comma-separated list of additional template attributes to include in the response. Valid values are: recipients, folders, documents, custom_fields, and notifications.
    • :account_permission_profiles (AccountPermissionProfiles):

Returns

} on success {:error, info} on failure

Link to this function

permission_profiles_put_permission_profiles(connection, account_id, permission_profile_id, opts \\ [])

View Source

Specs

permission_profiles_put_permission_profiles(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, DocuSign.Model.AccountPermissionProfiles.t()} | {:error, Tesla.Env.t()}

Updates a permission profile within the specified account.

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID Guid.
  • permission_profile_id (String.t):
  • opts (KeywordList): [optional] Optional parameters
    • :include (String.t): A comma-separated list of additional template attributes to include in the response. Valid values are: recipients, folders, documents, custom_fields, and notifications.
    • :account_permission_profiles (AccountPermissionProfiles):

Returns

} on success {:error, info} on failure