@wix/pricing-plans 1.0.79 → 1.0.81

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.
@@ -1,3 +1,47 @@
1
+ type RESTFunctionDescriptor<T extends (...args: any[]) => any = (...args: any[]) => any> = (httpClient: HttpClient) => T;
2
+ interface HttpClient {
3
+ request<TResponse, TData = any>(req: RequestOptionsFactory<TResponse, TData>): Promise<HttpResponse<TResponse>>;
4
+ fetchWithAuth: typeof fetch;
5
+ wixAPIFetch: (relativeUrl: string, options: RequestInit) => Promise<Response>;
6
+ }
7
+ type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
8
+ type HttpResponse<T = any> = {
9
+ data: T;
10
+ status: number;
11
+ statusText: string;
12
+ headers: any;
13
+ request?: any;
14
+ };
15
+ type RequestOptions<_TResponse = any, Data = any> = {
16
+ method: 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
17
+ url: string;
18
+ data?: Data;
19
+ params?: URLSearchParams;
20
+ } & APIMetadata;
21
+ type APIMetadata = {
22
+ methodFqn?: string;
23
+ entityFqdn?: string;
24
+ packageName?: string;
25
+ };
26
+ type BuildRESTFunction<T extends RESTFunctionDescriptor> = T extends RESTFunctionDescriptor<infer U> ? U : never;
27
+ type EventDefinition<Payload = unknown, Type extends string = string> = {
28
+ __type: 'event-definition';
29
+ type: Type;
30
+ isDomainEvent?: boolean;
31
+ transformations?: (envelope: unknown) => Payload;
32
+ __payload: Payload;
33
+ };
34
+ declare function EventDefinition<Type extends string>(type: Type, isDomainEvent?: boolean, transformations?: (envelope: any) => unknown): <Payload = unknown>() => EventDefinition<Payload, Type>;
35
+ type EventHandler<T extends EventDefinition> = (payload: T['__payload']) => void | Promise<void>;
36
+ type BuildEventDefinition<T extends EventDefinition<any, string>> = (handler: EventHandler<T>) => void;
37
+
38
+ declare global {
39
+ // eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
40
+ interface SymbolConstructor {
41
+ readonly observable: symbol;
42
+ }
43
+ }
44
+
1
45
  /**
2
46
  * An order object includes all of the details related to the purchase of a Pricing Plan.
3
47
  * You can manage existing orders, create offline orders, and preview orders not yet purchased.
@@ -508,6 +552,357 @@ interface FormData {
508
552
  */
509
553
  submissionData?: Record<string, any>;
510
554
  }
555
+ interface UpdatedWithPreviousEntity {
556
+ /** previous automation */
557
+ previousAutomation?: Automation;
558
+ /** updated automation */
559
+ currentAutomation?: Automation;
560
+ }
561
+ interface Automation extends AutomationOriginInfoOneOf {
562
+ /** Application info */
563
+ applicationInfo?: ApplicationOrigin;
564
+ /** Preinstalled info */
565
+ preinstalledInfo?: PreinstalledOrigin;
566
+ /**
567
+ * Automation ID.
568
+ * @readonly
569
+ */
570
+ _id?: string | null;
571
+ /**
572
+ * Revision number, which increments by 1 each time the automation is updated.
573
+ * To prevent conflicting changes,
574
+ * the current revision must be passed when updating the automation.
575
+ *
576
+ * Ignored when creating an automation.
577
+ * @readonly
578
+ */
579
+ revision?: string | null;
580
+ /**
581
+ * Information about the creator of the automation.
582
+ * @readonly
583
+ */
584
+ createdBy?: AuditInfo;
585
+ /**
586
+ * Date and time the automation was created.
587
+ * @readonly
588
+ */
589
+ _createdDate?: Date;
590
+ /**
591
+ * The entity that last updated the automation.
592
+ * @readonly
593
+ */
594
+ updatedBy?: AuditInfo;
595
+ /**
596
+ * Date and time the automation was last updated.
597
+ * @readonly
598
+ */
599
+ _updatedDate?: Date;
600
+ /** Automation name that is displayed on the user's site. */
601
+ name?: string;
602
+ /** Automation description. */
603
+ description?: string | null;
604
+ /** Object that defines the automation's trigger, actions, and activation status. */
605
+ configuration?: AutomationConfiguration;
606
+ /** Defines how the automation was added to the site. */
607
+ origin?: Origin;
608
+ /** Automation settings. */
609
+ settings?: AutomationSettings;
610
+ /**
611
+ * Draft info (optional - only if the automation is a draft)
612
+ * @readonly
613
+ */
614
+ draftInfo?: DraftInfo;
615
+ }
616
+ /** @oneof */
617
+ interface AutomationOriginInfoOneOf {
618
+ /** Application info */
619
+ applicationInfo?: ApplicationOrigin;
620
+ /** Preinstalled info */
621
+ preinstalledInfo?: PreinstalledOrigin;
622
+ }
623
+ interface ActionSettings {
624
+ /**
625
+ * List of actions that cannot be deleted.
626
+ * Default: Empty. All actions are deletable by default.
627
+ */
628
+ permanentActionIds?: string[];
629
+ /**
630
+ * List of actions that cannot be edited.
631
+ * Default: Empty. All actions are editable by default.
632
+ */
633
+ readonlyActionIds?: string[];
634
+ /** Whether the option to add a delay is disabled for the automation. */
635
+ disableDelayAddition?: boolean;
636
+ /** Whether the option to add a condition is disabled for the automation. */
637
+ disableConditionAddition?: boolean;
638
+ }
639
+ interface AuditInfo extends AuditInfoIdOneOf {
640
+ /** User ID. */
641
+ userId?: string;
642
+ /** Application ID. */
643
+ appId?: string;
644
+ }
645
+ /** @oneof */
646
+ interface AuditInfoIdOneOf {
647
+ /** User ID. */
648
+ userId?: string;
649
+ /** Application ID. */
650
+ appId?: string;
651
+ }
652
+ /** Automation runtime configuration */
653
+ interface AutomationConfiguration {
654
+ /** Status of the automation on the site. */
655
+ status?: AutomationConfigurationStatus;
656
+ /** Automation trigger configuration. */
657
+ trigger?: Trigger;
658
+ /** List of IDs of root actions. Root actions are the first actions to run after the trigger. The actions in the list run in parallel. */
659
+ rootActionIds?: string[];
660
+ /**
661
+ * Map of all actions that the automation may execute.
662
+ * The key is the action ID, and the value is the action configuration.
663
+ */
664
+ actions?: Record<string, Action>;
665
+ }
666
+ declare enum TimeUnit {
667
+ UNKNOWN_TIME_UNIT = "UNKNOWN_TIME_UNIT",
668
+ MINUTES = "MINUTES",
669
+ HOURS = "HOURS",
670
+ DAYS = "DAYS",
671
+ WEEKS = "WEEKS",
672
+ MONTHS = "MONTHS"
673
+ }
674
+ interface Filter {
675
+ /** Filter ID. */
676
+ _id?: string;
677
+ /** Field key from the payload schema, for example "formId". */
678
+ fieldKey?: string;
679
+ /** Filter expression that evaluates to a boolean. */
680
+ filterExpression?: string;
681
+ }
682
+ interface FutureDateActivationOffset {
683
+ /**
684
+ * The offset value. The value is always taken as negative, so that the automation runs before the trigger date.
685
+ * To create an offset that causes the automation to run after the trigger date, use a delay action.
686
+ */
687
+ preScheduledEventOffsetExpression?: string;
688
+ /** Time unit for the scheduled event offset. */
689
+ scheduledEventOffsetTimeUnit?: TimeUnit;
690
+ }
691
+ interface RateLimit {
692
+ /** Value expressing the maximum number of times the trigger can be activated. */
693
+ maxActivationsExpression?: string;
694
+ /** Duration of the rate limiting window in the selected time unit. If no value is set, the rate limit is permanent. */
695
+ durationExpression?: string | null;
696
+ /** Time unit for the rate limit duration. */
697
+ durationTimeUnit?: TimeUnit;
698
+ /** Unique identifier of each activation, by which rate limiter will count activations. */
699
+ uniqueIdentifierExpression?: string | null;
700
+ }
701
+ interface ConditionExpressionGroup {
702
+ /** Expression group operator. */
703
+ operator?: Operator;
704
+ /** List of boolean expressions to be evaluated with the given operator. */
705
+ booleanExpressions?: string[];
706
+ }
707
+ declare enum Operator {
708
+ UNKNOWN_OPERATOR = "UNKNOWN_OPERATOR",
709
+ OR = "OR",
710
+ AND = "AND"
711
+ }
712
+ declare enum Type {
713
+ /** Automation will be triggered according to the trigger configuration */
714
+ UNKNOWN_ACTION_TYPE = "UNKNOWN_ACTION_TYPE",
715
+ /** App defined Action */
716
+ APP_DEFINED = "APP_DEFINED",
717
+ /** Condition Action */
718
+ CONDITION = "CONDITION",
719
+ /** Delay Action */
720
+ DELAY = "DELAY",
721
+ /** RateLimit Action */
722
+ RATE_LIMIT = "RATE_LIMIT",
723
+ /** Output Action */
724
+ OUTPUT = "OUTPUT"
725
+ }
726
+ interface AppDefinedAction {
727
+ /** ID of the app that defines the action. */
728
+ appId?: string;
729
+ /** Action key. */
730
+ actionKey?: string;
731
+ /** Action input mapping. */
732
+ inputMapping?: Record<string, any> | null;
733
+ /**
734
+ * Array of conditions determining whether to skip the action in the automation flow.
735
+ * The action will be skipped if any of the expression groups evaluate to `true`.
736
+ * Actions following a skipped action will still run.
737
+ */
738
+ skipConditionOrExpressionGroups?: ConditionExpressionGroup[];
739
+ /** List of IDs of actions to run in parallel once the action completes. */
740
+ postActionIds?: string[];
741
+ }
742
+ interface ConditionAction {
743
+ /** The condition evaluates to `true` if either of the expression groups evaluate to `true`. */
744
+ orExpressionGroups?: ConditionExpressionGroup[];
745
+ /** List of IDs of actions to run when the entire condition is evaluated to `true`. */
746
+ truePostActionIds?: string[];
747
+ /** List of IDs of actions to run when the entire condition is evaluated to `false`. */
748
+ falsePostActionIds?: string[];
749
+ }
750
+ interface DelayAction {
751
+ /** Value expressing the amount of time to wait from a specific date or from the time the action is executed. */
752
+ offsetExpression?: string | null;
753
+ /** Time unit for delay offset. */
754
+ offsetTimeUnit?: TimeUnit;
755
+ /**
756
+ * The action due date. If defined without an offset, the automation will wait until this date to execute the next step.
757
+ * If an offset is defined, it's calculated from this date.
758
+ * The date is expressed in the number of milliseconds since the Unix Epoch (1 January, 1970 UTC).
759
+ */
760
+ dueDateEpochExpression?: string | null;
761
+ /** List of IDs of actions to run in parallel after the delay. */
762
+ postActionIds?: string[];
763
+ }
764
+ interface RateLimitAction {
765
+ /** The maximum number of activations allowed for the action. */
766
+ maxActivationsExpression?: string;
767
+ /**
768
+ * Duration of the rate limiting window, expressed in selected time unit.
769
+ * If no value is set, then there is no time limit on the rate limiter.
770
+ */
771
+ rateLimitDurationExpression?: string | null;
772
+ /** Time unit for the rate limit duration. */
773
+ rateLimitDurationTimeUnit?: TimeUnit;
774
+ /** Unique identifier of each activation by which rate limiter counts activations. */
775
+ uniqueIdentifierExpression?: string | null;
776
+ /** List of IDs of actions to run in parallel once the action completes. */
777
+ postActionIds?: string[];
778
+ }
779
+ interface OutputAction {
780
+ /** Output action output mapping. */
781
+ outputMapping?: Record<string, any> | null;
782
+ }
783
+ declare enum AutomationConfigurationStatus {
784
+ /** unused */
785
+ UNKNOWN_STATUS = "UNKNOWN_STATUS",
786
+ /** Automation will be triggered according to the trigger configuration */
787
+ ACTIVE = "ACTIVE",
788
+ /** Automation will not be triggered */
789
+ INACTIVE = "INACTIVE"
790
+ }
791
+ interface Trigger {
792
+ /** ID of the app that defines the trigger. */
793
+ appId?: string;
794
+ /** Trigger key. */
795
+ triggerKey?: string;
796
+ /**
797
+ * List of filters on schema fields.
798
+ * In order for the automation to run, all filter expressions must evaluate to `true` for a given payload.
799
+ */
800
+ filters?: Filter[];
801
+ /** Defines the time offset between the trigger date and when the automation runs. */
802
+ scheduledEventOffset?: FutureDateActivationOffset;
803
+ /** Limits the number of times an automation can be triggered. */
804
+ rateLimit?: RateLimit;
805
+ automationConfigMapping?: Record<string, any> | null;
806
+ }
807
+ interface Action extends ActionInfoOneOf {
808
+ /** Action defined by an app (via RPC, HTTP or Velo). */
809
+ appDefinedInfo?: AppDefinedAction;
810
+ /** Condition action. */
811
+ conditionInfo?: ConditionAction;
812
+ /** Delay action. */
813
+ delayInfo?: DelayAction;
814
+ /** Rate-limiting action. */
815
+ rateLimitInfo?: RateLimitAction;
816
+ /** Action ID. If not specified, a new ID is generated. */
817
+ _id?: string | null;
818
+ /** Action type. */
819
+ type?: Type;
820
+ /**
821
+ * Human-readable name to differentiate the action from other actions of the same type.
822
+ * The name can contain only alphanumeric characters and underscores. If not provided, a namespace in the form `actionkey-indexOfAction` is
823
+ * generated automatically.
824
+ * If the action has output, the output will be available in the payload under this name.
825
+ * If the user has multiple actions with the same appId and actionKey, previous action output will be overwritten.
826
+ */
827
+ namespace?: string | null;
828
+ }
829
+ /** @oneof */
830
+ interface ActionInfoOneOf {
831
+ /** Action defined by an app (via RPC, HTTP or Velo). */
832
+ appDefinedInfo?: AppDefinedAction;
833
+ /** Condition action. */
834
+ conditionInfo?: ConditionAction;
835
+ /** Delay action. */
836
+ delayInfo?: DelayAction;
837
+ /** Rate-limiting action. */
838
+ rateLimitInfo?: RateLimitAction;
839
+ }
840
+ declare enum Origin {
841
+ /** default value. this is unused */
842
+ UNKNOWN_ORIGIN = "UNKNOWN_ORIGIN",
843
+ /** user created automation */
844
+ USER = "USER",
845
+ /** automation created by application (site specific) */
846
+ APPLICATION = "APPLICATION",
847
+ /** preinstalled application automation */
848
+ PREINSTALLED = "PREINSTALLED"
849
+ }
850
+ interface ApplicationOrigin {
851
+ /** Application ID. */
852
+ appId?: string;
853
+ }
854
+ interface PreinstalledOrigin {
855
+ /** ID of the app that defines the preinstalled automation. */
856
+ appId?: string;
857
+ /** Application component ID. */
858
+ componentId?: string;
859
+ /** Application component version. */
860
+ componentVersion?: number;
861
+ /**
862
+ * Whether the automation is an override automation. If the user modifies the preinstalled automation installed on their site, a site-specific
863
+ * automation is created that overrides the original one. If the user makes no modifications this boolean is set to `false` and the original
864
+ * preinstalled automation is used.
865
+ *
866
+ * Default: `false`
867
+ * @readonly
868
+ */
869
+ override?: boolean | null;
870
+ }
871
+ interface AutomationSettings {
872
+ /**
873
+ * Whether the automation is hidden from users.
874
+ * Default: `false`
875
+ */
876
+ hidden?: boolean;
877
+ /**
878
+ * Whether the automation is read-only.
879
+ * Default: `false`
880
+ */
881
+ readonly?: boolean;
882
+ /**
883
+ * Whether the option to delete the automation from the site is disabled.
884
+ * Default: `false`
885
+ */
886
+ disableDelete?: boolean;
887
+ /**
888
+ * Whether the option to change the automation status (from active to inactive and vice versa) is disabled.
889
+ * Default: `false`
890
+ */
891
+ disableStatusChange?: boolean;
892
+ /** Automation action settings. */
893
+ actionSettings?: ActionSettings;
894
+ }
895
+ interface DraftInfo {
896
+ /**
897
+ * optional - automationId of the original automation
898
+ * @readonly
899
+ */
900
+ originalAutomationId?: string | null;
901
+ }
902
+ interface DeletedWithEntity {
903
+ /** Deleted automation */
904
+ automation?: Automation;
905
+ }
511
906
  interface DomainEvent$1 extends DomainEventBodyOneOf$1 {
512
907
  createdEvent?: EntityCreatedEvent$1;
513
908
  updatedEvent?: EntityUpdatedEvent$1;
@@ -580,6 +975,46 @@ interface ActionEvent$1 {
580
975
  }
581
976
  interface Empty {
582
977
  }
978
+ interface MessageEnvelope$1 {
979
+ /** App instance ID. */
980
+ instanceId?: string | null;
981
+ /** Event type. */
982
+ eventType?: string;
983
+ /** The identification type and identity data. */
984
+ identity?: IdentificationData$1;
985
+ /** Stringify payload. */
986
+ data?: string;
987
+ }
988
+ interface IdentificationData$1 extends IdentificationDataIdOneOf$1 {
989
+ /** ID of a site visitor that has not logged in to the site. */
990
+ anonymousVisitorId?: string;
991
+ /** ID of a site visitor that has logged in to the site. */
992
+ memberId?: string;
993
+ /** ID of a Wix user (site owner, contributor, etc.). */
994
+ wixUserId?: string;
995
+ /** ID of an app. */
996
+ appId?: string;
997
+ /** @readonly */
998
+ identityType?: WebhookIdentityType$1;
999
+ }
1000
+ /** @oneof */
1001
+ interface IdentificationDataIdOneOf$1 {
1002
+ /** ID of a site visitor that has not logged in to the site. */
1003
+ anonymousVisitorId?: string;
1004
+ /** ID of a site visitor that has logged in to the site. */
1005
+ memberId?: string;
1006
+ /** ID of a Wix user (site owner, contributor, etc.). */
1007
+ wixUserId?: string;
1008
+ /** ID of an app. */
1009
+ appId?: string;
1010
+ }
1011
+ declare enum WebhookIdentityType$1 {
1012
+ UNKNOWN = "UNKNOWN",
1013
+ ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
1014
+ MEMBER = "MEMBER",
1015
+ WIX_USER = "WIX_USER",
1016
+ APP = "APP"
1017
+ }
583
1018
  interface MemberGetOrderRequest {
584
1019
  /** Order ID. */
585
1020
  _id: string;
@@ -740,46 +1175,6 @@ interface OrderCanceled {
740
1175
  /** Canceled order. */
741
1176
  order?: Order;
742
1177
  }
743
- interface MessageEnvelope$1 {
744
- /** App instance ID. */
745
- instanceId?: string | null;
746
- /** Event type. */
747
- eventType?: string;
748
- /** The identification type and identity data. */
749
- identity?: IdentificationData$1;
750
- /** Stringify payload. */
751
- data?: string;
752
- }
753
- interface IdentificationData$1 extends IdentificationDataIdOneOf$1 {
754
- /** ID of a site visitor that has not logged in to the site. */
755
- anonymousVisitorId?: string;
756
- /** ID of a site visitor that has logged in to the site. */
757
- memberId?: string;
758
- /** ID of a Wix user (site owner, contributor, etc.). */
759
- wixUserId?: string;
760
- /** ID of an app. */
761
- appId?: string;
762
- /** @readonly */
763
- identityType?: WebhookIdentityType$1;
764
- }
765
- /** @oneof */
766
- interface IdentificationDataIdOneOf$1 {
767
- /** ID of a site visitor that has not logged in to the site. */
768
- anonymousVisitorId?: string;
769
- /** ID of a site visitor that has logged in to the site. */
770
- memberId?: string;
771
- /** ID of a Wix user (site owner, contributor, etc.). */
772
- wixUserId?: string;
773
- /** ID of an app. */
774
- appId?: string;
775
- }
776
- declare enum WebhookIdentityType$1 {
777
- UNKNOWN = "UNKNOWN",
778
- ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
779
- MEMBER = "MEMBER",
780
- WIX_USER = "WIX_USER",
781
- APP = "APP"
782
- }
783
1178
  interface CreateOnlineOrderRequest {
784
1179
  /** Plan ID. */
785
1180
  planId?: string;
@@ -1405,10 +1800,6 @@ interface EventMetadata$1 extends BaseEventMetadata$1 {
1405
1800
  */
1406
1801
  entityEventSequence?: string | null;
1407
1802
  }
1408
- interface OrderCanceledEnvelope {
1409
- data: OrderCanceled;
1410
- metadata: EventMetadata$1;
1411
- }
1412
1803
  interface OrderCreatedEnvelope {
1413
1804
  entity: Order;
1414
1805
  metadata: EventMetadata$1;
@@ -1417,6 +1808,10 @@ interface OrderUpdatedEnvelope {
1417
1808
  entity: Order;
1418
1809
  metadata: EventMetadata$1;
1419
1810
  }
1811
+ interface OrderCanceledEnvelope {
1812
+ data: OrderCanceled;
1813
+ metadata: EventMetadata$1;
1814
+ }
1420
1815
  interface OrderStartDateChangedEnvelope {
1421
1816
  data: OrderStartDateChanged;
1422
1817
  metadata: EventMetadata$1;
@@ -1608,66 +2003,258 @@ interface ManagementListOrdersOptions {
1608
2003
  fieldSet?: Set;
1609
2004
  }
1610
2005
 
1611
- type RESTFunctionDescriptor<T extends (...args: any[]) => any = (...args: any[]) => any> = (httpClient: HttpClient) => T;
1612
- interface HttpClient {
1613
- request<TResponse, TData = any>(req: RequestOptionsFactory<TResponse, TData>): Promise<HttpResponse<TResponse>>;
1614
- fetchWithAuth: typeof fetch;
1615
- wixAPIFetch: (relativeUrl: string, options: RequestInit) => Promise<Response>;
2006
+ declare function memberGetOrder$1(httpClient: HttpClient): MemberGetOrderSignature;
2007
+ interface MemberGetOrderSignature {
2008
+ /**
2009
+ * Gets an order by ID for the currently logged-in member.
2010
+ *
2011
+ * The `memberGetOrder()` function returns a Promise that resolves to information about a specified order for the currently logged-in member.
2012
+ * @param - Order ID.
2013
+ * @param - Options for getting a logged-in member's order.
2014
+ * @returns Requested order.
2015
+ */
2016
+ (_id: string, options?: MemberGetOrderOptions | undefined): Promise<Order & OrderNonNullableFields>;
1616
2017
  }
1617
- type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
1618
- type HttpResponse<T = any> = {
1619
- data: T;
1620
- status: number;
1621
- statusText: string;
1622
- headers: any;
1623
- request?: any;
1624
- };
1625
- type RequestOptions<_TResponse = any, Data = any> = {
1626
- method: 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
1627
- url: string;
1628
- data?: Data;
1629
- params?: URLSearchParams;
1630
- } & APIMetadata;
1631
- type APIMetadata = {
1632
- methodFqn?: string;
1633
- entityFqdn?: string;
1634
- packageName?: string;
1635
- };
1636
- type BuildRESTFunction<T extends RESTFunctionDescriptor> = T extends RESTFunctionDescriptor<infer U> ? U : never;
1637
- type EventDefinition<Payload = unknown, Type extends string = string> = {
1638
- __type: 'event-definition';
1639
- type: Type;
1640
- isDomainEvent?: boolean;
1641
- transformations?: (envelope: unknown) => Payload;
1642
- __payload: Payload;
1643
- };
1644
- declare function EventDefinition<Type extends string>(type: Type, isDomainEvent?: boolean, transformations?: (envelope: any) => unknown): <Payload = unknown>() => EventDefinition<Payload, Type>;
1645
- type EventHandler<T extends EventDefinition> = (payload: T['__payload']) => void | Promise<void>;
1646
- type BuildEventDefinition<T extends EventDefinition<any, string>> = (handler: EventHandler<T>) => void;
1647
-
1648
- declare global {
1649
- // eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
1650
- interface SymbolConstructor {
1651
- readonly observable: symbol;
1652
- }
2018
+ declare function memberListOrders$1(httpClient: HttpClient): MemberListOrdersSignature;
2019
+ interface MemberListOrdersSignature {
2020
+ /**
2021
+ * Lists orders for the currently logged-in member.
2022
+ *
2023
+ * The `memberListOrders()` function returns a Promise that resolves to a list of up to 100 pricing plan orders.
2024
+ * @param - Filtering, sorting, and pagination options.
2025
+ */
2026
+ (options?: MemberListOrdersOptions | undefined): Promise<MemberListOrdersResponse & MemberListOrdersResponseNonNullableFields>;
2027
+ }
2028
+ declare function requestCancellation$1(httpClient: HttpClient): RequestCancellationSignature;
2029
+ interface RequestCancellationSignature {
2030
+ /**
2031
+ * Starts the process of canceling an order.
2032
+ *
2033
+ *
2034
+ * The `requestCancellation()` function returns a Promise that resolves when the order cancellation is successfully requested.
2035
+ *
2036
+ * For orders with recurring payments, a cancellation can be set to occur either immediately or at the next payment date. For orders with one-time payments, a cancellation occurs immediately after the request is processed.
2037
+ *
2038
+ * Requesting an order cancellation starts the cancellation process. There may be some operations that continue to be processed before the status of the order is changed to `"CANCELED"`. For example, payments might need to be refunded before the order is fully canceled.
2039
+ *
2040
+ * #### Canceling during the free trial period.
2041
+ *
2042
+ * When a buyer cancels their order during the free trial period, the buyer's subscription expires at the end of the free trial period and they won't be billed. The buyer may continue using the benefits until the end of the free trial period.
2043
+ *
2044
+ * @param - Order ID.
2045
+ * @param - Whether to cancel the order immediately or at the next payment date.
2046
+ * One-time payment orders can only be canceled immediately.
2047
+ *
2048
+ * Supported values:
2049
+ * - `"IMMEDIATELY"`: Indicates that the order should be canceled immediately.
2050
+ * - `"NEXT_PAYMENT_DATE"`: Indicates that the order be canceled at the next payment date.
2051
+ * @param - Options for requesting a cancellation.
2052
+ * @returns Fulfilled - When the cancellation process is started.
2053
+ */
2054
+ (_id: string, effectiveAt: CancellationEffectiveAt): Promise<void>;
2055
+ }
2056
+ declare function createOfflineOrder$1(httpClient: HttpClient): CreateOfflineOrderSignature;
2057
+ interface CreateOfflineOrderSignature {
2058
+ /**
2059
+ * Creates an order for a buyer who purchased the plan with an offline transaction.
2060
+ *
2061
+ * The `createOfflineOrder()` function returns a Promise that resolves to an `order` object when the order has been created.
2062
+ *
2063
+ * Payment of an offline order is handled in 1 of 2 ways.
2064
+ * - When creating the order, select `true` in the `paid` request parameter.
2065
+ * - After creation, with the [`markAsPaid()`](#markaspaid) function.
2066
+ *
2067
+ * When creating a non-free offline order:
2068
+ * - The order's status is set to `"PENDING"` if the start date is in the future. Otherwise, the status is set to `"ACTIVE"`.
2069
+ * The order's last payment status is set to `"UNPAID"` or `"PAID"`.
2070
+ *
2071
+ * When creating a free offline order:
2072
+ * - The order's status is set to `"PENDING"` if the start date is in the future. Otherwise, the status is set to `"ACTIVE"`.
2073
+ * - The order's last payment status is set to `"NOT_APPLICABLE"`.
2074
+ * @param - ID of the member ordering the plan.
2075
+ * @param - Options for creating an offline order.
2076
+ * @param - ID of the plan being ordered. See [Plans for more information about plan IDs](plans)
2077
+ * @returns Fulfilled - The order of the plan.
2078
+ */
2079
+ (planId: string, memberId: string, options?: CreateOfflineOrderOptions | undefined): Promise<CreateOfflineOrderResponse & CreateOfflineOrderResponseNonNullableFields>;
2080
+ }
2081
+ declare function getOfflineOrderPreview$1(httpClient: HttpClient): GetOfflineOrderPreviewSignature;
2082
+ interface GetOfflineOrderPreviewSignature {
2083
+ /**
2084
+ * Provides a preview of an offline order as if it was purchased.
2085
+ *
2086
+ * The `getOfflineOrderPreview()` function returns a Promise that resolves to a temporary preview of the offline order.
2087
+ *
2088
+ * The preview uses the same logic as purchasing a plan, but the preview is not saved. Because an order is not actually created, the preview's `_id` and `subscriptionId` properties are displayed as a string of multiple zero characters (`000000-0000`).
2089
+ *
2090
+ * If [taxes are configured](https://support.wix.com/en/article/pricing-plans-setting-up-tax-collection) for the site, taxes are applied to the preview. If not, `tax` previews as `null`.
2091
+ *
2092
+ * You can preview the order to check purchase limitations, but the limitations are not enforced for the preview. If a pricing plan has a limit on the amount of purchases per buyer, that limit is not considered for generating the preview. But, if that limit has been reached and this order would then exceed the amount of purchases permitted for this buyer, then `purchaseLimitExceeded` will return as `true`. Thus function is not available to the buyer. You specify the member ID for the buyer whose order should be previewed. To get a general price preview for a plan that's not buyer-specific, use the [`getPricePreview()`](#getpricepreview) function.
2093
+ * @param - Member ID of the buyer the previewed order is for.
2094
+ * @param - Options for previewing the offline order.
2095
+ * @param - ID of the plan of the previewed order.
2096
+ * @returns Fulfilled - A preview of the order.
2097
+ */
2098
+ (planId: string, memberId: string, options?: GetOfflineOrderPreviewOptions | undefined): Promise<GetOfflineOrderPreviewResponse & GetOfflineOrderPreviewResponseNonNullableFields>;
2099
+ }
2100
+ declare function getPricePreview$1(httpClient: HttpClient): GetPricePreviewSignature;
2101
+ interface GetPricePreviewSignature {
2102
+ /**
2103
+ * Retrieves a preview of an order's pricing as if it was purchased.
2104
+ *
2105
+ * The `getPricePreview()` function returns a Promise that resolves to a temporary preview of the order's price.
2106
+ *
2107
+ * The price preview uses the same logic for calculating prices as used when purchasing a plan, but the preview is not saved. If [taxes are configured](https://support.wix.com/en/article/pricing-plans-setting-up-tax-collection) for the site, taxes are applied to the preview. If not, the `tax` previews as `null`.
2108
+ *
2109
+ * Buyers do not have to be logged in to preview the price, as such, the details returned by this function are not buyer-specific. To generate a preview of a purchase for a specific-buyer, use the [`getOfflineOrderPreview()`](#getofflineorderpreview).
2110
+ * @param - ID of plan to preview.
2111
+ * @param - Options for getting a price preview.
2112
+ * @returns Fulfilled - A preview of the pricing for the order.
2113
+ */
2114
+ (planId: string, options?: GetPricePreviewOptions | undefined): Promise<GetPricePreviewResponse & GetPricePreviewResponseNonNullableFields>;
2115
+ }
2116
+ declare function managementGetOrder$1(httpClient: HttpClient): ManagementGetOrderSignature;
2117
+ interface ManagementGetOrderSignature {
2118
+ /**
2119
+ * Retrieves an order by ID.
2120
+ *
2121
+ * The `managementGetOrder()` function returns a Promise that resolves to information about the specified order.
2122
+ * @param - Order ID.
2123
+ * @param - Options to use when getting an order.
2124
+ */
2125
+ (_id: string, options?: ManagementGetOrderOptions | undefined): Promise<GetOrderResponse & GetOrderResponseNonNullableFields>;
2126
+ }
2127
+ declare function managementListOrders$1(httpClient: HttpClient): ManagementListOrdersSignature;
2128
+ interface ManagementListOrdersSignature {
2129
+ /**
2130
+ * Lists pricing plan orders.
2131
+ *
2132
+ * The `managementListOrders()` function returns a Promise that resolves to a list of up to 50 pricing plan orders. You can specify options for filtering, sorting, and paginating the results.
2133
+ *
2134
+ * This function returns the orders on the site. To list orders for the currently logged-in member, use [`memberListOrders()`](#memberlistorders).
2135
+ * @param - Filtering, sorting, and pagination options.
2136
+ */
2137
+ (options?: ManagementListOrdersOptions | undefined): Promise<ListOrdersResponse & ListOrdersResponseNonNullableFields>;
2138
+ }
2139
+ declare function postponeEndDate$1(httpClient: HttpClient): PostponeEndDateSignature;
2140
+ interface PostponeEndDateSignature {
2141
+ /**
2142
+ * Extends the duration of a pricing plan order by postponing the order's `endDate`.
2143
+ *
2144
+ * The `postponeEndDate()` function returns a Promise that resolves when the order's end date is successfully changed.
2145
+ *
2146
+ * The new end date and time must be later than the order's current `endDate`.
2147
+ *
2148
+ * Postponing the end date of an order does not impact payments. For example, if the pricing plan is for a membership to an online lecture series, and you want to extend the duration of the series because the lecturer could not attend some sessions, you can postpone the end date of the orders for all relevant participants. The participants will not be billed additionally.
2149
+ *
2150
+ * Postponing an order causes the following changes:
2151
+ * - The `endDate` for the order is adjusted to the new end date.
2152
+ * @param - Order ID.
2153
+ * @param - New end date and time.
2154
+ *
2155
+ * Must be later than the current end date and time.
2156
+ * @param - Options for postponing the end date of an order.
2157
+ * @returns Fulfilled - When the order's end date has been postponed or made earlier.
2158
+ */
2159
+ (_id: string, endDate: Date): Promise<void>;
2160
+ }
2161
+ declare function cancelOrder$1(httpClient: HttpClient): CancelOrderSignature;
2162
+ interface CancelOrderSignature {
2163
+ /**
2164
+ * Cancels an existing order.
2165
+ *
2166
+ * The `cancelOrder()` function returns a Promise that resolves when the order is successfully canceled.
2167
+ *
2168
+ * For orders with recurring payments, a cancellation can be set to occur either `IMMEDIATELY` or at the `NEXT_PAYMENT_DATE`.
2169
+ * For orders with one-time payments, a cancellation occurs `IMMEDIATELY`.
2170
+ *
2171
+ * Canceling an order changes the order status to `CANCELED`.
2172
+ *
2173
+ * #### Canceling during the free trial period.
2174
+ *
2175
+ * When a site owner cancels an ordered plan during the free trial period, they choose to apply the cancellation `IMMEDIATELY` or at the `NEXT_PAYMENT_DATE`.
2176
+ *
2177
+ * Canceling `IMMEDIATELY` will end the subscription for the buyer
2178
+ * immediately, even during the free trial period and the buyer won't be billed.
2179
+ *
2180
+ * Canceling at the `NEXT_PAYMENT_DATE` allows the buyer to continue using the benefits of the subscription until the end of the free trial period. Then, the subscription ends and the buyer is not billed.
2181
+ * @param - Order ID.
2182
+ * @param - When the order is canceled.
2183
+ *
2184
+ * One time orders can only be canceled immediately. Supported values:
2185
+ * - `"IMMEDIATELY"`: The order is canceled immediately.
2186
+ * - `"NEXT_PAYMENT_DATE"`: The order is canceled at the next payment date.
2187
+ * @param - Options for canceling orders.
2188
+ * @returns Fulfilled - When the order is canceled.
2189
+ */
2190
+ (_id: string, effectiveAt: CancellationEffectiveAt): Promise<void>;
2191
+ }
2192
+ declare function markAsPaid$1(httpClient: HttpClient): MarkAsPaidSignature;
2193
+ interface MarkAsPaidSignature {
2194
+ /**
2195
+ * Marks an offline order as paid.
2196
+ *
2197
+ * The `markAsPaid()` function returns a Promise that resolves when the offline order is successfully marked as paid.
2198
+ *
2199
+ * The entire order is marked as paid, even if the order's payments are recurring.
2200
+ *
2201
+ * >**Note:** Marking separate payment cycles as paid is not yet supported. Subsequent offline payments do trigger events and emails, but are not registered as additional offline payments.
2202
+ *
2203
+ * Marking an offline order as paid causes the following changes:
2204
+ * - The order's `lastPaymentStatus` changes to `"PAID"`.
2205
+ * - The order's status changes to either `"PENDING"` or `"ACTIVE"`, depending on the order's `startDate`.
2206
+ *
2207
+ * An error occurs if you attempt to:
2208
+ * - Mark an already-paid, offline order as paid. You cannot make an offline order as paid twice.
2209
+ * - Mark an online order as paid. The `markAsPaid()` function is supported for offline orders only.
2210
+ * @param - Order ID.
2211
+ * @returns Fulfilled - When the order is marked as paid.
2212
+ */
2213
+ (_id: string): Promise<void>;
2214
+ }
2215
+ declare function pauseOrder$1(httpClient: HttpClient): PauseOrderSignature;
2216
+ interface PauseOrderSignature {
2217
+ /**
2218
+ * Pauses a pricing plan order.
2219
+ *
2220
+ * The `pauseOrder()` function returns a Promise that resolves when the order is successfully paused.
2221
+ *
2222
+ * For orders with recurring payments, `pauseOrder()` also pauses the payment schedule. Buyers are not charged when an order is paused. Use `pauseOrder()`, for example, if the buyer is away and would like to put their pricing plan membership on hold until they return. Pausing an order affects the end date of the order by adding the time the order is paused to the `endDate`. You can only pause orders with an `"ACTIVE`" status.
2223
+ *
2224
+ * Pausing an order causes the following changes:
2225
+ * - The order status changes to `"PAUSED"`.
2226
+ * - The `pausePeriods` array is updated.
2227
+ *
2228
+ * The `endDate` and the `earliestEndDate` for the order are adjusted to include the pause period when the order is resumed.
2229
+ *
2230
+ * Paused orders can be continued with the [`resumeOrder()`](#resumeorder) function.
2231
+ * @param - Order ID.
2232
+ * @returns Fulfilled - When the order is paused.
2233
+ */
2234
+ (_id: string): Promise<void>;
2235
+ }
2236
+ declare function resumeOrder$1(httpClient: HttpClient): ResumeOrderSignature;
2237
+ interface ResumeOrderSignature {
2238
+ /**
2239
+ * Resumes a paused pricing plan order.
2240
+ *
2241
+ * The `resumeOrder()` function returns a Promise that resolves when a paused order is successfully resumed.
2242
+ *
2243
+ * For orders with recurring payments, `resumeOrder()` also restarts the payment schedule.
2244
+ *
2245
+ * Resuming an order causes the following changes:
2246
+ * - The order status changes to `"ACTIVE"`.
2247
+ * - The `pausePeriods` array is updated.
2248
+ * - The `endDate` for the order is adjusted to include the pause period.
2249
+ * - The `earliestEndDate` is adjusted to include the pause period. (This property is reserved for future use).
2250
+ * @param - Order ID.
2251
+ * @returns Fulfilled - When the order is resumed.
2252
+ */
2253
+ (_id: string): Promise<void>;
1653
2254
  }
1654
-
1655
- declare function memberGetOrder$1(httpClient: HttpClient): (_id: string, options?: MemberGetOrderOptions) => Promise<Order & OrderNonNullableFields>;
1656
- declare function memberListOrders$1(httpClient: HttpClient): (options?: MemberListOrdersOptions) => Promise<MemberListOrdersResponse & MemberListOrdersResponseNonNullableFields>;
1657
- declare function requestCancellation$1(httpClient: HttpClient): (_id: string, effectiveAt: CancellationEffectiveAt) => Promise<void>;
1658
- declare function createOfflineOrder$1(httpClient: HttpClient): (planId: string, memberId: string, options?: CreateOfflineOrderOptions) => Promise<CreateOfflineOrderResponse & CreateOfflineOrderResponseNonNullableFields>;
1659
- declare function getOfflineOrderPreview$1(httpClient: HttpClient): (planId: string, memberId: string, options?: GetOfflineOrderPreviewOptions) => Promise<GetOfflineOrderPreviewResponse & GetOfflineOrderPreviewResponseNonNullableFields>;
1660
- declare function getPricePreview$1(httpClient: HttpClient): (planId: string, options?: GetPricePreviewOptions) => Promise<GetPricePreviewResponse & GetPricePreviewResponseNonNullableFields>;
1661
- declare function managementGetOrder$1(httpClient: HttpClient): (_id: string, options?: ManagementGetOrderOptions) => Promise<GetOrderResponse & GetOrderResponseNonNullableFields>;
1662
- declare function managementListOrders$1(httpClient: HttpClient): (options?: ManagementListOrdersOptions) => Promise<ListOrdersResponse & ListOrdersResponseNonNullableFields>;
1663
- declare function postponeEndDate$1(httpClient: HttpClient): (_id: string, endDate: Date) => Promise<void>;
1664
- declare function cancelOrder$1(httpClient: HttpClient): (_id: string, effectiveAt: CancellationEffectiveAt) => Promise<void>;
1665
- declare function markAsPaid$1(httpClient: HttpClient): (_id: string) => Promise<void>;
1666
- declare function pauseOrder$1(httpClient: HttpClient): (_id: string) => Promise<void>;
1667
- declare function resumeOrder$1(httpClient: HttpClient): (_id: string) => Promise<void>;
1668
- declare const onOrderCanceled$1: EventDefinition<OrderCanceledEnvelope, "wix.pricing_plans.v2.order_canceled">;
1669
2255
  declare const onOrderCreated$1: EventDefinition<OrderCreatedEnvelope, "wix.pricing_plans.v2.order_created">;
1670
2256
  declare const onOrderUpdated$1: EventDefinition<OrderUpdatedEnvelope, "wix.pricing_plans.v2.order_updated">;
2257
+ declare const onOrderCanceled$1: EventDefinition<OrderCanceledEnvelope, "wix.pricing_plans.v2.order_canceled">;
1671
2258
  declare const onOrderStartDateChanged$1: EventDefinition<OrderStartDateChangedEnvelope, "wix.pricing_plans.v2.order_start_date_changed">;
1672
2259
  declare const onOrderPurchased$1: EventDefinition<OrderPurchasedEnvelope, "wix.pricing_plans.v2.order_purchased">;
1673
2260
  declare const onOrderStarted$1: EventDefinition<OrderStartedEnvelope, "wix.pricing_plans.v2.order_started">;
@@ -1679,78 +2266,146 @@ declare const onOrderMarkedAsPaid$1: EventDefinition<OrderMarkedAsPaidEnvelope,
1679
2266
  declare const onOrderPaused$1: EventDefinition<OrderPausedEnvelope, "wix.pricing_plans.v2.order_paused">;
1680
2267
  declare const onOrderResumed$1: EventDefinition<OrderResumedEnvelope, "wix.pricing_plans.v2.order_resumed">;
1681
2268
 
1682
- declare function createRESTModule$1<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
1683
-
1684
2269
  declare function createEventModule$1<T extends EventDefinition<any, string>>(eventDefinition: T): BuildEventDefinition<T> & T;
1685
2270
 
1686
- type _publicMemberGetOrderType = typeof memberGetOrder$1;
1687
- declare const memberGetOrder: ReturnType<typeof createRESTModule$1<_publicMemberGetOrderType>>;
1688
- type _publicMemberListOrdersType = typeof memberListOrders$1;
1689
- declare const memberListOrders: ReturnType<typeof createRESTModule$1<_publicMemberListOrdersType>>;
1690
- type _publicRequestCancellationType = typeof requestCancellation$1;
1691
- declare const requestCancellation: ReturnType<typeof createRESTModule$1<_publicRequestCancellationType>>;
1692
- type _publicCreateOfflineOrderType = typeof createOfflineOrder$1;
1693
- declare const createOfflineOrder: ReturnType<typeof createRESTModule$1<_publicCreateOfflineOrderType>>;
1694
- type _publicGetOfflineOrderPreviewType = typeof getOfflineOrderPreview$1;
1695
- declare const getOfflineOrderPreview: ReturnType<typeof createRESTModule$1<_publicGetOfflineOrderPreviewType>>;
1696
- type _publicGetPricePreviewType = typeof getPricePreview$1;
1697
- declare const getPricePreview: ReturnType<typeof createRESTModule$1<_publicGetPricePreviewType>>;
1698
- type _publicManagementGetOrderType = typeof managementGetOrder$1;
1699
- declare const managementGetOrder: ReturnType<typeof createRESTModule$1<_publicManagementGetOrderType>>;
1700
- type _publicManagementListOrdersType = typeof managementListOrders$1;
1701
- declare const managementListOrders: ReturnType<typeof createRESTModule$1<_publicManagementListOrdersType>>;
1702
- type _publicPostponeEndDateType = typeof postponeEndDate$1;
1703
- declare const postponeEndDate: ReturnType<typeof createRESTModule$1<_publicPostponeEndDateType>>;
1704
- type _publicCancelOrderType = typeof cancelOrder$1;
1705
- declare const cancelOrder: ReturnType<typeof createRESTModule$1<_publicCancelOrderType>>;
1706
- type _publicMarkAsPaidType = typeof markAsPaid$1;
1707
- declare const markAsPaid: ReturnType<typeof createRESTModule$1<_publicMarkAsPaidType>>;
1708
- type _publicPauseOrderType = typeof pauseOrder$1;
1709
- declare const pauseOrder: ReturnType<typeof createRESTModule$1<_publicPauseOrderType>>;
1710
- type _publicResumeOrderType = typeof resumeOrder$1;
1711
- declare const resumeOrder: ReturnType<typeof createRESTModule$1<_publicResumeOrderType>>;
1712
-
1713
- type _publicOnOrderCanceledType = typeof onOrderCanceled$1;
1714
- declare const onOrderCanceled: ReturnType<typeof createEventModule$1<_publicOnOrderCanceledType>>;
2271
+ declare const memberGetOrder: BuildRESTFunction<typeof memberGetOrder$1> & typeof memberGetOrder$1;
2272
+ declare const memberListOrders: BuildRESTFunction<typeof memberListOrders$1> & typeof memberListOrders$1;
2273
+ declare const requestCancellation: BuildRESTFunction<typeof requestCancellation$1> & typeof requestCancellation$1;
2274
+ declare const createOfflineOrder: BuildRESTFunction<typeof createOfflineOrder$1> & typeof createOfflineOrder$1;
2275
+ declare const getOfflineOrderPreview: BuildRESTFunction<typeof getOfflineOrderPreview$1> & typeof getOfflineOrderPreview$1;
2276
+ declare const getPricePreview: BuildRESTFunction<typeof getPricePreview$1> & typeof getPricePreview$1;
2277
+ declare const managementGetOrder: BuildRESTFunction<typeof managementGetOrder$1> & typeof managementGetOrder$1;
2278
+ declare const managementListOrders: BuildRESTFunction<typeof managementListOrders$1> & typeof managementListOrders$1;
2279
+ declare const postponeEndDate: BuildRESTFunction<typeof postponeEndDate$1> & typeof postponeEndDate$1;
2280
+ declare const cancelOrder: BuildRESTFunction<typeof cancelOrder$1> & typeof cancelOrder$1;
2281
+ declare const markAsPaid: BuildRESTFunction<typeof markAsPaid$1> & typeof markAsPaid$1;
2282
+ declare const pauseOrder: BuildRESTFunction<typeof pauseOrder$1> & typeof pauseOrder$1;
2283
+ declare const resumeOrder: BuildRESTFunction<typeof resumeOrder$1> & typeof resumeOrder$1;
1715
2284
 
1716
2285
  type _publicOnOrderCreatedType = typeof onOrderCreated$1;
2286
+ /**
2287
+ * Triggered when an order is created.
2288
+ */
1717
2289
  declare const onOrderCreated: ReturnType<typeof createEventModule$1<_publicOnOrderCreatedType>>;
1718
2290
 
1719
2291
  type _publicOnOrderUpdatedType = typeof onOrderUpdated$1;
2292
+ /**
2293
+ * Triggered when an order is updated.
2294
+ *
2295
+ * Order Updated Webhook is triggered when any of the following happens:
2296
+ * + Order is paid for. [Order Purchased Webhook](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/orders/order-purchased-webhook) is also triggered.
2297
+ * + Order reaches its start date or end date. [Order Started Webhook](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/orders/order-started-webhook) and [Order Ended Webhook](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/orders/order-ended-webhook), respectively, are also triggered.
2298
+ * + New payment cycle of an order starts. [Order Cycle Started Webhook](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/orders/order-cycle-started-webhook) is also triggered.
2299
+ * + Offline order is marked as paid. [Order Marked As Paid Webhook](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/orders/order-marked-as-paid-webhook) is also triggered.
2300
+ * + End date of the order is postponed. [Order End Date Postponed Webhook](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/orders/order-end-date-postponed-webhook) is also triggered
2301
+ * + Order is paused, or a paused order is resumed. [Order Paused Webhook](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/orders/order-paused-webhook)
2302
+ * and [Order Resumed Webhook](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/orders/order-resumed-webhook), respectively, are also triggered.
2303
+ * + Order is canceled, either immediately or at the end of the payment cycle. [Order Canceled Webhook](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/orders/order-canceled-webhook)
2304
+ * and [Order Auto Renew Canceled Webhook](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/orders/order-auto-renew-canceled-webhook) are also triggered.
2305
+ */
1720
2306
  declare const onOrderUpdated: ReturnType<typeof createEventModule$1<_publicOnOrderUpdatedType>>;
1721
2307
 
2308
+ type _publicOnOrderCanceledType = typeof onOrderCanceled$1;
2309
+ /**
2310
+ * Triggered when an order is canceled.
2311
+ *
2312
+ * This webhook is triggered either immediately or at the end of the current payment cycle, as follows:
2313
+ * + If the order is canceled and `effectiveAt` is set to `IMMEDIATELY`, the webhook is triggered immediately when canceled.
2314
+ * + If the order is canceled and `effectiveAt` is set to `NEXT_PAYMENT_DATE`, the webhook is triggered at the end of the current payment cycle. In this case, the [Order Auto Renew Canceled Webhook](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/orders/order-auto-renew-canceled-webhook) is triggered immediately.
2315
+ */
2316
+ declare const onOrderCanceled: ReturnType<typeof createEventModule$1<_publicOnOrderCanceledType>>;
2317
+
1722
2318
  type _publicOnOrderStartDateChangedType = typeof onOrderStartDateChanged$1;
2319
+ /**
2320
+ * Triggered when an order's `startDate` is changed.
2321
+ */
1723
2322
  declare const onOrderStartDateChanged: ReturnType<typeof createEventModule$1<_publicOnOrderStartDateChangedType>>;
1724
2323
 
1725
2324
  type _publicOnOrderPurchasedType = typeof onOrderPurchased$1;
2325
+ /**
2326
+ * Triggered when an order is purchased.
2327
+ *
2328
+ * This webhook is triggered for any of the following events:
2329
+ * + Order is paid in full.
2330
+ * + At least 1 order cycle payment is paid for.
2331
+ * + Offline order is created, even if not yet marked as paid.
2332
+ * + Free order is created.
2333
+ */
1726
2334
  declare const onOrderPurchased: ReturnType<typeof createEventModule$1<_publicOnOrderPurchasedType>>;
1727
2335
 
1728
2336
  type _publicOnOrderStartedType = typeof onOrderStarted$1;
2337
+ /**
2338
+ * Triggered when an order reaches its `startDate`. Applies to both purchased and free orders.
2339
+ */
1729
2340
  declare const onOrderStarted: ReturnType<typeof createEventModule$1<_publicOnOrderStartedType>>;
1730
2341
 
1731
2342
  type _publicOnOrderCycleStartedType = typeof onOrderCycleStarted$1;
2343
+ /**
2344
+ * Triggered at the start of a new payment cycle for an existing order.
2345
+ *
2346
+ * This webhook is not triggered at the initial start of an offline order.
2347
+ */
1732
2348
  declare const onOrderCycleStarted: ReturnType<typeof createEventModule$1<_publicOnOrderCycleStartedType>>;
1733
2349
 
1734
2350
  type _publicOnOrderAutoRenewCanceledType = typeof onOrderAutoRenewCanceled$1;
2351
+ /**
2352
+ * Triggered when an order is canceled and `effectiveAt` is set to `NEXT_PAYMENT_DATE`.
2353
+ *
2354
+ * This webhook is *not* triggered in the following scenarios:
2355
+ * + When an order is canceled and `effectiveAt` is set to `IMMEDIATELY`. Instead, at the time of cancellation, [Order Canceled](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/orders/order-canceled-webhook) is triggered.
2356
+ * + When an order expires at the end of the current payment cycle because it was canceled and `effectiveAt` was set to `NEXT_PAYMENT_DATE`. Instead, at the time of expiration, [Order Canceled](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/orders/order-canceled-webhook) and [Order Ended](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/orders/order-ended-webhook) are triggered.
2357
+ */
1735
2358
  declare const onOrderAutoRenewCanceled: ReturnType<typeof createEventModule$1<_publicOnOrderAutoRenewCanceledType>>;
1736
2359
 
1737
2360
  type _publicOnOrderEndedType = typeof onOrderEnded$1;
2361
+ /**
2362
+ * Triggered when an order ends.
2363
+ *
2364
+ * This webhook is triggered:
2365
+ * + When an order expires at the end of the current payment cycle.
2366
+ * + When an order is canceled and `effectiveAt` is set to `IMMEDIATELY`..
2367
+ */
1738
2368
  declare const onOrderEnded: ReturnType<typeof createEventModule$1<_publicOnOrderEndedType>>;
1739
2369
 
1740
2370
  type _publicOnOrderEndDatePostponedType = typeof onOrderEndDatePostponed$1;
2371
+ /**
2372
+ * Triggered when an order's `endDate` is postponed.
2373
+ */
1741
2374
  declare const onOrderEndDatePostponed: ReturnType<typeof createEventModule$1<_publicOnOrderEndDatePostponedType>>;
1742
2375
 
1743
2376
  type _publicOnOrderMarkedAsPaidType = typeof onOrderMarkedAsPaid$1;
2377
+ /**
2378
+ * Triggered when an offline order is marked as paid.
2379
+ */
1744
2380
  declare const onOrderMarkedAsPaid: ReturnType<typeof createEventModule$1<_publicOnOrderMarkedAsPaidType>>;
1745
2381
 
1746
2382
  type _publicOnOrderPausedType = typeof onOrderPaused$1;
2383
+ /**
2384
+ * Triggered when an order is paused.
2385
+ */
1747
2386
  declare const onOrderPaused: ReturnType<typeof createEventModule$1<_publicOnOrderPausedType>>;
1748
2387
 
1749
2388
  type _publicOnOrderResumedType = typeof onOrderResumed$1;
2389
+ /**
2390
+ * Triggered when a paused order is resumed.
2391
+ */
1750
2392
  declare const onOrderResumed: ReturnType<typeof createEventModule$1<_publicOnOrderResumedType>>;
1751
2393
 
2394
+ type context$1_Action = Action;
2395
+ type context$1_ActionInfoOneOf = ActionInfoOneOf;
2396
+ type context$1_ActionSettings = ActionSettings;
2397
+ type context$1_AppDefinedAction = AppDefinedAction;
2398
+ type context$1_ApplicationOrigin = ApplicationOrigin;
1752
2399
  type context$1_ApplyCouponRequest = ApplyCouponRequest;
1753
2400
  type context$1_ApplyCouponResponse = ApplyCouponResponse;
2401
+ type context$1_AuditInfo = AuditInfo;
2402
+ type context$1_AuditInfoIdOneOf = AuditInfoIdOneOf;
2403
+ type context$1_Automation = Automation;
2404
+ type context$1_AutomationConfiguration = AutomationConfiguration;
2405
+ type context$1_AutomationConfigurationStatus = AutomationConfigurationStatus;
2406
+ declare const context$1_AutomationConfigurationStatus: typeof AutomationConfigurationStatus;
2407
+ type context$1_AutomationOriginInfoOneOf = AutomationOriginInfoOneOf;
2408
+ type context$1_AutomationSettings = AutomationSettings;
1754
2409
  type context$1_BulkOrderResult = BulkOrderResult;
1755
2410
  type context$1_BulkPauseOrderRequest = BulkPauseOrderRequest;
1756
2411
  type context$1_BulkPauseOrderResponse = BulkPauseOrderResponse;
@@ -1767,6 +2422,8 @@ declare const context$1_CancellationEffectiveAt: typeof CancellationEffectiveAt;
1767
2422
  type context$1_Captcha = Captcha;
1768
2423
  type context$1_ChangeStartDateRequest = ChangeStartDateRequest;
1769
2424
  type context$1_ChangeStartDateResponse = ChangeStartDateResponse;
2425
+ type context$1_ConditionAction = ConditionAction;
2426
+ type context$1_ConditionExpressionGroup = ConditionExpressionGroup;
1770
2427
  type context$1_Coupon = Coupon;
1771
2428
  type context$1_CouponsError = CouponsError;
1772
2429
  type context$1_CreateExternalOrderRequest = CreateExternalOrderRequest;
@@ -1781,8 +2438,13 @@ type context$1_CreateOnlineOrderRequest = CreateOnlineOrderRequest;
1781
2438
  type context$1_CreateOnlineOrderResponse = CreateOnlineOrderResponse;
1782
2439
  type context$1_CurrentCycle = CurrentCycle;
1783
2440
  type context$1_CursorPaging = CursorPaging;
2441
+ type context$1_DelayAction = DelayAction;
2442
+ type context$1_DeletedWithEntity = DeletedWithEntity;
2443
+ type context$1_DraftInfo = DraftInfo;
1784
2444
  type context$1_Empty = Empty;
2445
+ type context$1_Filter = Filter;
1785
2446
  type context$1_FormData = FormData;
2447
+ type context$1_FutureDateActivationOffset = FutureDateActivationOffset;
1786
2448
  type context$1_GetAvailableOrderActionsRequest = GetAvailableOrderActionsRequest;
1787
2449
  type context$1_GetAvailableOrderActionsResponse = GetAvailableOrderActionsResponse;
1788
2450
  type context$1_GetGuestOnlineOrderPreviewRequest = GetGuestOnlineOrderPreviewRequest;
@@ -1819,6 +2481,8 @@ type context$1_MemberListOrdersRequest = MemberListOrdersRequest;
1819
2481
  type context$1_MemberListOrdersResponse = MemberListOrdersResponse;
1820
2482
  type context$1_MemberListOrdersResponseNonNullableFields = MemberListOrdersResponseNonNullableFields;
1821
2483
  type context$1_OnBehalf = OnBehalf;
2484
+ type context$1_Operator = Operator;
2485
+ declare const context$1_Operator: typeof Operator;
1822
2486
  type context$1_Order = Order;
1823
2487
  type context$1_OrderAutoRenewCanceled = OrderAutoRenewCanceled;
1824
2488
  type context$1_OrderAutoRenewCanceledEnvelope = OrderAutoRenewCanceledEnvelope;
@@ -1854,6 +2518,9 @@ declare const context$1_OrderType: typeof OrderType;
1854
2518
  type context$1_OrderUpdatedEnvelope = OrderUpdatedEnvelope;
1855
2519
  type context$1_OrdersQueryOrdersRequest = OrdersQueryOrdersRequest;
1856
2520
  type context$1_OrdersQueryOrdersResponse = OrdersQueryOrdersResponse;
2521
+ type context$1_Origin = Origin;
2522
+ declare const context$1_Origin: typeof Origin;
2523
+ type context$1_OutputAction = OutputAction;
1857
2524
  type context$1_PauseOrderRequest = PauseOrderRequest;
1858
2525
  type context$1_PauseOrderResponse = PauseOrderResponse;
1859
2526
  type context$1_PausePeriod = PausePeriod;
@@ -1861,6 +2528,7 @@ type context$1_PaymentStatus = PaymentStatus;
1861
2528
  declare const context$1_PaymentStatus: typeof PaymentStatus;
1862
2529
  type context$1_PostponeEndDateRequest = PostponeEndDateRequest;
1863
2530
  type context$1_PostponeEndDateResponse = PostponeEndDateResponse;
2531
+ type context$1_PreinstalledOrigin = PreinstalledOrigin;
1864
2532
  type context$1_Price = Price;
1865
2533
  type context$1_PriceDetails = PriceDetails;
1866
2534
  type context$1_PriceDetailsPricingModelOneOf = PriceDetailsPricingModelOneOf;
@@ -1870,6 +2538,8 @@ type context$1_PricingDetailsPricingModelOneOf = PricingDetailsPricingModelOneOf
1870
2538
  type context$1_QueryOrdersRequest = QueryOrdersRequest;
1871
2539
  type context$1_QueryOrdersResponse = QueryOrdersResponse;
1872
2540
  type context$1_QueryV2PagingMethodOneOf = QueryV2PagingMethodOneOf;
2541
+ type context$1_RateLimit = RateLimit;
2542
+ type context$1_RateLimitAction = RateLimitAction;
1873
2543
  type context$1_ReasonNotSuspendable = ReasonNotSuspendable;
1874
2544
  declare const context$1_ReasonNotSuspendable: typeof ReasonNotSuspendable;
1875
2545
  type context$1_RequestCancellationRequest = RequestCancellationRequest;
@@ -1884,15 +2554,12 @@ type context$1_SpannedPrice = SpannedPrice;
1884
2554
  type context$1_Status = Status;
1885
2555
  declare const context$1_Status: typeof Status;
1886
2556
  type context$1_Tax = Tax;
1887
- type context$1__publicCancelOrderType = _publicCancelOrderType;
1888
- type context$1__publicCreateOfflineOrderType = _publicCreateOfflineOrderType;
1889
- type context$1__publicGetOfflineOrderPreviewType = _publicGetOfflineOrderPreviewType;
1890
- type context$1__publicGetPricePreviewType = _publicGetPricePreviewType;
1891
- type context$1__publicManagementGetOrderType = _publicManagementGetOrderType;
1892
- type context$1__publicManagementListOrdersType = _publicManagementListOrdersType;
1893
- type context$1__publicMarkAsPaidType = _publicMarkAsPaidType;
1894
- type context$1__publicMemberGetOrderType = _publicMemberGetOrderType;
1895
- type context$1__publicMemberListOrdersType = _publicMemberListOrdersType;
2557
+ type context$1_TimeUnit = TimeUnit;
2558
+ declare const context$1_TimeUnit: typeof TimeUnit;
2559
+ type context$1_Trigger = Trigger;
2560
+ type context$1_Type = Type;
2561
+ declare const context$1_Type: typeof Type;
2562
+ type context$1_UpdatedWithPreviousEntity = UpdatedWithPreviousEntity;
1896
2563
  type context$1__publicOnOrderAutoRenewCanceledType = _publicOnOrderAutoRenewCanceledType;
1897
2564
  type context$1__publicOnOrderCanceledType = _publicOnOrderCanceledType;
1898
2565
  type context$1__publicOnOrderCreatedType = _publicOnOrderCreatedType;
@@ -1906,10 +2573,6 @@ type context$1__publicOnOrderResumedType = _publicOnOrderResumedType;
1906
2573
  type context$1__publicOnOrderStartDateChangedType = _publicOnOrderStartDateChangedType;
1907
2574
  type context$1__publicOnOrderStartedType = _publicOnOrderStartedType;
1908
2575
  type context$1__publicOnOrderUpdatedType = _publicOnOrderUpdatedType;
1909
- type context$1__publicPauseOrderType = _publicPauseOrderType;
1910
- type context$1__publicPostponeEndDateType = _publicPostponeEndDateType;
1911
- type context$1__publicRequestCancellationType = _publicRequestCancellationType;
1912
- type context$1__publicResumeOrderType = _publicResumeOrderType;
1913
2576
  declare const context$1_cancelOrder: typeof cancelOrder;
1914
2577
  declare const context$1_createOfflineOrder: typeof createOfflineOrder;
1915
2578
  declare const context$1_getOfflineOrderPreview: typeof getOfflineOrderPreview;
@@ -1937,7 +2600,7 @@ declare const context$1_postponeEndDate: typeof postponeEndDate;
1937
2600
  declare const context$1_requestCancellation: typeof requestCancellation;
1938
2601
  declare const context$1_resumeOrder: typeof resumeOrder;
1939
2602
  declare namespace context$1 {
1940
- 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 RestoreInfo$1 as RestoreInfo, 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, type context$1__publicCancelOrderType as _publicCancelOrderType, type context$1__publicCreateOfflineOrderType as _publicCreateOfflineOrderType, type context$1__publicGetOfflineOrderPreviewType as _publicGetOfflineOrderPreviewType, type context$1__publicGetPricePreviewType as _publicGetPricePreviewType, type context$1__publicManagementGetOrderType as _publicManagementGetOrderType, type context$1__publicManagementListOrdersType as _publicManagementListOrdersType, type context$1__publicMarkAsPaidType as _publicMarkAsPaidType, type context$1__publicMemberGetOrderType as _publicMemberGetOrderType, type context$1__publicMemberListOrdersType as _publicMemberListOrdersType, type context$1__publicOnOrderAutoRenewCanceledType as _publicOnOrderAutoRenewCanceledType, type context$1__publicOnOrderCanceledType as _publicOnOrderCanceledType, type context$1__publicOnOrderCreatedType as _publicOnOrderCreatedType, type context$1__publicOnOrderCycleStartedType as _publicOnOrderCycleStartedType, type context$1__publicOnOrderEndDatePostponedType as _publicOnOrderEndDatePostponedType, type context$1__publicOnOrderEndedType as _publicOnOrderEndedType, type context$1__publicOnOrderMarkedAsPaidType as _publicOnOrderMarkedAsPaidType, type context$1__publicOnOrderPausedType as _publicOnOrderPausedType, type context$1__publicOnOrderPurchasedType as _publicOnOrderPurchasedType, type context$1__publicOnOrderResumedType as _publicOnOrderResumedType, type context$1__publicOnOrderStartDateChangedType as _publicOnOrderStartDateChangedType, type context$1__publicOnOrderStartedType as _publicOnOrderStartedType, type context$1__publicOnOrderUpdatedType as _publicOnOrderUpdatedType, type context$1__publicPauseOrderType as _publicPauseOrderType, type context$1__publicPostponeEndDateType as _publicPostponeEndDateType, type context$1__publicRequestCancellationType as _publicRequestCancellationType, type context$1__publicResumeOrderType as _publicResumeOrderType, 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, onOrderAutoRenewCanceled$1 as publicOnOrderAutoRenewCanceled, onOrderCanceled$1 as publicOnOrderCanceled, onOrderCreated$1 as publicOnOrderCreated, onOrderCycleStarted$1 as publicOnOrderCycleStarted, onOrderEndDatePostponed$1 as publicOnOrderEndDatePostponed, onOrderEnded$1 as publicOnOrderEnded, onOrderMarkedAsPaid$1 as publicOnOrderMarkedAsPaid, onOrderPaused$1 as publicOnOrderPaused, onOrderPurchased$1 as publicOnOrderPurchased, onOrderResumed$1 as publicOnOrderResumed, onOrderStartDateChanged$1 as publicOnOrderStartDateChanged, onOrderStarted$1 as publicOnOrderStarted, onOrderUpdated$1 as publicOnOrderUpdated, context$1_requestCancellation as requestCancellation, context$1_resumeOrder as resumeOrder };
2603
+ export { type context$1_Action as Action, type ActionEvent$1 as ActionEvent, type context$1_ActionInfoOneOf as ActionInfoOneOf, type context$1_ActionSettings as ActionSettings, type context$1_AppDefinedAction as AppDefinedAction, type ApplicationError$1 as ApplicationError, type context$1_ApplicationOrigin as ApplicationOrigin, type context$1_ApplyCouponRequest as ApplyCouponRequest, type context$1_ApplyCouponResponse as ApplyCouponResponse, type context$1_AuditInfo as AuditInfo, type context$1_AuditInfoIdOneOf as AuditInfoIdOneOf, type context$1_Automation as Automation, type context$1_AutomationConfiguration as AutomationConfiguration, context$1_AutomationConfigurationStatus as AutomationConfigurationStatus, type context$1_AutomationOriginInfoOneOf as AutomationOriginInfoOneOf, type context$1_AutomationSettings as AutomationSettings, 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_ConditionAction as ConditionAction, type context$1_ConditionExpressionGroup as ConditionExpressionGroup, 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 context$1_DelayAction as DelayAction, type context$1_DeletedWithEntity as DeletedWithEntity, type DomainEvent$1 as DomainEvent, type DomainEventBodyOneOf$1 as DomainEventBodyOneOf, type context$1_DraftInfo as DraftInfo, 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_Filter as Filter, type context$1_FormData as FormData, type context$1_FutureDateActivationOffset as FutureDateActivationOffset, 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, context$1_Operator as Operator, 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, context$1_Origin as Origin, type context$1_OutputAction as OutputAction, 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_PreinstalledOrigin as PreinstalledOrigin, 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, type context$1_RateLimit as RateLimit, type context$1_RateLimitAction as RateLimitAction, context$1_ReasonNotSuspendable as ReasonNotSuspendable, type Recurrence$1 as Recurrence, type context$1_RequestCancellationRequest as RequestCancellationRequest, type context$1_RequestCancellationResponse as RequestCancellationResponse, type RestoreInfo$1 as RestoreInfo, 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, context$1_TimeUnit as TimeUnit, type context$1_Trigger as Trigger, context$1_Type as Type, type context$1_UpdatedWithPreviousEntity as UpdatedWithPreviousEntity, WebhookIdentityType$1 as WebhookIdentityType, type context$1__publicOnOrderAutoRenewCanceledType as _publicOnOrderAutoRenewCanceledType, type context$1__publicOnOrderCanceledType as _publicOnOrderCanceledType, type context$1__publicOnOrderCreatedType as _publicOnOrderCreatedType, type context$1__publicOnOrderCycleStartedType as _publicOnOrderCycleStartedType, type context$1__publicOnOrderEndDatePostponedType as _publicOnOrderEndDatePostponedType, type context$1__publicOnOrderEndedType as _publicOnOrderEndedType, type context$1__publicOnOrderMarkedAsPaidType as _publicOnOrderMarkedAsPaidType, type context$1__publicOnOrderPausedType as _publicOnOrderPausedType, type context$1__publicOnOrderPurchasedType as _publicOnOrderPurchasedType, type context$1__publicOnOrderResumedType as _publicOnOrderResumedType, type context$1__publicOnOrderStartDateChangedType as _publicOnOrderStartDateChangedType, type context$1__publicOnOrderStartedType as _publicOnOrderStartedType, type context$1__publicOnOrderUpdatedType as _publicOnOrderUpdatedType, 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, onOrderAutoRenewCanceled$1 as publicOnOrderAutoRenewCanceled, onOrderCanceled$1 as publicOnOrderCanceled, onOrderCreated$1 as publicOnOrderCreated, onOrderCycleStarted$1 as publicOnOrderCycleStarted, onOrderEndDatePostponed$1 as publicOnOrderEndDatePostponed, onOrderEnded$1 as publicOnOrderEnded, onOrderMarkedAsPaid$1 as publicOnOrderMarkedAsPaid, onOrderPaused$1 as publicOnOrderPaused, onOrderPurchased$1 as publicOnOrderPurchased, onOrderResumed$1 as publicOnOrderResumed, onOrderStartDateChanged$1 as publicOnOrderStartDateChanged, onOrderStarted$1 as publicOnOrderStarted, onOrderUpdated$1 as publicOnOrderUpdated, context$1_requestCancellation as requestCancellation, context$1_resumeOrder as resumeOrder };
1941
2604
  }
1942
2605
 
1943
2606
  /** Information about the pricing plan. */
@@ -2659,9 +3322,65 @@ interface ListPublicPlansOptions {
2659
3322
  /** 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. */
2660
3323
  planIds?: string[];
2661
3324
  }
2662
- interface QueryPublicPlansOptions {
2663
- /** Query */
2664
- query?: QueryV2;
3325
+ interface QueryOffsetResult {
3326
+ currentPage: number | undefined;
3327
+ totalPages: number | undefined;
3328
+ totalCount: number | undefined;
3329
+ hasNext: () => boolean;
3330
+ hasPrev: () => boolean;
3331
+ length: number;
3332
+ pageSize: number;
3333
+ }
3334
+ interface PlansQueryResult extends QueryOffsetResult {
3335
+ items: PublicPlan[];
3336
+ query: PlansQueryBuilder;
3337
+ next: () => Promise<PlansQueryResult>;
3338
+ prev: () => Promise<PlansQueryResult>;
3339
+ }
3340
+ interface PlansQueryBuilder {
3341
+ /** @param propertyName - Property whose value is compared with `value`.
3342
+ * @param value - Value to compare against.
3343
+ */
3344
+ eq: (propertyName: '_id' | 'primary' | '_createdDate' | '_updatedDate' | 'slug', value: any) => PlansQueryBuilder;
3345
+ /** @param propertyName - Property whose value is compared with `value`.
3346
+ * @param value - Value to compare against.
3347
+ */
3348
+ ne: (propertyName: '_id' | 'primary' | '_createdDate' | '_updatedDate' | 'slug', value: any) => PlansQueryBuilder;
3349
+ /** @param propertyName - Property whose value is compared with `value`.
3350
+ * @param value - Value to compare against.
3351
+ */
3352
+ ge: (propertyName: '_createdDate' | '_updatedDate', value: any) => PlansQueryBuilder;
3353
+ /** @param propertyName - Property whose value is compared with `value`.
3354
+ * @param value - Value to compare against.
3355
+ */
3356
+ gt: (propertyName: '_createdDate' | '_updatedDate', value: any) => PlansQueryBuilder;
3357
+ /** @param propertyName - Property whose value is compared with `value`.
3358
+ * @param value - Value to compare against.
3359
+ */
3360
+ le: (propertyName: '_createdDate' | '_updatedDate', value: any) => PlansQueryBuilder;
3361
+ /** @param propertyName - Property whose value is compared with `value`.
3362
+ * @param value - Value to compare against.
3363
+ */
3364
+ lt: (propertyName: '_createdDate' | '_updatedDate', value: any) => PlansQueryBuilder;
3365
+ /** @param propertyName - Property whose value is compared with `string`.
3366
+ * @param string - String to compare against. Case-insensitive.
3367
+ */
3368
+ startsWith: (propertyName: '_id' | 'slug', value: string) => PlansQueryBuilder;
3369
+ /** @param propertyName - Property whose value is compared with `values`.
3370
+ * @param values - List of values to compare against.
3371
+ */
3372
+ hasSome: (propertyName: '_id' | 'primary' | '_createdDate' | '_updatedDate' | 'slug', value: any[]) => PlansQueryBuilder;
3373
+ in: (propertyName: '_id' | 'primary' | '_createdDate' | '_updatedDate' | 'slug', value: any) => PlansQueryBuilder;
3374
+ exists: (propertyName: '_id' | 'primary' | '_createdDate' | '_updatedDate' | 'slug', value: boolean) => PlansQueryBuilder;
3375
+ /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
3376
+ ascending: (...propertyNames: Array<'_id' | 'primary' | '_createdDate' | '_updatedDate' | 'slug'>) => PlansQueryBuilder;
3377
+ /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
3378
+ descending: (...propertyNames: Array<'_id' | 'primary' | '_createdDate' | '_updatedDate' | 'slug'>) => PlansQueryBuilder;
3379
+ /** @param limit - Number of items to return, which is also the `pageSize` of the results object. */
3380
+ limit: (limit: number) => PlansQueryBuilder;
3381
+ /** @param skip - Number of items to skip in the query results before returning the results. */
3382
+ skip: (skip: number) => PlansQueryBuilder;
3383
+ find: () => Promise<PlansQueryResult>;
2665
3384
  }
2666
3385
  interface ListPlansOptions {
2667
3386
  /**
@@ -2770,62 +3489,243 @@ interface UpdatePlan {
2770
3489
  formId?: string | null;
2771
3490
  }
2772
3491
 
2773
- declare function listPublicPlans$1(httpClient: HttpClient): (options?: ListPublicPlansOptions) => Promise<ListPublicPlansResponse & ListPublicPlansResponseNonNullableFields>;
2774
- declare function queryPublicPlans$1(httpClient: HttpClient): (options?: QueryPublicPlansOptions) => Promise<QueryPublicPlansResponse & QueryPublicPlansResponseNonNullableFields>;
2775
- declare function getPlan$1(httpClient: HttpClient): (_id: string) => Promise<Plan & PlanNonNullableFields>;
2776
- declare function listPlans$1(httpClient: HttpClient): (options?: ListPlansOptions) => Promise<ListPlansResponse & ListPlansResponseNonNullableFields>;
2777
- declare function getPlanStats$1(httpClient: HttpClient): () => Promise<GetPlanStatsResponse & GetPlanStatsResponseNonNullableFields>;
2778
- declare function createPlan$1(httpClient: HttpClient): (plan: Plan) => Promise<Plan & PlanNonNullableFields>;
2779
- declare function updatePlan$1(httpClient: HttpClient): (_id: string, plan: UpdatePlan) => Promise<Plan & PlanNonNullableFields>;
2780
- declare function setPlanVisibility$1(httpClient: HttpClient): (_id: string, visible: boolean) => Promise<SetPlanVisibilityResponse & SetPlanVisibilityResponseNonNullableFields>;
2781
- declare function makePlanPrimary$1(httpClient: HttpClient): (_id: string) => Promise<MakePlanPrimaryResponse & MakePlanPrimaryResponseNonNullableFields>;
2782
- declare function clearPrimary$1(httpClient: HttpClient): () => Promise<void>;
2783
- declare function archivePlan$1(httpClient: HttpClient): (_id: string) => Promise<ArchivePlanResponse & ArchivePlanResponseNonNullableFields>;
2784
- declare function arrangePlans$1(httpClient: HttpClient): (ids: string[]) => Promise<void>;
3492
+ declare function listPublicPlans$1(httpClient: HttpClient): ListPublicPlansSignature;
3493
+ interface ListPublicPlansSignature {
3494
+ /**
3495
+ * Retrieves a list of public pricing plans.
3496
+ *
3497
+ *
3498
+ * The `listPublicPlans()` function returns a Promise that resolves to a list of up to 100 public pricing plans. Public plans are visible plans that site visitors can see on the site and purchase.
3499
+ * @param - Options for filtering and paging the list of public plans.
3500
+ * @returns Fulfilled - List of public pricing plans.
3501
+ */
3502
+ (options?: ListPublicPlansOptions | undefined): Promise<ListPublicPlansResponse & ListPublicPlansResponseNonNullableFields>;
3503
+ }
3504
+ declare function queryPublicPlans$1(httpClient: HttpClient): QueryPublicPlansSignature;
3505
+ interface QueryPublicPlansSignature {
3506
+ /**
3507
+ * Creates a query to retrieve a list of public pricing plans.
3508
+ *
3509
+ *
3510
+ * The `queryPublicPlans()` function builds a query to retrieve a list of up to 1,000 public plans and returns a [`PublicPlansQueryBuilder`](#plansquerybuilder) object.
3511
+ *
3512
+ * The returned object contains the query definition which is typically used to run the query using the [`find()`](#plansquerybuilder/find) function.
3513
+ *
3514
+ * You can refine the query by chaining `PublicPlansQueryBuilder` functions onto the query. `PublicPlansQueryBuilder` functions enable you to sort, filter, and control the results that `queryPublicPlans()` returns.
3515
+ *
3516
+ * `queryPublicPlans()` runs with the following `PublicPlansQueryBuilder` defaults that you can override:
3517
+ * - [`skip`](#plansquerybuilder/skip): `0`
3518
+ * - [`limit`](#plansquerybuilder/limit): `50`
3519
+ *
3520
+ * The functions that are chained to `queryPublicPlans()` are applied in the order they are called. For example, if you sort on the `_createdDate` property in ascending order and then on the `_id` property in ascending order, the results are sorted first by the created date of the items and then, if there are multiple results with the same date, the items are sorted by `_id` in ascending order, per created date value.
3521
+ *
3522
+ * The following `PublicPlansQueryBuilder` functions are supported for the `queryPublicPlans()` function. For a full description of the Plans object, see the object returned for the [`items`](#plansqueryresult/items) property in [`PublicPlansQueryResult`](#plansqueryresult).
3523
+ */
3524
+ (): PlansQueryBuilder;
3525
+ }
3526
+ declare function getPlan$1(httpClient: HttpClient): GetPlanSignature;
3527
+ interface GetPlanSignature {
3528
+ /**
3529
+ * Retrieves a pricing plan by the specified ID.
3530
+ *
3531
+ * The `getPlan()` function returns a Promise that resolves to a plan whose ID matched the specified ID.
3532
+ * @param - Plan ID.
3533
+ * @returns Fulfilled - The retrieved plan's information.
3534
+ */
3535
+ (_id: string): Promise<Plan & PlanNonNullableFields>;
3536
+ }
3537
+ declare function listPlans$1(httpClient: HttpClient): ListPlansSignature;
3538
+ interface ListPlansSignature {
3539
+ /**
3540
+ * Retrieves a list of pricing plans.
3541
+ *
3542
+ * The `listPlans()` function returns a Promise that resolves to a list of up to 100 pricing plans. This includes public, hidden, and archived plans.
3543
+ * @param - Options for filtering and paging the list of plans.
3544
+ * @returns Fulfilled - List of plans that match the given criteria.
3545
+ */
3546
+ (options?: ListPlansOptions | undefined): Promise<ListPlansResponse & ListPlansResponseNonNullableFields>;
3547
+ }
3548
+ declare function getPlanStats$1(httpClient: HttpClient): GetPlanStatsSignature;
3549
+ interface GetPlanStatsSignature {
3550
+ /**
3551
+ * Retrieves statistics about the pricing plans.
3552
+ *
3553
+ *
3554
+ * The `getPlanStats()` function returns a Promise that resolves to statistics about the plan on the site.
3555
+ *
3556
+ * Currently this function provides only the total number of pricing plans, including archived plans.
3557
+ * @returns Fulfilled - Overall statistics about the pricing plans.
3558
+ */
3559
+ (): Promise<GetPlanStatsResponse & GetPlanStatsResponseNonNullableFields>;
3560
+ }
3561
+ declare function createPlan$1(httpClient: HttpClient): CreatePlanSignature;
3562
+ interface CreatePlanSignature {
3563
+ /**
3564
+ * Creates a pricing plan.
3565
+ *
3566
+ *
3567
+ * The `createPlan()` function returns a Promise that resolves to a newly-created pricing plan after is has successfully been created.
3568
+ *
3569
+ * The passed `plan` object must contain a [pricing model](https://www.wix.com/velo/reference/wix-pricing-plans-v2/plans/pricing-models). A pricing model can be one of the following:
3570
+ * - **A subscription**: A subscription with recurring payment and how often the plan occurs. Subscriptions can have free trial days.
3571
+ * - **A plan that does not renew**: A single payment for a specific duration that doesn't renew.
3572
+ * - **An unlimited plan**: A single payment for an unlimited amount of time (until canceled).
3573
+ *
3574
+ * Pricing plans created by this function are available to the site owner in the Pricing Plans section in the Dashboard.
3575
+ * @param - Information for the plan being created.
3576
+ * @returns Fulfilled - The created plan.
3577
+ *
3578
+ * Rejected - Error message.
3579
+ */
3580
+ (plan: Plan): Promise<Plan & PlanNonNullableFields>;
3581
+ }
3582
+ declare function updatePlan$1(httpClient: HttpClient): UpdatePlanSignature;
3583
+ interface UpdatePlanSignature {
3584
+ /**
3585
+ * Updates a pricing plan.
3586
+ *
3587
+ *
3588
+ * The `updatePlan()` function returns a Promise that resolves to an updated plan.
3589
+ *
3590
+ * Updating a plan does not impact existing purchases made for the plan. All purchases keep the details of the original plan that was active at the time of the purchase.
3591
+ * @param - ID of the plan to update.
3592
+ * @param - Options for updating the plan.
3593
+ * @returns Fulfilled - The updated plan.
3594
+ *
3595
+ * Rejected - Error message.
3596
+ */
3597
+ (_id: string, plan: UpdatePlan): Promise<Plan & PlanNonNullableFields>;
3598
+ }
3599
+ declare function setPlanVisibility$1(httpClient: HttpClient): SetPlanVisibilitySignature;
3600
+ interface SetPlanVisibilitySignature {
3601
+ /**
3602
+ * Sets visibility for non-archived pricing plans.
3603
+ *
3604
+ * The `setPlanVisibility()` functions returns a Promise that resolves to a pricing plan when its visibility has successfully been set.
3605
+ *
3606
+ * By default, pricing plans are public, meaning they are visible. [Plans can be hidden](https://support.wix.com/en/article/pricing-plans-removing-a-plan-from-your-site#hiding-plans) so that site members and visitors cannot see or choose them.
3607
+ *
3608
+ * As opposed to archiving, setting visibility can be reversed. This means that a public plan can be hidden, and a hidden plan can be made public (visible).
3609
+ *
3610
+ * >**Note:** An archived plan always remains archived and cannot be made active again. When archiving a plan, its `public` property is automatically set to `false` so that it is hidden.
3611
+ *
3612
+ * Changing a plan's visibility does not impact existing orders for the plan. All orders for hidden plans are still active and keep their terms and payment options.
3613
+ * @param - Whether to set the plan as visible.
3614
+ * @param - The ID of the plan to either display or hide on the site page.
3615
+ * @param - Plan visibility options.
3616
+ * @returns Fulfilled - The plan's information.
3617
+ *
3618
+ * Rejected - Error message.
3619
+ */
3620
+ (_id: string, visible: boolean): Promise<SetPlanVisibilityResponse & SetPlanVisibilityResponseNonNullableFields>;
3621
+ }
3622
+ declare function makePlanPrimary$1(httpClient: HttpClient): MakePlanPrimarySignature;
3623
+ interface MakePlanPrimarySignature {
3624
+ /**
3625
+ * Marks a pricing plan as the primary pricing plan.
3626
+ *
3627
+ *
3628
+ * The `makePlanPrimary()` function returns a Promise that resolves to the now primary pricing plan.
3629
+ *
3630
+ * Only a single plan can be marked as a primary plan at any given time. If there is an existing plan marked as primary, calling `makePlanPrimary()` causes the existing primary plan to lose its primary status.
3631
+ *
3632
+ * When viewing pricing plans on the site, the primary plan is highlighted with a customizable ribbon.
3633
+ * @param - ID of the pricing plan to set as the primary plan.
3634
+ * @returns Fulfilled - The primary plan.
3635
+ */
3636
+ (_id: string): Promise<MakePlanPrimaryResponse & MakePlanPrimaryResponseNonNullableFields>;
3637
+ }
3638
+ declare function clearPrimary$1(httpClient: HttpClient): ClearPrimarySignature;
3639
+ interface ClearPrimarySignature {
3640
+ /**
3641
+ * Sets all pricing plans to no longer be primary.
3642
+ *
3643
+ * The `clearPrimary()` function returns a Promise that is resolved when there are no pricing plans marked as `primary`.
3644
+ *
3645
+ * After clearing the primary plan, when viewing pricing plans on the site, no plan is highlighted with a customizable ribbon.
3646
+ */
3647
+ (): Promise<void>;
3648
+ }
3649
+ declare function archivePlan$1(httpClient: HttpClient): ArchivePlanSignature;
3650
+ interface ArchivePlanSignature {
3651
+ /**
3652
+ * Archives a single plan.
3653
+ *
3654
+ *
3655
+ * The `archivePlan()` function returns a Promise that resolves to the newly-archived plan.
3656
+ *
3657
+ * When a plan is archived, the plan
3658
+ * - Is no longer available for display or selection by visitors. This is because the plan's `public` property is automatically set to `false`.
3659
+ * - Cannot be purchased.
3660
+ * - Cannot be "un-archived", meaning the plan cannot be made active again.
3661
+ *
3662
+ * Plan archiving does not impact existing purchases made for the plan. All purchases for the plan are still active and keep their payment options and terms.
3663
+ *
3664
+ * Site owners can see archived plans in the Dashboard under **Pricing Plans -> Archived Plans**.
3665
+ *
3666
+ * >**Note:** An attempt to archive an already-archived plan throws an error.
3667
+ * @param - ID of the active plan to archive.
3668
+ * @returns Fulfilled - The archived plan.
3669
+ *
3670
+ * Rejected - Error message.
3671
+ */
3672
+ (_id: string): Promise<ArchivePlanResponse & ArchivePlanResponseNonNullableFields>;
3673
+ }
3674
+ declare function arrangePlans$1(httpClient: HttpClient): ArrangePlansSignature;
3675
+ interface ArrangePlansSignature {
3676
+ /**
3677
+ * Changes the display order of the pricing plans on the site page and in the Dashboard.
3678
+ *
3679
+ *
3680
+ * The `arrangePlans()` function returns a Promise that resolves when the plans are rearranged on the site page and in the Dashboard.
3681
+ *
3682
+ * To rearrange the order of the plans, provide a list of the IDs for all non-archived plans in the desired order, including hidden plans.
3683
+ *
3684
+ * >**Note:** Make sure to provide *all* non-archived plan IDs to avoid unpredictable results.
3685
+ * @param - IDs of all non-archived plans in the order you want them arranged.
3686
+ */
3687
+ (ids: string[]): Promise<void>;
3688
+ }
2785
3689
  declare const onPlanUpdated$1: EventDefinition<PlanUpdatedEnvelope, "wix.pricing_plans.plan_updated">;
2786
3690
  declare const onPlanCreated$1: EventDefinition<PlanCreatedEnvelope, "wix.pricing_plans.plan_created">;
2787
3691
  declare const onPlanBuyerCanCancelUpdated$1: EventDefinition<PlanBuyerCanCancelUpdatedEnvelope, "wix.pricing_plans.plan_buyer_can_cancel_updated">;
2788
3692
  declare const onPlanArchived$1: EventDefinition<PlanArchivedEnvelope, "wix.pricing_plans.plan_plan_archived">;
2789
3693
 
2790
- declare function createRESTModule<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
2791
-
2792
3694
  declare function createEventModule<T extends EventDefinition<any, string>>(eventDefinition: T): BuildEventDefinition<T> & T;
2793
3695
 
2794
- type _publicListPublicPlansType = typeof listPublicPlans$1;
2795
- declare const listPublicPlans: ReturnType<typeof createRESTModule<_publicListPublicPlansType>>;
2796
- type _publicQueryPublicPlansType = typeof queryPublicPlans$1;
2797
- declare const queryPublicPlans: ReturnType<typeof createRESTModule<_publicQueryPublicPlansType>>;
2798
- type _publicGetPlanType = typeof getPlan$1;
2799
- declare const getPlan: ReturnType<typeof createRESTModule<_publicGetPlanType>>;
2800
- type _publicListPlansType = typeof listPlans$1;
2801
- declare const listPlans: ReturnType<typeof createRESTModule<_publicListPlansType>>;
2802
- type _publicGetPlanStatsType = typeof getPlanStats$1;
2803
- declare const getPlanStats: ReturnType<typeof createRESTModule<_publicGetPlanStatsType>>;
2804
- type _publicCreatePlanType = typeof createPlan$1;
2805
- declare const createPlan: ReturnType<typeof createRESTModule<_publicCreatePlanType>>;
2806
- type _publicUpdatePlanType = typeof updatePlan$1;
2807
- declare const updatePlan: ReturnType<typeof createRESTModule<_publicUpdatePlanType>>;
2808
- type _publicSetPlanVisibilityType = typeof setPlanVisibility$1;
2809
- declare const setPlanVisibility: ReturnType<typeof createRESTModule<_publicSetPlanVisibilityType>>;
2810
- type _publicMakePlanPrimaryType = typeof makePlanPrimary$1;
2811
- declare const makePlanPrimary: ReturnType<typeof createRESTModule<_publicMakePlanPrimaryType>>;
2812
- type _publicClearPrimaryType = typeof clearPrimary$1;
2813
- declare const clearPrimary: ReturnType<typeof createRESTModule<_publicClearPrimaryType>>;
2814
- type _publicArchivePlanType = typeof archivePlan$1;
2815
- declare const archivePlan: ReturnType<typeof createRESTModule<_publicArchivePlanType>>;
2816
- type _publicArrangePlansType = typeof arrangePlans$1;
2817
- declare const arrangePlans: ReturnType<typeof createRESTModule<_publicArrangePlansType>>;
3696
+ declare const listPublicPlans: BuildRESTFunction<typeof listPublicPlans$1> & typeof listPublicPlans$1;
3697
+ declare const queryPublicPlans: BuildRESTFunction<typeof queryPublicPlans$1> & typeof queryPublicPlans$1;
3698
+ declare const getPlan: BuildRESTFunction<typeof getPlan$1> & typeof getPlan$1;
3699
+ declare const listPlans: BuildRESTFunction<typeof listPlans$1> & typeof listPlans$1;
3700
+ declare const getPlanStats: BuildRESTFunction<typeof getPlanStats$1> & typeof getPlanStats$1;
3701
+ declare const createPlan: BuildRESTFunction<typeof createPlan$1> & typeof createPlan$1;
3702
+ declare const updatePlan: BuildRESTFunction<typeof updatePlan$1> & typeof updatePlan$1;
3703
+ declare const setPlanVisibility: BuildRESTFunction<typeof setPlanVisibility$1> & typeof setPlanVisibility$1;
3704
+ declare const makePlanPrimary: BuildRESTFunction<typeof makePlanPrimary$1> & typeof makePlanPrimary$1;
3705
+ declare const clearPrimary: BuildRESTFunction<typeof clearPrimary$1> & typeof clearPrimary$1;
3706
+ declare const archivePlan: BuildRESTFunction<typeof archivePlan$1> & typeof archivePlan$1;
3707
+ declare const arrangePlans: BuildRESTFunction<typeof arrangePlans$1> & typeof arrangePlans$1;
2818
3708
 
2819
3709
  type _publicOnPlanUpdatedType = typeof onPlanUpdated$1;
3710
+ /**
3711
+ * An event that is triggered when a pricing plan is updated.
3712
+ */
2820
3713
  declare const onPlanUpdated: ReturnType<typeof createEventModule<_publicOnPlanUpdatedType>>;
2821
3714
 
2822
3715
  type _publicOnPlanCreatedType = typeof onPlanCreated$1;
3716
+ /**
3717
+ * An event that is triggered when a pricing plan is created.
3718
+ */
2823
3719
  declare const onPlanCreated: ReturnType<typeof createEventModule<_publicOnPlanCreatedType>>;
2824
3720
 
2825
3721
  type _publicOnPlanBuyerCanCancelUpdatedType = typeof onPlanBuyerCanCancelUpdated$1;
3722
+ /** */
2826
3723
  declare const onPlanBuyerCanCancelUpdated: ReturnType<typeof createEventModule<_publicOnPlanBuyerCanCancelUpdatedType>>;
2827
3724
 
2828
3725
  type _publicOnPlanArchivedType = typeof onPlanArchived$1;
3726
+ /**
3727
+ * An event that is triggered when a pricing plan is archived.
3728
+ */
2829
3729
  declare const onPlanArchived: ReturnType<typeof createEventModule<_publicOnPlanArchivedType>>;
2830
3730
 
2831
3731
  type context_ActionEvent = ActionEvent;
@@ -2897,6 +3797,8 @@ type context_PlanBuyerCanCancelUpdatedEnvelope = PlanBuyerCanCancelUpdatedEnvelo
2897
3797
  type context_PlanCreatedEnvelope = PlanCreatedEnvelope;
2898
3798
  type context_PlanNonNullableFields = PlanNonNullableFields;
2899
3799
  type context_PlanUpdatedEnvelope = PlanUpdatedEnvelope;
3800
+ type context_PlansQueryBuilder = PlansQueryBuilder;
3801
+ type context_PlansQueryResult = PlansQueryResult;
2900
3802
  type context_Pricing = Pricing;
2901
3803
  type context_PricingPricingModelOneOf = PricingPricingModelOneOf;
2902
3804
  type context_PublicFilter = PublicFilter;
@@ -2904,7 +3806,6 @@ declare const context_PublicFilter: typeof PublicFilter;
2904
3806
  type context_PublicPlan = PublicPlan;
2905
3807
  type context_QueryPlansRequest = QueryPlansRequest;
2906
3808
  type context_QueryPlansResponse = QueryPlansResponse;
2907
- type context_QueryPublicPlansOptions = QueryPublicPlansOptions;
2908
3809
  type context_QueryPublicPlansRequest = QueryPublicPlansRequest;
2909
3810
  type context_QueryPublicPlansResponse = QueryPublicPlansResponse;
2910
3811
  type context_QueryPublicPlansResponseNonNullableFields = QueryPublicPlansResponseNonNullableFields;
@@ -2924,22 +3825,10 @@ type context_UpdatePlanResponse = UpdatePlanResponse;
2924
3825
  type context_UpdatePlanResponseNonNullableFields = UpdatePlanResponseNonNullableFields;
2925
3826
  type context_WebhookIdentityType = WebhookIdentityType;
2926
3827
  declare const context_WebhookIdentityType: typeof WebhookIdentityType;
2927
- type context__publicArchivePlanType = _publicArchivePlanType;
2928
- type context__publicArrangePlansType = _publicArrangePlansType;
2929
- type context__publicClearPrimaryType = _publicClearPrimaryType;
2930
- type context__publicCreatePlanType = _publicCreatePlanType;
2931
- type context__publicGetPlanStatsType = _publicGetPlanStatsType;
2932
- type context__publicGetPlanType = _publicGetPlanType;
2933
- type context__publicListPlansType = _publicListPlansType;
2934
- type context__publicListPublicPlansType = _publicListPublicPlansType;
2935
- type context__publicMakePlanPrimaryType = _publicMakePlanPrimaryType;
2936
3828
  type context__publicOnPlanArchivedType = _publicOnPlanArchivedType;
2937
3829
  type context__publicOnPlanBuyerCanCancelUpdatedType = _publicOnPlanBuyerCanCancelUpdatedType;
2938
3830
  type context__publicOnPlanCreatedType = _publicOnPlanCreatedType;
2939
3831
  type context__publicOnPlanUpdatedType = _publicOnPlanUpdatedType;
2940
- type context__publicQueryPublicPlansType = _publicQueryPublicPlansType;
2941
- type context__publicSetPlanVisibilityType = _publicSetPlanVisibilityType;
2942
- type context__publicUpdatePlanType = _publicUpdatePlanType;
2943
3832
  declare const context_archivePlan: typeof archivePlan;
2944
3833
  declare const context_arrangePlans: typeof arrangePlans;
2945
3834
  declare const context_clearPrimary: typeof clearPrimary;
@@ -2957,7 +3846,7 @@ declare const context_queryPublicPlans: typeof queryPublicPlans;
2957
3846
  declare const context_setPlanVisibility: typeof setPlanVisibility;
2958
3847
  declare const context_updatePlan: typeof updatePlan;
2959
3848
  declare namespace context {
2960
- 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_CountPlansRequest as CountPlansRequest, type context_CountPlansResponse as CountPlansResponse, 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_GetPlansPremiumStatusRequest as GetPlansPremiumStatusRequest, type context_GetPlansPremiumStatusResponse as GetPlansPremiumStatusResponse, 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_Pricing as Pricing, type context_PricingPricingModelOneOf as PricingPricingModelOneOf, context_PublicFilter as PublicFilter, type context_PublicPlan as PublicPlan, type context_QueryPlansRequest as QueryPlansRequest, type context_QueryPlansResponse as QueryPlansResponse, type context_QueryPublicPlansOptions as QueryPublicPlansOptions, 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_RestoreInfo as RestoreInfo, 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, type context__publicArchivePlanType as _publicArchivePlanType, type context__publicArrangePlansType as _publicArrangePlansType, type context__publicClearPrimaryType as _publicClearPrimaryType, type context__publicCreatePlanType as _publicCreatePlanType, type context__publicGetPlanStatsType as _publicGetPlanStatsType, type context__publicGetPlanType as _publicGetPlanType, type context__publicListPlansType as _publicListPlansType, type context__publicListPublicPlansType as _publicListPublicPlansType, type context__publicMakePlanPrimaryType as _publicMakePlanPrimaryType, type context__publicOnPlanArchivedType as _publicOnPlanArchivedType, type context__publicOnPlanBuyerCanCancelUpdatedType as _publicOnPlanBuyerCanCancelUpdatedType, type context__publicOnPlanCreatedType as _publicOnPlanCreatedType, type context__publicOnPlanUpdatedType as _publicOnPlanUpdatedType, type context__publicQueryPublicPlansType as _publicQueryPublicPlansType, type context__publicSetPlanVisibilityType as _publicSetPlanVisibilityType, type context__publicUpdatePlanType as _publicUpdatePlanType, 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, onPlanArchived$1 as publicOnPlanArchived, onPlanBuyerCanCancelUpdated$1 as publicOnPlanBuyerCanCancelUpdated, onPlanCreated$1 as publicOnPlanCreated, onPlanUpdated$1 as publicOnPlanUpdated, context_queryPublicPlans as queryPublicPlans, context_setPlanVisibility as setPlanVisibility, context_updatePlan as updatePlan };
3849
+ 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_CountPlansRequest as CountPlansRequest, type context_CountPlansResponse as CountPlansResponse, 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_GetPlansPremiumStatusRequest as GetPlansPremiumStatusRequest, type context_GetPlansPremiumStatusResponse as GetPlansPremiumStatusResponse, 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_QueryPlansRequest as QueryPlansRequest, type context_QueryPlansResponse as QueryPlansResponse, 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_RestoreInfo as RestoreInfo, 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, type context__publicOnPlanArchivedType as _publicOnPlanArchivedType, type context__publicOnPlanBuyerCanCancelUpdatedType as _publicOnPlanBuyerCanCancelUpdatedType, type context__publicOnPlanCreatedType as _publicOnPlanCreatedType, type context__publicOnPlanUpdatedType as _publicOnPlanUpdatedType, 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, onPlanArchived$1 as publicOnPlanArchived, onPlanBuyerCanCancelUpdated$1 as publicOnPlanBuyerCanCancelUpdated, onPlanCreated$1 as publicOnPlanCreated, onPlanUpdated$1 as publicOnPlanUpdated, context_queryPublicPlans as queryPublicPlans, context_setPlanVisibility as setPlanVisibility, context_updatePlan as updatePlan };
2961
3850
  }
2962
3851
 
2963
3852
  export { context$1 as orders, context as plans };