@nizam-os/customer-sdk 6.0.1 → 7.0.0

package/dist/Client.d.ts

@@ -3,6 +3,7 @@ import { FilesClient } from "./api/resources/files/client/Client.js";
 import { LookupsClient } from "./api/resources/lookups/client/Client.js";
 import { NotificationPreferencesClient } from "./api/resources/notificationPreferences/client/Client.js";
 import { NotificationsClient } from "./api/resources/notifications/client/Client.js";
+import { PricingClient } from "./api/resources/pricing/client/Client.js";
 import { RealtimeClient } from "./api/resources/realtime/client/Client.js";
 import { UsersClient } from "./api/resources/users/client/Client.js";
 import type { BaseClientOptions, BaseRequestOptions } from "./BaseClient.js";
@@ -21,6 +22,7 @@ export declare class NizamCustomerClient {
     protected _devices: DevicesClient | undefined;
     protected _notificationPreferences: NotificationPreferencesClient | undefined;
     protected _notifications: NotificationsClient | undefined;
+    protected _pricing: PricingClient | undefined;
     protected _realtime: RealtimeClient | undefined;
     constructor(options: NizamCustomerClient.Options);
     get files(): FilesClient;
@@ -29,6 +31,7 @@ export declare class NizamCustomerClient {
     get devices(): DevicesClient;
     get notificationPreferences(): NotificationPreferencesClient;
     get notifications(): NotificationsClient;
+    get pricing(): PricingClient;
     get realtime(): RealtimeClient;
     /**
      * Make a passthrough request using the SDK's configured auth, retry, logging, etc.

package/dist/Client.js

@@ -40,8 +40,9 @@ const Client_js_2 = require("./api/resources/files/client/Client.js");
 const Client_js_3 = require("./api/resources/lookups/client/Client.js");
 const Client_js_4 = require("./api/resources/notificationPreferences/client/Client.js");
 const Client_js_5 = require("./api/resources/notifications/client/Client.js");
-const Client_js_6 = require("./api/resources/realtime/client/Client.js");
-const Client_js_7 = require("./api/resources/users/client/Client.js");
+const Client_js_6 = require("./api/resources/pricing/client/Client.js");
+const Client_js_7 = require("./api/resources/realtime/client/Client.js");
+const Client_js_8 = require("./api/resources/users/client/Client.js");
 const BaseClient_js_1 = require("./BaseClient.js");
 const core = __importStar(require("./core/index.js"));
 class NizamCustomerClient {
@@ -55,7 +56,7 @@ class NizamCustomerClient {
         return (this._lookups ?? (this._lookups = new Client_js_3.LookupsClient(this._options)));
     }
     get users() {
-        return (this._users ?? (this._users = new Client_js_7.UsersClient(this._options)));
+        return (this._users ?? (this._users = new Client_js_8.UsersClient(this._options)));
     }
     get devices() {
         return (this._devices ?? (this._devices = new Client_js_1.DevicesClient(this._options)));
@@ -66,8 +67,11 @@ class NizamCustomerClient {
     get notifications() {
         return (this._notifications ?? (this._notifications = new Client_js_5.NotificationsClient(this._options)));
     }
+    get pricing() {
+        return (this._pricing ?? (this._pricing = new Client_js_6.PricingClient(this._options)));
+    }
     get realtime() {
-        return (this._realtime ?? (this._realtime = new Client_js_6.RealtimeClient(this._options)));
+        return (this._realtime ?? (this._realtime = new Client_js_7.RealtimeClient(this._options)));
     }
     /**
      * Make a passthrough request using the SDK's configured auth, retry, logging, etc.

package/dist/api/resources/index.d.ts

@@ -9,6 +9,7 @@ export * as notificationPreferences from "./notificationPreferences/index.js";
 export * from "./notifications/client/requests/index.js";
 export * as notifications from "./notifications/index.js";
 export * from "./notifications/types/index.js";
+export * as pricing from "./pricing/index.js";
 export * as realtime from "./realtime/index.js";
 export * from "./users/client/requests/index.js";
 export * as users from "./users/index.js";

package/dist/api/resources/index.js

@@ -36,7 +36,7 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.users = exports.realtime = exports.notifications = exports.notificationPreferences = exports.lookups = exports.files = exports.devices = void 0;
+exports.users = exports.realtime = exports.pricing = exports.notifications = exports.notificationPreferences = exports.lookups = exports.files = exports.devices = void 0;
 __exportStar(require("./devices/client/requests/index.js"), exports);
 exports.devices = __importStar(require("./devices/index.js"));
 __exportStar(require("./files/client/requests/index.js"), exports);
@@ -48,6 +48,7 @@ exports.notificationPreferences = __importStar(require("./notificationPreference
 __exportStar(require("./notifications/client/requests/index.js"), exports);
 exports.notifications = __importStar(require("./notifications/index.js"));
 __exportStar(require("./notifications/types/index.js"), exports);
+exports.pricing = __importStar(require("./pricing/index.js"));
 exports.realtime = __importStar(require("./realtime/index.js"));
 __exportStar(require("./users/client/requests/index.js"), exports);
 exports.users = __importStar(require("./users/index.js"));

package/dist/api/resources/pricing/client/Client.d.ts

@@ -0,0 +1,30 @@
+import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.js";
+import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient.js";
+import * as core from "../../../../core/index.js";
+import * as NizamCustomer from "../../../index.js";
+export declare namespace PricingClient {
+    type Options = BaseClientOptions;
+    interface RequestOptions extends BaseRequestOptions {
+    }
+}
+/**
+ * Public subscription pricing for the pricing page (no authentication).
+ */
+export declare class PricingClient {
+    protected readonly _options: NormalizedClientOptionsWithAuth<PricingClient.Options>;
+    constructor(options: PricingClient.Options);
+    /**
+     * The active, visible subscription plans for the public pricing page, ordered for display. Anonymous — no authentication required.
+     *
+     * @param {PricingClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link NizamCustomer.UnauthorizedError}
+     * @throws {@link NizamCustomer.TooManyRequestsError}
+     * @throws {@link NizamCustomer.InternalServerError}
+     *
+     * @example
+     *     await client.pricing.listPricing()
+     */
+    listPricing(requestOptions?: PricingClient.RequestOptions): core.HttpResponsePromise<NizamCustomer.ListResponsePricingPlan>;
+    private __listPricing;
+}

package/dist/api/resources/pricing/client/Client.js

@@ -0,0 +1,108 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PricingClient = void 0;
+const BaseClient_js_1 = require("../../../../BaseClient.js");
+const headers_js_1 = require("../../../../core/headers.js");
+const core = __importStar(require("../../../../core/index.js"));
+const environments = __importStar(require("../../../../environments.js"));
+const handleNonStatusCodeError_js_1 = require("../../../../errors/handleNonStatusCodeError.js");
+const errors = __importStar(require("../../../../errors/index.js"));
+const NizamCustomer = __importStar(require("../../../index.js"));
+/**
+ * Public subscription pricing for the pricing page (no authentication).
+ */
+class PricingClient {
+    constructor(options) {
+        this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
+    }
+    /**
+     * The active, visible subscription plans for the public pricing page, ordered for display. Anonymous — no authentication required.
+     *
+     * @param {PricingClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link NizamCustomer.UnauthorizedError}
+     * @throws {@link NizamCustomer.TooManyRequestsError}
+     * @throws {@link NizamCustomer.InternalServerError}
+     *
+     * @example
+     *     await client.pricing.listPricing()
+     */
+    listPricing(requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__listPricing(requestOptions));
+    }
+    async __listPricing(requestOptions) {
+        const _authRequest = await this._options.authProvider.getAuthRequest();
+        const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, this._options?.headers, requestOptions?.headers);
+        const _response = await core.fetcher({
+            url: core.url.join((await core.Supplier.get(this._options.baseUrl)) ??
+                (await core.Supplier.get(this._options.environment)) ??
+                environments.NizamCustomerEnvironment.Production, "v1/pricing"),
+            method: "GET",
+            headers: _headers,
+            queryString: core.url.queryBuilder().mergeAdditional(requestOptions?.queryParams).build(),
+            timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000,
+            maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries,
+            abortSignal: requestOptions?.abortSignal,
+            fetchFn: this._options?.fetch,
+            logging: this._options.logging,
+        });
+        if (_response.ok) {
+            return {
+                data: _response.body,
+                rawResponse: _response.rawResponse,
+            };
+        }
+        if (_response.error.reason === "status-code") {
+            switch (_response.error.statusCode) {
+                case 401:
+                    throw new NizamCustomer.UnauthorizedError(_response.error.body, _response.rawResponse);
+                case 429:
+                    throw new NizamCustomer.TooManyRequestsError(_response.error.body, _response.rawResponse);
+                case 500:
+                    throw new NizamCustomer.InternalServerError(_response.error.body, _response.rawResponse);
+                default:
+                    throw new errors.NizamCustomerError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.body,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        }
+        return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/v1/pricing");
+    }
+}
+exports.PricingClient = PricingClient;

package/dist/api/resources/pricing/client/index.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/api/resources/pricing/client/index.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/resources/pricing/exports.d.ts

@@ -0,0 +1,2 @@
+export { PricingClient } from "./client/Client.js";
+export * from "./client/index.js";

package/dist/api/resources/pricing/exports.js

@@ -0,0 +1,21 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+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 });
+exports.PricingClient = void 0;
+var Client_js_1 = require("./client/Client.js");
+Object.defineProperty(exports, "PricingClient", { enumerable: true, get: function () { return Client_js_1.PricingClient; } });
+__exportStar(require("./client/index.js"), exports);

package/dist/api/resources/pricing/index.d.ts

@@ -0,0 +1 @@
+export * from "./client/index.js";

package/dist/api/resources/pricing/index.js

@@ -0,0 +1,17 @@
+"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("./client/index.js"), exports);

package/dist/api/types/CreatePlanRequest.d.ts

@@ -0,0 +1,49 @@
+import type * as NizamCustomer from "../index.js";
+/**
+ * Author a new draft subscription plan.
+ */
+export interface CreatePlanRequest {
+    /** Stable plan code (natural key) — a lowercase url-safe slug. */
+    code: string;
+    /** Display name. */
+    name: string;
+    /** Description. */
+    description?: string | undefined;
+    /** Recurring price in the currency's minor units. */
+    price_minor_units?: number | undefined;
+    /** ISO-4217 currency code. */
+    currency: string;
+    /** One-time setup fee in minor units (default 0). */
+    setup_fee_minor_units?: number | undefined;
+    /** Pricing shape. */
+    billing_model: CreatePlanRequest.BillingModel;
+    /** Billing cadence. */
+    billing_period: CreatePlanRequest.BillingPeriod;
+    /** Sort position on the pricing page (ascending). */
+    position?: number | undefined;
+    /** Default free-trial length in days. */
+    default_trial_days?: number | undefined;
+    features?: NizamCustomer.PlanFeaturesRequest | undefined;
+}
+export declare namespace CreatePlanRequest {
+    /** Pricing shape. */
+    const BillingModel: {
+        readonly Free: "free";
+        readonly Flat: "flat";
+        readonly PerSeat: "per_seat";
+        readonly PerEvent: "per_event";
+        readonly Tiered: "tiered";
+        readonly Hybrid: "hybrid";
+    };
+    type BillingModel = (typeof BillingModel)[keyof typeof BillingModel];
+    /** Billing cadence. */
+    const BillingPeriod: {
+        readonly Weekly: "weekly";
+        readonly Biweekly: "biweekly";
+        readonly Monthly: "monthly";
+        readonly Quarterly: "quarterly";
+        readonly Semiannual: "semiannual";
+        readonly Yearly: "yearly";
+    };
+    type BillingPeriod = (typeof BillingPeriod)[keyof typeof BillingPeriod];
+}

package/dist/api/types/CreatePlanRequest.js

@@ -0,0 +1,25 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CreatePlanRequest = void 0;
+var CreatePlanRequest;
+(function (CreatePlanRequest) {
+    /** Pricing shape. */
+    CreatePlanRequest.BillingModel = {
+        Free: "free",
+        Flat: "flat",
+        PerSeat: "per_seat",
+        PerEvent: "per_event",
+        Tiered: "tiered",
+        Hybrid: "hybrid",
+    };
+    /** Billing cadence. */
+    CreatePlanRequest.BillingPeriod = {
+        Weekly: "weekly",
+        Biweekly: "biweekly",
+        Monthly: "monthly",
+        Quarterly: "quarterly",
+        Semiannual: "semiannual",
+        Yearly: "yearly",
+    };
+})(CreatePlanRequest || (exports.CreatePlanRequest = CreatePlanRequest = {}));

package/dist/api/types/ListResponsePricingPlan.d.ts

@@ -0,0 +1,27 @@
+import type * as NizamCustomer from "../index.js";
+/**
+ * Envelope for paginated list responses (opaque cursor pagination).
+ */
+export interface ListResponsePricingPlan {
+    /** Object type discriminator. Always `list` for this envelope. */
+    object?: ListResponsePricingPlan.Object_ | undefined;
+    /** Page of resources. Empty array when there are no matches. */
+    data?: NizamCustomer.PricingPlan[] | undefined;
+    /** True when more pages exist; pass `next_cursor` as `?starting_after=` to fetch the next page. */
+    has_more?: boolean | undefined;
+    /** True when earlier pages exist; pass `prev_cursor` as `?ending_before=` to fetch the previous page. */
+    has_previous?: boolean | undefined;
+    /** Opaque cursor for the next page. `null` on the last page. */
+    next_cursor?: string | undefined;
+    /** Opaque cursor for the previous page. `null` on the first page. */
+    prev_cursor?: string | undefined;
+    /** Page size that produced this response. */
+    limit?: number | undefined;
+}
+export declare namespace ListResponsePricingPlan {
+    /** Object type discriminator. Always `list` for this envelope. */
+    const Object_: {
+        readonly List: "list";
+    };
+    type Object_ = (typeof Object_)[keyof typeof Object_];
+}

package/dist/api/types/ListResponsePricingPlan.js

@@ -0,0 +1,11 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ListResponsePricingPlan = void 0;
+var ListResponsePricingPlan;
+(function (ListResponsePricingPlan) {
+    /** Object type discriminator. Always `list` for this envelope. */
+    ListResponsePricingPlan.Object_ = {
+        List: "list",
+    };
+})(ListResponsePricingPlan || (exports.ListResponsePricingPlan = ListResponsePricingPlan = {}));

package/dist/api/types/ListResponseSubscriptionPlan.d.ts

@@ -0,0 +1,27 @@
+import type * as NizamCustomer from "../index.js";
+/**
+ * Envelope for paginated list responses (opaque cursor pagination).
+ */
+export interface ListResponseSubscriptionPlan {
+    /** Object type discriminator. Always `list` for this envelope. */
+    object?: ListResponseSubscriptionPlan.Object_ | undefined;
+    /** Page of resources. Empty array when there are no matches. */
+    data?: NizamCustomer.SubscriptionPlan[] | undefined;
+    /** True when more pages exist; pass `next_cursor` as `?starting_after=` to fetch the next page. */
+    has_more?: boolean | undefined;
+    /** True when earlier pages exist; pass `prev_cursor` as `?ending_before=` to fetch the previous page. */
+    has_previous?: boolean | undefined;
+    /** Opaque cursor for the next page. `null` on the last page. */
+    next_cursor?: string | undefined;
+    /** Opaque cursor for the previous page. `null` on the first page. */
+    prev_cursor?: string | undefined;
+    /** Page size that produced this response. */
+    limit?: number | undefined;
+}
+export declare namespace ListResponseSubscriptionPlan {
+    /** Object type discriminator. Always `list` for this envelope. */
+    const Object_: {
+        readonly List: "list";
+    };
+    type Object_ = (typeof Object_)[keyof typeof Object_];
+}

package/dist/api/types/ListResponseSubscriptionPlan.js

@@ -0,0 +1,11 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ListResponseSubscriptionPlan = void 0;
+var ListResponseSubscriptionPlan;
+(function (ListResponseSubscriptionPlan) {
+    /** Object type discriminator. Always `list` for this envelope. */
+    ListResponseSubscriptionPlan.Object_ = {
+        List: "list",
+    };
+})(ListResponseSubscriptionPlan || (exports.ListResponseSubscriptionPlan = ListResponseSubscriptionPlan = {}));

package/dist/api/types/Money.d.ts

@@ -0,0 +1,11 @@
+/**
+ * A monetary amount as integer minor units plus its ISO-4217 currency.
+ */
+export interface Money {
+    /** ISO-4217 currency code. */
+    currency?: string | undefined;
+    /** Amount in the currency's minor units (cents for USD, yen for JPY, fils for KWD). */
+    minor_units?: number | undefined;
+    /** Amount as a major-unit decimal string at the currency's scale. */
+    decimal?: string | undefined;
+}

package/dist/api/types/Money.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/types/PlanFeatures.d.ts

@@ -0,0 +1,9 @@
+/**
+ * A plan's entitlements: capability flags + numeric quota ceilings.
+ */
+export interface PlanFeatures {
+    /** Capability flags keyed by feature id. An absent flag means off. */
+    flags?: Record<string, boolean> | undefined;
+    /** Quota ceilings keyed by meter key or feature id. An absent quota means unlimited; a present 0 means hard-blocked. */
+    quotas?: Record<string, number> | undefined;
+}

package/dist/api/types/PlanFeatures.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/types/PlanFeaturesRequest.d.ts

@@ -0,0 +1,9 @@
+/**
+ * A plan's entitlements: capability flags + numeric quota ceilings.
+ */
+export interface PlanFeaturesRequest {
+    /** Capability flags keyed by feature id. */
+    flags?: Record<string, boolean> | undefined;
+    /** Quota ceilings (non-negative) keyed by meter key or feature id. */
+    quotas?: Record<string, number> | undefined;
+}

package/dist/api/types/PlanFeaturesRequest.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/types/PricingPlan.d.ts

@@ -0,0 +1,48 @@
+import type * as NizamCustomer from "../index.js";
+/**
+ * A publicly sellable subscription plan, for the pricing page.
+ */
+export interface PricingPlan {
+    /** Stable plan code. */
+    code: string;
+    /** Display name. */
+    name: string;
+    /** Marketing description. */
+    description?: string | undefined;
+    price: NizamCustomer.Money;
+    setup_fee: NizamCustomer.Money;
+    /** Pricing shape. */
+    billing_model: PricingPlan.BillingModel;
+    /** Billing cadence. */
+    billing_period: PricingPlan.BillingPeriod;
+    /** Free-trial length in days, when the plan offers one. */
+    trial_days?: number | undefined;
+    features: NizamCustomer.PlanFeatures;
+    object: PricingPlan.Object_;
+}
+export declare namespace PricingPlan {
+    /** Pricing shape. */
+    const BillingModel: {
+        readonly Free: "free";
+        readonly Flat: "flat";
+        readonly PerSeat: "per_seat";
+        readonly PerEvent: "per_event";
+        readonly Tiered: "tiered";
+        readonly Hybrid: "hybrid";
+    };
+    type BillingModel = (typeof BillingModel)[keyof typeof BillingModel];
+    /** Billing cadence. */
+    const BillingPeriod: {
+        readonly Weekly: "weekly";
+        readonly Biweekly: "biweekly";
+        readonly Monthly: "monthly";
+        readonly Quarterly: "quarterly";
+        readonly Semiannual: "semiannual";
+        readonly Yearly: "yearly";
+    };
+    type BillingPeriod = (typeof BillingPeriod)[keyof typeof BillingPeriod];
+    const Object_: {
+        readonly PricingPlan: "pricing_plan";
+    };
+    type Object_ = (typeof Object_)[keyof typeof Object_];
+}

package/dist/api/types/PricingPlan.js

@@ -0,0 +1,28 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PricingPlan = void 0;
+var PricingPlan;
+(function (PricingPlan) {
+    /** Pricing shape. */
+    PricingPlan.BillingModel = {
+        Free: "free",
+        Flat: "flat",
+        PerSeat: "per_seat",
+        PerEvent: "per_event",
+        Tiered: "tiered",
+        Hybrid: "hybrid",
+    };
+    /** Billing cadence. */
+    PricingPlan.BillingPeriod = {
+        Weekly: "weekly",
+        Biweekly: "biweekly",
+        Monthly: "monthly",
+        Quarterly: "quarterly",
+        Semiannual: "semiannual",
+        Yearly: "yearly",
+    };
+    PricingPlan.Object_ = {
+        PricingPlan: "pricing_plan",
+    };
+})(PricingPlan || (exports.PricingPlan = PricingPlan = {}));

package/dist/api/types/SubscriptionPlan.d.ts

@@ -0,0 +1,89 @@
+import type * as NizamCustomer from "../index.js";
+/**
+ * A subscription plan in the platform billing catalog (admin view).
+ */
+export interface SubscriptionPlan {
+    /** Stable plan id. */
+    id: string;
+    /** Stable plan code (natural key). */
+    code: string;
+    /** Display name. */
+    name: string;
+    /** Description. */
+    description?: string | undefined;
+    /** Catalog lifecycle status. */
+    status: SubscriptionPlan.Status;
+    price: NizamCustomer.Money;
+    setup_fee: NizamCustomer.Money;
+    /** Pricing shape. */
+    billing_model: SubscriptionPlan.BillingModel;
+    /** Billing cadence. */
+    billing_period: SubscriptionPlan.BillingPeriod;
+    /** Sort position on the pricing page (ascending). */
+    position: number;
+    /** Default free-trial length in days. */
+    default_trial_days?: number | undefined;
+    features: NizamCustomer.PlanFeatures;
+    /** Whether the plan is live (sellable to subscribers). */
+    active: boolean;
+    /** Whether the plan appears on the public pricing page. */
+    visible: boolean;
+    /** Processor (Stripe) Product id, once provisioned. */
+    processor_product_id?: string | undefined;
+    /** Processor (Stripe) Price id, once provisioned. */
+    processor_price_id?: string | undefined;
+    /** Lifecycle statuses this plan may legally transition to next. */
+    allowed_transitions: SubscriptionPlan.AllowedTransitions.Item[];
+    /** Creation time. */
+    created_at: string;
+    /** Last update time. */
+    updated_at: string;
+    object: SubscriptionPlan.Object_;
+}
+export declare namespace SubscriptionPlan {
+    /** Catalog lifecycle status. */
+    const Status: {
+        readonly Draft: "draft";
+        readonly Active: "active";
+        readonly Grandfathered: "grandfathered";
+        readonly Retired: "retired";
+        readonly Archived: "archived";
+    };
+    type Status = (typeof Status)[keyof typeof Status];
+    /** Pricing shape. */
+    const BillingModel: {
+        readonly Free: "free";
+        readonly Flat: "flat";
+        readonly PerSeat: "per_seat";
+        readonly PerEvent: "per_event";
+        readonly Tiered: "tiered";
+        readonly Hybrid: "hybrid";
+    };
+    type BillingModel = (typeof BillingModel)[keyof typeof BillingModel];
+    /** Billing cadence. */
+    const BillingPeriod: {
+        readonly Weekly: "weekly";
+        readonly Biweekly: "biweekly";
+        readonly Monthly: "monthly";
+        readonly Quarterly: "quarterly";
+        readonly Semiannual: "semiannual";
+        readonly Yearly: "yearly";
+    };
+    type BillingPeriod = (typeof BillingPeriod)[keyof typeof BillingPeriod];
+    type AllowedTransitions = AllowedTransitions.Item[];
+    namespace AllowedTransitions {
+        /** Lifecycle statuses this plan may legally transition to next. */
+        const Item: {
+            readonly Draft: "draft";
+            readonly Active: "active";
+            readonly Grandfathered: "grandfathered";
+            readonly Retired: "retired";
+            readonly Archived: "archived";
+        };
+        type Item = (typeof Item)[keyof typeof Item];
+    }
+    const Object_: {
+        readonly SubscriptionPlan: "subscription_plan";
+    };
+    type Object_ = (typeof Object_)[keyof typeof Object_];
+}

package/dist/api/types/SubscriptionPlan.js

@@ -0,0 +1,47 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SubscriptionPlan = void 0;
+var SubscriptionPlan;
+(function (SubscriptionPlan) {
+    /** Catalog lifecycle status. */
+    SubscriptionPlan.Status = {
+        Draft: "draft",
+        Active: "active",
+        Grandfathered: "grandfathered",
+        Retired: "retired",
+        Archived: "archived",
+    };
+    /** Pricing shape. */
+    SubscriptionPlan.BillingModel = {
+        Free: "free",
+        Flat: "flat",
+        PerSeat: "per_seat",
+        PerEvent: "per_event",
+        Tiered: "tiered",
+        Hybrid: "hybrid",
+    };
+    /** Billing cadence. */
+    SubscriptionPlan.BillingPeriod = {
+        Weekly: "weekly",
+        Biweekly: "biweekly",
+        Monthly: "monthly",
+        Quarterly: "quarterly",
+        Semiannual: "semiannual",
+        Yearly: "yearly",
+    };
+    let AllowedTransitions;
+    (function (AllowedTransitions) {
+        /** Lifecycle statuses this plan may legally transition to next. */
+        AllowedTransitions.Item = {
+            Draft: "draft",
+            Active: "active",
+            Grandfathered: "grandfathered",
+            Retired: "retired",
+            Archived: "archived",
+        };
+    })(AllowedTransitions = SubscriptionPlan.AllowedTransitions || (SubscriptionPlan.AllowedTransitions = {}));
+    SubscriptionPlan.Object_ = {
+        SubscriptionPlan: "subscription_plan",
+    };
+})(SubscriptionPlan || (exports.SubscriptionPlan = SubscriptionPlan = {}));

package/dist/api/types/UpdatePlanRequest.d.ts

@@ -0,0 +1,47 @@
+import type * as NizamCustomer from "../index.js";
+/**
+ * Edit a subscription plan's catalog fields (partial update).
+ */
+export interface UpdatePlanRequest {
+    /** Display name. */
+    name?: string | undefined;
+    /** Description. */
+    description?: string | undefined;
+    /** Recurring price in minor units. */
+    price_minor_units?: number | undefined;
+    /** ISO-4217 currency code. */
+    currency?: string | undefined;
+    /** One-time setup fee in minor units. */
+    setup_fee_minor_units?: number | undefined;
+    /** Pricing shape. */
+    billing_model?: UpdatePlanRequest.BillingModel | undefined;
+    /** Billing cadence. */
+    billing_period?: UpdatePlanRequest.BillingPeriod | undefined;
+    /** Sort position on the pricing page. */
+    position?: number | undefined;
+    /** Default free-trial length in days. */
+    default_trial_days?: number | undefined;
+    features?: NizamCustomer.PlanFeaturesRequest | undefined;
+}
+export declare namespace UpdatePlanRequest {
+    /** Pricing shape. */
+    const BillingModel: {
+        readonly Free: "free";
+        readonly Flat: "flat";
+        readonly PerSeat: "per_seat";
+        readonly PerEvent: "per_event";
+        readonly Tiered: "tiered";
+        readonly Hybrid: "hybrid";
+    };
+    type BillingModel = (typeof BillingModel)[keyof typeof BillingModel];
+    /** Billing cadence. */
+    const BillingPeriod: {
+        readonly Weekly: "weekly";
+        readonly Biweekly: "biweekly";
+        readonly Monthly: "monthly";
+        readonly Quarterly: "quarterly";
+        readonly Semiannual: "semiannual";
+        readonly Yearly: "yearly";
+    };
+    type BillingPeriod = (typeof BillingPeriod)[keyof typeof BillingPeriod];
+}

package/dist/api/types/UpdatePlanRequest.js

@@ -0,0 +1,25 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UpdatePlanRequest = void 0;
+var UpdatePlanRequest;
+(function (UpdatePlanRequest) {
+    /** Pricing shape. */
+    UpdatePlanRequest.BillingModel = {
+        Free: "free",
+        Flat: "flat",
+        PerSeat: "per_seat",
+        PerEvent: "per_event",
+        Tiered: "tiered",
+        Hybrid: "hybrid",
+    };
+    /** Billing cadence. */
+    UpdatePlanRequest.BillingPeriod = {
+        Weekly: "weekly",
+        Biweekly: "biweekly",
+        Monthly: "monthly",
+        Quarterly: "quarterly",
+        Semiannual: "semiannual",
+        Yearly: "yearly",
+    };
+})(UpdatePlanRequest || (exports.UpdatePlanRequest = UpdatePlanRequest = {}));

package/dist/api/types/User.d.ts

@@ -51,6 +51,8 @@ export declare namespace User {
             readonly KeycloakProjectionAdminister: "keycloak-projection:administer";
             readonly NotificationDeliveryRead: "notification-delivery:read";
             readonly OrgMaintenanceAdminister: "org-maintenance:administer";
+            readonly PlanManage: "plan:manage";
+            readonly PlanRead: "plan:read";
             readonly ServiceAccountAdminister: "service-account:administer";
             readonly TaskCreate: "task:create";
             readonly UserAdminister: "user:administer";

package/dist/api/types/User.js

@@ -29,6 +29,8 @@ var User;
             KeycloakProjectionAdminister: "keycloak-projection:administer",
             NotificationDeliveryRead: "notification-delivery:read",
             OrgMaintenanceAdminister: "org-maintenance:administer",
+            PlanManage: "plan:manage",
+            PlanRead: "plan:read",
             ServiceAccountAdminister: "service-account:administer",
             TaskCreate: "task:create",
             UserAdminister: "user:administer",

package/dist/api/types/index.d.ts

@@ -20,6 +20,7 @@ export * from "./CreateImportRequest.js";
 export * from "./CreateInviteRequest.js";
 export * from "./CreateOperatorRequest.js";
 export * from "./CreateOrganizationRequest.js";
+export * from "./CreatePlanRequest.js";
 export * from "./CreateTaskRequest.js";
 export * from "./CreateTeleoperatedOperatorRequest.js";
 export * from "./Currency.js";
@@ -55,12 +56,15 @@ export * from "./ListResponseNotificationDeadLetter.js";
 export * from "./ListResponseOperatorPosition.js";
 export * from "./ListResponseOrganization.js";
 export * from "./ListResponsePosition.js";
+export * from "./ListResponsePricingPlan.js";
+export * from "./ListResponseSubscriptionPlan.js";
 export * from "./ListResponseTask.js";
 export * from "./ListResponseTimezone.js";
 export * from "./ListResponseUserResource.js";
 export * from "./Membership.js";
 export * from "./MembershipChoice.js";
 export * from "./MembershipDriftResponse.js";
+export * from "./Money.js";
 export * from "./MqttToken.js";
 export * from "./Notification.js";
 export * from "./NotificationCategoryCount.js";
@@ -77,18 +81,23 @@ export * from "./Operator.js";
 export * from "./OperatorAsset.js";
 export * from "./OperatorPosition.js";
 export * from "./Organization.js";
+export * from "./PlanFeatures.js";
+export * from "./PlanFeaturesRequest.js";
 export * from "./Position.js";
+export * from "./PricingPlan.js";
 export * from "./ProblemDetail.js";
 export * from "./QuietHours.js";
 export * from "./RealtimeTicket.js";
 export * from "./ReconcileResponse.js";
 export * from "./SetActiveOrganizationRequest.js";
+export * from "./SubscriptionPlan.js";
 export * from "./Task.js";
 export * from "./TaskAttemptPhoto.js";
 export * from "./TaskAttemptPhotoThumbnail.js";
 export * from "./Timezone.js";
 export * from "./UpdateAssetRequest.js";
 export * from "./UpdateOrganizationRequest.js";
+export * from "./UpdatePlanRequest.js";
 export * from "./UpdateTaskRequest.js";
 export * from "./UploadInitiation.js";
 export * from "./UploadInitiationPart.js";

package/dist/api/types/index.js

@@ -36,6 +36,7 @@ __exportStar(require("./CreateImportRequest.js"), exports);
 __exportStar(require("./CreateInviteRequest.js"), exports);
 __exportStar(require("./CreateOperatorRequest.js"), exports);
 __exportStar(require("./CreateOrganizationRequest.js"), exports);
+__exportStar(require("./CreatePlanRequest.js"), exports);
 __exportStar(require("./CreateTaskRequest.js"), exports);
 __exportStar(require("./CreateTeleoperatedOperatorRequest.js"), exports);
 __exportStar(require("./Currency.js"), exports);
@@ -71,12 +72,15 @@ __exportStar(require("./ListResponseNotificationDeadLetter.js"), exports);
 __exportStar(require("./ListResponseOperatorPosition.js"), exports);
 __exportStar(require("./ListResponseOrganization.js"), exports);
 __exportStar(require("./ListResponsePosition.js"), exports);
+__exportStar(require("./ListResponsePricingPlan.js"), exports);
+__exportStar(require("./ListResponseSubscriptionPlan.js"), exports);
 __exportStar(require("./ListResponseTask.js"), exports);
 __exportStar(require("./ListResponseTimezone.js"), exports);
 __exportStar(require("./ListResponseUserResource.js"), exports);
 __exportStar(require("./Membership.js"), exports);
 __exportStar(require("./MembershipChoice.js"), exports);
 __exportStar(require("./MembershipDriftResponse.js"), exports);
+__exportStar(require("./Money.js"), exports);
 __exportStar(require("./MqttToken.js"), exports);
 __exportStar(require("./Notification.js"), exports);
 __exportStar(require("./NotificationCategoryCount.js"), exports);
@@ -93,18 +97,23 @@ __exportStar(require("./Operator.js"), exports);
 __exportStar(require("./OperatorAsset.js"), exports);
 __exportStar(require("./OperatorPosition.js"), exports);
 __exportStar(require("./Organization.js"), exports);
+__exportStar(require("./PlanFeatures.js"), exports);
+__exportStar(require("./PlanFeaturesRequest.js"), exports);
 __exportStar(require("./Position.js"), exports);
+__exportStar(require("./PricingPlan.js"), exports);
 __exportStar(require("./ProblemDetail.js"), exports);
 __exportStar(require("./QuietHours.js"), exports);
 __exportStar(require("./RealtimeTicket.js"), exports);
 __exportStar(require("./ReconcileResponse.js"), exports);
 __exportStar(require("./SetActiveOrganizationRequest.js"), exports);
+__exportStar(require("./SubscriptionPlan.js"), exports);
 __exportStar(require("./Task.js"), exports);
 __exportStar(require("./TaskAttemptPhoto.js"), exports);
 __exportStar(require("./TaskAttemptPhotoThumbnail.js"), exports);
 __exportStar(require("./Timezone.js"), exports);
 __exportStar(require("./UpdateAssetRequest.js"), exports);
 __exportStar(require("./UpdateOrganizationRequest.js"), exports);
+__exportStar(require("./UpdatePlanRequest.js"), exports);
 __exportStar(require("./UpdateTaskRequest.js"), exports);
 __exportStar(require("./UploadInitiation.js"), exports);
 __exportStar(require("./UploadInitiationPart.js"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nizam-os/customer-sdk",
-  "version": "6.0.1",
+  "version": "7.0.0",
   "description": "Nizam Customer API SDK for TypeScript / JavaScript.",
   "license": "MIT",
   "private": false,