@wix/auto_sdk_pricing-plans_orders 1.0.96 → 1.0.98
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 +612 -608
- package/build/cjs/index.typings.js +507 -507
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +461 -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 +612 -608
- package/build/es/index.typings.mjs +507 -507
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +461 -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 +612 -608
- 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 +461 -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 +612 -608
- 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 +461 -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.
|
|
@@ -835,6 +1039,8 @@ interface MessageEnvelope {
|
|
|
835
1039
|
identity?: IdentificationData;
|
|
836
1040
|
/** Stringify payload. */
|
|
837
1041
|
data?: string;
|
|
1042
|
+
/** Details related to the account */
|
|
1043
|
+
accountInfo?: AccountInfo;
|
|
838
1044
|
}
|
|
839
1045
|
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
840
1046
|
/**
|
|
@@ -909,16 +1115,93 @@ interface AccountInfo {
|
|
|
909
1115
|
*/
|
|
910
1116
|
siteId?: string | null;
|
|
911
1117
|
}
|
|
912
|
-
interface
|
|
1118
|
+
interface MemberGetOrderRequest {
|
|
913
1119
|
/**
|
|
914
|
-
*
|
|
1120
|
+
* Order ID.
|
|
915
1121
|
* @format GUID
|
|
916
1122
|
*/
|
|
917
|
-
|
|
1123
|
+
_id: string;
|
|
918
1124
|
/**
|
|
919
|
-
*
|
|
1125
|
+
* Predefined set of fields to return.
|
|
920
1126
|
*
|
|
921
|
-
* Default:
|
|
1127
|
+
* Default: If `fieldSet` is omitted, no order form submission data is returned.
|
|
1128
|
+
*/
|
|
1129
|
+
fieldSet?: SetWithLiterals;
|
|
1130
|
+
}
|
|
1131
|
+
interface MemberGetOrderResponse {
|
|
1132
|
+
/** Requested order. */
|
|
1133
|
+
order?: Order;
|
|
1134
|
+
}
|
|
1135
|
+
interface MemberListOrdersRequest {
|
|
1136
|
+
/**
|
|
1137
|
+
* Filter by plan IDs.
|
|
1138
|
+
* @format GUID
|
|
1139
|
+
*/
|
|
1140
|
+
planIds?: string[];
|
|
1141
|
+
/** Filter for orders where auto renewal was canceled. */
|
|
1142
|
+
autoRenewCanceled?: boolean | null;
|
|
1143
|
+
/** Filter by order status. */
|
|
1144
|
+
orderStatuses?: OrderStatusWithLiterals[];
|
|
1145
|
+
/** Filter by payment status. */
|
|
1146
|
+
paymentStatuses?: PaymentStatusWithLiterals[];
|
|
1147
|
+
/**
|
|
1148
|
+
* Limit the number of pricing plans returned. Default limit is 50.
|
|
1149
|
+
* @min 1
|
|
1150
|
+
* @max 50
|
|
1151
|
+
*/
|
|
1152
|
+
limit?: number | null;
|
|
1153
|
+
/** Number of entries to offset. */
|
|
1154
|
+
offset?: number | null;
|
|
1155
|
+
/** Sorting direction (defaults to ASC) and field to sort by. */
|
|
1156
|
+
sorting?: Sorting;
|
|
1157
|
+
/**
|
|
1158
|
+
* Predefined set of fields to return.
|
|
1159
|
+
*
|
|
1160
|
+
* Default: If `fieldSet` is omitted, no order form submission data is returned.
|
|
1161
|
+
*/
|
|
1162
|
+
fieldSet?: SetWithLiterals;
|
|
1163
|
+
}
|
|
1164
|
+
interface MemberListOrdersResponse {
|
|
1165
|
+
/** Requested orders. */
|
|
1166
|
+
orders?: Order[];
|
|
1167
|
+
/** Object containing paging-related data (number of orders returned, offset). */
|
|
1168
|
+
pagingMetadata?: PagingMetadataV2;
|
|
1169
|
+
}
|
|
1170
|
+
/**
|
|
1171
|
+
* TODO: Write orders filter and sort docs page
|
|
1172
|
+
* Retrieves a list of up to 1,000 orders, based on the provided paging, sorting, and filtering.
|
|
1173
|
+
*/
|
|
1174
|
+
interface QueryOrdersRequest {
|
|
1175
|
+
/** Query filter. */
|
|
1176
|
+
query?: QueryV2;
|
|
1177
|
+
}
|
|
1178
|
+
interface QueryOrdersResponse {
|
|
1179
|
+
/** Order data. */
|
|
1180
|
+
plans?: Order[];
|
|
1181
|
+
/** Paging-related data (number of orders returned, offset). */
|
|
1182
|
+
pagingMetadata?: PagingMetadataV2;
|
|
1183
|
+
}
|
|
1184
|
+
interface RequestCancellationRequest {
|
|
1185
|
+
/**
|
|
1186
|
+
* Order ID.
|
|
1187
|
+
* @format GUID
|
|
1188
|
+
*/
|
|
1189
|
+
_id: string;
|
|
1190
|
+
/** Required. Whether to cancel the order effective immediately or at the next payment date. One-time orders can only be canceled immediately. */
|
|
1191
|
+
effectiveAt: CancellationEffectiveAtWithLiterals;
|
|
1192
|
+
}
|
|
1193
|
+
interface RequestCancellationResponse {
|
|
1194
|
+
}
|
|
1195
|
+
interface CreateOnlineOrderRequest {
|
|
1196
|
+
/**
|
|
1197
|
+
* Plan ID.
|
|
1198
|
+
* @format GUID
|
|
1199
|
+
*/
|
|
1200
|
+
planId: string;
|
|
1201
|
+
/**
|
|
1202
|
+
* Start date and time for the plan of the online order in a `YYYY-MM-DDThh:mm[:ss][.sss]Z` format.
|
|
1203
|
+
*
|
|
1204
|
+
* Default: Current date and time.
|
|
922
1205
|
*/
|
|
923
1206
|
startDate?: Date | null;
|
|
924
1207
|
/**
|
|
@@ -1220,287 +1503,6 @@ interface SetSubmissionResponse {
|
|
|
1220
1503
|
/** Order with submission id */
|
|
1221
1504
|
order?: Order;
|
|
1222
1505
|
}
|
|
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
1506
|
/** @docsIgnore */
|
|
1505
1507
|
type CreateOnlineOrderApplicationErrors = {
|
|
1506
1508
|
code?: 'MEMBER_REQUIRED';
|
|
@@ -1810,6 +1812,8 @@ interface BaseEventMetadata {
|
|
|
1810
1812
|
eventType?: string;
|
|
1811
1813
|
/** The identification type and identity data. */
|
|
1812
1814
|
identity?: IdentificationData;
|
|
1815
|
+
/** Details related to the account */
|
|
1816
|
+
accountInfo?: AccountInfo;
|
|
1813
1817
|
}
|
|
1814
1818
|
interface EventMetadata extends BaseEventMetadata {
|
|
1815
1819
|
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
@@ -1850,6 +1854,31 @@ interface AccountInfoMetadata {
|
|
|
1850
1854
|
/** ID of the parent Wix account. Only included when 'accountId' belongs to a child account. */
|
|
1851
1855
|
parentAccountId?: string;
|
|
1852
1856
|
}
|
|
1857
|
+
interface OrderAutoRenewCanceledEnvelope {
|
|
1858
|
+
data: OrderAutoRenewCanceled;
|
|
1859
|
+
metadata: EventMetadata;
|
|
1860
|
+
}
|
|
1861
|
+
/**
|
|
1862
|
+
* Triggered when an order is canceled and `effectiveAt` is set to `NEXT_PAYMENT_DATE`.
|
|
1863
|
+
*
|
|
1864
|
+
* This webhook is *not* triggered in the following scenarios:
|
|
1865
|
+
* + When an order is canceled and `effectiveAt` is set to `IMMEDIATELY`. Instead, at the time of cancellation, Order Canceled is triggered.
|
|
1866
|
+
* + 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.
|
|
1867
|
+
* @permissionScope Manage Orders
|
|
1868
|
+
* @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
|
|
1869
|
+
* @permissionScope Read Orders
|
|
1870
|
+
* @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS
|
|
1871
|
+
* @permissionScope Manage plans and orders of Pricing Plans
|
|
1872
|
+
* @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-PLANS-AND-ORDERS
|
|
1873
|
+
* @permissionScope Manage Events
|
|
1874
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1875
|
+
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
1876
|
+
* @webhook
|
|
1877
|
+
* @eventType wix.pricing_plans.v2.order_auto_renew_canceled
|
|
1878
|
+
* @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
|
|
1879
|
+
* @slug auto_renew_canceled
|
|
1880
|
+
*/
|
|
1881
|
+
declare function onOrderAutoRenewCanceled(handler: (event: OrderAutoRenewCanceledEnvelope) => void | Promise<void>): void;
|
|
1853
1882
|
interface OrderCanceledEnvelope {
|
|
1854
1883
|
data: OrderCanceled;
|
|
1855
1884
|
metadata: EventMetadata;
|
|
@@ -1871,16 +1900,18 @@ interface OrderCanceledEnvelope {
|
|
|
1871
1900
|
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
1872
1901
|
* @webhook
|
|
1873
1902
|
* @eventType wix.pricing_plans.v2.order_canceled
|
|
1874
|
-
* @serviceIdentifier com.wixpress.membership.v2.orders.
|
|
1903
|
+
* @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
|
|
1875
1904
|
* @slug canceled
|
|
1876
1905
|
*/
|
|
1877
1906
|
declare function onOrderCanceled(handler: (event: OrderCanceledEnvelope) => void | Promise<void>): void;
|
|
1878
|
-
interface
|
|
1879
|
-
|
|
1907
|
+
interface OrderCycleStartedEnvelope {
|
|
1908
|
+
data: OrderCycleStarted;
|
|
1880
1909
|
metadata: EventMetadata;
|
|
1881
1910
|
}
|
|
1882
1911
|
/**
|
|
1883
|
-
* Triggered
|
|
1912
|
+
* Triggered at the start of a new payment cycle for an existing order.
|
|
1913
|
+
*
|
|
1914
|
+
* Not triggered at the initial start of an offline order.
|
|
1884
1915
|
* @permissionScope Manage Orders
|
|
1885
1916
|
* @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
|
|
1886
1917
|
* @permissionScope Read Orders
|
|
@@ -1891,17 +1922,17 @@ interface OrderCreatedEnvelope {
|
|
|
1891
1922
|
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1892
1923
|
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
1893
1924
|
* @webhook
|
|
1894
|
-
* @eventType wix.pricing_plans.v2.
|
|
1895
|
-
* @serviceIdentifier com.wixpress.membership.v2.orders.
|
|
1896
|
-
* @slug
|
|
1925
|
+
* @eventType wix.pricing_plans.v2.order_cycle_started
|
|
1926
|
+
* @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
|
|
1927
|
+
* @slug cycle_started
|
|
1897
1928
|
*/
|
|
1898
|
-
declare function
|
|
1899
|
-
interface
|
|
1900
|
-
data:
|
|
1929
|
+
declare function onOrderCycleStarted(handler: (event: OrderCycleStartedEnvelope) => void | Promise<void>): void;
|
|
1930
|
+
interface OrderEndDatePostponedEnvelope {
|
|
1931
|
+
data: OrderEndDatePostponed;
|
|
1901
1932
|
metadata: EventMetadata;
|
|
1902
1933
|
}
|
|
1903
1934
|
/**
|
|
1904
|
-
* Triggered when an order's `
|
|
1935
|
+
* Triggered when an order's `endDate` is postponed.
|
|
1905
1936
|
* @permissionScope Manage Orders
|
|
1906
1937
|
* @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
|
|
1907
1938
|
* @permissionScope Read Orders
|
|
@@ -1912,25 +1943,21 @@ interface OrderStartDateChangedEnvelope {
|
|
|
1912
1943
|
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1913
1944
|
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
1914
1945
|
* @webhook
|
|
1915
|
-
* @eventType wix.pricing_plans.v2.
|
|
1916
|
-
* @serviceIdentifier com.wixpress.membership.v2.orders.
|
|
1917
|
-
* @slug
|
|
1946
|
+
* @eventType wix.pricing_plans.v2.order_end_date_postponed
|
|
1947
|
+
* @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
|
|
1948
|
+
* @slug end_date_postponed
|
|
1918
1949
|
*/
|
|
1919
|
-
declare function
|
|
1920
|
-
interface
|
|
1921
|
-
|
|
1950
|
+
declare function onOrderEndDatePostponed(handler: (event: OrderEndDatePostponedEnvelope) => void | Promise<void>): void;
|
|
1951
|
+
interface OrderEndedEnvelope {
|
|
1952
|
+
data: OrderEnded;
|
|
1922
1953
|
metadata: EventMetadata;
|
|
1923
1954
|
}
|
|
1924
1955
|
/**
|
|
1925
|
-
* Triggered
|
|
1956
|
+
* Triggered when an order ends.
|
|
1926
1957
|
*
|
|
1927
|
-
*
|
|
1928
|
-
* +
|
|
1929
|
-
* +
|
|
1930
|
-
* + Offline order is marked as paid. Order Marked As Paid is also triggered.
|
|
1931
|
-
* + End date of the order is postponed. Order End Date Postponed is also triggered
|
|
1932
|
-
* + Order is paused, or a paused order is resumed. Order Paused and Order Resumed, respectively, are also triggered.
|
|
1933
|
-
* + Order is canceled, either immediately or at the end of the payment cycle. Order Canceled and Order Auto Renew Canceled, respectively, are also triggered.
|
|
1958
|
+
* This webhook is triggered:
|
|
1959
|
+
* + When an order expires at the end of the current payment cycle.
|
|
1960
|
+
* + When an order is canceled and `effectiveAt` is set to `IMMEDIATELY`.
|
|
1934
1961
|
* @permissionScope Manage Orders
|
|
1935
1962
|
* @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
|
|
1936
1963
|
* @permissionScope Read Orders
|
|
@@ -1941,21 +1968,17 @@ interface OrderUpdatedEnvelope {
|
|
|
1941
1968
|
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1942
1969
|
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
1943
1970
|
* @webhook
|
|
1944
|
-
* @eventType wix.pricing_plans.v2.
|
|
1945
|
-
* @serviceIdentifier com.wixpress.membership.v2.orders.
|
|
1946
|
-
* @slug
|
|
1971
|
+
* @eventType wix.pricing_plans.v2.order_ended
|
|
1972
|
+
* @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
|
|
1973
|
+
* @slug ended
|
|
1947
1974
|
*/
|
|
1948
|
-
declare function
|
|
1949
|
-
interface
|
|
1950
|
-
data:
|
|
1975
|
+
declare function onOrderEnded(handler: (event: OrderEndedEnvelope) => void | Promise<void>): void;
|
|
1976
|
+
interface OrderMarkedAsPaidEnvelope {
|
|
1977
|
+
data: OrderMarkedAsPaid;
|
|
1951
1978
|
metadata: EventMetadata;
|
|
1952
1979
|
}
|
|
1953
1980
|
/**
|
|
1954
|
-
* Triggered when an order is
|
|
1955
|
-
*
|
|
1956
|
-
* This webhook is *not* triggered in the following scenarios:
|
|
1957
|
-
* + When an order is canceled and `effectiveAt` is set to `IMMEDIATELY`. Instead, at the time of cancellation, Order Canceled is triggered.
|
|
1958
|
-
* + 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.
|
|
1981
|
+
* Triggered when an offline order is marked as paid.
|
|
1959
1982
|
* @permissionScope Manage Orders
|
|
1960
1983
|
* @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
|
|
1961
1984
|
* @permissionScope Read Orders
|
|
@@ -1966,19 +1989,17 @@ interface OrderAutoRenewCanceledEnvelope {
|
|
|
1966
1989
|
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1967
1990
|
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
1968
1991
|
* @webhook
|
|
1969
|
-
* @eventType wix.pricing_plans.v2.
|
|
1992
|
+
* @eventType wix.pricing_plans.v2.order_marked_as_paid
|
|
1970
1993
|
* @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
|
|
1971
|
-
* @slug
|
|
1994
|
+
* @slug marked_as_paid
|
|
1972
1995
|
*/
|
|
1973
|
-
declare function
|
|
1974
|
-
interface
|
|
1975
|
-
data:
|
|
1996
|
+
declare function onOrderMarkedAsPaid(handler: (event: OrderMarkedAsPaidEnvelope) => void | Promise<void>): void;
|
|
1997
|
+
interface OrderPausedEnvelope {
|
|
1998
|
+
data: OrderPaused;
|
|
1976
1999
|
metadata: EventMetadata;
|
|
1977
2000
|
}
|
|
1978
2001
|
/**
|
|
1979
|
-
* Triggered
|
|
1980
|
-
*
|
|
1981
|
-
* Not triggered at the initial start of an offline order.
|
|
2002
|
+
* Triggered when an order is paused.
|
|
1982
2003
|
* @permissionScope Manage Orders
|
|
1983
2004
|
* @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
|
|
1984
2005
|
* @permissionScope Read Orders
|
|
@@ -1989,17 +2010,21 @@ interface OrderCycleStartedEnvelope {
|
|
|
1989
2010
|
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1990
2011
|
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
1991
2012
|
* @webhook
|
|
1992
|
-
* @eventType wix.pricing_plans.v2.
|
|
2013
|
+
* @eventType wix.pricing_plans.v2.order_paused
|
|
1993
2014
|
* @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
|
|
1994
|
-
* @slug
|
|
2015
|
+
* @slug paused
|
|
1995
2016
|
*/
|
|
1996
|
-
declare function
|
|
1997
|
-
interface
|
|
1998
|
-
data:
|
|
2017
|
+
declare function onOrderPaused(handler: (event: OrderPausedEnvelope) => void | Promise<void>): void;
|
|
2018
|
+
interface OrderPurchasedEnvelope {
|
|
2019
|
+
data: OrderPurchased;
|
|
1999
2020
|
metadata: EventMetadata;
|
|
2000
2021
|
}
|
|
2001
2022
|
/**
|
|
2002
|
-
* Triggered
|
|
2023
|
+
* Triggered for any of the following purchase events:
|
|
2024
|
+
* + Order is paid in full.
|
|
2025
|
+
* + At least 1 order cycle payment is paid for.
|
|
2026
|
+
* + Offline order is created, even if not yet marked as paid.
|
|
2027
|
+
* + Free order is created.
|
|
2003
2028
|
* @permissionScope Manage Orders
|
|
2004
2029
|
* @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
|
|
2005
2030
|
* @permissionScope Read Orders
|
|
@@ -2010,21 +2035,17 @@ interface OrderEndDatePostponedEnvelope {
|
|
|
2010
2035
|
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
2011
2036
|
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
2012
2037
|
* @webhook
|
|
2013
|
-
* @eventType wix.pricing_plans.v2.
|
|
2038
|
+
* @eventType wix.pricing_plans.v2.order_purchased
|
|
2014
2039
|
* @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
|
|
2015
|
-
* @slug
|
|
2040
|
+
* @slug purchased
|
|
2016
2041
|
*/
|
|
2017
|
-
declare function
|
|
2018
|
-
interface
|
|
2019
|
-
data:
|
|
2042
|
+
declare function onOrderPurchased(handler: (event: OrderPurchasedEnvelope) => void | Promise<void>): void;
|
|
2043
|
+
interface OrderResumedEnvelope {
|
|
2044
|
+
data: OrderResumed;
|
|
2020
2045
|
metadata: EventMetadata;
|
|
2021
2046
|
}
|
|
2022
2047
|
/**
|
|
2023
|
-
* Triggered when
|
|
2024
|
-
*
|
|
2025
|
-
* This webhook is triggered:
|
|
2026
|
-
* + When an order expires at the end of the current payment cycle.
|
|
2027
|
-
* + When an order is canceled and `effectiveAt` is set to `IMMEDIATELY`.
|
|
2048
|
+
* Triggered when a paused order is resumed.
|
|
2028
2049
|
* @permissionScope Manage Orders
|
|
2029
2050
|
* @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
|
|
2030
2051
|
* @permissionScope Read Orders
|
|
@@ -2035,17 +2056,17 @@ interface OrderEndedEnvelope {
|
|
|
2035
2056
|
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
2036
2057
|
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
2037
2058
|
* @webhook
|
|
2038
|
-
* @eventType wix.pricing_plans.v2.
|
|
2059
|
+
* @eventType wix.pricing_plans.v2.order_resumed
|
|
2039
2060
|
* @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
|
|
2040
|
-
* @slug
|
|
2061
|
+
* @slug resumed
|
|
2041
2062
|
*/
|
|
2042
|
-
declare function
|
|
2043
|
-
interface
|
|
2044
|
-
data:
|
|
2063
|
+
declare function onOrderResumed(handler: (event: OrderResumedEnvelope) => void | Promise<void>): void;
|
|
2064
|
+
interface OrderStartedEnvelope {
|
|
2065
|
+
data: OrderStarted;
|
|
2045
2066
|
metadata: EventMetadata;
|
|
2046
2067
|
}
|
|
2047
2068
|
/**
|
|
2048
|
-
* Triggered when an
|
|
2069
|
+
* Triggered when an order reaches its `startDate`. Applies to both purchased and free orders.
|
|
2049
2070
|
* @permissionScope Manage Orders
|
|
2050
2071
|
* @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
|
|
2051
2072
|
* @permissionScope Read Orders
|
|
@@ -2056,17 +2077,25 @@ interface OrderMarkedAsPaidEnvelope {
|
|
|
2056
2077
|
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
2057
2078
|
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
2058
2079
|
* @webhook
|
|
2059
|
-
* @eventType wix.pricing_plans.v2.
|
|
2080
|
+
* @eventType wix.pricing_plans.v2.order_started
|
|
2060
2081
|
* @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
|
|
2061
|
-
* @slug
|
|
2082
|
+
* @slug started
|
|
2062
2083
|
*/
|
|
2063
|
-
declare function
|
|
2064
|
-
interface
|
|
2065
|
-
|
|
2084
|
+
declare function onOrderStarted(handler: (event: OrderStartedEnvelope) => void | Promise<void>): void;
|
|
2085
|
+
interface OrderUpdatedEnvelope {
|
|
2086
|
+
entity: Order;
|
|
2066
2087
|
metadata: EventMetadata;
|
|
2067
2088
|
}
|
|
2068
2089
|
/**
|
|
2069
|
-
* Triggered
|
|
2090
|
+
* Triggered for any of the following update events:
|
|
2091
|
+
*
|
|
2092
|
+
* + Order is paid for. Order Purchased is also triggered.
|
|
2093
|
+
* + Order reaches its start date or end date. Order Started and Order Ended, respectively, are also triggered.
|
|
2094
|
+
* + New payment cycle of an order starts. Order Cycle Started is also triggered.
|
|
2095
|
+
* + Offline order is marked as paid. Order Marked As Paid is also triggered.
|
|
2096
|
+
* + End date of the order is postponed. Order End Date Postponed is also triggered
|
|
2097
|
+
* + Order is paused, or a paused order is resumed. Order Paused and Order Resumed, respectively, are also triggered.
|
|
2098
|
+
* + Order is canceled, either immediately or at the end of the payment cycle. Order Canceled and Order Auto Renew Canceled, respectively, are also triggered.
|
|
2070
2099
|
* @permissionScope Manage Orders
|
|
2071
2100
|
* @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
|
|
2072
2101
|
* @permissionScope Read Orders
|
|
@@ -2077,21 +2106,17 @@ interface OrderPausedEnvelope {
|
|
|
2077
2106
|
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
2078
2107
|
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
2079
2108
|
* @webhook
|
|
2080
|
-
* @eventType wix.pricing_plans.v2.
|
|
2109
|
+
* @eventType wix.pricing_plans.v2.order_updated
|
|
2081
2110
|
* @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
|
|
2082
|
-
* @slug
|
|
2111
|
+
* @slug updated
|
|
2083
2112
|
*/
|
|
2084
|
-
declare function
|
|
2085
|
-
interface
|
|
2086
|
-
|
|
2113
|
+
declare function onOrderUpdated(handler: (event: OrderUpdatedEnvelope) => void | Promise<void>): void;
|
|
2114
|
+
interface OrderCreatedEnvelope {
|
|
2115
|
+
entity: Order;
|
|
2087
2116
|
metadata: EventMetadata;
|
|
2088
2117
|
}
|
|
2089
2118
|
/**
|
|
2090
|
-
* Triggered
|
|
2091
|
-
* + Order is paid in full.
|
|
2092
|
-
* + At least 1 order cycle payment is paid for.
|
|
2093
|
-
* + Offline order is created, even if not yet marked as paid.
|
|
2094
|
-
* + Free order is created.
|
|
2119
|
+
* Triggered when an order is created.
|
|
2095
2120
|
* @permissionScope Manage Orders
|
|
2096
2121
|
* @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
|
|
2097
2122
|
* @permissionScope Read Orders
|
|
@@ -2102,53 +2127,206 @@ interface OrderPurchasedEnvelope {
|
|
|
2102
2127
|
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
2103
2128
|
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
2104
2129
|
* @webhook
|
|
2105
|
-
* @eventType wix.pricing_plans.v2.
|
|
2106
|
-
* @serviceIdentifier com.wixpress.membership.v2.orders.
|
|
2107
|
-
* @slug
|
|
2130
|
+
* @eventType wix.pricing_plans.v2.order_created
|
|
2131
|
+
* @serviceIdentifier com.wixpress.membership.v2.orders.CheckoutService
|
|
2132
|
+
* @slug created
|
|
2133
|
+
*/
|
|
2134
|
+
declare function onOrderCreated(handler: (event: OrderCreatedEnvelope) => void | Promise<void>): void;
|
|
2135
|
+
interface OrderStartDateChangedEnvelope {
|
|
2136
|
+
data: OrderStartDateChanged;
|
|
2137
|
+
metadata: EventMetadata;
|
|
2138
|
+
}
|
|
2139
|
+
/**
|
|
2140
|
+
* Triggered when an order's `startDate` is changed.
|
|
2141
|
+
* @permissionScope Manage Orders
|
|
2142
|
+
* @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
|
|
2143
|
+
* @permissionScope Read Orders
|
|
2144
|
+
* @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS
|
|
2145
|
+
* @permissionScope Manage plans and orders of Pricing Plans
|
|
2146
|
+
* @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-PLANS-AND-ORDERS
|
|
2147
|
+
* @permissionScope Manage Events
|
|
2148
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
2149
|
+
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
2150
|
+
* @webhook
|
|
2151
|
+
* @eventType wix.pricing_plans.v2.order_start_date_changed
|
|
2152
|
+
* @serviceIdentifier com.wixpress.membership.v2.orders.CheckoutService
|
|
2153
|
+
* @slug start_date_changed
|
|
2154
|
+
*/
|
|
2155
|
+
declare function onOrderStartDateChanged(handler: (event: OrderStartDateChangedEnvelope) => void | Promise<void>): void;
|
|
2156
|
+
/**
|
|
2157
|
+
* Retrieves an order by ID.
|
|
2158
|
+
* @param _id - Order ID.
|
|
2159
|
+
* @public
|
|
2160
|
+
* @requiredField _id
|
|
2161
|
+
* @param options - Options to use when getting an order.
|
|
2162
|
+
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
2163
|
+
* @applicableIdentity APP
|
|
2164
|
+
* @fqn com.wixpress.membership.v2.orders.OrderManagementService.GetOrder
|
|
2165
|
+
*/
|
|
2166
|
+
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>>;
|
|
2167
|
+
interface ManagementGetOrderOptions {
|
|
2168
|
+
/**
|
|
2169
|
+
* Predefined set of fields to return.
|
|
2170
|
+
*
|
|
2171
|
+
* Default: If `fieldSet` is omitted, no order form submission data is returned.
|
|
2172
|
+
*/
|
|
2173
|
+
fieldSet?: SetWithLiterals;
|
|
2174
|
+
}
|
|
2175
|
+
/**
|
|
2176
|
+
* Retrieves a list of up to 50 pricing plan orders and details, given the specified sorting and filtering.
|
|
2177
|
+
*
|
|
2178
|
+
* By default, this endpoint will retrieve all orders and return them sorted by `createdDate` in `DESC`, descending order.
|
|
2179
|
+
* `sort.fieldName` supports `endDate` and `createdDate` fields and defaults to `ASC`, ascending order.
|
|
2180
|
+
* @public
|
|
2181
|
+
* @param options - Filtering, sorting, and pagination options.
|
|
2182
|
+
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
2183
|
+
* @applicableIdentity APP
|
|
2184
|
+
* @fqn com.wixpress.membership.v2.orders.OrderManagementService.ListOrders
|
|
2185
|
+
*/
|
|
2186
|
+
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>>;
|
|
2187
|
+
interface ManagementListOrdersOptions {
|
|
2188
|
+
/**
|
|
2189
|
+
* Filter by a buyer's member ID, from the Members API.
|
|
2190
|
+
* @format GUID
|
|
2191
|
+
*/
|
|
2192
|
+
buyerIds?: string[];
|
|
2193
|
+
/**
|
|
2194
|
+
* Filter by plan IDs, from the Plans API.
|
|
2195
|
+
* @format GUID
|
|
2196
|
+
*/
|
|
2197
|
+
planIds?: string[];
|
|
2198
|
+
/** Filter by whether or not the auto-renewal of recurring orders was canceled. */
|
|
2199
|
+
autoRenewCanceled?: boolean | null;
|
|
2200
|
+
/** Filter by order status. */
|
|
2201
|
+
orderStatuses?: OrderStatusWithLiterals[];
|
|
2202
|
+
/** Filter by payment status. */
|
|
2203
|
+
paymentStatuses?: PaymentStatusWithLiterals[];
|
|
2204
|
+
/**
|
|
2205
|
+
* Number of orders to return. See Sorting and Paging for more information.
|
|
2206
|
+
*
|
|
2207
|
+
* Max: `50`
|
|
2208
|
+
* @min 1
|
|
2209
|
+
* @max 50
|
|
2210
|
+
*/
|
|
2211
|
+
limit?: number | null;
|
|
2212
|
+
/** Number of orders to skip in the current sort order. */
|
|
2213
|
+
offset?: number | null;
|
|
2214
|
+
/**
|
|
2215
|
+
* Sort order.
|
|
2216
|
+
*
|
|
2217
|
+
* Use `ASC` for ascending order or `DESC` for descending order.
|
|
2218
|
+
*
|
|
2219
|
+
* Default: `DESC`.
|
|
2220
|
+
*/
|
|
2221
|
+
sorting?: Sorting;
|
|
2222
|
+
/**
|
|
2223
|
+
* Predefined set of fields to return.
|
|
2224
|
+
*
|
|
2225
|
+
* Default: If `fieldSet` is omitted, no order form submission data is returned.
|
|
2226
|
+
*/
|
|
2227
|
+
fieldSet?: SetWithLiterals;
|
|
2228
|
+
}
|
|
2229
|
+
/**
|
|
2230
|
+
* 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.
|
|
2231
|
+
*
|
|
2232
|
+
* New `endDate` must be later than the order's current `endDate`. Can't postpone orders that are unlimited.
|
|
2233
|
+
* Can't postpone an order with `status`: `PAUSED`.
|
|
2234
|
+
* @param _id - Order ID.
|
|
2235
|
+
* @param endDate - New end date and time.
|
|
2236
|
+
*
|
|
2237
|
+
* Must be later than the current end date and time.
|
|
2238
|
+
* @public
|
|
2239
|
+
* @requiredField _id
|
|
2240
|
+
* @requiredField endDate
|
|
2241
|
+
* @param options - Options for postponing the end date of an order.
|
|
2242
|
+
* @permissionId PRICING_PLANS.MANAGE_ORDERS
|
|
2243
|
+
* @applicableIdentity APP
|
|
2244
|
+
* @fqn com.wixpress.membership.v2.orders.OrderManagementService.PostponeEndDate
|
|
2245
|
+
*/
|
|
2246
|
+
declare function postponeEndDate(_id: string, endDate: Date): Promise<void>;
|
|
2247
|
+
/**
|
|
2248
|
+
* Cancels an existing order.
|
|
2249
|
+
*
|
|
2250
|
+
* For orders with recurring payments, a cancellation can be set to occur either `IMMEDIATELY` or at the `NEXT_PAYMENT_DATE`.
|
|
2251
|
+
* For orders with one-time payments, a cancellation can only be set for `IMMEDIATELY`.
|
|
2252
|
+
*
|
|
2253
|
+
* #### Canceling during the free trial period.
|
|
2254
|
+
*
|
|
2255
|
+
* When a buyer cancels their order during the free trial period, the buyer's subscription expires at the end
|
|
2256
|
+
* of the free trial period and they will not be billed. The buyer may continue using the benefits until the end
|
|
2257
|
+
* of the free trial period.
|
|
2258
|
+
*
|
|
2259
|
+
* When a Wix user cancels an ordered plan during the free trial period, they choose whether to apply the cancellation
|
|
2260
|
+
* `IMMEDIATELY` or at the `NEXT_PAYMENT_DATE`. Canceling `IMMEDIATELY` will end the subscription for the buyer
|
|
2261
|
+
* immediately, even during the free trial period and the buyer won't be billed. Canceling at the
|
|
2262
|
+
* `NEXT_PAYMENT_DATE` allows the buyer to continue using the benefits of the subscription until the end of the free trial period.
|
|
2263
|
+
* Then, the subscription ends and the buyer is not billed.
|
|
2264
|
+
* @param _id - Order ID.
|
|
2265
|
+
* @param effectiveAt - __Required.__ When the order will be canceled. One-time orders can only be canceled `IMMEDIATELY`.
|
|
2266
|
+
* @public
|
|
2267
|
+
* @requiredField _id
|
|
2268
|
+
* @requiredField effectiveAt
|
|
2269
|
+
* @param options - Options for canceling orders.
|
|
2270
|
+
* @permissionId PRICING_PLANS.MANAGE_ORDERS
|
|
2271
|
+
* @applicableIdentity APP
|
|
2272
|
+
* @fqn com.wixpress.membership.v2.orders.OrderManagementService.CancelOrder
|
|
2273
|
+
*/
|
|
2274
|
+
declare function cancelOrder(_id: string, effectiveAt: CancellationEffectiveAtWithLiterals): Promise<void>;
|
|
2275
|
+
/**
|
|
2276
|
+
* Marks an offline order as paid.
|
|
2277
|
+
* > __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.
|
|
2278
|
+
*
|
|
2279
|
+
* Marking an offline order as paid causes the following changes:
|
|
2280
|
+
* - The order's `lastPaymentStatus` changes to `"PAID"`.
|
|
2281
|
+
* - The order's status changes to either `"PENDING"` or `"ACTIVE"`, depending on the order's `startDate`.
|
|
2282
|
+
*
|
|
2283
|
+
* An error occurs if you attempt to:
|
|
2284
|
+
* - Mark an already-paid, offline order as paid. You cannot mark an offline order as paid twice.
|
|
2285
|
+
* - Mark an online order as paid. The Mark as Paid method is supported for offline orders only.
|
|
2286
|
+
* @param _id - Order ID.
|
|
2287
|
+
* @public
|
|
2288
|
+
* @requiredField _id
|
|
2289
|
+
* @permissionId PRICING_PLANS.MANAGE_ORDERS
|
|
2290
|
+
* @applicableIdentity APP
|
|
2291
|
+
* @fqn com.wixpress.membership.v2.orders.OrderManagementService.MarkAsPaid
|
|
2108
2292
|
*/
|
|
2109
|
-
declare function
|
|
2110
|
-
interface OrderResumedEnvelope {
|
|
2111
|
-
data: OrderResumed;
|
|
2112
|
-
metadata: EventMetadata;
|
|
2113
|
-
}
|
|
2293
|
+
declare function markAsPaid(_id: string): Promise<void>;
|
|
2114
2294
|
/**
|
|
2115
|
-
*
|
|
2116
|
-
*
|
|
2117
|
-
*
|
|
2118
|
-
*
|
|
2119
|
-
*
|
|
2120
|
-
*
|
|
2121
|
-
*
|
|
2122
|
-
*
|
|
2123
|
-
* @
|
|
2124
|
-
* @
|
|
2125
|
-
* @
|
|
2126
|
-
* @
|
|
2127
|
-
* @
|
|
2128
|
-
* @
|
|
2295
|
+
* Pauses an order. Calling this method changes the order status to `"PAUSED"` and updates the `pausePeriods` array.
|
|
2296
|
+
*
|
|
2297
|
+
* Only orders with `status`: `ACTIVE` can be paused.
|
|
2298
|
+
* For orders with recurring payments, it also pauses the payment schedule. Buyers are not charged when an order is paused.
|
|
2299
|
+
* Pausing an order affects the end date of the order by adding the time the order is paused to the `endDate`.
|
|
2300
|
+
* The `endDate` and the `earliestEndDate` for the order are adjusted to include the pause period when the order is resumed.
|
|
2301
|
+
*
|
|
2302
|
+
* To resume a paused order, call Resume Order.
|
|
2303
|
+
* @param _id - Order ID.
|
|
2304
|
+
* @public
|
|
2305
|
+
* @requiredField _id
|
|
2306
|
+
* @permissionId PRICING_PLANS.MANAGE_ORDERS
|
|
2307
|
+
* @applicableIdentity APP
|
|
2308
|
+
* @fqn com.wixpress.membership.v2.orders.OrderManagementService.PauseOrder
|
|
2129
2309
|
*/
|
|
2130
|
-
declare function
|
|
2131
|
-
interface OrderStartedEnvelope {
|
|
2132
|
-
data: OrderStarted;
|
|
2133
|
-
metadata: EventMetadata;
|
|
2134
|
-
}
|
|
2310
|
+
declare function pauseOrder(_id: string): Promise<void>;
|
|
2135
2311
|
/**
|
|
2136
|
-
*
|
|
2137
|
-
*
|
|
2138
|
-
*
|
|
2139
|
-
*
|
|
2140
|
-
*
|
|
2141
|
-
*
|
|
2142
|
-
*
|
|
2143
|
-
*
|
|
2144
|
-
*
|
|
2145
|
-
*
|
|
2146
|
-
* @
|
|
2147
|
-
* @
|
|
2148
|
-
* @
|
|
2149
|
-
* @
|
|
2312
|
+
* Resumes a paused order. For orders with recurring payments, it also restarts the payment schedule.
|
|
2313
|
+
*
|
|
2314
|
+
* Resuming an order causes the following changes:
|
|
2315
|
+
* - The order status changes to `"ACTIVE"`.
|
|
2316
|
+
* - The `pausePeriods` array is updated.
|
|
2317
|
+
* - The `endDate` for the order is adjusted to include the pause period.
|
|
2318
|
+
* - For orders with recurring payments, the payment schedule is restarted.
|
|
2319
|
+
* - The `earliestEndDate` is adjusted to include the pause period. (This property is reserved for future use).
|
|
2320
|
+
*
|
|
2321
|
+
* To pause an order, call Pause Order.
|
|
2322
|
+
* @param _id - Order ID.
|
|
2323
|
+
* @public
|
|
2324
|
+
* @requiredField _id
|
|
2325
|
+
* @permissionId PRICING_PLANS.MANAGE_ORDERS
|
|
2326
|
+
* @applicableIdentity APP
|
|
2327
|
+
* @fqn com.wixpress.membership.v2.orders.OrderManagementService.ResumeOrder
|
|
2150
2328
|
*/
|
|
2151
|
-
declare function
|
|
2329
|
+
declare function resumeOrder(_id: string): Promise<void>;
|
|
2152
2330
|
/**
|
|
2153
2331
|
* Retrieves an order for the currently logged-in member by ID.
|
|
2154
2332
|
* @param _id - Order ID.
|
|
@@ -2158,9 +2336,10 @@ declare function onOrderStarted(handler: (event: OrderStartedEnvelope) => void |
|
|
|
2158
2336
|
* @permissionId PRICING_PLANS.READ_OWN_ORDERS
|
|
2159
2337
|
* @applicableIdentity APP
|
|
2160
2338
|
* @applicableIdentity MEMBER
|
|
2339
|
+
* @returns Requested order.
|
|
2161
2340
|
* @fqn com.wixpress.membership.v2.orders.member.MemberOrdersService.GetOrder
|
|
2162
2341
|
*/
|
|
2163
|
-
declare function memberGetOrder(_id: string, options?: MemberGetOrderOptions): Promise<NonNullablePaths<
|
|
2342
|
+
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>>;
|
|
2164
2343
|
interface MemberGetOrderOptions {
|
|
2165
2344
|
/**
|
|
2166
2345
|
* Predefined set of fields to return.
|
|
@@ -2423,180 +2602,5 @@ interface GetPricePreviewOptions {
|
|
|
2423
2602
|
*/
|
|
2424
2603
|
couponCode?: string | null;
|
|
2425
2604
|
}
|
|
2426
|
-
/**
|
|
2427
|
-
* Retrieves an order by ID.
|
|
2428
|
-
* @param _id - Order ID.
|
|
2429
|
-
* @public
|
|
2430
|
-
* @requiredField _id
|
|
2431
|
-
* @param options - Options to use when getting an order.
|
|
2432
|
-
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
2433
|
-
* @applicableIdentity APP
|
|
2434
|
-
* @returns Order.
|
|
2435
|
-
* @fqn com.wixpress.membership.v2.orders.OrderManagementService.GetOrder
|
|
2436
|
-
*/
|
|
2437
|
-
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>>;
|
|
2438
|
-
interface ManagementGetOrderOptions {
|
|
2439
|
-
/**
|
|
2440
|
-
* Predefined set of fields to return.
|
|
2441
|
-
*
|
|
2442
|
-
* Default: If `fieldSet` is omitted, no order form submission data is returned.
|
|
2443
|
-
*/
|
|
2444
|
-
fieldSet?: SetWithLiterals;
|
|
2445
|
-
}
|
|
2446
|
-
/**
|
|
2447
|
-
* Retrieves a list of up to 50 pricing plan orders and details, given the specified sorting and filtering.
|
|
2448
|
-
*
|
|
2449
|
-
* By default, this endpoint will retrieve all orders and return them sorted by `createdDate` in `DESC`, descending order.
|
|
2450
|
-
* `sort.fieldName` supports `endDate` and `createdDate` fields and defaults to `ASC`, ascending order.
|
|
2451
|
-
* @public
|
|
2452
|
-
* @param options - Filtering, sorting, and pagination options.
|
|
2453
|
-
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
2454
|
-
* @applicableIdentity APP
|
|
2455
|
-
* @fqn com.wixpress.membership.v2.orders.OrderManagementService.ListOrders
|
|
2456
|
-
*/
|
|
2457
|
-
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>>;
|
|
2458
|
-
interface ManagementListOrdersOptions {
|
|
2459
|
-
/**
|
|
2460
|
-
* Filter by a buyer's member ID, from the Members API.
|
|
2461
|
-
* @format GUID
|
|
2462
|
-
*/
|
|
2463
|
-
buyerIds?: string[];
|
|
2464
|
-
/**
|
|
2465
|
-
* Filter by plan IDs, from the Plans API.
|
|
2466
|
-
* @format GUID
|
|
2467
|
-
*/
|
|
2468
|
-
planIds?: string[];
|
|
2469
|
-
/** Filter by whether or not the auto-renewal of recurring orders was canceled. */
|
|
2470
|
-
autoRenewCanceled?: boolean | null;
|
|
2471
|
-
/** Filter by order status. */
|
|
2472
|
-
orderStatuses?: OrderStatusWithLiterals[];
|
|
2473
|
-
/** Filter by payment status. */
|
|
2474
|
-
paymentStatuses?: PaymentStatusWithLiterals[];
|
|
2475
|
-
/**
|
|
2476
|
-
* Number of orders to return. See Sorting and Paging for more information.
|
|
2477
|
-
*
|
|
2478
|
-
* Max: `50`
|
|
2479
|
-
* @min 1
|
|
2480
|
-
* @max 50
|
|
2481
|
-
*/
|
|
2482
|
-
limit?: number | null;
|
|
2483
|
-
/** Number of orders to skip in the current sort order. */
|
|
2484
|
-
offset?: number | null;
|
|
2485
|
-
/**
|
|
2486
|
-
* Sort order.
|
|
2487
|
-
*
|
|
2488
|
-
* Use `ASC` for ascending order or `DESC` for descending order.
|
|
2489
|
-
*
|
|
2490
|
-
* Default: `DESC`.
|
|
2491
|
-
*/
|
|
2492
|
-
sorting?: Sorting;
|
|
2493
|
-
/**
|
|
2494
|
-
* Predefined set of fields to return.
|
|
2495
|
-
*
|
|
2496
|
-
* Default: If `fieldSet` is omitted, no order form submission data is returned.
|
|
2497
|
-
*/
|
|
2498
|
-
fieldSet?: SetWithLiterals;
|
|
2499
|
-
}
|
|
2500
|
-
/**
|
|
2501
|
-
* 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.
|
|
2502
|
-
*
|
|
2503
|
-
* New `endDate` must be later than the order's current `endDate`. Can't postpone orders that are unlimited.
|
|
2504
|
-
* Can't postpone an order with `status`: `PAUSED`.
|
|
2505
|
-
* @param _id - Order ID.
|
|
2506
|
-
* @param endDate - New end date and time.
|
|
2507
|
-
*
|
|
2508
|
-
* Must be later than the current end date and time.
|
|
2509
|
-
* @public
|
|
2510
|
-
* @requiredField _id
|
|
2511
|
-
* @requiredField endDate
|
|
2512
|
-
* @param options - Options for postponing the end date of an order.
|
|
2513
|
-
* @permissionId PRICING_PLANS.MANAGE_ORDERS
|
|
2514
|
-
* @applicableIdentity APP
|
|
2515
|
-
* @fqn com.wixpress.membership.v2.orders.OrderManagementService.PostponeEndDate
|
|
2516
|
-
*/
|
|
2517
|
-
declare function postponeEndDate(_id: string, endDate: Date): Promise<void>;
|
|
2518
|
-
/**
|
|
2519
|
-
* Cancels an existing order.
|
|
2520
|
-
*
|
|
2521
|
-
* For orders with recurring payments, a cancellation can be set to occur either `IMMEDIATELY` or at the `NEXT_PAYMENT_DATE`.
|
|
2522
|
-
* For orders with one-time payments, a cancellation can only be set for `IMMEDIATELY`.
|
|
2523
|
-
*
|
|
2524
|
-
* #### Canceling during the free trial period.
|
|
2525
|
-
*
|
|
2526
|
-
* When a buyer cancels their order during the free trial period, the buyer's subscription expires at the end
|
|
2527
|
-
* of the free trial period and they will not be billed. The buyer may continue using the benefits until the end
|
|
2528
|
-
* of the free trial period.
|
|
2529
|
-
*
|
|
2530
|
-
* When a Wix user cancels an ordered plan during the free trial period, they choose whether to apply the cancellation
|
|
2531
|
-
* `IMMEDIATELY` or at the `NEXT_PAYMENT_DATE`. Canceling `IMMEDIATELY` will end the subscription for the buyer
|
|
2532
|
-
* immediately, even during the free trial period and the buyer won't be billed. Canceling at the
|
|
2533
|
-
* `NEXT_PAYMENT_DATE` allows the buyer to continue using the benefits of the subscription until the end of the free trial period.
|
|
2534
|
-
* Then, the subscription ends and the buyer is not billed.
|
|
2535
|
-
* @param _id - Order ID.
|
|
2536
|
-
* @param effectiveAt - __Required.__ When the order will be canceled. One-time orders can only be canceled `IMMEDIATELY`.
|
|
2537
|
-
* @public
|
|
2538
|
-
* @requiredField _id
|
|
2539
|
-
* @requiredField effectiveAt
|
|
2540
|
-
* @param options - Options for canceling orders.
|
|
2541
|
-
* @permissionId PRICING_PLANS.MANAGE_ORDERS
|
|
2542
|
-
* @applicableIdentity APP
|
|
2543
|
-
* @fqn com.wixpress.membership.v2.orders.OrderManagementService.CancelOrder
|
|
2544
|
-
*/
|
|
2545
|
-
declare function cancelOrder(_id: string, effectiveAt: CancellationEffectiveAtWithLiterals): Promise<void>;
|
|
2546
|
-
/**
|
|
2547
|
-
* Marks an offline order as paid.
|
|
2548
|
-
* > __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.
|
|
2549
|
-
*
|
|
2550
|
-
* Marking an offline order as paid causes the following changes:
|
|
2551
|
-
* - The order's `lastPaymentStatus` changes to `"PAID"`.
|
|
2552
|
-
* - The order's status changes to either `"PENDING"` or `"ACTIVE"`, depending on the order's `startDate`.
|
|
2553
|
-
*
|
|
2554
|
-
* An error occurs if you attempt to:
|
|
2555
|
-
* - Mark an already-paid, offline order as paid. You cannot mark an offline order as paid twice.
|
|
2556
|
-
* - Mark an online order as paid. The Mark as Paid method is supported for offline orders only.
|
|
2557
|
-
* @param _id - Order ID.
|
|
2558
|
-
* @public
|
|
2559
|
-
* @requiredField _id
|
|
2560
|
-
* @permissionId PRICING_PLANS.MANAGE_ORDERS
|
|
2561
|
-
* @applicableIdentity APP
|
|
2562
|
-
* @fqn com.wixpress.membership.v2.orders.OrderManagementService.MarkAsPaid
|
|
2563
|
-
*/
|
|
2564
|
-
declare function markAsPaid(_id: string): Promise<void>;
|
|
2565
|
-
/**
|
|
2566
|
-
* Pauses an order. Calling this method changes the order status to `"PAUSED"` and updates the `pausePeriods` array.
|
|
2567
|
-
*
|
|
2568
|
-
* Only orders with `status`: `ACTIVE` can be paused.
|
|
2569
|
-
* For orders with recurring payments, it also pauses the payment schedule. Buyers are not charged when an order is paused.
|
|
2570
|
-
* Pausing an order affects the end date of the order by adding the time the order is paused to the `endDate`.
|
|
2571
|
-
* The `endDate` and the `earliestEndDate` for the order are adjusted to include the pause period when the order is resumed.
|
|
2572
|
-
*
|
|
2573
|
-
* To resume a paused order, call Resume Order.
|
|
2574
|
-
* @param _id - Order ID.
|
|
2575
|
-
* @public
|
|
2576
|
-
* @requiredField _id
|
|
2577
|
-
* @permissionId PRICING_PLANS.MANAGE_ORDERS
|
|
2578
|
-
* @applicableIdentity APP
|
|
2579
|
-
* @fqn com.wixpress.membership.v2.orders.OrderManagementService.PauseOrder
|
|
2580
|
-
*/
|
|
2581
|
-
declare function pauseOrder(_id: string): Promise<void>;
|
|
2582
|
-
/**
|
|
2583
|
-
* Resumes a paused order. For orders with recurring payments, it also restarts the payment schedule.
|
|
2584
|
-
*
|
|
2585
|
-
* Resuming an order causes the following changes:
|
|
2586
|
-
* - The order status changes to `"ACTIVE"`.
|
|
2587
|
-
* - The `pausePeriods` array is updated.
|
|
2588
|
-
* - The `endDate` for the order is adjusted to include the pause period.
|
|
2589
|
-
* - For orders with recurring payments, the payment schedule is restarted.
|
|
2590
|
-
* - The `earliestEndDate` is adjusted to include the pause period. (This property is reserved for future use).
|
|
2591
|
-
*
|
|
2592
|
-
* To pause an order, call Pause Order.
|
|
2593
|
-
* @param _id - Order ID.
|
|
2594
|
-
* @public
|
|
2595
|
-
* @requiredField _id
|
|
2596
|
-
* @permissionId PRICING_PLANS.MANAGE_ORDERS
|
|
2597
|
-
* @applicableIdentity APP
|
|
2598
|
-
* @fqn com.wixpress.membership.v2.orders.OrderManagementService.ResumeOrder
|
|
2599
|
-
*/
|
|
2600
|
-
declare function resumeOrder(_id: string): Promise<void>;
|
|
2601
2605
|
|
|
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 };
|
|
2606
|
+
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 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 };
|