@wix/auto_sdk_pricing-plans_plans 1.0.58 → 1.0.60

package/build/{cjs/src/pricing-plans-v2-plan-plans.types.d.ts → meta.d.ts}

@@ -1,5 +1,7 @@
+import { s as ListPublicPlansRequest$1, a as ListPublicPlansResponse$1, Q as QueryPublicPlansRequest$1, y as QueryPublicPlansResponse$1, z as GetPlanRequest$1, B as GetPlanResponse$1, E as ListPlansRequest$1, d as ListPlansResponse$1, H as GetPlanStatsRequest$1, G as GetPlanStatsResponse$1, I as CreatePlanRequest$1, J as CreatePlanResponse$1, K as UpdatePlanRequest$1, N as UpdatePlanResponse$1, T as SetPlanVisibilityRequest$1, S as SetPlanVisibilityResponse$1, V as MakePlanPrimaryRequest$1, M as MakePlanPrimaryResponse$1, X as ClearPrimaryRequest$1, Y as ClearPrimaryResponse$1, Z as ArchivePlanRequest$1, A as ArchivePlanResponse$1 } from './pricing-plans-v2-plan-plans.universal-DwvmTikd.js';
+
 /** Information about the pricing plan. */
-export interface Plan {
+interface Plan {
     /**
      * Plan ID.
      * @format GUID
@@ -83,7 +85,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 +94,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 +110,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 +119,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 +134,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 +143,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 +156,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,33 +169,7 @@ export interface Money {
      */
     currency?: string;
 }
-export interface FeeConfig {
-    /** Fee configuration. */
-    fee?: Fee;
-    /** The time this fee will be charged. */
-    appliedAt?: AppliedAtWithLiterals;
-}
-export interface Fee {
-    /**
-     * Fee name
-     * @minLength 1
-     * @maxLength 40
-     */
-    name?: string;
-    /**
-     * Amount of fee to be charged
-     * @decimalValue options { lt:1000000000000, gt:0.000, maxScale:3 }
-     */
-    amount?: string;
-}
-export 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 {
+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,14 +185,14 @@ 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
@@ -264,7 +240,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 +252,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 +264,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 +276,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 +285,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;
 }
-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 +334,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 +343,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,40 +353,36 @@ 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 {
-    /** 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
@@ -419,265 +391,67 @@ export interface SetPlanVisibilityRequest {
     /** 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;
 }
-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;
 }
-export interface ArchivePlanResponse {
+interface ArchivePlanResponse {
     /** Archived plan. */
     plan?: Plan;
 }
-export interface PlanArchived {
-    /** Pricing plan. */
-    plan?: Plan;
-}
-export interface BulkArchivePlanRequest {
-    /**
-     * List of Plan IDs to archive.
-     * @format GUID
-     * @minSize 1
-     * @maxSize 100
-     */
-    ids?: string[];
-    /** Set to `true` to return the `Plan` entity in the response. */
-    returnFullEntity?: boolean;
-}
-export interface BulkArchivePlanResponse {
-    /** Plans to be archived. */
-    results?: BulkPlanResult[];
-    /** Bulk action metadata. */
-    bulkActionMetadata?: BulkActionMetadata;
-}
-export interface BulkPlanResult {
-    /** Item metadata. */
-    itemMetadata?: ItemMetadata;
-    /** Pricing plan. */
-    plan?: Plan;
-}
-export interface ItemMetadata {
-    /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
-    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. */
-    success?: boolean;
-    /** Details about the error in case of failure. */
-    error?: ApplicationError;
-}
-export interface ApplicationError {
-    /** Error code. */
-    code?: string;
-    /** Description of the error. */
-    description?: string;
-    /** Data related to the error. */
-    data?: Record<string, any> | null;
-}
-export interface BulkActionMetadata {
-    /** Number of items that were successfully processed. */
-    totalSuccesses?: number;
-    /** Number of items that couldn't be processed. */
-    totalFailures?: number;
-    /** Number of failures without details because detailed failure threshold was exceeded. */
-    undetailedFailures?: number;
-}
-export interface ArrangePlansRequest {
-    /**
-     * IDs of all non-archived plans in the order you want them arranged.
-     * @format GUID
-     * @minSize 1
-     */
-    ids?: string[];
-}
-export interface ArrangePlansResponse {
-}
-export 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 {
-    /** Number of plans in the response. */
-    count?: number;
-}
-export interface GetPlansPremiumStatusRequest {
-}
-export 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 {
-    /** Query options. */
-    query?: QueryV2;
-    /**
-     * Search phrase for the plan name.
-     * @maxLength 50
-     */
-    searchPhrase?: string | null;
-}
-export 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 {
-    createdEvent?: EntityCreatedEvent;
-    updatedEvent?: EntityUpdatedEvent;
-    deletedEvent?: EntityDeletedEvent;
-    actionEvent?: ActionEvent;
-    /** 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;
-}
-/** @oneof */
-export 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;
-}
-export interface RestoreInfo {
-    deletedDate?: Date | null;
-}
-export 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;
-}
-export interface EntityDeletedEvent {
-    /** Entity that was deleted. */
-    deletedEntityAsJson?: string | null;
-}
-export interface ActionEvent {
-    bodyAsJson?: string;
-}
-export interface MessageEnvelope {
-    /**
-     * App instance ID.
-     * @format GUID
-     */
-    instanceId?: string | null;
-    /**
-     * Event type.
-     * @maxLength 150
-     */
-    eventType?: string;
-    /** The identification type and identity data. */
-    identity?: IdentificationData;
-    /** Stringify payload. */
-    data?: string;
-}
-export interface IdentificationData extends IdentificationDataIdOneOf {
-    /**
-     * ID of a site visitor that has not logged in to the site.
-     * @format GUID
-     */
-    anonymousVisitorId?: string;
-    /**
-     * ID of a site visitor that has logged in to the site.
-     * @format GUID
-     */
-    memberId?: string;
-    /**
-     * ID of a Wix user (site owner, contributor, etc.).
-     * @format GUID
-     */
-    wixUserId?: string;
-    /**
-     * ID of an app.
-     * @format GUID
-     */
-    appId?: string;
-    /** @readonly */
-    identityType?: WebhookIdentityTypeWithLiterals;
-}
-/** @oneof */
-export interface IdentificationDataIdOneOf {
-    /**
-     * ID of a site visitor that has not logged in to the site.
-     * @format GUID
-     */
-    anonymousVisitorId?: string;
-    /**
-     * ID of a site visitor that has logged in to the site.
-     * @format GUID
-     */
-    memberId?: string;
-    /**
-     * ID of a Wix user (site owner, contributor, etc.).
-     * @format GUID
-     */
-    wixUserId?: string;
-    /**
-     * ID of an app.
-     * @format GUID
-     */
-    appId?: string;
-}
-export declare enum WebhookIdentityType {
-    UNKNOWN = "UNKNOWN",
-    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
-    MEMBER = "MEMBER",
-    WIX_USER = "WIX_USER",
-    APP = "APP"
-}
-/** @enumType */
-export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
+
+type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
+    getUrl: (context: any) => string;
+    httpMethod: K;
+    path: string;
+    pathParams: M;
+    __requestType: T;
+    __originalRequestType: S;
+    __responseType: Q;
+    __originalResponseType: R;
+};
+declare function listPublicPlans(): __PublicMethodMetaInfo<'GET', {}, ListPublicPlansRequest$1, ListPublicPlansRequest, ListPublicPlansResponse$1, ListPublicPlansResponse>;
+declare function queryPublicPlans(): __PublicMethodMetaInfo<'POST', {}, QueryPublicPlansRequest$1, QueryPublicPlansRequest, QueryPublicPlansResponse$1, QueryPublicPlansResponse>;
+declare function getPlan(): __PublicMethodMetaInfo<'GET', {
+    id: string;
+}, GetPlanRequest$1, GetPlanRequest, GetPlanResponse$1, GetPlanResponse>;
+declare function listPlans(): __PublicMethodMetaInfo<'GET', {}, ListPlansRequest$1, ListPlansRequest, ListPlansResponse$1, ListPlansResponse>;
+declare function getPlanStats(): __PublicMethodMetaInfo<'GET', {}, GetPlanStatsRequest$1, GetPlanStatsRequest, GetPlanStatsResponse$1, GetPlanStatsResponse>;
+declare function createPlan(): __PublicMethodMetaInfo<'POST', {}, CreatePlanRequest$1, CreatePlanRequest, CreatePlanResponse$1, CreatePlanResponse>;
+declare function updatePlan(): __PublicMethodMetaInfo<'PATCH', {
+    planId: string;
+}, UpdatePlanRequest$1, UpdatePlanRequest, UpdatePlanResponse$1, UpdatePlanResponse>;
+declare function setPlanVisibility(): __PublicMethodMetaInfo<'PUT', {
+    id: string;
+}, SetPlanVisibilityRequest$1, SetPlanVisibilityRequest, SetPlanVisibilityResponse$1, SetPlanVisibilityResponse>;
+declare function makePlanPrimary(): __PublicMethodMetaInfo<'POST', {
+    id: string;
+}, MakePlanPrimaryRequest$1, MakePlanPrimaryRequest, MakePlanPrimaryResponse$1, MakePlanPrimaryResponse>;
+declare function clearPrimary(): __PublicMethodMetaInfo<'POST', {}, ClearPrimaryRequest$1, ClearPrimaryRequest, ClearPrimaryResponse$1, ClearPrimaryResponse>;
+declare function archivePlan(): __PublicMethodMetaInfo<'POST', {
+    id: string;
+}, ArchivePlanRequest$1, ArchivePlanRequest, ArchivePlanResponse$1, ArchivePlanResponse>;
+
+export { type __PublicMethodMetaInfo, archivePlan, clearPrimary, createPlan, getPlan, getPlanStats, listPlans, listPublicPlans, makePlanPrimary, queryPublicPlans, setPlanVisibility, updatePlan };