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

API calls for all endpoints tagged CloudStorage.

Link to this section Summary

Functions

Gets a list of all the items from the specified cloud storage provider. Retrieves a list of all the items in all the folders associated with the user from the specified cloud storage provider. You can limit the scope of the returned items by providing a comma separated list of folder IDs in the request.

Retrieves a list of all the items in a specified folder from the specified cloud storage provider. Retrieves a list of all the items in a specified folder from the specified cloud storage provider.

Link to this section Functions

Link to this function

cloud_storage_folder_get_cloud_storage_folder(connection, account_id, folder_id, service_id, user_id, opts \\ [])

View Source

Specs

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

Gets a list of all the items from the specified cloud storage provider. Retrieves a list of all the items in all the folders associated with the user from the specified cloud storage provider. You can limit the scope of the returned items by providing a comma separated list of folder IDs in the request.

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID Guid.
  • folder_id (String.t): The ID of the folder being accessed.
  • service_id (String.t): The ID of the service to access. Valid values are the service name ("Box") or the numerical serviceId ("4136").
  • user_id (String.t): 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.
  • opts (KeywordList): [optional] Optional parameters
    • :cloud_storage_folder_path (String.t):
    • :count (String.t): An optional value that sets how many items are included in the response. The default setting for this is 25.
    • :order (String.t): An optional value that sets the direction order used to sort the item list. Valid values are: asc = ascending sort order desc = descending sort order
    • :order_by (String.t): An optional value that sets the file attribute used to sort the item list. Valid values are: modified name
    • :search_text (String.t):
    • :start_position (String.t): Indicates the starting point of the first item included in the response set. It uses a 0-based index. The default setting for this is 0.

Returns

} on success {:error, info} on failure

Link to this function

cloud_storage_folder_get_cloud_storage_folder_all(connection, account_id, service_id, user_id, opts \\ [])

View Source

Specs

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

Retrieves a list of all the items in a specified folder from the specified cloud storage provider. Retrieves a list of all the items in a specified folder from the specified cloud storage provider.

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID Guid.
  • service_id (String.t): The ID of the service to access. Valid values are the service name ("Box") or the numerical serviceId ("4136").
  • user_id (String.t): 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.
  • opts (KeywordList): [optional] Optional parameters
    • :cloud_storage_folder_path (String.t): A comma separated list of folder IDs included in the request.
    • :count (String.t): An optional value that sets how many items are included in the response. The default setting for this is 25.
    • :order (String.t): An optional value that sets the direction order used to sort the item list. Valid values are: asc = ascending sort order desc = descending sort order
    • :order_by (String.t): An optional value that sets the file attribute used to sort the item list. Valid values are: modified name
    • :search_text (String.t):
    • :start_position (String.t): Indicates the starting point of the first item included in the response set. It uses a 0-based index. The default setting for this is 0.

Returns

} on success {:error, info} on failure