@wix/auto_sdk_pricing-plans_plans 1.0.64 → 1.0.66

package/build/cjs/index.typings.d.ts

@@ -905,6 +905,7 @@ interface PlanBuyerCanCancelUpdatedEnvelope {
  * @eventType wix.pricing_plans.plan_buyer_can_cancel_updated
  * @serviceIdentifier com.wixpress.membership.v2.plans.PlansServiceV2
  * @slug buyer_can_cancel_updated
+ * @deprecated
  */
 declare function onPlanBuyerCanCancelUpdated(handler: (event: PlanBuyerCanCancelUpdatedEnvelope) => void | Promise<void>): void;
 interface PlanCreatedEnvelope {
@@ -959,6 +960,7 @@ interface PlanArchivedEnvelope {
  * @eventType wix.pricing_plans.plan_plan_archived
  * @serviceIdentifier com.wixpress.membership.v2.plans.PlansServiceV2
  * @slug plan_archived
+ * @deprecated
  */
 declare function onPlanArchived(handler: (event: PlanArchivedEnvelope) => void | Promise<void>): void;
 interface PlanUpdatedEnvelope {
@@ -991,12 +993,16 @@ declare function onPlanUpdated(handler: (event: PlanUpdatedEnvelope) => void | P
 type PlanNonNullablePaths = `_id` | `perks.values` | `pricing.subscription.cycleDuration.unit` | `pricing.price.value` | `pricing.price.currency` | `archived` | `primary` | `hasOrders`;
 /**
  * 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.
  * @public
  * @param options - Options for filtering and paging the list of public plans.
  * @permissionId PRICING_PLANS.READ_PUBLIC_PLANS
  * @applicableIdentity APP
  * @applicableIdentity VISITOR
  * @fqn com.wixpress.membership.v2.plans.PlansServiceV2.ListPublicPlans
+ * @deprecated
+ * @replacedBy wix.pricing_plans.plans.v3.PlanService.QueryPlans
+ * @targetRemovalDate 2025-12-31
  */
 declare function listPublicPlans(options?: ListPublicPlansOptions): Promise<NonNullablePaths<ListPublicPlansResponse, `plans` | `plans.${number}._id` | `plans.${number}.pricing.subscription.cycleDuration.unit` | `plans.${number}.pricing.price.value` | `plans.${number}.pricing.price.currency` | `plans.${number}.primary`> & {
     __applicationErrorsType?: ListPublicPlansApplicationErrors;
@@ -1039,6 +1045,9 @@ interface ListPublicPlansOptions {
  * @applicableIdentity APP
  * @applicableIdentity VISITOR
  * @fqn com.wixpress.membership.v2.plans.PlansServiceV2.QueryPublicPlans
+ * @deprecated
+ * @replacedBy wix.pricing_plans.plans.v3.PlanService.QueryPlans
+ * @targetRemovalDate 2025-12-31
  */
 declare function queryPublicPlans(): PlansQueryBuilder;
 interface QueryOffsetResult {
@@ -1110,17 +1119,24 @@ interface PlansQueryBuilder {
  * @applicableIdentity APP
  * @returns Pricing plan.
  * @fqn com.wixpress.membership.v2.plans.PlansServiceV2.GetPlan
+ * @deprecated
+ * @replacedBy wix.pricing_plans.plans.v3.PlanService.GetPlan
+ * @targetRemovalDate 2025-12-31
  */
 declare function getPlan(_id: string): Promise<NonNullablePaths<Plan, PlanNonNullablePaths> & {
     __applicationErrorsType?: GetPlanApplicationErrors;
 }>;
 /**
  * Retrieves a list of up to 100 pricing plans (including public, hidden, and archived plans).
+ * Deprecated: use QueryPlans or SearchPlans instead.
  * @public
  * @param options - Options for filtering and paging the list of plans.
  * @permissionId PRICING_PLANS.READ_PLANS
  * @applicableIdentity APP
  * @fqn com.wixpress.membership.v2.plans.PlansServiceV2.ListPlans
+ * @deprecated
+ * @replacedBy wix.pricing_plans.plans.v3.PlanService.SearchPlans
+ * @targetRemovalDate 2025-12-31
  */
 declare function listPlans(options?: ListPlansOptions): Promise<NonNullablePaths<ListPlansResponse, {
     [P in PlanNonNullablePaths]: `plans.${number}.${P}`;
@@ -1150,10 +1166,14 @@ interface ListPlansOptions {
 }
 /**
  * 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.
  * @public
  * @permissionId PRICING_PLANS.READ_PLANS
  * @applicableIdentity APP
  * @fqn com.wixpress.membership.v2.plans.PlansServiceV2.GetPlanStats
+ * @deprecated
+ * @replacedBy wix.pricing_plans.plans.v3.PlanService.CountPlans
+ * @targetRemovalDate 2025-12-31
  */
 declare function getPlanStats(): Promise<NonNullablePaths<GetPlanStatsResponse, `totalPlans`> & {
     __applicationErrorsType?: GetPlanStatsApplicationErrors;
@@ -1178,6 +1198,9 @@ declare function getPlanStats(): Promise<NonNullablePaths<GetPlanStatsResponse,
  * @applicableIdentity APP
  * @returns Created plan.
  * @fqn com.wixpress.membership.v2.plans.PlansServiceV2.CreatePlan
+ * @deprecated
+ * @replacedBy wix.pricing_plans.plans.v3.PlanService.CreatePlan
+ * @targetRemovalDate 2025-12-31
  */
 declare function createPlan(plan: NonNullablePaths<Plan, `name` | `pricing` | `pricing.singlePaymentForDuration.count` | `pricing.subscription.cycleCount` | `pricing.subscription.cycleDuration` | `pricing.subscription.cycleDuration.count`>): Promise<NonNullablePaths<Plan, PlanNonNullablePaths> & {
     __applicationErrorsType?: CreatePlanApplicationErrors;
@@ -1195,6 +1218,9 @@ declare function createPlan(plan: NonNullablePaths<Plan, `name` | `pricing` | `p
  * @applicableIdentity APP
  * @returns Updated plan.
  * @fqn com.wixpress.membership.v2.plans.PlansServiceV2.UpdatePlan
+ * @deprecated
+ * @replacedBy wix.pricing_plans.plans.v3.PlanService.UpdatePlan
+ * @targetRemovalDate 2025-12-31
  */
 declare function updatePlan(_id: string, plan: UpdatePlan): Promise<NonNullablePaths<Plan, PlanNonNullablePaths> & {
     __applicationErrorsType?: UpdatePlanApplicationErrors;
@@ -1288,6 +1314,7 @@ interface UpdatePlan {
  * 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 visible - Whether a plan is visible to members and site visitors. Updates the `public` field.
  * @public
  * @requiredField _id
@@ -1297,6 +1324,9 @@ interface UpdatePlan {
  * @permissionId PRICING_PLANS.MANAGE_PLANS
  * @applicableIdentity APP
  * @fqn com.wixpress.membership.v2.plans.PlansServiceV2.SetPlanVisibility
+ * @deprecated
+ * @replacedBy wix.pricing_plans.plans.v3.PlanService.UpdatePlan
+ * @targetRemovalDate 2025-12-31
  */
 declare function setPlanVisibility(_id: string, visible: boolean): Promise<NonNullablePaths<SetPlanVisibilityResponse, {
     [P in PlanNonNullablePaths]: `plan.${P}`;
@@ -1305,12 +1335,18 @@ declare function setPlanVisibility(_id: string, visible: boolean): Promise<NonNu
 }>;
 /**
  * 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.
  * @public
  * @requiredField _id
  * @param _id - ID of the pricing plan to set as the primary plan.
  * @permissionId PRICING_PLANS.MANAGE_PLANS
  * @applicableIdentity APP
  * @fqn com.wixpress.membership.v2.plans.PlansServiceV2.MakePlanPrimary
+ * @deprecated
+ * @replacedBy wix.pricing_plans.plans.v3.PlanService.BulkUpdatePlans
+ * @targetRemovalDate 2025-12-31
  */
 declare function makePlanPrimary(_id: string): Promise<NonNullablePaths<MakePlanPrimaryResponse, {
     [P in PlanNonNullablePaths]: `plan.${P}`;
@@ -1319,28 +1355,31 @@ declare function makePlanPrimary(_id: string): Promise<NonNullablePaths<MakePlan
 }>;
 /**
  * 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.
  * @public
  * @permissionId PRICING_PLANS.MANAGE_PLANS
  * @applicableIdentity APP
  * @fqn com.wixpress.membership.v2.plans.PlansServiceV2.ClearPrimary
+ * @deprecated
+ * @replacedBy wix.pricing_plans.plans.v3.PlanService.BulkUpdatePlans
+ * @targetRemovalDate 2025-12-31
  */
 declare function clearPrimary(): Promise<void & {
     __applicationErrorsType?: ClearPrimaryApplicationErrors;
 }>;
 /**
- * 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.
+ * Deprecated: Use UpdatePlan with archived set to true instead.
  * @public
  * @requiredField _id
  * @param _id - ID of the active plan to archive.
  * @permissionId PRICING_PLANS.MANAGE_PLANS
  * @applicableIdentity APP
  * @fqn com.wixpress.membership.v2.plans.PlansServiceV2.ArchivePlan
+ * @deprecated
+ * @replacedBy wix.pricing_plans.plans.v3.PlanService.UpdatePlan
+ * @targetRemovalDate 2025-12-31
  */
 declare function archivePlan(_id: string): Promise<NonNullablePaths<ArchivePlanResponse, {
     [P in PlanNonNullablePaths]: `plan.${P}`;