@wix/auto_sdk_pricing-plans_orders 1.0.118 → 1.0.120
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 +489 -470
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +497 -560
- package/build/cjs/index.typings.js +361 -342
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +249 -312
- package/build/cjs/meta.js +361 -342
- package/build/cjs/meta.js.map +1 -1
- package/build/cjs/schemas.d.ts +38 -30
- package/build/cjs/schemas.js +73 -61
- package/build/cjs/schemas.js.map +1 -1
- package/build/es/index.d.mts +155 -155
- package/build/es/index.mjs +489 -470
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +497 -560
- package/build/es/index.typings.mjs +361 -342
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +249 -312
- package/build/es/meta.mjs +361 -342
- package/build/es/meta.mjs.map +1 -1
- package/build/es/schemas.d.mts +38 -30
- package/build/es/schemas.mjs +73 -61
- package/build/es/schemas.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +155 -155
- package/build/internal/cjs/index.js +489 -470
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +497 -560
- package/build/internal/cjs/index.typings.js +361 -342
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +249 -312
- package/build/internal/cjs/meta.js +361 -342
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/cjs/schemas.d.ts +38 -30
- package/build/internal/cjs/schemas.js +73 -61
- package/build/internal/cjs/schemas.js.map +1 -1
- package/build/internal/es/index.d.mts +155 -155
- package/build/internal/es/index.mjs +489 -470
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +497 -560
- package/build/internal/es/index.typings.mjs +361 -342
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +249 -312
- package/build/internal/es/meta.mjs +361 -342
- package/build/internal/es/meta.mjs.map +1 -1
- package/build/internal/es/schemas.d.mts +38 -30
- package/build/internal/es/schemas.mjs +73 -61
- 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.
|
|
@@ -690,6 +731,11 @@ interface Sorting {
|
|
|
690
731
|
fieldName?: string;
|
|
691
732
|
/** Sort order. */
|
|
692
733
|
order?: SortOrderWithLiterals;
|
|
734
|
+
/**
|
|
735
|
+
* Origin point for geo-distance sorting on a GEO field
|
|
736
|
+
* results are ordered by distance from this point (ASC = nearest first, DESC = farthest first).
|
|
737
|
+
*/
|
|
738
|
+
origin?: AddressLocation;
|
|
693
739
|
}
|
|
694
740
|
declare enum SortOrder {
|
|
695
741
|
ASC = "ASC",
|
|
@@ -697,8 +743,14 @@ declare enum SortOrder {
|
|
|
697
743
|
}
|
|
698
744
|
/** @enumType */
|
|
699
745
|
type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
700
|
-
interface
|
|
701
|
-
/**
|
|
746
|
+
interface AddressLocation {
|
|
747
|
+
/** Address latitude. */
|
|
748
|
+
latitude?: number | null;
|
|
749
|
+
/** Address longitude. */
|
|
750
|
+
longitude?: number | null;
|
|
751
|
+
}
|
|
752
|
+
interface ListOrdersResponse {
|
|
753
|
+
/** List of orders. */
|
|
702
754
|
orders?: Order[];
|
|
703
755
|
/** Object containing paging-related data (number of orders returned, offset). */
|
|
704
756
|
pagingMetadata?: PagingMetadataV2;
|
|
@@ -727,80 +779,78 @@ interface Cursors {
|
|
|
727
779
|
*/
|
|
728
780
|
prev?: string | null;
|
|
729
781
|
}
|
|
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 {
|
|
735
|
-
/** Query filter. */
|
|
736
|
-
query?: QueryV2;
|
|
782
|
+
interface GetOrdersStatsRequest {
|
|
737
783
|
}
|
|
738
|
-
interface
|
|
739
|
-
/**
|
|
740
|
-
|
|
741
|
-
/**
|
|
742
|
-
|
|
743
|
-
|
|
744
|
-
|
|
745
|
-
*
|
|
746
|
-
* Learn more about [filtering](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#filters).
|
|
747
|
-
*/
|
|
748
|
-
filter?: Record<string, any> | null;
|
|
784
|
+
interface GetOrdersStatsResponse {
|
|
785
|
+
/** Total number of orders. */
|
|
786
|
+
totalOrderCount?: number;
|
|
787
|
+
/** Number of active orders. */
|
|
788
|
+
activeOrderCount?: number;
|
|
789
|
+
}
|
|
790
|
+
interface GetAvailableOrderActionsRequest {
|
|
749
791
|
/**
|
|
750
|
-
*
|
|
751
|
-
*
|
|
752
|
-
* Learn more about [sorting](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#sorting).
|
|
792
|
+
* Order ID.
|
|
793
|
+
* @format GUID
|
|
753
794
|
*/
|
|
754
|
-
|
|
755
|
-
/** Array of projected fields. A list of specific field names to return. If `fieldsets` are also specified, the union of `fieldsets` and `fields` is returned. */
|
|
756
|
-
fields?: string[];
|
|
757
|
-
/** Array of named, predefined sets of projected fields. A array of predefined named sets of fields to be returned. Specifying multiple `fieldsets` will return the union of fields from all sets. If `fields` are also specified, the union of `fieldsets` and `fields` is returned. */
|
|
758
|
-
fieldsets?: string[];
|
|
795
|
+
_id?: string;
|
|
759
796
|
}
|
|
760
|
-
|
|
761
|
-
|
|
762
|
-
|
|
763
|
-
|
|
764
|
-
|
|
765
|
-
|
|
766
|
-
|
|
767
|
-
|
|
768
|
-
|
|
769
|
-
|
|
770
|
-
|
|
771
|
-
|
|
797
|
+
interface GetAvailableOrderActionsResponse {
|
|
798
|
+
/** Whether the order can be suspended. */
|
|
799
|
+
suspendable?: boolean;
|
|
800
|
+
/** If the order cannot be suspended, a reason is returned here. */
|
|
801
|
+
notSuspendableReason?: ReasonNotSuspendableWithLiterals;
|
|
802
|
+
/** Whether the order can be canceled by the buyer. */
|
|
803
|
+
cancelableByBuyer?: boolean;
|
|
804
|
+
}
|
|
805
|
+
declare enum ReasonNotSuspendable {
|
|
806
|
+
/** Undefined reason. */
|
|
807
|
+
UNDEFINED = "UNDEFINED",
|
|
808
|
+
/** Saved in the database but is awaiting payment. Non-active orders can't be suspended. */
|
|
809
|
+
PENDING = "PENDING",
|
|
810
|
+
/** Trial orders can't be suspended. */
|
|
811
|
+
TRIAL = "TRIAL",
|
|
812
|
+
/** Canceled orders can't be suspended. */
|
|
813
|
+
CANCELED = "CANCELED",
|
|
814
|
+
/** Ended orders can't be suspended. */
|
|
815
|
+
ENDED = "ENDED",
|
|
816
|
+
/** Paid for orders with future start dates can't be suspended. */
|
|
817
|
+
NOT_STARTED = "NOT_STARTED",
|
|
818
|
+
/** Order is already suspended. */
|
|
819
|
+
ALREADY_SUSPENDED = "ALREADY_SUSPENDED",
|
|
820
|
+
/** Orders based on recurring payments using older stripe versions can't be suspended. */
|
|
821
|
+
OLD_STRIPE = "OLD_STRIPE"
|
|
772
822
|
}
|
|
773
|
-
|
|
823
|
+
/** @enumType */
|
|
824
|
+
type ReasonNotSuspendableWithLiterals = ReasonNotSuspendable | 'UNDEFINED' | 'PENDING' | 'TRIAL' | 'CANCELED' | 'ENDED' | 'NOT_STARTED' | 'ALREADY_SUSPENDED' | 'OLD_STRIPE';
|
|
825
|
+
interface PostponeEndDateRequest {
|
|
774
826
|
/**
|
|
775
|
-
*
|
|
776
|
-
* @
|
|
827
|
+
* Order ID.
|
|
828
|
+
* @format GUID
|
|
777
829
|
*/
|
|
778
|
-
|
|
830
|
+
_id: string;
|
|
779
831
|
/**
|
|
780
|
-
*
|
|
832
|
+
* New end date and time.
|
|
781
833
|
*
|
|
782
|
-
*
|
|
783
|
-
* Not relevant for the first request.
|
|
784
|
-
* @maxLength 16000
|
|
834
|
+
* Must be later than the current end date and time.
|
|
785
835
|
*/
|
|
786
|
-
|
|
836
|
+
endDate: Date | null;
|
|
787
837
|
}
|
|
788
|
-
interface
|
|
789
|
-
/** Order data. */
|
|
790
|
-
plans?: Order[];
|
|
791
|
-
/** Paging-related data (number of orders returned, offset). */
|
|
792
|
-
pagingMetadata?: PagingMetadataV2;
|
|
838
|
+
interface PostponeEndDateResponse {
|
|
793
839
|
}
|
|
794
|
-
interface
|
|
840
|
+
interface OrderEndDatePostponed {
|
|
841
|
+
/** Order whose `endDate` was postponed. */
|
|
842
|
+
order?: Order;
|
|
843
|
+
}
|
|
844
|
+
interface CancelOrderRequest {
|
|
795
845
|
/**
|
|
796
846
|
* Order ID.
|
|
797
847
|
* @format GUID
|
|
798
848
|
*/
|
|
799
849
|
_id: string;
|
|
800
|
-
/**
|
|
850
|
+
/** __Required.__ When the order will be canceled. One-time orders can only be canceled `IMMEDIATELY`. */
|
|
801
851
|
effectiveAt: CancellationEffectiveAtWithLiterals;
|
|
802
852
|
}
|
|
803
|
-
interface
|
|
853
|
+
interface CancelOrderResponse {
|
|
804
854
|
}
|
|
805
855
|
/**
|
|
806
856
|
* Emitted when an order is canceled immediately or when cycle ends for an order with canceled auto renewal
|
|
@@ -811,6 +861,111 @@ interface OrderCanceled {
|
|
|
811
861
|
/** Canceled order. */
|
|
812
862
|
order?: Order;
|
|
813
863
|
}
|
|
864
|
+
interface MarkAsPaidRequest {
|
|
865
|
+
/**
|
|
866
|
+
* Order ID.
|
|
867
|
+
* @format GUID
|
|
868
|
+
*/
|
|
869
|
+
_id: string;
|
|
870
|
+
}
|
|
871
|
+
interface MarkAsPaidResponse {
|
|
872
|
+
}
|
|
873
|
+
interface OrderMarkedAsPaid {
|
|
874
|
+
/** Order that was marked as paid. */
|
|
875
|
+
order?: Order;
|
|
876
|
+
}
|
|
877
|
+
interface PauseOrderRequest {
|
|
878
|
+
/**
|
|
879
|
+
* Order ID.
|
|
880
|
+
* @format GUID
|
|
881
|
+
*/
|
|
882
|
+
_id: string;
|
|
883
|
+
}
|
|
884
|
+
interface PauseOrderResponse {
|
|
885
|
+
}
|
|
886
|
+
interface OrderPaused {
|
|
887
|
+
/** Paused order. */
|
|
888
|
+
order?: Order;
|
|
889
|
+
}
|
|
890
|
+
interface BulkPauseOrderRequest {
|
|
891
|
+
/**
|
|
892
|
+
* List of Order IDs.
|
|
893
|
+
* @format GUID
|
|
894
|
+
* @minSize 1
|
|
895
|
+
* @maxSize 100
|
|
896
|
+
*/
|
|
897
|
+
ids?: string[];
|
|
898
|
+
/** Set to true to return Order entity in response. */
|
|
899
|
+
returnFullEntity?: boolean;
|
|
900
|
+
}
|
|
901
|
+
interface BulkPauseOrderResponse {
|
|
902
|
+
/** Orders that were paused. */
|
|
903
|
+
results?: BulkOrderResult[];
|
|
904
|
+
/** Bulk action metadata. */
|
|
905
|
+
bulkActionMetadata?: BulkActionMetadata;
|
|
906
|
+
}
|
|
907
|
+
interface BulkOrderResult {
|
|
908
|
+
/** Item metadata */
|
|
909
|
+
itemMetadata?: ItemMetadata;
|
|
910
|
+
/** The order. */
|
|
911
|
+
order?: Order;
|
|
912
|
+
}
|
|
913
|
+
interface ItemMetadata {
|
|
914
|
+
/** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
|
|
915
|
+
_id?: string | null;
|
|
916
|
+
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
917
|
+
originalIndex?: number;
|
|
918
|
+
/** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
|
|
919
|
+
success?: boolean;
|
|
920
|
+
/** Details about the error in case of failure. */
|
|
921
|
+
error?: ApplicationError;
|
|
922
|
+
}
|
|
923
|
+
interface ApplicationError {
|
|
924
|
+
/** Error code. */
|
|
925
|
+
code?: string;
|
|
926
|
+
/** Description of the error. */
|
|
927
|
+
description?: string;
|
|
928
|
+
/** Data related to the error. */
|
|
929
|
+
data?: Record<string, any> | null;
|
|
930
|
+
}
|
|
931
|
+
interface BulkActionMetadata {
|
|
932
|
+
/** Number of items that were successfully processed. */
|
|
933
|
+
totalSuccesses?: number;
|
|
934
|
+
/** Number of items that couldn't be processed. */
|
|
935
|
+
totalFailures?: number;
|
|
936
|
+
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
937
|
+
undetailedFailures?: number;
|
|
938
|
+
}
|
|
939
|
+
interface ResumeOrderRequest {
|
|
940
|
+
/**
|
|
941
|
+
* Order ID.
|
|
942
|
+
* @format GUID
|
|
943
|
+
*/
|
|
944
|
+
_id: string;
|
|
945
|
+
}
|
|
946
|
+
interface ResumeOrderResponse {
|
|
947
|
+
}
|
|
948
|
+
interface OrderResumed {
|
|
949
|
+
/** Resumed order. */
|
|
950
|
+
order?: Order;
|
|
951
|
+
}
|
|
952
|
+
interface BulkResumeOrderRequest {
|
|
953
|
+
/**
|
|
954
|
+
* List of Order IDs.
|
|
955
|
+
* @format GUID
|
|
956
|
+
* @minSize 1
|
|
957
|
+
* @maxSize 100
|
|
958
|
+
*/
|
|
959
|
+
ids?: string[];
|
|
960
|
+
/** Set to true to return Order entity in response. */
|
|
961
|
+
returnFullEntity?: boolean;
|
|
962
|
+
}
|
|
963
|
+
interface BulkResumeOrderResponse {
|
|
964
|
+
/** Orders that were resumed. */
|
|
965
|
+
results?: BulkOrderResult[];
|
|
966
|
+
/** Bulk action metadata. */
|
|
967
|
+
bulkActionMetadata?: BulkActionMetadata;
|
|
968
|
+
}
|
|
814
969
|
interface MessageEnvelope {
|
|
815
970
|
/**
|
|
816
971
|
* App instance ID.
|
|
@@ -1205,85 +1360,44 @@ interface SetSubmissionResponse {
|
|
|
1205
1360
|
/** Order with submission id */
|
|
1206
1361
|
order?: Order;
|
|
1207
1362
|
}
|
|
1208
|
-
interface
|
|
1209
|
-
/**
|
|
1363
|
+
interface MemberGetOrderRequest {
|
|
1364
|
+
/**
|
|
1365
|
+
* Order ID.
|
|
1366
|
+
* @format GUID
|
|
1367
|
+
*/
|
|
1368
|
+
_id: string;
|
|
1369
|
+
/**
|
|
1370
|
+
* Predefined set of fields to return.
|
|
1371
|
+
*
|
|
1372
|
+
* Default: If `fieldSet` is omitted, no order form submission data is returned.
|
|
1373
|
+
*/
|
|
1374
|
+
fieldSet?: SetWithLiterals;
|
|
1375
|
+
}
|
|
1376
|
+
interface MemberGetOrderResponse {
|
|
1377
|
+
/** Requested order. */
|
|
1210
1378
|
order?: Order;
|
|
1211
1379
|
}
|
|
1212
|
-
interface
|
|
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 {
|
|
1237
|
-
/**
|
|
1238
|
-
* Order ID.
|
|
1239
|
-
* @format GUID
|
|
1240
|
-
*/
|
|
1241
|
-
_id: string;
|
|
1242
|
-
/**
|
|
1243
|
-
* Predefined set of fields to return.
|
|
1244
|
-
*
|
|
1245
|
-
* Default: If `fieldSet` is omitted, no order form submission data is returned.
|
|
1246
|
-
*/
|
|
1247
|
-
fieldSet?: SetWithLiterals;
|
|
1248
|
-
}
|
|
1249
|
-
interface GetOrderResponse {
|
|
1250
|
-
/** Order. */
|
|
1251
|
-
order?: Order;
|
|
1252
|
-
}
|
|
1253
|
-
interface ListOrdersRequest {
|
|
1254
|
-
/**
|
|
1255
|
-
* Filter by a buyer's member ID, from the Members API.
|
|
1256
|
-
* @format GUID
|
|
1257
|
-
*/
|
|
1258
|
-
buyerIds?: string[];
|
|
1380
|
+
interface MemberListOrdersRequest {
|
|
1259
1381
|
/**
|
|
1260
|
-
* Filter by plan IDs
|
|
1382
|
+
* Filter by plan IDs.
|
|
1261
1383
|
* @format GUID
|
|
1262
1384
|
*/
|
|
1263
1385
|
planIds?: string[];
|
|
1264
|
-
/** Filter
|
|
1386
|
+
/** Filter for orders where auto renewal was canceled. */
|
|
1265
1387
|
autoRenewCanceled?: boolean | null;
|
|
1266
1388
|
/** Filter by order status. */
|
|
1267
1389
|
orderStatuses?: OrderStatusWithLiterals[];
|
|
1268
1390
|
/** Filter by payment status. */
|
|
1269
1391
|
paymentStatuses?: PaymentStatusWithLiterals[];
|
|
1270
1392
|
/**
|
|
1271
|
-
*
|
|
1272
|
-
*
|
|
1273
|
-
* Max: `50`
|
|
1393
|
+
* Limit the number of pricing plans returned. Default limit is 50.
|
|
1274
1394
|
* @min 1
|
|
1275
1395
|
* @max 50
|
|
1276
1396
|
*/
|
|
1277
1397
|
limit?: number | null;
|
|
1278
|
-
/** Number of
|
|
1398
|
+
/** Number of entries to offset. */
|
|
1279
1399
|
offset?: number | null;
|
|
1280
|
-
/**
|
|
1281
|
-
* Sort order.
|
|
1282
|
-
*
|
|
1283
|
-
* Use `ASC` for ascending order or `DESC` for descending order.
|
|
1284
|
-
*
|
|
1285
|
-
* Default: `DESC`.
|
|
1286
|
-
*/
|
|
1400
|
+
/** Sorting direction (defaults to ASC) and field to sort by. */
|
|
1287
1401
|
sorting?: Sorting;
|
|
1288
1402
|
/**
|
|
1289
1403
|
* Predefined set of fields to return.
|
|
@@ -1292,199 +1406,22 @@ interface ListOrdersRequest {
|
|
|
1292
1406
|
*/
|
|
1293
1407
|
fieldSet?: SetWithLiterals;
|
|
1294
1408
|
}
|
|
1295
|
-
interface
|
|
1296
|
-
/**
|
|
1409
|
+
interface MemberListOrdersResponse {
|
|
1410
|
+
/** Requested orders. */
|
|
1297
1411
|
orders?: Order[];
|
|
1298
1412
|
/** Object containing paging-related data (number of orders returned, offset). */
|
|
1299
1413
|
pagingMetadata?: PagingMetadataV2;
|
|
1300
1414
|
}
|
|
1301
|
-
interface
|
|
1302
|
-
/** Query filter. */
|
|
1303
|
-
query?: QueryV2;
|
|
1304
|
-
}
|
|
1305
|
-
interface OrdersQueryOrdersResponse {
|
|
1306
|
-
/** Retrieved orders. */
|
|
1307
|
-
plans?: Order[];
|
|
1308
|
-
/** Paging-related data (number of orders returned, offset). */
|
|
1309
|
-
pagingMetadata?: PagingMetadataV2;
|
|
1310
|
-
}
|
|
1311
|
-
interface GetOrdersStatsRequest {
|
|
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 {
|
|
1415
|
+
interface RequestCancellationRequest {
|
|
1374
1416
|
/**
|
|
1375
1417
|
* Order ID.
|
|
1376
1418
|
* @format GUID
|
|
1377
1419
|
*/
|
|
1378
1420
|
_id: string;
|
|
1379
|
-
/**
|
|
1421
|
+
/** Required. Whether to cancel the order effective immediately or at the next payment date. One-time orders can only be canceled immediately. */
|
|
1380
1422
|
effectiveAt: CancellationEffectiveAtWithLiterals;
|
|
1381
1423
|
}
|
|
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;
|
|
1424
|
+
interface RequestCancellationResponse {
|
|
1488
1425
|
}
|
|
1489
1426
|
/** @docsIgnore */
|
|
1490
1427
|
type CreateOnlineOrderApplicationErrors = {
|
|
@@ -1837,93 +1774,16 @@ interface AccountInfoMetadata {
|
|
|
1837
1774
|
/** ID of the parent Wix account. Only included when 'accountId' belongs to a child account. */
|
|
1838
1775
|
parentAccountId?: string;
|
|
1839
1776
|
}
|
|
1840
|
-
interface
|
|
1841
|
-
data:
|
|
1777
|
+
interface OrderAutoRenewCanceledEnvelope {
|
|
1778
|
+
data: OrderAutoRenewCanceled;
|
|
1842
1779
|
metadata: EventMetadata;
|
|
1843
1780
|
}
|
|
1844
1781
|
/**
|
|
1845
|
-
* Triggered when an order is canceled
|
|
1782
|
+
* Triggered when an order is canceled and `effectiveAt` is set to `NEXT_PAYMENT_DATE`.
|
|
1846
1783
|
*
|
|
1847
|
-
* This webhook is triggered
|
|
1848
|
-
* +
|
|
1849
|
-
* +
|
|
1850
|
-
* @permissionScope Manage_Wix_Rentals_App_Forms_submissions
|
|
1851
|
-
* @permissionScopeId SCOPE.RENTALS.MANAGE
|
|
1852
|
-
* @permissionScope Manage Orders
|
|
1853
|
-
* @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
|
|
1854
|
-
* @permissionScope Read Orders
|
|
1855
|
-
* @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS
|
|
1856
|
-
* @permissionScope Manage plans and orders of Pricing Plans
|
|
1857
|
-
* @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-PLANS-AND-ORDERS
|
|
1858
|
-
* @permissionScope Manage Events
|
|
1859
|
-
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1860
|
-
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
1861
|
-
* @webhook
|
|
1862
|
-
* @eventType wix.pricing_plans.v2.order_canceled
|
|
1863
|
-
* @serviceIdentifier com.wixpress.membership.v2.orders.member.MemberOrdersService
|
|
1864
|
-
* @slug canceled
|
|
1865
|
-
*/
|
|
1866
|
-
declare function onOrderCanceled(handler: (event: OrderCanceledEnvelope) => void | Promise<void>): void;
|
|
1867
|
-
interface OrderCreatedEnvelope {
|
|
1868
|
-
entity: Order;
|
|
1869
|
-
metadata: EventMetadata;
|
|
1870
|
-
}
|
|
1871
|
-
/**
|
|
1872
|
-
* Triggered when an order is created.
|
|
1873
|
-
* @permissionScope Manage_Wix_Rentals_App_Forms_submissions
|
|
1874
|
-
* @permissionScopeId SCOPE.RENTALS.MANAGE
|
|
1875
|
-
* @permissionScope Manage Orders
|
|
1876
|
-
* @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
|
|
1877
|
-
* @permissionScope Read Orders
|
|
1878
|
-
* @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS
|
|
1879
|
-
* @permissionScope Manage plans and orders of Pricing Plans
|
|
1880
|
-
* @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-PLANS-AND-ORDERS
|
|
1881
|
-
* @permissionScope Manage Events
|
|
1882
|
-
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1883
|
-
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
1884
|
-
* @webhook
|
|
1885
|
-
* @eventType wix.pricing_plans.v2.order_created
|
|
1886
|
-
* @serviceIdentifier com.wixpress.membership.v2.orders.CheckoutService
|
|
1887
|
-
* @slug created
|
|
1888
|
-
*/
|
|
1889
|
-
declare function onOrderCreated(handler: (event: OrderCreatedEnvelope) => void | Promise<void>): void;
|
|
1890
|
-
interface OrderStartDateChangedEnvelope {
|
|
1891
|
-
data: OrderStartDateChanged;
|
|
1892
|
-
metadata: EventMetadata;
|
|
1893
|
-
}
|
|
1894
|
-
/**
|
|
1895
|
-
* Triggered when an order's `startDate` is changed.
|
|
1896
|
-
* @permissionScope Manage_Wix_Rentals_App_Forms_submissions
|
|
1897
|
-
* @permissionScopeId SCOPE.RENTALS.MANAGE
|
|
1898
|
-
* @permissionScope Manage Orders
|
|
1899
|
-
* @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
|
|
1900
|
-
* @permissionScope Read Orders
|
|
1901
|
-
* @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS
|
|
1902
|
-
* @permissionScope Manage plans and orders of Pricing Plans
|
|
1903
|
-
* @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-PLANS-AND-ORDERS
|
|
1904
|
-
* @permissionScope Manage Events
|
|
1905
|
-
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1906
|
-
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
1907
|
-
* @webhook
|
|
1908
|
-
* @eventType wix.pricing_plans.v2.order_start_date_changed
|
|
1909
|
-
* @serviceIdentifier com.wixpress.membership.v2.orders.CheckoutService
|
|
1910
|
-
* @slug start_date_changed
|
|
1911
|
-
*/
|
|
1912
|
-
declare function onOrderStartDateChanged(handler: (event: OrderStartDateChangedEnvelope) => void | Promise<void>): void;
|
|
1913
|
-
interface OrderUpdatedEnvelope {
|
|
1914
|
-
entity: Order;
|
|
1915
|
-
metadata: EventMetadata;
|
|
1916
|
-
}
|
|
1917
|
-
/**
|
|
1918
|
-
* Triggered for any of the following update events:
|
|
1919
|
-
*
|
|
1920
|
-
* + Order is paid for. Order Purchased is also triggered.
|
|
1921
|
-
* + Order reaches its start date or end date. Order Started and Order Ended, respectively, are also triggered.
|
|
1922
|
-
* + New payment cycle of an order starts. Order Cycle Started is also triggered.
|
|
1923
|
-
* + Offline order is marked as paid. Order Marked As Paid is also triggered.
|
|
1924
|
-
* + End date of the order is postponed. Order End Date Postponed is also triggered
|
|
1925
|
-
* + Order is paused, or a paused order is resumed. Order Paused and Order Resumed, respectively, are also triggered.
|
|
1926
|
-
* + Order is canceled, either immediately or at the end of the payment cycle. Order Canceled and Order Auto Renew Canceled, respectively, are also triggered.
|
|
1784
|
+
* This webhook is *not* triggered in the following scenarios:
|
|
1785
|
+
* + When an order is canceled and `effectiveAt` is set to `IMMEDIATELY`. Instead, at the time of cancellation, Order Canceled is triggered.
|
|
1786
|
+
* + 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.
|
|
1927
1787
|
* @permissionScope Manage_Wix_Rentals_App_Forms_submissions
|
|
1928
1788
|
* @permissionScopeId SCOPE.RENTALS.MANAGE
|
|
1929
1789
|
* @permissionScope Manage Orders
|
|
@@ -1936,21 +1796,21 @@ interface OrderUpdatedEnvelope {
|
|
|
1936
1796
|
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1937
1797
|
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
1938
1798
|
* @webhook
|
|
1939
|
-
* @eventType wix.pricing_plans.v2.
|
|
1940
|
-
* @serviceIdentifier com.wixpress.membership.v2.orders.
|
|
1941
|
-
* @slug
|
|
1799
|
+
* @eventType wix.pricing_plans.v2.order_auto_renew_canceled
|
|
1800
|
+
* @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
|
|
1801
|
+
* @slug auto_renew_canceled
|
|
1942
1802
|
*/
|
|
1943
|
-
declare function
|
|
1944
|
-
interface
|
|
1945
|
-
data:
|
|
1803
|
+
declare function onOrderAutoRenewCanceled(handler: (event: OrderAutoRenewCanceledEnvelope) => void | Promise<void>): void;
|
|
1804
|
+
interface OrderCanceledEnvelope {
|
|
1805
|
+
data: OrderCanceled;
|
|
1946
1806
|
metadata: EventMetadata;
|
|
1947
1807
|
}
|
|
1948
1808
|
/**
|
|
1949
|
-
* Triggered when an order is canceled
|
|
1809
|
+
* Triggered when an order is canceled.
|
|
1950
1810
|
*
|
|
1951
|
-
* This webhook is
|
|
1952
|
-
* +
|
|
1953
|
-
* +
|
|
1811
|
+
* This webhook is triggered either immediately or at the end of the current payment cycle, as follows:
|
|
1812
|
+
* + If the order is canceled and `effectiveAt` is set to `IMMEDIATELY`, the webhook is triggered immediately when canceled.
|
|
1813
|
+
* + 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.
|
|
1954
1814
|
* @permissionScope Manage_Wix_Rentals_App_Forms_submissions
|
|
1955
1815
|
* @permissionScopeId SCOPE.RENTALS.MANAGE
|
|
1956
1816
|
* @permissionScope Manage Orders
|
|
@@ -1963,11 +1823,11 @@ interface OrderAutoRenewCanceledEnvelope {
|
|
|
1963
1823
|
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1964
1824
|
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
1965
1825
|
* @webhook
|
|
1966
|
-
* @eventType wix.pricing_plans.v2.
|
|
1826
|
+
* @eventType wix.pricing_plans.v2.order_canceled
|
|
1967
1827
|
* @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
|
|
1968
|
-
* @slug
|
|
1828
|
+
* @slug canceled
|
|
1969
1829
|
*/
|
|
1970
|
-
declare function
|
|
1830
|
+
declare function onOrderCanceled(handler: (event: OrderCanceledEnvelope) => void | Promise<void>): void;
|
|
1971
1831
|
interface OrderCycleStartedEnvelope {
|
|
1972
1832
|
data: OrderCycleStarted;
|
|
1973
1833
|
metadata: EventMetadata;
|
|
@@ -2162,19 +2022,95 @@ interface OrderStartedEnvelope {
|
|
|
2162
2022
|
* @slug started
|
|
2163
2023
|
*/
|
|
2164
2024
|
declare function onOrderStarted(handler: (event: OrderStartedEnvelope) => void | Promise<void>): void;
|
|
2025
|
+
interface OrderUpdatedEnvelope {
|
|
2026
|
+
entity: Order;
|
|
2027
|
+
metadata: EventMetadata;
|
|
2028
|
+
}
|
|
2165
2029
|
/**
|
|
2166
|
-
*
|
|
2030
|
+
* Triggered for any of the following update events:
|
|
2031
|
+
*
|
|
2032
|
+
* + Order is paid for. Order Purchased is also triggered.
|
|
2033
|
+
* + Order reaches its start date or end date. Order Started and Order Ended, respectively, are also triggered.
|
|
2034
|
+
* + New payment cycle of an order starts. Order Cycle Started is also triggered.
|
|
2035
|
+
* + Offline order is marked as paid. Order Marked As Paid is also triggered.
|
|
2036
|
+
* + End date of the order is postponed. Order End Date Postponed is also triggered
|
|
2037
|
+
* + Order is paused, or a paused order is resumed. Order Paused and Order Resumed, respectively, are also triggered.
|
|
2038
|
+
* + Order is canceled, either immediately or at the end of the payment cycle. Order Canceled and Order Auto Renew Canceled, respectively, are also triggered.
|
|
2039
|
+
* @permissionScope Manage_Wix_Rentals_App_Forms_submissions
|
|
2040
|
+
* @permissionScopeId SCOPE.RENTALS.MANAGE
|
|
2041
|
+
* @permissionScope Manage Orders
|
|
2042
|
+
* @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
|
|
2043
|
+
* @permissionScope Read Orders
|
|
2044
|
+
* @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS
|
|
2045
|
+
* @permissionScope Manage plans and orders of Pricing Plans
|
|
2046
|
+
* @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-PLANS-AND-ORDERS
|
|
2047
|
+
* @permissionScope Manage Events
|
|
2048
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
2049
|
+
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
2050
|
+
* @webhook
|
|
2051
|
+
* @eventType wix.pricing_plans.v2.order_updated
|
|
2052
|
+
* @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
|
|
2053
|
+
* @slug updated
|
|
2054
|
+
*/
|
|
2055
|
+
declare function onOrderUpdated(handler: (event: OrderUpdatedEnvelope) => void | Promise<void>): void;
|
|
2056
|
+
interface OrderCreatedEnvelope {
|
|
2057
|
+
entity: Order;
|
|
2058
|
+
metadata: EventMetadata;
|
|
2059
|
+
}
|
|
2060
|
+
/**
|
|
2061
|
+
* Triggered when an order is created.
|
|
2062
|
+
* @permissionScope Manage_Wix_Rentals_App_Forms_submissions
|
|
2063
|
+
* @permissionScopeId SCOPE.RENTALS.MANAGE
|
|
2064
|
+
* @permissionScope Manage Orders
|
|
2065
|
+
* @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
|
|
2066
|
+
* @permissionScope Read Orders
|
|
2067
|
+
* @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS
|
|
2068
|
+
* @permissionScope Manage plans and orders of Pricing Plans
|
|
2069
|
+
* @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-PLANS-AND-ORDERS
|
|
2070
|
+
* @permissionScope Manage Events
|
|
2071
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
2072
|
+
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
2073
|
+
* @webhook
|
|
2074
|
+
* @eventType wix.pricing_plans.v2.order_created
|
|
2075
|
+
* @serviceIdentifier com.wixpress.membership.v2.orders.CheckoutService
|
|
2076
|
+
* @slug created
|
|
2077
|
+
*/
|
|
2078
|
+
declare function onOrderCreated(handler: (event: OrderCreatedEnvelope) => void | Promise<void>): void;
|
|
2079
|
+
interface OrderStartDateChangedEnvelope {
|
|
2080
|
+
data: OrderStartDateChanged;
|
|
2081
|
+
metadata: EventMetadata;
|
|
2082
|
+
}
|
|
2083
|
+
/**
|
|
2084
|
+
* Triggered when an order's `startDate` is changed.
|
|
2085
|
+
* @permissionScope Manage_Wix_Rentals_App_Forms_submissions
|
|
2086
|
+
* @permissionScopeId SCOPE.RENTALS.MANAGE
|
|
2087
|
+
* @permissionScope Manage Orders
|
|
2088
|
+
* @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
|
|
2089
|
+
* @permissionScope Read Orders
|
|
2090
|
+
* @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS
|
|
2091
|
+
* @permissionScope Manage plans and orders of Pricing Plans
|
|
2092
|
+
* @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-PLANS-AND-ORDERS
|
|
2093
|
+
* @permissionScope Manage Events
|
|
2094
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
2095
|
+
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
2096
|
+
* @webhook
|
|
2097
|
+
* @eventType wix.pricing_plans.v2.order_start_date_changed
|
|
2098
|
+
* @serviceIdentifier com.wixpress.membership.v2.orders.CheckoutService
|
|
2099
|
+
* @slug start_date_changed
|
|
2100
|
+
*/
|
|
2101
|
+
declare function onOrderStartDateChanged(handler: (event: OrderStartDateChangedEnvelope) => void | Promise<void>): void;
|
|
2102
|
+
/**
|
|
2103
|
+
* Retrieves an order by ID.
|
|
2167
2104
|
* @param _id - Order ID.
|
|
2168
2105
|
* @public
|
|
2169
2106
|
* @requiredField _id
|
|
2170
|
-
* @param options - Options
|
|
2171
|
-
* @permissionId PRICING_PLANS.
|
|
2107
|
+
* @param options - Options to use when getting an order.
|
|
2108
|
+
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
2172
2109
|
* @applicableIdentity APP
|
|
2173
|
-
* @
|
|
2174
|
-
* @fqn com.wixpress.membership.v2.orders.member.MemberOrdersService.GetOrder
|
|
2110
|
+
* @fqn com.wixpress.membership.v2.orders.OrderManagementService.GetOrder
|
|
2175
2111
|
*/
|
|
2176
|
-
declare function
|
|
2177
|
-
interface
|
|
2112
|
+
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>>;
|
|
2113
|
+
interface ManagementGetOrderOptions {
|
|
2178
2114
|
/**
|
|
2179
2115
|
* Predefined set of fields to return.
|
|
2180
2116
|
*
|
|
@@ -2183,36 +2119,51 @@ interface MemberGetOrderOptions {
|
|
|
2183
2119
|
fieldSet?: SetWithLiterals;
|
|
2184
2120
|
}
|
|
2185
2121
|
/**
|
|
2186
|
-
* Retrieves a list of up to
|
|
2122
|
+
* Retrieves a list of up to 50 pricing plan orders and details, given the specified sorting and filtering.
|
|
2123
|
+
*
|
|
2124
|
+
* By default, this endpoint will retrieve all orders and return them sorted by `createdDate` in `DESC`, descending order.
|
|
2125
|
+
* `sort.fieldName` supports `endDate` and `createdDate` fields and defaults to `ASC`, ascending order.
|
|
2187
2126
|
* @public
|
|
2188
2127
|
* @param options - Filtering, sorting, and pagination options.
|
|
2189
|
-
* @permissionId PRICING_PLANS.
|
|
2128
|
+
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
2190
2129
|
* @applicableIdentity APP
|
|
2191
|
-
* @
|
|
2192
|
-
* @fqn com.wixpress.membership.v2.orders.member.MemberOrdersService.ListOrders
|
|
2130
|
+
* @fqn com.wixpress.membership.v2.orders.OrderManagementService.ListOrders
|
|
2193
2131
|
*/
|
|
2194
|
-
declare function
|
|
2195
|
-
interface
|
|
2132
|
+
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>>;
|
|
2133
|
+
interface ManagementListOrdersOptions {
|
|
2196
2134
|
/**
|
|
2197
|
-
* Filter by
|
|
2135
|
+
* Filter by a buyer's member ID, from the Members API.
|
|
2136
|
+
* @format GUID
|
|
2137
|
+
*/
|
|
2138
|
+
buyerIds?: string[];
|
|
2139
|
+
/**
|
|
2140
|
+
* Filter by plan IDs, from the Plans API.
|
|
2198
2141
|
* @format GUID
|
|
2199
2142
|
*/
|
|
2200
2143
|
planIds?: string[];
|
|
2201
|
-
/** Filter
|
|
2144
|
+
/** Filter by whether or not the auto-renewal of recurring orders was canceled. */
|
|
2202
2145
|
autoRenewCanceled?: boolean | null;
|
|
2203
2146
|
/** Filter by order status. */
|
|
2204
2147
|
orderStatuses?: OrderStatusWithLiterals[];
|
|
2205
2148
|
/** Filter by payment status. */
|
|
2206
2149
|
paymentStatuses?: PaymentStatusWithLiterals[];
|
|
2207
2150
|
/**
|
|
2208
|
-
*
|
|
2151
|
+
* Number of orders to return. See Sorting and Paging for more information.
|
|
2152
|
+
*
|
|
2153
|
+
* Max: `50`
|
|
2209
2154
|
* @min 1
|
|
2210
2155
|
* @max 50
|
|
2211
2156
|
*/
|
|
2212
2157
|
limit?: number | null;
|
|
2213
|
-
/** Number of
|
|
2158
|
+
/** Number of orders to skip in the current sort order. */
|
|
2214
2159
|
offset?: number | null;
|
|
2215
|
-
/**
|
|
2160
|
+
/**
|
|
2161
|
+
* Sort order.
|
|
2162
|
+
*
|
|
2163
|
+
* Use `ASC` for ascending order or `DESC` for descending order.
|
|
2164
|
+
*
|
|
2165
|
+
* Default: `DESC`.
|
|
2166
|
+
*/
|
|
2216
2167
|
sorting?: Sorting;
|
|
2217
2168
|
/**
|
|
2218
2169
|
* Predefined set of fields to return.
|
|
@@ -2222,26 +2173,106 @@ interface MemberListOrdersOptions {
|
|
|
2222
2173
|
fieldSet?: SetWithLiterals;
|
|
2223
2174
|
}
|
|
2224
2175
|
/**
|
|
2225
|
-
*
|
|
2176
|
+
* 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.
|
|
2226
2177
|
*
|
|
2227
|
-
*
|
|
2178
|
+
* New `endDate` must be later than the order's current `endDate`. Can't postpone orders that are unlimited.
|
|
2179
|
+
* Can't postpone an order with `status`: `PAUSED`.
|
|
2180
|
+
* @param _id - Order ID.
|
|
2181
|
+
* @param endDate - New end date and time.
|
|
2228
2182
|
*
|
|
2229
|
-
*
|
|
2183
|
+
* Must be later than the current end date and time.
|
|
2184
|
+
* @public
|
|
2185
|
+
* @requiredField _id
|
|
2186
|
+
* @requiredField endDate
|
|
2187
|
+
* @param options - Options for postponing the end date of an order.
|
|
2188
|
+
* @permissionId PRICING_PLANS.MANAGE_ORDERS
|
|
2189
|
+
* @applicableIdentity APP
|
|
2190
|
+
* @fqn com.wixpress.membership.v2.orders.OrderManagementService.PostponeEndDate
|
|
2191
|
+
*/
|
|
2192
|
+
declare function postponeEndDate(_id: string, endDate: Date): Promise<void>;
|
|
2193
|
+
/**
|
|
2194
|
+
* Cancels an existing order.
|
|
2230
2195
|
*
|
|
2231
|
-
*
|
|
2232
|
-
*
|
|
2196
|
+
* For orders with recurring payments, a cancellation can be set to occur either `IMMEDIATELY` or at the `NEXT_PAYMENT_DATE`.
|
|
2197
|
+
* For orders with one-time payments, a cancellation can only be set for `IMMEDIATELY`.
|
|
2198
|
+
*
|
|
2199
|
+
* #### Canceling during the free trial period.
|
|
2200
|
+
*
|
|
2201
|
+
* When a buyer cancels their order during the free trial period, the buyer's subscription expires at the end
|
|
2202
|
+
* of the free trial period and they will not be billed. The buyer may continue using the benefits until the end
|
|
2203
|
+
* of the free trial period.
|
|
2204
|
+
*
|
|
2205
|
+
* When a Wix user cancels an ordered plan during the free trial period, they choose whether to apply the cancellation
|
|
2206
|
+
* `IMMEDIATELY` or at the `NEXT_PAYMENT_DATE`. Canceling `IMMEDIATELY` will end the subscription for the buyer
|
|
2207
|
+
* immediately, even during the free trial period and the buyer won't be billed. Canceling at the
|
|
2208
|
+
* `NEXT_PAYMENT_DATE` allows the buyer to continue using the benefits of the subscription until the end of the free trial period.
|
|
2209
|
+
* Then, the subscription ends and the buyer is not billed.
|
|
2233
2210
|
* @param _id - Order ID.
|
|
2234
|
-
* @param effectiveAt -
|
|
2211
|
+
* @param effectiveAt - __Required.__ When the order will be canceled. One-time orders can only be canceled `IMMEDIATELY`.
|
|
2235
2212
|
* @public
|
|
2236
2213
|
* @requiredField _id
|
|
2237
2214
|
* @requiredField effectiveAt
|
|
2238
|
-
* @param options - Options for
|
|
2239
|
-
* @permissionId PRICING_PLANS.
|
|
2215
|
+
* @param options - Options for canceling orders.
|
|
2216
|
+
* @permissionId PRICING_PLANS.MANAGE_ORDERS
|
|
2240
2217
|
* @applicableIdentity APP
|
|
2241
|
-
* @
|
|
2242
|
-
* @fqn com.wixpress.membership.v2.orders.member.MemberOrdersService.RequestCancellation
|
|
2218
|
+
* @fqn com.wixpress.membership.v2.orders.OrderManagementService.CancelOrder
|
|
2243
2219
|
*/
|
|
2244
|
-
declare function
|
|
2220
|
+
declare function cancelOrder(_id: string, effectiveAt: CancellationEffectiveAtWithLiterals): Promise<void>;
|
|
2221
|
+
/**
|
|
2222
|
+
* Marks an offline order as paid.
|
|
2223
|
+
* > __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.
|
|
2224
|
+
*
|
|
2225
|
+
* Marking an offline order as paid causes the following changes:
|
|
2226
|
+
* - The order's `lastPaymentStatus` changes to `"PAID"`.
|
|
2227
|
+
* - The order's status changes to either `"PENDING"` or `"ACTIVE"`, depending on the order's `startDate`.
|
|
2228
|
+
*
|
|
2229
|
+
* An error occurs if you attempt to:
|
|
2230
|
+
* - Mark an already-paid, offline order as paid. You cannot mark an offline order as paid twice.
|
|
2231
|
+
* - Mark an online order as paid. The Mark as Paid method is supported for offline orders only.
|
|
2232
|
+
* @param _id - Order ID.
|
|
2233
|
+
* @public
|
|
2234
|
+
* @requiredField _id
|
|
2235
|
+
* @permissionId PRICING_PLANS.MANAGE_ORDERS
|
|
2236
|
+
* @applicableIdentity APP
|
|
2237
|
+
* @fqn com.wixpress.membership.v2.orders.OrderManagementService.MarkAsPaid
|
|
2238
|
+
*/
|
|
2239
|
+
declare function markAsPaid(_id: string): Promise<void>;
|
|
2240
|
+
/**
|
|
2241
|
+
* Pauses an order. Calling this method changes the order status to `"PAUSED"` and updates the `pausePeriods` array.
|
|
2242
|
+
*
|
|
2243
|
+
* Only orders with `status`: `ACTIVE` can be paused.
|
|
2244
|
+
* For orders with recurring payments, it also pauses the payment schedule. Buyers are not charged when an order is paused.
|
|
2245
|
+
* Pausing an order affects the end date of the order by adding the time the order is paused to the `endDate`.
|
|
2246
|
+
* The `endDate` and the `earliestEndDate` for the order are adjusted to include the pause period when the order is resumed.
|
|
2247
|
+
*
|
|
2248
|
+
* To resume a paused order, call Resume Order.
|
|
2249
|
+
* @param _id - Order ID.
|
|
2250
|
+
* @public
|
|
2251
|
+
* @requiredField _id
|
|
2252
|
+
* @permissionId PRICING_PLANS.MANAGE_ORDERS
|
|
2253
|
+
* @applicableIdentity APP
|
|
2254
|
+
* @fqn com.wixpress.membership.v2.orders.OrderManagementService.PauseOrder
|
|
2255
|
+
*/
|
|
2256
|
+
declare function pauseOrder(_id: string): Promise<void>;
|
|
2257
|
+
/**
|
|
2258
|
+
* Resumes a paused order. For orders with recurring payments, it also restarts the payment schedule.
|
|
2259
|
+
*
|
|
2260
|
+
* Resuming an order causes the following changes:
|
|
2261
|
+
* - The order status changes to `"ACTIVE"`.
|
|
2262
|
+
* - The `pausePeriods` array is updated.
|
|
2263
|
+
* - The `endDate` for the order is adjusted to include the pause period.
|
|
2264
|
+
* - For orders with recurring payments, the payment schedule is restarted.
|
|
2265
|
+
* - The `earliestEndDate` is adjusted to include the pause period. (This property is reserved for future use).
|
|
2266
|
+
*
|
|
2267
|
+
* To pause an order, call Pause Order.
|
|
2268
|
+
* @param _id - Order ID.
|
|
2269
|
+
* @public
|
|
2270
|
+
* @requiredField _id
|
|
2271
|
+
* @permissionId PRICING_PLANS.MANAGE_ORDERS
|
|
2272
|
+
* @applicableIdentity APP
|
|
2273
|
+
* @fqn com.wixpress.membership.v2.orders.OrderManagementService.ResumeOrder
|
|
2274
|
+
*/
|
|
2275
|
+
declare function resumeOrder(_id: string): Promise<void>;
|
|
2245
2276
|
/**
|
|
2246
2277
|
* Creates an online order for a site member.
|
|
2247
2278
|
*
|
|
@@ -2437,18 +2468,19 @@ interface GetPricePreviewOptions {
|
|
|
2437
2468
|
couponCode?: string | null;
|
|
2438
2469
|
}
|
|
2439
2470
|
/**
|
|
2440
|
-
* Retrieves an order by ID.
|
|
2471
|
+
* Retrieves an order for the currently logged-in member by ID.
|
|
2441
2472
|
* @param _id - Order ID.
|
|
2442
2473
|
* @public
|
|
2443
2474
|
* @requiredField _id
|
|
2444
|
-
* @param options - Options
|
|
2445
|
-
* @permissionId PRICING_PLANS.
|
|
2475
|
+
* @param options - Options for getting a logged-in member's order.
|
|
2476
|
+
* @permissionId PRICING_PLANS.READ_OWN_ORDERS
|
|
2446
2477
|
* @applicableIdentity APP
|
|
2447
|
-
* @
|
|
2448
|
-
* @
|
|
2478
|
+
* @applicableIdentity MEMBER
|
|
2479
|
+
* @returns Requested order.
|
|
2480
|
+
* @fqn com.wixpress.membership.v2.orders.member.MemberOrdersService.GetOrder
|
|
2449
2481
|
*/
|
|
2450
|
-
declare function
|
|
2451
|
-
interface
|
|
2482
|
+
declare function memberGetOrder(_id: string, options?: MemberGetOrderOptions): Promise<NonNullablePaths<Order, `_id` | `planId` | `subscriptionId` | `buyer.memberId` | `buyer.contactId` | `priceDetails.subscription.cycleDuration.unit` | `priceDetails.subtotal` | `priceDetails.discount` | `priceDetails.tax.name` | `priceDetails.tax.includedInPrice` | `priceDetails.tax.rate` | `priceDetails.tax.amount` | `priceDetails.total` | `priceDetails.planPrice` | `priceDetails.currency` | `priceDetails.coupon.code` | `priceDetails.coupon.amount` | `priceDetails.coupon._id` | `pricing.prices` | `pricing.prices.${number}.duration.cycleFrom` | `pricing.prices.${number}.price.subtotal` | `pricing.prices.${number}.price.discount` | `pricing.prices.${number}.price.total` | `pricing.prices.${number}.price.currency` | `pricing.prices.${number}.price.proration` | `type` | `status` | `cancellation.cause` | `cancellation.effectiveAt` | `lastPaymentStatus` | `pausePeriods` | `pausePeriods.${number}.status` | `currentCycle.index` | `planName` | `planDescription` | `planPrice`, 6>>;
|
|
2483
|
+
interface MemberGetOrderOptions {
|
|
2452
2484
|
/**
|
|
2453
2485
|
* Predefined set of fields to return.
|
|
2454
2486
|
*
|
|
@@ -2457,51 +2489,36 @@ interface ManagementGetOrderOptions {
|
|
|
2457
2489
|
fieldSet?: SetWithLiterals;
|
|
2458
2490
|
}
|
|
2459
2491
|
/**
|
|
2460
|
-
* Retrieves a list of up to
|
|
2461
|
-
*
|
|
2462
|
-
* By default, this endpoint will retrieve all orders and return them sorted by `createdDate` in `DESC`, descending order.
|
|
2463
|
-
* `sort.fieldName` supports `endDate` and `createdDate` fields and defaults to `ASC`, ascending order.
|
|
2492
|
+
* Retrieves a list of up to 100 pricing plan orders for currently logged-in member.
|
|
2464
2493
|
* @public
|
|
2465
2494
|
* @param options - Filtering, sorting, and pagination options.
|
|
2466
|
-
* @permissionId PRICING_PLANS.
|
|
2495
|
+
* @permissionId PRICING_PLANS.READ_OWN_ORDERS
|
|
2467
2496
|
* @applicableIdentity APP
|
|
2468
|
-
* @
|
|
2497
|
+
* @applicableIdentity MEMBER
|
|
2498
|
+
* @fqn com.wixpress.membership.v2.orders.member.MemberOrdersService.ListOrders
|
|
2469
2499
|
*/
|
|
2470
|
-
declare function
|
|
2471
|
-
interface
|
|
2472
|
-
/**
|
|
2473
|
-
* Filter by a buyer's member ID, from the Members API.
|
|
2474
|
-
* @format GUID
|
|
2475
|
-
*/
|
|
2476
|
-
buyerIds?: string[];
|
|
2500
|
+
declare function memberListOrders(options?: MemberListOrdersOptions): Promise<NonNullablePaths<MemberListOrdersResponse, `orders` | `orders.${number}._id` | `orders.${number}.planId` | `orders.${number}.subscriptionId` | `orders.${number}.buyer.memberId` | `orders.${number}.buyer.contactId` | `orders.${number}.priceDetails.singlePaymentForDuration.unit` | `orders.${number}.priceDetails.subtotal` | `orders.${number}.priceDetails.discount` | `orders.${number}.priceDetails.tax.name` | `orders.${number}.priceDetails.tax.includedInPrice` | `orders.${number}.priceDetails.tax.rate` | `orders.${number}.priceDetails.tax.amount` | `orders.${number}.priceDetails.total` | `orders.${number}.priceDetails.planPrice` | `orders.${number}.priceDetails.currency` | `orders.${number}.priceDetails.coupon.code` | `orders.${number}.priceDetails.coupon.amount` | `orders.${number}.priceDetails.coupon._id` | `orders.${number}.type` | `orders.${number}.status` | `orders.${number}.cancellation.cause` | `orders.${number}.cancellation.effectiveAt` | `orders.${number}.lastPaymentStatus` | `orders.${number}.currentCycle.index` | `orders.${number}.planName` | `orders.${number}.planDescription` | `orders.${number}.planPrice`, 6>>;
|
|
2501
|
+
interface MemberListOrdersOptions {
|
|
2477
2502
|
/**
|
|
2478
|
-
* Filter by plan IDs
|
|
2503
|
+
* Filter by plan IDs.
|
|
2479
2504
|
* @format GUID
|
|
2480
2505
|
*/
|
|
2481
2506
|
planIds?: string[];
|
|
2482
|
-
/** Filter
|
|
2507
|
+
/** Filter for orders where auto renewal was canceled. */
|
|
2483
2508
|
autoRenewCanceled?: boolean | null;
|
|
2484
2509
|
/** Filter by order status. */
|
|
2485
2510
|
orderStatuses?: OrderStatusWithLiterals[];
|
|
2486
2511
|
/** Filter by payment status. */
|
|
2487
2512
|
paymentStatuses?: PaymentStatusWithLiterals[];
|
|
2488
2513
|
/**
|
|
2489
|
-
*
|
|
2490
|
-
*
|
|
2491
|
-
* Max: `50`
|
|
2514
|
+
* Limit the number of pricing plans returned. Default limit is 50.
|
|
2492
2515
|
* @min 1
|
|
2493
2516
|
* @max 50
|
|
2494
2517
|
*/
|
|
2495
2518
|
limit?: number | null;
|
|
2496
|
-
/** Number of
|
|
2519
|
+
/** Number of entries to offset. */
|
|
2497
2520
|
offset?: number | null;
|
|
2498
|
-
/**
|
|
2499
|
-
* Sort order.
|
|
2500
|
-
*
|
|
2501
|
-
* Use `ASC` for ascending order or `DESC` for descending order.
|
|
2502
|
-
*
|
|
2503
|
-
* Default: `DESC`.
|
|
2504
|
-
*/
|
|
2521
|
+
/** Sorting direction (defaults to ASC) and field to sort by. */
|
|
2505
2522
|
sorting?: Sorting;
|
|
2506
2523
|
/**
|
|
2507
2524
|
* Predefined set of fields to return.
|
|
@@ -2511,105 +2528,25 @@ interface ManagementListOrdersOptions {
|
|
|
2511
2528
|
fieldSet?: SetWithLiterals;
|
|
2512
2529
|
}
|
|
2513
2530
|
/**
|
|
2514
|
-
*
|
|
2515
|
-
*
|
|
2516
|
-
* New `endDate` must be later than the order's current `endDate`. Can't postpone orders that are unlimited.
|
|
2517
|
-
* Can't postpone an order with `status`: `PAUSED`.
|
|
2518
|
-
* @param _id - Order ID.
|
|
2519
|
-
* @param endDate - New end date and time.
|
|
2520
|
-
*
|
|
2521
|
-
* Must be later than the current end date and time.
|
|
2522
|
-
* @public
|
|
2523
|
-
* @requiredField _id
|
|
2524
|
-
* @requiredField endDate
|
|
2525
|
-
* @param options - Options for postponing the end date of an order.
|
|
2526
|
-
* @permissionId PRICING_PLANS.MANAGE_ORDERS
|
|
2527
|
-
* @applicableIdentity APP
|
|
2528
|
-
* @fqn com.wixpress.membership.v2.orders.OrderManagementService.PostponeEndDate
|
|
2529
|
-
*/
|
|
2530
|
-
declare function postponeEndDate(_id: string, endDate: Date): Promise<void>;
|
|
2531
|
-
/**
|
|
2532
|
-
* Cancels an existing order.
|
|
2533
|
-
*
|
|
2534
|
-
* For orders with recurring payments, a cancellation can be set to occur either `IMMEDIATELY` or at the `NEXT_PAYMENT_DATE`.
|
|
2535
|
-
* For orders with one-time payments, a cancellation can only be set for `IMMEDIATELY`.
|
|
2531
|
+
* Cancels an order. Recurring orders can be canceled either immediately or at the next payment date. One time orders can only be canceled immediately.
|
|
2536
2532
|
*
|
|
2537
|
-
*
|
|
2533
|
+
* There may be some operations that continue to be processed before the status of the order is changed to `"CANCELED"`. For example, payments might need to be refunded before the order is fully canceled.
|
|
2538
2534
|
*
|
|
2539
|
-
* When a buyer cancels their order during the free trial period, the buyer's subscription expires at the end
|
|
2540
|
-
* of the free trial period and they will not be billed. The buyer may continue using the benefits until the end
|
|
2541
|
-
* of the free trial period.
|
|
2535
|
+
* Canceling during the free trial period: When a buyer cancels their order during the free trial period, the buyer's subscription expires at the end of the free trial period and they won't be billed. The buyer may continue using the benefits until the end of the free trial period.
|
|
2542
2536
|
*
|
|
2543
|
-
*
|
|
2544
|
-
*
|
|
2545
|
-
* immediately, even during the free trial period and the buyer won't be billed. Canceling at the
|
|
2546
|
-
* `NEXT_PAYMENT_DATE` allows the buyer to continue using the benefits of the subscription until the end of the free trial period.
|
|
2547
|
-
* Then, the subscription ends and the buyer is not billed.
|
|
2537
|
+
* >**Note:**
|
|
2538
|
+
* >This method requires [visitor or member authentication](https://dev.wix.com/docs/rest/articles/getting-started/access-types-and-permissions).
|
|
2548
2539
|
* @param _id - Order ID.
|
|
2549
|
-
* @param effectiveAt -
|
|
2540
|
+
* @param effectiveAt - Required. Whether to cancel the order effective immediately or at the next payment date. One-time orders can only be canceled immediately.
|
|
2550
2541
|
* @public
|
|
2551
2542
|
* @requiredField _id
|
|
2552
2543
|
* @requiredField effectiveAt
|
|
2553
|
-
* @param options - Options for
|
|
2554
|
-
* @permissionId PRICING_PLANS.
|
|
2555
|
-
* @applicableIdentity APP
|
|
2556
|
-
* @fqn com.wixpress.membership.v2.orders.OrderManagementService.CancelOrder
|
|
2557
|
-
*/
|
|
2558
|
-
declare function cancelOrder(_id: string, effectiveAt: CancellationEffectiveAtWithLiterals): Promise<void>;
|
|
2559
|
-
/**
|
|
2560
|
-
* Marks an offline order as paid.
|
|
2561
|
-
* > __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.
|
|
2562
|
-
*
|
|
2563
|
-
* Marking an offline order as paid causes the following changes:
|
|
2564
|
-
* - The order's `lastPaymentStatus` changes to `"PAID"`.
|
|
2565
|
-
* - The order's status changes to either `"PENDING"` or `"ACTIVE"`, depending on the order's `startDate`.
|
|
2566
|
-
*
|
|
2567
|
-
* An error occurs if you attempt to:
|
|
2568
|
-
* - Mark an already-paid, offline order as paid. You cannot mark an offline order as paid twice.
|
|
2569
|
-
* - Mark an online order as paid. The Mark as Paid method is supported for offline orders only.
|
|
2570
|
-
* @param _id - Order ID.
|
|
2571
|
-
* @public
|
|
2572
|
-
* @requiredField _id
|
|
2573
|
-
* @permissionId PRICING_PLANS.MANAGE_ORDERS
|
|
2574
|
-
* @applicableIdentity APP
|
|
2575
|
-
* @fqn com.wixpress.membership.v2.orders.OrderManagementService.MarkAsPaid
|
|
2576
|
-
*/
|
|
2577
|
-
declare function markAsPaid(_id: string): Promise<void>;
|
|
2578
|
-
/**
|
|
2579
|
-
* Pauses an order. Calling this method changes the order status to `"PAUSED"` and updates the `pausePeriods` array.
|
|
2580
|
-
*
|
|
2581
|
-
* Only orders with `status`: `ACTIVE` can be paused.
|
|
2582
|
-
* For orders with recurring payments, it also pauses the payment schedule. Buyers are not charged when an order is paused.
|
|
2583
|
-
* Pausing an order affects the end date of the order by adding the time the order is paused to the `endDate`.
|
|
2584
|
-
* The `endDate` and the `earliestEndDate` for the order are adjusted to include the pause period when the order is resumed.
|
|
2585
|
-
*
|
|
2586
|
-
* To resume a paused order, call Resume Order.
|
|
2587
|
-
* @param _id - Order ID.
|
|
2588
|
-
* @public
|
|
2589
|
-
* @requiredField _id
|
|
2590
|
-
* @permissionId PRICING_PLANS.MANAGE_ORDERS
|
|
2591
|
-
* @applicableIdentity APP
|
|
2592
|
-
* @fqn com.wixpress.membership.v2.orders.OrderManagementService.PauseOrder
|
|
2593
|
-
*/
|
|
2594
|
-
declare function pauseOrder(_id: string): Promise<void>;
|
|
2595
|
-
/**
|
|
2596
|
-
* Resumes a paused order. For orders with recurring payments, it also restarts the payment schedule.
|
|
2597
|
-
*
|
|
2598
|
-
* Resuming an order causes the following changes:
|
|
2599
|
-
* - The order status changes to `"ACTIVE"`.
|
|
2600
|
-
* - The `pausePeriods` array is updated.
|
|
2601
|
-
* - The `endDate` for the order is adjusted to include the pause period.
|
|
2602
|
-
* - For orders with recurring payments, the payment schedule is restarted.
|
|
2603
|
-
* - The `earliestEndDate` is adjusted to include the pause period. (This property is reserved for future use).
|
|
2604
|
-
*
|
|
2605
|
-
* To pause an order, call Pause Order.
|
|
2606
|
-
* @param _id - Order ID.
|
|
2607
|
-
* @public
|
|
2608
|
-
* @requiredField _id
|
|
2609
|
-
* @permissionId PRICING_PLANS.MANAGE_ORDERS
|
|
2544
|
+
* @param options - Options for requesting a cancellation.
|
|
2545
|
+
* @permissionId PRICING_PLANS.MANAGE_OWN_ORDERS
|
|
2610
2546
|
* @applicableIdentity APP
|
|
2611
|
-
* @
|
|
2547
|
+
* @applicableIdentity MEMBER
|
|
2548
|
+
* @fqn com.wixpress.membership.v2.orders.member.MemberOrdersService.RequestCancellation
|
|
2612
2549
|
*/
|
|
2613
|
-
declare function
|
|
2550
|
+
declare function requestCancellation(_id: string, effectiveAt: CancellationEffectiveAtWithLiterals): Promise<void>;
|
|
2614
2551
|
|
|
2615
|
-
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
|
|
2552
|
+
export { type AccountInfo, type AccountInfoMetadata, type ActionEvent, type AddressLocation, type ApplicationError, type ApplyCouponRequest, type ApplyCouponResponse, type BaseEventMetadata, type BulkActionMetadata, type BulkOrderResult, type BulkPauseOrderRequest, type BulkPauseOrderResponse, type BulkResumeOrderRequest, type BulkResumeOrderResponse, type Buyer, type CancelOrderRequest, type CancelOrderResponse, type Cancellation, CancellationCause, type CancellationCauseWithLiterals, CancellationEffectiveAt, type CancellationEffectiveAtWithLiterals, type Captcha, type ChangeStartDateRequest, type ChangeStartDateResponse, type Coupon, type CouponsError, type CreateExternalOrderRequest, type CreateExternalOrderResponse, type CreateGuestOnlineOrderRequest, type CreateGuestOnlineOrderResponse, type CreateOfflineOrderApplicationErrors, type CreateOfflineOrderOptions, type CreateOfflineOrderRequest, type CreateOfflineOrderResponse, type CreateOfflineOrderValidationErrors, type CreateOnlineOrderApplicationErrors, type CreateOnlineOrderOptions, type CreateOnlineOrderRequest, type CreateOnlineOrderResponse, type CreateOnlineOrderValidationErrors, type CurrentCycle, type Cursors, type DomainEvent, type DomainEventBodyOneOf, type Duration, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, type Fee, type FormData, type GetAvailableOrderActionsRequest, type GetAvailableOrderActionsResponse, type GetGuestOnlineOrderPreviewRequest, type GetGuestOnlineOrderPreviewResponse, type GetOfflineOrderPreviewApplicationErrors, type GetOfflineOrderPreviewOptions, type GetOfflineOrderPreviewRequest, type GetOfflineOrderPreviewResponse, type GetOfflineOrderPreviewValidationErrors, type GetOnlineOrderPreviewApplicationErrors, type GetOnlineOrderPreviewOptions, type GetOnlineOrderPreviewRequest, type GetOnlineOrderPreviewResponse, type GetOnlineOrderPreviewValidationErrors, type GetOrderRequest, type GetOrderResponse, type GetOrdersStatsRequest, type GetOrdersStatsResponse, type GetPricePreviewApplicationErrors, type GetPricePreviewOptions, type GetPricePreviewRequest, type GetPricePreviewResponse, type Guest, type IdentificationData, type IdentificationDataIdOneOf, type ItemMetadata, type ListOrdersRequest, type ListOrdersResponse, type ManagementGetOrderOptions, type ManagementListOrdersOptions, type MarkAsPaidRequest, type MarkAsPaidResponse, type MemberGetOrderOptions, type MemberGetOrderRequest, type MemberGetOrderResponse, type MemberListOrdersOptions, type MemberListOrdersRequest, type MemberListOrdersResponse, type MessageEnvelope, type OnBehalf, type Order, type OrderAutoRenewCanceled, type OrderAutoRenewCanceledEnvelope, type OrderCanceled, type OrderCanceledEnvelope, type OrderCreatedEnvelope, type OrderCycle, type OrderCycleStarted, type OrderCycleStartedEnvelope, type OrderEndDatePostponed, type OrderEndDatePostponedEnvelope, type OrderEnded, type OrderEndedEnvelope, type OrderMarkedAsPaid, type OrderMarkedAsPaidEnvelope, OrderMethod, type OrderMethodWithLiterals, type OrderPaused, type OrderPausedEnvelope, type OrderPurchased, type OrderPurchasedEnvelope, type OrderResumed, type OrderResumedEnvelope, type OrderStartDateChanged, type OrderStartDateChangedEnvelope, type OrderStarted, type OrderStartedEnvelope, OrderStatus, type OrderStatusWithLiterals, OrderType, type OrderTypeWithLiterals, type OrderUpdatedEnvelope, type PagingMetadataV2, type PauseOrderRequest, type PauseOrderResponse, type PausePeriod, PaymentStatus, type PaymentStatusWithLiterals, PeriodUnit, type PeriodUnitWithLiterals, type PostponeEndDateRequest, type PostponeEndDateResponse, type Price, type PriceDetails, type PriceDetailsPricingModelOneOf, type PriceDuration, type PricingDetails, type PricingDetailsPricingModelOneOf, ReasonNotSuspendable, type ReasonNotSuspendableWithLiterals, type Recurrence, type RequestCancellationRequest, type RequestCancellationResponse, type RestoreInfo, type ResumeOrderRequest, type ResumeOrderResponse, Set, type SetSubmissionRequest, type SetSubmissionResponse, type SetWithLiterals, SortOrder, type SortOrderWithLiterals, type Sorting, type SpannedPrice, Status, type StatusWithLiterals, type Tax, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, cancelOrder, createOfflineOrder, createOnlineOrder, getOfflineOrderPreview, getOnlineOrderPreview, getPricePreview, managementGetOrder, managementListOrders, markAsPaid, memberGetOrder, memberListOrders, onOrderAutoRenewCanceled, onOrderCanceled, onOrderCreated, onOrderCycleStarted, onOrderEndDatePostponed, onOrderEnded, onOrderMarkedAsPaid, onOrderPaused, onOrderPurchased, onOrderResumed, onOrderStartDateChanged, onOrderStarted, onOrderUpdated, pauseOrder, postponeEndDate, requestCancellation, resumeOrder };
|