@bigcommerce/checkout-sdk 1.436.0 → 1.436.1

package/docs/interfaces/OrderBillingAddress.md

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

@@ -1,15 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / OrderConsignment
-
-# Interface: OrderConsignment
-
-## Table of contents
-
-### Properties
-
-- [shipping](OrderConsignment.md#shipping)
-
-## Properties
-
-### shipping
-
-• **shipping**: [`OrderShippingConsignment`](OrderShippingConsignment.md)[]

package/docs/interfaces/OrderFee.md

@@ -1,43 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / OrderFee
-
-# Interface: OrderFee
-
-## Table of contents
-
-### Properties
-
-- [cost](OrderFee.md#cost)
-- [customerDisplayName](OrderFee.md#customerdisplayname)
-- [id](OrderFee.md#id)
-- [source](OrderFee.md#source)
-- [type](OrderFee.md#type)
-
-## Properties
-
-### cost
-
-• **cost**: `number`
-
-___
-
-### customerDisplayName
-
-• **customerDisplayName**: `string`
-
-___
-
-### id
-
-• **id**: `number`
-
-___
-
-### source
-
-• **source**: `string`
-
-___
-
-### type
-
-• **type**: `string`

package/docs/interfaces/OrderPayment.md

@@ -1,58 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / OrderPayment
-
-# Interface: OrderPayment
-
-## Hierarchy
-
-- **`OrderPayment`**
-
-  ↳ [`GatewayOrderPayment`](GatewayOrderPayment.md)
-
-  ↳ [`GiftCertificateOrderPayment`](GiftCertificateOrderPayment.md)
-
-## Table of contents
-
-### Properties
-
-- [amount](OrderPayment.md#amount)
-- [description](OrderPayment.md#description)
-- [gatewayId](OrderPayment.md#gatewayid)
-- [methodId](OrderPayment.md#methodid)
-- [paymentId](OrderPayment.md#paymentid)
-- [providerId](OrderPayment.md#providerid)
-
-## Properties
-
-### amount
-
-• **amount**: `number`
-
-___
-
-### description
-
-• **description**: `string`
-
-___
-
-### gatewayId
-
-• `Optional` **gatewayId**: `string`
-
-___
-
-### methodId
-
-• `Optional` **methodId**: `string`
-
-___
-
-### paymentId
-
-• `Optional` **paymentId**: `string`
-
-___
-
-### providerId
-
-• **providerId**: `string`

package/docs/interfaces/OrderPaymentRequestBody.md

@@ -1,39 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / OrderPaymentRequestBody
-
-# Interface: OrderPaymentRequestBody
-
-An object that contains the payment information required for submitting an
-order.
-
-## Table of contents
-
-### Properties
-
-- [gatewayId](OrderPaymentRequestBody.md#gatewayid)
-- [methodId](OrderPaymentRequestBody.md#methodid)
-- [paymentData](OrderPaymentRequestBody.md#paymentdata)
-
-## Properties
-
-### gatewayId
-
-• `Optional` **gatewayId**: `string`
-
-The identifier of the payment provider that is chosen for the order.
-
-___
-
-### methodId
-
-• **methodId**: `string`
-
-The identifier of the payment method that is chosen for the order.
-
-___
-
-### paymentData
-
-• `Optional` **paymentData**: [`CreditCardInstrument`](CreditCardInstrument.md) \| [`HostedInstrument`](HostedInstrument.md) \| [`VaultedInstrument`](VaultedInstrument.md) \| [`NonceInstrument`](NonceInstrument.md) \| `WithBankAccountInstrument` \| `Pick`<[`CreditCardInstrument`](CreditCardInstrument.md), ``"ccCustomerCode"`` \| ``"shouldSaveInstrument"`` \| ``"shouldSetAsDefaultInstrument"`` \| ``"extraData"`` \| ``"threeDSecure"`` \| ``"browser_info"``\> \| `Pick`<[`VaultedInstrument`](VaultedInstrument.md), ``"instrumentId"``\> \| `BlueSnapDirectEcpInstrument` \| `WithAccountCreation` \| [`CreditCardInstrument`](CreditCardInstrument.md) & [`WithDocumentInstrument`](WithDocumentInstrument.md) \| [`CreditCardInstrument`](CreditCardInstrument.md) & [`WithCheckoutcomFawryInstrument`](WithCheckoutcomFawryInstrument.md) \| [`CreditCardInstrument`](CreditCardInstrument.md) & [`WithCheckoutcomSEPAInstrument`](WithCheckoutcomSEPAInstrument.md) \| [`CreditCardInstrument`](CreditCardInstrument.md) & [`WithCheckoutcomiDealInstrument`](WithCheckoutcomiDealInstrument.md) \| [`HostedInstrument`](HostedInstrument.md) & [`WithMollieIssuerInstrument`](WithMollieIssuerInstrument.md)
-
-An object that contains the details of a credit card, vaulted payment
-instrument or nonce instrument.

package/docs/interfaces/OrderRequestBody.md

@@ -1,33 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / OrderRequestBody
-
-# Interface: OrderRequestBody
-
-An object that contains the information required for submitting an order.
-
-## Table of contents
-
-### Properties
-
-- [payment](OrderRequestBody.md#payment)
-- [useStoreCredit](OrderRequestBody.md#usestorecredit)
-
-## Properties
-
-### payment
-
-• `Optional` **payment**: [`OrderPaymentRequestBody`](OrderPaymentRequestBody.md)
-
-An object that contains the payment details of a customer. In some cases,
-you can omit this object if the order does not require further payment.
-For example, the customer is able to use their store credit to pay for
-the entire order. Or they have already submitted their payment details
-using PayPal.
-
-___
-
-### useStoreCredit
-
-• `Optional` **useStoreCredit**: `boolean`
-
-If true, apply the store credit of the customer to the order. It only
-works if the customer has previously signed in.

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/PayPalButtonStyleOptions.md

@@ -1,36 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / PayPalButtonStyleOptions
-
-# Interface: PayPalButtonStyleOptions
-
-## Table of contents
-
-### Properties
-
-- [color](PayPalButtonStyleOptions.md#color)
-- [height](PayPalButtonStyleOptions.md#height)
-- [label](PayPalButtonStyleOptions.md#label)
-- [shape](PayPalButtonStyleOptions.md#shape)
-
-## Properties
-
-### color
-
-• `Optional` **color**: [`gold`](../enums/StyleButtonColor.md#gold) \| [`blue`](../enums/StyleButtonColor.md#blue) \| [`silver`](../enums/StyleButtonColor.md#silver) \| [`black`](../enums/StyleButtonColor.md#black) \| [`white`](../enums/StyleButtonColor.md#white)
-
-___
-
-### height
-
-• `Optional` **height**: `number`
-
-___
-
-### label
-
-• `Optional` **label**: [`paypal`](../enums/StyleButtonLabel.md#paypal) \| [`checkout`](../enums/StyleButtonLabel.md#checkout) \| [`buynow`](../enums/StyleButtonLabel.md#buynow) \| [`pay`](../enums/StyleButtonLabel.md#pay) \| [`installment`](../enums/StyleButtonLabel.md#installment)
-
-___
-
-### shape
-
-• `Optional` **shape**: [`pill`](../enums/StyleButtonShape_2.md#pill) \| [`rect`](../enums/StyleButtonShape_2.md#rect)

package/docs/interfaces/PayPalBuyNowInitializeOptions.md

@@ -1,21 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / PayPalBuyNowInitializeOptions
-
-# Interface: PayPalBuyNowInitializeOptions
-
-PayPal Commerce BuyNow
-
-## Table of contents
-
-### Methods
-
-- [getBuyNowCartRequestBody](PayPalBuyNowInitializeOptions.md#getbuynowcartrequestbody)
-
-## Methods
-
-### getBuyNowCartRequestBody
-
-▸ **getBuyNowCartRequestBody**(): `default`
-
-#### Returns
-
-`default`