@zenglobal/api-client 5.1.14 → 5.1.16

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`.
+     */
+    DeltaQuantity?: number;
+    /**
+     * Stock on hand before the change
+     */
+    PreviousSOH?: number;
+    /**
+     * Stock on hand after the change
+     */
+    CurrentSOH?: number;
+    /**
+     * Referral item code
      */
-    sitecode?: string;
+    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 title
+     * Offer description
      */
-    title?: string;
+    description: string | null;
     /**
-     * Offer description
+     * Date the offer becomes active (YYYY-MM-DD)
      */
-    description?: string;
+    dateactive: string | null;
+    /**
+     * Date the offer expires (YYYY-MM-DD)
+     */
+    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;
+    /**
+     * 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;
     /**
-     * Whether offer is loyalty-only
+     * 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 | null;
+    /**
+     * Event ID
+     */
+    eventid: number | null;
+    /**
+     * What the offer applies to
+     */
+    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
      */
-    changedate: string;
+    promo_group_id: number | null;
     /**
-     * Date offer becomes active
+     * Item the offer applies to, or `null`
      */
-    dateactive: string;
+    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;
     /**
-     * Date offer expires
+     * Discount item type
      */
-    dateexpire: string;
+    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)
@@ -6537,401 +6969,162 @@ export type TransactionCreateItem = {
 /**
  * Transaction creation request - wrapper object
  */
-export type TransactionCreateRequest = {
-    /**
-     * Transaction data
-     */
-    transaction: TransactionCreateData;
-};
-/**
- * Transaction creation response (union of success and error)
- */
-export type TransactionCreateResponse = TransactionCreateSuccessResponse | TransactionCreateErrorResponse;
-/**
- * Successful transaction creation response
- */
-export type TransactionCreateSuccessResponse = {
-    /**
-     * Result code (0 = success)
-     */
-    result: 0;
-    /**
-     * Result message
-     */
-    errormessage: 'OK';
-    /**
-     * Processing comment
-     */
-    comment: string;
-};
-/**
- * Transaction tender structure for creation requests
- */
-export type TransactionCreateTender = {
-    /**
-     * Tender type code
-     */
-    tendertype: string;
-    /**
-     * Tender description
-     */
-    description: string;
-    /**
-     * Tender amount
-     */
-    amount: string;
-    /**
-     * Shift number
-     */
-    shiftnumber?: string;
-    /**
-     * Obfuscated credit card number
-     */
-    creditcard?: string;
-    /**
-     * Card holder's name
-     */
-    cardname?: string;
-    /**
-     * Payment authorization platform
-     */
-    authorisation?: string;
-    /**
-     * Card expiry date (MM/YY)
-     */
-    expirydate?: string;
-    /**
-     * Voucher serial number (for voucher redemption)
-     */
-    voucher?: string;
-    /**
-     * Voucher type (for voucher redemption)
-     */
-    type?: string;
-    /**
-     * EFT surcharge amount (ex. tax)
-     */
-    surcharge?: ApiNumeric;
-    /**
-     * EFT surcharge tax
-     */
-    surchargetax?: ApiNumeric;
-    /**
-     * Tips amount
-     */
-    tips?: ApiNumeric;
-    /**
-     * Tips tax
-     */
-    tipstax?: ApiNumeric;
-    /**
-     * Retrieval reference number of the card payment, 1-32 alphanumeric characters. Stored trimmed and upper-cased; an invalid value is dropped without rejecting the transaction. The XML transaction API takes the same value as <Rrn> on <Tender>.
-     */
-    rrn?: string;
-};
-/**
- * Transaction customer information for creation requests
- */
-export type TransactionCustomer = {
-    /**
-     * Customer card number
-     */
-    cardnumber?: string;
-    /**
-     * Customer first name
-     */
-    firstname: string;
-    /**
-     * Customer last name
-     */
-    lastname: string;
-    /**
-     * Card type
-     */
-    cardtype?: string;
-    /**
-     * Number of loyalty points being redeemed
-     */
-    redeempoints?: string;
-    /**
-     * Dollar value of points being redeemed (inc. tax)
-     */
-    redeemamount?: string;
-    /**
-     * Debtor account number
-     */
-    account?: string;
-    /**
-     * Amount to charge to debtor account
-     */
-    charge?: string;
-    /**
-     * Amount being paid on debtor account
-     */
-    payment?: string;
-    /**
-     * Tender number for the debtor charge
-     */
-    tendernumber?: string;
-    /**
-     * Department for charge attribution
-     */
-    department?: number;
-    /**
-     * Purchase order reference
-     */
-    purchaseorder?: string;
-};
-/**
- * Transaction data structure
- */
-export type TransactionData = {
-    /**
-     * Company/chain code
-     */
-    Company: string;
-    /**
-     * Site code
-     */
-    Site: string;
-    /**
-     * Location code
-     */
-    Location: string;
-    /**
-     * Terminal number
-     */
-    Terminal: string;
-    /**
-     * Journal number
-     */
-    Journal: string;
-    /**
-     * Invoice journal number
-     */
-    InvoiceJournal?: string;
-    /**
-     * Credit note journal number
-     */
-    CreditJournal?: string;
-    /**
-     * Transaction date and time
-     */
-    DateTime: string;
-    /**
-     * Trading date
-     */
-    TradingDate: string;
-    /**
-     * Whether this is a training transaction
-     */
-    isTraining: boolean;
-    /**
-     * Operator number
-     */
-    OperatorNumber: string;
-    /**
-     * Operator name
-     */
-    OperatorName: string;
-    /**
-     * Operator login
-     */
-    OperatorLogin: string;
-    /**
-     * Cash drawer number
-     */
-    Cashdrawer: string;
-    /**
-     * Email receipt address
-     */
-    EmailReceipt?: string;
-    /**
-     * Customer email
-     */
-    CustomerEmail?: string;
-    /**
-     * Customer postcode
-     */
-    Postcode?: string;
-    /**
-     * Customer name
-     */
-    CustomerName?: string;
-    /**
-     * Customer address
-     */
-    CustomerAddress?: string;
-    /**
-     * Customer phone
-     */
-    CustomerPhone?: string;
-    /**
-     * Loyalty information
-     */
-    Loyalty?: WebhookTransactionLoyalty;
-    /**
-     * Sales items
-     */
-    Sales?: Array<TransactionItem>;
-    /**
-     * Tender information
-     */
-    Tender?: Array<TransactionTender>;
-    /**
-     * Sales discount
-     */
-    SalesDiscount?: TransactionDiscount;
-    /**
-     * Rounding amount
-     */
-    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).
- *
- * When `?format=event` is specified, the response is a JMS-serialized JournalCreatedEvent
- * object returned directly via `json_encode()`, without `result`/`errormessage` wrapper fields.
- * The exact structure depends on the JournalCreatedEvent serialization and includes
- * fields such as company, site, location, terminal, journal details, sale items,
- * tenders, discounts, loyalty information, and offers.
- */
-export type TransactionEventResponse = {
-    [key: string]: unknown;
+export type TransactionCreateRequest = {
+    /**
+     * Transaction data
+     */
+    transaction: TransactionCreateData;
 };
 /**
- * Transaction item
+ * Transaction creation response (union of success and error)
+ */
+export type TransactionCreateResponse = TransactionCreateSuccessResponse | TransactionCreateErrorResponse;
+/**
+ * Successful transaction creation response
  */
-export type TransactionItem = {
+export type TransactionCreateSuccessResponse = {
     /**
-     * Item transaction date and time
+     * Result code (0 = success)
      */
-    DateTime: string;
+    result: 0;
     /**
-     * Item code
+     * Result message
      */
-    Item: string;
+    errormessage: 'OK';
     /**
-     * Item barcode
+     * Processing comment
      */
-    Barcode: string;
+    comment: string;
+};
+/**
+ * Transaction tender structure for creation requests
+ */
+export type TransactionCreateTender = {
     /**
-     * Item description
+     * Tender type code
      */
-    Description: string;
+    tendertype: string;
     /**
-     * Price level
+     * Tender description
      */
-    PriceLevel: number;
+    description: string;
     /**
-     * Item price
+     * Tender amount
      */
-    Price: number;
+    amount: string;
     /**
-     * Original price before discounts
+     * Shift number
      */
-    OriginalPrice?: number;
+    shiftnumber?: string;
     /**
-     * Item cost
+     * Obfuscated credit card number
      */
-    Cost: number;
+    creditcard?: string;
     /**
-     * Quantity sold
+     * Card holder's name
      */
-    Quantity: number;
+    cardname?: string;
     /**
-     * Line total amount
+     * Payment authorization platform
      */
-    LineTotal: number;
+    authorisation?: string;
     /**
-     * Line tax amount
+     * Card expiry date (MM/YY)
      */
-    LineTAX: number;
+    expirydate?: string;
     /**
-     * Discount amount
+     * Voucher serial number (for voucher redemption)
      */
-    Discount: number;
+    voucher?: string;
     /**
-     * Department code
+     * Voucher type (for voucher redemption)
+     */
+    type?: string;
+    /**
+     * EFT surcharge amount (ex. tax)
      */
-    Department: number;
+    surcharge?: ApiNumeric;
     /**
-     * Department name
+     * EFT surcharge tax
      */
-    DepartmentName?: string;
+    surchargetax?: ApiNumeric;
     /**
-     * Whether item is on special
+     * Tips amount
      */
-    Special: boolean;
+    tips?: ApiNumeric;
     /**
-     * Loyalty points earned
+     * Tips tax
      */
-    Points?: number;
+    tipstax?: ApiNumeric;
     /**
-     * Bonus points earned
+     * Retrieval reference number of the card payment, 1-32 alphanumeric characters. Stored trimmed and upper-cased; an invalid value is dropped without rejecting the transaction. The XML transaction API takes the same value as <Rrn> on <Tender>.
      */
-    Bonus?: number;
+    rrn?: string;
+};
+/**
+ * Transaction customer information for creation requests
+ */
+export type TransactionCustomer = {
     /**
-     * Whether item was scanned
+     * Customer card number
      */
-    Scanned: boolean;
+    cardnumber?: string;
     /**
-     * Scan terminal number
+     * Customer first name
      */
-    ScanTerminal?: number;
+    firstname: string;
     /**
-     * Brand code
+     * Customer last name
      */
-    Brand?: string;
+    lastname: string;
     /**
-     * Brand name
+     * Card type
      */
-    BrandName?: string;
+    cardtype?: string;
     /**
-     * Sub-department code
+     * Number of loyalty points being redeemed
      */
-    SubDepartment?: number;
+    redeempoints?: string;
     /**
-     * Sub-department name
+     * Dollar value of points being redeemed (inc. tax)
      */
-    SubDepartmentName?: string;
+    redeemamount?: string;
     /**
-     * Category code
+     * Debtor account number
      */
-    Category?: number;
+    account?: string;
     /**
-     * Category name
+     * Amount to charge to debtor account
      */
-    CategoryName?: string;
+    charge?: string;
     /**
-     * Sub-category code
+     * Amount being paid on debtor account
      */
-    SubCategory?: number;
+    payment?: string;
     /**
-     * Sub-category name
+     * Tender number for the debtor charge
      */
-    SubCategoryName?: string;
+    tendernumber?: string;
     /**
-     * Range code
+     * Department for charge attribution
      */
-    Range?: number;
+    department?: number;
     /**
-     * Range name
+     * Purchase order reference
      */
-    RangeName?: string;
+    purchaseorder?: string;
+};
+/**
+ * Event format transaction response (for format=event query parameter).
+ *
+ * When `?format=event` is specified, the response is a JMS-serialized JournalCreatedEvent
+ * object returned directly via `json_encode()`, without `result`/`errormessage` wrapper fields.
+ * The exact structure depends on the JournalCreatedEvent serialization and includes
+ * fields such as company, site, location, terminal, journal details, sale items,
+ * tenders, discounts, loyalty information, and offers.
+ */
+export type TransactionEventResponse = {
+    [key: string]: unknown;
 };
 /**
  * Transaction offer structure for creation requests
@@ -7107,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.
@@ -7152,23 +7336,6 @@ export type TransactionTableInfo = {
      */
     covers?: string;
 };
-/**
- * Transaction tender
- */
-export type TransactionTender = {
-    /**
-     * Tender type number
-     */
-    Number: string;
-    /**
-     * Tender name
-     */
-    Name: string;
-    /**
-     * Tender amount
-     */
-    Amount: number;
-};
 /**
  * Transaction tracking information
  */
@@ -7219,14 +7386,210 @@ 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;
+    entry_metadata: {
+        [key: string]: unknown;
+    } | Array<unknown>;
+};
 /**
- * Transaction webhook data payload
+ * 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 TransactionWebhookData = {
+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;
+    };
+    /**
+     * Empty when the sale earned or spent no points.
+     */
+    points_breakdown: TransactionWebhookV2Points | Array<unknown>;
+    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;
+};
+export type TransactionWebhookV2Points = {
+    base: number;
+    bonus: number;
+    jackpot: number;
+    expired: number;
+    redeemed: number;
+    total: number;
+};
+export type TransactionWebhookV2SaleItem = {
     /**
-     * Transaction data container
+     * BASKET row id.
      */
-    AMC_POSPortal: TransactionData;
+    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)
@@ -8807,37 +9170,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
+     * 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.
      */
-    traceHtml: boolean;
-    /**
-     * Whether trace logging is enabled
-     */
-    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.
@@ -8851,39 +9217,6 @@ export type WebhookSigningKeyResponse = {
      */
     signing_key: string;
 };
-/**
- * Transaction loyalty information
- */
-export type WebhookTransactionLoyalty = {
-    /**
-     * Loyalty card number
-     */
-    Card: string;
-    /**
-     * Opening points balance
-     */
-    OpeningPoints?: string;
-    /**
-     * Card holder name
-     */
-    Name: string;
-    /**
-     * First name
-     */
-    FirstName?: string;
-    /**
-     * Last name
-     */
-    LastName?: string;
-    /**
-     * Points from rounding
-     */
-    RoundPoints?: string;
-    /**
-     * Card type
-     */
-    CardType: string;
-};
 /**
  * A field-level validation failure.
  */
@@ -8905,6 +9238,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 +13057,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 WebhookOfferDeleteWebhookPayload = WebhookPayload & {
+    function?: 'delete';
+    data: OfferDeleteWebhookData;
+};
+export type WebhookOfferDeleteWebhookRequest = {
+    body: WebhookOfferDeleteWebhookPayload;
+    key: 'offer.delete';
+    path?: never;
+    query?: never;
+};
+export type WebhookItemSohWebhookPayload = WebhookPayload & {
+    function?: 'item';
+    data: InventorySohWebhookData;
 };
-export type WebhookDeleteWebhookRequest = {
-    body: WebhookDeleteWebhookPayload;
-    key: 'delete';
+export type WebhookItemSohWebhookRequest = {
+    body: WebhookItemSohWebhookPayload;
+    key: 'item.soh';
     path?: never;
     query?: never;
 };
-export type WebhookItemWebhookPayload = WebhookPayload & {
-    data: InventoryWebhookData;
+export type WebhookItemPriceWebhookPayload = WebhookPayload & {
+    function?: 'price';
+    data: InventoryPriceWebhookData;
 };
-export type WebhookItemWebhookRequest = {
-    body: WebhookItemWebhookPayload;
-    key: 'item';
+export type WebhookItemPriceWebhookRequest = {
+    body: WebhookItemPriceWebhookPayload;
+    key: 'item.price';
     path?: never;
     query?: never;
 };
-export type WebhookPriceWebhookPayload = WebhookPayload & {
-    data: InventoryWebhookData;
+export type WebhookTransactionCompleteWebhookPayload = WebhookPayload & {
+    function?: 'transaction';
+    data: TransactionWebhookV2Data;
 };
-export type WebhookPriceWebhookRequest = {
-    body: WebhookPriceWebhookPayload;
-    key: 'price';
+export type WebhookTransactionCompleteWebhookRequest = {
+    body: WebhookTransactionCompleteWebhookPayload;
+    key: 'transaction.complete';
     path?: never;
     query?: never;
 };
-export type WebhookTransactionWebhookPayload = WebhookPayload & {
-    data: TransactionWebhookData;
+export type WebhookPingWebhookPayload = WebhookPayload & {
+    function?: 'ping';
+    data: PingWebhookData;
 };
-export type WebhookTransactionWebhookRequest = {
-    body: WebhookTransactionWebhookPayload;
-    key: 'transaction';
+export type WebhookPingWebhookRequest = {
+    body: WebhookPingWebhookPayload;
+    key: 'ping';
     path?: never;
     query?: never;
 };