@superdurable/connector-docusign 0.0.0-stage → 0.1.0

package/dist/connection-YEptevxS.d.ts

@@ -0,0 +1,363 @@
+import { RefreshingCredentialProvider, SecretString, Mutation, Query, ConnectionRef } from '@superdurable/connectors-sdk';
+import { z } from 'zod';
+
+/** Connector configuration; omitted fields use manifest defaults. */
+interface Config {
+    /** DocuSign API account ID that every envelope is sent from, a GUID such as 00000000-0000-0000-0000-000000000000. Find it after signing in at https://apps.docusign.com/admin/apps-and-keys, or https://apps-d.docusign.com/admin/apps-and-keys for the developer environment, under My Account Information > API Account ID. It is not secret. Blank uses the account that DocuSign marks as the authorizing user's default; enter an ID only when that user belongs to several accounts. */
+    accountId?: string;
+    /** Largest DocuSign API JSON response body, in bytes, that one call reads; a larger envelope or recipient response selects invalidResponse. Enter a positive integer only to raise or lower this safety limit, for example for envelopes with very many recipients. Blank uses the default. */
+    maxResponseBytes?: number;
+    /** Largest combined PDF, in bytes, that downloadCombinedDocument streams through its SHA-256 digest; a larger document selects tooLarge without reading the rest. Enter a positive integer only when envelopes carry very large documents. Blank uses the default. */
+    maxDocumentBytes?: number;
+    /** Largest DocuSign Connect request body, in bytes, that the envelopeEventReceived endpoint accepts; a larger body is answered 413 before its HMAC signature is checked. Raise it only when the Connect configuration includes large envelope data such as many recipients or tabs; never include documents. Blank uses the default. */
+    connectMaxBodyBytes?: number;
+}
+/** Runtime schema for manifest configuration. */
+declare const ConfigSchema: z.ZodObject<{
+    accountId: z.ZodOptional<z.ZodString>;
+    maxResponseBytes: z.ZodOptional<z.ZodNumber>;
+    maxDocumentBytes: z.ZodOptional<z.ZodNumber>;
+    connectMaxBodyBytes: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strip>;
+/** Private connector credentials resolved by the host. */
+interface Credentials {
+    /** Selected authorization method. */
+    authMethodId?: string;
+    /** Secret DocuSign access token produced automatically by authorization; it lasts eight hours and Dex refreshes it before expiry, so never enter it manually. */
+    accessToken: SecretString;
+    /** Secret DocuSign Connect HMAC key that verifies X-DocuSign-Signature headers on envelopeEventReceived deliveries. Create it after signing in at https://apps.docusign.com/admin/admin-dashboard, or https://apps-d.docusign.com/admin/admin-dashboard for the developer environment, under Integrations > Connect > Connect Keys > Add Secret Key, copy the whole value exactly as shown (an opaque string that DocuSign shows in full only once, and later only its first four characters), and enable Include HMAC Signature on the Connect configuration. To rotate it, add a new key, enter it here, then choose Remove next to the old key: DocuSign signs with every key and one match is enough, so no delivery is refused. Blank is fine for operations only; the Connect endpoint then answers 503 so DocuSign retries. */
+    connectHmacKey?: SecretString;
+    /** Non-secret integration key of your DocuSign app, a GUID copied after signing in at https://apps.docusign.com/admin/apps-and-keys (Settings > Integrations > Apps and Keys > the app > Integration Key), or from the app in the Developer Console at https://apps.docusign.com/dev-console/integrations; blank means authorization and refresh cannot start. */
+    oauthClientId: string;
+    /** Secret key of the same DocuSign app, a GUID such as 00000000-0000-0000-0000-000000000000, created under Authentication > Secret Keys > Add Secret Key at https://apps.docusign.com/admin/apps-and-keys and shown only once; Dex stores it only in this credential field, and blank means authorization and refresh cannot start. An app can hold several secret keys, so to rotate or revoke one, add a new key, enter it here, then delete the old key on the same page; DocuSign can take up to five minutes to apply the change. */
+    oauthClientSecret: SecretString;
+    /** Secret DocuSign refresh token produced automatically by authorization; the extended scope makes every refresh issue a new 30-day token, so never enter it manually, and a blank or rejected token means the connection must be authorized again. */
+    refreshToken: SecretString;
+}
+/** Decode private credential fields for the selected authorization method. */
+declare function decodeCredentials(value: unknown): Credentials;
+/** Decode shared credential fields for the selected authorization method. */
+declare function decodeSharedCredentials(value: unknown): Credentials;
+/** Host-owned source of private connector credentials. */
+type CredentialSource = RefreshingCredentialProvider<Credentials>;
+/** TemplateRole assigns one person to a template role. */
+interface TemplateRole {
+    /** RoleName is the template's role name, such as Customer, matched as DocuSign matches it. */
+    "roleName": string;
+    /** Name is the recipient's full name, 1 to 100 characters. */
+    "name": string;
+    /** Email is the recipient's email address, at most 100 characters. */
+    "email": string;
+    /** RoutingOrder overrides the role's routing order, 1 to 999; zero keeps the template's order, which
+     * decides who is asked to sign first. */
+    "routingOrder"?: number | undefined;
+}
+/** EnvelopeCustomField is one envelope text custom field, hidden from recipients, such as a correlation
+   * ID that a Connect event carries back. */
+interface EnvelopeCustomField {
+    /** Name is the field name, 1 to 50 characters. */
+    "name": string;
+    /** Value is the field value, at most 100 characters. */
+    "value": string;
+}
+/** CreateEnvelopeFromTemplateInput describes one envelope created from a DocuSign server template. */
+interface CreateEnvelopeFromTemplateInput {
+    /** TemplateID is the server template's GUID, shown in DocuSign under Templates > the template >
+     * Template ID. */
+    "templateId": string;
+    /** TemplateRoles fills the template's roles by name, 1 to 100 of them. Every role the template
+     * requires must be filled. */
+    "templateRoles": Array<TemplateRole> | null;
+    /** EmailSubject overrides the template's email subject, at most 100 characters; blank keeps it. */
+    "emailSubject"?: string | undefined;
+    /** EmailBlurb overrides the template's email message, at most 10,000 characters; blank keeps it. */
+    "emailBlurb"?: string | undefined;
+    /** IsDraft creates the envelope with status created and sends nothing; false sends it at once. */
+    "isDraft"?: boolean | undefined;
+    /** CustomFields adds hidden text custom fields, at most 10, such as a correlation ID that Connect
+     * events return. Names are 1 to 50 characters and unique; dexIdempotencyKey is reserved. */
+    "customFields"?: Array<EnvelopeCustomField> | undefined;
+}
+/** CreatedEnvelope identifies the envelope that createEnvelopeFromTemplate created. */
+interface CreatedEnvelope {
+    /** EnvelopeID is the new envelope's GUID. */
+    "envelopeId": string;
+    /** Status is sent, or created for a draft. */
+    "status": "completed" | "created" | "declined" | "delivered" | "sent" | "signed" | "voided" | (string & {});
+    /** StatusChangedAt is when DocuSign recorded Status, when it said. */
+    "statusChangedAt"?: string | null | undefined;
+    /** WasRecovered is true when an attempt whose answer was lost created the envelope and this attempt
+     * found it by its dexIdempotencyKey custom field instead of creating another. */
+    "wasRecovered"?: boolean | undefined;
+}
+/** GetEnvelopeInput names the envelope to read. */
+interface GetEnvelopeInput {
+    /** EnvelopeID is the envelope's GUID, such as a createEnvelopeFromTemplate Result's envelopeId. */
+    "envelopeId": string;
+}
+/** Envelope is one DocuSign envelope's status and timestamps. Each timestamp is nil until DocuSign
+   * records the matching transition. */
+interface Envelope {
+    /** EnvelopeID is the envelope's GUID. */
+    "envelopeId": string;
+    /** Status is DocuSign's current status. */
+    "status": "completed" | "created" | "declined" | "delivered" | "sent" | "signed" | "voided" | (string & {});
+    /** EmailSubject is the subject of the envelope's email. */
+    "emailSubject"?: string | undefined;
+    /** CreatedAt is when the envelope was created. */
+    "createdAt"?: string | null | undefined;
+    /** SentAt is when DocuSign sent the envelope. */
+    "sentAt"?: string | null | undefined;
+    /** DeliveredAt is when every current recipient had opened it. */
+    "deliveredAt"?: string | null | undefined;
+    /** CompletedAt is when the last recipient finished. */
+    "completedAt"?: string | null | undefined;
+    /** DeclinedAt is when a recipient declined. */
+    "declinedAt"?: string | null | undefined;
+    /** VoidedAt is when the envelope was voided or expired. */
+    "voidedAt"?: string | null | undefined;
+    /** StatusChangedAt is when Status last changed. */
+    "statusChangedAt"?: string | null | undefined;
+    /** ExpiresAt is when an unfinished envelope expires and DocuSign voids it. */
+    "expiresAt"?: string | null | undefined;
+    /** VoidedReason is the void reason the sender gave or DocuSign recorded for an expiry. */
+    "voidedReason"?: string | undefined;
+    /** CustomFields holds the envelope's text custom fields, including the connector's dexIdempotencyKey. */
+    "customFields"?: Array<EnvelopeCustomField> | undefined;
+}
+/** ListEnvelopeRecipientsInput names the envelope whose recipients to list. */
+interface ListEnvelopeRecipientsInput {
+    /** EnvelopeID is the envelope's GUID. */
+    "envelopeId": string;
+}
+/** Recipient is one envelope recipient's identity, place in the routing order, and progress. Access
+   * codes and authentication details are never read. */
+interface Recipient {
+    /** RecipientID is the recipient's ID within the envelope, such as 1. */
+    "recipientId": string;
+    /** Type is the recipient's collection, such as signer or carbonCopy. */
+    "type": "agent" | "carbonCopy" | "certifiedDelivery" | "editor" | "inPersonSigner" | "intermediary" | "signer" | "witness" | (string & {});
+    /** Name is the recipient's name. */
+    "name"?: string | undefined;
+    /** Email is the recipient's email address. */
+    "email"?: string | undefined;
+    /** RoleName is the template role the recipient fills, if any. */
+    "roleName"?: string | undefined;
+    /** RoutingOrder is the recipient's routing order; recipients with the same order receive it together. */
+    "routingOrder": number;
+    /** Status is DocuSign's recipient status, such as created, sent, delivered, completed, or declined. */
+    "status": string;
+    /** SentAt is when DocuSign sent the envelope to this recipient. */
+    "sentAt"?: string | null | undefined;
+    /** DeliveredAt is when the recipient opened it. */
+    "deliveredAt"?: string | null | undefined;
+    /** SignedAt is when the recipient finished. */
+    "signedAt"?: string | null | undefined;
+    /** DeclinedAt is when the recipient declined. */
+    "declinedAt"?: string | null | undefined;
+    /** DeclinedReason is the reason the recipient gave for declining. */
+    "declinedReason"?: string | undefined;
+}
+/** EnvelopeRecipients is one envelope's recipients sorted by routing order and then recipient ID. */
+interface EnvelopeRecipients {
+    /** EnvelopeID is the envelope's GUID. */
+    "envelopeId": string;
+    /** CurrentRoutingOrder is the routing order DocuSign is waiting on; zero when DocuSign did not say. */
+    "currentRoutingOrder"?: number | undefined;
+    /** Recipients lists every recipient of the types RecipientType names. */
+    "recipients": Array<Recipient> | null;
+}
+/** VoidEnvelopeInput names the envelope to void and why. */
+interface VoidEnvelopeInput {
+    /** EnvelopeID is the envelope's GUID. */
+    "envelopeId": string;
+    /** VoidedReason is shown to the recipients, 1 to 200 characters, such as "Signing deadline passed". */
+    "voidedReason": string;
+}
+/** VoidedEnvelope is the outcome of voidEnvelope. */
+interface VoidedEnvelope {
+    /** EnvelopeID is the envelope's GUID. */
+    "envelopeId": string;
+    /** WasAlreadyVoided is true when the envelope was voided before this call, such as by an earlier
+     * attempt of the same Step, by its sender, or by expiry. */
+    "wasAlreadyVoided"?: boolean | undefined;
+    /** Status is the envelope's status read back after DocuSign refused the void: voided, or on the
+     * notVoidable branch completed, declined, or created. It is empty when this call voided it. */
+    "status"?: "completed" | "created" | "declined" | "delivered" | "sent" | "signed" | "voided" | (string & {}) | undefined;
+    /** VoidedReason is the reason DocuSign holds for an envelope that was already voided. */
+    "voidedReason"?: string | undefined;
+}
+/** DownloadCombinedDocumentInput names the envelope whose documents to download. */
+interface DownloadCombinedDocumentInput {
+    /** EnvelopeID is the envelope's GUID, normally of a completed envelope. */
+    "envelopeId": string;
+    /** IncludeCertificate appends DocuSign's certificate of completion to the combined PDF. */
+    "includeCertificate"?: boolean | undefined;
+}
+/** CombinedDocument describes one downloaded combined PDF; it never holds the PDF's bytes. */
+interface CombinedDocument {
+    /** EnvelopeID is the envelope's GUID. */
+    "envelopeId": string;
+    /** ContentType is application/pdf. */
+    "contentType": string;
+    /** ByteCount is the PDF's size in bytes. */
+    "byteCount": number;
+    /** SHA256 is the lowercase hexadecimal SHA-256 digest of the PDF's bytes. */
+    "sha256": string;
+    /** IncludesCertificate is true when the PDF ends with the certificate of completion. */
+    "includesCertificate"?: boolean | undefined;
+    /** StoredLocation is where the CombinedDocumentStore put the PDF; blank without a store. */
+    "storedLocation"?: string | undefined;
+}
+/** Runtime validator for TemplateRole. */
+declare const TemplateRoleSchema: z.ZodObject<{
+    roleName: z.ZodString;
+    name: z.ZodString;
+    email: z.ZodString;
+    routingOrder: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strict>;
+/** Runtime validator for EnvelopeCustomField. */
+declare const EnvelopeCustomFieldSchema: z.ZodObject<{
+    name: z.ZodString;
+    value: z.ZodString;
+}, z.core.$strict>;
+/** Runtime validator for CreateEnvelopeFromTemplateInput. */
+declare const CreateEnvelopeFromTemplateInputSchema: z.ZodObject<{
+    templateId: z.ZodString;
+    templateRoles: z.ZodNullable<z.ZodArray<z.ZodObject<{
+        roleName: z.ZodString;
+        name: z.ZodString;
+        email: z.ZodString;
+        routingOrder: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strict>>>;
+    emailSubject: z.ZodOptional<z.ZodString>;
+    emailBlurb: z.ZodOptional<z.ZodString>;
+    isDraft: z.ZodOptional<z.ZodBoolean>;
+    customFields: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        value: z.ZodString;
+    }, z.core.$strict>>>;
+}, z.core.$strict>;
+/** Runtime validator for CreatedEnvelope. */
+declare const CreatedEnvelopeSchema: z.ZodObject<{
+    envelopeId: z.ZodString;
+    status: z.ZodString;
+    statusChangedAt: z.ZodOptional<z.ZodNullable<z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>>>;
+    wasRecovered: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$strict>;
+/** Runtime validator for GetEnvelopeInput. */
+declare const GetEnvelopeInputSchema: z.ZodObject<{
+    envelopeId: z.ZodString;
+}, z.core.$strict>;
+/** Runtime validator for Envelope. */
+declare const EnvelopeSchema: z.ZodObject<{
+    envelopeId: z.ZodString;
+    status: z.ZodString;
+    emailSubject: z.ZodOptional<z.ZodString>;
+    createdAt: z.ZodOptional<z.ZodNullable<z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>>>;
+    sentAt: z.ZodOptional<z.ZodNullable<z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>>>;
+    deliveredAt: z.ZodOptional<z.ZodNullable<z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>>>;
+    completedAt: z.ZodOptional<z.ZodNullable<z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>>>;
+    declinedAt: z.ZodOptional<z.ZodNullable<z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>>>;
+    voidedAt: z.ZodOptional<z.ZodNullable<z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>>>;
+    statusChangedAt: z.ZodOptional<z.ZodNullable<z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>>>;
+    expiresAt: z.ZodOptional<z.ZodNullable<z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>>>;
+    voidedReason: z.ZodOptional<z.ZodString>;
+    customFields: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        value: z.ZodString;
+    }, z.core.$strict>>>;
+}, z.core.$strict>;
+/** Runtime validator for ListEnvelopeRecipientsInput. */
+declare const ListEnvelopeRecipientsInputSchema: z.ZodObject<{
+    envelopeId: z.ZodString;
+}, z.core.$strict>;
+/** Runtime validator for Recipient. */
+declare const RecipientSchema: z.ZodObject<{
+    recipientId: z.ZodString;
+    type: z.ZodString;
+    name: z.ZodOptional<z.ZodString>;
+    email: z.ZodOptional<z.ZodString>;
+    roleName: z.ZodOptional<z.ZodString>;
+    routingOrder: z.ZodNumber;
+    status: z.ZodString;
+    sentAt: z.ZodOptional<z.ZodNullable<z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>>>;
+    deliveredAt: z.ZodOptional<z.ZodNullable<z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>>>;
+    signedAt: z.ZodOptional<z.ZodNullable<z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>>>;
+    declinedAt: z.ZodOptional<z.ZodNullable<z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>>>;
+    declinedReason: z.ZodOptional<z.ZodString>;
+}, z.core.$strict>;
+/** Runtime validator for EnvelopeRecipients. */
+declare const EnvelopeRecipientsSchema: z.ZodObject<{
+    envelopeId: z.ZodString;
+    currentRoutingOrder: z.ZodOptional<z.ZodNumber>;
+    recipients: z.ZodNullable<z.ZodArray<z.ZodObject<{
+        recipientId: z.ZodString;
+        type: z.ZodString;
+        name: z.ZodOptional<z.ZodString>;
+        email: z.ZodOptional<z.ZodString>;
+        roleName: z.ZodOptional<z.ZodString>;
+        routingOrder: z.ZodNumber;
+        status: z.ZodString;
+        sentAt: z.ZodOptional<z.ZodNullable<z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>>>;
+        deliveredAt: z.ZodOptional<z.ZodNullable<z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>>>;
+        signedAt: z.ZodOptional<z.ZodNullable<z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>>>;
+        declinedAt: z.ZodOptional<z.ZodNullable<z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>>>;
+        declinedReason: z.ZodOptional<z.ZodString>;
+    }, z.core.$strict>>>;
+}, z.core.$strict>;
+/** Runtime validator for VoidEnvelopeInput. */
+declare const VoidEnvelopeInputSchema: z.ZodObject<{
+    envelopeId: z.ZodString;
+    voidedReason: z.ZodString;
+}, z.core.$strict>;
+/** Runtime validator for VoidedEnvelope. */
+declare const VoidedEnvelopeSchema: z.ZodObject<{
+    envelopeId: z.ZodString;
+    wasAlreadyVoided: z.ZodOptional<z.ZodBoolean>;
+    status: z.ZodOptional<z.ZodString>;
+    voidedReason: z.ZodOptional<z.ZodString>;
+}, z.core.$strict>;
+/** Runtime validator for DownloadCombinedDocumentInput. */
+declare const DownloadCombinedDocumentInputSchema: z.ZodObject<{
+    envelopeId: z.ZodString;
+    includeCertificate: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$strict>;
+/** Runtime validator for CombinedDocument. */
+declare const CombinedDocumentSchema: z.ZodObject<{
+    envelopeId: z.ZodString;
+    contentType: z.ZodString;
+    byteCount: z.ZodNumber;
+    sha256: z.ZodString;
+    includesCertificate: z.ZodOptional<z.ZodBoolean>;
+    storedLocation: z.ZodOptional<z.ZodString>;
+}, z.core.$strict>;
+
+/** Typed operations supplied by a client or mock. */
+interface Operations {
+    /** Invoke createEnvelopeFromTemplate through this connection. */
+    createEnvelopeFromTemplate(): Mutation<CreateEnvelopeFromTemplateInput, CreatedEnvelope>;
+    /** Invoke getEnvelope through this connection. */
+    getEnvelope(): Query<GetEnvelopeInput, Envelope>;
+    /** Invoke listEnvelopeRecipients through this connection. */
+    listEnvelopeRecipients(): Query<ListEnvelopeRecipientsInput, EnvelopeRecipients>;
+    /** Invoke voidEnvelope through this connection. */
+    voidEnvelope(): Mutation<VoidEnvelopeInput, VoidedEnvelope>;
+    /** Invoke downloadCombinedDocument through this connection. */
+    downloadCombinedDocument(): Query<DownloadCombinedDocumentInput, CombinedDocument>;
+}
+/** Named connector connection kept outside Flow state. */
+declare class Connection<BoundOperations = Operations> {
+    /** Stable provider and connection name. */
+    readonly reference: ConnectionRef;
+    /** Bound provider operations. */
+    readonly operations: BoundOperations;
+    /** Validate a reference and bind operations. */
+    constructor(reference: ConnectionRef, operations: BoundOperations);
+}
+/** Bind a client to a named connection. */
+declare function newConnection(client: Operations, reference: ConnectionRef): Connection;
+/** Bind scripted operations to a named connection. */
+declare function newConnectionWithOperations(operations: Operations, reference: ConnectionRef): Connection;
+
+export { newConnectionWithOperations as A, type CreateEnvelopeFromTemplateInput as C, type DownloadCombinedDocumentInput as D, type Envelope as E, type GetEnvelopeInput as G, type ListEnvelopeRecipientsInput as L, type Operations as O, type Recipient as R, type TemplateRole as T, type VoidEnvelopeInput as V, type CreatedEnvelope as a, Connection as b, type CombinedDocument as c, type EnvelopeRecipients as d, type VoidedEnvelope as e, type CredentialSource as f, type Config as g, type Credentials as h, CombinedDocumentSchema as i, ConfigSchema as j, CreateEnvelopeFromTemplateInputSchema as k, CreatedEnvelopeSchema as l, DownloadCombinedDocumentInputSchema as m, type EnvelopeCustomField as n, EnvelopeCustomFieldSchema as o, EnvelopeRecipientsSchema as p, EnvelopeSchema as q, GetEnvelopeInputSchema as r, ListEnvelopeRecipientsInputSchema as s, RecipientSchema as t, TemplateRoleSchema as u, VoidEnvelopeInputSchema as v, VoidedEnvelopeSchema as w, decodeCredentials as x, decodeSharedCredentials as y, newConnection as z };