@bigcommerce/checkout-sdk 1.308.1 → 1.308.2

package/docs/interfaces/internal_.CustomerAddress.md

@@ -0,0 +1,184 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / CustomerAddress
+
+# Interface: CustomerAddress
+
+[<internal>](../modules/internal_.md).CustomerAddress
+
+## Hierarchy
+
+- [`Address`](internal_.Address.md)
+
+  ↳ **`CustomerAddress`**
+
+## Table of contents
+
+### Properties
+
+- [address1](internal_.CustomerAddress.md#address1)
+- [address2](internal_.CustomerAddress.md#address2)
+- [city](internal_.CustomerAddress.md#city)
+- [company](internal_.CustomerAddress.md#company)
+- [country](internal_.CustomerAddress.md#country)
+- [countryCode](internal_.CustomerAddress.md#countrycode)
+- [customFields](internal_.CustomerAddress.md#customfields)
+- [firstName](internal_.CustomerAddress.md#firstname)
+- [id](internal_.CustomerAddress.md#id)
+- [lastName](internal_.CustomerAddress.md#lastname)
+- [phone](internal_.CustomerAddress.md#phone)
+- [postalCode](internal_.CustomerAddress.md#postalcode)
+- [shouldSaveAddress](internal_.CustomerAddress.md#shouldsaveaddress)
+- [stateOrProvince](internal_.CustomerAddress.md#stateorprovince)
+- [stateOrProvinceCode](internal_.CustomerAddress.md#stateorprovincecode)
+- [type](internal_.CustomerAddress.md#type)
+
+## Properties
+
+### address1
+
+• **address1**: `string`
+
+#### Inherited from
+
+[Address](internal_.Address.md).[address1](internal_.Address.md#address1)
+
+___
+
+### address2
+
+• **address2**: `string`
+
+#### Inherited from
+
+[Address](internal_.Address.md).[address2](internal_.Address.md#address2)
+
+___
+
+### city
+
+• **city**: `string`
+
+#### Inherited from
+
+[Address](internal_.Address.md).[city](internal_.Address.md#city)
+
+___
+
+### company
+
+• **company**: `string`
+
+#### Inherited from
+
+[Address](internal_.Address.md).[company](internal_.Address.md#company)
+
+___
+
+### country
+
+• **country**: `string`
+
+#### Inherited from
+
+[Address](internal_.Address.md).[country](internal_.Address.md#country)
+
+___
+
+### countryCode
+
+• **countryCode**: `string`
+
+#### Inherited from
+
+[Address](internal_.Address.md).[countryCode](internal_.Address.md#countrycode)
+
+___
+
+### customFields
+
+• **customFields**: { `fieldId`: `string` ; `fieldValue`: `string` \| `number` \| `string`[]  }[]
+
+#### Inherited from
+
+[Address](internal_.Address.md).[customFields](internal_.Address.md#customfields)
+
+___
+
+### firstName
+
+• **firstName**: `string`
+
+#### Inherited from
+
+[Address](internal_.Address.md).[firstName](internal_.Address.md#firstname)
+
+___
+
+### id
+
+• **id**: `number`
+
+___
+
+### lastName
+
+• **lastName**: `string`
+
+#### Inherited from
+
+[Address](internal_.Address.md).[lastName](internal_.Address.md#lastname)
+
+___
+
+### phone
+
+• **phone**: `string`
+
+#### Inherited from
+
+[Address](internal_.Address.md).[phone](internal_.Address.md#phone)
+
+___
+
+### postalCode
+
+• **postalCode**: `string`
+
+#### Inherited from
+
+[Address](internal_.Address.md).[postalCode](internal_.Address.md#postalcode)
+
+___
+
+### shouldSaveAddress
+
+• `Optional` **shouldSaveAddress**: `boolean`
+
+#### Inherited from
+
+[Address](internal_.Address.md).[shouldSaveAddress](internal_.Address.md#shouldsaveaddress)
+
+___
+
+### stateOrProvince
+
+• **stateOrProvince**: `string`
+
+#### Inherited from
+
+[Address](internal_.Address.md).[stateOrProvince](internal_.Address.md#stateorprovince)
+
+___
+
+### stateOrProvinceCode
+
+• **stateOrProvinceCode**: `string`
+
+#### Inherited from
+
+[Address](internal_.Address.md).[stateOrProvinceCode](internal_.Address.md#stateorprovincecode)
+
+___
+
+### type
+
+• **type**: `string`

package/docs/interfaces/internal_.CustomerCredentials.md

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

package/docs/interfaces/internal_.CustomerGroup.md

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

package/docs/interfaces/internal_.CustomerPasswordRequirements.md

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

package/docs/interfaces/internal_.CustomerRequestOptions.md

@@ -0,0 +1,62 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / CustomerRequestOptions
+
+# Interface: CustomerRequestOptions
+
+[<internal>](../modules/internal_.md).CustomerRequestOptions
+
+A set of options for configuring any requests related to the customer step of
+the current checkout flow.
+
+Some payment methods have their own sign-in or sign-out flow. Therefore, you
+need to indicate the method you want to use if you need to trigger a specific
+flow for signing in or out a customer. Otherwise, these options are not required.
+
+## Hierarchy
+
+- [`RequestOptions`](internal_.RequestOptions.md)
+
+  ↳ **`CustomerRequestOptions`**
+
+  ↳↳ [`ExecutePaymentMethodCheckoutOptions`](internal_.ExecutePaymentMethodCheckoutOptions.md)
+
+  ↳↳ [`BaseCustomerInitializeOptions`](internal_.BaseCustomerInitializeOptions.md)
+
+## Table of contents
+
+### Properties
+
+- [methodId](internal_.CustomerRequestOptions.md#methodid)
+- [params](internal_.CustomerRequestOptions.md#params)
+- [timeout](internal_.CustomerRequestOptions.md#timeout)
+
+## Properties
+
+### methodId
+
+• `Optional` **methodId**: `string`
+
+___
+
+### 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_.DigitalItem.md

@@ -0,0 +1,312 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / DigitalItem
+
+# Interface: DigitalItem
+
+[<internal>](../modules/internal_.md).DigitalItem
+
+## Hierarchy
+
+- [`LineItem`](internal_.LineItem.md)
+
+  ↳ **`DigitalItem`**
+
+## Table of contents
+
+### Properties
+
+- [addedByPromotion](internal_.DigitalItem.md#addedbypromotion)
+- [brand](internal_.DigitalItem.md#brand)
+- [categories](internal_.DigitalItem.md#categories)
+- [categoryNames](internal_.DigitalItem.md#categorynames)
+- [comparisonPrice](internal_.DigitalItem.md#comparisonprice)
+- [couponAmount](internal_.DigitalItem.md#couponamount)
+- [discountAmount](internal_.DigitalItem.md#discountamount)
+- [discounts](internal_.DigitalItem.md#discounts)
+- [downloadFileUrls](internal_.DigitalItem.md#downloadfileurls)
+- [downloadPageUrl](internal_.DigitalItem.md#downloadpageurl)
+- [downloadSize](internal_.DigitalItem.md#downloadsize)
+- [extendedComparisonPrice](internal_.DigitalItem.md#extendedcomparisonprice)
+- [extendedListPrice](internal_.DigitalItem.md#extendedlistprice)
+- [extendedSalePrice](internal_.DigitalItem.md#extendedsaleprice)
+- [id](internal_.DigitalItem.md#id)
+- [imageUrl](internal_.DigitalItem.md#imageurl)
+- [isTaxable](internal_.DigitalItem.md#istaxable)
+- [listPrice](internal_.DigitalItem.md#listprice)
+- [name](internal_.DigitalItem.md#name)
+- [options](internal_.DigitalItem.md#options)
+- [parentId](internal_.DigitalItem.md#parentid)
+- [productId](internal_.DigitalItem.md#productid)
+- [quantity](internal_.DigitalItem.md#quantity)
+- [salePrice](internal_.DigitalItem.md#saleprice)
+- [sku](internal_.DigitalItem.md#sku)
+- [socialMedia](internal_.DigitalItem.md#socialmedia)
+- [url](internal_.DigitalItem.md#url)
+- [variantId](internal_.DigitalItem.md#variantid)
+
+## Properties
+
+### addedByPromotion
+
+• **addedByPromotion**: `boolean`
+
+#### Inherited from
+
+[LineItem](internal_.LineItem.md).[addedByPromotion](internal_.LineItem.md#addedbypromotion)
+
+___
+
+### brand
+
+• **brand**: `string`
+
+#### Inherited from
+
+[LineItem](internal_.LineItem.md).[brand](internal_.LineItem.md#brand)
+
+___
+
+### categories
+
+• `Optional` **categories**: [`LineItemCategory`](internal_.LineItemCategory.md)[][]
+
+#### Inherited from
+
+[LineItem](internal_.LineItem.md).[categories](internal_.LineItem.md#categories)
+
+___
+
+### categoryNames
+
+• `Optional` **categoryNames**: `string`[]
+
+#### Inherited from
+
+[LineItem](internal_.LineItem.md).[categoryNames](internal_.LineItem.md#categorynames)
+
+___
+
+### comparisonPrice
+
+• **comparisonPrice**: `number`
+
+#### Inherited from
+
+[LineItem](internal_.LineItem.md).[comparisonPrice](internal_.LineItem.md#comparisonprice)
+
+___
+
+### couponAmount
+
+• **couponAmount**: `number`
+
+#### Inherited from
+
+[LineItem](internal_.LineItem.md).[couponAmount](internal_.LineItem.md#couponamount)
+
+___
+
+### discountAmount
+
+• **discountAmount**: `number`
+
+#### Inherited from
+
+[LineItem](internal_.LineItem.md).[discountAmount](internal_.LineItem.md#discountamount)
+
+___
+
+### discounts
+
+• **discounts**: { `discountedAmount`: `number` ; `name`: `string`  }[]
+
+#### Inherited from
+
+[LineItem](internal_.LineItem.md).[discounts](internal_.LineItem.md#discounts)
+
+___
+
+### downloadFileUrls
+
+• **downloadFileUrls**: `string`[]
+
+___
+
+### downloadPageUrl
+
+• **downloadPageUrl**: `string`
+
+___
+
+### downloadSize
+
+• **downloadSize**: `string`
+
+___
+
+### extendedComparisonPrice
+
+• **extendedComparisonPrice**: `number`
+
+#### Inherited from
+
+[LineItem](internal_.LineItem.md).[extendedComparisonPrice](internal_.LineItem.md#extendedcomparisonprice)
+
+___
+
+### extendedListPrice
+
+• **extendedListPrice**: `number`
+
+#### Inherited from
+
+[LineItem](internal_.LineItem.md).[extendedListPrice](internal_.LineItem.md#extendedlistprice)
+
+___
+
+### extendedSalePrice
+
+• **extendedSalePrice**: `number`
+
+#### Inherited from
+
+[LineItem](internal_.LineItem.md).[extendedSalePrice](internal_.LineItem.md#extendedsaleprice)
+
+___
+
+### id
+
+• **id**: `string` \| `number`
+
+#### Inherited from
+
+[LineItem](internal_.LineItem.md).[id](internal_.LineItem.md#id)
+
+___
+
+### imageUrl
+
+• **imageUrl**: `string`
+
+#### Inherited from
+
+[LineItem](internal_.LineItem.md).[imageUrl](internal_.LineItem.md#imageurl)
+
+___
+
+### isTaxable
+
+• **isTaxable**: `boolean`
+
+#### Inherited from
+
+[LineItem](internal_.LineItem.md).[isTaxable](internal_.LineItem.md#istaxable)
+
+___
+
+### listPrice
+
+• **listPrice**: `number`
+
+#### Inherited from
+
+[LineItem](internal_.LineItem.md).[listPrice](internal_.LineItem.md#listprice)
+
+___
+
+### name
+
+• **name**: `string`
+
+#### Inherited from
+
+[LineItem](internal_.LineItem.md).[name](internal_.LineItem.md#name)
+
+___
+
+### options
+
+• `Optional` **options**: [`LineItemOption`](internal_.LineItemOption.md)[]
+
+#### Inherited from
+
+[LineItem](internal_.LineItem.md).[options](internal_.LineItem.md#options)
+
+___
+
+### parentId
+
+• `Optional` **parentId**: ``null`` \| `string`
+
+#### Inherited from
+
+[LineItem](internal_.LineItem.md).[parentId](internal_.LineItem.md#parentid)
+
+___
+
+### productId
+
+• **productId**: `number`
+
+#### Inherited from
+
+[LineItem](internal_.LineItem.md).[productId](internal_.LineItem.md#productid)
+
+___
+
+### quantity
+
+• **quantity**: `number`
+
+#### Inherited from
+
+[LineItem](internal_.LineItem.md).[quantity](internal_.LineItem.md#quantity)
+
+___
+
+### salePrice
+
+• **salePrice**: `number`
+
+#### Inherited from
+
+[LineItem](internal_.LineItem.md).[salePrice](internal_.LineItem.md#saleprice)
+
+___
+
+### sku
+
+• **sku**: `string`
+
+#### Inherited from
+
+[LineItem](internal_.LineItem.md).[sku](internal_.LineItem.md#sku)
+
+___
+
+### socialMedia
+
+• `Optional` **socialMedia**: [`LineItemSocialData`](internal_.LineItemSocialData.md)[]
+
+#### Inherited from
+
+[LineItem](internal_.LineItem.md).[socialMedia](internal_.LineItem.md#socialmedia)
+
+___
+
+### url
+
+• **url**: `string`
+
+#### Inherited from
+
+[LineItem](internal_.LineItem.md).[url](internal_.LineItem.md#url)
+
+___
+
+### variantId
+
+• **variantId**: `number`
+
+#### Inherited from
+
+[LineItem](internal_.LineItem.md).[variantId](internal_.LineItem.md#variantid)

package/docs/interfaces/internal_.DigitalRiverElementClasses.md

@@ -0,0 +1,69 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / DigitalRiverElementClasses
+
+# Interface: DigitalRiverElementClasses
+
+[<internal>](../modules/internal_.md).DigitalRiverElementClasses
+
+Custom classes
+You can specify custom classes as part of a Class object included within the Options object when you create or
+update an element. If you do not provide custom classes, the system uses the default options.
+https://docs.digitalriver.com/digital-river-api/payment-integrations-1/digitalriver.js/reference/elements#custom-classes
+
+## Table of contents
+
+### Properties
+
+- [base](internal_.DigitalRiverElementClasses.md#base)
+- [complete](internal_.DigitalRiverElementClasses.md#complete)
+- [empty](internal_.DigitalRiverElementClasses.md#empty)
+- [focus](internal_.DigitalRiverElementClasses.md#focus)
+- [invalid](internal_.DigitalRiverElementClasses.md#invalid)
+- [webkitAutofill](internal_.DigitalRiverElementClasses.md#webkitautofill)
+
+## Properties
+
+### base
+
+• `Optional` **base**: `string`
+
+The Element is in its base state. The user either has not entered anything into the input field or is currently typing.
+
+___
+
+### complete
+
+• `Optional` **complete**: `string`
+
+The Element is in its complete state. The user has input value, and it meets the basic validation requirements of that field.
+
+___
+
+### empty
+
+• `Optional` **empty**: `string`
+
+The Element is empty. The Element once had value but is now empty.
+
+___
+
+### focus
+
+• `Optional` **focus**: `string`
+
+The Element has focus.
+
+___
+
+### invalid
+
+• `Optional` **invalid**: `string`
+
+The Element has value, but it does not meet the basic validation requirements of the field.
+
+___
+
+### webkitAutofill
+
+• `Optional` **webkitAutofill**: `string`
+
+The element has a value that has been automatically filled by the browser.