@bigcommerce/checkout-sdk 1.263.0 → 1.264.2

package/docs/interfaces/paymentinitializeoptions.md

@@ -1,402 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) › [PaymentInitializeOptions](paymentinitializeoptions.md)
-
-# Interface: PaymentInitializeOptions ‹**TParams**›
-
-A set of options that are required to initialize the payment step of the
-current checkout flow.
-
-## Type parameters
-
-▪ **TParams**
-
-## Hierarchy
-
-  ↳ [PaymentRequestOptions](paymentrequestoptions.md)
-
-  ↳ **PaymentInitializeOptions**
-
-## Index
-
-### Properties
-
-* [adyenv2](paymentinitializeoptions.md#optional-adyenv2)
-* [adyenv3](paymentinitializeoptions.md#optional-adyenv3)
-* [amazon](paymentinitializeoptions.md#optional-amazon)
-* [amazonpay](paymentinitializeoptions.md#optional-amazonpay)
-* [applepay](paymentinitializeoptions.md#optional-applepay)
-* [bluesnapv2](paymentinitializeoptions.md#optional-bluesnapv2)
-* [bolt](paymentinitializeoptions.md#optional-bolt)
-* [braintree](paymentinitializeoptions.md#optional-braintree)
-* [braintreevisacheckout](paymentinitializeoptions.md#optional-braintreevisacheckout)
-* [chasepay](paymentinitializeoptions.md#optional-chasepay)
-* [creditCard](paymentinitializeoptions.md#optional-creditcard)
-* [digitalriver](paymentinitializeoptions.md#optional-digitalriver)
-* [gatewayId](paymentinitializeoptions.md#optional-gatewayid)
-* [googlepayadyenv2](paymentinitializeoptions.md#optional-googlepayadyenv2)
-* [googlepayadyenv3](paymentinitializeoptions.md#optional-googlepayadyenv3)
-* [googlepayauthorizenet](paymentinitializeoptions.md#optional-googlepayauthorizenet)
-* [googlepaybraintree](paymentinitializeoptions.md#optional-googlepaybraintree)
-* [googlepaycheckoutcom](paymentinitializeoptions.md#optional-googlepaycheckoutcom)
-* [googlepaycybersourcev2](paymentinitializeoptions.md#optional-googlepaycybersourcev2)
-* [googlepayorbital](paymentinitializeoptions.md#optional-googlepayorbital)
-* [googlepaystripe](paymentinitializeoptions.md#optional-googlepaystripe)
-* [googlepaystripeupe](paymentinitializeoptions.md#optional-googlepaystripeupe)
-* [klarna](paymentinitializeoptions.md#optional-klarna)
-* [klarnav2](paymentinitializeoptions.md#optional-klarnav2)
-* [masterpass](paymentinitializeoptions.md#optional-masterpass)
-* [methodId](paymentinitializeoptions.md#methodid)
-* [mollie](paymentinitializeoptions.md#optional-mollie)
-* [moneris](paymentinitializeoptions.md#optional-moneris)
-* [opy](paymentinitializeoptions.md#optional-opy)
-* [params](paymentinitializeoptions.md#optional-params)
-* [paypalcommerce](paymentinitializeoptions.md#optional-paypalcommerce)
-* [paypalexpress](paymentinitializeoptions.md#optional-paypalexpress)
-* [square](paymentinitializeoptions.md#optional-square)
-* [stripeupe](paymentinitializeoptions.md#optional-stripeupe)
-* [stripev3](paymentinitializeoptions.md#optional-stripev3)
-* [timeout](paymentinitializeoptions.md#optional-timeout)
-* [worldpay](paymentinitializeoptions.md#optional-worldpay)
-
-## Properties
-
-### `Optional` adyenv2
-
-• **adyenv2**? : *[AdyenV2PaymentInitializeOptions](adyenv2paymentinitializeoptions.md)*
-
-The options that are required to initialize the AdyenV2 payment
-method. They can be omitted unless you need to support AdyenV2.
-
-___
-
-### `Optional` adyenv3
-
-• **adyenv3**? : *[AdyenV3PaymentInitializeOptions](adyenv3paymentinitializeoptions.md)*
-
-The options that are required to initialize the AdyenV3 payment
-method. They can be omitted unless you need to support AdyenV3.
-
-___
-
-### `Optional` amazon
-
-• **amazon**? : *[AmazonPayPaymentInitializeOptions](amazonpaypaymentinitializeoptions.md)*
-
-The options that are required to initialize the Amazon Pay payment
-method. They can be omitted unless you need to support AmazonPay.
-
-___
-
-### `Optional` amazonpay
-
-• **amazonpay**? : *[AmazonPayV2PaymentInitializeOptions](amazonpayv2paymentinitializeoptions.md)*
-
-The options that are required to initialize the AmazonPayV2 payment
-method. They can be omitted unless you need to support AmazonPayV2.
-
-___
-
-### `Optional` applepay
-
-• **applepay**? : *[ApplePayPaymentInitializeOptions](applepaypaymentinitializeoptions.md)*
-
-The options that are required to initialize the Apple Pay payment
-method. They can be omitted unless you need to support AmazonPay.
-
-___
-
-### `Optional` bluesnapv2
-
-• **bluesnapv2**? : *[BlueSnapV2PaymentInitializeOptions](bluesnapv2paymentinitializeoptions.md)*
-
-The options that are required to initialize the BlueSnapV2 payment method.
-They can be omitted unless you need to support BlueSnapV2.
-
-___
-
-### `Optional` bolt
-
-• **bolt**? : *[BoltPaymentInitializeOptions](boltpaymentinitializeoptions.md)*
-
-The options that allow Bolt to load the client script and handle the checkout.
-They can be omitted if Bolt's full checkout take over is intended.
-
-___
-
-### `Optional` braintree
-
-• **braintree**? : *[BraintreePaymentInitializeOptions](braintreepaymentinitializeoptions.md)*
-
-The options that are required to initialize the Braintree payment method.
-They can be omitted unless you need to support Braintree.
-
-___
-
-### `Optional` braintreevisacheckout
-
-• **braintreevisacheckout**? : *[BraintreeVisaCheckoutPaymentInitializeOptions](braintreevisacheckoutpaymentinitializeoptions.md)*
-
-The options that are required to initialize the Visa Checkout payment
-method provided by Braintree. They can be omitted unless you need to
-support Visa Checkout.
-
-___
-
-### `Optional` chasepay
-
-• **chasepay**? : *[ChasePayInitializeOptions](chasepayinitializeoptions.md)*
-
-The options that are required to initialize the Chasepay payment method.
-They can be omitted unless you need to support Chasepay.
-
-___
-
-### `Optional` creditCard
-
-• **creditCard**? : *[CreditCardPaymentInitializeOptions](creditcardpaymentinitializeoptions.md)*
-
-**`alpha`** 
-Please note that this option is currently in an early stage of
-development. Therefore the API is unstable and not ready for public
-consumption.
-
-___
-
-### `Optional` digitalriver
-
-• **digitalriver**? : *[DigitalRiverPaymentInitializeOptions](digitalriverpaymentinitializeoptions.md)*
-
-The options that are required to initialize the Digital River payment method.
-They can be omitted unless you need to support Digital River.
-
-___
-
-### `Optional` gatewayId
-
-• **gatewayId**? : *undefined | string*
-
-*Inherited from [PaymentInitializeOptions](paymentinitializeoptions.md).[gatewayId](paymentinitializeoptions.md#optional-gatewayid)*
-
-The identifier of the payment provider providing the payment method. This
-option is only required if the provider offers multiple payment options.
-i.e.: Adyen and Klarna.
-
-___
-
-### `Optional` googlepayadyenv2
-
-• **googlepayadyenv2**? : *[GooglePayPaymentInitializeOptions](googlepaypaymentinitializeoptions.md)*
-
-The options that are required to initialize the GooglePay Authorize.Net
-payment method. They can be omitted unless you need to support GooglePay.
-
-___
-
-### `Optional` googlepayadyenv3
-
-• **googlepayadyenv3**? : *[GooglePayPaymentInitializeOptions](googlepaypaymentinitializeoptions.md)*
-
-The options that are required to initialize the GooglePay Authorize.Net
-payment method. They can be omitted unless you need to support GooglePay.
-
-___
-
-### `Optional` googlepayauthorizenet
-
-• **googlepayauthorizenet**? : *[GooglePayPaymentInitializeOptions](googlepaypaymentinitializeoptions.md)*
-
-The options that are required to initialize the GooglePay Authorize.Net
-payment method. They can be omitted unless you need to support GooglePay.
-
-___
-
-### `Optional` googlepaybraintree
-
-• **googlepaybraintree**? : *[GooglePayPaymentInitializeOptions](googlepaypaymentinitializeoptions.md)*
-
-The options that are required to initialize the GooglePay Braintree payment method.
-They can be omitted unless you need to support GooglePay.
-
-___
-
-### `Optional` googlepaycheckoutcom
-
-• **googlepaycheckoutcom**? : *[GooglePayPaymentInitializeOptions](googlepaypaymentinitializeoptions.md)*
-
-The options that are required to initialize the GooglePay Checkout.com payment method.
-They can be omitted unless you need to support GooglePay.
-
-___
-
-### `Optional` googlepaycybersourcev2
-
-• **googlepaycybersourcev2**? : *[GooglePayPaymentInitializeOptions](googlepaypaymentinitializeoptions.md)*
-
-The options that are required to initialize the GooglePay CybersourceV2 payment method.
-They can be omitted unless you need to support GooglePay.
-
-___
-
-### `Optional` googlepayorbital
-
-• **googlepayorbital**? : *[GooglePayPaymentInitializeOptions](googlepaypaymentinitializeoptions.md)*
-
-The options that are required to initialize the GooglePay payment method.
-They can be omitted unless you need to support GooglePay.
-
-___
-
-### `Optional` googlepaystripe
-
-• **googlepaystripe**? : *[GooglePayPaymentInitializeOptions](googlepaypaymentinitializeoptions.md)*
-
-The options that are required to initialize the GooglePay Stripe payment method.
-They can be omitted unless you need to support GooglePay.
-
-___
-
-### `Optional` googlepaystripeupe
-
-• **googlepaystripeupe**? : *[GooglePayPaymentInitializeOptions](googlepaypaymentinitializeoptions.md)*
-
-The options that are required to initialize the GooglePay Stripe payment method.
-They can be omitted unless you need to support GooglePay.
-
-___
-
-### `Optional` klarna
-
-• **klarna**? : *[KlarnaPaymentInitializeOptions](klarnapaymentinitializeoptions.md)*
-
-The options that are required to initialize the Klarna payment method.
-They can be omitted unless you need to support Klarna.
-
-___
-
-### `Optional` klarnav2
-
-• **klarnav2**? : *[KlarnaV2PaymentInitializeOptions](klarnav2paymentinitializeoptions.md)*
-
-The options that are required to initialize the KlarnaV2 payment method.
-They can be omitted unless you need to support KlarnaV2.
-
-___
-
-### `Optional` masterpass
-
-• **masterpass**? : *[MasterpassPaymentInitializeOptions](masterpasspaymentinitializeoptions.md)*
-
-The options that are required to initialize the Masterpass payment method.
-They can be omitted unless you need to support Masterpass.
-
-___
-
-###  methodId
-
-• **methodId**: *string*
-
-*Inherited from [PaymentInitializeOptions](paymentinitializeoptions.md).[methodId](paymentinitializeoptions.md#methodid)*
-
-The identifier of the payment method.
-
-___
-
-### `Optional` mollie
-
-• **mollie**? : *[MolliePaymentInitializeOptions](molliepaymentinitializeoptions.md)*
-
-The options that are required to initialize the Mollie payment method.
-They can be omitted unless you need to support Mollie.
-
-___
-
-### `Optional` moneris
-
-• **moneris**? : *[MonerisPaymentInitializeOptions](monerispaymentinitializeoptions.md)*
-
-The options that are required to initialize the Moneris payment method.
-They can be omitted unless you need to support Moneris.
-
-___
-
-### `Optional` opy
-
-• **opy**? : *[OpyPaymentInitializeOptions](opypaymentinitializeoptions.md)*
-
-The options that are required to initialize the Opy payment
-method. They can be omitted unless you need to support Opy.
-
-___
-
-### `Optional` params
-
-• **params**? : *TParams*
-
-*Inherited from [CheckoutButtonInitializeOptions](checkoutbuttoninitializeoptions.md).[params](checkoutbuttoninitializeoptions.md#optional-params)*
-
-The parameters of the request, if required.
-
-___
-
-### `Optional` paypalcommerce
-
-• **paypalcommerce**? : *[PaypalCommerceInitializeOptions](../README.md#paypalcommerceinitializeoptions)*
-
-The options that are required to initialize the PayPal Commerce payment method.
-They can be omitted unless you need to support PayPal Commerce.
-
-___
-
-### `Optional` paypalexpress
-
-• **paypalexpress**? : *[PaypalExpressPaymentInitializeOptions](paypalexpresspaymentinitializeoptions.md)*
-
-The options that are required to initialize the PayPal Express payment method.
-They can be omitted unless you need to support PayPal Express.
-
-___
-
-### `Optional` square
-
-• **square**? : *[SquarePaymentInitializeOptions](squarepaymentinitializeoptions.md)*
-
-The options that are required to initialize the Square payment method.
-They can be omitted unless you need to support Square.
-
-___
-
-### `Optional` stripeupe
-
-• **stripeupe**? : *[StripeUPEPaymentInitializeOptions](stripeupepaymentinitializeoptions.md)*
-
-The options that are required to initialize the StripeUPE payment method.
-They can be omitted unless you need to support StripeUPE.
-
-___
-
-### `Optional` stripev3
-
-• **stripev3**? : *[StripeV3PaymentInitializeOptions](stripev3paymentinitializeoptions.md)*
-
-The options that are required to initialize the Stripe payment method.
-They can be omitted unless you need to support StripeV3.
-
-___
-
-### `Optional` timeout
-
-• **timeout**? : *Timeout*
-
-*Inherited from [CheckoutButtonInitializeOptions](checkoutbuttoninitializeoptions.md).[timeout](checkoutbuttoninitializeoptions.md#optional-timeout)*
-
-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.
-
-___
-
-### `Optional` worldpay
-
-• **worldpay**? : *[WorldpayPaymentInitializeOptions](worldpaypaymentinitializeoptions.md)*
-
-The options that are required to initialize the Worldpay payment method.
-They can be omitted unless you need to support Worldpay.

package/docs/interfaces/paymentmethod.md

@@ -1,96 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) › [PaymentMethod](paymentmethod.md)
-
-# Interface: PaymentMethod
-
-## Hierarchy
-
-* **PaymentMethod**
-
-## Index
-
-### Properties
-
-* [clientToken](paymentmethod.md#optional-clienttoken)
-* [config](paymentmethod.md#config)
-* [gateway](paymentmethod.md#optional-gateway)
-* [id](paymentmethod.md#id)
-* [initializationData](paymentmethod.md#optional-initializationdata)
-* [initializationStrategy](paymentmethod.md#optional-initializationstrategy)
-* [logoUrl](paymentmethod.md#optional-logourl)
-* [method](paymentmethod.md#method)
-* [nonce](paymentmethod.md#optional-nonce)
-* [returnUrl](paymentmethod.md#optional-returnurl)
-* [supportedCards](paymentmethod.md#supportedcards)
-* [type](paymentmethod.md#type)
-
-## Properties
-
-### `Optional` clientToken
-
-• **clientToken**? : *undefined | string*
-
-___
-
-###  config
-
-• **config**: *[PaymentMethodConfig](paymentmethodconfig.md)*
-
-___
-
-### `Optional` gateway
-
-• **gateway**? : *undefined | string*
-
-___
-
-###  id
-
-• **id**: *string*
-
-___
-
-### `Optional` initializationData
-
-• **initializationData**? : *any*
-
-___
-
-### `Optional` initializationStrategy
-
-• **initializationStrategy**? : *[InitializationStrategy](initializationstrategy.md)*
-
-___
-
-### `Optional` logoUrl
-
-• **logoUrl**? : *undefined | string*
-
-___
-
-###  method
-
-• **method**: *string*
-
-___
-
-### `Optional` nonce
-
-• **nonce**? : *undefined | string*
-
-___
-
-### `Optional` returnUrl
-
-• **returnUrl**? : *undefined | string*
-
-___
-
-###  supportedCards
-
-• **supportedCards**: *string[]*
-
-___
-
-###  type
-
-• **type**: *string*

package/docs/interfaces/paymentmethodconfig.md

@@ -1,124 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) › [PaymentMethodConfig](paymentmethodconfig.md)
-
-# Interface: PaymentMethodConfig
-
-## Hierarchy
-
-* **PaymentMethodConfig**
-
-## Index
-
-### Properties
-
-* [cardCode](paymentmethodconfig.md#optional-cardcode)
-* [displayName](paymentmethodconfig.md#optional-displayname)
-* [enablePaypal](paymentmethodconfig.md#optional-enablepaypal)
-* [hasDefaultStoredInstrument](paymentmethodconfig.md#optional-hasdefaultstoredinstrument)
-* [helpText](paymentmethodconfig.md#optional-helptext)
-* [is3dsEnabled](paymentmethodconfig.md#optional-is3dsenabled)
-* [isHostedFormEnabled](paymentmethodconfig.md#optional-ishostedformenabled)
-* [isVaultingCvvEnabled](paymentmethodconfig.md#optional-isvaultingcvvenabled)
-* [isVaultingEnabled](paymentmethodconfig.md#optional-isvaultingenabled)
-* [isVisaCheckoutEnabled](paymentmethodconfig.md#optional-isvisacheckoutenabled)
-* [logo](paymentmethodconfig.md#optional-logo)
-* [merchantId](paymentmethodconfig.md#optional-merchantid)
-* [redirectUrl](paymentmethodconfig.md#optional-redirecturl)
-* [requireCustomerCode](paymentmethodconfig.md#optional-requirecustomercode)
-* [returnUrl](paymentmethodconfig.md#optional-returnurl)
-* [testMode](paymentmethodconfig.md#optional-testmode)
-
-## Properties
-
-### `Optional` cardCode
-
-• **cardCode**? : *undefined | false | true*
-
-___
-
-### `Optional` displayName
-
-• **displayName**? : *undefined | string*
-
-___
-
-### `Optional` enablePaypal
-
-• **enablePaypal**? : *undefined | false | true*
-
-___
-
-### `Optional` hasDefaultStoredInstrument
-
-• **hasDefaultStoredInstrument**? : *undefined | false | true*
-
-___
-
-### `Optional` helpText
-
-• **helpText**? : *undefined | string*
-
-___
-
-### `Optional` is3dsEnabled
-
-• **is3dsEnabled**? : *undefined | false | true*
-
-___
-
-### `Optional` isHostedFormEnabled
-
-• **isHostedFormEnabled**? : *undefined | false | true*
-
-___
-
-### `Optional` isVaultingCvvEnabled
-
-• **isVaultingCvvEnabled**? : *undefined | false | true*
-
-___
-
-### `Optional` isVaultingEnabled
-
-• **isVaultingEnabled**? : *undefined | false | true*
-
-___
-
-### `Optional` isVisaCheckoutEnabled
-
-• **isVisaCheckoutEnabled**? : *undefined | false | true*
-
-___
-
-### `Optional` logo
-
-• **logo**? : *undefined | string*
-
-___
-
-### `Optional` merchantId
-
-• **merchantId**? : *undefined | string*
-
-___
-
-### `Optional` redirectUrl
-
-• **redirectUrl**? : *undefined | string*
-
-___
-
-### `Optional` requireCustomerCode
-
-• **requireCustomerCode**? : *undefined | false | true*
-
-___
-
-### `Optional` returnUrl
-
-• **returnUrl**? : *undefined | string*
-
-___
-
-### `Optional` testMode
-
-• **testMode**? : *undefined | false | true*

package/docs/interfaces/paymentrequestoptions.md

@@ -1,67 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) › [PaymentRequestOptions](paymentrequestoptions.md)
-
-# Interface: PaymentRequestOptions ‹**TParams**›
-
-The set of options for configuring any requests related to the payment step of
-the current checkout flow.
-
-## Type parameters
-
-▪ **TParams**
-
-## Hierarchy
-
-* [RequestOptions](requestoptions.md)
-
-  ↳ **PaymentRequestOptions**
-
-  ↳ [PaymentInitializeOptions](paymentinitializeoptions.md)
-
-## Index
-
-### Properties
-
-* [gatewayId](paymentrequestoptions.md#optional-gatewayid)
-* [methodId](paymentrequestoptions.md#methodid)
-* [params](paymentrequestoptions.md#optional-params)
-* [timeout](paymentrequestoptions.md#optional-timeout)
-
-## Properties
-
-### `Optional` gatewayId
-
-• **gatewayId**? : *undefined | string*
-
-The identifier of the payment provider providing the payment method. This
-option is only required if the provider offers multiple payment options.
-i.e.: Adyen and Klarna.
-
-___
-
-###  methodId
-
-• **methodId**: *string*
-
-The identifier of the payment method.
-
-___
-
-### `Optional` params
-
-• **params**? : *TParams*
-
-*Inherited from [CheckoutButtonInitializeOptions](checkoutbuttoninitializeoptions.md).[params](checkoutbuttoninitializeoptions.md#optional-params)*
-
-The parameters of the request, if required.
-
-___
-
-### `Optional` timeout
-
-• **timeout**? : *Timeout*
-
-*Inherited from [CheckoutButtonInitializeOptions](checkoutbuttoninitializeoptions.md).[timeout](checkoutbuttoninitializeoptions.md#optional-timeout)*
-
-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.

package/docs/interfaces/paymentsettings.md

@@ -1,26 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) › [PaymentSettings](paymentsettings.md)
-
-# Interface: PaymentSettings
-
-## Hierarchy
-
-* **PaymentSettings**
-
-## Index
-
-### Properties
-
-* [bigpayBaseUrl](paymentsettings.md#bigpaybaseurl)
-* [clientSidePaymentProviders](paymentsettings.md#clientsidepaymentproviders)
-
-## Properties
-
-###  bigpayBaseUrl
-
-• **bigpayBaseUrl**: *string*
-
-___
-
-###  clientSidePaymentProviders
-
-• **clientSidePaymentProviders**: *string[]*