@wix/ecom 1.0.791 → 1.0.792
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/build/cjs/context.d.ts +1 -0
- package/build/cjs/context.js +2 -1
- package/build/cjs/context.js.map +1 -1
- package/build/cjs/index.d.ts +2 -1
- package/build/cjs/index.js +3 -1
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/meta.d.ts +1 -0
- package/build/cjs/meta.js +2 -1
- package/build/cjs/meta.js.map +1 -1
- package/build/es/context.d.ts +1 -0
- package/build/es/context.js +1 -0
- package/build/es/context.js.map +1 -1
- package/build/es/index.d.ts +2 -1
- package/build/es/index.js +2 -1
- package/build/es/index.js.map +1 -1
- package/build/es/meta.d.ts +1 -0
- package/build/es/meta.js +1 -0
- package/build/es/meta.js.map +1 -1
- package/package.json +4 -3
- package/type-bundles/context.bundle.d.ts +1982 -492
- package/type-bundles/index.bundle.d.ts +1982 -492
- package/type-bundles/meta.bundle.d.ts +2566 -256
|
@@ -544,15 +544,15 @@ interface GetCheckoutContentSignature {
|
|
|
544
544
|
|
|
545
545
|
declare const getCheckoutContent: MaybeContext<BuildRESTFunction<typeof getCheckoutContent$1> & typeof getCheckoutContent$1>;
|
|
546
546
|
|
|
547
|
-
type context$
|
|
548
|
-
type context$
|
|
549
|
-
type context$
|
|
550
|
-
type context$
|
|
551
|
-
type context$
|
|
552
|
-
type context$
|
|
553
|
-
declare const context$
|
|
554
|
-
declare namespace context$
|
|
555
|
-
export { type context$
|
|
547
|
+
type context$s_CheckoutContent = CheckoutContent;
|
|
548
|
+
type context$s_CheckoutContentProvider = CheckoutContentProvider;
|
|
549
|
+
type context$s_GetCheckoutContentIdentifiers = GetCheckoutContentIdentifiers;
|
|
550
|
+
type context$s_GetCheckoutContentOptions = GetCheckoutContentOptions;
|
|
551
|
+
type context$s_GetCheckoutContentRequest = GetCheckoutContentRequest;
|
|
552
|
+
type context$s_GetCheckoutContentResponse = GetCheckoutContentResponse;
|
|
553
|
+
declare const context$s_getCheckoutContent: typeof getCheckoutContent;
|
|
554
|
+
declare namespace context$s {
|
|
555
|
+
export { type context$s_CheckoutContent as CheckoutContent, type context$s_CheckoutContentProvider as CheckoutContentProvider, type context$s_GetCheckoutContentIdentifiers as GetCheckoutContentIdentifiers, type context$s_GetCheckoutContentOptions as GetCheckoutContentOptions, type context$s_GetCheckoutContentRequest as GetCheckoutContentRequest, type context$s_GetCheckoutContentResponse as GetCheckoutContentResponse, context$s_getCheckoutContent as getCheckoutContent };
|
|
556
556
|
}
|
|
557
557
|
|
|
558
558
|
interface CustomTrigger {
|
|
@@ -578,12 +578,12 @@ interface LineItem$8 {
|
|
|
578
578
|
* Catalog and item reference. Holds IDs for the item and the catalog it came from, as well as further optional info.
|
|
579
579
|
* This field may be empty in the case of a custom line item.
|
|
580
580
|
*/
|
|
581
|
-
catalogReference?: CatalogReference$
|
|
581
|
+
catalogReference?: CatalogReference$c;
|
|
582
582
|
/** Price of a single item. */
|
|
583
583
|
price?: string;
|
|
584
584
|
}
|
|
585
585
|
/** Used for grouping line items. Sent when an item is added to a cart, checkout, or order. */
|
|
586
|
-
interface CatalogReference$
|
|
586
|
+
interface CatalogReference$c {
|
|
587
587
|
/** ID of the item within the catalog it belongs to. */
|
|
588
588
|
catalogItemId?: string;
|
|
589
589
|
/**
|
|
@@ -655,21 +655,21 @@ interface ListTriggersSignature {
|
|
|
655
655
|
|
|
656
656
|
declare const listTriggers: MaybeContext<BuildRESTFunction<typeof listTriggers$1> & typeof listTriggers$1>;
|
|
657
657
|
|
|
658
|
-
type context$
|
|
659
|
-
type context$
|
|
660
|
-
type context$
|
|
661
|
-
type context$
|
|
662
|
-
type context$
|
|
663
|
-
type context$
|
|
664
|
-
type context$
|
|
665
|
-
type context$
|
|
666
|
-
type context$
|
|
667
|
-
declare const context$
|
|
668
|
-
declare namespace context$
|
|
669
|
-
export { type CatalogReference$
|
|
658
|
+
type context$r_CustomTrigger = CustomTrigger;
|
|
659
|
+
type context$r_EligibleTrigger = EligibleTrigger;
|
|
660
|
+
type context$r_GetEligibleTriggersRequest = GetEligibleTriggersRequest;
|
|
661
|
+
type context$r_GetEligibleTriggersResponse = GetEligibleTriggersResponse;
|
|
662
|
+
type context$r_ListTriggersRequest = ListTriggersRequest;
|
|
663
|
+
type context$r_ListTriggersResponse = ListTriggersResponse;
|
|
664
|
+
type context$r_ListTriggersResponseCustomTrigger = ListTriggersResponseCustomTrigger;
|
|
665
|
+
type context$r_ListTriggersResponseNonNullableFields = ListTriggersResponseNonNullableFields;
|
|
666
|
+
type context$r_TriggerToFilterBy = TriggerToFilterBy;
|
|
667
|
+
declare const context$r_listTriggers: typeof listTriggers;
|
|
668
|
+
declare namespace context$r {
|
|
669
|
+
export { type CatalogReference$c as CatalogReference, type context$r_CustomTrigger as CustomTrigger, type context$r_EligibleTrigger as EligibleTrigger, type context$r_GetEligibleTriggersRequest as GetEligibleTriggersRequest, type context$r_GetEligibleTriggersResponse as GetEligibleTriggersResponse, type LineItem$8 as LineItem, type context$r_ListTriggersRequest as ListTriggersRequest, type context$r_ListTriggersResponse as ListTriggersResponse, type context$r_ListTriggersResponseCustomTrigger as ListTriggersResponseCustomTrigger, type context$r_ListTriggersResponseNonNullableFields as ListTriggersResponseNonNullableFields, type context$r_TriggerToFilterBy as TriggerToFilterBy, context$r_listTriggers as listTriggers };
|
|
670
670
|
}
|
|
671
671
|
|
|
672
|
-
interface DiscountRule$
|
|
672
|
+
interface DiscountRule$8 {
|
|
673
673
|
/**
|
|
674
674
|
* Discount rule ID.
|
|
675
675
|
* @readonly
|
|
@@ -884,7 +884,7 @@ interface Discount$3 extends DiscountDiscountOneOf {
|
|
|
884
884
|
* + `"FIXED_AMOUNT"`: Price is reduced by fixed amount.
|
|
885
885
|
* + `"FIXED_PRICE"`: Price will be set to fixed amount.
|
|
886
886
|
*/
|
|
887
|
-
discountType?: DiscountType$
|
|
887
|
+
discountType?: DiscountType$8;
|
|
888
888
|
}
|
|
889
889
|
/** @oneof */
|
|
890
890
|
interface DiscountDiscountOneOf {
|
|
@@ -905,7 +905,7 @@ interface SpecificItemsInfo {
|
|
|
905
905
|
/** All associated scopes for `"SPECIFIC_ITEMS"` target type. */
|
|
906
906
|
scopes?: Scope$5[];
|
|
907
907
|
}
|
|
908
|
-
declare enum DiscountType$
|
|
908
|
+
declare enum DiscountType$8 {
|
|
909
909
|
UNDEFINED = "UNDEFINED",
|
|
910
910
|
/** Percentage discount */
|
|
911
911
|
PERCENTAGE = "PERCENTAGE",
|
|
@@ -987,7 +987,7 @@ declare enum AppliedSubjectType {
|
|
|
987
987
|
/** Discount applies to the lowest priced item at checkout. */
|
|
988
988
|
LOWEST_PRICED_ITEM = "LOWEST_PRICED_ITEM"
|
|
989
989
|
}
|
|
990
|
-
interface ExtendedFields$
|
|
990
|
+
interface ExtendedFields$b {
|
|
991
991
|
/**
|
|
992
992
|
* Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
|
|
993
993
|
* The value of each key is structured according to the schema defined when the extended fields were configured.
|
|
@@ -1000,11 +1000,11 @@ interface ExtendedFields$a {
|
|
|
1000
1000
|
}
|
|
1001
1001
|
interface CreateDiscountRuleRequest {
|
|
1002
1002
|
/** Discount rule info. */
|
|
1003
|
-
discountRule: DiscountRule$
|
|
1003
|
+
discountRule: DiscountRule$8;
|
|
1004
1004
|
}
|
|
1005
1005
|
interface CreateDiscountRuleResponse {
|
|
1006
1006
|
/** Discount rule. */
|
|
1007
|
-
discountRule?: DiscountRule$
|
|
1007
|
+
discountRule?: DiscountRule$8;
|
|
1008
1008
|
}
|
|
1009
1009
|
interface GetDiscountRuleRequest {
|
|
1010
1010
|
/** ID of the discount rule to retrieve. */
|
|
@@ -1012,15 +1012,15 @@ interface GetDiscountRuleRequest {
|
|
|
1012
1012
|
}
|
|
1013
1013
|
interface GetDiscountRuleResponse {
|
|
1014
1014
|
/** The requested discount rule. */
|
|
1015
|
-
discountRule?: DiscountRule$
|
|
1015
|
+
discountRule?: DiscountRule$8;
|
|
1016
1016
|
}
|
|
1017
1017
|
interface UpdateDiscountRuleRequest {
|
|
1018
1018
|
/** Discount rule info. */
|
|
1019
|
-
discountRule: DiscountRule$
|
|
1019
|
+
discountRule: DiscountRule$8;
|
|
1020
1020
|
}
|
|
1021
1021
|
interface UpdateDiscountRuleResponse {
|
|
1022
1022
|
/** Updated discount rule. */
|
|
1023
|
-
discountRule?: DiscountRule$
|
|
1023
|
+
discountRule?: DiscountRule$8;
|
|
1024
1024
|
}
|
|
1025
1025
|
interface DeleteDiscountRuleRequest {
|
|
1026
1026
|
/** ID of the discount rule to delete. */
|
|
@@ -1036,26 +1036,26 @@ interface PlatformQuery$2 extends PlatformQueryPagingMethodOneOf$2 {
|
|
|
1036
1036
|
/** Pointer to page of results using offset. Cannot be used together with `cursorPaging`. */
|
|
1037
1037
|
paging?: PlatformPaging$2;
|
|
1038
1038
|
/** Cursor pointing to page of results. Cannot be used together with `paging`. `cursorPaging.cursor` can not be used together with `filter` or `sort`. */
|
|
1039
|
-
cursorPaging?: CursorPaging$
|
|
1039
|
+
cursorPaging?: CursorPaging$c;
|
|
1040
1040
|
/** Filter object. */
|
|
1041
1041
|
filter?: Record<string, any> | null;
|
|
1042
1042
|
/** Sorting options. For example, `[{"fieldName":"sortField1"},{"fieldName":"sortField2","direction":"DESC"}]`. */
|
|
1043
|
-
sort?: Sorting$
|
|
1043
|
+
sort?: Sorting$c[];
|
|
1044
1044
|
}
|
|
1045
1045
|
/** @oneof */
|
|
1046
1046
|
interface PlatformQueryPagingMethodOneOf$2 {
|
|
1047
1047
|
/** Pointer to page of results using offset. Cannot be used together with `cursorPaging`. */
|
|
1048
1048
|
paging?: PlatformPaging$2;
|
|
1049
1049
|
/** Cursor pointing to page of results. Cannot be used together with `paging`. `cursorPaging.cursor` can not be used together with `filter` or `sort`. */
|
|
1050
|
-
cursorPaging?: CursorPaging$
|
|
1050
|
+
cursorPaging?: CursorPaging$c;
|
|
1051
1051
|
}
|
|
1052
|
-
interface Sorting$
|
|
1052
|
+
interface Sorting$c {
|
|
1053
1053
|
/** Name of the field to sort by. */
|
|
1054
1054
|
fieldName?: string;
|
|
1055
1055
|
/** Sort order. */
|
|
1056
|
-
order?: SortOrder$
|
|
1056
|
+
order?: SortOrder$c;
|
|
1057
1057
|
}
|
|
1058
|
-
declare enum SortOrder$
|
|
1058
|
+
declare enum SortOrder$c {
|
|
1059
1059
|
ASC = "ASC",
|
|
1060
1060
|
DESC = "DESC"
|
|
1061
1061
|
}
|
|
@@ -1065,7 +1065,7 @@ interface PlatformPaging$2 {
|
|
|
1065
1065
|
/** Number of items to skip in the current sort order. */
|
|
1066
1066
|
offset?: number | null;
|
|
1067
1067
|
}
|
|
1068
|
-
interface CursorPaging$
|
|
1068
|
+
interface CursorPaging$c {
|
|
1069
1069
|
/** Maximum number of items to return in the results. */
|
|
1070
1070
|
limit?: number | null;
|
|
1071
1071
|
/**
|
|
@@ -1078,7 +1078,7 @@ interface CursorPaging$b {
|
|
|
1078
1078
|
}
|
|
1079
1079
|
interface QueryDiscountRulesResponse {
|
|
1080
1080
|
/** List of discount rules. */
|
|
1081
|
-
discountRules?: DiscountRule$
|
|
1081
|
+
discountRules?: DiscountRule$8[];
|
|
1082
1082
|
/** Details on the paged set of results returned. */
|
|
1083
1083
|
pagingMetadata?: PlatformPagingMetadata$2;
|
|
1084
1084
|
}
|
|
@@ -1090,9 +1090,9 @@ interface PlatformPagingMetadata$2 {
|
|
|
1090
1090
|
/** The total number of items that match the query. Returned if offset paging was used. */
|
|
1091
1091
|
total?: number | null;
|
|
1092
1092
|
/** Cursors to navigate through result pages. Returned if cursor paging was used. */
|
|
1093
|
-
cursors?: Cursors$
|
|
1093
|
+
cursors?: Cursors$c;
|
|
1094
1094
|
}
|
|
1095
|
-
interface Cursors$
|
|
1095
|
+
interface Cursors$c {
|
|
1096
1096
|
/** Cursor string pointing to the next page in the list of results. */
|
|
1097
1097
|
next?: string | null;
|
|
1098
1098
|
/** Cursor pointing to the previous page in the list of results. */
|
|
@@ -1110,12 +1110,12 @@ interface LineItem$7 {
|
|
|
1110
1110
|
/** Line item quantity. */
|
|
1111
1111
|
quantity?: number | null;
|
|
1112
1112
|
/** Catalog and item reference info. Learn more about [integrating Wix Stores products with Wix eCommerce](https://dev.wix.com/api/rest/wix-stores/catalog/ecommerce-integration). */
|
|
1113
|
-
catalogReference?: CatalogReference$
|
|
1113
|
+
catalogReference?: CatalogReference$b;
|
|
1114
1114
|
/** Line item price. */
|
|
1115
1115
|
price?: string;
|
|
1116
1116
|
}
|
|
1117
1117
|
/** Used for grouping line items. Sent when an item is added to a cart, checkout, or order. */
|
|
1118
|
-
interface CatalogReference$
|
|
1118
|
+
interface CatalogReference$b {
|
|
1119
1119
|
/** ID of the item within the catalog it belongs to. */
|
|
1120
1120
|
catalogItemId?: string;
|
|
1121
1121
|
/**
|
|
@@ -1138,9 +1138,9 @@ interface CatalogReference$a {
|
|
|
1138
1138
|
}
|
|
1139
1139
|
interface GetAppliedDiscountsResponse {
|
|
1140
1140
|
/** All eligible discounts. */
|
|
1141
|
-
appliedDiscounts?: AppliedDiscount$
|
|
1141
|
+
appliedDiscounts?: AppliedDiscount$8[];
|
|
1142
1142
|
}
|
|
1143
|
-
interface AppliedDiscount$
|
|
1143
|
+
interface AppliedDiscount$8 {
|
|
1144
1144
|
/** Discount type. */
|
|
1145
1145
|
discountType?: Type;
|
|
1146
1146
|
/** IDs of line items the discount applies to, in GUID format. */
|
|
@@ -1152,13 +1152,13 @@ interface AppliedDiscountRule {
|
|
|
1152
1152
|
/** Applied discount rule ID. */
|
|
1153
1153
|
_id?: string;
|
|
1154
1154
|
/** Discount rule name. */
|
|
1155
|
-
name?: DiscountRuleName$
|
|
1155
|
+
name?: DiscountRuleName$8;
|
|
1156
1156
|
/** Total amount reduced from all discounted line items. */
|
|
1157
1157
|
amount?: MultiCurrencyPrice$6;
|
|
1158
1158
|
/** Discount rule type. */
|
|
1159
|
-
discountRuleType?: DiscountType$
|
|
1159
|
+
discountRuleType?: DiscountType$8;
|
|
1160
1160
|
}
|
|
1161
|
-
interface DiscountRuleName$
|
|
1161
|
+
interface DiscountRuleName$8 {
|
|
1162
1162
|
/** Original discount rule name (in site's default language). */
|
|
1163
1163
|
original?: string;
|
|
1164
1164
|
/**
|
|
@@ -1187,11 +1187,11 @@ interface MultiCurrencyPrice$6 {
|
|
|
1187
1187
|
*/
|
|
1188
1188
|
formattedConvertedAmount?: string;
|
|
1189
1189
|
}
|
|
1190
|
-
interface DomainEvent$
|
|
1191
|
-
createdEvent?: EntityCreatedEvent$
|
|
1192
|
-
updatedEvent?: EntityUpdatedEvent$
|
|
1193
|
-
deletedEvent?: EntityDeletedEvent$
|
|
1194
|
-
actionEvent?: ActionEvent$
|
|
1190
|
+
interface DomainEvent$l extends DomainEventBodyOneOf$l {
|
|
1191
|
+
createdEvent?: EntityCreatedEvent$l;
|
|
1192
|
+
updatedEvent?: EntityUpdatedEvent$l;
|
|
1193
|
+
deletedEvent?: EntityDeletedEvent$l;
|
|
1194
|
+
actionEvent?: ActionEvent$l;
|
|
1195
1195
|
/**
|
|
1196
1196
|
* Unique event ID.
|
|
1197
1197
|
* Allows clients to ignore duplicate webhooks.
|
|
@@ -1230,19 +1230,19 @@ interface DomainEvent$k extends DomainEventBodyOneOf$k {
|
|
|
1230
1230
|
entityEventSequence?: string | null;
|
|
1231
1231
|
}
|
|
1232
1232
|
/** @oneof */
|
|
1233
|
-
interface DomainEventBodyOneOf$
|
|
1234
|
-
createdEvent?: EntityCreatedEvent$
|
|
1235
|
-
updatedEvent?: EntityUpdatedEvent$
|
|
1236
|
-
deletedEvent?: EntityDeletedEvent$
|
|
1237
|
-
actionEvent?: ActionEvent$
|
|
1233
|
+
interface DomainEventBodyOneOf$l {
|
|
1234
|
+
createdEvent?: EntityCreatedEvent$l;
|
|
1235
|
+
updatedEvent?: EntityUpdatedEvent$l;
|
|
1236
|
+
deletedEvent?: EntityDeletedEvent$l;
|
|
1237
|
+
actionEvent?: ActionEvent$l;
|
|
1238
1238
|
}
|
|
1239
|
-
interface EntityCreatedEvent$
|
|
1239
|
+
interface EntityCreatedEvent$l {
|
|
1240
1240
|
entity?: string;
|
|
1241
1241
|
}
|
|
1242
|
-
interface RestoreInfo$
|
|
1242
|
+
interface RestoreInfo$l {
|
|
1243
1243
|
deletedDate?: Date | null;
|
|
1244
1244
|
}
|
|
1245
|
-
interface EntityUpdatedEvent$
|
|
1245
|
+
interface EntityUpdatedEvent$l {
|
|
1246
1246
|
/**
|
|
1247
1247
|
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
1248
1248
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
@@ -1250,30 +1250,30 @@ interface EntityUpdatedEvent$k {
|
|
|
1250
1250
|
*/
|
|
1251
1251
|
currentEntity?: string;
|
|
1252
1252
|
}
|
|
1253
|
-
interface EntityDeletedEvent$
|
|
1253
|
+
interface EntityDeletedEvent$l {
|
|
1254
1254
|
/** Entity that was deleted */
|
|
1255
1255
|
deletedEntity?: string | null;
|
|
1256
1256
|
}
|
|
1257
|
-
interface ActionEvent$
|
|
1257
|
+
interface ActionEvent$l {
|
|
1258
1258
|
body?: string;
|
|
1259
1259
|
}
|
|
1260
|
-
interface Empty$
|
|
1260
|
+
interface Empty$g {
|
|
1261
1261
|
}
|
|
1262
1262
|
interface DiscountRuleUsageLimitReached {
|
|
1263
1263
|
/** Discount Rule */
|
|
1264
|
-
rule?: DiscountRule$
|
|
1264
|
+
rule?: DiscountRule$8;
|
|
1265
1265
|
}
|
|
1266
|
-
interface MessageEnvelope$
|
|
1266
|
+
interface MessageEnvelope$k {
|
|
1267
1267
|
/** App instance ID. */
|
|
1268
1268
|
instanceId?: string | null;
|
|
1269
1269
|
/** Event type. */
|
|
1270
1270
|
eventType?: string;
|
|
1271
1271
|
/** The identification type and identity data. */
|
|
1272
|
-
identity?: IdentificationData$
|
|
1272
|
+
identity?: IdentificationData$k;
|
|
1273
1273
|
/** Stringify payload. */
|
|
1274
1274
|
data?: string;
|
|
1275
1275
|
}
|
|
1276
|
-
interface IdentificationData$
|
|
1276
|
+
interface IdentificationData$k extends IdentificationDataIdOneOf$k {
|
|
1277
1277
|
/** ID of a site visitor that has not logged in to the site. */
|
|
1278
1278
|
anonymousVisitorId?: string;
|
|
1279
1279
|
/** ID of a site visitor that has logged in to the site. */
|
|
@@ -1283,10 +1283,10 @@ interface IdentificationData$j extends IdentificationDataIdOneOf$j {
|
|
|
1283
1283
|
/** ID of an app. */
|
|
1284
1284
|
appId?: string;
|
|
1285
1285
|
/** @readonly */
|
|
1286
|
-
identityType?: WebhookIdentityType$
|
|
1286
|
+
identityType?: WebhookIdentityType$k;
|
|
1287
1287
|
}
|
|
1288
1288
|
/** @oneof */
|
|
1289
|
-
interface IdentificationDataIdOneOf$
|
|
1289
|
+
interface IdentificationDataIdOneOf$k {
|
|
1290
1290
|
/** ID of a site visitor that has not logged in to the site. */
|
|
1291
1291
|
anonymousVisitorId?: string;
|
|
1292
1292
|
/** ID of a site visitor that has logged in to the site. */
|
|
@@ -1296,7 +1296,7 @@ interface IdentificationDataIdOneOf$j {
|
|
|
1296
1296
|
/** ID of an app. */
|
|
1297
1297
|
appId?: string;
|
|
1298
1298
|
}
|
|
1299
|
-
declare enum WebhookIdentityType$
|
|
1299
|
+
declare enum WebhookIdentityType$k {
|
|
1300
1300
|
UNKNOWN = "UNKNOWN",
|
|
1301
1301
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
1302
1302
|
MEMBER = "MEMBER",
|
|
@@ -1361,7 +1361,7 @@ interface DiscountNonNullableFields {
|
|
|
1361
1361
|
fixedPrice: string;
|
|
1362
1362
|
targetType: Type;
|
|
1363
1363
|
specificItemsInfo?: SpecificItemsInfoNonNullableFields;
|
|
1364
|
-
discountType: DiscountType$
|
|
1364
|
+
discountType: DiscountType$8;
|
|
1365
1365
|
buyXGetYInfo?: BuyXGetYInfoNonNullableFields;
|
|
1366
1366
|
}
|
|
1367
1367
|
interface DiscountsNonNullableFields {
|
|
@@ -1370,7 +1370,7 @@ interface DiscountsNonNullableFields {
|
|
|
1370
1370
|
interface DiscountSettingsNonNullableFields {
|
|
1371
1371
|
appliesTo: AppliedSubjectType;
|
|
1372
1372
|
}
|
|
1373
|
-
interface DiscountRuleNonNullableFields$
|
|
1373
|
+
interface DiscountRuleNonNullableFields$7 {
|
|
1374
1374
|
trigger?: DiscountTriggerNonNullableFields;
|
|
1375
1375
|
discounts?: DiscountsNonNullableFields;
|
|
1376
1376
|
status: Status$5;
|
|
@@ -1378,26 +1378,26 @@ interface DiscountRuleNonNullableFields$6 {
|
|
|
1378
1378
|
settings?: DiscountSettingsNonNullableFields;
|
|
1379
1379
|
}
|
|
1380
1380
|
interface CreateDiscountRuleResponseNonNullableFields {
|
|
1381
|
-
discountRule?: DiscountRuleNonNullableFields$
|
|
1381
|
+
discountRule?: DiscountRuleNonNullableFields$7;
|
|
1382
1382
|
}
|
|
1383
1383
|
interface GetDiscountRuleResponseNonNullableFields {
|
|
1384
|
-
discountRule?: DiscountRuleNonNullableFields$
|
|
1384
|
+
discountRule?: DiscountRuleNonNullableFields$7;
|
|
1385
1385
|
}
|
|
1386
1386
|
interface UpdateDiscountRuleResponseNonNullableFields {
|
|
1387
|
-
discountRule?: DiscountRuleNonNullableFields$
|
|
1387
|
+
discountRule?: DiscountRuleNonNullableFields$7;
|
|
1388
1388
|
}
|
|
1389
1389
|
interface QueryDiscountRulesResponseNonNullableFields {
|
|
1390
|
-
discountRules: DiscountRuleNonNullableFields$
|
|
1390
|
+
discountRules: DiscountRuleNonNullableFields$7[];
|
|
1391
1391
|
}
|
|
1392
|
-
interface BaseEventMetadata$
|
|
1392
|
+
interface BaseEventMetadata$g {
|
|
1393
1393
|
/** App instance ID. */
|
|
1394
1394
|
instanceId?: string | null;
|
|
1395
1395
|
/** Event type. */
|
|
1396
1396
|
eventType?: string;
|
|
1397
1397
|
/** The identification type and identity data. */
|
|
1398
|
-
identity?: IdentificationData$
|
|
1398
|
+
identity?: IdentificationData$k;
|
|
1399
1399
|
}
|
|
1400
|
-
interface EventMetadata$
|
|
1400
|
+
interface EventMetadata$g extends BaseEventMetadata$g {
|
|
1401
1401
|
/**
|
|
1402
1402
|
* Unique event ID.
|
|
1403
1403
|
* Allows clients to ignore duplicate webhooks.
|
|
@@ -1436,15 +1436,15 @@ interface EventMetadata$f extends BaseEventMetadata$f {
|
|
|
1436
1436
|
entityEventSequence?: string | null;
|
|
1437
1437
|
}
|
|
1438
1438
|
interface DiscountRuleCreatedEnvelope {
|
|
1439
|
-
entity: DiscountRule$
|
|
1440
|
-
metadata: EventMetadata$
|
|
1439
|
+
entity: DiscountRule$8;
|
|
1440
|
+
metadata: EventMetadata$g;
|
|
1441
1441
|
}
|
|
1442
1442
|
interface DiscountRuleUpdatedEnvelope {
|
|
1443
|
-
entity: DiscountRule$
|
|
1444
|
-
metadata: EventMetadata$
|
|
1443
|
+
entity: DiscountRule$8;
|
|
1444
|
+
metadata: EventMetadata$g;
|
|
1445
1445
|
}
|
|
1446
1446
|
interface DiscountRuleDeletedEnvelope {
|
|
1447
|
-
metadata: EventMetadata$
|
|
1447
|
+
metadata: EventMetadata$g;
|
|
1448
1448
|
}
|
|
1449
1449
|
interface UpdateDiscountRule {
|
|
1450
1450
|
/**
|
|
@@ -1505,15 +1505,15 @@ interface UpdateDiscountRule {
|
|
|
1505
1505
|
*/
|
|
1506
1506
|
usageCount?: number;
|
|
1507
1507
|
}
|
|
1508
|
-
interface QueryCursorResult$
|
|
1509
|
-
cursors: Cursors$
|
|
1508
|
+
interface QueryCursorResult$a {
|
|
1509
|
+
cursors: Cursors$c;
|
|
1510
1510
|
hasNext: () => boolean;
|
|
1511
1511
|
hasPrev: () => boolean;
|
|
1512
1512
|
length: number;
|
|
1513
1513
|
pageSize: number;
|
|
1514
1514
|
}
|
|
1515
|
-
interface DiscountRulesQueryResult extends QueryCursorResult$
|
|
1516
|
-
items: DiscountRule$
|
|
1515
|
+
interface DiscountRulesQueryResult extends QueryCursorResult$a {
|
|
1516
|
+
items: DiscountRule$8[];
|
|
1517
1517
|
query: DiscountRulesQueryBuilder;
|
|
1518
1518
|
next: () => Promise<DiscountRulesQueryResult>;
|
|
1519
1519
|
prev: () => Promise<DiscountRulesQueryResult>;
|
|
@@ -1574,7 +1574,7 @@ interface CreateDiscountRuleSignature {
|
|
|
1574
1574
|
* @param - Discount rule info.
|
|
1575
1575
|
* @returns Discount rule.
|
|
1576
1576
|
*/
|
|
1577
|
-
(discountRule: DiscountRule$
|
|
1577
|
+
(discountRule: DiscountRule$8): Promise<DiscountRule$8 & DiscountRuleNonNullableFields$7>;
|
|
1578
1578
|
}
|
|
1579
1579
|
declare function getDiscountRule$1(httpClient: HttpClient): GetDiscountRuleSignature;
|
|
1580
1580
|
interface GetDiscountRuleSignature {
|
|
@@ -1586,7 +1586,7 @@ interface GetDiscountRuleSignature {
|
|
|
1586
1586
|
* @param - ID of the discount rule to retrieve.
|
|
1587
1587
|
* @returns The requested discount rule.
|
|
1588
1588
|
*/
|
|
1589
|
-
(discountRuleId: string): Promise<DiscountRule$
|
|
1589
|
+
(discountRuleId: string): Promise<DiscountRule$8 & DiscountRuleNonNullableFields$7>;
|
|
1590
1590
|
}
|
|
1591
1591
|
declare function updateDiscountRule$1(httpClient: HttpClient): UpdateDiscountRuleSignature;
|
|
1592
1592
|
interface UpdateDiscountRuleSignature {
|
|
@@ -1602,7 +1602,7 @@ interface UpdateDiscountRuleSignature {
|
|
|
1602
1602
|
* @param - Discount rule info.
|
|
1603
1603
|
* @returns Updated discount rule.
|
|
1604
1604
|
*/
|
|
1605
|
-
(_id: string | null, discountRule: UpdateDiscountRule): Promise<DiscountRule$
|
|
1605
|
+
(_id: string | null, discountRule: UpdateDiscountRule): Promise<DiscountRule$8 & DiscountRuleNonNullableFields$7>;
|
|
1606
1606
|
}
|
|
1607
1607
|
declare function deleteDiscountRule$1(httpClient: HttpClient): DeleteDiscountRuleSignature;
|
|
1608
1608
|
interface DeleteDiscountRuleSignature {
|
|
@@ -1639,7 +1639,7 @@ declare const onDiscountRuleCreated$1: EventDefinition<DiscountRuleCreatedEnvelo
|
|
|
1639
1639
|
declare const onDiscountRuleUpdated$1: EventDefinition<DiscountRuleUpdatedEnvelope, "wix.ecom.discounts.v1.discount_rule_updated">;
|
|
1640
1640
|
declare const onDiscountRuleDeleted$1: EventDefinition<DiscountRuleDeletedEnvelope, "wix.ecom.discounts.v1.discount_rule_deleted">;
|
|
1641
1641
|
|
|
1642
|
-
declare function createEventModule$
|
|
1642
|
+
declare function createEventModule$g<T extends EventDefinition<any, string>>(eventDefinition: T): BuildEventDefinition<T> & T;
|
|
1643
1643
|
|
|
1644
1644
|
declare const createDiscountRule: MaybeContext<BuildRESTFunction<typeof createDiscountRule$1> & typeof createDiscountRule$1>;
|
|
1645
1645
|
declare const getDiscountRule: MaybeContext<BuildRESTFunction<typeof getDiscountRule$1> & typeof getDiscountRule$1>;
|
|
@@ -1651,84 +1651,84 @@ type _publicOnDiscountRuleCreatedType = typeof onDiscountRuleCreated$1;
|
|
|
1651
1651
|
/**
|
|
1652
1652
|
* Triggered when a discount rule is created.
|
|
1653
1653
|
*/
|
|
1654
|
-
declare const onDiscountRuleCreated: ReturnType<typeof createEventModule$
|
|
1654
|
+
declare const onDiscountRuleCreated: ReturnType<typeof createEventModule$g<_publicOnDiscountRuleCreatedType>>;
|
|
1655
1655
|
|
|
1656
1656
|
type _publicOnDiscountRuleUpdatedType = typeof onDiscountRuleUpdated$1;
|
|
1657
1657
|
/**
|
|
1658
1658
|
* Triggered when a discount rule is updated.
|
|
1659
1659
|
*/
|
|
1660
|
-
declare const onDiscountRuleUpdated: ReturnType<typeof createEventModule$
|
|
1660
|
+
declare const onDiscountRuleUpdated: ReturnType<typeof createEventModule$g<_publicOnDiscountRuleUpdatedType>>;
|
|
1661
1661
|
|
|
1662
1662
|
type _publicOnDiscountRuleDeletedType = typeof onDiscountRuleDeleted$1;
|
|
1663
1663
|
/**
|
|
1664
1664
|
* Triggered when a discount rule is deleted.
|
|
1665
1665
|
*/
|
|
1666
|
-
declare const onDiscountRuleDeleted: ReturnType<typeof createEventModule$
|
|
1667
|
-
|
|
1668
|
-
type context$
|
|
1669
|
-
type context$
|
|
1670
|
-
type context$
|
|
1671
|
-
type context$
|
|
1672
|
-
declare const context$
|
|
1673
|
-
type context$
|
|
1674
|
-
type context$
|
|
1675
|
-
type context$
|
|
1676
|
-
type context$
|
|
1677
|
-
type context$
|
|
1678
|
-
type context$
|
|
1679
|
-
type context$
|
|
1680
|
-
type context$
|
|
1681
|
-
type context$
|
|
1682
|
-
type context$
|
|
1683
|
-
type context$
|
|
1684
|
-
type context$
|
|
1685
|
-
type context$
|
|
1686
|
-
type context$
|
|
1687
|
-
type context$
|
|
1688
|
-
type context$
|
|
1689
|
-
type context$
|
|
1690
|
-
type context$
|
|
1691
|
-
type context$
|
|
1692
|
-
type context$
|
|
1693
|
-
type context$
|
|
1694
|
-
type context$
|
|
1695
|
-
type context$
|
|
1696
|
-
type context$
|
|
1697
|
-
type context$
|
|
1698
|
-
type context$
|
|
1699
|
-
type context$
|
|
1700
|
-
type context$
|
|
1701
|
-
type context$
|
|
1702
|
-
type context$
|
|
1703
|
-
type context$
|
|
1704
|
-
type context$
|
|
1705
|
-
type context$
|
|
1706
|
-
type context$
|
|
1707
|
-
type context$
|
|
1708
|
-
declare const context$
|
|
1709
|
-
type context$
|
|
1710
|
-
type context$
|
|
1711
|
-
type context$
|
|
1712
|
-
declare const context$
|
|
1713
|
-
type context$
|
|
1714
|
-
declare const context$
|
|
1715
|
-
type context$
|
|
1716
|
-
type context$
|
|
1717
|
-
type context$
|
|
1718
|
-
type context$
|
|
1719
|
-
type context$
|
|
1720
|
-
type context$
|
|
1721
|
-
type context$
|
|
1722
|
-
declare const context$
|
|
1723
|
-
declare const context$
|
|
1724
|
-
declare const context$
|
|
1725
|
-
declare const context$
|
|
1726
|
-
declare const context$
|
|
1727
|
-
declare const context$
|
|
1728
|
-
declare const context$
|
|
1729
|
-
declare const context$
|
|
1730
|
-
declare namespace context$
|
|
1731
|
-
export { type ActionEvent$
|
|
1666
|
+
declare const onDiscountRuleDeleted: ReturnType<typeof createEventModule$g<_publicOnDiscountRuleDeletedType>>;
|
|
1667
|
+
|
|
1668
|
+
type context$q_ActiveTimeInfo = ActiveTimeInfo;
|
|
1669
|
+
type context$q_And = And;
|
|
1670
|
+
type context$q_AppliedDiscountRule = AppliedDiscountRule;
|
|
1671
|
+
type context$q_AppliedSubjectType = AppliedSubjectType;
|
|
1672
|
+
declare const context$q_AppliedSubjectType: typeof AppliedSubjectType;
|
|
1673
|
+
type context$q_BuyXGetYInfo = BuyXGetYInfo;
|
|
1674
|
+
type context$q_CatalogItemFilter = CatalogItemFilter;
|
|
1675
|
+
type context$q_CreateDiscountRuleRequest = CreateDiscountRuleRequest;
|
|
1676
|
+
type context$q_CreateDiscountRuleResponse = CreateDiscountRuleResponse;
|
|
1677
|
+
type context$q_CreateDiscountRuleResponseNonNullableFields = CreateDiscountRuleResponseNonNullableFields;
|
|
1678
|
+
type context$q_Custom = Custom;
|
|
1679
|
+
type context$q_CustomFilter = CustomFilter;
|
|
1680
|
+
type context$q_CustomerBuy = CustomerBuy;
|
|
1681
|
+
type context$q_CustomerBuyConditionOneOf = CustomerBuyConditionOneOf;
|
|
1682
|
+
type context$q_CustomerGet = CustomerGet;
|
|
1683
|
+
type context$q_DeleteDiscountRuleRequest = DeleteDiscountRuleRequest;
|
|
1684
|
+
type context$q_DeleteDiscountRuleResponse = DeleteDiscountRuleResponse;
|
|
1685
|
+
type context$q_DiscountDiscountOneOf = DiscountDiscountOneOf;
|
|
1686
|
+
type context$q_DiscountRuleCreatedEnvelope = DiscountRuleCreatedEnvelope;
|
|
1687
|
+
type context$q_DiscountRuleDeletedEnvelope = DiscountRuleDeletedEnvelope;
|
|
1688
|
+
type context$q_DiscountRuleUpdatedEnvelope = DiscountRuleUpdatedEnvelope;
|
|
1689
|
+
type context$q_DiscountRuleUsageLimitReached = DiscountRuleUsageLimitReached;
|
|
1690
|
+
type context$q_DiscountRulesQueryBuilder = DiscountRulesQueryBuilder;
|
|
1691
|
+
type context$q_DiscountRulesQueryResult = DiscountRulesQueryResult;
|
|
1692
|
+
type context$q_DiscountSettings = DiscountSettings;
|
|
1693
|
+
type context$q_DiscountTrigger = DiscountTrigger;
|
|
1694
|
+
type context$q_DiscountTriggerTriggerOneOf = DiscountTriggerTriggerOneOf;
|
|
1695
|
+
type context$q_Discounts = Discounts;
|
|
1696
|
+
type context$q_GetAppliedDiscountsRequest = GetAppliedDiscountsRequest;
|
|
1697
|
+
type context$q_GetAppliedDiscountsResponse = GetAppliedDiscountsResponse;
|
|
1698
|
+
type context$q_GetDiscountRuleRequest = GetDiscountRuleRequest;
|
|
1699
|
+
type context$q_GetDiscountRuleResponse = GetDiscountRuleResponse;
|
|
1700
|
+
type context$q_GetDiscountRuleResponseNonNullableFields = GetDiscountRuleResponseNonNullableFields;
|
|
1701
|
+
type context$q_ItemQuantityRange = ItemQuantityRange;
|
|
1702
|
+
type context$q_Or = Or;
|
|
1703
|
+
type context$q_QueryDiscountRulesRequest = QueryDiscountRulesRequest;
|
|
1704
|
+
type context$q_QueryDiscountRulesResponse = QueryDiscountRulesResponse;
|
|
1705
|
+
type context$q_QueryDiscountRulesResponseNonNullableFields = QueryDiscountRulesResponseNonNullableFields;
|
|
1706
|
+
type context$q_ScopeScopeItemsOneOf = ScopeScopeItemsOneOf;
|
|
1707
|
+
type context$q_ScopeType = ScopeType;
|
|
1708
|
+
declare const context$q_ScopeType: typeof ScopeType;
|
|
1709
|
+
type context$q_SpecificItemsInfo = SpecificItemsInfo;
|
|
1710
|
+
type context$q_SubtotalRange = SubtotalRange;
|
|
1711
|
+
type context$q_TriggerType = TriggerType;
|
|
1712
|
+
declare const context$q_TriggerType: typeof TriggerType;
|
|
1713
|
+
type context$q_Type = Type;
|
|
1714
|
+
declare const context$q_Type: typeof Type;
|
|
1715
|
+
type context$q_UpdateDiscountRule = UpdateDiscountRule;
|
|
1716
|
+
type context$q_UpdateDiscountRuleRequest = UpdateDiscountRuleRequest;
|
|
1717
|
+
type context$q_UpdateDiscountRuleResponse = UpdateDiscountRuleResponse;
|
|
1718
|
+
type context$q_UpdateDiscountRuleResponseNonNullableFields = UpdateDiscountRuleResponseNonNullableFields;
|
|
1719
|
+
type context$q__publicOnDiscountRuleCreatedType = _publicOnDiscountRuleCreatedType;
|
|
1720
|
+
type context$q__publicOnDiscountRuleDeletedType = _publicOnDiscountRuleDeletedType;
|
|
1721
|
+
type context$q__publicOnDiscountRuleUpdatedType = _publicOnDiscountRuleUpdatedType;
|
|
1722
|
+
declare const context$q_createDiscountRule: typeof createDiscountRule;
|
|
1723
|
+
declare const context$q_deleteDiscountRule: typeof deleteDiscountRule;
|
|
1724
|
+
declare const context$q_getDiscountRule: typeof getDiscountRule;
|
|
1725
|
+
declare const context$q_onDiscountRuleCreated: typeof onDiscountRuleCreated;
|
|
1726
|
+
declare const context$q_onDiscountRuleDeleted: typeof onDiscountRuleDeleted;
|
|
1727
|
+
declare const context$q_onDiscountRuleUpdated: typeof onDiscountRuleUpdated;
|
|
1728
|
+
declare const context$q_queryDiscountRules: typeof queryDiscountRules;
|
|
1729
|
+
declare const context$q_updateDiscountRule: typeof updateDiscountRule;
|
|
1730
|
+
declare namespace context$q {
|
|
1731
|
+
export { type ActionEvent$l as ActionEvent, type context$q_ActiveTimeInfo as ActiveTimeInfo, type context$q_And as And, type AppliedDiscount$8 as AppliedDiscount, type context$q_AppliedDiscountRule as AppliedDiscountRule, context$q_AppliedSubjectType as AppliedSubjectType, type BaseEventMetadata$g as BaseEventMetadata, type context$q_BuyXGetYInfo as BuyXGetYInfo, type context$q_CatalogItemFilter as CatalogItemFilter, type CatalogReference$b as CatalogReference, type context$q_CreateDiscountRuleRequest as CreateDiscountRuleRequest, type context$q_CreateDiscountRuleResponse as CreateDiscountRuleResponse, type context$q_CreateDiscountRuleResponseNonNullableFields as CreateDiscountRuleResponseNonNullableFields, type CursorPaging$c as CursorPaging, type Cursors$c as Cursors, type context$q_Custom as Custom, type context$q_CustomFilter as CustomFilter, type context$q_CustomerBuy as CustomerBuy, type context$q_CustomerBuyConditionOneOf as CustomerBuyConditionOneOf, type context$q_CustomerGet as CustomerGet, type context$q_DeleteDiscountRuleRequest as DeleteDiscountRuleRequest, type context$q_DeleteDiscountRuleResponse as DeleteDiscountRuleResponse, type Discount$3 as Discount, type context$q_DiscountDiscountOneOf as DiscountDiscountOneOf, type DiscountRule$8 as DiscountRule, type context$q_DiscountRuleCreatedEnvelope as DiscountRuleCreatedEnvelope, type context$q_DiscountRuleDeletedEnvelope as DiscountRuleDeletedEnvelope, type DiscountRuleName$8 as DiscountRuleName, type DiscountRuleNonNullableFields$7 as DiscountRuleNonNullableFields, type context$q_DiscountRuleUpdatedEnvelope as DiscountRuleUpdatedEnvelope, type context$q_DiscountRuleUsageLimitReached as DiscountRuleUsageLimitReached, type context$q_DiscountRulesQueryBuilder as DiscountRulesQueryBuilder, type context$q_DiscountRulesQueryResult as DiscountRulesQueryResult, type context$q_DiscountSettings as DiscountSettings, type context$q_DiscountTrigger as DiscountTrigger, type context$q_DiscountTriggerTriggerOneOf as DiscountTriggerTriggerOneOf, DiscountType$8 as DiscountType, type context$q_Discounts as Discounts, type DomainEvent$l as DomainEvent, type DomainEventBodyOneOf$l as DomainEventBodyOneOf, type Empty$g as Empty, type EntityCreatedEvent$l as EntityCreatedEvent, type EntityDeletedEvent$l as EntityDeletedEvent, type EntityUpdatedEvent$l as EntityUpdatedEvent, type EventMetadata$g as EventMetadata, type ExtendedFields$b as ExtendedFields, type context$q_GetAppliedDiscountsRequest as GetAppliedDiscountsRequest, type context$q_GetAppliedDiscountsResponse as GetAppliedDiscountsResponse, type context$q_GetDiscountRuleRequest as GetDiscountRuleRequest, type context$q_GetDiscountRuleResponse as GetDiscountRuleResponse, type context$q_GetDiscountRuleResponseNonNullableFields as GetDiscountRuleResponseNonNullableFields, type IdentificationData$k as IdentificationData, type IdentificationDataIdOneOf$k as IdentificationDataIdOneOf, type context$q_ItemQuantityRange as ItemQuantityRange, type LineItem$7 as LineItem, type MessageEnvelope$k as MessageEnvelope, type MultiCurrencyPrice$6 as MultiCurrencyPrice, type context$q_Or as Or, type PlatformPaging$2 as PlatformPaging, type PlatformPagingMetadata$2 as PlatformPagingMetadata, type PlatformQuery$2 as PlatformQuery, type PlatformQueryPagingMethodOneOf$2 as PlatformQueryPagingMethodOneOf, type context$q_QueryDiscountRulesRequest as QueryDiscountRulesRequest, type context$q_QueryDiscountRulesResponse as QueryDiscountRulesResponse, type context$q_QueryDiscountRulesResponseNonNullableFields as QueryDiscountRulesResponseNonNullableFields, type RestoreInfo$l as RestoreInfo, type Scope$5 as Scope, type context$q_ScopeScopeItemsOneOf as ScopeScopeItemsOneOf, context$q_ScopeType as ScopeType, SortOrder$c as SortOrder, type Sorting$c as Sorting, type context$q_SpecificItemsInfo as SpecificItemsInfo, Status$5 as Status, type context$q_SubtotalRange as SubtotalRange, context$q_TriggerType as TriggerType, context$q_Type as Type, type context$q_UpdateDiscountRule as UpdateDiscountRule, type context$q_UpdateDiscountRuleRequest as UpdateDiscountRuleRequest, type context$q_UpdateDiscountRuleResponse as UpdateDiscountRuleResponse, type context$q_UpdateDiscountRuleResponseNonNullableFields as UpdateDiscountRuleResponseNonNullableFields, WebhookIdentityType$k as WebhookIdentityType, type context$q__publicOnDiscountRuleCreatedType as _publicOnDiscountRuleCreatedType, type context$q__publicOnDiscountRuleDeletedType as _publicOnDiscountRuleDeletedType, type context$q__publicOnDiscountRuleUpdatedType as _publicOnDiscountRuleUpdatedType, context$q_createDiscountRule as createDiscountRule, context$q_deleteDiscountRule as deleteDiscountRule, context$q_getDiscountRule as getDiscountRule, context$q_onDiscountRuleCreated as onDiscountRuleCreated, context$q_onDiscountRuleDeleted as onDiscountRuleDeleted, context$q_onDiscountRuleUpdated as onDiscountRuleUpdated, onDiscountRuleCreated$1 as publicOnDiscountRuleCreated, onDiscountRuleDeleted$1 as publicOnDiscountRuleDeleted, onDiscountRuleUpdated$1 as publicOnDiscountRuleUpdated, context$q_queryDiscountRules as queryDiscountRules, context$q_updateDiscountRule as updateDiscountRule };
|
|
1732
1732
|
}
|
|
1733
1733
|
|
|
1734
1734
|
interface Invoice {
|
|
@@ -1821,11 +1821,1708 @@ interface AddInvoiceToOrderResponse$1 {
|
|
|
1821
1821
|
/** List of order invoices. */
|
|
1822
1822
|
orderInvoices?: Invoice[];
|
|
1823
1823
|
}
|
|
1824
|
-
interface DomainEvent$
|
|
1825
|
-
createdEvent?: EntityCreatedEvent$
|
|
1826
|
-
updatedEvent?: EntityUpdatedEvent$
|
|
1827
|
-
deletedEvent?: EntityDeletedEvent$
|
|
1828
|
-
actionEvent?: ActionEvent$
|
|
1824
|
+
interface DomainEvent$k extends DomainEventBodyOneOf$k {
|
|
1825
|
+
createdEvent?: EntityCreatedEvent$k;
|
|
1826
|
+
updatedEvent?: EntityUpdatedEvent$k;
|
|
1827
|
+
deletedEvent?: EntityDeletedEvent$k;
|
|
1828
|
+
actionEvent?: ActionEvent$k;
|
|
1829
|
+
/**
|
|
1830
|
+
* Unique event ID.
|
|
1831
|
+
* Allows clients to ignore duplicate webhooks.
|
|
1832
|
+
*/
|
|
1833
|
+
_id?: string;
|
|
1834
|
+
/**
|
|
1835
|
+
* Assumes actions are also always typed to an entity_type
|
|
1836
|
+
* Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
|
|
1837
|
+
*/
|
|
1838
|
+
entityFqdn?: string;
|
|
1839
|
+
/**
|
|
1840
|
+
* This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
|
|
1841
|
+
* This is although the created/updated/deleted notion is duplication of the oneof types
|
|
1842
|
+
* Example: created/updated/deleted/started/completed/email_opened
|
|
1843
|
+
*/
|
|
1844
|
+
slug?: string;
|
|
1845
|
+
/** ID of the entity associated with the event. */
|
|
1846
|
+
entityId?: string;
|
|
1847
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
|
|
1848
|
+
eventTime?: Date | null;
|
|
1849
|
+
/**
|
|
1850
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
1851
|
+
* (for example, GDPR).
|
|
1852
|
+
*/
|
|
1853
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
1854
|
+
/** If present, indicates the action that triggered the event. */
|
|
1855
|
+
originatedFrom?: string | null;
|
|
1856
|
+
/**
|
|
1857
|
+
* A sequence number defining the order of updates to the underlying entity.
|
|
1858
|
+
* For example, given that some entity was updated at 16:00 and than again at 16:01,
|
|
1859
|
+
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
1860
|
+
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
1861
|
+
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
1862
|
+
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
1863
|
+
*/
|
|
1864
|
+
entityEventSequence?: string | null;
|
|
1865
|
+
}
|
|
1866
|
+
/** @oneof */
|
|
1867
|
+
interface DomainEventBodyOneOf$k {
|
|
1868
|
+
createdEvent?: EntityCreatedEvent$k;
|
|
1869
|
+
updatedEvent?: EntityUpdatedEvent$k;
|
|
1870
|
+
deletedEvent?: EntityDeletedEvent$k;
|
|
1871
|
+
actionEvent?: ActionEvent$k;
|
|
1872
|
+
}
|
|
1873
|
+
interface EntityCreatedEvent$k {
|
|
1874
|
+
entity?: string;
|
|
1875
|
+
}
|
|
1876
|
+
interface RestoreInfo$k {
|
|
1877
|
+
deletedDate?: Date | null;
|
|
1878
|
+
}
|
|
1879
|
+
interface EntityUpdatedEvent$k {
|
|
1880
|
+
/**
|
|
1881
|
+
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
1882
|
+
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
1883
|
+
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
1884
|
+
*/
|
|
1885
|
+
currentEntity?: string;
|
|
1886
|
+
}
|
|
1887
|
+
interface EntityDeletedEvent$k {
|
|
1888
|
+
/** Entity that was deleted */
|
|
1889
|
+
deletedEntity?: string | null;
|
|
1890
|
+
}
|
|
1891
|
+
interface ActionEvent$k {
|
|
1892
|
+
body?: string;
|
|
1893
|
+
}
|
|
1894
|
+
interface Empty$f {
|
|
1895
|
+
}
|
|
1896
|
+
interface GetOrderInvoiceRequest {
|
|
1897
|
+
/** Invoice ID. */
|
|
1898
|
+
invoiceId?: string;
|
|
1899
|
+
}
|
|
1900
|
+
interface GetOrderInvoiceResponse {
|
|
1901
|
+
/** Order ID. */
|
|
1902
|
+
orderId?: string;
|
|
1903
|
+
/** Invoice info. */
|
|
1904
|
+
invoiceInfo?: Invoice;
|
|
1905
|
+
}
|
|
1906
|
+
interface GenerateInvoiceWithNumberRequest {
|
|
1907
|
+
/** Order ID. */
|
|
1908
|
+
orderId?: string;
|
|
1909
|
+
invoiceNumber?: string;
|
|
1910
|
+
/** Date and time the payment was created in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. Defaults to current time when not provided. */
|
|
1911
|
+
issueDate?: Date | null;
|
|
1912
|
+
}
|
|
1913
|
+
interface GenerateInvoiceWithNumberResponse {
|
|
1914
|
+
/** Invoice ID. */
|
|
1915
|
+
invoiceId?: string;
|
|
1916
|
+
}
|
|
1917
|
+
interface MessageEnvelope$j {
|
|
1918
|
+
/** App instance ID. */
|
|
1919
|
+
instanceId?: string | null;
|
|
1920
|
+
/** Event type. */
|
|
1921
|
+
eventType?: string;
|
|
1922
|
+
/** The identification type and identity data. */
|
|
1923
|
+
identity?: IdentificationData$j;
|
|
1924
|
+
/** Stringify payload. */
|
|
1925
|
+
data?: string;
|
|
1926
|
+
}
|
|
1927
|
+
interface IdentificationData$j extends IdentificationDataIdOneOf$j {
|
|
1928
|
+
/** ID of a site visitor that has not logged in to the site. */
|
|
1929
|
+
anonymousVisitorId?: string;
|
|
1930
|
+
/** ID of a site visitor that has logged in to the site. */
|
|
1931
|
+
memberId?: string;
|
|
1932
|
+
/** ID of a Wix user (site owner, contributor, etc.). */
|
|
1933
|
+
wixUserId?: string;
|
|
1934
|
+
/** ID of an app. */
|
|
1935
|
+
appId?: string;
|
|
1936
|
+
/** @readonly */
|
|
1937
|
+
identityType?: WebhookIdentityType$j;
|
|
1938
|
+
}
|
|
1939
|
+
/** @oneof */
|
|
1940
|
+
interface IdentificationDataIdOneOf$j {
|
|
1941
|
+
/** ID of a site visitor that has not logged in to the site. */
|
|
1942
|
+
anonymousVisitorId?: string;
|
|
1943
|
+
/** ID of a site visitor that has logged in to the site. */
|
|
1944
|
+
memberId?: string;
|
|
1945
|
+
/** ID of a Wix user (site owner, contributor, etc.). */
|
|
1946
|
+
wixUserId?: string;
|
|
1947
|
+
/** ID of an app. */
|
|
1948
|
+
appId?: string;
|
|
1949
|
+
}
|
|
1950
|
+
declare enum WebhookIdentityType$j {
|
|
1951
|
+
UNKNOWN = "UNKNOWN",
|
|
1952
|
+
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
1953
|
+
MEMBER = "MEMBER",
|
|
1954
|
+
WIX_USER = "WIX_USER",
|
|
1955
|
+
APP = "APP"
|
|
1956
|
+
}
|
|
1957
|
+
interface InvoiceNonNullableFields {
|
|
1958
|
+
_id: string;
|
|
1959
|
+
appId: string;
|
|
1960
|
+
}
|
|
1961
|
+
interface InvoicesForOrderNonNullableFields {
|
|
1962
|
+
orderId: string;
|
|
1963
|
+
invoices: InvoiceNonNullableFields[];
|
|
1964
|
+
invoicesInfo: InvoiceNonNullableFields[];
|
|
1965
|
+
}
|
|
1966
|
+
interface ListInvoicesForMultipleOrdersResponseNonNullableFields {
|
|
1967
|
+
invoicesForOrder: InvoicesForOrderNonNullableFields[];
|
|
1968
|
+
}
|
|
1969
|
+
|
|
1970
|
+
declare function listInvoicesForMultipleOrders$1(httpClient: HttpClient): ListInvoicesForMultipleOrdersSignature;
|
|
1971
|
+
interface ListInvoicesForMultipleOrdersSignature {
|
|
1972
|
+
/**
|
|
1973
|
+
* Retrieves the IDs of invoices associated with all specified orders.
|
|
1974
|
+
*
|
|
1975
|
+
*
|
|
1976
|
+
* The `listInvoicesForSingleOrder()` function returns a Promise that resolves when the specified order's transaction records are retrieved.
|
|
1977
|
+
* @param - Order IDs for which to retrieve invoices.
|
|
1978
|
+
*/
|
|
1979
|
+
(orderIds: string[]): Promise<ListInvoicesForMultipleOrdersResponse$1 & ListInvoicesForMultipleOrdersResponseNonNullableFields>;
|
|
1980
|
+
}
|
|
1981
|
+
|
|
1982
|
+
declare const listInvoicesForMultipleOrders: MaybeContext<BuildRESTFunction<typeof listInvoicesForMultipleOrders$1> & typeof listInvoicesForMultipleOrders$1>;
|
|
1983
|
+
|
|
1984
|
+
type context$p_GenerateInvoiceWithNumberRequest = GenerateInvoiceWithNumberRequest;
|
|
1985
|
+
type context$p_GenerateInvoiceWithNumberResponse = GenerateInvoiceWithNumberResponse;
|
|
1986
|
+
type context$p_GetOrderInvoiceRequest = GetOrderInvoiceRequest;
|
|
1987
|
+
type context$p_GetOrderInvoiceResponse = GetOrderInvoiceResponse;
|
|
1988
|
+
type context$p_Invoice = Invoice;
|
|
1989
|
+
type context$p_ListInvoicesForMultipleOrdersResponseNonNullableFields = ListInvoicesForMultipleOrdersResponseNonNullableFields;
|
|
1990
|
+
declare const context$p_listInvoicesForMultipleOrders: typeof listInvoicesForMultipleOrders;
|
|
1991
|
+
declare namespace context$p {
|
|
1992
|
+
export { type ActionEvent$k as ActionEvent, type AddInvoiceToOrderRequest$1 as AddInvoiceToOrderRequest, type AddInvoiceToOrderResponse$1 as AddInvoiceToOrderResponse, type ApplicationError$c as ApplicationError, type BulkActionMetadata$4 as BulkActionMetadata, type BulkGenerateInvoicesRequest$1 as BulkGenerateInvoicesRequest, type BulkGenerateInvoicesResponse$1 as BulkGenerateInvoicesResponse, type BulkInvoiceResult$1 as BulkInvoiceResult, type DomainEvent$k as DomainEvent, type DomainEventBodyOneOf$k as DomainEventBodyOneOf, type Empty$f as Empty, type EntityCreatedEvent$k as EntityCreatedEvent, type EntityDeletedEvent$k as EntityDeletedEvent, type EntityUpdatedEvent$k as EntityUpdatedEvent, type GenerateInvoiceRequest$1 as GenerateInvoiceRequest, type GenerateInvoiceResponse$1 as GenerateInvoiceResponse, type context$p_GenerateInvoiceWithNumberRequest as GenerateInvoiceWithNumberRequest, type context$p_GenerateInvoiceWithNumberResponse as GenerateInvoiceWithNumberResponse, type context$p_GetOrderInvoiceRequest as GetOrderInvoiceRequest, type context$p_GetOrderInvoiceResponse as GetOrderInvoiceResponse, type IdentificationData$j as IdentificationData, type IdentificationDataIdOneOf$j as IdentificationDataIdOneOf, type context$p_Invoice as Invoice, type InvoiceForOrder$1 as InvoiceForOrder, type InvoicesForOrder$1 as InvoicesForOrder, type ItemMetadata$4 as ItemMetadata, type ListInvoicesForMultipleOrdersRequest$1 as ListInvoicesForMultipleOrdersRequest, type ListInvoicesForMultipleOrdersResponse$1 as ListInvoicesForMultipleOrdersResponse, type context$p_ListInvoicesForMultipleOrdersResponseNonNullableFields as ListInvoicesForMultipleOrdersResponseNonNullableFields, type ListInvoicesForSingleOrderRequest$1 as ListInvoicesForSingleOrderRequest, type ListInvoicesForSingleOrderResponse$1 as ListInvoicesForSingleOrderResponse, type MessageEnvelope$j as MessageEnvelope, type RestoreInfo$k as RestoreInfo, WebhookIdentityType$j as WebhookIdentityType, context$p_listInvoicesForMultipleOrders as listInvoicesForMultipleOrders };
|
|
1993
|
+
}
|
|
1994
|
+
|
|
1995
|
+
interface Recommendation {
|
|
1996
|
+
/** Recommended items. */
|
|
1997
|
+
items?: CatalogReference$a[];
|
|
1998
|
+
/** The algorithm used to provide the recommendation. */
|
|
1999
|
+
algorithm?: Algorithm;
|
|
2000
|
+
}
|
|
2001
|
+
/** Used for grouping line items. Sent when an item is added to a cart, checkout, or order. */
|
|
2002
|
+
interface CatalogReference$a {
|
|
2003
|
+
/** ID of the item within the catalog it belongs to. */
|
|
2004
|
+
catalogItemId?: string;
|
|
2005
|
+
/**
|
|
2006
|
+
* ID of the app providing the catalog.
|
|
2007
|
+
*
|
|
2008
|
+
* You can get your app's ID from its page in the [Wix Dev Center](https://dev.wix.com/apps).
|
|
2009
|
+
*
|
|
2010
|
+
* For items from Wix catalogs, the following values always apply:
|
|
2011
|
+
* + Wix Stores: `"215238eb-22a5-4c36-9e7b-e7c08025e04e"`
|
|
2012
|
+
* + Wix Bookings: `"13d21c63-b5ec-5912-8397-c3a5ddb27a97"`
|
|
2013
|
+
* + Wix Restaurants: `"9a5d83fd-8570-482e-81ab-cfa88942ee60"`
|
|
2014
|
+
*/
|
|
2015
|
+
appId?: string;
|
|
2016
|
+
/**
|
|
2017
|
+
* Additional item details in key:value pairs. Use this optional field to provide more specificity with item selection. The `options` field values differ depending on which catalog is providing the items.
|
|
2018
|
+
*
|
|
2019
|
+
* For products and variants from a Wix Stores catalog, learn more about [eCommerce integration](https://dev.wix.com/docs/rest/business-solutions/stores/catalog/e-commerce-integration).
|
|
2020
|
+
*/
|
|
2021
|
+
options?: Record<string, any> | null;
|
|
2022
|
+
}
|
|
2023
|
+
interface Algorithm {
|
|
2024
|
+
/** Algorithm ID defined by the app providing the algorithm. */
|
|
2025
|
+
_id?: string;
|
|
2026
|
+
/**
|
|
2027
|
+
* App ID of the Wix or 3rd-party app providing the algorithm.
|
|
2028
|
+
*
|
|
2029
|
+
* Wix app IDs are <a href="https://dev.wix.com/api/rest/getting-started/wix-business-solutions#getting-started_wix-business-solutions_about-wix-business-solutions" target="_blank">listed here</a>.
|
|
2030
|
+
*/
|
|
2031
|
+
appId?: string;
|
|
2032
|
+
}
|
|
2033
|
+
interface ListAvailableAlgorithmsRequest {
|
|
2034
|
+
}
|
|
2035
|
+
interface ListAvailableAlgorithmsResponse {
|
|
2036
|
+
/** Algorithms available for use on your Wix site or project. See the method description for more information. */
|
|
2037
|
+
availableAlgorithms?: AlgorithmInfo[];
|
|
2038
|
+
}
|
|
2039
|
+
interface AlgorithmInfo {
|
|
2040
|
+
/** How the algorithm is configured. */
|
|
2041
|
+
config?: AlgorithmConfig;
|
|
2042
|
+
/**
|
|
2043
|
+
* The app ID of the application providing the algorithm.
|
|
2044
|
+
*
|
|
2045
|
+
* Wix app IDs are <a href="https://dev.wix.com/api/rest/getting-started/wix-business-solutions#getting-started_wix-business-solutions_about-wix-business-solutions" target="_blank">listed here</a>.
|
|
2046
|
+
*/
|
|
2047
|
+
appId?: string;
|
|
2048
|
+
/**
|
|
2049
|
+
* App IDs of catalogs to which the algorithm can be applied.
|
|
2050
|
+
*
|
|
2051
|
+
* Wix app IDs are <a href="https://dev.wix.com/api/rest/getting-started/wix-business-solutions#getting-started_wix-business-solutions_about-wix-business-solutions" target="_blank">listed here</a>.
|
|
2052
|
+
*/
|
|
2053
|
+
catalogAppIds?: string[];
|
|
2054
|
+
}
|
|
2055
|
+
interface AlgorithmConfig {
|
|
2056
|
+
/** Algorithm name. This value is not translatable. */
|
|
2057
|
+
name?: string;
|
|
2058
|
+
/** Algorithm description. This describes how the algorithm works and if it has any limitations regarding site content, number of items in the catalog, site traffic, and so on. This value is not translatable. */
|
|
2059
|
+
description?: string;
|
|
2060
|
+
/** A supplemental `description`. It can be used to help break up and organize information. You can, for example, display this information as a tooltip or as an additional section that is collapsed by default. */
|
|
2061
|
+
additionalInfo?: string | null;
|
|
2062
|
+
/**
|
|
2063
|
+
* Algorithms may have the following types:
|
|
2064
|
+
* * `RELATED_ITEMS` - This type of algorithm provides recommendations based on 1 or more other provided items. For example, when an item is added to a cart, the algorithm can suggest other items frequently bought together with that item.
|
|
2065
|
+
* * `GLOBAL` - This type of algorithm provides general recommendations based on site or project statistics. For example, bestsellers or new arrivals.
|
|
2066
|
+
*/
|
|
2067
|
+
algorithmType?: AlgorithmType;
|
|
2068
|
+
/** Algorithm ID. This must be unique for a specific app but does not have to be unique across all apps on the site or in the project. */
|
|
2069
|
+
algorithmId?: string;
|
|
2070
|
+
}
|
|
2071
|
+
declare enum AlgorithmType {
|
|
2072
|
+
UNSPECIFIED = "UNSPECIFIED",
|
|
2073
|
+
RELATED_ITEMS = "RELATED_ITEMS",
|
|
2074
|
+
GLOBAL = "GLOBAL"
|
|
2075
|
+
}
|
|
2076
|
+
interface GetRecommendationRequest {
|
|
2077
|
+
/** The set of items for which to get recommendations. Required if the `algorithmType` is `RELATED_ITEMS`. */
|
|
2078
|
+
items?: CatalogReference$a[];
|
|
2079
|
+
/**
|
|
2080
|
+
* A list of algorithms checked in a specific order determined by their `appID` and their position in the `algorithms` array.
|
|
2081
|
+
* See the method description for more information.
|
|
2082
|
+
*
|
|
2083
|
+
* If no algorithm is able to return at least `minimumRecommendedItems` items, an empty array is returned.
|
|
2084
|
+
*/
|
|
2085
|
+
algorithms: Algorithm[];
|
|
2086
|
+
/**
|
|
2087
|
+
* The minimum number of items that must be recommended by the algorithm for those items to be returned in the response.
|
|
2088
|
+
*
|
|
2089
|
+
* Max: `100`
|
|
2090
|
+
*/
|
|
2091
|
+
minimumRecommendedItems?: number;
|
|
2092
|
+
}
|
|
2093
|
+
interface GetRecommendationResponse {
|
|
2094
|
+
/** An object containing a list of items recommended by 1 of the specified algorithms. The recommendation is empty if none of the specified algorithms recommended enough items. */
|
|
2095
|
+
recommendation?: Recommendation;
|
|
2096
|
+
}
|
|
2097
|
+
interface ItemAppIdNotSupportedByProvider {
|
|
2098
|
+
/** Items with an App ID not supported by the provider. Supported App IDs can be found in the provider config in the Dev Center. */
|
|
2099
|
+
items?: CatalogReference$a[];
|
|
2100
|
+
/** Algorithms that don't support the requested items. */
|
|
2101
|
+
algorithms?: Algorithm[];
|
|
2102
|
+
}
|
|
2103
|
+
interface RecommendationAlgorithmNotSupported {
|
|
2104
|
+
/** Algorithms not supported by the provider. */
|
|
2105
|
+
unsupportedAlgorithms?: Algorithm[];
|
|
2106
|
+
}
|
|
2107
|
+
interface AlgorithmConfigNonNullableFields {
|
|
2108
|
+
name: string;
|
|
2109
|
+
description: string;
|
|
2110
|
+
algorithmType: AlgorithmType;
|
|
2111
|
+
algorithmId: string;
|
|
2112
|
+
}
|
|
2113
|
+
interface AlgorithmInfoNonNullableFields {
|
|
2114
|
+
config?: AlgorithmConfigNonNullableFields;
|
|
2115
|
+
appId: string;
|
|
2116
|
+
catalogAppIds: string[];
|
|
2117
|
+
}
|
|
2118
|
+
interface ListAvailableAlgorithmsResponseNonNullableFields {
|
|
2119
|
+
availableAlgorithms: AlgorithmInfoNonNullableFields[];
|
|
2120
|
+
}
|
|
2121
|
+
interface CatalogReferenceNonNullableFields$8 {
|
|
2122
|
+
catalogItemId: string;
|
|
2123
|
+
appId: string;
|
|
2124
|
+
}
|
|
2125
|
+
interface AlgorithmNonNullableFields {
|
|
2126
|
+
_id: string;
|
|
2127
|
+
appId: string;
|
|
2128
|
+
}
|
|
2129
|
+
interface RecommendationNonNullableFields {
|
|
2130
|
+
items: CatalogReferenceNonNullableFields$8[];
|
|
2131
|
+
algorithm?: AlgorithmNonNullableFields;
|
|
2132
|
+
}
|
|
2133
|
+
interface GetRecommendationResponseNonNullableFields {
|
|
2134
|
+
recommendation?: RecommendationNonNullableFields;
|
|
2135
|
+
}
|
|
2136
|
+
interface GetRecommendationOptions {
|
|
2137
|
+
/** The set of items for which to get recommendations. Required if the `algorithmType` is `RELATED_ITEMS`. */
|
|
2138
|
+
items?: CatalogReference$a[];
|
|
2139
|
+
/**
|
|
2140
|
+
* The minimum number of items that must be recommended by the algorithm for those items to be returned in the response.
|
|
2141
|
+
*
|
|
2142
|
+
* Max: `100`
|
|
2143
|
+
*/
|
|
2144
|
+
minimumRecommendedItems?: number;
|
|
2145
|
+
}
|
|
2146
|
+
|
|
2147
|
+
declare function listAvailableAlgorithms$1(httpClient: HttpClient): ListAvailableAlgorithmsSignature;
|
|
2148
|
+
interface ListAvailableAlgorithmsSignature {
|
|
2149
|
+
/**
|
|
2150
|
+
* Returns a list of recommendation algorithms that can be used on your Wix site or project. These algorithms can be used with [`getRecommendation()`](#getRecommendation) to provide item recommendations to the customer.
|
|
2151
|
+
*
|
|
2152
|
+
* Algorithms are run by the apps that provide them, and can only be used on catalogs they support. Apps may provide algorithms for use with their own catalogs and/or catalogs from other apps.
|
|
2153
|
+
*
|
|
2154
|
+
* The app which provides an algorithm is referenced by that algorithm’s `appId`. The apps whose catalogs are supported by an algorithm are referenced by the IDs in that algorithm’s `catalogAppIds` array.
|
|
2155
|
+
*
|
|
2156
|
+
*
|
|
2157
|
+
* For an algorithm to be considered “Available” and returned in this method’s response, the algorithm must meet the following conditions:
|
|
2158
|
+
* 1. The algorithm’s `appId` must match the ID of an installed Wix app.
|
|
2159
|
+
* 2. At least 1 of the IDs in `catalogAppIds` must match the ID of an installed Wix app.
|
|
2160
|
+
*
|
|
2161
|
+
* Wix app IDs are [listed here](https://dev.wix.com/api/rest/getting-started/wix-business-solutions#getting-started_wix-business-solutions_about-wix-business-solutions).
|
|
2162
|
+
*/
|
|
2163
|
+
(): Promise<ListAvailableAlgorithmsResponse & ListAvailableAlgorithmsResponseNonNullableFields>;
|
|
2164
|
+
}
|
|
2165
|
+
declare function getRecommendation$1(httpClient: HttpClient): GetRecommendationSignature;
|
|
2166
|
+
interface GetRecommendationSignature {
|
|
2167
|
+
/**
|
|
2168
|
+
* Returns a recommendation object containing a list of items to recommend to the customer.
|
|
2169
|
+
*
|
|
2170
|
+
* `getRecommendation()` determines which items to recommend based on the given recommendation algorithms.
|
|
2171
|
+
*
|
|
2172
|
+
* `getRecommendation()` doesn’t run the algorithms. It calls the installed apps that provide them.
|
|
2173
|
+
*
|
|
2174
|
+
* Apps may provide algorithms for use with their own catalogs, or for use with catalogs from other apps.
|
|
2175
|
+
* For example, Wix Stores provides algorithms that can only be used on its own catalogs.
|
|
2176
|
+
* To run an algorithm, the app providing it must be installed, and an app providing a supported catalog must be installed.
|
|
2177
|
+
* For more information and to see which algorithms are available on your site or project, call [`listAvailableAlgorithms()`](#listavailablealgorithms).
|
|
2178
|
+
*
|
|
2179
|
+
* `getRecommendation()` operates as follows:
|
|
2180
|
+
* 1. `getRecommendation()` receives as input a list of algorithms as an array. These algorithms can be provided by different apps and can apply to different catalogs.
|
|
2181
|
+
* 2. `getRecommendation()` calls the app that corresponds to the `appId` of the first algorithm in the list of algorithms. It passes that algorithm’s ID and the IDs of any subsequent algorithms in the array for the same app.
|
|
2182
|
+
* 3. The app runs the algorithms.
|
|
2183
|
+
* 4. `getRecommendation()` returns items recommendations from the first algorithm (according to its position in the `algorithms` array) that meets the minimum number of recommendations. At that point `getRecommendation()` stops calling other apps.
|
|
2184
|
+
* 5. If none of the algorithms run by the first app meet the minimum recommended items, `getRecommendation()` finds the next algorithm in the array with a new `appId` (an ID of an app that has not yet been called), and repeats the process.
|
|
2185
|
+
* 6. If no algorithms in the `algorithms` array recommend at least the minimum recommended items, `getRecommendation()` returns an empty array.
|
|
2186
|
+
* @param - A list of algorithms checked in a specific order determined by their `appID` and their position in the `algorithms` array.
|
|
2187
|
+
* See the method description for more information.
|
|
2188
|
+
*
|
|
2189
|
+
* If no algorithm is able to return at least `minimumRecommendedItems` items, an empty array is returned.
|
|
2190
|
+
* @param - Get recommendation options.
|
|
2191
|
+
*/
|
|
2192
|
+
(algorithms: Algorithm[], options?: GetRecommendationOptions | undefined): Promise<GetRecommendationResponse & GetRecommendationResponseNonNullableFields>;
|
|
2193
|
+
}
|
|
2194
|
+
|
|
2195
|
+
declare const listAvailableAlgorithms: MaybeContext<BuildRESTFunction<typeof listAvailableAlgorithms$1> & typeof listAvailableAlgorithms$1>;
|
|
2196
|
+
declare const getRecommendation: MaybeContext<BuildRESTFunction<typeof getRecommendation$1> & typeof getRecommendation$1>;
|
|
2197
|
+
|
|
2198
|
+
type context$o_Algorithm = Algorithm;
|
|
2199
|
+
type context$o_AlgorithmConfig = AlgorithmConfig;
|
|
2200
|
+
type context$o_AlgorithmInfo = AlgorithmInfo;
|
|
2201
|
+
type context$o_AlgorithmType = AlgorithmType;
|
|
2202
|
+
declare const context$o_AlgorithmType: typeof AlgorithmType;
|
|
2203
|
+
type context$o_GetRecommendationOptions = GetRecommendationOptions;
|
|
2204
|
+
type context$o_GetRecommendationRequest = GetRecommendationRequest;
|
|
2205
|
+
type context$o_GetRecommendationResponse = GetRecommendationResponse;
|
|
2206
|
+
type context$o_GetRecommendationResponseNonNullableFields = GetRecommendationResponseNonNullableFields;
|
|
2207
|
+
type context$o_ItemAppIdNotSupportedByProvider = ItemAppIdNotSupportedByProvider;
|
|
2208
|
+
type context$o_ListAvailableAlgorithmsRequest = ListAvailableAlgorithmsRequest;
|
|
2209
|
+
type context$o_ListAvailableAlgorithmsResponse = ListAvailableAlgorithmsResponse;
|
|
2210
|
+
type context$o_ListAvailableAlgorithmsResponseNonNullableFields = ListAvailableAlgorithmsResponseNonNullableFields;
|
|
2211
|
+
type context$o_Recommendation = Recommendation;
|
|
2212
|
+
type context$o_RecommendationAlgorithmNotSupported = RecommendationAlgorithmNotSupported;
|
|
2213
|
+
declare const context$o_getRecommendation: typeof getRecommendation;
|
|
2214
|
+
declare const context$o_listAvailableAlgorithms: typeof listAvailableAlgorithms;
|
|
2215
|
+
declare namespace context$o {
|
|
2216
|
+
export { type context$o_Algorithm as Algorithm, type context$o_AlgorithmConfig as AlgorithmConfig, type context$o_AlgorithmInfo as AlgorithmInfo, context$o_AlgorithmType as AlgorithmType, type CatalogReference$a as CatalogReference, type context$o_GetRecommendationOptions as GetRecommendationOptions, type context$o_GetRecommendationRequest as GetRecommendationRequest, type context$o_GetRecommendationResponse as GetRecommendationResponse, type context$o_GetRecommendationResponseNonNullableFields as GetRecommendationResponseNonNullableFields, type context$o_ItemAppIdNotSupportedByProvider as ItemAppIdNotSupportedByProvider, type context$o_ListAvailableAlgorithmsRequest as ListAvailableAlgorithmsRequest, type context$o_ListAvailableAlgorithmsResponse as ListAvailableAlgorithmsResponse, type context$o_ListAvailableAlgorithmsResponseNonNullableFields as ListAvailableAlgorithmsResponseNonNullableFields, type context$o_Recommendation as Recommendation, type context$o_RecommendationAlgorithmNotSupported as RecommendationAlgorithmNotSupported, context$o_getRecommendation as getRecommendation, context$o_listAvailableAlgorithms as listAvailableAlgorithms };
|
|
2217
|
+
}
|
|
2218
|
+
|
|
2219
|
+
/**
|
|
2220
|
+
* A SubscriptionContract is a ...
|
|
2221
|
+
* You can ...
|
|
2222
|
+
* Read more about SubscriptionContracts
|
|
2223
|
+
* in this [article](<LINK_TO_KB_ARTICLE>).
|
|
2224
|
+
*/
|
|
2225
|
+
interface SubscriptionContract {
|
|
2226
|
+
/**
|
|
2227
|
+
* SubscriptionContract ID.
|
|
2228
|
+
* @readonly
|
|
2229
|
+
*/
|
|
2230
|
+
_id?: string | null;
|
|
2231
|
+
/**
|
|
2232
|
+
* Revision number, which increments by 1 each time the SubscriptionContract is updated.
|
|
2233
|
+
* To prevent conflicting changes, the current revision must be passed when updating the SubscriptionContract.
|
|
2234
|
+
*
|
|
2235
|
+
* Ignored when creating a SubscriptionOrderContract.
|
|
2236
|
+
* @readonly
|
|
2237
|
+
*/
|
|
2238
|
+
revision?: string | null;
|
|
2239
|
+
/**
|
|
2240
|
+
* Date and time the subscription contract was created in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
|
|
2241
|
+
* @readonly
|
|
2242
|
+
*/
|
|
2243
|
+
_createdDate?: Date | null;
|
|
2244
|
+
/**
|
|
2245
|
+
* Date and time the subscription contract was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
|
|
2246
|
+
* @readonly
|
|
2247
|
+
*/
|
|
2248
|
+
_updatedDate?: Date | null;
|
|
2249
|
+
/** Subscription option description. For example, `"1kg of selected coffee, once a month"`. */
|
|
2250
|
+
description?: string | null;
|
|
2251
|
+
/** Subscription detailed information. */
|
|
2252
|
+
subscriptionSettings?: V1SubscriptionSettings$1;
|
|
2253
|
+
/**
|
|
2254
|
+
* Order line items.
|
|
2255
|
+
* @readonly
|
|
2256
|
+
*/
|
|
2257
|
+
lineItems?: OrderLineItem$2[];
|
|
2258
|
+
/** Buyer information. */
|
|
2259
|
+
buyerInfo?: BuyerInfo$9;
|
|
2260
|
+
/**
|
|
2261
|
+
* Language for communication with the buyer. Defaults to the site language.
|
|
2262
|
+
* For a site that supports multiple languages, this is the language the buyer selected.
|
|
2263
|
+
*/
|
|
2264
|
+
buyerLanguage?: string | null;
|
|
2265
|
+
/** Weight measurement unit - defaults to site's weight unit. */
|
|
2266
|
+
weightUnit?: WeightUnit$9;
|
|
2267
|
+
/** Currency used for the pricing of this order in [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes) format. */
|
|
2268
|
+
currency?: string | null;
|
|
2269
|
+
/**
|
|
2270
|
+
* Whether tax is included in line item prices.
|
|
2271
|
+
*
|
|
2272
|
+
* Default: `false`
|
|
2273
|
+
*/
|
|
2274
|
+
taxIncludedInPrices?: boolean;
|
|
2275
|
+
/**
|
|
2276
|
+
* Order price summary.
|
|
2277
|
+
* @readonly
|
|
2278
|
+
*/
|
|
2279
|
+
priceSummary?: PriceSummary$7;
|
|
2280
|
+
/** Billing address and contact details. */
|
|
2281
|
+
billingInfo?: AddressWithContact$6;
|
|
2282
|
+
/** Shipping info and selected shipping option details. */
|
|
2283
|
+
shippingInfo?: ShippingInformation$5;
|
|
2284
|
+
/** Applied discounts. */
|
|
2285
|
+
appliedDiscounts?: AppliedDiscount$7[];
|
|
2286
|
+
/** Information about the sales channel that submitted this order. */
|
|
2287
|
+
channelInfo?: ChannelInfo$4;
|
|
2288
|
+
/** Custom fields. */
|
|
2289
|
+
customFields?: CustomField$5[];
|
|
2290
|
+
/**
|
|
2291
|
+
* Order recipient address and contact details.
|
|
2292
|
+
*
|
|
2293
|
+
* This field may differ from the address in `shippingInfo.logistics` when:
|
|
2294
|
+
* + The chosen shipping option is pickup point or store pickup.
|
|
2295
|
+
* + No shipping option is selected.
|
|
2296
|
+
*/
|
|
2297
|
+
recipientInfo?: AddressWithContact$6;
|
|
2298
|
+
/**
|
|
2299
|
+
* Custom field data for the subscription contract object.
|
|
2300
|
+
*
|
|
2301
|
+
* [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the Wix Dev Center before they can be accessed with API calls.
|
|
2302
|
+
*/
|
|
2303
|
+
extendedFields?: ExtendedFields$a;
|
|
2304
|
+
/** Subscription option title. For example, `"Monthly coffee Subscription"`. */
|
|
2305
|
+
title?: string | null;
|
|
2306
|
+
}
|
|
2307
|
+
interface V1SubscriptionSettings$1 {
|
|
2308
|
+
/** Frequency of recurring payment. */
|
|
2309
|
+
frequency?: SubscriptionFrequency$8;
|
|
2310
|
+
/** Interval of recurring payment. */
|
|
2311
|
+
interval?: number | null;
|
|
2312
|
+
/** Whether subscription is renewed automatically at the end of each period. */
|
|
2313
|
+
autoRenewal?: boolean;
|
|
2314
|
+
/** Number of billing cycles before subscription ends. Ignored if `autoRenewal: true`. */
|
|
2315
|
+
billingCycles?: number | null;
|
|
2316
|
+
/** Whether to allow the customer to cancel the subscription. */
|
|
2317
|
+
enableCustomerCancellation?: boolean;
|
|
2318
|
+
}
|
|
2319
|
+
declare enum SubscriptionFrequency$8 {
|
|
2320
|
+
UNDEFINED = "UNDEFINED",
|
|
2321
|
+
DAY = "DAY",
|
|
2322
|
+
WEEK = "WEEK",
|
|
2323
|
+
MONTH = "MONTH",
|
|
2324
|
+
YEAR = "YEAR"
|
|
2325
|
+
}
|
|
2326
|
+
interface OrderLineItem$2 {
|
|
2327
|
+
/** Line item ID. */
|
|
2328
|
+
_id?: string;
|
|
2329
|
+
/**
|
|
2330
|
+
* Item name.
|
|
2331
|
+
* + Stores - `product.name`
|
|
2332
|
+
* + Bookings - `service.info.name`
|
|
2333
|
+
* + Events - `ticket.name`
|
|
2334
|
+
*/
|
|
2335
|
+
productName?: ProductName$6;
|
|
2336
|
+
/**
|
|
2337
|
+
* References to the line item's origin catalog.
|
|
2338
|
+
* This field may be empty in the case of a custom line item.
|
|
2339
|
+
*/
|
|
2340
|
+
catalogReference?: CatalogReference$9;
|
|
2341
|
+
/** Line item quantity. */
|
|
2342
|
+
quantity?: number;
|
|
2343
|
+
/**
|
|
2344
|
+
* Total discount for this line item's entire quantity.
|
|
2345
|
+
* @readonly
|
|
2346
|
+
*/
|
|
2347
|
+
totalDiscount?: Price$4;
|
|
2348
|
+
/** Line item description lines. Used for display purposes for the cart, checkout and order. */
|
|
2349
|
+
descriptionLines?: DescriptionLine$6[];
|
|
2350
|
+
/** Line item image. */
|
|
2351
|
+
image?: string;
|
|
2352
|
+
/** Physical properties of the item. When relevant, contains information such as SKU and item weight. */
|
|
2353
|
+
physicalProperties?: PhysicalProperties$8;
|
|
2354
|
+
/** Item type. Either a preset type or custom. */
|
|
2355
|
+
itemType?: ItemType$7;
|
|
2356
|
+
/**
|
|
2357
|
+
* Fulfiller ID. Field is empty when the line item is self-fulfilled.
|
|
2358
|
+
* To get fulfillment information, pass the order ID to [List Fulfillments For Single Order](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/order-fulfillments/list-fulfillments-for-single-order).
|
|
2359
|
+
*/
|
|
2360
|
+
fulfillerId?: string | null;
|
|
2361
|
+
/**
|
|
2362
|
+
* Number of items that were refunded.
|
|
2363
|
+
* @readonly
|
|
2364
|
+
*/
|
|
2365
|
+
refundQuantity?: number | null;
|
|
2366
|
+
/**
|
|
2367
|
+
* Number of items restocked.
|
|
2368
|
+
* @readonly
|
|
2369
|
+
*/
|
|
2370
|
+
restockQuantity?: number | null;
|
|
2371
|
+
/** Line item price after line item discounts for display purposes. */
|
|
2372
|
+
price?: Price$4;
|
|
2373
|
+
/**
|
|
2374
|
+
* Line item price before line item discounts for display purposes. Defaults to `price` when not provided.
|
|
2375
|
+
* @readonly
|
|
2376
|
+
*/
|
|
2377
|
+
priceBeforeDiscounts?: Price$4;
|
|
2378
|
+
/**
|
|
2379
|
+
* Total price after discounts, and before tax.
|
|
2380
|
+
* @readonly
|
|
2381
|
+
*/
|
|
2382
|
+
totalPriceBeforeTax?: Price$4;
|
|
2383
|
+
/**
|
|
2384
|
+
* Total price after all discounts and tax.
|
|
2385
|
+
* @readonly
|
|
2386
|
+
*/
|
|
2387
|
+
totalPriceAfterTax?: Price$4;
|
|
2388
|
+
/**
|
|
2389
|
+
* Type of selected payment option for current item. Defaults to `FULL_PAYMENT_ONLINE`.
|
|
2390
|
+
* + `FULL_PAYMENT_ONLINE` - The entire payment for this item happens as part of the checkout.
|
|
2391
|
+
* + `FULL_PAYMENT_OFFLINE` - The entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods.
|
|
2392
|
+
* + `MEMBERSHIP` - Payment for this item is done by charging a membership. When this option is used, `lineItem.price.amount` is 0.
|
|
2393
|
+
* + `DEPOSIT_ONLINE` - Partial payment for the given item to be paid upfront during the checkout. Eligible for catalog items with type `DEPOSIT_ONLINE` only.
|
|
2394
|
+
*/
|
|
2395
|
+
paymentOption?: PaymentOptionType$7;
|
|
2396
|
+
/**
|
|
2397
|
+
* Deprecated. Use `taxInfo` instead.
|
|
2398
|
+
* This field will be removed on September 30, 2024.
|
|
2399
|
+
* Tax details for this line item.
|
|
2400
|
+
* @deprecated Deprecated. Use `taxInfo` instead.
|
|
2401
|
+
* This field will be removed on September 30, 2024.
|
|
2402
|
+
* Tax details for this line item.
|
|
2403
|
+
* @replacedBy tax_info
|
|
2404
|
+
* @targetRemovalDate 2024-09-30
|
|
2405
|
+
*/
|
|
2406
|
+
taxDetails?: ItemTaxFullDetails$7;
|
|
2407
|
+
/** Represents all the relevant tax details for a specific line item. */
|
|
2408
|
+
taxInfo?: LineItemTaxInfo$2;
|
|
2409
|
+
/** Digital file identifier, relevant only for items with type DIGITAL. */
|
|
2410
|
+
digitalFile?: DigitalFile$3;
|
|
2411
|
+
/** Subscription info. */
|
|
2412
|
+
subscriptionInfo?: SubscriptionInfo$3;
|
|
2413
|
+
/** Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - "Starts at $67". */
|
|
2414
|
+
priceDescription?: PriceDescription$6;
|
|
2415
|
+
/**
|
|
2416
|
+
* Item's price amount to be charged during checkout. Relevant for items with a `paymentOption` value of `"DEPOSIT_ONLINE"`.
|
|
2417
|
+
* @readonly
|
|
2418
|
+
*/
|
|
2419
|
+
depositAmount?: Price$4;
|
|
2420
|
+
}
|
|
2421
|
+
interface ProductName$6 {
|
|
2422
|
+
/**
|
|
2423
|
+
* __Required.__ Item name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).
|
|
2424
|
+
*
|
|
2425
|
+
* Min: 1 character.
|
|
2426
|
+
* Max: 200 characters.
|
|
2427
|
+
*/
|
|
2428
|
+
original?: string;
|
|
2429
|
+
/**
|
|
2430
|
+
* Item name translated into the buyer's language.
|
|
2431
|
+
*
|
|
2432
|
+
* Min: 1 character.
|
|
2433
|
+
* Max: 400 characters.
|
|
2434
|
+
* Default: Same as `original`.
|
|
2435
|
+
*/
|
|
2436
|
+
translated?: string | null;
|
|
2437
|
+
}
|
|
2438
|
+
/** Used for grouping line items. Sent when an item is added to a cart, checkout, or order. */
|
|
2439
|
+
interface CatalogReference$9 {
|
|
2440
|
+
/** ID of the item within the catalog it belongs to. */
|
|
2441
|
+
catalogItemId?: string;
|
|
2442
|
+
/**
|
|
2443
|
+
* ID of the app providing the catalog.
|
|
2444
|
+
*
|
|
2445
|
+
* You can get your app's ID from its page in the [Wix Dev Center](https://dev.wix.com/apps).
|
|
2446
|
+
*
|
|
2447
|
+
* For items from Wix catalogs, the following values always apply:
|
|
2448
|
+
* + Wix Stores: `"215238eb-22a5-4c36-9e7b-e7c08025e04e"`
|
|
2449
|
+
* + Wix Bookings: `"13d21c63-b5ec-5912-8397-c3a5ddb27a97"`
|
|
2450
|
+
* + Wix Restaurants: `"9a5d83fd-8570-482e-81ab-cfa88942ee60"`
|
|
2451
|
+
*/
|
|
2452
|
+
appId?: string;
|
|
2453
|
+
/**
|
|
2454
|
+
* Additional item details in key:value pairs. Use this optional field to provide more specificity with item selection. The `options` field values differ depending on which catalog is providing the items.
|
|
2455
|
+
*
|
|
2456
|
+
* For products and variants from a Wix Stores catalog, learn more about [eCommerce integration](https://dev.wix.com/docs/rest/business-solutions/stores/catalog/e-commerce-integration).
|
|
2457
|
+
*/
|
|
2458
|
+
options?: Record<string, any> | null;
|
|
2459
|
+
}
|
|
2460
|
+
interface Price$4 {
|
|
2461
|
+
/** Amount. */
|
|
2462
|
+
amount?: string;
|
|
2463
|
+
/**
|
|
2464
|
+
* Amount formatted with currency symbol.
|
|
2465
|
+
* @readonly
|
|
2466
|
+
*/
|
|
2467
|
+
formattedAmount?: string;
|
|
2468
|
+
}
|
|
2469
|
+
interface DescriptionLine$6 extends DescriptionLineValueOneOf$6, DescriptionLineDescriptionLineValueOneOf$6 {
|
|
2470
|
+
/** Description line plain text value. */
|
|
2471
|
+
plainText?: PlainTextValue$6;
|
|
2472
|
+
/** Description line color value. */
|
|
2473
|
+
colorInfo?: Color$6;
|
|
2474
|
+
/** Description line name. */
|
|
2475
|
+
name?: DescriptionLineName$6;
|
|
2476
|
+
}
|
|
2477
|
+
/** @oneof */
|
|
2478
|
+
interface DescriptionLineValueOneOf$6 {
|
|
2479
|
+
/** Description line plain text value. */
|
|
2480
|
+
plainText?: PlainTextValue$6;
|
|
2481
|
+
/** Description line color value. */
|
|
2482
|
+
colorInfo?: Color$6;
|
|
2483
|
+
}
|
|
2484
|
+
/** @oneof */
|
|
2485
|
+
interface DescriptionLineDescriptionLineValueOneOf$6 {
|
|
2486
|
+
}
|
|
2487
|
+
interface DescriptionLineName$6 {
|
|
2488
|
+
/** Description line name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope). */
|
|
2489
|
+
original?: string;
|
|
2490
|
+
/**
|
|
2491
|
+
* Description line name translated into the buyer's language.
|
|
2492
|
+
*
|
|
2493
|
+
* Default: Same as `original`.
|
|
2494
|
+
*/
|
|
2495
|
+
translated?: string | null;
|
|
2496
|
+
}
|
|
2497
|
+
interface PlainTextValue$6 {
|
|
2498
|
+
/** Description line plain text value in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope). */
|
|
2499
|
+
original?: string;
|
|
2500
|
+
/**
|
|
2501
|
+
* Description line plain text value translated into the buyer's language.
|
|
2502
|
+
*
|
|
2503
|
+
* Default: Same as `original`.
|
|
2504
|
+
*/
|
|
2505
|
+
translated?: string | null;
|
|
2506
|
+
}
|
|
2507
|
+
interface Color$6 {
|
|
2508
|
+
/** Description line color name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope). */
|
|
2509
|
+
original?: string;
|
|
2510
|
+
/**
|
|
2511
|
+
* Description line color name translated into the buyer's language.
|
|
2512
|
+
*
|
|
2513
|
+
* Default: Same as `original`.
|
|
2514
|
+
*/
|
|
2515
|
+
translated?: string | null;
|
|
2516
|
+
/** HEX or RGB color code for display. */
|
|
2517
|
+
code?: string | null;
|
|
2518
|
+
}
|
|
2519
|
+
declare enum DescriptionLineType$6 {
|
|
2520
|
+
UNRECOGNISED = "UNRECOGNISED",
|
|
2521
|
+
PLAIN_TEXT = "PLAIN_TEXT",
|
|
2522
|
+
COLOR = "COLOR"
|
|
2523
|
+
}
|
|
2524
|
+
interface PhysicalProperties$8 {
|
|
2525
|
+
/** Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request. */
|
|
2526
|
+
weight?: number | null;
|
|
2527
|
+
/** Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku). */
|
|
2528
|
+
sku?: string | null;
|
|
2529
|
+
/** Whether this line item is shippable. */
|
|
2530
|
+
shippable?: boolean;
|
|
2531
|
+
}
|
|
2532
|
+
interface ItemType$7 extends ItemTypeItemTypeDataOneOf$7 {
|
|
2533
|
+
/** Preset item type. */
|
|
2534
|
+
preset?: ItemTypeItemType$7;
|
|
2535
|
+
/** Custom item type. When none of the preset types are suitable, specifies the custom type. */
|
|
2536
|
+
custom?: string;
|
|
2537
|
+
}
|
|
2538
|
+
/** @oneof */
|
|
2539
|
+
interface ItemTypeItemTypeDataOneOf$7 {
|
|
2540
|
+
/** Preset item type. */
|
|
2541
|
+
preset?: ItemTypeItemType$7;
|
|
2542
|
+
/** Custom item type. When none of the preset types are suitable, specifies the custom type. */
|
|
2543
|
+
custom?: string;
|
|
2544
|
+
}
|
|
2545
|
+
declare enum ItemTypeItemType$7 {
|
|
2546
|
+
UNRECOGNISED = "UNRECOGNISED",
|
|
2547
|
+
PHYSICAL = "PHYSICAL",
|
|
2548
|
+
DIGITAL = "DIGITAL",
|
|
2549
|
+
GIFT_CARD = "GIFT_CARD",
|
|
2550
|
+
SERVICE = "SERVICE"
|
|
2551
|
+
}
|
|
2552
|
+
/** Type of selected payment option for catalog item */
|
|
2553
|
+
declare enum PaymentOptionType$7 {
|
|
2554
|
+
/** The entire payment for this item happens as part of the checkout. */
|
|
2555
|
+
FULL_PAYMENT_ONLINE = "FULL_PAYMENT_ONLINE",
|
|
2556
|
+
/** The entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods. */
|
|
2557
|
+
FULL_PAYMENT_OFFLINE = "FULL_PAYMENT_OFFLINE",
|
|
2558
|
+
/** Payment for this item is done by charging a membership. When selected, `price` is `0`. */
|
|
2559
|
+
MEMBERSHIP = "MEMBERSHIP",
|
|
2560
|
+
/** Partial payment to be paid upfront during the checkout. Initial amount to be paid for each line item is specified in `depositAmount`. */
|
|
2561
|
+
DEPOSIT_ONLINE = "DEPOSIT_ONLINE",
|
|
2562
|
+
/** Payment for this item can only be done by charging a membership and must be manually redeemed in the dashboard by the site admin. When selected, `price` is `0`. */
|
|
2563
|
+
MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
|
|
2564
|
+
}
|
|
2565
|
+
interface ItemTaxFullDetails$7 {
|
|
2566
|
+
/** Taxable amount of this line item. */
|
|
2567
|
+
taxableAmount?: Price$4;
|
|
2568
|
+
/** Tax rate percentage, as a decimal numeral between 0 and 1. For example, `"0.13"`. */
|
|
2569
|
+
taxRate?: string;
|
|
2570
|
+
/** The calculated tax, based on the `taxableAmount` and `taxRate`. */
|
|
2571
|
+
totalTax?: Price$4;
|
|
2572
|
+
}
|
|
2573
|
+
interface LineItemTaxInfo$2 {
|
|
2574
|
+
/** Calculated tax, based on `taxable_amount` and `tax_rate`. */
|
|
2575
|
+
taxAmount?: Price$4;
|
|
2576
|
+
/** Amount for which tax is calculated. */
|
|
2577
|
+
taxableAmount?: Price$4;
|
|
2578
|
+
/** Tax rate %, as a decimal point. */
|
|
2579
|
+
taxRate?: string | null;
|
|
2580
|
+
/**
|
|
2581
|
+
* Tax group ID.
|
|
2582
|
+
* Learn more about [Tax Groups](https://dev.wix.com/docs/rest/business-management/payments/tax/tax-groups/introduction).
|
|
2583
|
+
*/
|
|
2584
|
+
taxGroupId?: string | null;
|
|
2585
|
+
/** Indicates whether the price already includes tax. */
|
|
2586
|
+
taxIncludedInPrice?: boolean;
|
|
2587
|
+
/** Tax information for a line item. */
|
|
2588
|
+
taxBreakdown?: LineItemTaxBreakdown$2[];
|
|
2589
|
+
}
|
|
2590
|
+
/**
|
|
2591
|
+
* TaxBreakdown represents tax information for a line item.
|
|
2592
|
+
* It holds the tax amount and the tax rate for each tax authority that apply on the line item.
|
|
2593
|
+
*/
|
|
2594
|
+
interface LineItemTaxBreakdown$2 {
|
|
2595
|
+
/** Jurisdiction that taxes were calculated for. For example, "New York", or "Quebec". */
|
|
2596
|
+
jurisdiction?: string | null;
|
|
2597
|
+
/** Tax rate used for this jurisdiction, as a decimal. For example, 10% tax is 0.1000. */
|
|
2598
|
+
rate?: string | null;
|
|
2599
|
+
/** Amount of tax calculated for this line item. */
|
|
2600
|
+
taxAmount?: Price$4;
|
|
2601
|
+
/** The type of tax that was calculated. Depends on the jurisdiction's tax laws. For example, "Sales Tax", "Income Tax", "Value Added Tax", etc. */
|
|
2602
|
+
taxType?: string | null;
|
|
2603
|
+
/**
|
|
2604
|
+
* The name of the tax against which this tax amount was calculated. For example, "NY State Sales Tax", "Quebec GST", etc.
|
|
2605
|
+
* This name should be explicit enough to allow the merchant to understand what tax was calculated.
|
|
2606
|
+
*/
|
|
2607
|
+
taxName?: string | null;
|
|
2608
|
+
/** Type of jurisdiction that taxes were calculated for. */
|
|
2609
|
+
jurisdictionType?: JurisdictionType$7;
|
|
2610
|
+
/** Non-taxable amount of the line item price. */
|
|
2611
|
+
nonTaxableAmount?: Price$4;
|
|
2612
|
+
/** Taxable amount of the line item price. */
|
|
2613
|
+
taxableAmount?: Price$4;
|
|
2614
|
+
}
|
|
2615
|
+
/** JurisdictionType represents the type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
|
|
2616
|
+
declare enum JurisdictionType$7 {
|
|
2617
|
+
UNDEFINED = "UNDEFINED",
|
|
2618
|
+
COUNTRY = "COUNTRY",
|
|
2619
|
+
STATE = "STATE",
|
|
2620
|
+
COUNTY = "COUNTY",
|
|
2621
|
+
CITY = "CITY",
|
|
2622
|
+
SPECIAL = "SPECIAL"
|
|
2623
|
+
}
|
|
2624
|
+
interface DigitalFile$3 {
|
|
2625
|
+
/** ID of the secure file in media. */
|
|
2626
|
+
fileId?: string;
|
|
2627
|
+
/** Link will exist after the digital links have been generated on the order. */
|
|
2628
|
+
link?: string | null;
|
|
2629
|
+
/**
|
|
2630
|
+
* Link expiration time and date.
|
|
2631
|
+
* @readonly
|
|
2632
|
+
*/
|
|
2633
|
+
expirationDate?: Date | null;
|
|
2634
|
+
}
|
|
2635
|
+
interface SubscriptionInfo$3 {
|
|
2636
|
+
/** Subscription ID. */
|
|
2637
|
+
_id?: string | null;
|
|
2638
|
+
/** Subscription cycle. For example, if this order is for the 3rd cycle of a subscription, value will be `3`. */
|
|
2639
|
+
cycleNumber?: number;
|
|
2640
|
+
/** Subscription option title. For example, `"Monthly coffee Subscription"`. */
|
|
2641
|
+
subscriptionOptionTitle?: string;
|
|
2642
|
+
/** Subscription option description. For example, `"1kg of selected coffee, once a month"`. */
|
|
2643
|
+
subscriptionOptionDescription?: string | null;
|
|
2644
|
+
/** Subscription detailed information. */
|
|
2645
|
+
subscriptionSettings?: SubscriptionSettings$8;
|
|
2646
|
+
}
|
|
2647
|
+
interface SubscriptionSettings$8 {
|
|
2648
|
+
/** Frequency of recurring payment. */
|
|
2649
|
+
frequency?: V2SubscriptionFrequency;
|
|
2650
|
+
/** Interval of recurring payment. */
|
|
2651
|
+
interval?: number | null;
|
|
2652
|
+
/** Whether subscription is renewed automatically at the end of each period. */
|
|
2653
|
+
autoRenewal?: boolean;
|
|
2654
|
+
/** Number of billing cycles before subscription ends. Ignored if `autoRenewal: true`. */
|
|
2655
|
+
billingCycles?: number | null;
|
|
2656
|
+
}
|
|
2657
|
+
/** Frequency unit of recurring payment */
|
|
2658
|
+
declare enum V2SubscriptionFrequency {
|
|
2659
|
+
UNDEFINED = "UNDEFINED",
|
|
2660
|
+
DAY = "DAY",
|
|
2661
|
+
WEEK = "WEEK",
|
|
2662
|
+
MONTH = "MONTH",
|
|
2663
|
+
YEAR = "YEAR"
|
|
2664
|
+
}
|
|
2665
|
+
interface PriceDescription$6 {
|
|
2666
|
+
/** __Required.__ Price description in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope). */
|
|
2667
|
+
original?: string;
|
|
2668
|
+
/**
|
|
2669
|
+
* Price description translated into the buyer's language.
|
|
2670
|
+
*
|
|
2671
|
+
* Default: Same as `original`.
|
|
2672
|
+
*/
|
|
2673
|
+
translated?: string | null;
|
|
2674
|
+
}
|
|
2675
|
+
interface LocationAndQuantity$2 {
|
|
2676
|
+
/** Location id in the associated owner app. */
|
|
2677
|
+
_id?: string;
|
|
2678
|
+
/** Location owner app, if not provided then the site business info locations will be used. */
|
|
2679
|
+
appId?: string | null;
|
|
2680
|
+
/** Quantity for specific location. */
|
|
2681
|
+
quantity?: number;
|
|
2682
|
+
}
|
|
2683
|
+
interface TaxableAddress$7 extends TaxableAddressTaxableAddressDataOneOf$7 {
|
|
2684
|
+
/** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
|
|
2685
|
+
addressType?: TaxableAddressType$7;
|
|
2686
|
+
}
|
|
2687
|
+
/** @oneof */
|
|
2688
|
+
interface TaxableAddressTaxableAddressDataOneOf$7 {
|
|
2689
|
+
/** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
|
|
2690
|
+
addressType?: TaxableAddressType$7;
|
|
2691
|
+
}
|
|
2692
|
+
declare enum TaxableAddressType$7 {
|
|
2693
|
+
UNKNOWN_TAXABLE_ADDRESS = "UNKNOWN_TAXABLE_ADDRESS",
|
|
2694
|
+
BUSINESS = "BUSINESS",
|
|
2695
|
+
BILLING = "BILLING",
|
|
2696
|
+
SHIPPING = "SHIPPING"
|
|
2697
|
+
}
|
|
2698
|
+
/** Buyer Info */
|
|
2699
|
+
interface BuyerInfo$9 extends BuyerInfoIdOneOf$6 {
|
|
2700
|
+
/** Visitor ID (if site visitor is not a member). */
|
|
2701
|
+
visitorId?: string;
|
|
2702
|
+
/** Member ID (if site visitor is a site member). */
|
|
2703
|
+
memberId?: string;
|
|
2704
|
+
/** Contact ID. Auto-created if one does not yet exist. For more information, see [Contacts API](https://dev.wix.com/api/rest/contacts/contacts/introduction). */
|
|
2705
|
+
contactId?: string | null;
|
|
2706
|
+
/** Buyer email address. */
|
|
2707
|
+
email?: string | null;
|
|
2708
|
+
}
|
|
2709
|
+
/** @oneof */
|
|
2710
|
+
interface BuyerInfoIdOneOf$6 {
|
|
2711
|
+
/** Visitor ID (if site visitor is not a member). */
|
|
2712
|
+
visitorId?: string;
|
|
2713
|
+
/** Member ID (if site visitor is a site member). */
|
|
2714
|
+
memberId?: string;
|
|
2715
|
+
}
|
|
2716
|
+
declare enum WeightUnit$9 {
|
|
2717
|
+
/** Weight unit can't be classified, due to an error */
|
|
2718
|
+
UNSPECIFIED_WEIGHT_UNIT = "UNSPECIFIED_WEIGHT_UNIT",
|
|
2719
|
+
/** Kilograms */
|
|
2720
|
+
KG = "KG",
|
|
2721
|
+
/** Pounds */
|
|
2722
|
+
LB = "LB"
|
|
2723
|
+
}
|
|
2724
|
+
interface PriceSummary$7 {
|
|
2725
|
+
/** Subtotal of all the line items, before discounts and before tax. */
|
|
2726
|
+
subtotal?: Price$4;
|
|
2727
|
+
/** Total shipping price, before discounts and before tax. */
|
|
2728
|
+
shipping?: Price$4;
|
|
2729
|
+
/** Total tax on this order. */
|
|
2730
|
+
tax?: Price$4;
|
|
2731
|
+
/** Total calculated discount value. */
|
|
2732
|
+
discount?: Price$4;
|
|
2733
|
+
/** Order’s total price after discounts and tax. */
|
|
2734
|
+
total?: Price$4;
|
|
2735
|
+
/** Total price of additional fees before tax. */
|
|
2736
|
+
totalAdditionalFees?: Price$4;
|
|
2737
|
+
}
|
|
2738
|
+
/** Billing Info and shipping details */
|
|
2739
|
+
interface AddressWithContact$6 {
|
|
2740
|
+
/** Address. */
|
|
2741
|
+
address?: Address$b;
|
|
2742
|
+
/** Contact details. */
|
|
2743
|
+
contactDetails?: FullAddressContactDetails$8;
|
|
2744
|
+
}
|
|
2745
|
+
/** Physical address */
|
|
2746
|
+
interface Address$b {
|
|
2747
|
+
/** Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format. */
|
|
2748
|
+
country?: string | null;
|
|
2749
|
+
/** Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://www.iso.org/standard/72483.html) format. */
|
|
2750
|
+
subdivision?: string | null;
|
|
2751
|
+
/** City name. */
|
|
2752
|
+
city?: string | null;
|
|
2753
|
+
/** Postal or zip code. */
|
|
2754
|
+
postalCode?: string | null;
|
|
2755
|
+
/** Street address. */
|
|
2756
|
+
streetAddress?: StreetAddress$a;
|
|
2757
|
+
/** Main address line (usually street name and number). */
|
|
2758
|
+
addressLine1?: string | null;
|
|
2759
|
+
/** Free text providing more detailed address info. Usually contains apt, suite, floor. */
|
|
2760
|
+
addressLine2?: string | null;
|
|
2761
|
+
}
|
|
2762
|
+
interface StreetAddress$a {
|
|
2763
|
+
/** Street number. */
|
|
2764
|
+
number?: string;
|
|
2765
|
+
/** Street name. */
|
|
2766
|
+
name?: string;
|
|
2767
|
+
}
|
|
2768
|
+
interface AddressLocation$a {
|
|
2769
|
+
/** Address latitude. */
|
|
2770
|
+
latitude?: number | null;
|
|
2771
|
+
/** Address longitude. */
|
|
2772
|
+
longitude?: number | null;
|
|
2773
|
+
}
|
|
2774
|
+
/** Full contact details for an address */
|
|
2775
|
+
interface FullAddressContactDetails$8 {
|
|
2776
|
+
/** First name. */
|
|
2777
|
+
firstName?: string | null;
|
|
2778
|
+
/** Last name. */
|
|
2779
|
+
lastName?: string | null;
|
|
2780
|
+
/** Phone number. */
|
|
2781
|
+
phone?: string | null;
|
|
2782
|
+
/** Company name. */
|
|
2783
|
+
company?: string | null;
|
|
2784
|
+
/** Tax information (for Brazil only). If ID is provided, `vatId.type` must also be set, `UNSPECIFIED` is not allowed. */
|
|
2785
|
+
vatId?: VatId$9;
|
|
2786
|
+
}
|
|
2787
|
+
interface VatId$9 {
|
|
2788
|
+
/** Customer's tax ID. */
|
|
2789
|
+
_id?: string;
|
|
2790
|
+
/**
|
|
2791
|
+
* Tax type.
|
|
2792
|
+
*
|
|
2793
|
+
* Supported values:
|
|
2794
|
+
* + `CPF`: for individual tax payers
|
|
2795
|
+
* + `CNPJ`: for corporations
|
|
2796
|
+
*/
|
|
2797
|
+
type?: VatType$9;
|
|
2798
|
+
}
|
|
2799
|
+
/** tax info types */
|
|
2800
|
+
declare enum VatType$9 {
|
|
2801
|
+
UNSPECIFIED = "UNSPECIFIED",
|
|
2802
|
+
/** CPF - for individual tax payers. */
|
|
2803
|
+
CPF = "CPF",
|
|
2804
|
+
/** CNPJ - for corporations */
|
|
2805
|
+
CNPJ = "CNPJ"
|
|
2806
|
+
}
|
|
2807
|
+
interface ShippingInformation$5 {
|
|
2808
|
+
/** App Def Id of external provider which was a source of shipping info */
|
|
2809
|
+
carrierId?: string | null;
|
|
2810
|
+
/** Unique code (or ID) of selected shipping option. For example, `"usps_std_overnight"``. */
|
|
2811
|
+
code?: string | null;
|
|
2812
|
+
/**
|
|
2813
|
+
* Shipping option title.
|
|
2814
|
+
* For example, `"USPS Standard Overnight Delivery"`, `"Standard"` or `"First-Class Package International"`.
|
|
2815
|
+
*/
|
|
2816
|
+
title?: string;
|
|
2817
|
+
/** Shipping logistics. */
|
|
2818
|
+
logistics?: DeliveryLogistics$8;
|
|
2819
|
+
/** Shipping costs. */
|
|
2820
|
+
cost?: ShippingPrice$7;
|
|
2821
|
+
/** Shipping region. */
|
|
2822
|
+
region?: ShippingRegion$7;
|
|
2823
|
+
}
|
|
2824
|
+
interface DeliveryLogistics$8 extends DeliveryLogisticsAddressOneOf$1 {
|
|
2825
|
+
/** Shipping address and contact details. */
|
|
2826
|
+
shippingDestination?: AddressWithContact$6;
|
|
2827
|
+
/** Pickup details. */
|
|
2828
|
+
pickupDetails?: PickupDetails$9;
|
|
2829
|
+
/** Expected delivery time in free text. For example, `"3-5 business days"`. */
|
|
2830
|
+
deliveryTime?: string | null;
|
|
2831
|
+
/** Instructions for carrier. For example, `"Please knock on the door. If unanswered, please call contact number. Thanks."`. */
|
|
2832
|
+
instructions?: string | null;
|
|
2833
|
+
/**
|
|
2834
|
+
* Deprecated - Latest expected delivery date and time in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
|
|
2835
|
+
* @deprecated
|
|
2836
|
+
*/
|
|
2837
|
+
deliverByDate?: Date | null;
|
|
2838
|
+
/** Expected delivery time. */
|
|
2839
|
+
deliveryTimeSlot?: DeliveryTimeSlot$8;
|
|
2840
|
+
}
|
|
2841
|
+
/** @oneof */
|
|
2842
|
+
interface DeliveryLogisticsAddressOneOf$1 {
|
|
2843
|
+
/** Shipping address and contact details. */
|
|
2844
|
+
shippingDestination?: AddressWithContact$6;
|
|
2845
|
+
/** Pickup details. */
|
|
2846
|
+
pickupDetails?: PickupDetails$9;
|
|
2847
|
+
}
|
|
2848
|
+
interface PickupDetails$9 {
|
|
2849
|
+
/** Pickup address. */
|
|
2850
|
+
address?: PickupAddress$4;
|
|
2851
|
+
/** Pickup method */
|
|
2852
|
+
pickupMethod?: PickupMethod$8;
|
|
2853
|
+
}
|
|
2854
|
+
/** Physical address */
|
|
2855
|
+
interface PickupAddress$4 {
|
|
2856
|
+
/** Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format. */
|
|
2857
|
+
country?: string | null;
|
|
2858
|
+
/** Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://www.iso.org/standard/72483.html) format. */
|
|
2859
|
+
subdivision?: string | null;
|
|
2860
|
+
/** City name. */
|
|
2861
|
+
city?: string | null;
|
|
2862
|
+
/** Postal or zip code. */
|
|
2863
|
+
postalCode?: string | null;
|
|
2864
|
+
/** Street address object, with number, name, and apartment number in separate fields. */
|
|
2865
|
+
streetAddress?: StreetAddress$a;
|
|
2866
|
+
/** Main address line (usually street name and number). */
|
|
2867
|
+
addressLine1?: string | null;
|
|
2868
|
+
/** Free text providing more detailed address info. Usually contains apt, suite, floor. */
|
|
2869
|
+
addressLine2?: string | null;
|
|
2870
|
+
}
|
|
2871
|
+
declare enum PickupMethod$8 {
|
|
2872
|
+
UNKNOWN_METHOD = "UNKNOWN_METHOD",
|
|
2873
|
+
STORE_PICKUP = "STORE_PICKUP",
|
|
2874
|
+
PICKUP_POINT = "PICKUP_POINT"
|
|
2875
|
+
}
|
|
2876
|
+
interface DeliveryTimeSlot$8 {
|
|
2877
|
+
/** Delivery slot starting time. */
|
|
2878
|
+
from?: Date | null;
|
|
2879
|
+
/** Delivery slot ending time. */
|
|
2880
|
+
to?: Date | null;
|
|
2881
|
+
}
|
|
2882
|
+
interface ShippingPrice$7 {
|
|
2883
|
+
/** Shipping price for display purposes. */
|
|
2884
|
+
price?: Price$4;
|
|
2885
|
+
/**
|
|
2886
|
+
* Total price of shipping after discounts (when relevant), and before tax.
|
|
2887
|
+
* @readonly
|
|
2888
|
+
*/
|
|
2889
|
+
totalPriceBeforeTax?: Price$4;
|
|
2890
|
+
/**
|
|
2891
|
+
* Shipping price after all discounts (if any exist), and after tax.
|
|
2892
|
+
* @readonly
|
|
2893
|
+
*/
|
|
2894
|
+
totalPriceAfterTax?: Price$4;
|
|
2895
|
+
/** Tax details. */
|
|
2896
|
+
taxDetails?: ItemTaxFullDetails$7;
|
|
2897
|
+
/**
|
|
2898
|
+
* Shipping discount before tax.
|
|
2899
|
+
* @readonly
|
|
2900
|
+
*/
|
|
2901
|
+
discount?: Price$4;
|
|
2902
|
+
}
|
|
2903
|
+
interface ShippingRegion$7 {
|
|
2904
|
+
/** Name of shipping region. For example, `"Metropolitan London"`, or `"Outer Melbourne suburbs"`. */
|
|
2905
|
+
name?: string | null;
|
|
2906
|
+
}
|
|
2907
|
+
interface OrderTaxInfo$2 {
|
|
2908
|
+
/** Calculated tax, added from line items. */
|
|
2909
|
+
totalTax?: Price$4;
|
|
2910
|
+
/** The summary of the tax breakdown for all the line items. It will hold for each tax name, the aggregated tax amount paid for it and the tax rate. */
|
|
2911
|
+
taxBreakdown?: OrderTaxBreakdown$2[];
|
|
2912
|
+
}
|
|
2913
|
+
/**
|
|
2914
|
+
* The summary of the tax breakdown for all the line items. It will hold for each tax name, the aggregated tax amount paid for it and the tax rate.
|
|
2915
|
+
* Tax breakdown is the tax amount split to the tax authorities that applied on the line item.
|
|
2916
|
+
*/
|
|
2917
|
+
interface OrderTaxBreakdown$2 {
|
|
2918
|
+
/** The name of the tax against which this tax amount was calculated. */
|
|
2919
|
+
taxName?: string;
|
|
2920
|
+
/** The type of tax that was calculated. Depends on the company's nexus settings as well as the jurisdiction's tax laws. */
|
|
2921
|
+
taxType?: string;
|
|
2922
|
+
/** The name of the jurisdiction in which this tax detail applies. */
|
|
2923
|
+
jurisdiction?: string;
|
|
2924
|
+
/** The type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
|
|
2925
|
+
jurisdictionType?: JurisdictionType$7;
|
|
2926
|
+
/** The rate at which this tax detail was calculated. */
|
|
2927
|
+
rate?: string;
|
|
2928
|
+
/** The sum of all the tax from line items that calculated by the tax identifiers. */
|
|
2929
|
+
aggregatedTaxAmount?: Price$4;
|
|
2930
|
+
}
|
|
2931
|
+
interface AppliedDiscount$7 extends AppliedDiscountDiscountSourceOneOf$7 {
|
|
2932
|
+
/** Applied coupon info. */
|
|
2933
|
+
coupon?: Coupon$7;
|
|
2934
|
+
/** Merchant discount. */
|
|
2935
|
+
merchantDiscount?: MerchantDiscount$7;
|
|
2936
|
+
/** Automatic Discount */
|
|
2937
|
+
discountRule?: DiscountRule$7;
|
|
2938
|
+
/**
|
|
2939
|
+
* Discount type.
|
|
2940
|
+
* * `"GLOBAL"` - discount applies to entire order.
|
|
2941
|
+
* * `"SPECIFIC-ITEMS"` - discount applies to specific items.
|
|
2942
|
+
* * `"SHIPPING"` - discount applies to shipping. For example, free shipping.
|
|
2943
|
+
*/
|
|
2944
|
+
discountType?: DiscountType$7;
|
|
2945
|
+
/**
|
|
2946
|
+
* IDs of line items discount applies to.
|
|
2947
|
+
* Deprecated. Use `line_item_discounts` instead.
|
|
2948
|
+
* @deprecated IDs of line items discount applies to.
|
|
2949
|
+
* Deprecated. Use `line_item_discounts` instead.
|
|
2950
|
+
* @replacedBy line_item_discounts
|
|
2951
|
+
* @targetRemovalDate 2024-10-30
|
|
2952
|
+
*/
|
|
2953
|
+
lineItemIds?: string[];
|
|
2954
|
+
/** Discount id. */
|
|
2955
|
+
_id?: string | null;
|
|
2956
|
+
}
|
|
2957
|
+
/** @oneof */
|
|
2958
|
+
interface AppliedDiscountDiscountSourceOneOf$7 {
|
|
2959
|
+
/** Applied coupon info. */
|
|
2960
|
+
coupon?: Coupon$7;
|
|
2961
|
+
/** Merchant discount. */
|
|
2962
|
+
merchantDiscount?: MerchantDiscount$7;
|
|
2963
|
+
/** Automatic Discount */
|
|
2964
|
+
discountRule?: DiscountRule$7;
|
|
2965
|
+
}
|
|
2966
|
+
declare enum DiscountType$7 {
|
|
2967
|
+
GLOBAL = "GLOBAL",
|
|
2968
|
+
SPECIFIC_ITEMS = "SPECIFIC_ITEMS",
|
|
2969
|
+
SHIPPING = "SHIPPING"
|
|
2970
|
+
}
|
|
2971
|
+
/** Coupon */
|
|
2972
|
+
interface Coupon$7 {
|
|
2973
|
+
/** Coupon ID. */
|
|
2974
|
+
_id?: string;
|
|
2975
|
+
/** Coupon code. */
|
|
2976
|
+
code?: string;
|
|
2977
|
+
/** Coupon name. */
|
|
2978
|
+
name?: string;
|
|
2979
|
+
/** Coupon value. */
|
|
2980
|
+
amount?: Price$4;
|
|
2981
|
+
}
|
|
2982
|
+
interface MerchantDiscount$7 extends MerchantDiscountMerchantDiscountReasonOneOf$2 {
|
|
2983
|
+
/**
|
|
2984
|
+
* Pre-defined discount reason (optional).
|
|
2985
|
+
* * `"ITEMS_EXCHANGE"` - exchange balance acquired as a result of items exchange.
|
|
2986
|
+
*/
|
|
2987
|
+
discountReason?: DiscountReason$2;
|
|
2988
|
+
/** Discount description as free text (optional). */
|
|
2989
|
+
description?: string | null;
|
|
2990
|
+
/** Discount amount. */
|
|
2991
|
+
amount?: Price$4;
|
|
2992
|
+
}
|
|
2993
|
+
/** @oneof */
|
|
2994
|
+
interface MerchantDiscountMerchantDiscountReasonOneOf$2 {
|
|
2995
|
+
/**
|
|
2996
|
+
* Pre-defined discount reason (optional).
|
|
2997
|
+
* * `"ITEMS_EXCHANGE"` - exchange balance acquired as a result of items exchange.
|
|
2998
|
+
*/
|
|
2999
|
+
discountReason?: DiscountReason$2;
|
|
3000
|
+
/** Discount description as free text (optional). */
|
|
3001
|
+
description?: string | null;
|
|
3002
|
+
}
|
|
3003
|
+
declare enum DiscountReason$2 {
|
|
3004
|
+
UNSPECIFIED = "UNSPECIFIED",
|
|
3005
|
+
EXCHANGED_ITEMS = "EXCHANGED_ITEMS"
|
|
3006
|
+
}
|
|
3007
|
+
interface DiscountRule$7 {
|
|
3008
|
+
/** Discount rule ID */
|
|
3009
|
+
_id?: string;
|
|
3010
|
+
/** Discount rule name */
|
|
3011
|
+
name?: DiscountRuleName$7;
|
|
3012
|
+
/** Discount value. */
|
|
3013
|
+
amount?: Price$4;
|
|
3014
|
+
}
|
|
3015
|
+
interface DiscountRuleName$7 {
|
|
3016
|
+
/** Original discount rule name (in site's default language). */
|
|
3017
|
+
original?: string;
|
|
3018
|
+
/** Translated discount rule name according to buyer language. Defaults to `original` when not provided. */
|
|
3019
|
+
translated?: string | null;
|
|
3020
|
+
}
|
|
3021
|
+
interface LineItemDiscount$7 {
|
|
3022
|
+
/** ID of line item the discount applies to. */
|
|
3023
|
+
_id?: string;
|
|
3024
|
+
/** Total discount for this line item. */
|
|
3025
|
+
totalDiscount?: Price$4;
|
|
3026
|
+
}
|
|
3027
|
+
interface ChannelInfo$4 {
|
|
3028
|
+
/** Sales channel that submitted the order. */
|
|
3029
|
+
type?: ChannelType$7;
|
|
3030
|
+
/** Reference to an order ID from an external system. */
|
|
3031
|
+
externalOrderId?: string | null;
|
|
3032
|
+
/** URL to the order in the external system. */
|
|
3033
|
+
externalOrderUrl?: string | null;
|
|
3034
|
+
}
|
|
3035
|
+
declare enum ChannelType$7 {
|
|
3036
|
+
UNSPECIFIED = "UNSPECIFIED",
|
|
3037
|
+
WEB = "WEB",
|
|
3038
|
+
POS = "POS",
|
|
3039
|
+
EBAY = "EBAY",
|
|
3040
|
+
AMAZON = "AMAZON",
|
|
3041
|
+
OTHER_PLATFORM = "OTHER_PLATFORM",
|
|
3042
|
+
WIX_APP_STORE = "WIX_APP_STORE",
|
|
3043
|
+
WIX_INVOICES = "WIX_INVOICES",
|
|
3044
|
+
BACKOFFICE_MERCHANT = "BACKOFFICE_MERCHANT",
|
|
3045
|
+
WISH = "WISH",
|
|
3046
|
+
CLASS_PASS = "CLASS_PASS",
|
|
3047
|
+
GLOBAL_E = "GLOBAL_E",
|
|
3048
|
+
FACEBOOK = "FACEBOOK",
|
|
3049
|
+
ETSY = "ETSY",
|
|
3050
|
+
TIKTOK = "TIKTOK",
|
|
3051
|
+
FAIRE_COM = "FAIRE_COM"
|
|
3052
|
+
}
|
|
3053
|
+
interface CustomField$5 {
|
|
3054
|
+
/** Custom field value. */
|
|
3055
|
+
value?: any;
|
|
3056
|
+
/** Custom field title. */
|
|
3057
|
+
title?: string;
|
|
3058
|
+
/** Translated custom field title. */
|
|
3059
|
+
translatedTitle?: string | null;
|
|
3060
|
+
}
|
|
3061
|
+
interface ExtendedFields$a {
|
|
3062
|
+
/**
|
|
3063
|
+
* Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
|
|
3064
|
+
* The value of each key is structured according to the schema defined when the extended fields were configured.
|
|
3065
|
+
*
|
|
3066
|
+
* You can only access fields for which you have the appropriate permissions.
|
|
3067
|
+
*
|
|
3068
|
+
* Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
|
|
3069
|
+
*/
|
|
3070
|
+
namespaces?: Record<string, Record<string, any>>;
|
|
3071
|
+
}
|
|
3072
|
+
interface CreateSubscriptionContractRequest {
|
|
3073
|
+
/** SubscriptionContract to be created. */
|
|
3074
|
+
subscriptionContract?: SubscriptionContract;
|
|
3075
|
+
}
|
|
3076
|
+
interface CreateSubscriptionContractResponse {
|
|
3077
|
+
/** The created SubscriptionContract. */
|
|
3078
|
+
subscriptionContract?: SubscriptionContract;
|
|
3079
|
+
}
|
|
3080
|
+
interface GetSubscriptionContractRequest {
|
|
3081
|
+
/** ID of the SubscriptionContract to retrieve. */
|
|
3082
|
+
subscriptionContractId: string;
|
|
3083
|
+
}
|
|
3084
|
+
interface GetSubscriptionContractResponse {
|
|
3085
|
+
/** The requested SubscriptionContract. */
|
|
3086
|
+
subscriptionContract?: SubscriptionContract;
|
|
3087
|
+
}
|
|
3088
|
+
interface UpdateSubscriptionContractRequest {
|
|
3089
|
+
/** SubscriptionContract to be updated, may be partial. */
|
|
3090
|
+
subscriptionContract?: SubscriptionContract;
|
|
3091
|
+
}
|
|
3092
|
+
interface UpdateSubscriptionContractResponse {
|
|
3093
|
+
/** Updated SubscriptionContract. */
|
|
3094
|
+
subscriptionContract?: SubscriptionContract;
|
|
3095
|
+
}
|
|
3096
|
+
interface QuerySubscriptionContractsRequest {
|
|
3097
|
+
/** WQL expression. */
|
|
3098
|
+
query?: CursorQuery$7;
|
|
3099
|
+
}
|
|
3100
|
+
interface CursorQuery$7 extends CursorQueryPagingMethodOneOf$7 {
|
|
3101
|
+
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
|
|
3102
|
+
cursorPaging?: CursorPaging$b;
|
|
3103
|
+
/**
|
|
3104
|
+
* Filter object in the following format:
|
|
3105
|
+
* `"filter" : {
|
|
3106
|
+
* "fieldName1": "value1",
|
|
3107
|
+
* "fieldName2":{"$operator":"value2"}
|
|
3108
|
+
* }`
|
|
3109
|
+
* Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
|
|
3110
|
+
* Learn more about the [filter format](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
|
|
3111
|
+
*/
|
|
3112
|
+
filter?: Record<string, any> | null;
|
|
3113
|
+
/**
|
|
3114
|
+
* Sort object in the following format:
|
|
3115
|
+
* `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
|
|
3116
|
+
* Learn more about the [sort format](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
|
|
3117
|
+
*/
|
|
3118
|
+
sort?: Sorting$b[];
|
|
3119
|
+
}
|
|
3120
|
+
/** @oneof */
|
|
3121
|
+
interface CursorQueryPagingMethodOneOf$7 {
|
|
3122
|
+
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
|
|
3123
|
+
cursorPaging?: CursorPaging$b;
|
|
3124
|
+
}
|
|
3125
|
+
interface Sorting$b {
|
|
3126
|
+
/** Name of the field to sort by. */
|
|
3127
|
+
fieldName?: string;
|
|
3128
|
+
/** Sort order. */
|
|
3129
|
+
order?: SortOrder$b;
|
|
3130
|
+
}
|
|
3131
|
+
declare enum SortOrder$b {
|
|
3132
|
+
ASC = "ASC",
|
|
3133
|
+
DESC = "DESC"
|
|
3134
|
+
}
|
|
3135
|
+
interface CursorPaging$b {
|
|
3136
|
+
/** Maximum number of items to return in the results. */
|
|
3137
|
+
limit?: number | null;
|
|
3138
|
+
/**
|
|
3139
|
+
* Pointer to the next or previous page in the list of results.
|
|
3140
|
+
*
|
|
3141
|
+
* Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
|
|
3142
|
+
* Not relevant for the first request.
|
|
3143
|
+
*/
|
|
3144
|
+
cursor?: string | null;
|
|
3145
|
+
}
|
|
3146
|
+
interface QuerySubscriptionContractsResponse {
|
|
3147
|
+
/** List of SubscriptionContracts. */
|
|
3148
|
+
subscriptionContracts?: SubscriptionContract[];
|
|
3149
|
+
/** Paging metadata */
|
|
3150
|
+
pagingMetadata?: CursorPagingMetadata$9;
|
|
3151
|
+
}
|
|
3152
|
+
interface CursorPagingMetadata$9 {
|
|
3153
|
+
/** Number of items returned in the response. */
|
|
3154
|
+
count?: number | null;
|
|
3155
|
+
/** Cursor strings that point to the next page, previous page, or both. */
|
|
3156
|
+
cursors?: Cursors$b;
|
|
3157
|
+
/**
|
|
3158
|
+
* Whether there are more pages to retrieve following the current page.
|
|
3159
|
+
*
|
|
3160
|
+
* + `true`: Another page of results can be retrieved.
|
|
3161
|
+
* + `false`: This is the last page.
|
|
3162
|
+
*/
|
|
3163
|
+
hasNext?: boolean | null;
|
|
3164
|
+
}
|
|
3165
|
+
interface Cursors$b {
|
|
3166
|
+
/** Cursor string pointing to the next page in the list of results. */
|
|
3167
|
+
next?: string | null;
|
|
3168
|
+
/** Cursor pointing to the previous page in the list of results. */
|
|
3169
|
+
prev?: string | null;
|
|
3170
|
+
}
|
|
3171
|
+
interface DomainEvent$j extends DomainEventBodyOneOf$j {
|
|
3172
|
+
createdEvent?: EntityCreatedEvent$j;
|
|
3173
|
+
updatedEvent?: EntityUpdatedEvent$j;
|
|
3174
|
+
deletedEvent?: EntityDeletedEvent$j;
|
|
3175
|
+
actionEvent?: ActionEvent$j;
|
|
3176
|
+
/**
|
|
3177
|
+
* Unique event ID.
|
|
3178
|
+
* Allows clients to ignore duplicate webhooks.
|
|
3179
|
+
*/
|
|
3180
|
+
_id?: string;
|
|
3181
|
+
/**
|
|
3182
|
+
* Assumes actions are also always typed to an entity_type
|
|
3183
|
+
* Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
|
|
3184
|
+
*/
|
|
3185
|
+
entityFqdn?: string;
|
|
3186
|
+
/**
|
|
3187
|
+
* This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
|
|
3188
|
+
* This is although the created/updated/deleted notion is duplication of the oneof types
|
|
3189
|
+
* Example: created/updated/deleted/started/completed/email_opened
|
|
3190
|
+
*/
|
|
3191
|
+
slug?: string;
|
|
3192
|
+
/** ID of the entity associated with the event. */
|
|
3193
|
+
entityId?: string;
|
|
3194
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
|
|
3195
|
+
eventTime?: Date | null;
|
|
3196
|
+
/**
|
|
3197
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
3198
|
+
* (for example, GDPR).
|
|
3199
|
+
*/
|
|
3200
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
3201
|
+
/** If present, indicates the action that triggered the event. */
|
|
3202
|
+
originatedFrom?: string | null;
|
|
3203
|
+
/**
|
|
3204
|
+
* A sequence number defining the order of updates to the underlying entity.
|
|
3205
|
+
* For example, given that some entity was updated at 16:00 and than again at 16:01,
|
|
3206
|
+
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
3207
|
+
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
3208
|
+
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
3209
|
+
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
3210
|
+
*/
|
|
3211
|
+
entityEventSequence?: string | null;
|
|
3212
|
+
}
|
|
3213
|
+
/** @oneof */
|
|
3214
|
+
interface DomainEventBodyOneOf$j {
|
|
3215
|
+
createdEvent?: EntityCreatedEvent$j;
|
|
3216
|
+
updatedEvent?: EntityUpdatedEvent$j;
|
|
3217
|
+
deletedEvent?: EntityDeletedEvent$j;
|
|
3218
|
+
actionEvent?: ActionEvent$j;
|
|
3219
|
+
}
|
|
3220
|
+
interface EntityCreatedEvent$j {
|
|
3221
|
+
entity?: string;
|
|
3222
|
+
}
|
|
3223
|
+
interface RestoreInfo$j {
|
|
3224
|
+
deletedDate?: Date | null;
|
|
3225
|
+
}
|
|
3226
|
+
interface EntityUpdatedEvent$j {
|
|
3227
|
+
/**
|
|
3228
|
+
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
3229
|
+
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
3230
|
+
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
3231
|
+
*/
|
|
3232
|
+
currentEntity?: string;
|
|
3233
|
+
}
|
|
3234
|
+
interface EntityDeletedEvent$j {
|
|
3235
|
+
/** Entity that was deleted */
|
|
3236
|
+
deletedEntity?: string | null;
|
|
3237
|
+
}
|
|
3238
|
+
interface ActionEvent$j {
|
|
3239
|
+
body?: string;
|
|
3240
|
+
}
|
|
3241
|
+
interface Empty$e {
|
|
3242
|
+
}
|
|
3243
|
+
interface MessageEnvelope$i {
|
|
3244
|
+
/** App instance ID. */
|
|
3245
|
+
instanceId?: string | null;
|
|
3246
|
+
/** Event type. */
|
|
3247
|
+
eventType?: string;
|
|
3248
|
+
/** The identification type and identity data. */
|
|
3249
|
+
identity?: IdentificationData$i;
|
|
3250
|
+
/** Stringify payload. */
|
|
3251
|
+
data?: string;
|
|
3252
|
+
}
|
|
3253
|
+
interface IdentificationData$i extends IdentificationDataIdOneOf$i {
|
|
3254
|
+
/** ID of a site visitor that has not logged in to the site. */
|
|
3255
|
+
anonymousVisitorId?: string;
|
|
3256
|
+
/** ID of a site visitor that has logged in to the site. */
|
|
3257
|
+
memberId?: string;
|
|
3258
|
+
/** ID of a Wix user (site owner, contributor, etc.). */
|
|
3259
|
+
wixUserId?: string;
|
|
3260
|
+
/** ID of an app. */
|
|
3261
|
+
appId?: string;
|
|
3262
|
+
/** @readonly */
|
|
3263
|
+
identityType?: WebhookIdentityType$i;
|
|
3264
|
+
}
|
|
3265
|
+
/** @oneof */
|
|
3266
|
+
interface IdentificationDataIdOneOf$i {
|
|
3267
|
+
/** ID of a site visitor that has not logged in to the site. */
|
|
3268
|
+
anonymousVisitorId?: string;
|
|
3269
|
+
/** ID of a site visitor that has logged in to the site. */
|
|
3270
|
+
memberId?: string;
|
|
3271
|
+
/** ID of a Wix user (site owner, contributor, etc.). */
|
|
3272
|
+
wixUserId?: string;
|
|
3273
|
+
/** ID of an app. */
|
|
3274
|
+
appId?: string;
|
|
3275
|
+
}
|
|
3276
|
+
declare enum WebhookIdentityType$i {
|
|
3277
|
+
UNKNOWN = "UNKNOWN",
|
|
3278
|
+
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
3279
|
+
MEMBER = "MEMBER",
|
|
3280
|
+
WIX_USER = "WIX_USER",
|
|
3281
|
+
APP = "APP"
|
|
3282
|
+
}
|
|
3283
|
+
interface V1SubscriptionSettingsNonNullableFields {
|
|
3284
|
+
frequency: SubscriptionFrequency$8;
|
|
3285
|
+
autoRenewal: boolean;
|
|
3286
|
+
enableCustomerCancellation: boolean;
|
|
3287
|
+
}
|
|
3288
|
+
interface ProductNameNonNullableFields$6 {
|
|
3289
|
+
original: string;
|
|
3290
|
+
}
|
|
3291
|
+
interface CatalogReferenceNonNullableFields$7 {
|
|
3292
|
+
catalogItemId: string;
|
|
3293
|
+
appId: string;
|
|
3294
|
+
}
|
|
3295
|
+
interface PriceNonNullableFields$4 {
|
|
3296
|
+
amount: string;
|
|
3297
|
+
formattedAmount: string;
|
|
3298
|
+
}
|
|
3299
|
+
interface PlainTextValueNonNullableFields$6 {
|
|
3300
|
+
original: string;
|
|
3301
|
+
}
|
|
3302
|
+
interface ColorNonNullableFields$6 {
|
|
3303
|
+
original: string;
|
|
3304
|
+
}
|
|
3305
|
+
interface DescriptionLineNameNonNullableFields$6 {
|
|
3306
|
+
original: string;
|
|
3307
|
+
}
|
|
3308
|
+
interface DescriptionLineNonNullableFields$6 {
|
|
3309
|
+
plainText?: PlainTextValueNonNullableFields$6;
|
|
3310
|
+
colorInfo?: ColorNonNullableFields$6;
|
|
3311
|
+
plainTextValue?: PlainTextValueNonNullableFields$6;
|
|
3312
|
+
color: string;
|
|
3313
|
+
name?: DescriptionLineNameNonNullableFields$6;
|
|
3314
|
+
lineType: DescriptionLineType$6;
|
|
3315
|
+
}
|
|
3316
|
+
interface PhysicalPropertiesNonNullableFields$6 {
|
|
3317
|
+
shippable: boolean;
|
|
3318
|
+
}
|
|
3319
|
+
interface ItemTypeNonNullableFields$6 {
|
|
3320
|
+
preset: ItemTypeItemType$7;
|
|
3321
|
+
custom: string;
|
|
3322
|
+
}
|
|
3323
|
+
interface ItemTaxFullDetailsNonNullableFields$6 {
|
|
3324
|
+
taxableAmount?: PriceNonNullableFields$4;
|
|
3325
|
+
taxRate: string;
|
|
3326
|
+
totalTax?: PriceNonNullableFields$4;
|
|
3327
|
+
}
|
|
3328
|
+
interface LineItemTaxBreakdownNonNullableFields$2 {
|
|
3329
|
+
taxAmount?: PriceNonNullableFields$4;
|
|
3330
|
+
jurisdictionType: JurisdictionType$7;
|
|
3331
|
+
nonTaxableAmount?: PriceNonNullableFields$4;
|
|
3332
|
+
taxableAmount?: PriceNonNullableFields$4;
|
|
3333
|
+
}
|
|
3334
|
+
interface LineItemTaxInfoNonNullableFields$2 {
|
|
3335
|
+
taxAmount?: PriceNonNullableFields$4;
|
|
3336
|
+
taxableAmount?: PriceNonNullableFields$4;
|
|
3337
|
+
taxIncludedInPrice: boolean;
|
|
3338
|
+
taxBreakdown: LineItemTaxBreakdownNonNullableFields$2[];
|
|
3339
|
+
}
|
|
3340
|
+
interface DigitalFileNonNullableFields$2 {
|
|
3341
|
+
fileId: string;
|
|
3342
|
+
}
|
|
3343
|
+
interface SubscriptionSettingsNonNullableFields$6 {
|
|
3344
|
+
frequency: V2SubscriptionFrequency;
|
|
3345
|
+
autoRenewal: boolean;
|
|
3346
|
+
enableCustomerCancellation: boolean;
|
|
3347
|
+
}
|
|
3348
|
+
interface SubscriptionInfoNonNullableFields$2 {
|
|
3349
|
+
cycleNumber: number;
|
|
3350
|
+
subscriptionOptionTitle: string;
|
|
3351
|
+
subscriptionSettings?: SubscriptionSettingsNonNullableFields$6;
|
|
3352
|
+
}
|
|
3353
|
+
interface PriceDescriptionNonNullableFields$6 {
|
|
3354
|
+
original: string;
|
|
3355
|
+
}
|
|
3356
|
+
interface LocationAndQuantityNonNullableFields$2 {
|
|
3357
|
+
_id: string;
|
|
3358
|
+
quantity: number;
|
|
3359
|
+
}
|
|
3360
|
+
interface TaxableAddressNonNullableFields$6 {
|
|
3361
|
+
addressType: TaxableAddressType$7;
|
|
3362
|
+
}
|
|
3363
|
+
interface OrderLineItemNonNullableFields$2 {
|
|
3364
|
+
_id: string;
|
|
3365
|
+
productName?: ProductNameNonNullableFields$6;
|
|
3366
|
+
catalogReference?: CatalogReferenceNonNullableFields$7;
|
|
3367
|
+
quantity: number;
|
|
3368
|
+
totalDiscount?: PriceNonNullableFields$4;
|
|
3369
|
+
descriptionLines: DescriptionLineNonNullableFields$6[];
|
|
3370
|
+
image: string;
|
|
3371
|
+
physicalProperties?: PhysicalPropertiesNonNullableFields$6;
|
|
3372
|
+
itemType?: ItemTypeNonNullableFields$6;
|
|
3373
|
+
price?: PriceNonNullableFields$4;
|
|
3374
|
+
priceBeforeDiscounts?: PriceNonNullableFields$4;
|
|
3375
|
+
totalPriceBeforeTax?: PriceNonNullableFields$4;
|
|
3376
|
+
totalPriceAfterTax?: PriceNonNullableFields$4;
|
|
3377
|
+
paymentOption: PaymentOptionType$7;
|
|
3378
|
+
taxDetails?: ItemTaxFullDetailsNonNullableFields$6;
|
|
3379
|
+
taxInfo?: LineItemTaxInfoNonNullableFields$2;
|
|
3380
|
+
digitalFile?: DigitalFileNonNullableFields$2;
|
|
3381
|
+
subscriptionInfo?: SubscriptionInfoNonNullableFields$2;
|
|
3382
|
+
priceDescription?: PriceDescriptionNonNullableFields$6;
|
|
3383
|
+
depositAmount?: PriceNonNullableFields$4;
|
|
3384
|
+
locations: LocationAndQuantityNonNullableFields$2[];
|
|
3385
|
+
lineItemPrice?: PriceNonNullableFields$4;
|
|
3386
|
+
taxableAddress?: TaxableAddressNonNullableFields$6;
|
|
3387
|
+
priceUndetermined: boolean;
|
|
3388
|
+
fixedQuantity: boolean;
|
|
3389
|
+
}
|
|
3390
|
+
interface BuyerInfoNonNullableFields$5 {
|
|
3391
|
+
visitorId: string;
|
|
3392
|
+
memberId: string;
|
|
3393
|
+
}
|
|
3394
|
+
interface PriceSummaryNonNullableFields$6 {
|
|
3395
|
+
subtotal?: PriceNonNullableFields$4;
|
|
3396
|
+
shipping?: PriceNonNullableFields$4;
|
|
3397
|
+
tax?: PriceNonNullableFields$4;
|
|
3398
|
+
discount?: PriceNonNullableFields$4;
|
|
3399
|
+
totalPrice?: PriceNonNullableFields$4;
|
|
3400
|
+
total?: PriceNonNullableFields$4;
|
|
3401
|
+
totalWithGiftCard?: PriceNonNullableFields$4;
|
|
3402
|
+
totalWithoutGiftCard?: PriceNonNullableFields$4;
|
|
3403
|
+
totalAdditionalFees?: PriceNonNullableFields$4;
|
|
3404
|
+
}
|
|
3405
|
+
interface StreetAddressNonNullableFields$9 {
|
|
3406
|
+
number: string;
|
|
3407
|
+
name: string;
|
|
3408
|
+
apt: string;
|
|
3409
|
+
}
|
|
3410
|
+
interface AddressNonNullableFields$8 {
|
|
3411
|
+
streetAddress?: StreetAddressNonNullableFields$9;
|
|
3412
|
+
}
|
|
3413
|
+
interface VatIdNonNullableFields$5 {
|
|
3414
|
+
_id: string;
|
|
3415
|
+
type: VatType$9;
|
|
3416
|
+
}
|
|
3417
|
+
interface FullAddressContactDetailsNonNullableFields$6 {
|
|
3418
|
+
vatId?: VatIdNonNullableFields$5;
|
|
3419
|
+
}
|
|
3420
|
+
interface AddressWithContactNonNullableFields$5 {
|
|
3421
|
+
address?: AddressNonNullableFields$8;
|
|
3422
|
+
contactDetails?: FullAddressContactDetailsNonNullableFields$6;
|
|
3423
|
+
}
|
|
3424
|
+
interface PickupAddressNonNullableFields$2 {
|
|
3425
|
+
streetAddress?: StreetAddressNonNullableFields$9;
|
|
3426
|
+
}
|
|
3427
|
+
interface PickupDetailsNonNullableFields$7 {
|
|
3428
|
+
address?: PickupAddressNonNullableFields$2;
|
|
3429
|
+
pickupMethod: PickupMethod$8;
|
|
3430
|
+
}
|
|
3431
|
+
interface DeliveryLogisticsNonNullableFields$7 {
|
|
3432
|
+
shippingDestination?: AddressWithContactNonNullableFields$5;
|
|
3433
|
+
pickupDetails?: PickupDetailsNonNullableFields$7;
|
|
3434
|
+
}
|
|
3435
|
+
interface ShippingPriceNonNullableFields$6 {
|
|
3436
|
+
price?: PriceNonNullableFields$4;
|
|
3437
|
+
totalPriceBeforeTax?: PriceNonNullableFields$4;
|
|
3438
|
+
totalPriceAfterTax?: PriceNonNullableFields$4;
|
|
3439
|
+
taxDetails?: ItemTaxFullDetailsNonNullableFields$6;
|
|
3440
|
+
discount?: PriceNonNullableFields$4;
|
|
3441
|
+
}
|
|
3442
|
+
interface ShippingInformationNonNullableFields$5 {
|
|
3443
|
+
title: string;
|
|
3444
|
+
logistics?: DeliveryLogisticsNonNullableFields$7;
|
|
3445
|
+
cost?: ShippingPriceNonNullableFields$6;
|
|
3446
|
+
}
|
|
3447
|
+
interface OrderTaxBreakdownNonNullableFields$2 {
|
|
3448
|
+
taxName: string;
|
|
3449
|
+
taxType: string;
|
|
3450
|
+
jurisdiction: string;
|
|
3451
|
+
jurisdictionType: JurisdictionType$7;
|
|
3452
|
+
rate: string;
|
|
3453
|
+
aggregatedTaxAmount?: PriceNonNullableFields$4;
|
|
3454
|
+
aggregatedTaxableAmount?: PriceNonNullableFields$4;
|
|
3455
|
+
}
|
|
3456
|
+
interface OrderTaxInfoNonNullableFields$2 {
|
|
3457
|
+
totalTax?: PriceNonNullableFields$4;
|
|
3458
|
+
taxBreakdown: OrderTaxBreakdownNonNullableFields$2[];
|
|
3459
|
+
}
|
|
3460
|
+
interface CouponNonNullableFields$6 {
|
|
3461
|
+
_id: string;
|
|
3462
|
+
code: string;
|
|
3463
|
+
name: string;
|
|
3464
|
+
amount?: PriceNonNullableFields$4;
|
|
3465
|
+
}
|
|
3466
|
+
interface MerchantDiscountNonNullableFields$6 {
|
|
3467
|
+
discountReason: DiscountReason$2;
|
|
3468
|
+
amount?: PriceNonNullableFields$4;
|
|
3469
|
+
}
|
|
3470
|
+
interface DiscountRuleNameNonNullableFields$6 {
|
|
3471
|
+
original: string;
|
|
3472
|
+
}
|
|
3473
|
+
interface DiscountRuleNonNullableFields$6 {
|
|
3474
|
+
_id: string;
|
|
3475
|
+
name?: DiscountRuleNameNonNullableFields$6;
|
|
3476
|
+
amount?: PriceNonNullableFields$4;
|
|
3477
|
+
}
|
|
3478
|
+
interface LineItemDiscountNonNullableFields$6 {
|
|
3479
|
+
_id: string;
|
|
3480
|
+
totalDiscount?: PriceNonNullableFields$4;
|
|
3481
|
+
}
|
|
3482
|
+
interface AppliedDiscountNonNullableFields$6 {
|
|
3483
|
+
coupon?: CouponNonNullableFields$6;
|
|
3484
|
+
merchantDiscount?: MerchantDiscountNonNullableFields$6;
|
|
3485
|
+
discountRule?: DiscountRuleNonNullableFields$6;
|
|
3486
|
+
discountType: DiscountType$7;
|
|
3487
|
+
lineItemIds: string[];
|
|
3488
|
+
lineItemDiscounts: LineItemDiscountNonNullableFields$6[];
|
|
3489
|
+
}
|
|
3490
|
+
interface ChannelInfoNonNullableFields$2 {
|
|
3491
|
+
type: ChannelType$7;
|
|
3492
|
+
}
|
|
3493
|
+
interface CustomFieldNonNullableFields$3 {
|
|
3494
|
+
title: string;
|
|
3495
|
+
}
|
|
3496
|
+
interface SubscriptionContractNonNullableFields {
|
|
3497
|
+
subscriptionSettings?: V1SubscriptionSettingsNonNullableFields;
|
|
3498
|
+
lineItems: OrderLineItemNonNullableFields$2[];
|
|
3499
|
+
buyerInfo?: BuyerInfoNonNullableFields$5;
|
|
3500
|
+
weightUnit: WeightUnit$9;
|
|
3501
|
+
taxIncludedInPrices: boolean;
|
|
3502
|
+
priceSummary?: PriceSummaryNonNullableFields$6;
|
|
3503
|
+
billingInfo?: AddressWithContactNonNullableFields$5;
|
|
3504
|
+
shippingInfo?: ShippingInformationNonNullableFields$5;
|
|
3505
|
+
taxInfo?: OrderTaxInfoNonNullableFields$2;
|
|
3506
|
+
appliedDiscounts: AppliedDiscountNonNullableFields$6[];
|
|
3507
|
+
channelInfo?: ChannelInfoNonNullableFields$2;
|
|
3508
|
+
customFields: CustomFieldNonNullableFields$3[];
|
|
3509
|
+
recipientInfo?: AddressWithContactNonNullableFields$5;
|
|
3510
|
+
}
|
|
3511
|
+
interface GetSubscriptionContractResponseNonNullableFields {
|
|
3512
|
+
subscriptionContract?: SubscriptionContractNonNullableFields;
|
|
3513
|
+
}
|
|
3514
|
+
interface QuerySubscriptionContractsResponseNonNullableFields {
|
|
3515
|
+
subscriptionContracts: SubscriptionContractNonNullableFields[];
|
|
3516
|
+
}
|
|
3517
|
+
interface BaseEventMetadata$f {
|
|
3518
|
+
/** App instance ID. */
|
|
3519
|
+
instanceId?: string | null;
|
|
3520
|
+
/** Event type. */
|
|
3521
|
+
eventType?: string;
|
|
3522
|
+
/** The identification type and identity data. */
|
|
3523
|
+
identity?: IdentificationData$i;
|
|
3524
|
+
}
|
|
3525
|
+
interface EventMetadata$f extends BaseEventMetadata$f {
|
|
1829
3526
|
/**
|
|
1830
3527
|
* Unique event ID.
|
|
1831
3528
|
* Allows clients to ignore duplicate webhooks.
|
|
@@ -1863,357 +3560,148 @@ interface DomainEvent$j extends DomainEventBodyOneOf$j {
|
|
|
1863
3560
|
*/
|
|
1864
3561
|
entityEventSequence?: string | null;
|
|
1865
3562
|
}
|
|
1866
|
-
|
|
1867
|
-
|
|
1868
|
-
|
|
1869
|
-
updatedEvent?: EntityUpdatedEvent$j;
|
|
1870
|
-
deletedEvent?: EntityDeletedEvent$j;
|
|
1871
|
-
actionEvent?: ActionEvent$j;
|
|
1872
|
-
}
|
|
1873
|
-
interface EntityCreatedEvent$j {
|
|
1874
|
-
entity?: string;
|
|
1875
|
-
}
|
|
1876
|
-
interface RestoreInfo$j {
|
|
1877
|
-
deletedDate?: Date | null;
|
|
1878
|
-
}
|
|
1879
|
-
interface EntityUpdatedEvent$j {
|
|
1880
|
-
/**
|
|
1881
|
-
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
1882
|
-
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
1883
|
-
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
1884
|
-
*/
|
|
1885
|
-
currentEntity?: string;
|
|
1886
|
-
}
|
|
1887
|
-
interface EntityDeletedEvent$j {
|
|
1888
|
-
/** Entity that was deleted */
|
|
1889
|
-
deletedEntity?: string | null;
|
|
1890
|
-
}
|
|
1891
|
-
interface ActionEvent$j {
|
|
1892
|
-
body?: string;
|
|
1893
|
-
}
|
|
1894
|
-
interface Empty$e {
|
|
1895
|
-
}
|
|
1896
|
-
interface GetOrderInvoiceRequest {
|
|
1897
|
-
/** Invoice ID. */
|
|
1898
|
-
invoiceId?: string;
|
|
1899
|
-
}
|
|
1900
|
-
interface GetOrderInvoiceResponse {
|
|
1901
|
-
/** Order ID. */
|
|
1902
|
-
orderId?: string;
|
|
1903
|
-
/** Invoice info. */
|
|
1904
|
-
invoiceInfo?: Invoice;
|
|
1905
|
-
}
|
|
1906
|
-
interface GenerateInvoiceWithNumberRequest {
|
|
1907
|
-
/** Order ID. */
|
|
1908
|
-
orderId?: string;
|
|
1909
|
-
invoiceNumber?: string;
|
|
1910
|
-
/** Date and time the payment was created in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. Defaults to current time when not provided. */
|
|
1911
|
-
issueDate?: Date | null;
|
|
1912
|
-
}
|
|
1913
|
-
interface GenerateInvoiceWithNumberResponse {
|
|
1914
|
-
/** Invoice ID. */
|
|
1915
|
-
invoiceId?: string;
|
|
1916
|
-
}
|
|
1917
|
-
interface MessageEnvelope$i {
|
|
1918
|
-
/** App instance ID. */
|
|
1919
|
-
instanceId?: string | null;
|
|
1920
|
-
/** Event type. */
|
|
1921
|
-
eventType?: string;
|
|
1922
|
-
/** The identification type and identity data. */
|
|
1923
|
-
identity?: IdentificationData$i;
|
|
1924
|
-
/** Stringify payload. */
|
|
1925
|
-
data?: string;
|
|
1926
|
-
}
|
|
1927
|
-
interface IdentificationData$i extends IdentificationDataIdOneOf$i {
|
|
1928
|
-
/** ID of a site visitor that has not logged in to the site. */
|
|
1929
|
-
anonymousVisitorId?: string;
|
|
1930
|
-
/** ID of a site visitor that has logged in to the site. */
|
|
1931
|
-
memberId?: string;
|
|
1932
|
-
/** ID of a Wix user (site owner, contributor, etc.). */
|
|
1933
|
-
wixUserId?: string;
|
|
1934
|
-
/** ID of an app. */
|
|
1935
|
-
appId?: string;
|
|
1936
|
-
/** @readonly */
|
|
1937
|
-
identityType?: WebhookIdentityType$i;
|
|
1938
|
-
}
|
|
1939
|
-
/** @oneof */
|
|
1940
|
-
interface IdentificationDataIdOneOf$i {
|
|
1941
|
-
/** ID of a site visitor that has not logged in to the site. */
|
|
1942
|
-
anonymousVisitorId?: string;
|
|
1943
|
-
/** ID of a site visitor that has logged in to the site. */
|
|
1944
|
-
memberId?: string;
|
|
1945
|
-
/** ID of a Wix user (site owner, contributor, etc.). */
|
|
1946
|
-
wixUserId?: string;
|
|
1947
|
-
/** ID of an app. */
|
|
1948
|
-
appId?: string;
|
|
1949
|
-
}
|
|
1950
|
-
declare enum WebhookIdentityType$i {
|
|
1951
|
-
UNKNOWN = "UNKNOWN",
|
|
1952
|
-
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
1953
|
-
MEMBER = "MEMBER",
|
|
1954
|
-
WIX_USER = "WIX_USER",
|
|
1955
|
-
APP = "APP"
|
|
1956
|
-
}
|
|
1957
|
-
interface InvoiceNonNullableFields {
|
|
1958
|
-
_id: string;
|
|
1959
|
-
appId: string;
|
|
1960
|
-
}
|
|
1961
|
-
interface InvoicesForOrderNonNullableFields {
|
|
1962
|
-
orderId: string;
|
|
1963
|
-
invoices: InvoiceNonNullableFields[];
|
|
1964
|
-
invoicesInfo: InvoiceNonNullableFields[];
|
|
3563
|
+
interface SubscriptionContractCreatedEnvelope {
|
|
3564
|
+
entity: SubscriptionContract;
|
|
3565
|
+
metadata: EventMetadata$f;
|
|
1965
3566
|
}
|
|
1966
|
-
interface
|
|
1967
|
-
|
|
3567
|
+
interface SubscriptionContractUpdatedEnvelope {
|
|
3568
|
+
entity: SubscriptionContract;
|
|
3569
|
+
metadata: EventMetadata$f;
|
|
1968
3570
|
}
|
|
1969
|
-
|
|
1970
|
-
|
|
1971
|
-
interface ListInvoicesForMultipleOrdersSignature {
|
|
1972
|
-
/**
|
|
1973
|
-
* Retrieves the IDs of invoices associated with all specified orders.
|
|
1974
|
-
*
|
|
1975
|
-
*
|
|
1976
|
-
* The `listInvoicesForSingleOrder()` function returns a Promise that resolves when the specified order's transaction records are retrieved.
|
|
1977
|
-
* @param - Order IDs for which to retrieve invoices.
|
|
1978
|
-
*/
|
|
1979
|
-
(orderIds: string[]): Promise<ListInvoicesForMultipleOrdersResponse$1 & ListInvoicesForMultipleOrdersResponseNonNullableFields>;
|
|
3571
|
+
interface SubscriptionContractDeletedEnvelope {
|
|
3572
|
+
metadata: EventMetadata$f;
|
|
1980
3573
|
}
|
|
1981
|
-
|
|
1982
|
-
|
|
1983
|
-
|
|
1984
|
-
|
|
1985
|
-
|
|
1986
|
-
|
|
1987
|
-
type context$o_GetOrderInvoiceResponse = GetOrderInvoiceResponse;
|
|
1988
|
-
type context$o_Invoice = Invoice;
|
|
1989
|
-
type context$o_ListInvoicesForMultipleOrdersResponseNonNullableFields = ListInvoicesForMultipleOrdersResponseNonNullableFields;
|
|
1990
|
-
declare const context$o_listInvoicesForMultipleOrders: typeof listInvoicesForMultipleOrders;
|
|
1991
|
-
declare namespace context$o {
|
|
1992
|
-
export { type ActionEvent$j as ActionEvent, type AddInvoiceToOrderRequest$1 as AddInvoiceToOrderRequest, type AddInvoiceToOrderResponse$1 as AddInvoiceToOrderResponse, type ApplicationError$c as ApplicationError, type BulkActionMetadata$4 as BulkActionMetadata, type BulkGenerateInvoicesRequest$1 as BulkGenerateInvoicesRequest, type BulkGenerateInvoicesResponse$1 as BulkGenerateInvoicesResponse, type BulkInvoiceResult$1 as BulkInvoiceResult, type DomainEvent$j as DomainEvent, type DomainEventBodyOneOf$j as DomainEventBodyOneOf, type Empty$e as Empty, type EntityCreatedEvent$j as EntityCreatedEvent, type EntityDeletedEvent$j as EntityDeletedEvent, type EntityUpdatedEvent$j as EntityUpdatedEvent, type GenerateInvoiceRequest$1 as GenerateInvoiceRequest, type GenerateInvoiceResponse$1 as GenerateInvoiceResponse, type context$o_GenerateInvoiceWithNumberRequest as GenerateInvoiceWithNumberRequest, type context$o_GenerateInvoiceWithNumberResponse as GenerateInvoiceWithNumberResponse, type context$o_GetOrderInvoiceRequest as GetOrderInvoiceRequest, type context$o_GetOrderInvoiceResponse as GetOrderInvoiceResponse, type IdentificationData$i as IdentificationData, type IdentificationDataIdOneOf$i as IdentificationDataIdOneOf, type context$o_Invoice as Invoice, type InvoiceForOrder$1 as InvoiceForOrder, type InvoicesForOrder$1 as InvoicesForOrder, type ItemMetadata$4 as ItemMetadata, type ListInvoicesForMultipleOrdersRequest$1 as ListInvoicesForMultipleOrdersRequest, type ListInvoicesForMultipleOrdersResponse$1 as ListInvoicesForMultipleOrdersResponse, type context$o_ListInvoicesForMultipleOrdersResponseNonNullableFields as ListInvoicesForMultipleOrdersResponseNonNullableFields, type ListInvoicesForSingleOrderRequest$1 as ListInvoicesForSingleOrderRequest, type ListInvoicesForSingleOrderResponse$1 as ListInvoicesForSingleOrderResponse, type MessageEnvelope$i as MessageEnvelope, type RestoreInfo$j as RestoreInfo, WebhookIdentityType$i as WebhookIdentityType, context$o_listInvoicesForMultipleOrders as listInvoicesForMultipleOrders };
|
|
3574
|
+
interface QueryCursorResult$9 {
|
|
3575
|
+
cursors: Cursors$b;
|
|
3576
|
+
hasNext: () => boolean;
|
|
3577
|
+
hasPrev: () => boolean;
|
|
3578
|
+
length: number;
|
|
3579
|
+
pageSize: number;
|
|
1993
3580
|
}
|
|
1994
|
-
|
|
1995
|
-
|
|
1996
|
-
|
|
1997
|
-
|
|
1998
|
-
|
|
1999
|
-
algorithm?: Algorithm;
|
|
3581
|
+
interface SubscriptionContractsQueryResult extends QueryCursorResult$9 {
|
|
3582
|
+
items: SubscriptionContract[];
|
|
3583
|
+
query: SubscriptionContractsQueryBuilder;
|
|
3584
|
+
next: () => Promise<SubscriptionContractsQueryResult>;
|
|
3585
|
+
prev: () => Promise<SubscriptionContractsQueryResult>;
|
|
2000
3586
|
}
|
|
2001
|
-
|
|
2002
|
-
|
|
2003
|
-
|
|
2004
|
-
|
|
2005
|
-
/**
|
|
2006
|
-
* ID of the app providing the catalog.
|
|
2007
|
-
*
|
|
2008
|
-
* You can get your app's ID from its page in the [Wix Dev Center](https://dev.wix.com/apps).
|
|
2009
|
-
*
|
|
2010
|
-
* For items from Wix catalogs, the following values always apply:
|
|
2011
|
-
* + Wix Stores: `"215238eb-22a5-4c36-9e7b-e7c08025e04e"`
|
|
2012
|
-
* + Wix Bookings: `"13d21c63-b5ec-5912-8397-c3a5ddb27a97"`
|
|
2013
|
-
* + Wix Restaurants: `"9a5d83fd-8570-482e-81ab-cfa88942ee60"`
|
|
2014
|
-
*/
|
|
2015
|
-
appId?: string;
|
|
2016
|
-
/**
|
|
2017
|
-
* Additional item details in key:value pairs. Use this optional field to provide more specificity with item selection. The `options` field values differ depending on which catalog is providing the items.
|
|
2018
|
-
*
|
|
2019
|
-
* For products and variants from a Wix Stores catalog, learn more about [eCommerce integration](https://dev.wix.com/docs/rest/business-solutions/stores/catalog/e-commerce-integration).
|
|
3587
|
+
interface SubscriptionContractsQueryBuilder {
|
|
3588
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
3589
|
+
* @param value - Value to compare against.
|
|
3590
|
+
* @documentationMaturity preview
|
|
2020
3591
|
*/
|
|
2021
|
-
|
|
2022
|
-
|
|
2023
|
-
|
|
2024
|
-
|
|
2025
|
-
_id?: string;
|
|
2026
|
-
/**
|
|
2027
|
-
* App ID of the Wix or 3rd-party app providing the algorithm.
|
|
2028
|
-
*
|
|
2029
|
-
* Wix app IDs are <a href="https://dev.wix.com/api/rest/getting-started/wix-business-solutions#getting-started_wix-business-solutions_about-wix-business-solutions" target="_blank">listed here</a>.
|
|
3592
|
+
eq: (propertyName: '_id' | 'buyerInfo.contactId', value: any) => SubscriptionContractsQueryBuilder;
|
|
3593
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
3594
|
+
* @param value - Value to compare against.
|
|
3595
|
+
* @documentationMaturity preview
|
|
2030
3596
|
*/
|
|
2031
|
-
|
|
2032
|
-
|
|
2033
|
-
|
|
2034
|
-
|
|
2035
|
-
interface ListAvailableAlgorithmsResponse {
|
|
2036
|
-
/** Algorithms available for use on your Wix site or project. See the method description for more information. */
|
|
2037
|
-
availableAlgorithms?: AlgorithmInfo[];
|
|
2038
|
-
}
|
|
2039
|
-
interface AlgorithmInfo {
|
|
2040
|
-
/** How the algorithm is configured. */
|
|
2041
|
-
config?: AlgorithmConfig;
|
|
2042
|
-
/**
|
|
2043
|
-
* The app ID of the application providing the algorithm.
|
|
2044
|
-
*
|
|
2045
|
-
* Wix app IDs are <a href="https://dev.wix.com/api/rest/getting-started/wix-business-solutions#getting-started_wix-business-solutions_about-wix-business-solutions" target="_blank">listed here</a>.
|
|
3597
|
+
ne: (propertyName: '_id' | 'buyerInfo.contactId', value: any) => SubscriptionContractsQueryBuilder;
|
|
3598
|
+
/** @param propertyName - Property whose value is compared with `string`.
|
|
3599
|
+
* @param string - String to compare against. Case-insensitive.
|
|
3600
|
+
* @documentationMaturity preview
|
|
2046
3601
|
*/
|
|
2047
|
-
|
|
2048
|
-
/**
|
|
2049
|
-
*
|
|
2050
|
-
*
|
|
2051
|
-
* Wix app IDs are <a href="https://dev.wix.com/api/rest/getting-started/wix-business-solutions#getting-started_wix-business-solutions_about-wix-business-solutions" target="_blank">listed here</a>.
|
|
3602
|
+
startsWith: (propertyName: '_id' | 'buyerInfo.contactId', value: string) => SubscriptionContractsQueryBuilder;
|
|
3603
|
+
/** @param propertyName - Property whose value is compared with `values`.
|
|
3604
|
+
* @param values - List of values to compare against.
|
|
3605
|
+
* @documentationMaturity preview
|
|
2052
3606
|
*/
|
|
2053
|
-
|
|
2054
|
-
|
|
2055
|
-
|
|
2056
|
-
/**
|
|
2057
|
-
|
|
2058
|
-
/**
|
|
2059
|
-
|
|
2060
|
-
/** A supplemental `description`. It can be used to help break up and organize information. You can, for example, display this information as a tooltip or as an additional section that is collapsed by default. */
|
|
2061
|
-
additionalInfo?: string | null;
|
|
2062
|
-
/**
|
|
2063
|
-
* Algorithms may have the following types:
|
|
2064
|
-
* * `RELATED_ITEMS` - This type of algorithm provides recommendations based on 1 or more other provided items. For example, when an item is added to a cart, the algorithm can suggest other items frequently bought together with that item.
|
|
2065
|
-
* * `GLOBAL` - This type of algorithm provides general recommendations based on site or project statistics. For example, bestsellers or new arrivals.
|
|
3607
|
+
hasSome: (propertyName: '_id' | 'buyerInfo.contactId', value: any[]) => SubscriptionContractsQueryBuilder;
|
|
3608
|
+
/** @documentationMaturity preview */
|
|
3609
|
+
in: (propertyName: '_id' | 'buyerInfo.contactId', value: any) => SubscriptionContractsQueryBuilder;
|
|
3610
|
+
/** @documentationMaturity preview */
|
|
3611
|
+
exists: (propertyName: '_id' | 'buyerInfo.contactId', value: boolean) => SubscriptionContractsQueryBuilder;
|
|
3612
|
+
/** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
|
|
3613
|
+
* @documentationMaturity preview
|
|
2066
3614
|
*/
|
|
2067
|
-
|
|
2068
|
-
/**
|
|
2069
|
-
|
|
2070
|
-
}
|
|
2071
|
-
declare enum AlgorithmType {
|
|
2072
|
-
UNSPECIFIED = "UNSPECIFIED",
|
|
2073
|
-
RELATED_ITEMS = "RELATED_ITEMS",
|
|
2074
|
-
GLOBAL = "GLOBAL"
|
|
2075
|
-
}
|
|
2076
|
-
interface GetRecommendationRequest {
|
|
2077
|
-
/** The set of items for which to get recommendations. Required if the `algorithmType` is `RELATED_ITEMS`. */
|
|
2078
|
-
items?: CatalogReference$9[];
|
|
2079
|
-
/**
|
|
2080
|
-
* A list of algorithms checked in a specific order determined by their `appID` and their position in the `algorithms` array.
|
|
2081
|
-
* See the method description for more information.
|
|
2082
|
-
*
|
|
2083
|
-
* If no algorithm is able to return at least `minimumRecommendedItems` items, an empty array is returned.
|
|
3615
|
+
ascending: (...propertyNames: Array<'_id' | 'buyerInfo.contactId'>) => SubscriptionContractsQueryBuilder;
|
|
3616
|
+
/** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
|
|
3617
|
+
* @documentationMaturity preview
|
|
2084
3618
|
*/
|
|
2085
|
-
|
|
2086
|
-
/**
|
|
2087
|
-
*
|
|
2088
|
-
*
|
|
2089
|
-
* Max: `100`
|
|
3619
|
+
descending: (...propertyNames: Array<'_id' | 'buyerInfo.contactId'>) => SubscriptionContractsQueryBuilder;
|
|
3620
|
+
/** @param limit - Number of items to return, which is also the `pageSize` of the results object.
|
|
3621
|
+
* @documentationMaturity preview
|
|
2090
3622
|
*/
|
|
2091
|
-
|
|
2092
|
-
|
|
2093
|
-
|
|
2094
|
-
/** An object containing a list of items recommended by 1 of the specified algorithms. The recommendation is empty if none of the specified algorithms recommended enough items. */
|
|
2095
|
-
recommendation?: Recommendation;
|
|
2096
|
-
}
|
|
2097
|
-
interface ItemAppIdNotSupportedByProvider {
|
|
2098
|
-
/** Items with an App ID not supported by the provider. Supported App IDs can be found in the provider config in the Dev Center. */
|
|
2099
|
-
items?: CatalogReference$9[];
|
|
2100
|
-
/** Algorithms that don't support the requested items. */
|
|
2101
|
-
algorithms?: Algorithm[];
|
|
2102
|
-
}
|
|
2103
|
-
interface RecommendationAlgorithmNotSupported {
|
|
2104
|
-
/** Algorithms not supported by the provider. */
|
|
2105
|
-
unsupportedAlgorithms?: Algorithm[];
|
|
2106
|
-
}
|
|
2107
|
-
interface AlgorithmConfigNonNullableFields {
|
|
2108
|
-
name: string;
|
|
2109
|
-
description: string;
|
|
2110
|
-
algorithmType: AlgorithmType;
|
|
2111
|
-
algorithmId: string;
|
|
2112
|
-
}
|
|
2113
|
-
interface AlgorithmInfoNonNullableFields {
|
|
2114
|
-
config?: AlgorithmConfigNonNullableFields;
|
|
2115
|
-
appId: string;
|
|
2116
|
-
catalogAppIds: string[];
|
|
2117
|
-
}
|
|
2118
|
-
interface ListAvailableAlgorithmsResponseNonNullableFields {
|
|
2119
|
-
availableAlgorithms: AlgorithmInfoNonNullableFields[];
|
|
2120
|
-
}
|
|
2121
|
-
interface CatalogReferenceNonNullableFields$7 {
|
|
2122
|
-
catalogItemId: string;
|
|
2123
|
-
appId: string;
|
|
2124
|
-
}
|
|
2125
|
-
interface AlgorithmNonNullableFields {
|
|
2126
|
-
_id: string;
|
|
2127
|
-
appId: string;
|
|
2128
|
-
}
|
|
2129
|
-
interface RecommendationNonNullableFields {
|
|
2130
|
-
items: CatalogReferenceNonNullableFields$7[];
|
|
2131
|
-
algorithm?: AlgorithmNonNullableFields;
|
|
2132
|
-
}
|
|
2133
|
-
interface GetRecommendationResponseNonNullableFields {
|
|
2134
|
-
recommendation?: RecommendationNonNullableFields;
|
|
2135
|
-
}
|
|
2136
|
-
interface GetRecommendationOptions {
|
|
2137
|
-
/** The set of items for which to get recommendations. Required if the `algorithmType` is `RELATED_ITEMS`. */
|
|
2138
|
-
items?: CatalogReference$9[];
|
|
2139
|
-
/**
|
|
2140
|
-
* The minimum number of items that must be recommended by the algorithm for those items to be returned in the response.
|
|
2141
|
-
*
|
|
2142
|
-
* Max: `100`
|
|
3623
|
+
limit: (limit: number) => SubscriptionContractsQueryBuilder;
|
|
3624
|
+
/** @param cursor - A pointer to specific record
|
|
3625
|
+
* @documentationMaturity preview
|
|
2143
3626
|
*/
|
|
2144
|
-
|
|
3627
|
+
skipTo: (cursor: string) => SubscriptionContractsQueryBuilder;
|
|
3628
|
+
/** @documentationMaturity preview */
|
|
3629
|
+
find: () => Promise<SubscriptionContractsQueryResult>;
|
|
2145
3630
|
}
|
|
2146
3631
|
|
|
2147
|
-
declare function
|
|
2148
|
-
interface
|
|
3632
|
+
declare function getSubscriptionContract$1(httpClient: HttpClient): GetSubscriptionContractSignature;
|
|
3633
|
+
interface GetSubscriptionContractSignature {
|
|
2149
3634
|
/**
|
|
2150
|
-
*
|
|
2151
|
-
*
|
|
2152
|
-
*
|
|
2153
|
-
*
|
|
2154
|
-
* The app which provides an algorithm is referenced by that algorithm’s `appId`. The apps whose catalogs are supported by an algorithm are referenced by the IDs in that algorithm’s `catalogAppIds` array.
|
|
2155
|
-
*
|
|
2156
|
-
*
|
|
2157
|
-
* For an algorithm to be considered “Available” and returned in this method’s response, the algorithm must meet the following conditions:
|
|
2158
|
-
* 1. The algorithm’s `appId` must match the ID of an installed Wix app.
|
|
2159
|
-
* 2. At least 1 of the IDs in `catalogAppIds` must match the ID of an installed Wix app.
|
|
2160
|
-
*
|
|
2161
|
-
* Wix app IDs are [listed here](https://dev.wix.com/api/rest/getting-started/wix-business-solutions#getting-started_wix-business-solutions_about-wix-business-solutions).
|
|
3635
|
+
* Retrieves a SubscriptionContract.
|
|
3636
|
+
* @param - ID of the SubscriptionContract to retrieve.
|
|
3637
|
+
* @returns The requested SubscriptionContract.
|
|
2162
3638
|
*/
|
|
2163
|
-
(): Promise<
|
|
3639
|
+
(subscriptionContractId: string): Promise<SubscriptionContract & SubscriptionContractNonNullableFields>;
|
|
2164
3640
|
}
|
|
2165
|
-
declare function
|
|
2166
|
-
interface
|
|
3641
|
+
declare function querySubscriptionContracts$1(httpClient: HttpClient): QuerySubscriptionContractsSignature;
|
|
3642
|
+
interface QuerySubscriptionContractsSignature {
|
|
2167
3643
|
/**
|
|
2168
|
-
*
|
|
3644
|
+
* Retrieves a list of SubscriptionContracts, given the provided [paging, filtering, and sorting][1].
|
|
2169
3645
|
*
|
|
2170
|
-
*
|
|
2171
|
-
*
|
|
2172
|
-
* `getRecommendation()` doesn’t run the algorithms. It calls the installed apps that provide them.
|
|
3646
|
+
* Up to 300 SubscriptionContracts can be returned per request.
|
|
2173
3647
|
*
|
|
2174
|
-
*
|
|
2175
|
-
* For example, Wix Stores provides algorithms that can only be used on its own catalogs.
|
|
2176
|
-
* To run an algorithm, the app providing it must be installed, and an app providing a supported catalog must be installed.
|
|
2177
|
-
* For more information and to see which algorithms are available on your site or project, call [`listAvailableAlgorithms()`](#listavailablealgorithms).
|
|
2178
|
-
*
|
|
2179
|
-
* `getRecommendation()` operates as follows:
|
|
2180
|
-
* 1. `getRecommendation()` receives as input a list of algorithms as an array. These algorithms can be provided by different apps and can apply to different catalogs.
|
|
2181
|
-
* 2. `getRecommendation()` calls the app that corresponds to the `appId` of the first algorithm in the list of algorithms. It passes that algorithm’s ID and the IDs of any subsequent algorithms in the array for the same app.
|
|
2182
|
-
* 3. The app runs the algorithms.
|
|
2183
|
-
* 4. `getRecommendation()` returns items recommendations from the first algorithm (according to its position in the `algorithms` array) that meets the minimum number of recommendations. At that point `getRecommendation()` stops calling other apps.
|
|
2184
|
-
* 5. If none of the algorithms run by the first app meet the minimum recommended items, `getRecommendation()` finds the next algorithm in the array with a new `appId` (an ID of an app that has not yet been called), and repeats the process.
|
|
2185
|
-
* 6. If no algorithms in the `algorithms` array recommend at least the minimum recommended items, `getRecommendation()` returns an empty array.
|
|
2186
|
-
* @param - A list of algorithms checked in a specific order determined by their `appID` and their position in the `algorithms` array.
|
|
2187
|
-
* See the method description for more information.
|
|
3648
|
+
* To learn how to query SubscriptionContracts, see [API Query Language][2].
|
|
2188
3649
|
*
|
|
2189
|
-
*
|
|
2190
|
-
*
|
|
3650
|
+
* [1]: https://dev.wix.com/api/rest/getting-started/sorting-and-paging
|
|
3651
|
+
* [2]: https://dev.wix.com/api/rest/getting-started/api-query-language
|
|
2191
3652
|
*/
|
|
2192
|
-
(
|
|
3653
|
+
(): SubscriptionContractsQueryBuilder;
|
|
2193
3654
|
}
|
|
3655
|
+
declare const onSubscriptionContractCreated$1: EventDefinition<SubscriptionContractCreatedEnvelope, "wix.ecom.subscription_contracts.v1.subscription_contract_created">;
|
|
3656
|
+
declare const onSubscriptionContractUpdated$1: EventDefinition<SubscriptionContractUpdatedEnvelope, "wix.ecom.subscription_contracts.v1.subscription_contract_updated">;
|
|
3657
|
+
declare const onSubscriptionContractDeleted$1: EventDefinition<SubscriptionContractDeletedEnvelope, "wix.ecom.subscription_contracts.v1.subscription_contract_deleted">;
|
|
2194
3658
|
|
|
2195
|
-
declare
|
|
2196
|
-
|
|
3659
|
+
declare function createEventModule$f<T extends EventDefinition<any, string>>(eventDefinition: T): BuildEventDefinition<T> & T;
|
|
3660
|
+
|
|
3661
|
+
declare const getSubscriptionContract: MaybeContext<BuildRESTFunction<typeof getSubscriptionContract$1> & typeof getSubscriptionContract$1>;
|
|
3662
|
+
declare const querySubscriptionContracts: MaybeContext<BuildRESTFunction<typeof querySubscriptionContracts$1> & typeof querySubscriptionContracts$1>;
|
|
3663
|
+
|
|
3664
|
+
type _publicOnSubscriptionContractCreatedType = typeof onSubscriptionContractCreated$1;
|
|
3665
|
+
/** */
|
|
3666
|
+
declare const onSubscriptionContractCreated: ReturnType<typeof createEventModule$f<_publicOnSubscriptionContractCreatedType>>;
|
|
3667
|
+
|
|
3668
|
+
type _publicOnSubscriptionContractUpdatedType = typeof onSubscriptionContractUpdated$1;
|
|
3669
|
+
/** */
|
|
3670
|
+
declare const onSubscriptionContractUpdated: ReturnType<typeof createEventModule$f<_publicOnSubscriptionContractUpdatedType>>;
|
|
3671
|
+
|
|
3672
|
+
type _publicOnSubscriptionContractDeletedType = typeof onSubscriptionContractDeleted$1;
|
|
3673
|
+
/** */
|
|
3674
|
+
declare const onSubscriptionContractDeleted: ReturnType<typeof createEventModule$f<_publicOnSubscriptionContractDeletedType>>;
|
|
2197
3675
|
|
|
2198
|
-
type context$
|
|
2199
|
-
type context$
|
|
2200
|
-
type context$
|
|
2201
|
-
type context$
|
|
2202
|
-
|
|
2203
|
-
type context$
|
|
2204
|
-
type context$
|
|
2205
|
-
type context$
|
|
2206
|
-
type context$
|
|
2207
|
-
type context$
|
|
2208
|
-
type context$
|
|
2209
|
-
type context$
|
|
2210
|
-
type context$
|
|
2211
|
-
type context$
|
|
2212
|
-
type context$
|
|
2213
|
-
|
|
2214
|
-
|
|
3676
|
+
type context$n_CreateSubscriptionContractRequest = CreateSubscriptionContractRequest;
|
|
3677
|
+
type context$n_CreateSubscriptionContractResponse = CreateSubscriptionContractResponse;
|
|
3678
|
+
type context$n_GetSubscriptionContractRequest = GetSubscriptionContractRequest;
|
|
3679
|
+
type context$n_GetSubscriptionContractResponse = GetSubscriptionContractResponse;
|
|
3680
|
+
type context$n_GetSubscriptionContractResponseNonNullableFields = GetSubscriptionContractResponseNonNullableFields;
|
|
3681
|
+
type context$n_QuerySubscriptionContractsRequest = QuerySubscriptionContractsRequest;
|
|
3682
|
+
type context$n_QuerySubscriptionContractsResponse = QuerySubscriptionContractsResponse;
|
|
3683
|
+
type context$n_QuerySubscriptionContractsResponseNonNullableFields = QuerySubscriptionContractsResponseNonNullableFields;
|
|
3684
|
+
type context$n_SubscriptionContract = SubscriptionContract;
|
|
3685
|
+
type context$n_SubscriptionContractCreatedEnvelope = SubscriptionContractCreatedEnvelope;
|
|
3686
|
+
type context$n_SubscriptionContractDeletedEnvelope = SubscriptionContractDeletedEnvelope;
|
|
3687
|
+
type context$n_SubscriptionContractNonNullableFields = SubscriptionContractNonNullableFields;
|
|
3688
|
+
type context$n_SubscriptionContractUpdatedEnvelope = SubscriptionContractUpdatedEnvelope;
|
|
3689
|
+
type context$n_SubscriptionContractsQueryBuilder = SubscriptionContractsQueryBuilder;
|
|
3690
|
+
type context$n_SubscriptionContractsQueryResult = SubscriptionContractsQueryResult;
|
|
3691
|
+
type context$n_UpdateSubscriptionContractRequest = UpdateSubscriptionContractRequest;
|
|
3692
|
+
type context$n_UpdateSubscriptionContractResponse = UpdateSubscriptionContractResponse;
|
|
3693
|
+
type context$n_V2SubscriptionFrequency = V2SubscriptionFrequency;
|
|
3694
|
+
declare const context$n_V2SubscriptionFrequency: typeof V2SubscriptionFrequency;
|
|
3695
|
+
type context$n__publicOnSubscriptionContractCreatedType = _publicOnSubscriptionContractCreatedType;
|
|
3696
|
+
type context$n__publicOnSubscriptionContractDeletedType = _publicOnSubscriptionContractDeletedType;
|
|
3697
|
+
type context$n__publicOnSubscriptionContractUpdatedType = _publicOnSubscriptionContractUpdatedType;
|
|
3698
|
+
declare const context$n_getSubscriptionContract: typeof getSubscriptionContract;
|
|
3699
|
+
declare const context$n_onSubscriptionContractCreated: typeof onSubscriptionContractCreated;
|
|
3700
|
+
declare const context$n_onSubscriptionContractDeleted: typeof onSubscriptionContractDeleted;
|
|
3701
|
+
declare const context$n_onSubscriptionContractUpdated: typeof onSubscriptionContractUpdated;
|
|
3702
|
+
declare const context$n_querySubscriptionContracts: typeof querySubscriptionContracts;
|
|
2215
3703
|
declare namespace context$n {
|
|
2216
|
-
export { type context$
|
|
3704
|
+
export { type ActionEvent$j as ActionEvent, type Address$b as Address, type AddressLocation$a as AddressLocation, type AddressWithContact$6 as AddressWithContact, type AppliedDiscount$7 as AppliedDiscount, type AppliedDiscountDiscountSourceOneOf$7 as AppliedDiscountDiscountSourceOneOf, type BaseEventMetadata$f as BaseEventMetadata, type BuyerInfo$9 as BuyerInfo, type BuyerInfoIdOneOf$6 as BuyerInfoIdOneOf, type CatalogReference$9 as CatalogReference, type ChannelInfo$4 as ChannelInfo, ChannelType$7 as ChannelType, type Color$6 as Color, type Coupon$7 as Coupon, type context$n_CreateSubscriptionContractRequest as CreateSubscriptionContractRequest, type context$n_CreateSubscriptionContractResponse as CreateSubscriptionContractResponse, type CursorPaging$b as CursorPaging, type CursorPagingMetadata$9 as CursorPagingMetadata, type CursorQuery$7 as CursorQuery, type CursorQueryPagingMethodOneOf$7 as CursorQueryPagingMethodOneOf, type Cursors$b as Cursors, type CustomField$5 as CustomField, type DeliveryLogistics$8 as DeliveryLogistics, type DeliveryLogisticsAddressOneOf$1 as DeliveryLogisticsAddressOneOf, type DeliveryTimeSlot$8 as DeliveryTimeSlot, type DescriptionLine$6 as DescriptionLine, type DescriptionLineDescriptionLineValueOneOf$6 as DescriptionLineDescriptionLineValueOneOf, type DescriptionLineName$6 as DescriptionLineName, DescriptionLineType$6 as DescriptionLineType, type DescriptionLineValueOneOf$6 as DescriptionLineValueOneOf, type DigitalFile$3 as DigitalFile, DiscountReason$2 as DiscountReason, type DiscountRule$7 as DiscountRule, type DiscountRuleName$7 as DiscountRuleName, DiscountType$7 as DiscountType, type DomainEvent$j as DomainEvent, type DomainEventBodyOneOf$j as DomainEventBodyOneOf, type Empty$e as Empty, type EntityCreatedEvent$j as EntityCreatedEvent, type EntityDeletedEvent$j as EntityDeletedEvent, type EntityUpdatedEvent$j as EntityUpdatedEvent, type EventMetadata$f as EventMetadata, type ExtendedFields$a as ExtendedFields, type FullAddressContactDetails$8 as FullAddressContactDetails, type context$n_GetSubscriptionContractRequest as GetSubscriptionContractRequest, type context$n_GetSubscriptionContractResponse as GetSubscriptionContractResponse, type context$n_GetSubscriptionContractResponseNonNullableFields as GetSubscriptionContractResponseNonNullableFields, type IdentificationData$i as IdentificationData, type IdentificationDataIdOneOf$i as IdentificationDataIdOneOf, type ItemTaxFullDetails$7 as ItemTaxFullDetails, type ItemType$7 as ItemType, ItemTypeItemType$7 as ItemTypeItemType, type ItemTypeItemTypeDataOneOf$7 as ItemTypeItemTypeDataOneOf, JurisdictionType$7 as JurisdictionType, type LineItemDiscount$7 as LineItemDiscount, type LineItemTaxBreakdown$2 as LineItemTaxBreakdown, type LineItemTaxInfo$2 as LineItemTaxInfo, type LocationAndQuantity$2 as LocationAndQuantity, type MerchantDiscount$7 as MerchantDiscount, type MerchantDiscountMerchantDiscountReasonOneOf$2 as MerchantDiscountMerchantDiscountReasonOneOf, type MessageEnvelope$i as MessageEnvelope, type OrderLineItem$2 as OrderLineItem, type OrderTaxBreakdown$2 as OrderTaxBreakdown, type OrderTaxInfo$2 as OrderTaxInfo, PaymentOptionType$7 as PaymentOptionType, type PhysicalProperties$8 as PhysicalProperties, type PickupAddress$4 as PickupAddress, type PickupDetails$9 as PickupDetails, PickupMethod$8 as PickupMethod, type PlainTextValue$6 as PlainTextValue, type Price$4 as Price, type PriceDescription$6 as PriceDescription, type PriceSummary$7 as PriceSummary, type ProductName$6 as ProductName, type context$n_QuerySubscriptionContractsRequest as QuerySubscriptionContractsRequest, type context$n_QuerySubscriptionContractsResponse as QuerySubscriptionContractsResponse, type context$n_QuerySubscriptionContractsResponseNonNullableFields as QuerySubscriptionContractsResponseNonNullableFields, type RestoreInfo$j as RestoreInfo, type ShippingInformation$5 as ShippingInformation, type ShippingPrice$7 as ShippingPrice, type ShippingRegion$7 as ShippingRegion, SortOrder$b as SortOrder, type Sorting$b as Sorting, type StreetAddress$a as StreetAddress, type context$n_SubscriptionContract as SubscriptionContract, type context$n_SubscriptionContractCreatedEnvelope as SubscriptionContractCreatedEnvelope, type context$n_SubscriptionContractDeletedEnvelope as SubscriptionContractDeletedEnvelope, type context$n_SubscriptionContractNonNullableFields as SubscriptionContractNonNullableFields, type context$n_SubscriptionContractUpdatedEnvelope as SubscriptionContractUpdatedEnvelope, type context$n_SubscriptionContractsQueryBuilder as SubscriptionContractsQueryBuilder, type context$n_SubscriptionContractsQueryResult as SubscriptionContractsQueryResult, SubscriptionFrequency$8 as SubscriptionFrequency, type SubscriptionInfo$3 as SubscriptionInfo, type SubscriptionSettings$8 as SubscriptionSettings, type TaxableAddress$7 as TaxableAddress, type TaxableAddressTaxableAddressDataOneOf$7 as TaxableAddressTaxableAddressDataOneOf, TaxableAddressType$7 as TaxableAddressType, type context$n_UpdateSubscriptionContractRequest as UpdateSubscriptionContractRequest, type context$n_UpdateSubscriptionContractResponse as UpdateSubscriptionContractResponse, type V1SubscriptionSettings$1 as V1SubscriptionSettings, context$n_V2SubscriptionFrequency as V2SubscriptionFrequency, type VatId$9 as VatId, VatType$9 as VatType, WebhookIdentityType$i as WebhookIdentityType, WeightUnit$9 as WeightUnit, type context$n__publicOnSubscriptionContractCreatedType as _publicOnSubscriptionContractCreatedType, type context$n__publicOnSubscriptionContractDeletedType as _publicOnSubscriptionContractDeletedType, type context$n__publicOnSubscriptionContractUpdatedType as _publicOnSubscriptionContractUpdatedType, context$n_getSubscriptionContract as getSubscriptionContract, context$n_onSubscriptionContractCreated as onSubscriptionContractCreated, context$n_onSubscriptionContractDeleted as onSubscriptionContractDeleted, context$n_onSubscriptionContractUpdated as onSubscriptionContractUpdated, onSubscriptionContractCreated$1 as publicOnSubscriptionContractCreated, onSubscriptionContractDeleted$1 as publicOnSubscriptionContractDeleted, onSubscriptionContractUpdated$1 as publicOnSubscriptionContractUpdated, context$n_querySubscriptionContracts as querySubscriptionContracts };
|
|
2217
3705
|
}
|
|
2218
3706
|
|
|
2219
3707
|
interface AbandonedCheckout {
|
|
@@ -26666,6 +28154,8 @@ interface OrderLineItemNonNullableFields {
|
|
|
26666
28154
|
locations: LocationAndQuantityNonNullableFields[];
|
|
26667
28155
|
lineItemPrice?: PriceNonNullableFields$2;
|
|
26668
28156
|
taxableAddress?: TaxableAddressNonNullableFields$1;
|
|
28157
|
+
priceUndetermined: boolean;
|
|
28158
|
+
fixedQuantity: boolean;
|
|
26669
28159
|
}
|
|
26670
28160
|
interface BuyerInfoNonNullableFields {
|
|
26671
28161
|
visitorId: string;
|
|
@@ -35592,4 +37082,4 @@ declare namespace context {
|
|
|
35592
37082
|
export { type context_ActionEvent as ActionEvent, type context_AdditionalCharge as AdditionalCharge, type context_Address as Address, type context_AddressLocation as AddressLocation, type context_AddressStreetOneOf as AddressStreetOneOf, type context_ApplicationError as ApplicationError, type context_Breakdown as Breakdown, type context_Carrier as Carrier, type context_CarrierDetails as CarrierDetails, type context_CarrierError as CarrierError, type context_CatalogReference as CatalogReference, context_ChargeType as ChargeType, type context_DeliverableItem as DeliverableItem, type context_DeliveryCarrierError as DeliveryCarrierError, type context_DeliveryCost as DeliveryCost, type context_DeliveryDetails as DeliveryDetails, type context_DeliveryLogistics as DeliveryLogistics, type context_DeliveryOption as DeliveryOption, type context_DeliveryRatesGateway as DeliveryRatesGateway, type context_DeliverySolution as DeliverySolution, type context_DeliveryTimeSlot as DeliveryTimeSlot, type context_Details as Details, type context_DetailsKindOneOf as DetailsKindOneOf, type context_DomainEvent as DomainEvent, type context_DomainEventBodyOneOf as DomainEventBodyOneOf, type context_Empty as Empty, type context_EntityCreatedEvent as EntityCreatedEvent, type context_EntityDeletedEvent as EntityDeletedEvent, type context_EntityUpdatedEvent as EntityUpdatedEvent, type context_FieldViolation as FieldViolation, type context_FullAddressContactDetails as FullAddressContactDetails, type context_GetDeliveryOptionsRequest as GetDeliveryOptionsRequest, type context_GetDeliveryOptionsResponse as GetDeliveryOptionsResponse, type context_GetDeliverySolutionsOptions as GetDeliverySolutionsOptions, type context_GetDeliverySolutionsRequest as GetDeliverySolutionsRequest, type context_GetDeliverySolutionsResponse as GetDeliverySolutionsResponse, type context_GetDeliverySolutionsResponseNonNullableFields as GetDeliverySolutionsResponseNonNullableFields, type Partial$1 as Partial, type context_PartialDeliveryOption as PartialDeliveryOption, type context_PhysicalProperties as PhysicalProperties, type context_PickupDetails as PickupDetails, context_PickupMethod as PickupMethod, type context_ProviderErrors as ProviderErrors, type context_Region as Region, type context_RegionDetails as RegionDetails, type context_RestoreInfo as RestoreInfo, context_RuleType as RuleType, type context_StreetAddress as StreetAddress, type context_Subdivision as Subdivision, context_SubdivisionType as SubdivisionType, type context_SystemError as SystemError, type context_UserIntent as UserIntent, type context_UserPreference as UserPreference, type context_ValidationError as ValidationError, type context_VatId as VatId, context_VatType as VatType, context_WeightUnit as WeightUnit, context_getDeliverySolutions as getDeliverySolutions };
|
|
35593
37083
|
}
|
|
35594
37084
|
|
|
35595
|
-
export { context$m as abandonedCheckouts, context$l as backInStockNotifications, context$k as backInStockSettings, context$j as cart, context$h as checkout, context$
|
|
37085
|
+
export { context$m as abandonedCheckouts, context$l as backInStockNotifications, context$k as backInStockSettings, context$j as cart, context$h as checkout, context$s as checkoutContent, context$g as checkoutSettings, context$f as checkoutTemplates, context$1 as currencies, context$i as currentCart, context$e as deliveryProfile, context as deliverySolutions, context$q as discountRules, context$r as discountsCustomTrigger, context$d as draftOrders, context$b as giftVouchers, context$a as localDeliveryOptions, context$c as orderFulfillments, context$p as orderInvoices, context$8 as orderPaymentRequests, context$7 as orderTransactions, context$9 as orders, context$6 as ordersSettings, context$5 as pickupLocations, context$o as recommendations, context$4 as shippingOptions, context$3 as shippoConfigurations, context$n as subscriptionContracts, context$2 as totalsCalculator };
|