@bigcommerce/checkout-sdk 1.271.1 → 1.271.2

package/docs/interfaces/OrderShippingConsignment.md

@@ -1,218 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / OrderShippingConsignment
-
-# Interface: OrderShippingConsignment
-
-## Table of contents
-
-### Properties
-
-- [address1](OrderShippingConsignment.md#address1)
-- [address2](OrderShippingConsignment.md#address2)
-- [baseCost](OrderShippingConsignment.md#basecost)
-- [baseHandlingCost](OrderShippingConsignment.md#basehandlingcost)
-- [city](OrderShippingConsignment.md#city)
-- [company](OrderShippingConsignment.md#company)
-- [costExTax](OrderShippingConsignment.md#costextax)
-- [costIncTax](OrderShippingConsignment.md#costinctax)
-- [costTax](OrderShippingConsignment.md#costtax)
-- [costTaxClassId](OrderShippingConsignment.md#costtaxclassid)
-- [country](OrderShippingConsignment.md#country)
-- [countryCode](OrderShippingConsignment.md#countrycode)
-- [customFields](OrderShippingConsignment.md#customfields)
-- [email](OrderShippingConsignment.md#email)
-- [firstName](OrderShippingConsignment.md#firstname)
-- [handlingCostExTax](OrderShippingConsignment.md#handlingcostextax)
-- [handlingCostIncTax](OrderShippingConsignment.md#handlingcostinctax)
-- [handlingCostTax](OrderShippingConsignment.md#handlingcosttax)
-- [handlingCostTaxClassId](OrderShippingConsignment.md#handlingcosttaxclassid)
-- [itemsShipped](OrderShippingConsignment.md#itemsshipped)
-- [itemsTotal](OrderShippingConsignment.md#itemstotal)
-- [lastName](OrderShippingConsignment.md#lastname)
-- [lineItems](OrderShippingConsignment.md#lineitems)
-- [phone](OrderShippingConsignment.md#phone)
-- [postalCode](OrderShippingConsignment.md#postalcode)
-- [shippingAddressId](OrderShippingConsignment.md#shippingaddressid)
-- [shippingMethod](OrderShippingConsignment.md#shippingmethod)
-- [shippingZoneId](OrderShippingConsignment.md#shippingzoneid)
-- [shippingZoneName](OrderShippingConsignment.md#shippingzonename)
-- [stateOrProvince](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/PasswordRequirements.md

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

package/docs/interfaces/PayPalInstrument.md

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

package/docs/interfaces/PaymentInitializeOptions_3.md

@@ -1,74 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / PaymentInitializeOptions_3
-
-# Interface: PaymentInitializeOptions\_3
-
-## Hierarchy
-
-- [`PaymentRequestOptions`](PaymentRequestOptions.md)
-
-  ↳ **`PaymentInitializeOptions_3`**
-
-## Indexable
-
-▪ [key: `string`]: `unknown`
-
-## Table of contents
-
-### Properties
-
-- [gatewayId](PaymentInitializeOptions_3.md#gatewayid)
-- [methodId](PaymentInitializeOptions_3.md#methodid)
-- [params](PaymentInitializeOptions_3.md#params)
-- [timeout](PaymentInitializeOptions_3.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.
-
-#### Inherited from
-
-[PaymentRequestOptions](PaymentRequestOptions.md).[gatewayId](PaymentRequestOptions.md#gatewayid)
-
-___
-
-### methodId
-
-• **methodId**: `string`
-
-The identifier of the payment method.
-
-#### Inherited from
-
-[PaymentRequestOptions](PaymentRequestOptions.md).[methodId](PaymentRequestOptions.md#methodid)
-
-___
-
-### params
-
-• `Optional` **params**: `Object`
-
-The parameters of the request, if required.
-
-#### Inherited from
-
-[PaymentRequestOptions](PaymentRequestOptions.md).[params](PaymentRequestOptions.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
-
-[PaymentRequestOptions](PaymentRequestOptions.md).[timeout](PaymentRequestOptions.md#timeout)