@wix/auto_sdk_stores_subscription-options 1.0.16 → 1.0.18

package/build/cjs/{stores-v1-subscription-option-subscription-options.universal-CvhCuWKj.d.ts → index.typings.d.ts}

@@ -1,3 +1,5 @@
+import { NonNullablePaths } from '@wix/sdk-types';
+
 interface SubscriptionOption {
     /**
      * Subscription option ID (auto-generated upon subscription option creation).
@@ -356,16 +358,102 @@ interface AllowOneTimePurchasesRequest {
 }
 interface AllowOneTimePurchasesResponse {
 }
+type SubscriptionOptionNonNullablePaths = `subscriptionSettings.frequency` | `subscriptionSettings.autoRenewal` | `discount.type` | `discount.value`;
+/**
+ * Retrieves a subscription option by ID.
+ * @param _id - Subscription option ID.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ * @permissionId WIX_STORES.READ_SUBSCRIPTION_OPTIONS
+ * @applicableIdentity APP
+ * @returns Subscription option.
+ * @fqn wix.ecommerce.subscription.option.api.v1.SubscriptionOptionsReadApi.GetSubscriptionOption
+ * @deprecated
+ */
+declare function getSubscriptionOption(_id: string): Promise<NonNullablePaths<SubscriptionOption, SubscriptionOptionNonNullablePaths>>;
+/**
+ * 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 productId - Product ID.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField productId
+ * @param options - Options.
+ * @permissionId WIX_STORES.READ_SUBSCRIPTION_OPTIONS
+ * @applicableIdentity APP
+ * @fqn wix.ecommerce.subscription.option.api.v1.SubscriptionOptionsReadApi.GetSubscriptionOptionsForProduct
+ * @deprecated
+ */
+declare function getSubscriptionOptionsForProduct(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`>>;
 interface GetSubscriptionOptionsForProductOptions {
     /** Whether to include hidden subscription options in the results. */
     includeHiddenSubscriptionOptions?: boolean;
 }
+/**
+ * Retrieves the IDs of products associated with a specified subscription option.
+ * @param _id - Subscription option ID.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ * @param options - Paging and other options.
+ * @permissionId WIX_STORES.READ_SUBSCRIPTION_OPTIONS
+ * @applicableIdentity APP
+ * @fqn wix.ecommerce.subscription.option.api.v1.SubscriptionOptionsReadApi.GetProductIdsForSubscriptionOption
+ * @deprecated
+ */
+declare function getProductIdsForSubscriptionOption(_id: string, options?: GetProductIdsForSubscriptionOptionOptions): Promise<NonNullablePaths<GetProductIdsForSubscriptionOptionResponse, `productIds` | `metadata.items` | `metadata.offset` | `totalResults`>>;
 interface GetProductIdsForSubscriptionOptionOptions {
     /** Whether to include hidden products in the returned results. */
     includeHiddenProducts?: boolean;
     /** Optional pagination parameters */
     paging?: Paging;
 }
+/**
+ * Checks whether a specified product (associated with subscription options) is available for one-time purchase.
+ * @param productId - Product ID.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField productId
+ * @permissionId WIX_STORES.READ_SUBSCRIPTION_OPTIONS
+ * @applicableIdentity APP
+ * @fqn wix.ecommerce.subscription.option.api.v1.SubscriptionOptionsReadApi.GetOneTimePurchasesStatus
+ * @deprecated
+ */
+declare function getOneTimePurchasesStatus(productId: string): Promise<NonNullablePaths<GetOneTimePurchasesStatusResponse, `allowed`>>;
+/**
+ * Creates a subscription option.
+ * To assign to a product, call [`assignSubscriptionOptionsToProduct()`](https://www.wix.com/velo/reference/wix-stores-v2/subscriptionoptions/assign-subscription-options-to-product).
+ * Subscription options that are not assigned to a product will not be visible in the Wix business manager.
+ * @param subscriptionOption - Subscription option info.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField subscriptionOption
+ * @requiredField subscriptionOption.subscriptionSettings
+ * @requiredField subscriptionOption.title
+ * @permissionId WIX_STORES.MODIFY_SUBSCRIPTION_OPTIONS
+ * @applicableIdentity APP
+ * @returns Newly created subscription option.
+ * @fqn wix.ecommerce.subscription.option.api.v1.SubscriptionOptionsWriteApi.CreateSubscriptionOption
+ * @deprecated
+ */
+declare function createSubscriptionOption(subscriptionOption: NonNullablePaths<SubscriptionOption, `subscriptionSettings` | `title`>): Promise<NonNullablePaths<SubscriptionOption, SubscriptionOptionNonNullablePaths>>;
+/**
+ * Updates a subscription option.
+ * Only parameters passed will be updated.
+ * @param _id - Subscription option ID (auto-generated upon subscription option creation).
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ * @requiredField subscriptionOption
+ * @param subscriptionOption - Subscription option update options.
+ * @permissionId WIX_STORES.MODIFY_SUBSCRIPTION_OPTIONS
+ * @applicableIdentity APP
+ * @returns Updated subscription option.
+ * @fqn wix.ecommerce.subscription.option.api.v1.SubscriptionOptionsWriteApi.UpdateSubscriptionOption
+ * @deprecated
+ */
+declare function updateSubscriptionOption(_id: string, subscriptionOption: UpdateSubscriptionOption): Promise<NonNullablePaths<SubscriptionOption, SubscriptionOptionNonNullablePaths>>;
 interface UpdateSubscriptionOption {
     /**
      * Subscription option ID (auto-generated upon subscription option creation).
@@ -391,6 +479,78 @@ interface UpdateSubscriptionOption {
      */
     discount?: Discount;
 }
+/**
+ * Deletes a subscription option.
+ * @param _id - ID of the subscription option to delete.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ * @permissionId WIX_STORES.MODIFY_SUBSCRIPTION_OPTIONS
+ * @applicableIdentity APP
+ * @fqn wix.ecommerce.subscription.option.api.v1.SubscriptionOptionsWriteApi.DeleteSubscriptionOption
+ * @deprecated
+ */
+declare function deleteSubscriptionOption(_id: string): Promise<void>;
+/**
+ * Creates multiple subscription options (up to 100).
+ * To assign to a product, call [`assignSubscriptionOptionsToProduct()`](https://www.wix.com/velo/reference/wix-stores-v2/subscriptionoptions/assign-subscription-options-to-product).
+ * Subscription options that are not assigned to a product will not be visible in the Wix business manager.
+ * @param subscriptionOptions - Subscription options info.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField subscriptionOptions
+ * @requiredField subscriptionOptions.subscriptionSettings
+ * @requiredField subscriptionOptions.title
+ * @permissionId WIX_STORES.MODIFY_SUBSCRIPTION_OPTIONS
+ * @applicableIdentity APP
+ * @fqn wix.ecommerce.subscription.option.api.v1.SubscriptionOptionsWriteApi.BulkCreateSubscriptionOptions
+ * @deprecated
+ */
+declare function bulkCreateSubscriptionOptions(subscriptionOptions: NonNullablePaths<SubscriptionOption, `subscriptionSettings` | `title`>[]): Promise<NonNullablePaths<BulkCreateSubscriptionOptionsResponse, {
+    [P in SubscriptionOptionNonNullablePaths]: `subscriptionOptions.${number}.${P}`;
+}[SubscriptionOptionNonNullablePaths]>>;
+/**
+ * Updates multiple subscription options.
+ * Only parameters passed will be updated.
+ * @param subscriptionOptions - Subscription options info. Only the passed parameters in each subscription option will be updated.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField subscriptionOptions
+ * @requiredField subscriptionOptions._id
+ * @permissionId WIX_STORES.MODIFY_SUBSCRIPTION_OPTIONS
+ * @applicableIdentity APP
+ * @fqn wix.ecommerce.subscription.option.api.v1.SubscriptionOptionsWriteApi.BulkUpdateSubscriptionOptions
+ * @deprecated
+ */
+declare function bulkUpdateSubscriptionOptions(subscriptionOptions: NonNullablePaths<SubscriptionOption, `_id`>[]): Promise<NonNullablePaths<BulkUpdateSubscriptionOptionsResponse, {
+    [P in SubscriptionOptionNonNullablePaths]: `subscriptionOptions.${number}.${P}`;
+}[SubscriptionOptionNonNullablePaths]>>;
+/**
+ * Deletes multiple subscription options.
+ * @param ids - IDs of the subscription options to delete.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField ids
+ * @permissionId WIX_STORES.MODIFY_SUBSCRIPTION_OPTIONS
+ * @applicableIdentity APP
+ * @fqn wix.ecommerce.subscription.option.api.v1.SubscriptionOptionsWriteApi.BulkDeleteSubscriptionOptions
+ * @deprecated
+ */
+declare function bulkDeleteSubscriptionOptions(ids: string[]): Promise<void>;
+/**
+ * Assign up to 6 subscription options to a specified product.
+ * Pass an empty array to remove all subscription options assigned to a product.
+ * @param productId - Product ID.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField productId
+ * @param options - Subscription option assignment options.
+ * @permissionId WIX_STORES.MODIFY_SUBSCRIPTION_OPTIONS
+ * @applicableIdentity APP
+ * @fqn wix.ecommerce.subscription.option.api.v1.SubscriptionOptionsWriteApi.AssignSubscriptionOptionsToProduct
+ * @deprecated
+ */
+declare function assignSubscriptionOptionsToProduct(productId: string, options?: AssignSubscriptionOptionsToProductOptions): Promise<void>;
 interface AssignSubscriptionOptionsToProductOptions {
     /**
      * Ordered array of subscription options that will be assigned to the product. Pass an empty array to remove all subscription options from the product.
@@ -398,5 +558,20 @@ interface AssignSubscriptionOptionsToProductOptions {
      */
     assignedSubscriptionOptions?: SubscriptionOptionInProduct[];
 }
+/**
+ * Allow for one-time purchase of a product.
+ * By default, product can be sold only as part of a subscription, not as a one-time purchase.
+ * @param productId - Product ID.
+ * @param allowed - Pass `true` to offer product by subscription and as one-time purchase. Pass `false` to offer product as subscription only.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField allowed
+ * @requiredField productId
+ * @permissionId WIX_STORES.MODIFY_SUBSCRIPTION_OPTIONS
+ * @applicableIdentity APP
+ * @fqn wix.ecommerce.subscription.option.api.v1.SubscriptionOptionsWriteApi.AllowOneTimePurchases
+ * @deprecated
+ */
+declare function allowOneTimePurchases(productId: string, allowed: boolean): Promise<void>;
 
-export { type AssignSubscriptionOptionsToProductOptions as A, type BulkCreateSubscriptionOptionsResponse as B, type CalculatePricesRequest as C, DiscountType as D, type CreateSubscriptionOptionResponse as E, type UpdateSubscriptionOptionRequest as F, type GetSubscriptionOptionsForProductOptions as G, type UpdateSubscriptionOptionResponse as H, type DeleteSubscriptionOptionRequest as I, type DeleteSubscriptionOptionResponse as J, type BulkCreateSubscriptionOptionsRequest as K, type ListSubscriptionOptionsRequest as L, type BulkUpdateSubscriptionOptionsRequest as M, type BulkDeleteSubscriptionOptionsRequest as N, type BulkDeleteSubscriptionOptionsResponse as O, type Paging as P, type AssignSubscriptionOptionsToProductRequest as Q, type AssignSubscriptionOptionsToProductResponse as R, type SubscriptionOption as S, type AllowOneTimePurchasesRequest as T, type UpdateSubscriptionOption as U, type AllowOneTimePurchasesResponse as V, type GetSubscriptionOptionsForProductResponse as a, type GetProductIdsForSubscriptionOptionOptions as b, type GetProductIdsForSubscriptionOptionResponse as c, type GetOneTimePurchasesStatusResponse as d, type BulkUpdateSubscriptionOptionsResponse as e, SubscriptionFrequency as f, type SubscriptionSettings as g, type Discount as h, type GetSubscriptionOptionRequest as i, type GetSubscriptionOptionResponse as j, type GetSubscriptionOptionsForProductRequest as k, type SubscriptionOptionInProduct as l, type ListSubscriptionOptionsResponse as m, type CalculatePricesResponse as n, type SubscriptionOptionPrices as o, type SubscriptionOptionPriceData as p, type BulkCalculatePricesRequest as q, type BulkCalculatePricesResponse as r, type BulkCalculatePricesRequestV2 as s, type BulkCalculatePricesRequestItem as t, type BulkCalculatePricesResponseV2 as u, type BulkCalculatePricesResponseItem as v, type GetProductIdsForSubscriptionOptionRequest as w, type PagingMetadata as x, type GetOneTimePurchasesStatusRequest as y, type CreateSubscriptionOptionRequest as z };
+export { type AllowOneTimePurchasesRequest, type AllowOneTimePurchasesResponse, type AssignSubscriptionOptionsToProductOptions, type AssignSubscriptionOptionsToProductRequest, type AssignSubscriptionOptionsToProductResponse, type BulkCalculatePricesRequest, type BulkCalculatePricesRequestItem, type BulkCalculatePricesRequestV2, type BulkCalculatePricesResponse, type BulkCalculatePricesResponseItem, type BulkCalculatePricesResponseV2, type BulkCreateSubscriptionOptionsRequest, type BulkCreateSubscriptionOptionsResponse, type BulkDeleteSubscriptionOptionsRequest, type BulkDeleteSubscriptionOptionsResponse, type BulkUpdateSubscriptionOptionsRequest, type BulkUpdateSubscriptionOptionsResponse, type CalculatePricesRequest, type CalculatePricesResponse, type CreateSubscriptionOptionRequest, type CreateSubscriptionOptionResponse, type DeleteSubscriptionOptionRequest, type DeleteSubscriptionOptionResponse, type Discount, DiscountType, type DiscountTypeWithLiterals, type GetOneTimePurchasesStatusRequest, type GetOneTimePurchasesStatusResponse, type GetProductIdsForSubscriptionOptionOptions, type GetProductIdsForSubscriptionOptionRequest, type GetProductIdsForSubscriptionOptionResponse, type GetSubscriptionOptionRequest, type GetSubscriptionOptionResponse, type GetSubscriptionOptionsForProductOptions, type GetSubscriptionOptionsForProductRequest, type GetSubscriptionOptionsForProductResponse, type ListSubscriptionOptionsRequest, type ListSubscriptionOptionsResponse, type Paging, type PagingMetadata, SubscriptionFrequency, type SubscriptionFrequencyWithLiterals, type SubscriptionOption, type SubscriptionOptionInProduct, type SubscriptionOptionPriceData, type SubscriptionOptionPrices, type SubscriptionSettings, type UpdateSubscriptionOption, type UpdateSubscriptionOptionRequest, type UpdateSubscriptionOptionResponse, allowOneTimePurchases, assignSubscriptionOptionsToProduct, bulkCreateSubscriptionOptions, bulkDeleteSubscriptionOptions, bulkUpdateSubscriptionOptions, createSubscriptionOption, deleteSubscriptionOption, getOneTimePurchasesStatus, getProductIdsForSubscriptionOption, getSubscriptionOption, getSubscriptionOptionsForProduct, updateSubscriptionOption };