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

API calls for all endpoints tagged Folders.

Link to this section Summary

Functions

Gets a list of the envelopes in the specified folder. Retrieves a list of the envelopes in the specified folder. You can narrow the query by specifying search criteria in the query string parameters.

Gets a list of the folders for the account. Retrieves a list of the folders for the account, including the folder hierarchy. You can specify whether to return just the template folder or template folder and normal folders by setting the `template` query string parameter.

Moves an envelope from its current folder to the specified folder. Moves an envelope from its current folder to the specified folder. ###### Note: You can use this endpoint to delete envelopes by specifying `recyclebin` in the `folderId` parameter of the endpoint. Placing an in process envelope (envelope status of `sent` or `delivered`) in the recycle bin voids the envelope. You can also use this endpoint to delete templates by specifying a template ID instead of an envelope ID in the 'envelopeIds' property and specifying `recyclebin` in the `folderId` parameter.

Gets a list of envelopes in folders matching the specified criteria. Retrieves a list of envelopes that match the criteria specified in the query. If the user ID of the user making the call is the same as the user ID for any returned recipient, then the userId property is added to the returned information for those recipients.

Link to this section Functions

Link to this function

folders_get_folder_items(connection, account_id, folder_id, opts \\ [])

View Source

Specs

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

Gets a list of the envelopes in the specified folder. Retrieves a list of the envelopes in the specified folder. You can narrow the query by specifying search criteria in the query string parameters.

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.
  • opts (KeywordList): [optional] Optional parameters
    • :from_date (String.t): Only return items on or after this date. If no value is provided, the default search is the previous 30 days.
    • :owner_email (String.t): The email of the folder owner.
    • :owner_name (String.t): The name of the folder owner.
    • :search_text (String.t): The search text used to search the items of the envelope. The search looks at recipient names and emails, envelope custom fields, sender name, and subject.
    • :start_position (String.t): The position of the folder items to return. This is used for repeated calls, when the number of envelopes returned is too much for one return (calls return 100 envelopes at a time). The default value is 0.
    • :status (String.t): A comma-separated list of current envelope statuses to included in the response. Possible values are: completed created declined deleted delivered processing sent signed timedout voided The `any` value is equivalent to any status.
    • :to_date (String.t): Only return items up to this date. If no value is provided, the default search is to the current date.

Returns

} on success {:error, info} on failure

Link to this function

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

View Source

Specs

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

Gets a list of the folders for the account. Retrieves a list of the folders for the account, including the folder hierarchy. You can specify whether to return just the template folder or template folder and normal folders by setting the `template` query string parameter.

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.
    • :start_position (String.t): Reserved for DocuSign.
    • :template (String.t): Specifies the items that are returned. Valid values are: include - The folder list will return normal folders plus template folders. only - Only the list of template folders are returned.
    • :user_filter (String.t): Reserved for DocuSign.

Returns

} on success {:error, info} on failure

Link to this function

folders_put_folder_by_id(connection, account_id, folder_id, opts \\ [])

View Source

Specs

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

Moves an envelope from its current folder to the specified folder. Moves an envelope from its current folder to the specified folder. ###### Note: You can use this endpoint to delete envelopes by specifying `recyclebin` in the `folderId` parameter of the endpoint. Placing an in process envelope (envelope status of `sent` or `delivered`) in the recycle bin voids the envelope. You can also use this endpoint to delete templates by specifying a template ID instead of an envelope ID in the 'envelopeIds' property and specifying `recyclebin` in the `folderId` parameter.

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.
  • opts (KeywordList): [optional] Optional parameters
    • :folders_request (FoldersRequest):

Returns

} on success {:error, info} on failure

Link to this function

search_folders_get_search_folder_contents(connection, account_id, search_folder_id, opts \\ [])

View Source

Specs

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

Gets a list of envelopes in folders matching the specified criteria. Retrieves a list of envelopes that match the criteria specified in the query. If the user ID of the user making the call is the same as the user ID for any returned recipient, then the userId property is added to the returned information for those recipients.

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID Guid.
  • search_folder_id (String.t): Specifies the envelope group that is searched by the request. These are logical groupings, not actual folder names. Valid values are: drafts, awaiting_my_signature, completed, out_for_signature.
  • opts (KeywordList): [optional] Optional parameters
    • :all (String.t): Specifies that all envelopes that match the criteria are returned.
    • :count (String.t): Specifies the number of records returned in the cache. The number must be greater than 0 and less than or equal to 100.
    • :from_date (String.t): Specifies the start of the date range to return. If no value is provided, the default search is the previous 30 days.
    • :include_recipients (String.t): When set to true, the recipient information is returned in the response.
    • :order (String.t): Specifies the order in which the list is returned. Valid values are: `asc` for ascending order, and `desc` for descending order.
    • :order_by (String.t): Specifies the property used to sort the list. Valid values are: `action_required`, `created`, `completed`, `sent`, `signer_list`, `status`, or `subject`.
    • :start_position (String.t): Specifies the the starting location in the result set of the items that are returned.
    • :to_date (String.t): Specifies the end of the date range to return.

Returns

} on success {:error, info} on failure