DocuSign.Api.BulkEnvelopes.bulk_envelopes_get_bulk_envelopes_batch_id
You're seeing just the function
bulk_envelopes_get_bulk_envelopes_batch_id
, go back to DocuSign.Api.BulkEnvelopes module for more information.
Link to this function
bulk_envelopes_get_bulk_envelopes_batch_id(connection, account_id, batch_id, opts \\ [])
View SourceSpecs
bulk_envelopes_get_bulk_envelopes_batch_id( Tesla.Env.client(), String.t(), String.t(), keyword() ) :: {:ok, DocuSign.Model.BulkEnvelopeStatus.t()} | {:error, Tesla.Env.t()}
Gets the status of a specified bulk send operation. Retrieves the status information of a single bulk recipient batch. A bulk recipient batch is the set of envelopes sent from a single bulk recipient file.
Parameters
- connection (DocuSign.Connection): Connection to server
- account_id (String.t): The external account number (int) or account ID Guid.
- batch_id (String.t):
- opts (KeywordList): [optional] Optional parameters
- :count (String.t): Specifies the number of entries to return.
- :include (String.t): Specifies which entries are included in the response. Multiple entries can be included by using commas in the query string (example: ?include="failed,queued") Valid values: all - Returns all entries. If present, overrides all other query settings. This is the default if no query string is provided. failed - Entries with a failed status. processing - Entries with a processing status. queued - Entries with a queued status. * sent - Entries with a sent status.
- :start_position (String.t): Specifies the location in the list of envelopes from which to start.
Returns
} on success {:error, info} on failure