@anvilco/types 0.2.0 → 0.2.1

package/dist/index.d.cts

@@ -3,6 +3,34 @@
  * Do not make direct changes to the file.
  */
 interface paths {
+    '/api/document-group/{documentGroupEid}.zip': {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Download a document group's files as a zip
+         * @description Downloads every file in a document group as a single zip archive: for
+         *     example, the signed documents of an Etch signature packet, from its
+         *     `documentGroup.eid`.
+         *
+         *     Instead of streaming the zip, the response may be a `302` redirect to
+         *     a short-lived signed URL for it. Follow redirects to get the file.
+         *
+         *     Requires API key (Basic auth) or OAuth authentication. Public OAuth
+         *     clients need the `mcp:full` scope; no narrower scope covers this route.
+         */
+        get: operations['downloadDocuments'];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     '/api/v1/fill/{castEid}.pdf': {
         parameters: {
             query?: never;
@@ -72,6 +100,133 @@ interface paths {
 }
 interface components {
     schemas: {
+        /** @description A signer in createEtchPacket's `signers` argument: who signs, which fields they sign, and how. */
+        EtchSigner: {
+            id: string;
+            /** Format: displayableShortText */
+            name?: string;
+            /** Format: email */
+            email?: string;
+            routingOrder?: number;
+            isPending?: boolean;
+            /** @enum {string} */
+            signatureMode?: 'draw' | 'text';
+            acceptEachField?: boolean;
+            showFinishSigningButton?: boolean;
+            addUuidToSignatures?: boolean;
+            addTimestampToSignatures?: boolean;
+            /** @enum {string} */
+            signatureImageVerticalJustificationDefault?: 'dynamic' | 'bottom' | 'none';
+            /** @enum {string} */
+            signatureExperience?: 'signBeforeReviewing' | 'signWhileReviewing' | 'acknowledgeOnly' | 'formCompletionOnly';
+            fields?: ({
+                fileId: string;
+                fieldId: string;
+                /** @enum {string} */
+                signatureImageVerticalJustification?: 'dynamic' | 'bottom' | 'none';
+            } | {
+                payloadMaps: {
+                    fileId: string;
+                    fieldId: string;
+                }[];
+                ignoreWhenFilled?: boolean;
+                /** @enum {string} */
+                kind: 'form';
+                label?: string;
+                description?: string;
+                helpTip?: string;
+                placeholder?: string;
+                optional?: boolean;
+                options?: {
+                    [key: string]: unknown;
+                };
+            })[];
+            fieldsAreOrdered?: boolean;
+            /** @enum {string} */
+            signerType?: 'email' | 'embedded' | 'in-person';
+            /** Format: redirectURL */
+            redirectURL?: string;
+            enableEmails?: boolean | 'etchComplete'[];
+            /** Format: date-time */
+            tokenValidUntil?: string;
+            tokenValidForMinutes?: number;
+            allowNameChange?: boolean;
+            allowEmailChange?: boolean;
+            requireNameOnLoad?: boolean;
+            requireEmailOnLoad?: boolean;
+            requireIdCheck?: boolean | ('kb' | 'sms' | 'smskb' | 'idsms');
+            requireIdCheckInTest?: boolean;
+            /** Format: phoneNumber */
+            idCheckPhone?: string;
+            accessCode?: string;
+        };
+        /** @description createEtchPacket's `signaturePageOptions` argument: text and styles for the signing page. */
+        EtchSignaturePageOptions: {
+            title?: string;
+            description?: string;
+            signatureLabel?: string;
+            initialLabel?: string;
+            acceptTitle?: string;
+            acceptDescription?: string;
+            acceptButtonText?: string;
+            drawSignatureTitle?: string;
+            drawSignatureDescription?: string;
+            drawSignatureButtonText?: string;
+            drawInitialsTitle?: string;
+            drawInitialsDescription?: string;
+            drawInitialsButtonText?: string;
+            signTitle?: string;
+            signDescription?: string;
+            signDescriptionCompleted?: string;
+            signConsentText?: string;
+            signEachDescription?: string;
+            signEachConsentText?: string;
+            signButtonText?: string;
+            reviewTitle?: string;
+            reviewDescription?: string;
+            reviewButtonText?: string;
+            signEachCompletedMessage?: string;
+            signEachNotReadyMessage?: string;
+            signEachSubmittingMessage?: string;
+            signEachSigningMessage?: string;
+            signEachErrorMessage?: string;
+            signEachStartButtonText?: string;
+            signEachNextButtonText?: string;
+            signEachFinishButtonText?: string;
+            signEachSignAllText?: string;
+            completedButtonText?: string;
+            error?: string;
+            notCurrentUserError?: string;
+            style?: {
+                /** Format: publicUri */
+                stylesheetURL?: string;
+                /** Format: hexColor */
+                primaryColor?: string;
+                /** Format: hexColor */
+                successColor?: string;
+                /** Format: hexColor */
+                infoColor?: string;
+                /** Format: hexColor */
+                linkColor?: string;
+            };
+        };
+        /** @description createEtchPacket's `finishPageOptions` argument: text for the page signers see when they're done. */
+        EtchFinishPageOptions: {
+            zipName?: string;
+            completeTitle?: string;
+            completeDescription?: string;
+            incompleteTitle?: string;
+            incompleteDescription?: string;
+            signatureTitle?: string;
+            signatureDescription?: string;
+            signatureButtonText?: string;
+            signatureWaitingSignersBeforeTitle?: string;
+            signatureWaitingSignersBeforeDescription?: string;
+            signatureWaitingSignersAfterTitle?: string;
+            signatureWaitingSignersAfterDescription?: string;
+            signatureAsyncTitle?: string;
+            signatureAsyncDescription?: string;
+        };
         FillPdfRequest: {
             /** @description Custom title for the generated PDF. Overrides the template's default title. */
             title?: string;
@@ -273,6 +428,60 @@ interface components {
     pathItems: never;
 }
 interface operations {
+    downloadDocuments: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description The EID of the document group, e.g. an Etch packet's `documentGroup.eid`. */
+                documentGroupEid: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /**
+             * @description The zip archive. `Content-Disposition` names it after the document
+             *     group's parent object, such as the Etch packet.
+             */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/zip': string;
+                };
+            };
+            /** @description Redirect to a short-lived signed URL for the zip. */
+            302: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Authentication required — API key or OAuth token is missing or invalid. */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description The OAuth token belongs to a public client without a scope that covers this route. */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Document group not found — no document group exists with the given EID, or the authenticated user lacks access to it. */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
     fillPdf: {
         parameters: {
             query?: {
@@ -4042,11 +4251,8 @@ type introspection = {
               {
                 "name": "organizationEid",
                 "type": {
-                  "kind": "NON_NULL",
-                  "ofType": {
-                    "kind": "SCALAR",
-                    "name": "String"
-                  }
+                  "kind": "SCALAR",
+                  "name": "String"
                 }
               },
               {

package/dist/index.d.ts

@@ -3,6 +3,34 @@
  * Do not make direct changes to the file.
  */
 interface paths {
+    '/api/document-group/{documentGroupEid}.zip': {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Download a document group's files as a zip
+         * @description Downloads every file in a document group as a single zip archive: for
+         *     example, the signed documents of an Etch signature packet, from its
+         *     `documentGroup.eid`.
+         *
+         *     Instead of streaming the zip, the response may be a `302` redirect to
+         *     a short-lived signed URL for it. Follow redirects to get the file.
+         *
+         *     Requires API key (Basic auth) or OAuth authentication. Public OAuth
+         *     clients need the `mcp:full` scope; no narrower scope covers this route.
+         */
+        get: operations['downloadDocuments'];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     '/api/v1/fill/{castEid}.pdf': {
         parameters: {
             query?: never;
@@ -72,6 +100,133 @@ interface paths {
 }
 interface components {
     schemas: {
+        /** @description A signer in createEtchPacket's `signers` argument: who signs, which fields they sign, and how. */
+        EtchSigner: {
+            id: string;
+            /** Format: displayableShortText */
+            name?: string;
+            /** Format: email */
+            email?: string;
+            routingOrder?: number;
+            isPending?: boolean;
+            /** @enum {string} */
+            signatureMode?: 'draw' | 'text';
+            acceptEachField?: boolean;
+            showFinishSigningButton?: boolean;
+            addUuidToSignatures?: boolean;
+            addTimestampToSignatures?: boolean;
+            /** @enum {string} */
+            signatureImageVerticalJustificationDefault?: 'dynamic' | 'bottom' | 'none';
+            /** @enum {string} */
+            signatureExperience?: 'signBeforeReviewing' | 'signWhileReviewing' | 'acknowledgeOnly' | 'formCompletionOnly';
+            fields?: ({
+                fileId: string;
+                fieldId: string;
+                /** @enum {string} */
+                signatureImageVerticalJustification?: 'dynamic' | 'bottom' | 'none';
+            } | {
+                payloadMaps: {
+                    fileId: string;
+                    fieldId: string;
+                }[];
+                ignoreWhenFilled?: boolean;
+                /** @enum {string} */
+                kind: 'form';
+                label?: string;
+                description?: string;
+                helpTip?: string;
+                placeholder?: string;
+                optional?: boolean;
+                options?: {
+                    [key: string]: unknown;
+                };
+            })[];
+            fieldsAreOrdered?: boolean;
+            /** @enum {string} */
+            signerType?: 'email' | 'embedded' | 'in-person';
+            /** Format: redirectURL */
+            redirectURL?: string;
+            enableEmails?: boolean | 'etchComplete'[];
+            /** Format: date-time */
+            tokenValidUntil?: string;
+            tokenValidForMinutes?: number;
+            allowNameChange?: boolean;
+            allowEmailChange?: boolean;
+            requireNameOnLoad?: boolean;
+            requireEmailOnLoad?: boolean;
+            requireIdCheck?: boolean | ('kb' | 'sms' | 'smskb' | 'idsms');
+            requireIdCheckInTest?: boolean;
+            /** Format: phoneNumber */
+            idCheckPhone?: string;
+            accessCode?: string;
+        };
+        /** @description createEtchPacket's `signaturePageOptions` argument: text and styles for the signing page. */
+        EtchSignaturePageOptions: {
+            title?: string;
+            description?: string;
+            signatureLabel?: string;
+            initialLabel?: string;
+            acceptTitle?: string;
+            acceptDescription?: string;
+            acceptButtonText?: string;
+            drawSignatureTitle?: string;
+            drawSignatureDescription?: string;
+            drawSignatureButtonText?: string;
+            drawInitialsTitle?: string;
+            drawInitialsDescription?: string;
+            drawInitialsButtonText?: string;
+            signTitle?: string;
+            signDescription?: string;
+            signDescriptionCompleted?: string;
+            signConsentText?: string;
+            signEachDescription?: string;
+            signEachConsentText?: string;
+            signButtonText?: string;
+            reviewTitle?: string;
+            reviewDescription?: string;
+            reviewButtonText?: string;
+            signEachCompletedMessage?: string;
+            signEachNotReadyMessage?: string;
+            signEachSubmittingMessage?: string;
+            signEachSigningMessage?: string;
+            signEachErrorMessage?: string;
+            signEachStartButtonText?: string;
+            signEachNextButtonText?: string;
+            signEachFinishButtonText?: string;
+            signEachSignAllText?: string;
+            completedButtonText?: string;
+            error?: string;
+            notCurrentUserError?: string;
+            style?: {
+                /** Format: publicUri */
+                stylesheetURL?: string;
+                /** Format: hexColor */
+                primaryColor?: string;
+                /** Format: hexColor */
+                successColor?: string;
+                /** Format: hexColor */
+                infoColor?: string;
+                /** Format: hexColor */
+                linkColor?: string;
+            };
+        };
+        /** @description createEtchPacket's `finishPageOptions` argument: text for the page signers see when they're done. */
+        EtchFinishPageOptions: {
+            zipName?: string;
+            completeTitle?: string;
+            completeDescription?: string;
+            incompleteTitle?: string;
+            incompleteDescription?: string;
+            signatureTitle?: string;
+            signatureDescription?: string;
+            signatureButtonText?: string;
+            signatureWaitingSignersBeforeTitle?: string;
+            signatureWaitingSignersBeforeDescription?: string;
+            signatureWaitingSignersAfterTitle?: string;
+            signatureWaitingSignersAfterDescription?: string;
+            signatureAsyncTitle?: string;
+            signatureAsyncDescription?: string;
+        };
         FillPdfRequest: {
             /** @description Custom title for the generated PDF. Overrides the template's default title. */
             title?: string;
@@ -273,6 +428,60 @@ interface components {
     pathItems: never;
 }
 interface operations {
+    downloadDocuments: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description The EID of the document group, e.g. an Etch packet's `documentGroup.eid`. */
+                documentGroupEid: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /**
+             * @description The zip archive. `Content-Disposition` names it after the document
+             *     group's parent object, such as the Etch packet.
+             */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/zip': string;
+                };
+            };
+            /** @description Redirect to a short-lived signed URL for the zip. */
+            302: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Authentication required — API key or OAuth token is missing or invalid. */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description The OAuth token belongs to a public client without a scope that covers this route. */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Document group not found — no document group exists with the given EID, or the authenticated user lacks access to it. */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
     fillPdf: {
         parameters: {
             query?: {
@@ -4042,11 +4251,8 @@ type introspection = {
               {
                 "name": "organizationEid",
                 "type": {
-                  "kind": "NON_NULL",
-                  "ofType": {
-                    "kind": "SCALAR",
-                    "name": "String"
-                  }
+                  "kind": "SCALAR",
+                  "name": "String"
                 }
               },
               {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@anvilco/types",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "description": "TypeScript types generated from the Anvil OpenAPI spec and GraphQL schema",
   "type": "module",
   "main": "./dist/index.cjs",

package/schema/anvil-schema.graphql

@@ -1114,7 +1114,7 @@ type Mutation {
   createWeldData(isTest: Boolean = false, webhookURL: String, weldDataGroupEid: String, weldEid: String!): WeldData
   destroySubmission(eid: String!): Boolean
   disconnectDocusign(organizationSlug: String!): Organization
-  duplicateCast(eid: String!, name: String, organizationEid: String!, title: String): Cast
+  duplicateCast(eid: String!, name: String, organizationEid: String, title: String): Cast
   duplicateWeld(eid: String!, name: String, organizationEid: String!, slug: String, visibility: String): Weld
 
   """