@nizam-os/merchant-sdk 3.0.0 → 5.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.
Files changed (86) hide show
  1. package/dist/api/resources/files/client/Client.d.ts +3 -1
  2. package/dist/api/resources/files/client/Client.js +11 -6
  3. package/dist/api/resources/files/client/requests/InitiateFileUploadRequest.d.ts +4 -0
  4. package/dist/api/resources/files/client/requests/InitiateFileUploadRequest.js +1 -0
  5. package/dist/api/resources/files/client/requests/ListFilesRequest.d.ts +7 -6
  6. package/dist/api/resources/files/index.d.ts +1 -0
  7. package/dist/api/resources/files/index.js +1 -0
  8. package/dist/api/resources/files/types/ListFilesRequestKindItem.d.ts +11 -0
  9. package/dist/api/resources/files/types/ListFilesRequestKindItem.js +14 -0
  10. package/dist/api/resources/files/types/ListFilesRequestSortItem.d.ts +5 -0
  11. package/dist/api/resources/files/types/ListFilesRequestSortItem.js +8 -0
  12. package/dist/api/resources/files/types/ListFilesRequestStatusItem.d.ts +6 -0
  13. package/dist/api/resources/files/types/ListFilesRequestStatusItem.js +9 -0
  14. package/dist/api/resources/files/types/index.d.ts +3 -0
  15. package/dist/api/resources/files/types/index.js +19 -0
  16. package/dist/api/resources/index.d.ts +2 -0
  17. package/dist/api/resources/index.js +2 -0
  18. package/dist/api/resources/notifications/client/Client.d.ts +1 -1
  19. package/dist/api/resources/notifications/client/Client.js +2 -2
  20. package/dist/api/resources/notifications/client/requests/ListNotificationsRequest.d.ts +3 -2
  21. package/dist/api/resources/notifications/index.d.ts +1 -0
  22. package/dist/api/resources/notifications/index.js +1 -0
  23. package/dist/api/resources/notifications/types/ListNotificationsRequestSortItem.d.ts +5 -0
  24. package/dist/api/resources/notifications/types/ListNotificationsRequestSortItem.js +8 -0
  25. package/dist/api/resources/notifications/types/index.d.ts +1 -0
  26. package/dist/api/resources/notifications/types/index.js +17 -0
  27. package/dist/api/types/ActiveOrganization.d.ts +2 -2
  28. package/dist/api/types/ActivityResource.d.ts +4 -4
  29. package/dist/api/types/AllowedTransitions.d.ts +28 -0
  30. package/dist/api/types/AllowedTransitions.js +23 -0
  31. package/dist/api/types/AllowedTransitionsRequest.d.ts +7 -0
  32. package/dist/api/types/AllowedTransitionsRequest.js +3 -0
  33. package/dist/api/types/ApiFieldError.d.ts +1 -1
  34. package/dist/api/types/Asset.d.ts +26 -4
  35. package/dist/api/types/Asset.js +13 -0
  36. package/dist/api/types/AssetListItem.d.ts +11 -5
  37. package/dist/api/types/Assignment.d.ts +6 -6
  38. package/dist/api/types/BulkJobSubmission.d.ts +3 -3
  39. package/dist/api/types/BusinessCategory.d.ts +3 -3
  40. package/dist/api/types/Country.d.ts +3 -3
  41. package/dist/api/types/CreateAssetRequest.d.ts +25 -0
  42. package/dist/api/types/CreateAssetRequest.js +10 -0
  43. package/dist/api/types/Currency.d.ts +5 -5
  44. package/dist/api/types/Device.d.ts +21 -6
  45. package/dist/api/types/Device.js +13 -0
  46. package/dist/api/types/Devices.d.ts +2 -2
  47. package/dist/api/types/ExportAssetsRequest.d.ts +36 -0
  48. package/dist/api/types/ExportAssetsRequest.js +31 -0
  49. package/dist/api/types/FileDownloadUrl.d.ts +4 -4
  50. package/dist/api/types/FileUploadSession.d.ts +12 -11
  51. package/dist/api/types/FileUploadSession.js +1 -0
  52. package/dist/api/types/File_.d.ts +14 -13
  53. package/dist/api/types/File_.js +1 -0
  54. package/dist/api/types/HeatmapCell.d.ts +4 -4
  55. package/dist/api/types/ImportError.d.ts +4 -4
  56. package/dist/api/types/ImportSubmission.d.ts +4 -4
  57. package/dist/api/types/Invite.d.ts +8 -8
  58. package/dist/api/types/Job.d.ts +11 -11
  59. package/dist/api/types/JobSubmission.d.ts +2 -2
  60. package/dist/api/types/Language.d.ts +4 -4
  61. package/dist/api/types/Membership.d.ts +3 -3
  62. package/dist/api/types/MqttToken.d.ts +4 -4
  63. package/dist/api/types/Notification.d.ts +9 -9
  64. package/dist/api/types/NotificationCounts.d.ts +5 -5
  65. package/dist/api/types/NotificationDeadLetter.d.ts +9 -9
  66. package/dist/api/types/NotificationPreferences.d.ts +2 -2
  67. package/dist/api/types/NotificationUnreadCount.d.ts +2 -2
  68. package/dist/api/types/NotificationsArchived.d.ts +2 -2
  69. package/dist/api/types/NotificationsMarkedRead.d.ts +2 -2
  70. package/dist/api/types/Operator.d.ts +4 -4
  71. package/dist/api/types/OperatorPosition.d.ts +5 -5
  72. package/dist/api/types/Organization.d.ts +7 -7
  73. package/dist/api/types/Position.d.ts +6 -6
  74. package/dist/api/types/ProblemDetail.d.ts +1 -1
  75. package/dist/api/types/RealtimeTicket.d.ts +3 -3
  76. package/dist/api/types/ReconcileResponse.d.ts +4 -4
  77. package/dist/api/types/TaskAttemptPhoto.d.ts +7 -7
  78. package/dist/api/types/Timezone.d.ts +4 -4
  79. package/dist/api/types/UpdateAssetRequest.d.ts +21 -0
  80. package/dist/api/types/UpdateAssetRequest.js +3 -0
  81. package/dist/api/types/UploadInitiation.d.ts +6 -6
  82. package/dist/api/types/User.d.ts +5 -5
  83. package/dist/api/types/UserResource.d.ts +4 -4
  84. package/dist/api/types/index.d.ts +4 -0
  85. package/dist/api/types/index.js +4 -0
  86. package/package.json +1 -1
@@ -3,21 +3,27 @@
3
3
  */
4
4
  export interface AssetListItem {
5
5
  /** Stable UUID. */
6
- id?: string | undefined;
6
+ id: string;
7
7
  /** Top-level kind. */
8
- kind?: AssetListItem.Kind | undefined;
8
+ kind: AssetListItem.Kind;
9
9
  /** Sub-kind within the kind (free-form). */
10
10
  sub_kind?: string | undefined;
11
11
  /** SAE J3016 autonomy level 0..5. */
12
12
  autonomy_level?: number | undefined;
13
13
  /** Lifecycle status. */
14
- status?: AssetListItem.Status | undefined;
14
+ status: AssetListItem.Status;
15
15
  /** Display name. */
16
16
  name?: string | undefined;
17
17
  /** Vehicle Identification Number. */
18
18
  vin?: string | undefined;
19
19
  /** License plate. */
20
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;
21
27
  /** Owning organization id. */
22
28
  organization_id?: string | undefined;
23
29
  /** Current primary operator (active assignment, role=primary). */
@@ -25,11 +31,11 @@ export interface AssetListItem {
25
31
  /** Creation timestamp (ISO-8601 UTC). */
26
32
  created_at?: string | undefined;
27
33
  /** Relevance score (descending) when the request carried `q`; 0 for plain listings. Scores are only comparable within a single response. */
28
- rank?: number | undefined;
34
+ rank: number;
29
35
  /** Highlighted match fragment when the request carried `q&highlight=true`. Matched terms are wrapped in `<mark>…</mark>`. */
30
36
  snippet?: string | undefined;
31
37
  /** Object type discriminator. */
32
- object?: AssetListItem.Object_ | undefined;
38
+ object: AssetListItem.Object_;
33
39
  }
34
40
  export declare namespace AssetListItem {
35
41
  /** Top-level kind. */
@@ -3,21 +3,21 @@
3
3
  */
4
4
  export interface Assignment {
5
5
  /** Stable UUID. */
6
- id?: string | undefined;
6
+ id: string;
7
7
  /** Asset id. */
8
- asset_id?: string | undefined;
8
+ asset_id: string;
9
9
  /** Operator id. */
10
- operator_id?: string | undefined;
10
+ operator_id: string;
11
11
  /** Role discriminator for concurrent assignments on the same asset. */
12
- role?: Assignment.Role | undefined;
12
+ role: Assignment.Role;
13
13
  /** Start of validity. */
14
- valid_from?: string | undefined;
14
+ valid_from: string;
15
15
  /** End of validity (null = still active). */
16
16
  valid_until?: string | undefined;
17
17
  /** Why the assignment was closed (null while active). */
18
18
  terminated_reason?: Assignment.TerminatedReason | undefined;
19
19
  /** Object type discriminator. */
20
- object?: Assignment.Object_ | undefined;
20
+ object: Assignment.Object_;
21
21
  }
22
22
  export declare namespace Assignment {
23
23
  /** Role discriminator for concurrent assignments on the same asset. */
@@ -2,10 +2,10 @@
2
2
  * Acknowledgement of a bulk admin action that fanned out one job per work item.
3
3
  */
4
4
  export interface BulkJobSubmission {
5
- job_ids?: string[] | undefined;
5
+ job_ids: string[];
6
6
  /** Number of jobs created (one per matched service account). */
7
- count?: number | undefined;
8
- object?: BulkJobSubmission.Object_ | undefined;
7
+ count: number;
8
+ object: BulkJobSubmission.Object_;
9
9
  }
10
10
  export declare namespace BulkJobSubmission {
11
11
  const Object_: {
@@ -3,11 +3,11 @@
3
3
  */
4
4
  export interface BusinessCategory {
5
5
  /** Stable slug — matches the DB CHECK constraint on `organizations.business_category`. */
6
- slug?: string | undefined;
6
+ slug: string;
7
7
  /** Human-readable label for picker UIs. */
8
- display_name?: string | undefined;
8
+ display_name: string;
9
9
  /** Object type discriminator. */
10
- object?: BusinessCategory.Object_ | undefined;
10
+ object: BusinessCategory.Object_;
11
11
  }
12
12
  export declare namespace BusinessCategory {
13
13
  /** Object type discriminator. */
@@ -3,13 +3,13 @@
3
3
  */
4
4
  export interface Country {
5
5
  /** ISO 3166-1 alpha-2 code. */
6
- code?: string | undefined;
6
+ code: string;
7
7
  /** Display name in the Accept-Language locale. */
8
- name?: string | undefined;
8
+ name: string;
9
9
  /** E.164 country calling code with `+` prefix, or null if not allocated. */
10
10
  calling_code?: string | undefined;
11
11
  /** Object type discriminator. */
12
- object?: Country.Object_ | undefined;
12
+ object: Country.Object_;
13
13
  }
14
14
  export declare namespace Country {
15
15
  /** Object type discriminator. */
@@ -4,10 +4,24 @@
4
4
  export interface CreateAssetRequest {
5
5
  /** Top-level kind. */
6
6
  kind: CreateAssetRequest.Kind;
7
+ /** Initial lifecycle status — the asset's birth state. Optional; defaults to `active`. Subsequent changes go through the status-transition endpoint. */
8
+ status?: CreateAssetRequest.Status | undefined;
7
9
  /** Display name. */
8
10
  name?: string | undefined;
11
+ /** Sub-kind within the kind (free-form). */
12
+ sub_kind?: string | undefined;
9
13
  /** SAE J3016 autonomy level 0..5. */
10
14
  autonomy_level?: number | undefined;
15
+ /** Vehicle Identification Number — 17 chars of A-Z (no I, O, Q) and 0-9, uppercase. Unique per organization. */
16
+ vin?: string | undefined;
17
+ /** License plate. */
18
+ plate_number?: string | undefined;
19
+ /** Manufacturer. */
20
+ make?: string | undefined;
21
+ /** Model designation. */
22
+ model?: string | undefined;
23
+ /** Model year — 1900 or later, and no later than next year. */
24
+ year?: number | undefined;
11
25
  }
12
26
  export declare namespace CreateAssetRequest {
13
27
  /** Top-level kind. */
@@ -23,4 +37,15 @@ export declare namespace CreateAssetRequest {
23
37
  readonly Equipment: "equipment";
24
38
  };
25
39
  type Kind = (typeof Kind)[keyof typeof Kind];
40
+ /** Initial lifecycle status — the asset's birth state. Optional; defaults to `active`. Subsequent changes go through the status-transition endpoint. */
41
+ const Status: {
42
+ readonly Active: "active";
43
+ readonly Maintenance: "maintenance";
44
+ readonly OutOfService: "out_of_service";
45
+ readonly Retired: "retired";
46
+ readonly Sold: "sold";
47
+ readonly Inactive: "inactive";
48
+ readonly Lost: "lost";
49
+ };
50
+ type Status = (typeof Status)[keyof typeof Status];
26
51
  }
@@ -16,4 +16,14 @@ var CreateAssetRequest;
16
16
  Pallet: "pallet",
17
17
  Equipment: "equipment",
18
18
  };
19
+ /** Initial lifecycle status — the asset's birth state. Optional; defaults to `active`. Subsequent changes go through the status-transition endpoint. */
20
+ CreateAssetRequest.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
+ };
19
29
  })(CreateAssetRequest || (exports.CreateAssetRequest = CreateAssetRequest = {}));
@@ -3,15 +3,15 @@
3
3
  */
4
4
  export interface Currency {
5
5
  /** ISO 4217 code. */
6
- code?: string | undefined;
6
+ code: string;
7
7
  /** Display name in the Accept-Language locale. */
8
- name?: string | undefined;
8
+ name: string;
9
9
  /** Short symbol in the Accept-Language locale. */
10
- symbol?: string | undefined;
10
+ symbol: string;
11
11
  /** Default number of fractional digits per ISO 4217. */
12
- fraction_digits?: number | undefined;
12
+ fraction_digits: number;
13
13
  /** Object type discriminator. */
14
- object?: Currency.Object_ | undefined;
14
+ object: Currency.Object_;
15
15
  }
16
16
  export declare namespace Currency {
17
17
  /** Object type discriminator. */
@@ -3,19 +3,34 @@
3
3
  */
4
4
  export interface Device {
5
5
  /** Device id. */
6
- id?: string | undefined;
6
+ id: string;
7
7
  /** Push transport. */
8
- platform?: string | undefined;
8
+ platform: Device.Platform;
9
9
  /** Registration lifecycle. */
10
- status?: string | undefined;
10
+ status: Device.Status;
11
11
  /** When the device was first registered. */
12
- registered_at?: string | undefined;
12
+ registered_at: string;
13
13
  /** When the registration was last refreshed (last seen). */
14
- last_seen_at?: string | undefined;
14
+ last_seen_at: string;
15
15
  /** Object type discriminator. */
16
- object?: Device.Object_ | undefined;
16
+ object: Device.Object_;
17
17
  }
18
18
  export declare namespace Device {
19
+ /** Push transport. */
20
+ const Platform: {
21
+ readonly Ios: "ios";
22
+ readonly Android: "android";
23
+ readonly Web: "web";
24
+ };
25
+ type Platform = (typeof Platform)[keyof typeof Platform];
26
+ /** Registration lifecycle. */
27
+ const Status: {
28
+ readonly Active: "active";
29
+ readonly Suspended: "suspended";
30
+ readonly Inactive: "inactive";
31
+ readonly Expired: "expired";
32
+ };
33
+ type Status = (typeof Status)[keyof typeof Status];
19
34
  /** Object type discriminator. */
20
35
  const Object_: {
21
36
  readonly Device: "device";
@@ -4,6 +4,19 @@ Object.defineProperty(exports, "__esModule", { value: true });
4
4
  exports.Device = void 0;
5
5
  var Device;
6
6
  (function (Device) {
7
+ /** Push transport. */
8
+ Device.Platform = {
9
+ Ios: "ios",
10
+ Android: "android",
11
+ Web: "web",
12
+ };
13
+ /** Registration lifecycle. */
14
+ Device.Status = {
15
+ Active: "active",
16
+ Suspended: "suspended",
17
+ Inactive: "inactive",
18
+ Expired: "expired",
19
+ };
7
20
  /** Object type discriminator. */
8
21
  Device.Object_ = {
9
22
  Device: "device",
@@ -4,9 +4,9 @@ import type * as NizamMerchant from "../index.js";
4
4
  */
5
5
  export interface Devices {
6
6
  /** The caller's live device registrations. */
7
- devices?: NizamMerchant.Device[] | undefined;
7
+ devices: NizamMerchant.Device[];
8
8
  /** Object type discriminator. */
9
- object?: Devices.Object_ | undefined;
9
+ object: Devices.Object_;
10
10
  }
11
11
  export declare namespace Devices {
12
12
  /** Object type discriminator. */
@@ -0,0 +1,36 @@
1
+ export interface ExportAssetsRequest {
2
+ /** Output format. */
3
+ format: ExportAssetsRequest.Format;
4
+ /** Columns to export, in display order. `id` is a UUID — the safe, stable re-import/audit key; `kind`/`status` carry their stored code, not the tenant's display label. */
5
+ fields: ExportAssetsRequest.Fields.Item[];
6
+ /** Asset ids to export (the current selection). Capped at 10000. */
7
+ ids: string[];
8
+ }
9
+ export declare namespace ExportAssetsRequest {
10
+ /** Output format. */
11
+ const Format: {
12
+ readonly Csv: "csv";
13
+ readonly Xlsx: "xlsx";
14
+ readonly Json: "json";
15
+ };
16
+ type Format = (typeof Format)[keyof typeof Format];
17
+ type Fields = Fields.Item[];
18
+ namespace Fields {
19
+ /** An exportable asset column key (mirrors the list columns). */
20
+ const Item: {
21
+ readonly Id: "id";
22
+ readonly Name: "name";
23
+ readonly Kind: "kind";
24
+ readonly SubKind: "sub_kind";
25
+ readonly AutonomyLevel: "autonomy_level";
26
+ readonly Status: "status";
27
+ readonly Make: "make";
28
+ readonly Model: "model";
29
+ readonly Year: "year";
30
+ readonly PlateNumber: "plate_number";
31
+ readonly Vin: "vin";
32
+ readonly CreatedAt: "created_at";
33
+ };
34
+ type Item = (typeof Item)[keyof typeof Item];
35
+ }
36
+ }
@@ -0,0 +1,31 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
4
+ exports.ExportAssetsRequest = void 0;
5
+ var ExportAssetsRequest;
6
+ (function (ExportAssetsRequest) {
7
+ /** Output format. */
8
+ ExportAssetsRequest.Format = {
9
+ Csv: "csv",
10
+ Xlsx: "xlsx",
11
+ Json: "json",
12
+ };
13
+ let Fields;
14
+ (function (Fields) {
15
+ /** An exportable asset column key (mirrors the list columns). */
16
+ Fields.Item = {
17
+ Id: "id",
18
+ Name: "name",
19
+ Kind: "kind",
20
+ SubKind: "sub_kind",
21
+ AutonomyLevel: "autonomy_level",
22
+ Status: "status",
23
+ Make: "make",
24
+ Model: "model",
25
+ Year: "year",
26
+ PlateNumber: "plate_number",
27
+ Vin: "vin",
28
+ CreatedAt: "created_at",
29
+ };
30
+ })(Fields = ExportAssetsRequest.Fields || (ExportAssetsRequest.Fields = {}));
31
+ })(ExportAssetsRequest || (exports.ExportAssetsRequest = ExportAssetsRequest = {}));
@@ -1,12 +1,12 @@
1
1
  /**
2
- * A short-lived URL granting read access to the file's bytes. Fetch it promptly — request a fresh grant after expiry.
2
+ * A short-lived URL granting read access to a file's bytes. Fetch it promptly — request a fresh grant after expiry.
3
3
  */
4
4
  export interface FileDownloadUrl {
5
5
  /** The URL to GET the bytes from. */
6
- url?: string | undefined;
6
+ url: string;
7
7
  /** When the URL stops working. */
8
- expires_at?: string | undefined;
9
- object?: FileDownloadUrl.Object_ | undefined;
8
+ expires_at: string;
9
+ object: FileDownloadUrl.Object_;
10
10
  }
11
11
  export declare namespace FileDownloadUrl {
12
12
  const Object_: {
@@ -4,24 +4,24 @@ import type * as NizamMerchant from "../index.js";
4
4
  */
5
5
  export interface FileUploadSession {
6
6
  /** Session id — the handle for resume / complete / cancel. */
7
- id?: string | undefined;
7
+ id: string;
8
8
  /** Pre-reserved id of the file this upload will become. */
9
- file_id?: string | undefined;
9
+ file_id: string;
10
10
  /** The kind declared at initiation. */
11
- kind?: FileUploadSession.Kind | undefined;
11
+ kind: FileUploadSession.Kind;
12
12
  /** Session lifecycle. */
13
- status?: FileUploadSession.Status | undefined;
13
+ status: FileUploadSession.Status;
14
14
  /** Nominal part size; every part except the last must be exactly this size. */
15
- part_size_bytes?: number | undefined;
15
+ part_size_bytes: number;
16
16
  /** Total parts in the layout. */
17
- part_count?: number | undefined;
17
+ part_count: number;
18
18
  /** Bytes confirmed so far (client-reported, re-verified at completion). */
19
- bytes_uploaded?: number | undefined;
20
- completed_part_numbers?: number[] | undefined;
21
- parts?: NizamMerchant.FileUploadPart[] | undefined;
19
+ bytes_uploaded: number;
20
+ completed_part_numbers: number[];
21
+ parts: NizamMerchant.FileUploadPart[];
22
22
  /** Deadline: the session expires and is swept if not completed by then. */
23
- expires_at?: string | undefined;
24
- object?: FileUploadSession.Object_ | undefined;
23
+ expires_at: string;
24
+ object: FileUploadSession.Object_;
25
25
  }
26
26
  export declare namespace FileUploadSession {
27
27
  /** The kind declared at initiation. */
@@ -33,6 +33,7 @@ export declare namespace FileUploadSession {
33
33
  readonly ImportReport: "import_report";
34
34
  readonly SignedDocument: "signed_document";
35
35
  readonly ProductImage: "product_image";
36
+ readonly DataExport: "data_export";
36
37
  };
37
38
  type Kind = (typeof Kind)[keyof typeof Kind];
38
39
  /** Session lifecycle. */
@@ -13,6 +13,7 @@ var FileUploadSession;
13
13
  ImportReport: "import_report",
14
14
  SignedDocument: "signed_document",
15
15
  ProductImage: "product_image",
16
+ DataExport: "data_export",
16
17
  };
17
18
  /** Session lifecycle. */
18
19
  FileUploadSession.Status = {
@@ -3,13 +3,13 @@
3
3
  */
4
4
  export interface File_ {
5
5
  /** Stable file id (pre-reserved at upload initiation). */
6
- id?: string | undefined;
6
+ id: string;
7
7
  /** Owning organization. */
8
- organization_id?: string | undefined;
8
+ organization_id: string;
9
9
  /** Uploading user. Null for system-generated artifacts. */
10
10
  uploader_id?: string | undefined;
11
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;
12
+ kind: File_.Kind;
13
13
  /** Type of the business entity this file documents. */
14
14
  subject_type?: string | undefined;
15
15
  /** Id of the business entity this file documents. */
@@ -17,21 +17,21 @@ export interface File_ {
17
17
  /** For derived files (thumbnails): the original this one was rendered from. */
18
18
  parent_file_id?: string | undefined;
19
19
  /** Client-supplied filename, served back via Content-Disposition on download. */
20
- original_filename?: string | undefined;
20
+ original_filename: string;
21
21
  /** MIME type declared by the uploader at initiation. */
22
- declared_content_type?: string | undefined;
22
+ declared_content_type: string;
23
23
  /** MIME type detected server-side from the bytes (Tika). Null when detection was inconclusive. */
24
24
  sniffed_content_type?: string | undefined;
25
25
  /** Object size in bytes, storage-confirmed at completion. */
26
- size_bytes?: number | undefined;
26
+ size_bytes: number;
27
27
  /** SHA-256 of the content, 64 lowercase hex characters. */
28
- checksum_sha256?: string | undefined;
28
+ checksum_sha256: string;
29
29
  /** Lifecycle: `active` (serving), `quarantined` (malware-positive), `deleted` (bytes purged, row retained under regulatory hold). */
30
- status?: File_.Status | undefined;
30
+ status: File_.Status;
31
31
  /** Access posture of the bytes, fixed by the kind's policy. */
32
- visibility?: File_.Visibility | undefined;
32
+ visibility: File_.Visibility;
33
33
  /** Malware-scan verdict. Bytes are downloadable only on `clean` or `skipped`. */
34
- virus_scan_status?: File_.VirusScanStatus | undefined;
34
+ virus_scan_status: File_.VirusScanStatus;
35
35
  /** When the scan verdict was produced. */
36
36
  virus_scanned_at?: string | undefined;
37
37
  /** When this file becomes eligible for the lifecycle sweep (TTL kinds). */
@@ -39,10 +39,10 @@ export interface File_ {
39
39
  /** Regulatory hold: the file cannot be deleted before this instant. */
40
40
  retention_until?: string | undefined;
41
41
  /** Upload completion time. */
42
- created_at?: string | undefined;
42
+ created_at: string;
43
43
  /** Last lifecycle/scan change. */
44
- updated_at?: string | undefined;
45
- object?: File_.Object_ | undefined;
44
+ updated_at: string;
45
+ object: File_.Object_;
46
46
  }
47
47
  export declare namespace File_ {
48
48
  /** What the bytes are for the platform — fixes the size/type/visibility/scan/retention policy applied to this file. */
@@ -54,6 +54,7 @@ export declare namespace File_ {
54
54
  readonly ImportReport: "import_report";
55
55
  readonly SignedDocument: "signed_document";
56
56
  readonly ProductImage: "product_image";
57
+ readonly DataExport: "data_export";
57
58
  };
58
59
  type Kind = (typeof Kind)[keyof typeof Kind];
59
60
  /** Lifecycle: `active` (serving), `quarantined` (malware-positive), `deleted` (bytes purged, row retained under regulatory hold). */
@@ -13,6 +13,7 @@ var File_;
13
13
  ImportReport: "import_report",
14
14
  SignedDocument: "signed_document",
15
15
  ProductImage: "product_image",
16
+ DataExport: "data_export",
16
17
  };
17
18
  /** Lifecycle: `active` (serving), `quarantined` (malware-positive), `deleted` (bytes purged, row retained under regulatory hold). */
18
19
  File_.Status = {
@@ -3,12 +3,12 @@
3
3
  */
4
4
  export interface HeatmapCell {
5
5
  /** H3 cell index, lowercase hex (string — H3 indexes exceed the JS safe-integer range). */
6
- h3_cell?: string | undefined;
6
+ h3_cell: string;
7
7
  /** H3 resolution of the cell (9 or 11). */
8
- h3_res?: number | undefined;
8
+ h3_res: number;
9
9
  /** Number of positions recorded in the cell over the window. */
10
- count?: number | undefined;
11
- object?: HeatmapCell.Object_ | undefined;
10
+ count: number;
11
+ object: HeatmapCell.Object_;
12
12
  }
13
13
  export declare namespace HeatmapCell {
14
14
  const Object_: {
@@ -3,16 +3,16 @@
3
3
  */
4
4
  export interface ImportError {
5
5
  /** The 1-based data-row index that failed (header excluded). */
6
- row_number?: number | undefined;
6
+ row_number: number;
7
7
  /** The offending column header, or null for a whole-row error. */
8
8
  field?: string | undefined;
9
9
  /** Stable machine-readable error code. */
10
- error_code?: string | undefined;
10
+ error_code: string;
11
11
  /** Human-readable explanation of the error. */
12
- error_message?: string | undefined;
12
+ error_message: string;
13
13
  /** The raw cell value that failed (truncated), when relevant. */
14
14
  raw_value?: string | undefined;
15
- object?: ImportError.Object_ | undefined;
15
+ object: ImportError.Object_;
16
16
  }
17
17
  export declare namespace ImportError {
18
18
  const Object_: {
@@ -4,11 +4,11 @@ import type * as NizamMerchant from "../index.js";
4
4
  */
5
5
  export interface ImportSubmission {
6
6
  /** The created import job — poll/cancel it via /v1/jobs/{id}. */
7
- job_id?: string | undefined;
7
+ job_id: string;
8
8
  /** The id the uploaded source file will carry. */
9
- file_id?: string | undefined;
10
- upload?: NizamMerchant.FileUploadSession | undefined;
11
- object?: ImportSubmission.Object_ | undefined;
9
+ file_id: string;
10
+ upload: NizamMerchant.FileUploadSession;
11
+ object: ImportSubmission.Object_;
12
12
  }
13
13
  export declare namespace ImportSubmission {
14
14
  const Object_: {
@@ -3,21 +3,21 @@
3
3
  */
4
4
  export interface Invite {
5
5
  /** Stable UUID of this invite. */
6
- id?: string | undefined;
6
+ id: string;
7
7
  /** Organization the invite confers membership in. */
8
- organization_id?: string | undefined;
8
+ organization_id: string;
9
9
  /** Recipient email — canonical lowercase form. */
10
- invited_email?: string | undefined;
10
+ invited_email: string;
11
11
  /** Role the recipient will hold after acceptance. */
12
- role?: Invite.Role | undefined;
12
+ role: Invite.Role;
13
13
  /** Lifecycle status. */
14
- status?: Invite.Status | undefined;
14
+ status: Invite.Status;
15
15
  /** When the invite expires. Recipients must accept before then. */
16
- expires_at?: string | undefined;
16
+ expires_at: string;
17
17
  /** Bearer secret used to redeem the invite. Returned only on POST /v1/invites; subsequent lookups omit it. */
18
- token?: string | undefined;
18
+ token: string;
19
19
  /** Object type discriminator. */
20
- object?: Invite.Object_ | undefined;
20
+ object: Invite.Object_;
21
21
  }
22
22
  export declare namespace Invite {
23
23
  /** Role the recipient will hold after acceptance. */
@@ -3,13 +3,13 @@
3
3
  */
4
4
  export interface Job {
5
5
  /** Stable job id. */
6
- id?: string | undefined;
6
+ id: string;
7
7
  /** Owning organization. */
8
- organization_id?: string | undefined;
8
+ organization_id: string;
9
9
  /** What kind of work this job performs; the kind also fixes the executing engine. */
10
- kind?: Job.Kind | undefined;
10
+ kind: Job.Kind;
11
11
  /** Lifecycle status. Terminal states are `completed`, `failed`, `cancelled`. */
12
- status?: Job.Status | undefined;
12
+ status: Job.Status;
13
13
  /** User who submitted the job. Null only if that user was since deleted. */
14
14
  requested_by_id?: string | undefined;
15
15
  /** File the job consumes (kind-specific), e.g. an uploaded import file. References a file id; download via the file's own endpoint. */
@@ -19,9 +19,9 @@ export interface Job {
19
19
  /** Total work items, once the engine has sized the work. Null while unknown. */
20
20
  rows_total?: number | undefined;
21
21
  /** Work items processed so far (monotonic). */
22
- rows_processed?: number | undefined;
22
+ rows_processed: number;
23
23
  /** Work items that failed so far (monotonic). */
24
- rows_failed?: number | undefined;
24
+ rows_failed: number;
25
25
  /** Operator-facing failure reason. Set only when status is `failed`. */
26
26
  error_summary?: string | undefined;
27
27
  /** Temporal workflow id (Temporal-engine kinds only) — cross-reference into the Temporal UI. */
@@ -29,18 +29,18 @@ export interface Job {
29
29
  /** Temporal run id of the latest attempt (changes across workflow retries). */
30
30
  run_id?: string | undefined;
31
31
  /** Engine execution attempts spent so far. */
32
- attempt_count?: number | undefined;
32
+ attempt_count: number;
33
33
  /** Retry budget: a failed job with attempt_count >= max_attempts is dead-lettered. */
34
- max_attempts?: number | undefined;
34
+ max_attempts: number;
35
35
  /** When the first engine attempt started. Null while pending (and for jobs cancelled before starting). */
36
36
  started_at?: string | undefined;
37
37
  /** When the job reached a terminal status. */
38
38
  finished_at?: string | undefined;
39
39
  /** Submission time. */
40
- created_at?: string | undefined;
40
+ created_at: string;
41
41
  /** Last state/progress change. */
42
- updated_at?: string | undefined;
43
- object?: Job.Object_ | undefined;
42
+ updated_at: string;
43
+ object: Job.Object_;
44
44
  }
45
45
  export declare namespace Job {
46
46
  /** What kind of work this job performs; the kind also fixes the executing engine. */
@@ -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?: string | undefined;
7
- object?: JobSubmission.Object_ | undefined;
6
+ job_id: string;
7
+ object: JobSubmission.Object_;
8
8
  }
9
9
  export declare namespace JobSubmission {
10
10
  const Object_: {