@nizam-os/dashboard-sdk 10.0.0 → 11.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/api/resources/activity/client/Client.d.ts +1 -1
- package/dist/api/resources/activity/client/Client.js +2 -2
- package/dist/api/resources/activity/client/requests/ListActivityRequest.d.ts +3 -2
- package/dist/api/resources/activity/index.d.ts +1 -0
- package/dist/api/resources/activity/index.js +1 -0
- package/dist/api/resources/activity/types/ListActivityRequestSortItem.d.ts +5 -0
- package/dist/api/resources/activity/types/ListActivityRequestSortItem.js +8 -0
- package/dist/api/resources/activity/types/index.d.ts +1 -0
- package/dist/api/resources/activity/types/index.js +17 -0
- package/dist/api/resources/assets/client/Client.d.ts +256 -1
- package/dist/api/resources/assets/client/Client.js +764 -5
- package/dist/api/resources/assets/client/requests/ActivateAssetRequest.d.ts +9 -0
- package/dist/api/resources/assets/client/requests/ActivateAssetRequest.js +3 -0
- package/dist/api/resources/assets/client/requests/AllowedTransitionsRequest.d.ts +10 -0
- package/dist/api/resources/assets/client/requests/AllowedTransitionsRequest.js +3 -0
- package/dist/api/resources/assets/client/requests/CreateAssetRequest.d.ts +25 -0
- package/dist/api/resources/assets/client/requests/CreateAssetRequest.js +10 -0
- package/dist/api/resources/assets/client/requests/DeactivateAssetRequest.d.ts +9 -0
- package/dist/api/resources/assets/client/requests/DeactivateAssetRequest.js +3 -0
- package/dist/api/resources/assets/client/requests/DeleteAssetRequest.d.ts +9 -0
- package/dist/api/resources/assets/client/requests/DeleteAssetRequest.js +3 -0
- package/dist/api/resources/assets/client/requests/EnterAssetMaintenanceRequest.d.ts +9 -0
- package/dist/api/resources/assets/client/requests/EnterAssetMaintenanceRequest.js +3 -0
- package/dist/api/resources/assets/client/requests/ExportAssetsRequest.d.ts +44 -0
- package/dist/api/resources/assets/client/requests/ExportAssetsRequest.js +31 -0
- package/dist/api/resources/assets/client/requests/ListAssetsRequest.d.ts +13 -6
- package/dist/api/resources/assets/client/requests/ReportAssetLostRequest.d.ts +9 -0
- package/dist/api/resources/assets/client/requests/ReportAssetLostRequest.js +3 -0
- package/dist/api/resources/assets/client/requests/RetireAssetRequest.d.ts +9 -0
- package/dist/api/resources/assets/client/requests/RetireAssetRequest.js +3 -0
- package/dist/api/resources/assets/client/requests/SellAssetRequest.d.ts +9 -0
- package/dist/api/resources/assets/client/requests/SellAssetRequest.js +3 -0
- package/dist/api/resources/assets/client/requests/TakeAssetOutOfServiceRequest.d.ts +9 -0
- package/dist/api/resources/assets/client/requests/TakeAssetOutOfServiceRequest.js +3 -0
- package/dist/api/resources/assets/client/requests/UpdateAssetRequest.d.ts +36 -0
- package/dist/api/resources/assets/client/requests/UpdateAssetRequest.js +3 -0
- package/dist/api/resources/assets/client/requests/index.d.ts +11 -0
- package/dist/api/resources/assets/client/requests/index.js +3 -1
- package/dist/api/resources/assets/index.d.ts +1 -0
- package/dist/api/resources/assets/index.js +1 -0
- package/dist/api/resources/assets/types/ListAssetsRequestKindItem.d.ts +12 -0
- package/dist/api/resources/assets/types/ListAssetsRequestKindItem.js +15 -0
- package/dist/api/resources/assets/types/ListAssetsRequestSortItem.d.ts +25 -0
- package/dist/api/resources/assets/types/ListAssetsRequestSortItem.js +28 -0
- package/dist/api/resources/assets/types/ListAssetsRequestStatusItem.d.ts +10 -0
- package/dist/api/resources/assets/types/ListAssetsRequestStatusItem.js +13 -0
- package/dist/api/resources/assets/types/index.d.ts +3 -0
- package/dist/api/resources/assets/types/index.js +19 -0
- package/dist/api/resources/files/client/Client.d.ts +1 -1
- package/dist/api/resources/files/client/Client.js +4 -4
- package/dist/api/resources/files/client/requests/InitiateFileUploadRequest.d.ts +1 -0
- package/dist/api/resources/files/client/requests/InitiateFileUploadRequest.js +1 -0
- package/dist/api/resources/files/client/requests/ListFilesRequest.d.ts +7 -6
- package/dist/api/resources/files/index.d.ts +1 -0
- package/dist/api/resources/files/index.js +1 -0
- package/dist/api/resources/files/types/ListFilesRequestKindItem.d.ts +11 -0
- package/dist/api/resources/files/types/ListFilesRequestKindItem.js +14 -0
- package/dist/api/resources/files/types/ListFilesRequestSortItem.d.ts +5 -0
- package/dist/api/resources/files/types/ListFilesRequestSortItem.js +8 -0
- package/dist/api/resources/files/types/ListFilesRequestStatusItem.d.ts +6 -0
- package/dist/api/resources/files/types/ListFilesRequestStatusItem.js +9 -0
- package/dist/api/resources/files/types/index.d.ts +3 -0
- package/dist/api/resources/files/types/index.js +19 -0
- package/dist/api/resources/index.d.ts +7 -0
- package/dist/api/resources/index.js +7 -0
- package/dist/api/resources/jobs/client/Client.d.ts +1 -1
- package/dist/api/resources/jobs/client/Client.js +2 -2
- package/dist/api/resources/jobs/client/requests/ListJobsRequest.d.ts +3 -2
- package/dist/api/resources/jobs/index.d.ts +1 -0
- package/dist/api/resources/jobs/index.js +1 -0
- package/dist/api/resources/jobs/types/ListJobsRequestSortItem.d.ts +5 -0
- package/dist/api/resources/jobs/types/ListJobsRequestSortItem.js +8 -0
- package/dist/api/resources/jobs/types/index.d.ts +1 -0
- package/dist/api/resources/jobs/types/index.js +17 -0
- package/dist/api/resources/notifications/client/Client.d.ts +1 -1
- package/dist/api/resources/notifications/client/Client.js +2 -2
- package/dist/api/resources/notifications/client/requests/ListNotificationsRequest.d.ts +3 -2
- package/dist/api/resources/notifications/index.d.ts +1 -0
- package/dist/api/resources/notifications/index.js +1 -0
- package/dist/api/resources/notifications/types/ListNotificationsRequestSortItem.d.ts +5 -0
- package/dist/api/resources/notifications/types/ListNotificationsRequestSortItem.js +8 -0
- package/dist/api/resources/notifications/types/index.d.ts +1 -0
- package/dist/api/resources/notifications/types/index.js +17 -0
- package/dist/api/resources/organizations/client/Client.d.ts +2 -2
- package/dist/api/resources/organizations/client/Client.js +3 -3
- package/dist/api/resources/organizations/client/requests/ListOrganizationsRequest.d.ts +3 -2
- package/dist/api/resources/organizations/index.d.ts +1 -0
- package/dist/api/resources/organizations/index.js +1 -0
- package/dist/api/resources/organizations/types/ListOrganizationsRequestSortItem.d.ts +5 -0
- package/dist/api/resources/organizations/types/ListOrganizationsRequestSortItem.js +8 -0
- package/dist/api/resources/organizations/types/index.d.ts +1 -0
- package/dist/api/resources/organizations/types/index.js +17 -0
- package/dist/api/resources/users/client/Client.d.ts +1 -1
- package/dist/api/resources/users/client/Client.js +2 -2
- package/dist/api/resources/users/client/requests/ListUsersRequest.d.ts +3 -2
- package/dist/api/resources/users/index.d.ts +1 -0
- package/dist/api/resources/users/index.js +1 -0
- package/dist/api/resources/users/types/ListUsersRequestSortItem.d.ts +7 -0
- package/dist/api/resources/users/types/ListUsersRequestSortItem.js +10 -0
- package/dist/api/resources/users/types/index.d.ts +1 -0
- package/dist/api/resources/users/types/index.js +17 -0
- package/dist/api/types/ActiveOrganization.d.ts +2 -2
- package/dist/api/types/ActivityResource.d.ts +4 -4
- package/dist/api/types/AllowedTransitions.d.ts +28 -0
- package/dist/api/types/AllowedTransitions.js +23 -0
- package/dist/api/types/ApiFieldError.d.ts +1 -1
- package/dist/api/types/Asset.d.ts +26 -4
- package/dist/api/types/Asset.js +13 -0
- package/dist/api/types/AssetListItem.d.ts +11 -5
- package/dist/api/types/Assignment.d.ts +6 -6
- package/dist/api/types/BulkJobSubmission.d.ts +3 -3
- package/dist/api/types/BusinessCategory.d.ts +3 -3
- package/dist/api/types/Country.d.ts +3 -3
- package/dist/api/types/Currency.d.ts +5 -5
- package/dist/api/types/Device.d.ts +6 -6
- package/dist/api/types/Devices.d.ts +2 -2
- package/dist/api/types/FileDownloadUrl.d.ts +4 -4
- package/dist/api/types/FileUploadSession.d.ts +12 -11
- package/dist/api/types/FileUploadSession.js +1 -0
- package/dist/api/types/File_.d.ts +14 -13
- package/dist/api/types/File_.js +1 -0
- package/dist/api/types/HeatmapCell.d.ts +4 -4
- package/dist/api/types/ImportError.d.ts +4 -4
- package/dist/api/types/ImportSubmission.d.ts +4 -4
- package/dist/api/types/Invite.d.ts +8 -8
- package/dist/api/types/Job.d.ts +11 -11
- package/dist/api/types/JobSubmission.d.ts +2 -2
- package/dist/api/types/Language.d.ts +4 -4
- package/dist/api/types/Membership.d.ts +3 -3
- package/dist/api/types/MqttToken.d.ts +4 -4
- package/dist/api/types/Notification.d.ts +9 -9
- package/dist/api/types/NotificationCounts.d.ts +5 -5
- package/dist/api/types/NotificationDeadLetter.d.ts +9 -9
- package/dist/api/types/NotificationPreferences.d.ts +2 -2
- package/dist/api/types/NotificationUnreadCount.d.ts +2 -2
- package/dist/api/types/NotificationsArchived.d.ts +2 -2
- package/dist/api/types/NotificationsMarkedRead.d.ts +2 -2
- package/dist/api/types/Operator.d.ts +4 -4
- package/dist/api/types/OperatorAsset.d.ts +64 -0
- package/dist/api/types/OperatorAsset.js +33 -0
- package/dist/api/types/OperatorPosition.d.ts +5 -5
- package/dist/api/types/Organization.d.ts +7 -7
- package/dist/api/types/Position.d.ts +6 -6
- package/dist/api/types/ProblemDetail.d.ts +1 -1
- package/dist/api/types/RealtimeTicket.d.ts +3 -3
- package/dist/api/types/ReconcileResponse.d.ts +4 -4
- package/dist/api/types/TaskAttemptPhoto.d.ts +7 -7
- package/dist/api/types/Timezone.d.ts +4 -4
- package/dist/api/types/UploadInitiation.d.ts +6 -6
- package/dist/api/types/User.d.ts +27 -5
- package/dist/api/types/User.js +19 -0
- package/dist/api/types/UserResource.d.ts +4 -4
- package/dist/api/types/index.d.ts +2 -0
- package/dist/api/types/index.js +2 -0
- package/package.json +1 -1
|
@@ -3,8 +3,8 @@
|
|
|
3
3
|
*/
|
|
4
4
|
export interface JobSubmission {
|
|
5
5
|
/** The created job — poll/cancel it via /v1/jobs/{id}. */
|
|
6
|
-
job_id
|
|
7
|
-
object
|
|
6
|
+
job_id: string;
|
|
7
|
+
object: JobSubmission.Object_;
|
|
8
8
|
}
|
|
9
9
|
export declare namespace JobSubmission {
|
|
10
10
|
const Object_: {
|
|
@@ -3,13 +3,13 @@
|
|
|
3
3
|
*/
|
|
4
4
|
export interface Language {
|
|
5
5
|
/** ISO 639-1 two-letter code. */
|
|
6
|
-
code
|
|
6
|
+
code: string;
|
|
7
7
|
/** Display name in the Accept-Language locale. */
|
|
8
|
-
name
|
|
8
|
+
name: string;
|
|
9
9
|
/** Name in the language itself, useful in language pickers. */
|
|
10
|
-
native_name
|
|
10
|
+
native_name: string;
|
|
11
11
|
/** Object type discriminator. */
|
|
12
|
-
object
|
|
12
|
+
object: Language.Object_;
|
|
13
13
|
}
|
|
14
14
|
export declare namespace Language {
|
|
15
15
|
/** Object type discriminator. */
|
|
@@ -3,11 +3,11 @@ import type * as NizamDashboard from "../index.js";
|
|
|
3
3
|
* An organization the current user belongs to, with their role inside it.
|
|
4
4
|
*/
|
|
5
5
|
export interface Membership {
|
|
6
|
-
organization
|
|
6
|
+
organization: NizamDashboard.Organization;
|
|
7
7
|
/** The user's role in this organization. */
|
|
8
|
-
role
|
|
8
|
+
role: Membership.Role;
|
|
9
9
|
/** Object type discriminator. */
|
|
10
|
-
object
|
|
10
|
+
object: Membership.Object_;
|
|
11
11
|
}
|
|
12
12
|
export declare namespace Membership {
|
|
13
13
|
/** The user's role in this organization. */
|
|
@@ -3,10 +3,10 @@
|
|
|
3
3
|
*/
|
|
4
4
|
export interface MqttToken {
|
|
5
5
|
/** JWT to present as the MQTT CONNECT password. The CONNECT username must be the operator id embedded in the token's operator_id claim. */
|
|
6
|
-
token
|
|
6
|
+
token: string;
|
|
7
7
|
/** Seconds until the token expires. Re-mint before this elapses to stay connected. */
|
|
8
|
-
expires_in
|
|
8
|
+
expires_in: number;
|
|
9
9
|
/** The only topic this credential may publish to: nizam/{organizationId}/operators/{operatorId}/location. */
|
|
10
|
-
topic
|
|
11
|
-
object
|
|
10
|
+
topic: string;
|
|
11
|
+
object: string;
|
|
12
12
|
}
|
|
@@ -3,27 +3,27 @@
|
|
|
3
3
|
*/
|
|
4
4
|
export interface Notification {
|
|
5
5
|
/** Object type discriminator. */
|
|
6
|
-
object
|
|
6
|
+
object: Notification.Object_;
|
|
7
7
|
/** Notification id. */
|
|
8
|
-
id
|
|
8
|
+
id: string;
|
|
9
9
|
/** Notification kind (stable wire key). */
|
|
10
|
-
kind
|
|
10
|
+
kind: string;
|
|
11
11
|
/** Opt-out / grouping category. */
|
|
12
|
-
category
|
|
12
|
+
category: Notification.Category;
|
|
13
13
|
/** Delivery priority. */
|
|
14
|
-
priority
|
|
14
|
+
priority: Notification.Priority;
|
|
15
15
|
/** Kind-specific render payload. */
|
|
16
|
-
data
|
|
16
|
+
data: Record<string, Record<string, unknown>>;
|
|
17
17
|
/** Whether the recipient has read it. */
|
|
18
|
-
read
|
|
18
|
+
read: boolean;
|
|
19
19
|
/** When it was read (RFC 3339); null while unread. */
|
|
20
20
|
read_at?: string | undefined;
|
|
21
21
|
/** Whether the recipient has archived ("Done") it. */
|
|
22
|
-
archived
|
|
22
|
+
archived: boolean;
|
|
23
23
|
/** When it was archived (RFC 3339); null while in the active inbox. */
|
|
24
24
|
archived_at?: string | undefined;
|
|
25
25
|
/** When it was raised (RFC 3339). */
|
|
26
|
-
created_at
|
|
26
|
+
created_at: string;
|
|
27
27
|
}
|
|
28
28
|
export declare namespace Notification {
|
|
29
29
|
/** Object type discriminator. */
|
|
@@ -4,15 +4,15 @@ import type * as NizamDashboard from "../index.js";
|
|
|
4
4
|
*/
|
|
5
5
|
export interface NotificationCounts {
|
|
6
6
|
/** Active (non-archived) notifications. */
|
|
7
|
-
total
|
|
7
|
+
total: number;
|
|
8
8
|
/** Active unread notifications. */
|
|
9
|
-
unread
|
|
9
|
+
unread: number;
|
|
10
10
|
/** Archived ("Done") notifications. */
|
|
11
|
-
archived
|
|
11
|
+
archived: number;
|
|
12
12
|
/** Per-category active counts; categories with no active row are omitted. */
|
|
13
|
-
categories
|
|
13
|
+
categories: NizamDashboard.NotificationCategoryCount[];
|
|
14
14
|
/** Object type discriminator. */
|
|
15
|
-
object
|
|
15
|
+
object: NotificationCounts.Object_;
|
|
16
16
|
}
|
|
17
17
|
export declare namespace NotificationCounts {
|
|
18
18
|
/** Object type discriminator. */
|
|
@@ -3,19 +3,19 @@
|
|
|
3
3
|
*/
|
|
4
4
|
export interface NotificationDeadLetter {
|
|
5
5
|
/** Delivery attempt id. */
|
|
6
|
-
id
|
|
6
|
+
id: string;
|
|
7
7
|
/** The notification this attempt belongs to. */
|
|
8
|
-
notification_id
|
|
8
|
+
notification_id: string;
|
|
9
9
|
/** Owning organization. */
|
|
10
|
-
organization_id
|
|
10
|
+
organization_id: string;
|
|
11
11
|
/** Channel. */
|
|
12
|
-
channel
|
|
12
|
+
channel: string;
|
|
13
13
|
/** Provider/gateway. */
|
|
14
|
-
provider
|
|
14
|
+
provider: string;
|
|
15
15
|
/** Resolved recipient endpoint (device id, email, user id). */
|
|
16
|
-
recipient_address
|
|
16
|
+
recipient_address: string;
|
|
17
17
|
/** Number of send attempts made. */
|
|
18
|
-
attempt_count
|
|
18
|
+
attempt_count: number;
|
|
19
19
|
/** Machine error code from the last attempt. */
|
|
20
20
|
error_code?: string | undefined;
|
|
21
21
|
/** Human-readable error from the last attempt. */
|
|
@@ -23,9 +23,9 @@ export interface NotificationDeadLetter {
|
|
|
23
23
|
/** When it dead-lettered (RFC 3339). */
|
|
24
24
|
failed_at?: string | undefined;
|
|
25
25
|
/** When the attempt row was created (RFC 3339). */
|
|
26
|
-
created_at
|
|
26
|
+
created_at: string;
|
|
27
27
|
/** Object type discriminator. */
|
|
28
|
-
object
|
|
28
|
+
object: NotificationDeadLetter.Object_;
|
|
29
29
|
}
|
|
30
30
|
export declare namespace NotificationDeadLetter {
|
|
31
31
|
/** Object type discriminator. */
|
|
@@ -4,9 +4,9 @@ import type * as NizamDashboard from "../index.js";
|
|
|
4
4
|
*/
|
|
5
5
|
export interface NotificationPreferences {
|
|
6
6
|
/** The user's explicit per-kind × channel overrides. */
|
|
7
|
-
preferences
|
|
7
|
+
preferences: NizamDashboard.NotificationPreference[];
|
|
8
8
|
/** Object type discriminator. */
|
|
9
|
-
object
|
|
9
|
+
object: NotificationPreferences.Object_;
|
|
10
10
|
}
|
|
11
11
|
export declare namespace NotificationPreferences {
|
|
12
12
|
/** Object type discriminator. */
|
|
@@ -3,9 +3,9 @@
|
|
|
3
3
|
*/
|
|
4
4
|
export interface NotificationUnreadCount {
|
|
5
5
|
/** Number of unread notifications. */
|
|
6
|
-
count
|
|
6
|
+
count: number;
|
|
7
7
|
/** Object type discriminator. */
|
|
8
|
-
object
|
|
8
|
+
object: NotificationUnreadCount.Object_;
|
|
9
9
|
}
|
|
10
10
|
export declare namespace NotificationUnreadCount {
|
|
11
11
|
/** Object type discriminator. */
|
|
@@ -3,9 +3,9 @@
|
|
|
3
3
|
*/
|
|
4
4
|
export interface NotificationsArchived {
|
|
5
5
|
/** Number of notifications archived. */
|
|
6
|
-
archived
|
|
6
|
+
archived: number;
|
|
7
7
|
/** Object type discriminator. */
|
|
8
|
-
object
|
|
8
|
+
object: NotificationsArchived.Object_;
|
|
9
9
|
}
|
|
10
10
|
export declare namespace NotificationsArchived {
|
|
11
11
|
/** Object type discriminator. */
|
|
@@ -3,9 +3,9 @@
|
|
|
3
3
|
*/
|
|
4
4
|
export interface NotificationsMarkedRead {
|
|
5
5
|
/** Number of notifications flipped to read. */
|
|
6
|
-
marked
|
|
6
|
+
marked: number;
|
|
7
7
|
/** Object type discriminator. */
|
|
8
|
-
object
|
|
8
|
+
object: NotificationsMarkedRead.Object_;
|
|
9
9
|
}
|
|
10
10
|
export declare namespace NotificationsMarkedRead {
|
|
11
11
|
/** Object type discriminator. */
|
|
@@ -3,11 +3,11 @@
|
|
|
3
3
|
*/
|
|
4
4
|
export interface Operator {
|
|
5
5
|
/** Stable UUID. */
|
|
6
|
-
id
|
|
6
|
+
id: string;
|
|
7
7
|
/** Kind discriminator. */
|
|
8
|
-
kind
|
|
8
|
+
kind: Operator.Kind;
|
|
9
9
|
/** Lifecycle status. */
|
|
10
|
-
status
|
|
10
|
+
status: Operator.Status;
|
|
11
11
|
/** Display name. */
|
|
12
12
|
display_name?: string | undefined;
|
|
13
13
|
/** Linked user id (humans with a Nizam login). Null for software agents. */
|
|
@@ -17,7 +17,7 @@ export interface Operator {
|
|
|
17
17
|
/** Owning organization id. */
|
|
18
18
|
organization_id?: string | undefined;
|
|
19
19
|
/** Object type discriminator. */
|
|
20
|
-
object
|
|
20
|
+
object: Operator.Object_;
|
|
21
21
|
}
|
|
22
22
|
export declare namespace Operator {
|
|
23
23
|
/** Kind discriminator. */
|
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* An asset as seen by an operator assigned to operate it — the operational identity fields, without the dashboard's lifecycle-management hints.
|
|
3
|
+
*/
|
|
4
|
+
export interface OperatorAsset {
|
|
5
|
+
/** Stable UUID. */
|
|
6
|
+
id: string;
|
|
7
|
+
/** Top-level kind. */
|
|
8
|
+
kind: OperatorAsset.Kind;
|
|
9
|
+
/** Sub-kind within the kind (free-form). */
|
|
10
|
+
sub_kind?: string | undefined;
|
|
11
|
+
/** SAE J3016 autonomy level 0..5. */
|
|
12
|
+
autonomy_level?: number | undefined;
|
|
13
|
+
/** Lifecycle status. */
|
|
14
|
+
status: OperatorAsset.Status;
|
|
15
|
+
/** Display name. */
|
|
16
|
+
name?: string | undefined;
|
|
17
|
+
/** Vehicle Identification Number. */
|
|
18
|
+
vin?: string | undefined;
|
|
19
|
+
/** License plate. */
|
|
20
|
+
plate_number?: string | undefined;
|
|
21
|
+
/** Manufacturer. */
|
|
22
|
+
make?: string | undefined;
|
|
23
|
+
/** Model designation. */
|
|
24
|
+
model?: string | undefined;
|
|
25
|
+
/** Model year. */
|
|
26
|
+
year?: number | undefined;
|
|
27
|
+
/** Owning organization id. */
|
|
28
|
+
organization_id?: string | undefined;
|
|
29
|
+
/** Current primary operator (active assignment, role=primary). */
|
|
30
|
+
current_primary_operator_id?: string | undefined;
|
|
31
|
+
/** Object type discriminator. */
|
|
32
|
+
object: OperatorAsset.Object_;
|
|
33
|
+
}
|
|
34
|
+
export declare namespace OperatorAsset {
|
|
35
|
+
/** Top-level kind. */
|
|
36
|
+
const Kind: {
|
|
37
|
+
readonly GroundVehicle: "ground_vehicle";
|
|
38
|
+
readonly AerialVehicle: "aerial_vehicle";
|
|
39
|
+
readonly MarineVehicle: "marine_vehicle";
|
|
40
|
+
readonly Robot: "robot";
|
|
41
|
+
readonly Agv: "agv";
|
|
42
|
+
readonly Trailer: "trailer";
|
|
43
|
+
readonly Container: "container";
|
|
44
|
+
readonly Pallet: "pallet";
|
|
45
|
+
readonly Equipment: "equipment";
|
|
46
|
+
};
|
|
47
|
+
type Kind = (typeof Kind)[keyof typeof Kind];
|
|
48
|
+
/** Lifecycle status. */
|
|
49
|
+
const Status: {
|
|
50
|
+
readonly Active: "active";
|
|
51
|
+
readonly Maintenance: "maintenance";
|
|
52
|
+
readonly OutOfService: "out_of_service";
|
|
53
|
+
readonly Retired: "retired";
|
|
54
|
+
readonly Sold: "sold";
|
|
55
|
+
readonly Inactive: "inactive";
|
|
56
|
+
readonly Lost: "lost";
|
|
57
|
+
};
|
|
58
|
+
type Status = (typeof Status)[keyof typeof Status];
|
|
59
|
+
/** Object type discriminator. */
|
|
60
|
+
const Object_: {
|
|
61
|
+
readonly Asset: "asset";
|
|
62
|
+
};
|
|
63
|
+
type Object_ = (typeof Object_)[keyof typeof Object_];
|
|
64
|
+
}
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.OperatorAsset = void 0;
|
|
5
|
+
var OperatorAsset;
|
|
6
|
+
(function (OperatorAsset) {
|
|
7
|
+
/** Top-level kind. */
|
|
8
|
+
OperatorAsset.Kind = {
|
|
9
|
+
GroundVehicle: "ground_vehicle",
|
|
10
|
+
AerialVehicle: "aerial_vehicle",
|
|
11
|
+
MarineVehicle: "marine_vehicle",
|
|
12
|
+
Robot: "robot",
|
|
13
|
+
Agv: "agv",
|
|
14
|
+
Trailer: "trailer",
|
|
15
|
+
Container: "container",
|
|
16
|
+
Pallet: "pallet",
|
|
17
|
+
Equipment: "equipment",
|
|
18
|
+
};
|
|
19
|
+
/** Lifecycle status. */
|
|
20
|
+
OperatorAsset.Status = {
|
|
21
|
+
Active: "active",
|
|
22
|
+
Maintenance: "maintenance",
|
|
23
|
+
OutOfService: "out_of_service",
|
|
24
|
+
Retired: "retired",
|
|
25
|
+
Sold: "sold",
|
|
26
|
+
Inactive: "inactive",
|
|
27
|
+
Lost: "lost",
|
|
28
|
+
};
|
|
29
|
+
/** Object type discriminator. */
|
|
30
|
+
OperatorAsset.Object_ = {
|
|
31
|
+
Asset: "asset",
|
|
32
|
+
};
|
|
33
|
+
})(OperatorAsset || (exports.OperatorAsset = OperatorAsset = {}));
|
|
@@ -3,11 +3,11 @@
|
|
|
3
3
|
*/
|
|
4
4
|
export interface OperatorPosition {
|
|
5
5
|
/** Operator id. */
|
|
6
|
-
operator_id
|
|
6
|
+
operator_id: string;
|
|
7
7
|
/** Latitude (WGS84). */
|
|
8
|
-
lat
|
|
8
|
+
lat: number;
|
|
9
9
|
/** Longitude (WGS84). */
|
|
10
|
-
lng
|
|
10
|
+
lng: number;
|
|
11
11
|
/** Direction of travel, compass degrees [0,360). */
|
|
12
12
|
heading?: number | undefined;
|
|
13
13
|
/** Course over ground, compass degrees [0,360). */
|
|
@@ -17,8 +17,8 @@ export interface OperatorPosition {
|
|
|
17
17
|
/** Altitude above the WGS84 ellipsoid, metres. */
|
|
18
18
|
altitude?: number | undefined;
|
|
19
19
|
/** Device-time of the fix. */
|
|
20
|
-
captured_at
|
|
21
|
-
object
|
|
20
|
+
captured_at: string;
|
|
21
|
+
object: OperatorPosition.Object_;
|
|
22
22
|
}
|
|
23
23
|
export declare namespace OperatorPosition {
|
|
24
24
|
const Object_: {
|
|
@@ -3,23 +3,23 @@
|
|
|
3
3
|
*/
|
|
4
4
|
export interface Organization {
|
|
5
5
|
/** Stable UUID owned by Nizam. Pin this value in URLs and external integrations. The matching Keycloak Organization is tracked server-side via a separate keycloak_id bridge and is not exposed over the SDK; do not assume the two ids are equal. */
|
|
6
|
-
id
|
|
6
|
+
id: string;
|
|
7
7
|
/** Display name. */
|
|
8
|
-
name
|
|
8
|
+
name: string;
|
|
9
9
|
/** URL-safe identifier — used in deep links and admin tooling. */
|
|
10
|
-
slug
|
|
10
|
+
slug: string;
|
|
11
11
|
/** Lifecycle status. */
|
|
12
|
-
status
|
|
12
|
+
status: Organization.Status;
|
|
13
13
|
/** User id of the human who originally created this organization. Immutable for the row's lifetime — does NOT change when ownership is transferred. */
|
|
14
|
-
founder_user_id
|
|
14
|
+
founder_user_id: string;
|
|
15
15
|
/** User id of the current owner. Receives all admin notifications by default. Mutable; reassigned via ownership transfer. May be null transiently if the owner user has been hard-deleted. */
|
|
16
16
|
owner_user_id?: string | undefined;
|
|
17
17
|
/** When this organization was created. */
|
|
18
|
-
created_at
|
|
18
|
+
created_at: string;
|
|
19
19
|
/** Populated ONLY on the POST /v1/organizations create response — the active organization id Nizam pinned for the founder as part of the same transaction that created the org. Null on every other endpoint (GET, list, membership embeds). Per issue #67 phase 1, the SPA writes its active-org cookie from this field instead of issuing a follow-up PATCH /v1/me/active-organization. */
|
|
20
20
|
active_organization_id?: string | undefined;
|
|
21
21
|
/** Object type discriminator. */
|
|
22
|
-
object
|
|
22
|
+
object: Organization.Object_;
|
|
23
23
|
}
|
|
24
24
|
export declare namespace Organization {
|
|
25
25
|
/** Lifecycle status. */
|
|
@@ -3,13 +3,13 @@
|
|
|
3
3
|
*/
|
|
4
4
|
export interface Position {
|
|
5
5
|
/** Position id. */
|
|
6
|
-
id
|
|
6
|
+
id: string;
|
|
7
7
|
/** Operator the fix belongs to. */
|
|
8
|
-
operator_id
|
|
8
|
+
operator_id: string;
|
|
9
9
|
/** Latitude (WGS84). */
|
|
10
|
-
lat
|
|
10
|
+
lat: number;
|
|
11
11
|
/** Longitude (WGS84). */
|
|
12
|
-
lng
|
|
12
|
+
lng: number;
|
|
13
13
|
/** Direction of travel, compass degrees [0,360). */
|
|
14
14
|
heading?: number | undefined;
|
|
15
15
|
/** Course over ground toward the destination, compass degrees [0,360). */
|
|
@@ -19,8 +19,8 @@ export interface Position {
|
|
|
19
19
|
/** Altitude above the WGS84 ellipsoid, metres. */
|
|
20
20
|
altitude?: number | undefined;
|
|
21
21
|
/** Device-time the fix was captured (authoritative). */
|
|
22
|
-
recorded_at
|
|
23
|
-
object
|
|
22
|
+
recorded_at: string;
|
|
23
|
+
object: Position.Object_;
|
|
24
24
|
}
|
|
25
25
|
export declare namespace Position {
|
|
26
26
|
const Object_: {
|
|
@@ -16,6 +16,6 @@ export interface ProblemDetail {
|
|
|
16
16
|
code: string;
|
|
17
17
|
/** OpenTelemetry trace id from the request — match to logs for support. */
|
|
18
18
|
trace_id?: string | undefined;
|
|
19
|
-
/** Per-field validation
|
|
19
|
+
/** Per-field errors keyed to the offending input. Present on 422 bean-validation failures AND on field-level 409 conflicts (e.g. a duplicate unique value such as a VIN) — bind each entry to its `field`; do not gate handling on `status == 422`. */
|
|
20
20
|
errors?: NizamDashboard.ApiFieldError[] | undefined;
|
|
21
21
|
}
|
|
@@ -3,11 +3,11 @@
|
|
|
3
3
|
*/
|
|
4
4
|
export interface RealtimeTicket {
|
|
5
5
|
/** The signed ticket. Send it as `Authorization: Bearer <ticket>` on the STOMP CONNECT frame to /ws. Opaque to the client; do not parse or store it. */
|
|
6
|
-
ticket
|
|
6
|
+
ticket: string;
|
|
7
7
|
/** When the ticket expires (ISO-8601). Connect promptly; mint a fresh ticket for each new connection attempt. */
|
|
8
|
-
expires_at
|
|
8
|
+
expires_at: string;
|
|
9
9
|
/** Object type discriminator. */
|
|
10
|
-
object
|
|
10
|
+
object: RealtimeTicket.Object_;
|
|
11
11
|
}
|
|
12
12
|
export declare namespace RealtimeTicket {
|
|
13
13
|
/** Object type discriminator. */
|
|
@@ -4,13 +4,13 @@ import type * as NizamDashboard from "../index.js";
|
|
|
4
4
|
*/
|
|
5
5
|
export interface ReconcileResponse {
|
|
6
6
|
/** Nizam org ids whose stored keycloak_id no longer resolves on the KC side. */
|
|
7
|
-
nizam_has_kc_missing
|
|
7
|
+
nizam_has_kc_missing: string[];
|
|
8
8
|
/** KC org ids with no matching Nizam organizations.keycloak_id row. */
|
|
9
|
-
kc_has_nizam_missing
|
|
9
|
+
kc_has_nizam_missing: string[];
|
|
10
10
|
/** Per-org membership-set divergences (KC vs Nizam). */
|
|
11
|
-
membership_divergent
|
|
11
|
+
membership_divergent: NizamDashboard.MembershipDriftResponse[];
|
|
12
12
|
/** Object type discriminator. */
|
|
13
|
-
object
|
|
13
|
+
object: ReconcileResponse.Object_;
|
|
14
14
|
}
|
|
15
15
|
export declare namespace ReconcileResponse {
|
|
16
16
|
/** Object type discriminator. */
|
|
@@ -4,11 +4,11 @@ import type * as NizamDashboard from "../index.js";
|
|
|
4
4
|
*/
|
|
5
5
|
export interface TaskAttemptPhoto {
|
|
6
6
|
/** Photo record id. */
|
|
7
|
-
id
|
|
7
|
+
id: string;
|
|
8
8
|
/** Central file id — request bytes via the files download-url endpoint. */
|
|
9
|
-
file_id
|
|
9
|
+
file_id: string;
|
|
10
10
|
/** Display order within the attempt. */
|
|
11
|
-
sequence
|
|
11
|
+
sequence: number;
|
|
12
12
|
/** Photo category, when categorised. */
|
|
13
13
|
photo_type?: string | undefined;
|
|
14
14
|
/** Operator-entered caption. */
|
|
@@ -16,11 +16,11 @@ export interface TaskAttemptPhoto {
|
|
|
16
16
|
/** Device capture time (EXIF), when reported. */
|
|
17
17
|
taken_at?: string | undefined;
|
|
18
18
|
/** May the bytes be served right now (scan verdict + lifecycle)? */
|
|
19
|
-
downloadable
|
|
20
|
-
thumbnails
|
|
19
|
+
downloadable: boolean;
|
|
20
|
+
thumbnails: NizamDashboard.TaskAttemptPhotoThumbnail[];
|
|
21
21
|
/** When the photo row was recorded. */
|
|
22
|
-
created_at
|
|
23
|
-
object
|
|
22
|
+
created_at: string;
|
|
23
|
+
object: TaskAttemptPhoto.Object_;
|
|
24
24
|
}
|
|
25
25
|
export declare namespace TaskAttemptPhoto {
|
|
26
26
|
const Object_: {
|
|
@@ -3,13 +3,13 @@
|
|
|
3
3
|
*/
|
|
4
4
|
export interface Timezone {
|
|
5
5
|
/** IANA timezone id (e.g. `America/New_York`). */
|
|
6
|
-
id
|
|
6
|
+
id: string;
|
|
7
7
|
/** Long display name in the Accept-Language locale. */
|
|
8
|
-
display_name
|
|
8
|
+
display_name: string;
|
|
9
9
|
/** Current offset from UTC in minutes (DST-aware). */
|
|
10
|
-
gmt_offset_minutes
|
|
10
|
+
gmt_offset_minutes: number;
|
|
11
11
|
/** Object type discriminator. */
|
|
12
|
-
object
|
|
12
|
+
object: Timezone.Object_;
|
|
13
13
|
}
|
|
14
14
|
export declare namespace Timezone {
|
|
15
15
|
/** Object type discriminator. */
|
|
@@ -4,15 +4,15 @@ import type * as NizamDashboard from "../index.js";
|
|
|
4
4
|
*/
|
|
5
5
|
export interface UploadInitiation {
|
|
6
6
|
/** Upload session id — the handle for resume/complete/cancel. */
|
|
7
|
-
upload_session_id
|
|
7
|
+
upload_session_id: string;
|
|
8
8
|
/** Pre-reserved file id — the id the completed file WILL carry. */
|
|
9
|
-
file_id
|
|
9
|
+
file_id: string;
|
|
10
10
|
/** Fixed size of every part except the last. */
|
|
11
|
-
part_size_bytes
|
|
11
|
+
part_size_bytes: number;
|
|
12
12
|
/** Session deadline; the sweep aborts the upload after this. */
|
|
13
|
-
expires_at
|
|
14
|
-
parts
|
|
15
|
-
object
|
|
13
|
+
expires_at: string;
|
|
14
|
+
parts: NizamDashboard.UploadInitiationPart[];
|
|
15
|
+
object: UploadInitiation.Object_;
|
|
16
16
|
}
|
|
17
17
|
export declare namespace UploadInitiation {
|
|
18
18
|
const Object_: {
|
package/dist/api/types/User.d.ts
CHANGED
|
@@ -3,12 +3,14 @@
|
|
|
3
3
|
*/
|
|
4
4
|
export interface User {
|
|
5
5
|
/** Stable UUID. Equal to the Keycloak `sub` claim. */
|
|
6
|
-
id
|
|
6
|
+
id: string;
|
|
7
7
|
/** Which portal issued the bearer token used for this request. */
|
|
8
|
-
portal
|
|
8
|
+
portal: User.Portal;
|
|
9
9
|
/** Keycloak Organization id the user belongs to. Null for cross-tenant platform admins. */
|
|
10
10
|
organization_id?: string | undefined;
|
|
11
|
-
roles
|
|
11
|
+
roles: string[];
|
|
12
|
+
/** The caller's effective permission ids for the active organization (epic #317): the union of catalog grants for every role they hold. Gate actions on these (`can("asset:create")`) rather than role strings, so frontend and backend reference the one catalog and cannot drift. Coarse and instance-independent; per-instance authority ('may delete THIS asset') is enforced server-side at the mutation, never precomputed here. */
|
|
13
|
+
permissions: User.Permissions.Item[];
|
|
12
14
|
/** Email shadowed from Keycloak. Null until the user completes a profile. */
|
|
13
15
|
email?: string | undefined;
|
|
14
16
|
/** Display name shadowed from Keycloak. */
|
|
@@ -16,11 +18,11 @@ export interface User {
|
|
|
16
18
|
/** Timestamp of this login. Null only on the very first call before provisioning completes. */
|
|
17
19
|
last_login_at?: string | undefined;
|
|
18
20
|
/** Total logins observed by this service. */
|
|
19
|
-
login_count
|
|
21
|
+
login_count: number;
|
|
20
22
|
/** File id of the current profile picture (epic #151 / #166); null until one is uploaded. Request bytes via the files download-url endpoint, or let `GET /users/{id}/profile-picture` pick the nearest thumbnail. */
|
|
21
23
|
profile_picture_file_id?: string | undefined;
|
|
22
24
|
/** Object type discriminator. */
|
|
23
|
-
object
|
|
25
|
+
object: User.Object_;
|
|
24
26
|
}
|
|
25
27
|
export declare namespace User {
|
|
26
28
|
/** Which portal issued the bearer token used for this request. */
|
|
@@ -34,6 +36,26 @@ export declare namespace User {
|
|
|
34
36
|
readonly Admin: "admin";
|
|
35
37
|
};
|
|
36
38
|
type Portal = (typeof Portal)[keyof typeof Portal];
|
|
39
|
+
type Permissions = Permissions.Item[];
|
|
40
|
+
namespace Permissions {
|
|
41
|
+
const Item: {
|
|
42
|
+
readonly AssetCreate: "asset:create";
|
|
43
|
+
readonly AssetDelete: "asset:delete";
|
|
44
|
+
readonly AssetDispose: "asset:dispose";
|
|
45
|
+
readonly AssetExport: "asset:export";
|
|
46
|
+
readonly AssetImport: "asset:import";
|
|
47
|
+
readonly AssetRead: "asset:read";
|
|
48
|
+
readonly AssetTransition: "asset:transition";
|
|
49
|
+
readonly AssetUpdate: "asset:update";
|
|
50
|
+
readonly KeycloakProjectionAdminister: "keycloak-projection:administer";
|
|
51
|
+
readonly NotificationDeliveryRead: "notification-delivery:read";
|
|
52
|
+
readonly OrgMaintenanceAdminister: "org-maintenance:administer";
|
|
53
|
+
readonly ServiceAccountAdminister: "service-account:administer";
|
|
54
|
+
readonly UserAdminister: "user:administer";
|
|
55
|
+
readonly UserInvite: "user:invite";
|
|
56
|
+
};
|
|
57
|
+
type Item = (typeof Item)[keyof typeof Item];
|
|
58
|
+
}
|
|
37
59
|
/** Object type discriminator. */
|
|
38
60
|
const Object_: {
|
|
39
61
|
readonly User: "user";
|
package/dist/api/types/User.js
CHANGED
|
@@ -14,6 +14,25 @@ var User;
|
|
|
14
14
|
PlatformStaff: "platform_staff",
|
|
15
15
|
Admin: "admin",
|
|
16
16
|
};
|
|
17
|
+
let Permissions;
|
|
18
|
+
(function (Permissions) {
|
|
19
|
+
Permissions.Item = {
|
|
20
|
+
AssetCreate: "asset:create",
|
|
21
|
+
AssetDelete: "asset:delete",
|
|
22
|
+
AssetDispose: "asset:dispose",
|
|
23
|
+
AssetExport: "asset:export",
|
|
24
|
+
AssetImport: "asset:import",
|
|
25
|
+
AssetRead: "asset:read",
|
|
26
|
+
AssetTransition: "asset:transition",
|
|
27
|
+
AssetUpdate: "asset:update",
|
|
28
|
+
KeycloakProjectionAdminister: "keycloak-projection:administer",
|
|
29
|
+
NotificationDeliveryRead: "notification-delivery:read",
|
|
30
|
+
OrgMaintenanceAdminister: "org-maintenance:administer",
|
|
31
|
+
ServiceAccountAdminister: "service-account:administer",
|
|
32
|
+
UserAdminister: "user:administer",
|
|
33
|
+
UserInvite: "user:invite",
|
|
34
|
+
};
|
|
35
|
+
})(Permissions = User.Permissions || (User.Permissions = {}));
|
|
17
36
|
/** Object type discriminator. */
|
|
18
37
|
User.Object_ = {
|
|
19
38
|
User: "user",
|