@cheqi/sdk 0.1.1

package/dist/models/generated/CheqiCreditNote.d.ts

@@ -0,0 +1,148 @@
+/**
+ * Cheqi API
+ * Cheqi provides APIs for creating receipts and reading receipts for customers
+ *
+ * The version of the OpenAPI document: v1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { Discount } from './Discount.js';
+import type { Identifier } from './Identifier.js';
+import type { ReceivingParty } from './ReceivingParty.js';
+import type { Charge } from './Charge.js';
+import type { SellingParty } from './SellingParty.js';
+import type { Period } from './Period.js';
+import type { Product } from './Product.js';
+import type { Tax } from './Tax.js';
+/**
+ * Cheqi JSON credit note template object. This contains a complete CheqiCreditNote structure with products, taxes, parties, and all credit note details.
+ * @export
+ * @interface CheqiCreditNote
+ */
+export interface CheqiCreditNote {
+    /**
+     * The unique identifier of the Cheqi credit note
+     * @type {string}
+     * @memberof CheqiCreditNote
+     */
+    cheqiCreditNoteId?: string;
+    /**
+     * The document number of the credit note, given by the seller.
+     * @type {string}
+     * @memberof CheqiCreditNote
+     */
+    documentNumber?: string;
+    /**
+     * The document number of the original purchase receipt this credit note refers to.
+     * @type {string}
+     * @memberof CheqiCreditNote
+     */
+    originatorDocumentReference?: string;
+    /**
+     * The identifiers for the credit note, given by the seller, for example order reference, transaction number
+     * @type {Array<Identifier>}
+     * @memberof CheqiCreditNote
+     */
+    identifiers?: Array<Identifier>;
+    /**
+     * The issue date of the credit note
+     * @type {Date}
+     * @memberof CheqiCreditNote
+     */
+    issueDate?: Date;
+    /**
+     * The currency of the credit note
+     * @type {string}
+     * @memberof CheqiCreditNote
+     */
+    currency?: string;
+    /**
+     * The subtotal of the credit note, calculated as the sum of all line items before any overall credit note-level adjustments or taxes.
+     * @type {number}
+     * @memberof CheqiCreditNote
+     */
+    creditNoteSubtotal?: number;
+    /**
+     * The total before tax of the credit note, including any overall discounts or charges.
+     * @type {number}
+     * @memberof CheqiCreditNote
+     */
+    totalBeforeTax?: number;
+    /**
+     * The total tax amount of the credit note
+     * @type {number}
+     * @memberof CheqiCreditNote
+     */
+    totalTaxAmount?: number;
+    /**
+     * The total amount of the credit note
+     * @type {number}
+     * @memberof CheqiCreditNote
+     */
+    totalAmount?: number;
+    /**
+     * The list of products included in the credit note. Must contain at least one product.
+     * @type {Array<Product>}
+     * @memberof CheqiCreditNote
+     */
+    products?: Array<Product>;
+    /**
+     * The list of discounts applied to the credit note on total credit note level.
+     * @type {Array<Discount>}
+     * @memberof CheqiCreditNote
+     */
+    discounts?: Array<Discount>;
+    /**
+     * The list of charges applied to the credit note on total credit note level.
+     * @type {Array<Charge>}
+     * @memberof CheqiCreditNote
+     */
+    charges?: Array<Charge>;
+    /**
+     * The list of taxes applied to the credit note
+     * @type {Array<Tax>}
+     * @memberof CheqiCreditNote
+     */
+    taxes?: Array<Tax>;
+    /**
+     *
+     * @type {Period}
+     * @memberof CheqiCreditNote
+     */
+    period?: Period;
+    /**
+     * A note included on the credit note.
+     * @type {string}
+     * @memberof CheqiCreditNote
+     */
+    note?: string;
+    /**
+     *
+     * @type {SellingParty}
+     * @memberof CheqiCreditNote
+     */
+    sellingParty?: SellingParty;
+    /**
+     *
+     * @type {ReceivingParty}
+     * @memberof CheqiCreditNote
+     */
+    receivingParty?: ReceivingParty;
+    /**
+     * The verification nonce of the credit note
+     * @type {string}
+     * @memberof CheqiCreditNote
+     */
+    receiptUuid?: string;
+}
+/**
+ * Check if a given object implements the CheqiCreditNote interface.
+ */
+export declare function instanceOfCheqiCreditNote(value: object): value is CheqiCreditNote;
+export declare function CheqiCreditNoteFromJSON(json: any): CheqiCreditNote;
+export declare function CheqiCreditNoteFromJSONTyped(json: any, ignoreDiscriminator: boolean): CheqiCreditNote;
+export declare function CheqiCreditNoteToJSON(json: any): CheqiCreditNote;
+export declare function CheqiCreditNoteToJSONTyped(value?: CheqiCreditNote | null, ignoreDiscriminator?: boolean): any;

package/dist/models/generated/CheqiCreditNote.js

@@ -0,0 +1,86 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Cheqi API
+ * Cheqi provides APIs for creating receipts and reading receipts for customers
+ *
+ * The version of the OpenAPI document: v1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { DiscountFromJSON, DiscountToJSON, } from './Discount.js';
+import { IdentifierFromJSON, IdentifierToJSON, } from './Identifier.js';
+import { ReceivingPartyFromJSON, ReceivingPartyToJSON, } from './ReceivingParty.js';
+import { ChargeFromJSON, ChargeToJSON, } from './Charge.js';
+import { SellingPartyFromJSON, SellingPartyToJSON, } from './SellingParty.js';
+import { PeriodFromJSON, PeriodToJSON, } from './Period.js';
+import { ProductFromJSON, ProductToJSON, } from './Product.js';
+import { TaxFromJSON, TaxToJSON, } from './Tax.js';
+/**
+ * Check if a given object implements the CheqiCreditNote interface.
+ */
+export function instanceOfCheqiCreditNote(value) {
+    return true;
+}
+export function CheqiCreditNoteFromJSON(json) {
+    return CheqiCreditNoteFromJSONTyped(json, false);
+}
+export function CheqiCreditNoteFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'cheqiCreditNoteId': json['cheqiCreditNoteId'] == null ? undefined : json['cheqiCreditNoteId'],
+        'documentNumber': json['documentNumber'] == null ? undefined : json['documentNumber'],
+        'originatorDocumentReference': json['originatorDocumentReference'] == null ? undefined : json['originatorDocumentReference'],
+        'identifiers': json['identifiers'] == null ? undefined : (json['identifiers'].map(IdentifierFromJSON)),
+        'issueDate': json['issueDate'] == null ? undefined : (new Date(json['issueDate'])),
+        'currency': json['currency'] == null ? undefined : json['currency'],
+        'creditNoteSubtotal': json['creditNoteSubtotal'] == null ? undefined : json['creditNoteSubtotal'],
+        'totalBeforeTax': json['totalBeforeTax'] == null ? undefined : json['totalBeforeTax'],
+        'totalTaxAmount': json['totalTaxAmount'] == null ? undefined : json['totalTaxAmount'],
+        'totalAmount': json['totalAmount'] == null ? undefined : json['totalAmount'],
+        'products': json['products'] == null ? undefined : (json['products'].map(ProductFromJSON)),
+        'discounts': json['discounts'] == null ? undefined : (json['discounts'].map(DiscountFromJSON)),
+        'charges': json['charges'] == null ? undefined : (json['charges'].map(ChargeFromJSON)),
+        'taxes': json['taxes'] == null ? undefined : (json['taxes'].map(TaxFromJSON)),
+        'period': json['period'] == null ? undefined : PeriodFromJSON(json['period']),
+        'note': json['note'] == null ? undefined : json['note'],
+        'sellingParty': json['sellingParty'] == null ? undefined : SellingPartyFromJSON(json['sellingParty']),
+        'receivingParty': json['receivingParty'] == null ? undefined : ReceivingPartyFromJSON(json['receivingParty']),
+        'receiptUuid': json['receiptUuid'] == null ? undefined : json['receiptUuid'],
+    };
+}
+export function CheqiCreditNoteToJSON(json) {
+    return CheqiCreditNoteToJSONTyped(json, false);
+}
+export function CheqiCreditNoteToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'cheqiCreditNoteId': value['cheqiCreditNoteId'],
+        'documentNumber': value['documentNumber'],
+        'originatorDocumentReference': value['originatorDocumentReference'],
+        'identifiers': value['identifiers'] == null ? undefined : (value['identifiers'].map(IdentifierToJSON)),
+        'issueDate': value['issueDate'] == null ? undefined : ((value['issueDate']).toISOString()),
+        'currency': value['currency'],
+        'creditNoteSubtotal': value['creditNoteSubtotal'],
+        'totalBeforeTax': value['totalBeforeTax'],
+        'totalTaxAmount': value['totalTaxAmount'],
+        'totalAmount': value['totalAmount'],
+        'products': value['products'] == null ? undefined : (value['products'].map(ProductToJSON)),
+        'discounts': value['discounts'] == null ? undefined : (value['discounts'].map(DiscountToJSON)),
+        'charges': value['charges'] == null ? undefined : (value['charges'].map(ChargeToJSON)),
+        'taxes': value['taxes'] == null ? undefined : (value['taxes'].map(TaxToJSON)),
+        'period': PeriodToJSON(value['period']),
+        'note': value['note'],
+        'sellingParty': SellingPartyToJSON(value['sellingParty']),
+        'receivingParty': ReceivingPartyToJSON(value['receivingParty']),
+        'receiptUuid': value['receiptUuid'],
+    };
+}
+//# sourceMappingURL=CheqiCreditNote.js.map

package/dist/models/generated/CheqiCreditNote.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CheqiCreditNote.js","sourceRoot":"","sources":["../../../src/models/generated/CheqiCreditNote.ts"],"names":[],"mappings":"AAAA,oBAAoB;AACpB,oBAAoB;AACpB;;;;;;;;;;GAUG;AAIH,OAAO,EACH,gBAAgB,EAEhB,cAAc,GAEjB,MAAM,eAAe,CAAC;AAEvB,OAAO,EACH,kBAAkB,EAElB,gBAAgB,GAEnB,MAAM,iBAAiB,CAAC;AAEzB,OAAO,EACH,sBAAsB,EAEtB,oBAAoB,GAEvB,MAAM,qBAAqB,CAAC;AAE7B,OAAO,EACH,cAAc,EAEd,YAAY,GAEf,MAAM,aAAa,CAAC;AAErB,OAAO,EACH,oBAAoB,EAEpB,kBAAkB,GAErB,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EACH,cAAc,EAEd,YAAY,GAEf,MAAM,aAAa,CAAC;AAErB,OAAO,EACH,eAAe,EAEf,aAAa,GAEhB,MAAM,cAAc,CAAC;AAEtB,OAAO,EACH,WAAW,EAEX,SAAS,GAEZ,MAAM,UAAU,CAAC;AA4HlB;;GAEG;AACH,MAAM,UAAU,yBAAyB,CAAC,KAAa;IACnD,OAAO,IAAI,CAAC;AAChB,CAAC;AAED,MAAM,UAAU,uBAAuB,CAAC,IAAS;IAC7C,OAAO,4BAA4B,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;AACrD,CAAC;AAED,MAAM,UAAU,4BAA4B,CAAC,IAAS,EAAE,mBAA4B;IAChF,IAAI,IAAI,IAAI,IAAI,EAAE,CAAC;QACf,OAAO,IAAI,CAAC;IAChB,CAAC;IACD,OAAO;QAEH,mBAAmB,EAAE,IAAI,CAAC,mBAAmB,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,mBAAmB,CAAC;QAC9F,gBAAgB,EAAE,IAAI,CAAC,gBAAgB,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC;QACrF,6BAA6B,EAAE,IAAI,CAAC,6BAA6B,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,6BAA6B,CAAC;QAC5H,aAAa,EAAE,IAAI,CAAC,aAAa,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAE,IAAI,CAAC,aAAa,CAAgB,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC;QACtH,WAAW,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC;QAClF,UAAU,EAAE,IAAI,CAAC,UAAU,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC;QACnE,oBAAoB,EAAE,IAAI,CAAC,oBAAoB,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,oBAAoB,CAAC;QACjG,gBAAgB,EAAE,IAAI,CAAC,gBAAgB,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC;QACrF,gBAAgB,EAAE,IAAI,CAAC,gBAAgB,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC;QACrF,aAAa,EAAE,IAAI,CAAC,aAAa,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC;QAC5E,UAAU,EAAE,IAAI,CAAC,UAAU,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAE,IAAI,CAAC,UAAU,CAAgB,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;QAC1G,WAAW,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAE,IAAI,CAAC,WAAW,CAAgB,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;QAC9G,SAAS,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAE,IAAI,CAAC,SAAS,CAAgB,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;QACtG,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAE,IAAI,CAAC,OAAO,CAAgB,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;QAC7F,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,cAAc,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC7E,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC;QACvD,cAAc,EAAE,IAAI,CAAC,cAAc,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,oBAAoB,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QACrG,gBAAgB,EAAE,IAAI,CAAC,gBAAgB,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,sBAAsB,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;QAC7G,aAAa,EAAE,IAAI,CAAC,aAAa,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC;KAC/E,CAAC;AACN,CAAC;AAED,MAAM,UAAU,qBAAqB,CAAC,IAAS;IAC3C,OAAO,0BAA0B,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;AACnD,CAAC;AAED,MAAM,UAAU,0BAA0B,CAAC,KAA8B,EAAE,sBAA+B,KAAK;IAC3G,IAAI,KAAK,IAAI,IAAI,EAAE,CAAC;QAChB,OAAO,KAAK,CAAC;IACjB,CAAC;IAED,OAAO;QAEH,mBAAmB,EAAE,KAAK,CAAC,mBAAmB,CAAC;QAC/C,gBAAgB,EAAE,KAAK,CAAC,gBAAgB,CAAC;QACzC,6BAA6B,EAAE,KAAK,CAAC,6BAA6B,CAAC;QACnE,aAAa,EAAE,KAAK,CAAC,aAAa,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAE,KAAK,CAAC,aAAa,CAAgB,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;QACtH,WAAW,EAAE,KAAK,CAAC,WAAW,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC;QAC1F,UAAU,EAAE,KAAK,CAAC,UAAU,CAAC;QAC7B,oBAAoB,EAAE,KAAK,CAAC,oBAAoB,CAAC;QACjD,gBAAgB,EAAE,KAAK,CAAC,gBAAgB,CAAC;QACzC,gBAAgB,EAAE,KAAK,CAAC,gBAAgB,CAAC;QACzC,aAAa,EAAE,KAAK,CAAC,aAAa,CAAC;QACnC,UAAU,EAAE,KAAK,CAAC,UAAU,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAE,KAAK,CAAC,UAAU,CAAgB,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;QAC1G,WAAW,EAAE,KAAK,CAAC,WAAW,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAE,KAAK,CAAC,WAAW,CAAgB,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;QAC9G,SAAS,EAAE,KAAK,CAAC,SAAS,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAE,KAAK,CAAC,SAAS,CAAgB,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;QACtG,OAAO,EAAE,KAAK,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAE,KAAK,CAAC,OAAO,CAAgB,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QAC7F,QAAQ,EAAE,YAAY,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QACvC,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC;QACrB,cAAc,EAAE,kBAAkB,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;QACzD,gBAAgB,EAAE,oBAAoB,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC;QAC/D,aAAa,EAAE,KAAK,CAAC,aAAa,CAAC;KACtC,CAAC;AACN,CAAC"}

package/dist/models/generated/CheqiReceipt.d.ts

@@ -0,0 +1,143 @@
+/**
+ * Cheqi API
+ * Cheqi provides APIs for creating receipts and reading receipts for customers
+ *
+ * The version of the OpenAPI document: v1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { Discount } from './Discount.js';
+import type { Identifier } from './Identifier.js';
+import type { ReceivingParty } from './ReceivingParty.js';
+import type { Barcode } from './Barcode.js';
+import type { Charge } from './Charge.js';
+import type { SellingParty } from './SellingParty.js';
+import type { Period } from './Period.js';
+import type { Product } from './Product.js';
+import type { Tax } from './Tax.js';
+/**
+ * Cheqi JSON receipt payload. Include this when the recipient accepts the CHEQI format.
+ * @export
+ * @interface CheqiReceipt
+ */
+export interface CheqiReceipt {
+    /**
+     * The total amount of the receipt
+     * @type {number}
+     * @memberof CheqiReceipt
+     */
+    totalAmount?: number;
+    /**
+     * The document number of the receipt, given by the seller, for example invoice number.
+     * @type {string}
+     * @memberof CheqiReceipt
+     */
+    documentNumber?: string;
+    /**
+     * The identifiers for the purchase, given by the seller, for example order reference, transaction number
+     * @type {Array<Identifier>}
+     * @memberof CheqiReceipt
+     */
+    identifiers?: Array<Identifier>;
+    /**
+     * The issue date of the receipt
+     * @type {Date}
+     * @memberof CheqiReceipt
+     */
+    issueDate?: Date;
+    /**
+     * The currency of the receipt
+     * @type {string}
+     * @memberof CheqiReceipt
+     */
+    currency?: string;
+    /**
+     * The subtotal of the receipt
+     * @type {number}
+     * @memberof CheqiReceipt
+     */
+    receiptSubtotal?: number;
+    /**
+     * The total before tax of the receipt
+     * @type {number}
+     * @memberof CheqiReceipt
+     */
+    totalBeforeTax?: number;
+    /**
+     * The total tax amount of the receipt
+     * @type {number}
+     * @memberof CheqiReceipt
+     */
+    totalTaxAmount?: number;
+    /**
+     * The list of products included in the receipt. Must contain at least one product.
+     * @type {Array<Product>}
+     * @memberof CheqiReceipt
+     */
+    products?: Array<Product>;
+    /**
+     * The list of discounts applied to the receipt on total receipt level. Example: discount on total receipt level, 20% discount on complete order, etc.
+     * @type {Array<Discount>}
+     * @memberof CheqiReceipt
+     */
+    discounts?: Array<Discount>;
+    /**
+     * The list of charges applied to the receipt on total receipt level. Example: service fee, shipping fee, etc.
+     * @type {Array<Charge>}
+     * @memberof CheqiReceipt
+     */
+    charges?: Array<Charge>;
+    /**
+     * The list of taxes applied to the receipt
+     * @type {Array<Tax>}
+     * @memberof CheqiReceipt
+     */
+    taxes?: Array<Tax>;
+    /**
+     *
+     * @type {Period}
+     * @memberof CheqiReceipt
+     */
+    period?: Period;
+    /**
+     * The note of the receipt.
+     * @type {string}
+     * @memberof CheqiReceipt
+     */
+    note?: string;
+    /**
+     *
+     * @type {SellingParty}
+     * @memberof CheqiReceipt
+     */
+    sellingParty?: SellingParty;
+    /**
+     *
+     * @type {ReceivingParty}
+     * @memberof CheqiReceipt
+     */
+    receivingParty?: ReceivingParty;
+    /**
+     * Optional list of barcodes or QR codes embedded in the receipt
+     * @type {Array<Barcode>}
+     * @memberof CheqiReceipt
+     */
+    barcodes?: Array<Barcode>;
+    /**
+     * The verification nonce of the receipt
+     * @type {string}
+     * @memberof CheqiReceipt
+     */
+    receiptUuid?: string;
+}
+/**
+ * Check if a given object implements the CheqiReceipt interface.
+ */
+export declare function instanceOfCheqiReceipt(value: object): value is CheqiReceipt;
+export declare function CheqiReceiptFromJSON(json: any): CheqiReceipt;
+export declare function CheqiReceiptFromJSONTyped(json: any, ignoreDiscriminator: boolean): CheqiReceipt;
+export declare function CheqiReceiptToJSON(json: any): CheqiReceipt;
+export declare function CheqiReceiptToJSONTyped(value?: CheqiReceipt | null, ignoreDiscriminator?: boolean): any;

package/dist/models/generated/CheqiReceipt.js

@@ -0,0 +1,85 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Cheqi API
+ * Cheqi provides APIs for creating receipts and reading receipts for customers
+ *
+ * The version of the OpenAPI document: v1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { DiscountFromJSON, DiscountToJSON, } from './Discount.js';
+import { IdentifierFromJSON, IdentifierToJSON, } from './Identifier.js';
+import { ReceivingPartyFromJSON, ReceivingPartyToJSON, } from './ReceivingParty.js';
+import { BarcodeFromJSON, BarcodeToJSON, } from './Barcode.js';
+import { ChargeFromJSON, ChargeToJSON, } from './Charge.js';
+import { SellingPartyFromJSON, SellingPartyToJSON, } from './SellingParty.js';
+import { PeriodFromJSON, PeriodToJSON, } from './Period.js';
+import { ProductFromJSON, ProductToJSON, } from './Product.js';
+import { TaxFromJSON, TaxToJSON, } from './Tax.js';
+/**
+ * Check if a given object implements the CheqiReceipt interface.
+ */
+export function instanceOfCheqiReceipt(value) {
+    return true;
+}
+export function CheqiReceiptFromJSON(json) {
+    return CheqiReceiptFromJSONTyped(json, false);
+}
+export function CheqiReceiptFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'totalAmount': json['totalAmount'] == null ? undefined : json['totalAmount'],
+        'documentNumber': json['documentNumber'] == null ? undefined : json['documentNumber'],
+        'identifiers': json['identifiers'] == null ? undefined : (json['identifiers'].map(IdentifierFromJSON)),
+        'issueDate': json['issueDate'] == null ? undefined : (new Date(json['issueDate'])),
+        'currency': json['currency'] == null ? undefined : json['currency'],
+        'receiptSubtotal': json['receiptSubtotal'] == null ? undefined : json['receiptSubtotal'],
+        'totalBeforeTax': json['totalBeforeTax'] == null ? undefined : json['totalBeforeTax'],
+        'totalTaxAmount': json['totalTaxAmount'] == null ? undefined : json['totalTaxAmount'],
+        'products': json['products'] == null ? undefined : (json['products'].map(ProductFromJSON)),
+        'discounts': json['discounts'] == null ? undefined : (json['discounts'].map(DiscountFromJSON)),
+        'charges': json['charges'] == null ? undefined : (json['charges'].map(ChargeFromJSON)),
+        'taxes': json['taxes'] == null ? undefined : (json['taxes'].map(TaxFromJSON)),
+        'period': json['period'] == null ? undefined : PeriodFromJSON(json['period']),
+        'note': json['note'] == null ? undefined : json['note'],
+        'sellingParty': json['sellingParty'] == null ? undefined : SellingPartyFromJSON(json['sellingParty']),
+        'receivingParty': json['receivingParty'] == null ? undefined : ReceivingPartyFromJSON(json['receivingParty']),
+        'barcodes': json['barcodes'] == null ? undefined : (json['barcodes'].map(BarcodeFromJSON)),
+        'receiptUuid': json['receiptUuid'] == null ? undefined : json['receiptUuid'],
+    };
+}
+export function CheqiReceiptToJSON(json) {
+    return CheqiReceiptToJSONTyped(json, false);
+}
+export function CheqiReceiptToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'totalAmount': value['totalAmount'],
+        'documentNumber': value['documentNumber'],
+        'identifiers': value['identifiers'] == null ? undefined : (value['identifiers'].map(IdentifierToJSON)),
+        'issueDate': value['issueDate'] == null ? undefined : ((value['issueDate']).toISOString()),
+        'currency': value['currency'],
+        'receiptSubtotal': value['receiptSubtotal'],
+        'totalBeforeTax': value['totalBeforeTax'],
+        'totalTaxAmount': value['totalTaxAmount'],
+        'products': value['products'] == null ? undefined : (value['products'].map(ProductToJSON)),
+        'discounts': value['discounts'] == null ? undefined : (value['discounts'].map(DiscountToJSON)),
+        'charges': value['charges'] == null ? undefined : (value['charges'].map(ChargeToJSON)),
+        'taxes': value['taxes'] == null ? undefined : (value['taxes'].map(TaxToJSON)),
+        'period': PeriodToJSON(value['period']),
+        'note': value['note'],
+        'sellingParty': SellingPartyToJSON(value['sellingParty']),
+        'receivingParty': ReceivingPartyToJSON(value['receivingParty']),
+        'barcodes': value['barcodes'] == null ? undefined : (value['barcodes'].map(BarcodeToJSON)),
+        'receiptUuid': value['receiptUuid'],
+    };
+}
+//# sourceMappingURL=CheqiReceipt.js.map

package/dist/models/generated/CheqiReceipt.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CheqiReceipt.js","sourceRoot":"","sources":["../../../src/models/generated/CheqiReceipt.ts"],"names":[],"mappings":"AAAA,oBAAoB;AACpB,oBAAoB;AACpB;;;;;;;;;;GAUG;AAIH,OAAO,EACH,gBAAgB,EAEhB,cAAc,GAEjB,MAAM,eAAe,CAAC;AAEvB,OAAO,EACH,kBAAkB,EAElB,gBAAgB,GAEnB,MAAM,iBAAiB,CAAC;AAEzB,OAAO,EACH,sBAAsB,EAEtB,oBAAoB,GAEvB,MAAM,qBAAqB,CAAC;AAE7B,OAAO,EACH,eAAe,EAEf,aAAa,GAEhB,MAAM,cAAc,CAAC;AAEtB,OAAO,EACH,cAAc,EAEd,YAAY,GAEf,MAAM,aAAa,CAAC;AAErB,OAAO,EACH,oBAAoB,EAEpB,kBAAkB,GAErB,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EACH,cAAc,EAEd,YAAY,GAEf,MAAM,aAAa,CAAC;AAErB,OAAO,EACH,eAAe,EAEf,aAAa,GAEhB,MAAM,cAAc,CAAC;AAEtB,OAAO,EACH,WAAW,EAEX,SAAS,GAEZ,MAAM,UAAU,CAAC;AAsHlB;;GAEG;AACH,MAAM,UAAU,sBAAsB,CAAC,KAAa;IAChD,OAAO,IAAI,CAAC;AAChB,CAAC;AAED,MAAM,UAAU,oBAAoB,CAAC,IAAS;IAC1C,OAAO,yBAAyB,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;AAClD,CAAC;AAED,MAAM,UAAU,yBAAyB,CAAC,IAAS,EAAE,mBAA4B;IAC7E,IAAI,IAAI,IAAI,IAAI,EAAE,CAAC;QACf,OAAO,IAAI,CAAC;IAChB,CAAC;IACD,OAAO;QAEH,aAAa,EAAE,IAAI,CAAC,aAAa,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC;QAC5E,gBAAgB,EAAE,IAAI,CAAC,gBAAgB,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC;QACrF,aAAa,EAAE,IAAI,CAAC,aAAa,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAE,IAAI,CAAC,aAAa,CAAgB,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC;QACtH,WAAW,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC;QAClF,UAAU,EAAE,IAAI,CAAC,UAAU,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC;QACnE,iBAAiB,EAAE,IAAI,CAAC,iBAAiB,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,iBAAiB,CAAC;QACxF,gBAAgB,EAAE,IAAI,CAAC,gBAAgB,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC;QACrF,gBAAgB,EAAE,IAAI,CAAC,gBAAgB,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC;QACrF,UAAU,EAAE,IAAI,CAAC,UAAU,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAE,IAAI,CAAC,UAAU,CAAgB,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;QAC1G,WAAW,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAE,IAAI,CAAC,WAAW,CAAgB,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;QAC9G,SAAS,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAE,IAAI,CAAC,SAAS,CAAgB,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;QACtG,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAE,IAAI,CAAC,OAAO,CAAgB,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;QAC7F,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,cAAc,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC7E,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC;QACvD,cAAc,EAAE,IAAI,CAAC,cAAc,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,oBAAoB,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QACrG,gBAAgB,EAAE,IAAI,CAAC,gBAAgB,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,sBAAsB,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;QAC7G,UAAU,EAAE,IAAI,CAAC,UAAU,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAE,IAAI,CAAC,UAAU,CAAgB,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;QAC1G,aAAa,EAAE,IAAI,CAAC,aAAa,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC;KAC/E,CAAC;AACN,CAAC;AAED,MAAM,UAAU,kBAAkB,CAAC,IAAS;IACxC,OAAO,uBAAuB,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;AAChD,CAAC;AAED,MAAM,UAAU,uBAAuB,CAAC,KAA2B,EAAE,sBAA+B,KAAK;IACrG,IAAI,KAAK,IAAI,IAAI,EAAE,CAAC;QAChB,OAAO,KAAK,CAAC;IACjB,CAAC;IAED,OAAO;QAEH,aAAa,EAAE,KAAK,CAAC,aAAa,CAAC;QACnC,gBAAgB,EAAE,KAAK,CAAC,gBAAgB,CAAC;QACzC,aAAa,EAAE,KAAK,CAAC,aAAa,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAE,KAAK,CAAC,aAAa,CAAgB,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;QACtH,WAAW,EAAE,KAAK,CAAC,WAAW,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC;QAC1F,UAAU,EAAE,KAAK,CAAC,UAAU,CAAC;QAC7B,iBAAiB,EAAE,KAAK,CAAC,iBAAiB,CAAC;QAC3C,gBAAgB,EAAE,KAAK,CAAC,gBAAgB,CAAC;QACzC,gBAAgB,EAAE,KAAK,CAAC,gBAAgB,CAAC;QACzC,UAAU,EAAE,KAAK,CAAC,UAAU,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAE,KAAK,CAAC,UAAU,CAAgB,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;QAC1G,WAAW,EAAE,KAAK,CAAC,WAAW,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAE,KAAK,CAAC,WAAW,CAAgB,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;QAC9G,SAAS,EAAE,KAAK,CAAC,SAAS,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAE,KAAK,CAAC,SAAS,CAAgB,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;QACtG,OAAO,EAAE,KAAK,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAE,KAAK,CAAC,OAAO,CAAgB,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QAC7F,QAAQ,EAAE,YAAY,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QACvC,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC;QACrB,cAAc,EAAE,kBAAkB,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;QACzD,gBAAgB,EAAE,oBAAoB,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC;QAC/D,UAAU,EAAE,KAAK,CAAC,UAAU,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAE,KAAK,CAAC,UAAU,CAAgB,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;QAC1G,aAAa,EAAE,KAAK,CAAC,aAAa,CAAC;KACtC,CAAC;AACN,CAAC"}

package/dist/models/generated/CompanyCreationRequest.d.ts

@@ -0,0 +1,114 @@
+/**
+ * Cheqi API
+ * Cheqi provides APIs for creating receipts and reading receipts for customers
+ *
+ * The version of the OpenAPI document: v1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { ContactDetailDto } from './ContactDetailDto.js';
+import type { CompanyIdentifierDTO } from './CompanyIdentifierDTO.js';
+import type { AddressDTO } from './AddressDTO.js';
+import type { ReturnProcessingMode } from './ReturnProcessingMode.js';
+/**
+ * Request payload for creating or provisioning a company.
+ * @export
+ * @interface CompanyCreationRequest
+ */
+export interface CompanyCreationRequest {
+    /**
+     * Display name of the company
+     * @type {string}
+     * @memberof CompanyCreationRequest
+     */
+    companyName: string;
+    /**
+     * Legal registered name of the company
+     * @type {string}
+     * @memberof CompanyCreationRequest
+     */
+    companyLegalName: string;
+    /**
+     * Legacy tax identification number of the company. Prefer identifiers for new integrations.
+     * @type {string}
+     * @memberof CompanyCreationRequest
+     */
+    taxNumber?: string | null;
+    /**
+     *
+     * @type {AddressDTO}
+     * @memberof CompanyCreationRequest
+     */
+    address: AddressDTO;
+    /**
+     * Primary company email address
+     * @type {string}
+     * @memberof CompanyCreationRequest
+     */
+    companyEmail: string;
+    /**
+     * Primary company phone number
+     * @type {string}
+     * @memberof CompanyCreationRequest
+     */
+    phoneNumber?: string | null;
+    /**
+     * Optional additional contact details for the company
+     * @type {Set<ContactDetailDto>}
+     * @memberof CompanyCreationRequest
+     */
+    contactDetails?: Set<ContactDetailDto>;
+    /**
+     * Optional company registration identifiers
+     * @type {Set<CompanyIdentifierDTO>}
+     * @memberof CompanyCreationRequest
+     */
+    identifiers?: Set<CompanyIdentifierDTO>;
+    /**
+     * Public company website
+     * @type {string}
+     * @memberof CompanyCreationRequest
+     */
+    website?: string | null;
+    /**
+     * Default return window in days
+     * @type {number}
+     * @memberof CompanyCreationRequest
+     */
+    returnDays?: number | null;
+    /**
+     * Optional custom receipt text appended to company receipts
+     * @type {string}
+     * @memberof CompanyCreationRequest
+     */
+    companyReceiptText?: string | null;
+    /**
+     *
+     * @type {ReturnProcessingMode}
+     * @memberof CompanyCreationRequest
+     */
+    returnProcessingMode?: ReturnProcessingMode | null;
+    /**
+     * Whether notification-code based receipt retrieval is enabled
+     * @type {boolean}
+     * @memberof CompanyCreationRequest
+     */
+    notificationCodeEnabled?: boolean | null;
+    /**
+     * Whether receipts may fall back to PDF email delivery when recipient matching does not find a Cheqi recipient
+     * @type {boolean}
+     * @memberof CompanyCreationRequest
+     */
+    emailFallbackEnabled?: boolean | null;
+}
+/**
+ * Check if a given object implements the CompanyCreationRequest interface.
+ */
+export declare function instanceOfCompanyCreationRequest(value: object): value is CompanyCreationRequest;
+export declare function CompanyCreationRequestFromJSON(json: any): CompanyCreationRequest;
+export declare function CompanyCreationRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CompanyCreationRequest;
+export declare function CompanyCreationRequestToJSON(json: any): CompanyCreationRequest;
+export declare function CompanyCreationRequestToJSONTyped(value?: CompanyCreationRequest | null, ignoreDiscriminator?: boolean): any;