@wix/auto_sdk_pricing-plans_orders 1.0.119 → 1.0.121
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/index.d.ts +51 -51
- package/build/cjs/index.js +386 -367
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +353 -342
- package/build/cjs/index.typings.js +312 -293
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +232 -221
- package/build/cjs/meta.js +245 -226
- package/build/cjs/meta.js.map +1 -1
- package/build/cjs/schemas.d.ts +209 -201
- package/build/cjs/schemas.js +928 -916
- package/build/cjs/schemas.js.map +1 -1
- package/build/es/index.d.mts +51 -51
- package/build/es/index.mjs +386 -367
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +353 -342
- package/build/es/index.typings.mjs +312 -293
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +232 -221
- package/build/es/meta.mjs +245 -226
- package/build/es/meta.mjs.map +1 -1
- package/build/es/schemas.d.mts +209 -201
- package/build/es/schemas.mjs +928 -916
- package/build/es/schemas.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +51 -51
- package/build/internal/cjs/index.js +386 -367
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +412 -342
- package/build/internal/cjs/index.typings.js +312 -293
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +329 -217
- package/build/internal/cjs/meta.js +245 -226
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/cjs/schemas.d.ts +209 -201
- package/build/internal/cjs/schemas.js +928 -916
- package/build/internal/cjs/schemas.js.map +1 -1
- package/build/internal/es/index.d.mts +51 -51
- package/build/internal/es/index.mjs +386 -367
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +412 -342
- package/build/internal/es/index.typings.mjs +312 -293
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +329 -217
- package/build/internal/es/meta.mjs +245 -226
- package/build/internal/es/meta.mjs.map +1 -1
- package/build/internal/es/schemas.d.mts +209 -201
- package/build/internal/es/schemas.mjs +928 -916
- package/build/internal/es/schemas.mjs.map +1 -1
- package/package.json +4 -4
|
@@ -66,6 +66,12 @@ interface Order {
|
|
|
66
66
|
* @readonly
|
|
67
67
|
*/
|
|
68
68
|
type?: OrderTypeWithLiterals;
|
|
69
|
+
/**
|
|
70
|
+
* Method by which checkout was initiated on buyer's behalf.
|
|
71
|
+
* @internal
|
|
72
|
+
* @readonly
|
|
73
|
+
*/
|
|
74
|
+
orderMethod?: OrderMethodWithLiterals;
|
|
69
75
|
/**
|
|
70
76
|
* Status of the order.
|
|
71
77
|
* @readonly
|
|
@@ -135,6 +141,12 @@ interface Order {
|
|
|
135
141
|
* @readonly
|
|
136
142
|
*/
|
|
137
143
|
currentCycle?: CurrentCycle;
|
|
144
|
+
/**
|
|
145
|
+
* Past and current cycles for the order.
|
|
146
|
+
* @internal
|
|
147
|
+
* @readonly
|
|
148
|
+
*/
|
|
149
|
+
cycles?: OrderCycle[];
|
|
138
150
|
/**
|
|
139
151
|
* Plan name at the time of purchase.
|
|
140
152
|
* @readonly
|
|
@@ -166,6 +178,17 @@ interface Order {
|
|
|
166
178
|
* @readonly
|
|
167
179
|
*/
|
|
168
180
|
formData?: FormData;
|
|
181
|
+
/**
|
|
182
|
+
* TODO PPL-1357: Remove when migration to new status is completed
|
|
183
|
+
* @internal
|
|
184
|
+
*/
|
|
185
|
+
statusNew?: OrderStatusWithLiterals;
|
|
186
|
+
/**
|
|
187
|
+
* Used to differentiate orders that were created from eCom flow.
|
|
188
|
+
* @internal
|
|
189
|
+
* @readonly
|
|
190
|
+
*/
|
|
191
|
+
onEcom?: boolean;
|
|
169
192
|
}
|
|
170
193
|
interface Buyer {
|
|
171
194
|
/**
|
|
@@ -392,6 +415,14 @@ interface Price {
|
|
|
392
415
|
* @format CURRENCY
|
|
393
416
|
*/
|
|
394
417
|
currency?: string;
|
|
418
|
+
/**
|
|
419
|
+
* Additional fees that would have been applied to the price, one of which could be a setup fee.
|
|
420
|
+
*
|
|
421
|
+
* Tax is also applied to additional fees.
|
|
422
|
+
* @internal
|
|
423
|
+
* @readonly
|
|
424
|
+
*/
|
|
425
|
+
fees?: Fee[];
|
|
395
426
|
/**
|
|
396
427
|
* Price change after billing date was change and price was adjusted. Could be positive and negative values.
|
|
397
428
|
* @format DECIMAL_VALUE
|
|
@@ -635,218 +666,6 @@ interface ActionEvent {
|
|
|
635
666
|
}
|
|
636
667
|
interface Empty {
|
|
637
668
|
}
|
|
638
|
-
interface MemberGetOrderRequest {
|
|
639
|
-
/**
|
|
640
|
-
* Order ID.
|
|
641
|
-
* @format GUID
|
|
642
|
-
*/
|
|
643
|
-
_id: string;
|
|
644
|
-
/**
|
|
645
|
-
* Predefined set of fields to return.
|
|
646
|
-
*
|
|
647
|
-
* Default: If `fieldSet` is omitted, no order form submission data is returned.
|
|
648
|
-
*/
|
|
649
|
-
fieldSet?: SetWithLiterals;
|
|
650
|
-
}
|
|
651
|
-
declare enum Set {
|
|
652
|
-
/** Same behavior as `BASIC`.` */
|
|
653
|
-
UNKNOWN_SET = "UNKNOWN_SET",
|
|
654
|
-
/** Doesn't return any order form submission data. */
|
|
655
|
-
BASIC = "BASIC",
|
|
656
|
-
/** Returns all order form submission data. */
|
|
657
|
-
FULL = "FULL"
|
|
658
|
-
}
|
|
659
|
-
/** @enumType */
|
|
660
|
-
type SetWithLiterals = Set | 'UNKNOWN_SET' | 'BASIC' | 'FULL';
|
|
661
|
-
interface MemberGetOrderResponse {
|
|
662
|
-
/** Requested order. */
|
|
663
|
-
order?: Order;
|
|
664
|
-
}
|
|
665
|
-
interface MemberListOrdersRequest {
|
|
666
|
-
/**
|
|
667
|
-
* Filter by plan IDs.
|
|
668
|
-
* @format GUID
|
|
669
|
-
*/
|
|
670
|
-
planIds?: string[];
|
|
671
|
-
/** Filter for orders where auto renewal was canceled. */
|
|
672
|
-
autoRenewCanceled?: boolean | null;
|
|
673
|
-
/** Filter by order status. */
|
|
674
|
-
orderStatuses?: OrderStatusWithLiterals[];
|
|
675
|
-
/** Filter by payment status. */
|
|
676
|
-
paymentStatuses?: PaymentStatusWithLiterals[];
|
|
677
|
-
/**
|
|
678
|
-
* Limit the number of pricing plans returned. Default limit is 50.
|
|
679
|
-
* @min 1
|
|
680
|
-
* @max 50
|
|
681
|
-
*/
|
|
682
|
-
limit?: number | null;
|
|
683
|
-
/** Number of entries to offset. */
|
|
684
|
-
offset?: number | null;
|
|
685
|
-
/** Sorting direction (defaults to ASC) and field to sort by. */
|
|
686
|
-
sorting?: Sorting;
|
|
687
|
-
/**
|
|
688
|
-
* Predefined set of fields to return.
|
|
689
|
-
*
|
|
690
|
-
* Default: If `fieldSet` is omitted, no order form submission data is returned.
|
|
691
|
-
*/
|
|
692
|
-
fieldSet?: SetWithLiterals;
|
|
693
|
-
}
|
|
694
|
-
interface Sorting {
|
|
695
|
-
/**
|
|
696
|
-
* Name of the field to sort by.
|
|
697
|
-
* @maxLength 512
|
|
698
|
-
*/
|
|
699
|
-
fieldName?: string;
|
|
700
|
-
/** Sort order. */
|
|
701
|
-
order?: SortOrderWithLiterals;
|
|
702
|
-
}
|
|
703
|
-
declare enum SortOrder {
|
|
704
|
-
ASC = "ASC",
|
|
705
|
-
DESC = "DESC"
|
|
706
|
-
}
|
|
707
|
-
/** @enumType */
|
|
708
|
-
type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
709
|
-
interface MemberListOrdersResponse {
|
|
710
|
-
/** Requested orders. */
|
|
711
|
-
orders?: Order[];
|
|
712
|
-
/** Object containing paging-related data (number of orders returned, offset). */
|
|
713
|
-
pagingMetadata?: PagingMetadataV2;
|
|
714
|
-
}
|
|
715
|
-
interface PagingMetadataV2 {
|
|
716
|
-
/** Number of items returned in the response. */
|
|
717
|
-
count?: number | null;
|
|
718
|
-
/** Offset that was requested. */
|
|
719
|
-
offset?: number | null;
|
|
720
|
-
/** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
|
|
721
|
-
total?: number | null;
|
|
722
|
-
/** Flag that indicates the server failed to calculate the `total` field. */
|
|
723
|
-
tooManyToCount?: boolean | null;
|
|
724
|
-
/** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
|
|
725
|
-
cursors?: Cursors;
|
|
726
|
-
}
|
|
727
|
-
interface Cursors {
|
|
728
|
-
/**
|
|
729
|
-
* Cursor string pointing to the next page in the list of results.
|
|
730
|
-
* @maxLength 16000
|
|
731
|
-
*/
|
|
732
|
-
next?: string | null;
|
|
733
|
-
/**
|
|
734
|
-
* Cursor pointing to the previous page in the list of results.
|
|
735
|
-
* @maxLength 16000
|
|
736
|
-
*/
|
|
737
|
-
prev?: string | null;
|
|
738
|
-
}
|
|
739
|
-
interface RequestCancellationRequest {
|
|
740
|
-
/**
|
|
741
|
-
* Order ID.
|
|
742
|
-
* @format GUID
|
|
743
|
-
*/
|
|
744
|
-
_id: string;
|
|
745
|
-
/** Required. Whether to cancel the order effective immediately or at the next payment date. One-time orders can only be canceled immediately. */
|
|
746
|
-
effectiveAt: CancellationEffectiveAtWithLiterals;
|
|
747
|
-
}
|
|
748
|
-
interface RequestCancellationResponse {
|
|
749
|
-
}
|
|
750
|
-
/**
|
|
751
|
-
* Emitted when an order is canceled immediately or when cycle ends for an order with canceled auto renewal
|
|
752
|
-
*
|
|
753
|
-
* To determine the specific reason of the cancellation check `order.cancellation.cause` field.
|
|
754
|
-
*/
|
|
755
|
-
interface OrderCanceled {
|
|
756
|
-
/** Canceled order. */
|
|
757
|
-
order?: Order;
|
|
758
|
-
}
|
|
759
|
-
interface MessageEnvelope {
|
|
760
|
-
/**
|
|
761
|
-
* App instance ID.
|
|
762
|
-
* @format GUID
|
|
763
|
-
*/
|
|
764
|
-
instanceId?: string | null;
|
|
765
|
-
/**
|
|
766
|
-
* Event type.
|
|
767
|
-
* @maxLength 150
|
|
768
|
-
*/
|
|
769
|
-
eventType?: string;
|
|
770
|
-
/** The identification type and identity data. */
|
|
771
|
-
identity?: IdentificationData;
|
|
772
|
-
/** Stringify payload. */
|
|
773
|
-
data?: string;
|
|
774
|
-
/** Details related to the account */
|
|
775
|
-
accountInfo?: AccountInfo;
|
|
776
|
-
}
|
|
777
|
-
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
778
|
-
/**
|
|
779
|
-
* ID of a site visitor that has not logged in to the site.
|
|
780
|
-
* @format GUID
|
|
781
|
-
*/
|
|
782
|
-
anonymousVisitorId?: string;
|
|
783
|
-
/**
|
|
784
|
-
* ID of a site visitor that has logged in to the site.
|
|
785
|
-
* @format GUID
|
|
786
|
-
*/
|
|
787
|
-
memberId?: string;
|
|
788
|
-
/**
|
|
789
|
-
* ID of a Wix user (site owner, contributor, etc.).
|
|
790
|
-
* @format GUID
|
|
791
|
-
*/
|
|
792
|
-
wixUserId?: string;
|
|
793
|
-
/**
|
|
794
|
-
* ID of an app.
|
|
795
|
-
* @format GUID
|
|
796
|
-
*/
|
|
797
|
-
appId?: string;
|
|
798
|
-
/** @readonly */
|
|
799
|
-
identityType?: WebhookIdentityTypeWithLiterals;
|
|
800
|
-
}
|
|
801
|
-
/** @oneof */
|
|
802
|
-
interface IdentificationDataIdOneOf {
|
|
803
|
-
/**
|
|
804
|
-
* ID of a site visitor that has not logged in to the site.
|
|
805
|
-
* @format GUID
|
|
806
|
-
*/
|
|
807
|
-
anonymousVisitorId?: string;
|
|
808
|
-
/**
|
|
809
|
-
* ID of a site visitor that has logged in to the site.
|
|
810
|
-
* @format GUID
|
|
811
|
-
*/
|
|
812
|
-
memberId?: string;
|
|
813
|
-
/**
|
|
814
|
-
* ID of a Wix user (site owner, contributor, etc.).
|
|
815
|
-
* @format GUID
|
|
816
|
-
*/
|
|
817
|
-
wixUserId?: string;
|
|
818
|
-
/**
|
|
819
|
-
* ID of an app.
|
|
820
|
-
* @format GUID
|
|
821
|
-
*/
|
|
822
|
-
appId?: string;
|
|
823
|
-
}
|
|
824
|
-
declare enum WebhookIdentityType {
|
|
825
|
-
UNKNOWN = "UNKNOWN",
|
|
826
|
-
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
827
|
-
MEMBER = "MEMBER",
|
|
828
|
-
WIX_USER = "WIX_USER",
|
|
829
|
-
APP = "APP"
|
|
830
|
-
}
|
|
831
|
-
/** @enumType */
|
|
832
|
-
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
833
|
-
interface AccountInfo {
|
|
834
|
-
/**
|
|
835
|
-
* ID of the Wix account associated with the event.
|
|
836
|
-
* @format GUID
|
|
837
|
-
*/
|
|
838
|
-
accountId?: string | null;
|
|
839
|
-
/**
|
|
840
|
-
* ID of the parent Wix account. Only included when accountId belongs to a child account.
|
|
841
|
-
* @format GUID
|
|
842
|
-
*/
|
|
843
|
-
parentAccountId?: string | null;
|
|
844
|
-
/**
|
|
845
|
-
* ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
|
|
846
|
-
* @format GUID
|
|
847
|
-
*/
|
|
848
|
-
siteId?: string | null;
|
|
849
|
-
}
|
|
850
669
|
interface CreateOnlineOrderRequest {
|
|
851
670
|
/**
|
|
852
671
|
* Plan ID.
|
|
@@ -1158,6 +977,97 @@ interface SetSubmissionResponse {
|
|
|
1158
977
|
/** Order with submission id */
|
|
1159
978
|
order?: Order;
|
|
1160
979
|
}
|
|
980
|
+
interface MessageEnvelope {
|
|
981
|
+
/**
|
|
982
|
+
* App instance ID.
|
|
983
|
+
* @format GUID
|
|
984
|
+
*/
|
|
985
|
+
instanceId?: string | null;
|
|
986
|
+
/**
|
|
987
|
+
* Event type.
|
|
988
|
+
* @maxLength 150
|
|
989
|
+
*/
|
|
990
|
+
eventType?: string;
|
|
991
|
+
/** The identification type and identity data. */
|
|
992
|
+
identity?: IdentificationData;
|
|
993
|
+
/** Stringify payload. */
|
|
994
|
+
data?: string;
|
|
995
|
+
/** Details related to the account */
|
|
996
|
+
accountInfo?: AccountInfo;
|
|
997
|
+
}
|
|
998
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
999
|
+
/**
|
|
1000
|
+
* ID of a site visitor that has not logged in to the site.
|
|
1001
|
+
* @format GUID
|
|
1002
|
+
*/
|
|
1003
|
+
anonymousVisitorId?: string;
|
|
1004
|
+
/**
|
|
1005
|
+
* ID of a site visitor that has logged in to the site.
|
|
1006
|
+
* @format GUID
|
|
1007
|
+
*/
|
|
1008
|
+
memberId?: string;
|
|
1009
|
+
/**
|
|
1010
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
1011
|
+
* @format GUID
|
|
1012
|
+
*/
|
|
1013
|
+
wixUserId?: string;
|
|
1014
|
+
/**
|
|
1015
|
+
* ID of an app.
|
|
1016
|
+
* @format GUID
|
|
1017
|
+
*/
|
|
1018
|
+
appId?: string;
|
|
1019
|
+
/** @readonly */
|
|
1020
|
+
identityType?: WebhookIdentityTypeWithLiterals;
|
|
1021
|
+
}
|
|
1022
|
+
/** @oneof */
|
|
1023
|
+
interface IdentificationDataIdOneOf {
|
|
1024
|
+
/**
|
|
1025
|
+
* ID of a site visitor that has not logged in to the site.
|
|
1026
|
+
* @format GUID
|
|
1027
|
+
*/
|
|
1028
|
+
anonymousVisitorId?: string;
|
|
1029
|
+
/**
|
|
1030
|
+
* ID of a site visitor that has logged in to the site.
|
|
1031
|
+
* @format GUID
|
|
1032
|
+
*/
|
|
1033
|
+
memberId?: string;
|
|
1034
|
+
/**
|
|
1035
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
1036
|
+
* @format GUID
|
|
1037
|
+
*/
|
|
1038
|
+
wixUserId?: string;
|
|
1039
|
+
/**
|
|
1040
|
+
* ID of an app.
|
|
1041
|
+
* @format GUID
|
|
1042
|
+
*/
|
|
1043
|
+
appId?: string;
|
|
1044
|
+
}
|
|
1045
|
+
declare enum WebhookIdentityType {
|
|
1046
|
+
UNKNOWN = "UNKNOWN",
|
|
1047
|
+
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
1048
|
+
MEMBER = "MEMBER",
|
|
1049
|
+
WIX_USER = "WIX_USER",
|
|
1050
|
+
APP = "APP"
|
|
1051
|
+
}
|
|
1052
|
+
/** @enumType */
|
|
1053
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
1054
|
+
interface AccountInfo {
|
|
1055
|
+
/**
|
|
1056
|
+
* ID of the Wix account associated with the event.
|
|
1057
|
+
* @format GUID
|
|
1058
|
+
*/
|
|
1059
|
+
accountId?: string | null;
|
|
1060
|
+
/**
|
|
1061
|
+
* ID of the parent Wix account. Only included when accountId belongs to a child account.
|
|
1062
|
+
* @format GUID
|
|
1063
|
+
*/
|
|
1064
|
+
parentAccountId?: string | null;
|
|
1065
|
+
/**
|
|
1066
|
+
* ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
|
|
1067
|
+
* @format GUID
|
|
1068
|
+
*/
|
|
1069
|
+
siteId?: string | null;
|
|
1070
|
+
}
|
|
1161
1071
|
interface OrderPurchased {
|
|
1162
1072
|
/** Order that was paid for. If a free or an offline order, the order that was created. */
|
|
1163
1073
|
order?: Order;
|
|
@@ -1199,6 +1109,16 @@ interface GetOrderRequest {
|
|
|
1199
1109
|
*/
|
|
1200
1110
|
fieldSet?: SetWithLiterals;
|
|
1201
1111
|
}
|
|
1112
|
+
declare enum Set {
|
|
1113
|
+
/** Same behavior as `BASIC`.` */
|
|
1114
|
+
UNKNOWN_SET = "UNKNOWN_SET",
|
|
1115
|
+
/** Doesn't return any order form submission data. */
|
|
1116
|
+
BASIC = "BASIC",
|
|
1117
|
+
/** Returns all order form submission data. */
|
|
1118
|
+
FULL = "FULL"
|
|
1119
|
+
}
|
|
1120
|
+
/** @enumType */
|
|
1121
|
+
type SetWithLiterals = Set | 'UNKNOWN_SET' | 'BASIC' | 'FULL';
|
|
1202
1122
|
interface GetOrderResponse {
|
|
1203
1123
|
/** Order. */
|
|
1204
1124
|
order?: Order;
|
|
@@ -1244,6 +1164,53 @@ interface ListOrdersRequest {
|
|
|
1244
1164
|
* Default: If `fieldSet` is omitted, no order form submission data is returned.
|
|
1245
1165
|
*/
|
|
1246
1166
|
fieldSet?: SetWithLiterals;
|
|
1167
|
+
/**
|
|
1168
|
+
* Filter by order IDs.
|
|
1169
|
+
* @internal
|
|
1170
|
+
* @format GUID
|
|
1171
|
+
* @maxSize 50
|
|
1172
|
+
*/
|
|
1173
|
+
orderIds?: string[];
|
|
1174
|
+
}
|
|
1175
|
+
interface Sorting {
|
|
1176
|
+
/**
|
|
1177
|
+
* Name of the field to sort by.
|
|
1178
|
+
* @maxLength 512
|
|
1179
|
+
*/
|
|
1180
|
+
fieldName?: string;
|
|
1181
|
+
/** Sort order. */
|
|
1182
|
+
order?: SortOrderWithLiterals;
|
|
1183
|
+
/**
|
|
1184
|
+
* When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by
|
|
1185
|
+
* a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.
|
|
1186
|
+
*
|
|
1187
|
+
* If multiple filters are provided, they are combined with AND operator.
|
|
1188
|
+
*
|
|
1189
|
+
* Example:
|
|
1190
|
+
* Given we have document like {"id": "1", "nestedField": [{"price": 10, "region": "EU"}, {"price": 20, "region": "US"}]}
|
|
1191
|
+
* and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be
|
|
1192
|
+
* { fieldName: "nestedField.price", "select_items_by": [{"nestedField.region": "US"}] }
|
|
1193
|
+
* @internal
|
|
1194
|
+
* @maxSize 10
|
|
1195
|
+
*/
|
|
1196
|
+
selectItemsBy?: Record<string, any>[] | null;
|
|
1197
|
+
/**
|
|
1198
|
+
* Origin point for geo-distance sorting on a GEO field
|
|
1199
|
+
* results are ordered by distance from this point (ASC = nearest first, DESC = farthest first).
|
|
1200
|
+
*/
|
|
1201
|
+
origin?: AddressLocation;
|
|
1202
|
+
}
|
|
1203
|
+
declare enum SortOrder {
|
|
1204
|
+
ASC = "ASC",
|
|
1205
|
+
DESC = "DESC"
|
|
1206
|
+
}
|
|
1207
|
+
/** @enumType */
|
|
1208
|
+
type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
1209
|
+
interface AddressLocation {
|
|
1210
|
+
/** Address latitude. */
|
|
1211
|
+
latitude?: number | null;
|
|
1212
|
+
/** Address longitude. */
|
|
1213
|
+
longitude?: number | null;
|
|
1247
1214
|
}
|
|
1248
1215
|
interface ListOrdersResponse {
|
|
1249
1216
|
/** List of orders. */
|
|
@@ -1251,6 +1218,37 @@ interface ListOrdersResponse {
|
|
|
1251
1218
|
/** Object containing paging-related data (number of orders returned, offset). */
|
|
1252
1219
|
pagingMetadata?: PagingMetadataV2;
|
|
1253
1220
|
}
|
|
1221
|
+
interface PagingMetadataV2 {
|
|
1222
|
+
/** Number of items returned in the response. */
|
|
1223
|
+
count?: number | null;
|
|
1224
|
+
/** Offset that was requested. */
|
|
1225
|
+
offset?: number | null;
|
|
1226
|
+
/** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
|
|
1227
|
+
total?: number | null;
|
|
1228
|
+
/** Flag that indicates the server failed to calculate the `total` field. */
|
|
1229
|
+
tooManyToCount?: boolean | null;
|
|
1230
|
+
/** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
|
|
1231
|
+
cursors?: Cursors;
|
|
1232
|
+
/**
|
|
1233
|
+
* Indicates if there are more results after the current page.
|
|
1234
|
+
* If `true`, another page of results can be retrieved.
|
|
1235
|
+
* If `false`, this is the last page.
|
|
1236
|
+
* @internal
|
|
1237
|
+
*/
|
|
1238
|
+
hasNext?: boolean | null;
|
|
1239
|
+
}
|
|
1240
|
+
interface Cursors {
|
|
1241
|
+
/**
|
|
1242
|
+
* Cursor string pointing to the next page in the list of results.
|
|
1243
|
+
* @maxLength 16000
|
|
1244
|
+
*/
|
|
1245
|
+
next?: string | null;
|
|
1246
|
+
/**
|
|
1247
|
+
* Cursor pointing to the previous page in the list of results.
|
|
1248
|
+
* @maxLength 16000
|
|
1249
|
+
*/
|
|
1250
|
+
prev?: string | null;
|
|
1251
|
+
}
|
|
1254
1252
|
interface GetOrdersStatsRequest {
|
|
1255
1253
|
}
|
|
1256
1254
|
interface GetOrdersStatsResponse {
|
|
@@ -1324,6 +1322,15 @@ interface CancelOrderRequest {
|
|
|
1324
1322
|
}
|
|
1325
1323
|
interface CancelOrderResponse {
|
|
1326
1324
|
}
|
|
1325
|
+
/**
|
|
1326
|
+
* Emitted when an order is canceled immediately or when cycle ends for an order with canceled auto renewal
|
|
1327
|
+
*
|
|
1328
|
+
* To determine the specific reason of the cancellation check `order.cancellation.cause` field.
|
|
1329
|
+
*/
|
|
1330
|
+
interface OrderCanceled {
|
|
1331
|
+
/** Canceled order. */
|
|
1332
|
+
order?: Order;
|
|
1333
|
+
}
|
|
1327
1334
|
interface MarkAsPaidRequest {
|
|
1328
1335
|
/**
|
|
1329
1336
|
* Order ID.
|
|
@@ -1401,33 +1408,96 @@ interface BulkActionMetadata {
|
|
|
1401
1408
|
}
|
|
1402
1409
|
interface ResumeOrderRequest {
|
|
1403
1410
|
/**
|
|
1404
|
-
* Order ID.
|
|
1405
|
-
* @format GUID
|
|
1411
|
+
* Order ID.
|
|
1412
|
+
* @format GUID
|
|
1413
|
+
*/
|
|
1414
|
+
_id: string;
|
|
1415
|
+
}
|
|
1416
|
+
interface ResumeOrderResponse {
|
|
1417
|
+
}
|
|
1418
|
+
interface OrderResumed {
|
|
1419
|
+
/** Resumed order. */
|
|
1420
|
+
order?: Order;
|
|
1421
|
+
}
|
|
1422
|
+
interface BulkResumeOrderRequest {
|
|
1423
|
+
/**
|
|
1424
|
+
* List of Order IDs.
|
|
1425
|
+
* @format GUID
|
|
1426
|
+
* @minSize 1
|
|
1427
|
+
* @maxSize 100
|
|
1428
|
+
*/
|
|
1429
|
+
ids?: string[];
|
|
1430
|
+
/** Set to true to return Order entity in response. */
|
|
1431
|
+
returnFullEntity?: boolean;
|
|
1432
|
+
}
|
|
1433
|
+
interface BulkResumeOrderResponse {
|
|
1434
|
+
/** Orders that were resumed. */
|
|
1435
|
+
results?: BulkOrderResult[];
|
|
1436
|
+
/** Bulk action metadata. */
|
|
1437
|
+
bulkActionMetadata?: BulkActionMetadata;
|
|
1438
|
+
}
|
|
1439
|
+
interface MemberGetOrderRequest {
|
|
1440
|
+
/**
|
|
1441
|
+
* Order ID.
|
|
1442
|
+
* @format GUID
|
|
1443
|
+
*/
|
|
1444
|
+
_id: string;
|
|
1445
|
+
/**
|
|
1446
|
+
* Predefined set of fields to return.
|
|
1447
|
+
*
|
|
1448
|
+
* Default: If `fieldSet` is omitted, no order form submission data is returned.
|
|
1449
|
+
*/
|
|
1450
|
+
fieldSet?: SetWithLiterals;
|
|
1451
|
+
}
|
|
1452
|
+
interface MemberGetOrderResponse {
|
|
1453
|
+
/** Requested order. */
|
|
1454
|
+
order?: Order;
|
|
1455
|
+
}
|
|
1456
|
+
interface MemberListOrdersRequest {
|
|
1457
|
+
/**
|
|
1458
|
+
* Filter by plan IDs.
|
|
1459
|
+
* @format GUID
|
|
1460
|
+
*/
|
|
1461
|
+
planIds?: string[];
|
|
1462
|
+
/** Filter for orders where auto renewal was canceled. */
|
|
1463
|
+
autoRenewCanceled?: boolean | null;
|
|
1464
|
+
/** Filter by order status. */
|
|
1465
|
+
orderStatuses?: OrderStatusWithLiterals[];
|
|
1466
|
+
/** Filter by payment status. */
|
|
1467
|
+
paymentStatuses?: PaymentStatusWithLiterals[];
|
|
1468
|
+
/**
|
|
1469
|
+
* Limit the number of pricing plans returned. Default limit is 50.
|
|
1470
|
+
* @min 1
|
|
1471
|
+
* @max 50
|
|
1406
1472
|
*/
|
|
1407
|
-
|
|
1408
|
-
|
|
1409
|
-
|
|
1473
|
+
limit?: number | null;
|
|
1474
|
+
/** Number of entries to offset. */
|
|
1475
|
+
offset?: number | null;
|
|
1476
|
+
/** Sorting direction (defaults to ASC) and field to sort by. */
|
|
1477
|
+
sorting?: Sorting;
|
|
1478
|
+
/**
|
|
1479
|
+
* Predefined set of fields to return.
|
|
1480
|
+
*
|
|
1481
|
+
* Default: If `fieldSet` is omitted, no order form submission data is returned.
|
|
1482
|
+
*/
|
|
1483
|
+
fieldSet?: SetWithLiterals;
|
|
1410
1484
|
}
|
|
1411
|
-
interface
|
|
1412
|
-
/**
|
|
1413
|
-
|
|
1485
|
+
interface MemberListOrdersResponse {
|
|
1486
|
+
/** Requested orders. */
|
|
1487
|
+
orders?: Order[];
|
|
1488
|
+
/** Object containing paging-related data (number of orders returned, offset). */
|
|
1489
|
+
pagingMetadata?: PagingMetadataV2;
|
|
1414
1490
|
}
|
|
1415
|
-
interface
|
|
1491
|
+
interface RequestCancellationRequest {
|
|
1416
1492
|
/**
|
|
1417
|
-
*
|
|
1493
|
+
* Order ID.
|
|
1418
1494
|
* @format GUID
|
|
1419
|
-
* @minSize 1
|
|
1420
|
-
* @maxSize 100
|
|
1421
1495
|
*/
|
|
1422
|
-
|
|
1423
|
-
/**
|
|
1424
|
-
|
|
1496
|
+
_id: string;
|
|
1497
|
+
/** Required. Whether to cancel the order effective immediately or at the next payment date. One-time orders can only be canceled immediately. */
|
|
1498
|
+
effectiveAt: CancellationEffectiveAtWithLiterals;
|
|
1425
1499
|
}
|
|
1426
|
-
interface
|
|
1427
|
-
/** Orders that were resumed. */
|
|
1428
|
-
results?: BulkOrderResult[];
|
|
1429
|
-
/** Bulk action metadata. */
|
|
1430
|
-
bulkActionMetadata?: BulkActionMetadata;
|
|
1500
|
+
interface RequestCancellationResponse {
|
|
1431
1501
|
}
|
|
1432
1502
|
/** @docsIgnore */
|
|
1433
1503
|
type CreateOnlineOrderApplicationErrors = {
|
|
@@ -1780,33 +1850,6 @@ interface AccountInfoMetadata {
|
|
|
1780
1850
|
/** ID of the parent Wix account. Only included when 'accountId' belongs to a child account. */
|
|
1781
1851
|
parentAccountId?: string;
|
|
1782
1852
|
}
|
|
1783
|
-
interface OrderCanceledEnvelope {
|
|
1784
|
-
data: OrderCanceled;
|
|
1785
|
-
metadata: EventMetadata;
|
|
1786
|
-
}
|
|
1787
|
-
/**
|
|
1788
|
-
* Triggered when an order is canceled.
|
|
1789
|
-
*
|
|
1790
|
-
* This webhook is triggered either immediately or at the end of the current payment cycle, as follows:
|
|
1791
|
-
* + If the order is canceled and `effectiveAt` is set to `IMMEDIATELY`, the webhook is triggered immediately when canceled.
|
|
1792
|
-
* + If the order is canceled and `effectiveAt` is set to `NEXT_PAYMENT_DATE`, the webhook is triggered at the end of the current payment cycle. In this case, the Order Auto Renew Canceled Webhook is triggered immediately.
|
|
1793
|
-
* @permissionScope Manage_Wix_Rentals_App_Forms_submissions
|
|
1794
|
-
* @permissionScopeId SCOPE.RENTALS.MANAGE
|
|
1795
|
-
* @permissionScope Manage Orders
|
|
1796
|
-
* @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
|
|
1797
|
-
* @permissionScope Read Orders
|
|
1798
|
-
* @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS
|
|
1799
|
-
* @permissionScope Manage plans and orders of Pricing Plans
|
|
1800
|
-
* @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-PLANS-AND-ORDERS
|
|
1801
|
-
* @permissionScope Manage Events
|
|
1802
|
-
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1803
|
-
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
1804
|
-
* @webhook
|
|
1805
|
-
* @eventType wix.pricing_plans.v2.order_canceled
|
|
1806
|
-
* @serviceIdentifier com.wixpress.membership.v2.orders.member.MemberOrdersService
|
|
1807
|
-
* @slug canceled
|
|
1808
|
-
*/
|
|
1809
|
-
declare function onOrderCanceled(handler: (event: OrderCanceledEnvelope) => void | Promise<void>): void;
|
|
1810
1853
|
interface OrderCreatedEnvelope {
|
|
1811
1854
|
entity: Order;
|
|
1812
1855
|
metadata: EventMetadata;
|
|
@@ -1911,6 +1954,33 @@ interface OrderAutoRenewCanceledEnvelope {
|
|
|
1911
1954
|
* @slug auto_renew_canceled
|
|
1912
1955
|
*/
|
|
1913
1956
|
declare function onOrderAutoRenewCanceled(handler: (event: OrderAutoRenewCanceledEnvelope) => void | Promise<void>): void;
|
|
1957
|
+
interface OrderCanceledEnvelope {
|
|
1958
|
+
data: OrderCanceled;
|
|
1959
|
+
metadata: EventMetadata;
|
|
1960
|
+
}
|
|
1961
|
+
/**
|
|
1962
|
+
* Triggered when an order is canceled.
|
|
1963
|
+
*
|
|
1964
|
+
* This webhook is triggered either immediately or at the end of the current payment cycle, as follows:
|
|
1965
|
+
* + If the order is canceled and `effectiveAt` is set to `IMMEDIATELY`, the webhook is triggered immediately when canceled.
|
|
1966
|
+
* + If the order is canceled and `effectiveAt` is set to `NEXT_PAYMENT_DATE`, the webhook is triggered at the end of the current payment cycle. In this case, the Order Auto Renew Canceled Webhook is triggered immediately.
|
|
1967
|
+
* @permissionScope Manage_Wix_Rentals_App_Forms_submissions
|
|
1968
|
+
* @permissionScopeId SCOPE.RENTALS.MANAGE
|
|
1969
|
+
* @permissionScope Manage Orders
|
|
1970
|
+
* @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
|
|
1971
|
+
* @permissionScope Read Orders
|
|
1972
|
+
* @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS
|
|
1973
|
+
* @permissionScope Manage plans and orders of Pricing Plans
|
|
1974
|
+
* @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-PLANS-AND-ORDERS
|
|
1975
|
+
* @permissionScope Manage Events
|
|
1976
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1977
|
+
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
1978
|
+
* @webhook
|
|
1979
|
+
* @eventType wix.pricing_plans.v2.order_canceled
|
|
1980
|
+
* @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
|
|
1981
|
+
* @slug canceled
|
|
1982
|
+
*/
|
|
1983
|
+
declare function onOrderCanceled(handler: (event: OrderCanceledEnvelope) => void | Promise<void>): void;
|
|
1914
1984
|
interface OrderCycleStartedEnvelope {
|
|
1915
1985
|
data: OrderCycleStarted;
|
|
1916
1986
|
metadata: EventMetadata;
|
|
@@ -2105,86 +2175,6 @@ interface OrderStartedEnvelope {
|
|
|
2105
2175
|
* @slug started
|
|
2106
2176
|
*/
|
|
2107
2177
|
declare function onOrderStarted(handler: (event: OrderStartedEnvelope) => void | Promise<void>): void;
|
|
2108
|
-
/**
|
|
2109
|
-
* Retrieves an order for the currently logged-in member by ID.
|
|
2110
|
-
* @param _id - Order ID.
|
|
2111
|
-
* @public
|
|
2112
|
-
* @requiredField _id
|
|
2113
|
-
* @param options - Options for getting a logged-in member's order.
|
|
2114
|
-
* @permissionId PRICING_PLANS.READ_OWN_ORDERS
|
|
2115
|
-
* @applicableIdentity APP
|
|
2116
|
-
* @applicableIdentity MEMBER
|
|
2117
|
-
* @fqn com.wixpress.membership.v2.orders.member.MemberOrdersService.GetOrder
|
|
2118
|
-
*/
|
|
2119
|
-
declare function memberGetOrder(_id: string, options?: MemberGetOrderOptions): Promise<NonNullablePaths<MemberGetOrderResponse, `order._id` | `order.planId` | `order.subscriptionId` | `order.buyer.memberId` | `order.buyer.contactId` | `order.priceDetails.subscription.cycleDuration.unit` | `order.priceDetails.subtotal` | `order.priceDetails.discount` | `order.priceDetails.tax.name` | `order.priceDetails.tax.includedInPrice` | `order.priceDetails.tax.rate` | `order.priceDetails.tax.amount` | `order.priceDetails.total` | `order.priceDetails.planPrice` | `order.priceDetails.currency` | `order.priceDetails.coupon.code` | `order.priceDetails.coupon.amount` | `order.priceDetails.coupon._id` | `order.pricing.prices` | `order.pricing.prices.${number}.duration.cycleFrom` | `order.pricing.prices.${number}.price.subtotal` | `order.pricing.prices.${number}.price.discount` | `order.pricing.prices.${number}.price.total` | `order.pricing.prices.${number}.price.currency` | `order.pricing.prices.${number}.price.proration` | `order.type` | `order.status` | `order.cancellation.cause` | `order.cancellation.effectiveAt` | `order.lastPaymentStatus` | `order.pausePeriods` | `order.pausePeriods.${number}.status` | `order.currentCycle.index` | `order.planName` | `order.planDescription` | `order.planPrice`, 7>>;
|
|
2120
|
-
interface MemberGetOrderOptions {
|
|
2121
|
-
/**
|
|
2122
|
-
* Predefined set of fields to return.
|
|
2123
|
-
*
|
|
2124
|
-
* Default: If `fieldSet` is omitted, no order form submission data is returned.
|
|
2125
|
-
*/
|
|
2126
|
-
fieldSet?: SetWithLiterals;
|
|
2127
|
-
}
|
|
2128
|
-
/**
|
|
2129
|
-
* Retrieves a list of up to 100 pricing plan orders for currently logged-in member.
|
|
2130
|
-
* @public
|
|
2131
|
-
* @param options - Filtering, sorting, and pagination options.
|
|
2132
|
-
* @permissionId PRICING_PLANS.READ_OWN_ORDERS
|
|
2133
|
-
* @applicableIdentity APP
|
|
2134
|
-
* @applicableIdentity MEMBER
|
|
2135
|
-
* @fqn com.wixpress.membership.v2.orders.member.MemberOrdersService.ListOrders
|
|
2136
|
-
*/
|
|
2137
|
-
declare function memberListOrders(options?: MemberListOrdersOptions): Promise<NonNullablePaths<MemberListOrdersResponse, `orders` | `orders.${number}._id` | `orders.${number}.planId` | `orders.${number}.subscriptionId` | `orders.${number}.buyer.memberId` | `orders.${number}.buyer.contactId` | `orders.${number}.priceDetails.singlePaymentForDuration.unit` | `orders.${number}.priceDetails.subtotal` | `orders.${number}.priceDetails.discount` | `orders.${number}.priceDetails.tax.name` | `orders.${number}.priceDetails.tax.includedInPrice` | `orders.${number}.priceDetails.tax.rate` | `orders.${number}.priceDetails.tax.amount` | `orders.${number}.priceDetails.total` | `orders.${number}.priceDetails.planPrice` | `orders.${number}.priceDetails.currency` | `orders.${number}.priceDetails.coupon.code` | `orders.${number}.priceDetails.coupon.amount` | `orders.${number}.priceDetails.coupon._id` | `orders.${number}.type` | `orders.${number}.status` | `orders.${number}.cancellation.cause` | `orders.${number}.cancellation.effectiveAt` | `orders.${number}.lastPaymentStatus` | `orders.${number}.currentCycle.index` | `orders.${number}.planName` | `orders.${number}.planDescription` | `orders.${number}.planPrice`, 6>>;
|
|
2138
|
-
interface MemberListOrdersOptions {
|
|
2139
|
-
/**
|
|
2140
|
-
* Filter by plan IDs.
|
|
2141
|
-
* @format GUID
|
|
2142
|
-
*/
|
|
2143
|
-
planIds?: string[];
|
|
2144
|
-
/** Filter for orders where auto renewal was canceled. */
|
|
2145
|
-
autoRenewCanceled?: boolean | null;
|
|
2146
|
-
/** Filter by order status. */
|
|
2147
|
-
orderStatuses?: OrderStatusWithLiterals[];
|
|
2148
|
-
/** Filter by payment status. */
|
|
2149
|
-
paymentStatuses?: PaymentStatusWithLiterals[];
|
|
2150
|
-
/**
|
|
2151
|
-
* Limit the number of pricing plans returned. Default limit is 50.
|
|
2152
|
-
* @min 1
|
|
2153
|
-
* @max 50
|
|
2154
|
-
*/
|
|
2155
|
-
limit?: number | null;
|
|
2156
|
-
/** Number of entries to offset. */
|
|
2157
|
-
offset?: number | null;
|
|
2158
|
-
/** Sorting direction (defaults to ASC) and field to sort by. */
|
|
2159
|
-
sorting?: Sorting;
|
|
2160
|
-
/**
|
|
2161
|
-
* Predefined set of fields to return.
|
|
2162
|
-
*
|
|
2163
|
-
* Default: If `fieldSet` is omitted, no order form submission data is returned.
|
|
2164
|
-
*/
|
|
2165
|
-
fieldSet?: SetWithLiterals;
|
|
2166
|
-
}
|
|
2167
|
-
/**
|
|
2168
|
-
* Cancels an order. Recurring orders can be canceled either immediately or at the next payment date. One time orders can only be canceled immediately.
|
|
2169
|
-
*
|
|
2170
|
-
* There may be some operations that continue to be processed before the status of the order is changed to `"CANCELED"`. For example, payments might need to be refunded before the order is fully canceled.
|
|
2171
|
-
*
|
|
2172
|
-
* Canceling during the free trial period: When a buyer cancels their order during the free trial period, the buyer's subscription expires at the end of the free trial period and they won't be billed. The buyer may continue using the benefits until the end of the free trial period.
|
|
2173
|
-
*
|
|
2174
|
-
* >**Note:**
|
|
2175
|
-
* >This method requires [visitor or member authentication](https://dev.wix.com/docs/rest/articles/getting-started/access-types-and-permissions).
|
|
2176
|
-
* @param _id - Order ID.
|
|
2177
|
-
* @param effectiveAt - Required. Whether to cancel the order effective immediately or at the next payment date. One-time orders can only be canceled immediately.
|
|
2178
|
-
* @public
|
|
2179
|
-
* @requiredField _id
|
|
2180
|
-
* @requiredField effectiveAt
|
|
2181
|
-
* @param options - Options for requesting a cancellation.
|
|
2182
|
-
* @permissionId PRICING_PLANS.MANAGE_OWN_ORDERS
|
|
2183
|
-
* @applicableIdentity APP
|
|
2184
|
-
* @applicableIdentity MEMBER
|
|
2185
|
-
* @fqn com.wixpress.membership.v2.orders.member.MemberOrdersService.RequestCancellation
|
|
2186
|
-
*/
|
|
2187
|
-
declare function requestCancellation(_id: string, effectiveAt: CancellationEffectiveAtWithLiterals): Promise<void>;
|
|
2188
2178
|
/**
|
|
2189
2179
|
* Creates an online order for a site member.
|
|
2190
2180
|
*
|
|
@@ -2387,10 +2377,9 @@ interface GetPricePreviewOptions {
|
|
|
2387
2377
|
* @param options - Options to use when getting an order.
|
|
2388
2378
|
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
2389
2379
|
* @applicableIdentity APP
|
|
2390
|
-
* @returns Order.
|
|
2391
2380
|
* @fqn com.wixpress.membership.v2.orders.OrderManagementService.GetOrder
|
|
2392
2381
|
*/
|
|
2393
|
-
declare function managementGetOrder(_id: string, options?: ManagementGetOrderOptions): Promise<NonNullablePaths<
|
|
2382
|
+
declare function managementGetOrder(_id: string, options?: ManagementGetOrderOptions): Promise<NonNullablePaths<GetOrderResponse, `order._id` | `order.planId` | `order.subscriptionId` | `order.buyer.memberId` | `order.buyer.contactId` | `order.priceDetails.subscription.cycleDuration.unit` | `order.priceDetails.subtotal` | `order.priceDetails.discount` | `order.priceDetails.tax.name` | `order.priceDetails.tax.includedInPrice` | `order.priceDetails.tax.rate` | `order.priceDetails.tax.amount` | `order.priceDetails.total` | `order.priceDetails.planPrice` | `order.priceDetails.currency` | `order.priceDetails.coupon.code` | `order.priceDetails.coupon.amount` | `order.priceDetails.coupon._id` | `order.pricing.prices` | `order.pricing.prices.${number}.duration.cycleFrom` | `order.pricing.prices.${number}.price.subtotal` | `order.pricing.prices.${number}.price.discount` | `order.pricing.prices.${number}.price.total` | `order.pricing.prices.${number}.price.currency` | `order.pricing.prices.${number}.price.proration` | `order.type` | `order.status` | `order.cancellation.cause` | `order.cancellation.effectiveAt` | `order.lastPaymentStatus` | `order.pausePeriods` | `order.pausePeriods.${number}.status` | `order.currentCycle.index` | `order.planName` | `order.planDescription` | `order.planPrice`, 7>>;
|
|
2394
2383
|
interface ManagementGetOrderOptions {
|
|
2395
2384
|
/**
|
|
2396
2385
|
* Predefined set of fields to return.
|
|
@@ -2554,5 +2543,86 @@ declare function pauseOrder(_id: string): Promise<void>;
|
|
|
2554
2543
|
* @fqn com.wixpress.membership.v2.orders.OrderManagementService.ResumeOrder
|
|
2555
2544
|
*/
|
|
2556
2545
|
declare function resumeOrder(_id: string): Promise<void>;
|
|
2546
|
+
/**
|
|
2547
|
+
* Retrieves an order for the currently logged-in member by ID.
|
|
2548
|
+
* @param _id - Order ID.
|
|
2549
|
+
* @public
|
|
2550
|
+
* @requiredField _id
|
|
2551
|
+
* @param options - Options for getting a logged-in member's order.
|
|
2552
|
+
* @permissionId PRICING_PLANS.READ_OWN_ORDERS
|
|
2553
|
+
* @applicableIdentity APP
|
|
2554
|
+
* @applicableIdentity MEMBER
|
|
2555
|
+
* @returns Requested order.
|
|
2556
|
+
* @fqn com.wixpress.membership.v2.orders.member.MemberOrdersService.GetOrder
|
|
2557
|
+
*/
|
|
2558
|
+
declare function memberGetOrder(_id: string, options?: MemberGetOrderOptions): Promise<NonNullablePaths<Order, `_id` | `planId` | `subscriptionId` | `buyer.memberId` | `buyer.contactId` | `priceDetails.subscription.cycleDuration.unit` | `priceDetails.subtotal` | `priceDetails.discount` | `priceDetails.tax.name` | `priceDetails.tax.includedInPrice` | `priceDetails.tax.rate` | `priceDetails.tax.amount` | `priceDetails.total` | `priceDetails.planPrice` | `priceDetails.currency` | `priceDetails.coupon.code` | `priceDetails.coupon.amount` | `priceDetails.coupon._id` | `pricing.prices` | `pricing.prices.${number}.duration.cycleFrom` | `pricing.prices.${number}.price.subtotal` | `pricing.prices.${number}.price.discount` | `pricing.prices.${number}.price.total` | `pricing.prices.${number}.price.currency` | `pricing.prices.${number}.price.proration` | `type` | `status` | `cancellation.cause` | `cancellation.effectiveAt` | `lastPaymentStatus` | `pausePeriods` | `pausePeriods.${number}.status` | `currentCycle.index` | `planName` | `planDescription` | `planPrice`, 6>>;
|
|
2559
|
+
interface MemberGetOrderOptions {
|
|
2560
|
+
/**
|
|
2561
|
+
* Predefined set of fields to return.
|
|
2562
|
+
*
|
|
2563
|
+
* Default: If `fieldSet` is omitted, no order form submission data is returned.
|
|
2564
|
+
*/
|
|
2565
|
+
fieldSet?: SetWithLiterals;
|
|
2566
|
+
}
|
|
2567
|
+
/**
|
|
2568
|
+
* Retrieves a list of up to 100 pricing plan orders for currently logged-in member.
|
|
2569
|
+
* @public
|
|
2570
|
+
* @param options - Filtering, sorting, and pagination options.
|
|
2571
|
+
* @permissionId PRICING_PLANS.READ_OWN_ORDERS
|
|
2572
|
+
* @applicableIdentity APP
|
|
2573
|
+
* @applicableIdentity MEMBER
|
|
2574
|
+
* @fqn com.wixpress.membership.v2.orders.member.MemberOrdersService.ListOrders
|
|
2575
|
+
*/
|
|
2576
|
+
declare function memberListOrders(options?: MemberListOrdersOptions): Promise<NonNullablePaths<MemberListOrdersResponse, `orders` | `orders.${number}._id` | `orders.${number}.planId` | `orders.${number}.subscriptionId` | `orders.${number}.buyer.memberId` | `orders.${number}.buyer.contactId` | `orders.${number}.priceDetails.singlePaymentForDuration.unit` | `orders.${number}.priceDetails.subtotal` | `orders.${number}.priceDetails.discount` | `orders.${number}.priceDetails.tax.name` | `orders.${number}.priceDetails.tax.includedInPrice` | `orders.${number}.priceDetails.tax.rate` | `orders.${number}.priceDetails.tax.amount` | `orders.${number}.priceDetails.total` | `orders.${number}.priceDetails.planPrice` | `orders.${number}.priceDetails.currency` | `orders.${number}.priceDetails.coupon.code` | `orders.${number}.priceDetails.coupon.amount` | `orders.${number}.priceDetails.coupon._id` | `orders.${number}.type` | `orders.${number}.status` | `orders.${number}.cancellation.cause` | `orders.${number}.cancellation.effectiveAt` | `orders.${number}.lastPaymentStatus` | `orders.${number}.currentCycle.index` | `orders.${number}.planName` | `orders.${number}.planDescription` | `orders.${number}.planPrice`, 6>>;
|
|
2577
|
+
interface MemberListOrdersOptions {
|
|
2578
|
+
/**
|
|
2579
|
+
* Filter by plan IDs.
|
|
2580
|
+
* @format GUID
|
|
2581
|
+
*/
|
|
2582
|
+
planIds?: string[];
|
|
2583
|
+
/** Filter for orders where auto renewal was canceled. */
|
|
2584
|
+
autoRenewCanceled?: boolean | null;
|
|
2585
|
+
/** Filter by order status. */
|
|
2586
|
+
orderStatuses?: OrderStatusWithLiterals[];
|
|
2587
|
+
/** Filter by payment status. */
|
|
2588
|
+
paymentStatuses?: PaymentStatusWithLiterals[];
|
|
2589
|
+
/**
|
|
2590
|
+
* Limit the number of pricing plans returned. Default limit is 50.
|
|
2591
|
+
* @min 1
|
|
2592
|
+
* @max 50
|
|
2593
|
+
*/
|
|
2594
|
+
limit?: number | null;
|
|
2595
|
+
/** Number of entries to offset. */
|
|
2596
|
+
offset?: number | null;
|
|
2597
|
+
/** Sorting direction (defaults to ASC) and field to sort by. */
|
|
2598
|
+
sorting?: Sorting;
|
|
2599
|
+
/**
|
|
2600
|
+
* Predefined set of fields to return.
|
|
2601
|
+
*
|
|
2602
|
+
* Default: If `fieldSet` is omitted, no order form submission data is returned.
|
|
2603
|
+
*/
|
|
2604
|
+
fieldSet?: SetWithLiterals;
|
|
2605
|
+
}
|
|
2606
|
+
/**
|
|
2607
|
+
* Cancels an order. Recurring orders can be canceled either immediately or at the next payment date. One time orders can only be canceled immediately.
|
|
2608
|
+
*
|
|
2609
|
+
* There may be some operations that continue to be processed before the status of the order is changed to `"CANCELED"`. For example, payments might need to be refunded before the order is fully canceled.
|
|
2610
|
+
*
|
|
2611
|
+
* Canceling during the free trial period: When a buyer cancels their order during the free trial period, the buyer's subscription expires at the end of the free trial period and they won't be billed. The buyer may continue using the benefits until the end of the free trial period.
|
|
2612
|
+
*
|
|
2613
|
+
* >**Note:**
|
|
2614
|
+
* >This method requires [visitor or member authentication](https://dev.wix.com/docs/rest/articles/getting-started/access-types-and-permissions).
|
|
2615
|
+
* @param _id - Order ID.
|
|
2616
|
+
* @param effectiveAt - Required. Whether to cancel the order effective immediately or at the next payment date. One-time orders can only be canceled immediately.
|
|
2617
|
+
* @public
|
|
2618
|
+
* @requiredField _id
|
|
2619
|
+
* @requiredField effectiveAt
|
|
2620
|
+
* @param options - Options for requesting a cancellation.
|
|
2621
|
+
* @permissionId PRICING_PLANS.MANAGE_OWN_ORDERS
|
|
2622
|
+
* @applicableIdentity APP
|
|
2623
|
+
* @applicableIdentity MEMBER
|
|
2624
|
+
* @fqn com.wixpress.membership.v2.orders.member.MemberOrdersService.RequestCancellation
|
|
2625
|
+
*/
|
|
2626
|
+
declare function requestCancellation(_id: string, effectiveAt: CancellationEffectiveAtWithLiterals): Promise<void>;
|
|
2557
2627
|
|
|
2558
|
-
export { type AccountInfo, type AccountInfoMetadata, type ActionEvent, type ApplicationError, type ApplyCouponRequest, type ApplyCouponResponse, type BaseEventMetadata, type BulkActionMetadata, type BulkOrderResult, type BulkPauseOrderRequest, type BulkPauseOrderResponse, type BulkResumeOrderRequest, type BulkResumeOrderResponse, type Buyer, type CancelOrderRequest, type CancelOrderResponse, type Cancellation, CancellationCause, type CancellationCauseWithLiterals, CancellationEffectiveAt, type CancellationEffectiveAtWithLiterals, type Captcha, type ChangeStartDateRequest, type ChangeStartDateResponse, type Coupon, type CouponsError, type CreateExternalOrderRequest, type CreateExternalOrderResponse, type CreateGuestOnlineOrderRequest, type CreateGuestOnlineOrderResponse, type CreateOfflineOrderApplicationErrors, type CreateOfflineOrderOptions, type CreateOfflineOrderRequest, type CreateOfflineOrderResponse, type CreateOfflineOrderValidationErrors, type CreateOnlineOrderApplicationErrors, type CreateOnlineOrderOptions, type CreateOnlineOrderRequest, type CreateOnlineOrderResponse, type CreateOnlineOrderValidationErrors, type CurrentCycle, type Cursors, type DomainEvent, type DomainEventBodyOneOf, type Duration, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, type Fee, type FormData, type GetAvailableOrderActionsRequest, type GetAvailableOrderActionsResponse, type GetGuestOnlineOrderPreviewRequest, type GetGuestOnlineOrderPreviewResponse, type GetOfflineOrderPreviewApplicationErrors, type GetOfflineOrderPreviewOptions, type GetOfflineOrderPreviewRequest, type GetOfflineOrderPreviewResponse, type GetOfflineOrderPreviewValidationErrors, type GetOnlineOrderPreviewApplicationErrors, type GetOnlineOrderPreviewOptions, type GetOnlineOrderPreviewRequest, type GetOnlineOrderPreviewResponse, type GetOnlineOrderPreviewValidationErrors, type GetOrderRequest, type GetOrderResponse, type GetOrdersStatsRequest, type GetOrdersStatsResponse, type GetPricePreviewApplicationErrors, type GetPricePreviewOptions, type GetPricePreviewRequest, type GetPricePreviewResponse, type Guest, type IdentificationData, type IdentificationDataIdOneOf, type ItemMetadata, type ListOrdersRequest, type ListOrdersResponse, type ManagementGetOrderOptions, type ManagementListOrdersOptions, type MarkAsPaidRequest, type MarkAsPaidResponse, type MemberGetOrderOptions, type MemberGetOrderRequest, type MemberGetOrderResponse, type MemberListOrdersOptions, type MemberListOrdersRequest, type MemberListOrdersResponse, type MessageEnvelope, type OnBehalf, type Order, type OrderAutoRenewCanceled, type OrderAutoRenewCanceledEnvelope, type OrderCanceled, type OrderCanceledEnvelope, type OrderCreatedEnvelope, type OrderCycle, type OrderCycleStarted, type OrderCycleStartedEnvelope, type OrderEndDatePostponed, type OrderEndDatePostponedEnvelope, type OrderEnded, type OrderEndedEnvelope, type OrderMarkedAsPaid, type OrderMarkedAsPaidEnvelope, OrderMethod, type OrderMethodWithLiterals, type OrderPaused, type OrderPausedEnvelope, type OrderPurchased, type OrderPurchasedEnvelope, type OrderResumed, type OrderResumedEnvelope, type OrderStartDateChanged, type OrderStartDateChangedEnvelope, type OrderStarted, type OrderStartedEnvelope, OrderStatus, type OrderStatusWithLiterals, OrderType, type OrderTypeWithLiterals, type OrderUpdatedEnvelope, type PagingMetadataV2, type PauseOrderRequest, type PauseOrderResponse, type PausePeriod, PaymentStatus, type PaymentStatusWithLiterals, PeriodUnit, type PeriodUnitWithLiterals, type PostponeEndDateRequest, type PostponeEndDateResponse, type Price, type PriceDetails, type PriceDetailsPricingModelOneOf, type PriceDuration, type PricingDetails, type PricingDetailsPricingModelOneOf, ReasonNotSuspendable, type ReasonNotSuspendableWithLiterals, type Recurrence, type RequestCancellationRequest, type RequestCancellationResponse, type RestoreInfo, type ResumeOrderRequest, type ResumeOrderResponse, Set, type SetSubmissionRequest, type SetSubmissionResponse, type SetWithLiterals, SortOrder, type SortOrderWithLiterals, type Sorting, type SpannedPrice, Status, type StatusWithLiterals, type Tax, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, cancelOrder, createOfflineOrder, createOnlineOrder, getOfflineOrderPreview, getOnlineOrderPreview, getPricePreview, managementGetOrder, managementListOrders, markAsPaid, memberGetOrder, memberListOrders, onOrderAutoRenewCanceled, onOrderCanceled, onOrderCreated, onOrderCycleStarted, onOrderEndDatePostponed, onOrderEnded, onOrderMarkedAsPaid, onOrderPaused, onOrderPurchased, onOrderResumed, onOrderStartDateChanged, onOrderStarted, onOrderUpdated, pauseOrder, postponeEndDate, requestCancellation, resumeOrder };
|
|
2628
|
+
export { type AccountInfo, type AccountInfoMetadata, type ActionEvent, type AddressLocation, type ApplicationError, type ApplyCouponRequest, type ApplyCouponResponse, type BaseEventMetadata, type BulkActionMetadata, type BulkOrderResult, type BulkPauseOrderRequest, type BulkPauseOrderResponse, type BulkResumeOrderRequest, type BulkResumeOrderResponse, type Buyer, type CancelOrderRequest, type CancelOrderResponse, type Cancellation, CancellationCause, type CancellationCauseWithLiterals, CancellationEffectiveAt, type CancellationEffectiveAtWithLiterals, type Captcha, type ChangeStartDateRequest, type ChangeStartDateResponse, type Coupon, type CouponsError, type CreateExternalOrderRequest, type CreateExternalOrderResponse, type CreateGuestOnlineOrderRequest, type CreateGuestOnlineOrderResponse, type CreateOfflineOrderApplicationErrors, type CreateOfflineOrderOptions, type CreateOfflineOrderRequest, type CreateOfflineOrderResponse, type CreateOfflineOrderValidationErrors, type CreateOnlineOrderApplicationErrors, type CreateOnlineOrderOptions, type CreateOnlineOrderRequest, type CreateOnlineOrderResponse, type CreateOnlineOrderValidationErrors, type CurrentCycle, type Cursors, type DomainEvent, type DomainEventBodyOneOf, type Duration, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, type Fee, type FormData, type GetAvailableOrderActionsRequest, type GetAvailableOrderActionsResponse, type GetGuestOnlineOrderPreviewRequest, type GetGuestOnlineOrderPreviewResponse, type GetOfflineOrderPreviewApplicationErrors, type GetOfflineOrderPreviewOptions, type GetOfflineOrderPreviewRequest, type GetOfflineOrderPreviewResponse, type GetOfflineOrderPreviewValidationErrors, type GetOnlineOrderPreviewApplicationErrors, type GetOnlineOrderPreviewOptions, type GetOnlineOrderPreviewRequest, type GetOnlineOrderPreviewResponse, type GetOnlineOrderPreviewValidationErrors, type GetOrderRequest, type GetOrderResponse, type GetOrdersStatsRequest, type GetOrdersStatsResponse, type GetPricePreviewApplicationErrors, type GetPricePreviewOptions, type GetPricePreviewRequest, type GetPricePreviewResponse, type Guest, type IdentificationData, type IdentificationDataIdOneOf, type ItemMetadata, type ListOrdersRequest, type ListOrdersResponse, type ManagementGetOrderOptions, type ManagementListOrdersOptions, type MarkAsPaidRequest, type MarkAsPaidResponse, type MemberGetOrderOptions, type MemberGetOrderRequest, type MemberGetOrderResponse, type MemberListOrdersOptions, type MemberListOrdersRequest, type MemberListOrdersResponse, type MessageEnvelope, type OnBehalf, type Order, type OrderAutoRenewCanceled, type OrderAutoRenewCanceledEnvelope, type OrderCanceled, type OrderCanceledEnvelope, type OrderCreatedEnvelope, type OrderCycle, type OrderCycleStarted, type OrderCycleStartedEnvelope, type OrderEndDatePostponed, type OrderEndDatePostponedEnvelope, type OrderEnded, type OrderEndedEnvelope, type OrderMarkedAsPaid, type OrderMarkedAsPaidEnvelope, OrderMethod, type OrderMethodWithLiterals, type OrderPaused, type OrderPausedEnvelope, type OrderPurchased, type OrderPurchasedEnvelope, type OrderResumed, type OrderResumedEnvelope, type OrderStartDateChanged, type OrderStartDateChangedEnvelope, type OrderStarted, type OrderStartedEnvelope, OrderStatus, type OrderStatusWithLiterals, OrderType, type OrderTypeWithLiterals, type OrderUpdatedEnvelope, type PagingMetadataV2, type PauseOrderRequest, type PauseOrderResponse, type PausePeriod, PaymentStatus, type PaymentStatusWithLiterals, PeriodUnit, type PeriodUnitWithLiterals, type PostponeEndDateRequest, type PostponeEndDateResponse, type Price, type PriceDetails, type PriceDetailsPricingModelOneOf, type PriceDuration, type PricingDetails, type PricingDetailsPricingModelOneOf, ReasonNotSuspendable, type ReasonNotSuspendableWithLiterals, type Recurrence, type RequestCancellationRequest, type RequestCancellationResponse, type RestoreInfo, type ResumeOrderRequest, type ResumeOrderResponse, Set, type SetSubmissionRequest, type SetSubmissionResponse, type SetWithLiterals, SortOrder, type SortOrderWithLiterals, type Sorting, type SpannedPrice, Status, type StatusWithLiterals, type Tax, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, cancelOrder, createOfflineOrder, createOnlineOrder, getOfflineOrderPreview, getOnlineOrderPreview, getPricePreview, managementGetOrder, managementListOrders, markAsPaid, memberGetOrder, memberListOrders, onOrderAutoRenewCanceled, onOrderCanceled, onOrderCreated, onOrderCycleStarted, onOrderEndDatePostponed, onOrderEnded, onOrderMarkedAsPaid, onOrderPaused, onOrderPurchased, onOrderResumed, onOrderStartDateChanged, onOrderStarted, onOrderUpdated, pauseOrder, postponeEndDate, requestCancellation, resumeOrder };
|