@spaceinvoices/js-sdk 2.0.0 → 2.1.0

package/dist/generated-zod/document-render/document-render.d.ts

@@ -28,8 +28,8 @@ export declare const renderDocumentQueryParams: zod.ZodObject<{
         false: "false";
     }>>;
     type: zod.ZodDefault<zod.ZodEnum<{
-        estimate: "estimate";
         invoice: "invoice";
+        estimate: "estimate";
         credit_note: "credit_note";
         advance_invoice: "advance_invoice";
     }>>;

package/dist/generated-zod/documents/documents.d.cts

@@ -12,8 +12,8 @@ import * as zod from "zod";
  */
 export declare const GetNextDocumentNumberQueryParams: zod.ZodObject<{
     type: zod.ZodEnum<{
-        estimate: "estimate";
         invoice: "invoice";
+        estimate: "estimate";
         credit_note: "credit_note";
         advance_invoice: "advance_invoice";
     }>;
@@ -39,8 +39,8 @@ export declare const FinalizeDocumentParams: zod.ZodObject<{
 }, zod.z.core.$strip>;
 export declare const FinalizeDocumentQueryParams: zod.ZodObject<{
     type: zod.ZodEnum<{
-        estimate: "estimate";
         invoice: "invoice";
+        estimate: "estimate";
         credit_note: "credit_note";
         advance_invoice: "advance_invoice";
     }>;
@@ -58,8 +58,8 @@ export declare const DeleteDocumentParams: zod.ZodObject<{
 }, zod.z.core.$strip>;
 export declare const DeleteDocumentQueryParams: zod.ZodObject<{
     type: zod.ZodEnum<{
-        estimate: "estimate";
         invoice: "invoice";
+        estimate: "estimate";
         credit_note: "credit_note";
         advance_invoice: "advance_invoice";
     }>;
@@ -67,6 +67,73 @@ export declare const DeleteDocumentQueryParams: zod.ZodObject<{
 export declare const DeleteDocumentHeader: zod.ZodObject<{
     "x-entity-id": zod.ZodOptional<zod.ZodString>;
 }, zod.z.core.$strip>;
+/**
+ * Restore a soft-deleted document from the trash. The document will be returned to its original state.
+ * @summary Restore a deleted document
+ */
+export declare const RestoreDocumentParams: zod.ZodObject<{
+    id: zod.ZodString;
+}, zod.z.core.$strip>;
+export declare const RestoreDocumentQueryParams: zod.ZodObject<{
+    type: zod.ZodEnum<{
+        invoice: "invoice";
+        estimate: "estimate";
+        credit_note: "credit_note";
+        advance_invoice: "advance_invoice";
+    }>;
+}, zod.z.core.$strip>;
+export declare const RestoreDocumentHeader: zod.ZodObject<{
+    "x-entity-id": zod.ZodOptional<zod.ZodString>;
+}, zod.z.core.$strip>;
+export declare const RestoreDocumentResponse: zod.ZodUnknown;
+/**
+ * Permanently delete a soft-deleted document. Only documents in the trash can be permanently deleted. Only draft documents and estimates can be permanently deleted.
+ * @summary Permanently delete a document
+ */
+export declare const PermanentDeleteDocumentParams: zod.ZodObject<{
+    id: zod.ZodString;
+}, zod.z.core.$strip>;
+export declare const PermanentDeleteDocumentQueryParams: zod.ZodObject<{
+    type: zod.ZodEnum<{
+        invoice: "invoice";
+        estimate: "estimate";
+        credit_note: "credit_note";
+        advance_invoice: "advance_invoice";
+    }>;
+}, zod.z.core.$strip>;
+export declare const PermanentDeleteDocumentHeader: zod.ZodObject<{
+    "x-entity-id": zod.ZodOptional<zod.ZodString>;
+}, zod.z.core.$strip>;
+/**
+ * Send a document via email. Automatically generates a public shareable link and optionally attaches the PDF. Supports markdown formatting and template variables in the email body.
+ * @summary Send document via email
+ */
+export declare const SendDocumentParams: zod.ZodObject<{
+    id: zod.ZodString;
+}, zod.z.core.$strip>;
+export declare const SendDocumentHeader: zod.ZodObject<{
+    "x-entity-id": zod.ZodOptional<zod.ZodString>;
+}, zod.z.core.$strip>;
+export declare const sendDocumentBodySubjectMax = 255;
+export declare const sendDocumentBodyAttachPdfDefault = false;
+export declare const sendDocumentBodyAttachEslogDefault = false;
+export declare const SendDocumentBody: zod.ZodObject<{
+    to: zod.ZodString;
+    subject: zod.ZodOptional<zod.ZodString>;
+    body_text: zod.ZodOptional<zod.ZodString>;
+    attach_pdf: zod.ZodDefault<zod.ZodBoolean>;
+    attach_eslog: zod.ZodDefault<zod.ZodBoolean>;
+}, zod.z.core.$strip>;
+export declare const SendDocumentResponse: zod.ZodObject<{
+    message_id: zod.ZodString;
+    status: zod.ZodEnum<{
+        sent: "sent";
+        queued: "queued";
+    }>;
+    to: zod.ZodString;
+    subject: zod.ZodString;
+    shareable_link: zod.ZodOptional<zod.ZodString>;
+}, zod.z.core.$strip>;
 /**
  * Generate a shareable token for a document. Document type is automatically detected from the ID prefix (inv_, est_, cre_, adv_). If the document is already shared, returns the existing token. Can be used to re-share a document that was previously unshared.
  * @summary Make document shareable

package/dist/generated-zod/documents/documents.d.ts

@@ -12,8 +12,8 @@ import * as zod from "zod";
  */
 export declare const GetNextDocumentNumberQueryParams: zod.ZodObject<{
     type: zod.ZodEnum<{
-        estimate: "estimate";
         invoice: "invoice";
+        estimate: "estimate";
         credit_note: "credit_note";
         advance_invoice: "advance_invoice";
     }>;
@@ -39,8 +39,8 @@ export declare const FinalizeDocumentParams: zod.ZodObject<{
 }, zod.z.core.$strip>;
 export declare const FinalizeDocumentQueryParams: zod.ZodObject<{
     type: zod.ZodEnum<{
-        estimate: "estimate";
         invoice: "invoice";
+        estimate: "estimate";
         credit_note: "credit_note";
         advance_invoice: "advance_invoice";
     }>;
@@ -58,8 +58,8 @@ export declare const DeleteDocumentParams: zod.ZodObject<{
 }, zod.z.core.$strip>;
 export declare const DeleteDocumentQueryParams: zod.ZodObject<{
     type: zod.ZodEnum<{
-        estimate: "estimate";
         invoice: "invoice";
+        estimate: "estimate";
         credit_note: "credit_note";
         advance_invoice: "advance_invoice";
     }>;
@@ -67,6 +67,73 @@ export declare const DeleteDocumentQueryParams: zod.ZodObject<{
 export declare const DeleteDocumentHeader: zod.ZodObject<{
     "x-entity-id": zod.ZodOptional<zod.ZodString>;
 }, zod.z.core.$strip>;
+/**
+ * Restore a soft-deleted document from the trash. The document will be returned to its original state.
+ * @summary Restore a deleted document
+ */
+export declare const RestoreDocumentParams: zod.ZodObject<{
+    id: zod.ZodString;
+}, zod.z.core.$strip>;
+export declare const RestoreDocumentQueryParams: zod.ZodObject<{
+    type: zod.ZodEnum<{
+        invoice: "invoice";
+        estimate: "estimate";
+        credit_note: "credit_note";
+        advance_invoice: "advance_invoice";
+    }>;
+}, zod.z.core.$strip>;
+export declare const RestoreDocumentHeader: zod.ZodObject<{
+    "x-entity-id": zod.ZodOptional<zod.ZodString>;
+}, zod.z.core.$strip>;
+export declare const RestoreDocumentResponse: zod.ZodUnknown;
+/**
+ * Permanently delete a soft-deleted document. Only documents in the trash can be permanently deleted. Only draft documents and estimates can be permanently deleted.
+ * @summary Permanently delete a document
+ */
+export declare const PermanentDeleteDocumentParams: zod.ZodObject<{
+    id: zod.ZodString;
+}, zod.z.core.$strip>;
+export declare const PermanentDeleteDocumentQueryParams: zod.ZodObject<{
+    type: zod.ZodEnum<{
+        invoice: "invoice";
+        estimate: "estimate";
+        credit_note: "credit_note";
+        advance_invoice: "advance_invoice";
+    }>;
+}, zod.z.core.$strip>;
+export declare const PermanentDeleteDocumentHeader: zod.ZodObject<{
+    "x-entity-id": zod.ZodOptional<zod.ZodString>;
+}, zod.z.core.$strip>;
+/**
+ * Send a document via email. Automatically generates a public shareable link and optionally attaches the PDF. Supports markdown formatting and template variables in the email body.
+ * @summary Send document via email
+ */
+export declare const SendDocumentParams: zod.ZodObject<{
+    id: zod.ZodString;
+}, zod.z.core.$strip>;
+export declare const SendDocumentHeader: zod.ZodObject<{
+    "x-entity-id": zod.ZodOptional<zod.ZodString>;
+}, zod.z.core.$strip>;
+export declare const sendDocumentBodySubjectMax = 255;
+export declare const sendDocumentBodyAttachPdfDefault = false;
+export declare const sendDocumentBodyAttachEslogDefault = false;
+export declare const SendDocumentBody: zod.ZodObject<{
+    to: zod.ZodString;
+    subject: zod.ZodOptional<zod.ZodString>;
+    body_text: zod.ZodOptional<zod.ZodString>;
+    attach_pdf: zod.ZodDefault<zod.ZodBoolean>;
+    attach_eslog: zod.ZodDefault<zod.ZodBoolean>;
+}, zod.z.core.$strip>;
+export declare const SendDocumentResponse: zod.ZodObject<{
+    message_id: zod.ZodString;
+    status: zod.ZodEnum<{
+        sent: "sent";
+        queued: "queued";
+    }>;
+    to: zod.ZodString;
+    subject: zod.ZodString;
+    shareable_link: zod.ZodOptional<zod.ZodString>;
+}, zod.z.core.$strip>;
 /**
  * Generate a shareable token for a document. Document type is automatically detected from the ID prefix (inv_, est_, cre_, adv_). If the document is already shared, returns the existing token. Can be used to re-share a document that was previously unshared.
  * @summary Make document shareable

package/dist/generated-zod/documents/documents.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"documents.d.ts","sourceRoot":"","sources":["../../../src/generated-zod/documents/documents.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,OAAO,KAAK,GAAG,MAAM,KAAK,CAAC;AAE3B;;;GAGG;AACH,eAAO,MAAM,gCAAgC;;;;;;;;;qBAY3C,CAAC;AAEH,eAAO,MAAM,2BAA2B;;qBAQtC,CAAC;AAEH,eAAO,MAAM,6BAA6B;;;;;;qBASxC,CAAC;AAEH;;;GAGG;AACH,eAAO,MAAM,sBAAsB;;qBAEjC,CAAC;AAEH,eAAO,MAAM,2BAA2B;;;;;;;qBAEtC,CAAC;AAEH,eAAO,MAAM,sBAAsB;;qBAQjC,CAAC;AAEH,eAAO,MAAM,wBAAwB,gBAAgB,CAAC;AAEtD;;;GAGG;AACH,eAAO,MAAM,oBAAoB;;qBAE/B,CAAC;AAEH,eAAO,MAAM,yBAAyB;;;;;;;qBAEpC,CAAC;AAEH,eAAO,MAAM,oBAAoB;;qBAQ/B,CAAC;AAEH;;;GAGG;AACH,eAAO,MAAM,yBAAyB,QAA8B,CAAC;AAErE,eAAO,MAAM,mBAAmB;;qBAE9B,CAAC;AAEH,eAAO,MAAM,mBAAmB;;qBAQ9B,CAAC;AAEH,eAAO,MAAM,qBAAqB;;qBAIqB,CAAC;AAExD;;;GAGG;AACH,eAAO,MAAM,0BAA0B,QAA8B,CAAC;AAEtE,eAAO,MAAM,oBAAoB;;qBAE/B,CAAC;AAEH,eAAO,MAAM,oBAAoB;;qBAQ/B,CAAC;AAEH,eAAO,MAAM,sBAAsB;;qBAIoB,CAAC;AAExD;;;GAGG;AACH,eAAO,MAAM,2BAA2B,QAA8B,CAAC;AAEvE,eAAO,MAAM,qBAAqB;;qBAEhC,CAAC;AAEH,eAAO,MAAM,qBAAqB;;qBAQhC,CAAC"}
+{"version":3,"file":"documents.d.ts","sourceRoot":"","sources":["../../../src/generated-zod/documents/documents.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,OAAO,KAAK,GAAG,MAAM,KAAK,CAAC;AAE3B;;;GAGG;AACH,eAAO,MAAM,gCAAgC;;;;;;;;;qBAY3C,CAAC;AAEH,eAAO,MAAM,2BAA2B;;qBAQtC,CAAC;AAEH,eAAO,MAAM,6BAA6B;;;;;;qBASxC,CAAC;AAEH;;;GAGG;AACH,eAAO,MAAM,sBAAsB;;qBAEjC,CAAC;AAEH,eAAO,MAAM,2BAA2B;;;;;;;qBAEtC,CAAC;AAEH,eAAO,MAAM,sBAAsB;;qBAQjC,CAAC;AAEH,eAAO,MAAM,wBAAwB,gBAAgB,CAAC;AAEtD;;;GAGG;AACH,eAAO,MAAM,oBAAoB;;qBAE/B,CAAC;AAEH,eAAO,MAAM,yBAAyB;;;;;;;qBAEpC,CAAC;AAEH,eAAO,MAAM,oBAAoB;;qBAQ/B,CAAC;AAEH;;;GAGG;AACH,eAAO,MAAM,qBAAqB;;qBAEhC,CAAC;AAEH,eAAO,MAAM,0BAA0B;;;;;;;qBAErC,CAAC;AAEH,eAAO,MAAM,qBAAqB;;qBAQhC,CAAC;AAEH,eAAO,MAAM,uBAAuB,gBAAgB,CAAC;AAErD;;;GAGG;AACH,eAAO,MAAM,6BAA6B;;qBAExC,CAAC;AAEH,eAAO,MAAM,kCAAkC;;;;;;;qBAE7C,CAAC;AAEH,eAAO,MAAM,6BAA6B;;qBAQxC,CAAC;AAEH;;;GAGG;AACH,eAAO,MAAM,kBAAkB;;qBAE7B,CAAC;AAEH,eAAO,MAAM,kBAAkB;;qBAQ7B,CAAC;AAEH,eAAO,MAAM,0BAA0B,MAAM,CAAC;AAE9C,eAAO,MAAM,gCAAgC,QAAQ,CAAC;AACtD,eAAO,MAAM,kCAAkC,QAAQ,CAAC;AAExD,eAAO,MAAM,gBAAgB;;;;;;qBAuB3B,CAAC;AAEH,eAAO,MAAM,oBAAoB;;;;;;;;;qBAU/B,CAAC;AAEH;;;GAGG;AACH,eAAO,MAAM,yBAAyB,QAA8B,CAAC;AAErE,eAAO,MAAM,mBAAmB;;qBAE9B,CAAC;AAEH,eAAO,MAAM,mBAAmB;;qBAQ9B,CAAC;AAEH,eAAO,MAAM,qBAAqB;;qBAIqB,CAAC;AAExD;;;GAGG;AACH,eAAO,MAAM,0BAA0B,QAA8B,CAAC;AAEtE,eAAO,MAAM,oBAAoB;;qBAE/B,CAAC;AAEH,eAAO,MAAM,oBAAoB;;qBAQ/B,CAAC;AAEH,eAAO,MAAM,sBAAsB;;qBAIoB,CAAC;AAExD;;;GAGG;AACH,eAAO,MAAM,2BAA2B,QAA8B,CAAC;AAEvE,eAAO,MAAM,qBAAqB;;qBAEhC,CAAC;AAEH,eAAO,MAAM,qBAAqB;;qBAQhC,CAAC"}

package/dist/generated-zod/e-slog/e-slog.d.cts

@@ -16,8 +16,8 @@ export declare const validateDocumentEslogParams: zod.ZodObject<{
 export declare const validateDocumentEslogQueryTypeDefault = "invoice";
 export declare const validateDocumentEslogQueryParams: zod.ZodObject<{
     type: zod.ZodDefault<zod.ZodEnum<{
-        estimate: "estimate";
         invoice: "invoice";
+        estimate: "estimate";
         credit_note: "credit_note";
     }>>;
 }, zod.z.core.$strip>;
@@ -48,8 +48,8 @@ export declare const downloadDocumentEslogParams: zod.ZodObject<{
 export declare const downloadDocumentEslogQueryTypeDefault = "invoice";
 export declare const downloadDocumentEslogQueryParams: zod.ZodObject<{
     type: zod.ZodDefault<zod.ZodEnum<{
-        estimate: "estimate";
         invoice: "invoice";
+        estimate: "estimate";
         credit_note: "credit_note";
     }>>;
 }, zod.z.core.$strip>;

package/dist/generated-zod/e-slog/e-slog.d.ts

@@ -16,8 +16,8 @@ export declare const validateDocumentEslogParams: zod.ZodObject<{
 export declare const validateDocumentEslogQueryTypeDefault = "invoice";
 export declare const validateDocumentEslogQueryParams: zod.ZodObject<{
     type: zod.ZodDefault<zod.ZodEnum<{
-        estimate: "estimate";
         invoice: "invoice";
+        estimate: "estimate";
         credit_note: "credit_note";
     }>>;
 }, zod.z.core.$strip>;
@@ -48,8 +48,8 @@ export declare const downloadDocumentEslogParams: zod.ZodObject<{
 export declare const downloadDocumentEslogQueryTypeDefault = "invoice";
 export declare const downloadDocumentEslogQueryParams: zod.ZodObject<{
     type: zod.ZodDefault<zod.ZodEnum<{
-        estimate: "estimate";
         invoice: "invoice";
+        estimate: "estimate";
         credit_note: "credit_note";
     }>>;
 }, zod.z.core.$strip>;

package/dist/generated-zod/email/email.d.cts

@@ -7,7 +7,7 @@
  */
 import * as zod from "zod";
 /**
- * Send an email with automatic company logo and optional document attachment. When a documentId is provided, a public shareable link is automatically generated and can be included in the email body using the {invoice_link} variable. If the variable is not used, the link is appended to the body. The PDF attachment is opt-in via attachPdf flag (default: false). Email body supports markdown formatting and template variables like {document_number}, {customer_name}, {entity_name}, {invoice_link}, etc.
+ * Send an email with automatic company logo and optional document attachment. When a document_id is provided, a public shareable link is automatically generated and can be included in the email body using the {invoice_link} variable. If the variable is not used, the link is appended to the body. The PDF attachment is opt-in via attach_pdf flag (default: false). Email body supports markdown formatting and template variables like {document_number}, {customer_name}, {entity_name}, {invoice_link}, etc.
  * @summary Send email with optional PDF attachment
  */
 export declare const SendEmailHeader: zod.ZodObject<{
@@ -19,19 +19,19 @@ export declare const sendEmailBodyAttachEslogDefault = false;
 export declare const SendEmailBody: zod.ZodObject<{
     to: zod.ZodString;
     subject: zod.ZodOptional<zod.ZodString>;
-    bodyText: zod.ZodOptional<zod.ZodString>;
-    documentId: zod.ZodOptional<zod.ZodString>;
-    attachPdf: zod.ZodDefault<zod.ZodBoolean>;
-    attachEslog: zod.ZodDefault<zod.ZodBoolean>;
+    body_text: zod.ZodOptional<zod.ZodString>;
+    document_id: zod.ZodOptional<zod.ZodString>;
+    attach_pdf: zod.ZodDefault<zod.ZodBoolean>;
+    attach_eslog: zod.ZodDefault<zod.ZodBoolean>;
 }, zod.z.core.$strip>;
 export declare const SendEmailResponse: zod.ZodObject<{
-    messageId: zod.ZodString;
+    message_id: zod.ZodString;
     status: zod.ZodEnum<{
         sent: "sent";
         queued: "queued";
     }>;
     to: zod.ZodString;
     subject: zod.ZodString;
-    shareableLink: zod.ZodOptional<zod.ZodString>;
+    shareable_link: zod.ZodOptional<zod.ZodString>;
 }, zod.z.core.$strip>;
 //# sourceMappingURL=email.d.ts.map

package/dist/generated-zod/email/email.d.ts

@@ -7,7 +7,7 @@
  */
 import * as zod from "zod";
 /**
- * Send an email with automatic company logo and optional document attachment. When a documentId is provided, a public shareable link is automatically generated and can be included in the email body using the {invoice_link} variable. If the variable is not used, the link is appended to the body. The PDF attachment is opt-in via attachPdf flag (default: false). Email body supports markdown formatting and template variables like {document_number}, {customer_name}, {entity_name}, {invoice_link}, etc.
+ * Send an email with automatic company logo and optional document attachment. When a document_id is provided, a public shareable link is automatically generated and can be included in the email body using the {invoice_link} variable. If the variable is not used, the link is appended to the body. The PDF attachment is opt-in via attach_pdf flag (default: false). Email body supports markdown formatting and template variables like {document_number}, {customer_name}, {entity_name}, {invoice_link}, etc.
  * @summary Send email with optional PDF attachment
  */
 export declare const SendEmailHeader: zod.ZodObject<{
@@ -19,19 +19,19 @@ export declare const sendEmailBodyAttachEslogDefault = false;
 export declare const SendEmailBody: zod.ZodObject<{
     to: zod.ZodString;
     subject: zod.ZodOptional<zod.ZodString>;
-    bodyText: zod.ZodOptional<zod.ZodString>;
-    documentId: zod.ZodOptional<zod.ZodString>;
-    attachPdf: zod.ZodDefault<zod.ZodBoolean>;
-    attachEslog: zod.ZodDefault<zod.ZodBoolean>;
+    body_text: zod.ZodOptional<zod.ZodString>;
+    document_id: zod.ZodOptional<zod.ZodString>;
+    attach_pdf: zod.ZodDefault<zod.ZodBoolean>;
+    attach_eslog: zod.ZodDefault<zod.ZodBoolean>;
 }, zod.z.core.$strip>;
 export declare const SendEmailResponse: zod.ZodObject<{
-    messageId: zod.ZodString;
+    message_id: zod.ZodString;
     status: zod.ZodEnum<{
         sent: "sent";
         queued: "queued";
     }>;
     to: zod.ZodString;
     subject: zod.ZodString;
-    shareableLink: zod.ZodOptional<zod.ZodString>;
+    shareable_link: zod.ZodOptional<zod.ZodString>;
 }, zod.z.core.$strip>;
 //# sourceMappingURL=email.d.ts.map