@wix/auto_sdk_pricing-plans_orders 1.0.111 → 1.0.113
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 +155 -155
- package/build/cjs/index.js +466 -466
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +489 -489
- package/build/cjs/index.typings.js +339 -339
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +259 -259
- package/build/cjs/meta.js +344 -344
- package/build/cjs/meta.js.map +1 -1
- package/build/cjs/schemas.d.ts +30 -30
- package/build/cjs/schemas.js +59 -59
- package/build/cjs/schemas.js.map +1 -1
- package/build/es/index.d.mts +155 -155
- package/build/es/index.mjs +466 -466
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +489 -489
- package/build/es/index.typings.mjs +339 -339
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +259 -259
- package/build/es/meta.mjs +344 -344
- package/build/es/meta.mjs.map +1 -1
- package/build/es/schemas.d.mts +30 -30
- package/build/es/schemas.mjs +59 -59
- package/build/es/schemas.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +155 -155
- package/build/internal/cjs/index.js +466 -466
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +489 -489
- package/build/internal/cjs/index.typings.js +339 -339
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +259 -259
- package/build/internal/cjs/meta.js +344 -344
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/cjs/schemas.d.ts +30 -30
- package/build/internal/cjs/schemas.js +59 -59
- package/build/internal/cjs/schemas.js.map +1 -1
- package/build/internal/es/index.d.mts +155 -155
- package/build/internal/es/index.mjs +466 -466
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +489 -489
- package/build/internal/es/index.typings.mjs +339 -339
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +259 -259
- package/build/internal/es/meta.mjs +344 -344
- package/build/internal/es/meta.mjs.map +1 -1
- package/build/internal/es/schemas.d.mts +30 -30
- package/build/internal/es/schemas.mjs +59 -59
- package/build/internal/es/schemas.mjs.map +1 -1
- package/package.json +2 -2
|
@@ -626,7 +626,35 @@ interface ActionEvent {
|
|
|
626
626
|
}
|
|
627
627
|
interface Empty {
|
|
628
628
|
}
|
|
629
|
-
interface
|
|
629
|
+
interface OrderPurchased {
|
|
630
|
+
/** Order that was paid for. If a free or an offline order, the order that was created. */
|
|
631
|
+
order?: Order;
|
|
632
|
+
}
|
|
633
|
+
interface OrderStarted {
|
|
634
|
+
/** Order that reached its `startDate`. */
|
|
635
|
+
order?: Order;
|
|
636
|
+
}
|
|
637
|
+
/**
|
|
638
|
+
* Triggered at the start of a new payment cycle for an existing order.
|
|
639
|
+
*
|
|
640
|
+
* This webhook does not trigger at the initial start of an offline order.
|
|
641
|
+
*/
|
|
642
|
+
interface OrderCycleStarted {
|
|
643
|
+
/** Order whose new cycle started. */
|
|
644
|
+
order?: Order;
|
|
645
|
+
/** 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. */
|
|
646
|
+
cycleNumber?: number;
|
|
647
|
+
}
|
|
648
|
+
/** Emitted when a recurring order is canceled for the next payment cycle */
|
|
649
|
+
interface OrderAutoRenewCanceled {
|
|
650
|
+
/** Order that is canceled, effective at the end of the current payment cycle. */
|
|
651
|
+
order?: Order;
|
|
652
|
+
}
|
|
653
|
+
interface OrderEnded {
|
|
654
|
+
/** Order that ended. */
|
|
655
|
+
order?: Order;
|
|
656
|
+
}
|
|
657
|
+
interface GetOrderRequest {
|
|
630
658
|
/**
|
|
631
659
|
* Order ID.
|
|
632
660
|
* @format GUID
|
|
@@ -649,31 +677,44 @@ declare enum Set {
|
|
|
649
677
|
}
|
|
650
678
|
/** @enumType */
|
|
651
679
|
type SetWithLiterals = Set | 'UNKNOWN_SET' | 'BASIC' | 'FULL';
|
|
652
|
-
interface
|
|
653
|
-
/**
|
|
680
|
+
interface GetOrderResponse {
|
|
681
|
+
/** Order. */
|
|
654
682
|
order?: Order;
|
|
655
683
|
}
|
|
656
|
-
interface
|
|
684
|
+
interface ListOrdersRequest {
|
|
657
685
|
/**
|
|
658
|
-
* Filter by
|
|
686
|
+
* Filter by a buyer's member ID, from the Members API.
|
|
687
|
+
* @format GUID
|
|
688
|
+
*/
|
|
689
|
+
buyerIds?: string[];
|
|
690
|
+
/**
|
|
691
|
+
* Filter by plan IDs, from the Plans API.
|
|
659
692
|
* @format GUID
|
|
660
693
|
*/
|
|
661
694
|
planIds?: string[];
|
|
662
|
-
/** Filter
|
|
695
|
+
/** Filter by whether or not the auto-renewal of recurring orders was canceled. */
|
|
663
696
|
autoRenewCanceled?: boolean | null;
|
|
664
697
|
/** Filter by order status. */
|
|
665
698
|
orderStatuses?: OrderStatusWithLiterals[];
|
|
666
699
|
/** Filter by payment status. */
|
|
667
700
|
paymentStatuses?: PaymentStatusWithLiterals[];
|
|
668
701
|
/**
|
|
669
|
-
*
|
|
702
|
+
* Number of orders to return. See Sorting and Paging for more information.
|
|
703
|
+
*
|
|
704
|
+
* Max: `50`
|
|
670
705
|
* @min 1
|
|
671
706
|
* @max 50
|
|
672
707
|
*/
|
|
673
708
|
limit?: number | null;
|
|
674
|
-
/** Number of
|
|
709
|
+
/** Number of orders to skip in the current sort order. */
|
|
675
710
|
offset?: number | null;
|
|
676
|
-
/**
|
|
711
|
+
/**
|
|
712
|
+
* Sort order.
|
|
713
|
+
*
|
|
714
|
+
* Use `ASC` for ascending order or `DESC` for descending order.
|
|
715
|
+
*
|
|
716
|
+
* Default: `DESC`.
|
|
717
|
+
*/
|
|
677
718
|
sorting?: Sorting;
|
|
678
719
|
/**
|
|
679
720
|
* Predefined set of fields to return.
|
|
@@ -697,8 +738,8 @@ declare enum SortOrder {
|
|
|
697
738
|
}
|
|
698
739
|
/** @enumType */
|
|
699
740
|
type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
700
|
-
interface
|
|
701
|
-
/**
|
|
741
|
+
interface ListOrdersResponse {
|
|
742
|
+
/** List of orders. */
|
|
702
743
|
orders?: Order[];
|
|
703
744
|
/** Object containing paging-related data (number of orders returned, offset). */
|
|
704
745
|
pagingMetadata?: PagingMetadataV2;
|
|
@@ -727,11 +768,7 @@ interface Cursors {
|
|
|
727
768
|
*/
|
|
728
769
|
prev?: string | null;
|
|
729
770
|
}
|
|
730
|
-
|
|
731
|
-
* TODO: Write orders filter and sort docs page
|
|
732
|
-
* Retrieves a list of up to 1,000 orders, based on the provided paging, sorting, and filtering.
|
|
733
|
-
*/
|
|
734
|
-
interface QueryOrdersRequest {
|
|
771
|
+
interface OrdersQueryOrdersRequest {
|
|
735
772
|
/** Query filter. */
|
|
736
773
|
query?: QueryV2;
|
|
737
774
|
}
|
|
@@ -785,22 +822,84 @@ interface CursorPaging {
|
|
|
785
822
|
*/
|
|
786
823
|
cursor?: string | null;
|
|
787
824
|
}
|
|
788
|
-
interface
|
|
789
|
-
/**
|
|
825
|
+
interface OrdersQueryOrdersResponse {
|
|
826
|
+
/** Retrieved orders. */
|
|
790
827
|
plans?: Order[];
|
|
791
828
|
/** Paging-related data (number of orders returned, offset). */
|
|
792
829
|
pagingMetadata?: PagingMetadataV2;
|
|
793
830
|
}
|
|
794
|
-
interface
|
|
831
|
+
interface GetOrdersStatsRequest {
|
|
832
|
+
}
|
|
833
|
+
interface GetOrdersStatsResponse {
|
|
834
|
+
/** Total number of orders. */
|
|
835
|
+
totalOrderCount?: number;
|
|
836
|
+
/** Number of active orders. */
|
|
837
|
+
activeOrderCount?: number;
|
|
838
|
+
}
|
|
839
|
+
interface GetAvailableOrderActionsRequest {
|
|
840
|
+
/**
|
|
841
|
+
* Order ID.
|
|
842
|
+
* @format GUID
|
|
843
|
+
*/
|
|
844
|
+
_id?: string;
|
|
845
|
+
}
|
|
846
|
+
interface GetAvailableOrderActionsResponse {
|
|
847
|
+
/** Whether the order can be suspended. */
|
|
848
|
+
suspendable?: boolean;
|
|
849
|
+
/** If the order cannot be suspended, a reason is returned here. */
|
|
850
|
+
notSuspendableReason?: ReasonNotSuspendableWithLiterals;
|
|
851
|
+
/** Whether the order can be canceled by the buyer. */
|
|
852
|
+
cancelableByBuyer?: boolean;
|
|
853
|
+
}
|
|
854
|
+
declare enum ReasonNotSuspendable {
|
|
855
|
+
/** Undefined reason. */
|
|
856
|
+
UNDEFINED = "UNDEFINED",
|
|
857
|
+
/** Saved in the database but is awaiting payment. Non-active orders can't be suspended. */
|
|
858
|
+
PENDING = "PENDING",
|
|
859
|
+
/** Trial orders can't be suspended. */
|
|
860
|
+
TRIAL = "TRIAL",
|
|
861
|
+
/** Canceled orders can't be suspended. */
|
|
862
|
+
CANCELED = "CANCELED",
|
|
863
|
+
/** Ended orders can't be suspended. */
|
|
864
|
+
ENDED = "ENDED",
|
|
865
|
+
/** Paid for orders with future start dates can't be suspended. */
|
|
866
|
+
NOT_STARTED = "NOT_STARTED",
|
|
867
|
+
/** Order is already suspended. */
|
|
868
|
+
ALREADY_SUSPENDED = "ALREADY_SUSPENDED",
|
|
869
|
+
/** Orders based on recurring payments using older stripe versions can't be suspended. */
|
|
870
|
+
OLD_STRIPE = "OLD_STRIPE"
|
|
871
|
+
}
|
|
872
|
+
/** @enumType */
|
|
873
|
+
type ReasonNotSuspendableWithLiterals = ReasonNotSuspendable | 'UNDEFINED' | 'PENDING' | 'TRIAL' | 'CANCELED' | 'ENDED' | 'NOT_STARTED' | 'ALREADY_SUSPENDED' | 'OLD_STRIPE';
|
|
874
|
+
interface PostponeEndDateRequest {
|
|
795
875
|
/**
|
|
796
876
|
* Order ID.
|
|
797
877
|
* @format GUID
|
|
798
878
|
*/
|
|
799
879
|
_id: string;
|
|
800
|
-
/**
|
|
880
|
+
/**
|
|
881
|
+
* New end date and time.
|
|
882
|
+
*
|
|
883
|
+
* Must be later than the current end date and time.
|
|
884
|
+
*/
|
|
885
|
+
endDate: Date | null;
|
|
886
|
+
}
|
|
887
|
+
interface PostponeEndDateResponse {
|
|
888
|
+
}
|
|
889
|
+
interface OrderEndDatePostponed {
|
|
890
|
+
/** Order whose `endDate` was postponed. */
|
|
891
|
+
order?: Order;
|
|
892
|
+
}
|
|
893
|
+
interface CancelOrderRequest {
|
|
894
|
+
/**
|
|
895
|
+
* Order ID.
|
|
896
|
+
* @format GUID
|
|
897
|
+
*/
|
|
898
|
+
_id: string;
|
|
899
|
+
/** __Required.__ When the order will be canceled. One-time orders can only be canceled `IMMEDIATELY`. */
|
|
801
900
|
effectiveAt: CancellationEffectiveAtWithLiterals;
|
|
802
901
|
}
|
|
803
|
-
interface
|
|
902
|
+
interface CancelOrderResponse {
|
|
804
903
|
}
|
|
805
904
|
/**
|
|
806
905
|
* Emitted when an order is canceled immediately or when cycle ends for an order with canceled auto renewal
|
|
@@ -811,6 +910,111 @@ interface OrderCanceled {
|
|
|
811
910
|
/** Canceled order. */
|
|
812
911
|
order?: Order;
|
|
813
912
|
}
|
|
913
|
+
interface MarkAsPaidRequest {
|
|
914
|
+
/**
|
|
915
|
+
* Order ID.
|
|
916
|
+
* @format GUID
|
|
917
|
+
*/
|
|
918
|
+
_id: string;
|
|
919
|
+
}
|
|
920
|
+
interface MarkAsPaidResponse {
|
|
921
|
+
}
|
|
922
|
+
interface OrderMarkedAsPaid {
|
|
923
|
+
/** Order that was marked as paid. */
|
|
924
|
+
order?: Order;
|
|
925
|
+
}
|
|
926
|
+
interface PauseOrderRequest {
|
|
927
|
+
/**
|
|
928
|
+
* Order ID.
|
|
929
|
+
* @format GUID
|
|
930
|
+
*/
|
|
931
|
+
_id: string;
|
|
932
|
+
}
|
|
933
|
+
interface PauseOrderResponse {
|
|
934
|
+
}
|
|
935
|
+
interface OrderPaused {
|
|
936
|
+
/** Paused order. */
|
|
937
|
+
order?: Order;
|
|
938
|
+
}
|
|
939
|
+
interface BulkPauseOrderRequest {
|
|
940
|
+
/**
|
|
941
|
+
* List of Order IDs.
|
|
942
|
+
* @format GUID
|
|
943
|
+
* @minSize 1
|
|
944
|
+
* @maxSize 100
|
|
945
|
+
*/
|
|
946
|
+
ids?: string[];
|
|
947
|
+
/** Set to true to return Order entity in response. */
|
|
948
|
+
returnFullEntity?: boolean;
|
|
949
|
+
}
|
|
950
|
+
interface BulkPauseOrderResponse {
|
|
951
|
+
/** Orders that were paused. */
|
|
952
|
+
results?: BulkOrderResult[];
|
|
953
|
+
/** Bulk action metadata. */
|
|
954
|
+
bulkActionMetadata?: BulkActionMetadata;
|
|
955
|
+
}
|
|
956
|
+
interface BulkOrderResult {
|
|
957
|
+
/** Item metadata */
|
|
958
|
+
itemMetadata?: ItemMetadata;
|
|
959
|
+
/** The order. */
|
|
960
|
+
order?: Order;
|
|
961
|
+
}
|
|
962
|
+
interface ItemMetadata {
|
|
963
|
+
/** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
|
|
964
|
+
_id?: string | null;
|
|
965
|
+
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
966
|
+
originalIndex?: number;
|
|
967
|
+
/** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
|
|
968
|
+
success?: boolean;
|
|
969
|
+
/** Details about the error in case of failure. */
|
|
970
|
+
error?: ApplicationError;
|
|
971
|
+
}
|
|
972
|
+
interface ApplicationError {
|
|
973
|
+
/** Error code. */
|
|
974
|
+
code?: string;
|
|
975
|
+
/** Description of the error. */
|
|
976
|
+
description?: string;
|
|
977
|
+
/** Data related to the error. */
|
|
978
|
+
data?: Record<string, any> | null;
|
|
979
|
+
}
|
|
980
|
+
interface BulkActionMetadata {
|
|
981
|
+
/** Number of items that were successfully processed. */
|
|
982
|
+
totalSuccesses?: number;
|
|
983
|
+
/** Number of items that couldn't be processed. */
|
|
984
|
+
totalFailures?: number;
|
|
985
|
+
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
986
|
+
undetailedFailures?: number;
|
|
987
|
+
}
|
|
988
|
+
interface ResumeOrderRequest {
|
|
989
|
+
/**
|
|
990
|
+
* Order ID.
|
|
991
|
+
* @format GUID
|
|
992
|
+
*/
|
|
993
|
+
_id: string;
|
|
994
|
+
}
|
|
995
|
+
interface ResumeOrderResponse {
|
|
996
|
+
}
|
|
997
|
+
interface OrderResumed {
|
|
998
|
+
/** Resumed order. */
|
|
999
|
+
order?: Order;
|
|
1000
|
+
}
|
|
1001
|
+
interface BulkResumeOrderRequest {
|
|
1002
|
+
/**
|
|
1003
|
+
* List of Order IDs.
|
|
1004
|
+
* @format GUID
|
|
1005
|
+
* @minSize 1
|
|
1006
|
+
* @maxSize 100
|
|
1007
|
+
*/
|
|
1008
|
+
ids?: string[];
|
|
1009
|
+
/** Set to true to return Order entity in response. */
|
|
1010
|
+
returnFullEntity?: boolean;
|
|
1011
|
+
}
|
|
1012
|
+
interface BulkResumeOrderResponse {
|
|
1013
|
+
/** Orders that were resumed. */
|
|
1014
|
+
results?: BulkOrderResult[];
|
|
1015
|
+
/** Bulk action metadata. */
|
|
1016
|
+
bulkActionMetadata?: BulkActionMetadata;
|
|
1017
|
+
}
|
|
814
1018
|
interface MessageEnvelope {
|
|
815
1019
|
/**
|
|
816
1020
|
* App instance ID.
|
|
@@ -1205,35 +1409,7 @@ interface SetSubmissionResponse {
|
|
|
1205
1409
|
/** Order with submission id */
|
|
1206
1410
|
order?: Order;
|
|
1207
1411
|
}
|
|
1208
|
-
interface
|
|
1209
|
-
/** Order that was paid for. If a free or an offline order, the order that was created. */
|
|
1210
|
-
order?: Order;
|
|
1211
|
-
}
|
|
1212
|
-
interface OrderStarted {
|
|
1213
|
-
/** Order that reached its `startDate`. */
|
|
1214
|
-
order?: Order;
|
|
1215
|
-
}
|
|
1216
|
-
/**
|
|
1217
|
-
* Triggered at the start of a new payment cycle for an existing order.
|
|
1218
|
-
*
|
|
1219
|
-
* This webhook does not trigger at the initial start of an offline order.
|
|
1220
|
-
*/
|
|
1221
|
-
interface OrderCycleStarted {
|
|
1222
|
-
/** Order whose new cycle started. */
|
|
1223
|
-
order?: Order;
|
|
1224
|
-
/** 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. */
|
|
1225
|
-
cycleNumber?: number;
|
|
1226
|
-
}
|
|
1227
|
-
/** Emitted when a recurring order is canceled for the next payment cycle */
|
|
1228
|
-
interface OrderAutoRenewCanceled {
|
|
1229
|
-
/** Order that is canceled, effective at the end of the current payment cycle. */
|
|
1230
|
-
order?: Order;
|
|
1231
|
-
}
|
|
1232
|
-
interface OrderEnded {
|
|
1233
|
-
/** Order that ended. */
|
|
1234
|
-
order?: Order;
|
|
1235
|
-
}
|
|
1236
|
-
interface GetOrderRequest {
|
|
1412
|
+
interface MemberGetOrderRequest {
|
|
1237
1413
|
/**
|
|
1238
1414
|
* Order ID.
|
|
1239
1415
|
* @format GUID
|
|
@@ -1246,44 +1422,31 @@ interface GetOrderRequest {
|
|
|
1246
1422
|
*/
|
|
1247
1423
|
fieldSet?: SetWithLiterals;
|
|
1248
1424
|
}
|
|
1249
|
-
interface
|
|
1250
|
-
/**
|
|
1425
|
+
interface MemberGetOrderResponse {
|
|
1426
|
+
/** Requested order. */
|
|
1251
1427
|
order?: Order;
|
|
1252
1428
|
}
|
|
1253
|
-
interface
|
|
1254
|
-
/**
|
|
1255
|
-
* Filter by a buyer's member ID, from the Members API.
|
|
1256
|
-
* @format GUID
|
|
1257
|
-
*/
|
|
1258
|
-
buyerIds?: string[];
|
|
1429
|
+
interface MemberListOrdersRequest {
|
|
1259
1430
|
/**
|
|
1260
|
-
* Filter by plan IDs
|
|
1431
|
+
* Filter by plan IDs.
|
|
1261
1432
|
* @format GUID
|
|
1262
1433
|
*/
|
|
1263
1434
|
planIds?: string[];
|
|
1264
|
-
/** Filter
|
|
1435
|
+
/** Filter for orders where auto renewal was canceled. */
|
|
1265
1436
|
autoRenewCanceled?: boolean | null;
|
|
1266
1437
|
/** Filter by order status. */
|
|
1267
1438
|
orderStatuses?: OrderStatusWithLiterals[];
|
|
1268
1439
|
/** Filter by payment status. */
|
|
1269
1440
|
paymentStatuses?: PaymentStatusWithLiterals[];
|
|
1270
1441
|
/**
|
|
1271
|
-
*
|
|
1272
|
-
*
|
|
1273
|
-
* Max: `50`
|
|
1442
|
+
* Limit the number of pricing plans returned. Default limit is 50.
|
|
1274
1443
|
* @min 1
|
|
1275
1444
|
* @max 50
|
|
1276
1445
|
*/
|
|
1277
1446
|
limit?: number | null;
|
|
1278
|
-
/** Number of
|
|
1447
|
+
/** Number of entries to offset. */
|
|
1279
1448
|
offset?: number | null;
|
|
1280
|
-
/**
|
|
1281
|
-
* Sort order.
|
|
1282
|
-
*
|
|
1283
|
-
* Use `ASC` for ascending order or `DESC` for descending order.
|
|
1284
|
-
*
|
|
1285
|
-
* Default: `DESC`.
|
|
1286
|
-
*/
|
|
1449
|
+
/** Sorting direction (defaults to ASC) and field to sort by. */
|
|
1287
1450
|
sorting?: Sorting;
|
|
1288
1451
|
/**
|
|
1289
1452
|
* Predefined set of fields to return.
|
|
@@ -1292,199 +1455,36 @@ interface ListOrdersRequest {
|
|
|
1292
1455
|
*/
|
|
1293
1456
|
fieldSet?: SetWithLiterals;
|
|
1294
1457
|
}
|
|
1295
|
-
interface
|
|
1296
|
-
/**
|
|
1458
|
+
interface MemberListOrdersResponse {
|
|
1459
|
+
/** Requested orders. */
|
|
1297
1460
|
orders?: Order[];
|
|
1298
1461
|
/** Object containing paging-related data (number of orders returned, offset). */
|
|
1299
1462
|
pagingMetadata?: PagingMetadataV2;
|
|
1300
1463
|
}
|
|
1301
|
-
|
|
1464
|
+
/**
|
|
1465
|
+
* TODO: Write orders filter and sort docs page
|
|
1466
|
+
* Retrieves a list of up to 1,000 orders, based on the provided paging, sorting, and filtering.
|
|
1467
|
+
*/
|
|
1468
|
+
interface QueryOrdersRequest {
|
|
1302
1469
|
/** Query filter. */
|
|
1303
1470
|
query?: QueryV2;
|
|
1304
1471
|
}
|
|
1305
|
-
interface
|
|
1306
|
-
/**
|
|
1472
|
+
interface QueryOrdersResponse {
|
|
1473
|
+
/** Order data. */
|
|
1307
1474
|
plans?: Order[];
|
|
1308
1475
|
/** Paging-related data (number of orders returned, offset). */
|
|
1309
1476
|
pagingMetadata?: PagingMetadataV2;
|
|
1310
1477
|
}
|
|
1311
|
-
interface
|
|
1312
|
-
}
|
|
1313
|
-
interface GetOrdersStatsResponse {
|
|
1314
|
-
/** Total number of orders. */
|
|
1315
|
-
totalOrderCount?: number;
|
|
1316
|
-
/** Number of active orders. */
|
|
1317
|
-
activeOrderCount?: number;
|
|
1318
|
-
}
|
|
1319
|
-
interface GetAvailableOrderActionsRequest {
|
|
1320
|
-
/**
|
|
1321
|
-
* Order ID.
|
|
1322
|
-
* @format GUID
|
|
1323
|
-
*/
|
|
1324
|
-
_id?: string;
|
|
1325
|
-
}
|
|
1326
|
-
interface GetAvailableOrderActionsResponse {
|
|
1327
|
-
/** Whether the order can be suspended. */
|
|
1328
|
-
suspendable?: boolean;
|
|
1329
|
-
/** If the order cannot be suspended, a reason is returned here. */
|
|
1330
|
-
notSuspendableReason?: ReasonNotSuspendableWithLiterals;
|
|
1331
|
-
/** Whether the order can be canceled by the buyer. */
|
|
1332
|
-
cancelableByBuyer?: boolean;
|
|
1333
|
-
}
|
|
1334
|
-
declare enum ReasonNotSuspendable {
|
|
1335
|
-
/** Undefined reason. */
|
|
1336
|
-
UNDEFINED = "UNDEFINED",
|
|
1337
|
-
/** Saved in the database but is awaiting payment. Non-active orders can't be suspended. */
|
|
1338
|
-
PENDING = "PENDING",
|
|
1339
|
-
/** Trial orders can't be suspended. */
|
|
1340
|
-
TRIAL = "TRIAL",
|
|
1341
|
-
/** Canceled orders can't be suspended. */
|
|
1342
|
-
CANCELED = "CANCELED",
|
|
1343
|
-
/** Ended orders can't be suspended. */
|
|
1344
|
-
ENDED = "ENDED",
|
|
1345
|
-
/** Paid for orders with future start dates can't be suspended. */
|
|
1346
|
-
NOT_STARTED = "NOT_STARTED",
|
|
1347
|
-
/** Order is already suspended. */
|
|
1348
|
-
ALREADY_SUSPENDED = "ALREADY_SUSPENDED",
|
|
1349
|
-
/** Orders based on recurring payments using older stripe versions can't be suspended. */
|
|
1350
|
-
OLD_STRIPE = "OLD_STRIPE"
|
|
1351
|
-
}
|
|
1352
|
-
/** @enumType */
|
|
1353
|
-
type ReasonNotSuspendableWithLiterals = ReasonNotSuspendable | 'UNDEFINED' | 'PENDING' | 'TRIAL' | 'CANCELED' | 'ENDED' | 'NOT_STARTED' | 'ALREADY_SUSPENDED' | 'OLD_STRIPE';
|
|
1354
|
-
interface PostponeEndDateRequest {
|
|
1355
|
-
/**
|
|
1356
|
-
* Order ID.
|
|
1357
|
-
* @format GUID
|
|
1358
|
-
*/
|
|
1359
|
-
_id: string;
|
|
1360
|
-
/**
|
|
1361
|
-
* New end date and time.
|
|
1362
|
-
*
|
|
1363
|
-
* Must be later than the current end date and time.
|
|
1364
|
-
*/
|
|
1365
|
-
endDate: Date | null;
|
|
1366
|
-
}
|
|
1367
|
-
interface PostponeEndDateResponse {
|
|
1368
|
-
}
|
|
1369
|
-
interface OrderEndDatePostponed {
|
|
1370
|
-
/** Order whose `endDate` was postponed. */
|
|
1371
|
-
order?: Order;
|
|
1372
|
-
}
|
|
1373
|
-
interface CancelOrderRequest {
|
|
1478
|
+
interface RequestCancellationRequest {
|
|
1374
1479
|
/**
|
|
1375
1480
|
* Order ID.
|
|
1376
1481
|
* @format GUID
|
|
1377
1482
|
*/
|
|
1378
1483
|
_id: string;
|
|
1379
|
-
/**
|
|
1484
|
+
/** Required. Whether to cancel the order effective immediately or at the next payment date. One-time orders can only be canceled immediately. */
|
|
1380
1485
|
effectiveAt: CancellationEffectiveAtWithLiterals;
|
|
1381
1486
|
}
|
|
1382
|
-
interface
|
|
1383
|
-
}
|
|
1384
|
-
interface MarkAsPaidRequest {
|
|
1385
|
-
/**
|
|
1386
|
-
* Order ID.
|
|
1387
|
-
* @format GUID
|
|
1388
|
-
*/
|
|
1389
|
-
_id: string;
|
|
1390
|
-
}
|
|
1391
|
-
interface MarkAsPaidResponse {
|
|
1392
|
-
}
|
|
1393
|
-
interface OrderMarkedAsPaid {
|
|
1394
|
-
/** Order that was marked as paid. */
|
|
1395
|
-
order?: Order;
|
|
1396
|
-
}
|
|
1397
|
-
interface PauseOrderRequest {
|
|
1398
|
-
/**
|
|
1399
|
-
* Order ID.
|
|
1400
|
-
* @format GUID
|
|
1401
|
-
*/
|
|
1402
|
-
_id: string;
|
|
1403
|
-
}
|
|
1404
|
-
interface PauseOrderResponse {
|
|
1405
|
-
}
|
|
1406
|
-
interface OrderPaused {
|
|
1407
|
-
/** Paused order. */
|
|
1408
|
-
order?: Order;
|
|
1409
|
-
}
|
|
1410
|
-
interface BulkPauseOrderRequest {
|
|
1411
|
-
/**
|
|
1412
|
-
* List of Order IDs.
|
|
1413
|
-
* @format GUID
|
|
1414
|
-
* @minSize 1
|
|
1415
|
-
* @maxSize 100
|
|
1416
|
-
*/
|
|
1417
|
-
ids?: string[];
|
|
1418
|
-
/** Set to true to return Order entity in response. */
|
|
1419
|
-
returnFullEntity?: boolean;
|
|
1420
|
-
}
|
|
1421
|
-
interface BulkPauseOrderResponse {
|
|
1422
|
-
/** Orders that were paused. */
|
|
1423
|
-
results?: BulkOrderResult[];
|
|
1424
|
-
/** Bulk action metadata. */
|
|
1425
|
-
bulkActionMetadata?: BulkActionMetadata;
|
|
1426
|
-
}
|
|
1427
|
-
interface BulkOrderResult {
|
|
1428
|
-
/** Item metadata */
|
|
1429
|
-
itemMetadata?: ItemMetadata;
|
|
1430
|
-
/** The order. */
|
|
1431
|
-
order?: Order;
|
|
1432
|
-
}
|
|
1433
|
-
interface ItemMetadata {
|
|
1434
|
-
/** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
|
|
1435
|
-
_id?: string | null;
|
|
1436
|
-
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
1437
|
-
originalIndex?: number;
|
|
1438
|
-
/** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
|
|
1439
|
-
success?: boolean;
|
|
1440
|
-
/** Details about the error in case of failure. */
|
|
1441
|
-
error?: ApplicationError;
|
|
1442
|
-
}
|
|
1443
|
-
interface ApplicationError {
|
|
1444
|
-
/** Error code. */
|
|
1445
|
-
code?: string;
|
|
1446
|
-
/** Description of the error. */
|
|
1447
|
-
description?: string;
|
|
1448
|
-
/** Data related to the error. */
|
|
1449
|
-
data?: Record<string, any> | null;
|
|
1450
|
-
}
|
|
1451
|
-
interface BulkActionMetadata {
|
|
1452
|
-
/** Number of items that were successfully processed. */
|
|
1453
|
-
totalSuccesses?: number;
|
|
1454
|
-
/** Number of items that couldn't be processed. */
|
|
1455
|
-
totalFailures?: number;
|
|
1456
|
-
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
1457
|
-
undetailedFailures?: number;
|
|
1458
|
-
}
|
|
1459
|
-
interface ResumeOrderRequest {
|
|
1460
|
-
/**
|
|
1461
|
-
* Order ID.
|
|
1462
|
-
* @format GUID
|
|
1463
|
-
*/
|
|
1464
|
-
_id: string;
|
|
1465
|
-
}
|
|
1466
|
-
interface ResumeOrderResponse {
|
|
1467
|
-
}
|
|
1468
|
-
interface OrderResumed {
|
|
1469
|
-
/** Resumed order. */
|
|
1470
|
-
order?: Order;
|
|
1471
|
-
}
|
|
1472
|
-
interface BulkResumeOrderRequest {
|
|
1473
|
-
/**
|
|
1474
|
-
* List of Order IDs.
|
|
1475
|
-
* @format GUID
|
|
1476
|
-
* @minSize 1
|
|
1477
|
-
* @maxSize 100
|
|
1478
|
-
*/
|
|
1479
|
-
ids?: string[];
|
|
1480
|
-
/** Set to true to return Order entity in response. */
|
|
1481
|
-
returnFullEntity?: boolean;
|
|
1482
|
-
}
|
|
1483
|
-
interface BulkResumeOrderResponse {
|
|
1484
|
-
/** Orders that were resumed. */
|
|
1485
|
-
results?: BulkOrderResult[];
|
|
1486
|
-
/** Bulk action metadata. */
|
|
1487
|
-
bulkActionMetadata?: BulkActionMetadata;
|
|
1487
|
+
interface RequestCancellationResponse {
|
|
1488
1488
|
}
|
|
1489
1489
|
/** @docsIgnore */
|
|
1490
1490
|
type CreateOnlineOrderApplicationErrors = {
|
|
@@ -1837,16 +1837,16 @@ interface AccountInfoMetadata {
|
|
|
1837
1837
|
/** ID of the parent Wix account. Only included when 'accountId' belongs to a child account. */
|
|
1838
1838
|
parentAccountId?: string;
|
|
1839
1839
|
}
|
|
1840
|
-
interface
|
|
1841
|
-
data:
|
|
1840
|
+
interface OrderAutoRenewCanceledEnvelope {
|
|
1841
|
+
data: OrderAutoRenewCanceled;
|
|
1842
1842
|
metadata: EventMetadata;
|
|
1843
1843
|
}
|
|
1844
1844
|
/**
|
|
1845
|
-
* Triggered when an order is canceled
|
|
1845
|
+
* Triggered when an order is canceled and `effectiveAt` is set to `NEXT_PAYMENT_DATE`.
|
|
1846
1846
|
*
|
|
1847
|
-
* This webhook is triggered
|
|
1848
|
-
* +
|
|
1849
|
-
* +
|
|
1847
|
+
* This webhook is *not* triggered in the following scenarios:
|
|
1848
|
+
* + When an order is canceled and `effectiveAt` is set to `IMMEDIATELY`. Instead, at the time of cancellation, Order Canceled is triggered.
|
|
1849
|
+
* + 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.
|
|
1850
1850
|
* @permissionScope Manage Orders
|
|
1851
1851
|
* @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
|
|
1852
1852
|
* @permissionScope Read Orders
|
|
@@ -1857,92 +1857,21 @@ interface OrderCanceledEnvelope {
|
|
|
1857
1857
|
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1858
1858
|
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
1859
1859
|
* @webhook
|
|
1860
|
-
* @eventType wix.pricing_plans.v2.
|
|
1861
|
-
* @serviceIdentifier com.wixpress.membership.v2.orders.
|
|
1862
|
-
* @slug
|
|
1860
|
+
* @eventType wix.pricing_plans.v2.order_auto_renew_canceled
|
|
1861
|
+
* @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
|
|
1862
|
+
* @slug auto_renew_canceled
|
|
1863
1863
|
*/
|
|
1864
|
-
declare function
|
|
1865
|
-
interface
|
|
1866
|
-
|
|
1867
|
-
metadata: EventMetadata;
|
|
1868
|
-
}
|
|
1869
|
-
/**
|
|
1870
|
-
* Triggered when an order is created.
|
|
1871
|
-
* @permissionScope Manage Orders
|
|
1872
|
-
* @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
|
|
1873
|
-
* @permissionScope Read Orders
|
|
1874
|
-
* @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS
|
|
1875
|
-
* @permissionScope Manage plans and orders of Pricing Plans
|
|
1876
|
-
* @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-PLANS-AND-ORDERS
|
|
1877
|
-
* @permissionScope Manage Events
|
|
1878
|
-
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1879
|
-
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
1880
|
-
* @webhook
|
|
1881
|
-
* @eventType wix.pricing_plans.v2.order_created
|
|
1882
|
-
* @serviceIdentifier com.wixpress.membership.v2.orders.CheckoutService
|
|
1883
|
-
* @slug created
|
|
1884
|
-
*/
|
|
1885
|
-
declare function onOrderCreated(handler: (event: OrderCreatedEnvelope) => void | Promise<void>): void;
|
|
1886
|
-
interface OrderStartDateChangedEnvelope {
|
|
1887
|
-
data: OrderStartDateChanged;
|
|
1888
|
-
metadata: EventMetadata;
|
|
1889
|
-
}
|
|
1890
|
-
/**
|
|
1891
|
-
* Triggered when an order's `startDate` is changed.
|
|
1892
|
-
* @permissionScope Manage Orders
|
|
1893
|
-
* @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
|
|
1894
|
-
* @permissionScope Read Orders
|
|
1895
|
-
* @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS
|
|
1896
|
-
* @permissionScope Manage plans and orders of Pricing Plans
|
|
1897
|
-
* @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-PLANS-AND-ORDERS
|
|
1898
|
-
* @permissionScope Manage Events
|
|
1899
|
-
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1900
|
-
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
1901
|
-
* @webhook
|
|
1902
|
-
* @eventType wix.pricing_plans.v2.order_start_date_changed
|
|
1903
|
-
* @serviceIdentifier com.wixpress.membership.v2.orders.CheckoutService
|
|
1904
|
-
* @slug start_date_changed
|
|
1905
|
-
*/
|
|
1906
|
-
declare function onOrderStartDateChanged(handler: (event: OrderStartDateChangedEnvelope) => void | Promise<void>): void;
|
|
1907
|
-
interface OrderUpdatedEnvelope {
|
|
1908
|
-
entity: Order;
|
|
1909
|
-
metadata: EventMetadata;
|
|
1910
|
-
}
|
|
1911
|
-
/**
|
|
1912
|
-
* Triggered for any of the following update events:
|
|
1913
|
-
*
|
|
1914
|
-
* + Order is paid for. Order Purchased is also triggered.
|
|
1915
|
-
* + Order reaches its start date or end date. Order Started and Order Ended, respectively, are also triggered.
|
|
1916
|
-
* + New payment cycle of an order starts. Order Cycle Started is also triggered.
|
|
1917
|
-
* + Offline order is marked as paid. Order Marked As Paid is also triggered.
|
|
1918
|
-
* + End date of the order is postponed. Order End Date Postponed is also triggered
|
|
1919
|
-
* + Order is paused, or a paused order is resumed. Order Paused and Order Resumed, respectively, are also triggered.
|
|
1920
|
-
* + Order is canceled, either immediately or at the end of the payment cycle. Order Canceled and Order Auto Renew Canceled, respectively, are also triggered.
|
|
1921
|
-
* @permissionScope Manage Orders
|
|
1922
|
-
* @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
|
|
1923
|
-
* @permissionScope Read Orders
|
|
1924
|
-
* @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS
|
|
1925
|
-
* @permissionScope Manage plans and orders of Pricing Plans
|
|
1926
|
-
* @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-PLANS-AND-ORDERS
|
|
1927
|
-
* @permissionScope Manage Events
|
|
1928
|
-
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1929
|
-
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
1930
|
-
* @webhook
|
|
1931
|
-
* @eventType wix.pricing_plans.v2.order_updated
|
|
1932
|
-
* @serviceIdentifier com.wixpress.membership.v2.orders.CheckoutService
|
|
1933
|
-
* @slug updated
|
|
1934
|
-
*/
|
|
1935
|
-
declare function onOrderUpdated(handler: (event: OrderUpdatedEnvelope) => void | Promise<void>): void;
|
|
1936
|
-
interface OrderAutoRenewCanceledEnvelope {
|
|
1937
|
-
data: OrderAutoRenewCanceled;
|
|
1864
|
+
declare function onOrderAutoRenewCanceled(handler: (event: OrderAutoRenewCanceledEnvelope) => void | Promise<void>): void;
|
|
1865
|
+
interface OrderCanceledEnvelope {
|
|
1866
|
+
data: OrderCanceled;
|
|
1938
1867
|
metadata: EventMetadata;
|
|
1939
1868
|
}
|
|
1940
1869
|
/**
|
|
1941
|
-
* Triggered when an order is canceled
|
|
1870
|
+
* Triggered when an order is canceled.
|
|
1942
1871
|
*
|
|
1943
|
-
* This webhook is
|
|
1944
|
-
* +
|
|
1945
|
-
* +
|
|
1872
|
+
* This webhook is triggered either immediately or at the end of the current payment cycle, as follows:
|
|
1873
|
+
* + If the order is canceled and `effectiveAt` is set to `IMMEDIATELY`, the webhook is triggered immediately when canceled.
|
|
1874
|
+
* + If the order is canceled and `effectiveAt` is set to `NEXT_PAYMENT_DATE`, the webhook is triggered at the end of the current payment cycle. In this case, the Order Auto Renew Canceled Webhook is triggered immediately.
|
|
1946
1875
|
* @permissionScope Manage Orders
|
|
1947
1876
|
* @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
|
|
1948
1877
|
* @permissionScope Read Orders
|
|
@@ -1953,11 +1882,11 @@ interface OrderAutoRenewCanceledEnvelope {
|
|
|
1953
1882
|
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1954
1883
|
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
1955
1884
|
* @webhook
|
|
1956
|
-
* @eventType wix.pricing_plans.v2.
|
|
1885
|
+
* @eventType wix.pricing_plans.v2.order_canceled
|
|
1957
1886
|
* @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
|
|
1958
|
-
* @slug
|
|
1887
|
+
* @slug canceled
|
|
1959
1888
|
*/
|
|
1960
|
-
declare function
|
|
1889
|
+
declare function onOrderCanceled(handler: (event: OrderCanceledEnvelope) => void | Promise<void>): void;
|
|
1961
1890
|
interface OrderCycleStartedEnvelope {
|
|
1962
1891
|
data: OrderCycleStarted;
|
|
1963
1892
|
metadata: EventMetadata;
|
|
@@ -2136,19 +2065,89 @@ interface OrderStartedEnvelope {
|
|
|
2136
2065
|
* @slug started
|
|
2137
2066
|
*/
|
|
2138
2067
|
declare function onOrderStarted(handler: (event: OrderStartedEnvelope) => void | Promise<void>): void;
|
|
2068
|
+
interface OrderUpdatedEnvelope {
|
|
2069
|
+
entity: Order;
|
|
2070
|
+
metadata: EventMetadata;
|
|
2071
|
+
}
|
|
2139
2072
|
/**
|
|
2140
|
-
*
|
|
2073
|
+
* Triggered for any of the following update events:
|
|
2074
|
+
*
|
|
2075
|
+
* + Order is paid for. Order Purchased is also triggered.
|
|
2076
|
+
* + Order reaches its start date or end date. Order Started and Order Ended, respectively, are also triggered.
|
|
2077
|
+
* + New payment cycle of an order starts. Order Cycle Started is also triggered.
|
|
2078
|
+
* + Offline order is marked as paid. Order Marked As Paid is also triggered.
|
|
2079
|
+
* + End date of the order is postponed. Order End Date Postponed is also triggered
|
|
2080
|
+
* + Order is paused, or a paused order is resumed. Order Paused and Order Resumed, respectively, are also triggered.
|
|
2081
|
+
* + Order is canceled, either immediately or at the end of the payment cycle. Order Canceled and Order Auto Renew Canceled, respectively, are also triggered.
|
|
2082
|
+
* @permissionScope Manage Orders
|
|
2083
|
+
* @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
|
|
2084
|
+
* @permissionScope Read Orders
|
|
2085
|
+
* @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS
|
|
2086
|
+
* @permissionScope Manage plans and orders of Pricing Plans
|
|
2087
|
+
* @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-PLANS-AND-ORDERS
|
|
2088
|
+
* @permissionScope Manage Events
|
|
2089
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
2090
|
+
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
2091
|
+
* @webhook
|
|
2092
|
+
* @eventType wix.pricing_plans.v2.order_updated
|
|
2093
|
+
* @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
|
|
2094
|
+
* @slug updated
|
|
2095
|
+
*/
|
|
2096
|
+
declare function onOrderUpdated(handler: (event: OrderUpdatedEnvelope) => void | Promise<void>): void;
|
|
2097
|
+
interface OrderCreatedEnvelope {
|
|
2098
|
+
entity: Order;
|
|
2099
|
+
metadata: EventMetadata;
|
|
2100
|
+
}
|
|
2101
|
+
/**
|
|
2102
|
+
* Triggered when an order is created.
|
|
2103
|
+
* @permissionScope Manage Orders
|
|
2104
|
+
* @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
|
|
2105
|
+
* @permissionScope Read Orders
|
|
2106
|
+
* @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS
|
|
2107
|
+
* @permissionScope Manage plans and orders of Pricing Plans
|
|
2108
|
+
* @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-PLANS-AND-ORDERS
|
|
2109
|
+
* @permissionScope Manage Events
|
|
2110
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
2111
|
+
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
2112
|
+
* @webhook
|
|
2113
|
+
* @eventType wix.pricing_plans.v2.order_created
|
|
2114
|
+
* @serviceIdentifier com.wixpress.membership.v2.orders.CheckoutService
|
|
2115
|
+
* @slug created
|
|
2116
|
+
*/
|
|
2117
|
+
declare function onOrderCreated(handler: (event: OrderCreatedEnvelope) => void | Promise<void>): void;
|
|
2118
|
+
interface OrderStartDateChangedEnvelope {
|
|
2119
|
+
data: OrderStartDateChanged;
|
|
2120
|
+
metadata: EventMetadata;
|
|
2121
|
+
}
|
|
2122
|
+
/**
|
|
2123
|
+
* Triggered when an order's `startDate` is changed.
|
|
2124
|
+
* @permissionScope Manage Orders
|
|
2125
|
+
* @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
|
|
2126
|
+
* @permissionScope Read Orders
|
|
2127
|
+
* @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS
|
|
2128
|
+
* @permissionScope Manage plans and orders of Pricing Plans
|
|
2129
|
+
* @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-PLANS-AND-ORDERS
|
|
2130
|
+
* @permissionScope Manage Events
|
|
2131
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
2132
|
+
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
2133
|
+
* @webhook
|
|
2134
|
+
* @eventType wix.pricing_plans.v2.order_start_date_changed
|
|
2135
|
+
* @serviceIdentifier com.wixpress.membership.v2.orders.CheckoutService
|
|
2136
|
+
* @slug start_date_changed
|
|
2137
|
+
*/
|
|
2138
|
+
declare function onOrderStartDateChanged(handler: (event: OrderStartDateChangedEnvelope) => void | Promise<void>): void;
|
|
2139
|
+
/**
|
|
2140
|
+
* Retrieves an order by ID.
|
|
2141
2141
|
* @param _id - Order ID.
|
|
2142
2142
|
* @public
|
|
2143
2143
|
* @requiredField _id
|
|
2144
|
-
* @param options - Options
|
|
2145
|
-
* @permissionId PRICING_PLANS.
|
|
2144
|
+
* @param options - Options to use when getting an order.
|
|
2145
|
+
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
2146
2146
|
* @applicableIdentity APP
|
|
2147
|
-
* @
|
|
2148
|
-
* @fqn com.wixpress.membership.v2.orders.member.MemberOrdersService.GetOrder
|
|
2147
|
+
* @fqn com.wixpress.membership.v2.orders.OrderManagementService.GetOrder
|
|
2149
2148
|
*/
|
|
2150
|
-
declare function
|
|
2151
|
-
interface
|
|
2149
|
+
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>>;
|
|
2150
|
+
interface ManagementGetOrderOptions {
|
|
2152
2151
|
/**
|
|
2153
2152
|
* Predefined set of fields to return.
|
|
2154
2153
|
*
|
|
@@ -2157,36 +2156,51 @@ interface MemberGetOrderOptions {
|
|
|
2157
2156
|
fieldSet?: SetWithLiterals;
|
|
2158
2157
|
}
|
|
2159
2158
|
/**
|
|
2160
|
-
* Retrieves a list of up to
|
|
2159
|
+
* Retrieves a list of up to 50 pricing plan orders and details, given the specified sorting and filtering.
|
|
2160
|
+
*
|
|
2161
|
+
* By default, this endpoint will retrieve all orders and return them sorted by `createdDate` in `DESC`, descending order.
|
|
2162
|
+
* `sort.fieldName` supports `endDate` and `createdDate` fields and defaults to `ASC`, ascending order.
|
|
2161
2163
|
* @public
|
|
2162
2164
|
* @param options - Filtering, sorting, and pagination options.
|
|
2163
|
-
* @permissionId PRICING_PLANS.
|
|
2165
|
+
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
2164
2166
|
* @applicableIdentity APP
|
|
2165
|
-
* @
|
|
2166
|
-
* @fqn com.wixpress.membership.v2.orders.member.MemberOrdersService.ListOrders
|
|
2167
|
+
* @fqn com.wixpress.membership.v2.orders.OrderManagementService.ListOrders
|
|
2167
2168
|
*/
|
|
2168
|
-
declare function
|
|
2169
|
-
interface
|
|
2169
|
+
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>>;
|
|
2170
|
+
interface ManagementListOrdersOptions {
|
|
2170
2171
|
/**
|
|
2171
|
-
* Filter by
|
|
2172
|
+
* Filter by a buyer's member ID, from the Members API.
|
|
2173
|
+
* @format GUID
|
|
2174
|
+
*/
|
|
2175
|
+
buyerIds?: string[];
|
|
2176
|
+
/**
|
|
2177
|
+
* Filter by plan IDs, from the Plans API.
|
|
2172
2178
|
* @format GUID
|
|
2173
2179
|
*/
|
|
2174
2180
|
planIds?: string[];
|
|
2175
|
-
/** Filter
|
|
2181
|
+
/** Filter by whether or not the auto-renewal of recurring orders was canceled. */
|
|
2176
2182
|
autoRenewCanceled?: boolean | null;
|
|
2177
2183
|
/** Filter by order status. */
|
|
2178
2184
|
orderStatuses?: OrderStatusWithLiterals[];
|
|
2179
2185
|
/** Filter by payment status. */
|
|
2180
2186
|
paymentStatuses?: PaymentStatusWithLiterals[];
|
|
2181
2187
|
/**
|
|
2182
|
-
*
|
|
2188
|
+
* Number of orders to return. See Sorting and Paging for more information.
|
|
2189
|
+
*
|
|
2190
|
+
* Max: `50`
|
|
2183
2191
|
* @min 1
|
|
2184
2192
|
* @max 50
|
|
2185
2193
|
*/
|
|
2186
2194
|
limit?: number | null;
|
|
2187
|
-
/** Number of
|
|
2195
|
+
/** Number of orders to skip in the current sort order. */
|
|
2188
2196
|
offset?: number | null;
|
|
2189
|
-
/**
|
|
2197
|
+
/**
|
|
2198
|
+
* Sort order.
|
|
2199
|
+
*
|
|
2200
|
+
* Use `ASC` for ascending order or `DESC` for descending order.
|
|
2201
|
+
*
|
|
2202
|
+
* Default: `DESC`.
|
|
2203
|
+
*/
|
|
2190
2204
|
sorting?: Sorting;
|
|
2191
2205
|
/**
|
|
2192
2206
|
* Predefined set of fields to return.
|
|
@@ -2196,26 +2210,106 @@ interface MemberListOrdersOptions {
|
|
|
2196
2210
|
fieldSet?: SetWithLiterals;
|
|
2197
2211
|
}
|
|
2198
2212
|
/**
|
|
2199
|
-
*
|
|
2213
|
+
* 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.
|
|
2200
2214
|
*
|
|
2201
|
-
*
|
|
2215
|
+
* New `endDate` must be later than the order's current `endDate`. Can't postpone orders that are unlimited.
|
|
2216
|
+
* Can't postpone an order with `status`: `PAUSED`.
|
|
2217
|
+
* @param _id - Order ID.
|
|
2218
|
+
* @param endDate - New end date and time.
|
|
2202
2219
|
*
|
|
2203
|
-
*
|
|
2220
|
+
* Must be later than the current end date and time.
|
|
2221
|
+
* @public
|
|
2222
|
+
* @requiredField _id
|
|
2223
|
+
* @requiredField endDate
|
|
2224
|
+
* @param options - Options for postponing the end date of an order.
|
|
2225
|
+
* @permissionId PRICING_PLANS.MANAGE_ORDERS
|
|
2226
|
+
* @applicableIdentity APP
|
|
2227
|
+
* @fqn com.wixpress.membership.v2.orders.OrderManagementService.PostponeEndDate
|
|
2228
|
+
*/
|
|
2229
|
+
declare function postponeEndDate(_id: string, endDate: Date): Promise<void>;
|
|
2230
|
+
/**
|
|
2231
|
+
* Cancels an existing order.
|
|
2204
2232
|
*
|
|
2205
|
-
*
|
|
2206
|
-
*
|
|
2233
|
+
* For orders with recurring payments, a cancellation can be set to occur either `IMMEDIATELY` or at the `NEXT_PAYMENT_DATE`.
|
|
2234
|
+
* For orders with one-time payments, a cancellation can only be set for `IMMEDIATELY`.
|
|
2235
|
+
*
|
|
2236
|
+
* #### Canceling during the free trial period.
|
|
2237
|
+
*
|
|
2238
|
+
* When a buyer cancels their order during the free trial period, the buyer's subscription expires at the end
|
|
2239
|
+
* of the free trial period and they will not be billed. The buyer may continue using the benefits until the end
|
|
2240
|
+
* of the free trial period.
|
|
2241
|
+
*
|
|
2242
|
+
* When a Wix user cancels an ordered plan during the free trial period, they choose whether to apply the cancellation
|
|
2243
|
+
* `IMMEDIATELY` or at the `NEXT_PAYMENT_DATE`. Canceling `IMMEDIATELY` will end the subscription for the buyer
|
|
2244
|
+
* immediately, even during the free trial period and the buyer won't be billed. Canceling at the
|
|
2245
|
+
* `NEXT_PAYMENT_DATE` allows the buyer to continue using the benefits of the subscription until the end of the free trial period.
|
|
2246
|
+
* Then, the subscription ends and the buyer is not billed.
|
|
2207
2247
|
* @param _id - Order ID.
|
|
2208
|
-
* @param effectiveAt -
|
|
2248
|
+
* @param effectiveAt - __Required.__ When the order will be canceled. One-time orders can only be canceled `IMMEDIATELY`.
|
|
2209
2249
|
* @public
|
|
2210
2250
|
* @requiredField _id
|
|
2211
2251
|
* @requiredField effectiveAt
|
|
2212
|
-
* @param options - Options for
|
|
2213
|
-
* @permissionId PRICING_PLANS.
|
|
2252
|
+
* @param options - Options for canceling orders.
|
|
2253
|
+
* @permissionId PRICING_PLANS.MANAGE_ORDERS
|
|
2214
2254
|
* @applicableIdentity APP
|
|
2215
|
-
* @
|
|
2216
|
-
* @fqn com.wixpress.membership.v2.orders.member.MemberOrdersService.RequestCancellation
|
|
2255
|
+
* @fqn com.wixpress.membership.v2.orders.OrderManagementService.CancelOrder
|
|
2217
2256
|
*/
|
|
2218
|
-
declare function
|
|
2257
|
+
declare function cancelOrder(_id: string, effectiveAt: CancellationEffectiveAtWithLiterals): Promise<void>;
|
|
2258
|
+
/**
|
|
2259
|
+
* Marks an offline order as paid.
|
|
2260
|
+
* > __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.
|
|
2261
|
+
*
|
|
2262
|
+
* Marking an offline order as paid causes the following changes:
|
|
2263
|
+
* - The order's `lastPaymentStatus` changes to `"PAID"`.
|
|
2264
|
+
* - The order's status changes to either `"PENDING"` or `"ACTIVE"`, depending on the order's `startDate`.
|
|
2265
|
+
*
|
|
2266
|
+
* An error occurs if you attempt to:
|
|
2267
|
+
* - Mark an already-paid, offline order as paid. You cannot mark an offline order as paid twice.
|
|
2268
|
+
* - Mark an online order as paid. The Mark as Paid method is supported for offline orders only.
|
|
2269
|
+
* @param _id - Order ID.
|
|
2270
|
+
* @public
|
|
2271
|
+
* @requiredField _id
|
|
2272
|
+
* @permissionId PRICING_PLANS.MANAGE_ORDERS
|
|
2273
|
+
* @applicableIdentity APP
|
|
2274
|
+
* @fqn com.wixpress.membership.v2.orders.OrderManagementService.MarkAsPaid
|
|
2275
|
+
*/
|
|
2276
|
+
declare function markAsPaid(_id: string): Promise<void>;
|
|
2277
|
+
/**
|
|
2278
|
+
* Pauses an order. Calling this method changes the order status to `"PAUSED"` and updates the `pausePeriods` array.
|
|
2279
|
+
*
|
|
2280
|
+
* Only orders with `status`: `ACTIVE` can be paused.
|
|
2281
|
+
* For orders with recurring payments, it also pauses the payment schedule. Buyers are not charged when an order is paused.
|
|
2282
|
+
* Pausing an order affects the end date of the order by adding the time the order is paused to the `endDate`.
|
|
2283
|
+
* The `endDate` and the `earliestEndDate` for the order are adjusted to include the pause period when the order is resumed.
|
|
2284
|
+
*
|
|
2285
|
+
* To resume a paused order, call Resume Order.
|
|
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.PauseOrder
|
|
2292
|
+
*/
|
|
2293
|
+
declare function pauseOrder(_id: string): Promise<void>;
|
|
2294
|
+
/**
|
|
2295
|
+
* Resumes a paused order. For orders with recurring payments, it also restarts the payment schedule.
|
|
2296
|
+
*
|
|
2297
|
+
* Resuming an order causes the following changes:
|
|
2298
|
+
* - The order status changes to `"ACTIVE"`.
|
|
2299
|
+
* - The `pausePeriods` array is updated.
|
|
2300
|
+
* - The `endDate` for the order is adjusted to include the pause period.
|
|
2301
|
+
* - For orders with recurring payments, the payment schedule is restarted.
|
|
2302
|
+
* - The `earliestEndDate` is adjusted to include the pause period. (This property is reserved for future use).
|
|
2303
|
+
*
|
|
2304
|
+
* To pause an order, call Pause Order.
|
|
2305
|
+
* @param _id - Order ID.
|
|
2306
|
+
* @public
|
|
2307
|
+
* @requiredField _id
|
|
2308
|
+
* @permissionId PRICING_PLANS.MANAGE_ORDERS
|
|
2309
|
+
* @applicableIdentity APP
|
|
2310
|
+
* @fqn com.wixpress.membership.v2.orders.OrderManagementService.ResumeOrder
|
|
2311
|
+
*/
|
|
2312
|
+
declare function resumeOrder(_id: string): Promise<void>;
|
|
2219
2313
|
/**
|
|
2220
2314
|
* Creates an online order for a site member.
|
|
2221
2315
|
*
|
|
@@ -2411,18 +2505,19 @@ interface GetPricePreviewOptions {
|
|
|
2411
2505
|
couponCode?: string | null;
|
|
2412
2506
|
}
|
|
2413
2507
|
/**
|
|
2414
|
-
* Retrieves an order by ID.
|
|
2508
|
+
* Retrieves an order for the currently logged-in member by ID.
|
|
2415
2509
|
* @param _id - Order ID.
|
|
2416
2510
|
* @public
|
|
2417
2511
|
* @requiredField _id
|
|
2418
|
-
* @param options - Options
|
|
2419
|
-
* @permissionId PRICING_PLANS.
|
|
2512
|
+
* @param options - Options for getting a logged-in member's order.
|
|
2513
|
+
* @permissionId PRICING_PLANS.READ_OWN_ORDERS
|
|
2420
2514
|
* @applicableIdentity APP
|
|
2421
|
-
* @
|
|
2422
|
-
* @
|
|
2515
|
+
* @applicableIdentity MEMBER
|
|
2516
|
+
* @returns Requested order.
|
|
2517
|
+
* @fqn com.wixpress.membership.v2.orders.member.MemberOrdersService.GetOrder
|
|
2423
2518
|
*/
|
|
2424
|
-
declare function
|
|
2425
|
-
interface
|
|
2519
|
+
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>>;
|
|
2520
|
+
interface MemberGetOrderOptions {
|
|
2426
2521
|
/**
|
|
2427
2522
|
* Predefined set of fields to return.
|
|
2428
2523
|
*
|
|
@@ -2431,51 +2526,36 @@ interface ManagementGetOrderOptions {
|
|
|
2431
2526
|
fieldSet?: SetWithLiterals;
|
|
2432
2527
|
}
|
|
2433
2528
|
/**
|
|
2434
|
-
* Retrieves a list of up to
|
|
2435
|
-
*
|
|
2436
|
-
* By default, this endpoint will retrieve all orders and return them sorted by `createdDate` in `DESC`, descending order.
|
|
2437
|
-
* `sort.fieldName` supports `endDate` and `createdDate` fields and defaults to `ASC`, ascending order.
|
|
2529
|
+
* Retrieves a list of up to 100 pricing plan orders for currently logged-in member.
|
|
2438
2530
|
* @public
|
|
2439
2531
|
* @param options - Filtering, sorting, and pagination options.
|
|
2440
|
-
* @permissionId PRICING_PLANS.
|
|
2532
|
+
* @permissionId PRICING_PLANS.READ_OWN_ORDERS
|
|
2441
2533
|
* @applicableIdentity APP
|
|
2442
|
-
* @
|
|
2534
|
+
* @applicableIdentity MEMBER
|
|
2535
|
+
* @fqn com.wixpress.membership.v2.orders.member.MemberOrdersService.ListOrders
|
|
2443
2536
|
*/
|
|
2444
|
-
declare function
|
|
2445
|
-
interface
|
|
2446
|
-
/**
|
|
2447
|
-
* Filter by a buyer's member ID, from the Members API.
|
|
2448
|
-
* @format GUID
|
|
2449
|
-
*/
|
|
2450
|
-
buyerIds?: string[];
|
|
2537
|
+
declare function memberListOrders(options?: MemberListOrdersOptions): Promise<NonNullablePaths<MemberListOrdersResponse, `orders` | `orders.${number}._id` | `orders.${number}.planId` | `orders.${number}.subscriptionId` | `orders.${number}.buyer.memberId` | `orders.${number}.buyer.contactId` | `orders.${number}.priceDetails.singlePaymentForDuration.unit` | `orders.${number}.priceDetails.subtotal` | `orders.${number}.priceDetails.discount` | `orders.${number}.priceDetails.tax.name` | `orders.${number}.priceDetails.tax.includedInPrice` | `orders.${number}.priceDetails.tax.rate` | `orders.${number}.priceDetails.tax.amount` | `orders.${number}.priceDetails.total` | `orders.${number}.priceDetails.planPrice` | `orders.${number}.priceDetails.currency` | `orders.${number}.priceDetails.coupon.code` | `orders.${number}.priceDetails.coupon.amount` | `orders.${number}.priceDetails.coupon._id` | `orders.${number}.type` | `orders.${number}.status` | `orders.${number}.cancellation.cause` | `orders.${number}.cancellation.effectiveAt` | `orders.${number}.lastPaymentStatus` | `orders.${number}.currentCycle.index` | `orders.${number}.planName` | `orders.${number}.planDescription` | `orders.${number}.planPrice`, 6>>;
|
|
2538
|
+
interface MemberListOrdersOptions {
|
|
2451
2539
|
/**
|
|
2452
|
-
* Filter by plan IDs
|
|
2540
|
+
* Filter by plan IDs.
|
|
2453
2541
|
* @format GUID
|
|
2454
2542
|
*/
|
|
2455
2543
|
planIds?: string[];
|
|
2456
|
-
/** Filter
|
|
2544
|
+
/** Filter for orders where auto renewal was canceled. */
|
|
2457
2545
|
autoRenewCanceled?: boolean | null;
|
|
2458
2546
|
/** Filter by order status. */
|
|
2459
2547
|
orderStatuses?: OrderStatusWithLiterals[];
|
|
2460
2548
|
/** Filter by payment status. */
|
|
2461
2549
|
paymentStatuses?: PaymentStatusWithLiterals[];
|
|
2462
2550
|
/**
|
|
2463
|
-
*
|
|
2464
|
-
*
|
|
2465
|
-
* Max: `50`
|
|
2551
|
+
* Limit the number of pricing plans returned. Default limit is 50.
|
|
2466
2552
|
* @min 1
|
|
2467
2553
|
* @max 50
|
|
2468
2554
|
*/
|
|
2469
2555
|
limit?: number | null;
|
|
2470
|
-
/** Number of
|
|
2556
|
+
/** Number of entries to offset. */
|
|
2471
2557
|
offset?: number | null;
|
|
2472
|
-
/**
|
|
2473
|
-
* Sort order.
|
|
2474
|
-
*
|
|
2475
|
-
* Use `ASC` for ascending order or `DESC` for descending order.
|
|
2476
|
-
*
|
|
2477
|
-
* Default: `DESC`.
|
|
2478
|
-
*/
|
|
2558
|
+
/** Sorting direction (defaults to ASC) and field to sort by. */
|
|
2479
2559
|
sorting?: Sorting;
|
|
2480
2560
|
/**
|
|
2481
2561
|
* Predefined set of fields to return.
|
|
@@ -2485,105 +2565,25 @@ interface ManagementListOrdersOptions {
|
|
|
2485
2565
|
fieldSet?: SetWithLiterals;
|
|
2486
2566
|
}
|
|
2487
2567
|
/**
|
|
2488
|
-
*
|
|
2489
|
-
*
|
|
2490
|
-
* New `endDate` must be later than the order's current `endDate`. Can't postpone orders that are unlimited.
|
|
2491
|
-
* Can't postpone an order with `status`: `PAUSED`.
|
|
2492
|
-
* @param _id - Order ID.
|
|
2493
|
-
* @param endDate - New end date and time.
|
|
2494
|
-
*
|
|
2495
|
-
* Must be later than the current end date and time.
|
|
2496
|
-
* @public
|
|
2497
|
-
* @requiredField _id
|
|
2498
|
-
* @requiredField endDate
|
|
2499
|
-
* @param options - Options for postponing the end date of an order.
|
|
2500
|
-
* @permissionId PRICING_PLANS.MANAGE_ORDERS
|
|
2501
|
-
* @applicableIdentity APP
|
|
2502
|
-
* @fqn com.wixpress.membership.v2.orders.OrderManagementService.PostponeEndDate
|
|
2503
|
-
*/
|
|
2504
|
-
declare function postponeEndDate(_id: string, endDate: Date): Promise<void>;
|
|
2505
|
-
/**
|
|
2506
|
-
* Cancels an existing order.
|
|
2507
|
-
*
|
|
2508
|
-
* For orders with recurring payments, a cancellation can be set to occur either `IMMEDIATELY` or at the `NEXT_PAYMENT_DATE`.
|
|
2509
|
-
* For orders with one-time payments, a cancellation can only be set for `IMMEDIATELY`.
|
|
2568
|
+
* Cancels an order. Recurring orders can be canceled either immediately or at the next payment date. One time orders can only be canceled immediately.
|
|
2510
2569
|
*
|
|
2511
|
-
*
|
|
2570
|
+
* There may be some operations that continue to be processed before the status of the order is changed to `"CANCELED"`. For example, payments might need to be refunded before the order is fully canceled.
|
|
2512
2571
|
*
|
|
2513
|
-
* When a buyer cancels their order during the free trial period, the buyer's subscription expires at the end
|
|
2514
|
-
* of the free trial period and they will not be billed. The buyer may continue using the benefits until the end
|
|
2515
|
-
* of the free trial period.
|
|
2572
|
+
* Canceling during the free trial period: When a buyer cancels their order during the free trial period, the buyer's subscription expires at the end of the free trial period and they won't be billed. The buyer may continue using the benefits until the end of the free trial period.
|
|
2516
2573
|
*
|
|
2517
|
-
*
|
|
2518
|
-
*
|
|
2519
|
-
* immediately, even during the free trial period and the buyer won't be billed. Canceling at the
|
|
2520
|
-
* `NEXT_PAYMENT_DATE` allows the buyer to continue using the benefits of the subscription until the end of the free trial period.
|
|
2521
|
-
* Then, the subscription ends and the buyer is not billed.
|
|
2574
|
+
* >**Note:**
|
|
2575
|
+
* >This method requires [visitor or member authentication](https://dev.wix.com/docs/rest/articles/getting-started/access-types-and-permissions).
|
|
2522
2576
|
* @param _id - Order ID.
|
|
2523
|
-
* @param effectiveAt -
|
|
2577
|
+
* @param effectiveAt - Required. Whether to cancel the order effective immediately or at the next payment date. One-time orders can only be canceled immediately.
|
|
2524
2578
|
* @public
|
|
2525
2579
|
* @requiredField _id
|
|
2526
2580
|
* @requiredField effectiveAt
|
|
2527
|
-
* @param options - Options for
|
|
2528
|
-
* @permissionId PRICING_PLANS.
|
|
2529
|
-
* @applicableIdentity APP
|
|
2530
|
-
* @fqn com.wixpress.membership.v2.orders.OrderManagementService.CancelOrder
|
|
2531
|
-
*/
|
|
2532
|
-
declare function cancelOrder(_id: string, effectiveAt: CancellationEffectiveAtWithLiterals): Promise<void>;
|
|
2533
|
-
/**
|
|
2534
|
-
* Marks an offline order as paid.
|
|
2535
|
-
* > __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.
|
|
2536
|
-
*
|
|
2537
|
-
* Marking an offline order as paid causes the following changes:
|
|
2538
|
-
* - The order's `lastPaymentStatus` changes to `"PAID"`.
|
|
2539
|
-
* - The order's status changes to either `"PENDING"` or `"ACTIVE"`, depending on the order's `startDate`.
|
|
2540
|
-
*
|
|
2541
|
-
* An error occurs if you attempt to:
|
|
2542
|
-
* - Mark an already-paid, offline order as paid. You cannot mark an offline order as paid twice.
|
|
2543
|
-
* - Mark an online order as paid. The Mark as Paid method is supported for offline orders only.
|
|
2544
|
-
* @param _id - Order ID.
|
|
2545
|
-
* @public
|
|
2546
|
-
* @requiredField _id
|
|
2547
|
-
* @permissionId PRICING_PLANS.MANAGE_ORDERS
|
|
2548
|
-
* @applicableIdentity APP
|
|
2549
|
-
* @fqn com.wixpress.membership.v2.orders.OrderManagementService.MarkAsPaid
|
|
2550
|
-
*/
|
|
2551
|
-
declare function markAsPaid(_id: string): Promise<void>;
|
|
2552
|
-
/**
|
|
2553
|
-
* Pauses an order. Calling this method changes the order status to `"PAUSED"` and updates the `pausePeriods` array.
|
|
2554
|
-
*
|
|
2555
|
-
* Only orders with `status`: `ACTIVE` can be paused.
|
|
2556
|
-
* For orders with recurring payments, it also pauses the payment schedule. Buyers are not charged when an order is paused.
|
|
2557
|
-
* Pausing an order affects the end date of the order by adding the time the order is paused to the `endDate`.
|
|
2558
|
-
* The `endDate` and the `earliestEndDate` for the order are adjusted to include the pause period when the order is resumed.
|
|
2559
|
-
*
|
|
2560
|
-
* To resume a paused order, call Resume Order.
|
|
2561
|
-
* @param _id - Order ID.
|
|
2562
|
-
* @public
|
|
2563
|
-
* @requiredField _id
|
|
2564
|
-
* @permissionId PRICING_PLANS.MANAGE_ORDERS
|
|
2565
|
-
* @applicableIdentity APP
|
|
2566
|
-
* @fqn com.wixpress.membership.v2.orders.OrderManagementService.PauseOrder
|
|
2567
|
-
*/
|
|
2568
|
-
declare function pauseOrder(_id: string): Promise<void>;
|
|
2569
|
-
/**
|
|
2570
|
-
* Resumes a paused order. For orders with recurring payments, it also restarts the payment schedule.
|
|
2571
|
-
*
|
|
2572
|
-
* Resuming an order causes the following changes:
|
|
2573
|
-
* - The order status changes to `"ACTIVE"`.
|
|
2574
|
-
* - The `pausePeriods` array is updated.
|
|
2575
|
-
* - The `endDate` for the order is adjusted to include the pause period.
|
|
2576
|
-
* - For orders with recurring payments, the payment schedule is restarted.
|
|
2577
|
-
* - The `earliestEndDate` is adjusted to include the pause period. (This property is reserved for future use).
|
|
2578
|
-
*
|
|
2579
|
-
* To pause an order, call Pause Order.
|
|
2580
|
-
* @param _id - Order ID.
|
|
2581
|
-
* @public
|
|
2582
|
-
* @requiredField _id
|
|
2583
|
-
* @permissionId PRICING_PLANS.MANAGE_ORDERS
|
|
2581
|
+
* @param options - Options for requesting a cancellation.
|
|
2582
|
+
* @permissionId PRICING_PLANS.MANAGE_OWN_ORDERS
|
|
2584
2583
|
* @applicableIdentity APP
|
|
2585
|
-
* @
|
|
2584
|
+
* @applicableIdentity MEMBER
|
|
2585
|
+
* @fqn com.wixpress.membership.v2.orders.member.MemberOrdersService.RequestCancellation
|
|
2586
2586
|
*/
|
|
2587
|
-
declare function
|
|
2587
|
+
declare function requestCancellation(_id: string, effectiveAt: CancellationEffectiveAtWithLiterals): Promise<void>;
|
|
2588
2588
|
|
|
2589
2589
|
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 };
|