@wix/auto_sdk_pricing-plans_plans 1.0.71 → 1.0.73

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

@@ -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,7 +993,6 @@ interface PlanUpdatedEnvelope {
  * @targetRemovalDate 2025-12-31
  */
 declare function onPlanUpdated(handler: (event: PlanUpdatedEnvelope) => void | Promise<void>): void;
-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.
  * @public
@@ -1000,8 +1001,11 @@ type PlanNonNullablePaths = `_id` | `perks.values` | `pricing.subscription.cycle
  * @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`> & {
+declare function listPublicPlans(options?: ListPublicPlansOptions): Promise<NonNullablePaths<ListPublicPlansResponse, `plans` | `plans.${number}._id` | `plans.${number}.pricing.singlePaymentForDuration.unit` | `plans.${number}.pricing.price.value` | `plans.${number}.pricing.price.currency` | `plans.${number}.primary`, 6> & {
     __applicationErrorsType?: ListPublicPlansApplicationErrors;
 }>;
 interface ListPublicPlansOptions {
@@ -1042,6 +1046,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 {
@@ -1113,8 +1120,11 @@ 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> & {
+declare function getPlan(_id: string): Promise<NonNullablePaths<Plan, `_id` | `perks.values` | `pricing.subscription.cycleDuration.unit` | `pricing.price.value` | `pricing.price.currency` | `archived` | `primary` | `hasOrders`, 5> & {
     __applicationErrorsType?: GetPlanApplicationErrors;
 }>;
 /**
@@ -1124,10 +1134,11 @@ declare function getPlan(_id: string): Promise<NonNullablePaths<Plan, PlanNonNul
  * @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}`;
-}[PlanNonNullablePaths]> & {
+declare function listPlans(options?: ListPlansOptions): Promise<NonNullablePaths<ListPlansResponse, `plans` | `plans.${number}._id` | `plans.${number}.pricing.singlePaymentForDuration.unit` | `plans.${number}.pricing.price.value` | `plans.${number}.pricing.price.currency` | `plans.${number}.archived` | `plans.${number}.primary` | `plans.${number}.hasOrders`, 6> & {
     __applicationErrorsType?: ListPlansApplicationErrors;
     __validationErrorsType?: ListPlansValidationErrors;
 }>;
@@ -1157,8 +1168,11 @@ interface ListPlansOptions {
  * @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`> & {
+declare function getPlanStats(): Promise<NonNullablePaths<GetPlanStatsResponse, `totalPlans`, 2> & {
     __applicationErrorsType?: GetPlanStatsApplicationErrors;
 }>;
 /**
@@ -1181,8 +1195,11 @@ 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> & {
+declare function createPlan(plan: NonNullablePaths<Plan, `name` | `pricing` | `pricing.singlePaymentForDuration.count` | `pricing.subscription.cycleCount` | `pricing.subscription.cycleDuration` | `pricing.subscription.cycleDuration.count`, 5>): Promise<NonNullablePaths<Plan, `_id` | `perks.values` | `pricing.subscription.cycleDuration.unit` | `pricing.price.value` | `pricing.price.currency` | `archived` | `primary` | `hasOrders`, 5> & {
     __applicationErrorsType?: CreatePlanApplicationErrors;
     __validationErrorsType?: CreatePlanValidationErrors;
 }>;
@@ -1198,8 +1215,11 @@ 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> & {
+declare function updatePlan(_id: string, plan: UpdatePlan): Promise<NonNullablePaths<Plan, `_id` | `perks.values` | `pricing.subscription.cycleDuration.unit` | `pricing.price.value` | `pricing.price.currency` | `archived` | `primary` | `hasOrders`, 5> & {
     __applicationErrorsType?: UpdatePlanApplicationErrors;
     __validationErrorsType?: UpdatePlanValidationErrors;
 }>;
@@ -1300,10 +1320,11 @@ 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}`;
-}[PlanNonNullablePaths]> & {
+declare function setPlanVisibility(_id: string, visible: boolean): Promise<NonNullablePaths<SetPlanVisibilityResponse, `plan._id` | `plan.perks.values` | `plan.pricing.subscription.cycleDuration.unit` | `plan.pricing.price.value` | `plan.pricing.price.currency` | `plan.archived` | `plan.primary` | `plan.hasOrders`, 6> & {
     __applicationErrorsType?: SetPlanVisibilityApplicationErrors;
 }>;
 /**
@@ -1314,10 +1335,11 @@ declare function setPlanVisibility(_id: string, visible: boolean): Promise<NonNu
  * @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}`;
-}[PlanNonNullablePaths]> & {
+declare function makePlanPrimary(_id: string): Promise<NonNullablePaths<MakePlanPrimaryResponse, `plan._id` | `plan.perks.values` | `plan.pricing.subscription.cycleDuration.unit` | `plan.pricing.price.value` | `plan.pricing.price.currency` | `plan.archived` | `plan.primary` | `plan.hasOrders`, 6> & {
     __applicationErrorsType?: MakePlanPrimaryApplicationErrors;
 }>;
 /**
@@ -1326,6 +1348,9 @@ declare function makePlanPrimary(_id: string): Promise<NonNullablePaths<MakePlan
  * @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;
@@ -1344,10 +1369,11 @@ declare function clearPrimary(): Promise<void & {
  * @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}`;
-}[PlanNonNullablePaths]> & {
+declare function archivePlan(_id: string): Promise<NonNullablePaths<ArchivePlanResponse, `plan._id` | `plan.perks.values` | `plan.pricing.subscription.cycleDuration.unit` | `plan.pricing.price.value` | `plan.pricing.price.currency` | `plan.archived` | `plan.primary` | `plan.hasOrders`, 6> & {
     __applicationErrorsType?: ArchivePlanApplicationErrors;
 }>;