@nizam-os/dashboard-sdk 10.0.0 → 11.0.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 +236 -1
- package/dist/api/resources/assets/client/Client.js +744 -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 +1 -1
- package/dist/api/resources/organizations/client/Client.js +2 -2
- 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/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 +5 -5
- package/dist/api/types/UserResource.d.ts +4 -4
- package/dist/api/types/index.d.ts +1 -0
- package/dist/api/types/index.js +1 -0
- package/package.json +1 -1
|
@@ -14,7 +14,7 @@ export declare class ActivityClient {
|
|
|
14
14
|
protected readonly _options: NormalizedClientOptionsWithAuth<ActivityClient.Options>;
|
|
15
15
|
constructor(options: ActivityClient.Options);
|
|
16
16
|
/**
|
|
17
|
-
* Newest-first feed of audited events for the caller's active organization (dashboard; tenant-scoped). Platform staff see across tenants. This is the durable, REST source of truth behind the realtime `/topic/organization.<id>.activity` STOMP stream: on reconnect, a client passes `since=<last_seen>` to catch up missed items, then resumes realtime. Each item's `event_id` correlates with the realtime ActivityFeedItem's `id` for deduplication. Sortable: `created_at` (default
|
|
17
|
+
* Newest-first feed of audited events for the caller's active organization (dashboard; tenant-scoped). Platform staff see across tenants. This is the durable, REST source of truth behind the realtime `/topic/organization.<id>.activity` STOMP stream: on reconnect, a client passes `since=<last_seen>` to catch up missed items, then resumes realtime. Each item's `event_id` correlates with the realtime ActivityFeedItem's `id` for deduplication. Sortable: `created_at` (default `created_at:desc`). Bidirectional opaque cursors via `starting_after` / `ending_before`.
|
|
18
18
|
*
|
|
19
19
|
* @param {NizamDashboard.ListActivityRequest} request
|
|
20
20
|
* @param {ActivityClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -50,7 +50,7 @@ class ActivityClient {
|
|
|
50
50
|
this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
|
|
51
51
|
}
|
|
52
52
|
/**
|
|
53
|
-
* Newest-first feed of audited events for the caller's active organization (dashboard; tenant-scoped). Platform staff see across tenants. This is the durable, REST source of truth behind the realtime `/topic/organization.<id>.activity` STOMP stream: on reconnect, a client passes `since=<last_seen>` to catch up missed items, then resumes realtime. Each item's `event_id` correlates with the realtime ActivityFeedItem's `id` for deduplication. Sortable: `created_at` (default
|
|
53
|
+
* Newest-first feed of audited events for the caller's active organization (dashboard; tenant-scoped). Platform staff see across tenants. This is the durable, REST source of truth behind the realtime `/topic/organization.<id>.activity` STOMP stream: on reconnect, a client passes `since=<last_seen>` to catch up missed items, then resumes realtime. Each item's `event_id` correlates with the realtime ActivityFeedItem's `id` for deduplication. Sortable: `created_at` (default `created_at:desc`). Bidirectional opaque cursors via `starting_after` / `ending_before`.
|
|
54
54
|
*
|
|
55
55
|
* @param {NizamDashboard.ListActivityRequest} request
|
|
56
56
|
* @param {ActivityClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -75,7 +75,7 @@ class ActivityClient {
|
|
|
75
75
|
const { since, sort, limit, starting_after: startingAfter, ending_before: endingBefore } = request;
|
|
76
76
|
const _queryParams = {
|
|
77
77
|
since: since != null ? since : undefined,
|
|
78
|
-
sort,
|
|
78
|
+
sort: Array.isArray(sort) ? sort.map((item) => item) : sort != null ? sort : undefined,
|
|
79
79
|
limit,
|
|
80
80
|
starting_after: startingAfter,
|
|
81
81
|
ending_before: endingBefore,
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import type * as NizamDashboard from "../../../../index.js";
|
|
1
2
|
/**
|
|
2
3
|
* @example
|
|
3
4
|
* {
|
|
@@ -9,8 +10,8 @@
|
|
|
9
10
|
export interface ListActivityRequest {
|
|
10
11
|
/** Return only activity at or after this instant (ISO-8601). Pass the last-seen timestamp to reconcile after a realtime disconnect. */
|
|
11
12
|
since?: string;
|
|
12
|
-
/** Sort order. Allowed fields: `created_at`.
|
|
13
|
-
sort?:
|
|
13
|
+
/** Sort order. Allowed fields: `created_at`. Append `:asc` or `:desc` to each field (direction required, e.g. `created_at:desc`), comma-separated for multi-sort; unknown fields or directions are rejected with `400 validation_failed`. */
|
|
14
|
+
sort?: NizamDashboard.ListActivityRequestSortItem | NizamDashboard.ListActivityRequestSortItem[];
|
|
14
15
|
/** Page size. Default 20, maximum 100. Out-of-range values are silently clamped; the response body's `limit` field reflects what was applied. */
|
|
15
16
|
limit?: number;
|
|
16
17
|
/** Opaque cursor — return the page starting strictly after this entity in the sort order. Mutually exclusive with `ending_before`. */
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.ListActivityRequestSortItem = void 0;
|
|
5
|
+
exports.ListActivityRequestSortItem = {
|
|
6
|
+
CreatedAtAsc: "created_at:asc",
|
|
7
|
+
CreatedAtDesc: "created_at:desc",
|
|
8
|
+
};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * from "./ListActivityRequestSortItem.js";
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
+
if (k2 === undefined) k2 = k;
|
|
4
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
+
}
|
|
8
|
+
Object.defineProperty(o, k2, desc);
|
|
9
|
+
}) : (function(o, m, k, k2) {
|
|
10
|
+
if (k2 === undefined) k2 = k;
|
|
11
|
+
o[k2] = m[k];
|
|
12
|
+
}));
|
|
13
|
+
var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
14
|
+
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
15
|
+
};
|
|
16
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
|
+
__exportStar(require("./ListActivityRequestSortItem.js"), exports);
|
|
@@ -14,7 +14,7 @@ export declare class AssetsClient {
|
|
|
14
14
|
protected readonly _options: NormalizedClientOptionsWithAuth<AssetsClient.Options>;
|
|
15
15
|
constructor(options: AssetsClient.Options);
|
|
16
16
|
/**
|
|
17
|
-
* Without `q`: the org's assets ordered by `created_at` descending (or an explicit `sort`). With `q`: ranked search across name, VIN, code, plate, serial, call sign, make, model and sub-kind — accent-insensitive and language-agnostic (epic #97). Matching is hybrid: whole words and word-prefixes (type-ahead — `pick` finds `Picker Bot 3`) plus substrings and typos (`ick`, or a misspelled `sprintr`, still match). `q` results are ordered by relevance unless `sort` is given, in which case the search narrows the rows and `sort` orders them.
|
|
17
|
+
* Without `q`: the org's assets ordered by `created_at` descending (or an explicit `sort`). With `q`: ranked search across name, VIN, code, plate, serial, call sign, make, model and sub-kind — accent-insensitive and language-agnostic (epic #97). Matching is hybrid: whole words and word-prefixes (type-ahead — `pick` finds `Picker Bot 3`) plus substrings and typos (`ick`, or a misspelled `sprintr`, still match). `q` results are ordered by relevance unless `sort` is given, in which case the search narrows the rows and `sort` orders them. Sort by a single column — the allowed fields and direction grammar are enumerated on the `sort` parameter; `status` and `kind` sort by their domain order (status lifecycle, kind grouping), not the stored code or the tenant-relabeled display string. As filters, `status` / `kind` accept comma-separated values and narrow every mode. Pagination is bidirectional (`starting_after` / `ending_before`); cursors are bound to the sort that minted them — switching sorts restarts from the first page. `highlight=true` adds a `<mark>`-wrapped match snippet (relevance mode only).
|
|
18
18
|
*
|
|
19
19
|
* @param {NizamDashboard.ListAssetsRequest} request
|
|
20
20
|
* @param {AssetsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -28,6 +28,8 @@ export declare class AssetsClient {
|
|
|
28
28
|
* @example
|
|
29
29
|
* await client.assets.listAssets({
|
|
30
30
|
* q: "<string>",
|
|
31
|
+
* created_on_or_after: "2026-05-20",
|
|
32
|
+
* created_on_or_before: "2026-05-20",
|
|
31
33
|
* starting_after: "Y3Vyc29yX25leHRfMDFKNVE=",
|
|
32
34
|
* ending_before: "Y3Vyc29yX25leHRfMDFKNVE="
|
|
33
35
|
* })
|
|
@@ -80,6 +82,48 @@ export declare class AssetsClient {
|
|
|
80
82
|
*/
|
|
81
83
|
createAsset(request: NizamDashboard.CreateAssetRequest, requestOptions?: AssetsClient.RequestOptions): core.HttpResponsePromise<NizamDashboard.Asset>;
|
|
82
84
|
private __createAsset;
|
|
85
|
+
/**
|
|
86
|
+
* Returns the lifecycle statuses EVERY asset in the selection may legally move to next — the intersection of each asset's legal-transition set (the same matrix the per-asset `allowed_transitions` field and the transition verbs enforce). The status picker calls this so a bulk change offers only moves legal for the WHOLE selection, instead of offering every status and relying on per-row 409s. Ids that don't resolve to a live asset in your organization are ignored; a selection that shares no common next status (e.g. it includes a terminal sold/lost asset) returns an empty list. It is a read — re-asserting it is free.
|
|
87
|
+
*
|
|
88
|
+
* @param {NizamDashboard.AllowedTransitionsRequest} request
|
|
89
|
+
* @param {AssetsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
90
|
+
*
|
|
91
|
+
* @throws {@link NizamDashboard.BadRequestError}
|
|
92
|
+
* @throws {@link NizamDashboard.UnauthorizedError}
|
|
93
|
+
* @throws {@link NizamDashboard.ForbiddenError}
|
|
94
|
+
* @throws {@link NizamDashboard.UnprocessableEntityError}
|
|
95
|
+
* @throws {@link NizamDashboard.TooManyRequestsError}
|
|
96
|
+
* @throws {@link NizamDashboard.InternalServerError}
|
|
97
|
+
*
|
|
98
|
+
* @example
|
|
99
|
+
* await client.assets.assetAllowedTransitions({
|
|
100
|
+
* ids: ["8f55f0eb-7d3a-4f2c-9c8d-a1b2c3d4e5f6"]
|
|
101
|
+
* })
|
|
102
|
+
*/
|
|
103
|
+
assetAllowedTransitions(request: NizamDashboard.AllowedTransitionsRequest, requestOptions?: AssetsClient.RequestOptions): core.HttpResponsePromise<NizamDashboard.AllowedTransitions>;
|
|
104
|
+
private __assetAllowedTransitions;
|
|
105
|
+
/**
|
|
106
|
+
* Generates a CSV / XLSX / JSON file of the selected assets with the chosen columns and returns a short-lived download URL the browser follows to download it. Columns are emitted in the requested order; `kind` and `status` carry their stored code (re-importable), not the tenant's display label. The id count is capped — this exports an explicit selection. POST because generating + storing the file and logging the egress is an audited action, not a cacheable read.
|
|
107
|
+
*
|
|
108
|
+
* @param {NizamDashboard.ExportAssetsRequest} request
|
|
109
|
+
* @param {AssetsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
110
|
+
*
|
|
111
|
+
* @throws {@link NizamDashboard.BadRequestError}
|
|
112
|
+
* @throws {@link NizamDashboard.UnauthorizedError}
|
|
113
|
+
* @throws {@link NizamDashboard.ForbiddenError}
|
|
114
|
+
* @throws {@link NizamDashboard.UnprocessableEntityError}
|
|
115
|
+
* @throws {@link NizamDashboard.TooManyRequestsError}
|
|
116
|
+
* @throws {@link NizamDashboard.InternalServerError}
|
|
117
|
+
*
|
|
118
|
+
* @example
|
|
119
|
+
* await client.assets.exportAssets({
|
|
120
|
+
* format: "xlsx",
|
|
121
|
+
* fields: ["id", "name", "status"],
|
|
122
|
+
* ids: ["8f55f0eb-7d3a-4f2c-9c8d-a1b2c3d4e5f6"]
|
|
123
|
+
* })
|
|
124
|
+
*/
|
|
125
|
+
exportAssets(request: NizamDashboard.ExportAssetsRequest, requestOptions?: AssetsClient.RequestOptions): core.HttpResponsePromise<NizamDashboard.FileDownloadUrl>;
|
|
126
|
+
private __exportAssets;
|
|
83
127
|
/**
|
|
84
128
|
* Returns a correctly-shaped XLSX template (header row + one example row) for the bulk asset import. Fill it in and upload it via POST /v1/imports to import assets in bulk.
|
|
85
129
|
*
|
|
@@ -107,4 +151,195 @@ export declare class AssetsClient {
|
|
|
107
151
|
*/
|
|
108
152
|
getAsset(request: NizamDashboard.GetAssetRequest, requestOptions?: AssetsClient.RequestOptions): core.HttpResponsePromise<NizamDashboard.Asset>;
|
|
109
153
|
private __getAsset;
|
|
154
|
+
/**
|
|
155
|
+
* Soft-deletes the asset: it disappears from listings immediately and frees its VIN for re-registration. Assignments and historical records are left untouched. There is no synchronous bulk-delete endpoint — delete a selection by fanning out per-id requests (each is naturally idempotent).
|
|
156
|
+
*
|
|
157
|
+
* @param {NizamDashboard.DeleteAssetRequest} request
|
|
158
|
+
* @param {AssetsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
159
|
+
*
|
|
160
|
+
* @throws {@link NizamDashboard.UnauthorizedError}
|
|
161
|
+
* @throws {@link NizamDashboard.ForbiddenError}
|
|
162
|
+
* @throws {@link NizamDashboard.NotFoundError}
|
|
163
|
+
* @throws {@link NizamDashboard.TooManyRequestsError}
|
|
164
|
+
* @throws {@link NizamDashboard.InternalServerError}
|
|
165
|
+
*
|
|
166
|
+
* @example
|
|
167
|
+
* await client.assets.deleteAsset({
|
|
168
|
+
* id: "00000000-0000-0000-0000-000000000000"
|
|
169
|
+
* })
|
|
170
|
+
*/
|
|
171
|
+
deleteAsset(request: NizamDashboard.DeleteAssetRequest, requestOptions?: AssetsClient.RequestOptions): core.HttpResponsePromise<void>;
|
|
172
|
+
private __deleteAsset;
|
|
173
|
+
/**
|
|
174
|
+
* Set-only partial update of an asset's mutable fields — display name, sub-kind, autonomy level, and the vehicle identity (VIN, plate, make, model, year). Omitted or null fields are left unchanged. An asset's `kind` is immutable and lifecycle `status` moves through dedicated transitions, so neither is editable here.
|
|
175
|
+
*
|
|
176
|
+
* @param {NizamDashboard.UpdateAssetRequest} request
|
|
177
|
+
* @param {AssetsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
178
|
+
*
|
|
179
|
+
* @throws {@link NizamDashboard.UnauthorizedError}
|
|
180
|
+
* @throws {@link NizamDashboard.ForbiddenError}
|
|
181
|
+
* @throws {@link NizamDashboard.NotFoundError}
|
|
182
|
+
* @throws {@link NizamDashboard.ConflictError}
|
|
183
|
+
* @throws {@link NizamDashboard.UnprocessableEntityError}
|
|
184
|
+
* @throws {@link NizamDashboard.TooManyRequestsError}
|
|
185
|
+
* @throws {@link NizamDashboard.InternalServerError}
|
|
186
|
+
*
|
|
187
|
+
* @example
|
|
188
|
+
* await client.assets.updateAsset({
|
|
189
|
+
* id: "00000000-0000-0000-0000-000000000000",
|
|
190
|
+
* name: "Truck 7B"
|
|
191
|
+
* })
|
|
192
|
+
*
|
|
193
|
+
* @example
|
|
194
|
+
* await client.assets.updateAsset({
|
|
195
|
+
* id: "00000000-0000-0000-0000-000000000000",
|
|
196
|
+
* vin: "1HGCM82633A004352",
|
|
197
|
+
* plate_number: "AB-123-CD",
|
|
198
|
+
* make: "Volvo",
|
|
199
|
+
* model: "FH16",
|
|
200
|
+
* year: 2024
|
|
201
|
+
* })
|
|
202
|
+
*/
|
|
203
|
+
updateAsset(request: NizamDashboard.UpdateAssetRequest, requestOptions?: AssetsClient.RequestOptions): core.HttpResponsePromise<NizamDashboard.Asset>;
|
|
204
|
+
private __updateAsset;
|
|
205
|
+
/**
|
|
206
|
+
* Returns the asset to `active` service. Idempotent no-op if already active; an illegal edge (e.g. from a terminal sold/lost asset) → 409 `asset.invalid_transition`. No body — fan out per id for a bulk change.
|
|
207
|
+
*
|
|
208
|
+
* @param {NizamDashboard.ActivateAssetRequest} request
|
|
209
|
+
* @param {AssetsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
210
|
+
*
|
|
211
|
+
* @throws {@link NizamDashboard.UnauthorizedError}
|
|
212
|
+
* @throws {@link NizamDashboard.ForbiddenError}
|
|
213
|
+
* @throws {@link NizamDashboard.NotFoundError}
|
|
214
|
+
* @throws {@link NizamDashboard.ConflictError}
|
|
215
|
+
* @throws {@link NizamDashboard.TooManyRequestsError}
|
|
216
|
+
* @throws {@link NizamDashboard.InternalServerError}
|
|
217
|
+
*
|
|
218
|
+
* @example
|
|
219
|
+
* await client.assets.activateAsset({
|
|
220
|
+
* id: "00000000-0000-0000-0000-000000000000"
|
|
221
|
+
* })
|
|
222
|
+
*/
|
|
223
|
+
activateAsset(request: NizamDashboard.ActivateAssetRequest, requestOptions?: AssetsClient.RequestOptions): core.HttpResponsePromise<NizamDashboard.Asset>;
|
|
224
|
+
private __activateAsset;
|
|
225
|
+
/**
|
|
226
|
+
* Marks the asset `inactive` (idle but still in-fleet). Idempotent no-op if already inactive; an illegal edge → 409 `asset.invalid_transition`. No body.
|
|
227
|
+
*
|
|
228
|
+
* @param {NizamDashboard.DeactivateAssetRequest} request
|
|
229
|
+
* @param {AssetsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
230
|
+
*
|
|
231
|
+
* @throws {@link NizamDashboard.UnauthorizedError}
|
|
232
|
+
* @throws {@link NizamDashboard.ForbiddenError}
|
|
233
|
+
* @throws {@link NizamDashboard.NotFoundError}
|
|
234
|
+
* @throws {@link NizamDashboard.ConflictError}
|
|
235
|
+
* @throws {@link NizamDashboard.TooManyRequestsError}
|
|
236
|
+
* @throws {@link NizamDashboard.InternalServerError}
|
|
237
|
+
*
|
|
238
|
+
* @example
|
|
239
|
+
* await client.assets.deactivateAsset({
|
|
240
|
+
* id: "00000000-0000-0000-0000-000000000000"
|
|
241
|
+
* })
|
|
242
|
+
*/
|
|
243
|
+
deactivateAsset(request: NizamDashboard.DeactivateAssetRequest, requestOptions?: AssetsClient.RequestOptions): core.HttpResponsePromise<NizamDashboard.Asset>;
|
|
244
|
+
private __deactivateAsset;
|
|
245
|
+
/**
|
|
246
|
+
* Moves the asset into `maintenance`. Idempotent no-op if already in maintenance; an illegal edge → 409 `asset.invalid_transition`. No body.
|
|
247
|
+
*
|
|
248
|
+
* @param {NizamDashboard.EnterAssetMaintenanceRequest} request
|
|
249
|
+
* @param {AssetsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
250
|
+
*
|
|
251
|
+
* @throws {@link NizamDashboard.UnauthorizedError}
|
|
252
|
+
* @throws {@link NizamDashboard.ForbiddenError}
|
|
253
|
+
* @throws {@link NizamDashboard.NotFoundError}
|
|
254
|
+
* @throws {@link NizamDashboard.ConflictError}
|
|
255
|
+
* @throws {@link NizamDashboard.TooManyRequestsError}
|
|
256
|
+
* @throws {@link NizamDashboard.InternalServerError}
|
|
257
|
+
*
|
|
258
|
+
* @example
|
|
259
|
+
* await client.assets.enterAssetMaintenance({
|
|
260
|
+
* id: "00000000-0000-0000-0000-000000000000"
|
|
261
|
+
* })
|
|
262
|
+
*/
|
|
263
|
+
enterAssetMaintenance(request: NizamDashboard.EnterAssetMaintenanceRequest, requestOptions?: AssetsClient.RequestOptions): core.HttpResponsePromise<NizamDashboard.Asset>;
|
|
264
|
+
private __enterAssetMaintenance;
|
|
265
|
+
/**
|
|
266
|
+
* Marks the asset `lost` — a terminal state; the asset has left the fleet and accepts no further transitions. Idempotent no-op if already lost; an illegal edge → 409 `asset.invalid_transition`. No body.
|
|
267
|
+
*
|
|
268
|
+
* @param {NizamDashboard.ReportAssetLostRequest} request
|
|
269
|
+
* @param {AssetsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
270
|
+
*
|
|
271
|
+
* @throws {@link NizamDashboard.UnauthorizedError}
|
|
272
|
+
* @throws {@link NizamDashboard.ForbiddenError}
|
|
273
|
+
* @throws {@link NizamDashboard.NotFoundError}
|
|
274
|
+
* @throws {@link NizamDashboard.ConflictError}
|
|
275
|
+
* @throws {@link NizamDashboard.TooManyRequestsError}
|
|
276
|
+
* @throws {@link NizamDashboard.InternalServerError}
|
|
277
|
+
*
|
|
278
|
+
* @example
|
|
279
|
+
* await client.assets.reportAssetLost({
|
|
280
|
+
* id: "00000000-0000-0000-0000-000000000000"
|
|
281
|
+
* })
|
|
282
|
+
*/
|
|
283
|
+
reportAssetLost(request: NizamDashboard.ReportAssetLostRequest, requestOptions?: AssetsClient.RequestOptions): core.HttpResponsePromise<NizamDashboard.Asset>;
|
|
284
|
+
private __reportAssetLost;
|
|
285
|
+
/**
|
|
286
|
+
* Retires the asset (`retired`) — decommissioned but still owned; it may later be reactivated, sold, or reported lost. Idempotent no-op if already retired; an illegal edge → 409 `asset.invalid_transition`. No body.
|
|
287
|
+
*
|
|
288
|
+
* @param {NizamDashboard.RetireAssetRequest} request
|
|
289
|
+
* @param {AssetsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
290
|
+
*
|
|
291
|
+
* @throws {@link NizamDashboard.UnauthorizedError}
|
|
292
|
+
* @throws {@link NizamDashboard.ForbiddenError}
|
|
293
|
+
* @throws {@link NizamDashboard.NotFoundError}
|
|
294
|
+
* @throws {@link NizamDashboard.ConflictError}
|
|
295
|
+
* @throws {@link NizamDashboard.TooManyRequestsError}
|
|
296
|
+
* @throws {@link NizamDashboard.InternalServerError}
|
|
297
|
+
*
|
|
298
|
+
* @example
|
|
299
|
+
* await client.assets.retireAsset({
|
|
300
|
+
* id: "00000000-0000-0000-0000-000000000000"
|
|
301
|
+
* })
|
|
302
|
+
*/
|
|
303
|
+
retireAsset(request: NizamDashboard.RetireAssetRequest, requestOptions?: AssetsClient.RequestOptions): core.HttpResponsePromise<NizamDashboard.Asset>;
|
|
304
|
+
private __retireAsset;
|
|
305
|
+
/**
|
|
306
|
+
* Marks the asset `sold` — a terminal state; the asset has left the fleet and accepts no further transitions. Idempotent no-op if already sold; an illegal edge → 409 `asset.invalid_transition`. No body.
|
|
307
|
+
*
|
|
308
|
+
* @param {NizamDashboard.SellAssetRequest} request
|
|
309
|
+
* @param {AssetsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
310
|
+
*
|
|
311
|
+
* @throws {@link NizamDashboard.UnauthorizedError}
|
|
312
|
+
* @throws {@link NizamDashboard.ForbiddenError}
|
|
313
|
+
* @throws {@link NizamDashboard.NotFoundError}
|
|
314
|
+
* @throws {@link NizamDashboard.ConflictError}
|
|
315
|
+
* @throws {@link NizamDashboard.TooManyRequestsError}
|
|
316
|
+
* @throws {@link NizamDashboard.InternalServerError}
|
|
317
|
+
*
|
|
318
|
+
* @example
|
|
319
|
+
* await client.assets.sellAsset({
|
|
320
|
+
* id: "00000000-0000-0000-0000-000000000000"
|
|
321
|
+
* })
|
|
322
|
+
*/
|
|
323
|
+
sellAsset(request: NizamDashboard.SellAssetRequest, requestOptions?: AssetsClient.RequestOptions): core.HttpResponsePromise<NizamDashboard.Asset>;
|
|
324
|
+
private __sellAsset;
|
|
325
|
+
/**
|
|
326
|
+
* Moves the asset `out_of_service`. Idempotent no-op if already out of service; an illegal edge → 409 `asset.invalid_transition`. No body.
|
|
327
|
+
*
|
|
328
|
+
* @param {NizamDashboard.TakeAssetOutOfServiceRequest} request
|
|
329
|
+
* @param {AssetsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
330
|
+
*
|
|
331
|
+
* @throws {@link NizamDashboard.UnauthorizedError}
|
|
332
|
+
* @throws {@link NizamDashboard.ForbiddenError}
|
|
333
|
+
* @throws {@link NizamDashboard.NotFoundError}
|
|
334
|
+
* @throws {@link NizamDashboard.ConflictError}
|
|
335
|
+
* @throws {@link NizamDashboard.TooManyRequestsError}
|
|
336
|
+
* @throws {@link NizamDashboard.InternalServerError}
|
|
337
|
+
*
|
|
338
|
+
* @example
|
|
339
|
+
* await client.assets.takeAssetOutOfService({
|
|
340
|
+
* id: "00000000-0000-0000-0000-000000000000"
|
|
341
|
+
* })
|
|
342
|
+
*/
|
|
343
|
+
takeAssetOutOfService(request: NizamDashboard.TakeAssetOutOfServiceRequest, requestOptions?: AssetsClient.RequestOptions): core.HttpResponsePromise<NizamDashboard.Asset>;
|
|
344
|
+
private __takeAssetOutOfService;
|
|
110
345
|
}
|