@wix/auto_sdk_pricing-plans_plans 1.0.64 → 1.0.65

package/build/cjs/index.d.ts

@@ -1,15 +1,16 @@
-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.
      * @param - Options for filtering and paging the list of public plans.
      */
-    (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;
@@ -41,8 +42,8 @@ interface GetPlanSignature {
      * @param - Plan ID.
      * @returns Pricing plan.
      */
-    (_id: string): Promise<Plan & {
-        __applicationErrorsType?: GetPlanApplicationErrors | undefined;
+    (_id: string): Promise<NonNullablePaths<Plan, PlanNonNullablePaths> & {
+        __applicationErrorsType?: GetPlanApplicationErrors;
     }>;
 }
 declare function listPlans$1(httpClient: HttpClient): ListPlansSignature;
@@ -51,9 +52,11 @@ 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.
      */
-    (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;
@@ -61,8 +64,8 @@ interface GetPlanStatsSignature {
     /**
      * Gets statistics about the pricing plans. Currently provides only the total number of pricing plans, including archived plans.
      */
-    (): Promise<GetPlanStatsResponse & {
-        __applicationErrorsType?: GetPlanStatsApplicationErrors | undefined;
+    (): Promise<NonNullablePaths<GetPlanStatsResponse, `totalPlans`> & {
+        __applicationErrorsType?: GetPlanStatsApplicationErrors;
     }>;
 }
 declare function createPlan$1(httpClient: HttpClient): CreatePlanSignature;
@@ -76,9 +79,9 @@ interface CreatePlanSignature {
      * @param - Information for the plan being created.
      * @returns Created plan.
      */
-    (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;
@@ -90,9 +93,9 @@ interface UpdatePlanSignature {
      * @param - Options for updating the plan.
      * @returns Updated plan.
      */
-    (_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;
@@ -106,8 +109,10 @@ interface SetPlanVisibilitySignature {
      * @param - The ID of the plan to either display or hide on the site page.
      * @param - Plan visibility options.
      */
-    (_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;
@@ -116,8 +121,10 @@ 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.
      */
-    (_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;
@@ -126,7 +133,7 @@ interface ClearPrimarySignature {
      * Sets all pricing plans as not primary. When viewing pricing plans on a site, no plan is highlighted with a customizable ribbon.
      */
     (): Promise<void & {
-        __applicationErrorsType?: ClearPrimaryApplicationErrors | undefined;
+        __applicationErrorsType?: ClearPrimaryApplicationErrors;
     }>;
 }
 declare function archivePlan$1(httpClient: HttpClient): ArchivePlanSignature;
@@ -141,8 +148,10 @@ interface ArchivePlanSignature {
      * > **Note:** An attempt to archive an already-archived plan throws an error.
      * @param - ID of the active plan to archive.
      */
-    (_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">;