@bigcommerce/checkout-sdk 1.264.0 → 1.265.0

package/docs/interfaces/customeraddress.md

@@ -1,154 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) › [CustomerAddress](customeraddress.md)
-
-# Interface: CustomerAddress
-
-## Hierarchy
-
-  ↳ [Address](address.md)
-
-  ↳ **CustomerAddress**
-
-## Index
-
-### Properties
-
-* [address1](customeraddress.md#address1)
-* [address2](customeraddress.md#address2)
-* [city](customeraddress.md#city)
-* [company](customeraddress.md#company)
-* [country](customeraddress.md#country)
-* [countryCode](customeraddress.md#countrycode)
-* [customFields](customeraddress.md#customfields)
-* [firstName](customeraddress.md#firstname)
-* [id](customeraddress.md#id)
-* [lastName](customeraddress.md#lastname)
-* [phone](customeraddress.md#phone)
-* [postalCode](customeraddress.md#postalcode)
-* [shouldSaveAddress](customeraddress.md#optional-shouldsaveaddress)
-* [stateOrProvince](customeraddress.md#stateorprovince)
-* [stateOrProvinceCode](customeraddress.md#stateorprovincecode)
-* [type](customeraddress.md#type)
-
-## Properties
-
-###  address1
-
-• **address1**: *string*
-
-*Inherited from [Address](address.md).[address1](address.md#address1)*
-
-___
-
-###  address2
-
-• **address2**: *string*
-
-*Inherited from [Address](address.md).[address2](address.md#address2)*
-
-___
-
-###  city
-
-• **city**: *string*
-
-*Inherited from [Address](address.md).[city](address.md#city)*
-
-___
-
-###  company
-
-• **company**: *string*
-
-*Inherited from [Address](address.md).[company](address.md#company)*
-
-___
-
-###  country
-
-• **country**: *string*
-
-*Inherited from [Address](address.md).[country](address.md#country)*
-
-___
-
-###  countryCode
-
-• **countryCode**: *string*
-
-*Inherited from [Address](address.md).[countryCode](address.md#countrycode)*
-
-___
-
-###  customFields
-
-• **customFields**: *Array‹object›*
-
-*Inherited from [Address](address.md).[customFields](address.md#customfields)*
-
-___
-
-###  firstName
-
-• **firstName**: *string*
-
-*Inherited from [Address](address.md).[firstName](address.md#firstname)*
-
-___
-
-###  id
-
-• **id**: *number*
-
-___
-
-###  lastName
-
-• **lastName**: *string*
-
-*Inherited from [Address](address.md).[lastName](address.md#lastname)*
-
-___
-
-###  phone
-
-• **phone**: *string*
-
-*Inherited from [Address](address.md).[phone](address.md#phone)*
-
-___
-
-###  postalCode
-
-• **postalCode**: *string*
-
-*Inherited from [Address](address.md).[postalCode](address.md#postalcode)*
-
-___
-
-### `Optional` shouldSaveAddress
-
-• **shouldSaveAddress**? : *undefined | false | true*
-
-*Inherited from [Address](address.md).[shouldSaveAddress](address.md#optional-shouldsaveaddress)*
-
-___
-
-###  stateOrProvince
-
-• **stateOrProvince**: *string*
-
-*Inherited from [Address](address.md).[stateOrProvince](address.md#stateorprovince)*
-
-___
-
-###  stateOrProvinceCode
-
-• **stateOrProvinceCode**: *string*
-
-*Inherited from [Address](address.md).[stateOrProvinceCode](address.md#stateorprovincecode)*
-
-___
-
-###  type
-
-• **type**: *string*

package/docs/interfaces/customercredentials.md

@@ -1,26 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) › [CustomerCredentials](customercredentials.md)
-
-# Interface: CustomerCredentials
-
-## Hierarchy
-
-* **CustomerCredentials**
-
-## Index
-
-### Properties
-
-* [email](customercredentials.md#email)
-* [password](customercredentials.md#password)
-
-## Properties
-
-###  email
-
-• **email**: *string*
-
-___
-
-###  password
-
-• **password**: *string*

package/docs/interfaces/customergroup.md

@@ -1,26 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) › [CustomerGroup](customergroup.md)
-
-# Interface: CustomerGroup
-
-## Hierarchy
-
-* **CustomerGroup**
-
-## Index
-
-### Properties
-
-* [id](customergroup.md#id)
-* [name](customergroup.md#name)
-
-## Properties
-
-###  id
-
-• **id**: *number*
-
-___
-
-###  name
-
-• **name**: *string*

package/docs/interfaces/customerinitializeoptions.md

@@ -1,219 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) › [CustomerInitializeOptions](customerinitializeoptions.md)
-
-# Interface: CustomerInitializeOptions ‹**TParams**›
-
-A set of options that are required to initialize the customer step of the
-current checkout flow.
-
-Some payment methods have specific requirements for setting the customer
-details for checkout. For example, Amazon Pay requires the customer to sign in
-using their sign-in button. As a result, you may need to provide additional
-information in order to initialize the customer step of checkout.
-
-## Type parameters
-
-▪ **TParams**
-
-## Hierarchy
-
-  ↳ [CustomerRequestOptions](customerrequestoptions.md)
-
-  ↳ **CustomerInitializeOptions**
-
-## Index
-
-### Properties
-
-* [amazon](customerinitializeoptions.md#optional-amazon)
-* [amazonpay](customerinitializeoptions.md#optional-amazonpay)
-* [applepay](customerinitializeoptions.md#optional-applepay)
-* [bolt](customerinitializeoptions.md#optional-bolt)
-* [braintreevisacheckout](customerinitializeoptions.md#optional-braintreevisacheckout)
-* [chasepay](customerinitializeoptions.md#optional-chasepay)
-* [googlepayadyenv2](customerinitializeoptions.md#optional-googlepayadyenv2)
-* [googlepayadyenv3](customerinitializeoptions.md#optional-googlepayadyenv3)
-* [googlepayauthorizenet](customerinitializeoptions.md#optional-googlepayauthorizenet)
-* [googlepaybraintree](customerinitializeoptions.md#optional-googlepaybraintree)
-* [googlepaycheckoutcom](customerinitializeoptions.md#optional-googlepaycheckoutcom)
-* [googlepaycybersourcev2](customerinitializeoptions.md#optional-googlepaycybersourcev2)
-* [googlepayorbital](customerinitializeoptions.md#optional-googlepayorbital)
-* [googlepaystripe](customerinitializeoptions.md#optional-googlepaystripe)
-* [googlepaystripeupe](customerinitializeoptions.md#optional-googlepaystripeupe)
-* [masterpass](customerinitializeoptions.md#optional-masterpass)
-* [methodId](customerinitializeoptions.md#optional-methodid)
-* [params](customerinitializeoptions.md#optional-params)
-* [timeout](customerinitializeoptions.md#optional-timeout)
-
-## Properties
-
-### `Optional` amazon
-
-• **amazon**? : *[AmazonPayCustomerInitializeOptions](amazonpaycustomerinitializeoptions.md)*
-
-The options that are required to initialize the customer step of checkout
-when using Amazon Pay.
-
-___
-
-### `Optional` amazonpay
-
-• **amazonpay**? : *[AmazonPayV2CustomerInitializeOptions](amazonpayv2customerinitializeoptions.md)*
-
-The options that are required to initialize the customer step of checkout
-when using AmazonPayV2.
-
-___
-
-### `Optional` applepay
-
-• **applepay**? : *[ApplePayCustomerInitializeOptions](applepaycustomerinitializeoptions.md)*
-
-The options that are required to initialize the customer step of checkout
-when using ApplePay.
-
-___
-
-### `Optional` bolt
-
-• **bolt**? : *[BoltCustomerInitializeOptions](boltcustomerinitializeoptions.md)*
-
-The options that are required to initialize the customer step of checkout
-when using Bolt.
-
-___
-
-### `Optional` braintreevisacheckout
-
-• **braintreevisacheckout**? : *[BraintreeVisaCheckoutCustomerInitializeOptions](braintreevisacheckoutcustomerinitializeoptions.md)*
-
-The options that are required to initialize the customer step of checkout
-when using Visa Checkout provided by Braintree.
-
-___
-
-### `Optional` chasepay
-
-• **chasepay**? : *[ChasePayCustomerInitializeOptions](chasepaycustomerinitializeoptions.md)*
-
-The options that are required to initialize the Chasepay payment method.
-They can be omitted unless you need to support Chasepay.
-
-___
-
-### `Optional` googlepayadyenv2
-
-• **googlepayadyenv2**? : *[GooglePayCustomerInitializeOptions](googlepaycustomerinitializeoptions.md)*
-
-The options that are required to initialize the GooglePay payment method.
-They can be omitted unless you need to support GooglePay.
-
-___
-
-### `Optional` googlepayadyenv3
-
-• **googlepayadyenv3**? : *[GooglePayCustomerInitializeOptions](googlepaycustomerinitializeoptions.md)*
-
-The options that are required to initialize the GooglePay payment method.
-They can be omitted unless you need to support GooglePay.
-
-___
-
-### `Optional` googlepayauthorizenet
-
-• **googlepayauthorizenet**? : *[GooglePayCustomerInitializeOptions](googlepaycustomerinitializeoptions.md)*
-
-The options that are required to initialize the GooglePay payment method.
-They can be omitted unless you need to support GooglePay.
-
-___
-
-### `Optional` googlepaybraintree
-
-• **googlepaybraintree**? : *[GooglePayCustomerInitializeOptions](googlepaycustomerinitializeoptions.md)*
-
-The options that are required to initialize the GooglePay payment method.
-They can be omitted unless you need to support GooglePay.
-
-___
-
-### `Optional` googlepaycheckoutcom
-
-• **googlepaycheckoutcom**? : *[GooglePayCustomerInitializeOptions](googlepaycustomerinitializeoptions.md)*
-
-The options that are required to initialize the GooglePay payment method.
-They can be omitted unless you need to support GooglePay.
-
-___
-
-### `Optional` googlepaycybersourcev2
-
-• **googlepaycybersourcev2**? : *[GooglePayCustomerInitializeOptions](googlepaycustomerinitializeoptions.md)*
-
-The options that are required to initialize the GooglePay payment method.
-They can be omitted unless you need to support GooglePay.
-
-___
-
-### `Optional` googlepayorbital
-
-• **googlepayorbital**? : *[GooglePayCustomerInitializeOptions](googlepaycustomerinitializeoptions.md)*
-
-The options that are required to initialize the GooglePay payment method.
-They can be omitted unless you need to support GooglePay.
-
-___
-
-### `Optional` googlepaystripe
-
-• **googlepaystripe**? : *[GooglePayCustomerInitializeOptions](googlepaycustomerinitializeoptions.md)*
-
-The options that are required to initialize the GooglePay payment method.
-They can be omitted unless you need to support GooglePay.
-
-___
-
-### `Optional` googlepaystripeupe
-
-• **googlepaystripeupe**? : *[GooglePayCustomerInitializeOptions](googlepaycustomerinitializeoptions.md)*
-
-The options that are required to initialize the GooglePay payment method.
-They can be omitted unless you need to support GooglePay.
-
-___
-
-### `Optional` masterpass
-
-• **masterpass**? : *[MasterpassCustomerInitializeOptions](masterpasscustomerinitializeoptions.md)*
-
-The options that are required to initialize the Masterpass payment method.
-They can be omitted unless you need to support Masterpass.
-
-___
-
-### `Optional` methodId
-
-• **methodId**? : *undefined | string*
-
-*Inherited from [CustomerInitializeOptions](customerinitializeoptions.md).[methodId](customerinitializeoptions.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/customerpasswordrequirements.md

@@ -1,40 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) › [CustomerPasswordRequirements](customerpasswordrequirements.md)
-
-# Interface: CustomerPasswordRequirements
-
-## Hierarchy
-
-* **CustomerPasswordRequirements**
-
-## Index
-
-### Properties
-
-* [alpha](customerpasswordrequirements.md#alpha)
-* [description](customerpasswordrequirements.md#description)
-* [minlength](customerpasswordrequirements.md#minlength)
-* [numeric](customerpasswordrequirements.md#numeric)
-
-## Properties
-
-###  alpha
-
-• **alpha**: *string*
-
-___
-
-###  description
-
-• **description**: *string*
-
-___
-
-###  minlength
-
-• **minlength**: *number*
-
-___
-
-###  numeric
-
-• **numeric**: *string*

package/docs/interfaces/customerrequestoptions.md

@@ -1,60 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) › [CustomerRequestOptions](customerrequestoptions.md)
-
-# Interface: CustomerRequestOptions ‹**TParams**›
-
-A set of options for configuring any requests related to the customer step of
-the current checkout flow.
-
-Some payment methods have their own sign-in or sign-out flow. Therefore, you
-need to indicate the method you want to use if you need to trigger a specific
-flow for signing in or out a customer. Otherwise, these options are not required.
-
-## Type parameters
-
-▪ **TParams**
-
-## Hierarchy
-
-* [RequestOptions](requestoptions.md)
-
-  ↳ **CustomerRequestOptions**
-
-  ↳ [CustomerInitializeOptions](customerinitializeoptions.md)
-
-  ↳ [ExecutePaymentMethodCheckoutOptions](executepaymentmethodcheckoutoptions.md)
-
-## Index
-
-### Properties
-
-* [methodId](customerrequestoptions.md#optional-methodid)
-* [params](customerrequestoptions.md#optional-params)
-* [timeout](customerrequestoptions.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/customerror.md

@@ -1,68 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) › [CustomError](customerror.md)
-
-# Interface: CustomError
-
-## Hierarchy
-
-* [Error](amazonpaywidgeterror.md#error)
-
-  ↳ **CustomError**
-
-## Implemented by
-
-* [CartChangedError](../classes/cartchangederror.md)
-* [RequestError](../classes/requesterror.md)
-* [StandardError](../classes/standarderror.md)
-
-## Index
-
-### Properties
-
-* [Error](customerror.md#error)
-* [message](customerror.md#message)
-* [name](customerror.md#name)
-* [stack](customerror.md#optional-stack)
-* [subtype](customerror.md#optional-subtype)
-* [type](customerror.md#type)
-
-## Properties
-
-###  Error
-
-• **Error**: *ErrorConstructor*
-
-___
-
-###  message
-
-• **message**: *string*
-
-*Overrides [AmazonPayWidgetError](amazonpaywidgeterror.md).[message](amazonpaywidgeterror.md#message)*
-
-___
-
-###  name
-
-• **name**: *string*
-
-*Inherited from [AmazonPayWidgetError](amazonpaywidgeterror.md).[name](amazonpaywidgeterror.md#name)*
-
-___
-
-### `Optional` stack
-
-• **stack**? : *undefined | string*
-
-*Inherited from [AmazonPayWidgetError](amazonpaywidgeterror.md).[stack](amazonpaywidgeterror.md#optional-stack)*
-
-___
-
-### `Optional` subtype
-
-• **subtype**? : *undefined | string*
-
-___
-
-###  type
-
-• **type**: *string*

package/docs/interfaces/customitem.md

@@ -1,54 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) › [CustomItem](customitem.md)
-
-# Interface: CustomItem
-
-## Hierarchy
-
-* **CustomItem**
-
-## Index
-
-### Properties
-
-* [extendedListPrice](customitem.md#extendedlistprice)
-* [id](customitem.md#id)
-* [listPrice](customitem.md#listprice)
-* [name](customitem.md#name)
-* [quantity](customitem.md#quantity)
-* [sku](customitem.md#sku)
-
-## Properties
-
-###  extendedListPrice
-
-• **extendedListPrice**: *number*
-
-___
-
-###  id
-
-• **id**: *string*
-
-___
-
-###  listPrice
-
-• **listPrice**: *number*
-
-___
-
-###  name
-
-• **name**: *string*
-
-___
-
-###  quantity
-
-• **quantity**: *number*
-
-___
-
-###  sku
-
-• **sku**: *string*