@zenglobal/api-client 2.0.0 → 3.0.0

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

@@ -422,10 +422,8 @@ export type CoffeeCardResultItem = {
     purchased: number;
 };
 /**
- * Site and company information modelsComplete company information structure.
- * Fields are sourced from CHAIN, SBU, CHAININFO, CHAINDEFAULT, and CHAINLOCALE tables.
- * All T/F varchar fields are converted to booleans.
- * All integer/decimal values are converted to strings by JsonTransformer.
+ * Site and company information models.Complete company information structure.
+ * Boolean fields are native booleans. Numeric values are returned as strings.
  */
 export type CompanyInfo = {
     /**
@@ -433,11 +431,11 @@ export type CompanyInfo = {
      */
     company: ApiNumeric;
     /**
-     * Company description/name
+     * Company name
      */
     description: string;
     /**
-     * SBU (Strategic Business Unit) number
+     * Strategic Business Unit number
      */
     sbunumber: string;
     /**
@@ -457,7 +455,7 @@ export type CompanyInfo = {
      */
     phone: string;
     /**
-     * Company active status (T/F converted to boolean)
+     * Whether the company is active
      */
     active: boolean;
     /**
@@ -521,7 +519,7 @@ export type CompanyInfo = {
      */
     acn: string;
     /**
-     * Department levels setting
+     * Department hierarchy levels
      */
     deptlevels: ApiNumeric;
     /**
@@ -533,11 +531,11 @@ export type CompanyInfo = {
      */
     mastersite: ApiNumeric;
     /**
-     * Districts enabled flag (T/F converted to boolean)
+     * Whether district grouping is enabled
      */
     districts: boolean;
     /**
-     * Chain URL for loyalty portal
+     * Loyalty portal URL
      */
     chainurl: string;
     /**
@@ -553,7 +551,7 @@ export type CompanyInfo = {
      */
     discount: ApiNumeric;
     /**
-     * Year renewal month
+     * Year renewal setting
      */
     yearrenew: ApiNumeric;
     /**
@@ -565,7 +563,7 @@ export type CompanyInfo = {
      */
     weekstartday: ApiNumeric;
     /**
-     * Year start month
+     * Fiscal year start month
      */
     yearstartmonth: ApiNumeric;
     /**
@@ -573,7 +571,7 @@ export type CompanyInfo = {
      */
     defaultmenu: ApiNumeric;
     /**
-     * Default image (business) path
+     * Default business image path
      */
     defaultimageb: string;
     /**
@@ -585,75 +583,67 @@ export type CompanyInfo = {
      */
     loyaltyname: string;
     /**
-     * Singular site descriptor label
+     * Singular site label
      */
     sitedesc: string;
     /**
-     * Plural site descriptor label
+     * Plural site label
      */
     sitedescs: string;
     /**
-     * Fashion mode setting
-     */
-    fashion: string;
-    /**
-     * Brand lab setting
+     * Brand label
      */
     brandlab: string;
     /**
-     * Group financial summary enabled (T/F converted to boolean)
+     * Whether loyalty is grouped across sites
      */
     groupfs: boolean;
     /**
-     * Card management enabled (T/F converted to boolean)
+     * Whether card management is enabled
      */
     enablecard: boolean;
     /**
-     * Card expiry enabled (T/F converted to boolean)
-     */
-    enableexpiry: boolean;
-    /**
-     * Warning grace period (days)
+     * Warning grace period in days
      */
     warninggrace: ApiNumeric;
     /**
-     * Expiry grace period (days)
+     * Expiry grace period in days
      */
     expirygrace: ApiNumeric;
     /**
-     * Password expiry warning period (days)
+     * Password expiry warning period in days
      */
     warningpwdexpiry: ApiNumeric;
     /**
-     * Tax description label
+     * Tax description label (e.g. GST)
      */
     taxdesc: string;
     /**
-     * Default active status for new records (T/F converted to boolean)
+     * Whether new records are active by default
      */
     defaultactive: boolean;
     /**
-     * Follow active status from parent (T/F converted to boolean)
+     * Whether child records follow parent active status
      */
     followactive: boolean;
     /**
-     * Recalculate points enabled (T/F converted to boolean)
+     * Whether points are recalculated on changes
      */
     recalculatepoints: boolean;
     /**
-     * Loyalty period type
+     * Loyalty period type (e.g. man, quart, 4-4-5)
      */
     periodtype: string;
     /**
-     * SMS sub-accounts enabled (T/F converted to boolean)
+     * Whether SMS sub-accounts are enabled
      */
     smssubaccounts: boolean;
     /**
-     * Currency symbol
+     * Currency symbol (e.g. $)
      */
     currencysym: string;
     /**
-     * Decimal places for currency
+     * Decimal places for currency display
      */
     decimals: ApiNumeric;
     /**
@@ -669,35 +659,35 @@ export type CompanyInfo = {
      */
     maxterminals: ApiNumeric;
     /**
-     * Currency code (e.g., AUD)
+     * Currency code (e.g. AUD)
      */
     currency: string;
     /**
-     * Web voucher module enabled (always true)
+     * Whether the web voucher module is enabled
      */
     webvoucherenabled: boolean;
     /**
-     * Web loyalty module enabled (always true)
+     * Whether the web loyalty module is enabled
      */
     webloyaltyenabled: boolean;
     /**
-     * Web debtor module enabled (always false)
+     * Whether the web debtor module is enabled
      */
     webdebtorenabled: boolean;
     /**
-     * Web member module enabled (always true)
+     * Whether the web member module is enabled
      */
     webmemberenabled: boolean;
     /**
-     * Web customer order module enabled (always true)
+     * Whether the web customer order module is enabled
      */
     webcustomerorderenabled: boolean;
     /**
-     * Web voucher URL
+     * Web voucher purchase URL
      */
     webvoucherurl: string;
     /**
-     * Array of sites belonging to this company
+     * Sites belonging to this company
      */
     sites: Array<SiteInfo>;
 };
@@ -1375,7 +1365,7 @@ export type ListUpdateRequest = {
     };
 };
 /**
- * Location information within a site
+ * Location within a site.
  */
 export type LocationInfo = {
     /**
@@ -1383,7 +1373,7 @@ export type LocationInfo = {
      */
     location: ApiNumeric;
     /**
-     * Location description
+     * Location name
      */
     description: string;
     /**
@@ -1391,7 +1381,7 @@ export type LocationInfo = {
      */
     locationtype: ApiNumeric;
     /**
-     * Location type description
+     * Location type name
      */
     locationtypedescription: string;
 };
@@ -1652,11 +1642,11 @@ export type LoyaltyCard = {
     /**
      * Available offers (when includeoffers requested)
      */
-    offers?: Array<LoyaltyOffer>;
+    offers?: Array<Offer>;
     /**
      * Recently redeemed offers (when includeoffers requested)
      */
-    redeemed_offers?: Array<RedeemedOffer>;
+    redeemed_offers?: Array<OfferRedemption>;
     /**
      * Transaction history (when requested)
      */
@@ -2094,29 +2084,6 @@ export type LoyaltyGroup = {
      */
     sitelist: Array<string>;
 };
-/**
- * Loyalty offer information (simplified for card context)
- */
-export type LoyaltyOffer = {
-    /**
-     * Offer identifier
-     */
-    offer_id: number;
-    /**
-     * Offer description
-     */
-    offer_description: string;
-    /**
-     * Offer is active
-     */
-    active: boolean;
-    /**
-     * Offer details
-     */
-    details?: {
-        [key: string]: string;
-    };
-};
 /**
  * Simplified loyalty card information returned by search endpoints
  */
@@ -3383,8 +3350,9 @@ export type Offer = {
      * * `P` - Before birthday
      * * `A` - After birthday
      * * `B` - Before or after birthday
+     * Null when not a birthday offer.
      */
-    deltadir?: DeltaDir;
+    deltadir?: DeltaDir | null;
     /**
      * Human-readable description of the card type flag setting
      */
@@ -3502,7 +3470,7 @@ export type Offer = {
     /**
      * Link scheduler value
      */
-    linksched?: ApiNumeric;
+    linksched?: string;
     /**
      * Determine the range for which to look for purchased items.
      * * `-1` - ALL
@@ -4576,59 +4544,6 @@ export type PurchaseGroup = {
      */
     isdefault: string;
 };
-/**
- * Redeemed offer information
- */
-export type RedeemedOffer = {
-    /**
-     * Offer identifier
-     */
-    id: number;
-    /**
-     * Offer description
-     */
-    description: string;
-    /**
-     * Offer active date
-     */
-    dateactive?: ApiDate;
-    /**
-     * Offer expiry date
-     */
-    dateexpire?: ApiDate;
-    /**
-     * Offer points value
-     */
-    points?: ApiNumeric;
-    /**
-     * Offer discount value
-     */
-    discount?: ApiNumeric;
-    /**
-     * Offer amount
-     */
-    amount?: ApiNumeric;
-    /**
-     * Whether offer is enabled
-     */
-    enabled: boolean;
-    /**
-     * Date the offer was redeemed
-     */
-    redeemed_date?: ApiDate;
-    /**
-     * Points redeemed for this offer
-     */
-    redeemed_points?: ApiNumeric;
-    /**
-     * Amount redeemed for this offer
-     */
-    redeemed_amount?: ApiNumeric;
-    /**
-     * Tax on redeemed amount
-     */
-    redeemed_tax?: ApiNumeric;
-};
 export type Result = {
     result: number;
     errormessage: string;
@@ -4847,11 +4762,6 @@ export type ShortCodeUpdateResponse = {
 };
 /**
  * Individual site information.
- * All columns from the SITE table are included except: servernumber, netaddress,
- * tillmastersite, servername, changedate, childid, chaincode, nmi, enableasp.
- * T/F varchar fields are converted to booleans.
- * Integer/decimal values are converted to strings by JsonTransformer.
- * The `times` and `locations` fields are dynamically added.
  */
 export type SiteInfo = {
     /**
@@ -4859,69 +4769,13 @@ export type SiteInfo = {
      */
     sitecode: ApiNumeric;
     /**
-     * Site description/name
+     * Site name
      */
     description: string;
-    /**
-     * Site type (single character code)
-     */
-    sitetype: string;
-    /**
-     * Region code
-     */
-    region: ApiNumeric;
-    /**
-     * Site locale setting
-     */
-    sitelocale: string;
-    /**
-     * Code page for character encoding
-     */
-    codepage: ApiNumeric;
-    /**
-     * Maximum terminals allowed at site
-     */
-    maxterminals: ApiNumeric;
-    /**
-     * Venue ID for external integrations
-     */
-    venue_id: ApiNumeric;
-    /**
-     * District code
-     */
-    district: ApiNumeric;
-    /**
-     * External store identifier
-     */
-    store_id: string;
-    /**
-     * Shopify store identifier
-     */
-    shopify_id: string;
-    /**
-     * Salesforce account identifier
-     */
-    salesforce_account_id: string;
-    /**
-     * Customer reference identifier
-     */
-    customer_reference_id: string;
-    /**
-     * Salesforce sync status
-     */
-    salesforce_sync_status: string;
-    /**
-     * Salesforce sync last updated timestamp
-     */
-    salesforce_sync_updated_at: string;
     /**
      * Registered business name
      */
     registeredname: string;
-    /**
-     * Site serial number for authentication
-     */
-    serialnumber: string;
     /**
      * Site address line 1
      */
@@ -4943,7 +4797,7 @@ export type SiteInfo = {
      */
     country: string;
     /**
-     * City/Suburb name
+     * City or suburb
      */
     city: string;
     /**
@@ -4987,11 +4841,11 @@ export type SiteInfo = {
      */
     billcity: string;
     /**
-     * Contact person name
+     * Contact person
      */
     contact: string;
     /**
-     * Site manager name
+     * Site manager
      */
     manager: string;
     /**
@@ -4999,105 +4853,61 @@ export type SiteInfo = {
      */
     email: string;
     /**
-     * Last known IP address
-     */
-    lastipaddress: string;
-    /**
-     * Last IP address date
-     */
-    lastipdate: string;
-    /**
-     * Last billing date
-     */
-    lastbilldate: string;
-    /**
-     * License expiry date
-     */
-    licdate: string;
-    /**
-     * Date of first sale
-     */
-    firstsale: string;
-    /**
-     * Date of last sale
-     */
-    lastsale: string;
-    /**
-     * Store type classification
-     */
-    storetype: string;
-    /**
-     * Store number identifier
-     */
-    storenum: string;
-    /**
-     * Blind cash-up enabled (T/F converted to boolean)
-     */
-    blindcashup: boolean;
-    /**
-     * Location feature enabled (T/F converted to boolean)
-     */
-    enableloc: boolean;
-    /**
-     * Kiosk mode enabled (T/F converted to boolean)
-     */
-    enablekiosk: boolean;
-    /**
-     * Australian Company Number for site
+     * Australian Company Number
      */
     acn: string;
     /**
-     * VNC password (internal)
-     */
-    _vncpassword: string;
-    /**
-     * Site active status (T/F converted to boolean)
+     * Whether the site is active
      */
     siteactive: boolean;
-    /**
-     * Video port number
-     */
-    videoport: ApiNumeric;
     /**
      * Site currency code
      */
     currency: string;
     /**
-     * GPS latitude coordinate
+     * GPS latitude
      */
     latitude: ApiNumeric;
     /**
-     * GPS longitude coordinate (note: column name has legacy typo)
+     * GPS longitude (note: legacy spelling preserved)
      */
     longtitude: ApiNumeric;
     /**
-     * Base station identifier
+     * Site timezone
      */
-    basestation: string;
+    timezone: string;
     /**
-     * Use trade date instead of calendar date (T/F converted to boolean)
+     * Region code
      */
-    usetradedate: boolean;
+    region: ApiNumeric;
     /**
-     * Site passphrase for authentication
+     * Region reference ID
      */
-    passphrase: string;
+    region_id: ApiNumeric;
     /**
-     * Map cash drawer enabled (T/F converted to boolean)
+     * District code
      */
-    mapcashdrawer: boolean;
+    district: ApiNumeric;
     /**
-     * Compliance mode setting
+     * District reference ID
      */
-    compliancemode: string;
+    district_id: ApiNumeric;
     /**
-     * Region reference ID
+     * External store identifier
      */
-    region_id: ApiNumeric;
+    store_id: string;
     /**
-     * District reference ID
+     * Shopify store identifier
      */
-    district_id: ApiNumeric;
+    shopify_id: string;
+    /**
+     * Salesforce account identifier
+     */
+    salesforce_account_id: string;
+    /**
+     * Customer reference identifier
+     */
+    customer_reference_id: string;
     /**
      * POS provider reference ID
      */
@@ -5107,7 +4917,7 @@ export type SiteInfo = {
      */
     point_of_sale_reseller_id: ApiNumeric;
     /**
-     * POS support enabled
+     * Whether POS support is enabled
      */
     point_of_sale_support: boolean;
     /**
@@ -5115,23 +4925,39 @@ export type SiteInfo = {
      */
     web_store_id: ApiNumeric;
     /**
-     * Site timezone (e.g., Australia/Adelaide)
+     * Salesforce sync status
      */
-    timezone: string;
+    salesforce_sync_status: string;
+    /**
+     * Salesforce sync last updated
+     */
+    salesforce_sync_updated_at: string;
     /**
      * Whether loyalty signup is allowed at this site
      */
-    allow_loyalty_signup: boolean;
+    allow_loyalty_signup: string;
+    /**
+     * Date of first sale
+     */
+    firstsale: string;
+    /**
+     * Date of last sale
+     */
+    lastsale: string;
+    /**
+     * Store number
+     */
+    storenum: string;
     /**
      * Operating hours for today
      */
     times: {
         /**
-         * Opening time
+         * Opening hour (0-23)
          */
         opening: string;
         /**
-         * Closing time
+         * Closing hour (0-23)
          */
         closing: string;
     };
@@ -5141,8 +4967,7 @@ export type SiteInfo = {
     locations: Array<LocationInfo>;
 };
 /**
- * Sites response model.
- * This is a GET endpoint that returns raw JSON via prepareJson() without result/errormessage wrapper.
+ * Sites endpoint response.
  */
 export type SitesResponse = {
     /**