@bigcommerce/checkout-sdk 1.271.2 → 1.272.1

package/docs/interfaces/SquarePaymentInitializeOptions.md

@@ -0,0 +1,131 @@
+[@bigcommerce/checkout-sdk](../README.md) / SquarePaymentInitializeOptions
+
+# Interface: SquarePaymentInitializeOptions
+
+A set of options that are required to initialize the Square payment method.
+
+Once Square payment is initialized, credit card form fields, provided by the
+payment provider as iframes, will be inserted into the current page. These
+options provide a location and styling for each of the form fields.
+
+```html
+<!-- These containers are where the hosted (iframed) credit card fields will be inserted -->
+<div id="card-number"></div>
+<div id="card-name"></div>
+<div id="card-expiry"></div>
+<div id="card-code"></div>
+```
+
+```js
+service.initializePayment({
+    methodId: 'squarev2',
+    square: {
+        cardNumber: {
+            elementId: 'card-number',
+        },
+        cvv: {
+            elementId: 'card-code',
+        },
+        expirationDate: {
+            elementId: 'card-expiry',
+        },
+        postalCode: {
+            elementId: 'card-code',
+        },
+    },
+});
+```
+
+## Table of contents
+
+### Properties
+
+- [cardNumber](SquarePaymentInitializeOptions.md#cardnumber)
+- [cvv](SquarePaymentInitializeOptions.md#cvv)
+- [expirationDate](SquarePaymentInitializeOptions.md#expirationdate)
+- [inputClass](SquarePaymentInitializeOptions.md#inputclass)
+- [inputStyles](SquarePaymentInitializeOptions.md#inputstyles)
+- [postalCode](SquarePaymentInitializeOptions.md#postalcode)
+
+### Methods
+
+- [onError](SquarePaymentInitializeOptions.md#onerror)
+- [onPaymentSelect](SquarePaymentInitializeOptions.md#onpaymentselect)
+
+## Properties
+
+### cardNumber
+
+• **cardNumber**: [`SquareFormElement`](SquareFormElement.md)
+
+The location to insert the credit card number form field.
+
+___
+
+### cvv
+
+• **cvv**: [`SquareFormElement`](SquareFormElement.md)
+
+The location to insert the CVV form field.
+
+___
+
+### expirationDate
+
+• **expirationDate**: [`SquareFormElement`](SquareFormElement.md)
+
+The location to insert the expiration date form field.
+
+___
+
+### inputClass
+
+• `Optional` **inputClass**: `string`
+
+The CSS class to apply to all form fields.
+
+___
+
+### inputStyles
+
+• `Optional` **inputStyles**: { [key: string]: `string`;  }[]
+
+The set of CSS styles to apply to all form fields.
+
+___
+
+### postalCode
+
+• **postalCode**: [`SquareFormElement`](SquareFormElement.md)
+
+The location to insert the postal code form field.
+
+## Methods
+
+### onError
+
+▸ `Optional` **onError**(`errors?`): `void`
+
+A callback that gets called when an error occurs in the card nonce generation
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `errors?` | [`NonceGenerationError`](NonceGenerationError.md)[] |
+
+#### Returns
+
+`void`
+
+___
+
+### onPaymentSelect
+
+▸ `Optional` **onPaymentSelect**(): `void`
+
+A callback that gets called when the customer selects a payment option.
+
+#### Returns
+
+`void`

package/docs/interfaces/StepStyles.md

@@ -0,0 +1,120 @@
+[@bigcommerce/checkout-sdk](../README.md) / StepStyles
+
+# Interface: StepStyles
+
+## Hierarchy
+
+- [`BlockElementStyles`](BlockElementStyles.md)
+
+  ↳ **`StepStyles`**
+
+## Table of contents
+
+### Properties
+
+- [backgroundColor](StepStyles.md#backgroundcolor)
+- [borderColor](StepStyles.md#bordercolor)
+- [borderWidth](StepStyles.md#borderwidth)
+- [boxShadow](StepStyles.md#boxshadow)
+- [color](StepStyles.md#color)
+- [fontFamily](StepStyles.md#fontfamily)
+- [fontWeight](StepStyles.md#fontweight)
+- [icon](StepStyles.md#icon)
+- [letterSpacing](StepStyles.md#letterspacing)
+- [lineHeight](StepStyles.md#lineheight)
+
+## Properties
+
+### backgroundColor
+
+• `Optional` **backgroundColor**: `string`
+
+#### Inherited from
+
+[BlockElementStyles](BlockElementStyles.md).[backgroundColor](BlockElementStyles.md#backgroundcolor)
+
+___
+
+### borderColor
+
+• `Optional` **borderColor**: `string`
+
+#### Inherited from
+
+[BlockElementStyles](BlockElementStyles.md).[borderColor](BlockElementStyles.md#bordercolor)
+
+___
+
+### borderWidth
+
+• `Optional` **borderWidth**: `string`
+
+#### Inherited from
+
+[BlockElementStyles](BlockElementStyles.md).[borderWidth](BlockElementStyles.md#borderwidth)
+
+___
+
+### boxShadow
+
+• `Optional` **boxShadow**: `string`
+
+#### Inherited from
+
+[BlockElementStyles](BlockElementStyles.md).[boxShadow](BlockElementStyles.md#boxshadow)
+
+___
+
+### color
+
+• `Optional` **color**: `string`
+
+#### Inherited from
+
+[BlockElementStyles](BlockElementStyles.md).[color](BlockElementStyles.md#color)
+
+___
+
+### fontFamily
+
+• `Optional` **fontFamily**: `string`
+
+#### Inherited from
+
+[BlockElementStyles](BlockElementStyles.md).[fontFamily](BlockElementStyles.md#fontfamily)
+
+___
+
+### fontWeight
+
+• `Optional` **fontWeight**: `string`
+
+#### Inherited from
+
+[BlockElementStyles](BlockElementStyles.md).[fontWeight](BlockElementStyles.md#fontweight)
+
+___
+
+### icon
+
+• `Optional` **icon**: [`BlockElementStyles`](BlockElementStyles.md)
+
+___
+
+### letterSpacing
+
+• `Optional` **letterSpacing**: `string`
+
+#### Inherited from
+
+[BlockElementStyles](BlockElementStyles.md).[letterSpacing](BlockElementStyles.md#letterspacing)
+
+___
+
+### lineHeight
+
+• `Optional` **lineHeight**: `string`
+
+#### Inherited from
+
+[BlockElementStyles](BlockElementStyles.md).[lineHeight](BlockElementStyles.md#lineheight)

package/docs/interfaces/StepTracker.md

@@ -0,0 +1,64 @@
+[@bigcommerce/checkout-sdk](../README.md) / StepTracker
+
+# Interface: StepTracker
+
+## Table of contents
+
+### Methods
+
+- [trackCheckoutStarted](StepTracker.md#trackcheckoutstarted)
+- [trackOrderComplete](StepTracker.md#trackordercomplete)
+- [trackStepCompleted](StepTracker.md#trackstepcompleted)
+- [trackStepViewed](StepTracker.md#trackstepviewed)
+
+## Methods
+
+### trackCheckoutStarted
+
+▸ **trackCheckoutStarted**(): `void`
+
+#### Returns
+
+`void`
+
+___
+
+### trackOrderComplete
+
+▸ **trackOrderComplete**(): `void`
+
+#### Returns
+
+`void`
+
+___
+
+### trackStepCompleted
+
+▸ **trackStepCompleted**(`step`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `step` | `string` |
+
+#### Returns
+
+`void`
+
+___
+
+### trackStepViewed
+
+▸ **trackStepViewed**(`step`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `step` | `string` |
+
+#### Returns
+
+`void`

package/docs/interfaces/StepTrackerConfig.md

@@ -0,0 +1,15 @@
+[@bigcommerce/checkout-sdk](../README.md) / StepTrackerConfig
+
+# Interface: StepTrackerConfig
+
+## Table of contents
+
+### Properties
+
+- [checkoutSteps](StepTrackerConfig.md#checkoutsteps)
+
+## Properties
+
+### checkoutSteps
+
+• `Optional` **checkoutSteps**: [`AnalyticStepType`](../README.md#analyticsteptype)[]

package/docs/interfaces/StoreConfig.md

@@ -0,0 +1,109 @@
+[@bigcommerce/checkout-sdk](../README.md) / StoreConfig
+
+# Interface: StoreConfig
+
+## Table of contents
+
+### Properties
+
+- [cdnPath](StoreConfig.md#cdnpath)
+- [checkoutSettings](StoreConfig.md#checkoutsettings)
+- [currency](StoreConfig.md#currency)
+- [displayDateFormat](StoreConfig.md#displaydateformat)
+- [formFields](StoreConfig.md#formfields)
+- [imageDirectory](StoreConfig.md#imagedirectory)
+- [inputDateFormat](StoreConfig.md#inputdateformat)
+- [isAngularDebuggingEnabled](StoreConfig.md#isangulardebuggingenabled)
+- [links](StoreConfig.md#links)
+- [paymentSettings](StoreConfig.md#paymentsettings)
+- [shopperConfig](StoreConfig.md#shopperconfig)
+- [shopperCurrency](StoreConfig.md#shoppercurrency)
+- [storeProfile](StoreConfig.md#storeprofile)
+
+## Properties
+
+### cdnPath
+
+• **cdnPath**: `string`
+
+___
+
+### checkoutSettings
+
+• **checkoutSettings**: [`CheckoutSettings`](CheckoutSettings.md)
+
+___
+
+### currency
+
+• **currency**: [`StoreCurrency`](StoreCurrency.md)
+
+___
+
+### displayDateFormat
+
+• **displayDateFormat**: `string`
+
+___
+
+### formFields
+
+• **formFields**: [`FormFields`](FormFields.md)
+
+**`deprecated`** Please use instead the data selectors
+
+**`remarks`**
+```js
+const data = CheckoutService.getState().data;
+const shippingAddressFields = data.getShippingAddressFields('US');
+const billingAddressFields = data.getBillingAddressFields('US');
+const customerAccountFields = data.getCustomerAccountFields();
+```
+
+___
+
+### imageDirectory
+
+• **imageDirectory**: `string`
+
+___
+
+### inputDateFormat
+
+• **inputDateFormat**: `string`
+
+___
+
+### isAngularDebuggingEnabled
+
+• **isAngularDebuggingEnabled**: `boolean`
+
+___
+
+### links
+
+• **links**: [`StoreLinks`](StoreLinks.md)
+
+___
+
+### paymentSettings
+
+• **paymentSettings**: [`PaymentSettings`](PaymentSettings.md)
+
+___
+
+### shopperConfig
+
+• **shopperConfig**: [`ShopperConfig`](ShopperConfig.md)
+
+___
+
+### shopperCurrency
+
+• **shopperCurrency**: [`ShopperCurrency`](ShopperCurrency.md)
+
+___
+
+### storeProfile
+
+• **storeProfile**: [`StoreProfile`](StoreProfile.md)

package/docs/interfaces/StoreCurrency.md

@@ -0,0 +1,56 @@
+[@bigcommerce/checkout-sdk](../README.md) / StoreCurrency
+
+# Interface: StoreCurrency
+
+## Hierarchy
+
+- **`StoreCurrency`**
+
+  ↳ [`ShopperCurrency`](ShopperCurrency.md)
+
+## Table of contents
+
+### Properties
+
+- [code](StoreCurrency.md#code)
+- [decimalPlaces](StoreCurrency.md#decimalplaces)
+- [decimalSeparator](StoreCurrency.md#decimalseparator)
+- [symbol](StoreCurrency.md#symbol)
+- [symbolLocation](StoreCurrency.md#symbollocation)
+- [thousandsSeparator](StoreCurrency.md#thousandsseparator)
+
+## Properties
+
+### code
+
+• **code**: `string`
+
+___
+
+### decimalPlaces
+
+• **decimalPlaces**: `string`
+
+___
+
+### decimalSeparator
+
+• **decimalSeparator**: `string`
+
+___
+
+### symbol
+
+• **symbol**: `string`
+
+___
+
+### symbolLocation
+
+• **symbolLocation**: `string`
+
+___
+
+### thousandsSeparator
+
+• **thousandsSeparator**: `string`

package/docs/interfaces/StoreLinks.md

@@ -0,0 +1,57 @@
+[@bigcommerce/checkout-sdk](../README.md) / StoreLinks
+
+# Interface: StoreLinks
+
+## Table of contents
+
+### Properties
+
+- [cartLink](StoreLinks.md#cartlink)
+- [checkoutLink](StoreLinks.md#checkoutlink)
+- [createAccountLink](StoreLinks.md#createaccountlink)
+- [forgotPasswordLink](StoreLinks.md#forgotpasswordlink)
+- [loginLink](StoreLinks.md#loginlink)
+- [orderConfirmationLink](StoreLinks.md#orderconfirmationlink)
+- [siteLink](StoreLinks.md#sitelink)
+
+## Properties
+
+### cartLink
+
+• **cartLink**: `string`
+
+___
+
+### checkoutLink
+
+• **checkoutLink**: `string`
+
+___
+
+### createAccountLink
+
+• **createAccountLink**: `string`
+
+___
+
+### forgotPasswordLink
+
+• **forgotPasswordLink**: `string`
+
+___
+
+### loginLink
+
+• **loginLink**: `string`
+
+___
+
+### orderConfirmationLink
+
+• **orderConfirmationLink**: `string`
+
+___
+
+### siteLink
+
+• **siteLink**: `string`

package/docs/interfaces/StoreProfile.md

@@ -0,0 +1,71 @@
+[@bigcommerce/checkout-sdk](../README.md) / StoreProfile
+
+# Interface: StoreProfile
+
+## Table of contents
+
+### Properties
+
+- [orderEmail](StoreProfile.md#orderemail)
+- [shopPath](StoreProfile.md#shoppath)
+- [storeCountry](StoreProfile.md#storecountry)
+- [storeCountryCode](StoreProfile.md#storecountrycode)
+- [storeHash](StoreProfile.md#storehash)
+- [storeId](StoreProfile.md#storeid)
+- [storeLanguage](StoreProfile.md#storelanguage)
+- [storeName](StoreProfile.md#storename)
+- [storePhoneNumber](StoreProfile.md#storephonenumber)
+
+## Properties
+
+### orderEmail
+
+• **orderEmail**: `string`
+
+___
+
+### shopPath
+
+• **shopPath**: `string`
+
+___
+
+### storeCountry
+
+• **storeCountry**: `string`
+
+___
+
+### storeCountryCode
+
+• **storeCountryCode**: `string`
+
+___
+
+### storeHash
+
+• **storeHash**: `string`
+
+___
+
+### storeId
+
+• **storeId**: `string`
+
+___
+
+### storeLanguage
+
+• **storeLanguage**: `string`
+
+___
+
+### storeName
+
+• **storeName**: `string`
+
+___
+
+### storePhoneNumber
+
+• **storePhoneNumber**: `string`