@wix/auto_sdk_pricing-plans_orders 1.0.140 → 1.0.142
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 +129 -129
- package/build/cjs/index.js +507 -507
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +797 -785
- package/build/cjs/index.typings.js +405 -405
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +489 -483
- package/build/cjs/meta.js +329 -329
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.d.mts +129 -129
- package/build/es/index.mjs +507 -507
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +797 -785
- package/build/es/index.typings.mjs +405 -405
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +489 -483
- package/build/es/meta.mjs +329 -329
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +129 -129
- package/build/internal/cjs/index.typings.d.ts +822 -810
- package/build/internal/cjs/meta.d.ts +505 -499
- package/build/internal/es/index.d.mts +129 -129
- package/build/internal/es/index.typings.d.mts +822 -810
- package/build/internal/es/meta.d.mts +505 -499
- package/package.json +2 -2
|
@@ -666,316 +666,373 @@ interface ActionEvent {
|
|
|
666
666
|
}
|
|
667
667
|
interface Empty {
|
|
668
668
|
}
|
|
669
|
-
interface
|
|
670
|
-
/**
|
|
671
|
-
|
|
672
|
-
* @format GUID
|
|
673
|
-
*/
|
|
674
|
-
planId: string;
|
|
675
|
-
/**
|
|
676
|
-
* Start date and time for the plan of the online order in a `YYYY-MM-DDThh:mm[:ss][.sss]Z` format.
|
|
677
|
-
*
|
|
678
|
-
* Default: Current date and time.
|
|
679
|
-
*/
|
|
680
|
-
startDate?: Date | null;
|
|
681
|
-
/**
|
|
682
|
-
* Coupon code to apply.
|
|
683
|
-
* @minLength 1
|
|
684
|
-
* @maxLength 20
|
|
685
|
-
*/
|
|
686
|
-
couponCode?: string | null;
|
|
687
|
-
/** Provided if checkout is initiated on buyer's behalf. */
|
|
688
|
-
onBehalf?: OnBehalf;
|
|
689
|
-
/**
|
|
690
|
-
* Submission ID of the form submitted with this order.
|
|
691
|
-
* @format GUID
|
|
692
|
-
*/
|
|
693
|
-
submissionId?: string | null;
|
|
669
|
+
interface OrderPurchased {
|
|
670
|
+
/** Order that was paid for. If a free or an offline order, the order that was created. */
|
|
671
|
+
order?: Order;
|
|
694
672
|
}
|
|
695
|
-
interface
|
|
696
|
-
/**
|
|
697
|
-
|
|
698
|
-
* @format GUID
|
|
699
|
-
*/
|
|
700
|
-
memberId?: string;
|
|
701
|
-
/** Method by which checkout is initiated. */
|
|
702
|
-
orderMethod?: OrderMethodWithLiterals;
|
|
673
|
+
interface OrderStarted {
|
|
674
|
+
/** Order that reached its `startDate`. */
|
|
675
|
+
order?: Order;
|
|
703
676
|
}
|
|
704
|
-
|
|
705
|
-
|
|
677
|
+
/**
|
|
678
|
+
* Triggered at the start of a new payment cycle for an existing order.
|
|
679
|
+
*
|
|
680
|
+
* This webhook does not trigger at the initial start of an offline order.
|
|
681
|
+
*/
|
|
682
|
+
interface OrderCycleStarted {
|
|
683
|
+
/** Order whose new cycle started. */
|
|
706
684
|
order?: Order;
|
|
685
|
+
/** 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. */
|
|
686
|
+
cycleNumber?: number;
|
|
707
687
|
}
|
|
708
|
-
|
|
709
|
-
|
|
710
|
-
|
|
711
|
-
|
|
712
|
-
planId?: string;
|
|
688
|
+
/** Emitted when a recurring order is canceled for the next payment cycle */
|
|
689
|
+
interface OrderAutoRenewCanceled {
|
|
690
|
+
/** Order that is canceled, effective at the end of the current payment cycle. */
|
|
691
|
+
order?: Order;
|
|
713
692
|
}
|
|
714
|
-
interface
|
|
693
|
+
interface OrderEnded {
|
|
694
|
+
/** Order that ended. */
|
|
695
|
+
order?: Order;
|
|
696
|
+
}
|
|
697
|
+
interface GetOrderRequest {
|
|
715
698
|
/**
|
|
716
|
-
*
|
|
699
|
+
* Order ID.
|
|
717
700
|
* @format GUID
|
|
718
701
|
*/
|
|
719
|
-
|
|
702
|
+
_id: string;
|
|
720
703
|
/**
|
|
721
|
-
*
|
|
704
|
+
* Predefined set of fields to return.
|
|
722
705
|
*
|
|
723
|
-
* Default:
|
|
724
|
-
*/
|
|
725
|
-
startDate?: Date | null;
|
|
726
|
-
/**
|
|
727
|
-
* Coupon code to apply.
|
|
728
|
-
* @minLength 1
|
|
729
|
-
* @maxLength 20
|
|
730
|
-
*/
|
|
731
|
-
couponCode?: string | null;
|
|
732
|
-
/** Captcha data to prove you are not a robot */
|
|
733
|
-
captcha?: Captcha;
|
|
734
|
-
/** Visitor info */
|
|
735
|
-
guest?: Guest;
|
|
736
|
-
/**
|
|
737
|
-
* Form submission id that was submitted together with the order
|
|
738
|
-
* @format GUID
|
|
706
|
+
* Default: If `fieldSet` is omitted, no order form submission data is returned.
|
|
739
707
|
*/
|
|
740
|
-
|
|
741
|
-
}
|
|
742
|
-
interface Captcha {
|
|
743
|
-
/** Token from captcha */
|
|
744
|
-
token?: string;
|
|
708
|
+
fieldSet?: SetWithLiterals;
|
|
745
709
|
}
|
|
746
|
-
|
|
747
|
-
/**
|
|
748
|
-
|
|
749
|
-
|
|
750
|
-
|
|
751
|
-
|
|
710
|
+
declare enum Set {
|
|
711
|
+
/** Same behavior as `BASIC`.` */
|
|
712
|
+
UNKNOWN_SET = "UNKNOWN_SET",
|
|
713
|
+
/** Doesn't return any order form submission data. */
|
|
714
|
+
BASIC = "BASIC",
|
|
715
|
+
/** Returns all order form submission data. */
|
|
716
|
+
FULL = "FULL"
|
|
752
717
|
}
|
|
753
|
-
|
|
718
|
+
/** @enumType */
|
|
719
|
+
type SetWithLiterals = Set | 'UNKNOWN_SET' | 'BASIC' | 'FULL';
|
|
720
|
+
interface GetOrderResponse {
|
|
754
721
|
/** Order. */
|
|
755
722
|
order?: Order;
|
|
756
723
|
}
|
|
757
|
-
interface
|
|
724
|
+
interface ListOrdersRequest {
|
|
758
725
|
/**
|
|
759
|
-
*
|
|
726
|
+
* Filter by a buyer's member ID, from the Members API.
|
|
760
727
|
* @format GUID
|
|
761
728
|
*/
|
|
762
|
-
|
|
729
|
+
buyerIds?: string[];
|
|
763
730
|
/**
|
|
764
|
-
*
|
|
731
|
+
* Filter by plan IDs, from the Plans API.
|
|
765
732
|
* @format GUID
|
|
766
733
|
*/
|
|
767
|
-
|
|
734
|
+
planIds?: string[];
|
|
735
|
+
/** Filter by whether or not the auto-renewal of recurring orders was canceled. */
|
|
736
|
+
autoRenewCanceled?: boolean | null;
|
|
737
|
+
/** Filter by order status. */
|
|
738
|
+
orderStatuses?: OrderStatusWithLiterals[];
|
|
739
|
+
/** Filter by payment status. */
|
|
740
|
+
paymentStatuses?: PaymentStatusWithLiterals[];
|
|
768
741
|
/**
|
|
769
|
-
*
|
|
742
|
+
* Number of orders to return. See Sorting and Paging for more information.
|
|
770
743
|
*
|
|
771
|
-
*
|
|
744
|
+
* Max: `50`
|
|
745
|
+
* @min 1
|
|
746
|
+
* @max 50
|
|
772
747
|
*/
|
|
773
|
-
|
|
748
|
+
limit?: number | null;
|
|
749
|
+
/** Number of orders to skip in the current sort order. */
|
|
750
|
+
offset?: number | null;
|
|
774
751
|
/**
|
|
775
|
-
*
|
|
752
|
+
* Sort order.
|
|
776
753
|
*
|
|
777
|
-
*
|
|
778
|
-
|
|
779
|
-
|
|
780
|
-
/**
|
|
781
|
-
* Coupon code to apply, from the Coupons API.
|
|
782
|
-
* @minLength 1
|
|
783
|
-
* @maxLength 20
|
|
784
|
-
*/
|
|
785
|
-
couponCode?: string | null;
|
|
786
|
-
/**
|
|
787
|
-
* Form submission ID that was submitted with the order.
|
|
788
|
-
* @format GUID
|
|
754
|
+
* Use `ASC` for ascending order or `DESC` for descending order.
|
|
755
|
+
*
|
|
756
|
+
* Default: `DESC`.
|
|
789
757
|
*/
|
|
790
|
-
|
|
791
|
-
}
|
|
792
|
-
interface CreateOfflineOrderResponse {
|
|
793
|
-
/** Order. */
|
|
794
|
-
order?: Order;
|
|
795
|
-
}
|
|
796
|
-
interface CreateExternalOrderRequest {
|
|
758
|
+
sorting?: Sorting;
|
|
797
759
|
/**
|
|
798
|
-
*
|
|
799
|
-
*
|
|
760
|
+
* Predefined set of fields to return.
|
|
761
|
+
*
|
|
762
|
+
* Default: If `fieldSet` is omitted, no order form submission data is returned.
|
|
800
763
|
*/
|
|
801
|
-
|
|
764
|
+
fieldSet?: SetWithLiterals;
|
|
802
765
|
/**
|
|
803
|
-
*
|
|
766
|
+
* Filter by order IDs.
|
|
767
|
+
* @internal
|
|
804
768
|
* @format GUID
|
|
769
|
+
* @maxSize 50
|
|
805
770
|
*/
|
|
806
|
-
|
|
807
|
-
}
|
|
808
|
-
interface CreateExternalOrderResponse {
|
|
809
|
-
/** Created order */
|
|
810
|
-
order?: Order;
|
|
771
|
+
orderIds?: string[];
|
|
811
772
|
}
|
|
812
|
-
interface
|
|
773
|
+
interface Sorting {
|
|
813
774
|
/**
|
|
814
|
-
*
|
|
815
|
-
* @
|
|
775
|
+
* Name of the field to sort by.
|
|
776
|
+
* @maxLength 512
|
|
816
777
|
*/
|
|
817
|
-
|
|
778
|
+
fieldName?: string;
|
|
779
|
+
/** Sort order. */
|
|
780
|
+
order?: SortOrderWithLiterals;
|
|
818
781
|
/**
|
|
819
|
-
*
|
|
782
|
+
* When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by
|
|
783
|
+
* a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.
|
|
820
784
|
*
|
|
821
|
-
*
|
|
785
|
+
* If multiple filters are provided, they are combined with AND operator.
|
|
786
|
+
*
|
|
787
|
+
* Example:
|
|
788
|
+
* Given we have document like {"id": "1", "nestedField": [{"price": 10, "region": "EU"}, {"price": 20, "region": "US"}]}
|
|
789
|
+
* and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be
|
|
790
|
+
* { fieldName: "nestedField.price", "select_items_by": [{"nestedField.region": "US"}] }
|
|
791
|
+
* @internal
|
|
792
|
+
* @maxSize 10
|
|
822
793
|
*/
|
|
823
|
-
|
|
794
|
+
selectItemsBy?: Record<string, any>[] | null;
|
|
824
795
|
/**
|
|
825
|
-
*
|
|
826
|
-
*
|
|
827
|
-
* @maxLength 20
|
|
796
|
+
* Origin point for geo-distance sorting on a GEO field
|
|
797
|
+
* results are ordered by distance from this point (ASC = nearest first, DESC = farthest first).
|
|
828
798
|
*/
|
|
829
|
-
|
|
799
|
+
origin?: AddressLocation;
|
|
830
800
|
}
|
|
831
|
-
|
|
832
|
-
|
|
833
|
-
|
|
834
|
-
/** Whether the member has already reached purchase limit for the order's plan. */
|
|
835
|
-
purchaseLimitExceeded?: boolean;
|
|
801
|
+
declare enum SortOrder {
|
|
802
|
+
ASC = "ASC",
|
|
803
|
+
DESC = "DESC"
|
|
836
804
|
}
|
|
837
|
-
|
|
838
|
-
|
|
839
|
-
|
|
840
|
-
|
|
841
|
-
|
|
842
|
-
|
|
805
|
+
/** @enumType */
|
|
806
|
+
type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
807
|
+
interface AddressLocation {
|
|
808
|
+
/** Address latitude. */
|
|
809
|
+
latitude?: number | null;
|
|
810
|
+
/** Address longitude. */
|
|
811
|
+
longitude?: number | null;
|
|
812
|
+
}
|
|
813
|
+
interface ListOrdersResponse {
|
|
814
|
+
/** List of orders. */
|
|
815
|
+
orders?: Order[];
|
|
816
|
+
/** Object containing paging-related data (number of orders returned, offset). */
|
|
817
|
+
pagingMetadata?: PagingMetadataV2;
|
|
818
|
+
}
|
|
819
|
+
interface PagingMetadataV2 {
|
|
820
|
+
/** Number of items returned in the response. */
|
|
821
|
+
count?: number | null;
|
|
822
|
+
/** Offset that was requested. */
|
|
823
|
+
offset?: number | null;
|
|
824
|
+
/** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
|
|
825
|
+
total?: number | null;
|
|
826
|
+
/** Flag that indicates the server failed to calculate the `total` field. */
|
|
827
|
+
tooManyToCount?: boolean | null;
|
|
828
|
+
/** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
|
|
829
|
+
cursors?: Cursors;
|
|
843
830
|
/**
|
|
844
|
-
*
|
|
845
|
-
*
|
|
846
|
-
*
|
|
831
|
+
* Indicates if there are more results after the current page.
|
|
832
|
+
* If `true`, another page of results can be retrieved.
|
|
833
|
+
* If `false`, this is the last page.
|
|
834
|
+
* @internal
|
|
847
835
|
*/
|
|
848
|
-
|
|
836
|
+
hasNext?: boolean | null;
|
|
837
|
+
}
|
|
838
|
+
interface Cursors {
|
|
849
839
|
/**
|
|
850
|
-
*
|
|
851
|
-
* @
|
|
852
|
-
* @maxLength 20
|
|
840
|
+
* Cursor string pointing to the next page in the list of results.
|
|
841
|
+
* @maxLength 16000
|
|
853
842
|
*/
|
|
854
|
-
|
|
843
|
+
next?: string | null;
|
|
855
844
|
/**
|
|
856
|
-
*
|
|
857
|
-
* @
|
|
845
|
+
* Cursor pointing to the previous page in the list of results.
|
|
846
|
+
* @maxLength 16000
|
|
858
847
|
*/
|
|
859
|
-
|
|
848
|
+
prev?: string | null;
|
|
860
849
|
}
|
|
861
|
-
interface
|
|
862
|
-
/** Will be missing if limit is exceeded */
|
|
863
|
-
order?: Order;
|
|
864
|
-
/**
|
|
865
|
-
* Whether the purchase limit has already been reached for this plan by this email.
|
|
866
|
-
* Always false for plans without purchase limits.
|
|
867
|
-
*/
|
|
868
|
-
purchaseLimitExceeded?: boolean;
|
|
850
|
+
interface GetOrdersStatsRequest {
|
|
869
851
|
}
|
|
870
|
-
interface
|
|
871
|
-
/**
|
|
872
|
-
|
|
873
|
-
|
|
874
|
-
|
|
875
|
-
|
|
852
|
+
interface GetOrdersStatsResponse {
|
|
853
|
+
/** Total number of orders. */
|
|
854
|
+
totalOrderCount?: number;
|
|
855
|
+
/** Number of active orders. */
|
|
856
|
+
activeOrderCount?: number;
|
|
857
|
+
}
|
|
858
|
+
interface GetAvailableOrderActionsRequest {
|
|
876
859
|
/**
|
|
877
|
-
*
|
|
860
|
+
* Order ID.
|
|
878
861
|
* @format GUID
|
|
879
862
|
*/
|
|
880
|
-
|
|
881
|
-
/**
|
|
882
|
-
* Start date and time for plan of the previewed order in a `YYYY-MM-DDThh:mm[:ss][.sss]Z` format.
|
|
883
|
-
*
|
|
884
|
-
* Default: Current date and time.
|
|
885
|
-
*/
|
|
886
|
-
startDate?: Date | null;
|
|
887
|
-
/**
|
|
888
|
-
* Coupon code to apply, from the Coupons API.
|
|
889
|
-
* @minLength 1
|
|
890
|
-
* @maxLength 20
|
|
891
|
-
*/
|
|
892
|
-
couponCode?: string | null;
|
|
863
|
+
_id?: string;
|
|
893
864
|
}
|
|
894
|
-
interface
|
|
895
|
-
/**
|
|
896
|
-
|
|
897
|
-
/**
|
|
898
|
-
|
|
899
|
-
|
|
900
|
-
|
|
901
|
-
|
|
902
|
-
|
|
903
|
-
|
|
865
|
+
interface GetAvailableOrderActionsResponse {
|
|
866
|
+
/** Whether the order can be suspended. */
|
|
867
|
+
suspendable?: boolean;
|
|
868
|
+
/** If the order cannot be suspended, a reason is returned here. */
|
|
869
|
+
notSuspendableReason?: ReasonNotSuspendableWithLiterals;
|
|
870
|
+
/** Whether the order can be canceled by the buyer. */
|
|
871
|
+
cancelableByBuyer?: boolean;
|
|
872
|
+
}
|
|
873
|
+
declare enum ReasonNotSuspendable {
|
|
874
|
+
/** Undefined reason. */
|
|
875
|
+
UNDEFINED = "UNDEFINED",
|
|
876
|
+
/** Saved in the database but is awaiting payment. Non-active orders can't be suspended. */
|
|
877
|
+
PENDING = "PENDING",
|
|
878
|
+
/** Trial orders can't be suspended. */
|
|
879
|
+
TRIAL = "TRIAL",
|
|
880
|
+
/** Canceled orders can't be suspended. */
|
|
881
|
+
CANCELED = "CANCELED",
|
|
882
|
+
/** Ended orders can't be suspended. */
|
|
883
|
+
ENDED = "ENDED",
|
|
884
|
+
/** Paid for orders with future start dates can't be suspended. */
|
|
885
|
+
NOT_STARTED = "NOT_STARTED",
|
|
886
|
+
/** Order is already suspended. */
|
|
887
|
+
ALREADY_SUSPENDED = "ALREADY_SUSPENDED",
|
|
888
|
+
/** Orders based on recurring payments using older stripe versions can't be suspended. */
|
|
889
|
+
OLD_STRIPE = "OLD_STRIPE"
|
|
904
890
|
}
|
|
905
|
-
|
|
891
|
+
/** @enumType */
|
|
892
|
+
type ReasonNotSuspendableWithLiterals = ReasonNotSuspendable | 'UNDEFINED' | 'PENDING' | 'TRIAL' | 'CANCELED' | 'ENDED' | 'NOT_STARTED' | 'ALREADY_SUSPENDED' | 'OLD_STRIPE';
|
|
893
|
+
interface PostponeEndDateRequest {
|
|
906
894
|
/**
|
|
907
|
-
* ID
|
|
895
|
+
* Order ID.
|
|
908
896
|
* @format GUID
|
|
909
897
|
*/
|
|
910
|
-
|
|
898
|
+
_id: string;
|
|
911
899
|
/**
|
|
912
|
-
*
|
|
913
|
-
*
|
|
914
|
-
*
|
|
900
|
+
* New end date and time.
|
|
901
|
+
*
|
|
902
|
+
* Must be later than the current end date and time.
|
|
915
903
|
*/
|
|
916
|
-
|
|
904
|
+
endDate: Date | null;
|
|
917
905
|
}
|
|
918
|
-
interface
|
|
906
|
+
interface PostponeEndDateResponse {
|
|
907
|
+
}
|
|
908
|
+
interface OrderEndDatePostponed {
|
|
909
|
+
/** Order whose `endDate` was postponed. */
|
|
910
|
+
order?: Order;
|
|
911
|
+
}
|
|
912
|
+
interface CancelOrderRequest {
|
|
919
913
|
/**
|
|
920
|
-
*
|
|
921
|
-
* @
|
|
922
|
-
* @deprecated __Deprecated.__ Use `prices` instead. This property will be removed on September 30, 2022.
|
|
923
|
-
* @replacedBy prices
|
|
924
|
-
* @targetRemovalDate 2022-10-01
|
|
914
|
+
* Order ID.
|
|
915
|
+
* @format GUID
|
|
925
916
|
*/
|
|
926
|
-
|
|
927
|
-
/**
|
|
928
|
-
|
|
917
|
+
_id: string;
|
|
918
|
+
/** __Required.__ When the order will be canceled. One-time orders can only be canceled `IMMEDIATELY`. */
|
|
919
|
+
effectiveAt: CancellationEffectiveAtWithLiterals;
|
|
929
920
|
}
|
|
930
|
-
interface
|
|
921
|
+
interface CancelOrderResponse {
|
|
922
|
+
}
|
|
923
|
+
/**
|
|
924
|
+
* Emitted when an order is canceled immediately or when cycle ends for an order with canceled auto renewal
|
|
925
|
+
*
|
|
926
|
+
* To determine the specific reason of the cancellation check `order.cancellation.cause` field.
|
|
927
|
+
*/
|
|
928
|
+
interface OrderCanceled {
|
|
929
|
+
/** Canceled order. */
|
|
930
|
+
order?: Order;
|
|
931
|
+
}
|
|
932
|
+
interface MarkAsPaidRequest {
|
|
931
933
|
/**
|
|
932
|
-
*
|
|
934
|
+
* Order ID.
|
|
933
935
|
* @format GUID
|
|
934
936
|
*/
|
|
935
|
-
|
|
936
|
-
/** New valid from date (timestamp). */
|
|
937
|
-
startDate?: Date | null;
|
|
937
|
+
_id: string;
|
|
938
938
|
}
|
|
939
|
-
interface
|
|
940
|
-
/** Updated draft order. */
|
|
941
|
-
order?: Order;
|
|
939
|
+
interface MarkAsPaidResponse {
|
|
942
940
|
}
|
|
943
|
-
interface
|
|
944
|
-
/** Order
|
|
941
|
+
interface OrderMarkedAsPaid {
|
|
942
|
+
/** Order that was marked as paid. */
|
|
945
943
|
order?: Order;
|
|
946
944
|
}
|
|
947
|
-
interface
|
|
945
|
+
interface PauseOrderRequest {
|
|
948
946
|
/**
|
|
949
|
-
*
|
|
947
|
+
* Order ID.
|
|
950
948
|
* @format GUID
|
|
951
949
|
*/
|
|
952
|
-
|
|
950
|
+
_id: string;
|
|
951
|
+
}
|
|
952
|
+
interface PauseOrderResponse {
|
|
953
|
+
}
|
|
954
|
+
interface OrderPaused {
|
|
955
|
+
/** Paused order. */
|
|
956
|
+
order?: Order;
|
|
957
|
+
}
|
|
958
|
+
interface BulkPauseOrderRequest {
|
|
953
959
|
/**
|
|
954
|
-
*
|
|
955
|
-
* @
|
|
956
|
-
* @
|
|
960
|
+
* List of Order IDs.
|
|
961
|
+
* @format GUID
|
|
962
|
+
* @minSize 1
|
|
963
|
+
* @maxSize 100
|
|
957
964
|
*/
|
|
958
|
-
|
|
965
|
+
ids?: string[];
|
|
966
|
+
/** Set to true to return Order entity in response. */
|
|
967
|
+
returnFullEntity?: boolean;
|
|
959
968
|
}
|
|
960
|
-
interface
|
|
961
|
-
/**
|
|
969
|
+
interface BulkPauseOrderResponse {
|
|
970
|
+
/** Orders that were paused. */
|
|
971
|
+
results?: BulkOrderResult[];
|
|
972
|
+
/** Bulk action metadata. */
|
|
973
|
+
bulkActionMetadata?: BulkActionMetadata;
|
|
974
|
+
}
|
|
975
|
+
interface BulkOrderResult {
|
|
976
|
+
/** Item metadata */
|
|
977
|
+
itemMetadata?: ItemMetadata;
|
|
978
|
+
/** The order. */
|
|
962
979
|
order?: Order;
|
|
963
980
|
}
|
|
964
|
-
interface
|
|
981
|
+
interface ItemMetadata {
|
|
982
|
+
/** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
|
|
983
|
+
_id?: string | null;
|
|
984
|
+
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
985
|
+
originalIndex?: number;
|
|
986
|
+
/** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
|
|
987
|
+
success?: boolean;
|
|
988
|
+
/** Details about the error in case of failure. */
|
|
989
|
+
error?: ApplicationError;
|
|
990
|
+
}
|
|
991
|
+
interface ApplicationError {
|
|
992
|
+
/** Error code. */
|
|
993
|
+
code?: string;
|
|
994
|
+
/** Description of the error. */
|
|
995
|
+
description?: string;
|
|
996
|
+
/** Data related to the error. */
|
|
997
|
+
data?: Record<string, any> | null;
|
|
998
|
+
}
|
|
999
|
+
interface BulkActionMetadata {
|
|
1000
|
+
/** Number of items that were successfully processed. */
|
|
1001
|
+
totalSuccesses?: number;
|
|
1002
|
+
/** Number of items that couldn't be processed. */
|
|
1003
|
+
totalFailures?: number;
|
|
1004
|
+
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
1005
|
+
undetailedFailures?: number;
|
|
1006
|
+
}
|
|
1007
|
+
interface ResumeOrderRequest {
|
|
965
1008
|
/**
|
|
966
1009
|
* Order ID.
|
|
967
1010
|
* @format GUID
|
|
968
1011
|
*/
|
|
969
|
-
|
|
1012
|
+
_id: string;
|
|
1013
|
+
}
|
|
1014
|
+
interface ResumeOrderResponse {
|
|
1015
|
+
}
|
|
1016
|
+
interface OrderResumed {
|
|
1017
|
+
/** Resumed order. */
|
|
1018
|
+
order?: Order;
|
|
1019
|
+
}
|
|
1020
|
+
interface BulkResumeOrderRequest {
|
|
970
1021
|
/**
|
|
971
|
-
*
|
|
1022
|
+
* List of Order IDs.
|
|
972
1023
|
* @format GUID
|
|
1024
|
+
* @minSize 1
|
|
1025
|
+
* @maxSize 100
|
|
973
1026
|
*/
|
|
974
|
-
|
|
1027
|
+
ids?: string[];
|
|
1028
|
+
/** Set to true to return Order entity in response. */
|
|
1029
|
+
returnFullEntity?: boolean;
|
|
975
1030
|
}
|
|
976
|
-
interface
|
|
977
|
-
/**
|
|
978
|
-
|
|
1031
|
+
interface BulkResumeOrderResponse {
|
|
1032
|
+
/** Orders that were resumed. */
|
|
1033
|
+
results?: BulkOrderResult[];
|
|
1034
|
+
/** Bulk action metadata. */
|
|
1035
|
+
bulkActionMetadata?: BulkActionMetadata;
|
|
979
1036
|
}
|
|
980
1037
|
interface MessageEnvelope {
|
|
981
1038
|
/**
|
|
@@ -1068,373 +1125,322 @@ interface AccountInfo {
|
|
|
1068
1125
|
*/
|
|
1069
1126
|
siteId?: string | null;
|
|
1070
1127
|
}
|
|
1071
|
-
interface
|
|
1072
|
-
/**
|
|
1073
|
-
|
|
1074
|
-
|
|
1075
|
-
|
|
1076
|
-
|
|
1077
|
-
|
|
1128
|
+
interface CreateOnlineOrderRequest {
|
|
1129
|
+
/**
|
|
1130
|
+
* Plan ID.
|
|
1131
|
+
* @format GUID
|
|
1132
|
+
*/
|
|
1133
|
+
planId: string;
|
|
1134
|
+
/**
|
|
1135
|
+
* Start date and time for the plan of the online order in a `YYYY-MM-DDThh:mm[:ss][.sss]Z` format.
|
|
1136
|
+
*
|
|
1137
|
+
* Default: Current date and time.
|
|
1138
|
+
*/
|
|
1139
|
+
startDate?: Date | null;
|
|
1140
|
+
/**
|
|
1141
|
+
* Coupon code to apply.
|
|
1142
|
+
* @minLength 1
|
|
1143
|
+
* @maxLength 20
|
|
1144
|
+
*/
|
|
1145
|
+
couponCode?: string | null;
|
|
1146
|
+
/** Provided if checkout is initiated on buyer's behalf. */
|
|
1147
|
+
onBehalf?: OnBehalf;
|
|
1148
|
+
/**
|
|
1149
|
+
* Submission ID of the form submitted with this order.
|
|
1150
|
+
*
|
|
1151
|
+
* The submission must belong to the form attached to the plan, and that form must belong to the Pricing Plans namespace.
|
|
1152
|
+
* An invalid submission ID is dropped and the order is created without a submission.
|
|
1153
|
+
* @format GUID
|
|
1154
|
+
*/
|
|
1155
|
+
submissionId?: string | null;
|
|
1078
1156
|
}
|
|
1079
|
-
|
|
1080
|
-
|
|
1081
|
-
|
|
1082
|
-
|
|
1083
|
-
|
|
1084
|
-
|
|
1085
|
-
/**
|
|
1086
|
-
|
|
1087
|
-
/** 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. */
|
|
1088
|
-
cycleNumber?: number;
|
|
1157
|
+
interface OnBehalf {
|
|
1158
|
+
/**
|
|
1159
|
+
* Member ID.
|
|
1160
|
+
* @format GUID
|
|
1161
|
+
*/
|
|
1162
|
+
memberId?: string;
|
|
1163
|
+
/** Method by which checkout is initiated. */
|
|
1164
|
+
orderMethod?: OrderMethodWithLiterals;
|
|
1089
1165
|
}
|
|
1090
|
-
|
|
1091
|
-
|
|
1092
|
-
/** Order that is canceled, effective at the end of the current payment cycle. */
|
|
1166
|
+
interface CreateOnlineOrderResponse {
|
|
1167
|
+
/** Created online order. */
|
|
1093
1168
|
order?: Order;
|
|
1094
1169
|
}
|
|
1095
|
-
interface
|
|
1096
|
-
/**
|
|
1097
|
-
|
|
1170
|
+
interface CouponsError {
|
|
1171
|
+
/** Coupon code. */
|
|
1172
|
+
couponCode?: string;
|
|
1173
|
+
/** Plan ID. */
|
|
1174
|
+
planId?: string;
|
|
1098
1175
|
}
|
|
1099
|
-
interface
|
|
1176
|
+
interface CreateGuestOnlineOrderRequest {
|
|
1100
1177
|
/**
|
|
1101
|
-
*
|
|
1178
|
+
* Plan ID.
|
|
1102
1179
|
* @format GUID
|
|
1103
1180
|
*/
|
|
1104
|
-
|
|
1181
|
+
planId?: string;
|
|
1105
1182
|
/**
|
|
1106
|
-
*
|
|
1183
|
+
* Start date for the ordered plan.
|
|
1107
1184
|
*
|
|
1108
|
-
* Default:
|
|
1185
|
+
* Default: Current date
|
|
1186
|
+
*/
|
|
1187
|
+
startDate?: Date | null;
|
|
1188
|
+
/**
|
|
1189
|
+
* Coupon code to apply.
|
|
1190
|
+
* @minLength 1
|
|
1191
|
+
* @maxLength 20
|
|
1192
|
+
*/
|
|
1193
|
+
couponCode?: string | null;
|
|
1194
|
+
/** Captcha data to prove you are not a robot */
|
|
1195
|
+
captcha?: Captcha;
|
|
1196
|
+
/** Visitor info */
|
|
1197
|
+
guest?: Guest;
|
|
1198
|
+
/**
|
|
1199
|
+
* Form submission id that was submitted together with the order
|
|
1200
|
+
* @format GUID
|
|
1201
|
+
*/
|
|
1202
|
+
submissionId?: string | null;
|
|
1203
|
+
}
|
|
1204
|
+
interface Captcha {
|
|
1205
|
+
/** Token from captcha */
|
|
1206
|
+
token?: string;
|
|
1207
|
+
}
|
|
1208
|
+
interface Guest {
|
|
1209
|
+
/**
|
|
1210
|
+
* Email for checkout
|
|
1211
|
+
* @format EMAIL
|
|
1109
1212
|
*/
|
|
1110
|
-
|
|
1111
|
-
}
|
|
1112
|
-
declare enum Set {
|
|
1113
|
-
/** Same behavior as `BASIC`.` */
|
|
1114
|
-
UNKNOWN_SET = "UNKNOWN_SET",
|
|
1115
|
-
/** Doesn't return any order form submission data. */
|
|
1116
|
-
BASIC = "BASIC",
|
|
1117
|
-
/** Returns all order form submission data. */
|
|
1118
|
-
FULL = "FULL"
|
|
1213
|
+
email?: string;
|
|
1119
1214
|
}
|
|
1120
|
-
|
|
1121
|
-
type SetWithLiterals = Set | 'UNKNOWN_SET' | 'BASIC' | 'FULL';
|
|
1122
|
-
interface GetOrderResponse {
|
|
1215
|
+
interface CreateGuestOnlineOrderResponse {
|
|
1123
1216
|
/** Order. */
|
|
1124
1217
|
order?: Order;
|
|
1125
1218
|
}
|
|
1126
|
-
interface
|
|
1219
|
+
interface CreateOfflineOrderRequest {
|
|
1127
1220
|
/**
|
|
1128
|
-
*
|
|
1221
|
+
* ID of the plan being ordered, from the Plans API.
|
|
1129
1222
|
* @format GUID
|
|
1130
1223
|
*/
|
|
1131
|
-
|
|
1224
|
+
planId: string;
|
|
1132
1225
|
/**
|
|
1133
|
-
*
|
|
1226
|
+
* ID of the member ordering the plan, from the Members API.
|
|
1134
1227
|
* @format GUID
|
|
1135
1228
|
*/
|
|
1136
|
-
|
|
1137
|
-
/** Filter by whether or not the auto-renewal of recurring orders was canceled. */
|
|
1138
|
-
autoRenewCanceled?: boolean | null;
|
|
1139
|
-
/** Filter by order status. */
|
|
1140
|
-
orderStatuses?: OrderStatusWithLiterals[];
|
|
1141
|
-
/** Filter by payment status. */
|
|
1142
|
-
paymentStatuses?: PaymentStatusWithLiterals[];
|
|
1229
|
+
memberId: string;
|
|
1143
1230
|
/**
|
|
1144
|
-
*
|
|
1231
|
+
* Start date and time for the ordered plan in a `YYYY-MM-DDThh:mm[:ss][.sss]Z` format.
|
|
1145
1232
|
*
|
|
1146
|
-
*
|
|
1147
|
-
* @min 1
|
|
1148
|
-
* @max 50
|
|
1233
|
+
* Default: Current date and time.
|
|
1149
1234
|
*/
|
|
1150
|
-
|
|
1151
|
-
/** Number of orders to skip in the current sort order. */
|
|
1152
|
-
offset?: number | null;
|
|
1235
|
+
startDate?: Date | null;
|
|
1153
1236
|
/**
|
|
1154
|
-
*
|
|
1155
|
-
*
|
|
1156
|
-
* Use `ASC` for ascending order or `DESC` for descending order.
|
|
1237
|
+
* Whether the order is paid.
|
|
1157
1238
|
*
|
|
1158
|
-
* Default: `
|
|
1239
|
+
* Default: `false`
|
|
1159
1240
|
*/
|
|
1160
|
-
|
|
1241
|
+
paid?: boolean | null;
|
|
1161
1242
|
/**
|
|
1162
|
-
*
|
|
1243
|
+
* Coupon code to apply, from the Coupons API.
|
|
1244
|
+
* @minLength 1
|
|
1245
|
+
* @maxLength 20
|
|
1246
|
+
*/
|
|
1247
|
+
couponCode?: string | null;
|
|
1248
|
+
/**
|
|
1249
|
+
* Form submission ID that was submitted with the order.
|
|
1163
1250
|
*
|
|
1164
|
-
*
|
|
1251
|
+
* The submission must belong to the form attached to the plan, and that form must belong to the Pricing Plans namespace.
|
|
1252
|
+
* An invalid submission ID is dropped and the order is created without a submission.
|
|
1253
|
+
* @format GUID
|
|
1165
1254
|
*/
|
|
1166
|
-
|
|
1255
|
+
submissionId?: string | null;
|
|
1256
|
+
}
|
|
1257
|
+
interface CreateOfflineOrderResponse {
|
|
1258
|
+
/** Order. */
|
|
1259
|
+
order?: Order;
|
|
1260
|
+
}
|
|
1261
|
+
interface CreateExternalOrderRequest {
|
|
1167
1262
|
/**
|
|
1168
|
-
*
|
|
1169
|
-
* @internal
|
|
1263
|
+
* Plan ID.
|
|
1170
1264
|
* @format GUID
|
|
1171
|
-
* @maxSize 50
|
|
1172
1265
|
*/
|
|
1173
|
-
|
|
1266
|
+
planId?: string;
|
|
1267
|
+
/**
|
|
1268
|
+
* Form submission id that was submitted together with the order
|
|
1269
|
+
* @format GUID
|
|
1270
|
+
*/
|
|
1271
|
+
submissionId?: string | null;
|
|
1174
1272
|
}
|
|
1175
|
-
interface
|
|
1273
|
+
interface CreateExternalOrderResponse {
|
|
1274
|
+
/** Created order */
|
|
1275
|
+
order?: Order;
|
|
1276
|
+
}
|
|
1277
|
+
interface GetOnlineOrderPreviewRequest {
|
|
1176
1278
|
/**
|
|
1177
|
-
*
|
|
1178
|
-
* @
|
|
1279
|
+
* Plan ID.
|
|
1280
|
+
* @format GUID
|
|
1179
1281
|
*/
|
|
1180
|
-
|
|
1181
|
-
/** Sort order. */
|
|
1182
|
-
order?: SortOrderWithLiterals;
|
|
1282
|
+
planId: string;
|
|
1183
1283
|
/**
|
|
1184
|
-
*
|
|
1185
|
-
* a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.
|
|
1186
|
-
*
|
|
1187
|
-
* If multiple filters are provided, they are combined with AND operator.
|
|
1284
|
+
* Start date and time for the plan of the order preview in a `YYYY-MM-DDThh:mm[:ss][.sss]Z` format.
|
|
1188
1285
|
*
|
|
1189
|
-
*
|
|
1190
|
-
* Given we have document like {"id": "1", "nestedField": [{"price": 10, "region": "EU"}, {"price": 20, "region": "US"}]}
|
|
1191
|
-
* and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be
|
|
1192
|
-
* { fieldName: "nestedField.price", "select_items_by": [{"nestedField.region": "US"}] }
|
|
1193
|
-
* @internal
|
|
1194
|
-
* @maxSize 10
|
|
1286
|
+
* Default: Current date and time.
|
|
1195
1287
|
*/
|
|
1196
|
-
|
|
1288
|
+
startDate?: Date | null;
|
|
1197
1289
|
/**
|
|
1198
|
-
*
|
|
1199
|
-
*
|
|
1290
|
+
* Coupon code to apply.
|
|
1291
|
+
* @minLength 1
|
|
1292
|
+
* @maxLength 20
|
|
1200
1293
|
*/
|
|
1201
|
-
|
|
1202
|
-
}
|
|
1203
|
-
declare enum SortOrder {
|
|
1204
|
-
ASC = "ASC",
|
|
1205
|
-
DESC = "DESC"
|
|
1206
|
-
}
|
|
1207
|
-
/** @enumType */
|
|
1208
|
-
type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
1209
|
-
interface AddressLocation {
|
|
1210
|
-
/** Address latitude. */
|
|
1211
|
-
latitude?: number | null;
|
|
1212
|
-
/** Address longitude. */
|
|
1213
|
-
longitude?: number | null;
|
|
1294
|
+
couponCode?: string | null;
|
|
1214
1295
|
}
|
|
1215
|
-
interface
|
|
1216
|
-
/**
|
|
1217
|
-
|
|
1218
|
-
/**
|
|
1219
|
-
|
|
1296
|
+
interface GetOnlineOrderPreviewResponse {
|
|
1297
|
+
/** Order preview. This field is undefined if the member has already reached the purchase limit for the order's plan. */
|
|
1298
|
+
order?: Order;
|
|
1299
|
+
/** Whether the member has already reached purchase limit for the order's plan. */
|
|
1300
|
+
purchaseLimitExceeded?: boolean;
|
|
1220
1301
|
}
|
|
1221
|
-
interface
|
|
1222
|
-
/** Number of items returned in the response. */
|
|
1223
|
-
count?: number | null;
|
|
1224
|
-
/** Offset that was requested. */
|
|
1225
|
-
offset?: number | null;
|
|
1226
|
-
/** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
|
|
1227
|
-
total?: number | null;
|
|
1228
|
-
/** Flag that indicates the server failed to calculate the `total` field. */
|
|
1229
|
-
tooManyToCount?: boolean | null;
|
|
1230
|
-
/** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
|
|
1231
|
-
cursors?: Cursors;
|
|
1302
|
+
interface GetGuestOnlineOrderPreviewRequest {
|
|
1232
1303
|
/**
|
|
1233
|
-
*
|
|
1234
|
-
*
|
|
1235
|
-
* If `false`, this is the last page.
|
|
1236
|
-
* @internal
|
|
1304
|
+
* Plan ID.
|
|
1305
|
+
* @format GUID
|
|
1237
1306
|
*/
|
|
1238
|
-
|
|
1239
|
-
}
|
|
1240
|
-
interface Cursors {
|
|
1307
|
+
planId?: string;
|
|
1241
1308
|
/**
|
|
1242
|
-
*
|
|
1243
|
-
*
|
|
1309
|
+
* Start date for the ordered plan.
|
|
1310
|
+
*
|
|
1311
|
+
* Default: Current date
|
|
1244
1312
|
*/
|
|
1245
|
-
|
|
1313
|
+
startDate?: Date | null;
|
|
1246
1314
|
/**
|
|
1247
|
-
*
|
|
1248
|
-
* @
|
|
1315
|
+
* Coupon code to apply.
|
|
1316
|
+
* @minLength 1
|
|
1317
|
+
* @maxLength 20
|
|
1249
1318
|
*/
|
|
1250
|
-
|
|
1251
|
-
|
|
1252
|
-
|
|
1319
|
+
couponCode?: string | null;
|
|
1320
|
+
/**
|
|
1321
|
+
* Email for checkout
|
|
1322
|
+
* @format EMAIL
|
|
1323
|
+
*/
|
|
1324
|
+
email?: string;
|
|
1253
1325
|
}
|
|
1254
|
-
interface
|
|
1255
|
-
/**
|
|
1256
|
-
|
|
1257
|
-
/**
|
|
1258
|
-
|
|
1326
|
+
interface GetGuestOnlineOrderPreviewResponse {
|
|
1327
|
+
/** Will be missing if limit is exceeded */
|
|
1328
|
+
order?: Order;
|
|
1329
|
+
/**
|
|
1330
|
+
* Whether the purchase limit has already been reached for this plan by this email.
|
|
1331
|
+
* Always false for plans without purchase limits.
|
|
1332
|
+
*/
|
|
1333
|
+
purchaseLimitExceeded?: boolean;
|
|
1259
1334
|
}
|
|
1260
|
-
interface
|
|
1335
|
+
interface GetOfflineOrderPreviewRequest {
|
|
1261
1336
|
/**
|
|
1262
|
-
*
|
|
1337
|
+
* ID of the plan of the previewed order, from the Plans API.
|
|
1263
1338
|
* @format GUID
|
|
1264
1339
|
*/
|
|
1265
|
-
|
|
1266
|
-
}
|
|
1267
|
-
interface GetAvailableOrderActionsResponse {
|
|
1268
|
-
/** Whether the order can be suspended. */
|
|
1269
|
-
suspendable?: boolean;
|
|
1270
|
-
/** If the order cannot be suspended, a reason is returned here. */
|
|
1271
|
-
notSuspendableReason?: ReasonNotSuspendableWithLiterals;
|
|
1272
|
-
/** Whether the order can be canceled by the buyer. */
|
|
1273
|
-
cancelableByBuyer?: boolean;
|
|
1274
|
-
}
|
|
1275
|
-
declare enum ReasonNotSuspendable {
|
|
1276
|
-
/** Undefined reason. */
|
|
1277
|
-
UNDEFINED = "UNDEFINED",
|
|
1278
|
-
/** Saved in the database but is awaiting payment. Non-active orders can't be suspended. */
|
|
1279
|
-
PENDING = "PENDING",
|
|
1280
|
-
/** Trial orders can't be suspended. */
|
|
1281
|
-
TRIAL = "TRIAL",
|
|
1282
|
-
/** Canceled orders can't be suspended. */
|
|
1283
|
-
CANCELED = "CANCELED",
|
|
1284
|
-
/** Ended orders can't be suspended. */
|
|
1285
|
-
ENDED = "ENDED",
|
|
1286
|
-
/** Paid for orders with future start dates can't be suspended. */
|
|
1287
|
-
NOT_STARTED = "NOT_STARTED",
|
|
1288
|
-
/** Order is already suspended. */
|
|
1289
|
-
ALREADY_SUSPENDED = "ALREADY_SUSPENDED",
|
|
1290
|
-
/** Orders based on recurring payments using older stripe versions can't be suspended. */
|
|
1291
|
-
OLD_STRIPE = "OLD_STRIPE"
|
|
1292
|
-
}
|
|
1293
|
-
/** @enumType */
|
|
1294
|
-
type ReasonNotSuspendableWithLiterals = ReasonNotSuspendable | 'UNDEFINED' | 'PENDING' | 'TRIAL' | 'CANCELED' | 'ENDED' | 'NOT_STARTED' | 'ALREADY_SUSPENDED' | 'OLD_STRIPE';
|
|
1295
|
-
interface PostponeEndDateRequest {
|
|
1340
|
+
planId: string;
|
|
1296
1341
|
/**
|
|
1297
|
-
*
|
|
1342
|
+
* Member ID of the buyer the previewed order is for, from the Members API.
|
|
1298
1343
|
* @format GUID
|
|
1299
1344
|
*/
|
|
1300
|
-
|
|
1345
|
+
memberId: string;
|
|
1301
1346
|
/**
|
|
1302
|
-
*
|
|
1347
|
+
* Start date and time for plan of the previewed order in a `YYYY-MM-DDThh:mm[:ss][.sss]Z` format.
|
|
1303
1348
|
*
|
|
1304
|
-
*
|
|
1349
|
+
* Default: Current date and time.
|
|
1305
1350
|
*/
|
|
1306
|
-
|
|
1307
|
-
}
|
|
1308
|
-
interface PostponeEndDateResponse {
|
|
1309
|
-
}
|
|
1310
|
-
interface OrderEndDatePostponed {
|
|
1311
|
-
/** Order whose `endDate` was postponed. */
|
|
1312
|
-
order?: Order;
|
|
1313
|
-
}
|
|
1314
|
-
interface CancelOrderRequest {
|
|
1351
|
+
startDate?: Date | null;
|
|
1315
1352
|
/**
|
|
1316
|
-
*
|
|
1317
|
-
* @
|
|
1318
|
-
|
|
1319
|
-
|
|
1320
|
-
|
|
1321
|
-
effectiveAt: CancellationEffectiveAtWithLiterals;
|
|
1322
|
-
}
|
|
1323
|
-
interface CancelOrderResponse {
|
|
1353
|
+
* Coupon code to apply, from the Coupons API.
|
|
1354
|
+
* @minLength 1
|
|
1355
|
+
* @maxLength 20
|
|
1356
|
+
*/
|
|
1357
|
+
couponCode?: string | null;
|
|
1324
1358
|
}
|
|
1325
|
-
|
|
1326
|
-
|
|
1327
|
-
*
|
|
1328
|
-
* To determine the specific reason of the cancellation check `order.cancellation.cause` field.
|
|
1329
|
-
*/
|
|
1330
|
-
interface OrderCanceled {
|
|
1331
|
-
/** Canceled order. */
|
|
1359
|
+
interface GetOfflineOrderPreviewResponse {
|
|
1360
|
+
/** The previewed order, as if the plan had been ordered. */
|
|
1332
1361
|
order?: Order;
|
|
1362
|
+
/**
|
|
1363
|
+
* Whether this previewed order would exceed the permitted amount of purchases available
|
|
1364
|
+
* for this plan for this buyer.
|
|
1365
|
+
*
|
|
1366
|
+
* Always `false` for plans that do not have purchase limits.
|
|
1367
|
+
*/
|
|
1368
|
+
purchaseLimitExceeded?: boolean;
|
|
1333
1369
|
}
|
|
1334
|
-
interface
|
|
1370
|
+
interface GetPricePreviewRequest {
|
|
1335
1371
|
/**
|
|
1336
|
-
*
|
|
1372
|
+
* ID of plan to preview.
|
|
1337
1373
|
* @format GUID
|
|
1338
1374
|
*/
|
|
1339
|
-
|
|
1340
|
-
|
|
1341
|
-
|
|
1375
|
+
planId: string;
|
|
1376
|
+
/**
|
|
1377
|
+
* Coupon code to apply, from the Coupons API.
|
|
1378
|
+
* @minLength 1
|
|
1379
|
+
* @maxLength 20
|
|
1380
|
+
*/
|
|
1381
|
+
couponCode?: string | null;
|
|
1342
1382
|
}
|
|
1343
|
-
interface
|
|
1344
|
-
/**
|
|
1345
|
-
|
|
1383
|
+
interface GetPricePreviewResponse {
|
|
1384
|
+
/**
|
|
1385
|
+
* @internal
|
|
1386
|
+
* @internal
|
|
1387
|
+
* @deprecated __Deprecated.__ Use `prices` instead. This property will be removed on September 30, 2022.
|
|
1388
|
+
* @replacedBy prices
|
|
1389
|
+
* @targetRemovalDate 2022-10-01
|
|
1390
|
+
*/
|
|
1391
|
+
price?: PriceDetails;
|
|
1392
|
+
/** Pricing details. */
|
|
1393
|
+
prices?: SpannedPrice[];
|
|
1346
1394
|
}
|
|
1347
|
-
interface
|
|
1395
|
+
interface ChangeStartDateRequest {
|
|
1348
1396
|
/**
|
|
1349
|
-
*
|
|
1397
|
+
* Draft order ID.
|
|
1350
1398
|
* @format GUID
|
|
1351
1399
|
*/
|
|
1352
|
-
|
|
1400
|
+
orderId?: string;
|
|
1401
|
+
/** New valid from date (timestamp). */
|
|
1402
|
+
startDate?: Date | null;
|
|
1353
1403
|
}
|
|
1354
|
-
interface
|
|
1404
|
+
interface ChangeStartDateResponse {
|
|
1405
|
+
/** Updated draft order. */
|
|
1406
|
+
order?: Order;
|
|
1355
1407
|
}
|
|
1356
|
-
interface
|
|
1357
|
-
/**
|
|
1408
|
+
interface OrderStartDateChanged {
|
|
1409
|
+
/** Order whose `startDate` changed. */
|
|
1358
1410
|
order?: Order;
|
|
1359
1411
|
}
|
|
1360
|
-
interface
|
|
1412
|
+
interface ApplyCouponRequest {
|
|
1361
1413
|
/**
|
|
1362
|
-
*
|
|
1414
|
+
* Draft order ID.
|
|
1363
1415
|
* @format GUID
|
|
1364
|
-
* @minSize 1
|
|
1365
|
-
* @maxSize 100
|
|
1366
1416
|
*/
|
|
1367
|
-
|
|
1368
|
-
/**
|
|
1369
|
-
|
|
1370
|
-
|
|
1371
|
-
|
|
1372
|
-
|
|
1373
|
-
|
|
1374
|
-
/** Bulk action metadata. */
|
|
1375
|
-
bulkActionMetadata?: BulkActionMetadata;
|
|
1417
|
+
orderId?: string;
|
|
1418
|
+
/**
|
|
1419
|
+
* Coupon code to apply.
|
|
1420
|
+
* @minLength 1
|
|
1421
|
+
* @maxLength 20
|
|
1422
|
+
*/
|
|
1423
|
+
couponCode?: string;
|
|
1376
1424
|
}
|
|
1377
|
-
interface
|
|
1378
|
-
/**
|
|
1379
|
-
itemMetadata?: ItemMetadata;
|
|
1380
|
-
/** The order. */
|
|
1425
|
+
interface ApplyCouponResponse {
|
|
1426
|
+
/** Order with applied coupon and recalculated tax. */
|
|
1381
1427
|
order?: Order;
|
|
1382
1428
|
}
|
|
1383
|
-
interface
|
|
1384
|
-
/** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
|
|
1385
|
-
_id?: string | null;
|
|
1386
|
-
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
1387
|
-
originalIndex?: number;
|
|
1388
|
-
/** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
|
|
1389
|
-
success?: boolean;
|
|
1390
|
-
/** Details about the error in case of failure. */
|
|
1391
|
-
error?: ApplicationError;
|
|
1392
|
-
}
|
|
1393
|
-
interface ApplicationError {
|
|
1394
|
-
/** Error code. */
|
|
1395
|
-
code?: string;
|
|
1396
|
-
/** Description of the error. */
|
|
1397
|
-
description?: string;
|
|
1398
|
-
/** Data related to the error. */
|
|
1399
|
-
data?: Record<string, any> | null;
|
|
1400
|
-
}
|
|
1401
|
-
interface BulkActionMetadata {
|
|
1402
|
-
/** Number of items that were successfully processed. */
|
|
1403
|
-
totalSuccesses?: number;
|
|
1404
|
-
/** Number of items that couldn't be processed. */
|
|
1405
|
-
totalFailures?: number;
|
|
1406
|
-
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
1407
|
-
undetailedFailures?: number;
|
|
1408
|
-
}
|
|
1409
|
-
interface ResumeOrderRequest {
|
|
1429
|
+
interface SetSubmissionRequest {
|
|
1410
1430
|
/**
|
|
1411
1431
|
* Order ID.
|
|
1412
1432
|
* @format GUID
|
|
1413
1433
|
*/
|
|
1414
|
-
|
|
1415
|
-
}
|
|
1416
|
-
interface ResumeOrderResponse {
|
|
1417
|
-
}
|
|
1418
|
-
interface OrderResumed {
|
|
1419
|
-
/** Resumed order. */
|
|
1420
|
-
order?: Order;
|
|
1421
|
-
}
|
|
1422
|
-
interface BulkResumeOrderRequest {
|
|
1434
|
+
orderId?: string;
|
|
1423
1435
|
/**
|
|
1424
|
-
*
|
|
1436
|
+
* Submission ID.
|
|
1425
1437
|
* @format GUID
|
|
1426
|
-
* @minSize 1
|
|
1427
|
-
* @maxSize 100
|
|
1428
1438
|
*/
|
|
1429
|
-
|
|
1430
|
-
/** Set to true to return Order entity in response. */
|
|
1431
|
-
returnFullEntity?: boolean;
|
|
1439
|
+
submissionId?: string;
|
|
1432
1440
|
}
|
|
1433
|
-
interface
|
|
1434
|
-
/**
|
|
1435
|
-
|
|
1436
|
-
/** Bulk action metadata. */
|
|
1437
|
-
bulkActionMetadata?: BulkActionMetadata;
|
|
1441
|
+
interface SetSubmissionResponse {
|
|
1442
|
+
/** Order with submission id */
|
|
1443
|
+
order?: Order;
|
|
1438
1444
|
}
|
|
1439
1445
|
interface MemberGetOrderRequest {
|
|
1440
1446
|
/**
|
|
@@ -1850,12 +1856,16 @@ interface AccountInfoMetadata {
|
|
|
1850
1856
|
/** ID of the parent Wix account. Only included when 'accountId' belongs to a child account. */
|
|
1851
1857
|
parentAccountId?: string;
|
|
1852
1858
|
}
|
|
1853
|
-
interface
|
|
1854
|
-
|
|
1859
|
+
interface OrderAutoRenewCanceledEnvelope {
|
|
1860
|
+
data: OrderAutoRenewCanceled;
|
|
1855
1861
|
metadata: EventMetadata;
|
|
1856
1862
|
}
|
|
1857
1863
|
/**
|
|
1858
|
-
* Triggered when an order is
|
|
1864
|
+
* Triggered when an order is canceled and `effectiveAt` is set to `NEXT_PAYMENT_DATE`.
|
|
1865
|
+
*
|
|
1866
|
+
* This webhook is *not* triggered in the following scenarios:
|
|
1867
|
+
* + When an order is canceled and `effectiveAt` is set to `IMMEDIATELY`. Instead, at the time of cancellation, Order Canceled is triggered.
|
|
1868
|
+
* + 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.
|
|
1859
1869
|
* @permissionScope Manage_Wix_Rentals_App_Forms_submissions
|
|
1860
1870
|
* @permissionScopeId SCOPE.RENTALS.MANAGE
|
|
1861
1871
|
* @permissionScope Manage Orders
|
|
@@ -1868,17 +1878,21 @@ interface OrderCreatedEnvelope {
|
|
|
1868
1878
|
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1869
1879
|
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
1870
1880
|
* @webhook
|
|
1871
|
-
* @eventType wix.pricing_plans.v2.
|
|
1872
|
-
* @serviceIdentifier com.wixpress.membership.v2.orders.
|
|
1873
|
-
* @slug
|
|
1881
|
+
* @eventType wix.pricing_plans.v2.order_auto_renew_canceled
|
|
1882
|
+
* @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
|
|
1883
|
+
* @slug auto_renew_canceled
|
|
1874
1884
|
*/
|
|
1875
|
-
declare function
|
|
1876
|
-
interface
|
|
1877
|
-
data:
|
|
1885
|
+
declare function onOrderAutoRenewCanceled(handler: (event: OrderAutoRenewCanceledEnvelope) => void | Promise<void>): void;
|
|
1886
|
+
interface OrderCanceledEnvelope {
|
|
1887
|
+
data: OrderCanceled;
|
|
1878
1888
|
metadata: EventMetadata;
|
|
1879
1889
|
}
|
|
1880
1890
|
/**
|
|
1881
|
-
* Triggered when an order
|
|
1891
|
+
* Triggered when an order is canceled.
|
|
1892
|
+
*
|
|
1893
|
+
* This webhook is triggered either immediately or at the end of the current payment cycle, as follows:
|
|
1894
|
+
* + If the order is canceled and `effectiveAt` is set to `IMMEDIATELY`, the webhook is triggered immediately when canceled.
|
|
1895
|
+
* + 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.
|
|
1882
1896
|
* @permissionScope Manage_Wix_Rentals_App_Forms_submissions
|
|
1883
1897
|
* @permissionScopeId SCOPE.RENTALS.MANAGE
|
|
1884
1898
|
* @permissionScope Manage Orders
|
|
@@ -1891,25 +1905,19 @@ interface OrderStartDateChangedEnvelope {
|
|
|
1891
1905
|
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1892
1906
|
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
1893
1907
|
* @webhook
|
|
1894
|
-
* @eventType wix.pricing_plans.v2.
|
|
1895
|
-
* @serviceIdentifier com.wixpress.membership.v2.orders.
|
|
1896
|
-
* @slug
|
|
1908
|
+
* @eventType wix.pricing_plans.v2.order_canceled
|
|
1909
|
+
* @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
|
|
1910
|
+
* @slug canceled
|
|
1897
1911
|
*/
|
|
1898
|
-
declare function
|
|
1899
|
-
interface
|
|
1900
|
-
|
|
1912
|
+
declare function onOrderCanceled(handler: (event: OrderCanceledEnvelope) => void | Promise<void>): void;
|
|
1913
|
+
interface OrderCycleStartedEnvelope {
|
|
1914
|
+
data: OrderCycleStarted;
|
|
1901
1915
|
metadata: EventMetadata;
|
|
1902
1916
|
}
|
|
1903
1917
|
/**
|
|
1904
|
-
* Triggered
|
|
1918
|
+
* Triggered at the start of a new payment cycle for an existing order.
|
|
1905
1919
|
*
|
|
1906
|
-
*
|
|
1907
|
-
* + Order reaches its start date or end date. Order Started and Order Ended, respectively, are also triggered.
|
|
1908
|
-
* + New payment cycle of an order starts. Order Cycle Started is also triggered.
|
|
1909
|
-
* + Offline order is marked as paid. Order Marked As Paid is also triggered.
|
|
1910
|
-
* + End date of the order is postponed. Order End Date Postponed is also triggered
|
|
1911
|
-
* + Order is paused, or a paused order is resumed. Order Paused and Order Resumed, respectively, are also triggered.
|
|
1912
|
-
* + Order is canceled, either immediately or at the end of the payment cycle. Order Canceled and Order Auto Renew Canceled, respectively, are also triggered.
|
|
1920
|
+
* Not triggered at the initial start of an offline order.
|
|
1913
1921
|
* @permissionScope Manage_Wix_Rentals_App_Forms_submissions
|
|
1914
1922
|
* @permissionScopeId SCOPE.RENTALS.MANAGE
|
|
1915
1923
|
* @permissionScope Manage Orders
|
|
@@ -1922,21 +1930,67 @@ interface OrderUpdatedEnvelope {
|
|
|
1922
1930
|
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1923
1931
|
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
1924
1932
|
* @webhook
|
|
1925
|
-
* @eventType wix.pricing_plans.v2.
|
|
1926
|
-
* @serviceIdentifier com.wixpress.membership.v2.orders.
|
|
1927
|
-
* @slug
|
|
1933
|
+
* @eventType wix.pricing_plans.v2.order_cycle_started
|
|
1934
|
+
* @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
|
|
1935
|
+
* @slug cycle_started
|
|
1928
1936
|
*/
|
|
1929
|
-
declare function
|
|
1930
|
-
interface
|
|
1931
|
-
data:
|
|
1937
|
+
declare function onOrderCycleStarted(handler: (event: OrderCycleStartedEnvelope) => void | Promise<void>): void;
|
|
1938
|
+
interface OrderEndDatePostponedEnvelope {
|
|
1939
|
+
data: OrderEndDatePostponed;
|
|
1932
1940
|
metadata: EventMetadata;
|
|
1933
1941
|
}
|
|
1934
1942
|
/**
|
|
1935
|
-
* Triggered when an order
|
|
1943
|
+
* Triggered when an order's `endDate` is postponed.
|
|
1944
|
+
* @permissionScope Manage_Wix_Rentals_App_Forms_submissions
|
|
1945
|
+
* @permissionScopeId SCOPE.RENTALS.MANAGE
|
|
1946
|
+
* @permissionScope Manage Orders
|
|
1947
|
+
* @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
|
|
1948
|
+
* @permissionScope Read Orders
|
|
1949
|
+
* @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS
|
|
1950
|
+
* @permissionScope Manage plans and orders of Pricing Plans
|
|
1951
|
+
* @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-PLANS-AND-ORDERS
|
|
1952
|
+
* @permissionScope Manage Events
|
|
1953
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1954
|
+
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
1955
|
+
* @webhook
|
|
1956
|
+
* @eventType wix.pricing_plans.v2.order_end_date_postponed
|
|
1957
|
+
* @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
|
|
1958
|
+
* @slug end_date_postponed
|
|
1959
|
+
*/
|
|
1960
|
+
declare function onOrderEndDatePostponed(handler: (event: OrderEndDatePostponedEnvelope) => void | Promise<void>): void;
|
|
1961
|
+
interface OrderEndedEnvelope {
|
|
1962
|
+
data: OrderEnded;
|
|
1963
|
+
metadata: EventMetadata;
|
|
1964
|
+
}
|
|
1965
|
+
/**
|
|
1966
|
+
* Triggered when an order ends.
|
|
1936
1967
|
*
|
|
1937
|
-
* This webhook is
|
|
1938
|
-
* + When an order
|
|
1939
|
-
* + When an order
|
|
1968
|
+
* This webhook is triggered:
|
|
1969
|
+
* + When an order expires at the end of the current payment cycle.
|
|
1970
|
+
* + When an order is canceled and `effectiveAt` is set to `IMMEDIATELY`.
|
|
1971
|
+
* @permissionScope Manage_Wix_Rentals_App_Forms_submissions
|
|
1972
|
+
* @permissionScopeId SCOPE.RENTALS.MANAGE
|
|
1973
|
+
* @permissionScope Manage Orders
|
|
1974
|
+
* @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
|
|
1975
|
+
* @permissionScope Read Orders
|
|
1976
|
+
* @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS
|
|
1977
|
+
* @permissionScope Manage plans and orders of Pricing Plans
|
|
1978
|
+
* @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-PLANS-AND-ORDERS
|
|
1979
|
+
* @permissionScope Manage Events
|
|
1980
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1981
|
+
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
1982
|
+
* @webhook
|
|
1983
|
+
* @eventType wix.pricing_plans.v2.order_ended
|
|
1984
|
+
* @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
|
|
1985
|
+
* @slug ended
|
|
1986
|
+
*/
|
|
1987
|
+
declare function onOrderEnded(handler: (event: OrderEndedEnvelope) => void | Promise<void>): void;
|
|
1988
|
+
interface OrderMarkedAsPaidEnvelope {
|
|
1989
|
+
data: OrderMarkedAsPaid;
|
|
1990
|
+
metadata: EventMetadata;
|
|
1991
|
+
}
|
|
1992
|
+
/**
|
|
1993
|
+
* Triggered when an offline order is marked as paid.
|
|
1940
1994
|
* @permissionScope Manage_Wix_Rentals_App_Forms_submissions
|
|
1941
1995
|
* @permissionScopeId SCOPE.RENTALS.MANAGE
|
|
1942
1996
|
* @permissionScope Manage Orders
|
|
@@ -1949,21 +2003,17 @@ interface OrderAutoRenewCanceledEnvelope {
|
|
|
1949
2003
|
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1950
2004
|
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
1951
2005
|
* @webhook
|
|
1952
|
-
* @eventType wix.pricing_plans.v2.
|
|
2006
|
+
* @eventType wix.pricing_plans.v2.order_marked_as_paid
|
|
1953
2007
|
* @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
|
|
1954
|
-
* @slug
|
|
2008
|
+
* @slug marked_as_paid
|
|
1955
2009
|
*/
|
|
1956
|
-
declare function
|
|
1957
|
-
interface
|
|
1958
|
-
data:
|
|
2010
|
+
declare function onOrderMarkedAsPaid(handler: (event: OrderMarkedAsPaidEnvelope) => void | Promise<void>): void;
|
|
2011
|
+
interface OrderPausedEnvelope {
|
|
2012
|
+
data: OrderPaused;
|
|
1959
2013
|
metadata: EventMetadata;
|
|
1960
2014
|
}
|
|
1961
2015
|
/**
|
|
1962
|
-
* Triggered when an order is
|
|
1963
|
-
*
|
|
1964
|
-
* This webhook is triggered either immediately or at the end of the current payment cycle, as follows:
|
|
1965
|
-
* + If the order is canceled and `effectiveAt` is set to `IMMEDIATELY`, the webhook is triggered immediately when canceled.
|
|
1966
|
-
* + 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.
|
|
2016
|
+
* Triggered when an order is paused.
|
|
1967
2017
|
* @permissionScope Manage_Wix_Rentals_App_Forms_submissions
|
|
1968
2018
|
* @permissionScopeId SCOPE.RENTALS.MANAGE
|
|
1969
2019
|
* @permissionScope Manage Orders
|
|
@@ -1976,19 +2026,21 @@ interface OrderCanceledEnvelope {
|
|
|
1976
2026
|
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1977
2027
|
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
1978
2028
|
* @webhook
|
|
1979
|
-
* @eventType wix.pricing_plans.v2.
|
|
2029
|
+
* @eventType wix.pricing_plans.v2.order_paused
|
|
1980
2030
|
* @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
|
|
1981
|
-
* @slug
|
|
2031
|
+
* @slug paused
|
|
1982
2032
|
*/
|
|
1983
|
-
declare function
|
|
1984
|
-
interface
|
|
1985
|
-
data:
|
|
2033
|
+
declare function onOrderPaused(handler: (event: OrderPausedEnvelope) => void | Promise<void>): void;
|
|
2034
|
+
interface OrderPurchasedEnvelope {
|
|
2035
|
+
data: OrderPurchased;
|
|
1986
2036
|
metadata: EventMetadata;
|
|
1987
2037
|
}
|
|
1988
2038
|
/**
|
|
1989
|
-
* Triggered
|
|
1990
|
-
*
|
|
1991
|
-
*
|
|
2039
|
+
* Triggered for any of the following purchase events:
|
|
2040
|
+
* + Order is paid in full.
|
|
2041
|
+
* + At least 1 order cycle payment is paid for.
|
|
2042
|
+
* + Offline order is created, even if not yet marked as paid.
|
|
2043
|
+
* + Free order is created.
|
|
1992
2044
|
* @permissionScope Manage_Wix_Rentals_App_Forms_submissions
|
|
1993
2045
|
* @permissionScopeId SCOPE.RENTALS.MANAGE
|
|
1994
2046
|
* @permissionScope Manage Orders
|
|
@@ -2001,17 +2053,17 @@ interface OrderCycleStartedEnvelope {
|
|
|
2001
2053
|
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
2002
2054
|
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
2003
2055
|
* @webhook
|
|
2004
|
-
* @eventType wix.pricing_plans.v2.
|
|
2056
|
+
* @eventType wix.pricing_plans.v2.order_purchased
|
|
2005
2057
|
* @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
|
|
2006
|
-
* @slug
|
|
2058
|
+
* @slug purchased
|
|
2007
2059
|
*/
|
|
2008
|
-
declare function
|
|
2009
|
-
interface
|
|
2010
|
-
data:
|
|
2060
|
+
declare function onOrderPurchased(handler: (event: OrderPurchasedEnvelope) => void | Promise<void>): void;
|
|
2061
|
+
interface OrderResumedEnvelope {
|
|
2062
|
+
data: OrderResumed;
|
|
2011
2063
|
metadata: EventMetadata;
|
|
2012
2064
|
}
|
|
2013
2065
|
/**
|
|
2014
|
-
* Triggered when
|
|
2066
|
+
* Triggered when a paused order is resumed.
|
|
2015
2067
|
* @permissionScope Manage_Wix_Rentals_App_Forms_submissions
|
|
2016
2068
|
* @permissionScopeId SCOPE.RENTALS.MANAGE
|
|
2017
2069
|
* @permissionScope Manage Orders
|
|
@@ -2024,21 +2076,17 @@ interface OrderEndDatePostponedEnvelope {
|
|
|
2024
2076
|
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
2025
2077
|
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
2026
2078
|
* @webhook
|
|
2027
|
-
* @eventType wix.pricing_plans.v2.
|
|
2079
|
+
* @eventType wix.pricing_plans.v2.order_resumed
|
|
2028
2080
|
* @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
|
|
2029
|
-
* @slug
|
|
2081
|
+
* @slug resumed
|
|
2030
2082
|
*/
|
|
2031
|
-
declare function
|
|
2032
|
-
interface
|
|
2033
|
-
data:
|
|
2083
|
+
declare function onOrderResumed(handler: (event: OrderResumedEnvelope) => void | Promise<void>): void;
|
|
2084
|
+
interface OrderStartedEnvelope {
|
|
2085
|
+
data: OrderStarted;
|
|
2034
2086
|
metadata: EventMetadata;
|
|
2035
2087
|
}
|
|
2036
2088
|
/**
|
|
2037
|
-
* Triggered when an order
|
|
2038
|
-
*
|
|
2039
|
-
* This webhook is triggered:
|
|
2040
|
-
* + When an order expires at the end of the current payment cycle.
|
|
2041
|
-
* + When an order is canceled and `effectiveAt` is set to `IMMEDIATELY`.
|
|
2089
|
+
* Triggered when an order reaches its `startDate`. Applies to both purchased and free orders.
|
|
2042
2090
|
* @permissionScope Manage_Wix_Rentals_App_Forms_submissions
|
|
2043
2091
|
* @permissionScopeId SCOPE.RENTALS.MANAGE
|
|
2044
2092
|
* @permissionScope Manage Orders
|
|
@@ -2051,17 +2099,25 @@ interface OrderEndedEnvelope {
|
|
|
2051
2099
|
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
2052
2100
|
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
2053
2101
|
* @webhook
|
|
2054
|
-
* @eventType wix.pricing_plans.v2.
|
|
2102
|
+
* @eventType wix.pricing_plans.v2.order_started
|
|
2055
2103
|
* @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
|
|
2056
|
-
* @slug
|
|
2104
|
+
* @slug started
|
|
2057
2105
|
*/
|
|
2058
|
-
declare function
|
|
2059
|
-
interface
|
|
2060
|
-
|
|
2106
|
+
declare function onOrderStarted(handler: (event: OrderStartedEnvelope) => void | Promise<void>): void;
|
|
2107
|
+
interface OrderUpdatedEnvelope {
|
|
2108
|
+
entity: Order;
|
|
2061
2109
|
metadata: EventMetadata;
|
|
2062
2110
|
}
|
|
2063
2111
|
/**
|
|
2064
|
-
* Triggered
|
|
2112
|
+
* Triggered for any of the following update events:
|
|
2113
|
+
*
|
|
2114
|
+
* + Order is paid for. Order Purchased is also triggered.
|
|
2115
|
+
* + Order reaches its start date or end date. Order Started and Order Ended, respectively, are also triggered.
|
|
2116
|
+
* + New payment cycle of an order starts. Order Cycle Started is also triggered.
|
|
2117
|
+
* + Offline order is marked as paid. Order Marked As Paid is also triggered.
|
|
2118
|
+
* + End date of the order is postponed. Order End Date Postponed is also triggered
|
|
2119
|
+
* + Order is paused, or a paused order is resumed. Order Paused and Order Resumed, respectively, are also triggered.
|
|
2120
|
+
* + Order is canceled, either immediately or at the end of the payment cycle. Order Canceled and Order Auto Renew Canceled, respectively, are also triggered.
|
|
2065
2121
|
* @permissionScope Manage_Wix_Rentals_App_Forms_submissions
|
|
2066
2122
|
* @permissionScopeId SCOPE.RENTALS.MANAGE
|
|
2067
2123
|
* @permissionScope Manage Orders
|
|
@@ -2074,17 +2130,17 @@ interface OrderMarkedAsPaidEnvelope {
|
|
|
2074
2130
|
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
2075
2131
|
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
2076
2132
|
* @webhook
|
|
2077
|
-
* @eventType wix.pricing_plans.v2.
|
|
2133
|
+
* @eventType wix.pricing_plans.v2.order_updated
|
|
2078
2134
|
* @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
|
|
2079
|
-
* @slug
|
|
2135
|
+
* @slug updated
|
|
2080
2136
|
*/
|
|
2081
|
-
declare function
|
|
2082
|
-
interface
|
|
2083
|
-
|
|
2137
|
+
declare function onOrderUpdated(handler: (event: OrderUpdatedEnvelope) => void | Promise<void>): void;
|
|
2138
|
+
interface OrderCreatedEnvelope {
|
|
2139
|
+
entity: Order;
|
|
2084
2140
|
metadata: EventMetadata;
|
|
2085
2141
|
}
|
|
2086
2142
|
/**
|
|
2087
|
-
* Triggered when an order is
|
|
2143
|
+
* Triggered when an order is created.
|
|
2088
2144
|
* @permissionScope Manage_Wix_Rentals_App_Forms_submissions
|
|
2089
2145
|
* @permissionScopeId SCOPE.RENTALS.MANAGE
|
|
2090
2146
|
* @permissionScope Manage Orders
|
|
@@ -2097,21 +2153,17 @@ interface OrderPausedEnvelope {
|
|
|
2097
2153
|
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
2098
2154
|
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
2099
2155
|
* @webhook
|
|
2100
|
-
* @eventType wix.pricing_plans.v2.
|
|
2101
|
-
* @serviceIdentifier com.wixpress.membership.v2.orders.
|
|
2102
|
-
* @slug
|
|
2156
|
+
* @eventType wix.pricing_plans.v2.order_created
|
|
2157
|
+
* @serviceIdentifier com.wixpress.membership.v2.orders.CheckoutService
|
|
2158
|
+
* @slug created
|
|
2103
2159
|
*/
|
|
2104
|
-
declare function
|
|
2105
|
-
interface
|
|
2106
|
-
data:
|
|
2160
|
+
declare function onOrderCreated(handler: (event: OrderCreatedEnvelope) => void | Promise<void>): void;
|
|
2161
|
+
interface OrderStartDateChangedEnvelope {
|
|
2162
|
+
data: OrderStartDateChanged;
|
|
2107
2163
|
metadata: EventMetadata;
|
|
2108
2164
|
}
|
|
2109
2165
|
/**
|
|
2110
|
-
* Triggered
|
|
2111
|
-
* + Order is paid in full.
|
|
2112
|
-
* + At least 1 order cycle payment is paid for.
|
|
2113
|
-
* + Offline order is created, even if not yet marked as paid.
|
|
2114
|
-
* + Free order is created.
|
|
2166
|
+
* Triggered when an order's `startDate` is changed.
|
|
2115
2167
|
* @permissionScope Manage_Wix_Rentals_App_Forms_submissions
|
|
2116
2168
|
* @permissionScopeId SCOPE.RENTALS.MANAGE
|
|
2117
2169
|
* @permissionScope Manage Orders
|
|
@@ -2124,57 +2176,185 @@ interface OrderPurchasedEnvelope {
|
|
|
2124
2176
|
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
2125
2177
|
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
2126
2178
|
* @webhook
|
|
2127
|
-
* @eventType wix.pricing_plans.v2.
|
|
2128
|
-
* @serviceIdentifier com.wixpress.membership.v2.orders.
|
|
2129
|
-
* @slug
|
|
2179
|
+
* @eventType wix.pricing_plans.v2.order_start_date_changed
|
|
2180
|
+
* @serviceIdentifier com.wixpress.membership.v2.orders.CheckoutService
|
|
2181
|
+
* @slug start_date_changed
|
|
2182
|
+
*/
|
|
2183
|
+
declare function onOrderStartDateChanged(handler: (event: OrderStartDateChangedEnvelope) => void | Promise<void>): void;
|
|
2184
|
+
/**
|
|
2185
|
+
* Retrieves an order by ID.
|
|
2186
|
+
* @param _id - Order ID.
|
|
2187
|
+
* @public
|
|
2188
|
+
* @requiredField _id
|
|
2189
|
+
* @param options - Options to use when getting an order.
|
|
2190
|
+
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
2191
|
+
* @applicableIdentity APP
|
|
2192
|
+
* @fqn com.wixpress.membership.v2.orders.OrderManagementService.GetOrder
|
|
2193
|
+
*/
|
|
2194
|
+
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`, 5>>;
|
|
2195
|
+
interface ManagementGetOrderOptions {
|
|
2196
|
+
/**
|
|
2197
|
+
* Predefined set of fields to return.
|
|
2198
|
+
*
|
|
2199
|
+
* Default: If `fieldSet` is omitted, no order form submission data is returned.
|
|
2200
|
+
*/
|
|
2201
|
+
fieldSet?: SetWithLiterals;
|
|
2202
|
+
}
|
|
2203
|
+
/**
|
|
2204
|
+
* Retrieves a list of up to 50 pricing plan orders and details, given the specified sorting and filtering.
|
|
2205
|
+
*
|
|
2206
|
+
* By default, this endpoint will retrieve all orders and return them sorted by `createdDate` in `DESC`, descending order.
|
|
2207
|
+
* `sort.fieldName` supports `endDate` and `createdDate` fields and defaults to `ASC`, ascending order.
|
|
2208
|
+
* @public
|
|
2209
|
+
* @param options - Filtering, sorting, and pagination options.
|
|
2210
|
+
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
2211
|
+
* @applicableIdentity APP
|
|
2212
|
+
* @fqn com.wixpress.membership.v2.orders.OrderManagementService.ListOrders
|
|
2213
|
+
*/
|
|
2214
|
+
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`, 4>>;
|
|
2215
|
+
interface ManagementListOrdersOptions {
|
|
2216
|
+
/**
|
|
2217
|
+
* Filter by a buyer's member ID, from the Members API.
|
|
2218
|
+
* @format GUID
|
|
2219
|
+
*/
|
|
2220
|
+
buyerIds?: string[];
|
|
2221
|
+
/**
|
|
2222
|
+
* Filter by plan IDs, from the Plans API.
|
|
2223
|
+
* @format GUID
|
|
2224
|
+
*/
|
|
2225
|
+
planIds?: string[];
|
|
2226
|
+
/** Filter by whether or not the auto-renewal of recurring orders was canceled. */
|
|
2227
|
+
autoRenewCanceled?: boolean | null;
|
|
2228
|
+
/** Filter by order status. */
|
|
2229
|
+
orderStatuses?: OrderStatusWithLiterals[];
|
|
2230
|
+
/** Filter by payment status. */
|
|
2231
|
+
paymentStatuses?: PaymentStatusWithLiterals[];
|
|
2232
|
+
/**
|
|
2233
|
+
* Number of orders to return. See Sorting and Paging for more information.
|
|
2234
|
+
*
|
|
2235
|
+
* Max: `50`
|
|
2236
|
+
* @min 1
|
|
2237
|
+
* @max 50
|
|
2238
|
+
*/
|
|
2239
|
+
limit?: number | null;
|
|
2240
|
+
/** Number of orders to skip in the current sort order. */
|
|
2241
|
+
offset?: number | null;
|
|
2242
|
+
/**
|
|
2243
|
+
* Sort order.
|
|
2244
|
+
*
|
|
2245
|
+
* Use `ASC` for ascending order or `DESC` for descending order.
|
|
2246
|
+
*
|
|
2247
|
+
* Default: `DESC`.
|
|
2248
|
+
*/
|
|
2249
|
+
sorting?: Sorting;
|
|
2250
|
+
/**
|
|
2251
|
+
* Predefined set of fields to return.
|
|
2252
|
+
*
|
|
2253
|
+
* Default: If `fieldSet` is omitted, no order form submission data is returned.
|
|
2254
|
+
*/
|
|
2255
|
+
fieldSet?: SetWithLiterals;
|
|
2256
|
+
}
|
|
2257
|
+
/**
|
|
2258
|
+
* 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.
|
|
2259
|
+
*
|
|
2260
|
+
* New `endDate` must be later than the order's current `endDate`. Can't postpone orders that are unlimited.
|
|
2261
|
+
* Can't postpone an order with `status`: `PAUSED`.
|
|
2262
|
+
* @param _id - Order ID.
|
|
2263
|
+
* @param endDate - New end date and time.
|
|
2264
|
+
*
|
|
2265
|
+
* Must be later than the current end date and time.
|
|
2266
|
+
* @public
|
|
2267
|
+
* @requiredField _id
|
|
2268
|
+
* @requiredField endDate
|
|
2269
|
+
* @param options - Options for postponing the end date of an order.
|
|
2270
|
+
* @permissionId PRICING_PLANS.MANAGE_ORDERS
|
|
2271
|
+
* @applicableIdentity APP
|
|
2272
|
+
* @fqn com.wixpress.membership.v2.orders.OrderManagementService.PostponeEndDate
|
|
2273
|
+
*/
|
|
2274
|
+
declare function postponeEndDate(_id: string, endDate: Date): Promise<void>;
|
|
2275
|
+
/**
|
|
2276
|
+
* Cancels an existing order.
|
|
2277
|
+
*
|
|
2278
|
+
* For orders with recurring payments, a cancellation can be set to occur either `IMMEDIATELY` or at the `NEXT_PAYMENT_DATE`.
|
|
2279
|
+
* For orders with one-time payments, a cancellation can only be set for `IMMEDIATELY`.
|
|
2280
|
+
*
|
|
2281
|
+
* #### Canceling during the free trial period.
|
|
2282
|
+
*
|
|
2283
|
+
* When a buyer cancels their order during the free trial period, the buyer's subscription expires at the end
|
|
2284
|
+
* of the free trial period and they will not be billed. The buyer may continue using the benefits until the end
|
|
2285
|
+
* of the free trial period.
|
|
2286
|
+
*
|
|
2287
|
+
* When a Wix user cancels an ordered plan during the free trial period, they choose whether to apply the cancellation
|
|
2288
|
+
* `IMMEDIATELY` or at the `NEXT_PAYMENT_DATE`. Canceling `IMMEDIATELY` will end the subscription for the buyer
|
|
2289
|
+
* immediately, even during the free trial period and the buyer won't be billed. Canceling at the
|
|
2290
|
+
* `NEXT_PAYMENT_DATE` allows the buyer to continue using the benefits of the subscription until the end of the free trial period.
|
|
2291
|
+
* Then, the subscription ends and the buyer is not billed.
|
|
2292
|
+
* @param _id - Order ID.
|
|
2293
|
+
* @param effectiveAt - __Required.__ When the order will be canceled. One-time orders can only be canceled `IMMEDIATELY`.
|
|
2294
|
+
* @public
|
|
2295
|
+
* @requiredField _id
|
|
2296
|
+
* @requiredField effectiveAt
|
|
2297
|
+
* @param options - Options for canceling orders.
|
|
2298
|
+
* @permissionId PRICING_PLANS.MANAGE_ORDERS
|
|
2299
|
+
* @applicableIdentity APP
|
|
2300
|
+
* @fqn com.wixpress.membership.v2.orders.OrderManagementService.CancelOrder
|
|
2301
|
+
*/
|
|
2302
|
+
declare function cancelOrder(_id: string, effectiveAt: CancellationEffectiveAtWithLiterals): Promise<void>;
|
|
2303
|
+
/**
|
|
2304
|
+
* Marks an offline order as paid.
|
|
2305
|
+
* > __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.
|
|
2306
|
+
*
|
|
2307
|
+
* Marking an offline order as paid causes the following changes:
|
|
2308
|
+
* - The order's `lastPaymentStatus` changes to `"PAID"`.
|
|
2309
|
+
* - The order's status changes to either `"PENDING"` or `"ACTIVE"`, depending on the order's `startDate`.
|
|
2310
|
+
*
|
|
2311
|
+
* An error occurs if you attempt to:
|
|
2312
|
+
* - Mark an already-paid, offline order as paid. You cannot mark an offline order as paid twice.
|
|
2313
|
+
* - Mark an online order as paid. The Mark as Paid method is supported for offline orders only.
|
|
2314
|
+
* @param _id - Order ID.
|
|
2315
|
+
* @public
|
|
2316
|
+
* @requiredField _id
|
|
2317
|
+
* @permissionId PRICING_PLANS.MANAGE_ORDERS
|
|
2318
|
+
* @applicableIdentity APP
|
|
2319
|
+
* @fqn com.wixpress.membership.v2.orders.OrderManagementService.MarkAsPaid
|
|
2130
2320
|
*/
|
|
2131
|
-
declare function
|
|
2132
|
-
interface OrderResumedEnvelope {
|
|
2133
|
-
data: OrderResumed;
|
|
2134
|
-
metadata: EventMetadata;
|
|
2135
|
-
}
|
|
2321
|
+
declare function markAsPaid(_id: string): Promise<void>;
|
|
2136
2322
|
/**
|
|
2137
|
-
*
|
|
2138
|
-
*
|
|
2139
|
-
*
|
|
2140
|
-
*
|
|
2141
|
-
*
|
|
2142
|
-
*
|
|
2143
|
-
*
|
|
2144
|
-
*
|
|
2145
|
-
* @
|
|
2146
|
-
* @
|
|
2147
|
-
* @
|
|
2148
|
-
* @permissionId PRICING_PLANS.
|
|
2149
|
-
* @
|
|
2150
|
-
* @
|
|
2151
|
-
* @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
|
|
2152
|
-
* @slug resumed
|
|
2323
|
+
* Pauses an order. Calling this method changes the order status to `"PAUSED"` and updates the `pausePeriods` array.
|
|
2324
|
+
*
|
|
2325
|
+
* Only orders with `status`: `ACTIVE` can be paused.
|
|
2326
|
+
* For orders with recurring payments, it also pauses the payment schedule. Buyers are not charged when an order is paused.
|
|
2327
|
+
* Pausing an order affects the end date of the order by adding the time the order is paused to the `endDate`.
|
|
2328
|
+
* The `endDate` and the `earliestEndDate` for the order are adjusted to include the pause period when the order is resumed.
|
|
2329
|
+
*
|
|
2330
|
+
* To resume a paused order, call Resume Order.
|
|
2331
|
+
* @param _id - Order ID.
|
|
2332
|
+
* @public
|
|
2333
|
+
* @requiredField _id
|
|
2334
|
+
* @permissionId PRICING_PLANS.MANAGE_ORDERS
|
|
2335
|
+
* @applicableIdentity APP
|
|
2336
|
+
* @fqn com.wixpress.membership.v2.orders.OrderManagementService.PauseOrder
|
|
2153
2337
|
*/
|
|
2154
|
-
declare function
|
|
2155
|
-
interface OrderStartedEnvelope {
|
|
2156
|
-
data: OrderStarted;
|
|
2157
|
-
metadata: EventMetadata;
|
|
2158
|
-
}
|
|
2338
|
+
declare function pauseOrder(_id: string): Promise<void>;
|
|
2159
2339
|
/**
|
|
2160
|
-
*
|
|
2161
|
-
*
|
|
2162
|
-
*
|
|
2163
|
-
*
|
|
2164
|
-
*
|
|
2165
|
-
*
|
|
2166
|
-
*
|
|
2167
|
-
*
|
|
2168
|
-
*
|
|
2169
|
-
*
|
|
2170
|
-
* @
|
|
2171
|
-
* @
|
|
2172
|
-
* @
|
|
2173
|
-
* @
|
|
2174
|
-
* @
|
|
2175
|
-
* @
|
|
2340
|
+
* Resumes a paused order. For orders with recurring payments, it also restarts the payment schedule.
|
|
2341
|
+
*
|
|
2342
|
+
* Resuming an order causes the following changes:
|
|
2343
|
+
* - The order status changes to `"ACTIVE"`.
|
|
2344
|
+
* - The `pausePeriods` array is updated.
|
|
2345
|
+
* - The `endDate` for the order is adjusted to include the pause period.
|
|
2346
|
+
* - For orders with recurring payments, the payment schedule is restarted.
|
|
2347
|
+
* - The `earliestEndDate` is adjusted to include the pause period. (This property is reserved for future use).
|
|
2348
|
+
*
|
|
2349
|
+
* To pause an order, call Pause Order.
|
|
2350
|
+
* @param _id - Order ID.
|
|
2351
|
+
* @public
|
|
2352
|
+
* @requiredField _id
|
|
2353
|
+
* @permissionId PRICING_PLANS.MANAGE_ORDERS
|
|
2354
|
+
* @applicableIdentity APP
|
|
2355
|
+
* @fqn com.wixpress.membership.v2.orders.OrderManagementService.ResumeOrder
|
|
2176
2356
|
*/
|
|
2177
|
-
declare function
|
|
2357
|
+
declare function resumeOrder(_id: string): Promise<void>;
|
|
2178
2358
|
/**
|
|
2179
2359
|
* Creates an online order for a site member.
|
|
2180
2360
|
*
|
|
@@ -2208,6 +2388,9 @@ interface CreateOnlineOrderOptions {
|
|
|
2208
2388
|
onBehalf?: OnBehalf;
|
|
2209
2389
|
/**
|
|
2210
2390
|
* Submission ID of the form submitted with this order.
|
|
2391
|
+
*
|
|
2392
|
+
* The submission must belong to the form attached to the plan, and that form must belong to the Pricing Plans namespace.
|
|
2393
|
+
* An invalid submission ID is dropped and the order is created without a submission.
|
|
2211
2394
|
* @format GUID
|
|
2212
2395
|
*/
|
|
2213
2396
|
submissionId?: string | null;
|
|
@@ -2265,6 +2448,9 @@ interface CreateOfflineOrderOptions {
|
|
|
2265
2448
|
couponCode?: string | null;
|
|
2266
2449
|
/**
|
|
2267
2450
|
* Form submission ID that was submitted with the order.
|
|
2451
|
+
*
|
|
2452
|
+
* The submission must belong to the form attached to the plan, and that form must belong to the Pricing Plans namespace.
|
|
2453
|
+
* An invalid submission ID is dropped and the order is created without a submission.
|
|
2268
2454
|
* @format GUID
|
|
2269
2455
|
*/
|
|
2270
2456
|
submissionId?: string | null;
|
|
@@ -2369,180 +2555,6 @@ interface GetPricePreviewOptions {
|
|
|
2369
2555
|
*/
|
|
2370
2556
|
couponCode?: string | null;
|
|
2371
2557
|
}
|
|
2372
|
-
/**
|
|
2373
|
-
* Retrieves an order by ID.
|
|
2374
|
-
* @param _id - Order ID.
|
|
2375
|
-
* @public
|
|
2376
|
-
* @requiredField _id
|
|
2377
|
-
* @param options - Options to use when getting an order.
|
|
2378
|
-
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
2379
|
-
* @applicableIdentity APP
|
|
2380
|
-
* @fqn com.wixpress.membership.v2.orders.OrderManagementService.GetOrder
|
|
2381
|
-
*/
|
|
2382
|
-
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`, 5>>;
|
|
2383
|
-
interface ManagementGetOrderOptions {
|
|
2384
|
-
/**
|
|
2385
|
-
* Predefined set of fields to return.
|
|
2386
|
-
*
|
|
2387
|
-
* Default: If `fieldSet` is omitted, no order form submission data is returned.
|
|
2388
|
-
*/
|
|
2389
|
-
fieldSet?: SetWithLiterals;
|
|
2390
|
-
}
|
|
2391
|
-
/**
|
|
2392
|
-
* Retrieves a list of up to 50 pricing plan orders and details, given the specified sorting and filtering.
|
|
2393
|
-
*
|
|
2394
|
-
* By default, this endpoint will retrieve all orders and return them sorted by `createdDate` in `DESC`, descending order.
|
|
2395
|
-
* `sort.fieldName` supports `endDate` and `createdDate` fields and defaults to `ASC`, ascending order.
|
|
2396
|
-
* @public
|
|
2397
|
-
* @param options - Filtering, sorting, and pagination options.
|
|
2398
|
-
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
2399
|
-
* @applicableIdentity APP
|
|
2400
|
-
* @fqn com.wixpress.membership.v2.orders.OrderManagementService.ListOrders
|
|
2401
|
-
*/
|
|
2402
|
-
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`, 4>>;
|
|
2403
|
-
interface ManagementListOrdersOptions {
|
|
2404
|
-
/**
|
|
2405
|
-
* Filter by a buyer's member ID, from the Members API.
|
|
2406
|
-
* @format GUID
|
|
2407
|
-
*/
|
|
2408
|
-
buyerIds?: string[];
|
|
2409
|
-
/**
|
|
2410
|
-
* Filter by plan IDs, from the Plans API.
|
|
2411
|
-
* @format GUID
|
|
2412
|
-
*/
|
|
2413
|
-
planIds?: string[];
|
|
2414
|
-
/** Filter by whether or not the auto-renewal of recurring orders was canceled. */
|
|
2415
|
-
autoRenewCanceled?: boolean | null;
|
|
2416
|
-
/** Filter by order status. */
|
|
2417
|
-
orderStatuses?: OrderStatusWithLiterals[];
|
|
2418
|
-
/** Filter by payment status. */
|
|
2419
|
-
paymentStatuses?: PaymentStatusWithLiterals[];
|
|
2420
|
-
/**
|
|
2421
|
-
* Number of orders to return. See Sorting and Paging for more information.
|
|
2422
|
-
*
|
|
2423
|
-
* Max: `50`
|
|
2424
|
-
* @min 1
|
|
2425
|
-
* @max 50
|
|
2426
|
-
*/
|
|
2427
|
-
limit?: number | null;
|
|
2428
|
-
/** Number of orders to skip in the current sort order. */
|
|
2429
|
-
offset?: number | null;
|
|
2430
|
-
/**
|
|
2431
|
-
* Sort order.
|
|
2432
|
-
*
|
|
2433
|
-
* Use `ASC` for ascending order or `DESC` for descending order.
|
|
2434
|
-
*
|
|
2435
|
-
* Default: `DESC`.
|
|
2436
|
-
*/
|
|
2437
|
-
sorting?: Sorting;
|
|
2438
|
-
/**
|
|
2439
|
-
* Predefined set of fields to return.
|
|
2440
|
-
*
|
|
2441
|
-
* Default: If `fieldSet` is omitted, no order form submission data is returned.
|
|
2442
|
-
*/
|
|
2443
|
-
fieldSet?: SetWithLiterals;
|
|
2444
|
-
}
|
|
2445
|
-
/**
|
|
2446
|
-
* 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.
|
|
2447
|
-
*
|
|
2448
|
-
* New `endDate` must be later than the order's current `endDate`. Can't postpone orders that are unlimited.
|
|
2449
|
-
* Can't postpone an order with `status`: `PAUSED`.
|
|
2450
|
-
* @param _id - Order ID.
|
|
2451
|
-
* @param endDate - New end date and time.
|
|
2452
|
-
*
|
|
2453
|
-
* Must be later than the current end date and time.
|
|
2454
|
-
* @public
|
|
2455
|
-
* @requiredField _id
|
|
2456
|
-
* @requiredField endDate
|
|
2457
|
-
* @param options - Options for postponing the end date of an order.
|
|
2458
|
-
* @permissionId PRICING_PLANS.MANAGE_ORDERS
|
|
2459
|
-
* @applicableIdentity APP
|
|
2460
|
-
* @fqn com.wixpress.membership.v2.orders.OrderManagementService.PostponeEndDate
|
|
2461
|
-
*/
|
|
2462
|
-
declare function postponeEndDate(_id: string, endDate: Date): Promise<void>;
|
|
2463
|
-
/**
|
|
2464
|
-
* Cancels an existing order.
|
|
2465
|
-
*
|
|
2466
|
-
* For orders with recurring payments, a cancellation can be set to occur either `IMMEDIATELY` or at the `NEXT_PAYMENT_DATE`.
|
|
2467
|
-
* For orders with one-time payments, a cancellation can only be set for `IMMEDIATELY`.
|
|
2468
|
-
*
|
|
2469
|
-
* #### Canceling during the free trial period.
|
|
2470
|
-
*
|
|
2471
|
-
* When a buyer cancels their order during the free trial period, the buyer's subscription expires at the end
|
|
2472
|
-
* of the free trial period and they will not be billed. The buyer may continue using the benefits until the end
|
|
2473
|
-
* of the free trial period.
|
|
2474
|
-
*
|
|
2475
|
-
* When a Wix user cancels an ordered plan during the free trial period, they choose whether to apply the cancellation
|
|
2476
|
-
* `IMMEDIATELY` or at the `NEXT_PAYMENT_DATE`. Canceling `IMMEDIATELY` will end the subscription for the buyer
|
|
2477
|
-
* immediately, even during the free trial period and the buyer won't be billed. Canceling at the
|
|
2478
|
-
* `NEXT_PAYMENT_DATE` allows the buyer to continue using the benefits of the subscription until the end of the free trial period.
|
|
2479
|
-
* Then, the subscription ends and the buyer is not billed.
|
|
2480
|
-
* @param _id - Order ID.
|
|
2481
|
-
* @param effectiveAt - __Required.__ When the order will be canceled. One-time orders can only be canceled `IMMEDIATELY`.
|
|
2482
|
-
* @public
|
|
2483
|
-
* @requiredField _id
|
|
2484
|
-
* @requiredField effectiveAt
|
|
2485
|
-
* @param options - Options for canceling orders.
|
|
2486
|
-
* @permissionId PRICING_PLANS.MANAGE_ORDERS
|
|
2487
|
-
* @applicableIdentity APP
|
|
2488
|
-
* @fqn com.wixpress.membership.v2.orders.OrderManagementService.CancelOrder
|
|
2489
|
-
*/
|
|
2490
|
-
declare function cancelOrder(_id: string, effectiveAt: CancellationEffectiveAtWithLiterals): Promise<void>;
|
|
2491
|
-
/**
|
|
2492
|
-
* Marks an offline order as paid.
|
|
2493
|
-
* > __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.
|
|
2494
|
-
*
|
|
2495
|
-
* Marking an offline order as paid causes the following changes:
|
|
2496
|
-
* - The order's `lastPaymentStatus` changes to `"PAID"`.
|
|
2497
|
-
* - The order's status changes to either `"PENDING"` or `"ACTIVE"`, depending on the order's `startDate`.
|
|
2498
|
-
*
|
|
2499
|
-
* An error occurs if you attempt to:
|
|
2500
|
-
* - Mark an already-paid, offline order as paid. You cannot mark an offline order as paid twice.
|
|
2501
|
-
* - Mark an online order as paid. The Mark as Paid method is supported for offline orders only.
|
|
2502
|
-
* @param _id - Order ID.
|
|
2503
|
-
* @public
|
|
2504
|
-
* @requiredField _id
|
|
2505
|
-
* @permissionId PRICING_PLANS.MANAGE_ORDERS
|
|
2506
|
-
* @applicableIdentity APP
|
|
2507
|
-
* @fqn com.wixpress.membership.v2.orders.OrderManagementService.MarkAsPaid
|
|
2508
|
-
*/
|
|
2509
|
-
declare function markAsPaid(_id: string): Promise<void>;
|
|
2510
|
-
/**
|
|
2511
|
-
* Pauses an order. Calling this method changes the order status to `"PAUSED"` and updates the `pausePeriods` array.
|
|
2512
|
-
*
|
|
2513
|
-
* Only orders with `status`: `ACTIVE` can be paused.
|
|
2514
|
-
* For orders with recurring payments, it also pauses the payment schedule. Buyers are not charged when an order is paused.
|
|
2515
|
-
* Pausing an order affects the end date of the order by adding the time the order is paused to the `endDate`.
|
|
2516
|
-
* The `endDate` and the `earliestEndDate` for the order are adjusted to include the pause period when the order is resumed.
|
|
2517
|
-
*
|
|
2518
|
-
* To resume a paused order, call Resume Order.
|
|
2519
|
-
* @param _id - Order ID.
|
|
2520
|
-
* @public
|
|
2521
|
-
* @requiredField _id
|
|
2522
|
-
* @permissionId PRICING_PLANS.MANAGE_ORDERS
|
|
2523
|
-
* @applicableIdentity APP
|
|
2524
|
-
* @fqn com.wixpress.membership.v2.orders.OrderManagementService.PauseOrder
|
|
2525
|
-
*/
|
|
2526
|
-
declare function pauseOrder(_id: string): Promise<void>;
|
|
2527
|
-
/**
|
|
2528
|
-
* Resumes a paused order. For orders with recurring payments, it also restarts the payment schedule.
|
|
2529
|
-
*
|
|
2530
|
-
* Resuming an order causes the following changes:
|
|
2531
|
-
* - The order status changes to `"ACTIVE"`.
|
|
2532
|
-
* - The `pausePeriods` array is updated.
|
|
2533
|
-
* - The `endDate` for the order is adjusted to include the pause period.
|
|
2534
|
-
* - For orders with recurring payments, the payment schedule is restarted.
|
|
2535
|
-
* - The `earliestEndDate` is adjusted to include the pause period. (This property is reserved for future use).
|
|
2536
|
-
*
|
|
2537
|
-
* To pause an order, call Pause Order.
|
|
2538
|
-
* @param _id - Order ID.
|
|
2539
|
-
* @public
|
|
2540
|
-
* @requiredField _id
|
|
2541
|
-
* @permissionId PRICING_PLANS.MANAGE_ORDERS
|
|
2542
|
-
* @applicableIdentity APP
|
|
2543
|
-
* @fqn com.wixpress.membership.v2.orders.OrderManagementService.ResumeOrder
|
|
2544
|
-
*/
|
|
2545
|
-
declare function resumeOrder(_id: string): Promise<void>;
|
|
2546
2558
|
/**
|
|
2547
2559
|
* Retrieves an order for the currently logged-in member by ID.
|
|
2548
2560
|
* @param _id - Order ID.
|