@zenglobal/api-client 5.1.9 → 5.1.11

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

@@ -4332,8 +4332,20 @@ export type Offer = {
     acceptancedays?: ApiNumeric;
     /**
      * Promotion group identifier for coffee card offers
+     *
+     * @deprecated
+     */
+    promogroupid?: ApiNumeric | null;
+    /**
+     * Stamp target of a coffee card: the number of earn-item purchases that
+     * unlock the free item. Null when the offer is not a coffee card.
+     */
+    coffee_card_target?: ApiNumeric | null;
+    /**
+     * The items whose purchases earn a coffee card stamp. Empty when the offer
+     * is not a coffee card. Distinct from the items the free item can be.
      */
-    promogroupid?: ApiNumeric;
+    earn_items?: Array<OfferEarnItem>;
     /**
      * Start date for new member window (inclusive)
      */
@@ -4630,6 +4642,19 @@ export type OfferDetailTimeOfDay = {
     start_hour: string;
     end_hour: string;
 };
+/**
+ * An item whose purchases earn a coffee card stamp
+ */
+export type OfferEarnItem = {
+    /**
+     * Item number, matched exactly against sale lines
+     */
+    item_number: string;
+    /**
+     * Item description
+     */
+    description: string | null;
+};
 export type OfferEffect = {
     /**
      * The type and amount of discount offered with the offer
@@ -7799,6 +7824,15 @@ export type VoucherCreateBody = {
      * Cart workflow reference ID
      */
     reference?: string;
+    /**
+     * External reference from the client's own system (order, booking or finance
+     * reference), used to find the voucher later via the `externalreference` search.
+     * Any text up to 100 characters; leading and trailing spaces are trimmed and a
+     * blank value is ignored. Need not be unique. For a multi-voucher cart
+     * (`multi: true`) every voucher created by the request gets this reference.
+     * Longer values, or a non-string value, are rejected with error code `9`.
+     */
+    externalreference?: string;
 };
 /**
  * Request body for creating a new voucher via POST /voucher/{voucherType}/create.
@@ -8009,6 +8043,10 @@ export type VoucherEnquireDetail = {
      * Payment option
      */
     paymentoption: string;
+    /**
+     * External reference from the client's own system. Empty string if none.
+     */
+    externalreference: string;
     /**
      * Transaction history (up to 50 most recent, ordered by time descending)
      */
@@ -8450,6 +8488,10 @@ export type VoucherSearchItem = {
      * Voucher subtype description (from VOUCHERSUBTYPE table, empty string if none)
      */
     subtype: string;
+    /**
+     * External reference from the client's own system (order, booking or finance reference). Empty string if none.
+     */
+    externalreference: string;
 };
 /**
  * Voucher search response.
@@ -12127,7 +12169,7 @@ export type VoucherSearchVouchersData = {
     body?: never;
     path: {
         voucherType: string;
-        searchBy: 'number' | 'name' | 'mobile' | 'email' | 'id' | 'date' | 'issuedate' | 'redeemdate' | 'rechargedate';
+        searchBy: 'number' | 'name' | 'mobile' | 'email' | 'id' | 'date' | 'issuedate' | 'redeemdate' | 'rechargedate' | 'externalreference';
     };
     query: {
         q: string;
@@ -12156,7 +12198,7 @@ export type VoucherSearchVouchersFlatData = {
     body?: never;
     path: {
         voucherType: string;
-        searchBy: 'number' | 'name' | 'mobile' | 'email' | 'id' | 'date' | 'issuedate' | 'redeemdate' | 'rechargedate';
+        searchBy: 'number' | 'name' | 'mobile' | 'email' | 'id' | 'date' | 'issuedate' | 'redeemdate' | 'rechargedate' | 'externalreference';
     };
     query: {
         q: string;