@bigcommerce/checkout-sdk 1.716.0 → 1.718.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/checkout-button.js +1 -1
- package/dist/checkout-button.umd.js +1 -1
- package/dist/checkout-sdk.d.ts +17 -36
- package/dist/checkout-sdk.js +1 -1
- package/dist/checkout-sdk.js.map +1 -1
- package/dist/checkout-sdk.umd.js +1 -1
- package/dist/checkout-sdk.umd.js.map +1 -1
- package/dist/hosted-form-v2-iframe-host.js +1 -1
- package/dist/hosted-form-v2-iframe-host.umd.js +1 -1
- package/dist/internal-mappers.d.ts +17 -0
- package/docs/README.md +10 -1
- package/docs/interfaces/BasePaymentInitializeOptions.md +0 -10
- package/docs/interfaces/Consignment.md +7 -0
- package/docs/interfaces/ConsignmentAutomaticDiscount.md +47 -0
- package/docs/interfaces/ConsignmentCouponDiscount.md +61 -0
- package/docs/interfaces/ConsignmentDiscountBase.md +43 -0
- package/package.json +1 -1
- package/docs/interfaces/OpyPaymentInitializeOptions.md +0 -40
package/dist/checkout-sdk.d.ts
CHANGED
|
@@ -780,11 +780,6 @@ declare interface BasePaymentInitializeOptions extends PaymentRequestOptions {
|
|
|
780
780
|
* They can be omitted unless you need to support Masterpass.
|
|
781
781
|
*/
|
|
782
782
|
masterpass?: MasterpassPaymentInitializeOptions;
|
|
783
|
-
/**
|
|
784
|
-
* The options that are required to initialize the Opy payment
|
|
785
|
-
* method. They can be omitted unless you need to support Opy.
|
|
786
|
-
*/
|
|
787
|
-
opy?: OpyPaymentInitializeOptions;
|
|
788
783
|
/**
|
|
789
784
|
* The options that are required to initialize the PayPal Express payment method.
|
|
790
785
|
* They can be omitted unless you need to support PayPal Express.
|
|
@@ -4092,6 +4087,7 @@ declare interface Consignment {
|
|
|
4092
4087
|
id: string;
|
|
4093
4088
|
address: Address;
|
|
4094
4089
|
shippingAddress: Address;
|
|
4090
|
+
discounts: ConsignmentDiscount[];
|
|
4095
4091
|
handlingCost: number;
|
|
4096
4092
|
shippingCost: number;
|
|
4097
4093
|
availableShippingOptions?: ShippingOption[];
|
|
@@ -4114,6 +4110,14 @@ declare interface ConsignmentAssignmentBaseRequestBodyWithShippingAddress {
|
|
|
4114
4110
|
|
|
4115
4111
|
declare type ConsignmentAssignmentRequestBody = ConsignmentAssignmentBaseRequestBodyWithShippingAddress | ConsignmentAssignmentBaseRequestBodyWithAddress;
|
|
4116
4112
|
|
|
4113
|
+
declare interface ConsignmentAutomaticDiscount extends ConsignmentDiscountBase<'AUTOMATIC'> {
|
|
4114
|
+
}
|
|
4115
|
+
|
|
4116
|
+
declare interface ConsignmentCouponDiscount extends ConsignmentDiscountBase<'COUPON'> {
|
|
4117
|
+
couponId: number;
|
|
4118
|
+
couponCode: string;
|
|
4119
|
+
}
|
|
4120
|
+
|
|
4117
4121
|
declare interface ConsignmentCreateRequestBody {
|
|
4118
4122
|
address?: AddressRequestBody;
|
|
4119
4123
|
shippingAddress?: AddressRequestBody;
|
|
@@ -4121,6 +4125,14 @@ declare interface ConsignmentCreateRequestBody {
|
|
|
4121
4125
|
pickupOption?: ConsignmentPickupOption;
|
|
4122
4126
|
}
|
|
4123
4127
|
|
|
4128
|
+
declare type ConsignmentDiscount = ConsignmentAutomaticDiscount | ConsignmentCouponDiscount;
|
|
4129
|
+
|
|
4130
|
+
declare interface ConsignmentDiscountBase<T> {
|
|
4131
|
+
id: number;
|
|
4132
|
+
amount: number;
|
|
4133
|
+
type: T;
|
|
4134
|
+
}
|
|
4135
|
+
|
|
4124
4136
|
declare interface ConsignmentLineItem {
|
|
4125
4137
|
itemId: string | number;
|
|
4126
4138
|
quantity: number;
|
|
@@ -6040,37 +6052,6 @@ declare interface OptionsResponse {
|
|
|
6040
6052
|
paymentMethodConfiguration?: BaseElementOptions;
|
|
6041
6053
|
}
|
|
6042
6054
|
|
|
6043
|
-
/**
|
|
6044
|
-
* A set of options that are required to initialize the payment step of
|
|
6045
|
-
* checkout in order to support Opy.
|
|
6046
|
-
*
|
|
6047
|
-
* When Opy is initialized, a widget will be inserted into the DOM. The
|
|
6048
|
-
* widget will open a modal that will show more information about Opy when
|
|
6049
|
-
* clicking it.
|
|
6050
|
-
*
|
|
6051
|
-
* @example
|
|
6052
|
-
*
|
|
6053
|
-
* ```html
|
|
6054
|
-
* <!-- This is where the Opy widget will be inserted -->
|
|
6055
|
-
* <div id="opy-widget"></div>
|
|
6056
|
-
* ```
|
|
6057
|
-
*
|
|
6058
|
-
* ```js
|
|
6059
|
-
* service.initializePayment({
|
|
6060
|
-
* methodId: 'opy',
|
|
6061
|
-
* opy: {
|
|
6062
|
-
* containerId: 'opy-widget',
|
|
6063
|
-
* },
|
|
6064
|
-
* });
|
|
6065
|
-
* ```
|
|
6066
|
-
*/
|
|
6067
|
-
declare interface OpyPaymentInitializeOptions {
|
|
6068
|
-
/**
|
|
6069
|
-
* The ID of a container which the payment widget should insert into.
|
|
6070
|
-
*/
|
|
6071
|
-
containerId: string;
|
|
6072
|
-
}
|
|
6073
|
-
|
|
6074
6055
|
declare interface Order {
|
|
6075
6056
|
baseAmount: number;
|
|
6076
6057
|
billingAddress: OrderBillingAddress;
|