@timbro/invoices 0.10.3 → 0.12.0

package/dist/generated/invoice-api-contract.d.ts

@@ -1869,18 +1869,50 @@ export declare const invoiceApiContract: {
             };
             readonly InvoiceFiscalIdentity: {
                 readonly type: "object";
-                readonly required: readonly ["type", "eNcf"];
+                readonly required: readonly ["type", "eNcf", "signature"];
                 readonly properties: {
                     readonly eNcf: {
                         readonly type: "string";
                         readonly pattern: "^E(31|32|33|34|41|43|44|45|46|47)[0-9]{10}$";
                     };
+                    readonly signature: {
+                        readonly oneOf: readonly [{
+                            readonly type: "null";
+                        }, {
+                            readonly $ref: "#/components/schemas/InvoiceSignature";
+                            readonly description: "The facts every printed e-CF must show, `null` until the complete e-CF is signed.";
+                        }];
+                    };
                     readonly type: {
                         readonly $ref: "#/components/schemas/InvoiceType";
                     };
                 };
                 readonly additionalProperties: false;
             };
+            readonly InvoiceSignature: {
+                readonly type: "object";
+                readonly description: "The signature facts DGII requires on every printed e-CF, read from the signed document.\n\nPrint the buyer's copy after DGII accepts the Invoice; DGII sequences the printed e-CF after\nits validation result, including the Type 32 below DOP 250,000 it validates by RFCE summary.";
+                readonly required: readonly ["signedAt", "securityCode", "verificationUrl"];
+                readonly properties: {
+                    readonly securityCode: {
+                        readonly type: "string";
+                        readonly description: "The first six characters of the signature value, printed below the QR code.";
+                        readonly pattern: "^[A-Za-z0-9+/]{6}$";
+                    };
+                    readonly signedAt: {
+                        readonly type: "string";
+                        readonly description: "The exact `FechaHoraFirma` instant as RFC 3339 in DGII's fixed GMT-4, so its date and\ntime read as the printed `dd-MM-aaaa HH:mm:ss`.";
+                        readonly pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}-04:00$";
+                    };
+                    readonly verificationUrl: {
+                        readonly type: "string";
+                        readonly format: "uri";
+                        readonly description: "The DGII consultation URL the printed QR code encodes.";
+                        readonly pattern: "^https://(ecf|fc)\\.dgii\\.gov\\.do/";
+                    };
+                };
+                readonly additionalProperties: false;
+            };
             readonly InvoiceType: {
                 readonly type: "string";
                 readonly enum: readonly ["E31", "E32", "E33", "E34", "E41", "E43", "E44", "E45", "E46", "E47"];
@@ -3559,6 +3591,7 @@ export declare const invoiceApiContract: {
                     };
                     readonly additionalProperties: false;
                 }];
+                readonly description: "Whether the buyer may receive the e-CF: `ready` once DGII received it and answered `Aceptado`\nor `Aceptado Condicional`, never at signing or submission alone.";
                 readonly discriminator: {
                     readonly propertyName: "status";
                 };
@@ -5841,6 +5874,10 @@ export declare const invoiceApiContract: {
                         readonly maxLength: 2048;
                         readonly pattern: "^https://";
                     };
+                    readonly attachments: {
+                        readonly $ref: "#/components/schemas/InvoiceDeliveryAttachmentSelection";
+                        readonly description: "Files attached to the email beside its link. Omitted, the email attaches nothing.";
+                    };
                     readonly recipientEmail: {
                         readonly type: "string";
                         readonly format: "email";
@@ -5850,10 +5887,27 @@ export declare const invoiceApiContract: {
                 };
                 readonly additionalProperties: false;
             };
+            readonly InvoiceDeliveryAttachmentSelection: {
+                readonly type: "object";
+                readonly properties: {
+                    readonly pdf: {
+                        readonly type: "boolean";
+                        readonly description: "Attach the printed representation as `{RNC}{e-NCF}.pdf`.";
+                    };
+                    readonly xml: {
+                        readonly type: "boolean";
+                        readonly description: "Attach the signed e-CF as `{RNC}{e-NCF}.xml`, DGII's file-name standard.";
+                    };
+                };
+                readonly additionalProperties: false;
+            };
             readonly InvoiceDeliveryResource: {
                 readonly type: "object";
-                readonly required: readonly ["id", "invoiceId", "recipientEmail", "state", "link", "lastResultCode", "providerDeliveryId", "createdAt", "updatedAt"];
+                readonly required: readonly ["id", "invoiceId", "recipientEmail", "attachments", "state", "link", "lastResultCode", "providerDeliveryId", "createdAt", "updatedAt"];
                 readonly properties: {
+                    readonly attachments: {
+                        readonly $ref: "#/components/schemas/InvoiceDeliveryAttachments";
+                    };
                     readonly createdAt: {
                         readonly type: "string";
                         readonly format: "date-time";
@@ -5888,6 +5942,20 @@ export declare const invoiceApiContract: {
                 };
                 readonly additionalProperties: false;
             };
+            readonly InvoiceDeliveryAttachments: {
+                readonly type: "object";
+                readonly description: "The files this email attaches beside its link.";
+                readonly required: readonly ["pdf", "xml"];
+                readonly properties: {
+                    readonly pdf: {
+                        readonly type: "boolean";
+                    };
+                    readonly xml: {
+                        readonly type: "boolean";
+                    };
+                };
+                readonly additionalProperties: false;
+            };
             readonly FiscalDeliveryState: {
                 readonly type: "string";
                 readonly enum: readonly ["pending", "submitted", "delivered", "bounced", "failed", "suppressed"];
@@ -6365,6 +6433,122 @@ export declare const invoiceApiContract: {
                         };
                     };
                     readonly additionalProperties: false;
+                }, {
+                    readonly type: "object";
+                    readonly title: "InvoiceDeliverySentEvent";
+                    readonly required: readonly ["data", "type", "apiVersion", "object", "id", "sequence", "occurredAt", "organizationId", "environment"];
+                    readonly properties: {
+                        readonly apiVersion: {
+                            readonly type: "string";
+                            readonly minLength: 1;
+                        };
+                        readonly data: {
+                            readonly type: "object";
+                            readonly title: "InvoiceDeliveryEventData";
+                            readonly description: "The Invoice and the buyer email whose sent or failed outcome the event announces.";
+                            readonly required: readonly ["id", "sourceConnectionId", "deliveryId"];
+                            readonly properties: {
+                                readonly deliveryId: {
+                                    readonly type: "string";
+                                    readonly format: "uuid";
+                                };
+                                readonly id: {
+                                    readonly type: "string";
+                                    readonly format: "uuid";
+                                };
+                                readonly sourceConnectionId: {
+                                    readonly type: "string";
+                                    readonly format: "uuid";
+                                };
+                            };
+                            readonly additionalProperties: false;
+                        };
+                        readonly environment: {
+                            readonly $ref: "#/components/schemas/FiscalEnvironment";
+                        };
+                        readonly id: {
+                            readonly type: "string";
+                            readonly format: "uuid";
+                        };
+                        readonly object: {
+                            readonly $ref: "#/components/schemas/WebhookEventObject";
+                        };
+                        readonly occurredAt: {
+                            readonly type: "string";
+                            readonly format: "date-time";
+                        };
+                        readonly organizationId: {
+                            readonly type: "string";
+                            readonly format: "uuid";
+                        };
+                        readonly sequence: {
+                            readonly type: "string";
+                            readonly pattern: "^[1-9][0-9]*$";
+                        };
+                        readonly type: {
+                            readonly type: "string";
+                            readonly enum: readonly ["invoice.deliverySent"];
+                        };
+                    };
+                    readonly additionalProperties: false;
+                }, {
+                    readonly type: "object";
+                    readonly title: "InvoiceDeliveryFailedEvent";
+                    readonly required: readonly ["data", "type", "apiVersion", "object", "id", "sequence", "occurredAt", "organizationId", "environment"];
+                    readonly properties: {
+                        readonly apiVersion: {
+                            readonly type: "string";
+                            readonly minLength: 1;
+                        };
+                        readonly data: {
+                            readonly type: "object";
+                            readonly title: "InvoiceDeliveryEventData";
+                            readonly description: "The Invoice and the buyer email whose sent or failed outcome the event announces.";
+                            readonly required: readonly ["id", "sourceConnectionId", "deliveryId"];
+                            readonly properties: {
+                                readonly deliveryId: {
+                                    readonly type: "string";
+                                    readonly format: "uuid";
+                                };
+                                readonly id: {
+                                    readonly type: "string";
+                                    readonly format: "uuid";
+                                };
+                                readonly sourceConnectionId: {
+                                    readonly type: "string";
+                                    readonly format: "uuid";
+                                };
+                            };
+                            readonly additionalProperties: false;
+                        };
+                        readonly environment: {
+                            readonly $ref: "#/components/schemas/FiscalEnvironment";
+                        };
+                        readonly id: {
+                            readonly type: "string";
+                            readonly format: "uuid";
+                        };
+                        readonly object: {
+                            readonly $ref: "#/components/schemas/WebhookEventObject";
+                        };
+                        readonly occurredAt: {
+                            readonly type: "string";
+                            readonly format: "date-time";
+                        };
+                        readonly organizationId: {
+                            readonly type: "string";
+                            readonly format: "uuid";
+                        };
+                        readonly sequence: {
+                            readonly type: "string";
+                            readonly pattern: "^[1-9][0-9]*$";
+                        };
+                        readonly type: {
+                            readonly type: "string";
+                            readonly enum: readonly ["invoice.deliveryFailed"];
+                        };
+                    };
+                    readonly additionalProperties: false;
                 }];
                 readonly discriminator: {
                     readonly propertyName: "type";