npm - @paydock/client-sdk - Versions diffs - 1.103.1 → 1.104.1-beta - Mend

@paydock/client-sdk 1.103.1 → 1.104.1-beta

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (482) hide show

package/docs/api-examples.md ADDED Viewed

@@ -0,0 +1,65 @@
+## Api
+You can find description of all methods and parameters [here](https://www.npmjs.com/package/@paydock/client-sdk#api)
+This wrapper helps you to work with paydock api emdpoints
+### Get browser details
+```javascript
+var browserDetails = await new paydock.Api('publicKey').setEnv('env').getBrowserDetails();
+```
+```javascript
+// ES2015 | TypeScript
+import { Api } from '@paydock/client-sdk';
+var browserDetails = await new paydock.Api('publicKey').setEnv('env').getBrowserDetails();
+```
+### Initialization
+```javascript
+var response = await new paydock.Api('publicKey').setEnv('env').charge().preAuth({
+      amount: 100,
+      currency: 'AUD',
+      token: 'token',
+    });
+```
+```javascript
+// ES2015 | TypeScript
+import { Api } from '@paydock/client-sdk';
+var response = await new Api('publicKey').setEnv('env').charge().preAuth({
+      amount: 100,
+      currency: 'AUD',
+      token: 'token',
+    });
+```
+Then write only need 2 lines of code in js to make request
+### Initialization full example
+```html
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <title>Title</title>
+    <style></style>
+</head>
+<body>
+    <script src="https://widget.paydock.com/sdk/latest/widget.umd.min.js" ></script>
+    <script>
+         (async function() {
+            var response = await new Api('publicKey').setEnv('env').charge().preAuth({
+                amount: 100,
+                currency: 'AUD',
+                token: 'token',
+            });
+        })();
+    </script>
+</body>
+</html>
+```

package/docs/api-ps-widget.md ADDED Viewed

@@ -0,0 +1,585 @@
+## Classes
+<dl>
+<dt><a href="#user-content-psw_HtmlPaymentSourceWidget">HtmlPaymentSourceWidget</a> ⇐ <code><a href="#user-content-psw_PaymentSourceWidget">PaymentSourceWidget</a></code></dt>
+<dd><p>Class HtmlPaymentSourceWidget include method for working on html</p>
+</dd>
+<dt><a href="#user-content-psw_PaymentSourceWidget">PaymentSourceWidget</a></dt>
+<dd><p>Class PaymentSourceWidget include method for for creating iframe url</p>
+</dd>
+</dl>
+## Constants
+<dl>
+<dt><a href="#user-content-psw_EVENT">EVENT</a> : <code>object</code></dt>
+<dd><p>List of available event&#39;s name</p>
+</dd>
+<dt><a href="#user-content-psw_STYLE">STYLE</a> : <code>object</code></dt>
+<dd><p>List of available style params for widget</p>
+</dd>
+<dt><a href="#user-content-psw_PAYMENT_SOURCE_TYPE">PAYMENT_SOURCE_TYPE</a> : <code>object</code></dt>
+<dd><p>List of available payment source types</p>
+</dd>
+</dl>
+## Typedefs
+<dl>
+<dt><a href="#user-content-psw_listener--PaymentSourceWidget">listener--PaymentSourceWidget</a> : <code>function</code></dt>
+<dd><p>This callback will be called for each event in payment source widget</p>
+</dd>
+</dl>
+## Interfaces
+<dl>
+<dt><a href="#user-content-psw_IEventSelectData">IEventSelectData</a></dt>
+<dd><p>Interface of data from event.</p>
+</dd>
+<dt><a href="#user-content-psw_IEventPaginationData">IEventPaginationData</a></dt>
+<dd><p>Interface of data from event.</p>
+</dd>
+<dt><a href="#user-content-psw_IEventAfterLoadData">IEventAfterLoadData</a></dt>
+<dd><p>Interface of data from event.</p>
+</dd>
+<dt><a href="#user-content-psw_IEventFinishData">IEventFinishData</a></dt>
+<dd><p>Interface of data from event.</p>
+</dd>
+<dt><a href="#user-content-psw_IEventSizeData">IEventSizeData</a></dt>
+<dd><p>Interface of data from event.</p>
+</dd>
+<dt><a href="#user-content-psw_IStyles">IStyles</a></dt>
+<dd><p>Interface for classes that represent widget&#39;s styles.</p>
+</dd>
+</dl>
+<a name="psw_IEventSelectData" id="psw_IEventSelectData" href="#user-content-psw_IEventSelectData">&nbsp;</a>
+## IEventSelectData
+Interface of data from event.
+**Kind**: global interface
+| Param | Type |
+| --- | --- |
+| event | <code>string</code> |
+| purpose | <code>string</code> |
+| message_source | <code>string</code> |
+| [ref_id] | <code>string</code> |
+| customer_id | <code>string</code> |
+| payment_source_id | <code>string</code> |
+| gateway_id | <code>string</code> |
+| primary | <code>boolean</code> |
+| [widget_id] | <code>string</code> |
+| [card_number_last4] | <code>string</code> |
+| [card_scheme] | <code>string</code> |
+| gateway_type | <code>string</code> |
+| [checkout_email] | <code>string</code> |
+| payment_source_type | <code>string</code> |
+| [account_name] | <code>string</code> |
+| [account_number] | <code>string</code> |
+<a name="psw_IEventPaginationData" id="psw_IEventPaginationData" href="#user-content-psw_IEventPaginationData">&nbsp;</a>
+## IEventPaginationData
+Interface of data from event.
+**Kind**: global interface
+| Param | Type |
+| --- | --- |
+| event | <code>string</code> |
+| purpose | <code>string</code> |
+| message_source | <code>string</code> |
+| [ref_id] | <code>string</code> |
+| total_item | <code>number</code> |
+| skip | <code>number</code> |
+| limit | <code>number</code> |
+<a name="psw_IEventAfterLoadData" id="psw_IEventAfterLoadData" href="#user-content-psw_IEventAfterLoadData">&nbsp;</a>
+## IEventAfterLoadData
+Interface of data from event.
+**Kind**: global interface
+| Param | Type | Description |
+| --- | --- | --- |
+| event | <code>string</code> | Event name |
+| purpose | <code>string</code> | System variable. Purpose of event |
+| message_source | <code>string</code> | System variable. Event source |
+| [ref_id] | <code>string</code> | Custom value for identify result of processed operation |
+| total_item | <code>number</code> | Pagination param. Total item count |
+| skip | <code>number</code> | Pagination param. Skip items from first item |
+| limit | <code>number</code> | Pagination param. Query limit |
+<a name="psw_IEventFinishData" id="psw_IEventFinishData" href="#user-content-psw_IEventFinishData">&nbsp;</a>
+## IEventFinishData
+Interface of data from event.
+**Kind**: global interface
+| Param | Type | Description |
+| --- | --- | --- |
+| event | <code>string</code> | Event name |
+| purpose | <code>string</code> | System variable. Purpose of event |
+| message_source | <code>string</code> | System variable. Event source |
+| [ref_id] | <code>string</code> | Custom value for identify result of processed operation |
+<a name="psw_IEventSizeData" id="psw_IEventSizeData" href="#user-content-psw_IEventSizeData">&nbsp;</a>
+## IEventSizeData
+Interface of data from event.
+**Kind**: global interface
+| Param | Type | Description |
+| --- | --- | --- |
+| event | <code>number</code> | Event name |
+| purpose | <code>number</code> | System variable. Purpose of event |
+| message_source | <code>string</code> | System variable. Event source |
+| [ref_id] | <code>string</code> | Custom value for identify result of processed operation |
+| height | <code>number</code> | Height of iFrame |
+| width | <code>number</code> | Width of iFrame |
+<a name="psw_IStyles" id="psw_IStyles" href="#user-content-psw_IStyles">&nbsp;</a>
+## IStyles
+Interface for classes that represent widget's styles.
+**Kind**: global interface
+| Param | Type |
+| --- | --- |
+| [background_color] | <code>string</code> |
+| [background_active_color] | <code>string</code> |
+| [text_color] | <code>string</code> |
+| [border_color] | <code>string</code> |
+| [font_size] | <code>string</code> |
+| [icon_size] | <code>string</code> |
+<a name="psw_HtmlPaymentSourceWidget" id="psw_HtmlPaymentSourceWidget" href="#user-content-psw_HtmlPaymentSourceWidget">&nbsp;</a>
+## HtmlPaymentSourceWidget ⇐ [<code>PaymentSourceWidget</code>](#user-content-psw_PaymentSourceWidget)
+Class HtmlPaymentSourceWidget include method for working on html
+**Kind**: global class
+**Extends**: [<code>PaymentSourceWidget</code>](#user-content-psw_PaymentSourceWidget)
+* [HtmlPaymentSourceWidget](#user-content-psw_HtmlPaymentSourceWidget) ⇐ [<code>PaymentSourceWidget</code>](#user-content-psw_PaymentSourceWidget)
+    * [new HtmlPaymentSourceWidget(selector, publicKey, queryToken)](#user-content-psw_new_HtmlPaymentSourceWidget_new)
+    * [.load()](#user-content-psw_HtmlPaymentSourceWidget+load)
+    * [.on(eventName, cb)](#user-content-psw_HtmlPaymentSourceWidget+on)
+    * [.hide([saveSize])](#user-content-psw_HtmlPaymentSourceWidget+hide)
+    * [.show()](#user-content-psw_HtmlPaymentSourceWidget+show)
+    * [.reload()](#user-content-psw_HtmlPaymentSourceWidget+reload)
+    * [.onSelectInsert(selector, dataType)](#user-content-psw_HtmlPaymentSourceWidget+onSelectInsert)
+    * [.setStyles(fields)](#user-content-psw_PaymentSourceWidget+setStyles)
+    * [.setRefId(refId)](#user-content-psw_PaymentSourceWidget+setRefId)
+    * [.setLimit(count)](#user-content-psw_PaymentSourceWidget+setLimit)
+    * [.setEnv(env, [alias])](#user-content-psw_PaymentSourceWidget+setEnv)
+    * [.getIFrameUrl()](#user-content-psw_PaymentSourceWidget+getIFrameUrl)
+    * [.filterByGatewayIds(ids)](#user-content-psw_PaymentSourceWidget+filterByGatewayIds)
+    * [.filterByTypes(types)](#user-content-psw_PaymentSourceWidget+filterByTypes)
+    * [.setLanguage(code)](#user-content-psw_PaymentSourceWidget+setLanguage)
+<a name="psw_new_HtmlPaymentSourceWidget_new" id="psw_new_HtmlPaymentSourceWidget_new" href="#user-content-psw_new_HtmlPaymentSourceWidget_new">&nbsp;</a>
+### new HtmlPaymentSourceWidget(selector, publicKey, queryToken)
+| Param | Type | Description |
+| --- | --- | --- |
+| selector | <code>string</code> | Selector of html element. Container for widget |
+| publicKey | <code>string</code> | PayDock users public key |
+| queryToken | <code>string</code> | PayDock's query token that represents params to search customer by id or reference |
+**Example**
+```javascript
+* var widget = new HtmlPaymentSourceWidget('#widget', 'publicKey','queryToken');
+```
+<a name="psw_HtmlPaymentSourceWidget+load" id="psw_HtmlPaymentSourceWidget+load" href="#user-content-psw_HtmlPaymentSourceWidget+load">&nbsp;</a>
+### htmlPaymentSourceWidget.load()
+The final method to beginning, the load process of widget to html
+**Kind**: instance method of [<code>HtmlPaymentSourceWidget</code>](#user-content-psw_HtmlPaymentSourceWidget)
+<a name="psw_HtmlPaymentSourceWidget+on" id="psw_HtmlPaymentSourceWidget+on" href="#user-content-psw_HtmlPaymentSourceWidget+on">&nbsp;</a>
+### htmlPaymentSourceWidget.on(eventName, cb)
+Listen to events of widget
+**Kind**: instance method of [<code>HtmlPaymentSourceWidget</code>](#user-content-psw_HtmlPaymentSourceWidget)
+| Param | Type | Description |
+| --- | --- | --- |
+| eventName | <code>string</code> | Available event names [EVENT](#user-content-psw_EVENT) |
+| cb | [<code>listener--PaymentSourceWidget</code>](#user-content-psw_listener--PaymentSourceWidget) |  |
+**Example**
+```javascript
+widget.on('select', function (data) {
+     console.log(data);
+});
+```
+<a name="psw_HtmlPaymentSourceWidget+hide" id="psw_HtmlPaymentSourceWidget+hide" href="#user-content-psw_HtmlPaymentSourceWidget+hide">&nbsp;</a>
+### htmlPaymentSourceWidget.hide([saveSize])
+Using this method you can hide widget after load
+**Kind**: instance method of [<code>HtmlPaymentSourceWidget</code>](#user-content-psw_HtmlPaymentSourceWidget)
+| Param | Type | Default | Description |
+| --- | --- | --- | --- |
+| [saveSize] | <code>boolean</code> | <code>false</code> | using this param you can save iframe's size |
+<a name="psw_HtmlPaymentSourceWidget+show" id="psw_HtmlPaymentSourceWidget+show" href="#user-content-psw_HtmlPaymentSourceWidget+show">&nbsp;</a>
+### htmlPaymentSourceWidget.show()
+Using this method you can show widget after using hide method
+**Kind**: instance method of [<code>HtmlPaymentSourceWidget</code>](#user-content-psw_HtmlPaymentSourceWidget)
+<a name="psw_HtmlPaymentSourceWidget+reload" id="psw_HtmlPaymentSourceWidget+reload" href="#user-content-psw_HtmlPaymentSourceWidget+reload">&nbsp;</a>
+### htmlPaymentSourceWidget.reload()
+Using this method you can reload widget
+**Kind**: instance method of [<code>HtmlPaymentSourceWidget</code>](#user-content-psw_HtmlPaymentSourceWidget)
+<a name="psw_HtmlPaymentSourceWidget+onSelectInsert" id="psw_HtmlPaymentSourceWidget+onSelectInsert" href="#user-content-psw_HtmlPaymentSourceWidget+onSelectInsert">&nbsp;</a>
+### htmlPaymentSourceWidget.onSelectInsert(selector, dataType)
+After select event of widget, data (dataType) will be insert to input (selector)
+**Kind**: instance method of [<code>HtmlPaymentSourceWidget</code>](#user-content-psw_HtmlPaymentSourceWidget)
+| Param | Type | Description |
+| --- | --- | --- |
+| selector | <code>string</code> | css selector . [] # |
+| dataType | <code>string</code> | data type of [IEventSelectData](#user-content-psw_IEventSelectData). |
+<a name="psw_PaymentSourceWidget+setStyles" id="psw_PaymentSourceWidget+setStyles" href="#user-content-psw_PaymentSourceWidget+setStyles">&nbsp;</a>
+### htmlPaymentSourceWidget.setStyles(fields)
+Object contain styles for widget
+**Kind**: instance method of [<code>HtmlPaymentSourceWidget</code>](#user-content-psw_HtmlPaymentSourceWidget)
+**Overrides**: [<code>setStyles</code>](#user-content-psw_PaymentSourceWidget+setStyles)
+| Param | Type | Description |
+| --- | --- | --- |
+| fields | [<code>IStyles</code>](#user-content-psw_IStyles) | name of styles which can be shown in widget [STYLE](#user-content-psw_STYLE) |
+**Example**
+```javascript
+widget.setStyles({
+      background_color: 'rgb(0, 0, 0)',
+      border_color: 'yellow',
+      text_color: '#FFFFAA',
+      icon_size: 'small',
+      font_size: '20px'
+  });
+```
+<a name="psw_PaymentSourceWidget+setRefId" id="psw_PaymentSourceWidget+setRefId" href="#user-content-psw_PaymentSourceWidget+setRefId">&nbsp;</a>
+### htmlPaymentSourceWidget.setRefId(refId)
+Current method can set custom ID to identify the data in the future
+**Kind**: instance method of [<code>HtmlPaymentSourceWidget</code>](#user-content-psw_HtmlPaymentSourceWidget)
+**Overrides**: [<code>setRefId</code>](#user-content-psw_PaymentSourceWidget+setRefId)
+| Param | Type | Description |
+| --- | --- | --- |
+| refId | <code>string</code> | custom id |
+**Example**
+```javascript
+widget.setRefId('id');
+```
+<a name="psw_PaymentSourceWidget+setLimit" id="psw_PaymentSourceWidget+setLimit" href="#user-content-psw_PaymentSourceWidget+setLimit">&nbsp;</a>
+### htmlPaymentSourceWidget.setLimit(count)
+Current method can set limit for payment sources count. In case when limit sets less then general count will be shown pagination buttons prev and next.
+**Kind**: instance method of [<code>HtmlPaymentSourceWidget</code>](#user-content-psw_HtmlPaymentSourceWidget)
+**Overrides**: [<code>setLimit</code>](#user-content-psw_PaymentSourceWidget+setLimit)
+| Param | Type | Description |
+| --- | --- | --- |
+| count | <code>string</code> | payment source count |
+<a name="psw_PaymentSourceWidget+setEnv" id="psw_PaymentSourceWidget+setEnv" href="#user-content-psw_PaymentSourceWidget+setEnv">&nbsp;</a>
+### htmlPaymentSourceWidget.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>HtmlPaymentSourceWidget</code>](#user-content-psw_HtmlPaymentSourceWidget)
+**Overrides**: [<code>setEnv</code>](#user-content-psw_PaymentSourceWidget+setEnv)
+| Param | Type | Description |
+| --- | --- | --- |
+| env | <code>string</code> | sandbox, production |
+| [alias] | <code>string</code> | Own domain alias |
+**Example**
+```javascript
+widget.setEnv('production');
+```
+<a name="psw_PaymentSourceWidget+getIFrameUrl" id="psw_PaymentSourceWidget+getIFrameUrl" href="#user-content-psw_PaymentSourceWidget+getIFrameUrl">&nbsp;</a>
+### htmlPaymentSourceWidget.getIFrameUrl()
+Method for getting iframe's url
+**Kind**: instance method of [<code>HtmlPaymentSourceWidget</code>](#user-content-psw_HtmlPaymentSourceWidget)
+**Overrides**: [<code>getIFrameUrl</code>](#user-content-psw_PaymentSourceWidget+getIFrameUrl)
+<a name="psw_PaymentSourceWidget+filterByGatewayIds" id="psw_PaymentSourceWidget+filterByGatewayIds" href="#user-content-psw_PaymentSourceWidget+filterByGatewayIds">&nbsp;</a>
+### htmlPaymentSourceWidget.filterByGatewayIds(ids)
+Show payment source inside widget only with requested gateway ids
+**Kind**: instance method of [<code>HtmlPaymentSourceWidget</code>](#user-content-psw_HtmlPaymentSourceWidget)
+**Overrides**: [<code>filterByGatewayIds</code>](#user-content-psw_PaymentSourceWidget+filterByGatewayIds)
+| Param | Type | Description |
+| --- | --- | --- |
+| ids | <code>Array.&lt;string&gt;</code> | List of gateway_id |
+<a name="psw_PaymentSourceWidget+filterByTypes" id="psw_PaymentSourceWidget+filterByTypes" href="#user-content-psw_PaymentSourceWidget+filterByTypes">&nbsp;</a>
+### htmlPaymentSourceWidget.filterByTypes(types)
+Show payment source inside widget only with requested payment source types
+**Kind**: instance method of [<code>HtmlPaymentSourceWidget</code>](#user-content-psw_HtmlPaymentSourceWidget)
+**Overrides**: [<code>filterByTypes</code>](#user-content-psw_PaymentSourceWidget+filterByTypes)
+| Param | Description |
+| --- | --- |
+| types | List of payment source types. Available parameters [PAYMENT_TYPE](PAYMENT_TYPE) |
+<a name="psw_PaymentSourceWidget+setLanguage" id="psw_PaymentSourceWidget+setLanguage" href="#user-content-psw_PaymentSourceWidget+setLanguage">&nbsp;</a>
+### htmlPaymentSourceWidget.setLanguage(code)
+Method for setting a custom language code
+**Kind**: instance method of [<code>HtmlPaymentSourceWidget</code>](#user-content-psw_HtmlPaymentSourceWidget)
+**Overrides**: [<code>setLanguage</code>](#user-content-psw_PaymentSourceWidget+setLanguage)
+| Param | Type | Description |
+| --- | --- | --- |
+| code | <code>string</code> | ISO 639-1 |
+**Example**
+```javascript
+config.setLanguage('en');
+```
+<a name="psw_PaymentSourceWidget" id="psw_PaymentSourceWidget" href="#user-content-psw_PaymentSourceWidget">&nbsp;</a>
+## PaymentSourceWidget
+Class PaymentSourceWidget include method for for creating iframe url
+**Kind**: global class
+* [PaymentSourceWidget](#user-content-psw_PaymentSourceWidget)
+    * [new PaymentSourceWidget(publicKey, customer, [useReference])](#user-content-psw_new_PaymentSourceWidget_new)
+    * [.setStyles(fields)](#user-content-psw_PaymentSourceWidget+setStyles)
+    * [.setRefId(refId)](#user-content-psw_PaymentSourceWidget+setRefId)
+    * [.setLimit(count)](#user-content-psw_PaymentSourceWidget+setLimit)
+    * [.setEnv(env, [alias])](#user-content-psw_PaymentSourceWidget+setEnv)
+    * [.getIFrameUrl()](#user-content-psw_PaymentSourceWidget+getIFrameUrl)
+    * [.filterByGatewayIds(ids)](#user-content-psw_PaymentSourceWidget+filterByGatewayIds)
+    * [.filterByTypes(types)](#user-content-psw_PaymentSourceWidget+filterByTypes)
+    * [.setLanguage(code)](#user-content-psw_PaymentSourceWidget+setLanguage)
+<a name="psw_new_PaymentSourceWidget_new" id="psw_new_PaymentSourceWidget_new" href="#user-content-psw_new_PaymentSourceWidget_new">&nbsp;</a>
+### new PaymentSourceWidget(publicKey, customer, [useReference])
+| Param | Type | Default | Description |
+| --- | --- | --- | --- |
+| publicKey | <code>string</code> |  | PayDock users public key |
+| customer | <code>string</code> |  | PayDock's customer_id or customer_reference (In order to use the customer_reference, you must explicitly specify useReference as true) |
+| [useReference] | <code>boolean</code> | <code>false</code> |  |
+**Example**
+```javascript
+var widget = new PaymentSourceWidget('publicKey','customerId');
+// or
+var widget = new PaymentSourceWidget('publicKey', customerReference, true);
+```
+<a name="psw_PaymentSourceWidget+setStyles" id="psw_PaymentSourceWidget+setStyles" href="#user-content-psw_PaymentSourceWidget+setStyles">&nbsp;</a>
+### paymentSourceWidget.setStyles(fields)
+Object contain styles for widget
+**Kind**: instance method of [<code>PaymentSourceWidget</code>](#user-content-psw_PaymentSourceWidget)
+| Param | Type | Description |
+| --- | --- | --- |
+| fields | [<code>IStyles</code>](#user-content-psw_IStyles) | name of styles which can be shown in widget [STYLE](#user-content-psw_STYLE) |
+**Example**
+```javascript
+widget.setStyles({
+      background_color: 'rgb(0, 0, 0)',
+      border_color: 'yellow',
+      text_color: '#FFFFAA',
+      icon_size: 'small',
+      font_size: '20px'
+  });
+```
+<a name="psw_PaymentSourceWidget+setRefId" id="psw_PaymentSourceWidget+setRefId" href="#user-content-psw_PaymentSourceWidget+setRefId">&nbsp;</a>
+### paymentSourceWidget.setRefId(refId)
+Current method can set custom ID to identify the data in the future
+**Kind**: instance method of [<code>PaymentSourceWidget</code>](#user-content-psw_PaymentSourceWidget)
+| Param | Type | Description |
+| --- | --- | --- |
+| refId | <code>string</code> | custom id |
+**Example**
+```javascript
+widget.setRefId('id');
+```
+<a name="psw_PaymentSourceWidget+setLimit" id="psw_PaymentSourceWidget+setLimit" href="#user-content-psw_PaymentSourceWidget+setLimit">&nbsp;</a>
+### paymentSourceWidget.setLimit(count)
+Current method can set limit for payment sources count. In case when limit sets less then general count will be shown pagination buttons prev and next.
+**Kind**: instance method of [<code>PaymentSourceWidget</code>](#user-content-psw_PaymentSourceWidget)
+| Param | Type | Description |
+| --- | --- | --- |
+| count | <code>string</code> | payment source count |
+<a name="psw_PaymentSourceWidget+setEnv" id="psw_PaymentSourceWidget+setEnv" href="#user-content-psw_PaymentSourceWidget+setEnv">&nbsp;</a>
+### paymentSourceWidget.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>PaymentSourceWidget</code>](#user-content-psw_PaymentSourceWidget)
+| Param | Type | Description |
+| --- | --- | --- |
+| env | <code>string</code> | sandbox, production |
+| [alias] | <code>string</code> | Own domain alias |
+**Example**
+```javascript
+widget.setEnv('production');
+```
+<a name="psw_PaymentSourceWidget+getIFrameUrl" id="psw_PaymentSourceWidget+getIFrameUrl" href="#user-content-psw_PaymentSourceWidget+getIFrameUrl">&nbsp;</a>
+### paymentSourceWidget.getIFrameUrl()
+Method for getting iframe's url
+**Kind**: instance method of [<code>PaymentSourceWidget</code>](#user-content-psw_PaymentSourceWidget)
+<a name="psw_PaymentSourceWidget+filterByGatewayIds" id="psw_PaymentSourceWidget+filterByGatewayIds" href="#user-content-psw_PaymentSourceWidget+filterByGatewayIds">&nbsp;</a>
+### paymentSourceWidget.filterByGatewayIds(ids)
+Show payment source inside widget only with requested gateway ids
+**Kind**: instance method of [<code>PaymentSourceWidget</code>](#user-content-psw_PaymentSourceWidget)
+| Param | Type | Description |
+| --- | --- | --- |
+| ids | <code>Array.&lt;string&gt;</code> | List of gateway_id |
+<a name="psw_PaymentSourceWidget+filterByTypes" id="psw_PaymentSourceWidget+filterByTypes" href="#user-content-psw_PaymentSourceWidget+filterByTypes">&nbsp;</a>
+### paymentSourceWidget.filterByTypes(types)
+Show payment source inside widget only with requested payment source types
+**Kind**: instance method of [<code>PaymentSourceWidget</code>](#user-content-psw_PaymentSourceWidget)
+| Param | Description |
+| --- | --- |
+| types | List of payment source types. Available parameters [PAYMENT_TYPE](PAYMENT_TYPE) |
+<a name="psw_PaymentSourceWidget+setLanguage" id="psw_PaymentSourceWidget+setLanguage" href="#user-content-psw_PaymentSourceWidget+setLanguage">&nbsp;</a>
+### paymentSourceWidget.setLanguage(code)
+Method for setting a custom language code
+**Kind**: instance method of [<code>PaymentSourceWidget</code>](#user-content-psw_PaymentSourceWidget)
+| Param | Type | Description |
+| --- | --- | --- |
+| code | <code>string</code> | ISO 639-1 |
+**Example**
+```javascript
+config.setLanguage('en');
+```
+<a name="psw_EVENT" id="psw_EVENT" href="#user-content-psw_EVENT">&nbsp;</a>
+## EVENT : <code>object</code>
+List of available event's name
+**Kind**: global constant
+| Param | Type | Default |
+| --- | --- | --- |
+| AFTER_LOAD | <code>string</code> | <code>&quot;afterLoad&quot;</code> |
+| SYSTEM_ERROR | <code>string</code> | <code>&quot;systemError&quot;</code> |
+| SELECT | <code>string</code> | <code>&quot;select&quot;</code> |
+| UNSELECT | <code>string</code> | <code>&quot;unselect&quot;</code> |
+| NEXT | <code>string</code> | <code>&quot;next&quot;</code> |
+| PREV | <code>string</code> | <code>&quot;prev&quot;</code> |
+| META_CHANGE | <code>string</code> | <code>&quot;metaChange&quot;</code> |
+| RESIZE | <code>string</code> | <code>&quot;resize&quot;</code> |
+<a name="psw_STYLE" id="psw_STYLE" href="#user-content-psw_STYLE">&nbsp;</a>
+## STYLE : <code>object</code>
+List of available style params for widget
+**Kind**: global constant
+| Param | Type | Default |
+| --- | --- | --- |
+| BACKGROUND_COLOR | <code>string</code> | <code>&quot;background_color&quot;</code> |
+| BACKGROUND_ACTIVE_COLOR | <code>string</code> | <code>&quot;background_active_color&quot;</code> |
+| TEXT_COLOR | <code>string</code> | <code>&quot;text_color&quot;</code> |
+| BORDER_COLOR | <code>string</code> | <code>&quot;border_color&quot;</code> |
+| ICON_SIZE | <code>string</code> | <code>&quot;icon_size&quot;</code> |
+| FONT_SIZE | <code>string</code> | <code>&quot;font_size&quot;</code> |
+<a name="psw_PAYMENT_SOURCE_TYPE" id="psw_PAYMENT_SOURCE_TYPE" href="#user-content-psw_PAYMENT_SOURCE_TYPE">&nbsp;</a>
+## PAYMENT\_SOURCE\_TYPE : <code>object</code>
+List of available payment source types
+**Kind**: global constant
+| Param | Type | Default |
+| --- | --- | --- |
+| CARD | <code>string</code> | <code>&quot;card&quot;</code> |
+| BANK_ACCOUNT | <code>string</code> | <code>&quot;bank_account&quot;</code> |
+| CHECKOUT | <code>string</code> | <code>&quot;checkout&quot;</code> |
+<a name="psw_listener--PaymentSourceWidget" id="psw_listener--PaymentSourceWidget" href="#user-content-psw_listener--PaymentSourceWidget">&nbsp;</a>
+## listener--PaymentSourceWidget : <code>function</code>
+This callback will be called for each event in payment source widget
+**Kind**: global typedef
+| Param | Type |
+| --- | --- |
+| response | <code>IEventData</code> \| [<code>IEventSelectData</code>](#user-content-psw_IEventSelectData) \| [<code>IEventPaginationData</code>](#user-content-psw_IEventPaginationData) \| [<code>IEventAfterLoadData</code>](#user-content-psw_IEventAfterLoadData) |