@bigcommerce/checkout-sdk 1.263.0 → 1.264.2

package/docs/classes/currencyservice.md

@@ -1,44 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) › [CurrencyService](currencyservice.md)
-
-# Class: CurrencyService
-
-Responsible for formatting and converting currencies.
-
-## Hierarchy
-
-* **CurrencyService**
-
-## Index
-
-### Methods
-
-* [toCustomerCurrency](currencyservice.md#tocustomercurrency)
-* [toStoreCurrency](currencyservice.md#tostorecurrency)
-
-## Methods
-
-###  toCustomerCurrency
-
-▸ **toCustomerCurrency**(`amount`: number): *string*
-
-**Parameters:**
-
-Name | Type |
------- | ------ |
-`amount` | number |
-
-**Returns:** *string*
-
-___
-
-###  toStoreCurrency
-
-▸ **toStoreCurrency**(`amount`: number): *string*
-
-**Parameters:**
-
-Name | Type |
------- | ------ |
-`amount` | number |
-
-**Returns:** *string*

package/docs/classes/embeddedcheckout.md

@@ -1,30 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) › [EmbeddedCheckout](embeddedcheckout.md)
-
-# Class: EmbeddedCheckout
-
-## Hierarchy
-
-* **EmbeddedCheckout**
-
-## Index
-
-### Methods
-
-* [attach](embeddedcheckout.md#attach)
-* [detach](embeddedcheckout.md#detach)
-
-## Methods
-
-###  attach
-
-▸ **attach**(): *Promise‹this›*
-
-**Returns:** *Promise‹this›*
-
-___
-
-###  detach
-
-▸ **detach**(): *void*
-
-**Returns:** *void*

package/docs/classes/languageservice.md

@@ -1,89 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) › [LanguageService](languageservice.md)
-
-# 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.
-
-## Hierarchy
-
-* **LanguageService**
-
-## Index
-
-### Methods
-
-* [getLocale](languageservice.md#getlocale)
-* [mapKeys](languageservice.md#mapkeys)
-* [translate](languageservice.md#translate)
-
-## Methods
-
-###  getLocale
-
-▸ **getLocale**(): *string*
-
-Gets the preferred locale of the current customer.
-
-**Returns:** *string*
-
-The preferred locale code.
-
-___
-
-###  mapKeys
-
-▸ **mapKeys**(`maps`: object): *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`: string, `data?`: [TranslationData](../interfaces/translationdata.md)): *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,128 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) › [RequestError](requesterror.md)
-
-# 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
-
-▪ **TBody**
-
-## Hierarchy
-
-  ↳ [StandardError](standarderror.md)
-
-  ↳ **RequestError**
-
-## Implements
-
-* [CustomError](../interfaces/customerror.md)
-
-## Index
-
-### Constructors
-
-* [constructor](requesterror.md#constructor)
-
-### Properties
-
-* [body](requesterror.md#body)
-* [errors](requesterror.md#errors)
-* [headers](requesterror.md#headers)
-* [message](requesterror.md#message)
-* [name](requesterror.md#name)
-* [stack](requesterror.md#optional-stack)
-* [status](requesterror.md#status)
-* [type](requesterror.md#type)
-
-## Constructors
-
-###  constructor
-
-\+ **new RequestError**(`response?`: Response‹TBody | object›, `__namedParameters?`: object): *[RequestError](requesterror.md)*
-
-*Overrides [StandardError](standarderror.md).[constructor](standarderror.md#constructor)*
-
-**Parameters:**
-
-▪`Optional`  **response**: *Response‹TBody | object›*
-
-▪`Optional`  **__namedParameters**: *object*
-
-Name | Type |
------- | ------ |
-`errors` | undefined | object[] |
-`message` | undefined | string |
-
-**Returns:** *[RequestError](requesterror.md)*
-
-## Properties
-
-###  body
-
-• **body**: *TBody | object*
-
-___
-
-###  errors
-
-• **errors**: *Array‹object›*
-
-___
-
-###  headers
-
-• **headers**: *object*
-
-#### Type declaration:
-
-* \[ **key**: *string*\]: any
-
-___
-
-###  message
-
-• **message**: *string*
-
-*Implementation of [CustomError](../interfaces/customerror.md).[message](../interfaces/customerror.md#message)*
-
-*Inherited from [AmazonPayWidgetError](../interfaces/amazonpaywidgeterror.md).[message](../interfaces/amazonpaywidgeterror.md#message)*
-
-___
-
-###  name
-
-• **name**: *string*
-
-*Implementation of [CustomError](../interfaces/customerror.md).[name](../interfaces/customerror.md#name)*
-
-*Inherited from [CartChangedError](cartchangederror.md).[name](cartchangederror.md#name)*
-
-*Overrides [AmazonPayWidgetError](../interfaces/amazonpaywidgeterror.md).[name](../interfaces/amazonpaywidgeterror.md#name)*
-
-___
-
-### `Optional` stack
-
-• **stack**? : *undefined | string*
-
-*Implementation of [CustomError](../interfaces/customerror.md).[stack](../interfaces/customerror.md#optional-stack)*
-
-*Inherited from [AmazonPayWidgetError](../interfaces/amazonpaywidgeterror.md).[stack](../interfaces/amazonpaywidgeterror.md#optional-stack)*
-
-___
-
-###  status
-
-• **status**: *number*
-
-___
-
-###  type
-
-• **type**: *string*
-
-*Implementation of [CustomError](../interfaces/customerror.md).[type](../interfaces/customerror.md#type)*
-
-*Inherited from [CartChangedError](cartchangederror.md).[type](cartchangederror.md#type)*

package/docs/classes/standarderror.md

@@ -1,92 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) › [StandardError](standarderror.md)
-
-# 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](../interfaces/amazonpaywidgeterror.md#error)
-
-  ↳ **StandardError**
-
-  ↳ [CartChangedError](cartchangederror.md)
-
-  ↳ [RequestError](requesterror.md)
-
-## Implements
-
-* [CustomError](../interfaces/customerror.md)
-
-## Index
-
-### Constructors
-
-* [constructor](standarderror.md#constructor)
-
-### Properties
-
-* [message](standarderror.md#message)
-* [name](standarderror.md#name)
-* [stack](standarderror.md#optional-stack)
-* [type](standarderror.md#type)
-* [Error](standarderror.md#static-error)
-
-## Constructors
-
-###  constructor
-
-\+ **new StandardError**(`message?`: undefined | string): *[StandardError](standarderror.md)*
-
-**Parameters:**
-
-Name | Type |
------- | ------ |
-`message?` | undefined | string |
-
-**Returns:** *[StandardError](standarderror.md)*
-
-## Properties
-
-###  message
-
-• **message**: *string*
-
-*Implementation of [CustomError](../interfaces/customerror.md).[message](../interfaces/customerror.md#message)*
-
-*Inherited from [AmazonPayWidgetError](../interfaces/amazonpaywidgeterror.md).[message](../interfaces/amazonpaywidgeterror.md#message)*
-
-___
-
-###  name
-
-• **name**: *string*
-
-*Implementation of [CustomError](../interfaces/customerror.md).[name](../interfaces/customerror.md#name)*
-
-*Overrides [AmazonPayWidgetError](../interfaces/amazonpaywidgeterror.md).[name](../interfaces/amazonpaywidgeterror.md#name)*
-
-___
-
-### `Optional` stack
-
-• **stack**? : *undefined | string*
-
-*Implementation of [CustomError](../interfaces/customerror.md).[stack](../interfaces/customerror.md#optional-stack)*
-
-*Inherited from [AmazonPayWidgetError](../interfaces/amazonpaywidgeterror.md).[stack](../interfaces/amazonpaywidgeterror.md#optional-stack)*
-
-___
-
-###  type
-
-• **type**: *string*
-
-*Implementation of [CustomError](../interfaces/customerror.md).[type](../interfaces/customerror.md#type)*
-
-___
-
-### `Static` Error
-
-▪ **Error**: *ErrorConstructor*

package/docs/enums/amazonpayv2checkoutlanguage.md

@@ -1,57 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) › [AmazonPayV2CheckoutLanguage](amazonpayv2checkoutlanguage.md)
-
-# Enumeration: AmazonPayV2CheckoutLanguage
-
-## Index
-
-### 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](amazonpayv2ledgercurrency.md)
-
-# Enumeration: AmazonPayV2LedgerCurrency
-
-## Index
-
-### 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](amazonpayv2payoptions.md)
-
-# Enumeration: AmazonPayV2PayOptions
-
-## Index
-
-### 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](amazonpayv2placement.md)
-
-# Enumeration: AmazonPayV2Placement
-
-## Index
-
-### 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](braintreeformfieldtype.md)
-
-# Enumeration: BraintreeFormFieldType
-
-## Index
-
-### 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](buttoncolor.md)
-
-# Enumeration: ButtonColor
-
-## Index
-
-### 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](buttontype.md)
-
-# Enumeration: ButtonType
-
-## Index
-
-### Enumeration members
-
-* [Long](buttontype.md#long)
-* [Short](buttontype.md#short)
-
-## Enumeration members
-
-###  Long
-
-• **Long**: = "long"
-
-___
-
-###  Short
-
-• **Short**: = "short"