@zenglobal/api-client 5.1.15 → 5.1.17

package/dist/client/types.gen.d.ts

@@ -7114,125 +7114,6 @@ export type TransactionCustomer = {
      */
     purchaseorder?: string;
 };
-/**
- * Transaction data structure. Optional fields are left out of the body
- * entirely when they have no value; they are never sent as `null`.
- */
-export type TransactionData = {
-    /**
-     * Company/chain code
-     */
-    Company: number;
-    /**
-     * Site ID
-     */
-    Site: number;
-    /**
-     * Location ID
-     */
-    Location: number;
-    /**
-     * Terminal number
-     */
-    Terminal: number;
-    /**
-     * Journal number
-     */
-    Journal: number;
-    /**
-     * Invoice journal number
-     */
-    InvoiceJournal?: string;
-    /**
-     * Credit note journal number
-     */
-    CreditJournal?: string;
-    /**
-     * Transaction date and time (YYYY-MM-DD HH:MM:SS)
-     */
-    DateTime: string;
-    /**
-     * Trading date (YYYY-MM-DD)
-     */
-    TradingDate: string;
-    /**
-     * Always `false`
-     */
-    isTraining: false;
-    /**
-     * Operator number
-     */
-    OperatorNumber: number;
-    /**
-     * Operator name
-     */
-    OperatorName: string;
-    /**
-     * Operator login
-     */
-    OperatorLogin: string;
-    /**
-     * Cash drawer number
-     */
-    Cashdrawer: number;
-    /**
-     * Always an empty string
-     */
-    EmailReceipt: '';
-    /**
-     * Customer email
-     */
-    CustomerEmail: string;
-    /**
-     * Customer postcode
-     */
-    Postcode: string;
-    /**
-     * Customer name
-     */
-    CustomerName?: string;
-    /**
-     * Customer address
-     */
-    CustomerAddress?: string;
-    /**
-     * Customer phone
-     */
-    CustomerPhone?: string;
-    /**
-     * Loyalty information, when a card was used
-     */
-    Loyalty?: WebhookTransactionLoyalty;
-    /**
-     * Sales lines
-     */
-    Sales?: Array<TransactionItem>;
-    /**
-     * Tenders. Change given is a separate line with a negative amount.
-     */
-    Tender?: Array<TransactionTender>;
-    /**
-     * Whole-of-sale discount
-     */
-    SalesDiscount?: TransactionDiscount;
-    /**
-     * Rounding
-     */
-    Rounding?: TransactionRounding;
-};
-/**
- * Transaction discount
- */
-export type TransactionDiscount = {
-    /**
-     * Discount amount
-     */
-    Amount: number;
-    /**
-     * Tax amount on discount
-     */
-    Tax: number;
-};
 /**
  * Event format transaction response (for format=event query parameter).
  *
@@ -7245,132 +7126,6 @@ export type TransactionDiscount = {
 export type TransactionEventResponse = {
     [key: string]: unknown;
 };
-/**
- * Transaction sales line.
- *
- * At most one of the pairs `SubDepartment`/`SubDepartmentName`,
- * `Category`/`CategoryName`, `SubCategory`/`SubCategoryName` and
- * `Range`/`RangeName` is present, depending on how many department levels
- * the company uses.
- */
-export type TransactionItem = {
-    /**
-     * Line date and time (YYYY-MM-DD HH:MM:SS)
-     */
-    DateTime: string;
-    /**
-     * Item code
-     */
-    Item: string;
-    /**
-     * Item barcode
-     */
-    Barcode: string;
-    /**
-     * Item description
-     */
-    Description: string;
-    /**
-     * Price level
-     */
-    PriceLevel: number;
-    /**
-     * Unit price
-     */
-    Price: number;
-    /**
-     * Original price before discounts. `0` when not discounted.
-     */
-    OriginalPrice: number;
-    /**
-     * Unit cost
-     */
-    Cost: number;
-    /**
-     * Quantity sold
-     */
-    Quantity: number;
-    /**
-     * Line total
-     */
-    LineTotal: number;
-    /**
-     * Line tax
-     */
-    LineTAX: number;
-    /**
-     * Discount amount
-     */
-    Discount: number;
-    /**
-     * Department code
-     */
-    Department: number;
-    /**
-     * Department name
-     */
-    DepartmentName: string;
-    /**
-     * Whether the item is on special
-     */
-    Special: boolean;
-    /**
-     * Loyalty points earned
-     */
-    Points?: number;
-    /**
-     * Bonus points earned
-     */
-    Bonus?: number;
-    /**
-     * Whether the item was scanned
-     */
-    Scanned: boolean;
-    /**
-     * Scan terminal number. `0` when not scanned.
-     */
-    ScanTerminal: number;
-    /**
-     * Brand code. Empty string when the item has no brand.
-     */
-    Brand: string;
-    /**
-     * Brand name. Empty string when the item has no brand.
-     */
-    BrandName: string;
-    /**
-     * Sub-department code
-     */
-    SubDepartment?: number;
-    /**
-     * Sub-department name
-     */
-    SubDepartmentName?: string;
-    /**
-     * Category code
-     */
-    Category?: number;
-    /**
-     * Category name
-     */
-    CategoryName?: string;
-    /**
-     * Sub-category code
-     */
-    SubCategory?: number;
-    /**
-     * Sub-category name
-     */
-    SubCategoryName?: string;
-    /**
-     * Range code
-     */
-    Range?: number;
-    /**
-     * Range name
-     */
-    RangeName?: string;
-};
 /**
  * Transaction offer structure for creation requests
  */
@@ -7545,15 +7300,6 @@ export type TransactionResponseOffer = {
      */
     customer_loyalty_id?: string;
 };
-/**
- * Transaction rounding
- */
-export type TransactionRounding = {
-    /**
-     * Rounding amount
-     */
-    Amount: number;
-};
 /**
  * Transaction sales discount structure.
  * The Sales Discount node activates the sales discount reports in the Portal.
@@ -7590,23 +7336,6 @@ export type TransactionTableInfo = {
      */
     covers?: string;
 };
-/**
- * Transaction tender
- */
-export type TransactionTender = {
-    /**
-     * Tender type number
-     */
-    Number: number;
-    /**
-     * Tender name
-     */
-    Name: string;
-    /**
-     * Tender amount
-     */
-    Amount: number;
-};
 /**
  * Transaction tracking information
  */
@@ -7657,14 +7386,235 @@ export type TransactionVoucher = {
      */
     voiditem?: boolean;
 };
+export type TransactionWebhookV2Category = {
+    number: number | null;
+    description: string | null;
+    chain: number | null;
+};
+export type TransactionWebhookV2CompetitionEntry = {
+    competition_id: number;
+    competition_code: string;
+    competition_name: string;
+    customer_loyalty_id: number;
+    card_number: string | null;
+    entries_count: number;
+    entry_source: string;
+    qualifying_amount: number | null;
+    qualifying_quantity: number | null;
+    /**
+     * Free-form details recorded with the entry, such as the basket total and site. `{}` when none were recorded.
+     */
+    entry_metadata: {
+        [key: string]: unknown;
+    };
+};
+/**
+ * The `transaction.complete` webhook's `data` (template `zen_transaction_v2`,
+ * ZC-7687): the journal stream record, the same record the LMG Snowflake
+ * stream receives.
+ *
+ * `event_uid` is stable for a journal: it is derived from the portal and the
+ * journal id, so a retry or replay carries the same value. Use it as an
+ * idempotency key.
+ *
+ * Every committed journal is sent, voids and training included. Read
+ * `event_payload.journal.void` and the other flags to tell them apart.
+ *
+ * Object keys arrive in alphabetical order. Do not depend on key order.
+ *
+ * These models are the webhook's own copy, not shared with the stream, so the
+ * two can diverge. Checked against
+ * `fixtures/webhook-parity/transaction_v2.expected.json`.
+ */
+export type TransactionWebhookV2Data = {
+    /**
+     * Always `journal.created`.
+     */
+    event_name: string;
+    /**
+     * When the record was built (ISO 8601, UTC).
+     */
+    event_created_at: string;
+    /**
+     * The portal the journal belongs to.
+     */
+    event_portal_uid: string;
+    /**
+     * Stable per journal: a UUIDv5 of the portal and journal id.
+     */
+    event_uid: string;
+    event_payload: TransactionWebhookV2Payload;
+};
+export type TransactionWebhookV2Discount = {
+    amount: number;
+    tax: number;
+    discount_type: string;
+    item_number: string | null;
+};
+export type TransactionWebhookV2Journal = {
+    /**
+     * Journal (JOURNALTRACK) id.
+     */
+    id: number;
+    /**
+     * Whether the whole sale was voided.
+     */
+    void: boolean;
+    company: {
+        id: number;
+        name: string;
+    };
+    site: {
+        id: number;
+        name: string | null;
+        customer_reference_id: string | null;
+    };
+    location: {
+        id: number;
+        number: number;
+        name: string | null;
+    };
+    operator: {
+        id: number;
+        number: number;
+        name: string;
+    };
+    terminal: {
+        number: number;
+        cash_drawer: number | null;
+    };
+    /**
+     * Journal number as the POS reported it.
+     */
+    journal_number: string;
+    /**
+     * Local time of the sale, `Y-m-d\TH:i:s`, no offset.
+     */
+    transacted_at: string;
+    /**
+     * Loyalty card on the sale, or `null`.
+     */
+    loyalty: TransactionWebhookV2Loyalty | null;
+    table: {
+        table_id: number | null;
+        number: number | null;
+        covers: number;
+    };
+    sales: Array<TransactionWebhookV2SaleItem>;
+    tenders: Array<TransactionWebhookV2Tender>;
+    discounts: Array<TransactionWebhookV2Discount>;
+    offers: Array<TransactionWebhookV2Offer>;
+    voids: Array<TransactionWebhookV2Void>;
+    competition_entries: Array<TransactionWebhookV2CompetitionEntry>;
+    sales_breakdown: {
+        sales: number;
+        sales_ex: number;
+        tax: number;
+        cost: number;
+        discount: number;
+        rounding: number;
+    };
+    /**
+     * The points the sale posted to the loyalty card. All zero when the sale has no loyalty card.
+     */
+    points_breakdown: TransactionWebhookV2Points;
+    discount_breakdown: {
+        sales: number;
+        item: number;
+        offer: number;
+    };
+    sales_channel: string;
+    partner_id: string;
+    order_reference: string;
+    timezone: string;
+};
+export type TransactionWebhookV2Loyalty = {
+    card_number: string;
+    first_name?: string;
+    last_name?: string;
+    mobile?: string | null;
+    card_type?: number;
+};
+export type TransactionWebhookV2Offer = {
+    id: number;
+    external_reference: string;
+    total_amount: number;
+    total_quantity: number;
+    effect_type: string;
+};
+export type TransactionWebhookV2Payload = {
+    journal: TransactionWebhookV2Journal;
+};
 /**
- * Transaction webhook data payload
+ * The points a sale posted to its loyalty card, split by kind.
+ * `base + bonus + jackpot + redeemed + expired = total`.
  */
-export type TransactionWebhookData = {
+export type TransactionWebhookV2Points = {
+    /**
+     * Points earned at the card's normal rate.
+     */
+    base: number;
     /**
-     * Transaction data container
+     * Bonus points included in `total`.
      */
-    AMC_POSPortal: TransactionData;
+    bonus: number;
+    /**
+     * Jackpot points included in `total`.
+     */
+    jackpot: number;
+    /**
+     * Expired points included in `total`.
+     */
+    expired: number;
+    /**
+     * Points redeemed. Negative when the sale spent points.
+     */
+    redeemed: number;
+    /**
+     * The net change to the card's balance from this sale.
+     */
+    total: number;
+};
+export type TransactionWebhookV2SaleItem = {
+    /**
+     * BASKET row id.
+     */
+    basket_id: number | null;
+    item_number: string;
+    source_item_number: string;
+    barcode: string;
+    description: string;
+    promotion_id: string;
+    price_level: number;
+    unit_price: number;
+    unit_cost: number;
+    quantity: number;
+    line_total: number;
+    line_tax: number;
+    line_discount: number;
+    special: boolean;
+    matching_strategy_type: string;
+    kit_type: string;
+    division?: TransactionWebhookV2Category;
+    department?: TransactionWebhookV2Category;
+    sub_department?: TransactionWebhookV2Category;
+    offers: Array<TransactionWebhookV2Offer>;
+    competition_entries: Array<TransactionWebhookV2CompetitionEntry>;
+};
+export type TransactionWebhookV2Tender = {
+    number: number;
+    name: string;
+    amount: number;
+    void: boolean;
+};
+export type TransactionWebhookV2Void = {
+    amount: number;
+    description: string;
+    item_number: string | null;
+    /**
+     * `item` or `sale`.
+     */
+    type: string;
 };
 /**
  * Validation error for various validation failures (400)
@@ -9129,9 +9079,9 @@ export type WebhookDestination = {
         [key: string]: unknown;
     } | null;
     /**
-     * Whether a 4xx response from your endpoint counts as a permanent failure or a retryable one
+     * What a 4xx response from your endpoint means: `failed` (the default) is a permanent failure that is not retried; `delivered` counts it as delivered.
      */
-    treat_4xx_as: 'failed' | 'retry';
+    treat_4xx_as: 'failed' | 'delivered';
     /**
      * Read-only. Whether this destination is live. Creating sets it true and deleting sets it false; it cannot be driven from a request body.
      */
@@ -9207,7 +9157,7 @@ export type WebhookDestinationInput = {
     response_check?: {
         [key: string]: unknown;
     } | null;
-    treat_4xx_as?: 'failed' | 'retry';
+    treat_4xx_as?: 'failed' | 'delivered';
 };
 export type WebhookDestinationListResponse = {
     destinations: Array<WebhookDestination>;
@@ -9292,39 +9242,6 @@ export type WebhookSigningKeyResponse = {
      */
     signing_key: string;
 };
-/**
- * Transaction loyalty information
- */
-export type WebhookTransactionLoyalty = {
-    /**
-     * Loyalty card number
-     */
-    Card: string;
-    /**
-     * Always an empty string
-     */
-    OpeningPoints: '';
-    /**
-     * Card holder name, as `Last,First`
-     */
-    Name: string;
-    /**
-     * First name
-     */
-    FirstName: string;
-    /**
-     * Last name
-     */
-    LastName: string;
-    /**
-     * Round points flag
-     */
-    RoundPoints: boolean;
-    /**
-     * Card type ID
-     */
-    CardType: number;
-};
 /**
  * A field-level validation failure.
  */
@@ -13257,7 +13174,7 @@ export type WebhookItemPriceWebhookRequest = {
 };
 export type WebhookTransactionCompleteWebhookPayload = WebhookPayload & {
     function?: 'transaction';
-    data: TransactionWebhookData;
+    data: TransactionWebhookV2Data;
 };
 export type WebhookTransactionCompleteWebhookRequest = {
     body: WebhookTransactionCompleteWebhookPayload;