@bigcommerce/checkout-sdk 1.271.2 → 1.272.1

package/docs/interfaces/PaypalCommercePaymentInitializeOptions.md

@@ -0,0 +1,186 @@
+[@bigcommerce/checkout-sdk](../README.md) / PaypalCommercePaymentInitializeOptions
+
+# Interface: PaypalCommercePaymentInitializeOptions
+
+A set of options that are required to initialize the PayPal Commerce payment
+method for presenting its PayPal button.
+
+Please note that the minimum version of checkout-sdk is 1.100
+
+Also, PayPal (also known as PayPal Commerce Platform) requires specific options to initialize the PayPal Smart Payment Button on checkout page that substitutes a standard submit button
+```html
+<!-- This is where the PayPal button will be inserted -->
+<div id="container"></div>
+<!-- This is where the PayPal alternative payment methods fields will be inserted.  -->
+<div id="apm-fields-container"></div>
+```
+
+```js
+service.initializePayment({
+    methodId: 'paypalcommerce',
+    paypalcommerce: {
+        container: '#container',
+        apmFieldsContainer: '#apm-fields-container',
+        apmFieldsStyles: {
+            base: {
+                  backgroundColor: 'transparent',
+              },
+              input: {
+                  backgroundColor: 'white',
+                  fontSize: '1rem',
+                  color: '#333',
+                  borderColor: '#d9d9d9',
+                  borderRadius: '4px',
+                  borderWidth: '1px',
+                  padding: '1rem',
+              },
+              invalid: {
+                  color: '#ed6a6a',
+              },
+              active: {
+                  color: '#4496f6',
+              },
+        },
+        clientId: 'YOUR_CLIENT_ID',
+// Callback for submitting payment form that gets called when a buyer approves PayPal payment
+        submitForm: () => {
+        // Example function
+            this.submitOrder(
+               {
+                  payment: { methodId: 'paypalcommerce', }
+              }
+           );
+        },
+// Callback is used to define the state of the payment form, validate if it is applicable for submit.
+        onValidate: (resolve, reject) => {
+        // Example function
+            const isValid = this.validatePaymentForm();
+            if (isValid) {
+                return resolve();
+            }
+            return reject();
+        },
+// Callback that is called right before render of a Smart Payment Button. It gets called when a buyer is eligible for use of the particular PayPal method. This callback can be used to hide the standard submit button.
+        onRenderButton: () => {
+        // Example function
+            this.hidePaymentSubmitButton();
+        }
+    },
+});
+```
+
+## Table of contents
+
+### Properties
+
+- [apmFieldsContainer](PaypalCommercePaymentInitializeOptions.md#apmfieldscontainer)
+- [apmFieldsStyles](PaypalCommercePaymentInitializeOptions.md#apmfieldsstyles)
+- [clientId](PaypalCommercePaymentInitializeOptions.md#clientid)
+- [container](PaypalCommercePaymentInitializeOptions.md#container)
+
+### Methods
+
+- [onError](PaypalCommercePaymentInitializeOptions.md#onerror)
+- [onRenderButton](PaypalCommercePaymentInitializeOptions.md#onrenderbutton)
+- [onValidate](PaypalCommercePaymentInitializeOptions.md#onvalidate)
+- [submitForm](PaypalCommercePaymentInitializeOptions.md#submitform)
+
+## Properties
+
+### apmFieldsContainer
+
+• `Optional` **apmFieldsContainer**: `string`
+
+The CSS selector of a container where the alternative payment methods fields widget should be inserted into.
+It's necessary to specify this parameter when using Alternative Payment Methods.
+Without it alternative payment methods will not work.
+
+___
+
+### apmFieldsStyles
+
+• `Optional` **apmFieldsStyles**: [`PaypalFieldsStyleOptions`](PaypalFieldsStyleOptions.md)
+
+Object with styles to customize alternative payment methods fields.
+
+___
+
+### clientId
+
+• **clientId**: `string`
+
+ The Client ID of the Paypal App
+
+___
+
+### container
+
+• **container**: `string`
+
+The CSS selector of a container where the payment widget should be inserted into.
+
+## Methods
+
+### onError
+
+▸ `Optional` **onError**(`error`): `void`
+
+A callback for displaying error popup. This callback requires error object as parameter.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `error` | `Error` |
+
+#### Returns
+
+`void`
+
+___
+
+### onRenderButton
+
+▸ `Optional` **onRenderButton**(): `void`
+
+A callback right before render Smart Payment Button that gets called when
+Smart Payment Button is eligible. This callback can be used to hide the standard submit button.
+
+#### Returns
+
+`void`
+
+___
+
+### onValidate
+
+▸ **onValidate**(`resolve`, `reject`): `Promise`<`void`\>
+
+A callback that gets called when a buyer click on Smart Payment Button
+and should validate payment form.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `resolve` | () => `void` | A function, that gets called if form is valid. |
+| `reject` | () => `void` | A function, that gets called if form is not valid. |
+
+#### Returns
+
+`Promise`<`void`\>
+
+reject() or resolve()
+
+___
+
+### submitForm
+
+▸ **submitForm**(): `void`
+
+A callback for submitting payment form that gets called
+when buyer approved PayPal account.
+
+#### Returns
+
+`void`

package/docs/interfaces/PaypalCommerceStoredCardFieldOptions.md

@@ -0,0 +1,43 @@
+[@bigcommerce/checkout-sdk](../README.md) / PaypalCommerceStoredCardFieldOptions
+
+# Interface: PaypalCommerceStoredCardFieldOptions
+
+## Hierarchy
+
+- [`PaypalCommerceFormFieldOptions`](PaypalCommerceFormFieldOptions.md)
+
+  ↳ **`PaypalCommerceStoredCardFieldOptions`**
+
+## Table of contents
+
+### Properties
+
+- [containerId](PaypalCommerceStoredCardFieldOptions.md#containerid)
+- [instrumentId](PaypalCommerceStoredCardFieldOptions.md#instrumentid)
+- [placeholder](PaypalCommerceStoredCardFieldOptions.md#placeholder)
+
+## Properties
+
+### containerId
+
+• **containerId**: `string`
+
+#### Inherited from
+
+[PaypalCommerceFormFieldOptions](PaypalCommerceFormFieldOptions.md).[containerId](PaypalCommerceFormFieldOptions.md#containerid)
+
+___
+
+### instrumentId
+
+• **instrumentId**: `string`
+
+___
+
+### placeholder
+
+• `Optional` **placeholder**: `string`
+
+#### Inherited from
+
+[PaypalCommerceFormFieldOptions](PaypalCommerceFormFieldOptions.md).[placeholder](PaypalCommerceFormFieldOptions.md#placeholder)

package/docs/interfaces/PaypalCommerceStoredCardFieldsMap.md

@@ -0,0 +1,22 @@
+[@bigcommerce/checkout-sdk](../README.md) / PaypalCommerceStoredCardFieldsMap
+
+# Interface: PaypalCommerceStoredCardFieldsMap
+
+## Table of contents
+
+### Properties
+
+- [cardCodeVerification](PaypalCommerceStoredCardFieldsMap.md#cardcodeverification)
+- [cardNumberVerification](PaypalCommerceStoredCardFieldsMap.md#cardnumberverification)
+
+## Properties
+
+### cardCodeVerification
+
+• `Optional` **cardCodeVerification**: [`PaypalCommerceStoredCardFieldOptions`](PaypalCommerceStoredCardFieldOptions.md)
+
+___
+
+### cardNumberVerification
+
+• `Optional` **cardNumberVerification**: [`PaypalCommerceStoredCardFieldOptions`](PaypalCommerceStoredCardFieldOptions.md)

package/docs/interfaces/PaypalCommerceVenmoButtonInitializeOptions.md

@@ -0,0 +1,26 @@
+[@bigcommerce/checkout-sdk](../README.md) / PaypalCommerceVenmoButtonInitializeOptions
+
+# Interface: PaypalCommerceVenmoButtonInitializeOptions
+
+## Table of contents
+
+### Properties
+
+- [initializesOnCheckoutPage](PaypalCommerceVenmoButtonInitializeOptions.md#initializesoncheckoutpage)
+- [style](PaypalCommerceVenmoButtonInitializeOptions.md#style)
+
+## Properties
+
+### initializesOnCheckoutPage
+
+• `Optional` **initializesOnCheckoutPage**: `boolean`
+
+Flag which helps to detect that the strategy initializes on Checkout page
+
+___
+
+### style
+
+• `Optional` **style**: [`PaypalButtonStyleOptions_2`](PaypalButtonStyleOptions_2.md)
+
+A set of styling options for the checkout button.

package/docs/interfaces/PaypalExpressPaymentInitializeOptions.md

@@ -0,0 +1,36 @@
+[@bigcommerce/checkout-sdk](../README.md) / PaypalExpressPaymentInitializeOptions
+
+# Interface: PaypalExpressPaymentInitializeOptions
+
+A set of options that are required to initialize the PayPal Express payment
+method.
+
+```js
+service.initializePayment({
+    methodId: 'paypalexpress',
+});
+```
+
+An additional flag can be passed in to always start the payment flow through
+a redirect rather than a popup.
+
+```js
+service.initializePayment({
+    methodId: 'paypalexpress',
+    paypalexpress: {
+        useRedirectFlow: true,
+    },
+});
+```
+
+## Table of contents
+
+### Properties
+
+- [useRedirectFlow](PaypalExpressPaymentInitializeOptions.md#useredirectflow)
+
+## Properties
+
+### useRedirectFlow
+
+• `Optional` **useRedirectFlow**: `boolean`

package/docs/interfaces/PaypalFieldsStyleOptions.md

@@ -0,0 +1,46 @@
+[@bigcommerce/checkout-sdk](../README.md) / PaypalFieldsStyleOptions
+
+# Interface: PaypalFieldsStyleOptions
+
+## Table of contents
+
+### Properties
+
+- [rules](PaypalFieldsStyleOptions.md#rules)
+- [variables](PaypalFieldsStyleOptions.md#variables)
+
+## Properties
+
+### rules
+
+• `Optional` **rules**: `Object`
+
+#### Index signature
+
+▪ [key: `string`]: `any`
+
+___
+
+### variables
+
+• `Optional` **variables**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `borderColor?` | `string` |
+| `borderFocusColor?` | `string` |
+| `borderRadius?` | `string` |
+| `borderWidth?` | `string` |
+| `colorBackground?` | `string` |
+| `colorDanger?` | `string` |
+| `colorInfo?` | `string` |
+| `colorTextPlaceholder?` | `string` |
+| `fontFamily?` | `string` |
+| `fontSizeBase?` | `string` |
+| `fontSizeLg?` | `string` |
+| `fontSizeM?` | `string` |
+| `fontSizeSm?` | `string` |
+| `spacingUnit?` | `string` |
+| `textColor?` | `string` |

package/docs/interfaces/PhysicalItem.md

@@ -0,0 +1,311 @@
+[@bigcommerce/checkout-sdk](../README.md) / PhysicalItem
+
+# Interface: PhysicalItem
+
+## Hierarchy
+
+- [`LineItem`](LineItem.md)
+
+  ↳ **`PhysicalItem`**
+
+## Table of contents
+
+### Properties
+
+- [addedByPromotion](PhysicalItem.md#addedbypromotion)
+- [brand](PhysicalItem.md#brand)
+- [categories](PhysicalItem.md#categories)
+- [categoryNames](PhysicalItem.md#categorynames)
+- [comparisonPrice](PhysicalItem.md#comparisonprice)
+- [couponAmount](PhysicalItem.md#couponamount)
+- [discountAmount](PhysicalItem.md#discountamount)
+- [discounts](PhysicalItem.md#discounts)
+- [extendedComparisonPrice](PhysicalItem.md#extendedcomparisonprice)
+- [extendedListPrice](PhysicalItem.md#extendedlistprice)
+- [extendedSalePrice](PhysicalItem.md#extendedsaleprice)
+- [giftWrapping](PhysicalItem.md#giftwrapping)
+- [id](PhysicalItem.md#id)
+- [imageUrl](PhysicalItem.md#imageurl)
+- [isShippingRequired](PhysicalItem.md#isshippingrequired)
+- [isTaxable](PhysicalItem.md#istaxable)
+- [listPrice](PhysicalItem.md#listprice)
+- [name](PhysicalItem.md#name)
+- [options](PhysicalItem.md#options)
+- [parentId](PhysicalItem.md#parentid)
+- [productId](PhysicalItem.md#productid)
+- [quantity](PhysicalItem.md#quantity)
+- [salePrice](PhysicalItem.md#saleprice)
+- [sku](PhysicalItem.md#sku)
+- [socialMedia](PhysicalItem.md#socialmedia)
+- [url](PhysicalItem.md#url)
+- [variantId](PhysicalItem.md#variantid)
+
+## Properties
+
+### addedByPromotion
+
+• **addedByPromotion**: `boolean`
+
+#### Inherited from
+
+[LineItem](LineItem.md).[addedByPromotion](LineItem.md#addedbypromotion)
+
+___
+
+### brand
+
+• **brand**: `string`
+
+#### Inherited from
+
+[LineItem](LineItem.md).[brand](LineItem.md#brand)
+
+___
+
+### categories
+
+• `Optional` **categories**: [`LineItemCategory`](LineItemCategory.md)[][]
+
+#### Inherited from
+
+[LineItem](LineItem.md).[categories](LineItem.md#categories)
+
+___
+
+### categoryNames
+
+• `Optional` **categoryNames**: `string`[]
+
+#### Inherited from
+
+[LineItem](LineItem.md).[categoryNames](LineItem.md#categorynames)
+
+___
+
+### comparisonPrice
+
+• **comparisonPrice**: `number`
+
+#### Inherited from
+
+[LineItem](LineItem.md).[comparisonPrice](LineItem.md#comparisonprice)
+
+___
+
+### couponAmount
+
+• **couponAmount**: `number`
+
+#### Inherited from
+
+[LineItem](LineItem.md).[couponAmount](LineItem.md#couponamount)
+
+___
+
+### discountAmount
+
+• **discountAmount**: `number`
+
+#### Inherited from
+
+[LineItem](LineItem.md).[discountAmount](LineItem.md#discountamount)
+
+___
+
+### discounts
+
+• **discounts**: { `discountedAmount`: `number` ; `name`: `string`  }[]
+
+#### Inherited from
+
+[LineItem](LineItem.md).[discounts](LineItem.md#discounts)
+
+___
+
+### extendedComparisonPrice
+
+• **extendedComparisonPrice**: `number`
+
+#### Inherited from
+
+[LineItem](LineItem.md).[extendedComparisonPrice](LineItem.md#extendedcomparisonprice)
+
+___
+
+### extendedListPrice
+
+• **extendedListPrice**: `number`
+
+#### Inherited from
+
+[LineItem](LineItem.md).[extendedListPrice](LineItem.md#extendedlistprice)
+
+___
+
+### extendedSalePrice
+
+• **extendedSalePrice**: `number`
+
+#### Inherited from
+
+[LineItem](LineItem.md).[extendedSalePrice](LineItem.md#extendedsaleprice)
+
+___
+
+### giftWrapping
+
+• `Optional` **giftWrapping**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `amount` | `number` |
+| `message` | `string` |
+| `name` | `string` |
+
+___
+
+### id
+
+• **id**: `string` \| `number`
+
+#### Inherited from
+
+[LineItem](LineItem.md).[id](LineItem.md#id)
+
+___
+
+### imageUrl
+
+• **imageUrl**: `string`
+
+#### Inherited from
+
+[LineItem](LineItem.md).[imageUrl](LineItem.md#imageurl)
+
+___
+
+### isShippingRequired
+
+• **isShippingRequired**: `boolean`
+
+___
+
+### isTaxable
+
+• **isTaxable**: `boolean`
+
+#### Inherited from
+
+[LineItem](LineItem.md).[isTaxable](LineItem.md#istaxable)
+
+___
+
+### listPrice
+
+• **listPrice**: `number`
+
+#### Inherited from
+
+[LineItem](LineItem.md).[listPrice](LineItem.md#listprice)
+
+___
+
+### name
+
+• **name**: `string`
+
+#### Inherited from
+
+[LineItem](LineItem.md).[name](LineItem.md#name)
+
+___
+
+### options
+
+• `Optional` **options**: [`LineItemOption`](LineItemOption.md)[]
+
+#### Inherited from
+
+[LineItem](LineItem.md).[options](LineItem.md#options)
+
+___
+
+### parentId
+
+• `Optional` **parentId**: ``null`` \| `string`
+
+#### Inherited from
+
+[LineItem](LineItem.md).[parentId](LineItem.md#parentid)
+
+___
+
+### productId
+
+• **productId**: `number`
+
+#### Inherited from
+
+[LineItem](LineItem.md).[productId](LineItem.md#productid)
+
+___
+
+### quantity
+
+• **quantity**: `number`
+
+#### Inherited from
+
+[LineItem](LineItem.md).[quantity](LineItem.md#quantity)
+
+___
+
+### salePrice
+
+• **salePrice**: `number`
+
+#### Inherited from
+
+[LineItem](LineItem.md).[salePrice](LineItem.md#saleprice)
+
+___
+
+### sku
+
+• **sku**: `string`
+
+#### Inherited from
+
+[LineItem](LineItem.md).[sku](LineItem.md#sku)
+
+___
+
+### socialMedia
+
+• `Optional` **socialMedia**: [`LineItemSocialData`](LineItemSocialData.md)[]
+
+#### Inherited from
+
+[LineItem](LineItem.md).[socialMedia](LineItem.md#socialmedia)
+
+___
+
+### url
+
+• **url**: `string`
+
+#### Inherited from
+
+[LineItem](LineItem.md).[url](LineItem.md#url)
+
+___
+
+### variantId
+
+• **variantId**: `number`
+
+#### Inherited from
+
+[LineItem](LineItem.md).[variantId](LineItem.md#variantid)

package/docs/interfaces/PickupMethod.md

@@ -0,0 +1,43 @@
+[@bigcommerce/checkout-sdk](../README.md) / PickupMethod
+
+# Interface: PickupMethod
+
+## Table of contents
+
+### Properties
+
+- [collectionInstructions](PickupMethod.md#collectioninstructions)
+- [collectionTimeDescription](PickupMethod.md#collectiontimedescription)
+- [displayName](PickupMethod.md#displayname)
+- [id](PickupMethod.md#id)
+- [locationId](PickupMethod.md#locationid)
+
+## Properties
+
+### collectionInstructions
+
+• **collectionInstructions**: `string`
+
+___
+
+### collectionTimeDescription
+
+• **collectionTimeDescription**: `string`
+
+___
+
+### displayName
+
+• **displayName**: `string`
+
+___
+
+### id
+
+• **id**: `number`
+
+___
+
+### locationId
+
+• **locationId**: `number`