@bigcommerce/checkout-sdk 1.308.2 → 1.308.3

package/docs/interfaces/internal_.MonerisPaymentInitializeOptions.md

@@ -1,59 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / MonerisPaymentInitializeOptions
-
-# Interface: MonerisPaymentInitializeOptions
-
-[<internal>](../modules/internal_.md).MonerisPaymentInitializeOptions
-
-A set of options that are required to initialize the Moneris payment method.
-
-Once Moneris payment is initialized, a credit card payment form is provided by the
-payment provider as an IFrame, it will be inserted into the current page. These
-options provide a location and styling for the payment form.
-
-```js
-service.initializePayment({
-     methodId: 'moneris',
-     moneris: {
-         containerId: 'container',
-         style : {
-             cssBody: 'background:white;';
-             cssTextbox: 'border-width:2px;';
-             cssTextboxCardNumber: 'width:140px;';
-             cssTextboxExpiryDate: 'width:40px;';
-             cssTextboxCVV: 'width:40px';
-         }
-     }
-});
-```
-
-## Table of contents
-
-### Properties
-
-- [containerId](internal_.MonerisPaymentInitializeOptions.md#containerid)
-- [form](internal_.MonerisPaymentInitializeOptions.md#form)
-- [style](internal_.MonerisPaymentInitializeOptions.md#style)
-
-## Properties
-
-### containerId
-
-• **containerId**: `string`
-
-The ID of a container where the Moneris iframe component should be mounted
-
-___
-
-### form
-
-• `Optional` **form**: [`HostedFormOptions`](internal_.HostedFormOptions.md)
-
-Hosted Form Validation Options
-
-___
-
-### style
-
-• `Optional` **style**: [`MonerisStylingProps`](internal_.MonerisStylingProps.md)
-
-The styling props to apply to the iframe component

package/docs/interfaces/internal_.MonerisStylingProps.md

@@ -1,82 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / MonerisStylingProps
-
-# Interface: MonerisStylingProps
-
-[<internal>](../modules/internal_.md).MonerisStylingProps
-
-A set of stringified CSS to apply to Moneris' IFrame fields.
-CSS attributes should be converted to string.
-Please note that ClassNames are not supported.
-
-IE:
-```js
-{
-     cssBody: 'background:white;';
-     cssTextbox: 'border-width:2px;';
-     cssTextboxCardNumber: 'width:140px;';
-     cssTextboxExpiryDate: 'width:40px;';
-     cssTextboxCVV: 'width:40px;';
-}
-```
-
-When using several attributes use semicolon to separate each one.
-IE: 'background:white;width:40px;'
-
-## Table of contents
-
-### Properties
-
-- [cssBody](internal_.MonerisStylingProps.md#cssbody)
-- [cssInputLabel](internal_.MonerisStylingProps.md#cssinputlabel)
-- [cssTextbox](internal_.MonerisStylingProps.md#csstextbox)
-- [cssTextboxCVV](internal_.MonerisStylingProps.md#csstextboxcvv)
-- [cssTextboxCardNumber](internal_.MonerisStylingProps.md#csstextboxcardnumber)
-- [cssTextboxExpiryDate](internal_.MonerisStylingProps.md#csstextboxexpirydate)
-
-## Properties
-
-### cssBody
-
-• `Optional` **cssBody**: `string`
-
-Stringified CSS to apply to the body of the IFrame.
-
-___
-
-### cssInputLabel
-
-• `Optional` **cssInputLabel**: `string`
-
-Stringified CSS to apply to input labels
-
-___
-
-### cssTextbox
-
-• `Optional` **cssTextbox**: `string`
-
-Stringified CSS to apply to each of input fields.
-
-___
-
-### cssTextboxCVV
-
-• `Optional` **cssTextboxCVV**: `string`
-
-Stringified CSS to apply to the card's CVV field.
-
-___
-
-### cssTextboxCardNumber
-
-• `Optional` **cssTextboxCardNumber**: `string`
-
-Stringified CSS to apply to the card's number field.
-
-___
-
-### cssTextboxExpiryDate
-
-• `Optional` **cssTextboxExpiryDate**: `string`
-
-Stringified CSS to apply to the card's expiry field.

package/docs/interfaces/internal_.NonceGenerationError.md

@@ -1,31 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / NonceGenerationError
-
-# Interface: NonceGenerationError
-
-[<internal>](../modules/internal_.md).NonceGenerationError
-
-## Table of contents
-
-### Properties
-
-- [field](internal_.NonceGenerationError.md#field)
-- [message](internal_.NonceGenerationError.md#message)
-- [type](internal_.NonceGenerationError.md#type)
-
-## Properties
-
-### field
-
-• **field**: `string`
-
-___
-
-### message
-
-• **message**: `string`
-
-___
-
-### type
-
-• **type**: `string`

package/docs/interfaces/internal_.NonceInstrument.md

@@ -1,38 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / NonceInstrument
-
-# Interface: NonceInstrument
-
-[<internal>](../modules/internal_.md).NonceInstrument
-
-## Table of contents
-
-### Properties
-
-- [deviceSessionId](internal_.NonceInstrument.md#devicesessionid)
-- [nonce](internal_.NonceInstrument.md#nonce)
-- [shouldSaveInstrument](internal_.NonceInstrument.md#shouldsaveinstrument)
-- [shouldSetAsDefaultInstrument](internal_.NonceInstrument.md#shouldsetasdefaultinstrument)
-
-## Properties
-
-### deviceSessionId
-
-• `Optional` **deviceSessionId**: `string`
-
-___
-
-### nonce
-
-• **nonce**: `string`
-
-___
-
-### shouldSaveInstrument
-
-• `Optional` **shouldSaveInstrument**: `boolean`
-
-___
-
-### shouldSetAsDefaultInstrument
-
-• `Optional` **shouldSetAsDefaultInstrument**: `boolean`

package/docs/interfaces/internal_.Option_2.md

@@ -1,24 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / Option\_2
-
-# Interface: Option\_2
-
-[<internal>](../modules/internal_.md).Option_2
-
-## Table of contents
-
-### Properties
-
-- [itemQuantities](internal_.Option_2.md#itemquantities)
-- [pickupMethod](internal_.Option_2.md#pickupmethod)
-
-## Properties
-
-### itemQuantities
-
-• **itemQuantities**: [`Item`](internal_.Item.md)
-
-___
-
-### pickupMethod
-
-• **pickupMethod**: [`PickupMethod`](internal_.PickupMethod.md)

package/docs/interfaces/internal_.OptionsResponse.md

@@ -1,79 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / OptionsResponse
-
-# Interface: OptionsResponse
-
-[<internal>](../modules/internal_.md).OptionsResponse
-
-When creating your Drop-in instance, you can specify options to trigger different features or functionality.
-https://docs.digitalriver.com/digital-river-api/payment-integrations-1/drop-in/drop-in-integration-guide#drop-in-options
-
-## Table of contents
-
-### Properties
-
-- [button](internal_.OptionsResponse.md#button)
-- [flow](internal_.OptionsResponse.md#flow)
-- [paymentMethodConfiguration](internal_.OptionsResponse.md#paymentmethodconfiguration)
-- [showComplianceSection](internal_.OptionsResponse.md#showcompliancesection)
-- [showSavePaymentAgreement](internal_.OptionsResponse.md#showsavepaymentagreement)
-- [showTermsOfSaleDisclosure](internal_.OptionsResponse.md#showtermsofsaledisclosure)
-- [usage](internal_.OptionsResponse.md#usage)
-
-## Properties
-
-### button
-
-• `Optional` **button**: [`ButtonResponse`](internal_.ButtonResponse.md)
-
-Use this option to customize the text of the Drop-in button.
-
-___
-
-### flow
-
-• `Optional` **flow**: `string`
-
-Use this option if you are using Drop-in within a standard checkout flow. Example Value: "checkout"
-
-___
-
-### paymentMethodConfiguration
-
-• `Optional` **paymentMethodConfiguration**: [`BaseElementOptions`](internal_.BaseElementOptions.md)
-
-Additional configuration details for drop-in.
-
-___
-
-### showComplianceSection
-
-• `Optional` **showComplianceSection**: `boolean`
-
-Will show a localized compliance link section as part of Drop-in. This is an important piece for accessing the Digital River business model.
-
-___
-
-### showSavePaymentAgreement
-
-• `Optional` **showSavePaymentAgreement**: `boolean`
-
-When enabled, presents the customer with an option to save their payment details for future use within Drop-in.
-Enabling this feature will show the appropriate check boxes and localized disclosure statements and facilitate
-any necessary Strong Customer Authentication.
-If disabled, Drop-in will not present the customer with an option to save their payment details.
-
-___
-
-### showTermsOfSaleDisclosure
-
-• `Optional` **showTermsOfSaleDisclosure**: `boolean`
-
-Use this option to show the required terms of sale disclosure. These localized terms automatically update if recurring products are purchased.
-
-___
-
-### usage
-
-• `Optional` **usage**: `string`
-
-Use this option to specify the future use of a source.

package/docs/interfaces/internal_.OpyPaymentInitializeOptions.md

@@ -1,40 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / OpyPaymentInitializeOptions
-
-# Interface: OpyPaymentInitializeOptions
-
-[<internal>](../modules/internal_.md).OpyPaymentInitializeOptions
-
-A set of options that are required to initialize the payment step of
-checkout in order to support Opy.
-
-When Opy is initialized, a widget will be inserted into the DOM. The
-widget will open a modal that will show more information about Opy when
-clicking it.
-
-**`example`** ```html
-<!-- This is where the Opy widget will be inserted -->
-<div id="opy-widget"></div>
-```
-
-```js
-service.initializePayment({
-    methodId: 'opy',
-    opy: {
-        containerId: 'opy-widget',
-    },
-});
-```
-
-## Table of contents
-
-### Properties
-
-- [containerId](internal_.OpyPaymentInitializeOptions.md#containerid)
-
-## Properties
-
-### containerId
-
-• **containerId**: `string`
-
-The ID of a container which the payment widget should insert into.

package/docs/interfaces/internal_.Order.md

@@ -1,199 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / Order
-
-# Interface: Order
-
-[<internal>](../modules/internal_.md).Order
-
-## Table of contents
-
-### Properties
-
-- [baseAmount](internal_.Order.md#baseamount)
-- [billingAddress](internal_.Order.md#billingaddress)
-- [cartId](internal_.Order.md#cartid)
-- [channelId](internal_.Order.md#channelid)
-- [consignments](internal_.Order.md#consignments)
-- [coupons](internal_.Order.md#coupons)
-- [currency](internal_.Order.md#currency)
-- [customerCanBeCreated](internal_.Order.md#customercanbecreated)
-- [customerId](internal_.Order.md#customerid)
-- [customerMessage](internal_.Order.md#customermessage)
-- [discountAmount](internal_.Order.md#discountamount)
-- [giftWrappingCostTotal](internal_.Order.md#giftwrappingcosttotal)
-- [handlingCostTotal](internal_.Order.md#handlingcosttotal)
-- [hasDigitalItems](internal_.Order.md#hasdigitalitems)
-- [isComplete](internal_.Order.md#iscomplete)
-- [isDownloadable](internal_.Order.md#isdownloadable)
-- [isTaxIncluded](internal_.Order.md#istaxincluded)
-- [lineItems](internal_.Order.md#lineitems)
-- [orderAmount](internal_.Order.md#orderamount)
-- [orderAmountAsInteger](internal_.Order.md#orderamountasinteger)
-- [orderId](internal_.Order.md#orderid)
-- [payments](internal_.Order.md#payments)
-- [shippingCostBeforeDiscount](internal_.Order.md#shippingcostbeforediscount)
-- [shippingCostTotal](internal_.Order.md#shippingcosttotal)
-- [status](internal_.Order.md#status)
-- [taxTotal](internal_.Order.md#taxtotal)
-- [taxes](internal_.Order.md#taxes)
-
-## Properties
-
-### baseAmount
-
-• **baseAmount**: `number`
-
-___
-
-### billingAddress
-
-• **billingAddress**: [`BillingAddress`](internal_.BillingAddress.md)
-
-___
-
-### cartId
-
-• **cartId**: `string`
-
-___
-
-### channelId
-
-• **channelId**: `number`
-
-___
-
-### consignments
-
-• **consignments**: [`OrderConsignment`](internal_.OrderConsignment.md)
-
-___
-
-### coupons
-
-• **coupons**: [`Coupon`](internal_.Coupon.md)[]
-
-___
-
-### currency
-
-• **currency**: [`Currency`](internal_.Currency.md)
-
-___
-
-### customerCanBeCreated
-
-• **customerCanBeCreated**: `boolean`
-
-___
-
-### customerId
-
-• **customerId**: `number`
-
-___
-
-### customerMessage
-
-• **customerMessage**: `string`
-
-___
-
-### discountAmount
-
-• **discountAmount**: `number`
-
-___
-
-### giftWrappingCostTotal
-
-• **giftWrappingCostTotal**: `number`
-
-___
-
-### handlingCostTotal
-
-• **handlingCostTotal**: `number`
-
-___
-
-### hasDigitalItems
-
-• **hasDigitalItems**: `boolean`
-
-___
-
-### isComplete
-
-• **isComplete**: `boolean`
-
-___
-
-### isDownloadable
-
-• **isDownloadable**: `boolean`
-
-___
-
-### isTaxIncluded
-
-• **isTaxIncluded**: `boolean`
-
-___
-
-### lineItems
-
-• **lineItems**: [`LineItemMap`](internal_.LineItemMap.md)
-
-___
-
-### orderAmount
-
-• **orderAmount**: `number`
-
-___
-
-### orderAmountAsInteger
-
-• **orderAmountAsInteger**: `number`
-
-___
-
-### orderId
-
-• **orderId**: `number`
-
-___
-
-### payments
-
-• `Optional` **payments**: [`OrderPayments`](../modules/internal_.md#orderpayments)
-
-___
-
-### shippingCostBeforeDiscount
-
-• **shippingCostBeforeDiscount**: `number`
-
-___
-
-### shippingCostTotal
-
-• **shippingCostTotal**: `number`
-
-___
-
-### status
-
-• **status**: `string`
-
-___
-
-### taxTotal
-
-• **taxTotal**: `number`
-
-___
-
-### taxes
-
-• **taxes**: [`Tax`](internal_.Tax.md)[]

package/docs/interfaces/internal_.OrderConsignment.md

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

package/docs/interfaces/internal_.OrderPayment.md

@@ -1,60 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / OrderPayment
-
-# Interface: OrderPayment
-
-[<internal>](../modules/internal_.md).OrderPayment
-
-## Hierarchy
-
-- **`OrderPayment`**
-
-  ↳ [`GatewayOrderPayment`](internal_.GatewayOrderPayment.md)
-
-  ↳ [`GiftCertificateOrderPayment`](internal_.GiftCertificateOrderPayment.md)
-
-## Table of contents
-
-### Properties
-
-- [amount](internal_.OrderPayment.md#amount)
-- [description](internal_.OrderPayment.md#description)
-- [gatewayId](internal_.OrderPayment.md#gatewayid)
-- [methodId](internal_.OrderPayment.md#methodid)
-- [paymentId](internal_.OrderPayment.md#paymentid)
-- [providerId](internal_.OrderPayment.md#providerid)
-
-## Properties
-
-### amount
-
-• **amount**: `number`
-
-___
-
-### description
-
-• **description**: `string`
-
-___
-
-### gatewayId
-
-• `Optional` **gatewayId**: `string`
-
-___
-
-### methodId
-
-• `Optional` **methodId**: `string`
-
-___
-
-### paymentId
-
-• `Optional` **paymentId**: `string`
-
-___
-
-### providerId
-
-• **providerId**: `string`

package/docs/interfaces/internal_.OrderPaymentRequestBody.md

@@ -1,41 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / OrderPaymentRequestBody
-
-# Interface: OrderPaymentRequestBody
-
-[<internal>](../modules/internal_.md).OrderPaymentRequestBody
-
-An object that contains the payment information required for submitting an
-order.
-
-## Table of contents
-
-### Properties
-
-- [gatewayId](internal_.OrderPaymentRequestBody.md#gatewayid)
-- [methodId](internal_.OrderPaymentRequestBody.md#methodid)
-- [paymentData](internal_.OrderPaymentRequestBody.md#paymentdata)
-
-## Properties
-
-### gatewayId
-
-• `Optional` **gatewayId**: `string`
-
-The identifier of the payment provider that is chosen for the order.
-
-___
-
-### methodId
-
-• **methodId**: `string`
-
-The identifier of the payment method that is chosen for the order.
-
-___
-
-### paymentData
-
-• `Optional` **paymentData**: [`OrderPaymentInstrument`](../modules/internal_.md#orderpaymentinstrument)
-
-An object that contains the details of a credit card, vaulted payment
-instrument or nonce instrument.

package/docs/interfaces/internal_.OrderRequestBody.md

@@ -1,35 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / OrderRequestBody
-
-# Interface: OrderRequestBody
-
-[<internal>](../modules/internal_.md).OrderRequestBody
-
-An object that contains the information required for submitting an order.
-
-## Table of contents
-
-### Properties
-
-- [payment](internal_.OrderRequestBody.md#payment)
-- [useStoreCredit](internal_.OrderRequestBody.md#usestorecredit)
-
-## Properties
-
-### payment
-
-• `Optional` **payment**: [`OrderPaymentRequestBody`](internal_.OrderPaymentRequestBody.md)
-
-An object that contains the payment details of a customer. In some cases,
-you can omit this object if the order does not require further payment.
-For example, the customer is able to use their store credit to pay for
-the entire order. Or they have already submitted their payment details
-using PayPal.
-
-___
-
-### useStoreCredit
-
-• `Optional` **useStoreCredit**: `boolean`
-
-If true, apply the store credit of the customer to the order. It only
-works if the customer has previously signed in.