@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
|
@@ -626,218 +626,6 @@ interface ActionEvent {
|
|
|
626
626
|
}
|
|
627
627
|
interface Empty {
|
|
628
628
|
}
|
|
629
|
-
interface MemberGetOrderRequest {
|
|
630
|
-
/**
|
|
631
|
-
* Order ID.
|
|
632
|
-
* @format GUID
|
|
633
|
-
*/
|
|
634
|
-
_id: string;
|
|
635
|
-
/**
|
|
636
|
-
* Predefined set of fields to return.
|
|
637
|
-
*
|
|
638
|
-
* Default: If `fieldSet` is omitted, no order form submission data is returned.
|
|
639
|
-
*/
|
|
640
|
-
fieldSet?: SetWithLiterals;
|
|
641
|
-
}
|
|
642
|
-
declare enum Set {
|
|
643
|
-
/** Same behavior as `BASIC`.` */
|
|
644
|
-
UNKNOWN_SET = "UNKNOWN_SET",
|
|
645
|
-
/** Doesn't return any order form submission data. */
|
|
646
|
-
BASIC = "BASIC",
|
|
647
|
-
/** Returns all order form submission data. */
|
|
648
|
-
FULL = "FULL"
|
|
649
|
-
}
|
|
650
|
-
/** @enumType */
|
|
651
|
-
type SetWithLiterals = Set | 'UNKNOWN_SET' | 'BASIC' | 'FULL';
|
|
652
|
-
interface MemberGetOrderResponse {
|
|
653
|
-
/** Requested order. */
|
|
654
|
-
order?: Order;
|
|
655
|
-
}
|
|
656
|
-
interface MemberListOrdersRequest {
|
|
657
|
-
/**
|
|
658
|
-
* Filter by plan IDs.
|
|
659
|
-
* @format GUID
|
|
660
|
-
*/
|
|
661
|
-
planIds?: string[];
|
|
662
|
-
/** Filter for orders where auto renewal was canceled. */
|
|
663
|
-
autoRenewCanceled?: boolean | null;
|
|
664
|
-
/** Filter by order status. */
|
|
665
|
-
orderStatuses?: OrderStatusWithLiterals[];
|
|
666
|
-
/** Filter by payment status. */
|
|
667
|
-
paymentStatuses?: PaymentStatusWithLiterals[];
|
|
668
|
-
/**
|
|
669
|
-
* Limit the number of pricing plans returned. Default limit is 50.
|
|
670
|
-
* @min 1
|
|
671
|
-
* @max 50
|
|
672
|
-
*/
|
|
673
|
-
limit?: number | null;
|
|
674
|
-
/** Number of entries to offset. */
|
|
675
|
-
offset?: number | null;
|
|
676
|
-
/** Sorting direction (defaults to ASC) and field to sort by. */
|
|
677
|
-
sorting?: Sorting;
|
|
678
|
-
/**
|
|
679
|
-
* Predefined set of fields to return.
|
|
680
|
-
*
|
|
681
|
-
* Default: If `fieldSet` is omitted, no order form submission data is returned.
|
|
682
|
-
*/
|
|
683
|
-
fieldSet?: SetWithLiterals;
|
|
684
|
-
}
|
|
685
|
-
interface Sorting {
|
|
686
|
-
/**
|
|
687
|
-
* Name of the field to sort by.
|
|
688
|
-
* @maxLength 512
|
|
689
|
-
*/
|
|
690
|
-
fieldName?: string;
|
|
691
|
-
/** Sort order. */
|
|
692
|
-
order?: SortOrderWithLiterals;
|
|
693
|
-
}
|
|
694
|
-
declare enum SortOrder {
|
|
695
|
-
ASC = "ASC",
|
|
696
|
-
DESC = "DESC"
|
|
697
|
-
}
|
|
698
|
-
/** @enumType */
|
|
699
|
-
type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
700
|
-
interface MemberListOrdersResponse {
|
|
701
|
-
/** Requested orders. */
|
|
702
|
-
orders?: Order[];
|
|
703
|
-
/** Object containing paging-related data (number of orders returned, offset). */
|
|
704
|
-
pagingMetadata?: PagingMetadataV2;
|
|
705
|
-
}
|
|
706
|
-
interface PagingMetadataV2 {
|
|
707
|
-
/** Number of items returned in the response. */
|
|
708
|
-
count?: number | null;
|
|
709
|
-
/** Offset that was requested. */
|
|
710
|
-
offset?: number | null;
|
|
711
|
-
/** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
|
|
712
|
-
total?: number | null;
|
|
713
|
-
/** Flag that indicates the server failed to calculate the `total` field. */
|
|
714
|
-
tooManyToCount?: boolean | null;
|
|
715
|
-
/** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
|
|
716
|
-
cursors?: Cursors;
|
|
717
|
-
}
|
|
718
|
-
interface Cursors {
|
|
719
|
-
/**
|
|
720
|
-
* Cursor string pointing to the next page in the list of results.
|
|
721
|
-
* @maxLength 16000
|
|
722
|
-
*/
|
|
723
|
-
next?: string | null;
|
|
724
|
-
/**
|
|
725
|
-
* Cursor pointing to the previous page in the list of results.
|
|
726
|
-
* @maxLength 16000
|
|
727
|
-
*/
|
|
728
|
-
prev?: string | null;
|
|
729
|
-
}
|
|
730
|
-
interface RequestCancellationRequest {
|
|
731
|
-
/**
|
|
732
|
-
* Order ID.
|
|
733
|
-
* @format GUID
|
|
734
|
-
*/
|
|
735
|
-
_id: string;
|
|
736
|
-
/** Required. Whether to cancel the order effective immediately or at the next payment date. One-time orders can only be canceled immediately. */
|
|
737
|
-
effectiveAt: CancellationEffectiveAtWithLiterals;
|
|
738
|
-
}
|
|
739
|
-
interface RequestCancellationResponse {
|
|
740
|
-
}
|
|
741
|
-
/**
|
|
742
|
-
* Emitted when an order is canceled immediately or when cycle ends for an order with canceled auto renewal
|
|
743
|
-
*
|
|
744
|
-
* To determine the specific reason of the cancellation check `order.cancellation.cause` field.
|
|
745
|
-
*/
|
|
746
|
-
interface OrderCanceled {
|
|
747
|
-
/** Canceled order. */
|
|
748
|
-
order?: Order;
|
|
749
|
-
}
|
|
750
|
-
interface MessageEnvelope {
|
|
751
|
-
/**
|
|
752
|
-
* App instance ID.
|
|
753
|
-
* @format GUID
|
|
754
|
-
*/
|
|
755
|
-
instanceId?: string | null;
|
|
756
|
-
/**
|
|
757
|
-
* Event type.
|
|
758
|
-
* @maxLength 150
|
|
759
|
-
*/
|
|
760
|
-
eventType?: string;
|
|
761
|
-
/** The identification type and identity data. */
|
|
762
|
-
identity?: IdentificationData;
|
|
763
|
-
/** Stringify payload. */
|
|
764
|
-
data?: string;
|
|
765
|
-
/** Details related to the account */
|
|
766
|
-
accountInfo?: AccountInfo;
|
|
767
|
-
}
|
|
768
|
-
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
769
|
-
/**
|
|
770
|
-
* ID of a site visitor that has not logged in to the site.
|
|
771
|
-
* @format GUID
|
|
772
|
-
*/
|
|
773
|
-
anonymousVisitorId?: string;
|
|
774
|
-
/**
|
|
775
|
-
* ID of a site visitor that has logged in to the site.
|
|
776
|
-
* @format GUID
|
|
777
|
-
*/
|
|
778
|
-
memberId?: string;
|
|
779
|
-
/**
|
|
780
|
-
* ID of a Wix user (site owner, contributor, etc.).
|
|
781
|
-
* @format GUID
|
|
782
|
-
*/
|
|
783
|
-
wixUserId?: string;
|
|
784
|
-
/**
|
|
785
|
-
* ID of an app.
|
|
786
|
-
* @format GUID
|
|
787
|
-
*/
|
|
788
|
-
appId?: string;
|
|
789
|
-
/** @readonly */
|
|
790
|
-
identityType?: WebhookIdentityTypeWithLiterals;
|
|
791
|
-
}
|
|
792
|
-
/** @oneof */
|
|
793
|
-
interface IdentificationDataIdOneOf {
|
|
794
|
-
/**
|
|
795
|
-
* ID of a site visitor that has not logged in to the site.
|
|
796
|
-
* @format GUID
|
|
797
|
-
*/
|
|
798
|
-
anonymousVisitorId?: string;
|
|
799
|
-
/**
|
|
800
|
-
* ID of a site visitor that has logged in to the site.
|
|
801
|
-
* @format GUID
|
|
802
|
-
*/
|
|
803
|
-
memberId?: string;
|
|
804
|
-
/**
|
|
805
|
-
* ID of a Wix user (site owner, contributor, etc.).
|
|
806
|
-
* @format GUID
|
|
807
|
-
*/
|
|
808
|
-
wixUserId?: string;
|
|
809
|
-
/**
|
|
810
|
-
* ID of an app.
|
|
811
|
-
* @format GUID
|
|
812
|
-
*/
|
|
813
|
-
appId?: string;
|
|
814
|
-
}
|
|
815
|
-
declare enum WebhookIdentityType {
|
|
816
|
-
UNKNOWN = "UNKNOWN",
|
|
817
|
-
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
818
|
-
MEMBER = "MEMBER",
|
|
819
|
-
WIX_USER = "WIX_USER",
|
|
820
|
-
APP = "APP"
|
|
821
|
-
}
|
|
822
|
-
/** @enumType */
|
|
823
|
-
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
824
|
-
interface AccountInfo {
|
|
825
|
-
/**
|
|
826
|
-
* ID of the Wix account associated with the event.
|
|
827
|
-
* @format GUID
|
|
828
|
-
*/
|
|
829
|
-
accountId?: string | null;
|
|
830
|
-
/**
|
|
831
|
-
* ID of the parent Wix account. Only included when accountId belongs to a child account.
|
|
832
|
-
* @format GUID
|
|
833
|
-
*/
|
|
834
|
-
parentAccountId?: string | null;
|
|
835
|
-
/**
|
|
836
|
-
* ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
|
|
837
|
-
* @format GUID
|
|
838
|
-
*/
|
|
839
|
-
siteId?: string | null;
|
|
840
|
-
}
|
|
841
629
|
interface CreateOnlineOrderRequest {
|
|
842
630
|
/**
|
|
843
631
|
* Plan ID.
|
|
@@ -1141,6 +929,97 @@ interface SetSubmissionResponse {
|
|
|
1141
929
|
/** Order with submission id */
|
|
1142
930
|
order?: Order;
|
|
1143
931
|
}
|
|
932
|
+
interface MessageEnvelope {
|
|
933
|
+
/**
|
|
934
|
+
* App instance ID.
|
|
935
|
+
* @format GUID
|
|
936
|
+
*/
|
|
937
|
+
instanceId?: string | null;
|
|
938
|
+
/**
|
|
939
|
+
* Event type.
|
|
940
|
+
* @maxLength 150
|
|
941
|
+
*/
|
|
942
|
+
eventType?: string;
|
|
943
|
+
/** The identification type and identity data. */
|
|
944
|
+
identity?: IdentificationData;
|
|
945
|
+
/** Stringify payload. */
|
|
946
|
+
data?: string;
|
|
947
|
+
/** Details related to the account */
|
|
948
|
+
accountInfo?: AccountInfo;
|
|
949
|
+
}
|
|
950
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
951
|
+
/**
|
|
952
|
+
* ID of a site visitor that has not logged in to the site.
|
|
953
|
+
* @format GUID
|
|
954
|
+
*/
|
|
955
|
+
anonymousVisitorId?: string;
|
|
956
|
+
/**
|
|
957
|
+
* ID of a site visitor that has logged in to the site.
|
|
958
|
+
* @format GUID
|
|
959
|
+
*/
|
|
960
|
+
memberId?: string;
|
|
961
|
+
/**
|
|
962
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
963
|
+
* @format GUID
|
|
964
|
+
*/
|
|
965
|
+
wixUserId?: string;
|
|
966
|
+
/**
|
|
967
|
+
* ID of an app.
|
|
968
|
+
* @format GUID
|
|
969
|
+
*/
|
|
970
|
+
appId?: string;
|
|
971
|
+
/** @readonly */
|
|
972
|
+
identityType?: WebhookIdentityTypeWithLiterals;
|
|
973
|
+
}
|
|
974
|
+
/** @oneof */
|
|
975
|
+
interface IdentificationDataIdOneOf {
|
|
976
|
+
/**
|
|
977
|
+
* ID of a site visitor that has not logged in to the site.
|
|
978
|
+
* @format GUID
|
|
979
|
+
*/
|
|
980
|
+
anonymousVisitorId?: string;
|
|
981
|
+
/**
|
|
982
|
+
* ID of a site visitor that has logged in to the site.
|
|
983
|
+
* @format GUID
|
|
984
|
+
*/
|
|
985
|
+
memberId?: string;
|
|
986
|
+
/**
|
|
987
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
988
|
+
* @format GUID
|
|
989
|
+
*/
|
|
990
|
+
wixUserId?: string;
|
|
991
|
+
/**
|
|
992
|
+
* ID of an app.
|
|
993
|
+
* @format GUID
|
|
994
|
+
*/
|
|
995
|
+
appId?: string;
|
|
996
|
+
}
|
|
997
|
+
declare enum WebhookIdentityType {
|
|
998
|
+
UNKNOWN = "UNKNOWN",
|
|
999
|
+
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
1000
|
+
MEMBER = "MEMBER",
|
|
1001
|
+
WIX_USER = "WIX_USER",
|
|
1002
|
+
APP = "APP"
|
|
1003
|
+
}
|
|
1004
|
+
/** @enumType */
|
|
1005
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
1006
|
+
interface AccountInfo {
|
|
1007
|
+
/**
|
|
1008
|
+
* ID of the Wix account associated with the event.
|
|
1009
|
+
* @format GUID
|
|
1010
|
+
*/
|
|
1011
|
+
accountId?: string | null;
|
|
1012
|
+
/**
|
|
1013
|
+
* ID of the parent Wix account. Only included when accountId belongs to a child account.
|
|
1014
|
+
* @format GUID
|
|
1015
|
+
*/
|
|
1016
|
+
parentAccountId?: string | null;
|
|
1017
|
+
/**
|
|
1018
|
+
* ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
|
|
1019
|
+
* @format GUID
|
|
1020
|
+
*/
|
|
1021
|
+
siteId?: string | null;
|
|
1022
|
+
}
|
|
1144
1023
|
interface OrderPurchased {
|
|
1145
1024
|
/** Order that was paid for. If a free or an offline order, the order that was created. */
|
|
1146
1025
|
order?: Order;
|
|
@@ -1182,6 +1061,16 @@ interface GetOrderRequest {
|
|
|
1182
1061
|
*/
|
|
1183
1062
|
fieldSet?: SetWithLiterals;
|
|
1184
1063
|
}
|
|
1064
|
+
declare enum Set {
|
|
1065
|
+
/** Same behavior as `BASIC`.` */
|
|
1066
|
+
UNKNOWN_SET = "UNKNOWN_SET",
|
|
1067
|
+
/** Doesn't return any order form submission data. */
|
|
1068
|
+
BASIC = "BASIC",
|
|
1069
|
+
/** Returns all order form submission data. */
|
|
1070
|
+
FULL = "FULL"
|
|
1071
|
+
}
|
|
1072
|
+
/** @enumType */
|
|
1073
|
+
type SetWithLiterals = Set | 'UNKNOWN_SET' | 'BASIC' | 'FULL';
|
|
1185
1074
|
interface GetOrderResponse {
|
|
1186
1075
|
/** Order. */
|
|
1187
1076
|
order?: Order;
|
|
@@ -1228,12 +1117,62 @@ interface ListOrdersRequest {
|
|
|
1228
1117
|
*/
|
|
1229
1118
|
fieldSet?: SetWithLiterals;
|
|
1230
1119
|
}
|
|
1120
|
+
interface Sorting {
|
|
1121
|
+
/**
|
|
1122
|
+
* Name of the field to sort by.
|
|
1123
|
+
* @maxLength 512
|
|
1124
|
+
*/
|
|
1125
|
+
fieldName?: string;
|
|
1126
|
+
/** Sort order. */
|
|
1127
|
+
order?: SortOrderWithLiterals;
|
|
1128
|
+
/**
|
|
1129
|
+
* Origin point for geo-distance sorting on a GEO field
|
|
1130
|
+
* results are ordered by distance from this point (ASC = nearest first, DESC = farthest first).
|
|
1131
|
+
*/
|
|
1132
|
+
origin?: AddressLocation;
|
|
1133
|
+
}
|
|
1134
|
+
declare enum SortOrder {
|
|
1135
|
+
ASC = "ASC",
|
|
1136
|
+
DESC = "DESC"
|
|
1137
|
+
}
|
|
1138
|
+
/** @enumType */
|
|
1139
|
+
type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
1140
|
+
interface AddressLocation {
|
|
1141
|
+
/** Address latitude. */
|
|
1142
|
+
latitude?: number | null;
|
|
1143
|
+
/** Address longitude. */
|
|
1144
|
+
longitude?: number | null;
|
|
1145
|
+
}
|
|
1231
1146
|
interface ListOrdersResponse {
|
|
1232
1147
|
/** List of orders. */
|
|
1233
1148
|
orders?: Order[];
|
|
1234
1149
|
/** Object containing paging-related data (number of orders returned, offset). */
|
|
1235
1150
|
pagingMetadata?: PagingMetadataV2;
|
|
1236
1151
|
}
|
|
1152
|
+
interface PagingMetadataV2 {
|
|
1153
|
+
/** Number of items returned in the response. */
|
|
1154
|
+
count?: number | null;
|
|
1155
|
+
/** Offset that was requested. */
|
|
1156
|
+
offset?: number | null;
|
|
1157
|
+
/** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
|
|
1158
|
+
total?: number | null;
|
|
1159
|
+
/** Flag that indicates the server failed to calculate the `total` field. */
|
|
1160
|
+
tooManyToCount?: boolean | null;
|
|
1161
|
+
/** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
|
|
1162
|
+
cursors?: Cursors;
|
|
1163
|
+
}
|
|
1164
|
+
interface Cursors {
|
|
1165
|
+
/**
|
|
1166
|
+
* Cursor string pointing to the next page in the list of results.
|
|
1167
|
+
* @maxLength 16000
|
|
1168
|
+
*/
|
|
1169
|
+
next?: string | null;
|
|
1170
|
+
/**
|
|
1171
|
+
* Cursor pointing to the previous page in the list of results.
|
|
1172
|
+
* @maxLength 16000
|
|
1173
|
+
*/
|
|
1174
|
+
prev?: string | null;
|
|
1175
|
+
}
|
|
1237
1176
|
interface GetOrdersStatsRequest {
|
|
1238
1177
|
}
|
|
1239
1178
|
interface GetOrdersStatsResponse {
|
|
@@ -1307,6 +1246,15 @@ interface CancelOrderRequest {
|
|
|
1307
1246
|
}
|
|
1308
1247
|
interface CancelOrderResponse {
|
|
1309
1248
|
}
|
|
1249
|
+
/**
|
|
1250
|
+
* Emitted when an order is canceled immediately or when cycle ends for an order with canceled auto renewal
|
|
1251
|
+
*
|
|
1252
|
+
* To determine the specific reason of the cancellation check `order.cancellation.cause` field.
|
|
1253
|
+
*/
|
|
1254
|
+
interface OrderCanceled {
|
|
1255
|
+
/** Canceled order. */
|
|
1256
|
+
order?: Order;
|
|
1257
|
+
}
|
|
1310
1258
|
interface MarkAsPaidRequest {
|
|
1311
1259
|
/**
|
|
1312
1260
|
* Order ID.
|
|
@@ -1384,33 +1332,96 @@ interface BulkActionMetadata {
|
|
|
1384
1332
|
}
|
|
1385
1333
|
interface ResumeOrderRequest {
|
|
1386
1334
|
/**
|
|
1387
|
-
* Order ID.
|
|
1388
|
-
* @format GUID
|
|
1335
|
+
* Order ID.
|
|
1336
|
+
* @format GUID
|
|
1337
|
+
*/
|
|
1338
|
+
_id: string;
|
|
1339
|
+
}
|
|
1340
|
+
interface ResumeOrderResponse {
|
|
1341
|
+
}
|
|
1342
|
+
interface OrderResumed {
|
|
1343
|
+
/** Resumed order. */
|
|
1344
|
+
order?: Order;
|
|
1345
|
+
}
|
|
1346
|
+
interface BulkResumeOrderRequest {
|
|
1347
|
+
/**
|
|
1348
|
+
* List of Order IDs.
|
|
1349
|
+
* @format GUID
|
|
1350
|
+
* @minSize 1
|
|
1351
|
+
* @maxSize 100
|
|
1352
|
+
*/
|
|
1353
|
+
ids?: string[];
|
|
1354
|
+
/** Set to true to return Order entity in response. */
|
|
1355
|
+
returnFullEntity?: boolean;
|
|
1356
|
+
}
|
|
1357
|
+
interface BulkResumeOrderResponse {
|
|
1358
|
+
/** Orders that were resumed. */
|
|
1359
|
+
results?: BulkOrderResult[];
|
|
1360
|
+
/** Bulk action metadata. */
|
|
1361
|
+
bulkActionMetadata?: BulkActionMetadata;
|
|
1362
|
+
}
|
|
1363
|
+
interface MemberGetOrderRequest {
|
|
1364
|
+
/**
|
|
1365
|
+
* Order ID.
|
|
1366
|
+
* @format GUID
|
|
1367
|
+
*/
|
|
1368
|
+
_id: string;
|
|
1369
|
+
/**
|
|
1370
|
+
* Predefined set of fields to return.
|
|
1371
|
+
*
|
|
1372
|
+
* Default: If `fieldSet` is omitted, no order form submission data is returned.
|
|
1373
|
+
*/
|
|
1374
|
+
fieldSet?: SetWithLiterals;
|
|
1375
|
+
}
|
|
1376
|
+
interface MemberGetOrderResponse {
|
|
1377
|
+
/** Requested order. */
|
|
1378
|
+
order?: Order;
|
|
1379
|
+
}
|
|
1380
|
+
interface MemberListOrdersRequest {
|
|
1381
|
+
/**
|
|
1382
|
+
* Filter by plan IDs.
|
|
1383
|
+
* @format GUID
|
|
1384
|
+
*/
|
|
1385
|
+
planIds?: string[];
|
|
1386
|
+
/** Filter for orders where auto renewal was canceled. */
|
|
1387
|
+
autoRenewCanceled?: boolean | null;
|
|
1388
|
+
/** Filter by order status. */
|
|
1389
|
+
orderStatuses?: OrderStatusWithLiterals[];
|
|
1390
|
+
/** Filter by payment status. */
|
|
1391
|
+
paymentStatuses?: PaymentStatusWithLiterals[];
|
|
1392
|
+
/**
|
|
1393
|
+
* Limit the number of pricing plans returned. Default limit is 50.
|
|
1394
|
+
* @min 1
|
|
1395
|
+
* @max 50
|
|
1389
1396
|
*/
|
|
1390
|
-
|
|
1391
|
-
|
|
1392
|
-
|
|
1397
|
+
limit?: number | null;
|
|
1398
|
+
/** Number of entries to offset. */
|
|
1399
|
+
offset?: number | null;
|
|
1400
|
+
/** Sorting direction (defaults to ASC) and field to sort by. */
|
|
1401
|
+
sorting?: Sorting;
|
|
1402
|
+
/**
|
|
1403
|
+
* Predefined set of fields to return.
|
|
1404
|
+
*
|
|
1405
|
+
* Default: If `fieldSet` is omitted, no order form submission data is returned.
|
|
1406
|
+
*/
|
|
1407
|
+
fieldSet?: SetWithLiterals;
|
|
1393
1408
|
}
|
|
1394
|
-
interface
|
|
1395
|
-
/**
|
|
1396
|
-
|
|
1409
|
+
interface MemberListOrdersResponse {
|
|
1410
|
+
/** Requested orders. */
|
|
1411
|
+
orders?: Order[];
|
|
1412
|
+
/** Object containing paging-related data (number of orders returned, offset). */
|
|
1413
|
+
pagingMetadata?: PagingMetadataV2;
|
|
1397
1414
|
}
|
|
1398
|
-
interface
|
|
1415
|
+
interface RequestCancellationRequest {
|
|
1399
1416
|
/**
|
|
1400
|
-
*
|
|
1417
|
+
* Order ID.
|
|
1401
1418
|
* @format GUID
|
|
1402
|
-
* @minSize 1
|
|
1403
|
-
* @maxSize 100
|
|
1404
1419
|
*/
|
|
1405
|
-
|
|
1406
|
-
/**
|
|
1407
|
-
|
|
1420
|
+
_id: string;
|
|
1421
|
+
/** Required. Whether to cancel the order effective immediately or at the next payment date. One-time orders can only be canceled immediately. */
|
|
1422
|
+
effectiveAt: CancellationEffectiveAtWithLiterals;
|
|
1408
1423
|
}
|
|
1409
|
-
interface
|
|
1410
|
-
/** Orders that were resumed. */
|
|
1411
|
-
results?: BulkOrderResult[];
|
|
1412
|
-
/** Bulk action metadata. */
|
|
1413
|
-
bulkActionMetadata?: BulkActionMetadata;
|
|
1424
|
+
interface RequestCancellationResponse {
|
|
1414
1425
|
}
|
|
1415
1426
|
/** @docsIgnore */
|
|
1416
1427
|
type CreateOnlineOrderApplicationErrors = {
|
|
@@ -1763,33 +1774,6 @@ interface AccountInfoMetadata {
|
|
|
1763
1774
|
/** ID of the parent Wix account. Only included when 'accountId' belongs to a child account. */
|
|
1764
1775
|
parentAccountId?: string;
|
|
1765
1776
|
}
|
|
1766
|
-
interface OrderCanceledEnvelope {
|
|
1767
|
-
data: OrderCanceled;
|
|
1768
|
-
metadata: EventMetadata;
|
|
1769
|
-
}
|
|
1770
|
-
/**
|
|
1771
|
-
* Triggered when an order is canceled.
|
|
1772
|
-
*
|
|
1773
|
-
* This webhook is triggered either immediately or at the end of the current payment cycle, as follows:
|
|
1774
|
-
* + If the order is canceled and `effectiveAt` is set to `IMMEDIATELY`, the webhook is triggered immediately when canceled.
|
|
1775
|
-
* + 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.
|
|
1776
|
-
* @permissionScope Manage_Wix_Rentals_App_Forms_submissions
|
|
1777
|
-
* @permissionScopeId SCOPE.RENTALS.MANAGE
|
|
1778
|
-
* @permissionScope Manage Orders
|
|
1779
|
-
* @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
|
|
1780
|
-
* @permissionScope Read Orders
|
|
1781
|
-
* @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS
|
|
1782
|
-
* @permissionScope Manage plans and orders of Pricing Plans
|
|
1783
|
-
* @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-PLANS-AND-ORDERS
|
|
1784
|
-
* @permissionScope Manage Events
|
|
1785
|
-
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1786
|
-
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
1787
|
-
* @webhook
|
|
1788
|
-
* @eventType wix.pricing_plans.v2.order_canceled
|
|
1789
|
-
* @serviceIdentifier com.wixpress.membership.v2.orders.member.MemberOrdersService
|
|
1790
|
-
* @slug canceled
|
|
1791
|
-
*/
|
|
1792
|
-
declare function onOrderCanceled(handler: (event: OrderCanceledEnvelope) => void | Promise<void>): void;
|
|
1793
1777
|
interface OrderCreatedEnvelope {
|
|
1794
1778
|
entity: Order;
|
|
1795
1779
|
metadata: EventMetadata;
|
|
@@ -1894,6 +1878,33 @@ interface OrderAutoRenewCanceledEnvelope {
|
|
|
1894
1878
|
* @slug auto_renew_canceled
|
|
1895
1879
|
*/
|
|
1896
1880
|
declare function onOrderAutoRenewCanceled(handler: (event: OrderAutoRenewCanceledEnvelope) => void | Promise<void>): void;
|
|
1881
|
+
interface OrderCanceledEnvelope {
|
|
1882
|
+
data: OrderCanceled;
|
|
1883
|
+
metadata: EventMetadata;
|
|
1884
|
+
}
|
|
1885
|
+
/**
|
|
1886
|
+
* Triggered when an order is canceled.
|
|
1887
|
+
*
|
|
1888
|
+
* This webhook is triggered either immediately or at the end of the current payment cycle, as follows:
|
|
1889
|
+
* + If the order is canceled and `effectiveAt` is set to `IMMEDIATELY`, the webhook is triggered immediately when canceled.
|
|
1890
|
+
* + 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.
|
|
1891
|
+
* @permissionScope Manage_Wix_Rentals_App_Forms_submissions
|
|
1892
|
+
* @permissionScopeId SCOPE.RENTALS.MANAGE
|
|
1893
|
+
* @permissionScope Manage Orders
|
|
1894
|
+
* @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
|
|
1895
|
+
* @permissionScope Read Orders
|
|
1896
|
+
* @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS
|
|
1897
|
+
* @permissionScope Manage plans and orders of Pricing Plans
|
|
1898
|
+
* @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-PLANS-AND-ORDERS
|
|
1899
|
+
* @permissionScope Manage Events
|
|
1900
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1901
|
+
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
1902
|
+
* @webhook
|
|
1903
|
+
* @eventType wix.pricing_plans.v2.order_canceled
|
|
1904
|
+
* @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
|
|
1905
|
+
* @slug canceled
|
|
1906
|
+
*/
|
|
1907
|
+
declare function onOrderCanceled(handler: (event: OrderCanceledEnvelope) => void | Promise<void>): void;
|
|
1897
1908
|
interface OrderCycleStartedEnvelope {
|
|
1898
1909
|
data: OrderCycleStarted;
|
|
1899
1910
|
metadata: EventMetadata;
|
|
@@ -2088,86 +2099,6 @@ interface OrderStartedEnvelope {
|
|
|
2088
2099
|
* @slug started
|
|
2089
2100
|
*/
|
|
2090
2101
|
declare function onOrderStarted(handler: (event: OrderStartedEnvelope) => void | Promise<void>): void;
|
|
2091
|
-
/**
|
|
2092
|
-
* Retrieves an order for the currently logged-in member by ID.
|
|
2093
|
-
* @param _id - Order ID.
|
|
2094
|
-
* @public
|
|
2095
|
-
* @requiredField _id
|
|
2096
|
-
* @param options - Options for getting a logged-in member's order.
|
|
2097
|
-
* @permissionId PRICING_PLANS.READ_OWN_ORDERS
|
|
2098
|
-
* @applicableIdentity APP
|
|
2099
|
-
* @applicableIdentity MEMBER
|
|
2100
|
-
* @fqn com.wixpress.membership.v2.orders.member.MemberOrdersService.GetOrder
|
|
2101
|
-
*/
|
|
2102
|
-
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>>;
|
|
2103
|
-
interface MemberGetOrderOptions {
|
|
2104
|
-
/**
|
|
2105
|
-
* Predefined set of fields to return.
|
|
2106
|
-
*
|
|
2107
|
-
* Default: If `fieldSet` is omitted, no order form submission data is returned.
|
|
2108
|
-
*/
|
|
2109
|
-
fieldSet?: SetWithLiterals;
|
|
2110
|
-
}
|
|
2111
|
-
/**
|
|
2112
|
-
* Retrieves a list of up to 100 pricing plan orders for currently logged-in member.
|
|
2113
|
-
* @public
|
|
2114
|
-
* @param options - Filtering, sorting, and pagination options.
|
|
2115
|
-
* @permissionId PRICING_PLANS.READ_OWN_ORDERS
|
|
2116
|
-
* @applicableIdentity APP
|
|
2117
|
-
* @applicableIdentity MEMBER
|
|
2118
|
-
* @fqn com.wixpress.membership.v2.orders.member.MemberOrdersService.ListOrders
|
|
2119
|
-
*/
|
|
2120
|
-
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>>;
|
|
2121
|
-
interface MemberListOrdersOptions {
|
|
2122
|
-
/**
|
|
2123
|
-
* Filter by plan IDs.
|
|
2124
|
-
* @format GUID
|
|
2125
|
-
*/
|
|
2126
|
-
planIds?: string[];
|
|
2127
|
-
/** Filter for orders where auto renewal was canceled. */
|
|
2128
|
-
autoRenewCanceled?: boolean | null;
|
|
2129
|
-
/** Filter by order status. */
|
|
2130
|
-
orderStatuses?: OrderStatusWithLiterals[];
|
|
2131
|
-
/** Filter by payment status. */
|
|
2132
|
-
paymentStatuses?: PaymentStatusWithLiterals[];
|
|
2133
|
-
/**
|
|
2134
|
-
* Limit the number of pricing plans returned. Default limit is 50.
|
|
2135
|
-
* @min 1
|
|
2136
|
-
* @max 50
|
|
2137
|
-
*/
|
|
2138
|
-
limit?: number | null;
|
|
2139
|
-
/** Number of entries to offset. */
|
|
2140
|
-
offset?: number | null;
|
|
2141
|
-
/** Sorting direction (defaults to ASC) and field to sort by. */
|
|
2142
|
-
sorting?: Sorting;
|
|
2143
|
-
/**
|
|
2144
|
-
* Predefined set of fields to return.
|
|
2145
|
-
*
|
|
2146
|
-
* Default: If `fieldSet` is omitted, no order form submission data is returned.
|
|
2147
|
-
*/
|
|
2148
|
-
fieldSet?: SetWithLiterals;
|
|
2149
|
-
}
|
|
2150
|
-
/**
|
|
2151
|
-
* Cancels an order. Recurring orders can be canceled either immediately or at the next payment date. One time orders can only be canceled immediately.
|
|
2152
|
-
*
|
|
2153
|
-
* 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.
|
|
2154
|
-
*
|
|
2155
|
-
* 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.
|
|
2156
|
-
*
|
|
2157
|
-
* >**Note:**
|
|
2158
|
-
* >This method requires [visitor or member authentication](https://dev.wix.com/docs/rest/articles/getting-started/access-types-and-permissions).
|
|
2159
|
-
* @param _id - Order ID.
|
|
2160
|
-
* @param effectiveAt - Required. Whether to cancel the order effective immediately or at the next payment date. One-time orders can only be canceled immediately.
|
|
2161
|
-
* @public
|
|
2162
|
-
* @requiredField _id
|
|
2163
|
-
* @requiredField effectiveAt
|
|
2164
|
-
* @param options - Options for requesting a cancellation.
|
|
2165
|
-
* @permissionId PRICING_PLANS.MANAGE_OWN_ORDERS
|
|
2166
|
-
* @applicableIdentity APP
|
|
2167
|
-
* @applicableIdentity MEMBER
|
|
2168
|
-
* @fqn com.wixpress.membership.v2.orders.member.MemberOrdersService.RequestCancellation
|
|
2169
|
-
*/
|
|
2170
|
-
declare function requestCancellation(_id: string, effectiveAt: CancellationEffectiveAtWithLiterals): Promise<void>;
|
|
2171
2102
|
/**
|
|
2172
2103
|
* Creates an online order for a site member.
|
|
2173
2104
|
*
|
|
@@ -2370,10 +2301,9 @@ interface GetPricePreviewOptions {
|
|
|
2370
2301
|
* @param options - Options to use when getting an order.
|
|
2371
2302
|
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
2372
2303
|
* @applicableIdentity APP
|
|
2373
|
-
* @returns Order.
|
|
2374
2304
|
* @fqn com.wixpress.membership.v2.orders.OrderManagementService.GetOrder
|
|
2375
2305
|
*/
|
|
2376
|
-
declare function managementGetOrder(_id: string, options?: ManagementGetOrderOptions): Promise<NonNullablePaths<
|
|
2306
|
+
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>>;
|
|
2377
2307
|
interface ManagementGetOrderOptions {
|
|
2378
2308
|
/**
|
|
2379
2309
|
* Predefined set of fields to return.
|
|
@@ -2537,5 +2467,86 @@ declare function pauseOrder(_id: string): Promise<void>;
|
|
|
2537
2467
|
* @fqn com.wixpress.membership.v2.orders.OrderManagementService.ResumeOrder
|
|
2538
2468
|
*/
|
|
2539
2469
|
declare function resumeOrder(_id: string): Promise<void>;
|
|
2470
|
+
/**
|
|
2471
|
+
* Retrieves an order for the currently logged-in member by ID.
|
|
2472
|
+
* @param _id - Order ID.
|
|
2473
|
+
* @public
|
|
2474
|
+
* @requiredField _id
|
|
2475
|
+
* @param options - Options for getting a logged-in member's order.
|
|
2476
|
+
* @permissionId PRICING_PLANS.READ_OWN_ORDERS
|
|
2477
|
+
* @applicableIdentity APP
|
|
2478
|
+
* @applicableIdentity MEMBER
|
|
2479
|
+
* @returns Requested order.
|
|
2480
|
+
* @fqn com.wixpress.membership.v2.orders.member.MemberOrdersService.GetOrder
|
|
2481
|
+
*/
|
|
2482
|
+
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>>;
|
|
2483
|
+
interface MemberGetOrderOptions {
|
|
2484
|
+
/**
|
|
2485
|
+
* Predefined set of fields to return.
|
|
2486
|
+
*
|
|
2487
|
+
* Default: If `fieldSet` is omitted, no order form submission data is returned.
|
|
2488
|
+
*/
|
|
2489
|
+
fieldSet?: SetWithLiterals;
|
|
2490
|
+
}
|
|
2491
|
+
/**
|
|
2492
|
+
* Retrieves a list of up to 100 pricing plan orders for currently logged-in member.
|
|
2493
|
+
* @public
|
|
2494
|
+
* @param options - Filtering, sorting, and pagination options.
|
|
2495
|
+
* @permissionId PRICING_PLANS.READ_OWN_ORDERS
|
|
2496
|
+
* @applicableIdentity APP
|
|
2497
|
+
* @applicableIdentity MEMBER
|
|
2498
|
+
* @fqn com.wixpress.membership.v2.orders.member.MemberOrdersService.ListOrders
|
|
2499
|
+
*/
|
|
2500
|
+
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>>;
|
|
2501
|
+
interface MemberListOrdersOptions {
|
|
2502
|
+
/**
|
|
2503
|
+
* Filter by plan IDs.
|
|
2504
|
+
* @format GUID
|
|
2505
|
+
*/
|
|
2506
|
+
planIds?: string[];
|
|
2507
|
+
/** Filter for orders where auto renewal was canceled. */
|
|
2508
|
+
autoRenewCanceled?: boolean | null;
|
|
2509
|
+
/** Filter by order status. */
|
|
2510
|
+
orderStatuses?: OrderStatusWithLiterals[];
|
|
2511
|
+
/** Filter by payment status. */
|
|
2512
|
+
paymentStatuses?: PaymentStatusWithLiterals[];
|
|
2513
|
+
/**
|
|
2514
|
+
* Limit the number of pricing plans returned. Default limit is 50.
|
|
2515
|
+
* @min 1
|
|
2516
|
+
* @max 50
|
|
2517
|
+
*/
|
|
2518
|
+
limit?: number | null;
|
|
2519
|
+
/** Number of entries to offset. */
|
|
2520
|
+
offset?: number | null;
|
|
2521
|
+
/** Sorting direction (defaults to ASC) and field to sort by. */
|
|
2522
|
+
sorting?: Sorting;
|
|
2523
|
+
/**
|
|
2524
|
+
* Predefined set of fields to return.
|
|
2525
|
+
*
|
|
2526
|
+
* Default: If `fieldSet` is omitted, no order form submission data is returned.
|
|
2527
|
+
*/
|
|
2528
|
+
fieldSet?: SetWithLiterals;
|
|
2529
|
+
}
|
|
2530
|
+
/**
|
|
2531
|
+
* Cancels an order. Recurring orders can be canceled either immediately or at the next payment date. One time orders can only be canceled immediately.
|
|
2532
|
+
*
|
|
2533
|
+
* 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.
|
|
2534
|
+
*
|
|
2535
|
+
* 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.
|
|
2536
|
+
*
|
|
2537
|
+
* >**Note:**
|
|
2538
|
+
* >This method requires [visitor or member authentication](https://dev.wix.com/docs/rest/articles/getting-started/access-types-and-permissions).
|
|
2539
|
+
* @param _id - Order ID.
|
|
2540
|
+
* @param effectiveAt - Required. Whether to cancel the order effective immediately or at the next payment date. One-time orders can only be canceled immediately.
|
|
2541
|
+
* @public
|
|
2542
|
+
* @requiredField _id
|
|
2543
|
+
* @requiredField effectiveAt
|
|
2544
|
+
* @param options - Options for requesting a cancellation.
|
|
2545
|
+
* @permissionId PRICING_PLANS.MANAGE_OWN_ORDERS
|
|
2546
|
+
* @applicableIdentity APP
|
|
2547
|
+
* @applicableIdentity MEMBER
|
|
2548
|
+
* @fqn com.wixpress.membership.v2.orders.member.MemberOrdersService.RequestCancellation
|
|
2549
|
+
*/
|
|
2550
|
+
declare function requestCancellation(_id: string, effectiveAt: CancellationEffectiveAtWithLiterals): Promise<void>;
|
|
2540
2551
|
|
|
2541
|
-
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 };
|
|
2552
|
+
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 };
|