@bigcommerce/checkout-sdk 1.271.1 → 1.271.2

package/docs/classes/CurrencyService.md

@@ -1,54 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / CurrencyService
-
-# Class: CurrencyService
-
-Responsible for formatting and converting currencies.
-
-## Table of contents
-
-### Constructors
-
-- [constructor](CurrencyService.md#constructor)
-
-### Methods
-
-- [toCustomerCurrency](CurrencyService.md#tocustomercurrency)
-- [toStoreCurrency](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/EmbeddedCheckout.md

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

package/docs/classes/LanguageService.md

@@ -1,101 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / LanguageService
-
-# Class: 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](LanguageService.md#constructor)
-
-### Methods
-
-- [getLocale](LanguageService.md#getlocale)
-- [mapKeys](LanguageService.md#mapkeys)
-- [translate](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/TranslationData.md) | Data for replacing placeholders in the language string. |
-
-#### Returns
-
-`string`
-
-The translated language string.

package/docs/classes/RequestError.md

@@ -1,106 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / RequestError
-
-# Class: RequestError<TBody\>
-
-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`](StandardError.md)
-
-  ↳ **`RequestError`**
-
-## Table of contents
-
-### Constructors
-
-- [constructor](RequestError.md#constructor)
-
-### Properties
-
-- [body](RequestError.md#body)
-- [errors](RequestError.md#errors)
-- [headers](RequestError.md#headers)
-- [name](RequestError.md#name)
-- [status](RequestError.md#status)
-- [type](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](StandardError.md).[constructor](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](StandardError.md).[name](StandardError.md#name)
-
-___
-
-### status
-
-• **status**: `number`
-
-___
-
-### type
-
-• **type**: `string`
-
-#### Inherited from
-
-[StandardError](StandardError.md).[type](StandardError.md#type)

package/docs/classes/StandardError.md

@@ -1,71 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / StandardError
-
-# Class: StandardError
-
-This error type should not be constructed directly. It is a base class for
-all custom errors thrown in this library.
-
-## Hierarchy
-
-- `Error`
-
-  ↳ **`StandardError`**
-
-  ↳↳ [`CartChangedError`](CartChangedError.md)
-
-  ↳↳ [`RequestError`](RequestError.md)
-
-## Implements
-
-- [`CustomError`](../interfaces/CustomError.md)
-
-## Table of contents
-
-### Constructors
-
-- [constructor](StandardError.md#constructor)
-
-### Properties
-
-- [name](StandardError.md#name)
-- [type](StandardError.md#type)
-
-## Constructors
-
-### constructor
-
-• **new StandardError**(`message?`)
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `message?` | `string` |
-
-#### Overrides
-
-Error.constructor
-
-## Properties
-
-### name
-
-• **name**: `string`
-
-#### Implementation of
-
-CustomError.name
-
-#### Overrides
-
-Error.name
-
-___
-
-### type
-
-• **type**: `string`
-
-#### Implementation of
-
-[CustomError](../interfaces/CustomError.md).[type](../interfaces/CustomError.md#type)

package/docs/enums/AmazonPayV2CheckoutLanguage.md

@@ -1,57 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / AmazonPayV2CheckoutLanguage
-
-# Enumeration: AmazonPayV2CheckoutLanguage
-
-## Table of contents
-
-### Enumeration members
-
-- [de_DE](AmazonPayV2CheckoutLanguage.md#de_de)
-- [en_GB](AmazonPayV2CheckoutLanguage.md#en_gb)
-- [en_US](AmazonPayV2CheckoutLanguage.md#en_us)
-- [es_ES](AmazonPayV2CheckoutLanguage.md#es_es)
-- [fr_FR](AmazonPayV2CheckoutLanguage.md#fr_fr)
-- [it_IT](AmazonPayV2CheckoutLanguage.md#it_it)
-- [ja_JP](AmazonPayV2CheckoutLanguage.md#ja_jp)
-
-## Enumeration members
-
-### de\_DE
-
-• **de\_DE** = `"de_DE"`
-
-___
-
-### en\_GB
-
-• **en\_GB** = `"en_GB"`
-
-___
-
-### en\_US
-
-• **en\_US** = `"en_US"`
-
-___
-
-### es\_ES
-
-• **es\_ES** = `"es_ES"`
-
-___
-
-### fr\_FR
-
-• **fr\_FR** = `"fr_FR"`
-
-___
-
-### it\_IT
-
-• **it\_IT** = `"it_IT"`
-
-___
-
-### ja\_JP
-
-• **ja\_JP** = `"ja_JP"`

package/docs/enums/AmazonPayV2LedgerCurrency.md

@@ -1,36 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / AmazonPayV2LedgerCurrency
-
-# Enumeration: AmazonPayV2LedgerCurrency
-
-## Table of contents
-
-### Enumeration members
-
-- [EUR](AmazonPayV2LedgerCurrency.md#eur)
-- [GBP](AmazonPayV2LedgerCurrency.md#gbp)
-- [JPY](AmazonPayV2LedgerCurrency.md#jpy)
-- [USD](AmazonPayV2LedgerCurrency.md#usd)
-
-## Enumeration members
-
-### EUR
-
-• **EUR** = `"EUR"`
-
-___
-
-### GBP
-
-• **GBP** = `"GBP"`
-
-___
-
-### JPY
-
-• **JPY** = `"JPY"`
-
-___
-
-### USD
-
-• **USD** = `"USD"`

package/docs/enums/AmazonPayV2PayOptions.md

@@ -1,26 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / AmazonPayV2PayOptions
-
-# Enumeration: AmazonPayV2PayOptions
-
-## Table of contents
-
-### Enumeration members
-
-- [PayAndShip](AmazonPayV2PayOptions.md#payandship)
-- [PayOnly](AmazonPayV2PayOptions.md#payonly)
-
-## Enumeration members
-
-### PayAndShip
-
-• **PayAndShip** = `"PayAndShip"`
-
-Select this product type if you need the buyer's shipping details.
-
-___
-
-### PayOnly
-
-• **PayOnly** = `"PayOnly"`
-
-Select this product type if you do not need the buyer's shipping details.

package/docs/enums/AmazonPayV2Placement.md

@@ -1,53 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / AmazonPayV2Placement
-
-# Enumeration: AmazonPayV2Placement
-
-## Table of contents
-
-### Enumeration members
-
-- [Cart](AmazonPayV2Placement.md#cart)
-- [Checkout](AmazonPayV2Placement.md#checkout)
-- [Home](AmazonPayV2Placement.md#home)
-- [Other](AmazonPayV2Placement.md#other)
-- [Product](AmazonPayV2Placement.md#product)
-
-## Enumeration members
-
-### Cart
-
-• **Cart** = `"Cart"`
-
-Cart review page before buyer starts checkout.
-
-___
-
-### Checkout
-
-• **Checkout** = `"Checkout"`
-
-Any page after buyer starts checkout.
-
-___
-
-### Home
-
-• **Home** = `"Home"`
-
-Initial or main page.
-
-___
-
-### Other
-
-• **Other** = `"Other"`
-
-Any page that doesn't fit the previous descriptions.
-
-___
-
-### Product
-
-• **Product** = `"Product"`
-
-Product details page.

package/docs/enums/BraintreeFormFieldType.md

@@ -1,50 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / BraintreeFormFieldType
-
-# Enumeration: BraintreeFormFieldType
-
-## Table of contents
-
-### Enumeration members
-
-- [CardCode](BraintreeFormFieldType.md#cardcode)
-- [CardCodeVerification](BraintreeFormFieldType.md#cardcodeverification)
-- [CardExpiry](BraintreeFormFieldType.md#cardexpiry)
-- [CardName](BraintreeFormFieldType.md#cardname)
-- [CardNumber](BraintreeFormFieldType.md#cardnumber)
-- [CardNumberVerification](BraintreeFormFieldType.md#cardnumberverification)
-
-## Enumeration members
-
-### CardCode
-
-• **CardCode** = `"cardCode"`
-
-___
-
-### CardCodeVerification
-
-• **CardCodeVerification** = `"cardCodeVerification"`
-
-___
-
-### CardExpiry
-
-• **CardExpiry** = `"cardExpiry"`
-
-___
-
-### CardName
-
-• **CardName** = `"cardName"`
-
-___
-
-### CardNumber
-
-• **CardNumber** = `"cardNumber"`
-
-___
-
-### CardNumberVerification
-
-• **CardNumberVerification** = `"cardNumberVerification"`

package/docs/enums/ButtonColor.md

@@ -1,29 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / ButtonColor
-
-# Enumeration: ButtonColor
-
-## Table of contents
-
-### Enumeration members
-
-- [Black](ButtonColor.md#black)
-- [Default](ButtonColor.md#default)
-- [White](ButtonColor.md#white)
-
-## Enumeration members
-
-### Black
-
-• **Black** = `"black"`
-
-___
-
-### Default
-
-• **Default** = `"default"`
-
-___
-
-### White
-
-• **White** = `"white"`

package/docs/enums/ButtonType.md

@@ -1,22 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / ButtonType
-
-# Enumeration: ButtonType
-
-## Table of contents
-
-### Enumeration members
-
-- [Long](ButtonType.md#long)
-- [Short](ButtonType.md#short)
-
-## Enumeration members
-
-### Long
-
-• **Long** = `"long"`
-
-___
-
-### Short
-
-• **Short** = `"short"`