@bigcommerce/checkout-sdk 1.271.2 → 1.272.1

package/docs/interfaces/CustomerAddress.md

@@ -0,0 +1,182 @@
+[@bigcommerce/checkout-sdk](../README.md) / CustomerAddress
+
+# Interface: CustomerAddress
+
+## Hierarchy
+
+- [`Address`](Address.md)
+
+  ↳ **`CustomerAddress`**
+
+## Table of contents
+
+### 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#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**: { `fieldId`: `string` ; `fieldValue`: `string` \| `number` \| `string`[]  }[]
+
+#### 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)
+
+___
+
+### shouldSaveAddress
+
+• `Optional` **shouldSaveAddress**: `boolean`
+
+#### Inherited from
+
+[Address](Address.md).[shouldSaveAddress](Address.md#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

@@ -0,0 +1,22 @@
+[@bigcommerce/checkout-sdk](../README.md) / CustomerCredentials
+
+# Interface: CustomerCredentials
+
+## Table of contents
+
+### Properties
+
+- [email](CustomerCredentials.md#email)
+- [password](CustomerCredentials.md#password)
+
+## Properties
+
+### email
+
+• **email**: `string`
+
+___
+
+### password
+
+• **password**: `string`

package/docs/interfaces/CustomerGroup.md

@@ -0,0 +1,22 @@
+[@bigcommerce/checkout-sdk](../README.md) / CustomerGroup
+
+# Interface: CustomerGroup
+
+## Table of contents
+
+### Properties
+
+- [id](CustomerGroup.md#id)
+- [name](CustomerGroup.md#name)
+
+## Properties
+
+### id
+
+• **id**: `number`
+
+___
+
+### name
+
+• **name**: `string`

package/docs/interfaces/CustomerInitializeOptions.md

@@ -0,0 +1,221 @@
+[@bigcommerce/checkout-sdk](../README.md) / CustomerInitializeOptions
+
+# Interface: CustomerInitializeOptions
+
+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.
+
+## Hierarchy
+
+- [`CustomerRequestOptions`](CustomerRequestOptions.md)
+
+  ↳ **`CustomerInitializeOptions`**
+
+## Table of contents
+
+### Properties
+
+- [amazon](CustomerInitializeOptions.md#amazon)
+- [amazonpay](CustomerInitializeOptions.md#amazonpay)
+- [applepay](CustomerInitializeOptions.md#applepay)
+- [bolt](CustomerInitializeOptions.md#bolt)
+- [braintreevisacheckout](CustomerInitializeOptions.md#braintreevisacheckout)
+- [chasepay](CustomerInitializeOptions.md#chasepay)
+- [googlepayadyenv2](CustomerInitializeOptions.md#googlepayadyenv2)
+- [googlepayadyenv3](CustomerInitializeOptions.md#googlepayadyenv3)
+- [googlepayauthorizenet](CustomerInitializeOptions.md#googlepayauthorizenet)
+- [googlepaybraintree](CustomerInitializeOptions.md#googlepaybraintree)
+- [googlepaycheckoutcom](CustomerInitializeOptions.md#googlepaycheckoutcom)
+- [googlepaycybersourcev2](CustomerInitializeOptions.md#googlepaycybersourcev2)
+- [googlepayorbital](CustomerInitializeOptions.md#googlepayorbital)
+- [googlepaystripe](CustomerInitializeOptions.md#googlepaystripe)
+- [googlepaystripeupe](CustomerInitializeOptions.md#googlepaystripeupe)
+- [masterpass](CustomerInitializeOptions.md#masterpass)
+- [methodId](CustomerInitializeOptions.md#methodid)
+- [params](CustomerInitializeOptions.md#params)
+- [timeout](CustomerInitializeOptions.md#timeout)
+
+## Properties
+
+### amazon
+
+• `Optional` **amazon**: [`AmazonPayCustomerInitializeOptions`](AmazonPayCustomerInitializeOptions.md)
+
+The options that are required to initialize the customer step of checkout
+when using Amazon Pay.
+
+___
+
+### amazonpay
+
+• `Optional` **amazonpay**: [`AmazonPayV2CustomerInitializeOptions`](AmazonPayV2CustomerInitializeOptions.md)
+
+The options that are required to initialize the customer step of checkout
+when using AmazonPayV2.
+
+___
+
+### applepay
+
+• `Optional` **applepay**: [`ApplePayCustomerInitializeOptions`](ApplePayCustomerInitializeOptions.md)
+
+The options that are required to initialize the customer step of checkout
+when using ApplePay.
+
+___
+
+### bolt
+
+• `Optional` **bolt**: [`BoltCustomerInitializeOptions`](BoltCustomerInitializeOptions.md)
+
+The options that are required to initialize the customer step of checkout
+when using Bolt.
+
+___
+
+### braintreevisacheckout
+
+• `Optional` **braintreevisacheckout**: [`BraintreeVisaCheckoutCustomerInitializeOptions`](BraintreeVisaCheckoutCustomerInitializeOptions.md)
+
+The options that are required to initialize the customer step of checkout
+when using Visa Checkout provided by Braintree.
+
+___
+
+### chasepay
+
+• `Optional` **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.
+
+___
+
+### googlepayadyenv2
+
+• `Optional` **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.
+
+___
+
+### googlepayadyenv3
+
+• `Optional` **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.
+
+___
+
+### googlepayauthorizenet
+
+• `Optional` **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.
+
+___
+
+### googlepaybraintree
+
+• `Optional` **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.
+
+___
+
+### googlepaycheckoutcom
+
+• `Optional` **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.
+
+___
+
+### googlepaycybersourcev2
+
+• `Optional` **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.
+
+___
+
+### googlepayorbital
+
+• `Optional` **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.
+
+___
+
+### googlepaystripe
+
+• `Optional` **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.
+
+___
+
+### googlepaystripeupe
+
+• `Optional` **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.
+
+___
+
+### masterpass
+
+• `Optional` **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.
+
+___
+
+### methodId
+
+• `Optional` **methodId**: `string`
+
+#### Inherited from
+
+[CustomerRequestOptions](CustomerRequestOptions.md).[methodId](CustomerRequestOptions.md#methodid)
+
+___
+
+### params
+
+• `Optional` **params**: `Object`
+
+The parameters of the request, if required.
+
+#### Inherited from
+
+[CustomerRequestOptions](CustomerRequestOptions.md).[params](CustomerRequestOptions.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
+
+[CustomerRequestOptions](CustomerRequestOptions.md).[timeout](CustomerRequestOptions.md#timeout)

package/docs/interfaces/CustomerPasswordRequirements.md

@@ -0,0 +1,36 @@
+[@bigcommerce/checkout-sdk](../README.md) / CustomerPasswordRequirements
+
+# Interface: CustomerPasswordRequirements
+
+## Table of contents
+
+### 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

@@ -0,0 +1,60 @@
+[@bigcommerce/checkout-sdk](../README.md) / CustomerRequestOptions
+
+# Interface: CustomerRequestOptions
+
+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.
+
+## Hierarchy
+
+- [`RequestOptions`](RequestOptions.md)
+
+  ↳ **`CustomerRequestOptions`**
+
+  ↳↳ [`CustomerInitializeOptions`](CustomerInitializeOptions.md)
+
+  ↳↳ [`ExecutePaymentMethodCheckoutOptions`](ExecutePaymentMethodCheckoutOptions.md)
+
+## Table of contents
+
+### Properties
+
+- [methodId](CustomerRequestOptions.md#methodid)
+- [params](CustomerRequestOptions.md#params)
+- [timeout](CustomerRequestOptions.md#timeout)
+
+## Properties
+
+### methodId
+
+• `Optional` **methodId**: `string`
+
+___
+
+### params
+
+• `Optional` **params**: `Object`
+
+The parameters of the request, if required.
+
+#### Inherited from
+
+[RequestOptions](RequestOptions.md).[params](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](RequestOptions.md).[timeout](RequestOptions.md#timeout)