@bigcommerce/checkout-sdk 1.308.1 → 1.308.2

package/docs/interfaces/internal_.PaymentMethod.md

@@ -0,0 +1,100 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / PaymentMethod
+
+# Interface: PaymentMethod<T\>
+
+[<internal>](../modules/internal_.md).PaymentMethod
+
+## Type parameters
+
+| Name | Type |
+| :------ | :------ |
+| `T` | `any` |
+
+## Table of contents
+
+### Properties
+
+- [clientToken](internal_.PaymentMethod.md#clienttoken)
+- [config](internal_.PaymentMethod.md#config)
+- [gateway](internal_.PaymentMethod.md#gateway)
+- [id](internal_.PaymentMethod.md#id)
+- [initializationData](internal_.PaymentMethod.md#initializationdata)
+- [initializationStrategy](internal_.PaymentMethod.md#initializationstrategy)
+- [logoUrl](internal_.PaymentMethod.md#logourl)
+- [method](internal_.PaymentMethod.md#method)
+- [nonce](internal_.PaymentMethod.md#nonce)
+- [returnUrl](internal_.PaymentMethod.md#returnurl)
+- [supportedCards](internal_.PaymentMethod.md#supportedcards)
+- [type](internal_.PaymentMethod.md#type)
+
+## Properties
+
+### clientToken
+
+• `Optional` **clientToken**: `string`
+
+___
+
+### config
+
+• **config**: [`PaymentMethodConfig`](internal_.PaymentMethodConfig.md)
+
+___
+
+### gateway
+
+• `Optional` **gateway**: `string`
+
+___
+
+### id
+
+• **id**: `string`
+
+___
+
+### initializationData
+
+• `Optional` **initializationData**: `T`
+
+___
+
+### initializationStrategy
+
+• `Optional` **initializationStrategy**: [`InitializationStrategy`](internal_.InitializationStrategy.md)
+
+___
+
+### logoUrl
+
+• `Optional` **logoUrl**: `string`
+
+___
+
+### method
+
+• **method**: `string`
+
+___
+
+### nonce
+
+• `Optional` **nonce**: `string`
+
+___
+
+### returnUrl
+
+• `Optional` **returnUrl**: `string`
+
+___
+
+### supportedCards
+
+• **supportedCards**: `string`[]
+
+___
+
+### type
+
+• **type**: `string`

package/docs/interfaces/internal_.PaymentMethodConfig.md

@@ -0,0 +1,122 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / PaymentMethodConfig
+
+# Interface: PaymentMethodConfig
+
+[<internal>](../modules/internal_.md).PaymentMethodConfig
+
+## Table of contents
+
+### Properties
+
+- [cardCode](internal_.PaymentMethodConfig.md#cardcode)
+- [displayName](internal_.PaymentMethodConfig.md#displayname)
+- [enablePaypal](internal_.PaymentMethodConfig.md#enablepaypal)
+- [hasDefaultStoredInstrument](internal_.PaymentMethodConfig.md#hasdefaultstoredinstrument)
+- [helpText](internal_.PaymentMethodConfig.md#helptext)
+- [is3dsEnabled](internal_.PaymentMethodConfig.md#is3dsenabled)
+- [isHostedFormEnabled](internal_.PaymentMethodConfig.md#ishostedformenabled)
+- [isVaultingCvvEnabled](internal_.PaymentMethodConfig.md#isvaultingcvvenabled)
+- [isVaultingEnabled](internal_.PaymentMethodConfig.md#isvaultingenabled)
+- [isVisaCheckoutEnabled](internal_.PaymentMethodConfig.md#isvisacheckoutenabled)
+- [logo](internal_.PaymentMethodConfig.md#logo)
+- [merchantId](internal_.PaymentMethodConfig.md#merchantid)
+- [redirectUrl](internal_.PaymentMethodConfig.md#redirecturl)
+- [requireCustomerCode](internal_.PaymentMethodConfig.md#requirecustomercode)
+- [returnUrl](internal_.PaymentMethodConfig.md#returnurl)
+- [testMode](internal_.PaymentMethodConfig.md#testmode)
+
+## Properties
+
+### cardCode
+
+• `Optional` **cardCode**: `boolean`
+
+___
+
+### displayName
+
+• `Optional` **displayName**: `string`
+
+___
+
+### enablePaypal
+
+• `Optional` **enablePaypal**: `boolean`
+
+___
+
+### hasDefaultStoredInstrument
+
+• `Optional` **hasDefaultStoredInstrument**: `boolean`
+
+___
+
+### helpText
+
+• `Optional` **helpText**: `string`
+
+___
+
+### is3dsEnabled
+
+• `Optional` **is3dsEnabled**: `boolean`
+
+___
+
+### isHostedFormEnabled
+
+• `Optional` **isHostedFormEnabled**: `boolean`
+
+___
+
+### isVaultingCvvEnabled
+
+• `Optional` **isVaultingCvvEnabled**: `boolean`
+
+___
+
+### isVaultingEnabled
+
+• `Optional` **isVaultingEnabled**: `boolean`
+
+___
+
+### isVisaCheckoutEnabled
+
+• `Optional` **isVisaCheckoutEnabled**: `boolean`
+
+___
+
+### logo
+
+• `Optional` **logo**: `string`
+
+___
+
+### merchantId
+
+• `Optional` **merchantId**: `string`
+
+___
+
+### redirectUrl
+
+• `Optional` **redirectUrl**: `string`
+
+___
+
+### requireCustomerCode
+
+• `Optional` **requireCustomerCode**: `boolean`
+
+___
+
+### returnUrl
+
+• `Optional` **returnUrl**: `string`
+
+___
+
+### testMode
+
+• `Optional` **testMode**: `boolean`

package/docs/interfaces/internal_.PaymentRequestOptions.md

@@ -0,0 +1,69 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / PaymentRequestOptions
+
+# Interface: PaymentRequestOptions
+
+[<internal>](../modules/internal_.md).PaymentRequestOptions
+
+The set of options for configuring any requests related to the payment step of
+the current checkout flow.
+
+## Hierarchy
+
+- [`RequestOptions`](internal_.RequestOptions.md)
+
+  ↳ **`PaymentRequestOptions`**
+
+  ↳↳ [`BasePaymentInitializeOptions`](internal_.BasePaymentInitializeOptions.md)
+
+## Table of contents
+
+### Properties
+
+- [gatewayId](internal_.PaymentRequestOptions.md#gatewayid)
+- [methodId](internal_.PaymentRequestOptions.md#methodid)
+- [params](internal_.PaymentRequestOptions.md#params)
+- [timeout](internal_.PaymentRequestOptions.md#timeout)
+
+## Properties
+
+### gatewayId
+
+• `Optional` **gatewayId**: `string`
+
+The identifier of the payment provider providing the payment method. This
+option is only required if the provider offers multiple payment options.
+i.e.: Adyen and Klarna.
+
+___
+
+### methodId
+
+• **methodId**: `string`
+
+The identifier of the payment method.
+
+___
+
+### params
+
+• `Optional` **params**: `Object`
+
+The parameters of the request, if required.
+
+#### Inherited from
+
+[RequestOptions](internal_.RequestOptions.md).[params](internal_.RequestOptions.md#params)
+
+___
+
+### timeout
+
+• `Optional` **timeout**: `default`
+
+Provide this option if you want to cancel or time out the request. If the
+timeout object completes before the request, the request will be
+cancelled.
+
+#### Inherited from
+
+[RequestOptions](internal_.RequestOptions.md).[timeout](internal_.RequestOptions.md#timeout)

package/docs/interfaces/internal_.PaymentSettings.md

@@ -0,0 +1,24 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / PaymentSettings
+
+# Interface: PaymentSettings
+
+[<internal>](../modules/internal_.md).PaymentSettings
+
+## Table of contents
+
+### Properties
+
+- [bigpayBaseUrl](internal_.PaymentSettings.md#bigpaybaseurl)
+- [clientSidePaymentProviders](internal_.PaymentSettings.md#clientsidepaymentproviders)
+
+## Properties
+
+### bigpayBaseUrl
+
+• **bigpayBaseUrl**: `string`
+
+___
+
+### clientSidePaymentProviders
+
+• **clientSidePaymentProviders**: `string`[]

package/docs/interfaces/internal_.PaypalCommerceCreditCardPaymentInitializeOptions.md

@@ -0,0 +1,92 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / PaypalCommerceCreditCardPaymentInitializeOptions
+
+# Interface: PaypalCommerceCreditCardPaymentInitializeOptions
+
+[<internal>](../modules/internal_.md).PaypalCommerceCreditCardPaymentInitializeOptions
+
+A set of options that are required to initialize the PayPal Commerce payment
+method for presenting its credit card form.
+
+```html
+<!-- These containers are where the hosted (iframed) credit card fields will be inserted -->
+<div id="card-number"></div>
+<div id="card-name"></div>
+<div id="card-expiry"></div>
+<div id="card-code"></div>
+```
+
+```js
+service.initializePayment({
+    methodId: 'paypalcommerce',
+    paypalcommerce: {
+        form: {
+            fields: {
+                cardNumber: { containerId: 'card-number' },
+                cardName: { containerId: 'card-name' },
+                cardExpiry: { containerId: 'card-expiry' },
+                cardCode: { containerId: 'card-code' },
+            },
+        },
+    },
+});
+```
+
+Additional options can be passed in to customize the fields and register
+event callbacks.
+
+```js
+service.initializePayment({
+    methodId: 'paypalcommerce',
+    creditCard: {
+        form: {
+            fields: {
+                cardNumber: { containerId: 'card-number', placeholder: 'Number of card' },
+                cardName: { containerId: 'card-name', placeholder: 'Name of card' },
+                cardExpiry: { containerId: 'card-expiry', placeholder: 'Expiry of card' },
+                cardCode: { containerId: 'card-code', placeholder: 'Code of card' },
+            },
+            styles: {
+                default: {
+                    color: '#000',
+                },
+                error: {
+                    color: '#f00',
+                },
+                focus: {
+                    color: '#0f0',
+                },
+            },
+            onBlur({ fieldType }) {
+                console.log(fieldType);
+            },
+            onFocus({ fieldType }) {
+                console.log(fieldType);
+            },
+            onEnter({ fieldType }) {
+                console.log(fieldType);
+            },
+            onCardTypeChange({ cardType }) {
+                console.log(cardType);
+            },
+            onValidate({ errors, isValid }) {
+                console.log(errors);
+                console.log(isValid);
+            },
+        },
+    },
+});
+```
+
+## Table of contents
+
+### Properties
+
+- [form](internal_.PaypalCommerceCreditCardPaymentInitializeOptions.md#form)
+
+## Properties
+
+### form
+
+• **form**: [`PaypalCommerceFormOptions`](internal_.PaypalCommerceFormOptions.md)
+
+The form is data for Credit Card Form

package/docs/interfaces/internal_.PaypalCommerceFormFieldCardTypeChangeEventData.md

@@ -0,0 +1,17 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / PaypalCommerceFormFieldCardTypeChangeEventData
+
+# Interface: PaypalCommerceFormFieldCardTypeChangeEventData
+
+[<internal>](../modules/internal_.md).PaypalCommerceFormFieldCardTypeChangeEventData
+
+## Table of contents
+
+### Properties
+
+- [cardType](internal_.PaypalCommerceFormFieldCardTypeChangeEventData.md#cardtype)
+
+## Properties
+
+### cardType
+
+• `Optional` **cardType**: `string`

package/docs/interfaces/internal_.PaypalCommerceFormFieldKeyboardEventData.md

@@ -0,0 +1,17 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / PaypalCommerceFormFieldKeyboardEventData
+
+# Interface: PaypalCommerceFormFieldKeyboardEventData
+
+[<internal>](../modules/internal_.md).PaypalCommerceFormFieldKeyboardEventData
+
+## Table of contents
+
+### Properties
+
+- [fieldType](internal_.PaypalCommerceFormFieldKeyboardEventData.md#fieldtype)
+
+## Properties
+
+### fieldType
+
+• **fieldType**: `string`

package/docs/interfaces/internal_.PaypalCommerceFormFieldOptions.md

@@ -0,0 +1,30 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / PaypalCommerceFormFieldOptions
+
+# Interface: PaypalCommerceFormFieldOptions
+
+[<internal>](../modules/internal_.md).PaypalCommerceFormFieldOptions
+
+## Hierarchy
+
+- **`PaypalCommerceFormFieldOptions`**
+
+  ↳ [`PaypalCommerceStoredCardFieldOptions`](internal_.PaypalCommerceStoredCardFieldOptions.md)
+
+## Table of contents
+
+### Properties
+
+- [containerId](internal_.PaypalCommerceFormFieldOptions.md#containerid)
+- [placeholder](internal_.PaypalCommerceFormFieldOptions.md#placeholder)
+
+## Properties
+
+### containerId
+
+• **containerId**: `string`
+
+___
+
+### placeholder
+
+• `Optional` **placeholder**: `string`

package/docs/interfaces/internal_.PaypalCommerceFormFieldStylesMap.md

@@ -0,0 +1,31 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / PaypalCommerceFormFieldStylesMap
+
+# Interface: PaypalCommerceFormFieldStylesMap
+
+[<internal>](../modules/internal_.md).PaypalCommerceFormFieldStylesMap
+
+## Table of contents
+
+### Properties
+
+- [default](internal_.PaypalCommerceFormFieldStylesMap.md#default)
+- [error](internal_.PaypalCommerceFormFieldStylesMap.md#error)
+- [focus](internal_.PaypalCommerceFormFieldStylesMap.md#focus)
+
+## Properties
+
+### default
+
+• `Optional` **default**: `Partial`<`Pick`<`CSSStyleDeclaration`, ``"color"`` \| ``"fontFamily"`` \| ``"fontSize"`` \| ``"fontWeight"``\>\>
+
+___
+
+### error
+
+• `Optional` **error**: `Partial`<`Pick`<`CSSStyleDeclaration`, ``"color"`` \| ``"fontFamily"`` \| ``"fontSize"`` \| ``"fontWeight"``\>\>
+
+___
+
+### focus
+
+• `Optional` **focus**: `Partial`<`Pick`<`CSSStyleDeclaration`, ``"color"`` \| ``"fontFamily"`` \| ``"fontSize"`` \| ``"fontWeight"``\>\>

package/docs/interfaces/internal_.PaypalCommerceFormFieldValidateErrorData.md

@@ -0,0 +1,31 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / PaypalCommerceFormFieldValidateErrorData
+
+# Interface: PaypalCommerceFormFieldValidateErrorData
+
+[<internal>](../modules/internal_.md).PaypalCommerceFormFieldValidateErrorData
+
+## Table of contents
+
+### Properties
+
+- [fieldType](internal_.PaypalCommerceFormFieldValidateErrorData.md#fieldtype)
+- [message](internal_.PaypalCommerceFormFieldValidateErrorData.md#message)
+- [type](internal_.PaypalCommerceFormFieldValidateErrorData.md#type)
+
+## Properties
+
+### fieldType
+
+• **fieldType**: `string`
+
+___
+
+### message
+
+• **message**: `string`
+
+___
+
+### type
+
+• **type**: `string`

package/docs/interfaces/internal_.PaypalCommerceFormFieldValidateEventData.md

@@ -0,0 +1,35 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / PaypalCommerceFormFieldValidateEventData
+
+# Interface: PaypalCommerceFormFieldValidateEventData
+
+[<internal>](../modules/internal_.md).PaypalCommerceFormFieldValidateEventData
+
+## Table of contents
+
+### Properties
+
+- [errors](internal_.PaypalCommerceFormFieldValidateEventData.md#errors)
+- [isValid](internal_.PaypalCommerceFormFieldValidateEventData.md#isvalid)
+
+## Properties
+
+### errors
+
+• **errors**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `cardCode?` | [`PaypalCommerceFormFieldValidateErrorData`](internal_.PaypalCommerceFormFieldValidateErrorData.md)[] |
+| `cardCodeVerification?` | [`PaypalCommerceFormFieldValidateErrorData`](internal_.PaypalCommerceFormFieldValidateErrorData.md)[] |
+| `cardExpiry?` | [`PaypalCommerceFormFieldValidateErrorData`](internal_.PaypalCommerceFormFieldValidateErrorData.md)[] |
+| `cardName?` | [`PaypalCommerceFormFieldValidateErrorData`](internal_.PaypalCommerceFormFieldValidateErrorData.md)[] |
+| `cardNumber?` | [`PaypalCommerceFormFieldValidateErrorData`](internal_.PaypalCommerceFormFieldValidateErrorData.md)[] |
+| `cardNumberVerification?` | [`PaypalCommerceFormFieldValidateErrorData`](internal_.PaypalCommerceFormFieldValidateErrorData.md)[] |
+
+___
+
+### isValid
+
+• **isValid**: `boolean`

package/docs/interfaces/internal_.PaypalCommerceFormFieldsMap.md

@@ -0,0 +1,38 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / PaypalCommerceFormFieldsMap
+
+# Interface: PaypalCommerceFormFieldsMap
+
+[<internal>](../modules/internal_.md).PaypalCommerceFormFieldsMap
+
+## Table of contents
+
+### Properties
+
+- [cardCode](internal_.PaypalCommerceFormFieldsMap.md#cardcode)
+- [cardExpiry](internal_.PaypalCommerceFormFieldsMap.md#cardexpiry)
+- [cardName](internal_.PaypalCommerceFormFieldsMap.md#cardname)
+- [cardNumber](internal_.PaypalCommerceFormFieldsMap.md#cardnumber)
+
+## Properties
+
+### cardCode
+
+• `Optional` **cardCode**: [`PaypalCommerceFormFieldOptions`](internal_.PaypalCommerceFormFieldOptions.md)
+
+___
+
+### cardExpiry
+
+• **cardExpiry**: [`PaypalCommerceFormFieldOptions`](internal_.PaypalCommerceFormFieldOptions.md)
+
+___
+
+### cardName
+
+• **cardName**: [`PaypalCommerceFormFieldOptions`](internal_.PaypalCommerceFormFieldOptions.md)
+
+___
+
+### cardNumber
+
+• **cardNumber**: [`PaypalCommerceFormFieldOptions`](internal_.PaypalCommerceFormFieldOptions.md)