@paydock/client-sdk 1.106.1 → 1.107.0-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 (490) hide show
  1. package/README.md +194 -162
  2. package/bundles/index.cjs +10483 -0
  3. package/bundles/index.cjs.d.ts +3206 -0
  4. package/bundles/index.cjs.map +1 -0
  5. package/bundles/index.mjs +10451 -0
  6. package/bundles/index.mjs.d.ts +3206 -0
  7. package/bundles/index.mjs.map +1 -0
  8. package/{lib → bundles/types}/api/api-base.d.ts +2 -1
  9. package/bundles/types/api/api-base.d.ts.map +1 -0
  10. package/{lib → bundles/types}/api/api-charge-internal.d.ts +1 -0
  11. package/bundles/types/api/api-charge-internal.d.ts.map +1 -0
  12. package/{lib → bundles/types}/api/api-charge.d.ts +1 -0
  13. package/bundles/types/api/api-charge.d.ts.map +1 -0
  14. package/{lib → bundles/types}/api/api-internal.d.ts +1 -0
  15. package/bundles/types/api/api-internal.d.ts.map +1 -0
  16. package/{lib → bundles/types}/api/api-service-internal.d.ts +2 -1
  17. package/bundles/types/api/api-service-internal.d.ts.map +1 -0
  18. package/{lib → bundles/types}/api/api.d.ts +1 -0
  19. package/bundles/types/api/api.d.ts.map +1 -0
  20. package/bundles/types/api/index.d.ts +2 -0
  21. package/bundles/types/api/index.d.ts.map +1 -0
  22. package/{lib → bundles/types}/canvas-3ds/canvas-3ds.d.ts +1 -0
  23. package/bundles/types/canvas-3ds/canvas-3ds.d.ts.map +1 -0
  24. package/{lib → bundles/types}/canvas-3ds/index.d.ts +1 -0
  25. package/bundles/types/canvas-3ds/index.d.ts.map +1 -0
  26. package/{lib → bundles/types}/canvas-3ds/services/gpayments-service.d.ts +1 -0
  27. package/bundles/types/canvas-3ds/services/gpayments-service.d.ts.map +1 -0
  28. package/{lib → bundles/types}/canvas-3ds/services/index.d.ts +1 -0
  29. package/bundles/types/canvas-3ds/services/index.d.ts.map +1 -0
  30. package/{lib → bundles/types}/canvas-3ds/services/standalone3ds-service.d.ts +1 -0
  31. package/bundles/types/canvas-3ds/services/standalone3ds-service.d.ts.map +1 -0
  32. package/{lib → bundles/types}/checkout-button/afterpay/afterpay-checkout-button.d.ts +1 -0
  33. package/bundles/types/checkout-button/afterpay/afterpay-checkout-button.d.ts.map +1 -0
  34. package/{lib → bundles/types}/checkout-button/afterpay/afterpay.runner.d.ts +1 -0
  35. package/bundles/types/checkout-button/afterpay/afterpay.runner.d.ts.map +1 -0
  36. package/{lib → bundles/types}/checkout-button/checkout-button.d.ts +1 -0
  37. package/bundles/types/checkout-button/checkout-button.d.ts.map +1 -0
  38. package/{lib → bundles/types}/checkout-button/checkout-button.interface.d.ts +1 -0
  39. package/bundles/types/checkout-button/checkout-button.interface.d.ts.map +1 -0
  40. package/{lib → bundles/types}/checkout-button/checkout-contextual-handler.d.ts +1 -0
  41. package/bundles/types/checkout-button/checkout-contextual-handler.d.ts.map +1 -0
  42. package/{lib → bundles/types}/checkout-button/index.d.ts +2 -1
  43. package/bundles/types/checkout-button/index.d.ts.map +1 -0
  44. package/{lib → bundles/types}/checkout-button/paypal/paypal-checkout-button.d.ts +1 -0
  45. package/bundles/types/checkout-button/paypal/paypal-checkout-button.d.ts.map +1 -0
  46. package/{lib → bundles/types}/checkout-button/paypal/paypal.runner.d.ts +1 -0
  47. package/bundles/types/checkout-button/paypal/paypal.runner.d.ts.map +1 -0
  48. package/{lib → bundles/types}/checkout-button/runner/base.runner.d.ts +4 -3
  49. package/bundles/types/checkout-button/runner/base.runner.d.ts.map +1 -0
  50. package/{lib → bundles/types}/checkout-button/runner/contextual.runner.d.ts +2 -1
  51. package/bundles/types/checkout-button/runner/contextual.runner.d.ts.map +1 -0
  52. package/{lib → bundles/types}/checkout-button/runner/index.d.ts +1 -0
  53. package/bundles/types/checkout-button/runner/index.d.ts.map +1 -0
  54. package/{lib → bundles/types}/checkout-button/runner/popup.runner.d.ts +2 -1
  55. package/bundles/types/checkout-button/runner/popup.runner.d.ts.map +1 -0
  56. package/{lib → bundles/types}/checkout-button/runner/redirect.runner.d.ts +2 -1
  57. package/bundles/types/checkout-button/runner/redirect.runner.d.ts.map +1 -0
  58. package/bundles/types/checkout-button/zipmoney/index.d.ts +4 -0
  59. package/bundles/types/checkout-button/zipmoney/index.d.ts.map +1 -0
  60. package/{lib → bundles/types}/checkout-button/zipmoney/zipmoney-checkout-button.d.ts +1 -0
  61. package/bundles/types/checkout-button/zipmoney/zipmoney-checkout-button.d.ts.map +1 -0
  62. package/{lib → bundles/types}/checkout-button/zipmoney/zipmoney-contextual.runner.d.ts +2 -1
  63. package/bundles/types/checkout-button/zipmoney/zipmoney-contextual.runner.d.ts.map +1 -0
  64. package/{lib → bundles/types}/checkout-button/zipmoney/zipmoney-redirect.runner.d.ts +2 -1
  65. package/bundles/types/checkout-button/zipmoney/zipmoney-redirect.runner.d.ts.map +1 -0
  66. package/{lib → bundles/types}/checkout-button/zipmoney/zipmoney.config.d.ts +1 -0
  67. package/bundles/types/checkout-button/zipmoney/zipmoney.config.d.ts.map +1 -0
  68. package/{lib → bundles/types}/checkout-button/zipmoney/zipmoney.runner.d.ts +2 -1
  69. package/bundles/types/checkout-button/zipmoney/zipmoney.runner.d.ts.map +1 -0
  70. package/{lib → bundles/types}/checkout-button/zipmoney/zipmoney.types.d.ts +1 -0
  71. package/bundles/types/checkout-button/zipmoney/zipmoney.types.d.ts.map +1 -0
  72. package/{lib → bundles/types}/components/ability-guard.d.ts +1 -0
  73. package/bundles/types/components/ability-guard.d.ts.map +1 -0
  74. package/{lib → bundles/types}/components/background.d.ts +1 -0
  75. package/bundles/types/components/background.d.ts.map +1 -0
  76. package/{lib → bundles/types}/components/container.d.ts +1 -0
  77. package/bundles/types/components/container.d.ts.map +1 -0
  78. package/{lib → bundles/types}/components/dispatcher.d.ts +2 -1
  79. package/bundles/types/components/dispatcher.d.ts.map +1 -0
  80. package/{lib → bundles/types}/components/element-style.d.ts +2 -1
  81. package/bundles/types/components/element-style.d.ts.map +1 -0
  82. package/{lib → bundles/types}/components/flypay-iframe-event.d.ts +1 -0
  83. package/bundles/types/components/flypay-iframe-event.d.ts.map +1 -0
  84. package/{lib/components/form-Interceptor.d.ts → bundles/types/components/form-interceptor.d.ts} +1 -0
  85. package/bundles/types/components/form-interceptor.d.ts.map +1 -0
  86. package/{lib → bundles/types}/components/http-core.d.ts +1 -0
  87. package/bundles/types/components/http-core.d.ts.map +1 -0
  88. package/{lib → bundles/types}/components/iframe-event.d.ts +2 -0
  89. package/bundles/types/components/iframe-event.d.ts.map +1 -0
  90. package/{lib → bundles/types}/components/iframe.d.ts +1 -0
  91. package/bundles/types/components/iframe.d.ts.map +1 -0
  92. package/{lib → bundles/types}/components/link.d.ts +2 -1
  93. package/bundles/types/components/link.d.ts.map +1 -0
  94. package/{lib → bundles/types}/components/loader.d.ts +1 -0
  95. package/bundles/types/components/loader.d.ts.map +1 -0
  96. package/{lib → bundles/types}/components/param.d.ts +8 -7
  97. package/bundles/types/components/param.d.ts.map +1 -0
  98. package/{lib → bundles/types}/components/popup.d.ts +1 -0
  99. package/bundles/types/components/popup.d.ts.map +1 -0
  100. package/{lib → bundles/types}/components/storage-dispatcher.d.ts +1 -0
  101. package/bundles/types/components/storage-dispatcher.d.ts.map +1 -0
  102. package/{lib → bundles/types}/components/trigger.d.ts +1 -0
  103. package/bundles/types/components/trigger.d.ts.map +1 -0
  104. package/{lib → bundles/types}/components/vault-display-iframe-event.d.ts +1 -0
  105. package/bundles/types/components/vault-display-iframe-event.d.ts.map +1 -0
  106. package/{lib → bundles/types}/components/wallet-background.d.ts +3 -1
  107. package/bundles/types/components/wallet-background.d.ts.map +1 -0
  108. package/{lib → bundles/types}/components/wallet-trigger.d.ts +1 -0
  109. package/bundles/types/components/wallet-trigger.d.ts.map +1 -0
  110. package/bundles/types/configs/env/environment.cba.d.ts +29 -0
  111. package/bundles/types/configs/env/environment.cba.d.ts.map +1 -0
  112. package/bundles/types/configs/env/environment.interface.d.ts +12 -0
  113. package/bundles/types/configs/env/environment.interface.d.ts.map +1 -0
  114. package/{lib/configs/env/env.d.ts → bundles/types/configs/env/environment.paydock.d.ts} +5 -8
  115. package/bundles/types/configs/env/environment.paydock.d.ts.map +1 -0
  116. package/bundles/types/configs/env/index.d.ts +3 -0
  117. package/bundles/types/configs/env/index.d.ts.map +1 -0
  118. package/{lib → bundles/types}/configs/sdk.d.ts +3 -2
  119. package/bundles/types/configs/sdk.d.ts.map +1 -0
  120. package/{lib → bundles/types}/constants/validators.d.ts +3 -2
  121. package/bundles/types/constants/validators.d.ts.map +1 -0
  122. package/{lib → bundles/types}/external-checkout/builder.d.ts +1 -0
  123. package/bundles/types/external-checkout/builder.d.ts.map +1 -0
  124. package/{lib → bundles/types}/external-checkout/checker.d.ts +1 -0
  125. package/bundles/types/external-checkout/checker.d.ts.map +1 -0
  126. package/bundles/types/external-checkout/index.d.ts +3 -0
  127. package/bundles/types/external-checkout/index.d.ts.map +1 -0
  128. package/{lib → bundles/types}/helper/access-token.d.ts +1 -0
  129. package/bundles/types/helper/access-token.d.ts.map +1 -0
  130. package/{lib → bundles/types}/helper/browser.d.ts +1 -0
  131. package/bundles/types/helper/browser.d.ts.map +1 -0
  132. package/bundles/types/helper/element-id.d.ts +5 -0
  133. package/bundles/types/helper/element-id.d.ts.map +1 -0
  134. package/{lib → bundles/types}/helper/event-emitter.d.ts +1 -0
  135. package/bundles/types/helper/event-emitter.d.ts.map +1 -0
  136. package/{lib → bundles/types}/helper/event.d.ts +1 -0
  137. package/bundles/types/helper/event.d.ts.map +1 -0
  138. package/{lib → bundles/types}/helper/ms.d.ts +1 -0
  139. package/bundles/types/helper/ms.d.ts.map +1 -0
  140. package/{lib → bundles/types}/helper/object.d.ts +1 -0
  141. package/bundles/types/helper/object.d.ts.map +1 -0
  142. package/{lib → bundles/types}/helper/url.d.ts +1 -0
  143. package/bundles/types/helper/url.d.ts.map +1 -0
  144. package/{lib → bundles/types}/helper/uuid.d.ts +1 -0
  145. package/bundles/types/helper/uuid.d.ts.map +1 -0
  146. package/bundles/types/index-cba.d.ts +13 -0
  147. package/bundles/types/index-cba.d.ts.map +1 -0
  148. package/bundles/types/index.d.ts +14 -0
  149. package/bundles/types/index.d.ts.map +1 -0
  150. package/{lib → bundles/types}/payment-source/builder.d.ts +1 -0
  151. package/bundles/types/payment-source/builder.d.ts.map +1 -0
  152. package/{lib → bundles/types}/payment-source/index.d.ts +1 -0
  153. package/bundles/types/payment-source/index.d.ts.map +1 -0
  154. package/{lib → bundles/types}/payment-source-widget/html-payment-source-widget.d.ts +1 -0
  155. package/bundles/types/payment-source-widget/html-payment-source-widget.d.ts.map +1 -0
  156. package/{lib → bundles/types}/payment-source-widget/index.d.ts +1 -0
  157. package/bundles/types/payment-source-widget/index.d.ts.map +1 -0
  158. package/{lib → bundles/types}/payment-source-widget/interfaces.d.ts +1 -0
  159. package/bundles/types/payment-source-widget/interfaces.d.ts.map +1 -0
  160. package/{lib → bundles/types}/payment-source-widget/payment-source-widget.d.ts +1 -0
  161. package/bundles/types/payment-source-widget/payment-source-widget.d.ts.map +1 -0
  162. package/bundles/types/secure-remote-commerce/click-to-pay-secure-remote-commerce.d.ts +31 -0
  163. package/bundles/types/secure-remote-commerce/click-to-pay-secure-remote-commerce.d.ts.map +1 -0
  164. package/{lib → bundles/types}/secure-remote-commerce/index.d.ts +5 -4
  165. package/bundles/types/secure-remote-commerce/index.d.ts.map +1 -0
  166. package/{lib → bundles/types}/secure-remote-commerce/interfaces.d.ts +10 -9
  167. package/bundles/types/secure-remote-commerce/interfaces.d.ts.map +1 -0
  168. package/bundles/types/secure-remote-commerce/providers/mastercard-src/index.d.ts +2 -0
  169. package/bundles/types/secure-remote-commerce/providers/mastercard-src/index.d.ts.map +1 -0
  170. package/{lib → bundles/types}/secure-remote-commerce/providers/mastercard-src/mastercard-src.d.ts +5 -4
  171. package/bundles/types/secure-remote-commerce/providers/mastercard-src/mastercard-src.d.ts.map +1 -0
  172. package/{lib → bundles/types}/secure-remote-commerce/providers/src-provider.d.ts +1 -0
  173. package/bundles/types/secure-remote-commerce/providers/src-provider.d.ts.map +1 -0
  174. package/{lib → bundles/types}/secure-remote-commerce/secure-remote-commerce.d.ts +4 -3
  175. package/bundles/types/secure-remote-commerce/secure-remote-commerce.d.ts.map +1 -0
  176. package/{lib → bundles/types}/vault-display-widget/index.d.ts +1 -0
  177. package/bundles/types/vault-display-widget/index.d.ts.map +1 -0
  178. package/{lib → bundles/types}/vault-display-widget/vault-display-widget.d.ts +1 -0
  179. package/bundles/types/vault-display-widget/vault-display-widget.d.ts.map +1 -0
  180. package/{lib → bundles/types}/wallet-buttons/afterpay.wallet-service.d.ts +1 -0
  181. package/bundles/types/wallet-buttons/afterpay.wallet-service.d.ts.map +1 -0
  182. package/{lib → bundles/types}/wallet-buttons/apple.wallet-service.d.ts +1 -0
  183. package/bundles/types/wallet-buttons/apple.wallet-service.d.ts.map +1 -0
  184. package/{lib → bundles/types}/wallet-buttons/flypay-v2.wallet-service.d.ts +2 -1
  185. package/bundles/types/wallet-buttons/flypay-v2.wallet-service.d.ts.map +1 -0
  186. package/{lib → bundles/types}/wallet-buttons/flypay.wallet-service.d.ts +1 -0
  187. package/bundles/types/wallet-buttons/flypay.wallet-service.d.ts.map +1 -0
  188. package/{lib → bundles/types}/wallet-buttons/google.wallet-service.d.ts +1 -0
  189. package/bundles/types/wallet-buttons/google.wallet-service.d.ts.map +1 -0
  190. package/bundles/types/wallet-buttons/helpers/flypay-v2.helper.d.ts +6 -0
  191. package/bundles/types/wallet-buttons/helpers/flypay-v2.helper.d.ts.map +1 -0
  192. package/bundles/types/wallet-buttons/index-cba.d.ts +2 -0
  193. package/bundles/types/wallet-buttons/index-cba.d.ts.map +1 -0
  194. package/{lib → bundles/types}/wallet-buttons/index.d.ts +1 -0
  195. package/bundles/types/wallet-buttons/index.d.ts.map +1 -0
  196. package/{lib → bundles/types}/wallet-buttons/interfaces.d.ts +1 -0
  197. package/bundles/types/wallet-buttons/interfaces.d.ts.map +1 -0
  198. package/{lib → bundles/types}/wallet-buttons/mastercard.wallet-service.d.ts +1 -0
  199. package/bundles/types/wallet-buttons/mastercard.wallet-service.d.ts.map +1 -0
  200. package/{lib → bundles/types}/wallet-buttons/paypal.wallet-service.d.ts +1 -0
  201. package/bundles/types/wallet-buttons/paypal.wallet-service.d.ts.map +1 -0
  202. package/{lib → bundles/types}/wallet-buttons/stripe.wallet-service.d.ts +1 -0
  203. package/bundles/types/wallet-buttons/stripe.wallet-service.d.ts.map +1 -0
  204. package/{lib → bundles/types}/wallet-buttons/wallet-buttons.d.ts +1 -0
  205. package/bundles/types/wallet-buttons/wallet-buttons.d.ts.map +1 -0
  206. package/bundles/types/wallet-buttons/wallet-cba-buttons.d.ts +330 -0
  207. package/bundles/types/wallet-buttons/wallet-cba-buttons.d.ts.map +1 -0
  208. package/{lib → bundles/types}/wallet-buttons/wallet-service.d.ts +1 -0
  209. package/bundles/types/wallet-buttons/wallet-service.d.ts.map +1 -0
  210. package/{lib → bundles/types}/widget/configuration.d.ts +2 -1
  211. package/bundles/types/widget/configuration.d.ts.map +1 -0
  212. package/{lib → bundles/types}/widget/html-multi-widget.d.ts +4 -3
  213. package/bundles/types/widget/html-multi-widget.d.ts.map +1 -0
  214. package/{lib → bundles/types}/widget/html-widget.d.ts +1 -0
  215. package/bundles/types/widget/html-widget.d.ts.map +1 -0
  216. package/{lib → bundles/types}/widget/index.d.ts +2 -1
  217. package/bundles/types/widget/index.d.ts.map +1 -0
  218. package/{lib → bundles/types}/widget/meta.d.ts +1 -0
  219. package/bundles/types/widget/meta.d.ts.map +1 -0
  220. package/{lib → bundles/types}/widget/multi-widget.d.ts +2 -1
  221. package/bundles/types/widget/multi-widget.d.ts.map +1 -0
  222. package/{lib → bundles/types}/widget/style.d.ts +1 -0
  223. package/bundles/types/widget/style.d.ts.map +1 -0
  224. package/bundles/widget.umd.js +6755 -6894
  225. package/bundles/widget.umd.js.d.ts +3206 -0
  226. package/bundles/widget.umd.js.map +1 -0
  227. package/bundles/widget.umd.js.min.d.ts +3206 -0
  228. package/bundles/widget.umd.min.js +2 -1
  229. package/bundles/widget.umd.min.js.map +1 -0
  230. package/docs/api-canvas3ds.md +158 -0
  231. package/docs/api-checkout-button.md +912 -0
  232. package/docs/api-examples.md +65 -0
  233. package/docs/api-ps-widget.md +585 -0
  234. package/docs/api-vault-display.md +94 -0
  235. package/docs/api-widget.md +2499 -0
  236. package/docs/api-wrapper.md +78 -0
  237. package/docs/canvas3ds-examples.md +242 -0
  238. package/docs/cba-header.md +13 -0
  239. package/docs/cba-license.md +2 -0
  240. package/docs/checkout-examples.md +248 -0
  241. package/docs/click-to-pay-examples.md +231 -0
  242. package/docs/click-to-pay.md +336 -0
  243. package/docs/header.md +15 -0
  244. package/docs/html/layout.html +78 -0
  245. package/docs/html/marked.js +23 -0
  246. package/docs/html/style.css +365 -0
  247. package/docs/install/npm.content.md +16 -0
  248. package/docs/install/npm.example.md +24 -0
  249. package/docs/install/umd.content.md +20 -0
  250. package/docs/install/umd.example.md +6 -0
  251. package/docs/install.md +43 -0
  252. package/docs/install.readme.t.md +17 -0
  253. package/docs/install.slate.t.md +17 -0
  254. package/docs/license.md +2 -0
  255. package/docs/partials/header.hbs +3 -0
  256. package/docs/ps-examples.md +129 -0
  257. package/docs/vault-display-example.md +132 -0
  258. package/docs/wallet-buttons-examples.md +609 -0
  259. package/docs/wallet-buttons.md +619 -0
  260. package/docs/wallet-cba-buttons-examples.md +388 -0
  261. package/docs/widget-examples.md +134 -0
  262. package/package.json +164 -42
  263. package/slate.md +141 -106
  264. package/.nvmrc +0 -1
  265. package/api.d.ts +0 -1
  266. package/api.js +0 -1
  267. package/canvas3ds.d.ts +0 -1
  268. package/canvas3ds.js +0 -1
  269. package/checkout-button.d.ts +0 -1
  270. package/checkout-button.js +0 -1
  271. package/inicialization-guide.md +0 -7
  272. package/lib/api/api-base.js +0 -101
  273. package/lib/api/api-base.js.map +0 -1
  274. package/lib/api/api-charge-internal.js +0 -30
  275. package/lib/api/api-charge-internal.js.map +0 -1
  276. package/lib/api/api-charge.js +0 -49
  277. package/lib/api/api-charge.js.map +0 -1
  278. package/lib/api/api-internal.js +0 -13
  279. package/lib/api/api-internal.js.map +0 -1
  280. package/lib/api/api-service-internal.js +0 -19
  281. package/lib/api/api-service-internal.js.map +0 -1
  282. package/lib/api/api.js +0 -62
  283. package/lib/api/api.js.map +0 -1
  284. package/lib/api/index.d.ts +0 -1
  285. package/lib/api/index.js +0 -2
  286. package/lib/api/index.js.map +0 -1
  287. package/lib/canvas-3ds/canvas-3ds.js +0 -157
  288. package/lib/canvas-3ds/canvas-3ds.js.map +0 -1
  289. package/lib/canvas-3ds/index.js +0 -2
  290. package/lib/canvas-3ds/index.js.map +0 -1
  291. package/lib/canvas-3ds/services/gpayments-service.js +0 -181
  292. package/lib/canvas-3ds/services/gpayments-service.js.map +0 -1
  293. package/lib/canvas-3ds/services/index.js +0 -2
  294. package/lib/canvas-3ds/services/index.js.map +0 -1
  295. package/lib/canvas-3ds/services/standalone3ds-service.js +0 -32
  296. package/lib/canvas-3ds/services/standalone3ds-service.js.map +0 -1
  297. package/lib/checkout-button/afterpay/afterpay-checkout-button.js +0 -50
  298. package/lib/checkout-button/afterpay/afterpay-checkout-button.js.map +0 -1
  299. package/lib/checkout-button/afterpay/afterpay.runner.js +0 -41
  300. package/lib/checkout-button/afterpay/afterpay.runner.js.map +0 -1
  301. package/lib/checkout-button/checkout-button.interface.js +0 -45
  302. package/lib/checkout-button/checkout-button.interface.js.map +0 -1
  303. package/lib/checkout-button/checkout-button.js +0 -266
  304. package/lib/checkout-button/checkout-button.js.map +0 -1
  305. package/lib/checkout-button/checkout-contextual-handler.js +0 -75
  306. package/lib/checkout-button/checkout-contextual-handler.js.map +0 -1
  307. package/lib/checkout-button/index.js +0 -85
  308. package/lib/checkout-button/index.js.map +0 -1
  309. package/lib/checkout-button/paypal/paypal-checkout-button.js +0 -25
  310. package/lib/checkout-button/paypal/paypal-checkout-button.js.map +0 -1
  311. package/lib/checkout-button/paypal/paypal.runner.js +0 -14
  312. package/lib/checkout-button/paypal/paypal.runner.js.map +0 -1
  313. package/lib/checkout-button/runner/base.runner.js +0 -13
  314. package/lib/checkout-button/runner/base.runner.js.map +0 -1
  315. package/lib/checkout-button/runner/contextual.runner.js +0 -40
  316. package/lib/checkout-button/runner/contextual.runner.js.map +0 -1
  317. package/lib/checkout-button/runner/index.js +0 -11
  318. package/lib/checkout-button/runner/index.js.map +0 -1
  319. package/lib/checkout-button/runner/popup.runner.js +0 -68
  320. package/lib/checkout-button/runner/popup.runner.js.map +0 -1
  321. package/lib/checkout-button/runner/redirect.runner.js +0 -15
  322. package/lib/checkout-button/runner/redirect.runner.js.map +0 -1
  323. package/lib/checkout-button/zipmoney/zipmoney-checkout-button.js +0 -64
  324. package/lib/checkout-button/zipmoney/zipmoney-checkout-button.js.map +0 -1
  325. package/lib/checkout-button/zipmoney/zipmoney-contextual.runner.js +0 -78
  326. package/lib/checkout-button/zipmoney/zipmoney-contextual.runner.js.map +0 -1
  327. package/lib/checkout-button/zipmoney/zipmoney-redirect.runner.js +0 -49
  328. package/lib/checkout-button/zipmoney/zipmoney-redirect.runner.js.map +0 -1
  329. package/lib/checkout-button/zipmoney/zipmoney.config.js +0 -4
  330. package/lib/checkout-button/zipmoney/zipmoney.config.js.map +0 -1
  331. package/lib/checkout-button/zipmoney/zipmoney.runner.js +0 -23
  332. package/lib/checkout-button/zipmoney/zipmoney.runner.js.map +0 -1
  333. package/lib/checkout-button/zipmoney/zipmoney.types.js +0 -1
  334. package/lib/checkout-button/zipmoney/zipmoney.types.js.map +0 -1
  335. package/lib/components/ability-guard.js +0 -44
  336. package/lib/components/ability-guard.js.map +0 -1
  337. package/lib/components/background.js +0 -193
  338. package/lib/components/background.js.map +0 -1
  339. package/lib/components/container.js +0 -63
  340. package/lib/components/container.js.map +0 -1
  341. package/lib/components/dispatcher.js +0 -39
  342. package/lib/components/dispatcher.js.map +0 -1
  343. package/lib/components/element-style.js +0 -52
  344. package/lib/components/element-style.js.map +0 -1
  345. package/lib/components/flypay-iframe-event.js +0 -28
  346. package/lib/components/flypay-iframe-event.js.map +0 -1
  347. package/lib/components/form-Interceptor.js +0 -38
  348. package/lib/components/form-Interceptor.js.map +0 -1
  349. package/lib/components/http-core.js +0 -57
  350. package/lib/components/http-core.js.map +0 -1
  351. package/lib/components/iframe-event.js +0 -77
  352. package/lib/components/iframe-event.js.map +0 -1
  353. package/lib/components/iframe.js +0 -62
  354. package/lib/components/iframe.js.map +0 -1
  355. package/lib/components/link.js +0 -60
  356. package/lib/components/link.js.map +0 -1
  357. package/lib/components/loader.js +0 -234
  358. package/lib/components/loader.js.map +0 -1
  359. package/lib/components/param.js +0 -147
  360. package/lib/components/param.js.map +0 -1
  361. package/lib/components/popup.js +0 -104
  362. package/lib/components/popup.js.map +0 -1
  363. package/lib/components/storage-dispatcher.js +0 -75
  364. package/lib/components/storage-dispatcher.js.map +0 -1
  365. package/lib/components/trigger.js +0 -49
  366. package/lib/components/trigger.js.map +0 -1
  367. package/lib/components/vault-display-iframe-event.js +0 -27
  368. package/lib/components/vault-display-iframe-event.js.map +0 -1
  369. package/lib/components/wallet-background.js +0 -75
  370. package/lib/components/wallet-background.js.map +0 -1
  371. package/lib/components/wallet-trigger.js +0 -27
  372. package/lib/components/wallet-trigger.js.map +0 -1
  373. package/lib/configs/env/env.js +0 -117
  374. package/lib/configs/env/env.js.map +0 -1
  375. package/lib/configs/sdk.js +0 -16
  376. package/lib/configs/sdk.js.map +0 -1
  377. package/lib/constants/validators.js +0 -42
  378. package/lib/constants/validators.js.map +0 -1
  379. package/lib/external-checkout/builder.js +0 -45
  380. package/lib/external-checkout/builder.js.map +0 -1
  381. package/lib/external-checkout/checker.js +0 -22
  382. package/lib/external-checkout/checker.js.map +0 -1
  383. package/lib/external-checkout/index.d.ts +0 -2
  384. package/lib/external-checkout/index.js +0 -3
  385. package/lib/external-checkout/index.js.map +0 -1
  386. package/lib/helper/access-token.js +0 -44
  387. package/lib/helper/access-token.js.map +0 -1
  388. package/lib/helper/browser.js +0 -79
  389. package/lib/helper/browser.js.map +0 -1
  390. package/lib/helper/event-emitter.js +0 -23
  391. package/lib/helper/event-emitter.js.map +0 -1
  392. package/lib/helper/event.js +0 -23
  393. package/lib/helper/event.js.map +0 -1
  394. package/lib/helper/ms.js +0 -32
  395. package/lib/helper/ms.js.map +0 -1
  396. package/lib/helper/object.js +0 -6
  397. package/lib/helper/object.js.map +0 -1
  398. package/lib/helper/url.js +0 -11
  399. package/lib/helper/url.js.map +0 -1
  400. package/lib/helper/uuid.js +0 -26
  401. package/lib/helper/uuid.js.map +0 -1
  402. package/lib/index.d.ts +0 -15
  403. package/lib/index.js +0 -15
  404. package/lib/index.js.map +0 -1
  405. package/lib/payment-source/builder.js +0 -49
  406. package/lib/payment-source/builder.js.map +0 -1
  407. package/lib/payment-source/index.js +0 -2
  408. package/lib/payment-source/index.js.map +0 -1
  409. package/lib/payment-source-widget/html-payment-source-widget.js +0 -172
  410. package/lib/payment-source-widget/html-payment-source-widget.js.map +0 -1
  411. package/lib/payment-source-widget/index.js +0 -35
  412. package/lib/payment-source-widget/index.js.map +0 -1
  413. package/lib/payment-source-widget/interfaces.js +0 -2
  414. package/lib/payment-source-widget/interfaces.js.map +0 -1
  415. package/lib/payment-source-widget/payment-source-widget.js +0 -142
  416. package/lib/payment-source-widget/payment-source-widget.js.map +0 -1
  417. package/lib/secure-remote-commerce/index.js +0 -103
  418. package/lib/secure-remote-commerce/index.js.map +0 -1
  419. package/lib/secure-remote-commerce/interfaces.js +0 -48
  420. package/lib/secure-remote-commerce/interfaces.js.map +0 -1
  421. package/lib/secure-remote-commerce/mastercard-secure-remote-commerce.d.ts +0 -30
  422. package/lib/secure-remote-commerce/mastercard-secure-remote-commerce.js +0 -40
  423. package/lib/secure-remote-commerce/mastercard-secure-remote-commerce.js.map +0 -1
  424. package/lib/secure-remote-commerce/providers/mastercard-src/index.d.ts +0 -1
  425. package/lib/secure-remote-commerce/providers/mastercard-src/index.js +0 -2
  426. package/lib/secure-remote-commerce/providers/mastercard-src/index.js.map +0 -1
  427. package/lib/secure-remote-commerce/providers/mastercard-src/mastercard-src.js +0 -89
  428. package/lib/secure-remote-commerce/providers/mastercard-src/mastercard-src.js.map +0 -1
  429. package/lib/secure-remote-commerce/providers/src-provider.js +0 -1
  430. package/lib/secure-remote-commerce/providers/src-provider.js.map +0 -1
  431. package/lib/secure-remote-commerce/secure-remote-commerce.js +0 -155
  432. package/lib/secure-remote-commerce/secure-remote-commerce.js.map +0 -1
  433. package/lib/vault-display-widget/index.js +0 -14
  434. package/lib/vault-display-widget/index.js.map +0 -1
  435. package/lib/vault-display-widget/vault-display-widget.js +0 -99
  436. package/lib/vault-display-widget/vault-display-widget.js.map +0 -1
  437. package/lib/wallet-buttons/afterpay.wallet-service.js +0 -152
  438. package/lib/wallet-buttons/afterpay.wallet-service.js.map +0 -1
  439. package/lib/wallet-buttons/apple.wallet-service.js +0 -324
  440. package/lib/wallet-buttons/apple.wallet-service.js.map +0 -1
  441. package/lib/wallet-buttons/flypay-v2.wallet-service.js +0 -163
  442. package/lib/wallet-buttons/flypay-v2.wallet-service.js.map +0 -1
  443. package/lib/wallet-buttons/flypay.wallet-service.js +0 -117
  444. package/lib/wallet-buttons/flypay.wallet-service.js.map +0 -1
  445. package/lib/wallet-buttons/google.wallet-service.js +0 -301
  446. package/lib/wallet-buttons/google.wallet-service.js.map +0 -1
  447. package/lib/wallet-buttons/helpers/flypay-v2.helper.d.ts +0 -3
  448. package/lib/wallet-buttons/helpers/flypay-v2.helper.js +0 -151
  449. package/lib/wallet-buttons/helpers/flypay-v2.helper.js.map +0 -1
  450. package/lib/wallet-buttons/index.js +0 -128
  451. package/lib/wallet-buttons/index.js.map +0 -1
  452. package/lib/wallet-buttons/interfaces.js +0 -1
  453. package/lib/wallet-buttons/interfaces.js.map +0 -1
  454. package/lib/wallet-buttons/mastercard.wallet-service.js +0 -27
  455. package/lib/wallet-buttons/mastercard.wallet-service.js.map +0 -1
  456. package/lib/wallet-buttons/paypal.wallet-service.js +0 -144
  457. package/lib/wallet-buttons/paypal.wallet-service.js.map +0 -1
  458. package/lib/wallet-buttons/stripe.wallet-service.js +0 -100
  459. package/lib/wallet-buttons/stripe.wallet-service.js.map +0 -1
  460. package/lib/wallet-buttons/wallet-buttons.js +0 -479
  461. package/lib/wallet-buttons/wallet-buttons.js.map +0 -1
  462. package/lib/wallet-buttons/wallet-service.js +0 -60
  463. package/lib/wallet-buttons/wallet-service.js.map +0 -1
  464. package/lib/widget/configuration.js +0 -260
  465. package/lib/widget/configuration.js.map +0 -1
  466. package/lib/widget/html-multi-widget.js +0 -422
  467. package/lib/widget/html-multi-widget.js.map +0 -1
  468. package/lib/widget/html-widget.js +0 -127
  469. package/lib/widget/html-widget.js.map +0 -1
  470. package/lib/widget/index.js +0 -132
  471. package/lib/widget/index.js.map +0 -1
  472. package/lib/widget/meta.js +0 -8
  473. package/lib/widget/meta.js.map +0 -1
  474. package/lib/widget/multi-widget.js +0 -437
  475. package/lib/widget/multi-widget.js.map +0 -1
  476. package/lib/widget/style.js +0 -204
  477. package/lib/widget/style.js.map +0 -1
  478. package/payment-source-widget.d.ts +0 -1
  479. package/payment-source-widget.js +0 -1
  480. package/tslint.json +0 -129
  481. package/typings/globals/jasmine/index.d.ts +0 -576
  482. package/typings/globals/jasmine-ajax/index.d.ts +0 -83
  483. package/typings/globals/jquery/index.d.ts +0 -3759
  484. package/typings/index.d.ts +0 -3
  485. package/vault-display-widget.d.ts +0 -1
  486. package/vault-display-widget.js +0 -1
  487. package/vendors/zipmoney.d.ts +0 -18
  488. package/vendors/zipmoney.js +0 -1
  489. package/widget.d.ts +0 -1
  490. package/widget.js +0 -1
package/docs/api-widget.md ADDED
@@ -0,0 +1,2499 @@
1
+ ## Classes
2
+
3
+ <dl>
4
+ <dt><a href="#user-content-w_HtmlWidget">HtmlWidget</a> ⇐ <code><a href="#user-content-w_HtmlMultiWidget">HtmlMultiWidget</a></code></dt>
5
+ <dd><p>Class Widget include method for working on html and include extended by HtmlMultiWidget methods</p>
6
+ </dd>
7
+ <dt><a href="#user-content-w_HtmlMultiWidget">HtmlMultiWidget</a> ⇐ <code><a href="#user-content-w_MultiWidget">MultiWidget</a></code></dt>
8
+ <dd><p>Class HtmlMultiWidget include method for working with html</p>
9
+ </dd>
10
+ <dt><a href="#user-content-w_Configuration">Configuration</a></dt>
11
+ <dd><p>Class Configuration include methods for creating configuration token</p>
12
+ </dd>
13
+ <dt><a href="#user-content-w_MultiWidget">MultiWidget</a></dt>
14
+ <dd><p>Class MultiWidget include method for for creating iframe url</p>
15
+ </dd>
16
+ </dl>
17
+
18
+ ## Constants
19
+
20
+ <dl>
21
+ <dt><a href="#user-content-w_EVENT">EVENT</a> : <code>object</code></dt>
22
+ <dd><p>List of available event&#39;s name</p>
23
+ </dd>
24
+ <dt><a href="#user-content-w_VAULT_DISPLAY_EVENT">VAULT_DISPLAY_EVENT</a> : <code>object</code></dt>
25
+ <dd><p>List of available event&#39;s name</p>
26
+ </dd>
27
+ <dt><a href="#user-content-w_PAYMENT_TYPE">PAYMENT_TYPE</a> : <code>object</code></dt>
28
+ <dd><p>List of available payment source types</p>
29
+ </dd>
30
+ <dt><a href="#user-content-w_PURPOSE">PURPOSE</a> : <code>object</code></dt>
31
+ <dd><p>Purposes</p>
32
+ </dd>
33
+ <dt><a href="#user-content-w_FORM_FIELD">FORM_FIELD</a> : <code>object</code></dt>
34
+ <dd><p>Current constant include available type of fields which can be included to widget</p>
35
+ </dd>
36
+ <dt><a href="#user-content-w_STYLE">STYLE</a> : <code>object</code></dt>
37
+ <dd><p>List of available style params for widget</p>
38
+ </dd>
39
+ <dt><a href="#user-content-w_TEXT">TEXT</a> : <code>object</code></dt>
40
+ <dd><p>List of available text item params for widget</p>
41
+ </dd>
42
+ <dt><a href="#user-content-w_ELEMENT">ELEMENT</a> : <code>object</code></dt>
43
+ <dd><p>List of available params for hide elements</p>
44
+ </dd>
45
+ <dt><a href="#user-content-w_SUPPORTED_CARD_TYPES">SUPPORTED_CARD_TYPES</a> : <code>object</code></dt>
46
+ <dd><p>The list of available parameters for showing card icons</p>
47
+ </dd>
48
+ <dt><a href="#user-content-w_STYLABLE_ELEMENT">STYLABLE_ELEMENT</a> : <code>object</code></dt>
49
+ <dd><p>Current constant include available type of element for styling</p>
50
+ </dd>
51
+ <dt><a href="#user-content-w_STYLABLE_ELEMENT_STATE">STYLABLE_ELEMENT_STATE</a> : <code>object</code></dt>
52
+ <dd><p>Current constant include available states of element for styling</p>
53
+ </dd>
54
+ <dt><a href="#user-content-w_CARD_VALIDATORS">CARD_VALIDATORS</a> : <code>Record.&lt;string, string&gt;</code></dt>
55
+ <dd><p>List of available form field validators dedicated to cards and their definition</p>
56
+ </dd>
57
+ <dt><a href="#user-content-w_GENERIC_VALIDATORS">GENERIC_VALIDATORS</a> : <code>Record.&lt;string, string&gt;</code></dt>
58
+ <dd><p>List of available generic form field validators and their definition</p>
59
+ </dd>
60
+ <dt><a href="#user-content-w_TRIGGER">TRIGGER</a> : <code>object</code></dt>
61
+ <dd><p>List of available triggers</p>
62
+ </dd>
63
+ </dl>
64
+
65
+ ## Interfaces
66
+
67
+ <dl>
68
+ <dt><a href="#user-content-w_IFormValidation">IFormValidation</a></dt>
69
+ <dd><p>Interface of data from validation event.</p>
70
+ </dd>
71
+ <dt><a href="#user-content-w_IEventMetaData">IEventMetaData</a></dt>
72
+ <dd><p>Contains basic information associated with the event and additional meta data
73
+ specific to the event. E.g., card info, gateway info, etc.</p>
74
+ </dd>
75
+ <dt><a href="#user-content-w_IEventAfterLoadData">IEventAfterLoadData</a></dt>
76
+ <dd><p>Interface of data from event.</p>
77
+ </dd>
78
+ <dt><a href="#user-content-w_IEventFinishData">IEventFinishData</a></dt>
79
+ <dd><p>Interface of data from event.</p>
80
+ </dd>
81
+ <dt><a href="#user-content-w_IPayPalMeta">IPayPalMeta</a></dt>
82
+ <dd><p>Interface for PayPal checkout meta information</p>
83
+ </dd>
84
+ <dt><a href="#user-content-w_IStyles">IStyles</a></dt>
85
+ <dd><p>Interface for classes that represent widget&#39;s styles.</p>
86
+ </dd>
87
+ <dt><a href="#user-content-w_ITexts">ITexts</a></dt>
88
+ <dd><p>Interface for classes that represent widget&#39;s text.</p>
89
+ </dd>
90
+ <dt><a href="#user-content-w_IBamboraMeta">IBamboraMeta</a></dt>
91
+ <dd><p>Interface for Bamboora meta information</p>
92
+ </dd>
93
+ <dt><a href="#user-content-w_IElementStyleInput">IElementStyleInput</a></dt>
94
+ <dd><p>Interface for styling input element.</p>
95
+ </dd>
96
+ <dt><a href="#user-content-w_IElementStyleSubmitButton">IElementStyleSubmitButton</a></dt>
97
+ <dd><p>Interface for styling submit_button element.</p>
98
+ </dd>
99
+ <dt><a href="#user-content-w_IElementStyleLabel">IElementStyleLabel</a></dt>
100
+ <dd><p>Interface for styling label element.</p>
101
+ </dd>
102
+ <dt><a href="#user-content-w_IElementStyleTitle">IElementStyleTitle</a></dt>
103
+ <dd><p>Interface for styling title element.</p>
104
+ </dd>
105
+ <dt><a href="#user-content-w_IElementStyleTitleDescription">IElementStyleTitleDescription</a></dt>
106
+ <dd><p>Interface for styling title_description element.</p>
107
+ </dd>
108
+ <dt><a href="#user-content-w_ITriggerData">ITriggerData</a></dt>
109
+ <dd><p>Interface for classes that represent a trigger data.</p>
110
+ </dd>
111
+ </dl>
112
+
113
+ <a name="w_IFormValidation" id="w_IFormValidation" href="#user-content-w_IFormValidation">&nbsp;</a>
114
+
115
+ ## IFormValidation
116
+ Interface of data from validation event.
117
+
118
+ **Kind**: global interface
119
+
120
+ | Param | Type | Description |
121
+ | --- | --- | --- |
122
+ | event | <code>string</code> | The name of the event. |
123
+ | message_source | <code>string</code> | A system variable that identifies the event source. |
124
+ | purpose | <code>string</code> | A system variable that states the purpose of the event. |
125
+ | [ref_id] | <code>string</code> | Custom unique value that identifies result of processed operation. |
126
+ | [form_valid] | <code>boolean</code> | Indicates wether or not the form is valid. |
127
+ | [invalid_fields] | <code>Array.&lt;string&gt;</code> | Names of form fields with invalid data. |
128
+ | [invalid_showed_fields] | <code>Array.&lt;string&gt;</code> | Names of invalid form fields which are already displaying the error. |
129
+ | [validators] | <code>Partial.&lt;Record.&lt;(CardValidatorValue\|GenericValidatorValue), Array.&lt;string&gt;&gt;&gt;</code> | Object containing validator identifiers as keys and the fields subject to that validator as an array of form field names. See list of available [Generic Vallidators](#user-content-w_GENERIC_VALIDATORS) and [Card Validators](#user-content-w_CARD_VALIDATORS), |
130
+
131
+ <a name="w_IEventMetaData" id="w_IEventMetaData" href="#user-content-w_IEventMetaData">&nbsp;</a>
132
+
133
+ ## IEventMetaData
134
+ Contains basic information associated with the event and additional meta data
135
+ specific to the event. E.g., card info, gateway info, etc.
136
+
137
+ **Kind**: global interface
138
+
139
+ | Param | Type | Description |
140
+ | --- | --- | --- |
141
+ | event | <code>string</code> | The name of the event. |
142
+ | purpose | <code>string</code> | A system variable that states the purpose of the event. |
143
+ | message_source | <code>string</code> | A system variable that identifies the event source. |
144
+ | [ref_id] | <code>string</code> | Custom unique value that identifies result of processed operation. |
145
+ | configuration_token | <code>string</code> | Token received from our API with widget data |
146
+ | type | <code>string</code> | Payment type 'card', 'bank_account' |
147
+ | gateway_type | <code>string</code> | Gateway type |
148
+ | [card_number_last4] | <code>string</code> | Last 4 digit of your card |
149
+ | [card_scheme] | <code>string</code> | Card scheme, e.g., (Visa, Mastercard and American Express (AmEx)) |
150
+ | [card_number_length] | <code>number</code> | Card number length |
151
+ | [account_name] | <code>string</code> | Bank account account name |
152
+ | [account_number] | <code>string</code> | Bank account account number |
153
+
154
+ <a name="w_IEventAfterLoadData" id="w_IEventAfterLoadData" href="#user-content-w_IEventAfterLoadData">&nbsp;</a>
155
+
156
+ ## IEventAfterLoadData
157
+ Interface of data from event.
158
+
159
+ **Kind**: global interface
160
+
161
+ | Param | Type | Description |
162
+ | --- | --- | --- |
163
+ | event | <code>string</code> | The name of the event. |
164
+ | purpose | <code>string</code> | A system variable that states the purpose of the event. |
165
+ | message_source | <code>string</code> | A system variable that identifies the event source. |
166
+ | [ref_id] | <code>string</code> | Custom unique value that identifies result of processed operation. |
167
+
168
+ <a name="w_IEventFinishData" id="w_IEventFinishData" href="#user-content-w_IEventFinishData">&nbsp;</a>
169
+
170
+ ## IEventFinishData
171
+ Interface of data from event.
172
+
173
+ **Kind**: global interface
174
+
175
+ | Param | Type | Description |
176
+ | --- | --- | --- |
177
+ | event | <code>string</code> | The name of the event. |
178
+ | purpose | <code>string</code> | A system variable that states the purpose of the event. |
179
+ | message_source | <code>string</code> | A system variable that identifies the event source. |
180
+ | [ref_id] | <code>string</code> | Custom unique value that identifies result of processed operation. |
181
+ | payment_source | <code>string</code> | One time token. Result from this endpoint [API docs](https://docs.paydock.com/#tokens) |
182
+
183
+ <a name="w_IPayPalMeta" id="w_IPayPalMeta" href="#user-content-w_IPayPalMeta">&nbsp;</a>
184
+
185
+ ## IPayPalMeta
186
+ Interface for PayPal checkout meta information
187
+
188
+ **Kind**: global interface
189
+
190
+ | Param | Type | Description |
191
+ | --- | --- | --- |
192
+ | [brand_name] | <code>string</code> | A label that overrides the business name in the PayPal account on the PayPal hosted checkout pages |
193
+ | [cart_border_color] | <code>string</code> | The HTML hex code for your principal identifying color |
194
+ | [reference] | <code>string</code> | Merchant Customer Service number displayed on the PayPal pages |
195
+ | [email] | <code>string</code> | The consumer’s email |
196
+ | [hdr_img] | <code>string</code> | URL for the image you want to appear at the top left of the payment page |
197
+ | [logo_img] | <code>string</code> | A URL to your logo image |
198
+ | [pay_flow_color] | <code>string</code> | Sets the background color for the payment page. By default, the color is white. |
199
+ | [first_name] | <code>string</code> | The consumer’s given names |
200
+ | [last_name] | <code>string</code> | The consumer’s surname |
201
+ | [address_line] | <code>string</code> | Street address |
202
+ | [address_line2] | <code>string</code> | Second line of the address |
203
+ | [address_city] | <code>string</code> | City |
204
+ | [address_state] | <code>string</code> | State |
205
+ | [address_postcode] | <code>string</code> | Postcode |
206
+ | [address_country] | <code>string</code> | Country |
207
+ | [phone] | <code>string</code> | The consumer’s phone number in E.164 international notation (Example: +12345678901) |
208
+ | [hide_shipping_address] | <code>boolean</code> | Determines whether PayPal displays shipping address fields on the PayPal pages |
209
+
210
+ <a name="w_IStyles" id="w_IStyles" href="#user-content-w_IStyles">&nbsp;</a>
211
+
212
+ ## IStyles
213
+ Interface for classes that represent widget's styles.
214
+
215
+ **Kind**: global interface
216
+
217
+ | Param | Type |
218
+ | --- | --- |
219
+ | [background_color] | <code>string</code> |
220
+ | [text_color] | <code>string</code> |
221
+ | [border_color] | <code>string</code> |
222
+ | [button_color] | <code>string</code> |
223
+ | [error_color] | <code>string</code> |
224
+ | [success_color] | <code>string</code> |
225
+ | [font_size] | <code>string</code> |
226
+ | [font_family] | <code>string</code> |
227
+
228
+ <a name="w_ITexts" id="w_ITexts" href="#user-content-w_ITexts">&nbsp;</a>
229
+
230
+ ## ITexts
231
+ Interface for classes that represent widget's text.
232
+
233
+ **Kind**: global interface
234
+
235
+ | Param | Type |
236
+ | --- | --- |
237
+ | [title] | <code>string</code> |
238
+ | [title_h1] | <code>string</code> |
239
+ | [title_h2] | <code>string</code> |
240
+ | [title_h3] | <code>string</code> |
241
+ | [title_h4] | <code>string</code> |
242
+ | [title_h5] | <code>string</code> |
243
+ | [title_h6] | <code>string</code> |
244
+ | [finish_text] | <code>string</code> |
245
+ | [title_description] | <code>string</code> |
246
+ | [submit_button] | <code>string</code> |
247
+ | [submit_button_processing] | <code>string</code> |
248
+
249
+ <a name="w_IBamboraMeta" id="w_IBamboraMeta" href="#user-content-w_IBamboraMeta">&nbsp;</a>
250
+
251
+ ## IBamboraMeta
252
+ Interface for Bamboora meta information
253
+
254
+ **Kind**: global interface
255
+
256
+ | Param | Type | Description |
257
+ | --- | --- | --- |
258
+ | [customer_storage_number] | <code>string</code> | Customer storage number |
259
+ | [tokenise_algorithm] | <code>number</code> | Tokenise algorithm |
260
+
261
+ <a name="w_IElementStyleInput" id="w_IElementStyleInput" href="#user-content-w_IElementStyleInput">&nbsp;</a>
262
+
263
+ ## IElementStyleInput
264
+ Interface for styling input element.
265
+
266
+ **Kind**: global interface
267
+
268
+ | Param | Type | Description |
269
+ | --- | --- | --- |
270
+ | [color] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/color) |
271
+ | [border] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/border) |
272
+ | [border_radius] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/border-radius) |
273
+ | [background_color] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/background-color) |
274
+ | [height] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/height) |
275
+ | [text_decoration] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/text-decoration) |
276
+ | [font_size] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/font-size) |
277
+ | [font_family] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/font-family) |
278
+ | [transition] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/transition) |
279
+ | [line_height] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/line-height) |
280
+ | [font_weight] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/font-weight) |
281
+ | [padding] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/padding) |
282
+ | [margin] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/margin) |
283
+
284
+ <a name="w_IElementStyleSubmitButton" id="w_IElementStyleSubmitButton" href="#user-content-w_IElementStyleSubmitButton">&nbsp;</a>
285
+
286
+ ## IElementStyleSubmitButton
287
+ Interface for styling submit_button element.
288
+
289
+ **Kind**: global interface
290
+
291
+ | Param | Type | Description |
292
+ | --- | --- | --- |
293
+ | [color] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/color) |
294
+ | [border] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/border) |
295
+ | [border_radius] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/border-radius) |
296
+ | [background_color] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/background-color) |
297
+ | [text_decoration] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/text-decoration) |
298
+ | [font_size] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/font-size) |
299
+ | [font_family] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/font-family) |
300
+ | [padding] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/padding) |
301
+ | [margin] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/margin) |
302
+ | [transition] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/transition) |
303
+ | [line_height] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/line-height) |
304
+ | [font_weight] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/font-weight) |
305
+ | [opacity] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/opacity) |
306
+
307
+ <a name="w_IElementStyleLabel" id="w_IElementStyleLabel" href="#user-content-w_IElementStyleLabel">&nbsp;</a>
308
+
309
+ ## IElementStyleLabel
310
+ Interface for styling label element.
311
+
312
+ **Kind**: global interface
313
+
314
+ | Param | Type | Description |
315
+ | --- | --- | --- |
316
+ | [color] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/color) |
317
+ | [text_decoration] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/text-decoration) |
318
+ | [font_size] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/font-size) |
319
+ | [font_family] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/font-family) |
320
+ | [line_height] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/line-height) |
321
+ | [font_weight] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/font-weight) |
322
+ | [padding] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/padding) |
323
+ | [margin] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/margin) |
324
+
325
+ <a name="w_IElementStyleTitle" id="w_IElementStyleTitle" href="#user-content-w_IElementStyleTitle">&nbsp;</a>
326
+
327
+ ## IElementStyleTitle
328
+ Interface for styling title element.
329
+
330
+ **Kind**: global interface
331
+
332
+ | Param | Type | Description |
333
+ | --- | --- | --- |
334
+ | [color] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/color) |
335
+ | [text_decoration] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/text-decoration) |
336
+ | [font_size] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/font-size) |
337
+ | [font_family] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/font-family) |
338
+ | [line_height] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/line-height) |
339
+ | [font_weight] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/font-weight) |
340
+ | [padding] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/padding) |
341
+ | [margin] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/margin) |
342
+ | ['text-align',] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/text-align) |
343
+
344
+ <a name="w_IElementStyleTitleDescription" id="w_IElementStyleTitleDescription" href="#user-content-w_IElementStyleTitleDescription">&nbsp;</a>
345
+
346
+ ## IElementStyleTitleDescription
347
+ Interface for styling title_description element.
348
+
349
+ **Kind**: global interface
350
+
351
+ | Param | Type | Description |
352
+ | --- | --- | --- |
353
+ | [color] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/color) |
354
+ | [text_decoration] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/text-decoration) |
355
+ | [font_size] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/font-size) |
356
+ | [font_family] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/font-family) |
357
+ | [line_height] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/line-height) |
358
+ | [font_weight] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/font-weight) |
359
+ | [padding] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/padding) |
360
+ | [margin] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/margin) |
361
+ | ['text-align',] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/text-align) |
362
+
363
+ <a name="w_ITriggerData" id="w_ITriggerData" href="#user-content-w_ITriggerData">&nbsp;</a>
364
+
365
+ ## ITriggerData
366
+ Interface for classes that represent a trigger data.
367
+
368
+ **Kind**: global interface
369
+
370
+ | Param | Type |
371
+ | --- | --- |
372
+ | [configuration_token] | <code>string</code> |
373
+ | [tab_number] | <code>string</code> |
374
+ | [elements] | <code>string</code> |
375
+ | [form_values] | <code>string</code> |
376
+
377
+ <a name="w_HtmlWidget" id="w_HtmlWidget" href="#user-content-w_HtmlWidget">&nbsp;</a>
378
+
379
+ ## HtmlWidget ⇐ [<code>HtmlMultiWidget</code>](#user-content-w_HtmlMultiWidget)
380
+ Class Widget include method for working on html and include extended by HtmlMultiWidget methods
381
+
382
+ **Kind**: global class
383
+ **Extends**: [<code>HtmlMultiWidget</code>](#user-content-w_HtmlMultiWidget), [<code>MultiWidget</code>](#user-content-w_MultiWidget)
384
+
385
+ * [HtmlWidget](#user-content-w_HtmlWidget) ⇐ [<code>HtmlMultiWidget</code>](#user-content-w_HtmlMultiWidget)
386
+ * [new HtmlWidget(selector, publicKey, [gatewayID], [paymentType], [purpose])](#user-content-w_new_HtmlWidget_new)
387
+ * [.setWebHookDestination(url)](#user-content-w_HtmlWidget+setWebHookDestination)
388
+ * [.setSuccessRedirectUrl(url)](#user-content-w_HtmlWidget+setSuccessRedirectUrl)
389
+ * [.setErrorRedirectUrl(url)](#user-content-w_HtmlWidget+setErrorRedirectUrl)
390
+ * [.setFormFields(fields)](#user-content-w_HtmlWidget+setFormFields)
391
+ * [.setFormElements(elements)](#user-content-w_HtmlWidget+setFormElements)
392
+ * [.setMeta(object)](#user-content-w_HtmlWidget+setMeta)
393
+ * [.load()](#user-content-w_HtmlMultiWidget+load)
394
+ * [.afterLoad()](#user-content-w_HtmlMultiWidget+afterLoad)
395
+ * [.trigger(triggers, data)](#user-content-w_HtmlMultiWidget+trigger)
396
+ * [.getValidationState()](#user-content-w_HtmlMultiWidget+getValidationState) ⇒ [<code>IFormValidation</code>](#user-content-w_IFormValidation)
397
+ * [.isValidForm()](#user-content-w_HtmlMultiWidget+isValidForm) ⇒ <code>boolean</code>
398
+ * [.isInvalidField(field)](#user-content-w_HtmlMultiWidget+isInvalidField) ⇒ <code>boolean</code>
399
+ * [.isFieldErrorShowed(field)](#user-content-w_HtmlMultiWidget+isFieldErrorShowed) ⇒ <code>boolean</code>
400
+ * [.isInvalidFieldByValidator(field, validator)](#user-content-w_HtmlMultiWidget+isInvalidFieldByValidator) ⇒ <code>boolean</code>
401
+ * [.hide([saveSize])](#user-content-w_HtmlMultiWidget+hide)
402
+ * [.show()](#user-content-w_HtmlMultiWidget+show)
403
+ * [.reload()](#user-content-w_HtmlMultiWidget+reload)
404
+ * [.hideElements(elements)](#user-content-w_HtmlMultiWidget+hideElements)
405
+ * [.showElements(elements)](#user-content-w_HtmlMultiWidget+showElements)
406
+ * [.updateFormValues(fieldValues)](#user-content-w_HtmlMultiWidget+updateFormValues)
407
+ * [.updateFormValue(key, value)](#user-content-w_HtmlMultiWidget+updateFormValue)
408
+ * [.onFinishInsert(selector, dataType)](#user-content-w_HtmlMultiWidget+onFinishInsert)
409
+ * [.interceptSubmitForm(selector)](#user-content-w_HtmlMultiWidget+interceptSubmitForm)
410
+ * [.useCheckoutAutoSubmit()](#user-content-w_HtmlMultiWidget+useCheckoutAutoSubmit)
411
+ * [.useAutoResize()](#user-content-w_HtmlMultiWidget+useAutoResize)
412
+ * [.setStyles(fields)](#user-content-w_MultiWidget+setStyles)
413
+ * [.usePhoneCountryMask([options])](#user-content-w_MultiWidget+usePhoneCountryMask)
414
+ * [.setTexts(fields)](#user-content-w_MultiWidget+setTexts)
415
+ * [.setElementStyle(element, [state], styles)](#user-content-w_MultiWidget+setElementStyle)
416
+ * [.setFormValues(fieldValues)](#user-content-w_MultiWidget+setFormValues)
417
+ * [.setFormLabels(fieldLabels)](#user-content-w_MultiWidget+setFormLabels)
418
+ * [.setFormPlaceholders(fieldPlaceholders)](#user-content-w_MultiWidget+setFormPlaceholders)
419
+ * ~~[.setIcons()](#user-content-w_MultiWidget+setIcons)~~
420
+ * [.setHiddenElements(elements)](#user-content-w_MultiWidget+setHiddenElements)
421
+ * [.setRefId(refId)](#user-content-w_MultiWidget+setRefId)
422
+ * [.useGatewayFieldValidation()](#user-content-w_MultiWidget+useGatewayFieldValidation)
423
+ * [.setSupportedCardIcons(elements, validateCardNumberInput)](#user-content-w_MultiWidget+setSupportedCardIcons)
424
+ * [.setEnv(env, [alias])](#user-content-w_MultiWidget+setEnv)
425
+ * [.loadIFrameUrl()](#user-content-w_MultiWidget+loadIFrameUrl)
426
+ * [.setLanguage(code)](#user-content-w_MultiWidget+setLanguage)
427
+
428
+ <a name="w_new_HtmlWidget_new" id="w_new_HtmlWidget_new" href="#user-content-w_new_HtmlWidget_new">&nbsp;</a>
429
+
430
+ ### new HtmlWidget(selector, publicKey, [gatewayID], [paymentType], [purpose])
431
+
432
+ | Param | Type | Default | Description |
433
+ | --- | --- | --- | --- |
434
+ | selector | <code>string</code> | | Selector of html element. Container for widget |
435
+ | publicKey | <code>string</code> | | PayDock users public key |
436
+ | [gatewayID] | <code>string</code> | <code>&quot;default&quot;</code> | ID of a gateway connected to PayDock. By default or if put 'default', it will use the selected default gateway. If put 'not_configured', it won’t use gateway to create downstream token. |
437
+ | [paymentType] | <code>string</code> | <code>&quot;card&quot;</code> | Type of payment source which shows in widget form. Available parameters : “card”, “bank_account”. |
438
+ | [purpose] | <code>string</code> | <code>&quot;payment_source&quot;</code> | Purpose of widget form. Available parameters: ‘payment_source’, ‘card_payment_source_with_cvv’, ‘card_payment_source_without_cvv’ |
439
+
440
+ **Example**
441
+
442
+ ```javascript
443
+ var widget = new HtmlWidget('#widget', 'publicKey', 'gatewayID'); // short
444
+
445
+ var widget = new HtmlWidget('#widget', 'publicKey', 'gatewayID', 'bank_account', 'payment_source'); // extend
446
+
447
+ var widget = new HtmlWidget('#widget', 'publicKey', 'not_configured'); // without gateway
448
+ ```
449
+ <a name="w_HtmlWidget+setWebHookDestination" id="w_HtmlWidget+setWebHookDestination" href="#user-content-w_HtmlWidget+setWebHookDestination">&nbsp;</a>
450
+
451
+ ### htmlWidget.setWebHookDestination(url)
452
+ Destination, where customer will receive all successful responses.
453
+ Response will contain “data” object with “payment_source” or other parameters, in depending on 'purpose'
454
+
455
+ **Kind**: instance method of [<code>HtmlWidget</code>](#user-content-w_HtmlWidget)
456
+
457
+ | Param | Type | Description |
458
+ | --- | --- | --- |
459
+ | url | <code>string</code> | Your endpoint for post request. |
460
+
461
+ **Example**
462
+
463
+ ```javascript
464
+ widget.setWebHookDestination('http://google.com');
465
+ ```
466
+ <a name="w_HtmlWidget+setSuccessRedirectUrl" id="w_HtmlWidget+setSuccessRedirectUrl" href="#user-content-w_HtmlWidget+setSuccessRedirectUrl">&nbsp;</a>
467
+
468
+ ### htmlWidget.setSuccessRedirectUrl(url)
469
+ URL to which the Customer will be redirected to after the success finish
470
+
471
+ **Kind**: instance method of [<code>HtmlWidget</code>](#user-content-w_HtmlWidget)
472
+
473
+ | Param | Type |
474
+ | --- | --- |
475
+ | url | <code>string</code> |
476
+
477
+ **Example**
478
+
479
+ ```javascript
480
+ widget.setSuccessRedirectUrl('google.com/search?q=success');
481
+ ```
482
+ <a name="w_HtmlWidget+setErrorRedirectUrl" id="w_HtmlWidget+setErrorRedirectUrl" href="#user-content-w_HtmlWidget+setErrorRedirectUrl">&nbsp;</a>
483
+
484
+ ### htmlWidget.setErrorRedirectUrl(url)
485
+ URL to which the Customer will be redirected to if an error is triggered in the process of operation
486
+
487
+ **Kind**: instance method of [<code>HtmlWidget</code>](#user-content-w_HtmlWidget)
488
+
489
+ | Param | Type |
490
+ | --- | --- |
491
+ | url | <code>string</code> |
492
+
493
+ **Example**
494
+
495
+ ```javascript
496
+ widget.setErrorRedirectUrl('google.com/search?q=error');
497
+ ```
498
+ <a name="w_HtmlWidget+setFormFields" id="w_HtmlWidget+setFormFields" href="#user-content-w_HtmlWidget+setFormFields">&nbsp;</a>
499
+
500
+ ### htmlWidget.setFormFields(fields)
501
+ Set list with widget form field, which will be shown in form. Also you can set the required validation for these fields
502
+
503
+ **Kind**: instance method of [<code>HtmlWidget</code>](#user-content-w_HtmlWidget)
504
+
505
+ | Param | Type | Description |
506
+ | --- | --- | --- |
507
+ | fields | <code>Array.&lt;string&gt;</code> | name of fields which can be shown in a widget. If after a name of a field, you put “*”, this field will be required on client-side. (For validation, you can specify any fields, even those that are shown by default: card_number, expiration, etc... ) [FORM_FIELD](#user-content-w_FORM_FIELD) |
508
+
509
+ **Example**
510
+
511
+ ```javascript
512
+ widget.setFormFields(['phone', 'email', 'first_name*']);
513
+ ```
514
+ <a name="w_HtmlWidget+setFormElements" id="w_HtmlWidget+setFormElements" href="#user-content-w_HtmlWidget+setFormElements">&nbsp;</a>
515
+
516
+ ### htmlWidget.setFormElements(elements)
517
+ The method to set the full configuration for the all specific form elements (visibility, required, label, placeholder, value)
518
+ You can also use the other method for the partial configuration like: setFormFields, setFormValues, setFormPlaceholder, setFormLabel
519
+
520
+ **Kind**: instance method of [<code>HtmlWidget</code>](#user-content-w_HtmlWidget)
521
+ **Overrides**: [<code>setFormElements</code>](#user-content-w_MultiWidget+setFormElements)
522
+
523
+ | Param | Type | Description |
524
+ | --- | --- | --- |
525
+ | elements | <code>Array.&lt;Object&gt;</code> | List of elements |
526
+ | elements[].field | <code>string</code> | Field name of element. If after a name of a field, you put “*”, this field will be required on client-side. (For validation, you can specify any fields, even those that are shown by default: card_number, expiration, etc... ) [FORM_FIELD](#user-content-w_FORM_FIELD) |
527
+ | elements[].placeholder | <code>string</code> | Set custom placeholders in form fields |
528
+ | elements[].label | <code>string</code> | Set a custom labels near the form field |
529
+ | elements[].value | <code>string</code> | Set predefined values for the form field |
530
+
531
+ **Example**
532
+
533
+ ```javascript
534
+ widget.setFormElements([
535
+ {
536
+ field: 'card_name*',
537
+ placeholder: 'Input your card holder name...',
538
+ label: 'Card Holder Name',
539
+ value: 'Houston',
540
+ },
541
+ {
542
+ field: 'email',
543
+ placeholder: 'Input your email, like test@example.com',
544
+ label: 'Email for the receipt',
545
+ value: 'predefined@email.com',
546
+ },
547
+ ])
548
+ ```
549
+ <a name="w_HtmlWidget+setMeta" id="w_HtmlWidget+setMeta" href="#user-content-w_HtmlWidget+setMeta">&nbsp;</a>
550
+
551
+ ### htmlWidget.setMeta(object)
552
+ The method to set meta information for the checkout page
553
+
554
+ **Kind**: instance method of [<code>HtmlWidget</code>](#user-content-w_HtmlWidget)
555
+
556
+ | Param | Type | Description |
557
+ | --- | --- | --- |
558
+ | object | [<code>IPayPalMeta</code>](#user-content-w_IPayPalMeta) \| [<code>IBamboraMeta</code>](#user-content-w_IBamboraMeta) | data which can be shown on checkout page [IPayPalMeta](#user-content-w_IPayPalMeta) [IBamboraMeta](#user-content-w_IBamboraMeta) |
559
+
560
+ **Example**
561
+
562
+ ```javascript
563
+ config.setMeta({
564
+ brand_name: 'paydock',
565
+ reference: '15',
566
+ email: 'wault@paydock.com'
567
+ });
568
+ ```
569
+ <a name="w_HtmlMultiWidget+load" id="w_HtmlMultiWidget+load" href="#user-content-w_HtmlMultiWidget+load">&nbsp;</a>
570
+
571
+ ### htmlWidget.load()
572
+ Loads the widget.
573
+
574
+ Calling this method results in an iframe element being inserted and rendered in the DOM.
575
+
576
+ **Kind**: instance method of [<code>HtmlWidget</code>](#user-content-w_HtmlWidget)
577
+ **Overrides**: [<code>load</code>](#user-content-w_HtmlMultiWidget+load)
578
+ <a name="w_HtmlMultiWidget+afterLoad" id="w_HtmlMultiWidget+afterLoad" href="#user-content-w_HtmlMultiWidget+afterLoad">&nbsp;</a>
579
+
580
+ ### htmlWidget.afterLoad()
581
+ Registers a form validation callback for validation events.
582
+
583
+ **Kind**: instance method of [<code>HtmlWidget</code>](#user-content-w_HtmlWidget)
584
+ **Overrides**: [<code>afterLoad</code>](#user-content-w_HtmlMultiWidget+afterLoad)
585
+ <a name="w_HtmlMultiWidget+trigger" id="w_HtmlMultiWidget+trigger" href="#user-content-w_HtmlMultiWidget+trigger">&nbsp;</a>
586
+
587
+ ### htmlWidget.trigger(triggers, data)
588
+ Registers callback that will be invoked for every trigger.
589
+
590
+ **Kind**: instance method of [<code>HtmlWidget</code>](#user-content-w_HtmlWidget)
591
+ **Overrides**: [<code>trigger</code>](#user-content-w_HtmlMultiWidget+trigger)
592
+
593
+ | Param | Type | Description |
594
+ | --- | --- | --- |
595
+ | triggers | <code>&#x27;submit\_form&#x27;</code> \| <code>&#x27;tab&#x27;</code> | The Widget element identifier that caused the trigger. |
596
+ | data | [<code>ITriggerData</code>](#user-content-w_ITriggerData) | Data that will be sent to the widget when the trigger occurs. |
597
+
598
+ <a name="w_HtmlMultiWidget+getValidationState" id="w_HtmlMultiWidget+getValidationState" href="#user-content-w_HtmlMultiWidget+getValidationState">&nbsp;</a>
599
+
600
+ ### htmlWidget.getValidationState() ⇒ [<code>IFormValidation</code>](#user-content-w_IFormValidation)
601
+ Gets a reference to the form current validation state.
602
+
603
+ !Warning: do not directly modify the values of the returned object.
604
+
605
+ **Kind**: instance method of [<code>HtmlWidget</code>](#user-content-w_HtmlWidget)
606
+ **Overrides**: [<code>getValidationState</code>](#user-content-w_HtmlMultiWidget+getValidationState)
607
+ **Returns**: [<code>IFormValidation</code>](#user-content-w_IFormValidation) - Form validation object
608
+ <a name="w_HtmlMultiWidget+isValidForm" id="w_HtmlMultiWidget+isValidForm" href="#user-content-w_HtmlMultiWidget+isValidForm">&nbsp;</a>
609
+
610
+ ### htmlWidget.isValidForm() ⇒ <code>boolean</code>
611
+ Checks if a given form is valid.
612
+
613
+ A form is valid if all form fields are valid.
614
+
615
+ **Kind**: instance method of [<code>HtmlWidget</code>](#user-content-w_HtmlWidget)
616
+ **Overrides**: [<code>isValidForm</code>](#user-content-w_HtmlMultiWidget+isValidForm)
617
+ **Returns**: <code>boolean</code> - Indicates wether or not form is valid.
618
+ <a name="w_HtmlMultiWidget+isInvalidField" id="w_HtmlMultiWidget+isInvalidField" href="#user-content-w_HtmlMultiWidget+isInvalidField">&nbsp;</a>
619
+
620
+ ### htmlWidget.isInvalidField(field) ⇒ <code>boolean</code>
621
+ Using this method you can check if a specific form field is invalid
622
+
623
+ **Kind**: instance method of [<code>HtmlWidget</code>](#user-content-w_HtmlWidget)
624
+ **Overrides**: [<code>isInvalidField</code>](#user-content-w_HtmlMultiWidget+isInvalidField)
625
+ **Returns**: <code>boolean</code> - Field is invalid
626
+
627
+ | Param | Type | Description |
628
+ | --- | --- | --- |
629
+ | field | <code>string</code> | Field name |
630
+
631
+ <a name="w_HtmlMultiWidget+isFieldErrorShowed" id="w_HtmlMultiWidget+isFieldErrorShowed" href="#user-content-w_HtmlMultiWidget+isFieldErrorShowed">&nbsp;</a>
632
+
633
+ ### htmlWidget.isFieldErrorShowed(field) ⇒ <code>boolean</code>
634
+ Checks if a given form field is displaying an error.
635
+
636
+ **Kind**: instance method of [<code>HtmlWidget</code>](#user-content-w_HtmlWidget)
637
+ **Overrides**: [<code>isFieldErrorShowed</code>](#user-content-w_HtmlMultiWidget+isFieldErrorShowed)
638
+ **Returns**: <code>boolean</code> - Indicates wether or not the Error message is being displayed on the associated field.
639
+
640
+ | Param | Type | Description |
641
+ | --- | --- | --- |
642
+ | field | <code>string</code> | The form field name |
643
+
644
+ <a name="w_HtmlMultiWidget+isInvalidFieldByValidator" id="w_HtmlMultiWidget+isInvalidFieldByValidator" href="#user-content-w_HtmlMultiWidget+isInvalidFieldByValidator">&nbsp;</a>
645
+
646
+ ### htmlWidget.isInvalidFieldByValidator(field, validator) ⇒ <code>boolean</code>
647
+ Checks if a given form field is valid or invalid by name.
648
+
649
+ **Kind**: instance method of [<code>HtmlWidget</code>](#user-content-w_HtmlWidget)
650
+ **Overrides**: [<code>isInvalidFieldByValidator</code>](#user-content-w_HtmlMultiWidget+isInvalidFieldByValidator)
651
+ **Returns**: <code>boolean</code> - Indicates wether or not the field is invalid based on validator intepretation.
652
+
653
+ | Param | Type | Description |
654
+ | --- | --- | --- |
655
+ | field | <code>string</code> | The form field name |
656
+ | validator | | The name of the validator. |
657
+
658
+ <a name="w_HtmlMultiWidget+hide" id="w_HtmlMultiWidget+hide" href="#user-content-w_HtmlMultiWidget+hide">&nbsp;</a>
659
+
660
+ ### htmlWidget.hide([saveSize])
661
+ Hides the widget.
662
+
663
+ E.g., use this method to hide the widget after it loads.
664
+
665
+ **Kind**: instance method of [<code>HtmlWidget</code>](#user-content-w_HtmlWidget)
666
+ **Overrides**: [<code>hide</code>](#user-content-w_HtmlMultiWidget+hide)
667
+
668
+ | Param | Type | Default | Description |
669
+ | --- | --- | --- | --- |
670
+ | [saveSize] | <code>boolean</code> | <code>false</code> | Wether the original iframe element size should be saved before being hidden. |
671
+
672
+ <a name="w_HtmlMultiWidget+show" id="w_HtmlMultiWidget+show" href="#user-content-w_HtmlMultiWidget+show">&nbsp;</a>
673
+
674
+ ### htmlWidget.show()
675
+ Shows the widget.
676
+
677
+ E.g., use this method to show the widget after it was explicitly hidden.
678
+
679
+ **Kind**: instance method of [<code>HtmlWidget</code>](#user-content-w_HtmlWidget)
680
+ **Overrides**: [<code>show</code>](#user-content-w_HtmlMultiWidget+show)
681
+ <a name="w_HtmlMultiWidget+reload" id="w_HtmlMultiWidget+reload" href="#user-content-w_HtmlMultiWidget+reload">&nbsp;</a>
682
+
683
+ ### htmlWidget.reload()
684
+ Reloads the widget.
685
+
686
+ **Kind**: instance method of [<code>HtmlWidget</code>](#user-content-w_HtmlWidget)
687
+ **Overrides**: [<code>reload</code>](#user-content-w_HtmlMultiWidget+reload)
688
+ <a name="w_HtmlMultiWidget+hideElements" id="w_HtmlMultiWidget+hideElements" href="#user-content-w_HtmlMultiWidget+hideElements">&nbsp;</a>
689
+
690
+ ### htmlWidget.hideElements(elements)
691
+ Hides the specified Widget elements by their identifier.
692
+
693
+ **Kind**: instance method of [<code>HtmlWidget</code>](#user-content-w_HtmlWidget)
694
+ **Overrides**: [<code>hideElements</code>](#user-content-w_HtmlMultiWidget+hideElements)
695
+
696
+ | Param | Type | Description |
697
+ | --- | --- | --- |
698
+ | elements | <code>Array.&lt;string&gt;</code> | List of element which can be hidden [ELEMENT](#user-content-w_ELEMENT) || [FORM_FIELD](#user-content-w_FORM_FIELD) |
699
+
700
+ **Example**
701
+ ```javascript
702
+ widget.hideElements(['submit_button', 'email']);
703
+ ```
704
+ <a name="w_HtmlMultiWidget+showElements" id="w_HtmlMultiWidget+showElements" href="#user-content-w_HtmlMultiWidget+showElements">&nbsp;</a>
705
+
706
+ ### htmlWidget.showElements(elements)
707
+ Shows the specified Widget elements by their identifier.
708
+
709
+ **Kind**: instance method of [<code>HtmlWidget</code>](#user-content-w_HtmlWidget)
710
+ **Overrides**: [<code>showElements</code>](#user-content-w_HtmlMultiWidget+showElements)
711
+
712
+ | Param | Type | Description |
713
+ | --- | --- | --- |
714
+ | elements | <code>Array.&lt;string&gt;</code> | List of elements which can be showed [ELEMENT](#user-content-w_ELEMENT) || [FORM_FIELD](#user-content-w_FORM_FIELD) |
715
+
716
+ **Example**
717
+ ```javascript
718
+ widget.showElements(['submit_button', 'email']);
719
+ ```
720
+ <a name="w_HtmlMultiWidget+updateFormValues" id="w_HtmlMultiWidget+updateFormValues" href="#user-content-w_HtmlMultiWidget+updateFormValues">&nbsp;</a>
721
+
722
+ ### htmlWidget.updateFormValues(fieldValues)
723
+ Updates the form field values inside the widget.
724
+
725
+ **Kind**: instance method of [<code>HtmlWidget</code>](#user-content-w_HtmlWidget)
726
+ **Overrides**: [<code>updateFormValues</code>](#user-content-w_HtmlMultiWidget+updateFormValues)
727
+
728
+ | Param | Type | Description |
729
+ | --- | --- | --- |
730
+ | fieldValues | <code>IFormValues</code> | Fields with values |
731
+
732
+ **Example**
733
+ ```javascript
734
+ widget.updateFormValues({
735
+ email: 'predefined@email.com',
736
+ card_name: 'Houston'
737
+ });
738
+ ```
739
+ <a name="w_HtmlMultiWidget+updateFormValue" id="w_HtmlMultiWidget+updateFormValue" href="#user-content-w_HtmlMultiWidget+updateFormValue">&nbsp;</a>
740
+
741
+ ### htmlWidget.updateFormValue(key, value)
742
+ Updates a single form field values inside the widget by the form field name.
743
+
744
+ **Kind**: instance method of [<code>HtmlWidget</code>](#user-content-w_HtmlWidget)
745
+ **Overrides**: [<code>updateFormValue</code>](#user-content-w_HtmlMultiWidget+updateFormValue)
746
+
747
+ | Param | Type | Description |
748
+ | --- | --- | --- |
749
+ | key | <code>string</code> | The form field name |
750
+ | value | <code>string</code> | The form field value |
751
+
752
+ **Example**
753
+ ```javascript
754
+ widget.updateFormValue("card_name", "John Doe");
755
+ ```
756
+ <a name="w_HtmlMultiWidget+onFinishInsert" id="w_HtmlMultiWidget+onFinishInsert" href="#user-content-w_HtmlMultiWidget+onFinishInsert">&nbsp;</a>
757
+
758
+ ### htmlWidget.onFinishInsert(selector, dataType)
759
+ Inserts the event data (after finish event) onto the input field associated with the provided CSS selector.
760
+
761
+ **Kind**: instance method of [<code>HtmlWidget</code>](#user-content-w_HtmlWidget)
762
+ **Overrides**: [<code>onFinishInsert</code>](#user-content-w_HtmlMultiWidget+onFinishInsert)
763
+
764
+ | Param | Type | Description |
765
+ | --- | --- | --- |
766
+ | selector | <code>string</code> | A CSS selector. E.g., ".my-class", "#my-id", or others |
767
+ | dataType | <code>string</code> | The data type of IEventData object. |
768
+
769
+ <a name="w_HtmlMultiWidget+interceptSubmitForm" id="w_HtmlMultiWidget+interceptSubmitForm" href="#user-content-w_HtmlMultiWidget+interceptSubmitForm">&nbsp;</a>
770
+
771
+ ### htmlWidget.interceptSubmitForm(selector)
772
+ Intercepts a form submission and delegates processing to the widget.
773
+
774
+ An simplified example of the process:
775
+ - User clicks submit button in your form
776
+ - This implicitly triggers a submission to the widget
777
+ - The widget submits your form
778
+
779
+ **Kind**: instance method of [<code>HtmlWidget</code>](#user-content-w_HtmlWidget)
780
+ **Overrides**: [<code>interceptSubmitForm</code>](#user-content-w_HtmlMultiWidget+interceptSubmitForm)
781
+ **Note**: The widget's submit button will be hidden.
782
+
783
+ | Param | Type | Description |
784
+ | --- | --- | --- |
785
+ | selector | <code>string</code> | css selector of your form |
786
+
787
+ **Example**
788
+ ```html
789
+ <body>
790
+ <form id="myForm">
791
+ <input name="amount">
792
+ <button type="submit">Submit</button>
793
+ </form>
794
+ <script>
795
+ widget.interceptSubmitForm('#myForm');
796
+ </script>
797
+ </body>
798
+ ```
799
+ <a name="w_HtmlMultiWidget+useCheckoutAutoSubmit" id="w_HtmlMultiWidget+useCheckoutAutoSubmit" href="#user-content-w_HtmlMultiWidget+useCheckoutAutoSubmit">&nbsp;</a>
800
+
801
+ ### htmlWidget.useCheckoutAutoSubmit()
802
+ This method hides a submit button and automatically execute form submit
803
+
804
+ **Kind**: instance method of [<code>HtmlWidget</code>](#user-content-w_HtmlWidget)
805
+ **Overrides**: [<code>useCheckoutAutoSubmit</code>](#user-content-w_HtmlMultiWidget+useCheckoutAutoSubmit)
806
+ <a name="w_HtmlMultiWidget+useAutoResize" id="w_HtmlMultiWidget+useAutoResize" href="#user-content-w_HtmlMultiWidget+useAutoResize">&nbsp;</a>
807
+
808
+ ### htmlWidget.useAutoResize()
809
+ Use this method for resize iFrame according content height
810
+
811
+ **Kind**: instance method of [<code>HtmlWidget</code>](#user-content-w_HtmlWidget)
812
+ **Overrides**: [<code>useAutoResize</code>](#user-content-w_HtmlMultiWidget+useAutoResize)
813
+ **Example**
814
+ ```javascript
815
+ widget.useAutoResize();
816
+ ```
817
+ <a name="w_MultiWidget+setStyles" id="w_MultiWidget+setStyles" href="#user-content-w_MultiWidget+setStyles">&nbsp;</a>
818
+
819
+ ### htmlWidget.setStyles(fields)
820
+ Object contain styles for widget
821
+
822
+ **Kind**: instance method of [<code>HtmlWidget</code>](#user-content-w_HtmlWidget)
823
+ **Overrides**: [<code>setStyles</code>](#user-content-w_MultiWidget+setStyles)
824
+
825
+ | Param | Type | Description |
826
+ | --- | --- | --- |
827
+ | fields | [<code>IStyles</code>](#user-content-w_IStyles) | name of styles which can be shown in widget [STYLE](#user-content-w_STYLE) |
828
+
829
+ **Example**
830
+
831
+ ```javascript
832
+ widget.setStyles({
833
+ background_color: 'rgb(0, 0, 0)',
834
+ border_color: 'yellow',
835
+ text_color: '#FFFFAA',
836
+ button_color: 'rgba(255, 255, 255, 0.9)',
837
+ font_size: '20px'
838
+ fort_family: 'fantasy'
839
+ });
840
+ ```
841
+ <a name="w_MultiWidget+usePhoneCountryMask" id="w_MultiWidget+usePhoneCountryMask" href="#user-content-w_MultiWidget+usePhoneCountryMask">&nbsp;</a>
842
+
843
+ ### htmlWidget.usePhoneCountryMask([options])
844
+ Method to set a country code mask for the phone input.
845
+
846
+ **Kind**: instance method of [<code>HtmlWidget</code>](#user-content-w_HtmlWidget)
847
+ **Overrides**: [<code>usePhoneCountryMask</code>](#user-content-w_MultiWidget+usePhoneCountryMask)
848
+
849
+ | Param | Type | Description |
850
+ | --- | --- | --- |
851
+ | [options] | <code>object</code> | Options for configure the phone mask. |
852
+ | [options.default_country] | <code>string</code> | Set a default country for the mask. |
853
+ | [options.preferred_countries] | <code>Array.&lt;string&gt;</code> | Set list of preferred countries for the top of the select box . |
854
+ | [options.only_countries] | <code>Array.&lt;string&gt;</code> | Set list of countries to show in the select box. |
855
+
856
+ **Example**
857
+
858
+ ```javascript
859
+ widget.usePhoneCountryMask();
860
+ ```
861
+ **Example**
862
+
863
+ ```javascript
864
+ widget.usePhoneCountryMask({
865
+ default_country: 'au',
866
+ preferred_countries: ['au', 'gb'],
867
+ only_countries: ['au', 'gb', 'us', 'ua']
868
+ });
869
+ ```
870
+ <a name="w_MultiWidget+setTexts" id="w_MultiWidget+setTexts" href="#user-content-w_MultiWidget+setTexts">&nbsp;</a>
871
+
872
+ ### htmlWidget.setTexts(fields)
873
+ Method for set different texts inside the widget
874
+
875
+ **Kind**: instance method of [<code>HtmlWidget</code>](#user-content-w_HtmlWidget)
876
+ **Overrides**: [<code>setTexts</code>](#user-content-w_MultiWidget+setTexts)
877
+
878
+ | Param | Type | Description |
879
+ | --- | --- | --- |
880
+ | fields | [<code>ITexts</code>](#user-content-w_ITexts) | name of text items which can be shown in widget [TEXT](#user-content-w_TEXT) |
881
+
882
+ **Example**
883
+
884
+ ```javascript
885
+ widget.setTexts({
886
+ title: 'Your card',
887
+ finish_text: 'Payment resource was successfully accepted',
888
+ title_description: '* indicates required field',
889
+ submit_button: 'Save',
890
+ submit_button_processing: 'Load...',
891
+ });
892
+ ```
893
+ <a name="w_MultiWidget+setElementStyle" id="w_MultiWidget+setElementStyle" href="#user-content-w_MultiWidget+setElementStyle">&nbsp;</a>
894
+
895
+ ### htmlWidget.setElementStyle(element, [state], styles)
896
+ Method for set styles for different elements and states
897
+
898
+ **Kind**: instance method of [<code>HtmlWidget</code>](#user-content-w_HtmlWidget)
899
+ **Overrides**: [<code>setElementStyle</code>](#user-content-w_MultiWidget+setElementStyle)
900
+
901
+ | Param | Type | Description |
902
+ | --- | --- | --- |
903
+ | element | <code>string</code> | type of element for styling. These elements are available [STYLABLE_ELEMENT](#user-content-w_STYLABLE_ELEMENT) |
904
+ | [state] | <code>string</code> | state of element for styling. These states are available [STYLABLE_ELEMENT_STATE](#user-content-w_STYLABLE_ELEMENT_STATE) |
905
+ | styles | [<code>IElementStyleInput</code>](#user-content-w_IElementStyleInput) \| [<code>IElementStyleSubmitButton</code>](#user-content-w_IElementStyleSubmitButton) \| [<code>IElementStyleLabel</code>](#user-content-w_IElementStyleLabel) \| [<code>IElementStyleTitle</code>](#user-content-w_IElementStyleTitle) \| [<code>IElementStyleTitleDescription</code>](#user-content-w_IElementStyleTitleDescription) | styles list |
906
+
907
+ **Example**
908
+
909
+ ```javascript
910
+ widget.setElementStyle('input', {
911
+ border: 'green solid 1px'
912
+ });
913
+
914
+ widget.setElementStyle('input', 'focus', {
915
+ border: 'blue solid 1px'
916
+ });
917
+
918
+ widget.setElementStyle('input', 'error', {
919
+ border: 'red solid 1px'
920
+ });
921
+ ```
922
+ <a name="w_MultiWidget+setFormValues" id="w_MultiWidget+setFormValues" href="#user-content-w_MultiWidget+setFormValues">&nbsp;</a>
923
+
924
+ ### htmlWidget.setFormValues(fieldValues)
925
+ The method to set the predefined values for the form fields inside the widget
926
+
927
+ **Kind**: instance method of [<code>HtmlWidget</code>](#user-content-w_HtmlWidget)
928
+ **Overrides**: [<code>setFormValues</code>](#user-content-w_MultiWidget+setFormValues)
929
+
930
+ | Param | Type | Description |
931
+ | --- | --- | --- |
932
+ | fieldValues | <code>Object</code> | Key of object is one of [FORM_FIELD](#user-content-w_FORM_FIELD), The object value is what we are expecting |
933
+
934
+ **Example**
935
+
936
+ ```javascript
937
+ widget.setFormValues({
938
+ email: 'predefined@email.com',
939
+ card_name: 'Houston'
940
+ });
941
+ ```
942
+ <a name="w_MultiWidget+setFormLabels" id="w_MultiWidget+setFormLabels" href="#user-content-w_MultiWidget+setFormLabels">&nbsp;</a>
943
+
944
+ ### htmlWidget.setFormLabels(fieldLabels)
945
+ The method to set custom form field labels
946
+
947
+ **Kind**: instance method of [<code>HtmlWidget</code>](#user-content-w_HtmlWidget)
948
+ **Overrides**: [<code>setFormLabels</code>](#user-content-w_MultiWidget+setFormLabels)
949
+
950
+ | Param | Type | Description |
951
+ | --- | --- | --- |
952
+ | fieldLabels | <code>Object</code> | Key of object is one of [FORM_FIELD](#user-content-w_FORM_FIELD), The object value is what we are expecting |
953
+
954
+ **Example**
955
+
956
+ ```javascript
957
+ widget.setFormPlaceholders({
958
+ card_name: 'Card Holder Name',
959
+ email: 'Email For Receipt'
960
+ })
961
+ ```
962
+ <a name="w_MultiWidget+setFormPlaceholders" id="w_MultiWidget+setFormPlaceholders" href="#user-content-w_MultiWidget+setFormPlaceholders">&nbsp;</a>
963
+
964
+ ### htmlWidget.setFormPlaceholders(fieldPlaceholders)
965
+ The method to set custom form fields placeholders
966
+
967
+ **Kind**: instance method of [<code>HtmlWidget</code>](#user-content-w_HtmlWidget)
968
+ **Overrides**: [<code>setFormPlaceholders</code>](#user-content-w_MultiWidget+setFormPlaceholders)
969
+
970
+ | Param | Type | Description |
971
+ | --- | --- | --- |
972
+ | fieldPlaceholders | <code>Object</code> | Key of object is one of [FORM_FIELD](#user-content-w_FORM_FIELD), Value of object is expected placeholder |
973
+
974
+ **Example**
975
+
976
+ ```javascript
977
+ widget.setFormPlaceholders({
978
+ card_name: 'Input your card holder name...',
979
+ email: 'Input your email, like test@example.com'
980
+ })
981
+ ```
982
+ <a name="w_MultiWidget+setIcons" id="w_MultiWidget+setIcons" href="#user-content-w_MultiWidget+setIcons">&nbsp;</a>
983
+
984
+ ### ~~htmlWidget.setIcons()~~
985
+ ***Deprecated***
986
+
987
+ The method to change the widget icons
988
+
989
+ **Kind**: instance method of [<code>HtmlWidget</code>](#user-content-w_HtmlWidget)
990
+ **Overrides**: [<code>setIcons</code>](#user-content-w_MultiWidget+setIcons)
991
+ <a name="w_MultiWidget+setHiddenElements" id="w_MultiWidget+setHiddenElements" href="#user-content-w_MultiWidget+setHiddenElements">&nbsp;</a>
992
+
993
+ ### htmlWidget.setHiddenElements(elements)
994
+ Using this method you can set hidden elements inside widget
995
+
996
+ **Kind**: instance method of [<code>HtmlWidget</code>](#user-content-w_HtmlWidget)
997
+ **Overrides**: [<code>setHiddenElements</code>](#user-content-w_MultiWidget+setHiddenElements)
998
+
999
+ | Param | Type | Description |
1000
+ | --- | --- | --- |
1001
+ | elements | <code>Array.&lt;string&gt;</code> | list of element which can be hidden [ELEMENT](#user-content-w_ELEMENT) || [FORM_FIELD](#user-content-w_FORM_FIELD) |
1002
+
1003
+ **Example**
1004
+
1005
+ ```javascript
1006
+ widget.setHiddenElements(['submit_button', 'email']);
1007
+ ```
1008
+ <a name="w_MultiWidget+setRefId" id="w_MultiWidget+setRefId" href="#user-content-w_MultiWidget+setRefId">&nbsp;</a>
1009
+
1010
+ ### htmlWidget.setRefId(refId)
1011
+ Current method can set custom ID to identify the data in the future
1012
+
1013
+ **Kind**: instance method of [<code>HtmlWidget</code>](#user-content-w_HtmlWidget)
1014
+ **Overrides**: [<code>setRefId</code>](#user-content-w_MultiWidget+setRefId)
1015
+
1016
+ | Param | Type | Description |
1017
+ | --- | --- | --- |
1018
+ | refId | <code>string</code> | custom id |
1019
+
1020
+ **Example**
1021
+
1022
+ ```javascript
1023
+ widget.setRefId('id');
1024
+ ```
1025
+ <a name="w_MultiWidget+useGatewayFieldValidation" id="w_MultiWidget+useGatewayFieldValidation" href="#user-content-w_MultiWidget+useGatewayFieldValidation">&nbsp;</a>
1026
+
1027
+ ### htmlWidget.useGatewayFieldValidation()
1028
+ Current method can add visual validation from gateway to widget's form fields
1029
+
1030
+ **Kind**: instance method of [<code>HtmlWidget</code>](#user-content-w_HtmlWidget)
1031
+ **Overrides**: [<code>useGatewayFieldValidation</code>](#user-content-w_MultiWidget+useGatewayFieldValidation)
1032
+ **Example**
1033
+
1034
+ ```javascript
1035
+ widget.useGatewayFieldValidation();
1036
+ ```
1037
+ <a name="w_MultiWidget+setSupportedCardIcons" id="w_MultiWidget+setSupportedCardIcons" href="#user-content-w_MultiWidget+setSupportedCardIcons">&nbsp;</a>
1038
+
1039
+ ### htmlWidget.setSupportedCardIcons(elements, validateCardNumberInput)
1040
+ Current method can set icons of supported card types
1041
+
1042
+ **Kind**: instance method of [<code>HtmlWidget</code>](#user-content-w_HtmlWidget)
1043
+ **Overrides**: [<code>setSupportedCardIcons</code>](#user-content-w_MultiWidget+setSupportedCardIcons)
1044
+
1045
+ | Param | Type | Description |
1046
+ | --- | --- | --- |
1047
+ | elements | <code>Array.&lt;string&gt;</code> | [SUPPORTED_CARD_TYPES](#user-content-w_SUPPORTED_CARD_TYPES) |
1048
+ | validateCardNumberInput | <code>boolean</code> | [validateCardNumberInput=false] - using this param you allow validation for card number input on supported card types |
1049
+
1050
+ **Example**
1051
+
1052
+ ```javascript
1053
+ widget.setSupportedCardIcons(['mastercard', 'visa'], validateCardNumberInput);
1054
+ ```
1055
+ <a name="w_MultiWidget+setEnv" id="w_MultiWidget+setEnv" href="#user-content-w_MultiWidget+setEnv">&nbsp;</a>
1056
+
1057
+ ### htmlWidget.setEnv(env, [alias])
1058
+ Current method can change environment. By default environment = sandbox.
1059
+ Also we can change domain alias for this environment. By default domain_alias = paydock.com
1060
+
1061
+ **Kind**: instance method of [<code>HtmlWidget</code>](#user-content-w_HtmlWidget)
1062
+ **Overrides**: [<code>setEnv</code>](#user-content-w_MultiWidget+setEnv)
1063
+
1064
+ | Param | Type | Description |
1065
+ | --- | --- | --- |
1066
+ | env | <code>string</code> | sandbox, production |
1067
+ | [alias] | <code>string</code> | Own domain alias |
1068
+
1069
+ **Example**
1070
+
1071
+ ```javascript
1072
+ widget.setEnv('production', 'paydock.com');
1073
+ ```
1074
+ <a name="w_MultiWidget+loadIFrameUrl" id="w_MultiWidget+loadIFrameUrl" href="#user-content-w_MultiWidget+loadIFrameUrl">&nbsp;</a>
1075
+
1076
+ ### htmlWidget.loadIFrameUrl()
1077
+ Method for creating iframe url
1078
+
1079
+ **Kind**: instance method of [<code>HtmlWidget</code>](#user-content-w_HtmlWidget)
1080
+ **Overrides**: [<code>loadIFrameUrl</code>](#user-content-w_MultiWidget+loadIFrameUrl)
1081
+ **Example**
1082
+
1083
+ ```javascript
1084
+ widget.loadIFrameUrl(function (url) {
1085
+ console.log(url);
1086
+ }, function (errors) {
1087
+ console.log(errors);
1088
+ });
1089
+ ```
1090
+ <a name="w_MultiWidget+setLanguage" id="w_MultiWidget+setLanguage" href="#user-content-w_MultiWidget+setLanguage">&nbsp;</a>
1091
+
1092
+ ### htmlWidget.setLanguage(code)
1093
+ Method for setting a custom language code
1094
+
1095
+ **Kind**: instance method of [<code>HtmlWidget</code>](#user-content-w_HtmlWidget)
1096
+ **Overrides**: [<code>setLanguage</code>](#user-content-w_MultiWidget+setLanguage)
1097
+
1098
+ | Param | Type | Description |
1099
+ | --- | --- | --- |
1100
+ | code | <code>string</code> | ISO 639-1 |
1101
+
1102
+ **Example**
1103
+
1104
+ ```javascript
1105
+ config.setLanguage('en');
1106
+ ```
1107
+ <a name="w_HtmlMultiWidget" id="w_HtmlMultiWidget" href="#user-content-w_HtmlMultiWidget">&nbsp;</a>
1108
+
1109
+ ## HtmlMultiWidget ⇐ [<code>MultiWidget</code>](#user-content-w_MultiWidget)
1110
+ Class HtmlMultiWidget include method for working with html
1111
+
1112
+ **Kind**: global class
1113
+ **Extends**: [<code>MultiWidget</code>](#user-content-w_MultiWidget)
1114
+
1115
+ * [HtmlMultiWidget](#user-content-w_HtmlMultiWidget) ⇐ [<code>MultiWidget</code>](#user-content-w_MultiWidget)
1116
+ * [new HtmlMultiWidget(selector, publicKey, conf)](#user-content-w_new_HtmlMultiWidget_new)
1117
+ * [.load()](#user-content-w_HtmlMultiWidget+load)
1118
+ * [.afterLoad()](#user-content-w_HtmlMultiWidget+afterLoad)
1119
+ * [.trigger(triggers, data)](#user-content-w_HtmlMultiWidget+trigger)
1120
+ * [.getValidationState()](#user-content-w_HtmlMultiWidget+getValidationState) ⇒ [<code>IFormValidation</code>](#user-content-w_IFormValidation)
1121
+ * [.isValidForm()](#user-content-w_HtmlMultiWidget+isValidForm) ⇒ <code>boolean</code>
1122
+ * [.isInvalidField(field)](#user-content-w_HtmlMultiWidget+isInvalidField) ⇒ <code>boolean</code>
1123
+ * [.isFieldErrorShowed(field)](#user-content-w_HtmlMultiWidget+isFieldErrorShowed) ⇒ <code>boolean</code>
1124
+ * [.isInvalidFieldByValidator(field, validator)](#user-content-w_HtmlMultiWidget+isInvalidFieldByValidator) ⇒ <code>boolean</code>
1125
+ * [.hide([saveSize])](#user-content-w_HtmlMultiWidget+hide)
1126
+ * [.show()](#user-content-w_HtmlMultiWidget+show)
1127
+ * [.reload()](#user-content-w_HtmlMultiWidget+reload)
1128
+ * [.hideElements(elements)](#user-content-w_HtmlMultiWidget+hideElements)
1129
+ * [.showElements(elements)](#user-content-w_HtmlMultiWidget+showElements)
1130
+ * [.updateFormValues(fieldValues)](#user-content-w_HtmlMultiWidget+updateFormValues)
1131
+ * [.updateFormValue(key, value)](#user-content-w_HtmlMultiWidget+updateFormValue)
1132
+ * [.onFinishInsert(selector, dataType)](#user-content-w_HtmlMultiWidget+onFinishInsert)
1133
+ * [.interceptSubmitForm(selector)](#user-content-w_HtmlMultiWidget+interceptSubmitForm)
1134
+ * [.useCheckoutAutoSubmit()](#user-content-w_HtmlMultiWidget+useCheckoutAutoSubmit)
1135
+ * [.useAutoResize()](#user-content-w_HtmlMultiWidget+useAutoResize)
1136
+ * [.setStyles(fields)](#user-content-w_MultiWidget+setStyles)
1137
+ * [.usePhoneCountryMask([options])](#user-content-w_MultiWidget+usePhoneCountryMask)
1138
+ * [.setTexts(fields)](#user-content-w_MultiWidget+setTexts)
1139
+ * [.setElementStyle(element, [state], styles)](#user-content-w_MultiWidget+setElementStyle)
1140
+ * [.setFormValues(fieldValues)](#user-content-w_MultiWidget+setFormValues)
1141
+ * [.setFormLabels(fieldLabels)](#user-content-w_MultiWidget+setFormLabels)
1142
+ * [.setFormPlaceholders(fieldPlaceholders)](#user-content-w_MultiWidget+setFormPlaceholders)
1143
+ * [.setFormElements(elements)](#user-content-w_MultiWidget+setFormElements)
1144
+ * ~~[.setIcons()](#user-content-w_MultiWidget+setIcons)~~
1145
+ * [.setHiddenElements(elements)](#user-content-w_MultiWidget+setHiddenElements)
1146
+ * [.setRefId(refId)](#user-content-w_MultiWidget+setRefId)
1147
+ * [.useGatewayFieldValidation()](#user-content-w_MultiWidget+useGatewayFieldValidation)
1148
+ * [.setSupportedCardIcons(elements, validateCardNumberInput)](#user-content-w_MultiWidget+setSupportedCardIcons)
1149
+ * [.setEnv(env, [alias])](#user-content-w_MultiWidget+setEnv)
1150
+ * [.loadIFrameUrl()](#user-content-w_MultiWidget+loadIFrameUrl)
1151
+ * [.setLanguage(code)](#user-content-w_MultiWidget+setLanguage)
1152
+
1153
+ <a name="w_new_HtmlMultiWidget_new" id="w_new_HtmlMultiWidget_new" href="#user-content-w_new_HtmlMultiWidget_new">&nbsp;</a>
1154
+
1155
+ ### new HtmlMultiWidget(selector, publicKey, conf)
1156
+
1157
+ | Param | Type | Description |
1158
+ | --- | --- | --- |
1159
+ | selector | <code>string</code> | Selector of html element. Container for widget |
1160
+ | publicKey | <code>string</code> | PayDock users public key |
1161
+ | conf | [<code>Configuration</code>](#user-content-w_Configuration) \| <code>string</code> \| [<code>Array.&lt;Configuration&gt;</code>](#user-content-w_Configuration) \| <code>Array.&lt;string&gt;</code> | exemplar[s] Configuration class OR configuration token |
1162
+
1163
+ **Example**
1164
+
1165
+ ```javascript
1166
+ var widget = new MultiWidget('#widget', 'publicKey','configurationToken'); // With a pre-created configuration token
1167
+
1168
+ var widget = new MultiWidget('#widget', 'publicKey',['configurationToken', 'configurationToken2']); // With pre-created configuration tokens
1169
+
1170
+ var widget = new MultiWidget('#widget', 'publicKey', new Configuration('gatewayId')); With Configuration
1171
+
1172
+ var widget = new MultiWidget('#widget', 'publicKey',[ With Configurations
1173
+ Configuration(), // default gateway_id,
1174
+ Configuration('not_configured'), // without gateway,
1175
+ Configuration('gatewayId'),
1176
+ Configuration('gatewayId', 'bank_account')
1177
+ ]);
1178
+ ```
1179
+ <a name="w_HtmlMultiWidget+load" id="w_HtmlMultiWidget+load" href="#user-content-w_HtmlMultiWidget+load">&nbsp;</a>
1180
+
1181
+ ### htmlMultiWidget.load()
1182
+ Loads the widget.
1183
+
1184
+ Calling this method results in an iframe element being inserted and rendered in the DOM.
1185
+
1186
+ **Kind**: instance method of [<code>HtmlMultiWidget</code>](#user-content-w_HtmlMultiWidget)
1187
+ <a name="w_HtmlMultiWidget+afterLoad" id="w_HtmlMultiWidget+afterLoad" href="#user-content-w_HtmlMultiWidget+afterLoad">&nbsp;</a>
1188
+
1189
+ ### htmlMultiWidget.afterLoad()
1190
+ Registers a form validation callback for validation events.
1191
+
1192
+ **Kind**: instance method of [<code>HtmlMultiWidget</code>](#user-content-w_HtmlMultiWidget)
1193
+ <a name="w_HtmlMultiWidget+trigger" id="w_HtmlMultiWidget+trigger" href="#user-content-w_HtmlMultiWidget+trigger">&nbsp;</a>
1194
+
1195
+ ### htmlMultiWidget.trigger(triggers, data)
1196
+ Registers callback that will be invoked for every trigger.
1197
+
1198
+ **Kind**: instance method of [<code>HtmlMultiWidget</code>](#user-content-w_HtmlMultiWidget)
1199
+
1200
+ | Param | Type | Description |
1201
+ | --- | --- | --- |
1202
+ | triggers | <code>&#x27;submit\_form&#x27;</code> \| <code>&#x27;tab&#x27;</code> | The Widget element identifier that caused the trigger. |
1203
+ | data | [<code>ITriggerData</code>](#user-content-w_ITriggerData) | Data that will be sent to the widget when the trigger occurs. |
1204
+
1205
+ <a name="w_HtmlMultiWidget+getValidationState" id="w_HtmlMultiWidget+getValidationState" href="#user-content-w_HtmlMultiWidget+getValidationState">&nbsp;</a>
1206
+
1207
+ ### htmlMultiWidget.getValidationState() ⇒ [<code>IFormValidation</code>](#user-content-w_IFormValidation)
1208
+ Gets a reference to the form current validation state.
1209
+
1210
+ !Warning: do not directly modify the values of the returned object.
1211
+
1212
+ **Kind**: instance method of [<code>HtmlMultiWidget</code>](#user-content-w_HtmlMultiWidget)
1213
+ **Returns**: [<code>IFormValidation</code>](#user-content-w_IFormValidation) - Form validation object
1214
+ <a name="w_HtmlMultiWidget+isValidForm" id="w_HtmlMultiWidget+isValidForm" href="#user-content-w_HtmlMultiWidget+isValidForm">&nbsp;</a>
1215
+
1216
+ ### htmlMultiWidget.isValidForm() ⇒ <code>boolean</code>
1217
+ Checks if a given form is valid.
1218
+
1219
+ A form is valid if all form fields are valid.
1220
+
1221
+ **Kind**: instance method of [<code>HtmlMultiWidget</code>](#user-content-w_HtmlMultiWidget)
1222
+ **Returns**: <code>boolean</code> - Indicates wether or not form is valid.
1223
+ <a name="w_HtmlMultiWidget+isInvalidField" id="w_HtmlMultiWidget+isInvalidField" href="#user-content-w_HtmlMultiWidget+isInvalidField">&nbsp;</a>
1224
+
1225
+ ### htmlMultiWidget.isInvalidField(field) ⇒ <code>boolean</code>
1226
+ Using this method you can check if a specific form field is invalid
1227
+
1228
+ **Kind**: instance method of [<code>HtmlMultiWidget</code>](#user-content-w_HtmlMultiWidget)
1229
+ **Returns**: <code>boolean</code> - Field is invalid
1230
+
1231
+ | Param | Type | Description |
1232
+ | --- | --- | --- |
1233
+ | field | <code>string</code> | Field name |
1234
+
1235
+ <a name="w_HtmlMultiWidget+isFieldErrorShowed" id="w_HtmlMultiWidget+isFieldErrorShowed" href="#user-content-w_HtmlMultiWidget+isFieldErrorShowed">&nbsp;</a>
1236
+
1237
+ ### htmlMultiWidget.isFieldErrorShowed(field) ⇒ <code>boolean</code>
1238
+ Checks if a given form field is displaying an error.
1239
+
1240
+ **Kind**: instance method of [<code>HtmlMultiWidget</code>](#user-content-w_HtmlMultiWidget)
1241
+ **Returns**: <code>boolean</code> - Indicates wether or not the Error message is being displayed on the associated field.
1242
+
1243
+ | Param | Type | Description |
1244
+ | --- | --- | --- |
1245
+ | field | <code>string</code> | The form field name |
1246
+
1247
+ <a name="w_HtmlMultiWidget+isInvalidFieldByValidator" id="w_HtmlMultiWidget+isInvalidFieldByValidator" href="#user-content-w_HtmlMultiWidget+isInvalidFieldByValidator">&nbsp;</a>
1248
+
1249
+ ### htmlMultiWidget.isInvalidFieldByValidator(field, validator) ⇒ <code>boolean</code>
1250
+ Checks if a given form field is valid or invalid by name.
1251
+
1252
+ **Kind**: instance method of [<code>HtmlMultiWidget</code>](#user-content-w_HtmlMultiWidget)
1253
+ **Returns**: <code>boolean</code> - Indicates wether or not the field is invalid based on validator intepretation.
1254
+
1255
+ | Param | Type | Description |
1256
+ | --- | --- | --- |
1257
+ | field | <code>string</code> | The form field name |
1258
+ | validator | | The name of the validator. |
1259
+
1260
+ <a name="w_HtmlMultiWidget+hide" id="w_HtmlMultiWidget+hide" href="#user-content-w_HtmlMultiWidget+hide">&nbsp;</a>
1261
+
1262
+ ### htmlMultiWidget.hide([saveSize])
1263
+ Hides the widget.
1264
+
1265
+ E.g., use this method to hide the widget after it loads.
1266
+
1267
+ **Kind**: instance method of [<code>HtmlMultiWidget</code>](#user-content-w_HtmlMultiWidget)
1268
+
1269
+ | Param | Type | Default | Description |
1270
+ | --- | --- | --- | --- |
1271
+ | [saveSize] | <code>boolean</code> | <code>false</code> | Wether the original iframe element size should be saved before being hidden. |
1272
+
1273
+ <a name="w_HtmlMultiWidget+show" id="w_HtmlMultiWidget+show" href="#user-content-w_HtmlMultiWidget+show">&nbsp;</a>
1274
+
1275
+ ### htmlMultiWidget.show()
1276
+ Shows the widget.
1277
+
1278
+ E.g., use this method to show the widget after it was explicitly hidden.
1279
+
1280
+ **Kind**: instance method of [<code>HtmlMultiWidget</code>](#user-content-w_HtmlMultiWidget)
1281
+ <a name="w_HtmlMultiWidget+reload" id="w_HtmlMultiWidget+reload" href="#user-content-w_HtmlMultiWidget+reload">&nbsp;</a>
1282
+
1283
+ ### htmlMultiWidget.reload()
1284
+ Reloads the widget.
1285
+
1286
+ **Kind**: instance method of [<code>HtmlMultiWidget</code>](#user-content-w_HtmlMultiWidget)
1287
+ <a name="w_HtmlMultiWidget+hideElements" id="w_HtmlMultiWidget+hideElements" href="#user-content-w_HtmlMultiWidget+hideElements">&nbsp;</a>
1288
+
1289
+ ### htmlMultiWidget.hideElements(elements)
1290
+ Hides the specified Widget elements by their identifier.
1291
+
1292
+ **Kind**: instance method of [<code>HtmlMultiWidget</code>](#user-content-w_HtmlMultiWidget)
1293
+
1294
+ | Param | Type | Description |
1295
+ | --- | --- | --- |
1296
+ | elements | <code>Array.&lt;string&gt;</code> | List of element which can be hidden [ELEMENT](#user-content-w_ELEMENT) || [FORM_FIELD](#user-content-w_FORM_FIELD) |
1297
+
1298
+ **Example**
1299
+ ```javascript
1300
+ widget.hideElements(['submit_button', 'email']);
1301
+ ```
1302
+ <a name="w_HtmlMultiWidget+showElements" id="w_HtmlMultiWidget+showElements" href="#user-content-w_HtmlMultiWidget+showElements">&nbsp;</a>
1303
+
1304
+ ### htmlMultiWidget.showElements(elements)
1305
+ Shows the specified Widget elements by their identifier.
1306
+
1307
+ **Kind**: instance method of [<code>HtmlMultiWidget</code>](#user-content-w_HtmlMultiWidget)
1308
+
1309
+ | Param | Type | Description |
1310
+ | --- | --- | --- |
1311
+ | elements | <code>Array.&lt;string&gt;</code> | List of elements which can be showed [ELEMENT](#user-content-w_ELEMENT) || [FORM_FIELD](#user-content-w_FORM_FIELD) |
1312
+
1313
+ **Example**
1314
+ ```javascript
1315
+ widget.showElements(['submit_button', 'email']);
1316
+ ```
1317
+ <a name="w_HtmlMultiWidget+updateFormValues" id="w_HtmlMultiWidget+updateFormValues" href="#user-content-w_HtmlMultiWidget+updateFormValues">&nbsp;</a>
1318
+
1319
+ ### htmlMultiWidget.updateFormValues(fieldValues)
1320
+ Updates the form field values inside the widget.
1321
+
1322
+ **Kind**: instance method of [<code>HtmlMultiWidget</code>](#user-content-w_HtmlMultiWidget)
1323
+
1324
+ | Param | Type | Description |
1325
+ | --- | --- | --- |
1326
+ | fieldValues | <code>IFormValues</code> | Fields with values |
1327
+
1328
+ **Example**
1329
+ ```javascript
1330
+ widget.updateFormValues({
1331
+ email: 'predefined@email.com',
1332
+ card_name: 'Houston'
1333
+ });
1334
+ ```
1335
+ <a name="w_HtmlMultiWidget+updateFormValue" id="w_HtmlMultiWidget+updateFormValue" href="#user-content-w_HtmlMultiWidget+updateFormValue">&nbsp;</a>
1336
+
1337
+ ### htmlMultiWidget.updateFormValue(key, value)
1338
+ Updates a single form field values inside the widget by the form field name.
1339
+
1340
+ **Kind**: instance method of [<code>HtmlMultiWidget</code>](#user-content-w_HtmlMultiWidget)
1341
+
1342
+ | Param | Type | Description |
1343
+ | --- | --- | --- |
1344
+ | key | <code>string</code> | The form field name |
1345
+ | value | <code>string</code> | The form field value |
1346
+
1347
+ **Example**
1348
+ ```javascript
1349
+ widget.updateFormValue("card_name", "John Doe");
1350
+ ```
1351
+ <a name="w_HtmlMultiWidget+onFinishInsert" id="w_HtmlMultiWidget+onFinishInsert" href="#user-content-w_HtmlMultiWidget+onFinishInsert">&nbsp;</a>
1352
+
1353
+ ### htmlMultiWidget.onFinishInsert(selector, dataType)
1354
+ Inserts the event data (after finish event) onto the input field associated with the provided CSS selector.
1355
+
1356
+ **Kind**: instance method of [<code>HtmlMultiWidget</code>](#user-content-w_HtmlMultiWidget)
1357
+
1358
+ | Param | Type | Description |
1359
+ | --- | --- | --- |
1360
+ | selector | <code>string</code> | A CSS selector. E.g., ".my-class", "#my-id", or others |
1361
+ | dataType | <code>string</code> | The data type of IEventData object. |
1362
+
1363
+ <a name="w_HtmlMultiWidget+interceptSubmitForm" id="w_HtmlMultiWidget+interceptSubmitForm" href="#user-content-w_HtmlMultiWidget+interceptSubmitForm">&nbsp;</a>
1364
+
1365
+ ### htmlMultiWidget.interceptSubmitForm(selector)
1366
+ Intercepts a form submission and delegates processing to the widget.
1367
+
1368
+ An simplified example of the process:
1369
+ - User clicks submit button in your form
1370
+ - This implicitly triggers a submission to the widget
1371
+ - The widget submits your form
1372
+
1373
+ **Kind**: instance method of [<code>HtmlMultiWidget</code>](#user-content-w_HtmlMultiWidget)
1374
+ **Note**: The widget's submit button will be hidden.
1375
+
1376
+ | Param | Type | Description |
1377
+ | --- | --- | --- |
1378
+ | selector | <code>string</code> | css selector of your form |
1379
+
1380
+ **Example**
1381
+ ```html
1382
+ <body>
1383
+ <form id="myForm">
1384
+ <input name="amount">
1385
+ <button type="submit">Submit</button>
1386
+ </form>
1387
+ <script>
1388
+ widget.interceptSubmitForm('#myForm');
1389
+ </script>
1390
+ </body>
1391
+ ```
1392
+ <a name="w_HtmlMultiWidget+useCheckoutAutoSubmit" id="w_HtmlMultiWidget+useCheckoutAutoSubmit" href="#user-content-w_HtmlMultiWidget+useCheckoutAutoSubmit">&nbsp;</a>
1393
+
1394
+ ### htmlMultiWidget.useCheckoutAutoSubmit()
1395
+ This method hides a submit button and automatically execute form submit
1396
+
1397
+ **Kind**: instance method of [<code>HtmlMultiWidget</code>](#user-content-w_HtmlMultiWidget)
1398
+ <a name="w_HtmlMultiWidget+useAutoResize" id="w_HtmlMultiWidget+useAutoResize" href="#user-content-w_HtmlMultiWidget+useAutoResize">&nbsp;</a>
1399
+
1400
+ ### htmlMultiWidget.useAutoResize()
1401
+ Use this method for resize iFrame according content height
1402
+
1403
+ **Kind**: instance method of [<code>HtmlMultiWidget</code>](#user-content-w_HtmlMultiWidget)
1404
+ **Example**
1405
+ ```javascript
1406
+ widget.useAutoResize();
1407
+ ```
1408
+ <a name="w_MultiWidget+setStyles" id="w_MultiWidget+setStyles" href="#user-content-w_MultiWidget+setStyles">&nbsp;</a>
1409
+
1410
+ ### htmlMultiWidget.setStyles(fields)
1411
+ Object contain styles for widget
1412
+
1413
+ **Kind**: instance method of [<code>HtmlMultiWidget</code>](#user-content-w_HtmlMultiWidget)
1414
+ **Overrides**: [<code>setStyles</code>](#user-content-w_MultiWidget+setStyles)
1415
+
1416
+ | Param | Type | Description |
1417
+ | --- | --- | --- |
1418
+ | fields | [<code>IStyles</code>](#user-content-w_IStyles) | name of styles which can be shown in widget [STYLE](#user-content-w_STYLE) |
1419
+
1420
+ **Example**
1421
+
1422
+ ```javascript
1423
+ widget.setStyles({
1424
+ background_color: 'rgb(0, 0, 0)',
1425
+ border_color: 'yellow',
1426
+ text_color: '#FFFFAA',
1427
+ button_color: 'rgba(255, 255, 255, 0.9)',
1428
+ font_size: '20px'
1429
+ fort_family: 'fantasy'
1430
+ });
1431
+ ```
1432
+ <a name="w_MultiWidget+usePhoneCountryMask" id="w_MultiWidget+usePhoneCountryMask" href="#user-content-w_MultiWidget+usePhoneCountryMask">&nbsp;</a>
1433
+
1434
+ ### htmlMultiWidget.usePhoneCountryMask([options])
1435
+ Method to set a country code mask for the phone input.
1436
+
1437
+ **Kind**: instance method of [<code>HtmlMultiWidget</code>](#user-content-w_HtmlMultiWidget)
1438
+ **Overrides**: [<code>usePhoneCountryMask</code>](#user-content-w_MultiWidget+usePhoneCountryMask)
1439
+
1440
+ | Param | Type | Description |
1441
+ | --- | --- | --- |
1442
+ | [options] | <code>object</code> | Options for configure the phone mask. |
1443
+ | [options.default_country] | <code>string</code> | Set a default country for the mask. |
1444
+ | [options.preferred_countries] | <code>Array.&lt;string&gt;</code> | Set list of preferred countries for the top of the select box . |
1445
+ | [options.only_countries] | <code>Array.&lt;string&gt;</code> | Set list of countries to show in the select box. |
1446
+
1447
+ **Example**
1448
+
1449
+ ```javascript
1450
+ widget.usePhoneCountryMask();
1451
+ ```
1452
+ **Example**
1453
+
1454
+ ```javascript
1455
+ widget.usePhoneCountryMask({
1456
+ default_country: 'au',
1457
+ preferred_countries: ['au', 'gb'],
1458
+ only_countries: ['au', 'gb', 'us', 'ua']
1459
+ });
1460
+ ```
1461
+ <a name="w_MultiWidget+setTexts" id="w_MultiWidget+setTexts" href="#user-content-w_MultiWidget+setTexts">&nbsp;</a>
1462
+
1463
+ ### htmlMultiWidget.setTexts(fields)
1464
+ Method for set different texts inside the widget
1465
+
1466
+ **Kind**: instance method of [<code>HtmlMultiWidget</code>](#user-content-w_HtmlMultiWidget)
1467
+ **Overrides**: [<code>setTexts</code>](#user-content-w_MultiWidget+setTexts)
1468
+
1469
+ | Param | Type | Description |
1470
+ | --- | --- | --- |
1471
+ | fields | [<code>ITexts</code>](#user-content-w_ITexts) | name of text items which can be shown in widget [TEXT](#user-content-w_TEXT) |
1472
+
1473
+ **Example**
1474
+
1475
+ ```javascript
1476
+ widget.setTexts({
1477
+ title: 'Your card',
1478
+ finish_text: 'Payment resource was successfully accepted',
1479
+ title_description: '* indicates required field',
1480
+ submit_button: 'Save',
1481
+ submit_button_processing: 'Load...',
1482
+ });
1483
+ ```
1484
+ <a name="w_MultiWidget+setElementStyle" id="w_MultiWidget+setElementStyle" href="#user-content-w_MultiWidget+setElementStyle">&nbsp;</a>
1485
+
1486
+ ### htmlMultiWidget.setElementStyle(element, [state], styles)
1487
+ Method for set styles for different elements and states
1488
+
1489
+ **Kind**: instance method of [<code>HtmlMultiWidget</code>](#user-content-w_HtmlMultiWidget)
1490
+ **Overrides**: [<code>setElementStyle</code>](#user-content-w_MultiWidget+setElementStyle)
1491
+
1492
+ | Param | Type | Description |
1493
+ | --- | --- | --- |
1494
+ | element | <code>string</code> | type of element for styling. These elements are available [STYLABLE_ELEMENT](#user-content-w_STYLABLE_ELEMENT) |
1495
+ | [state] | <code>string</code> | state of element for styling. These states are available [STYLABLE_ELEMENT_STATE](#user-content-w_STYLABLE_ELEMENT_STATE) |
1496
+ | styles | [<code>IElementStyleInput</code>](#user-content-w_IElementStyleInput) \| [<code>IElementStyleSubmitButton</code>](#user-content-w_IElementStyleSubmitButton) \| [<code>IElementStyleLabel</code>](#user-content-w_IElementStyleLabel) \| [<code>IElementStyleTitle</code>](#user-content-w_IElementStyleTitle) \| [<code>IElementStyleTitleDescription</code>](#user-content-w_IElementStyleTitleDescription) | styles list |
1497
+
1498
+ **Example**
1499
+
1500
+ ```javascript
1501
+ widget.setElementStyle('input', {
1502
+ border: 'green solid 1px'
1503
+ });
1504
+
1505
+ widget.setElementStyle('input', 'focus', {
1506
+ border: 'blue solid 1px'
1507
+ });
1508
+
1509
+ widget.setElementStyle('input', 'error', {
1510
+ border: 'red solid 1px'
1511
+ });
1512
+ ```
1513
+ <a name="w_MultiWidget+setFormValues" id="w_MultiWidget+setFormValues" href="#user-content-w_MultiWidget+setFormValues">&nbsp;</a>
1514
+
1515
+ ### htmlMultiWidget.setFormValues(fieldValues)
1516
+ The method to set the predefined values for the form fields inside the widget
1517
+
1518
+ **Kind**: instance method of [<code>HtmlMultiWidget</code>](#user-content-w_HtmlMultiWidget)
1519
+ **Overrides**: [<code>setFormValues</code>](#user-content-w_MultiWidget+setFormValues)
1520
+
1521
+ | Param | Type | Description |
1522
+ | --- | --- | --- |
1523
+ | fieldValues | <code>Object</code> | Key of object is one of [FORM_FIELD](#user-content-w_FORM_FIELD), The object value is what we are expecting |
1524
+
1525
+ **Example**
1526
+
1527
+ ```javascript
1528
+ widget.setFormValues({
1529
+ email: 'predefined@email.com',
1530
+ card_name: 'Houston'
1531
+ });
1532
+ ```
1533
+ <a name="w_MultiWidget+setFormLabels" id="w_MultiWidget+setFormLabels" href="#user-content-w_MultiWidget+setFormLabels">&nbsp;</a>
1534
+
1535
+ ### htmlMultiWidget.setFormLabels(fieldLabels)
1536
+ The method to set custom form field labels
1537
+
1538
+ **Kind**: instance method of [<code>HtmlMultiWidget</code>](#user-content-w_HtmlMultiWidget)
1539
+ **Overrides**: [<code>setFormLabels</code>](#user-content-w_MultiWidget+setFormLabels)
1540
+
1541
+ | Param | Type | Description |
1542
+ | --- | --- | --- |
1543
+ | fieldLabels | <code>Object</code> | Key of object is one of [FORM_FIELD](#user-content-w_FORM_FIELD), The object value is what we are expecting |
1544
+
1545
+ **Example**
1546
+
1547
+ ```javascript
1548
+ widget.setFormPlaceholders({
1549
+ card_name: 'Card Holder Name',
1550
+ email: 'Email For Receipt'
1551
+ })
1552
+ ```
1553
+ <a name="w_MultiWidget+setFormPlaceholders" id="w_MultiWidget+setFormPlaceholders" href="#user-content-w_MultiWidget+setFormPlaceholders">&nbsp;</a>
1554
+
1555
+ ### htmlMultiWidget.setFormPlaceholders(fieldPlaceholders)
1556
+ The method to set custom form fields placeholders
1557
+
1558
+ **Kind**: instance method of [<code>HtmlMultiWidget</code>](#user-content-w_HtmlMultiWidget)
1559
+ **Overrides**: [<code>setFormPlaceholders</code>](#user-content-w_MultiWidget+setFormPlaceholders)
1560
+
1561
+ | Param | Type | Description |
1562
+ | --- | --- | --- |
1563
+ | fieldPlaceholders | <code>Object</code> | Key of object is one of [FORM_FIELD](#user-content-w_FORM_FIELD), Value of object is expected placeholder |
1564
+
1565
+ **Example**
1566
+
1567
+ ```javascript
1568
+ widget.setFormPlaceholders({
1569
+ card_name: 'Input your card holder name...',
1570
+ email: 'Input your email, like test@example.com'
1571
+ })
1572
+ ```
1573
+ <a name="w_MultiWidget+setFormElements" id="w_MultiWidget+setFormElements" href="#user-content-w_MultiWidget+setFormElements">&nbsp;</a>
1574
+
1575
+ ### htmlMultiWidget.setFormElements(elements)
1576
+ The method to set the full configuration for the all specific form elements (label, placeholder, value)
1577
+ You can also use the other method for the partial configuration like: setFormValues, setFormPlaceholder, setFormLabel
1578
+
1579
+ **Kind**: instance method of [<code>HtmlMultiWidget</code>](#user-content-w_HtmlMultiWidget)
1580
+ **Overrides**: [<code>setFormElements</code>](#user-content-w_MultiWidget+setFormElements)
1581
+
1582
+ | Param | Type | Description |
1583
+ | --- | --- | --- |
1584
+ | elements | <code>string</code> | The list of elements |
1585
+ | elements[].field | <code>string</code> | Field name of the element [FORM_FIELD](#user-content-w_FORM_FIELD) |
1586
+ | elements[].placeholder | <code>string</code> | Set custom form field placeholder |
1587
+ | elements[].label | <code>string</code> | Set custom labels near form field |
1588
+ | elements[].value | <code>string</code> | Set predefined values for the form field |
1589
+
1590
+ **Example**
1591
+
1592
+ ```javascript
1593
+ widget.setFormElements([
1594
+ {
1595
+ field: 'card_name',
1596
+ placeholder: 'Input your card holder name...',
1597
+ label: 'Card Holder Name',
1598
+ value: 'Houston',
1599
+ },
1600
+ {
1601
+ field: 'email',
1602
+ placeholder: 'Input your email, like test@example.com',
1603
+ label: 'Email For Receipt',
1604
+ value: 'predefined@email.com',
1605
+ },
1606
+ ])
1607
+ ```
1608
+ <a name="w_MultiWidget+setIcons" id="w_MultiWidget+setIcons" href="#user-content-w_MultiWidget+setIcons">&nbsp;</a>
1609
+
1610
+ ### ~~htmlMultiWidget.setIcons()~~
1611
+ ***Deprecated***
1612
+
1613
+ The method to change the widget icons
1614
+
1615
+ **Kind**: instance method of [<code>HtmlMultiWidget</code>](#user-content-w_HtmlMultiWidget)
1616
+ **Overrides**: [<code>setIcons</code>](#user-content-w_MultiWidget+setIcons)
1617
+ <a name="w_MultiWidget+setHiddenElements" id="w_MultiWidget+setHiddenElements" href="#user-content-w_MultiWidget+setHiddenElements">&nbsp;</a>
1618
+
1619
+ ### htmlMultiWidget.setHiddenElements(elements)
1620
+ Using this method you can set hidden elements inside widget
1621
+
1622
+ **Kind**: instance method of [<code>HtmlMultiWidget</code>](#user-content-w_HtmlMultiWidget)
1623
+ **Overrides**: [<code>setHiddenElements</code>](#user-content-w_MultiWidget+setHiddenElements)
1624
+
1625
+ | Param | Type | Description |
1626
+ | --- | --- | --- |
1627
+ | elements | <code>Array.&lt;string&gt;</code> | list of element which can be hidden [ELEMENT](#user-content-w_ELEMENT) || [FORM_FIELD](#user-content-w_FORM_FIELD) |
1628
+
1629
+ **Example**
1630
+
1631
+ ```javascript
1632
+ widget.setHiddenElements(['submit_button', 'email']);
1633
+ ```
1634
+ <a name="w_MultiWidget+setRefId" id="w_MultiWidget+setRefId" href="#user-content-w_MultiWidget+setRefId">&nbsp;</a>
1635
+
1636
+ ### htmlMultiWidget.setRefId(refId)
1637
+ Current method can set custom ID to identify the data in the future
1638
+
1639
+ **Kind**: instance method of [<code>HtmlMultiWidget</code>](#user-content-w_HtmlMultiWidget)
1640
+ **Overrides**: [<code>setRefId</code>](#user-content-w_MultiWidget+setRefId)
1641
+
1642
+ | Param | Type | Description |
1643
+ | --- | --- | --- |
1644
+ | refId | <code>string</code> | custom id |
1645
+
1646
+ **Example**
1647
+
1648
+ ```javascript
1649
+ widget.setRefId('id');
1650
+ ```
1651
+ <a name="w_MultiWidget+useGatewayFieldValidation" id="w_MultiWidget+useGatewayFieldValidation" href="#user-content-w_MultiWidget+useGatewayFieldValidation">&nbsp;</a>
1652
+
1653
+ ### htmlMultiWidget.useGatewayFieldValidation()
1654
+ Current method can add visual validation from gateway to widget's form fields
1655
+
1656
+ **Kind**: instance method of [<code>HtmlMultiWidget</code>](#user-content-w_HtmlMultiWidget)
1657
+ **Overrides**: [<code>useGatewayFieldValidation</code>](#user-content-w_MultiWidget+useGatewayFieldValidation)
1658
+ **Example**
1659
+
1660
+ ```javascript
1661
+ widget.useGatewayFieldValidation();
1662
+ ```
1663
+ <a name="w_MultiWidget+setSupportedCardIcons" id="w_MultiWidget+setSupportedCardIcons" href="#user-content-w_MultiWidget+setSupportedCardIcons">&nbsp;</a>
1664
+
1665
+ ### htmlMultiWidget.setSupportedCardIcons(elements, validateCardNumberInput)
1666
+ Current method can set icons of supported card types
1667
+
1668
+ **Kind**: instance method of [<code>HtmlMultiWidget</code>](#user-content-w_HtmlMultiWidget)
1669
+ **Overrides**: [<code>setSupportedCardIcons</code>](#user-content-w_MultiWidget+setSupportedCardIcons)
1670
+
1671
+ | Param | Type | Description |
1672
+ | --- | --- | --- |
1673
+ | elements | <code>Array.&lt;string&gt;</code> | [SUPPORTED_CARD_TYPES](#user-content-w_SUPPORTED_CARD_TYPES) |
1674
+ | validateCardNumberInput | <code>boolean</code> | [validateCardNumberInput=false] - using this param you allow validation for card number input on supported card types |
1675
+
1676
+ **Example**
1677
+
1678
+ ```javascript
1679
+ widget.setSupportedCardIcons(['mastercard', 'visa'], validateCardNumberInput);
1680
+ ```
1681
+ <a name="w_MultiWidget+setEnv" id="w_MultiWidget+setEnv" href="#user-content-w_MultiWidget+setEnv">&nbsp;</a>
1682
+
1683
+ ### htmlMultiWidget.setEnv(env, [alias])
1684
+ Current method can change environment. By default environment = sandbox.
1685
+ Also we can change domain alias for this environment. By default domain_alias = paydock.com
1686
+
1687
+ **Kind**: instance method of [<code>HtmlMultiWidget</code>](#user-content-w_HtmlMultiWidget)
1688
+ **Overrides**: [<code>setEnv</code>](#user-content-w_MultiWidget+setEnv)
1689
+
1690
+ | Param | Type | Description |
1691
+ | --- | --- | --- |
1692
+ | env | <code>string</code> | sandbox, production |
1693
+ | [alias] | <code>string</code> | Own domain alias |
1694
+
1695
+ **Example**
1696
+
1697
+ ```javascript
1698
+ widget.setEnv('production', 'paydock.com');
1699
+ ```
1700
+ <a name="w_MultiWidget+loadIFrameUrl" id="w_MultiWidget+loadIFrameUrl" href="#user-content-w_MultiWidget+loadIFrameUrl">&nbsp;</a>
1701
+
1702
+ ### htmlMultiWidget.loadIFrameUrl()
1703
+ Method for creating iframe url
1704
+
1705
+ **Kind**: instance method of [<code>HtmlMultiWidget</code>](#user-content-w_HtmlMultiWidget)
1706
+ **Overrides**: [<code>loadIFrameUrl</code>](#user-content-w_MultiWidget+loadIFrameUrl)
1707
+ **Example**
1708
+
1709
+ ```javascript
1710
+ widget.loadIFrameUrl(function (url) {
1711
+ console.log(url);
1712
+ }, function (errors) {
1713
+ console.log(errors);
1714
+ });
1715
+ ```
1716
+ <a name="w_MultiWidget+setLanguage" id="w_MultiWidget+setLanguage" href="#user-content-w_MultiWidget+setLanguage">&nbsp;</a>
1717
+
1718
+ ### htmlMultiWidget.setLanguage(code)
1719
+ Method for setting a custom language code
1720
+
1721
+ **Kind**: instance method of [<code>HtmlMultiWidget</code>](#user-content-w_HtmlMultiWidget)
1722
+ **Overrides**: [<code>setLanguage</code>](#user-content-w_MultiWidget+setLanguage)
1723
+
1724
+ | Param | Type | Description |
1725
+ | --- | --- | --- |
1726
+ | code | <code>string</code> | ISO 639-1 |
1727
+
1728
+ **Example**
1729
+
1730
+ ```javascript
1731
+ config.setLanguage('en');
1732
+ ```
1733
+ <a name="w_Configuration" id="w_Configuration" href="#user-content-w_Configuration">&nbsp;</a>
1734
+
1735
+ ## Configuration
1736
+ Class Configuration include methods for creating configuration token
1737
+
1738
+ **Kind**: global class
1739
+
1740
+ * [Configuration](#user-content-w_Configuration)
1741
+ * [new Configuration([gatewayID], paymentType, purpose)](#user-content-w_new_Configuration_new)
1742
+ * [.setWebHookDestination(url)](#user-content-w_Configuration+setWebHookDestination)
1743
+ * [.setSuccessRedirectUrl(url)](#user-content-w_Configuration+setSuccessRedirectUrl)
1744
+ * [.setErrorRedirectUrl(url)](#user-content-w_Configuration+setErrorRedirectUrl)
1745
+ * [.setFormFields(fields)](#user-content-w_Configuration+setFormFields)
1746
+ * [.setMeta(object)](#user-content-w_Configuration+setMeta)
1747
+ * [.setEnv(env, [alias])](#user-content-w_Configuration+setEnv)
1748
+ * [.setLabel(label)](#user-content-w_Configuration+setLabel)
1749
+ * [.createToken(accessToken, cb, errorCb)](#user-content-w_Configuration+createToken)
1750
+
1751
+ <a name="w_new_Configuration_new" id="w_new_Configuration_new" href="#user-content-w_new_Configuration_new">&nbsp;</a>
1752
+
1753
+ ### new Configuration([gatewayID], paymentType, purpose)
1754
+
1755
+ | Param | Type | Default | Description |
1756
+ | --- | --- | --- | --- |
1757
+ | [gatewayID] | <code>string</code> | <code>&quot;default&quot;</code> | gateway ID. By default or if put 'default', it will use the selected default gateway. If put 'not_configured', it won’t use gateway to create downstream token. |
1758
+ | paymentType | <code>string</code> | | Type of payment source which shows in widget form. Available parameters [PAYMENT_TYPE](#user-content-w_PAYMENT_TYPE) |
1759
+ | purpose | <code>string</code> | | Param which describes payment purpose. By default uses Available parameters [PURPOSE](#user-content-w_PURPOSE) |
1760
+
1761
+ **Example**
1762
+
1763
+ ```javascript
1764
+ var config = new Configuration('gatewayId'); // short
1765
+
1766
+ var config = new Configuration('gatewayId', 'bank_account', 'paymentSource'); // extend
1767
+
1768
+ var config = new Configuration('not_configured'); // without gateway
1769
+ ```
1770
+ <a name="w_Configuration+setWebHookDestination" id="w_Configuration+setWebHookDestination" href="#user-content-w_Configuration+setWebHookDestination">&nbsp;</a>
1771
+
1772
+ ### configuration.setWebHookDestination(url)
1773
+ Destination, where customer will receive all successful responses.
1774
+ Response will contain “data” object with “payment_source” or other parameters, in depending on 'purpose'
1775
+
1776
+ **Kind**: instance method of [<code>Configuration</code>](#user-content-w_Configuration)
1777
+
1778
+ | Param | Type | Description |
1779
+ | --- | --- | --- |
1780
+ | url | <code>string</code> | Your endpoint for post request. |
1781
+
1782
+ **Example**
1783
+
1784
+ ```javascript
1785
+ config.setWebHookDestination('http://google.com');
1786
+ ```
1787
+ <a name="w_Configuration+setSuccessRedirectUrl" id="w_Configuration+setSuccessRedirectUrl" href="#user-content-w_Configuration+setSuccessRedirectUrl">&nbsp;</a>
1788
+
1789
+ ### configuration.setSuccessRedirectUrl(url)
1790
+ URL to which the Customer will be redirected to after the success finish
1791
+
1792
+ **Kind**: instance method of [<code>Configuration</code>](#user-content-w_Configuration)
1793
+
1794
+ | Param | Type |
1795
+ | --- | --- |
1796
+ | url | <code>string</code> |
1797
+
1798
+ **Example**
1799
+
1800
+ ```javascript
1801
+ config.setSuccessRedirectUrl('google.com/search?q=success');
1802
+ ```
1803
+ <a name="w_Configuration+setErrorRedirectUrl" id="w_Configuration+setErrorRedirectUrl" href="#user-content-w_Configuration+setErrorRedirectUrl">&nbsp;</a>
1804
+
1805
+ ### configuration.setErrorRedirectUrl(url)
1806
+ URL to which the Customer will be redirected to if an error is triggered in the process of operation
1807
+
1808
+ **Kind**: instance method of [<code>Configuration</code>](#user-content-w_Configuration)
1809
+
1810
+ | Param | Type |
1811
+ | --- | --- |
1812
+ | url | <code>string</code> |
1813
+
1814
+ **Example**
1815
+
1816
+ ```javascript
1817
+ config.setErrorRedirectUrl('google.com/search?q=error');
1818
+ ```
1819
+ <a name="w_Configuration+setFormFields" id="w_Configuration+setFormFields" href="#user-content-w_Configuration+setFormFields">&nbsp;</a>
1820
+
1821
+ ### configuration.setFormFields(fields)
1822
+ Set list with widget form field, which will be shown in form. Also you can set the required validation for these fields
1823
+
1824
+ **Kind**: instance method of [<code>Configuration</code>](#user-content-w_Configuration)
1825
+
1826
+ | Param | Type | Description |
1827
+ | --- | --- | --- |
1828
+ | fields | <code>Array.&lt;string&gt;</code> | name of fields which can be shown in a widget. If after a name of a field, you put “*”, this field will be required on client-side. (For validation, you can specify any fields, even those that are shown by default: card_number, expiration, etc... ) [FORM_FIELD](#user-content-w_FORM_FIELD) |
1829
+
1830
+ **Example**
1831
+
1832
+ ```javascript
1833
+ config.setFormFields(['phone', 'email', 'first_name*']);
1834
+ ```
1835
+ <a name="w_Configuration+setMeta" id="w_Configuration+setMeta" href="#user-content-w_Configuration+setMeta">&nbsp;</a>
1836
+
1837
+ ### configuration.setMeta(object)
1838
+ Method for setting meta information for checkout page
1839
+
1840
+ **Kind**: instance method of [<code>Configuration</code>](#user-content-w_Configuration)
1841
+
1842
+ | Param | Type | Description |
1843
+ | --- | --- | --- |
1844
+ | object | [<code>IPayPalMeta</code>](#user-content-w_IPayPalMeta) \| <code>IZipmoneyMeta</code> \| <code>IAfterpayMeta</code> \| [<code>IBamboraMeta</code>](#user-content-w_IBamboraMeta) | data which can be shown on checkout page [IPayPalMeta](#user-content-w_IPayPalMeta) [IZipmoneyMeta](IZipmoneyMeta) [IAfterpayMeta](IAfterpayMeta) [IBamboraMeta](#user-content-w_IBamboraMeta) |
1845
+
1846
+ **Example**
1847
+
1848
+ ```javascript
1849
+ config.setMeta({
1850
+ brand_name: 'paydock',
1851
+ reference: '15',
1852
+ email: 'wault@paydock.com'
1853
+ });
1854
+ ```
1855
+ <a name="w_Configuration+setEnv" id="w_Configuration+setEnv" href="#user-content-w_Configuration+setEnv">&nbsp;</a>
1856
+
1857
+ ### configuration.setEnv(env, [alias])
1858
+ Current method can change environment. By default environment = sandbox.
1859
+ Also we can change domain alias for this environment. By default domain_alias = paydock.com
1860
+
1861
+ **Kind**: instance method of [<code>Configuration</code>](#user-content-w_Configuration)
1862
+
1863
+ | Param | Type | Description |
1864
+ | --- | --- | --- |
1865
+ | env | <code>string</code> | sandbox, production |
1866
+ | [alias] | <code>string</code> | Own domain alias |
1867
+
1868
+ **Example**
1869
+
1870
+ ```javascript
1871
+ config.setEnv('production');
1872
+ ```
1873
+ <a name="w_Configuration+setLabel" id="w_Configuration+setLabel" href="#user-content-w_Configuration+setLabel">&nbsp;</a>
1874
+
1875
+ ### configuration.setLabel(label)
1876
+ Title for tab which can be set instead of default
1877
+
1878
+ **Kind**: instance method of [<code>Configuration</code>](#user-content-w_Configuration)
1879
+
1880
+ | Param | Type | Description |
1881
+ | --- | --- | --- |
1882
+ | label | <code>string</code> | Text label for tab |
1883
+
1884
+ **Example**
1885
+
1886
+ ```javascript
1887
+ config.setLabel('custom label');
1888
+ ```
1889
+ <a name="w_Configuration+createToken" id="w_Configuration+createToken" href="#user-content-w_Configuration+createToken">&nbsp;</a>
1890
+
1891
+ ### configuration.createToken(accessToken, cb, errorCb)
1892
+ createToken - method which exactly create payment one time token
1893
+
1894
+ **Kind**: instance method of [<code>Configuration</code>](#user-content-w_Configuration)
1895
+
1896
+ | Param | Type | Description |
1897
+ | --- | --- | --- |
1898
+ | accessToken | <code>string</code> | Customer access token or public key which provided for each client |
1899
+ | cb | <code>createToken~requestCallback</code> | The callback that handles the success response. |
1900
+ | errorCb | <code>createToken~requestCallback</code> | The callback that handles the failed response. |
1901
+
1902
+ **Example**
1903
+
1904
+ ```javascript
1905
+ config.createToken('582035346f65cdd57ee81192d6e5w65w4e5',
1906
+ function (data) {
1907
+ console.log(data);
1908
+ }, function (error) {
1909
+ console.log(error);
1910
+ });
1911
+ ```
1912
+ <a name="w_MultiWidget" id="w_MultiWidget" href="#user-content-w_MultiWidget">&nbsp;</a>
1913
+
1914
+ ## MultiWidget
1915
+ Class MultiWidget include method for for creating iframe url
1916
+
1917
+ **Kind**: global class
1918
+
1919
+ * [MultiWidget](#user-content-w_MultiWidget)
1920
+ * [new MultiWidget(accessToken, conf)](#user-content-w_new_MultiWidget_new)
1921
+ * [.setStyles(fields)](#user-content-w_MultiWidget+setStyles)
1922
+ * [.usePhoneCountryMask([options])](#user-content-w_MultiWidget+usePhoneCountryMask)
1923
+ * [.setTexts(fields)](#user-content-w_MultiWidget+setTexts)
1924
+ * [.setElementStyle(element, [state], styles)](#user-content-w_MultiWidget+setElementStyle)
1925
+ * [.setFormValues(fieldValues)](#user-content-w_MultiWidget+setFormValues)
1926
+ * [.setFormLabels(fieldLabels)](#user-content-w_MultiWidget+setFormLabels)
1927
+ * [.setFormPlaceholders(fieldPlaceholders)](#user-content-w_MultiWidget+setFormPlaceholders)
1928
+ * [.setFormElements(elements)](#user-content-w_MultiWidget+setFormElements)
1929
+ * ~~[.setIcons()](#user-content-w_MultiWidget+setIcons)~~
1930
+ * [.setHiddenElements(elements)](#user-content-w_MultiWidget+setHiddenElements)
1931
+ * [.setRefId(refId)](#user-content-w_MultiWidget+setRefId)
1932
+ * [.useGatewayFieldValidation()](#user-content-w_MultiWidget+useGatewayFieldValidation)
1933
+ * [.setSupportedCardIcons(elements, validateCardNumberInput)](#user-content-w_MultiWidget+setSupportedCardIcons)
1934
+ * [.setEnv(env, [alias])](#user-content-w_MultiWidget+setEnv)
1935
+ * [.loadIFrameUrl()](#user-content-w_MultiWidget+loadIFrameUrl)
1936
+ * [.setLanguage(code)](#user-content-w_MultiWidget+setLanguage)
1937
+
1938
+ <a name="w_new_MultiWidget_new" id="w_new_MultiWidget_new" href="#user-content-w_new_MultiWidget_new">&nbsp;</a>
1939
+
1940
+ ### new MultiWidget(accessToken, conf)
1941
+
1942
+ | Param | Type | Description |
1943
+ | --- | --- | --- |
1944
+ | accessToken | <code>string</code> | PayDock users access token or public key |
1945
+ | conf | [<code>Configuration</code>](#user-content-w_Configuration) \| <code>string</code> \| [<code>Array.&lt;Configuration&gt;</code>](#user-content-w_Configuration) \| <code>Array.&lt;string&gt;</code> | exemplar[s] Configuration class OR configuration token |
1946
+
1947
+ **Example**
1948
+
1949
+ ```javascript
1950
+ var widget = new MultiWidget('accessToken','configurationToken'); // With a pre-created configuration token
1951
+
1952
+ var widget = new MultiWidget('accessToken',['configurationToken', 'configurationToken2']); // With pre-created configuration tokens
1953
+
1954
+ var widget = new MultiWidget('accessToken', new Configuration('gatewayId')); With Configuration
1955
+
1956
+ var widget = new MultiWidget('accessToken',[ With Configurations
1957
+ Configuration('gatewayId'),
1958
+ Configuration('gatewayId', 'bank_account')
1959
+ ]);
1960
+ ```
1961
+ <a name="w_MultiWidget+setStyles" id="w_MultiWidget+setStyles" href="#user-content-w_MultiWidget+setStyles">&nbsp;</a>
1962
+
1963
+ ### multiWidget.setStyles(fields)
1964
+ Object contain styles for widget
1965
+
1966
+ **Kind**: instance method of [<code>MultiWidget</code>](#user-content-w_MultiWidget)
1967
+
1968
+ | Param | Type | Description |
1969
+ | --- | --- | --- |
1970
+ | fields | [<code>IStyles</code>](#user-content-w_IStyles) | name of styles which can be shown in widget [STYLE](#user-content-w_STYLE) |
1971
+
1972
+ **Example**
1973
+
1974
+ ```javascript
1975
+ widget.setStyles({
1976
+ background_color: 'rgb(0, 0, 0)',
1977
+ border_color: 'yellow',
1978
+ text_color: '#FFFFAA',
1979
+ button_color: 'rgba(255, 255, 255, 0.9)',
1980
+ font_size: '20px'
1981
+ fort_family: 'fantasy'
1982
+ });
1983
+ ```
1984
+ <a name="w_MultiWidget+usePhoneCountryMask" id="w_MultiWidget+usePhoneCountryMask" href="#user-content-w_MultiWidget+usePhoneCountryMask">&nbsp;</a>
1985
+
1986
+ ### multiWidget.usePhoneCountryMask([options])
1987
+ Method to set a country code mask for the phone input.
1988
+
1989
+ **Kind**: instance method of [<code>MultiWidget</code>](#user-content-w_MultiWidget)
1990
+
1991
+ | Param | Type | Description |
1992
+ | --- | --- | --- |
1993
+ | [options] | <code>object</code> | Options for configure the phone mask. |
1994
+ | [options.default_country] | <code>string</code> | Set a default country for the mask. |
1995
+ | [options.preferred_countries] | <code>Array.&lt;string&gt;</code> | Set list of preferred countries for the top of the select box . |
1996
+ | [options.only_countries] | <code>Array.&lt;string&gt;</code> | Set list of countries to show in the select box. |
1997
+
1998
+ **Example**
1999
+
2000
+ ```javascript
2001
+ widget.usePhoneCountryMask();
2002
+ ```
2003
+ **Example**
2004
+
2005
+ ```javascript
2006
+ widget.usePhoneCountryMask({
2007
+ default_country: 'au',
2008
+ preferred_countries: ['au', 'gb'],
2009
+ only_countries: ['au', 'gb', 'us', 'ua']
2010
+ });
2011
+ ```
2012
+ <a name="w_MultiWidget+setTexts" id="w_MultiWidget+setTexts" href="#user-content-w_MultiWidget+setTexts">&nbsp;</a>
2013
+
2014
+ ### multiWidget.setTexts(fields)
2015
+ Method for set different texts inside the widget
2016
+
2017
+ **Kind**: instance method of [<code>MultiWidget</code>](#user-content-w_MultiWidget)
2018
+
2019
+ | Param | Type | Description |
2020
+ | --- | --- | --- |
2021
+ | fields | [<code>ITexts</code>](#user-content-w_ITexts) | name of text items which can be shown in widget [TEXT](#user-content-w_TEXT) |
2022
+
2023
+ **Example**
2024
+
2025
+ ```javascript
2026
+ widget.setTexts({
2027
+ title: 'Your card',
2028
+ finish_text: 'Payment resource was successfully accepted',
2029
+ title_description: '* indicates required field',
2030
+ submit_button: 'Save',
2031
+ submit_button_processing: 'Load...',
2032
+ });
2033
+ ```
2034
+ <a name="w_MultiWidget+setElementStyle" id="w_MultiWidget+setElementStyle" href="#user-content-w_MultiWidget+setElementStyle">&nbsp;</a>
2035
+
2036
+ ### multiWidget.setElementStyle(element, [state], styles)
2037
+ Method for set styles for different elements and states
2038
+
2039
+ **Kind**: instance method of [<code>MultiWidget</code>](#user-content-w_MultiWidget)
2040
+
2041
+ | Param | Type | Description |
2042
+ | --- | --- | --- |
2043
+ | element | <code>string</code> | type of element for styling. These elements are available [STYLABLE_ELEMENT](#user-content-w_STYLABLE_ELEMENT) |
2044
+ | [state] | <code>string</code> | state of element for styling. These states are available [STYLABLE_ELEMENT_STATE](#user-content-w_STYLABLE_ELEMENT_STATE) |
2045
+ | styles | [<code>IElementStyleInput</code>](#user-content-w_IElementStyleInput) \| [<code>IElementStyleSubmitButton</code>](#user-content-w_IElementStyleSubmitButton) \| [<code>IElementStyleLabel</code>](#user-content-w_IElementStyleLabel) \| [<code>IElementStyleTitle</code>](#user-content-w_IElementStyleTitle) \| [<code>IElementStyleTitleDescription</code>](#user-content-w_IElementStyleTitleDescription) | styles list |
2046
+
2047
+ **Example**
2048
+
2049
+ ```javascript
2050
+ widget.setElementStyle('input', {
2051
+ border: 'green solid 1px'
2052
+ });
2053
+
2054
+ widget.setElementStyle('input', 'focus', {
2055
+ border: 'blue solid 1px'
2056
+ });
2057
+
2058
+ widget.setElementStyle('input', 'error', {
2059
+ border: 'red solid 1px'
2060
+ });
2061
+ ```
2062
+ <a name="w_MultiWidget+setFormValues" id="w_MultiWidget+setFormValues" href="#user-content-w_MultiWidget+setFormValues">&nbsp;</a>
2063
+
2064
+ ### multiWidget.setFormValues(fieldValues)
2065
+ The method to set the predefined values for the form fields inside the widget
2066
+
2067
+ **Kind**: instance method of [<code>MultiWidget</code>](#user-content-w_MultiWidget)
2068
+
2069
+ | Param | Type | Description |
2070
+ | --- | --- | --- |
2071
+ | fieldValues | <code>Object</code> | Key of object is one of [FORM_FIELD](#user-content-w_FORM_FIELD), The object value is what we are expecting |
2072
+
2073
+ **Example**
2074
+
2075
+ ```javascript
2076
+ widget.setFormValues({
2077
+ email: 'predefined@email.com',
2078
+ card_name: 'Houston'
2079
+ });
2080
+ ```
2081
+ <a name="w_MultiWidget+setFormLabels" id="w_MultiWidget+setFormLabels" href="#user-content-w_MultiWidget+setFormLabels">&nbsp;</a>
2082
+
2083
+ ### multiWidget.setFormLabels(fieldLabels)
2084
+ The method to set custom form field labels
2085
+
2086
+ **Kind**: instance method of [<code>MultiWidget</code>](#user-content-w_MultiWidget)
2087
+
2088
+ | Param | Type | Description |
2089
+ | --- | --- | --- |
2090
+ | fieldLabels | <code>Object</code> | Key of object is one of [FORM_FIELD](#user-content-w_FORM_FIELD), The object value is what we are expecting |
2091
+
2092
+ **Example**
2093
+
2094
+ ```javascript
2095
+ widget.setFormPlaceholders({
2096
+ card_name: 'Card Holder Name',
2097
+ email: 'Email For Receipt'
2098
+ })
2099
+ ```
2100
+ <a name="w_MultiWidget+setFormPlaceholders" id="w_MultiWidget+setFormPlaceholders" href="#user-content-w_MultiWidget+setFormPlaceholders">&nbsp;</a>
2101
+
2102
+ ### multiWidget.setFormPlaceholders(fieldPlaceholders)
2103
+ The method to set custom form fields placeholders
2104
+
2105
+ **Kind**: instance method of [<code>MultiWidget</code>](#user-content-w_MultiWidget)
2106
+
2107
+ | Param | Type | Description |
2108
+ | --- | --- | --- |
2109
+ | fieldPlaceholders | <code>Object</code> | Key of object is one of [FORM_FIELD](#user-content-w_FORM_FIELD), Value of object is expected placeholder |
2110
+
2111
+ **Example**
2112
+
2113
+ ```javascript
2114
+ widget.setFormPlaceholders({
2115
+ card_name: 'Input your card holder name...',
2116
+ email: 'Input your email, like test@example.com'
2117
+ })
2118
+ ```
2119
+ <a name="w_MultiWidget+setFormElements" id="w_MultiWidget+setFormElements" href="#user-content-w_MultiWidget+setFormElements">&nbsp;</a>
2120
+
2121
+ ### multiWidget.setFormElements(elements)
2122
+ The method to set the full configuration for the all specific form elements (label, placeholder, value)
2123
+ You can also use the other method for the partial configuration like: setFormValues, setFormPlaceholder, setFormLabel
2124
+
2125
+ **Kind**: instance method of [<code>MultiWidget</code>](#user-content-w_MultiWidget)
2126
+
2127
+ | Param | Type | Description |
2128
+ | --- | --- | --- |
2129
+ | elements | <code>string</code> | The list of elements |
2130
+ | elements[].field | <code>string</code> | Field name of the element [FORM_FIELD](#user-content-w_FORM_FIELD) |
2131
+ | elements[].placeholder | <code>string</code> | Set custom form field placeholder |
2132
+ | elements[].label | <code>string</code> | Set custom labels near form field |
2133
+ | elements[].value | <code>string</code> | Set predefined values for the form field |
2134
+
2135
+ **Example**
2136
+
2137
+ ```javascript
2138
+ widget.setFormElements([
2139
+ {
2140
+ field: 'card_name',
2141
+ placeholder: 'Input your card holder name...',
2142
+ label: 'Card Holder Name',
2143
+ value: 'Houston',
2144
+ },
2145
+ {
2146
+ field: 'email',
2147
+ placeholder: 'Input your email, like test@example.com',
2148
+ label: 'Email For Receipt',
2149
+ value: 'predefined@email.com',
2150
+ },
2151
+ ])
2152
+ ```
2153
+ <a name="w_MultiWidget+setIcons" id="w_MultiWidget+setIcons" href="#user-content-w_MultiWidget+setIcons">&nbsp;</a>
2154
+
2155
+ ### ~~multiWidget.setIcons()~~
2156
+ ***Deprecated***
2157
+
2158
+ The method to change the widget icons
2159
+
2160
+ **Kind**: instance method of [<code>MultiWidget</code>](#user-content-w_MultiWidget)
2161
+ <a name="w_MultiWidget+setHiddenElements" id="w_MultiWidget+setHiddenElements" href="#user-content-w_MultiWidget+setHiddenElements">&nbsp;</a>
2162
+
2163
+ ### multiWidget.setHiddenElements(elements)
2164
+ Using this method you can set hidden elements inside widget
2165
+
2166
+ **Kind**: instance method of [<code>MultiWidget</code>](#user-content-w_MultiWidget)
2167
+
2168
+ | Param | Type | Description |
2169
+ | --- | --- | --- |
2170
+ | elements | <code>Array.&lt;string&gt;</code> | list of element which can be hidden [ELEMENT](#user-content-w_ELEMENT) || [FORM_FIELD](#user-content-w_FORM_FIELD) |
2171
+
2172
+ **Example**
2173
+
2174
+ ```javascript
2175
+ widget.setHiddenElements(['submit_button', 'email']);
2176
+ ```
2177
+ <a name="w_MultiWidget+setRefId" id="w_MultiWidget+setRefId" href="#user-content-w_MultiWidget+setRefId">&nbsp;</a>
2178
+
2179
+ ### multiWidget.setRefId(refId)
2180
+ Current method can set custom ID to identify the data in the future
2181
+
2182
+ **Kind**: instance method of [<code>MultiWidget</code>](#user-content-w_MultiWidget)
2183
+
2184
+ | Param | Type | Description |
2185
+ | --- | --- | --- |
2186
+ | refId | <code>string</code> | custom id |
2187
+
2188
+ **Example**
2189
+
2190
+ ```javascript
2191
+ widget.setRefId('id');
2192
+ ```
2193
+ <a name="w_MultiWidget+useGatewayFieldValidation" id="w_MultiWidget+useGatewayFieldValidation" href="#user-content-w_MultiWidget+useGatewayFieldValidation">&nbsp;</a>
2194
+
2195
+ ### multiWidget.useGatewayFieldValidation()
2196
+ Current method can add visual validation from gateway to widget's form fields
2197
+
2198
+ **Kind**: instance method of [<code>MultiWidget</code>](#user-content-w_MultiWidget)
2199
+ **Example**
2200
+
2201
+ ```javascript
2202
+ widget.useGatewayFieldValidation();
2203
+ ```
2204
+ <a name="w_MultiWidget+setSupportedCardIcons" id="w_MultiWidget+setSupportedCardIcons" href="#user-content-w_MultiWidget+setSupportedCardIcons">&nbsp;</a>
2205
+
2206
+ ### multiWidget.setSupportedCardIcons(elements, validateCardNumberInput)
2207
+ Current method can set icons of supported card types
2208
+
2209
+ **Kind**: instance method of [<code>MultiWidget</code>](#user-content-w_MultiWidget)
2210
+
2211
+ | Param | Type | Description |
2212
+ | --- | --- | --- |
2213
+ | elements | <code>Array.&lt;string&gt;</code> | [SUPPORTED_CARD_TYPES](#user-content-w_SUPPORTED_CARD_TYPES) |
2214
+ | validateCardNumberInput | <code>boolean</code> | [validateCardNumberInput=false] - using this param you allow validation for card number input on supported card types |
2215
+
2216
+ **Example**
2217
+
2218
+ ```javascript
2219
+ widget.setSupportedCardIcons(['mastercard', 'visa'], validateCardNumberInput);
2220
+ ```
2221
+ <a name="w_MultiWidget+setEnv" id="w_MultiWidget+setEnv" href="#user-content-w_MultiWidget+setEnv">&nbsp;</a>
2222
+
2223
+ ### multiWidget.setEnv(env, [alias])
2224
+ Current method can change environment. By default environment = sandbox.
2225
+ Also we can change domain alias for this environment. By default domain_alias = paydock.com
2226
+
2227
+ **Kind**: instance method of [<code>MultiWidget</code>](#user-content-w_MultiWidget)
2228
+
2229
+ | Param | Type | Description |
2230
+ | --- | --- | --- |
2231
+ | env | <code>string</code> | sandbox, production |
2232
+ | [alias] | <code>string</code> | Own domain alias |
2233
+
2234
+ **Example**
2235
+
2236
+ ```javascript
2237
+ widget.setEnv('production', 'paydock.com');
2238
+ ```
2239
+ <a name="w_MultiWidget+loadIFrameUrl" id="w_MultiWidget+loadIFrameUrl" href="#user-content-w_MultiWidget+loadIFrameUrl">&nbsp;</a>
2240
+
2241
+ ### multiWidget.loadIFrameUrl()
2242
+ Method for creating iframe url
2243
+
2244
+ **Kind**: instance method of [<code>MultiWidget</code>](#user-content-w_MultiWidget)
2245
+ **Example**
2246
+
2247
+ ```javascript
2248
+ widget.loadIFrameUrl(function (url) {
2249
+ console.log(url);
2250
+ }, function (errors) {
2251
+ console.log(errors);
2252
+ });
2253
+ ```
2254
+ <a name="w_MultiWidget+setLanguage" id="w_MultiWidget+setLanguage" href="#user-content-w_MultiWidget+setLanguage">&nbsp;</a>
2255
+
2256
+ ### multiWidget.setLanguage(code)
2257
+ Method for setting a custom language code
2258
+
2259
+ **Kind**: instance method of [<code>MultiWidget</code>](#user-content-w_MultiWidget)
2260
+
2261
+ | Param | Type | Description |
2262
+ | --- | --- | --- |
2263
+ | code | <code>string</code> | ISO 639-1 |
2264
+
2265
+ **Example**
2266
+
2267
+ ```javascript
2268
+ config.setLanguage('en');
2269
+ ```
2270
+ <a name="w_EVENT" id="w_EVENT" href="#user-content-w_EVENT">&nbsp;</a>
2271
+
2272
+ ## EVENT : <code>object</code>
2273
+ List of available event's name
2274
+
2275
+ **Kind**: global constant
2276
+
2277
+ | Param | Type | Default |
2278
+ | --- | --- | --- |
2279
+ | AFTER_LOAD | <code>string</code> | <code>&quot;afterLoad&quot;</code> |
2280
+ | SUBMIT | <code>string</code> | <code>&quot;submit&quot;</code> |
2281
+ | FINISH | <code>string</code> | <code>&quot;finish&quot;</code> |
2282
+ | VALIDATION | <code>string</code> | <code>&quot;validation&quot;</code> |
2283
+ | VALIDATION_ERROR | <code>string</code> | <code>&quot;validationError&quot;</code> |
2284
+ | SYSTEM_ERROR | <code>string</code> | <code>&quot;systemError&quot;</code> |
2285
+ | META_CHANGE | <code>string</code> | <code>&quot;metaChange&quot;</code> |
2286
+ | RESIZE | <code>string</code> | <code>&quot;resize&quot;</code> |
2287
+
2288
+ <a name="w_VAULT_DISPLAY_EVENT" id="w_VAULT_DISPLAY_EVENT" href="#user-content-w_VAULT_DISPLAY_EVENT">&nbsp;</a>
2289
+
2290
+ ## VAULT\_DISPLAY\_EVENT : <code>object</code>
2291
+ List of available event's name
2292
+
2293
+ **Kind**: global constant
2294
+
2295
+ | Param | Type | Default |
2296
+ | --- | --- | --- |
2297
+ | AFTER_LOAD | <code>string</code> | <code>&quot;afterLoad&quot;</code> |
2298
+ | SYSTEM_ERROR | <code>string</code> | <code>&quot;system_error&quot;</code> |
2299
+ | CVV_SECURE_CODE_REQUESTED | <code>string</code> | <code>&quot;cvv_secure_code_requested&quot;</code> |
2300
+ | CARD_NUMBER_SECURE_CODE_REQUESTED | <code>string</code> | <code>&quot;card_number_secure_code_requested&quot;</code> |
2301
+ | ACCESS_FORBIDDEN | <code>string</code> | <code>&quot;access_forbidden&quot;</code> |
2302
+ | SESSION_EXPIRED | <code>string</code> | <code>&quot;systemError&quot;</code> |
2303
+ | SYSTEM_ERROR | <code>string</code> | <code>&quot;session_expired&quot;</code> |
2304
+ | OPERATION_FORBIDDEN | <code>string</code> | <code>&quot;operation_forbidden&quot;</code> |
2305
+
2306
+ <a name="w_PAYMENT_TYPE" id="w_PAYMENT_TYPE" href="#user-content-w_PAYMENT_TYPE">&nbsp;</a>
2307
+
2308
+ ## PAYMENT\_TYPE : <code>object</code>
2309
+ List of available payment source types
2310
+
2311
+ **Kind**: global constant
2312
+
2313
+ | Param | Type | Default |
2314
+ | --- | --- | --- |
2315
+ | CARD | <code>string</code> | <code>&quot;card&quot;</code> |
2316
+ | BANK_ACCOUNT | <code>string</code> | <code>&quot;bank_account&quot;</code> |
2317
+ | CHECKOUT | <code>string</code> | <code>&quot;checkout&quot;</code> |
2318
+
2319
+ <a name="w_PURPOSE" id="w_PURPOSE" href="#user-content-w_PURPOSE">&nbsp;</a>
2320
+
2321
+ ## PURPOSE : <code>object</code>
2322
+ Purposes
2323
+
2324
+ **Kind**: global constant
2325
+
2326
+ | Param | Type | Default |
2327
+ | --- | --- | --- |
2328
+ | PAYMENT_SOURCE | <code>string</code> | <code>&quot;payment_source&quot;</code> |
2329
+ | CARD_PAYMENT_SOURCE_WITH_CVV | <code>string</code> | <code>&quot;card_payment_source_with_cvv&quot;</code> |
2330
+ | CARD_PAYMENT_SOURCE_WITHOUT_CVV | <code>string</code> | <code>&quot;card_payment_source_without_cvv&quot;</code> |
2331
+
2332
+ <a name="w_FORM_FIELD" id="w_FORM_FIELD" href="#user-content-w_FORM_FIELD">&nbsp;</a>
2333
+
2334
+ ## FORM\_FIELD : <code>object</code>
2335
+ Current constant include available type of fields which can be included to widget
2336
+
2337
+ **Kind**: global constant
2338
+
2339
+ | Param | Type | Default |
2340
+ | --- | --- | --- |
2341
+ | CARD_NAME | <code>string</code> | <code>&quot;card_name&quot;</code> |
2342
+ | CARD_NUMBER | <code>string</code> | <code>&quot;card_number&quot;</code> |
2343
+ | EXPIRE_MONTH | <code>string</code> | <code>&quot;expire_month&quot;</code> |
2344
+ | EXPIRE_YEAR | <code>string</code> | <code>&quot;expire_year&quot;</code> |
2345
+ | CARD_CCV | <code>string</code> | <code>&quot;card_ccv&quot;</code> |
2346
+ | CARD_PIN | <code>string</code> | <code>&quot;card_pin&quot;</code> |
2347
+ | ACCOUNT_NAME | <code>string</code> | <code>&quot;account_name&quot;</code> |
2348
+ | ACCOUNT_BSB | <code>string</code> | <code>&quot;account_bsb&quot;</code> |
2349
+ | ACCOUNT_NUMBER | <code>string</code> | <code>&quot;account_number&quot;</code> |
2350
+ | ACCOUNT_ROUTING | <code>string</code> | <code>&quot;account_routing&quot;</code> |
2351
+ | ACCOUNT_HOLDER_TYPE | <code>string</code> | <code>&quot;account_holder_type&quot;</code> |
2352
+ | ACCOUNT_BANK_NAME | <code>string</code> | <code>&quot;account_bank_name&quot;</code> |
2353
+ | ACCOUNT_TYPE | <code>string</code> | <code>&quot;account_type&quot;</code> |
2354
+ | FIRST_NAME | <code>string</code> | <code>&quot;first_name&quot;</code> |
2355
+ | LAST_NAME | <code>string</code> | <code>&quot;last_name&quot;</code> |
2356
+ | EMAIL | <code>string</code> | <code>&quot;email&quot;</code> |
2357
+ | PHONE | <code>string</code> | <code>&quot;phone&quot;</code> |
2358
+ | PHONE2 | <code>string</code> | <code>&quot;phone2&quot;</code> |
2359
+ | ADDRESS_LINE1 | <code>string</code> | <code>&quot;address_line1&quot;</code> |
2360
+ | ADDRESS_LINE2 | <code>string</code> | <code>&quot;address_line2&quot;</code> |
2361
+ | ADDRESS_STATE | <code>string</code> | <code>&quot;address_state&quot;</code> |
2362
+ | ADDRESS_COUNTRY | <code>string</code> | <code>&quot;address_country&quot;</code> |
2363
+ | ADDRESS_CITY | <code>string</code> | <code>&quot;address_city&quot;</code> |
2364
+ | ADDRESS_POSTCODE | <code>string</code> | <code>&quot;address_postcode&quot;</code> |
2365
+ | ADDRESS_COMPANY | <code>string</code> | <code>&quot;address_company&quot;</code> |
2366
+
2367
+ <a name="w_STYLE" id="w_STYLE" href="#user-content-w_STYLE">&nbsp;</a>
2368
+
2369
+ ## STYLE : <code>object</code>
2370
+ List of available style params for widget
2371
+
2372
+ **Kind**: global constant
2373
+
2374
+ | Param | Type | Default |
2375
+ | --- | --- | --- |
2376
+ | BACKGROUND_COLOR | <code>string</code> | <code>&quot;background_color&quot;</code> |
2377
+ | TEXT_COLOR | <code>string</code> | <code>&quot;text_color&quot;</code> |
2378
+ | BORDER_COLOR | <code>string</code> | <code>&quot;border_color&quot;</code> |
2379
+ | BUTTON_COLOR | <code>string</code> | <code>&quot;button_color&quot;</code> |
2380
+ | ERROR_COLOR | <code>string</code> | <code>&quot;error_color&quot;</code> |
2381
+ | SUCCESS_COLOR | <code>string</code> | <code>&quot;success_color&quot;</code> |
2382
+ | FONT_SIZE | <code>string</code> | <code>&quot;font_size&quot;</code> |
2383
+ | FONT_FAMILY | <code>string</code> | <code>&quot;font_family&quot;</code> |
2384
+
2385
+ <a name="w_TEXT" id="w_TEXT" href="#user-content-w_TEXT">&nbsp;</a>
2386
+
2387
+ ## TEXT : <code>object</code>
2388
+ List of available text item params for widget
2389
+
2390
+ **Kind**: global constant
2391
+
2392
+ | Param | Type | Default |
2393
+ | --- | --- | --- |
2394
+ | TITLE | <code>string</code> | <code>&quot;title&quot;</code> |
2395
+ | FINISH | <code>string</code> | <code>&quot;finish_text&quot;</code> |
2396
+
2397
+ <a name="w_ELEMENT" id="w_ELEMENT" href="#user-content-w_ELEMENT">&nbsp;</a>
2398
+
2399
+ ## ELEMENT : <code>object</code>
2400
+ List of available params for hide elements
2401
+
2402
+ **Kind**: global constant
2403
+
2404
+ | Param | Type | Default |
2405
+ | --- | --- | --- |
2406
+ | SUBMIT_BUTTON | <code>string</code> | <code>&quot;submit_button&quot;</code> |
2407
+ | TABS | <code>string</code> | <code>&quot;tabs&quot;</code> |
2408
+
2409
+ <a name="w_SUPPORTED_CARD_TYPES" id="w_SUPPORTED_CARD_TYPES" href="#user-content-w_SUPPORTED_CARD_TYPES">&nbsp;</a>
2410
+
2411
+ ## SUPPORTED\_CARD\_TYPES : <code>object</code>
2412
+ The list of available parameters for showing card icons
2413
+
2414
+ **Kind**: global constant
2415
+
2416
+ | Param | Type | Default |
2417
+ | --- | --- | --- |
2418
+ | AMEX | <code>string</code> | <code>&quot;amex&quot;</code> |
2419
+ | AUSBC | <code>string</code> | <code>&quot;ausbc&quot;</code> |
2420
+ | DINERS | <code>string</code> | <code>&quot;diners&quot;</code> |
2421
+ | DISCOVER | <code>string</code> | <code>&quot;discover&quot;</code> |
2422
+ | JAPCB | <code>string</code> | <code>&quot;japcb&quot;</code> |
2423
+ | LASER | <code>string</code> | <code>&quot;laser&quot;</code> |
2424
+ | MASTERCARD | <code>string</code> | <code>&quot;mastercard&quot;</code> |
2425
+ | SOLO | <code>string</code> | <code>&quot;solo&quot;</code> |
2426
+ | VISA | <code>string</code> | <code>&quot;visa&quot;</code> |
2427
+ | VISA_WHITE | <code>string</code> | <code>&quot;visa_white&quot;</code> |
2428
+
2429
+ <a name="w_STYLABLE_ELEMENT" id="w_STYLABLE_ELEMENT" href="#user-content-w_STYLABLE_ELEMENT">&nbsp;</a>
2430
+
2431
+ ## STYLABLE\_ELEMENT : <code>object</code>
2432
+ Current constant include available type of element for styling
2433
+
2434
+ **Kind**: global constant
2435
+
2436
+ | Param | Type | Default | Description |
2437
+ | --- | --- | --- | --- |
2438
+ | INPUT | <code>string</code> | <code>&quot;input.&quot;</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) |
2439
+ | SUBMIT_BUTTON | <code>string</code> | <code>&quot;submit_button&quot;</code> | These states are available: [STYLABLE_ELEMENT_STATE.HOVER](#user-content-w_STYLABLE_ELEMENT_STATE). These styles are available [IElementStyleSubmitButton](#user-content-w_IElementStyleSubmitButton) |
2440
+ | LABEL | <code>string</code> | <code>&quot;label.&quot;</code> | These styles are available [IElementStyleLabel](#user-content-w_IElementStyleLabel) |
2441
+ | TITLE | <code>string</code> | <code>&quot;title.&quot;</code> | These styles are available [IElementStyleTitle](#user-content-w_IElementStyleTitle) |
2442
+ | TITLE_DESCRIPTION | <code>string</code> | <code>&quot;title_description.&quot;</code> | These styles are available [IElementStyleTitleDescription](#user-content-w_IElementStyleTitleDescription) |
2443
+
2444
+ <a name="w_STYLABLE_ELEMENT_STATE" id="w_STYLABLE_ELEMENT_STATE" href="#user-content-w_STYLABLE_ELEMENT_STATE">&nbsp;</a>
2445
+
2446
+ ## STYLABLE\_ELEMENT\_STATE : <code>object</code>
2447
+ Current constant include available states of element for styling
2448
+
2449
+ **Kind**: global constant
2450
+
2451
+ | Param | Type | Default | Description |
2452
+ | --- | --- | --- | --- |
2453
+ | ERROR | <code>string</code> | <code>&quot;error&quot;</code> | client|server validation. This state applies to: input |
2454
+ | FOCUS | <code>string</code> | <code>&quot;focus&quot;</code> | focus. This state applies to: input |
2455
+ | HOVER | <code>string</code> | <code>&quot;hover&quot;</code> | focus. This state applies to: submit_button |
2456
+
2457
+ <a name="w_CARD_VALIDATORS" id="w_CARD_VALIDATORS" href="#user-content-w_CARD_VALIDATORS">&nbsp;</a>
2458
+
2459
+ ## CARD\_VALIDATORS : <code>Record.&lt;string, string&gt;</code>
2460
+ List of available form field validators dedicated to cards and their definition
2461
+
2462
+ **Kind**: global constant
2463
+
2464
+ | Param | Type | Default | Description |
2465
+ | --- | --- | --- | --- |
2466
+ | CVV | <code>string</code> | <code>&quot;cardCvvValidation&quot;</code> | Asserts that CVV contains zero or more digits and is a number |
2467
+ | EXPIRY_DATE | <code>string</code> | <code>&quot;expireDateValidation&quot;</code> | Asserts value is a date in the future with format MM/YY |
2468
+ | HOLDER_NAME | <code>string</code> | <code>&quot;cardHoldernameValidation&quot;</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) |
2469
+ | NUMBER | <code>string</code> | <code>&quot;cardNumberValidation&quot;</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 |
2470
+ | PIN | <code>string</code> | <code>&quot;cardPinValidation&quot;</code> | Asserts the value is a number with exactly 4 digits |
2471
+
2472
+ <a name="w_GENERIC_VALIDATORS" id="w_GENERIC_VALIDATORS" href="#user-content-w_GENERIC_VALIDATORS">&nbsp;</a>
2473
+
2474
+ ## GENERIC\_VALIDATORS : <code>Record.&lt;string, string&gt;</code>
2475
+ List of available generic form field validators and their definition
2476
+
2477
+ **Kind**: global constant
2478
+
2479
+ | Param | Type | Default | Description |
2480
+ | --- | --- | --- | --- |
2481
+ | REQUIRED | <code>string</code> | <code>&quot;required&quot;</code> | Asserts the input or form field has a value defined truthy value |
2482
+
2483
+ <a name="w_TRIGGER" id="w_TRIGGER" href="#user-content-w_TRIGGER">&nbsp;</a>
2484
+
2485
+ ## TRIGGER : <code>object</code>
2486
+ List of available triggers
2487
+
2488
+ **Kind**: global constant
2489
+
2490
+ | Param | Type | Default |
2491
+ | --- | --- | --- |
2492
+ | SUBMIT_FORM | <code>string</code> | <code>&quot;submit_form&quot;</code> |
2493
+ | CHANGE_TAB | <code>string</code> | <code>&quot;tab&quot;</code> |
2494
+ | HIDE_ELEMENTS | <code>string</code> | <code>&quot;hide_elements&quot;</code> |
2495
+ | SHOW_ELEMENTS | <code>string</code> | <code>&quot;show_elements&quot;</code> |
2496
+ | REFRESH_CHECKOUT | <code>string</code> | <code>&quot;refresh_checkout&quot;</code> |
2497
+ | UPDATE_FORM_VALUES | <code>string</code> | <code>&quot;update_form_values&quot;</code> |
2498
+ | INIT_CHECKOUT | <code>string</code> | <code>&quot;init_checkout&quot;</code> |
2499
+