@wix/ecom 1.0.765 → 1.0.766
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/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@wix/ecom",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.766",
|
|
4
4
|
"publishConfig": {
|
|
5
5
|
"registry": "https://registry.npmjs.org/",
|
|
6
6
|
"access": "public"
|
|
@@ -36,8 +36,8 @@
|
|
|
36
36
|
"@wix/ecom_discounts": "1.0.6",
|
|
37
37
|
"@wix/ecom_discounts-custom-trigger": "1.0.8",
|
|
38
38
|
"@wix/ecom_draft-orders": "1.0.22",
|
|
39
|
-
"@wix/ecom_gift-vouchers": "1.0.
|
|
40
|
-
"@wix/ecom_gift-vouchers-provider": "1.0.
|
|
39
|
+
"@wix/ecom_gift-vouchers": "1.0.4",
|
|
40
|
+
"@wix/ecom_gift-vouchers-provider": "1.0.5",
|
|
41
41
|
"@wix/ecom_local-delivery-options": "1.0.9",
|
|
42
42
|
"@wix/ecom_order-fulfillments": "1.0.47",
|
|
43
43
|
"@wix/ecom_order-invoices": "1.0.40",
|
|
@@ -78,5 +78,5 @@
|
|
|
78
78
|
"fqdn": ""
|
|
79
79
|
}
|
|
80
80
|
},
|
|
81
|
-
"falconPackageHash": "
|
|
81
|
+
"falconPackageHash": "2d3b8be6a62cc5ee31bdbabc2c2afe86911a868b03189851d9675597"
|
|
82
82
|
}
|
|
@@ -27781,7 +27781,7 @@ interface GiftCard$2 {
|
|
|
27781
27781
|
* + **DISABLED**: Gift card has been disabled by the merchant and can no longer be used.
|
|
27782
27782
|
*/
|
|
27783
27783
|
status?: Status$1;
|
|
27784
|
-
/** App ID of the gift card provider, as returned in
|
|
27784
|
+
/** App ID of the gift card provider, as returned in eCommerce Get Checkout or List Transactions for Single Order. */
|
|
27785
27785
|
appId?: string;
|
|
27786
27786
|
/**
|
|
27787
27787
|
* External ID in the gift card provider's system.
|
|
@@ -27808,7 +27808,7 @@ interface GetGiftCardRequest {
|
|
|
27808
27808
|
context?: Context;
|
|
27809
27809
|
}
|
|
27810
27810
|
interface Context {
|
|
27811
|
-
/** Physical location ID. Can be based on the
|
|
27811
|
+
/** Physical location ID. Can be based on the Locations API or an external provider. */
|
|
27812
27812
|
locationId?: string | null;
|
|
27813
27813
|
}
|
|
27814
27814
|
interface GetGiftCardResponse {
|
|
@@ -27820,7 +27820,7 @@ interface RedeemGiftCardRequest {
|
|
|
27820
27820
|
code: string;
|
|
27821
27821
|
/** Amount to redeem from the gift card. */
|
|
27822
27822
|
amount: Money;
|
|
27823
|
-
/** Order ID to apply the gift card transaction, when applying a gift card after order creation. Order ID can be collected from the
|
|
27823
|
+
/** Order ID to apply the gift card transaction, when applying a gift card after order creation. Order ID can be collected from the eCommerce Order Created webhook or by calling eCommerce Search Orders. */
|
|
27824
27824
|
orderId?: string;
|
|
27825
27825
|
/** App ID of the gift card provider. */
|
|
27826
27826
|
appId: string;
|
|
@@ -27832,7 +27832,7 @@ interface RedeemGiftCardResponse {
|
|
|
27832
27832
|
transactionId?: string;
|
|
27833
27833
|
}
|
|
27834
27834
|
interface VoidTransactionRequest {
|
|
27835
|
-
/** Gift card transaction ID, as returned from
|
|
27835
|
+
/** Gift card transaction ID, as returned from Redeem Gift Card. */
|
|
27836
27836
|
transactionId: string;
|
|
27837
27837
|
/** App ID of the gift card provider. */
|
|
27838
27838
|
appId: string;
|
|
@@ -27864,7 +27864,7 @@ interface GetGiftCardOptions {
|
|
|
27864
27864
|
interface RedeemGiftCardOptions {
|
|
27865
27865
|
/** Amount to redeem from the gift card. */
|
|
27866
27866
|
amount: Money;
|
|
27867
|
-
/** Order ID to apply the gift card transaction, when applying a gift card after order creation. Order ID can be collected from the
|
|
27867
|
+
/** Order ID to apply the gift card transaction, when applying a gift card after order creation. Order ID can be collected from the eCommerce Order Created webhook or by calling eCommerce Search Orders. */
|
|
27868
27868
|
orderId?: string;
|
|
27869
27869
|
/** App ID of the gift card provider. */
|
|
27870
27870
|
appId: string;
|
|
@@ -27893,8 +27893,7 @@ interface RedeemGiftCardSignature {
|
|
|
27893
27893
|
* Redeems a gift card.
|
|
27894
27894
|
* Creates a transaction and lowers the card balance by the transaction amount.
|
|
27895
27895
|
* @param - Gift card code.
|
|
27896
|
-
* @param - Field options. `
|
|
27897
|
-
* @param - Order ID to apply the gift card transaction, when applying a gift card after order creation. Order ID can be collected from [OnOrderCreated()](https://dev.wix.com/docs/sdk/backend-modules/ecom/orders/on-order-created) or by calling [Search Orders()](https://dev.wix.com/docs/sdk/backend-modules/ecom/orders/search-orders).
|
|
27896
|
+
* @param - Field options. `amount` and `appId` **must** be passed.
|
|
27898
27897
|
*/
|
|
27899
27898
|
(code: string, options?: RedeemGiftCardOptions | undefined): Promise<RedeemGiftCardResponse & RedeemGiftCardResponseNonNullableFields>;
|
|
27900
27899
|
}
|
|
@@ -27902,9 +27901,9 @@ declare function voidTransaction$1(httpClient: HttpClient$a): VoidTransactionSig
|
|
|
27902
27901
|
interface VoidTransactionSignature {
|
|
27903
27902
|
/**
|
|
27904
27903
|
* Voids a gift card transaction.
|
|
27905
|
-
* Transaction IDs are returned in
|
|
27904
|
+
* Transaction IDs are returned in Redeem Gift Card.
|
|
27905
|
+
* @param - Gift card transaction ID, as returned from Redeem Gift Card.
|
|
27906
27906
|
* @param - Field options. `appId` **must** be passed.
|
|
27907
|
-
* @param - Gift card transaction ID, as returned from [Redeem Gift Card](https://dev.wix.com/docs/rest/business-solutions/e-commerce/gift-cards/gift-cards/redeem-gift-card).
|
|
27908
27907
|
*/
|
|
27909
27908
|
(transactionId: string, options?: VoidTransactionOptions | undefined): Promise<void>;
|
|
27910
27909
|
}
|
|
@@ -27781,7 +27781,7 @@ interface GiftCard$2 {
|
|
|
27781
27781
|
* + **DISABLED**: Gift card has been disabled by the merchant and can no longer be used.
|
|
27782
27782
|
*/
|
|
27783
27783
|
status?: Status$1;
|
|
27784
|
-
/** App ID of the gift card provider, as returned in
|
|
27784
|
+
/** App ID of the gift card provider, as returned in eCommerce Get Checkout or List Transactions for Single Order. */
|
|
27785
27785
|
appId?: string;
|
|
27786
27786
|
/**
|
|
27787
27787
|
* External ID in the gift card provider's system.
|
|
@@ -27808,7 +27808,7 @@ interface GetGiftCardRequest {
|
|
|
27808
27808
|
context?: Context;
|
|
27809
27809
|
}
|
|
27810
27810
|
interface Context {
|
|
27811
|
-
/** Physical location ID. Can be based on the
|
|
27811
|
+
/** Physical location ID. Can be based on the Locations API or an external provider. */
|
|
27812
27812
|
locationId?: string | null;
|
|
27813
27813
|
}
|
|
27814
27814
|
interface GetGiftCardResponse {
|
|
@@ -27820,7 +27820,7 @@ interface RedeemGiftCardRequest {
|
|
|
27820
27820
|
code: string;
|
|
27821
27821
|
/** Amount to redeem from the gift card. */
|
|
27822
27822
|
amount: Money;
|
|
27823
|
-
/** Order ID to apply the gift card transaction, when applying a gift card after order creation. Order ID can be collected from the
|
|
27823
|
+
/** Order ID to apply the gift card transaction, when applying a gift card after order creation. Order ID can be collected from the eCommerce Order Created webhook or by calling eCommerce Search Orders. */
|
|
27824
27824
|
orderId?: string;
|
|
27825
27825
|
/** App ID of the gift card provider. */
|
|
27826
27826
|
appId: string;
|
|
@@ -27832,7 +27832,7 @@ interface RedeemGiftCardResponse {
|
|
|
27832
27832
|
transactionId?: string;
|
|
27833
27833
|
}
|
|
27834
27834
|
interface VoidTransactionRequest {
|
|
27835
|
-
/** Gift card transaction ID, as returned from
|
|
27835
|
+
/** Gift card transaction ID, as returned from Redeem Gift Card. */
|
|
27836
27836
|
transactionId: string;
|
|
27837
27837
|
/** App ID of the gift card provider. */
|
|
27838
27838
|
appId: string;
|
|
@@ -27864,7 +27864,7 @@ interface GetGiftCardOptions {
|
|
|
27864
27864
|
interface RedeemGiftCardOptions {
|
|
27865
27865
|
/** Amount to redeem from the gift card. */
|
|
27866
27866
|
amount: Money;
|
|
27867
|
-
/** Order ID to apply the gift card transaction, when applying a gift card after order creation. Order ID can be collected from the
|
|
27867
|
+
/** Order ID to apply the gift card transaction, when applying a gift card after order creation. Order ID can be collected from the eCommerce Order Created webhook or by calling eCommerce Search Orders. */
|
|
27868
27868
|
orderId?: string;
|
|
27869
27869
|
/** App ID of the gift card provider. */
|
|
27870
27870
|
appId: string;
|
|
@@ -27893,8 +27893,7 @@ interface RedeemGiftCardSignature {
|
|
|
27893
27893
|
* Redeems a gift card.
|
|
27894
27894
|
* Creates a transaction and lowers the card balance by the transaction amount.
|
|
27895
27895
|
* @param - Gift card code.
|
|
27896
|
-
* @param - Field options. `
|
|
27897
|
-
* @param - Order ID to apply the gift card transaction, when applying a gift card after order creation. Order ID can be collected from [OnOrderCreated()](https://dev.wix.com/docs/sdk/backend-modules/ecom/orders/on-order-created) or by calling [Search Orders()](https://dev.wix.com/docs/sdk/backend-modules/ecom/orders/search-orders).
|
|
27896
|
+
* @param - Field options. `amount` and `appId` **must** be passed.
|
|
27898
27897
|
*/
|
|
27899
27898
|
(code: string, options?: RedeemGiftCardOptions | undefined): Promise<RedeemGiftCardResponse & RedeemGiftCardResponseNonNullableFields>;
|
|
27900
27899
|
}
|
|
@@ -27902,9 +27901,9 @@ declare function voidTransaction$1(httpClient: HttpClient$a): VoidTransactionSig
|
|
|
27902
27901
|
interface VoidTransactionSignature {
|
|
27903
27902
|
/**
|
|
27904
27903
|
* Voids a gift card transaction.
|
|
27905
|
-
* Transaction IDs are returned in
|
|
27904
|
+
* Transaction IDs are returned in Redeem Gift Card.
|
|
27905
|
+
* @param - Gift card transaction ID, as returned from Redeem Gift Card.
|
|
27906
27906
|
* @param - Field options. `appId` **must** be passed.
|
|
27907
|
-
* @param - Gift card transaction ID, as returned from [Redeem Gift Card](https://dev.wix.com/docs/rest/business-solutions/e-commerce/gift-cards/gift-cards/redeem-gift-card).
|
|
27908
27907
|
*/
|
|
27909
27908
|
(transactionId: string, options?: VoidTransactionOptions | undefined): Promise<void>;
|
|
27910
27909
|
}
|
|
@@ -23495,7 +23495,7 @@ interface GiftCard$3 {
|
|
|
23495
23495
|
* + **DISABLED**: Gift card has been disabled by the merchant and can no longer be used.
|
|
23496
23496
|
*/
|
|
23497
23497
|
status?: Status$3;
|
|
23498
|
-
/** App ID of the gift card provider, as returned in
|
|
23498
|
+
/** App ID of the gift card provider, as returned in eCommerce Get Checkout or List Transactions for Single Order. */
|
|
23499
23499
|
appId?: string;
|
|
23500
23500
|
/**
|
|
23501
23501
|
* External ID in the gift card provider's system.
|
|
@@ -23522,7 +23522,7 @@ interface GetGiftCardRequest$1 {
|
|
|
23522
23522
|
context?: Context$1;
|
|
23523
23523
|
}
|
|
23524
23524
|
interface Context$1 {
|
|
23525
|
-
/** Physical location ID. Can be based on the
|
|
23525
|
+
/** Physical location ID. Can be based on the Locations API or an external provider. */
|
|
23526
23526
|
locationId?: string | null;
|
|
23527
23527
|
}
|
|
23528
23528
|
interface GetGiftCardResponse$1 {
|
|
@@ -23534,7 +23534,7 @@ interface RedeemGiftCardRequest$1 {
|
|
|
23534
23534
|
code: string;
|
|
23535
23535
|
/** Amount to redeem from the gift card. */
|
|
23536
23536
|
amount: Money$1;
|
|
23537
|
-
/** Order ID to apply the gift card transaction, when applying a gift card after order creation. Order ID can be collected from the
|
|
23537
|
+
/** Order ID to apply the gift card transaction, when applying a gift card after order creation. Order ID can be collected from the eCommerce Order Created webhook or by calling eCommerce Search Orders. */
|
|
23538
23538
|
orderId?: string;
|
|
23539
23539
|
/** App ID of the gift card provider. */
|
|
23540
23540
|
appId: string;
|
|
@@ -23546,7 +23546,7 @@ interface RedeemGiftCardResponse$1 {
|
|
|
23546
23546
|
transactionId?: string;
|
|
23547
23547
|
}
|
|
23548
23548
|
interface VoidTransactionRequest$1 {
|
|
23549
|
-
/** Gift card transaction ID, as returned from
|
|
23549
|
+
/** Gift card transaction ID, as returned from Redeem Gift Card. */
|
|
23550
23550
|
transactionId: string;
|
|
23551
23551
|
/** App ID of the gift card provider. */
|
|
23552
23552
|
appId: string;
|
|
@@ -23588,7 +23588,7 @@ interface GiftCard$2 {
|
|
|
23588
23588
|
* + **DISABLED**: Gift card has been disabled by the merchant and can no longer be used.
|
|
23589
23589
|
*/
|
|
23590
23590
|
status?: Status$2;
|
|
23591
|
-
/** App ID of the gift card provider, as returned in
|
|
23591
|
+
/** App ID of the gift card provider, as returned in eCommerce Get Checkout or List Transactions for Single Order. */
|
|
23592
23592
|
appId?: string;
|
|
23593
23593
|
/**
|
|
23594
23594
|
* External ID in the gift card provider's system.
|
|
@@ -23615,7 +23615,7 @@ interface GetGiftCardRequest {
|
|
|
23615
23615
|
context?: Context;
|
|
23616
23616
|
}
|
|
23617
23617
|
interface Context {
|
|
23618
|
-
/** Physical location ID. Can be based on the
|
|
23618
|
+
/** Physical location ID. Can be based on the Locations API or an external provider. */
|
|
23619
23619
|
locationId?: string | null;
|
|
23620
23620
|
}
|
|
23621
23621
|
interface GetGiftCardResponse {
|
|
@@ -23627,7 +23627,7 @@ interface RedeemGiftCardRequest {
|
|
|
23627
23627
|
code: string;
|
|
23628
23628
|
/** Amount to redeem from the gift card. */
|
|
23629
23629
|
amount: Money;
|
|
23630
|
-
/** Order ID to apply the gift card transaction, when applying a gift card after order creation. Order ID can be collected from the
|
|
23630
|
+
/** Order ID to apply the gift card transaction, when applying a gift card after order creation. Order ID can be collected from the eCommerce Order Created webhook or by calling eCommerce Search Orders. */
|
|
23631
23631
|
orderId?: string;
|
|
23632
23632
|
/** App ID of the gift card provider. */
|
|
23633
23633
|
appId: string;
|
|
@@ -23639,7 +23639,7 @@ interface RedeemGiftCardResponse {
|
|
|
23639
23639
|
transactionId?: string;
|
|
23640
23640
|
}
|
|
23641
23641
|
interface VoidTransactionRequest {
|
|
23642
|
-
/** Gift card transaction ID, as returned from
|
|
23642
|
+
/** Gift card transaction ID, as returned from Redeem Gift Card. */
|
|
23643
23643
|
transactionId: string;
|
|
23644
23644
|
/** App ID of the gift card provider. */
|
|
23645
23645
|
appId: string;
|
|
@@ -6,12 +6,12 @@ interface GetBalanceRequest {
|
|
|
6
6
|
/** Gift card code. */
|
|
7
7
|
code?: string;
|
|
8
8
|
/**
|
|
9
|
-
* App
|
|
10
|
-
* @deprecated App
|
|
9
|
+
* App ID of the Gift Card provider. Deprecated.
|
|
10
|
+
* @deprecated App ID of the Gift Card provider. Deprecated.
|
|
11
11
|
* @targetRemovalDate 2025-07-01
|
|
12
12
|
*/
|
|
13
13
|
appInstanceId?: string;
|
|
14
|
-
/** The physical location ID. */
|
|
14
|
+
/** The physical location ID. Can be based on the Locations API or an external provider. */
|
|
15
15
|
locationId?: string | null;
|
|
16
16
|
}
|
|
17
17
|
interface GetBalanceResponse {
|
|
@@ -29,18 +29,18 @@ interface RedeemRequest {
|
|
|
29
29
|
/** Gift card code. */
|
|
30
30
|
code?: string;
|
|
31
31
|
/**
|
|
32
|
-
* App
|
|
33
|
-
* @deprecated App
|
|
32
|
+
* App ID of the Gift Card provider. Deprecated.
|
|
33
|
+
* @deprecated App ID of the Gift Card provider. Deprecated.
|
|
34
34
|
* @targetRemovalDate 2025-07-01
|
|
35
35
|
*/
|
|
36
36
|
appInstanceId?: string;
|
|
37
37
|
/** Amount to redeem from the gift card. */
|
|
38
38
|
amount?: number;
|
|
39
|
-
/** Order ID the gift card transaction is applied to. */
|
|
39
|
+
/** Order ID the gift card transaction is applied to. Order details can be collected from eCommerce Search Orders. */
|
|
40
40
|
orderId?: string;
|
|
41
41
|
/** Currency code. */
|
|
42
42
|
currencyCode?: string;
|
|
43
|
-
/** Physical location ID. */
|
|
43
|
+
/** Physical location ID. Can be based on the Locations API or an external provider. */
|
|
44
44
|
locationId?: string | null;
|
|
45
45
|
}
|
|
46
46
|
interface RedeemResponse {
|
|
@@ -53,14 +53,14 @@ interface RedeemResponse {
|
|
|
53
53
|
}
|
|
54
54
|
interface VoidRequest {
|
|
55
55
|
/**
|
|
56
|
-
* App
|
|
57
|
-
* @deprecated App
|
|
56
|
+
* App ID of the Gift Card provider. Deprecated.
|
|
57
|
+
* @deprecated App ID of the Gift Card provider. Deprecated.
|
|
58
58
|
* @targetRemovalDate 2025-07-01
|
|
59
59
|
*/
|
|
60
60
|
appInstanceId?: string;
|
|
61
61
|
/** Transaction ID to void. */
|
|
62
62
|
transactionId?: string;
|
|
63
|
-
/** Physical location ID. */
|
|
63
|
+
/** Physical location ID. Can be based on the Locations API or an external provider. */
|
|
64
64
|
locationId?: string | null;
|
|
65
65
|
}
|
|
66
66
|
interface VoidResponse {
|
|
@@ -6,12 +6,12 @@ interface GetBalanceRequest {
|
|
|
6
6
|
/** Gift card code. */
|
|
7
7
|
code?: string;
|
|
8
8
|
/**
|
|
9
|
-
* App
|
|
10
|
-
* @deprecated App
|
|
9
|
+
* App ID of the Gift Card provider. Deprecated.
|
|
10
|
+
* @deprecated App ID of the Gift Card provider. Deprecated.
|
|
11
11
|
* @targetRemovalDate 2025-07-01
|
|
12
12
|
*/
|
|
13
13
|
appInstanceId?: string;
|
|
14
|
-
/** The physical location ID. */
|
|
14
|
+
/** The physical location ID. Can be based on the Locations API or an external provider. */
|
|
15
15
|
locationId?: string | null;
|
|
16
16
|
}
|
|
17
17
|
interface GetBalanceResponse {
|
|
@@ -29,18 +29,18 @@ interface RedeemRequest {
|
|
|
29
29
|
/** Gift card code. */
|
|
30
30
|
code?: string;
|
|
31
31
|
/**
|
|
32
|
-
* App
|
|
33
|
-
* @deprecated App
|
|
32
|
+
* App ID of the Gift Card provider. Deprecated.
|
|
33
|
+
* @deprecated App ID of the Gift Card provider. Deprecated.
|
|
34
34
|
* @targetRemovalDate 2025-07-01
|
|
35
35
|
*/
|
|
36
36
|
appInstanceId?: string;
|
|
37
37
|
/** Amount to redeem from the gift card. */
|
|
38
38
|
amount?: number;
|
|
39
|
-
/** Order ID the gift card transaction is applied to. */
|
|
39
|
+
/** Order ID the gift card transaction is applied to. Order details can be collected from eCommerce Search Orders. */
|
|
40
40
|
orderId?: string;
|
|
41
41
|
/** Currency code. */
|
|
42
42
|
currencyCode?: string;
|
|
43
|
-
/** Physical location ID. */
|
|
43
|
+
/** Physical location ID. Can be based on the Locations API or an external provider. */
|
|
44
44
|
locationId?: string | null;
|
|
45
45
|
}
|
|
46
46
|
interface RedeemResponse {
|
|
@@ -53,14 +53,14 @@ interface RedeemResponse {
|
|
|
53
53
|
}
|
|
54
54
|
interface VoidRequest {
|
|
55
55
|
/**
|
|
56
|
-
* App
|
|
57
|
-
* @deprecated App
|
|
56
|
+
* App ID of the Gift Card provider. Deprecated.
|
|
57
|
+
* @deprecated App ID of the Gift Card provider. Deprecated.
|
|
58
58
|
* @targetRemovalDate 2025-07-01
|
|
59
59
|
*/
|
|
60
60
|
appInstanceId?: string;
|
|
61
61
|
/** Transaction ID to void. */
|
|
62
62
|
transactionId?: string;
|
|
63
|
-
/** Physical location ID. */
|
|
63
|
+
/** Physical location ID. Can be based on the Locations API or an external provider. */
|
|
64
64
|
locationId?: string | null;
|
|
65
65
|
}
|
|
66
66
|
interface VoidResponse {
|