@wix/auto_sdk_pricing-plans_plans 1.0.0

package/build/cjs/index.d.ts

@@ -0,0 +1 @@
+export * from './src/pricing-plans-v2-plan-plans.context.js';

package/build/cjs/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./src/pricing-plans-v2-plan-plans.context.js"), exports);
+//# sourceMappingURL=index.js.map

package/build/cjs/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,+EAA6D"}

package/build/cjs/index.typings.d.ts

@@ -0,0 +1 @@
+export * from './src/pricing-plans-v2-plan-plans.universal.js';

package/build/cjs/index.typings.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./src/pricing-plans-v2-plan-plans.universal.js"), exports);
+//# sourceMappingURL=index.typings.js.map

package/build/cjs/index.typings.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.typings.js","sourceRoot":"","sources":["../../index.typings.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,iFAA+D"}

package/build/cjs/meta.d.ts

@@ -0,0 +1 @@
+export * from './src/pricing-plans-v2-plan-plans.meta.js';

package/build/cjs/meta.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./src/pricing-plans-v2-plan-plans.meta.js"), exports);
+//# sourceMappingURL=meta.js.map

package/build/cjs/meta.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"meta.js","sourceRoot":"","sources":["../../meta.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,4EAA0D"}

package/build/cjs/src/pricing-plans-v2-plan-plans.context.d.ts

@@ -0,0 +1,36 @@
+import { listPublicPlans as publicListPublicPlans, queryPublicPlans as publicQueryPublicPlans, getPlan as publicGetPlan, listPlans as publicListPlans, getPlanStats as publicGetPlanStats, createPlan as publicCreatePlan, updatePlan as publicUpdatePlan, setPlanVisibility as publicSetPlanVisibility, makePlanPrimary as publicMakePlanPrimary, clearPrimary as publicClearPrimary, archivePlan as publicArchivePlan } from './pricing-plans-v2-plan-plans.public.js';
+import { createEventModule } from '@wix/sdk-runtime/event-definition-modules';
+import { BuildRESTFunction, MaybeContext } from '@wix/sdk-types';
+import { onPlanBuyerCanCancelUpdated as publicOnPlanBuyerCanCancelUpdated } from './pricing-plans-v2-plan-plans.public.js';
+import { onPlanCreated as publicOnPlanCreated } from './pricing-plans-v2-plan-plans.public.js';
+import { onPlanArchived as publicOnPlanArchived } from './pricing-plans-v2-plan-plans.public.js';
+import { onPlanUpdated as publicOnPlanUpdated } from './pricing-plans-v2-plan-plans.public.js';
+export declare const listPublicPlans: MaybeContext<BuildRESTFunction<typeof publicListPublicPlans> & typeof publicListPublicPlans>;
+export declare const queryPublicPlans: MaybeContext<BuildRESTFunction<typeof publicQueryPublicPlans> & typeof publicQueryPublicPlans>;
+export declare const getPlan: MaybeContext<BuildRESTFunction<typeof publicGetPlan> & typeof publicGetPlan>;
+export declare const listPlans: MaybeContext<BuildRESTFunction<typeof publicListPlans> & typeof publicListPlans>;
+export declare const getPlanStats: MaybeContext<BuildRESTFunction<typeof publicGetPlanStats> & typeof publicGetPlanStats>;
+export declare const createPlan: MaybeContext<BuildRESTFunction<typeof publicCreatePlan> & typeof publicCreatePlan>;
+export declare const updatePlan: MaybeContext<BuildRESTFunction<typeof publicUpdatePlan> & typeof publicUpdatePlan>;
+export declare const setPlanVisibility: MaybeContext<BuildRESTFunction<typeof publicSetPlanVisibility> & typeof publicSetPlanVisibility>;
+export declare const makePlanPrimary: MaybeContext<BuildRESTFunction<typeof publicMakePlanPrimary> & typeof publicMakePlanPrimary>;
+export declare const clearPrimary: MaybeContext<BuildRESTFunction<typeof publicClearPrimary> & typeof publicClearPrimary>;
+export declare const archivePlan: MaybeContext<BuildRESTFunction<typeof publicArchivePlan> & typeof publicArchivePlan>;
+/**
+ * Triggered when a plan's `buyerCanCancel` field is updated.
+ */
+export declare const onPlanBuyerCanCancelUpdated: ReturnType<typeof createEventModule<typeof publicOnPlanBuyerCanCancelUpdated>>;
+/**
+ * Triggered when a pricing plan is created.
+ */
+export declare const onPlanCreated: ReturnType<typeof createEventModule<typeof publicOnPlanCreated>>;
+/**
+ * Triggered when a pricing plan is archived.
+ */
+export declare const onPlanArchived: ReturnType<typeof createEventModule<typeof publicOnPlanArchived>>;
+/**
+ * Triggered when a pricing plan is updated.
+ */
+export declare const onPlanUpdated: ReturnType<typeof createEventModule<typeof publicOnPlanUpdated>>;
+export { PeriodUnit, AppliedAt, SortOrder, ArchivedFilter, PublicFilter, WebhookIdentityType, } from './pricing-plans-v2-plan-plans.universal.js';
+export { Plan, StringList, Pricing, PricingPricingModelOneOf, Recurrence, Duration, Money, FeeConfig, Fee, ListPublicPlansRequest, ListPublicPlansResponse, PublicPlan, PagingMetadataV2, Cursors, QueryPublicPlansRequest, QueryV2, Sorting, Paging, QueryPublicPlansResponse, GetPlanRequest, GetPlanResponse, ListPlansRequest, ListPlansResponse, GetPlanStatsRequest, GetPlanStatsResponse, CreatePlanRequest, CreatePlanResponse, UpdatePlanRequest, UpdatePlanResponse, BuyerCanCancelUpdated, SetPlanVisibilityRequest, SetPlanVisibilityResponse, MakePlanPrimaryRequest, MakePlanPrimaryResponse, ClearPrimaryRequest, ClearPrimaryResponse, ArchivePlanRequest, ArchivePlanResponse, PlanArchived, BulkArchivePlanRequest, BulkArchivePlanResponse, BulkPlanResult, ItemMetadata, ApplicationError, BulkActionMetadata, ArrangePlansRequest, ArrangePlansResponse, CountPlansRequest, CountPlansResponse, GetPlansPremiumStatusRequest, GetPlansPremiumStatusResponse, SearchPlansRequest, SearchPlansResponse, DomainEvent, DomainEventBodyOneOf, EntityCreatedEvent, RestoreInfo, EntityUpdatedEvent, EntityDeletedEvent, ActionEvent, MessageEnvelope, IdentificationData, IdentificationDataIdOneOf, ListPublicPlansResponseNonNullableFields, QueryPublicPlansResponseNonNullableFields, PlanNonNullableFields, GetPlanResponseNonNullableFields, ListPlansResponseNonNullableFields, GetPlanStatsResponseNonNullableFields, CreatePlanResponseNonNullableFields, UpdatePlanResponseNonNullableFields, SetPlanVisibilityResponseNonNullableFields, MakePlanPrimaryResponseNonNullableFields, ArchivePlanResponseNonNullableFields, BaseEventMetadata, EventMetadata, PlanBuyerCanCancelUpdatedEnvelope, PlanCreatedEnvelope, PlanArchivedEnvelope, PlanUpdatedEnvelope, ListPublicPlansOptions, PlansQueryResult, PlansQueryBuilder, ListPlansOptions, UpdatePlan, } from './pricing-plans-v2-plan-plans.universal.js';

package/build/cjs/src/pricing-plans-v2-plan-plans.context.js

@@ -0,0 +1,45 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WebhookIdentityType = exports.PublicFilter = exports.ArchivedFilter = exports.SortOrder = exports.AppliedAt = exports.PeriodUnit = exports.onPlanUpdated = exports.onPlanArchived = exports.onPlanCreated = exports.onPlanBuyerCanCancelUpdated = exports.archivePlan = exports.clearPrimary = exports.makePlanPrimary = exports.setPlanVisibility = exports.updatePlan = exports.createPlan = exports.getPlanStats = exports.listPlans = exports.getPlan = exports.queryPublicPlans = exports.listPublicPlans = void 0;
+const pricing_plans_v2_plan_plans_public_js_1 = require("./pricing-plans-v2-plan-plans.public.js");
+const rest_modules_1 = require("@wix/sdk-runtime/rest-modules");
+const event_definition_modules_1 = require("@wix/sdk-runtime/event-definition-modules");
+const pricing_plans_v2_plan_plans_public_js_2 = require("./pricing-plans-v2-plan-plans.public.js");
+const pricing_plans_v2_plan_plans_public_js_3 = require("./pricing-plans-v2-plan-plans.public.js");
+const pricing_plans_v2_plan_plans_public_js_4 = require("./pricing-plans-v2-plan-plans.public.js");
+const pricing_plans_v2_plan_plans_public_js_5 = require("./pricing-plans-v2-plan-plans.public.js");
+exports.listPublicPlans = (0, rest_modules_1.createRESTModule)(pricing_plans_v2_plan_plans_public_js_1.listPublicPlans);
+exports.queryPublicPlans = (0, rest_modules_1.createRESTModule)(pricing_plans_v2_plan_plans_public_js_1.queryPublicPlans);
+exports.getPlan = (0, rest_modules_1.createRESTModule)(pricing_plans_v2_plan_plans_public_js_1.getPlan);
+exports.listPlans = (0, rest_modules_1.createRESTModule)(pricing_plans_v2_plan_plans_public_js_1.listPlans);
+exports.getPlanStats = (0, rest_modules_1.createRESTModule)(pricing_plans_v2_plan_plans_public_js_1.getPlanStats);
+exports.createPlan = (0, rest_modules_1.createRESTModule)(pricing_plans_v2_plan_plans_public_js_1.createPlan);
+exports.updatePlan = (0, rest_modules_1.createRESTModule)(pricing_plans_v2_plan_plans_public_js_1.updatePlan);
+exports.setPlanVisibility = (0, rest_modules_1.createRESTModule)(pricing_plans_v2_plan_plans_public_js_1.setPlanVisibility);
+exports.makePlanPrimary = (0, rest_modules_1.createRESTModule)(pricing_plans_v2_plan_plans_public_js_1.makePlanPrimary);
+exports.clearPrimary = (0, rest_modules_1.createRESTModule)(pricing_plans_v2_plan_plans_public_js_1.clearPrimary);
+exports.archivePlan = (0, rest_modules_1.createRESTModule)(pricing_plans_v2_plan_plans_public_js_1.archivePlan);
+/**
+ * Triggered when a plan's `buyerCanCancel` field is updated.
+ */
+exports.onPlanBuyerCanCancelUpdated = (0, event_definition_modules_1.createEventModule)(pricing_plans_v2_plan_plans_public_js_2.onPlanBuyerCanCancelUpdated);
+/**
+ * Triggered when a pricing plan is created.
+ */
+exports.onPlanCreated = (0, event_definition_modules_1.createEventModule)(pricing_plans_v2_plan_plans_public_js_3.onPlanCreated);
+/**
+ * Triggered when a pricing plan is archived.
+ */
+exports.onPlanArchived = (0, event_definition_modules_1.createEventModule)(pricing_plans_v2_plan_plans_public_js_4.onPlanArchived);
+/**
+ * Triggered when a pricing plan is updated.
+ */
+exports.onPlanUpdated = (0, event_definition_modules_1.createEventModule)(pricing_plans_v2_plan_plans_public_js_5.onPlanUpdated);
+var pricing_plans_v2_plan_plans_universal_js_1 = require("./pricing-plans-v2-plan-plans.universal.js");
+Object.defineProperty(exports, "PeriodUnit", { enumerable: true, get: function () { return pricing_plans_v2_plan_plans_universal_js_1.PeriodUnit; } });
+Object.defineProperty(exports, "AppliedAt", { enumerable: true, get: function () { return pricing_plans_v2_plan_plans_universal_js_1.AppliedAt; } });
+Object.defineProperty(exports, "SortOrder", { enumerable: true, get: function () { return pricing_plans_v2_plan_plans_universal_js_1.SortOrder; } });
+Object.defineProperty(exports, "ArchivedFilter", { enumerable: true, get: function () { return pricing_plans_v2_plan_plans_universal_js_1.ArchivedFilter; } });
+Object.defineProperty(exports, "PublicFilter", { enumerable: true, get: function () { return pricing_plans_v2_plan_plans_universal_js_1.PublicFilter; } });
+Object.defineProperty(exports, "WebhookIdentityType", { enumerable: true, get: function () { return pricing_plans_v2_plan_plans_universal_js_1.WebhookIdentityType; } });
+//# sourceMappingURL=pricing-plans-v2-plan-plans.context.js.map

package/build/cjs/src/pricing-plans-v2-plan-plans.context.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pricing-plans-v2-plan-plans.context.js","sourceRoot":"","sources":["../../../src/pricing-plans-v2-plan-plans.context.ts"],"names":[],"mappings":";;;AAAA,mGAYiD;AACjD,gEAAiE;AACjE,wFAA8E;AAE9E,mGAA2H;AAC3H,mGAA+F;AAC/F,mGAAiG;AACjG,mGAA+F;AAElF,QAAA,eAAe,GAEV,IAAA,+BAAgB,EAAC,uDAAqB,CAAC,CAAC;AAC7C,QAAA,gBAAgB,GAGX,IAAA,+BAAgB,EAAC,wDAAsB,CAAC,CAAC;AAC9C,QAAA,OAAO,GAEF,IAAA,+BAAgB,EAAC,+CAAa,CAAC,CAAC;AACrC,QAAA,SAAS,GAEJ,IAAA,+BAAgB,EAAC,iDAAe,CAAC,CAAC;AACvC,QAAA,YAAY,GAEP,IAAA,+BAAgB,EAAC,oDAAkB,CAAC,CAAC;AAC1C,QAAA,UAAU,GAEL,IAAA,+BAAgB,EAAC,kDAAgB,CAAC,CAAC;AACxC,QAAA,UAAU,GAEL,IAAA,+BAAgB,EAAC,kDAAgB,CAAC,CAAC;AACxC,QAAA,iBAAiB,GAGZ,IAAA,+BAAgB,EAAC,yDAAuB,CAAC,CAAC;AAC/C,QAAA,eAAe,GAEV,IAAA,+BAAgB,EAAC,uDAAqB,CAAC,CAAC;AAC7C,QAAA,YAAY,GAEP,IAAA,+BAAgB,EAAC,oDAAkB,CAAC,CAAC;AAC1C,QAAA,WAAW,GAEN,IAAA,+BAAgB,EAAC,mDAAiB,CAAC,CAAC;AACtD;;GAEG;AACU,QAAA,2BAA2B,GAEpC,IAAA,4CAAiB,EAAC,mEAAiC,CAAC,CAAC;AACzD;;GAEG;AACU,QAAA,aAAa,GAEtB,IAAA,4CAAiB,EAAC,qDAAmB,CAAC,CAAC;AAC3C;;GAEG;AACU,QAAA,cAAc,GAEvB,IAAA,4CAAiB,EAAC,sDAAoB,CAAC,CAAC;AAC5C;;GAEG;AACU,QAAA,aAAa,GAEtB,IAAA,4CAAiB,EAAC,qDAAmB,CAAC,CAAC;AAE3C,uGAOoD;AANlD,sIAAA,UAAU,OAAA;AACV,qIAAA,SAAS,OAAA;AACT,qIAAA,SAAS,OAAA;AACT,0IAAA,cAAc,OAAA;AACd,wIAAA,YAAY,OAAA;AACZ,+IAAA,mBAAmB,OAAA"}

package/build/cjs/src/pricing-plans-v2-plan-plans.http.d.ts

@@ -0,0 +1,62 @@
+import { RequestOptionsFactory } from '@wix/sdk-types';
+/** 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. */
+export declare function listPublicPlans(payload: object): RequestOptionsFactory<any>;
+/**
+ * Creates a query to retrieve a list of public pricing plans.
+ *
+ *
+ * The `queryPublicPlans()` method builds a query to retrieve a list of up to 1,000 public plans and returns a [`PublicPlansQueryBuilder`](#plansquerybuilder) object.
+ *
+ * The returned object contains the query definition which is typically used to run the query using the [`find()`](#plansquerybuilder/find) method.
+ *
+ * You can refine the query by chaining `PublicPlansQueryBuilder` methods onto the query. `PublicPlansQueryBuilder` methods enable you to sort, filter, and control the results that `queryPublicPlans()` returns.
+ *
+ * `queryPublicPlans()` runs with the following `PublicPlansQueryBuilder` defaults that you can override:
+ * - [`skip`](#plansquerybuilder/skip): `0`
+ * - [`limit`](#plansquerybuilder/limit): `50`
+ *
+ * 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).
+ */
+export declare function queryPublicPlans(payload: object): RequestOptionsFactory<any>;
+/** Retrieves a pricing plan by ID. */
+export declare function getPlan(payload: object): RequestOptionsFactory<any>;
+/** Retrieves a list of up to 100 pricing plans (including public, hidden, and archived plans). */
+export declare function listPlans(payload: object): RequestOptionsFactory<any>;
+/** Gets statistics about the pricing plans. Currently provides only the total number of pricing plans, including archived plans. */
+export declare function getPlanStats(payload: object): RequestOptionsFactory<any>;
+/**
+ * Creates a pricing plan. The specified `plan` object must contain a pricing model. A pricing model can be 1 of the following:
+ * - **A subscription**: A subscription with recurring payments and how often the plan occurs. Subscriptions can have free trial days.
+ * - **A plan that doesn't renew**: A single payment for a specific duration that doesn't renew.
+ * - **An unlimited plan**: A single payment for an unlimited amount of time (until canceled).
+ * Pricing plans are available to the Wix user in the Pricing Plans section in a site's dashboard.
+ */
+export declare function createPlan(payload: object): RequestOptionsFactory<any>;
+/**
+ * Updates a pricing plan.
+ * Updating a plan doesn't impact existing orders made for the plan. All orders keep the details of the original plan that was active at the time of purchase.
+ */
+export declare function updatePlan(payload: object): RequestOptionsFactory<any>;
+/**
+ * Sets visibility for pricing plans. Visible plans are considered public plans.
+ * 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.
+ */
+export declare function setPlanVisibility(payload: object): RequestOptionsFactory<any>;
+/** 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. */
+export declare function makePlanPrimary(payload: object): RequestOptionsFactory<any>;
+/** Sets all pricing plans as not primary. When viewing pricing plans on a site, no plan is highlighted with a customizable ribbon. */
+export declare function clearPrimary(payload: object): RequestOptionsFactory<any>;
+/**
+ * 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.
+ */
+export declare function archivePlan(payload: object): RequestOptionsFactory<any>;