@kohost/api-client 4.16.0 → 4.17.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (19) hide show
  1. package/dist/cjs/models/ticket.cjs +3 -4
  2. package/dist/cjs/models/ticket.cjs.map +1 -1
  3. package/dist/cjs/schemas/emailMessage.cjs +6 -2
  4. package/dist/cjs/schemas/emailMessage.cjs.map +1 -1
  5. package/dist/cjs/schemas/emailMessage.d.cts +6 -0
  6. package/dist/cjs/schemas/ticket.cjs +33 -226
  7. package/dist/cjs/schemas/ticket.cjs.map +1 -1
  8. package/dist/cjs/schemas/ticket.d.cts +31 -235
  9. package/dist/cjs/validate.d.cts +9 -0
  10. package/dist/esm/models/ticket.js +3 -4
  11. package/dist/esm/models/ticket.js.map +1 -1
  12. package/dist/esm/schemas/emailMessage.d.ts +6 -0
  13. package/dist/esm/schemas/emailMessage.js +6 -2
  14. package/dist/esm/schemas/emailMessage.js.map +1 -1
  15. package/dist/esm/schemas/ticket.d.ts +31 -235
  16. package/dist/esm/schemas/ticket.js +33 -226
  17. package/dist/esm/schemas/ticket.js.map +1 -1
  18. package/dist/esm/validate.d.ts +9 -0
  19. package/package.json +1 -1
package/dist/esm/schemas/ticket.d.ts CHANGED
@@ -8,7 +8,7 @@ declare const ticketSchema: {
8
8
  readonly title: "Ticket";
9
9
  readonly description: "A ticket is a request from a user.";
10
10
  readonly type: "object";
11
- readonly required: readonly ["id", "conversation", "requester", "status", "tags", "createdAt", "updatedAt"];
11
+ readonly required: readonly ["id", "conversation", "requester", "openedBy", "assignedTo", "status", "priority", "tags", "createdAt", "updatedAt"];
12
12
  readonly additionalProperties: false;
13
13
  readonly properties: {
14
14
  readonly id: {
@@ -34,7 +34,7 @@ declare const ticketSchema: {
34
34
  readonly items: {
35
35
  readonly type: "object";
36
36
  readonly additionalProperties: false;
37
- readonly required: readonly ["id", "discriminator", "timestamp", "body"];
37
+ readonly required: readonly ["id", "discriminator", "timestamp", "body", "author"];
38
38
  readonly properties: {
39
39
  readonly id: {
40
40
  readonly type: "string";
@@ -46,60 +46,25 @@ declare const ticketSchema: {
46
46
  readonly default: "message";
47
47
  readonly description: "The discriminator of the message.";
48
48
  };
49
- readonly authorId: {
50
- readonly type: "string";
51
- readonly description: "The ID of the author of the message.";
52
- };
53
- readonly authorName: {
54
- readonly type: "string";
55
- readonly description: "The name of the author of the message.";
56
- };
57
- readonly authorDiscriminator: {
58
- readonly type: "string";
59
- readonly enum: readonly ["user", "vendor", "system"];
60
- readonly description: "The discriminator of the author of the message.";
61
- };
62
- /**
63
- * @deprecated - use authorId instead.
64
- */
65
- readonly userId: {
66
- readonly type: "string";
67
- readonly description: "@deprecated - use authorId instead. The ID of the user who sent the message.";
68
- };
69
- /**
70
- * @deprecated - use authorName instead.
71
- */
72
- readonly userName: {
73
- readonly type: "string";
74
- readonly description: "@deprecated - use authorName instead. The name of the user who sent the message.";
75
- };
76
- /**
77
- * @deprecated - use authorId instead.
78
- */
79
- readonly vendorId: {
80
- readonly type: "string";
81
- readonly description: "@deprecated - use authorId instead. The ID of the vendor who sent the message.";
82
- };
83
- /**
84
- * @deprecated - use authorName instead.
85
- */
86
- readonly vendorName: {
87
- readonly type: "string";
88
- readonly description: "@deprecated - use authorName instead. The name of the vendor who sent the message.";
89
- };
90
- /**
91
- * @deprecated - use authorId instead.
92
- */
93
- readonly systemId: {
94
- readonly type: "string";
95
- readonly description: "@deprecated - use authorId instead. The ID of the system who sent the message.";
96
- };
97
- /**
98
- * @deprecated - use authorName instead.
99
- */
100
- readonly systemName: {
101
- readonly type: "string";
102
- readonly description: "@deprecated - use authorName instead. The name of the system who sent the message.";
49
+ readonly author: {
50
+ readonly type: "object";
51
+ readonly additionalProperties: false;
52
+ readonly required: readonly ["id", "discriminator", "name"];
53
+ readonly properties: {
54
+ readonly id: {
55
+ readonly type: "string";
56
+ readonly description: "The ID of the author of the message.";
57
+ };
58
+ readonly discriminator: {
59
+ readonly type: "string";
60
+ readonly enum: readonly ["user", "vendor", "system"];
61
+ readonly description: "The discriminator of the author of the message.";
62
+ };
63
+ readonly name: {
64
+ readonly type: "string";
65
+ readonly description: "The name of the author of the message.";
66
+ };
67
+ };
103
68
  };
104
69
  readonly timestamp: {
105
70
  readonly $ref: "definitions.json#/definitions/date";
@@ -177,6 +142,8 @@ declare const ticketSchema: {
177
142
  };
178
143
  readonly openedBy: {
179
144
  readonly type: "object";
145
+ readonly additionalProperties: false;
146
+ readonly required: readonly ["id", "discriminator", "name"];
180
147
  readonly properties: {
181
148
  readonly id: {
182
149
  readonly type: "string";
@@ -188,38 +155,12 @@ declare const ticketSchema: {
188
155
  readonly name: {
189
156
  readonly type: "string";
190
157
  };
191
- /**
192
- * @deprecated - use id instead.
193
- */
194
- readonly userId: {
195
- readonly type: "string";
196
- readonly description: "@deprecated - use id instead. The ID of the user who opened the ticket.";
197
- };
198
- /**
199
- * @deprecated - use name instead.
200
- */
201
- readonly userName: {
202
- readonly type: "string";
203
- readonly description: "@deprecated - use name instead. The name of the user who opened the ticket.";
204
- };
205
- /**
206
- * @deprecated - use id instead.
207
- */
208
- readonly systemId: {
209
- readonly type: "string";
210
- readonly description: "@deprecated - use id instead. The ID of the system who opened the ticket.";
211
- };
212
- /**
213
- * @deprecated - use name instead.
214
- */
215
- readonly systemName: {
216
- readonly type: "string";
217
- readonly description: "@deprecated - use name instead. The name of the system who opened the ticket.";
218
- };
219
158
  };
220
159
  };
221
160
  readonly requester: {
222
161
  readonly type: "object";
162
+ readonly additionalProperties: false;
163
+ readonly required: readonly ["id", "discriminator", "name"];
223
164
  readonly properties: {
224
165
  readonly id: {
225
166
  readonly type: "string";
@@ -244,98 +185,13 @@ declare const ticketSchema: {
244
185
  }];
245
186
  readonly description: "The photo of the requester.";
246
187
  };
247
- /**
248
- * @deprecated - use id instead.
249
- */
250
- readonly systemId: {
251
- readonly type: "string";
252
- readonly description: "@deprecated - use id instead. The ID of the system who requested the ticket.";
253
- };
254
- /**
255
- * @deprecated - use name instead.
256
- */
257
- readonly systemName: {
258
- readonly type: "string";
259
- readonly description: "@deprecated - use name instead. The name of the system who requested the ticket.";
260
- };
261
- /**
262
- * @deprecated - use photo instead.
263
- */
264
- readonly systemPhoto: {
265
- readonly anyOf: readonly [{
266
- readonly $ref: "mediaFile.json";
267
- }, {
268
- readonly type: "null";
269
- }, {
270
- readonly type: "string";
271
- }];
272
- readonly description: "@deprecated - use photo instead. The photo of the system who requested the ticket.";
273
- };
274
- /**
275
- * @deprecated - use id instead.
276
- */
277
- readonly userId: {
278
- readonly type: "string";
279
- readonly description: "@deprecated - use id instead. The ID of the user who requested the ticket.";
280
- };
281
- /**
282
- * @deprecated - use name instead.
283
- */
284
- readonly userName: {
285
- readonly type: "string";
286
- readonly description: "@deprecated - use name instead. The name of the user who requested the ticket.";
287
- };
288
- /**
289
- * @deprecated - use photo instead.
290
- */
291
- readonly userPhoto: {
292
- readonly anyOf: readonly [{
293
- readonly $ref: "mediaFile.json";
294
- }, {
295
- readonly type: "null";
296
- }, {
297
- readonly type: "string";
298
- }];
299
- readonly description: "@deprecated - use photo instead. The photo of the user who requested the ticket.";
300
- };
301
- /**
302
- * @deprecated - use id instead.
303
- */
304
- readonly deviceId: {
305
- readonly type: "string";
306
- };
307
- /**
308
- * @deprecated - This will be removed in a future version.
309
- */
310
- readonly roomId: {
311
- readonly type: "string";
312
- readonly description: "@deprecated - This will be removed in a future version. The ID of the room who requested the ticket.";
313
- };
314
- /**
315
- * @deprecated - This will be removed in a future version.
316
- */
317
- readonly reservationId: {
318
- readonly type: "string";
319
- readonly description: "@deprecated - This will be removed in a future version. The ID of the reservation who requested the ticket.";
320
- };
321
- /**
322
- * @deprecated - This will be removed in a future version.
323
- */
324
- readonly spaceId: {
325
- readonly type: "string";
326
- readonly description: "@deprecated - This will be removed in a future version. The ID of the space who requested the ticket.";
327
- };
328
- /**
329
- * @deprecated - This will be removed in a future version.
330
- */
331
- readonly spaceName: {
332
- readonly type: "string";
333
- readonly description: "@deprecated - This will be removed in a future version. The name of the space who requested the ticket.";
334
- };
335
188
  };
336
189
  };
337
190
  readonly assignedTo: {
338
- readonly type: "object";
191
+ readonly type: readonly ["object", "null"];
192
+ readonly default: null;
193
+ readonly additionalProperties: false;
194
+ readonly required: readonly ["id", "discriminator", "name"];
339
195
  readonly properties: {
340
196
  readonly id: {
341
197
  readonly type: "string";
@@ -360,59 +216,6 @@ declare const ticketSchema: {
360
216
  }];
361
217
  readonly description: "The photo of the assigned to.";
362
218
  };
363
- /**
364
- * @deprecated - use id instead.
365
- */
366
- readonly userId: {
367
- readonly type: "string";
368
- readonly description: "@deprecated - use id instead. The ID of the user who assigned the ticket.";
369
- };
370
- /**
371
- * @deprecated - use name instead.
372
- */
373
- readonly userName: {
374
- readonly type: "string";
375
- readonly description: "@deprecated - use name instead. The name of the user who assigned the ticket.";
376
- };
377
- /**
378
- * @deprecated - use photo instead.
379
- */
380
- readonly userPhoto: {
381
- readonly anyOf: readonly [{
382
- readonly $ref: "mediaFile.json";
383
- }, {
384
- readonly type: "null";
385
- }, {
386
- readonly type: "string";
387
- }];
388
- };
389
- /**
390
- * @deprecated - use id instead.
391
- */
392
- readonly vendorId: {
393
- readonly type: "string";
394
- readonly description: "@deprecated - use id instead. The ID of the vendor who assigned the ticket.";
395
- };
396
- /**
397
- * @deprecated - use name instead.
398
- */
399
- readonly vendorName: {
400
- readonly type: "string";
401
- readonly description: "@deprecated - use name instead. The name of the vendor who assigned the ticket.";
402
- };
403
- /**
404
- * @deprecated - use photo instead.
405
- */
406
- readonly vendorPhoto: {
407
- readonly anyOf: readonly [{
408
- readonly $ref: "mediaFile.json";
409
- }, {
410
- readonly type: "null";
411
- }, {
412
- readonly type: "string";
413
- }];
414
- readonly description: "@deprecated - use photo instead. The photo of the vendor who assigned the ticket.";
415
- };
416
219
  };
417
220
  };
418
221
  readonly notify: {
@@ -467,7 +270,7 @@ declare const ticketSchema: {
467
270
  };
468
271
  readonly discriminator: {
469
272
  readonly type: "string";
470
- readonly enum: readonly ["space", "room", "property", "customText"];
273
+ readonly enum: readonly ["space", "property", "customText"];
471
274
  };
472
275
  readonly name: {
473
276
  readonly type: "string";
@@ -481,7 +284,7 @@ declare const ticketSchema: {
481
284
  };
482
285
  readonly priority: {
483
286
  readonly type: "string";
484
- readonly enum: readonly ["low", "normal", "high"];
287
+ readonly enum: readonly ["low", "normal", "high", "critical"];
485
288
  readonly default: "normal";
486
289
  };
487
290
  readonly tags: {
@@ -499,13 +302,6 @@ declare const ticketSchema: {
499
302
  readonly ratingComment: {
500
303
  readonly type: "string";
501
304
  };
502
- /**
503
- * @deprecated - This will be removed in a future version.
504
- */
505
- readonly tipAmount: {
506
- readonly type: "string";
507
- readonly description: "@deprecated - This will be removed in a future version. The amount of the tip.";
508
- };
509
305
  readonly autoCloseAt: {
510
306
  readonly $ref: "definitions.json#/definitions/date";
511
307
  };
package/dist/esm/schemas/ticket.js CHANGED
@@ -8,7 +8,10 @@ const ticketSchema = {
8
8
  "id",
9
9
  "conversation",
10
10
  "requester",
11
+ "openedBy",
12
+ "assignedTo",
11
13
  "status",
14
+ "priority",
12
15
  "tags",
13
16
  "createdAt",
14
17
  "updatedAt"
@@ -38,7 +41,7 @@ const ticketSchema = {
38
41
  items: {
39
42
  type: "object",
40
43
  additionalProperties: false,
41
- required: ["id", "discriminator", "timestamp", "body"],
44
+ required: ["id", "discriminator", "timestamp", "body", "author"],
42
45
  properties: {
43
46
  id: {
44
47
  type: "string",
@@ -63,60 +66,25 @@ const ticketSchema = {
63
66
  default: "message",
64
67
  description: "The discriminator of the message."
65
68
  },
66
- authorId: {
67
- type: "string",
68
- description: "The ID of the author of the message."
69
- },
70
- authorName: {
71
- type: "string",
72
- description: "The name of the author of the message."
73
- },
74
- authorDiscriminator: {
75
- type: "string",
76
- enum: ["user", "vendor", "system"],
77
- description: "The discriminator of the author of the message."
78
- },
79
- /**
80
- * @deprecated - use authorId instead.
81
- */
82
- userId: {
83
- type: "string",
84
- description: "@deprecated - use authorId instead. The ID of the user who sent the message."
85
- },
86
- /**
87
- * @deprecated - use authorName instead.
88
- */
89
- userName: {
90
- type: "string",
91
- description: "@deprecated - use authorName instead. The name of the user who sent the message."
92
- },
93
- /**
94
- * @deprecated - use authorId instead.
95
- */
96
- vendorId: {
97
- type: "string",
98
- description: "@deprecated - use authorId instead. The ID of the vendor who sent the message."
99
- },
100
- /**
101
- * @deprecated - use authorName instead.
102
- */
103
- vendorName: {
104
- type: "string",
105
- description: "@deprecated - use authorName instead. The name of the vendor who sent the message."
106
- },
107
- /**
108
- * @deprecated - use authorId instead.
109
- */
110
- systemId: {
111
- type: "string",
112
- description: "@deprecated - use authorId instead. The ID of the system who sent the message."
113
- },
114
- /**
115
- * @deprecated - use authorName instead.
116
- */
117
- systemName: {
118
- type: "string",
119
- description: "@deprecated - use authorName instead. The name of the system who sent the message."
69
+ author: {
70
+ type: "object",
71
+ additionalProperties: false,
72
+ required: ["id", "discriminator", "name"],
73
+ properties: {
74
+ id: {
75
+ type: "string",
76
+ description: "The ID of the author of the message."
77
+ },
78
+ discriminator: {
79
+ type: "string",
80
+ enum: ["user", "vendor", "system"],
81
+ description: "The discriminator of the author of the message."
82
+ },
83
+ name: {
84
+ type: "string",
85
+ description: "The name of the author of the message."
86
+ }
87
+ }
120
88
  },
121
89
  timestamp: {
122
90
  $ref: "definitions.json#/definitions/date",
@@ -196,6 +164,8 @@ const ticketSchema = {
196
164
  },
197
165
  openedBy: {
198
166
  type: "object",
167
+ additionalProperties: false,
168
+ required: ["id", "discriminator", "name"],
199
169
  properties: {
200
170
  id: {
201
171
  type: "string"
@@ -206,39 +176,13 @@ const ticketSchema = {
206
176
  },
207
177
  name: {
208
178
  type: "string"
209
- },
210
- /**
211
- * @deprecated - use id instead.
212
- */
213
- userId: {
214
- type: "string",
215
- description: "@deprecated - use id instead. The ID of the user who opened the ticket."
216
- },
217
- /**
218
- * @deprecated - use name instead.
219
- */
220
- userName: {
221
- type: "string",
222
- description: "@deprecated - use name instead. The name of the user who opened the ticket."
223
- },
224
- /**
225
- * @deprecated - use id instead.
226
- */
227
- systemId: {
228
- type: "string",
229
- description: "@deprecated - use id instead. The ID of the system who opened the ticket."
230
- },
231
- /**
232
- * @deprecated - use name instead.
233
- */
234
- systemName: {
235
- type: "string",
236
- description: "@deprecated - use name instead. The name of the system who opened the ticket."
237
179
  }
238
180
  }
239
181
  },
240
182
  requester: {
241
183
  type: "object",
184
+ additionalProperties: false,
185
+ required: ["id", "discriminator", "name"],
242
186
  properties: {
243
187
  id: {
244
188
  type: "string",
@@ -260,95 +204,14 @@ const ticketSchema = {
260
204
  { type: "string" }
261
205
  ],
262
206
  description: "The photo of the requester."
263
- },
264
- /**
265
- * @deprecated - use id instead.
266
- */
267
- systemId: {
268
- type: "string",
269
- description: "@deprecated - use id instead. The ID of the system who requested the ticket."
270
- },
271
- /**
272
- * @deprecated - use name instead.
273
- */
274
- systemName: {
275
- type: "string",
276
- description: "@deprecated - use name instead. The name of the system who requested the ticket."
277
- },
278
- /**
279
- * @deprecated - use photo instead.
280
- */
281
- systemPhoto: {
282
- anyOf: [
283
- { $ref: "mediaFile.json" },
284
- { type: "null" },
285
- { type: "string" }
286
- ],
287
- description: "@deprecated - use photo instead. The photo of the system who requested the ticket."
288
- },
289
- /**
290
- * @deprecated - use id instead.
291
- */
292
- userId: {
293
- type: "string",
294
- description: "@deprecated - use id instead. The ID of the user who requested the ticket."
295
- },
296
- /**
297
- * @deprecated - use name instead.
298
- */
299
- userName: {
300
- type: "string",
301
- description: "@deprecated - use name instead. The name of the user who requested the ticket."
302
- },
303
- /**
304
- * @deprecated - use photo instead.
305
- */
306
- userPhoto: {
307
- anyOf: [
308
- { $ref: "mediaFile.json" },
309
- { type: "null" },
310
- { type: "string" }
311
- ],
312
- description: "@deprecated - use photo instead. The photo of the user who requested the ticket."
313
- },
314
- /**
315
- * @deprecated - use id instead.
316
- */
317
- deviceId: {
318
- type: "string"
319
- },
320
- /**
321
- * @deprecated - This will be removed in a future version.
322
- */
323
- roomId: {
324
- type: "string",
325
- description: "@deprecated - This will be removed in a future version. The ID of the room who requested the ticket."
326
- },
327
- /**
328
- * @deprecated - This will be removed in a future version.
329
- */
330
- reservationId: {
331
- type: "string",
332
- description: "@deprecated - This will be removed in a future version. The ID of the reservation who requested the ticket."
333
- },
334
- /**
335
- * @deprecated - This will be removed in a future version.
336
- */
337
- spaceId: {
338
- type: "string",
339
- description: "@deprecated - This will be removed in a future version. The ID of the space who requested the ticket."
340
- },
341
- /**
342
- * @deprecated - This will be removed in a future version.
343
- */
344
- spaceName: {
345
- type: "string",
346
- description: "@deprecated - This will be removed in a future version. The name of the space who requested the ticket."
347
207
  }
348
208
  }
349
209
  },
350
210
  assignedTo: {
351
- type: "object",
211
+ type: ["object", "null"],
212
+ default: null,
213
+ additionalProperties: false,
214
+ required: ["id", "discriminator", "name"],
352
215
  properties: {
353
216
  id: {
354
217
  type: "string",
@@ -370,55 +233,6 @@ const ticketSchema = {
370
233
  { type: "string" }
371
234
  ],
372
235
  description: "The photo of the assigned to."
373
- },
374
- /**
375
- * @deprecated - use id instead.
376
- */
377
- userId: {
378
- type: "string",
379
- description: "@deprecated - use id instead. The ID of the user who assigned the ticket."
380
- },
381
- /**
382
- * @deprecated - use name instead.
383
- */
384
- userName: {
385
- type: "string",
386
- description: "@deprecated - use name instead. The name of the user who assigned the ticket."
387
- },
388
- /**
389
- * @deprecated - use photo instead.
390
- */
391
- userPhoto: {
392
- anyOf: [
393
- { $ref: "mediaFile.json" },
394
- { type: "null" },
395
- { type: "string" }
396
- ]
397
- },
398
- /**
399
- * @deprecated - use id instead.
400
- */
401
- vendorId: {
402
- type: "string",
403
- description: "@deprecated - use id instead. The ID of the vendor who assigned the ticket."
404
- },
405
- /**
406
- * @deprecated - use name instead.
407
- */
408
- vendorName: {
409
- type: "string",
410
- description: "@deprecated - use name instead. The name of the vendor who assigned the ticket."
411
- },
412
- /**
413
- * @deprecated - use photo instead.
414
- */
415
- vendorPhoto: {
416
- anyOf: [
417
- { $ref: "mediaFile.json" },
418
- { type: "null" },
419
- { type: "string" }
420
- ],
421
- description: "@deprecated - use photo instead. The photo of the vendor who assigned the ticket."
422
236
  }
423
237
  }
424
238
  },
@@ -474,7 +288,7 @@ const ticketSchema = {
474
288
  },
475
289
  discriminator: {
476
290
  type: "string",
477
- enum: ["space", "room", "property", "customText"]
291
+ enum: ["space", "property", "customText"]
478
292
  },
479
293
  name: {
480
294
  type: "string"
@@ -488,7 +302,7 @@ const ticketSchema = {
488
302
  },
489
303
  priority: {
490
304
  type: "string",
491
- enum: ["low", "normal", "high"],
305
+ enum: ["low", "normal", "high", "critical"],
492
306
  default: "normal"
493
307
  },
494
308
  tags: {
@@ -506,13 +320,6 @@ const ticketSchema = {
506
320
  ratingComment: {
507
321
  type: "string"
508
322
  },
509
- /**
510
- * @deprecated - This will be removed in a future version.
511
- */
512
- tipAmount: {
513
- type: "string",
514
- description: "@deprecated - This will be removed in a future version. The amount of the tip."
515
- },
516
323
  autoCloseAt: {
517
324
  $ref: "definitions.json#/definitions/date"
518
325
  },