@wix/auto_sdk_app-management_app-plans 1.0.0 → 1.0.2

package/build/internal/cjs/src/appmarket-v1-app-plans-app-plans.universal.d.ts

@@ -6,6 +6,7 @@ export interface AppPlans {
      *
      * Min: `0` plans
      * Max: `50` plans
+     * @maxSize 50
      */
     plans?: Plan[];
 }
@@ -33,6 +34,7 @@ export declare enum SourceType {
     APP_BENEFIT = "APP_BENEFIT"
 }
 export interface SaleSource {
+    /** @format GUID */
     saleId?: string | null;
     saleType?: SaleType;
     startDate?: Date | null;
@@ -78,6 +80,9 @@ export interface UsageBasedDetails {
      *
      * Min: `0.00`
      * Max: 1024 characters
+     * @format DECIMAL_VALUE
+     * @decimalValue options { gte:0.00 }
+     * @maxLength 1024
      */
     minimumChargeIncrement?: string | null;
     /**
@@ -86,6 +91,9 @@ export interface UsageBasedDetails {
      *
      * Min: `0.00`
      * Max: 1024 characters
+     * @format DECIMAL_VALUE
+     * @decimalValue options { gte:0.00 }
+     * @maxLength 1024
      */
     monthlyBaseFee?: string | null;
     /**
@@ -97,7 +105,12 @@ export interface UsageBasedDetails {
 }
 export interface Discount extends DiscountSourceDataOneOf {
     type?: DiscountType;
-    /** Discount amount */
+    /**
+     * Discount amount
+     * @format DECIMAL_VALUE
+     * @decimalValue options { gte:0.00, maxScale:2 }
+     * @maxLength 1024
+     */
     amount?: string;
     /**
      * Price without taxes. For yearly plans, Wix calculates and returns the
@@ -105,12 +118,18 @@ export interface Discount extends DiscountSourceDataOneOf {
      * returned price with 12.
      * Min: `0.00`
      * Max: 1024 characters
+     * @format DECIMAL_VALUE
+     * @decimalValue options { gte:0.00, maxScale:2 }
+     * @maxLength 1024
      */
     priceBeforeTax?: string;
     /**
      * Total price including taxes.
      * Min: `0.00`
      * Max: 1024 characters
+     * @format DECIMAL_VALUE
+     * @decimalValue options { gte:0.00, maxScale:2 }
+     * @maxLength 1024
      */
     totalPrice?: string;
     /**
@@ -137,6 +156,9 @@ export interface Price {
      *
      * Min: `0.00`
      * Max: 1024 characters
+     * @format DECIMAL_VALUE
+     * @decimalValue options { gte:0.00 }
+     * @maxLength 1024
      */
     priceBeforeTax?: string;
     /**
@@ -144,6 +166,9 @@ export interface Price {
      *
      * Min: `0.00`
      * Max: 1024 characters
+     * @format DECIMAL_VALUE
+     * @decimalValue options { gte:0.00 }
+     * @maxLength 1024
      */
     totalPrice?: string;
     /** Information about the plan's recurring billing cycle or single payment. */
@@ -156,12 +181,16 @@ export interface Price {
     usageBaseOptions?: UsageBasedDetails;
     discount?: Discount;
     billingSource?: BillingSource;
-    /** Can be shown instead of plan price - used for dynamic plans */
+    /**
+     * Can be shown instead of plan price - used for dynamic plans
+     * @maxLength 140
+     */
     customPaymentTitle?: string | null;
 }
 export interface Plan {
     /**
      * ID of the app plan.
+     * @format GUID
      * @readonly
      */
     _id?: string;
@@ -180,6 +209,8 @@ export interface Plan {
      * Min: `0` benefits
      * Max: `4` benefits
      * Max per benefit: 1024 characters
+     * @maxSize 4
+     * @maxLength 1024
      */
     benefits?: string[];
     /**
@@ -188,6 +219,7 @@ export interface Plan {
      *
      * Min: `0` prices
      * Max: `10` prices
+     * @maxSize 10
      */
     prices?: Price[];
 }
@@ -197,6 +229,8 @@ export interface ListAppPlansByAppIdRequest {
      *
      * Min: 1 app ID
      * Max: 100 app IDs
+     * @minSize 1
+     * @maxSize 100
      */
     appIds: string[];
 }
@@ -214,6 +248,7 @@ export interface ListAppPlansByAppIdResponse {
      * you pass in the call's header. If you don't pass a country code in the header,
      * Wix calculates the currency based on the caller's IP address. Note that the
      * currency may not resolve properly if you call through a VPN.
+     * @format CURRENCY
      */
     currency?: string;
     /**
@@ -232,6 +267,7 @@ export interface ListAppPlansByAppIdResponse {
      * Max: 50 plans
      *
      * If any plans aren't returned, it's likely because they haven't been activated yet.
+     * @maxSize 50
      */
     appPlans?: AppPlans[];
 }
@@ -244,6 +280,7 @@ export interface TaxSettings {
     /**
      * Tax rate for the given country as percentage. Returned as `0` when
      * `{"showPriceWithTax": false}`.
+     * @format DECIMAL_VALUE
      */
     percentage?: string | null;
     /**
@@ -261,7 +298,10 @@ export declare enum TaxType {
     GST = "GST"
 }
 export interface GetAvailableAppPlansRequest {
-    /** AppId to get the available app plans for. */
+    /**
+     * AppId to get the available app plans for.
+     * @format GUID
+     */
     appId?: string;
     /** The specific app plan info to retrieve the available app plans for. */
     appPlanInfo?: AppPlanInfo;
@@ -275,6 +315,7 @@ export interface AppPlanInfo {
      * The app plan's vendorId to retrieve the response for.
      *
      * Max: 100 characters
+     * @maxLength 100
      */
     vendorId?: string;
     /** The app plan cycle to retrieve the response for. */
@@ -289,13 +330,19 @@ export interface GetAvailableAppPlansResponse {
     currentPlan?: Plan;
 }
 export interface GetPricingPageUrlRequest {
-    /** AppId to get the pricing page url for. */
+    /**
+     * AppId to get the pricing page url for.
+     * @format GUID
+     */
     appId?: string;
     /** The specific app plan to retrieve the pricing page url for. */
     appPlanInfo?: AppPlanInfo;
 }
 export interface GetPricingPageUrlResponse {
-    /** the pricing page url, if there is a app plan that is upgradable. */
+    /**
+     * the pricing page url, if there is a app plan that is upgradable.
+     * @format WEB_URL
+     */
     packagePickerUrl?: string | null;
 }
 interface TaxSettingsNonNullableFields {
@@ -360,12 +407,12 @@ export interface ListAppPlansByAppIdResponseNonNullableFields {
  * Prices for plans that are managed outside of Wix aren't returned.
  *
  * Consumers must pay for yearly and multi-yearly plans of your app every month.
- * For these plans this endpoint returns the price that the consumer must pay every
+ * For these plans this method returns the price that the consumer must pay every
  * month and not the total price for the entire year.
  *
  * > **Notes:**
  * > - The App Plans API doesn't follow any tenancy model. You don't need any permissions to call `List App Plans by App ID`.
- * > - This endpoint only returns app plans that have been activated. ([REST](https://dev.wix.com/docs/rest/app-management/app-billing/app-plans/introduction#before-you-begin)|[SDK](https://dev.wix.com/docs/sdk/backend-modules/app-management/app-plans/introduction)).
+ * > - This method only returns app plans that have been activated.
  * @param appIds - List of app IDs to retrieve plans for.
  *
  * Min: 1 app ID

package/build/internal/cjs/src/appmarket-v1-app-plans-app-plans.universal.js

@@ -96,12 +96,12 @@ var TaxType;
  * Prices for plans that are managed outside of Wix aren't returned.
  *
  * Consumers must pay for yearly and multi-yearly plans of your app every month.
- * For these plans this endpoint returns the price that the consumer must pay every
+ * For these plans this method returns the price that the consumer must pay every
  * month and not the total price for the entire year.
  *
  * > **Notes:**
  * > - The App Plans API doesn't follow any tenancy model. You don't need any permissions to call `List App Plans by App ID`.
- * > - This endpoint only returns app plans that have been activated. ([REST](https://dev.wix.com/docs/rest/app-management/app-billing/app-plans/introduction#before-you-begin)|[SDK](https://dev.wix.com/docs/sdk/backend-modules/app-management/app-plans/introduction)).
+ * > - This method only returns app plans that have been activated.
  * @param appIds - List of app IDs to retrieve plans for.
  *
  * Min: 1 app ID

package/build/internal/cjs/src/appmarket-v1-app-plans-app-plans.universal.js.map

@@ -1 +1 @@
-{"version":3,"file":"appmarket-v1-app-plans-app-plans.universal.js","sourceRoot":"","sources":["../../../../src/appmarket-v1-app-plans-app-plans.universal.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,sEAAuF;AACvF,oFAGiD;AAEjD,6GAA+F;AAc/F,IAAY,QAOX;AAPD,WAAY,QAAQ;IAClB,sEAAsE;IACtE,2DAA+C,CAAA;IAC/C,yCAA6B,CAAA;IAC7B,2CAA+B,CAAA;IAC/B,yCAA6B,CAAA;IAC7B,6CAAiC,CAAA;AACnC,CAAC,EAPW,QAAQ,wBAAR,QAAQ,QAOnB;AAED,IAAY,YAMX;AAND,WAAY,YAAY;IACtB,uEAAuD,CAAA;IACvD,yCAAyC;IACzC,6CAA6B,CAAA;IAC7B,mDAAmD;IACnD,yCAAyB,CAAA;AAC3B,CAAC,EANW,YAAY,4BAAZ,YAAY,QAMvB;AAED,IAAY,UAOX;AAPD,WAAY,UAAU;IACpB,wEAAwE;IACxE,iEAAmD,CAAA;IACnD,4CAA4C;IAC5C,2BAAa,CAAA;IACb,qCAAqC;IACrC,yCAA2B,CAAA;AAC7B,CAAC,EAPW,UAAU,0BAAV,UAAU,QAOrB;AAsBD,IAAY,YAOX;AAPD,WAAY,YAAY;IACtB,4BAA4B;IAC5B,6CAA6B,CAAA;IAC7B,YAAY;IACZ,+BAAe,CAAA;IACf,WAAW;IACX,6BAAa,CAAA;AACf,CAAC,EAPW,YAAY,4BAAZ,YAAY,QAOvB;AAED,IAAY,SAIX;AAJD,WAAY,SAAS;IACnB,0CAA6B,CAAA;IAC7B,kCAAqB,CAAA;IACrB,oCAAuB,CAAA;AACzB,CAAC,EAJW,SAAS,yBAAT,SAAS,QAIpB;AAgED,IAAY,aAMX;AAND,WAAY,aAAa;IACvB,oCAAmB,CAAA;IACnB,iDAAiD;IACjD,4BAAW,CAAA;IACX,qDAAqD;IACrD,sCAAqB,CAAA;AACvB,CAAC,EANW,aAAa,6BAAb,aAAa,QAMxB;AAqID,IAAY,OAIX;AAJD,WAAY,OAAO;IACjB,4CAAiC,CAAA;IACjC,sBAAW,CAAA;IACX,sBAAW,CAAA;AACb,CAAC,EAJW,OAAO,uBAAP,OAAO,QAIlB;AAsGD;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACI,KAAK,UAAU,mBAAmB,CACvC,MAAgB;IAIhB,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,IAAA,8DAAqC,EAAC,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;IAE1E,MAAM,OAAO,GAAG,gCAAgC,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC;IAE9E,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,IAAA,gEAAuC,EAAC,MAAM,CAAC,IAAI,CAAE,CAAC;IAC/D,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,IAAA,gCAAiB,EACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE;YAC5C,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,QAAQ,CAAC,CACX,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AAnCD,kDAmCC"}
+{"version":3,"file":"appmarket-v1-app-plans-app-plans.universal.js","sourceRoot":"","sources":["../../../../src/appmarket-v1-app-plans-app-plans.universal.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,sEAAuF;AACvF,oFAGiD;AAEjD,6GAA+F;AAe/F,IAAY,QAOX;AAPD,WAAY,QAAQ;IAClB,sEAAsE;IACtE,2DAA+C,CAAA;IAC/C,yCAA6B,CAAA;IAC7B,2CAA+B,CAAA;IAC/B,yCAA6B,CAAA;IAC7B,6CAAiC,CAAA;AACnC,CAAC,EAPW,QAAQ,wBAAR,QAAQ,QAOnB;AAED,IAAY,YAMX;AAND,WAAY,YAAY;IACtB,uEAAuD,CAAA;IACvD,yCAAyC;IACzC,6CAA6B,CAAA;IAC7B,mDAAmD;IACnD,yCAAyB,CAAA;AAC3B,CAAC,EANW,YAAY,4BAAZ,YAAY,QAMvB;AAED,IAAY,UAOX;AAPD,WAAY,UAAU;IACpB,wEAAwE;IACxE,iEAAmD,CAAA;IACnD,4CAA4C;IAC5C,2BAAa,CAAA;IACb,qCAAqC;IACrC,yCAA2B,CAAA;AAC7B,CAAC,EAPW,UAAU,0BAAV,UAAU,QAOrB;AAuBD,IAAY,YAOX;AAPD,WAAY,YAAY;IACtB,4BAA4B;IAC5B,6CAA6B,CAAA;IAC7B,YAAY;IACZ,+BAAe,CAAA;IACf,WAAW;IACX,6BAAa,CAAA;AACf,CAAC,EAPW,YAAY,4BAAZ,YAAY,QAOvB;AAED,IAAY,SAIX;AAJD,WAAY,SAAS;IACnB,0CAA6B,CAAA;IAC7B,kCAAqB,CAAA;IACrB,oCAAuB,CAAA;AACzB,CAAC,EAJW,SAAS,yBAAT,SAAS,QAIpB;AAiFD,IAAY,aAMX;AAND,WAAY,aAAa;IACvB,oCAAmB,CAAA;IACnB,iDAAiD;IACjD,4BAAW,CAAA;IACX,qDAAqD;IACrD,sCAAqB,CAAA;AACvB,CAAC,EANW,aAAa,6BAAb,aAAa,QAMxB;AAuJD,IAAY,OAIX;AAJD,WAAY,OAAO;IACjB,4CAAiC,CAAA;IACjC,sBAAW,CAAA;IACX,sBAAW,CAAA;AACb,CAAC,EAJW,OAAO,uBAAP,OAAO,QAIlB;AAgHD;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACI,KAAK,UAAU,mBAAmB,CACvC,MAAgB;IAIhB,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,IAAA,8DAAqC,EAAC,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;IAE1E,MAAM,OAAO,GAAG,gCAAgC,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC;IAE9E,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,IAAA,gEAAuC,EAAC,MAAM,CAAC,IAAI,CAAE,CAAC;IAC/D,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,IAAA,gCAAiB,EACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE;YAC5C,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,QAAQ,CAAC,CACX,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AAnCD,kDAmCC"}

package/build/internal/es/src/appmarket-v1-app-plans-app-plans.http.d.ts

@@ -13,11 +13,11 @@ import { RequestOptionsFactory } from '@wix/sdk-types';
  * Prices for plans that are managed outside of Wix aren't returned.
  *
  * Consumers must pay for yearly and multi-yearly plans of your app every month.
- * For these plans this endpoint returns the price that the consumer must pay every
+ * For these plans this method returns the price that the consumer must pay every
  * month and not the total price for the entire year.
  *
  * > **Notes:**
  * > - The App Plans API doesn't follow any tenancy model. You don't need any permissions to call `List App Plans by App ID`.
- * > - This endpoint only returns app plans that have been activated. ([REST](https://dev.wix.com/docs/rest/app-management/app-billing/app-plans/introduction#before-you-begin)|[SDK](https://dev.wix.com/docs/sdk/backend-modules/app-management/app-plans/introduction)).
+ * > - This method only returns app plans that have been activated.
  */
 export declare function listAppPlansByAppId(payload: object): RequestOptionsFactory<any>;

package/build/internal/es/src/appmarket-v1-app-plans-app-plans.http.js

@@ -106,12 +106,12 @@ const PACKAGE_NAME = '@wix/auto_sdk_app-management_app-plans';
  * Prices for plans that are managed outside of Wix aren't returned.
  *
  * Consumers must pay for yearly and multi-yearly plans of your app every month.
- * For these plans this endpoint returns the price that the consumer must pay every
+ * For these plans this method returns the price that the consumer must pay every
  * month and not the total price for the entire year.
  *
  * > **Notes:**
  * > - The App Plans API doesn't follow any tenancy model. You don't need any permissions to call `List App Plans by App ID`.
- * > - This endpoint only returns app plans that have been activated. ([REST](https://dev.wix.com/docs/rest/app-management/app-billing/app-plans/introduction#before-you-begin)|[SDK](https://dev.wix.com/docs/sdk/backend-modules/app-management/app-plans/introduction)).
+ * > - This method only returns app plans that have been activated.
  */
 export function listAppPlansByAppId(payload) {
     function __listAppPlansByAppId({ host }) {

package/build/internal/es/src/appmarket-v1-app-plans-app-plans.public.d.ts

@@ -19,12 +19,12 @@ interface ListAppPlansByAppIdSignature {
      * Prices for plans that are managed outside of Wix aren't returned.
      *
      * Consumers must pay for yearly and multi-yearly plans of your app every month.
-     * For these plans this endpoint returns the price that the consumer must pay every
+     * For these plans this method returns the price that the consumer must pay every
      * month and not the total price for the entire year.
      *
      * > **Notes:**
      * > - The App Plans API doesn't follow any tenancy model. You don't need any permissions to call `List App Plans by App ID`.
-     * > - This endpoint only returns app plans that have been activated. ([REST](https://dev.wix.com/docs/rest/app-management/app-billing/app-plans/introduction#before-you-begin)|[SDK](https://dev.wix.com/docs/sdk/backend-modules/app-management/app-plans/introduction)).
+     * > - This method only returns app plans that have been activated.
      * @param - List of app IDs to retrieve plans for.
      *
      * Min: 1 app ID

package/build/internal/es/src/appmarket-v1-app-plans-app-plans.types.d.ts

@@ -6,6 +6,7 @@ export interface AppPlans {
      *
      * Min: `0` plans
      * Max: `50` plans
+     * @maxSize 50
      */
     plans?: Plan[];
 }
@@ -33,6 +34,7 @@ export declare enum SourceType {
     APP_BENEFIT = "APP_BENEFIT"
 }
 export interface SaleSource {
+    /** @format GUID */
     saleId?: string | null;
     saleType?: SaleType;
     startDate?: Date | null;
@@ -78,6 +80,9 @@ export interface UsageBasedDetails {
      *
      * Min: `0.00`
      * Max: 1024 characters
+     * @format DECIMAL_VALUE
+     * @decimalValue options { gte:0.00 }
+     * @maxLength 1024
      */
     minimumChargeIncrement?: string | null;
     /**
@@ -86,6 +91,9 @@ export interface UsageBasedDetails {
      *
      * Min: `0.00`
      * Max: 1024 characters
+     * @format DECIMAL_VALUE
+     * @decimalValue options { gte:0.00 }
+     * @maxLength 1024
      */
     monthlyBaseFee?: string | null;
     /**
@@ -97,7 +105,12 @@ export interface UsageBasedDetails {
 }
 export interface Discount extends DiscountSourceDataOneOf {
     type?: DiscountType;
-    /** Discount amount */
+    /**
+     * Discount amount
+     * @format DECIMAL_VALUE
+     * @decimalValue options { gte:0.00, maxScale:2 }
+     * @maxLength 1024
+     */
     amount?: string;
     /**
      * Price without taxes. For yearly plans, Wix calculates and returns the
@@ -105,12 +118,18 @@ export interface Discount extends DiscountSourceDataOneOf {
      * returned price with 12.
      * Min: `0.00`
      * Max: 1024 characters
+     * @format DECIMAL_VALUE
+     * @decimalValue options { gte:0.00, maxScale:2 }
+     * @maxLength 1024
      */
     priceBeforeTax?: string;
     /**
      * Total price including taxes.
      * Min: `0.00`
      * Max: 1024 characters
+     * @format DECIMAL_VALUE
+     * @decimalValue options { gte:0.00, maxScale:2 }
+     * @maxLength 1024
      */
     totalPrice?: string;
 }
@@ -132,6 +151,9 @@ export interface Price {
      *
      * Min: `0.00`
      * Max: 1024 characters
+     * @format DECIMAL_VALUE
+     * @decimalValue options { gte:0.00 }
+     * @maxLength 1024
      */
     priceBeforeTax?: string;
     /**
@@ -139,6 +161,9 @@ export interface Price {
      *
      * Min: `0.00`
      * Max: 1024 characters
+     * @format DECIMAL_VALUE
+     * @decimalValue options { gte:0.00 }
+     * @maxLength 1024
      */
     totalPrice?: string;
     /** Information about the plan's recurring billing cycle or single payment. */
@@ -151,12 +176,16 @@ export interface Price {
     usageBaseOptions?: UsageBasedDetails;
     discount?: Discount;
     billingSource?: BillingSource;
-    /** Can be shown instead of plan price - used for dynamic plans */
+    /**
+     * Can be shown instead of plan price - used for dynamic plans
+     * @maxLength 140
+     */
     customPaymentTitle?: string | null;
 }
 export interface Plan {
     /**
      * ID of the app plan.
+     * @format GUID
      * @readonly
      */
     id?: string;
@@ -175,6 +204,8 @@ export interface Plan {
      * Min: `0` benefits
      * Max: `4` benefits
      * Max per benefit: 1024 characters
+     * @maxSize 4
+     * @maxLength 1024
      */
     benefits?: string[];
     /**
@@ -183,6 +214,7 @@ export interface Plan {
      *
      * Min: `0` prices
      * Max: `10` prices
+     * @maxSize 10
      */
     prices?: Price[];
 }
@@ -192,6 +224,8 @@ export interface ListAppPlansByAppIdRequest {
      *
      * Min: 1 app ID
      * Max: 100 app IDs
+     * @minSize 1
+     * @maxSize 100
      */
     appIds: string[];
 }
@@ -209,6 +243,7 @@ export interface ListAppPlansByAppIdResponse {
      * you pass in the call's header. If you don't pass a country code in the header,
      * Wix calculates the currency based on the caller's IP address. Note that the
      * currency may not resolve properly if you call through a VPN.
+     * @format CURRENCY
      */
     currency?: string;
     /**
@@ -227,6 +262,7 @@ export interface ListAppPlansByAppIdResponse {
      * Max: 50 plans
      *
      * If any plans aren't returned, it's likely because they haven't been activated yet.
+     * @maxSize 50
      */
     appPlans?: AppPlans[];
 }
@@ -239,6 +275,7 @@ export interface TaxSettings {
     /**
      * Tax rate for the given country as percentage. Returned as `0` when
      * `{"showPriceWithTax": false}`.
+     * @format DECIMAL_VALUE
      */
     percentage?: string | null;
     /**
@@ -256,7 +293,10 @@ export declare enum TaxType {
     GST = "GST"
 }
 export interface GetAvailableAppPlansRequest {
-    /** AppId to get the available app plans for. */
+    /**
+     * AppId to get the available app plans for.
+     * @format GUID
+     */
     appId?: string;
     /** The specific app plan info to retrieve the available app plans for. */
     appPlanInfo?: AppPlanInfo;
@@ -270,6 +310,7 @@ export interface AppPlanInfo {
      * The app plan's vendorId to retrieve the response for.
      *
      * Max: 100 characters
+     * @maxLength 100
      */
     vendorId?: string;
     /** The app plan cycle to retrieve the response for. */
@@ -284,13 +325,19 @@ export interface GetAvailableAppPlansResponse {
     currentPlan?: Plan;
 }
 export interface GetPricingPageUrlRequest {
-    /** AppId to get the pricing page url for. */
+    /**
+     * AppId to get the pricing page url for.
+     * @format GUID
+     */
     appId?: string;
     /** The specific app plan to retrieve the pricing page url for. */
     appPlanInfo?: AppPlanInfo;
 }
 export interface GetPricingPageUrlResponse {
-    /** the pricing page url, if there is a app plan that is upgradable. */
+    /**
+     * the pricing page url, if there is a app plan that is upgradable.
+     * @format WEB_URL
+     */
     packagePickerUrl?: string | null;
 }
 interface TaxSettingsNonNullableFields {

package/build/internal/es/src/appmarket-v1-app-plans-app-plans.types.js.map

@@ -1 +1 @@
-{"version":3,"file":"appmarket-v1-app-plans-app-plans.types.js","sourceRoot":"","sources":["../../../../src/appmarket-v1-app-plans-app-plans.types.ts"],"names":[],"mappings":"AAYA,MAAM,CAAN,IAAY,QAOX;AAPD,WAAY,QAAQ;IAClB,sEAAsE;IACtE,2DAA+C,CAAA;IAC/C,yCAA6B,CAAA;IAC7B,2CAA+B,CAAA;IAC/B,yCAA6B,CAAA;IAC7B,6CAAiC,CAAA;AACnC,CAAC,EAPW,QAAQ,KAAR,QAAQ,QAOnB;AAED,MAAM,CAAN,IAAY,YAMX;AAND,WAAY,YAAY;IACtB,uEAAuD,CAAA;IACvD,yCAAyC;IACzC,6CAA6B,CAAA;IAC7B,mDAAmD;IACnD,yCAAyB,CAAA;AAC3B,CAAC,EANW,YAAY,KAAZ,YAAY,QAMvB;AAED,MAAM,CAAN,IAAY,UAOX;AAPD,WAAY,UAAU;IACpB,wEAAwE;IACxE,iEAAmD,CAAA;IACnD,4CAA4C;IAC5C,2BAAa,CAAA;IACb,qCAAqC;IACrC,yCAA2B,CAAA;AAC7B,CAAC,EAPW,UAAU,KAAV,UAAU,QAOrB;AAsBD,MAAM,CAAN,IAAY,YAOX;AAPD,WAAY,YAAY;IACtB,4BAA4B;IAC5B,6CAA6B,CAAA;IAC7B,YAAY;IACZ,+BAAe,CAAA;IACf,WAAW;IACX,6BAAa,CAAA;AACf,CAAC,EAPW,YAAY,KAAZ,YAAY,QAOvB;AAED,MAAM,CAAN,IAAY,SAIX;AAJD,WAAY,SAAS;IACnB,0CAA6B,CAAA;IAC7B,kCAAqB,CAAA;IACrB,oCAAuB,CAAA;AACzB,CAAC,EAJW,SAAS,KAAT,SAAS,QAIpB;AA2DD,MAAM,CAAN,IAAY,aAMX;AAND,WAAY,aAAa;IACvB,oCAAmB,CAAA;IACnB,iDAAiD;IACjD,4BAAW,CAAA;IACX,qDAAqD;IACrD,sCAAqB,CAAA;AACvB,CAAC,EANW,aAAa,KAAb,aAAa,QAMxB;AAqID,MAAM,CAAN,IAAY,OAIX;AAJD,WAAY,OAAO;IACjB,4CAAiC,CAAA;IACjC,sBAAW,CAAA;IACX,sBAAW,CAAA;AACb,CAAC,EAJW,OAAO,KAAP,OAAO,QAIlB"}
+{"version":3,"file":"appmarket-v1-app-plans-app-plans.types.js","sourceRoot":"","sources":["../../../../src/appmarket-v1-app-plans-app-plans.types.ts"],"names":[],"mappings":"AAaA,MAAM,CAAN,IAAY,QAOX;AAPD,WAAY,QAAQ;IAClB,sEAAsE;IACtE,2DAA+C,CAAA;IAC/C,yCAA6B,CAAA;IAC7B,2CAA+B,CAAA;IAC/B,yCAA6B,CAAA;IAC7B,6CAAiC,CAAA;AACnC,CAAC,EAPW,QAAQ,KAAR,QAAQ,QAOnB;AAED,MAAM,CAAN,IAAY,YAMX;AAND,WAAY,YAAY;IACtB,uEAAuD,CAAA;IACvD,yCAAyC;IACzC,6CAA6B,CAAA;IAC7B,mDAAmD;IACnD,yCAAyB,CAAA;AAC3B,CAAC,EANW,YAAY,KAAZ,YAAY,QAMvB;AAED,MAAM,CAAN,IAAY,UAOX;AAPD,WAAY,UAAU;IACpB,wEAAwE;IACxE,iEAAmD,CAAA;IACnD,4CAA4C;IAC5C,2BAAa,CAAA;IACb,qCAAqC;IACrC,yCAA2B,CAAA;AAC7B,CAAC,EAPW,UAAU,KAAV,UAAU,QAOrB;AAuBD,MAAM,CAAN,IAAY,YAOX;AAPD,WAAY,YAAY;IACtB,4BAA4B;IAC5B,6CAA6B,CAAA;IAC7B,YAAY;IACZ,+BAAe,CAAA;IACf,WAAW;IACX,6BAAa,CAAA;AACf,CAAC,EAPW,YAAY,KAAZ,YAAY,QAOvB;AAED,MAAM,CAAN,IAAY,SAIX;AAJD,WAAY,SAAS;IACnB,0CAA6B,CAAA;IAC7B,kCAAqB,CAAA;IACrB,oCAAuB,CAAA;AACzB,CAAC,EAJW,SAAS,KAAT,SAAS,QAIpB;AA4ED,MAAM,CAAN,IAAY,aAMX;AAND,WAAY,aAAa;IACvB,oCAAmB,CAAA;IACnB,iDAAiD;IACjD,4BAAW,CAAA;IACX,qDAAqD;IACrD,sCAAqB,CAAA;AACvB,CAAC,EANW,aAAa,KAAb,aAAa,QAMxB;AAuJD,MAAM,CAAN,IAAY,OAIX;AAJD,WAAY,OAAO;IACjB,4CAAiC,CAAA;IACjC,sBAAW,CAAA;IACX,sBAAW,CAAA;AACb,CAAC,EAJW,OAAO,KAAP,OAAO,QAIlB"}

package/build/internal/es/src/appmarket-v1-app-plans-app-plans.universal.d.ts

@@ -6,6 +6,7 @@ export interface AppPlans {
      *
      * Min: `0` plans
      * Max: `50` plans
+     * @maxSize 50
      */
     plans?: Plan[];
 }
@@ -33,6 +34,7 @@ export declare enum SourceType {
     APP_BENEFIT = "APP_BENEFIT"
 }
 export interface SaleSource {
+    /** @format GUID */
     saleId?: string | null;
     saleType?: SaleType;
     startDate?: Date | null;
@@ -78,6 +80,9 @@ export interface UsageBasedDetails {
      *
      * Min: `0.00`
      * Max: 1024 characters
+     * @format DECIMAL_VALUE
+     * @decimalValue options { gte:0.00 }
+     * @maxLength 1024
      */
     minimumChargeIncrement?: string | null;
     /**
@@ -86,6 +91,9 @@ export interface UsageBasedDetails {
      *
      * Min: `0.00`
      * Max: 1024 characters
+     * @format DECIMAL_VALUE
+     * @decimalValue options { gte:0.00 }
+     * @maxLength 1024
      */
     monthlyBaseFee?: string | null;
     /**
@@ -97,7 +105,12 @@ export interface UsageBasedDetails {
 }
 export interface Discount extends DiscountSourceDataOneOf {
     type?: DiscountType;
-    /** Discount amount */
+    /**
+     * Discount amount
+     * @format DECIMAL_VALUE
+     * @decimalValue options { gte:0.00, maxScale:2 }
+     * @maxLength 1024
+     */
     amount?: string;
     /**
      * Price without taxes. For yearly plans, Wix calculates and returns the
@@ -105,12 +118,18 @@ export interface Discount extends DiscountSourceDataOneOf {
      * returned price with 12.
      * Min: `0.00`
      * Max: 1024 characters
+     * @format DECIMAL_VALUE
+     * @decimalValue options { gte:0.00, maxScale:2 }
+     * @maxLength 1024
      */
     priceBeforeTax?: string;
     /**
      * Total price including taxes.
      * Min: `0.00`
      * Max: 1024 characters
+     * @format DECIMAL_VALUE
+     * @decimalValue options { gte:0.00, maxScale:2 }
+     * @maxLength 1024
      */
     totalPrice?: string;
     /**
@@ -137,6 +156,9 @@ export interface Price {
      *
      * Min: `0.00`
      * Max: 1024 characters
+     * @format DECIMAL_VALUE
+     * @decimalValue options { gte:0.00 }
+     * @maxLength 1024
      */
     priceBeforeTax?: string;
     /**
@@ -144,6 +166,9 @@ export interface Price {
      *
      * Min: `0.00`
      * Max: 1024 characters
+     * @format DECIMAL_VALUE
+     * @decimalValue options { gte:0.00 }
+     * @maxLength 1024
      */
     totalPrice?: string;
     /** Information about the plan's recurring billing cycle or single payment. */
@@ -156,12 +181,16 @@ export interface Price {
     usageBaseOptions?: UsageBasedDetails;
     discount?: Discount;
     billingSource?: BillingSource;
-    /** Can be shown instead of plan price - used for dynamic plans */
+    /**
+     * Can be shown instead of plan price - used for dynamic plans
+     * @maxLength 140
+     */
     customPaymentTitle?: string | null;
 }
 export interface Plan {
     /**
      * ID of the app plan.
+     * @format GUID
      * @readonly
      */
     _id?: string;
@@ -180,6 +209,8 @@ export interface Plan {
      * Min: `0` benefits
      * Max: `4` benefits
      * Max per benefit: 1024 characters
+     * @maxSize 4
+     * @maxLength 1024
      */
     benefits?: string[];
     /**
@@ -188,6 +219,7 @@ export interface Plan {
      *
      * Min: `0` prices
      * Max: `10` prices
+     * @maxSize 10
      */
     prices?: Price[];
 }
@@ -197,6 +229,8 @@ export interface ListAppPlansByAppIdRequest {
      *
      * Min: 1 app ID
      * Max: 100 app IDs
+     * @minSize 1
+     * @maxSize 100
      */
     appIds: string[];
 }
@@ -214,6 +248,7 @@ export interface ListAppPlansByAppIdResponse {
      * you pass in the call's header. If you don't pass a country code in the header,
      * Wix calculates the currency based on the caller's IP address. Note that the
      * currency may not resolve properly if you call through a VPN.
+     * @format CURRENCY
      */
     currency?: string;
     /**
@@ -232,6 +267,7 @@ export interface ListAppPlansByAppIdResponse {
      * Max: 50 plans
      *
      * If any plans aren't returned, it's likely because they haven't been activated yet.
+     * @maxSize 50
      */
     appPlans?: AppPlans[];
 }
@@ -244,6 +280,7 @@ export interface TaxSettings {
     /**
      * Tax rate for the given country as percentage. Returned as `0` when
      * `{"showPriceWithTax": false}`.
+     * @format DECIMAL_VALUE
      */
     percentage?: string | null;
     /**
@@ -261,7 +298,10 @@ export declare enum TaxType {
     GST = "GST"
 }
 export interface GetAvailableAppPlansRequest {
-    /** AppId to get the available app plans for. */
+    /**
+     * AppId to get the available app plans for.
+     * @format GUID
+     */
     appId?: string;
     /** The specific app plan info to retrieve the available app plans for. */
     appPlanInfo?: AppPlanInfo;
@@ -275,6 +315,7 @@ export interface AppPlanInfo {
      * The app plan's vendorId to retrieve the response for.
      *
      * Max: 100 characters
+     * @maxLength 100
      */
     vendorId?: string;
     /** The app plan cycle to retrieve the response for. */
@@ -289,13 +330,19 @@ export interface GetAvailableAppPlansResponse {
     currentPlan?: Plan;
 }
 export interface GetPricingPageUrlRequest {
-    /** AppId to get the pricing page url for. */
+    /**
+     * AppId to get the pricing page url for.
+     * @format GUID
+     */
     appId?: string;
     /** The specific app plan to retrieve the pricing page url for. */
     appPlanInfo?: AppPlanInfo;
 }
 export interface GetPricingPageUrlResponse {
-    /** the pricing page url, if there is a app plan that is upgradable. */
+    /**
+     * the pricing page url, if there is a app plan that is upgradable.
+     * @format WEB_URL
+     */
     packagePickerUrl?: string | null;
 }
 interface TaxSettingsNonNullableFields {
@@ -360,12 +407,12 @@ export interface ListAppPlansByAppIdResponseNonNullableFields {
  * Prices for plans that are managed outside of Wix aren't returned.
  *
  * Consumers must pay for yearly and multi-yearly plans of your app every month.
- * For these plans this endpoint returns the price that the consumer must pay every
+ * For these plans this method returns the price that the consumer must pay every
  * month and not the total price for the entire year.
  *
  * > **Notes:**
  * > - The App Plans API doesn't follow any tenancy model. You don't need any permissions to call `List App Plans by App ID`.
- * > - This endpoint only returns app plans that have been activated. ([REST](https://dev.wix.com/docs/rest/app-management/app-billing/app-plans/introduction#before-you-begin)|[SDK](https://dev.wix.com/docs/sdk/backend-modules/app-management/app-plans/introduction)).
+ * > - This method only returns app plans that have been activated.
  * @param appIds - List of app IDs to retrieve plans for.
  *
  * Min: 1 app ID