@cheqi/sdk 0.1.1

package/dist/models/domain.d.ts

@@ -0,0 +1,366 @@
+import type { AddressDTO, BarcodeType, BuyerType, CardDetails as CardDetailsShape, Charge as ChargeShape, CompanyDTO, CreateStoreRequest as CreateStoreRequestShape, Discount as DiscountShape, IdentificationDetails as IdentificationDetailsShape, IdentificationDetailsPaymentTypeEnum, Identifier as IdentifierShape, NotificationDisplayCode as NotificationDisplayCodeShape, PaymentAccountDetails as PaymentAccountDetailsShape, Period as PeriodShape, Product as ProductShape, ReceiptTemplateRequest as ReceiptTemplateRequestShape, ReceiptTemplateResponse as ReceiptTemplateResponseShape, Tax as TaxShape, VatMetadata as VatMetadataShape } from "../types.js";
+type Optional<T> = T | null | undefined;
+declare class BuilderBase<T> {
+    protected values: any;
+    from(value: Partial<T>): this;
+}
+export declare class CardDetails {
+    paymentAccountNumber?: string;
+    paymentAccountReference?: string;
+    cardProvider?: string;
+    constructor(init?: Partial<CardDetailsShape>);
+    static builder(): CardDetailsBuilder;
+}
+export declare class CardDetailsBuilder extends BuilderBase<CardDetailsShape> {
+    paymentAccountNumber(value: string): this;
+    paymentAccountReference(value: string): this;
+    cardProvider(value: string): this;
+    build(): CardDetailsShape;
+}
+export declare class PaymentAccountDetails {
+    identifier?: string;
+    identifierType?: string;
+    constructor(init?: Partial<PaymentAccountDetailsShape>);
+    static builder(): PaymentAccountDetailsBuilder;
+}
+export declare class PaymentAccountDetailsBuilder extends BuilderBase<PaymentAccountDetailsShape> {
+    identifier(value: string): this;
+    identifierType(value: string): this;
+    build(): PaymentAccountDetailsShape;
+}
+export declare class IdentificationDetails implements IdentificationDetailsShape {
+    paymentType: IdentificationDetailsPaymentTypeEnum;
+    cardDetails?: CardDetailsShape;
+    paymentAccountDetails?: PaymentAccountDetailsShape;
+    paymentIds?: string[];
+    recipientEmail?: string;
+    cheqiReceiptId?: string;
+    pairingCode?: string;
+    constructor(init?: Partial<IdentificationDetailsShape>);
+    static builder(): IdentificationDetailsBuilder;
+    getPaymentType(): Optional<IdentificationDetailsPaymentTypeEnum>;
+    getCardDetails(): Optional<CardDetailsShape>;
+    getPaymentAccountDetails(): Optional<PaymentAccountDetailsShape>;
+    getPaymentIds(): Optional<string[]>;
+    getRecipientEmail(): Optional<string>;
+    getCheqiReceiptId(): Optional<string>;
+    getPairingCode(): Optional<string>;
+}
+export declare class IdentificationDetailsBuilder extends BuilderBase<IdentificationDetailsShape> {
+    paymentType(value: IdentificationDetailsPaymentTypeEnum): this;
+    cardDetails(value: CardDetailsShape): this;
+    paymentAccountDetails(value: PaymentAccountDetailsShape): this;
+    paymentIds(value: string[]): this;
+    recipientEmail(value: string): this;
+    cheqiReceiptId(value: string): this;
+    pairingCode(value: string): this;
+    build(): IdentificationDetails;
+}
+export declare class NotificationDisplayCode implements NotificationDisplayCodeShape {
+    type: BarcodeType;
+    data: string;
+    constructor(init: NotificationDisplayCodeShape);
+    static builder(): NotificationDisplayCodeBuilder;
+}
+export declare class NotificationDisplayCodeBuilder extends BuilderBase<NotificationDisplayCodeShape> {
+    type(value: BarcodeType): this;
+    data(value: string): this;
+    build(): NotificationDisplayCode;
+}
+export declare class Identifier {
+    value?: string;
+    schemeID?: string;
+    constructor(init?: Partial<IdentifierShape>);
+    static builder(): IdentifierBuilder;
+}
+export declare class IdentifierBuilder extends BuilderBase<IdentifierShape> {
+    value(value: string): this;
+    schemeID(value: string): this;
+    build(): IdentifierShape;
+}
+export declare class Period {
+    startDate?: string;
+    endDate?: string;
+    description?: string;
+    constructor(init?: Partial<PeriodShape>);
+    static builder(): PeriodBuilder;
+}
+export declare class PeriodBuilder extends BuilderBase<PeriodShape> {
+    startDate(value: string): this;
+    endDate(value: string): this;
+    description(value: string): this;
+    build(): PeriodShape;
+}
+export declare class Barcode {
+    type?: string;
+    data?: string;
+    label?: string;
+    constructor(init?: Partial<{
+        type?: string;
+        data?: string;
+        label?: string;
+    }>);
+    static builder(): BarcodeBuilder;
+}
+export declare class BarcodeBuilder extends BuilderBase<{
+    type?: string;
+    data?: string;
+    label?: string;
+}> {
+    type(value: string): this;
+    data(value: string): this;
+    label(value: string): this;
+    build(): {
+        type?: string;
+        data?: string;
+        label?: string;
+    };
+}
+export declare class Tax {
+    rate?: number;
+    type?: string;
+    taxableAmount?: number;
+    amount?: number;
+    label?: string;
+    constructor(init?: Partial<TaxShape>);
+    static builder(): TaxBuilder;
+}
+export declare class TaxBuilder extends BuilderBase<TaxShape> {
+    rate(value: number): this;
+    type(value: string): this;
+    taxableAmount(value: number): this;
+    amount(value: number): this;
+    label(value: string): this;
+    build(): TaxShape;
+}
+export declare class Discount {
+    amount?: number;
+    percentage?: number;
+    label?: string;
+    constructor(init?: Partial<DiscountShape>);
+    static builder(): DiscountBuilder;
+}
+export declare class DiscountBuilder extends BuilderBase<DiscountShape> {
+    amount(value: number): this;
+    percentage(value: number): this;
+    label(value: string): this;
+    build(): DiscountShape;
+}
+export declare class Charge {
+    amount?: number;
+    percentage?: number;
+    label?: string;
+    constructor(init?: Partial<ChargeShape>);
+    static builder(): ChargeBuilder;
+}
+export declare class ChargeBuilder extends BuilderBase<ChargeShape> {
+    amount(value: number): this;
+    percentage(value: number): this;
+    label(value: string): this;
+    build(): ChargeShape;
+}
+export declare class Product {
+    name?: string;
+    identifier?: string;
+    description?: string;
+    brandName?: string;
+    quantity?: number;
+    baseQuantity?: number;
+    unitCode?: any;
+    unitPrice?: number;
+    discounts?: DiscountShape[];
+    charges?: ChargeShape[];
+    taxes?: TaxShape[];
+    subtotal?: number;
+    total?: number;
+    barcodes?: any[];
+    period?: PeriodShape;
+    constructor(init?: Partial<ProductShape>);
+    static builder(): ProductBuilder;
+}
+export declare class ProductBuilder extends BuilderBase<ProductShape> {
+    name(value: string): this;
+    identifier(value: string): this;
+    description(value: string): this;
+    brandName(value: string): this;
+    quantity(value: number): this;
+    baseQuantity(value: number): this;
+    unitCode(value: string): this;
+    unitPrice(value: number): this;
+    discounts(value: DiscountShape[]): this;
+    charges(value: ChargeShape[]): this;
+    taxes(value: TaxShape[]): this;
+    subtotal(value: number): this;
+    total(value: number): this;
+    barcodes(value: any[]): this;
+    period(value: PeriodShape): this;
+    addTax(rate: number, type: string, taxableAmount: number, amount: number): this;
+    addDiscount(amount: number, label: string, percentage?: number): this;
+    addCharge(amount: number, label: string, percentage?: number): this;
+    build(): ProductShape;
+}
+export declare class PaymentInfo {
+    paymentType?: string;
+    paymentAccountReference?: string;
+    cardIssuer?: string;
+    cardBrand?: string;
+    lastFourDigits?: string;
+    paymentIds?: string[];
+    constructor(init?: Partial<PaymentInfo>);
+    static builder(): PaymentInfoBuilder;
+}
+export declare class PaymentInfoBuilder extends BuilderBase<PaymentInfo> {
+    paymentType(value: string): this;
+    paymentAccountReference(value: string): this;
+    cardIssuer(value: string): this;
+    cardBrand(value: string): this;
+    lastFourDigits(value: string): this;
+    paymentIds(value: string[]): this;
+    build(): PaymentInfo;
+}
+export declare class VatMetadata {
+    supplierCountry?: string;
+    buyerCountry?: string;
+    crossBorder?: boolean;
+    buyerType?: BuyerType;
+    vatOnReceipt?: boolean;
+    vatRegime?: string;
+    taxesApplied?: boolean;
+    constructor(init?: Partial<VatMetadataShape>);
+    static builder(): VatMetadataBuilder;
+}
+export declare class VatMetadataBuilder extends BuilderBase<VatMetadataShape> {
+    supplierCountry(value: string): this;
+    buyerCountry(value: string): this;
+    crossBorder(value: boolean): this;
+    buyerType(value: BuyerType): this;
+    vatOnReceipt(value: boolean): this;
+    vatRegime(value: string): this;
+    taxesApplied(value: boolean): this;
+    build(): VatMetadataShape;
+}
+export declare class ReceiptTemplateRequest {
+    childCompanyId?: string;
+    documentNumber?: string;
+    identifiers?: IdentifierShape[];
+    issueDate?: Date;
+    currency?: string;
+    receiptSubtotal?: number;
+    totalBeforeTax?: number;
+    totalTaxAmount?: number;
+    totalAmount?: number;
+    products?: ProductShape[];
+    discounts?: DiscountShape[];
+    charges?: ChargeShape[];
+    taxes?: TaxShape[];
+    transactionDate?: Date;
+    purchaseDate?: Date;
+    period?: PeriodShape;
+    barcodes?: any[];
+    note?: string;
+    constructor(init?: Partial<ReceiptTemplateRequestShape>);
+    static builder(): ReceiptTemplateRequestBuilder;
+}
+export declare class ReceiptTemplateRequestBuilder extends BuilderBase<ReceiptTemplateRequestShape> {
+    childCompanyId(value: string): this;
+    documentNumber(value: string): this;
+    identifiers(value: IdentifierShape[]): this;
+    issueDate(value: Date): this;
+    currency(value: string): this;
+    receiptSubtotal(value: number): this;
+    totalBeforeTax(value: number): this;
+    totalTaxAmount(value: number): this;
+    totalAmount(value: number): this;
+    products(value: ProductShape[]): this;
+    discounts(value: DiscountShape[]): this;
+    charges(value: ChargeShape[]): this;
+    taxes(value: TaxShape[]): this;
+    transactionDate(value: Date): this;
+    purchaseDate(value: Date): this;
+    period(value: PeriodShape): this;
+    barcodes(value: any[]): this;
+    note(value: string): this;
+    addProduct(product: ProductShape): this;
+    addTax(tax: TaxShape): this;
+    addDiscount(discount: DiscountShape): this;
+    addCharge(charge: ChargeShape): this;
+    build(): ReceiptTemplateRequest;
+}
+export declare class ReceiptTemplateResponse implements Partial<ReceiptTemplateResponseShape> {
+    ubl?: string;
+    cheqi?: any;
+    vatMetadata?: any;
+    constructor(init?: Partial<ReceiptTemplateResponseShape>);
+}
+export declare class CompanyAddress implements Partial<AddressDTO> {
+    streetName?: string;
+    additionalStreetName?: string;
+    addressLine?: string;
+    region?: string;
+    cityName?: string;
+    postalZone?: string;
+    countryIsoCode?: string;
+    constructor(init?: Partial<AddressDTO>);
+    static builder(): CompanyAddressBuilder;
+}
+export declare class CompanyAddressBuilder extends BuilderBase<AddressDTO> {
+    streetName(value: string): this;
+    additionalStreetName(value: string): this;
+    addressLine(value: string): this;
+    region(value: string): this;
+    cityName(value: string): this;
+    postalZone(value: string): this;
+    countryIsoCode(value: string): this;
+    build(): CompanyAddress;
+}
+export declare class Company {
+    companyName?: string;
+    companyLegalName?: string;
+    chamberOfCommerceNumber?: string;
+    taxNumber?: string;
+    companyEmail?: string;
+    phoneNumber?: string;
+    website?: string;
+    returnDays?: number;
+    companyReceiptText?: string;
+    companyLogoUrl?: string;
+    address?: CompanyAddress;
+    constructor(init?: Partial<Company>);
+    static builder(): CompanyBuilder;
+    toCompanyDTO(): CompanyDTO;
+}
+export declare class CompanyBuilder extends BuilderBase<Company> {
+    companyName(value: string): this;
+    companyLegalName(value: string): this;
+    chamberOfCommerceNumber(value: string): this;
+    taxNumber(value: string): this;
+    companyEmail(value: string): this;
+    phoneNumber(value: string): this;
+    website(value: string): this;
+    returnDays(value: number): this;
+    companyReceiptText(value: string): this;
+    companyLogoUrl(value: string): this;
+    address(value: CompanyAddress): this;
+    build(): Company;
+}
+export declare class CreateStoreRequest {
+    storeName?: string;
+    storeCode?: string;
+    address?: CompanyAddress;
+    phoneNumber?: string;
+    email?: string;
+    openingHours?: string;
+    constructor(init?: Partial<CreateStoreRequest>);
+    static builder(): CreateStoreRequestBuilder;
+    toCreateStoreRequestDTO(): CreateStoreRequestShape;
+}
+export declare class CreateStoreRequestBuilder extends BuilderBase<CreateStoreRequest> {
+    storeName(value: string): this;
+    storeCode(value: string): this;
+    address(value: CompanyAddress): this;
+    phoneNumber(value: string): this;
+    email(value: string): this;
+    openingHours(value: string): this;
+    build(): CreateStoreRequest;
+}
+export {};