@wix/auto_sdk_pricing-plans_plans 1.0.63 → 1.0.65

package/build/cjs/index.d.ts

@@ -1,14 +1,17 @@
-import { HttpClient, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
-import { L as ListPublicPlansOptions, a as ListPublicPlansResponse, P as PlansQueryBuilder, b as Plan, c as ListPlansOptions, d as ListPlansResponse, G as GetPlanStatsResponse, U as UpdatePlan, S as SetPlanVisibilityResponse, M as MakePlanPrimaryResponse, A as ArchivePlanResponse, e as PlanBuyerCanCancelUpdatedEnvelope, f as PlanCreatedEnvelope, g as PlanArchivedEnvelope, h as PlanUpdatedEnvelope } from './pricing-plans-v2-plan-plans.universal-DwvmTikd.js';
-export { aj as ActionEvent, a3 as ApplicationError, j as AppliedAt, Z as ArchivePlanRequest, l as ArchivedFilter, a5 as ArrangePlansRequest, a6 as ArrangePlansResponse, an as BaseEventMetadata, a4 as BulkActionMetadata, $ as BulkArchivePlanRequest, a0 as BulkArchivePlanResponse, a1 as BulkPlanResult, O as BuyerCanCancelUpdated, X as ClearPrimaryRequest, Y as ClearPrimaryResponse, a7 as CountPlansRequest, a8 as CountPlansResponse, I as CreatePlanRequest, J as CreatePlanResponse, C as Cursors, ad as DomainEvent, ae as DomainEventBodyOneOf, D as Duration, af as EntityCreatedEvent, ai as EntityDeletedEvent, ah as EntityUpdatedEvent, ao as EventMetadata, r as Fee, F as FeeConfig, z as GetPlanRequest, B as GetPlanResponse, H as GetPlanStatsRequest, a9 as GetPlansPremiumStatusRequest, aa as GetPlansPremiumStatusResponse, al as IdentificationData, am as IdentificationDataIdOneOf, a2 as ItemMetadata, E as ListPlansRequest, s as ListPublicPlansRequest, V as MakePlanPrimaryRequest, ak as MessageEnvelope, q as Money, x as Paging, u as PagingMetadataV2, i as PeriodUnit, _ as PlanArchived, ap as PlansQueryResult, o as Pricing, p as PricingPricingModelOneOf, m as PublicFilter, t as PublicPlan, Q as QueryPublicPlansRequest, y as QueryPublicPlansResponse, v as QueryV2, R as Recurrence, ag as RestoreInfo, ab as SearchPlansRequest, ac as SearchPlansResponse, T as SetPlanVisibilityRequest, k as SortOrder, w as Sorting, n as StringList, K as UpdatePlanRequest, N as UpdatePlanResponse, W as WebhookIdentityType } from './pricing-plans-v2-plan-plans.universal-DwvmTikd.js';
+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>;
+    (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;
 interface QueryPublicPlansSignature {
@@ -39,7 +42,9 @@ interface GetPlanSignature {
      * @param - Plan ID.
      * @returns Pricing plan.
      */
-    (_id: string): Promise<Plan>;
+    (_id: string): Promise<NonNullablePaths<Plan, PlanNonNullablePaths> & {
+        __applicationErrorsType?: GetPlanApplicationErrors;
+    }>;
 }
 declare function listPlans$1(httpClient: HttpClient): ListPlansSignature;
 interface ListPlansSignature {
@@ -47,14 +52,21 @@ 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>;
+    (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.
      */
-    (): Promise<GetPlanStatsResponse>;
+    (): Promise<NonNullablePaths<GetPlanStatsResponse, `totalPlans`> & {
+        __applicationErrorsType?: GetPlanStatsApplicationErrors;
+    }>;
 }
 declare function createPlan$1(httpClient: HttpClient): CreatePlanSignature;
 interface CreatePlanSignature {
@@ -67,7 +79,10 @@ interface CreatePlanSignature {
      * @param - Information for the plan being created.
      * @returns Created plan.
      */
-    (plan: Plan): Promise<Plan>;
+    (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;
 interface UpdatePlanSignature {
@@ -78,7 +93,10 @@ interface UpdatePlanSignature {
      * @param - Options for updating the plan.
      * @returns Updated plan.
      */
-    (_id: string, plan: UpdatePlan): Promise<Plan>;
+    (_id: string, plan: UpdatePlan): Promise<NonNullablePaths<Plan, PlanNonNullablePaths> & {
+        __applicationErrorsType?: UpdatePlanApplicationErrors;
+        __validationErrorsType?: UpdatePlanValidationErrors;
+    }>;
 }
 declare function setPlanVisibility$1(httpClient: HttpClient): SetPlanVisibilitySignature;
 interface SetPlanVisibilitySignature {
@@ -91,7 +109,11 @@ 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>;
+    (_id: string, visible: boolean): Promise<NonNullablePaths<SetPlanVisibilityResponse, {
+        [P in PlanNonNullablePaths]: `plan.${P}`;
+    }[PlanNonNullablePaths]> & {
+        __applicationErrorsType?: SetPlanVisibilityApplicationErrors;
+    }>;
 }
 declare function makePlanPrimary$1(httpClient: HttpClient): MakePlanPrimarySignature;
 interface MakePlanPrimarySignature {
@@ -99,14 +121,20 @@ 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>;
+    (_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.
      */
-    (): Promise<void>;
+    (): Promise<void & {
+        __applicationErrorsType?: ClearPrimaryApplicationErrors;
+    }>;
 }
 declare function archivePlan$1(httpClient: HttpClient): ArchivePlanSignature;
 interface ArchivePlanSignature {
@@ -120,7 +148,11 @@ 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>;
+    (_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">;
 declare const onPlanCreated$1: EventDefinition<PlanCreatedEnvelope, "wix.pricing_plans.plan_created">;

package/build/cjs/index.js

@@ -740,6 +740,7 @@ async function clearPrimary2() {
   try {
     const result = await httpClient.request(reqOpts);
     sideEffects?.onSuccess?.(result);
+    return (0, import_rename_all_nested_keys.renameKeysFromRESTResponseToSDKResponse)(result.data);
   } catch (err) {
     const transformedError = (0, import_transform_error.transformError)(
       err,