@wix/auto_sdk_pricing-plans_plans 1.0.64 → 1.0.66

package/build/cjs/index.d.ts

@@ -1,15 +1,18 @@
-import { HttpClient, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
+import { HttpClient, NonNullablePaths, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
 import { ListPublicPlansOptions, ListPublicPlansResponse, ListPublicPlansApplicationErrors, PlansQueryBuilder, Plan, GetPlanApplicationErrors, ListPlansOptions, ListPlansResponse, ListPlansApplicationErrors, ListPlansValidationErrors, GetPlanStatsResponse, GetPlanStatsApplicationErrors, CreatePlanApplicationErrors, CreatePlanValidationErrors, UpdatePlan, UpdatePlanApplicationErrors, UpdatePlanValidationErrors, SetPlanVisibilityResponse, SetPlanVisibilityApplicationErrors, MakePlanPrimaryResponse, MakePlanPrimaryApplicationErrors, ClearPrimaryApplicationErrors, ArchivePlanResponse, ArchivePlanApplicationErrors, PlanBuyerCanCancelUpdatedEnvelope, PlanCreatedEnvelope, PlanArchivedEnvelope, PlanUpdatedEnvelope } from './index.typings.js';
 export { ActionEvent, ApplicationError, AppliedAt, ArchivePlanRequest, ArchivedFilter, ArrangePlansRequest, ArrangePlansResponse, BaseEventMetadata, BulkActionMetadata, BulkArchivePlanRequest, BulkArchivePlanResponse, BulkPlanResult, BuyerCanCancelUpdated, ClearPrimaryRequest, ClearPrimaryResponse, CountPlansRequest, CountPlansResponse, CreatePlanRequest, CreatePlanResponse, Cursors, DomainEvent, DomainEventBodyOneOf, Duration, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EventMetadata, Fee, FeeConfig, GetPlanRequest, GetPlanResponse, GetPlanStatsRequest, GetPlansPremiumStatusRequest, GetPlansPremiumStatusResponse, IdentificationData, IdentificationDataIdOneOf, ItemMetadata, ListPlansRequest, ListPublicPlansRequest, MakePlanPrimaryRequest, MessageEnvelope, Money, Paging, PagingMetadataV2, PeriodUnit, PlanArchived, PlansQueryResult, Pricing, PricingPricingModelOneOf, PublicFilter, PublicPlan, QueryPublicPlansRequest, QueryPublicPlansResponse, QueryV2, Recurrence, RestoreInfo, SearchPlansRequest, SearchPlansResponse, SetPlanVisibilityRequest, SortOrder, Sorting, StringList, UpdatePlanRequest, UpdatePlanResponse, WebhookIdentityType } from './index.typings.js';
 
+type PlanNonNullablePaths = `_id` | `perks.values` | `pricing.subscription.cycleDuration.unit` | `pricing.price.value` | `pricing.price.currency` | `archived` | `primary` | `hasOrders`;
 declare function listPublicPlans$1(httpClient: HttpClient): ListPublicPlansSignature;
 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
      */
-    (options?: ListPublicPlansOptions | undefined): Promise<ListPublicPlansResponse & {
-        __applicationErrorsType?: ListPublicPlansApplicationErrors | undefined;
+    (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;
     }>;
 }
 declare function queryPublicPlans$1(httpClient: HttpClient): QueryPublicPlansSignature;
@@ -31,6 +34,7 @@ interface QueryPublicPlansSignature {
      * The methods that are chained to `queryPublicPlans()` are applied in the order they are called. For example, if you sort on the `_createdDate` property in ascending order and then on the `_id` property in ascending order, the results are sorted first by the created date of the items and then, if there are multiple results with the same date, the items are sorted by `_id` in ascending order, per created date value.
      *
      * The following `PublicPlansQueryBuilder` methods are supported for the `queryPublicPlans()` method. For a full description of the Plans object, see the object returned for the [`items`](#plansqueryresult/items) property in [`PublicPlansQueryResult`](#plansqueryresult).
+     * @deprecated
      */
     (): PlansQueryBuilder;
 }
@@ -40,29 +44,36 @@ interface GetPlanSignature {
      * Retrieves a pricing plan by ID.
      * @param - Plan ID.
      * @returns Pricing plan.
+     * @deprecated
      */
-    (_id: string): Promise<Plan & {
-        __applicationErrorsType?: GetPlanApplicationErrors | undefined;
+    (_id: string): Promise<NonNullablePaths<Plan, PlanNonNullablePaths> & {
+        __applicationErrorsType?: GetPlanApplicationErrors;
     }>;
 }
 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
      */
-    (options?: ListPlansOptions | undefined): Promise<ListPlansResponse & {
-        __applicationErrorsType?: ListPlansApplicationErrors | undefined;
-        __validationErrorsType?: ListPlansValidationErrors | undefined;
+    (options?: ListPlansOptions): Promise<NonNullablePaths<ListPlansResponse, {
+        [P in PlanNonNullablePaths]: `plans.${number}.${P}`;
+    }[PlanNonNullablePaths]> & {
+        __applicationErrorsType?: ListPlansApplicationErrors;
+        __validationErrorsType?: ListPlansValidationErrors;
     }>;
 }
 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<GetPlanStatsResponse & {
-        __applicationErrorsType?: GetPlanStatsApplicationErrors | undefined;
+    (): Promise<NonNullablePaths<GetPlanStatsResponse, `totalPlans`> & {
+        __applicationErrorsType?: GetPlanStatsApplicationErrors;
     }>;
 }
 declare function createPlan$1(httpClient: HttpClient): CreatePlanSignature;
@@ -75,10 +86,11 @@ interface CreatePlanSignature {
      * Pricing plans are available to the Wix user in the Pricing Plans section in a site's dashboard.
      * @param - Information for the plan being created.
      * @returns Created plan.
+     * @deprecated
      */
-    (plan: Plan): Promise<Plan & {
-        __applicationErrorsType?: CreatePlanApplicationErrors | undefined;
-        __validationErrorsType?: CreatePlanValidationErrors | undefined;
+    (plan: NonNullablePaths<Plan, `name` | `pricing` | `pricing.singlePaymentForDuration.count` | `pricing.subscription.cycleCount` | `pricing.subscription.cycleDuration` | `pricing.subscription.cycleDuration.count`>): Promise<NonNullablePaths<Plan, PlanNonNullablePaths> & {
+        __applicationErrorsType?: CreatePlanApplicationErrors;
+        __validationErrorsType?: CreatePlanValidationErrors;
     }>;
 }
 declare function updatePlan$1(httpClient: HttpClient): UpdatePlanSignature;
@@ -89,10 +101,11 @@ interface UpdatePlanSignature {
      * @param - ID of the plan to update.
      * @param - Options for updating the plan.
      * @returns Updated plan.
+     * @deprecated
      */
-    (_id: string, plan: UpdatePlan): Promise<Plan & {
-        __applicationErrorsType?: UpdatePlanApplicationErrors | undefined;
-        __validationErrorsType?: UpdatePlanValidationErrors | undefined;
+    (_id: string, plan: UpdatePlan): Promise<NonNullablePaths<Plan, PlanNonNullablePaths> & {
+        __applicationErrorsType?: UpdatePlanApplicationErrors;
+        __validationErrorsType?: UpdatePlanValidationErrors;
     }>;
 }
 declare function setPlanVisibility$1(httpClient: HttpClient): SetPlanVisibilitySignature;
@@ -102,47 +115,58 @@ 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.
+     * @deprecated
      */
-    (_id: string, visible: boolean): Promise<SetPlanVisibilityResponse & {
-        __applicationErrorsType?: SetPlanVisibilityApplicationErrors | undefined;
+    (_id: string, visible: boolean): Promise<NonNullablePaths<SetPlanVisibilityResponse, {
+        [P in PlanNonNullablePaths]: `plan.${P}`;
+    }[PlanNonNullablePaths]> & {
+        __applicationErrorsType?: SetPlanVisibilityApplicationErrors;
     }>;
 }
 declare function makePlanPrimary$1(httpClient: HttpClient): MakePlanPrimarySignature;
 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
      */
-    (_id: string): Promise<MakePlanPrimaryResponse & {
-        __applicationErrorsType?: MakePlanPrimaryApplicationErrors | undefined;
+    (_id: string): Promise<NonNullablePaths<MakePlanPrimaryResponse, {
+        [P in PlanNonNullablePaths]: `plan.${P}`;
+    }[PlanNonNullablePaths]> & {
+        __applicationErrorsType?: MakePlanPrimaryApplicationErrors;
     }>;
 }
 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 & {
-        __applicationErrorsType?: ClearPrimaryApplicationErrors | undefined;
+        __applicationErrorsType?: ClearPrimaryApplicationErrors;
     }>;
 }
 declare function archivePlan$1(httpClient: HttpClient): ArchivePlanSignature;
 interface ArchivePlanSignature {
     /**
-     * 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.
      * @param - ID of the active plan to archive.
+     * @deprecated
      */
-    (_id: string): Promise<ArchivePlanResponse & {
-        __applicationErrorsType?: ArchivePlanApplicationErrors | undefined;
+    (_id: string): Promise<NonNullablePaths<ArchivePlanResponse, {
+        [P in PlanNonNullablePaths]: `plan.${P}`;
+    }[PlanNonNullablePaths]> & {
+        __applicationErrorsType?: ArchivePlanApplicationErrors;
     }>;
 }
 declare const onPlanBuyerCanCancelUpdated$1: EventDefinition<PlanBuyerCanCancelUpdatedEnvelope, "wix.pricing_plans.plan_buyer_can_cancel_updated">;
@@ -163,6 +187,7 @@ declare const clearPrimary: MaybeContext<BuildRESTFunction<typeof clearPrimary$1
 declare const archivePlan: MaybeContext<BuildRESTFunction<typeof archivePlan$1> & typeof archivePlan$1>;
 /**
  * Triggered when a plan's `buyerCanCancel` field is updated.
+ * @deprecated
  */
 declare const onPlanBuyerCanCancelUpdated: BuildEventDefinition<typeof onPlanBuyerCanCancelUpdated$1>;
 /**
@@ -171,6 +196,7 @@ declare const onPlanBuyerCanCancelUpdated: BuildEventDefinition<typeof onPlanBuy
 declare const onPlanCreated: BuildEventDefinition<typeof onPlanCreated$1>;
 /**
  * Triggered when a pricing plan is archived.
+ * @deprecated
  */
 declare const onPlanArchived: BuildEventDefinition<typeof onPlanArchived$1>;
 /**