@bigcommerce/checkout-sdk 1.271.1 → 1.271.2

package/docs/interfaces/DigitalItem.md

@@ -1,310 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / DigitalItem
-
-# Interface: DigitalItem
-
-## Hierarchy
-
-- [`LineItem`](LineItem.md)
-
-  ↳ **`DigitalItem`**
-
-## Table of contents
-
-### Properties
-
-- [addedByPromotion](DigitalItem.md#addedbypromotion)
-- [brand](DigitalItem.md#brand)
-- [categories](DigitalItem.md#categories)
-- [categoryNames](DigitalItem.md#categorynames)
-- [comparisonPrice](DigitalItem.md#comparisonprice)
-- [couponAmount](DigitalItem.md#couponamount)
-- [discountAmount](DigitalItem.md#discountamount)
-- [discounts](DigitalItem.md#discounts)
-- [downloadFileUrls](DigitalItem.md#downloadfileurls)
-- [downloadPageUrl](DigitalItem.md#downloadpageurl)
-- [downloadSize](DigitalItem.md#downloadsize)
-- [extendedComparisonPrice](DigitalItem.md#extendedcomparisonprice)
-- [extendedListPrice](DigitalItem.md#extendedlistprice)
-- [extendedSalePrice](DigitalItem.md#extendedsaleprice)
-- [id](DigitalItem.md#id)
-- [imageUrl](DigitalItem.md#imageurl)
-- [isTaxable](DigitalItem.md#istaxable)
-- [listPrice](DigitalItem.md#listprice)
-- [name](DigitalItem.md#name)
-- [options](DigitalItem.md#options)
-- [parentId](DigitalItem.md#parentid)
-- [productId](DigitalItem.md#productid)
-- [quantity](DigitalItem.md#quantity)
-- [salePrice](DigitalItem.md#saleprice)
-- [sku](DigitalItem.md#sku)
-- [socialMedia](DigitalItem.md#socialmedia)
-- [url](DigitalItem.md#url)
-- [variantId](DigitalItem.md#variantid)
-
-## Properties
-
-### addedByPromotion
-
-• **addedByPromotion**: `boolean`
-
-#### Inherited from
-
-[LineItem](LineItem.md).[addedByPromotion](LineItem.md#addedbypromotion)
-
-___
-
-### brand
-
-• **brand**: `string`
-
-#### Inherited from
-
-[LineItem](LineItem.md).[brand](LineItem.md#brand)
-
-___
-
-### categories
-
-• `Optional` **categories**: [`LineItemCategory`](LineItemCategory.md)[][]
-
-#### Inherited from
-
-[LineItem](LineItem.md).[categories](LineItem.md#categories)
-
-___
-
-### categoryNames
-
-• `Optional` **categoryNames**: `string`[]
-
-#### Inherited from
-
-[LineItem](LineItem.md).[categoryNames](LineItem.md#categorynames)
-
-___
-
-### comparisonPrice
-
-• **comparisonPrice**: `number`
-
-#### Inherited from
-
-[LineItem](LineItem.md).[comparisonPrice](LineItem.md#comparisonprice)
-
-___
-
-### couponAmount
-
-• **couponAmount**: `number`
-
-#### Inherited from
-
-[LineItem](LineItem.md).[couponAmount](LineItem.md#couponamount)
-
-___
-
-### discountAmount
-
-• **discountAmount**: `number`
-
-#### Inherited from
-
-[LineItem](LineItem.md).[discountAmount](LineItem.md#discountamount)
-
-___
-
-### discounts
-
-• **discounts**: { `discountedAmount`: `number` ; `name`: `string`  }[]
-
-#### Inherited from
-
-[LineItem](LineItem.md).[discounts](LineItem.md#discounts)
-
-___
-
-### downloadFileUrls
-
-• **downloadFileUrls**: `string`[]
-
-___
-
-### downloadPageUrl
-
-• **downloadPageUrl**: `string`
-
-___
-
-### downloadSize
-
-• **downloadSize**: `string`
-
-___
-
-### extendedComparisonPrice
-
-• **extendedComparisonPrice**: `number`
-
-#### Inherited from
-
-[LineItem](LineItem.md).[extendedComparisonPrice](LineItem.md#extendedcomparisonprice)
-
-___
-
-### extendedListPrice
-
-• **extendedListPrice**: `number`
-
-#### Inherited from
-
-[LineItem](LineItem.md).[extendedListPrice](LineItem.md#extendedlistprice)
-
-___
-
-### extendedSalePrice
-
-• **extendedSalePrice**: `number`
-
-#### Inherited from
-
-[LineItem](LineItem.md).[extendedSalePrice](LineItem.md#extendedsaleprice)
-
-___
-
-### id
-
-• **id**: `string` \| `number`
-
-#### Inherited from
-
-[LineItem](LineItem.md).[id](LineItem.md#id)
-
-___
-
-### imageUrl
-
-• **imageUrl**: `string`
-
-#### Inherited from
-
-[LineItem](LineItem.md).[imageUrl](LineItem.md#imageurl)
-
-___
-
-### isTaxable
-
-• **isTaxable**: `boolean`
-
-#### Inherited from
-
-[LineItem](LineItem.md).[isTaxable](LineItem.md#istaxable)
-
-___
-
-### listPrice
-
-• **listPrice**: `number`
-
-#### Inherited from
-
-[LineItem](LineItem.md).[listPrice](LineItem.md#listprice)
-
-___
-
-### name
-
-• **name**: `string`
-
-#### Inherited from
-
-[LineItem](LineItem.md).[name](LineItem.md#name)
-
-___
-
-### options
-
-• `Optional` **options**: [`LineItemOption`](LineItemOption.md)[]
-
-#### Inherited from
-
-[LineItem](LineItem.md).[options](LineItem.md#options)
-
-___
-
-### parentId
-
-• `Optional` **parentId**: ``null`` \| `string`
-
-#### Inherited from
-
-[LineItem](LineItem.md).[parentId](LineItem.md#parentid)
-
-___
-
-### productId
-
-• **productId**: `number`
-
-#### Inherited from
-
-[LineItem](LineItem.md).[productId](LineItem.md#productid)
-
-___
-
-### quantity
-
-• **quantity**: `number`
-
-#### Inherited from
-
-[LineItem](LineItem.md).[quantity](LineItem.md#quantity)
-
-___
-
-### salePrice
-
-• **salePrice**: `number`
-
-#### Inherited from
-
-[LineItem](LineItem.md).[salePrice](LineItem.md#saleprice)
-
-___
-
-### sku
-
-• **sku**: `string`
-
-#### Inherited from
-
-[LineItem](LineItem.md).[sku](LineItem.md#sku)
-
-___
-
-### socialMedia
-
-• `Optional` **socialMedia**: [`LineItemSocialData`](LineItemSocialData.md)[]
-
-#### Inherited from
-
-[LineItem](LineItem.md).[socialMedia](LineItem.md#socialmedia)
-
-___
-
-### url
-
-• **url**: `string`
-
-#### Inherited from
-
-[LineItem](LineItem.md).[url](LineItem.md#url)
-
-___
-
-### variantId
-
-• **variantId**: `number`
-
-#### Inherited from
-
-[LineItem](LineItem.md).[variantId](LineItem.md#variantid)

package/docs/interfaces/DigitalRiverElementClasses.md

@@ -1,67 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / DigitalRiverElementClasses
-
-# Interface: DigitalRiverElementClasses
-
-Custom classes
-You can specify custom classes as part of a Class object included within the Options object when you create or
-update an element. If you do not provide custom classes, the system uses the default options.
-https://docs.digitalriver.com/digital-river-api/payment-integrations-1/digitalriver.js/reference/elements#custom-classes
-
-## Table of contents
-
-### Properties
-
-- [base](DigitalRiverElementClasses.md#base)
-- [complete](DigitalRiverElementClasses.md#complete)
-- [empty](DigitalRiverElementClasses.md#empty)
-- [focus](DigitalRiverElementClasses.md#focus)
-- [invalid](DigitalRiverElementClasses.md#invalid)
-- [webkitAutofill](DigitalRiverElementClasses.md#webkitautofill)
-
-## Properties
-
-### base
-
-• `Optional` **base**: `string`
-
-The Element is in its base state. The user either has not entered anything into the input field or is currently typing.
-
-___
-
-### complete
-
-• `Optional` **complete**: `string`
-
-The Element is in its complete state. The user has input value, and it meets the basic validation requirements of that field.
-
-___
-
-### empty
-
-• `Optional` **empty**: `string`
-
-The Element is empty. The Element once had value but is now empty.
-
-___
-
-### focus
-
-• `Optional` **focus**: `string`
-
-The Element has focus.
-
-___
-
-### invalid
-
-• `Optional` **invalid**: `string`
-
-The Element has value, but it does not meet the basic validation requirements of the field.
-
-___
-
-### webkitAutofill
-
-• `Optional` **webkitAutofill**: `string`
-
-The element has a value that has been automatically filled by the browser.

package/docs/interfaces/DigitalRiverPaymentInitializeOptions.md

@@ -1,146 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / DigitalRiverPaymentInitializeOptions
-
-# Interface: 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](DigitalRiverPaymentInitializeOptions.md#configuration)
-- [containerId](DigitalRiverPaymentInitializeOptions.md#containerid)
-
-### Methods
-
-- [onError](DigitalRiverPaymentInitializeOptions.md#onerror)
-- [onRenderButton](DigitalRiverPaymentInitializeOptions.md#onrenderbutton)
-- [onSubmitForm](DigitalRiverPaymentInitializeOptions.md#onsubmitform)
-
-## Properties
-
-### configuration
-
-• **configuration**: [`OptionsResponse`](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/Discount.md

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

package/docs/interfaces/EmbeddedCheckoutCompleteEvent.md

@@ -1,15 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / EmbeddedCheckoutCompleteEvent
-
-# Interface: EmbeddedCheckoutCompleteEvent
-
-## Table of contents
-
-### Properties
-
-- [type](EmbeddedCheckoutCompleteEvent.md#type)
-
-## Properties
-
-### type
-
-• **type**: [`CheckoutComplete`](../enums/EmbeddedCheckoutEventType.md#checkoutcomplete)

package/docs/interfaces/EmbeddedCheckoutError.md

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

package/docs/interfaces/EmbeddedCheckoutErrorEvent.md

@@ -1,22 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / EmbeddedCheckoutErrorEvent
-
-# Interface: EmbeddedCheckoutErrorEvent
-
-## Table of contents
-
-### Properties
-
-- [payload](EmbeddedCheckoutErrorEvent.md#payload)
-- [type](EmbeddedCheckoutErrorEvent.md#type)
-
-## Properties
-
-### payload
-
-• **payload**: [`EmbeddedCheckoutError`](EmbeddedCheckoutError.md)
-
-___
-
-### type
-
-• **type**: [`CheckoutError`](../enums/EmbeddedCheckoutEventType.md#checkouterror)

package/docs/interfaces/EmbeddedCheckoutFrameErrorEvent.md

@@ -1,22 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / EmbeddedCheckoutFrameErrorEvent
-
-# Interface: EmbeddedCheckoutFrameErrorEvent
-
-## Table of contents
-
-### Properties
-
-- [payload](EmbeddedCheckoutFrameErrorEvent.md#payload)
-- [type](EmbeddedCheckoutFrameErrorEvent.md#type)
-
-## Properties
-
-### payload
-
-• **payload**: [`EmbeddedCheckoutError`](EmbeddedCheckoutError.md)
-
-___
-
-### type
-
-• **type**: [`FrameError`](../enums/EmbeddedCheckoutEventType.md#frameerror)

package/docs/interfaces/EmbeddedCheckoutFrameLoadedEvent.md

@@ -1,22 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / EmbeddedCheckoutFrameLoadedEvent
-
-# Interface: EmbeddedCheckoutFrameLoadedEvent
-
-## Table of contents
-
-### Properties
-
-- [payload](EmbeddedCheckoutFrameLoadedEvent.md#payload)
-- [type](EmbeddedCheckoutFrameLoadedEvent.md#type)
-
-## Properties
-
-### payload
-
-• `Optional` **payload**: [`EmbeddedContentOptions`](EmbeddedContentOptions.md)
-
-___
-
-### type
-
-• **type**: [`FrameLoaded`](../enums/EmbeddedCheckoutEventType.md#frameloaded)

package/docs/interfaces/EmbeddedCheckoutLoadedEvent.md

@@ -1,15 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / EmbeddedCheckoutLoadedEvent
-
-# Interface: EmbeddedCheckoutLoadedEvent
-
-## Table of contents
-
-### Properties
-
-- [type](EmbeddedCheckoutLoadedEvent.md#type)
-
-## Properties
-
-### type
-
-• **type**: [`CheckoutLoaded`](../enums/EmbeddedCheckoutEventType.md#checkoutloaded)