DocuSign.Api.Folders.search_folders_get_search_folder_contents

You're seeing just the function search_folders_get_search_folder_contents, go back to DocuSign.Api.Folders module for more information.
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