@nizam-os/dashboard-sdk 6.2.0 → 6.3.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/requests/ListActivityRequest.d.ts +1 -1
- package/dist/api/resources/assets/client/Client.d.ts +1 -1
- package/dist/api/resources/assets/client/Client.js +5 -2
- package/dist/api/resources/assets/client/requests/ListAssetsRequest.d.ts +6 -0
- package/dist/api/resources/organizations/client/requests/ListOrganizationsRequest.d.ts +1 -1
- package/dist/api/resources/users/client/requests/ListUsersRequest.d.ts +1 -1
- package/dist/api/types/AssetListItem.d.ts +2 -0
- package/package.json +1 -1
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
export interface ListActivityRequest {
|
|
10
10
|
/** Return only activity at or after this instant (ISO-8601). Pass the last-seen timestamp to reconcile after a realtime disconnect. */
|
|
11
11
|
since?: string;
|
|
12
|
-
/**
|
|
12
|
+
/** Sort order. Allowed fields: `created_at`. Prefix a field with `-` for descending (e.g. `-created_at`); unknown fields are rejected with `400 validation_failed`. */
|
|
13
13
|
sort?: string | string[];
|
|
14
14
|
/** Page size. Default 20, maximum 100. Out-of-range values are silently clamped; the response body's `limit` field reflects what was applied. */
|
|
15
15
|
limit?: number;
|
|
@@ -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. 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).
|
|
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. Allowed sort fields: `created_at`, `name`, `plate_number` — a single field, `-` prefix for descending. `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.
|
|
@@ -50,7 +50,7 @@ class AssetsClient {
|
|
|
50
50
|
this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
|
|
51
51
|
}
|
|
52
52
|
/**
|
|
53
|
-
* Without `q`: the org's assets ordered by `created_at` descending. 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).
|
|
53
|
+
* 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. Allowed sort fields: `created_at`, `name`, `plate_number` — a single field, `-` prefix for descending. `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).
|
|
54
54
|
*
|
|
55
55
|
* @param {NizamDashboard.ListAssetsRequest} request
|
|
56
56
|
* @param {AssetsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -72,10 +72,13 @@ class AssetsClient {
|
|
|
72
72
|
return core.HttpResponsePromise.fromPromise(this.__listAssets(request, requestOptions));
|
|
73
73
|
}
|
|
74
74
|
async __listAssets(request = {}, requestOptions) {
|
|
75
|
-
const { q, highlight, limit, starting_after: startingAfter, ending_before: endingBefore } = request;
|
|
75
|
+
const { q, highlight, status, kind, sort, limit, starting_after: startingAfter, ending_before: endingBefore, } = request;
|
|
76
76
|
const _queryParams = {
|
|
77
77
|
q,
|
|
78
78
|
highlight,
|
|
79
|
+
status,
|
|
80
|
+
kind,
|
|
81
|
+
sort,
|
|
79
82
|
limit,
|
|
80
83
|
starting_after: startingAfter,
|
|
81
84
|
ending_before: endingBefore,
|
|
@@ -11,6 +11,12 @@ export interface ListAssetsRequest {
|
|
|
11
11
|
q?: string;
|
|
12
12
|
/** Include a highlighted match snippet per hit (search mode only). */
|
|
13
13
|
highlight?: boolean;
|
|
14
|
+
/** Filter by lifecycle status. Comma-separated; values: `active`, `maintenance`, `out_of_service`, `retired`, `sold`, `inactive`, `lost`. */
|
|
15
|
+
status?: string | string[];
|
|
16
|
+
/** Filter by top-level kind. Comma-separated; values: `ground_vehicle`, `aerial_vehicle`, `marine_vehicle`, `robot`, `agv`, `trailer`, `container`, `pallet`, `equipment`. */
|
|
17
|
+
kind?: string | string[];
|
|
18
|
+
/** Sort order. Allowed fields: `created_at`, `name`, `plate_number`. Prefix a field with `-` for descending (e.g. `-created_at`); unknown fields are rejected with `400 validation_failed`. */
|
|
19
|
+
sort?: string | string[];
|
|
14
20
|
/** Page size. Default 20, maximum 100. Out-of-range values are silently clamped; the response body's `limit` field reflects what was applied. */
|
|
15
21
|
limit?: number;
|
|
16
22
|
/** Opaque cursor — return the page starting strictly after this entity in the sort order. Mutually exclusive with `ending_before`. */
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
* }
|
|
7
7
|
*/
|
|
8
8
|
export interface ListOrganizationsRequest {
|
|
9
|
-
/**
|
|
9
|
+
/** Sort order. Allowed fields: `created_at`. Prefix a field with `-` for descending (e.g. `-created_at`); unknown fields are rejected with `400 validation_failed`. */
|
|
10
10
|
sort?: string | string[];
|
|
11
11
|
/** Page size. Default 20, maximum 100. Out-of-range values are silently clamped; the response body's `limit` field reflects what was applied. */
|
|
12
12
|
limit?: number;
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
* }
|
|
7
7
|
*/
|
|
8
8
|
export interface ListUsersRequest {
|
|
9
|
-
/**
|
|
9
|
+
/** Sort order. Allowed fields: `created_at`, `name`. Prefix a field with `-` for descending (e.g. `-created_at`); unknown fields are rejected with `400 validation_failed`. */
|
|
10
10
|
sort?: string | string[];
|
|
11
11
|
/** Page size. Default 20, maximum 100. Out-of-range values are silently clamped; the response body's `limit` field reflects what was applied. */
|
|
12
12
|
limit?: number;
|
|
@@ -22,6 +22,8 @@ export interface AssetListItem {
|
|
|
22
22
|
organization_id?: string | undefined;
|
|
23
23
|
/** Current primary operator (active assignment, role=primary). */
|
|
24
24
|
current_primary_operator_id?: string | undefined;
|
|
25
|
+
/** Creation timestamp (ISO-8601 UTC). */
|
|
26
|
+
created_at?: string | undefined;
|
|
25
27
|
/** Relevance score (descending) when the request carried `q`; 0 for plain listings. Scores are only comparable within a single response. */
|
|
26
28
|
rank?: number | undefined;
|
|
27
29
|
/** Highlighted match fragment when the request carried `q&highlight=true`. Matched terms are wrapped in `<mark>…</mark>`. */
|