DocuSign.Api.Folders.folders_get_folder_items

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