@wix/auto_sdk_stores_subscription-options 1.0.30 → 1.0.32

package/build/internal/es/index.typings.d.mts

@@ -61,75 +61,30 @@ declare enum DiscountType {
 }
 /** @enumType */
 type DiscountTypeWithLiterals = DiscountType | 'UNDEFINED' | 'AMOUNT' | 'PERCENT';
-interface CreateSubscriptionOptionRequest {
-    /** Subscription option info. */
-    subscriptionOption: SubscriptionOption;
-}
-interface CreateSubscriptionOptionResponse {
-    /** Newly created subscription option. */
-    subscriptionOption?: SubscriptionOption;
-}
-interface UpdateSubscriptionOptionRequest {
-    /** Subscription option info. Only the passed parameters will be updated. */
-    subscriptionOption: SubscriptionOption;
-}
-interface UpdateSubscriptionOptionResponse {
-    /** Updated subscription option. */
-    subscriptionOption?: SubscriptionOption;
-}
-interface DeleteSubscriptionOptionRequest {
+interface GetSubscriptionOptionRequest {
     /**
-     * ID of the subscription option to delete.
+     * Subscription option ID.
      * @minLength 1
      * @format GUID
      */
     _id: string;
 }
-interface DeleteSubscriptionOptionResponse {
-}
-interface BulkCreateSubscriptionOptionsRequest {
-    /**
-     * Subscription options info.
-     * @maxSize 100
-     */
-    subscriptionOptions: SubscriptionOption[];
-}
-interface BulkCreateSubscriptionOptionsResponse {
-    /** Newly created subscription options. */
-    subscriptionOptions?: SubscriptionOption[];
-}
-interface BulkUpdateSubscriptionOptionsRequest {
-    /**
-     * Subscription options info. Only the passed parameters in each subscription option will be updated.
-     * @maxSize 100
-     */
-    subscriptionOptions: SubscriptionOption[];
-}
-interface BulkUpdateSubscriptionOptionsResponse {
-    /** Updated subscription options. */
-    subscriptionOptions?: SubscriptionOption[];
-}
-interface BulkDeleteSubscriptionOptionsRequest {
-    /**
-     * IDs of the subscription options to delete.
-     * @maxSize 100
-     * @format GUID
-     */
-    ids: string[];
-}
-interface BulkDeleteSubscriptionOptionsResponse {
+interface GetSubscriptionOptionResponse {
+    /** Subscription option. */
+    subscriptionOption?: SubscriptionOption;
 }
-interface AssignSubscriptionOptionsToProductRequest {
+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.
-     * @maxSize 6
-     */
-    assignedSubscriptionOptions?: SubscriptionOptionInProduct[];
+    /** Whether to include hidden subscription options in the results. */
+    includeHiddenSubscriptionOptions?: boolean;
+}
+interface GetSubscriptionOptionsForProductResponse {
+    /** Subscription options. */
+    subscriptionOptions?: SubscriptionOptionInProduct[];
 }
 interface SubscriptionOptionInProduct {
     /**
@@ -163,44 +118,6 @@ interface SubscriptionOptionInProduct {
      */
     discount?: Discount;
 }
-interface AssignSubscriptionOptionsToProductResponse {
-}
-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;
-}
-interface AllowOneTimePurchasesResponse {
-}
-interface GetSubscriptionOptionRequest {
-    /**
-     * Subscription option ID.
-     * @minLength 1
-     * @format GUID
-     */
-    _id: string;
-}
-interface GetSubscriptionOptionResponse {
-    /** Subscription option. */
-    subscriptionOption?: SubscriptionOption;
-}
-interface GetSubscriptionOptionsForProductRequest {
-    /**
-     * Product ID.
-     * @minLength 1
-     */
-    productId: string;
-    /** Whether to include hidden subscription options in the results. */
-    includeHiddenSubscriptionOptions?: boolean;
-}
-interface GetSubscriptionOptionsForProductResponse {
-    /** Subscription options. */
-    subscriptionOptions?: SubscriptionOptionInProduct[];
-}
 interface ListSubscriptionOptionsRequest {
     /**
      * Subscription option IDs.
@@ -358,6 +275,162 @@ interface GetOneTimePurchasesStatusResponse {
     /** Whether the specified product is available for one-time purchase */
     allowed?: boolean;
 }
+interface CreateSubscriptionOptionRequest {
+    /** Subscription option info. */
+    subscriptionOption: SubscriptionOption;
+}
+interface CreateSubscriptionOptionResponse {
+    /** Newly created subscription option. */
+    subscriptionOption?: SubscriptionOption;
+}
+interface UpdateSubscriptionOptionRequest {
+    /** Subscription option info. Only the passed parameters will be updated. */
+    subscriptionOption: SubscriptionOption;
+}
+interface UpdateSubscriptionOptionResponse {
+    /** Updated subscription option. */
+    subscriptionOption?: SubscriptionOption;
+}
+interface DeleteSubscriptionOptionRequest {
+    /**
+     * ID of the subscription option to delete.
+     * @minLength 1
+     * @format GUID
+     */
+    _id: string;
+}
+interface DeleteSubscriptionOptionResponse {
+}
+interface BulkCreateSubscriptionOptionsRequest {
+    /**
+     * Subscription options info.
+     * @maxSize 100
+     */
+    subscriptionOptions: SubscriptionOption[];
+}
+interface BulkCreateSubscriptionOptionsResponse {
+    /** Newly created subscription options. */
+    subscriptionOptions?: SubscriptionOption[];
+}
+interface BulkUpdateSubscriptionOptionsRequest {
+    /**
+     * Subscription options info. Only the passed parameters in each subscription option will be updated.
+     * @maxSize 100
+     */
+    subscriptionOptions: SubscriptionOption[];
+}
+interface BulkUpdateSubscriptionOptionsResponse {
+    /** Updated subscription options. */
+    subscriptionOptions?: SubscriptionOption[];
+}
+interface BulkDeleteSubscriptionOptionsRequest {
+    /**
+     * IDs of the subscription options to delete.
+     * @maxSize 100
+     * @format GUID
+     */
+    ids: string[];
+}
+interface BulkDeleteSubscriptionOptionsResponse {
+}
+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[];
+}
+interface AssignSubscriptionOptionsToProductResponse {
+}
+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;
+}
+interface AllowOneTimePurchasesResponse {
+}
+interface EnableCustomerCancellationRequest {
+    /**
+     * Product ID.
+     * @minLength 1
+     */
+    productId: string;
+    /** Pass `true` to enable cancellation option of plans for the customer, pass `false` to disable it. */
+    allowed: boolean | null;
+}
+interface EnableCustomerCancellationResponse {
+}
+/**
+ * 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, `subscriptionSettings.frequency` | `subscriptionSettings.autoRenewal` | `discount.type` | `discount.value`, 3>>;
+/**
+ * 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`, 5>>;
+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`, 3>>;
+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`, 2>>;
 /**
  * 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).
@@ -507,66 +580,18 @@ interface AssignSubscriptionOptionsToProductOptions {
  */
 declare function allowOneTimePurchases(productId: string, allowed: boolean): Promise<void>;
 /**
- * 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, `subscriptionSettings.frequency` | `subscriptionSettings.autoRenewal` | `discount.type` | `discount.value`, 3>>;
-/**
- * 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`, 5>>;
-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`, 3>>;
-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.
+ * Enable Customer Cancellation option for all subscriptions of a certain product.
  * @param productId - Product ID.
+ * @param allowed - Pass `true` to enable cancellation option of plans for the customer, pass `false` to disable it.
  * @public
  * @documentationMaturity preview
+ * @requiredField allowed
  * @requiredField productId
- * @permissionId WIX_STORES.READ_SUBSCRIPTION_OPTIONS
+ * @permissionId WIX_STORES.MODIFY_SUBSCRIPTION_OPTIONS
  * @applicableIdentity APP
- * @fqn wix.ecommerce.subscription.option.api.v1.SubscriptionOptionsReadApi.GetOneTimePurchasesStatus
+ * @fqn wix.ecommerce.subscription.option.api.v1.SubscriptionOptionsWriteApi.EnableCustomerCancellation
  * @deprecated
  */
-declare function getOneTimePurchasesStatus(productId: string): Promise<NonNullablePaths<GetOneTimePurchasesStatusResponse, `allowed`, 2>>;
+declare function enableCustomerCancellation(productId: string, allowed: boolean): Promise<void>;
 
-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 };
+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 EnableCustomerCancellationRequest, type EnableCustomerCancellationResponse, 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, enableCustomerCancellation, getOneTimePurchasesStatus, getProductIdsForSubscriptionOption, getSubscriptionOption, getSubscriptionOptionsForProduct, updateSubscriptionOption };