@paydock/client-sdk

## Constants <dl> <dt><a href="#user-content-w_FORM_FIELD">FORM_FIELD</a> : <code>object</code></dt> <dd>Current constant include available type of fields which can be included to widget </dd> <dt><a href="#user-content-w_STYLE">STYLE</a> : <code>object</code></dt> <dd>List of available style params for widget </dd> <dt><a href="#user-content-w_TEXT">TEXT</a> : <code>object</code></dt> <dd>List of available text item params for widget </dd> <dt><a href="#user-content-w_ELEMENT">ELEMENT</a> : <code>object</code></dt> <dd>List of available params for hide elements </dd> <dt><a href="#user-content-w_SUPPORTED_CARD_TYPES">SUPPORTED_CARD_TYPES</a> : <code>object</code></dt> <dd>The list of available parameters for showing card icons </dd> <dt><a href="#user-content-w_STYLABLE_ELEMENT">STYLABLE_ELEMENT</a> : <code>object</code></dt> <dd>Current constant include available type of element for styling </dd> <dt><a href="#user-content-w_STYLABLE_ELEMENT_STATE">STYLABLE_ELEMENT_STATE</a> : <code>object</code></dt> <dd>Current constant include available states of element for styling </dd> <dt><a href="#user-content-w_CARD_VALIDATORS">CARD_VALIDATORS</a> : <code>Record.<string, string></code></dt> <dd>List of available form field validators dedicated to cards and their definition </dd> <dt><a href="#user-content-w_GENERIC_VALIDATORS">GENERIC_VALIDATORS</a> : <code>Record.<string, string></code></dt> <dd>List of available generic form field validators and their definition </dd> <dt><a href="#user-content-w_TRIGGER">TRIGGER</a> : <code>object</code></dt> <dd>List of available triggers </dd> </dl> ## Interfaces <dl> <dt><a href="#user-content-w_IPayPalMeta">IPayPalMeta</a></dt> <dd>Interface for PayPal checkout meta information </dd> <dt><a href="#user-content-w_IStyles">IStyles</a></dt> <dd>Interface for classes that represent widget's styles. </dd> <dt><a href="#user-content-w_ITexts">ITexts</a></dt> <dd>Interface for classes that represent widget's text. </dd> <dt><a href="#user-content-w_IBamboraMeta">IBamboraMeta</a></dt> <dd>Interface for Bamboora meta information </dd> <dt><a href="#user-content-w_IElementStyleInput">IElementStyleInput</a></dt> <dd>Interface for styling input element. </dd> <dt><a href="#user-content-w_IElementStyleSubmitButton">IElementStyleSubmitButton</a></dt> <dd>Interface for styling submit_button element. </dd> <dt><a href="#user-content-w_IElementStyleLabel">IElementStyleLabel</a></dt> <dd>Interface for styling label element. </dd> <dt><a href="#user-content-w_IElementStyleTitle">IElementStyleTitle</a></dt> <dd>Interface for styling title element. </dd> <dt><a href="#user-content-w_IElementStyleTitleDescription">IElementStyleTitleDescription</a></dt> <dd>Interface for styling title_description element. </dd> <dt><a href="#user-content-w_ITriggerData">ITriggerData</a></dt> <dd>Interface for classes that represent a trigger data. </dd> </dl> <a name="w_IPayPalMeta" id="w_IPayPalMeta" href="#user-content-w_IPayPalMeta"> </a> ## IPayPalMeta Interface for PayPal checkout meta information **Kind**: global interface | Param | Type | Description | | --- | --- | --- | | [brand_name] | <code>string</code> | A label that overrides the business name in the PayPal account on the PayPal hosted checkout pages | | [cart_border_color] | <code>string</code> | The HTML hex code for your principal identifying color | | [reference] | <code>string</code> | Merchant Customer Service number displayed on the PayPal pages | | [email] | <code>string</code> | The consumer’s email | | [hdr_img] | <code>string</code> | URL for the image you want to appear at the top left of the payment page | | [logo_img] | <code>string</code> | A URL to your logo image | | [pay_flow_color] | <code>string</code> | Sets the background color for the payment page. By default, the color is white. | | [first_name] | <code>string</code> | The consumer’s given names | | [last_name] | <code>string</code> | The consumer’s surname | | [address_line] | <code>string</code> | Street address | | [address_line2] | <code>string</code> | Second line of the address | | [address_city] | <code>string</code> | City | | [address_state] | <code>string</code> | State | | [address_postcode] | <code>string</code> | Postcode | | [address_country] | <code>string</code> | Country | | [phone] | <code>string</code> | The consumer’s phone number in E.164 international notation (Example: +12345678901) | | [hide_shipping_address] | <code>boolean</code> | Determines whether PayPal displays shipping address fields on the PayPal pages | <a name="w_IStyles" id="w_IStyles" href="#user-content-w_IStyles"> </a> ## IStyles Interface for classes that represent widget's styles. **Kind**: global interface | Param | Type | | --- | --- | | [background_color] | <code>string</code> | | [text_color] | <code>string</code> | | [border_color] | <code>string</code> | | [button_color] | <code>string</code> | | [error_color] | <code>string</code> | | [success_color] | <code>string</code> | | [font_size] | <code>string</code> | | [font_family] | <code>string</code> | <a name="w_ITexts" id="w_ITexts" href="#user-content-w_ITexts"> </a> ## ITexts Interface for classes that represent widget's text. **Kind**: global interface | Param | Type | | --- | --- | | [title] | <code>string</code> | | [title_h1] | <code>string</code> | | [title_h2] | <code>string</code> | | [title_h3] | <code>string</code> | | [title_h4] | <code>string</code> | | [title_h5] | <code>string</code> | | [title_h6] | <code>string</code> | | [finish_text] | <code>string</code> | | [title_description] | <code>string</code> | | [submit_button] | <code>string</code> | | [submit_button_processing] | <code>string</code> | <a name="w_IBamboraMeta" id="w_IBamboraMeta" href="#user-content-w_IBamboraMeta"> </a> ## IBamboraMeta Interface for Bamboora meta information **Kind**: global interface | Param | Type | Description | | --- | --- | --- | | [customer_storage_number] | <code>string</code> | Customer storage number | | [tokenise_algorithm] | <code>number</code> | Tokenise algorithm | <a name="w_IElementStyleInput" id="w_IElementStyleInput" href="#user-content-w_IElementStyleInput"> </a> ## IElementStyleInput Interface for styling input element. **Kind**: global interface | Param | Type | Description | | --- | --- | --- | | [color] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/color) | | [border] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/border) | | [border_radius] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/border-radius) | | [background_color] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/background-color) | | [height] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/height) | | [text_decoration] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/text-decoration) | | [font_size] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/font-size) | | [font_family] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/font-family) | | [transition] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/transition) | | [line_height] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/line-height) | | [font_weight] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/font-weight) | | [padding] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/padding) | | [margin] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/margin) | <a name="w_IElementStyleSubmitButton" id="w_IElementStyleSubmitButton" href="#user-content-w_IElementStyleSubmitButton"> </a> ## IElementStyleSubmitButton Interface for styling submit_button element. **Kind**: global interface | Param | Type | Description | | --- | --- | --- | | [color] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/color) | | [border] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/border) | | [border_radius] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/border-radius) | | [background_color] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/background-color) | | [text_decoration] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/text-decoration) | | [font_size] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/font-size) | | [font_family] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/font-family) | | [padding] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/padding) | | [margin] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/margin) | | [transition] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/transition) | | [line_height] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/line-height) | | [font_weight] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/font-weight) | | [opacity] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/opacity) | <a name="w_IElementStyleLabel" id="w_IElementStyleLabel" href="#user-content-w_IElementStyleLabel"> </a> ## IElementStyleLabel Interface for styling label element. **Kind**: global interface | Param | Type | Description | | --- | --- | --- | | [color] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/color) | | [text_decoration] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/text-decoration) | | [font_size] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/font-size) | | [font_family] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/font-family) | | [line_height] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/line-height) | | [font_weight] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/font-weight) | | [padding] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/padding) | | [margin] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/margin) | <a name="w_IElementStyleTitle" id="w_IElementStyleTitle" href="#user-content-w_IElementStyleTitle"> </a> ## IElementStyleTitle Interface for styling title element. **Kind**: global interface | Param | Type | Description | | --- | --- | --- | | [color] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/color) | | [text_decoration] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/text-decoration) | | [font_size] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/font-size) | | [font_family] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/font-family) | | [line_height] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/line-height) | | [font_weight] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/font-weight) | | [padding] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/padding) | | [margin] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/margin) | | ['text-align',] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/text-align) | <a name="w_IElementStyleTitleDescription" id="w_IElementStyleTitleDescription" href="#user-content-w_IElementStyleTitleDescription"> </a> ## IElementStyleTitleDescription Interface for styling title_description element. **Kind**: global interface | Param | Type | Description | | --- | --- | --- | | [color] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/color) | | [text_decoration] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/text-decoration) | | [font_size] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/font-size) | | [font_family] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/font-family) | | [line_height] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/line-height) | | [font_weight] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/font-weight) | | [padding] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/padding) | | [margin] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/margin) | | ['text-align',] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/text-align) | <a name="w_ITriggerData" id="w_ITriggerData" href="#user-content-w_ITriggerData"> </a> ## ITriggerData Interface for classes that represent a trigger data. **Kind**: global interface | Param | Type | | --- | --- | | [configuration_token] | <code>string</code> | | [tab_number] | <code>string</code> | | [elements] | <code>string</code> | | [form_values] | <code>string</code> | <a name="w_FORM_FIELD" id="w_FORM_FIELD" href="#user-content-w_FORM_FIELD"> </a> ## FORM\_FIELD : <code>object</code> Current constant include available type of fields which can be included to widget **Kind**: global constant | Param | Type | Default | | --- | --- | --- | | CARD_NAME | <code>string</code> | <code>"card_name"</code> | | CARD_NUMBER | <code>string</code> | <code>"card_number"</code> | | EXPIRE_MONTH | <code>string</code> | <code>"expire_month"</code> | | EXPIRE_YEAR | <code>string</code> | <code>"expire_year"</code> | | CARD_CCV | <code>string</code> | <code>"card_ccv"</code> | | CARD_PIN | <code>string</code> | <code>"card_pin"</code> | | ACCOUNT_NAME | <code>string</code> | <code>"account_name"</code> | | ACCOUNT_BSB | <code>string</code> | <code>"account_bsb"</code> | | ACCOUNT_NUMBER | <code>string</code> | <code>"account_number"</code> | | ACCOUNT_ROUTING | <code>string</code> | <code>"account_routing"</code> | | ACCOUNT_HOLDER_TYPE | <code>string</code> | <code>"account_holder_type"</code> | | ACCOUNT_BANK_NAME | <code>string</code> | <code>"account_bank_name"</code> | | ACCOUNT_TYPE | <code>string</code> | <code>"account_type"</code> | | FIRST_NAME | <code>string</code> | <code>"first_name"</code> | | LAST_NAME | <code>string</code> | <code>"last_name"</code> | | EMAIL | <code>string</code> | <code>"email"</code> | | PHONE | <code>string</code> | <code>"phone"</code> | | PHONE2 | <code>string</code> | <code>"phone2"</code> | | ADDRESS_LINE1 | <code>string</code> | <code>"address_line1"</code> | | ADDRESS_LINE2 | <code>string</code> | <code>"address_line2"</code> | | ADDRESS_STATE | <code>string</code> | <code>"address_state"</code> | | ADDRESS_COUNTRY | <code>string</code> | <code>"address_country"</code> | | ADDRESS_CITY | <code>string</code> | <code>"address_city"</code> | | ADDRESS_POSTCODE | <code>string</code> | <code>"address_postcode"</code> | | ADDRESS_COMPANY | <code>string</code> | <code>"address_company"</code> | <a name="w_STYLE" id="w_STYLE" href="#user-content-w_STYLE"> </a> ## STYLE : <code>object</code> List of available style params for widget **Kind**: global constant | Param | Type | Default | | --- | --- | --- | | BACKGROUND_COLOR | <code>string</code> | <code>"background_color"</code> | | TEXT_COLOR | <code>string</code> | <code>"text_color"</code> | | BORDER_COLOR | <code>string</code> | <code>"border_color"</code> | | BUTTON_COLOR | <code>string</code> | <code>"button_color"</code> | | ERROR_COLOR | <code>string</code> | <code>"error_color"</code> | | SUCCESS_COLOR | <code>string</code> | <code>"success_color"</code> | | FONT_SIZE | <code>string</code> | <code>"font_size"</code> | | FONT_FAMILY | <code>string</code> | <code>"font_family"</code> | <a name="w_TEXT" id="w_TEXT" href="#user-content-w_TEXT"> </a> ## TEXT : <code>object</code> List of available text item params for widget **Kind**: global constant | Param | Type | Default | | --- | --- | --- | | TITLE | <code>string</code> | <code>"title"</code> | | FINISH | <code>string</code> | <code>"finish_text"</code> | <a name="w_ELEMENT" id="w_ELEMENT" href="#user-content-w_ELEMENT"> </a> ## ELEMENT : <code>object</code> List of available params for hide elements **Kind**: global constant | Param | Type | Default | | --- | --- | --- | | SUBMIT_BUTTON | <code>string</code> | <code>"submit_button"</code> | | TABS | <code>string</code> | <code>"tabs"</code> | <a name="w_SUPPORTED_CARD_TYPES" id="w_SUPPORTED_CARD_TYPES" href="#user-content-w_SUPPORTED_CARD_TYPES"> </a> ## SUPPORTED\_CARD\_TYPES : <code>object</code> The list of available parameters for showing card icons **Kind**: global constant | Param | Type | Default | | --- | --- | --- | | AMEX | <code>string</code> | <code>"amex"</code> | | AUSBC | <code>string</code> | <code>"ausbc"</code> | | DINERS | <code>string</code> | <code>"diners"</code> | | DISCOVER | <code>string</code> | <code>"discover"</code> | | JAPCB | <code>string</code> | <code>"japcb"</code> | | LASER | <code>string</code> | <code>"laser"</code> | | MASTERCARD | <code>string</code> | <code>"mastercard"</code> | | SOLO | <code>string</code> | <code>"solo"</code> | | VISA | <code>string</code> | <code>"visa"</code> | | VISA_WHITE | <code>string</code> | <code>"visa_white"</code> | | UNIONPAY | <code>string</code> | <code>"unionpay"</code> | <a name="w_STYLABLE_ELEMENT" id="w_STYLABLE_ELEMENT" href="#user-content-w_STYLABLE_ELEMENT"> </a> ## STYLABLE\_ELEMENT : <code>object</code> Current constant include available type of element for styling **Kind**: global constant | Param | Type | Default | Description | | --- | --- | --- | --- | | INPUT | <code>string</code> | <code>"input."</code> | These states are available: [STYLABLE_ELEMENT_STATE.ERROR](#user-content-w_STYLABLE_ELEMENT_STATE), [STYLABLE_ELEMENT_STATE.FOCUS](#user-content-w_STYLABLE_ELEMENT_STATE). These styles are available [IElementStyleInput](#user-content-w_IElementStyleInput) | | SUBMIT_BUTTON | <code>string</code> | <code>"submit_button"</code> | These states are available: [STYLABLE_ELEMENT_STATE.HOVER](#user-content-w_STYLABLE_ELEMENT_STATE). These styles are available [IElementStyleSubmitButton](#user-content-w_IElementStyleSubmitButton) | | LABEL | <code>string</code> | <code>"label."</code> | These styles are available [IElementStyleLabel](#user-content-w_IElementStyleLabel) | | TITLE | <code>string</code> | <code>"title."</code> | These styles are available [IElementStyleTitle](#user-content-w_IElementStyleTitle) | | TITLE_DESCRIPTION | <code>string</code> | <code>"title_description."</code> | These styles are available [IElementStyleTitleDescription](#user-content-w_IElementStyleTitleDescription) | <a name="w_STYLABLE_ELEMENT_STATE" id="w_STYLABLE_ELEMENT_STATE" href="#user-content-w_STYLABLE_ELEMENT_STATE"> </a> ## STYLABLE\_ELEMENT\_STATE : <code>object</code> Current constant include available states of element for styling **Kind**: global constant | Param | Type | Default | Description | | --- | --- | --- | --- | | ERROR | <code>string</code> | <code>"error"</code> | client|server validation. This state applies to: input | | FOCUS | <code>string</code> | <code>"focus"</code> | focus. This state applies to: input | | HOVER | <code>string</code> | <code>"hover"</code> | focus. This state applies to: submit_button | <a name="w_CARD_VALIDATORS" id="w_CARD_VALIDATORS" href="#user-content-w_CARD_VALIDATORS"> </a> ## CARD\_VALIDATORS : <code>Record.<string, string></code> List of available form field validators dedicated to cards and their definition **Kind**: global constant | Param | Type | Default | Description | | --- | --- | --- | --- | | CVV | <code>string</code> | <code>"cardCvvValidation"</code> | Asserts that CVV contains zero or more digits and is a number | | EXPIRY_DATE | <code>string</code> | <code>"expireDateValidation"</code> | Asserts value is a date in the future with format MM/YY | | HOLDER_NAME | <code>string</code> | <code>"cardHoldernameValidation"</code> | Asserts value is a name that respects the ITU-T T.50 standard (@see https://www.itu.int/rec/T-REC-T.50/en) | | NUMBER | <code>string</code> | <code>"cardNumberValidation"</code> | Asserts the value matches a known card scheme and as a the correct length. E.g., matches a 13, 16 or 19 digit bank card, **or**, a 13 to 25 digit Vii Gift card | | PIN | <code>string</code> | <code>"cardPinValidation"</code> | Asserts the value is a number with exactly 4 digits | <a name="w_GENERIC_VALIDATORS" id="w_GENERIC_VALIDATORS" href="#user-content-w_GENERIC_VALIDATORS"> </a> ## GENERIC\_VALIDATORS : <code>Record.<string, string></code> List of available generic form field validators and their definition **Kind**: global constant | Param | Type | Default | Description | | --- | --- | --- | --- | | REQUIRED | <code>string</code> | <code>"required"</code> | Asserts the input or form field has a value defined truthy value | <a name="w_TRIGGER" id="w_TRIGGER" href="#user-content-w_TRIGGER"> </a> ## TRIGGER : <code>object</code> List of available triggers **Kind**: global constant | Param | Type | Default | | --- | --- | --- | | SUBMIT_FORM | <code>string</code> | <code>"submit_form"</code> | | CHANGE_TAB | <code>string</code> | <code>"tab"</code> | | HIDE_ELEMENTS | <code>string</code> | <code>"hide_elements"</code> | | SHOW_ELEMENTS | <code>string</code> | <code>"show_elements"</code> | | REFRESH_CHECKOUT | <code>string</code> | <code>"refresh_checkout"</code> | | UPDATE_FORM_VALUES | <code>string</code> | <code>"update_form_values"</code> | | INIT_CHECKOUT | <code>string</code> | <code>"init_checkout"</code> | | INJECT_CUSTOMER_DATA | <code>string</code> | <code>"inject_customer_data"</code> |