@paydock/client-sdk 1.104.6-beta → 1.104.9-beta

package/README.md

@@ -6378,20 +6378,20 @@ List of available event's name in the wallet button lifecycle
 | ON_CLICK | <code>string</code> | <code>&quot;onClick&quot;</code> | 
 
 
-# Secure Remote Commerce
+# Click To Pay
 
 ## Overview
 
-Integrate with Mastercard SRC using Paydock's Mastercard SRC widget.
-For a full description of the methods and parameters, reference the [README file](https://www.npmjs.com/package/@paydock/client-sdk#SRC).
+Integrate with Click To Pay using Paydock's Click To Pay widget.
+For a full description of the methods and parameters, reference the [README file](https://www.npmjs.com/package/@paydock/client-sdk#ClickToPay).
 
-## SRC simple example
+## Click To Pay simple example
 
 The following section provides an example use case and integration for the widget.
 
 ### Create a Container
 
-To integrate the SRC checkout iFrame, create a container in your HTML code. This container serves as the placeholder for the iFrame.
+To integrate the Click To Pay checkout iFrame, create a container in your HTML code. This container serves as the placeholder for the iFrame.
 
 ```html
 <div id="checkoutIframe"></div>
@@ -6402,7 +6402,7 @@ To integrate the SRC checkout iFrame, create a container in your HTML code. This
 Use the following code to initialize your widget:
 
 ```javascript
-var src = new paydock.MastercardSRCClickToPay(
+var src = new paydock.ClickToPay(
     "#checkoutIframe",
     "service_id",
     "paydock_public_key_or_access_token",
@@ -6413,8 +6413,8 @@ src.load();
 
 ```javascript
 // ES2015 | TypeScript
-import { MastercardSRCClickToPay } from '@paydock/client-sdk';
-var src = new MastercardSRCClickToPay(
+import { ClickToPay } from '@paydock/client-sdk';
+var src = new ClickToPay(
     "#checkoutIframe",
     "service_id",
     "paydock_public_key_or_access_token",
@@ -6441,7 +6441,7 @@ A full example of the container and the initialized widget is as follows:
     <div id="checkoutIframe"></div>
     <script src="https://widget.paydock.com/sdk/latest/widget.umd.min.js" ></script>
     <script>
-        var src = new paydock.MastercardSRCClickToPay(
+        var src = new paydock.ClickToPay(
             "#checkoutIframe",
             "service_id",
             "paydock_public_key_or_access_token",
@@ -6453,7 +6453,7 @@ A full example of the container and the initialized widget is as follows:
 </html>
 ```
 
-## Customize your SRC Checkout
+## Customize your Click To Pay Checkout
 
 The following is an advanced example that includes customization. You can use these methods to enhance your checkout experience.
 
@@ -6491,7 +6491,7 @@ src.on('checkoutError', (error) => {
     <div id="checkoutIframe"></div>
     <script src="https://widget.paydock.com/sdk/latest/widget.umd.min.js" ></script>
     <script>
-        var src = new paydock.MastercardSRCClickToPay(
+        var src = new paydock.ClickToPay(
             "#checkoutIframe",
             "service_id",
             "paydock_public_key_or_access_token",
@@ -6521,7 +6521,7 @@ To customize your billing address experience, Paydock uses a flag that manages w
 The options for this customization are NONE (default option), and POSTAL_COUNTRY or FULL.
 
 ```
-var src = new paydock.MastercardSRCClickToPay(
+var src = new paydock.ClickToPay(
     "#checkoutIframe",
     "service_id",
     "paydock_public_key_or_access_token",
@@ -6533,11 +6533,10 @@ var src = new paydock.MastercardSRCClickToPay(
 );
 ```
 
-The SRC checkout in the example requires the billing address from the customer, which is then returned as a part of the checkout data. The data is then stored and leveraged in the Paydock charge.
-You can also provide the billing address at the time of creating the charge. For example, if you have a different method for collecting the billing address, such as outside of the SRC checkout, you can provide it alongside other information at the charge creation step:
-
-1. Disable the billing address in Paydock's SRC widget.
-2. Get your One Time Token from the SRC widget alongside other details that may have been collected outside the SRC checkout as the shipping address.
+The Click To Pay checkout in the example requires the billing address from the customer, which is then returned as a part of the checkout data. The data is then stored and leveraged in the Paydock charge.
+You can also provide the billing address at the time of creating the charge. For example, if you have a different method for collecting the billing address, such as outside of the Click To Pay checkout, you can provide it alongside other information at the charge creation step:
+1. Disable the billing address in Paydock's Click To Pay widget.
+2. Get your One Time Token from the Click To Pay widget alongside other details that may have been collected outside the Click To Pay checkout as the shipping address.
 3. Send the billing address when creating the charge.
 
 ```
@@ -6578,7 +6577,7 @@ You can send a flag `unaccepted_card_type` to block the usage of a specific card
 The following example demonstrates how to block the card:
 
 ```
-var src = new paydock.MastercardSRCClickToPay(
+var src = new paydock.ClickToPay(
     "#checkoutIframe",
     "service_id",
     "paydock_public_key",
@@ -6595,7 +6594,7 @@ Customize the look and feel of your UI. The following example demonstrates chang
 ### Example code
 
 ```
-var src = new paydock.MastercardSRCClickToPay(
+var src = new paydock.ClickToPay(
     "#checkoutIframe",
     "service_id",
     "paydock_public_key",
@@ -6614,8 +6613,8 @@ src.setStyles({
 ## Classes
 
 <dl>
-<dt><a href="#MastercardSRCClickToPay">MastercardSRCClickToPay</a> ⇐ <code>SRC</code></dt>
-<dd><p>Class MastercardSRCClickToPay include methods for interacting with the MastercardSRC checkout and Manual Card option</p>
+<dt><a href="#ClickToPay">ClickToPay</a> ⇐ <code>SRC</code></dt>
+<dd><p>Class ClickToPay include methods for interacting with the ClickToPay checkout and Manual Card option</p>
 </dd>
 </dl>
 
@@ -6633,7 +6632,7 @@ src.setStyles({
 When the flow type is src, masked checkoutData available is also returned</p>
 </dd>
 <dt><a href="#IStyles">IStyles</a> : <code>object</code></dt>
-<dd><p>Interface for style configs inyected to the SRC checkout</p>
+<dd><p>Interface for style configs inyected to the Click to Pay checkout</p>
 </dd>
 </dl>
 
@@ -6662,7 +6661,7 @@ Interface of data used for the Mastercard Checkout. For further information refe
 | [dpa_data.dpa_supported_phone_number.phone_number] | <code>string</code> | The phone number part of the phone number. |
 | [dpa_data.dpa_support_uri] | <code>string</code> | URI for DPA support. |
 | [dpa_data.application_type] | <code>string</code> | Application type, either 'WEB_BROWSER' or 'MOBILE_APP'. |
-| [co_brand_names] | <code>Array.&lt;string&gt;</code> | List of co-brand names associated with the SRC experience. |
+| [co_brand_names] | <code>Array.&lt;string&gt;</code> | List of co-brand names associated with the Click to Pay experience. |
 | [checkout_experience] | <code>string</code> | Checkout experience type, either 'WITHIN_CHECKOUT' or 'PAYMENT_SETTINGS'. |
 | [services] | <code>string</code> | Services offered, such as 'INLINE_CHECKOUT' or 'INLINE_INSTALLMENTS'. |
 | [dpa_transaction_options] | <code>object</code> | Object that stores options for creating a transaction with DPA. |
@@ -6740,7 +6739,7 @@ When the flow type is src, masked checkoutData available is also returned
 <a name="IStyles" id="IStyles" href="#IStyles">&nbsp;</a>
 
 ## IStyles : <code>object</code>
-Interface for style configs inyected to the SRC checkout
+Interface for style configs inyected to the Click to Pay checkout
 
 **Kind**: global interface  
 
@@ -6751,19 +6750,19 @@ Interface for style configs inyected to the SRC checkout
 | [secondary_button_color] | <code>string</code> | Color Code for secondary button. |
 | [secondary_button_text_color] | <code>string</code> | Color Code for secondary button text. |
 | [font_family] | <code>string</code> | Font family to be used. |
-| [enable_src_popup] | <code>boolean</code> | Boolean flag to make the SRC checkout show in a popup window instead of embedded in iframe. |
+| [enable_src_popup] | <code>boolean</code> | Boolean flag to make the Click to Pay checkout show in a popup window instead of embedded in iframe. |
 
-<a name="MastercardSRCClickToPay" id="MastercardSRCClickToPay" href="#MastercardSRCClickToPay">&nbsp;</a>
+<a name="ClickToPay" id="ClickToPay" href="#ClickToPay">&nbsp;</a>
 
-## MastercardSRCClickToPay ⇐ <code>SRC</code>
-Class MastercardSRCClickToPay include methods for interacting with the MastercardSRC checkout and Manual Card option
+## ClickToPay ⇐ <code>SRC</code>
+Class ClickToPay include methods for interacting with the ClickToPay checkout and Manual Card option
 
 **Kind**: global class  
 **Extends**: <code>SRC</code>  
 
-* [MastercardSRCClickToPay](#MastercardSRCClickToPay) ⇐ <code>SRC</code>
-    * [new MastercardSRCClickToPay(iframe_selector, service_id, public_key_or_access_token, meta)](#new_MastercardSRCClickToPay_new)
-    * [.load()](#MastercardSRCClickToPay+load)
+* [ClickToPay](#ClickToPay) ⇐ <code>SRC</code>
+    * [new ClickToPay(iframe_selector, service_id, public_key_or_access_token, meta)](#new_ClickToPay_new)
+    * [.load()](#ClickToPay+load)
     * [.setStyles(fields)](#SRC+setStyles)
     * [.setEnv(env, [alias])](#SRC+setEnv)
     * [.getEnv()](#SRC+getEnv)
@@ -6773,33 +6772,33 @@ Class MastercardSRCClickToPay include methods for interacting with the Mastercar
     * [.reload()](#SRC+reload)
     * [.useAutoResize()](#SRC+useAutoResize)
 
-<a name="new_MastercardSRCClickToPay_new" id="new_MastercardSRCClickToPay_new" href="#new_MastercardSRCClickToPay_new">&nbsp;</a>
+<a name="new_ClickToPay_new" id="new_ClickToPay_new" href="#new_ClickToPay_new">&nbsp;</a>
 
-### new MastercardSRCClickToPay(iframe_selector, service_id, public_key_or_access_token, meta)
+### new ClickToPay(iframe_selector, service_id, public_key_or_access_token, meta)
 
 | Param | Type | Description |
 | --- | --- | --- |
-| iframe_selector | <code>string</code> | Selector of html element. Container for SRC checkout iFrame. |
+| iframe_selector | <code>string</code> | Selector of html element. Container for Click To Pay checkout iFrame. |
 | service_id | <code>string</code> | Card Scheme Service ID |
 | public_key_or_access_token | <code>string</code> | Paydock public key or Access Token |
-| meta | [<code>IMastercardSRCMeta</code>](#IMastercardSRCMeta) | Data that configures the SRC checkout |
+| meta | <code>IClickToPayMeta</code> | Data that configures the Click To Pay checkout |
 
 **Example**  
 ```js
-var mastercardSRC = new MastercardSRCClickToPay('#checkoutIframe', 'service_id', 'public_key', {});
+var mastercardSRC = new ClickToPay('#checkoutIframe', 'service_id', 'public_key', {});
 ```
-<a name="MastercardSRCClickToPay+load" id="MastercardSRCClickToPay+load" href="#MastercardSRCClickToPay+load">&nbsp;</a>
+<a name="ClickToPay+load" id="ClickToPay+load" href="#ClickToPay+load">&nbsp;</a>
 
-### mastercardSRCClickToPay.load()
-The final method after configuring the SRC to start the load process of SRC checkout
+### clickToPay.load()
+The final method after configuring the SRC to start the load process of Click To Pay checkout
 
-**Kind**: instance method of [<code>MastercardSRCClickToPay</code>](#MastercardSRCClickToPay)  
+**Kind**: instance method of [<code>ClickToPay</code>](#ClickToPay)  
 <a name="SRC+setStyles" id="SRC+setStyles" href="#SRC+setStyles">&nbsp;</a>
 
-### mastercardSRCClickToPay.setStyles(fields)
+### clickToPay.setStyles(fields)
 Object contain styles for widget - call before `.load()`.
 
-**Kind**: instance method of [<code>MastercardSRCClickToPay</code>](#MastercardSRCClickToPay)  
+**Kind**: instance method of [<code>ClickToPay</code>](#ClickToPay)  
 **Overrides**: [<code>setStyles</code>](#SRC+setStyles)  
 
 | Param | Type | Description |
@@ -6819,11 +6818,11 @@ widget.setStyles({
 ```
 <a name="SRC+setEnv" id="SRC+setEnv" href="#SRC+setEnv">&nbsp;</a>
 
-### mastercardSRCClickToPay.setEnv(env, [alias])
+### clickToPay.setEnv(env, [alias])
 Current method can change environment. By default environment = sandbox.
 Also we can change domain alias for this environment. By default domain_alias = paydock.com
 
-**Kind**: instance method of [<code>MastercardSRCClickToPay</code>](#MastercardSRCClickToPay)  
+**Kind**: instance method of [<code>ClickToPay</code>](#ClickToPay)  
 **Overrides**: [<code>setEnv</code>](#SRC+setEnv)  
 
 | Param | Type | Description |
@@ -6837,10 +6836,10 @@ SRC.setEnv('production');
 ```
 <a name="SRC+getEnv" id="SRC+getEnv" href="#SRC+getEnv">&nbsp;</a>
 
-### mastercardSRCClickToPay.getEnv()
+### clickToPay.getEnv()
 Method to read the current environment
 
-**Kind**: instance method of [<code>MastercardSRCClickToPay</code>](#MastercardSRCClickToPay)  
+**Kind**: instance method of [<code>ClickToPay</code>](#ClickToPay)  
 **Overrides**: [<code>getEnv</code>](#SRC+getEnv)  
 **Example**  
 ```js
@@ -6848,10 +6847,10 @@ SRC.getEnv();
 ```
 <a name="SRC+on" id="SRC+on" href="#SRC+on">&nbsp;</a>
 
-### mastercardSRCClickToPay.on(eventName, [cb]) ⇒ <code>Promise.&lt;any&gt;</code> \| <code>void</code>
+### clickToPay.on(eventName, [cb]) ⇒ <code>Promise.&lt;any&gt;</code> \| <code>void</code>
 Listen to events of SRC
 
-**Kind**: instance method of [<code>MastercardSRCClickToPay</code>](#MastercardSRCClickToPay)  
+**Kind**: instance method of [<code>ClickToPay</code>](#ClickToPay)  
 **Overrides**: [<code>on</code>](#SRC+on)  
 
 | Param | Type | Description |
@@ -6871,10 +6870,10 @@ SRC.on('checkoutCompleted').then(function (token) {
 ```
 <a name="SRC+hideCheckout" id="SRC+hideCheckout" href="#SRC+hideCheckout">&nbsp;</a>
 
-### mastercardSRCClickToPay.hideCheckout([saveSize])
+### clickToPay.hideCheckout([saveSize])
 Using this method you can hide checkout after load and button click
 
-**Kind**: instance method of [<code>MastercardSRCClickToPay</code>](#MastercardSRCClickToPay)  
+**Kind**: instance method of [<code>ClickToPay</code>](#ClickToPay)  
 **Overrides**: [<code>hideCheckout</code>](#SRC+hideCheckout)  
 
 | Param | Type | Default | Description |
@@ -6887,10 +6886,10 @@ SRC.hideCheckout();
 ```
 <a name="SRC+showCheckout" id="SRC+showCheckout" href="#SRC+showCheckout">&nbsp;</a>
 
-### mastercardSRCClickToPay.showCheckout()
+### clickToPay.showCheckout()
 Using this method you can show checkout after using hideCheckout method
 
-**Kind**: instance method of [<code>MastercardSRCClickToPay</code>](#MastercardSRCClickToPay)  
+**Kind**: instance method of [<code>ClickToPay</code>](#ClickToPay)  
 **Overrides**: [<code>showCheckout</code>](#SRC+showCheckout)  
 **Example**  
 ```js
@@ -6898,10 +6897,10 @@ SRC.showCheckout()
 ```
 <a name="SRC+reload" id="SRC+reload" href="#SRC+reload">&nbsp;</a>
 
-### mastercardSRCClickToPay.reload()
+### clickToPay.reload()
 Using this method you can reload the whole checkout
 
-**Kind**: instance method of [<code>MastercardSRCClickToPay</code>](#MastercardSRCClickToPay)  
+**Kind**: instance method of [<code>ClickToPay</code>](#ClickToPay)  
 **Overrides**: [<code>reload</code>](#SRC+reload)  
 **Example**  
 ```js
@@ -6909,10 +6908,10 @@ SRC.reload()
 ```
 <a name="SRC+useAutoResize" id="SRC+useAutoResize" href="#SRC+useAutoResize">&nbsp;</a>
 
-### mastercardSRCClickToPay.useAutoResize()
+### clickToPay.useAutoResize()
 Use this method for resize checkout iFrame according to content height, if applicable
 
-**Kind**: instance method of [<code>MastercardSRCClickToPay</code>](#MastercardSRCClickToPay)  
+**Kind**: instance method of [<code>ClickToPay</code>](#ClickToPay)  
 **Overrides**: [<code>useAutoResize</code>](#SRC+useAutoResize)  
 **Example**  
 ```js
@@ -6921,7 +6920,7 @@ SRC.useAutoResize();
 <a name="EVENT" id="EVENT" href="#EVENT">&nbsp;</a>
 
 ## EVENT : <code>enum</code>
-List of available event's name in the SRC checkout lifecycle
+List of available event's name in the Click To Pay checkout lifecycle
 
 **Kind**: global enum  
 
@@ -6929,8 +6928,8 @@ List of available event's name in the SRC checkout lifecycle
 | --- | --- | --- | --- |
 | IFRAME_LOADED | <code>string</code> | <code>&quot;iframeLoaded&quot;</code> | Initial event sent when IFrame is initially loaded. |
 | CHECKOUT_READY | <code>string</code> | <code>&quot;checkoutReady&quot;</code> | Event sent when checkout is loaded and ready to be used by customer. Leverage alongside [showCheckout](#SRC+showCheckout) and [hideCheckout](#SRC+hideCheckout). |
-| CHECKOUT_POPUP_OPEN | <code>string</code> | <code>&quot;checkoutPopupOpen&quot;</code> | Event sent when SRC Checkout flow is started, regardless of embedded or windowed mode. |
-| CHECKOUT_POPUP_CLOSE | <code>string</code> | <code>&quot;checkoutPopupClose&quot;</code> | Event sent when SRC Checkout flow is closed, regardless of embedded or windowed mode. |
+| CHECKOUT_POPUP_OPEN | <code>string</code> | <code>&quot;checkoutPopupOpen&quot;</code> | Event sent when Click To Pay checkout flow is started, regardless of embedded or windowed mode. |
+| CHECKOUT_POPUP_CLOSE | <code>string</code> | <code>&quot;checkoutPopupClose&quot;</code> | Event sent when Click To Pay checkout flow is closed, regardless of embedded or windowed mode. |
 | CHECKOUT_COMPLETED | <code>string</code> | <code>&quot;checkoutCompleted&quot;</code> | Event sent on successful checkout by customer. Check [data](#EventDataCheckoutCompletedData) for more information. |
 | CHECKOUT_ERROR | <code>string</code> | <code>&quot;checkoutError&quot;</code> | Event sent on error checkout by customer. Check [data](#EventData) for more information. |