@bigcommerce/checkout-sdk 1.308.2 → 1.308.3

package/docs/classes/internal_.CurrencyService.md

@@ -1,56 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / CurrencyService
-
-# Class: CurrencyService
-
-[<internal>](../modules/internal_.md).CurrencyService
-
-Responsible for formatting and converting currencies.
-
-## Table of contents
-
-### Constructors
-
-- [constructor](internal_.CurrencyService.md#constructor)
-
-### Methods
-
-- [toCustomerCurrency](internal_.CurrencyService.md#tocustomercurrency)
-- [toStoreCurrency](internal_.CurrencyService.md#tostorecurrency)
-
-## Constructors
-
-### constructor
-
-• **new CurrencyService**()
-
-## Methods
-
-### toCustomerCurrency
-
-▸ **toCustomerCurrency**(`amount`): `string`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `amount` | `number` |
-
-#### Returns
-
-`string`
-
-___
-
-### toStoreCurrency
-
-▸ **toStoreCurrency**(`amount`): `string`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `amount` | `number` |
-
-#### Returns
-
-`string`

package/docs/classes/internal_.EmbeddedCheckout.md

@@ -1,42 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / EmbeddedCheckout
-
-# Class: EmbeddedCheckout
-
-[<internal>](../modules/internal_.md).EmbeddedCheckout
-
-## Table of contents
-
-### Constructors
-
-- [constructor](internal_.EmbeddedCheckout.md#constructor)
-
-### Methods
-
-- [attach](internal_.EmbeddedCheckout.md#attach)
-- [detach](internal_.EmbeddedCheckout.md#detach)
-
-## Constructors
-
-### constructor
-
-• **new EmbeddedCheckout**()
-
-## Methods
-
-### attach
-
-▸ **attach**(): `Promise`<[`EmbeddedCheckout`](internal_.EmbeddedCheckout.md)\>
-
-#### Returns
-
-`Promise`<[`EmbeddedCheckout`](internal_.EmbeddedCheckout.md)\>
-
-___
-
-### detach
-
-▸ **detach**(): `void`
-
-#### Returns
-
-`void`

package/docs/classes/internal_.LanguageService.md

@@ -1,103 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / LanguageService
-
-# Class: LanguageService
-
-[<internal>](../modules/internal_.md).LanguageService
-
-Responsible for getting language strings.
-
-This object can be used to retrieve language strings that are most
-appropriate for a given locale.
-
-The language strings provided to the object should follow [ICU
-MessageFormat](http://userguide.icu-project.org/formatparse/messages) syntax.
-
-## Table of contents
-
-### Constructors
-
-- [constructor](internal_.LanguageService.md#constructor)
-
-### Methods
-
-- [getLocale](internal_.LanguageService.md#getlocale)
-- [mapKeys](internal_.LanguageService.md#mapkeys)
-- [translate](internal_.LanguageService.md#translate)
-
-## Constructors
-
-### constructor
-
-• **new LanguageService**()
-
-## Methods
-
-### getLocale
-
-▸ **getLocale**(): `string`
-
-Gets the preferred locale of the current customer.
-
-#### Returns
-
-`string`
-
-The preferred locale code.
-
-___
-
-### mapKeys
-
-▸ **mapKeys**(`maps`): `void`
-
-Remaps a set of language strings with a different set of keys.
-
-```js
-service.mapKeys({
-    'new_key': 'existing_key',
-});
-
-console.log(service.translate('new_key'));
-```
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `maps` | `Object` | The set of language strings. |
-
-#### Returns
-
-`void`
-
-___
-
-### translate
-
-▸ **translate**(`key`, `data?`): `string`
-
-Gets a language string by a key.
-
-```js
-service.translate('language_key');
-```
-
-If the language string contains a placeholder, you can replace it by
-providing a second argument.
-
-```js
-service.translate('language_key', { placeholder: 'Hello' });
-```
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `key` | `string` | The language key. |
-| `data?` | [`TranslationData`](../interfaces/internal_.TranslationData.md) | Data for replacing placeholders in the language string. |
-
-#### Returns
-
-`string`
-
-The translated language string.

package/docs/classes/internal_.RequestError.md

@@ -1,108 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / RequestError
-
-# Class: RequestError<TBody\>
-
-[<internal>](../modules/internal_.md).RequestError
-
-Throw this error if we are unable to make a request to the server. It wraps
-any server response into a JS error object.
-
-## Type parameters
-
-| Name | Type |
-| :------ | :------ |
-| `TBody` | `any` |
-
-## Hierarchy
-
-- [`StandardError`](internal_.StandardError.md)
-
-  ↳ **`RequestError`**
-
-## Table of contents
-
-### Constructors
-
-- [constructor](internal_.RequestError.md#constructor)
-
-### Properties
-
-- [body](internal_.RequestError.md#body)
-- [errors](internal_.RequestError.md#errors)
-- [headers](internal_.RequestError.md#headers)
-- [name](internal_.RequestError.md#name)
-- [status](internal_.RequestError.md#status)
-- [type](internal_.RequestError.md#type)
-
-## Constructors
-
-### constructor
-
-• **new RequestError**<`TBody`\>(`response?`, `__namedParameters?`)
-
-#### Type parameters
-
-| Name | Type |
-| :------ | :------ |
-| `TBody` | `any` |
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `response?` | `default`<{} \| `TBody`\> |
-| `__namedParameters?` | `Object` |
-| `__namedParameters.errors?` | { `code`: `string` ; `message?`: `string`  }[] |
-| `__namedParameters.message?` | `string` |
-
-#### Overrides
-
-[StandardError](internal_.StandardError.md).[constructor](internal_.StandardError.md#constructor)
-
-## Properties
-
-### body
-
-• **body**: {} \| `TBody`
-
-___
-
-### errors
-
-• **errors**: { `code`: `string` ; `message?`: `string`  }[]
-
-___
-
-### headers
-
-• **headers**: `Object`
-
-#### Index signature
-
-▪ [key: `string`]: `any`
-
-___
-
-### name
-
-• **name**: `string`
-
-#### Inherited from
-
-[StandardError](internal_.StandardError.md).[name](internal_.StandardError.md#name)
-
-___
-
-### status
-
-• **status**: `number`
-
-___
-
-### type
-
-• **type**: `string`
-
-#### Inherited from
-
-[StandardError](internal_.StandardError.md).[type](internal_.StandardError.md#type)

package/docs/enums/internal_.AdyenV2CardFields.md

@@ -1,31 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / AdyenV2CardFields
-
-# Enumeration: AdyenV2CardFields
-
-[<internal>](../modules/internal_.md).AdyenV2CardFields
-
-## Table of contents
-
-### Enumeration Members
-
-- [CardNumber](internal_.AdyenV2CardFields.md#cardnumber)
-- [ExpiryDate](internal_.AdyenV2CardFields.md#expirydate)
-- [SecurityCode](internal_.AdyenV2CardFields.md#securitycode)
-
-## Enumeration Members
-
-### CardNumber
-
-• **CardNumber**
-
-___
-
-### ExpiryDate
-
-• **ExpiryDate**
-
-___
-
-### SecurityCode
-
-• **SecurityCode**

package/docs/enums/internal_.AdyenV3CardFields.md

@@ -1,31 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / AdyenV3CardFields
-
-# Enumeration: AdyenV3CardFields
-
-[<internal>](../modules/internal_.md).AdyenV3CardFields
-
-## Table of contents
-
-### Enumeration Members
-
-- [CardNumber](internal_.AdyenV3CardFields.md#cardnumber)
-- [ExpiryDate](internal_.AdyenV3CardFields.md#expirydate)
-- [SecurityCode](internal_.AdyenV3CardFields.md#securitycode)
-
-## Enumeration Members
-
-### CardNumber
-
-• **CardNumber**
-
-___
-
-### ExpiryDate
-
-• **ExpiryDate**
-
-___
-
-### SecurityCode
-
-• **SecurityCode**

package/docs/enums/internal_.CheckoutIncludes.md

@@ -1,31 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / CheckoutIncludes
-
-# Enumeration: CheckoutIncludes
-
-[<internal>](../modules/internal_.md).CheckoutIncludes
-
-## Table of contents
-
-### Enumeration Members
-
-- [AvailableShippingOptions](internal_.CheckoutIncludes.md#availableshippingoptions)
-- [DigitalItemsCategoryNames](internal_.CheckoutIncludes.md#digitalitemscategorynames)
-- [PhysicalItemsCategoryNames](internal_.CheckoutIncludes.md#physicalitemscategorynames)
-
-## Enumeration Members
-
-### AvailableShippingOptions
-
-• **AvailableShippingOptions**
-
-___
-
-### DigitalItemsCategoryNames
-
-• **DigitalItemsCategoryNames**
-
-___
-
-### PhysicalItemsCategoryNames
-
-• **PhysicalItemsCategoryNames**

package/docs/enums/internal_.HostedFieldType.md

@@ -1,52 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / HostedFieldType
-
-# Enumeration: HostedFieldType
-
-[<internal>](../modules/internal_.md).HostedFieldType
-
-## Table of contents
-
-### Enumeration Members
-
-- [CardCode](internal_.HostedFieldType.md#cardcode)
-- [CardCodeVerification](internal_.HostedFieldType.md#cardcodeverification)
-- [CardExpiry](internal_.HostedFieldType.md#cardexpiry)
-- [CardName](internal_.HostedFieldType.md#cardname)
-- [CardNumber](internal_.HostedFieldType.md#cardnumber)
-- [CardNumberVerification](internal_.HostedFieldType.md#cardnumberverification)
-
-## Enumeration Members
-
-### CardCode
-
-• **CardCode**
-
-___
-
-### CardCodeVerification
-
-• **CardCodeVerification**
-
-___
-
-### CardExpiry
-
-• **CardExpiry**
-
-___
-
-### CardName
-
-• **CardName**
-
-___
-
-### CardNumber
-
-• **CardNumber**
-
-___
-
-### CardNumberVerification
-
-• **CardNumberVerification**

package/docs/enums/internal_.IconStyle.md

@@ -1,24 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / IconStyle
-
-# Enumeration: IconStyle
-
-[<internal>](../modules/internal_.md).IconStyle
-
-## Table of contents
-
-### Enumeration Members
-
-- [Default](internal_.IconStyle.md#default)
-- [Solid](internal_.IconStyle.md#solid)
-
-## Enumeration Members
-
-### Default
-
-• **Default**
-
-___
-
-### Solid
-
-• **Solid**

package/docs/enums/internal_.RadiusUnit.md

@@ -1,24 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / RadiusUnit
-
-# Enumeration: RadiusUnit
-
-[<internal>](../modules/internal_.md).RadiusUnit
-
-## Table of contents
-
-### Enumeration Members
-
-- [KM](internal_.RadiusUnit.md#km)
-- [MI](internal_.RadiusUnit.md#mi)
-
-## Enumeration Members
-
-### KM
-
-• **KM**
-
-___
-
-### MI
-
-• **MI**

package/docs/interfaces/internal_.AdyenAdditionalActionCallbacks.md

@@ -1,70 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / AdyenAdditionalActionCallbacks
-
-# Interface: AdyenAdditionalActionCallbacks
-
-[<internal>](../modules/internal_.md).AdyenAdditionalActionCallbacks
-
-## Hierarchy
-
-- **`AdyenAdditionalActionCallbacks`**
-
-  ↳ [`AdyenThreeDS2Options`](internal_.AdyenThreeDS2Options.md)
-
-  ↳ [`AdyenAdditionalActionOptions`](internal_.AdyenAdditionalActionOptions.md)
-
-## Table of contents
-
-### Methods
-
-- [onBeforeLoad](internal_.AdyenAdditionalActionCallbacks.md#onbeforeload)
-- [onComplete](internal_.AdyenAdditionalActionCallbacks.md#oncomplete)
-- [onLoad](internal_.AdyenAdditionalActionCallbacks.md#onload)
-
-## Methods
-
-### onBeforeLoad
-
-▸ `Optional` **onBeforeLoad**(`shopperInteraction?`): `void`
-
-A callback that gets called before adyen component is loaded
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `shopperInteraction?` | `boolean` |
-
-#### Returns
-
-`void`
-
-___
-
-### onComplete
-
-▸ `Optional` **onComplete**(): `void`
-
-A callback that gets called when adyen component verification
-is completed
-
-#### Returns
-
-`void`
-
-___
-
-### onLoad
-
-▸ `Optional` **onLoad**(`cancel?`): `void`
-
-A callback that gets called when adyen component is loaded
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `cancel?` | () => `void` |
-
-#### Returns
-
-`void`

package/docs/interfaces/internal_.AdyenAdditionalActionCallbacks_2.md

@@ -1,68 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / AdyenAdditionalActionCallbacks\_2
-
-# Interface: AdyenAdditionalActionCallbacks\_2
-
-[<internal>](../modules/internal_.md).AdyenAdditionalActionCallbacks_2
-
-## Hierarchy
-
-- **`AdyenAdditionalActionCallbacks_2`**
-
-  ↳ [`AdyenAdditionalActionOptions_2`](internal_.AdyenAdditionalActionOptions_2.md)
-
-## Table of contents
-
-### Methods
-
-- [onBeforeLoad](internal_.AdyenAdditionalActionCallbacks_2.md#onbeforeload)
-- [onComplete](internal_.AdyenAdditionalActionCallbacks_2.md#oncomplete)
-- [onLoad](internal_.AdyenAdditionalActionCallbacks_2.md#onload)
-
-## Methods
-
-### onBeforeLoad
-
-▸ `Optional` **onBeforeLoad**(`shopperInteraction?`): `void`
-
-A callback that gets called before adyen component is loaded
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `shopperInteraction?` | `boolean` |
-
-#### Returns
-
-`void`
-
-___
-
-### onComplete
-
-▸ `Optional` **onComplete**(): `void`
-
-A callback that gets called when adyen component verification
-is completed
-
-#### Returns
-
-`void`
-
-___
-
-### onLoad
-
-▸ `Optional` **onLoad**(`cancel?`): `void`
-
-A callback that gets called when adyen component is loaded
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `cancel?` | () => `void` |
-
-#### Returns
-
-`void`