@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.
@@ -88,7 +88,7 @@ interface CheckoutContent {
88
88
  placeOrderPayButton?: string | null;
89
89
  }
90
90
 
91
- type __PublicMethodMetaInfo$r<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
91
+ type __PublicMethodMetaInfo$s<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
92
92
  getUrl: (context: any) => string;
93
93
  httpMethod: K;
94
94
  path: string;
@@ -98,14 +98,14 @@ type __PublicMethodMetaInfo$r<K = string, M = unknown, T = unknown, S = unknown,
98
98
  __responseType: Q;
99
99
  __originalResponseType: R;
100
100
  };
101
- declare function getCheckoutContent(): __PublicMethodMetaInfo$r<'GET', {
101
+ declare function getCheckoutContent(): __PublicMethodMetaInfo$s<'GET', {
102
102
  appId: string;
103
103
  componentId: string;
104
104
  }, GetCheckoutContentRequest, GetCheckoutContentRequest$1, GetCheckoutContentResponse, GetCheckoutContentResponse$1>;
105
105
 
106
- declare const meta$r_getCheckoutContent: typeof getCheckoutContent;
107
- declare namespace meta$r {
108
- export { type __PublicMethodMetaInfo$r as __PublicMethodMetaInfo, meta$r_getCheckoutContent as getCheckoutContent };
106
+ declare const meta$s_getCheckoutContent: typeof getCheckoutContent;
107
+ declare namespace meta$s {
108
+ export { type __PublicMethodMetaInfo$s as __PublicMethodMetaInfo, meta$s_getCheckoutContent as getCheckoutContent };
109
109
  }
110
110
 
111
111
  interface ListTriggersRequest$1 {
@@ -154,7 +154,7 @@ interface ListTriggersResponseNonNullableFields {
154
154
  triggers: ListTriggersResponseCustomTriggerNonNullableFields[];
155
155
  }
156
156
 
157
- type __PublicMethodMetaInfo$q<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
157
+ type __PublicMethodMetaInfo$r<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
158
158
  getUrl: (context: any) => string;
159
159
  httpMethod: K;
160
160
  path: string;
@@ -164,14 +164,14 @@ type __PublicMethodMetaInfo$q<K = string, M = unknown, T = unknown, S = unknown,
164
164
  __responseType: Q;
165
165
  __originalResponseType: R;
166
166
  };
167
- declare function listTriggers(): __PublicMethodMetaInfo$q<'POST', {}, ListTriggersRequest, ListTriggersRequest$1, ListTriggersResponse & ListTriggersResponseNonNullableFields, ListTriggersResponse$1 & ListTriggersResponseNonNullableFields$1>;
167
+ declare function listTriggers(): __PublicMethodMetaInfo$r<'POST', {}, ListTriggersRequest, ListTriggersRequest$1, ListTriggersResponse & ListTriggersResponseNonNullableFields, ListTriggersResponse$1 & ListTriggersResponseNonNullableFields$1>;
168
168
 
169
- declare const meta$q_listTriggers: typeof listTriggers;
170
- declare namespace meta$q {
171
- export { type __PublicMethodMetaInfo$q as __PublicMethodMetaInfo, meta$q_listTriggers as listTriggers };
169
+ declare const meta$r_listTriggers: typeof listTriggers;
170
+ declare namespace meta$r {
171
+ export { type __PublicMethodMetaInfo$r as __PublicMethodMetaInfo, meta$r_listTriggers as listTriggers };
172
172
  }
173
173
 
174
- interface DiscountRule$d {
174
+ interface DiscountRule$f {
175
175
  /**
176
176
  * Discount rule ID.
177
177
  * @readonly
@@ -386,7 +386,7 @@ interface Discount$1 extends DiscountDiscountOneOf$1 {
386
386
  * + `FIXED_AMOUNT`: Price is reduced by fixed amount.
387
387
  * + `FIXED_PRICE`: Price will be set to fixed amount.
388
388
  */
389
- discountType?: DiscountType$d;
389
+ discountType?: DiscountType$f;
390
390
  }
391
391
  /** @oneof */
392
392
  interface DiscountDiscountOneOf$1 {
@@ -407,7 +407,7 @@ interface SpecificItemsInfo$1 {
407
407
  /** All associated scopes for `SPECIFIC_ITEMS` target type. */
408
408
  scopes?: Scope$1[];
409
409
  }
410
- declare enum DiscountType$d {
410
+ declare enum DiscountType$f {
411
411
  UNDEFINED = "UNDEFINED",
412
412
  /** Percentage discount */
413
413
  PERCENTAGE = "PERCENTAGE",
@@ -436,11 +436,11 @@ declare enum AppliedSubjectType$1 {
436
436
  }
437
437
  interface CreateDiscountRuleRequest$1 {
438
438
  /** Discount rule info. */
439
- discountRule: DiscountRule$d;
439
+ discountRule: DiscountRule$f;
440
440
  }
441
441
  interface CreateDiscountRuleResponse$1 {
442
442
  /** Discount rule. */
443
- discountRule?: DiscountRule$d;
443
+ discountRule?: DiscountRule$f;
444
444
  }
445
445
  interface GetDiscountRuleRequest$1 {
446
446
  /** ID of the discount rule to retrieve. */
@@ -448,15 +448,15 @@ interface GetDiscountRuleRequest$1 {
448
448
  }
449
449
  interface GetDiscountRuleResponse$1 {
450
450
  /** The requested discount rule. */
451
- discountRule?: DiscountRule$d;
451
+ discountRule?: DiscountRule$f;
452
452
  }
453
453
  interface UpdateDiscountRuleRequest$1 {
454
454
  /** Discount rule info. */
455
- discountRule: DiscountRule$d;
455
+ discountRule: DiscountRule$f;
456
456
  }
457
457
  interface UpdateDiscountRuleResponse$1 {
458
458
  /** Updated discount rule. */
459
- discountRule?: DiscountRule$d;
459
+ discountRule?: DiscountRule$f;
460
460
  }
461
461
  interface DeleteDiscountRuleRequest$1 {
462
462
  /** ID of the discount rule to delete. */
@@ -472,26 +472,26 @@ interface PlatformQuery$3 extends PlatformQueryPagingMethodOneOf$3 {
472
472
  /** Pointer to page of results using offset. Cannot be used together with `cursorPaging`. */
473
473
  paging?: PlatformPaging$3;
474
474
  /** Cursor pointing to page of results. Cannot be used together with `paging`. `cursorPaging.cursor` can not be used together with `filter` or `sort`. */
475
- cursorPaging?: CursorPaging$l;
475
+ cursorPaging?: CursorPaging$n;
476
476
  /** Filter object. */
477
477
  filter?: Record<string, any> | null;
478
478
  /** Sorting options. For example, `[{"fieldName":"sortField1"},{"fieldName":"sortField2","direction":"DESC"}]`. */
479
- sort?: Sorting$l[];
479
+ sort?: Sorting$n[];
480
480
  }
481
481
  /** @oneof */
482
482
  interface PlatformQueryPagingMethodOneOf$3 {
483
483
  /** Pointer to page of results using offset. Cannot be used together with `cursorPaging`. */
484
484
  paging?: PlatformPaging$3;
485
485
  /** Cursor pointing to page of results. Cannot be used together with `paging`. `cursorPaging.cursor` can not be used together with `filter` or `sort`. */
486
- cursorPaging?: CursorPaging$l;
486
+ cursorPaging?: CursorPaging$n;
487
487
  }
488
- interface Sorting$l {
488
+ interface Sorting$n {
489
489
  /** Name of the field to sort by. */
490
490
  fieldName?: string;
491
491
  /** Sort order. */
492
- order?: SortOrder$l;
492
+ order?: SortOrder$n;
493
493
  }
494
- declare enum SortOrder$l {
494
+ declare enum SortOrder$n {
495
495
  ASC = "ASC",
496
496
  DESC = "DESC"
497
497
  }
@@ -501,7 +501,7 @@ interface PlatformPaging$3 {
501
501
  /** Number of items to skip in the current sort order. */
502
502
  offset?: number | null;
503
503
  }
504
- interface CursorPaging$l {
504
+ interface CursorPaging$n {
505
505
  /** Maximum number of items to return in the results. */
506
506
  limit?: number | null;
507
507
  /**
@@ -514,7 +514,7 @@ interface CursorPaging$l {
514
514
  }
515
515
  interface QueryDiscountRulesResponse$1 {
516
516
  /** List of discount rules. */
517
- discountRules?: DiscountRule$d[];
517
+ discountRules?: DiscountRule$f[];
518
518
  /** Details on the paged set of results returned. */
519
519
  pagingMetadata?: PlatformPagingMetadata$3;
520
520
  }
@@ -526,9 +526,9 @@ interface PlatformPagingMetadata$3 {
526
526
  /** The total number of items that match the query. Returned if offset paging was used. */
527
527
  total?: number | null;
528
528
  /** Cursors to navigate through result pages. Returned if cursor paging was used. */
529
- cursors?: Cursors$l;
529
+ cursors?: Cursors$n;
530
530
  }
531
- interface Cursors$l {
531
+ interface Cursors$n {
532
532
  /** Cursor string pointing to the next page in the list of results. */
533
533
  next?: string | null;
534
534
  /** Cursor pointing to the previous page in the list of results. */
@@ -592,7 +592,7 @@ interface DiscountNonNullableFields$1 {
592
592
  fixedPrice: string;
593
593
  targetType: Type$1;
594
594
  specificItemsInfo?: SpecificItemsInfoNonNullableFields$1;
595
- discountType: DiscountType$d;
595
+ discountType: DiscountType$f;
596
596
  buyXGetYInfo?: BuyXGetYInfoNonNullableFields$1;
597
597
  }
598
598
  interface DiscountsNonNullableFields$1 {
@@ -601,7 +601,7 @@ interface DiscountsNonNullableFields$1 {
601
601
  interface DiscountSettingsNonNullableFields$1 {
602
602
  appliesTo: AppliedSubjectType$1;
603
603
  }
604
- interface DiscountRuleNonNullableFields$d {
604
+ interface DiscountRuleNonNullableFields$f {
605
605
  trigger?: DiscountTriggerNonNullableFields$1;
606
606
  discounts?: DiscountsNonNullableFields$1;
607
607
  status: Status$b;
@@ -609,19 +609,19 @@ interface DiscountRuleNonNullableFields$d {
609
609
  settings?: DiscountSettingsNonNullableFields$1;
610
610
  }
611
611
  interface CreateDiscountRuleResponseNonNullableFields$1 {
612
- discountRule?: DiscountRuleNonNullableFields$d;
612
+ discountRule?: DiscountRuleNonNullableFields$f;
613
613
  }
614
614
  interface GetDiscountRuleResponseNonNullableFields$1 {
615
- discountRule?: DiscountRuleNonNullableFields$d;
615
+ discountRule?: DiscountRuleNonNullableFields$f;
616
616
  }
617
617
  interface UpdateDiscountRuleResponseNonNullableFields$1 {
618
- discountRule?: DiscountRuleNonNullableFields$d;
618
+ discountRule?: DiscountRuleNonNullableFields$f;
619
619
  }
620
620
  interface QueryDiscountRulesResponseNonNullableFields$1 {
621
- discountRules: DiscountRuleNonNullableFields$d[];
621
+ discountRules: DiscountRuleNonNullableFields$f[];
622
622
  }
623
623
 
624
- interface DiscountRule$c {
624
+ interface DiscountRule$e {
625
625
  /**
626
626
  * Discount rule ID.
627
627
  * @readonly
@@ -836,7 +836,7 @@ interface Discount extends DiscountDiscountOneOf {
836
836
  * + `"FIXED_AMOUNT"`: Price is reduced by fixed amount.
837
837
  * + `"FIXED_PRICE"`: Price will be set to fixed amount.
838
838
  */
839
- discountType?: DiscountType$c;
839
+ discountType?: DiscountType$e;
840
840
  }
841
841
  /** @oneof */
842
842
  interface DiscountDiscountOneOf {
@@ -857,7 +857,7 @@ interface SpecificItemsInfo {
857
857
  /** All associated scopes for `"SPECIFIC_ITEMS"` target type. */
858
858
  scopes?: Scope[];
859
859
  }
860
- declare enum DiscountType$c {
860
+ declare enum DiscountType$e {
861
861
  UNDEFINED = "UNDEFINED",
862
862
  /** Percentage discount */
863
863
  PERCENTAGE = "PERCENTAGE",
@@ -886,11 +886,11 @@ declare enum AppliedSubjectType {
886
886
  }
887
887
  interface CreateDiscountRuleRequest {
888
888
  /** Discount rule info. */
889
- discountRule: DiscountRule$c;
889
+ discountRule: DiscountRule$e;
890
890
  }
891
891
  interface CreateDiscountRuleResponse {
892
892
  /** Discount rule. */
893
- discountRule?: DiscountRule$c;
893
+ discountRule?: DiscountRule$e;
894
894
  }
895
895
  interface GetDiscountRuleRequest {
896
896
  /** ID of the discount rule to retrieve. */
@@ -898,15 +898,15 @@ interface GetDiscountRuleRequest {
898
898
  }
899
899
  interface GetDiscountRuleResponse {
900
900
  /** The requested discount rule. */
901
- discountRule?: DiscountRule$c;
901
+ discountRule?: DiscountRule$e;
902
902
  }
903
903
  interface UpdateDiscountRuleRequest {
904
904
  /** Discount rule info. */
905
- discountRule: DiscountRule$c;
905
+ discountRule: DiscountRule$e;
906
906
  }
907
907
  interface UpdateDiscountRuleResponse {
908
908
  /** Updated discount rule. */
909
- discountRule?: DiscountRule$c;
909
+ discountRule?: DiscountRule$e;
910
910
  }
911
911
  interface DeleteDiscountRuleRequest {
912
912
  /** ID of the discount rule to delete. */
@@ -922,26 +922,26 @@ interface PlatformQuery$2 extends PlatformQueryPagingMethodOneOf$2 {
922
922
  /** Pointer to page of results using offset. Cannot be used together with `cursorPaging`. */
923
923
  paging?: PlatformPaging$2;
924
924
  /** Cursor pointing to page of results. Cannot be used together with `paging`. `cursorPaging.cursor` can not be used together with `filter` or `sort`. */
925
- cursorPaging?: CursorPaging$k;
925
+ cursorPaging?: CursorPaging$m;
926
926
  /** Filter object. */
927
927
  filter?: Record<string, any> | null;
928
928
  /** Sorting options. For example, `[{"fieldName":"sortField1"},{"fieldName":"sortField2","direction":"DESC"}]`. */
929
- sort?: Sorting$k[];
929
+ sort?: Sorting$m[];
930
930
  }
931
931
  /** @oneof */
932
932
  interface PlatformQueryPagingMethodOneOf$2 {
933
933
  /** Pointer to page of results using offset. Cannot be used together with `cursorPaging`. */
934
934
  paging?: PlatformPaging$2;
935
935
  /** Cursor pointing to page of results. Cannot be used together with `paging`. `cursorPaging.cursor` can not be used together with `filter` or `sort`. */
936
- cursorPaging?: CursorPaging$k;
936
+ cursorPaging?: CursorPaging$m;
937
937
  }
938
- interface Sorting$k {
938
+ interface Sorting$m {
939
939
  /** Name of the field to sort by. */
940
940
  fieldName?: string;
941
941
  /** Sort order. */
942
- order?: SortOrder$k;
942
+ order?: SortOrder$m;
943
943
  }
944
- declare enum SortOrder$k {
944
+ declare enum SortOrder$m {
945
945
  ASC = "ASC",
946
946
  DESC = "DESC"
947
947
  }
@@ -951,7 +951,7 @@ interface PlatformPaging$2 {
951
951
  /** Number of items to skip in the current sort order. */
952
952
  offset?: number | null;
953
953
  }
954
- interface CursorPaging$k {
954
+ interface CursorPaging$m {
955
955
  /** Maximum number of items to return in the results. */
956
956
  limit?: number | null;
957
957
  /**
@@ -964,7 +964,7 @@ interface CursorPaging$k {
964
964
  }
965
965
  interface QueryDiscountRulesResponse {
966
966
  /** List of discount rules. */
967
- discountRules?: DiscountRule$c[];
967
+ discountRules?: DiscountRule$e[];
968
968
  /** Details on the paged set of results returned. */
969
969
  pagingMetadata?: PlatformPagingMetadata$2;
970
970
  }
@@ -976,9 +976,9 @@ interface PlatformPagingMetadata$2 {
976
976
  /** The total number of items that match the query. Returned if offset paging was used. */
977
977
  total?: number | null;
978
978
  /** Cursors to navigate through result pages. Returned if cursor paging was used. */
979
- cursors?: Cursors$k;
979
+ cursors?: Cursors$m;
980
980
  }
981
- interface Cursors$k {
981
+ interface Cursors$m {
982
982
  /** Cursor string pointing to the next page in the list of results. */
983
983
  next?: string | null;
984
984
  /** Cursor pointing to the previous page in the list of results. */
@@ -1042,7 +1042,7 @@ interface DiscountNonNullableFields {
1042
1042
  fixedPrice: string;
1043
1043
  targetType: Type;
1044
1044
  specificItemsInfo?: SpecificItemsInfoNonNullableFields;
1045
- discountType: DiscountType$c;
1045
+ discountType: DiscountType$e;
1046
1046
  buyXGetYInfo?: BuyXGetYInfoNonNullableFields;
1047
1047
  }
1048
1048
  interface DiscountsNonNullableFields {
@@ -1051,7 +1051,7 @@ interface DiscountsNonNullableFields {
1051
1051
  interface DiscountSettingsNonNullableFields {
1052
1052
  appliesTo: AppliedSubjectType;
1053
1053
  }
1054
- interface DiscountRuleNonNullableFields$c {
1054
+ interface DiscountRuleNonNullableFields$e {
1055
1055
  trigger?: DiscountTriggerNonNullableFields;
1056
1056
  discounts?: DiscountsNonNullableFields;
1057
1057
  status: Status$a;
@@ -1059,19 +1059,19 @@ interface DiscountRuleNonNullableFields$c {
1059
1059
  settings?: DiscountSettingsNonNullableFields;
1060
1060
  }
1061
1061
  interface CreateDiscountRuleResponseNonNullableFields {
1062
- discountRule?: DiscountRuleNonNullableFields$c;
1062
+ discountRule?: DiscountRuleNonNullableFields$e;
1063
1063
  }
1064
1064
  interface GetDiscountRuleResponseNonNullableFields {
1065
- discountRule?: DiscountRuleNonNullableFields$c;
1065
+ discountRule?: DiscountRuleNonNullableFields$e;
1066
1066
  }
1067
1067
  interface UpdateDiscountRuleResponseNonNullableFields {
1068
- discountRule?: DiscountRuleNonNullableFields$c;
1068
+ discountRule?: DiscountRuleNonNullableFields$e;
1069
1069
  }
1070
1070
  interface QueryDiscountRulesResponseNonNullableFields {
1071
- discountRules: DiscountRuleNonNullableFields$c[];
1071
+ discountRules: DiscountRuleNonNullableFields$e[];
1072
1072
  }
1073
1073
 
1074
- type __PublicMethodMetaInfo$p<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
1074
+ type __PublicMethodMetaInfo$q<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
1075
1075
  getUrl: (context: any) => string;
1076
1076
  httpMethod: K;
1077
1077
  path: string;
@@ -1081,25 +1081,25 @@ type __PublicMethodMetaInfo$p<K = string, M = unknown, T = unknown, S = unknown,
1081
1081
  __responseType: Q;
1082
1082
  __originalResponseType: R;
1083
1083
  };
1084
- declare function createDiscountRule(): __PublicMethodMetaInfo$p<'POST', {}, CreateDiscountRuleRequest, CreateDiscountRuleRequest$1, CreateDiscountRuleResponse & CreateDiscountRuleResponseNonNullableFields, CreateDiscountRuleResponse$1 & CreateDiscountRuleResponseNonNullableFields$1>;
1085
- declare function getDiscountRule(): __PublicMethodMetaInfo$p<'GET', {
1084
+ declare function createDiscountRule(): __PublicMethodMetaInfo$q<'POST', {}, CreateDiscountRuleRequest, CreateDiscountRuleRequest$1, CreateDiscountRuleResponse & CreateDiscountRuleResponseNonNullableFields, CreateDiscountRuleResponse$1 & CreateDiscountRuleResponseNonNullableFields$1>;
1085
+ declare function getDiscountRule(): __PublicMethodMetaInfo$q<'GET', {
1086
1086
  discountRuleId: string;
1087
1087
  }, GetDiscountRuleRequest, GetDiscountRuleRequest$1, GetDiscountRuleResponse & GetDiscountRuleResponseNonNullableFields, GetDiscountRuleResponse$1 & GetDiscountRuleResponseNonNullableFields$1>;
1088
- declare function updateDiscountRule(): __PublicMethodMetaInfo$p<'PATCH', {
1088
+ declare function updateDiscountRule(): __PublicMethodMetaInfo$q<'PATCH', {
1089
1089
  discountRuleId: string;
1090
1090
  }, UpdateDiscountRuleRequest, UpdateDiscountRuleRequest$1, UpdateDiscountRuleResponse & UpdateDiscountRuleResponseNonNullableFields, UpdateDiscountRuleResponse$1 & UpdateDiscountRuleResponseNonNullableFields$1>;
1091
- declare function deleteDiscountRule(): __PublicMethodMetaInfo$p<'DELETE', {
1091
+ declare function deleteDiscountRule(): __PublicMethodMetaInfo$q<'DELETE', {
1092
1092
  discountRuleId: string;
1093
1093
  }, DeleteDiscountRuleRequest, DeleteDiscountRuleRequest$1, DeleteDiscountRuleResponse, DeleteDiscountRuleResponse$1>;
1094
- declare function queryDiscountRules(): __PublicMethodMetaInfo$p<'POST', {}, QueryDiscountRulesRequest, QueryDiscountRulesRequest$1, QueryDiscountRulesResponse & QueryDiscountRulesResponseNonNullableFields, QueryDiscountRulesResponse$1 & QueryDiscountRulesResponseNonNullableFields$1>;
1094
+ declare function queryDiscountRules(): __PublicMethodMetaInfo$q<'POST', {}, QueryDiscountRulesRequest, QueryDiscountRulesRequest$1, QueryDiscountRulesResponse & QueryDiscountRulesResponseNonNullableFields, QueryDiscountRulesResponse$1 & QueryDiscountRulesResponseNonNullableFields$1>;
1095
1095
 
1096
- declare const meta$p_createDiscountRule: typeof createDiscountRule;
1097
- declare const meta$p_deleteDiscountRule: typeof deleteDiscountRule;
1098
- declare const meta$p_getDiscountRule: typeof getDiscountRule;
1099
- declare const meta$p_queryDiscountRules: typeof queryDiscountRules;
1100
- declare const meta$p_updateDiscountRule: typeof updateDiscountRule;
1101
- declare namespace meta$p {
1102
- export { type __PublicMethodMetaInfo$p as __PublicMethodMetaInfo, meta$p_createDiscountRule as createDiscountRule, meta$p_deleteDiscountRule as deleteDiscountRule, meta$p_getDiscountRule as getDiscountRule, meta$p_queryDiscountRules as queryDiscountRules, meta$p_updateDiscountRule as updateDiscountRule };
1096
+ declare const meta$q_createDiscountRule: typeof createDiscountRule;
1097
+ declare const meta$q_deleteDiscountRule: typeof deleteDiscountRule;
1098
+ declare const meta$q_getDiscountRule: typeof getDiscountRule;
1099
+ declare const meta$q_queryDiscountRules: typeof queryDiscountRules;
1100
+ declare const meta$q_updateDiscountRule: typeof updateDiscountRule;
1101
+ declare namespace meta$q {
1102
+ export { type __PublicMethodMetaInfo$q as __PublicMethodMetaInfo, meta$q_createDiscountRule as createDiscountRule, meta$q_deleteDiscountRule as deleteDiscountRule, meta$q_getDiscountRule as getDiscountRule, meta$q_queryDiscountRules as queryDiscountRules, meta$q_updateDiscountRule as updateDiscountRule };
1103
1103
  }
1104
1104
 
1105
1105
  interface Invoice$1 {
@@ -1168,7 +1168,7 @@ interface ListInvoicesForMultipleOrdersResponseNonNullableFields {
1168
1168
  invoicesForOrder: InvoicesForOrderNonNullableFields[];
1169
1169
  }
1170
1170
 
1171
- type __PublicMethodMetaInfo$o<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
1171
+ type __PublicMethodMetaInfo$p<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
1172
1172
  getUrl: (context: any) => string;
1173
1173
  httpMethod: K;
1174
1174
  path: string;
@@ -1178,20 +1178,516 @@ type __PublicMethodMetaInfo$o<K = string, M = unknown, T = unknown, S = unknown,
1178
1178
  __responseType: Q;
1179
1179
  __originalResponseType: R;
1180
1180
  };
1181
- declare function listInvoicesForMultipleOrders(): __PublicMethodMetaInfo$o<'POST', {}, ListInvoicesForMultipleOrdersRequest, ListInvoicesForMultipleOrdersRequest$1, ListInvoicesForMultipleOrdersResponse & ListInvoicesForMultipleOrdersResponseNonNullableFields, ListInvoicesForMultipleOrdersResponse$1 & ListInvoicesForMultipleOrdersResponseNonNullableFields$1>;
1181
+ declare function listInvoicesForMultipleOrders(): __PublicMethodMetaInfo$p<'POST', {}, ListInvoicesForMultipleOrdersRequest, ListInvoicesForMultipleOrdersRequest$1, ListInvoicesForMultipleOrdersResponse & ListInvoicesForMultipleOrdersResponseNonNullableFields, ListInvoicesForMultipleOrdersResponse$1 & ListInvoicesForMultipleOrdersResponseNonNullableFields$1>;
1182
1182
 
1183
- declare const meta$o_listInvoicesForMultipleOrders: typeof listInvoicesForMultipleOrders;
1184
- declare namespace meta$o {
1185
- export { type __PublicMethodMetaInfo$o as __PublicMethodMetaInfo, meta$o_listInvoicesForMultipleOrders as listInvoicesForMultipleOrders };
1183
+ declare const meta$p_listInvoicesForMultipleOrders: typeof listInvoicesForMultipleOrders;
1184
+ declare namespace meta$p {
1185
+ export { type __PublicMethodMetaInfo$p as __PublicMethodMetaInfo, meta$p_listInvoicesForMultipleOrders as listInvoicesForMultipleOrders };
1186
1186
  }
1187
1187
 
1188
1188
  interface Recommendation$1 {
1189
1189
  /** Recommended items. */
1190
- items?: CatalogReference$j[];
1190
+ items?: CatalogReference$l[];
1191
1191
  /** The algorithm used to provide the recommendation. */
1192
1192
  algorithm?: Algorithm$1;
1193
1193
  }
1194
1194
  /** Used for grouping line items. Sent when an item is added to a cart, checkout, or order. */
1195
+ interface CatalogReference$l {
1196
+ /** ID of the item within the catalog it belongs to. */
1197
+ catalogItemId?: string;
1198
+ /**
1199
+ * ID of the app providing the catalog.
1200
+ *
1201
+ * You can get your app's ID from its page in the [Wix Dev Center](https://dev.wix.com/apps).
1202
+ *
1203
+ * For items from Wix catalogs, the following values always apply:
1204
+ * + Wix Stores: `"215238eb-22a5-4c36-9e7b-e7c08025e04e"`
1205
+ * + Wix Bookings: `"13d21c63-b5ec-5912-8397-c3a5ddb27a97"`
1206
+ * + Wix Restaurants: `"9a5d83fd-8570-482e-81ab-cfa88942ee60"`
1207
+ */
1208
+ appId?: string;
1209
+ /**
1210
+ * 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.
1211
+ *
1212
+ * 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).
1213
+ */
1214
+ options?: Record<string, any> | null;
1215
+ }
1216
+ interface Algorithm$1 {
1217
+ /** Algorithm ID defined by the app providing the algorithm. */
1218
+ id?: string;
1219
+ /**
1220
+ * App ID of the Wix or 3rd-party app providing the algorithm.
1221
+ *
1222
+ * 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>.
1223
+ */
1224
+ appId?: string;
1225
+ }
1226
+ interface ListAvailableAlgorithmsRequest$1 {
1227
+ }
1228
+ interface ListAvailableAlgorithmsResponse$1 {
1229
+ /** Algorithms available for use on your Wix site or project. See the method description for more information. */
1230
+ availableAlgorithms?: AlgorithmInfo$1[];
1231
+ }
1232
+ interface AlgorithmInfo$1 {
1233
+ /** How the algorithm is configured. */
1234
+ config?: AlgorithmConfig$1;
1235
+ /**
1236
+ * The app ID of the application providing the algorithm.
1237
+ *
1238
+ * 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>.
1239
+ */
1240
+ appId?: string;
1241
+ /**
1242
+ * App IDs of catalogs to which the algorithm can be applied.
1243
+ *
1244
+ * 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>.
1245
+ */
1246
+ catalogAppIds?: string[];
1247
+ }
1248
+ interface AlgorithmConfig$1 {
1249
+ /** Algorithm name. This value is not translatable. */
1250
+ name?: string;
1251
+ /** 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. */
1252
+ description?: string;
1253
+ /** 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. */
1254
+ additionalInfo?: string | null;
1255
+ /**
1256
+ * Algorithms may have the following types:
1257
+ * * `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.
1258
+ * * `GLOBAL` - This type of algorithm provides general recommendations based on site or project statistics. For example, bestsellers or new arrivals.
1259
+ */
1260
+ algorithmType?: AlgorithmType$1;
1261
+ /** 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. */
1262
+ algorithmId?: string;
1263
+ }
1264
+ declare enum AlgorithmType$1 {
1265
+ UNSPECIFIED = "UNSPECIFIED",
1266
+ RELATED_ITEMS = "RELATED_ITEMS",
1267
+ GLOBAL = "GLOBAL"
1268
+ }
1269
+ interface GetRecommendationRequest$1 {
1270
+ /** The set of items for which to get recommendations. Required if the `algorithmType` is `RELATED_ITEMS`. */
1271
+ items?: CatalogReference$l[];
1272
+ /**
1273
+ * A list of algorithms checked in a specific order determined by their `appID` and their position in the `algorithms` array.
1274
+ * See the method description for more information.
1275
+ *
1276
+ * If no algorithm is able to return at least `minimumRecommendedItems` items, an empty array is returned.
1277
+ */
1278
+ algorithms: Algorithm$1[];
1279
+ /**
1280
+ * The minimum number of items that must be recommended by the algorithm for those items to be returned in the response.
1281
+ *
1282
+ * Max: `100`
1283
+ */
1284
+ minimumRecommendedItems?: number;
1285
+ }
1286
+ interface GetRecommendationResponse$1 {
1287
+ /** 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. */
1288
+ recommendation?: Recommendation$1;
1289
+ }
1290
+ interface AlgorithmConfigNonNullableFields$1 {
1291
+ name: string;
1292
+ description: string;
1293
+ algorithmType: AlgorithmType$1;
1294
+ algorithmId: string;
1295
+ }
1296
+ interface AlgorithmInfoNonNullableFields$1 {
1297
+ config?: AlgorithmConfigNonNullableFields$1;
1298
+ appId: string;
1299
+ catalogAppIds: string[];
1300
+ }
1301
+ interface ListAvailableAlgorithmsResponseNonNullableFields$1 {
1302
+ availableAlgorithms: AlgorithmInfoNonNullableFields$1[];
1303
+ }
1304
+ interface CatalogReferenceNonNullableFields$h {
1305
+ catalogItemId: string;
1306
+ appId: string;
1307
+ }
1308
+ interface AlgorithmNonNullableFields$1 {
1309
+ id: string;
1310
+ appId: string;
1311
+ }
1312
+ interface RecommendationNonNullableFields$1 {
1313
+ items: CatalogReferenceNonNullableFields$h[];
1314
+ algorithm?: AlgorithmNonNullableFields$1;
1315
+ }
1316
+ interface GetRecommendationResponseNonNullableFields$1 {
1317
+ recommendation?: RecommendationNonNullableFields$1;
1318
+ }
1319
+
1320
+ interface Recommendation {
1321
+ /** Recommended items. */
1322
+ items?: CatalogReference$k[];
1323
+ /** The algorithm used to provide the recommendation. */
1324
+ algorithm?: Algorithm;
1325
+ }
1326
+ /** Used for grouping line items. Sent when an item is added to a cart, checkout, or order. */
1327
+ interface CatalogReference$k {
1328
+ /** ID of the item within the catalog it belongs to. */
1329
+ catalogItemId?: string;
1330
+ /**
1331
+ * ID of the app providing the catalog.
1332
+ *
1333
+ * You can get your app's ID from its page in the [Wix Dev Center](https://dev.wix.com/apps).
1334
+ *
1335
+ * For items from Wix catalogs, the following values always apply:
1336
+ * + Wix Stores: `"215238eb-22a5-4c36-9e7b-e7c08025e04e"`
1337
+ * + Wix Bookings: `"13d21c63-b5ec-5912-8397-c3a5ddb27a97"`
1338
+ * + Wix Restaurants: `"9a5d83fd-8570-482e-81ab-cfa88942ee60"`
1339
+ */
1340
+ appId?: string;
1341
+ /**
1342
+ * 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.
1343
+ *
1344
+ * 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).
1345
+ */
1346
+ options?: Record<string, any> | null;
1347
+ }
1348
+ interface Algorithm {
1349
+ /** Algorithm ID defined by the app providing the algorithm. */
1350
+ _id?: string;
1351
+ /**
1352
+ * App ID of the Wix or 3rd-party app providing the algorithm.
1353
+ *
1354
+ * 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>.
1355
+ */
1356
+ appId?: string;
1357
+ }
1358
+ interface ListAvailableAlgorithmsRequest {
1359
+ }
1360
+ interface ListAvailableAlgorithmsResponse {
1361
+ /** Algorithms available for use on your Wix site or project. See the method description for more information. */
1362
+ availableAlgorithms?: AlgorithmInfo[];
1363
+ }
1364
+ interface AlgorithmInfo {
1365
+ /** How the algorithm is configured. */
1366
+ config?: AlgorithmConfig;
1367
+ /**
1368
+ * The app ID of the application providing the algorithm.
1369
+ *
1370
+ * 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>.
1371
+ */
1372
+ appId?: string;
1373
+ /**
1374
+ * App IDs of catalogs to which the algorithm can be applied.
1375
+ *
1376
+ * 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>.
1377
+ */
1378
+ catalogAppIds?: string[];
1379
+ }
1380
+ interface AlgorithmConfig {
1381
+ /** Algorithm name. This value is not translatable. */
1382
+ name?: string;
1383
+ /** 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. */
1384
+ description?: string;
1385
+ /** 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. */
1386
+ additionalInfo?: string | null;
1387
+ /**
1388
+ * Algorithms may have the following types:
1389
+ * * `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.
1390
+ * * `GLOBAL` - This type of algorithm provides general recommendations based on site or project statistics. For example, bestsellers or new arrivals.
1391
+ */
1392
+ algorithmType?: AlgorithmType;
1393
+ /** 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. */
1394
+ algorithmId?: string;
1395
+ }
1396
+ declare enum AlgorithmType {
1397
+ UNSPECIFIED = "UNSPECIFIED",
1398
+ RELATED_ITEMS = "RELATED_ITEMS",
1399
+ GLOBAL = "GLOBAL"
1400
+ }
1401
+ interface GetRecommendationRequest {
1402
+ /** The set of items for which to get recommendations. Required if the `algorithmType` is `RELATED_ITEMS`. */
1403
+ items?: CatalogReference$k[];
1404
+ /**
1405
+ * A list of algorithms checked in a specific order determined by their `appID` and their position in the `algorithms` array.
1406
+ * See the method description for more information.
1407
+ *
1408
+ * If no algorithm is able to return at least `minimumRecommendedItems` items, an empty array is returned.
1409
+ */
1410
+ algorithms: Algorithm[];
1411
+ /**
1412
+ * The minimum number of items that must be recommended by the algorithm for those items to be returned in the response.
1413
+ *
1414
+ * Max: `100`
1415
+ */
1416
+ minimumRecommendedItems?: number;
1417
+ }
1418
+ interface GetRecommendationResponse {
1419
+ /** 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. */
1420
+ recommendation?: Recommendation;
1421
+ }
1422
+ interface AlgorithmConfigNonNullableFields {
1423
+ name: string;
1424
+ description: string;
1425
+ algorithmType: AlgorithmType;
1426
+ algorithmId: string;
1427
+ }
1428
+ interface AlgorithmInfoNonNullableFields {
1429
+ config?: AlgorithmConfigNonNullableFields;
1430
+ appId: string;
1431
+ catalogAppIds: string[];
1432
+ }
1433
+ interface ListAvailableAlgorithmsResponseNonNullableFields {
1434
+ availableAlgorithms: AlgorithmInfoNonNullableFields[];
1435
+ }
1436
+ interface CatalogReferenceNonNullableFields$g {
1437
+ catalogItemId: string;
1438
+ appId: string;
1439
+ }
1440
+ interface AlgorithmNonNullableFields {
1441
+ _id: string;
1442
+ appId: string;
1443
+ }
1444
+ interface RecommendationNonNullableFields {
1445
+ items: CatalogReferenceNonNullableFields$g[];
1446
+ algorithm?: AlgorithmNonNullableFields;
1447
+ }
1448
+ interface GetRecommendationResponseNonNullableFields {
1449
+ recommendation?: RecommendationNonNullableFields;
1450
+ }
1451
+
1452
+ type __PublicMethodMetaInfo$o<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
1453
+ getUrl: (context: any) => string;
1454
+ httpMethod: K;
1455
+ path: string;
1456
+ pathParams: M;
1457
+ __requestType: T;
1458
+ __originalRequestType: S;
1459
+ __responseType: Q;
1460
+ __originalResponseType: R;
1461
+ };
1462
+ declare function listAvailableAlgorithms(): __PublicMethodMetaInfo$o<'GET', {}, ListAvailableAlgorithmsRequest, ListAvailableAlgorithmsRequest$1, ListAvailableAlgorithmsResponse & ListAvailableAlgorithmsResponseNonNullableFields, ListAvailableAlgorithmsResponse$1 & ListAvailableAlgorithmsResponseNonNullableFields$1>;
1463
+ declare function getRecommendation(): __PublicMethodMetaInfo$o<'POST', {}, GetRecommendationRequest, GetRecommendationRequest$1, GetRecommendationResponse & GetRecommendationResponseNonNullableFields, GetRecommendationResponse$1 & GetRecommendationResponseNonNullableFields$1>;
1464
+
1465
+ declare const meta$o_getRecommendation: typeof getRecommendation;
1466
+ declare const meta$o_listAvailableAlgorithms: typeof listAvailableAlgorithms;
1467
+ declare namespace meta$o {
1468
+ export { type __PublicMethodMetaInfo$o as __PublicMethodMetaInfo, meta$o_getRecommendation as getRecommendation, meta$o_listAvailableAlgorithms as listAvailableAlgorithms };
1469
+ }
1470
+
1471
+ /**
1472
+ * A SubscriptionContract is a ...
1473
+ * You can ...
1474
+ * Read more about SubscriptionContracts
1475
+ * in this [article](<LINK_TO_KB_ARTICLE>).
1476
+ */
1477
+ interface SubscriptionContract$1 {
1478
+ /**
1479
+ * SubscriptionContract ID.
1480
+ * @readonly
1481
+ */
1482
+ id?: string | null;
1483
+ /**
1484
+ * Revision number, which increments by 1 each time the SubscriptionContract is updated.
1485
+ * To prevent conflicting changes, the current revision must be passed when updating the SubscriptionContract.
1486
+ *
1487
+ * Ignored when creating a SubscriptionOrderContract.
1488
+ * @readonly
1489
+ */
1490
+ revision?: string | null;
1491
+ /**
1492
+ * Date and time the subscription contract was created in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
1493
+ * @readonly
1494
+ */
1495
+ createdDate?: Date | null;
1496
+ /**
1497
+ * 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.
1498
+ * @readonly
1499
+ */
1500
+ updatedDate?: Date | null;
1501
+ /** Subscription option description. For example, `"1kg of selected coffee, once a month"`. */
1502
+ description?: string | null;
1503
+ /** Subscription detailed information. */
1504
+ subscriptionSettings?: V1SubscriptionSettings$1;
1505
+ /**
1506
+ * Order line items.
1507
+ * @readonly
1508
+ */
1509
+ lineItems?: OrderLineItem$5[];
1510
+ /** Buyer information. */
1511
+ buyerInfo?: BuyerInfo$b;
1512
+ /**
1513
+ * Language for communication with the buyer. Defaults to the site language.
1514
+ * For a site that supports multiple languages, this is the language the buyer selected.
1515
+ */
1516
+ buyerLanguage?: string | null;
1517
+ /** Weight measurement unit - defaults to site's weight unit. */
1518
+ weightUnit?: WeightUnit$f;
1519
+ /** 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. */
1520
+ currency?: string | null;
1521
+ /**
1522
+ * Whether tax is included in line item prices.
1523
+ *
1524
+ * Default: `false`
1525
+ */
1526
+ taxIncludedInPrices?: boolean;
1527
+ /**
1528
+ * Order price summary.
1529
+ * @readonly
1530
+ */
1531
+ priceSummary?: PriceSummary$d;
1532
+ /** Billing address and contact details. */
1533
+ billingInfo?: AddressWithContact$b;
1534
+ /** Shipping info and selected shipping option details. */
1535
+ shippingInfo?: ShippingInformation$7;
1536
+ /** Applied discounts. */
1537
+ appliedDiscounts?: AppliedDiscount$d[];
1538
+ /** Information about the sales channel that submitted this order. */
1539
+ channelInfo?: ChannelInfo$5;
1540
+ /** Custom fields. */
1541
+ customFields?: CustomField$7[];
1542
+ /**
1543
+ * Order recipient address and contact details.
1544
+ *
1545
+ * This field may differ from the address in `shippingInfo.logistics` when:
1546
+ * + The chosen shipping option is pickup point or store pickup.
1547
+ * + No shipping option is selected.
1548
+ */
1549
+ recipientInfo?: AddressWithContact$b;
1550
+ /**
1551
+ * Custom field data for the subscription contract object.
1552
+ *
1553
+ * [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.
1554
+ */
1555
+ extendedFields?: ExtendedFields$f;
1556
+ /** Subscription option title. For example, `"Monthly coffee Subscription"`. */
1557
+ title?: string | null;
1558
+ }
1559
+ interface V1SubscriptionSettings$1 {
1560
+ /** Frequency of recurring payment. */
1561
+ frequency?: SubscriptionFrequency$f;
1562
+ /** Interval of recurring payment. */
1563
+ interval?: number | null;
1564
+ /** Whether subscription is renewed automatically at the end of each period. */
1565
+ autoRenewal?: boolean;
1566
+ /** Number of billing cycles before subscription ends. Ignored if `autoRenewal: true`. */
1567
+ billingCycles?: number | null;
1568
+ /** Whether to allow the customer to cancel the subscription. */
1569
+ enableCustomerCancellation?: boolean;
1570
+ }
1571
+ declare enum SubscriptionFrequency$f {
1572
+ UNDEFINED = "UNDEFINED",
1573
+ DAY = "DAY",
1574
+ WEEK = "WEEK",
1575
+ MONTH = "MONTH",
1576
+ YEAR = "YEAR"
1577
+ }
1578
+ interface OrderLineItem$5 {
1579
+ /** Line item ID. */
1580
+ id?: string;
1581
+ /**
1582
+ * Item name.
1583
+ * + Stores - `product.name`
1584
+ * + Bookings - `service.info.name`
1585
+ * + Events - `ticket.name`
1586
+ */
1587
+ productName?: ProductName$d;
1588
+ /**
1589
+ * References to the line item's origin catalog.
1590
+ * This field may be empty in the case of a custom line item.
1591
+ */
1592
+ catalogReference?: CatalogReference$j;
1593
+ /** Line item quantity. */
1594
+ quantity?: number;
1595
+ /**
1596
+ * Total discount for this line item's entire quantity.
1597
+ * @readonly
1598
+ */
1599
+ totalDiscount?: Price$9;
1600
+ /** Line item description lines. Used for display purposes for the cart, checkout and order. */
1601
+ descriptionLines?: DescriptionLine$d[];
1602
+ /** Line item image. */
1603
+ image?: Image$8;
1604
+ /** Physical properties of the item. When relevant, contains information such as SKU and item weight. */
1605
+ physicalProperties?: PhysicalProperties$h;
1606
+ /** Item type. Either a preset type or custom. */
1607
+ itemType?: ItemType$f;
1608
+ /**
1609
+ * Fulfiller ID. Field is empty when the line item is self-fulfilled.
1610
+ * 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).
1611
+ */
1612
+ fulfillerId?: string | null;
1613
+ /**
1614
+ * Number of items that were refunded.
1615
+ * @readonly
1616
+ */
1617
+ refundQuantity?: number | null;
1618
+ /**
1619
+ * Number of items restocked.
1620
+ * @readonly
1621
+ */
1622
+ restockQuantity?: number | null;
1623
+ /** Line item price after line item discounts for display purposes. */
1624
+ price?: Price$9;
1625
+ /**
1626
+ * Line item price before line item discounts for display purposes. Defaults to `price` when not provided.
1627
+ * @readonly
1628
+ */
1629
+ priceBeforeDiscounts?: Price$9;
1630
+ /**
1631
+ * Total price after discounts, and before tax.
1632
+ * @readonly
1633
+ */
1634
+ totalPriceBeforeTax?: Price$9;
1635
+ /**
1636
+ * Total price after all discounts and tax.
1637
+ * @readonly
1638
+ */
1639
+ totalPriceAfterTax?: Price$9;
1640
+ /**
1641
+ * Type of selected payment option for current item. Defaults to `FULL_PAYMENT_ONLINE`.
1642
+ * + `FULL_PAYMENT_ONLINE` - The entire payment for this item happens as part of the checkout.
1643
+ * + `FULL_PAYMENT_OFFLINE` - The entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods.
1644
+ * + `MEMBERSHIP` - Payment for this item is done by charging a membership. When this option is used, `lineItem.price.amount` is 0.
1645
+ * + `DEPOSIT_ONLINE` - Partial payment for the given item to be paid upfront during the checkout. Eligible for catalog items with type `DEPOSIT_ONLINE` only.
1646
+ */
1647
+ paymentOption?: PaymentOptionType$f;
1648
+ /**
1649
+ * Deprecated. Use `taxInfo` instead.
1650
+ * This field will be removed on September 30, 2024.
1651
+ * Tax details for this line item.
1652
+ * @deprecated Deprecated. Use `taxInfo` instead.
1653
+ * This field will be removed on September 30, 2024.
1654
+ * Tax details for this line item.
1655
+ * @replacedBy tax_info
1656
+ * @targetRemovalDate 2024-09-30
1657
+ */
1658
+ taxDetails?: ItemTaxFullDetails$d;
1659
+ /** Represents all the relevant tax details for a specific line item. */
1660
+ taxInfo?: LineItemTaxInfo$5;
1661
+ /** Digital file identifier, relevant only for items with type DIGITAL. */
1662
+ digitalFile?: DigitalFile$5;
1663
+ /** Subscription info. */
1664
+ subscriptionInfo?: SubscriptionInfo$5;
1665
+ /** Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - "Starts at $67". */
1666
+ priceDescription?: PriceDescription$d;
1667
+ /**
1668
+ * Item's price amount to be charged during checkout. Relevant for items with a `paymentOption` value of `"DEPOSIT_ONLINE"`.
1669
+ * @readonly
1670
+ */
1671
+ depositAmount?: Price$9;
1672
+ }
1673
+ interface ProductName$d {
1674
+ /**
1675
+ * __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).
1676
+ *
1677
+ * Min: 1 character.
1678
+ * Max: 200 characters.
1679
+ */
1680
+ original?: string;
1681
+ /**
1682
+ * Item name translated into the buyer's language.
1683
+ *
1684
+ * Min: 1 character.
1685
+ * Max: 400 characters.
1686
+ * Default: Same as `original`.
1687
+ */
1688
+ translated?: string | null;
1689
+ }
1690
+ /** Used for grouping line items. Sent when an item is added to a cart, checkout, or order. */
1195
1691
  interface CatalogReference$j {
1196
1692
  /** ID of the item within the catalog it belongs to. */
1197
1693
  catalogItemId?: string;
@@ -1213,240 +1709,2048 @@ interface CatalogReference$j {
1213
1709
  */
1214
1710
  options?: Record<string, any> | null;
1215
1711
  }
1216
- interface Algorithm$1 {
1217
- /** Algorithm ID defined by the app providing the algorithm. */
1712
+ interface Price$9 {
1713
+ /** Amount. */
1714
+ amount?: string;
1715
+ /**
1716
+ * Amount formatted with currency symbol.
1717
+ * @readonly
1718
+ */
1719
+ formattedAmount?: string;
1720
+ }
1721
+ interface DescriptionLine$d extends DescriptionLineValueOneOf$d, DescriptionLineDescriptionLineValueOneOf$d {
1722
+ /** Description line plain text value. */
1723
+ plainText?: PlainTextValue$d;
1724
+ /** Description line color value. */
1725
+ colorInfo?: Color$d;
1726
+ /** Description line name. */
1727
+ name?: DescriptionLineName$d;
1728
+ }
1729
+ /** @oneof */
1730
+ interface DescriptionLineValueOneOf$d {
1731
+ /** Description line plain text value. */
1732
+ plainText?: PlainTextValue$d;
1733
+ /** Description line color value. */
1734
+ colorInfo?: Color$d;
1735
+ }
1736
+ /** @oneof */
1737
+ interface DescriptionLineDescriptionLineValueOneOf$d {
1738
+ }
1739
+ interface DescriptionLineName$d {
1740
+ /** 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). */
1741
+ original?: string;
1742
+ /**
1743
+ * Description line name translated into the buyer's language.
1744
+ *
1745
+ * Default: Same as `original`.
1746
+ */
1747
+ translated?: string | null;
1748
+ }
1749
+ interface PlainTextValue$d {
1750
+ /** 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). */
1751
+ original?: string;
1752
+ /**
1753
+ * Description line plain text value translated into the buyer's language.
1754
+ *
1755
+ * Default: Same as `original`.
1756
+ */
1757
+ translated?: string | null;
1758
+ }
1759
+ interface Color$d {
1760
+ /** 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). */
1761
+ original?: string;
1762
+ /**
1763
+ * Description line color name translated into the buyer's language.
1764
+ *
1765
+ * Default: Same as `original`.
1766
+ */
1767
+ translated?: string | null;
1768
+ /** HEX or RGB color code for display. */
1769
+ code?: string | null;
1770
+ }
1771
+ declare enum DescriptionLineType$d {
1772
+ UNRECOGNISED = "UNRECOGNISED",
1773
+ PLAIN_TEXT = "PLAIN_TEXT",
1774
+ COLOR = "COLOR"
1775
+ }
1776
+ interface Image$8 {
1777
+ /** WixMedia image ID. */
1778
+ id?: string;
1779
+ /** Image URL. */
1780
+ url?: string;
1781
+ /**
1782
+ * Original image height.
1783
+ * @readonly
1784
+ */
1785
+ height?: number;
1786
+ /**
1787
+ * Original image width.
1788
+ * @readonly
1789
+ */
1790
+ width?: number;
1791
+ /** Image alt text. */
1792
+ altText?: string | null;
1793
+ /**
1794
+ * Image filename.
1795
+ * @readonly
1796
+ */
1797
+ filename?: string | null;
1798
+ }
1799
+ interface PhysicalProperties$h {
1800
+ /** Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request. */
1801
+ weight?: number | null;
1802
+ /** Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku). */
1803
+ sku?: string | null;
1804
+ /** Whether this line item is shippable. */
1805
+ shippable?: boolean;
1806
+ }
1807
+ interface ItemType$f extends ItemTypeItemTypeDataOneOf$f {
1808
+ /** Preset item type. */
1809
+ preset?: ItemTypeItemType$f;
1810
+ /** Custom item type. When none of the preset types are suitable, specifies the custom type. */
1811
+ custom?: string;
1812
+ }
1813
+ /** @oneof */
1814
+ interface ItemTypeItemTypeDataOneOf$f {
1815
+ /** Preset item type. */
1816
+ preset?: ItemTypeItemType$f;
1817
+ /** Custom item type. When none of the preset types are suitable, specifies the custom type. */
1818
+ custom?: string;
1819
+ }
1820
+ declare enum ItemTypeItemType$f {
1821
+ UNRECOGNISED = "UNRECOGNISED",
1822
+ PHYSICAL = "PHYSICAL",
1823
+ DIGITAL = "DIGITAL",
1824
+ GIFT_CARD = "GIFT_CARD",
1825
+ SERVICE = "SERVICE"
1826
+ }
1827
+ /** Type of selected payment option for catalog item */
1828
+ declare enum PaymentOptionType$f {
1829
+ /** The entire payment for this item happens as part of the checkout. */
1830
+ FULL_PAYMENT_ONLINE = "FULL_PAYMENT_ONLINE",
1831
+ /** The entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods. */
1832
+ FULL_PAYMENT_OFFLINE = "FULL_PAYMENT_OFFLINE",
1833
+ /** Payment for this item is done by charging a membership. When selected, `price` is `0`. */
1834
+ MEMBERSHIP = "MEMBERSHIP",
1835
+ /** Partial payment to be paid upfront during the checkout. Initial amount to be paid for each line item is specified in `depositAmount`. */
1836
+ DEPOSIT_ONLINE = "DEPOSIT_ONLINE",
1837
+ /** 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`. */
1838
+ MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
1839
+ }
1840
+ interface ItemTaxFullDetails$d {
1841
+ /** Taxable amount of this line item. */
1842
+ taxableAmount?: Price$9;
1843
+ /** Tax rate percentage, as a decimal numeral between 0 and 1. For example, `"0.13"`. */
1844
+ taxRate?: string;
1845
+ /** The calculated tax, based on the `taxableAmount` and `taxRate`. */
1846
+ totalTax?: Price$9;
1847
+ }
1848
+ interface LineItemTaxInfo$5 {
1849
+ /** Calculated tax, based on `taxable_amount` and `tax_rate`. */
1850
+ taxAmount?: Price$9;
1851
+ /** Amount for which tax is calculated. */
1852
+ taxableAmount?: Price$9;
1853
+ /** Tax rate %, as a decimal point. */
1854
+ taxRate?: string | null;
1855
+ /**
1856
+ * Tax group ID.
1857
+ * Learn more about [Tax Groups](https://dev.wix.com/docs/rest/business-management/payments/tax/tax-groups/introduction).
1858
+ */
1859
+ taxGroupId?: string | null;
1860
+ /** Indicates whether the price already includes tax. */
1861
+ taxIncludedInPrice?: boolean;
1862
+ /** Tax information for a line item. */
1863
+ taxBreakdown?: LineItemTaxBreakdown$5[];
1864
+ }
1865
+ /**
1866
+ * TaxBreakdown represents tax information for a line item.
1867
+ * It holds the tax amount and the tax rate for each tax authority that apply on the line item.
1868
+ */
1869
+ interface LineItemTaxBreakdown$5 {
1870
+ /** Jurisdiction that taxes were calculated for. For example, "New York", or "Quebec". */
1871
+ jurisdiction?: string | null;
1872
+ /** Tax rate used for this jurisdiction, as a decimal. For example, 10% tax is 0.1000. */
1873
+ rate?: string | null;
1874
+ /** Amount of tax calculated for this line item. */
1875
+ taxAmount?: Price$9;
1876
+ /** The type of tax that was calculated. Depends on the jurisdiction's tax laws. For example, "Sales Tax", "Income Tax", "Value Added Tax", etc. */
1877
+ taxType?: string | null;
1878
+ /**
1879
+ * The name of the tax against which this tax amount was calculated. For example, "NY State Sales Tax", "Quebec GST", etc.
1880
+ * This name should be explicit enough to allow the merchant to understand what tax was calculated.
1881
+ */
1882
+ taxName?: string | null;
1883
+ /** Type of jurisdiction that taxes were calculated for. */
1884
+ jurisdictionType?: JurisdictionType$d;
1885
+ /** Non-taxable amount of the line item price. */
1886
+ nonTaxableAmount?: Price$9;
1887
+ /** Taxable amount of the line item price. */
1888
+ taxableAmount?: Price$9;
1889
+ }
1890
+ /** JurisdictionType represents the type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
1891
+ declare enum JurisdictionType$d {
1892
+ UNDEFINED = "UNDEFINED",
1893
+ COUNTRY = "COUNTRY",
1894
+ STATE = "STATE",
1895
+ COUNTY = "COUNTY",
1896
+ CITY = "CITY",
1897
+ SPECIAL = "SPECIAL"
1898
+ }
1899
+ interface DigitalFile$5 {
1900
+ /** ID of the secure file in media. */
1901
+ fileId?: string;
1902
+ /** Link will exist after the digital links have been generated on the order. */
1903
+ link?: string | null;
1904
+ /**
1905
+ * Link expiration time and date.
1906
+ * @readonly
1907
+ */
1908
+ expirationDate?: Date | null;
1909
+ }
1910
+ interface SubscriptionInfo$5 {
1911
+ /** Subscription ID. */
1912
+ id?: string | null;
1913
+ /** Subscription cycle. For example, if this order is for the 3rd cycle of a subscription, value will be `3`. */
1914
+ cycleNumber?: number;
1915
+ /** Subscription option title. For example, `"Monthly coffee Subscription"`. */
1916
+ subscriptionOptionTitle?: string;
1917
+ /** Subscription option description. For example, `"1kg of selected coffee, once a month"`. */
1918
+ subscriptionOptionDescription?: string | null;
1919
+ /** Subscription detailed information. */
1920
+ subscriptionSettings?: SubscriptionSettings$7;
1921
+ }
1922
+ interface SubscriptionSettings$7 {
1923
+ /** Frequency of recurring payment. */
1924
+ frequency?: V2SubscriptionFrequency$1;
1925
+ /** Interval of recurring payment. */
1926
+ interval?: number | null;
1927
+ /** Whether subscription is renewed automatically at the end of each period. */
1928
+ autoRenewal?: boolean;
1929
+ /** Number of billing cycles before subscription ends. Ignored if `autoRenewal: true`. */
1930
+ billingCycles?: number | null;
1931
+ }
1932
+ /** Frequency unit of recurring payment */
1933
+ declare enum V2SubscriptionFrequency$1 {
1934
+ UNDEFINED = "UNDEFINED",
1935
+ DAY = "DAY",
1936
+ WEEK = "WEEK",
1937
+ MONTH = "MONTH",
1938
+ YEAR = "YEAR"
1939
+ }
1940
+ interface PriceDescription$d {
1941
+ /** __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). */
1942
+ original?: string;
1943
+ /**
1944
+ * Price description translated into the buyer's language.
1945
+ *
1946
+ * Default: Same as `original`.
1947
+ */
1948
+ translated?: string | null;
1949
+ }
1950
+ declare enum TaxableAddressType$d {
1951
+ UNKNOWN_TAXABLE_ADDRESS = "UNKNOWN_TAXABLE_ADDRESS",
1952
+ BUSINESS = "BUSINESS",
1953
+ BILLING = "BILLING",
1954
+ SHIPPING = "SHIPPING"
1955
+ }
1956
+ /** Buyer Info */
1957
+ interface BuyerInfo$b extends BuyerInfoIdOneOf$b {
1958
+ /** Visitor ID (if site visitor is not a member). */
1959
+ visitorId?: string;
1960
+ /** Member ID (if site visitor is a site member). */
1961
+ memberId?: string;
1962
+ /** 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). */
1963
+ contactId?: string | null;
1964
+ /** Buyer email address. */
1965
+ email?: string | null;
1966
+ }
1967
+ /** @oneof */
1968
+ interface BuyerInfoIdOneOf$b {
1969
+ /** Visitor ID (if site visitor is not a member). */
1970
+ visitorId?: string;
1971
+ /** Member ID (if site visitor is a site member). */
1972
+ memberId?: string;
1973
+ }
1974
+ declare enum WeightUnit$f {
1975
+ /** Weight unit can't be classified, due to an error */
1976
+ UNSPECIFIED_WEIGHT_UNIT = "UNSPECIFIED_WEIGHT_UNIT",
1977
+ /** Kilograms */
1978
+ KG = "KG",
1979
+ /** Pounds */
1980
+ LB = "LB"
1981
+ }
1982
+ interface PriceSummary$d {
1983
+ /** Subtotal of all the line items, before discounts and before tax. */
1984
+ subtotal?: Price$9;
1985
+ /** Total shipping price, before discounts and before tax. */
1986
+ shipping?: Price$9;
1987
+ /** Total tax on this order. */
1988
+ tax?: Price$9;
1989
+ /** Total calculated discount value. */
1990
+ discount?: Price$9;
1991
+ /** Order’s total price after discounts and tax. */
1992
+ total?: Price$9;
1993
+ /** Total price of additional fees before tax. */
1994
+ totalAdditionalFees?: Price$9;
1995
+ }
1996
+ /** Billing Info and shipping details */
1997
+ interface AddressWithContact$b {
1998
+ /** Address. */
1999
+ address?: Address$h;
2000
+ /** Contact details. */
2001
+ contactDetails?: FullAddressContactDetails$f;
2002
+ }
2003
+ /** Physical address */
2004
+ interface Address$h {
2005
+ /** Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format. */
2006
+ country?: string | null;
2007
+ /** Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://www.iso.org/standard/72483.html) format. */
2008
+ subdivision?: string | null;
2009
+ /** City name. */
2010
+ city?: string | null;
2011
+ /** Postal or zip code. */
2012
+ postalCode?: string | null;
2013
+ /** Street address. */
2014
+ streetAddress?: StreetAddress$j;
2015
+ /** Main address line (usually street name and number). */
2016
+ addressLine?: string | null;
2017
+ /** Free text providing more detailed address info. Usually contains apt, suite, floor. */
2018
+ addressLine2?: string | null;
2019
+ /**
2020
+ * Country's full name.
2021
+ * @readonly
2022
+ */
2023
+ countryFullname?: string | null;
2024
+ /**
2025
+ * Subdivision full-name.
2026
+ * @readonly
2027
+ */
2028
+ subdivisionFullname?: string | null;
2029
+ }
2030
+ interface StreetAddress$j {
2031
+ /** Street number. */
2032
+ number?: string;
2033
+ /** Street name. */
2034
+ name?: string;
2035
+ }
2036
+ /** Full contact details for an address */
2037
+ interface FullAddressContactDetails$f {
2038
+ /** First name. */
2039
+ firstName?: string | null;
2040
+ /** Last name. */
2041
+ lastName?: string | null;
2042
+ /** Phone number. */
2043
+ phone?: string | null;
2044
+ /** Company name. */
2045
+ company?: string | null;
2046
+ /** Tax information (for Brazil only). If ID is provided, `vatId.type` must also be set, `UNSPECIFIED` is not allowed. */
2047
+ vatId?: VatId$d;
2048
+ }
2049
+ interface VatId$d {
2050
+ /** Customer's tax ID. */
2051
+ id?: string;
2052
+ /**
2053
+ * Tax type.
2054
+ *
2055
+ * Supported values:
2056
+ * + `CPF`: for individual tax payers
2057
+ * + `CNPJ`: for corporations
2058
+ */
2059
+ type?: VatType$d;
2060
+ }
2061
+ /** tax info types */
2062
+ declare enum VatType$d {
2063
+ UNSPECIFIED = "UNSPECIFIED",
2064
+ /** CPF - for individual tax payers. */
2065
+ CPF = "CPF",
2066
+ /** CNPJ - for corporations */
2067
+ CNPJ = "CNPJ"
2068
+ }
2069
+ interface ShippingInformation$7 {
2070
+ /** App Def Id of external provider which was a source of shipping info */
2071
+ carrierId?: string | null;
2072
+ /** Unique code (or ID) of selected shipping option. For example, `"usps_std_overnight"``. */
2073
+ code?: string | null;
2074
+ /**
2075
+ * Shipping option title.
2076
+ * For example, `"USPS Standard Overnight Delivery"`, `"Standard"` or `"First-Class Package International"`.
2077
+ */
2078
+ title?: string;
2079
+ /** Shipping logistics. */
2080
+ logistics?: DeliveryLogistics$f;
2081
+ /** Shipping costs. */
2082
+ cost?: ShippingPrice$d;
2083
+ /** Shipping region. */
2084
+ region?: ShippingRegion$d;
2085
+ }
2086
+ interface DeliveryLogistics$f extends DeliveryLogisticsAddressOneOf$3 {
2087
+ /** Shipping address and contact details. */
2088
+ shippingDestination?: AddressWithContact$b;
2089
+ /** Pickup details. */
2090
+ pickupDetails?: PickupDetails$f;
2091
+ /** Expected delivery time in free text. For example, `"3-5 business days"`. */
2092
+ deliveryTime?: string | null;
2093
+ /** Instructions for carrier. For example, `"Please knock on the door. If unanswered, please call contact number. Thanks."`. */
2094
+ instructions?: string | null;
2095
+ /**
2096
+ * Deprecated - Latest expected delivery date and time in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
2097
+ * @deprecated
2098
+ */
2099
+ deliverByDate?: Date | null;
2100
+ /** Expected delivery time. */
2101
+ deliveryTimeSlot?: DeliveryTimeSlot$7;
2102
+ }
2103
+ /** @oneof */
2104
+ interface DeliveryLogisticsAddressOneOf$3 {
2105
+ /** Shipping address and contact details. */
2106
+ shippingDestination?: AddressWithContact$b;
2107
+ /** Pickup details. */
2108
+ pickupDetails?: PickupDetails$f;
2109
+ }
2110
+ interface PickupDetails$f {
2111
+ /** Pickup address. */
2112
+ address?: PickupAddress$5;
2113
+ /** Pickup method */
2114
+ pickupMethod?: PickupMethod$f;
2115
+ }
2116
+ /** Physical address */
2117
+ interface PickupAddress$5 {
2118
+ /** Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format. */
2119
+ country?: string | null;
2120
+ /** Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://www.iso.org/standard/72483.html) format. */
2121
+ subdivision?: string | null;
2122
+ /** City name. */
2123
+ city?: string | null;
2124
+ /** Postal or zip code. */
2125
+ postalCode?: string | null;
2126
+ /** Street address object, with number, name, and apartment number in separate fields. */
2127
+ streetAddress?: StreetAddress$j;
2128
+ /** Main address line (usually street name and number). */
2129
+ addressLine?: string | null;
2130
+ /** Free text providing more detailed address info. Usually contains apt, suite, floor. */
2131
+ addressLine2?: string | null;
2132
+ /**
2133
+ * Country's full name.
2134
+ * @readonly
2135
+ */
2136
+ countryFullname?: string | null;
2137
+ /**
2138
+ * Subdivision full-name.
2139
+ * @readonly
2140
+ */
2141
+ subdivisionFullname?: string | null;
2142
+ }
2143
+ declare enum PickupMethod$f {
2144
+ UNKNOWN_METHOD = "UNKNOWN_METHOD",
2145
+ STORE_PICKUP = "STORE_PICKUP",
2146
+ PICKUP_POINT = "PICKUP_POINT"
2147
+ }
2148
+ interface DeliveryTimeSlot$7 {
2149
+ /** Delivery slot starting time. */
2150
+ from?: Date | null;
2151
+ /** Delivery slot ending time. */
2152
+ to?: Date | null;
2153
+ }
2154
+ interface ShippingPrice$d {
2155
+ /** Shipping price for display purposes. */
2156
+ price?: Price$9;
2157
+ /**
2158
+ * Total price of shipping after discounts (when relevant), and before tax.
2159
+ * @readonly
2160
+ */
2161
+ totalPriceBeforeTax?: Price$9;
2162
+ /**
2163
+ * Shipping price after all discounts (if any exist), and after tax.
2164
+ * @readonly
2165
+ */
2166
+ totalPriceAfterTax?: Price$9;
2167
+ /** Tax details. */
2168
+ taxDetails?: ItemTaxFullDetails$d;
2169
+ /**
2170
+ * Shipping discount before tax.
2171
+ * @readonly
2172
+ */
2173
+ discount?: Price$9;
2174
+ }
2175
+ interface ShippingRegion$d {
2176
+ /** Name of shipping region. For example, `"Metropolitan London"`, or `"Outer Melbourne suburbs"`. */
2177
+ name?: string | null;
2178
+ }
2179
+ interface AppliedDiscount$d extends AppliedDiscountDiscountSourceOneOf$d {
2180
+ /** Applied coupon info. */
2181
+ coupon?: Coupon$d;
2182
+ /** Merchant discount. */
2183
+ merchantDiscount?: MerchantDiscount$d;
2184
+ /** Automatic Discount */
2185
+ discountRule?: DiscountRule$d;
2186
+ /**
2187
+ * Discount type.
2188
+ * * `"GLOBAL"` - discount applies to entire order.
2189
+ * * `"SPECIFIC-ITEMS"` - discount applies to specific items.
2190
+ * * `"SHIPPING"` - discount applies to shipping. For example, free shipping.
2191
+ */
2192
+ discountType?: DiscountType$d;
2193
+ /**
2194
+ * IDs of line items discount applies to.
2195
+ * Deprecated. Use `line_item_discounts` instead.
2196
+ * @deprecated IDs of line items discount applies to.
2197
+ * Deprecated. Use `line_item_discounts` instead.
2198
+ * @replacedBy line_item_discounts
2199
+ * @targetRemovalDate 2024-10-30
2200
+ */
2201
+ lineItemIds?: string[];
2202
+ /** Discount id. */
2203
+ id?: string | null;
2204
+ }
2205
+ /** @oneof */
2206
+ interface AppliedDiscountDiscountSourceOneOf$d {
2207
+ /** Applied coupon info. */
2208
+ coupon?: Coupon$d;
2209
+ /** Merchant discount. */
2210
+ merchantDiscount?: MerchantDiscount$d;
2211
+ /** Automatic Discount */
2212
+ discountRule?: DiscountRule$d;
2213
+ }
2214
+ declare enum DiscountType$d {
2215
+ GLOBAL = "GLOBAL",
2216
+ SPECIFIC_ITEMS = "SPECIFIC_ITEMS",
2217
+ SHIPPING = "SHIPPING"
2218
+ }
2219
+ /** Coupon */
2220
+ interface Coupon$d {
2221
+ /** Coupon ID. */
2222
+ id?: string;
2223
+ /** Coupon code. */
2224
+ code?: string;
2225
+ /** Coupon name. */
2226
+ name?: string;
2227
+ /** Coupon value. */
2228
+ amount?: Price$9;
2229
+ }
2230
+ interface MerchantDiscount$d extends MerchantDiscountMerchantDiscountReasonOneOf$5 {
2231
+ /**
2232
+ * Pre-defined discount reason (optional).
2233
+ * * `"ITEMS_EXCHANGE"` - exchange balance acquired as a result of items exchange.
2234
+ */
2235
+ discountReason?: DiscountReason$5;
2236
+ /** Discount description as free text (optional). */
2237
+ description?: string | null;
2238
+ /** Discount amount. */
2239
+ amount?: Price$9;
2240
+ }
2241
+ /** @oneof */
2242
+ interface MerchantDiscountMerchantDiscountReasonOneOf$5 {
2243
+ /**
2244
+ * Pre-defined discount reason (optional).
2245
+ * * `"ITEMS_EXCHANGE"` - exchange balance acquired as a result of items exchange.
2246
+ */
2247
+ discountReason?: DiscountReason$5;
2248
+ /** Discount description as free text (optional). */
2249
+ description?: string | null;
2250
+ }
2251
+ declare enum DiscountReason$5 {
2252
+ UNSPECIFIED = "UNSPECIFIED",
2253
+ EXCHANGED_ITEMS = "EXCHANGED_ITEMS"
2254
+ }
2255
+ interface DiscountRule$d {
2256
+ /** Discount rule ID */
1218
2257
  id?: string;
2258
+ /** Discount rule name */
2259
+ name?: DiscountRuleName$d;
2260
+ /** Discount value. */
2261
+ amount?: Price$9;
2262
+ }
2263
+ interface DiscountRuleName$d {
2264
+ /** Original discount rule name (in site's default language). */
2265
+ original?: string;
2266
+ /** Translated discount rule name according to buyer language. Defaults to `original` when not provided. */
2267
+ translated?: string | null;
2268
+ }
2269
+ interface ChannelInfo$5 {
2270
+ /** Sales channel that submitted the order. */
2271
+ type?: ChannelType$b;
2272
+ /** Reference to an order ID from an external system. */
2273
+ externalOrderId?: string | null;
2274
+ /** URL to the order in the external system. */
2275
+ externalOrderUrl?: string | null;
2276
+ }
2277
+ declare enum ChannelType$b {
2278
+ UNSPECIFIED = "UNSPECIFIED",
2279
+ WEB = "WEB",
2280
+ POS = "POS",
2281
+ EBAY = "EBAY",
2282
+ AMAZON = "AMAZON",
2283
+ OTHER_PLATFORM = "OTHER_PLATFORM",
2284
+ WIX_APP_STORE = "WIX_APP_STORE",
2285
+ WIX_INVOICES = "WIX_INVOICES",
2286
+ BACKOFFICE_MERCHANT = "BACKOFFICE_MERCHANT",
2287
+ WISH = "WISH",
2288
+ CLASS_PASS = "CLASS_PASS",
2289
+ GLOBAL_E = "GLOBAL_E",
2290
+ FACEBOOK = "FACEBOOK",
2291
+ ETSY = "ETSY",
2292
+ TIKTOK = "TIKTOK",
2293
+ FAIRE_COM = "FAIRE_COM"
2294
+ }
2295
+ interface CustomField$7 {
2296
+ /** Custom field value. */
2297
+ value?: any;
2298
+ /** Custom field title. */
2299
+ title?: string;
2300
+ /** Translated custom field title. */
2301
+ translatedTitle?: string | null;
2302
+ }
2303
+ interface ExtendedFields$f {
2304
+ /**
2305
+ * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
2306
+ * The value of each key is structured according to the schema defined when the extended fields were configured.
2307
+ *
2308
+ * You can only access fields for which you have the appropriate permissions.
2309
+ *
2310
+ * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
2311
+ */
2312
+ namespaces?: Record<string, Record<string, any>>;
2313
+ }
2314
+ interface GetSubscriptionContractRequest$1 {
2315
+ /** ID of the SubscriptionContract to retrieve. */
2316
+ subscriptionContractId: string;
2317
+ }
2318
+ interface GetSubscriptionContractResponse$1 {
2319
+ /** The requested SubscriptionContract. */
2320
+ subscriptionContract?: SubscriptionContract$1;
2321
+ }
2322
+ interface QuerySubscriptionContractsRequest$1 {
2323
+ /** WQL expression. */
2324
+ query?: CursorQuery$d;
2325
+ }
2326
+ interface CursorQuery$d extends CursorQueryPagingMethodOneOf$d {
2327
+ /** 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`. */
2328
+ cursorPaging?: CursorPaging$l;
2329
+ /**
2330
+ * Filter object in the following format:
2331
+ * `"filter" : {
2332
+ * "fieldName1": "value1",
2333
+ * "fieldName2":{"$operator":"value2"}
2334
+ * }`
2335
+ * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
2336
+ * Learn more about the [filter format](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
2337
+ */
2338
+ filter?: Record<string, any> | null;
2339
+ /**
2340
+ * Sort object in the following format:
2341
+ * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
2342
+ * Learn more about the [sort format](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
2343
+ */
2344
+ sort?: Sorting$l[];
2345
+ }
2346
+ /** @oneof */
2347
+ interface CursorQueryPagingMethodOneOf$d {
2348
+ /** 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`. */
2349
+ cursorPaging?: CursorPaging$l;
2350
+ }
2351
+ interface Sorting$l {
2352
+ /** Name of the field to sort by. */
2353
+ fieldName?: string;
2354
+ /** Sort order. */
2355
+ order?: SortOrder$l;
2356
+ }
2357
+ declare enum SortOrder$l {
2358
+ ASC = "ASC",
2359
+ DESC = "DESC"
2360
+ }
2361
+ interface CursorPaging$l {
2362
+ /** Maximum number of items to return in the results. */
2363
+ limit?: number | null;
2364
+ /**
2365
+ * Pointer to the next or previous page in the list of results.
2366
+ *
2367
+ * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
2368
+ * Not relevant for the first request.
2369
+ */
2370
+ cursor?: string | null;
2371
+ }
2372
+ interface QuerySubscriptionContractsResponse$1 {
2373
+ /** List of SubscriptionContracts. */
2374
+ subscriptionContracts?: SubscriptionContract$1[];
2375
+ /** Paging metadata */
2376
+ pagingMetadata?: CursorPagingMetadata$h;
2377
+ }
2378
+ interface CursorPagingMetadata$h {
2379
+ /** Number of items returned in the response. */
2380
+ count?: number | null;
2381
+ /** Cursor strings that point to the next page, previous page, or both. */
2382
+ cursors?: Cursors$l;
2383
+ /**
2384
+ * Whether there are more pages to retrieve following the current page.
2385
+ *
2386
+ * + `true`: Another page of results can be retrieved.
2387
+ * + `false`: This is the last page.
2388
+ */
2389
+ hasNext?: boolean | null;
2390
+ }
2391
+ interface Cursors$l {
2392
+ /** Cursor string pointing to the next page in the list of results. */
2393
+ next?: string | null;
2394
+ /** Cursor pointing to the previous page in the list of results. */
2395
+ prev?: string | null;
2396
+ }
2397
+ interface V1SubscriptionSettingsNonNullableFields$1 {
2398
+ frequency: SubscriptionFrequency$f;
2399
+ autoRenewal: boolean;
2400
+ enableCustomerCancellation: boolean;
2401
+ }
2402
+ interface ProductNameNonNullableFields$d {
2403
+ original: string;
2404
+ }
2405
+ interface CatalogReferenceNonNullableFields$f {
2406
+ catalogItemId: string;
2407
+ appId: string;
2408
+ }
2409
+ interface PriceNonNullableFields$9 {
2410
+ amount: string;
2411
+ formattedAmount: string;
2412
+ }
2413
+ interface PlainTextValueNonNullableFields$d {
2414
+ original: string;
2415
+ }
2416
+ interface ColorNonNullableFields$d {
2417
+ original: string;
2418
+ }
2419
+ interface DescriptionLineNameNonNullableFields$d {
2420
+ original: string;
2421
+ }
2422
+ interface DescriptionLineNonNullableFields$d {
2423
+ plainText?: PlainTextValueNonNullableFields$d;
2424
+ colorInfo?: ColorNonNullableFields$d;
2425
+ plainTextValue?: PlainTextValueNonNullableFields$d;
2426
+ color: string;
2427
+ name?: DescriptionLineNameNonNullableFields$d;
2428
+ lineType: DescriptionLineType$d;
2429
+ }
2430
+ interface ImageNonNullableFields$8 {
2431
+ id: string;
2432
+ url: string;
2433
+ height: number;
2434
+ width: number;
2435
+ }
2436
+ interface PhysicalPropertiesNonNullableFields$d {
2437
+ shippable: boolean;
2438
+ }
2439
+ interface ItemTypeNonNullableFields$d {
2440
+ preset: ItemTypeItemType$f;
2441
+ custom: string;
2442
+ }
2443
+ interface ItemTaxFullDetailsNonNullableFields$d {
2444
+ taxableAmount?: PriceNonNullableFields$9;
2445
+ taxRate: string;
2446
+ totalTax?: PriceNonNullableFields$9;
2447
+ }
2448
+ interface LineItemTaxBreakdownNonNullableFields$5 {
2449
+ taxAmount?: PriceNonNullableFields$9;
2450
+ jurisdictionType: JurisdictionType$d;
2451
+ nonTaxableAmount?: PriceNonNullableFields$9;
2452
+ taxableAmount?: PriceNonNullableFields$9;
2453
+ }
2454
+ interface LineItemTaxInfoNonNullableFields$5 {
2455
+ taxAmount?: PriceNonNullableFields$9;
2456
+ taxableAmount?: PriceNonNullableFields$9;
2457
+ taxIncludedInPrice: boolean;
2458
+ taxBreakdown: LineItemTaxBreakdownNonNullableFields$5[];
2459
+ }
2460
+ interface DigitalFileNonNullableFields$5 {
2461
+ fileId: string;
2462
+ }
2463
+ interface SubscriptionSettingsNonNullableFields$d {
2464
+ frequency: V2SubscriptionFrequency$1;
2465
+ autoRenewal: boolean;
2466
+ enableCustomerCancellation: boolean;
2467
+ }
2468
+ interface SubscriptionInfoNonNullableFields$5 {
2469
+ cycleNumber: number;
2470
+ subscriptionOptionTitle: string;
2471
+ subscriptionSettings?: SubscriptionSettingsNonNullableFields$d;
2472
+ }
2473
+ interface PriceDescriptionNonNullableFields$d {
2474
+ original: string;
2475
+ }
2476
+ interface LocationAndQuantityNonNullableFields$5 {
2477
+ id: string;
2478
+ quantity: number;
2479
+ }
2480
+ interface TaxableAddressNonNullableFields$d {
2481
+ addressType: TaxableAddressType$d;
2482
+ }
2483
+ interface OrderLineItemNonNullableFields$5 {
2484
+ id: string;
2485
+ productName?: ProductNameNonNullableFields$d;
2486
+ catalogReference?: CatalogReferenceNonNullableFields$f;
2487
+ quantity: number;
2488
+ totalDiscount?: PriceNonNullableFields$9;
2489
+ descriptionLines: DescriptionLineNonNullableFields$d[];
2490
+ image?: ImageNonNullableFields$8;
2491
+ physicalProperties?: PhysicalPropertiesNonNullableFields$d;
2492
+ itemType?: ItemTypeNonNullableFields$d;
2493
+ price?: PriceNonNullableFields$9;
2494
+ priceBeforeDiscounts?: PriceNonNullableFields$9;
2495
+ totalPriceBeforeTax?: PriceNonNullableFields$9;
2496
+ totalPriceAfterTax?: PriceNonNullableFields$9;
2497
+ paymentOption: PaymentOptionType$f;
2498
+ taxDetails?: ItemTaxFullDetailsNonNullableFields$d;
2499
+ taxInfo?: LineItemTaxInfoNonNullableFields$5;
2500
+ digitalFile?: DigitalFileNonNullableFields$5;
2501
+ subscriptionInfo?: SubscriptionInfoNonNullableFields$5;
2502
+ priceDescription?: PriceDescriptionNonNullableFields$d;
2503
+ depositAmount?: PriceNonNullableFields$9;
2504
+ locations: LocationAndQuantityNonNullableFields$5[];
2505
+ lineItemPrice?: PriceNonNullableFields$9;
2506
+ taxableAddress?: TaxableAddressNonNullableFields$d;
2507
+ priceUndetermined: boolean;
2508
+ fixedQuantity: boolean;
2509
+ }
2510
+ interface BuyerInfoNonNullableFields$b {
2511
+ visitorId: string;
2512
+ memberId: string;
2513
+ }
2514
+ interface PriceSummaryNonNullableFields$d {
2515
+ subtotal?: PriceNonNullableFields$9;
2516
+ shipping?: PriceNonNullableFields$9;
2517
+ tax?: PriceNonNullableFields$9;
2518
+ discount?: PriceNonNullableFields$9;
2519
+ totalPrice?: PriceNonNullableFields$9;
2520
+ total?: PriceNonNullableFields$9;
2521
+ totalWithGiftCard?: PriceNonNullableFields$9;
2522
+ totalWithoutGiftCard?: PriceNonNullableFields$9;
2523
+ totalAdditionalFees?: PriceNonNullableFields$9;
2524
+ }
2525
+ interface StreetAddressNonNullableFields$j {
2526
+ number: string;
2527
+ name: string;
2528
+ apt: string;
2529
+ }
2530
+ interface AddressNonNullableFields$h {
2531
+ streetAddress?: StreetAddressNonNullableFields$j;
2532
+ }
2533
+ interface VatIdNonNullableFields$b {
2534
+ id: string;
2535
+ type: VatType$d;
2536
+ }
2537
+ interface FullAddressContactDetailsNonNullableFields$d {
2538
+ vatId?: VatIdNonNullableFields$b;
2539
+ }
2540
+ interface AddressWithContactNonNullableFields$b {
2541
+ address?: AddressNonNullableFields$h;
2542
+ contactDetails?: FullAddressContactDetailsNonNullableFields$d;
2543
+ }
2544
+ interface PickupAddressNonNullableFields$5 {
2545
+ streetAddress?: StreetAddressNonNullableFields$j;
2546
+ }
2547
+ interface PickupDetailsNonNullableFields$f {
2548
+ address?: PickupAddressNonNullableFields$5;
2549
+ pickupMethod: PickupMethod$f;
2550
+ }
2551
+ interface DeliveryLogisticsNonNullableFields$f {
2552
+ shippingDestination?: AddressWithContactNonNullableFields$b;
2553
+ pickupDetails?: PickupDetailsNonNullableFields$f;
2554
+ }
2555
+ interface ShippingPriceNonNullableFields$d {
2556
+ price?: PriceNonNullableFields$9;
2557
+ totalPriceBeforeTax?: PriceNonNullableFields$9;
2558
+ totalPriceAfterTax?: PriceNonNullableFields$9;
2559
+ taxDetails?: ItemTaxFullDetailsNonNullableFields$d;
2560
+ discount?: PriceNonNullableFields$9;
2561
+ }
2562
+ interface ShippingInformationNonNullableFields$b {
2563
+ title: string;
2564
+ logistics?: DeliveryLogisticsNonNullableFields$f;
2565
+ cost?: ShippingPriceNonNullableFields$d;
2566
+ }
2567
+ interface OrderTaxBreakdownNonNullableFields$5 {
2568
+ taxName: string;
2569
+ taxType: string;
2570
+ jurisdiction: string;
2571
+ jurisdictionType: JurisdictionType$d;
2572
+ rate: string;
2573
+ aggregatedTaxAmount?: PriceNonNullableFields$9;
2574
+ aggregatedTaxableAmount?: PriceNonNullableFields$9;
2575
+ }
2576
+ interface OrderTaxInfoNonNullableFields$5 {
2577
+ totalTax?: PriceNonNullableFields$9;
2578
+ taxBreakdown: OrderTaxBreakdownNonNullableFields$5[];
2579
+ }
2580
+ interface CouponNonNullableFields$d {
2581
+ id: string;
2582
+ code: string;
2583
+ name: string;
2584
+ amount?: PriceNonNullableFields$9;
2585
+ }
2586
+ interface MerchantDiscountNonNullableFields$d {
2587
+ discountReason: DiscountReason$5;
2588
+ amount?: PriceNonNullableFields$9;
2589
+ }
2590
+ interface DiscountRuleNameNonNullableFields$d {
2591
+ original: string;
2592
+ }
2593
+ interface DiscountRuleNonNullableFields$d {
2594
+ id: string;
2595
+ name?: DiscountRuleNameNonNullableFields$d;
2596
+ amount?: PriceNonNullableFields$9;
2597
+ }
2598
+ interface LineItemDiscountNonNullableFields$d {
2599
+ id: string;
2600
+ totalDiscount?: PriceNonNullableFields$9;
2601
+ }
2602
+ interface AppliedDiscountNonNullableFields$d {
2603
+ coupon?: CouponNonNullableFields$d;
2604
+ merchantDiscount?: MerchantDiscountNonNullableFields$d;
2605
+ discountRule?: DiscountRuleNonNullableFields$d;
2606
+ discountType: DiscountType$d;
2607
+ lineItemIds: string[];
2608
+ lineItemDiscounts: LineItemDiscountNonNullableFields$d[];
2609
+ }
2610
+ interface ChannelInfoNonNullableFields$5 {
2611
+ type: ChannelType$b;
2612
+ }
2613
+ interface CustomFieldNonNullableFields$7 {
2614
+ title: string;
2615
+ }
2616
+ interface SubscriptionContractNonNullableFields$1 {
2617
+ subscriptionSettings?: V1SubscriptionSettingsNonNullableFields$1;
2618
+ lineItems: OrderLineItemNonNullableFields$5[];
2619
+ buyerInfo?: BuyerInfoNonNullableFields$b;
2620
+ weightUnit: WeightUnit$f;
2621
+ taxIncludedInPrices: boolean;
2622
+ priceSummary?: PriceSummaryNonNullableFields$d;
2623
+ billingInfo?: AddressWithContactNonNullableFields$b;
2624
+ shippingInfo?: ShippingInformationNonNullableFields$b;
2625
+ taxInfo?: OrderTaxInfoNonNullableFields$5;
2626
+ appliedDiscounts: AppliedDiscountNonNullableFields$d[];
2627
+ channelInfo?: ChannelInfoNonNullableFields$5;
2628
+ customFields: CustomFieldNonNullableFields$7[];
2629
+ recipientInfo?: AddressWithContactNonNullableFields$b;
2630
+ }
2631
+ interface GetSubscriptionContractResponseNonNullableFields$1 {
2632
+ subscriptionContract?: SubscriptionContractNonNullableFields$1;
2633
+ }
2634
+ interface QuerySubscriptionContractsResponseNonNullableFields$1 {
2635
+ subscriptionContracts: SubscriptionContractNonNullableFields$1[];
2636
+ }
2637
+
2638
+ /**
2639
+ * A SubscriptionContract is a ...
2640
+ * You can ...
2641
+ * Read more about SubscriptionContracts
2642
+ * in this [article](<LINK_TO_KB_ARTICLE>).
2643
+ */
2644
+ interface SubscriptionContract {
2645
+ /**
2646
+ * SubscriptionContract ID.
2647
+ * @readonly
2648
+ */
2649
+ _id?: string | null;
2650
+ /**
2651
+ * Revision number, which increments by 1 each time the SubscriptionContract is updated.
2652
+ * To prevent conflicting changes, the current revision must be passed when updating the SubscriptionContract.
2653
+ *
2654
+ * Ignored when creating a SubscriptionOrderContract.
2655
+ * @readonly
2656
+ */
2657
+ revision?: string | null;
2658
+ /**
2659
+ * Date and time the subscription contract was created in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
2660
+ * @readonly
2661
+ */
2662
+ _createdDate?: Date | null;
2663
+ /**
2664
+ * 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.
2665
+ * @readonly
2666
+ */
2667
+ _updatedDate?: Date | null;
2668
+ /** Subscription option description. For example, `"1kg of selected coffee, once a month"`. */
2669
+ description?: string | null;
2670
+ /** Subscription detailed information. */
2671
+ subscriptionSettings?: V1SubscriptionSettings;
2672
+ /**
2673
+ * Order line items.
2674
+ * @readonly
2675
+ */
2676
+ lineItems?: OrderLineItem$4[];
2677
+ /** Buyer information. */
2678
+ buyerInfo?: BuyerInfo$a;
2679
+ /**
2680
+ * Language for communication with the buyer. Defaults to the site language.
2681
+ * For a site that supports multiple languages, this is the language the buyer selected.
2682
+ */
2683
+ buyerLanguage?: string | null;
2684
+ /** Weight measurement unit - defaults to site's weight unit. */
2685
+ weightUnit?: WeightUnit$e;
2686
+ /** 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. */
2687
+ currency?: string | null;
2688
+ /**
2689
+ * Whether tax is included in line item prices.
2690
+ *
2691
+ * Default: `false`
2692
+ */
2693
+ taxIncludedInPrices?: boolean;
2694
+ /**
2695
+ * Order price summary.
2696
+ * @readonly
2697
+ */
2698
+ priceSummary?: PriceSummary$c;
2699
+ /** Billing address and contact details. */
2700
+ billingInfo?: AddressWithContact$a;
2701
+ /** Shipping info and selected shipping option details. */
2702
+ shippingInfo?: ShippingInformation$6;
2703
+ /** Applied discounts. */
2704
+ appliedDiscounts?: AppliedDiscount$c[];
2705
+ /** Information about the sales channel that submitted this order. */
2706
+ channelInfo?: ChannelInfo$4;
2707
+ /** Custom fields. */
2708
+ customFields?: CustomField$6[];
2709
+ /**
2710
+ * Order recipient address and contact details.
2711
+ *
2712
+ * This field may differ from the address in `shippingInfo.logistics` when:
2713
+ * + The chosen shipping option is pickup point or store pickup.
2714
+ * + No shipping option is selected.
2715
+ */
2716
+ recipientInfo?: AddressWithContact$a;
2717
+ /**
2718
+ * Custom field data for the subscription contract object.
2719
+ *
2720
+ * [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.
2721
+ */
2722
+ extendedFields?: ExtendedFields$e;
2723
+ /** Subscription option title. For example, `"Monthly coffee Subscription"`. */
2724
+ title?: string | null;
2725
+ }
2726
+ interface V1SubscriptionSettings {
2727
+ /** Frequency of recurring payment. */
2728
+ frequency?: SubscriptionFrequency$e;
2729
+ /** Interval of recurring payment. */
2730
+ interval?: number | null;
2731
+ /** Whether subscription is renewed automatically at the end of each period. */
2732
+ autoRenewal?: boolean;
2733
+ /** Number of billing cycles before subscription ends. Ignored if `autoRenewal: true`. */
2734
+ billingCycles?: number | null;
2735
+ /** Whether to allow the customer to cancel the subscription. */
2736
+ enableCustomerCancellation?: boolean;
2737
+ }
2738
+ declare enum SubscriptionFrequency$e {
2739
+ UNDEFINED = "UNDEFINED",
2740
+ DAY = "DAY",
2741
+ WEEK = "WEEK",
2742
+ MONTH = "MONTH",
2743
+ YEAR = "YEAR"
2744
+ }
2745
+ interface OrderLineItem$4 {
2746
+ /** Line item ID. */
2747
+ _id?: string;
2748
+ /**
2749
+ * Item name.
2750
+ * + Stores - `product.name`
2751
+ * + Bookings - `service.info.name`
2752
+ * + Events - `ticket.name`
2753
+ */
2754
+ productName?: ProductName$c;
2755
+ /**
2756
+ * References to the line item's origin catalog.
2757
+ * This field may be empty in the case of a custom line item.
2758
+ */
2759
+ catalogReference?: CatalogReference$i;
2760
+ /** Line item quantity. */
2761
+ quantity?: number;
2762
+ /**
2763
+ * Total discount for this line item's entire quantity.
2764
+ * @readonly
2765
+ */
2766
+ totalDiscount?: Price$8;
2767
+ /** Line item description lines. Used for display purposes for the cart, checkout and order. */
2768
+ descriptionLines?: DescriptionLine$c[];
2769
+ /** Line item image. */
2770
+ image?: string;
2771
+ /** Physical properties of the item. When relevant, contains information such as SKU and item weight. */
2772
+ physicalProperties?: PhysicalProperties$g;
2773
+ /** Item type. Either a preset type or custom. */
2774
+ itemType?: ItemType$e;
2775
+ /**
2776
+ * Fulfiller ID. Field is empty when the line item is self-fulfilled.
2777
+ * 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).
2778
+ */
2779
+ fulfillerId?: string | null;
2780
+ /**
2781
+ * Number of items that were refunded.
2782
+ * @readonly
2783
+ */
2784
+ refundQuantity?: number | null;
2785
+ /**
2786
+ * Number of items restocked.
2787
+ * @readonly
2788
+ */
2789
+ restockQuantity?: number | null;
2790
+ /** Line item price after line item discounts for display purposes. */
2791
+ price?: Price$8;
2792
+ /**
2793
+ * Line item price before line item discounts for display purposes. Defaults to `price` when not provided.
2794
+ * @readonly
2795
+ */
2796
+ priceBeforeDiscounts?: Price$8;
2797
+ /**
2798
+ * Total price after discounts, and before tax.
2799
+ * @readonly
2800
+ */
2801
+ totalPriceBeforeTax?: Price$8;
2802
+ /**
2803
+ * Total price after all discounts and tax.
2804
+ * @readonly
2805
+ */
2806
+ totalPriceAfterTax?: Price$8;
2807
+ /**
2808
+ * Type of selected payment option for current item. Defaults to `FULL_PAYMENT_ONLINE`.
2809
+ * + `FULL_PAYMENT_ONLINE` - The entire payment for this item happens as part of the checkout.
2810
+ * + `FULL_PAYMENT_OFFLINE` - The entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods.
2811
+ * + `MEMBERSHIP` - Payment for this item is done by charging a membership. When this option is used, `lineItem.price.amount` is 0.
2812
+ * + `DEPOSIT_ONLINE` - Partial payment for the given item to be paid upfront during the checkout. Eligible for catalog items with type `DEPOSIT_ONLINE` only.
2813
+ */
2814
+ paymentOption?: PaymentOptionType$e;
2815
+ /**
2816
+ * Deprecated. Use `taxInfo` instead.
2817
+ * This field will be removed on September 30, 2024.
2818
+ * Tax details for this line item.
2819
+ * @deprecated Deprecated. Use `taxInfo` instead.
2820
+ * This field will be removed on September 30, 2024.
2821
+ * Tax details for this line item.
2822
+ * @replacedBy tax_info
2823
+ * @targetRemovalDate 2024-09-30
2824
+ */
2825
+ taxDetails?: ItemTaxFullDetails$c;
2826
+ /** Represents all the relevant tax details for a specific line item. */
2827
+ taxInfo?: LineItemTaxInfo$4;
2828
+ /** Digital file identifier, relevant only for items with type DIGITAL. */
2829
+ digitalFile?: DigitalFile$4;
2830
+ /** Subscription info. */
2831
+ subscriptionInfo?: SubscriptionInfo$4;
2832
+ /** Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - "Starts at $67". */
2833
+ priceDescription?: PriceDescription$c;
2834
+ /**
2835
+ * Item's price amount to be charged during checkout. Relevant for items with a `paymentOption` value of `"DEPOSIT_ONLINE"`.
2836
+ * @readonly
2837
+ */
2838
+ depositAmount?: Price$8;
2839
+ }
2840
+ interface ProductName$c {
2841
+ /**
2842
+ * __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).
2843
+ *
2844
+ * Min: 1 character.
2845
+ * Max: 200 characters.
2846
+ */
2847
+ original?: string;
2848
+ /**
2849
+ * Item name translated into the buyer's language.
2850
+ *
2851
+ * Min: 1 character.
2852
+ * Max: 400 characters.
2853
+ * Default: Same as `original`.
2854
+ */
2855
+ translated?: string | null;
2856
+ }
2857
+ /** Used for grouping line items. Sent when an item is added to a cart, checkout, or order. */
2858
+ interface CatalogReference$i {
2859
+ /** ID of the item within the catalog it belongs to. */
2860
+ catalogItemId?: string;
2861
+ /**
2862
+ * ID of the app providing the catalog.
2863
+ *
2864
+ * You can get your app's ID from its page in the [Wix Dev Center](https://dev.wix.com/apps).
2865
+ *
2866
+ * For items from Wix catalogs, the following values always apply:
2867
+ * + Wix Stores: `"215238eb-22a5-4c36-9e7b-e7c08025e04e"`
2868
+ * + Wix Bookings: `"13d21c63-b5ec-5912-8397-c3a5ddb27a97"`
2869
+ * + Wix Restaurants: `"9a5d83fd-8570-482e-81ab-cfa88942ee60"`
2870
+ */
2871
+ appId?: string;
2872
+ /**
2873
+ * 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.
2874
+ *
2875
+ * 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).
2876
+ */
2877
+ options?: Record<string, any> | null;
2878
+ }
2879
+ interface Price$8 {
2880
+ /** Amount. */
2881
+ amount?: string;
2882
+ /**
2883
+ * Amount formatted with currency symbol.
2884
+ * @readonly
2885
+ */
2886
+ formattedAmount?: string;
2887
+ }
2888
+ interface DescriptionLine$c extends DescriptionLineValueOneOf$c, DescriptionLineDescriptionLineValueOneOf$c {
2889
+ /** Description line plain text value. */
2890
+ plainText?: PlainTextValue$c;
2891
+ /** Description line color value. */
2892
+ colorInfo?: Color$c;
2893
+ /** Description line name. */
2894
+ name?: DescriptionLineName$c;
2895
+ }
2896
+ /** @oneof */
2897
+ interface DescriptionLineValueOneOf$c {
2898
+ /** Description line plain text value. */
2899
+ plainText?: PlainTextValue$c;
2900
+ /** Description line color value. */
2901
+ colorInfo?: Color$c;
2902
+ }
2903
+ /** @oneof */
2904
+ interface DescriptionLineDescriptionLineValueOneOf$c {
2905
+ }
2906
+ interface DescriptionLineName$c {
2907
+ /** 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). */
2908
+ original?: string;
2909
+ /**
2910
+ * Description line name translated into the buyer's language.
2911
+ *
2912
+ * Default: Same as `original`.
2913
+ */
2914
+ translated?: string | null;
2915
+ }
2916
+ interface PlainTextValue$c {
2917
+ /** 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). */
2918
+ original?: string;
2919
+ /**
2920
+ * Description line plain text value translated into the buyer's language.
2921
+ *
2922
+ * Default: Same as `original`.
2923
+ */
2924
+ translated?: string | null;
2925
+ }
2926
+ interface Color$c {
2927
+ /** 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). */
2928
+ original?: string;
2929
+ /**
2930
+ * Description line color name translated into the buyer's language.
2931
+ *
2932
+ * Default: Same as `original`.
2933
+ */
2934
+ translated?: string | null;
2935
+ /** HEX or RGB color code for display. */
2936
+ code?: string | null;
2937
+ }
2938
+ declare enum DescriptionLineType$c {
2939
+ UNRECOGNISED = "UNRECOGNISED",
2940
+ PLAIN_TEXT = "PLAIN_TEXT",
2941
+ COLOR = "COLOR"
2942
+ }
2943
+ interface PhysicalProperties$g {
2944
+ /** Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request. */
2945
+ weight?: number | null;
2946
+ /** Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku). */
2947
+ sku?: string | null;
2948
+ /** Whether this line item is shippable. */
2949
+ shippable?: boolean;
2950
+ }
2951
+ interface ItemType$e extends ItemTypeItemTypeDataOneOf$e {
2952
+ /** Preset item type. */
2953
+ preset?: ItemTypeItemType$e;
2954
+ /** Custom item type. When none of the preset types are suitable, specifies the custom type. */
2955
+ custom?: string;
2956
+ }
2957
+ /** @oneof */
2958
+ interface ItemTypeItemTypeDataOneOf$e {
2959
+ /** Preset item type. */
2960
+ preset?: ItemTypeItemType$e;
2961
+ /** Custom item type. When none of the preset types are suitable, specifies the custom type. */
2962
+ custom?: string;
2963
+ }
2964
+ declare enum ItemTypeItemType$e {
2965
+ UNRECOGNISED = "UNRECOGNISED",
2966
+ PHYSICAL = "PHYSICAL",
2967
+ DIGITAL = "DIGITAL",
2968
+ GIFT_CARD = "GIFT_CARD",
2969
+ SERVICE = "SERVICE"
2970
+ }
2971
+ /** Type of selected payment option for catalog item */
2972
+ declare enum PaymentOptionType$e {
2973
+ /** The entire payment for this item happens as part of the checkout. */
2974
+ FULL_PAYMENT_ONLINE = "FULL_PAYMENT_ONLINE",
2975
+ /** The entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods. */
2976
+ FULL_PAYMENT_OFFLINE = "FULL_PAYMENT_OFFLINE",
2977
+ /** Payment for this item is done by charging a membership. When selected, `price` is `0`. */
2978
+ MEMBERSHIP = "MEMBERSHIP",
2979
+ /** Partial payment to be paid upfront during the checkout. Initial amount to be paid for each line item is specified in `depositAmount`. */
2980
+ DEPOSIT_ONLINE = "DEPOSIT_ONLINE",
2981
+ /** 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`. */
2982
+ MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
2983
+ }
2984
+ interface ItemTaxFullDetails$c {
2985
+ /** Taxable amount of this line item. */
2986
+ taxableAmount?: Price$8;
2987
+ /** Tax rate percentage, as a decimal numeral between 0 and 1. For example, `"0.13"`. */
2988
+ taxRate?: string;
2989
+ /** The calculated tax, based on the `taxableAmount` and `taxRate`. */
2990
+ totalTax?: Price$8;
2991
+ }
2992
+ interface LineItemTaxInfo$4 {
2993
+ /** Calculated tax, based on `taxable_amount` and `tax_rate`. */
2994
+ taxAmount?: Price$8;
2995
+ /** Amount for which tax is calculated. */
2996
+ taxableAmount?: Price$8;
2997
+ /** Tax rate %, as a decimal point. */
2998
+ taxRate?: string | null;
2999
+ /**
3000
+ * Tax group ID.
3001
+ * Learn more about [Tax Groups](https://dev.wix.com/docs/rest/business-management/payments/tax/tax-groups/introduction).
3002
+ */
3003
+ taxGroupId?: string | null;
3004
+ /** Indicates whether the price already includes tax. */
3005
+ taxIncludedInPrice?: boolean;
3006
+ /** Tax information for a line item. */
3007
+ taxBreakdown?: LineItemTaxBreakdown$4[];
3008
+ }
3009
+ /**
3010
+ * TaxBreakdown represents tax information for a line item.
3011
+ * It holds the tax amount and the tax rate for each tax authority that apply on the line item.
3012
+ */
3013
+ interface LineItemTaxBreakdown$4 {
3014
+ /** Jurisdiction that taxes were calculated for. For example, "New York", or "Quebec". */
3015
+ jurisdiction?: string | null;
3016
+ /** Tax rate used for this jurisdiction, as a decimal. For example, 10% tax is 0.1000. */
3017
+ rate?: string | null;
3018
+ /** Amount of tax calculated for this line item. */
3019
+ taxAmount?: Price$8;
3020
+ /** The type of tax that was calculated. Depends on the jurisdiction's tax laws. For example, "Sales Tax", "Income Tax", "Value Added Tax", etc. */
3021
+ taxType?: string | null;
3022
+ /**
3023
+ * The name of the tax against which this tax amount was calculated. For example, "NY State Sales Tax", "Quebec GST", etc.
3024
+ * This name should be explicit enough to allow the merchant to understand what tax was calculated.
3025
+ */
3026
+ taxName?: string | null;
3027
+ /** Type of jurisdiction that taxes were calculated for. */
3028
+ jurisdictionType?: JurisdictionType$c;
3029
+ /** Non-taxable amount of the line item price. */
3030
+ nonTaxableAmount?: Price$8;
3031
+ /** Taxable amount of the line item price. */
3032
+ taxableAmount?: Price$8;
3033
+ }
3034
+ /** JurisdictionType represents the type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
3035
+ declare enum JurisdictionType$c {
3036
+ UNDEFINED = "UNDEFINED",
3037
+ COUNTRY = "COUNTRY",
3038
+ STATE = "STATE",
3039
+ COUNTY = "COUNTY",
3040
+ CITY = "CITY",
3041
+ SPECIAL = "SPECIAL"
3042
+ }
3043
+ interface DigitalFile$4 {
3044
+ /** ID of the secure file in media. */
3045
+ fileId?: string;
3046
+ /** Link will exist after the digital links have been generated on the order. */
3047
+ link?: string | null;
3048
+ /**
3049
+ * Link expiration time and date.
3050
+ * @readonly
3051
+ */
3052
+ expirationDate?: Date | null;
3053
+ }
3054
+ interface SubscriptionInfo$4 {
3055
+ /** Subscription ID. */
3056
+ _id?: string | null;
3057
+ /** Subscription cycle. For example, if this order is for the 3rd cycle of a subscription, value will be `3`. */
3058
+ cycleNumber?: number;
3059
+ /** Subscription option title. For example, `"Monthly coffee Subscription"`. */
3060
+ subscriptionOptionTitle?: string;
3061
+ /** Subscription option description. For example, `"1kg of selected coffee, once a month"`. */
3062
+ subscriptionOptionDescription?: string | null;
3063
+ /** Subscription detailed information. */
3064
+ subscriptionSettings?: SubscriptionSettings$6;
3065
+ }
3066
+ interface SubscriptionSettings$6 {
3067
+ /** Frequency of recurring payment. */
3068
+ frequency?: V2SubscriptionFrequency;
3069
+ /** Interval of recurring payment. */
3070
+ interval?: number | null;
3071
+ /** Whether subscription is renewed automatically at the end of each period. */
3072
+ autoRenewal?: boolean;
3073
+ /** Number of billing cycles before subscription ends. Ignored if `autoRenewal: true`. */
3074
+ billingCycles?: number | null;
3075
+ }
3076
+ /** Frequency unit of recurring payment */
3077
+ declare enum V2SubscriptionFrequency {
3078
+ UNDEFINED = "UNDEFINED",
3079
+ DAY = "DAY",
3080
+ WEEK = "WEEK",
3081
+ MONTH = "MONTH",
3082
+ YEAR = "YEAR"
3083
+ }
3084
+ interface PriceDescription$c {
3085
+ /** __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). */
3086
+ original?: string;
3087
+ /**
3088
+ * Price description translated into the buyer's language.
3089
+ *
3090
+ * Default: Same as `original`.
3091
+ */
3092
+ translated?: string | null;
3093
+ }
3094
+ declare enum TaxableAddressType$c {
3095
+ UNKNOWN_TAXABLE_ADDRESS = "UNKNOWN_TAXABLE_ADDRESS",
3096
+ BUSINESS = "BUSINESS",
3097
+ BILLING = "BILLING",
3098
+ SHIPPING = "SHIPPING"
3099
+ }
3100
+ /** Buyer Info */
3101
+ interface BuyerInfo$a extends BuyerInfoIdOneOf$a {
3102
+ /** Visitor ID (if site visitor is not a member). */
3103
+ visitorId?: string;
3104
+ /** Member ID (if site visitor is a site member). */
3105
+ memberId?: string;
3106
+ /** 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). */
3107
+ contactId?: string | null;
3108
+ /** Buyer email address. */
3109
+ email?: string | null;
3110
+ }
3111
+ /** @oneof */
3112
+ interface BuyerInfoIdOneOf$a {
3113
+ /** Visitor ID (if site visitor is not a member). */
3114
+ visitorId?: string;
3115
+ /** Member ID (if site visitor is a site member). */
3116
+ memberId?: string;
3117
+ }
3118
+ declare enum WeightUnit$e {
3119
+ /** Weight unit can't be classified, due to an error */
3120
+ UNSPECIFIED_WEIGHT_UNIT = "UNSPECIFIED_WEIGHT_UNIT",
3121
+ /** Kilograms */
3122
+ KG = "KG",
3123
+ /** Pounds */
3124
+ LB = "LB"
3125
+ }
3126
+ interface PriceSummary$c {
3127
+ /** Subtotal of all the line items, before discounts and before tax. */
3128
+ subtotal?: Price$8;
3129
+ /** Total shipping price, before discounts and before tax. */
3130
+ shipping?: Price$8;
3131
+ /** Total tax on this order. */
3132
+ tax?: Price$8;
3133
+ /** Total calculated discount value. */
3134
+ discount?: Price$8;
3135
+ /** Order’s total price after discounts and tax. */
3136
+ total?: Price$8;
3137
+ /** Total price of additional fees before tax. */
3138
+ totalAdditionalFees?: Price$8;
3139
+ }
3140
+ /** Billing Info and shipping details */
3141
+ interface AddressWithContact$a {
3142
+ /** Address. */
3143
+ address?: Address$g;
3144
+ /** Contact details. */
3145
+ contactDetails?: FullAddressContactDetails$e;
3146
+ }
3147
+ /** Physical address */
3148
+ interface Address$g {
3149
+ /** Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format. */
3150
+ country?: string | null;
3151
+ /** Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://www.iso.org/standard/72483.html) format. */
3152
+ subdivision?: string | null;
3153
+ /** City name. */
3154
+ city?: string | null;
3155
+ /** Postal or zip code. */
3156
+ postalCode?: string | null;
3157
+ /** Street address. */
3158
+ streetAddress?: StreetAddress$i;
3159
+ /** Main address line (usually street name and number). */
3160
+ addressLine1?: string | null;
3161
+ /** Free text providing more detailed address info. Usually contains apt, suite, floor. */
3162
+ addressLine2?: string | null;
3163
+ }
3164
+ interface StreetAddress$i {
3165
+ /** Street number. */
3166
+ number?: string;
3167
+ /** Street name. */
3168
+ name?: string;
3169
+ }
3170
+ /** Full contact details for an address */
3171
+ interface FullAddressContactDetails$e {
3172
+ /** First name. */
3173
+ firstName?: string | null;
3174
+ /** Last name. */
3175
+ lastName?: string | null;
3176
+ /** Phone number. */
3177
+ phone?: string | null;
3178
+ /** Company name. */
3179
+ company?: string | null;
3180
+ /** Tax information (for Brazil only). If ID is provided, `vatId.type` must also be set, `UNSPECIFIED` is not allowed. */
3181
+ vatId?: VatId$c;
3182
+ }
3183
+ interface VatId$c {
3184
+ /** Customer's tax ID. */
3185
+ _id?: string;
1219
3186
  /**
1220
- * App ID of the Wix or 3rd-party app providing the algorithm.
3187
+ * Tax type.
1221
3188
  *
1222
- * 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>.
3189
+ * Supported values:
3190
+ * + `CPF`: for individual tax payers
3191
+ * + `CNPJ`: for corporations
1223
3192
  */
1224
- appId?: string;
1225
- }
1226
- interface ListAvailableAlgorithmsRequest$1 {
3193
+ type?: VatType$c;
1227
3194
  }
1228
- interface ListAvailableAlgorithmsResponse$1 {
1229
- /** Algorithms available for use on your Wix site or project. See the method description for more information. */
1230
- availableAlgorithms?: AlgorithmInfo$1[];
3195
+ /** tax info types */
3196
+ declare enum VatType$c {
3197
+ UNSPECIFIED = "UNSPECIFIED",
3198
+ /** CPF - for individual tax payers. */
3199
+ CPF = "CPF",
3200
+ /** CNPJ - for corporations */
3201
+ CNPJ = "CNPJ"
1231
3202
  }
1232
- interface AlgorithmInfo$1 {
1233
- /** How the algorithm is configured. */
1234
- config?: AlgorithmConfig$1;
3203
+ interface ShippingInformation$6 {
3204
+ /** App Def Id of external provider which was a source of shipping info */
3205
+ carrierId?: string | null;
3206
+ /** Unique code (or ID) of selected shipping option. For example, `"usps_std_overnight"``. */
3207
+ code?: string | null;
1235
3208
  /**
1236
- * The app ID of the application providing the algorithm.
1237
- *
1238
- * 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>.
3209
+ * Shipping option title.
3210
+ * For example, `"USPS Standard Overnight Delivery"`, `"Standard"` or `"First-Class Package International"`.
1239
3211
  */
1240
- appId?: string;
3212
+ title?: string;
3213
+ /** Shipping logistics. */
3214
+ logistics?: DeliveryLogistics$e;
3215
+ /** Shipping costs. */
3216
+ cost?: ShippingPrice$c;
3217
+ /** Shipping region. */
3218
+ region?: ShippingRegion$c;
3219
+ }
3220
+ interface DeliveryLogistics$e extends DeliveryLogisticsAddressOneOf$2 {
3221
+ /** Shipping address and contact details. */
3222
+ shippingDestination?: AddressWithContact$a;
3223
+ /** Pickup details. */
3224
+ pickupDetails?: PickupDetails$e;
3225
+ /** Expected delivery time in free text. For example, `"3-5 business days"`. */
3226
+ deliveryTime?: string | null;
3227
+ /** Instructions for carrier. For example, `"Please knock on the door. If unanswered, please call contact number. Thanks."`. */
3228
+ instructions?: string | null;
1241
3229
  /**
1242
- * App IDs of catalogs to which the algorithm can be applied.
1243
- *
1244
- * 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>.
3230
+ * Deprecated - Latest expected delivery date and time in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
3231
+ * @deprecated
1245
3232
  */
1246
- catalogAppIds?: string[];
3233
+ deliverByDate?: Date | null;
3234
+ /** Expected delivery time. */
3235
+ deliveryTimeSlot?: DeliveryTimeSlot$6;
1247
3236
  }
1248
- interface AlgorithmConfig$1 {
1249
- /** Algorithm name. This value is not translatable. */
1250
- name?: string;
1251
- /** 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. */
1252
- description?: string;
1253
- /** 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. */
1254
- additionalInfo?: string | null;
3237
+ /** @oneof */
3238
+ interface DeliveryLogisticsAddressOneOf$2 {
3239
+ /** Shipping address and contact details. */
3240
+ shippingDestination?: AddressWithContact$a;
3241
+ /** Pickup details. */
3242
+ pickupDetails?: PickupDetails$e;
3243
+ }
3244
+ interface PickupDetails$e {
3245
+ /** Pickup address. */
3246
+ address?: PickupAddress$4;
3247
+ /** Pickup method */
3248
+ pickupMethod?: PickupMethod$e;
3249
+ }
3250
+ /** Physical address */
3251
+ interface PickupAddress$4 {
3252
+ /** Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format. */
3253
+ country?: string | null;
3254
+ /** Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://www.iso.org/standard/72483.html) format. */
3255
+ subdivision?: string | null;
3256
+ /** City name. */
3257
+ city?: string | null;
3258
+ /** Postal or zip code. */
3259
+ postalCode?: string | null;
3260
+ /** Street address object, with number, name, and apartment number in separate fields. */
3261
+ streetAddress?: StreetAddress$i;
3262
+ /** Main address line (usually street name and number). */
3263
+ addressLine1?: string | null;
3264
+ /** Free text providing more detailed address info. Usually contains apt, suite, floor. */
3265
+ addressLine2?: string | null;
3266
+ }
3267
+ declare enum PickupMethod$e {
3268
+ UNKNOWN_METHOD = "UNKNOWN_METHOD",
3269
+ STORE_PICKUP = "STORE_PICKUP",
3270
+ PICKUP_POINT = "PICKUP_POINT"
3271
+ }
3272
+ interface DeliveryTimeSlot$6 {
3273
+ /** Delivery slot starting time. */
3274
+ from?: Date | null;
3275
+ /** Delivery slot ending time. */
3276
+ to?: Date | null;
3277
+ }
3278
+ interface ShippingPrice$c {
3279
+ /** Shipping price for display purposes. */
3280
+ price?: Price$8;
1255
3281
  /**
1256
- * Algorithms may have the following types:
1257
- * * `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.
1258
- * * `GLOBAL` - This type of algorithm provides general recommendations based on site or project statistics. For example, bestsellers or new arrivals.
3282
+ * Total price of shipping after discounts (when relevant), and before tax.
3283
+ * @readonly
1259
3284
  */
1260
- algorithmType?: AlgorithmType$1;
1261
- /** 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. */
1262
- algorithmId?: string;
3285
+ totalPriceBeforeTax?: Price$8;
3286
+ /**
3287
+ * Shipping price after all discounts (if any exist), and after tax.
3288
+ * @readonly
3289
+ */
3290
+ totalPriceAfterTax?: Price$8;
3291
+ /** Tax details. */
3292
+ taxDetails?: ItemTaxFullDetails$c;
3293
+ /**
3294
+ * Shipping discount before tax.
3295
+ * @readonly
3296
+ */
3297
+ discount?: Price$8;
1263
3298
  }
1264
- declare enum AlgorithmType$1 {
1265
- UNSPECIFIED = "UNSPECIFIED",
1266
- RELATED_ITEMS = "RELATED_ITEMS",
1267
- GLOBAL = "GLOBAL"
3299
+ interface ShippingRegion$c {
3300
+ /** Name of shipping region. For example, `"Metropolitan London"`, or `"Outer Melbourne suburbs"`. */
3301
+ name?: string | null;
1268
3302
  }
1269
- interface GetRecommendationRequest$1 {
1270
- /** The set of items for which to get recommendations. Required if the `algorithmType` is `RELATED_ITEMS`. */
1271
- items?: CatalogReference$j[];
3303
+ interface AppliedDiscount$c extends AppliedDiscountDiscountSourceOneOf$c {
3304
+ /** Applied coupon info. */
3305
+ coupon?: Coupon$c;
3306
+ /** Merchant discount. */
3307
+ merchantDiscount?: MerchantDiscount$c;
3308
+ /** Automatic Discount */
3309
+ discountRule?: DiscountRule$c;
1272
3310
  /**
1273
- * A list of algorithms checked in a specific order determined by their `appID` and their position in the `algorithms` array.
1274
- * See the method description for more information.
1275
- *
1276
- * If no algorithm is able to return at least `minimumRecommendedItems` items, an empty array is returned.
3311
+ * Discount type.
3312
+ * * `"GLOBAL"` - discount applies to entire order.
3313
+ * * `"SPECIFIC-ITEMS"` - discount applies to specific items.
3314
+ * * `"SHIPPING"` - discount applies to shipping. For example, free shipping.
1277
3315
  */
1278
- algorithms: Algorithm$1[];
3316
+ discountType?: DiscountType$c;
1279
3317
  /**
1280
- * The minimum number of items that must be recommended by the algorithm for those items to be returned in the response.
1281
- *
1282
- * Max: `100`
3318
+ * IDs of line items discount applies to.
3319
+ * Deprecated. Use `line_item_discounts` instead.
3320
+ * @deprecated IDs of line items discount applies to.
3321
+ * Deprecated. Use `line_item_discounts` instead.
3322
+ * @replacedBy line_item_discounts
3323
+ * @targetRemovalDate 2024-10-30
1283
3324
  */
1284
- minimumRecommendedItems?: number;
3325
+ lineItemIds?: string[];
3326
+ /** Discount id. */
3327
+ _id?: string | null;
1285
3328
  }
1286
- interface GetRecommendationResponse$1 {
1287
- /** 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. */
1288
- recommendation?: Recommendation$1;
3329
+ /** @oneof */
3330
+ interface AppliedDiscountDiscountSourceOneOf$c {
3331
+ /** Applied coupon info. */
3332
+ coupon?: Coupon$c;
3333
+ /** Merchant discount. */
3334
+ merchantDiscount?: MerchantDiscount$c;
3335
+ /** Automatic Discount */
3336
+ discountRule?: DiscountRule$c;
1289
3337
  }
1290
- interface AlgorithmConfigNonNullableFields$1 {
1291
- name: string;
1292
- description: string;
1293
- algorithmType: AlgorithmType$1;
1294
- algorithmId: string;
3338
+ declare enum DiscountType$c {
3339
+ GLOBAL = "GLOBAL",
3340
+ SPECIFIC_ITEMS = "SPECIFIC_ITEMS",
3341
+ SHIPPING = "SHIPPING"
1295
3342
  }
1296
- interface AlgorithmInfoNonNullableFields$1 {
1297
- config?: AlgorithmConfigNonNullableFields$1;
1298
- appId: string;
1299
- catalogAppIds: string[];
3343
+ /** Coupon */
3344
+ interface Coupon$c {
3345
+ /** Coupon ID. */
3346
+ _id?: string;
3347
+ /** Coupon code. */
3348
+ code?: string;
3349
+ /** Coupon name. */
3350
+ name?: string;
3351
+ /** Coupon value. */
3352
+ amount?: Price$8;
1300
3353
  }
1301
- interface ListAvailableAlgorithmsResponseNonNullableFields$1 {
1302
- availableAlgorithms: AlgorithmInfoNonNullableFields$1[];
3354
+ interface MerchantDiscount$c extends MerchantDiscountMerchantDiscountReasonOneOf$4 {
3355
+ /**
3356
+ * Pre-defined discount reason (optional).
3357
+ * * `"ITEMS_EXCHANGE"` - exchange balance acquired as a result of items exchange.
3358
+ */
3359
+ discountReason?: DiscountReason$4;
3360
+ /** Discount description as free text (optional). */
3361
+ description?: string | null;
3362
+ /** Discount amount. */
3363
+ amount?: Price$8;
1303
3364
  }
1304
- interface CatalogReferenceNonNullableFields$f {
1305
- catalogItemId: string;
1306
- appId: string;
3365
+ /** @oneof */
3366
+ interface MerchantDiscountMerchantDiscountReasonOneOf$4 {
3367
+ /**
3368
+ * Pre-defined discount reason (optional).
3369
+ * * `"ITEMS_EXCHANGE"` - exchange balance acquired as a result of items exchange.
3370
+ */
3371
+ discountReason?: DiscountReason$4;
3372
+ /** Discount description as free text (optional). */
3373
+ description?: string | null;
1307
3374
  }
1308
- interface AlgorithmNonNullableFields$1 {
1309
- id: string;
1310
- appId: string;
3375
+ declare enum DiscountReason$4 {
3376
+ UNSPECIFIED = "UNSPECIFIED",
3377
+ EXCHANGED_ITEMS = "EXCHANGED_ITEMS"
1311
3378
  }
1312
- interface RecommendationNonNullableFields$1 {
1313
- items: CatalogReferenceNonNullableFields$f[];
1314
- algorithm?: AlgorithmNonNullableFields$1;
3379
+ interface DiscountRule$c {
3380
+ /** Discount rule ID */
3381
+ _id?: string;
3382
+ /** Discount rule name */
3383
+ name?: DiscountRuleName$c;
3384
+ /** Discount value. */
3385
+ amount?: Price$8;
1315
3386
  }
1316
- interface GetRecommendationResponseNonNullableFields$1 {
1317
- recommendation?: RecommendationNonNullableFields$1;
3387
+ interface DiscountRuleName$c {
3388
+ /** Original discount rule name (in site's default language). */
3389
+ original?: string;
3390
+ /** Translated discount rule name according to buyer language. Defaults to `original` when not provided. */
3391
+ translated?: string | null;
1318
3392
  }
1319
-
1320
- interface Recommendation {
1321
- /** Recommended items. */
1322
- items?: CatalogReference$i[];
1323
- /** The algorithm used to provide the recommendation. */
1324
- algorithm?: Algorithm;
3393
+ interface ChannelInfo$4 {
3394
+ /** Sales channel that submitted the order. */
3395
+ type?: ChannelType$a;
3396
+ /** Reference to an order ID from an external system. */
3397
+ externalOrderId?: string | null;
3398
+ /** URL to the order in the external system. */
3399
+ externalOrderUrl?: string | null;
1325
3400
  }
1326
- /** Used for grouping line items. Sent when an item is added to a cart, checkout, or order. */
1327
- interface CatalogReference$i {
1328
- /** ID of the item within the catalog it belongs to. */
1329
- catalogItemId?: string;
3401
+ declare enum ChannelType$a {
3402
+ UNSPECIFIED = "UNSPECIFIED",
3403
+ WEB = "WEB",
3404
+ POS = "POS",
3405
+ EBAY = "EBAY",
3406
+ AMAZON = "AMAZON",
3407
+ OTHER_PLATFORM = "OTHER_PLATFORM",
3408
+ WIX_APP_STORE = "WIX_APP_STORE",
3409
+ WIX_INVOICES = "WIX_INVOICES",
3410
+ BACKOFFICE_MERCHANT = "BACKOFFICE_MERCHANT",
3411
+ WISH = "WISH",
3412
+ CLASS_PASS = "CLASS_PASS",
3413
+ GLOBAL_E = "GLOBAL_E",
3414
+ FACEBOOK = "FACEBOOK",
3415
+ ETSY = "ETSY",
3416
+ TIKTOK = "TIKTOK",
3417
+ FAIRE_COM = "FAIRE_COM"
3418
+ }
3419
+ interface CustomField$6 {
3420
+ /** Custom field value. */
3421
+ value?: any;
3422
+ /** Custom field title. */
3423
+ title?: string;
3424
+ /** Translated custom field title. */
3425
+ translatedTitle?: string | null;
3426
+ }
3427
+ interface ExtendedFields$e {
1330
3428
  /**
1331
- * ID of the app providing the catalog.
1332
- *
1333
- * You can get your app's ID from its page in the [Wix Dev Center](https://dev.wix.com/apps).
3429
+ * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
3430
+ * The value of each key is structured according to the schema defined when the extended fields were configured.
1334
3431
  *
1335
- * For items from Wix catalogs, the following values always apply:
1336
- * + Wix Stores: `"215238eb-22a5-4c36-9e7b-e7c08025e04e"`
1337
- * + Wix Bookings: `"13d21c63-b5ec-5912-8397-c3a5ddb27a97"`
1338
- * + Wix Restaurants: `"9a5d83fd-8570-482e-81ab-cfa88942ee60"`
1339
- */
1340
- appId?: string;
1341
- /**
1342
- * 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.
3432
+ * You can only access fields for which you have the appropriate permissions.
1343
3433
  *
1344
- * 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).
3434
+ * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
1345
3435
  */
1346
- options?: Record<string, any> | null;
3436
+ namespaces?: Record<string, Record<string, any>>;
1347
3437
  }
1348
- interface Algorithm {
1349
- /** Algorithm ID defined by the app providing the algorithm. */
1350
- _id?: string;
1351
- /**
1352
- * App ID of the Wix or 3rd-party app providing the algorithm.
1353
- *
1354
- * 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>.
1355
- */
1356
- appId?: string;
3438
+ interface GetSubscriptionContractRequest {
3439
+ /** ID of the SubscriptionContract to retrieve. */
3440
+ subscriptionContractId: string;
1357
3441
  }
1358
- interface ListAvailableAlgorithmsRequest {
3442
+ interface GetSubscriptionContractResponse {
3443
+ /** The requested SubscriptionContract. */
3444
+ subscriptionContract?: SubscriptionContract;
1359
3445
  }
1360
- interface ListAvailableAlgorithmsResponse {
1361
- /** Algorithms available for use on your Wix site or project. See the method description for more information. */
1362
- availableAlgorithms?: AlgorithmInfo[];
3446
+ interface QuerySubscriptionContractsRequest {
3447
+ /** WQL expression. */
3448
+ query?: CursorQuery$c;
1363
3449
  }
1364
- interface AlgorithmInfo {
1365
- /** How the algorithm is configured. */
1366
- config?: AlgorithmConfig;
3450
+ interface CursorQuery$c extends CursorQueryPagingMethodOneOf$c {
3451
+ /** 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`. */
3452
+ cursorPaging?: CursorPaging$k;
1367
3453
  /**
1368
- * The app ID of the application providing the algorithm.
1369
- *
1370
- * 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>.
3454
+ * Filter object in the following format:
3455
+ * `"filter" : {
3456
+ * "fieldName1": "value1",
3457
+ * "fieldName2":{"$operator":"value2"}
3458
+ * }`
3459
+ * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
3460
+ * Learn more about the [filter format](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
1371
3461
  */
1372
- appId?: string;
3462
+ filter?: Record<string, any> | null;
1373
3463
  /**
1374
- * App IDs of catalogs to which the algorithm can be applied.
1375
- *
1376
- * 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>.
3464
+ * Sort object in the following format:
3465
+ * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
3466
+ * Learn more about the [sort format](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
1377
3467
  */
1378
- catalogAppIds?: string[];
3468
+ sort?: Sorting$k[];
1379
3469
  }
1380
- interface AlgorithmConfig {
1381
- /** Algorithm name. This value is not translatable. */
1382
- name?: string;
1383
- /** 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. */
1384
- description?: string;
1385
- /** 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. */
1386
- additionalInfo?: string | null;
1387
- /**
1388
- * Algorithms may have the following types:
1389
- * * `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.
1390
- * * `GLOBAL` - This type of algorithm provides general recommendations based on site or project statistics. For example, bestsellers or new arrivals.
1391
- */
1392
- algorithmType?: AlgorithmType;
1393
- /** 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. */
1394
- algorithmId?: string;
3470
+ /** @oneof */
3471
+ interface CursorQueryPagingMethodOneOf$c {
3472
+ /** 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`. */
3473
+ cursorPaging?: CursorPaging$k;
1395
3474
  }
1396
- declare enum AlgorithmType {
1397
- UNSPECIFIED = "UNSPECIFIED",
1398
- RELATED_ITEMS = "RELATED_ITEMS",
1399
- GLOBAL = "GLOBAL"
3475
+ interface Sorting$k {
3476
+ /** Name of the field to sort by. */
3477
+ fieldName?: string;
3478
+ /** Sort order. */
3479
+ order?: SortOrder$k;
1400
3480
  }
1401
- interface GetRecommendationRequest {
1402
- /** The set of items for which to get recommendations. Required if the `algorithmType` is `RELATED_ITEMS`. */
1403
- items?: CatalogReference$i[];
3481
+ declare enum SortOrder$k {
3482
+ ASC = "ASC",
3483
+ DESC = "DESC"
3484
+ }
3485
+ interface CursorPaging$k {
3486
+ /** Maximum number of items to return in the results. */
3487
+ limit?: number | null;
1404
3488
  /**
1405
- * A list of algorithms checked in a specific order determined by their `appID` and their position in the `algorithms` array.
1406
- * See the method description for more information.
3489
+ * Pointer to the next or previous page in the list of results.
1407
3490
  *
1408
- * If no algorithm is able to return at least `minimumRecommendedItems` items, an empty array is returned.
3491
+ * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
3492
+ * Not relevant for the first request.
1409
3493
  */
1410
- algorithms: Algorithm[];
3494
+ cursor?: string | null;
3495
+ }
3496
+ interface QuerySubscriptionContractsResponse {
3497
+ /** List of SubscriptionContracts. */
3498
+ subscriptionContracts?: SubscriptionContract[];
3499
+ /** Paging metadata */
3500
+ pagingMetadata?: CursorPagingMetadata$g;
3501
+ }
3502
+ interface CursorPagingMetadata$g {
3503
+ /** Number of items returned in the response. */
3504
+ count?: number | null;
3505
+ /** Cursor strings that point to the next page, previous page, or both. */
3506
+ cursors?: Cursors$k;
1411
3507
  /**
1412
- * The minimum number of items that must be recommended by the algorithm for those items to be returned in the response.
3508
+ * Whether there are more pages to retrieve following the current page.
1413
3509
  *
1414
- * Max: `100`
3510
+ * + `true`: Another page of results can be retrieved.
3511
+ * + `false`: This is the last page.
1415
3512
  */
1416
- minimumRecommendedItems?: number;
1417
- }
1418
- interface GetRecommendationResponse {
1419
- /** 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. */
1420
- recommendation?: Recommendation;
3513
+ hasNext?: boolean | null;
1421
3514
  }
1422
- interface AlgorithmConfigNonNullableFields {
1423
- name: string;
1424
- description: string;
1425
- algorithmType: AlgorithmType;
1426
- algorithmId: string;
3515
+ interface Cursors$k {
3516
+ /** Cursor string pointing to the next page in the list of results. */
3517
+ next?: string | null;
3518
+ /** Cursor pointing to the previous page in the list of results. */
3519
+ prev?: string | null;
1427
3520
  }
1428
- interface AlgorithmInfoNonNullableFields {
1429
- config?: AlgorithmConfigNonNullableFields;
1430
- appId: string;
1431
- catalogAppIds: string[];
3521
+ interface V1SubscriptionSettingsNonNullableFields {
3522
+ frequency: SubscriptionFrequency$e;
3523
+ autoRenewal: boolean;
3524
+ enableCustomerCancellation: boolean;
1432
3525
  }
1433
- interface ListAvailableAlgorithmsResponseNonNullableFields {
1434
- availableAlgorithms: AlgorithmInfoNonNullableFields[];
3526
+ interface ProductNameNonNullableFields$c {
3527
+ original: string;
1435
3528
  }
1436
3529
  interface CatalogReferenceNonNullableFields$e {
1437
3530
  catalogItemId: string;
1438
3531
  appId: string;
1439
3532
  }
1440
- interface AlgorithmNonNullableFields {
3533
+ interface PriceNonNullableFields$8 {
3534
+ amount: string;
3535
+ formattedAmount: string;
3536
+ }
3537
+ interface PlainTextValueNonNullableFields$c {
3538
+ original: string;
3539
+ }
3540
+ interface ColorNonNullableFields$c {
3541
+ original: string;
3542
+ }
3543
+ interface DescriptionLineNameNonNullableFields$c {
3544
+ original: string;
3545
+ }
3546
+ interface DescriptionLineNonNullableFields$c {
3547
+ plainText?: PlainTextValueNonNullableFields$c;
3548
+ colorInfo?: ColorNonNullableFields$c;
3549
+ plainTextValue?: PlainTextValueNonNullableFields$c;
3550
+ color: string;
3551
+ name?: DescriptionLineNameNonNullableFields$c;
3552
+ lineType: DescriptionLineType$c;
3553
+ }
3554
+ interface PhysicalPropertiesNonNullableFields$c {
3555
+ shippable: boolean;
3556
+ }
3557
+ interface ItemTypeNonNullableFields$c {
3558
+ preset: ItemTypeItemType$e;
3559
+ custom: string;
3560
+ }
3561
+ interface ItemTaxFullDetailsNonNullableFields$c {
3562
+ taxableAmount?: PriceNonNullableFields$8;
3563
+ taxRate: string;
3564
+ totalTax?: PriceNonNullableFields$8;
3565
+ }
3566
+ interface LineItemTaxBreakdownNonNullableFields$4 {
3567
+ taxAmount?: PriceNonNullableFields$8;
3568
+ jurisdictionType: JurisdictionType$c;
3569
+ nonTaxableAmount?: PriceNonNullableFields$8;
3570
+ taxableAmount?: PriceNonNullableFields$8;
3571
+ }
3572
+ interface LineItemTaxInfoNonNullableFields$4 {
3573
+ taxAmount?: PriceNonNullableFields$8;
3574
+ taxableAmount?: PriceNonNullableFields$8;
3575
+ taxIncludedInPrice: boolean;
3576
+ taxBreakdown: LineItemTaxBreakdownNonNullableFields$4[];
3577
+ }
3578
+ interface DigitalFileNonNullableFields$4 {
3579
+ fileId: string;
3580
+ }
3581
+ interface SubscriptionSettingsNonNullableFields$c {
3582
+ frequency: V2SubscriptionFrequency;
3583
+ autoRenewal: boolean;
3584
+ enableCustomerCancellation: boolean;
3585
+ }
3586
+ interface SubscriptionInfoNonNullableFields$4 {
3587
+ cycleNumber: number;
3588
+ subscriptionOptionTitle: string;
3589
+ subscriptionSettings?: SubscriptionSettingsNonNullableFields$c;
3590
+ }
3591
+ interface PriceDescriptionNonNullableFields$c {
3592
+ original: string;
3593
+ }
3594
+ interface LocationAndQuantityNonNullableFields$4 {
1441
3595
  _id: string;
1442
- appId: string;
3596
+ quantity: number;
1443
3597
  }
1444
- interface RecommendationNonNullableFields {
1445
- items: CatalogReferenceNonNullableFields$e[];
1446
- algorithm?: AlgorithmNonNullableFields;
3598
+ interface TaxableAddressNonNullableFields$c {
3599
+ addressType: TaxableAddressType$c;
1447
3600
  }
1448
- interface GetRecommendationResponseNonNullableFields {
1449
- recommendation?: RecommendationNonNullableFields;
3601
+ interface OrderLineItemNonNullableFields$4 {
3602
+ _id: string;
3603
+ productName?: ProductNameNonNullableFields$c;
3604
+ catalogReference?: CatalogReferenceNonNullableFields$e;
3605
+ quantity: number;
3606
+ totalDiscount?: PriceNonNullableFields$8;
3607
+ descriptionLines: DescriptionLineNonNullableFields$c[];
3608
+ image: string;
3609
+ physicalProperties?: PhysicalPropertiesNonNullableFields$c;
3610
+ itemType?: ItemTypeNonNullableFields$c;
3611
+ price?: PriceNonNullableFields$8;
3612
+ priceBeforeDiscounts?: PriceNonNullableFields$8;
3613
+ totalPriceBeforeTax?: PriceNonNullableFields$8;
3614
+ totalPriceAfterTax?: PriceNonNullableFields$8;
3615
+ paymentOption: PaymentOptionType$e;
3616
+ taxDetails?: ItemTaxFullDetailsNonNullableFields$c;
3617
+ taxInfo?: LineItemTaxInfoNonNullableFields$4;
3618
+ digitalFile?: DigitalFileNonNullableFields$4;
3619
+ subscriptionInfo?: SubscriptionInfoNonNullableFields$4;
3620
+ priceDescription?: PriceDescriptionNonNullableFields$c;
3621
+ depositAmount?: PriceNonNullableFields$8;
3622
+ locations: LocationAndQuantityNonNullableFields$4[];
3623
+ lineItemPrice?: PriceNonNullableFields$8;
3624
+ taxableAddress?: TaxableAddressNonNullableFields$c;
3625
+ priceUndetermined: boolean;
3626
+ fixedQuantity: boolean;
3627
+ }
3628
+ interface BuyerInfoNonNullableFields$a {
3629
+ visitorId: string;
3630
+ memberId: string;
3631
+ }
3632
+ interface PriceSummaryNonNullableFields$c {
3633
+ subtotal?: PriceNonNullableFields$8;
3634
+ shipping?: PriceNonNullableFields$8;
3635
+ tax?: PriceNonNullableFields$8;
3636
+ discount?: PriceNonNullableFields$8;
3637
+ totalPrice?: PriceNonNullableFields$8;
3638
+ total?: PriceNonNullableFields$8;
3639
+ totalWithGiftCard?: PriceNonNullableFields$8;
3640
+ totalWithoutGiftCard?: PriceNonNullableFields$8;
3641
+ totalAdditionalFees?: PriceNonNullableFields$8;
3642
+ }
3643
+ interface StreetAddressNonNullableFields$i {
3644
+ number: string;
3645
+ name: string;
3646
+ apt: string;
3647
+ }
3648
+ interface AddressNonNullableFields$g {
3649
+ streetAddress?: StreetAddressNonNullableFields$i;
3650
+ }
3651
+ interface VatIdNonNullableFields$a {
3652
+ _id: string;
3653
+ type: VatType$c;
3654
+ }
3655
+ interface FullAddressContactDetailsNonNullableFields$c {
3656
+ vatId?: VatIdNonNullableFields$a;
3657
+ }
3658
+ interface AddressWithContactNonNullableFields$a {
3659
+ address?: AddressNonNullableFields$g;
3660
+ contactDetails?: FullAddressContactDetailsNonNullableFields$c;
3661
+ }
3662
+ interface PickupAddressNonNullableFields$4 {
3663
+ streetAddress?: StreetAddressNonNullableFields$i;
3664
+ }
3665
+ interface PickupDetailsNonNullableFields$e {
3666
+ address?: PickupAddressNonNullableFields$4;
3667
+ pickupMethod: PickupMethod$e;
3668
+ }
3669
+ interface DeliveryLogisticsNonNullableFields$e {
3670
+ shippingDestination?: AddressWithContactNonNullableFields$a;
3671
+ pickupDetails?: PickupDetailsNonNullableFields$e;
3672
+ }
3673
+ interface ShippingPriceNonNullableFields$c {
3674
+ price?: PriceNonNullableFields$8;
3675
+ totalPriceBeforeTax?: PriceNonNullableFields$8;
3676
+ totalPriceAfterTax?: PriceNonNullableFields$8;
3677
+ taxDetails?: ItemTaxFullDetailsNonNullableFields$c;
3678
+ discount?: PriceNonNullableFields$8;
3679
+ }
3680
+ interface ShippingInformationNonNullableFields$a {
3681
+ title: string;
3682
+ logistics?: DeliveryLogisticsNonNullableFields$e;
3683
+ cost?: ShippingPriceNonNullableFields$c;
3684
+ }
3685
+ interface OrderTaxBreakdownNonNullableFields$4 {
3686
+ taxName: string;
3687
+ taxType: string;
3688
+ jurisdiction: string;
3689
+ jurisdictionType: JurisdictionType$c;
3690
+ rate: string;
3691
+ aggregatedTaxAmount?: PriceNonNullableFields$8;
3692
+ aggregatedTaxableAmount?: PriceNonNullableFields$8;
3693
+ }
3694
+ interface OrderTaxInfoNonNullableFields$4 {
3695
+ totalTax?: PriceNonNullableFields$8;
3696
+ taxBreakdown: OrderTaxBreakdownNonNullableFields$4[];
3697
+ }
3698
+ interface CouponNonNullableFields$c {
3699
+ _id: string;
3700
+ code: string;
3701
+ name: string;
3702
+ amount?: PriceNonNullableFields$8;
3703
+ }
3704
+ interface MerchantDiscountNonNullableFields$c {
3705
+ discountReason: DiscountReason$4;
3706
+ amount?: PriceNonNullableFields$8;
3707
+ }
3708
+ interface DiscountRuleNameNonNullableFields$c {
3709
+ original: string;
3710
+ }
3711
+ interface DiscountRuleNonNullableFields$c {
3712
+ _id: string;
3713
+ name?: DiscountRuleNameNonNullableFields$c;
3714
+ amount?: PriceNonNullableFields$8;
3715
+ }
3716
+ interface LineItemDiscountNonNullableFields$c {
3717
+ _id: string;
3718
+ totalDiscount?: PriceNonNullableFields$8;
3719
+ }
3720
+ interface AppliedDiscountNonNullableFields$c {
3721
+ coupon?: CouponNonNullableFields$c;
3722
+ merchantDiscount?: MerchantDiscountNonNullableFields$c;
3723
+ discountRule?: DiscountRuleNonNullableFields$c;
3724
+ discountType: DiscountType$c;
3725
+ lineItemIds: string[];
3726
+ lineItemDiscounts: LineItemDiscountNonNullableFields$c[];
3727
+ }
3728
+ interface ChannelInfoNonNullableFields$4 {
3729
+ type: ChannelType$a;
3730
+ }
3731
+ interface CustomFieldNonNullableFields$6 {
3732
+ title: string;
3733
+ }
3734
+ interface SubscriptionContractNonNullableFields {
3735
+ subscriptionSettings?: V1SubscriptionSettingsNonNullableFields;
3736
+ lineItems: OrderLineItemNonNullableFields$4[];
3737
+ buyerInfo?: BuyerInfoNonNullableFields$a;
3738
+ weightUnit: WeightUnit$e;
3739
+ taxIncludedInPrices: boolean;
3740
+ priceSummary?: PriceSummaryNonNullableFields$c;
3741
+ billingInfo?: AddressWithContactNonNullableFields$a;
3742
+ shippingInfo?: ShippingInformationNonNullableFields$a;
3743
+ taxInfo?: OrderTaxInfoNonNullableFields$4;
3744
+ appliedDiscounts: AppliedDiscountNonNullableFields$c[];
3745
+ channelInfo?: ChannelInfoNonNullableFields$4;
3746
+ customFields: CustomFieldNonNullableFields$6[];
3747
+ recipientInfo?: AddressWithContactNonNullableFields$a;
3748
+ }
3749
+ interface GetSubscriptionContractResponseNonNullableFields {
3750
+ subscriptionContract?: SubscriptionContractNonNullableFields;
3751
+ }
3752
+ interface QuerySubscriptionContractsResponseNonNullableFields {
3753
+ subscriptionContracts: SubscriptionContractNonNullableFields[];
1450
3754
  }
1451
3755
 
1452
3756
  type __PublicMethodMetaInfo$n<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
@@ -1459,13 +3763,15 @@ type __PublicMethodMetaInfo$n<K = string, M = unknown, T = unknown, S = unknown,
1459
3763
  __responseType: Q;
1460
3764
  __originalResponseType: R;
1461
3765
  };
1462
- declare function listAvailableAlgorithms(): __PublicMethodMetaInfo$n<'GET', {}, ListAvailableAlgorithmsRequest, ListAvailableAlgorithmsRequest$1, ListAvailableAlgorithmsResponse & ListAvailableAlgorithmsResponseNonNullableFields, ListAvailableAlgorithmsResponse$1 & ListAvailableAlgorithmsResponseNonNullableFields$1>;
1463
- declare function getRecommendation(): __PublicMethodMetaInfo$n<'POST', {}, GetRecommendationRequest, GetRecommendationRequest$1, GetRecommendationResponse & GetRecommendationResponseNonNullableFields, GetRecommendationResponse$1 & GetRecommendationResponseNonNullableFields$1>;
3766
+ declare function getSubscriptionContract(): __PublicMethodMetaInfo$n<'GET', {
3767
+ subscriptionContractId: string;
3768
+ }, GetSubscriptionContractRequest, GetSubscriptionContractRequest$1, GetSubscriptionContractResponse & GetSubscriptionContractResponseNonNullableFields, GetSubscriptionContractResponse$1 & GetSubscriptionContractResponseNonNullableFields$1>;
3769
+ declare function querySubscriptionContracts(): __PublicMethodMetaInfo$n<'GET', {}, QuerySubscriptionContractsRequest, QuerySubscriptionContractsRequest$1, QuerySubscriptionContractsResponse & QuerySubscriptionContractsResponseNonNullableFields, QuerySubscriptionContractsResponse$1 & QuerySubscriptionContractsResponseNonNullableFields$1>;
1464
3770
 
1465
- declare const meta$n_getRecommendation: typeof getRecommendation;
1466
- declare const meta$n_listAvailableAlgorithms: typeof listAvailableAlgorithms;
3771
+ declare const meta$n_getSubscriptionContract: typeof getSubscriptionContract;
3772
+ declare const meta$n_querySubscriptionContracts: typeof querySubscriptionContracts;
1467
3773
  declare namespace meta$n {
1468
- export { type __PublicMethodMetaInfo$n as __PublicMethodMetaInfo, meta$n_getRecommendation as getRecommendation, meta$n_listAvailableAlgorithms as listAvailableAlgorithms };
3774
+ export { type __PublicMethodMetaInfo$n as __PublicMethodMetaInfo, meta$n_getSubscriptionContract as getSubscriptionContract, meta$n_querySubscriptionContracts as querySubscriptionContracts };
1469
3775
  }
1470
3776
 
1471
3777
  interface AbandonedCheckout$1 {
@@ -26461,6 +28767,8 @@ interface OrderLineItemNonNullableFields$1 {
26461
28767
  locations: LocationAndQuantityNonNullableFields$1[];
26462
28768
  lineItemPrice?: PriceNonNullableFields$5;
26463
28769
  taxableAddress?: TaxableAddressNonNullableFields$3;
28770
+ priceUndetermined: boolean;
28771
+ fixedQuantity: boolean;
26464
28772
  }
26465
28773
  interface BuyerInfoNonNullableFields$1 {
26466
28774
  visitorId: string;
@@ -28708,6 +31016,8 @@ interface OrderLineItemNonNullableFields {
28708
31016
  locations: LocationAndQuantityNonNullableFields[];
28709
31017
  lineItemPrice?: PriceNonNullableFields$4;
28710
31018
  taxableAddress?: TaxableAddressNonNullableFields$2;
31019
+ priceUndetermined: boolean;
31020
+ fixedQuantity: boolean;
28711
31021
  }
28712
31022
  interface BuyerInfoNonNullableFields {
28713
31023
  visitorId: string;
@@ -36054,4 +38364,4 @@ declare namespace meta {
36054
38364
  export { type meta___PublicMethodMetaInfo as __PublicMethodMetaInfo, meta_getDeliverySolutions as getDeliverySolutions };
36055
38365
  }
36056
38366
 
36057
- export { meta$m as abandonedCheckouts, meta$l as backInStockNotifications, meta$k as backInStockSettings, meta$j as cart, meta$h as checkout, meta$r as checkoutContent, meta$g as checkoutSettings, meta$f as checkoutTemplates, meta$1 as currencies, meta$i as currentCart, meta$e as deliveryProfile, meta as deliverySolutions, meta$p as discountRules, meta$q as discountsCustomTrigger, meta$d as draftOrders, meta$b as giftVouchers, meta$a as localDeliveryOptions, meta$c as orderFulfillments, meta$o as orderInvoices, meta$8 as orderPaymentRequests, meta$7 as orderTransactions, meta$9 as orders, meta$6 as ordersSettings, meta$5 as pickupLocations, meta$n as recommendations, meta$4 as shippingOptions, meta$3 as shippoConfigurations, meta$2 as totalsCalculator };
38367
+ export { meta$m as abandonedCheckouts, meta$l as backInStockNotifications, meta$k as backInStockSettings, meta$j as cart, meta$h as checkout, meta$s as checkoutContent, meta$g as checkoutSettings, meta$f as checkoutTemplates, meta$1 as currencies, meta$i as currentCart, meta$e as deliveryProfile, meta as deliverySolutions, meta$q as discountRules, meta$r as discountsCustomTrigger, meta$d as draftOrders, meta$b as giftVouchers, meta$a as localDeliveryOptions, meta$c as orderFulfillments, meta$p as orderInvoices, meta$8 as orderPaymentRequests, meta$7 as orderTransactions, meta$9 as orders, meta$6 as ordersSettings, meta$5 as pickupLocations, meta$o as recommendations, meta$4 as shippingOptions, meta$3 as shippoConfigurations, meta$n as subscriptionContracts, meta$2 as totalsCalculator };