@nizam-os/dashboard-sdk 8.0.1 → 8.1.0

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

@@ -0,0 +1,49 @@
+import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.js";
+import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient.js";
+import * as core from "../../../../core/index.js";
+import * as NizamDashboard from "../../../index.js";
+export declare namespace NotificationPreferencesClient {
+    type Options = BaseClientOptions;
+    interface RequestOptions extends BaseRequestOptions {
+    }
+}
+/**
+ * The authenticated user's per-kind × channel delivery preferences.
+ */
+export declare class NotificationPreferencesClient {
+    protected readonly _options: NormalizedClientOptionsWithAuth<NotificationPreferencesClient.Options>;
+    constructor(options: NotificationPreferencesClient.Options);
+    /**
+     * The user's explicit per-kind × channel overrides. A (kind, channel) with no row uses the kind's coded default (so an empty list means 'all defaults').
+     *
+     * @param {NotificationPreferencesClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link NizamDashboard.UnauthorizedError}
+     * @throws {@link NizamDashboard.ForbiddenError}
+     * @throws {@link NizamDashboard.TooManyRequestsError}
+     * @throws {@link NizamDashboard.InternalServerError}
+     *
+     * @example
+     *     await client.notificationPreferences.getNotificationPreferences()
+     */
+    getNotificationPreferences(requestOptions?: NotificationPreferencesClient.RequestOptions): core.HttpResponsePromise<NizamDashboard.NotificationPreferences>;
+    private __getNotificationPreferences;
+    /**
+     * Upserts the supplied overrides — each item fully declares the desired state of one (kind, channel). Unlisted preferences are untouched. Returns the full resulting set.
+     *
+     * @param {NizamDashboard.UpdateNotificationPreferences} request
+     * @param {NotificationPreferencesClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link NizamDashboard.UnauthorizedError}
+     * @throws {@link NizamDashboard.ForbiddenError}
+     * @throws {@link NizamDashboard.TooManyRequestsError}
+     * @throws {@link NizamDashboard.InternalServerError}
+     *
+     * @example
+     *     await client.notificationPreferences.updateNotificationPreferences({
+     *         preferences: [{}]
+     *     })
+     */
+    updateNotificationPreferences(request?: NizamDashboard.UpdateNotificationPreferences, requestOptions?: NotificationPreferencesClient.RequestOptions): core.HttpResponsePromise<NizamDashboard.NotificationPreferences>;
+    private __updateNotificationPreferences;
+}

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

@@ -0,0 +1,175 @@
+"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.NotificationPreferencesClient = 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 NizamDashboard = __importStar(require("../../../index.js"));
+/**
+ * The authenticated user's per-kind × channel delivery preferences.
+ */
+class NotificationPreferencesClient {
+    constructor(options) {
+        this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
+    }
+    /**
+     * The user's explicit per-kind × channel overrides. A (kind, channel) with no row uses the kind's coded default (so an empty list means 'all defaults').
+     *
+     * @param {NotificationPreferencesClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link NizamDashboard.UnauthorizedError}
+     * @throws {@link NizamDashboard.ForbiddenError}
+     * @throws {@link NizamDashboard.TooManyRequestsError}
+     * @throws {@link NizamDashboard.InternalServerError}
+     *
+     * @example
+     *     await client.notificationPreferences.getNotificationPreferences()
+     */
+    getNotificationPreferences(requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__getNotificationPreferences(requestOptions));
+    }
+    async __getNotificationPreferences(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.NizamDashboardEnvironment.Production, "v1/me/notification-preferences"),
+            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 NizamDashboard.UnauthorizedError(_response.error.body, _response.rawResponse);
+                case 403:
+                    throw new NizamDashboard.ForbiddenError(_response.error.body, _response.rawResponse);
+                case 429:
+                    throw new NizamDashboard.TooManyRequestsError(_response.error.body, _response.rawResponse);
+                case 500:
+                    throw new NizamDashboard.InternalServerError(_response.error.body, _response.rawResponse);
+                default:
+                    throw new errors.NizamDashboardError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.body,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        }
+        return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/v1/me/notification-preferences");
+    }
+    /**
+     * Upserts the supplied overrides — each item fully declares the desired state of one (kind, channel). Unlisted preferences are untouched. Returns the full resulting set.
+     *
+     * @param {NizamDashboard.UpdateNotificationPreferences} request
+     * @param {NotificationPreferencesClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link NizamDashboard.UnauthorizedError}
+     * @throws {@link NizamDashboard.ForbiddenError}
+     * @throws {@link NizamDashboard.TooManyRequestsError}
+     * @throws {@link NizamDashboard.InternalServerError}
+     *
+     * @example
+     *     await client.notificationPreferences.updateNotificationPreferences({
+     *         preferences: [{}]
+     *     })
+     */
+    updateNotificationPreferences(request = {}, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__updateNotificationPreferences(request, requestOptions));
+    }
+    async __updateNotificationPreferences(request = {}, 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.NizamDashboardEnvironment.Production, "v1/me/notification-preferences"),
+            method: "PATCH",
+            headers: _headers,
+            contentType: "application/json",
+            queryString: core.url.queryBuilder().mergeAdditional(requestOptions?.queryParams).build(),
+            requestType: "json",
+            body: request,
+            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 NizamDashboard.UnauthorizedError(_response.error.body, _response.rawResponse);
+                case 403:
+                    throw new NizamDashboard.ForbiddenError(_response.error.body, _response.rawResponse);
+                case 429:
+                    throw new NizamDashboard.TooManyRequestsError(_response.error.body, _response.rawResponse);
+                case 500:
+                    throw new NizamDashboard.InternalServerError(_response.error.body, _response.rawResponse);
+                default:
+                    throw new errors.NizamDashboardError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.body,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        }
+        return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "PATCH", "/v1/me/notification-preferences");
+    }
+}
+exports.NotificationPreferencesClient = NotificationPreferencesClient;

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

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

package/dist/api/resources/notificationPreferences/client/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("./requests/index.js"), exports);

package/dist/api/resources/notificationPreferences/client/requests/UpdateNotificationPreferences.d.ts

@@ -0,0 +1,11 @@
+import type * as NizamDashboard from "../../../../index.js";
+/**
+ * @example
+ *     {
+ *         preferences: [{}]
+ *     }
+ */
+export interface UpdateNotificationPreferences {
+    /** The overrides to apply; each fully declares one (kind, channel). */
+    preferences?: NizamDashboard.NotificationPreferenceItem[];
+}

package/dist/api/resources/notificationPreferences/client/requests/UpdateNotificationPreferences.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/resources/notificationPreferences/client/requests/index.d.ts

@@ -0,0 +1 @@
+export type { UpdateNotificationPreferences } from "./UpdateNotificationPreferences.js";

package/dist/api/resources/notificationPreferences/client/requests/index.js

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

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

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

package/dist/api/resources/notificationPreferences/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.NotificationPreferencesClient = void 0;
+var Client_js_1 = require("./client/Client.js");
+Object.defineProperty(exports, "NotificationPreferencesClient", { enumerable: true, get: function () { return Client_js_1.NotificationPreferencesClient; } });
+__exportStar(require("./client/index.js"), exports);

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

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

package/dist/api/resources/notificationPreferences/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/resources/notifications/client/Client.d.ts

@@ -0,0 +1,88 @@
+import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.js";
+import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient.js";
+import * as core from "../../../../core/index.js";
+import * as NizamDashboard from "../../../index.js";
+export declare namespace NotificationsClient {
+    type Options = BaseClientOptions;
+    interface RequestOptions extends BaseRequestOptions {
+    }
+}
+/**
+ * The authenticated user's notification inbox.
+ */
+export declare class NotificationsClient {
+    protected readonly _options: NormalizedClientOptionsWithAuth<NotificationsClient.Options>;
+    constructor(options: NotificationsClient.Options);
+    /**
+     * The caller's own notifications ordered by `created_at` descending (pass `sort=created_at` for ascending). `unread=true` restricts to unread; `since=` (RFC 3339) returns only items at/after the instant for incremental catch-up after a reconnect. Pagination is bidirectional (`starting_after` / `ending_before`); cursors are bound to the sort direction that minted them.
+     *
+     * @param {NizamDashboard.ListNotificationsRequest} request
+     * @param {NotificationsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link NizamDashboard.BadRequestError}
+     * @throws {@link NizamDashboard.UnauthorizedError}
+     * @throws {@link NizamDashboard.ForbiddenError}
+     * @throws {@link NizamDashboard.TooManyRequestsError}
+     * @throws {@link NizamDashboard.InternalServerError}
+     *
+     * @example
+     *     await client.notifications.listNotifications({
+     *         since: "2026-05-20T14:00:00Z",
+     *         starting_after: "Y3Vyc29yX25leHRfMDFKNVE=",
+     *         ending_before: "Y3Vyc29yX25leHRfMDFKNVE="
+     *     })
+     */
+    listNotifications(request?: NizamDashboard.ListNotificationsRequest, requestOptions?: NotificationsClient.RequestOptions): core.HttpResponsePromise<NizamDashboard.ListResponseNotification>;
+    private __listNotifications;
+    /**
+     * Flips every unread notification of the caller to read in one operation. Returns the number of notifications that were flipped (zero when the inbox was already clear).
+     *
+     * @param {NotificationsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link NizamDashboard.BadRequestError}
+     * @throws {@link NizamDashboard.UnauthorizedError}
+     * @throws {@link NizamDashboard.ForbiddenError}
+     * @throws {@link NizamDashboard.TooManyRequestsError}
+     * @throws {@link NizamDashboard.InternalServerError}
+     *
+     * @example
+     *     await client.notifications.markAllNotificationsRead()
+     */
+    markAllNotificationsRead(requestOptions?: NotificationsClient.RequestOptions): core.HttpResponsePromise<NizamDashboard.NotificationsMarkedRead>;
+    private __markAllNotificationsRead;
+    /**
+     * The unread badge count for the active organization. Excludes dismissed (soft-deleted) notifications.
+     *
+     * @param {NotificationsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link NizamDashboard.BadRequestError}
+     * @throws {@link NizamDashboard.UnauthorizedError}
+     * @throws {@link NizamDashboard.ForbiddenError}
+     * @throws {@link NizamDashboard.TooManyRequestsError}
+     * @throws {@link NizamDashboard.InternalServerError}
+     *
+     * @example
+     *     await client.notifications.getUnreadNotificationCount()
+     */
+    getUnreadNotificationCount(requestOptions?: NotificationsClient.RequestOptions): core.HttpResponsePromise<NizamDashboard.NotificationUnreadCount>;
+    private __getUnreadNotificationCount;
+    /**
+     * Flips a single notification to read. Idempotent — a second call is a no-op that preserves the original read timestamp. 404 if the notification is not the caller's.
+     *
+     * @param {NizamDashboard.MarkNotificationReadRequest} request
+     * @param {NotificationsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link NizamDashboard.UnauthorizedError}
+     * @throws {@link NizamDashboard.ForbiddenError}
+     * @throws {@link NizamDashboard.NotFoundError}
+     * @throws {@link NizamDashboard.TooManyRequestsError}
+     * @throws {@link NizamDashboard.InternalServerError}
+     *
+     * @example
+     *     await client.notifications.markNotificationRead({
+     *         id: "00000000-0000-0000-0000-000000000000"
+     *     })
+     */
+    markNotificationRead(request: NizamDashboard.MarkNotificationReadRequest, requestOptions?: NotificationsClient.RequestOptions): core.HttpResponsePromise<NizamDashboard.Notification>;
+    private __markNotificationRead;
+}