@paydock/client-sdk 1.127.1-beta → 1.131.0-beta

package/docs/api-checkout-button.md

@@ -7,12 +7,6 @@
 <dt><a href="#user-content-cb_ZipmoneyCheckoutButton">ZipmoneyCheckoutButton</a> ⇐ <code><a href="#user-content-cb_CheckoutButton">CheckoutButton</a></code></dt>
 <dd><p>Class ZipmoneyCheckoutButton is wrapper of CheckoutButton transform usual button into checkout</p>
 </dd>
-<dt><a href="#user-content-cb_PaypalCheckoutButton">PaypalCheckoutButton</a> ⇐ <code><a href="#user-content-cb_CheckoutButton">CheckoutButton</a></code></dt>
-<dd><p>Class PaypalCheckoutButton is wrapper of CheckoutButton transform usual button into checkout</p>
-</dd>
-<dt><a href="#user-content-cb_AfterpayCheckoutButton">AfterpayCheckoutButton</a> ⇐ <code><a href="#user-content-cb_CheckoutButton">CheckoutButton</a></code></dt>
-<dd><p>Class AfterpayCheckoutButton is wrapper of CheckoutButton transform usual button into checkout</p>
-</dd>
 </dl>
 
 ## Members
@@ -502,370 +496,6 @@ Only for 'contextual' mode.
 **Overrides**: [<code>turnOffBackdrop</code>](#user-content-cb_CheckoutButton+turnOffBackdrop)  
 **Example**  
 
-```javascript
-button.turnOffBackdrop();
-```
-<a name="cb_PaypalCheckoutButton" id="cb_PaypalCheckoutButton" href="#user-content-cb_PaypalCheckoutButton">&nbsp;</a>
-
-## PaypalCheckoutButton ⇐ [<code>CheckoutButton</code>](#user-content-cb_CheckoutButton)
-Class PaypalCheckoutButton is wrapper of CheckoutButton transform usual button into checkout
-
-**Kind**: global class  
-**Extends**: [<code>CheckoutButton</code>](#user-content-cb_CheckoutButton)  
-
-* [PaypalCheckoutButton](#user-content-cb_PaypalCheckoutButton) ⇐ [<code>CheckoutButton</code>](#user-content-cb_CheckoutButton)
-    * [new PaypalCheckoutButton(selector, publicKey, [gatewayId])](#user-content-cb_new_PaypalCheckoutButton_new)
-    * [.on(eventName, cb)](#user-content-cb_CheckoutButton+on)
-    * [.close()](#user-content-cb_CheckoutButton+close)
-    * [.onFinishInsert(selector, dataType)](#user-content-cb_CheckoutButton+onFinishInsert)
-    * [.setMeta(meta)](#user-content-cb_CheckoutButton+setMeta)
-    * [.setBackdropDescription(text)](#user-content-cb_CheckoutButton+setBackdropDescription)
-    * [.setBackdropTitle(string)](#user-content-cb_CheckoutButton+setBackdropTitle)
-    * [.setSuspendedRedirectUri(string)](#user-content-cb_CheckoutButton+setSuspendedRedirectUri)
-    * [.setRedirectUrl(string)](#user-content-cb_CheckoutButton+setRedirectUrl)
-    * [.turnOffBackdrop()](#user-content-cb_CheckoutButton+turnOffBackdrop)
-
-<a name="cb_new_PaypalCheckoutButton_new" id="cb_new_PaypalCheckoutButton_new" href="#user-content-cb_new_PaypalCheckoutButton_new">&nbsp;</a>
-
-### new PaypalCheckoutButton(selector, publicKey, [gatewayId])
-
-| Param | Type | Default | Description |
-| --- | --- | --- | --- |
-| selector | <code>string</code> |  | Selector of html element. |
-| publicKey | <code>string</code> |  | PayDock users public key |
-| [gatewayId] | <code>string</code> | <code>&quot;default&quot;</code> | PayDock's gatewayId. By default or if put 'default', it will use the selected default gateway |
-
-**Example**  
-
-```javascript
-var widget = new PaypalCheckoutButton('#button', 'publicKey','gatewayId');
-```
-<a name="cb_CheckoutButton+on" id="cb_CheckoutButton+on" href="#user-content-cb_CheckoutButton+on">&nbsp;</a>
-
-### paypalCheckoutButton.on(eventName, cb)
-Listen to events of widget
-
-**Kind**: instance method of [<code>PaypalCheckoutButton</code>](#user-content-cb_PaypalCheckoutButton)  
-**Overrides**: [<code>on</code>](#user-content-cb_CheckoutButton+on)  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| eventName | <code>string</code> | Available event names [CHECKOUT_BUTTON_EVENT](#user-content-cb_CHECKOUT_BUTTON_EVENT) |
-| cb | [<code>listener</code>](#user-content-cb_listener) |  |
-
-**Example**  
-
-```javascript
-widget.on('click', function () {
-
-});
-```
-<a name="cb_CheckoutButton+close" id="cb_CheckoutButton+close" href="#user-content-cb_CheckoutButton+close">&nbsp;</a>
-
-### paypalCheckoutButton.close()
-Close popup window forcibly.
-Only for 'contextual' mode.
-
-**Kind**: instance method of [<code>PaypalCheckoutButton</code>](#user-content-cb_PaypalCheckoutButton)  
-**Overrides**: [<code>close</code>](#user-content-cb_CheckoutButton+close)  
-<a name="cb_CheckoutButton+onFinishInsert" id="cb_CheckoutButton+onFinishInsert" href="#user-content-cb_CheckoutButton+onFinishInsert">&nbsp;</a>
-
-### paypalCheckoutButton.onFinishInsert(selector, dataType)
-After finish event of checkout button, data (dataType) will be insert to input (selector)
-
-**Kind**: instance method of [<code>PaypalCheckoutButton</code>](#user-content-cb_PaypalCheckoutButton)  
-**Overrides**: [<code>onFinishInsert</code>](#user-content-cb_CheckoutButton+onFinishInsert)  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| selector | <code>string</code> | css selector . [] # |
-| dataType | <code>string</code> | data type of IEventCheckoutFinishData [IEventCheckoutFinishData](#user-content-cb_IEventCheckoutFinishData). |
-
-<a name="cb_CheckoutButton+setMeta" id="cb_CheckoutButton+setMeta" href="#user-content-cb_CheckoutButton+setMeta">&nbsp;</a>
-
-### paypalCheckoutButton.setMeta(meta)
-Method for setting meta information for checkout page
-
-**Kind**: instance method of [<code>PaypalCheckoutButton</code>](#user-content-cb_PaypalCheckoutButton)  
-**Overrides**: [<code>setMeta</code>](#user-content-cb_CheckoutButton+setMeta)  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| meta | [<code>IPayPalMeta</code>](#user-content-cb_IPayPalMeta) \| [<code>IAfterpayMeta</code>](#user-content-cb_IAfterpayMeta) \| [<code>IZipmoneyMeta</code>](#user-content-cb_IZipmoneyMeta) | Data which can be shown on checkout page [IPayPalMeta](#user-content-cb_IPayPalMeta) [IZipmoneyMeta](#user-content-cb_IZipmoneyMeta) [IAfterpayMeta](#user-content-cb_IAfterpayMeta) |
-
-**Example**  
-
-```javascript
-button.setMeta({
-            brand_name: 'paydock',
-            reference: '15',
-            email: 'wault@paydock.com'
-        });
-```
-<a name="cb_CheckoutButton+setBackdropDescription" id="cb_CheckoutButton+setBackdropDescription" href="#user-content-cb_CheckoutButton+setBackdropDescription">&nbsp;</a>
-
-### paypalCheckoutButton.setBackdropDescription(text)
-Method for setting backdrop description.
-Only for 'contextual' mode.
-
-**Kind**: instance method of [<code>PaypalCheckoutButton</code>](#user-content-cb_PaypalCheckoutButton)  
-**Overrides**: [<code>setBackdropDescription</code>](#user-content-cb_CheckoutButton+setBackdropDescription)  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| text | <code>string</code> | description which can be shown in overlay of back side checkout page |
-
-**Example**  
-
-```javascript
-button.setBackdropDescription('Custom description');
-```
-<a name="cb_CheckoutButton+setBackdropTitle" id="cb_CheckoutButton+setBackdropTitle" href="#user-content-cb_CheckoutButton+setBackdropTitle">&nbsp;</a>
-
-### paypalCheckoutButton.setBackdropTitle(string)
-Method for setting backdrop title.
-Only for 'contextual' mode.
-
-**Kind**: instance method of [<code>PaypalCheckoutButton</code>](#user-content-cb_PaypalCheckoutButton)  
-**Overrides**: [<code>setBackdropTitle</code>](#user-content-cb_CheckoutButton+setBackdropTitle)  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| string | <code>text</code> | title which can be shown in overlay of back side checkout page |
-
-**Example**  
-
-```javascript
-button.setBackdropTitle('Custom title');
-```
-<a name="cb_CheckoutButton+setSuspendedRedirectUri" id="cb_CheckoutButton+setSuspendedRedirectUri" href="#user-content-cb_CheckoutButton+setSuspendedRedirectUri">&nbsp;</a>
-
-### paypalCheckoutButton.setSuspendedRedirectUri(string)
-Method for setting suspended redirect uri. Redirect after referred checkout.
-Only for 'contextual' mode.
-
-**Kind**: instance method of [<code>PaypalCheckoutButton</code>](#user-content-cb_PaypalCheckoutButton)  
-**Overrides**: [<code>setSuspendedRedirectUri</code>](#user-content-cb_CheckoutButton+setSuspendedRedirectUri)  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| string | <code>uri</code> | uri for redirect (by default) |
-
-<a name="cb_CheckoutButton+setRedirectUrl" id="cb_CheckoutButton+setRedirectUrl" href="#user-content-cb_CheckoutButton+setRedirectUrl">&nbsp;</a>
-
-### paypalCheckoutButton.setRedirectUrl(string)
-Method for setting the merchant redirect URL.
-Merchant's customers redirect after successfull checkout.
-Only for 'redirect' mode.
-
-**Kind**: instance method of [<code>PaypalCheckoutButton</code>](#user-content-cb_PaypalCheckoutButton)  
-**Overrides**: [<code>setRedirectUrl</code>](#user-content-cb_CheckoutButton+setRedirectUrl)  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| string | <code>url</code> | redirect url |
-
-<a name="cb_CheckoutButton+turnOffBackdrop" id="cb_CheckoutButton+turnOffBackdrop" href="#user-content-cb_CheckoutButton+turnOffBackdrop">&nbsp;</a>
-
-### paypalCheckoutButton.turnOffBackdrop()
-Method for disable backdrop on the page.
-Only for 'contextual' mode.
-
-**Kind**: instance method of [<code>PaypalCheckoutButton</code>](#user-content-cb_PaypalCheckoutButton)  
-**Overrides**: [<code>turnOffBackdrop</code>](#user-content-cb_CheckoutButton+turnOffBackdrop)  
-**Example**  
-
-```javascript
-button.turnOffBackdrop();
-```
-<a name="cb_AfterpayCheckoutButton" id="cb_AfterpayCheckoutButton" href="#user-content-cb_AfterpayCheckoutButton">&nbsp;</a>
-
-## AfterpayCheckoutButton ⇐ [<code>CheckoutButton</code>](#user-content-cb_CheckoutButton)
-Class AfterpayCheckoutButton is wrapper of CheckoutButton transform usual button into checkout
-
-**Kind**: global class  
-**Extends**: [<code>CheckoutButton</code>](#user-content-cb_CheckoutButton)  
-
-* [AfterpayCheckoutButton](#user-content-cb_AfterpayCheckoutButton) ⇐ [<code>CheckoutButton</code>](#user-content-cb_CheckoutButton)
-    * [new AfterpayCheckoutButton(selector, accessToken, [gatewayId])](#user-content-cb_new_AfterpayCheckoutButton_new)
-    * [.showEnhancedTrackingProtectionPopup(boolean)](#user-content-cb_AfterpayCheckoutButton+showEnhancedTrackingProtectionPopup)
-    * [.on(eventName, cb)](#user-content-cb_CheckoutButton+on)
-    * [.close()](#user-content-cb_CheckoutButton+close)
-    * [.onFinishInsert(selector, dataType)](#user-content-cb_CheckoutButton+onFinishInsert)
-    * [.setMeta(meta)](#user-content-cb_CheckoutButton+setMeta)
-    * [.setBackdropDescription(text)](#user-content-cb_CheckoutButton+setBackdropDescription)
-    * [.setBackdropTitle(string)](#user-content-cb_CheckoutButton+setBackdropTitle)
-    * [.setSuspendedRedirectUri(string)](#user-content-cb_CheckoutButton+setSuspendedRedirectUri)
-    * [.setRedirectUrl(string)](#user-content-cb_CheckoutButton+setRedirectUrl)
-    * [.turnOffBackdrop()](#user-content-cb_CheckoutButton+turnOffBackdrop)
-
-<a name="cb_new_AfterpayCheckoutButton_new" id="cb_new_AfterpayCheckoutButton_new" href="#user-content-cb_new_AfterpayCheckoutButton_new">&nbsp;</a>
-
-### new AfterpayCheckoutButton(selector, accessToken, [gatewayId])
-
-| Param | Type | Default | Description |
-| --- | --- | --- | --- |
-| selector | <code>string</code> |  | Selector of html element. |
-| accessToken | <code>string</code> |  | PayDock access-token or users public key |
-| [gatewayId] | <code>string</code> | <code>&quot;default&quot;</code> | PayDock's gatewayId. By default or if put 'default', it will use the selected default gateway |
-
-**Example**  
-
-```javascript
-var widget = new AfterpayCheckoutButton('#button', 'access-token','gatewayId');
-```
-<a name="cb_AfterpayCheckoutButton+showEnhancedTrackingProtectionPopup" id="cb_AfterpayCheckoutButton+showEnhancedTrackingProtectionPopup" href="#user-content-cb_AfterpayCheckoutButton+showEnhancedTrackingProtectionPopup">&nbsp;</a>
-
-### afterpayCheckoutButton.showEnhancedTrackingProtectionPopup(boolean)
-Method which toggles the "Enhanced Tracking Protection" warning popup to 'on' mode.
-
-This popup with a warning about "Enhanced Tracking Protection" limitations
-would be shown in the Mozilla Firefox browser version 100+
-
-By default, the popup would not be shown, until
-the flag would be set to `true`
-
-**Kind**: instance method of [<code>AfterpayCheckoutButton</code>](#user-content-cb_AfterpayCheckoutButton)  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| boolean | <code>doShow</code> | flag which toggle the popup visibility |
-
-<a name="cb_CheckoutButton+on" id="cb_CheckoutButton+on" href="#user-content-cb_CheckoutButton+on">&nbsp;</a>
-
-### afterpayCheckoutButton.on(eventName, cb)
-Listen to events of widget
-
-**Kind**: instance method of [<code>AfterpayCheckoutButton</code>](#user-content-cb_AfterpayCheckoutButton)  
-**Overrides**: [<code>on</code>](#user-content-cb_CheckoutButton+on)  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| eventName | <code>string</code> | Available event names [CHECKOUT_BUTTON_EVENT](#user-content-cb_CHECKOUT_BUTTON_EVENT) |
-| cb | [<code>listener</code>](#user-content-cb_listener) |  |
-
-**Example**  
-
-```javascript
-widget.on('click', function () {
-
-});
-```
-<a name="cb_CheckoutButton+close" id="cb_CheckoutButton+close" href="#user-content-cb_CheckoutButton+close">&nbsp;</a>
-
-### afterpayCheckoutButton.close()
-Close popup window forcibly.
-Only for 'contextual' mode.
-
-**Kind**: instance method of [<code>AfterpayCheckoutButton</code>](#user-content-cb_AfterpayCheckoutButton)  
-**Overrides**: [<code>close</code>](#user-content-cb_CheckoutButton+close)  
-<a name="cb_CheckoutButton+onFinishInsert" id="cb_CheckoutButton+onFinishInsert" href="#user-content-cb_CheckoutButton+onFinishInsert">&nbsp;</a>
-
-### afterpayCheckoutButton.onFinishInsert(selector, dataType)
-After finish event of checkout button, data (dataType) will be insert to input (selector)
-
-**Kind**: instance method of [<code>AfterpayCheckoutButton</code>](#user-content-cb_AfterpayCheckoutButton)  
-**Overrides**: [<code>onFinishInsert</code>](#user-content-cb_CheckoutButton+onFinishInsert)  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| selector | <code>string</code> | css selector . [] # |
-| dataType | <code>string</code> | data type of IEventCheckoutFinishData [IEventCheckoutFinishData](#user-content-cb_IEventCheckoutFinishData). |
-
-<a name="cb_CheckoutButton+setMeta" id="cb_CheckoutButton+setMeta" href="#user-content-cb_CheckoutButton+setMeta">&nbsp;</a>
-
-### afterpayCheckoutButton.setMeta(meta)
-Method for setting meta information for checkout page
-
-**Kind**: instance method of [<code>AfterpayCheckoutButton</code>](#user-content-cb_AfterpayCheckoutButton)  
-**Overrides**: [<code>setMeta</code>](#user-content-cb_CheckoutButton+setMeta)  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| meta | [<code>IPayPalMeta</code>](#user-content-cb_IPayPalMeta) \| [<code>IAfterpayMeta</code>](#user-content-cb_IAfterpayMeta) \| [<code>IZipmoneyMeta</code>](#user-content-cb_IZipmoneyMeta) | Data which can be shown on checkout page [IPayPalMeta](#user-content-cb_IPayPalMeta) [IZipmoneyMeta](#user-content-cb_IZipmoneyMeta) [IAfterpayMeta](#user-content-cb_IAfterpayMeta) |
-
-**Example**  
-
-```javascript
-button.setMeta({
-            brand_name: 'paydock',
-            reference: '15',
-            email: 'wault@paydock.com'
-        });
-```
-<a name="cb_CheckoutButton+setBackdropDescription" id="cb_CheckoutButton+setBackdropDescription" href="#user-content-cb_CheckoutButton+setBackdropDescription">&nbsp;</a>
-
-### afterpayCheckoutButton.setBackdropDescription(text)
-Method for setting backdrop description.
-Only for 'contextual' mode.
-
-**Kind**: instance method of [<code>AfterpayCheckoutButton</code>](#user-content-cb_AfterpayCheckoutButton)  
-**Overrides**: [<code>setBackdropDescription</code>](#user-content-cb_CheckoutButton+setBackdropDescription)  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| text | <code>string</code> | description which can be shown in overlay of back side checkout page |
-
-**Example**  
-
-```javascript
-button.setBackdropDescription('Custom description');
-```
-<a name="cb_CheckoutButton+setBackdropTitle" id="cb_CheckoutButton+setBackdropTitle" href="#user-content-cb_CheckoutButton+setBackdropTitle">&nbsp;</a>
-
-### afterpayCheckoutButton.setBackdropTitle(string)
-Method for setting backdrop title.
-Only for 'contextual' mode.
-
-**Kind**: instance method of [<code>AfterpayCheckoutButton</code>](#user-content-cb_AfterpayCheckoutButton)  
-**Overrides**: [<code>setBackdropTitle</code>](#user-content-cb_CheckoutButton+setBackdropTitle)  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| string | <code>text</code> | title which can be shown in overlay of back side checkout page |
-
-**Example**  
-
-```javascript
-button.setBackdropTitle('Custom title');
-```
-<a name="cb_CheckoutButton+setSuspendedRedirectUri" id="cb_CheckoutButton+setSuspendedRedirectUri" href="#user-content-cb_CheckoutButton+setSuspendedRedirectUri">&nbsp;</a>
-
-### afterpayCheckoutButton.setSuspendedRedirectUri(string)
-Method for setting suspended redirect uri. Redirect after referred checkout.
-Only for 'contextual' mode.
-
-**Kind**: instance method of [<code>AfterpayCheckoutButton</code>](#user-content-cb_AfterpayCheckoutButton)  
-**Overrides**: [<code>setSuspendedRedirectUri</code>](#user-content-cb_CheckoutButton+setSuspendedRedirectUri)  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| string | <code>uri</code> | uri for redirect (by default) |
-
-<a name="cb_CheckoutButton+setRedirectUrl" id="cb_CheckoutButton+setRedirectUrl" href="#user-content-cb_CheckoutButton+setRedirectUrl">&nbsp;</a>
-
-### afterpayCheckoutButton.setRedirectUrl(string)
-Method for setting the merchant redirect URL.
-Merchant's customers redirect after successfull checkout.
-Only for 'redirect' mode.
-
-**Kind**: instance method of [<code>AfterpayCheckoutButton</code>](#user-content-cb_AfterpayCheckoutButton)  
-**Overrides**: [<code>setRedirectUrl</code>](#user-content-cb_CheckoutButton+setRedirectUrl)  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| string | <code>url</code> | redirect url |
-
-<a name="cb_CheckoutButton+turnOffBackdrop" id="cb_CheckoutButton+turnOffBackdrop" href="#user-content-cb_CheckoutButton+turnOffBackdrop">&nbsp;</a>
-
-### afterpayCheckoutButton.turnOffBackdrop()
-Method for disable backdrop on the page.
-Only for 'contextual' mode.
-
-**Kind**: instance method of [<code>AfterpayCheckoutButton</code>](#user-content-cb_AfterpayCheckoutButton)  
-**Overrides**: [<code>turnOffBackdrop</code>](#user-content-cb_CheckoutButton+turnOffBackdrop)  
-**Example**  
-
 ```javascript
 button.turnOffBackdrop();
 ```