@anvilco/types 0.2.1 → 0.2.2

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

@@ -607,56 +607,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 +10865,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

@@ -607,56 +607,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 +10865,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.2",
   "description": "TypeScript types generated from the Anvil OpenAPI spec and GraphQL schema",
   "type": "module",
   "main": "./dist/index.cjs",