@paydock/client-sdk 1.10.72-beta → 1.10.76-beta

package/README.md

@@ -4603,10 +4603,42 @@ After you initialized the 3ds charge via `v1/charges/standalone-3ds` API endpoin
 </html>
 ```
 
-**The chargeAuthSuccess event is executed both for frictionless flow, or for challenge flow after the customer has correctly authenticated with the bank using whatever challenge imposed.**
-**The chargeAuthChallenge event is sent before starting a challenge flow (i.e. opening an IFrame for the customer to complete a challenge with ther bank)**
-**The chargeAuthDecoupled event is sent when the flow is a decoupled challenge, alongside a `data.result.description` field that you must show to the customer, indicating the method the user must use to authenticate. For example this may happen by having the cardholder authenticating directly with their banking app through biometrics. Once the end customer does this, the Canvas3ds will be able to recognize the challenge result is ready and will either produce a chargeAuthSuccess or chargeAuthReject event**
-**The error event is sent if an unexpected issue with the client library occurs. In such scenarios, you should consider the autentication process as interrupted**
+The chargeAuthSuccess event is executed both for frictionless flow, or for challenge flow after the customer has correctly authenticated with the bank using whatever challenge imposed.
+The chargeAuthChallenge event is sent before starting a challenge flow (i.e. opening an IFrame for the customer to complete a challenge with ther bank)
+The chargeAuthDecoupled event is sent when the flow is a decoupled challenge, alongside a `data.result.description` field that you must show to the customer, indicating the method the user must use to authenticate. For example this may happen by having the cardholder authenticating directly with their banking app through biometrics. Once the end customer does this, the Canvas3ds will be able to recognize the challenge result is ready and will either produce a chargeAuthSuccess or chargeAuthReject event
+The error event is sent if an unexpected issue with the client library occurs. In such scenarios, you should consider the autentication process as interrupted
+
+### Event and Values
+
+| Event Value         | Type                | Description                                                    |
+| ------------------- | ------------------- | -------------------------------------------------------------- |
+| chargeAuthSuccess   | <code>object</code> | Instance of [ChargeEventResponse](#cb_chargeEventResponse) |
+| chargeAuthReject    | <code>object</code> | Instance of [ChargeEventResponse](#cb_chargeEventResponse)       |
+| chargeAuthChallenge | <code>object</code> | Instance of [ChargeEventResponse](#cb_chargeEventResponse)       |
+| chargeAuthDecoupled | <code>object</code> | Instance of [ChargeEventResponse](#cb_chargeEventResponse)       |
+| error               | <code>object</code> | Instance of [chargeError](#cb_chargeError)                     |
+
+## Response Values
+
+<a name="cb_chargeEventResponse" id="cb_chargeEventResponse"></a>
+
+### ChargeEventResponse
+
+| Param                           | Type                           | Description                                                                                        |
+| ------------------------------- | ------------------------------ | -------------------------------------------------------------------------------------------------- |
+| status                          | <code>string</code>            | status for the event transaction                                                                   |
+| charge_3ds_id                   | <code>string</code>            | Universal unique transaction identifier to identify the transaction                                |
+| <code>result.description</code> | <code>string</code> [Optional] | field that you must show to the customer, indicating the method the user must use to authenticate. |
+
+### ChargeError
+
+<a name="cb_chargeError" id="cb_chargeError"></a>
+
+| Param         | Type                | Description                                                         |
+| ------------- | ------------------- | ------------------------------------------------------------------- |
+| error         | <code>object</code> | error response                                                      |
+| charge_3ds_id | <code>string</code> | Universal unique transaction identifier to identify the transaction |
+
 
 ## Vault Display Widget
 You can find description of all methods and parameters [here](https://www.npmjs.com/package/@paydock/client-sdk#vault-display-widget)
@@ -4858,8 +4890,14 @@ The final method to beginning, the load process of widget to html
 <dt><a href="#IWalletMeta">IWalletMeta</a> : <code>object</code></dt>
 <dd><p>Interface of data used by the wallet checkout and payment proccess.</p>
 </dd>
-<dt><a href="#IShippingOption">IShippingOption</a> : <code>object</code></dt>
-<dd><p>Interface of Shipping Options.</p>
+<dt><a href="#IApplePayShippingOption">IApplePayShippingOption</a> : <code>object</code></dt>
+<dd><p>Interface of Shipping Options for ApplePay</p>
+</dd>
+<dt><a href="#IGooglePayShippingOption">IGooglePayShippingOption</a> : <code>object</code></dt>
+<dd><p>Interface of Shipping Options for GooglePay</p>
+</dd>
+<dt><a href="#IPayPalShippingOption">IPayPalShippingOption</a> : <code>object</code></dt>
+<dd><p>Interface of Shipping Options for PayPal</p>
 </dd>
 </dl>
 
@@ -4872,23 +4910,25 @@ Interface of data used by the wallet checkout and payment proccess.
 
 | Param | Type | Description |
 | --- | --- | --- |
-| [amount_label] | <code>string</code> | Label shown next to the total amount to be paid. Required for [Stripe, ApplePay]. N/A for [FlyPay, PayPal]. |
-| [country] | <code>string</code> | Country of the user. 2 letter ISO code format. Required for [Stripe, ApplePay]. N/A for [FlyPay, PayPal]. |
+| [amount_label] | <code>string</code> | Label shown next to the total amount to be paid. Required for [Stripe, ApplePay, GooglePay]. N/A for [FlyPay, PayPal]. |
+| [country] | <code>string</code> | Country of the user. 2 letter ISO code format. Required for [Stripe, ApplePay, GooglePay]. N/A for [FlyPay, PayPal]. |
 | [pay_later] | <code>string</code> | Used to enable Pay Later feature in PayPal Smart Checkout WalletButton integration when available. Optional for [PayPal]. N/A for other wallets. |
+| [show_billing_address] | <code>boolean</code> | Used to hide/show the billing address on ApplePay and GooglePay popups. Default value is false. Optional for [ApplePay, GooglePay]. N/A for other wallets. |
 | [request_payer_name] | <code>boolean</code> | Used mainly for fraud purposes - recommended set to true. Optional for [Stripe]. N/A for other wallets. |
 | [request_payer_email] | <code>boolean</code> | Used mainly for fraud purposes - recommended set to true. Optional for [Stripe]. N/A for other wallets. |
 | [request_payer_phone] | <code>boolean</code> | Used mainly for fraud purposes - recommended set to true. Optional for [Stripe]. N/A for other wallets. |
-| [request_shipping] | <code>boolean</code> | Used to request or not shipping address in the Wallet checkout, being able to handle amount changes via the `update` event. Optional for [FlyPay, PayPal, ApplePay]. N/A for [Stripe]. |
-| [shipping_options] | [<code>[ &#x27;Array&#x27; ].&lt;IShippingOption&gt;</code>](#IShippingOption) | Used to provide available shipping options. Optional for [ApplePay]. N/A for the other wallets. |
+| [request_shipping] | <code>boolean</code> | Used to request or not shipping address in the Wallet checkout, being able to handle amount changes via the `update` event. Optional for [FlyPay, PayPal, ApplePay, GooglePay]. N/A for [Stripe]. |
+| [shipping_options] | [<code>Array.&lt;IApplePayShippingOption&gt;</code>](#IApplePayShippingOption) \| [<code>Array.&lt;IPayPalShippingOption&gt;</code>](#IPayPalShippingOption) | Used to provide available shipping options.(To use shipping_options the request_shipping flag should be true). Optional for [ApplePay]. N/A for the other wallets. |
+| [merchant_name] | <code>string</code> | Merchant Name used for GooglePay integration via MPGS. Required for [GooglePay]. N/A for other wallets. |
 | [raw_data_initialization] | <code>object</code> | Used to provide values to initialize wallet with raw data. Optional for [ApplePay]. N/A for the other wallets. |
 | [style] | <code>object</code> | Used to style PayPal buttons, check possible values at https://developer.paypal.com/docs/business/checkout/reference/style-guide. Also used at ApplePay to select button type. Optional for [PayPal, ApplePay]. N/A for [Stripe, FlyPay]. |
 | [style.button_type] | <code>object</code> | Used to select ApplePay button type (e.g: 'buy','donate', etc), check possible values at https://developer.apple.com/documentation/apple_pay_on_the_web/displaying_apple_pay_buttons_using_css. Optional for [ApplePay]. N/A for other wallets. |
-| [wallets] | <code>array</code> | By default if this is not sent or empty, we will try to show either Apple Pay or Google Pay buttons. This can be limited sending the following array in this field: ['apple','google]. Optional for [Stripe]. N/A for other wallets. |
+| [wallets] | <code>array</code> | By default if this is not sent or empty, we will try to show either Apple Pay or Google Pay buttons. This can be limited sending the following array in this field: ['apple','google]. Optional for [Stripe, ApplePay, GooglePay]. N/A for other wallets. |
 
-<a name="IShippingOption" id="IShippingOption"></a>
+<a name="IApplePayShippingOption" id="IApplePayShippingOption"></a>
 
-## IShippingOption : <code>object</code>
-Interface of Shipping Options.
+## IApplePayShippingOption : <code>object</code>
+Interface of Shipping Options for ApplePay
 
 **Kind**: global interface  
 
@@ -4897,9 +4937,37 @@ Interface of Shipping Options.
 | [id] | <code>string</code> | Identifier of the Shipping Option. Required. |
 | [label] | <code>string</code> | Identifier of the Shipping Option. Required. |
 | [amount] | <code>string</code> | Amount of the Shipping Option. Required. |
+| [detail] | <code>string</code> | Details of the Shipping Option. Required. |
+| [type] | <code>string</code> | Type of the Shipping Option. Values can be 'ELECTRONIC', 'GROUND', 'NOT_SHIPPED', 'OVERNIGHT', 'PICKUP', 'PRIORITY', 'SAME_DAY'. Optional. |
+
+<a name="IGooglePayShippingOption" id="IGooglePayShippingOption"></a>
+
+## IGooglePayShippingOption : <code>object</code>
+Interface of Shipping Options for GooglePay
+
+**Kind**: global interface  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| [id] | <code>string</code> | Identifier of the Shipping Option. Required. |
+| [label] | <code>string</code> | Identifier of the Shipping Option. Required. |
 | [detail] | <code>string</code> | Details of the Shipping Option. Optional. |
-| [currency] | <code>string</code> | Currency of the Shipping Option. Optional. |
-| [type] | <code>string</code> | Type of the Shipping Option. Optional. |
+| [type] | <code>string</code> | Type of the Shipping Option. Values can be 'ELECTRONIC', 'GROUND', 'NOT_SHIPPED', 'OVERNIGHT', 'PICKUP', 'PRIORITY', 'SAME_DAY'. Optional. |
+
+<a name="IPayPalShippingOption" id="IPayPalShippingOption"></a>
+
+## IPayPalShippingOption : <code>object</code>
+Interface of Shipping Options for PayPal
+
+**Kind**: global interface  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| [id] | <code>string</code> | Identifier of the Shipping Option. Required. |
+| [label] | <code>string</code> | Identifier of the Shipping Option. Required. |
+| [amount] | <code>string</code> | Amount of the Shipping Option. Required. |
+| [currency] | <code>string</code> | Currency of the Shipping Option. Required. |
+| [type] | <code>string</code> | Type of the Shipping Option. Values can be 'SHIPPING' or 'PICKUP'. Required. |
 
 <a name="WalletButtons" id="WalletButtons"></a>
 
@@ -4958,7 +5026,7 @@ var button = new WalletButtons(
 
 ### walletButtons.update()
 Triggers the update process of the wallet, if available.
-Currently supported by Flypay, Paypal and ApplePay via MPGS Wallets.
+Currently supported by Flypay, Paypal and ApplePay/GooglePay via MPGS Wallets.
 
 **Kind**: instance method of [<code>WalletButtons</code>](#WalletButtons)  
 **Example**  
@@ -5069,6 +5137,7 @@ button.on('unavailable').then(function () {
 
 ### walletButtons.onUnavailable([handler])
 User to subscribe to the no button available event. This method is used after loading when the button is not available.
+For MPGS, since can have more than one wallet button configured (ApplePay/GooglePay) you will receive a body (({ wallet: WALLET_TYPE.GOOGLE }) or ({ wallet: WALLET_TYPE.APPLE })) indicating which button is unavailable
 Important: Do not perform thread blocking operations in callback such as window.alert() calls.
 
 **Kind**: instance method of [<code>WalletButtons</code>](#WalletButtons)  
@@ -5087,6 +5156,10 @@ button.onUnavailable(() => {
 ```js
 button.onUnavailable().then(() => console.log('No wallet buttons available'));
 ```
+**Example**  
+```js
+button.onUnavailable(function (data) {console.log('data.wallet :: ', data.wallet)});
+```
 <a name="WalletButtons+onUpdate" id="WalletButtons+onUpdate"></a>
 
 ### walletButtons.onUpdate([handler])