View Source DocuSign.Api.ChunkedUploads (DocuSign v1.2.0)

API calls for all endpoints tagged ChunkedUploads.

Summary

Functions

chunked_uploads_delete_chunked_upload(connection, account_id, chunked_upload_id, opts \\ [])

Deletes a chunked upload. Deletes a chunked upload that has been committed but not yet consumed. This method cannot be used to delete the following types of chunked uploads, which the system deletes automatically: - Chunked uploads that have been consumed by use in another API call. - Expired chunked uploads. Note: If you are aware of a chunked upload that can be discarded, the best practice is to explicitly delete it. If you wait for the system to automatically delete it after it expires, the chunked upload will continue to count against your quota.

chunked_uploads_get_chunked_upload(connection, account_id, chunked_upload_id, opts \\ [])

Retrieves metadata about a chunked upload. Returns the details (but not the content) about a chunked upload. Note: You cannot obtain details about a chunked upload that has expired, been deleted, or consumed by other actions.

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

Initiate a new chunked upload. This method initiates a new chunked upload with the first part of the content.

chunked_uploads_put_chunked_upload_part(connection, account_id, chunked_upload_id, chunked_upload_part_seq, opts \\ [])

Add a chunk to an existing chunked upload. Adds a chunk or part to an existing chunked upload. After you use the Create method to initiate a new chunked upload and upload the first part, use this method to upload subsequent parts. For simplicity, DocuSign recommends that you upload the parts in their sequential order ( 1,2, 3, 4, etc.). The Create method adds the first part and assigns it the sequence value 0. As a result, DocuSign recommends that you start with a sequence value of 1 when you use this method, and continue uploading parts contiguously until you have uploaded the entirety of the original content to DocuSign. Example: PUT /v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}/1 PUT /v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}/2 PUT /v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}/3 Note: You cannot replace a part that DocuSign has already received, or add parts to a chunked upload that is already successfully committed.

chunked_uploads_put_chunked_uploads(connection, account_id, chunked_upload_id, opts \\ [])

Commit a chunked upload. This method checks the integrity of a chunked upload and then commits it. When this request is successful, the chunked upload is then ready to be referenced in other API calls. If the request is unsuccessful, ensure that you have uploaded all of the parts by using the Update method. Note: After you commit a chunked upload, it no longer accepts additional parts.

Functions

chunked_uploads_delete_chunked_upload(connection, account_id, chunked_upload_id, opts \\ [])

@spec chunked_uploads_delete_chunked_upload(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, DocuSign.Model.ChunkedUploadResponse.t()}
  | {:ok, DocuSign.Model.ErrorDetails.t()}
  | {:error, Tesla.Env.t()}

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): The ID of the chunked upload.
opts (keyword): Optional parameters

Returns

{:ok, DocuSign.Model.ChunkedUploadResponse.t} on success
{:error, Tesla.Env.t} on failure

chunked_uploads_get_chunked_upload(connection, account_id, chunked_upload_id, opts \\ [])

@spec chunked_uploads_get_chunked_upload(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, DocuSign.Model.ChunkedUploadResponse.t()}
  | {:ok, DocuSign.Model.ErrorDetails.t()}
  | {:error, Tesla.Env.t()}

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): The ID of the chunked upload.
opts (keyword): Optional parameters
- :include (String.t): (Optional) This parameter enables you to include additional attribute data in the response. The valid value for this method is checksum, which returns an SHA256 checksum of the content of the chunked upload in the response. You can use compare this checksum against your own checksum of the original content to verify that there are no missing parts before you attempt to commit the chunked upload.

Returns

{:ok, DocuSign.Model.ChunkedUploadResponse.t} on success
{:error, Tesla.Env.t} on failure

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

@spec chunked_uploads_post_chunked_uploads(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, DocuSign.Model.ChunkedUploadResponse.t()}
  | {:ok, DocuSign.Model.ErrorDetails.t()}
  | {:error, Tesla.Env.t()}

Initiate a new chunked upload. This method initiates a new chunked upload with the first part of the content.

Parameters

connection (DocuSign.Connection): Connection to server
account_id (String.t): The external account number (int) or account ID GUID.
opts (keyword): Optional parameters
- :body (ChunkedUploadRequest):

Returns

{:ok, DocuSign.Model.ChunkedUploadResponse.t} on success
{:error, Tesla.Env.t} on failure

chunked_uploads_put_chunked_upload_part(connection, account_id, chunked_upload_id, chunked_upload_part_seq, opts \\ [])

@spec chunked_uploads_put_chunked_upload_part(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, DocuSign.Model.ChunkedUploadResponse.t()}
  | {:ok, DocuSign.Model.ErrorDetails.t()}
  | {:error, Tesla.Env.t()}

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): The ID of the chunked upload.
chunked_upload_part_seq (String.t): The sequence or order of the part in the chunked upload. By default, the sequence of the first part that is uploaded as part of the Create request is 0. Note: You can add parts out of order. However, the chunked upload must consist of a contiguous series of one or more parts before you can successfully commit it.
opts (keyword): Optional parameters
- :body (ChunkedUploadRequest):

Returns

{:ok, DocuSign.Model.ChunkedUploadResponse.t} on success
{:error, Tesla.Env.t} on failure

chunked_uploads_put_chunked_uploads(connection, account_id, chunked_upload_id, opts \\ [])

@spec chunked_uploads_put_chunked_uploads(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, DocuSign.Model.ChunkedUploadResponse.t()}
  | {:ok, DocuSign.Model.ErrorDetails.t()}
  | {:error, Tesla.Env.t()}

Parameters

connection (DocuSign.Connection): Connection to server
account_id (String.t): (Required) The external account number (int) or account ID GUID.
chunked_upload_id (String.t): (Required) The ID of the chunked upload to commit.
opts (keyword): Optional parameters
- :action (String.t): (Required) You must use this query parameter with the value commit, which affirms the request to validate and prepare the chunked upload for use with other API calls.

Returns

{:ok, DocuSign.Model.ChunkedUploadResponse.t} on success
{:error, Tesla.Env.t} on failure