@wix/auto_sdk_pricing-plans_plans 1.0.59 → 1.0.61

package/build/{internal/cjs/src/pricing-plans-v2-plan-plans.types.d.ts → pricing-plans-v2-plan-plans.universal-DwvmTikd.d.mts}

@@ -1,11 +1,11 @@
 /** Information about the pricing plan. */
-export interface Plan {
+interface Plan {
     /**
      * Plan ID.
      * @format GUID
      * @readonly
      */
-    id?: string;
+    _id?: string;
     /**
      * Plan name.
      * @minLength 1
@@ -42,12 +42,12 @@ export interface Plan {
      * Date plan was created.
      * @readonly
      */
-    createdDate?: Date | null;
+    _createdDate?: Date | null;
     /**
      * Date plan was last updated.
      * @readonly
      */
-    updatedDate?: Date | null;
+    _updatedDate?: Date | null;
     /**
      * URL-friendly version of plan name. Unique across all plans in the same site.
      * @minLength 1
@@ -83,7 +83,7 @@ export interface Plan {
     formId?: string | null;
 }
 /** This wrapper type exists to distinguish an empty string list from no list at all in update requests. */
-export interface StringList {
+interface StringList {
     /**
      * @minLength 1
      * @maxLength 1400
@@ -92,7 +92,7 @@ export interface StringList {
     values?: string[];
 }
 /** Plan pricing information. Includes the price of the plan and payment details. */
-export interface Pricing extends PricingPricingModelOneOf {
+interface Pricing extends PricingPricingModelOneOf {
     /** Pricing model indicating that the plan has recurring payments. This type of subscription is not a "Wix subscription," which encompasses various types of subscriptions, such as Wix Stores subscriptions, Wix invoice subscriptions, and all pricing plan models. */
     subscription?: Recurrence;
     /** Pricing model indicating a single payment per cycle and the length of the cycle. The cycle is the duration of the plan, not a payment cycle. */
@@ -108,7 +108,7 @@ export interface Pricing extends PricingPricingModelOneOf {
     freeTrialDays?: number | null;
 }
 /** @oneof */
-export interface PricingPricingModelOneOf {
+interface PricingPricingModelOneOf {
     /** Pricing model indicating that the plan has recurring payments. This type of subscription is not a "Wix subscription," which encompasses various types of subscriptions, such as Wix Stores subscriptions, Wix invoice subscriptions, and all pricing plan models. */
     subscription?: Recurrence;
     /** Pricing model indicating a single payment per cycle and the length of the cycle. The cycle is the duration of the plan, not a payment cycle. */
@@ -117,7 +117,7 @@ export interface PricingPricingModelOneOf {
     singlePaymentUnlimited?: boolean | null;
 }
 /** An object specifying how often and for how long payments recur (may be forever). */
-export interface Recurrence {
+interface Recurrence {
     /**
      * Number of payment cycles the subscription is valid for.
      * `0` for unlimited plans or for plans that are valid until canceled.
@@ -132,7 +132,7 @@ export interface Recurrence {
     cycleCount?: number | null;
 }
 /** A duration expressed in number of time units. */
-export interface Duration {
+interface Duration {
     /**
      * Number of days, months, weeks, or years in a single payment cycle. Currently limited to support only `1`.
      * @min 1
@@ -141,7 +141,7 @@ export interface Duration {
     /** Unit of time for the cycle duration. */
     unit?: PeriodUnitWithLiterals;
 }
-export declare enum PeriodUnit {
+declare enum PeriodUnit {
     /** Not defined. */
     UNDEFINED = "UNDEFINED",
     /** Time unit is a day. */
@@ -154,8 +154,8 @@ export declare enum PeriodUnit {
     YEAR = "YEAR"
 }
 /** @enumType */
-export type PeriodUnitWithLiterals = PeriodUnit | 'UNDEFINED' | 'DAY' | 'WEEK' | 'MONTH' | 'YEAR';
-export interface Money {
+type PeriodUnitWithLiterals = PeriodUnit | 'UNDEFINED' | 'DAY' | 'WEEK' | 'MONTH' | 'YEAR';
+interface Money {
     /**
      * Monetary amount. Decimal string with a period as a decimal separator. For example, `'3.99'`. Can't be negative.
      * @decimalValue options { lt:1000000000000, gte:0.000, maxScale:3 }
@@ -167,13 +167,13 @@ export interface Money {
      */
     currency?: string;
 }
-export interface FeeConfig {
+interface FeeConfig {
     /** Fee configuration. */
     fee?: Fee;
     /** The time this fee will be charged. */
     appliedAt?: AppliedAtWithLiterals;
 }
-export interface Fee {
+interface Fee {
     /**
      * Fee name
      * @minLength 1
@@ -186,14 +186,14 @@ export interface Fee {
      */
     amount?: string;
 }
-export declare enum AppliedAt {
+declare enum AppliedAt {
     UNKNOWN_CHARGE_EVENT = "UNKNOWN_CHARGE_EVENT",
     /** Will charge the fee on the first payment. If the order has a free trial, it will charge after the free trial. */
     FIRST_PAYMENT = "FIRST_PAYMENT"
 }
 /** @enumType */
-export type AppliedAtWithLiterals = AppliedAt | 'UNKNOWN_CHARGE_EVENT' | 'FIRST_PAYMENT';
-export interface ListPublicPlansRequest {
+type AppliedAtWithLiterals = AppliedAt | 'UNKNOWN_CHARGE_EVENT' | 'FIRST_PAYMENT';
+interface ListPublicPlansRequest {
     /**
      * Number of items to list. Defaults to `75`. See limits ([SDK](https://dev.wix.com/docs/sdk/backend-modules/pricing-plans/plans/list-public-plans) | [REST](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#paging)).
      * @min 1
@@ -209,19 +209,19 @@ export interface ListPublicPlansRequest {
      */
     planIds?: string[];
 }
-export interface ListPublicPlansResponse {
+interface ListPublicPlansResponse {
     /** List of public pricing plans. */
     plans?: PublicPlan[];
     /** Object containing paging-related data (such as the number of plans returned, the offset, and so on). */
     pagingMetadata?: PagingMetadataV2;
 }
 /** Public plan entity containing information about the pricing plan. Can be read by any site member or visitor. */
-export interface PublicPlan {
+interface PublicPlan {
     /**
      * Plan ID.
      * @format GUID
      */
-    id?: string;
+    _id?: string;
     /**
      * Plan name.
      * @minLength 1
@@ -240,9 +240,9 @@ export interface PublicPlan {
     /** Whether the plan is marked as primary. */
     primary?: boolean;
     /** Date plan was created. */
-    createdDate?: Date | null;
+    _createdDate?: Date | null;
     /** Date plan was last updated. */
-    updatedDate?: Date | null;
+    _updatedDate?: Date | null;
     /**
      * URL-friendly version of plan name. Unique across all plans in the same site.
      * @minLength 1
@@ -264,7 +264,7 @@ export interface PublicPlan {
      */
     formId?: string | null;
 }
-export interface PagingMetadataV2 {
+interface PagingMetadataV2 {
     /** Number of items returned in the response. */
     count?: number | null;
     /** Offset that was requested. */
@@ -276,7 +276,7 @@ export interface PagingMetadataV2 {
     /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
     cursors?: Cursors;
 }
-export interface Cursors {
+interface Cursors {
     /**
      * Cursor string pointing to the next page in the list of results.
      * @maxLength 16000
@@ -288,11 +288,11 @@ export interface Cursors {
      */
     prev?: string | null;
 }
-export interface QueryPublicPlansRequest {
+interface QueryPublicPlansRequest {
     /** Query options. */
     query?: QueryV2;
 }
-export interface QueryV2 {
+interface QueryV2 {
     /** A filter object. See supported fields and operators ([SDK](https://dev.wix.com/docs/sdk/backend-modules/pricing-plans/plans/query-public-plans) | [REST](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/plans/filter-and-sort#wix-pricing-plans_pricing-plans_plans_filter-and-sort_query-public-plans)). */
     filter?: Record<string, any> | null;
     /** Sort object in the form [{"fieldName":"sortField1"},{"fieldName":"sortField2","direction":"DESC"}]. */
@@ -300,7 +300,7 @@ export interface QueryV2 {
     /** Pointer to page of results using offset. Can't be used together with 'cursorPaging'. */
     paging?: Paging;
 }
-export interface Sorting {
+interface Sorting {
     /**
      * Name of the field to sort by.
      * @maxLength 512
@@ -309,36 +309,36 @@ export interface Sorting {
     /** Sort order. */
     order?: SortOrderWithLiterals;
 }
-export declare enum SortOrder {
+declare enum SortOrder {
     ASC = "ASC",
     DESC = "DESC"
 }
 /** @enumType */
-export type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
-export interface Paging {
+type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
+interface Paging {
     /** Number of items to load. */
     limit?: number | null;
     /** Number of items to skip in the current sort order. */
     offset?: number | null;
 }
-export interface QueryPublicPlansResponse {
+interface QueryPublicPlansResponse {
     /** List of public pricing plans that match the specified query. */
     plans?: PublicPlan[];
     /** Object containing paging-related data (such as the number of plans returned, the offset, and so on). */
     pagingMetadata?: PagingMetadataV2;
 }
-export interface GetPlanRequest {
+interface GetPlanRequest {
     /**
      * Plan ID.
      * @format GUID
      */
-    id: string;
+    _id: string;
 }
-export interface GetPlanResponse {
+interface GetPlanResponse {
     /** Pricing plan. */
     plan?: Plan;
 }
-export interface ListPlansRequest {
+interface ListPlansRequest {
     /** Archived filter. Defaults to `ACTIVE` (not archived) only. */
     archived?: ArchivedFilterWithLiterals;
     /** Visibility filter. Defaults to `PUBLIC_AND_HIDDEN` (meaning, both are listed). */
@@ -358,7 +358,7 @@ export interface ListPlansRequest {
      */
     planIds?: string[];
 }
-export declare enum ArchivedFilter {
+declare enum ArchivedFilter {
     /** Returns all plans that are active. */
     ACTIVE = "ACTIVE",
     /** Returns all plans that are archived. */
@@ -367,8 +367,8 @@ export declare enum ArchivedFilter {
     ARCHIVED_AND_ACTIVE = "ARCHIVED_AND_ACTIVE"
 }
 /** @enumType */
-export type ArchivedFilterWithLiterals = ArchivedFilter | 'ACTIVE' | 'ARCHIVED' | 'ARCHIVED_AND_ACTIVE';
-export declare enum PublicFilter {
+type ArchivedFilterWithLiterals = ArchivedFilter | 'ACTIVE' | 'ARCHIVED' | 'ARCHIVED_AND_ACTIVE';
+declare enum PublicFilter {
     /** Returns all public and hidden plans. */
     PUBLIC_AND_HIDDEN = "PUBLIC_AND_HIDDEN",
     /** Returns only public plans. */
@@ -377,83 +377,83 @@ export declare enum PublicFilter {
     HIDDEN = "HIDDEN"
 }
 /** @enumType */
-export type PublicFilterWithLiterals = PublicFilter | 'PUBLIC_AND_HIDDEN' | 'PUBLIC' | 'HIDDEN';
-export interface ListPlansResponse {
+type PublicFilterWithLiterals = PublicFilter | 'PUBLIC_AND_HIDDEN' | 'PUBLIC' | 'HIDDEN';
+interface ListPlansResponse {
     /** List of all public and hidden pricing plans. */
     plans?: Plan[];
     /** Object containing paging-related data (such as the number of plans returned, the offset, and so on). */
     pagingMetadata?: PagingMetadataV2;
 }
-export interface GetPlanStatsRequest {
+interface GetPlanStatsRequest {
 }
-export interface GetPlanStatsResponse {
+interface GetPlanStatsResponse {
     /** Total number of plans created, including active plans (both public and hidden) and archived plans. */
     totalPlans?: number;
 }
-export interface CreatePlanRequest {
+interface CreatePlanRequest {
     /** Plan details. */
     plan: Plan;
 }
-export interface CreatePlanResponse {
+interface CreatePlanResponse {
     /** Created plan. */
     plan?: Plan;
 }
-export interface UpdatePlanRequest {
+interface UpdatePlanRequest {
     /** ID of the plan to update. */
     plan: Plan;
 }
-export interface UpdatePlanResponse {
+interface UpdatePlanResponse {
     /** Updated plan. */
     plan?: Plan;
 }
-export interface BuyerCanCancelUpdated {
+interface BuyerCanCancelUpdated {
     /** Pricing plan. */
     plan?: Plan;
 }
-export interface SetPlanVisibilityRequest {
+interface SetPlanVisibilityRequest {
     /**
      * The ID of the plan to either display or hide on a site page.
      * @format GUID
      */
-    id: string;
+    _id: string;
     /** Whether a plan is visible to members and site visitors. Updates the `public` field. */
     visible: boolean;
 }
-export interface SetPlanVisibilityResponse {
+interface SetPlanVisibilityResponse {
     /** Pricing plan. */
     plan?: Plan;
 }
-export interface MakePlanPrimaryRequest {
+interface MakePlanPrimaryRequest {
     /**
      * Pricing plan ID.
      * @format GUID
      */
-    id: string;
+    _id: string;
 }
-export interface MakePlanPrimaryResponse {
+interface MakePlanPrimaryResponse {
     /** Pricing plan. */
     plan?: Plan;
 }
-export interface ClearPrimaryRequest {
+interface ClearPrimaryRequest {
 }
-export interface ClearPrimaryResponse {
+interface ClearPrimaryResponse {
 }
-export interface ArchivePlanRequest {
+interface ArchivePlanRequest {
     /**
      * ID of the active plan to archive.
      * @format GUID
      */
-    id: string;
+    _id: string;
 }
-export interface ArchivePlanResponse {
+interface ArchivePlanResponse {
     /** Archived plan. */
     plan?: Plan;
 }
-export interface PlanArchived {
+interface PlanArchived {
     /** Pricing plan. */
     plan?: Plan;
 }
-export interface BulkArchivePlanRequest {
+interface BulkArchivePlanRequest {
     /**
      * List of Plan IDs to archive.
      * @format GUID
@@ -464,21 +464,21 @@ export interface BulkArchivePlanRequest {
     /** Set to `true` to return the `Plan` entity in the response. */
     returnFullEntity?: boolean;
 }
-export interface BulkArchivePlanResponse {
+interface BulkArchivePlanResponse {
     /** Plans to be archived. */
     results?: BulkPlanResult[];
     /** Bulk action metadata. */
     bulkActionMetadata?: BulkActionMetadata;
 }
-export interface BulkPlanResult {
+interface BulkPlanResult {
     /** Item metadata. */
     itemMetadata?: ItemMetadata;
     /** Pricing plan. */
     plan?: Plan;
 }
-export interface ItemMetadata {
+interface ItemMetadata {
     /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
-    id?: string | null;
+    _id?: string | null;
     /** Index of the item within the request array. Allows for correlation between request and response items. */
     originalIndex?: number;
     /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
@@ -486,7 +486,7 @@ export interface ItemMetadata {
     /** Details about the error in case of failure. */
     error?: ApplicationError;
 }
-export interface ApplicationError {
+interface ApplicationError {
     /** Error code. */
     code?: string;
     /** Description of the error. */
@@ -494,7 +494,7 @@ export interface ApplicationError {
     /** Data related to the error. */
     data?: Record<string, any> | null;
 }
-export interface BulkActionMetadata {
+interface BulkActionMetadata {
     /** Number of items that were successfully processed. */
     totalSuccesses?: number;
     /** Number of items that couldn't be processed. */
@@ -502,7 +502,7 @@ export interface BulkActionMetadata {
     /** Number of failures without details because detailed failure threshold was exceeded. */
     undetailedFailures?: number;
 }
-export interface ArrangePlansRequest {
+interface ArrangePlansRequest {
     /**
      * IDs of all non-archived plans in the order you want them arranged.
      * @format GUID
@@ -510,27 +510,27 @@ export interface ArrangePlansRequest {
      */
     ids?: string[];
 }
-export interface ArrangePlansResponse {
+interface ArrangePlansResponse {
 }
-export interface CountPlansRequest {
+interface CountPlansRequest {
     /** The filter. */
     filter?: Record<string, any> | null;
     /** If true, counts only visible plans (visible and not archived). If no value is specified, all plans are counted. */
     visibility?: boolean | null;
 }
-export interface CountPlansResponse {
+interface CountPlansResponse {
     /** Number of plans in the response. */
     count?: number;
 }
-export interface GetPlansPremiumStatusRequest {
+interface GetPlansPremiumStatusRequest {
 }
-export interface GetPlansPremiumStatusResponse {
+interface GetPlansPremiumStatusResponse {
     /** True if a site has non-free, non-template plans. */
     hasPaidPlans?: boolean;
     /** True if a site has plans that were created before Pricing Plans became a premium app. */
     hasOldPlans?: boolean;
 }
-export interface SearchPlansRequest {
+interface SearchPlansRequest {
     /** Query options. */
     query?: QueryV2;
     /**
@@ -539,19 +539,19 @@ export interface SearchPlansRequest {
      */
     searchPhrase?: string | null;
 }
-export interface SearchPlansResponse {
+interface SearchPlansResponse {
     /** List of pricing plans that match the specified filter and search phrase. */
     plans?: Plan[];
     /** Object containing paging-related data (such as the number of plans returned, the offset, and so on). */
     pagingMetadata?: PagingMetadataV2;
 }
-export interface DomainEvent extends DomainEventBodyOneOf {
+interface DomainEvent extends DomainEventBodyOneOf {
     createdEvent?: EntityCreatedEvent;
     updatedEvent?: EntityUpdatedEvent;
     deletedEvent?: EntityDeletedEvent;
     actionEvent?: ActionEvent;
     /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
-    id?: string;
+    _id?: string;
     /**
      * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
      * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
@@ -580,36 +580,34 @@ export interface DomainEvent extends DomainEventBodyOneOf {
     entityEventSequence?: string | null;
 }
 /** @oneof */
-export interface DomainEventBodyOneOf {
+interface DomainEventBodyOneOf {
     createdEvent?: EntityCreatedEvent;
     updatedEvent?: EntityUpdatedEvent;
     deletedEvent?: EntityDeletedEvent;
     actionEvent?: ActionEvent;
 }
-export interface EntityCreatedEvent {
-    entityAsJson?: string;
-    /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
-    restoreInfo?: RestoreInfo;
+interface EntityCreatedEvent {
+    entity?: string;
 }
-export interface RestoreInfo {
+interface RestoreInfo {
     deletedDate?: Date | null;
 }
-export interface EntityUpdatedEvent {
+interface EntityUpdatedEvent {
     /**
      * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
      * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
      * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
      */
-    currentEntityAsJson?: string;
+    currentEntity?: string;
 }
-export interface EntityDeletedEvent {
+interface EntityDeletedEvent {
     /** Entity that was deleted. */
-    deletedEntityAsJson?: string | null;
+    deletedEntity?: string | null;
 }
-export interface ActionEvent {
-    bodyAsJson?: string;
+interface ActionEvent {
+    body?: string;
 }
-export interface MessageEnvelope {
+interface MessageEnvelope {
     /**
      * App instance ID.
      * @format GUID
@@ -625,7 +623,7 @@ export interface MessageEnvelope {
     /** Stringify payload. */
     data?: string;
 }
-export interface IdentificationData extends IdentificationDataIdOneOf {
+interface IdentificationData extends IdentificationDataIdOneOf {
     /**
      * ID of a site visitor that has not logged in to the site.
      * @format GUID
@@ -650,7 +648,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
     identityType?: WebhookIdentityTypeWithLiterals;
 }
 /** @oneof */
-export interface IdentificationDataIdOneOf {
+interface IdentificationDataIdOneOf {
     /**
      * ID of a site visitor that has not logged in to the site.
      * @format GUID
@@ -672,7 +670,7 @@ export interface IdentificationDataIdOneOf {
      */
     appId?: string;
 }
-export declare enum WebhookIdentityType {
+declare enum WebhookIdentityType {
     UNKNOWN = "UNKNOWN",
     ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
     MEMBER = "MEMBER",
@@ -680,4 +678,245 @@ export declare enum WebhookIdentityType {
     APP = "APP"
 }
 /** @enumType */
-export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
+type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
+interface BaseEventMetadata {
+    /**
+     * App instance ID.
+     * @format GUID
+     */
+    instanceId?: string | null;
+    /**
+     * Event type.
+     * @maxLength 150
+     */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+}
+interface EventMetadata extends BaseEventMetadata {
+    /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
+    _id?: string;
+    /**
+     * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
+     * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
+     */
+    entityFqdn?: string;
+    /**
+     * Event action name, placed at the top level to make it easier for users to dispatch messages.
+     * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
+     */
+    slug?: string;
+    /** ID of the entity associated with the event. */
+    entityId?: string;
+    /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
+    eventTime?: Date | null;
+    /**
+     * Whether the event was triggered as a result of a privacy regulation application
+     * (for example, GDPR).
+     */
+    triggeredByAnonymizeRequest?: boolean | null;
+    /** If present, indicates the action that triggered the event. */
+    originatedFrom?: string | null;
+    /**
+     * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
+     * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
+     */
+    entityEventSequence?: string | null;
+}
+interface PlanBuyerCanCancelUpdatedEnvelope {
+    data: BuyerCanCancelUpdated;
+    metadata: EventMetadata;
+}
+interface PlanCreatedEnvelope {
+    entity: Plan;
+    metadata: EventMetadata;
+}
+interface PlanArchivedEnvelope {
+    data: PlanArchived;
+    metadata: EventMetadata;
+}
+interface PlanUpdatedEnvelope {
+    entity: Plan;
+    metadata: EventMetadata;
+}
+interface ListPublicPlansOptions {
+    /**
+     * Number of items to list. Defaults to `75`. See limits ([SDK](https://dev.wix.com/docs/sdk/backend-modules/pricing-plans/plans/list-public-plans) | [REST](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#paging)).
+     * @min 1
+     * @max 100
+     */
+    limit?: number | null;
+    /** Number of items to skip. Defaults to `0`. See paging ([SDK](https://dev.wix.com/docs/sdk/backend-modules/pricing-plans/plans/list-public-plans) |[REST](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#paging)). */
+    offset?: number | null;
+    /**
+     * IDs of plans to list. Non-existent IDs are ignored and don't cause errors. You can specify a maximum of 100 IDs.
+     * @format GUID
+     * @maxSize 100
+     */
+    planIds?: string[];
+}
+interface QueryOffsetResult {
+    currentPage: number | undefined;
+    totalPages: number | undefined;
+    totalCount: number | undefined;
+    hasNext: () => boolean;
+    hasPrev: () => boolean;
+    length: number;
+    pageSize: number;
+}
+interface PlansQueryResult extends QueryOffsetResult {
+    items: PublicPlan[];
+    query: PlansQueryBuilder;
+    next: () => Promise<PlansQueryResult>;
+    prev: () => Promise<PlansQueryResult>;
+}
+interface PlansQueryBuilder {
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     */
+    eq: (propertyName: '_id' | 'primary' | '_createdDate' | '_updatedDate' | 'slug', value: any) => PlansQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     */
+    ne: (propertyName: '_id' | 'primary' | '_createdDate' | '_updatedDate' | 'slug', value: any) => PlansQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     */
+    ge: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'slug', value: any) => PlansQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     */
+    gt: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'slug', value: any) => PlansQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     */
+    le: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'slug', value: any) => PlansQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     */
+    lt: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'slug', value: any) => PlansQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `string`.
+     * @param string - String to compare against. Case-insensitive.
+     */
+    startsWith: (propertyName: '_id' | 'slug', value: string) => PlansQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `values`.
+     * @param values - List of values to compare against.
+     */
+    hasSome: (propertyName: '_id' | 'primary' | '_createdDate' | '_updatedDate' | 'slug', value: any[]) => PlansQueryBuilder;
+    in: (propertyName: '_id' | 'primary' | '_createdDate' | '_updatedDate' | 'slug', value: any) => PlansQueryBuilder;
+    exists: (propertyName: '_id' | 'primary' | '_createdDate' | '_updatedDate' | 'slug', value: boolean) => PlansQueryBuilder;
+    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
+    ascending: (...propertyNames: Array<'_id' | 'primary' | '_createdDate' | '_updatedDate' | 'slug'>) => PlansQueryBuilder;
+    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
+    descending: (...propertyNames: Array<'_id' | 'primary' | '_createdDate' | '_updatedDate' | 'slug'>) => PlansQueryBuilder;
+    /** @param limit - Number of items to return, which is also the `pageSize` of the results object. */
+    limit: (limit: number) => PlansQueryBuilder;
+    /** @param skip - Number of items to skip in the query results before returning the results. */
+    skip: (skip: number) => PlansQueryBuilder;
+    find: () => Promise<PlansQueryResult>;
+}
+interface ListPlansOptions {
+    /** Archived filter. Defaults to `ACTIVE` (not archived) only. */
+    archived?: ArchivedFilterWithLiterals;
+    /** Visibility filter. Defaults to `PUBLIC_AND_HIDDEN` (meaning, both are listed). */
+    public?: PublicFilterWithLiterals;
+    /**
+     * Number of pricing plans to list. Defaults to `75`.
+     * @min 1
+     * @max 100
+     */
+    limit?: number | null;
+    /** Number of pricing plans to skip. Defaults to `0`. */
+    offset?: number | null;
+    /**
+     * IDs of plans to list. If non-existent IDs are specified, they are ignored and don't cause errors. If no IDs are specified, all public and hidden plans are listed according to the order displayed in a site's dashboard (which you can set with Arrange Plans). You can specify a maximum of 100 IDs.
+     * @format GUID
+     * @maxSize 100
+     */
+    planIds?: string[];
+}
+interface UpdatePlan {
+    /**
+     * Plan ID.
+     * @format GUID
+     * @readonly
+     */
+    _id?: string;
+    /**
+     * Plan name.
+     * @minLength 1
+     * @maxLength 50
+     */
+    name?: string | null;
+    /**
+     * Plan description.
+     * @maxLength 450
+     */
+    description?: string | null;
+    /** List of text strings that promote what is included with this plan. For example, "Plenty of parking" or "Free gift on your birthday." */
+    perks?: StringList;
+    /** Plan price, payment schedule, and expiration. */
+    pricing?: Pricing;
+    /** Whether the plan is public (visible to site visitors and members). */
+    public?: boolean | null;
+    /**
+     * Whether the plan is archived. Archived plans are not visible and can't be purchased anymore, but existing purchases remain in effect.
+     * @readonly
+     */
+    archived?: boolean;
+    /**
+     * Whether the plan is marked as primary.
+     * @readonly
+     */
+    primary?: boolean;
+    /**
+     * Whether the plan has any orders (including pending and unpaid orders).
+     * @readonly
+     */
+    hasOrders?: boolean;
+    /**
+     * Date plan was created.
+     * @readonly
+     */
+    _createdDate?: Date | null;
+    /**
+     * Date plan was last updated.
+     * @readonly
+     */
+    _updatedDate?: Date | null;
+    /**
+     * URL-friendly version of plan name. Unique across all plans in the same site.
+     * @minLength 1
+     * @readonly
+     * @format URL_SLUG
+     */
+    slug?: string | null;
+    /**
+     * Number of times the same buyer can purchase the plan. Currently limited to support:
+     * - Empty value or a value of `0`, meaning no limitation.
+     * - Value of `1`, meaning limited to 1 purchase per buyer.
+     * @max 1
+     */
+    maxPurchasesPerBuyer?: number | null;
+    /** Whether the buyer can start the plan at a later date. Defaults to false. */
+    allowFutureStartDate?: boolean | null;
+    /**
+     * Whether the buyer is allowed to cancel their plan. Defaults to false.
+     * If false, calling Request Cancellation returns an error.
+     */
+    buyerCanCancel?: boolean | null;
+    /**
+     * Any terms and conditions that apply to the plan. This information is displayed during checkout.
+     * @maxLength 3000
+     */
+    termsAndConditions?: string | null;
+    /**
+     * ID of the form associated with the plan at checkout.
+     *
+     * Learn more about [forms](https://support.wix.com/en/article/wix-forms-an-overview).
+     * @format GUID
+     */
+    formId?: string | null;
+}
+
+export { type BulkArchivePlanRequest as $, type ArchivePlanResponse as A, type GetPlanResponse as B, type Cursors as C, type Duration as D, type ListPlansRequest as E, type FeeConfig as F, type GetPlanStatsResponse as G, type GetPlanStatsRequest as H, type CreatePlanRequest as I, type CreatePlanResponse as J, type UpdatePlanRequest as K, type ListPublicPlansOptions as L, type MakePlanPrimaryResponse as M, type UpdatePlanResponse as N, type BuyerCanCancelUpdated as O, type PlansQueryBuilder as P, type QueryPublicPlansRequest as Q, type Recurrence as R, type SetPlanVisibilityResponse as S, type SetPlanVisibilityRequest as T, type UpdatePlan as U, type MakePlanPrimaryRequest as V, WebhookIdentityType as W, type ClearPrimaryRequest as X, type ClearPrimaryResponse as Y, type ArchivePlanRequest as Z, type PlanArchived as _, type ListPublicPlansResponse as a, type BulkArchivePlanResponse as a0, type BulkPlanResult as a1, type ItemMetadata as a2, type ApplicationError as a3, type BulkActionMetadata as a4, type ArrangePlansRequest as a5, type ArrangePlansResponse as a6, type CountPlansRequest as a7, type CountPlansResponse as a8, type GetPlansPremiumStatusRequest as a9, type GetPlansPremiumStatusResponse as aa, type SearchPlansRequest as ab, type SearchPlansResponse as ac, type DomainEvent as ad, type DomainEventBodyOneOf as ae, type EntityCreatedEvent as af, type RestoreInfo as ag, type EntityUpdatedEvent as ah, type EntityDeletedEvent as ai, type ActionEvent as aj, type MessageEnvelope as ak, type IdentificationData as al, type IdentificationDataIdOneOf as am, type BaseEventMetadata as an, type EventMetadata as ao, type PlansQueryResult as ap, type Plan as b, type ListPlansOptions as c, type ListPlansResponse as d, type PlanBuyerCanCancelUpdatedEnvelope as e, type PlanCreatedEnvelope as f, type PlanArchivedEnvelope as g, type PlanUpdatedEnvelope as h, PeriodUnit as i, AppliedAt as j, SortOrder as k, ArchivedFilter as l, PublicFilter as m, type StringList as n, type Pricing as o, type PricingPricingModelOneOf as p, type Money as q, type Fee as r, type ListPublicPlansRequest as s, type PublicPlan as t, type PagingMetadataV2 as u, type QueryV2 as v, type Sorting as w, type Paging as x, type QueryPublicPlansResponse as y, type GetPlanRequest as z };