@zenglobal/api-client 5.0.4 → 5.0.5

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

@@ -7153,6 +7153,136 @@ export type VoucherBalanceResponse = {
         [key: string]: unknown;
     };
 };
+/**
+ * Individual cart item for multi-voucher operations.
+ * Each item represents one voucher to be created.
+ */
+export type VoucherCartItem = {
+    /**
+     * Cart item identifier
+     */
+    id: string;
+    /**
+     * Buyer's first name (from billing details)
+     */
+    firstname: string;
+    /**
+     * Buyer's surname (from billing details)
+     */
+    surname: string;
+    /**
+     * Buyer's surname only — legacy API concatenates as 'name, firstName'
+     */
+    name: string;
+    /**
+     * Buyer's first name (from billing details)
+     */
+    firstName: string;
+    /**
+     * Unit price per voucher after discount
+     */
+    unitPrice: number;
+    /**
+     * Number of vouchers for this line item
+     */
+    quantity: number;
+    /**
+     * Voucher face value per unit (includes bonus)
+     */
+    value: number;
+    /**
+     * Delivery method: 'email' or 'post'
+     */
+    sendBy: string;
+    /**
+     * Optional message to include with the voucher
+     */
+    message: string;
+    /**
+     * Sender name for the message
+     */
+    messageFrom: string;
+    /**
+     * Recipient name for the message
+     */
+    messageTo: string;
+    /**
+     * Delivery address
+     */
+    address: string;
+    /**
+     * Scheduled delivery date (YYYY-MM-DD format)
+     */
+    scheduledDate: string;
+    /**
+     * Buyer's email address
+     */
+    email: string;
+    /**
+     * Buyer's phone number
+     */
+    phone: string;
+    /**
+     * Buyer's mobile number
+     */
+    mobile: string;
+    /**
+     * Delivery postcode
+     */
+    postcode: string;
+    /**
+     * Recipient's first name
+     */
+    recipientFirstname: string;
+    /**
+     * Recipient's surname
+     */
+    recipientSurname: string;
+    /**
+     * Recipient's email address
+     */
+    recipientEmail: string;
+    /**
+     * Postage type: '1' for express, '0' for standard
+     */
+    postage: string;
+    /**
+     * Whether this item requires physical delivery
+     */
+    sendPhysical: boolean;
+    /**
+     * Postage charge amount for this item
+     */
+    postageCharge: number;
+    /**
+     * Whether this is a gift voucher
+     */
+    sendGift: boolean;
+    /**
+     * Secondary email address (recipient's email)
+     */
+    secondary_email: string;
+    /**
+     * Gift recipient's first name
+     */
+    giftfirst: string;
+    /**
+     * Gift recipient's last name
+     */
+    giftlast: string;
+    /**
+     * Gift recipient's address
+     */
+    giftaddress: string;
+    /**
+     * Scheduled email delivery date
+     */
+    emailDate: string;
+    /**
+     * Line number (1-based index)
+     */
+    line: number;
+};
 /**
  * Payment charge information for web voucher operations
  */
@@ -7161,6 +7291,28 @@ export type VoucherCharge = {
      * Payment process ID from payment gateway
      */
     processId: string;
+    /**
+     * Card identifier from payment method
+     */
+    cardID?: string;
+    /**
+     * Cardholder name from payment method billing details
+     */
+    cardName?: string;
+    /**
+     * Payment reference
+     */
+    reference?: string;
+    /**
+     * Payment token (e.g., charge ID from Stripe)
+     */
+    token?: string;
+    /**
+     * Raw charge payload from payment gateway
+     */
+    raw?: {
+        [key: string]: unknown;
+    };
 };
 /**
  * Voucher create body fields (inside the `voucher` wrapper).
@@ -7228,6 +7380,10 @@ export type VoucherCreateBody = {
      * Surcharge amount
      */
     surcharge?: number;
+    /**
+     * Currency code (e.g., 'aud')
+     */
+    currency?: string;
     /**
      * Whether this is a web voucher (requires charge.processId)
      */
@@ -7276,6 +7432,10 @@ export type VoucherCreateBody = {
      * Gift recipient's last name (when isgift is true)
      */
     giftlast?: string;
+    /**
+     * Scheduled date for gift email delivery (YYYY-MM-DD format)
+     */
+    giftEmailDate?: string;
     /**
      * Optional message to include with the voucher notification
      */
@@ -7288,10 +7448,26 @@ export type VoucherCreateBody = {
      * Recipient name for the voucher message
      */
     messageTo?: string;
+    /**
+     * Whether the customer opted in to marketing communications
+     */
+    marketingOptIn?: boolean;
     /**
      * When true, sets the voucher to Locked status instead of Sold (for sandbox/testing)
      */
     sandbox?: boolean;
+    /**
+     * Whether terms and conditions were accepted. Note: field name preserves legacy API typo.
+     */
+    condtionAccept?: boolean;
+    /**
+     * Client IP address for web voucher transactions
+     */
+    webVoucherIP?: string;
+    /**
+     * Client user agent string for web voucher transactions
+     */
+    webVoucherAgent?: string;
     /**
      * Voucher PIN
      */
@@ -7307,9 +7483,7 @@ export type VoucherCreateBody = {
     /**
      * Cart items for multi-voucher operations
      */
-    cart?: Array<{
-        [key: string]: unknown;
-    }>;
+    cart?: Array<VoucherCartItem>;
     /**
      * Reason text for the voucher operation
      */
@@ -7317,9 +7491,7 @@ export type VoucherCreateBody = {
     /**
      * Voucher number tracking for multi-voucher operations
      */
-    voucherNumbers?: {
-        [key: string]: unknown;
-    };
+    voucherNumbers?: VoucherNumbers;
     /**
      * Location number (used when ispos is true)
      */
@@ -7328,6 +7500,38 @@ export type VoucherCreateBody = {
      * Terminal number (used when ispos is true)
      */
     terminal?: number;
+    /**
+     * Chain/company code
+     */
+    company?: number;
+    /**
+     * Total amount paid by customer (after discounts and surcharges)
+     */
+    amountpaid?: number;
+    /**
+     * Discount amount applied
+     */
+    discount?: number;
+    /**
+     * Voucher type identifier (e.g., 'Gift', 'Loyalty')
+     */
+    vouchertype?: string;
+    /**
+     * Timestamp of web voucher creation (Y-m-d H:i:s format)
+     */
+    webVoucherDateTime?: string;
+    /**
+     * Unix timestamp of web voucher creation
+     */
+    webVoucherDateTimeRaw?: number;
+    /**
+     * Total postage charge amount
+     */
+    postageCharge?: number;
+    /**
+     * Cart workflow reference ID
+     */
+    reference?: string;
 };
 /**
  * Request body for creating a new voucher via POST /voucher/{voucherType}/create.
@@ -7377,43 +7581,14 @@ export type VoucherCreateResponse = {
      * Transaction reference in format site:terminal:journal (POS operations only)
      */
     reference?: string;
-};
-/**
- * Voucher deletion request.
- * Body must be wrapped in a `voucher` key: `{"voucher": {...}}`.
- */
-export type VoucherDeleteRequest = {
-    /**
-     * Voucher wrapper
-     */
-    voucher: {
-        /**
-         * Voucher serial number
-         */
-        serialnumber: string;
-        /**
-         * Voucher PIN for verification (required when PIN checking is enabled)
-         */
-        pin: string;
-        /**
-         * Site code where deletion occurs
-         */
-        site: number;
-    };
-};
-/**
- * Voucher deletion response.
- * Uses setError() so includes result/errormessage.
- */
-export type VoucherDeleteResponse = {
     /**
-     * Result code (0 = success)
+     * Reason for failure or additional context
      */
-    result: number;
+    reason?: string;
     /**
-     * Result message
+     * Whether to show the view voucher link in the response
      */
-    errormessage: string;
+    showViewLink?: boolean;
 };
 /**
  * Voucher enquire body fields (inside the `voucher` wrapper).
@@ -7602,6 +7777,23 @@ export type VoucherImageResponse = {
         voucherimage: string;
     };
 };
+/**
+ * Voucher count tracking for multi-voucher operations
+ */
+export type VoucherNumbers = {
+    /**
+     * Total number of vouchers in the cart
+     */
+    total: number;
+    /**
+     * Number of email (electronic) vouchers
+     */
+    totalE: number;
+    /**
+     * Number of physical (postal) vouchers
+     */
+    totalP: number;
+};
 /**
  * Voucher recharge body fields (inside the `voucher` wrapper).
  */
@@ -11178,32 +11370,6 @@ export type VersionGetVersionResponses = {
     200: VersionResponse;
 };
 export type VersionGetVersionResponse = VersionGetVersionResponses[keyof VersionGetVersionResponses];
-export type VoucherDeleteVoucherData = {
-    body: VoucherDeleteRequest;
-    path: {
-        voucherType: string;
-    };
-    query?: never;
-    url: '/v1/voucher/{voucherType}';
-};
-export type VoucherDeleteVoucherErrors = {
-    /**
-     * The server could not understand the request due to invalid syntax.
-     */
-    400: ValidationError;
-    /**
-     * Access is unauthorized.
-     */
-    401: InvalidAccessKeyError;
-};
-export type VoucherDeleteVoucherError = VoucherDeleteVoucherErrors[keyof VoucherDeleteVoucherErrors];
-export type VoucherDeleteVoucherResponses = {
-    /**
-     * The request has succeeded.
-     */
-    200: VoucherDeleteResponse;
-};
-export type VoucherDeleteVoucherResponse = VoucherDeleteVoucherResponses[keyof VoucherDeleteVoucherResponses];
 export type VoucherGetVoucherTypeData = {
     body?: never;
     path: {