@wix/auto_sdk_pricing-plans_plans 1.0.2 → 1.0.4

package/build/cjs/src/pricing-plans-v2-plan-plans.types.d.ts

@@ -2,12 +2,20 @@
 export interface Plan {
     /**
      * Plan ID.
+     * @format GUID
      * @readonly
      */
     id?: string;
-    /** Plan name. */
+    /**
+     * Plan name.
+     * @minLength 1
+     * @maxLength 50
+     */
     name?: string | null;
-    /** Plan description. */
+    /**
+     * 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;
@@ -42,13 +50,16 @@ export interface Plan {
     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. */
@@ -58,17 +69,26 @@ export interface Plan {
      * 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. */
+    /**
+     * 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. */
 export interface StringList {
+    /**
+     * @minLength 1
+     * @maxLength 1400
+     * @maxSize 500
+     */
     values?: string[];
 }
 /** Plan pricing information. Includes the price of the plan and payment details. */
@@ -81,7 +101,10 @@ export interface Pricing extends PricingPricingModelOneOf {
     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. */
+    /**
+     * 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 */
@@ -104,12 +127,16 @@ export interface Recurrence {
      * 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. */
 export interface Duration {
-    /** Number of days, months, weeks, or years in a single payment cycle. Currently limited to support only `1`. */
+    /**
+     * 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?: PeriodUnit;
@@ -127,9 +154,15 @@ export declare enum PeriodUnit {
     YEAR = "YEAR"
 }
 export interface Money {
-    /** Monetary amount. Decimal string with a period as a decimal separator. For example, `'3.99'`. Can't be negative. */
+    /**
+     * 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'`. */
+    /**
+     * 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;
 }
 export interface FeeConfig {
@@ -139,9 +172,16 @@ export interface FeeConfig {
     appliedAt?: AppliedAt;
 }
 export interface Fee {
-    /** Fee name */
+    /**
+     * Fee name
+     * @minLength 1
+     * @maxLength 40
+     */
     name?: string;
-    /** Amount of fee to be charged */
+    /**
+     * Amount of fee to be charged
+     * @decimalValue options { lt:1000000000000, gt:0.000, maxScale:3 }
+     */
     amount?: string;
 }
 export declare enum AppliedAt {
@@ -150,11 +190,19 @@ export declare enum AppliedAt {
     FIRST_PAYMENT = "FIRST_PAYMENT"
 }
 export 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)). */
+    /**
+     * 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. */
+    /**
+     * 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[];
 }
 export interface ListPublicPlansResponse {
@@ -165,11 +213,21 @@ export interface ListPublicPlansResponse {
 }
 /** Public plan entity containing information about the pricing plan. Can be read by any site member or visitor. */
 export interface PublicPlan {
-    /** Plan ID. */
+    /**
+     * Plan ID.
+     * @format GUID
+     */
     id?: string;
-    /** Plan name. */
+    /**
+     * Plan name.
+     * @minLength 1
+     * @maxLength 50
+     */
     name?: string | null;
-    /** Plan description. */
+    /**
+     * Plan description.
+     * @maxLength 450
+     */
     description?: string | null;
     /** What is included with this plan (for example, 1 weekly entrance to a specific class). */
     perks?: StringList;
@@ -181,7 +239,10 @@ export interface PublicPlan {
     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. */
+    /**
+     * 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;
@@ -195,6 +256,7 @@ export interface PublicPlan {
      * 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;
 }
@@ -211,9 +273,15 @@ export interface PagingMetadataV2 {
     cursors?: Cursors;
 }
 export interface Cursors {
-    /** Cursor string pointing to the next page in the list of results. */
+    /**
+     * 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. */
+    /**
+     * Cursor pointing to the previous page in the list of results.
+     * @maxLength 16000
+     */
     prev?: string | null;
 }
 export interface QueryPublicPlansRequest {
@@ -229,7 +297,10 @@ export interface QueryV2 {
     paging?: Paging;
 }
 export interface Sorting {
-    /** Name of the field to sort by. */
+    /**
+     * Name of the field to sort by.
+     * @maxLength 512
+     */
     fieldName?: string;
     /** Sort order. */
     order?: SortOrder;
@@ -251,7 +322,10 @@ export interface QueryPublicPlansResponse {
     pagingMetadata?: PagingMetadataV2;
 }
 export interface GetPlanRequest {
-    /** Plan ID. */
+    /**
+     * Plan ID.
+     * @format GUID
+     */
     id: string;
 }
 export interface GetPlanResponse {
@@ -263,11 +337,19 @@ export interface ListPlansRequest {
     archived?: ArchivedFilter;
     /** Visibility filter. Defaults to `PUBLIC_AND_HIDDEN` (meaning, both are listed). */
     public?: PublicFilter;
-    /** Number of pricing plans to list. Defaults to `75`. */
+    /**
+     * 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. */
+    /**
+     * 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[];
 }
 export declare enum ArchivedFilter {
@@ -319,7 +401,10 @@ export interface BuyerCanCancelUpdated {
     plan?: Plan;
 }
 export interface SetPlanVisibilityRequest {
-    /** The ID of the plan to either display or hide on a site page. */
+    /**
+     * 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;
@@ -329,7 +414,10 @@ export interface SetPlanVisibilityResponse {
     plan?: Plan;
 }
 export interface MakePlanPrimaryRequest {
-    /** Pricing plan ID. */
+    /**
+     * Pricing plan ID.
+     * @format GUID
+     */
     id: string;
 }
 export interface MakePlanPrimaryResponse {
@@ -341,7 +429,10 @@ export interface ClearPrimaryRequest {
 export interface ClearPrimaryResponse {
 }
 export interface ArchivePlanRequest {
-    /** ID of the active plan to archive. */
+    /**
+     * ID of the active plan to archive.
+     * @format GUID
+     */
     id: string;
 }
 export interface ArchivePlanResponse {
@@ -353,7 +444,12 @@ export interface PlanArchived {
     plan?: Plan;
 }
 export interface BulkArchivePlanRequest {
-    /** List of Plan IDs to archive. */
+    /**
+     * 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;
@@ -397,7 +493,11 @@ export interface BulkActionMetadata {
     undetailedFailures?: number;
 }
 export interface ArrangePlansRequest {
-    /** IDs of all non-archived plans in the order you want them arranged. */
+    /**
+     * IDs of all non-archived plans in the order you want them arranged.
+     * @format GUID
+     * @minSize 1
+     */
     ids?: string[];
 }
 export interface ArrangePlansResponse {
@@ -423,7 +523,10 @@ export interface GetPlansPremiumStatusResponse {
 export interface SearchPlansRequest {
     /** Query options. */
     query?: QueryV2;
-    /** Search phrase for the plan name. */
+    /**
+     * Search phrase for the plan name.
+     * @maxLength 50
+     */
     searchPhrase?: string | null;
 }
 export interface SearchPlansResponse {
@@ -505,9 +608,15 @@ export interface ActionEvent {
     bodyAsJson?: string;
 }
 export interface MessageEnvelope {
-    /** App instance ID. */
+    /**
+     * App instance ID.
+     * @format GUID
+     */
     instanceId?: string | null;
-    /** Event type. */
+    /**
+     * Event type.
+     * @maxLength 150
+     */
     eventType?: string;
     /** The identification type and identity data. */
     identity?: IdentificationData;
@@ -515,26 +624,50 @@ export interface MessageEnvelope {
     data?: string;
 }
 export interface IdentificationData extends IdentificationDataIdOneOf {
-    /** ID of a site visitor that has not logged in to the site. */
+    /**
+     * 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. */
+    /**
+     * 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.). */
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
     wixUserId?: string;
-    /** ID of an app. */
+    /**
+     * ID of an app.
+     * @format GUID
+     */
     appId?: string;
     /** @readonly */
     identityType?: WebhookIdentityType;
 }
 /** @oneof */
 export interface IdentificationDataIdOneOf {
-    /** ID of a site visitor that has not logged in to the site. */
+    /**
+     * 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. */
+    /**
+     * 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.). */
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
     wixUserId?: string;
-    /** ID of an app. */
+    /**
+     * ID of an app.
+     * @format GUID
+     */
     appId?: string;
 }
 export declare enum WebhookIdentityType {

package/build/cjs/src/pricing-plans-v2-plan-plans.types.js.map

@@ -1 +1 @@
-{"version":3,"file":"pricing-plans-v2-plan-plans.types.js","sourceRoot":"","sources":["../../../src/pricing-plans-v2-plan-plans.types.ts"],"names":[],"mappings":";;;AA0HA,IAAY,UAWX;AAXD,WAAY,UAAU;IACpB,mBAAmB;IACnB,qCAAuB,CAAA;IACvB,0BAA0B;IAC1B,yBAAW,CAAA;IACX,2BAA2B;IAC3B,2BAAa,CAAA;IACb,4BAA4B;IAC5B,6BAAe,CAAA;IACf,2BAA2B;IAC3B,2BAAa,CAAA;AACf,CAAC,EAXW,UAAU,0BAAV,UAAU,QAWrB;AAuBD,IAAY,SAIX;AAJD,WAAY,SAAS;IACnB,0DAA6C,CAAA;IAC7C,oHAAoH;IACpH,4CAA+B,CAAA;AACjC,CAAC,EAJW,SAAS,yBAAT,SAAS,QAIpB;AA+FD,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,yBAAT,SAAS,QAGpB;AAuCD,IAAY,cAOX;AAPD,WAAY,cAAc;IACxB,yCAAyC;IACzC,mCAAiB,CAAA;IACjB,2CAA2C;IAC3C,uCAAqB,CAAA;IACrB,sDAAsD;IACtD,6DAA2C,CAAA;AAC7C,CAAC,EAPW,cAAc,8BAAd,cAAc,QAOzB;AAED,IAAY,YAOX;AAPD,WAAY,YAAY;IACtB,2CAA2C;IAC3C,uDAAuC,CAAA;IACvC,iCAAiC;IACjC,iCAAiB,CAAA;IACjB,iCAAiC;IACjC,iCAAiB,CAAA;AACnB,CAAC,EAPW,YAAY,4BAAZ,YAAY,QAOvB;AAiSD,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,mCAAnB,mBAAmB,QAM9B"}
+{"version":3,"file":"pricing-plans-v2-plan-plans.types.js","sourceRoot":"","sources":["../../../src/pricing-plans-v2-plan-plans.types.ts"],"names":[],"mappings":";;;AAqJA,IAAY,UAWX;AAXD,WAAY,UAAU;IACpB,mBAAmB;IACnB,qCAAuB,CAAA;IACvB,0BAA0B;IAC1B,yBAAW,CAAA;IACX,2BAA2B;IAC3B,2BAAa,CAAA;IACb,4BAA4B;IAC5B,6BAAe,CAAA;IACf,2BAA2B;IAC3B,2BAAa,CAAA;AACf,CAAC,EAXW,UAAU,0BAAV,UAAU,QAWrB;AAoCD,IAAY,SAIX;AAJD,WAAY,SAAS;IACnB,0DAA6C,CAAA;IAC7C,oHAAoH;IACpH,4CAA+B,CAAA;AACjC,CAAC,EAJW,SAAS,yBAAT,SAAS,QAIpB;AA8HD,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,yBAAT,SAAS,QAGpB;AAkDD,IAAY,cAOX;AAPD,WAAY,cAAc;IACxB,yCAAyC;IACzC,mCAAiB,CAAA;IACjB,2CAA2C;IAC3C,uCAAqB,CAAA;IACrB,sDAAsD;IACtD,6DAA2C,CAAA;AAC7C,CAAC,EAPW,cAAc,8BAAd,cAAc,QAOzB;AAED,IAAY,YAOX;AAPD,WAAY,YAAY;IACtB,2CAA2C;IAC3C,uDAAuC,CAAA;IACvC,iCAAiC;IACjC,iCAAiB,CAAA;IACjB,iCAAiC;IACjC,iCAAiB,CAAA;AACnB,CAAC,EAPW,YAAY,4BAAZ,YAAY,QAOvB;AAoVD,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,mCAAnB,mBAAmB,QAM9B"}