@zenglobal/api-client 5.0.2 → 5.0.4

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

@@ -1,6 +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;
 /**
  * Address structure used for billing and shipping addresses
  */
@@ -8,11 +9,11 @@ export type Address = {
     /**
      * Address line 1
      */
-    address1: string;
+    address1: string | null;
     /**
      * Address line 2
      */
-    address2: string;
+    address2: string | null;
     /**
      * Suburb/City
      */
@@ -20,15 +21,44 @@ export type Address = {
     /**
      * State/Province
      */
-    state: string;
+    state: string | null;
     /**
      * Postal/ZIP code
      */
-    postcode: string;
+    postcode: string | null;
     /**
      * Country
      */
-    country: string;
+    country: string | null;
+};
+/**
+ * Address data structure
+ */
+export type AddressData = {
+    /**
+     * Address line 1
+     */
+    address1?: string;
+    /**
+     * Address line 2
+     */
+    address2?: string;
+    /**
+     * Suburb
+     */
+    suburb?: string;
+    /**
+     * State
+     */
+    state?: string;
+    /**
+     * Postcode
+     */
+    postcode?: string;
+    /**
+     * Country
+     */
+    country?: string;
 };
 /**
  * Response for GET /lists.
@@ -731,7 +761,7 @@ export type CompulsoryFields = {
      * Additional compulsory settings
      */
     settings?: {
-        [key: string]: string;
+        [key: string]: unknown;
     };
 };
 /**
@@ -755,6 +785,76 @@ export type CreateCardResponse = {
      */
     cardimage?: string;
 };
+/**
+ * Customer data structure
+ */
+export type CustomerData = {
+    /**
+     * Company/chain code
+     */
+    Company: string;
+    /**
+     * Customer number
+     */
+    customer: string;
+    /**
+     * Customer name
+     */
+    name: string;
+    /**
+     * Email address
+     */
+    email?: string;
+    /**
+     * Mobile number
+     */
+    mobile?: string;
+    /**
+     * Phone number
+     */
+    phone?: string;
+    /**
+     * Secondary phone number
+     */
+    phone1?: string;
+    /**
+     * Gender
+     */
+    gender?: string;
+    /**
+     * Date of birth
+     */
+    dateofbirth?: string;
+    /**
+     * WooCommerce customer ID
+     */
+    woocommerce?: string;
+    /**
+     * Shopify customer ID
+     */
+    shopify?: string;
+    /**
+     * Billing address
+     */
+    billing: AddressData;
+    /**
+     * Shipping address
+     */
+    shipping: AddressData;
+    /**
+     * Associated loyalty cards
+     */
+    cards?: Array<LoyaltyCardSummary>;
+};
+/**
+ * Customer webhook data payload
+ */
+export type CustomerWebhookData = {
+    /**
+     * Customer information
+     */
+    customer: CustomerData;
+};
 /**
  * Database error (500)
  */
@@ -1069,6 +1169,55 @@ export type InventoryLoyaltyGroup = {
      */
     description: string;
 };
+/**
+ * Inventory webhook data payload
+ */
+export type InventoryWebhookData = {
+    /**
+     * Item code
+     */
+    Item: string;
+    /**
+     * Company/chain code
+     */
+    chain: string;
+    /**
+     * Company/chain code (duplicate)
+     */
+    Company: string;
+    /**
+     * Whether stock on hand has changed
+     */
+    sohFlag: boolean;
+    /**
+     * Whether price has changed
+     */
+    priceFlag: boolean;
+    /**
+     * Current stock on hand
+     */
+    stockOnHand?: number;
+    /**
+     * Item price
+     */
+    price?: number;
+    /**
+     * Item cost
+     */
+    cost?: number;
+    /**
+     * Item description
+     */
+    description?: string;
+    /**
+     * Department code
+     */
+    department?: number;
+    /**
+     * Site code
+     */
+    sitecode?: string;
+};
 /**
  * Active jackpot information
  */
@@ -1375,7 +1524,7 @@ export type LocationInfo = {
     /**
      * Location name
      */
-    description: string;
+    description: string | null;
     /**
      * Location type code (-1 if no type assigned)
      */
@@ -1480,7 +1629,7 @@ export type LoyaltyCard = {
     /**
      * User ID
      */
-    userid: string;
+    userid: string | null;
     /**
      * Username for login
      */
@@ -1493,6 +1642,10 @@ export type LoyaltyCard = {
      * Last name
      */
     lastname: string;
+    /**
+     * Full name as stored (surname, firstname)
+     */
+    customername: string;
     /**
      * Email address
      */
@@ -1500,15 +1653,87 @@ export type LoyaltyCard = {
     /**
      * Date of birth (Y-m-d format)
      */
-    dateofbirth: ApiDate;
+    dateofbirth: ApiDate | null;
     /**
      * Gender
      */
-    gender: string;
+    gender: string | null;
+    /**
+     * Chain code
+     */
+    chaincode: string;
+    /**
+     * Title
+     */
+    title: string | null;
+    /**
+     * Initials
+     */
+    initials: string | null;
+    /**
+     * Comments
+     */
+    comments: string | null;
+    /**
+     * Customer ID
+     */
+    customerid: string;
+    /**
+     * Referring customer number
+     */
+    refercustomer: string | null;
+    /**
+     * Name prefix
+     */
+    prefix: string | null;
+    /**
+     * Name suffix
+     */
+    suffix: string | null;
+    /**
+     * Authentication token
+     */
+    token: string;
+    /**
+     * Freight provider
+     */
+    freightprovider: string | null;
+    /**
+     * Shopify customer ID
+     */
+    shopify: string | null;
+    /**
+     * Shopify store ID
+     */
+    shopify_id: string | null;
+    /**
+     * Payment provider name
+     */
+    payment_provider: string | null;
+    /**
+     * Payment provider customer ID
+     */
+    payment_customer_id: string | null;
     /**
      * Phone numbers
      */
     phones: PhoneNumbers;
+    /**
+     * Mobile phone number
+     */
+    mobile: string;
+    /**
+     * Mobile in E.164 format
+     */
+    mobile_e164: string | null;
+    /**
+     * Home phone
+     */
+    phone1: string;
+    /**
+     * Work phone
+     */
+    phone2: string;
     /**
      * Billing address
      */
@@ -1517,6 +1742,10 @@ export type LoyaltyCard = {
      * Shipping address
      */
     shipping: Address;
+    /**
+     * Postcode (top-level)
+     */
+    postcode: string | null;
     /**
      * Date joined loyalty program
      */
@@ -1526,9 +1755,9 @@ export type LoyaltyCard = {
      */
     createdate: ApiDate;
     /**
-     * Card expiry date
+     * Card expiry date (empty string if no expiry)
      */
-    expirydate: ApiDate;
+    expirydate: string;
     /**
      * Last changed date
      */
@@ -1536,15 +1765,47 @@ export type LoyaltyCard = {
     /**
      * Date of last sale
      */
-    datelastsale: ApiDate;
+    datelastsale: ApiDate | null;
     /**
      * Welcome email sent date
      */
-    welcomeemaildate?: ApiDate;
+    welcomeemaildate: ApiDate | null;
+    /**
+     * Welcome SMS sent date
+     */
+    welcomesmsdate: ApiDate | null;
     /**
      * Last expiry notification date
      */
-    lastexpiry?: ApiDate;
+    lastexpiry: ApiDate | null;
+    /**
+     * Anniversary date
+     */
+    anniversary: ApiDate | null;
+    /**
+     * Next birthday date
+     */
+    nextbirthday: ApiDate | null;
+    /**
+     * Card anniversary date
+     */
+    cardanniversary: ApiDate | null;
+    /**
+     * Card next birthday date
+     */
+    cardnextbirthday: ApiDate | null;
+    /**
+     * Next visit prediction date
+     */
+    nextvisit: ApiDate | null;
+    /**
+     * Last visit date
+     */
+    lastvisit: ApiDate | null;
+    /**
+     * Last login date
+     */
+    lastlogin: ApiDate | null;
     /**
      * Total points earned
      */
@@ -1553,16 +1814,74 @@ export type LoyaltyCard = {
      * Total points redeemed
      */
     pointsredeemed: ApiNumeric;
+    /**
+     * Total points expired
+     */
+    pointsexpired: ApiNumeric;
+    /**
+     * Jackpot points
+     */
+    pointsjackpot: ApiNumeric;
     /**
      * Current points balance
      */
     pointsbalance: ApiNumeric;
+    /**
+     * Rolling balance
+     */
+    rollbalance: ApiNumeric;
+    /**
+     * Dollar to point ratio
+     */
+    dollarpointratio: ApiNumeric;
+    /**
+     * Redemption ratio
+     */
+    redemptionratio: ApiNumeric;
+    /**
+     * Total sales to date
+     */
+    salestodate: ApiNumeric;
+    /**
+     * Card stored value
+     */
+    cardvalue: ApiNumeric;
+    /**
+     * Amount of discount
+     */
+    amountofdiscount: ApiNumeric;
+    /**
+     * Type of discount
+     */
+    typeofdiscount: string | null;
+    /**
+     * Percentage discount
+     */
+    percentagediscount: ApiNumeric;
+    /**
+     * Number of visits
+     */
+    visits: ApiNumeric;
+    /**
+     * Average days between visits
+     */
+    averagedays: ApiNumeric;
+    /**
+     * Market ID
+     */
+    marketid: ApiNumeric;
+    /**
+     * Market chain code
+     */
+    marketchain: ApiNumeric;
+    /**
+     * Market name
+     */
+    market: string;
     /**
      * Card movement calculation result
      */
-    cardmovement?: {
-        [key: string]: string;
-    };
+    cardmovement?: LoyaltyCardMovement;
     /**
      * Opted in for mail marketing
      */
@@ -1612,120 +1931,89 @@ export type LoyaltyCard = {
      */
     purged: boolean;
     /**
-     * Member status code
+     * Staff member who created the card
      */
-    memberstatus: 'A' | 'C' | 'S';
+    staffmember: string;
     /**
-     * Member status description
+     * Occupation
      */
-    memberstatusdescription: 'Active' | 'Cancelled' | 'Suspended';
+    occupation: string;
     /**
-     * Home site code
+     * Favourite item or preference
      */
-    homesite: string;
+    favourite: string;
     /**
-     * Home site name
+     * Income bracket
      */
-    homesitename: string;
-    /**
-     * Custom soft fields
-     */
-    softfields: SoftFields;
+    income: string | null;
     /**
-     * Loyalty groups assigned to card
+     * Referral source
      */
-    groups?: Array<LoyaltyGroup>;
+    referralfrom: string;
     /**
-     * Purchase groups available to member
+     * External reference
      */
-    purchasegroups?: Array<PurchaseGroup>;
-    /**
-     * Available offers (when includeoffers requested)
-     */
-    offers?: Array<Offer>;
-    /**
-     * Recently redeemed offers (when includeoffers requested)
-     */
-    redeemed_offers?: Array<OfferRedemption>;
-    /**
-     * Transaction history (when requested)
-     */
-    transactions?: Array<LoyaltyTransaction>;
-    /**
-     * Digital wallet link URL
-     */
-    wallet: string;
-};
-/**
- * Compact loyalty card structure containing only essential fields
- */
-export type LoyaltyCardCompact = {
+    reference: string;
     /**
-     * Chain code
+     * App push notification token
      */
-    chaincode: string;
+    apptoken: string | null;
     /**
-     * Email address
-     */
-    email: string;
-    /**
-     * Date of birth (Y-m-d format or null)
+     * Delivery instructions
      */
-    dateofbirth: ApiDate | null;
+    deliveryinstructions: string | null;
     /**
-     * Mobile phone number
+     * Member status code. Null for non-members.
      */
-    mobile: string;
+    memberstatus: 'A' | 'C' | 'S' | null;
     /**
-     * Loyalty card number
+     * Member status description
      */
-    cardnumber: string;
+    memberstatusdescription: 'Active' | 'Cancelled' | 'Suspended' | 'Non Member';
     /**
-     * Card expiry date
+     * Home site code
      */
-    expirydate: string;
+    homesite: string;
     /**
-     * Current points balance
+     * Home site name
      */
-    pointsbalance: ApiNumeric;
+    homesitename: string;
     /**
-     * Card reported as lost
+     * Custom soft fields
      */
-    cardlost: boolean;
+    softfields: SoftFields;
     /**
-     * Not allowed to redeem points
+     * API version
      */
-    notallowredeem: boolean;
+    version: string;
     /**
-     * Card is active
+     * Loyalty system version
      */
-    cardactive: boolean;
+    loyaltyversion: string;
     /**
-     * Card has been purged
+     * Loyalty groups assigned to card
      */
-    purged: boolean;
+    groups?: Array<LoyaltyGroup>;
     /**
-     * First name
+     * Purchase groups available to member
      */
-    firstname: string;
+    purchasegroups?: Array<PurchaseGroup>;
     /**
-     * Last name
+     * Available offers (when includeoffers requested)
      */
-    lastname: string;
+    offers?: Array<Offer>;
     /**
-     * Card type identifier
+     * Recently redeemed offers (when includeoffers requested)
      */
-    cardtype: string;
+    redeemed_offers?: Array<OfferRedemption>;
     /**
-     * Home site code
+     * Transaction history (when requested)
      */
-    homesite: string;
-};
-export type LoyaltyCardCompactResponse = {
+    transactions?: Array<LoyaltyTransaction>;
     /**
-     * Compact loyalty card details
+     * Digital wallet link URL
      */
-    card: LoyaltyCardCompact;
+    wallet: string;
 };
 /**
  * Loyalty card creation request body.
@@ -1887,6 +2175,208 @@ export type LoyaltyCardCreateRequest = {
         deliveryinstructions?: string;
     };
 };
+/**
+ * Loyalty card data structure
+ */
+export type LoyaltyCardData = {
+    /**
+     * Company/chain code
+     */
+    Company: string;
+    /**
+     * Loyalty card number
+     */
+    Card: string;
+    /**
+     * Customer number
+     */
+    Customer: string;
+    /**
+     * Family card number (if linked)
+     */
+    FamilyCard: string;
+    /**
+     * Original card number before conversion
+     */
+    OriginalCard: string;
+    /**
+     * Card status
+     */
+    Status: string;
+    /**
+     * Customer salutation
+     */
+    Salutation?: string;
+    /**
+     * First name
+     */
+    First: string;
+    /**
+     * Last name
+     */
+    Last: string;
+    /**
+     * Card PIN
+     */
+    pin?: string;
+    /**
+     * Gender
+     */
+    Gender?: string;
+    /**
+     * Address line 1
+     */
+    Address1?: string;
+    /**
+     * Address line 2
+     */
+    Address2?: string;
+    /**
+     * Suburb
+     */
+    Suburb?: string;
+    /**
+     * State
+     */
+    State?: string;
+    /**
+     * Postcode
+     */
+    Postcode?: string;
+    /**
+     * Security token
+     */
+    Token?: string;
+    /**
+     * App token
+     */
+    AppToken?: string;
+    /**
+     * App operating system
+     */
+    AppSystem?: string;
+    /**
+     * Email address
+     */
+    Email?: string;
+    /**
+     * Phone number
+     */
+    Phone?: string;
+    /**
+     * Secondary phone number
+     */
+    Phone2?: string;
+    /**
+     * Mobile number
+     */
+    Mobile?: string;
+    /**
+     * Fax number
+     */
+    Fax?: string;
+    /**
+     * Occupation
+     */
+    Occupation?: string;
+    /**
+     * Date of birth
+     */
+    dateOfBirth?: string;
+    /**
+     * Card type ID
+     */
+    CARDTYPE: string;
+    /**
+     * Whether card follows default settings
+     */
+    FOLLOWCARD: 'T' | 'F';
+    /**
+     * Points earning ratio
+     */
+    PointsRatio: string;
+    /**
+     * Points redemption ratio
+     */
+    RedeemRatio: string;
+    /**
+     * Percentage discount
+     */
+    Discount: string;
+    /**
+     * Mail opt-in preference
+     */
+    mailOpt?: string;
+    /**
+     * Email opt-in preference
+     */
+    emailOpt?: string;
+    /**
+     * SMS opt-in preference
+     */
+    smsOpt?: string;
+    /**
+     * Whether card details are complete
+     */
+    CardComplete: string;
+    /**
+     * Whether card is active
+     */
+    CardActive: string;
+    /**
+     * Whether card is purged
+     */
+    Purged: string;
+    /**
+     * Current points balance
+     */
+    Points: string;
+    /**
+     * Home site ID
+     */
+    HomeSite: string;
+    /**
+     * Home site name
+     */
+    HomeSiteName: string;
+    /**
+     * Profile picture URL
+     */
+    Picture?: string;
+};
+/**
+ * Card movement/tier progression information
+ */
+export type LoyaltyCardMovement = {
+    /**
+     * Movement type description
+     */
+    type: string;
+    /**
+     * Whether card movement is enabled
+     */
+    enabled: boolean;
+    /**
+     * Date from which movement is calculated
+     */
+    datefrom: string;
+    /**
+     * Target card type for upgrade
+     */
+    bettercardtype: string;
+    /**
+     * Required value to trigger movement
+     */
+    requiredvalue: string;
+    /**
+     * Current progress value
+     */
+    currentvalue: string;
+    /**
+     * Remaining value needed to move
+     */
+    needtomove: string;
+};
 /**
  * GET /loyalty/card response — returned via prepareJson() without result/errormessage wrapper.
  * The version and loyaltyVersion fields are embedded inside the card object.
@@ -1897,6 +2387,47 @@ export type LoyaltyCardResponse = {
      */
     card: LoyaltyCard;
 };
+/**
+ * Loyalty card summary for customer webhook
+ */
+export type LoyaltyCardSummary = {
+    /**
+     * Card number
+     */
+    card: string;
+    /**
+     * Card holder name
+     */
+    name: string;
+    /**
+     * Join date
+     */
+    joindate: string;
+    /**
+     * Points earned to date
+     */
+    pointsearned: string;
+    /**
+     * Points redeemed to date
+     */
+    pointsredeemed: string;
+    /**
+     * Points expired to date
+     */
+    pointsexpired: string;
+    /**
+     * Current points balance
+     */
+    pointsbalance: string;
+    /**
+     * Total sales to date
+     */
+    salestodate: string;
+    /**
+     * Card type
+     */
+    cardtype: string;
+};
 /**
  * Loyalty card type information
  */
@@ -1913,7 +2444,7 @@ export type LoyaltyCardType = {
      * Card type settings
      */
     settings?: {
-        [key: string]: string;
+        [key: string]: unknown;
     };
 };
 /**
@@ -2282,6 +2813,20 @@ export type LoyaltyTransaction = {
      */
     bonus: ApiNumeric;
 };
+/**
+ * Loyalty webhook data payload
+ */
+export type LoyaltyWebhookData = {
+    /**
+     * Card data container
+     */
+    AMC_POSPortal: {
+        /**
+         * Loyalty card information
+         */
+        CardData: LoyaltyCardData;
+    };
+};
 /**
  * Address update request body for the PUT address sub-function.
  * The request body must be wrapped: `{"member": {...}}`
@@ -2956,6 +3501,55 @@ export type MemberGroupDetail = {
      */
     url?: string;
 };
+/**
+ * V2 member group with clean snake_case field names and proper types
+ */
+export type MemberGroupV2 = {
+    /**
+     * Unique group identifier (database primary key)
+     */
+    id: number;
+    /**
+     * Legacy group reference number (GROUPID)
+     */
+    group_id: number;
+    /**
+     * Group description
+     */
+    description: string;
+    /**
+     * Points multiplier
+     */
+    points_multiplier: number;
+    /**
+     * Bonus amount
+     */
+    bonus: number;
+    /**
+     * Pack price
+     */
+    pack_price: number;
+    /**
+     * Whether this is the default group
+     */
+    is_default: boolean;
+    /**
+     * Web type
+     */
+    web_type: string;
+    /**
+     * Group image URL
+     */
+    url: string;
+    /**
+     * Site control setting
+     */
+    site_control: 'disabled' | 'in_site_list' | 'not_in_site_list';
+    /**
+     * Site list for group control
+     */
+    site_list: Array<string>;
+};
 /**
  * Member groups GET response.
  * The version and loyaltyVersion fields are embedded as pseudo-elements inside the groups array.
@@ -3602,42 +4196,107 @@ export type OfferConditions = {
     /**
      * Set to have only apply to transactions over a minimum amount
      */
-    minimum_trigger_amount?: number;
+    minimum_trigger_amount?: number;
+    /**
+     * Set to have only apply to transactions below a maximum amount
+     */
+    maximum_trigger_amount?: number;
+    /**
+     * Limit the usage of a given offer
+     */
+    limits?: OfferLimits;
+};
+export type OfferCreateRequest = {
+    /**
+     * Name of the Offer
+     */
+    description: string;
+    /**
+     * Enable or Disable the offer
+     */
+    enabled: boolean;
+    /**
+     * A reference identifier for external systems
+     */
+    reference?: string;
+    /**
+     * Detailed description of the offer
+     */
+    comment?: string;
+    /**
+     * Describe the conditions under which the offer
+     * is valid.
+     */
+    conditions?: OfferConditions;
+    /**
+     * Describe how the offer is applied at Point of Sale
+     */
+    effect?: OfferEffect;
+};
+/**
+ * Offer data structure
+ */
+export type OfferData = {
+    /**
+     * Offer ID
+     */
+    offerid: string;
+    /**
+     * Company/chain code
+     */
+    chaincode: string;
+    /**
+     * Offer title
+     */
+    title?: string;
+    /**
+     * Offer description
+     */
+    description?: string;
+    /**
+     * Whether offer is loyalty-only
+     */
+    loyaltyonly: boolean;
+    /**
+     * Whether offer is linked to another offer
+     */
+    linkedto: boolean;
+    /**
+     * Whether this is a birthday offer
+     */
+    birthdayoffer: boolean;
     /**
-     * Set to have only apply to transactions below a maximum amount
+     * Whether card must be active
      */
-    maximum_trigger_amount?: number;
+    cardactive: boolean;
     /**
-     * Limit the usage of a given offer
+     * Whether card details must be complete
      */
-    limits?: OfferLimits;
-};
-export type OfferCreateRequest = {
+    cardcomplete: boolean;
     /**
-     * Name of the Offer
+     * Date offer was last changed
      */
-    description: string;
+    changedate: string;
     /**
-     * Enable or Disable the offer
+     * Date offer becomes active
      */
-    enabled: boolean;
+    dateactive: string;
     /**
-     * A reference identifier for external systems
+     * Date offer expires
      */
-    reference?: string;
+    dateexpire: string;
     /**
-     * Detailed description of the offer
+     * Whether this is a redemption event
      */
-    comment?: string;
+    redeem: boolean;
     /**
-     * Describe the conditions under which the offer
-     * is valid.
+     * Whether this is a deletion event
      */
-    conditions?: OfferConditions;
+    delete: boolean;
     /**
-     * Describe how the offer is applied at Point of Sale
+     * Card data for redemption events
      */
-    effect?: OfferEffect;
+    card?: LoyaltyCardData;
 };
 export type OfferDeleteResult = {
     result: number;
@@ -3909,6 +4568,15 @@ export type OfferUpdateRequest = {
      */
     effect?: OfferEffect;
 };
+/**
+ * Offer webhook data payload
+ */
+export type OfferWebhookData = {
+    /**
+     * Offer information
+     */
+    Offer: OfferData;
+};
 /**
  * Order detail structure as returned by GET /order/{orderNumber}/{site}.
  * The response is nested under an `order` key.
@@ -4957,23 +5625,23 @@ export type SiteInfo = {
     /**
      * Billing city
      */
-    billcity: string;
+    billcity: string | null;
     /**
      * Contact person
      */
-    contact: string;
+    contact: string | null;
     /**
      * Site manager
      */
-    manager: string;
+    manager: string | null;
     /**
      * Site email address
      */
-    email: string;
+    email: string | null;
     /**
      * Australian Company Number
      */
-    acn: string;
+    acn: string | null;
     /**
      * Whether the site is active
      */
@@ -4981,75 +5649,75 @@ export type SiteInfo = {
     /**
      * Site currency code
      */
-    currency: string;
+    currency: string | null;
     /**
      * GPS latitude
      */
-    latitude: ApiNumeric;
+    latitude: ApiNumeric | null;
     /**
      * GPS longitude (note: legacy spelling preserved)
      */
-    longtitude: ApiNumeric;
+    longtitude: ApiNumeric | null;
     /**
      * Site timezone
      */
-    timezone: string;
+    timezone: string | null;
     /**
      * Region code
      */
-    region: ApiNumeric;
+    region: ApiNumeric | null;
     /**
      * Region reference ID
      */
-    region_id: ApiNumeric;
+    region_id: ApiNumeric | null;
     /**
      * District code
      */
-    district: ApiNumeric;
+    district: ApiNumeric | null;
     /**
      * District reference ID
      */
-    district_id: ApiNumeric;
+    district_id: ApiNumeric | null;
     /**
      * External store identifier
      */
-    store_id: string;
+    store_id: string | null;
     /**
      * Shopify store identifier
      */
-    shopify_id: string;
+    shopify_id: string | null;
     /**
      * Salesforce account identifier
      */
-    salesforce_account_id: string;
+    salesforce_account_id: string | null;
     /**
      * Customer reference identifier
      */
-    customer_reference_id: string;
+    customer_reference_id: string | null;
     /**
      * POS provider reference ID
      */
-    point_of_sale_provider_id: ApiNumeric;
+    point_of_sale_provider_id: ApiNumeric | null;
     /**
      * POS reseller reference ID
      */
-    point_of_sale_reseller_id: ApiNumeric;
+    point_of_sale_reseller_id: ApiNumeric | null;
     /**
      * Whether POS support is enabled
      */
-    point_of_sale_support: boolean;
+    point_of_sale_support: boolean | null;
     /**
      * Web store reference ID
      */
-    web_store_id: ApiNumeric;
+    web_store_id: ApiNumeric | null;
     /**
      * Salesforce sync status
      */
-    salesforce_sync_status: string;
+    salesforce_sync_status: string | null;
     /**
      * Salesforce sync last updated
      */
-    salesforce_sync_updated_at: string;
+    salesforce_sync_updated_at: string | null;
     /**
      * Whether loyalty signup is allowed at this site
      */
@@ -5057,15 +5725,15 @@ export type SiteInfo = {
     /**
      * Date of first sale
      */
-    firstsale: string;
+    firstsale: string | null;
     /**
      * Date of last sale
      */
-    lastsale: string;
+    lastsale: string | null;
     /**
      * Store number
      */
-    storenum: string;
+    storenum: string | null;
     /**
      * Operating hours for today
      */
@@ -5163,6 +5831,22 @@ export type SiteSearchResult = {
      * Whether POS support is enabled
      */
     point_of_sale_support: boolean;
+    /**
+     * Site IANA timezone identifier
+     */
+    timezone: string | null;
+    /**
+     * Date and time of the first sale at this site (UTC, ISO 8601)
+     */
+    first_sale: string | null;
+    /**
+     * Date and time of the most recent sale at this site (UTC, ISO 8601)
+     */
+    last_sale: string | null;
+    /**
+     * When Zen last received data from this site (UTC, ISO 8601 with offset)
+     */
+    last_connected_at: string | null;
 };
 /**
  * Sites endpoint response.
@@ -5532,189 +6216,428 @@ export type TransactionCreateItem = {
      */
     discount?: string;
     /**
-     * Discount department number
+     * Discount department number
+     */
+    discountnumber?: number;
+    /**
+     * Item is on special
+     */
+    onspecial?: boolean;
+    /**
+     * Points earned for this item
+     */
+    points?: string;
+    /**
+     * Bonus points earned for this item
+     */
+    bonuspoints?: string;
+    /**
+     * Sales discount split applied to this item
+     */
+    salediscount?: string;
+    /**
+     * Item was weighed
+     */
+    weighed?: boolean;
+    /**
+     * Item was scanned via barcode
+     */
+    scanned?: boolean;
+    /**
+     * Table cover attribution
+     */
+    cover?: string;
+};
+/**
+ * Transaction creation request - wrapper object
+ */
+export type TransactionCreateRequest = {
+    /**
+     * Transaction data
+     */
+    transaction: TransactionCreateData;
+};
+/**
+ * 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;
+};
+/**
+ * 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
      */
-    discountnumber?: number;
+    CustomerName?: string;
     /**
-     * Item is on special
+     * Customer address
      */
-    onspecial?: boolean;
+    CustomerAddress?: string;
     /**
-     * Points earned for this item
+     * Customer phone
      */
-    points?: string;
+    CustomerPhone?: string;
     /**
-     * Bonus points earned for this item
+     * Loyalty information
      */
-    bonuspoints?: string;
+    Loyalty?: WebhookTransactionLoyalty;
     /**
-     * Sales discount split applied to this item
+     * Sales items
      */
-    salediscount?: string;
+    Sales?: Array<TransactionItem>;
     /**
-     * Item was weighed
+     * Tender information
      */
-    weighed?: boolean;
+    Tender?: Array<TransactionTender>;
     /**
-     * Item was scanned via barcode
+     * Sales discount
      */
-    scanned?: boolean;
+    SalesDiscount?: TransactionDiscount;
     /**
-     * Table cover attribution
+     * Rounding amount
      */
-    cover?: string;
+    Rounding?: TransactionRounding;
 };
 /**
- * Transaction creation request - wrapper object
+ * Transaction discount
  */
-export type TransactionCreateRequest = {
+export type TransactionDiscount = {
     /**
-     * Transaction data
+     * Discount amount
      */
-    transaction: TransactionCreateData;
+    Amount: number;
+    /**
+     * Tax amount on discount
+     */
+    Tax: number;
 };
 /**
- * Successful transaction creation response
+ * 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 TransactionCreateSuccessResponse = {
+export type TransactionEventResponse = {
+    [key: string]: unknown;
+};
+/**
+ * Transaction item
+ */
+export type TransactionItem = {
     /**
-     * Result code (0 = success)
+     * Item transaction date and time
      */
-    result: 0;
+    DateTime: string;
     /**
-     * Result message
+     * Item code
      */
-    errormessage: 'OK';
+    Item: string;
     /**
-     * Processing comment
+     * Item barcode
      */
-    comment: string;
-};
-/**
- * Transaction tender structure for creation requests
- */
-export type TransactionCreateTender = {
+    Barcode: string;
     /**
-     * Tender type code
+     * Item description
      */
-    tendertype: string;
+    Description: string;
     /**
-     * Tender description
+     * Price level
      */
-    description: string;
+    PriceLevel: number;
     /**
-     * Tender amount
+     * Item price
      */
-    amount: string;
+    Price: number;
     /**
-     * Shift number
+     * Original price before discounts
      */
-    shiftnumber?: string;
+    OriginalPrice?: number;
     /**
-     * Obfuscated credit card number
+     * Item cost
      */
-    creditcard?: string;
+    Cost: number;
     /**
-     * Card holder's name
+     * Quantity sold
      */
-    cardname?: string;
+    Quantity: number;
     /**
-     * Payment authorization platform
+     * Line total amount
      */
-    authorisation?: string;
+    LineTotal: number;
     /**
-     * Card expiry date (MM/YY)
+     * Line tax amount
      */
-    expirydate?: string;
+    LineTAX: number;
     /**
-     * Voucher serial number (for voucher redemption)
+     * Discount amount
      */
-    voucher?: string;
+    Discount: number;
     /**
-     * Voucher type (for voucher redemption)
+     * Department code
      */
-    type?: string;
+    Department: number;
     /**
-     * EFT surcharge amount (ex. tax)
+     * Department name
      */
-    surcharge?: ApiNumeric;
+    DepartmentName?: string;
     /**
-     * EFT surcharge tax
+     * Whether item is on special
      */
-    surchargetax?: ApiNumeric;
+    Special: boolean;
     /**
-     * Tips amount
+     * Loyalty points earned
      */
-    tips?: ApiNumeric;
+    Points?: number;
     /**
-     * Tips tax
+     * Bonus points earned
      */
-    tipstax?: ApiNumeric;
-};
-/**
- * Transaction customer information for creation requests
- */
-export type TransactionCustomer = {
+    Bonus?: number;
     /**
-     * Customer card number
+     * Whether item was scanned
      */
-    cardnumber?: string;
+    Scanned: boolean;
     /**
-     * Customer first name
+     * Scan terminal number
      */
-    firstname: string;
+    ScanTerminal?: number;
     /**
-     * Customer last name
+     * Brand code
      */
-    lastname: string;
+    Brand?: string;
     /**
-     * Card type
+     * Brand name
      */
-    cardtype?: string;
+    BrandName?: string;
     /**
-     * Number of loyalty points being redeemed
+     * Sub-department code
      */
-    redeempoints?: string;
+    SubDepartment?: number;
     /**
-     * Dollar value of points being redeemed (inc. tax)
+     * Sub-department name
      */
-    redeemamount?: string;
+    SubDepartmentName?: string;
     /**
-     * Debtor account number
+     * Category code
      */
-    account?: string;
+    Category?: number;
     /**
-     * Amount to charge to debtor account
+     * Category name
      */
-    charge?: string;
+    CategoryName?: string;
     /**
-     * Amount being paid on debtor account
+     * Sub-category code
      */
-    payment?: string;
+    SubCategory?: number;
     /**
-     * Tender number for the debtor charge
+     * Sub-category name
      */
-    tendernumber?: string;
+    SubCategoryName?: string;
     /**
-     * Department for charge attribution
+     * Range code
      */
-    department?: number;
+    Range?: number;
     /**
-     * Purchase order reference
+     * Range name
      */
-    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;
+    RangeName?: string;
 };
 /**
  * Transaction offer structure for creation requests
@@ -5890,6 +6813,15 @@ 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.
@@ -5926,6 +6858,23 @@ 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
  */
@@ -5976,6 +6925,15 @@ export type TransactionVoucher = {
      */
     voiditem?: boolean;
 };
+/**
+ * Transaction webhook data payload
+ */
+export type TransactionWebhookData = {
+    /**
+     * Transaction data container
+     */
+    AMC_POSPortal: TransactionData;
+};
 /**
  * Validation error for various validation failures (400)
  */
@@ -6159,7 +7117,7 @@ export type VersionResponse = {
      * Available API function sections and their allowed methods
      */
     functions: {
-        [key: string]: ApiFunctionInfo;
+        [key: string]: unknown;
     };
 };
 export type Versions = '1.0.0' | '2.0.0';
@@ -7149,6 +8107,75 @@ export type VoucherTypeResponse = {
         version: string;
     };
 };
+/**
+ * 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
+ */
+export type WebhookPayload = {
+    /**
+     * Webhook function/event type
+     */
+    function: string;
+    /**
+     * Authentication key for webhook verification
+     */
+    key: string;
+    /**
+     * Company/chain code
+     */
+    chain: string;
+    /**
+     * Whether HTML trace is enabled
+     */
+    traceHtml: boolean;
+    /**
+     * Whether trace logging is enabled
+     */
+    trace: boolean;
+    /**
+     * Target webhook URL
+     */
+    url: string;
+    /**
+     * Whether data is sent via POST body
+     */
+    viaBody: boolean;
+};
+/**
+ * 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;
+};
 /**
  * Not found error (404)
  */
@@ -7871,9 +8898,7 @@ export type LoyaltyGetCardData = {
     path: {
         cardNumber: string;
     };
-    query?: {
-        format?: 'compact';
-    };
+    query?: never;
     url: '/v1/loyalty/card/{cardNumber}';
 };
 export type LoyaltyGetCardErrors = {
@@ -7891,7 +8916,7 @@ export type LoyaltyGetCardResponses = {
     /**
      * The request has succeeded.
      */
-    200: LoyaltyCardResponse | LoyaltyCardCompactResponse;
+    200: LoyaltyCardResponse;
 };
 export type LoyaltyGetCardResponse = LoyaltyGetCardResponses[keyof LoyaltyGetCardResponses];
 export type LoyaltyUpdateCardData = {
@@ -8383,7 +9408,7 @@ export type LoyaltyRenewCardResponses = {
         result: number;
         errormessage: string;
         data?: {
-            [key: string]: string;
+            [key: string]: unknown;
         };
     };
 };
@@ -8514,9 +9539,11 @@ export type LoyaltyGetCardTypesResponses = {
      */
     200: {
         /**
-         * Available card types. Also contains version and loyaltyVersion as pseudo-elements.
+         * Card types keyed by numeric string index. Also contains version and loyaltyVersion as pseudo-elements.
          */
-        cardTypes: Array<LoyaltyCardType>;
+        cardTypes: {
+            [key: string]: unknown;
+        };
     };
 };
 export type LoyaltyGetCardTypesResponse = LoyaltyGetCardTypesResponses[keyof LoyaltyGetCardTypesResponses];
@@ -8526,7 +9553,13 @@ export type LoyaltyGetCoffeeCardStatsData = {
         cardNumber: string;
     };
     query?: {
+        /**
+         * Site code. Either this or customer_reference_id is required.
+         */
         site?: number;
+        /**
+         * Customer reference ID for site lookup. Either this or site is required.
+         */
         customer_reference_id?: string;
     };
     url: '/v1/loyalty/coffeecard/{cardNumber}';
@@ -8660,9 +9693,11 @@ export type LoyaltyGetMemberGroupsResponses = {
      */
     200: {
         /**
-         * Purchase loyalty groups. Also contains version and loyaltyVersion as pseudo-elements.
+         * Member groups keyed by numeric string index. Also contains version and loyaltyVersion as pseudo-elements.
          */
-        membergroups: Array<MemberGroup>;
+        membergroups: {
+            [key: string]: unknown;
+        };
     };
 };
 export type LoyaltyGetMemberGroupsResponse = LoyaltyGetMemberGroupsResponses[keyof LoyaltyGetMemberGroupsResponses];
@@ -9543,7 +10578,8 @@ export type OfferListData = {
     query?: {
         /**
          * The unique site code at which the offer check is occurring.
-         * Required when filtering by a specific card number.
+         * Required when cardNumber is not `all` — omitting this for a specific
+         * card will return a validation error.
          */
         site?: number;
         /**
@@ -9878,11 +10914,11 @@ export type SitesSearchSitesData = {
     path?: never;
     query: {
         /**
-         * Search query (required, minimum 1 character). Searches across site name (partial match), CCode (exact), and site code (exact).
+         * Search query (required, minimum 1 character). Supports comma-separated values for batch lookup when field is 'ccode' or 'sitecode' (max 200 values). Single values search across site name (partial match), CCode (exact), and site code (exact).
          */
         q: string;
         /**
-         * Restrict search to a specific field. When omitted, searches all fields.
+         * Restrict search to a specific field. Required when using comma-separated values in q.
          */
         field?: 'name' | 'ccode' | 'sitecode';
         /**
@@ -10020,9 +11056,9 @@ export type TransactionLookupSearchJournalsData = {
          */
         journal: string;
         /**
-         * Optional site code to narrow results
+         * Site code
          */
-        site?: number;
+        site: number;
         /**
          * Optional start date filter (Y-m-d)
          */
@@ -10502,6 +11538,35 @@ export type LoyaltyV2GetGroupsResponses = {
     };
 };
 export type LoyaltyV2GetGroupsResponse = LoyaltyV2GetGroupsResponses[keyof LoyaltyV2GetGroupsResponses];
+export type LoyaltyV2GetMemberGroupsData = {
+    body?: never;
+    path?: never;
+    query?: never;
+    url: '/v2/loyalty/membergroups';
+};
+export type LoyaltyV2GetMemberGroupsErrors = {
+    /**
+     * Access is unauthorized.
+     */
+    401: InvalidAccessKeyError;
+    /**
+     * The server cannot find the requested resource.
+     */
+    404: ZenNotFoundError;
+};
+export type LoyaltyV2GetMemberGroupsError = LoyaltyV2GetMemberGroupsErrors[keyof LoyaltyV2GetMemberGroupsErrors];
+export type LoyaltyV2GetMemberGroupsResponses = {
+    /**
+     * The request has succeeded.
+     */
+    200: {
+        /**
+         * Purchase member groups
+         */
+        member_groups: Array<MemberGroupV2>;
+    };
+};
+export type LoyaltyV2GetMemberGroupsResponse = LoyaltyV2GetMemberGroupsResponses[keyof LoyaltyV2GetMemberGroupsResponses];
 export type PingV2ShowData = {
     body?: never;
     path?: never;
@@ -10515,4 +11580,76 @@ export type PingV2ShowResponses = {
     200: PingV2PingResult;
 };
 export type PingV2ShowResponse = PingV2ShowResponses[keyof PingV2ShowResponses];
+export type WebhookLoyaltyWebhookPayload = WebhookPayload & {
+    data: LoyaltyWebhookData;
+};
+export type WebhookLoyaltyWebhookRequest = {
+    body: WebhookLoyaltyWebhookPayload;
+    key: 'loyalty';
+    path?: never;
+    query?: never;
+};
+export type WebhookCustomerWebhookPayload = WebhookPayload & {
+    data: CustomerWebhookData;
+};
+export type WebhookCustomerWebhookRequest = {
+    body: WebhookCustomerWebhookPayload;
+    key: 'customer';
+    path?: never;
+    query?: never;
+};
+export type WebhookOfferWebhookPayload = WebhookPayload & {
+    data: OfferWebhookData;
+};
+export type WebhookOfferWebhookRequest = {
+    body: WebhookOfferWebhookPayload;
+    key: 'offer';
+    path?: never;
+    query?: never;
+};
+export type WebhookRedeemWebhookPayload = WebhookPayload & {
+    data: OfferWebhookData;
+};
+export type WebhookRedeemWebhookRequest = {
+    body: WebhookRedeemWebhookPayload;
+    key: 'redeem';
+    path?: never;
+    query?: never;
+};
+export type WebhookDeleteWebhookPayload = WebhookPayload & {
+    data: OfferWebhookData;
+};
+export type WebhookDeleteWebhookRequest = {
+    body: WebhookDeleteWebhookPayload;
+    key: 'delete';
+    path?: never;
+    query?: never;
+};
+export type WebhookItemWebhookPayload = WebhookPayload & {
+    data: InventoryWebhookData;
+};
+export type WebhookItemWebhookRequest = {
+    body: WebhookItemWebhookPayload;
+    key: 'item';
+    path?: never;
+    query?: never;
+};
+export type WebhookPriceWebhookPayload = WebhookPayload & {
+    data: InventoryWebhookData;
+};
+export type WebhookPriceWebhookRequest = {
+    body: WebhookPriceWebhookPayload;
+    key: 'price';
+    path?: never;
+    query?: never;
+};
+export type WebhookTransactionWebhookPayload = WebhookPayload & {
+    data: TransactionWebhookData;
+};
+export type WebhookTransactionWebhookRequest = {
+    body: WebhookTransactionWebhookPayload;
+    key: 'transaction';
+    path?: never;
+    query?: never;
+};
 //# sourceMappingURL=types.gen.d.ts.map