@bigcommerce/checkout-sdk 1.215.1 → 1.219.0

package/dist/internal-mappers.d.ts

@@ -201,6 +201,10 @@ declare interface GatewayOrderPayment extends OrderPayment {
         step: string;
         instructions: string;
     };
+    mandate?: {
+        id: string;
+        url?: string;
+    };
 }
 
 declare interface GiftCertificate {
@@ -584,7 +588,6 @@ declare interface Order {
     status: string;
     taxes: Tax[];
     taxTotal: number;
-    mandateUrl?: string;
 }
 
 declare interface OrderConsignment {
@@ -601,6 +604,7 @@ declare interface OrderMetaState extends InternalOrderMeta {
 declare interface OrderPayment {
     providerId: string;
     gatewayId?: string;
+    methodId?: string;
     paymentId?: string;
     description: string;
     amount: number;

package/docs/README.md

@@ -225,6 +225,7 @@
 * [NonceGenerationError](interfaces/noncegenerationerror.md)
 * [NonceInstrument](interfaces/nonceinstrument.md)
 * [OptionsResponse](interfaces/optionsresponse.md)
+* [OpyPaymentInitializeOptions](interfaces/opypaymentinitializeoptions.md)
 * [Order](interfaces/order.md)
 * [OrderConsignment](interfaces/orderconsignment.md)
 * [OrderPayment](interfaces/orderpayment.md)

package/docs/interfaces/gatewayorderpayment.md

@@ -16,6 +16,8 @@
 * [description](gatewayorderpayment.md#description)
 * [detail](gatewayorderpayment.md#detail)
 * [gatewayId](gatewayorderpayment.md#optional-gatewayid)
+* [mandate](gatewayorderpayment.md#optional-mandate)
+* [methodId](gatewayorderpayment.md#optional-methodid)
 * [paymentId](gatewayorderpayment.md#optional-paymentid)
 * [providerId](gatewayorderpayment.md#providerid)
 
@@ -57,6 +59,20 @@ ___
 
 ___
 
+### `Optional` mandate
+
+• **mandate**? : *undefined | object*
+
+___
+
+### `Optional` methodId
+
+• **methodId**? : *undefined | string*
+
+*Inherited from [GatewayOrderPayment](gatewayorderpayment.md).[methodId](gatewayorderpayment.md#optional-methodid)*
+
+___
+
 ### `Optional` paymentId
 
 • **paymentId**? : *undefined | string*

package/docs/interfaces/giftcertificateorderpayment.md

@@ -16,6 +16,7 @@
 * [description](giftcertificateorderpayment.md#description)
 * [detail](giftcertificateorderpayment.md#detail)
 * [gatewayId](giftcertificateorderpayment.md#optional-gatewayid)
+* [methodId](giftcertificateorderpayment.md#optional-methodid)
 * [paymentId](giftcertificateorderpayment.md#optional-paymentid)
 * [providerId](giftcertificateorderpayment.md#providerid)
 
@@ -57,6 +58,14 @@ ___
 
 ___
 
+### `Optional` methodId
+
+• **methodId**? : *undefined | string*
+
+*Inherited from [GatewayOrderPayment](gatewayorderpayment.md).[methodId](gatewayorderpayment.md#optional-methodid)*
+
+___
+
 ### `Optional` paymentId
 
 • **paymentId**? : *undefined | string*

package/docs/interfaces/opypaymentinitializeoptions.md

@@ -0,0 +1,44 @@
+[@bigcommerce/checkout-sdk](../README.md) › [OpyPaymentInitializeOptions](opypaymentinitializeoptions.md)
+
+# 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',
+    },
+});
+```
+
+## Hierarchy
+
+* **OpyPaymentInitializeOptions**
+
+## Index
+
+### 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

@@ -27,7 +27,6 @@
 * [isDownloadable](order.md#isdownloadable)
 * [isTaxIncluded](order.md#istaxincluded)
 * [lineItems](order.md#lineitems)
-* [mandateUrl](order.md#optional-mandateurl)
 * [orderAmount](order.md#orderamount)
 * [orderAmountAsInteger](order.md#orderamountasinteger)
 * [orderId](order.md#orderid)
@@ -142,12 +141,6 @@ ___
 
 ___
 
-### `Optional` mandateUrl
-
-• **mandateUrl**? : *undefined | string*
-
-___
-
 ###  orderAmount
 
 • **orderAmount**: *number*

package/docs/interfaces/orderpayment.md

@@ -17,6 +17,7 @@
 * [amount](orderpayment.md#amount)
 * [description](orderpayment.md#description)
 * [gatewayId](orderpayment.md#optional-gatewayid)
+* [methodId](orderpayment.md#optional-methodid)
 * [paymentId](orderpayment.md#optional-paymentid)
 * [providerId](orderpayment.md#providerid)
 
@@ -40,6 +41,12 @@ ___
 
 ___
 
+### `Optional` methodId
+
+• **methodId**? : *undefined | string*
+
+___
+
 ### `Optional` paymentId
 
 • **paymentId**? : *undefined | string*

package/docs/interfaces/paymentinitializeoptions.md

@@ -44,6 +44,7 @@ current checkout flow.
 * [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)
@@ -286,6 +287,15 @@ 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*

package/docs/interfaces/paypalfieldsstyleoptions.md

@@ -10,31 +10,17 @@
 
 ### Properties
 
-* [active](paypalfieldsstyleoptions.md#optional-active)
-* [base](paypalfieldsstyleoptions.md#optional-base)
-* [input](paypalfieldsstyleoptions.md#optional-input)
-* [invalid](paypalfieldsstyleoptions.md#optional-invalid)
+* [rules](paypalfieldsstyleoptions.md#optional-rules)
+* [variables](paypalfieldsstyleoptions.md#optional-variables)
 
 ## Properties
 
-### `Optional` active
+### `Optional` rules
 
-• **active**? : *undefined | object*
+• **rules**? : *undefined | object*
 
 ___
 
-### `Optional` base
+### `Optional` variables
 
-• **base**? : *undefined | object*
-
-___
-
-### `Optional` input
-
-• **input**? : *undefined | object*
-
-___
-
-### `Optional` invalid
-
-• **invalid**? : *undefined | object*
+• **variables**? : *undefined | object*

package/docs/interfaces/squarepaymentinitializeoptions.md

@@ -36,45 +36,6 @@ service.initializePayment({
 });
 ```
 
-Additional options can be passed in to enable Masterpass (if configured for
-the account) and customize the fields.
-
-```html
-<!-- This container is where Masterpass button will be inserted -->
-<div id="masterpass"></div>
-```
-
-```js
-service.initializePayment({
-    methodId: 'squarev2',
-    square: {
-        cardNumber: {
-            elementId: 'card-number',
-        },
-        cvv: {
-            elementId: 'card-code',
-        },
-        expirationDate: {
-            elementId: 'card-expiry',
-        },
-        postalCode: {
-            elementId: 'card-code',
-        },
-        inputClass: 'form-input',
-        inputStyles: [
-            {
-                color: '#333',
-                fontSize: '13px',
-                lineHeight: '20px',
-            },
-        ],
-        masterpass: {
-            elementId: 'masterpass',
-        },
-    },
-});
-```
-
 ## Hierarchy
 
 * **SquarePaymentInitializeOptions**
@@ -88,7 +49,6 @@ service.initializePayment({
 * [expirationDate](squarepaymentinitializeoptions.md#expirationdate)
 * [inputClass](squarepaymentinitializeoptions.md#optional-inputclass)
 * [inputStyles](squarepaymentinitializeoptions.md#optional-inputstyles)
-* [masterpass](squarepaymentinitializeoptions.md#optional-masterpass)
 * [postalCode](squarepaymentinitializeoptions.md#postalcode)
 
 ### Methods
@@ -138,14 +98,6 @@ The set of CSS styles to apply to all form fields.
 
 ___
 
-### `Optional` masterpass
-
-• **masterpass**? : *[SquareFormElement](squareformelement.md)*
-
-Initialize Masterpass placeholder ID
-
-___
-
 ###  postalCode
 
 • **postalCode**: *[SquareFormElement](squareformelement.md)*

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bigcommerce/checkout-sdk",
-  "version": "1.215.1",
+  "version": "1.219.0",
   "description": "BigCommerce Checkout JavaScript SDK",
   "license": "MIT",
   "main": "dist/checkout-sdk.js",