@bigcommerce/checkout-sdk 1.308.1 → 1.308.2

package/docs/interfaces/internal_.Order.md

@@ -0,0 +1,199 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / Order
+
+# Interface: Order
+
+[<internal>](../modules/internal_.md).Order
+
+## Table of contents
+
+### Properties
+
+- [baseAmount](internal_.Order.md#baseamount)
+- [billingAddress](internal_.Order.md#billingaddress)
+- [cartId](internal_.Order.md#cartid)
+- [channelId](internal_.Order.md#channelid)
+- [consignments](internal_.Order.md#consignments)
+- [coupons](internal_.Order.md#coupons)
+- [currency](internal_.Order.md#currency)
+- [customerCanBeCreated](internal_.Order.md#customercanbecreated)
+- [customerId](internal_.Order.md#customerid)
+- [customerMessage](internal_.Order.md#customermessage)
+- [discountAmount](internal_.Order.md#discountamount)
+- [giftWrappingCostTotal](internal_.Order.md#giftwrappingcosttotal)
+- [handlingCostTotal](internal_.Order.md#handlingcosttotal)
+- [hasDigitalItems](internal_.Order.md#hasdigitalitems)
+- [isComplete](internal_.Order.md#iscomplete)
+- [isDownloadable](internal_.Order.md#isdownloadable)
+- [isTaxIncluded](internal_.Order.md#istaxincluded)
+- [lineItems](internal_.Order.md#lineitems)
+- [orderAmount](internal_.Order.md#orderamount)
+- [orderAmountAsInteger](internal_.Order.md#orderamountasinteger)
+- [orderId](internal_.Order.md#orderid)
+- [payments](internal_.Order.md#payments)
+- [shippingCostBeforeDiscount](internal_.Order.md#shippingcostbeforediscount)
+- [shippingCostTotal](internal_.Order.md#shippingcosttotal)
+- [status](internal_.Order.md#status)
+- [taxTotal](internal_.Order.md#taxtotal)
+- [taxes](internal_.Order.md#taxes)
+
+## Properties
+
+### baseAmount
+
+• **baseAmount**: `number`
+
+___
+
+### billingAddress
+
+• **billingAddress**: [`BillingAddress`](internal_.BillingAddress.md)
+
+___
+
+### cartId
+
+• **cartId**: `string`
+
+___
+
+### channelId
+
+• **channelId**: `number`
+
+___
+
+### consignments
+
+• **consignments**: [`OrderConsignment`](internal_.OrderConsignment.md)
+
+___
+
+### coupons
+
+• **coupons**: [`Coupon`](internal_.Coupon.md)[]
+
+___
+
+### currency
+
+• **currency**: [`Currency`](internal_.Currency.md)
+
+___
+
+### customerCanBeCreated
+
+• **customerCanBeCreated**: `boolean`
+
+___
+
+### customerId
+
+• **customerId**: `number`
+
+___
+
+### customerMessage
+
+• **customerMessage**: `string`
+
+___
+
+### discountAmount
+
+• **discountAmount**: `number`
+
+___
+
+### giftWrappingCostTotal
+
+• **giftWrappingCostTotal**: `number`
+
+___
+
+### handlingCostTotal
+
+• **handlingCostTotal**: `number`
+
+___
+
+### hasDigitalItems
+
+• **hasDigitalItems**: `boolean`
+
+___
+
+### isComplete
+
+• **isComplete**: `boolean`
+
+___
+
+### isDownloadable
+
+• **isDownloadable**: `boolean`
+
+___
+
+### isTaxIncluded
+
+• **isTaxIncluded**: `boolean`
+
+___
+
+### lineItems
+
+• **lineItems**: [`LineItemMap`](internal_.LineItemMap.md)
+
+___
+
+### orderAmount
+
+• **orderAmount**: `number`
+
+___
+
+### orderAmountAsInteger
+
+• **orderAmountAsInteger**: `number`
+
+___
+
+### orderId
+
+• **orderId**: `number`
+
+___
+
+### payments
+
+• `Optional` **payments**: [`OrderPayments`](../modules/internal_.md#orderpayments)
+
+___
+
+### shippingCostBeforeDiscount
+
+• **shippingCostBeforeDiscount**: `number`
+
+___
+
+### shippingCostTotal
+
+• **shippingCostTotal**: `number`
+
+___
+
+### status
+
+• **status**: `string`
+
+___
+
+### taxTotal
+
+• **taxTotal**: `number`
+
+___
+
+### taxes
+
+• **taxes**: [`Tax`](internal_.Tax.md)[]

package/docs/interfaces/internal_.OrderConsignment.md

@@ -0,0 +1,17 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / OrderConsignment
+
+# Interface: OrderConsignment
+
+[<internal>](../modules/internal_.md).OrderConsignment
+
+## Table of contents
+
+### Properties
+
+- [shipping](internal_.OrderConsignment.md#shipping)
+
+## Properties
+
+### shipping
+
+• **shipping**: [`OrderShippingConsignment`](internal_.OrderShippingConsignment.md)[]

package/docs/interfaces/internal_.OrderPayment.md

@@ -0,0 +1,60 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / OrderPayment
+
+# Interface: OrderPayment
+
+[<internal>](../modules/internal_.md).OrderPayment
+
+## Hierarchy
+
+- **`OrderPayment`**
+
+  ↳ [`GatewayOrderPayment`](internal_.GatewayOrderPayment.md)
+
+  ↳ [`GiftCertificateOrderPayment`](internal_.GiftCertificateOrderPayment.md)
+
+## Table of contents
+
+### Properties
+
+- [amount](internal_.OrderPayment.md#amount)
+- [description](internal_.OrderPayment.md#description)
+- [gatewayId](internal_.OrderPayment.md#gatewayid)
+- [methodId](internal_.OrderPayment.md#methodid)
+- [paymentId](internal_.OrderPayment.md#paymentid)
+- [providerId](internal_.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/internal_.OrderPaymentRequestBody.md

@@ -0,0 +1,41 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / OrderPaymentRequestBody
+
+# Interface: OrderPaymentRequestBody
+
+[<internal>](../modules/internal_.md).OrderPaymentRequestBody
+
+An object that contains the payment information required for submitting an
+order.
+
+## Table of contents
+
+### Properties
+
+- [gatewayId](internal_.OrderPaymentRequestBody.md#gatewayid)
+- [methodId](internal_.OrderPaymentRequestBody.md#methodid)
+- [paymentData](internal_.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**: [`OrderPaymentInstrument`](../modules/internal_.md#orderpaymentinstrument)
+
+An object that contains the details of a credit card, vaulted payment
+instrument or nonce instrument.

package/docs/interfaces/internal_.OrderRequestBody.md

@@ -0,0 +1,35 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / OrderRequestBody
+
+# Interface: OrderRequestBody
+
+[<internal>](../modules/internal_.md).OrderRequestBody
+
+An object that contains the information required for submitting an order.
+
+## Table of contents
+
+### Properties
+
+- [payment](internal_.OrderRequestBody.md#payment)
+- [useStoreCredit](internal_.OrderRequestBody.md#usestorecredit)
+
+## Properties
+
+### payment
+
+• `Optional` **payment**: [`OrderPaymentRequestBody`](internal_.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/internal_.OrderShippingConsignment.md

@@ -0,0 +1,220 @@
+[@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

@@ -0,0 +1,38 @@
+[@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

@@ -0,0 +1,93 @@
+[@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)