@nizam-os/operator-sdk 2.5.2 → 2.7.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/Client.d.ts +9 -0
- package/dist/Client.js +20 -8
- package/dist/api/errors/BadGatewayError.d.ts +6 -0
- package/dist/api/errors/BadGatewayError.js +54 -0
- package/dist/api/errors/BadRequestError.d.ts +6 -0
- package/dist/api/errors/BadRequestError.js +54 -0
- package/dist/api/errors/ContentTooLargeError.d.ts +6 -0
- package/dist/api/errors/ContentTooLargeError.js +54 -0
- package/dist/api/errors/index.d.ts +3 -0
- package/dist/api/errors/index.js +3 -0
- package/dist/api/resources/files/client/Client.d.ts +188 -0
- package/dist/api/resources/files/client/Client.js +617 -0
- package/dist/api/resources/files/client/index.d.ts +1 -0
- package/dist/api/resources/files/client/index.js +17 -0
- package/dist/api/resources/files/client/requests/CancelFileUploadRequest.d.ts +9 -0
- package/dist/api/resources/files/client/requests/CancelFileUploadRequest.js +3 -0
- package/dist/api/resources/files/client/requests/CompleteFileUploadRequest.d.ts +15 -0
- package/dist/api/resources/files/client/requests/CompleteFileUploadRequest.js +3 -0
- package/dist/api/resources/files/client/requests/CreateFileDownloadUrlRequest.d.ts +9 -0
- package/dist/api/resources/files/client/requests/CreateFileDownloadUrlRequest.js +3 -0
- package/dist/api/resources/files/client/requests/DeleteFileRequest.d.ts +9 -0
- package/dist/api/resources/files/client/requests/DeleteFileRequest.js +3 -0
- package/dist/api/resources/files/client/requests/GetFileRequest.d.ts +9 -0
- package/dist/api/resources/files/client/requests/GetFileRequest.js +3 -0
- package/dist/api/resources/files/client/requests/InitiateFileUploadRequest.d.ts +41 -0
- package/dist/api/resources/files/client/requests/InitiateFileUploadRequest.js +17 -0
- package/dist/api/resources/files/client/requests/ListFilesRequest.d.ts +27 -0
- package/dist/api/resources/files/client/requests/ListFilesRequest.js +3 -0
- package/dist/api/resources/files/client/requests/ResumeFileUploadRequest.d.ts +9 -0
- package/dist/api/resources/files/client/requests/ResumeFileUploadRequest.js +3 -0
- package/dist/api/resources/files/client/requests/index.d.ts +8 -0
- package/dist/api/resources/files/client/requests/index.js +5 -0
- package/dist/api/resources/files/exports.d.ts +2 -0
- package/dist/api/resources/files/exports.js +21 -0
- package/dist/api/resources/files/index.d.ts +1 -0
- package/dist/api/resources/files/index.js +17 -0
- package/dist/api/resources/index.d.ts +6 -0
- package/dist/api/resources/index.js +7 -1
- package/dist/api/resources/positions/client/Client.d.ts +31 -0
- package/dist/api/resources/positions/client/Client.js +114 -0
- package/dist/api/resources/positions/client/index.d.ts +1 -0
- package/dist/api/resources/positions/client/index.js +2 -0
- package/dist/api/resources/positions/exports.d.ts +2 -0
- package/dist/api/resources/positions/exports.js +21 -0
- package/dist/api/resources/positions/index.d.ts +1 -0
- package/dist/api/resources/positions/index.js +17 -0
- package/dist/api/resources/taskAttempts/client/Client.d.ts +65 -0
- package/dist/api/resources/taskAttempts/client/Client.js +214 -0
- package/dist/api/resources/taskAttempts/client/index.d.ts +1 -0
- package/dist/api/resources/taskAttempts/client/index.js +17 -0
- package/dist/api/resources/taskAttempts/client/requests/CaptureTaskAttemptPhotoRequest.d.ts +49 -0
- package/dist/api/resources/taskAttempts/client/requests/CaptureTaskAttemptPhotoRequest.js +20 -0
- package/dist/api/resources/taskAttempts/client/requests/ListTaskAttemptPhotosRequest.d.ts +17 -0
- package/dist/api/resources/taskAttempts/client/requests/ListTaskAttemptPhotosRequest.js +3 -0
- package/dist/api/resources/taskAttempts/client/requests/index.d.ts +2 -0
- package/dist/api/resources/taskAttempts/client/requests/index.js +5 -0
- package/dist/api/resources/taskAttempts/exports.d.ts +2 -0
- package/dist/api/resources/taskAttempts/exports.js +21 -0
- package/dist/api/resources/taskAttempts/index.d.ts +1 -0
- package/dist/api/resources/taskAttempts/index.js +17 -0
- package/dist/api/resources/users/client/Client.d.ts +43 -0
- package/dist/api/resources/users/client/Client.js +145 -0
- package/dist/api/resources/users/client/index.d.ts +1 -1
- package/dist/api/resources/users/client/index.js +15 -0
- package/dist/api/resources/users/client/requests/GetUserProfilePictureRequest.d.ts +11 -0
- package/dist/api/resources/users/client/requests/GetUserProfilePictureRequest.js +3 -0
- package/dist/api/resources/users/client/requests/InitiateProfilePictureUploadRequest.d.ts +19 -0
- package/dist/api/resources/users/client/requests/InitiateProfilePictureUploadRequest.js +3 -0
- package/dist/api/resources/users/client/requests/index.d.ts +2 -0
- package/dist/api/resources/users/client/requests/index.js +2 -0
- package/dist/api/types/FileDownloadUrl.d.ts +16 -0
- package/dist/api/types/FileDownloadUrl.js +10 -0
- package/dist/api/types/FileUploadPart.d.ts +13 -0
- package/dist/api/types/FileUploadPart.js +3 -0
- package/dist/api/types/FileUploadPartReport.d.ts +9 -0
- package/dist/api/types/FileUploadPartReport.js +3 -0
- package/dist/api/types/FileUploadSession.d.ts +51 -0
- package/dist/api/types/FileUploadSession.js +28 -0
- package/dist/api/types/File_.d.ts +86 -0
- package/dist/api/types/File_.js +40 -0
- package/dist/api/types/HeatmapCell.d.ts +18 -0
- package/dist/api/types/HeatmapCell.js +10 -0
- package/dist/api/types/Job.d.ts +2 -0
- package/dist/api/types/Job.js +2 -0
- package/dist/api/types/ListResponseFile.d.ts +27 -0
- package/dist/api/types/ListResponseFile.js +11 -0
- package/dist/api/types/ListResponseHeatmapCell.d.ts +27 -0
- package/dist/api/types/ListResponseHeatmapCell.js +11 -0
- package/dist/api/types/ListResponseOperatorPosition.d.ts +27 -0
- package/dist/api/types/ListResponseOperatorPosition.js +11 -0
- package/dist/api/types/ListResponsePosition.d.ts +27 -0
- package/dist/api/types/ListResponsePosition.js +11 -0
- package/dist/api/types/MqttToken.d.ts +12 -0
- package/dist/api/types/MqttToken.js +3 -0
- package/dist/api/types/OperatorPosition.d.ts +28 -0
- package/dist/api/types/OperatorPosition.js +10 -0
- package/dist/api/types/Position.d.ts +30 -0
- package/dist/api/types/Position.js +10 -0
- package/dist/api/types/TaskAttemptPhoto.d.ts +30 -0
- package/dist/api/types/TaskAttemptPhoto.js +10 -0
- package/dist/api/types/TaskAttemptPhotoThumbnail.d.ts +9 -0
- package/dist/api/types/TaskAttemptPhotoThumbnail.js +3 -0
- package/dist/api/types/UploadInitiation.d.ts +22 -0
- package/dist/api/types/UploadInitiation.js +10 -0
- package/dist/api/types/UploadInitiationPart.d.ts +13 -0
- package/dist/api/types/UploadInitiationPart.js +3 -0
- package/dist/api/types/index.d.ts +17 -0
- package/dist/api/types/index.js +17 -0
- package/package.json +1 -1
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* A short-lived URL granting read access to the file's bytes. Fetch it promptly — request a fresh grant after expiry.
|
|
3
|
+
*/
|
|
4
|
+
export interface FileDownloadUrl {
|
|
5
|
+
/** The URL to GET the bytes from. */
|
|
6
|
+
url?: string | undefined;
|
|
7
|
+
/** When the URL stops working. */
|
|
8
|
+
expires_at?: string | undefined;
|
|
9
|
+
object?: FileDownloadUrl.Object_ | undefined;
|
|
10
|
+
}
|
|
11
|
+
export declare namespace FileDownloadUrl {
|
|
12
|
+
const Object_: {
|
|
13
|
+
readonly FileDownloadUrl: "file_download_url";
|
|
14
|
+
};
|
|
15
|
+
type Object_ = (typeof Object_)[keyof typeof Object_];
|
|
16
|
+
}
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.FileDownloadUrl = void 0;
|
|
5
|
+
var FileDownloadUrl;
|
|
6
|
+
(function (FileDownloadUrl) {
|
|
7
|
+
FileDownloadUrl.Object_ = {
|
|
8
|
+
FileDownloadUrl: "file_download_url",
|
|
9
|
+
};
|
|
10
|
+
})(FileDownloadUrl || (exports.FileDownloadUrl = FileDownloadUrl = {}));
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* A presigned PUT for one part. Send the raw part bytes; repeat `headers` verbatim; keep the response's `ETag` header for completion.
|
|
3
|
+
*/
|
|
4
|
+
export interface FileUploadPart {
|
|
5
|
+
/** 1-based part number. */
|
|
6
|
+
part_number?: number | undefined;
|
|
7
|
+
/** Presigned URL to PUT the part's bytes to. */
|
|
8
|
+
url?: string | undefined;
|
|
9
|
+
/** Headers that were signed into the URL — the PUT must repeat them verbatim. */
|
|
10
|
+
headers?: Record<string, string> | undefined;
|
|
11
|
+
/** When this URL stops working (re-issue via resume). */
|
|
12
|
+
url_expires_at?: string | undefined;
|
|
13
|
+
}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The storage ETag received for one uploaded part.
|
|
3
|
+
*/
|
|
4
|
+
export interface FileUploadPartReport {
|
|
5
|
+
/** 1-based part number from the initiation layout. */
|
|
6
|
+
part_number?: number | undefined;
|
|
7
|
+
/** The ETag header value returned by the part's PUT (quotes optional). */
|
|
8
|
+
etag: string;
|
|
9
|
+
}
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
import type * as NizamOperatorRuntime from "../index.js";
|
|
2
|
+
/**
|
|
3
|
+
* A resumable multipart upload in flight. The browser PUTs each part directly to the presigned URL (echoing the part's `headers` verbatim), persists the returned ETags, and completes the session with the full part list. `file_id` is the id the finished file WILL carry — safe to build optimistic UI against.
|
|
4
|
+
*/
|
|
5
|
+
export interface FileUploadSession {
|
|
6
|
+
/** Session id — the handle for resume / complete / cancel. */
|
|
7
|
+
id?: string | undefined;
|
|
8
|
+
/** Pre-reserved id of the file this upload will become. */
|
|
9
|
+
file_id?: string | undefined;
|
|
10
|
+
/** The kind declared at initiation. */
|
|
11
|
+
kind?: FileUploadSession.Kind | undefined;
|
|
12
|
+
/** Session lifecycle. */
|
|
13
|
+
status?: FileUploadSession.Status | undefined;
|
|
14
|
+
/** Nominal part size; every part except the last must be exactly this size. */
|
|
15
|
+
part_size_bytes?: number | undefined;
|
|
16
|
+
/** Total parts in the layout. */
|
|
17
|
+
part_count?: number | undefined;
|
|
18
|
+
/** Bytes confirmed so far (client-reported, re-verified at completion). */
|
|
19
|
+
bytes_uploaded?: number | undefined;
|
|
20
|
+
completed_part_numbers?: number[] | undefined;
|
|
21
|
+
parts?: NizamOperatorRuntime.FileUploadPart[] | undefined;
|
|
22
|
+
/** Deadline: the session expires and is swept if not completed by then. */
|
|
23
|
+
expires_at?: string | undefined;
|
|
24
|
+
object?: FileUploadSession.Object_ | undefined;
|
|
25
|
+
}
|
|
26
|
+
export declare namespace FileUploadSession {
|
|
27
|
+
/** The kind declared at initiation. */
|
|
28
|
+
const Kind: {
|
|
29
|
+
readonly ProfilePicture: "profile_picture";
|
|
30
|
+
readonly ChatAttachment: "chat_attachment";
|
|
31
|
+
readonly TaskPodPhoto: "task_pod_photo";
|
|
32
|
+
readonly ImportSource: "import_source";
|
|
33
|
+
readonly ImportReport: "import_report";
|
|
34
|
+
readonly SignedDocument: "signed_document";
|
|
35
|
+
readonly ProductImage: "product_image";
|
|
36
|
+
};
|
|
37
|
+
type Kind = (typeof Kind)[keyof typeof Kind];
|
|
38
|
+
/** Session lifecycle. */
|
|
39
|
+
const Status: {
|
|
40
|
+
readonly Initiated: "initiated";
|
|
41
|
+
readonly InProgress: "in_progress";
|
|
42
|
+
readonly Completed: "completed";
|
|
43
|
+
readonly Aborted: "aborted";
|
|
44
|
+
readonly Expired: "expired";
|
|
45
|
+
};
|
|
46
|
+
type Status = (typeof Status)[keyof typeof Status];
|
|
47
|
+
const Object_: {
|
|
48
|
+
readonly FileUploadSession: "file_upload_session";
|
|
49
|
+
};
|
|
50
|
+
type Object_ = (typeof Object_)[keyof typeof Object_];
|
|
51
|
+
}
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.FileUploadSession = void 0;
|
|
5
|
+
var FileUploadSession;
|
|
6
|
+
(function (FileUploadSession) {
|
|
7
|
+
/** The kind declared at initiation. */
|
|
8
|
+
FileUploadSession.Kind = {
|
|
9
|
+
ProfilePicture: "profile_picture",
|
|
10
|
+
ChatAttachment: "chat_attachment",
|
|
11
|
+
TaskPodPhoto: "task_pod_photo",
|
|
12
|
+
ImportSource: "import_source",
|
|
13
|
+
ImportReport: "import_report",
|
|
14
|
+
SignedDocument: "signed_document",
|
|
15
|
+
ProductImage: "product_image",
|
|
16
|
+
};
|
|
17
|
+
/** Session lifecycle. */
|
|
18
|
+
FileUploadSession.Status = {
|
|
19
|
+
Initiated: "initiated",
|
|
20
|
+
InProgress: "in_progress",
|
|
21
|
+
Completed: "completed",
|
|
22
|
+
Aborted: "aborted",
|
|
23
|
+
Expired: "expired",
|
|
24
|
+
};
|
|
25
|
+
FileUploadSession.Object_ = {
|
|
26
|
+
FileUploadSession: "file_upload_session",
|
|
27
|
+
};
|
|
28
|
+
})(FileUploadSession || (exports.FileUploadSession = FileUploadSession = {}));
|
|
@@ -0,0 +1,86 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* A stored file's metadata: what it is (kind), who uploaded it, integrity (checksum), lifecycle (status + scan verdict + retention), and what business entity it documents (subject). The bytes themselves are served only through short-lived download URLs.
|
|
3
|
+
*/
|
|
4
|
+
export interface File_ {
|
|
5
|
+
/** Stable file id (pre-reserved at upload initiation). */
|
|
6
|
+
id?: string | undefined;
|
|
7
|
+
/** Owning organization. */
|
|
8
|
+
organization_id?: string | undefined;
|
|
9
|
+
/** Uploading user. Null for system-generated artifacts. */
|
|
10
|
+
uploader_id?: string | undefined;
|
|
11
|
+
/** What the bytes are for the platform — fixes the size/type/visibility/scan/retention policy applied to this file. */
|
|
12
|
+
kind?: File_.Kind | undefined;
|
|
13
|
+
/** Type of the business entity this file documents. */
|
|
14
|
+
subject_type?: string | undefined;
|
|
15
|
+
/** Id of the business entity this file documents. */
|
|
16
|
+
subject_id?: string | undefined;
|
|
17
|
+
/** For derived files (thumbnails): the original this one was rendered from. */
|
|
18
|
+
parent_file_id?: string | undefined;
|
|
19
|
+
/** Client-supplied filename, served back via Content-Disposition on download. */
|
|
20
|
+
original_filename?: string | undefined;
|
|
21
|
+
/** MIME type declared by the uploader at initiation. */
|
|
22
|
+
declared_content_type?: string | undefined;
|
|
23
|
+
/** MIME type detected server-side from the bytes (Tika). Null when detection was inconclusive. */
|
|
24
|
+
sniffed_content_type?: string | undefined;
|
|
25
|
+
/** Object size in bytes, storage-confirmed at completion. */
|
|
26
|
+
size_bytes?: number | undefined;
|
|
27
|
+
/** SHA-256 of the content, 64 lowercase hex characters. */
|
|
28
|
+
checksum_sha256?: string | undefined;
|
|
29
|
+
/** Lifecycle: `active` (serving), `quarantined` (malware-positive), `deleted` (bytes purged, row retained under regulatory hold). */
|
|
30
|
+
status?: File_.Status | undefined;
|
|
31
|
+
/** Access posture of the bytes, fixed by the kind's policy. */
|
|
32
|
+
visibility?: File_.Visibility | undefined;
|
|
33
|
+
/** Malware-scan verdict. Bytes are downloadable only on `clean` or `skipped`. */
|
|
34
|
+
virus_scan_status?: File_.VirusScanStatus | undefined;
|
|
35
|
+
/** When the scan verdict was produced. */
|
|
36
|
+
virus_scanned_at?: string | undefined;
|
|
37
|
+
/** When this file becomes eligible for the lifecycle sweep (TTL kinds). */
|
|
38
|
+
expires_at?: string | undefined;
|
|
39
|
+
/** Regulatory hold: the file cannot be deleted before this instant. */
|
|
40
|
+
retention_until?: string | undefined;
|
|
41
|
+
/** Upload completion time. */
|
|
42
|
+
created_at?: string | undefined;
|
|
43
|
+
/** Last lifecycle/scan change. */
|
|
44
|
+
updated_at?: string | undefined;
|
|
45
|
+
object?: File_.Object_ | undefined;
|
|
46
|
+
}
|
|
47
|
+
export declare namespace File_ {
|
|
48
|
+
/** What the bytes are for the platform — fixes the size/type/visibility/scan/retention policy applied to this file. */
|
|
49
|
+
const Kind: {
|
|
50
|
+
readonly ProfilePicture: "profile_picture";
|
|
51
|
+
readonly ChatAttachment: "chat_attachment";
|
|
52
|
+
readonly TaskPodPhoto: "task_pod_photo";
|
|
53
|
+
readonly ImportSource: "import_source";
|
|
54
|
+
readonly ImportReport: "import_report";
|
|
55
|
+
readonly SignedDocument: "signed_document";
|
|
56
|
+
readonly ProductImage: "product_image";
|
|
57
|
+
};
|
|
58
|
+
type Kind = (typeof Kind)[keyof typeof Kind];
|
|
59
|
+
/** Lifecycle: `active` (serving), `quarantined` (malware-positive), `deleted` (bytes purged, row retained under regulatory hold). */
|
|
60
|
+
const Status: {
|
|
61
|
+
readonly Active: "active";
|
|
62
|
+
readonly Quarantined: "quarantined";
|
|
63
|
+
readonly Deleted: "deleted";
|
|
64
|
+
};
|
|
65
|
+
type Status = (typeof Status)[keyof typeof Status];
|
|
66
|
+
/** Access posture of the bytes, fixed by the kind's policy. */
|
|
67
|
+
const Visibility: {
|
|
68
|
+
readonly Private: "private";
|
|
69
|
+
readonly Public: "public";
|
|
70
|
+
readonly PublicCdn: "public_cdn";
|
|
71
|
+
};
|
|
72
|
+
type Visibility = (typeof Visibility)[keyof typeof Visibility];
|
|
73
|
+
/** Malware-scan verdict. Bytes are downloadable only on `clean` or `skipped`. */
|
|
74
|
+
const VirusScanStatus: {
|
|
75
|
+
readonly Pending: "pending";
|
|
76
|
+
readonly Clean: "clean";
|
|
77
|
+
readonly Infected: "infected";
|
|
78
|
+
readonly Error: "error";
|
|
79
|
+
readonly Skipped: "skipped";
|
|
80
|
+
};
|
|
81
|
+
type VirusScanStatus = (typeof VirusScanStatus)[keyof typeof VirusScanStatus];
|
|
82
|
+
const Object_: {
|
|
83
|
+
readonly File: "file";
|
|
84
|
+
};
|
|
85
|
+
type Object_ = (typeof Object_)[keyof typeof Object_];
|
|
86
|
+
}
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.File_ = void 0;
|
|
5
|
+
var File_;
|
|
6
|
+
(function (File_) {
|
|
7
|
+
/** What the bytes are for the platform — fixes the size/type/visibility/scan/retention policy applied to this file. */
|
|
8
|
+
File_.Kind = {
|
|
9
|
+
ProfilePicture: "profile_picture",
|
|
10
|
+
ChatAttachment: "chat_attachment",
|
|
11
|
+
TaskPodPhoto: "task_pod_photo",
|
|
12
|
+
ImportSource: "import_source",
|
|
13
|
+
ImportReport: "import_report",
|
|
14
|
+
SignedDocument: "signed_document",
|
|
15
|
+
ProductImage: "product_image",
|
|
16
|
+
};
|
|
17
|
+
/** Lifecycle: `active` (serving), `quarantined` (malware-positive), `deleted` (bytes purged, row retained under regulatory hold). */
|
|
18
|
+
File_.Status = {
|
|
19
|
+
Active: "active",
|
|
20
|
+
Quarantined: "quarantined",
|
|
21
|
+
Deleted: "deleted",
|
|
22
|
+
};
|
|
23
|
+
/** Access posture of the bytes, fixed by the kind's policy. */
|
|
24
|
+
File_.Visibility = {
|
|
25
|
+
Private: "private",
|
|
26
|
+
Public: "public",
|
|
27
|
+
PublicCdn: "public_cdn",
|
|
28
|
+
};
|
|
29
|
+
/** Malware-scan verdict. Bytes are downloadable only on `clean` or `skipped`. */
|
|
30
|
+
File_.VirusScanStatus = {
|
|
31
|
+
Pending: "pending",
|
|
32
|
+
Clean: "clean",
|
|
33
|
+
Infected: "infected",
|
|
34
|
+
Error: "error",
|
|
35
|
+
Skipped: "skipped",
|
|
36
|
+
};
|
|
37
|
+
File_.Object_ = {
|
|
38
|
+
File: "file",
|
|
39
|
+
};
|
|
40
|
+
})(File_ || (exports.File_ = File_ = {}));
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Aggregated position count for one H3 hex cell.
|
|
3
|
+
*/
|
|
4
|
+
export interface HeatmapCell {
|
|
5
|
+
/** H3 cell index, lowercase hex (string — H3 indexes exceed the JS safe-integer range). */
|
|
6
|
+
h3_cell?: string | undefined;
|
|
7
|
+
/** H3 resolution of the cell (9 or 11). */
|
|
8
|
+
h3_res?: number | undefined;
|
|
9
|
+
/** Number of positions recorded in the cell over the window. */
|
|
10
|
+
count?: number | undefined;
|
|
11
|
+
object?: HeatmapCell.Object_ | undefined;
|
|
12
|
+
}
|
|
13
|
+
export declare namespace HeatmapCell {
|
|
14
|
+
const Object_: {
|
|
15
|
+
readonly HeatmapCell: "heatmap_cell";
|
|
16
|
+
};
|
|
17
|
+
type Object_ = (typeof Object_)[keyof typeof Object_];
|
|
18
|
+
}
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.HeatmapCell = void 0;
|
|
5
|
+
var HeatmapCell;
|
|
6
|
+
(function (HeatmapCell) {
|
|
7
|
+
HeatmapCell.Object_ = {
|
|
8
|
+
HeatmapCell: "heatmap_cell",
|
|
9
|
+
};
|
|
10
|
+
})(HeatmapCell || (exports.HeatmapCell = HeatmapCell = {}));
|
package/dist/api/types/Job.d.ts
CHANGED
|
@@ -47,6 +47,8 @@ export declare namespace Job {
|
|
|
47
47
|
const Kind: {
|
|
48
48
|
readonly MembershipCacheRebuild: "membership_cache_rebuild";
|
|
49
49
|
readonly ServiceAccountApiKeyRegeneration: "service_account_api_key_regeneration";
|
|
50
|
+
readonly FileVirusScan: "file_virus_scan";
|
|
51
|
+
readonly FileThumbnailGeneration: "file_thumbnail_generation";
|
|
50
52
|
};
|
|
51
53
|
type Kind = (typeof Kind)[keyof typeof Kind];
|
|
52
54
|
/** Lifecycle status. Terminal states are `completed`, `failed`, `cancelled`. */
|
package/dist/api/types/Job.js
CHANGED
|
@@ -8,6 +8,8 @@ var Job;
|
|
|
8
8
|
Job.Kind = {
|
|
9
9
|
MembershipCacheRebuild: "membership_cache_rebuild",
|
|
10
10
|
ServiceAccountApiKeyRegeneration: "service_account_api_key_regeneration",
|
|
11
|
+
FileVirusScan: "file_virus_scan",
|
|
12
|
+
FileThumbnailGeneration: "file_thumbnail_generation",
|
|
11
13
|
};
|
|
12
14
|
/** Lifecycle status. Terminal states are `completed`, `failed`, `cancelled`. */
|
|
13
15
|
Job.Status = {
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
import type * as NizamOperatorRuntime from "../index.js";
|
|
2
|
+
/**
|
|
3
|
+
* Envelope for paginated list responses (Stripe-style cursor pagination).
|
|
4
|
+
*/
|
|
5
|
+
export interface ListResponseFile {
|
|
6
|
+
/** Object type discriminator (Stripe pattern). Always `list` for this envelope. */
|
|
7
|
+
object?: ListResponseFile.Object_ | undefined;
|
|
8
|
+
/** Page of resources. Empty array when there are no matches. */
|
|
9
|
+
data?: NizamOperatorRuntime.File_[] | undefined;
|
|
10
|
+
/** True when more pages exist; pass `next_cursor` as `?starting_after=` to fetch the next page. */
|
|
11
|
+
has_more?: boolean | undefined;
|
|
12
|
+
/** True when earlier pages exist; pass `prev_cursor` as `?ending_before=` to fetch the previous page. */
|
|
13
|
+
has_previous?: boolean | undefined;
|
|
14
|
+
/** Opaque cursor for the next page. `null` on the last page. */
|
|
15
|
+
next_cursor?: string | undefined;
|
|
16
|
+
/** Opaque cursor for the previous page. `null` on the first page. */
|
|
17
|
+
prev_cursor?: string | undefined;
|
|
18
|
+
/** Page size that produced this response. */
|
|
19
|
+
limit?: number | undefined;
|
|
20
|
+
}
|
|
21
|
+
export declare namespace ListResponseFile {
|
|
22
|
+
/** Object type discriminator (Stripe pattern). Always `list` for this envelope. */
|
|
23
|
+
const Object_: {
|
|
24
|
+
readonly List: "list";
|
|
25
|
+
};
|
|
26
|
+
type Object_ = (typeof Object_)[keyof typeof Object_];
|
|
27
|
+
}
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.ListResponseFile = void 0;
|
|
5
|
+
var ListResponseFile;
|
|
6
|
+
(function (ListResponseFile) {
|
|
7
|
+
/** Object type discriminator (Stripe pattern). Always `list` for this envelope. */
|
|
8
|
+
ListResponseFile.Object_ = {
|
|
9
|
+
List: "list",
|
|
10
|
+
};
|
|
11
|
+
})(ListResponseFile || (exports.ListResponseFile = ListResponseFile = {}));
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
import type * as NizamOperatorRuntime from "../index.js";
|
|
2
|
+
/**
|
|
3
|
+
* Envelope for paginated list responses (Stripe-style cursor pagination).
|
|
4
|
+
*/
|
|
5
|
+
export interface ListResponseHeatmapCell {
|
|
6
|
+
/** Object type discriminator (Stripe pattern). Always `list` for this envelope. */
|
|
7
|
+
object?: ListResponseHeatmapCell.Object_ | undefined;
|
|
8
|
+
/** Page of resources. Empty array when there are no matches. */
|
|
9
|
+
data?: NizamOperatorRuntime.HeatmapCell[] | undefined;
|
|
10
|
+
/** True when more pages exist; pass `next_cursor` as `?starting_after=` to fetch the next page. */
|
|
11
|
+
has_more?: boolean | undefined;
|
|
12
|
+
/** True when earlier pages exist; pass `prev_cursor` as `?ending_before=` to fetch the previous page. */
|
|
13
|
+
has_previous?: boolean | undefined;
|
|
14
|
+
/** Opaque cursor for the next page. `null` on the last page. */
|
|
15
|
+
next_cursor?: string | undefined;
|
|
16
|
+
/** Opaque cursor for the previous page. `null` on the first page. */
|
|
17
|
+
prev_cursor?: string | undefined;
|
|
18
|
+
/** Page size that produced this response. */
|
|
19
|
+
limit?: number | undefined;
|
|
20
|
+
}
|
|
21
|
+
export declare namespace ListResponseHeatmapCell {
|
|
22
|
+
/** Object type discriminator (Stripe pattern). Always `list` for this envelope. */
|
|
23
|
+
const Object_: {
|
|
24
|
+
readonly List: "list";
|
|
25
|
+
};
|
|
26
|
+
type Object_ = (typeof Object_)[keyof typeof Object_];
|
|
27
|
+
}
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.ListResponseHeatmapCell = void 0;
|
|
5
|
+
var ListResponseHeatmapCell;
|
|
6
|
+
(function (ListResponseHeatmapCell) {
|
|
7
|
+
/** Object type discriminator (Stripe pattern). Always `list` for this envelope. */
|
|
8
|
+
ListResponseHeatmapCell.Object_ = {
|
|
9
|
+
List: "list",
|
|
10
|
+
};
|
|
11
|
+
})(ListResponseHeatmapCell || (exports.ListResponseHeatmapCell = ListResponseHeatmapCell = {}));
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
import type * as NizamOperatorRuntime from "../index.js";
|
|
2
|
+
/**
|
|
3
|
+
* Envelope for paginated list responses (Stripe-style cursor pagination).
|
|
4
|
+
*/
|
|
5
|
+
export interface ListResponseOperatorPosition {
|
|
6
|
+
/** Object type discriminator (Stripe pattern). Always `list` for this envelope. */
|
|
7
|
+
object?: ListResponseOperatorPosition.Object_ | undefined;
|
|
8
|
+
/** Page of resources. Empty array when there are no matches. */
|
|
9
|
+
data?: NizamOperatorRuntime.OperatorPosition[] | undefined;
|
|
10
|
+
/** True when more pages exist; pass `next_cursor` as `?starting_after=` to fetch the next page. */
|
|
11
|
+
has_more?: boolean | undefined;
|
|
12
|
+
/** True when earlier pages exist; pass `prev_cursor` as `?ending_before=` to fetch the previous page. */
|
|
13
|
+
has_previous?: boolean | undefined;
|
|
14
|
+
/** Opaque cursor for the next page. `null` on the last page. */
|
|
15
|
+
next_cursor?: string | undefined;
|
|
16
|
+
/** Opaque cursor for the previous page. `null` on the first page. */
|
|
17
|
+
prev_cursor?: string | undefined;
|
|
18
|
+
/** Page size that produced this response. */
|
|
19
|
+
limit?: number | undefined;
|
|
20
|
+
}
|
|
21
|
+
export declare namespace ListResponseOperatorPosition {
|
|
22
|
+
/** Object type discriminator (Stripe pattern). Always `list` for this envelope. */
|
|
23
|
+
const Object_: {
|
|
24
|
+
readonly List: "list";
|
|
25
|
+
};
|
|
26
|
+
type Object_ = (typeof Object_)[keyof typeof Object_];
|
|
27
|
+
}
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.ListResponseOperatorPosition = void 0;
|
|
5
|
+
var ListResponseOperatorPosition;
|
|
6
|
+
(function (ListResponseOperatorPosition) {
|
|
7
|
+
/** Object type discriminator (Stripe pattern). Always `list` for this envelope. */
|
|
8
|
+
ListResponseOperatorPosition.Object_ = {
|
|
9
|
+
List: "list",
|
|
10
|
+
};
|
|
11
|
+
})(ListResponseOperatorPosition || (exports.ListResponseOperatorPosition = ListResponseOperatorPosition = {}));
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
import type * as NizamOperatorRuntime from "../index.js";
|
|
2
|
+
/**
|
|
3
|
+
* Envelope for paginated list responses (Stripe-style cursor pagination).
|
|
4
|
+
*/
|
|
5
|
+
export interface ListResponsePosition {
|
|
6
|
+
/** Object type discriminator (Stripe pattern). Always `list` for this envelope. */
|
|
7
|
+
object?: ListResponsePosition.Object_ | undefined;
|
|
8
|
+
/** Page of resources. Empty array when there are no matches. */
|
|
9
|
+
data?: NizamOperatorRuntime.Position[] | undefined;
|
|
10
|
+
/** True when more pages exist; pass `next_cursor` as `?starting_after=` to fetch the next page. */
|
|
11
|
+
has_more?: boolean | undefined;
|
|
12
|
+
/** True when earlier pages exist; pass `prev_cursor` as `?ending_before=` to fetch the previous page. */
|
|
13
|
+
has_previous?: boolean | undefined;
|
|
14
|
+
/** Opaque cursor for the next page. `null` on the last page. */
|
|
15
|
+
next_cursor?: string | undefined;
|
|
16
|
+
/** Opaque cursor for the previous page. `null` on the first page. */
|
|
17
|
+
prev_cursor?: string | undefined;
|
|
18
|
+
/** Page size that produced this response. */
|
|
19
|
+
limit?: number | undefined;
|
|
20
|
+
}
|
|
21
|
+
export declare namespace ListResponsePosition {
|
|
22
|
+
/** Object type discriminator (Stripe pattern). Always `list` for this envelope. */
|
|
23
|
+
const Object_: {
|
|
24
|
+
readonly List: "list";
|
|
25
|
+
};
|
|
26
|
+
type Object_ = (typeof Object_)[keyof typeof Object_];
|
|
27
|
+
}
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.ListResponsePosition = void 0;
|
|
5
|
+
var ListResponsePosition;
|
|
6
|
+
(function (ListResponsePosition) {
|
|
7
|
+
/** Object type discriminator (Stripe pattern). Always `list` for this envelope. */
|
|
8
|
+
ListResponsePosition.Object_ = {
|
|
9
|
+
List: "list",
|
|
10
|
+
};
|
|
11
|
+
})(ListResponsePosition || (exports.ListResponsePosition = ListResponsePosition = {}));
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* A short-lived MQTT publish credential for the position ingest broker.
|
|
3
|
+
*/
|
|
4
|
+
export interface MqttToken {
|
|
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?: string | undefined;
|
|
7
|
+
/** Seconds until the token expires. Re-mint before this elapses to stay connected. */
|
|
8
|
+
expires_in?: number | undefined;
|
|
9
|
+
/** The only topic this credential may publish to: nizam/{organizationId}/operators/{operatorId}/location. */
|
|
10
|
+
topic?: string | undefined;
|
|
11
|
+
object?: string | undefined;
|
|
12
|
+
}
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The current position of one operator.
|
|
3
|
+
*/
|
|
4
|
+
export interface OperatorPosition {
|
|
5
|
+
/** Operator id. */
|
|
6
|
+
operator_id?: string | undefined;
|
|
7
|
+
/** Latitude (WGS84). */
|
|
8
|
+
lat?: number | undefined;
|
|
9
|
+
/** Longitude (WGS84). */
|
|
10
|
+
lng?: number | undefined;
|
|
11
|
+
/** Direction of travel, compass degrees [0,360). */
|
|
12
|
+
heading?: number | undefined;
|
|
13
|
+
/** Course over ground, compass degrees [0,360). */
|
|
14
|
+
bearing?: number | undefined;
|
|
15
|
+
/** Ground speed, km/h. */
|
|
16
|
+
speed?: number | undefined;
|
|
17
|
+
/** Altitude above the WGS84 ellipsoid, metres. */
|
|
18
|
+
altitude?: number | undefined;
|
|
19
|
+
/** Device-time of the fix. */
|
|
20
|
+
captured_at?: string | undefined;
|
|
21
|
+
object?: OperatorPosition.Object_ | undefined;
|
|
22
|
+
}
|
|
23
|
+
export declare namespace OperatorPosition {
|
|
24
|
+
const Object_: {
|
|
25
|
+
readonly OperatorPosition: "operator_position";
|
|
26
|
+
};
|
|
27
|
+
type Object_ = (typeof Object_)[keyof typeof Object_];
|
|
28
|
+
}
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.OperatorPosition = void 0;
|
|
5
|
+
var OperatorPosition;
|
|
6
|
+
(function (OperatorPosition) {
|
|
7
|
+
OperatorPosition.Object_ = {
|
|
8
|
+
OperatorPosition: "operator_position",
|
|
9
|
+
};
|
|
10
|
+
})(OperatorPosition || (exports.OperatorPosition = OperatorPosition = {}));
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* One recorded GPS position of an operator.
|
|
3
|
+
*/
|
|
4
|
+
export interface Position {
|
|
5
|
+
/** Position id. */
|
|
6
|
+
id?: string | undefined;
|
|
7
|
+
/** Operator the fix belongs to. */
|
|
8
|
+
operator_id?: string | undefined;
|
|
9
|
+
/** Latitude (WGS84). */
|
|
10
|
+
lat?: number | undefined;
|
|
11
|
+
/** Longitude (WGS84). */
|
|
12
|
+
lng?: number | undefined;
|
|
13
|
+
/** Direction of travel, compass degrees [0,360). */
|
|
14
|
+
heading?: number | undefined;
|
|
15
|
+
/** Course over ground toward the destination, compass degrees [0,360). */
|
|
16
|
+
bearing?: number | undefined;
|
|
17
|
+
/** Ground speed, km/h. */
|
|
18
|
+
speed?: number | undefined;
|
|
19
|
+
/** Altitude above the WGS84 ellipsoid, metres. */
|
|
20
|
+
altitude?: number | undefined;
|
|
21
|
+
/** Device-time the fix was captured (authoritative). */
|
|
22
|
+
recorded_at?: string | undefined;
|
|
23
|
+
object?: Position.Object_ | undefined;
|
|
24
|
+
}
|
|
25
|
+
export declare namespace Position {
|
|
26
|
+
const Object_: {
|
|
27
|
+
readonly Position: "position";
|
|
28
|
+
};
|
|
29
|
+
type Object_ = (typeof Object_)[keyof typeof Object_];
|
|
30
|
+
}
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.Position = void 0;
|
|
5
|
+
var Position;
|
|
6
|
+
(function (Position) {
|
|
7
|
+
Position.Object_ = {
|
|
8
|
+
Position: "position",
|
|
9
|
+
};
|
|
10
|
+
})(Position || (exports.Position = Position = {}));
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
import type * as NizamOperatorRuntime from "../index.js";
|
|
2
|
+
/**
|
|
3
|
+
* A proof-of-delivery photo captured during a task attempt.
|
|
4
|
+
*/
|
|
5
|
+
export interface TaskAttemptPhoto {
|
|
6
|
+
/** Photo record id. */
|
|
7
|
+
id?: string | undefined;
|
|
8
|
+
/** Central file id — request bytes via the files download-url endpoint. */
|
|
9
|
+
file_id?: string | undefined;
|
|
10
|
+
/** Display order within the attempt. */
|
|
11
|
+
sequence?: number | undefined;
|
|
12
|
+
/** Photo category, when categorised. */
|
|
13
|
+
photo_type?: string | undefined;
|
|
14
|
+
/** Operator-entered caption. */
|
|
15
|
+
caption?: string | undefined;
|
|
16
|
+
/** Device capture time (EXIF), when reported. */
|
|
17
|
+
taken_at?: string | undefined;
|
|
18
|
+
/** May the bytes be served right now (scan verdict + lifecycle)? */
|
|
19
|
+
downloadable?: boolean | undefined;
|
|
20
|
+
thumbnails?: NizamOperatorRuntime.TaskAttemptPhotoThumbnail[] | undefined;
|
|
21
|
+
/** When the photo row was recorded. */
|
|
22
|
+
created_at?: string | undefined;
|
|
23
|
+
object?: TaskAttemptPhoto.Object_ | undefined;
|
|
24
|
+
}
|
|
25
|
+
export declare namespace TaskAttemptPhoto {
|
|
26
|
+
const Object_: {
|
|
27
|
+
readonly TaskAttemptPhoto: "task_attempt_photo";
|
|
28
|
+
};
|
|
29
|
+
type Object_ = (typeof Object_)[keyof typeof Object_];
|
|
30
|
+
}
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.TaskAttemptPhoto = void 0;
|
|
5
|
+
var TaskAttemptPhoto;
|
|
6
|
+
(function (TaskAttemptPhoto) {
|
|
7
|
+
TaskAttemptPhoto.Object_ = {
|
|
8
|
+
TaskAttemptPhoto: "task_attempt_photo",
|
|
9
|
+
};
|
|
10
|
+
})(TaskAttemptPhoto || (exports.TaskAttemptPhoto = TaskAttemptPhoto = {}));
|