@bigcommerce/checkout-sdk 1.271.2 → 1.271.3

package/docs/interfaces/MonerisStylingProps.md

@@ -0,0 +1,80 @@
+[@bigcommerce/checkout-sdk](../README.md) / MonerisStylingProps
+
+# Interface: 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](MonerisStylingProps.md#cssbody)
+- [cssInputLabel](MonerisStylingProps.md#cssinputlabel)
+- [cssTextbox](MonerisStylingProps.md#csstextbox)
+- [cssTextboxCVV](MonerisStylingProps.md#csstextboxcvv)
+- [cssTextboxCardNumber](MonerisStylingProps.md#csstextboxcardnumber)
+- [cssTextboxExpiryDate](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/NonceGenerationError.md

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

package/docs/interfaces/NonceInstrument.md

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

package/docs/interfaces/Option.md

@@ -0,0 +1,22 @@
+[@bigcommerce/checkout-sdk](../README.md) / Option
+
+# Interface: Option
+
+## Table of contents
+
+### Properties
+
+- [itemQuantities](Option.md#itemquantities)
+- [pickupMethod](Option.md#pickupmethod)
+
+## Properties
+
+### itemQuantities
+
+• **itemQuantities**: [`Item`](Item.md)
+
+___
+
+### pickupMethod
+
+• **pickupMethod**: [`PickupMethod`](PickupMethod.md)

package/docs/interfaces/OptionsResponse.md

@@ -0,0 +1,77 @@
+[@bigcommerce/checkout-sdk](../README.md) / OptionsResponse
+
+# Interface: 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](OptionsResponse.md#button)
+- [flow](OptionsResponse.md#flow)
+- [paymentMethodConfiguration](OptionsResponse.md#paymentmethodconfiguration)
+- [showComplianceSection](OptionsResponse.md#showcompliancesection)
+- [showSavePaymentAgreement](OptionsResponse.md#showsavepaymentagreement)
+- [showTermsOfSaleDisclosure](OptionsResponse.md#showtermsofsaledisclosure)
+- [usage](OptionsResponse.md#usage)
+
+## Properties
+
+### button
+
+• `Optional` **button**: [`ButtonResponse`](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`](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/OpyPaymentInitializeOptions.md

@@ -0,0 +1,40 @@
+[@bigcommerce/checkout-sdk](../README.md) / OpyPaymentInitializeOptions
+
+# Interface: 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](OpyPaymentInitializeOptions.md#containerid)
+
+## Properties
+
+### containerId
+
+• **containerId**: `string`
+
+The ID of a container which the payment widget should insert into.

package/docs/interfaces/Order.md

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

package/docs/interfaces/OrderConsignment.md

@@ -0,0 +1,15 @@
+[@bigcommerce/checkout-sdk](../README.md) / OrderConsignment
+
+# Interface: OrderConsignment
+
+## Table of contents
+
+### Properties
+
+- [shipping](OrderConsignment.md#shipping)
+
+## Properties
+
+### shipping
+
+• **shipping**: [`OrderShippingConsignment`](OrderShippingConsignment.md)[]

package/docs/interfaces/OrderPayment.md

@@ -0,0 +1,58 @@
+[@bigcommerce/checkout-sdk](../README.md) / OrderPayment
+
+# Interface: OrderPayment
+
+## Hierarchy
+
+- **`OrderPayment`**
+
+  ↳ [`GatewayOrderPayment`](GatewayOrderPayment.md)
+
+  ↳ [`GiftCertificateOrderPayment`](GiftCertificateOrderPayment.md)
+
+## Table of contents
+
+### Properties
+
+- [amount](OrderPayment.md#amount)
+- [description](OrderPayment.md#description)
+- [gatewayId](OrderPayment.md#gatewayid)
+- [methodId](OrderPayment.md#methodid)
+- [paymentId](OrderPayment.md#paymentid)
+- [providerId](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/OrderPaymentRequestBody.md

@@ -0,0 +1,39 @@
+[@bigcommerce/checkout-sdk](../README.md) / OrderPaymentRequestBody
+
+# Interface: OrderPaymentRequestBody
+
+An object that contains the payment information required for submitting an
+order.
+
+## Table of contents
+
+### Properties
+
+- [gatewayId](OrderPaymentRequestBody.md#gatewayid)
+- [methodId](OrderPaymentRequestBody.md#methodid)
+- [paymentData](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**: [`CreditCardInstrument`](CreditCardInstrument.md) \| [`HostedInstrument`](HostedInstrument.md) \| [`VaultedInstrument`](VaultedInstrument.md) \| [`NonceInstrument`](NonceInstrument.md) \| `Pick`<[`CreditCardInstrument`](CreditCardInstrument.md), ``"ccCustomerCode"`` \| ``"shouldSaveInstrument"`` \| ``"shouldSetAsDefaultInstrument"`` \| ``"extraData"`` \| ``"threeDSecure"`` \| ``"browser_info"``\> \| `Pick`<[`VaultedInstrument`](VaultedInstrument.md), ``"instrumentId"``\> \| [`WithAccountCreation`](WithAccountCreation.md) \| [`CreditCardInstrument`](CreditCardInstrument.md) & [`WithDocumentInstrument`](WithDocumentInstrument.md) \| [`CreditCardInstrument`](CreditCardInstrument.md) & [`WithCheckoutcomFawryInstrument`](WithCheckoutcomFawryInstrument.md) \| [`CreditCardInstrument`](CreditCardInstrument.md) & [`WithCheckoutcomSEPAInstrument`](WithCheckoutcomSEPAInstrument.md) \| [`CreditCardInstrument`](CreditCardInstrument.md) & [`WithCheckoutcomiDealInstrument`](WithCheckoutcomiDealInstrument.md) \| [`HostedInstrument`](HostedInstrument.md) & [`WithMollieIssuerInstrument`](WithMollieIssuerInstrument.md)
+
+An object that contains the details of a credit card, vaulted payment
+instrument or nonce instrument.

package/docs/interfaces/OrderRequestBody.md

@@ -0,0 +1,33 @@
+[@bigcommerce/checkout-sdk](../README.md) / OrderRequestBody
+
+# Interface: OrderRequestBody
+
+An object that contains the information required for submitting an order.
+
+## Table of contents
+
+### Properties
+
+- [payment](OrderRequestBody.md#payment)
+- [useStoreCredit](OrderRequestBody.md#usestorecredit)
+
+## Properties
+
+### payment
+
+• `Optional` **payment**: [`OrderPaymentRequestBody`](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.