@bigcommerce/checkout-sdk 1.264.1 → 1.266.0

package/docs/interfaces/noncegenerationerror.md

@@ -1,33 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) › [NonceGenerationError](noncegenerationerror.md)
-
-# Interface: NonceGenerationError
-
-## Hierarchy
-
-* **NonceGenerationError**
-
-## Index
-
-### Properties
-
-* [field](noncegenerationerror.md#field)
-* [message](noncegenerationerror.md#message)
-* [type](noncegenerationerror.md#type)
-
-## Properties
-
-###  field
-
-• **field**: *string*
-
-___
-
-###  message
-
-• **message**: *string*
-
-___
-
-###  type
-
-• **type**: *string*

package/docs/interfaces/nonceinstrument.md

@@ -1,40 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) › [NonceInstrument](nonceinstrument.md)
-
-# Interface: NonceInstrument
-
-## Hierarchy
-
-* **NonceInstrument**
-
-## Index
-
-### Properties
-
-* [deviceSessionId](nonceinstrument.md#optional-devicesessionid)
-* [nonce](nonceinstrument.md#nonce)
-* [shouldSaveInstrument](nonceinstrument.md#optional-shouldsaveinstrument)
-* [shouldSetAsDefaultInstrument](nonceinstrument.md#optional-shouldsetasdefaultinstrument)
-
-## Properties
-
-### `Optional` deviceSessionId
-
-• **deviceSessionId**? : *undefined | string*
-
-___
-
-###  nonce
-
-• **nonce**: *string*
-
-___
-
-### `Optional` shouldSaveInstrument
-
-• **shouldSaveInstrument**? : *undefined | false | true*
-
-___
-
-### `Optional` shouldSetAsDefaultInstrument
-
-• **shouldSetAsDefaultInstrument**? : *undefined | false | true*

package/docs/interfaces/option.md

@@ -1,26 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) › [Option](option.md)
-
-# Interface: Option
-
-## Hierarchy
-
-* **Option**
-
-## Index
-
-### Properties
-
-* [itemQuantities](option.md#itemquantities)
-* [pickupMethod](option.md#pickupmethod)
-
-## Properties
-
-###  itemQuantities
-
-• **itemQuantities**: *[Item](item.md)*
-
-___
-
-###  pickupMethod
-
-• **pickupMethod**: *[PickupMethod](pickupmethod.md)*

package/docs/interfaces/order.md

@@ -1,194 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) › [Order](order.md)
-
-# Interface: Order
-
-## Hierarchy
-
-* **Order**
-
-## Index
-
-### Properties
-
-* [baseAmount](order.md#baseamount)
-* [billingAddress](order.md#billingaddress)
-* [cartId](order.md#cartid)
-* [consignments](order.md#consignments)
-* [coupons](order.md#coupons)
-* [currency](order.md#currency)
-* [customerCanBeCreated](order.md#customercanbecreated)
-* [customerId](order.md#customerid)
-* [customerMessage](order.md#customermessage)
-* [discountAmount](order.md#discountamount)
-* [giftWrappingCostTotal](order.md#giftwrappingcosttotal)
-* [handlingCostTotal](order.md#handlingcosttotal)
-* [hasDigitalItems](order.md#hasdigitalitems)
-* [isComplete](order.md#iscomplete)
-* [isDownloadable](order.md#isdownloadable)
-* [isTaxIncluded](order.md#istaxincluded)
-* [lineItems](order.md#lineitems)
-* [orderAmount](order.md#orderamount)
-* [orderAmountAsInteger](order.md#orderamountasinteger)
-* [orderId](order.md#orderid)
-* [payments](order.md#optional-payments)
-* [shippingCostBeforeDiscount](order.md#shippingcostbeforediscount)
-* [shippingCostTotal](order.md#shippingcosttotal)
-* [status](order.md#status)
-* [taxTotal](order.md#taxtotal)
-* [taxes](order.md#taxes)
-
-## Properties
-
-###  baseAmount
-
-• **baseAmount**: *number*
-
-___
-
-###  billingAddress
-
-• **billingAddress**: *[BillingAddress](billingaddress.md)*
-
-___
-
-###  cartId
-
-• **cartId**: *string*
-
-___
-
-###  consignments
-
-• **consignments**: *[OrderConsignment](orderconsignment.md)[]*
-
-___
-
-###  coupons
-
-• **coupons**: *[Coupon](coupon.md)[]*
-
-___
-
-###  currency
-
-• **currency**: *[Currency](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](lineitemmap.md)*
-
-___
-
-###  orderAmount
-
-• **orderAmount**: *number*
-
-___
-
-###  orderAmountAsInteger
-
-• **orderAmountAsInteger**: *number*
-
-___
-
-###  orderId
-
-• **orderId**: *number*
-
-___
-
-### `Optional` payments
-
-• **payments**? : *[OrderPayments](../README.md#orderpayments)*
-
-___
-
-###  shippingCostBeforeDiscount
-
-• **shippingCostBeforeDiscount**: *number*
-
-___
-
-###  shippingCostTotal
-
-• **shippingCostTotal**: *number*
-
-___
-
-###  status
-
-• **status**: *string*
-
-___
-
-###  taxTotal
-
-• **taxTotal**: *number*
-
-___
-
-###  taxes
-
-• **taxes**: *[Tax](tax.md)[]*

package/docs/interfaces/orderconsignment.md

@@ -1,19 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) › [OrderConsignment](orderconsignment.md)
-
-# Interface: OrderConsignment
-
-## Hierarchy
-
-* **OrderConsignment**
-
-## Index
-
-### Properties
-
-* [shipping](orderconsignment.md#shipping)
-
-## Properties
-
-###  shipping
-
-• **shipping**: *[OrderShippingConsignment](ordershippingconsignment.md)[]*

package/docs/interfaces/orderpayment.md

@@ -1,58 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) › [OrderPayment](orderpayment.md)
-
-# Interface: OrderPayment
-
-## Hierarchy
-
-* **OrderPayment**
-
-  ↳ [GatewayOrderPayment](gatewayorderpayment.md)
-
-  ↳ [GiftCertificateOrderPayment](giftcertificateorderpayment.md)
-
-## Index
-
-### Properties
-
-* [amount](orderpayment.md#amount)
-* [description](orderpayment.md#description)
-* [gatewayId](orderpayment.md#optional-gatewayid)
-* [methodId](orderpayment.md#optional-methodid)
-* [paymentId](orderpayment.md#optional-paymentid)
-* [providerId](orderpayment.md#providerid)
-
-## Properties
-
-###  amount
-
-• **amount**: *number*
-
-___
-
-###  description
-
-• **description**: *string*
-
-___
-
-### `Optional` gatewayId
-
-• **gatewayId**? : *undefined | string*
-
-___
-
-### `Optional` methodId
-
-• **methodId**? : *undefined | string*
-
-___
-
-### `Optional` paymentId
-
-• **paymentId**? : *undefined | string*
-
-___
-
-###  providerId
-
-• **providerId**: *string*

package/docs/interfaces/orderpaymentrequestbody.md

@@ -1,43 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) › [OrderPaymentRequestBody](orderpaymentrequestbody.md)
-
-# Interface: OrderPaymentRequestBody
-
-An object that contains the payment information required for submitting an
-order.
-
-## Hierarchy
-
-* **OrderPaymentRequestBody**
-
-## Index
-
-### Properties
-
-* [gatewayId](orderpaymentrequestbody.md#optional-gatewayid)
-* [methodId](orderpaymentrequestbody.md#methodid)
-* [paymentData](orderpaymentrequestbody.md#optional-paymentdata)
-
-## Properties
-
-### `Optional` gatewayId
-
-• **gatewayId**? : *undefined | 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.
-
-___
-
-### `Optional` paymentData
-
-• **paymentData**? : *[OrderPaymentInstrument](../README.md#orderpaymentinstrument)*
-
-An object that contains the details of a credit card, vaulted payment
-instrument or nonce instrument.

package/docs/interfaces/ordershippingconsignment.md

@@ -1,222 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) › [OrderShippingConsignment](ordershippingconsignment.md)
-
-# Interface: OrderShippingConsignment
-
-## Hierarchy
-
-* **OrderShippingConsignment**
-
-## Index
-
-### 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**: *Array‹object›*
-
-___
-
-###  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**: *Array‹object›*
-
-___
-
-###  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,40 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) › [PasswordRequirements](passwordrequirements.md)
-
-# Interface: PasswordRequirements
-
-## Hierarchy
-
-* **PasswordRequirements**
-
-## Index
-
-### 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*