@subnoto/api-client 2.0.5 → 2.0.7

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@subnoto/api-client",
   "private": false,
-  "version": "2.0.5",
+  "version": "2.0.7",
   "description": "TypeScript SDK for Subnoto Public API",
   "author": "Subnoto",
   "homepage": "https://subnoto.com",

package/src/generated/api.gen.d.ts

@@ -1050,6 +1050,187 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/public/envelope/add-attachment": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * add-attachment
+         * @description Add a document attachment to an existing envelope. Accepts multipart/form-data with a PDF or Word document file.
+         */
+        post: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path?: never;
+                cookie?: never;
+            };
+            requestBody: {
+                content: {
+                    "multipart/form-data": {
+                        /** @description The UUID of the workspace containing the envelope. */
+                        workspaceUuid: string;
+                        /** @description The UUID of the envelope to attach the document to. */
+                        envelopeUuid: string;
+                        /** @description The title of the document attachment. */
+                        documentTitle: string;
+                        /** @description The file to attach (PDF or Word document, max 11MB). */
+                        file: unknown;
+                    };
+                };
+            };
+            responses: {
+                /** @description Default Response */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /** @description The unique identifier of the created document. */
+                            documentUuid: string;
+                            /** @description The key in base64 for the document revision. */
+                            revisionEncryptionKey: string;
+                        };
+                    };
+                };
+                /** @description Default Response */
+                400: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /** @description HTTP status code */
+                            statusCode: number;
+                            error: {
+                                /**
+                                 * @description The error code
+                                 * @enum {string}
+                                 */
+                                code: "WORKSPACE_NOT_FOUND" | "ENVELOPE_NOT_FOUND" | "ENVELOPE_NOT_IN_DRAFT" | "DOCUMENT_INVALID" | "FILE_SIZE_EXCEEDED" | "INVALID_REQUEST_FORMAT";
+                                /** @description The error message */
+                                message: string;
+                                /** @description A suggestion to resolve the error */
+                                suggestion: string;
+                                /** @description A URL to the documentation */
+                                documentationUrl: string;
+                            };
+                            /** @description The unique identifier of the request */
+                            requestId: string;
+                            /** @description The timestamp of the response */
+                            timestamp: string;
+                            /** @description The path of the request */
+                            path: string;
+                        };
+                    };
+                };
+                /** @description Default Response */
+                401: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /** @description HTTP status code */
+                            statusCode: number;
+                            error: {
+                                /**
+                                 * @description The error code
+                                 * @enum {string}
+                                 */
+                                code: "AUTHENTICATION_ERROR" | "TUNNEL_ERROR" | "INVALID_REQUEST_FORMAT";
+                                /** @description The error message */
+                                message: string;
+                                /** @description A suggestion to resolve the error */
+                                suggestion: string;
+                                /** @description A URL to the documentation */
+                                documentationUrl: string;
+                            };
+                            /** @description The unique identifier of the request */
+                            requestId: string;
+                            /** @description The timestamp of the response */
+                            timestamp: string;
+                            /** @description The path of the request */
+                            path: string;
+                        };
+                    };
+                };
+                /** @description Default Response */
+                403: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /** @description HTTP status code */
+                            statusCode: number;
+                            error: {
+                                /**
+                                 * @description The error code
+                                 * @enum {string}
+                                 */
+                                code: "AUTHORIZATION_ERROR" | "FEATURE_NOT_IN_CURRENT_PLAN" | "INVALID_REQUEST_FORMAT";
+                                /** @description The error message */
+                                message: string;
+                                /** @description A suggestion to resolve the error */
+                                suggestion: string;
+                                /** @description A URL to the documentation */
+                                documentationUrl: string;
+                            };
+                            /** @description The unique identifier of the request */
+                            requestId: string;
+                            /** @description The timestamp of the response */
+                            timestamp: string;
+                            /** @description The path of the request */
+                            path: string;
+                        };
+                    };
+                };
+                /** @description Default Response */
+                500: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /** @description HTTP status code */
+                            statusCode: number;
+                            error: {
+                                /**
+                                 * @description The error code
+                                 * @enum {string}
+                                 */
+                                code: "INTERNAL_SERVER_ERROR" | "INVALID_REQUEST_FORMAT";
+                                /** @description The error message */
+                                message: string;
+                                /** @description A suggestion to resolve the error */
+                                suggestion: string;
+                                /** @description A URL to the documentation */
+                                documentationUrl: string;
+                            };
+                            /** @description The unique identifier of the request */
+                            requestId: string;
+                            /** @description The timestamp of the response */
+                            timestamp: string;
+                            /** @description The path of the request */
+                            path: string;
+                        };
+                    };
+                };
+            };
+        };
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/public/envelope/add-blocks": {
         parameters: {
             query?: never;
@@ -1553,7 +1734,7 @@ export interface paths {
         put?: never;
         /**
          * create
-         * @description Create an envelope and the first document placeholder. Optionally accepts a small file directly (max 10 MB) in the request body. If a file is provided, it will be encrypted and uploaded to S3, and pre-signed S3 parameters will not be returned. Otherwise, returns pre-signed S3 parameters for document upload.
+         * @description Create an envelope and the first document placeholder. Optionally accepts a small file directly (max 10 MB) in the request body. If a file is provided, it will be processed and uploaded directly. Otherwise, returns upload parameters for document upload.
          */
         post: {
             parameters: {
@@ -1571,7 +1752,7 @@ export interface paths {
                         envelopeTitle: string;
                         /**
                          * Format: base64
-                         * @description Base64-encoded PDF file data (max 10 MB). If provided, the file will be encrypted and uploaded directly, and presignedS3Params will not be returned.
+                         * @description Base64-encoded PDF file data (max 10 MB). If provided, the file will be processed and uploaded directly, and presignedS3Params will not be returned.
                          */
                         file?: string;
                     };
@@ -1589,31 +1770,31 @@ export interface paths {
                             envelopeUuid: string;
                             /** @description The unique identifier of the first document. */
                             documentUuid: string;
-                            /** @description Pre-signed S3 parameters for document upload. Only returned when no file is provided in the request. */
+                            /** @description Upload parameters for document upload. Only returned when no file is provided in the request. */
                             presignedS3Params?: {
-                                /** @description The pre-signed S3 URL for uploading the document. */
+                                /** @description The URL for uploading the document. */
                                 url: string;
-                                /** @description Fields required for the S3 upload. */
+                                /** @description Fields required for the upload. */
                                 fields: {
-                                    /** @description The S3 bucket name. */
+                                    /** @description The bucket name. */
                                     bucket: string;
-                                    /** @description The S3 key. */
+                                    /** @description The object key. */
                                     key: string;
-                                    /** @description The S3 content type. */
+                                    /** @description The content type. */
                                     "content-type": string;
-                                    /** @description The S3 algorithm. */
+                                    /** @description The algorithm. */
                                     "x-amz-algorithm": string;
-                                    /** @description The S3 credential. */
+                                    /** @description The credential. */
                                     "x-amz-credential": string;
-                                    /** @description The S3 date. */
+                                    /** @description The date. */
                                     "x-amz-date": string;
-                                    /** @description The S3 policy. */
+                                    /** @description The policy. */
                                     policy: string;
-                                    /** @description The S3 signature. */
+                                    /** @description The signature. */
                                     "x-amz-signature": string;
                                 };
                             };
-                            /** @description The encryption key in base64 for the document revision to be used for encryption. */
+                            /** @description The key in base64 for the document revision. */
                             revisionEncryptionKey: string;
                         };
                     };
@@ -1750,6 +1931,185 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/public/envelope/create-from-file": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * create-from-file
+         * @description Create an envelope and the first document placeholder with a file upload. Accepts multipart/form-data with a PDF or Word document file (max 50 MB). DOCX files are converted to PDF. The file is processed and uploaded directly.
+         */
+        post: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path?: never;
+                cookie?: never;
+            };
+            requestBody: {
+                content: {
+                    "multipart/form-data": {
+                        /** @description The UUID of the workspace to create the envelope in. */
+                        workspaceUuid: string;
+                        /** @description The title of the envelope being created. */
+                        envelopeTitle: string;
+                        /** @description The file to upload (PDF or Word document, max 50MB). */
+                        file: unknown;
+                    };
+                };
+            };
+            responses: {
+                /** @description Default Response */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /** @description The unique identifier of the created envelope. */
+                            envelopeUuid: string;
+                            /** @description The unique identifier of the first document. */
+                            documentUuid: string;
+                        };
+                    };
+                };
+                /** @description Default Response */
+                400: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /** @description HTTP status code */
+                            statusCode: number;
+                            error: {
+                                /**
+                                 * @description The error code
+                                 * @enum {string}
+                                 */
+                                code: "WORKSPACE_NOT_FOUND" | "INVALID_FILE_DATA" | "FILE_SIZE_EXCEEDED" | "INVALID_PDF" | "INVALID_REQUEST" | "DOCUMENT_INVALID" | "DOCX_CONVERSION_UNAVAILABLE" | "DOCUMENT_CONVERSION_FAILED" | "INVALID_REQUEST_FORMAT";
+                                /** @description The error message */
+                                message: string;
+                                /** @description A suggestion to resolve the error */
+                                suggestion: string;
+                                /** @description A URL to the documentation */
+                                documentationUrl: string;
+                            };
+                            /** @description The unique identifier of the request */
+                            requestId: string;
+                            /** @description The timestamp of the response */
+                            timestamp: string;
+                            /** @description The path of the request */
+                            path: string;
+                        };
+                    };
+                };
+                /** @description Default Response */
+                401: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /** @description HTTP status code */
+                            statusCode: number;
+                            error: {
+                                /**
+                                 * @description The error code
+                                 * @enum {string}
+                                 */
+                                code: "AUTHENTICATION_ERROR" | "TUNNEL_ERROR" | "INVALID_REQUEST_FORMAT";
+                                /** @description The error message */
+                                message: string;
+                                /** @description A suggestion to resolve the error */
+                                suggestion: string;
+                                /** @description A URL to the documentation */
+                                documentationUrl: string;
+                            };
+                            /** @description The unique identifier of the request */
+                            requestId: string;
+                            /** @description The timestamp of the response */
+                            timestamp: string;
+                            /** @description The path of the request */
+                            path: string;
+                        };
+                    };
+                };
+                /** @description Default Response */
+                403: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /** @description HTTP status code */
+                            statusCode: number;
+                            error: {
+                                /**
+                                 * @description The error code
+                                 * @enum {string}
+                                 */
+                                code: "AUTHORIZATION_ERROR" | "FEATURE_NOT_IN_CURRENT_PLAN" | "INVALID_REQUEST_FORMAT";
+                                /** @description The error message */
+                                message: string;
+                                /** @description A suggestion to resolve the error */
+                                suggestion: string;
+                                /** @description A URL to the documentation */
+                                documentationUrl: string;
+                            };
+                            /** @description The unique identifier of the request */
+                            requestId: string;
+                            /** @description The timestamp of the response */
+                            timestamp: string;
+                            /** @description The path of the request */
+                            path: string;
+                        };
+                    };
+                };
+                /** @description Default Response */
+                500: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /** @description HTTP status code */
+                            statusCode: number;
+                            error: {
+                                /**
+                                 * @description The error code
+                                 * @enum {string}
+                                 */
+                                code: "INTERNAL_SERVER_ERROR" | "INVALID_REQUEST_FORMAT";
+                                /** @description The error message */
+                                message: string;
+                                /** @description A suggestion to resolve the error */
+                                suggestion: string;
+                                /** @description A URL to the documentation */
+                                documentationUrl: string;
+                            };
+                            /** @description The unique identifier of the request */
+                            requestId: string;
+                            /** @description The timestamp of the response */
+                            timestamp: string;
+                            /** @description The path of the request */
+                            path: string;
+                        };
+                    };
+                };
+            };
+        };
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/public/envelope/create-from-template": {
         parameters: {
             query?: never;
@@ -1957,6 +2317,177 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/public/envelope/delete-attachment": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * delete-attachment
+         * @description Delete an attachment document and its revisions
+         */
+        post: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path?: never;
+                cookie?: never;
+            };
+            requestBody: {
+                content: {
+                    "application/json": {
+                        workspaceUuid: string;
+                        envelopeUuid: string;
+                        documentUuid: string;
+                    };
+                };
+            };
+            responses: {
+                /** @description Default Response */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": Record<string, never>;
+                    };
+                };
+                /** @description Default Response */
+                400: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /** @description HTTP status code */
+                            statusCode: number;
+                            error: {
+                                /**
+                                 * @description The error code
+                                 * @enum {string}
+                                 */
+                                code: "WORKSPACE_NOT_FOUND" | "ENVELOPE_NOT_FOUND" | "DOCUMENT_NOT_FOUND" | "DOCUMENT_NOT_ATTACHMENT" | "ENVELOPE_NOT_IN_DRAFT" | "INVALID_REQUEST_FORMAT";
+                                /** @description The error message */
+                                message: string;
+                                /** @description A suggestion to resolve the error */
+                                suggestion: string;
+                                /** @description A URL to the documentation */
+                                documentationUrl: string;
+                            };
+                            /** @description The unique identifier of the request */
+                            requestId: string;
+                            /** @description The timestamp of the response */
+                            timestamp: string;
+                            /** @description The path of the request */
+                            path: string;
+                        };
+                    };
+                };
+                /** @description Default Response */
+                401: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /** @description HTTP status code */
+                            statusCode: number;
+                            error: {
+                                /**
+                                 * @description The error code
+                                 * @enum {string}
+                                 */
+                                code: "AUTHENTICATION_ERROR" | "TUNNEL_ERROR" | "INVALID_REQUEST_FORMAT";
+                                /** @description The error message */
+                                message: string;
+                                /** @description A suggestion to resolve the error */
+                                suggestion: string;
+                                /** @description A URL to the documentation */
+                                documentationUrl: string;
+                            };
+                            /** @description The unique identifier of the request */
+                            requestId: string;
+                            /** @description The timestamp of the response */
+                            timestamp: string;
+                            /** @description The path of the request */
+                            path: string;
+                        };
+                    };
+                };
+                /** @description Default Response */
+                403: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /** @description HTTP status code */
+                            statusCode: number;
+                            error: {
+                                /**
+                                 * @description The error code
+                                 * @enum {string}
+                                 */
+                                code: "AUTHORIZATION_ERROR" | "FEATURE_NOT_IN_CURRENT_PLAN" | "INVALID_REQUEST_FORMAT";
+                                /** @description The error message */
+                                message: string;
+                                /** @description A suggestion to resolve the error */
+                                suggestion: string;
+                                /** @description A URL to the documentation */
+                                documentationUrl: string;
+                            };
+                            /** @description The unique identifier of the request */
+                            requestId: string;
+                            /** @description The timestamp of the response */
+                            timestamp: string;
+                            /** @description The path of the request */
+                            path: string;
+                        };
+                    };
+                };
+                /** @description Default Response */
+                500: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /** @description HTTP status code */
+                            statusCode: number;
+                            error: {
+                                /**
+                                 * @description The error code
+                                 * @enum {string}
+                                 */
+                                code: "INTERNAL_SERVER_ERROR" | "INVALID_REQUEST_FORMAT";
+                                /** @description The error message */
+                                message: string;
+                                /** @description A suggestion to resolve the error */
+                                suggestion: string;
+                                /** @description A URL to the documentation */
+                                documentationUrl: string;
+                            };
+                            /** @description The unique identifier of the request */
+                            requestId: string;
+                            /** @description The timestamp of the response */
+                            timestamp: string;
+                            /** @description The path of the request */
+                            path: string;
+                        };
+                    };
+                };
+            };
+        };
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/public/envelope/delete-blocks": {
         parameters: {
             query?: never;
@@ -2861,7 +3392,7 @@ export interface paths {
         put?: never;
         /**
          * complete-document-upload
-         * @description Verify uploaded document exists on S3, validate as PDF, generate a small preview image, and persist it.
+         * @description Verify uploaded document, validate as PDF, generate a small preview image, and persist it.
          */
         post: {
             parameters: {
@@ -3342,6 +3873,13 @@ export interface paths {
                                 /** @description The number of pages in the document. */
                                 pageCount: number;
                             }[];
+                            /** @description The list of attachments in the envelope. */
+                            attachments: {
+                                /** @description The unique identifier of the attachment. */
+                                uuid: string;
+                                /** @description The title of the attachment. */
+                                title: string;
+                            }[];
                             /** @description The tags of the envelope. */
                             tags: string[];
                             metrics: {
@@ -4548,10 +5086,13 @@ export enum ApiPaths {
     PostPublicContactDelete = "/public/contact/delete",
     PostPublicContactGet = "/public/contact/get",
     PostPublicContactUpdate = "/public/contact/update",
+    PostPublicEnvelopeAddattachment = "/public/envelope/add-attachment",
     PostPublicEnvelopeAddblocks = "/public/envelope/add-blocks",
     PostPublicEnvelopeAddrecipients = "/public/envelope/add-recipients",
     PostPublicEnvelopeCreate = "/public/envelope/create",
+    PostPublicEnvelopeCreatefrom_file = "/public/envelope/create-from-file",
     PostPublicEnvelopeCreatefrom_template = "/public/envelope/create-from-template",
+    PostPublicEnvelopeDeleteattachment = "/public/envelope/delete-attachment",
     PostPublicEnvelopeDeleteblocks = "/public/envelope/delete-blocks",
     PostPublicEnvelopeDelete = "/public/envelope/delete",
     PostPublicEnvelopeDeleterecipients = "/public/envelope/delete-recipients",