@bigcommerce/checkout-sdk 1.436.0 → 1.436.1

package/docs/interfaces/BasePaymentInitializeOptions.md

@@ -1,356 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / BasePaymentInitializeOptions
-
-# Interface: BasePaymentInitializeOptions
-
-A set of options that are required to initialize the payment step of the
-current checkout flow.
-
-## Hierarchy
-
-- [`PaymentRequestOptions`](PaymentRequestOptions.md)
-
-  ↳ **`BasePaymentInitializeOptions`**
-
-## Table of contents
-
-### Properties
-
-- [amazonpay](BasePaymentInitializeOptions.md#amazonpay)
-- [bluesnapv2](BasePaymentInitializeOptions.md#bluesnapv2)
-- [braintree](BasePaymentInitializeOptions.md#braintree)
-- [braintreevisacheckout](BasePaymentInitializeOptions.md#braintreevisacheckout)
-- [chasepay](BasePaymentInitializeOptions.md#chasepay)
-- [creditCard](BasePaymentInitializeOptions.md#creditcard)
-- [digitalriver](BasePaymentInitializeOptions.md#digitalriver)
-- [gatewayId](BasePaymentInitializeOptions.md#gatewayid)
-- [googlepayadyenv2](BasePaymentInitializeOptions.md#googlepayadyenv2)
-- [googlepayadyenv3](BasePaymentInitializeOptions.md#googlepayadyenv3)
-- [googlepayauthorizenet](BasePaymentInitializeOptions.md#googlepayauthorizenet)
-- [googlepaybnz](BasePaymentInitializeOptions.md#googlepaybnz)
-- [googlepaybraintree](BasePaymentInitializeOptions.md#googlepaybraintree)
-- [googlepaycheckoutcom](BasePaymentInitializeOptions.md#googlepaycheckoutcom)
-- [googlepaycybersourcev2](BasePaymentInitializeOptions.md#googlepaycybersourcev2)
-- [googlepayorbital](BasePaymentInitializeOptions.md#googlepayorbital)
-- [googlepaystripe](BasePaymentInitializeOptions.md#googlepaystripe)
-- [googlepaystripeupe](BasePaymentInitializeOptions.md#googlepaystripeupe)
-- [googlepayworldpayaccess](BasePaymentInitializeOptions.md#googlepayworldpayaccess)
-- [klarna](BasePaymentInitializeOptions.md#klarna)
-- [klarnav2](BasePaymentInitializeOptions.md#klarnav2)
-- [masterpass](BasePaymentInitializeOptions.md#masterpass)
-- [methodId](BasePaymentInitializeOptions.md#methodid)
-- [moneris](BasePaymentInitializeOptions.md#moneris)
-- [opy](BasePaymentInitializeOptions.md#opy)
-- [params](BasePaymentInitializeOptions.md#params)
-- [paypalexpress](BasePaymentInitializeOptions.md#paypalexpress)
-- [square](BasePaymentInitializeOptions.md#square)
-- [stripeupe](BasePaymentInitializeOptions.md#stripeupe)
-- [stripev3](BasePaymentInitializeOptions.md#stripev3)
-- [timeout](BasePaymentInitializeOptions.md#timeout)
-- [worldpay](BasePaymentInitializeOptions.md#worldpay)
-
-## Properties
-
-### amazonpay
-
-• `Optional` **amazonpay**: [`AmazonPayV2PaymentInitializeOptions`](AmazonPayV2PaymentInitializeOptions.md)
-
-The options that are required to initialize the AmazonPayV2 payment
-method. They can be omitted unless you need to support AmazonPayV2.
-
-___
-
-### bluesnapv2
-
-• `Optional` **bluesnapv2**: [`BlueSnapV2PaymentInitializeOptions`](BlueSnapV2PaymentInitializeOptions.md)
-
-The options that are required to initialize the BlueSnapV2 payment method.
-They can be omitted unless you need to support BlueSnapV2.
-
-___
-
-### braintree
-
-• `Optional` **braintree**: [`BraintreePaymentInitializeOptions`](BraintreePaymentInitializeOptions.md)
-
-The options that are required to initialize the Braintree payment method.
-They can be omitted unless you need to support Braintree.
-
-___
-
-### braintreevisacheckout
-
-• `Optional` **braintreevisacheckout**: [`BraintreeVisaCheckoutPaymentInitializeOptions`](BraintreeVisaCheckoutPaymentInitializeOptions.md)
-
-The options that are required to initialize the Visa Checkout payment
-method provided by Braintree. They can be omitted unless you need to
-support Visa Checkout.
-
-___
-
-### chasepay
-
-• `Optional` **chasepay**: [`ChasePayInitializeOptions`](ChasePayInitializeOptions.md)
-
-The options that are required to initialize the Chasepay payment method.
-They can be omitted unless you need to support Chasepay.
-
-___
-
-### creditCard
-
-• `Optional` **creditCard**: `CreditCardPaymentInitializeOptions`
-
-**`alpha`**
-Please note that this option is currently in an early stage of
-development. Therefore the API is unstable and not ready for public
-consumption.
-
-___
-
-### digitalriver
-
-• `Optional` **digitalriver**: [`DigitalRiverPaymentInitializeOptions`](DigitalRiverPaymentInitializeOptions.md)
-
-The options that are required to initialize the Digital River payment method.
-They can be omitted unless you need to support Digital River.
-
-___
-
-### gatewayId
-
-• `Optional` **gatewayId**: `string`
-
-The identifier of the payment provider providing the payment method. This
-option is only required if the provider offers multiple payment options.
-i.e.: Adyen and Klarna.
-
-#### Inherited from
-
-[PaymentRequestOptions](PaymentRequestOptions.md).[gatewayId](PaymentRequestOptions.md#gatewayid)
-
-___
-
-### googlepayadyenv2
-
-• `Optional` **googlepayadyenv2**: [`GooglePayPaymentInitializeOptions`](GooglePayPaymentInitializeOptions.md)
-
-The options that are required to initialize the GooglePay Authorize.Net
-payment method. They can be omitted unless you need to support GooglePay.
-
-___
-
-### googlepayadyenv3
-
-• `Optional` **googlepayadyenv3**: [`GooglePayPaymentInitializeOptions`](GooglePayPaymentInitializeOptions.md)
-
-The options that are required to initialize the GooglePay Authorize.Net
-payment method. They can be omitted unless you need to support GooglePay.
-
-___
-
-### googlepayauthorizenet
-
-• `Optional` **googlepayauthorizenet**: [`GooglePayPaymentInitializeOptions`](GooglePayPaymentInitializeOptions.md)
-
-The options that are required to initialize the GooglePay Authorize.Net
-payment method. They can be omitted unless you need to support GooglePay.
-
-___
-
-### googlepaybnz
-
-• `Optional` **googlepaybnz**: [`GooglePayPaymentInitializeOptions`](GooglePayPaymentInitializeOptions.md)
-
-The options that are required to initialize the GooglePay Authorize.Net
-payment method. They can be omitted unless you need to support GooglePay.
-
-___
-
-### googlepaybraintree
-
-• `Optional` **googlepaybraintree**: [`GooglePayPaymentInitializeOptions`](GooglePayPaymentInitializeOptions.md)
-
-The options that are required to initialize the GooglePay Braintree payment method.
-They can be omitted unless you need to support GooglePay.
-
-___
-
-### googlepaycheckoutcom
-
-• `Optional` **googlepaycheckoutcom**: [`GooglePayPaymentInitializeOptions`](GooglePayPaymentInitializeOptions.md)
-
-The options that are required to initialize the GooglePay Checkout.com payment method.
-They can be omitted unless you need to support GooglePay.
-
-___
-
-### googlepaycybersourcev2
-
-• `Optional` **googlepaycybersourcev2**: [`GooglePayPaymentInitializeOptions`](GooglePayPaymentInitializeOptions.md)
-
-The options that are required to initialize the GooglePay CybersourceV2 payment method.
-They can be omitted unless you need to support GooglePay.
-
-___
-
-### googlepayorbital
-
-• `Optional` **googlepayorbital**: [`GooglePayPaymentInitializeOptions`](GooglePayPaymentInitializeOptions.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**: [`GooglePayPaymentInitializeOptions`](GooglePayPaymentInitializeOptions.md)
-
-The options that are required to initialize the GooglePay Stripe payment method.
-They can be omitted unless you need to support GooglePay.
-
-___
-
-### googlepaystripeupe
-
-• `Optional` **googlepaystripeupe**: [`GooglePayPaymentInitializeOptions`](GooglePayPaymentInitializeOptions.md)
-
-The options that are required to initialize the GooglePay Stripe payment method.
-They can be omitted unless you need to support GooglePay.
-
-___
-
-### googlepayworldpayaccess
-
-• `Optional` **googlepayworldpayaccess**: [`GooglePayPaymentInitializeOptions`](GooglePayPaymentInitializeOptions.md)
-
-The options that are required to initialize the GooglePay Worldpay Access payment method.
-They can be omitted unless you need to support GooglePay.
-
-___
-
-### klarna
-
-• `Optional` **klarna**: [`KlarnaPaymentInitializeOptions`](KlarnaPaymentInitializeOptions.md)
-
-The options that are required to initialize the Klarna payment method.
-They can be omitted unless you need to support Klarna.
-
-___
-
-### klarnav2
-
-• `Optional` **klarnav2**: [`KlarnaV2PaymentInitializeOptions`](KlarnaV2PaymentInitializeOptions.md)
-
-The options that are required to initialize the KlarnaV2 payment method.
-They can be omitted unless you need to support KlarnaV2.
-
-___
-
-### masterpass
-
-• `Optional` **masterpass**: [`MasterpassPaymentInitializeOptions`](MasterpassPaymentInitializeOptions.md)
-
-The options that are required to initialize the Masterpass payment method.
-They can be omitted unless you need to support Masterpass.
-
-___
-
-### methodId
-
-• **methodId**: `string`
-
-The identifier of the payment method.
-
-#### Inherited from
-
-[PaymentRequestOptions](PaymentRequestOptions.md).[methodId](PaymentRequestOptions.md#methodid)
-
-___
-
-### moneris
-
-• `Optional` **moneris**: [`MonerisPaymentInitializeOptions`](MonerisPaymentInitializeOptions.md)
-
-The options that are required to initialize the Moneris payment method.
-They can be omitted unless you need to support Moneris.
-
-___
-
-### opy
-
-• `Optional` **opy**: [`OpyPaymentInitializeOptions`](OpyPaymentInitializeOptions.md)
-
-The options that are required to initialize the Opy payment
-method. They can be omitted unless you need to support Opy.
-
-___
-
-### params
-
-• `Optional` **params**: `Object`
-
-The parameters of the request, if required.
-
-#### Inherited from
-
-[PaymentRequestOptions](PaymentRequestOptions.md).[params](PaymentRequestOptions.md#params)
-
-___
-
-### paypalexpress
-
-• `Optional` **paypalexpress**: [`PaypalExpressPaymentInitializeOptions`](PaypalExpressPaymentInitializeOptions.md)
-
-The options that are required to initialize the PayPal Express payment method.
-They can be omitted unless you need to support PayPal Express.
-
-___
-
-### square
-
-• `Optional` **square**: [`SquarePaymentInitializeOptions`](SquarePaymentInitializeOptions.md)
-
-The options that are required to initialize the Square payment method.
-They can be omitted unless you need to support Square.
-
-___
-
-### stripeupe
-
-• `Optional` **stripeupe**: [`StripeUPEPaymentInitializeOptions`](StripeUPEPaymentInitializeOptions.md)
-
-The options that are required to initialize the StripeUPE payment method.
-They can be omitted unless you need to support StripeUPE.
-
-___
-
-### stripev3
-
-• `Optional` **stripev3**: [`StripeV3PaymentInitializeOptions`](StripeV3PaymentInitializeOptions.md)
-
-The options that are required to initialize the Stripe payment method.
-They can be omitted unless you need to support StripeV3.
-
-___
-
-### 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
-
-[PaymentRequestOptions](PaymentRequestOptions.md).[timeout](PaymentRequestOptions.md#timeout)
-
-___
-
-### worldpay
-
-• `Optional` **worldpay**: [`WorldpayAccessPaymentInitializeOptions`](WorldpayAccessPaymentInitializeOptions.md)
-
-The options that are required to initialize the Worldpay payment method.
-They can be omitted unless you need to support Worldpay.

package/docs/interfaces/BillingAddress.md

@@ -1,182 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / BillingAddress
-
-# Interface: BillingAddress
-
-## Hierarchy
-
-- [`Address`](Address.md)
-
-  ↳ **`BillingAddress`**
-
-## Table of contents
-
-### Properties
-
-- [address1](BillingAddress.md#address1)
-- [address2](BillingAddress.md#address2)
-- [city](BillingAddress.md#city)
-- [company](BillingAddress.md#company)
-- [country](BillingAddress.md#country)
-- [countryCode](BillingAddress.md#countrycode)
-- [customFields](BillingAddress.md#customfields)
-- [email](BillingAddress.md#email)
-- [firstName](BillingAddress.md#firstname)
-- [id](BillingAddress.md#id)
-- [lastName](BillingAddress.md#lastname)
-- [phone](BillingAddress.md#phone)
-- [postalCode](BillingAddress.md#postalcode)
-- [shouldSaveAddress](BillingAddress.md#shouldsaveaddress)
-- [stateOrProvince](BillingAddress.md#stateorprovince)
-- [stateOrProvinceCode](BillingAddress.md#stateorprovincecode)
-
-## 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)
-
-___
-
-### email
-
-• `Optional` **email**: `string`
-
-___
-
-### firstName
-
-• **firstName**: `string`
-
-#### Inherited from
-
-[Address](Address.md).[firstName](Address.md#firstname)
-
-___
-
-### id
-
-• **id**: `string`
-
-___
-
-### 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)

package/docs/interfaces/BillingAddressRequestBody.md

@@ -1,153 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / BillingAddressRequestBody
-
-# Interface: BillingAddressRequestBody
-
-## Hierarchy
-
-- [`AddressRequestBody`](AddressRequestBody.md)
-
-  ↳ **`BillingAddressRequestBody`**
-
-## Table of contents
-
-### Properties
-
-- [address1](BillingAddressRequestBody.md#address1)
-- [address2](BillingAddressRequestBody.md#address2)
-- [city](BillingAddressRequestBody.md#city)
-- [company](BillingAddressRequestBody.md#company)
-- [countryCode](BillingAddressRequestBody.md#countrycode)
-- [customFields](BillingAddressRequestBody.md#customfields)
-- [email](BillingAddressRequestBody.md#email)
-- [firstName](BillingAddressRequestBody.md#firstname)
-- [lastName](BillingAddressRequestBody.md#lastname)
-- [phone](BillingAddressRequestBody.md#phone)
-- [postalCode](BillingAddressRequestBody.md#postalcode)
-- [stateOrProvince](BillingAddressRequestBody.md#stateorprovince)
-- [stateOrProvinceCode](BillingAddressRequestBody.md#stateorprovincecode)
-
-## Properties
-
-### address1
-
-• **address1**: `string`
-
-#### Inherited from
-
-[AddressRequestBody](AddressRequestBody.md).[address1](AddressRequestBody.md#address1)
-
-___
-
-### address2
-
-• **address2**: `string`
-
-#### Inherited from
-
-[AddressRequestBody](AddressRequestBody.md).[address2](AddressRequestBody.md#address2)
-
-___
-
-### city
-
-• **city**: `string`
-
-#### Inherited from
-
-[AddressRequestBody](AddressRequestBody.md).[city](AddressRequestBody.md#city)
-
-___
-
-### company
-
-• **company**: `string`
-
-#### Inherited from
-
-[AddressRequestBody](AddressRequestBody.md).[company](AddressRequestBody.md#company)
-
-___
-
-### countryCode
-
-• **countryCode**: `string`
-
-#### Inherited from
-
-[AddressRequestBody](AddressRequestBody.md).[countryCode](AddressRequestBody.md#countrycode)
-
-___
-
-### customFields
-
-• **customFields**: { `fieldId`: `string` ; `fieldValue`: `string` \| `number` \| `string`[]  }[]
-
-#### Inherited from
-
-[AddressRequestBody](AddressRequestBody.md).[customFields](AddressRequestBody.md#customfields)
-
-___
-
-### email
-
-• `Optional` **email**: `string`
-
-___
-
-### firstName
-
-• **firstName**: `string`
-
-#### Inherited from
-
-[AddressRequestBody](AddressRequestBody.md).[firstName](AddressRequestBody.md#firstname)
-
-___
-
-### lastName
-
-• **lastName**: `string`
-
-#### Inherited from
-
-[AddressRequestBody](AddressRequestBody.md).[lastName](AddressRequestBody.md#lastname)
-
-___
-
-### phone
-
-• **phone**: `string`
-
-#### Inherited from
-
-[AddressRequestBody](AddressRequestBody.md).[phone](AddressRequestBody.md#phone)
-
-___
-
-### postalCode
-
-• **postalCode**: `string`
-
-#### Inherited from
-
-[AddressRequestBody](AddressRequestBody.md).[postalCode](AddressRequestBody.md#postalcode)
-
-___
-
-### stateOrProvince
-
-• **stateOrProvince**: `string`
-
-#### Inherited from
-
-[AddressRequestBody](AddressRequestBody.md).[stateOrProvince](AddressRequestBody.md#stateorprovince)
-
-___
-
-### stateOrProvinceCode
-
-• **stateOrProvinceCode**: `string`
-
-#### Inherited from
-
-[AddressRequestBody](AddressRequestBody.md).[stateOrProvinceCode](AddressRequestBody.md#stateorprovincecode)