@wix/auto_sdk_stores_subscription-options 1.0.1 → 1.0.2

package/build/internal/es/src/stores-v1-subscription-option-subscription-options.types.d.ts

@@ -1,9 +1,19 @@
 export interface SubscriptionOption {
-    /** Subscription option ID (auto-generated upon subscription option creation). */
+    /**
+     * Subscription option ID (auto-generated upon subscription option creation).
+     * @format GUID
+     */
     id?: string | null;
-    /** Subscription option title. */
+    /**
+     * Subscription option title.
+     * @minLength 1
+     * @maxLength 20
+     */
     title?: string | null;
-    /** Subscription option description (optional). */
+    /**
+     * Subscription option description (optional).
+     * @maxLength 60
+     */
     description?: string | null;
     /** Subscription charge times. For example, if `frequency: MONTH` and `billingCycles: 6`; payment will be made monthly for 6 months. */
     subscriptionSettings?: SubscriptionSettings;
@@ -18,7 +28,11 @@ export interface SubscriptionSettings {
     frequency?: SubscriptionFrequency;
     /** Whether subscription is renewed automatically at the end of each period. */
     autoRenewal?: boolean;
-    /** Number of billing cycles before subscription ends. Ignored if `autoRenewal: true`. */
+    /**
+     * Number of billing cycles before subscription ends. Ignored if `autoRenewal: true`.
+     * @min 2
+     * @max 999
+     */
     billingCycles?: number | null;
 }
 /** Frequency unit of recurring payment */
@@ -41,68 +55,49 @@ export declare enum DiscountType {
     AMOUNT = "AMOUNT",
     PERCENT = "PERCENT"
 }
-export interface CreateSubscriptionOptionRequest {
-    /** Subscription option info. */
-    subscriptionOption: SubscriptionOption;
-}
-export interface CreateSubscriptionOptionResponse {
-    /** Newly created subscription option. */
-    subscriptionOption?: SubscriptionOption;
-}
-export interface UpdateSubscriptionOptionRequest {
-    /** Subscription option info. Only the passed parameters will be updated. */
-    subscriptionOption: SubscriptionOption;
-}
-export interface UpdateSubscriptionOptionResponse {
-    /** Updated subscription option. */
-    subscriptionOption?: SubscriptionOption;
-}
-export interface DeleteSubscriptionOptionRequest {
-    /** ID of the subscription option to delete. */
+export interface GetSubscriptionOptionRequest {
+    /**
+     * Subscription option ID.
+     * @minLength 1
+     * @format GUID
+     */
     id: string;
 }
-export interface DeleteSubscriptionOptionResponse {
-}
-export interface BulkCreateSubscriptionOptionsRequest {
-    /** Subscription options info. */
-    subscriptionOptions: SubscriptionOption[];
-}
-export interface BulkCreateSubscriptionOptionsResponse {
-    /** Newly created subscription options. */
-    subscriptionOptions?: SubscriptionOption[];
-}
-export interface BulkUpdateSubscriptionOptionsRequest {
-    /** Subscription options info. Only the passed parameters in each subscription option will be updated. */
-    subscriptionOptions: SubscriptionOption[];
-}
-export interface BulkUpdateSubscriptionOptionsResponse {
-    /** Updated subscription options. */
-    subscriptionOptions?: SubscriptionOption[];
-}
-export interface BulkDeleteSubscriptionOptionsRequest {
-    /** IDs of the subscription options to delete. */
-    ids: string[];
-}
-export interface BulkDeleteSubscriptionOptionsResponse {
+export interface GetSubscriptionOptionResponse {
+    /** Subscription option. */
+    subscriptionOption?: SubscriptionOption;
 }
-export interface AssignSubscriptionOptionsToProductRequest {
-    /** Product ID. */
+export interface GetSubscriptionOptionsForProductRequest {
+    /**
+     * Product ID.
+     * @minLength 1
+     */
     productId: string;
-    /** Ordered array of subscription options that will be assigned to the product. Pass an empty array to remove all subscription options from the product. */
-    assignedSubscriptionOptions?: SubscriptionOptionInProduct[];
+    /** Whether to include hidden subscription options in the results. */
+    includeHiddenSubscriptionOptions?: boolean;
+}
+export interface GetSubscriptionOptionsForProductResponse {
+    /** Subscription options. */
+    subscriptionOptions?: SubscriptionOptionInProduct[];
 }
 export interface SubscriptionOptionInProduct {
-    /** Subscription option ID. */
+    /**
+     * Subscription option ID.
+     * @format GUID
+     */
     id?: string;
     /** Whether the subscription option is hidden for the product (the default is false). */
     hidden?: boolean;
     /**
      * Subscription option title.
+     * @minLength 1
+     * @maxLength 20
      * @readonly
      */
     title?: string | null;
     /**
      * Subscription option description (optional).
+     * @maxLength 60
      * @readonly
      */
     description?: string | null;
@@ -117,36 +112,12 @@ export interface SubscriptionOptionInProduct {
      */
     discount?: Discount;
 }
-export interface AssignSubscriptionOptionsToProductResponse {
-}
-export interface AllowOneTimePurchasesRequest {
-    /** Product ID. */
-    productId: string;
-    /** Pass `true` to offer product by subscription and as one-time purchase. Pass `false` to offer product as subscription only. */
-    allowed: boolean | null;
-}
-export interface AllowOneTimePurchasesResponse {
-}
-export interface GetSubscriptionOptionRequest {
-    /** Subscription option ID. */
-    id: string;
-}
-export interface GetSubscriptionOptionResponse {
-    /** Subscription option. */
-    subscriptionOption?: SubscriptionOption;
-}
-export interface GetSubscriptionOptionsForProductRequest {
-    /** Product ID. */
-    productId: string;
-    /** Whether to include hidden subscription options in the results. */
-    includeHiddenSubscriptionOptions?: boolean;
-}
-export interface GetSubscriptionOptionsForProductResponse {
-    /** Subscription options. */
-    subscriptionOptions?: SubscriptionOptionInProduct[];
-}
 export interface ListSubscriptionOptionsRequest {
-    /** Subscription option IDs. */
+    /**
+     * Subscription option IDs.
+     * @format GUID
+     * @maxSize 100
+     */
     ids?: string[];
 }
 export interface ListSubscriptionOptionsResponse {
@@ -156,7 +127,11 @@ export interface ListSubscriptionOptionsResponse {
 export interface CalculatePricesRequest {
     /** original price to which subscription options discount will be applied */
     price?: number;
-    /** ids of subscription options which will be applied to original price */
+    /**
+     * ids of subscription options which will be applied to original price
+     * @format GUID
+     * @maxSize 100
+     */
     ids?: string[];
 }
 export interface CalculatePricesResponse {
@@ -185,9 +160,14 @@ export interface BulkCalculatePricesRequest {
     /**
      * Original prices to which subscription options discount will be applied.
      * Key is identifier unique per price that can be used to match calculated prices with original price
+     * @maxSize 1001
      */
     prices?: Record<string, number>;
-    /** ids of subscription options which will be applied to original price */
+    /**
+     * ids of subscription options which will be applied to original price
+     * @format GUID
+     * @maxSize 100
+     */
     ids?: string[];
 }
 export interface BulkCalculatePricesResponse {
@@ -198,18 +178,30 @@ export interface BulkCalculatePricesResponse {
     calculatedPrices?: Record<string, CalculatePricesResponse>;
 }
 export interface BulkCalculatePricesRequestV2 {
-    /** Original prices to be calculated for each corresponding product id with related subscription plan ids */
+    /**
+     * Original prices to be calculated for each corresponding product id with related subscription plan ids
+     * @maxSize 100
+     */
     items?: BulkCalculatePricesRequestItem[];
 }
 export interface BulkCalculatePricesRequestItem {
-    /** Calculation id (product id) */
+    /**
+     * Calculation id (product id)
+     * @minLength 1
+     * @maxLength 36
+     */
     id?: string;
     /**
      * Original prices to which subscription options discount will be applied.
      * Key is identifier unique per price that can be used to match calculated prices with original price
+     * @maxSize 1001
      */
     prices?: Record<string, number>;
-    /** ids of subscription options which will be applied to original price. */
+    /**
+     * ids of subscription options which will be applied to original price.
+     * @format GUID
+     * @maxSize 100
+     */
     subscriptionOptionIds?: string[];
 }
 export interface BulkCalculatePricesResponseV2 {
@@ -220,7 +212,10 @@ export interface BulkCalculatePricesResponseV2 {
     calculatedPricesPerProduct?: BulkCalculatePricesResponseItem[];
 }
 export interface BulkCalculatePricesResponseItem {
-    /** Calculation id (product id) */
+    /**
+     * Calculation id (product id)
+     * @minLength 1
+     */
     id?: string;
     /**
      * Key is identifier unique per price that can be used to match calculated prices with original price
@@ -229,7 +224,11 @@ export interface BulkCalculatePricesResponseItem {
     calculatedPrices?: Record<string, CalculatePricesResponse>;
 }
 export interface GetProductIdsForSubscriptionOptionRequest {
-    /** Subscription option ID. */
+    /**
+     * Subscription option ID.
+     * @minLength 1
+     * @format GUID
+     */
     id: string;
     /** Whether to include hidden products in the returned results. */
     includeHiddenProducts?: boolean;
@@ -237,7 +236,10 @@ export interface GetProductIdsForSubscriptionOptionRequest {
     paging?: Paging;
 }
 export interface Paging {
-    /** Amount of items to load per page. */
+    /**
+     * Amount of items to load per page.
+     * @max 100
+     */
     limit?: number | null;
     /** Number of items to skip in the display (relevant for all pages after the first). */
     offset?: number | null;
@@ -257,13 +259,99 @@ export interface PagingMetadata {
     offset?: number;
 }
 export interface GetOneTimePurchasesStatusRequest {
-    /** Product ID. */
+    /**
+     * Product ID.
+     * @minLength 1
+     */
     productId: string;
 }
 export interface GetOneTimePurchasesStatusResponse {
     /** Whether the specified product is available for one-time purchase */
     allowed?: boolean;
 }
+export interface CreateSubscriptionOptionRequest {
+    /** Subscription option info. */
+    subscriptionOption: SubscriptionOption;
+}
+export interface CreateSubscriptionOptionResponse {
+    /** Newly created subscription option. */
+    subscriptionOption?: SubscriptionOption;
+}
+export interface UpdateSubscriptionOptionRequest {
+    /** Subscription option info. Only the passed parameters will be updated. */
+    subscriptionOption: SubscriptionOption;
+}
+export interface UpdateSubscriptionOptionResponse {
+    /** Updated subscription option. */
+    subscriptionOption?: SubscriptionOption;
+}
+export interface DeleteSubscriptionOptionRequest {
+    /**
+     * ID of the subscription option to delete.
+     * @minLength 1
+     * @format GUID
+     */
+    id: string;
+}
+export interface DeleteSubscriptionOptionResponse {
+}
+export interface BulkCreateSubscriptionOptionsRequest {
+    /**
+     * Subscription options info.
+     * @maxSize 100
+     */
+    subscriptionOptions: SubscriptionOption[];
+}
+export interface BulkCreateSubscriptionOptionsResponse {
+    /** Newly created subscription options. */
+    subscriptionOptions?: SubscriptionOption[];
+}
+export interface BulkUpdateSubscriptionOptionsRequest {
+    /**
+     * Subscription options info. Only the passed parameters in each subscription option will be updated.
+     * @maxSize 100
+     */
+    subscriptionOptions: SubscriptionOption[];
+}
+export interface BulkUpdateSubscriptionOptionsResponse {
+    /** Updated subscription options. */
+    subscriptionOptions?: SubscriptionOption[];
+}
+export interface BulkDeleteSubscriptionOptionsRequest {
+    /**
+     * IDs of the subscription options to delete.
+     * @maxSize 100
+     * @format GUID
+     */
+    ids: string[];
+}
+export interface BulkDeleteSubscriptionOptionsResponse {
+}
+export interface AssignSubscriptionOptionsToProductRequest {
+    /**
+     * Product ID.
+     * @minLength 1
+     */
+    productId: string;
+    /**
+     * Ordered array of subscription options that will be assigned to the product. Pass an empty array to remove all subscription options from the product.
+     * @maxSize 6
+     */
+    assignedSubscriptionOptions?: SubscriptionOptionInProduct[];
+}
+export interface AssignSubscriptionOptionsToProductResponse {
+}
+export interface AllowOneTimePurchasesRequest {
+    /**
+     * Product ID.
+     * @minLength 1
+     */
+    productId: string;
+    /** Pass `true` to offer product by subscription and as one-time purchase. Pass `false` to offer product as subscription only. */
+    allowed: boolean | null;
+}
+export interface AllowOneTimePurchasesResponse {
+}
 interface SubscriptionSettingsNonNullableFields {
     frequency: SubscriptionFrequency;
     autoRenewal: boolean;
@@ -276,18 +364,6 @@ interface SubscriptionOptionNonNullableFields {
     subscriptionSettings?: SubscriptionSettingsNonNullableFields;
     discount?: DiscountNonNullableFields;
 }
-export interface CreateSubscriptionOptionResponseNonNullableFields {
-    subscriptionOption?: SubscriptionOptionNonNullableFields;
-}
-export interface UpdateSubscriptionOptionResponseNonNullableFields {
-    subscriptionOption?: SubscriptionOptionNonNullableFields;
-}
-export interface BulkCreateSubscriptionOptionsResponseNonNullableFields {
-    subscriptionOptions: SubscriptionOptionNonNullableFields[];
-}
-export interface BulkUpdateSubscriptionOptionsResponseNonNullableFields {
-    subscriptionOptions: SubscriptionOptionNonNullableFields[];
-}
 export interface GetSubscriptionOptionResponseNonNullableFields {
     subscriptionOption?: SubscriptionOptionNonNullableFields;
 }
@@ -312,4 +388,16 @@ export interface GetProductIdsForSubscriptionOptionResponseNonNullableFields {
 export interface GetOneTimePurchasesStatusResponseNonNullableFields {
     allowed: boolean;
 }
+export interface CreateSubscriptionOptionResponseNonNullableFields {
+    subscriptionOption?: SubscriptionOptionNonNullableFields;
+}
+export interface UpdateSubscriptionOptionResponseNonNullableFields {
+    subscriptionOption?: SubscriptionOptionNonNullableFields;
+}
+export interface BulkCreateSubscriptionOptionsResponseNonNullableFields {
+    subscriptionOptions: SubscriptionOptionNonNullableFields[];
+}
+export interface BulkUpdateSubscriptionOptionsResponseNonNullableFields {
+    subscriptionOptions: SubscriptionOptionNonNullableFields[];
+}
 export {};

package/build/internal/es/src/stores-v1-subscription-option-subscription-options.types.js.map

@@ -1 +1 @@
-{"version":3,"file":"stores-v1-subscription-option-subscription-options.types.js","sourceRoot":"","sources":["../../../../src/stores-v1-subscription-option-subscription-options.types.ts"],"names":[],"mappings":"AAyBA,0CAA0C;AAC1C,MAAM,CAAN,IAAY,qBAMX;AAND,WAAY,qBAAqB;IAC/B,gDAAuB,CAAA;IACvB,oCAAW,CAAA;IACX,sCAAa,CAAA;IACb,wCAAe,CAAA;IACf,sCAAa,CAAA;AACf,CAAC,EANW,qBAAqB,KAArB,qBAAqB,QAMhC;AASD,MAAM,CAAN,IAAY,YAKX;AALD,WAAY,YAAY;IACtB,uCAAuB,CAAA;IACvB,kBAAkB;IAClB,iCAAiB,CAAA;IACjB,mCAAmB,CAAA;AACrB,CAAC,EALW,YAAY,KAAZ,YAAY,QAKvB"}
+{"version":3,"file":"stores-v1-subscription-option-subscription-options.types.js","sourceRoot":"","sources":["../../../../src/stores-v1-subscription-option-subscription-options.types.ts"],"names":[],"mappings":"AAuCA,0CAA0C;AAC1C,MAAM,CAAN,IAAY,qBAMX;AAND,WAAY,qBAAqB;IAC/B,gDAAuB,CAAA;IACvB,oCAAW,CAAA;IACX,sCAAa,CAAA;IACb,wCAAe,CAAA;IACf,sCAAa,CAAA;AACf,CAAC,EANW,qBAAqB,KAArB,qBAAqB,QAMhC;AASD,MAAM,CAAN,IAAY,YAKX;AALD,WAAY,YAAY;IACtB,uCAAuB,CAAA;IACvB,kBAAkB;IAClB,iCAAiB,CAAA;IACjB,mCAAmB,CAAA;AACrB,CAAC,EALW,YAAY,KAAZ,YAAY,QAKvB"}