@nizam-os/dashboard-sdk 5.2.1 → 5.4.0

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

@@ -32,6 +32,13 @@ export declare class AssignmentsClient {
      *         operator_id: "c1d2e3f4-5a6b-7c8d-9e0f-1a2b3c4d5e6f",
      *         role: "primary"
      *     })
+     *
+     * @example
+     *     await client.assignments.openAssignment({
+     *         asset_id: "8f55f0eb-7d3a-4f2c-9c8d-a1b2c3d4e5f6",
+     *         operator_id: "d2e3f4a5-6b7c-8d9e-0f1a-2b3c4d5e6f7a",
+     *         role: "safety_monitor"
+     *     })
      */
     openAssignment(request: NizamDashboard.OpenAssignmentRequest, requestOptions?: AssignmentsClient.RequestOptions): core.HttpResponsePromise<NizamDashboard.Assignment>;
     private __openAssignment;
@@ -69,6 +76,12 @@ export declare class AssignmentsClient {
      *         id: "00000000-0000-0000-0000-000000000000",
      *         reason: "shift_end"
      *     })
+     *
+     * @example
+     *     await client.assignments.closeAssignment({
+     *         id: "00000000-0000-0000-0000-000000000000",
+     *         reason: "incident"
+     *     })
      */
     closeAssignment(request: NizamDashboard.CloseAssignmentRequest, requestOptions?: AssignmentsClient.RequestOptions): core.HttpResponsePromise<NizamDashboard.Assignment>;
     private __closeAssignment;

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

@@ -68,6 +68,13 @@ class AssignmentsClient {
      *         operator_id: "c1d2e3f4-5a6b-7c8d-9e0f-1a2b3c4d5e6f",
      *         role: "primary"
      *     })
+     *
+     * @example
+     *     await client.assignments.openAssignment({
+     *         asset_id: "8f55f0eb-7d3a-4f2c-9c8d-a1b2c3d4e5f6",
+     *         operator_id: "d2e3f4a5-6b7c-8d9e-0f1a-2b3c4d5e6f7a",
+     *         role: "safety_monitor"
+     *     })
      */
     openAssignment(request, requestOptions) {
         return core.HttpResponsePromise.fromPromise(this.__openAssignment(request, requestOptions));
@@ -193,6 +200,12 @@ class AssignmentsClient {
      *         id: "00000000-0000-0000-0000-000000000000",
      *         reason: "shift_end"
      *     })
+     *
+     * @example
+     *     await client.assignments.closeAssignment({
+     *         id: "00000000-0000-0000-0000-000000000000",
+     *         reason: "incident"
+     *     })
      */
     closeAssignment(request, requestOptions) {
         return core.HttpResponsePromise.fromPromise(this.__closeAssignment(request, requestOptions));

package/dist/api/resources/assignments/client/requests/CloseAssignmentRequest.d.ts

@@ -4,6 +4,12 @@
  *         id: "00000000-0000-0000-0000-000000000000",
  *         reason: "shift_end"
  *     }
+ *
+ * @example
+ *     {
+ *         id: "00000000-0000-0000-0000-000000000000",
+ *         reason: "incident"
+ *     }
  */
 export interface CloseAssignmentRequest {
     id: string;

package/dist/api/resources/assignments/client/requests/OpenAssignmentRequest.d.ts

@@ -5,6 +5,13 @@
  *         operator_id: "c1d2e3f4-5a6b-7c8d-9e0f-1a2b3c4d5e6f",
  *         role: "primary"
  *     }
+ *
+ * @example
+ *     {
+ *         asset_id: "8f55f0eb-7d3a-4f2c-9c8d-a1b2c3d4e5f6",
+ *         operator_id: "d2e3f4a5-6b7c-8d9e-0f1a-2b3c4d5e6f7a",
+ *         role: "safety_monitor"
+ *     }
  */
 export interface OpenAssignmentRequest {
     /** Asset id. */

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

@@ -1,5 +1,7 @@
 export * from "./activeOrganization/client/requests/index.js";
 export * as activeOrganization from "./activeOrganization/index.js";
+export * from "./activity/client/requests/index.js";
+export * as activity from "./activity/index.js";
 export * from "./assets/client/requests/index.js";
 export * as assets from "./assets/index.js";
 export * from "./assignments/client/requests/index.js";
@@ -13,5 +15,6 @@ export * from "./operators/client/requests/index.js";
 export * as operators from "./operators/index.js";
 export * from "./organizations/client/requests/index.js";
 export * as organizations from "./organizations/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,9 +36,11 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.users = exports.organizations = exports.operators = exports.memberships = exports.lookups = exports.invites = exports.assignments = exports.assets = exports.activeOrganization = void 0;
+exports.users = exports.realtime = exports.organizations = exports.operators = exports.memberships = exports.lookups = exports.invites = exports.assignments = exports.assets = exports.activity = exports.activeOrganization = void 0;
 __exportStar(require("./activeOrganization/client/requests/index.js"), exports);
 exports.activeOrganization = __importStar(require("./activeOrganization/index.js"));
+__exportStar(require("./activity/client/requests/index.js"), exports);
+exports.activity = __importStar(require("./activity/index.js"));
 __exportStar(require("./assets/client/requests/index.js"), exports);
 exports.assets = __importStar(require("./assets/index.js"));
 __exportStar(require("./assignments/client/requests/index.js"), exports);
@@ -52,5 +54,6 @@ __exportStar(require("./operators/client/requests/index.js"), exports);
 exports.operators = __importStar(require("./operators/index.js"));
 __exportStar(require("./organizations/client/requests/index.js"), exports);
 exports.organizations = __importStar(require("./organizations/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/invites/client/Client.d.ts

@@ -28,8 +28,23 @@ export declare class InvitesClient {
      *     await client.invites.createInvite({
      *         organization_id: "8f55f0eb-7d3a-4f2c-9c8d-a1b2c3d4e5f6",
      *         email: "ali@nizam.ai",
+     *         role: "admin"
+     *     })
+     *
+     * @example
+     *     await client.invites.createInvite({
+     *         organization_id: "8f55f0eb-7d3a-4f2c-9c8d-a1b2c3d4e5f6",
+     *         email: "jordan@example.com",
      *         role: "dispatcher",
-     *         ttl_days: 7
+     *         ttl_days: 14
+     *     })
+     *
+     * @example
+     *     await client.invites.createInvite({
+     *         organization_id: "8f55f0eb-7d3a-4f2c-9c8d-a1b2c3d4e5f6",
+     *         email: "auditor@partner.example",
+     *         role: "viewer",
+     *         ttl_days: 3
      *     })
      */
     createInvite(request: NizamDashboard.CreateInviteRequest, requestOptions?: InvitesClient.RequestOptions): core.HttpResponsePromise<NizamDashboard.Invite>;

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

@@ -64,8 +64,23 @@ class InvitesClient {
      *     await client.invites.createInvite({
      *         organization_id: "8f55f0eb-7d3a-4f2c-9c8d-a1b2c3d4e5f6",
      *         email: "ali@nizam.ai",
+     *         role: "admin"
+     *     })
+     *
+     * @example
+     *     await client.invites.createInvite({
+     *         organization_id: "8f55f0eb-7d3a-4f2c-9c8d-a1b2c3d4e5f6",
+     *         email: "jordan@example.com",
      *         role: "dispatcher",
-     *         ttl_days: 7
+     *         ttl_days: 14
+     *     })
+     *
+     * @example
+     *     await client.invites.createInvite({
+     *         organization_id: "8f55f0eb-7d3a-4f2c-9c8d-a1b2c3d4e5f6",
+     *         email: "auditor@partner.example",
+     *         role: "viewer",
+     *         ttl_days: 3
      *     })
      */
     createInvite(request, requestOptions) {

package/dist/api/resources/invites/client/requests/CreateInviteRequest.d.ts

@@ -3,8 +3,23 @@
  *     {
  *         organization_id: "8f55f0eb-7d3a-4f2c-9c8d-a1b2c3d4e5f6",
  *         email: "ali@nizam.ai",
+ *         role: "admin"
+ *     }
+ *
+ * @example
+ *     {
+ *         organization_id: "8f55f0eb-7d3a-4f2c-9c8d-a1b2c3d4e5f6",
+ *         email: "jordan@example.com",
  *         role: "dispatcher",
- *         ttl_days: 7
+ *         ttl_days: 14
+ *     }
+ *
+ * @example
+ *     {
+ *         organization_id: "8f55f0eb-7d3a-4f2c-9c8d-a1b2c3d4e5f6",
+ *         email: "auditor@partner.example",
+ *         role: "viewer",
+ *         ttl_days: 3
  *     }
  */
 export interface CreateInviteRequest {

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

@@ -47,6 +47,11 @@ export declare class OrganizationsClient {
      *
      * @example
      *     await client.organizations.createOrganization({
+     *         name: "Acme Logistics"
+     *     })
+     *
+     * @example
+     *     await client.organizations.createOrganization({
      *         name: "Acme Logistics",
      *         slug: "acme-logistics",
      *         primary_domain: "acme.com",
@@ -114,12 +119,15 @@ export declare class OrganizationsClient {
      * @example
      *     await client.organizations.updateOrganization({
      *         id: "00000000-0000-0000-0000-000000000000",
-     *         name: "Acme Logistics",
-     *         slug: "acme-logistics",
-     *         business_category: "third_party_logistics",
-     *         phone: "+15551234567",
-     *         country: "US",
-     *         timezone: "America/Los_Angeles"
+     *         name: "Acme Freight"
+     *     })
+     *
+     * @example
+     *     await client.organizations.updateOrganization({
+     *         id: "00000000-0000-0000-0000-000000000000",
+     *         business_category: "courier",
+     *         phone: "+15557654321",
+     *         timezone: "America/New_York"
      *     })
      */
     updateOrganization(request: NizamDashboard.UpdateOrganizationRequest, requestOptions?: OrganizationsClient.RequestOptions): core.HttpResponsePromise<NizamDashboard.Organization>;

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

@@ -135,6 +135,11 @@ class OrganizationsClient {
      *
      * @example
      *     await client.organizations.createOrganization({
+     *         name: "Acme Logistics"
+     *     })
+     *
+     * @example
+     *     await client.organizations.createOrganization({
      *         name: "Acme Logistics",
      *         slug: "acme-logistics",
      *         primary_domain: "acme.com",
@@ -329,12 +334,15 @@ class OrganizationsClient {
      * @example
      *     await client.organizations.updateOrganization({
      *         id: "00000000-0000-0000-0000-000000000000",
-     *         name: "Acme Logistics",
-     *         slug: "acme-logistics",
-     *         business_category: "third_party_logistics",
-     *         phone: "+15551234567",
-     *         country: "US",
-     *         timezone: "America/Los_Angeles"
+     *         name: "Acme Freight"
+     *     })
+     *
+     * @example
+     *     await client.organizations.updateOrganization({
+     *         id: "00000000-0000-0000-0000-000000000000",
+     *         business_category: "courier",
+     *         phone: "+15557654321",
+     *         timezone: "America/New_York"
      *     })
      */
     updateOrganization(request, requestOptions) {

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

@@ -1,4 +1,9 @@
 /**
+ * @example
+ *     {
+ *         name: "Acme Logistics"
+ *     }
+ *
  * @example
  *     {
  *         name: "Acme Logistics",

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

@@ -2,12 +2,15 @@
  * @example
  *     {
  *         id: "00000000-0000-0000-0000-000000000000",
- *         name: "Acme Logistics",
- *         slug: "acme-logistics",
- *         business_category: "third_party_logistics",
- *         phone: "+15551234567",
- *         country: "US",
- *         timezone: "America/Los_Angeles"
+ *         name: "Acme Freight"
+ *     }
+ *
+ * @example
+ *     {
+ *         id: "00000000-0000-0000-0000-000000000000",
+ *         business_category: "courier",
+ *         phone: "+15557654321",
+ *         timezone: "America/New_York"
  *     }
  */
 export interface UpdateOrganizationRequest {

package/dist/api/resources/realtime/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 NizamDashboard from "../../../index.js";
+export declare namespace RealtimeClient {
+    type Options = BaseClientOptions;
+    interface RequestOptions extends BaseRequestOptions {
+    }
+}
+/**
+ * Realtime (STOMP/WebSocket) session bootstrap — mint a ticket to open a connection.
+ */
+export declare class RealtimeClient {
+    protected readonly _options: NormalizedClientOptionsWithAuth<RealtimeClient.Options>;
+    constructor(options: RealtimeClient.Options);
+    /**
+     * Returns a short-lived ticket to present as `Authorization: Bearer <ticket>` on the STOMP CONNECT frame to `/ws`. Browser clients need this because their Keycloak access token lives in an HTTP-only cookie that JavaScript cannot read; native/mobile clients holding a Keycloak access token may present it directly on CONNECT and skip this call. Mint a fresh ticket per connection attempt — it expires within seconds.
+     *
+     * @param {RealtimeClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link NizamDashboard.UnauthorizedError}
+     * @throws {@link NizamDashboard.ForbiddenError}
+     * @throws {@link NizamDashboard.InternalServerError}
+     *
+     * @example
+     *     await client.realtime.createRealtimeTicket()
+     */
+    createRealtimeTicket(requestOptions?: RealtimeClient.RequestOptions): core.HttpResponsePromise<NizamDashboard.RealtimeTicket>;
+    private __createRealtimeTicket;
+}

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

@@ -0,0 +1,105 @@
+"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.RealtimeClient = 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"));
+/**
+ * Realtime (STOMP/WebSocket) session bootstrap — mint a ticket to open a connection.
+ */
+class RealtimeClient {
+    constructor(options) {
+        this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
+    }
+    /**
+     * Returns a short-lived ticket to present as `Authorization: Bearer <ticket>` on the STOMP CONNECT frame to `/ws`. Browser clients need this because their Keycloak access token lives in an HTTP-only cookie that JavaScript cannot read; native/mobile clients holding a Keycloak access token may present it directly on CONNECT and skip this call. Mint a fresh ticket per connection attempt — it expires within seconds.
+     *
+     * @param {RealtimeClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link NizamDashboard.UnauthorizedError}
+     * @throws {@link NizamDashboard.ForbiddenError}
+     * @throws {@link NizamDashboard.InternalServerError}
+     *
+     * @example
+     *     await client.realtime.createRealtimeTicket()
+     */
+    createRealtimeTicket(requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__createRealtimeTicket(requestOptions));
+    }
+    async __createRealtimeTicket(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/realtime/tickets"),
+            method: "POST",
+            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 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, "POST", "/v1/realtime/tickets");
+    }
+}
+exports.RealtimeClient = RealtimeClient;

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

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

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

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

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

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

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

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

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

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

@@ -72,6 +72,11 @@ export declare class UsersClient {
      *         email: "newhire@acme.example",
      *         name: "New Hire"
      *     })
+     *
+     * @example
+     *     await client.users.inviteUser({
+     *         email: "newhire@acme.example"
+     *     })
      */
     inviteUser(request: NizamDashboard.InviteUserRequest, requestOptions?: UsersClient.RequestOptions): core.HttpResponsePromise<NizamDashboard.UserResource>;
     private __inviteUser;

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

@@ -202,6 +202,11 @@ class UsersClient {
      *         email: "newhire@acme.example",
      *         name: "New Hire"
      *     })
+     *
+     * @example
+     *     await client.users.inviteUser({
+     *         email: "newhire@acme.example"
+     *     })
      */
     inviteUser(request, requestOptions) {
         return core.HttpResponsePromise.fromPromise(this.__inviteUser(request, requestOptions));

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

@@ -4,6 +4,11 @@
  *         email: "newhire@acme.example",
  *         name: "New Hire"
  *     }
+ *
+ * @example
+ *     {
+ *         email: "newhire@acme.example"
+ *     }
  */
 export interface InviteUserRequest {
     /** Recipient email. */

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

@@ -0,0 +1,55 @@
+/**
+ * One entry in an organization's activity feed (append-only audit timeline).
+ */
+export interface ActivityResource {
+    /** Stable UUID of this activity row — the resource id and pagination key. */
+    id?: string | undefined;
+    /** Per-publication idempotency key — equal to the realtime ActivityFeedItem's `id` for the same event, so a client can dedupe realtime against REST. Null for directly-written audit rows. */
+    event_id?: string | undefined;
+    /** Canonical event verb. */
+    event?: ActivityResource.Event | undefined;
+    /** Human-readable narrative shown in the feed UI. */
+    description?: string | undefined;
+    /** Type of the entity the action targeted (polymorphic subject). */
+    subject_type?: string | undefined;
+    /** Id of the entity the action targeted. */
+    subject_id?: string | undefined;
+    /** Type of the actor that performed the action. */
+    causer_type?: string | undefined;
+    /** Id of the actor that performed the action. Null for system/scheduled actions. */
+    causer_id?: string | undefined;
+    /** Optional UI filtering bucket. */
+    log_name?: string | undefined;
+    /** When the activity was recorded — the authoritative timestamp. */
+    occurred_at?: string | undefined;
+    /** Object type discriminator (Stripe pattern). */
+    object?: ActivityResource.Object_ | undefined;
+}
+export declare namespace ActivityResource {
+    /** Canonical event verb. */
+    const Event: {
+        readonly Created: "created";
+        readonly Updated: "updated";
+        readonly Deleted: "deleted";
+        readonly Restored: "restored";
+        readonly StateChanged: "state_changed";
+        readonly Assigned: "assigned";
+        readonly Unassigned: "unassigned";
+        readonly Completed: "completed";
+        readonly Failed: "failed";
+        readonly Cancelled: "cancelled";
+        readonly Sent: "sent";
+        readonly Received: "received";
+        readonly Attached: "attached";
+        readonly Detached: "detached";
+        readonly LoggedIn: "logged_in";
+        readonly LoggedOut: "logged_out";
+        readonly Custom: "custom";
+    };
+    type Event = (typeof Event)[keyof typeof Event];
+    /** Object type discriminator (Stripe pattern). */
+    const Object_: {
+        readonly Activity: "activity";
+    };
+    type Object_ = (typeof Object_)[keyof typeof Object_];
+}

package/dist/api/types/ActivityResource.js

@@ -0,0 +1,31 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ActivityResource = void 0;
+var ActivityResource;
+(function (ActivityResource) {
+    /** Canonical event verb. */
+    ActivityResource.Event = {
+        Created: "created",
+        Updated: "updated",
+        Deleted: "deleted",
+        Restored: "restored",
+        StateChanged: "state_changed",
+        Assigned: "assigned",
+        Unassigned: "unassigned",
+        Completed: "completed",
+        Failed: "failed",
+        Cancelled: "cancelled",
+        Sent: "sent",
+        Received: "received",
+        Attached: "attached",
+        Detached: "detached",
+        LoggedIn: "logged_in",
+        LoggedOut: "logged_out",
+        Custom: "custom",
+    };
+    /** Object type discriminator (Stripe pattern). */
+    ActivityResource.Object_ = {
+        Activity: "activity",
+    };
+})(ActivityResource || (exports.ActivityResource = ActivityResource = {}));