@wix/auto_sdk_stores_subscription-options 1.0.59 → 1.0.61

package/build/cjs/index.d.ts

@@ -1,48 +1,10 @@
 import { HttpClient, NonNullablePaths, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
-import { SubscriptionOption, GetSubscriptionOptionsForProductOptions, GetSubscriptionOptionsForProductResponse, GetProductIdsForSubscriptionOptionOptions, GetProductIdsForSubscriptionOptionResponse, GetOneTimePurchasesStatusResponse, UpdateSubscriptionOption, BulkCreateSubscriptionOptionsResponse, BulkUpdateSubscriptionOptionsResponse, AssignSubscriptionOptionsToProductOptions } from './index.typings.js';
+import { SubscriptionOption, UpdateSubscriptionOption, BulkCreateSubscriptionOptionsResponse, BulkUpdateSubscriptionOptionsResponse, AssignSubscriptionOptionsToProductOptions, GetSubscriptionOptionsForProductOptions, GetSubscriptionOptionsForProductResponse, GetProductIdsForSubscriptionOptionOptions, GetProductIdsForSubscriptionOptionResponse, GetOneTimePurchasesStatusResponse } from './index.typings.js';
 export { AllowOneTimePurchasesRequest, AllowOneTimePurchasesResponse, AssignSubscriptionOptionsToProductRequest, AssignSubscriptionOptionsToProductResponse, BulkCalculatePricesRequest, BulkCalculatePricesRequestItem, BulkCalculatePricesRequestV2, BulkCalculatePricesResponse, BulkCalculatePricesResponseItem, BulkCalculatePricesResponseV2, BulkCreateSubscriptionOptionsRequest, BulkDeleteSubscriptionOptionsRequest, BulkDeleteSubscriptionOptionsResponse, BulkUpdateSubscriptionOptionsRequest, CalculatePricesRequest, CalculatePricesResponse, CreateSubscriptionOptionRequest, CreateSubscriptionOptionResponse, DeleteSubscriptionOptionRequest, DeleteSubscriptionOptionResponse, Discount, DiscountType, DiscountTypeWithLiterals, GetOneTimePurchasesStatusRequest, GetProductIdsForSubscriptionOptionRequest, GetSubscriptionOptionRequest, GetSubscriptionOptionResponse, GetSubscriptionOptionsForProductRequest, ListSubscriptionOptionsRequest, ListSubscriptionOptionsResponse, Paging, PagingMetadata, SubscriptionFrequency, SubscriptionFrequencyWithLiterals, SubscriptionOptionInProduct, SubscriptionOptionPriceData, SubscriptionOptionPrices, SubscriptionSettings, UpdateSubscriptionOptionRequest, UpdateSubscriptionOptionResponse } from './index.typings.js';
 
-declare function getSubscriptionOption$1(httpClient: HttpClient): GetSubscriptionOptionSignature;
-interface GetSubscriptionOptionSignature {
-    /**
-     * Retrieves a subscription option by ID.
-     * @param - Subscription option ID.
-     * @returns Subscription option.
-     * @deprecated
-     */
-    (_id: string): Promise<NonNullablePaths<SubscriptionOption, `subscriptionSettings.frequency` | `subscriptionSettings.autoRenewal` | `discount.type` | `discount.value`, 3>>;
-}
-declare function getSubscriptionOptionsForProduct$1(httpClient: HttpClient): GetSubscriptionOptionsForProductSignature;
-interface GetSubscriptionOptionsForProductSignature {
-    /**
-     * Retrieves all subscription options assigned to a specified product.
-     * By default, hidden subscription options are not returned. To retrieve all subscription options you must pass `includeHiddenSubscriptionOptions = true`.
-     * @param - Product ID.
-     * @param - Options.
-     * @deprecated
-     */
-    (productId: string, options?: GetSubscriptionOptionsForProductOptions): Promise<NonNullablePaths<GetSubscriptionOptionsForProductResponse, `subscriptionOptions` | `subscriptionOptions.${number}._id` | `subscriptionOptions.${number}.hidden` | `subscriptionOptions.${number}.subscriptionSettings.frequency` | `subscriptionOptions.${number}.subscriptionSettings.autoRenewal` | `subscriptionOptions.${number}.discount.type` | `subscriptionOptions.${number}.discount.value`, 5>>;
-}
-declare function getProductIdsForSubscriptionOption$1(httpClient: HttpClient): GetProductIdsForSubscriptionOptionSignature;
-interface GetProductIdsForSubscriptionOptionSignature {
-    /**
-     * Retrieves the IDs of products associated with a specified subscription option.
-     * @param - Subscription option ID.
-     * @param - Paging and other options.
-     * @deprecated
-     */
-    (_id: string, options?: GetProductIdsForSubscriptionOptionOptions): Promise<NonNullablePaths<GetProductIdsForSubscriptionOptionResponse, `productIds` | `metadata.items` | `metadata.offset` | `totalResults`, 3>>;
-}
-declare function getOneTimePurchasesStatus$1(httpClient: HttpClient): GetOneTimePurchasesStatusSignature;
-interface GetOneTimePurchasesStatusSignature {
-    /**
-     * Checks whether a specified product (associated with subscription options) is available for one-time purchase.
-     * @param - Product ID.
-     * @deprecated
-     */
-    (productId: string): Promise<NonNullablePaths<GetOneTimePurchasesStatusResponse, `allowed`, 2>>;
-}
-declare function createSubscriptionOption$1(httpClient: HttpClient): CreateSubscriptionOptionSignature;
+declare function createSubscriptionOption$1(httpClient: HttpClient, __options?: {
+    validateRequestSchema?: boolean;
+}): CreateSubscriptionOptionSignature;
 interface CreateSubscriptionOptionSignature {
     /**
      * Creates a subscription option.
@@ -54,7 +16,9 @@ interface CreateSubscriptionOptionSignature {
      */
     (subscriptionOption: NonNullablePaths<SubscriptionOption, `subscriptionSettings` | `title`, 2>): Promise<NonNullablePaths<SubscriptionOption, `subscriptionSettings.frequency` | `subscriptionSettings.autoRenewal` | `discount.type` | `discount.value`, 3>>;
 }
-declare function updateSubscriptionOption$1(httpClient: HttpClient): UpdateSubscriptionOptionSignature;
+declare function updateSubscriptionOption$1(httpClient: HttpClient, __options?: {
+    validateRequestSchema?: boolean;
+}): UpdateSubscriptionOptionSignature;
 interface UpdateSubscriptionOptionSignature {
     /**
      * Updates a subscription option.
@@ -66,7 +30,9 @@ interface UpdateSubscriptionOptionSignature {
      */
     (_id: string, subscriptionOption: UpdateSubscriptionOption): Promise<NonNullablePaths<SubscriptionOption, `subscriptionSettings.frequency` | `subscriptionSettings.autoRenewal` | `discount.type` | `discount.value`, 3>>;
 }
-declare function deleteSubscriptionOption$1(httpClient: HttpClient): DeleteSubscriptionOptionSignature;
+declare function deleteSubscriptionOption$1(httpClient: HttpClient, __options?: {
+    validateRequestSchema?: boolean;
+}): DeleteSubscriptionOptionSignature;
 interface DeleteSubscriptionOptionSignature {
     /**
      * Deletes a subscription option.
@@ -75,7 +41,9 @@ interface DeleteSubscriptionOptionSignature {
      */
     (_id: string): Promise<void>;
 }
-declare function bulkCreateSubscriptionOptions$1(httpClient: HttpClient): BulkCreateSubscriptionOptionsSignature;
+declare function bulkCreateSubscriptionOptions$1(httpClient: HttpClient, __options?: {
+    validateRequestSchema?: boolean;
+}): BulkCreateSubscriptionOptionsSignature;
 interface BulkCreateSubscriptionOptionsSignature {
     /**
      * Creates multiple subscription options (up to 100).
@@ -86,7 +54,9 @@ interface BulkCreateSubscriptionOptionsSignature {
      */
     (subscriptionOptions: NonNullablePaths<SubscriptionOption, `subscriptionSettings` | `title`, 2>[]): Promise<NonNullablePaths<BulkCreateSubscriptionOptionsResponse, `subscriptionOptions` | `subscriptionOptions.${number}.subscriptionSettings.frequency` | `subscriptionOptions.${number}.subscriptionSettings.autoRenewal` | `subscriptionOptions.${number}.discount.type` | `subscriptionOptions.${number}.discount.value`, 5>>;
 }
-declare function bulkUpdateSubscriptionOptions$1(httpClient: HttpClient): BulkUpdateSubscriptionOptionsSignature;
+declare function bulkUpdateSubscriptionOptions$1(httpClient: HttpClient, __options?: {
+    validateRequestSchema?: boolean;
+}): BulkUpdateSubscriptionOptionsSignature;
 interface BulkUpdateSubscriptionOptionsSignature {
     /**
      * Updates multiple subscription options.
@@ -96,7 +66,9 @@ interface BulkUpdateSubscriptionOptionsSignature {
      */
     (subscriptionOptions: NonNullablePaths<SubscriptionOption, `_id`, 2>[]): Promise<NonNullablePaths<BulkUpdateSubscriptionOptionsResponse, `subscriptionOptions` | `subscriptionOptions.${number}.subscriptionSettings.frequency` | `subscriptionOptions.${number}.subscriptionSettings.autoRenewal` | `subscriptionOptions.${number}.discount.type` | `subscriptionOptions.${number}.discount.value`, 5>>;
 }
-declare function bulkDeleteSubscriptionOptions$1(httpClient: HttpClient): BulkDeleteSubscriptionOptionsSignature;
+declare function bulkDeleteSubscriptionOptions$1(httpClient: HttpClient, __options?: {
+    validateRequestSchema?: boolean;
+}): BulkDeleteSubscriptionOptionsSignature;
 interface BulkDeleteSubscriptionOptionsSignature {
     /**
      * Deletes multiple subscription options.
@@ -105,7 +77,9 @@ interface BulkDeleteSubscriptionOptionsSignature {
      */
     (ids: string[]): Promise<void>;
 }
-declare function assignSubscriptionOptionsToProduct$1(httpClient: HttpClient): AssignSubscriptionOptionsToProductSignature;
+declare function assignSubscriptionOptionsToProduct$1(httpClient: HttpClient, __options?: {
+    validateRequestSchema?: boolean;
+}): AssignSubscriptionOptionsToProductSignature;
 interface AssignSubscriptionOptionsToProductSignature {
     /**
      * Assign up to 6 subscription options to a specified product.
@@ -116,7 +90,9 @@ interface AssignSubscriptionOptionsToProductSignature {
      */
     (productId: string, options?: AssignSubscriptionOptionsToProductOptions): Promise<void>;
 }
-declare function allowOneTimePurchases$1(httpClient: HttpClient): AllowOneTimePurchasesSignature;
+declare function allowOneTimePurchases$1(httpClient: HttpClient, __options?: {
+    validateRequestSchema?: boolean;
+}): AllowOneTimePurchasesSignature;
 interface AllowOneTimePurchasesSignature {
     /**
      * Allow for one-time purchase of a product.
@@ -127,11 +103,55 @@ interface AllowOneTimePurchasesSignature {
      */
     (productId: string, allowed: boolean): Promise<void>;
 }
+declare function getSubscriptionOption$1(httpClient: HttpClient, __options?: {
+    validateRequestSchema?: boolean;
+}): GetSubscriptionOptionSignature;
+interface GetSubscriptionOptionSignature {
+    /**
+     * Retrieves a subscription option by ID.
+     * @param - Subscription option ID.
+     * @returns Subscription option.
+     * @deprecated
+     */
+    (_id: string): Promise<NonNullablePaths<SubscriptionOption, `subscriptionSettings.frequency` | `subscriptionSettings.autoRenewal` | `discount.type` | `discount.value`, 3>>;
+}
+declare function getSubscriptionOptionsForProduct$1(httpClient: HttpClient, __options?: {
+    validateRequestSchema?: boolean;
+}): GetSubscriptionOptionsForProductSignature;
+interface GetSubscriptionOptionsForProductSignature {
+    /**
+     * Retrieves all subscription options assigned to a specified product.
+     * By default, hidden subscription options are not returned. To retrieve all subscription options you must pass `includeHiddenSubscriptionOptions = true`.
+     * @param - Product ID.
+     * @param - Options.
+     * @deprecated
+     */
+    (productId: string, options?: GetSubscriptionOptionsForProductOptions): Promise<NonNullablePaths<GetSubscriptionOptionsForProductResponse, `subscriptionOptions` | `subscriptionOptions.${number}._id` | `subscriptionOptions.${number}.hidden` | `subscriptionOptions.${number}.subscriptionSettings.frequency` | `subscriptionOptions.${number}.subscriptionSettings.autoRenewal` | `subscriptionOptions.${number}.discount.type` | `subscriptionOptions.${number}.discount.value`, 5>>;
+}
+declare function getProductIdsForSubscriptionOption$1(httpClient: HttpClient, __options?: {
+    validateRequestSchema?: boolean;
+}): GetProductIdsForSubscriptionOptionSignature;
+interface GetProductIdsForSubscriptionOptionSignature {
+    /**
+     * Retrieves the IDs of products associated with a specified subscription option.
+     * @param - Subscription option ID.
+     * @param - Paging and other options.
+     * @deprecated
+     */
+    (_id: string, options?: GetProductIdsForSubscriptionOptionOptions): Promise<NonNullablePaths<GetProductIdsForSubscriptionOptionResponse, `productIds` | `metadata.items` | `metadata.offset` | `totalResults`, 3>>;
+}
+declare function getOneTimePurchasesStatus$1(httpClient: HttpClient, __options?: {
+    validateRequestSchema?: boolean;
+}): GetOneTimePurchasesStatusSignature;
+interface GetOneTimePurchasesStatusSignature {
+    /**
+     * Checks whether a specified product (associated with subscription options) is available for one-time purchase.
+     * @param - Product ID.
+     * @deprecated
+     */
+    (productId: string): Promise<NonNullablePaths<GetOneTimePurchasesStatusResponse, `allowed`, 2>>;
+}
 
-declare const getSubscriptionOption: MaybeContext<BuildRESTFunction<typeof getSubscriptionOption$1> & typeof getSubscriptionOption$1>;
-declare const getSubscriptionOptionsForProduct: MaybeContext<BuildRESTFunction<typeof getSubscriptionOptionsForProduct$1> & typeof getSubscriptionOptionsForProduct$1>;
-declare const getProductIdsForSubscriptionOption: MaybeContext<BuildRESTFunction<typeof getProductIdsForSubscriptionOption$1> & typeof getProductIdsForSubscriptionOption$1>;
-declare const getOneTimePurchasesStatus: MaybeContext<BuildRESTFunction<typeof getOneTimePurchasesStatus$1> & typeof getOneTimePurchasesStatus$1>;
 declare const createSubscriptionOption: MaybeContext<BuildRESTFunction<typeof createSubscriptionOption$1> & typeof createSubscriptionOption$1>;
 declare const updateSubscriptionOption: MaybeContext<BuildRESTFunction<typeof updateSubscriptionOption$1> & typeof updateSubscriptionOption$1>;
 declare const deleteSubscriptionOption: MaybeContext<BuildRESTFunction<typeof deleteSubscriptionOption$1> & typeof deleteSubscriptionOption$1>;
@@ -140,5 +160,9 @@ declare const bulkUpdateSubscriptionOptions: MaybeContext<BuildRESTFunction<type
 declare const bulkDeleteSubscriptionOptions: MaybeContext<BuildRESTFunction<typeof bulkDeleteSubscriptionOptions$1> & typeof bulkDeleteSubscriptionOptions$1>;
 declare const assignSubscriptionOptionsToProduct: MaybeContext<BuildRESTFunction<typeof assignSubscriptionOptionsToProduct$1> & typeof assignSubscriptionOptionsToProduct$1>;
 declare const allowOneTimePurchases: MaybeContext<BuildRESTFunction<typeof allowOneTimePurchases$1> & typeof allowOneTimePurchases$1>;
+declare const getSubscriptionOption: MaybeContext<BuildRESTFunction<typeof getSubscriptionOption$1> & typeof getSubscriptionOption$1>;
+declare const getSubscriptionOptionsForProduct: MaybeContext<BuildRESTFunction<typeof getSubscriptionOptionsForProduct$1> & typeof getSubscriptionOptionsForProduct$1>;
+declare const getProductIdsForSubscriptionOption: MaybeContext<BuildRESTFunction<typeof getProductIdsForSubscriptionOption$1> & typeof getProductIdsForSubscriptionOption$1>;
+declare const getOneTimePurchasesStatus: MaybeContext<BuildRESTFunction<typeof getOneTimePurchasesStatus$1> & typeof getOneTimePurchasesStatus$1>;
 
 export { AssignSubscriptionOptionsToProductOptions, BulkCreateSubscriptionOptionsResponse, BulkUpdateSubscriptionOptionsResponse, GetOneTimePurchasesStatusResponse, GetProductIdsForSubscriptionOptionOptions, GetProductIdsForSubscriptionOptionResponse, GetSubscriptionOptionsForProductOptions, GetSubscriptionOptionsForProductResponse, SubscriptionOption, UpdateSubscriptionOption, allowOneTimePurchases, assignSubscriptionOptionsToProduct, bulkCreateSubscriptionOptions, bulkDeleteSubscriptionOptions, bulkUpdateSubscriptionOptions, createSubscriptionOption, deleteSubscriptionOption, getOneTimePurchasesStatus, getProductIdsForSubscriptionOption, getSubscriptionOption, getSubscriptionOptionsForProduct, updateSubscriptionOption };