@seamapi/types 1.360.0 → 1.360.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 (31) hide show
  1. package/dist/connect.cjs +899 -569
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +3626 -2951
  4. package/lib/seam/connect/models/acs/acs-credential.js +94 -51
  5. package/lib/seam/connect/models/acs/acs-credential.js.map +1 -1
  6. package/lib/seam/connect/models/acs/acs-encoder.js +12 -7
  7. package/lib/seam/connect/models/acs/acs-encoder.js.map +1 -1
  8. package/lib/seam/connect/models/acs/acs-entrance.js +37 -14
  9. package/lib/seam/connect/models/acs/acs-entrance.js.map +1 -1
  10. package/lib/seam/connect/models/acs/acs-system.js +48 -41
  11. package/lib/seam/connect/models/acs/acs-system.js.map +1 -1
  12. package/lib/seam/connect/models/acs/acs-user.js +45 -32
  13. package/lib/seam/connect/models/acs/acs-user.js.map +1 -1
  14. package/lib/seam/connect/models/thermostats/climate-preset.js +12 -10
  15. package/lib/seam/connect/models/thermostats/climate-preset.js.map +1 -1
  16. package/lib/seam/connect/models/thermostats/thermostat-schedule.js +19 -12
  17. package/lib/seam/connect/models/thermostats/thermostat-schedule.js.map +1 -1
  18. package/lib/seam/connect/openapi.d.ts +45 -23
  19. package/lib/seam/connect/openapi.js +557 -401
  20. package/lib/seam/connect/openapi.js.map +1 -1
  21. package/lib/seam/connect/route-types.d.ts +3581 -2928
  22. package/package.json +1 -1
  23. package/src/lib/seam/connect/models/acs/acs-credential.ts +162 -51
  24. package/src/lib/seam/connect/models/acs/acs-encoder.ts +22 -7
  25. package/src/lib/seam/connect/models/acs/acs-entrance.ts +65 -18
  26. package/src/lib/seam/connect/models/acs/acs-system.ts +81 -52
  27. package/src/lib/seam/connect/models/acs/acs-user.ts +69 -32
  28. package/src/lib/seam/connect/models/thermostats/climate-preset.ts +28 -10
  29. package/src/lib/seam/connect/models/thermostats/thermostat-schedule.ts +31 -12
  30. package/src/lib/seam/connect/openapi.ts +698 -401
  31. package/src/lib/seam/connect/route-types.ts +3581 -2928
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.360.0",
3
+ "version": "1.360.1",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -47,7 +47,9 @@ const waiting_to_be_issued = common_acs_credential_warning
47
47
  .literal('waiting_to_be_issued')
48
48
  .describe(warning_code_description),
49
49
  })
50
- .describe('Indicates that the credential is waiting to be issued.')
50
+ .describe(
51
+ 'Indicates that the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is waiting to be issued.',
52
+ )
51
53
 
52
54
  const schedule_externally_modified = common_acs_credential_warning
53
55
  .extend({
@@ -56,7 +58,7 @@ const schedule_externally_modified = common_acs_credential_warning
56
58
  .describe(warning_code_description),
57
59
  })
58
60
  .describe(
59
- "Indicates that the schedule of one of the credential's children was modified externally.",
61
+ "Indicates that the schedule of one of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)'s children was modified externally.",
60
62
  )
61
63
 
62
64
  const schedule_modified = common_acs_credential_warning
@@ -66,14 +68,16 @@ const schedule_modified = common_acs_credential_warning
66
68
  .describe(warning_code_description),
67
69
  })
68
70
  .describe(
69
- 'Indicates that the schedule of this credential was modified to avoid creating a credential with a start date in the past.',
71
+ 'Indicates that the schedule of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was modified to avoid creating a credential with a start date in the past.',
70
72
  )
71
73
 
72
74
  const being_deleted = common_acs_credential_warning
73
75
  .extend({
74
76
  warning_code: z.literal('being_deleted').describe(warning_code_description),
75
77
  })
76
- .describe('Indicates that this credential is being deleted.')
78
+ .describe(
79
+ 'Indicates that the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is being deleted.',
80
+ )
77
81
 
78
82
  export const unknown_issue_with_acs_credential = common_acs_credential_warning
79
83
  .extend({
@@ -82,8 +86,8 @@ export const unknown_issue_with_acs_credential = common_acs_credential_warning
82
86
  .describe(warning_code_description),
83
87
  })
84
88
  .describe(
85
- 'An unknown issue occurred while syncing the state of this credential with the provider. ' +
86
- 'This issue may affect the proper functioning of this credential.',
89
+ 'An unknown issue occurred while syncing the state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) with the provider. ' +
90
+ 'This issue may affect the proper functioning of the credential.',
87
91
  )
88
92
 
89
93
  const needs_to_be_reissued = common_acs_credential_warning
@@ -93,7 +97,7 @@ const needs_to_be_reissued = common_acs_credential_warning
93
97
  .describe(warning_code_description),
94
98
  })
95
99
  .describe(
96
- 'Access permissions for this [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) have changed. [Reissue](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials) (re-encode) this credential. This issue may affect the proper functioning of the credential.',
100
+ 'Access permissions for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) have changed. [Reissue](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials) (re-encode) the credential. This issue may affect the proper functioning of the credential.',
97
101
  )
98
102
 
99
103
  const acs_credential_warning = z
@@ -105,7 +109,9 @@ const acs_credential_warning = z
105
109
  unknown_issue_with_acs_credential,
106
110
  needs_to_be_reissued,
107
111
  ])
108
- .describe('Warning associated with the `acs_credential`.')
112
+ .describe(
113
+ 'Warning associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
114
+ )
109
115
 
110
116
  const acs_credential_warning_map = z.object({
111
117
  waiting_to_be_issued: waiting_to_be_issued.optional().nullable(),
@@ -123,75 +129,110 @@ const acs_credential_warning_map = z.object({
123
129
  export type AcsCredentialWarningMap = z.infer<typeof acs_credential_warning_map>
124
130
 
125
131
  const common_acs_credential = z.object({
126
- acs_credential_id: z.string().uuid().describe('ID of the credential.'),
132
+ acs_credential_id: z
133
+ .string()
134
+ .uuid()
135
+ .describe(
136
+ 'ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
137
+ ),
127
138
  acs_user_id: z
128
139
  .string()
129
140
  .uuid()
130
141
  .optional()
131
- .describe('ID of the ACS user to whom the credential belongs.'),
142
+ .describe(
143
+ 'ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs.',
144
+ ),
132
145
  acs_credential_pool_id: z.string().uuid().optional(),
133
146
  acs_system_id: z
134
147
  .string()
135
148
  .uuid()
136
- .describe('ID of the access control system that contains the credential.'),
149
+ .describe(
150
+ 'ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
151
+ ),
137
152
  parent_acs_credential_id: z
138
153
  .string()
139
154
  .uuid()
140
155
  .optional()
141
- .describe('ID of the parent credential.'),
156
+ .describe(
157
+ 'ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
158
+ ),
142
159
  display_name: z
143
160
  .string()
144
161
  .min(1)
145
- .describe('Display name that corresponds to the credential type.'),
162
+ .describe(
163
+ 'Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type.',
164
+ ),
146
165
  code: z
147
166
  .string()
148
167
  .optional()
149
168
  .nullable()
150
- .describe('Access (PIN) code for the credential.'),
169
+ .describe(
170
+ 'Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
171
+ ),
151
172
  is_one_time_use: z
152
173
  .boolean()
153
174
  .optional()
154
175
  .describe(
155
- 'Indicates whether the credential can only be used once. If "true," the code becomes invalid after the first use.',
176
+ 'Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) can only be used once. If `true`, the code becomes invalid after the first use.',
177
+ ),
178
+ card_number: z
179
+ .string()
180
+ .optional()
181
+ .nullable()
182
+ .describe(
183
+ 'Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
184
+ ),
185
+ is_issued: z
186
+ .boolean()
187
+ .optional()
188
+ .describe(
189
+ 'Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card.',
190
+ ),
191
+ issued_at: z
192
+ .string()
193
+ .datetime()
194
+ .optional()
195
+ .nullable()
196
+ .describe(
197
+ 'Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card.',
156
198
  ),
157
- card_number: z.string().optional().nullable(),
158
- is_issued: z.boolean().optional(),
159
- issued_at: z.string().datetime().optional().nullable(),
160
199
  access_method: acs_credential_access_method_type.describe(
161
- 'Access method for the credential. Supported values: `code`, `card`, `mobile_key`.',
200
+ 'Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`.',
162
201
  ),
163
202
  external_type: acs_credential_external_type
164
203
  .optional()
165
204
  .describe(
166
- 'Brand-specific terminology for the credential type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`.',
205
+ 'Brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`.',
167
206
  ),
168
207
  external_type_display_name: z
169
208
  .string()
170
209
  .optional()
171
210
  .describe(
172
- 'Display name that corresponds to the brand-specific terminology for the credential type.',
211
+ 'Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type.',
173
212
  ),
174
213
  created_at: z
175
214
  .string()
176
215
  .datetime()
177
- .describe('Date and time at which the credential was created.'),
216
+ .describe(
217
+ 'Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created.',
218
+ ),
178
219
  workspace_id: z
179
220
  .string()
180
221
  .uuid()
181
222
  .describe(
182
- 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the credential.',
223
+ 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
183
224
  ),
184
225
  starts_at: z
185
226
  .string()
186
227
  .optional()
187
228
  .describe(
188
- 'Date and time at which the credential validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
229
+ 'Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
189
230
  ),
190
231
  ends_at: z
191
232
  .string()
192
233
  .optional()
193
234
  .describe(
194
- 'Date and time at which the credential validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.',
235
+ 'Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.',
195
236
  ),
196
237
  errors: z
197
238
  .array(
@@ -200,22 +241,26 @@ const common_acs_credential = z.object({
200
241
  message: z.string(),
201
242
  }),
202
243
  )
203
- .describe('Errors associated with the `acs_credential`.'),
244
+ .describe(
245
+ 'Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
246
+ ),
204
247
  warnings: z
205
248
  .array(acs_credential_warning)
206
- .describe('Warnings associated with the `acs_credential`.'),
249
+ .describe(
250
+ 'Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
251
+ ),
207
252
  is_multi_phone_sync_credential: z
208
253
  .boolean()
209
254
  .optional()
210
255
  .describe(
211
- 'Indicates whether the credential is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).',
256
+ 'Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).',
212
257
  ),
213
258
  is_latest_desired_state_synced_with_provider: z
214
259
  .boolean()
215
260
  .nullable()
216
261
  .optional()
217
262
  .describe(
218
- 'Indicates whether the latest state of the credential has been synced from Seam to the provider.',
263
+ 'Indicates whether the latest state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been synced from Seam to the provider.',
219
264
  ),
220
265
  latest_desired_state_synced_with_provider_at: z
221
266
  .string()
@@ -223,14 +268,18 @@ const common_acs_credential = z.object({
223
268
  .nullable()
224
269
  .optional()
225
270
  .describe(
226
- 'Date and time at which the state of the credential was most recently synced from Seam to the provider.',
271
+ 'Date and time at which the state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was most recently synced from Seam to the provider.',
227
272
  ),
228
273
  visionline_metadata: acs_credential_visionline_metadata
229
274
  .optional()
230
- .describe('Visionline-specific metadata for the credential.'),
275
+ .describe(
276
+ 'Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
277
+ ),
231
278
  assa_abloy_vostio_metadata: acs_credential_vostio_metadata
232
279
  .optional()
233
- .describe('Vostio-specific metadata for the credential.'),
280
+ .describe(
281
+ 'Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
282
+ ),
234
283
  })
235
284
 
236
285
  export const acs_credential = common_acs_credential.merge(
@@ -241,7 +290,7 @@ export const acs_credential = common_acs_credential.merge(
241
290
  ---
242
291
  route_path: /acs/credentials
243
292
  ---
244
- Means by which a user gains access at an entrance. The \`acs_credential\` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code.
293
+ Means by which an [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). The \`acs_credential\` object represents a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). For each \`acs_credential\` object, you define the access method. You can also specify additional properties, such as a PIN code.
245
294
  `)
246
295
 
247
296
  export const unmanaged_acs_credential = common_acs_credential.merge(
@@ -252,7 +301,7 @@ export const unmanaged_acs_credential = common_acs_credential.merge(
252
301
  ---
253
302
  route_path: /acs/credentials/unmanaged
254
303
  ---
255
- Means by which a user gains access at an entrance. The \`unmanaged_acs_credential\` object, which is not managed by Seam, represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code.
304
+ Means by which an [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). The \`unmanaged_acs_credential\` object, which is not managed by Seam, represents a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). For each \`acs_credential\` object, you define the access method. You can also specify additional properties, such as a PIN code.
256
305
  `)
257
306
 
258
307
  export const acs_credential_on_encoder = z.object({
@@ -260,7 +309,9 @@ export const acs_credential_on_encoder = z.object({
260
309
  .string()
261
310
  .datetime()
262
311
  .nullable()
263
- .describe('Date and time the credential was created.'),
312
+ .describe(
313
+ 'Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created.',
314
+ ),
264
315
 
265
316
  is_issued: z.boolean().nullable(),
266
317
 
@@ -268,40 +319,100 @@ export const acs_credential_on_encoder = z.object({
268
319
  .string()
269
320
  .datetime()
270
321
  .nullable()
271
- .describe('Date and time the credential will become useable.'),
322
+ .describe(
323
+ 'Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) becomes usable.',
324
+ ),
272
325
  ends_at: z
273
326
  .string()
274
327
  .datetime()
275
328
  .nullable()
276
- .describe('Date and time the credential will stop being useable.'),
329
+ .describe(
330
+ 'Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) will stop being usable.',
331
+ ),
277
332
 
278
333
  card_number: z
279
334
  .string()
280
335
  .nullable()
281
- .describe('A number or string that physically identifies this card.'),
336
+ .describe(
337
+ 'A number or string that physically identifies the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
338
+ ),
282
339
 
283
340
  visionline_metadata: z
284
341
  .object({
285
- card_id: z.string(),
342
+ card_id: z
343
+ .string()
344
+ .describe(
345
+ 'Card ID for the Visionline card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
346
+ ),
286
347
  // TODO card_function_type: z.enum(["guest", "staff"]), // computed, looks at door ops, and checks is guest op is present.
287
348
 
288
- cancelled: z.boolean(),
289
- discarded: z.boolean(),
290
- expired: z.boolean(),
291
- overwritten: z.boolean(),
292
- overridden: z.boolean().optional(),
293
- pending_auto_update: z.boolean(),
349
+ cancelled: z
350
+ .boolean()
351
+ .describe(
352
+ 'Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is cancelled.',
353
+ ),
354
+ discarded: z
355
+ .boolean()
356
+ .describe(
357
+ 'Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is discarded.',
358
+ ),
359
+ expired: z
360
+ .boolean()
361
+ .describe(
362
+ 'Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is expired.',
363
+ ),
364
+ overwritten: z
365
+ .boolean()
366
+ .describe(
367
+ 'Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is overwritten.',
368
+ ),
369
+ overridden: z
370
+ .boolean()
371
+ .optional()
372
+ .describe(
373
+ 'Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is overridden.',
374
+ ),
375
+ pending_auto_update: z
376
+ .boolean()
377
+ .describe(
378
+ 'Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is pending auto-update.',
379
+ ),
294
380
 
295
- card_format: z.enum(['TLCode', 'rfid48']),
296
- card_holder: z.string().optional(),
381
+ card_format: z
382
+ .enum(['TLCode', 'rfid48'])
383
+ .describe(
384
+ 'Format of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
385
+ ),
386
+ card_holder: z
387
+ .string()
388
+ .optional()
389
+ .describe(
390
+ 'Holden of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
391
+ ),
297
392
 
298
- number_of_issued_cards: z.number(),
393
+ number_of_issued_cards: z
394
+ .number()
395
+ .describe(
396
+ 'Number of issued cards associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
397
+ ),
299
398
 
300
- guest_acs_entrance_ids: z.array(z.string().uuid()).optional(),
301
- common_acs_entrance_ids: z.array(z.string().uuid()).optional(),
399
+ guest_acs_entrance_ids: z
400
+ .array(z.string().uuid())
401
+ .optional()
402
+ .describe(
403
+ 'IDs of the guest [entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
404
+ ),
405
+ common_acs_entrance_ids: z
406
+ .array(z.string().uuid())
407
+ .optional()
408
+ .describe(
409
+ 'IDs of the common [entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
410
+ ),
302
411
  })
303
412
  .optional()
304
- .describe('Visionline-specific metadata for the credential.'),
413
+ .describe(
414
+ 'Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
415
+ ),
305
416
  })
306
417
 
307
418
  export type AcsCredential = z.output<typeof acs_credential>
@@ -23,7 +23,9 @@ const acs_encoder_error =
23
23
  // z.union([
24
24
  acs_encoder_removed
25
25
  // ])
26
- .describe('Error associated with the `acs_encoder`.')
26
+ .describe(
27
+ 'Error associated with the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).',
28
+ )
27
29
 
28
30
  const acs_encoder_error_map = z.object({
29
31
  acs_encoder_removed: acs_encoder_removed.optional().nullable(),
@@ -32,27 +34,40 @@ const acs_encoder_error_map = z.object({
32
34
  export type AcsEncoderErrorMap = z.infer<typeof acs_encoder_error_map>
33
35
 
34
36
  export const acs_encoder = z.object({
35
- acs_encoder_id: z.string().uuid().describe('ID of the `acs_encoder`.'),
37
+ acs_encoder_id: z
38
+ .string()
39
+ .uuid()
40
+ .describe(
41
+ 'ID of the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners.',
42
+ ),
36
43
  acs_system_id: z
37
44
  .string()
38
45
  .uuid()
39
46
  .describe(
40
- 'ID of the access control system that contains the `acs_encoder`.',
47
+ 'ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).',
41
48
  ),
42
49
  workspace_id: z
43
50
  .string()
44
51
  .uuid()
45
52
  .describe(
46
- 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `acs_system`.',
53
+ 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).',
47
54
  ),
48
55
  errors: z
49
56
  .array(acs_encoder_error)
50
- .describe('Errors associated with the `acs_encoder`.'),
57
+ .describe(
58
+ 'Errors associated with the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).',
59
+ ),
51
60
  created_at: z
52
61
  .string()
53
62
  .datetime()
54
- .describe('Date and time at which the `acs_encoder` was created.'),
55
- display_name: z.string().describe('Display name for the `acs_encoder`.'),
63
+ .describe(
64
+ 'Date and time at which the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners) was created.',
65
+ ),
66
+ display_name: z
67
+ .string()
68
+ .describe(
69
+ 'Display name for the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).',
70
+ ),
56
71
  }).describe(`
57
72
  ---
58
73
  route_path: /acs/encoders
@@ -13,27 +13,74 @@ export const acs_entrance = z.object({
13
13
  acs_system_id: z
14
14
  .string()
15
15
  .uuid()
16
- .describe('ID of the access control system that contains the entrance.'),
17
- acs_entrance_id: z.string().uuid().describe('ID of the entrance.'),
16
+ .describe(
17
+ 'ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
18
+ ),
19
+ acs_entrance_id: z
20
+ .string()
21
+ .uuid()
22
+ .describe(
23
+ 'ID of the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
24
+ ),
18
25
  created_at: z
19
26
  .string()
20
27
  .datetime()
21
- .describe('Date and time at which the entrance was created.'),
22
- display_name: z.string().describe('Display name for the entrance.'),
23
- errors: z.array(
24
- z.object({
25
- error_code: z.string(),
26
- message: z.string(),
27
- }),
28
- ),
29
- latch_metadata: acs_entrance_latch_metadata.optional(),
30
- visionline_metadata: acs_entrance_visionline_metadata.optional(),
31
- salto_ks_metadata: acs_entrance_salto_ks_metadata.optional(),
32
- dormakaba_community_metadata:
33
- acs_entrance_dormakaba_community_metadata.optional(),
34
- assa_abloy_vostio_metadata:
35
- acs_entrance_assa_abloy_vostio_metadata.optional(),
36
- salto_space_metadata: acs_entrance_salto_space_metadata.optional(),
28
+ .describe(
29
+ 'Date and time at which the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) was created.',
30
+ ),
31
+ display_name: z
32
+ .string()
33
+ .describe(
34
+ 'Display name for the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
35
+ ),
36
+ errors: z
37
+ .array(
38
+ z.object({
39
+ error_code: z
40
+ .string()
41
+ .describe(
42
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
43
+ ),
44
+ message: z
45
+ .string()
46
+ .describe(
47
+ 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
48
+ ),
49
+ }),
50
+ )
51
+ .describe(
52
+ 'Errors associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
53
+ ),
54
+ latch_metadata: acs_entrance_latch_metadata
55
+ .optional()
56
+ .describe(
57
+ 'Latch-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
58
+ ),
59
+ visionline_metadata: acs_entrance_visionline_metadata
60
+ .optional()
61
+ .describe(
62
+ 'Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
63
+ ),
64
+ salto_ks_metadata: acs_entrance_salto_ks_metadata
65
+ .optional()
66
+ .describe(
67
+ 'Salto KS-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
68
+ ),
69
+ dormakaba_community_metadata: acs_entrance_dormakaba_community_metadata
70
+ .optional()
71
+ .describe(
72
+ 'dormakaba Community-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
73
+ ),
74
+ assa_abloy_vostio_metadata: acs_entrance_assa_abloy_vostio_metadata
75
+ .optional()
76
+ .describe(
77
+ 'ASSA ABLOY Vostio-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
78
+ ),
79
+ salto_space_metadata: acs_entrance_salto_space_metadata
80
+ .optional()
81
+ .describe(
82
+ 'Salto Space-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
83
+ ),
37
84
  }).describe(`
38
85
  ---
39
86
  route_path: /acs/entrances