@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
|
@@ -626,308 +626,345 @@ interface ActionEvent {
|
|
|
626
626
|
}
|
|
627
627
|
interface Empty {
|
|
628
628
|
}
|
|
629
|
-
interface
|
|
630
|
-
/**
|
|
631
|
-
|
|
632
|
-
* @format GUID
|
|
633
|
-
*/
|
|
634
|
-
planId: string;
|
|
635
|
-
/**
|
|
636
|
-
* Start date and time for the plan of the online order in a `YYYY-MM-DDThh:mm[:ss][.sss]Z` format.
|
|
637
|
-
*
|
|
638
|
-
* Default: Current date and time.
|
|
639
|
-
*/
|
|
640
|
-
startDate?: Date | null;
|
|
641
|
-
/**
|
|
642
|
-
* Coupon code to apply.
|
|
643
|
-
* @minLength 1
|
|
644
|
-
* @maxLength 20
|
|
645
|
-
*/
|
|
646
|
-
couponCode?: string | null;
|
|
647
|
-
/** Provided if checkout is initiated on buyer's behalf. */
|
|
648
|
-
onBehalf?: OnBehalf;
|
|
649
|
-
/**
|
|
650
|
-
* Submission ID of the form submitted with this order.
|
|
651
|
-
* @format GUID
|
|
652
|
-
*/
|
|
653
|
-
submissionId?: string | null;
|
|
629
|
+
interface OrderPurchased {
|
|
630
|
+
/** Order that was paid for. If a free or an offline order, the order that was created. */
|
|
631
|
+
order?: Order;
|
|
654
632
|
}
|
|
655
|
-
interface
|
|
656
|
-
/**
|
|
657
|
-
|
|
658
|
-
* @format GUID
|
|
659
|
-
*/
|
|
660
|
-
memberId?: string;
|
|
661
|
-
/** Method by which checkout is initiated. */
|
|
662
|
-
orderMethod?: OrderMethodWithLiterals;
|
|
633
|
+
interface OrderStarted {
|
|
634
|
+
/** Order that reached its `startDate`. */
|
|
635
|
+
order?: Order;
|
|
663
636
|
}
|
|
664
|
-
|
|
665
|
-
|
|
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. */
|
|
666
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;
|
|
667
647
|
}
|
|
668
|
-
|
|
669
|
-
|
|
670
|
-
|
|
671
|
-
|
|
672
|
-
planId?: string;
|
|
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;
|
|
673
652
|
}
|
|
674
|
-
interface
|
|
653
|
+
interface OrderEnded {
|
|
654
|
+
/** Order that ended. */
|
|
655
|
+
order?: Order;
|
|
656
|
+
}
|
|
657
|
+
interface GetOrderRequest {
|
|
675
658
|
/**
|
|
676
|
-
*
|
|
659
|
+
* Order ID.
|
|
677
660
|
* @format GUID
|
|
678
661
|
*/
|
|
679
|
-
|
|
662
|
+
_id: string;
|
|
680
663
|
/**
|
|
681
|
-
*
|
|
664
|
+
* Predefined set of fields to return.
|
|
682
665
|
*
|
|
683
|
-
* Default:
|
|
684
|
-
*/
|
|
685
|
-
startDate?: Date | null;
|
|
686
|
-
/**
|
|
687
|
-
* Coupon code to apply.
|
|
688
|
-
* @minLength 1
|
|
689
|
-
* @maxLength 20
|
|
690
|
-
*/
|
|
691
|
-
couponCode?: string | null;
|
|
692
|
-
/** Captcha data to prove you are not a robot */
|
|
693
|
-
captcha?: Captcha;
|
|
694
|
-
/** Visitor info */
|
|
695
|
-
guest?: Guest;
|
|
696
|
-
/**
|
|
697
|
-
* Form submission id that was submitted together with the order
|
|
698
|
-
* @format GUID
|
|
666
|
+
* Default: If `fieldSet` is omitted, no order form submission data is returned.
|
|
699
667
|
*/
|
|
700
|
-
|
|
701
|
-
}
|
|
702
|
-
interface Captcha {
|
|
703
|
-
/** Token from captcha */
|
|
704
|
-
token?: string;
|
|
668
|
+
fieldSet?: SetWithLiterals;
|
|
705
669
|
}
|
|
706
|
-
|
|
707
|
-
/**
|
|
708
|
-
|
|
709
|
-
|
|
710
|
-
|
|
711
|
-
|
|
670
|
+
declare enum Set {
|
|
671
|
+
/** Same behavior as `BASIC`.` */
|
|
672
|
+
UNKNOWN_SET = "UNKNOWN_SET",
|
|
673
|
+
/** Doesn't return any order form submission data. */
|
|
674
|
+
BASIC = "BASIC",
|
|
675
|
+
/** Returns all order form submission data. */
|
|
676
|
+
FULL = "FULL"
|
|
712
677
|
}
|
|
713
|
-
|
|
678
|
+
/** @enumType */
|
|
679
|
+
type SetWithLiterals = Set | 'UNKNOWN_SET' | 'BASIC' | 'FULL';
|
|
680
|
+
interface GetOrderResponse {
|
|
714
681
|
/** Order. */
|
|
715
682
|
order?: Order;
|
|
716
683
|
}
|
|
717
|
-
interface
|
|
684
|
+
interface ListOrdersRequest {
|
|
718
685
|
/**
|
|
719
|
-
*
|
|
686
|
+
* Filter by a buyer's member ID, from the Members API.
|
|
720
687
|
* @format GUID
|
|
721
688
|
*/
|
|
722
|
-
|
|
689
|
+
buyerIds?: string[];
|
|
723
690
|
/**
|
|
724
|
-
*
|
|
691
|
+
* Filter by plan IDs, from the Plans API.
|
|
725
692
|
* @format GUID
|
|
726
693
|
*/
|
|
727
|
-
|
|
694
|
+
planIds?: string[];
|
|
695
|
+
/** Filter by whether or not the auto-renewal of recurring orders was canceled. */
|
|
696
|
+
autoRenewCanceled?: boolean | null;
|
|
697
|
+
/** Filter by order status. */
|
|
698
|
+
orderStatuses?: OrderStatusWithLiterals[];
|
|
699
|
+
/** Filter by payment status. */
|
|
700
|
+
paymentStatuses?: PaymentStatusWithLiterals[];
|
|
728
701
|
/**
|
|
729
|
-
*
|
|
702
|
+
* Number of orders to return. See Sorting and Paging for more information.
|
|
730
703
|
*
|
|
731
|
-
*
|
|
704
|
+
* Max: `50`
|
|
705
|
+
* @min 1
|
|
706
|
+
* @max 50
|
|
732
707
|
*/
|
|
733
|
-
|
|
708
|
+
limit?: number | null;
|
|
709
|
+
/** Number of orders to skip in the current sort order. */
|
|
710
|
+
offset?: number | null;
|
|
734
711
|
/**
|
|
735
|
-
*
|
|
712
|
+
* Sort order.
|
|
736
713
|
*
|
|
737
|
-
*
|
|
738
|
-
|
|
739
|
-
|
|
740
|
-
/**
|
|
741
|
-
* Coupon code to apply, from the Coupons API.
|
|
742
|
-
* @minLength 1
|
|
743
|
-
* @maxLength 20
|
|
714
|
+
* Use `ASC` for ascending order or `DESC` for descending order.
|
|
715
|
+
*
|
|
716
|
+
* Default: `DESC`.
|
|
744
717
|
*/
|
|
745
|
-
|
|
718
|
+
sorting?: Sorting;
|
|
746
719
|
/**
|
|
747
|
-
*
|
|
748
|
-
*
|
|
720
|
+
* Predefined set of fields to return.
|
|
721
|
+
*
|
|
722
|
+
* Default: If `fieldSet` is omitted, no order form submission data is returned.
|
|
749
723
|
*/
|
|
750
|
-
|
|
751
|
-
}
|
|
752
|
-
interface CreateOfflineOrderResponse {
|
|
753
|
-
/** Order. */
|
|
754
|
-
order?: Order;
|
|
724
|
+
fieldSet?: SetWithLiterals;
|
|
755
725
|
}
|
|
756
|
-
interface
|
|
726
|
+
interface Sorting {
|
|
757
727
|
/**
|
|
758
|
-
*
|
|
759
|
-
* @
|
|
728
|
+
* Name of the field to sort by.
|
|
729
|
+
* @maxLength 512
|
|
760
730
|
*/
|
|
761
|
-
|
|
731
|
+
fieldName?: string;
|
|
732
|
+
/** Sort order. */
|
|
733
|
+
order?: SortOrderWithLiterals;
|
|
762
734
|
/**
|
|
763
|
-
*
|
|
764
|
-
*
|
|
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).
|
|
765
737
|
*/
|
|
766
|
-
|
|
738
|
+
origin?: AddressLocation;
|
|
767
739
|
}
|
|
768
|
-
|
|
769
|
-
|
|
770
|
-
|
|
740
|
+
declare enum SortOrder {
|
|
741
|
+
ASC = "ASC",
|
|
742
|
+
DESC = "DESC"
|
|
771
743
|
}
|
|
772
|
-
|
|
773
|
-
|
|
774
|
-
|
|
775
|
-
|
|
776
|
-
|
|
777
|
-
|
|
744
|
+
/** @enumType */
|
|
745
|
+
type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
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. */
|
|
754
|
+
orders?: Order[];
|
|
755
|
+
/** Object containing paging-related data (number of orders returned, offset). */
|
|
756
|
+
pagingMetadata?: PagingMetadataV2;
|
|
757
|
+
}
|
|
758
|
+
interface PagingMetadataV2 {
|
|
759
|
+
/** Number of items returned in the response. */
|
|
760
|
+
count?: number | null;
|
|
761
|
+
/** Offset that was requested. */
|
|
762
|
+
offset?: number | null;
|
|
763
|
+
/** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
|
|
764
|
+
total?: number | null;
|
|
765
|
+
/** Flag that indicates the server failed to calculate the `total` field. */
|
|
766
|
+
tooManyToCount?: boolean | null;
|
|
767
|
+
/** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
|
|
768
|
+
cursors?: Cursors;
|
|
769
|
+
}
|
|
770
|
+
interface Cursors {
|
|
778
771
|
/**
|
|
779
|
-
*
|
|
780
|
-
*
|
|
781
|
-
* Default: Current date and time.
|
|
772
|
+
* Cursor string pointing to the next page in the list of results.
|
|
773
|
+
* @maxLength 16000
|
|
782
774
|
*/
|
|
783
|
-
|
|
775
|
+
next?: string | null;
|
|
784
776
|
/**
|
|
785
|
-
*
|
|
786
|
-
* @
|
|
787
|
-
* @maxLength 20
|
|
777
|
+
* Cursor pointing to the previous page in the list of results.
|
|
778
|
+
* @maxLength 16000
|
|
788
779
|
*/
|
|
789
|
-
|
|
780
|
+
prev?: string | null;
|
|
790
781
|
}
|
|
791
|
-
interface
|
|
792
|
-
/** Order preview. This field is undefined if the member has already reached the purchase limit for the order's plan. */
|
|
793
|
-
order?: Order;
|
|
794
|
-
/** Whether the member has already reached purchase limit for the order's plan. */
|
|
795
|
-
purchaseLimitExceeded?: boolean;
|
|
782
|
+
interface GetOrdersStatsRequest {
|
|
796
783
|
}
|
|
797
|
-
interface
|
|
784
|
+
interface GetOrdersStatsResponse {
|
|
785
|
+
/** Total number of orders. */
|
|
786
|
+
totalOrderCount?: number;
|
|
787
|
+
/** Number of active orders. */
|
|
788
|
+
activeOrderCount?: number;
|
|
789
|
+
}
|
|
790
|
+
interface GetAvailableOrderActionsRequest {
|
|
798
791
|
/**
|
|
799
|
-
*
|
|
792
|
+
* Order ID.
|
|
800
793
|
* @format GUID
|
|
801
794
|
*/
|
|
802
|
-
|
|
803
|
-
/**
|
|
804
|
-
* Start date for the ordered plan.
|
|
805
|
-
*
|
|
806
|
-
* Default: Current date
|
|
807
|
-
*/
|
|
808
|
-
startDate?: Date | null;
|
|
809
|
-
/**
|
|
810
|
-
* Coupon code to apply.
|
|
811
|
-
* @minLength 1
|
|
812
|
-
* @maxLength 20
|
|
813
|
-
*/
|
|
814
|
-
couponCode?: string | null;
|
|
815
|
-
/**
|
|
816
|
-
* Email for checkout
|
|
817
|
-
* @format EMAIL
|
|
818
|
-
*/
|
|
819
|
-
email?: string;
|
|
795
|
+
_id?: string;
|
|
820
796
|
}
|
|
821
|
-
interface
|
|
822
|
-
/**
|
|
823
|
-
|
|
824
|
-
/**
|
|
825
|
-
|
|
826
|
-
|
|
827
|
-
|
|
828
|
-
|
|
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"
|
|
829
822
|
}
|
|
830
|
-
|
|
831
|
-
|
|
832
|
-
|
|
833
|
-
* @format GUID
|
|
834
|
-
*/
|
|
835
|
-
planId: string;
|
|
823
|
+
/** @enumType */
|
|
824
|
+
type ReasonNotSuspendableWithLiterals = ReasonNotSuspendable | 'UNDEFINED' | 'PENDING' | 'TRIAL' | 'CANCELED' | 'ENDED' | 'NOT_STARTED' | 'ALREADY_SUSPENDED' | 'OLD_STRIPE';
|
|
825
|
+
interface PostponeEndDateRequest {
|
|
836
826
|
/**
|
|
837
|
-
*
|
|
827
|
+
* Order ID.
|
|
838
828
|
* @format GUID
|
|
839
829
|
*/
|
|
840
|
-
|
|
830
|
+
_id: string;
|
|
841
831
|
/**
|
|
842
|
-
*
|
|
832
|
+
* New end date and time.
|
|
843
833
|
*
|
|
844
|
-
*
|
|
845
|
-
*/
|
|
846
|
-
startDate?: Date | null;
|
|
847
|
-
/**
|
|
848
|
-
* Coupon code to apply, from the Coupons API.
|
|
849
|
-
* @minLength 1
|
|
850
|
-
* @maxLength 20
|
|
834
|
+
* Must be later than the current end date and time.
|
|
851
835
|
*/
|
|
852
|
-
|
|
836
|
+
endDate: Date | null;
|
|
853
837
|
}
|
|
854
|
-
interface
|
|
855
|
-
|
|
838
|
+
interface PostponeEndDateResponse {
|
|
839
|
+
}
|
|
840
|
+
interface OrderEndDatePostponed {
|
|
841
|
+
/** Order whose `endDate` was postponed. */
|
|
856
842
|
order?: Order;
|
|
857
|
-
/**
|
|
858
|
-
* Whether this previewed order would exceed the permitted amount of purchases available
|
|
859
|
-
* for this plan for this buyer.
|
|
860
|
-
*
|
|
861
|
-
* Always `false` for plans that do not have purchase limits.
|
|
862
|
-
*/
|
|
863
|
-
purchaseLimitExceeded?: boolean;
|
|
864
843
|
}
|
|
865
|
-
interface
|
|
844
|
+
interface CancelOrderRequest {
|
|
866
845
|
/**
|
|
867
|
-
* ID
|
|
846
|
+
* Order ID.
|
|
868
847
|
* @format GUID
|
|
869
848
|
*/
|
|
870
|
-
|
|
871
|
-
/**
|
|
872
|
-
|
|
873
|
-
* @minLength 1
|
|
874
|
-
* @maxLength 20
|
|
875
|
-
*/
|
|
876
|
-
couponCode?: string | null;
|
|
849
|
+
_id: string;
|
|
850
|
+
/** __Required.__ When the order will be canceled. One-time orders can only be canceled `IMMEDIATELY`. */
|
|
851
|
+
effectiveAt: CancellationEffectiveAtWithLiterals;
|
|
877
852
|
}
|
|
878
|
-
interface
|
|
879
|
-
/** Pricing details. */
|
|
880
|
-
prices?: SpannedPrice[];
|
|
853
|
+
interface CancelOrderResponse {
|
|
881
854
|
}
|
|
882
|
-
|
|
855
|
+
/**
|
|
856
|
+
* Emitted when an order is canceled immediately or when cycle ends for an order with canceled auto renewal
|
|
857
|
+
*
|
|
858
|
+
* To determine the specific reason of the cancellation check `order.cancellation.cause` field.
|
|
859
|
+
*/
|
|
860
|
+
interface OrderCanceled {
|
|
861
|
+
/** Canceled order. */
|
|
862
|
+
order?: Order;
|
|
863
|
+
}
|
|
864
|
+
interface MarkAsPaidRequest {
|
|
883
865
|
/**
|
|
884
|
-
*
|
|
866
|
+
* Order ID.
|
|
885
867
|
* @format GUID
|
|
886
868
|
*/
|
|
887
|
-
|
|
888
|
-
/** New valid from date (timestamp). */
|
|
889
|
-
startDate?: Date | null;
|
|
869
|
+
_id: string;
|
|
890
870
|
}
|
|
891
|
-
interface
|
|
892
|
-
/** Updated draft order. */
|
|
893
|
-
order?: Order;
|
|
871
|
+
interface MarkAsPaidResponse {
|
|
894
872
|
}
|
|
895
|
-
interface
|
|
896
|
-
/** Order
|
|
873
|
+
interface OrderMarkedAsPaid {
|
|
874
|
+
/** Order that was marked as paid. */
|
|
897
875
|
order?: Order;
|
|
898
876
|
}
|
|
899
|
-
interface
|
|
877
|
+
interface PauseOrderRequest {
|
|
900
878
|
/**
|
|
901
|
-
*
|
|
879
|
+
* Order ID.
|
|
902
880
|
* @format GUID
|
|
903
881
|
*/
|
|
904
|
-
|
|
882
|
+
_id: string;
|
|
883
|
+
}
|
|
884
|
+
interface PauseOrderResponse {
|
|
885
|
+
}
|
|
886
|
+
interface OrderPaused {
|
|
887
|
+
/** Paused order. */
|
|
888
|
+
order?: Order;
|
|
889
|
+
}
|
|
890
|
+
interface BulkPauseOrderRequest {
|
|
905
891
|
/**
|
|
906
|
-
*
|
|
907
|
-
* @
|
|
908
|
-
* @
|
|
892
|
+
* List of Order IDs.
|
|
893
|
+
* @format GUID
|
|
894
|
+
* @minSize 1
|
|
895
|
+
* @maxSize 100
|
|
909
896
|
*/
|
|
910
|
-
|
|
897
|
+
ids?: string[];
|
|
898
|
+
/** Set to true to return Order entity in response. */
|
|
899
|
+
returnFullEntity?: boolean;
|
|
911
900
|
}
|
|
912
|
-
interface
|
|
913
|
-
/**
|
|
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. */
|
|
914
911
|
order?: Order;
|
|
915
912
|
}
|
|
916
|
-
interface
|
|
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 {
|
|
917
940
|
/**
|
|
918
941
|
* Order ID.
|
|
919
942
|
* @format GUID
|
|
920
943
|
*/
|
|
921
|
-
|
|
944
|
+
_id: string;
|
|
945
|
+
}
|
|
946
|
+
interface ResumeOrderResponse {
|
|
947
|
+
}
|
|
948
|
+
interface OrderResumed {
|
|
949
|
+
/** Resumed order. */
|
|
950
|
+
order?: Order;
|
|
951
|
+
}
|
|
952
|
+
interface BulkResumeOrderRequest {
|
|
922
953
|
/**
|
|
923
|
-
*
|
|
954
|
+
* List of Order IDs.
|
|
924
955
|
* @format GUID
|
|
956
|
+
* @minSize 1
|
|
957
|
+
* @maxSize 100
|
|
925
958
|
*/
|
|
926
|
-
|
|
959
|
+
ids?: string[];
|
|
960
|
+
/** Set to true to return Order entity in response. */
|
|
961
|
+
returnFullEntity?: boolean;
|
|
927
962
|
}
|
|
928
|
-
interface
|
|
929
|
-
/**
|
|
930
|
-
|
|
963
|
+
interface BulkResumeOrderResponse {
|
|
964
|
+
/** Orders that were resumed. */
|
|
965
|
+
results?: BulkOrderResult[];
|
|
966
|
+
/** Bulk action metadata. */
|
|
967
|
+
bulkActionMetadata?: BulkActionMetadata;
|
|
931
968
|
}
|
|
932
969
|
interface MessageEnvelope {
|
|
933
970
|
/**
|
|
@@ -1020,345 +1057,314 @@ interface AccountInfo {
|
|
|
1020
1057
|
*/
|
|
1021
1058
|
siteId?: string | null;
|
|
1022
1059
|
}
|
|
1023
|
-
interface
|
|
1024
|
-
/**
|
|
1025
|
-
|
|
1026
|
-
|
|
1027
|
-
|
|
1028
|
-
|
|
1029
|
-
|
|
1060
|
+
interface CreateOnlineOrderRequest {
|
|
1061
|
+
/**
|
|
1062
|
+
* Plan ID.
|
|
1063
|
+
* @format GUID
|
|
1064
|
+
*/
|
|
1065
|
+
planId: string;
|
|
1066
|
+
/**
|
|
1067
|
+
* Start date and time for the plan of the online order in a `YYYY-MM-DDThh:mm[:ss][.sss]Z` format.
|
|
1068
|
+
*
|
|
1069
|
+
* Default: Current date and time.
|
|
1070
|
+
*/
|
|
1071
|
+
startDate?: Date | null;
|
|
1072
|
+
/**
|
|
1073
|
+
* Coupon code to apply.
|
|
1074
|
+
* @minLength 1
|
|
1075
|
+
* @maxLength 20
|
|
1076
|
+
*/
|
|
1077
|
+
couponCode?: string | null;
|
|
1078
|
+
/** Provided if checkout is initiated on buyer's behalf. */
|
|
1079
|
+
onBehalf?: OnBehalf;
|
|
1080
|
+
/**
|
|
1081
|
+
* Submission ID of the form submitted with this order.
|
|
1082
|
+
*
|
|
1083
|
+
* The submission must belong to the form attached to the plan, and that form must belong to the Pricing Plans namespace.
|
|
1084
|
+
* An invalid submission ID is dropped and the order is created without a submission.
|
|
1085
|
+
* @format GUID
|
|
1086
|
+
*/
|
|
1087
|
+
submissionId?: string | null;
|
|
1030
1088
|
}
|
|
1031
|
-
|
|
1032
|
-
|
|
1033
|
-
|
|
1034
|
-
|
|
1035
|
-
|
|
1036
|
-
|
|
1037
|
-
/**
|
|
1038
|
-
|
|
1039
|
-
/** 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. */
|
|
1040
|
-
cycleNumber?: number;
|
|
1089
|
+
interface OnBehalf {
|
|
1090
|
+
/**
|
|
1091
|
+
* Member ID.
|
|
1092
|
+
* @format GUID
|
|
1093
|
+
*/
|
|
1094
|
+
memberId?: string;
|
|
1095
|
+
/** Method by which checkout is initiated. */
|
|
1096
|
+
orderMethod?: OrderMethodWithLiterals;
|
|
1041
1097
|
}
|
|
1042
|
-
|
|
1043
|
-
|
|
1044
|
-
/** Order that is canceled, effective at the end of the current payment cycle. */
|
|
1098
|
+
interface CreateOnlineOrderResponse {
|
|
1099
|
+
/** Created online order. */
|
|
1045
1100
|
order?: Order;
|
|
1046
1101
|
}
|
|
1047
|
-
interface
|
|
1048
|
-
/**
|
|
1049
|
-
|
|
1102
|
+
interface CouponsError {
|
|
1103
|
+
/** Coupon code. */
|
|
1104
|
+
couponCode?: string;
|
|
1105
|
+
/** Plan ID. */
|
|
1106
|
+
planId?: string;
|
|
1050
1107
|
}
|
|
1051
|
-
interface
|
|
1108
|
+
interface CreateGuestOnlineOrderRequest {
|
|
1109
|
+
/**
|
|
1110
|
+
* Plan ID.
|
|
1111
|
+
* @format GUID
|
|
1112
|
+
*/
|
|
1113
|
+
planId?: string;
|
|
1114
|
+
/**
|
|
1115
|
+
* Start date for the ordered plan.
|
|
1116
|
+
*
|
|
1117
|
+
* Default: Current date
|
|
1118
|
+
*/
|
|
1119
|
+
startDate?: Date | null;
|
|
1120
|
+
/**
|
|
1121
|
+
* Coupon code to apply.
|
|
1122
|
+
* @minLength 1
|
|
1123
|
+
* @maxLength 20
|
|
1124
|
+
*/
|
|
1125
|
+
couponCode?: string | null;
|
|
1126
|
+
/** Captcha data to prove you are not a robot */
|
|
1127
|
+
captcha?: Captcha;
|
|
1128
|
+
/** Visitor info */
|
|
1129
|
+
guest?: Guest;
|
|
1052
1130
|
/**
|
|
1053
|
-
*
|
|
1131
|
+
* Form submission id that was submitted together with the order
|
|
1054
1132
|
* @format GUID
|
|
1055
1133
|
*/
|
|
1056
|
-
|
|
1134
|
+
submissionId?: string | null;
|
|
1135
|
+
}
|
|
1136
|
+
interface Captcha {
|
|
1137
|
+
/** Token from captcha */
|
|
1138
|
+
token?: string;
|
|
1139
|
+
}
|
|
1140
|
+
interface Guest {
|
|
1057
1141
|
/**
|
|
1058
|
-
*
|
|
1059
|
-
*
|
|
1060
|
-
* Default: If `fieldSet` is omitted, no order form submission data is returned.
|
|
1142
|
+
* Email for checkout
|
|
1143
|
+
* @format EMAIL
|
|
1061
1144
|
*/
|
|
1062
|
-
|
|
1063
|
-
}
|
|
1064
|
-
declare enum Set {
|
|
1065
|
-
/** Same behavior as `BASIC`.` */
|
|
1066
|
-
UNKNOWN_SET = "UNKNOWN_SET",
|
|
1067
|
-
/** Doesn't return any order form submission data. */
|
|
1068
|
-
BASIC = "BASIC",
|
|
1069
|
-
/** Returns all order form submission data. */
|
|
1070
|
-
FULL = "FULL"
|
|
1145
|
+
email?: string;
|
|
1071
1146
|
}
|
|
1072
|
-
|
|
1073
|
-
type SetWithLiterals = Set | 'UNKNOWN_SET' | 'BASIC' | 'FULL';
|
|
1074
|
-
interface GetOrderResponse {
|
|
1147
|
+
interface CreateGuestOnlineOrderResponse {
|
|
1075
1148
|
/** Order. */
|
|
1076
1149
|
order?: Order;
|
|
1077
1150
|
}
|
|
1078
|
-
interface
|
|
1151
|
+
interface CreateOfflineOrderRequest {
|
|
1079
1152
|
/**
|
|
1080
|
-
*
|
|
1153
|
+
* ID of the plan being ordered, from the Plans API.
|
|
1081
1154
|
* @format GUID
|
|
1082
1155
|
*/
|
|
1083
|
-
|
|
1156
|
+
planId: string;
|
|
1084
1157
|
/**
|
|
1085
|
-
*
|
|
1158
|
+
* ID of the member ordering the plan, from the Members API.
|
|
1086
1159
|
* @format GUID
|
|
1087
1160
|
*/
|
|
1088
|
-
|
|
1089
|
-
/** Filter by whether or not the auto-renewal of recurring orders was canceled. */
|
|
1090
|
-
autoRenewCanceled?: boolean | null;
|
|
1091
|
-
/** Filter by order status. */
|
|
1092
|
-
orderStatuses?: OrderStatusWithLiterals[];
|
|
1093
|
-
/** Filter by payment status. */
|
|
1094
|
-
paymentStatuses?: PaymentStatusWithLiterals[];
|
|
1161
|
+
memberId: string;
|
|
1095
1162
|
/**
|
|
1096
|
-
*
|
|
1163
|
+
* Start date and time for the ordered plan in a `YYYY-MM-DDThh:mm[:ss][.sss]Z` format.
|
|
1097
1164
|
*
|
|
1098
|
-
*
|
|
1099
|
-
* @min 1
|
|
1100
|
-
* @max 50
|
|
1165
|
+
* Default: Current date and time.
|
|
1101
1166
|
*/
|
|
1102
|
-
|
|
1103
|
-
/** Number of orders to skip in the current sort order. */
|
|
1104
|
-
offset?: number | null;
|
|
1167
|
+
startDate?: Date | null;
|
|
1105
1168
|
/**
|
|
1106
|
-
*
|
|
1107
|
-
*
|
|
1108
|
-
* Use `ASC` for ascending order or `DESC` for descending order.
|
|
1169
|
+
* Whether the order is paid.
|
|
1109
1170
|
*
|
|
1110
|
-
* Default: `
|
|
1171
|
+
* Default: `false`
|
|
1111
1172
|
*/
|
|
1112
|
-
|
|
1173
|
+
paid?: boolean | null;
|
|
1113
1174
|
/**
|
|
1114
|
-
*
|
|
1175
|
+
* Coupon code to apply, from the Coupons API.
|
|
1176
|
+
* @minLength 1
|
|
1177
|
+
* @maxLength 20
|
|
1178
|
+
*/
|
|
1179
|
+
couponCode?: string | null;
|
|
1180
|
+
/**
|
|
1181
|
+
* Form submission ID that was submitted with the order.
|
|
1115
1182
|
*
|
|
1116
|
-
*
|
|
1183
|
+
* The submission must belong to the form attached to the plan, and that form must belong to the Pricing Plans namespace.
|
|
1184
|
+
* An invalid submission ID is dropped and the order is created without a submission.
|
|
1185
|
+
* @format GUID
|
|
1117
1186
|
*/
|
|
1118
|
-
|
|
1187
|
+
submissionId?: string | null;
|
|
1119
1188
|
}
|
|
1120
|
-
interface
|
|
1189
|
+
interface CreateOfflineOrderResponse {
|
|
1190
|
+
/** Order. */
|
|
1191
|
+
order?: Order;
|
|
1192
|
+
}
|
|
1193
|
+
interface CreateExternalOrderRequest {
|
|
1121
1194
|
/**
|
|
1122
|
-
*
|
|
1123
|
-
* @
|
|
1195
|
+
* Plan ID.
|
|
1196
|
+
* @format GUID
|
|
1124
1197
|
*/
|
|
1125
|
-
|
|
1126
|
-
/** Sort order. */
|
|
1127
|
-
order?: SortOrderWithLiterals;
|
|
1198
|
+
planId?: string;
|
|
1128
1199
|
/**
|
|
1129
|
-
*
|
|
1130
|
-
*
|
|
1200
|
+
* Form submission id that was submitted together with the order
|
|
1201
|
+
* @format GUID
|
|
1131
1202
|
*/
|
|
1132
|
-
|
|
1133
|
-
}
|
|
1134
|
-
declare enum SortOrder {
|
|
1135
|
-
ASC = "ASC",
|
|
1136
|
-
DESC = "DESC"
|
|
1137
|
-
}
|
|
1138
|
-
/** @enumType */
|
|
1139
|
-
type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
1140
|
-
interface AddressLocation {
|
|
1141
|
-
/** Address latitude. */
|
|
1142
|
-
latitude?: number | null;
|
|
1143
|
-
/** Address longitude. */
|
|
1144
|
-
longitude?: number | null;
|
|
1145
|
-
}
|
|
1146
|
-
interface ListOrdersResponse {
|
|
1147
|
-
/** List of orders. */
|
|
1148
|
-
orders?: Order[];
|
|
1149
|
-
/** Object containing paging-related data (number of orders returned, offset). */
|
|
1150
|
-
pagingMetadata?: PagingMetadataV2;
|
|
1203
|
+
submissionId?: string | null;
|
|
1151
1204
|
}
|
|
1152
|
-
interface
|
|
1153
|
-
/**
|
|
1154
|
-
|
|
1155
|
-
/** Offset that was requested. */
|
|
1156
|
-
offset?: number | null;
|
|
1157
|
-
/** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
|
|
1158
|
-
total?: number | null;
|
|
1159
|
-
/** Flag that indicates the server failed to calculate the `total` field. */
|
|
1160
|
-
tooManyToCount?: boolean | null;
|
|
1161
|
-
/** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
|
|
1162
|
-
cursors?: Cursors;
|
|
1205
|
+
interface CreateExternalOrderResponse {
|
|
1206
|
+
/** Created order */
|
|
1207
|
+
order?: Order;
|
|
1163
1208
|
}
|
|
1164
|
-
interface
|
|
1209
|
+
interface GetOnlineOrderPreviewRequest {
|
|
1165
1210
|
/**
|
|
1166
|
-
*
|
|
1167
|
-
* @
|
|
1211
|
+
* Plan ID.
|
|
1212
|
+
* @format GUID
|
|
1168
1213
|
*/
|
|
1169
|
-
|
|
1214
|
+
planId: string;
|
|
1170
1215
|
/**
|
|
1171
|
-
*
|
|
1172
|
-
*
|
|
1216
|
+
* Start date and time for the plan of the order preview in a `YYYY-MM-DDThh:mm[:ss][.sss]Z` format.
|
|
1217
|
+
*
|
|
1218
|
+
* Default: Current date and time.
|
|
1173
1219
|
*/
|
|
1174
|
-
|
|
1175
|
-
|
|
1176
|
-
|
|
1220
|
+
startDate?: Date | null;
|
|
1221
|
+
/**
|
|
1222
|
+
* Coupon code to apply.
|
|
1223
|
+
* @minLength 1
|
|
1224
|
+
* @maxLength 20
|
|
1225
|
+
*/
|
|
1226
|
+
couponCode?: string | null;
|
|
1177
1227
|
}
|
|
1178
|
-
interface
|
|
1179
|
-
/**
|
|
1180
|
-
|
|
1181
|
-
/**
|
|
1182
|
-
|
|
1228
|
+
interface GetOnlineOrderPreviewResponse {
|
|
1229
|
+
/** Order preview. This field is undefined if the member has already reached the purchase limit for the order's plan. */
|
|
1230
|
+
order?: Order;
|
|
1231
|
+
/** Whether the member has already reached purchase limit for the order's plan. */
|
|
1232
|
+
purchaseLimitExceeded?: boolean;
|
|
1183
1233
|
}
|
|
1184
|
-
interface
|
|
1234
|
+
interface GetGuestOnlineOrderPreviewRequest {
|
|
1185
1235
|
/**
|
|
1186
|
-
*
|
|
1236
|
+
* Plan ID.
|
|
1187
1237
|
* @format GUID
|
|
1188
1238
|
*/
|
|
1189
|
-
|
|
1190
|
-
|
|
1191
|
-
|
|
1192
|
-
|
|
1193
|
-
|
|
1194
|
-
|
|
1195
|
-
|
|
1196
|
-
/**
|
|
1197
|
-
|
|
1239
|
+
planId?: string;
|
|
1240
|
+
/**
|
|
1241
|
+
* Start date for the ordered plan.
|
|
1242
|
+
*
|
|
1243
|
+
* Default: Current date
|
|
1244
|
+
*/
|
|
1245
|
+
startDate?: Date | null;
|
|
1246
|
+
/**
|
|
1247
|
+
* Coupon code to apply.
|
|
1248
|
+
* @minLength 1
|
|
1249
|
+
* @maxLength 20
|
|
1250
|
+
*/
|
|
1251
|
+
couponCode?: string | null;
|
|
1252
|
+
/**
|
|
1253
|
+
* Email for checkout
|
|
1254
|
+
* @format EMAIL
|
|
1255
|
+
*/
|
|
1256
|
+
email?: string;
|
|
1198
1257
|
}
|
|
1199
|
-
|
|
1200
|
-
/**
|
|
1201
|
-
|
|
1202
|
-
/**
|
|
1203
|
-
|
|
1204
|
-
|
|
1205
|
-
|
|
1206
|
-
|
|
1207
|
-
CANCELED = "CANCELED",
|
|
1208
|
-
/** Ended orders can't be suspended. */
|
|
1209
|
-
ENDED = "ENDED",
|
|
1210
|
-
/** Paid for orders with future start dates can't be suspended. */
|
|
1211
|
-
NOT_STARTED = "NOT_STARTED",
|
|
1212
|
-
/** Order is already suspended. */
|
|
1213
|
-
ALREADY_SUSPENDED = "ALREADY_SUSPENDED",
|
|
1214
|
-
/** Orders based on recurring payments using older stripe versions can't be suspended. */
|
|
1215
|
-
OLD_STRIPE = "OLD_STRIPE"
|
|
1258
|
+
interface GetGuestOnlineOrderPreviewResponse {
|
|
1259
|
+
/** Will be missing if limit is exceeded */
|
|
1260
|
+
order?: Order;
|
|
1261
|
+
/**
|
|
1262
|
+
* Whether the purchase limit has already been reached for this plan by this email.
|
|
1263
|
+
* Always false for plans without purchase limits.
|
|
1264
|
+
*/
|
|
1265
|
+
purchaseLimitExceeded?: boolean;
|
|
1216
1266
|
}
|
|
1217
|
-
|
|
1218
|
-
type ReasonNotSuspendableWithLiterals = ReasonNotSuspendable | 'UNDEFINED' | 'PENDING' | 'TRIAL' | 'CANCELED' | 'ENDED' | 'NOT_STARTED' | 'ALREADY_SUSPENDED' | 'OLD_STRIPE';
|
|
1219
|
-
interface PostponeEndDateRequest {
|
|
1267
|
+
interface GetOfflineOrderPreviewRequest {
|
|
1220
1268
|
/**
|
|
1221
|
-
*
|
|
1269
|
+
* ID of the plan of the previewed order, from the Plans API.
|
|
1222
1270
|
* @format GUID
|
|
1223
1271
|
*/
|
|
1224
|
-
|
|
1272
|
+
planId: string;
|
|
1225
1273
|
/**
|
|
1226
|
-
*
|
|
1274
|
+
* Member ID of the buyer the previewed order is for, from the Members API.
|
|
1275
|
+
* @format GUID
|
|
1276
|
+
*/
|
|
1277
|
+
memberId: string;
|
|
1278
|
+
/**
|
|
1279
|
+
* Start date and time for plan of the previewed order in a `YYYY-MM-DDThh:mm[:ss][.sss]Z` format.
|
|
1280
|
+
*
|
|
1281
|
+
* Default: Current date and time.
|
|
1282
|
+
*/
|
|
1283
|
+
startDate?: Date | null;
|
|
1284
|
+
/**
|
|
1285
|
+
* Coupon code to apply, from the Coupons API.
|
|
1286
|
+
* @minLength 1
|
|
1287
|
+
* @maxLength 20
|
|
1288
|
+
*/
|
|
1289
|
+
couponCode?: string | null;
|
|
1290
|
+
}
|
|
1291
|
+
interface GetOfflineOrderPreviewResponse {
|
|
1292
|
+
/** The previewed order, as if the plan had been ordered. */
|
|
1293
|
+
order?: Order;
|
|
1294
|
+
/**
|
|
1295
|
+
* Whether this previewed order would exceed the permitted amount of purchases available
|
|
1296
|
+
* for this plan for this buyer.
|
|
1227
1297
|
*
|
|
1228
|
-
*
|
|
1298
|
+
* Always `false` for plans that do not have purchase limits.
|
|
1229
1299
|
*/
|
|
1230
|
-
|
|
1231
|
-
}
|
|
1232
|
-
interface PostponeEndDateResponse {
|
|
1233
|
-
}
|
|
1234
|
-
interface OrderEndDatePostponed {
|
|
1235
|
-
/** Order whose `endDate` was postponed. */
|
|
1236
|
-
order?: Order;
|
|
1300
|
+
purchaseLimitExceeded?: boolean;
|
|
1237
1301
|
}
|
|
1238
|
-
interface
|
|
1302
|
+
interface GetPricePreviewRequest {
|
|
1239
1303
|
/**
|
|
1240
|
-
*
|
|
1304
|
+
* ID of plan to preview.
|
|
1241
1305
|
* @format GUID
|
|
1242
1306
|
*/
|
|
1243
|
-
|
|
1244
|
-
/** __Required.__ When the order will be canceled. One-time orders can only be canceled `IMMEDIATELY`. */
|
|
1245
|
-
effectiveAt: CancellationEffectiveAtWithLiterals;
|
|
1246
|
-
}
|
|
1247
|
-
interface CancelOrderResponse {
|
|
1248
|
-
}
|
|
1249
|
-
/**
|
|
1250
|
-
* Emitted when an order is canceled immediately or when cycle ends for an order with canceled auto renewal
|
|
1251
|
-
*
|
|
1252
|
-
* To determine the specific reason of the cancellation check `order.cancellation.cause` field.
|
|
1253
|
-
*/
|
|
1254
|
-
interface OrderCanceled {
|
|
1255
|
-
/** Canceled order. */
|
|
1256
|
-
order?: Order;
|
|
1257
|
-
}
|
|
1258
|
-
interface MarkAsPaidRequest {
|
|
1307
|
+
planId: string;
|
|
1259
1308
|
/**
|
|
1260
|
-
*
|
|
1261
|
-
* @
|
|
1309
|
+
* Coupon code to apply, from the Coupons API.
|
|
1310
|
+
* @minLength 1
|
|
1311
|
+
* @maxLength 20
|
|
1262
1312
|
*/
|
|
1263
|
-
|
|
1264
|
-
}
|
|
1265
|
-
interface MarkAsPaidResponse {
|
|
1313
|
+
couponCode?: string | null;
|
|
1266
1314
|
}
|
|
1267
|
-
interface
|
|
1268
|
-
/**
|
|
1269
|
-
|
|
1315
|
+
interface GetPricePreviewResponse {
|
|
1316
|
+
/** Pricing details. */
|
|
1317
|
+
prices?: SpannedPrice[];
|
|
1270
1318
|
}
|
|
1271
|
-
interface
|
|
1319
|
+
interface ChangeStartDateRequest {
|
|
1272
1320
|
/**
|
|
1273
|
-
*
|
|
1321
|
+
* Draft order ID.
|
|
1274
1322
|
* @format GUID
|
|
1275
1323
|
*/
|
|
1276
|
-
|
|
1324
|
+
orderId?: string;
|
|
1325
|
+
/** New valid from date (timestamp). */
|
|
1326
|
+
startDate?: Date | null;
|
|
1277
1327
|
}
|
|
1278
|
-
interface
|
|
1328
|
+
interface ChangeStartDateResponse {
|
|
1329
|
+
/** Updated draft order. */
|
|
1330
|
+
order?: Order;
|
|
1279
1331
|
}
|
|
1280
|
-
interface
|
|
1281
|
-
/**
|
|
1332
|
+
interface OrderStartDateChanged {
|
|
1333
|
+
/** Order whose `startDate` changed. */
|
|
1282
1334
|
order?: Order;
|
|
1283
1335
|
}
|
|
1284
|
-
interface
|
|
1336
|
+
interface ApplyCouponRequest {
|
|
1285
1337
|
/**
|
|
1286
|
-
*
|
|
1338
|
+
* Draft order ID.
|
|
1287
1339
|
* @format GUID
|
|
1288
|
-
* @minSize 1
|
|
1289
|
-
* @maxSize 100
|
|
1290
1340
|
*/
|
|
1291
|
-
|
|
1292
|
-
/**
|
|
1293
|
-
|
|
1294
|
-
|
|
1295
|
-
|
|
1296
|
-
|
|
1297
|
-
|
|
1298
|
-
/** Bulk action metadata. */
|
|
1299
|
-
bulkActionMetadata?: BulkActionMetadata;
|
|
1341
|
+
orderId?: string;
|
|
1342
|
+
/**
|
|
1343
|
+
* Coupon code to apply.
|
|
1344
|
+
* @minLength 1
|
|
1345
|
+
* @maxLength 20
|
|
1346
|
+
*/
|
|
1347
|
+
couponCode?: string;
|
|
1300
1348
|
}
|
|
1301
|
-
interface
|
|
1302
|
-
/**
|
|
1303
|
-
itemMetadata?: ItemMetadata;
|
|
1304
|
-
/** The order. */
|
|
1349
|
+
interface ApplyCouponResponse {
|
|
1350
|
+
/** Order with applied coupon and recalculated tax. */
|
|
1305
1351
|
order?: Order;
|
|
1306
1352
|
}
|
|
1307
|
-
interface
|
|
1308
|
-
/** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
|
|
1309
|
-
_id?: string | null;
|
|
1310
|
-
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
1311
|
-
originalIndex?: number;
|
|
1312
|
-
/** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
|
|
1313
|
-
success?: boolean;
|
|
1314
|
-
/** Details about the error in case of failure. */
|
|
1315
|
-
error?: ApplicationError;
|
|
1316
|
-
}
|
|
1317
|
-
interface ApplicationError {
|
|
1318
|
-
/** Error code. */
|
|
1319
|
-
code?: string;
|
|
1320
|
-
/** Description of the error. */
|
|
1321
|
-
description?: string;
|
|
1322
|
-
/** Data related to the error. */
|
|
1323
|
-
data?: Record<string, any> | null;
|
|
1324
|
-
}
|
|
1325
|
-
interface BulkActionMetadata {
|
|
1326
|
-
/** Number of items that were successfully processed. */
|
|
1327
|
-
totalSuccesses?: number;
|
|
1328
|
-
/** Number of items that couldn't be processed. */
|
|
1329
|
-
totalFailures?: number;
|
|
1330
|
-
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
1331
|
-
undetailedFailures?: number;
|
|
1332
|
-
}
|
|
1333
|
-
interface ResumeOrderRequest {
|
|
1353
|
+
interface SetSubmissionRequest {
|
|
1334
1354
|
/**
|
|
1335
1355
|
* Order ID.
|
|
1336
1356
|
* @format GUID
|
|
1337
1357
|
*/
|
|
1338
|
-
|
|
1339
|
-
}
|
|
1340
|
-
interface ResumeOrderResponse {
|
|
1341
|
-
}
|
|
1342
|
-
interface OrderResumed {
|
|
1343
|
-
/** Resumed order. */
|
|
1344
|
-
order?: Order;
|
|
1345
|
-
}
|
|
1346
|
-
interface BulkResumeOrderRequest {
|
|
1358
|
+
orderId?: string;
|
|
1347
1359
|
/**
|
|
1348
|
-
*
|
|
1360
|
+
* Submission ID.
|
|
1349
1361
|
* @format GUID
|
|
1350
|
-
* @minSize 1
|
|
1351
|
-
* @maxSize 100
|
|
1352
1362
|
*/
|
|
1353
|
-
|
|
1354
|
-
/** Set to true to return Order entity in response. */
|
|
1355
|
-
returnFullEntity?: boolean;
|
|
1363
|
+
submissionId?: string;
|
|
1356
1364
|
}
|
|
1357
|
-
interface
|
|
1358
|
-
/**
|
|
1359
|
-
|
|
1360
|
-
/** Bulk action metadata. */
|
|
1361
|
-
bulkActionMetadata?: BulkActionMetadata;
|
|
1365
|
+
interface SetSubmissionResponse {
|
|
1366
|
+
/** Order with submission id */
|
|
1367
|
+
order?: Order;
|
|
1362
1368
|
}
|
|
1363
1369
|
interface MemberGetOrderRequest {
|
|
1364
1370
|
/**
|
|
@@ -1774,12 +1780,16 @@ interface AccountInfoMetadata {
|
|
|
1774
1780
|
/** ID of the parent Wix account. Only included when 'accountId' belongs to a child account. */
|
|
1775
1781
|
parentAccountId?: string;
|
|
1776
1782
|
}
|
|
1777
|
-
interface
|
|
1778
|
-
|
|
1783
|
+
interface OrderAutoRenewCanceledEnvelope {
|
|
1784
|
+
data: OrderAutoRenewCanceled;
|
|
1779
1785
|
metadata: EventMetadata;
|
|
1780
1786
|
}
|
|
1781
1787
|
/**
|
|
1782
|
-
* Triggered when an order is
|
|
1788
|
+
* Triggered when an order is canceled and `effectiveAt` is set to `NEXT_PAYMENT_DATE`.
|
|
1789
|
+
*
|
|
1790
|
+
* This webhook is *not* triggered in the following scenarios:
|
|
1791
|
+
* + When an order is canceled and `effectiveAt` is set to `IMMEDIATELY`. Instead, at the time of cancellation, Order Canceled is triggered.
|
|
1792
|
+
* + 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.
|
|
1783
1793
|
* @permissionScope Manage_Wix_Rentals_App_Forms_submissions
|
|
1784
1794
|
* @permissionScopeId SCOPE.RENTALS.MANAGE
|
|
1785
1795
|
* @permissionScope Manage Orders
|
|
@@ -1792,17 +1802,21 @@ interface OrderCreatedEnvelope {
|
|
|
1792
1802
|
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1793
1803
|
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
1794
1804
|
* @webhook
|
|
1795
|
-
* @eventType wix.pricing_plans.v2.
|
|
1796
|
-
* @serviceIdentifier com.wixpress.membership.v2.orders.
|
|
1797
|
-
* @slug
|
|
1805
|
+
* @eventType wix.pricing_plans.v2.order_auto_renew_canceled
|
|
1806
|
+
* @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
|
|
1807
|
+
* @slug auto_renew_canceled
|
|
1798
1808
|
*/
|
|
1799
|
-
declare function
|
|
1800
|
-
interface
|
|
1801
|
-
data:
|
|
1809
|
+
declare function onOrderAutoRenewCanceled(handler: (event: OrderAutoRenewCanceledEnvelope) => void | Promise<void>): void;
|
|
1810
|
+
interface OrderCanceledEnvelope {
|
|
1811
|
+
data: OrderCanceled;
|
|
1802
1812
|
metadata: EventMetadata;
|
|
1803
1813
|
}
|
|
1804
1814
|
/**
|
|
1805
|
-
* Triggered when an order
|
|
1815
|
+
* Triggered when an order is canceled.
|
|
1816
|
+
*
|
|
1817
|
+
* This webhook is triggered either immediately or at the end of the current payment cycle, as follows:
|
|
1818
|
+
* + If the order is canceled and `effectiveAt` is set to `IMMEDIATELY`, the webhook is triggered immediately when canceled.
|
|
1819
|
+
* + 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.
|
|
1806
1820
|
* @permissionScope Manage_Wix_Rentals_App_Forms_submissions
|
|
1807
1821
|
* @permissionScopeId SCOPE.RENTALS.MANAGE
|
|
1808
1822
|
* @permissionScope Manage Orders
|
|
@@ -1815,25 +1829,19 @@ interface OrderStartDateChangedEnvelope {
|
|
|
1815
1829
|
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1816
1830
|
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
1817
1831
|
* @webhook
|
|
1818
|
-
* @eventType wix.pricing_plans.v2.
|
|
1819
|
-
* @serviceIdentifier com.wixpress.membership.v2.orders.
|
|
1820
|
-
* @slug
|
|
1832
|
+
* @eventType wix.pricing_plans.v2.order_canceled
|
|
1833
|
+
* @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
|
|
1834
|
+
* @slug canceled
|
|
1821
1835
|
*/
|
|
1822
|
-
declare function
|
|
1823
|
-
interface
|
|
1824
|
-
|
|
1836
|
+
declare function onOrderCanceled(handler: (event: OrderCanceledEnvelope) => void | Promise<void>): void;
|
|
1837
|
+
interface OrderCycleStartedEnvelope {
|
|
1838
|
+
data: OrderCycleStarted;
|
|
1825
1839
|
metadata: EventMetadata;
|
|
1826
1840
|
}
|
|
1827
1841
|
/**
|
|
1828
|
-
* Triggered
|
|
1842
|
+
* Triggered at the start of a new payment cycle for an existing order.
|
|
1829
1843
|
*
|
|
1830
|
-
*
|
|
1831
|
-
* + Order reaches its start date or end date. Order Started and Order Ended, respectively, are also triggered.
|
|
1832
|
-
* + New payment cycle of an order starts. Order Cycle Started is also triggered.
|
|
1833
|
-
* + Offline order is marked as paid. Order Marked As Paid is also triggered.
|
|
1834
|
-
* + End date of the order is postponed. Order End Date Postponed is also triggered
|
|
1835
|
-
* + Order is paused, or a paused order is resumed. Order Paused and Order Resumed, respectively, are also triggered.
|
|
1836
|
-
* + Order is canceled, either immediately or at the end of the payment cycle. Order Canceled and Order Auto Renew Canceled, respectively, are also triggered.
|
|
1844
|
+
* Not triggered at the initial start of an offline order.
|
|
1837
1845
|
* @permissionScope Manage_Wix_Rentals_App_Forms_submissions
|
|
1838
1846
|
* @permissionScopeId SCOPE.RENTALS.MANAGE
|
|
1839
1847
|
* @permissionScope Manage Orders
|
|
@@ -1846,21 +1854,67 @@ interface OrderUpdatedEnvelope {
|
|
|
1846
1854
|
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1847
1855
|
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
1848
1856
|
* @webhook
|
|
1849
|
-
* @eventType wix.pricing_plans.v2.
|
|
1850
|
-
* @serviceIdentifier com.wixpress.membership.v2.orders.
|
|
1851
|
-
* @slug
|
|
1857
|
+
* @eventType wix.pricing_plans.v2.order_cycle_started
|
|
1858
|
+
* @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
|
|
1859
|
+
* @slug cycle_started
|
|
1852
1860
|
*/
|
|
1853
|
-
declare function
|
|
1854
|
-
interface
|
|
1855
|
-
data:
|
|
1861
|
+
declare function onOrderCycleStarted(handler: (event: OrderCycleStartedEnvelope) => void | Promise<void>): void;
|
|
1862
|
+
interface OrderEndDatePostponedEnvelope {
|
|
1863
|
+
data: OrderEndDatePostponed;
|
|
1856
1864
|
metadata: EventMetadata;
|
|
1857
1865
|
}
|
|
1858
1866
|
/**
|
|
1859
|
-
* Triggered when an order
|
|
1867
|
+
* Triggered when an order's `endDate` is postponed.
|
|
1868
|
+
* @permissionScope Manage_Wix_Rentals_App_Forms_submissions
|
|
1869
|
+
* @permissionScopeId SCOPE.RENTALS.MANAGE
|
|
1870
|
+
* @permissionScope Manage Orders
|
|
1871
|
+
* @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
|
|
1872
|
+
* @permissionScope Read Orders
|
|
1873
|
+
* @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS
|
|
1874
|
+
* @permissionScope Manage plans and orders of Pricing Plans
|
|
1875
|
+
* @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-PLANS-AND-ORDERS
|
|
1876
|
+
* @permissionScope Manage Events
|
|
1877
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1878
|
+
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
1879
|
+
* @webhook
|
|
1880
|
+
* @eventType wix.pricing_plans.v2.order_end_date_postponed
|
|
1881
|
+
* @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
|
|
1882
|
+
* @slug end_date_postponed
|
|
1883
|
+
*/
|
|
1884
|
+
declare function onOrderEndDatePostponed(handler: (event: OrderEndDatePostponedEnvelope) => void | Promise<void>): void;
|
|
1885
|
+
interface OrderEndedEnvelope {
|
|
1886
|
+
data: OrderEnded;
|
|
1887
|
+
metadata: EventMetadata;
|
|
1888
|
+
}
|
|
1889
|
+
/**
|
|
1890
|
+
* Triggered when an order ends.
|
|
1860
1891
|
*
|
|
1861
|
-
* This webhook is
|
|
1862
|
-
* + When an order
|
|
1863
|
-
* + When an order
|
|
1892
|
+
* This webhook is triggered:
|
|
1893
|
+
* + When an order expires at the end of the current payment cycle.
|
|
1894
|
+
* + When an order is canceled and `effectiveAt` is set to `IMMEDIATELY`.
|
|
1895
|
+
* @permissionScope Manage_Wix_Rentals_App_Forms_submissions
|
|
1896
|
+
* @permissionScopeId SCOPE.RENTALS.MANAGE
|
|
1897
|
+
* @permissionScope Manage Orders
|
|
1898
|
+
* @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
|
|
1899
|
+
* @permissionScope Read Orders
|
|
1900
|
+
* @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS
|
|
1901
|
+
* @permissionScope Manage plans and orders of Pricing Plans
|
|
1902
|
+
* @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-PLANS-AND-ORDERS
|
|
1903
|
+
* @permissionScope Manage Events
|
|
1904
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1905
|
+
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
1906
|
+
* @webhook
|
|
1907
|
+
* @eventType wix.pricing_plans.v2.order_ended
|
|
1908
|
+
* @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
|
|
1909
|
+
* @slug ended
|
|
1910
|
+
*/
|
|
1911
|
+
declare function onOrderEnded(handler: (event: OrderEndedEnvelope) => void | Promise<void>): void;
|
|
1912
|
+
interface OrderMarkedAsPaidEnvelope {
|
|
1913
|
+
data: OrderMarkedAsPaid;
|
|
1914
|
+
metadata: EventMetadata;
|
|
1915
|
+
}
|
|
1916
|
+
/**
|
|
1917
|
+
* Triggered when an offline order is marked as paid.
|
|
1864
1918
|
* @permissionScope Manage_Wix_Rentals_App_Forms_submissions
|
|
1865
1919
|
* @permissionScopeId SCOPE.RENTALS.MANAGE
|
|
1866
1920
|
* @permissionScope Manage Orders
|
|
@@ -1873,21 +1927,17 @@ interface OrderAutoRenewCanceledEnvelope {
|
|
|
1873
1927
|
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1874
1928
|
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
1875
1929
|
* @webhook
|
|
1876
|
-
* @eventType wix.pricing_plans.v2.
|
|
1930
|
+
* @eventType wix.pricing_plans.v2.order_marked_as_paid
|
|
1877
1931
|
* @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
|
|
1878
|
-
* @slug
|
|
1932
|
+
* @slug marked_as_paid
|
|
1879
1933
|
*/
|
|
1880
|
-
declare function
|
|
1881
|
-
interface
|
|
1882
|
-
data:
|
|
1934
|
+
declare function onOrderMarkedAsPaid(handler: (event: OrderMarkedAsPaidEnvelope) => void | Promise<void>): void;
|
|
1935
|
+
interface OrderPausedEnvelope {
|
|
1936
|
+
data: OrderPaused;
|
|
1883
1937
|
metadata: EventMetadata;
|
|
1884
1938
|
}
|
|
1885
1939
|
/**
|
|
1886
|
-
* Triggered when an order is
|
|
1887
|
-
*
|
|
1888
|
-
* This webhook is triggered either immediately or at the end of the current payment cycle, as follows:
|
|
1889
|
-
* + If the order is canceled and `effectiveAt` is set to `IMMEDIATELY`, the webhook is triggered immediately when canceled.
|
|
1890
|
-
* + 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.
|
|
1940
|
+
* Triggered when an order is paused.
|
|
1891
1941
|
* @permissionScope Manage_Wix_Rentals_App_Forms_submissions
|
|
1892
1942
|
* @permissionScopeId SCOPE.RENTALS.MANAGE
|
|
1893
1943
|
* @permissionScope Manage Orders
|
|
@@ -1900,19 +1950,21 @@ interface OrderCanceledEnvelope {
|
|
|
1900
1950
|
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1901
1951
|
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
1902
1952
|
* @webhook
|
|
1903
|
-
* @eventType wix.pricing_plans.v2.
|
|
1953
|
+
* @eventType wix.pricing_plans.v2.order_paused
|
|
1904
1954
|
* @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
|
|
1905
|
-
* @slug
|
|
1955
|
+
* @slug paused
|
|
1906
1956
|
*/
|
|
1907
|
-
declare function
|
|
1908
|
-
interface
|
|
1909
|
-
data:
|
|
1957
|
+
declare function onOrderPaused(handler: (event: OrderPausedEnvelope) => void | Promise<void>): void;
|
|
1958
|
+
interface OrderPurchasedEnvelope {
|
|
1959
|
+
data: OrderPurchased;
|
|
1910
1960
|
metadata: EventMetadata;
|
|
1911
1961
|
}
|
|
1912
1962
|
/**
|
|
1913
|
-
* Triggered
|
|
1914
|
-
*
|
|
1915
|
-
*
|
|
1963
|
+
* Triggered for any of the following purchase events:
|
|
1964
|
+
* + Order is paid in full.
|
|
1965
|
+
* + At least 1 order cycle payment is paid for.
|
|
1966
|
+
* + Offline order is created, even if not yet marked as paid.
|
|
1967
|
+
* + Free order is created.
|
|
1916
1968
|
* @permissionScope Manage_Wix_Rentals_App_Forms_submissions
|
|
1917
1969
|
* @permissionScopeId SCOPE.RENTALS.MANAGE
|
|
1918
1970
|
* @permissionScope Manage Orders
|
|
@@ -1925,17 +1977,17 @@ interface OrderCycleStartedEnvelope {
|
|
|
1925
1977
|
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1926
1978
|
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
1927
1979
|
* @webhook
|
|
1928
|
-
* @eventType wix.pricing_plans.v2.
|
|
1980
|
+
* @eventType wix.pricing_plans.v2.order_purchased
|
|
1929
1981
|
* @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
|
|
1930
|
-
* @slug
|
|
1982
|
+
* @slug purchased
|
|
1931
1983
|
*/
|
|
1932
|
-
declare function
|
|
1933
|
-
interface
|
|
1934
|
-
data:
|
|
1984
|
+
declare function onOrderPurchased(handler: (event: OrderPurchasedEnvelope) => void | Promise<void>): void;
|
|
1985
|
+
interface OrderResumedEnvelope {
|
|
1986
|
+
data: OrderResumed;
|
|
1935
1987
|
metadata: EventMetadata;
|
|
1936
1988
|
}
|
|
1937
1989
|
/**
|
|
1938
|
-
* Triggered when
|
|
1990
|
+
* Triggered when a paused order is resumed.
|
|
1939
1991
|
* @permissionScope Manage_Wix_Rentals_App_Forms_submissions
|
|
1940
1992
|
* @permissionScopeId SCOPE.RENTALS.MANAGE
|
|
1941
1993
|
* @permissionScope Manage Orders
|
|
@@ -1948,21 +2000,17 @@ interface OrderEndDatePostponedEnvelope {
|
|
|
1948
2000
|
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1949
2001
|
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
1950
2002
|
* @webhook
|
|
1951
|
-
* @eventType wix.pricing_plans.v2.
|
|
2003
|
+
* @eventType wix.pricing_plans.v2.order_resumed
|
|
1952
2004
|
* @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
|
|
1953
|
-
* @slug
|
|
2005
|
+
* @slug resumed
|
|
1954
2006
|
*/
|
|
1955
|
-
declare function
|
|
1956
|
-
interface
|
|
1957
|
-
data:
|
|
2007
|
+
declare function onOrderResumed(handler: (event: OrderResumedEnvelope) => void | Promise<void>): void;
|
|
2008
|
+
interface OrderStartedEnvelope {
|
|
2009
|
+
data: OrderStarted;
|
|
1958
2010
|
metadata: EventMetadata;
|
|
1959
2011
|
}
|
|
1960
2012
|
/**
|
|
1961
|
-
* Triggered when an order
|
|
1962
|
-
*
|
|
1963
|
-
* This webhook is triggered:
|
|
1964
|
-
* + When an order expires at the end of the current payment cycle.
|
|
1965
|
-
* + When an order is canceled and `effectiveAt` is set to `IMMEDIATELY`.
|
|
2013
|
+
* Triggered when an order reaches its `startDate`. Applies to both purchased and free orders.
|
|
1966
2014
|
* @permissionScope Manage_Wix_Rentals_App_Forms_submissions
|
|
1967
2015
|
* @permissionScopeId SCOPE.RENTALS.MANAGE
|
|
1968
2016
|
* @permissionScope Manage Orders
|
|
@@ -1975,17 +2023,25 @@ interface OrderEndedEnvelope {
|
|
|
1975
2023
|
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1976
2024
|
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
1977
2025
|
* @webhook
|
|
1978
|
-
* @eventType wix.pricing_plans.v2.
|
|
2026
|
+
* @eventType wix.pricing_plans.v2.order_started
|
|
1979
2027
|
* @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
|
|
1980
|
-
* @slug
|
|
2028
|
+
* @slug started
|
|
1981
2029
|
*/
|
|
1982
|
-
declare function
|
|
1983
|
-
interface
|
|
1984
|
-
|
|
2030
|
+
declare function onOrderStarted(handler: (event: OrderStartedEnvelope) => void | Promise<void>): void;
|
|
2031
|
+
interface OrderUpdatedEnvelope {
|
|
2032
|
+
entity: Order;
|
|
1985
2033
|
metadata: EventMetadata;
|
|
1986
2034
|
}
|
|
1987
2035
|
/**
|
|
1988
|
-
* Triggered
|
|
2036
|
+
* Triggered for any of the following update events:
|
|
2037
|
+
*
|
|
2038
|
+
* + Order is paid for. Order Purchased is also triggered.
|
|
2039
|
+
* + Order reaches its start date or end date. Order Started and Order Ended, respectively, are also triggered.
|
|
2040
|
+
* + New payment cycle of an order starts. Order Cycle Started is also triggered.
|
|
2041
|
+
* + Offline order is marked as paid. Order Marked As Paid is also triggered.
|
|
2042
|
+
* + End date of the order is postponed. Order End Date Postponed is also triggered
|
|
2043
|
+
* + Order is paused, or a paused order is resumed. Order Paused and Order Resumed, respectively, are also triggered.
|
|
2044
|
+
* + Order is canceled, either immediately or at the end of the payment cycle. Order Canceled and Order Auto Renew Canceled, respectively, are also triggered.
|
|
1989
2045
|
* @permissionScope Manage_Wix_Rentals_App_Forms_submissions
|
|
1990
2046
|
* @permissionScopeId SCOPE.RENTALS.MANAGE
|
|
1991
2047
|
* @permissionScope Manage Orders
|
|
@@ -1998,17 +2054,17 @@ interface OrderMarkedAsPaidEnvelope {
|
|
|
1998
2054
|
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1999
2055
|
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
2000
2056
|
* @webhook
|
|
2001
|
-
* @eventType wix.pricing_plans.v2.
|
|
2057
|
+
* @eventType wix.pricing_plans.v2.order_updated
|
|
2002
2058
|
* @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
|
|
2003
|
-
* @slug
|
|
2059
|
+
* @slug updated
|
|
2004
2060
|
*/
|
|
2005
|
-
declare function
|
|
2006
|
-
interface
|
|
2007
|
-
|
|
2061
|
+
declare function onOrderUpdated(handler: (event: OrderUpdatedEnvelope) => void | Promise<void>): void;
|
|
2062
|
+
interface OrderCreatedEnvelope {
|
|
2063
|
+
entity: Order;
|
|
2008
2064
|
metadata: EventMetadata;
|
|
2009
2065
|
}
|
|
2010
2066
|
/**
|
|
2011
|
-
* Triggered when an order is
|
|
2067
|
+
* Triggered when an order is created.
|
|
2012
2068
|
* @permissionScope Manage_Wix_Rentals_App_Forms_submissions
|
|
2013
2069
|
* @permissionScopeId SCOPE.RENTALS.MANAGE
|
|
2014
2070
|
* @permissionScope Manage Orders
|
|
@@ -2021,21 +2077,17 @@ interface OrderPausedEnvelope {
|
|
|
2021
2077
|
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
2022
2078
|
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
2023
2079
|
* @webhook
|
|
2024
|
-
* @eventType wix.pricing_plans.v2.
|
|
2025
|
-
* @serviceIdentifier com.wixpress.membership.v2.orders.
|
|
2026
|
-
* @slug
|
|
2080
|
+
* @eventType wix.pricing_plans.v2.order_created
|
|
2081
|
+
* @serviceIdentifier com.wixpress.membership.v2.orders.CheckoutService
|
|
2082
|
+
* @slug created
|
|
2027
2083
|
*/
|
|
2028
|
-
declare function
|
|
2029
|
-
interface
|
|
2030
|
-
data:
|
|
2084
|
+
declare function onOrderCreated(handler: (event: OrderCreatedEnvelope) => void | Promise<void>): void;
|
|
2085
|
+
interface OrderStartDateChangedEnvelope {
|
|
2086
|
+
data: OrderStartDateChanged;
|
|
2031
2087
|
metadata: EventMetadata;
|
|
2032
2088
|
}
|
|
2033
2089
|
/**
|
|
2034
|
-
* Triggered
|
|
2035
|
-
* + Order is paid in full.
|
|
2036
|
-
* + At least 1 order cycle payment is paid for.
|
|
2037
|
-
* + Offline order is created, even if not yet marked as paid.
|
|
2038
|
-
* + Free order is created.
|
|
2090
|
+
* Triggered when an order's `startDate` is changed.
|
|
2039
2091
|
* @permissionScope Manage_Wix_Rentals_App_Forms_submissions
|
|
2040
2092
|
* @permissionScopeId SCOPE.RENTALS.MANAGE
|
|
2041
2093
|
* @permissionScope Manage Orders
|
|
@@ -2048,57 +2100,185 @@ interface OrderPurchasedEnvelope {
|
|
|
2048
2100
|
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
2049
2101
|
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
2050
2102
|
* @webhook
|
|
2051
|
-
* @eventType wix.pricing_plans.v2.
|
|
2052
|
-
* @serviceIdentifier com.wixpress.membership.v2.orders.
|
|
2053
|
-
* @slug
|
|
2103
|
+
* @eventType wix.pricing_plans.v2.order_start_date_changed
|
|
2104
|
+
* @serviceIdentifier com.wixpress.membership.v2.orders.CheckoutService
|
|
2105
|
+
* @slug start_date_changed
|
|
2106
|
+
*/
|
|
2107
|
+
declare function onOrderStartDateChanged(handler: (event: OrderStartDateChangedEnvelope) => void | Promise<void>): void;
|
|
2108
|
+
/**
|
|
2109
|
+
* Retrieves an order by ID.
|
|
2110
|
+
* @param _id - Order ID.
|
|
2111
|
+
* @public
|
|
2112
|
+
* @requiredField _id
|
|
2113
|
+
* @param options - Options to use when getting an order.
|
|
2114
|
+
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
2115
|
+
* @applicableIdentity APP
|
|
2116
|
+
* @fqn com.wixpress.membership.v2.orders.OrderManagementService.GetOrder
|
|
2117
|
+
*/
|
|
2118
|
+
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>>;
|
|
2119
|
+
interface ManagementGetOrderOptions {
|
|
2120
|
+
/**
|
|
2121
|
+
* Predefined set of fields to return.
|
|
2122
|
+
*
|
|
2123
|
+
* Default: If `fieldSet` is omitted, no order form submission data is returned.
|
|
2124
|
+
*/
|
|
2125
|
+
fieldSet?: SetWithLiterals;
|
|
2126
|
+
}
|
|
2127
|
+
/**
|
|
2128
|
+
* Retrieves a list of up to 50 pricing plan orders and details, given the specified sorting and filtering.
|
|
2129
|
+
*
|
|
2130
|
+
* By default, this endpoint will retrieve all orders and return them sorted by `createdDate` in `DESC`, descending order.
|
|
2131
|
+
* `sort.fieldName` supports `endDate` and `createdDate` fields and defaults to `ASC`, ascending order.
|
|
2132
|
+
* @public
|
|
2133
|
+
* @param options - Filtering, sorting, and pagination options.
|
|
2134
|
+
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
2135
|
+
* @applicableIdentity APP
|
|
2136
|
+
* @fqn com.wixpress.membership.v2.orders.OrderManagementService.ListOrders
|
|
2137
|
+
*/
|
|
2138
|
+
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>>;
|
|
2139
|
+
interface ManagementListOrdersOptions {
|
|
2140
|
+
/**
|
|
2141
|
+
* Filter by a buyer's member ID, from the Members API.
|
|
2142
|
+
* @format GUID
|
|
2143
|
+
*/
|
|
2144
|
+
buyerIds?: string[];
|
|
2145
|
+
/**
|
|
2146
|
+
* Filter by plan IDs, from the Plans API.
|
|
2147
|
+
* @format GUID
|
|
2148
|
+
*/
|
|
2149
|
+
planIds?: string[];
|
|
2150
|
+
/** Filter by whether or not the auto-renewal of recurring orders was canceled. */
|
|
2151
|
+
autoRenewCanceled?: boolean | null;
|
|
2152
|
+
/** Filter by order status. */
|
|
2153
|
+
orderStatuses?: OrderStatusWithLiterals[];
|
|
2154
|
+
/** Filter by payment status. */
|
|
2155
|
+
paymentStatuses?: PaymentStatusWithLiterals[];
|
|
2156
|
+
/**
|
|
2157
|
+
* Number of orders to return. See Sorting and Paging for more information.
|
|
2158
|
+
*
|
|
2159
|
+
* Max: `50`
|
|
2160
|
+
* @min 1
|
|
2161
|
+
* @max 50
|
|
2162
|
+
*/
|
|
2163
|
+
limit?: number | null;
|
|
2164
|
+
/** Number of orders to skip in the current sort order. */
|
|
2165
|
+
offset?: number | null;
|
|
2166
|
+
/**
|
|
2167
|
+
* Sort order.
|
|
2168
|
+
*
|
|
2169
|
+
* Use `ASC` for ascending order or `DESC` for descending order.
|
|
2170
|
+
*
|
|
2171
|
+
* Default: `DESC`.
|
|
2172
|
+
*/
|
|
2173
|
+
sorting?: Sorting;
|
|
2174
|
+
/**
|
|
2175
|
+
* Predefined set of fields to return.
|
|
2176
|
+
*
|
|
2177
|
+
* Default: If `fieldSet` is omitted, no order form submission data is returned.
|
|
2178
|
+
*/
|
|
2179
|
+
fieldSet?: SetWithLiterals;
|
|
2180
|
+
}
|
|
2181
|
+
/**
|
|
2182
|
+
* 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.
|
|
2183
|
+
*
|
|
2184
|
+
* New `endDate` must be later than the order's current `endDate`. Can't postpone orders that are unlimited.
|
|
2185
|
+
* Can't postpone an order with `status`: `PAUSED`.
|
|
2186
|
+
* @param _id - Order ID.
|
|
2187
|
+
* @param endDate - New end date and time.
|
|
2188
|
+
*
|
|
2189
|
+
* Must be later than the current end date and time.
|
|
2190
|
+
* @public
|
|
2191
|
+
* @requiredField _id
|
|
2192
|
+
* @requiredField endDate
|
|
2193
|
+
* @param options - Options for postponing the end date of an order.
|
|
2194
|
+
* @permissionId PRICING_PLANS.MANAGE_ORDERS
|
|
2195
|
+
* @applicableIdentity APP
|
|
2196
|
+
* @fqn com.wixpress.membership.v2.orders.OrderManagementService.PostponeEndDate
|
|
2197
|
+
*/
|
|
2198
|
+
declare function postponeEndDate(_id: string, endDate: Date): Promise<void>;
|
|
2199
|
+
/**
|
|
2200
|
+
* Cancels an existing order.
|
|
2201
|
+
*
|
|
2202
|
+
* For orders with recurring payments, a cancellation can be set to occur either `IMMEDIATELY` or at the `NEXT_PAYMENT_DATE`.
|
|
2203
|
+
* For orders with one-time payments, a cancellation can only be set for `IMMEDIATELY`.
|
|
2204
|
+
*
|
|
2205
|
+
* #### Canceling during the free trial period.
|
|
2206
|
+
*
|
|
2207
|
+
* When a buyer cancels their order during the free trial period, the buyer's subscription expires at the end
|
|
2208
|
+
* of the free trial period and they will not be billed. The buyer may continue using the benefits until the end
|
|
2209
|
+
* of the free trial period.
|
|
2210
|
+
*
|
|
2211
|
+
* When a Wix user cancels an ordered plan during the free trial period, they choose whether to apply the cancellation
|
|
2212
|
+
* `IMMEDIATELY` or at the `NEXT_PAYMENT_DATE`. Canceling `IMMEDIATELY` will end the subscription for the buyer
|
|
2213
|
+
* immediately, even during the free trial period and the buyer won't be billed. Canceling at the
|
|
2214
|
+
* `NEXT_PAYMENT_DATE` allows the buyer to continue using the benefits of the subscription until the end of the free trial period.
|
|
2215
|
+
* Then, the subscription ends and the buyer is not billed.
|
|
2216
|
+
* @param _id - Order ID.
|
|
2217
|
+
* @param effectiveAt - __Required.__ When the order will be canceled. One-time orders can only be canceled `IMMEDIATELY`.
|
|
2218
|
+
* @public
|
|
2219
|
+
* @requiredField _id
|
|
2220
|
+
* @requiredField effectiveAt
|
|
2221
|
+
* @param options - Options for canceling orders.
|
|
2222
|
+
* @permissionId PRICING_PLANS.MANAGE_ORDERS
|
|
2223
|
+
* @applicableIdentity APP
|
|
2224
|
+
* @fqn com.wixpress.membership.v2.orders.OrderManagementService.CancelOrder
|
|
2225
|
+
*/
|
|
2226
|
+
declare function cancelOrder(_id: string, effectiveAt: CancellationEffectiveAtWithLiterals): Promise<void>;
|
|
2227
|
+
/**
|
|
2228
|
+
* Marks an offline order as paid.
|
|
2229
|
+
* > __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.
|
|
2230
|
+
*
|
|
2231
|
+
* Marking an offline order as paid causes the following changes:
|
|
2232
|
+
* - The order's `lastPaymentStatus` changes to `"PAID"`.
|
|
2233
|
+
* - The order's status changes to either `"PENDING"` or `"ACTIVE"`, depending on the order's `startDate`.
|
|
2234
|
+
*
|
|
2235
|
+
* An error occurs if you attempt to:
|
|
2236
|
+
* - Mark an already-paid, offline order as paid. You cannot mark an offline order as paid twice.
|
|
2237
|
+
* - Mark an online order as paid. The Mark as Paid method is supported for offline orders only.
|
|
2238
|
+
* @param _id - Order ID.
|
|
2239
|
+
* @public
|
|
2240
|
+
* @requiredField _id
|
|
2241
|
+
* @permissionId PRICING_PLANS.MANAGE_ORDERS
|
|
2242
|
+
* @applicableIdentity APP
|
|
2243
|
+
* @fqn com.wixpress.membership.v2.orders.OrderManagementService.MarkAsPaid
|
|
2054
2244
|
*/
|
|
2055
|
-
declare function
|
|
2056
|
-
interface OrderResumedEnvelope {
|
|
2057
|
-
data: OrderResumed;
|
|
2058
|
-
metadata: EventMetadata;
|
|
2059
|
-
}
|
|
2245
|
+
declare function markAsPaid(_id: string): Promise<void>;
|
|
2060
2246
|
/**
|
|
2061
|
-
*
|
|
2062
|
-
*
|
|
2063
|
-
*
|
|
2064
|
-
*
|
|
2065
|
-
*
|
|
2066
|
-
*
|
|
2067
|
-
*
|
|
2068
|
-
*
|
|
2069
|
-
* @
|
|
2070
|
-
* @
|
|
2071
|
-
* @
|
|
2072
|
-
* @permissionId PRICING_PLANS.
|
|
2073
|
-
* @
|
|
2074
|
-
* @
|
|
2075
|
-
* @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
|
|
2076
|
-
* @slug resumed
|
|
2247
|
+
* Pauses an order. Calling this method changes the order status to `"PAUSED"` and updates the `pausePeriods` array.
|
|
2248
|
+
*
|
|
2249
|
+
* Only orders with `status`: `ACTIVE` can be paused.
|
|
2250
|
+
* For orders with recurring payments, it also pauses the payment schedule. Buyers are not charged when an order is paused.
|
|
2251
|
+
* Pausing an order affects the end date of the order by adding the time the order is paused to the `endDate`.
|
|
2252
|
+
* The `endDate` and the `earliestEndDate` for the order are adjusted to include the pause period when the order is resumed.
|
|
2253
|
+
*
|
|
2254
|
+
* To resume a paused order, call Resume Order.
|
|
2255
|
+
* @param _id - Order ID.
|
|
2256
|
+
* @public
|
|
2257
|
+
* @requiredField _id
|
|
2258
|
+
* @permissionId PRICING_PLANS.MANAGE_ORDERS
|
|
2259
|
+
* @applicableIdentity APP
|
|
2260
|
+
* @fqn com.wixpress.membership.v2.orders.OrderManagementService.PauseOrder
|
|
2077
2261
|
*/
|
|
2078
|
-
declare function
|
|
2079
|
-
interface OrderStartedEnvelope {
|
|
2080
|
-
data: OrderStarted;
|
|
2081
|
-
metadata: EventMetadata;
|
|
2082
|
-
}
|
|
2262
|
+
declare function pauseOrder(_id: string): Promise<void>;
|
|
2083
2263
|
/**
|
|
2084
|
-
*
|
|
2085
|
-
*
|
|
2086
|
-
*
|
|
2087
|
-
*
|
|
2088
|
-
*
|
|
2089
|
-
*
|
|
2090
|
-
*
|
|
2091
|
-
*
|
|
2092
|
-
*
|
|
2093
|
-
*
|
|
2094
|
-
* @
|
|
2095
|
-
* @
|
|
2096
|
-
* @
|
|
2097
|
-
* @
|
|
2098
|
-
* @
|
|
2099
|
-
* @
|
|
2264
|
+
* Resumes a paused order. For orders with recurring payments, it also restarts the payment schedule.
|
|
2265
|
+
*
|
|
2266
|
+
* Resuming an order causes the following changes:
|
|
2267
|
+
* - The order status changes to `"ACTIVE"`.
|
|
2268
|
+
* - The `pausePeriods` array is updated.
|
|
2269
|
+
* - The `endDate` for the order is adjusted to include the pause period.
|
|
2270
|
+
* - For orders with recurring payments, the payment schedule is restarted.
|
|
2271
|
+
* - The `earliestEndDate` is adjusted to include the pause period. (This property is reserved for future use).
|
|
2272
|
+
*
|
|
2273
|
+
* To pause an order, call Pause Order.
|
|
2274
|
+
* @param _id - Order ID.
|
|
2275
|
+
* @public
|
|
2276
|
+
* @requiredField _id
|
|
2277
|
+
* @permissionId PRICING_PLANS.MANAGE_ORDERS
|
|
2278
|
+
* @applicableIdentity APP
|
|
2279
|
+
* @fqn com.wixpress.membership.v2.orders.OrderManagementService.ResumeOrder
|
|
2100
2280
|
*/
|
|
2101
|
-
declare function
|
|
2281
|
+
declare function resumeOrder(_id: string): Promise<void>;
|
|
2102
2282
|
/**
|
|
2103
2283
|
* Creates an online order for a site member.
|
|
2104
2284
|
*
|
|
@@ -2132,6 +2312,9 @@ interface CreateOnlineOrderOptions {
|
|
|
2132
2312
|
onBehalf?: OnBehalf;
|
|
2133
2313
|
/**
|
|
2134
2314
|
* Submission ID of the form submitted with this order.
|
|
2315
|
+
*
|
|
2316
|
+
* The submission must belong to the form attached to the plan, and that form must belong to the Pricing Plans namespace.
|
|
2317
|
+
* An invalid submission ID is dropped and the order is created without a submission.
|
|
2135
2318
|
* @format GUID
|
|
2136
2319
|
*/
|
|
2137
2320
|
submissionId?: string | null;
|
|
@@ -2189,6 +2372,9 @@ interface CreateOfflineOrderOptions {
|
|
|
2189
2372
|
couponCode?: string | null;
|
|
2190
2373
|
/**
|
|
2191
2374
|
* Form submission ID that was submitted with the order.
|
|
2375
|
+
*
|
|
2376
|
+
* The submission must belong to the form attached to the plan, and that form must belong to the Pricing Plans namespace.
|
|
2377
|
+
* An invalid submission ID is dropped and the order is created without a submission.
|
|
2192
2378
|
* @format GUID
|
|
2193
2379
|
*/
|
|
2194
2380
|
submissionId?: string | null;
|
|
@@ -2293,180 +2479,6 @@ interface GetPricePreviewOptions {
|
|
|
2293
2479
|
*/
|
|
2294
2480
|
couponCode?: string | null;
|
|
2295
2481
|
}
|
|
2296
|
-
/**
|
|
2297
|
-
* Retrieves an order by ID.
|
|
2298
|
-
* @param _id - Order ID.
|
|
2299
|
-
* @public
|
|
2300
|
-
* @requiredField _id
|
|
2301
|
-
* @param options - Options to use when getting an order.
|
|
2302
|
-
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
2303
|
-
* @applicableIdentity APP
|
|
2304
|
-
* @fqn com.wixpress.membership.v2.orders.OrderManagementService.GetOrder
|
|
2305
|
-
*/
|
|
2306
|
-
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>>;
|
|
2307
|
-
interface ManagementGetOrderOptions {
|
|
2308
|
-
/**
|
|
2309
|
-
* Predefined set of fields to return.
|
|
2310
|
-
*
|
|
2311
|
-
* Default: If `fieldSet` is omitted, no order form submission data is returned.
|
|
2312
|
-
*/
|
|
2313
|
-
fieldSet?: SetWithLiterals;
|
|
2314
|
-
}
|
|
2315
|
-
/**
|
|
2316
|
-
* Retrieves a list of up to 50 pricing plan orders and details, given the specified sorting and filtering.
|
|
2317
|
-
*
|
|
2318
|
-
* By default, this endpoint will retrieve all orders and return them sorted by `createdDate` in `DESC`, descending order.
|
|
2319
|
-
* `sort.fieldName` supports `endDate` and `createdDate` fields and defaults to `ASC`, ascending order.
|
|
2320
|
-
* @public
|
|
2321
|
-
* @param options - Filtering, sorting, and pagination options.
|
|
2322
|
-
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
2323
|
-
* @applicableIdentity APP
|
|
2324
|
-
* @fqn com.wixpress.membership.v2.orders.OrderManagementService.ListOrders
|
|
2325
|
-
*/
|
|
2326
|
-
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>>;
|
|
2327
|
-
interface ManagementListOrdersOptions {
|
|
2328
|
-
/**
|
|
2329
|
-
* Filter by a buyer's member ID, from the Members API.
|
|
2330
|
-
* @format GUID
|
|
2331
|
-
*/
|
|
2332
|
-
buyerIds?: string[];
|
|
2333
|
-
/**
|
|
2334
|
-
* Filter by plan IDs, from the Plans API.
|
|
2335
|
-
* @format GUID
|
|
2336
|
-
*/
|
|
2337
|
-
planIds?: string[];
|
|
2338
|
-
/** Filter by whether or not the auto-renewal of recurring orders was canceled. */
|
|
2339
|
-
autoRenewCanceled?: boolean | null;
|
|
2340
|
-
/** Filter by order status. */
|
|
2341
|
-
orderStatuses?: OrderStatusWithLiterals[];
|
|
2342
|
-
/** Filter by payment status. */
|
|
2343
|
-
paymentStatuses?: PaymentStatusWithLiterals[];
|
|
2344
|
-
/**
|
|
2345
|
-
* Number of orders to return. See Sorting and Paging for more information.
|
|
2346
|
-
*
|
|
2347
|
-
* Max: `50`
|
|
2348
|
-
* @min 1
|
|
2349
|
-
* @max 50
|
|
2350
|
-
*/
|
|
2351
|
-
limit?: number | null;
|
|
2352
|
-
/** Number of orders to skip in the current sort order. */
|
|
2353
|
-
offset?: number | null;
|
|
2354
|
-
/**
|
|
2355
|
-
* Sort order.
|
|
2356
|
-
*
|
|
2357
|
-
* Use `ASC` for ascending order or `DESC` for descending order.
|
|
2358
|
-
*
|
|
2359
|
-
* Default: `DESC`.
|
|
2360
|
-
*/
|
|
2361
|
-
sorting?: Sorting;
|
|
2362
|
-
/**
|
|
2363
|
-
* Predefined set of fields to return.
|
|
2364
|
-
*
|
|
2365
|
-
* Default: If `fieldSet` is omitted, no order form submission data is returned.
|
|
2366
|
-
*/
|
|
2367
|
-
fieldSet?: SetWithLiterals;
|
|
2368
|
-
}
|
|
2369
|
-
/**
|
|
2370
|
-
* 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.
|
|
2371
|
-
*
|
|
2372
|
-
* New `endDate` must be later than the order's current `endDate`. Can't postpone orders that are unlimited.
|
|
2373
|
-
* Can't postpone an order with `status`: `PAUSED`.
|
|
2374
|
-
* @param _id - Order ID.
|
|
2375
|
-
* @param endDate - New end date and time.
|
|
2376
|
-
*
|
|
2377
|
-
* Must be later than the current end date and time.
|
|
2378
|
-
* @public
|
|
2379
|
-
* @requiredField _id
|
|
2380
|
-
* @requiredField endDate
|
|
2381
|
-
* @param options - Options for postponing the end date of an order.
|
|
2382
|
-
* @permissionId PRICING_PLANS.MANAGE_ORDERS
|
|
2383
|
-
* @applicableIdentity APP
|
|
2384
|
-
* @fqn com.wixpress.membership.v2.orders.OrderManagementService.PostponeEndDate
|
|
2385
|
-
*/
|
|
2386
|
-
declare function postponeEndDate(_id: string, endDate: Date): Promise<void>;
|
|
2387
|
-
/**
|
|
2388
|
-
* Cancels an existing order.
|
|
2389
|
-
*
|
|
2390
|
-
* For orders with recurring payments, a cancellation can be set to occur either `IMMEDIATELY` or at the `NEXT_PAYMENT_DATE`.
|
|
2391
|
-
* For orders with one-time payments, a cancellation can only be set for `IMMEDIATELY`.
|
|
2392
|
-
*
|
|
2393
|
-
* #### Canceling during the free trial period.
|
|
2394
|
-
*
|
|
2395
|
-
* When a buyer cancels their order during the free trial period, the buyer's subscription expires at the end
|
|
2396
|
-
* of the free trial period and they will not be billed. The buyer may continue using the benefits until the end
|
|
2397
|
-
* of the free trial period.
|
|
2398
|
-
*
|
|
2399
|
-
* When a Wix user cancels an ordered plan during the free trial period, they choose whether to apply the cancellation
|
|
2400
|
-
* `IMMEDIATELY` or at the `NEXT_PAYMENT_DATE`. Canceling `IMMEDIATELY` will end the subscription for the buyer
|
|
2401
|
-
* immediately, even during the free trial period and the buyer won't be billed. Canceling at the
|
|
2402
|
-
* `NEXT_PAYMENT_DATE` allows the buyer to continue using the benefits of the subscription until the end of the free trial period.
|
|
2403
|
-
* Then, the subscription ends and the buyer is not billed.
|
|
2404
|
-
* @param _id - Order ID.
|
|
2405
|
-
* @param effectiveAt - __Required.__ When the order will be canceled. One-time orders can only be canceled `IMMEDIATELY`.
|
|
2406
|
-
* @public
|
|
2407
|
-
* @requiredField _id
|
|
2408
|
-
* @requiredField effectiveAt
|
|
2409
|
-
* @param options - Options for canceling orders.
|
|
2410
|
-
* @permissionId PRICING_PLANS.MANAGE_ORDERS
|
|
2411
|
-
* @applicableIdentity APP
|
|
2412
|
-
* @fqn com.wixpress.membership.v2.orders.OrderManagementService.CancelOrder
|
|
2413
|
-
*/
|
|
2414
|
-
declare function cancelOrder(_id: string, effectiveAt: CancellationEffectiveAtWithLiterals): Promise<void>;
|
|
2415
|
-
/**
|
|
2416
|
-
* Marks an offline order as paid.
|
|
2417
|
-
* > __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.
|
|
2418
|
-
*
|
|
2419
|
-
* Marking an offline order as paid causes the following changes:
|
|
2420
|
-
* - The order's `lastPaymentStatus` changes to `"PAID"`.
|
|
2421
|
-
* - The order's status changes to either `"PENDING"` or `"ACTIVE"`, depending on the order's `startDate`.
|
|
2422
|
-
*
|
|
2423
|
-
* An error occurs if you attempt to:
|
|
2424
|
-
* - Mark an already-paid, offline order as paid. You cannot mark an offline order as paid twice.
|
|
2425
|
-
* - Mark an online order as paid. The Mark as Paid method is supported for offline orders only.
|
|
2426
|
-
* @param _id - Order ID.
|
|
2427
|
-
* @public
|
|
2428
|
-
* @requiredField _id
|
|
2429
|
-
* @permissionId PRICING_PLANS.MANAGE_ORDERS
|
|
2430
|
-
* @applicableIdentity APP
|
|
2431
|
-
* @fqn com.wixpress.membership.v2.orders.OrderManagementService.MarkAsPaid
|
|
2432
|
-
*/
|
|
2433
|
-
declare function markAsPaid(_id: string): Promise<void>;
|
|
2434
|
-
/**
|
|
2435
|
-
* Pauses an order. Calling this method changes the order status to `"PAUSED"` and updates the `pausePeriods` array.
|
|
2436
|
-
*
|
|
2437
|
-
* Only orders with `status`: `ACTIVE` can be paused.
|
|
2438
|
-
* For orders with recurring payments, it also pauses the payment schedule. Buyers are not charged when an order is paused.
|
|
2439
|
-
* Pausing an order affects the end date of the order by adding the time the order is paused to the `endDate`.
|
|
2440
|
-
* The `endDate` and the `earliestEndDate` for the order are adjusted to include the pause period when the order is resumed.
|
|
2441
|
-
*
|
|
2442
|
-
* To resume a paused order, call Resume Order.
|
|
2443
|
-
* @param _id - Order ID.
|
|
2444
|
-
* @public
|
|
2445
|
-
* @requiredField _id
|
|
2446
|
-
* @permissionId PRICING_PLANS.MANAGE_ORDERS
|
|
2447
|
-
* @applicableIdentity APP
|
|
2448
|
-
* @fqn com.wixpress.membership.v2.orders.OrderManagementService.PauseOrder
|
|
2449
|
-
*/
|
|
2450
|
-
declare function pauseOrder(_id: string): Promise<void>;
|
|
2451
|
-
/**
|
|
2452
|
-
* Resumes a paused order. For orders with recurring payments, it also restarts the payment schedule.
|
|
2453
|
-
*
|
|
2454
|
-
* Resuming an order causes the following changes:
|
|
2455
|
-
* - The order status changes to `"ACTIVE"`.
|
|
2456
|
-
* - The `pausePeriods` array is updated.
|
|
2457
|
-
* - The `endDate` for the order is adjusted to include the pause period.
|
|
2458
|
-
* - For orders with recurring payments, the payment schedule is restarted.
|
|
2459
|
-
* - The `earliestEndDate` is adjusted to include the pause period. (This property is reserved for future use).
|
|
2460
|
-
*
|
|
2461
|
-
* To pause an order, call Pause Order.
|
|
2462
|
-
* @param _id - Order ID.
|
|
2463
|
-
* @public
|
|
2464
|
-
* @requiredField _id
|
|
2465
|
-
* @permissionId PRICING_PLANS.MANAGE_ORDERS
|
|
2466
|
-
* @applicableIdentity APP
|
|
2467
|
-
* @fqn com.wixpress.membership.v2.orders.OrderManagementService.ResumeOrder
|
|
2468
|
-
*/
|
|
2469
|
-
declare function resumeOrder(_id: string): Promise<void>;
|
|
2470
2482
|
/**
|
|
2471
2483
|
* Retrieves an order for the currently logged-in member by ID.
|
|
2472
2484
|
* @param _id - Order ID.
|