@bigcommerce/checkout-sdk 1.435.0 → 1.436.1

package/docs/interfaces/SpamProtectionOptions.md

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

package/docs/interfaces/SquareFormElement.md

@@ -1,28 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / SquareFormElement
-
-# Interface: SquareFormElement
-
-Configures any form element provided by Square payment.
-
-## Table of contents
-
-### Properties
-
-- [elementId](SquareFormElement.md#elementid)
-- [placeholder](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/SquarePaymentInitializeOptions.md

@@ -1,131 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / SquarePaymentInitializeOptions
-
-# Interface: 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](SquarePaymentInitializeOptions.md#cardnumber)
-- [cvv](SquarePaymentInitializeOptions.md#cvv)
-- [expirationDate](SquarePaymentInitializeOptions.md#expirationdate)
-- [inputClass](SquarePaymentInitializeOptions.md#inputclass)
-- [inputStyles](SquarePaymentInitializeOptions.md#inputstyles)
-- [postalCode](SquarePaymentInitializeOptions.md#postalcode)
-
-### Methods
-
-- [onError](SquarePaymentInitializeOptions.md#onerror)
-- [onPaymentSelect](SquarePaymentInitializeOptions.md#onpaymentselect)
-
-## Properties
-
-### cardNumber
-
-• **cardNumber**: [`SquareFormElement`](SquareFormElement.md)
-
-The location to insert the credit card number form field.
-
-___
-
-### cvv
-
-• **cvv**: [`SquareFormElement`](SquareFormElement.md)
-
-The location to insert the CVV form field.
-
-___
-
-### expirationDate
-
-• **expirationDate**: [`SquareFormElement`](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`](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`](NonceGenerationError.md)[] |
-
-#### Returns
-
-`void`
-
-___
-
-### onPaymentSelect
-
-▸ `Optional` **onPaymentSelect**(): `void`
-
-A callback that gets called when the customer selects a payment option.
-
-#### Returns
-
-`void`

package/docs/interfaces/SquareV2PaymentInitializeOptions.md

@@ -1,90 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / SquareV2PaymentInitializeOptions
-
-# Interface: SquareV2PaymentInitializeOptions
-
-A set of options that are required to initialize the Square payment method.
-
-Once Square payment is initialized, an iframed payment element will be
-inserted into the current page. These options provide a location, styling,
-and a callback function that advises when it's safe to pay.
-
-**`example`**
-
-```html
-<!-- These container is where the hosted (iframed) payment method element will be inserted -->
-<div id="card-payment"></div>
-```
-
-```js
-service.initializePayment({
-    methodId: 'squarev2',
-    squarev2: {
-        containerId: 'card-payment',
-        style: {
-            input: {
-                backgroundColor: '#F7F8F9',
-                color: '#373F4A',
-                fontFamily: 'Helvetica Neue',
-                fontSize: '16px',
-                fontWeight: 'normal'
-            }
-        },
-        onValidationChange: (isReadyToPay: boolean) => {
-            if (isReadyToPay) {
-                // Show or hide some component or message...
-            }
-        }
-    },
-});
-```
-
-## Table of contents
-
-### Properties
-
-- [containerId](SquareV2PaymentInitializeOptions.md#containerid)
-- [style](SquareV2PaymentInitializeOptions.md#style)
-
-### Methods
-
-- [onValidationChange](SquareV2PaymentInitializeOptions.md#onvalidationchange)
-
-## Properties
-
-### containerId
-
-• **containerId**: `string`
-
-The ID of a container which the payment widget should insert into.
-
-___
-
-### style
-
-• `Optional` **style**: `CardClassSelectors`
-
-A map of .css classes and values that customize the style of the
-input fields from the card element.
-
-For more information about applying custom styles to the card form, see
-the available [CardClassSelectors](https://developer.squareup.com/reference/sdks/web/payments/objects/CardClassSelectors)
-for styling.
-
-## Methods
-
-### onValidationChange
-
-▸ `Optional` **onValidationChange**(`isReadyToPay`): `void`
-
-A callback that gets called when the validity of the
-payment component changes.
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `isReadyToPay` | `boolean` |
-
-#### Returns
-
-`void`

package/docs/interfaces/StepStyles.md

@@ -1,120 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / StepStyles
-
-# Interface: StepStyles
-
-## Hierarchy
-
-- [`BlockElementStyles`](BlockElementStyles.md)
-
-  ↳ **`StepStyles`**
-
-## Table of contents
-
-### Properties
-
-- [backgroundColor](StepStyles.md#backgroundcolor)
-- [borderColor](StepStyles.md#bordercolor)
-- [borderWidth](StepStyles.md#borderwidth)
-- [boxShadow](StepStyles.md#boxshadow)
-- [color](StepStyles.md#color)
-- [fontFamily](StepStyles.md#fontfamily)
-- [fontWeight](StepStyles.md#fontweight)
-- [icon](StepStyles.md#icon)
-- [letterSpacing](StepStyles.md#letterspacing)
-- [lineHeight](StepStyles.md#lineheight)
-
-## Properties
-
-### backgroundColor
-
-• `Optional` **backgroundColor**: `string`
-
-#### Inherited from
-
-[BlockElementStyles](BlockElementStyles.md).[backgroundColor](BlockElementStyles.md#backgroundcolor)
-
-___
-
-### borderColor
-
-• `Optional` **borderColor**: `string`
-
-#### Inherited from
-
-[BlockElementStyles](BlockElementStyles.md).[borderColor](BlockElementStyles.md#bordercolor)
-
-___
-
-### borderWidth
-
-• `Optional` **borderWidth**: `string`
-
-#### Inherited from
-
-[BlockElementStyles](BlockElementStyles.md).[borderWidth](BlockElementStyles.md#borderwidth)
-
-___
-
-### boxShadow
-
-• `Optional` **boxShadow**: `string`
-
-#### Inherited from
-
-[BlockElementStyles](BlockElementStyles.md).[boxShadow](BlockElementStyles.md#boxshadow)
-
-___
-
-### color
-
-• `Optional` **color**: `string`
-
-#### Inherited from
-
-[BlockElementStyles](BlockElementStyles.md).[color](BlockElementStyles.md#color)
-
-___
-
-### fontFamily
-
-• `Optional` **fontFamily**: `string`
-
-#### Inherited from
-
-[BlockElementStyles](BlockElementStyles.md).[fontFamily](BlockElementStyles.md#fontfamily)
-
-___
-
-### fontWeight
-
-• `Optional` **fontWeight**: `string`
-
-#### Inherited from
-
-[BlockElementStyles](BlockElementStyles.md).[fontWeight](BlockElementStyles.md#fontweight)
-
-___
-
-### icon
-
-• `Optional` **icon**: [`BlockElementStyles`](BlockElementStyles.md)
-
-___
-
-### letterSpacing
-
-• `Optional` **letterSpacing**: `string`
-
-#### Inherited from
-
-[BlockElementStyles](BlockElementStyles.md).[letterSpacing](BlockElementStyles.md#letterspacing)
-
-___
-
-### lineHeight
-
-• `Optional` **lineHeight**: `string`
-
-#### Inherited from
-
-[BlockElementStyles](BlockElementStyles.md).[lineHeight](BlockElementStyles.md#lineheight)

package/docs/interfaces/StepTracker.md

@@ -1,64 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / StepTracker
-
-# Interface: StepTracker
-
-## Table of contents
-
-### Methods
-
-- [trackCheckoutStarted](StepTracker.md#trackcheckoutstarted)
-- [trackOrderComplete](StepTracker.md#trackordercomplete)
-- [trackStepCompleted](StepTracker.md#trackstepcompleted)
-- [trackStepViewed](StepTracker.md#trackstepviewed)
-
-## Methods
-
-### trackCheckoutStarted
-
-▸ **trackCheckoutStarted**(): `void`
-
-#### Returns
-
-`void`
-
-___
-
-### trackOrderComplete
-
-▸ **trackOrderComplete**(): `void`
-
-#### Returns
-
-`void`
-
-___
-
-### trackStepCompleted
-
-▸ **trackStepCompleted**(`step`): `void`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `step` | `string` |
-
-#### Returns
-
-`void`
-
-___
-
-### trackStepViewed
-
-▸ **trackStepViewed**(`step`): `void`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `step` | `string` |
-
-#### Returns
-
-`void`

package/docs/interfaces/StepTrackerConfig.md

@@ -1,15 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / StepTrackerConfig
-
-# Interface: StepTrackerConfig
-
-## Table of contents
-
-### Properties
-
-- [checkoutSteps](StepTrackerConfig.md#checkoutsteps)
-
-## Properties
-
-### checkoutSteps
-
-• `Optional` **checkoutSteps**: [`AnalyticStepType`](../README.md#analyticsteptype)[]

package/docs/interfaces/StoreConfig.md

@@ -1,116 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / StoreConfig
-
-# Interface: StoreConfig
-
-## Table of contents
-
-### Properties
-
-- [cdnPath](StoreConfig.md#cdnpath)
-- [checkoutSettings](StoreConfig.md#checkoutsettings)
-- [currency](StoreConfig.md#currency)
-- [displayDateFormat](StoreConfig.md#displaydateformat)
-- [displaySettings](StoreConfig.md#displaysettings)
-- [formFields](StoreConfig.md#formfields)
-- [imageDirectory](StoreConfig.md#imagedirectory)
-- [inputDateFormat](StoreConfig.md#inputdateformat)
-- [isAngularDebuggingEnabled](StoreConfig.md#isangulardebuggingenabled)
-- [links](StoreConfig.md#links)
-- [paymentSettings](StoreConfig.md#paymentsettings)
-- [shopperConfig](StoreConfig.md#shopperconfig)
-- [shopperCurrency](StoreConfig.md#shoppercurrency)
-- [storeProfile](StoreConfig.md#storeprofile)
-
-## Properties
-
-### cdnPath
-
-• **cdnPath**: `string`
-
-___
-
-### checkoutSettings
-
-• **checkoutSettings**: [`CheckoutSettings`](CheckoutSettings.md)
-
-___
-
-### currency
-
-• **currency**: [`StoreCurrency`](StoreCurrency.md)
-
-___
-
-### displayDateFormat
-
-• **displayDateFormat**: `string`
-
-___
-
-### displaySettings
-
-• **displaySettings**: [`DisplaySettings`](DisplaySettings.md)
-
-___
-
-### formFields
-
-• **formFields**: [`FormFields`](FormFields.md)
-
-**`deprecated`** Please use instead the data selectors
-
-**`remarks`**
-```js
-const data = CheckoutService.getState().data;
-const shippingAddressFields = data.getShippingAddressFields('US');
-const billingAddressFields = data.getBillingAddressFields('US');
-const customerAccountFields = data.getCustomerAccountFields();
-```
-
-___
-
-### imageDirectory
-
-• **imageDirectory**: `string`
-
-___
-
-### inputDateFormat
-
-• **inputDateFormat**: `string`
-
-___
-
-### isAngularDebuggingEnabled
-
-• **isAngularDebuggingEnabled**: `boolean`
-
-___
-
-### links
-
-• **links**: [`StoreLinks`](StoreLinks.md)
-
-___
-
-### paymentSettings
-
-• **paymentSettings**: [`PaymentSettings`](PaymentSettings.md)
-
-___
-
-### shopperConfig
-
-• **shopperConfig**: [`ShopperConfig`](ShopperConfig.md)
-
-___
-
-### shopperCurrency
-
-• **shopperCurrency**: [`ShopperCurrency`](ShopperCurrency.md)
-
-___
-
-### storeProfile
-
-• **storeProfile**: [`StoreProfile`](StoreProfile.md)

package/docs/interfaces/StoreCurrency.md

@@ -1,56 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / StoreCurrency
-
-# Interface: StoreCurrency
-
-## Hierarchy
-
-- **`StoreCurrency`**
-
-  ↳ [`ShopperCurrency`](ShopperCurrency.md)
-
-## Table of contents
-
-### Properties
-
-- [code](StoreCurrency.md#code)
-- [decimalPlaces](StoreCurrency.md#decimalplaces)
-- [decimalSeparator](StoreCurrency.md#decimalseparator)
-- [symbol](StoreCurrency.md#symbol)
-- [symbolLocation](StoreCurrency.md#symbollocation)
-- [thousandsSeparator](StoreCurrency.md#thousandsseparator)
-
-## Properties
-
-### code
-
-• **code**: `string`
-
-___
-
-### decimalPlaces
-
-• **decimalPlaces**: `string`
-
-___
-
-### decimalSeparator
-
-• **decimalSeparator**: `string`
-
-___
-
-### symbol
-
-• **symbol**: `string`
-
-___
-
-### symbolLocation
-
-• **symbolLocation**: `string`
-
-___
-
-### thousandsSeparator
-
-• **thousandsSeparator**: `string`

package/docs/interfaces/StoreLinks.md

@@ -1,57 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / StoreLinks
-
-# Interface: StoreLinks
-
-## Table of contents
-
-### Properties
-
-- [cartLink](StoreLinks.md#cartlink)
-- [checkoutLink](StoreLinks.md#checkoutlink)
-- [createAccountLink](StoreLinks.md#createaccountlink)
-- [forgotPasswordLink](StoreLinks.md#forgotpasswordlink)
-- [loginLink](StoreLinks.md#loginlink)
-- [orderConfirmationLink](StoreLinks.md#orderconfirmationlink)
-- [siteLink](StoreLinks.md#sitelink)
-
-## Properties
-
-### cartLink
-
-• **cartLink**: `string`
-
-___
-
-### checkoutLink
-
-• **checkoutLink**: `string`
-
-___
-
-### createAccountLink
-
-• **createAccountLink**: `string`
-
-___
-
-### forgotPasswordLink
-
-• **forgotPasswordLink**: `string`
-
-___
-
-### loginLink
-
-• **loginLink**: `string`
-
-___
-
-### orderConfirmationLink
-
-• **orderConfirmationLink**: `string`
-
-___
-
-### siteLink
-
-• **siteLink**: `string`