@paydock/client-sdk 1.139.0 → 1.140.0-beta

package/bundles/types/open-wallets/types/on-shipping-address-change-event-response.interface.d.ts

@@ -1,6 +1,24 @@
-import type { IApplePayShippingOption } from '../../components/param';
+import type { IShippingOption } from '../../components/param';
+/**
+ * Response object returned by the merchant's `onShippingAddressChange` handler.
+ * Used to update the wallet payment sheet with new amounts, shipping options, or errors.
+ */
 export interface OnShippingAddressChangeEventResponse {
+    /** The updated payment amount based on the new shipping address. */
     amount?: number;
-    shipping_options?: IApplePayShippingOption[];
+    /**
+     * Updated list of available shipping options for the new address.
+     * The first item in the array is used as the default selected option.
+     */
+    shipping_options?: IShippingOption[];
+    /** Optional error to display in the wallet payment sheet if the address is invalid. */
+    error?: {
+        /** The error code identifying the type of address validation error. */
+        code: 'address_error' | 'country_error' | 'state_error' | 'zip_error' | 'shipping_contact_invalid' | 'billing_contact_invalid' | string;
+        /** The specific field that caused the error (for Apple Pay error display). */
+        field?: 'phone' | 'email' | 'name' | 'phonetic_name' | 'address_lines' | 'locality' | 'postal_code' | 'administrative_area' | 'country' | 'country_code';
+        /** A human-readable error message to display to the customer. */
+        message?: string;
+    };
 }
 //# sourceMappingURL=on-shipping-address-change-event-response.interface.d.ts.map

package/bundles/types/open-wallets/types/on-shipping-address-change-event-response.interface.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"on-shipping-address-change-event-response.interface.d.ts","sourceRoot":"","sources":["../../../src/open-wallets/types/on-shipping-address-change-event-response.interface.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,wBAAwB,CAAC;AAEtE,MAAM,WAAW,oCAAoC;IACnD,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,gBAAgB,CAAC,EAAE,uBAAuB,EAAE,CAAC;CAC9C"}
+{"version":3,"file":"on-shipping-address-change-event-response.interface.d.ts","sourceRoot":"","sources":["../../../src/open-wallets/types/on-shipping-address-change-event-response.interface.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAE9D;;;GAGG;AACH,MAAM,WAAW,oCAAoC;IACnD,oEAAoE;IACpE,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,eAAe,EAAE,CAAC;IACrC,uFAAuF;IACvF,KAAK,CAAC,EAAE;QACN,uEAAuE;QACvE,IAAI,EACA,eAAe,GACf,eAAe,GACf,aAAa,GACb,WAAW,GACX,0BAA0B,GAC1B,yBAAyB,GACzB,MAAM,CAAC;QACX,8EAA8E;QAC9E,KAAK,CAAC,EACF,OAAO,GACP,OAAO,GACP,MAAM,GACN,eAAe,GACf,eAAe,GACf,UAAU,GACV,aAAa,GACb,qBAAqB,GACrB,SAAS,GACT,cAAc,CAAC;QACnB,iEAAiE;QACjE,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB,CAAC;CACH"}

package/bundles/types/open-wallets/types/on-shipping-option-change-event-data.interface.d.ts

@@ -1,12 +1,23 @@
 import type { EVENT } from '../enum/event.enum';
-import type { BaseEventData } from './base-event-data.interface';
-export interface OnShippingOptionChangeEventData extends BaseEventData<ShippingOptionChangeEventData> {
+import type { OpenWalletDataEvent } from './base-event-data.interface';
+/**
+ * Event data emitted when the customer selects a shipping option
+ * in the wallet payment sheet.
+ */
+export interface OnShippingOptionChangeEventData extends OpenWalletDataEvent<ShippingOptionChangeEventData> {
     event: EVENT.ON_SHIPPING_OPTIONS_CHANGE;
 }
+/**
+ * The selected shipping option data provided by the wallet.
+ */
 interface ShippingOptionChangeEventData {
+    /** The unique identifier of the selected shipping option. */
     shipping_option_id?: string;
+    /** The amount associated with the selected shipping option. */
     amount?: string;
+    /** The display label of the selected shipping option. */
     label?: string;
+    /** Additional detail text for the selected shipping option. */
     detail?: string;
 }
 export {};

package/bundles/types/open-wallets/types/on-shipping-option-change-event-data.interface.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"on-shipping-option-change-event-data.interface.d.ts","sourceRoot":"","sources":["../../../src/open-wallets/types/on-shipping-option-change-event-data.interface.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAC;AAChD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,6BAA6B,CAAC;AAEjE,MAAM,WAAW,+BACf,SAAQ,aAAa,CAAC,6BAA6B,CAAC;IACpD,KAAK,EAAE,KAAK,CAAC,0BAA0B,CAAC;CACzC;AAED,UAAU,6BAA6B;IACrC,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB"}
+{"version":3,"file":"on-shipping-option-change-event-data.interface.d.ts","sourceRoot":"","sources":["../../../src/open-wallets/types/on-shipping-option-change-event-data.interface.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAC;AAChD,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,6BAA6B,CAAC;AAEvE;;;GAGG;AACH,MAAM,WAAW,+BACf,SAAQ,mBAAmB,CAAC,6BAA6B,CAAC;IAC1D,KAAK,EAAE,KAAK,CAAC,0BAA0B,CAAC;CACzC;AAED;;GAEG;AACH,UAAU,6BAA6B;IACrC,6DAA6D;IAC7D,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,+DAA+D;IAC/D,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,yDAAyD;IACzD,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,+DAA+D;IAC/D,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB"}

package/bundles/types/open-wallets/types/on-shipping-option-change-event-response.interface.d.ts

@@ -1,4 +1,16 @@
+/**
+ * Response object returned by the merchant's `onShippingOptionsChange` handler.
+ * Used to update the wallet payment sheet with a new total amount.
+ */
 export interface OnShippingOptionChangeEventResponse {
+    /** The updated total payment amount based on the selected shipping option. */
     amount?: number;
+    /** Optional error to display in the wallet payment sheet if the option is invalid. */
+    error?: {
+        /** The error code identifying the type of shipping option error. */
+        code: 'method_unavailable' | 'store_unavailable' | string;
+        /** A human-readable error message. */
+        message?: string;
+    };
 }
 //# sourceMappingURL=on-shipping-option-change-event-response.interface.d.ts.map

package/bundles/types/open-wallets/types/on-shipping-option-change-event-response.interface.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"on-shipping-option-change-event-response.interface.d.ts","sourceRoot":"","sources":["../../../src/open-wallets/types/on-shipping-option-change-event-response.interface.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,mCAAmC;IAClD,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB"}
+{"version":3,"file":"on-shipping-option-change-event-response.interface.d.ts","sourceRoot":"","sources":["../../../src/open-wallets/types/on-shipping-option-change-event-response.interface.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,WAAW,mCAAmC;IAClD,8EAA8E;IAC9E,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,sFAAsF;IACtF,KAAK,CAAC,EAAE;QACN,oEAAoE;QACpE,IAAI,EAAE,oBAAoB,GAAG,mBAAmB,GAAG,MAAM,CAAC;QAC1D,sCAAsC;QACtC,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB,CAAC;CACH"}

package/bundles/types/open-wallets/types/payment-source.type.d.ts

@@ -4,10 +4,11 @@ import type { SERVICE_TYPES } from '../../api/api-service-internal';
 import type { IShippingOption } from '../../components/param';
 import type { PAYLOAD_FORMAT } from '../enum/payload-format.enum';
 import type { SERVICE_GROUP } from '../enum/service-group.enum';
+import type { TOKEN_TYPE } from '../enum/token-type.enum';
 import type { WalletType } from './wallet-type.type';
 export interface CreateOTTResponse {
     temp_token: string;
-    token_type: string;
+    token_type: TOKEN_TYPE;
 }
 export interface Billing {
     address_line1: string;
@@ -39,7 +40,7 @@ export interface CreateSessionRequest {
     service_id: string;
     session_id: string;
     request_shipping?: boolean;
-    store_name?: string;
+    store_name: string;
 }
 export interface CreateSessionResponse {
     id: string;

package/bundles/types/open-wallets/types/payment-source.type.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"payment-source.type.d.ts","sourceRoot":"","sources":["../../../src/open-wallets/types/payment-source.type.ts"],"names":[],"mappings":";;AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,gCAAgC,CAAC;AACpE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAC9D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAC;AAClE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAChE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAErD,MAAM,WAAW,iBAAiB;IAChC,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,OAAO;IACtB,aAAa,EAAE,MAAM,CAAC;IACtB,aAAa,EAAE,MAAM,CAAC;IACtB,eAAe,EAAE,MAAM,CAAC;IACxB,YAAY,EAAE,MAAM,CAAC;IACrB,gBAAgB,EAAE,MAAM,CAAC;IACzB,aAAa,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,QAAQ;IACvB,WAAW,EAAE,MAAM,CAAC;IACpB,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED,MAAM,WAAW,aAAa;IAC5B,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,QAAQ,CAAC;IACnB,OAAO,EAAE,OAAO,CAAC;IACjB,SAAS,EAAE,QAAQ,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,gBAAgB;IAC/B,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,aAAa,CAAC;IAC5B,aAAa,EAAE,aAAa,CAAC;IAC7B,OAAO,EAAE,MAAM,CAAC;IAChB,cAAc,EAAE,cAAc,CAAC;CAChC;AAED,MAAM,WAAW,oBAAoB;IACnC,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,qBAAqB;IACpC,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,MAAM,CAAC;IACf,eAAe,EAAE,MAAM,CAAC;IACxB,YAAY,EAAE,MAAM,CAAC;IACrB,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,MAAM,gBAAgB,GACxB,UAAU,CAAC,8BAA8B,GACzC,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,0BAA0B,GAC9C,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,WAAW,CAAC;AAEpC,oBAAY,kBAAkB;IAC5B,QAAQ,aAAa;IACrB,MAAM,WAAW;IACjB,KAAK,UAAU;IACf,WAAW,gBAAgB;IAC3B,QAAQ,aAAa;IACrB,eAAe,oBAAoB;CACpC;AAED,MAAM,WAAW,WAAW;IAC1B,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,EAAE,MAAM,CAAC;IACnB,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,WAAW,EAAE,UAAU,CAAC;CACzB;AAED,MAAM,WAAW,QAAQ;IACvB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,eAAe,EAAE,CAAC;IAC5B,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC,OAAO,CAAC,EAAE;QACR,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB,CAAC;CACH"}
+{"version":3,"file":"payment-source.type.d.ts","sourceRoot":"","sources":["../../../src/open-wallets/types/payment-source.type.ts"],"names":[],"mappings":";;AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,gCAAgC,CAAC;AACpE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAC9D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAC;AAClE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAChE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAC1D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAErD,MAAM,WAAW,iBAAiB;IAChC,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,UAAU,CAAC;CACxB;AAED,MAAM,WAAW,OAAO;IACtB,aAAa,EAAE,MAAM,CAAC;IACtB,aAAa,EAAE,MAAM,CAAC;IACtB,eAAe,EAAE,MAAM,CAAC;IACxB,YAAY,EAAE,MAAM,CAAC;IACrB,gBAAgB,EAAE,MAAM,CAAC;IACzB,aAAa,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,QAAQ;IACvB,WAAW,EAAE,MAAM,CAAC;IACpB,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED,MAAM,WAAW,aAAa;IAC5B,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,QAAQ,CAAC;IACnB,OAAO,EAAE,OAAO,CAAC;IACjB,SAAS,EAAE,QAAQ,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,gBAAgB;IAC/B,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,aAAa,CAAC;IAC5B,aAAa,EAAE,aAAa,CAAC;IAC7B,OAAO,EAAE,MAAM,CAAC;IAChB,cAAc,EAAE,cAAc,CAAC;CAChC;AAED,MAAM,WAAW,oBAAoB;IACnC,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,qBAAqB;IACpC,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,MAAM,CAAC;IACf,eAAe,EAAE,MAAM,CAAC;IACxB,YAAY,EAAE,MAAM,CAAC;IACrB,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,MAAM,gBAAgB,GACxB,UAAU,CAAC,8BAA8B,GACzC,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,0BAA0B,GAC9C,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,WAAW,CAAC;AAEpC,oBAAY,kBAAkB;IAC5B,QAAQ,aAAa;IACrB,MAAM,WAAW;IACjB,KAAK,UAAU;IACf,WAAW,gBAAgB;IAC3B,QAAQ,aAAa;IACrB,eAAe,oBAAoB;CACpC;AAED,MAAM,WAAW,WAAW;IAC1B,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,EAAE,MAAM,CAAC;IACnB,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,WAAW,EAAE,UAAU,CAAC;CACzB;AAED,MAAM,WAAW,QAAQ;IACvB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,eAAe,EAAE,CAAC;IAC5B,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC,OAAO,CAAC,EAAE;QACR,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB,CAAC;CACH"}

package/bundles/types/open-wallets/types/shipping-event-to-response.type.d.ts

@@ -2,5 +2,13 @@ import type { OnShippingAddressChangeEventData } from './on-shipping-address-cha
 import type { OnShippingAddressChangeEventResponse } from './on-shipping-address-change-event-response.interface';
 import type { OnShippingOptionChangeEventData } from './on-shipping-option-change-event-data.interface';
 import type { OnShippingOptionChangeEventResponse } from './on-shipping-option-change-event-response.interface';
+/**
+ * Conditional type that maps a shipping event data type to its corresponding response type.
+ *
+ * - `OnShippingAddressChangeEventData` maps to `OnShippingAddressChangeEventResponse`
+ * - `OnShippingOptionChangeEventData` maps to `OnShippingOptionChangeEventResponse`
+ *
+ * @template T - The shipping event data type.
+ */
 export type ShippingEventToResponse<T> = T extends OnShippingAddressChangeEventData ? OnShippingAddressChangeEventResponse : T extends OnShippingOptionChangeEventData ? OnShippingOptionChangeEventResponse : never;
 //# sourceMappingURL=shipping-event-to-response.type.d.ts.map

package/bundles/types/open-wallets/types/shipping-event-to-response.type.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"shipping-event-to-response.type.d.ts","sourceRoot":"","sources":["../../../src/open-wallets/types/shipping-event-to-response.type.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gCAAgC,EAAE,MAAM,mDAAmD,CAAC;AAC1G,OAAO,KAAK,EAAE,oCAAoC,EAAE,MAAM,uDAAuD,CAAC;AAClH,OAAO,KAAK,EAAE,+BAA+B,EAAE,MAAM,kDAAkD,CAAC;AACxG,OAAO,KAAK,EAAE,mCAAmC,EAAE,MAAM,sDAAsD,CAAC;AAEhH,MAAM,MAAM,uBAAuB,CAAC,CAAC,IAAI,CAAC,SAAS,gCAAgC,GAC/E,oCAAoC,GACpC,CAAC,SAAS,+BAA+B,GACvC,mCAAmC,GACnC,KAAK,CAAC"}
+{"version":3,"file":"shipping-event-to-response.type.d.ts","sourceRoot":"","sources":["../../../src/open-wallets/types/shipping-event-to-response.type.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gCAAgC,EAAE,MAAM,mDAAmD,CAAC;AAC1G,OAAO,KAAK,EAAE,oCAAoC,EAAE,MAAM,uDAAuD,CAAC;AAClH,OAAO,KAAK,EAAE,+BAA+B,EAAE,MAAM,kDAAkD,CAAC;AACxG,OAAO,KAAK,EAAE,mCAAmC,EAAE,MAAM,sDAAsD,CAAC;AAEhH;;;;;;;GAOG;AACH,MAAM,MAAM,uBAAuB,CAAC,CAAC,IAAI,CAAC,SAAS,gCAAgC,GAC/E,oCAAoC,GACpC,CAAC,SAAS,+BAA+B,GACvC,mCAAmC,GACnC,KAAK,CAAC"}