@bigcommerce/checkout-sdk 1.264.0 → 1.265.0

package/docs/interfaces/shippinginitializeoptions.md

@@ -1,80 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) › [ShippingInitializeOptions](shippinginitializeoptions.md)
-
-# Interface: ShippingInitializeOptions ‹**T**›
-
-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
-
-▪ **T**
-
-## Hierarchy
-
-  ↳ [ShippingRequestOptions](shippingrequestoptions.md)‹T›
-
-  ↳ **ShippingInitializeOptions**
-
-## Index
-
-### Properties
-
-* [amazon](shippinginitializeoptions.md#optional-amazon)
-* [amazonpay](shippinginitializeoptions.md#optional-amazonpay)
-* [methodId](shippinginitializeoptions.md#optional-methodid)
-* [params](shippinginitializeoptions.md#optional-params)
-* [timeout](shippinginitializeoptions.md#optional-timeout)
-
-## Properties
-
-### `Optional` amazon
-
-• **amazon**? : *[AmazonPayShippingInitializeOptions](amazonpayshippinginitializeoptions.md)*
-
-The options that are required to initialize the shipping step of checkout
-when using Amazon Pay.
-
-___
-
-### `Optional` amazonpay
-
-• **amazonpay**? : *[AmazonPayV2ShippingInitializeOptions](amazonpayv2shippinginitializeoptions.md)*
-
-The options that are required to initialize the shipping step of checkout
-when using AmazonPayV2.
-
-___
-
-### `Optional` methodId
-
-• **methodId**? : *undefined | string*
-
-*Inherited from [ShippingInitializeOptions](shippinginitializeoptions.md).[methodId](shippinginitializeoptions.md#optional-methodid)*
-
-___
-
-### `Optional` params
-
-• **params**? : *TParams*
-
-*Inherited from [CheckoutButtonInitializeOptions](checkoutbuttoninitializeoptions.md).[params](checkoutbuttoninitializeoptions.md#optional-params)*
-
-The parameters of the request, if required.
-
-___
-
-### `Optional` timeout
-
-• **timeout**? : *Timeout*
-
-*Inherited from [CheckoutButtonInitializeOptions](checkoutbuttoninitializeoptions.md).[timeout](checkoutbuttoninitializeoptions.md#optional-timeout)*
-
-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.

package/docs/interfaces/shippingoption.md

@@ -1,68 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) › [ShippingOption](shippingoption.md)
-
-# Interface: ShippingOption
-
-## Hierarchy
-
-* **ShippingOption**
-
-## Index
-
-### Properties
-
-* [additionalDescription](shippingoption.md#additionaldescription)
-* [cost](shippingoption.md#cost)
-* [description](shippingoption.md#description)
-* [id](shippingoption.md#id)
-* [imageUrl](shippingoption.md#imageurl)
-* [isRecommended](shippingoption.md#isrecommended)
-* [transitTime](shippingoption.md#transittime)
-* [type](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/shippingrequestoptions.md

@@ -1,59 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) › [ShippingRequestOptions](shippingrequestoptions.md)
-
-# Interface: ShippingRequestOptions ‹**T**›
-
-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
-
-▪ **T**
-
-## Hierarchy
-
-* [RequestOptions](requestoptions.md)‹T›
-
-  ↳ **ShippingRequestOptions**
-
-  ↳ [ShippingInitializeOptions](shippinginitializeoptions.md)
-
-## Index
-
-### Properties
-
-* [methodId](shippingrequestoptions.md#optional-methodid)
-* [params](shippingrequestoptions.md#optional-params)
-* [timeout](shippingrequestoptions.md#optional-timeout)
-
-## Properties
-
-### `Optional` methodId
-
-• **methodId**? : *undefined | string*
-
-___
-
-### `Optional` params
-
-• **params**? : *TParams*
-
-*Inherited from [CheckoutButtonInitializeOptions](checkoutbuttoninitializeoptions.md).[params](checkoutbuttoninitializeoptions.md#optional-params)*
-
-The parameters of the request, if required.
-
-___
-
-### `Optional` timeout
-
-• **timeout**? : *Timeout*
-
-*Inherited from [CheckoutButtonInitializeOptions](checkoutbuttoninitializeoptions.md).[timeout](checkoutbuttoninitializeoptions.md#optional-timeout)*
-
-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.

package/docs/interfaces/shopperconfig.md

@@ -1,33 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) › [ShopperConfig](shopperconfig.md)
-
-# Interface: ShopperConfig
-
-## Hierarchy
-
-* **ShopperConfig**
-
-## Index
-
-### Properties
-
-* [defaultNewsletterSignup](shopperconfig.md#defaultnewslettersignup)
-* [passwordRequirements](shopperconfig.md#passwordrequirements)
-* [showNewsletterSignup](shopperconfig.md#shownewslettersignup)
-
-## Properties
-
-###  defaultNewsletterSignup
-
-• **defaultNewsletterSignup**: *boolean*
-
-___
-
-###  passwordRequirements
-
-• **passwordRequirements**: *[PasswordRequirements](passwordrequirements.md)*
-
-___
-
-###  showNewsletterSignup
-
-• **showNewsletterSignup**: *boolean*

package/docs/interfaces/shoppercurrency.md

@@ -1,82 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) › [ShopperCurrency](shoppercurrency.md)
-
-# Interface: ShopperCurrency
-
-## Hierarchy
-
-* [StoreCurrency](storecurrency.md)
-
-  ↳ **ShopperCurrency**
-
-## Index
-
-### Properties
-
-* [code](shoppercurrency.md#code)
-* [decimalPlaces](shoppercurrency.md#decimalplaces)
-* [decimalSeparator](shoppercurrency.md#decimalseparator)
-* [exchangeRate](shoppercurrency.md#exchangerate)
-* [isTransactional](shoppercurrency.md#istransactional)
-* [symbol](shoppercurrency.md#symbol)
-* [symbolLocation](shoppercurrency.md#symbollocation)
-* [thousandsSeparator](shoppercurrency.md#thousandsseparator)
-
-## Properties
-
-###  code
-
-• **code**: *string*
-
-*Inherited from [ShopperCurrency](shoppercurrency.md).[code](shoppercurrency.md#code)*
-
-___
-
-###  decimalPlaces
-
-• **decimalPlaces**: *string*
-
-*Inherited from [ShopperCurrency](shoppercurrency.md).[decimalPlaces](shoppercurrency.md#decimalplaces)*
-
-___
-
-###  decimalSeparator
-
-• **decimalSeparator**: *string*
-
-*Inherited from [ShopperCurrency](shoppercurrency.md).[decimalSeparator](shoppercurrency.md#decimalseparator)*
-
-___
-
-###  exchangeRate
-
-• **exchangeRate**: *number*
-
-___
-
-###  isTransactional
-
-• **isTransactional**: *boolean*
-
-___
-
-###  symbol
-
-• **symbol**: *string*
-
-*Inherited from [ShopperCurrency](shoppercurrency.md).[symbol](shoppercurrency.md#symbol)*
-
-___
-
-###  symbolLocation
-
-• **symbolLocation**: *string*
-
-*Inherited from [ShopperCurrency](shoppercurrency.md).[symbolLocation](shoppercurrency.md#symbollocation)*
-
-___
-
-###  thousandsSeparator
-
-• **thousandsSeparator**: *string*
-
-*Inherited from [ShopperCurrency](shoppercurrency.md).[thousandsSeparator](shoppercurrency.md#thousandsseparator)*

package/docs/interfaces/signinemail.md

@@ -1,26 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) › [SignInEmail](signinemail.md)
-
-# Interface: SignInEmail
-
-## Hierarchy
-
-* **SignInEmail**
-
-## Index
-
-### Properties
-
-* [expiry](signinemail.md#expiry)
-* [sent_email](signinemail.md#sent_email)
-
-## Properties
-
-###  expiry
-
-• **expiry**: *number*
-
-___
-
-###  sent_email
-
-• **sent_email**: *string*

package/docs/interfaces/signinemailrequestbody.md

@@ -1,26 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) › [SignInEmailRequestBody](signinemailrequestbody.md)
-
-# Interface: SignInEmailRequestBody
-
-## Hierarchy
-
-* **SignInEmailRequestBody**
-
-## Index
-
-### Properties
-
-* [email](signinemailrequestbody.md#email)
-* [redirectUrl](signinemailrequestbody.md#optional-redirecturl)
-
-## Properties
-
-###  email
-
-• **email**: *string*
-
-___
-
-### `Optional` redirectUrl
-
-• **redirectUrl**? : *undefined | string*

package/docs/interfaces/spamprotectionoptions.md

@@ -1,97 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) › [SpamProtectionOptions](spamprotectionoptions.md)
-
-# Interface: SpamProtectionOptions
-
-The set of options for configuring any requests related to spam protection.
-
-## Hierarchy
-
-* RequestOptions
-
-  ↳ **SpamProtectionOptions**
-
-## Index
-
-### Properties
-
-* [body](spamprotectionoptions.md#optional-body)
-* [cache](spamprotectionoptions.md#optional-cache)
-* [containerId](spamprotectionoptions.md#containerid)
-* [credentials](spamprotectionoptions.md#optional-credentials)
-* [encodeParams](spamprotectionoptions.md#optional-encodeparams)
-* [headers](spamprotectionoptions.md#optional-headers)
-* [method](spamprotectionoptions.md#optional-method)
-* [params](spamprotectionoptions.md#optional-params)
-* [timeout](spamprotectionoptions.md#optional-timeout)
-
-## Properties
-
-### `Optional` body
-
-• **body**? : *any*
-
-*Inherited from [SpamProtectionOptions](spamprotectionoptions.md).[body](spamprotectionoptions.md#optional-body)*
-
-___
-
-### `Optional` cache
-
-• **cache**? : *undefined | false | true*
-
-*Inherited from [SpamProtectionOptions](spamprotectionoptions.md).[cache](spamprotectionoptions.md#optional-cache)*
-
-___
-
-###  containerId
-
-• **containerId**: *string*
-
-The container ID where the spam protection should be rendered.
-
-___
-
-### `Optional` credentials
-
-• **credentials**? : *undefined | false | true*
-
-*Inherited from [SpamProtectionOptions](spamprotectionoptions.md).[credentials](spamprotectionoptions.md#optional-credentials)*
-
-___
-
-### `Optional` encodeParams
-
-• **encodeParams**? : *undefined | false | true*
-
-*Inherited from [SpamProtectionOptions](spamprotectionoptions.md).[encodeParams](spamprotectionoptions.md#optional-encodeparams)*
-
-___
-
-### `Optional` headers
-
-• **headers**? : *Headers*
-
-*Inherited from [SpamProtectionOptions](spamprotectionoptions.md).[headers](spamprotectionoptions.md#optional-headers)*
-
-___
-
-### `Optional` method
-
-• **method**? : *undefined | string*
-
-*Inherited from [SpamProtectionOptions](spamprotectionoptions.md).[method](spamprotectionoptions.md#optional-method)*
-
-___
-
-### `Optional` params
-
-• **params**? : *undefined | object*
-
-*Inherited from [SpamProtectionOptions](spamprotectionoptions.md).[params](spamprotectionoptions.md#optional-params)*
-
-___
-
-### `Optional` timeout
-
-• **timeout**? : *Timeout | Promise‹any›*
-
-*Inherited from [SpamProtectionOptions](spamprotectionoptions.md).[timeout](spamprotectionoptions.md#optional-timeout)*

package/docs/interfaces/squareformelement.md

@@ -1,32 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) › [SquareFormElement](squareformelement.md)
-
-# Interface: SquareFormElement
-
-Configures any form element provided by Square payment.
-
-## Hierarchy
-
-* **SquareFormElement**
-
-## Index
-
-### Properties
-
-* [elementId](squareformelement.md#elementid)
-* [placeholder](squareformelement.md#optional-placeholder)
-
-## Properties
-
-###  elementId
-
-• **elementId**: *string*
-
-The ID of the container which the form element should insert into.
-
-___
-
-### `Optional` placeholder
-
-• **placeholder**? : *undefined | string*
-
-The placeholder text to use for the form element, if provided.

package/docs/interfaces/stepstyles.md

@@ -1,102 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) › [StepStyles](stepstyles.md)
-
-# Interface: StepStyles
-
-## Hierarchy
-
-  ↳ [BlockElementStyles](blockelementstyles.md)
-
-  ↳ **StepStyles**
-
-## Index
-
-### Properties
-
-* [backgroundColor](stepstyles.md#optional-backgroundcolor)
-* [borderColor](stepstyles.md#optional-bordercolor)
-* [borderWidth](stepstyles.md#optional-borderwidth)
-* [boxShadow](stepstyles.md#optional-boxshadow)
-* [color](stepstyles.md#optional-color)
-* [fontFamily](stepstyles.md#optional-fontfamily)
-* [fontWeight](stepstyles.md#optional-fontweight)
-* [icon](stepstyles.md#optional-icon)
-* [letterSpacing](stepstyles.md#optional-letterspacing)
-* [lineHeight](stepstyles.md#optional-lineheight)
-
-## Properties
-
-### `Optional` backgroundColor
-
-• **backgroundColor**? : *undefined | string*
-
-*Inherited from [BlockElementStyles](blockelementstyles.md).[backgroundColor](blockelementstyles.md#optional-backgroundcolor)*
-
-___
-
-### `Optional` borderColor
-
-• **borderColor**? : *undefined | string*
-
-*Inherited from [BlockElementStyles](blockelementstyles.md).[borderColor](blockelementstyles.md#optional-bordercolor)*
-
-___
-
-### `Optional` borderWidth
-
-• **borderWidth**? : *undefined | string*
-
-*Inherited from [BlockElementStyles](blockelementstyles.md).[borderWidth](blockelementstyles.md#optional-borderwidth)*
-
-___
-
-### `Optional` boxShadow
-
-• **boxShadow**? : *undefined | string*
-
-*Inherited from [BlockElementStyles](blockelementstyles.md).[boxShadow](blockelementstyles.md#optional-boxshadow)*
-
-___
-
-### `Optional` color
-
-• **color**? : *undefined | string*
-
-*Inherited from [BlockElementStyles](blockelementstyles.md).[color](blockelementstyles.md#optional-color)*
-
-___
-
-### `Optional` fontFamily
-
-• **fontFamily**? : *undefined | string*
-
-*Inherited from [BlockElementStyles](blockelementstyles.md).[fontFamily](blockelementstyles.md#optional-fontfamily)*
-
-___
-
-### `Optional` fontWeight
-
-• **fontWeight**? : *undefined | string*
-
-*Inherited from [BlockElementStyles](blockelementstyles.md).[fontWeight](blockelementstyles.md#optional-fontweight)*
-
-___
-
-### `Optional` icon
-
-• **icon**? : *[BlockElementStyles](blockelementstyles.md)*
-
-___
-
-### `Optional` letterSpacing
-
-• **letterSpacing**? : *undefined | string*
-
-*Inherited from [BlockElementStyles](blockelementstyles.md).[letterSpacing](blockelementstyles.md#optional-letterspacing)*
-
-___
-
-### `Optional` lineHeight
-
-• **lineHeight**? : *undefined | string*
-
-*Inherited from [BlockElementStyles](blockelementstyles.md).[lineHeight](blockelementstyles.md#optional-lineheight)*

package/docs/interfaces/steptracker.md

@@ -1,60 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) › [StepTracker](steptracker.md)
-
-# Interface: StepTracker
-
-## Hierarchy
-
-* **StepTracker**
-
-## Index
-
-### 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`: string): *void*
-
-**Parameters:**
-
-Name | Type |
------- | ------ |
-`step` | string |
-
-**Returns:** *void*
-
-___
-
-###  trackStepViewed
-
-▸ **trackStepViewed**(`step`: string): *void*
-
-**Parameters:**
-
-Name | Type |
------- | ------ |
-`step` | string |
-
-**Returns:** *void*

package/docs/interfaces/steptrackerconfig.md

@@ -1,19 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) › [StepTrackerConfig](steptrackerconfig.md)
-
-# Interface: StepTrackerConfig
-
-## Hierarchy
-
-* **StepTrackerConfig**
-
-## Index
-
-### Properties
-
-* [checkoutSteps](steptrackerconfig.md#optional-checkoutsteps)
-
-## Properties
-
-### `Optional` checkoutSteps
-
-• **checkoutSteps**? : *[AnalyticStepType](../README.md#analyticsteptype)[]*