@bigcommerce/checkout-sdk 1.308.2 → 1.308.3

package/docs/interfaces/internal_.ShippingInitializeOptions.md

@@ -1,100 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / ShippingInitializeOptions
-
-# Interface: ShippingInitializeOptions<T\>
-
-[<internal>](../modules/internal_.md).ShippingInitializeOptions
-
-A set of options that are required to initialize the shipping step of the
-current checkout flow.
-
-Some payment methods have specific requirements for setting the shipping
-details for checkout. For example, Amazon Pay requires the customer to enter
-their shipping address using their address book widget. As a result, you may
-need to provide additional information in order to initialize the shipping
-step of checkout.
-
-## Type parameters
-
-| Name | Type |
-| :------ | :------ |
-| `T` | {} |
-
-## Hierarchy
-
-- [`ShippingRequestOptions`](internal_.ShippingRequestOptions.md)<`T`\>
-
-  ↳ **`ShippingInitializeOptions`**
-
-## Table of contents
-
-### Properties
-
-- [amazon](internal_.ShippingInitializeOptions.md#amazon)
-- [amazonpay](internal_.ShippingInitializeOptions.md#amazonpay)
-- [methodId](internal_.ShippingInitializeOptions.md#methodid)
-- [params](internal_.ShippingInitializeOptions.md#params)
-- [stripeupe](internal_.ShippingInitializeOptions.md#stripeupe)
-- [timeout](internal_.ShippingInitializeOptions.md#timeout)
-
-## Properties
-
-### amazon
-
-• `Optional` **amazon**: [`AmazonPayShippingInitializeOptions`](internal_.AmazonPayShippingInitializeOptions.md)
-
-The options that are required to initialize the shipping step of checkout
-when using Amazon Pay.
-
-___
-
-### amazonpay
-
-• `Optional` **amazonpay**: [`AmazonPayV2ShippingInitializeOptions`](internal_.AmazonPayV2ShippingInitializeOptions.md)
-
-The options that are required to initialize the shipping step of checkout
-when using AmazonPayV2.
-
-___
-
-### methodId
-
-• `Optional` **methodId**: `string`
-
-#### Inherited from
-
-[ShippingRequestOptions](internal_.ShippingRequestOptions.md).[methodId](internal_.ShippingRequestOptions.md#methodid)
-
-___
-
-### params
-
-• `Optional` **params**: `T`
-
-The parameters of the request, if required.
-
-#### Inherited from
-
-[ShippingRequestOptions](internal_.ShippingRequestOptions.md).[params](internal_.ShippingRequestOptions.md#params)
-
-___
-
-### stripeupe
-
-• `Optional` **stripeupe**: [`StripeUPEShippingInitializeOptions`](internal_.StripeUPEShippingInitializeOptions.md)
-
-The options that are required to initialize the shipping step of checkout
-when using Stripe Upe Link.
-
-___
-
-### timeout
-
-• `Optional` **timeout**: `default`
-
-Provide this option if you want to cancel or time out the request. If the
-timeout object completes before the request, the request will be
-cancelled.
-
-#### Inherited from
-
-[ShippingRequestOptions](internal_.ShippingRequestOptions.md).[timeout](internal_.ShippingRequestOptions.md#timeout)

package/docs/interfaces/internal_.ShippingOption.md

@@ -1,66 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / ShippingOption
-
-# Interface: ShippingOption
-
-[<internal>](../modules/internal_.md).ShippingOption
-
-## Table of contents
-
-### Properties
-
-- [additionalDescription](internal_.ShippingOption.md#additionaldescription)
-- [cost](internal_.ShippingOption.md#cost)
-- [description](internal_.ShippingOption.md#description)
-- [id](internal_.ShippingOption.md#id)
-- [imageUrl](internal_.ShippingOption.md#imageurl)
-- [isRecommended](internal_.ShippingOption.md#isrecommended)
-- [transitTime](internal_.ShippingOption.md#transittime)
-- [type](internal_.ShippingOption.md#type)
-
-## Properties
-
-### additionalDescription
-
-• **additionalDescription**: `string`
-
-___
-
-### cost
-
-• **cost**: `number`
-
-___
-
-### description
-
-• **description**: `string`
-
-___
-
-### id
-
-• **id**: `string`
-
-___
-
-### imageUrl
-
-• **imageUrl**: `string`
-
-___
-
-### isRecommended
-
-• **isRecommended**: `boolean`
-
-___
-
-### transitTime
-
-• **transitTime**: `string`
-
-___
-
-### type
-
-• **type**: `string`

package/docs/interfaces/internal_.ShippingRequestOptions.md

@@ -1,67 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / ShippingRequestOptions
-
-# Interface: ShippingRequestOptions<T\>
-
-[<internal>](../modules/internal_.md).ShippingRequestOptions
-
-A set of options for configuring any requests related to the shipping step of
-the current checkout flow.
-
-Some payment methods have their own shipping configuration flow. Therefore,
-you need to specify the method you intend to use if you want to trigger a
-specific flow for setting the shipping address or option. Otherwise, these
-options are not required.
-
-## Type parameters
-
-| Name | Type |
-| :------ | :------ |
-| `T` | {} |
-
-## Hierarchy
-
-- [`RequestOptions`](internal_.RequestOptions.md)<`T`\>
-
-  ↳ **`ShippingRequestOptions`**
-
-  ↳↳ [`ShippingInitializeOptions`](internal_.ShippingInitializeOptions.md)
-
-## Table of contents
-
-### Properties
-
-- [methodId](internal_.ShippingRequestOptions.md#methodid)
-- [params](internal_.ShippingRequestOptions.md#params)
-- [timeout](internal_.ShippingRequestOptions.md#timeout)
-
-## Properties
-
-### methodId
-
-• `Optional` **methodId**: `string`
-
-___
-
-### params
-
-• `Optional` **params**: `T`
-
-The parameters of the request, if required.
-
-#### Inherited from
-
-[RequestOptions](internal_.RequestOptions.md).[params](internal_.RequestOptions.md#params)
-
-___
-
-### timeout
-
-• `Optional` **timeout**: `default`
-
-Provide this option if you want to cancel or time out the request. If the
-timeout object completes before the request, the request will be
-cancelled.
-
-#### Inherited from
-
-[RequestOptions](internal_.RequestOptions.md).[timeout](internal_.RequestOptions.md#timeout)

package/docs/interfaces/internal_.ShopperConfig.md

@@ -1,31 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / ShopperConfig
-
-# Interface: ShopperConfig
-
-[<internal>](../modules/internal_.md).ShopperConfig
-
-## Table of contents
-
-### Properties
-
-- [defaultNewsletterSignup](internal_.ShopperConfig.md#defaultnewslettersignup)
-- [passwordRequirements](internal_.ShopperConfig.md#passwordrequirements)
-- [showNewsletterSignup](internal_.ShopperConfig.md#shownewslettersignup)
-
-## Properties
-
-### defaultNewsletterSignup
-
-• **defaultNewsletterSignup**: `boolean`
-
-___
-
-### passwordRequirements
-
-• **passwordRequirements**: [`PasswordRequirements`](internal_.PasswordRequirements.md)
-
-___
-
-### showNewsletterSignup
-
-• **showNewsletterSignup**: `boolean`

package/docs/interfaces/internal_.ShopperCurrency.md

@@ -1,96 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / ShopperCurrency
-
-# Interface: ShopperCurrency
-
-[<internal>](../modules/internal_.md).ShopperCurrency
-
-## Hierarchy
-
-- [`StoreCurrency`](internal_.StoreCurrency.md)
-
-  ↳ **`ShopperCurrency`**
-
-## Table of contents
-
-### Properties
-
-- [code](internal_.ShopperCurrency.md#code)
-- [decimalPlaces](internal_.ShopperCurrency.md#decimalplaces)
-- [decimalSeparator](internal_.ShopperCurrency.md#decimalseparator)
-- [exchangeRate](internal_.ShopperCurrency.md#exchangerate)
-- [isTransactional](internal_.ShopperCurrency.md#istransactional)
-- [symbol](internal_.ShopperCurrency.md#symbol)
-- [symbolLocation](internal_.ShopperCurrency.md#symbollocation)
-- [thousandsSeparator](internal_.ShopperCurrency.md#thousandsseparator)
-
-## Properties
-
-### code
-
-• **code**: `string`
-
-#### Inherited from
-
-[StoreCurrency](internal_.StoreCurrency.md).[code](internal_.StoreCurrency.md#code)
-
-___
-
-### decimalPlaces
-
-• **decimalPlaces**: `string`
-
-#### Inherited from
-
-[StoreCurrency](internal_.StoreCurrency.md).[decimalPlaces](internal_.StoreCurrency.md#decimalplaces)
-
-___
-
-### decimalSeparator
-
-• **decimalSeparator**: `string`
-
-#### Inherited from
-
-[StoreCurrency](internal_.StoreCurrency.md).[decimalSeparator](internal_.StoreCurrency.md#decimalseparator)
-
-___
-
-### exchangeRate
-
-• **exchangeRate**: `number`
-
-___
-
-### isTransactional
-
-• **isTransactional**: `boolean`
-
-___
-
-### symbol
-
-• **symbol**: `string`
-
-#### Inherited from
-
-[StoreCurrency](internal_.StoreCurrency.md).[symbol](internal_.StoreCurrency.md#symbol)
-
-___
-
-### symbolLocation
-
-• **symbolLocation**: `string`
-
-#### Inherited from
-
-[StoreCurrency](internal_.StoreCurrency.md).[symbolLocation](internal_.StoreCurrency.md#symbollocation)
-
-___
-
-### thousandsSeparator
-
-• **thousandsSeparator**: `string`
-
-#### Inherited from
-
-[StoreCurrency](internal_.StoreCurrency.md).[thousandsSeparator](internal_.StoreCurrency.md#thousandsseparator)

package/docs/interfaces/internal_.SignInEmail.md

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

package/docs/interfaces/internal_.SignInEmailRequestBody.md

@@ -1,24 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / SignInEmailRequestBody
-
-# Interface: SignInEmailRequestBody
-
-[<internal>](../modules/internal_.md).SignInEmailRequestBody
-
-## Table of contents
-
-### Properties
-
-- [email](internal_.SignInEmailRequestBody.md#email)
-- [redirectUrl](internal_.SignInEmailRequestBody.md#redirecturl)
-
-## Properties
-
-### email
-
-• **email**: `string`
-
-___
-
-### redirectUrl
-
-• `Optional` **redirectUrl**: `string`

package/docs/interfaces/internal_.SpamProtectionOptions.md

@@ -1,27 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / SpamProtectionOptions
-
-# Interface: SpamProtectionOptions
-
-[<internal>](../modules/internal_.md).SpamProtectionOptions
-
-The set of options for configuring any requests related to spam protection.
-
-## Hierarchy
-
-- `default`
-
-  ↳ **`SpamProtectionOptions`**
-
-## Table of contents
-
-### Properties
-
-- [containerId](internal_.SpamProtectionOptions.md#containerid)
-
-## Properties
-
-### containerId
-
-• **containerId**: `string`
-
-The container ID where the spam protection should be rendered.

package/docs/interfaces/internal_.SquareFormElement.md

@@ -1,30 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / SquareFormElement
-
-# Interface: SquareFormElement
-
-[<internal>](../modules/internal_.md).SquareFormElement
-
-Configures any form element provided by Square payment.
-
-## Table of contents
-
-### Properties
-
-- [elementId](internal_.SquareFormElement.md#elementid)
-- [placeholder](internal_.SquareFormElement.md#placeholder)
-
-## Properties
-
-### elementId
-
-• **elementId**: `string`
-
-The ID of the container which the form element should insert into.
-
-___
-
-### placeholder
-
-• `Optional` **placeholder**: `string`
-
-The placeholder text to use for the form element, if provided.

package/docs/interfaces/internal_.SquarePaymentInitializeOptions.md

@@ -1,133 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / SquarePaymentInitializeOptions
-
-# Interface: SquarePaymentInitializeOptions
-
-[<internal>](../modules/internal_.md).SquarePaymentInitializeOptions
-
-A set of options that are required to initialize the Square payment method.
-
-Once Square payment is initialized, credit card form fields, provided by the
-payment provider as iframes, will be inserted into the current page. These
-options provide a location and styling for each of the form fields.
-
-```html
-<!-- These containers are where the hosted (iframed) credit card fields will be inserted -->
-<div id="card-number"></div>
-<div id="card-name"></div>
-<div id="card-expiry"></div>
-<div id="card-code"></div>
-```
-
-```js
-service.initializePayment({
-    methodId: 'squarev2',
-    square: {
-        cardNumber: {
-            elementId: 'card-number',
-        },
-        cvv: {
-            elementId: 'card-code',
-        },
-        expirationDate: {
-            elementId: 'card-expiry',
-        },
-        postalCode: {
-            elementId: 'card-code',
-        },
-    },
-});
-```
-
-## Table of contents
-
-### Properties
-
-- [cardNumber](internal_.SquarePaymentInitializeOptions.md#cardnumber)
-- [cvv](internal_.SquarePaymentInitializeOptions.md#cvv)
-- [expirationDate](internal_.SquarePaymentInitializeOptions.md#expirationdate)
-- [inputClass](internal_.SquarePaymentInitializeOptions.md#inputclass)
-- [inputStyles](internal_.SquarePaymentInitializeOptions.md#inputstyles)
-- [postalCode](internal_.SquarePaymentInitializeOptions.md#postalcode)
-
-### Methods
-
-- [onError](internal_.SquarePaymentInitializeOptions.md#onerror)
-- [onPaymentSelect](internal_.SquarePaymentInitializeOptions.md#onpaymentselect)
-
-## Properties
-
-### cardNumber
-
-• **cardNumber**: [`SquareFormElement`](internal_.SquareFormElement.md)
-
-The location to insert the credit card number form field.
-
-___
-
-### cvv
-
-• **cvv**: [`SquareFormElement`](internal_.SquareFormElement.md)
-
-The location to insert the CVV form field.
-
-___
-
-### expirationDate
-
-• **expirationDate**: [`SquareFormElement`](internal_.SquareFormElement.md)
-
-The location to insert the expiration date form field.
-
-___
-
-### inputClass
-
-• `Optional` **inputClass**: `string`
-
-The CSS class to apply to all form fields.
-
-___
-
-### inputStyles
-
-• `Optional` **inputStyles**: { `[key: string]`: `string`;  }[]
-
-The set of CSS styles to apply to all form fields.
-
-___
-
-### postalCode
-
-• **postalCode**: [`SquareFormElement`](internal_.SquareFormElement.md)
-
-The location to insert the postal code form field.
-
-## Methods
-
-### onError
-
-▸ `Optional` **onError**(`errors?`): `void`
-
-A callback that gets called when an error occurs in the card nonce generation
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `errors?` | [`NonceGenerationError`](internal_.NonceGenerationError.md)[] |
-
-#### Returns
-
-`void`
-
-___
-
-### onPaymentSelect
-
-▸ `Optional` **onPaymentSelect**(): `void`
-
-A callback that gets called when the customer selects a payment option.
-
-#### Returns
-
-`void`