@anvilco/types 0.2.1 → 0.2.3

package/README.md

@@ -5,6 +5,7 @@ TypeScript types generated from the [Anvil](https://www.useanvil.com) OpenAPI sp
 The one place for the Anvil SDK's TypeScript types:
 
 - **REST**: `paths`, `components` and `operations`, generated from the OpenAPI spec, plus the fill-PDF request types (`FillPdfPayload`, `FillPdfData`, `FillPdfOptions`).
+- **Etch**: `CreateEtchPacketArgs`, the createEtchPacket mutation's arguments with the ones the GraphQL schema calls `JSON` typed: `signers` (`EtchSigner`), `signaturePageOptions` (`EtchSignaturePageOptions`) and `finishPageOptions` (`EtchFinishPageOptions`). The OpenAPI spec publishes their shapes.
 - **GraphQL**: the `GraphQL` namespace, generated from the schema.
 - **The SDK's own types**: `AnvilOptions`, `GraphQLResponse`, `RESTResponse`, `ResponseError`, `ResponseErrorField`, `RuntimeError` and `Abortable`.
 

package/dist/index.d.cts

@@ -64,6 +64,31 @@ interface paths {
         patch?: never;
         trace?: never;
     };
+    '/api/v1/fill/{integrationType}/{castEid}.pdf': {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Fill a PDF template from integration records
+         * @description Fills a PDF template (Cast) built from an integration with values read
+         *     from that integration's records, and returns the same PDF or signed URL
+         *     as `/api/v1/fill/{castEid}.pdf`. Accepts every option that endpoint does
+         *     except `data`.
+         *
+         *     Only `hubspot` is supported, and one record per object type.
+         */
+        post: operations['fillPdfFromIntegration'];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     '/api/v1/generate-pdf': {
         parameters: {
             query?: never;
@@ -287,6 +312,22 @@ interface components {
              */
             outputFormat: 'pdf' | 'url';
         };
+        FillPdfFromIntegrationRequest: {
+            /**
+             * @description Record IDs keyed by the template's object types, e.g.
+             *     `{ "contacts": "111", "companies": "999" }`. Each type takes one ID
+             *     as a numeric string, or a list holding one.
+             */
+            records: {
+                [key: string]: string | string[];
+            };
+            title?: string;
+            /**
+             * @default pdf
+             * @enum {string}
+             */
+            outputFormat: 'pdf' | 'url';
+        };
         /** @description Custom page dimensions and margins for the generated PDF. */
         PageOptions: {
             /** @description Page width with unit (e.g. `8.5in`, `210mm`). */
@@ -473,7 +514,7 @@ interface operations {
                 };
                 content?: never;
             };
-            /** @description Document group not found — no document group exists with the given EID, or the authenticated user lacks access to it. */
+            /** @description Not found. No document group exists with the given EID, the authenticated user lacks access to it, or its zip is missing from storage. */
             404: {
                 headers: {
                     [name: string]: unknown;
@@ -552,6 +593,81 @@ interface operations {
             };
         };
     };
+    fillPdfFromIntegration: {
+        parameters: {
+            query?: {
+                /** @description The version number of the template to use. Defaults to the latest published version. */
+                versionNumber?: number;
+            };
+            header?: never;
+            path: {
+                /** @description The integration the template was built from. */
+                integrationType: 'hubspot';
+                /** @description The EID of the PDF template (Cast) to fill. */
+                castEid: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                'application/json': components['schemas']['FillPdfFromIntegrationRequest'];
+                'multipart/form-data': components['schemas']['FillPdfFromIntegrationRequest'];
+            };
+        };
+        responses: {
+            /** @description The filled PDF document. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/pdf': string;
+                };
+            };
+            /** @description Validation error, the template wasn't built from this integration, or the integration has no record with a given ID. */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Authentication required. */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description No edit access to the template. */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Template not found. */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Unsupported media type. */
+            415: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Concurrency limit exceeded. */
+            429: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
     generatePdf: {
         parameters: {
             query?: never;
@@ -607,56 +723,6 @@ interface operations {
     };
 }
 
-interface AnvilOptions {
-    apiKey?: string;
-    accessToken?: string;
-    baseURL?: string;
-    userAgent?: string;
-    requestLimit?: number;
-    requestLimitMS?: number;
-}
-interface ResponseErrorField {
-    message: string;
-    property?: string;
-    [key: string]: unknown;
-}
-interface ResponseError {
-    message: string;
-    status?: number;
-    name?: string;
-    fields?: ResponseErrorField[];
-    [key: string]: unknown;
-}
-interface RuntimeError {
-    name: string;
-    message: string;
-    stack?: string;
-    code?: string;
-    cause?: unknown;
-}
-interface GraphQLResponseData {
-    [key: string]: unknown;
-}
-interface GraphQLResponse<TData = GraphQLResponseData> {
-    statusCode: number;
-    data?: TData;
-    errors?: Array<ResponseError | RuntimeError>;
-}
-interface RESTResponse<T = unknown> {
-    statusCode: number;
-    data?: T;
-    errors?: Array<ResponseError | RuntimeError>;
-}
-interface Abortable {
-    signal?: AbortSignal;
-}
-type FillPdfPayload = components['schemas']['FillPdfRequest'];
-type FillPdfData = FillPdfPayload['data'];
-type FillPdfVersionNumber = NonNullable<operations['fillPdf']['parameters']['query']>['versionNumber'];
-interface FillPdfOptions extends Abortable {
-    versionNumber?: FillPdfVersionNumber;
-}
-
 // Generated by scripts/generate-graphql.js (gql.tada) from schema/anvil-schema.graphql — do not edit by hand.
 // Run `yarn workspace @anvilco/types generate:graphql` to regenerate.
 /* eslint-disable */
@@ -10915,4 +10981,63 @@ declare namespace index {
   export type { index_Introspection as Introspection, index_MutationArgs as MutationArgs, index_MutationName as MutationName, index_QueryArgs as QueryArgs, index_QueryName as QueryName, index_Scalars as Scalars, index_Setup as Setup, index_Type as Type, index_TypeName as TypeName };
 }
 
-export { type Abortable, type AnvilOptions, type FillPdfData, type FillPdfOptions, type FillPdfPayload, type FillPdfVersionNumber, index as GraphQL, type GraphQLResponse, type GraphQLResponseData, type RESTResponse, type ResponseError, type ResponseErrorField, type RuntimeError, type components, type operations, type paths };
+interface AnvilOptions {
+    apiKey?: string;
+    accessToken?: string;
+    baseURL?: string;
+    userAgent?: string;
+    requestLimit?: number;
+    requestLimitMS?: number;
+}
+interface ResponseErrorField {
+    message: string;
+    property?: string;
+    [key: string]: unknown;
+}
+interface ResponseError {
+    message: string;
+    status?: number;
+    name?: string;
+    fields?: ResponseErrorField[];
+    [key: string]: unknown;
+}
+interface RuntimeError {
+    name: string;
+    message: string;
+    stack?: string;
+    code?: string;
+    cause?: unknown;
+}
+interface GraphQLResponseData {
+    [key: string]: unknown;
+}
+interface GraphQLResponse<TData = GraphQLResponseData> {
+    statusCode: number;
+    data?: TData;
+    errors?: Array<ResponseError | RuntimeError>;
+}
+interface RESTResponse<T = unknown> {
+    statusCode: number;
+    data?: T;
+    errors?: Array<ResponseError | RuntimeError>;
+}
+interface Abortable {
+    signal?: AbortSignal;
+}
+type FillPdfPayload = components['schemas']['FillPdfRequest'];
+type FillPdfData = FillPdfPayload['data'];
+type FillPdfVersionNumber = NonNullable<operations['fillPdf']['parameters']['query']>['versionNumber'];
+interface FillPdfOptions extends Abortable {
+    versionNumber?: FillPdfVersionNumber;
+}
+type EtchSigner = components['schemas']['EtchSigner'];
+type EtchSignaturePageOptions = components['schemas']['EtchSignaturePageOptions'];
+type EtchFinishPageOptions = components['schemas']['EtchFinishPageOptions'];
+/** createEtchPacket's arguments, with `signers`, `signaturePageOptions` and `finishPageOptions` typed. */
+type CreateEtchPacketArgs = Omit<MutationArgs<'createEtchPacket'>, 'signers' | 'signaturePageOptions' | 'finishPageOptions'> & {
+    signers?: EtchSigner[] | null;
+    signaturePageOptions?: EtchSignaturePageOptions | null;
+    finishPageOptions?: EtchFinishPageOptions | null;
+};
+
+export { type Abortable, type AnvilOptions, type CreateEtchPacketArgs, type EtchFinishPageOptions, type EtchSignaturePageOptions, type EtchSigner, type FillPdfData, type FillPdfOptions, type FillPdfPayload, type FillPdfVersionNumber, index as GraphQL, type GraphQLResponse, type GraphQLResponseData, type RESTResponse, type ResponseError, type ResponseErrorField, type RuntimeError, type components, type operations, type paths };

package/dist/index.d.ts

@@ -64,6 +64,31 @@ interface paths {
         patch?: never;
         trace?: never;
     };
+    '/api/v1/fill/{integrationType}/{castEid}.pdf': {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Fill a PDF template from integration records
+         * @description Fills a PDF template (Cast) built from an integration with values read
+         *     from that integration's records, and returns the same PDF or signed URL
+         *     as `/api/v1/fill/{castEid}.pdf`. Accepts every option that endpoint does
+         *     except `data`.
+         *
+         *     Only `hubspot` is supported, and one record per object type.
+         */
+        post: operations['fillPdfFromIntegration'];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     '/api/v1/generate-pdf': {
         parameters: {
             query?: never;
@@ -287,6 +312,22 @@ interface components {
              */
             outputFormat: 'pdf' | 'url';
         };
+        FillPdfFromIntegrationRequest: {
+            /**
+             * @description Record IDs keyed by the template's object types, e.g.
+             *     `{ "contacts": "111", "companies": "999" }`. Each type takes one ID
+             *     as a numeric string, or a list holding one.
+             */
+            records: {
+                [key: string]: string | string[];
+            };
+            title?: string;
+            /**
+             * @default pdf
+             * @enum {string}
+             */
+            outputFormat: 'pdf' | 'url';
+        };
         /** @description Custom page dimensions and margins for the generated PDF. */
         PageOptions: {
             /** @description Page width with unit (e.g. `8.5in`, `210mm`). */
@@ -473,7 +514,7 @@ interface operations {
                 };
                 content?: never;
             };
-            /** @description Document group not found — no document group exists with the given EID, or the authenticated user lacks access to it. */
+            /** @description Not found. No document group exists with the given EID, the authenticated user lacks access to it, or its zip is missing from storage. */
             404: {
                 headers: {
                     [name: string]: unknown;
@@ -552,6 +593,81 @@ interface operations {
             };
         };
     };
+    fillPdfFromIntegration: {
+        parameters: {
+            query?: {
+                /** @description The version number of the template to use. Defaults to the latest published version. */
+                versionNumber?: number;
+            };
+            header?: never;
+            path: {
+                /** @description The integration the template was built from. */
+                integrationType: 'hubspot';
+                /** @description The EID of the PDF template (Cast) to fill. */
+                castEid: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                'application/json': components['schemas']['FillPdfFromIntegrationRequest'];
+                'multipart/form-data': components['schemas']['FillPdfFromIntegrationRequest'];
+            };
+        };
+        responses: {
+            /** @description The filled PDF document. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/pdf': string;
+                };
+            };
+            /** @description Validation error, the template wasn't built from this integration, or the integration has no record with a given ID. */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Authentication required. */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description No edit access to the template. */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Template not found. */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Unsupported media type. */
+            415: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Concurrency limit exceeded. */
+            429: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
     generatePdf: {
         parameters: {
             query?: never;
@@ -607,56 +723,6 @@ interface operations {
     };
 }
 
-interface AnvilOptions {
-    apiKey?: string;
-    accessToken?: string;
-    baseURL?: string;
-    userAgent?: string;
-    requestLimit?: number;
-    requestLimitMS?: number;
-}
-interface ResponseErrorField {
-    message: string;
-    property?: string;
-    [key: string]: unknown;
-}
-interface ResponseError {
-    message: string;
-    status?: number;
-    name?: string;
-    fields?: ResponseErrorField[];
-    [key: string]: unknown;
-}
-interface RuntimeError {
-    name: string;
-    message: string;
-    stack?: string;
-    code?: string;
-    cause?: unknown;
-}
-interface GraphQLResponseData {
-    [key: string]: unknown;
-}
-interface GraphQLResponse<TData = GraphQLResponseData> {
-    statusCode: number;
-    data?: TData;
-    errors?: Array<ResponseError | RuntimeError>;
-}
-interface RESTResponse<T = unknown> {
-    statusCode: number;
-    data?: T;
-    errors?: Array<ResponseError | RuntimeError>;
-}
-interface Abortable {
-    signal?: AbortSignal;
-}
-type FillPdfPayload = components['schemas']['FillPdfRequest'];
-type FillPdfData = FillPdfPayload['data'];
-type FillPdfVersionNumber = NonNullable<operations['fillPdf']['parameters']['query']>['versionNumber'];
-interface FillPdfOptions extends Abortable {
-    versionNumber?: FillPdfVersionNumber;
-}
-
 // Generated by scripts/generate-graphql.js (gql.tada) from schema/anvil-schema.graphql — do not edit by hand.
 // Run `yarn workspace @anvilco/types generate:graphql` to regenerate.
 /* eslint-disable */
@@ -10915,4 +10981,63 @@ declare namespace index {
   export type { index_Introspection as Introspection, index_MutationArgs as MutationArgs, index_MutationName as MutationName, index_QueryArgs as QueryArgs, index_QueryName as QueryName, index_Scalars as Scalars, index_Setup as Setup, index_Type as Type, index_TypeName as TypeName };
 }
 
-export { type Abortable, type AnvilOptions, type FillPdfData, type FillPdfOptions, type FillPdfPayload, type FillPdfVersionNumber, index as GraphQL, type GraphQLResponse, type GraphQLResponseData, type RESTResponse, type ResponseError, type ResponseErrorField, type RuntimeError, type components, type operations, type paths };
+interface AnvilOptions {
+    apiKey?: string;
+    accessToken?: string;
+    baseURL?: string;
+    userAgent?: string;
+    requestLimit?: number;
+    requestLimitMS?: number;
+}
+interface ResponseErrorField {
+    message: string;
+    property?: string;
+    [key: string]: unknown;
+}
+interface ResponseError {
+    message: string;
+    status?: number;
+    name?: string;
+    fields?: ResponseErrorField[];
+    [key: string]: unknown;
+}
+interface RuntimeError {
+    name: string;
+    message: string;
+    stack?: string;
+    code?: string;
+    cause?: unknown;
+}
+interface GraphQLResponseData {
+    [key: string]: unknown;
+}
+interface GraphQLResponse<TData = GraphQLResponseData> {
+    statusCode: number;
+    data?: TData;
+    errors?: Array<ResponseError | RuntimeError>;
+}
+interface RESTResponse<T = unknown> {
+    statusCode: number;
+    data?: T;
+    errors?: Array<ResponseError | RuntimeError>;
+}
+interface Abortable {
+    signal?: AbortSignal;
+}
+type FillPdfPayload = components['schemas']['FillPdfRequest'];
+type FillPdfData = FillPdfPayload['data'];
+type FillPdfVersionNumber = NonNullable<operations['fillPdf']['parameters']['query']>['versionNumber'];
+interface FillPdfOptions extends Abortable {
+    versionNumber?: FillPdfVersionNumber;
+}
+type EtchSigner = components['schemas']['EtchSigner'];
+type EtchSignaturePageOptions = components['schemas']['EtchSignaturePageOptions'];
+type EtchFinishPageOptions = components['schemas']['EtchFinishPageOptions'];
+/** createEtchPacket's arguments, with `signers`, `signaturePageOptions` and `finishPageOptions` typed. */
+type CreateEtchPacketArgs = Omit<MutationArgs<'createEtchPacket'>, 'signers' | 'signaturePageOptions' | 'finishPageOptions'> & {
+    signers?: EtchSigner[] | null;
+    signaturePageOptions?: EtchSignaturePageOptions | null;
+    finishPageOptions?: EtchFinishPageOptions | null;
+};
+
+export { type Abortable, type AnvilOptions, type CreateEtchPacketArgs, type EtchFinishPageOptions, type EtchSignaturePageOptions, type EtchSigner, type FillPdfData, type FillPdfOptions, type FillPdfPayload, type FillPdfVersionNumber, index as GraphQL, type GraphQLResponse, type GraphQLResponseData, type RESTResponse, type ResponseError, type ResponseErrorField, type RuntimeError, type components, type operations, type paths };

package/package.json

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