@wix/auto_sdk_pricing-plans_orders 1.0.124 → 1.0.125
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 +629 -629
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +787 -787
- package/build/cjs/index.typings.js +502 -502
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +484 -484
- package/build/cjs/meta.js +388 -388
- package/build/cjs/meta.js.map +1 -1
- package/build/cjs/schemas.d.ts +199 -199
- package/build/cjs/schemas.js +889 -889
- package/build/cjs/schemas.js.map +1 -1
- package/build/es/index.d.mts +129 -129
- package/build/es/index.mjs +629 -629
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +787 -787
- package/build/es/index.typings.mjs +502 -502
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +484 -484
- package/build/es/meta.mjs +388 -388
- package/build/es/meta.mjs.map +1 -1
- package/build/es/schemas.d.mts +199 -199
- package/build/es/schemas.mjs +889 -889
- package/build/es/schemas.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +129 -129
- package/build/internal/cjs/index.typings.d.ts +813 -813
- package/build/internal/cjs/meta.d.ts +500 -500
- package/build/internal/cjs/schemas.d.ts +199 -199
- package/build/internal/es/index.d.mts +129 -129
- package/build/internal/es/index.typings.d.mts +813 -813
- package/build/internal/es/meta.d.mts +500 -500
- package/build/internal/es/schemas.d.mts +199 -199
- package/package.json +2 -2
|
@@ -626,345 +626,308 @@ interface ActionEvent {
|
|
|
626
626
|
}
|
|
627
627
|
interface Empty {
|
|
628
628
|
}
|
|
629
|
-
interface
|
|
630
|
-
/**
|
|
631
|
-
|
|
632
|
-
|
|
633
|
-
|
|
634
|
-
|
|
635
|
-
|
|
629
|
+
interface CreateOnlineOrderRequest {
|
|
630
|
+
/**
|
|
631
|
+
* Plan ID.
|
|
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;
|
|
636
654
|
}
|
|
637
|
-
|
|
638
|
-
|
|
639
|
-
|
|
640
|
-
|
|
641
|
-
|
|
642
|
-
|
|
643
|
-
/**
|
|
644
|
-
|
|
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;
|
|
655
|
+
interface OnBehalf {
|
|
656
|
+
/**
|
|
657
|
+
* Member ID.
|
|
658
|
+
* @format GUID
|
|
659
|
+
*/
|
|
660
|
+
memberId?: string;
|
|
661
|
+
/** Method by which checkout is initiated. */
|
|
662
|
+
orderMethod?: OrderMethodWithLiterals;
|
|
647
663
|
}
|
|
648
|
-
|
|
649
|
-
|
|
650
|
-
/** Order that is canceled, effective at the end of the current payment cycle. */
|
|
664
|
+
interface CreateOnlineOrderResponse {
|
|
665
|
+
/** Created online order. */
|
|
651
666
|
order?: Order;
|
|
652
667
|
}
|
|
653
|
-
interface
|
|
654
|
-
/**
|
|
655
|
-
|
|
668
|
+
interface CouponsError {
|
|
669
|
+
/** Coupon code. */
|
|
670
|
+
couponCode?: string;
|
|
671
|
+
/** Plan ID. */
|
|
672
|
+
planId?: string;
|
|
656
673
|
}
|
|
657
|
-
interface
|
|
674
|
+
interface CreateGuestOnlineOrderRequest {
|
|
658
675
|
/**
|
|
659
|
-
*
|
|
676
|
+
* Plan ID.
|
|
660
677
|
* @format GUID
|
|
661
678
|
*/
|
|
662
|
-
|
|
679
|
+
planId?: string;
|
|
663
680
|
/**
|
|
664
|
-
*
|
|
681
|
+
* Start date for the ordered plan.
|
|
665
682
|
*
|
|
666
|
-
* Default:
|
|
683
|
+
* Default: Current date
|
|
667
684
|
*/
|
|
668
|
-
|
|
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
|
|
699
|
+
*/
|
|
700
|
+
submissionId?: string | null;
|
|
669
701
|
}
|
|
670
|
-
|
|
671
|
-
/**
|
|
672
|
-
|
|
673
|
-
/** Doesn't return any order form submission data. */
|
|
674
|
-
BASIC = "BASIC",
|
|
675
|
-
/** Returns all order form submission data. */
|
|
676
|
-
FULL = "FULL"
|
|
702
|
+
interface Captcha {
|
|
703
|
+
/** Token from captcha */
|
|
704
|
+
token?: string;
|
|
677
705
|
}
|
|
678
|
-
|
|
679
|
-
|
|
680
|
-
|
|
706
|
+
interface Guest {
|
|
707
|
+
/**
|
|
708
|
+
* Email for checkout
|
|
709
|
+
* @format EMAIL
|
|
710
|
+
*/
|
|
711
|
+
email?: string;
|
|
712
|
+
}
|
|
713
|
+
interface CreateGuestOnlineOrderResponse {
|
|
681
714
|
/** Order. */
|
|
682
715
|
order?: Order;
|
|
683
716
|
}
|
|
684
|
-
interface
|
|
717
|
+
interface CreateOfflineOrderRequest {
|
|
685
718
|
/**
|
|
686
|
-
*
|
|
719
|
+
* ID of the plan being ordered, from the Plans API.
|
|
687
720
|
* @format GUID
|
|
688
721
|
*/
|
|
689
|
-
|
|
722
|
+
planId: string;
|
|
690
723
|
/**
|
|
691
|
-
*
|
|
724
|
+
* ID of the member ordering the plan, from the Members API.
|
|
692
725
|
* @format GUID
|
|
693
726
|
*/
|
|
694
|
-
|
|
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[];
|
|
727
|
+
memberId: string;
|
|
701
728
|
/**
|
|
702
|
-
*
|
|
729
|
+
* Start date and time for the ordered plan in a `YYYY-MM-DDThh:mm[:ss][.sss]Z` format.
|
|
703
730
|
*
|
|
704
|
-
*
|
|
705
|
-
* @min 1
|
|
706
|
-
* @max 50
|
|
731
|
+
* Default: Current date and time.
|
|
707
732
|
*/
|
|
708
|
-
|
|
709
|
-
/** Number of orders to skip in the current sort order. */
|
|
710
|
-
offset?: number | null;
|
|
733
|
+
startDate?: Date | null;
|
|
711
734
|
/**
|
|
712
|
-
*
|
|
713
|
-
*
|
|
714
|
-
* Use `ASC` for ascending order or `DESC` for descending order.
|
|
735
|
+
* Whether the order is paid.
|
|
715
736
|
*
|
|
716
|
-
* Default: `
|
|
737
|
+
* Default: `false`
|
|
717
738
|
*/
|
|
718
|
-
|
|
739
|
+
paid?: boolean | null;
|
|
719
740
|
/**
|
|
720
|
-
*
|
|
721
|
-
*
|
|
722
|
-
*
|
|
741
|
+
* Coupon code to apply, from the Coupons API.
|
|
742
|
+
* @minLength 1
|
|
743
|
+
* @maxLength 20
|
|
723
744
|
*/
|
|
724
|
-
|
|
745
|
+
couponCode?: string | null;
|
|
746
|
+
/**
|
|
747
|
+
* Form submission ID that was submitted with the order.
|
|
748
|
+
* @format GUID
|
|
749
|
+
*/
|
|
750
|
+
submissionId?: string | null;
|
|
725
751
|
}
|
|
726
|
-
interface
|
|
752
|
+
interface CreateOfflineOrderResponse {
|
|
753
|
+
/** Order. */
|
|
754
|
+
order?: Order;
|
|
755
|
+
}
|
|
756
|
+
interface CreateExternalOrderRequest {
|
|
727
757
|
/**
|
|
728
|
-
*
|
|
729
|
-
* @
|
|
758
|
+
* Plan ID.
|
|
759
|
+
* @format GUID
|
|
730
760
|
*/
|
|
731
|
-
|
|
732
|
-
/** Sort order. */
|
|
733
|
-
order?: SortOrderWithLiterals;
|
|
761
|
+
planId?: string;
|
|
734
762
|
/**
|
|
735
|
-
*
|
|
736
|
-
*
|
|
763
|
+
* Form submission id that was submitted together with the order
|
|
764
|
+
* @format GUID
|
|
737
765
|
*/
|
|
738
|
-
|
|
739
|
-
}
|
|
740
|
-
declare enum SortOrder {
|
|
741
|
-
ASC = "ASC",
|
|
742
|
-
DESC = "DESC"
|
|
743
|
-
}
|
|
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;
|
|
766
|
+
submissionId?: string | null;
|
|
757
767
|
}
|
|
758
|
-
interface
|
|
759
|
-
/**
|
|
760
|
-
|
|
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;
|
|
768
|
+
interface CreateExternalOrderResponse {
|
|
769
|
+
/** Created order */
|
|
770
|
+
order?: Order;
|
|
769
771
|
}
|
|
770
|
-
interface
|
|
772
|
+
interface GetOnlineOrderPreviewRequest {
|
|
771
773
|
/**
|
|
772
|
-
*
|
|
773
|
-
* @
|
|
774
|
+
* Plan ID.
|
|
775
|
+
* @format GUID
|
|
774
776
|
*/
|
|
775
|
-
|
|
777
|
+
planId: string;
|
|
776
778
|
/**
|
|
777
|
-
*
|
|
778
|
-
*
|
|
779
|
+
* Start date and time for the plan of the order preview in a `YYYY-MM-DDThh:mm[:ss][.sss]Z` format.
|
|
780
|
+
*
|
|
781
|
+
* Default: Current date and time.
|
|
779
782
|
*/
|
|
780
|
-
|
|
781
|
-
|
|
782
|
-
|
|
783
|
+
startDate?: Date | null;
|
|
784
|
+
/**
|
|
785
|
+
* Coupon code to apply.
|
|
786
|
+
* @minLength 1
|
|
787
|
+
* @maxLength 20
|
|
788
|
+
*/
|
|
789
|
+
couponCode?: string | null;
|
|
783
790
|
}
|
|
784
|
-
interface
|
|
785
|
-
/**
|
|
786
|
-
|
|
787
|
-
/**
|
|
788
|
-
|
|
791
|
+
interface GetOnlineOrderPreviewResponse {
|
|
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;
|
|
789
796
|
}
|
|
790
|
-
interface
|
|
797
|
+
interface GetGuestOnlineOrderPreviewRequest {
|
|
791
798
|
/**
|
|
792
|
-
*
|
|
799
|
+
* Plan ID.
|
|
793
800
|
* @format GUID
|
|
794
801
|
*/
|
|
795
|
-
|
|
796
|
-
|
|
797
|
-
|
|
798
|
-
|
|
799
|
-
|
|
800
|
-
|
|
801
|
-
|
|
802
|
-
/**
|
|
803
|
-
|
|
802
|
+
planId?: string;
|
|
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;
|
|
804
820
|
}
|
|
805
|
-
|
|
806
|
-
/**
|
|
807
|
-
|
|
808
|
-
/**
|
|
809
|
-
|
|
810
|
-
|
|
811
|
-
|
|
812
|
-
|
|
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"
|
|
821
|
+
interface GetGuestOnlineOrderPreviewResponse {
|
|
822
|
+
/** Will be missing if limit is exceeded */
|
|
823
|
+
order?: Order;
|
|
824
|
+
/**
|
|
825
|
+
* Whether the purchase limit has already been reached for this plan by this email.
|
|
826
|
+
* Always false for plans without purchase limits.
|
|
827
|
+
*/
|
|
828
|
+
purchaseLimitExceeded?: boolean;
|
|
822
829
|
}
|
|
823
|
-
|
|
824
|
-
type ReasonNotSuspendableWithLiterals = ReasonNotSuspendable | 'UNDEFINED' | 'PENDING' | 'TRIAL' | 'CANCELED' | 'ENDED' | 'NOT_STARTED' | 'ALREADY_SUSPENDED' | 'OLD_STRIPE';
|
|
825
|
-
interface PostponeEndDateRequest {
|
|
830
|
+
interface GetOfflineOrderPreviewRequest {
|
|
826
831
|
/**
|
|
827
|
-
*
|
|
832
|
+
* ID of the plan of the previewed order, from the Plans API.
|
|
828
833
|
* @format GUID
|
|
829
834
|
*/
|
|
830
|
-
|
|
835
|
+
planId: string;
|
|
831
836
|
/**
|
|
832
|
-
*
|
|
837
|
+
* Member ID of the buyer the previewed order is for, from the Members API.
|
|
838
|
+
* @format GUID
|
|
839
|
+
*/
|
|
840
|
+
memberId: string;
|
|
841
|
+
/**
|
|
842
|
+
* Start date and time for plan of the previewed order in a `YYYY-MM-DDThh:mm[:ss][.sss]Z` format.
|
|
833
843
|
*
|
|
834
|
-
*
|
|
844
|
+
* Default: Current date and time.
|
|
835
845
|
*/
|
|
836
|
-
|
|
837
|
-
}
|
|
838
|
-
interface PostponeEndDateResponse {
|
|
839
|
-
}
|
|
840
|
-
interface OrderEndDatePostponed {
|
|
841
|
-
/** Order whose `endDate` was postponed. */
|
|
842
|
-
order?: Order;
|
|
843
|
-
}
|
|
844
|
-
interface CancelOrderRequest {
|
|
846
|
+
startDate?: Date | null;
|
|
845
847
|
/**
|
|
846
|
-
*
|
|
847
|
-
* @
|
|
848
|
+
* Coupon code to apply, from the Coupons API.
|
|
849
|
+
* @minLength 1
|
|
850
|
+
* @maxLength 20
|
|
848
851
|
*/
|
|
849
|
-
|
|
850
|
-
/** __Required.__ When the order will be canceled. One-time orders can only be canceled `IMMEDIATELY`. */
|
|
851
|
-
effectiveAt: CancellationEffectiveAtWithLiterals;
|
|
852
|
-
}
|
|
853
|
-
interface CancelOrderResponse {
|
|
852
|
+
couponCode?: string | null;
|
|
854
853
|
}
|
|
855
|
-
|
|
856
|
-
|
|
857
|
-
*
|
|
858
|
-
* To determine the specific reason of the cancellation check `order.cancellation.cause` field.
|
|
859
|
-
*/
|
|
860
|
-
interface OrderCanceled {
|
|
861
|
-
/** Canceled order. */
|
|
854
|
+
interface GetOfflineOrderPreviewResponse {
|
|
855
|
+
/** The previewed order, as if the plan had been ordered. */
|
|
862
856
|
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;
|
|
863
864
|
}
|
|
864
|
-
interface
|
|
865
|
+
interface GetPricePreviewRequest {
|
|
865
866
|
/**
|
|
866
|
-
*
|
|
867
|
+
* ID of plan to preview.
|
|
867
868
|
* @format GUID
|
|
868
869
|
*/
|
|
869
|
-
|
|
870
|
-
|
|
871
|
-
|
|
870
|
+
planId: string;
|
|
871
|
+
/**
|
|
872
|
+
* Coupon code to apply, from the Coupons API.
|
|
873
|
+
* @minLength 1
|
|
874
|
+
* @maxLength 20
|
|
875
|
+
*/
|
|
876
|
+
couponCode?: string | null;
|
|
872
877
|
}
|
|
873
|
-
interface
|
|
874
|
-
/**
|
|
875
|
-
|
|
878
|
+
interface GetPricePreviewResponse {
|
|
879
|
+
/** Pricing details. */
|
|
880
|
+
prices?: SpannedPrice[];
|
|
876
881
|
}
|
|
877
|
-
interface
|
|
882
|
+
interface ChangeStartDateRequest {
|
|
878
883
|
/**
|
|
879
|
-
*
|
|
884
|
+
* Draft order ID.
|
|
880
885
|
* @format GUID
|
|
881
886
|
*/
|
|
882
|
-
|
|
887
|
+
orderId?: string;
|
|
888
|
+
/** New valid from date (timestamp). */
|
|
889
|
+
startDate?: Date | null;
|
|
883
890
|
}
|
|
884
|
-
interface
|
|
891
|
+
interface ChangeStartDateResponse {
|
|
892
|
+
/** Updated draft order. */
|
|
893
|
+
order?: Order;
|
|
885
894
|
}
|
|
886
|
-
interface
|
|
887
|
-
/**
|
|
895
|
+
interface OrderStartDateChanged {
|
|
896
|
+
/** Order whose `startDate` changed. */
|
|
888
897
|
order?: Order;
|
|
889
898
|
}
|
|
890
|
-
interface
|
|
899
|
+
interface ApplyCouponRequest {
|
|
891
900
|
/**
|
|
892
|
-
*
|
|
901
|
+
* Draft order ID.
|
|
893
902
|
* @format GUID
|
|
894
|
-
* @minSize 1
|
|
895
|
-
* @maxSize 100
|
|
896
903
|
*/
|
|
897
|
-
|
|
898
|
-
/**
|
|
899
|
-
|
|
900
|
-
|
|
901
|
-
|
|
902
|
-
|
|
903
|
-
|
|
904
|
-
/** Bulk action metadata. */
|
|
905
|
-
bulkActionMetadata?: BulkActionMetadata;
|
|
904
|
+
orderId?: string;
|
|
905
|
+
/**
|
|
906
|
+
* Coupon code to apply.
|
|
907
|
+
* @minLength 1
|
|
908
|
+
* @maxLength 20
|
|
909
|
+
*/
|
|
910
|
+
couponCode?: string;
|
|
906
911
|
}
|
|
907
|
-
interface
|
|
908
|
-
/**
|
|
909
|
-
itemMetadata?: ItemMetadata;
|
|
910
|
-
/** The order. */
|
|
912
|
+
interface ApplyCouponResponse {
|
|
913
|
+
/** Order with applied coupon and recalculated tax. */
|
|
911
914
|
order?: Order;
|
|
912
915
|
}
|
|
913
|
-
interface
|
|
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 {
|
|
916
|
+
interface SetSubmissionRequest {
|
|
940
917
|
/**
|
|
941
918
|
* Order ID.
|
|
942
919
|
* @format GUID
|
|
943
920
|
*/
|
|
944
|
-
|
|
945
|
-
}
|
|
946
|
-
interface ResumeOrderResponse {
|
|
947
|
-
}
|
|
948
|
-
interface OrderResumed {
|
|
949
|
-
/** Resumed order. */
|
|
950
|
-
order?: Order;
|
|
951
|
-
}
|
|
952
|
-
interface BulkResumeOrderRequest {
|
|
921
|
+
orderId?: string;
|
|
953
922
|
/**
|
|
954
|
-
*
|
|
923
|
+
* Submission ID.
|
|
955
924
|
* @format GUID
|
|
956
|
-
* @minSize 1
|
|
957
|
-
* @maxSize 100
|
|
958
925
|
*/
|
|
959
|
-
|
|
960
|
-
/** Set to true to return Order entity in response. */
|
|
961
|
-
returnFullEntity?: boolean;
|
|
926
|
+
submissionId?: string;
|
|
962
927
|
}
|
|
963
|
-
interface
|
|
964
|
-
/**
|
|
965
|
-
|
|
966
|
-
/** Bulk action metadata. */
|
|
967
|
-
bulkActionMetadata?: BulkActionMetadata;
|
|
928
|
+
interface SetSubmissionResponse {
|
|
929
|
+
/** Order with submission id */
|
|
930
|
+
order?: Order;
|
|
968
931
|
}
|
|
969
932
|
interface MessageEnvelope {
|
|
970
933
|
/**
|
|
@@ -1057,308 +1020,345 @@ interface AccountInfo {
|
|
|
1057
1020
|
*/
|
|
1058
1021
|
siteId?: string | null;
|
|
1059
1022
|
}
|
|
1060
|
-
interface
|
|
1061
|
-
/**
|
|
1062
|
-
|
|
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
|
-
* @format GUID
|
|
1083
|
-
*/
|
|
1084
|
-
submissionId?: string | null;
|
|
1085
|
-
}
|
|
1086
|
-
interface OnBehalf {
|
|
1087
|
-
/**
|
|
1088
|
-
* Member ID.
|
|
1089
|
-
* @format GUID
|
|
1090
|
-
*/
|
|
1091
|
-
memberId?: string;
|
|
1092
|
-
/** Method by which checkout is initiated. */
|
|
1093
|
-
orderMethod?: OrderMethodWithLiterals;
|
|
1023
|
+
interface OrderPurchased {
|
|
1024
|
+
/** Order that was paid for. If a free or an offline order, the order that was created. */
|
|
1025
|
+
order?: Order;
|
|
1094
1026
|
}
|
|
1095
|
-
interface
|
|
1096
|
-
/**
|
|
1027
|
+
interface OrderStarted {
|
|
1028
|
+
/** Order that reached its `startDate`. */
|
|
1097
1029
|
order?: Order;
|
|
1098
1030
|
}
|
|
1099
|
-
|
|
1100
|
-
|
|
1101
|
-
|
|
1102
|
-
|
|
1103
|
-
|
|
1031
|
+
/**
|
|
1032
|
+
* Triggered at the start of a new payment cycle for an existing order.
|
|
1033
|
+
*
|
|
1034
|
+
* This webhook does not trigger at the initial start of an offline order.
|
|
1035
|
+
*/
|
|
1036
|
+
interface OrderCycleStarted {
|
|
1037
|
+
/** Order whose new cycle started. */
|
|
1038
|
+
order?: Order;
|
|
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;
|
|
1104
1041
|
}
|
|
1105
|
-
|
|
1106
|
-
|
|
1107
|
-
|
|
1108
|
-
|
|
1109
|
-
|
|
1110
|
-
|
|
1111
|
-
/**
|
|
1112
|
-
|
|
1113
|
-
|
|
1114
|
-
|
|
1115
|
-
*/
|
|
1116
|
-
startDate?: Date | null;
|
|
1117
|
-
/**
|
|
1118
|
-
* Coupon code to apply.
|
|
1119
|
-
* @minLength 1
|
|
1120
|
-
* @maxLength 20
|
|
1121
|
-
*/
|
|
1122
|
-
couponCode?: string | null;
|
|
1123
|
-
/** Captcha data to prove you are not a robot */
|
|
1124
|
-
captcha?: Captcha;
|
|
1125
|
-
/** Visitor info */
|
|
1126
|
-
guest?: Guest;
|
|
1042
|
+
/** Emitted when a recurring order is canceled for the next payment cycle */
|
|
1043
|
+
interface OrderAutoRenewCanceled {
|
|
1044
|
+
/** Order that is canceled, effective at the end of the current payment cycle. */
|
|
1045
|
+
order?: Order;
|
|
1046
|
+
}
|
|
1047
|
+
interface OrderEnded {
|
|
1048
|
+
/** Order that ended. */
|
|
1049
|
+
order?: Order;
|
|
1050
|
+
}
|
|
1051
|
+
interface GetOrderRequest {
|
|
1127
1052
|
/**
|
|
1128
|
-
*
|
|
1053
|
+
* Order ID.
|
|
1129
1054
|
* @format GUID
|
|
1130
1055
|
*/
|
|
1131
|
-
|
|
1132
|
-
}
|
|
1133
|
-
interface Captcha {
|
|
1134
|
-
/** Token from captcha */
|
|
1135
|
-
token?: string;
|
|
1136
|
-
}
|
|
1137
|
-
interface Guest {
|
|
1056
|
+
_id: string;
|
|
1138
1057
|
/**
|
|
1139
|
-
*
|
|
1140
|
-
*
|
|
1058
|
+
* Predefined set of fields to return.
|
|
1059
|
+
*
|
|
1060
|
+
* Default: If `fieldSet` is omitted, no order form submission data is returned.
|
|
1141
1061
|
*/
|
|
1142
|
-
|
|
1062
|
+
fieldSet?: SetWithLiterals;
|
|
1143
1063
|
}
|
|
1144
|
-
|
|
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"
|
|
1071
|
+
}
|
|
1072
|
+
/** @enumType */
|
|
1073
|
+
type SetWithLiterals = Set | 'UNKNOWN_SET' | 'BASIC' | 'FULL';
|
|
1074
|
+
interface GetOrderResponse {
|
|
1145
1075
|
/** Order. */
|
|
1146
1076
|
order?: Order;
|
|
1147
1077
|
}
|
|
1148
|
-
interface
|
|
1078
|
+
interface ListOrdersRequest {
|
|
1149
1079
|
/**
|
|
1150
|
-
*
|
|
1080
|
+
* Filter by a buyer's member ID, from the Members API.
|
|
1151
1081
|
* @format GUID
|
|
1152
1082
|
*/
|
|
1153
|
-
|
|
1083
|
+
buyerIds?: string[];
|
|
1154
1084
|
/**
|
|
1155
|
-
*
|
|
1085
|
+
* Filter by plan IDs, from the Plans API.
|
|
1156
1086
|
* @format GUID
|
|
1157
1087
|
*/
|
|
1158
|
-
|
|
1088
|
+
planIds?: string[];
|
|
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[];
|
|
1159
1095
|
/**
|
|
1160
|
-
*
|
|
1096
|
+
* Number of orders to return. See Sorting and Paging for more information.
|
|
1161
1097
|
*
|
|
1162
|
-
*
|
|
1098
|
+
* Max: `50`
|
|
1099
|
+
* @min 1
|
|
1100
|
+
* @max 50
|
|
1163
1101
|
*/
|
|
1164
|
-
|
|
1102
|
+
limit?: number | null;
|
|
1103
|
+
/** Number of orders to skip in the current sort order. */
|
|
1104
|
+
offset?: number | null;
|
|
1165
1105
|
/**
|
|
1166
|
-
*
|
|
1106
|
+
* Sort order.
|
|
1167
1107
|
*
|
|
1168
|
-
*
|
|
1169
|
-
|
|
1170
|
-
|
|
1171
|
-
/**
|
|
1172
|
-
* Coupon code to apply, from the Coupons API.
|
|
1173
|
-
* @minLength 1
|
|
1174
|
-
* @maxLength 20
|
|
1108
|
+
* Use `ASC` for ascending order or `DESC` for descending order.
|
|
1109
|
+
*
|
|
1110
|
+
* Default: `DESC`.
|
|
1175
1111
|
*/
|
|
1176
|
-
|
|
1112
|
+
sorting?: Sorting;
|
|
1177
1113
|
/**
|
|
1178
|
-
*
|
|
1179
|
-
*
|
|
1114
|
+
* Predefined set of fields to return.
|
|
1115
|
+
*
|
|
1116
|
+
* Default: If `fieldSet` is omitted, no order form submission data is returned.
|
|
1180
1117
|
*/
|
|
1181
|
-
|
|
1182
|
-
}
|
|
1183
|
-
interface CreateOfflineOrderResponse {
|
|
1184
|
-
/** Order. */
|
|
1185
|
-
order?: Order;
|
|
1118
|
+
fieldSet?: SetWithLiterals;
|
|
1186
1119
|
}
|
|
1187
|
-
interface
|
|
1120
|
+
interface Sorting {
|
|
1188
1121
|
/**
|
|
1189
|
-
*
|
|
1190
|
-
* @
|
|
1122
|
+
* Name of the field to sort by.
|
|
1123
|
+
* @maxLength 512
|
|
1191
1124
|
*/
|
|
1192
|
-
|
|
1125
|
+
fieldName?: string;
|
|
1126
|
+
/** Sort order. */
|
|
1127
|
+
order?: SortOrderWithLiterals;
|
|
1193
1128
|
/**
|
|
1194
|
-
*
|
|
1195
|
-
*
|
|
1129
|
+
* Origin point for geo-distance sorting on a GEO field
|
|
1130
|
+
* results are ordered by distance from this point (ASC = nearest first, DESC = farthest first).
|
|
1196
1131
|
*/
|
|
1197
|
-
|
|
1132
|
+
origin?: AddressLocation;
|
|
1198
1133
|
}
|
|
1199
|
-
|
|
1200
|
-
|
|
1201
|
-
|
|
1134
|
+
declare enum SortOrder {
|
|
1135
|
+
ASC = "ASC",
|
|
1136
|
+
DESC = "DESC"
|
|
1202
1137
|
}
|
|
1203
|
-
|
|
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;
|
|
1151
|
+
}
|
|
1152
|
+
interface PagingMetadataV2 {
|
|
1153
|
+
/** Number of items returned in the response. */
|
|
1154
|
+
count?: number | null;
|
|
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;
|
|
1163
|
+
}
|
|
1164
|
+
interface Cursors {
|
|
1204
1165
|
/**
|
|
1205
|
-
*
|
|
1206
|
-
* @
|
|
1166
|
+
* Cursor string pointing to the next page in the list of results.
|
|
1167
|
+
* @maxLength 16000
|
|
1207
1168
|
*/
|
|
1208
|
-
|
|
1169
|
+
next?: string | null;
|
|
1209
1170
|
/**
|
|
1210
|
-
*
|
|
1211
|
-
*
|
|
1212
|
-
* Default: Current date and time.
|
|
1171
|
+
* Cursor pointing to the previous page in the list of results.
|
|
1172
|
+
* @maxLength 16000
|
|
1213
1173
|
*/
|
|
1214
|
-
|
|
1174
|
+
prev?: string | null;
|
|
1175
|
+
}
|
|
1176
|
+
interface GetOrdersStatsRequest {
|
|
1177
|
+
}
|
|
1178
|
+
interface GetOrdersStatsResponse {
|
|
1179
|
+
/** Total number of orders. */
|
|
1180
|
+
totalOrderCount?: number;
|
|
1181
|
+
/** Number of active orders. */
|
|
1182
|
+
activeOrderCount?: number;
|
|
1183
|
+
}
|
|
1184
|
+
interface GetAvailableOrderActionsRequest {
|
|
1215
1185
|
/**
|
|
1216
|
-
*
|
|
1217
|
-
* @
|
|
1218
|
-
* @maxLength 20
|
|
1186
|
+
* Order ID.
|
|
1187
|
+
* @format GUID
|
|
1219
1188
|
*/
|
|
1220
|
-
|
|
1189
|
+
_id?: string;
|
|
1221
1190
|
}
|
|
1222
|
-
interface
|
|
1223
|
-
/**
|
|
1224
|
-
|
|
1225
|
-
/**
|
|
1226
|
-
|
|
1191
|
+
interface GetAvailableOrderActionsResponse {
|
|
1192
|
+
/** Whether the order can be suspended. */
|
|
1193
|
+
suspendable?: boolean;
|
|
1194
|
+
/** If the order cannot be suspended, a reason is returned here. */
|
|
1195
|
+
notSuspendableReason?: ReasonNotSuspendableWithLiterals;
|
|
1196
|
+
/** Whether the order can be canceled by the buyer. */
|
|
1197
|
+
cancelableByBuyer?: boolean;
|
|
1227
1198
|
}
|
|
1228
|
-
|
|
1199
|
+
declare enum ReasonNotSuspendable {
|
|
1200
|
+
/** Undefined reason. */
|
|
1201
|
+
UNDEFINED = "UNDEFINED",
|
|
1202
|
+
/** Saved in the database but is awaiting payment. Non-active orders can't be suspended. */
|
|
1203
|
+
PENDING = "PENDING",
|
|
1204
|
+
/** Trial orders can't be suspended. */
|
|
1205
|
+
TRIAL = "TRIAL",
|
|
1206
|
+
/** Canceled orders can't be suspended. */
|
|
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"
|
|
1216
|
+
}
|
|
1217
|
+
/** @enumType */
|
|
1218
|
+
type ReasonNotSuspendableWithLiterals = ReasonNotSuspendable | 'UNDEFINED' | 'PENDING' | 'TRIAL' | 'CANCELED' | 'ENDED' | 'NOT_STARTED' | 'ALREADY_SUSPENDED' | 'OLD_STRIPE';
|
|
1219
|
+
interface PostponeEndDateRequest {
|
|
1229
1220
|
/**
|
|
1230
|
-
*
|
|
1221
|
+
* Order ID.
|
|
1231
1222
|
* @format GUID
|
|
1232
1223
|
*/
|
|
1233
|
-
|
|
1224
|
+
_id: string;
|
|
1234
1225
|
/**
|
|
1235
|
-
*
|
|
1226
|
+
* New end date and time.
|
|
1236
1227
|
*
|
|
1237
|
-
*
|
|
1238
|
-
*/
|
|
1239
|
-
startDate?: Date | null;
|
|
1240
|
-
/**
|
|
1241
|
-
* Coupon code to apply.
|
|
1242
|
-
* @minLength 1
|
|
1243
|
-
* @maxLength 20
|
|
1244
|
-
*/
|
|
1245
|
-
couponCode?: string | null;
|
|
1246
|
-
/**
|
|
1247
|
-
* Email for checkout
|
|
1248
|
-
* @format EMAIL
|
|
1228
|
+
* Must be later than the current end date and time.
|
|
1249
1229
|
*/
|
|
1250
|
-
|
|
1230
|
+
endDate: Date | null;
|
|
1251
1231
|
}
|
|
1252
|
-
interface
|
|
1253
|
-
|
|
1232
|
+
interface PostponeEndDateResponse {
|
|
1233
|
+
}
|
|
1234
|
+
interface OrderEndDatePostponed {
|
|
1235
|
+
/** Order whose `endDate` was postponed. */
|
|
1254
1236
|
order?: Order;
|
|
1255
|
-
/**
|
|
1256
|
-
* Whether the purchase limit has already been reached for this plan by this email.
|
|
1257
|
-
* Always false for plans without purchase limits.
|
|
1258
|
-
*/
|
|
1259
|
-
purchaseLimitExceeded?: boolean;
|
|
1260
1237
|
}
|
|
1261
|
-
interface
|
|
1262
|
-
/**
|
|
1263
|
-
* ID of the plan of the previewed order, from the Plans API.
|
|
1264
|
-
* @format GUID
|
|
1265
|
-
*/
|
|
1266
|
-
planId: string;
|
|
1238
|
+
interface CancelOrderRequest {
|
|
1267
1239
|
/**
|
|
1268
|
-
*
|
|
1240
|
+
* Order ID.
|
|
1269
1241
|
* @format GUID
|
|
1270
1242
|
*/
|
|
1271
|
-
|
|
1272
|
-
/**
|
|
1273
|
-
|
|
1274
|
-
*
|
|
1275
|
-
* Default: Current date and time.
|
|
1276
|
-
*/
|
|
1277
|
-
startDate?: Date | null;
|
|
1278
|
-
/**
|
|
1279
|
-
* Coupon code to apply, from the Coupons API.
|
|
1280
|
-
* @minLength 1
|
|
1281
|
-
* @maxLength 20
|
|
1282
|
-
*/
|
|
1283
|
-
couponCode?: string | null;
|
|
1243
|
+
_id: string;
|
|
1244
|
+
/** __Required.__ When the order will be canceled. One-time orders can only be canceled `IMMEDIATELY`. */
|
|
1245
|
+
effectiveAt: CancellationEffectiveAtWithLiterals;
|
|
1284
1246
|
}
|
|
1285
|
-
interface
|
|
1286
|
-
|
|
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. */
|
|
1287
1256
|
order?: Order;
|
|
1288
|
-
/**
|
|
1289
|
-
* Whether this previewed order would exceed the permitted amount of purchases available
|
|
1290
|
-
* for this plan for this buyer.
|
|
1291
|
-
*
|
|
1292
|
-
* Always `false` for plans that do not have purchase limits.
|
|
1293
|
-
*/
|
|
1294
|
-
purchaseLimitExceeded?: boolean;
|
|
1295
1257
|
}
|
|
1296
|
-
interface
|
|
1258
|
+
interface MarkAsPaidRequest {
|
|
1297
1259
|
/**
|
|
1298
|
-
* ID
|
|
1260
|
+
* Order ID.
|
|
1299
1261
|
* @format GUID
|
|
1300
1262
|
*/
|
|
1301
|
-
|
|
1302
|
-
/**
|
|
1303
|
-
* Coupon code to apply, from the Coupons API.
|
|
1304
|
-
* @minLength 1
|
|
1305
|
-
* @maxLength 20
|
|
1306
|
-
*/
|
|
1307
|
-
couponCode?: string | null;
|
|
1263
|
+
_id: string;
|
|
1308
1264
|
}
|
|
1309
|
-
interface
|
|
1310
|
-
/** Pricing details. */
|
|
1311
|
-
prices?: SpannedPrice[];
|
|
1265
|
+
interface MarkAsPaidResponse {
|
|
1312
1266
|
}
|
|
1313
|
-
interface
|
|
1267
|
+
interface OrderMarkedAsPaid {
|
|
1268
|
+
/** Order that was marked as paid. */
|
|
1269
|
+
order?: Order;
|
|
1270
|
+
}
|
|
1271
|
+
interface PauseOrderRequest {
|
|
1314
1272
|
/**
|
|
1315
|
-
*
|
|
1273
|
+
* Order ID.
|
|
1316
1274
|
* @format GUID
|
|
1317
1275
|
*/
|
|
1318
|
-
|
|
1319
|
-
/** New valid from date (timestamp). */
|
|
1320
|
-
startDate?: Date | null;
|
|
1276
|
+
_id: string;
|
|
1321
1277
|
}
|
|
1322
|
-
interface
|
|
1323
|
-
/** Updated draft order. */
|
|
1324
|
-
order?: Order;
|
|
1278
|
+
interface PauseOrderResponse {
|
|
1325
1279
|
}
|
|
1326
|
-
interface
|
|
1327
|
-
/**
|
|
1280
|
+
interface OrderPaused {
|
|
1281
|
+
/** Paused order. */
|
|
1328
1282
|
order?: Order;
|
|
1329
1283
|
}
|
|
1330
|
-
interface
|
|
1284
|
+
interface BulkPauseOrderRequest {
|
|
1331
1285
|
/**
|
|
1332
|
-
*
|
|
1286
|
+
* List of Order IDs.
|
|
1333
1287
|
* @format GUID
|
|
1288
|
+
* @minSize 1
|
|
1289
|
+
* @maxSize 100
|
|
1334
1290
|
*/
|
|
1335
|
-
|
|
1336
|
-
/**
|
|
1337
|
-
|
|
1338
|
-
* @minLength 1
|
|
1339
|
-
* @maxLength 20
|
|
1340
|
-
*/
|
|
1341
|
-
couponCode?: string;
|
|
1291
|
+
ids?: string[];
|
|
1292
|
+
/** Set to true to return Order entity in response. */
|
|
1293
|
+
returnFullEntity?: boolean;
|
|
1342
1294
|
}
|
|
1343
|
-
interface
|
|
1344
|
-
/**
|
|
1295
|
+
interface BulkPauseOrderResponse {
|
|
1296
|
+
/** Orders that were paused. */
|
|
1297
|
+
results?: BulkOrderResult[];
|
|
1298
|
+
/** Bulk action metadata. */
|
|
1299
|
+
bulkActionMetadata?: BulkActionMetadata;
|
|
1300
|
+
}
|
|
1301
|
+
interface BulkOrderResult {
|
|
1302
|
+
/** Item metadata */
|
|
1303
|
+
itemMetadata?: ItemMetadata;
|
|
1304
|
+
/** The order. */
|
|
1345
1305
|
order?: Order;
|
|
1346
1306
|
}
|
|
1347
|
-
interface
|
|
1307
|
+
interface ItemMetadata {
|
|
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 {
|
|
1348
1334
|
/**
|
|
1349
1335
|
* Order ID.
|
|
1350
1336
|
* @format GUID
|
|
1351
1337
|
*/
|
|
1352
|
-
|
|
1338
|
+
_id: string;
|
|
1339
|
+
}
|
|
1340
|
+
interface ResumeOrderResponse {
|
|
1341
|
+
}
|
|
1342
|
+
interface OrderResumed {
|
|
1343
|
+
/** Resumed order. */
|
|
1344
|
+
order?: Order;
|
|
1345
|
+
}
|
|
1346
|
+
interface BulkResumeOrderRequest {
|
|
1353
1347
|
/**
|
|
1354
|
-
*
|
|
1348
|
+
* List of Order IDs.
|
|
1355
1349
|
* @format GUID
|
|
1350
|
+
* @minSize 1
|
|
1351
|
+
* @maxSize 100
|
|
1356
1352
|
*/
|
|
1357
|
-
|
|
1353
|
+
ids?: string[];
|
|
1354
|
+
/** Set to true to return Order entity in response. */
|
|
1355
|
+
returnFullEntity?: boolean;
|
|
1358
1356
|
}
|
|
1359
|
-
interface
|
|
1360
|
-
/**
|
|
1361
|
-
|
|
1357
|
+
interface BulkResumeOrderResponse {
|
|
1358
|
+
/** Orders that were resumed. */
|
|
1359
|
+
results?: BulkOrderResult[];
|
|
1360
|
+
/** Bulk action metadata. */
|
|
1361
|
+
bulkActionMetadata?: BulkActionMetadata;
|
|
1362
1362
|
}
|
|
1363
1363
|
interface MemberGetOrderRequest {
|
|
1364
1364
|
/**
|
|
@@ -1774,16 +1774,12 @@ interface AccountInfoMetadata {
|
|
|
1774
1774
|
/** ID of the parent Wix account. Only included when 'accountId' belongs to a child account. */
|
|
1775
1775
|
parentAccountId?: string;
|
|
1776
1776
|
}
|
|
1777
|
-
interface
|
|
1778
|
-
|
|
1777
|
+
interface OrderCreatedEnvelope {
|
|
1778
|
+
entity: Order;
|
|
1779
1779
|
metadata: EventMetadata;
|
|
1780
1780
|
}
|
|
1781
1781
|
/**
|
|
1782
|
-
* Triggered when an order is
|
|
1783
|
-
*
|
|
1784
|
-
* This webhook is *not* triggered in the following scenarios:
|
|
1785
|
-
* + When an order is canceled and `effectiveAt` is set to `IMMEDIATELY`. Instead, at the time of cancellation, Order Canceled is triggered.
|
|
1786
|
-
* + When an order expires at the end of the current payment cycle because it was canceled and `effectiveAt` was set to `NEXT_PAYMENT_DATE`. Instead, at the time of expiration, Order Canceled and Order Ended are triggered.
|
|
1782
|
+
* Triggered when an order is created.
|
|
1787
1783
|
* @permissionScope Manage_Wix_Rentals_App_Forms_submissions
|
|
1788
1784
|
* @permissionScopeId SCOPE.RENTALS.MANAGE
|
|
1789
1785
|
* @permissionScope Manage Orders
|
|
@@ -1796,21 +1792,17 @@ interface OrderAutoRenewCanceledEnvelope {
|
|
|
1796
1792
|
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1797
1793
|
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
1798
1794
|
* @webhook
|
|
1799
|
-
* @eventType wix.pricing_plans.v2.
|
|
1800
|
-
* @serviceIdentifier com.wixpress.membership.v2.orders.
|
|
1801
|
-
* @slug
|
|
1795
|
+
* @eventType wix.pricing_plans.v2.order_created
|
|
1796
|
+
* @serviceIdentifier com.wixpress.membership.v2.orders.CheckoutService
|
|
1797
|
+
* @slug created
|
|
1802
1798
|
*/
|
|
1803
|
-
declare function
|
|
1804
|
-
interface
|
|
1805
|
-
data:
|
|
1799
|
+
declare function onOrderCreated(handler: (event: OrderCreatedEnvelope) => void | Promise<void>): void;
|
|
1800
|
+
interface OrderStartDateChangedEnvelope {
|
|
1801
|
+
data: OrderStartDateChanged;
|
|
1806
1802
|
metadata: EventMetadata;
|
|
1807
1803
|
}
|
|
1808
1804
|
/**
|
|
1809
|
-
* Triggered when an order is
|
|
1810
|
-
*
|
|
1811
|
-
* This webhook is triggered either immediately or at the end of the current payment cycle, as follows:
|
|
1812
|
-
* + If the order is canceled and `effectiveAt` is set to `IMMEDIATELY`, the webhook is triggered immediately when canceled.
|
|
1813
|
-
* + If the order is canceled and `effectiveAt` is set to `NEXT_PAYMENT_DATE`, the webhook is triggered at the end of the current payment cycle. In this case, the Order Auto Renew Canceled Webhook is triggered immediately.
|
|
1805
|
+
* Triggered when an order's `startDate` is changed.
|
|
1814
1806
|
* @permissionScope Manage_Wix_Rentals_App_Forms_submissions
|
|
1815
1807
|
* @permissionScopeId SCOPE.RENTALS.MANAGE
|
|
1816
1808
|
* @permissionScope Manage Orders
|
|
@@ -1823,42 +1815,25 @@ interface OrderCanceledEnvelope {
|
|
|
1823
1815
|
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1824
1816
|
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
1825
1817
|
* @webhook
|
|
1826
|
-
* @eventType wix.pricing_plans.v2.
|
|
1827
|
-
* @serviceIdentifier com.wixpress.membership.v2.orders.
|
|
1828
|
-
* @slug
|
|
1818
|
+
* @eventType wix.pricing_plans.v2.order_start_date_changed
|
|
1819
|
+
* @serviceIdentifier com.wixpress.membership.v2.orders.CheckoutService
|
|
1820
|
+
* @slug start_date_changed
|
|
1829
1821
|
*/
|
|
1830
|
-
declare function
|
|
1831
|
-
interface
|
|
1832
|
-
|
|
1822
|
+
declare function onOrderStartDateChanged(handler: (event: OrderStartDateChangedEnvelope) => void | Promise<void>): void;
|
|
1823
|
+
interface OrderUpdatedEnvelope {
|
|
1824
|
+
entity: Order;
|
|
1833
1825
|
metadata: EventMetadata;
|
|
1834
1826
|
}
|
|
1835
1827
|
/**
|
|
1836
|
-
* Triggered
|
|
1828
|
+
* Triggered for any of the following update events:
|
|
1837
1829
|
*
|
|
1838
|
-
*
|
|
1839
|
-
*
|
|
1840
|
-
*
|
|
1841
|
-
*
|
|
1842
|
-
*
|
|
1843
|
-
*
|
|
1844
|
-
*
|
|
1845
|
-
* @permissionScope Manage plans and orders of Pricing Plans
|
|
1846
|
-
* @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-PLANS-AND-ORDERS
|
|
1847
|
-
* @permissionScope Manage Events
|
|
1848
|
-
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1849
|
-
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
1850
|
-
* @webhook
|
|
1851
|
-
* @eventType wix.pricing_plans.v2.order_cycle_started
|
|
1852
|
-
* @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
|
|
1853
|
-
* @slug cycle_started
|
|
1854
|
-
*/
|
|
1855
|
-
declare function onOrderCycleStarted(handler: (event: OrderCycleStartedEnvelope) => void | Promise<void>): void;
|
|
1856
|
-
interface OrderEndDatePostponedEnvelope {
|
|
1857
|
-
data: OrderEndDatePostponed;
|
|
1858
|
-
metadata: EventMetadata;
|
|
1859
|
-
}
|
|
1860
|
-
/**
|
|
1861
|
-
* Triggered when an order's `endDate` is postponed.
|
|
1830
|
+
* + Order is paid for. Order Purchased is also triggered.
|
|
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.
|
|
1862
1837
|
* @permissionScope Manage_Wix_Rentals_App_Forms_submissions
|
|
1863
1838
|
* @permissionScopeId SCOPE.RENTALS.MANAGE
|
|
1864
1839
|
* @permissionScope Manage Orders
|
|
@@ -1871,44 +1846,21 @@ interface OrderEndDatePostponedEnvelope {
|
|
|
1871
1846
|
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1872
1847
|
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
1873
1848
|
* @webhook
|
|
1874
|
-
* @eventType wix.pricing_plans.v2.
|
|
1875
|
-
* @serviceIdentifier com.wixpress.membership.v2.orders.
|
|
1876
|
-
* @slug
|
|
1849
|
+
* @eventType wix.pricing_plans.v2.order_updated
|
|
1850
|
+
* @serviceIdentifier com.wixpress.membership.v2.orders.CheckoutService
|
|
1851
|
+
* @slug updated
|
|
1877
1852
|
*/
|
|
1878
|
-
declare function
|
|
1879
|
-
interface
|
|
1880
|
-
data:
|
|
1853
|
+
declare function onOrderUpdated(handler: (event: OrderUpdatedEnvelope) => void | Promise<void>): void;
|
|
1854
|
+
interface OrderAutoRenewCanceledEnvelope {
|
|
1855
|
+
data: OrderAutoRenewCanceled;
|
|
1881
1856
|
metadata: EventMetadata;
|
|
1882
1857
|
}
|
|
1883
1858
|
/**
|
|
1884
|
-
* Triggered when an order
|
|
1859
|
+
* Triggered when an order is canceled and `effectiveAt` is set to `NEXT_PAYMENT_DATE`.
|
|
1885
1860
|
*
|
|
1886
|
-
* This webhook is triggered:
|
|
1887
|
-
* + When an order
|
|
1888
|
-
* + When an order
|
|
1889
|
-
* @permissionScope Manage_Wix_Rentals_App_Forms_submissions
|
|
1890
|
-
* @permissionScopeId SCOPE.RENTALS.MANAGE
|
|
1891
|
-
* @permissionScope Manage Orders
|
|
1892
|
-
* @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
|
|
1893
|
-
* @permissionScope Read Orders
|
|
1894
|
-
* @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS
|
|
1895
|
-
* @permissionScope Manage plans and orders of Pricing Plans
|
|
1896
|
-
* @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-PLANS-AND-ORDERS
|
|
1897
|
-
* @permissionScope Manage Events
|
|
1898
|
-
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1899
|
-
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
1900
|
-
* @webhook
|
|
1901
|
-
* @eventType wix.pricing_plans.v2.order_ended
|
|
1902
|
-
* @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
|
|
1903
|
-
* @slug ended
|
|
1904
|
-
*/
|
|
1905
|
-
declare function onOrderEnded(handler: (event: OrderEndedEnvelope) => void | Promise<void>): void;
|
|
1906
|
-
interface OrderMarkedAsPaidEnvelope {
|
|
1907
|
-
data: OrderMarkedAsPaid;
|
|
1908
|
-
metadata: EventMetadata;
|
|
1909
|
-
}
|
|
1910
|
-
/**
|
|
1911
|
-
* Triggered when an offline order is marked as paid.
|
|
1861
|
+
* This webhook is *not* triggered in the following scenarios:
|
|
1862
|
+
* + When an order is canceled and `effectiveAt` is set to `IMMEDIATELY`. Instead, at the time of cancellation, Order Canceled is triggered.
|
|
1863
|
+
* + 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.
|
|
1912
1864
|
* @permissionScope Manage_Wix_Rentals_App_Forms_submissions
|
|
1913
1865
|
* @permissionScopeId SCOPE.RENTALS.MANAGE
|
|
1914
1866
|
* @permissionScope Manage Orders
|
|
@@ -1921,17 +1873,21 @@ interface OrderMarkedAsPaidEnvelope {
|
|
|
1921
1873
|
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1922
1874
|
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
1923
1875
|
* @webhook
|
|
1924
|
-
* @eventType wix.pricing_plans.v2.
|
|
1876
|
+
* @eventType wix.pricing_plans.v2.order_auto_renew_canceled
|
|
1925
1877
|
* @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
|
|
1926
|
-
* @slug
|
|
1878
|
+
* @slug auto_renew_canceled
|
|
1927
1879
|
*/
|
|
1928
|
-
declare function
|
|
1929
|
-
interface
|
|
1930
|
-
data:
|
|
1880
|
+
declare function onOrderAutoRenewCanceled(handler: (event: OrderAutoRenewCanceledEnvelope) => void | Promise<void>): void;
|
|
1881
|
+
interface OrderCanceledEnvelope {
|
|
1882
|
+
data: OrderCanceled;
|
|
1931
1883
|
metadata: EventMetadata;
|
|
1932
1884
|
}
|
|
1933
1885
|
/**
|
|
1934
|
-
* Triggered when an order is
|
|
1886
|
+
* Triggered when an order is canceled.
|
|
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.
|
|
1935
1891
|
* @permissionScope Manage_Wix_Rentals_App_Forms_submissions
|
|
1936
1892
|
* @permissionScopeId SCOPE.RENTALS.MANAGE
|
|
1937
1893
|
* @permissionScope Manage Orders
|
|
@@ -1944,21 +1900,19 @@ interface OrderPausedEnvelope {
|
|
|
1944
1900
|
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1945
1901
|
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
1946
1902
|
* @webhook
|
|
1947
|
-
* @eventType wix.pricing_plans.v2.
|
|
1903
|
+
* @eventType wix.pricing_plans.v2.order_canceled
|
|
1948
1904
|
* @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
|
|
1949
|
-
* @slug
|
|
1905
|
+
* @slug canceled
|
|
1950
1906
|
*/
|
|
1951
|
-
declare function
|
|
1952
|
-
interface
|
|
1953
|
-
data:
|
|
1907
|
+
declare function onOrderCanceled(handler: (event: OrderCanceledEnvelope) => void | Promise<void>): void;
|
|
1908
|
+
interface OrderCycleStartedEnvelope {
|
|
1909
|
+
data: OrderCycleStarted;
|
|
1954
1910
|
metadata: EventMetadata;
|
|
1955
1911
|
}
|
|
1956
1912
|
/**
|
|
1957
|
-
* Triggered
|
|
1958
|
-
*
|
|
1959
|
-
*
|
|
1960
|
-
* + Offline order is created, even if not yet marked as paid.
|
|
1961
|
-
* + Free order is created.
|
|
1913
|
+
* Triggered at the start of a new payment cycle for an existing order.
|
|
1914
|
+
*
|
|
1915
|
+
* Not triggered at the initial start of an offline order.
|
|
1962
1916
|
* @permissionScope Manage_Wix_Rentals_App_Forms_submissions
|
|
1963
1917
|
* @permissionScopeId SCOPE.RENTALS.MANAGE
|
|
1964
1918
|
* @permissionScope Manage Orders
|
|
@@ -1971,17 +1925,17 @@ interface OrderPurchasedEnvelope {
|
|
|
1971
1925
|
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1972
1926
|
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
1973
1927
|
* @webhook
|
|
1974
|
-
* @eventType wix.pricing_plans.v2.
|
|
1928
|
+
* @eventType wix.pricing_plans.v2.order_cycle_started
|
|
1975
1929
|
* @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
|
|
1976
|
-
* @slug
|
|
1930
|
+
* @slug cycle_started
|
|
1977
1931
|
*/
|
|
1978
|
-
declare function
|
|
1979
|
-
interface
|
|
1980
|
-
data:
|
|
1932
|
+
declare function onOrderCycleStarted(handler: (event: OrderCycleStartedEnvelope) => void | Promise<void>): void;
|
|
1933
|
+
interface OrderEndDatePostponedEnvelope {
|
|
1934
|
+
data: OrderEndDatePostponed;
|
|
1981
1935
|
metadata: EventMetadata;
|
|
1982
1936
|
}
|
|
1983
1937
|
/**
|
|
1984
|
-
* Triggered when
|
|
1938
|
+
* Triggered when an order's `endDate` is postponed.
|
|
1985
1939
|
* @permissionScope Manage_Wix_Rentals_App_Forms_submissions
|
|
1986
1940
|
* @permissionScopeId SCOPE.RENTALS.MANAGE
|
|
1987
1941
|
* @permissionScope Manage Orders
|
|
@@ -1994,17 +1948,21 @@ interface OrderResumedEnvelope {
|
|
|
1994
1948
|
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1995
1949
|
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
1996
1950
|
* @webhook
|
|
1997
|
-
* @eventType wix.pricing_plans.v2.
|
|
1951
|
+
* @eventType wix.pricing_plans.v2.order_end_date_postponed
|
|
1998
1952
|
* @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
|
|
1999
|
-
* @slug
|
|
1953
|
+
* @slug end_date_postponed
|
|
2000
1954
|
*/
|
|
2001
|
-
declare function
|
|
2002
|
-
interface
|
|
2003
|
-
data:
|
|
1955
|
+
declare function onOrderEndDatePostponed(handler: (event: OrderEndDatePostponedEnvelope) => void | Promise<void>): void;
|
|
1956
|
+
interface OrderEndedEnvelope {
|
|
1957
|
+
data: OrderEnded;
|
|
2004
1958
|
metadata: EventMetadata;
|
|
2005
1959
|
}
|
|
2006
1960
|
/**
|
|
2007
|
-
* Triggered when an order
|
|
1961
|
+
* Triggered when an order ends.
|
|
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`.
|
|
2008
1966
|
* @permissionScope Manage_Wix_Rentals_App_Forms_submissions
|
|
2009
1967
|
* @permissionScopeId SCOPE.RENTALS.MANAGE
|
|
2010
1968
|
* @permissionScope Manage Orders
|
|
@@ -2017,25 +1975,17 @@ interface OrderStartedEnvelope {
|
|
|
2017
1975
|
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
2018
1976
|
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
2019
1977
|
* @webhook
|
|
2020
|
-
* @eventType wix.pricing_plans.v2.
|
|
1978
|
+
* @eventType wix.pricing_plans.v2.order_ended
|
|
2021
1979
|
* @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
|
|
2022
|
-
* @slug
|
|
1980
|
+
* @slug ended
|
|
2023
1981
|
*/
|
|
2024
|
-
declare function
|
|
2025
|
-
interface
|
|
2026
|
-
|
|
1982
|
+
declare function onOrderEnded(handler: (event: OrderEndedEnvelope) => void | Promise<void>): void;
|
|
1983
|
+
interface OrderMarkedAsPaidEnvelope {
|
|
1984
|
+
data: OrderMarkedAsPaid;
|
|
2027
1985
|
metadata: EventMetadata;
|
|
2028
1986
|
}
|
|
2029
1987
|
/**
|
|
2030
|
-
* Triggered
|
|
2031
|
-
*
|
|
2032
|
-
* + Order is paid for. Order Purchased is also triggered.
|
|
2033
|
-
* + Order reaches its start date or end date. Order Started and Order Ended, respectively, are also triggered.
|
|
2034
|
-
* + New payment cycle of an order starts. Order Cycle Started is also triggered.
|
|
2035
|
-
* + Offline order is marked as paid. Order Marked As Paid is also triggered.
|
|
2036
|
-
* + End date of the order is postponed. Order End Date Postponed is also triggered
|
|
2037
|
-
* + Order is paused, or a paused order is resumed. Order Paused and Order Resumed, respectively, are also triggered.
|
|
2038
|
-
* + Order is canceled, either immediately or at the end of the payment cycle. Order Canceled and Order Auto Renew Canceled, respectively, are also triggered.
|
|
1988
|
+
* Triggered when an offline order is marked as paid.
|
|
2039
1989
|
* @permissionScope Manage_Wix_Rentals_App_Forms_submissions
|
|
2040
1990
|
* @permissionScopeId SCOPE.RENTALS.MANAGE
|
|
2041
1991
|
* @permissionScope Manage Orders
|
|
@@ -2048,17 +1998,17 @@ interface OrderUpdatedEnvelope {
|
|
|
2048
1998
|
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
2049
1999
|
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
2050
2000
|
* @webhook
|
|
2051
|
-
* @eventType wix.pricing_plans.v2.
|
|
2001
|
+
* @eventType wix.pricing_plans.v2.order_marked_as_paid
|
|
2052
2002
|
* @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
|
|
2053
|
-
* @slug
|
|
2003
|
+
* @slug marked_as_paid
|
|
2054
2004
|
*/
|
|
2055
|
-
declare function
|
|
2056
|
-
interface
|
|
2057
|
-
|
|
2005
|
+
declare function onOrderMarkedAsPaid(handler: (event: OrderMarkedAsPaidEnvelope) => void | Promise<void>): void;
|
|
2006
|
+
interface OrderPausedEnvelope {
|
|
2007
|
+
data: OrderPaused;
|
|
2058
2008
|
metadata: EventMetadata;
|
|
2059
2009
|
}
|
|
2060
2010
|
/**
|
|
2061
|
-
* Triggered when an order is
|
|
2011
|
+
* Triggered when an order is paused.
|
|
2062
2012
|
* @permissionScope Manage_Wix_Rentals_App_Forms_submissions
|
|
2063
2013
|
* @permissionScopeId SCOPE.RENTALS.MANAGE
|
|
2064
2014
|
* @permissionScope Manage Orders
|
|
@@ -2071,17 +2021,21 @@ interface OrderCreatedEnvelope {
|
|
|
2071
2021
|
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
2072
2022
|
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
2073
2023
|
* @webhook
|
|
2074
|
-
* @eventType wix.pricing_plans.v2.
|
|
2075
|
-
* @serviceIdentifier com.wixpress.membership.v2.orders.
|
|
2076
|
-
* @slug
|
|
2024
|
+
* @eventType wix.pricing_plans.v2.order_paused
|
|
2025
|
+
* @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
|
|
2026
|
+
* @slug paused
|
|
2077
2027
|
*/
|
|
2078
|
-
declare function
|
|
2079
|
-
interface
|
|
2080
|
-
data:
|
|
2028
|
+
declare function onOrderPaused(handler: (event: OrderPausedEnvelope) => void | Promise<void>): void;
|
|
2029
|
+
interface OrderPurchasedEnvelope {
|
|
2030
|
+
data: OrderPurchased;
|
|
2081
2031
|
metadata: EventMetadata;
|
|
2082
2032
|
}
|
|
2083
2033
|
/**
|
|
2084
|
-
* Triggered
|
|
2034
|
+
* Triggered for any of the following purchase events:
|
|
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.
|
|
2085
2039
|
* @permissionScope Manage_Wix_Rentals_App_Forms_submissions
|
|
2086
2040
|
* @permissionScopeId SCOPE.RENTALS.MANAGE
|
|
2087
2041
|
* @permissionScope Manage Orders
|
|
@@ -2091,188 +2045,60 @@ interface OrderStartDateChangedEnvelope {
|
|
|
2091
2045
|
* @permissionScope Manage plans and orders of Pricing Plans
|
|
2092
2046
|
* @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-PLANS-AND-ORDERS
|
|
2093
2047
|
* @permissionScope Manage Events
|
|
2094
|
-
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
2095
|
-
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
2096
|
-
* @webhook
|
|
2097
|
-
* @eventType wix.pricing_plans.v2.
|
|
2098
|
-
* @serviceIdentifier com.wixpress.membership.v2.orders.
|
|
2099
|
-
* @slug
|
|
2100
|
-
*/
|
|
2101
|
-
declare function onOrderStartDateChanged(handler: (event: OrderStartDateChangedEnvelope) => void | Promise<void>): void;
|
|
2102
|
-
/**
|
|
2103
|
-
* Retrieves an order by ID.
|
|
2104
|
-
* @param _id - Order ID.
|
|
2105
|
-
* @public
|
|
2106
|
-
* @requiredField _id
|
|
2107
|
-
* @param options - Options to use when getting an order.
|
|
2108
|
-
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
2109
|
-
* @applicableIdentity APP
|
|
2110
|
-
* @fqn com.wixpress.membership.v2.orders.OrderManagementService.GetOrder
|
|
2111
|
-
*/
|
|
2112
|
-
declare function managementGetOrder(_id: string, options?: ManagementGetOrderOptions): Promise<NonNullablePaths<GetOrderResponse, `order._id` | `order.planId` | `order.subscriptionId` | `order.buyer.memberId` | `order.buyer.contactId` | `order.priceDetails.subscription.cycleDuration.unit` | `order.priceDetails.subtotal` | `order.priceDetails.discount` | `order.priceDetails.tax.name` | `order.priceDetails.tax.includedInPrice` | `order.priceDetails.tax.rate` | `order.priceDetails.tax.amount` | `order.priceDetails.total` | `order.priceDetails.planPrice` | `order.priceDetails.currency` | `order.priceDetails.coupon.code` | `order.priceDetails.coupon.amount` | `order.priceDetails.coupon._id` | `order.pricing.prices` | `order.pricing.prices.${number}.duration.cycleFrom` | `order.pricing.prices.${number}.price.subtotal` | `order.pricing.prices.${number}.price.discount` | `order.pricing.prices.${number}.price.total` | `order.pricing.prices.${number}.price.currency` | `order.pricing.prices.${number}.price.proration` | `order.type` | `order.status` | `order.cancellation.cause` | `order.cancellation.effectiveAt` | `order.lastPaymentStatus` | `order.pausePeriods` | `order.pausePeriods.${number}.status` | `order.currentCycle.index` | `order.planName` | `order.planDescription` | `order.planPrice`, 7>>;
|
|
2113
|
-
interface ManagementGetOrderOptions {
|
|
2114
|
-
/**
|
|
2115
|
-
* Predefined set of fields to return.
|
|
2116
|
-
*
|
|
2117
|
-
* Default: If `fieldSet` is omitted, no order form submission data is returned.
|
|
2118
|
-
*/
|
|
2119
|
-
fieldSet?: SetWithLiterals;
|
|
2120
|
-
}
|
|
2121
|
-
/**
|
|
2122
|
-
* Retrieves a list of up to 50 pricing plan orders and details, given the specified sorting and filtering.
|
|
2123
|
-
*
|
|
2124
|
-
* By default, this endpoint will retrieve all orders and return them sorted by `createdDate` in `DESC`, descending order.
|
|
2125
|
-
* `sort.fieldName` supports `endDate` and `createdDate` fields and defaults to `ASC`, ascending order.
|
|
2126
|
-
* @public
|
|
2127
|
-
* @param options - Filtering, sorting, and pagination options.
|
|
2128
|
-
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
2129
|
-
* @applicableIdentity APP
|
|
2130
|
-
* @fqn com.wixpress.membership.v2.orders.OrderManagementService.ListOrders
|
|
2131
|
-
*/
|
|
2132
|
-
declare function managementListOrders(options?: ManagementListOrdersOptions): Promise<NonNullablePaths<ListOrdersResponse, `orders` | `orders.${number}._id` | `orders.${number}.planId` | `orders.${number}.subscriptionId` | `orders.${number}.buyer.memberId` | `orders.${number}.buyer.contactId` | `orders.${number}.priceDetails.singlePaymentForDuration.unit` | `orders.${number}.priceDetails.subtotal` | `orders.${number}.priceDetails.discount` | `orders.${number}.priceDetails.tax.name` | `orders.${number}.priceDetails.tax.includedInPrice` | `orders.${number}.priceDetails.tax.rate` | `orders.${number}.priceDetails.tax.amount` | `orders.${number}.priceDetails.total` | `orders.${number}.priceDetails.planPrice` | `orders.${number}.priceDetails.currency` | `orders.${number}.priceDetails.coupon.code` | `orders.${number}.priceDetails.coupon.amount` | `orders.${number}.priceDetails.coupon._id` | `orders.${number}.type` | `orders.${number}.status` | `orders.${number}.cancellation.cause` | `orders.${number}.cancellation.effectiveAt` | `orders.${number}.lastPaymentStatus` | `orders.${number}.currentCycle.index` | `orders.${number}.planName` | `orders.${number}.planDescription` | `orders.${number}.planPrice`, 6>>;
|
|
2133
|
-
interface ManagementListOrdersOptions {
|
|
2134
|
-
/**
|
|
2135
|
-
* Filter by a buyer's member ID, from the Members API.
|
|
2136
|
-
* @format GUID
|
|
2137
|
-
*/
|
|
2138
|
-
buyerIds?: string[];
|
|
2139
|
-
/**
|
|
2140
|
-
* Filter by plan IDs, from the Plans API.
|
|
2141
|
-
* @format GUID
|
|
2142
|
-
*/
|
|
2143
|
-
planIds?: string[];
|
|
2144
|
-
/** Filter by whether or not the auto-renewal of recurring orders was canceled. */
|
|
2145
|
-
autoRenewCanceled?: boolean | null;
|
|
2146
|
-
/** Filter by order status. */
|
|
2147
|
-
orderStatuses?: OrderStatusWithLiterals[];
|
|
2148
|
-
/** Filter by payment status. */
|
|
2149
|
-
paymentStatuses?: PaymentStatusWithLiterals[];
|
|
2150
|
-
/**
|
|
2151
|
-
* Number of orders to return. See Sorting and Paging for more information.
|
|
2152
|
-
*
|
|
2153
|
-
* Max: `50`
|
|
2154
|
-
* @min 1
|
|
2155
|
-
* @max 50
|
|
2156
|
-
*/
|
|
2157
|
-
limit?: number | null;
|
|
2158
|
-
/** Number of orders to skip in the current sort order. */
|
|
2159
|
-
offset?: number | null;
|
|
2160
|
-
/**
|
|
2161
|
-
* Sort order.
|
|
2162
|
-
*
|
|
2163
|
-
* Use `ASC` for ascending order or `DESC` for descending order.
|
|
2164
|
-
*
|
|
2165
|
-
* Default: `DESC`.
|
|
2166
|
-
*/
|
|
2167
|
-
sorting?: Sorting;
|
|
2168
|
-
/**
|
|
2169
|
-
* Predefined set of fields to return.
|
|
2170
|
-
*
|
|
2171
|
-
* Default: If `fieldSet` is omitted, no order form submission data is returned.
|
|
2172
|
-
*/
|
|
2173
|
-
fieldSet?: SetWithLiterals;
|
|
2174
|
-
}
|
|
2175
|
-
/**
|
|
2176
|
-
* 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.
|
|
2177
|
-
*
|
|
2178
|
-
* New `endDate` must be later than the order's current `endDate`. Can't postpone orders that are unlimited.
|
|
2179
|
-
* Can't postpone an order with `status`: `PAUSED`.
|
|
2180
|
-
* @param _id - Order ID.
|
|
2181
|
-
* @param endDate - New end date and time.
|
|
2182
|
-
*
|
|
2183
|
-
* Must be later than the current end date and time.
|
|
2184
|
-
* @public
|
|
2185
|
-
* @requiredField _id
|
|
2186
|
-
* @requiredField endDate
|
|
2187
|
-
* @param options - Options for postponing the end date of an order.
|
|
2188
|
-
* @permissionId PRICING_PLANS.MANAGE_ORDERS
|
|
2189
|
-
* @applicableIdentity APP
|
|
2190
|
-
* @fqn com.wixpress.membership.v2.orders.OrderManagementService.PostponeEndDate
|
|
2191
|
-
*/
|
|
2192
|
-
declare function postponeEndDate(_id: string, endDate: Date): Promise<void>;
|
|
2193
|
-
/**
|
|
2194
|
-
* Cancels an existing order.
|
|
2195
|
-
*
|
|
2196
|
-
* For orders with recurring payments, a cancellation can be set to occur either `IMMEDIATELY` or at the `NEXT_PAYMENT_DATE`.
|
|
2197
|
-
* For orders with one-time payments, a cancellation can only be set for `IMMEDIATELY`.
|
|
2198
|
-
*
|
|
2199
|
-
* #### Canceling during the free trial period.
|
|
2200
|
-
*
|
|
2201
|
-
* When a buyer cancels their order during the free trial period, the buyer's subscription expires at the end
|
|
2202
|
-
* of the free trial period and they will not be billed. The buyer may continue using the benefits until the end
|
|
2203
|
-
* of the free trial period.
|
|
2204
|
-
*
|
|
2205
|
-
* When a Wix user cancels an ordered plan during the free trial period, they choose whether to apply the cancellation
|
|
2206
|
-
* `IMMEDIATELY` or at the `NEXT_PAYMENT_DATE`. Canceling `IMMEDIATELY` will end the subscription for the buyer
|
|
2207
|
-
* immediately, even during the free trial period and the buyer won't be billed. Canceling at the
|
|
2208
|
-
* `NEXT_PAYMENT_DATE` allows the buyer to continue using the benefits of the subscription until the end of the free trial period.
|
|
2209
|
-
* Then, the subscription ends and the buyer is not billed.
|
|
2210
|
-
* @param _id - Order ID.
|
|
2211
|
-
* @param effectiveAt - __Required.__ When the order will be canceled. One-time orders can only be canceled `IMMEDIATELY`.
|
|
2212
|
-
* @public
|
|
2213
|
-
* @requiredField _id
|
|
2214
|
-
* @requiredField effectiveAt
|
|
2215
|
-
* @param options - Options for canceling orders.
|
|
2216
|
-
* @permissionId PRICING_PLANS.MANAGE_ORDERS
|
|
2217
|
-
* @applicableIdentity APP
|
|
2218
|
-
* @fqn com.wixpress.membership.v2.orders.OrderManagementService.CancelOrder
|
|
2219
|
-
*/
|
|
2220
|
-
declare function cancelOrder(_id: string, effectiveAt: CancellationEffectiveAtWithLiterals): Promise<void>;
|
|
2221
|
-
/**
|
|
2222
|
-
* Marks an offline order as paid.
|
|
2223
|
-
* > __Note__: Marking separate payment cycles as paid is not yet supported. The entire order will be marked as paid. Subsequent offline payments do trigger events and emails, but are not registered as additional offline payments.
|
|
2224
|
-
*
|
|
2225
|
-
* Marking an offline order as paid causes the following changes:
|
|
2226
|
-
* - The order's `lastPaymentStatus` changes to `"PAID"`.
|
|
2227
|
-
* - The order's status changes to either `"PENDING"` or `"ACTIVE"`, depending on the order's `startDate`.
|
|
2228
|
-
*
|
|
2229
|
-
* An error occurs if you attempt to:
|
|
2230
|
-
* - Mark an already-paid, offline order as paid. You cannot mark an offline order as paid twice.
|
|
2231
|
-
* - Mark an online order as paid. The Mark as Paid method is supported for offline orders only.
|
|
2232
|
-
* @param _id - Order ID.
|
|
2233
|
-
* @public
|
|
2234
|
-
* @requiredField _id
|
|
2235
|
-
* @permissionId PRICING_PLANS.MANAGE_ORDERS
|
|
2236
|
-
* @applicableIdentity APP
|
|
2237
|
-
* @fqn com.wixpress.membership.v2.orders.OrderManagementService.MarkAsPaid
|
|
2048
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
2049
|
+
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
2050
|
+
* @webhook
|
|
2051
|
+
* @eventType wix.pricing_plans.v2.order_purchased
|
|
2052
|
+
* @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
|
|
2053
|
+
* @slug purchased
|
|
2238
2054
|
*/
|
|
2239
|
-
declare function
|
|
2055
|
+
declare function onOrderPurchased(handler: (event: OrderPurchasedEnvelope) => void | Promise<void>): void;
|
|
2056
|
+
interface OrderResumedEnvelope {
|
|
2057
|
+
data: OrderResumed;
|
|
2058
|
+
metadata: EventMetadata;
|
|
2059
|
+
}
|
|
2240
2060
|
/**
|
|
2241
|
-
*
|
|
2242
|
-
*
|
|
2243
|
-
*
|
|
2244
|
-
*
|
|
2245
|
-
*
|
|
2246
|
-
*
|
|
2247
|
-
*
|
|
2248
|
-
*
|
|
2249
|
-
* @
|
|
2250
|
-
* @
|
|
2251
|
-
* @
|
|
2252
|
-
* @permissionId PRICING_PLANS.
|
|
2253
|
-
* @
|
|
2254
|
-
* @
|
|
2061
|
+
* Triggered when a paused order is resumed.
|
|
2062
|
+
* @permissionScope Manage_Wix_Rentals_App_Forms_submissions
|
|
2063
|
+
* @permissionScopeId SCOPE.RENTALS.MANAGE
|
|
2064
|
+
* @permissionScope Manage Orders
|
|
2065
|
+
* @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
|
|
2066
|
+
* @permissionScope Read Orders
|
|
2067
|
+
* @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS
|
|
2068
|
+
* @permissionScope Manage plans and orders of Pricing Plans
|
|
2069
|
+
* @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-PLANS-AND-ORDERS
|
|
2070
|
+
* @permissionScope Manage Events
|
|
2071
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
2072
|
+
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
2073
|
+
* @webhook
|
|
2074
|
+
* @eventType wix.pricing_plans.v2.order_resumed
|
|
2075
|
+
* @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
|
|
2076
|
+
* @slug resumed
|
|
2255
2077
|
*/
|
|
2256
|
-
declare function
|
|
2078
|
+
declare function onOrderResumed(handler: (event: OrderResumedEnvelope) => void | Promise<void>): void;
|
|
2079
|
+
interface OrderStartedEnvelope {
|
|
2080
|
+
data: OrderStarted;
|
|
2081
|
+
metadata: EventMetadata;
|
|
2082
|
+
}
|
|
2257
2083
|
/**
|
|
2258
|
-
*
|
|
2259
|
-
*
|
|
2260
|
-
*
|
|
2261
|
-
*
|
|
2262
|
-
*
|
|
2263
|
-
*
|
|
2264
|
-
*
|
|
2265
|
-
*
|
|
2266
|
-
*
|
|
2267
|
-
*
|
|
2268
|
-
* @
|
|
2269
|
-
* @
|
|
2270
|
-
* @
|
|
2271
|
-
* @
|
|
2272
|
-
* @
|
|
2273
|
-
* @
|
|
2084
|
+
* Triggered when an order reaches its `startDate`. Applies to both purchased and free orders.
|
|
2085
|
+
* @permissionScope Manage_Wix_Rentals_App_Forms_submissions
|
|
2086
|
+
* @permissionScopeId SCOPE.RENTALS.MANAGE
|
|
2087
|
+
* @permissionScope Manage Orders
|
|
2088
|
+
* @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
|
|
2089
|
+
* @permissionScope Read Orders
|
|
2090
|
+
* @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS
|
|
2091
|
+
* @permissionScope Manage plans and orders of Pricing Plans
|
|
2092
|
+
* @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-PLANS-AND-ORDERS
|
|
2093
|
+
* @permissionScope Manage Events
|
|
2094
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
2095
|
+
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
2096
|
+
* @webhook
|
|
2097
|
+
* @eventType wix.pricing_plans.v2.order_started
|
|
2098
|
+
* @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
|
|
2099
|
+
* @slug started
|
|
2274
2100
|
*/
|
|
2275
|
-
declare function
|
|
2101
|
+
declare function onOrderStarted(handler: (event: OrderStartedEnvelope) => void | Promise<void>): void;
|
|
2276
2102
|
/**
|
|
2277
2103
|
* Creates an online order for a site member.
|
|
2278
2104
|
*
|
|
@@ -2467,6 +2293,180 @@ interface GetPricePreviewOptions {
|
|
|
2467
2293
|
*/
|
|
2468
2294
|
couponCode?: string | null;
|
|
2469
2295
|
}
|
|
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`, 7>>;
|
|
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`, 6>>;
|
|
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
2470
|
/**
|
|
2471
2471
|
* Retrieves an order for the currently logged-in member by ID.
|
|
2472
2472
|
* @param _id - Order ID.
|