@wix/auto_sdk_pricing-plans_orders 1.0.94 → 1.0.95
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 +153 -153
- package/build/cjs/index.js +642 -642
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +616 -607
- package/build/cjs/index.typings.js +507 -507
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +459 -459
- package/build/cjs/meta.js +403 -403
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.d.mts +153 -153
- package/build/es/index.mjs +642 -642
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +616 -607
- package/build/es/index.typings.mjs +507 -507
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +459 -459
- package/build/es/meta.mjs +403 -403
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +153 -153
- package/build/internal/cjs/index.js +642 -642
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +616 -607
- package/build/internal/cjs/index.typings.js +507 -507
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +459 -459
- package/build/internal/cjs/meta.js +403 -403
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/es/index.d.mts +153 -153
- package/build/internal/es/index.mjs +642 -642
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +616 -607
- package/build/internal/es/index.typings.mjs +507 -507
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +459 -459
- package/build/internal/es/meta.mjs +403 -403
- package/build/internal/es/meta.mjs.map +1 -1
- package/package.json +2 -2
|
@@ -635,7 +635,35 @@ interface ActionEvent {
|
|
|
635
635
|
}
|
|
636
636
|
interface Empty {
|
|
637
637
|
}
|
|
638
|
-
interface
|
|
638
|
+
interface OrderPurchased {
|
|
639
|
+
/** Order that was paid for. If a free or an offline order, the order that was created. */
|
|
640
|
+
order?: Order;
|
|
641
|
+
}
|
|
642
|
+
interface OrderStarted {
|
|
643
|
+
/** Order that reached its `startDate`. */
|
|
644
|
+
order?: Order;
|
|
645
|
+
}
|
|
646
|
+
/**
|
|
647
|
+
* Triggered at the start of a new payment cycle for an existing order.
|
|
648
|
+
*
|
|
649
|
+
* This webhook does not trigger at the initial start of an offline order.
|
|
650
|
+
*/
|
|
651
|
+
interface OrderCycleStarted {
|
|
652
|
+
/** Order whose new cycle started. */
|
|
653
|
+
order?: Order;
|
|
654
|
+
/** Number of the payment cycle will be 0 when the order is in the free trial period. In other cases, the cycle number starts from 1. */
|
|
655
|
+
cycleNumber?: number;
|
|
656
|
+
}
|
|
657
|
+
/** Emitted when a recurring order is canceled for the next payment cycle */
|
|
658
|
+
interface OrderAutoRenewCanceled {
|
|
659
|
+
/** Order that is canceled, effective at the end of the current payment cycle. */
|
|
660
|
+
order?: Order;
|
|
661
|
+
}
|
|
662
|
+
interface OrderEnded {
|
|
663
|
+
/** Order that ended. */
|
|
664
|
+
order?: Order;
|
|
665
|
+
}
|
|
666
|
+
interface GetOrderRequest {
|
|
639
667
|
/**
|
|
640
668
|
* Order ID.
|
|
641
669
|
* @format GUID
|
|
@@ -658,31 +686,44 @@ declare enum Set {
|
|
|
658
686
|
}
|
|
659
687
|
/** @enumType */
|
|
660
688
|
type SetWithLiterals = Set | 'UNKNOWN_SET' | 'BASIC' | 'FULL';
|
|
661
|
-
interface
|
|
662
|
-
/**
|
|
689
|
+
interface GetOrderResponse {
|
|
690
|
+
/** Order. */
|
|
663
691
|
order?: Order;
|
|
664
692
|
}
|
|
665
|
-
interface
|
|
693
|
+
interface ListOrdersRequest {
|
|
666
694
|
/**
|
|
667
|
-
* Filter by
|
|
695
|
+
* Filter by a buyer's member ID, from the Members API.
|
|
696
|
+
* @format GUID
|
|
697
|
+
*/
|
|
698
|
+
buyerIds?: string[];
|
|
699
|
+
/**
|
|
700
|
+
* Filter by plan IDs, from the Plans API.
|
|
668
701
|
* @format GUID
|
|
669
702
|
*/
|
|
670
703
|
planIds?: string[];
|
|
671
|
-
/** Filter
|
|
704
|
+
/** Filter by whether or not the auto-renewal of recurring orders was canceled. */
|
|
672
705
|
autoRenewCanceled?: boolean | null;
|
|
673
706
|
/** Filter by order status. */
|
|
674
707
|
orderStatuses?: OrderStatusWithLiterals[];
|
|
675
708
|
/** Filter by payment status. */
|
|
676
709
|
paymentStatuses?: PaymentStatusWithLiterals[];
|
|
677
710
|
/**
|
|
678
|
-
*
|
|
711
|
+
* Number of orders to return. See Sorting and Paging for more information.
|
|
712
|
+
*
|
|
713
|
+
* Max: `50`
|
|
679
714
|
* @min 1
|
|
680
715
|
* @max 50
|
|
681
716
|
*/
|
|
682
717
|
limit?: number | null;
|
|
683
|
-
/** Number of
|
|
718
|
+
/** Number of orders to skip in the current sort order. */
|
|
684
719
|
offset?: number | null;
|
|
685
|
-
/**
|
|
720
|
+
/**
|
|
721
|
+
* Sort order.
|
|
722
|
+
*
|
|
723
|
+
* Use `ASC` for ascending order or `DESC` for descending order.
|
|
724
|
+
*
|
|
725
|
+
* Default: `DESC`.
|
|
726
|
+
*/
|
|
686
727
|
sorting?: Sorting;
|
|
687
728
|
/**
|
|
688
729
|
* Predefined set of fields to return.
|
|
@@ -706,8 +747,8 @@ declare enum SortOrder {
|
|
|
706
747
|
}
|
|
707
748
|
/** @enumType */
|
|
708
749
|
type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
709
|
-
interface
|
|
710
|
-
/**
|
|
750
|
+
interface ListOrdersResponse {
|
|
751
|
+
/** List of orders. */
|
|
711
752
|
orders?: Order[];
|
|
712
753
|
/** Object containing paging-related data (number of orders returned, offset). */
|
|
713
754
|
pagingMetadata?: PagingMetadataV2;
|
|
@@ -736,11 +777,7 @@ interface Cursors {
|
|
|
736
777
|
*/
|
|
737
778
|
prev?: string | null;
|
|
738
779
|
}
|
|
739
|
-
|
|
740
|
-
* TODO: Write orders filter and sort docs page
|
|
741
|
-
* Retrieves a list of up to 1,000 orders, based on the provided paging, sorting, and filtering.
|
|
742
|
-
*/
|
|
743
|
-
interface QueryOrdersRequest {
|
|
780
|
+
interface OrdersQueryOrdersRequest {
|
|
744
781
|
/** Query filter. */
|
|
745
782
|
query?: QueryV2;
|
|
746
783
|
}
|
|
@@ -794,22 +831,84 @@ interface CursorPaging {
|
|
|
794
831
|
*/
|
|
795
832
|
cursor?: string | null;
|
|
796
833
|
}
|
|
797
|
-
interface
|
|
798
|
-
/**
|
|
834
|
+
interface OrdersQueryOrdersResponse {
|
|
835
|
+
/** Retrieved orders. */
|
|
799
836
|
plans?: Order[];
|
|
800
837
|
/** Paging-related data (number of orders returned, offset). */
|
|
801
838
|
pagingMetadata?: PagingMetadataV2;
|
|
802
839
|
}
|
|
803
|
-
interface
|
|
840
|
+
interface GetOrdersStatsRequest {
|
|
841
|
+
}
|
|
842
|
+
interface GetOrdersStatsResponse {
|
|
843
|
+
/** Total number of orders. */
|
|
844
|
+
totalOrderCount?: number;
|
|
845
|
+
/** Number of active orders. */
|
|
846
|
+
activeOrderCount?: number;
|
|
847
|
+
}
|
|
848
|
+
interface GetAvailableOrderActionsRequest {
|
|
849
|
+
/**
|
|
850
|
+
* Order ID.
|
|
851
|
+
* @format GUID
|
|
852
|
+
*/
|
|
853
|
+
_id?: string;
|
|
854
|
+
}
|
|
855
|
+
interface GetAvailableOrderActionsResponse {
|
|
856
|
+
/** Whether the order can be suspended. */
|
|
857
|
+
suspendable?: boolean;
|
|
858
|
+
/** If the order cannot be suspended, a reason is returned here. */
|
|
859
|
+
notSuspendableReason?: ReasonNotSuspendableWithLiterals;
|
|
860
|
+
/** Whether the order can be canceled by the buyer. */
|
|
861
|
+
cancelableByBuyer?: boolean;
|
|
862
|
+
}
|
|
863
|
+
declare enum ReasonNotSuspendable {
|
|
864
|
+
/** Undefined reason. */
|
|
865
|
+
UNDEFINED = "UNDEFINED",
|
|
866
|
+
/** Saved in the database but is awaiting payment. Non-active orders can't be suspended. */
|
|
867
|
+
PENDING = "PENDING",
|
|
868
|
+
/** Trial orders can't be suspended. */
|
|
869
|
+
TRIAL = "TRIAL",
|
|
870
|
+
/** Canceled orders can't be suspended. */
|
|
871
|
+
CANCELED = "CANCELED",
|
|
872
|
+
/** Ended orders can't be suspended. */
|
|
873
|
+
ENDED = "ENDED",
|
|
874
|
+
/** Paid for orders with future start dates can't be suspended. */
|
|
875
|
+
NOT_STARTED = "NOT_STARTED",
|
|
876
|
+
/** Order is already suspended. */
|
|
877
|
+
ALREADY_SUSPENDED = "ALREADY_SUSPENDED",
|
|
878
|
+
/** Orders based on recurring payments using older stripe versions can't be suspended. */
|
|
879
|
+
OLD_STRIPE = "OLD_STRIPE"
|
|
880
|
+
}
|
|
881
|
+
/** @enumType */
|
|
882
|
+
type ReasonNotSuspendableWithLiterals = ReasonNotSuspendable | 'UNDEFINED' | 'PENDING' | 'TRIAL' | 'CANCELED' | 'ENDED' | 'NOT_STARTED' | 'ALREADY_SUSPENDED' | 'OLD_STRIPE';
|
|
883
|
+
interface PostponeEndDateRequest {
|
|
804
884
|
/**
|
|
805
885
|
* Order ID.
|
|
806
886
|
* @format GUID
|
|
807
887
|
*/
|
|
808
888
|
_id: string;
|
|
809
|
-
/**
|
|
889
|
+
/**
|
|
890
|
+
* New end date and time.
|
|
891
|
+
*
|
|
892
|
+
* Must be later than the current end date and time.
|
|
893
|
+
*/
|
|
894
|
+
endDate: Date | null;
|
|
895
|
+
}
|
|
896
|
+
interface PostponeEndDateResponse {
|
|
897
|
+
}
|
|
898
|
+
interface OrderEndDatePostponed {
|
|
899
|
+
/** Order whose `endDate` was postponed. */
|
|
900
|
+
order?: Order;
|
|
901
|
+
}
|
|
902
|
+
interface CancelOrderRequest {
|
|
903
|
+
/**
|
|
904
|
+
* Order ID.
|
|
905
|
+
* @format GUID
|
|
906
|
+
*/
|
|
907
|
+
_id: string;
|
|
908
|
+
/** __Required.__ When the order will be canceled. One-time orders can only be canceled `IMMEDIATELY`. */
|
|
810
909
|
effectiveAt: CancellationEffectiveAtWithLiterals;
|
|
811
910
|
}
|
|
812
|
-
interface
|
|
911
|
+
interface CancelOrderResponse {
|
|
813
912
|
}
|
|
814
913
|
/**
|
|
815
914
|
* Emitted when an order is canceled immediately or when cycle ends for an order with canceled auto renewal
|
|
@@ -820,6 +919,111 @@ interface OrderCanceled {
|
|
|
820
919
|
/** Canceled order. */
|
|
821
920
|
order?: Order;
|
|
822
921
|
}
|
|
922
|
+
interface MarkAsPaidRequest {
|
|
923
|
+
/**
|
|
924
|
+
* Order ID.
|
|
925
|
+
* @format GUID
|
|
926
|
+
*/
|
|
927
|
+
_id: string;
|
|
928
|
+
}
|
|
929
|
+
interface MarkAsPaidResponse {
|
|
930
|
+
}
|
|
931
|
+
interface OrderMarkedAsPaid {
|
|
932
|
+
/** Order that was marked as paid. */
|
|
933
|
+
order?: Order;
|
|
934
|
+
}
|
|
935
|
+
interface PauseOrderRequest {
|
|
936
|
+
/**
|
|
937
|
+
* Order ID.
|
|
938
|
+
* @format GUID
|
|
939
|
+
*/
|
|
940
|
+
_id: string;
|
|
941
|
+
}
|
|
942
|
+
interface PauseOrderResponse {
|
|
943
|
+
}
|
|
944
|
+
interface OrderPaused {
|
|
945
|
+
/** Paused order. */
|
|
946
|
+
order?: Order;
|
|
947
|
+
}
|
|
948
|
+
interface BulkPauseOrderRequest {
|
|
949
|
+
/**
|
|
950
|
+
* List of Order IDs.
|
|
951
|
+
* @format GUID
|
|
952
|
+
* @minSize 1
|
|
953
|
+
* @maxSize 100
|
|
954
|
+
*/
|
|
955
|
+
ids?: string[];
|
|
956
|
+
/** Set to true to return Order entity in response. */
|
|
957
|
+
returnFullEntity?: boolean;
|
|
958
|
+
}
|
|
959
|
+
interface BulkPauseOrderResponse {
|
|
960
|
+
/** Orders that were paused. */
|
|
961
|
+
results?: BulkOrderResult[];
|
|
962
|
+
/** Bulk action metadata. */
|
|
963
|
+
bulkActionMetadata?: BulkActionMetadata;
|
|
964
|
+
}
|
|
965
|
+
interface BulkOrderResult {
|
|
966
|
+
/** Item metadata */
|
|
967
|
+
itemMetadata?: ItemMetadata;
|
|
968
|
+
/** The order. */
|
|
969
|
+
order?: Order;
|
|
970
|
+
}
|
|
971
|
+
interface ItemMetadata {
|
|
972
|
+
/** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
|
|
973
|
+
_id?: string | null;
|
|
974
|
+
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
975
|
+
originalIndex?: number;
|
|
976
|
+
/** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
|
|
977
|
+
success?: boolean;
|
|
978
|
+
/** Details about the error in case of failure. */
|
|
979
|
+
error?: ApplicationError;
|
|
980
|
+
}
|
|
981
|
+
interface ApplicationError {
|
|
982
|
+
/** Error code. */
|
|
983
|
+
code?: string;
|
|
984
|
+
/** Description of the error. */
|
|
985
|
+
description?: string;
|
|
986
|
+
/** Data related to the error. */
|
|
987
|
+
data?: Record<string, any> | null;
|
|
988
|
+
}
|
|
989
|
+
interface BulkActionMetadata {
|
|
990
|
+
/** Number of items that were successfully processed. */
|
|
991
|
+
totalSuccesses?: number;
|
|
992
|
+
/** Number of items that couldn't be processed. */
|
|
993
|
+
totalFailures?: number;
|
|
994
|
+
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
995
|
+
undetailedFailures?: number;
|
|
996
|
+
}
|
|
997
|
+
interface ResumeOrderRequest {
|
|
998
|
+
/**
|
|
999
|
+
* Order ID.
|
|
1000
|
+
* @format GUID
|
|
1001
|
+
*/
|
|
1002
|
+
_id: string;
|
|
1003
|
+
}
|
|
1004
|
+
interface ResumeOrderResponse {
|
|
1005
|
+
}
|
|
1006
|
+
interface OrderResumed {
|
|
1007
|
+
/** Resumed order. */
|
|
1008
|
+
order?: Order;
|
|
1009
|
+
}
|
|
1010
|
+
interface BulkResumeOrderRequest {
|
|
1011
|
+
/**
|
|
1012
|
+
* List of Order IDs.
|
|
1013
|
+
* @format GUID
|
|
1014
|
+
* @minSize 1
|
|
1015
|
+
* @maxSize 100
|
|
1016
|
+
*/
|
|
1017
|
+
ids?: string[];
|
|
1018
|
+
/** Set to true to return Order entity in response. */
|
|
1019
|
+
returnFullEntity?: boolean;
|
|
1020
|
+
}
|
|
1021
|
+
interface BulkResumeOrderResponse {
|
|
1022
|
+
/** Orders that were resumed. */
|
|
1023
|
+
results?: BulkOrderResult[];
|
|
1024
|
+
/** Bulk action metadata. */
|
|
1025
|
+
bulkActionMetadata?: BulkActionMetadata;
|
|
1026
|
+
}
|
|
823
1027
|
interface MessageEnvelope {
|
|
824
1028
|
/**
|
|
825
1029
|
* App instance ID.
|
|
@@ -909,16 +1113,93 @@ interface AccountInfo {
|
|
|
909
1113
|
*/
|
|
910
1114
|
siteId?: string | null;
|
|
911
1115
|
}
|
|
912
|
-
interface
|
|
1116
|
+
interface MemberGetOrderRequest {
|
|
913
1117
|
/**
|
|
914
|
-
*
|
|
1118
|
+
* Order ID.
|
|
915
1119
|
* @format GUID
|
|
916
1120
|
*/
|
|
917
|
-
|
|
1121
|
+
_id: string;
|
|
918
1122
|
/**
|
|
919
|
-
*
|
|
1123
|
+
* Predefined set of fields to return.
|
|
920
1124
|
*
|
|
921
|
-
* Default:
|
|
1125
|
+
* Default: If `fieldSet` is omitted, no order form submission data is returned.
|
|
1126
|
+
*/
|
|
1127
|
+
fieldSet?: SetWithLiterals;
|
|
1128
|
+
}
|
|
1129
|
+
interface MemberGetOrderResponse {
|
|
1130
|
+
/** Requested order. */
|
|
1131
|
+
order?: Order;
|
|
1132
|
+
}
|
|
1133
|
+
interface MemberListOrdersRequest {
|
|
1134
|
+
/**
|
|
1135
|
+
* Filter by plan IDs.
|
|
1136
|
+
* @format GUID
|
|
1137
|
+
*/
|
|
1138
|
+
planIds?: string[];
|
|
1139
|
+
/** Filter for orders where auto renewal was canceled. */
|
|
1140
|
+
autoRenewCanceled?: boolean | null;
|
|
1141
|
+
/** Filter by order status. */
|
|
1142
|
+
orderStatuses?: OrderStatusWithLiterals[];
|
|
1143
|
+
/** Filter by payment status. */
|
|
1144
|
+
paymentStatuses?: PaymentStatusWithLiterals[];
|
|
1145
|
+
/**
|
|
1146
|
+
* Limit the number of pricing plans returned. Default limit is 50.
|
|
1147
|
+
* @min 1
|
|
1148
|
+
* @max 50
|
|
1149
|
+
*/
|
|
1150
|
+
limit?: number | null;
|
|
1151
|
+
/** Number of entries to offset. */
|
|
1152
|
+
offset?: number | null;
|
|
1153
|
+
/** Sorting direction (defaults to ASC) and field to sort by. */
|
|
1154
|
+
sorting?: Sorting;
|
|
1155
|
+
/**
|
|
1156
|
+
* Predefined set of fields to return.
|
|
1157
|
+
*
|
|
1158
|
+
* Default: If `fieldSet` is omitted, no order form submission data is returned.
|
|
1159
|
+
*/
|
|
1160
|
+
fieldSet?: SetWithLiterals;
|
|
1161
|
+
}
|
|
1162
|
+
interface MemberListOrdersResponse {
|
|
1163
|
+
/** Requested orders. */
|
|
1164
|
+
orders?: Order[];
|
|
1165
|
+
/** Object containing paging-related data (number of orders returned, offset). */
|
|
1166
|
+
pagingMetadata?: PagingMetadataV2;
|
|
1167
|
+
}
|
|
1168
|
+
/**
|
|
1169
|
+
* TODO: Write orders filter and sort docs page
|
|
1170
|
+
* Retrieves a list of up to 1,000 orders, based on the provided paging, sorting, and filtering.
|
|
1171
|
+
*/
|
|
1172
|
+
interface QueryOrdersRequest {
|
|
1173
|
+
/** Query filter. */
|
|
1174
|
+
query?: QueryV2;
|
|
1175
|
+
}
|
|
1176
|
+
interface QueryOrdersResponse {
|
|
1177
|
+
/** Order data. */
|
|
1178
|
+
plans?: Order[];
|
|
1179
|
+
/** Paging-related data (number of orders returned, offset). */
|
|
1180
|
+
pagingMetadata?: PagingMetadataV2;
|
|
1181
|
+
}
|
|
1182
|
+
interface RequestCancellationRequest {
|
|
1183
|
+
/**
|
|
1184
|
+
* Order ID.
|
|
1185
|
+
* @format GUID
|
|
1186
|
+
*/
|
|
1187
|
+
_id: string;
|
|
1188
|
+
/** Required. Whether to cancel the order effective immediately or at the next payment date. One-time orders can only be canceled immediately. */
|
|
1189
|
+
effectiveAt: CancellationEffectiveAtWithLiterals;
|
|
1190
|
+
}
|
|
1191
|
+
interface RequestCancellationResponse {
|
|
1192
|
+
}
|
|
1193
|
+
interface CreateOnlineOrderRequest {
|
|
1194
|
+
/**
|
|
1195
|
+
* Plan ID.
|
|
1196
|
+
* @format GUID
|
|
1197
|
+
*/
|
|
1198
|
+
planId: string;
|
|
1199
|
+
/**
|
|
1200
|
+
* Start date and time for the plan of the online order in a `YYYY-MM-DDThh:mm[:ss][.sss]Z` format.
|
|
1201
|
+
*
|
|
1202
|
+
* Default: Current date and time.
|
|
922
1203
|
*/
|
|
923
1204
|
startDate?: Date | null;
|
|
924
1205
|
/**
|
|
@@ -1220,287 +1501,6 @@ interface SetSubmissionResponse {
|
|
|
1220
1501
|
/** Order with submission id */
|
|
1221
1502
|
order?: Order;
|
|
1222
1503
|
}
|
|
1223
|
-
interface OrderPurchased {
|
|
1224
|
-
/** Order that was paid for. If a free or an offline order, the order that was created. */
|
|
1225
|
-
order?: Order;
|
|
1226
|
-
}
|
|
1227
|
-
interface OrderStarted {
|
|
1228
|
-
/** Order that reached its `startDate`. */
|
|
1229
|
-
order?: Order;
|
|
1230
|
-
}
|
|
1231
|
-
/**
|
|
1232
|
-
* Triggered at the start of a new payment cycle for an existing order.
|
|
1233
|
-
*
|
|
1234
|
-
* This webhook does not trigger at the initial start of an offline order.
|
|
1235
|
-
*/
|
|
1236
|
-
interface OrderCycleStarted {
|
|
1237
|
-
/** Order whose new cycle started. */
|
|
1238
|
-
order?: Order;
|
|
1239
|
-
/** Number of the payment cycle will be 0 when the order is in the free trial period. In other cases, the cycle number starts from 1. */
|
|
1240
|
-
cycleNumber?: number;
|
|
1241
|
-
}
|
|
1242
|
-
/** Emitted when a recurring order is canceled for the next payment cycle */
|
|
1243
|
-
interface OrderAutoRenewCanceled {
|
|
1244
|
-
/** Order that is canceled, effective at the end of the current payment cycle. */
|
|
1245
|
-
order?: Order;
|
|
1246
|
-
}
|
|
1247
|
-
interface OrderEnded {
|
|
1248
|
-
/** Order that ended. */
|
|
1249
|
-
order?: Order;
|
|
1250
|
-
}
|
|
1251
|
-
interface GetOrderRequest {
|
|
1252
|
-
/**
|
|
1253
|
-
* Order ID.
|
|
1254
|
-
* @format GUID
|
|
1255
|
-
*/
|
|
1256
|
-
_id: string;
|
|
1257
|
-
/**
|
|
1258
|
-
* Predefined set of fields to return.
|
|
1259
|
-
*
|
|
1260
|
-
* Default: If `fieldSet` is omitted, no order form submission data is returned.
|
|
1261
|
-
*/
|
|
1262
|
-
fieldSet?: SetWithLiterals;
|
|
1263
|
-
}
|
|
1264
|
-
interface GetOrderResponse {
|
|
1265
|
-
/** Order. */
|
|
1266
|
-
order?: Order;
|
|
1267
|
-
}
|
|
1268
|
-
interface ListOrdersRequest {
|
|
1269
|
-
/**
|
|
1270
|
-
* Filter by a buyer's member ID, from the Members API.
|
|
1271
|
-
* @format GUID
|
|
1272
|
-
*/
|
|
1273
|
-
buyerIds?: string[];
|
|
1274
|
-
/**
|
|
1275
|
-
* Filter by plan IDs, from the Plans API.
|
|
1276
|
-
* @format GUID
|
|
1277
|
-
*/
|
|
1278
|
-
planIds?: string[];
|
|
1279
|
-
/** Filter by whether or not the auto-renewal of recurring orders was canceled. */
|
|
1280
|
-
autoRenewCanceled?: boolean | null;
|
|
1281
|
-
/** Filter by order status. */
|
|
1282
|
-
orderStatuses?: OrderStatusWithLiterals[];
|
|
1283
|
-
/** Filter by payment status. */
|
|
1284
|
-
paymentStatuses?: PaymentStatusWithLiterals[];
|
|
1285
|
-
/**
|
|
1286
|
-
* Number of orders to return. See Sorting and Paging for more information.
|
|
1287
|
-
*
|
|
1288
|
-
* Max: `50`
|
|
1289
|
-
* @min 1
|
|
1290
|
-
* @max 50
|
|
1291
|
-
*/
|
|
1292
|
-
limit?: number | null;
|
|
1293
|
-
/** Number of orders to skip in the current sort order. */
|
|
1294
|
-
offset?: number | null;
|
|
1295
|
-
/**
|
|
1296
|
-
* Sort order.
|
|
1297
|
-
*
|
|
1298
|
-
* Use `ASC` for ascending order or `DESC` for descending order.
|
|
1299
|
-
*
|
|
1300
|
-
* Default: `DESC`.
|
|
1301
|
-
*/
|
|
1302
|
-
sorting?: Sorting;
|
|
1303
|
-
/**
|
|
1304
|
-
* Predefined set of fields to return.
|
|
1305
|
-
*
|
|
1306
|
-
* Default: If `fieldSet` is omitted, no order form submission data is returned.
|
|
1307
|
-
*/
|
|
1308
|
-
fieldSet?: SetWithLiterals;
|
|
1309
|
-
}
|
|
1310
|
-
interface ListOrdersResponse {
|
|
1311
|
-
/** List of orders. */
|
|
1312
|
-
orders?: Order[];
|
|
1313
|
-
/** Object containing paging-related data (number of orders returned, offset). */
|
|
1314
|
-
pagingMetadata?: PagingMetadataV2;
|
|
1315
|
-
}
|
|
1316
|
-
interface OrdersQueryOrdersRequest {
|
|
1317
|
-
/** Query filter. */
|
|
1318
|
-
query?: QueryV2;
|
|
1319
|
-
}
|
|
1320
|
-
interface OrdersQueryOrdersResponse {
|
|
1321
|
-
/** Retrieved orders. */
|
|
1322
|
-
plans?: Order[];
|
|
1323
|
-
/** Paging-related data (number of orders returned, offset). */
|
|
1324
|
-
pagingMetadata?: PagingMetadataV2;
|
|
1325
|
-
}
|
|
1326
|
-
interface GetOrdersStatsRequest {
|
|
1327
|
-
}
|
|
1328
|
-
interface GetOrdersStatsResponse {
|
|
1329
|
-
/** Total number of orders. */
|
|
1330
|
-
totalOrderCount?: number;
|
|
1331
|
-
/** Number of active orders. */
|
|
1332
|
-
activeOrderCount?: number;
|
|
1333
|
-
}
|
|
1334
|
-
interface GetAvailableOrderActionsRequest {
|
|
1335
|
-
/**
|
|
1336
|
-
* Order ID.
|
|
1337
|
-
* @format GUID
|
|
1338
|
-
*/
|
|
1339
|
-
_id?: string;
|
|
1340
|
-
}
|
|
1341
|
-
interface GetAvailableOrderActionsResponse {
|
|
1342
|
-
/** Whether the order can be suspended. */
|
|
1343
|
-
suspendable?: boolean;
|
|
1344
|
-
/** If the order cannot be suspended, a reason is returned here. */
|
|
1345
|
-
notSuspendableReason?: ReasonNotSuspendableWithLiterals;
|
|
1346
|
-
/** Whether the order can be canceled by the buyer. */
|
|
1347
|
-
cancelableByBuyer?: boolean;
|
|
1348
|
-
}
|
|
1349
|
-
declare enum ReasonNotSuspendable {
|
|
1350
|
-
/** Undefined reason. */
|
|
1351
|
-
UNDEFINED = "UNDEFINED",
|
|
1352
|
-
/** Saved in the database but is awaiting payment. Non-active orders can't be suspended. */
|
|
1353
|
-
PENDING = "PENDING",
|
|
1354
|
-
/** Trial orders can't be suspended. */
|
|
1355
|
-
TRIAL = "TRIAL",
|
|
1356
|
-
/** Canceled orders can't be suspended. */
|
|
1357
|
-
CANCELED = "CANCELED",
|
|
1358
|
-
/** Ended orders can't be suspended. */
|
|
1359
|
-
ENDED = "ENDED",
|
|
1360
|
-
/** Paid for orders with future start dates can't be suspended. */
|
|
1361
|
-
NOT_STARTED = "NOT_STARTED",
|
|
1362
|
-
/** Order is already suspended. */
|
|
1363
|
-
ALREADY_SUSPENDED = "ALREADY_SUSPENDED",
|
|
1364
|
-
/** Orders based on recurring payments using older stripe versions can't be suspended. */
|
|
1365
|
-
OLD_STRIPE = "OLD_STRIPE"
|
|
1366
|
-
}
|
|
1367
|
-
/** @enumType */
|
|
1368
|
-
type ReasonNotSuspendableWithLiterals = ReasonNotSuspendable | 'UNDEFINED' | 'PENDING' | 'TRIAL' | 'CANCELED' | 'ENDED' | 'NOT_STARTED' | 'ALREADY_SUSPENDED' | 'OLD_STRIPE';
|
|
1369
|
-
interface PostponeEndDateRequest {
|
|
1370
|
-
/**
|
|
1371
|
-
* Order ID.
|
|
1372
|
-
* @format GUID
|
|
1373
|
-
*/
|
|
1374
|
-
_id: string;
|
|
1375
|
-
/**
|
|
1376
|
-
* New end date and time.
|
|
1377
|
-
*
|
|
1378
|
-
* Must be later than the current end date and time.
|
|
1379
|
-
*/
|
|
1380
|
-
endDate: Date | null;
|
|
1381
|
-
}
|
|
1382
|
-
interface PostponeEndDateResponse {
|
|
1383
|
-
}
|
|
1384
|
-
interface OrderEndDatePostponed {
|
|
1385
|
-
/** Order whose `endDate` was postponed. */
|
|
1386
|
-
order?: Order;
|
|
1387
|
-
}
|
|
1388
|
-
interface CancelOrderRequest {
|
|
1389
|
-
/**
|
|
1390
|
-
* Order ID.
|
|
1391
|
-
* @format GUID
|
|
1392
|
-
*/
|
|
1393
|
-
_id: string;
|
|
1394
|
-
/** __Required.__ When the order will be canceled. One-time orders can only be canceled `IMMEDIATELY`. */
|
|
1395
|
-
effectiveAt: CancellationEffectiveAtWithLiterals;
|
|
1396
|
-
}
|
|
1397
|
-
interface CancelOrderResponse {
|
|
1398
|
-
}
|
|
1399
|
-
interface MarkAsPaidRequest {
|
|
1400
|
-
/**
|
|
1401
|
-
* Order ID.
|
|
1402
|
-
* @format GUID
|
|
1403
|
-
*/
|
|
1404
|
-
_id: string;
|
|
1405
|
-
}
|
|
1406
|
-
interface MarkAsPaidResponse {
|
|
1407
|
-
}
|
|
1408
|
-
interface OrderMarkedAsPaid {
|
|
1409
|
-
/** Order that was marked as paid. */
|
|
1410
|
-
order?: Order;
|
|
1411
|
-
}
|
|
1412
|
-
interface PauseOrderRequest {
|
|
1413
|
-
/**
|
|
1414
|
-
* Order ID.
|
|
1415
|
-
* @format GUID
|
|
1416
|
-
*/
|
|
1417
|
-
_id: string;
|
|
1418
|
-
}
|
|
1419
|
-
interface PauseOrderResponse {
|
|
1420
|
-
}
|
|
1421
|
-
interface OrderPaused {
|
|
1422
|
-
/** Paused order. */
|
|
1423
|
-
order?: Order;
|
|
1424
|
-
}
|
|
1425
|
-
interface BulkPauseOrderRequest {
|
|
1426
|
-
/**
|
|
1427
|
-
* List of Order IDs.
|
|
1428
|
-
* @format GUID
|
|
1429
|
-
* @minSize 1
|
|
1430
|
-
* @maxSize 100
|
|
1431
|
-
*/
|
|
1432
|
-
ids?: string[];
|
|
1433
|
-
/** Set to true to return Order entity in response. */
|
|
1434
|
-
returnFullEntity?: boolean;
|
|
1435
|
-
}
|
|
1436
|
-
interface BulkPauseOrderResponse {
|
|
1437
|
-
/** Orders that were paused. */
|
|
1438
|
-
results?: BulkOrderResult[];
|
|
1439
|
-
/** Bulk action metadata. */
|
|
1440
|
-
bulkActionMetadata?: BulkActionMetadata;
|
|
1441
|
-
}
|
|
1442
|
-
interface BulkOrderResult {
|
|
1443
|
-
/** Item metadata */
|
|
1444
|
-
itemMetadata?: ItemMetadata;
|
|
1445
|
-
/** The order. */
|
|
1446
|
-
order?: Order;
|
|
1447
|
-
}
|
|
1448
|
-
interface ItemMetadata {
|
|
1449
|
-
/** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
|
|
1450
|
-
_id?: string | null;
|
|
1451
|
-
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
1452
|
-
originalIndex?: number;
|
|
1453
|
-
/** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
|
|
1454
|
-
success?: boolean;
|
|
1455
|
-
/** Details about the error in case of failure. */
|
|
1456
|
-
error?: ApplicationError;
|
|
1457
|
-
}
|
|
1458
|
-
interface ApplicationError {
|
|
1459
|
-
/** Error code. */
|
|
1460
|
-
code?: string;
|
|
1461
|
-
/** Description of the error. */
|
|
1462
|
-
description?: string;
|
|
1463
|
-
/** Data related to the error. */
|
|
1464
|
-
data?: Record<string, any> | null;
|
|
1465
|
-
}
|
|
1466
|
-
interface BulkActionMetadata {
|
|
1467
|
-
/** Number of items that were successfully processed. */
|
|
1468
|
-
totalSuccesses?: number;
|
|
1469
|
-
/** Number of items that couldn't be processed. */
|
|
1470
|
-
totalFailures?: number;
|
|
1471
|
-
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
1472
|
-
undetailedFailures?: number;
|
|
1473
|
-
}
|
|
1474
|
-
interface ResumeOrderRequest {
|
|
1475
|
-
/**
|
|
1476
|
-
* Order ID.
|
|
1477
|
-
* @format GUID
|
|
1478
|
-
*/
|
|
1479
|
-
_id: string;
|
|
1480
|
-
}
|
|
1481
|
-
interface ResumeOrderResponse {
|
|
1482
|
-
}
|
|
1483
|
-
interface OrderResumed {
|
|
1484
|
-
/** Resumed order. */
|
|
1485
|
-
order?: Order;
|
|
1486
|
-
}
|
|
1487
|
-
interface BulkResumeOrderRequest {
|
|
1488
|
-
/**
|
|
1489
|
-
* List of Order IDs.
|
|
1490
|
-
* @format GUID
|
|
1491
|
-
* @minSize 1
|
|
1492
|
-
* @maxSize 100
|
|
1493
|
-
*/
|
|
1494
|
-
ids?: string[];
|
|
1495
|
-
/** Set to true to return Order entity in response. */
|
|
1496
|
-
returnFullEntity?: boolean;
|
|
1497
|
-
}
|
|
1498
|
-
interface BulkResumeOrderResponse {
|
|
1499
|
-
/** Orders that were resumed. */
|
|
1500
|
-
results?: BulkOrderResult[];
|
|
1501
|
-
/** Bulk action metadata. */
|
|
1502
|
-
bulkActionMetadata?: BulkActionMetadata;
|
|
1503
|
-
}
|
|
1504
1504
|
/** @docsIgnore */
|
|
1505
1505
|
type CreateOnlineOrderApplicationErrors = {
|
|
1506
1506
|
code?: 'MEMBER_REQUIRED';
|
|
@@ -1840,7 +1840,41 @@ interface EventMetadata extends BaseEventMetadata {
|
|
|
1840
1840
|
* You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
|
|
1841
1841
|
*/
|
|
1842
1842
|
entityEventSequence?: string | null;
|
|
1843
|
+
accountInfo?: AccountInfoMetadata;
|
|
1844
|
+
}
|
|
1845
|
+
interface AccountInfoMetadata {
|
|
1846
|
+
/** ID of the Wix account associated with the event */
|
|
1847
|
+
accountId: string;
|
|
1848
|
+
/** ID of the Wix site associated with the event. Only included when the event is tied to a specific site. */
|
|
1849
|
+
siteId?: string;
|
|
1850
|
+
/** ID of the parent Wix account. Only included when 'accountId' belongs to a child account. */
|
|
1851
|
+
parentAccountId?: string;
|
|
1843
1852
|
}
|
|
1853
|
+
interface OrderAutoRenewCanceledEnvelope {
|
|
1854
|
+
data: OrderAutoRenewCanceled;
|
|
1855
|
+
metadata: EventMetadata;
|
|
1856
|
+
}
|
|
1857
|
+
/**
|
|
1858
|
+
* Triggered when an order is canceled and `effectiveAt` is set to `NEXT_PAYMENT_DATE`.
|
|
1859
|
+
*
|
|
1860
|
+
* This webhook is *not* triggered in the following scenarios:
|
|
1861
|
+
* + When an order is canceled and `effectiveAt` is set to `IMMEDIATELY`. Instead, at the time of cancellation, Order Canceled is triggered.
|
|
1862
|
+
* + When an order expires at the end of the current payment cycle because it was canceled and `effectiveAt` was set to `NEXT_PAYMENT_DATE`. Instead, at the time of expiration, Order Canceled and Order Ended are triggered.
|
|
1863
|
+
* @permissionScope Manage Orders
|
|
1864
|
+
* @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
|
|
1865
|
+
* @permissionScope Read Orders
|
|
1866
|
+
* @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS
|
|
1867
|
+
* @permissionScope Manage plans and orders of Pricing Plans
|
|
1868
|
+
* @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-PLANS-AND-ORDERS
|
|
1869
|
+
* @permissionScope Manage Events
|
|
1870
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1871
|
+
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
1872
|
+
* @webhook
|
|
1873
|
+
* @eventType wix.pricing_plans.v2.order_auto_renew_canceled
|
|
1874
|
+
* @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
|
|
1875
|
+
* @slug auto_renew_canceled
|
|
1876
|
+
*/
|
|
1877
|
+
declare function onOrderAutoRenewCanceled(handler: (event: OrderAutoRenewCanceledEnvelope) => void | Promise<void>): void;
|
|
1844
1878
|
interface OrderCanceledEnvelope {
|
|
1845
1879
|
data: OrderCanceled;
|
|
1846
1880
|
metadata: EventMetadata;
|
|
@@ -1862,16 +1896,18 @@ interface OrderCanceledEnvelope {
|
|
|
1862
1896
|
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
1863
1897
|
* @webhook
|
|
1864
1898
|
* @eventType wix.pricing_plans.v2.order_canceled
|
|
1865
|
-
* @serviceIdentifier com.wixpress.membership.v2.orders.
|
|
1899
|
+
* @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
|
|
1866
1900
|
* @slug canceled
|
|
1867
1901
|
*/
|
|
1868
1902
|
declare function onOrderCanceled(handler: (event: OrderCanceledEnvelope) => void | Promise<void>): void;
|
|
1869
|
-
interface
|
|
1870
|
-
|
|
1903
|
+
interface OrderCycleStartedEnvelope {
|
|
1904
|
+
data: OrderCycleStarted;
|
|
1871
1905
|
metadata: EventMetadata;
|
|
1872
1906
|
}
|
|
1873
1907
|
/**
|
|
1874
|
-
* Triggered
|
|
1908
|
+
* Triggered at the start of a new payment cycle for an existing order.
|
|
1909
|
+
*
|
|
1910
|
+
* Not triggered at the initial start of an offline order.
|
|
1875
1911
|
* @permissionScope Manage Orders
|
|
1876
1912
|
* @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
|
|
1877
1913
|
* @permissionScope Read Orders
|
|
@@ -1882,17 +1918,17 @@ interface OrderCreatedEnvelope {
|
|
|
1882
1918
|
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1883
1919
|
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
1884
1920
|
* @webhook
|
|
1885
|
-
* @eventType wix.pricing_plans.v2.
|
|
1886
|
-
* @serviceIdentifier com.wixpress.membership.v2.orders.
|
|
1887
|
-
* @slug
|
|
1921
|
+
* @eventType wix.pricing_plans.v2.order_cycle_started
|
|
1922
|
+
* @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
|
|
1923
|
+
* @slug cycle_started
|
|
1888
1924
|
*/
|
|
1889
|
-
declare function
|
|
1890
|
-
interface
|
|
1891
|
-
data:
|
|
1925
|
+
declare function onOrderCycleStarted(handler: (event: OrderCycleStartedEnvelope) => void | Promise<void>): void;
|
|
1926
|
+
interface OrderEndDatePostponedEnvelope {
|
|
1927
|
+
data: OrderEndDatePostponed;
|
|
1892
1928
|
metadata: EventMetadata;
|
|
1893
1929
|
}
|
|
1894
1930
|
/**
|
|
1895
|
-
* Triggered when an order's `
|
|
1931
|
+
* Triggered when an order's `endDate` is postponed.
|
|
1896
1932
|
* @permissionScope Manage Orders
|
|
1897
1933
|
* @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
|
|
1898
1934
|
* @permissionScope Read Orders
|
|
@@ -1903,25 +1939,21 @@ interface OrderStartDateChangedEnvelope {
|
|
|
1903
1939
|
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1904
1940
|
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
1905
1941
|
* @webhook
|
|
1906
|
-
* @eventType wix.pricing_plans.v2.
|
|
1907
|
-
* @serviceIdentifier com.wixpress.membership.v2.orders.
|
|
1908
|
-
* @slug
|
|
1942
|
+
* @eventType wix.pricing_plans.v2.order_end_date_postponed
|
|
1943
|
+
* @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
|
|
1944
|
+
* @slug end_date_postponed
|
|
1909
1945
|
*/
|
|
1910
|
-
declare function
|
|
1911
|
-
interface
|
|
1912
|
-
|
|
1946
|
+
declare function onOrderEndDatePostponed(handler: (event: OrderEndDatePostponedEnvelope) => void | Promise<void>): void;
|
|
1947
|
+
interface OrderEndedEnvelope {
|
|
1948
|
+
data: OrderEnded;
|
|
1913
1949
|
metadata: EventMetadata;
|
|
1914
1950
|
}
|
|
1915
1951
|
/**
|
|
1916
|
-
* Triggered
|
|
1952
|
+
* Triggered when an order ends.
|
|
1917
1953
|
*
|
|
1918
|
-
*
|
|
1919
|
-
* +
|
|
1920
|
-
* +
|
|
1921
|
-
* + Offline order is marked as paid. Order Marked As Paid is also triggered.
|
|
1922
|
-
* + End date of the order is postponed. Order End Date Postponed is also triggered
|
|
1923
|
-
* + Order is paused, or a paused order is resumed. Order Paused and Order Resumed, respectively, are also triggered.
|
|
1924
|
-
* + Order is canceled, either immediately or at the end of the payment cycle. Order Canceled and Order Auto Renew Canceled, respectively, are also triggered.
|
|
1954
|
+
* This webhook is triggered:
|
|
1955
|
+
* + When an order expires at the end of the current payment cycle.
|
|
1956
|
+
* + When an order is canceled and `effectiveAt` is set to `IMMEDIATELY`.
|
|
1925
1957
|
* @permissionScope Manage Orders
|
|
1926
1958
|
* @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
|
|
1927
1959
|
* @permissionScope Read Orders
|
|
@@ -1932,21 +1964,17 @@ interface OrderUpdatedEnvelope {
|
|
|
1932
1964
|
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1933
1965
|
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
1934
1966
|
* @webhook
|
|
1935
|
-
* @eventType wix.pricing_plans.v2.
|
|
1936
|
-
* @serviceIdentifier com.wixpress.membership.v2.orders.
|
|
1937
|
-
* @slug
|
|
1967
|
+
* @eventType wix.pricing_plans.v2.order_ended
|
|
1968
|
+
* @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
|
|
1969
|
+
* @slug ended
|
|
1938
1970
|
*/
|
|
1939
|
-
declare function
|
|
1940
|
-
interface
|
|
1941
|
-
data:
|
|
1971
|
+
declare function onOrderEnded(handler: (event: OrderEndedEnvelope) => void | Promise<void>): void;
|
|
1972
|
+
interface OrderMarkedAsPaidEnvelope {
|
|
1973
|
+
data: OrderMarkedAsPaid;
|
|
1942
1974
|
metadata: EventMetadata;
|
|
1943
1975
|
}
|
|
1944
1976
|
/**
|
|
1945
|
-
* Triggered when an order is
|
|
1946
|
-
*
|
|
1947
|
-
* This webhook is *not* triggered in the following scenarios:
|
|
1948
|
-
* + When an order is canceled and `effectiveAt` is set to `IMMEDIATELY`. Instead, at the time of cancellation, Order Canceled is triggered.
|
|
1949
|
-
* + When an order expires at the end of the current payment cycle because it was canceled and `effectiveAt` was set to `NEXT_PAYMENT_DATE`. Instead, at the time of expiration, Order Canceled and Order Ended are triggered.
|
|
1977
|
+
* Triggered when an offline order is marked as paid.
|
|
1950
1978
|
* @permissionScope Manage Orders
|
|
1951
1979
|
* @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
|
|
1952
1980
|
* @permissionScope Read Orders
|
|
@@ -1957,19 +1985,17 @@ interface OrderAutoRenewCanceledEnvelope {
|
|
|
1957
1985
|
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1958
1986
|
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
1959
1987
|
* @webhook
|
|
1960
|
-
* @eventType wix.pricing_plans.v2.
|
|
1988
|
+
* @eventType wix.pricing_plans.v2.order_marked_as_paid
|
|
1961
1989
|
* @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
|
|
1962
|
-
* @slug
|
|
1990
|
+
* @slug marked_as_paid
|
|
1963
1991
|
*/
|
|
1964
|
-
declare function
|
|
1965
|
-
interface
|
|
1966
|
-
data:
|
|
1992
|
+
declare function onOrderMarkedAsPaid(handler: (event: OrderMarkedAsPaidEnvelope) => void | Promise<void>): void;
|
|
1993
|
+
interface OrderPausedEnvelope {
|
|
1994
|
+
data: OrderPaused;
|
|
1967
1995
|
metadata: EventMetadata;
|
|
1968
1996
|
}
|
|
1969
1997
|
/**
|
|
1970
|
-
* Triggered
|
|
1971
|
-
*
|
|
1972
|
-
* Not triggered at the initial start of an offline order.
|
|
1998
|
+
* Triggered when an order is paused.
|
|
1973
1999
|
* @permissionScope Manage Orders
|
|
1974
2000
|
* @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
|
|
1975
2001
|
* @permissionScope Read Orders
|
|
@@ -1980,17 +2006,21 @@ interface OrderCycleStartedEnvelope {
|
|
|
1980
2006
|
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1981
2007
|
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
1982
2008
|
* @webhook
|
|
1983
|
-
* @eventType wix.pricing_plans.v2.
|
|
2009
|
+
* @eventType wix.pricing_plans.v2.order_paused
|
|
1984
2010
|
* @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
|
|
1985
|
-
* @slug
|
|
2011
|
+
* @slug paused
|
|
1986
2012
|
*/
|
|
1987
|
-
declare function
|
|
1988
|
-
interface
|
|
1989
|
-
data:
|
|
2013
|
+
declare function onOrderPaused(handler: (event: OrderPausedEnvelope) => void | Promise<void>): void;
|
|
2014
|
+
interface OrderPurchasedEnvelope {
|
|
2015
|
+
data: OrderPurchased;
|
|
1990
2016
|
metadata: EventMetadata;
|
|
1991
2017
|
}
|
|
1992
2018
|
/**
|
|
1993
|
-
* Triggered
|
|
2019
|
+
* Triggered for any of the following purchase events:
|
|
2020
|
+
* + Order is paid in full.
|
|
2021
|
+
* + At least 1 order cycle payment is paid for.
|
|
2022
|
+
* + Offline order is created, even if not yet marked as paid.
|
|
2023
|
+
* + Free order is created.
|
|
1994
2024
|
* @permissionScope Manage Orders
|
|
1995
2025
|
* @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
|
|
1996
2026
|
* @permissionScope Read Orders
|
|
@@ -2001,21 +2031,17 @@ interface OrderEndDatePostponedEnvelope {
|
|
|
2001
2031
|
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
2002
2032
|
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
2003
2033
|
* @webhook
|
|
2004
|
-
* @eventType wix.pricing_plans.v2.
|
|
2034
|
+
* @eventType wix.pricing_plans.v2.order_purchased
|
|
2005
2035
|
* @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
|
|
2006
|
-
* @slug
|
|
2036
|
+
* @slug purchased
|
|
2007
2037
|
*/
|
|
2008
|
-
declare function
|
|
2009
|
-
interface
|
|
2010
|
-
data:
|
|
2038
|
+
declare function onOrderPurchased(handler: (event: OrderPurchasedEnvelope) => void | Promise<void>): void;
|
|
2039
|
+
interface OrderResumedEnvelope {
|
|
2040
|
+
data: OrderResumed;
|
|
2011
2041
|
metadata: EventMetadata;
|
|
2012
2042
|
}
|
|
2013
2043
|
/**
|
|
2014
|
-
* Triggered when
|
|
2015
|
-
*
|
|
2016
|
-
* This webhook is triggered:
|
|
2017
|
-
* + When an order expires at the end of the current payment cycle.
|
|
2018
|
-
* + When an order is canceled and `effectiveAt` is set to `IMMEDIATELY`.
|
|
2044
|
+
* Triggered when a paused order is resumed.
|
|
2019
2045
|
* @permissionScope Manage Orders
|
|
2020
2046
|
* @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
|
|
2021
2047
|
* @permissionScope Read Orders
|
|
@@ -2026,17 +2052,17 @@ interface OrderEndedEnvelope {
|
|
|
2026
2052
|
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
2027
2053
|
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
2028
2054
|
* @webhook
|
|
2029
|
-
* @eventType wix.pricing_plans.v2.
|
|
2055
|
+
* @eventType wix.pricing_plans.v2.order_resumed
|
|
2030
2056
|
* @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
|
|
2031
|
-
* @slug
|
|
2057
|
+
* @slug resumed
|
|
2032
2058
|
*/
|
|
2033
|
-
declare function
|
|
2034
|
-
interface
|
|
2035
|
-
data:
|
|
2059
|
+
declare function onOrderResumed(handler: (event: OrderResumedEnvelope) => void | Promise<void>): void;
|
|
2060
|
+
interface OrderStartedEnvelope {
|
|
2061
|
+
data: OrderStarted;
|
|
2036
2062
|
metadata: EventMetadata;
|
|
2037
2063
|
}
|
|
2038
2064
|
/**
|
|
2039
|
-
* Triggered when an
|
|
2065
|
+
* Triggered when an order reaches its `startDate`. Applies to both purchased and free orders.
|
|
2040
2066
|
* @permissionScope Manage Orders
|
|
2041
2067
|
* @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
|
|
2042
2068
|
* @permissionScope Read Orders
|
|
@@ -2047,17 +2073,25 @@ interface OrderMarkedAsPaidEnvelope {
|
|
|
2047
2073
|
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
2048
2074
|
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
2049
2075
|
* @webhook
|
|
2050
|
-
* @eventType wix.pricing_plans.v2.
|
|
2076
|
+
* @eventType wix.pricing_plans.v2.order_started
|
|
2051
2077
|
* @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
|
|
2052
|
-
* @slug
|
|
2078
|
+
* @slug started
|
|
2053
2079
|
*/
|
|
2054
|
-
declare function
|
|
2055
|
-
interface
|
|
2056
|
-
|
|
2080
|
+
declare function onOrderStarted(handler: (event: OrderStartedEnvelope) => void | Promise<void>): void;
|
|
2081
|
+
interface OrderUpdatedEnvelope {
|
|
2082
|
+
entity: Order;
|
|
2057
2083
|
metadata: EventMetadata;
|
|
2058
2084
|
}
|
|
2059
2085
|
/**
|
|
2060
|
-
* Triggered
|
|
2086
|
+
* Triggered for any of the following update events:
|
|
2087
|
+
*
|
|
2088
|
+
* + Order is paid for. Order Purchased is also triggered.
|
|
2089
|
+
* + Order reaches its start date or end date. Order Started and Order Ended, respectively, are also triggered.
|
|
2090
|
+
* + New payment cycle of an order starts. Order Cycle Started is also triggered.
|
|
2091
|
+
* + Offline order is marked as paid. Order Marked As Paid is also triggered.
|
|
2092
|
+
* + End date of the order is postponed. Order End Date Postponed is also triggered
|
|
2093
|
+
* + Order is paused, or a paused order is resumed. Order Paused and Order Resumed, respectively, are also triggered.
|
|
2094
|
+
* + Order is canceled, either immediately or at the end of the payment cycle. Order Canceled and Order Auto Renew Canceled, respectively, are also triggered.
|
|
2061
2095
|
* @permissionScope Manage Orders
|
|
2062
2096
|
* @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
|
|
2063
2097
|
* @permissionScope Read Orders
|
|
@@ -2068,21 +2102,17 @@ interface OrderPausedEnvelope {
|
|
|
2068
2102
|
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
2069
2103
|
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
2070
2104
|
* @webhook
|
|
2071
|
-
* @eventType wix.pricing_plans.v2.
|
|
2105
|
+
* @eventType wix.pricing_plans.v2.order_updated
|
|
2072
2106
|
* @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
|
|
2073
|
-
* @slug
|
|
2107
|
+
* @slug updated
|
|
2074
2108
|
*/
|
|
2075
|
-
declare function
|
|
2076
|
-
interface
|
|
2077
|
-
|
|
2109
|
+
declare function onOrderUpdated(handler: (event: OrderUpdatedEnvelope) => void | Promise<void>): void;
|
|
2110
|
+
interface OrderCreatedEnvelope {
|
|
2111
|
+
entity: Order;
|
|
2078
2112
|
metadata: EventMetadata;
|
|
2079
2113
|
}
|
|
2080
2114
|
/**
|
|
2081
|
-
* Triggered
|
|
2082
|
-
* + Order is paid in full.
|
|
2083
|
-
* + At least 1 order cycle payment is paid for.
|
|
2084
|
-
* + Offline order is created, even if not yet marked as paid.
|
|
2085
|
-
* + Free order is created.
|
|
2115
|
+
* Triggered when an order is created.
|
|
2086
2116
|
* @permissionScope Manage Orders
|
|
2087
2117
|
* @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
|
|
2088
2118
|
* @permissionScope Read Orders
|
|
@@ -2093,53 +2123,206 @@ interface OrderPurchasedEnvelope {
|
|
|
2093
2123
|
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
2094
2124
|
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
2095
2125
|
* @webhook
|
|
2096
|
-
* @eventType wix.pricing_plans.v2.
|
|
2097
|
-
* @serviceIdentifier com.wixpress.membership.v2.orders.
|
|
2098
|
-
* @slug
|
|
2126
|
+
* @eventType wix.pricing_plans.v2.order_created
|
|
2127
|
+
* @serviceIdentifier com.wixpress.membership.v2.orders.CheckoutService
|
|
2128
|
+
* @slug created
|
|
2129
|
+
*/
|
|
2130
|
+
declare function onOrderCreated(handler: (event: OrderCreatedEnvelope) => void | Promise<void>): void;
|
|
2131
|
+
interface OrderStartDateChangedEnvelope {
|
|
2132
|
+
data: OrderStartDateChanged;
|
|
2133
|
+
metadata: EventMetadata;
|
|
2134
|
+
}
|
|
2135
|
+
/**
|
|
2136
|
+
* Triggered when an order's `startDate` is changed.
|
|
2137
|
+
* @permissionScope Manage Orders
|
|
2138
|
+
* @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
|
|
2139
|
+
* @permissionScope Read Orders
|
|
2140
|
+
* @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS
|
|
2141
|
+
* @permissionScope Manage plans and orders of Pricing Plans
|
|
2142
|
+
* @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-PLANS-AND-ORDERS
|
|
2143
|
+
* @permissionScope Manage Events
|
|
2144
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
2145
|
+
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
2146
|
+
* @webhook
|
|
2147
|
+
* @eventType wix.pricing_plans.v2.order_start_date_changed
|
|
2148
|
+
* @serviceIdentifier com.wixpress.membership.v2.orders.CheckoutService
|
|
2149
|
+
* @slug start_date_changed
|
|
2150
|
+
*/
|
|
2151
|
+
declare function onOrderStartDateChanged(handler: (event: OrderStartDateChangedEnvelope) => void | Promise<void>): void;
|
|
2152
|
+
/**
|
|
2153
|
+
* Retrieves an order by ID.
|
|
2154
|
+
* @param _id - Order ID.
|
|
2155
|
+
* @public
|
|
2156
|
+
* @requiredField _id
|
|
2157
|
+
* @param options - Options to use when getting an order.
|
|
2158
|
+
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
2159
|
+
* @applicableIdentity APP
|
|
2160
|
+
* @fqn com.wixpress.membership.v2.orders.OrderManagementService.GetOrder
|
|
2161
|
+
*/
|
|
2162
|
+
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>>;
|
|
2163
|
+
interface ManagementGetOrderOptions {
|
|
2164
|
+
/**
|
|
2165
|
+
* Predefined set of fields to return.
|
|
2166
|
+
*
|
|
2167
|
+
* Default: If `fieldSet` is omitted, no order form submission data is returned.
|
|
2168
|
+
*/
|
|
2169
|
+
fieldSet?: SetWithLiterals;
|
|
2170
|
+
}
|
|
2171
|
+
/**
|
|
2172
|
+
* Retrieves a list of up to 50 pricing plan orders and details, given the specified sorting and filtering.
|
|
2173
|
+
*
|
|
2174
|
+
* By default, this endpoint will retrieve all orders and return them sorted by `createdDate` in `DESC`, descending order.
|
|
2175
|
+
* `sort.fieldName` supports `endDate` and `createdDate` fields and defaults to `ASC`, ascending order.
|
|
2176
|
+
* @public
|
|
2177
|
+
* @param options - Filtering, sorting, and pagination options.
|
|
2178
|
+
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
2179
|
+
* @applicableIdentity APP
|
|
2180
|
+
* @fqn com.wixpress.membership.v2.orders.OrderManagementService.ListOrders
|
|
2181
|
+
*/
|
|
2182
|
+
declare function managementListOrders(options?: ManagementListOrdersOptions): Promise<NonNullablePaths<ListOrdersResponse, `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>>;
|
|
2183
|
+
interface ManagementListOrdersOptions {
|
|
2184
|
+
/**
|
|
2185
|
+
* Filter by a buyer's member ID, from the Members API.
|
|
2186
|
+
* @format GUID
|
|
2187
|
+
*/
|
|
2188
|
+
buyerIds?: string[];
|
|
2189
|
+
/**
|
|
2190
|
+
* Filter by plan IDs, from the Plans API.
|
|
2191
|
+
* @format GUID
|
|
2192
|
+
*/
|
|
2193
|
+
planIds?: string[];
|
|
2194
|
+
/** Filter by whether or not the auto-renewal of recurring orders was canceled. */
|
|
2195
|
+
autoRenewCanceled?: boolean | null;
|
|
2196
|
+
/** Filter by order status. */
|
|
2197
|
+
orderStatuses?: OrderStatusWithLiterals[];
|
|
2198
|
+
/** Filter by payment status. */
|
|
2199
|
+
paymentStatuses?: PaymentStatusWithLiterals[];
|
|
2200
|
+
/**
|
|
2201
|
+
* Number of orders to return. See Sorting and Paging for more information.
|
|
2202
|
+
*
|
|
2203
|
+
* Max: `50`
|
|
2204
|
+
* @min 1
|
|
2205
|
+
* @max 50
|
|
2206
|
+
*/
|
|
2207
|
+
limit?: number | null;
|
|
2208
|
+
/** Number of orders to skip in the current sort order. */
|
|
2209
|
+
offset?: number | null;
|
|
2210
|
+
/**
|
|
2211
|
+
* Sort order.
|
|
2212
|
+
*
|
|
2213
|
+
* Use `ASC` for ascending order or `DESC` for descending order.
|
|
2214
|
+
*
|
|
2215
|
+
* Default: `DESC`.
|
|
2216
|
+
*/
|
|
2217
|
+
sorting?: Sorting;
|
|
2218
|
+
/**
|
|
2219
|
+
* Predefined set of fields to return.
|
|
2220
|
+
*
|
|
2221
|
+
* Default: If `fieldSet` is omitted, no order form submission data is returned.
|
|
2222
|
+
*/
|
|
2223
|
+
fieldSet?: SetWithLiterals;
|
|
2224
|
+
}
|
|
2225
|
+
/**
|
|
2226
|
+
* Extends the duration of a pricing plan order by postponing the order's `endDate`. Postponing the end date of an order does not impact payments.
|
|
2227
|
+
*
|
|
2228
|
+
* New `endDate` must be later than the order's current `endDate`. Can't postpone orders that are unlimited.
|
|
2229
|
+
* Can't postpone an order with `status`: `PAUSED`.
|
|
2230
|
+
* @param _id - Order ID.
|
|
2231
|
+
* @param endDate - New end date and time.
|
|
2232
|
+
*
|
|
2233
|
+
* Must be later than the current end date and time.
|
|
2234
|
+
* @public
|
|
2235
|
+
* @requiredField _id
|
|
2236
|
+
* @requiredField endDate
|
|
2237
|
+
* @param options - Options for postponing the end date of an order.
|
|
2238
|
+
* @permissionId PRICING_PLANS.MANAGE_ORDERS
|
|
2239
|
+
* @applicableIdentity APP
|
|
2240
|
+
* @fqn com.wixpress.membership.v2.orders.OrderManagementService.PostponeEndDate
|
|
2241
|
+
*/
|
|
2242
|
+
declare function postponeEndDate(_id: string, endDate: Date): Promise<void>;
|
|
2243
|
+
/**
|
|
2244
|
+
* Cancels an existing order.
|
|
2245
|
+
*
|
|
2246
|
+
* For orders with recurring payments, a cancellation can be set to occur either `IMMEDIATELY` or at the `NEXT_PAYMENT_DATE`.
|
|
2247
|
+
* For orders with one-time payments, a cancellation can only be set for `IMMEDIATELY`.
|
|
2248
|
+
*
|
|
2249
|
+
* #### Canceling during the free trial period.
|
|
2250
|
+
*
|
|
2251
|
+
* When a buyer cancels their order during the free trial period, the buyer's subscription expires at the end
|
|
2252
|
+
* of the free trial period and they will not be billed. The buyer may continue using the benefits until the end
|
|
2253
|
+
* of the free trial period.
|
|
2254
|
+
*
|
|
2255
|
+
* When a Wix user cancels an ordered plan during the free trial period, they choose whether to apply the cancellation
|
|
2256
|
+
* `IMMEDIATELY` or at the `NEXT_PAYMENT_DATE`. Canceling `IMMEDIATELY` will end the subscription for the buyer
|
|
2257
|
+
* immediately, even during the free trial period and the buyer won't be billed. Canceling at the
|
|
2258
|
+
* `NEXT_PAYMENT_DATE` allows the buyer to continue using the benefits of the subscription until the end of the free trial period.
|
|
2259
|
+
* Then, the subscription ends and the buyer is not billed.
|
|
2260
|
+
* @param _id - Order ID.
|
|
2261
|
+
* @param effectiveAt - __Required.__ When the order will be canceled. One-time orders can only be canceled `IMMEDIATELY`.
|
|
2262
|
+
* @public
|
|
2263
|
+
* @requiredField _id
|
|
2264
|
+
* @requiredField effectiveAt
|
|
2265
|
+
* @param options - Options for canceling orders.
|
|
2266
|
+
* @permissionId PRICING_PLANS.MANAGE_ORDERS
|
|
2267
|
+
* @applicableIdentity APP
|
|
2268
|
+
* @fqn com.wixpress.membership.v2.orders.OrderManagementService.CancelOrder
|
|
2269
|
+
*/
|
|
2270
|
+
declare function cancelOrder(_id: string, effectiveAt: CancellationEffectiveAtWithLiterals): Promise<void>;
|
|
2271
|
+
/**
|
|
2272
|
+
* Marks an offline order as paid.
|
|
2273
|
+
* > __Note__: Marking separate payment cycles as paid is not yet supported. The entire order will be marked as paid. Subsequent offline payments do trigger events and emails, but are not registered as additional offline payments.
|
|
2274
|
+
*
|
|
2275
|
+
* Marking an offline order as paid causes the following changes:
|
|
2276
|
+
* - The order's `lastPaymentStatus` changes to `"PAID"`.
|
|
2277
|
+
* - The order's status changes to either `"PENDING"` or `"ACTIVE"`, depending on the order's `startDate`.
|
|
2278
|
+
*
|
|
2279
|
+
* An error occurs if you attempt to:
|
|
2280
|
+
* - Mark an already-paid, offline order as paid. You cannot mark an offline order as paid twice.
|
|
2281
|
+
* - Mark an online order as paid. The Mark as Paid method is supported for offline orders only.
|
|
2282
|
+
* @param _id - Order ID.
|
|
2283
|
+
* @public
|
|
2284
|
+
* @requiredField _id
|
|
2285
|
+
* @permissionId PRICING_PLANS.MANAGE_ORDERS
|
|
2286
|
+
* @applicableIdentity APP
|
|
2287
|
+
* @fqn com.wixpress.membership.v2.orders.OrderManagementService.MarkAsPaid
|
|
2099
2288
|
*/
|
|
2100
|
-
declare function
|
|
2101
|
-
interface OrderResumedEnvelope {
|
|
2102
|
-
data: OrderResumed;
|
|
2103
|
-
metadata: EventMetadata;
|
|
2104
|
-
}
|
|
2289
|
+
declare function markAsPaid(_id: string): Promise<void>;
|
|
2105
2290
|
/**
|
|
2106
|
-
*
|
|
2107
|
-
*
|
|
2108
|
-
*
|
|
2109
|
-
*
|
|
2110
|
-
*
|
|
2111
|
-
*
|
|
2112
|
-
*
|
|
2113
|
-
*
|
|
2114
|
-
* @
|
|
2115
|
-
* @
|
|
2116
|
-
* @
|
|
2117
|
-
* @
|
|
2118
|
-
* @
|
|
2119
|
-
* @
|
|
2291
|
+
* Pauses an order. Calling this method changes the order status to `"PAUSED"` and updates the `pausePeriods` array.
|
|
2292
|
+
*
|
|
2293
|
+
* Only orders with `status`: `ACTIVE` can be paused.
|
|
2294
|
+
* For orders with recurring payments, it also pauses the payment schedule. Buyers are not charged when an order is paused.
|
|
2295
|
+
* Pausing an order affects the end date of the order by adding the time the order is paused to the `endDate`.
|
|
2296
|
+
* The `endDate` and the `earliestEndDate` for the order are adjusted to include the pause period when the order is resumed.
|
|
2297
|
+
*
|
|
2298
|
+
* To resume a paused order, call Resume Order.
|
|
2299
|
+
* @param _id - Order ID.
|
|
2300
|
+
* @public
|
|
2301
|
+
* @requiredField _id
|
|
2302
|
+
* @permissionId PRICING_PLANS.MANAGE_ORDERS
|
|
2303
|
+
* @applicableIdentity APP
|
|
2304
|
+
* @fqn com.wixpress.membership.v2.orders.OrderManagementService.PauseOrder
|
|
2120
2305
|
*/
|
|
2121
|
-
declare function
|
|
2122
|
-
interface OrderStartedEnvelope {
|
|
2123
|
-
data: OrderStarted;
|
|
2124
|
-
metadata: EventMetadata;
|
|
2125
|
-
}
|
|
2306
|
+
declare function pauseOrder(_id: string): Promise<void>;
|
|
2126
2307
|
/**
|
|
2127
|
-
*
|
|
2128
|
-
*
|
|
2129
|
-
*
|
|
2130
|
-
*
|
|
2131
|
-
*
|
|
2132
|
-
*
|
|
2133
|
-
*
|
|
2134
|
-
*
|
|
2135
|
-
*
|
|
2136
|
-
*
|
|
2137
|
-
* @
|
|
2138
|
-
* @
|
|
2139
|
-
* @
|
|
2140
|
-
* @
|
|
2308
|
+
* Resumes a paused order. For orders with recurring payments, it also restarts the payment schedule.
|
|
2309
|
+
*
|
|
2310
|
+
* Resuming an order causes the following changes:
|
|
2311
|
+
* - The order status changes to `"ACTIVE"`.
|
|
2312
|
+
* - The `pausePeriods` array is updated.
|
|
2313
|
+
* - The `endDate` for the order is adjusted to include the pause period.
|
|
2314
|
+
* - For orders with recurring payments, the payment schedule is restarted.
|
|
2315
|
+
* - The `earliestEndDate` is adjusted to include the pause period. (This property is reserved for future use).
|
|
2316
|
+
*
|
|
2317
|
+
* To pause an order, call Pause Order.
|
|
2318
|
+
* @param _id - Order ID.
|
|
2319
|
+
* @public
|
|
2320
|
+
* @requiredField _id
|
|
2321
|
+
* @permissionId PRICING_PLANS.MANAGE_ORDERS
|
|
2322
|
+
* @applicableIdentity APP
|
|
2323
|
+
* @fqn com.wixpress.membership.v2.orders.OrderManagementService.ResumeOrder
|
|
2141
2324
|
*/
|
|
2142
|
-
declare function
|
|
2325
|
+
declare function resumeOrder(_id: string): Promise<void>;
|
|
2143
2326
|
/**
|
|
2144
2327
|
* Retrieves an order for the currently logged-in member by ID.
|
|
2145
2328
|
* @param _id - Order ID.
|
|
@@ -2149,9 +2332,10 @@ declare function onOrderStarted(handler: (event: OrderStartedEnvelope) => void |
|
|
|
2149
2332
|
* @permissionId PRICING_PLANS.READ_OWN_ORDERS
|
|
2150
2333
|
* @applicableIdentity APP
|
|
2151
2334
|
* @applicableIdentity MEMBER
|
|
2335
|
+
* @returns Requested order.
|
|
2152
2336
|
* @fqn com.wixpress.membership.v2.orders.member.MemberOrdersService.GetOrder
|
|
2153
2337
|
*/
|
|
2154
|
-
declare function memberGetOrder(_id: string, options?: MemberGetOrderOptions): Promise<NonNullablePaths<
|
|
2338
|
+
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>>;
|
|
2155
2339
|
interface MemberGetOrderOptions {
|
|
2156
2340
|
/**
|
|
2157
2341
|
* Predefined set of fields to return.
|
|
@@ -2414,180 +2598,5 @@ interface GetPricePreviewOptions {
|
|
|
2414
2598
|
*/
|
|
2415
2599
|
couponCode?: string | null;
|
|
2416
2600
|
}
|
|
2417
|
-
/**
|
|
2418
|
-
* Retrieves an order by ID.
|
|
2419
|
-
* @param _id - Order ID.
|
|
2420
|
-
* @public
|
|
2421
|
-
* @requiredField _id
|
|
2422
|
-
* @param options - Options to use when getting an order.
|
|
2423
|
-
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
2424
|
-
* @applicableIdentity APP
|
|
2425
|
-
* @returns Order.
|
|
2426
|
-
* @fqn com.wixpress.membership.v2.orders.OrderManagementService.GetOrder
|
|
2427
|
-
*/
|
|
2428
|
-
declare function managementGetOrder(_id: string, options?: ManagementGetOrderOptions): 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>>;
|
|
2429
|
-
interface ManagementGetOrderOptions {
|
|
2430
|
-
/**
|
|
2431
|
-
* Predefined set of fields to return.
|
|
2432
|
-
*
|
|
2433
|
-
* Default: If `fieldSet` is omitted, no order form submission data is returned.
|
|
2434
|
-
*/
|
|
2435
|
-
fieldSet?: SetWithLiterals;
|
|
2436
|
-
}
|
|
2437
|
-
/**
|
|
2438
|
-
* Retrieves a list of up to 50 pricing plan orders and details, given the specified sorting and filtering.
|
|
2439
|
-
*
|
|
2440
|
-
* By default, this endpoint will retrieve all orders and return them sorted by `createdDate` in `DESC`, descending order.
|
|
2441
|
-
* `sort.fieldName` supports `endDate` and `createdDate` fields and defaults to `ASC`, ascending order.
|
|
2442
|
-
* @public
|
|
2443
|
-
* @param options - Filtering, sorting, and pagination options.
|
|
2444
|
-
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
2445
|
-
* @applicableIdentity APP
|
|
2446
|
-
* @fqn com.wixpress.membership.v2.orders.OrderManagementService.ListOrders
|
|
2447
|
-
*/
|
|
2448
|
-
declare function managementListOrders(options?: ManagementListOrdersOptions): Promise<NonNullablePaths<ListOrdersResponse, `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>>;
|
|
2449
|
-
interface ManagementListOrdersOptions {
|
|
2450
|
-
/**
|
|
2451
|
-
* Filter by a buyer's member ID, from the Members API.
|
|
2452
|
-
* @format GUID
|
|
2453
|
-
*/
|
|
2454
|
-
buyerIds?: string[];
|
|
2455
|
-
/**
|
|
2456
|
-
* Filter by plan IDs, from the Plans API.
|
|
2457
|
-
* @format GUID
|
|
2458
|
-
*/
|
|
2459
|
-
planIds?: string[];
|
|
2460
|
-
/** Filter by whether or not the auto-renewal of recurring orders was canceled. */
|
|
2461
|
-
autoRenewCanceled?: boolean | null;
|
|
2462
|
-
/** Filter by order status. */
|
|
2463
|
-
orderStatuses?: OrderStatusWithLiterals[];
|
|
2464
|
-
/** Filter by payment status. */
|
|
2465
|
-
paymentStatuses?: PaymentStatusWithLiterals[];
|
|
2466
|
-
/**
|
|
2467
|
-
* Number of orders to return. See Sorting and Paging for more information.
|
|
2468
|
-
*
|
|
2469
|
-
* Max: `50`
|
|
2470
|
-
* @min 1
|
|
2471
|
-
* @max 50
|
|
2472
|
-
*/
|
|
2473
|
-
limit?: number | null;
|
|
2474
|
-
/** Number of orders to skip in the current sort order. */
|
|
2475
|
-
offset?: number | null;
|
|
2476
|
-
/**
|
|
2477
|
-
* Sort order.
|
|
2478
|
-
*
|
|
2479
|
-
* Use `ASC` for ascending order or `DESC` for descending order.
|
|
2480
|
-
*
|
|
2481
|
-
* Default: `DESC`.
|
|
2482
|
-
*/
|
|
2483
|
-
sorting?: Sorting;
|
|
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
|
-
* Extends the duration of a pricing plan order by postponing the order's `endDate`. Postponing the end date of an order does not impact payments.
|
|
2493
|
-
*
|
|
2494
|
-
* New `endDate` must be later than the order's current `endDate`. Can't postpone orders that are unlimited.
|
|
2495
|
-
* Can't postpone an order with `status`: `PAUSED`.
|
|
2496
|
-
* @param _id - Order ID.
|
|
2497
|
-
* @param endDate - New end date and time.
|
|
2498
|
-
*
|
|
2499
|
-
* Must be later than the current end date and time.
|
|
2500
|
-
* @public
|
|
2501
|
-
* @requiredField _id
|
|
2502
|
-
* @requiredField endDate
|
|
2503
|
-
* @param options - Options for postponing the end date of an order.
|
|
2504
|
-
* @permissionId PRICING_PLANS.MANAGE_ORDERS
|
|
2505
|
-
* @applicableIdentity APP
|
|
2506
|
-
* @fqn com.wixpress.membership.v2.orders.OrderManagementService.PostponeEndDate
|
|
2507
|
-
*/
|
|
2508
|
-
declare function postponeEndDate(_id: string, endDate: Date): Promise<void>;
|
|
2509
|
-
/**
|
|
2510
|
-
* Cancels an existing order.
|
|
2511
|
-
*
|
|
2512
|
-
* For orders with recurring payments, a cancellation can be set to occur either `IMMEDIATELY` or at the `NEXT_PAYMENT_DATE`.
|
|
2513
|
-
* For orders with one-time payments, a cancellation can only be set for `IMMEDIATELY`.
|
|
2514
|
-
*
|
|
2515
|
-
* #### Canceling during the free trial period.
|
|
2516
|
-
*
|
|
2517
|
-
* When a buyer cancels their order during the free trial period, the buyer's subscription expires at the end
|
|
2518
|
-
* of the free trial period and they will not be billed. The buyer may continue using the benefits until the end
|
|
2519
|
-
* of the free trial period.
|
|
2520
|
-
*
|
|
2521
|
-
* When a Wix user cancels an ordered plan during the free trial period, they choose whether to apply the cancellation
|
|
2522
|
-
* `IMMEDIATELY` or at the `NEXT_PAYMENT_DATE`. Canceling `IMMEDIATELY` will end the subscription for the buyer
|
|
2523
|
-
* immediately, even during the free trial period and the buyer won't be billed. Canceling at the
|
|
2524
|
-
* `NEXT_PAYMENT_DATE` allows the buyer to continue using the benefits of the subscription until the end of the free trial period.
|
|
2525
|
-
* Then, the subscription ends and the buyer is not billed.
|
|
2526
|
-
* @param _id - Order ID.
|
|
2527
|
-
* @param effectiveAt - __Required.__ When the order will be canceled. One-time orders can only be canceled `IMMEDIATELY`.
|
|
2528
|
-
* @public
|
|
2529
|
-
* @requiredField _id
|
|
2530
|
-
* @requiredField effectiveAt
|
|
2531
|
-
* @param options - Options for canceling orders.
|
|
2532
|
-
* @permissionId PRICING_PLANS.MANAGE_ORDERS
|
|
2533
|
-
* @applicableIdentity APP
|
|
2534
|
-
* @fqn com.wixpress.membership.v2.orders.OrderManagementService.CancelOrder
|
|
2535
|
-
*/
|
|
2536
|
-
declare function cancelOrder(_id: string, effectiveAt: CancellationEffectiveAtWithLiterals): Promise<void>;
|
|
2537
|
-
/**
|
|
2538
|
-
* Marks an offline order as paid.
|
|
2539
|
-
* > __Note__: Marking separate payment cycles as paid is not yet supported. The entire order will be marked as paid. Subsequent offline payments do trigger events and emails, but are not registered as additional offline payments.
|
|
2540
|
-
*
|
|
2541
|
-
* Marking an offline order as paid causes the following changes:
|
|
2542
|
-
* - The order's `lastPaymentStatus` changes to `"PAID"`.
|
|
2543
|
-
* - The order's status changes to either `"PENDING"` or `"ACTIVE"`, depending on the order's `startDate`.
|
|
2544
|
-
*
|
|
2545
|
-
* An error occurs if you attempt to:
|
|
2546
|
-
* - Mark an already-paid, offline order as paid. You cannot mark an offline order as paid twice.
|
|
2547
|
-
* - Mark an online order as paid. The Mark as Paid method is supported for offline orders only.
|
|
2548
|
-
* @param _id - Order ID.
|
|
2549
|
-
* @public
|
|
2550
|
-
* @requiredField _id
|
|
2551
|
-
* @permissionId PRICING_PLANS.MANAGE_ORDERS
|
|
2552
|
-
* @applicableIdentity APP
|
|
2553
|
-
* @fqn com.wixpress.membership.v2.orders.OrderManagementService.MarkAsPaid
|
|
2554
|
-
*/
|
|
2555
|
-
declare function markAsPaid(_id: string): Promise<void>;
|
|
2556
|
-
/**
|
|
2557
|
-
* Pauses an order. Calling this method changes the order status to `"PAUSED"` and updates the `pausePeriods` array.
|
|
2558
|
-
*
|
|
2559
|
-
* Only orders with `status`: `ACTIVE` can be paused.
|
|
2560
|
-
* For orders with recurring payments, it also pauses the payment schedule. Buyers are not charged when an order is paused.
|
|
2561
|
-
* Pausing an order affects the end date of the order by adding the time the order is paused to the `endDate`.
|
|
2562
|
-
* The `endDate` and the `earliestEndDate` for the order are adjusted to include the pause period when the order is resumed.
|
|
2563
|
-
*
|
|
2564
|
-
* To resume a paused order, call Resume Order.
|
|
2565
|
-
* @param _id - Order ID.
|
|
2566
|
-
* @public
|
|
2567
|
-
* @requiredField _id
|
|
2568
|
-
* @permissionId PRICING_PLANS.MANAGE_ORDERS
|
|
2569
|
-
* @applicableIdentity APP
|
|
2570
|
-
* @fqn com.wixpress.membership.v2.orders.OrderManagementService.PauseOrder
|
|
2571
|
-
*/
|
|
2572
|
-
declare function pauseOrder(_id: string): Promise<void>;
|
|
2573
|
-
/**
|
|
2574
|
-
* Resumes a paused order. For orders with recurring payments, it also restarts the payment schedule.
|
|
2575
|
-
*
|
|
2576
|
-
* Resuming an order causes the following changes:
|
|
2577
|
-
* - The order status changes to `"ACTIVE"`.
|
|
2578
|
-
* - The `pausePeriods` array is updated.
|
|
2579
|
-
* - The `endDate` for the order is adjusted to include the pause period.
|
|
2580
|
-
* - For orders with recurring payments, the payment schedule is restarted.
|
|
2581
|
-
* - The `earliestEndDate` is adjusted to include the pause period. (This property is reserved for future use).
|
|
2582
|
-
*
|
|
2583
|
-
* To pause an order, call Pause Order.
|
|
2584
|
-
* @param _id - Order ID.
|
|
2585
|
-
* @public
|
|
2586
|
-
* @requiredField _id
|
|
2587
|
-
* @permissionId PRICING_PLANS.MANAGE_ORDERS
|
|
2588
|
-
* @applicableIdentity APP
|
|
2589
|
-
* @fqn com.wixpress.membership.v2.orders.OrderManagementService.ResumeOrder
|
|
2590
|
-
*/
|
|
2591
|
-
declare function resumeOrder(_id: string): Promise<void>;
|
|
2592
2601
|
|
|
2593
2602
|
export { type AccountInfo, 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 CursorPaging, 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 OrdersQueryOrdersRequest, type OrdersQueryOrdersResponse, type Paging, 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, type QueryOrdersRequest, type QueryOrdersResponse, type QueryV2, type QueryV2PagingMethodOneOf, 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 };
|