@bigcommerce/checkout-sdk 1.308.2 → 1.308.3

package/docs/interfaces/internal_.OrderShippingConsignment.md

@@ -1,220 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / OrderShippingConsignment
-
-# Interface: OrderShippingConsignment
-
-[<internal>](../modules/internal_.md).OrderShippingConsignment
-
-## Table of contents
-
-### Properties
-
-- [address1](internal_.OrderShippingConsignment.md#address1)
-- [address2](internal_.OrderShippingConsignment.md#address2)
-- [baseCost](internal_.OrderShippingConsignment.md#basecost)
-- [baseHandlingCost](internal_.OrderShippingConsignment.md#basehandlingcost)
-- [city](internal_.OrderShippingConsignment.md#city)
-- [company](internal_.OrderShippingConsignment.md#company)
-- [costExTax](internal_.OrderShippingConsignment.md#costextax)
-- [costIncTax](internal_.OrderShippingConsignment.md#costinctax)
-- [costTax](internal_.OrderShippingConsignment.md#costtax)
-- [costTaxClassId](internal_.OrderShippingConsignment.md#costtaxclassid)
-- [country](internal_.OrderShippingConsignment.md#country)
-- [countryCode](internal_.OrderShippingConsignment.md#countrycode)
-- [customFields](internal_.OrderShippingConsignment.md#customfields)
-- [email](internal_.OrderShippingConsignment.md#email)
-- [firstName](internal_.OrderShippingConsignment.md#firstname)
-- [handlingCostExTax](internal_.OrderShippingConsignment.md#handlingcostextax)
-- [handlingCostIncTax](internal_.OrderShippingConsignment.md#handlingcostinctax)
-- [handlingCostTax](internal_.OrderShippingConsignment.md#handlingcosttax)
-- [handlingCostTaxClassId](internal_.OrderShippingConsignment.md#handlingcosttaxclassid)
-- [itemsShipped](internal_.OrderShippingConsignment.md#itemsshipped)
-- [itemsTotal](internal_.OrderShippingConsignment.md#itemstotal)
-- [lastName](internal_.OrderShippingConsignment.md#lastname)
-- [lineItems](internal_.OrderShippingConsignment.md#lineitems)
-- [phone](internal_.OrderShippingConsignment.md#phone)
-- [postalCode](internal_.OrderShippingConsignment.md#postalcode)
-- [shippingAddressId](internal_.OrderShippingConsignment.md#shippingaddressid)
-- [shippingMethod](internal_.OrderShippingConsignment.md#shippingmethod)
-- [shippingZoneId](internal_.OrderShippingConsignment.md#shippingzoneid)
-- [shippingZoneName](internal_.OrderShippingConsignment.md#shippingzonename)
-- [stateOrProvince](internal_.OrderShippingConsignment.md#stateorprovince)
-
-## Properties
-
-### address1
-
-• **address1**: `string`
-
-___
-
-### address2
-
-• **address2**: `string`
-
-___
-
-### baseCost
-
-• **baseCost**: `number`
-
-___
-
-### baseHandlingCost
-
-• **baseHandlingCost**: `number`
-
-___
-
-### city
-
-• **city**: `string`
-
-___
-
-### company
-
-• **company**: `string`
-
-___
-
-### costExTax
-
-• **costExTax**: `number`
-
-___
-
-### costIncTax
-
-• **costIncTax**: `number`
-
-___
-
-### costTax
-
-• **costTax**: `number`
-
-___
-
-### costTaxClassId
-
-• **costTaxClassId**: `number`
-
-___
-
-### country
-
-• **country**: `string`
-
-___
-
-### countryCode
-
-• **countryCode**: `string`
-
-___
-
-### customFields
-
-• **customFields**: { `name`: `string` ; `value`: ``null`` \| `string`  }[]
-
-___
-
-### email
-
-• **email**: `string`
-
-___
-
-### firstName
-
-• **firstName**: `string`
-
-___
-
-### handlingCostExTax
-
-• **handlingCostExTax**: `number`
-
-___
-
-### handlingCostIncTax
-
-• **handlingCostIncTax**: `number`
-
-___
-
-### handlingCostTax
-
-• **handlingCostTax**: `number`
-
-___
-
-### handlingCostTaxClassId
-
-• **handlingCostTaxClassId**: `number`
-
-___
-
-### itemsShipped
-
-• **itemsShipped**: `number`
-
-___
-
-### itemsTotal
-
-• **itemsTotal**: `number`
-
-___
-
-### lastName
-
-• **lastName**: `string`
-
-___
-
-### lineItems
-
-• **lineItems**: { `id`: `number`  }[]
-
-___
-
-### phone
-
-• **phone**: `string`
-
-___
-
-### postalCode
-
-• **postalCode**: `string`
-
-___
-
-### shippingAddressId
-
-• **shippingAddressId**: `number`
-
-___
-
-### shippingMethod
-
-• **shippingMethod**: `string`
-
-___
-
-### shippingZoneId
-
-• **shippingZoneId**: `number`
-
-___
-
-### shippingZoneName
-
-• **shippingZoneName**: `string`
-
-___
-
-### stateOrProvince
-
-• **stateOrProvince**: `string`

package/docs/interfaces/internal_.PasswordRequirements.md

@@ -1,38 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / PasswordRequirements
-
-# Interface: PasswordRequirements
-
-[<internal>](../modules/internal_.md).PasswordRequirements
-
-## Table of contents
-
-### Properties
-
-- [alpha](internal_.PasswordRequirements.md#alpha)
-- [error](internal_.PasswordRequirements.md#error)
-- [minlength](internal_.PasswordRequirements.md#minlength)
-- [numeric](internal_.PasswordRequirements.md#numeric)
-
-## Properties
-
-### alpha
-
-• **alpha**: `string`
-
-___
-
-### error
-
-• **error**: `string`
-
-___
-
-### minlength
-
-• **minlength**: `number`
-
-___
-
-### numeric
-
-• **numeric**: `string`

package/docs/interfaces/internal_.PayPalInstrument.md

@@ -1,93 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / PayPalInstrument
-
-# Interface: PayPalInstrument
-
-[<internal>](../modules/internal_.md).PayPalInstrument
-
-## Hierarchy
-
-- [`BaseAccountInstrument`](internal_.BaseAccountInstrument.md)
-
-  ↳ **`PayPalInstrument`**
-
-## Table of contents
-
-### Properties
-
-- [bigpayToken](internal_.PayPalInstrument.md#bigpaytoken)
-- [defaultInstrument](internal_.PayPalInstrument.md#defaultinstrument)
-- [externalId](internal_.PayPalInstrument.md#externalid)
-- [method](internal_.PayPalInstrument.md#method)
-- [provider](internal_.PayPalInstrument.md#provider)
-- [trustedShippingAddress](internal_.PayPalInstrument.md#trustedshippingaddress)
-- [type](internal_.PayPalInstrument.md#type)
-
-## Properties
-
-### bigpayToken
-
-• **bigpayToken**: `string`
-
-#### Inherited from
-
-[BaseAccountInstrument](internal_.BaseAccountInstrument.md).[bigpayToken](internal_.BaseAccountInstrument.md#bigpaytoken)
-
-___
-
-### defaultInstrument
-
-• **defaultInstrument**: `boolean`
-
-#### Inherited from
-
-[BaseAccountInstrument](internal_.BaseAccountInstrument.md).[defaultInstrument](internal_.BaseAccountInstrument.md#defaultinstrument)
-
-___
-
-### externalId
-
-• **externalId**: `string`
-
-#### Inherited from
-
-[BaseAccountInstrument](internal_.BaseAccountInstrument.md).[externalId](internal_.BaseAccountInstrument.md#externalid)
-
-___
-
-### method
-
-• **method**: ``"paypal"``
-
-#### Overrides
-
-[BaseAccountInstrument](internal_.BaseAccountInstrument.md).[method](internal_.BaseAccountInstrument.md#method)
-
-___
-
-### provider
-
-• **provider**: `string`
-
-#### Inherited from
-
-[BaseAccountInstrument](internal_.BaseAccountInstrument.md).[provider](internal_.BaseAccountInstrument.md#provider)
-
-___
-
-### trustedShippingAddress
-
-• **trustedShippingAddress**: `boolean`
-
-#### Inherited from
-
-[BaseAccountInstrument](internal_.BaseAccountInstrument.md).[trustedShippingAddress](internal_.BaseAccountInstrument.md#trustedshippingaddress)
-
-___
-
-### type
-
-• **type**: ``"account"`` \| ``"bank"``
-
-#### Inherited from
-
-[BaseAccountInstrument](internal_.BaseAccountInstrument.md).[type](internal_.BaseAccountInstrument.md#type)

package/docs/interfaces/internal_.PaymentMethod.md

@@ -1,100 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / PaymentMethod
-
-# Interface: PaymentMethod<T\>
-
-[<internal>](../modules/internal_.md).PaymentMethod
-
-## Type parameters
-
-| Name | Type |
-| :------ | :------ |
-| `T` | `any` |
-
-## Table of contents
-
-### Properties
-
-- [clientToken](internal_.PaymentMethod.md#clienttoken)
-- [config](internal_.PaymentMethod.md#config)
-- [gateway](internal_.PaymentMethod.md#gateway)
-- [id](internal_.PaymentMethod.md#id)
-- [initializationData](internal_.PaymentMethod.md#initializationdata)
-- [initializationStrategy](internal_.PaymentMethod.md#initializationstrategy)
-- [logoUrl](internal_.PaymentMethod.md#logourl)
-- [method](internal_.PaymentMethod.md#method)
-- [nonce](internal_.PaymentMethod.md#nonce)
-- [returnUrl](internal_.PaymentMethod.md#returnurl)
-- [supportedCards](internal_.PaymentMethod.md#supportedcards)
-- [type](internal_.PaymentMethod.md#type)
-
-## Properties
-
-### clientToken
-
-• `Optional` **clientToken**: `string`
-
-___
-
-### config
-
-• **config**: [`PaymentMethodConfig`](internal_.PaymentMethodConfig.md)
-
-___
-
-### gateway
-
-• `Optional` **gateway**: `string`
-
-___
-
-### id
-
-• **id**: `string`
-
-___
-
-### initializationData
-
-• `Optional` **initializationData**: `T`
-
-___
-
-### initializationStrategy
-
-• `Optional` **initializationStrategy**: [`InitializationStrategy`](internal_.InitializationStrategy.md)
-
-___
-
-### logoUrl
-
-• `Optional` **logoUrl**: `string`
-
-___
-
-### method
-
-• **method**: `string`
-
-___
-
-### nonce
-
-• `Optional` **nonce**: `string`
-
-___
-
-### returnUrl
-
-• `Optional` **returnUrl**: `string`
-
-___
-
-### supportedCards
-
-• **supportedCards**: `string`[]
-
-___
-
-### type
-
-• **type**: `string`

package/docs/interfaces/internal_.PaymentMethodConfig.md

@@ -1,122 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / PaymentMethodConfig
-
-# Interface: PaymentMethodConfig
-
-[<internal>](../modules/internal_.md).PaymentMethodConfig
-
-## Table of contents
-
-### Properties
-
-- [cardCode](internal_.PaymentMethodConfig.md#cardcode)
-- [displayName](internal_.PaymentMethodConfig.md#displayname)
-- [enablePaypal](internal_.PaymentMethodConfig.md#enablepaypal)
-- [hasDefaultStoredInstrument](internal_.PaymentMethodConfig.md#hasdefaultstoredinstrument)
-- [helpText](internal_.PaymentMethodConfig.md#helptext)
-- [is3dsEnabled](internal_.PaymentMethodConfig.md#is3dsenabled)
-- [isHostedFormEnabled](internal_.PaymentMethodConfig.md#ishostedformenabled)
-- [isVaultingCvvEnabled](internal_.PaymentMethodConfig.md#isvaultingcvvenabled)
-- [isVaultingEnabled](internal_.PaymentMethodConfig.md#isvaultingenabled)
-- [isVisaCheckoutEnabled](internal_.PaymentMethodConfig.md#isvisacheckoutenabled)
-- [logo](internal_.PaymentMethodConfig.md#logo)
-- [merchantId](internal_.PaymentMethodConfig.md#merchantid)
-- [redirectUrl](internal_.PaymentMethodConfig.md#redirecturl)
-- [requireCustomerCode](internal_.PaymentMethodConfig.md#requirecustomercode)
-- [returnUrl](internal_.PaymentMethodConfig.md#returnurl)
-- [testMode](internal_.PaymentMethodConfig.md#testmode)
-
-## Properties
-
-### cardCode
-
-• `Optional` **cardCode**: `boolean`
-
-___
-
-### displayName
-
-• `Optional` **displayName**: `string`
-
-___
-
-### enablePaypal
-
-• `Optional` **enablePaypal**: `boolean`
-
-___
-
-### hasDefaultStoredInstrument
-
-• `Optional` **hasDefaultStoredInstrument**: `boolean`
-
-___
-
-### helpText
-
-• `Optional` **helpText**: `string`
-
-___
-
-### is3dsEnabled
-
-• `Optional` **is3dsEnabled**: `boolean`
-
-___
-
-### isHostedFormEnabled
-
-• `Optional` **isHostedFormEnabled**: `boolean`
-
-___
-
-### isVaultingCvvEnabled
-
-• `Optional` **isVaultingCvvEnabled**: `boolean`
-
-___
-
-### isVaultingEnabled
-
-• `Optional` **isVaultingEnabled**: `boolean`
-
-___
-
-### isVisaCheckoutEnabled
-
-• `Optional` **isVisaCheckoutEnabled**: `boolean`
-
-___
-
-### logo
-
-• `Optional` **logo**: `string`
-
-___
-
-### merchantId
-
-• `Optional` **merchantId**: `string`
-
-___
-
-### redirectUrl
-
-• `Optional` **redirectUrl**: `string`
-
-___
-
-### requireCustomerCode
-
-• `Optional` **requireCustomerCode**: `boolean`
-
-___
-
-### returnUrl
-
-• `Optional` **returnUrl**: `string`
-
-___
-
-### testMode
-
-• `Optional` **testMode**: `boolean`

package/docs/interfaces/internal_.PaymentRequestOptions.md

@@ -1,69 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / PaymentRequestOptions
-
-# Interface: PaymentRequestOptions
-
-[<internal>](../modules/internal_.md).PaymentRequestOptions
-
-The set of options for configuring any requests related to the payment step of
-the current checkout flow.
-
-## Hierarchy
-
-- [`RequestOptions`](internal_.RequestOptions.md)
-
-  ↳ **`PaymentRequestOptions`**
-
-  ↳↳ [`BasePaymentInitializeOptions`](internal_.BasePaymentInitializeOptions.md)
-
-## Table of contents
-
-### Properties
-
-- [gatewayId](internal_.PaymentRequestOptions.md#gatewayid)
-- [methodId](internal_.PaymentRequestOptions.md#methodid)
-- [params](internal_.PaymentRequestOptions.md#params)
-- [timeout](internal_.PaymentRequestOptions.md#timeout)
-
-## Properties
-
-### 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.
-
-___
-
-### methodId
-
-• **methodId**: `string`
-
-The identifier of the payment method.
-
-___
-
-### params
-
-• `Optional` **params**: `Object`
-
-The parameters of the request, if required.
-
-#### Inherited from
-
-[RequestOptions](internal_.RequestOptions.md).[params](internal_.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](internal_.RequestOptions.md).[timeout](internal_.RequestOptions.md#timeout)

package/docs/interfaces/internal_.PaymentSettings.md

@@ -1,24 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / PaymentSettings
-
-# Interface: PaymentSettings
-
-[<internal>](../modules/internal_.md).PaymentSettings
-
-## Table of contents
-
-### Properties
-
-- [bigpayBaseUrl](internal_.PaymentSettings.md#bigpaybaseurl)
-- [clientSidePaymentProviders](internal_.PaymentSettings.md#clientsidepaymentproviders)
-
-## Properties
-
-### bigpayBaseUrl
-
-• **bigpayBaseUrl**: `string`
-
-___
-
-### clientSidePaymentProviders
-
-• **clientSidePaymentProviders**: `string`[]