@bigcommerce/checkout-sdk 1.271.2 → 1.271.3

package/docs/interfaces/FormFields.md

@@ -0,0 +1,29 @@
+[@bigcommerce/checkout-sdk](../README.md) / FormFields
+
+# Interface: FormFields
+
+## Table of contents
+
+### Properties
+
+- [billingAddress](FormFields.md#billingaddress)
+- [customerAccount](FormFields.md#customeraccount)
+- [shippingAddress](FormFields.md#shippingaddress)
+
+## Properties
+
+### billingAddress
+
+• **billingAddress**: [`FormField`](FormField.md)[]
+
+___
+
+### customerAccount
+
+• **customerAccount**: [`FormField`](FormField.md)[]
+
+___
+
+### shippingAddress
+
+• **shippingAddress**: [`FormField`](FormField.md)[]

package/docs/interfaces/GatewayOrderPayment.md

@@ -0,0 +1,108 @@
+[@bigcommerce/checkout-sdk](../README.md) / GatewayOrderPayment
+
+# Interface: GatewayOrderPayment
+
+## Hierarchy
+
+- [`OrderPayment`](OrderPayment.md)
+
+  ↳ **`GatewayOrderPayment`**
+
+## Table of contents
+
+### Properties
+
+- [amount](GatewayOrderPayment.md#amount)
+- [description](GatewayOrderPayment.md#description)
+- [detail](GatewayOrderPayment.md#detail)
+- [gatewayId](GatewayOrderPayment.md#gatewayid)
+- [mandate](GatewayOrderPayment.md#mandate)
+- [methodId](GatewayOrderPayment.md#methodid)
+- [paymentId](GatewayOrderPayment.md#paymentid)
+- [providerId](GatewayOrderPayment.md#providerid)
+
+## Properties
+
+### amount
+
+• **amount**: `number`
+
+#### Inherited from
+
+[OrderPayment](OrderPayment.md).[amount](OrderPayment.md#amount)
+
+___
+
+### description
+
+• **description**: `string`
+
+#### Inherited from
+
+[OrderPayment](OrderPayment.md).[description](OrderPayment.md#description)
+
+___
+
+### detail
+
+• **detail**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `instructions` | `string` |
+| `step` | `string` |
+
+___
+
+### gatewayId
+
+• `Optional` **gatewayId**: `string`
+
+#### Inherited from
+
+[OrderPayment](OrderPayment.md).[gatewayId](OrderPayment.md#gatewayid)
+
+___
+
+### mandate
+
+• `Optional` **mandate**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `id` | `string` |
+| `url?` | `string` |
+
+___
+
+### methodId
+
+• `Optional` **methodId**: `string`
+
+#### Inherited from
+
+[OrderPayment](OrderPayment.md).[methodId](OrderPayment.md#methodid)
+
+___
+
+### paymentId
+
+• `Optional` **paymentId**: `string`
+
+#### Inherited from
+
+[OrderPayment](OrderPayment.md).[paymentId](OrderPayment.md#paymentid)
+
+___
+
+### providerId
+
+• **providerId**: `string`
+
+#### Inherited from
+
+[OrderPayment](OrderPayment.md).[providerId](OrderPayment.md#providerid)

package/docs/interfaces/GiftCertificate.md

@@ -0,0 +1,43 @@
+[@bigcommerce/checkout-sdk](../README.md) / GiftCertificate
+
+# Interface: GiftCertificate
+
+## Table of contents
+
+### Properties
+
+- [balance](GiftCertificate.md#balance)
+- [code](GiftCertificate.md#code)
+- [purchaseDate](GiftCertificate.md#purchasedate)
+- [remaining](GiftCertificate.md#remaining)
+- [used](GiftCertificate.md#used)
+
+## Properties
+
+### balance
+
+• **balance**: `number`
+
+___
+
+### code
+
+• **code**: `string`
+
+___
+
+### purchaseDate
+
+• **purchaseDate**: `string`
+
+___
+
+### remaining
+
+• **remaining**: `number`
+
+___
+
+### used
+
+• **used**: `number`

package/docs/interfaces/GiftCertificateItem.md

@@ -0,0 +1,78 @@
+[@bigcommerce/checkout-sdk](../README.md) / GiftCertificateItem
+
+# Interface: GiftCertificateItem
+
+## Table of contents
+
+### Properties
+
+- [amount](GiftCertificateItem.md#amount)
+- [id](GiftCertificateItem.md#id)
+- [message](GiftCertificateItem.md#message)
+- [name](GiftCertificateItem.md#name)
+- [recipient](GiftCertificateItem.md#recipient)
+- [sender](GiftCertificateItem.md#sender)
+- [taxable](GiftCertificateItem.md#taxable)
+- [theme](GiftCertificateItem.md#theme)
+
+## Properties
+
+### amount
+
+• **amount**: `number`
+
+___
+
+### id
+
+• **id**: `string` \| `number`
+
+___
+
+### message
+
+• **message**: `string`
+
+___
+
+### name
+
+• **name**: `string`
+
+___
+
+### recipient
+
+• **recipient**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `email` | `string` |
+| `name` | `string` |
+
+___
+
+### sender
+
+• **sender**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `email` | `string` |
+| `name` | `string` |
+
+___
+
+### taxable
+
+• **taxable**: `boolean`
+
+___
+
+### theme
+
+• **theme**: `string`

package/docs/interfaces/GiftCertificateOrderPayment.md

@@ -0,0 +1,94 @@
+[@bigcommerce/checkout-sdk](../README.md) / GiftCertificateOrderPayment
+
+# Interface: GiftCertificateOrderPayment
+
+## Hierarchy
+
+- [`OrderPayment`](OrderPayment.md)
+
+  ↳ **`GiftCertificateOrderPayment`**
+
+## Table of contents
+
+### Properties
+
+- [amount](GiftCertificateOrderPayment.md#amount)
+- [description](GiftCertificateOrderPayment.md#description)
+- [detail](GiftCertificateOrderPayment.md#detail)
+- [gatewayId](GiftCertificateOrderPayment.md#gatewayid)
+- [methodId](GiftCertificateOrderPayment.md#methodid)
+- [paymentId](GiftCertificateOrderPayment.md#paymentid)
+- [providerId](GiftCertificateOrderPayment.md#providerid)
+
+## Properties
+
+### amount
+
+• **amount**: `number`
+
+#### Inherited from
+
+[OrderPayment](OrderPayment.md).[amount](OrderPayment.md#amount)
+
+___
+
+### description
+
+• **description**: `string`
+
+#### Inherited from
+
+[OrderPayment](OrderPayment.md).[description](OrderPayment.md#description)
+
+___
+
+### detail
+
+• **detail**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `code` | `string` |
+| `remaining` | `number` |
+
+___
+
+### gatewayId
+
+• `Optional` **gatewayId**: `string`
+
+#### Inherited from
+
+[OrderPayment](OrderPayment.md).[gatewayId](OrderPayment.md#gatewayid)
+
+___
+
+### methodId
+
+• `Optional` **methodId**: `string`
+
+#### Inherited from
+
+[OrderPayment](OrderPayment.md).[methodId](OrderPayment.md#methodid)
+
+___
+
+### paymentId
+
+• `Optional` **paymentId**: `string`
+
+#### Inherited from
+
+[OrderPayment](OrderPayment.md).[paymentId](OrderPayment.md#paymentid)
+
+___
+
+### providerId
+
+• **providerId**: `string`
+
+#### Inherited from
+
+[OrderPayment](OrderPayment.md).[providerId](OrderPayment.md#providerid)

package/docs/interfaces/GooglePayButtonInitializeOptions.md

@@ -0,0 +1,31 @@
+[@bigcommerce/checkout-sdk](../README.md) / GooglePayButtonInitializeOptions
+
+# Interface: GooglePayButtonInitializeOptions
+
+## Table of contents
+
+### Properties
+
+- [buttonColor](GooglePayButtonInitializeOptions.md#buttoncolor)
+- [buttonType](GooglePayButtonInitializeOptions.md#buttontype)
+
+## Properties
+
+### buttonColor
+
+• `Optional` **buttonColor**: [`Default`](../enums/ButtonColor.md#default) \| [`Black`](../enums/ButtonColor.md#black) \| [`White`](../enums/ButtonColor.md#white)
+
+The color of the GooglePay button that will be inserted.
+ black (default): a black button suitable for use on white or light backgrounds.
+ white: a white button suitable for use on colorful backgrounds.
+
+___
+
+### buttonType
+
+• `Optional` **buttonType**: [`Long`](../enums/ButtonType.md#long) \| [`Short`](../enums/ButtonType.md#short)
+
+The size of the GooglePay button that will be inserted.
+ long: "Buy with Google Pay" button (default). A translated button label may appear
+        if a language specified in the viewer's browser matches an available language.
+ short: Google Pay payment button without the "Buy with" text.

package/docs/interfaces/GooglePayCustomerInitializeOptions.md

@@ -0,0 +1,42 @@
+[@bigcommerce/checkout-sdk](../README.md) / GooglePayCustomerInitializeOptions
+
+# Interface: GooglePayCustomerInitializeOptions
+
+## Table of contents
+
+### Properties
+
+- [buttonColor](GooglePayCustomerInitializeOptions.md#buttoncolor)
+- [buttonType](GooglePayCustomerInitializeOptions.md#buttontype)
+- [container](GooglePayCustomerInitializeOptions.md#container)
+
+## Properties
+
+### buttonColor
+
+• `Optional` **buttonColor**: [`Default`](../enums/ButtonColor.md#default) \| [`Black`](../enums/ButtonColor.md#black) \| [`White`](../enums/ButtonColor.md#white)
+
+The color of the GooglePay button that will be inserted.
+ black (default): a black button suitable for use on white or light backgrounds.
+ white: a white button suitable for use on colorful backgrounds.
+
+___
+
+### buttonType
+
+• `Optional` **buttonType**: [`Long`](../enums/ButtonType.md#long) \| [`Short`](../enums/ButtonType.md#short)
+
+The size of the GooglePay button that will be inserted.
+ long: "Buy with Google Pay" button (default). A translated button label may appear
+        if a language specified in the viewer's browser matches an available language.
+ short: Google Pay payment button without the "Buy with" text.
+
+___
+
+### container
+
+• **container**: `string`
+
+This container is used to set an event listener, provide an element ID if you want
+users to be able to launch the GooglePay wallet modal by clicking on a button.
+It should be an HTML element.

package/docs/interfaces/GooglePayPaymentInitializeOptions.md

@@ -0,0 +1,93 @@
+[@bigcommerce/checkout-sdk](../README.md) / GooglePayPaymentInitializeOptions
+
+# Interface: GooglePayPaymentInitializeOptions
+
+A set of options that are required to initialize the GooglePay payment method
+
+If the customer chooses to pay with GooglePay, they will be asked to
+enter their payment details via a modal. You can hook into events emitted by
+the modal by providing the callbacks listed below.
+
+```html
+<!-- This is where the GooglePay button will be inserted -->
+<div id="wallet-button"></div>
+```
+
+```js
+service.initializePayment({
+    // Using GooglePay provided by Braintree as an example
+    methodId: 'googlepaybraintree',
+    googlepaybraintree: {
+        walletButton: 'wallet-button'
+    },
+});
+```
+
+Additional event callbacks can be registered.
+
+```js
+service.initializePayment({
+    methodId: 'googlepaybraintree',
+    googlepaybraintree: {
+        walletButton: 'wallet-button',
+        onError(error) {
+            console.log(error);
+        },
+        onPaymentSelect() {
+            console.log('Selected');
+        },
+    },
+});
+```
+
+## Table of contents
+
+### Properties
+
+- [walletButton](GooglePayPaymentInitializeOptions.md#walletbutton)
+
+### Methods
+
+- [onError](GooglePayPaymentInitializeOptions.md#onerror)
+- [onPaymentSelect](GooglePayPaymentInitializeOptions.md#onpaymentselect)
+
+## Properties
+
+### walletButton
+
+• `Optional` **walletButton**: `string`
+
+This walletButton is used to set an event listener, provide an element ID if you want
+users to be able to launch the GooglePay wallet modal by clicking on a button.
+It should be an HTML element.
+
+## Methods
+
+### onError
+
+▸ `Optional` **onError**(`error`): `void`
+
+A callback that gets called when GooglePay fails to initialize or
+selects a payment option.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `error` | `Error` | The error object describing the failure. |
+
+#### Returns
+
+`void`
+
+___
+
+### onPaymentSelect
+
+▸ `Optional` **onPaymentSelect**(): `void`
+
+A callback that gets called when the customer selects a payment option.
+
+#### Returns
+
+`void`

package/docs/interfaces/HostedCardFieldOptions.md

@@ -0,0 +1,35 @@
+[@bigcommerce/checkout-sdk](../README.md) / HostedCardFieldOptions
+
+# Interface: HostedCardFieldOptions
+
+## Hierarchy
+
+- **`HostedCardFieldOptions`**
+
+  ↳ [`HostedStoredCardFieldOptions`](HostedStoredCardFieldOptions.md)
+
+## Table of contents
+
+### Properties
+
+- [accessibilityLabel](HostedCardFieldOptions.md#accessibilitylabel)
+- [containerId](HostedCardFieldOptions.md#containerid)
+- [placeholder](HostedCardFieldOptions.md#placeholder)
+
+## Properties
+
+### accessibilityLabel
+
+• `Optional` **accessibilityLabel**: `string`
+
+___
+
+### containerId
+
+• **containerId**: `string`
+
+___
+
+### placeholder
+
+• `Optional` **placeholder**: `string`

package/docs/interfaces/HostedCardFieldOptionsMap.md

@@ -0,0 +1,36 @@
+[@bigcommerce/checkout-sdk](../README.md) / HostedCardFieldOptionsMap
+
+# Interface: HostedCardFieldOptionsMap
+
+## Table of contents
+
+### Properties
+
+- [cardCode](HostedCardFieldOptionsMap.md#cardcode)
+- [cardExpiry](HostedCardFieldOptionsMap.md#cardexpiry)
+- [cardName](HostedCardFieldOptionsMap.md#cardname)
+- [cardNumber](HostedCardFieldOptionsMap.md#cardnumber)
+
+## Properties
+
+### cardCode
+
+• `Optional` **cardCode**: [`HostedCardFieldOptions`](HostedCardFieldOptions.md)
+
+___
+
+### cardExpiry
+
+• **cardExpiry**: [`HostedCardFieldOptions`](HostedCardFieldOptions.md)
+
+___
+
+### cardName
+
+• **cardName**: [`HostedCardFieldOptions`](HostedCardFieldOptions.md)
+
+___
+
+### cardNumber
+
+• **cardNumber**: [`HostedCardFieldOptions`](HostedCardFieldOptions.md)

package/docs/interfaces/HostedFieldStylesMap.md

@@ -0,0 +1,29 @@
+[@bigcommerce/checkout-sdk](../README.md) / HostedFieldStylesMap
+
+# Interface: HostedFieldStylesMap
+
+## Table of contents
+
+### Properties
+
+- [default](HostedFieldStylesMap.md#default)
+- [error](HostedFieldStylesMap.md#error)
+- [focus](HostedFieldStylesMap.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"``\>\>