instasign 1.1.3 → 1.1.5

package/dist/index.d.cts

@@ -1,5 +1,4 @@
 import { AxiosInstance } from 'axios';
-import { WebhookEventType, WebhookPayloadMap } from './webhook.types.js';
 
 /**
  * This file was auto-generated by openapi-typescript.
@@ -7,7 +6,7 @@ import { WebhookEventType, WebhookPayloadMap } from './webhook.types.js';
  */
 
 interface paths {
-    "/functions/envelope:add-sign-request": {
+    "/functions/envelope:add-sign-requests": {
         parameters: {
             query?: never;
             header?: never;
@@ -16,7 +15,7 @@ interface paths {
         };
         get?: never;
         put?: never;
-        /** envelope:add-sign-request */
+        /** envelope:add-sign-requests */
         post: {
             parameters: {
                 query?: never;
@@ -28,12 +27,15 @@ interface paths {
                 content: {
                     "application/json": {
                         envelopeId: string;
-                        filename: string;
-                        base64File?: string;
-                        fileUrl?: string;
-                        metadata?: {
-                            [key: string]: unknown;
-                        };
+                        signRequests: {
+                            filename: string;
+                            base64File?: string;
+                            fileUrl?: string;
+                            metadata?: {
+                                [key: string]: unknown;
+                            };
+                            clientReferenceId?: string;
+                        }[];
                     };
                 };
             };
@@ -45,11 +47,7 @@ interface paths {
                     };
                     content: {
                         "application/json": {
-                            result: {
-                                requestId: string;
-                                signUrl: string;
-                                envelopeSignUrl?: string;
-                            };
+                            result: components["schemas"]["EnvelopeAddSignRequestsResult"];
                         };
                     };
                 };
@@ -93,10 +91,7 @@ interface paths {
                     };
                     content: {
                         "application/json": {
-                            result: {
-                                success: boolean;
-                                message: string;
-                            };
+                            result: components["schemas"]["EnvelopeCompleteResult"];
                         };
                     };
                 };
@@ -147,9 +142,7 @@ interface paths {
                     };
                     content: {
                         "application/json": {
-                            result: {
-                                envelopeId: string;
-                            };
+                            result: components["schemas"]["EnvelopeCreateResult"];
                         };
                     };
                 };
@@ -193,9 +186,7 @@ interface paths {
                     };
                     content: {
                         "application/json": {
-                            result: {
-                                success: boolean;
-                            };
+                            result: components["schemas"]["EnvelopeDeleteResult"];
                         };
                     };
                 };
@@ -240,34 +231,7 @@ interface paths {
                     };
                     content: {
                         "application/json": {
-                            result: {
-                                envelopeId: string;
-                                name: string;
-                                description?: string;
-                                /** @enum {string} */
-                                status: "pending" | "in-progress" | "completed" | "cancelled";
-                                clientReferenceId?: string;
-                                signRequestsCount: number;
-                                signRequests: {
-                                    requestId: string;
-                                    /** @enum {string} */
-                                    status: "pending" | "completed" | "canceled" | "queued";
-                                    fileName: string;
-                                    fileUrl: string;
-                                    signedFileUrl?: string;
-                                    metadata: {
-                                        [key: string]: unknown;
-                                    };
-                                    clientReferenceId?: string;
-                                }[];
-                                /** Format: date-time */
-                                createdAt: string;
-                                /** Format: date-time */
-                                updatedAt: string;
-                                /** Format: date-time */
-                                expirationDate?: string;
-                                signUrl?: string;
-                            };
+                            result: components["schemas"]["EnvelopeGetResult"];
                         };
                     };
                 };
@@ -324,34 +288,7 @@ interface paths {
                     };
                     content: {
                         "application/json": {
-                            result: {
-                                envelopeId: string;
-                                name: string;
-                                description?: string;
-                                /** @enum {string} */
-                                status: "pending" | "in-progress" | "completed" | "cancelled";
-                                clientReferenceId?: string;
-                                signRequestsCount: number;
-                                signRequests: {
-                                    requestId: string;
-                                    /** @enum {string} */
-                                    status: "pending" | "completed" | "canceled" | "queued";
-                                    fileName: string;
-                                    fileUrl: string;
-                                    signedFileUrl?: string;
-                                    metadata: {
-                                        [key: string]: unknown;
-                                    };
-                                    clientReferenceId?: string;
-                                }[];
-                                /** Format: date-time */
-                                createdAt: string;
-                                /** Format: date-time */
-                                updatedAt: string;
-                                /** Format: date-time */
-                                expirationDate?: string;
-                                signUrl?: string;
-                            }[];
+                            result: components["schemas"]["EnvelopeListResult"][];
                         };
                     };
                 };
@@ -396,10 +333,7 @@ interface paths {
                     };
                     content: {
                         "application/json": {
-                            result: {
-                                success: boolean;
-                                message: string;
-                            };
+                            result: components["schemas"]["EnvelopeRemoveSignRequestResult"];
                         };
                     };
                 };
@@ -446,12 +380,7 @@ interface paths {
                     };
                     content: {
                         "application/json": {
-                            result: {
-                                envelopeId: string;
-                                metadata: {
-                                    [key: string]: unknown;
-                                };
-                            };
+                            result: components["schemas"]["EnvelopeUpdateMetadataResult"];
                         };
                     };
                 };
@@ -496,9 +425,7 @@ interface paths {
                     };
                     content: {
                         "application/json": {
-                            result: {
-                                signedFileUrl: string;
-                            };
+                            result: components["schemas"]["SignRequestCompleteResult"];
                         };
                     };
                 };
@@ -550,10 +477,7 @@ interface paths {
                     };
                     content: {
                         "application/json": {
-                            result: {
-                                requestId: string;
-                                signUrl: string;
-                            };
+                            result: components["schemas"]["SignRequestCreateResult"];
                         };
                     };
                 };
@@ -597,22 +521,7 @@ interface paths {
                     };
                     content: {
                         "application/json": {
-                            result: {
-                                requestId: string;
-                                /** @enum {string} */
-                                status: "pending" | "completed" | "canceled" | "queued";
-                                fileName: string;
-                                originalFile: string;
-                                signedFile?: string;
-                                metadata?: {
-                                    [key: string]: unknown;
-                                };
-                                clientReferenceId?: string;
-                                /** Format: date-time */
-                                createdAt: string;
-                                /** Format: date-time */
-                                updatedAt: string;
-                            };
+                            result: components["schemas"]["SignRequestGetResult"];
                         };
                     };
                 };
@@ -659,12 +568,7 @@ interface paths {
                     };
                     content: {
                         "application/json": {
-                            result: {
-                                requestId: string;
-                                metadata: {
-                                    [key: string]: unknown;
-                                };
-                            };
+                            result: components["schemas"]["SignRequestUpdateMetadataResult"];
                         };
                     };
                 };
@@ -679,7 +583,120 @@ interface paths {
 }
 type webhooks = Record<string, never>;
 interface components {
-    schemas: never;
+    schemas: {
+        EnvelopeAddSignRequestsResult: {
+            signRequests: {
+                requestId: string;
+                signUrl: string;
+            }[];
+            envelopeSignUrl?: string;
+        };
+        EnvelopeCompleteResult: {
+            success: boolean;
+            message: string;
+        };
+        EnvelopeCreateResult: {
+            envelopeId: string;
+        };
+        EnvelopeDeleteResult: {
+            success: boolean;
+        };
+        EnvelopeGetResult: {
+            envelopeId: string;
+            name: string;
+            description?: string;
+            /** @enum {string} */
+            status: "pending" | "in-progress" | "completed" | "cancelled";
+            clientReferenceId?: string;
+            signRequestsCount: number;
+            signRequests: {
+                requestId: string;
+                /** @enum {string} */
+                status: "pending" | "completed" | "canceled" | "queued";
+                fileName: string;
+                fileUrl: string;
+                signedFileUrl?: string;
+                metadata: {
+                    [key: string]: unknown;
+                };
+                clientReferenceId?: string;
+            }[];
+            /** Format: date-time */
+            createdAt: string;
+            /** Format: date-time */
+            updatedAt: string;
+            /** Format: date-time */
+            expirationDate?: string;
+            signUrl?: string;
+        };
+        EnvelopeListResult: {
+            envelopeId: string;
+            name: string;
+            description?: string;
+            /** @enum {string} */
+            status: "pending" | "in-progress" | "completed" | "cancelled";
+            clientReferenceId?: string;
+            signRequestsCount: number;
+            signRequests: {
+                requestId: string;
+                /** @enum {string} */
+                status: "pending" | "completed" | "canceled" | "queued";
+                fileName: string;
+                fileUrl: string;
+                signedFileUrl?: string;
+                metadata: {
+                    [key: string]: unknown;
+                };
+                clientReferenceId?: string;
+            }[];
+            /** Format: date-time */
+            createdAt: string;
+            /** Format: date-time */
+            updatedAt: string;
+            /** Format: date-time */
+            expirationDate?: string;
+            signUrl?: string;
+        };
+        EnvelopeRemoveSignRequestResult: {
+            success: boolean;
+            message: string;
+        };
+        EnvelopeUpdateMetadataResult: {
+            envelopeId: string;
+            metadata: {
+                [key: string]: unknown;
+            };
+        };
+        SignRequestCompleteResult: {
+            signedFileUrl: string;
+        };
+        SignRequestCreateResult: {
+            requestId: string;
+            signUrl: string;
+        };
+        SignRequestGetResult: {
+            requestId: string;
+            /** @enum {string} */
+            status: "pending" | "completed" | "canceled" | "queued";
+            fileName: string;
+            originalFile: string;
+            signedFile?: string;
+            metadata?: {
+                [key: string]: unknown;
+            };
+            clientReferenceId?: string;
+            /** Format: date-time */
+            createdAt: string;
+            /** Format: date-time */
+            updatedAt: string;
+        };
+        SignRequestUpdateMetadataResult: {
+            requestId: string;
+            metadata: {
+                [key: string]: unknown;
+            };
+        };
+    };
     responses: never;
     parameters: never;
     requestBodies: never;
@@ -689,6 +706,43 @@ interface components {
 type $defs = Record<string, never>;
 type operations = Record<string, never>;
 
+declare const VALID_WEBHOOK_EVENT_TYPES: readonly ["envelope_created", "envelope_expired", "sign_request_created", "sign_request_signed", "sign_request_expired"];
+type WebhookEventType = typeof VALID_WEBHOOK_EVENT_TYPES[number];
+type WebhookStatus = 'pending' | 'success' | 'error';
+type WebhookPayloadMap = {
+    'envelope_created': {
+        envelopeId: string;
+    };
+    'envelope_expired': {
+        envelopeId: string;
+    };
+    'sign_request_created': {
+        requestId: string;
+        status: string;
+        envelopeId?: string;
+    };
+    'sign_request_signed': {
+        requestId: string;
+        status: string;
+        envelopeId?: string;
+    };
+    'sign_request_expired': {
+        requestId: string;
+    };
+};
+declare const VALID_SIGN_REQUEST_STATUSES: readonly ["pending", "completed", "canceled", "queued"];
+type SignRequestStatus = typeof VALID_SIGN_REQUEST_STATUSES[number];
+declare const VALID_ENVELOPE_STATUSES: readonly ["pending", "in-progress", "completed", "cancelled"];
+type EnvelopeStatus = typeof VALID_ENVELOPE_STATUSES[number];
+type SignRequestMetadata = Record<string, unknown>;
+type EnvelopeMetadata = Record<string, unknown>;
+declare const VALID_ORDER_BY: readonly ["updatedAt", "createdAt"];
+type OrderBy = (typeof VALID_ORDER_BY)[number];
+declare const VALID_ORDER_DIRECTION: readonly ["asc", "desc"];
+type OrderDirection = (typeof VALID_ORDER_DIRECTION)[number];
+
+/** Extract a named component schema from the OpenAPI definition */
+type SchemaResult<N extends keyof components['schemas']> = components['schemas'][N];
 interface OperationResponse {
     success?: boolean;
     message?: string;
@@ -697,27 +751,45 @@ interface OperationResponse {
 type ResponseResult<P extends keyof paths> = NonNullable<NonNullable<paths[P]['post']['responses']>[200]['content']>['application/json']['result'];
 /** Extract the request body type from a Cloud Function */
 type RequestBody<P extends keyof paths> = NonNullable<NonNullable<paths[P]['post']['requestBody']>['content']>['application/json'];
-
 /** A full envelope with its sign requests */
-type Envelope = ResponseResult<'/functions/envelope:get'>;
+interface Envelope extends SchemaResult<'EnvelopeGetResult'> {
+}
 /** Envelope as returned in a list */
-type EnvelopeListItem = ResponseResult<'/functions/envelope:list'>[number];
-type CreateEnvelopeParams = RequestBody<'/functions/envelope:create'>;
-type GetEnvelopesParams = RequestBody<'/functions/envelope:list'>;
-type UpdateEnvelopeMetadataParams = RequestBody<'/functions/envelope:update-metadata'>;
-type RemoveSignRequestFromEnvelopeParams = RequestBody<'/functions/envelope:remove-sign-request'>;
-type AddSignRequestToEnvelopeParams = RequestBody<'/functions/envelope:add-sign-request'>;
-type CreateEnvelopeResponse = ResponseResult<'/functions/envelope:create'>;
-type UpdateEnvelopeMetadataResponse = ResponseResult<'/functions/envelope:update-metadata'>;
-type AddSignRequestToEnvelopeResponse = ResponseResult<'/functions/envelope:add-sign-request'>;
-
+interface EnvelopeListItem extends SchemaResult<'EnvelopeListResult'> {
+}
+interface CreateEnvelopeParams extends RequestBody<'/functions/envelope:create'> {
+}
+interface GetEnvelopesParams extends RequestBody<'/functions/envelope:list'> {
+}
+interface UpdateEnvelopeMetadataParams extends RequestBody<'/functions/envelope:update-metadata'> {
+}
+interface RemoveSignRequestFromEnvelopeParams extends RequestBody<'/functions/envelope:remove-sign-request'> {
+}
+interface AddSignRequestsToEnvelopeParams extends RequestBody<'/functions/envelope:add-sign-requests'> {
+}
+interface CreateEnvelopeResponse extends ResponseResult<'/functions/envelope:create'> {
+}
+interface UpdateEnvelopeMetadataResponse extends ResponseResult<'/functions/envelope:update-metadata'> {
+}
+interface AddSignRequestsToEnvelopeResponse extends ResponseResult<'/functions/envelope:add-sign-requests'> {
+}
 /** A single sign request */
-type SignRequest = ResponseResult<'/functions/envelope:get'>['signRequests'][number];
-type CreateSignRequestParams = RequestBody<'/functions/sign-request:create'>;
-type CompleteSignRequestParams = RequestBody<'/functions/sign-request:complete'>;
-type CreateSignRequestResponse = ResponseResult<'/functions/sign-request:create'>;
-type CompleteSignRequestResponse = ResponseResult<'/functions/sign-request:complete'>;
-
+interface SignRequest extends SchemaResult<'SignRequestGetResult'> {
+}
+interface CreateSignRequestParams extends RequestBody<'/functions/sign-request:create'> {
+}
+interface CompleteSignRequestParams extends RequestBody<'/functions/sign-request:complete'> {
+}
+interface GetFileFromRequestIdParams extends RequestBody<'/functions/sign-request:get'> {
+}
+interface UpdateSignRequestMetadataParams extends RequestBody<'/functions/sign-request:update-metadata'> {
+}
+interface CreateSignRequestResponse extends ResponseResult<'/functions/sign-request:create'> {
+}
+interface CompleteSignRequestResponse extends ResponseResult<'/functions/sign-request:complete'> {
+}
+interface UpdateSignRequestMetadataResponse extends ResponseResult<'/functions/sign-request:update-metadata'> {
+}
 type WebhookEvent = {
     [T in WebhookEventType]: {
         eventType: T;
@@ -769,11 +841,11 @@ declare class Envelopes {
     /**
      * Remove a sign request from an envelope
      */
-    removeSignRequest(params: RemoveSignRequestFromEnvelopeParams): Promise<OperationResponse | undefined>;
+    remove(params: RemoveSignRequestFromEnvelopeParams): Promise<OperationResponse | undefined>;
     /**
-     * Add a sign request to an envelope
+     * Add sign requests to an envelope
      */
-    addSignRequest(params: AddSignRequestToEnvelopeParams): Promise<AddSignRequestToEnvelopeResponse | undefined>;
+    addAll(params: AddSignRequestsToEnvelopeParams): Promise<AddSignRequestsToEnvelopeResponse | undefined>;
 }
 
 declare class SignRequests {
@@ -817,4 +889,4 @@ declare class Instasign {
     constructor(config: IInstasignConfig);
 }
 
-export { type $defs, type AddSignRequestToEnvelopeParams, type AddSignRequestToEnvelopeResponse, type CompleteSignRequestParams, type CompleteSignRequestResponse, type CreateEnvelopeParams, type CreateEnvelopeResponse, type CreateSignRequestParams, type CreateSignRequestResponse, type Envelope, type EnvelopeCreatedEvent, type EnvelopeExpiredEvent, type EnvelopeListItem, Envelopes, type GetEnvelopesParams, type IInstasignConfig, Instasign, type OperationResponse, type RemoveSignRequestFromEnvelopeParams, type RequestBody, type ResponseResult, type SignRequest, type SignRequestCreatedEvent, type SignRequestExpiredEvent, type SignRequestSignedEvent, SignRequests, type UpdateEnvelopeMetadataParams, type UpdateEnvelopeMetadataResponse, type WebhookEvent, Webhooks, type components, type operations, type paths, type webhooks };
+export { type $defs, type AddSignRequestsToEnvelopeParams, type AddSignRequestsToEnvelopeResponse, type CompleteSignRequestParams, type CompleteSignRequestResponse, type CreateEnvelopeParams, type CreateEnvelopeResponse, type CreateSignRequestParams, type CreateSignRequestResponse, type Envelope, type EnvelopeCreatedEvent, type EnvelopeExpiredEvent, type EnvelopeListItem, type EnvelopeMetadata, type EnvelopeStatus, Envelopes, type GetEnvelopesParams, type GetFileFromRequestIdParams, type IInstasignConfig, Instasign, type OperationResponse, type OrderBy, type OrderDirection, type RemoveSignRequestFromEnvelopeParams, type RequestBody, type ResponseResult, type SchemaResult, type SignRequest, type SignRequestCreatedEvent, type SignRequestExpiredEvent, type SignRequestMetadata, type SignRequestSignedEvent, type SignRequestStatus, SignRequests, type UpdateEnvelopeMetadataParams, type UpdateEnvelopeMetadataResponse, type UpdateSignRequestMetadataParams, type UpdateSignRequestMetadataResponse, VALID_ENVELOPE_STATUSES, VALID_ORDER_BY, VALID_ORDER_DIRECTION, VALID_SIGN_REQUEST_STATUSES, VALID_WEBHOOK_EVENT_TYPES, type WebhookEvent, type WebhookEventType, type WebhookPayloadMap, type WebhookStatus, Webhooks, type components, type operations, type paths, type webhooks };