@wakata-dev/api-client 0.3.0 → 0.3.2
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/index.cjs +35 -22
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +1045 -1812
- package/dist/index.d.ts +1045 -1812
- package/dist/index.js +35 -22
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/dist/index.d.cts
CHANGED
|
@@ -1,2388 +1,1565 @@
|
|
|
1
1
|
import * as _hey_api_client_fetch from '@hey-api/client-fetch';
|
|
2
2
|
import { TDataShape, Options as Options$1, Client } from '@hey-api/client-fetch';
|
|
3
3
|
|
|
4
|
-
type
|
|
4
|
+
type ApiErrorBody = {
|
|
5
5
|
/**
|
|
6
|
-
*
|
|
6
|
+
* Stable, machine-readable code identifying the failure class. Integrators should switch on this rather than parsing the message. Codes are append-only — they are never removed or renamed.
|
|
7
7
|
*/
|
|
8
|
-
|
|
8
|
+
code: 'validation_error' | 'bad_request' | 'invalid_filter_value' | 'unauthorized' | 'forbidden' | 'ip_not_allowed' | 'not_found' | 'conflict' | 'idempotency_key_conflict' | 'rate_limited' | 'internal_error';
|
|
9
|
+
/**
|
|
10
|
+
* Human-readable description of the failure. Subject to wording tweaks — do not parse.
|
|
11
|
+
*/
|
|
12
|
+
message: string;
|
|
13
|
+
/**
|
|
14
|
+
* Correlator that matches the `X-Request-Id` response header. Quote this when filing a support ticket.
|
|
15
|
+
*/
|
|
16
|
+
request_id: string;
|
|
9
17
|
/**
|
|
10
|
-
*
|
|
18
|
+
* Deep-link into the public error documentation.
|
|
11
19
|
*/
|
|
12
|
-
|
|
20
|
+
docs_url?: string;
|
|
13
21
|
/**
|
|
14
|
-
*
|
|
22
|
+
* Name of the request parameter that triggered the failure, when the failure can be pinpointed to a single field. For nested-body failures see `details[].field` instead.
|
|
15
23
|
*/
|
|
16
|
-
|
|
24
|
+
param?: string;
|
|
17
25
|
/**
|
|
18
|
-
*
|
|
26
|
+
* Itemized list of per-field validation problems. Populated for `validation_error` responses; usually absent for other codes.
|
|
19
27
|
*/
|
|
20
|
-
|
|
28
|
+
details?: Array<ApiErrorDetail>;
|
|
21
29
|
};
|
|
22
|
-
type
|
|
30
|
+
type ApiErrorDetail = {
|
|
23
31
|
/**
|
|
24
|
-
*
|
|
32
|
+
* Dotted path to the offending property, when available.
|
|
25
33
|
*/
|
|
26
|
-
|
|
34
|
+
field?: string;
|
|
27
35
|
/**
|
|
28
|
-
*
|
|
36
|
+
* Machine-readable code for the validation failure (e.g. the class-validator constraint name like `isUuid`, `isNotEmpty`).
|
|
29
37
|
*/
|
|
30
|
-
|
|
38
|
+
code?: string;
|
|
31
39
|
/**
|
|
32
|
-
*
|
|
40
|
+
* Human-readable explanation of the problem.
|
|
33
41
|
*/
|
|
34
|
-
|
|
42
|
+
message: string;
|
|
43
|
+
};
|
|
44
|
+
type ApiErrorResponse = {
|
|
45
|
+
error: ApiErrorBody;
|
|
46
|
+
};
|
|
47
|
+
type AssetClassListResponseDto = {
|
|
35
48
|
/**
|
|
36
|
-
*
|
|
49
|
+
* List of asset classes
|
|
37
50
|
*/
|
|
38
|
-
|
|
51
|
+
data: Array<AssetClassResponseDto>;
|
|
39
52
|
/**
|
|
40
|
-
*
|
|
53
|
+
* Total number of records
|
|
41
54
|
*/
|
|
42
|
-
|
|
55
|
+
total: number;
|
|
43
56
|
/**
|
|
44
|
-
*
|
|
57
|
+
* Current page number
|
|
45
58
|
*/
|
|
46
|
-
|
|
59
|
+
page: number;
|
|
47
60
|
/**
|
|
48
|
-
*
|
|
61
|
+
* Items per page
|
|
49
62
|
*/
|
|
50
|
-
|
|
63
|
+
per_page: number;
|
|
51
64
|
/**
|
|
52
|
-
*
|
|
65
|
+
* Total number of pages
|
|
53
66
|
*/
|
|
54
|
-
|
|
67
|
+
total_pages: number;
|
|
55
68
|
};
|
|
56
|
-
type
|
|
69
|
+
type AssetClassPropertyResponseDto = {
|
|
57
70
|
/**
|
|
58
|
-
*
|
|
71
|
+
* Asset class property value-row ID
|
|
59
72
|
*/
|
|
60
73
|
id: string;
|
|
61
74
|
/**
|
|
62
|
-
*
|
|
75
|
+
* Asset class ID
|
|
63
76
|
*/
|
|
64
|
-
|
|
77
|
+
asset_class_id: string;
|
|
65
78
|
/**
|
|
66
|
-
*
|
|
79
|
+
* Field-definition ID (config_items.id)
|
|
80
|
+
*/
|
|
81
|
+
property_id: string;
|
|
82
|
+
/**
|
|
83
|
+
* Text value
|
|
67
84
|
*/
|
|
68
|
-
|
|
85
|
+
text_value: {
|
|
86
|
+
[key: string]: unknown;
|
|
87
|
+
} | null;
|
|
69
88
|
/**
|
|
70
|
-
*
|
|
89
|
+
* Numeric value
|
|
71
90
|
*/
|
|
72
|
-
|
|
91
|
+
numeric_value: {
|
|
92
|
+
[key: string]: unknown;
|
|
93
|
+
} | null;
|
|
73
94
|
/**
|
|
74
|
-
*
|
|
95
|
+
* Date value
|
|
75
96
|
*/
|
|
76
|
-
|
|
97
|
+
date_value: {
|
|
98
|
+
[key: string]: unknown;
|
|
99
|
+
} | null;
|
|
77
100
|
/**
|
|
78
|
-
*
|
|
101
|
+
* How the value was last set
|
|
79
102
|
*/
|
|
80
|
-
|
|
103
|
+
update_method: {
|
|
104
|
+
[key: string]: unknown;
|
|
105
|
+
} | null;
|
|
106
|
+
created_at: string;
|
|
107
|
+
updated_at: string;
|
|
108
|
+
};
|
|
109
|
+
type AssetClassResponseDto = {
|
|
81
110
|
/**
|
|
82
|
-
*
|
|
111
|
+
* Asset class public ID (UUID)
|
|
83
112
|
*/
|
|
84
|
-
|
|
113
|
+
public_id: string;
|
|
85
114
|
/**
|
|
86
|
-
*
|
|
115
|
+
* Asset class name (make)
|
|
87
116
|
*/
|
|
88
|
-
|
|
117
|
+
asset_class: string;
|
|
89
118
|
/**
|
|
90
|
-
*
|
|
119
|
+
* Asset sub-class name (model)
|
|
91
120
|
*/
|
|
92
|
-
|
|
121
|
+
asset_sub_class?: {
|
|
122
|
+
[key: string]: unknown;
|
|
123
|
+
};
|
|
93
124
|
/**
|
|
94
|
-
*
|
|
125
|
+
* Asset category ID. Serialized as a string in public API responses (BigInt-safe).
|
|
95
126
|
*/
|
|
96
|
-
|
|
127
|
+
asset_category_id?: string | null;
|
|
97
128
|
/**
|
|
98
|
-
*
|
|
129
|
+
* Asset category name
|
|
99
130
|
*/
|
|
100
|
-
|
|
131
|
+
asset_category_name?: {
|
|
101
132
|
[key: string]: unknown;
|
|
102
|
-
}
|
|
133
|
+
};
|
|
103
134
|
/**
|
|
104
|
-
*
|
|
135
|
+
* Asset class photo file path (S3 key)
|
|
105
136
|
*/
|
|
106
|
-
|
|
137
|
+
asset_class_photo_file?: {
|
|
138
|
+
[key: string]: unknown;
|
|
139
|
+
};
|
|
107
140
|
/**
|
|
108
|
-
*
|
|
141
|
+
* Signed CloudFront URL for the asset class photo (≈1h lifetime), or null if no photo / signing not configured.
|
|
109
142
|
*/
|
|
110
|
-
|
|
143
|
+
asset_class_photo_url?: {
|
|
144
|
+
[key: string]: unknown;
|
|
145
|
+
};
|
|
111
146
|
/**
|
|
112
|
-
*
|
|
147
|
+
* Asset class photo info
|
|
113
148
|
*/
|
|
114
|
-
|
|
149
|
+
asset_class_photo_info?: {
|
|
150
|
+
[key: string]: unknown;
|
|
151
|
+
};
|
|
115
152
|
/**
|
|
116
|
-
*
|
|
153
|
+
* Whether on-the-fly creation is enabled
|
|
117
154
|
*/
|
|
118
|
-
|
|
155
|
+
on_the_fly_enabled: boolean;
|
|
119
156
|
/**
|
|
120
|
-
*
|
|
157
|
+
* Creation timestamp
|
|
121
158
|
*/
|
|
122
|
-
|
|
159
|
+
created_at: string;
|
|
123
160
|
/**
|
|
124
|
-
*
|
|
161
|
+
* Created by user public ID
|
|
125
162
|
*/
|
|
126
|
-
|
|
163
|
+
created_by_id: string;
|
|
127
164
|
/**
|
|
128
|
-
*
|
|
165
|
+
* Created by user name
|
|
129
166
|
*/
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
167
|
+
created_by_name?: {
|
|
168
|
+
[key: string]: unknown;
|
|
169
|
+
};
|
|
133
170
|
/**
|
|
134
|
-
*
|
|
171
|
+
* Last update timestamp
|
|
135
172
|
*/
|
|
136
|
-
|
|
173
|
+
updated_at: string;
|
|
137
174
|
/**
|
|
138
|
-
*
|
|
175
|
+
* Updated by user public ID
|
|
139
176
|
*/
|
|
140
|
-
|
|
177
|
+
updated_by_id: string;
|
|
141
178
|
/**
|
|
142
|
-
*
|
|
179
|
+
* Updated by user name
|
|
143
180
|
*/
|
|
144
|
-
|
|
181
|
+
updated_by_name?: {
|
|
182
|
+
[key: string]: unknown;
|
|
183
|
+
};
|
|
145
184
|
/**
|
|
146
|
-
*
|
|
185
|
+
* Embedded custom property values for this asset class. Uniform shape across entities (property_id = field definition, asset_class_property_id = value row). Empty when the class has no custom properties.
|
|
147
186
|
*/
|
|
148
|
-
|
|
187
|
+
asset_class_properties: Array<EmbeddedAssetClassPropertyDto>;
|
|
149
188
|
};
|
|
150
|
-
type
|
|
189
|
+
type AssetPropertyResponseDto = {
|
|
151
190
|
/**
|
|
152
|
-
*
|
|
191
|
+
* Asset property ID. Serialized as a string in public API responses (BigInt-safe).
|
|
153
192
|
*/
|
|
154
|
-
|
|
193
|
+
id: string;
|
|
155
194
|
/**
|
|
156
|
-
*
|
|
195
|
+
* Asset ID. Serialized as a string in public API responses (BigInt-safe).
|
|
157
196
|
*/
|
|
158
|
-
|
|
197
|
+
asset_id: string;
|
|
159
198
|
/**
|
|
160
|
-
*
|
|
199
|
+
* Property ID (config item ID). Serialized as a string in public API responses (BigInt-safe).
|
|
161
200
|
*/
|
|
162
|
-
|
|
163
|
-
};
|
|
164
|
-
type TokenCompanyDto = {
|
|
201
|
+
property_id: string;
|
|
165
202
|
/**
|
|
166
|
-
*
|
|
203
|
+
* Text value (if property type is Text, Email, or Phone)
|
|
167
204
|
*/
|
|
168
|
-
|
|
205
|
+
text_value: {
|
|
206
|
+
[key: string]: unknown;
|
|
207
|
+
} | null;
|
|
169
208
|
/**
|
|
170
|
-
*
|
|
209
|
+
* Numeric value (if property type is Decimal)
|
|
171
210
|
*/
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
211
|
+
numeric_value: {
|
|
212
|
+
[key: string]: unknown;
|
|
213
|
+
} | null;
|
|
175
214
|
/**
|
|
176
|
-
*
|
|
215
|
+
* Date value (if property type is Date)
|
|
177
216
|
*/
|
|
178
|
-
|
|
217
|
+
date_value: {
|
|
218
|
+
[key: string]: unknown;
|
|
219
|
+
} | null;
|
|
179
220
|
/**
|
|
180
|
-
*
|
|
221
|
+
* Update method
|
|
181
222
|
*/
|
|
182
|
-
|
|
223
|
+
update_method: {
|
|
183
224
|
[key: string]: unknown;
|
|
184
225
|
} | null;
|
|
185
226
|
/**
|
|
186
|
-
*
|
|
227
|
+
* Created timestamp
|
|
187
228
|
*/
|
|
188
|
-
|
|
229
|
+
created_at: string;
|
|
189
230
|
/**
|
|
190
|
-
*
|
|
231
|
+
* Updated timestamp
|
|
191
232
|
*/
|
|
192
|
-
|
|
233
|
+
updated_at: string;
|
|
193
234
|
};
|
|
194
|
-
type
|
|
235
|
+
type ChecklistSummaryDto = {
|
|
195
236
|
/**
|
|
196
|
-
*
|
|
237
|
+
* Checklist ID (numeric string)
|
|
197
238
|
*/
|
|
198
|
-
|
|
239
|
+
id: string;
|
|
199
240
|
/**
|
|
200
|
-
*
|
|
241
|
+
* Company ID
|
|
201
242
|
*/
|
|
202
|
-
|
|
243
|
+
company_id: string;
|
|
203
244
|
/**
|
|
204
|
-
*
|
|
245
|
+
* Checklist name
|
|
205
246
|
*/
|
|
206
|
-
|
|
247
|
+
name: string;
|
|
207
248
|
/**
|
|
208
|
-
*
|
|
249
|
+
* Checklist type
|
|
209
250
|
*/
|
|
210
|
-
|
|
211
|
-
[key: string]: unknown;
|
|
212
|
-
} | null;
|
|
251
|
+
type: string;
|
|
213
252
|
/**
|
|
214
|
-
*
|
|
253
|
+
* Root checklist ID grouping all versions (null for a v1 with no prior versions). Numeric string.
|
|
215
254
|
*/
|
|
216
|
-
|
|
255
|
+
root_id: {
|
|
217
256
|
[key: string]: unknown;
|
|
218
257
|
} | null;
|
|
219
258
|
/**
|
|
220
|
-
*
|
|
259
|
+
* Version number
|
|
221
260
|
*/
|
|
222
|
-
|
|
261
|
+
version: number;
|
|
262
|
+
/**
|
|
263
|
+
* Version notes
|
|
264
|
+
*/
|
|
265
|
+
version_notes: {
|
|
223
266
|
[key: string]: unknown;
|
|
224
267
|
} | null;
|
|
225
268
|
/**
|
|
226
|
-
*
|
|
269
|
+
* Category ID
|
|
227
270
|
*/
|
|
228
|
-
|
|
271
|
+
category_id: {
|
|
272
|
+
[key: string]: unknown;
|
|
273
|
+
} | null;
|
|
229
274
|
/**
|
|
230
|
-
*
|
|
275
|
+
* Category name
|
|
231
276
|
*/
|
|
232
|
-
|
|
277
|
+
category_name: {
|
|
233
278
|
[key: string]: unknown;
|
|
234
279
|
} | null;
|
|
235
280
|
/**
|
|
236
|
-
*
|
|
281
|
+
* When this version was published
|
|
237
282
|
*/
|
|
238
|
-
|
|
283
|
+
published_at: {
|
|
239
284
|
[key: string]: unknown;
|
|
240
285
|
} | null;
|
|
286
|
+
created_at: string;
|
|
287
|
+
updated_at: string;
|
|
241
288
|
};
|
|
242
|
-
type
|
|
289
|
+
type ConfigItemDto = {
|
|
243
290
|
/**
|
|
244
|
-
*
|
|
291
|
+
* Config item ID (numeric string)
|
|
245
292
|
*/
|
|
246
|
-
|
|
293
|
+
id: string;
|
|
247
294
|
/**
|
|
248
|
-
*
|
|
295
|
+
* Parent config table ID
|
|
249
296
|
*/
|
|
250
|
-
|
|
297
|
+
config_table_id: string;
|
|
251
298
|
/**
|
|
252
|
-
*
|
|
299
|
+
* Parent config table name
|
|
253
300
|
*/
|
|
254
|
-
|
|
301
|
+
config_table_name: string;
|
|
255
302
|
/**
|
|
256
|
-
*
|
|
303
|
+
* Parent config table class
|
|
257
304
|
*/
|
|
258
|
-
|
|
259
|
-
};
|
|
260
|
-
type PublicCreateAssetDto = {
|
|
305
|
+
config_table_class: string;
|
|
261
306
|
/**
|
|
262
|
-
*
|
|
307
|
+
* Item value / name
|
|
263
308
|
*/
|
|
264
|
-
|
|
309
|
+
item: string;
|
|
265
310
|
/**
|
|
266
|
-
*
|
|
311
|
+
* Description
|
|
267
312
|
*/
|
|
268
|
-
|
|
313
|
+
description: {
|
|
314
|
+
[key: string]: unknown;
|
|
315
|
+
} | null;
|
|
269
316
|
/**
|
|
270
|
-
*
|
|
317
|
+
* Free-form options (JSON), e.g. property metadata
|
|
271
318
|
*/
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
|
|
319
|
+
options: {
|
|
320
|
+
[key: string]: unknown;
|
|
321
|
+
} | null;
|
|
275
322
|
/**
|
|
276
|
-
*
|
|
323
|
+
* Image file key
|
|
277
324
|
*/
|
|
278
|
-
|
|
325
|
+
image_file: {
|
|
326
|
+
[key: string]: unknown;
|
|
327
|
+
} | null;
|
|
328
|
+
created_at: string;
|
|
329
|
+
updated_at: string;
|
|
330
|
+
};
|
|
331
|
+
type ConfigTableDto = {
|
|
279
332
|
/**
|
|
280
|
-
*
|
|
333
|
+
* Config table ID (numeric string)
|
|
281
334
|
*/
|
|
282
|
-
|
|
335
|
+
id: string;
|
|
283
336
|
/**
|
|
284
|
-
*
|
|
337
|
+
* Display name
|
|
285
338
|
*/
|
|
286
|
-
|
|
287
|
-
};
|
|
288
|
-
type ApiErrorBody = {
|
|
339
|
+
name: string;
|
|
289
340
|
/**
|
|
290
|
-
* Stable
|
|
341
|
+
* Stable class/key identifying the table purpose
|
|
291
342
|
*/
|
|
292
|
-
|
|
343
|
+
class: string;
|
|
293
344
|
/**
|
|
294
|
-
*
|
|
345
|
+
* Whether items in this table are content-translated
|
|
295
346
|
*/
|
|
296
|
-
|
|
347
|
+
translate_content: boolean;
|
|
348
|
+
created_at: string;
|
|
349
|
+
updated_at: string;
|
|
350
|
+
};
|
|
351
|
+
type CreateAssetClassDto = {
|
|
297
352
|
/**
|
|
298
|
-
*
|
|
353
|
+
* Asset class name (make)
|
|
299
354
|
*/
|
|
300
|
-
|
|
355
|
+
asset_class: string;
|
|
301
356
|
/**
|
|
302
|
-
*
|
|
357
|
+
* Asset sub-class name (model)
|
|
303
358
|
*/
|
|
304
|
-
|
|
359
|
+
asset_sub_class?: string;
|
|
305
360
|
/**
|
|
306
|
-
*
|
|
361
|
+
* BigInt as string. Asset category ID (from config_items table)
|
|
307
362
|
*/
|
|
308
|
-
|
|
363
|
+
asset_category_id?: string;
|
|
309
364
|
/**
|
|
310
|
-
*
|
|
365
|
+
* Asset class photo file path
|
|
311
366
|
*/
|
|
312
|
-
|
|
367
|
+
asset_class_photo_file?: string;
|
|
368
|
+
/**
|
|
369
|
+
* Asset class photo info (JSON string)
|
|
370
|
+
*/
|
|
371
|
+
asset_class_photo_info?: string;
|
|
372
|
+
/**
|
|
373
|
+
* Whether on-the-fly creation is enabled
|
|
374
|
+
*/
|
|
375
|
+
on_the_fly_enabled?: boolean;
|
|
313
376
|
};
|
|
314
|
-
type
|
|
315
|
-
|
|
377
|
+
type CreateConfigItemDto = {
|
|
378
|
+
/**
|
|
379
|
+
* Parent config table ID (numeric string, from GET /public/config-table/list). Must belong to the authenticated company.
|
|
380
|
+
*/
|
|
381
|
+
config_table_id: string;
|
|
382
|
+
/**
|
|
383
|
+
* Item value / name
|
|
384
|
+
*/
|
|
385
|
+
item: string;
|
|
386
|
+
/**
|
|
387
|
+
* Description
|
|
388
|
+
*/
|
|
389
|
+
description?: string;
|
|
316
390
|
};
|
|
317
|
-
type
|
|
391
|
+
type CreateSiteDto = {
|
|
318
392
|
/**
|
|
319
|
-
*
|
|
393
|
+
* Site name
|
|
320
394
|
*/
|
|
321
|
-
|
|
395
|
+
name: string;
|
|
322
396
|
/**
|
|
323
|
-
*
|
|
397
|
+
* Base language for the site
|
|
324
398
|
*/
|
|
325
|
-
|
|
399
|
+
base_language?: string;
|
|
326
400
|
/**
|
|
327
|
-
* Site
|
|
401
|
+
* BigInt as string. Site category ID (config_items.id)
|
|
328
402
|
*/
|
|
329
|
-
|
|
403
|
+
category_id?: string;
|
|
330
404
|
/**
|
|
331
|
-
* Asset
|
|
405
|
+
* Asset selection method
|
|
332
406
|
*/
|
|
333
|
-
|
|
407
|
+
asset_selection_method?: string;
|
|
334
408
|
/**
|
|
335
|
-
* Asset
|
|
409
|
+
* Asset affix
|
|
336
410
|
*/
|
|
337
|
-
|
|
411
|
+
asset_affix?: string;
|
|
338
412
|
/**
|
|
339
|
-
*
|
|
413
|
+
* Asset affix position (prefix or suffix)
|
|
340
414
|
*/
|
|
341
|
-
|
|
415
|
+
asset_affix_position?: string;
|
|
342
416
|
/**
|
|
343
|
-
*
|
|
417
|
+
* Public ID (UUID) - if not provided, will be generated
|
|
344
418
|
*/
|
|
345
|
-
|
|
419
|
+
public_id?: string;
|
|
346
420
|
};
|
|
347
|
-
type
|
|
421
|
+
type DeleteAssetClassPropertyResponseDto = {
|
|
422
|
+
message: string;
|
|
348
423
|
/**
|
|
349
|
-
*
|
|
424
|
+
* Deleted asset class property ID
|
|
350
425
|
*/
|
|
351
|
-
|
|
426
|
+
id: string;
|
|
427
|
+
};
|
|
428
|
+
type DeleteAssetPropertyResponseDto = {
|
|
352
429
|
/**
|
|
353
|
-
*
|
|
430
|
+
* Success message
|
|
354
431
|
*/
|
|
355
|
-
|
|
432
|
+
message: string;
|
|
356
433
|
/**
|
|
357
|
-
*
|
|
434
|
+
* Deleted asset property ID. Serialized as a string in public API responses (BigInt-safe).
|
|
358
435
|
*/
|
|
359
|
-
|
|
360
|
-
|
|
361
|
-
|
|
436
|
+
id: string;
|
|
437
|
+
};
|
|
438
|
+
type DeleteSiteResponseDto = {
|
|
362
439
|
/**
|
|
363
|
-
*
|
|
440
|
+
* Success message
|
|
364
441
|
*/
|
|
365
|
-
|
|
366
|
-
[key: string]: unknown;
|
|
367
|
-
} | null;
|
|
442
|
+
message: string;
|
|
368
443
|
/**
|
|
369
|
-
*
|
|
444
|
+
* Deleted site public ID
|
|
370
445
|
*/
|
|
371
|
-
|
|
372
|
-
[key: string]: unknown;
|
|
373
|
-
} | null;
|
|
446
|
+
site_public_id: string;
|
|
374
447
|
};
|
|
375
|
-
type
|
|
448
|
+
type DeleteUserPropertyResponseDto = {
|
|
376
449
|
/**
|
|
377
|
-
*
|
|
450
|
+
* Success message
|
|
378
451
|
*/
|
|
379
|
-
|
|
452
|
+
message: string;
|
|
380
453
|
/**
|
|
381
|
-
*
|
|
454
|
+
* Deleted user property ID. Serialized as a string in public API responses (BigInt-safe).
|
|
382
455
|
*/
|
|
383
|
-
|
|
456
|
+
id: string;
|
|
457
|
+
};
|
|
458
|
+
type EmbeddedAssetClassPropertyDto = {
|
|
384
459
|
/**
|
|
385
|
-
*
|
|
460
|
+
* Custom field-definition ID (config_items.id). String (BigInt-safe).
|
|
386
461
|
*/
|
|
387
|
-
|
|
462
|
+
property_id: string;
|
|
388
463
|
/**
|
|
389
|
-
*
|
|
464
|
+
* The asset_class_properties value-row ID (for future round-trip into an asset-class-property update). String (BigInt-safe).
|
|
390
465
|
*/
|
|
391
|
-
|
|
392
|
-
[key: string]: unknown;
|
|
393
|
-
} | null;
|
|
466
|
+
asset_class_property_id: string;
|
|
394
467
|
/**
|
|
395
|
-
*
|
|
468
|
+
* Property name from config_items
|
|
396
469
|
*/
|
|
397
|
-
|
|
470
|
+
property_name: string;
|
|
471
|
+
/**
|
|
472
|
+
* Text value
|
|
473
|
+
*/
|
|
474
|
+
text_value: {
|
|
398
475
|
[key: string]: unknown;
|
|
399
476
|
} | null;
|
|
400
477
|
/**
|
|
401
|
-
*
|
|
478
|
+
* Numeric value
|
|
402
479
|
*/
|
|
403
|
-
|
|
480
|
+
numeric_value: {
|
|
404
481
|
[key: string]: unknown;
|
|
405
482
|
} | null;
|
|
406
483
|
/**
|
|
407
|
-
*
|
|
484
|
+
* Date value
|
|
408
485
|
*/
|
|
409
|
-
|
|
486
|
+
date_value: {
|
|
410
487
|
[key: string]: unknown;
|
|
411
488
|
} | null;
|
|
412
489
|
/**
|
|
413
|
-
*
|
|
490
|
+
* Timestamp the value was last updated
|
|
414
491
|
*/
|
|
415
|
-
|
|
492
|
+
updated_at: {
|
|
416
493
|
[key: string]: unknown;
|
|
417
494
|
} | null;
|
|
418
495
|
/**
|
|
419
|
-
*
|
|
496
|
+
* Public ID (UUID) of the user who last updated this value
|
|
420
497
|
*/
|
|
421
|
-
|
|
498
|
+
updated_by: {
|
|
422
499
|
[key: string]: unknown;
|
|
423
500
|
} | null;
|
|
424
501
|
/**
|
|
425
|
-
*
|
|
502
|
+
* Name of the user who last updated this value
|
|
426
503
|
*/
|
|
427
|
-
|
|
504
|
+
updated_by_name: {
|
|
428
505
|
[key: string]: unknown;
|
|
429
506
|
} | null;
|
|
507
|
+
};
|
|
508
|
+
type EmbeddedAssetPropertyDto = {
|
|
430
509
|
/**
|
|
431
|
-
*
|
|
510
|
+
* Custom field-definition ID (config_items.id — which field, e.g. "Voyage"). Serialized as a string in public API responses (BigInt-safe).
|
|
432
511
|
*/
|
|
433
|
-
|
|
512
|
+
property_id: string;
|
|
434
513
|
/**
|
|
435
|
-
*
|
|
514
|
+
* The asset_properties value-row ID. Pass this to PATCH/DELETE /asset-property/:id to update or remove the value. Serialized as a string in public API responses (BigInt-safe).
|
|
436
515
|
*/
|
|
437
|
-
|
|
438
|
-
[key: string]: unknown;
|
|
439
|
-
} | null;
|
|
516
|
+
asset_property_id: string;
|
|
440
517
|
/**
|
|
441
|
-
*
|
|
518
|
+
* Property name from config_items
|
|
442
519
|
*/
|
|
443
|
-
|
|
444
|
-
[key: string]: unknown;
|
|
445
|
-
} | null;
|
|
520
|
+
property_name: string;
|
|
446
521
|
/**
|
|
447
|
-
*
|
|
522
|
+
* Text value (if property type is text)
|
|
448
523
|
*/
|
|
449
|
-
|
|
524
|
+
text_value: {
|
|
525
|
+
[key: string]: unknown;
|
|
526
|
+
} | null;
|
|
450
527
|
/**
|
|
451
|
-
*
|
|
528
|
+
* Numeric value (if property type is numeric)
|
|
452
529
|
*/
|
|
453
|
-
|
|
530
|
+
numeric_value: {
|
|
454
531
|
[key: string]: unknown;
|
|
455
532
|
} | null;
|
|
456
533
|
/**
|
|
457
|
-
*
|
|
534
|
+
* Date value (if property type is date)
|
|
458
535
|
*/
|
|
459
|
-
|
|
536
|
+
date_value: {
|
|
460
537
|
[key: string]: unknown;
|
|
461
538
|
} | null;
|
|
462
539
|
/**
|
|
463
|
-
*
|
|
540
|
+
* Timestamp the property value was last updated
|
|
464
541
|
*/
|
|
465
|
-
|
|
542
|
+
updated_at: string;
|
|
466
543
|
/**
|
|
467
|
-
*
|
|
544
|
+
* Public ID (UUID) of the user who last updated this value
|
|
468
545
|
*/
|
|
469
|
-
|
|
470
|
-
|
|
471
|
-
|
|
546
|
+
updated_by: {
|
|
547
|
+
[key: string]: unknown;
|
|
548
|
+
} | null;
|
|
472
549
|
/**
|
|
473
|
-
*
|
|
550
|
+
* Name of the user who last updated this value
|
|
474
551
|
*/
|
|
475
|
-
|
|
552
|
+
updated_by_name: {
|
|
553
|
+
[key: string]: unknown;
|
|
554
|
+
} | null;
|
|
476
555
|
};
|
|
477
|
-
type
|
|
478
|
-
/**
|
|
479
|
-
* Temporary AWS Access Key ID
|
|
480
|
-
*/
|
|
481
|
-
accessKeyId: string;
|
|
482
|
-
/**
|
|
483
|
-
* Temporary AWS Secret Access Key
|
|
484
|
-
*/
|
|
485
|
-
secretAccessKey: string;
|
|
556
|
+
type EmbeddedUserPropertyDto = {
|
|
486
557
|
/**
|
|
487
|
-
*
|
|
558
|
+
* Property ID. Serialized as a string in public API responses (BigInt-safe).
|
|
488
559
|
*/
|
|
489
|
-
|
|
560
|
+
property_id: string;
|
|
490
561
|
/**
|
|
491
|
-
*
|
|
562
|
+
* Property name from config_items
|
|
492
563
|
*/
|
|
493
|
-
|
|
564
|
+
property_name: string;
|
|
494
565
|
/**
|
|
495
|
-
*
|
|
566
|
+
* Text value (if property type is text)
|
|
496
567
|
*/
|
|
497
|
-
|
|
568
|
+
text_value: {
|
|
569
|
+
[key: string]: unknown;
|
|
570
|
+
} | null;
|
|
498
571
|
/**
|
|
499
|
-
*
|
|
572
|
+
* Numeric value (if property type is numeric)
|
|
500
573
|
*/
|
|
501
|
-
|
|
574
|
+
numeric_value: {
|
|
575
|
+
[key: string]: unknown;
|
|
576
|
+
} | null;
|
|
502
577
|
/**
|
|
503
|
-
*
|
|
578
|
+
* Date value (if property type is date)
|
|
504
579
|
*/
|
|
505
|
-
|
|
580
|
+
date_value: {
|
|
581
|
+
[key: string]: unknown;
|
|
582
|
+
} | null;
|
|
506
583
|
};
|
|
507
|
-
type
|
|
584
|
+
type InspectionResponseDto = {
|
|
508
585
|
/**
|
|
509
|
-
*
|
|
586
|
+
* Inspection public ID (UUID)
|
|
510
587
|
*/
|
|
511
|
-
|
|
588
|
+
inspection_public_id: string;
|
|
512
589
|
/**
|
|
513
|
-
*
|
|
590
|
+
* Inspection type
|
|
514
591
|
*/
|
|
515
|
-
|
|
516
|
-
};
|
|
517
|
-
type RequestLogUploadDto = {
|
|
592
|
+
inspection_type: string;
|
|
518
593
|
/**
|
|
519
|
-
*
|
|
594
|
+
* Inspection status
|
|
520
595
|
*/
|
|
521
|
-
|
|
596
|
+
inspection_status: string;
|
|
522
597
|
/**
|
|
523
|
-
*
|
|
598
|
+
* Site public ID (UUID)
|
|
524
599
|
*/
|
|
525
|
-
|
|
600
|
+
inspection_site_id?: {
|
|
601
|
+
[key: string]: unknown;
|
|
602
|
+
};
|
|
526
603
|
/**
|
|
527
|
-
*
|
|
604
|
+
* Site name
|
|
528
605
|
*/
|
|
529
|
-
|
|
530
|
-
|
|
531
|
-
|
|
606
|
+
inspection_site_name?: {
|
|
607
|
+
[key: string]: unknown;
|
|
608
|
+
};
|
|
532
609
|
/**
|
|
533
|
-
*
|
|
610
|
+
* Asset public ID (UUID)
|
|
534
611
|
*/
|
|
535
|
-
|
|
612
|
+
inspection_asset_id?: {
|
|
613
|
+
[key: string]: unknown;
|
|
614
|
+
};
|
|
536
615
|
/**
|
|
537
|
-
*
|
|
616
|
+
* Asset number
|
|
538
617
|
*/
|
|
539
|
-
|
|
540
|
-
|
|
541
|
-
|
|
618
|
+
inspection_asset_number?: {
|
|
619
|
+
[key: string]: unknown;
|
|
620
|
+
};
|
|
542
621
|
/**
|
|
543
|
-
*
|
|
622
|
+
* Checklist public ID (UUID)
|
|
544
623
|
*/
|
|
545
|
-
|
|
624
|
+
inspection_checklist_id?: {
|
|
625
|
+
[key: string]: unknown;
|
|
626
|
+
};
|
|
546
627
|
/**
|
|
547
|
-
*
|
|
628
|
+
* Checklist name
|
|
548
629
|
*/
|
|
549
|
-
|
|
550
|
-
|
|
551
|
-
|
|
552
|
-
*/
|
|
553
|
-
cloudFrontPolicy?: string;
|
|
630
|
+
inspection_checklist_name?: {
|
|
631
|
+
[key: string]: unknown;
|
|
632
|
+
};
|
|
554
633
|
/**
|
|
555
|
-
*
|
|
634
|
+
* Checklist category public ID (UUID)
|
|
556
635
|
*/
|
|
557
|
-
|
|
636
|
+
inspection_checklist_category_id?: {
|
|
637
|
+
[key: string]: unknown;
|
|
638
|
+
};
|
|
558
639
|
/**
|
|
559
|
-
*
|
|
640
|
+
* Checklist category name
|
|
560
641
|
*/
|
|
561
|
-
|
|
642
|
+
inspection_checklist_category?: {
|
|
643
|
+
[key: string]: unknown;
|
|
644
|
+
};
|
|
562
645
|
/**
|
|
563
|
-
*
|
|
646
|
+
* Submitted user public ID (UUID)
|
|
564
647
|
*/
|
|
565
|
-
|
|
648
|
+
inspection_submitted_user_id?: {
|
|
649
|
+
[key: string]: unknown;
|
|
650
|
+
};
|
|
566
651
|
/**
|
|
567
|
-
*
|
|
652
|
+
* Submitted user full name
|
|
568
653
|
*/
|
|
569
|
-
|
|
570
|
-
|
|
571
|
-
|
|
654
|
+
inspection_submitted_user_name?: {
|
|
655
|
+
[key: string]: unknown;
|
|
656
|
+
};
|
|
572
657
|
/**
|
|
573
|
-
*
|
|
658
|
+
* Subject user public ID (UUID)
|
|
574
659
|
*/
|
|
575
|
-
|
|
660
|
+
inspection_subject_user_id?: {
|
|
661
|
+
[key: string]: unknown;
|
|
662
|
+
};
|
|
576
663
|
/**
|
|
577
|
-
*
|
|
664
|
+
* Subject user full name
|
|
578
665
|
*/
|
|
579
|
-
|
|
666
|
+
inspection_subject_user_name?: {
|
|
667
|
+
[key: string]: unknown;
|
|
668
|
+
};
|
|
580
669
|
/**
|
|
581
|
-
*
|
|
670
|
+
* Target project ID. Serialized as a string in public API responses (BigInt-safe).
|
|
582
671
|
*/
|
|
583
|
-
|
|
672
|
+
inspection_target_project_id?: string | null;
|
|
584
673
|
/**
|
|
585
|
-
*
|
|
674
|
+
* Device public ID (UUID)
|
|
586
675
|
*/
|
|
587
|
-
|
|
676
|
+
inspection_device_id?: {
|
|
677
|
+
[key: string]: unknown;
|
|
678
|
+
};
|
|
588
679
|
/**
|
|
589
|
-
*
|
|
680
|
+
* Device name
|
|
590
681
|
*/
|
|
591
|
-
|
|
682
|
+
inspection_device_name?: {
|
|
683
|
+
[key: string]: unknown;
|
|
684
|
+
};
|
|
592
685
|
/**
|
|
593
|
-
*
|
|
686
|
+
* Inspection score
|
|
594
687
|
*/
|
|
595
|
-
|
|
688
|
+
inspection_score?: {
|
|
689
|
+
[key: string]: unknown;
|
|
690
|
+
};
|
|
596
691
|
/**
|
|
597
|
-
*
|
|
692
|
+
* Inspection duration in seconds
|
|
598
693
|
*/
|
|
599
|
-
|
|
694
|
+
inspection_duration?: {
|
|
695
|
+
[key: string]: unknown;
|
|
696
|
+
};
|
|
600
697
|
/**
|
|
601
|
-
*
|
|
698
|
+
* Completion percentage
|
|
602
699
|
*/
|
|
603
|
-
|
|
700
|
+
inspection_completion_percentage?: {
|
|
701
|
+
[key: string]: unknown;
|
|
702
|
+
};
|
|
604
703
|
/**
|
|
605
|
-
*
|
|
704
|
+
* Started at timestamp
|
|
606
705
|
*/
|
|
607
|
-
|
|
706
|
+
inspection_started_at?: {
|
|
707
|
+
[key: string]: unknown;
|
|
708
|
+
};
|
|
608
709
|
/**
|
|
609
|
-
*
|
|
710
|
+
* Ended at timestamp
|
|
610
711
|
*/
|
|
611
|
-
|
|
712
|
+
inspection_ended_at?: {
|
|
713
|
+
[key: string]: unknown;
|
|
714
|
+
};
|
|
612
715
|
/**
|
|
613
|
-
*
|
|
716
|
+
* Submitted at timestamp
|
|
614
717
|
*/
|
|
615
|
-
|
|
718
|
+
inspection_submitted_at?: {
|
|
719
|
+
[key: string]: unknown;
|
|
720
|
+
};
|
|
616
721
|
/**
|
|
617
|
-
*
|
|
722
|
+
* Created at timestamp (date received)
|
|
618
723
|
*/
|
|
619
|
-
|
|
724
|
+
inspection_created_at: string;
|
|
620
725
|
/**
|
|
621
|
-
*
|
|
726
|
+
* Created by user public ID (UUID)
|
|
622
727
|
*/
|
|
623
|
-
|
|
728
|
+
inspection_created_by_id?: {
|
|
729
|
+
[key: string]: unknown;
|
|
730
|
+
};
|
|
624
731
|
/**
|
|
625
|
-
*
|
|
732
|
+
* Created by user full name
|
|
626
733
|
*/
|
|
627
|
-
|
|
734
|
+
inspection_created_by_name?: {
|
|
735
|
+
[key: string]: unknown;
|
|
736
|
+
};
|
|
628
737
|
/**
|
|
629
|
-
*
|
|
738
|
+
* Updated at timestamp
|
|
630
739
|
*/
|
|
631
|
-
|
|
740
|
+
inspection_updated_at: string;
|
|
632
741
|
/**
|
|
633
|
-
*
|
|
742
|
+
* Updated by user public ID (UUID)
|
|
634
743
|
*/
|
|
635
|
-
|
|
636
|
-
|
|
637
|
-
|
|
744
|
+
inspection_updated_by_id?: {
|
|
745
|
+
[key: string]: unknown;
|
|
746
|
+
};
|
|
638
747
|
/**
|
|
639
|
-
*
|
|
748
|
+
* Updated by user full name
|
|
640
749
|
*/
|
|
641
|
-
|
|
750
|
+
inspection_updated_by_name?: {
|
|
751
|
+
[key: string]: unknown;
|
|
752
|
+
};
|
|
753
|
+
};
|
|
754
|
+
type IssueHistoryDto = {
|
|
642
755
|
/**
|
|
643
|
-
*
|
|
756
|
+
* BigInt as string. Issue history entry ID
|
|
644
757
|
*/
|
|
645
|
-
|
|
646
|
-
};
|
|
647
|
-
type ResumeInspectionDto = {
|
|
758
|
+
id: string;
|
|
648
759
|
/**
|
|
649
|
-
*
|
|
760
|
+
* BigInt as string. Issue ID this history entry belongs to
|
|
650
761
|
*/
|
|
651
|
-
|
|
652
|
-
};
|
|
653
|
-
type UpdateInspectionDto = {
|
|
762
|
+
issue_id: string;
|
|
654
763
|
/**
|
|
655
|
-
*
|
|
764
|
+
* Issue title at the time of change
|
|
656
765
|
*/
|
|
657
|
-
|
|
766
|
+
title?: {
|
|
767
|
+
[key: string]: unknown;
|
|
768
|
+
};
|
|
658
769
|
/**
|
|
659
|
-
*
|
|
770
|
+
* Assigned user ID at the time of change
|
|
660
771
|
*/
|
|
661
|
-
|
|
772
|
+
assigned_user_id?: {
|
|
773
|
+
[key: string]: unknown;
|
|
774
|
+
};
|
|
662
775
|
/**
|
|
663
|
-
*
|
|
776
|
+
* Assigned group ID at the time of change
|
|
664
777
|
*/
|
|
665
|
-
|
|
778
|
+
assigned_group_id?: {
|
|
779
|
+
[key: string]: unknown;
|
|
780
|
+
};
|
|
666
781
|
/**
|
|
667
|
-
*
|
|
782
|
+
* Status at the time of change
|
|
668
783
|
*/
|
|
669
|
-
|
|
784
|
+
status?: {
|
|
785
|
+
[key: string]: unknown;
|
|
786
|
+
};
|
|
670
787
|
/**
|
|
671
|
-
*
|
|
788
|
+
* Primary action ID at the time of change
|
|
672
789
|
*/
|
|
673
|
-
|
|
790
|
+
primary_action_id?: {
|
|
791
|
+
[key: string]: unknown;
|
|
792
|
+
};
|
|
674
793
|
/**
|
|
675
|
-
*
|
|
794
|
+
* Resolution ID at the time of change
|
|
676
795
|
*/
|
|
677
|
-
|
|
796
|
+
resolution_id?: {
|
|
797
|
+
[key: string]: unknown;
|
|
798
|
+
};
|
|
678
799
|
/**
|
|
679
|
-
*
|
|
800
|
+
* Reference text at the time of change
|
|
680
801
|
*/
|
|
681
|
-
|
|
802
|
+
reference?: {
|
|
803
|
+
[key: string]: unknown;
|
|
804
|
+
};
|
|
682
805
|
/**
|
|
683
|
-
*
|
|
806
|
+
* Target completion date at the time of change
|
|
684
807
|
*/
|
|
685
|
-
|
|
808
|
+
target_completion_on?: {
|
|
809
|
+
[key: string]: unknown;
|
|
810
|
+
};
|
|
686
811
|
/**
|
|
687
|
-
*
|
|
812
|
+
* Note about the change
|
|
688
813
|
*/
|
|
689
|
-
|
|
814
|
+
note?: {
|
|
815
|
+
[key: string]: unknown;
|
|
816
|
+
};
|
|
690
817
|
/**
|
|
691
|
-
*
|
|
818
|
+
* Effort spent in minutes
|
|
692
819
|
*/
|
|
693
|
-
|
|
820
|
+
effort_spent?: {
|
|
821
|
+
[key: string]: unknown;
|
|
822
|
+
};
|
|
694
823
|
/**
|
|
695
|
-
*
|
|
824
|
+
* Cost incurred
|
|
696
825
|
*/
|
|
697
|
-
|
|
826
|
+
cost_incurred?: {
|
|
827
|
+
[key: string]: unknown;
|
|
828
|
+
};
|
|
698
829
|
/**
|
|
699
|
-
*
|
|
830
|
+
* Chargeable cost
|
|
700
831
|
*/
|
|
701
|
-
|
|
832
|
+
chargeable_cost?: {
|
|
833
|
+
[key: string]: unknown;
|
|
834
|
+
};
|
|
702
835
|
/**
|
|
703
|
-
*
|
|
836
|
+
* Type of change that occurred
|
|
704
837
|
*/
|
|
705
|
-
|
|
838
|
+
change_type: string;
|
|
706
839
|
/**
|
|
707
|
-
*
|
|
840
|
+
* Timestamp when the change occurred
|
|
708
841
|
*/
|
|
709
|
-
|
|
710
|
-
};
|
|
711
|
-
type DeleteInspectionDto = {
|
|
842
|
+
changed_at: string;
|
|
712
843
|
/**
|
|
713
|
-
* User
|
|
844
|
+
* BigInt as string. User ID who made the change
|
|
714
845
|
*/
|
|
715
|
-
|
|
846
|
+
changed_by_id: string;
|
|
716
847
|
};
|
|
717
|
-
type
|
|
848
|
+
type IssueHistoryResponseDto = {
|
|
718
849
|
/**
|
|
719
|
-
*
|
|
850
|
+
* Issue public ID
|
|
720
851
|
*/
|
|
721
|
-
|
|
852
|
+
issue_public_id: string;
|
|
722
853
|
/**
|
|
723
|
-
*
|
|
854
|
+
* BigInt as string. Issue internal ID
|
|
724
855
|
*/
|
|
725
|
-
|
|
856
|
+
issue_id: string;
|
|
726
857
|
/**
|
|
727
|
-
*
|
|
858
|
+
* Array of issue history entries
|
|
728
859
|
*/
|
|
729
|
-
|
|
860
|
+
history: Array<IssueHistoryDto>;
|
|
861
|
+
};
|
|
862
|
+
type IssueResponseDto = {
|
|
730
863
|
/**
|
|
731
|
-
*
|
|
864
|
+
* Issue public ID (UUID)
|
|
732
865
|
*/
|
|
733
|
-
|
|
866
|
+
issue_public_id: string;
|
|
734
867
|
/**
|
|
735
|
-
*
|
|
868
|
+
* Issue number
|
|
736
869
|
*/
|
|
737
|
-
|
|
870
|
+
issue_number: string;
|
|
738
871
|
/**
|
|
739
|
-
*
|
|
872
|
+
* Asset internal ID
|
|
740
873
|
*/
|
|
741
|
-
|
|
874
|
+
issue_asset_id?: {
|
|
742
875
|
[key: string]: unknown;
|
|
743
876
|
};
|
|
744
877
|
/**
|
|
745
|
-
*
|
|
878
|
+
* Asset number
|
|
746
879
|
*/
|
|
747
|
-
|
|
880
|
+
issue_asset_number?: {
|
|
881
|
+
[key: string]: unknown;
|
|
882
|
+
};
|
|
748
883
|
/**
|
|
749
|
-
*
|
|
884
|
+
* Asset class name
|
|
750
885
|
*/
|
|
751
|
-
|
|
886
|
+
issue_asset_class?: {
|
|
887
|
+
[key: string]: unknown;
|
|
888
|
+
};
|
|
752
889
|
/**
|
|
753
|
-
*
|
|
890
|
+
* Asset sub-class name
|
|
754
891
|
*/
|
|
755
|
-
|
|
756
|
-
|
|
757
|
-
|
|
892
|
+
issue_asset_sub_class?: {
|
|
893
|
+
[key: string]: unknown;
|
|
894
|
+
};
|
|
758
895
|
/**
|
|
759
|
-
*
|
|
896
|
+
* Asset category name
|
|
760
897
|
*/
|
|
761
|
-
|
|
898
|
+
issue_asset_category?: {
|
|
899
|
+
[key: string]: unknown;
|
|
900
|
+
};
|
|
762
901
|
/**
|
|
763
|
-
*
|
|
902
|
+
* Inspection name
|
|
764
903
|
*/
|
|
765
|
-
|
|
904
|
+
issue_inspection_name?: {
|
|
905
|
+
[key: string]: unknown;
|
|
906
|
+
};
|
|
766
907
|
/**
|
|
767
|
-
*
|
|
908
|
+
* Checklist category
|
|
768
909
|
*/
|
|
769
|
-
|
|
910
|
+
issue_inspection_category?: {
|
|
911
|
+
[key: string]: unknown;
|
|
912
|
+
};
|
|
770
913
|
/**
|
|
771
|
-
*
|
|
914
|
+
* Question title
|
|
772
915
|
*/
|
|
773
|
-
|
|
916
|
+
issues_question_title?: {
|
|
917
|
+
[key: string]: unknown;
|
|
918
|
+
};
|
|
774
919
|
/**
|
|
775
|
-
*
|
|
920
|
+
* Issue title
|
|
776
921
|
*/
|
|
777
|
-
|
|
922
|
+
issue_title: string;
|
|
778
923
|
/**
|
|
779
|
-
*
|
|
924
|
+
* Assignee user ID
|
|
780
925
|
*/
|
|
781
|
-
|
|
926
|
+
issue_assignee_id?: {
|
|
927
|
+
[key: string]: unknown;
|
|
928
|
+
};
|
|
782
929
|
/**
|
|
783
|
-
*
|
|
930
|
+
* Assignee full name
|
|
784
931
|
*/
|
|
785
|
-
|
|
932
|
+
issue_assignee?: {
|
|
933
|
+
[key: string]: unknown;
|
|
934
|
+
};
|
|
786
935
|
/**
|
|
787
|
-
*
|
|
936
|
+
* Assigned group ID
|
|
788
937
|
*/
|
|
789
|
-
|
|
938
|
+
issue_assigned_group_id?: {
|
|
939
|
+
[key: string]: unknown;
|
|
940
|
+
};
|
|
790
941
|
/**
|
|
791
|
-
*
|
|
942
|
+
* Assigned group name
|
|
792
943
|
*/
|
|
793
|
-
|
|
944
|
+
issue_assigned_group?: {
|
|
945
|
+
[key: string]: unknown;
|
|
946
|
+
};
|
|
794
947
|
/**
|
|
795
|
-
*
|
|
948
|
+
* Reported at timestamp
|
|
796
949
|
*/
|
|
797
|
-
|
|
950
|
+
issue_reported_at?: {
|
|
798
951
|
[key: string]: unknown;
|
|
799
952
|
};
|
|
800
953
|
/**
|
|
801
|
-
*
|
|
954
|
+
* Reference
|
|
802
955
|
*/
|
|
803
|
-
|
|
956
|
+
issue_reference?: {
|
|
957
|
+
[key: string]: unknown;
|
|
958
|
+
};
|
|
804
959
|
/**
|
|
805
|
-
*
|
|
960
|
+
* Issue status
|
|
806
961
|
*/
|
|
807
|
-
|
|
808
|
-
};
|
|
809
|
-
type ExtraInfoDto = {
|
|
962
|
+
issue_status: string;
|
|
810
963
|
/**
|
|
811
|
-
*
|
|
964
|
+
* Primary action ID
|
|
812
965
|
*/
|
|
813
|
-
|
|
966
|
+
issue_primary_action_id?: {
|
|
967
|
+
[key: string]: unknown;
|
|
968
|
+
};
|
|
814
969
|
/**
|
|
815
|
-
*
|
|
970
|
+
* Primary action name
|
|
816
971
|
*/
|
|
817
|
-
|
|
972
|
+
issue_primary_action?: {
|
|
973
|
+
[key: string]: unknown;
|
|
974
|
+
};
|
|
818
975
|
/**
|
|
819
|
-
*
|
|
976
|
+
* Response score
|
|
820
977
|
*/
|
|
821
|
-
|
|
978
|
+
issue_score?: {
|
|
979
|
+
[key: string]: unknown;
|
|
980
|
+
};
|
|
822
981
|
/**
|
|
823
|
-
*
|
|
982
|
+
* Resolution ID
|
|
824
983
|
*/
|
|
825
|
-
|
|
984
|
+
issue_resolution_id?: {
|
|
985
|
+
[key: string]: unknown;
|
|
986
|
+
};
|
|
826
987
|
/**
|
|
827
|
-
*
|
|
988
|
+
* Resolution reason
|
|
828
989
|
*/
|
|
829
|
-
|
|
990
|
+
issue_resolution_reason?: {
|
|
991
|
+
[key: string]: unknown;
|
|
992
|
+
};
|
|
830
993
|
/**
|
|
831
|
-
*
|
|
994
|
+
* First actioned at timestamp
|
|
832
995
|
*/
|
|
833
|
-
|
|
996
|
+
issue_first_actioned_at?: {
|
|
997
|
+
[key: string]: unknown;
|
|
998
|
+
};
|
|
834
999
|
/**
|
|
835
|
-
*
|
|
1000
|
+
* Target completion date
|
|
836
1001
|
*/
|
|
837
|
-
|
|
1002
|
+
issue_target_completion_date?: {
|
|
1003
|
+
[key: string]: unknown;
|
|
1004
|
+
};
|
|
838
1005
|
/**
|
|
839
|
-
*
|
|
1006
|
+
* Closed at timestamp
|
|
840
1007
|
*/
|
|
841
|
-
|
|
1008
|
+
issue_closed_at?: {
|
|
1009
|
+
[key: string]: unknown;
|
|
1010
|
+
};
|
|
842
1011
|
/**
|
|
843
|
-
*
|
|
1012
|
+
* Response status
|
|
844
1013
|
*/
|
|
845
|
-
|
|
1014
|
+
response_status?: {
|
|
1015
|
+
[key: string]: unknown;
|
|
1016
|
+
};
|
|
846
1017
|
/**
|
|
847
|
-
*
|
|
1018
|
+
* Created at timestamp
|
|
848
1019
|
*/
|
|
849
|
-
|
|
1020
|
+
issue_created_at: string;
|
|
850
1021
|
/**
|
|
851
|
-
*
|
|
1022
|
+
* Created by user public ID (UUID)
|
|
852
1023
|
*/
|
|
853
|
-
|
|
1024
|
+
issue_created_by_id: string;
|
|
854
1025
|
/**
|
|
855
|
-
*
|
|
1026
|
+
* Created by user full name
|
|
856
1027
|
*/
|
|
857
|
-
|
|
858
|
-
|
|
859
|
-
|
|
1028
|
+
issue_created_by?: {
|
|
1029
|
+
[key: string]: unknown;
|
|
1030
|
+
};
|
|
860
1031
|
/**
|
|
861
|
-
*
|
|
1032
|
+
* Modified at timestamp
|
|
862
1033
|
*/
|
|
863
|
-
|
|
1034
|
+
issue_modified_at: string;
|
|
864
1035
|
/**
|
|
865
|
-
*
|
|
1036
|
+
* Modified by user public ID (UUID)
|
|
866
1037
|
*/
|
|
867
|
-
|
|
1038
|
+
issue_modified_by_id: string;
|
|
868
1039
|
/**
|
|
869
|
-
*
|
|
1040
|
+
* Modified by user full name
|
|
870
1041
|
*/
|
|
871
|
-
|
|
1042
|
+
issue_modified_by?: {
|
|
1043
|
+
[key: string]: unknown;
|
|
1044
|
+
};
|
|
1045
|
+
};
|
|
1046
|
+
type ListChecklistsResponseDto = {
|
|
872
1047
|
/**
|
|
873
|
-
*
|
|
1048
|
+
* List of checklists
|
|
874
1049
|
*/
|
|
875
|
-
|
|
1050
|
+
data: Array<ChecklistSummaryDto>;
|
|
876
1051
|
/**
|
|
877
|
-
*
|
|
1052
|
+
* Current page number
|
|
878
1053
|
*/
|
|
879
|
-
|
|
1054
|
+
page: number;
|
|
880
1055
|
/**
|
|
881
|
-
*
|
|
1056
|
+
* Number of results per page
|
|
882
1057
|
*/
|
|
883
|
-
|
|
884
|
-
[key: string]: unknown;
|
|
885
|
-
};
|
|
1058
|
+
per_page: number;
|
|
886
1059
|
/**
|
|
887
|
-
*
|
|
1060
|
+
* Total number of results
|
|
888
1061
|
*/
|
|
889
|
-
|
|
1062
|
+
total: number;
|
|
890
1063
|
/**
|
|
891
|
-
*
|
|
1064
|
+
* Total number of pages
|
|
892
1065
|
*/
|
|
893
|
-
|
|
1066
|
+
total_pages: number;
|
|
1067
|
+
};
|
|
1068
|
+
type ListConfigItemsResponseDto = {
|
|
894
1069
|
/**
|
|
895
|
-
*
|
|
1070
|
+
* Config items
|
|
896
1071
|
*/
|
|
897
|
-
|
|
1072
|
+
data: Array<ConfigItemDto>;
|
|
1073
|
+
page: number;
|
|
1074
|
+
per_page: number;
|
|
1075
|
+
total: number;
|
|
1076
|
+
total_pages: number;
|
|
1077
|
+
};
|
|
1078
|
+
type ListConfigTablesResponseDto = {
|
|
898
1079
|
/**
|
|
899
|
-
*
|
|
1080
|
+
* Config tables
|
|
900
1081
|
*/
|
|
901
|
-
|
|
1082
|
+
data: Array<ConfigTableDto>;
|
|
1083
|
+
page: number;
|
|
1084
|
+
per_page: number;
|
|
1085
|
+
total: number;
|
|
1086
|
+
total_pages: number;
|
|
1087
|
+
};
|
|
1088
|
+
type ListInspectionsResponseDto = {
|
|
902
1089
|
/**
|
|
903
|
-
*
|
|
1090
|
+
* List of inspections
|
|
904
1091
|
*/
|
|
905
|
-
|
|
1092
|
+
data: Array<InspectionResponseDto>;
|
|
906
1093
|
/**
|
|
907
|
-
*
|
|
1094
|
+
* Current page number
|
|
908
1095
|
*/
|
|
909
|
-
|
|
1096
|
+
page: number;
|
|
910
1097
|
/**
|
|
911
|
-
*
|
|
1098
|
+
* Number of results per page
|
|
912
1099
|
*/
|
|
913
|
-
|
|
1100
|
+
per_page: number;
|
|
914
1101
|
/**
|
|
915
|
-
*
|
|
1102
|
+
* Total number of results
|
|
916
1103
|
*/
|
|
917
|
-
|
|
1104
|
+
total: number;
|
|
918
1105
|
/**
|
|
919
|
-
*
|
|
1106
|
+
* Total number of pages
|
|
920
1107
|
*/
|
|
921
|
-
|
|
1108
|
+
total_pages: number;
|
|
1109
|
+
};
|
|
1110
|
+
type ListIssuesResponseDto = {
|
|
922
1111
|
/**
|
|
923
|
-
*
|
|
1112
|
+
* List of issues
|
|
924
1113
|
*/
|
|
925
|
-
|
|
1114
|
+
data: Array<IssueResponseDto>;
|
|
926
1115
|
/**
|
|
927
|
-
*
|
|
1116
|
+
* Current page number
|
|
928
1117
|
*/
|
|
929
|
-
|
|
1118
|
+
page: number;
|
|
930
1119
|
/**
|
|
931
|
-
*
|
|
1120
|
+
* Number of results per page
|
|
932
1121
|
*/
|
|
933
|
-
|
|
1122
|
+
per_page: number;
|
|
934
1123
|
/**
|
|
935
|
-
*
|
|
1124
|
+
* Total number of results
|
|
936
1125
|
*/
|
|
937
|
-
|
|
1126
|
+
total: number;
|
|
938
1127
|
/**
|
|
939
|
-
*
|
|
1128
|
+
* Total number of pages
|
|
940
1129
|
*/
|
|
941
|
-
|
|
1130
|
+
total_pages: number;
|
|
1131
|
+
};
|
|
1132
|
+
type ListSitesResponseDto = {
|
|
942
1133
|
/**
|
|
943
|
-
*
|
|
1134
|
+
* List of sites
|
|
944
1135
|
*/
|
|
945
|
-
|
|
1136
|
+
data: Array<SiteResponseDto>;
|
|
946
1137
|
/**
|
|
947
|
-
*
|
|
1138
|
+
* Total number of sites
|
|
948
1139
|
*/
|
|
949
|
-
|
|
1140
|
+
total: number;
|
|
950
1141
|
/**
|
|
951
|
-
*
|
|
1142
|
+
* Current page
|
|
952
1143
|
*/
|
|
953
|
-
|
|
1144
|
+
page: number;
|
|
954
1145
|
/**
|
|
955
|
-
*
|
|
1146
|
+
* Items per page
|
|
956
1147
|
*/
|
|
957
|
-
|
|
1148
|
+
per_page: number;
|
|
958
1149
|
/**
|
|
959
|
-
*
|
|
1150
|
+
* Total number of pages
|
|
960
1151
|
*/
|
|
961
|
-
|
|
1152
|
+
total_pages: number;
|
|
1153
|
+
};
|
|
1154
|
+
type PublicCreateAssetDto = {
|
|
962
1155
|
/**
|
|
963
|
-
*
|
|
1156
|
+
* Asset number
|
|
964
1157
|
*/
|
|
965
|
-
|
|
1158
|
+
asset_number: string;
|
|
966
1159
|
/**
|
|
967
|
-
*
|
|
1160
|
+
* Asset class public ID
|
|
968
1161
|
*/
|
|
969
|
-
|
|
1162
|
+
asset_class: string;
|
|
970
1163
|
/**
|
|
971
|
-
*
|
|
1164
|
+
* Site public ID
|
|
972
1165
|
*/
|
|
973
|
-
|
|
1166
|
+
site_id: string;
|
|
974
1167
|
};
|
|
975
|
-
type
|
|
1168
|
+
type SiteResponseDto = {
|
|
976
1169
|
/**
|
|
977
|
-
*
|
|
1170
|
+
* Site public ID (UUID)
|
|
978
1171
|
*/
|
|
979
|
-
|
|
1172
|
+
site_public_id: string;
|
|
980
1173
|
/**
|
|
981
|
-
*
|
|
1174
|
+
* Site name
|
|
982
1175
|
*/
|
|
983
|
-
|
|
1176
|
+
site_name: string;
|
|
984
1177
|
/**
|
|
985
|
-
*
|
|
1178
|
+
* Base language
|
|
986
1179
|
*/
|
|
987
|
-
|
|
1180
|
+
site_base_language: string;
|
|
988
1181
|
/**
|
|
989
|
-
*
|
|
1182
|
+
* Logo file path
|
|
990
1183
|
*/
|
|
991
|
-
|
|
1184
|
+
site_logo_file?: {
|
|
1185
|
+
[key: string]: unknown;
|
|
1186
|
+
};
|
|
992
1187
|
/**
|
|
993
|
-
*
|
|
1188
|
+
* Site category name
|
|
994
1189
|
*/
|
|
995
|
-
|
|
1190
|
+
site_category?: {
|
|
996
1191
|
[key: string]: unknown;
|
|
997
1192
|
};
|
|
998
1193
|
/**
|
|
999
|
-
*
|
|
1194
|
+
* Site category ID. Serialized as a string in public API responses (BigInt-safe).
|
|
1000
1195
|
*/
|
|
1001
|
-
|
|
1196
|
+
site_category_id?: string | null;
|
|
1002
1197
|
/**
|
|
1003
|
-
*
|
|
1198
|
+
* Asset selection method
|
|
1004
1199
|
*/
|
|
1005
|
-
|
|
1200
|
+
site_asset_selection_method: string;
|
|
1006
1201
|
/**
|
|
1007
|
-
*
|
|
1202
|
+
* Asset affix
|
|
1008
1203
|
*/
|
|
1009
|
-
|
|
1204
|
+
site_asset_affix?: {
|
|
1205
|
+
[key: string]: unknown;
|
|
1206
|
+
};
|
|
1010
1207
|
/**
|
|
1011
|
-
*
|
|
1208
|
+
* Asset affix position
|
|
1012
1209
|
*/
|
|
1013
|
-
|
|
1210
|
+
site_asset_affix_position?: {
|
|
1211
|
+
[key: string]: unknown;
|
|
1212
|
+
};
|
|
1014
1213
|
/**
|
|
1015
|
-
*
|
|
1214
|
+
* Created at timestamp
|
|
1016
1215
|
*/
|
|
1017
|
-
|
|
1216
|
+
site_created_at: string;
|
|
1018
1217
|
/**
|
|
1019
|
-
*
|
|
1218
|
+
* Created by user public ID
|
|
1020
1219
|
*/
|
|
1021
|
-
|
|
1220
|
+
site_created_by: string;
|
|
1022
1221
|
/**
|
|
1023
|
-
*
|
|
1222
|
+
* Created by user name
|
|
1024
1223
|
*/
|
|
1025
|
-
|
|
1224
|
+
site_created_by_name?: {
|
|
1225
|
+
[key: string]: unknown;
|
|
1226
|
+
};
|
|
1026
1227
|
/**
|
|
1027
|
-
*
|
|
1228
|
+
* Updated at timestamp
|
|
1028
1229
|
*/
|
|
1029
|
-
|
|
1230
|
+
site_updated_at: string;
|
|
1030
1231
|
/**
|
|
1031
|
-
*
|
|
1232
|
+
* Updated by user public ID
|
|
1032
1233
|
*/
|
|
1033
|
-
|
|
1234
|
+
site_updated_by: string;
|
|
1034
1235
|
/**
|
|
1035
|
-
*
|
|
1236
|
+
* Updated by user name
|
|
1036
1237
|
*/
|
|
1037
|
-
|
|
1238
|
+
site_updated_by_name?: {
|
|
1239
|
+
[key: string]: unknown;
|
|
1240
|
+
};
|
|
1241
|
+
};
|
|
1242
|
+
type UpdateAssetClassDto = {
|
|
1038
1243
|
/**
|
|
1039
|
-
*
|
|
1244
|
+
* Asset class name (make)
|
|
1040
1245
|
*/
|
|
1041
|
-
|
|
1246
|
+
asset_class?: string;
|
|
1042
1247
|
/**
|
|
1043
|
-
*
|
|
1248
|
+
* Asset sub-class name (model)
|
|
1044
1249
|
*/
|
|
1045
|
-
|
|
1250
|
+
asset_sub_class?: string;
|
|
1046
1251
|
/**
|
|
1047
|
-
*
|
|
1252
|
+
* BigInt as string. Asset category ID (from config_items table)
|
|
1048
1253
|
*/
|
|
1049
|
-
|
|
1254
|
+
asset_category_id?: string;
|
|
1050
1255
|
/**
|
|
1051
|
-
*
|
|
1256
|
+
* Asset class photo file path
|
|
1052
1257
|
*/
|
|
1053
|
-
|
|
1258
|
+
asset_class_photo_file?: string;
|
|
1054
1259
|
/**
|
|
1055
|
-
* Asset
|
|
1260
|
+
* Asset class photo info (JSON string)
|
|
1056
1261
|
*/
|
|
1057
|
-
|
|
1262
|
+
asset_class_photo_info?: string;
|
|
1058
1263
|
/**
|
|
1059
|
-
*
|
|
1264
|
+
* Whether on-the-fly creation is enabled
|
|
1060
1265
|
*/
|
|
1061
|
-
|
|
1266
|
+
on_the_fly_enabled?: boolean;
|
|
1267
|
+
};
|
|
1268
|
+
type UpdateAssetClassPropertyDto = {
|
|
1062
1269
|
/**
|
|
1063
|
-
*
|
|
1270
|
+
* Property value (string, number, or date depending on the property type defined in config_items).
|
|
1064
1271
|
*/
|
|
1065
|
-
|
|
1272
|
+
value: {
|
|
1273
|
+
[key: string]: unknown;
|
|
1274
|
+
};
|
|
1275
|
+
};
|
|
1276
|
+
type UpdateAssetDto = {
|
|
1066
1277
|
/**
|
|
1067
|
-
*
|
|
1278
|
+
* Asset number
|
|
1068
1279
|
*/
|
|
1069
|
-
|
|
1280
|
+
asset_number?: string;
|
|
1070
1281
|
/**
|
|
1071
|
-
*
|
|
1282
|
+
* Asset class public ID
|
|
1072
1283
|
*/
|
|
1073
|
-
|
|
1284
|
+
asset_class?: string;
|
|
1074
1285
|
/**
|
|
1075
|
-
*
|
|
1286
|
+
* Site public ID
|
|
1076
1287
|
*/
|
|
1077
|
-
|
|
1288
|
+
site_id?: string;
|
|
1078
1289
|
/**
|
|
1079
|
-
*
|
|
1290
|
+
* Asset photo file path or URL
|
|
1080
1291
|
*/
|
|
1081
|
-
|
|
1292
|
+
asset_photo_file?: string;
|
|
1082
1293
|
/**
|
|
1083
|
-
*
|
|
1294
|
+
* Asset photo metadata as JSON string
|
|
1084
1295
|
*/
|
|
1085
|
-
|
|
1296
|
+
asset_photo_info?: string;
|
|
1086
1297
|
/**
|
|
1087
|
-
*
|
|
1298
|
+
* Latitude coordinate
|
|
1088
1299
|
*/
|
|
1089
|
-
|
|
1300
|
+
lat?: number;
|
|
1090
1301
|
/**
|
|
1091
|
-
*
|
|
1302
|
+
* Longitude coordinate
|
|
1092
1303
|
*/
|
|
1093
|
-
|
|
1304
|
+
lng?: number;
|
|
1305
|
+
};
|
|
1306
|
+
type UpdateAssetPropertyDto = {
|
|
1094
1307
|
/**
|
|
1095
|
-
*
|
|
1308
|
+
* Property value (can be string, number, or date depending on property type)
|
|
1096
1309
|
*/
|
|
1097
|
-
|
|
1310
|
+
value: {
|
|
1311
|
+
[key: string]: unknown;
|
|
1312
|
+
};
|
|
1313
|
+
};
|
|
1314
|
+
type UpdateConfigItemDto = {
|
|
1098
1315
|
/**
|
|
1099
|
-
*
|
|
1316
|
+
* Item value / name
|
|
1100
1317
|
*/
|
|
1101
|
-
|
|
1102
|
-
};
|
|
1103
|
-
type InspectionResponseDto = {
|
|
1318
|
+
item?: string;
|
|
1104
1319
|
/**
|
|
1105
|
-
*
|
|
1320
|
+
* Description (pass null to clear)
|
|
1106
1321
|
*/
|
|
1107
|
-
|
|
1322
|
+
description?: {
|
|
1323
|
+
[key: string]: unknown;
|
|
1324
|
+
} | null;
|
|
1325
|
+
};
|
|
1326
|
+
type UpdateIssueDto = {
|
|
1108
1327
|
/**
|
|
1109
|
-
*
|
|
1328
|
+
* Issue title
|
|
1110
1329
|
*/
|
|
1111
|
-
|
|
1330
|
+
title?: string;
|
|
1112
1331
|
/**
|
|
1113
|
-
*
|
|
1332
|
+
* BigInt as string. Asset ID
|
|
1114
1333
|
*/
|
|
1115
|
-
|
|
1334
|
+
asset_id?: string;
|
|
1116
1335
|
/**
|
|
1117
|
-
*
|
|
1336
|
+
* BigInt as string. Assigned user ID
|
|
1118
1337
|
*/
|
|
1119
|
-
|
|
1120
|
-
[key: string]: unknown;
|
|
1121
|
-
};
|
|
1338
|
+
assigned_user_id?: string;
|
|
1122
1339
|
/**
|
|
1123
|
-
*
|
|
1340
|
+
* BigInt as string. Assigned group ID
|
|
1124
1341
|
*/
|
|
1125
|
-
|
|
1126
|
-
[key: string]: unknown;
|
|
1127
|
-
};
|
|
1342
|
+
assigned_group_id?: string;
|
|
1128
1343
|
/**
|
|
1129
|
-
*
|
|
1344
|
+
* Issue status
|
|
1130
1345
|
*/
|
|
1131
|
-
|
|
1132
|
-
[key: string]: unknown;
|
|
1133
|
-
};
|
|
1134
|
-
/**
|
|
1135
|
-
* Asset number
|
|
1136
|
-
*/
|
|
1137
|
-
inspection_asset_number?: {
|
|
1138
|
-
[key: string]: unknown;
|
|
1139
|
-
};
|
|
1140
|
-
/**
|
|
1141
|
-
* Checklist public ID (UUID)
|
|
1142
|
-
*/
|
|
1143
|
-
inspection_checklist_id?: {
|
|
1144
|
-
[key: string]: unknown;
|
|
1145
|
-
};
|
|
1146
|
-
/**
|
|
1147
|
-
* Checklist name
|
|
1148
|
-
*/
|
|
1149
|
-
inspection_checklist_name?: {
|
|
1150
|
-
[key: string]: unknown;
|
|
1151
|
-
};
|
|
1152
|
-
/**
|
|
1153
|
-
* Checklist category public ID (UUID)
|
|
1154
|
-
*/
|
|
1155
|
-
inspection_checklist_category_id?: {
|
|
1156
|
-
[key: string]: unknown;
|
|
1157
|
-
};
|
|
1158
|
-
/**
|
|
1159
|
-
* Checklist category name
|
|
1160
|
-
*/
|
|
1161
|
-
inspection_checklist_category?: {
|
|
1162
|
-
[key: string]: unknown;
|
|
1163
|
-
};
|
|
1164
|
-
/**
|
|
1165
|
-
* Submitted user public ID (UUID)
|
|
1166
|
-
*/
|
|
1167
|
-
inspection_submitted_user_id?: {
|
|
1168
|
-
[key: string]: unknown;
|
|
1169
|
-
};
|
|
1170
|
-
/**
|
|
1171
|
-
* Submitted user full name
|
|
1172
|
-
*/
|
|
1173
|
-
inspection_submitted_user_name?: {
|
|
1174
|
-
[key: string]: unknown;
|
|
1175
|
-
};
|
|
1176
|
-
/**
|
|
1177
|
-
* Subject user public ID (UUID)
|
|
1178
|
-
*/
|
|
1179
|
-
inspection_subject_user_id?: {
|
|
1180
|
-
[key: string]: unknown;
|
|
1181
|
-
};
|
|
1182
|
-
/**
|
|
1183
|
-
* Subject user full name
|
|
1184
|
-
*/
|
|
1185
|
-
inspection_subject_user_name?: {
|
|
1186
|
-
[key: string]: unknown;
|
|
1187
|
-
};
|
|
1188
|
-
/**
|
|
1189
|
-
* Target project ID. Serialized as a string in public API responses (BigInt-safe).
|
|
1190
|
-
*/
|
|
1191
|
-
inspection_target_project_id?: string | null;
|
|
1192
|
-
/**
|
|
1193
|
-
* Device public ID (UUID)
|
|
1194
|
-
*/
|
|
1195
|
-
inspection_device_id?: {
|
|
1196
|
-
[key: string]: unknown;
|
|
1197
|
-
};
|
|
1198
|
-
/**
|
|
1199
|
-
* Device name
|
|
1200
|
-
*/
|
|
1201
|
-
inspection_device_name?: {
|
|
1202
|
-
[key: string]: unknown;
|
|
1203
|
-
};
|
|
1204
|
-
/**
|
|
1205
|
-
* Inspection score
|
|
1206
|
-
*/
|
|
1207
|
-
inspection_score?: {
|
|
1208
|
-
[key: string]: unknown;
|
|
1209
|
-
};
|
|
1210
|
-
/**
|
|
1211
|
-
* Inspection duration in seconds
|
|
1212
|
-
*/
|
|
1213
|
-
inspection_duration?: {
|
|
1214
|
-
[key: string]: unknown;
|
|
1215
|
-
};
|
|
1216
|
-
/**
|
|
1217
|
-
* Completion percentage
|
|
1218
|
-
*/
|
|
1219
|
-
inspection_completion_percentage?: {
|
|
1220
|
-
[key: string]: unknown;
|
|
1221
|
-
};
|
|
1222
|
-
/**
|
|
1223
|
-
* Started at timestamp
|
|
1224
|
-
*/
|
|
1225
|
-
inspection_started_at?: {
|
|
1226
|
-
[key: string]: unknown;
|
|
1227
|
-
};
|
|
1228
|
-
/**
|
|
1229
|
-
* Ended at timestamp
|
|
1230
|
-
*/
|
|
1231
|
-
inspection_ended_at?: {
|
|
1232
|
-
[key: string]: unknown;
|
|
1233
|
-
};
|
|
1234
|
-
/**
|
|
1235
|
-
* Submitted at timestamp
|
|
1236
|
-
*/
|
|
1237
|
-
inspection_submitted_at?: {
|
|
1238
|
-
[key: string]: unknown;
|
|
1239
|
-
};
|
|
1240
|
-
/**
|
|
1241
|
-
* Created at timestamp (date received)
|
|
1242
|
-
*/
|
|
1243
|
-
inspection_created_at: string;
|
|
1244
|
-
/**
|
|
1245
|
-
* Created by user public ID (UUID)
|
|
1246
|
-
*/
|
|
1247
|
-
inspection_created_by_id?: {
|
|
1248
|
-
[key: string]: unknown;
|
|
1249
|
-
};
|
|
1250
|
-
/**
|
|
1251
|
-
* Created by user full name
|
|
1252
|
-
*/
|
|
1253
|
-
inspection_created_by_name?: {
|
|
1254
|
-
[key: string]: unknown;
|
|
1255
|
-
};
|
|
1256
|
-
/**
|
|
1257
|
-
* Updated at timestamp
|
|
1258
|
-
*/
|
|
1259
|
-
inspection_updated_at: string;
|
|
1260
|
-
/**
|
|
1261
|
-
* Updated by user public ID (UUID)
|
|
1262
|
-
*/
|
|
1263
|
-
inspection_updated_by_id?: {
|
|
1264
|
-
[key: string]: unknown;
|
|
1265
|
-
};
|
|
1266
|
-
/**
|
|
1267
|
-
* Updated by user full name
|
|
1268
|
-
*/
|
|
1269
|
-
inspection_updated_by_name?: {
|
|
1270
|
-
[key: string]: unknown;
|
|
1271
|
-
};
|
|
1272
|
-
};
|
|
1273
|
-
type ListInspectionsResponseDto = {
|
|
1274
|
-
/**
|
|
1275
|
-
* List of inspections
|
|
1276
|
-
*/
|
|
1277
|
-
data: Array<InspectionResponseDto>;
|
|
1278
|
-
/**
|
|
1279
|
-
* Current page number
|
|
1280
|
-
*/
|
|
1281
|
-
page: number;
|
|
1282
|
-
/**
|
|
1283
|
-
* Number of results per page
|
|
1284
|
-
*/
|
|
1285
|
-
per_page: number;
|
|
1286
|
-
/**
|
|
1287
|
-
* Total number of results
|
|
1288
|
-
*/
|
|
1289
|
-
total: number;
|
|
1290
|
-
/**
|
|
1291
|
-
* Total number of pages
|
|
1292
|
-
*/
|
|
1293
|
-
total_pages: number;
|
|
1294
|
-
};
|
|
1295
|
-
type IssueHistoryDto = {
|
|
1296
|
-
/**
|
|
1297
|
-
* BigInt as string. Issue history entry ID
|
|
1298
|
-
*/
|
|
1299
|
-
id: string;
|
|
1300
|
-
/**
|
|
1301
|
-
* BigInt as string. Issue ID this history entry belongs to
|
|
1302
|
-
*/
|
|
1303
|
-
issue_id: string;
|
|
1304
|
-
/**
|
|
1305
|
-
* Issue title at the time of change
|
|
1306
|
-
*/
|
|
1307
|
-
title?: {
|
|
1308
|
-
[key: string]: unknown;
|
|
1309
|
-
};
|
|
1310
|
-
/**
|
|
1311
|
-
* Assigned user ID at the time of change
|
|
1312
|
-
*/
|
|
1313
|
-
assigned_user_id?: {
|
|
1314
|
-
[key: string]: unknown;
|
|
1315
|
-
};
|
|
1316
|
-
/**
|
|
1317
|
-
* Assigned group ID at the time of change
|
|
1318
|
-
*/
|
|
1319
|
-
assigned_group_id?: {
|
|
1320
|
-
[key: string]: unknown;
|
|
1321
|
-
};
|
|
1322
|
-
/**
|
|
1323
|
-
* Status at the time of change
|
|
1324
|
-
*/
|
|
1325
|
-
status?: {
|
|
1326
|
-
[key: string]: unknown;
|
|
1327
|
-
};
|
|
1328
|
-
/**
|
|
1329
|
-
* Primary action ID at the time of change
|
|
1330
|
-
*/
|
|
1331
|
-
primary_action_id?: {
|
|
1332
|
-
[key: string]: unknown;
|
|
1333
|
-
};
|
|
1334
|
-
/**
|
|
1335
|
-
* Resolution ID at the time of change
|
|
1336
|
-
*/
|
|
1337
|
-
resolution_id?: {
|
|
1338
|
-
[key: string]: unknown;
|
|
1339
|
-
};
|
|
1340
|
-
/**
|
|
1341
|
-
* Reference text at the time of change
|
|
1342
|
-
*/
|
|
1343
|
-
reference?: {
|
|
1344
|
-
[key: string]: unknown;
|
|
1345
|
-
};
|
|
1346
|
-
/**
|
|
1347
|
-
* Target completion date at the time of change
|
|
1348
|
-
*/
|
|
1349
|
-
target_completion_on?: {
|
|
1350
|
-
[key: string]: unknown;
|
|
1351
|
-
};
|
|
1352
|
-
/**
|
|
1353
|
-
* Note about the change
|
|
1354
|
-
*/
|
|
1355
|
-
note?: {
|
|
1356
|
-
[key: string]: unknown;
|
|
1357
|
-
};
|
|
1358
|
-
/**
|
|
1359
|
-
* Effort spent in minutes
|
|
1360
|
-
*/
|
|
1361
|
-
effort_spent?: {
|
|
1362
|
-
[key: string]: unknown;
|
|
1363
|
-
};
|
|
1364
|
-
/**
|
|
1365
|
-
* Cost incurred
|
|
1366
|
-
*/
|
|
1367
|
-
cost_incurred?: {
|
|
1368
|
-
[key: string]: unknown;
|
|
1369
|
-
};
|
|
1370
|
-
/**
|
|
1371
|
-
* Chargeable cost
|
|
1372
|
-
*/
|
|
1373
|
-
chargeable_cost?: {
|
|
1374
|
-
[key: string]: unknown;
|
|
1375
|
-
};
|
|
1376
|
-
/**
|
|
1377
|
-
* Type of change that occurred
|
|
1378
|
-
*/
|
|
1379
|
-
change_type: string;
|
|
1380
|
-
/**
|
|
1381
|
-
* Timestamp when the change occurred
|
|
1382
|
-
*/
|
|
1383
|
-
changed_at: string;
|
|
1384
|
-
/**
|
|
1385
|
-
* BigInt as string. User ID who made the change
|
|
1386
|
-
*/
|
|
1387
|
-
changed_by_id: string;
|
|
1388
|
-
};
|
|
1389
|
-
type IssueHistoryResponseDto = {
|
|
1390
|
-
/**
|
|
1391
|
-
* Issue public ID
|
|
1392
|
-
*/
|
|
1393
|
-
issue_public_id: string;
|
|
1394
|
-
/**
|
|
1395
|
-
* BigInt as string. Issue internal ID
|
|
1396
|
-
*/
|
|
1397
|
-
issue_id: string;
|
|
1398
|
-
/**
|
|
1399
|
-
* Array of issue history entries
|
|
1400
|
-
*/
|
|
1401
|
-
history: Array<IssueHistoryDto>;
|
|
1402
|
-
};
|
|
1403
|
-
type UpdateIssueDto = {
|
|
1404
|
-
/**
|
|
1405
|
-
* Issue title
|
|
1406
|
-
*/
|
|
1407
|
-
title?: string;
|
|
1408
|
-
/**
|
|
1409
|
-
* BigInt as string. Asset ID
|
|
1410
|
-
*/
|
|
1411
|
-
asset_id?: string;
|
|
1412
|
-
/**
|
|
1413
|
-
* BigInt as string. Assigned user ID
|
|
1414
|
-
*/
|
|
1415
|
-
assigned_user_id?: string;
|
|
1416
|
-
/**
|
|
1417
|
-
* BigInt as string. Assigned group ID
|
|
1418
|
-
*/
|
|
1419
|
-
assigned_group_id?: string;
|
|
1420
|
-
/**
|
|
1421
|
-
* Issue status
|
|
1422
|
-
*/
|
|
1423
|
-
status?: string;
|
|
1424
|
-
/**
|
|
1425
|
-
* BigInt as string. Primary action ID
|
|
1426
|
-
*/
|
|
1427
|
-
primary_action_id?: string;
|
|
1428
|
-
/**
|
|
1429
|
-
* Resolution ID (accepts string or number, will be converted to string)
|
|
1430
|
-
*/
|
|
1431
|
-
resolution_id?: string;
|
|
1432
|
-
/**
|
|
1433
|
-
* Response score
|
|
1434
|
-
*/
|
|
1435
|
-
response_score?: number;
|
|
1436
|
-
/**
|
|
1437
|
-
* Reference text
|
|
1438
|
-
*/
|
|
1439
|
-
reference?: string;
|
|
1440
|
-
/**
|
|
1441
|
-
* Reported at timestamp (Unix epoch in seconds)
|
|
1442
|
-
*/
|
|
1443
|
-
reported_at?: number;
|
|
1444
|
-
/**
|
|
1445
|
-
* First actioned at timestamp (Unix epoch in seconds)
|
|
1446
|
-
*/
|
|
1447
|
-
first_actioned_at?: number;
|
|
1448
|
-
/**
|
|
1449
|
-
* Target completion on timestamp (Unix epoch in seconds)
|
|
1450
|
-
*/
|
|
1451
|
-
target_completion_on?: number;
|
|
1452
|
-
/**
|
|
1453
|
-
* Closed on timestamp (Unix epoch in seconds)
|
|
1454
|
-
*/
|
|
1455
|
-
closed_on?: number;
|
|
1456
|
-
/**
|
|
1457
|
-
* Project ID
|
|
1458
|
-
*/
|
|
1459
|
-
project_id?: string;
|
|
1460
|
-
/**
|
|
1461
|
-
* User public ID (UUID) performing the update
|
|
1462
|
-
*/
|
|
1463
|
-
user_id: string;
|
|
1464
|
-
};
|
|
1465
|
-
type CreateIssueMediaDto = {
|
|
1466
|
-
/**
|
|
1467
|
-
* Media UUID. Auto-generated if not provided.
|
|
1468
|
-
*/
|
|
1469
|
-
public_id?: string;
|
|
1470
|
-
/**
|
|
1471
|
-
* Media type
|
|
1472
|
-
*/
|
|
1473
|
-
type: 'photo' | 'audio' | 'video';
|
|
1474
|
-
/**
|
|
1475
|
-
* S3 path where the file was uploaded
|
|
1476
|
-
*/
|
|
1477
|
-
media_file?: string;
|
|
1478
|
-
/**
|
|
1479
|
-
* JSON metadata (dimensions, duration, etc.)
|
|
1480
|
-
*/
|
|
1481
|
-
media_info?: string;
|
|
1482
|
-
/**
|
|
1483
|
-
* Unix timestamp in seconds when media was captured
|
|
1484
|
-
*/
|
|
1485
|
-
captured_at?: number;
|
|
1486
|
-
/**
|
|
1487
|
-
* Whether the file upload to S3 is complete
|
|
1488
|
-
*/
|
|
1489
|
-
uploaded?: boolean;
|
|
1490
|
-
/**
|
|
1491
|
-
* BigInt as string. Link to specific issue_history record
|
|
1492
|
-
*/
|
|
1493
|
-
issue_history_id?: string;
|
|
1494
|
-
};
|
|
1495
|
-
type IssueMediaResponseDto = {
|
|
1496
|
-
/**
|
|
1497
|
-
* Whether the operation was successful
|
|
1498
|
-
*/
|
|
1499
|
-
success: boolean;
|
|
1500
|
-
/**
|
|
1501
|
-
* BigInt as string. Database ID of the created issue media record
|
|
1502
|
-
*/
|
|
1503
|
-
issue_media_id: string;
|
|
1504
|
-
/**
|
|
1505
|
-
* Public UUID of the issue media
|
|
1506
|
-
*/
|
|
1507
|
-
public_id: string;
|
|
1508
|
-
};
|
|
1509
|
-
type IssueResponseDto = {
|
|
1510
|
-
/**
|
|
1511
|
-
* Issue public ID (UUID)
|
|
1512
|
-
*/
|
|
1513
|
-
issue_public_id: string;
|
|
1514
|
-
/**
|
|
1515
|
-
* Issue number
|
|
1516
|
-
*/
|
|
1517
|
-
issue_number: string;
|
|
1518
|
-
/**
|
|
1519
|
-
* Asset internal ID
|
|
1520
|
-
*/
|
|
1521
|
-
issue_asset_id?: {
|
|
1522
|
-
[key: string]: unknown;
|
|
1523
|
-
};
|
|
1524
|
-
/**
|
|
1525
|
-
* Asset number
|
|
1526
|
-
*/
|
|
1527
|
-
issue_asset_number?: {
|
|
1528
|
-
[key: string]: unknown;
|
|
1529
|
-
};
|
|
1530
|
-
/**
|
|
1531
|
-
* Asset class name
|
|
1532
|
-
*/
|
|
1533
|
-
issue_asset_class?: {
|
|
1534
|
-
[key: string]: unknown;
|
|
1535
|
-
};
|
|
1536
|
-
/**
|
|
1537
|
-
* Asset sub-class name
|
|
1538
|
-
*/
|
|
1539
|
-
issue_asset_sub_class?: {
|
|
1540
|
-
[key: string]: unknown;
|
|
1541
|
-
};
|
|
1542
|
-
/**
|
|
1543
|
-
* Asset category name
|
|
1544
|
-
*/
|
|
1545
|
-
issue_asset_category?: {
|
|
1546
|
-
[key: string]: unknown;
|
|
1547
|
-
};
|
|
1548
|
-
/**
|
|
1549
|
-
* Inspection name
|
|
1550
|
-
*/
|
|
1551
|
-
issue_inspection_name?: {
|
|
1552
|
-
[key: string]: unknown;
|
|
1553
|
-
};
|
|
1554
|
-
/**
|
|
1555
|
-
* Checklist category
|
|
1556
|
-
*/
|
|
1557
|
-
issue_inspection_category?: {
|
|
1558
|
-
[key: string]: unknown;
|
|
1559
|
-
};
|
|
1560
|
-
/**
|
|
1561
|
-
* Question title
|
|
1562
|
-
*/
|
|
1563
|
-
issues_question_title?: {
|
|
1564
|
-
[key: string]: unknown;
|
|
1565
|
-
};
|
|
1566
|
-
/**
|
|
1567
|
-
* Issue title
|
|
1568
|
-
*/
|
|
1569
|
-
issue_title: string;
|
|
1570
|
-
/**
|
|
1571
|
-
* Assignee user ID
|
|
1572
|
-
*/
|
|
1573
|
-
issue_assignee_id?: {
|
|
1574
|
-
[key: string]: unknown;
|
|
1575
|
-
};
|
|
1576
|
-
/**
|
|
1577
|
-
* Assignee full name
|
|
1578
|
-
*/
|
|
1579
|
-
issue_assignee?: {
|
|
1580
|
-
[key: string]: unknown;
|
|
1581
|
-
};
|
|
1582
|
-
/**
|
|
1583
|
-
* Assigned group ID
|
|
1584
|
-
*/
|
|
1585
|
-
issue_assigned_group_id?: {
|
|
1586
|
-
[key: string]: unknown;
|
|
1587
|
-
};
|
|
1588
|
-
/**
|
|
1589
|
-
* Assigned group name
|
|
1590
|
-
*/
|
|
1591
|
-
issue_assigned_group?: {
|
|
1592
|
-
[key: string]: unknown;
|
|
1593
|
-
};
|
|
1594
|
-
/**
|
|
1595
|
-
* Reported at timestamp
|
|
1596
|
-
*/
|
|
1597
|
-
issue_reported_at?: {
|
|
1598
|
-
[key: string]: unknown;
|
|
1599
|
-
};
|
|
1600
|
-
/**
|
|
1601
|
-
* Reference
|
|
1602
|
-
*/
|
|
1603
|
-
issue_reference?: {
|
|
1604
|
-
[key: string]: unknown;
|
|
1605
|
-
};
|
|
1606
|
-
/**
|
|
1607
|
-
* Issue status
|
|
1608
|
-
*/
|
|
1609
|
-
issue_status: string;
|
|
1610
|
-
/**
|
|
1611
|
-
* Primary action ID
|
|
1612
|
-
*/
|
|
1613
|
-
issue_primary_action_id?: {
|
|
1614
|
-
[key: string]: unknown;
|
|
1615
|
-
};
|
|
1616
|
-
/**
|
|
1617
|
-
* Primary action name
|
|
1618
|
-
*/
|
|
1619
|
-
issue_primary_action?: {
|
|
1620
|
-
[key: string]: unknown;
|
|
1621
|
-
};
|
|
1622
|
-
/**
|
|
1623
|
-
* Response score
|
|
1624
|
-
*/
|
|
1625
|
-
issue_score?: {
|
|
1626
|
-
[key: string]: unknown;
|
|
1627
|
-
};
|
|
1628
|
-
/**
|
|
1629
|
-
* Resolution ID
|
|
1630
|
-
*/
|
|
1631
|
-
issue_resolution_id?: {
|
|
1632
|
-
[key: string]: unknown;
|
|
1633
|
-
};
|
|
1634
|
-
/**
|
|
1635
|
-
* Resolution reason
|
|
1636
|
-
*/
|
|
1637
|
-
issue_resolution_reason?: {
|
|
1638
|
-
[key: string]: unknown;
|
|
1639
|
-
};
|
|
1640
|
-
/**
|
|
1641
|
-
* First actioned at timestamp
|
|
1642
|
-
*/
|
|
1643
|
-
issue_first_actioned_at?: {
|
|
1644
|
-
[key: string]: unknown;
|
|
1645
|
-
};
|
|
1646
|
-
/**
|
|
1647
|
-
* Target completion date
|
|
1648
|
-
*/
|
|
1649
|
-
issue_target_completion_date?: {
|
|
1650
|
-
[key: string]: unknown;
|
|
1651
|
-
};
|
|
1652
|
-
/**
|
|
1653
|
-
* Closed at timestamp
|
|
1654
|
-
*/
|
|
1655
|
-
issue_closed_at?: {
|
|
1656
|
-
[key: string]: unknown;
|
|
1657
|
-
};
|
|
1658
|
-
/**
|
|
1659
|
-
* Response status
|
|
1660
|
-
*/
|
|
1661
|
-
response_status?: {
|
|
1662
|
-
[key: string]: unknown;
|
|
1663
|
-
};
|
|
1664
|
-
/**
|
|
1665
|
-
* Created at timestamp
|
|
1666
|
-
*/
|
|
1667
|
-
issue_created_at: string;
|
|
1668
|
-
/**
|
|
1669
|
-
* Created by user public ID (UUID)
|
|
1670
|
-
*/
|
|
1671
|
-
issue_created_by_id: string;
|
|
1672
|
-
/**
|
|
1673
|
-
* Created by user full name
|
|
1674
|
-
*/
|
|
1675
|
-
issue_created_by?: {
|
|
1676
|
-
[key: string]: unknown;
|
|
1677
|
-
};
|
|
1678
|
-
/**
|
|
1679
|
-
* Modified at timestamp
|
|
1680
|
-
*/
|
|
1681
|
-
issue_modified_at: string;
|
|
1682
|
-
/**
|
|
1683
|
-
* Modified by user public ID (UUID)
|
|
1684
|
-
*/
|
|
1685
|
-
issue_modified_by_id: string;
|
|
1686
|
-
/**
|
|
1687
|
-
* Modified by user full name
|
|
1688
|
-
*/
|
|
1689
|
-
issue_modified_by?: {
|
|
1690
|
-
[key: string]: unknown;
|
|
1691
|
-
};
|
|
1692
|
-
};
|
|
1693
|
-
type ListIssuesResponseDto = {
|
|
1694
|
-
/**
|
|
1695
|
-
* List of issues
|
|
1696
|
-
*/
|
|
1697
|
-
data: Array<IssueResponseDto>;
|
|
1698
|
-
/**
|
|
1699
|
-
* Current page number
|
|
1700
|
-
*/
|
|
1701
|
-
page: number;
|
|
1702
|
-
/**
|
|
1703
|
-
* Number of results per page
|
|
1704
|
-
*/
|
|
1705
|
-
per_page: number;
|
|
1706
|
-
/**
|
|
1707
|
-
* Total number of results
|
|
1708
|
-
*/
|
|
1709
|
-
total: number;
|
|
1710
|
-
/**
|
|
1711
|
-
* Total number of pages
|
|
1712
|
-
*/
|
|
1713
|
-
total_pages: number;
|
|
1714
|
-
};
|
|
1715
|
-
type UpdateUserPropertyDto = {
|
|
1716
|
-
/**
|
|
1717
|
-
* Property value (can be string, number, or date depending on property type)
|
|
1718
|
-
*/
|
|
1719
|
-
value: {
|
|
1720
|
-
[key: string]: unknown;
|
|
1721
|
-
};
|
|
1722
|
-
};
|
|
1723
|
-
type UserPropertyResponseDto = {
|
|
1724
|
-
/**
|
|
1725
|
-
* User property ID. Serialized as a string in public API responses (BigInt-safe).
|
|
1726
|
-
*/
|
|
1727
|
-
id: string;
|
|
1728
|
-
/**
|
|
1729
|
-
* User ID. Serialized as a string in public API responses (BigInt-safe).
|
|
1730
|
-
*/
|
|
1731
|
-
user_id: string;
|
|
1732
|
-
/**
|
|
1733
|
-
* Property ID (config item ID). Serialized as a string in public API responses (BigInt-safe).
|
|
1734
|
-
*/
|
|
1735
|
-
property_id: string;
|
|
1736
|
-
/**
|
|
1737
|
-
* Text value (if property type is Text, Email, or Phone)
|
|
1738
|
-
*/
|
|
1739
|
-
text_value: {
|
|
1740
|
-
[key: string]: unknown;
|
|
1741
|
-
} | null;
|
|
1742
|
-
/**
|
|
1743
|
-
* Numeric value (if property type is Decimal)
|
|
1744
|
-
*/
|
|
1745
|
-
numeric_value: {
|
|
1746
|
-
[key: string]: unknown;
|
|
1747
|
-
} | null;
|
|
1748
|
-
/**
|
|
1749
|
-
* Date value (if property type is Date)
|
|
1750
|
-
*/
|
|
1751
|
-
date_value: {
|
|
1752
|
-
[key: string]: unknown;
|
|
1753
|
-
} | null;
|
|
1754
|
-
/**
|
|
1755
|
-
* Update method
|
|
1756
|
-
*/
|
|
1757
|
-
update_method: {
|
|
1758
|
-
[key: string]: unknown;
|
|
1759
|
-
} | null;
|
|
1760
|
-
/**
|
|
1761
|
-
* Created timestamp
|
|
1762
|
-
*/
|
|
1763
|
-
created_at: string;
|
|
1764
|
-
/**
|
|
1765
|
-
* Updated timestamp
|
|
1766
|
-
*/
|
|
1767
|
-
updated_at: string;
|
|
1768
|
-
};
|
|
1769
|
-
type DeleteUserPropertyResponseDto = {
|
|
1770
|
-
/**
|
|
1771
|
-
* Success message
|
|
1772
|
-
*/
|
|
1773
|
-
message: string;
|
|
1774
|
-
/**
|
|
1775
|
-
* Deleted user property ID. Serialized as a string in public API responses (BigInt-safe).
|
|
1776
|
-
*/
|
|
1777
|
-
id: string;
|
|
1778
|
-
};
|
|
1779
|
-
type UpdateAssetPropertyDto = {
|
|
1780
|
-
/**
|
|
1781
|
-
* Property value (can be string, number, or date depending on property type)
|
|
1782
|
-
*/
|
|
1783
|
-
value: {
|
|
1784
|
-
[key: string]: unknown;
|
|
1785
|
-
};
|
|
1786
|
-
};
|
|
1787
|
-
type AssetPropertyResponseDto = {
|
|
1788
|
-
/**
|
|
1789
|
-
* Asset property ID. Serialized as a string in public API responses (BigInt-safe).
|
|
1790
|
-
*/
|
|
1791
|
-
id: string;
|
|
1792
|
-
/**
|
|
1793
|
-
* Asset ID. Serialized as a string in public API responses (BigInt-safe).
|
|
1794
|
-
*/
|
|
1795
|
-
asset_id: string;
|
|
1796
|
-
/**
|
|
1797
|
-
* Property ID (config item ID). Serialized as a string in public API responses (BigInt-safe).
|
|
1798
|
-
*/
|
|
1799
|
-
property_id: string;
|
|
1800
|
-
/**
|
|
1801
|
-
* Text value (if property type is Text, Email, or Phone)
|
|
1802
|
-
*/
|
|
1803
|
-
text_value: {
|
|
1804
|
-
[key: string]: unknown;
|
|
1805
|
-
} | null;
|
|
1806
|
-
/**
|
|
1807
|
-
* Numeric value (if property type is Decimal)
|
|
1808
|
-
*/
|
|
1809
|
-
numeric_value: {
|
|
1810
|
-
[key: string]: unknown;
|
|
1811
|
-
} | null;
|
|
1812
|
-
/**
|
|
1813
|
-
* Date value (if property type is Date)
|
|
1814
|
-
*/
|
|
1815
|
-
date_value: {
|
|
1816
|
-
[key: string]: unknown;
|
|
1817
|
-
} | null;
|
|
1818
|
-
/**
|
|
1819
|
-
* Update method
|
|
1820
|
-
*/
|
|
1821
|
-
update_method: {
|
|
1822
|
-
[key: string]: unknown;
|
|
1823
|
-
} | null;
|
|
1824
|
-
/**
|
|
1825
|
-
* Created timestamp
|
|
1826
|
-
*/
|
|
1827
|
-
created_at: string;
|
|
1828
|
-
/**
|
|
1829
|
-
* Updated timestamp
|
|
1830
|
-
*/
|
|
1831
|
-
updated_at: string;
|
|
1832
|
-
};
|
|
1833
|
-
type DeleteAssetPropertyResponseDto = {
|
|
1834
|
-
/**
|
|
1835
|
-
* Success message
|
|
1836
|
-
*/
|
|
1837
|
-
message: string;
|
|
1838
|
-
/**
|
|
1839
|
-
* Deleted asset property ID. Serialized as a string in public API responses (BigInt-safe).
|
|
1840
|
-
*/
|
|
1841
|
-
id: string;
|
|
1842
|
-
};
|
|
1843
|
-
type EmbeddedAssetClassPropertyDto = {
|
|
1844
|
-
/**
|
|
1845
|
-
* Custom field-definition ID (config_items.id). String (BigInt-safe).
|
|
1846
|
-
*/
|
|
1847
|
-
property_id: string;
|
|
1848
|
-
/**
|
|
1849
|
-
* The asset_class_properties value-row ID (for future round-trip into an asset-class-property update). String (BigInt-safe).
|
|
1850
|
-
*/
|
|
1851
|
-
asset_class_property_id: string;
|
|
1852
|
-
/**
|
|
1853
|
-
* Property name from config_items
|
|
1854
|
-
*/
|
|
1855
|
-
property_name: string;
|
|
1856
|
-
/**
|
|
1857
|
-
* Text value
|
|
1858
|
-
*/
|
|
1859
|
-
text_value: {
|
|
1860
|
-
[key: string]: unknown;
|
|
1861
|
-
} | null;
|
|
1862
|
-
/**
|
|
1863
|
-
* Numeric value
|
|
1864
|
-
*/
|
|
1865
|
-
numeric_value: {
|
|
1866
|
-
[key: string]: unknown;
|
|
1867
|
-
} | null;
|
|
1868
|
-
/**
|
|
1869
|
-
* Date value
|
|
1870
|
-
*/
|
|
1871
|
-
date_value: {
|
|
1872
|
-
[key: string]: unknown;
|
|
1873
|
-
} | null;
|
|
1874
|
-
/**
|
|
1875
|
-
* Timestamp the value was last updated
|
|
1876
|
-
*/
|
|
1877
|
-
updated_at: {
|
|
1878
|
-
[key: string]: unknown;
|
|
1879
|
-
} | null;
|
|
1880
|
-
/**
|
|
1881
|
-
* Public ID (UUID) of the user who last updated this value
|
|
1882
|
-
*/
|
|
1883
|
-
updated_by: {
|
|
1884
|
-
[key: string]: unknown;
|
|
1885
|
-
} | null;
|
|
1886
|
-
/**
|
|
1887
|
-
* Name of the user who last updated this value
|
|
1888
|
-
*/
|
|
1889
|
-
updated_by_name: {
|
|
1890
|
-
[key: string]: unknown;
|
|
1891
|
-
} | null;
|
|
1892
|
-
};
|
|
1893
|
-
type AssetClassResponseDto = {
|
|
1894
|
-
/**
|
|
1895
|
-
* Asset class public ID (UUID)
|
|
1896
|
-
*/
|
|
1897
|
-
public_id: string;
|
|
1898
|
-
/**
|
|
1899
|
-
* Asset class name (make)
|
|
1900
|
-
*/
|
|
1901
|
-
asset_class: string;
|
|
1902
|
-
/**
|
|
1903
|
-
* Asset sub-class name (model)
|
|
1904
|
-
*/
|
|
1905
|
-
asset_sub_class?: {
|
|
1906
|
-
[key: string]: unknown;
|
|
1907
|
-
};
|
|
1908
|
-
/**
|
|
1909
|
-
* Asset category ID. Serialized as a string in public API responses (BigInt-safe).
|
|
1910
|
-
*/
|
|
1911
|
-
asset_category_id?: string | null;
|
|
1912
|
-
/**
|
|
1913
|
-
* Asset category name
|
|
1914
|
-
*/
|
|
1915
|
-
asset_category_name?: {
|
|
1916
|
-
[key: string]: unknown;
|
|
1917
|
-
};
|
|
1918
|
-
/**
|
|
1919
|
-
* Asset class photo file path
|
|
1920
|
-
*/
|
|
1921
|
-
asset_class_photo_file?: {
|
|
1922
|
-
[key: string]: unknown;
|
|
1923
|
-
};
|
|
1924
|
-
/**
|
|
1925
|
-
* Asset class photo info
|
|
1926
|
-
*/
|
|
1927
|
-
asset_class_photo_info?: {
|
|
1928
|
-
[key: string]: unknown;
|
|
1929
|
-
};
|
|
1930
|
-
/**
|
|
1931
|
-
* Whether on-the-fly creation is enabled
|
|
1932
|
-
*/
|
|
1933
|
-
on_the_fly_enabled: boolean;
|
|
1934
|
-
/**
|
|
1935
|
-
* Creation timestamp
|
|
1936
|
-
*/
|
|
1937
|
-
created_at: string;
|
|
1938
|
-
/**
|
|
1939
|
-
* Created by user public ID
|
|
1940
|
-
*/
|
|
1941
|
-
created_by_id: string;
|
|
1942
|
-
/**
|
|
1943
|
-
* Created by user name
|
|
1944
|
-
*/
|
|
1945
|
-
created_by_name?: {
|
|
1946
|
-
[key: string]: unknown;
|
|
1947
|
-
};
|
|
1948
|
-
/**
|
|
1949
|
-
* Last update timestamp
|
|
1950
|
-
*/
|
|
1951
|
-
updated_at: string;
|
|
1952
|
-
/**
|
|
1953
|
-
* Updated by user public ID
|
|
1954
|
-
*/
|
|
1955
|
-
updated_by_id: string;
|
|
1956
|
-
/**
|
|
1957
|
-
* Updated by user name
|
|
1958
|
-
*/
|
|
1959
|
-
updated_by_name?: {
|
|
1960
|
-
[key: string]: unknown;
|
|
1961
|
-
};
|
|
1962
|
-
/**
|
|
1963
|
-
* Embedded custom property values for this asset class. Uniform shape across entities (property_id = field definition, asset_class_property_id = value row). Empty when the class has no custom properties.
|
|
1964
|
-
*/
|
|
1965
|
-
asset_class_properties: Array<EmbeddedAssetClassPropertyDto>;
|
|
1966
|
-
};
|
|
1967
|
-
type AssetClassListResponseDto = {
|
|
1968
|
-
/**
|
|
1969
|
-
* List of asset classes
|
|
1970
|
-
*/
|
|
1971
|
-
data: Array<AssetClassResponseDto>;
|
|
1972
|
-
/**
|
|
1973
|
-
* Total number of records
|
|
1974
|
-
*/
|
|
1975
|
-
total: number;
|
|
1976
|
-
/**
|
|
1977
|
-
* Current page number
|
|
1978
|
-
*/
|
|
1979
|
-
page: number;
|
|
1980
|
-
/**
|
|
1981
|
-
* Items per page
|
|
1982
|
-
*/
|
|
1983
|
-
per_page: number;
|
|
1984
|
-
/**
|
|
1985
|
-
* Total number of pages
|
|
1986
|
-
*/
|
|
1987
|
-
total_pages: number;
|
|
1988
|
-
};
|
|
1989
|
-
type CreateAssetClassDto = {
|
|
1990
|
-
/**
|
|
1991
|
-
* Asset class name (make)
|
|
1992
|
-
*/
|
|
1993
|
-
asset_class: string;
|
|
1994
|
-
/**
|
|
1995
|
-
* Asset sub-class name (model)
|
|
1996
|
-
*/
|
|
1997
|
-
asset_sub_class?: string;
|
|
1998
|
-
/**
|
|
1999
|
-
* BigInt as string. Asset category ID (from config_items table)
|
|
2000
|
-
*/
|
|
2001
|
-
asset_category_id?: string;
|
|
2002
|
-
/**
|
|
2003
|
-
* Asset class photo file path
|
|
2004
|
-
*/
|
|
2005
|
-
asset_class_photo_file?: string;
|
|
2006
|
-
/**
|
|
2007
|
-
* Asset class photo info (JSON string)
|
|
2008
|
-
*/
|
|
2009
|
-
asset_class_photo_info?: string;
|
|
2010
|
-
/**
|
|
2011
|
-
* Whether on-the-fly creation is enabled
|
|
2012
|
-
*/
|
|
2013
|
-
on_the_fly_enabled?: boolean;
|
|
2014
|
-
};
|
|
2015
|
-
type UpdateAssetClassDto = {
|
|
2016
|
-
/**
|
|
2017
|
-
* Asset class name (make)
|
|
2018
|
-
*/
|
|
2019
|
-
asset_class?: string;
|
|
2020
|
-
/**
|
|
2021
|
-
* Asset sub-class name (model)
|
|
2022
|
-
*/
|
|
2023
|
-
asset_sub_class?: string;
|
|
2024
|
-
/**
|
|
2025
|
-
* BigInt as string. Asset category ID (from config_items table)
|
|
2026
|
-
*/
|
|
2027
|
-
asset_category_id?: string;
|
|
2028
|
-
/**
|
|
2029
|
-
* Asset class photo file path
|
|
2030
|
-
*/
|
|
2031
|
-
asset_class_photo_file?: string;
|
|
2032
|
-
/**
|
|
2033
|
-
* Asset class photo info (JSON string)
|
|
2034
|
-
*/
|
|
2035
|
-
asset_class_photo_info?: string;
|
|
2036
|
-
/**
|
|
2037
|
-
* Whether on-the-fly creation is enabled
|
|
2038
|
-
*/
|
|
2039
|
-
on_the_fly_enabled?: boolean;
|
|
2040
|
-
};
|
|
2041
|
-
type ChecklistSummaryDto = {
|
|
1346
|
+
status?: string;
|
|
2042
1347
|
/**
|
|
2043
|
-
*
|
|
1348
|
+
* BigInt as string. Primary action ID
|
|
2044
1349
|
*/
|
|
2045
|
-
|
|
1350
|
+
primary_action_id?: string;
|
|
2046
1351
|
/**
|
|
2047
|
-
*
|
|
1352
|
+
* Resolution ID (accepts string or number, will be converted to string)
|
|
2048
1353
|
*/
|
|
2049
|
-
|
|
1354
|
+
resolution_id?: string;
|
|
2050
1355
|
/**
|
|
2051
|
-
*
|
|
1356
|
+
* Response score
|
|
2052
1357
|
*/
|
|
2053
|
-
|
|
1358
|
+
response_score?: number;
|
|
2054
1359
|
/**
|
|
2055
|
-
*
|
|
1360
|
+
* Reference text
|
|
2056
1361
|
*/
|
|
2057
|
-
|
|
1362
|
+
reference?: string;
|
|
2058
1363
|
/**
|
|
2059
|
-
*
|
|
1364
|
+
* Reported at timestamp (Unix epoch in seconds)
|
|
2060
1365
|
*/
|
|
2061
|
-
|
|
2062
|
-
[key: string]: unknown;
|
|
2063
|
-
} | null;
|
|
1366
|
+
reported_at?: number;
|
|
2064
1367
|
/**
|
|
2065
|
-
*
|
|
1368
|
+
* First actioned at timestamp (Unix epoch in seconds)
|
|
2066
1369
|
*/
|
|
2067
|
-
|
|
1370
|
+
first_actioned_at?: number;
|
|
2068
1371
|
/**
|
|
2069
|
-
*
|
|
1372
|
+
* Target completion on timestamp (Unix epoch in seconds)
|
|
2070
1373
|
*/
|
|
2071
|
-
|
|
2072
|
-
[key: string]: unknown;
|
|
2073
|
-
} | null;
|
|
1374
|
+
target_completion_on?: number;
|
|
2074
1375
|
/**
|
|
2075
|
-
*
|
|
1376
|
+
* Closed on timestamp (Unix epoch in seconds)
|
|
2076
1377
|
*/
|
|
2077
|
-
|
|
2078
|
-
[key: string]: unknown;
|
|
2079
|
-
} | null;
|
|
1378
|
+
closed_on?: number;
|
|
2080
1379
|
/**
|
|
2081
|
-
*
|
|
1380
|
+
* Project ID
|
|
2082
1381
|
*/
|
|
2083
|
-
|
|
2084
|
-
[key: string]: unknown;
|
|
2085
|
-
} | null;
|
|
1382
|
+
project_id?: string;
|
|
2086
1383
|
/**
|
|
2087
|
-
*
|
|
1384
|
+
* User public ID (UUID) performing the update
|
|
2088
1385
|
*/
|
|
2089
|
-
|
|
2090
|
-
[key: string]: unknown;
|
|
2091
|
-
} | null;
|
|
2092
|
-
created_at: string;
|
|
2093
|
-
updated_at: string;
|
|
1386
|
+
user_id: string;
|
|
2094
1387
|
};
|
|
2095
|
-
type
|
|
2096
|
-
/**
|
|
2097
|
-
* List of checklists
|
|
2098
|
-
*/
|
|
2099
|
-
data: Array<ChecklistSummaryDto>;
|
|
2100
|
-
/**
|
|
2101
|
-
* Current page number
|
|
2102
|
-
*/
|
|
2103
|
-
page: number;
|
|
2104
|
-
/**
|
|
2105
|
-
* Number of results per page
|
|
2106
|
-
*/
|
|
2107
|
-
per_page: number;
|
|
1388
|
+
type UpdateSiteDto = {
|
|
2108
1389
|
/**
|
|
2109
|
-
*
|
|
1390
|
+
* Site name
|
|
2110
1391
|
*/
|
|
2111
|
-
|
|
1392
|
+
name?: string;
|
|
2112
1393
|
/**
|
|
2113
|
-
*
|
|
1394
|
+
* Base language for the site
|
|
2114
1395
|
*/
|
|
2115
|
-
|
|
2116
|
-
};
|
|
2117
|
-
type ConfigTableDto = {
|
|
1396
|
+
base_language?: string;
|
|
2118
1397
|
/**
|
|
2119
|
-
*
|
|
1398
|
+
* BigInt as string. Site category ID (config_items.id)
|
|
2120
1399
|
*/
|
|
2121
|
-
|
|
1400
|
+
category_id?: string;
|
|
2122
1401
|
/**
|
|
2123
|
-
*
|
|
1402
|
+
* Asset selection method
|
|
2124
1403
|
*/
|
|
2125
|
-
|
|
1404
|
+
asset_selection_method?: string;
|
|
2126
1405
|
/**
|
|
2127
|
-
*
|
|
1406
|
+
* Asset affix
|
|
2128
1407
|
*/
|
|
2129
|
-
|
|
1408
|
+
asset_affix?: string;
|
|
2130
1409
|
/**
|
|
2131
|
-
*
|
|
1410
|
+
* Asset affix position (prefix or suffix)
|
|
2132
1411
|
*/
|
|
2133
|
-
|
|
2134
|
-
created_at: string;
|
|
2135
|
-
updated_at: string;
|
|
1412
|
+
asset_affix_position?: string;
|
|
2136
1413
|
};
|
|
2137
|
-
type
|
|
1414
|
+
type UpdateUserPropertyDto = {
|
|
2138
1415
|
/**
|
|
2139
|
-
*
|
|
1416
|
+
* Property value (can be string, number, or date depending on property type)
|
|
2140
1417
|
*/
|
|
2141
|
-
|
|
2142
|
-
|
|
2143
|
-
|
|
2144
|
-
total: number;
|
|
2145
|
-
total_pages: number;
|
|
1418
|
+
value: {
|
|
1419
|
+
[key: string]: unknown;
|
|
1420
|
+
};
|
|
2146
1421
|
};
|
|
2147
|
-
type
|
|
1422
|
+
type UserPropertyResponseDto = {
|
|
2148
1423
|
/**
|
|
2149
|
-
*
|
|
1424
|
+
* User property ID. Serialized as a string in public API responses (BigInt-safe).
|
|
2150
1425
|
*/
|
|
2151
1426
|
id: string;
|
|
2152
1427
|
/**
|
|
2153
|
-
*
|
|
2154
|
-
*/
|
|
2155
|
-
config_table_id: string;
|
|
2156
|
-
/**
|
|
2157
|
-
* Parent config table name
|
|
2158
|
-
*/
|
|
2159
|
-
config_table_name: string;
|
|
2160
|
-
/**
|
|
2161
|
-
* Parent config table class
|
|
2162
|
-
*/
|
|
2163
|
-
config_table_class: string;
|
|
2164
|
-
/**
|
|
2165
|
-
* Item value / name
|
|
1428
|
+
* User ID. Serialized as a string in public API responses (BigInt-safe).
|
|
2166
1429
|
*/
|
|
2167
|
-
|
|
1430
|
+
user_id: string;
|
|
2168
1431
|
/**
|
|
2169
|
-
*
|
|
1432
|
+
* Property ID (config item ID). Serialized as a string in public API responses (BigInt-safe).
|
|
2170
1433
|
*/
|
|
2171
|
-
|
|
2172
|
-
[key: string]: unknown;
|
|
2173
|
-
} | null;
|
|
1434
|
+
property_id: string;
|
|
2174
1435
|
/**
|
|
2175
|
-
*
|
|
1436
|
+
* Text value (if property type is Text, Email, or Phone)
|
|
2176
1437
|
*/
|
|
2177
|
-
|
|
1438
|
+
text_value: {
|
|
2178
1439
|
[key: string]: unknown;
|
|
2179
1440
|
} | null;
|
|
2180
1441
|
/**
|
|
2181
|
-
*
|
|
1442
|
+
* Numeric value (if property type is Decimal)
|
|
2182
1443
|
*/
|
|
2183
|
-
|
|
1444
|
+
numeric_value: {
|
|
2184
1445
|
[key: string]: unknown;
|
|
2185
1446
|
} | null;
|
|
2186
|
-
created_at: string;
|
|
2187
|
-
updated_at: string;
|
|
2188
|
-
};
|
|
2189
|
-
type ListConfigItemsResponseDto = {
|
|
2190
|
-
/**
|
|
2191
|
-
* Config items
|
|
2192
|
-
*/
|
|
2193
|
-
data: Array<ConfigItemDto>;
|
|
2194
|
-
page: number;
|
|
2195
|
-
per_page: number;
|
|
2196
|
-
total: number;
|
|
2197
|
-
total_pages: number;
|
|
2198
|
-
};
|
|
2199
|
-
type CreateConfigItemDto = {
|
|
2200
|
-
/**
|
|
2201
|
-
* Parent config table ID (numeric string, from GET /public/config-table/list). Must belong to the authenticated company.
|
|
2202
|
-
*/
|
|
2203
|
-
config_table_id: string;
|
|
2204
|
-
/**
|
|
2205
|
-
* Item value / name
|
|
2206
|
-
*/
|
|
2207
|
-
item: string;
|
|
2208
|
-
/**
|
|
2209
|
-
* Description
|
|
2210
|
-
*/
|
|
2211
|
-
description?: string;
|
|
2212
|
-
};
|
|
2213
|
-
type UpdateConfigItemDto = {
|
|
2214
|
-
/**
|
|
2215
|
-
* Item value / name
|
|
2216
|
-
*/
|
|
2217
|
-
item?: string;
|
|
2218
1447
|
/**
|
|
2219
|
-
*
|
|
1448
|
+
* Date value (if property type is Date)
|
|
2220
1449
|
*/
|
|
2221
|
-
|
|
1450
|
+
date_value: {
|
|
2222
1451
|
[key: string]: unknown;
|
|
2223
1452
|
} | null;
|
|
2224
|
-
};
|
|
2225
|
-
type SiteResponseDto = {
|
|
2226
|
-
/**
|
|
2227
|
-
* Site public ID (UUID)
|
|
2228
|
-
*/
|
|
2229
|
-
site_public_id: string;
|
|
2230
|
-
/**
|
|
2231
|
-
* Site name
|
|
2232
|
-
*/
|
|
2233
|
-
site_name: string;
|
|
2234
|
-
/**
|
|
2235
|
-
* Base language
|
|
2236
|
-
*/
|
|
2237
|
-
site_base_language: string;
|
|
2238
|
-
/**
|
|
2239
|
-
* Logo file path
|
|
2240
|
-
*/
|
|
2241
|
-
site_logo_file?: {
|
|
2242
|
-
[key: string]: unknown;
|
|
2243
|
-
};
|
|
2244
|
-
/**
|
|
2245
|
-
* Site category name
|
|
2246
|
-
*/
|
|
2247
|
-
site_category?: {
|
|
2248
|
-
[key: string]: unknown;
|
|
2249
|
-
};
|
|
2250
|
-
/**
|
|
2251
|
-
* Site category ID. Serialized as a string in public API responses (BigInt-safe).
|
|
2252
|
-
*/
|
|
2253
|
-
site_category_id?: string | null;
|
|
2254
|
-
/**
|
|
2255
|
-
* Asset selection method
|
|
2256
|
-
*/
|
|
2257
|
-
site_asset_selection_method: string;
|
|
2258
|
-
/**
|
|
2259
|
-
* Asset affix
|
|
2260
|
-
*/
|
|
2261
|
-
site_asset_affix?: {
|
|
2262
|
-
[key: string]: unknown;
|
|
2263
|
-
};
|
|
2264
|
-
/**
|
|
2265
|
-
* Asset affix position
|
|
2266
|
-
*/
|
|
2267
|
-
site_asset_affix_position?: {
|
|
2268
|
-
[key: string]: unknown;
|
|
2269
|
-
};
|
|
2270
|
-
/**
|
|
2271
|
-
* Created at timestamp
|
|
2272
|
-
*/
|
|
2273
|
-
site_created_at: string;
|
|
2274
|
-
/**
|
|
2275
|
-
* Created by user public ID
|
|
2276
|
-
*/
|
|
2277
|
-
site_created_by: string;
|
|
2278
|
-
/**
|
|
2279
|
-
* Created by user name
|
|
2280
|
-
*/
|
|
2281
|
-
site_created_by_name?: {
|
|
2282
|
-
[key: string]: unknown;
|
|
2283
|
-
};
|
|
2284
|
-
/**
|
|
2285
|
-
* Updated at timestamp
|
|
2286
|
-
*/
|
|
2287
|
-
site_updated_at: string;
|
|
2288
|
-
/**
|
|
2289
|
-
* Updated by user public ID
|
|
2290
|
-
*/
|
|
2291
|
-
site_updated_by: string;
|
|
2292
1453
|
/**
|
|
2293
|
-
*
|
|
1454
|
+
* Update method
|
|
2294
1455
|
*/
|
|
2295
|
-
|
|
1456
|
+
update_method: {
|
|
2296
1457
|
[key: string]: unknown;
|
|
2297
|
-
};
|
|
2298
|
-
};
|
|
2299
|
-
type ListSitesResponseDto = {
|
|
1458
|
+
} | null;
|
|
2300
1459
|
/**
|
|
2301
|
-
*
|
|
1460
|
+
* Created timestamp
|
|
2302
1461
|
*/
|
|
2303
|
-
|
|
1462
|
+
created_at: string;
|
|
2304
1463
|
/**
|
|
2305
|
-
*
|
|
1464
|
+
* Updated timestamp
|
|
2306
1465
|
*/
|
|
2307
|
-
|
|
1466
|
+
updated_at: string;
|
|
1467
|
+
};
|
|
1468
|
+
type UserResponseDto = {
|
|
2308
1469
|
/**
|
|
2309
|
-
*
|
|
1470
|
+
* User public ID (UUID)
|
|
2310
1471
|
*/
|
|
2311
|
-
|
|
1472
|
+
user_public_id: string;
|
|
2312
1473
|
/**
|
|
2313
|
-
*
|
|
1474
|
+
* User first name
|
|
2314
1475
|
*/
|
|
2315
|
-
|
|
1476
|
+
user_first_name: string;
|
|
2316
1477
|
/**
|
|
2317
|
-
*
|
|
1478
|
+
* User last name
|
|
2318
1479
|
*/
|
|
2319
|
-
|
|
2320
|
-
};
|
|
2321
|
-
type CreateSiteDto = {
|
|
1480
|
+
user_last_name: string;
|
|
2322
1481
|
/**
|
|
2323
|
-
*
|
|
1482
|
+
* User email address
|
|
2324
1483
|
*/
|
|
2325
|
-
|
|
1484
|
+
user_email: {
|
|
1485
|
+
[key: string]: unknown;
|
|
1486
|
+
} | null;
|
|
2326
1487
|
/**
|
|
2327
|
-
*
|
|
1488
|
+
* Profile photo URL
|
|
2328
1489
|
*/
|
|
2329
|
-
|
|
1490
|
+
user_profile_photo: {
|
|
1491
|
+
[key: string]: unknown;
|
|
1492
|
+
} | null;
|
|
2330
1493
|
/**
|
|
2331
|
-
*
|
|
1494
|
+
* Username (typically email)
|
|
2332
1495
|
*/
|
|
2333
|
-
|
|
1496
|
+
user_user_name: {
|
|
1497
|
+
[key: string]: unknown;
|
|
1498
|
+
} | null;
|
|
2334
1499
|
/**
|
|
2335
|
-
*
|
|
1500
|
+
* Employee number
|
|
2336
1501
|
*/
|
|
2337
|
-
|
|
1502
|
+
user_employee_number: {
|
|
1503
|
+
[key: string]: unknown;
|
|
1504
|
+
} | null;
|
|
2338
1505
|
/**
|
|
2339
|
-
*
|
|
1506
|
+
* User PIN code
|
|
2340
1507
|
*/
|
|
2341
|
-
|
|
1508
|
+
user_pin: {
|
|
1509
|
+
[key: string]: unknown;
|
|
1510
|
+
} | null;
|
|
2342
1511
|
/**
|
|
2343
|
-
*
|
|
1512
|
+
* Contact phone number
|
|
2344
1513
|
*/
|
|
2345
|
-
|
|
1514
|
+
user_contact_number: {
|
|
1515
|
+
[key: string]: unknown;
|
|
1516
|
+
} | null;
|
|
2346
1517
|
/**
|
|
2347
|
-
*
|
|
1518
|
+
* Last login timestamp
|
|
2348
1519
|
*/
|
|
2349
|
-
|
|
2350
|
-
|
|
2351
|
-
|
|
1520
|
+
user_last_login_timestamp: {
|
|
1521
|
+
[key: string]: unknown;
|
|
1522
|
+
} | null;
|
|
2352
1523
|
/**
|
|
2353
|
-
*
|
|
1524
|
+
* User creation timestamp
|
|
2354
1525
|
*/
|
|
2355
|
-
|
|
1526
|
+
user_created: string;
|
|
2356
1527
|
/**
|
|
2357
|
-
*
|
|
1528
|
+
* Public ID of user who created this user
|
|
2358
1529
|
*/
|
|
2359
|
-
|
|
1530
|
+
user_created_by: {
|
|
1531
|
+
[key: string]: unknown;
|
|
1532
|
+
} | null;
|
|
2360
1533
|
/**
|
|
2361
|
-
*
|
|
1534
|
+
* Name of user who created this user
|
|
2362
1535
|
*/
|
|
2363
|
-
|
|
1536
|
+
user_created_by_name: {
|
|
1537
|
+
[key: string]: unknown;
|
|
1538
|
+
} | null;
|
|
2364
1539
|
/**
|
|
2365
|
-
*
|
|
1540
|
+
* Last modification timestamp
|
|
2366
1541
|
*/
|
|
2367
|
-
|
|
1542
|
+
user_modified: string;
|
|
2368
1543
|
/**
|
|
2369
|
-
*
|
|
1544
|
+
* Public ID of user who last modified this user
|
|
2370
1545
|
*/
|
|
2371
|
-
|
|
1546
|
+
user_modified_by: {
|
|
1547
|
+
[key: string]: unknown;
|
|
1548
|
+
} | null;
|
|
2372
1549
|
/**
|
|
2373
|
-
*
|
|
1550
|
+
* Name of user who last modified this user
|
|
2374
1551
|
*/
|
|
2375
|
-
|
|
2376
|
-
|
|
2377
|
-
|
|
1552
|
+
user_modified_by_name: {
|
|
1553
|
+
[key: string]: unknown;
|
|
1554
|
+
} | null;
|
|
2378
1555
|
/**
|
|
2379
|
-
*
|
|
1556
|
+
* Whether user is deleted
|
|
2380
1557
|
*/
|
|
2381
|
-
|
|
1558
|
+
user_deleted: boolean;
|
|
2382
1559
|
/**
|
|
2383
|
-
*
|
|
1560
|
+
* User properties
|
|
2384
1561
|
*/
|
|
2385
|
-
|
|
1562
|
+
user_properties: Array<EmbeddedUserPropertyDto>;
|
|
2386
1563
|
};
|
|
2387
1564
|
type AssetControllerCreateAssetPublicData = {
|
|
2388
1565
|
/**
|
|
@@ -2443,6 +1620,10 @@ type AssetControllerCreateAssetPublicResponses = {
|
|
|
2443
1620
|
companyId?: string;
|
|
2444
1621
|
assetPhotoFile?: string | null;
|
|
2445
1622
|
assetPhotoInfo?: string | null;
|
|
1623
|
+
/**
|
|
1624
|
+
* Signed CloudFront URL for the asset photo (assetPhotoFile is the S3 key). ~1h lifetime; null if no photo / signing not configured.
|
|
1625
|
+
*/
|
|
1626
|
+
asset_photo_url?: string | null;
|
|
2446
1627
|
lat?: number | null;
|
|
2447
1628
|
lng?: number | null;
|
|
2448
1629
|
createdById?: string;
|
|
@@ -2542,6 +1723,10 @@ type AssetControllerListAssetsResponses = {
|
|
|
2542
1723
|
companyId?: string;
|
|
2543
1724
|
assetPhotoFile?: string | null;
|
|
2544
1725
|
assetPhotoInfo?: string | null;
|
|
1726
|
+
/**
|
|
1727
|
+
* Signed CloudFront URL for the asset photo (assetPhotoFile is the S3 key). ~1h lifetime; null if no photo / signing not configured.
|
|
1728
|
+
*/
|
|
1729
|
+
asset_photo_url?: string | null;
|
|
2545
1730
|
lat?: number | null;
|
|
2546
1731
|
lng?: number | null;
|
|
2547
1732
|
createdById?: string;
|
|
@@ -2612,6 +1797,10 @@ type AssetControllerGetAssetResponses = {
|
|
|
2612
1797
|
companyId?: string;
|
|
2613
1798
|
assetPhotoFile?: string | null;
|
|
2614
1799
|
assetPhotoInfo?: string | null;
|
|
1800
|
+
/**
|
|
1801
|
+
* Signed CloudFront URL for the asset photo (assetPhotoFile is the S3 key). ~1h lifetime; null if no photo / signing not configured.
|
|
1802
|
+
*/
|
|
1803
|
+
asset_photo_url?: string | null;
|
|
2615
1804
|
lat?: number | null;
|
|
2616
1805
|
lng?: number | null;
|
|
2617
1806
|
createdById?: string;
|
|
@@ -2692,6 +1881,10 @@ type AssetControllerUpdateAssetResponses = {
|
|
|
2692
1881
|
companyId?: string;
|
|
2693
1882
|
assetPhotoFile?: string | null;
|
|
2694
1883
|
assetPhotoInfo?: string | null;
|
|
1884
|
+
/**
|
|
1885
|
+
* Signed CloudFront URL for the asset photo (assetPhotoFile is the S3 key). ~1h lifetime; null if no photo / signing not configured.
|
|
1886
|
+
*/
|
|
1887
|
+
asset_photo_url?: string | null;
|
|
2695
1888
|
lat?: number | null;
|
|
2696
1889
|
lng?: number | null;
|
|
2697
1890
|
createdById?: string;
|
|
@@ -3341,66 +2534,6 @@ type InspectionControllerGetPublicInspectionResponses = {
|
|
|
3341
2534
|
};
|
|
3342
2535
|
};
|
|
3343
2536
|
type InspectionControllerGetPublicInspectionResponse = InspectionControllerGetPublicInspectionResponses[keyof InspectionControllerGetPublicInspectionResponses];
|
|
3344
|
-
type InspectionControllerSubmitInspectionPublicData = {
|
|
3345
|
-
/**
|
|
3346
|
-
* Complete inspection data with nested structure
|
|
3347
|
-
*/
|
|
3348
|
-
body: SubmitInspectionDto;
|
|
3349
|
-
headers?: {
|
|
3350
|
-
/**
|
|
3351
|
-
* Opaque client-generated key (any string up to 255 chars, ULID or UUID recommended) that makes this POST/PATCH safe to retry. The server stores the first successful response under this key for 24 hours; retries with the same key replay the stored response and set `Idempotent-Replayed: true`. Reusing the key with a different body returns `409 idempotency_key_conflict`. Omit on read-only GETs — they are already idempotent.
|
|
3352
|
-
*/
|
|
3353
|
-
'Idempotency-Key'?: string;
|
|
3354
|
-
};
|
|
3355
|
-
path?: never;
|
|
3356
|
-
query?: never;
|
|
3357
|
-
url: '/public/inspection/submit';
|
|
3358
|
-
};
|
|
3359
|
-
type InspectionControllerSubmitInspectionPublicErrors = {
|
|
3360
|
-
/**
|
|
3361
|
-
* Validation failed or the request was malformed. The response body will use `code: validation_error` (with `details[]` populated when the failure can be pinpointed to specific fields) or the more generic `code: bad_request`.
|
|
3362
|
-
*/
|
|
3363
|
-
400: ApiErrorResponse;
|
|
3364
|
-
/**
|
|
3365
|
-
* The Bearer token is missing, malformed, or no longer valid. Verify the `Authorization` header is set to `Bearer wk_…` and that the key has not been revoked or rotated out.
|
|
3366
|
-
*/
|
|
3367
|
-
401: ApiErrorResponse;
|
|
3368
|
-
/**
|
|
3369
|
-
* The Bearer token authenticated successfully but cannot perform this action. Two distinct codes share this status: `forbidden` (missing permission scope) and `ip_not_allowed` (source IP not in the API key's allowlist).
|
|
3370
|
-
*/
|
|
3371
|
-
403: ApiErrorResponse;
|
|
3372
|
-
/**
|
|
3373
|
-
* No resource was found at the requested location, or a referenced resource (`publicId` in the body) doesn't exist or is not visible to the calling company.
|
|
3374
|
-
*/
|
|
3375
|
-
404: ApiErrorResponse;
|
|
3376
|
-
/**
|
|
3377
|
-
* The request conflicts with current state. Common cases: a unique business identifier already exists (`conflict`), or an `Idempotency-Key` was reused with a different request body (`idempotency_key_conflict`).
|
|
3378
|
-
*/
|
|
3379
|
-
409: ApiErrorResponse;
|
|
3380
|
-
/**
|
|
3381
|
-
* Rate limit exceeded for this API key. Inspect `X-RateLimit-Reset` and `Retry-After` to find out when the window resets.
|
|
3382
|
-
*/
|
|
3383
|
-
429: ApiErrorResponse;
|
|
3384
|
-
/**
|
|
3385
|
-
* Something went wrong on our side. The `request_id` field in the response body matches the entry in our logs — include it when reporting the issue.
|
|
3386
|
-
*/
|
|
3387
|
-
500: ApiErrorResponse;
|
|
3388
|
-
};
|
|
3389
|
-
type InspectionControllerSubmitInspectionPublicError = InspectionControllerSubmitInspectionPublicErrors[keyof InspectionControllerSubmitInspectionPublicErrors];
|
|
3390
|
-
type InspectionControllerSubmitInspectionPublicResponses = {
|
|
3391
|
-
/**
|
|
3392
|
-
* Inspection successfully submitted
|
|
3393
|
-
*/
|
|
3394
|
-
201: {
|
|
3395
|
-
success?: boolean;
|
|
3396
|
-
inspection_public_id?: string;
|
|
3397
|
-
/**
|
|
3398
|
-
* BigInt-safe stringified ID of the created inspection.
|
|
3399
|
-
*/
|
|
3400
|
-
inspection_id?: string;
|
|
3401
|
-
};
|
|
3402
|
-
};
|
|
3403
|
-
type InspectionControllerSubmitInspectionPublicResponse = InspectionControllerSubmitInspectionPublicResponses[keyof InspectionControllerSubmitInspectionPublicResponses];
|
|
3404
2537
|
type IssueControllerListIssuesData = {
|
|
3405
2538
|
body?: never;
|
|
3406
2539
|
path?: never;
|
|
@@ -4460,6 +3593,98 @@ type PublicConfigControllerCreateConfigItemResponses = {
|
|
|
4460
3593
|
201: ConfigItemDto;
|
|
4461
3594
|
};
|
|
4462
3595
|
type PublicConfigControllerCreateConfigItemResponse = PublicConfigControllerCreateConfigItemResponses[keyof PublicConfigControllerCreateConfigItemResponses];
|
|
3596
|
+
type AssetClassPropertyControllerRemoveData = {
|
|
3597
|
+
body?: never;
|
|
3598
|
+
path: {
|
|
3599
|
+
/**
|
|
3600
|
+
* Asset class property value-row ID (numeric string)
|
|
3601
|
+
*/
|
|
3602
|
+
id: string;
|
|
3603
|
+
};
|
|
3604
|
+
query?: never;
|
|
3605
|
+
url: '/asset-class-property/{id}';
|
|
3606
|
+
};
|
|
3607
|
+
type AssetClassPropertyControllerRemoveErrors = {
|
|
3608
|
+
/**
|
|
3609
|
+
* The Bearer token is missing, malformed, or no longer valid. Verify the `Authorization` header is set to `Bearer wk_…` and that the key has not been revoked or rotated out.
|
|
3610
|
+
*/
|
|
3611
|
+
401: ApiErrorResponse;
|
|
3612
|
+
/**
|
|
3613
|
+
* The Bearer token authenticated successfully but cannot perform this action. Two distinct codes share this status: `forbidden` (missing permission scope) and `ip_not_allowed` (source IP not in the API key's allowlist).
|
|
3614
|
+
*/
|
|
3615
|
+
403: ApiErrorResponse;
|
|
3616
|
+
/**
|
|
3617
|
+
* No resource was found at the requested location, or a referenced resource (`publicId` in the body) doesn't exist or is not visible to the calling company.
|
|
3618
|
+
*/
|
|
3619
|
+
404: ApiErrorResponse;
|
|
3620
|
+
/**
|
|
3621
|
+
* Rate limit exceeded for this API key. Inspect `X-RateLimit-Reset` and `Retry-After` to find out when the window resets.
|
|
3622
|
+
*/
|
|
3623
|
+
429: ApiErrorResponse;
|
|
3624
|
+
/**
|
|
3625
|
+
* Something went wrong on our side. The `request_id` field in the response body matches the entry in our logs — include it when reporting the issue.
|
|
3626
|
+
*/
|
|
3627
|
+
500: ApiErrorResponse;
|
|
3628
|
+
};
|
|
3629
|
+
type AssetClassPropertyControllerRemoveError = AssetClassPropertyControllerRemoveErrors[keyof AssetClassPropertyControllerRemoveErrors];
|
|
3630
|
+
type AssetClassPropertyControllerRemoveResponses = {
|
|
3631
|
+
/**
|
|
3632
|
+
* Asset class property deleted
|
|
3633
|
+
*/
|
|
3634
|
+
200: DeleteAssetClassPropertyResponseDto;
|
|
3635
|
+
};
|
|
3636
|
+
type AssetClassPropertyControllerRemoveResponse = AssetClassPropertyControllerRemoveResponses[keyof AssetClassPropertyControllerRemoveResponses];
|
|
3637
|
+
type AssetClassPropertyControllerUpdateData = {
|
|
3638
|
+
body: UpdateAssetClassPropertyDto;
|
|
3639
|
+
headers?: {
|
|
3640
|
+
/**
|
|
3641
|
+
* Opaque client-generated key (any string up to 255 chars, ULID or UUID recommended) that makes this POST/PATCH safe to retry. The server stores the first successful response under this key for 24 hours; retries with the same key replay the stored response and set `Idempotent-Replayed: true`. Reusing the key with a different body returns `409 idempotency_key_conflict`. Omit on read-only GETs — they are already idempotent.
|
|
3642
|
+
*/
|
|
3643
|
+
'Idempotency-Key'?: string;
|
|
3644
|
+
};
|
|
3645
|
+
path: {
|
|
3646
|
+
/**
|
|
3647
|
+
* Asset class property value-row ID (numeric string)
|
|
3648
|
+
*/
|
|
3649
|
+
id: string;
|
|
3650
|
+
};
|
|
3651
|
+
query?: never;
|
|
3652
|
+
url: '/asset-class-property/{id}';
|
|
3653
|
+
};
|
|
3654
|
+
type AssetClassPropertyControllerUpdateErrors = {
|
|
3655
|
+
/**
|
|
3656
|
+
* Validation failed or the request was malformed. The response body will use `code: validation_error` (with `details[]` populated when the failure can be pinpointed to specific fields) or the more generic `code: bad_request`.
|
|
3657
|
+
*/
|
|
3658
|
+
400: ApiErrorResponse;
|
|
3659
|
+
/**
|
|
3660
|
+
* The Bearer token is missing, malformed, or no longer valid. Verify the `Authorization` header is set to `Bearer wk_…` and that the key has not been revoked or rotated out.
|
|
3661
|
+
*/
|
|
3662
|
+
401: ApiErrorResponse;
|
|
3663
|
+
/**
|
|
3664
|
+
* The Bearer token authenticated successfully but cannot perform this action. Two distinct codes share this status: `forbidden` (missing permission scope) and `ip_not_allowed` (source IP not in the API key's allowlist).
|
|
3665
|
+
*/
|
|
3666
|
+
403: ApiErrorResponse;
|
|
3667
|
+
/**
|
|
3668
|
+
* No resource was found at the requested location, or a referenced resource (`publicId` in the body) doesn't exist or is not visible to the calling company.
|
|
3669
|
+
*/
|
|
3670
|
+
404: ApiErrorResponse;
|
|
3671
|
+
/**
|
|
3672
|
+
* Rate limit exceeded for this API key. Inspect `X-RateLimit-Reset` and `Retry-After` to find out when the window resets.
|
|
3673
|
+
*/
|
|
3674
|
+
429: ApiErrorResponse;
|
|
3675
|
+
/**
|
|
3676
|
+
* Something went wrong on our side. The `request_id` field in the response body matches the entry in our logs — include it when reporting the issue.
|
|
3677
|
+
*/
|
|
3678
|
+
500: ApiErrorResponse;
|
|
3679
|
+
};
|
|
3680
|
+
type AssetClassPropertyControllerUpdateError = AssetClassPropertyControllerUpdateErrors[keyof AssetClassPropertyControllerUpdateErrors];
|
|
3681
|
+
type AssetClassPropertyControllerUpdateResponses = {
|
|
3682
|
+
/**
|
|
3683
|
+
* Asset class property updated
|
|
3684
|
+
*/
|
|
3685
|
+
200: AssetClassPropertyResponseDto;
|
|
3686
|
+
};
|
|
3687
|
+
type AssetClassPropertyControllerUpdateResponse = AssetClassPropertyControllerUpdateResponses[keyof AssetClassPropertyControllerUpdateResponses];
|
|
4463
3688
|
type SiteControllerListSitesData = {
|
|
4464
3689
|
body?: never;
|
|
4465
3690
|
path?: never;
|
|
@@ -4678,7 +3903,7 @@ type SiteControllerUpdateSiteResponses = {
|
|
|
4678
3903
|
};
|
|
4679
3904
|
type SiteControllerUpdateSiteResponse = SiteControllerUpdateSiteResponses[keyof SiteControllerUpdateSiteResponses];
|
|
4680
3905
|
type ClientOptions = {
|
|
4681
|
-
baseUrl: 'https://
|
|
3906
|
+
baseUrl: 'https://api.wakata.ai' | (string & {});
|
|
4682
3907
|
};
|
|
4683
3908
|
|
|
4684
3909
|
type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = Options$1<TData, ThrowOnError> & {
|
|
@@ -4707,6 +3932,7 @@ declare const assetControllerCreateAssetPublic: <ThrowOnError extends boolean =
|
|
|
4707
3932
|
companyId?: string;
|
|
4708
3933
|
assetPhotoFile?: string | null;
|
|
4709
3934
|
assetPhotoInfo?: string | null;
|
|
3935
|
+
asset_photo_url?: string | null;
|
|
4710
3936
|
lat?: number | null;
|
|
4711
3937
|
lng?: number | null;
|
|
4712
3938
|
createdById?: string;
|
|
@@ -4732,6 +3958,7 @@ declare const assetControllerListAssets: <ThrowOnError extends boolean = false>(
|
|
|
4732
3958
|
companyId?: string;
|
|
4733
3959
|
assetPhotoFile?: string | null;
|
|
4734
3960
|
assetPhotoInfo?: string | null;
|
|
3961
|
+
asset_photo_url?: string | null;
|
|
4735
3962
|
lat?: number | null;
|
|
4736
3963
|
lng?: number | null;
|
|
4737
3964
|
createdById?: string;
|
|
@@ -4763,6 +3990,7 @@ declare const assetControllerGetAsset: <ThrowOnError extends boolean = false>(op
|
|
|
4763
3990
|
companyId?: string;
|
|
4764
3991
|
assetPhotoFile?: string | null;
|
|
4765
3992
|
assetPhotoInfo?: string | null;
|
|
3993
|
+
asset_photo_url?: string | null;
|
|
4766
3994
|
lat?: number | null;
|
|
4767
3995
|
lng?: number | null;
|
|
4768
3996
|
createdById?: string;
|
|
@@ -4787,6 +4015,7 @@ declare const assetControllerUpdateAsset: <ThrowOnError extends boolean = false>
|
|
|
4787
4015
|
companyId?: string;
|
|
4788
4016
|
assetPhotoFile?: string | null;
|
|
4789
4017
|
assetPhotoInfo?: string | null;
|
|
4018
|
+
asset_photo_url?: string | null;
|
|
4790
4019
|
lat?: number | null;
|
|
4791
4020
|
lng?: number | null;
|
|
4792
4021
|
createdById?: string;
|
|
@@ -4946,16 +4175,6 @@ declare const inspectionControllerGetPublicInspection: <ThrowOnError extends boo
|
|
|
4946
4175
|
updated_by_name?: string | null;
|
|
4947
4176
|
}>;
|
|
4948
4177
|
}, ApiErrorResponse, ThrowOnError>;
|
|
4949
|
-
/**
|
|
4950
|
-
* @deprecated
|
|
4951
|
-
* Submit inspection with nested data (deprecated)
|
|
4952
|
-
* DEPRECATED — inspections are created only by the Wakata app; this public create path is being retired (WAK-00560). Do not build new integrations against it. Submits a complete inspection with nested responses, response options, extra infos, and media. Uses PostgreSQL transactions to ensure atomicity. Checks if inspection already exists by public_id to avoid duplicates. Handles nested response tree structure with left/right values. Timestamps in input are Unix epoch (milliseconds for inspection times, seconds for others). Requires Bearer token authentication. Internal tokens bypass permission check, public tokens require inspection:create permission. Supports `Idempotency-Key` for safe retries.
|
|
4953
|
-
*/
|
|
4954
|
-
declare const inspectionControllerSubmitInspectionPublic: <ThrowOnError extends boolean = false>(options: Options<InspectionControllerSubmitInspectionPublicData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<{
|
|
4955
|
-
success?: boolean;
|
|
4956
|
-
inspection_public_id?: string;
|
|
4957
|
-
inspection_id?: string;
|
|
4958
|
-
}, ApiErrorResponse, ThrowOnError>;
|
|
4959
4178
|
/**
|
|
4960
4179
|
* List issues
|
|
4961
4180
|
* Returns a paginated list of issues for the authenticated company. Supports filtering by various fields and sorting. Requires Bearer token authentication with issue:read permission.
|
|
@@ -5038,6 +4257,16 @@ declare const publicConfigControllerUpdateConfigItem: <ThrowOnError extends bool
|
|
|
5038
4257
|
* Creates a config item (e.g. a new asset category) under the given config_table_id, which must belong to the authenticated company. Requires company:settings:tables. Supports `Idempotency-Key`.
|
|
5039
4258
|
*/
|
|
5040
4259
|
declare const publicConfigControllerCreateConfigItem: <ThrowOnError extends boolean = false>(options: Options<PublicConfigControllerCreateConfigItemData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ConfigItemDto, ApiErrorResponse, ThrowOnError>;
|
|
4260
|
+
/**
|
|
4261
|
+
* Delete an asset class property by ID
|
|
4262
|
+
* Soft-deletes an asset class custom property value (writes a history record). Company-scoped. Requires asset-class:update.
|
|
4263
|
+
*/
|
|
4264
|
+
declare const assetClassPropertyControllerRemove: <ThrowOnError extends boolean = false>(options: Options<AssetClassPropertyControllerRemoveData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<DeleteAssetClassPropertyResponseDto, ApiErrorResponse, ThrowOnError>;
|
|
4265
|
+
/**
|
|
4266
|
+
* Update an asset class property value by ID
|
|
4267
|
+
* Updates the value of an asset class custom property. The value is stored in text_value, numeric_value, or date_value based on the property type in config_items, and a history record is written. Company-scoped. Requires asset-class:update. Supports `Idempotency-Key`.
|
|
4268
|
+
*/
|
|
4269
|
+
declare const assetClassPropertyControllerUpdate: <ThrowOnError extends boolean = false>(options: Options<AssetClassPropertyControllerUpdateData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<AssetClassPropertyResponseDto, ApiErrorResponse, ThrowOnError>;
|
|
5041
4270
|
/**
|
|
5042
4271
|
* List sites
|
|
5043
4272
|
* Returns a paginated list of sites for the authenticated company. Supports filtering by name, category, and date modified. Requires Bearer token authentication with site:read permission.
|
|
@@ -5116,7 +4345,6 @@ interface SitesResource {
|
|
|
5116
4345
|
interface InspectionsResource {
|
|
5117
4346
|
list: (options?: WakataMethodOptions<Parameters<typeof inspectionControllerListInspections>[0] extends infer O ? O : never>) => Promise<Awaited<ReturnType<typeof inspectionControllerListInspections>>['data']>;
|
|
5118
4347
|
getDetail: (options: WakataMethodOptions<Parameters<typeof inspectionControllerGetPublicInspection>[0]>) => Promise<Awaited<ReturnType<typeof inspectionControllerGetPublicInspection>>['data']>;
|
|
5119
|
-
submit: (options: WakataMethodOptions<Parameters<typeof inspectionControllerSubmitInspectionPublic>[0]>) => Promise<Awaited<ReturnType<typeof inspectionControllerSubmitInspectionPublic>>['data']>;
|
|
5120
4348
|
}
|
|
5121
4349
|
interface ChecklistsResource {
|
|
5122
4350
|
list: (options?: WakataMethodOptions<Parameters<typeof checklistControllerListChecklists>[0] extends infer O ? O : never>) => Promise<Awaited<ReturnType<typeof checklistControllerListChecklists>>['data']>;
|
|
@@ -5140,6 +4368,10 @@ interface UserPropertiesResource {
|
|
|
5140
4368
|
update: (options: WakataMethodOptions<Parameters<typeof userPropertyControllerUpdateUserProperty>[0]>) => Promise<Awaited<ReturnType<typeof userPropertyControllerUpdateUserProperty>>['data']>;
|
|
5141
4369
|
delete: (options: WakataMethodOptions<Parameters<typeof userPropertyControllerDeleteUserProperty>[0]>) => Promise<Awaited<ReturnType<typeof userPropertyControllerDeleteUserProperty>>['data']>;
|
|
5142
4370
|
}
|
|
4371
|
+
interface AssetClassPropertiesResource {
|
|
4372
|
+
update: (options: WakataMethodOptions<Parameters<typeof assetClassPropertyControllerUpdate>[0]>) => Promise<Awaited<ReturnType<typeof assetClassPropertyControllerUpdate>>['data']>;
|
|
4373
|
+
delete: (options: WakataMethodOptions<Parameters<typeof assetClassPropertyControllerRemove>[0]>) => Promise<Awaited<ReturnType<typeof assetClassPropertyControllerRemove>>['data']>;
|
|
4374
|
+
}
|
|
5143
4375
|
/**
|
|
5144
4376
|
* The main entry point for the Wakata API client.
|
|
5145
4377
|
*
|
|
@@ -5168,6 +4400,7 @@ declare class WakataClient {
|
|
|
5168
4400
|
readonly userProperties: UserPropertiesResource;
|
|
5169
4401
|
readonly checklists: ChecklistsResource;
|
|
5170
4402
|
readonly config: ConfigResource;
|
|
4403
|
+
readonly assetClassProperties: AssetClassPropertiesResource;
|
|
5171
4404
|
constructor(options: WakataClientOptions);
|
|
5172
4405
|
}
|
|
5173
4406
|
|
|
@@ -5337,8 +4570,8 @@ declare function generateIdempotencyKey(): string;
|
|
|
5337
4570
|
* See README.md for usage.
|
|
5338
4571
|
*/
|
|
5339
4572
|
declare const PACKAGE_NAME = "@wakata-dev/api-client";
|
|
5340
|
-
declare const PACKAGE_VERSION = "0.3.
|
|
4573
|
+
declare const PACKAGE_VERSION = "0.3.2";
|
|
5341
4574
|
/** Default base URL for the Wakata Public API (production). */
|
|
5342
4575
|
declare const DEFAULT_BASE_URL = "https://api.wakata.ai/api/v1";
|
|
5343
4576
|
|
|
5344
|
-
export { type ApiErrorBody, type ApiErrorDetail, type ApiErrorResponse, type AssetClassControllerCreateAssetClassData, type AssetClassControllerCreateAssetClassError, type AssetClassControllerCreateAssetClassErrors, type AssetClassControllerCreateAssetClassResponse, type AssetClassControllerCreateAssetClassResponses, type AssetClassControllerGetAssetClassListData, type AssetClassControllerGetAssetClassListError, type AssetClassControllerGetAssetClassListErrors, type AssetClassControllerGetAssetClassListResponse, type AssetClassControllerGetAssetClassListResponses, type AssetClassControllerUpdateAssetClassData, type AssetClassControllerUpdateAssetClassError, type AssetClassControllerUpdateAssetClassErrors, type AssetClassControllerUpdateAssetClassResponse, type AssetClassControllerUpdateAssetClassResponses, type AssetClassListResponseDto, type AssetClassResponseDto, type AssetControllerCreateAssetPublicData, type AssetControllerCreateAssetPublicError, type AssetControllerCreateAssetPublicErrors, type AssetControllerCreateAssetPublicResponse, type AssetControllerCreateAssetPublicResponses, type AssetControllerGetAssetData, type AssetControllerGetAssetError, type AssetControllerGetAssetErrors, type AssetControllerGetAssetResponse, type AssetControllerGetAssetResponses, type AssetControllerListAssetsData, type AssetControllerListAssetsError, type AssetControllerListAssetsErrors, type AssetControllerListAssetsResponse, type AssetControllerListAssetsResponses, type AssetControllerUpdateAssetData, type AssetControllerUpdateAssetError, type AssetControllerUpdateAssetErrors, type AssetControllerUpdateAssetResponse, type AssetControllerUpdateAssetResponses, type AssetPropertyControllerDeleteAssetPropertyData, type AssetPropertyControllerDeleteAssetPropertyError, type AssetPropertyControllerDeleteAssetPropertyErrors, type AssetPropertyControllerDeleteAssetPropertyResponse, type AssetPropertyControllerDeleteAssetPropertyResponses, type AssetPropertyControllerUpdateAssetPropertyData, type AssetPropertyControllerUpdateAssetPropertyError, type AssetPropertyControllerUpdateAssetPropertyErrors, type AssetPropertyControllerUpdateAssetPropertyResponse, type AssetPropertyControllerUpdateAssetPropertyResponses, type AssetPropertyResponseDto, type AssetsResource, type
|
|
4577
|
+
export { type ApiErrorBody, type ApiErrorDetail, type ApiErrorResponse, type AssetClassControllerCreateAssetClassData, type AssetClassControllerCreateAssetClassError, type AssetClassControllerCreateAssetClassErrors, type AssetClassControllerCreateAssetClassResponse, type AssetClassControllerCreateAssetClassResponses, type AssetClassControllerGetAssetClassListData, type AssetClassControllerGetAssetClassListError, type AssetClassControllerGetAssetClassListErrors, type AssetClassControllerGetAssetClassListResponse, type AssetClassControllerGetAssetClassListResponses, type AssetClassControllerUpdateAssetClassData, type AssetClassControllerUpdateAssetClassError, type AssetClassControllerUpdateAssetClassErrors, type AssetClassControllerUpdateAssetClassResponse, type AssetClassControllerUpdateAssetClassResponses, type AssetClassListResponseDto, type AssetClassPropertyControllerRemoveData, type AssetClassPropertyControllerRemoveError, type AssetClassPropertyControllerRemoveErrors, type AssetClassPropertyControllerRemoveResponse, type AssetClassPropertyControllerRemoveResponses, type AssetClassPropertyControllerUpdateData, type AssetClassPropertyControllerUpdateError, type AssetClassPropertyControllerUpdateErrors, type AssetClassPropertyControllerUpdateResponse, type AssetClassPropertyControllerUpdateResponses, type AssetClassPropertyResponseDto, type AssetClassResponseDto, type AssetControllerCreateAssetPublicData, type AssetControllerCreateAssetPublicError, type AssetControllerCreateAssetPublicErrors, type AssetControllerCreateAssetPublicResponse, type AssetControllerCreateAssetPublicResponses, type AssetControllerGetAssetData, type AssetControllerGetAssetError, type AssetControllerGetAssetErrors, type AssetControllerGetAssetResponse, type AssetControllerGetAssetResponses, type AssetControllerListAssetsData, type AssetControllerListAssetsError, type AssetControllerListAssetsErrors, type AssetControllerListAssetsResponse, type AssetControllerListAssetsResponses, type AssetControllerUpdateAssetData, type AssetControllerUpdateAssetError, type AssetControllerUpdateAssetErrors, type AssetControllerUpdateAssetResponse, type AssetControllerUpdateAssetResponses, type AssetPropertyControllerDeleteAssetPropertyData, type AssetPropertyControllerDeleteAssetPropertyError, type AssetPropertyControllerDeleteAssetPropertyErrors, type AssetPropertyControllerDeleteAssetPropertyResponse, type AssetPropertyControllerDeleteAssetPropertyResponses, type AssetPropertyControllerUpdateAssetPropertyData, type AssetPropertyControllerUpdateAssetPropertyError, type AssetPropertyControllerUpdateAssetPropertyErrors, type AssetPropertyControllerUpdateAssetPropertyResponse, type AssetPropertyControllerUpdateAssetPropertyResponses, type AssetPropertyResponseDto, type AssetsResource, type ChecklistControllerGetChecklistData, type ChecklistControllerGetChecklistError, type ChecklistControllerGetChecklistErrors, type ChecklistControllerGetChecklistResponse, type ChecklistControllerGetChecklistResponses, type ChecklistControllerListChecklistsData, type ChecklistControllerListChecklistsError, type ChecklistControllerListChecklistsErrors, type ChecklistControllerListChecklistsResponse, type ChecklistControllerListChecklistsResponses, type ChecklistSummaryDto, type ClientOptions, type ConfigItemDto, type ConfigTableDto, type CreateAssetClassDto, type CreateConfigItemDto, type CreateSiteDto, DEFAULT_BASE_URL, type DeleteAssetClassPropertyResponseDto, type DeleteAssetPropertyResponseDto, type DeleteSiteResponseDto, type DeleteUserPropertyResponseDto, type EmbeddedAssetClassPropertyDto, type EmbeddedAssetPropertyDto, type EmbeddedUserPropertyDto, type ErrorDetail, type InspectionControllerGetPublicInspectionData, type InspectionControllerGetPublicInspectionError, type InspectionControllerGetPublicInspectionErrors, type InspectionControllerGetPublicInspectionResponse, type InspectionControllerGetPublicInspectionResponses, type InspectionControllerListInspectionsData, type InspectionControllerListInspectionsError, type InspectionControllerListInspectionsErrors, type InspectionControllerListInspectionsResponse, type InspectionControllerListInspectionsResponses, type InspectionResponseDto, type InspectionsResource, type IssueControllerGetIssueHistoryPublicData, type IssueControllerGetIssueHistoryPublicError, type IssueControllerGetIssueHistoryPublicErrors, type IssueControllerGetIssueHistoryPublicResponse, type IssueControllerGetIssueHistoryPublicResponses, type IssueControllerGetIssuePublicData, type IssueControllerGetIssuePublicError, type IssueControllerGetIssuePublicErrors, type IssueControllerGetIssuePublicResponse, type IssueControllerGetIssuePublicResponses, type IssueControllerListIssuesData, type IssueControllerListIssuesError, type IssueControllerListIssuesErrors, type IssueControllerListIssuesResponse, type IssueControllerListIssuesResponses, type IssueControllerUpdateIssuePublicData, type IssueControllerUpdateIssuePublicError, type IssueControllerUpdateIssuePublicErrors, type IssueControllerUpdateIssuePublicResponse, type IssueControllerUpdateIssuePublicResponses, type IssueHistoryDto, type IssueHistoryResponseDto, type IssueResponseDto, type IssuesResource, type ListChecklistsResponseDto, type ListConfigItemsResponseDto, type ListConfigTablesResponseDto, type ListInspectionsResponseDto, type ListIssuesResponseDto, type ListSitesResponseDto, PACKAGE_NAME, PACKAGE_VERSION, type PublicConfigControllerCreateConfigItemData, type PublicConfigControllerCreateConfigItemError, type PublicConfigControllerCreateConfigItemErrors, type PublicConfigControllerCreateConfigItemResponse, type PublicConfigControllerCreateConfigItemResponses, type PublicConfigControllerDeleteConfigItemData, type PublicConfigControllerDeleteConfigItemError, type PublicConfigControllerDeleteConfigItemErrors, type PublicConfigControllerDeleteConfigItemResponse, type PublicConfigControllerDeleteConfigItemResponses, type PublicConfigControllerGetConfigItemData, type PublicConfigControllerGetConfigItemError, type PublicConfigControllerGetConfigItemErrors, type PublicConfigControllerGetConfigItemResponse, type PublicConfigControllerGetConfigItemResponses, type PublicConfigControllerListConfigItemsData, type PublicConfigControllerListConfigItemsError, type PublicConfigControllerListConfigItemsErrors, type PublicConfigControllerListConfigItemsResponse, type PublicConfigControllerListConfigItemsResponses, type PublicConfigControllerListConfigTablesData, type PublicConfigControllerListConfigTablesError, type PublicConfigControllerListConfigTablesErrors, type PublicConfigControllerListConfigTablesResponse, type PublicConfigControllerListConfigTablesResponses, type PublicConfigControllerUpdateConfigItemData, type PublicConfigControllerUpdateConfigItemError, type PublicConfigControllerUpdateConfigItemErrors, type PublicConfigControllerUpdateConfigItemResponse, type PublicConfigControllerUpdateConfigItemResponses, type PublicCreateAssetDto, type SiteControllerCreateSiteData, type SiteControllerCreateSiteError, type SiteControllerCreateSiteErrors, type SiteControllerCreateSiteResponse, type SiteControllerCreateSiteResponses, type SiteControllerDeleteSiteData, type SiteControllerDeleteSiteError, type SiteControllerDeleteSiteErrors, type SiteControllerDeleteSiteResponse, type SiteControllerDeleteSiteResponses, type SiteControllerListSitesData, type SiteControllerListSitesError, type SiteControllerListSitesErrors, type SiteControllerListSitesResponse, type SiteControllerListSitesResponses, type SiteControllerUpdateSiteData, type SiteControllerUpdateSiteError, type SiteControllerUpdateSiteErrors, type SiteControllerUpdateSiteResponse, type SiteControllerUpdateSiteResponses, type SiteResponseDto, type SitesResource, type UpdateAssetClassDto, type UpdateAssetClassPropertyDto, type UpdateAssetDto, type UpdateAssetPropertyDto, type UpdateConfigItemDto, type UpdateIssueDto, type UpdateSiteDto, type UpdateUserPropertyDto, type UserControllerCreateUserData, type UserControllerCreateUserError, type UserControllerCreateUserErrors, type UserControllerCreateUserResponse, type UserControllerCreateUserResponses, type UserControllerGetUserData, type UserControllerGetUserError, type UserControllerGetUserErrors, type UserControllerGetUserResponse, type UserControllerGetUserResponses, type UserControllerListUsersData, type UserControllerListUsersError, type UserControllerListUsersErrors, type UserControllerListUsersResponse, type UserControllerListUsersResponses, type UserControllerUpdateUserData, type UserControllerUpdateUserError, type UserControllerUpdateUserErrors, type UserControllerUpdateUserResponse, type UserControllerUpdateUserResponses, type UserPropertiesResource, type UserPropertyControllerDeleteUserPropertyData, type UserPropertyControllerDeleteUserPropertyError, type UserPropertyControllerDeleteUserPropertyErrors, type UserPropertyControllerDeleteUserPropertyResponse, type UserPropertyControllerDeleteUserPropertyResponses, type UserPropertyControllerUpdateUserPropertyData, type UserPropertyControllerUpdateUserPropertyError, type UserPropertyControllerUpdateUserPropertyErrors, type UserPropertyControllerUpdateUserPropertyResponse, type UserPropertyControllerUpdateUserPropertyResponses, type UserPropertyResponseDto, type UserResponseDto, type UsersResource, WakataApiError, WakataAuthError, WakataClient, type WakataClientOptions, WakataConflictError, type WakataErrorEnvelope, WakataNotFoundError, WakataPermissionError, WakataRateLimitError, WakataServerError, WakataValidationError, generateIdempotencyKey, mapApiError };
|