DocuSign v0.1.2 DocuSign.Api.ChunkedUploads View Source
API calls for all endpoints tagged ChunkedUploads
.
Link to this section Summary
Functions
Delete an existing ChunkedUpload
Retrieves the current metadata of a ChunkedUpload
Initiate a new ChunkedUpload
Add a chunk, a chunk 'part', to an existing ChunkedUpload
Integrity-Check and Commit a ChunkedUpload, readying it for use elsewhere
Link to this section Functions
chunked_uploads_delete_chunked_upload( Tesla.Env.client(), String.t(), String.t(), keyword() ) :: {:ok, DocuSign.Model.ChunkedUploads.t()} | {:error, Tesla.Env.t()}
Delete an existing ChunkedUpload.
Parameters
- connection (DocuSign.Connection): Connection to server
- account_id (String.t): The external account number (int) or account ID Guid.
- chunked_upload_id (String.t):
- opts (KeywordList): [optional] Optional parameters
Returns
{:ok, %DocuSign.Model.ChunkedUploads{}} on success {:error, info} on failure
chunked_uploads_get_chunked_upload( Tesla.Env.client(), String.t(), String.t(), keyword() ) :: {:ok, DocuSign.Model.ChunkedUploads.t()} | {:error, Tesla.Env.t()}
Retrieves the current metadata of a ChunkedUpload.
Parameters
- connection (DocuSign.Connection): Connection to server
- account_id (String.t): The external account number (int) or account ID Guid.
- chunked_upload_id (String.t):
opts (KeywordList): [optional] Optional parameters
- :include (String.t): A comma-separated list of additional template attributes to include in the response. Valid values are: recipients, folders, documents, custom_fields, and notifications.
Returns
{:ok, %DocuSign.Model.ChunkedUploads{}} on success {:error, info} on failure
chunked_uploads_post_chunked_uploads(Tesla.Env.client(), String.t(), keyword()) :: {:ok, DocuSign.Model.ChunkedUploads.t()} | {:error, Tesla.Env.t()}
Initiate a new ChunkedUpload.
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
- :chunked_upload_request (ChunkedUploadRequest):
Returns
{:ok, %DocuSign.Model.ChunkedUploads{}} on success {:error, info} on failure
chunked_uploads_put_chunked_upload_part( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword() ) :: {:ok, DocuSign.Model.ChunkedUploads.t()} | {:error, Tesla.Env.t()}
Add a chunk, a chunk 'part', to an existing ChunkedUpload.
Parameters
- connection (DocuSign.Connection): Connection to server
- account_id (String.t): The external account number (int) or account ID Guid.
- chunked_upload_id (String.t):
- chunked_upload_part_seq (String.t):
opts (KeywordList): [optional] Optional parameters
- :chunked_upload_request (ChunkedUploadRequest):
Returns
{:ok, %DocuSign.Model.ChunkedUploads{}} on success {:error, info} on failure
chunked_uploads_put_chunked_uploads( Tesla.Env.client(), String.t(), String.t(), keyword() ) :: {:ok, DocuSign.Model.ChunkedUploads.t()} | {:error, Tesla.Env.t()}
Integrity-Check and Commit a ChunkedUpload, readying it for use elsewhere.
Parameters
- connection (DocuSign.Connection): Connection to server
- account_id (String.t): The external account number (int) or account ID Guid.
- chunked_upload_id (String.t):
opts (KeywordList): [optional] Optional parameters
- :action (String.t):
Returns
{:ok, %DocuSign.Model.ChunkedUploads{}} on success {:error, info} on failure