@zenglobal/api-client 5.1.14 → 5.1.15

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

@@ -1,7 +1,7 @@
 export type ClientOptions = {
     baseUrl: 'https://api-dev.zenglobal.au' | 'https://api.zenglobal.au' | (string & {});
 };
-export type Webhooks = WebhookLoyaltyWebhookRequest | WebhookCustomerWebhookRequest | WebhookOfferWebhookRequest | WebhookRedeemWebhookRequest | WebhookDeleteWebhookRequest | WebhookItemWebhookRequest | WebhookPriceWebhookRequest | WebhookTransactionWebhookRequest;
+export type Webhooks = WebhookLoyaltyCardWebhookRequest | WebhookLoyaltyPointsWebhookRequest | WebhookCustomerUpsertWebhookRequest | WebhookOfferCreateWebhookRequest | WebhookOfferUpdateWebhookRequest | WebhookOfferRedeemWebhookRequest | WebhookOfferDeleteWebhookRequest | WebhookItemSohWebhookRequest | WebhookItemPriceWebhookRequest | WebhookTransactionCompleteWebhookRequest | WebhookPingWebhookRequest;
 /**
  * Address structure used for billing and shipping addresses
  */
@@ -38,27 +38,27 @@ export type AddressData = {
     /**
      * Address line 1
      */
-    address1?: string;
+    address1: string;
     /**
      * Address line 2
      */
-    address2?: string;
+    address2: string;
     /**
      * Suburb
      */
-    suburb?: string;
+    suburb: string;
     /**
      * State
      */
-    state?: string;
+    state: string;
     /**
      * Postcode
      */
-    postcode?: string;
+    postcode: string;
     /**
      * Country
      */
-    country?: string;
+    country: string;
 };
 /**
  * Response for GET /lists.
@@ -808,7 +808,7 @@ export type CustomerData = {
     /**
      * Company/chain code
      */
-    Company: string;
+    Company: number;
     /**
      * Customer number
      */
@@ -820,35 +820,36 @@ export type CustomerData = {
     /**
      * Email address
      */
-    email?: string;
+    email: string;
     /**
      * Mobile number
      */
-    mobile?: string;
+    mobile: string;
     /**
      * Phone number
      */
-    phone?: string;
+    phone: string;
     /**
      * Secondary phone number
      */
-    phone1?: string;
+    phone1: string;
     /**
      * Gender
      */
-    gender?: string;
+    gender: string;
     /**
-     * Date of birth
+     * Date of birth (YYYY-MM-DD)
      */
-    dateofbirth?: string;
+    dateofbirth: string;
     /**
      * WooCommerce customer ID
      */
-    woocommerce?: string;
+    woocommerce: string;
     /**
-     * Shopify customer ID
+     * Shopify customer ID. The key really is spelled `shopfiy`; it has always
+     * been sent that way and is kept for compatibility.
      */
-    shopify?: string;
+    shopfiy: string;
     /**
      * Billing address
      */
@@ -858,9 +859,9 @@ export type CustomerData = {
      */
     shipping: AddressData;
     /**
-     * Associated loyalty cards
+     * Loyalty cards linked to the customer. An empty array when there are none.
      */
-    cards?: Array<LoyaltyCardSummary>;
+    cards: Array<LoyaltyCardSummary>;
 };
 /**
  * The error body these operations return.
@@ -1362,53 +1363,108 @@ export type InventoryLoyaltyGroup = {
     description: string;
 };
 /**
- * Inventory webhook data payload
+ * Price change, sent on `item.price`. The fields are at the top level of
+ * `data`, not in a wrapper object.
  */
-export type InventoryWebhookData = {
+export type InventoryPriceWebhookData = {
+    /**
+     * Company/chain code
+     */
+    chain: number;
+    /**
+     * Company/chain code (same value as `chain`)
+     */
+    Company: number;
+    /**
+     * Site ID
+     */
+    Site: number;
+    /**
+     * Location ID
+     */
+    Location: number;
     /**
      * Item code
      */
     Item: string;
+    /**
+     * New price
+     */
+    Price: number;
+    /**
+     * Always `false`
+     */
+    sohFlag: false;
+    /**
+     * Always `true`
+     */
+    priceFlag: true;
+};
+/**
+ * Stock-on-hand change, sent on `item.soh`. The fields are at the top level
+ * of `data`, not in a wrapper object.
+ *
+ * Exactly one of `StockOnHand` and `DeltaQuantity` is present, chosen by
+ * `delta`. `PreviousSOH`, `CurrentSOH`, `ReferralItem` and `ReferralRatio`
+ * are each left out when they have no value.
+ */
+export type InventorySohWebhookData = {
     /**
      * Company/chain code
      */
-    chain: string;
+    chain: number;
     /**
-     * Company/chain code (duplicate)
+     * Company/chain code (same value as `chain`)
      */
-    Company: string;
+    Company: number;
     /**
-     * Whether stock on hand has changed
+     * Site ID
      */
-    sohFlag: boolean;
+    Site: number;
     /**
-     * Whether price has changed
+     * Location ID
      */
-    priceFlag: boolean;
+    Location: number;
     /**
-     * Current stock on hand
+     * Item code
      */
-    stockOnHand?: number;
+    Item: string;
     /**
-     * Item price
+     * Always `true`
      */
-    price?: number;
+    sohFlag: true;
     /**
-     * Item cost
+     * Always `false`
      */
-    cost?: number;
+    priceFlag: false;
     /**
-     * Item description
+     * `true` when the change is sent as a quantity change (`DeltaQuantity`), `false` when it is the new level (`StockOnHand`)
      */
-    description?: string;
+    delta: boolean;
     /**
-     * Department code
+     * Stock on hand. Present when `delta` is `false`.
      */
-    department?: number;
+    StockOnHand?: number;
     /**
-     * Site code
+     * Change in stock on hand. Present when `delta` is `true`.
      */
-    sitecode?: string;
+    DeltaQuantity?: number;
+    /**
+     * Stock on hand before the change
+     */
+    PreviousSOH?: number;
+    /**
+     * Stock on hand after the change
+     */
+    CurrentSOH?: number;
+    /**
+     * Referral item code
+     */
+    ReferralItem?: string;
+    /**
+     * Ratio between this item and `ReferralItem`
+     */
+    ReferralRatio?: number;
 };
 /**
  * Active jackpot information
@@ -2399,7 +2455,7 @@ export type LoyaltyCardData = {
     /**
      * Company/chain code
      */
-    Company: string;
+    Company: number;
     /**
      * Loyalty card number
      */
@@ -2409,21 +2465,21 @@ export type LoyaltyCardData = {
      */
     Customer: string;
     /**
-     * Family card number (if linked)
+     * Family card number, or an empty string if the card is not linked
      */
     FamilyCard: string;
     /**
-     * Original card number before conversion
+     * Same value as `Card`
      */
     OriginalCard: string;
     /**
-     * Card status
+     * Always `Present`
      */
-    Status: string;
+    Status: 'Present';
     /**
      * Customer salutation
      */
-    Salutation?: string;
+    Salutation: string;
     /**
      * First name
      */
@@ -2435,77 +2491,77 @@ export type LoyaltyCardData = {
     /**
      * Card PIN
      */
-    pin?: string;
+    pin: string;
     /**
      * Gender
      */
-    Gender?: string;
+    Gender: string;
     /**
      * Address line 1
      */
-    Address1?: string;
+    Address1: string;
     /**
      * Address line 2
      */
-    Address2?: string;
+    Address2: string;
     /**
      * Suburb
      */
-    Suburb?: string;
+    Suburb: string;
     /**
      * State
      */
-    State?: string;
+    State: string;
     /**
      * Postcode
      */
-    Postcode?: string;
+    Postcode: string;
     /**
      * Security token
      */
-    Token?: string;
+    Token: string;
     /**
-     * App token
+     * Always an empty string
      */
-    AppToken?: string;
+    AppToken: '';
     /**
-     * App operating system
+     * Always an empty string
      */
-    AppSystem?: string;
+    AppSystem: '';
     /**
      * Email address
      */
-    Email?: string;
+    Email: string;
     /**
      * Phone number
      */
-    Phone?: string;
+    Phone: string;
     /**
      * Secondary phone number
      */
-    Phone2?: string;
+    Phone2: string;
     /**
      * Mobile number
      */
-    Mobile?: string;
+    Mobile: string;
     /**
      * Fax number
      */
-    Fax?: string;
+    Fax: string;
     /**
      * Occupation
      */
-    Occupation?: string;
+    Occupation: string;
     /**
-     * Date of birth
+     * Date of birth (YYYY-MM-DD)
      */
-    dateOfBirth?: string;
+    dateOfBirth: string;
     /**
      * Card type ID
      */
-    CARDTYPE: string;
+    CARDTYPE: number;
     /**
-     * Whether card follows default settings
+     * Whether the card follows its card type's default settings
      */
     FOLLOWCARD: 'T' | 'F';
     /**
@@ -2521,29 +2577,29 @@ export type LoyaltyCardData = {
      */
     Discount: string;
     /**
-     * Mail opt-in preference
+     * Mail opt-in
      */
-    mailOpt?: string;
+    mailOpt: 'T' | 'F';
     /**
-     * Email opt-in preference
+     * Email opt-in
      */
-    emailOpt?: string;
+    emailOpt: 'T' | 'F';
     /**
-     * SMS opt-in preference
+     * SMS opt-in
      */
-    smsOpt?: string;
+    smsOpt: 'T' | 'F';
     /**
      * Whether card details are complete
      */
-    CardComplete: string;
+    CardComplete: 'T' | 'F';
     /**
      * Whether card is active
      */
-    CardActive: string;
+    CardActive: 'T' | 'F';
     /**
      * Whether card is purged
      */
-    Purged: string;
+    Purged: 'T' | 'F';
     /**
      * Current points balance
      */
@@ -2551,7 +2607,7 @@ export type LoyaltyCardData = {
     /**
      * Home site ID
      */
-    HomeSite: string;
+    HomeSite: number;
     /**
      * Home site name
      */
@@ -2559,7 +2615,7 @@ export type LoyaltyCardData = {
     /**
      * Profile picture URL
      */
-    Picture?: string;
+    Picture: string;
 };
 /**
  * Card movement/tier progression information
@@ -2617,33 +2673,29 @@ export type LoyaltyCardSummary = {
      */
     name: string;
     /**
-     * Join date
+     * Join date (YYYY-MM-DD)
      */
     joindate: string;
     /**
      * Points earned to date
      */
-    pointsearned: string;
+    pointsearned: number;
     /**
      * Points redeemed to date
      */
-    pointsredeemed: string;
+    pointsredeemed: number;
     /**
      * Points expired to date
      */
-    pointsexpired: string;
+    pointsexpired: number;
     /**
-     * Current points balance
+     * Current points balance. Sent as a string, unlike the other points fields.
      */
     pointsbalance: string;
     /**
-     * Total sales to date
-     */
-    salestodate: string;
-    /**
-     * Card type
+     * Card type ID
      */
-    cardtype: string;
+    cardtype: number;
 };
 /**
  * Loyalty card type information
@@ -4474,57 +4526,306 @@ export type OfferCreateRequest = {
     effect?: OfferEffect;
 };
 /**
- * Offer data structure
+ * The offer record, sent on `offer.create` and `offer.update`.
+ *
+ * Most fields can be `null` when the offer does not set them. Decimal
+ * columns are sent as strings (`"19.990"`). Flag columns are sent as `"T"`
+ * or `"F"`, except the six listed as booleans.
+ *
+ * The boolean flags `linkedto`, `peritem`, `birthdayoffer`, `linkscheduler`,
+ * `cardactive` and `cardcomplete` are always `false`, and `loyaltyonly` is
+ * always `true`, whatever the offer is set to. This is a long-standing bug
+ * in how these flags are converted; it is kept so existing consumers do not
+ * break. Do not rely on these seven fields.
  */
 export type OfferData = {
     /**
      * Offer ID
      */
-    offerid: string;
+    offerid: number;
     /**
-     * Company/chain code
+     * Company/chain code that owns the offer
      */
-    chaincode: string;
+    chaincode: number | null;
+    /**
+     * Offer description
+     */
+    description: string | null;
     /**
-     * Offer title
+     * Date the offer becomes active (YYYY-MM-DD)
      */
-    title?: string;
+    dateactive: string | null;
     /**
-     * Offer description
+     * Date the offer expires (YYYY-MM-DD)
      */
-    description?: string;
+    dateexpire: string | null;
+    /**
+     * Number of times a customer may use the offer
+     */
+    numberallowed: number | null;
+    /**
+     * Number of times the offer may be used per site
+     */
+    numberallowedsite: number | null;
     /**
-     * Whether offer is loyalty-only
+     * Start hour of day, as a decimal string
+     */
+    starthour: string | null;
+    /**
+     * End hour of day, as a decimal string
+     */
+    endhour: string | null;
+    /**
+     * Largest basket total the offer triggers on
+     */
+    maxamount: string | null;
+    /**
+     * Smallest basket total the offer triggers on
+     */
+    minamount: string | null;
+    /**
+     * Offer amount
+     */
+    amount: string | null;
+    /**
+     * Points value configured on the offer
+     */
+    points: string | null;
+    /**
+     * Discount
+     */
+    discount: string | null;
+    /**
+     * Department code
+     */
+    department: number | null;
+    /**
+     * Points multiplier
+     */
+    multpoints: string | null;
+    /**
+     * Whether the offer is enabled
+     */
+    enabled: 'T' | 'F' | null;
+    /**
+     * Always `true`. See the model description.
      */
     loyaltyonly: boolean;
     /**
-     * Whether offer is linked to another offer
+     * Whether the offer is limited to the card types below
+     */
+    cardtypeflag: 'T' | 'F' | null;
+    /**
+     * Card type the offer is limited to
+     */
+    loyaltycardtype: number | null;
+    /**
+     * Additional card type
+     */
+    loyaltycardtype1: number | null;
+    /**
+     * Additional card type
+     */
+    loyaltycardtype2: number | null;
+    /**
+     * Additional card type
+     */
+    loyaltycardtype3: number | null;
+    /**
+     * Additional card type
+     */
+    loyaltycardtype4: number | null;
+    /**
+     * Additional card type
+     */
+    loyaltycardtype5: number | null;
+    /**
+     * Customer group the offer is limited to
+     */
+    group1: number | null;
+    /**
+     * Additional customer group
+     */
+    group2: number | null;
+    /**
+     * Additional customer group
+     */
+    group3: number | null;
+    /**
+     * Additional customer group
+     */
+    group4: number | null;
+    /**
+     * Additional customer group
+     */
+    group5: number | null;
+    /**
+     * Additional customer group
+     */
+    group6: number | null;
+    /**
+     * Whether the offer is limited to the groups above
+     */
+    groupflag: 'T' | 'F' | null;
+    /**
+     * Always `false`. See the model description.
      */
     linkedto: boolean;
     /**
-     * Whether this is a birthday offer
+     * Always `false`. See the model description.
+     */
+    peritem: boolean;
+    /**
+     * Offer reference
+     */
+    offerref: string | null;
+    /**
+     * Free-text comments
+     */
+    comments: string | null;
+    /**
+     * Offer period in days
+     */
+    offerperiod: number | null;
+    /**
+     * Always `false`. See the model description.
      */
     birthdayoffer: boolean;
     /**
-     * Whether card must be active
+     * Delta days
+     */
+    deltadays: number | null;
+    /**
+     * Whether the offer is linked to an external system
+     */
+    externallink: 'T' | 'F' | null;
+    /**
+     * External system user
+     */
+    externaluser: string | null;
+    /**
+     * External system password
+     */
+    externalpassword: string | null;
+    /**
+     * External system reference
+     */
+    externalref: string | null;
+    /**
+     * Always `false`. See the model description.
+     */
+    linkscheduler: boolean;
+    /**
+     * Offer image URL
+     */
+    image: string | null;
+    /**
+     * Delta direction
+     */
+    deltadir: string | null;
+    /**
+     * Boost type
+     */
+    boosttype: string | null;
+    /**
+     * Boost days
+     */
+    boostdays: number | null;
+    /**
+     * Always `false`. See the model description.
      */
     cardactive: boolean;
     /**
-     * Whether card details must be complete
+     * Always `false`. See the model description.
      */
     cardcomplete: boolean;
     /**
-     * Date offer was last changed
+     * Coffee card ID
+     */
+    coffeecard: number | null;
+    /**
+     * Portal user who last changed the offer
+     */
+    portaluser: string | null;
+    /**
+     * Date the offer was last changed (YYYY-MM-DD)
      */
-    changedate: string;
+    changedate: string | null;
     /**
-     * Date offer becomes active
+     * Event ID
      */
-    dateactive: string;
+    eventid: number | null;
     /**
-     * Date offer expires
+     * What the offer applies to
      */
-    dateexpire: string;
+    apply_to: number;
+    /**
+     * Maximum quantity the offer applies to
+     */
+    apply_upto_quantity: number;
+    /**
+     * Fixed amount
+     */
+    fixed_amount: string;
+    /**
+     * Location type filter, as a JSON-encoded array in a string
+     */
+    location_type_id_filter: string | null;
+    /**
+     * Location filter, as a JSON-encoded array in a string
+     */
+    location_filter: string | null;
+    /**
+     * Site filter, as a JSON-encoded array in a string
+     */
+    site_filter: string | null;
+    /**
+     * Day-of-week filter, as a JSON-encoded array in a string
+     */
+    day_of_week_filter: string | null;
+    /**
+     * Region filter, as a JSON-encoded array in a string
+     */
+    region_filter: string | null;
+    /**
+     * State filter, as a JSON-encoded array in a string
+     */
+    state_filter: string | null;
+    /**
+     * Promotion group ID
+     */
+    promo_group_id: number | null;
+    /**
+     * Item the offer applies to, or `null`
+     */
+    apply_to_items: {
+        sku: string;
+        quantity: number;
+    } | null;
+    /**
+     * Start of the new-member window (YYYY-MM-DD)
+     */
+    new_member_window_start: string | null;
+    /**
+     * End of the new-member window (YYYY-MM-DD)
+     */
+    new_member_window_end: string | null;
+    /**
+     * Days after the trigger that the offer becomes valid
+     */
+    trigger_days_valid_after: number | null;
+    /**
+     * Discount item number
+     */
+    discount_item_number: string | null;
+    /**
+     * Whether the offer is applied automatically (`1` or `0`)
+     */
+    auto_applied: number;
+    /**
+     * Discount item type
+     */
+    discount_item_type: string | null;
     /**
      * Maximum total discount this offer may give in a single transaction,
      * summed across all lines. `null` means no cap.
@@ -4533,24 +4834,42 @@ export type OfferData = {
      * amount. Not to be confused with `maxamount`, the largest basket total the
      * offer triggers on.
      */
-    max_discount_amount?: string | null;
+    max_discount_amount: string | null;
     /**
-     * Whether this is a redemption event
+     * Always `false`. Redemptions are sent as `offer.redeem`.
      */
-    redeem: boolean;
+    redeem: false;
     /**
-     * Whether this is a deletion event
+     * Always `false`. Deletions are sent as `offer.delete`.
      */
-    delete: boolean;
+    delete: false;
     /**
-     * Card data for redemption events
+     * Always `null`.
      */
-    card?: LoyaltyCardData;
+    card: null;
 };
 export type OfferDeleteResult = {
     result: number;
     errormessage: string;
 };
+/**
+ * Offer delete webhook data payload
+ */
+export type OfferDeleteWebhookData = {
+    /**
+     * The deleted offer
+     */
+    Offer: {
+        /**
+         * Offer ID
+         */
+        offer_id: number;
+        /**
+         * Company loyalty chain the offer belonged to
+         */
+        chain_code: number;
+    };
+};
 export type OfferDetailAmount = {
     type: string;
     value: number;
@@ -4772,6 +5091,102 @@ export type OfferRedemption = {
      */
     redeemed_tax?: ApiNumeric;
 };
+/**
+ * One redemption of an offer at the POS. This is the redemption itself,
+ * not the offer record: subscribe to `offer.create`/`offer.update` for the
+ * offer's settings, and `loyalty.card` for cardholder details.
+ */
+export type OfferRedemptionData = {
+    /**
+     * Offer ID
+     */
+    offer_id: number;
+    /**
+     * Offer reference
+     */
+    offer_ref: string;
+    /**
+     * Offer description
+     */
+    description: string;
+    /**
+     * Loyalty card used, or `null` when no card was presented
+     */
+    card: string | null;
+    /**
+     * Whether this was a loyalty redemption
+     */
+    is_loyalty: boolean;
+    /**
+     * Company loyalty chain the offer belongs to. This is the chain the
+     * webhook destination is configured on, and the same value as the
+     * envelope's `chain`.
+     */
+    chain_code: number;
+    /**
+     * Company (chain) code where the redemption took place
+     */
+    trading_chain_code: number;
+    /**
+     * Site ID
+     */
+    site: number;
+    /**
+     * Location ID
+     */
+    location: number;
+    /**
+     * Terminal number
+     */
+    terminal: number;
+    /**
+     * Journal number of the transaction
+     */
+    journal: number;
+    /**
+     * Sequence number of the redemption line
+     */
+    sequence: number;
+    /**
+     * Transaction date (YYYY-MM-DD)
+     */
+    transaction_date: string;
+    /**
+     * Transaction time of day (HH:MM:SS)
+     */
+    transaction_time: string;
+    /**
+     * Operator number
+     */
+    operator: number;
+    /**
+     * Operator name
+     */
+    operator_name: string;
+    /**
+     * Value of the redemption line. Negative for a discount.
+     */
+    amount: number;
+    /**
+     * Tax on the redemption line
+     */
+    tax: number;
+    /**
+     * The offer's configured points value, NOT the points awarded on this
+     * redemption. A non-loyalty redemption (`is_loyalty: false`) awards no
+     * points even when this is non-zero.
+     */
+    points: number;
+};
+/**
+ * Offer redemption webhook data payload
+ */
+export type OfferRedemptionWebhookData = {
+    /**
+     * The redemption
+     */
+    Redemption: OfferRedemptionData;
+};
 /**
  * Response for offer redemptions list endpoint
  */
@@ -4855,7 +5270,7 @@ export type OfferUpdateRequest = {
     effect?: OfferEffect;
 };
 /**
- * Offer webhook data payload
+ * Offer create/update webhook data payload
  */
 export type OfferWebhookData = {
     /**
@@ -5581,6 +5996,23 @@ export type PingV2PingResult = {
      */
     chaincode: number;
 };
+/**
+ * Test delivery sent when a destination is tested from Zen.
+ */
+export type PingWebhookData = {
+    /**
+     * Always `zen.ping`
+     */
+    event: 'zen.ping';
+    /**
+     * Name of the destination being tested
+     */
+    destination: string;
+    /**
+     * When the test was sent (RFC 3339)
+     */
+    sent_at: string;
+};
 export type PluGroup = {
     /**
      * PLU Group Id (match with PLUGroupNo)
@@ -6683,29 +7115,30 @@ export type TransactionCustomer = {
     purchaseorder?: string;
 };
 /**
- * Transaction data structure
+ * 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: string;
+    Company: number;
     /**
-     * Site code
+     * Site ID
      */
-    Site: string;
+    Site: number;
     /**
-     * Location code
+     * Location ID
      */
-    Location: string;
+    Location: number;
     /**
      * Terminal number
      */
-    Terminal: string;
+    Terminal: number;
     /**
      * Journal number
      */
-    Journal: string;
+    Journal: number;
     /**
      * Invoice journal number
      */
@@ -6715,21 +7148,21 @@ export type TransactionData = {
      */
     CreditJournal?: string;
     /**
-     * Transaction date and time
+     * Transaction date and time (YYYY-MM-DD HH:MM:SS)
      */
     DateTime: string;
     /**
-     * Trading date
+     * Trading date (YYYY-MM-DD)
      */
     TradingDate: string;
     /**
-     * Whether this is a training transaction
+     * Always `false`
      */
-    isTraining: boolean;
+    isTraining: false;
     /**
      * Operator number
      */
-    OperatorNumber: string;
+    OperatorNumber: number;
     /**
      * Operator name
      */
@@ -6741,19 +7174,19 @@ export type TransactionData = {
     /**
      * Cash drawer number
      */
-    Cashdrawer: string;
+    Cashdrawer: number;
     /**
-     * Email receipt address
+     * Always an empty string
      */
-    EmailReceipt?: string;
+    EmailReceipt: '';
     /**
      * Customer email
      */
-    CustomerEmail?: string;
+    CustomerEmail: string;
     /**
      * Customer postcode
      */
-    Postcode?: string;
+    Postcode: string;
     /**
      * Customer name
      */
@@ -6767,23 +7200,23 @@ export type TransactionData = {
      */
     CustomerPhone?: string;
     /**
-     * Loyalty information
+     * Loyalty information, when a card was used
      */
     Loyalty?: WebhookTransactionLoyalty;
     /**
-     * Sales items
+     * Sales lines
      */
     Sales?: Array<TransactionItem>;
     /**
-     * Tender information
+     * Tenders. Change given is a separate line with a negative amount.
      */
     Tender?: Array<TransactionTender>;
     /**
-     * Sales discount
+     * Whole-of-sale discount
      */
     SalesDiscount?: TransactionDiscount;
     /**
-     * Rounding amount
+     * Rounding
      */
     Rounding?: TransactionRounding;
 };
@@ -6813,11 +7246,16 @@ export type TransactionEventResponse = {
     [key: string]: unknown;
 };
 /**
- * Transaction item
+ * 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 = {
     /**
-     * Item transaction date and time
+     * Line date and time (YYYY-MM-DD HH:MM:SS)
      */
     DateTime: string;
     /**
@@ -6837,15 +7275,15 @@ export type TransactionItem = {
      */
     PriceLevel: number;
     /**
-     * Item price
+     * Unit price
      */
     Price: number;
     /**
-     * Original price before discounts
+     * Original price before discounts. `0` when not discounted.
      */
-    OriginalPrice?: number;
+    OriginalPrice: number;
     /**
-     * Item cost
+     * Unit cost
      */
     Cost: number;
     /**
@@ -6853,11 +7291,11 @@ export type TransactionItem = {
      */
     Quantity: number;
     /**
-     * Line total amount
+     * Line total
      */
     LineTotal: number;
     /**
-     * Line tax amount
+     * Line tax
      */
     LineTAX: number;
     /**
@@ -6871,9 +7309,9 @@ export type TransactionItem = {
     /**
      * Department name
      */
-    DepartmentName?: string;
+    DepartmentName: string;
     /**
-     * Whether item is on special
+     * Whether the item is on special
      */
     Special: boolean;
     /**
@@ -6885,21 +7323,21 @@ export type TransactionItem = {
      */
     Bonus?: number;
     /**
-     * Whether item was scanned
+     * Whether the item was scanned
      */
     Scanned: boolean;
     /**
-     * Scan terminal number
+     * Scan terminal number. `0` when not scanned.
      */
-    ScanTerminal?: number;
+    ScanTerminal: number;
     /**
-     * Brand code
+     * Brand code. Empty string when the item has no brand.
      */
-    Brand?: string;
+    Brand: string;
     /**
-     * Brand name
+     * Brand name. Empty string when the item has no brand.
      */
-    BrandName?: string;
+    BrandName: string;
     /**
      * Sub-department code
      */
@@ -7159,7 +7597,7 @@ export type TransactionTender = {
     /**
      * Tender type number
      */
-    Number: string;
+    Number: number;
     /**
      * Tender name
      */
@@ -8807,37 +9245,40 @@ export type WebhookEventType = 'loyalty.card' | 'loyalty.points' | 'customer.ups
  * Outbound Webhook Models
  *
  * Zen sends webhooks to external systems when various events occur.
- * All webhooks are sent as HTTP POST requests with JSON payloads.Base webhook payload structure
+ * All webhooks are sent as HTTP POST requests with JSON payloads.
+ *
+ * These models describe the bodies exactly as Zen renders them. Each one is
+ * checked against a golden fixture in
+ * `apps/zen/db/dbtend/comms/fixtures/webhook-parity/` (the
+ * `*.expected.json` files). When a template changes, update the matching
+ * model here.
+ *
+ * Several payloads keep legacy quirks (mixed key casing, numbers sent as
+ * strings, the `shopfiy` key). They are part of the wire contract and are
+ * documented as sent, not as they should be.The envelope every webhook body is wrapped in. The event's own fields are
+ * in `data`.
  */
 export type WebhookPayload = {
     /**
-     * Webhook function/event type
-     */
-    function: string;
-    /**
-     * Authentication key for webhook verification
+     * Shared key. Only filled in when the destination is configured to send
+     * its credential in the body; otherwise an empty string. Verify deliveries
+     * with the `X-Zen-Signature` header instead.
      */
     key: string;
     /**
-     * Company/chain code
-     */
-    chain: string;
-    /**
-     * Whether HTML trace is enabled
-     */
-    traceHtml: boolean;
-    /**
-     * Whether trace logging is enabled
+     * The legacy function name for this event. Several events share a value
+     * (for example `create` is sent for customer, loyalty and offer events),
+     * so use the `X-Zen-Topic` header to tell events apart.
      */
-    trace: boolean;
+    function: string;
     /**
-     * Target webhook URL
+     * Company (chain) code the destination is configured on.
      */
-    url: string;
+    chain: number;
     /**
-     * Whether data is sent via POST body
+     * Always `true`.
      */
-    viaBody: boolean;
+    viaBody: true;
 };
 /**
  * 200 — a newly generated signing key.
@@ -8860,29 +9301,29 @@ export type WebhookTransactionLoyalty = {
      */
     Card: string;
     /**
-     * Opening points balance
+     * Always an empty string
      */
-    OpeningPoints?: string;
+    OpeningPoints: '';
     /**
-     * Card holder name
+     * Card holder name, as `Last,First`
      */
     Name: string;
     /**
      * First name
      */
-    FirstName?: string;
+    FirstName: string;
     /**
      * Last name
      */
-    LastName?: string;
+    LastName: string;
     /**
-     * Points from rounding
+     * Round points flag
      */
-    RoundPoints?: string;
+    RoundPoints: boolean;
     /**
-     * Card type
+     * Card type ID
      */
-    CardType: string;
+    CardType: number;
 };
 /**
  * A field-level validation failure.
@@ -8905,6 +9346,37 @@ export type ZenNotFoundError = {
     errormessage: 'Not Found';
     issue?: string;
 };
+/**
+ * HMAC-SHA256 signature of the raw body, keyed with the destination's
+ * signing key: `t=<unix seconds>,v1=<hex hmac_sha256(key, "<t>.<raw body>")>`.
+ * See *Verifying a delivery* under Webhook Destinations.
+ *
+ */
+export type XZenSignature = string;
+/**
+ * The event type, for example `offer.redeem`. Use this, not the body's `function`, to tell events apart.
+ */
+export type XZenTopic = string;
+/**
+ * Identifies the event. The same on every retry, so deduplicate on it.
+ */
+export type XZenEventId = string;
+/**
+ * Identifies this delivery attempt, as `<event id>.<attempt>`. Different on every retry.
+ */
+export type XZenDeliveryId = string;
+/**
+ * Name of the webhook destination this was delivered to.
+ */
+export type XZenDestination = string;
+/**
+ * RFC 3339 time the event occurred. Does not change between retries.
+ */
+export type XZenTriggeredAt = string;
+/**
+ * Revision of that template the body was rendered from.
+ */
+export type XZenTemplateVersion = string;
 export type SmsSendSmsData = {
     body: SmsSendRequestBody;
     path?: never;
@@ -12693,75 +13165,113 @@ export type PingV2ShowResponses = {
     200: PingV2PingResult;
 };
 export type PingV2ShowResponse = PingV2ShowResponses[keyof PingV2ShowResponses];
-export type WebhookLoyaltyWebhookPayload = WebhookPayload & {
+export type WebhookLoyaltyCardWebhookPayload = WebhookPayload & {
+    function?: 'card' | 'create' | 'update';
+    data: LoyaltyWebhookData;
+};
+export type WebhookLoyaltyCardWebhookRequest = {
+    body: WebhookLoyaltyCardWebhookPayload;
+    key: 'loyalty.card';
+    path?: never;
+    query?: never;
+};
+export type WebhookLoyaltyPointsWebhookPayload = WebhookPayload & {
+    function?: 'points';
     data: LoyaltyWebhookData;
 };
-export type WebhookLoyaltyWebhookRequest = {
-    body: WebhookLoyaltyWebhookPayload;
-    key: 'loyalty';
+export type WebhookLoyaltyPointsWebhookRequest = {
+    body: WebhookLoyaltyPointsWebhookPayload;
+    key: 'loyalty.points';
     path?: never;
     query?: never;
 };
-export type WebhookCustomerWebhookPayload = WebhookPayload & {
+export type WebhookCustomerUpsertWebhookPayload = WebhookPayload & {
+    function?: 'customer' | 'create' | 'update';
     data: CustomerWebhookData;
 };
-export type WebhookCustomerWebhookRequest = {
-    body: WebhookCustomerWebhookPayload;
-    key: 'customer';
+export type WebhookCustomerUpsertWebhookRequest = {
+    body: WebhookCustomerUpsertWebhookPayload;
+    key: 'customer.upsert';
     path?: never;
     query?: never;
 };
-export type WebhookOfferWebhookPayload = WebhookPayload & {
+export type WebhookOfferCreateWebhookPayload = WebhookPayload & {
+    function?: 'create';
     data: OfferWebhookData;
 };
-export type WebhookOfferWebhookRequest = {
-    body: WebhookOfferWebhookPayload;
-    key: 'offer';
+export type WebhookOfferCreateWebhookRequest = {
+    body: WebhookOfferCreateWebhookPayload;
+    key: 'offer.create';
     path?: never;
     query?: never;
 };
-export type WebhookRedeemWebhookPayload = WebhookPayload & {
+export type WebhookOfferUpdateWebhookPayload = WebhookPayload & {
+    function?: 'update';
     data: OfferWebhookData;
 };
-export type WebhookRedeemWebhookRequest = {
-    body: WebhookRedeemWebhookPayload;
-    key: 'redeem';
+export type WebhookOfferUpdateWebhookRequest = {
+    body: WebhookOfferUpdateWebhookPayload;
+    key: 'offer.update';
     path?: never;
     query?: never;
 };
-export type WebhookDeleteWebhookPayload = WebhookPayload & {
-    data: OfferWebhookData;
+export type WebhookOfferRedeemWebhookPayload = WebhookPayload & {
+    function?: 'redeem';
+    data: OfferRedemptionWebhookData;
+};
+export type WebhookOfferRedeemWebhookRequest = {
+    body: WebhookOfferRedeemWebhookPayload;
+    key: 'offer.redeem';
+    path?: never;
+    query?: never;
 };
-export type WebhookDeleteWebhookRequest = {
-    body: WebhookDeleteWebhookPayload;
-    key: 'delete';
+export type WebhookOfferDeleteWebhookPayload = WebhookPayload & {
+    function?: 'delete';
+    data: OfferDeleteWebhookData;
+};
+export type WebhookOfferDeleteWebhookRequest = {
+    body: WebhookOfferDeleteWebhookPayload;
+    key: 'offer.delete';
     path?: never;
     query?: never;
 };
-export type WebhookItemWebhookPayload = WebhookPayload & {
-    data: InventoryWebhookData;
+export type WebhookItemSohWebhookPayload = WebhookPayload & {
+    function?: 'item';
+    data: InventorySohWebhookData;
 };
-export type WebhookItemWebhookRequest = {
-    body: WebhookItemWebhookPayload;
-    key: 'item';
+export type WebhookItemSohWebhookRequest = {
+    body: WebhookItemSohWebhookPayload;
+    key: 'item.soh';
     path?: never;
     query?: never;
 };
-export type WebhookPriceWebhookPayload = WebhookPayload & {
-    data: InventoryWebhookData;
+export type WebhookItemPriceWebhookPayload = WebhookPayload & {
+    function?: 'price';
+    data: InventoryPriceWebhookData;
 };
-export type WebhookPriceWebhookRequest = {
-    body: WebhookPriceWebhookPayload;
-    key: 'price';
+export type WebhookItemPriceWebhookRequest = {
+    body: WebhookItemPriceWebhookPayload;
+    key: 'item.price';
     path?: never;
     query?: never;
 };
-export type WebhookTransactionWebhookPayload = WebhookPayload & {
+export type WebhookTransactionCompleteWebhookPayload = WebhookPayload & {
+    function?: 'transaction';
     data: TransactionWebhookData;
 };
-export type WebhookTransactionWebhookRequest = {
-    body: WebhookTransactionWebhookPayload;
-    key: 'transaction';
+export type WebhookTransactionCompleteWebhookRequest = {
+    body: WebhookTransactionCompleteWebhookPayload;
+    key: 'transaction.complete';
+    path?: never;
+    query?: never;
+};
+export type WebhookPingWebhookPayload = WebhookPayload & {
+    function?: 'ping';
+    data: PingWebhookData;
+};
+export type WebhookPingWebhookRequest = {
+    body: WebhookPingWebhookPayload;
+    key: 'ping';
     path?: never;
     query?: never;
 };