@nizam-os/dashboard-sdk 8.1.0 → 10.0.0

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

@@ -35,8 +35,6 @@ export declare class OrganizationsClient {
     /**
      * Creates a brand-new tenant with the calling user as the founding admin. The id is assigned by Keycloak so the same value identifies the organization in both systems. Slug is derived from the name when not supplied.
      *
-     * Supports the standard `Idempotency-Key` header — submit a UUID (v4 recommended) per logical attempt (same value on retry); malformed keys are rejected with 400 `idempotency.invalid_key`. Successful responses and 4xx domain rejections replay for matching request bodies; transient 5xx responses are never cached, so retrying with the same key re-executes. Mismatching fingerprints surface as 409 `idempotency.key_conflict`.
-     *
      * @param {NizamDashboard.CreateOrganizationRequest} request
      * @param {OrganizationsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -50,11 +48,13 @@ export declare class OrganizationsClient {
      *
      * @example
      *     await client.organizations.createOrganization({
+     *         "Idempotency-Key": "9f1e6d2a-7c3b-4e5f-8a91-0b2c3d4e5f60",
      *         name: "Acme Logistics"
      *     })
      *
      * @example
      *     await client.organizations.createOrganization({
+     *         "Idempotency-Key": "9f1e6d2a-7c3b-4e5f-8a91-0b2c3d4e5f60",
      *         name: "Acme Logistics",
      *         slug: "acme-logistics",
      *         primary_domain: "acme.com",

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

@@ -125,8 +125,6 @@ class OrganizationsClient {
     /**
      * Creates a brand-new tenant with the calling user as the founding admin. The id is assigned by Keycloak so the same value identifies the organization in both systems. Slug is derived from the name when not supplied.
      *
-     * Supports the standard `Idempotency-Key` header — submit a UUID (v4 recommended) per logical attempt (same value on retry); malformed keys are rejected with 400 `idempotency.invalid_key`. Successful responses and 4xx domain rejections replay for matching request bodies; transient 5xx responses are never cached, so retrying with the same key re-executes. Mismatching fingerprints surface as 409 `idempotency.key_conflict`.
-     *
      * @param {NizamDashboard.CreateOrganizationRequest} request
      * @param {OrganizationsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -140,11 +138,13 @@ class OrganizationsClient {
      *
      * @example
      *     await client.organizations.createOrganization({
+     *         "Idempotency-Key": "9f1e6d2a-7c3b-4e5f-8a91-0b2c3d4e5f60",
      *         name: "Acme Logistics"
      *     })
      *
      * @example
      *     await client.organizations.createOrganization({
+     *         "Idempotency-Key": "9f1e6d2a-7c3b-4e5f-8a91-0b2c3d4e5f60",
      *         name: "Acme Logistics",
      *         slug: "acme-logistics",
      *         primary_domain: "acme.com",
@@ -158,8 +158,9 @@ class OrganizationsClient {
         return core.HttpResponsePromise.fromPromise(this.__createOrganization(request, requestOptions));
     }
     async __createOrganization(request, requestOptions) {
+        const { "Idempotency-Key": idempotencyKey, ..._body } = request;
         const _authRequest = await this._options.authProvider.getAuthRequest();
-        const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, this._options?.headers, requestOptions?.headers);
+        const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, this._options?.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ "Idempotency-Key": idempotencyKey }), 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)) ??
@@ -169,7 +170,7 @@ class OrganizationsClient {
             contentType: "application/json",
             queryString: core.url.queryBuilder().mergeAdditional(requestOptions?.queryParams).build(),
             requestType: "json",
-            body: request,
+            body: _body,
             timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000,
             maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries,
             abortSignal: requestOptions?.abortSignal,

package/dist/api/resources/organizations/client/requests/CreateOrganizationRequest.d.ts

@@ -1,11 +1,13 @@
 /**
  * @example
  *     {
+ *         "Idempotency-Key": "9f1e6d2a-7c3b-4e5f-8a91-0b2c3d4e5f60",
  *         name: "Acme Logistics"
  *     }
  *
  * @example
  *     {
+ *         "Idempotency-Key": "9f1e6d2a-7c3b-4e5f-8a91-0b2c3d4e5f60",
  *         name: "Acme Logistics",
  *         slug: "acme-logistics",
  *         primary_domain: "acme.com",
@@ -16,6 +18,8 @@
  *     }
  */
 export interface CreateOrganizationRequest {
+    /** Optional. Supply a UUID (canonical 8-4-4-4-12 form; lowercase v4 recommended) to make this operation idempotent: the same key on a retry replays the original outcome instead of creating a second resource. 2xx successes and deliberate 4xx domain rejections are cached and replayed for 24h when the request body matches; transient 5xx responses are never cached, so a retry with the same key re-executes. A malformed key is rejected with 400 `idempotency.invalid_key`; reusing a key with a different request body is 409 `idempotency.key_conflict`; a key still in flight is 409 `idempotency.in_progress`. Omit the header and the operation behaves like any other write. */
+    "Idempotency-Key"?: string;
     /** Display name of the organization. */
     name: string;
     /** Optional URL-safe slug. When omitted, the server derives one from the name. */

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

@@ -42,6 +42,7 @@ export declare class TaskAttemptsClient {
      * @throws {@link NizamDashboard.UnauthorizedError}
      * @throws {@link NizamDashboard.ForbiddenError}
      * @throws {@link NizamDashboard.NotFoundError}
+     * @throws {@link NizamDashboard.ConflictError}
      * @throws {@link NizamDashboard.ContentTooLargeError}
      * @throws {@link NizamDashboard.UnprocessableEntityError}
      * @throws {@link NizamDashboard.TooManyRequestsError}
@@ -49,6 +50,7 @@ export declare class TaskAttemptsClient {
      *
      * @example
      *     await client.taskAttempts.captureTaskAttemptPhoto({
+     *         "Idempotency-Key": "9f1e6d2a-7c3b-4e5f-8a91-0b2c3d4e5f60",
      *         attemptId: "00000000-0000-0000-0000-000000000000",
      *         filename: "delivery-door.jpg",
      *         content_type: "image/jpeg",

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

@@ -132,6 +132,7 @@ class TaskAttemptsClient {
      * @throws {@link NizamDashboard.UnauthorizedError}
      * @throws {@link NizamDashboard.ForbiddenError}
      * @throws {@link NizamDashboard.NotFoundError}
+     * @throws {@link NizamDashboard.ConflictError}
      * @throws {@link NizamDashboard.ContentTooLargeError}
      * @throws {@link NizamDashboard.UnprocessableEntityError}
      * @throws {@link NizamDashboard.TooManyRequestsError}
@@ -139,6 +140,7 @@ class TaskAttemptsClient {
      *
      * @example
      *     await client.taskAttempts.captureTaskAttemptPhoto({
+     *         "Idempotency-Key": "9f1e6d2a-7c3b-4e5f-8a91-0b2c3d4e5f60",
      *         attemptId: "00000000-0000-0000-0000-000000000000",
      *         filename: "delivery-door.jpg",
      *         content_type: "image/jpeg",
@@ -154,9 +156,9 @@ class TaskAttemptsClient {
         return core.HttpResponsePromise.fromPromise(this.__captureTaskAttemptPhoto(request, requestOptions));
     }
     async __captureTaskAttemptPhoto(request, requestOptions) {
-        const { attemptId, ..._body } = request;
+        const { attemptId, "Idempotency-Key": idempotencyKey, ..._body } = request;
         const _authRequest = await this._options.authProvider.getAuthRequest();
-        const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, this._options?.headers, requestOptions?.headers);
+        const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, this._options?.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ "Idempotency-Key": idempotencyKey }), 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)) ??
@@ -186,6 +188,8 @@ class TaskAttemptsClient {
                     throw new NizamDashboard.ForbiddenError(_response.error.body, _response.rawResponse);
                 case 404:
                     throw new NizamDashboard.NotFoundError(_response.error.body, _response.rawResponse);
+                case 409:
+                    throw new NizamDashboard.ConflictError(_response.error.body, _response.rawResponse);
                 case 413:
                     throw new NizamDashboard.ContentTooLargeError(_response.error.body, _response.rawResponse);
                 case 422:

package/dist/api/resources/taskAttempts/client/requests/CaptureTaskAttemptPhotoRequest.d.ts

@@ -1,6 +1,7 @@
 /**
  * @example
  *     {
+ *         "Idempotency-Key": "9f1e6d2a-7c3b-4e5f-8a91-0b2c3d4e5f60",
  *         attemptId: "00000000-0000-0000-0000-000000000000",
  *         filename: "delivery-door.jpg",
  *         content_type: "image/jpeg",
@@ -14,6 +15,8 @@
  */
 export interface CaptureTaskAttemptPhotoRequest {
     attemptId: string;
+    /** Optional. Supply a UUID (canonical 8-4-4-4-12 form; lowercase v4 recommended) to make this operation idempotent: the same key on a retry replays the original outcome instead of creating a second resource. 2xx successes and deliberate 4xx domain rejections are cached and replayed for 24h when the request body matches; transient 5xx responses are never cached, so a retry with the same key re-executes. A malformed key is rejected with 400 `idempotency.invalid_key`; reusing a key with a different request body is 409 `idempotency.key_conflict`; a key still in flight is 409 `idempotency.in_progress`. Omit the header and the operation behaves like any other write. */
+    "Idempotency-Key"?: string;
     /** Original filename. */
     filename: string;
     /** Declared MIME type — POD photos accept image/jpeg, image/png, image/webp, image/heic, image/heif. */

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

@@ -88,6 +88,7 @@ export declare class UsersClient {
      * @param {NizamDashboard.InviteUserRequest} request
      * @param {UsersClient.RequestOptions} requestOptions - Request-specific configuration.
      *
+     * @throws {@link NizamDashboard.BadRequestError}
      * @throws {@link NizamDashboard.UnauthorizedError}
      * @throws {@link NizamDashboard.ForbiddenError}
      * @throws {@link NizamDashboard.ConflictError}
@@ -97,12 +98,14 @@ export declare class UsersClient {
      *
      * @example
      *     await client.users.inviteUser({
+     *         "Idempotency-Key": "9f1e6d2a-7c3b-4e5f-8a91-0b2c3d4e5f60",
      *         email: "newhire@acme.example",
      *         name: "New Hire"
      *     })
      *
      * @example
      *     await client.users.inviteUser({
+     *         "Idempotency-Key": "9f1e6d2a-7c3b-4e5f-8a91-0b2c3d4e5f60",
      *         email: "newhire@acme.example"
      *     })
      */

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

@@ -271,6 +271,7 @@ class UsersClient {
      * @param {NizamDashboard.InviteUserRequest} request
      * @param {UsersClient.RequestOptions} requestOptions - Request-specific configuration.
      *
+     * @throws {@link NizamDashboard.BadRequestError}
      * @throws {@link NizamDashboard.UnauthorizedError}
      * @throws {@link NizamDashboard.ForbiddenError}
      * @throws {@link NizamDashboard.ConflictError}
@@ -280,12 +281,14 @@ class UsersClient {
      *
      * @example
      *     await client.users.inviteUser({
+     *         "Idempotency-Key": "9f1e6d2a-7c3b-4e5f-8a91-0b2c3d4e5f60",
      *         email: "newhire@acme.example",
      *         name: "New Hire"
      *     })
      *
      * @example
      *     await client.users.inviteUser({
+     *         "Idempotency-Key": "9f1e6d2a-7c3b-4e5f-8a91-0b2c3d4e5f60",
      *         email: "newhire@acme.example"
      *     })
      */
@@ -293,8 +296,9 @@ class UsersClient {
         return core.HttpResponsePromise.fromPromise(this.__inviteUser(request, requestOptions));
     }
     async __inviteUser(request, requestOptions) {
+        const { "Idempotency-Key": idempotencyKey, ..._body } = request;
         const _authRequest = await this._options.authProvider.getAuthRequest();
-        const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, this._options?.headers, requestOptions?.headers);
+        const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, this._options?.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ "Idempotency-Key": idempotencyKey }), 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)) ??
@@ -304,7 +308,7 @@ class UsersClient {
             contentType: "application/json",
             queryString: core.url.queryBuilder().mergeAdditional(requestOptions?.queryParams).build(),
             requestType: "json",
-            body: request,
+            body: _body,
             timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000,
             maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries,
             abortSignal: requestOptions?.abortSignal,
@@ -316,6 +320,8 @@ class UsersClient {
         }
         if (_response.error.reason === "status-code") {
             switch (_response.error.statusCode) {
+                case 400:
+                    throw new NizamDashboard.BadRequestError(_response.error.body, _response.rawResponse);
                 case 401:
                     throw new NizamDashboard.UnauthorizedError(_response.error.body, _response.rawResponse);
                 case 403:

package/dist/api/resources/users/client/requests/InviteUserRequest.d.ts

@@ -1,16 +1,20 @@
 /**
  * @example
  *     {
+ *         "Idempotency-Key": "9f1e6d2a-7c3b-4e5f-8a91-0b2c3d4e5f60",
  *         email: "newhire@acme.example",
  *         name: "New Hire"
  *     }
  *
  * @example
  *     {
+ *         "Idempotency-Key": "9f1e6d2a-7c3b-4e5f-8a91-0b2c3d4e5f60",
  *         email: "newhire@acme.example"
  *     }
  */
 export interface InviteUserRequest {
+    /** Optional. Supply a UUID (canonical 8-4-4-4-12 form; lowercase v4 recommended) to make this operation idempotent: the same key on a retry replays the original outcome instead of creating a second resource. 2xx successes and deliberate 4xx domain rejections are cached and replayed for 24h when the request body matches; transient 5xx responses are never cached, so a retry with the same key re-executes. A malformed key is rejected with 400 `idempotency.invalid_key`; reusing a key with a different request body is 409 `idempotency.key_conflict`; a key still in flight is 409 `idempotency.in_progress`. Omit the header and the operation behaves like any other write. */
+    "Idempotency-Key"?: string;
     /** Recipient email. */
     email: string;
     /** Display name (optional). */

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

@@ -5,9 +5,9 @@ export interface Device {
     /** Device id. */
     id?: string | undefined;
     /** Push transport. */
-    platform?: string | undefined;
+    platform?: Device.Platform | undefined;
     /** Registration lifecycle. */
-    status?: string | undefined;
+    status?: Device.Status | undefined;
     /** When the device was first registered. */
     registered_at?: string | undefined;
     /** When the registration was last refreshed (last seen). */
@@ -16,6 +16,21 @@ export interface Device {
     object?: Device.Object_ | undefined;
 }
 export declare namespace Device {
+    /** Push transport. */
+    const Platform: {
+        readonly Ios: "ios";
+        readonly Android: "android";
+        readonly Web: "web";
+    };
+    type Platform = (typeof Platform)[keyof typeof Platform];
+    /** Registration lifecycle. */
+    const Status: {
+        readonly Active: "active";
+        readonly Suspended: "suspended";
+        readonly Inactive: "inactive";
+        readonly Expired: "expired";
+    };
+    type Status = (typeof Status)[keyof typeof Status];
     /** Object type discriminator. */
     const Object_: {
         readonly Device: "device";

package/dist/api/types/Device.js

@@ -4,6 +4,19 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Device = void 0;
 var Device;
 (function (Device) {
+    /** Push transport. */
+    Device.Platform = {
+        Ios: "ios",
+        Android: "android",
+        Web: "web",
+    };
+    /** Registration lifecycle. */
+    Device.Status = {
+        Active: "active",
+        Suspended: "suspended",
+        Inactive: "inactive",
+        Expired: "expired",
+    };
     /** Object type discriminator. */
     Device.Object_ = {
         Device: "device",

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

@@ -18,6 +18,10 @@ export interface Notification {
     read?: boolean | undefined;
     /** When it was read (RFC 3339); null while unread. */
     read_at?: string | undefined;
+    /** Whether the recipient has archived ("Done") it. */
+    archived?: boolean | undefined;
+    /** When it was archived (RFC 3339); null while in the active inbox. */
+    archived_at?: string | undefined;
     /** When it was raised (RFC 3339). */
     created_at?: string | undefined;
 }

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

@@ -0,0 +1,23 @@
+/**
+ * Active total/unread for one category.
+ */
+export interface NotificationCategoryCount {
+    /** Category. */
+    category?: NotificationCategoryCount.Category | undefined;
+    /** Active notifications in this category. */
+    total?: number | undefined;
+    /** Active unread notifications in this category. */
+    unread?: number | undefined;
+}
+export declare namespace NotificationCategoryCount {
+    /** Category. */
+    const Category: {
+        readonly Transactional: "transactional";
+        readonly Operational: "operational";
+        readonly Alert: "alert";
+        readonly Marketing: "marketing";
+        readonly Security: "security";
+        readonly System: "system";
+    };
+    type Category = (typeof Category)[keyof typeof Category];
+}

package/dist/api/types/NotificationCategoryCount.js

@@ -0,0 +1,16 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NotificationCategoryCount = void 0;
+var NotificationCategoryCount;
+(function (NotificationCategoryCount) {
+    /** Category. */
+    NotificationCategoryCount.Category = {
+        Transactional: "transactional",
+        Operational: "operational",
+        Alert: "alert",
+        Marketing: "marketing",
+        Security: "security",
+        System: "system",
+    };
+})(NotificationCategoryCount || (exports.NotificationCategoryCount = NotificationCategoryCount = {}));

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

@@ -0,0 +1,23 @@
+import type * as NizamDashboard from "../index.js";
+/**
+ * Inbox segment-badge counts (server-derived).
+ */
+export interface NotificationCounts {
+    /** Active (non-archived) notifications. */
+    total?: number | undefined;
+    /** Active unread notifications. */
+    unread?: number | undefined;
+    /** Archived ("Done") notifications. */
+    archived?: number | undefined;
+    /** Per-category active counts; categories with no active row are omitted. */
+    categories?: NizamDashboard.NotificationCategoryCount[] | undefined;
+    /** Object type discriminator. */
+    object?: NotificationCounts.Object_ | undefined;
+}
+export declare namespace NotificationCounts {
+    /** Object type discriminator. */
+    const Object_: {
+        readonly NotificationCounts: "notification_counts";
+    };
+    type Object_ = (typeof Object_)[keyof typeof Object_];
+}

package/dist/api/types/NotificationCounts.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.NotificationCounts = void 0;
+var NotificationCounts;
+(function (NotificationCounts) {
+    /** Object type discriminator. */
+    NotificationCounts.Object_ = {
+        NotificationCounts: "notification_counts",
+    };
+})(NotificationCounts || (exports.NotificationCounts = NotificationCounts = {}));

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

@@ -0,0 +1,16 @@
+/**
+ * Result of an archive-all operation.
+ */
+export interface NotificationsArchived {
+    /** Number of notifications archived. */
+    archived?: number | undefined;
+    /** Object type discriminator. */
+    object?: NotificationsArchived.Object_ | undefined;
+}
+export declare namespace NotificationsArchived {
+    /** Object type discriminator. */
+    const Object_: {
+        readonly NotificationsArchived: "notifications_archived";
+    };
+    type Object_ = (typeof Object_)[keyof typeof Object_];
+}

package/dist/api/types/NotificationsArchived.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.NotificationsArchived = void 0;
+var NotificationsArchived;
+(function (NotificationsArchived) {
+    /** Object type discriminator. */
+    NotificationsArchived.Object_ = {
+        NotificationsArchived: "notifications_archived",
+    };
+})(NotificationsArchived || (exports.NotificationsArchived = NotificationsArchived = {}));

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

@@ -1,5 +1,5 @@
 /**
- * Result of a mark-all-read operation.
+ * Result of a mark-read operation.
  */
 export interface NotificationsMarkedRead {
     /** Number of notifications flipped to read. */

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

@@ -49,10 +49,13 @@ export * from "./MembershipChoice.js";
 export * from "./MembershipDriftResponse.js";
 export * from "./MqttToken.js";
 export * from "./Notification.js";
+export * from "./NotificationCategoryCount.js";
+export * from "./NotificationCounts.js";
 export * from "./NotificationDeadLetter.js";
 export * from "./NotificationPreference.js";
 export * from "./NotificationPreferenceItem.js";
 export * from "./NotificationPreferences.js";
+export * from "./NotificationsArchived.js";
 export * from "./NotificationsMarkedRead.js";
 export * from "./NotificationUnreadCount.js";
 export * from "./Operator.js";

package/dist/api/types/index.js

@@ -65,10 +65,13 @@ __exportStar(require("./MembershipChoice.js"), exports);
 __exportStar(require("./MembershipDriftResponse.js"), exports);
 __exportStar(require("./MqttToken.js"), exports);
 __exportStar(require("./Notification.js"), exports);
+__exportStar(require("./NotificationCategoryCount.js"), exports);
+__exportStar(require("./NotificationCounts.js"), exports);
 __exportStar(require("./NotificationDeadLetter.js"), exports);
 __exportStar(require("./NotificationPreference.js"), exports);
 __exportStar(require("./NotificationPreferenceItem.js"), exports);
 __exportStar(require("./NotificationPreferences.js"), exports);
+__exportStar(require("./NotificationsArchived.js"), exports);
 __exportStar(require("./NotificationsMarkedRead.js"), exports);
 __exportStar(require("./NotificationUnreadCount.js"), exports);
 __exportStar(require("./Operator.js"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nizam-os/dashboard-sdk",
-  "version": "8.1.0",
+  "version": "10.0.0",
   "description": "Nizam Dashboard API SDK for TypeScript / JavaScript.",
   "license": "MIT",
   "private": false,