@wix/auto_sdk_pricing-plans_plans 1.0.71 → 1.0.73

package/build/cjs/index.d.ts

@@ -1,15 +1,15 @@
 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';
+export { ActionEvent, ApplicationError, AppliedAt, AppliedAtWithLiterals, ArchivePlanRequest, ArchivedFilter, ArchivedFilterWithLiterals, 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, PeriodUnitWithLiterals, PlanArchived, PlansQueryResult, Pricing, PricingPricingModelOneOf, PublicFilter, PublicFilterWithLiterals, PublicPlan, QueryPublicPlansApplicationErrors, QueryPublicPlansRequest, QueryPublicPlansResponse, QueryPublicPlansValidationErrors, QueryV2, Recurrence, RestoreInfo, SearchPlansRequest, SearchPlansResponse, SetPlanVisibilityRequest, SortOrder, SortOrderWithLiterals, Sorting, StringList, UpdatePlanRequest, UpdatePlanResponse, WebhookIdentityType, WebhookIdentityTypeWithLiterals } 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.
      * @param - Options for filtering and paging the list of public plans.
+     * @deprecated
      */
-    (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`> & {
+    (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;
     }>;
 }
@@ -32,6 +32,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;
 }
@@ -41,8 +42,9 @@ interface GetPlanSignature {
      * Retrieves a pricing plan by ID.
      * @param - Plan ID.
      * @returns Pricing plan.
+     * @deprecated
      */
-    (_id: string): Promise<NonNullablePaths<Plan, PlanNonNullablePaths> & {
+    (_id: string): Promise<NonNullablePaths<Plan, `_id` | `perks.values` | `pricing.subscription.cycleDuration.unit` | `pricing.price.value` | `pricing.price.currency` | `archived` | `primary` | `hasOrders`, 5> & {
         __applicationErrorsType?: GetPlanApplicationErrors;
     }>;
 }
@@ -51,10 +53,9 @@ interface ListPlansSignature {
     /**
      * Retrieves a list of up to 100 pricing plans (including public, hidden, and archived plans).
      * @param - Options for filtering and paging the list of plans.
+     * @deprecated
      */
-    (options?: ListPlansOptions): Promise<NonNullablePaths<ListPlansResponse, {
-        [P in PlanNonNullablePaths]: `plans.${number}.${P}`;
-    }[PlanNonNullablePaths]> & {
+    (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;
     }>;
@@ -63,8 +64,9 @@ 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
      */
-    (): Promise<NonNullablePaths<GetPlanStatsResponse, `totalPlans`> & {
+    (): Promise<NonNullablePaths<GetPlanStatsResponse, `totalPlans`, 2> & {
         __applicationErrorsType?: GetPlanStatsApplicationErrors;
     }>;
 }
@@ -78,8 +80,9 @@ 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: NonNullablePaths<Plan, `name` | `pricing` | `pricing.singlePaymentForDuration.count` | `pricing.subscription.cycleCount` | `pricing.subscription.cycleDuration` | `pricing.subscription.cycleDuration.count`>): Promise<NonNullablePaths<Plan, PlanNonNullablePaths> & {
+    (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;
     }>;
@@ -92,8 +95,9 @@ interface UpdatePlanSignature {
      * @param - ID of the plan to update.
      * @param - Options for updating the plan.
      * @returns Updated plan.
+     * @deprecated
      */
-    (_id: string, plan: UpdatePlan): Promise<NonNullablePaths<Plan, PlanNonNullablePaths> & {
+    (_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;
     }>;
@@ -108,10 +112,9 @@ interface SetPlanVisibilitySignature {
      * @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<NonNullablePaths<SetPlanVisibilityResponse, {
-        [P in PlanNonNullablePaths]: `plan.${P}`;
-    }[PlanNonNullablePaths]> & {
+    (_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;
     }>;
 }
@@ -120,10 +123,9 @@ 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.
      * @param - ID of the pricing plan to set as the primary plan.
+     * @deprecated
      */
-    (_id: string): Promise<NonNullablePaths<MakePlanPrimaryResponse, {
-        [P in PlanNonNullablePaths]: `plan.${P}`;
-    }[PlanNonNullablePaths]> & {
+    (_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;
     }>;
 }
@@ -131,6 +133,7 @@ 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
      */
     (): Promise<void & {
         __applicationErrorsType?: ClearPrimaryApplicationErrors;
@@ -147,10 +150,9 @@ interface ArchivePlanSignature {
      * 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
      */
-    (_id: string): Promise<NonNullablePaths<ArchivePlanResponse, {
-        [P in PlanNonNullablePaths]: `plan.${P}`;
-    }[PlanNonNullablePaths]> & {
+    (_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;
     }>;
 }
@@ -172,6 +174,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>;
 /**
@@ -180,6 +183,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>;
 /**
@@ -188,4 +192,4 @@ declare const onPlanArchived: BuildEventDefinition<typeof onPlanArchived$1>;
  */
 declare const onPlanUpdated: BuildEventDefinition<typeof onPlanUpdated$1>;
 
-export { ArchivePlanResponse, GetPlanStatsResponse, ListPlansOptions, ListPlansResponse, ListPublicPlansOptions, ListPublicPlansResponse, MakePlanPrimaryResponse, Plan, PlanArchivedEnvelope, PlanBuyerCanCancelUpdatedEnvelope, PlanCreatedEnvelope, PlanUpdatedEnvelope, PlansQueryBuilder, SetPlanVisibilityResponse, UpdatePlan, archivePlan, clearPrimary, createPlan, getPlan, getPlanStats, listPlans, listPublicPlans, makePlanPrimary, onPlanArchived, onPlanBuyerCanCancelUpdated, onPlanCreated, onPlanUpdated, queryPublicPlans, setPlanVisibility, updatePlan };
+export { ArchivePlanApplicationErrors, ArchivePlanResponse, ClearPrimaryApplicationErrors, CreatePlanApplicationErrors, CreatePlanValidationErrors, GetPlanApplicationErrors, GetPlanStatsApplicationErrors, GetPlanStatsResponse, ListPlansApplicationErrors, ListPlansOptions, ListPlansResponse, ListPlansValidationErrors, ListPublicPlansApplicationErrors, ListPublicPlansOptions, ListPublicPlansResponse, MakePlanPrimaryApplicationErrors, MakePlanPrimaryResponse, Plan, PlanArchivedEnvelope, PlanBuyerCanCancelUpdatedEnvelope, PlanCreatedEnvelope, PlanUpdatedEnvelope, PlansQueryBuilder, SetPlanVisibilityApplicationErrors, SetPlanVisibilityResponse, UpdatePlan, UpdatePlanApplicationErrors, UpdatePlanValidationErrors, archivePlan, clearPrimary, createPlan, getPlan, getPlanStats, listPlans, listPublicPlans, makePlanPrimary, onPlanArchived, onPlanBuyerCanCancelUpdated, onPlanCreated, onPlanUpdated, queryPublicPlans, setPlanVisibility, updatePlan };