@bigcommerce/checkout-sdk 1.308.2 → 1.308.3

package/docs/interfaces/internal_.PaypalButtonInitializeOptions.md

@@ -0,0 +1,78 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / PaypalButtonInitializeOptions
+
+# Interface: PaypalButtonInitializeOptions
+
+[<internal>](../modules/internal_.md).PaypalButtonInitializeOptions
+
+## Table of contents
+
+### Properties
+
+- [allowCredit](internal_.PaypalButtonInitializeOptions.md#allowcredit)
+- [clientId](internal_.PaypalButtonInitializeOptions.md#clientid)
+- [style](internal_.PaypalButtonInitializeOptions.md#style)
+
+### Methods
+
+- [onAuthorizeError](internal_.PaypalButtonInitializeOptions.md#onauthorizeerror)
+- [onPaymentError](internal_.PaypalButtonInitializeOptions.md#onpaymenterror)
+
+## Properties
+
+### allowCredit
+
+• `Optional` **allowCredit**: `boolean`
+
+Whether or not to show a credit button.
+
+___
+
+### clientId
+
+• **clientId**: `string`
+
+The Client ID of the Paypal App
+
+___
+
+### style
+
+• `Optional` **style**: `Pick`<[`PaypalButtonStyleOptions`](internal_.PaypalButtonStyleOptions.md), ``"label"`` \| ``"size"`` \| ``"color"`` \| ``"layout"`` \| ``"shape"`` \| ``"tagline"`` \| ``"fundingicons"``\>
+
+A set of styling options for the checkout button.
+
+## Methods
+
+### onAuthorizeError
+
+▸ `Optional` **onAuthorizeError**(`error`): `void`
+
+A callback that gets called if unable to authorize and tokenize payment.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `error` | [`StandardError`](../classes/internal_.StandardError.md) | The error object describing the failure. |
+
+#### Returns
+
+`void`
+
+___
+
+### onPaymentError
+
+▸ `Optional` **onPaymentError**(`error`): `void`
+
+A callback that gets called if unable to submit payment.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `error` | [`StandardError`](../classes/internal_.StandardError.md) | The error object describing the failure. |
+
+#### Returns
+
+`void`

package/docs/interfaces/internal_.PaypalButtonStyleOptions.md

@@ -0,0 +1,66 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / PaypalButtonStyleOptions
+
+# Interface: PaypalButtonStyleOptions
+
+[<internal>](../modules/internal_.md).PaypalButtonStyleOptions
+
+## Table of contents
+
+### Properties
+
+- [color](internal_.PaypalButtonStyleOptions.md#color)
+- [fundingicons](internal_.PaypalButtonStyleOptions.md#fundingicons)
+- [height](internal_.PaypalButtonStyleOptions.md#height)
+- [label](internal_.PaypalButtonStyleOptions.md#label)
+- [layout](internal_.PaypalButtonStyleOptions.md#layout)
+- [shape](internal_.PaypalButtonStyleOptions.md#shape)
+- [size](internal_.PaypalButtonStyleOptions.md#size)
+- [tagline](internal_.PaypalButtonStyleOptions.md#tagline)
+
+## Properties
+
+### color
+
+• `Optional` **color**: [`PaypalButtonStyleColorOption`](../enums/internal_.PaypalButtonStyleColorOption.md)
+
+___
+
+### fundingicons
+
+• `Optional` **fundingicons**: `boolean`
+
+___
+
+### height
+
+• `Optional` **height**: `number`
+
+___
+
+### label
+
+• `Optional` **label**: [`PaypalButtonStyleLabelOption`](../enums/internal_.PaypalButtonStyleLabelOption.md)
+
+___
+
+### layout
+
+• `Optional` **layout**: [`PaypalButtonStyleLayoutOption`](../enums/internal_.PaypalButtonStyleLayoutOption.md)
+
+___
+
+### shape
+
+• `Optional` **shape**: [`PaypalButtonStyleShapeOption`](../enums/internal_.PaypalButtonStyleShapeOption.md)
+
+___
+
+### size
+
+• `Optional` **size**: [`PaypalButtonStyleSizeOption`](../enums/internal_.PaypalButtonStyleSizeOption.md)
+
+___
+
+### tagline
+
+• `Optional` **tagline**: `boolean`

package/docs/interfaces/internal_.PaypalButtonStyleOptions_2.md

@@ -0,0 +1,69 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / PaypalButtonStyleOptions\_2
+
+# Interface: PaypalButtonStyleOptions\_2
+
+[<internal>](../modules/internal_.md).PaypalButtonStyleOptions_2
+
+## Table of contents
+
+### Properties
+
+- [color](internal_.PaypalButtonStyleOptions_2.md#color)
+- [custom](internal_.PaypalButtonStyleOptions_2.md#custom)
+- [height](internal_.PaypalButtonStyleOptions_2.md#height)
+- [label](internal_.PaypalButtonStyleOptions_2.md#label)
+- [layout](internal_.PaypalButtonStyleOptions_2.md#layout)
+- [shape](internal_.PaypalButtonStyleOptions_2.md#shape)
+- [tagline](internal_.PaypalButtonStyleOptions_2.md#tagline)
+
+## Properties
+
+### color
+
+• `Optional` **color**: [`StyleButtonColor`](../enums/internal_.StyleButtonColor.md)
+
+___
+
+### custom
+
+• `Optional` **custom**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `css?` | { `background?`: `string` ; `color?`: `string` ; `width?`: `string`  } |
+| `css.background?` | `string` |
+| `css.color?` | `string` |
+| `css.width?` | `string` |
+| `label?` | `string` |
+
+___
+
+### height
+
+• `Optional` **height**: `number`
+
+___
+
+### label
+
+• `Optional` **label**: [`StyleButtonLabel`](../enums/internal_.StyleButtonLabel.md)
+
+___
+
+### layout
+
+• `Optional` **layout**: [`StyleButtonLayout`](../enums/internal_.StyleButtonLayout.md)
+
+___
+
+### shape
+
+• `Optional` **shape**: [`StyleButtonShape`](../enums/internal_.StyleButtonShape.md)
+
+___
+
+### tagline
+
+• `Optional` **tagline**: `boolean`

package/docs/interfaces/internal_.PaypalCommerceAlternativeMethodsButtonOptions.md

@@ -0,0 +1,61 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / PaypalCommerceAlternativeMethodsButtonOptions
+
+# Interface: PaypalCommerceAlternativeMethodsButtonOptions
+
+[<internal>](../modules/internal_.md).PaypalCommerceAlternativeMethodsButtonOptions
+
+## Table of contents
+
+### Properties
+
+- [apm](internal_.PaypalCommerceAlternativeMethodsButtonOptions.md#apm)
+- [buyNowInitializeOptions](internal_.PaypalCommerceAlternativeMethodsButtonOptions.md#buynowinitializeoptions)
+- [currencyCode](internal_.PaypalCommerceAlternativeMethodsButtonOptions.md#currencycode)
+- [initializesOnCheckoutPage](internal_.PaypalCommerceAlternativeMethodsButtonOptions.md#initializesoncheckoutpage)
+- [style](internal_.PaypalCommerceAlternativeMethodsButtonOptions.md#style)
+
+## Properties
+
+### apm
+
+• **apm**: `string`
+
+Alternative payment method id what used for initialization PayPal button as funding source.
+
+___
+
+### buyNowInitializeOptions
+
+• `Optional` **buyNowInitializeOptions**: `Object`
+
+The options that are required to initialize Buy Now functionality.
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `getBuyNowCartRequestBody?` | () => `void` \| [`BuyNowCartRequestBody`](internal_.BuyNowCartRequestBody.md) |
+
+___
+
+### currencyCode
+
+• `Optional` **currencyCode**: `string`
+
+The option that used to initialize a PayPal script with provided currency code.
+
+___
+
+### initializesOnCheckoutPage
+
+• `Optional` **initializesOnCheckoutPage**: `boolean`
+
+Flag which helps to detect that the strategy initializes on Checkout page.
+
+___
+
+### style
+
+• `Optional` **style**: [`PaypalButtonStyleOptions_2`](internal_.PaypalButtonStyleOptions_2.md)
+
+A set of styling options for the checkout button.

package/docs/interfaces/internal_.PaypalCommerceButtonInitializeOptions.md

@@ -0,0 +1,68 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / PaypalCommerceButtonInitializeOptions
+
+# Interface: PaypalCommerceButtonInitializeOptions
+
+[<internal>](../modules/internal_.md).PaypalCommerceButtonInitializeOptions
+
+## Table of contents
+
+### Properties
+
+- [buyNowInitializeOptions](internal_.PaypalCommerceButtonInitializeOptions.md#buynowinitializeoptions)
+- [currencyCode](internal_.PaypalCommerceButtonInitializeOptions.md#currencycode)
+- [initializesOnCheckoutPage](internal_.PaypalCommerceButtonInitializeOptions.md#initializesoncheckoutpage)
+- [style](internal_.PaypalCommerceButtonInitializeOptions.md#style)
+
+### Methods
+
+- [onComplete](internal_.PaypalCommerceButtonInitializeOptions.md#oncomplete)
+
+## Properties
+
+### buyNowInitializeOptions
+
+• `Optional` **buyNowInitializeOptions**: `Object`
+
+The options that are required to initialize Buy Now functionality.
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `getBuyNowCartRequestBody?` | () => `void` \| [`BuyNowCartRequestBody`](internal_.BuyNowCartRequestBody.md) |
+
+___
+
+### currencyCode
+
+• `Optional` **currencyCode**: `string`
+
+The option that used to initialize a PayPal script with provided currency code.
+
+___
+
+### initializesOnCheckoutPage
+
+• `Optional` **initializesOnCheckoutPage**: `boolean`
+
+Flag which helps to detect that the strategy initializes on Checkout page.
+
+___
+
+### style
+
+• `Optional` **style**: [`PaypalButtonStyleOptions_2`](internal_.PaypalButtonStyleOptions_2.md)
+
+A set of styling options for the checkout button.
+
+## Methods
+
+### onComplete
+
+▸ `Optional` **onComplete**(): `void`
+
+A callback that gets called when payment complete on paypal side.
+
+#### Returns
+
+`void`

package/docs/interfaces/internal_.PaypalCommerceCreditButtonInitializeOptions.md

@@ -0,0 +1,77 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / PaypalCommerceCreditButtonInitializeOptions
+
+# Interface: PaypalCommerceCreditButtonInitializeOptions
+
+[<internal>](../modules/internal_.md).PaypalCommerceCreditButtonInitializeOptions
+
+## Table of contents
+
+### Properties
+
+- [buyNowInitializeOptions](internal_.PaypalCommerceCreditButtonInitializeOptions.md#buynowinitializeoptions)
+- [currencyCode](internal_.PaypalCommerceCreditButtonInitializeOptions.md#currencycode)
+- [initializesOnCheckoutPage](internal_.PaypalCommerceCreditButtonInitializeOptions.md#initializesoncheckoutpage)
+- [messagingContainerId](internal_.PaypalCommerceCreditButtonInitializeOptions.md#messagingcontainerid)
+- [style](internal_.PaypalCommerceCreditButtonInitializeOptions.md#style)
+
+### Methods
+
+- [onComplete](internal_.PaypalCommerceCreditButtonInitializeOptions.md#oncomplete)
+
+## Properties
+
+### buyNowInitializeOptions
+
+• `Optional` **buyNowInitializeOptions**: `Object`
+
+The options that are required to initialize Buy Now functionality.
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `getBuyNowCartRequestBody?` | () => `void` \| [`BuyNowCartRequestBody`](internal_.BuyNowCartRequestBody.md) |
+
+___
+
+### currencyCode
+
+• `Optional` **currencyCode**: `string`
+
+The option that used to initialize a PayPal script with provided currency code.
+
+___
+
+### initializesOnCheckoutPage
+
+• `Optional` **initializesOnCheckoutPage**: `boolean`
+
+Flag which helps to detect that the strategy initializes on Checkout page
+
+___
+
+### messagingContainerId
+
+• `Optional` **messagingContainerId**: `string`
+
+The ID of a container which the messaging should be inserted.
+
+___
+
+### style
+
+• `Optional` **style**: [`PaypalButtonStyleOptions_2`](internal_.PaypalButtonStyleOptions_2.md)
+
+A set of styling options for the checkout button.
+
+## Methods
+
+### onComplete
+
+▸ `Optional` **onComplete**(): `void`
+
+A callback that gets called when payment complete on paypal side.
+
+#### Returns
+
+`void`

package/docs/interfaces/internal_.PaypalCommerceInlineCheckoutButtonInitializeOptions.md

@@ -0,0 +1,58 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / PaypalCommerceInlineCheckoutButtonInitializeOptions
+
+# Interface: PaypalCommerceInlineCheckoutButtonInitializeOptions
+
+[<internal>](../modules/internal_.md).PaypalCommerceInlineCheckoutButtonInitializeOptions
+
+## Table of contents
+
+### Properties
+
+- [buttonContainerClassName](internal_.PaypalCommerceInlineCheckoutButtonInitializeOptions.md#buttoncontainerclassname)
+- [style](internal_.PaypalCommerceInlineCheckoutButtonInitializeOptions.md#style)
+
+### Methods
+
+- [onComplete](internal_.PaypalCommerceInlineCheckoutButtonInitializeOptions.md#oncomplete)
+- [onError](internal_.PaypalCommerceInlineCheckoutButtonInitializeOptions.md#onerror)
+
+## Properties
+
+### buttonContainerClassName
+
+• `Optional` **buttonContainerClassName**: `string`
+
+A class name used to add special class for container where the button will be generated in
+Default: 'PaypalCommerceInlineButton'
+
+___
+
+### style
+
+• `Optional` **style**: [`PaypalButtonStyleOptions_2`](internal_.PaypalButtonStyleOptions_2.md)
+
+A set of styling options for the checkout button.
+
+## Methods
+
+### onComplete
+
+▸ **onComplete**(): `void`
+
+A callback that gets called when payment complete on paypal side.
+
+#### Returns
+
+`void`
+
+___
+
+### onError
+
+▸ `Optional` **onError**(): `void`
+
+A callback that gets called on any error
+
+#### Returns
+
+`void`

package/docs/interfaces/internal_.PaypalCommerceVenmoButtonInitializeOptions.md

@@ -0,0 +1,52 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / PaypalCommerceVenmoButtonInitializeOptions
+
+# Interface: PaypalCommerceVenmoButtonInitializeOptions
+
+[<internal>](../modules/internal_.md).PaypalCommerceVenmoButtonInitializeOptions
+
+## Table of contents
+
+### Properties
+
+- [buyNowInitializeOptions](internal_.PaypalCommerceVenmoButtonInitializeOptions.md#buynowinitializeoptions)
+- [currencyCode](internal_.PaypalCommerceVenmoButtonInitializeOptions.md#currencycode)
+- [initializesOnCheckoutPage](internal_.PaypalCommerceVenmoButtonInitializeOptions.md#initializesoncheckoutpage)
+- [style](internal_.PaypalCommerceVenmoButtonInitializeOptions.md#style)
+
+## Properties
+
+### buyNowInitializeOptions
+
+• `Optional` **buyNowInitializeOptions**: `Object`
+
+The options that are required to initialize Buy Now functionality.
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `getBuyNowCartRequestBody?` | () => `void` \| [`BuyNowCartRequestBody`](internal_.BuyNowCartRequestBody.md) |
+
+___
+
+### currencyCode
+
+• `Optional` **currencyCode**: `string`
+
+The option that used to initialize a PayPal script with provided currency code.
+
+___
+
+### initializesOnCheckoutPage
+
+• `Optional` **initializesOnCheckoutPage**: `boolean`
+
+Flag which helps to detect that the strategy initializes on Checkout page
+
+___
+
+### style
+
+• `Optional` **style**: [`PaypalButtonStyleOptions_2`](internal_.PaypalButtonStyleOptions_2.md)
+
+A set of styling options for the checkout button.

package/docs/interfaces/internal_.RequestOptions.md

@@ -16,11 +16,7 @@ A set of options for configuring an asynchronous request.
 
 - **`RequestOptions`**
 
-  ↳ [`PaymentRequestOptions`](internal_.PaymentRequestOptions.md)
-
-  ↳ [`CustomerRequestOptions`](internal_.CustomerRequestOptions.md)
-
-  ↳ [`ShippingRequestOptions`](internal_.ShippingRequestOptions.md)
+  ↳ [`CheckoutButtonOptions`](internal_.CheckoutButtonOptions.md)
 
 ## Table of contents
 

package/docs/interfaces/internal_.WithApplePayButtonInitializeOptions.md

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