@wix/pricing-plans 1.0.72 → 1.0.74
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/package.json +5 -6
- package/type-bundles/context.bundle.d.ts +1287 -826
- package/type-bundles/index.bundle.d.ts +220 -960
- package/type-bundles/meta.bundle.d.ts +316 -1639
@@ -44,7 +44,7 @@ interface Order {
|
|
44
44
|
* @readonly
|
45
45
|
* @deprecated __Deprecated.__ Use `pricing` instead. This property will be removed on September 30, 2022.
|
46
46
|
* @replacedBy pricing
|
47
|
-
* @
|
47
|
+
* @targetRemovalDate 2022-10-01
|
48
48
|
*/
|
49
49
|
priceDetails?: PriceDetails;
|
50
50
|
/**
|
@@ -347,6 +347,12 @@ interface Price {
|
|
347
347
|
/** Price change after billing date was change and price was adjusted. Could be positive and negative values. */
|
348
348
|
proration?: string;
|
349
349
|
}
|
350
|
+
interface Fee$1 {
|
351
|
+
/** Fee name */
|
352
|
+
name?: string;
|
353
|
+
/** Amount of fee to be charged */
|
354
|
+
amount?: string;
|
355
|
+
}
|
350
356
|
declare enum OrderType {
|
351
357
|
UNDEFINED = "UNDEFINED",
|
352
358
|
/** Payments made by the buyer */
|
@@ -356,6 +362,13 @@ declare enum OrderType {
|
|
356
362
|
/** Payments managed externally */
|
357
363
|
EXTERNAL = "EXTERNAL"
|
358
364
|
}
|
365
|
+
declare enum OrderMethod {
|
366
|
+
UNKNOWN = "UNKNOWN",
|
367
|
+
/** Mail Order / Telephone Order transaction */
|
368
|
+
MOTO = "MOTO",
|
369
|
+
/** Point of Sale transaction */
|
370
|
+
POS = "POS"
|
371
|
+
}
|
359
372
|
declare enum OrderStatus {
|
360
373
|
/** Order status undefined */
|
361
374
|
UNDEFINED = "UNDEFINED",
|
@@ -468,6 +481,19 @@ interface CurrentCycle {
|
|
468
481
|
/** End date and time for the current payment cycle. */
|
469
482
|
endedDate?: Date;
|
470
483
|
}
|
484
|
+
/** Order cycle start and end dates take into account free trial days and suspensions */
|
485
|
+
interface OrderCycle {
|
486
|
+
/**
|
487
|
+
* Index of this cycle in the order.
|
488
|
+
*
|
489
|
+
* `0` when order is in a free trial period. In all other cases, the index starts with `1`.
|
490
|
+
*/
|
491
|
+
index?: number;
|
492
|
+
/** Start date and time for this order cycle. */
|
493
|
+
startedDate?: Date;
|
494
|
+
/** End date and time for this order cycle. */
|
495
|
+
endedDate?: Date;
|
496
|
+
}
|
471
497
|
interface FormData {
|
472
498
|
/** ID of the form associated with the plan at checkout. */
|
473
499
|
formId?: string | null;
|
@@ -482,6 +508,80 @@ interface FormData {
|
|
482
508
|
*/
|
483
509
|
submissionData?: Record<string, any>;
|
484
510
|
}
|
511
|
+
interface DomainEvent$1 extends DomainEventBodyOneOf$1 {
|
512
|
+
createdEvent?: EntityCreatedEvent$1;
|
513
|
+
updatedEvent?: EntityUpdatedEvent$1;
|
514
|
+
deletedEvent?: EntityDeletedEvent$1;
|
515
|
+
actionEvent?: ActionEvent$1;
|
516
|
+
/**
|
517
|
+
* Unique event ID.
|
518
|
+
* Allows clients to ignore duplicate webhooks.
|
519
|
+
*/
|
520
|
+
_id?: string;
|
521
|
+
/**
|
522
|
+
* Assumes actions are also always typed to an entity_type
|
523
|
+
* Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
|
524
|
+
*/
|
525
|
+
entityFqdn?: string;
|
526
|
+
/**
|
527
|
+
* This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
|
528
|
+
* This is although the created/updated/deleted notion is duplication of the oneof types
|
529
|
+
* Example: created/updated/deleted/started/completed/email_opened
|
530
|
+
*/
|
531
|
+
slug?: string;
|
532
|
+
/** ID of the entity associated with the event. */
|
533
|
+
entityId?: string;
|
534
|
+
/** Event timestamp. */
|
535
|
+
eventTime?: Date;
|
536
|
+
/**
|
537
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
538
|
+
* (for example, GDPR).
|
539
|
+
*/
|
540
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
541
|
+
/** If present, indicates the action that triggered the event. */
|
542
|
+
originatedFrom?: string | null;
|
543
|
+
/**
|
544
|
+
* A sequence number defining the order of updates to the underlying entity.
|
545
|
+
* For example, given that some entity was updated at 16:00 and than again at 16:01,
|
546
|
+
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
547
|
+
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
548
|
+
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
549
|
+
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
550
|
+
*/
|
551
|
+
entityEventSequence?: string | null;
|
552
|
+
}
|
553
|
+
/** @oneof */
|
554
|
+
interface DomainEventBodyOneOf$1 {
|
555
|
+
createdEvent?: EntityCreatedEvent$1;
|
556
|
+
updatedEvent?: EntityUpdatedEvent$1;
|
557
|
+
deletedEvent?: EntityDeletedEvent$1;
|
558
|
+
actionEvent?: ActionEvent$1;
|
559
|
+
}
|
560
|
+
interface EntityCreatedEvent$1 {
|
561
|
+
entity?: string;
|
562
|
+
}
|
563
|
+
interface EntityUpdatedEvent$1 {
|
564
|
+
/**
|
565
|
+
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
566
|
+
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
567
|
+
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
568
|
+
*/
|
569
|
+
currentEntity?: string;
|
570
|
+
}
|
571
|
+
interface EntityDeletedEvent$1 {
|
572
|
+
/** Entity that was deleted */
|
573
|
+
deletedEntity?: string | null;
|
574
|
+
}
|
575
|
+
interface ActionEvent$1 {
|
576
|
+
body?: string;
|
577
|
+
}
|
578
|
+
interface Empty {
|
579
|
+
}
|
580
|
+
interface MemberGetOrderRequest {
|
581
|
+
/** Order ID. */
|
582
|
+
_id: string;
|
583
|
+
fieldSet?: Set;
|
584
|
+
}
|
485
585
|
declare enum Set {
|
486
586
|
/** Same behavior as BASIC */
|
487
587
|
UNKNOWN_SET = "UNKNOWN_SET",
|
@@ -496,13 +596,34 @@ declare enum Set {
|
|
496
596
|
*/
|
497
597
|
FULL = "FULL"
|
498
598
|
}
|
499
|
-
interface
|
599
|
+
interface MemberGetOrderResponse {
|
600
|
+
/** Requested order. */
|
601
|
+
order?: Order;
|
602
|
+
}
|
603
|
+
interface MemberListOrdersRequest {
|
604
|
+
/** Filter by plan IDs. */
|
605
|
+
planIds?: string[];
|
606
|
+
/** Filter for orders where auto renewal was canceled. */
|
607
|
+
autoRenewCanceled?: boolean | null;
|
608
|
+
/** Filter by order status. */
|
609
|
+
orderStatuses?: OrderStatus[];
|
610
|
+
/** Filter by payment status. */
|
611
|
+
paymentStatuses?: PaymentStatus[];
|
612
|
+
/** Limit the number of pricing plans returned. Default limit is 50. */
|
613
|
+
limit?: number | null;
|
614
|
+
/** Number of entries to offset. */
|
615
|
+
offset?: number | null;
|
616
|
+
/** Sorting direction (defaults to ASC) and field to sort by. [See available fields here](https://dev.wix.com/api/rest/pricing-plans/pricing-plans/order-v2/filter-and-sort). */
|
617
|
+
sorting?: Sorting$1;
|
618
|
+
fieldSet?: Set;
|
619
|
+
}
|
620
|
+
interface Sorting$1 {
|
500
621
|
/** Name of the field to sort by. */
|
501
622
|
fieldName?: string;
|
502
623
|
/** Sort order. */
|
503
|
-
order?: SortOrder;
|
624
|
+
order?: SortOrder$1;
|
504
625
|
}
|
505
|
-
declare enum SortOrder {
|
626
|
+
declare enum SortOrder$1 {
|
506
627
|
ASC = "ASC",
|
507
628
|
DESC = "DESC"
|
508
629
|
}
|
@@ -530,6 +651,82 @@ interface Cursors$1 {
|
|
530
651
|
/** Cursor pointing to the previous page in the list of results. */
|
531
652
|
prev?: string | null;
|
532
653
|
}
|
654
|
+
/**
|
655
|
+
* TODO: Write orders filter and sort docs page
|
656
|
+
* Retrieves a list of up to 1,000 orders, based on the provided paging, [sorting, and filtering](https://dev.wix.com/api/rest/pricing-plans/pricing-plans/order-v2/filter-and-sort).
|
657
|
+
*/
|
658
|
+
interface QueryOrdersRequest {
|
659
|
+
query?: QueryV2$1;
|
660
|
+
}
|
661
|
+
interface QueryV2$1 extends QueryV2PagingMethodOneOf {
|
662
|
+
/** Paging options to limit and skip the number of items. */
|
663
|
+
paging?: Paging$1;
|
664
|
+
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
|
665
|
+
cursorPaging?: CursorPaging;
|
666
|
+
/**
|
667
|
+
* Filter object in the following format:
|
668
|
+
* `"filter" : {
|
669
|
+
* "fieldName1": "value1",
|
670
|
+
* "fieldName2":{"$operator":"value2"}
|
671
|
+
* }`
|
672
|
+
* Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
|
673
|
+
*/
|
674
|
+
filter?: Record<string, any> | null;
|
675
|
+
/**
|
676
|
+
* Sort object in the following format:
|
677
|
+
* `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
|
678
|
+
*/
|
679
|
+
sort?: Sorting$1[];
|
680
|
+
/** Array of projected fields. A list of specific field names to return. If `fieldsets` are also specified, the union of `fieldsets` and `fields` is returned. */
|
681
|
+
fields?: string[];
|
682
|
+
/** Array of named, predefined sets of projected fields. A array of predefined named sets of fields to be returned. Specifying multiple `fieldsets` will return the union of fields from all sets. If `fields` are also specified, the union of `fieldsets` and `fields` is returned. */
|
683
|
+
fieldsets?: string[];
|
684
|
+
}
|
685
|
+
/** @oneof */
|
686
|
+
interface QueryV2PagingMethodOneOf {
|
687
|
+
/** Paging options to limit and skip the number of items. */
|
688
|
+
paging?: Paging$1;
|
689
|
+
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
|
690
|
+
cursorPaging?: CursorPaging;
|
691
|
+
}
|
692
|
+
interface Paging$1 {
|
693
|
+
/** Number of items to load. */
|
694
|
+
limit?: number | null;
|
695
|
+
/** Number of items to skip in the current sort order. */
|
696
|
+
offset?: number | null;
|
697
|
+
}
|
698
|
+
interface CursorPaging {
|
699
|
+
/** Maximum number of items to return in the results. */
|
700
|
+
limit?: number | null;
|
701
|
+
/**
|
702
|
+
* Pointer to the next or previous page in the list of results.
|
703
|
+
*
|
704
|
+
* Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
|
705
|
+
* Not relevant for the first request.
|
706
|
+
*/
|
707
|
+
cursor?: string | null;
|
708
|
+
}
|
709
|
+
interface QueryOrdersResponse {
|
710
|
+
/** Order data. */
|
711
|
+
plans?: Order[];
|
712
|
+
/** Paging-related data (number of orders returned, offset). */
|
713
|
+
pagingMetadata?: PagingMetadataV2$1;
|
714
|
+
}
|
715
|
+
interface RequestCancellationRequest {
|
716
|
+
/** Order ID. */
|
717
|
+
_id: string;
|
718
|
+
/**
|
719
|
+
* Whether to cancel the order immediately or at the next payment date.
|
720
|
+
* One-time payment orders can only be canceled immediately.
|
721
|
+
*
|
722
|
+
* Supported values:
|
723
|
+
* - `"IMMEDIATELY"`: Indicates that the order should be canceled immediately.
|
724
|
+
* - `"NEXT_PAYMENT_DATE"`: Indicates that the order be canceled at the next payment date.
|
725
|
+
*/
|
726
|
+
effectiveAt: CancellationEffectiveAt;
|
727
|
+
}
|
728
|
+
interface RequestCancellationResponse {
|
729
|
+
}
|
533
730
|
/**
|
534
731
|
* Emitted when an order is canceled immediately or when cycle ends for an order with canceled auto renewal
|
535
732
|
*
|
@@ -539,6 +736,16 @@ interface OrderCanceled {
|
|
539
736
|
/** Canceled order. */
|
540
737
|
order?: Order;
|
541
738
|
}
|
739
|
+
interface MessageEnvelope$1 {
|
740
|
+
/** App instance ID. */
|
741
|
+
instanceId?: string | null;
|
742
|
+
/** Event type. */
|
743
|
+
eventType?: string;
|
744
|
+
/** The identification type and identity data. */
|
745
|
+
identity?: IdentificationData$1;
|
746
|
+
/** Stringify payload. */
|
747
|
+
data?: string;
|
748
|
+
}
|
542
749
|
interface IdentificationData$1 extends IdentificationDataIdOneOf$1 {
|
543
750
|
/** ID of a site visitor that has not logged in to the site. */
|
544
751
|
anonymousVisitorId?: string;
|
@@ -569,10 +776,163 @@ declare enum WebhookIdentityType$1 {
|
|
569
776
|
WIX_USER = "WIX_USER",
|
570
777
|
APP = "APP"
|
571
778
|
}
|
779
|
+
interface CreateOnlineOrderRequest {
|
780
|
+
/** Plan ID. */
|
781
|
+
planId?: string;
|
782
|
+
/**
|
783
|
+
* Start date for the ordered plan.
|
784
|
+
*
|
785
|
+
* Default: Current date
|
786
|
+
*/
|
787
|
+
startDate?: Date;
|
788
|
+
/** Coupon code to apply. */
|
789
|
+
couponCode?: string | null;
|
790
|
+
/** Provided if checkout is initiated on buyer's behalf. */
|
791
|
+
onBehalf?: OnBehalf;
|
792
|
+
/** Form submission id that was submitted together with the order */
|
793
|
+
submissionId?: string | null;
|
794
|
+
}
|
795
|
+
interface OnBehalf {
|
796
|
+
/** Member ID. */
|
797
|
+
memberId?: string;
|
798
|
+
/** Method by which checkout is initiated on buyer's behalf */
|
799
|
+
orderMethod?: OrderMethod;
|
800
|
+
}
|
801
|
+
interface CreateOnlineOrderResponse {
|
802
|
+
/** Order. */
|
803
|
+
order?: Order;
|
804
|
+
}
|
805
|
+
interface CouponsError {
|
806
|
+
couponCode?: string;
|
807
|
+
planId?: string;
|
808
|
+
}
|
809
|
+
interface CreateGuestOnlineOrderRequest {
|
810
|
+
/** Plan ID. */
|
811
|
+
planId?: string;
|
812
|
+
/**
|
813
|
+
* Start date for the ordered plan.
|
814
|
+
*
|
815
|
+
* Default: Current date
|
816
|
+
*/
|
817
|
+
startDate?: Date;
|
818
|
+
/** Coupon code to apply. */
|
819
|
+
couponCode?: string | null;
|
820
|
+
/** Captcha data to prove you are not a robot */
|
821
|
+
captcha?: Captcha;
|
822
|
+
/** Visitor info */
|
823
|
+
guest?: Guest;
|
824
|
+
/** Form submission id that was submitted together with the order */
|
825
|
+
submissionId?: string | null;
|
826
|
+
}
|
827
|
+
interface Captcha {
|
828
|
+
/** Token from captcha */
|
829
|
+
token?: string;
|
830
|
+
}
|
831
|
+
interface Guest {
|
832
|
+
/** Email for checkout */
|
833
|
+
email?: string;
|
834
|
+
}
|
835
|
+
interface CreateGuestOnlineOrderResponse {
|
836
|
+
/** Order. */
|
837
|
+
order?: Order;
|
838
|
+
}
|
839
|
+
interface CreateOfflineOrderRequest {
|
840
|
+
/** ID of the plan being ordered. */
|
841
|
+
planId: string;
|
842
|
+
/** ID of the member ordering the plan. */
|
843
|
+
memberId: string;
|
844
|
+
/**
|
845
|
+
* Start date and time for the ordered plan.
|
846
|
+
*
|
847
|
+
* Default: Current date and time
|
848
|
+
*/
|
849
|
+
startDate?: Date;
|
850
|
+
/**
|
851
|
+
* Whether the order is paid.
|
852
|
+
*
|
853
|
+
* Default: `false`
|
854
|
+
*/
|
855
|
+
paid?: boolean | null;
|
856
|
+
/**
|
857
|
+
* Coupon code to apply.
|
858
|
+
*
|
859
|
+
* See [Coupons to learn more](https://dev.wix.com/api/rest/coupons).
|
860
|
+
*/
|
861
|
+
couponCode?: string | null;
|
862
|
+
/** Form submission id that was submitted together with the order */
|
863
|
+
submissionId?: string | null;
|
864
|
+
}
|
572
865
|
interface CreateOfflineOrderResponse {
|
573
866
|
/** Order. */
|
574
867
|
order?: Order;
|
575
868
|
}
|
869
|
+
interface CreateExternalOrderRequest {
|
870
|
+
/** Plan ID. */
|
871
|
+
planId?: string;
|
872
|
+
/** Form submission id that was submitted together with the order */
|
873
|
+
submissionId?: string | null;
|
874
|
+
}
|
875
|
+
interface CreateExternalOrderResponse {
|
876
|
+
/** Created order */
|
877
|
+
order?: Order;
|
878
|
+
}
|
879
|
+
interface GetOnlineOrderPreviewRequest {
|
880
|
+
/** Plan ID. */
|
881
|
+
planId?: string;
|
882
|
+
/**
|
883
|
+
* Start date for the ordered plan.
|
884
|
+
*
|
885
|
+
* Default: Current date
|
886
|
+
*/
|
887
|
+
startDate?: Date;
|
888
|
+
/** Coupon code to apply. */
|
889
|
+
couponCode?: string | null;
|
890
|
+
}
|
891
|
+
interface GetOnlineOrderPreviewResponse {
|
892
|
+
/** Will be missing if limit is exceeded */
|
893
|
+
order?: Order;
|
894
|
+
/**
|
895
|
+
* Whether the purchase limit has already been reached for this plan by this member.
|
896
|
+
* Always false for plans without purchase limits.
|
897
|
+
*/
|
898
|
+
purchaseLimitExceeded?: boolean;
|
899
|
+
}
|
900
|
+
interface GetGuestOnlineOrderPreviewRequest {
|
901
|
+
/** Plan ID. */
|
902
|
+
planId?: string;
|
903
|
+
/**
|
904
|
+
* Start date for the ordered plan.
|
905
|
+
*
|
906
|
+
* Default: Current date
|
907
|
+
*/
|
908
|
+
startDate?: Date;
|
909
|
+
/** Coupon code to apply. */
|
910
|
+
couponCode?: string | null;
|
911
|
+
email?: string;
|
912
|
+
}
|
913
|
+
interface GetGuestOnlineOrderPreviewResponse {
|
914
|
+
/** Will be missing if limit is exceeded */
|
915
|
+
order?: Order;
|
916
|
+
/**
|
917
|
+
* Whether the purchase limit has already been reached for this plan by this email.
|
918
|
+
* Always false for plans without purchase limits.
|
919
|
+
*/
|
920
|
+
purchaseLimitExceeded?: boolean;
|
921
|
+
}
|
922
|
+
interface GetOfflineOrderPreviewRequest {
|
923
|
+
/** ID of the plan of the previewed order. See [Plans for more information about plan IDs](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/plans). */
|
924
|
+
planId: string;
|
925
|
+
/** Member ID of the buyer the previewed order is for. */
|
926
|
+
memberId: string;
|
927
|
+
/**
|
928
|
+
* Start date and time for plan of the previewed order.
|
929
|
+
*
|
930
|
+
* Default: Current date and time
|
931
|
+
*/
|
932
|
+
startDate?: Date;
|
933
|
+
/** Coupon code to apply. See [Coupons to learn more](https://dev.wix.com/api/rest/coupons). */
|
934
|
+
couponCode?: string | null;
|
935
|
+
}
|
576
936
|
interface GetOfflineOrderPreviewResponse {
|
577
937
|
/** The previewed order, as if the plan had been ordered. */
|
578
938
|
order?: Order;
|
@@ -584,22 +944,60 @@ interface GetOfflineOrderPreviewResponse {
|
|
584
944
|
*/
|
585
945
|
purchaseLimitExceeded?: boolean;
|
586
946
|
}
|
947
|
+
interface GetPricePreviewRequest {
|
948
|
+
/** ID of plan to preview. */
|
949
|
+
planId: string;
|
950
|
+
/**
|
951
|
+
* Coupon code to apply.
|
952
|
+
*
|
953
|
+
* See Coupons [to learn more](https://dev.wix.com/api/rest/coupons).
|
954
|
+
*/
|
955
|
+
couponCode?: string | null;
|
956
|
+
}
|
587
957
|
interface GetPricePreviewResponse {
|
588
958
|
/**
|
589
959
|
* @internal
|
590
960
|
* @internal
|
591
961
|
* @deprecated __Deprecated.__ Use `prices` instead. This property will be removed on September 30, 2022.
|
592
962
|
* @replacedBy prices
|
593
|
-
* @
|
963
|
+
* @targetRemovalDate 2022-10-01
|
594
964
|
*/
|
595
965
|
price?: PriceDetails;
|
596
966
|
/** Pricing details. */
|
597
967
|
prices?: SpannedPrice[];
|
598
968
|
}
|
969
|
+
interface ChangeStartDateRequest {
|
970
|
+
/** Draft order ID. */
|
971
|
+
orderId?: string;
|
972
|
+
/** New valid from date (timestamp). */
|
973
|
+
startDate?: Date;
|
974
|
+
}
|
975
|
+
interface ChangeStartDateResponse {
|
976
|
+
/** Updated draft order. */
|
977
|
+
order?: Order;
|
978
|
+
}
|
599
979
|
interface OrderStartDateChanged {
|
600
980
|
/** Order whose `startDate` changed. */
|
601
981
|
order?: Order;
|
602
982
|
}
|
983
|
+
interface ApplyCouponRequest {
|
984
|
+
/** Draft order ID. */
|
985
|
+
orderId?: string;
|
986
|
+
/** Coupon code to apply. */
|
987
|
+
couponCode?: string;
|
988
|
+
}
|
989
|
+
interface ApplyCouponResponse {
|
990
|
+
/** Order with applied coupon and recalculated tax. */
|
991
|
+
order?: Order;
|
992
|
+
}
|
993
|
+
interface SetSubmissionRequest {
|
994
|
+
orderId?: string;
|
995
|
+
submissionId?: string;
|
996
|
+
}
|
997
|
+
interface SetSubmissionResponse {
|
998
|
+
/** Order with submission id */
|
999
|
+
order?: Order;
|
1000
|
+
}
|
603
1001
|
interface OrderPurchased {
|
604
1002
|
/** Order that was paid for. If a free or an offline order, the order that was created. */
|
605
1003
|
order?: Order;
|
@@ -628,513 +1026,322 @@ interface OrderEnded {
|
|
628
1026
|
/** Order that ended. */
|
629
1027
|
order?: Order;
|
630
1028
|
}
|
1029
|
+
interface GetOrderRequest {
|
1030
|
+
/** Order ID. */
|
1031
|
+
_id: string;
|
1032
|
+
fieldSet?: Set;
|
1033
|
+
}
|
631
1034
|
interface GetOrderResponse {
|
632
1035
|
/** Order. */
|
633
1036
|
order?: Order;
|
634
1037
|
}
|
1038
|
+
interface ListOrdersRequest {
|
1039
|
+
/** Filter by a buyer's member ID. See [Members to learn more about a site's members](https://dev.wix.com/api/rest/members/members). */
|
1040
|
+
buyerIds?: string[];
|
1041
|
+
/** Filter by plan IDs. See [Plans to learn more about pricing plans](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/plans). */
|
1042
|
+
planIds?: string[];
|
1043
|
+
/** Filter by whether or not the auto-renewal of recurring orders was canceled. */
|
1044
|
+
autoRenewCanceled?: boolean | null;
|
1045
|
+
/** Filter by order status. */
|
1046
|
+
orderStatuses?: OrderStatus[];
|
1047
|
+
/** Filter by payment status. */
|
1048
|
+
paymentStatuses?: PaymentStatus[];
|
1049
|
+
/**
|
1050
|
+
* Number of orders to return. See [Pagination](https://dev.wix.com/api/rest/getting-started/sorting-and-paging#getting-started_sorting-and-paging_paging) for more information.
|
1051
|
+
*
|
1052
|
+
* Max: `50`
|
1053
|
+
*/
|
1054
|
+
limit?: number | null;
|
1055
|
+
/** Number of orders to skip in the current sort order. */
|
1056
|
+
offset?: number | null;
|
1057
|
+
/**
|
1058
|
+
* Sort order.
|
1059
|
+
*
|
1060
|
+
* Use `ASC` for ascending order or `DESC` for descending order.
|
1061
|
+
*
|
1062
|
+
* Default: `DESC`
|
1063
|
+
*/
|
1064
|
+
sorting?: Sorting$1;
|
1065
|
+
/** Parameter to define amount of fields to return. FULL returns each order's submission data. Supported values: UNKNOWN_SET, BASIC, FULL */
|
1066
|
+
fieldSet?: Set;
|
1067
|
+
}
|
635
1068
|
interface ListOrdersResponse {
|
636
1069
|
/** List of orders. */
|
637
1070
|
orders?: Order[];
|
638
1071
|
/** Object containing paging-related data (number of orders returned, offset). */
|
639
1072
|
pagingMetadata?: PagingMetadataV2$1;
|
640
1073
|
}
|
1074
|
+
interface OrdersQueryOrdersRequest {
|
1075
|
+
/** [See available fields here](https://dev.wix.com/api/rest/pricing-plans/pricing-plans/order-v2/filter-and-sort). */
|
1076
|
+
query?: QueryV2$1;
|
1077
|
+
}
|
1078
|
+
interface OrdersQueryOrdersResponse {
|
1079
|
+
/** Retrieved orders. */
|
1080
|
+
plans?: Order[];
|
1081
|
+
/** Paging-related data (number of orders returned, offset). */
|
1082
|
+
pagingMetadata?: PagingMetadataV2$1;
|
1083
|
+
}
|
1084
|
+
interface GetOrdersStatsRequest {
|
1085
|
+
}
|
1086
|
+
interface GetOrdersStatsResponse {
|
1087
|
+
/** Total number of orders. */
|
1088
|
+
totalOrderCount?: number;
|
1089
|
+
/** Number of active orders. */
|
1090
|
+
activeOrderCount?: number;
|
1091
|
+
}
|
1092
|
+
interface GetAvailableOrderActionsRequest {
|
1093
|
+
/** Order ID. */
|
1094
|
+
_id?: string;
|
1095
|
+
}
|
1096
|
+
interface GetAvailableOrderActionsResponse {
|
1097
|
+
/** Whether the order can be suspended. */
|
1098
|
+
suspendable?: boolean;
|
1099
|
+
/** If the order cannot be suspended, a reason is returned here. */
|
1100
|
+
notSuspendableReason?: ReasonNotSuspendable;
|
1101
|
+
/** Whether the order can be canceled by the buyer. */
|
1102
|
+
cancelableByBuyer?: boolean;
|
1103
|
+
}
|
1104
|
+
declare enum ReasonNotSuspendable {
|
1105
|
+
/** Reason unknown */
|
1106
|
+
UNDEFINED = "UNDEFINED",
|
1107
|
+
/** Saved in the database but is awaiting payment. Non-active orders cannot be suspended */
|
1108
|
+
PENDING = "PENDING",
|
1109
|
+
/** Trial orders cannot be suspended */
|
1110
|
+
TRIAL = "TRIAL",
|
1111
|
+
/** Canceled orders cannot be suspended */
|
1112
|
+
CANCELED = "CANCELED",
|
1113
|
+
/** Ended orders cannot be suspended */
|
1114
|
+
ENDED = "ENDED",
|
1115
|
+
/** Paid for orders with future start dates cannot be suspended */
|
1116
|
+
NOT_STARTED = "NOT_STARTED",
|
1117
|
+
/** Order is already suspended */
|
1118
|
+
ALREADY_SUSPENDED = "ALREADY_SUSPENDED",
|
1119
|
+
/** Orders based on recurring payments using older Stripe versions cannot be suspended */
|
1120
|
+
OLD_STRIPE = "OLD_STRIPE"
|
1121
|
+
}
|
1122
|
+
interface PostponeEndDateRequest {
|
1123
|
+
/** Order ID. */
|
1124
|
+
_id: string;
|
1125
|
+
/**
|
1126
|
+
* New end date and time.
|
1127
|
+
*
|
1128
|
+
* Must be later than the current end date and time.
|
1129
|
+
*/
|
1130
|
+
endDate: Date;
|
1131
|
+
}
|
1132
|
+
interface PostponeEndDateResponse {
|
1133
|
+
}
|
641
1134
|
interface OrderEndDatePostponed {
|
642
1135
|
/** Order whose `endDate` was postponed. */
|
643
1136
|
order?: Order;
|
644
1137
|
}
|
1138
|
+
interface CancelOrderRequest {
|
1139
|
+
/** Order ID. */
|
1140
|
+
_id: string;
|
1141
|
+
/**
|
1142
|
+
* When the order is canceled.
|
1143
|
+
*
|
1144
|
+
* One time orders can only be canceled immediately. Supported values:
|
1145
|
+
* - `"IMMEDIATELY"`: The order is canceled immediately.
|
1146
|
+
* - `"NEXT_PAYMENT_DATE"`: The order is canceled at the next payment date.
|
1147
|
+
*/
|
1148
|
+
effectiveAt: CancellationEffectiveAt;
|
1149
|
+
}
|
1150
|
+
interface CancelOrderResponse {
|
1151
|
+
}
|
1152
|
+
interface MarkAsPaidRequest {
|
1153
|
+
/** Order ID. */
|
1154
|
+
_id: string;
|
1155
|
+
}
|
1156
|
+
interface MarkAsPaidResponse {
|
1157
|
+
}
|
645
1158
|
interface OrderMarkedAsPaid {
|
646
1159
|
/** Order that was marked as paid. */
|
647
1160
|
order?: Order;
|
648
1161
|
}
|
1162
|
+
interface PauseOrderRequest {
|
1163
|
+
/** Order ID. */
|
1164
|
+
_id: string;
|
1165
|
+
}
|
1166
|
+
interface PauseOrderResponse {
|
1167
|
+
}
|
649
1168
|
interface OrderPaused {
|
650
1169
|
/** Paused order. */
|
651
1170
|
order?: Order;
|
652
1171
|
}
|
1172
|
+
interface BulkPauseOrderRequest {
|
1173
|
+
/** List of Order IDs. */
|
1174
|
+
ids?: string[];
|
1175
|
+
/** Set to true to return Order entity in response. */
|
1176
|
+
returnFullEntity?: boolean;
|
1177
|
+
}
|
1178
|
+
interface BulkPauseOrderResponse {
|
1179
|
+
results?: BulkOrderResult[];
|
1180
|
+
bulkActionMetadata?: BulkActionMetadata$1;
|
1181
|
+
}
|
1182
|
+
interface BulkOrderResult {
|
1183
|
+
itemMetadata?: ItemMetadata$1;
|
1184
|
+
order?: Order;
|
1185
|
+
}
|
1186
|
+
interface ItemMetadata$1 {
|
1187
|
+
/** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
|
1188
|
+
_id?: string | null;
|
1189
|
+
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
1190
|
+
originalIndex?: number;
|
1191
|
+
/** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
|
1192
|
+
success?: boolean;
|
1193
|
+
/** Details about the error in case of failure. */
|
1194
|
+
error?: ApplicationError$1;
|
1195
|
+
}
|
1196
|
+
interface ApplicationError$1 {
|
1197
|
+
/** Error code. */
|
1198
|
+
code?: string;
|
1199
|
+
/** Description of the error. */
|
1200
|
+
description?: string;
|
1201
|
+
/** Data related to the error. */
|
1202
|
+
data?: Record<string, any> | null;
|
1203
|
+
}
|
1204
|
+
interface BulkActionMetadata$1 {
|
1205
|
+
/** Number of items that were successfully processed. */
|
1206
|
+
totalSuccesses?: number;
|
1207
|
+
/** Number of items that couldn't be processed. */
|
1208
|
+
totalFailures?: number;
|
1209
|
+
/** Number of failures without details because detailed failure threshold was exceeded. */
|
1210
|
+
undetailedFailures?: number;
|
1211
|
+
}
|
1212
|
+
interface ResumeOrderRequest {
|
1213
|
+
/** Order ID. */
|
1214
|
+
_id: string;
|
1215
|
+
}
|
1216
|
+
interface ResumeOrderResponse {
|
1217
|
+
}
|
653
1218
|
interface OrderResumed {
|
654
1219
|
/** Resumed order. */
|
655
1220
|
order?: Order;
|
656
1221
|
}
|
1222
|
+
interface BulkResumeOrderRequest {
|
1223
|
+
/** List of Order IDs. */
|
1224
|
+
ids?: string[];
|
1225
|
+
/** Set to true to return Order entity in response. */
|
1226
|
+
returnFullEntity?: boolean;
|
1227
|
+
}
|
1228
|
+
interface BulkResumeOrderResponse {
|
1229
|
+
results?: BulkOrderResult[];
|
1230
|
+
bulkActionMetadata?: BulkActionMetadata$1;
|
1231
|
+
}
|
1232
|
+
interface BuyerNonNullableFields {
|
1233
|
+
memberId: string;
|
1234
|
+
contactId: string;
|
1235
|
+
}
|
1236
|
+
interface DurationNonNullableFields$1 {
|
1237
|
+
unit: PeriodUnit$1;
|
1238
|
+
}
|
1239
|
+
interface RecurrenceNonNullableFields$1 {
|
1240
|
+
cycleDuration?: DurationNonNullableFields$1;
|
1241
|
+
}
|
1242
|
+
interface TaxNonNullableFields {
|
1243
|
+
name: string;
|
1244
|
+
includedInPrice: boolean;
|
1245
|
+
rate: string;
|
1246
|
+
amount: string;
|
1247
|
+
}
|
1248
|
+
interface CouponNonNullableFields {
|
1249
|
+
code: string;
|
1250
|
+
amount: string;
|
1251
|
+
_id: string;
|
1252
|
+
}
|
1253
|
+
interface PriceDetailsNonNullableFields {
|
1254
|
+
subscription?: RecurrenceNonNullableFields$1;
|
1255
|
+
singlePaymentForDuration?: DurationNonNullableFields$1;
|
1256
|
+
subtotal: string;
|
1257
|
+
discount: string;
|
1258
|
+
tax?: TaxNonNullableFields;
|
1259
|
+
total: string;
|
1260
|
+
planPrice: string;
|
1261
|
+
currency: string;
|
1262
|
+
coupon?: CouponNonNullableFields;
|
1263
|
+
}
|
1264
|
+
interface PriceDurationNonNullableFields {
|
1265
|
+
cycleFrom: number;
|
1266
|
+
}
|
1267
|
+
interface FeeNonNullableFields$1 {
|
1268
|
+
name: string;
|
1269
|
+
amount: string;
|
1270
|
+
}
|
1271
|
+
interface PriceNonNullableFields {
|
1272
|
+
subtotal: string;
|
1273
|
+
coupon?: CouponNonNullableFields;
|
1274
|
+
discount: string;
|
1275
|
+
tax?: TaxNonNullableFields;
|
1276
|
+
total: string;
|
1277
|
+
currency: string;
|
1278
|
+
fees: FeeNonNullableFields$1[];
|
1279
|
+
proration: string;
|
1280
|
+
}
|
1281
|
+
interface SpannedPriceNonNullableFields {
|
1282
|
+
duration?: PriceDurationNonNullableFields;
|
1283
|
+
price?: PriceNonNullableFields;
|
1284
|
+
}
|
1285
|
+
interface PricingDetailsNonNullableFields {
|
1286
|
+
subscription?: RecurrenceNonNullableFields$1;
|
1287
|
+
singlePaymentForDuration?: DurationNonNullableFields$1;
|
1288
|
+
prices: SpannedPriceNonNullableFields[];
|
1289
|
+
}
|
1290
|
+
interface CancellationNonNullableFields {
|
1291
|
+
cause: CancellationCause;
|
1292
|
+
effectiveAt: CancellationEffectiveAt;
|
1293
|
+
}
|
1294
|
+
interface PausePeriodNonNullableFields {
|
1295
|
+
status: Status;
|
1296
|
+
}
|
1297
|
+
interface CurrentCycleNonNullableFields {
|
1298
|
+
index: number;
|
1299
|
+
}
|
1300
|
+
interface OrderCycleNonNullableFields {
|
1301
|
+
index: number;
|
1302
|
+
}
|
1303
|
+
interface OrderNonNullableFields {
|
1304
|
+
_id: string;
|
1305
|
+
planId: string;
|
1306
|
+
subscriptionId: string;
|
1307
|
+
buyer?: BuyerNonNullableFields;
|
1308
|
+
priceDetails?: PriceDetailsNonNullableFields;
|
1309
|
+
pricing?: PricingDetailsNonNullableFields;
|
1310
|
+
type: OrderType;
|
1311
|
+
orderMethod: OrderMethod;
|
1312
|
+
status: OrderStatus;
|
1313
|
+
cancellation?: CancellationNonNullableFields;
|
1314
|
+
lastPaymentStatus: PaymentStatus;
|
1315
|
+
pausePeriods: PausePeriodNonNullableFields[];
|
1316
|
+
currentCycle?: CurrentCycleNonNullableFields;
|
1317
|
+
cycles: OrderCycleNonNullableFields[];
|
1318
|
+
planName: string;
|
1319
|
+
planDescription: string;
|
1320
|
+
planPrice: string;
|
1321
|
+
statusNew: OrderStatus;
|
1322
|
+
}
|
1323
|
+
interface MemberGetOrderResponseNonNullableFields {
|
1324
|
+
order?: OrderNonNullableFields;
|
1325
|
+
}
|
657
1326
|
interface MemberListOrdersResponseNonNullableFields {
|
658
|
-
orders:
|
659
|
-
_id: string;
|
660
|
-
planId: string;
|
661
|
-
subscriptionId: string;
|
662
|
-
buyer?: {
|
663
|
-
memberId: string;
|
664
|
-
contactId: string;
|
665
|
-
};
|
666
|
-
priceDetails?: {
|
667
|
-
subscription?: {
|
668
|
-
cycleDuration?: {
|
669
|
-
unit: PeriodUnit$1;
|
670
|
-
};
|
671
|
-
};
|
672
|
-
singlePaymentForDuration?: {
|
673
|
-
unit: PeriodUnit$1;
|
674
|
-
};
|
675
|
-
subtotal: string;
|
676
|
-
discount: string;
|
677
|
-
tax?: {
|
678
|
-
name: string;
|
679
|
-
includedInPrice: boolean;
|
680
|
-
rate: string;
|
681
|
-
amount: string;
|
682
|
-
};
|
683
|
-
total: string;
|
684
|
-
planPrice: string;
|
685
|
-
currency: string;
|
686
|
-
coupon?: {
|
687
|
-
code: string;
|
688
|
-
amount: string;
|
689
|
-
_id: string;
|
690
|
-
};
|
691
|
-
};
|
692
|
-
pricing?: {
|
693
|
-
subscription?: {
|
694
|
-
cycleDuration?: {
|
695
|
-
unit: PeriodUnit$1;
|
696
|
-
};
|
697
|
-
};
|
698
|
-
singlePaymentForDuration?: {
|
699
|
-
unit: PeriodUnit$1;
|
700
|
-
};
|
701
|
-
prices: {
|
702
|
-
duration?: {
|
703
|
-
cycleFrom: number;
|
704
|
-
};
|
705
|
-
price?: {
|
706
|
-
subtotal: string;
|
707
|
-
coupon?: {
|
708
|
-
code: string;
|
709
|
-
amount: string;
|
710
|
-
_id: string;
|
711
|
-
};
|
712
|
-
discount: string;
|
713
|
-
tax?: {
|
714
|
-
name: string;
|
715
|
-
includedInPrice: boolean;
|
716
|
-
rate: string;
|
717
|
-
amount: string;
|
718
|
-
};
|
719
|
-
total: string;
|
720
|
-
currency: string;
|
721
|
-
proration: string;
|
722
|
-
};
|
723
|
-
}[];
|
724
|
-
};
|
725
|
-
type: OrderType;
|
726
|
-
status: OrderStatus;
|
727
|
-
cancellation?: {
|
728
|
-
cause: CancellationCause;
|
729
|
-
effectiveAt: CancellationEffectiveAt;
|
730
|
-
};
|
731
|
-
lastPaymentStatus: PaymentStatus;
|
732
|
-
pausePeriods: {
|
733
|
-
status: Status;
|
734
|
-
}[];
|
735
|
-
currentCycle?: {
|
736
|
-
index: number;
|
737
|
-
};
|
738
|
-
planName: string;
|
739
|
-
planDescription: string;
|
740
|
-
planPrice: string;
|
741
|
-
}[];
|
1327
|
+
orders: OrderNonNullableFields[];
|
742
1328
|
}
|
743
1329
|
interface CreateOfflineOrderResponseNonNullableFields {
|
744
|
-
order?:
|
745
|
-
_id: string;
|
746
|
-
planId: string;
|
747
|
-
subscriptionId: string;
|
748
|
-
buyer?: {
|
749
|
-
memberId: string;
|
750
|
-
contactId: string;
|
751
|
-
};
|
752
|
-
priceDetails?: {
|
753
|
-
subscription?: {
|
754
|
-
cycleDuration?: {
|
755
|
-
unit: PeriodUnit$1;
|
756
|
-
};
|
757
|
-
};
|
758
|
-
singlePaymentForDuration?: {
|
759
|
-
unit: PeriodUnit$1;
|
760
|
-
};
|
761
|
-
subtotal: string;
|
762
|
-
discount: string;
|
763
|
-
tax?: {
|
764
|
-
name: string;
|
765
|
-
includedInPrice: boolean;
|
766
|
-
rate: string;
|
767
|
-
amount: string;
|
768
|
-
};
|
769
|
-
total: string;
|
770
|
-
planPrice: string;
|
771
|
-
currency: string;
|
772
|
-
coupon?: {
|
773
|
-
code: string;
|
774
|
-
amount: string;
|
775
|
-
_id: string;
|
776
|
-
};
|
777
|
-
};
|
778
|
-
pricing?: {
|
779
|
-
subscription?: {
|
780
|
-
cycleDuration?: {
|
781
|
-
unit: PeriodUnit$1;
|
782
|
-
};
|
783
|
-
};
|
784
|
-
singlePaymentForDuration?: {
|
785
|
-
unit: PeriodUnit$1;
|
786
|
-
};
|
787
|
-
prices: {
|
788
|
-
duration?: {
|
789
|
-
cycleFrom: number;
|
790
|
-
};
|
791
|
-
price?: {
|
792
|
-
subtotal: string;
|
793
|
-
coupon?: {
|
794
|
-
code: string;
|
795
|
-
amount: string;
|
796
|
-
_id: string;
|
797
|
-
};
|
798
|
-
discount: string;
|
799
|
-
tax?: {
|
800
|
-
name: string;
|
801
|
-
includedInPrice: boolean;
|
802
|
-
rate: string;
|
803
|
-
amount: string;
|
804
|
-
};
|
805
|
-
total: string;
|
806
|
-
currency: string;
|
807
|
-
proration: string;
|
808
|
-
};
|
809
|
-
}[];
|
810
|
-
};
|
811
|
-
type: OrderType;
|
812
|
-
status: OrderStatus;
|
813
|
-
cancellation?: {
|
814
|
-
cause: CancellationCause;
|
815
|
-
effectiveAt: CancellationEffectiveAt;
|
816
|
-
};
|
817
|
-
lastPaymentStatus: PaymentStatus;
|
818
|
-
pausePeriods: {
|
819
|
-
status: Status;
|
820
|
-
}[];
|
821
|
-
currentCycle?: {
|
822
|
-
index: number;
|
823
|
-
};
|
824
|
-
planName: string;
|
825
|
-
planDescription: string;
|
826
|
-
planPrice: string;
|
827
|
-
};
|
1330
|
+
order?: OrderNonNullableFields;
|
828
1331
|
}
|
829
1332
|
interface GetOfflineOrderPreviewResponseNonNullableFields {
|
830
|
-
order?:
|
831
|
-
_id: string;
|
832
|
-
planId: string;
|
833
|
-
subscriptionId: string;
|
834
|
-
buyer?: {
|
835
|
-
memberId: string;
|
836
|
-
contactId: string;
|
837
|
-
};
|
838
|
-
priceDetails?: {
|
839
|
-
subscription?: {
|
840
|
-
cycleDuration?: {
|
841
|
-
unit: PeriodUnit$1;
|
842
|
-
};
|
843
|
-
};
|
844
|
-
singlePaymentForDuration?: {
|
845
|
-
unit: PeriodUnit$1;
|
846
|
-
};
|
847
|
-
subtotal: string;
|
848
|
-
discount: string;
|
849
|
-
tax?: {
|
850
|
-
name: string;
|
851
|
-
includedInPrice: boolean;
|
852
|
-
rate: string;
|
853
|
-
amount: string;
|
854
|
-
};
|
855
|
-
total: string;
|
856
|
-
planPrice: string;
|
857
|
-
currency: string;
|
858
|
-
coupon?: {
|
859
|
-
code: string;
|
860
|
-
amount: string;
|
861
|
-
_id: string;
|
862
|
-
};
|
863
|
-
};
|
864
|
-
pricing?: {
|
865
|
-
subscription?: {
|
866
|
-
cycleDuration?: {
|
867
|
-
unit: PeriodUnit$1;
|
868
|
-
};
|
869
|
-
};
|
870
|
-
singlePaymentForDuration?: {
|
871
|
-
unit: PeriodUnit$1;
|
872
|
-
};
|
873
|
-
prices: {
|
874
|
-
duration?: {
|
875
|
-
cycleFrom: number;
|
876
|
-
};
|
877
|
-
price?: {
|
878
|
-
subtotal: string;
|
879
|
-
coupon?: {
|
880
|
-
code: string;
|
881
|
-
amount: string;
|
882
|
-
_id: string;
|
883
|
-
};
|
884
|
-
discount: string;
|
885
|
-
tax?: {
|
886
|
-
name: string;
|
887
|
-
includedInPrice: boolean;
|
888
|
-
rate: string;
|
889
|
-
amount: string;
|
890
|
-
};
|
891
|
-
total: string;
|
892
|
-
currency: string;
|
893
|
-
proration: string;
|
894
|
-
};
|
895
|
-
}[];
|
896
|
-
};
|
897
|
-
type: OrderType;
|
898
|
-
status: OrderStatus;
|
899
|
-
cancellation?: {
|
900
|
-
cause: CancellationCause;
|
901
|
-
effectiveAt: CancellationEffectiveAt;
|
902
|
-
};
|
903
|
-
lastPaymentStatus: PaymentStatus;
|
904
|
-
pausePeriods: {
|
905
|
-
status: Status;
|
906
|
-
}[];
|
907
|
-
currentCycle?: {
|
908
|
-
index: number;
|
909
|
-
};
|
910
|
-
planName: string;
|
911
|
-
planDescription: string;
|
912
|
-
planPrice: string;
|
913
|
-
};
|
1333
|
+
order?: OrderNonNullableFields;
|
914
1334
|
purchaseLimitExceeded: boolean;
|
915
1335
|
}
|
916
1336
|
interface GetPricePreviewResponseNonNullableFields {
|
917
|
-
price?:
|
918
|
-
|
919
|
-
cycleDuration?: {
|
920
|
-
unit: PeriodUnit$1;
|
921
|
-
};
|
922
|
-
};
|
923
|
-
singlePaymentForDuration?: {
|
924
|
-
unit: PeriodUnit$1;
|
925
|
-
};
|
926
|
-
subtotal: string;
|
927
|
-
discount: string;
|
928
|
-
tax?: {
|
929
|
-
name: string;
|
930
|
-
includedInPrice: boolean;
|
931
|
-
rate: string;
|
932
|
-
amount: string;
|
933
|
-
};
|
934
|
-
total: string;
|
935
|
-
planPrice: string;
|
936
|
-
currency: string;
|
937
|
-
coupon?: {
|
938
|
-
code: string;
|
939
|
-
amount: string;
|
940
|
-
_id: string;
|
941
|
-
};
|
942
|
-
};
|
943
|
-
prices: {
|
944
|
-
duration?: {
|
945
|
-
cycleFrom: number;
|
946
|
-
};
|
947
|
-
price?: {
|
948
|
-
subtotal: string;
|
949
|
-
coupon?: {
|
950
|
-
code: string;
|
951
|
-
amount: string;
|
952
|
-
_id: string;
|
953
|
-
};
|
954
|
-
discount: string;
|
955
|
-
tax?: {
|
956
|
-
name: string;
|
957
|
-
includedInPrice: boolean;
|
958
|
-
rate: string;
|
959
|
-
amount: string;
|
960
|
-
};
|
961
|
-
total: string;
|
962
|
-
currency: string;
|
963
|
-
proration: string;
|
964
|
-
};
|
965
|
-
}[];
|
1337
|
+
price?: PriceDetailsNonNullableFields;
|
1338
|
+
prices: SpannedPriceNonNullableFields[];
|
966
1339
|
}
|
967
1340
|
interface GetOrderResponseNonNullableFields {
|
968
|
-
order?:
|
969
|
-
_id: string;
|
970
|
-
planId: string;
|
971
|
-
subscriptionId: string;
|
972
|
-
buyer?: {
|
973
|
-
memberId: string;
|
974
|
-
contactId: string;
|
975
|
-
};
|
976
|
-
priceDetails?: {
|
977
|
-
subscription?: {
|
978
|
-
cycleDuration?: {
|
979
|
-
unit: PeriodUnit$1;
|
980
|
-
};
|
981
|
-
};
|
982
|
-
singlePaymentForDuration?: {
|
983
|
-
unit: PeriodUnit$1;
|
984
|
-
};
|
985
|
-
subtotal: string;
|
986
|
-
discount: string;
|
987
|
-
tax?: {
|
988
|
-
name: string;
|
989
|
-
includedInPrice: boolean;
|
990
|
-
rate: string;
|
991
|
-
amount: string;
|
992
|
-
};
|
993
|
-
total: string;
|
994
|
-
planPrice: string;
|
995
|
-
currency: string;
|
996
|
-
coupon?: {
|
997
|
-
code: string;
|
998
|
-
amount: string;
|
999
|
-
_id: string;
|
1000
|
-
};
|
1001
|
-
};
|
1002
|
-
pricing?: {
|
1003
|
-
subscription?: {
|
1004
|
-
cycleDuration?: {
|
1005
|
-
unit: PeriodUnit$1;
|
1006
|
-
};
|
1007
|
-
};
|
1008
|
-
singlePaymentForDuration?: {
|
1009
|
-
unit: PeriodUnit$1;
|
1010
|
-
};
|
1011
|
-
prices: {
|
1012
|
-
duration?: {
|
1013
|
-
cycleFrom: number;
|
1014
|
-
};
|
1015
|
-
price?: {
|
1016
|
-
subtotal: string;
|
1017
|
-
coupon?: {
|
1018
|
-
code: string;
|
1019
|
-
amount: string;
|
1020
|
-
_id: string;
|
1021
|
-
};
|
1022
|
-
discount: string;
|
1023
|
-
tax?: {
|
1024
|
-
name: string;
|
1025
|
-
includedInPrice: boolean;
|
1026
|
-
rate: string;
|
1027
|
-
amount: string;
|
1028
|
-
};
|
1029
|
-
total: string;
|
1030
|
-
currency: string;
|
1031
|
-
proration: string;
|
1032
|
-
};
|
1033
|
-
}[];
|
1034
|
-
};
|
1035
|
-
type: OrderType;
|
1036
|
-
status: OrderStatus;
|
1037
|
-
cancellation?: {
|
1038
|
-
cause: CancellationCause;
|
1039
|
-
effectiveAt: CancellationEffectiveAt;
|
1040
|
-
};
|
1041
|
-
lastPaymentStatus: PaymentStatus;
|
1042
|
-
pausePeriods: {
|
1043
|
-
status: Status;
|
1044
|
-
}[];
|
1045
|
-
currentCycle?: {
|
1046
|
-
index: number;
|
1047
|
-
};
|
1048
|
-
planName: string;
|
1049
|
-
planDescription: string;
|
1050
|
-
planPrice: string;
|
1051
|
-
};
|
1341
|
+
order?: OrderNonNullableFields;
|
1052
1342
|
}
|
1053
1343
|
interface ListOrdersResponseNonNullableFields {
|
1054
|
-
orders:
|
1055
|
-
_id: string;
|
1056
|
-
planId: string;
|
1057
|
-
subscriptionId: string;
|
1058
|
-
buyer?: {
|
1059
|
-
memberId: string;
|
1060
|
-
contactId: string;
|
1061
|
-
};
|
1062
|
-
priceDetails?: {
|
1063
|
-
subscription?: {
|
1064
|
-
cycleDuration?: {
|
1065
|
-
unit: PeriodUnit$1;
|
1066
|
-
};
|
1067
|
-
};
|
1068
|
-
singlePaymentForDuration?: {
|
1069
|
-
unit: PeriodUnit$1;
|
1070
|
-
};
|
1071
|
-
subtotal: string;
|
1072
|
-
discount: string;
|
1073
|
-
tax?: {
|
1074
|
-
name: string;
|
1075
|
-
includedInPrice: boolean;
|
1076
|
-
rate: string;
|
1077
|
-
amount: string;
|
1078
|
-
};
|
1079
|
-
total: string;
|
1080
|
-
planPrice: string;
|
1081
|
-
currency: string;
|
1082
|
-
coupon?: {
|
1083
|
-
code: string;
|
1084
|
-
amount: string;
|
1085
|
-
_id: string;
|
1086
|
-
};
|
1087
|
-
};
|
1088
|
-
pricing?: {
|
1089
|
-
subscription?: {
|
1090
|
-
cycleDuration?: {
|
1091
|
-
unit: PeriodUnit$1;
|
1092
|
-
};
|
1093
|
-
};
|
1094
|
-
singlePaymentForDuration?: {
|
1095
|
-
unit: PeriodUnit$1;
|
1096
|
-
};
|
1097
|
-
prices: {
|
1098
|
-
duration?: {
|
1099
|
-
cycleFrom: number;
|
1100
|
-
};
|
1101
|
-
price?: {
|
1102
|
-
subtotal: string;
|
1103
|
-
coupon?: {
|
1104
|
-
code: string;
|
1105
|
-
amount: string;
|
1106
|
-
_id: string;
|
1107
|
-
};
|
1108
|
-
discount: string;
|
1109
|
-
tax?: {
|
1110
|
-
name: string;
|
1111
|
-
includedInPrice: boolean;
|
1112
|
-
rate: string;
|
1113
|
-
amount: string;
|
1114
|
-
};
|
1115
|
-
total: string;
|
1116
|
-
currency: string;
|
1117
|
-
proration: string;
|
1118
|
-
};
|
1119
|
-
}[];
|
1120
|
-
};
|
1121
|
-
type: OrderType;
|
1122
|
-
status: OrderStatus;
|
1123
|
-
cancellation?: {
|
1124
|
-
cause: CancellationCause;
|
1125
|
-
effectiveAt: CancellationEffectiveAt;
|
1126
|
-
};
|
1127
|
-
lastPaymentStatus: PaymentStatus;
|
1128
|
-
pausePeriods: {
|
1129
|
-
status: Status;
|
1130
|
-
}[];
|
1131
|
-
currentCycle?: {
|
1132
|
-
index: number;
|
1133
|
-
};
|
1134
|
-
planName: string;
|
1135
|
-
planDescription: string;
|
1136
|
-
planPrice: string;
|
1137
|
-
}[];
|
1344
|
+
orders: OrderNonNullableFields[];
|
1138
1345
|
}
|
1139
1346
|
interface BaseEventMetadata$1 {
|
1140
1347
|
/** App instance ID. */
|
@@ -1295,7 +1502,7 @@ interface MemberListOrdersOptions {
|
|
1295
1502
|
*
|
1296
1503
|
* Default: `ASC`
|
1297
1504
|
*/
|
1298
|
-
sorting?: Sorting;
|
1505
|
+
sorting?: Sorting$1;
|
1299
1506
|
fieldSet?: Set;
|
1300
1507
|
}
|
1301
1508
|
interface CreateOfflineOrderOptions {
|
@@ -1377,7 +1584,7 @@ interface ManagementListOrdersOptions {
|
|
1377
1584
|
*
|
1378
1585
|
* Default: `DESC`
|
1379
1586
|
*/
|
1380
|
-
sorting?: Sorting;
|
1587
|
+
sorting?: Sorting$1;
|
1381
1588
|
/** Parameter to define amount of fields to return. FULL returns each order's submission data. Supported values: UNKNOWN_SET, BASIC, FULL */
|
1382
1589
|
fieldSet?: Set;
|
1383
1590
|
}
|
@@ -1385,6 +1592,8 @@ interface ManagementListOrdersOptions {
|
|
1385
1592
|
type RESTFunctionDescriptor<T extends (...args: any[]) => any = (...args: any[]) => any> = (httpClient: HttpClient) => T;
|
1386
1593
|
interface HttpClient {
|
1387
1594
|
request<TResponse, TData = any>(req: RequestOptionsFactory<TResponse, TData>): Promise<HttpResponse<TResponse>>;
|
1595
|
+
fetchWithAuth: typeof fetch;
|
1596
|
+
wixAPIFetch: (relativeUrl: string, options: RequestInit) => Promise<Response>;
|
1388
1597
|
}
|
1389
1598
|
type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
|
1390
1599
|
type HttpResponse<T = any> = {
|
@@ -1410,150 +1619,186 @@ type EventDefinition<Payload = unknown, Type extends string = string> = {
|
|
1410
1619
|
__type: 'event-definition';
|
1411
1620
|
type: Type;
|
1412
1621
|
isDomainEvent?: boolean;
|
1413
|
-
transformations?: unknown;
|
1622
|
+
transformations?: (envelope: unknown) => Payload;
|
1414
1623
|
__payload: Payload;
|
1415
1624
|
};
|
1416
|
-
declare function EventDefinition<Type extends string>(type: Type, isDomainEvent?: boolean,
|
1625
|
+
declare function EventDefinition<Type extends string>(type: Type, isDomainEvent?: boolean, transformations?: (envelope: any) => unknown): <Payload = unknown>() => EventDefinition<Payload, Type>;
|
1417
1626
|
type EventHandler<T extends EventDefinition> = (payload: T['__payload']) => void | Promise<void>;
|
1418
1627
|
type BuildEventDefinition<T extends EventDefinition<any, string>> = (handler: EventHandler<T>) => void;
|
1419
1628
|
|
1420
|
-
declare
|
1421
|
-
|
1422
|
-
|
1423
|
-
|
1424
|
-
|
1425
|
-
|
1426
|
-
|
1427
|
-
|
1428
|
-
priceDetails?: {
|
1429
|
-
subscription?: {
|
1430
|
-
cycleDuration?: {
|
1431
|
-
unit: PeriodUnit$1;
|
1432
|
-
} | undefined;
|
1433
|
-
} | undefined;
|
1434
|
-
singlePaymentForDuration?: {
|
1435
|
-
unit: PeriodUnit$1;
|
1436
|
-
} | undefined;
|
1437
|
-
subtotal: string;
|
1438
|
-
discount: string;
|
1439
|
-
tax?: {
|
1440
|
-
name: string;
|
1441
|
-
includedInPrice: boolean;
|
1442
|
-
rate: string;
|
1443
|
-
amount: string;
|
1444
|
-
} | undefined;
|
1445
|
-
total: string;
|
1446
|
-
planPrice: string;
|
1447
|
-
currency: string;
|
1448
|
-
coupon?: {
|
1449
|
-
code: string;
|
1450
|
-
amount: string;
|
1451
|
-
_id: string;
|
1452
|
-
} | undefined;
|
1453
|
-
} | undefined;
|
1454
|
-
pricing?: {
|
1455
|
-
subscription?: {
|
1456
|
-
cycleDuration?: {
|
1457
|
-
unit: PeriodUnit$1;
|
1458
|
-
} | undefined;
|
1459
|
-
} | undefined;
|
1460
|
-
singlePaymentForDuration?: {
|
1461
|
-
unit: PeriodUnit$1;
|
1462
|
-
} | undefined;
|
1463
|
-
prices: {
|
1464
|
-
duration?: {
|
1465
|
-
cycleFrom: number;
|
1466
|
-
} | undefined;
|
1467
|
-
price?: {
|
1468
|
-
subtotal: string;
|
1469
|
-
coupon?: {
|
1470
|
-
code: string;
|
1471
|
-
amount: string;
|
1472
|
-
_id: string;
|
1473
|
-
} | undefined;
|
1474
|
-
discount: string;
|
1475
|
-
tax?: {
|
1476
|
-
name: string;
|
1477
|
-
includedInPrice: boolean;
|
1478
|
-
rate: string;
|
1479
|
-
amount: string;
|
1480
|
-
} | undefined;
|
1481
|
-
total: string;
|
1482
|
-
currency: string;
|
1483
|
-
proration: string;
|
1484
|
-
} | undefined;
|
1485
|
-
}[];
|
1486
|
-
} | undefined;
|
1487
|
-
type: OrderType;
|
1488
|
-
status: OrderStatus;
|
1489
|
-
cancellation?: {
|
1490
|
-
cause: CancellationCause;
|
1491
|
-
effectiveAt: CancellationEffectiveAt;
|
1492
|
-
} | undefined;
|
1493
|
-
lastPaymentStatus: PaymentStatus;
|
1494
|
-
pausePeriods: {
|
1495
|
-
status: Status;
|
1496
|
-
}[];
|
1497
|
-
currentCycle?: {
|
1498
|
-
index: number;
|
1499
|
-
} | undefined;
|
1500
|
-
planName: string;
|
1501
|
-
planDescription: string;
|
1502
|
-
planPrice: string;
|
1503
|
-
}>;
|
1504
|
-
declare function memberListOrders$1(httpClient: HttpClient): (options?: MemberListOrdersOptions) => Promise<MemberListOrdersResponse & MemberListOrdersResponseNonNullableFields>;
|
1505
|
-
declare function requestCancellation$1(httpClient: HttpClient): (_id: string, effectiveAt: CancellationEffectiveAt) => Promise<void>;
|
1506
|
-
declare function createOfflineOrder$1(httpClient: HttpClient): (planId: string, memberId: string, options?: CreateOfflineOrderOptions) => Promise<CreateOfflineOrderResponse & CreateOfflineOrderResponseNonNullableFields>;
|
1507
|
-
declare function getOfflineOrderPreview$1(httpClient: HttpClient): (planId: string, memberId: string, options?: GetOfflineOrderPreviewOptions) => Promise<GetOfflineOrderPreviewResponse & GetOfflineOrderPreviewResponseNonNullableFields>;
|
1508
|
-
declare function getPricePreview$1(httpClient: HttpClient): (planId: string, options?: GetPricePreviewOptions) => Promise<GetPricePreviewResponse & GetPricePreviewResponseNonNullableFields>;
|
1509
|
-
declare function managementGetOrder$1(httpClient: HttpClient): (_id: string, options?: ManagementGetOrderOptions) => Promise<GetOrderResponse & GetOrderResponseNonNullableFields>;
|
1510
|
-
declare function managementListOrders$1(httpClient: HttpClient): (options?: ManagementListOrdersOptions) => Promise<ListOrdersResponse & ListOrdersResponseNonNullableFields>;
|
1511
|
-
declare function postponeEndDate$1(httpClient: HttpClient): (_id: string, endDate: Date) => Promise<void>;
|
1512
|
-
declare function cancelOrder$1(httpClient: HttpClient): (_id: string, effectiveAt: CancellationEffectiveAt) => Promise<void>;
|
1513
|
-
declare function markAsPaid$1(httpClient: HttpClient): (_id: string) => Promise<void>;
|
1514
|
-
declare function pauseOrder$1(httpClient: HttpClient): (_id: string) => Promise<void>;
|
1515
|
-
declare function resumeOrder$1(httpClient: HttpClient): (_id: string) => Promise<void>;
|
1516
|
-
declare const onOrderCanceled$1: EventDefinition<OrderCanceledEnvelope, "wix.pricing_plans.v2.order_canceled">;
|
1517
|
-
declare const onOrderCreated$1: EventDefinition<OrderCreatedEnvelope, "wix.pricing_plans.v2.order_created">;
|
1518
|
-
declare const onOrderUpdated$1: EventDefinition<OrderUpdatedEnvelope, "wix.pricing_plans.v2.order_updated">;
|
1519
|
-
declare const onOrderStartDateChanged$1: EventDefinition<OrderStartDateChangedEnvelope, "wix.pricing_plans.v2.order_start_date_changed">;
|
1520
|
-
declare const onOrderPurchased$1: EventDefinition<OrderPurchasedEnvelope, "wix.pricing_plans.v2.order_purchased">;
|
1521
|
-
declare const onOrderStarted$1: EventDefinition<OrderStartedEnvelope, "wix.pricing_plans.v2.order_started">;
|
1522
|
-
declare const onOrderCycleStarted$1: EventDefinition<OrderCycleStartedEnvelope, "wix.pricing_plans.v2.order_cycle_started">;
|
1523
|
-
declare const onOrderAutoRenewCanceled$1: EventDefinition<OrderAutoRenewCanceledEnvelope, "wix.pricing_plans.v2.order_auto_renew_canceled">;
|
1524
|
-
declare const onOrderEnded$1: EventDefinition<OrderEndedEnvelope, "wix.pricing_plans.v2.order_ended">;
|
1525
|
-
declare const onOrderEndDatePostponed$1: EventDefinition<OrderEndDatePostponedEnvelope, "wix.pricing_plans.v2.order_end_date_postponed">;
|
1526
|
-
declare const onOrderMarkedAsPaid$1: EventDefinition<OrderMarkedAsPaidEnvelope, "wix.pricing_plans.v2.order_marked_as_paid">;
|
1527
|
-
declare const onOrderPaused$1: EventDefinition<OrderPausedEnvelope, "wix.pricing_plans.v2.order_paused">;
|
1528
|
-
declare const onOrderResumed$1: EventDefinition<OrderResumedEnvelope, "wix.pricing_plans.v2.order_resumed">;
|
1629
|
+
declare global {
|
1630
|
+
// eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
|
1631
|
+
interface SymbolConstructor {
|
1632
|
+
readonly observable: symbol;
|
1633
|
+
}
|
1634
|
+
}
|
1635
|
+
|
1636
|
+
declare function createRESTModule$1<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
|
1529
1637
|
|
1530
|
-
declare
|
1531
|
-
declare const memberListOrders: BuildRESTFunction<typeof memberListOrders$1>;
|
1532
|
-
declare const requestCancellation: BuildRESTFunction<typeof requestCancellation$1>;
|
1533
|
-
declare const createOfflineOrder: BuildRESTFunction<typeof createOfflineOrder$1>;
|
1534
|
-
declare const getOfflineOrderPreview: BuildRESTFunction<typeof getOfflineOrderPreview$1>;
|
1535
|
-
declare const getPricePreview: BuildRESTFunction<typeof getPricePreview$1>;
|
1536
|
-
declare const managementGetOrder: BuildRESTFunction<typeof managementGetOrder$1>;
|
1537
|
-
declare const managementListOrders: BuildRESTFunction<typeof managementListOrders$1>;
|
1538
|
-
declare const postponeEndDate: BuildRESTFunction<typeof postponeEndDate$1>;
|
1539
|
-
declare const cancelOrder: BuildRESTFunction<typeof cancelOrder$1>;
|
1540
|
-
declare const markAsPaid: BuildRESTFunction<typeof markAsPaid$1>;
|
1541
|
-
declare const pauseOrder: BuildRESTFunction<typeof pauseOrder$1>;
|
1542
|
-
declare const resumeOrder: BuildRESTFunction<typeof resumeOrder$1>;
|
1543
|
-
declare const onOrderCanceled: BuildEventDefinition<typeof onOrderCanceled$1>;
|
1544
|
-
declare const onOrderCreated: BuildEventDefinition<typeof onOrderCreated$1>;
|
1545
|
-
declare const onOrderUpdated: BuildEventDefinition<typeof onOrderUpdated$1>;
|
1546
|
-
declare const onOrderStartDateChanged: BuildEventDefinition<typeof onOrderStartDateChanged$1>;
|
1547
|
-
declare const onOrderPurchased: BuildEventDefinition<typeof onOrderPurchased$1>;
|
1548
|
-
declare const onOrderStarted: BuildEventDefinition<typeof onOrderStarted$1>;
|
1549
|
-
declare const onOrderCycleStarted: BuildEventDefinition<typeof onOrderCycleStarted$1>;
|
1550
|
-
declare const onOrderAutoRenewCanceled: BuildEventDefinition<typeof onOrderAutoRenewCanceled$1>;
|
1551
|
-
declare const onOrderEnded: BuildEventDefinition<typeof onOrderEnded$1>;
|
1552
|
-
declare const onOrderEndDatePostponed: BuildEventDefinition<typeof onOrderEndDatePostponed$1>;
|
1553
|
-
declare const onOrderMarkedAsPaid: BuildEventDefinition<typeof onOrderMarkedAsPaid$1>;
|
1554
|
-
declare const onOrderPaused: BuildEventDefinition<typeof onOrderPaused$1>;
|
1555
|
-
declare const onOrderResumed: BuildEventDefinition<typeof onOrderResumed$1>;
|
1638
|
+
declare function createEventModule$1<T extends EventDefinition<any, string>>(eventDefinition: T): BuildEventDefinition<T> & T;
|
1556
1639
|
|
1640
|
+
declare const memberGetOrder: ReturnType<typeof createRESTModule$1<typeof publicMemberGetOrder>>;
|
1641
|
+
declare const memberListOrders: ReturnType<typeof createRESTModule$1<typeof publicMemberListOrders>>;
|
1642
|
+
declare const requestCancellation: ReturnType<typeof createRESTModule$1<typeof publicRequestCancellation>>;
|
1643
|
+
declare const createOfflineOrder: ReturnType<typeof createRESTModule$1<typeof publicCreateOfflineOrder>>;
|
1644
|
+
declare const getOfflineOrderPreview: ReturnType<typeof createRESTModule$1<typeof publicGetOfflineOrderPreview>>;
|
1645
|
+
declare const getPricePreview: ReturnType<typeof createRESTModule$1<typeof publicGetPricePreview>>;
|
1646
|
+
declare const managementGetOrder: ReturnType<typeof createRESTModule$1<typeof publicManagementGetOrder>>;
|
1647
|
+
declare const managementListOrders: ReturnType<typeof createRESTModule$1<typeof publicManagementListOrders>>;
|
1648
|
+
declare const postponeEndDate: ReturnType<typeof createRESTModule$1<typeof publicPostponeEndDate>>;
|
1649
|
+
declare const cancelOrder: ReturnType<typeof createRESTModule$1<typeof publicCancelOrder>>;
|
1650
|
+
declare const markAsPaid: ReturnType<typeof createRESTModule$1<typeof publicMarkAsPaid>>;
|
1651
|
+
declare const pauseOrder: ReturnType<typeof createRESTModule$1<typeof publicPauseOrder>>;
|
1652
|
+
declare const resumeOrder: ReturnType<typeof createRESTModule$1<typeof publicResumeOrder>>;
|
1653
|
+
declare const onOrderCanceled: ReturnType<typeof createEventModule$1<typeof publicOnOrderCanceled>>;
|
1654
|
+
declare const onOrderCreated: ReturnType<typeof createEventModule$1<typeof publicOnOrderCreated>>;
|
1655
|
+
declare const onOrderUpdated: ReturnType<typeof createEventModule$1<typeof publicOnOrderUpdated>>;
|
1656
|
+
declare const onOrderStartDateChanged: ReturnType<typeof createEventModule$1<typeof publicOnOrderStartDateChanged>>;
|
1657
|
+
declare const onOrderPurchased: ReturnType<typeof createEventModule$1<typeof publicOnOrderPurchased>>;
|
1658
|
+
declare const onOrderStarted: ReturnType<typeof createEventModule$1<typeof publicOnOrderStarted>>;
|
1659
|
+
declare const onOrderCycleStarted: ReturnType<typeof createEventModule$1<typeof publicOnOrderCycleStarted>>;
|
1660
|
+
declare const onOrderAutoRenewCanceled: ReturnType<typeof createEventModule$1<typeof publicOnOrderAutoRenewCanceled>>;
|
1661
|
+
declare const onOrderEnded: ReturnType<typeof createEventModule$1<typeof publicOnOrderEnded>>;
|
1662
|
+
declare const onOrderEndDatePostponed: ReturnType<typeof createEventModule$1<typeof publicOnOrderEndDatePostponed>>;
|
1663
|
+
declare const onOrderMarkedAsPaid: ReturnType<typeof createEventModule$1<typeof publicOnOrderMarkedAsPaid>>;
|
1664
|
+
declare const onOrderPaused: ReturnType<typeof createEventModule$1<typeof publicOnOrderPaused>>;
|
1665
|
+
declare const onOrderResumed: ReturnType<typeof createEventModule$1<typeof publicOnOrderResumed>>;
|
1666
|
+
|
1667
|
+
type context$1_ApplyCouponRequest = ApplyCouponRequest;
|
1668
|
+
type context$1_ApplyCouponResponse = ApplyCouponResponse;
|
1669
|
+
type context$1_BulkOrderResult = BulkOrderResult;
|
1670
|
+
type context$1_BulkPauseOrderRequest = BulkPauseOrderRequest;
|
1671
|
+
type context$1_BulkPauseOrderResponse = BulkPauseOrderResponse;
|
1672
|
+
type context$1_BulkResumeOrderRequest = BulkResumeOrderRequest;
|
1673
|
+
type context$1_BulkResumeOrderResponse = BulkResumeOrderResponse;
|
1674
|
+
type context$1_Buyer = Buyer;
|
1675
|
+
type context$1_CancelOrderRequest = CancelOrderRequest;
|
1676
|
+
type context$1_CancelOrderResponse = CancelOrderResponse;
|
1677
|
+
type context$1_Cancellation = Cancellation;
|
1678
|
+
type context$1_CancellationCause = CancellationCause;
|
1679
|
+
declare const context$1_CancellationCause: typeof CancellationCause;
|
1680
|
+
type context$1_CancellationEffectiveAt = CancellationEffectiveAt;
|
1681
|
+
declare const context$1_CancellationEffectiveAt: typeof CancellationEffectiveAt;
|
1682
|
+
type context$1_Captcha = Captcha;
|
1683
|
+
type context$1_ChangeStartDateRequest = ChangeStartDateRequest;
|
1684
|
+
type context$1_ChangeStartDateResponse = ChangeStartDateResponse;
|
1685
|
+
type context$1_Coupon = Coupon;
|
1686
|
+
type context$1_CouponsError = CouponsError;
|
1687
|
+
type context$1_CreateExternalOrderRequest = CreateExternalOrderRequest;
|
1688
|
+
type context$1_CreateExternalOrderResponse = CreateExternalOrderResponse;
|
1689
|
+
type context$1_CreateGuestOnlineOrderRequest = CreateGuestOnlineOrderRequest;
|
1690
|
+
type context$1_CreateGuestOnlineOrderResponse = CreateGuestOnlineOrderResponse;
|
1691
|
+
type context$1_CreateOfflineOrderOptions = CreateOfflineOrderOptions;
|
1692
|
+
type context$1_CreateOfflineOrderRequest = CreateOfflineOrderRequest;
|
1693
|
+
type context$1_CreateOfflineOrderResponse = CreateOfflineOrderResponse;
|
1694
|
+
type context$1_CreateOfflineOrderResponseNonNullableFields = CreateOfflineOrderResponseNonNullableFields;
|
1695
|
+
type context$1_CreateOnlineOrderRequest = CreateOnlineOrderRequest;
|
1696
|
+
type context$1_CreateOnlineOrderResponse = CreateOnlineOrderResponse;
|
1697
|
+
type context$1_CurrentCycle = CurrentCycle;
|
1698
|
+
type context$1_CursorPaging = CursorPaging;
|
1699
|
+
type context$1_Empty = Empty;
|
1700
|
+
type context$1_FormData = FormData;
|
1701
|
+
type context$1_GetAvailableOrderActionsRequest = GetAvailableOrderActionsRequest;
|
1702
|
+
type context$1_GetAvailableOrderActionsResponse = GetAvailableOrderActionsResponse;
|
1703
|
+
type context$1_GetGuestOnlineOrderPreviewRequest = GetGuestOnlineOrderPreviewRequest;
|
1704
|
+
type context$1_GetGuestOnlineOrderPreviewResponse = GetGuestOnlineOrderPreviewResponse;
|
1705
|
+
type context$1_GetOfflineOrderPreviewOptions = GetOfflineOrderPreviewOptions;
|
1706
|
+
type context$1_GetOfflineOrderPreviewRequest = GetOfflineOrderPreviewRequest;
|
1707
|
+
type context$1_GetOfflineOrderPreviewResponse = GetOfflineOrderPreviewResponse;
|
1708
|
+
type context$1_GetOfflineOrderPreviewResponseNonNullableFields = GetOfflineOrderPreviewResponseNonNullableFields;
|
1709
|
+
type context$1_GetOnlineOrderPreviewRequest = GetOnlineOrderPreviewRequest;
|
1710
|
+
type context$1_GetOnlineOrderPreviewResponse = GetOnlineOrderPreviewResponse;
|
1711
|
+
type context$1_GetOrderRequest = GetOrderRequest;
|
1712
|
+
type context$1_GetOrderResponse = GetOrderResponse;
|
1713
|
+
type context$1_GetOrderResponseNonNullableFields = GetOrderResponseNonNullableFields;
|
1714
|
+
type context$1_GetOrdersStatsRequest = GetOrdersStatsRequest;
|
1715
|
+
type context$1_GetOrdersStatsResponse = GetOrdersStatsResponse;
|
1716
|
+
type context$1_GetPricePreviewOptions = GetPricePreviewOptions;
|
1717
|
+
type context$1_GetPricePreviewRequest = GetPricePreviewRequest;
|
1718
|
+
type context$1_GetPricePreviewResponse = GetPricePreviewResponse;
|
1719
|
+
type context$1_GetPricePreviewResponseNonNullableFields = GetPricePreviewResponseNonNullableFields;
|
1720
|
+
type context$1_Guest = Guest;
|
1721
|
+
type context$1_ListOrdersRequest = ListOrdersRequest;
|
1722
|
+
type context$1_ListOrdersResponse = ListOrdersResponse;
|
1723
|
+
type context$1_ListOrdersResponseNonNullableFields = ListOrdersResponseNonNullableFields;
|
1724
|
+
type context$1_ManagementGetOrderOptions = ManagementGetOrderOptions;
|
1725
|
+
type context$1_ManagementListOrdersOptions = ManagementListOrdersOptions;
|
1726
|
+
type context$1_MarkAsPaidRequest = MarkAsPaidRequest;
|
1727
|
+
type context$1_MarkAsPaidResponse = MarkAsPaidResponse;
|
1728
|
+
type context$1_MemberGetOrderOptions = MemberGetOrderOptions;
|
1729
|
+
type context$1_MemberGetOrderRequest = MemberGetOrderRequest;
|
1730
|
+
type context$1_MemberGetOrderResponse = MemberGetOrderResponse;
|
1731
|
+
type context$1_MemberGetOrderResponseNonNullableFields = MemberGetOrderResponseNonNullableFields;
|
1732
|
+
type context$1_MemberListOrdersOptions = MemberListOrdersOptions;
|
1733
|
+
type context$1_MemberListOrdersRequest = MemberListOrdersRequest;
|
1734
|
+
type context$1_MemberListOrdersResponse = MemberListOrdersResponse;
|
1735
|
+
type context$1_MemberListOrdersResponseNonNullableFields = MemberListOrdersResponseNonNullableFields;
|
1736
|
+
type context$1_OnBehalf = OnBehalf;
|
1737
|
+
type context$1_Order = Order;
|
1738
|
+
type context$1_OrderAutoRenewCanceled = OrderAutoRenewCanceled;
|
1739
|
+
type context$1_OrderAutoRenewCanceledEnvelope = OrderAutoRenewCanceledEnvelope;
|
1740
|
+
type context$1_OrderCanceled = OrderCanceled;
|
1741
|
+
type context$1_OrderCanceledEnvelope = OrderCanceledEnvelope;
|
1742
|
+
type context$1_OrderCreatedEnvelope = OrderCreatedEnvelope;
|
1743
|
+
type context$1_OrderCycle = OrderCycle;
|
1744
|
+
type context$1_OrderCycleStarted = OrderCycleStarted;
|
1745
|
+
type context$1_OrderCycleStartedEnvelope = OrderCycleStartedEnvelope;
|
1746
|
+
type context$1_OrderEndDatePostponed = OrderEndDatePostponed;
|
1747
|
+
type context$1_OrderEndDatePostponedEnvelope = OrderEndDatePostponedEnvelope;
|
1748
|
+
type context$1_OrderEnded = OrderEnded;
|
1749
|
+
type context$1_OrderEndedEnvelope = OrderEndedEnvelope;
|
1750
|
+
type context$1_OrderMarkedAsPaid = OrderMarkedAsPaid;
|
1751
|
+
type context$1_OrderMarkedAsPaidEnvelope = OrderMarkedAsPaidEnvelope;
|
1752
|
+
type context$1_OrderMethod = OrderMethod;
|
1753
|
+
declare const context$1_OrderMethod: typeof OrderMethod;
|
1754
|
+
type context$1_OrderNonNullableFields = OrderNonNullableFields;
|
1755
|
+
type context$1_OrderPaused = OrderPaused;
|
1756
|
+
type context$1_OrderPausedEnvelope = OrderPausedEnvelope;
|
1757
|
+
type context$1_OrderPurchased = OrderPurchased;
|
1758
|
+
type context$1_OrderPurchasedEnvelope = OrderPurchasedEnvelope;
|
1759
|
+
type context$1_OrderResumed = OrderResumed;
|
1760
|
+
type context$1_OrderResumedEnvelope = OrderResumedEnvelope;
|
1761
|
+
type context$1_OrderStartDateChanged = OrderStartDateChanged;
|
1762
|
+
type context$1_OrderStartDateChangedEnvelope = OrderStartDateChangedEnvelope;
|
1763
|
+
type context$1_OrderStarted = OrderStarted;
|
1764
|
+
type context$1_OrderStartedEnvelope = OrderStartedEnvelope;
|
1765
|
+
type context$1_OrderStatus = OrderStatus;
|
1766
|
+
declare const context$1_OrderStatus: typeof OrderStatus;
|
1767
|
+
type context$1_OrderType = OrderType;
|
1768
|
+
declare const context$1_OrderType: typeof OrderType;
|
1769
|
+
type context$1_OrderUpdatedEnvelope = OrderUpdatedEnvelope;
|
1770
|
+
type context$1_OrdersQueryOrdersRequest = OrdersQueryOrdersRequest;
|
1771
|
+
type context$1_OrdersQueryOrdersResponse = OrdersQueryOrdersResponse;
|
1772
|
+
type context$1_PauseOrderRequest = PauseOrderRequest;
|
1773
|
+
type context$1_PauseOrderResponse = PauseOrderResponse;
|
1774
|
+
type context$1_PausePeriod = PausePeriod;
|
1775
|
+
type context$1_PaymentStatus = PaymentStatus;
|
1776
|
+
declare const context$1_PaymentStatus: typeof PaymentStatus;
|
1777
|
+
type context$1_PostponeEndDateRequest = PostponeEndDateRequest;
|
1778
|
+
type context$1_PostponeEndDateResponse = PostponeEndDateResponse;
|
1779
|
+
type context$1_Price = Price;
|
1780
|
+
type context$1_PriceDetails = PriceDetails;
|
1781
|
+
type context$1_PriceDetailsPricingModelOneOf = PriceDetailsPricingModelOneOf;
|
1782
|
+
type context$1_PriceDuration = PriceDuration;
|
1783
|
+
type context$1_PricingDetails = PricingDetails;
|
1784
|
+
type context$1_PricingDetailsPricingModelOneOf = PricingDetailsPricingModelOneOf;
|
1785
|
+
type context$1_QueryOrdersRequest = QueryOrdersRequest;
|
1786
|
+
type context$1_QueryOrdersResponse = QueryOrdersResponse;
|
1787
|
+
type context$1_QueryV2PagingMethodOneOf = QueryV2PagingMethodOneOf;
|
1788
|
+
type context$1_ReasonNotSuspendable = ReasonNotSuspendable;
|
1789
|
+
declare const context$1_ReasonNotSuspendable: typeof ReasonNotSuspendable;
|
1790
|
+
type context$1_RequestCancellationRequest = RequestCancellationRequest;
|
1791
|
+
type context$1_RequestCancellationResponse = RequestCancellationResponse;
|
1792
|
+
type context$1_ResumeOrderRequest = ResumeOrderRequest;
|
1793
|
+
type context$1_ResumeOrderResponse = ResumeOrderResponse;
|
1794
|
+
type context$1_Set = Set;
|
1795
|
+
declare const context$1_Set: typeof Set;
|
1796
|
+
type context$1_SetSubmissionRequest = SetSubmissionRequest;
|
1797
|
+
type context$1_SetSubmissionResponse = SetSubmissionResponse;
|
1798
|
+
type context$1_SpannedPrice = SpannedPrice;
|
1799
|
+
type context$1_Status = Status;
|
1800
|
+
declare const context$1_Status: typeof Status;
|
1801
|
+
type context$1_Tax = Tax;
|
1557
1802
|
declare const context$1_cancelOrder: typeof cancelOrder;
|
1558
1803
|
declare const context$1_createOfflineOrder: typeof createOfflineOrder;
|
1559
1804
|
declare const context$1_getOfflineOrderPreview: typeof getOfflineOrderPreview;
|
@@ -1581,7 +1826,7 @@ declare const context$1_postponeEndDate: typeof postponeEndDate;
|
|
1581
1826
|
declare const context$1_requestCancellation: typeof requestCancellation;
|
1582
1827
|
declare const context$1_resumeOrder: typeof resumeOrder;
|
1583
1828
|
declare namespace context$1 {
|
1584
|
-
export { context$1_cancelOrder as cancelOrder, context$1_createOfflineOrder as createOfflineOrder, context$1_getOfflineOrderPreview as getOfflineOrderPreview, context$1_getPricePreview as getPricePreview, context$1_managementGetOrder as managementGetOrder, context$1_managementListOrders as managementListOrders, context$1_markAsPaid as markAsPaid, context$1_memberGetOrder as memberGetOrder, context$1_memberListOrders as memberListOrders, context$1_onOrderAutoRenewCanceled as onOrderAutoRenewCanceled, context$1_onOrderCanceled as onOrderCanceled, context$1_onOrderCreated as onOrderCreated, context$1_onOrderCycleStarted as onOrderCycleStarted, context$1_onOrderEndDatePostponed as onOrderEndDatePostponed, context$1_onOrderEnded as onOrderEnded, context$1_onOrderMarkedAsPaid as onOrderMarkedAsPaid, context$1_onOrderPaused as onOrderPaused, context$1_onOrderPurchased as onOrderPurchased, context$1_onOrderResumed as onOrderResumed, context$1_onOrderStartDateChanged as onOrderStartDateChanged, context$1_onOrderStarted as onOrderStarted, context$1_onOrderUpdated as onOrderUpdated, context$1_pauseOrder as pauseOrder, context$1_postponeEndDate as postponeEndDate, context$1_requestCancellation as requestCancellation, context$1_resumeOrder as resumeOrder };
|
1829
|
+
export { type ActionEvent$1 as ActionEvent, type ApplicationError$1 as ApplicationError, type context$1_ApplyCouponRequest as ApplyCouponRequest, type context$1_ApplyCouponResponse as ApplyCouponResponse, type BaseEventMetadata$1 as BaseEventMetadata, type BulkActionMetadata$1 as BulkActionMetadata, type context$1_BulkOrderResult as BulkOrderResult, type context$1_BulkPauseOrderRequest as BulkPauseOrderRequest, type context$1_BulkPauseOrderResponse as BulkPauseOrderResponse, type context$1_BulkResumeOrderRequest as BulkResumeOrderRequest, type context$1_BulkResumeOrderResponse as BulkResumeOrderResponse, type context$1_Buyer as Buyer, type context$1_CancelOrderRequest as CancelOrderRequest, type context$1_CancelOrderResponse as CancelOrderResponse, type context$1_Cancellation as Cancellation, context$1_CancellationCause as CancellationCause, context$1_CancellationEffectiveAt as CancellationEffectiveAt, type context$1_Captcha as Captcha, type context$1_ChangeStartDateRequest as ChangeStartDateRequest, type context$1_ChangeStartDateResponse as ChangeStartDateResponse, type context$1_Coupon as Coupon, type context$1_CouponsError as CouponsError, type context$1_CreateExternalOrderRequest as CreateExternalOrderRequest, type context$1_CreateExternalOrderResponse as CreateExternalOrderResponse, type context$1_CreateGuestOnlineOrderRequest as CreateGuestOnlineOrderRequest, type context$1_CreateGuestOnlineOrderResponse as CreateGuestOnlineOrderResponse, type context$1_CreateOfflineOrderOptions as CreateOfflineOrderOptions, type context$1_CreateOfflineOrderRequest as CreateOfflineOrderRequest, type context$1_CreateOfflineOrderResponse as CreateOfflineOrderResponse, type context$1_CreateOfflineOrderResponseNonNullableFields as CreateOfflineOrderResponseNonNullableFields, type context$1_CreateOnlineOrderRequest as CreateOnlineOrderRequest, type context$1_CreateOnlineOrderResponse as CreateOnlineOrderResponse, type context$1_CurrentCycle as CurrentCycle, type context$1_CursorPaging as CursorPaging, type Cursors$1 as Cursors, type DomainEvent$1 as DomainEvent, type DomainEventBodyOneOf$1 as DomainEventBodyOneOf, type Duration$1 as Duration, type context$1_Empty as Empty, type EntityCreatedEvent$1 as EntityCreatedEvent, type EntityDeletedEvent$1 as EntityDeletedEvent, type EntityUpdatedEvent$1 as EntityUpdatedEvent, type EventMetadata$1 as EventMetadata, type Fee$1 as Fee, type context$1_FormData as FormData, type context$1_GetAvailableOrderActionsRequest as GetAvailableOrderActionsRequest, type context$1_GetAvailableOrderActionsResponse as GetAvailableOrderActionsResponse, type context$1_GetGuestOnlineOrderPreviewRequest as GetGuestOnlineOrderPreviewRequest, type context$1_GetGuestOnlineOrderPreviewResponse as GetGuestOnlineOrderPreviewResponse, type context$1_GetOfflineOrderPreviewOptions as GetOfflineOrderPreviewOptions, type context$1_GetOfflineOrderPreviewRequest as GetOfflineOrderPreviewRequest, type context$1_GetOfflineOrderPreviewResponse as GetOfflineOrderPreviewResponse, type context$1_GetOfflineOrderPreviewResponseNonNullableFields as GetOfflineOrderPreviewResponseNonNullableFields, type context$1_GetOnlineOrderPreviewRequest as GetOnlineOrderPreviewRequest, type context$1_GetOnlineOrderPreviewResponse as GetOnlineOrderPreviewResponse, type context$1_GetOrderRequest as GetOrderRequest, type context$1_GetOrderResponse as GetOrderResponse, type context$1_GetOrderResponseNonNullableFields as GetOrderResponseNonNullableFields, type context$1_GetOrdersStatsRequest as GetOrdersStatsRequest, type context$1_GetOrdersStatsResponse as GetOrdersStatsResponse, type context$1_GetPricePreviewOptions as GetPricePreviewOptions, type context$1_GetPricePreviewRequest as GetPricePreviewRequest, type context$1_GetPricePreviewResponse as GetPricePreviewResponse, type context$1_GetPricePreviewResponseNonNullableFields as GetPricePreviewResponseNonNullableFields, type context$1_Guest as Guest, type IdentificationData$1 as IdentificationData, type IdentificationDataIdOneOf$1 as IdentificationDataIdOneOf, type ItemMetadata$1 as ItemMetadata, type context$1_ListOrdersRequest as ListOrdersRequest, type context$1_ListOrdersResponse as ListOrdersResponse, type context$1_ListOrdersResponseNonNullableFields as ListOrdersResponseNonNullableFields, type context$1_ManagementGetOrderOptions as ManagementGetOrderOptions, type context$1_ManagementListOrdersOptions as ManagementListOrdersOptions, type context$1_MarkAsPaidRequest as MarkAsPaidRequest, type context$1_MarkAsPaidResponse as MarkAsPaidResponse, type context$1_MemberGetOrderOptions as MemberGetOrderOptions, type context$1_MemberGetOrderRequest as MemberGetOrderRequest, type context$1_MemberGetOrderResponse as MemberGetOrderResponse, type context$1_MemberGetOrderResponseNonNullableFields as MemberGetOrderResponseNonNullableFields, type context$1_MemberListOrdersOptions as MemberListOrdersOptions, type context$1_MemberListOrdersRequest as MemberListOrdersRequest, type context$1_MemberListOrdersResponse as MemberListOrdersResponse, type context$1_MemberListOrdersResponseNonNullableFields as MemberListOrdersResponseNonNullableFields, type MessageEnvelope$1 as MessageEnvelope, type context$1_OnBehalf as OnBehalf, type context$1_Order as Order, type context$1_OrderAutoRenewCanceled as OrderAutoRenewCanceled, type context$1_OrderAutoRenewCanceledEnvelope as OrderAutoRenewCanceledEnvelope, type context$1_OrderCanceled as OrderCanceled, type context$1_OrderCanceledEnvelope as OrderCanceledEnvelope, type context$1_OrderCreatedEnvelope as OrderCreatedEnvelope, type context$1_OrderCycle as OrderCycle, type context$1_OrderCycleStarted as OrderCycleStarted, type context$1_OrderCycleStartedEnvelope as OrderCycleStartedEnvelope, type context$1_OrderEndDatePostponed as OrderEndDatePostponed, type context$1_OrderEndDatePostponedEnvelope as OrderEndDatePostponedEnvelope, type context$1_OrderEnded as OrderEnded, type context$1_OrderEndedEnvelope as OrderEndedEnvelope, type context$1_OrderMarkedAsPaid as OrderMarkedAsPaid, type context$1_OrderMarkedAsPaidEnvelope as OrderMarkedAsPaidEnvelope, context$1_OrderMethod as OrderMethod, type context$1_OrderNonNullableFields as OrderNonNullableFields, type context$1_OrderPaused as OrderPaused, type context$1_OrderPausedEnvelope as OrderPausedEnvelope, type context$1_OrderPurchased as OrderPurchased, type context$1_OrderPurchasedEnvelope as OrderPurchasedEnvelope, type context$1_OrderResumed as OrderResumed, type context$1_OrderResumedEnvelope as OrderResumedEnvelope, type context$1_OrderStartDateChanged as OrderStartDateChanged, type context$1_OrderStartDateChangedEnvelope as OrderStartDateChangedEnvelope, type context$1_OrderStarted as OrderStarted, type context$1_OrderStartedEnvelope as OrderStartedEnvelope, context$1_OrderStatus as OrderStatus, context$1_OrderType as OrderType, type context$1_OrderUpdatedEnvelope as OrderUpdatedEnvelope, type context$1_OrdersQueryOrdersRequest as OrdersQueryOrdersRequest, type context$1_OrdersQueryOrdersResponse as OrdersQueryOrdersResponse, type Paging$1 as Paging, type PagingMetadataV2$1 as PagingMetadataV2, type context$1_PauseOrderRequest as PauseOrderRequest, type context$1_PauseOrderResponse as PauseOrderResponse, type context$1_PausePeriod as PausePeriod, context$1_PaymentStatus as PaymentStatus, PeriodUnit$1 as PeriodUnit, type context$1_PostponeEndDateRequest as PostponeEndDateRequest, type context$1_PostponeEndDateResponse as PostponeEndDateResponse, type context$1_Price as Price, type context$1_PriceDetails as PriceDetails, type context$1_PriceDetailsPricingModelOneOf as PriceDetailsPricingModelOneOf, type context$1_PriceDuration as PriceDuration, type context$1_PricingDetails as PricingDetails, type context$1_PricingDetailsPricingModelOneOf as PricingDetailsPricingModelOneOf, type context$1_QueryOrdersRequest as QueryOrdersRequest, type context$1_QueryOrdersResponse as QueryOrdersResponse, type QueryV2$1 as QueryV2, type context$1_QueryV2PagingMethodOneOf as QueryV2PagingMethodOneOf, context$1_ReasonNotSuspendable as ReasonNotSuspendable, type Recurrence$1 as Recurrence, type context$1_RequestCancellationRequest as RequestCancellationRequest, type context$1_RequestCancellationResponse as RequestCancellationResponse, type context$1_ResumeOrderRequest as ResumeOrderRequest, type context$1_ResumeOrderResponse as ResumeOrderResponse, context$1_Set as Set, type context$1_SetSubmissionRequest as SetSubmissionRequest, type context$1_SetSubmissionResponse as SetSubmissionResponse, SortOrder$1 as SortOrder, type Sorting$1 as Sorting, type context$1_SpannedPrice as SpannedPrice, context$1_Status as Status, type context$1_Tax as Tax, WebhookIdentityType$1 as WebhookIdentityType, context$1_cancelOrder as cancelOrder, context$1_createOfflineOrder as createOfflineOrder, context$1_getOfflineOrderPreview as getOfflineOrderPreview, context$1_getPricePreview as getPricePreview, context$1_managementGetOrder as managementGetOrder, context$1_managementListOrders as managementListOrders, context$1_markAsPaid as markAsPaid, context$1_memberGetOrder as memberGetOrder, context$1_memberListOrders as memberListOrders, context$1_onOrderAutoRenewCanceled as onOrderAutoRenewCanceled, context$1_onOrderCanceled as onOrderCanceled, context$1_onOrderCreated as onOrderCreated, context$1_onOrderCycleStarted as onOrderCycleStarted, context$1_onOrderEndDatePostponed as onOrderEndDatePostponed, context$1_onOrderEnded as onOrderEnded, context$1_onOrderMarkedAsPaid as onOrderMarkedAsPaid, context$1_onOrderPaused as onOrderPaused, context$1_onOrderPurchased as onOrderPurchased, context$1_onOrderResumed as onOrderResumed, context$1_onOrderStartDateChanged as onOrderStartDateChanged, context$1_onOrderStarted as onOrderStarted, context$1_onOrderUpdated as onOrderUpdated, context$1_pauseOrder as pauseOrder, context$1_postponeEndDate as postponeEndDate, context$1_requestCancellation as requestCancellation, context$1_resumeOrder as resumeOrder };
|
1585
1830
|
}
|
1586
1831
|
|
1587
1832
|
/** Information about the pricing plan. */
|
@@ -1727,6 +1972,38 @@ interface Money {
|
|
1727
1972
|
*/
|
1728
1973
|
currency?: string;
|
1729
1974
|
}
|
1975
|
+
interface FeeConfig {
|
1976
|
+
fee?: Fee;
|
1977
|
+
/** The time this fee will be charged */
|
1978
|
+
appliedAt?: AppliedAt;
|
1979
|
+
}
|
1980
|
+
interface Fee {
|
1981
|
+
/** Fee name */
|
1982
|
+
name?: string;
|
1983
|
+
/** Amount of fee to be charged */
|
1984
|
+
amount?: string;
|
1985
|
+
}
|
1986
|
+
declare enum AppliedAt {
|
1987
|
+
UNKNOWN_CHARGE_EVENT = "UNKNOWN_CHARGE_EVENT",
|
1988
|
+
/** Will charge the fee on first payment. If order has a free trial meaning it will charge after the free trial. */
|
1989
|
+
FIRST_PAYMENT = "FIRST_PAYMENT"
|
1990
|
+
}
|
1991
|
+
interface ListPublicPlansRequest {
|
1992
|
+
/**
|
1993
|
+
* Number of pricing plans to list.
|
1994
|
+
*
|
1995
|
+
* Default: `75`.
|
1996
|
+
*/
|
1997
|
+
limit?: number | null;
|
1998
|
+
/**
|
1999
|
+
* Number of pricing plans to skip.
|
2000
|
+
*
|
2001
|
+
* Default: `0`.
|
2002
|
+
*/
|
2003
|
+
offset?: number | null;
|
2004
|
+
/** IDs of public plans to list. If non-existent IDs are specified, they are ignored and don't cause errors. If no IDs are specified, all public are listed according to the [order](#arrangeplans) displayed in the Dashboard. You can pass a maximum of 100 IDs. */
|
2005
|
+
planIds?: string[];
|
2006
|
+
}
|
1730
2007
|
interface ListPublicPlansResponse {
|
1731
2008
|
/** List of public pricing plans. */
|
1732
2009
|
plans?: PublicPlan[];
|
@@ -1782,6 +2059,76 @@ interface Cursors {
|
|
1782
2059
|
/** Cursor pointing to the previous page in the list of results. */
|
1783
2060
|
prev?: string | null;
|
1784
2061
|
}
|
2062
|
+
interface QueryPublicPlansRequest {
|
2063
|
+
query?: QueryV2;
|
2064
|
+
}
|
2065
|
+
interface QueryV2 {
|
2066
|
+
/** A filter object. See [supported fields and operators](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/plans/filter-and-sort#wix-pricing-plans_pricing-plans_plans_filter-and-sort_query-public-plans) */
|
2067
|
+
filter?: Record<string, any> | null;
|
2068
|
+
/** Sort object in the form [{"fieldName":"sortField1"},{"fieldName":"sortField2","direction":"DESC"}] */
|
2069
|
+
sort?: Sorting[];
|
2070
|
+
/** Pointer to page of results using offset. Can not be used together with 'cursorPaging' */
|
2071
|
+
paging?: Paging;
|
2072
|
+
}
|
2073
|
+
interface Sorting {
|
2074
|
+
/** Name of the field to sort by. */
|
2075
|
+
fieldName?: string;
|
2076
|
+
/** Sort order. */
|
2077
|
+
order?: SortOrder;
|
2078
|
+
}
|
2079
|
+
declare enum SortOrder {
|
2080
|
+
ASC = "ASC",
|
2081
|
+
DESC = "DESC"
|
2082
|
+
}
|
2083
|
+
interface Paging {
|
2084
|
+
/** Number of items to load. */
|
2085
|
+
limit?: number | null;
|
2086
|
+
/** Number of items to skip in the current sort order. */
|
2087
|
+
offset?: number | null;
|
2088
|
+
}
|
2089
|
+
interface QueryPublicPlansResponse {
|
2090
|
+
/** List of public pricing plans that match the specified query. */
|
2091
|
+
plans?: PublicPlan[];
|
2092
|
+
/** Object containing paging-related data (number of plans returned, offset). */
|
2093
|
+
pagingMetadata?: PagingMetadataV2;
|
2094
|
+
}
|
2095
|
+
interface GetPlanRequest {
|
2096
|
+
/** Plan ID. */
|
2097
|
+
_id: string;
|
2098
|
+
}
|
2099
|
+
interface GetPlanResponse {
|
2100
|
+
/** Pricing plan info. */
|
2101
|
+
plan?: Plan;
|
2102
|
+
}
|
2103
|
+
interface ListPlansRequest {
|
2104
|
+
/**
|
2105
|
+
* Archived filter.
|
2106
|
+
*
|
2107
|
+
* Default: `ACTIVE` (not archived).
|
2108
|
+
*/
|
2109
|
+
archived?: ArchivedFilter;
|
2110
|
+
/**
|
2111
|
+
* Visibility filter.
|
2112
|
+
*
|
2113
|
+
* Default: `PUBLIC_AND_HIDDEN` (meaning, both public and hidden plans are listed).
|
2114
|
+
*
|
2115
|
+
*/
|
2116
|
+
public?: PublicFilter;
|
2117
|
+
/**
|
2118
|
+
* Number of pricing plans to list.
|
2119
|
+
*
|
2120
|
+
* Default: `75`.
|
2121
|
+
*/
|
2122
|
+
limit?: number | null;
|
2123
|
+
/**
|
2124
|
+
* Number of pricing plans to skip.
|
2125
|
+
*
|
2126
|
+
* Default: `0`.
|
2127
|
+
*/
|
2128
|
+
offset?: number | null;
|
2129
|
+
/** IDs of plans to list. If non-existent IDs are specified, they are ignored and don't cause errors. If no IDs are specified, all public and hidden plans (based on `options`) are listed according to the [order](#arrangeplans) displayed in the Dashboard. You can pass a maximum of 100 IDs. */
|
2130
|
+
planIds?: string[];
|
2131
|
+
}
|
1785
2132
|
declare enum ArchivedFilter {
|
1786
2133
|
/** Returns all plans that are active. */
|
1787
2134
|
ACTIVE = "ACTIVE",
|
@@ -1804,21 +2151,56 @@ interface ListPlansResponse {
|
|
1804
2151
|
/** Details on the paged set of pricing plans returned. */
|
1805
2152
|
pagingMetadata?: PagingMetadataV2;
|
1806
2153
|
}
|
2154
|
+
interface GetPlanStatsRequest {
|
2155
|
+
}
|
1807
2156
|
interface GetPlanStatsResponse {
|
1808
2157
|
/** Total number of plans created, including active plans (both public and hidden) and archived plans. */
|
1809
2158
|
totalPlans?: number;
|
1810
2159
|
}
|
2160
|
+
interface CreatePlanRequest {
|
2161
|
+
/** Information for the plan being created. */
|
2162
|
+
plan: Plan;
|
2163
|
+
}
|
2164
|
+
interface CreatePlanResponse {
|
2165
|
+
/** Plan info. */
|
2166
|
+
plan?: Plan;
|
2167
|
+
}
|
2168
|
+
interface UpdatePlanRequest {
|
2169
|
+
/** Plan info to update. */
|
2170
|
+
plan: Plan;
|
2171
|
+
}
|
2172
|
+
interface UpdatePlanResponse {
|
2173
|
+
/** Updated plan info. */
|
2174
|
+
plan?: Plan;
|
2175
|
+
}
|
1811
2176
|
interface BuyerCanCancelUpdated {
|
1812
2177
|
plan?: Plan;
|
1813
2178
|
}
|
2179
|
+
interface SetPlanVisibilityRequest {
|
2180
|
+
/** The ID of the plan to either display or hide on the site page. */
|
2181
|
+
_id: string;
|
2182
|
+
/** Whether to set the plan as visible. */
|
2183
|
+
visible: boolean;
|
2184
|
+
}
|
1814
2185
|
interface SetPlanVisibilityResponse {
|
1815
2186
|
/** Plan info. */
|
1816
2187
|
plan?: Plan;
|
1817
2188
|
}
|
2189
|
+
interface MakePlanPrimaryRequest {
|
2190
|
+
/** ID of the pricing plan to set as the primary plan. */
|
2191
|
+
_id: string;
|
2192
|
+
}
|
1818
2193
|
interface MakePlanPrimaryResponse {
|
1819
2194
|
/** Primary plan info. */
|
1820
2195
|
plan?: Plan;
|
1821
2196
|
}
|
2197
|
+
interface ClearPrimaryRequest {
|
2198
|
+
}
|
2199
|
+
interface ClearPrimaryResponse {
|
2200
|
+
}
|
2201
|
+
interface ArchivePlanRequest {
|
2202
|
+
_id: string;
|
2203
|
+
}
|
1822
2204
|
interface ArchivePlanResponse {
|
1823
2205
|
/** Archived plan info. */
|
1824
2206
|
plan?: Plan;
|
@@ -1826,6 +2208,129 @@ interface ArchivePlanResponse {
|
|
1826
2208
|
interface PlanArchived {
|
1827
2209
|
plan?: Plan;
|
1828
2210
|
}
|
2211
|
+
interface BulkArchivePlanRequest {
|
2212
|
+
/** List of Plan IDs. */
|
2213
|
+
ids?: string[];
|
2214
|
+
/** Set to true to return Plan entity in response. */
|
2215
|
+
returnFullEntity?: boolean;
|
2216
|
+
}
|
2217
|
+
interface BulkArchivePlanResponse {
|
2218
|
+
results?: BulkPlanResult[];
|
2219
|
+
bulkActionMetadata?: BulkActionMetadata;
|
2220
|
+
}
|
2221
|
+
interface BulkPlanResult {
|
2222
|
+
itemMetadata?: ItemMetadata;
|
2223
|
+
plan?: Plan;
|
2224
|
+
}
|
2225
|
+
interface ItemMetadata {
|
2226
|
+
/** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
|
2227
|
+
_id?: string | null;
|
2228
|
+
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
2229
|
+
originalIndex?: number;
|
2230
|
+
/** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
|
2231
|
+
success?: boolean;
|
2232
|
+
/** Details about the error in case of failure. */
|
2233
|
+
error?: ApplicationError;
|
2234
|
+
}
|
2235
|
+
interface ApplicationError {
|
2236
|
+
/** Error code. */
|
2237
|
+
code?: string;
|
2238
|
+
/** Description of the error. */
|
2239
|
+
description?: string;
|
2240
|
+
/** Data related to the error. */
|
2241
|
+
data?: Record<string, any> | null;
|
2242
|
+
}
|
2243
|
+
interface BulkActionMetadata {
|
2244
|
+
/** Number of items that were successfully processed. */
|
2245
|
+
totalSuccesses?: number;
|
2246
|
+
/** Number of items that couldn't be processed. */
|
2247
|
+
totalFailures?: number;
|
2248
|
+
/** Number of failures without details because detailed failure threshold was exceeded. */
|
2249
|
+
undetailedFailures?: number;
|
2250
|
+
}
|
2251
|
+
interface ArrangePlansRequest {
|
2252
|
+
/** IDs of all non-archived plans in the order you want them arranged. */
|
2253
|
+
ids: string[];
|
2254
|
+
}
|
2255
|
+
interface ArrangePlansResponse {
|
2256
|
+
}
|
2257
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
2258
|
+
createdEvent?: EntityCreatedEvent;
|
2259
|
+
updatedEvent?: EntityUpdatedEvent;
|
2260
|
+
deletedEvent?: EntityDeletedEvent;
|
2261
|
+
actionEvent?: ActionEvent;
|
2262
|
+
/**
|
2263
|
+
* Unique event ID.
|
2264
|
+
* Allows clients to ignore duplicate webhooks.
|
2265
|
+
*/
|
2266
|
+
_id?: string;
|
2267
|
+
/**
|
2268
|
+
* Assumes actions are also always typed to an entity_type
|
2269
|
+
* Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
|
2270
|
+
*/
|
2271
|
+
entityFqdn?: string;
|
2272
|
+
/**
|
2273
|
+
* This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
|
2274
|
+
* This is although the created/updated/deleted notion is duplication of the oneof types
|
2275
|
+
* Example: created/updated/deleted/started/completed/email_opened
|
2276
|
+
*/
|
2277
|
+
slug?: string;
|
2278
|
+
/** ID of the entity associated with the event. */
|
2279
|
+
entityId?: string;
|
2280
|
+
/** Event timestamp. */
|
2281
|
+
eventTime?: Date;
|
2282
|
+
/**
|
2283
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
2284
|
+
* (for example, GDPR).
|
2285
|
+
*/
|
2286
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
2287
|
+
/** If present, indicates the action that triggered the event. */
|
2288
|
+
originatedFrom?: string | null;
|
2289
|
+
/**
|
2290
|
+
* A sequence number defining the order of updates to the underlying entity.
|
2291
|
+
* For example, given that some entity was updated at 16:00 and than again at 16:01,
|
2292
|
+
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
2293
|
+
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
2294
|
+
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
2295
|
+
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
2296
|
+
*/
|
2297
|
+
entityEventSequence?: string | null;
|
2298
|
+
}
|
2299
|
+
/** @oneof */
|
2300
|
+
interface DomainEventBodyOneOf {
|
2301
|
+
createdEvent?: EntityCreatedEvent;
|
2302
|
+
updatedEvent?: EntityUpdatedEvent;
|
2303
|
+
deletedEvent?: EntityDeletedEvent;
|
2304
|
+
actionEvent?: ActionEvent;
|
2305
|
+
}
|
2306
|
+
interface EntityCreatedEvent {
|
2307
|
+
entity?: string;
|
2308
|
+
}
|
2309
|
+
interface EntityUpdatedEvent {
|
2310
|
+
/**
|
2311
|
+
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
2312
|
+
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
2313
|
+
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
2314
|
+
*/
|
2315
|
+
currentEntity?: string;
|
2316
|
+
}
|
2317
|
+
interface EntityDeletedEvent {
|
2318
|
+
/** Entity that was deleted */
|
2319
|
+
deletedEntity?: string | null;
|
2320
|
+
}
|
2321
|
+
interface ActionEvent {
|
2322
|
+
body?: string;
|
2323
|
+
}
|
2324
|
+
interface MessageEnvelope {
|
2325
|
+
/** App instance ID. */
|
2326
|
+
instanceId?: string | null;
|
2327
|
+
/** Event type. */
|
2328
|
+
eventType?: string;
|
2329
|
+
/** The identification type and identity data. */
|
2330
|
+
identity?: IdentificationData;
|
2331
|
+
/** Stringify payload. */
|
2332
|
+
data?: string;
|
2333
|
+
}
|
1829
2334
|
interface IdentificationData extends IdentificationDataIdOneOf {
|
1830
2335
|
/** ID of a site visitor that has not logged in to the site. */
|
1831
2336
|
anonymousVisitorId?: string;
|
@@ -1856,131 +2361,76 @@ declare enum WebhookIdentityType {
|
|
1856
2361
|
WIX_USER = "WIX_USER",
|
1857
2362
|
APP = "APP"
|
1858
2363
|
}
|
2364
|
+
interface StringListNonNullableFields {
|
2365
|
+
values: string[];
|
2366
|
+
}
|
2367
|
+
interface DurationNonNullableFields {
|
2368
|
+
unit: PeriodUnit;
|
2369
|
+
}
|
2370
|
+
interface RecurrenceNonNullableFields {
|
2371
|
+
cycleDuration?: DurationNonNullableFields;
|
2372
|
+
}
|
2373
|
+
interface MoneyNonNullableFields {
|
2374
|
+
value: string;
|
2375
|
+
currency: string;
|
2376
|
+
}
|
2377
|
+
interface FeeNonNullableFields {
|
2378
|
+
name: string;
|
2379
|
+
amount: string;
|
2380
|
+
}
|
2381
|
+
interface FeeConfigNonNullableFields {
|
2382
|
+
fee?: FeeNonNullableFields;
|
2383
|
+
appliedAt: AppliedAt;
|
2384
|
+
}
|
2385
|
+
interface PricingNonNullableFields {
|
2386
|
+
subscription?: RecurrenceNonNullableFields;
|
2387
|
+
singlePaymentForDuration?: DurationNonNullableFields;
|
2388
|
+
price?: MoneyNonNullableFields;
|
2389
|
+
feeConfigs: FeeConfigNonNullableFields[];
|
2390
|
+
}
|
2391
|
+
interface PublicPlanNonNullableFields {
|
2392
|
+
_id: string;
|
2393
|
+
perks?: StringListNonNullableFields;
|
2394
|
+
pricing?: PricingNonNullableFields;
|
2395
|
+
primary: boolean;
|
2396
|
+
}
|
1859
2397
|
interface ListPublicPlansResponseNonNullableFields {
|
1860
|
-
plans:
|
1861
|
-
|
1862
|
-
|
1863
|
-
|
1864
|
-
|
1865
|
-
|
1866
|
-
|
1867
|
-
|
1868
|
-
|
1869
|
-
|
1870
|
-
|
1871
|
-
|
1872
|
-
|
1873
|
-
|
1874
|
-
|
1875
|
-
value: string;
|
1876
|
-
currency: string;
|
1877
|
-
};
|
1878
|
-
};
|
1879
|
-
primary: boolean;
|
1880
|
-
}[];
|
2398
|
+
plans: PublicPlanNonNullableFields[];
|
2399
|
+
}
|
2400
|
+
interface QueryPublicPlansResponseNonNullableFields {
|
2401
|
+
plans: PublicPlanNonNullableFields[];
|
2402
|
+
}
|
2403
|
+
interface PlanNonNullableFields {
|
2404
|
+
_id: string;
|
2405
|
+
perks?: StringListNonNullableFields;
|
2406
|
+
pricing?: PricingNonNullableFields;
|
2407
|
+
archived: boolean;
|
2408
|
+
primary: boolean;
|
2409
|
+
hasOrders: boolean;
|
2410
|
+
}
|
2411
|
+
interface GetPlanResponseNonNullableFields {
|
2412
|
+
plan?: PlanNonNullableFields;
|
1881
2413
|
}
|
1882
2414
|
interface ListPlansResponseNonNullableFields {
|
1883
|
-
plans:
|
1884
|
-
_id: string;
|
1885
|
-
perks?: {
|
1886
|
-
values: string[];
|
1887
|
-
};
|
1888
|
-
pricing?: {
|
1889
|
-
subscription?: {
|
1890
|
-
cycleDuration?: {
|
1891
|
-
unit: PeriodUnit;
|
1892
|
-
};
|
1893
|
-
};
|
1894
|
-
singlePaymentForDuration?: {
|
1895
|
-
unit: PeriodUnit;
|
1896
|
-
};
|
1897
|
-
price?: {
|
1898
|
-
value: string;
|
1899
|
-
currency: string;
|
1900
|
-
};
|
1901
|
-
};
|
1902
|
-
archived: boolean;
|
1903
|
-
primary: boolean;
|
1904
|
-
hasOrders: boolean;
|
1905
|
-
}[];
|
2415
|
+
plans: PlanNonNullableFields[];
|
1906
2416
|
}
|
1907
2417
|
interface GetPlanStatsResponseNonNullableFields {
|
1908
2418
|
totalPlans: number;
|
1909
2419
|
}
|
2420
|
+
interface CreatePlanResponseNonNullableFields {
|
2421
|
+
plan?: PlanNonNullableFields;
|
2422
|
+
}
|
2423
|
+
interface UpdatePlanResponseNonNullableFields {
|
2424
|
+
plan?: PlanNonNullableFields;
|
2425
|
+
}
|
1910
2426
|
interface SetPlanVisibilityResponseNonNullableFields {
|
1911
|
-
plan?:
|
1912
|
-
_id: string;
|
1913
|
-
perks?: {
|
1914
|
-
values: string[];
|
1915
|
-
};
|
1916
|
-
pricing?: {
|
1917
|
-
subscription?: {
|
1918
|
-
cycleDuration?: {
|
1919
|
-
unit: PeriodUnit;
|
1920
|
-
};
|
1921
|
-
};
|
1922
|
-
singlePaymentForDuration?: {
|
1923
|
-
unit: PeriodUnit;
|
1924
|
-
};
|
1925
|
-
price?: {
|
1926
|
-
value: string;
|
1927
|
-
currency: string;
|
1928
|
-
};
|
1929
|
-
};
|
1930
|
-
archived: boolean;
|
1931
|
-
primary: boolean;
|
1932
|
-
hasOrders: boolean;
|
1933
|
-
};
|
2427
|
+
plan?: PlanNonNullableFields;
|
1934
2428
|
}
|
1935
2429
|
interface MakePlanPrimaryResponseNonNullableFields {
|
1936
|
-
plan?:
|
1937
|
-
_id: string;
|
1938
|
-
perks?: {
|
1939
|
-
values: string[];
|
1940
|
-
};
|
1941
|
-
pricing?: {
|
1942
|
-
subscription?: {
|
1943
|
-
cycleDuration?: {
|
1944
|
-
unit: PeriodUnit;
|
1945
|
-
};
|
1946
|
-
};
|
1947
|
-
singlePaymentForDuration?: {
|
1948
|
-
unit: PeriodUnit;
|
1949
|
-
};
|
1950
|
-
price?: {
|
1951
|
-
value: string;
|
1952
|
-
currency: string;
|
1953
|
-
};
|
1954
|
-
};
|
1955
|
-
archived: boolean;
|
1956
|
-
primary: boolean;
|
1957
|
-
hasOrders: boolean;
|
1958
|
-
};
|
2430
|
+
plan?: PlanNonNullableFields;
|
1959
2431
|
}
|
1960
2432
|
interface ArchivePlanResponseNonNullableFields {
|
1961
|
-
plan?:
|
1962
|
-
_id: string;
|
1963
|
-
perks?: {
|
1964
|
-
values: string[];
|
1965
|
-
};
|
1966
|
-
pricing?: {
|
1967
|
-
subscription?: {
|
1968
|
-
cycleDuration?: {
|
1969
|
-
unit: PeriodUnit;
|
1970
|
-
};
|
1971
|
-
};
|
1972
|
-
singlePaymentForDuration?: {
|
1973
|
-
unit: PeriodUnit;
|
1974
|
-
};
|
1975
|
-
price?: {
|
1976
|
-
value: string;
|
1977
|
-
currency: string;
|
1978
|
-
};
|
1979
|
-
};
|
1980
|
-
archived: boolean;
|
1981
|
-
primary: boolean;
|
1982
|
-
hasOrders: boolean;
|
1983
|
-
};
|
2433
|
+
plan?: PlanNonNullableFields;
|
1984
2434
|
}
|
1985
2435
|
interface BaseEventMetadata {
|
1986
2436
|
/** App instance ID. */
|
@@ -2227,106 +2677,117 @@ interface UpdatePlan {
|
|
2227
2677
|
formId?: string | null;
|
2228
2678
|
}
|
2229
2679
|
|
2230
|
-
declare function
|
2231
|
-
|
2232
|
-
declare function
|
2233
|
-
_id: string;
|
2234
|
-
perks?: {
|
2235
|
-
values: string[];
|
2236
|
-
} | undefined;
|
2237
|
-
pricing?: {
|
2238
|
-
subscription?: {
|
2239
|
-
cycleDuration?: {
|
2240
|
-
unit: PeriodUnit;
|
2241
|
-
} | undefined;
|
2242
|
-
} | undefined;
|
2243
|
-
singlePaymentForDuration?: {
|
2244
|
-
unit: PeriodUnit;
|
2245
|
-
} | undefined;
|
2246
|
-
price?: {
|
2247
|
-
value: string;
|
2248
|
-
currency: string;
|
2249
|
-
} | undefined;
|
2250
|
-
} | undefined;
|
2251
|
-
archived: boolean;
|
2252
|
-
primary: boolean;
|
2253
|
-
hasOrders: boolean;
|
2254
|
-
}>;
|
2255
|
-
declare function listPlans$1(httpClient: HttpClient): (options?: ListPlansOptions) => Promise<ListPlansResponse & ListPlansResponseNonNullableFields>;
|
2256
|
-
declare function getPlanStats$1(httpClient: HttpClient): () => Promise<GetPlanStatsResponse & GetPlanStatsResponseNonNullableFields>;
|
2257
|
-
declare function createPlan$1(httpClient: HttpClient): (plan: Plan) => Promise<Plan & {
|
2258
|
-
_id: string;
|
2259
|
-
perks?: {
|
2260
|
-
values: string[];
|
2261
|
-
} | undefined;
|
2262
|
-
pricing?: {
|
2263
|
-
subscription?: {
|
2264
|
-
cycleDuration?: {
|
2265
|
-
unit: PeriodUnit;
|
2266
|
-
} | undefined;
|
2267
|
-
} | undefined;
|
2268
|
-
singlePaymentForDuration?: {
|
2269
|
-
unit: PeriodUnit;
|
2270
|
-
} | undefined;
|
2271
|
-
price?: {
|
2272
|
-
value: string;
|
2273
|
-
currency: string;
|
2274
|
-
} | undefined;
|
2275
|
-
} | undefined;
|
2276
|
-
archived: boolean;
|
2277
|
-
primary: boolean;
|
2278
|
-
hasOrders: boolean;
|
2279
|
-
}>;
|
2280
|
-
declare function updatePlan$1(httpClient: HttpClient): (_id: string, plan: UpdatePlan) => Promise<Plan & {
|
2281
|
-
_id: string;
|
2282
|
-
perks?: {
|
2283
|
-
values: string[];
|
2284
|
-
} | undefined;
|
2285
|
-
pricing?: {
|
2286
|
-
subscription?: {
|
2287
|
-
cycleDuration?: {
|
2288
|
-
unit: PeriodUnit;
|
2289
|
-
} | undefined;
|
2290
|
-
} | undefined;
|
2291
|
-
singlePaymentForDuration?: {
|
2292
|
-
unit: PeriodUnit;
|
2293
|
-
} | undefined;
|
2294
|
-
price?: {
|
2295
|
-
value: string;
|
2296
|
-
currency: string;
|
2297
|
-
} | undefined;
|
2298
|
-
} | undefined;
|
2299
|
-
archived: boolean;
|
2300
|
-
primary: boolean;
|
2301
|
-
hasOrders: boolean;
|
2302
|
-
}>;
|
2303
|
-
declare function setPlanVisibility$1(httpClient: HttpClient): (_id: string, visible: boolean) => Promise<SetPlanVisibilityResponse & SetPlanVisibilityResponseNonNullableFields>;
|
2304
|
-
declare function makePlanPrimary$1(httpClient: HttpClient): (_id: string) => Promise<MakePlanPrimaryResponse & MakePlanPrimaryResponseNonNullableFields>;
|
2305
|
-
declare function clearPrimary$1(httpClient: HttpClient): () => Promise<void>;
|
2306
|
-
declare function archivePlan$1(httpClient: HttpClient): (_id: string) => Promise<ArchivePlanResponse & ArchivePlanResponseNonNullableFields>;
|
2307
|
-
declare function arrangePlans$1(httpClient: HttpClient): (ids: string[]) => Promise<void>;
|
2308
|
-
declare const onPlanUpdated$1: EventDefinition<PlanUpdatedEnvelope, "wix.pricing_plans.plan_updated">;
|
2309
|
-
declare const onPlanCreated$1: EventDefinition<PlanCreatedEnvelope, "wix.pricing_plans.plan_created">;
|
2310
|
-
declare const onPlanBuyerCanCancelUpdated$1: EventDefinition<PlanBuyerCanCancelUpdatedEnvelope, "wix.pricing_plans.plan_buyer_can_cancel_updated">;
|
2311
|
-
declare const onPlanArchived$1: EventDefinition<PlanArchivedEnvelope, "wix.pricing_plans.plan_plan_archived">;
|
2680
|
+
declare function createRESTModule<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
|
2681
|
+
|
2682
|
+
declare function createEventModule<T extends EventDefinition<any, string>>(eventDefinition: T): BuildEventDefinition<T> & T;
|
2312
2683
|
|
2313
|
-
declare const listPublicPlans:
|
2314
|
-
declare const queryPublicPlans:
|
2315
|
-
declare const getPlan:
|
2316
|
-
declare const listPlans:
|
2317
|
-
declare const getPlanStats:
|
2318
|
-
declare const createPlan:
|
2319
|
-
declare const updatePlan:
|
2320
|
-
declare const setPlanVisibility:
|
2321
|
-
declare const makePlanPrimary:
|
2322
|
-
declare const clearPrimary:
|
2323
|
-
declare const archivePlan:
|
2324
|
-
declare const arrangePlans:
|
2325
|
-
declare const onPlanUpdated:
|
2326
|
-
declare const onPlanCreated:
|
2327
|
-
declare const onPlanBuyerCanCancelUpdated:
|
2328
|
-
declare const onPlanArchived:
|
2684
|
+
declare const listPublicPlans: ReturnType<typeof createRESTModule<typeof publicListPublicPlans>>;
|
2685
|
+
declare const queryPublicPlans: ReturnType<typeof createRESTModule<typeof publicQueryPublicPlans>>;
|
2686
|
+
declare const getPlan: ReturnType<typeof createRESTModule<typeof publicGetPlan>>;
|
2687
|
+
declare const listPlans: ReturnType<typeof createRESTModule<typeof publicListPlans>>;
|
2688
|
+
declare const getPlanStats: ReturnType<typeof createRESTModule<typeof publicGetPlanStats>>;
|
2689
|
+
declare const createPlan: ReturnType<typeof createRESTModule<typeof publicCreatePlan>>;
|
2690
|
+
declare const updatePlan: ReturnType<typeof createRESTModule<typeof publicUpdatePlan>>;
|
2691
|
+
declare const setPlanVisibility: ReturnType<typeof createRESTModule<typeof publicSetPlanVisibility>>;
|
2692
|
+
declare const makePlanPrimary: ReturnType<typeof createRESTModule<typeof publicMakePlanPrimary>>;
|
2693
|
+
declare const clearPrimary: ReturnType<typeof createRESTModule<typeof publicClearPrimary>>;
|
2694
|
+
declare const archivePlan: ReturnType<typeof createRESTModule<typeof publicArchivePlan>>;
|
2695
|
+
declare const arrangePlans: ReturnType<typeof createRESTModule<typeof publicArrangePlans>>;
|
2696
|
+
declare const onPlanUpdated: ReturnType<typeof createEventModule<typeof publicOnPlanUpdated>>;
|
2697
|
+
declare const onPlanCreated: ReturnType<typeof createEventModule<typeof publicOnPlanCreated>>;
|
2698
|
+
declare const onPlanBuyerCanCancelUpdated: ReturnType<typeof createEventModule<typeof publicOnPlanBuyerCanCancelUpdated>>;
|
2699
|
+
declare const onPlanArchived: ReturnType<typeof createEventModule<typeof publicOnPlanArchived>>;
|
2329
2700
|
|
2701
|
+
type context_ActionEvent = ActionEvent;
|
2702
|
+
type context_ApplicationError = ApplicationError;
|
2703
|
+
type context_AppliedAt = AppliedAt;
|
2704
|
+
declare const context_AppliedAt: typeof AppliedAt;
|
2705
|
+
type context_ArchivePlanRequest = ArchivePlanRequest;
|
2706
|
+
type context_ArchivePlanResponse = ArchivePlanResponse;
|
2707
|
+
type context_ArchivePlanResponseNonNullableFields = ArchivePlanResponseNonNullableFields;
|
2708
|
+
type context_ArchivedFilter = ArchivedFilter;
|
2709
|
+
declare const context_ArchivedFilter: typeof ArchivedFilter;
|
2710
|
+
type context_ArrangePlansRequest = ArrangePlansRequest;
|
2711
|
+
type context_ArrangePlansResponse = ArrangePlansResponse;
|
2712
|
+
type context_BaseEventMetadata = BaseEventMetadata;
|
2713
|
+
type context_BulkActionMetadata = BulkActionMetadata;
|
2714
|
+
type context_BulkArchivePlanRequest = BulkArchivePlanRequest;
|
2715
|
+
type context_BulkArchivePlanResponse = BulkArchivePlanResponse;
|
2716
|
+
type context_BulkPlanResult = BulkPlanResult;
|
2717
|
+
type context_BuyerCanCancelUpdated = BuyerCanCancelUpdated;
|
2718
|
+
type context_ClearPrimaryRequest = ClearPrimaryRequest;
|
2719
|
+
type context_ClearPrimaryResponse = ClearPrimaryResponse;
|
2720
|
+
type context_CreatePlanRequest = CreatePlanRequest;
|
2721
|
+
type context_CreatePlanResponse = CreatePlanResponse;
|
2722
|
+
type context_CreatePlanResponseNonNullableFields = CreatePlanResponseNonNullableFields;
|
2723
|
+
type context_Cursors = Cursors;
|
2724
|
+
type context_DomainEvent = DomainEvent;
|
2725
|
+
type context_DomainEventBodyOneOf = DomainEventBodyOneOf;
|
2726
|
+
type context_Duration = Duration;
|
2727
|
+
type context_EntityCreatedEvent = EntityCreatedEvent;
|
2728
|
+
type context_EntityDeletedEvent = EntityDeletedEvent;
|
2729
|
+
type context_EntityUpdatedEvent = EntityUpdatedEvent;
|
2730
|
+
type context_EventMetadata = EventMetadata;
|
2731
|
+
type context_Fee = Fee;
|
2732
|
+
type context_FeeConfig = FeeConfig;
|
2733
|
+
type context_GetPlanRequest = GetPlanRequest;
|
2734
|
+
type context_GetPlanResponse = GetPlanResponse;
|
2735
|
+
type context_GetPlanResponseNonNullableFields = GetPlanResponseNonNullableFields;
|
2736
|
+
type context_GetPlanStatsRequest = GetPlanStatsRequest;
|
2737
|
+
type context_GetPlanStatsResponse = GetPlanStatsResponse;
|
2738
|
+
type context_GetPlanStatsResponseNonNullableFields = GetPlanStatsResponseNonNullableFields;
|
2739
|
+
type context_IdentificationData = IdentificationData;
|
2740
|
+
type context_IdentificationDataIdOneOf = IdentificationDataIdOneOf;
|
2741
|
+
type context_ItemMetadata = ItemMetadata;
|
2742
|
+
type context_ListPlansOptions = ListPlansOptions;
|
2743
|
+
type context_ListPlansRequest = ListPlansRequest;
|
2744
|
+
type context_ListPlansResponse = ListPlansResponse;
|
2745
|
+
type context_ListPlansResponseNonNullableFields = ListPlansResponseNonNullableFields;
|
2746
|
+
type context_ListPublicPlansOptions = ListPublicPlansOptions;
|
2747
|
+
type context_ListPublicPlansRequest = ListPublicPlansRequest;
|
2748
|
+
type context_ListPublicPlansResponse = ListPublicPlansResponse;
|
2749
|
+
type context_ListPublicPlansResponseNonNullableFields = ListPublicPlansResponseNonNullableFields;
|
2750
|
+
type context_MakePlanPrimaryRequest = MakePlanPrimaryRequest;
|
2751
|
+
type context_MakePlanPrimaryResponse = MakePlanPrimaryResponse;
|
2752
|
+
type context_MakePlanPrimaryResponseNonNullableFields = MakePlanPrimaryResponseNonNullableFields;
|
2753
|
+
type context_MessageEnvelope = MessageEnvelope;
|
2754
|
+
type context_Money = Money;
|
2755
|
+
type context_Paging = Paging;
|
2756
|
+
type context_PagingMetadataV2 = PagingMetadataV2;
|
2757
|
+
type context_PeriodUnit = PeriodUnit;
|
2758
|
+
declare const context_PeriodUnit: typeof PeriodUnit;
|
2759
|
+
type context_Plan = Plan;
|
2760
|
+
type context_PlanArchived = PlanArchived;
|
2761
|
+
type context_PlanArchivedEnvelope = PlanArchivedEnvelope;
|
2762
|
+
type context_PlanBuyerCanCancelUpdatedEnvelope = PlanBuyerCanCancelUpdatedEnvelope;
|
2763
|
+
type context_PlanCreatedEnvelope = PlanCreatedEnvelope;
|
2764
|
+
type context_PlanNonNullableFields = PlanNonNullableFields;
|
2765
|
+
type context_PlanUpdatedEnvelope = PlanUpdatedEnvelope;
|
2766
|
+
type context_PlansQueryBuilder = PlansQueryBuilder;
|
2767
|
+
type context_PlansQueryResult = PlansQueryResult;
|
2768
|
+
type context_Pricing = Pricing;
|
2769
|
+
type context_PricingPricingModelOneOf = PricingPricingModelOneOf;
|
2770
|
+
type context_PublicFilter = PublicFilter;
|
2771
|
+
declare const context_PublicFilter: typeof PublicFilter;
|
2772
|
+
type context_PublicPlan = PublicPlan;
|
2773
|
+
type context_QueryPublicPlansRequest = QueryPublicPlansRequest;
|
2774
|
+
type context_QueryPublicPlansResponse = QueryPublicPlansResponse;
|
2775
|
+
type context_QueryPublicPlansResponseNonNullableFields = QueryPublicPlansResponseNonNullableFields;
|
2776
|
+
type context_QueryV2 = QueryV2;
|
2777
|
+
type context_Recurrence = Recurrence;
|
2778
|
+
type context_SetPlanVisibilityRequest = SetPlanVisibilityRequest;
|
2779
|
+
type context_SetPlanVisibilityResponse = SetPlanVisibilityResponse;
|
2780
|
+
type context_SetPlanVisibilityResponseNonNullableFields = SetPlanVisibilityResponseNonNullableFields;
|
2781
|
+
type context_SortOrder = SortOrder;
|
2782
|
+
declare const context_SortOrder: typeof SortOrder;
|
2783
|
+
type context_Sorting = Sorting;
|
2784
|
+
type context_StringList = StringList;
|
2785
|
+
type context_UpdatePlan = UpdatePlan;
|
2786
|
+
type context_UpdatePlanRequest = UpdatePlanRequest;
|
2787
|
+
type context_UpdatePlanResponse = UpdatePlanResponse;
|
2788
|
+
type context_UpdatePlanResponseNonNullableFields = UpdatePlanResponseNonNullableFields;
|
2789
|
+
type context_WebhookIdentityType = WebhookIdentityType;
|
2790
|
+
declare const context_WebhookIdentityType: typeof WebhookIdentityType;
|
2330
2791
|
declare const context_archivePlan: typeof archivePlan;
|
2331
2792
|
declare const context_arrangePlans: typeof arrangePlans;
|
2332
2793
|
declare const context_clearPrimary: typeof clearPrimary;
|
@@ -2344,7 +2805,7 @@ declare const context_queryPublicPlans: typeof queryPublicPlans;
|
|
2344
2805
|
declare const context_setPlanVisibility: typeof setPlanVisibility;
|
2345
2806
|
declare const context_updatePlan: typeof updatePlan;
|
2346
2807
|
declare namespace context {
|
2347
|
-
export { context_archivePlan as archivePlan, context_arrangePlans as arrangePlans, context_clearPrimary as clearPrimary, context_createPlan as createPlan, context_getPlan as getPlan, context_getPlanStats as getPlanStats, context_listPlans as listPlans, context_listPublicPlans as listPublicPlans, context_makePlanPrimary as makePlanPrimary, context_onPlanArchived as onPlanArchived, context_onPlanBuyerCanCancelUpdated as onPlanBuyerCanCancelUpdated, context_onPlanCreated as onPlanCreated, context_onPlanUpdated as onPlanUpdated, context_queryPublicPlans as queryPublicPlans, context_setPlanVisibility as setPlanVisibility, context_updatePlan as updatePlan };
|
2808
|
+
export { type context_ActionEvent as ActionEvent, type context_ApplicationError as ApplicationError, context_AppliedAt as AppliedAt, type context_ArchivePlanRequest as ArchivePlanRequest, type context_ArchivePlanResponse as ArchivePlanResponse, type context_ArchivePlanResponseNonNullableFields as ArchivePlanResponseNonNullableFields, context_ArchivedFilter as ArchivedFilter, type context_ArrangePlansRequest as ArrangePlansRequest, type context_ArrangePlansResponse as ArrangePlansResponse, type context_BaseEventMetadata as BaseEventMetadata, type context_BulkActionMetadata as BulkActionMetadata, type context_BulkArchivePlanRequest as BulkArchivePlanRequest, type context_BulkArchivePlanResponse as BulkArchivePlanResponse, type context_BulkPlanResult as BulkPlanResult, type context_BuyerCanCancelUpdated as BuyerCanCancelUpdated, type context_ClearPrimaryRequest as ClearPrimaryRequest, type context_ClearPrimaryResponse as ClearPrimaryResponse, type context_CreatePlanRequest as CreatePlanRequest, type context_CreatePlanResponse as CreatePlanResponse, type context_CreatePlanResponseNonNullableFields as CreatePlanResponseNonNullableFields, type context_Cursors as Cursors, type context_DomainEvent as DomainEvent, type context_DomainEventBodyOneOf as DomainEventBodyOneOf, type context_Duration as Duration, type context_EntityCreatedEvent as EntityCreatedEvent, type context_EntityDeletedEvent as EntityDeletedEvent, type context_EntityUpdatedEvent as EntityUpdatedEvent, type context_EventMetadata as EventMetadata, type context_Fee as Fee, type context_FeeConfig as FeeConfig, type context_GetPlanRequest as GetPlanRequest, type context_GetPlanResponse as GetPlanResponse, type context_GetPlanResponseNonNullableFields as GetPlanResponseNonNullableFields, type context_GetPlanStatsRequest as GetPlanStatsRequest, type context_GetPlanStatsResponse as GetPlanStatsResponse, type context_GetPlanStatsResponseNonNullableFields as GetPlanStatsResponseNonNullableFields, type context_IdentificationData as IdentificationData, type context_IdentificationDataIdOneOf as IdentificationDataIdOneOf, type context_ItemMetadata as ItemMetadata, type context_ListPlansOptions as ListPlansOptions, type context_ListPlansRequest as ListPlansRequest, type context_ListPlansResponse as ListPlansResponse, type context_ListPlansResponseNonNullableFields as ListPlansResponseNonNullableFields, type context_ListPublicPlansOptions as ListPublicPlansOptions, type context_ListPublicPlansRequest as ListPublicPlansRequest, type context_ListPublicPlansResponse as ListPublicPlansResponse, type context_ListPublicPlansResponseNonNullableFields as ListPublicPlansResponseNonNullableFields, type context_MakePlanPrimaryRequest as MakePlanPrimaryRequest, type context_MakePlanPrimaryResponse as MakePlanPrimaryResponse, type context_MakePlanPrimaryResponseNonNullableFields as MakePlanPrimaryResponseNonNullableFields, type context_MessageEnvelope as MessageEnvelope, type context_Money as Money, type context_Paging as Paging, type context_PagingMetadataV2 as PagingMetadataV2, context_PeriodUnit as PeriodUnit, type context_Plan as Plan, type context_PlanArchived as PlanArchived, type context_PlanArchivedEnvelope as PlanArchivedEnvelope, type context_PlanBuyerCanCancelUpdatedEnvelope as PlanBuyerCanCancelUpdatedEnvelope, type context_PlanCreatedEnvelope as PlanCreatedEnvelope, type context_PlanNonNullableFields as PlanNonNullableFields, type context_PlanUpdatedEnvelope as PlanUpdatedEnvelope, type context_PlansQueryBuilder as PlansQueryBuilder, type context_PlansQueryResult as PlansQueryResult, type context_Pricing as Pricing, type context_PricingPricingModelOneOf as PricingPricingModelOneOf, context_PublicFilter as PublicFilter, type context_PublicPlan as PublicPlan, type context_QueryPublicPlansRequest as QueryPublicPlansRequest, type context_QueryPublicPlansResponse as QueryPublicPlansResponse, type context_QueryPublicPlansResponseNonNullableFields as QueryPublicPlansResponseNonNullableFields, type context_QueryV2 as QueryV2, type context_Recurrence as Recurrence, type context_SetPlanVisibilityRequest as SetPlanVisibilityRequest, type context_SetPlanVisibilityResponse as SetPlanVisibilityResponse, type context_SetPlanVisibilityResponseNonNullableFields as SetPlanVisibilityResponseNonNullableFields, context_SortOrder as SortOrder, type context_Sorting as Sorting, type context_StringList as StringList, type context_UpdatePlan as UpdatePlan, type context_UpdatePlanRequest as UpdatePlanRequest, type context_UpdatePlanResponse as UpdatePlanResponse, type context_UpdatePlanResponseNonNullableFields as UpdatePlanResponseNonNullableFields, context_WebhookIdentityType as WebhookIdentityType, context_archivePlan as archivePlan, context_arrangePlans as arrangePlans, context_clearPrimary as clearPrimary, context_createPlan as createPlan, context_getPlan as getPlan, context_getPlanStats as getPlanStats, context_listPlans as listPlans, context_listPublicPlans as listPublicPlans, context_makePlanPrimary as makePlanPrimary, context_onPlanArchived as onPlanArchived, context_onPlanBuyerCanCancelUpdated as onPlanBuyerCanCancelUpdated, context_onPlanCreated as onPlanCreated, context_onPlanUpdated as onPlanUpdated, context_queryPublicPlans as queryPublicPlans, context_setPlanVisibility as setPlanVisibility, context_updatePlan as updatePlan };
|
2348
2809
|
}
|
2349
2810
|
|
2350
2811
|
export { context$1 as orders, context as plans };
|