@wix/auto_sdk_pricing-plans_plans 1.0.59 → 1.0.60

package/build/meta.d.ts

@@ -0,0 +1,457 @@
+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. */
+interface Plan {
+    /**
+     * 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;
+}
+/** This wrapper type exists to distinguish an empty string list from no list at all in update requests. */
+interface StringList {
+    /**
+     * @minLength 1
+     * @maxLength 1400
+     * @maxSize 500
+     */
+    values?: string[];
+}
+/** Plan pricing information. Includes the price of the plan and payment details. */
+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. */
+    singlePaymentForDuration?: Duration;
+    /** Pricing model indicating the plan is paid in a single payment. The plan is valid until canceled. */
+    singlePaymentUnlimited?: boolean | null;
+    /** Amount for a single payment. For subscriptions, this is the amount to pay each payment cycle and it is required. For plans that are not recurring plans, it is the single payment amount for the whole subscription. */
+    price?: Money;
+    /**
+     * Free trial period for the plan in days. Available only for recurring plans, meaning plans whose pricing model is `subscription`. Set to `0` to remove the free trial.
+     * @max 999
+     */
+    freeTrialDays?: number | null;
+}
+/** @oneof */
+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. */
+    singlePaymentForDuration?: Duration;
+    /** Pricing model indicating the plan is paid in a single payment. The plan is valid until canceled. */
+    singlePaymentUnlimited?: boolean | null;
+}
+/** An object specifying how often and for how long payments recur (may be forever). */
+interface Recurrence {
+    /**
+     * Number of payment cycles the subscription is valid for.
+     * `0` for unlimited plans or for plans that are valid until canceled.
+     */
+    cycleDuration?: Duration;
+    /**
+     * Length of a payment cycle. For example, 1 month to have monthly payments.
+     * Multiply `cycleDuration`'s `count` by `cycleCount` to get the subscription duration.
+     * Currently, only a value of `1` is supported.
+     * @max 2000
+     */
+    cycleCount?: number | null;
+}
+/** A duration expressed in number of time units. */
+interface Duration {
+    /**
+     * Number of days, months, weeks, or years in a single payment cycle. Currently limited to support only `1`.
+     * @min 1
+     */
+    count?: number | null;
+    /** Unit of time for the cycle duration. */
+    unit?: PeriodUnitWithLiterals;
+}
+declare enum PeriodUnit {
+    /** Not defined. */
+    UNDEFINED = "UNDEFINED",
+    /** Time unit is a day. */
+    DAY = "DAY",
+    /** Time unit is a week. */
+    WEEK = "WEEK",
+    /** Time unit is a month. */
+    MONTH = "MONTH",
+    /** Time unit is a year. */
+    YEAR = "YEAR"
+}
+/** @enumType */
+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 }
+     */
+    value?: string;
+    /**
+     * Currency code. Three-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format. For example, `'USD'`.
+     * @format CURRENCY
+     */
+    currency?: string;
+}
+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
+     * @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 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. */
+interface PublicPlan {
+    /**
+     * Plan ID.
+     * @format GUID
+     */
+    id?: string;
+    /**
+     * Plan name.
+     * @minLength 1
+     * @maxLength 50
+     */
+    name?: string | null;
+    /**
+     * Plan description.
+     * @maxLength 450
+     */
+    description?: string | null;
+    /** What is included with this plan (for example, 1 weekly entrance to a specific class). */
+    perks?: StringList;
+    /** Plan price, payment schedule, and expiration. */
+    pricing?: Pricing;
+    /** Whether the plan is marked as primary. */
+    primary?: boolean;
+    /** Date plan was created. */
+    createdDate?: Date | null;
+    /** Date plan was last updated. */
+    updatedDate?: Date | null;
+    /**
+     * URL-friendly version of plan name. Unique across all plans in the same site.
+     * @minLength 1
+     */
+    slug?: string | null;
+    /** Number of times the same buyer can purchase the plan. An empty value or a value of 0 means no limitation. */
+    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. */
+    buyerCanCancel?: boolean | null;
+    /** Any terms and conditions that apply to the plan. This information is displayed during checkout. */
+    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;
+}
+interface PagingMetadataV2 {
+    /** Number of items returned in the response. */
+    count?: number | null;
+    /** Offset that was requested. */
+    offset?: number | null;
+    /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
+    total?: number | null;
+    /** Flag that indicates the server failed to calculate the `total` field. */
+    tooManyToCount?: boolean | null;
+    /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
+    cursors?: Cursors;
+}
+interface Cursors {
+    /**
+     * Cursor string pointing to the next page in the list of results.
+     * @maxLength 16000
+     */
+    next?: string | null;
+    /**
+     * Cursor pointing to the previous page in the list of results.
+     * @maxLength 16000
+     */
+    prev?: string | null;
+}
+interface QueryPublicPlansRequest {
+    /** Query options. */
+    query?: 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"}]. */
+    sort?: Sorting[];
+    /** Pointer to page of results using offset. Can't be used together with 'cursorPaging'. */
+    paging?: Paging;
+}
+interface Sorting {
+    /**
+     * Name of the field to sort by.
+     * @maxLength 512
+     */
+    fieldName?: string;
+    /** Sort order. */
+    order?: SortOrderWithLiterals;
+}
+declare enum SortOrder {
+    ASC = "ASC",
+    DESC = "DESC"
+}
+/** @enumType */
+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;
+}
+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;
+}
+interface GetPlanRequest {
+    /**
+     * Plan ID.
+     * @format GUID
+     */
+    id: string;
+}
+interface GetPlanResponse {
+    /** Pricing plan. */
+    plan?: Plan;
+}
+interface ListPlansRequest {
+    /** 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[];
+}
+declare enum ArchivedFilter {
+    /** Returns all plans that are active. */
+    ACTIVE = "ACTIVE",
+    /** Returns all plans that are archived. */
+    ARCHIVED = "ARCHIVED",
+    /** Returns all plans that are active and archived. */
+    ARCHIVED_AND_ACTIVE = "ARCHIVED_AND_ACTIVE"
+}
+/** @enumType */
+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. */
+    PUBLIC = "PUBLIC",
+    /** Returns only hidden plans. */
+    HIDDEN = "HIDDEN"
+}
+/** @enumType */
+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;
+}
+interface GetPlanStatsRequest {
+}
+interface GetPlanStatsResponse {
+    /** Total number of plans created, including active plans (both public and hidden) and archived plans. */
+    totalPlans?: number;
+}
+interface CreatePlanRequest {
+    /** Plan details. */
+    plan: Plan;
+}
+interface CreatePlanResponse {
+    /** Created plan. */
+    plan?: Plan;
+}
+interface UpdatePlanRequest {
+    /** ID of the plan to update. */
+    plan: Plan;
+}
+interface UpdatePlanResponse {
+    /** Updated plan. */
+    plan?: Plan;
+}
+interface SetPlanVisibilityRequest {
+    /**
+     * The ID of the plan to either display or hide on a site page.
+     * @format GUID
+     */
+    id: string;
+    /** Whether a plan is visible to members and site visitors. Updates the `public` field. */
+    visible: boolean;
+}
+interface SetPlanVisibilityResponse {
+    /** Pricing plan. */
+    plan?: Plan;
+}
+interface MakePlanPrimaryRequest {
+    /**
+     * Pricing plan ID.
+     * @format GUID
+     */
+    id: string;
+}
+interface MakePlanPrimaryResponse {
+    /** Pricing plan. */
+    plan?: Plan;
+}
+interface ClearPrimaryRequest {
+}
+interface ClearPrimaryResponse {
+}
+interface ArchivePlanRequest {
+    /**
+     * ID of the active plan to archive.
+     * @format GUID
+     */
+    id: string;
+}
+interface ArchivePlanResponse {
+    /** Archived plan. */
+    plan?: Plan;
+}
+
+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 };