@bigcommerce/checkout-sdk 1.308.1 → 1.308.2

package/docs/interfaces/internal_.MasterpassPaymentInitializeOptions.md

@@ -0,0 +1,37 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / MasterpassPaymentInitializeOptions
+
+# Interface: MasterpassPaymentInitializeOptions
+
+[<internal>](../modules/internal_.md).MasterpassPaymentInitializeOptions
+
+A set of options that are required to initialize the Masterpass payment method.
+
+```html
+<!-- This is where the Masterpass button will be inserted -->
+<div id="wallet-button"></div>
+```
+
+```js
+service.initializePayment({
+    methodId: 'masterpass',
+    masterpass: {
+        walletButton: 'wallet-button'
+    },
+});
+```
+
+## Table of contents
+
+### Properties
+
+- [walletButton](internal_.MasterpassPaymentInitializeOptions.md#walletbutton)
+
+## 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 ChasePay wallet modal by clicking on a button.
+It should be an HTML element.

package/docs/interfaces/internal_.MolliePaymentInitializeOptions.md

@@ -0,0 +1,126 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / MolliePaymentInitializeOptions
+
+# Interface: MolliePaymentInitializeOptions
+
+[<internal>](../modules/internal_.md).MolliePaymentInitializeOptions
+
+A set of options that are required to initialize the Mollie payment method.
+
+Once Mollie payment is initialized, credit card form fields are provided by the
+payment provider as IFrames, these will be inserted into the current page. These
+options provide a location and styling for each of the form fields.
+
+```js
+service.initializePayment({
+     methodId: 'mollie',
+     mollie: {
+         containerId: 'container',
+         cardNumberId: '',
+         cardHolderId: '',
+         cardCvcId: '',
+         cardExpiryId: '',
+         styles : {
+             base: {
+                 color: '#fff'
+             }
+         }
+     }
+});
+```
+
+## Table of contents
+
+### Properties
+
+- [cardCvcId](internal_.MolliePaymentInitializeOptions.md#cardcvcid)
+- [cardExpiryId](internal_.MolliePaymentInitializeOptions.md#cardexpiryid)
+- [cardHolderId](internal_.MolliePaymentInitializeOptions.md#cardholderid)
+- [cardNumberId](internal_.MolliePaymentInitializeOptions.md#cardnumberid)
+- [containerId](internal_.MolliePaymentInitializeOptions.md#containerid)
+- [form](internal_.MolliePaymentInitializeOptions.md#form)
+- [styles](internal_.MolliePaymentInitializeOptions.md#styles)
+- [unsupportedMethodMessage](internal_.MolliePaymentInitializeOptions.md#unsupportedmethodmessage)
+
+### Methods
+
+- [disableButton](internal_.MolliePaymentInitializeOptions.md#disablebutton)
+
+## Properties
+
+### cardCvcId
+
+• **cardCvcId**: `string`
+
+The location to insert Mollie Component
+
+___
+
+### cardExpiryId
+
+• **cardExpiryId**: `string`
+
+The location to insert Mollie Component
+
+___
+
+### cardHolderId
+
+• **cardHolderId**: `string`
+
+The location to insert Mollie Component
+
+___
+
+### cardNumberId
+
+• **cardNumberId**: `string`
+
+The location to insert Mollie Component
+
+___
+
+### containerId
+
+• `Optional` **containerId**: `string`
+
+ContainerId is use in Mollie for determined either its showing or not the
+container, because when Mollie has Vaulted Instruments it gets hide,
+and shows an error because can't mount Provider Components
+
+___
+
+### form
+
+• `Optional` **form**: [`HostedFormOptions`](internal_.HostedFormOptions.md)
+
+Hosted Form Validation Options
+
+___
+
+### styles
+
+• **styles**: `object`
+
+A set of styles required for the mollie components
+
+___
+
+### unsupportedMethodMessage
+
+• `Optional` **unsupportedMethodMessage**: `string`
+
+## Methods
+
+### disableButton
+
+▸ **disableButton**(`disabled`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `disabled` | `boolean` |
+
+#### Returns
+
+`void`

package/docs/interfaces/internal_.MonerisPaymentInitializeOptions.md

@@ -0,0 +1,59 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / MonerisPaymentInitializeOptions
+
+# Interface: MonerisPaymentInitializeOptions
+
+[<internal>](../modules/internal_.md).MonerisPaymentInitializeOptions
+
+A set of options that are required to initialize the Moneris payment method.
+
+Once Moneris payment is initialized, a credit card payment form is provided by the
+payment provider as an IFrame, it will be inserted into the current page. These
+options provide a location and styling for the payment form.
+
+```js
+service.initializePayment({
+     methodId: 'moneris',
+     moneris: {
+         containerId: 'container',
+         style : {
+             cssBody: 'background:white;';
+             cssTextbox: 'border-width:2px;';
+             cssTextboxCardNumber: 'width:140px;';
+             cssTextboxExpiryDate: 'width:40px;';
+             cssTextboxCVV: 'width:40px';
+         }
+     }
+});
+```
+
+## Table of contents
+
+### Properties
+
+- [containerId](internal_.MonerisPaymentInitializeOptions.md#containerid)
+- [form](internal_.MonerisPaymentInitializeOptions.md#form)
+- [style](internal_.MonerisPaymentInitializeOptions.md#style)
+
+## Properties
+
+### containerId
+
+• **containerId**: `string`
+
+The ID of a container where the Moneris iframe component should be mounted
+
+___
+
+### form
+
+• `Optional` **form**: [`HostedFormOptions`](internal_.HostedFormOptions.md)
+
+Hosted Form Validation Options
+
+___
+
+### style
+
+• `Optional` **style**: [`MonerisStylingProps`](internal_.MonerisStylingProps.md)
+
+The styling props to apply to the iframe component

package/docs/interfaces/internal_.MonerisStylingProps.md

@@ -0,0 +1,82 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / MonerisStylingProps
+
+# Interface: MonerisStylingProps
+
+[<internal>](../modules/internal_.md).MonerisStylingProps
+
+A set of stringified CSS to apply to Moneris' IFrame fields.
+CSS attributes should be converted to string.
+Please note that ClassNames are not supported.
+
+IE:
+```js
+{
+     cssBody: 'background:white;';
+     cssTextbox: 'border-width:2px;';
+     cssTextboxCardNumber: 'width:140px;';
+     cssTextboxExpiryDate: 'width:40px;';
+     cssTextboxCVV: 'width:40px;';
+}
+```
+
+When using several attributes use semicolon to separate each one.
+IE: 'background:white;width:40px;'
+
+## Table of contents
+
+### Properties
+
+- [cssBody](internal_.MonerisStylingProps.md#cssbody)
+- [cssInputLabel](internal_.MonerisStylingProps.md#cssinputlabel)
+- [cssTextbox](internal_.MonerisStylingProps.md#csstextbox)
+- [cssTextboxCVV](internal_.MonerisStylingProps.md#csstextboxcvv)
+- [cssTextboxCardNumber](internal_.MonerisStylingProps.md#csstextboxcardnumber)
+- [cssTextboxExpiryDate](internal_.MonerisStylingProps.md#csstextboxexpirydate)
+
+## Properties
+
+### cssBody
+
+• `Optional` **cssBody**: `string`
+
+Stringified CSS to apply to the body of the IFrame.
+
+___
+
+### cssInputLabel
+
+• `Optional` **cssInputLabel**: `string`
+
+Stringified CSS to apply to input labels
+
+___
+
+### cssTextbox
+
+• `Optional` **cssTextbox**: `string`
+
+Stringified CSS to apply to each of input fields.
+
+___
+
+### cssTextboxCVV
+
+• `Optional` **cssTextboxCVV**: `string`
+
+Stringified CSS to apply to the card's CVV field.
+
+___
+
+### cssTextboxCardNumber
+
+• `Optional` **cssTextboxCardNumber**: `string`
+
+Stringified CSS to apply to the card's number field.
+
+___
+
+### cssTextboxExpiryDate
+
+• `Optional` **cssTextboxExpiryDate**: `string`
+
+Stringified CSS to apply to the card's expiry field.

package/docs/interfaces/internal_.NonceGenerationError.md

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

package/docs/interfaces/internal_.NonceInstrument.md

@@ -0,0 +1,38 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / NonceInstrument
+
+# Interface: NonceInstrument
+
+[<internal>](../modules/internal_.md).NonceInstrument
+
+## Table of contents
+
+### Properties
+
+- [deviceSessionId](internal_.NonceInstrument.md#devicesessionid)
+- [nonce](internal_.NonceInstrument.md#nonce)
+- [shouldSaveInstrument](internal_.NonceInstrument.md#shouldsaveinstrument)
+- [shouldSetAsDefaultInstrument](internal_.NonceInstrument.md#shouldsetasdefaultinstrument)
+
+## Properties
+
+### deviceSessionId
+
+• `Optional` **deviceSessionId**: `string`
+
+___
+
+### nonce
+
+• **nonce**: `string`
+
+___
+
+### shouldSaveInstrument
+
+• `Optional` **shouldSaveInstrument**: `boolean`
+
+___
+
+### shouldSetAsDefaultInstrument
+
+• `Optional` **shouldSetAsDefaultInstrument**: `boolean`

package/docs/interfaces/internal_.Option_2.md

@@ -0,0 +1,24 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / Option\_2
+
+# Interface: Option\_2
+
+[<internal>](../modules/internal_.md).Option_2
+
+## Table of contents
+
+### Properties
+
+- [itemQuantities](internal_.Option_2.md#itemquantities)
+- [pickupMethod](internal_.Option_2.md#pickupmethod)
+
+## Properties
+
+### itemQuantities
+
+• **itemQuantities**: [`Item`](internal_.Item.md)
+
+___
+
+### pickupMethod
+
+• **pickupMethod**: [`PickupMethod`](internal_.PickupMethod.md)

package/docs/interfaces/internal_.OptionsResponse.md

@@ -0,0 +1,79 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / OptionsResponse
+
+# Interface: OptionsResponse
+
+[<internal>](../modules/internal_.md).OptionsResponse
+
+When creating your Drop-in instance, you can specify options to trigger different features or functionality.
+https://docs.digitalriver.com/digital-river-api/payment-integrations-1/drop-in/drop-in-integration-guide#drop-in-options
+
+## Table of contents
+
+### Properties
+
+- [button](internal_.OptionsResponse.md#button)
+- [flow](internal_.OptionsResponse.md#flow)
+- [paymentMethodConfiguration](internal_.OptionsResponse.md#paymentmethodconfiguration)
+- [showComplianceSection](internal_.OptionsResponse.md#showcompliancesection)
+- [showSavePaymentAgreement](internal_.OptionsResponse.md#showsavepaymentagreement)
+- [showTermsOfSaleDisclosure](internal_.OptionsResponse.md#showtermsofsaledisclosure)
+- [usage](internal_.OptionsResponse.md#usage)
+
+## Properties
+
+### button
+
+• `Optional` **button**: [`ButtonResponse`](internal_.ButtonResponse.md)
+
+Use this option to customize the text of the Drop-in button.
+
+___
+
+### flow
+
+• `Optional` **flow**: `string`
+
+Use this option if you are using Drop-in within a standard checkout flow. Example Value: "checkout"
+
+___
+
+### paymentMethodConfiguration
+
+• `Optional` **paymentMethodConfiguration**: [`BaseElementOptions`](internal_.BaseElementOptions.md)
+
+Additional configuration details for drop-in.
+
+___
+
+### showComplianceSection
+
+• `Optional` **showComplianceSection**: `boolean`
+
+Will show a localized compliance link section as part of Drop-in. This is an important piece for accessing the Digital River business model.
+
+___
+
+### showSavePaymentAgreement
+
+• `Optional` **showSavePaymentAgreement**: `boolean`
+
+When enabled, presents the customer with an option to save their payment details for future use within Drop-in.
+Enabling this feature will show the appropriate check boxes and localized disclosure statements and facilitate
+any necessary Strong Customer Authentication.
+If disabled, Drop-in will not present the customer with an option to save their payment details.
+
+___
+
+### showTermsOfSaleDisclosure
+
+• `Optional` **showTermsOfSaleDisclosure**: `boolean`
+
+Use this option to show the required terms of sale disclosure. These localized terms automatically update if recurring products are purchased.
+
+___
+
+### usage
+
+• `Optional` **usage**: `string`
+
+Use this option to specify the future use of a source.

package/docs/interfaces/internal_.OpyPaymentInitializeOptions.md

@@ -0,0 +1,40 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / OpyPaymentInitializeOptions
+
+# Interface: OpyPaymentInitializeOptions
+
+[<internal>](../modules/internal_.md).OpyPaymentInitializeOptions
+
+A set of options that are required to initialize the payment step of
+checkout in order to support Opy.
+
+When Opy is initialized, a widget will be inserted into the DOM. The
+widget will open a modal that will show more information about Opy when
+clicking it.
+
+**`example`** ```html
+<!-- This is where the Opy widget will be inserted -->
+<div id="opy-widget"></div>
+```
+
+```js
+service.initializePayment({
+    methodId: 'opy',
+    opy: {
+        containerId: 'opy-widget',
+    },
+});
+```
+
+## Table of contents
+
+### Properties
+
+- [containerId](internal_.OpyPaymentInitializeOptions.md#containerid)
+
+## Properties
+
+### containerId
+
+• **containerId**: `string`
+
+The ID of a container which the payment widget should insert into.