@wix/auto_sdk_stores_subscription-options 1.0.29 → 1.0.31

package/build/cjs/index.d.ts

@@ -1,47 +1,7 @@
 import { HttpClient, NonNullablePaths, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
-import { SubscriptionOption, GetSubscriptionOptionsForProductOptions, GetSubscriptionOptionsForProductResponse, GetProductIdsForSubscriptionOptionOptions, GetProductIdsForSubscriptionOptionResponse, GetOneTimePurchasesStatusResponse, UpdateSubscriptionOption, BulkCreateSubscriptionOptionsResponse, BulkUpdateSubscriptionOptionsResponse, AssignSubscriptionOptionsToProductOptions } 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';
+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, EnableCustomerCancellationRequest, EnableCustomerCancellationResponse, 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;
 interface CreateSubscriptionOptionSignature {
     /**
@@ -127,11 +87,57 @@ interface AllowOneTimePurchasesSignature {
      */
     (productId: string, allowed: boolean): Promise<void>;
 }
+declare function enableCustomerCancellation$1(httpClient: HttpClient): EnableCustomerCancellationSignature;
+interface EnableCustomerCancellationSignature {
+    /**
+     * Enable Customer Cancellation option for all subscriptions of a certain product.
+     * @param - Product ID.
+     * @param - Pass `true` to enable cancellation option of plans for the customer, pass `false` to disable it.
+     * @deprecated
+     */
+    (productId: string, allowed: boolean): Promise<void>;
+}
+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 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 +146,10 @@ 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 enableCustomerCancellation: MaybeContext<BuildRESTFunction<typeof enableCustomerCancellation$1> & typeof enableCustomerCancellation$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 };
+export { AssignSubscriptionOptionsToProductOptions, BulkCreateSubscriptionOptionsResponse, BulkUpdateSubscriptionOptionsResponse, GetOneTimePurchasesStatusResponse, GetProductIdsForSubscriptionOptionOptions, GetProductIdsForSubscriptionOptionResponse, GetSubscriptionOptionsForProductOptions, GetSubscriptionOptionsForProductResponse, SubscriptionOption, UpdateSubscriptionOption, allowOneTimePurchases, assignSubscriptionOptionsToProduct, bulkCreateSubscriptionOptions, bulkDeleteSubscriptionOptions, bulkUpdateSubscriptionOptions, createSubscriptionOption, deleteSubscriptionOption, enableCustomerCancellation, getOneTimePurchasesStatus, getProductIdsForSubscriptionOption, getSubscriptionOption, getSubscriptionOptionsForProduct, updateSubscriptionOption };