@wix/auto_sdk_pricing-plans_plans 1.0.68 → 1.0.70

package/build/cjs/index.d.ts

@@ -7,7 +7,6 @@ declare function listPublicPlans$1(httpClient: HttpClient): ListPublicPlansSigna
 interface ListPublicPlansSignature {
     /**
      * Retrieves a list of up to 100 public pricing plans. Public plans are visible plans that are available to site visitors and can be purchased.
-     * Deprecated: use QueryPlans or SearchPlans with visibility set to PUBLIC and archived set to false in the filter.
      * @param - Options for filtering and paging the list of public plans.
      * @deprecated
      */
@@ -54,7 +53,6 @@ declare function listPlans$1(httpClient: HttpClient): ListPlansSignature;
 interface ListPlansSignature {
     /**
      * Retrieves a list of up to 100 pricing plans (including public, hidden, and archived plans).
-     * Deprecated: use QueryPlans or SearchPlans instead.
      * @param - Options for filtering and paging the list of plans.
      * @deprecated
      */
@@ -69,7 +67,6 @@ declare function getPlanStats$1(httpClient: HttpClient): GetPlanStatsSignature;
 interface GetPlanStatsSignature {
     /**
      * Gets statistics about the pricing plans. Currently provides only the total number of pricing plans, including archived plans.
-     * Deprecated: use CountPlans instead in order to retrieve the total number of pricing plans.
      * @deprecated
      */
     (): Promise<NonNullablePaths<GetPlanStatsResponse, `totalPlans`> & {
@@ -115,7 +112,6 @@ interface SetPlanVisibilitySignature {
      * By default, pricing plans are public, meaning they are visible. Plans can be hidden so that site members and visitors can't choose them.
      * As opposed to archiving, setting visibility can be reversed. This means that a public plan can be hidden, and a hidden plan can be made public (visible). (An archived plan always remains archived and can't be made active again.)
      * Changing a plan’s visibility doesn't impact existing orders for the plan. All orders for hidden plans are still active and keep their perks.
-     * Deprecated: use UpdatePlan with visibility parameter in the request instead.
      * @param - Whether a plan is visible to members and site visitors. Updates the `public` field.
      * @param - The ID of the plan to either display or hide on the site page.
      * @param - Plan visibility options.
@@ -131,9 +127,6 @@ declare function makePlanPrimary$1(httpClient: HttpClient): MakePlanPrimarySigna
 interface MakePlanPrimarySignature {
     /**
      * Marks a pricing plan as the primary pricing plan. When viewing pricing plans on a site, the primary plan is highlighted with a customizable ribbon. Only a single plan can be marked as a primary plan at any given time. If there is an existing plan marked as primary, calling Make Plan Primary causes the existing primary plan to lose its primary status.
-     * Deprecated: Use QueryPlans along with BulkUpdatePlans instead.
-     * First, use QueryPlans with the primary set to true in the filter to retrieve existing plans and identify the primary ones.
-     * Then, use BulkUpdatePlans to set the new plan as primary and remove the primary setting from the existing one.
      * @param - ID of the pricing plan to set as the primary plan.
      * @deprecated
      */
@@ -147,9 +140,6 @@ declare function clearPrimary$1(httpClient: HttpClient): ClearPrimarySignature;
 interface ClearPrimarySignature {
     /**
      * Sets all pricing plans as not primary. When viewing pricing plans on a site, no plan is highlighted with a customizable ribbon.
-     * Deprecated: Use QueryPlans along with BulkUpdatePlans instead.
-     * First, use QueryPlans with the primary set to true in the filter to retrieve existing plans and identify the primary ones.
-     * Then, use BulkUpdatePlans to remove the primary setting from all primary plans.
      * @deprecated
      */
     (): Promise<void & {
@@ -159,7 +149,13 @@ interface ClearPrimarySignature {
 declare function archivePlan$1(httpClient: HttpClient): ArchivePlanSignature;
 interface ArchivePlanSignature {
     /**
-     * Deprecated: Use UpdatePlan with archived set to true instead.
+     * Archives a single plan.
+     * When a plan is archived, it's no longer visible as a public plan that can be chosen by site members or visitors.
+     * This is because the plan's `public` property is automatically set to `false`.
+     * Archived plans can't be purchased or reactivated.
+     * Plan archiving doesn't impact existing orders made for the plan. All orders for the plan are still active and keep their perks, payment options, and terms.
+     * Wix users can see archived plans in a site's dashboard under **Pricing Plans -> Archived Plans**.
+     * > **Note:** An attempt to archive an already-archived plan throws an error.
      * @param - ID of the active plan to archive.
      * @deprecated
      */