@voyant-travel/finance 0.157.0 → 0.158.0

package/dist/voyant-event-schemas.d.ts

@@ -0,0 +1,759 @@
+/** Static payload schemas used by the import-cheap Finance deployment manifest. */
+export declare const invoiceTypeSchema: {
+    readonly enum: readonly ["invoice", "proforma", "credit_note"];
+};
+export declare const invoiceStatusSchema: {
+    readonly enum: readonly ["draft", "pending_external_allocation", "issued", "partially_paid", "paid", "overdue", "void"];
+};
+export declare const renditionFormatSchema: {
+    readonly enum: readonly ["html", "pdf", "xml", "json"];
+};
+export declare const nullableStringSchema: {
+    readonly type: readonly ["string", "null"];
+};
+export declare const invoiceIssuedPayloadSchema: {
+    readonly type: "object";
+    readonly required: readonly ["invoiceId", "invoiceNumber", "invoiceType", "bookingId", "totalCents", "currency"];
+    readonly properties: {
+        readonly invoiceId: {
+            readonly type: "string";
+        };
+        readonly invoiceNumber: {
+            readonly type: "string";
+        };
+        readonly invoiceType: {
+            readonly enum: readonly ["invoice", "proforma", "credit_note"];
+        };
+        readonly bookingId: {
+            readonly type: readonly ["string", "null"];
+        };
+        readonly totalCents: {
+            readonly type: "integer";
+        };
+        readonly currency: {
+            readonly type: "string";
+        };
+        readonly baseCurrency: {
+            readonly type: "string";
+        };
+        readonly fxRateSetId: {
+            readonly type: "string";
+        };
+        readonly fxRate: {
+            readonly type: "number";
+        };
+        readonly fxRateSource: {
+            readonly type: "string";
+        };
+        readonly fxRateQuotedAt: {
+            readonly type: "string";
+            readonly format: "date-time";
+        };
+        readonly fxRateValidUntil: {
+            readonly type: "string";
+            readonly format: "date-time";
+        };
+        readonly fxCommissionBps: {
+            readonly type: "integer";
+        };
+        readonly effectiveRate: {
+            readonly type: "number";
+        };
+        readonly fxCommissionInvoiceMention: {
+            readonly type: "string";
+        };
+        readonly convertedFromInvoiceId: {
+            readonly type: readonly ["string", "null"];
+        };
+        readonly clientName: {
+            readonly type: "string";
+        };
+        readonly clientEmail: {
+            readonly type: readonly ["string", "null"];
+        };
+        readonly clientPhone: {
+            readonly type: readonly ["string", "null"];
+        };
+        readonly clientAddress: {
+            readonly type: readonly ["string", "null"];
+        };
+        readonly clientCity: {
+            readonly type: readonly ["string", "null"];
+        };
+        readonly clientCounty: {
+            readonly type: readonly ["string", "null"];
+        };
+        readonly clientCountry: {
+            readonly type: readonly ["string", "null"];
+        };
+        readonly clientVatCode: {
+            readonly type: readonly ["string", "null"];
+        };
+        readonly clientRegCom: {
+            readonly type: readonly ["string", "null"];
+        };
+        readonly lineItems: {
+            readonly type: "array";
+            readonly items: {
+                readonly type: "object";
+                readonly required: readonly ["description", "quantity", "unitPrice", "currency"];
+                readonly properties: {
+                    readonly description: {
+                        readonly type: "string";
+                    };
+                    readonly quantity: {
+                        readonly type: "number";
+                    };
+                    readonly unitPrice: {
+                        readonly type: "number";
+                    };
+                    readonly currency: {
+                        readonly type: "string";
+                    };
+                    readonly bookingPaymentScheduleId: {
+                        readonly type: "string";
+                    };
+                    readonly scheduleType: {
+                        readonly enum: readonly ["deposit", "installment", "balance", "hold", "other"];
+                    };
+                    readonly schedulePercent: {
+                        readonly type: "number";
+                    };
+                    readonly taxPercentage: {
+                        readonly type: "number";
+                    };
+                    readonly taxName: {
+                        readonly type: readonly ["string", "null"];
+                    };
+                    readonly taxRegimeCode: {
+                        readonly type: readonly ["string", "null"];
+                        readonly enum: readonly ["standard", "reduced", "exempt", "reverse_charge", "margin_scheme_art311", "zero_rated", "out_of_scope", "other", null];
+                    };
+                    readonly isService: {
+                        readonly type: "boolean";
+                    };
+                };
+                readonly additionalProperties: false;
+            };
+        };
+        readonly bookingNumber: {
+            readonly type: readonly ["string", "null"];
+        };
+        readonly issueDate: {
+            readonly type: "string";
+        };
+        readonly dueDate: {
+            readonly type: "string";
+        };
+        readonly externalAllocationRequired: {
+            readonly type: "boolean";
+        };
+        readonly externalProvider: {
+            readonly type: readonly ["string", "null"];
+        };
+        readonly externalConfigKey: {
+            readonly type: readonly ["string", "null"];
+        };
+        readonly externalSeriesId: {
+            readonly type: readonly ["string", "null"];
+        };
+        readonly externalPlaceholderNumber: {
+            readonly type: readonly ["string", "null"];
+        };
+        readonly skipExternalSync: {
+            readonly type: "boolean";
+        };
+    };
+    readonly additionalProperties: false;
+};
+export declare const invoiceProformaConvertedPayloadSchema: {
+    readonly required: readonly ["invoiceId", "invoiceNumber", "invoiceType", "bookingId", "totalCents", "currency", "id", "proformaId", "proformaInvoiceNumber"];
+    readonly properties: {
+        readonly id: {
+            readonly type: "string";
+        };
+        readonly proformaId: {
+            readonly type: "string";
+        };
+        readonly proformaInvoiceNumber: {
+            readonly type: "string";
+        };
+        readonly invoiceId: {
+            readonly type: "string";
+        };
+        readonly invoiceNumber: {
+            readonly type: "string";
+        };
+        readonly invoiceType: {
+            readonly enum: readonly ["invoice", "proforma", "credit_note"];
+        };
+        readonly bookingId: {
+            readonly type: readonly ["string", "null"];
+        };
+        readonly totalCents: {
+            readonly type: "integer";
+        };
+        readonly currency: {
+            readonly type: "string";
+        };
+        readonly baseCurrency: {
+            readonly type: "string";
+        };
+        readonly fxRateSetId: {
+            readonly type: "string";
+        };
+        readonly fxRate: {
+            readonly type: "number";
+        };
+        readonly fxRateSource: {
+            readonly type: "string";
+        };
+        readonly fxRateQuotedAt: {
+            readonly type: "string";
+            readonly format: "date-time";
+        };
+        readonly fxRateValidUntil: {
+            readonly type: "string";
+            readonly format: "date-time";
+        };
+        readonly fxCommissionBps: {
+            readonly type: "integer";
+        };
+        readonly effectiveRate: {
+            readonly type: "number";
+        };
+        readonly fxCommissionInvoiceMention: {
+            readonly type: "string";
+        };
+        readonly convertedFromInvoiceId: {
+            readonly type: readonly ["string", "null"];
+        };
+        readonly clientName: {
+            readonly type: "string";
+        };
+        readonly clientEmail: {
+            readonly type: readonly ["string", "null"];
+        };
+        readonly clientPhone: {
+            readonly type: readonly ["string", "null"];
+        };
+        readonly clientAddress: {
+            readonly type: readonly ["string", "null"];
+        };
+        readonly clientCity: {
+            readonly type: readonly ["string", "null"];
+        };
+        readonly clientCounty: {
+            readonly type: readonly ["string", "null"];
+        };
+        readonly clientCountry: {
+            readonly type: readonly ["string", "null"];
+        };
+        readonly clientVatCode: {
+            readonly type: readonly ["string", "null"];
+        };
+        readonly clientRegCom: {
+            readonly type: readonly ["string", "null"];
+        };
+        readonly lineItems: {
+            readonly type: "array";
+            readonly items: {
+                readonly type: "object";
+                readonly required: readonly ["description", "quantity", "unitPrice", "currency"];
+                readonly properties: {
+                    readonly description: {
+                        readonly type: "string";
+                    };
+                    readonly quantity: {
+                        readonly type: "number";
+                    };
+                    readonly unitPrice: {
+                        readonly type: "number";
+                    };
+                    readonly currency: {
+                        readonly type: "string";
+                    };
+                    readonly bookingPaymentScheduleId: {
+                        readonly type: "string";
+                    };
+                    readonly scheduleType: {
+                        readonly enum: readonly ["deposit", "installment", "balance", "hold", "other"];
+                    };
+                    readonly schedulePercent: {
+                        readonly type: "number";
+                    };
+                    readonly taxPercentage: {
+                        readonly type: "number";
+                    };
+                    readonly taxName: {
+                        readonly type: readonly ["string", "null"];
+                    };
+                    readonly taxRegimeCode: {
+                        readonly type: readonly ["string", "null"];
+                        readonly enum: readonly ["standard", "reduced", "exempt", "reverse_charge", "margin_scheme_art311", "zero_rated", "out_of_scope", "other", null];
+                    };
+                    readonly isService: {
+                        readonly type: "boolean";
+                    };
+                };
+                readonly additionalProperties: false;
+            };
+        };
+        readonly bookingNumber: {
+            readonly type: readonly ["string", "null"];
+        };
+        readonly issueDate: {
+            readonly type: "string";
+        };
+        readonly dueDate: {
+            readonly type: "string";
+        };
+        readonly externalAllocationRequired: {
+            readonly type: "boolean";
+        };
+        readonly externalProvider: {
+            readonly type: readonly ["string", "null"];
+        };
+        readonly externalConfigKey: {
+            readonly type: readonly ["string", "null"];
+        };
+        readonly externalSeriesId: {
+            readonly type: readonly ["string", "null"];
+        };
+        readonly externalPlaceholderNumber: {
+            readonly type: readonly ["string", "null"];
+        };
+        readonly skipExternalSync: {
+            readonly type: "boolean";
+        };
+    };
+    readonly type: "object";
+    readonly additionalProperties: false;
+};
+export declare const invoiceVoidedPayloadSchema: {
+    readonly type: "object";
+    readonly required: readonly ["invoiceId", "invoiceNumber", "invoiceType", "bookingId", "totalCents", "currency", "reason", "voidedAt"];
+    readonly properties: {
+        readonly invoiceId: {
+            readonly type: "string";
+        };
+        readonly invoiceNumber: {
+            readonly type: "string";
+        };
+        readonly invoiceType: {
+            readonly enum: readonly ["invoice", "proforma", "credit_note"];
+        };
+        readonly bookingId: {
+            readonly type: readonly ["string", "null"];
+        };
+        readonly totalCents: {
+            readonly type: "integer";
+        };
+        readonly currency: {
+            readonly type: "string";
+        };
+        readonly reason: {
+            readonly type: readonly ["string", "null"];
+        };
+        readonly voidedAt: {
+            readonly type: "string";
+            readonly format: "date-time";
+        };
+        readonly externalProvider: {
+            readonly type: readonly ["string", "null"];
+        };
+        readonly externalNumber: {
+            readonly type: readonly ["string", "null"];
+        };
+        readonly externalSeriesName: {
+            readonly type: readonly ["string", "null"];
+        };
+    };
+    readonly additionalProperties: false;
+};
+export declare const invoiceSettledPayloadSchema: {
+    readonly type: "object";
+    readonly required: readonly ["invoiceId", "paymentId", "provider", "newlyAppliedAmountCents", "paidCents", "balanceDueCents"];
+    readonly properties: {
+        readonly invoiceId: {
+            readonly type: "string";
+        };
+        readonly paymentId: {
+            readonly type: "string";
+        };
+        readonly provider: {
+            readonly type: "string";
+        };
+        readonly newlyAppliedAmountCents: {
+            readonly type: "integer";
+        };
+        readonly paidCents: {
+            readonly type: "integer";
+        };
+        readonly balanceDueCents: {
+            readonly type: "integer";
+        };
+    };
+    readonly additionalProperties: false;
+};
+export declare const invoiceRenderedPayloadSchema: {
+    readonly type: "object";
+    readonly required: readonly ["invoiceId", "invoiceStatus", "invoiceType", "renditionId", "format", "storageKey", "contentType", "byteSize", "contentHash"];
+    readonly properties: {
+        readonly invoiceId: {
+            readonly type: "string";
+        };
+        readonly invoiceStatus: {
+            readonly enum: readonly ["draft", "pending_external_allocation", "issued", "partially_paid", "paid", "overdue", "void"];
+        };
+        readonly invoiceType: {
+            readonly enum: readonly ["invoice", "proforma", "credit_note"];
+        };
+        readonly renditionId: {
+            readonly type: "string";
+        };
+        readonly format: {
+            readonly enum: readonly ["html", "pdf", "xml", "json"];
+        };
+        readonly storageKey: {
+            readonly type: readonly ["string", "null"];
+        };
+        readonly contentType: {
+            readonly type: "string";
+        };
+        readonly byteSize: {
+            readonly type: readonly ["integer", "null"];
+        };
+        readonly contentHash: {
+            readonly type: readonly ["string", "null"];
+        };
+    };
+    readonly additionalProperties: false;
+};
+export declare const invoiceDocumentGeneratedPayloadSchema: {
+    readonly type: "object";
+    readonly required: readonly ["invoiceId", "invoiceStatus", "invoiceType", "renditionId", "format", "renderedBodyFormat", "regenerated"];
+    readonly properties: {
+        readonly invoiceId: {
+            readonly type: "string";
+        };
+        readonly invoiceStatus: {
+            readonly enum: readonly ["draft", "pending_external_allocation", "issued", "partially_paid", "paid", "overdue", "void"];
+        };
+        readonly invoiceType: {
+            readonly enum: readonly ["invoice", "proforma", "credit_note"];
+        };
+        readonly renditionId: {
+            readonly type: "string";
+        };
+        readonly format: {
+            readonly enum: readonly ["html", "pdf", "xml", "json"];
+        };
+        readonly renderedBodyFormat: {
+            readonly enum: readonly ["html", "markdown", "lexical_json"];
+        };
+        readonly regenerated: {
+            readonly type: "boolean";
+        };
+    };
+    readonly additionalProperties: false;
+};
+export declare const invoicePaymentRecordedPayloadSchema: {
+    readonly type: "object";
+    readonly required: readonly ["invoiceId", "invoiceNumber", "invoiceType", "bookingId", "invoiceCurrency", "invoiceTotalCents", "invoicePaidCents", "invoiceBalanceDueCents", "paymentId", "amountCents", "currency", "baseCurrency", "baseAmountCents", "paymentMethod", "status", "referenceNumber", "paymentDate"];
+    readonly properties: {
+        readonly invoiceId: {
+            readonly type: "string";
+        };
+        readonly invoiceNumber: {
+            readonly type: "string";
+        };
+        readonly invoiceType: {
+            readonly enum: readonly ["invoice", "proforma", "credit_note"];
+        };
+        readonly bookingId: {
+            readonly type: readonly ["string", "null"];
+        };
+        readonly invoiceCurrency: {
+            readonly type: "string";
+        };
+        readonly invoiceTotalCents: {
+            readonly type: "integer";
+        };
+        readonly invoicePaidCents: {
+            readonly type: "integer";
+        };
+        readonly invoiceBalanceDueCents: {
+            readonly type: "integer";
+        };
+        readonly paymentId: {
+            readonly type: "string";
+        };
+        readonly amountCents: {
+            readonly type: "integer";
+        };
+        readonly currency: {
+            readonly type: "string";
+        };
+        readonly baseCurrency: {
+            readonly type: readonly ["string", "null"];
+        };
+        readonly baseAmountCents: {
+            readonly type: readonly ["integer", "null"];
+        };
+        readonly paymentMethod: {
+            readonly enum: readonly ["bank_transfer", "credit_card", "debit_card", "cash", "cheque", "wallet", "direct_bill", "travel_credit", "other"];
+        };
+        readonly status: {
+            readonly enum: readonly ["pending", "completed", "failed", "refunded"];
+        };
+        readonly referenceNumber: {
+            readonly type: readonly ["string", "null"];
+        };
+        readonly paymentDate: {
+            readonly type: "string";
+        };
+    };
+    readonly additionalProperties: false;
+};
+export declare const paymentCompletedPayloadSchema: {
+    readonly type: "object";
+    readonly required: readonly ["paymentSessionId", "targetType", "targetId", "bookingId", "legacyOrderId", "invoiceId", "bookingPaymentScheduleId", "bookingGuaranteeId", "amountCents", "currency", "provider"];
+    readonly properties: {
+        readonly paymentSessionId: {
+            readonly type: "string";
+        };
+        readonly targetType: {
+            readonly enum: readonly ["booking", "order", "invoice", "booking_payment_schedule", "booking_guarantee", "flight_order", "other"];
+        };
+        readonly targetId: {
+            readonly type: readonly ["string", "null"];
+        };
+        readonly bookingId: {
+            readonly type: readonly ["string", "null"];
+        };
+        readonly legacyOrderId: {
+            readonly type: readonly ["string", "null"];
+        };
+        readonly invoiceId: {
+            readonly type: readonly ["string", "null"];
+        };
+        readonly bookingPaymentScheduleId: {
+            readonly type: readonly ["string", "null"];
+        };
+        readonly bookingGuaranteeId: {
+            readonly type: readonly ["string", "null"];
+        };
+        readonly amountCents: {
+            readonly type: "integer";
+        };
+        readonly currency: {
+            readonly type: "string";
+        };
+        readonly provider: {
+            readonly type: readonly ["string", "null"];
+        };
+    };
+    readonly additionalProperties: false;
+};
+export declare const bookingCreatedPayloadSchema: {
+    readonly type: "object";
+    readonly required: readonly ["bookingId", "bookingNumber", "productId", "travelerCount", "paymentScheduleCount", "travelCreditRedeemedCents", "groupId", "documentGeneration", "createdByUserId", "occurredAt"];
+    readonly properties: {
+        readonly bookingId: {
+            readonly type: "string";
+        };
+        readonly bookingNumber: {
+            readonly type: "string";
+        };
+        readonly productId: {
+            readonly type: "string";
+        };
+        readonly travelerCount: {
+            readonly type: "integer";
+        };
+        readonly paymentScheduleCount: {
+            readonly type: "integer";
+        };
+        readonly travelCreditRedeemedCents: {
+            readonly type: readonly ["integer", "null"];
+        };
+        readonly groupId: {
+            readonly type: readonly ["string", "null"];
+        };
+        readonly documentGeneration: {
+            readonly type: "object";
+            readonly required: readonly ["contractDocument", "invoiceDocument", "invoiceType"];
+            readonly properties: {
+                readonly contractDocument: {
+                    readonly type: "boolean";
+                };
+                readonly invoiceDocument: {
+                    readonly type: "boolean";
+                };
+                readonly invoiceType: {
+                    readonly enum: readonly ["invoice", "proforma"];
+                };
+            };
+            readonly additionalProperties: false;
+        };
+        readonly createdByUserId: {
+            readonly type: readonly ["string", "null"];
+        };
+        readonly occurredAt: {
+            readonly type: "string";
+            readonly format: "date-time";
+        };
+    };
+    readonly additionalProperties: false;
+};
+export declare const bookingConfirmedPayloadSchema: {
+    readonly type: "object";
+    readonly required: readonly ["bookingId", "bookingNumber", "actorId"];
+    readonly properties: {
+        readonly bookingId: {
+            readonly type: "string";
+        };
+        readonly bookingNumber: {
+            readonly type: "string";
+        };
+        readonly actorId: {
+            readonly type: readonly ["string", "null"];
+        };
+        readonly suppressNotifications: {
+            readonly type: "boolean";
+        };
+    };
+    readonly additionalProperties: false;
+};
+export declare const bookingDualCreatedPayloadSchema: {
+    readonly type: "object";
+    readonly required: readonly ["groupId", "primaryBookingId", "secondaryBookingId", "productId", "createdByUserId", "occurredAt"];
+    readonly properties: {
+        readonly groupId: {
+            readonly type: "string";
+        };
+        readonly primaryBookingId: {
+            readonly type: "string";
+        };
+        readonly secondaryBookingId: {
+            readonly type: "string";
+        };
+        readonly productId: {
+            readonly type: "string";
+        };
+        readonly createdByUserId: {
+            readonly type: readonly ["string", "null"];
+        };
+        readonly occurredAt: {
+            readonly type: "string";
+            readonly format: "date-time";
+        };
+    };
+    readonly additionalProperties: false;
+};
+export declare const bookingCreateRejectedPayloadSchema: {
+    readonly type: "object";
+    readonly required: readonly ["reason", "productId", "optionId", "slotId", "bookingNumber", "mismatchCount", "mismatches", "createdByUserId", "occurredAt"];
+    readonly properties: {
+        readonly reason: {
+            readonly const: "payload_resolver_mismatch";
+        };
+        readonly productId: {
+            readonly type: "string";
+        };
+        readonly optionId: {
+            readonly type: readonly ["string", "null"];
+        };
+        readonly slotId: {
+            readonly type: readonly ["string", "null"];
+        };
+        readonly bookingNumber: {
+            readonly type: "string";
+        };
+        readonly mismatchCount: {
+            readonly type: "integer";
+        };
+        readonly mismatches: {
+            readonly type: "array";
+            readonly items: {
+                readonly type: "object";
+                readonly required: readonly ["kind", "optionUnitId", "submittedQuantity", "resolvedQuantity"];
+                readonly properties: {
+                    readonly kind: {
+                        readonly enum: readonly ["qty", "missing", "extra"];
+                    };
+                    readonly optionUnitId: {
+                        readonly type: "string";
+                    };
+                    readonly submittedQuantity: {
+                        readonly type: "number";
+                    };
+                    readonly resolvedQuantity: {
+                        readonly type: "number";
+                    };
+                };
+                readonly additionalProperties: false;
+            };
+        };
+        readonly createdByUserId: {
+            readonly type: readonly ["string", "null"];
+        };
+        readonly occurredAt: {
+            readonly type: "string";
+            readonly format: "date-time";
+        };
+    };
+    readonly additionalProperties: false;
+};
+export declare const bookingContractDocumentRequestedPayloadSchema: {
+    readonly type: "object";
+    readonly required: readonly ["bookingId", "bookingNumber", "createdByUserId", "occurredAt"];
+    readonly properties: {
+        readonly bookingId: {
+            readonly type: "string";
+        };
+        readonly bookingNumber: {
+            readonly type: "string";
+        };
+        readonly createdByUserId: {
+            readonly type: readonly ["string", "null"];
+        };
+        readonly occurredAt: {
+            readonly type: "string";
+            readonly format: "date-time";
+        };
+    };
+    readonly additionalProperties: false;
+};
+export declare const bookingPaymentSchedulePaidPayloadSchema: {
+    readonly type: "object";
+    readonly required: readonly ["bookingId", "bookingPaymentScheduleId", "paymentSessionId", "paymentId", "scheduleType", "amountCents", "currency", "provider"];
+    readonly properties: {
+        readonly bookingId: {
+            readonly type: "string";
+        };
+        readonly bookingPaymentScheduleId: {
+            readonly type: "string";
+        };
+        readonly paymentSessionId: {
+            readonly type: "string";
+        };
+        readonly paymentId: {
+            readonly type: readonly ["string", "null"];
+        };
+        readonly scheduleType: {
+            readonly enum: readonly ["deposit", "installment", "balance", "hold", "other"];
+        };
+        readonly amountCents: {
+            readonly type: "integer";
+        };
+        readonly currency: {
+            readonly type: "string";
+        };
+        readonly provider: {
+            readonly type: readonly ["string", "null"];
+        };
+    };
+    readonly additionalProperties: false;
+};