@bigcommerce/checkout-sdk 1.308.2 → 1.308.3

package/docs/interfaces/internal_.DigitalRiverPaymentInitializeOptions.md

@@ -1,148 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / DigitalRiverPaymentInitializeOptions
-
-# Interface: DigitalRiverPaymentInitializeOptions
-
-[<internal>](../modules/internal_.md).DigitalRiverPaymentInitializeOptions
-
-A set of options that are required to initialize the DigitalRiver payment method.
-
-When DigitalRiver is initialized, a widget will be inserted into the DOM. The widget has a list of payment options for the customer to choose from.
-
-```html
-<!-- This is where the widget will be inserted -->
-<div id="container"></div>
-```
-
-```js
-service.initializePayment({
-  methodId: 'digitalriver',
-  digitalriver: {
-      containerId: 'digitalriver-component-field',
-      // Callback for submitting payment form that gets called when a buyer approves DR payment
-      onSubmitForm: () => {
-          // Example function
-          this.submitOrder(
-              {
-                  payment: {methodId: 'digitalriver',}
-              }
-          );
-      },
-      onError: (error) => {
-          console.log(error);
-      },
-  }
-});
-```
-
-Additional options can be passed in to customize the components and register
-event callbacks.
-
-```js
-service.initializePayment({
-  methodId: 'digitalriver',
-  digitalriver: {
-      containerId: 'digitalriver-component-field',
-      configuration: {
-          flow: 'checkout',
-          showSavePaymentAgreement: false,
-          showComplianceSection: true,
-          button: {
-              type: 'submitOrder',
-          },
-          usage: 'unscheduled',
-          showTermsOfSaleDisclosure: true,
-          paymentMethodConfiguration: {
-              classes: {
-                  // these classes are to control styles on BC side
-                  base: 'form-input optimizedCheckout-form-input'
-              },
-          },
-      },
-      // Callback for submitting payment form that gets called when a buyer approves DR payment
-     onSubmitForm: () => {
-          // Example function
-          this.submitOrder(
-              {
-                  payment: {methodId: 'digitalriver',}
-              }
-          );
-      },
-      onError: (error) => {
-          console.log(error);
-      },
-  }
-});
-```
-
-## Table of contents
-
-### Properties
-
-- [configuration](internal_.DigitalRiverPaymentInitializeOptions.md#configuration)
-- [containerId](internal_.DigitalRiverPaymentInitializeOptions.md#containerid)
-
-### Methods
-
-- [onError](internal_.DigitalRiverPaymentInitializeOptions.md#onerror)
-- [onRenderButton](internal_.DigitalRiverPaymentInitializeOptions.md#onrenderbutton)
-- [onSubmitForm](internal_.DigitalRiverPaymentInitializeOptions.md#onsubmitform)
-
-## Properties
-
-### configuration
-
-• **configuration**: [`OptionsResponse`](internal_.OptionsResponse.md)
-
-Create a Configuration object for Drop-in that contains both required and optional values.
-https://docs.digitalriver.com/digital-river-api/payment-integrations-1/drop-in/drop-in-integration-guide#step-5-configure-hydrate
-
-___
-
-### containerId
-
-• **containerId**: `string`
-
-The ID of a container which the Digital River drop in component should be mounted
-
-## Methods
-
-### onError
-
-▸ `Optional` **onError**(`error`): `void`
-
-Callback that gets triggered when an error happens when submitting payment form and contains an object with codes and error messages
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `error` | `Error` |
-
-#### Returns
-
-`void`
-
-___
-
-### onRenderButton
-
-▸ `Optional` **onRenderButton**(): `void`
-
-Callback used to hide the standard submit button which is rendered right after the payment providers.
-
-#### Returns
-
-`void`
-
-___
-
-### onSubmitForm
-
-▸ **onSubmitForm**(): `void`
-
-Callback for submitting payment form that gets called
-when buyer pay with DigitalRiver.
-
-#### Returns
-
-`void`

package/docs/interfaces/internal_.Discount.md

@@ -1,24 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / Discount
-
-# Interface: Discount
-
-[<internal>](../modules/internal_.md).Discount
-
-## Table of contents
-
-### Properties
-
-- [discountedAmount](internal_.Discount.md#discountedamount)
-- [id](internal_.Discount.md#id)
-
-## Properties
-
-### discountedAmount
-
-• **discountedAmount**: `number`
-
-___
-
-### id
-
-• **id**: `string`

package/docs/interfaces/internal_.DisplaySettings.md

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

package/docs/interfaces/internal_.EmbeddedCheckoutCompleteEvent.md

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

package/docs/interfaces/internal_.EmbeddedCheckoutError.md

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

package/docs/interfaces/internal_.EmbeddedCheckoutErrorEvent.md

@@ -1,24 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / EmbeddedCheckoutErrorEvent
-
-# Interface: EmbeddedCheckoutErrorEvent
-
-[<internal>](../modules/internal_.md).EmbeddedCheckoutErrorEvent
-
-## Table of contents
-
-### Properties
-
-- [payload](internal_.EmbeddedCheckoutErrorEvent.md#payload)
-- [type](internal_.EmbeddedCheckoutErrorEvent.md#type)
-
-## Properties
-
-### payload
-
-• **payload**: [`EmbeddedCheckoutError`](internal_.EmbeddedCheckoutError.md)
-
-___
-
-### type
-
-• **type**: [`CheckoutError`](../modules/internal_.md#checkouterror)

package/docs/interfaces/internal_.EmbeddedCheckoutFrameErrorEvent.md

@@ -1,24 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / EmbeddedCheckoutFrameErrorEvent
-
-# Interface: EmbeddedCheckoutFrameErrorEvent
-
-[<internal>](../modules/internal_.md).EmbeddedCheckoutFrameErrorEvent
-
-## Table of contents
-
-### Properties
-
-- [payload](internal_.EmbeddedCheckoutFrameErrorEvent.md#payload)
-- [type](internal_.EmbeddedCheckoutFrameErrorEvent.md#type)
-
-## Properties
-
-### payload
-
-• **payload**: [`EmbeddedCheckoutError`](internal_.EmbeddedCheckoutError.md)
-
-___
-
-### type
-
-• **type**: [`FrameError`](../modules/internal_.md#frameerror)

package/docs/interfaces/internal_.EmbeddedCheckoutFrameLoadedEvent.md

@@ -1,24 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / EmbeddedCheckoutFrameLoadedEvent
-
-# Interface: EmbeddedCheckoutFrameLoadedEvent
-
-[<internal>](../modules/internal_.md).EmbeddedCheckoutFrameLoadedEvent
-
-## Table of contents
-
-### Properties
-
-- [payload](internal_.EmbeddedCheckoutFrameLoadedEvent.md#payload)
-- [type](internal_.EmbeddedCheckoutFrameLoadedEvent.md#type)
-
-## Properties
-
-### payload
-
-• `Optional` **payload**: [`EmbeddedContentOptions`](internal_.EmbeddedContentOptions.md)
-
-___
-
-### type
-
-• **type**: [`FrameLoaded`](../modules/internal_.md#frameloaded)

package/docs/interfaces/internal_.EmbeddedCheckoutLoadedEvent.md

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

package/docs/interfaces/internal_.EmbeddedCheckoutOptions.md

@@ -1,136 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / EmbeddedCheckoutOptions
-
-# Interface: EmbeddedCheckoutOptions
-
-[<internal>](../modules/internal_.md).EmbeddedCheckoutOptions
-
-## Table of contents
-
-### Properties
-
-- [containerId](internal_.EmbeddedCheckoutOptions.md#containerid)
-- [styles](internal_.EmbeddedCheckoutOptions.md#styles)
-- [url](internal_.EmbeddedCheckoutOptions.md#url)
-
-### Methods
-
-- [onComplete](internal_.EmbeddedCheckoutOptions.md#oncomplete)
-- [onError](internal_.EmbeddedCheckoutOptions.md#onerror)
-- [onFrameError](internal_.EmbeddedCheckoutOptions.md#onframeerror)
-- [onFrameLoad](internal_.EmbeddedCheckoutOptions.md#onframeload)
-- [onLoad](internal_.EmbeddedCheckoutOptions.md#onload)
-- [onSignOut](internal_.EmbeddedCheckoutOptions.md#onsignout)
-
-## Properties
-
-### containerId
-
-• **containerId**: `string`
-
-___
-
-### styles
-
-• `Optional` **styles**: [`EmbeddedCheckoutStyles`](internal_.EmbeddedCheckoutStyles.md)
-
-___
-
-### url
-
-• **url**: `string`
-
-## Methods
-
-### onComplete
-
-▸ `Optional` **onComplete**(`event`): `void`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `event` | [`EmbeddedCheckoutCompleteEvent`](internal_.EmbeddedCheckoutCompleteEvent.md) |
-
-#### Returns
-
-`void`
-
-___
-
-### onError
-
-▸ `Optional` **onError**(`event`): `void`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `event` | [`EmbeddedCheckoutErrorEvent`](internal_.EmbeddedCheckoutErrorEvent.md) |
-
-#### Returns
-
-`void`
-
-___
-
-### onFrameError
-
-▸ `Optional` **onFrameError**(`event`): `void`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `event` | [`EmbeddedCheckoutFrameErrorEvent`](internal_.EmbeddedCheckoutFrameErrorEvent.md) |
-
-#### Returns
-
-`void`
-
-___
-
-### onFrameLoad
-
-▸ `Optional` **onFrameLoad**(`event`): `void`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `event` | [`EmbeddedCheckoutFrameLoadedEvent`](internal_.EmbeddedCheckoutFrameLoadedEvent.md) |
-
-#### Returns
-
-`void`
-
-___
-
-### onLoad
-
-▸ `Optional` **onLoad**(`event`): `void`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `event` | [`EmbeddedCheckoutLoadedEvent`](internal_.EmbeddedCheckoutLoadedEvent.md) |
-
-#### Returns
-
-`void`
-
-___
-
-### onSignOut
-
-▸ `Optional` **onSignOut**(`event`): `void`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `event` | [`EmbeddedCheckoutSignedOutEvent`](internal_.EmbeddedCheckoutSignedOutEvent.md) |
-
-#### Returns
-
-`void`

package/docs/interfaces/internal_.EmbeddedCheckoutSignedOutEvent.md

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

package/docs/interfaces/internal_.EmbeddedCheckoutStyles.md

@@ -1,143 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / EmbeddedCheckoutStyles
-
-# Interface: EmbeddedCheckoutStyles
-
-[<internal>](../modules/internal_.md).EmbeddedCheckoutStyles
-
-## Table of contents
-
-### Properties
-
-- [body](internal_.EmbeddedCheckoutStyles.md#body)
-- [button](internal_.EmbeddedCheckoutStyles.md#button)
-- [checkbox](internal_.EmbeddedCheckoutStyles.md#checkbox)
-- [checklist](internal_.EmbeddedCheckoutStyles.md#checklist)
-- [discountBanner](internal_.EmbeddedCheckoutStyles.md#discountbanner)
-- [heading](internal_.EmbeddedCheckoutStyles.md#heading)
-- [input](internal_.EmbeddedCheckoutStyles.md#input)
-- [label](internal_.EmbeddedCheckoutStyles.md#label)
-- [link](internal_.EmbeddedCheckoutStyles.md#link)
-- [loadingBanner](internal_.EmbeddedCheckoutStyles.md#loadingbanner)
-- [loadingIndicator](internal_.EmbeddedCheckoutStyles.md#loadingindicator)
-- [orderSummary](internal_.EmbeddedCheckoutStyles.md#ordersummary)
-- [radio](internal_.EmbeddedCheckoutStyles.md#radio)
-- [secondaryButton](internal_.EmbeddedCheckoutStyles.md#secondarybutton)
-- [secondaryHeading](internal_.EmbeddedCheckoutStyles.md#secondaryheading)
-- [secondaryText](internal_.EmbeddedCheckoutStyles.md#secondarytext)
-- [select](internal_.EmbeddedCheckoutStyles.md#select)
-- [step](internal_.EmbeddedCheckoutStyles.md#step)
-- [text](internal_.EmbeddedCheckoutStyles.md#text)
-
-## Properties
-
-### body
-
-• `Optional` **body**: [`BodyStyles`](internal_.BodyStyles.md)
-
-___
-
-### button
-
-• `Optional` **button**: [`ButtonStyles`](internal_.ButtonStyles.md)
-
-___
-
-### checkbox
-
-• `Optional` **checkbox**: [`CheckableInputStyles`](internal_.CheckableInputStyles.md)
-
-___
-
-### checklist
-
-• `Optional` **checklist**: [`ChecklistStyles`](internal_.ChecklistStyles.md)
-
-___
-
-### discountBanner
-
-• `Optional` **discountBanner**: [`BlockElementStyles`](internal_.BlockElementStyles.md)
-
-___
-
-### heading
-
-• `Optional` **heading**: [`BlockElementStyles`](internal_.BlockElementStyles.md)
-
-___
-
-### input
-
-• `Optional` **input**: [`TextInputStyles`](internal_.TextInputStyles.md)
-
-___
-
-### label
-
-• `Optional` **label**: [`LabelStyles`](internal_.LabelStyles.md)
-
-___
-
-### link
-
-• `Optional` **link**: [`LinkStyles`](internal_.LinkStyles.md)
-
-___
-
-### loadingBanner
-
-• `Optional` **loadingBanner**: [`BlockElementStyles`](internal_.BlockElementStyles.md)
-
-___
-
-### loadingIndicator
-
-• `Optional` **loadingIndicator**: [`LoadingIndicatorStyles`](internal_.LoadingIndicatorStyles.md)
-
-___
-
-### orderSummary
-
-• `Optional` **orderSummary**: [`BlockElementStyles`](internal_.BlockElementStyles.md)
-
-___
-
-### radio
-
-• `Optional` **radio**: [`CheckableInputStyles`](internal_.CheckableInputStyles.md)
-
-___
-
-### secondaryButton
-
-• `Optional` **secondaryButton**: [`ButtonStyles`](internal_.ButtonStyles.md)
-
-___
-
-### secondaryHeading
-
-• `Optional` **secondaryHeading**: [`BlockElementStyles`](internal_.BlockElementStyles.md)
-
-___
-
-### secondaryText
-
-• `Optional` **secondaryText**: [`InlineElementStyles`](internal_.InlineElementStyles.md)
-
-___
-
-### select
-
-• `Optional` **select**: [`InputStyles`](internal_.InputStyles.md)
-
-___
-
-### step
-
-• `Optional` **step**: [`StepStyles`](internal_.StepStyles.md)
-
-___
-
-### text
-
-• `Optional` **text**: [`InlineElementStyles`](internal_.InlineElementStyles.md)

package/docs/interfaces/internal_.EmbeddedContentOptions.md

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