DocuSign: Downloads a document at an order within the agreement
DocuSign click.clickSupplementalUserAgreementsGetAgreementDocument: arguments, response, policy and SDK examples.
← Click operations · Get started
Operation docusign.click_supplemental_useragreements_getagreementdocument
Provider route: GET /clickapi/v1/accounts/{accountId}/clickwraps/{clickwrapId}/versions/{versionId}/documents/{orderOrDisclosure}. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/docusign with npm, or alter-sdk-docusign with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { DocuSignIntegration } from "@alter-ai/docusign";
async function execute(input: Parameters<DocuSignIntegration["click"]["clickSupplementalUserAgreementsGetAgreementDocument"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new DocuSignIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.click.clickSupplementalUserAgreementsGetAgreementDocument(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_docusign import DocuSignIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = DocuSignIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.click.click_supplemental_user_agreements_get_agreement_document(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.accountId | string | Required within parent | |
path.clickwrapId | string | Required within parent | |
path.orderOrDisclosure | string | Required within parent | |
path.versionId | string | Required within parent |
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Downloads a document at an order within the agreement — response body |
Referenced models: Downloads a document at an order within the agreement — response body
Schemas
Section titled “Schemas”Downloads a document at an order within the agreement — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Information about a document. |
documentBase64 | string | Optional | The base64-encoded contents of the document. |
documentDisplay | string | Optional | Display type: link or document |
documentHtml | string | Optional | The HTML representation of the document. |
documentName | string | Optional | The name of the document. |
fileExtension | string | Optional | The file extension of the document. |
mustRead | boolean | Optional | **True** if the user needs to scroll to the end of the document. |
mustView | boolean | Optional | Reserved for DocuSign. |
order | JSON | Optional | |
order (anyOf 1) | integer | Alternative | The order of document layout. Format: int32 |
order (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: docusign.click_supplemental_useragreements_getagreementdocument. Catalog operation: click_supplemental:UserAgreements_GetAgreementDocument. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.