@seamapi/types 1.48.0 → 1.50.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (39) hide show
  1. package/dist/connect.cjs +333 -38
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +477 -17
  4. package/lib/seam/connect/openapi.d.ts +269 -3
  5. package/lib/seam/connect/openapi.js +332 -37
  6. package/lib/seam/connect/openapi.js.map +1 -1
  7. package/lib/seam/connect/route-types.d.ts +208 -14
  8. package/lib/seam/connect/unstable/model-types.d.ts +1 -1
  9. package/lib/seam/connect/unstable/models/access-codes/managed-access-code.js +81 -21
  10. package/lib/seam/connect/unstable/models/access-codes/managed-access-code.js.map +1 -1
  11. package/lib/seam/connect/unstable/models/acs/credential.d.ts +7 -4
  12. package/lib/seam/connect/unstable/models/acs/credential.js +2 -1
  13. package/lib/seam/connect/unstable/models/acs/credential.js.map +1 -1
  14. package/lib/seam/connect/unstable/models/acs/credential_pool.d.ts +29 -0
  15. package/lib/seam/connect/unstable/models/acs/credential_pool.js +12 -0
  16. package/lib/seam/connect/unstable/models/acs/credential_pool.js.map +1 -0
  17. package/lib/seam/connect/unstable/models/acs/credential_provisioning_automation.d.ts +21 -0
  18. package/lib/seam/connect/unstable/models/acs/credential_provisioning_automation.js +9 -0
  19. package/lib/seam/connect/unstable/models/acs/credential_provisioning_automation.js.map +1 -0
  20. package/lib/seam/connect/unstable/models/acs/index.d.ts +2 -0
  21. package/lib/seam/connect/unstable/models/acs/index.js +2 -0
  22. package/lib/seam/connect/unstable/models/acs/index.js.map +1 -1
  23. package/lib/seam/connect/unstable/models/devices/managed-device.d.ts +14 -14
  24. package/lib/seam/connect/unstable/models/devices/managed-device.js +1 -1
  25. package/lib/seam/connect/unstable/models/devices/managed-device.js.map +1 -1
  26. package/lib/seam/connect/unstable/schemas.d.ts +1 -1
  27. package/lib/seam/connect/unstable/schemas.js +1 -1
  28. package/lib/seam/connect/unstable/schemas.js.map +1 -1
  29. package/package.json +1 -1
  30. package/src/lib/seam/connect/openapi.ts +357 -37
  31. package/src/lib/seam/connect/route-types.ts +208 -14
  32. package/src/lib/seam/connect/unstable/model-types.ts +2 -0
  33. package/src/lib/seam/connect/unstable/models/access-codes/managed-access-code.ts +113 -21
  34. package/src/lib/seam/connect/unstable/models/acs/credential.ts +2 -1
  35. package/src/lib/seam/connect/unstable/models/acs/credential_pool.ts +19 -0
  36. package/src/lib/seam/connect/unstable/models/acs/credential_provisioning_automation.ts +13 -0
  37. package/src/lib/seam/connect/unstable/models/acs/index.ts +2 -0
  38. package/src/lib/seam/connect/unstable/models/devices/managed-device.ts +1 -1
  39. package/src/lib/seam/connect/unstable/schemas.ts +3 -0
@@ -47,26 +47,49 @@ export interface Routes {
47
47
  };
48
48
  };
49
49
  access_code: {
50
+ /** Unique identifier for a group of access codes that share the same code. */
50
51
  common_code_key: string | null;
52
+ /** Indicates whether the code is set on the device according to a preconfigured schedule. */
51
53
  is_scheduled_on_device?: boolean | undefined;
54
+ /** Nature of the access code. Values are "ongoing" for access codes that are active continuously until deactivated manually or "time_bound" for access codes that have a specific duration. */
52
55
  type: 'time_bound' | 'ongoing';
56
+ /** Indicates whether the access code is waiting for a code assignment. */
53
57
  is_waiting_for_code_assignment?: boolean | undefined;
58
+ /** Unique identifier for the access code. */
54
59
  access_code_id: string;
60
+ /** Unique identifier for the device associated with the access code. */
55
61
  device_id: string;
62
+ /** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. */
56
63
  name: string | null;
64
+ /** Code used for access. Typically, a numeric or alphanumeric string. */
57
65
  code: string | null;
66
+ /** Date and time at which the access code was created. */
58
67
  created_at: string;
68
+ /** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
59
69
  errors?: any;
70
+ /** Collection of warnings associated with the access code, structured in a dictionary format. A unique "warning_code" keys each warning. Each warning entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the warning. "created_at" is a date that indicates when the warning was generated. This structure enables detailed tracking and timely response to potential issues that are not critical but that may require attention. */
60
71
  warnings?: any;
72
+ /** Indicates whether Seam manages the access code. */
61
73
  is_managed: true;
74
+ /** Date and time at which the time-bound access code becomes active. */
62
75
  starts_at?: (string | null) | undefined;
76
+ /** Date and time after which the time-bound access code becomes inactive. */
63
77
  ends_at?: (string | null) | undefined;
78
+ /**
79
+ Current status of the access code within the operational lifecycle. Values are "setting," a transitional phase that indicates that the code is being configured or activated; "set", which indicates that the code is active and operational; "unset," which indicates a deactivated or unused state, either before activation or after deliberate deactivation; "removing," which indicates a transitional period in which the code is being deleted or made inactive; and "unknown," which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting.
80
+ */
64
81
  status: 'setting' | 'set' | 'unset' | 'removing' | 'unknown';
82
+ /** Indicates whether a backup access code is available for use if the primary access code is lost or compromised. */
65
83
  is_backup_access_code_available: boolean;
84
+ /** Indicates whether the access code is a backup code. */
66
85
  is_backup?: boolean | undefined;
86
+ /** Identifier of the pulled backup access code. Used to associate the pulled backup access code with the original access code. */
67
87
  pulled_backup_access_code_id?: (string | null) | undefined;
88
+ /** Indicates whether changes to the access code from external sources are permitted. */
68
89
  is_external_modification_allowed: boolean;
90
+ /** Indicates whether the access code can only be used once. If "true," the code becomes invalid after the first use. */
69
91
  is_one_time_use: boolean;
92
+ /** Indicates whether the access code is intended for use in offline scenarios. If "true," this code can be created on a device without a network connection. */
70
93
  is_offline_access_code: boolean;
71
94
  };
72
95
  };
@@ -96,26 +119,49 @@ export interface Routes {
96
119
  formData: {};
97
120
  jsonResponse: {
98
121
  access_codes: Array<{
122
+ /** Unique identifier for a group of access codes that share the same code. */
99
123
  common_code_key: string | null;
124
+ /** Indicates whether the code is set on the device according to a preconfigured schedule. */
100
125
  is_scheduled_on_device?: boolean | undefined;
126
+ /** Nature of the access code. Values are "ongoing" for access codes that are active continuously until deactivated manually or "time_bound" for access codes that have a specific duration. */
101
127
  type: 'time_bound' | 'ongoing';
128
+ /** Indicates whether the access code is waiting for a code assignment. */
102
129
  is_waiting_for_code_assignment?: boolean | undefined;
130
+ /** Unique identifier for the access code. */
103
131
  access_code_id: string;
132
+ /** Unique identifier for the device associated with the access code. */
104
133
  device_id: string;
134
+ /** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. */
105
135
  name: string | null;
136
+ /** Code used for access. Typically, a numeric or alphanumeric string. */
106
137
  code: string | null;
138
+ /** Date and time at which the access code was created. */
107
139
  created_at: string;
140
+ /** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
108
141
  errors?: any;
142
+ /** Collection of warnings associated with the access code, structured in a dictionary format. A unique "warning_code" keys each warning. Each warning entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the warning. "created_at" is a date that indicates when the warning was generated. This structure enables detailed tracking and timely response to potential issues that are not critical but that may require attention. */
109
143
  warnings?: any;
144
+ /** Indicates whether Seam manages the access code. */
110
145
  is_managed: true;
146
+ /** Date and time at which the time-bound access code becomes active. */
111
147
  starts_at?: (string | null) | undefined;
148
+ /** Date and time after which the time-bound access code becomes inactive. */
112
149
  ends_at?: (string | null) | undefined;
150
+ /**
151
+ Current status of the access code within the operational lifecycle. Values are "setting," a transitional phase that indicates that the code is being configured or activated; "set", which indicates that the code is active and operational; "unset," which indicates a deactivated or unused state, either before activation or after deliberate deactivation; "removing," which indicates a transitional period in which the code is being deleted or made inactive; and "unknown," which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting.
152
+ */
113
153
  status: 'setting' | 'set' | 'unset' | 'removing' | 'unknown';
154
+ /** Indicates whether a backup access code is available for use if the primary access code is lost or compromised. */
114
155
  is_backup_access_code_available: boolean;
156
+ /** Indicates whether the access code is a backup code. */
115
157
  is_backup?: boolean | undefined;
158
+ /** Identifier of the pulled backup access code. Used to associate the pulled backup access code with the original access code. */
116
159
  pulled_backup_access_code_id?: (string | null) | undefined;
160
+ /** Indicates whether changes to the access code from external sources are permitted. */
117
161
  is_external_modification_allowed: boolean;
162
+ /** Indicates whether the access code can only be used once. If "true," the code becomes invalid after the first use. */
118
163
  is_one_time_use: boolean;
164
+ /** Indicates whether the access code is intended for use in offline scenarios. If "true," this code can be created on a device without a network connection. */
119
165
  is_offline_access_code: boolean;
120
166
  }>;
121
167
  };
@@ -185,26 +231,49 @@ export interface Routes {
185
231
  formData: {};
186
232
  jsonResponse: {
187
233
  access_code: {
234
+ /** Unique identifier for a group of access codes that share the same code. */
188
235
  common_code_key: string | null;
236
+ /** Indicates whether the code is set on the device according to a preconfigured schedule. */
189
237
  is_scheduled_on_device?: boolean | undefined;
238
+ /** Nature of the access code. Values are "ongoing" for access codes that are active continuously until deactivated manually or "time_bound" for access codes that have a specific duration. */
190
239
  type: 'time_bound' | 'ongoing';
240
+ /** Indicates whether the access code is waiting for a code assignment. */
191
241
  is_waiting_for_code_assignment?: boolean | undefined;
242
+ /** Unique identifier for the access code. */
192
243
  access_code_id: string;
244
+ /** Unique identifier for the device associated with the access code. */
193
245
  device_id: string;
246
+ /** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. */
194
247
  name: string | null;
248
+ /** Code used for access. Typically, a numeric or alphanumeric string. */
195
249
  code: string | null;
250
+ /** Date and time at which the access code was created. */
196
251
  created_at: string;
252
+ /** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
197
253
  errors?: any;
254
+ /** Collection of warnings associated with the access code, structured in a dictionary format. A unique "warning_code" keys each warning. Each warning entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the warning. "created_at" is a date that indicates when the warning was generated. This structure enables detailed tracking and timely response to potential issues that are not critical but that may require attention. */
198
255
  warnings?: any;
256
+ /** Indicates whether Seam manages the access code. */
199
257
  is_managed: true;
258
+ /** Date and time at which the time-bound access code becomes active. */
200
259
  starts_at?: (string | null) | undefined;
260
+ /** Date and time after which the time-bound access code becomes inactive. */
201
261
  ends_at?: (string | null) | undefined;
262
+ /**
263
+ Current status of the access code within the operational lifecycle. Values are "setting," a transitional phase that indicates that the code is being configured or activated; "set", which indicates that the code is active and operational; "unset," which indicates a deactivated or unused state, either before activation or after deliberate deactivation; "removing," which indicates a transitional period in which the code is being deleted or made inactive; and "unknown," which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting.
264
+ */
202
265
  status: 'setting' | 'set' | 'unset' | 'removing' | 'unknown';
266
+ /** Indicates whether a backup access code is available for use if the primary access code is lost or compromised. */
203
267
  is_backup_access_code_available: boolean;
268
+ /** Indicates whether the access code is a backup code. */
204
269
  is_backup?: boolean | undefined;
270
+ /** Identifier of the pulled backup access code. Used to associate the pulled backup access code with the original access code. */
205
271
  pulled_backup_access_code_id?: (string | null) | undefined;
272
+ /** Indicates whether changes to the access code from external sources are permitted. */
206
273
  is_external_modification_allowed: boolean;
274
+ /** Indicates whether the access code can only be used once. If "true," the code becomes invalid after the first use. */
207
275
  is_one_time_use: boolean;
276
+ /** Indicates whether the access code is intended for use in offline scenarios. If "true," this code can be created on a device without a network connection. */
208
277
  is_offline_access_code: boolean;
209
278
  };
210
279
  };
@@ -222,26 +291,49 @@ export interface Routes {
222
291
  formData: {};
223
292
  jsonResponse: {
224
293
  access_codes: Array<{
294
+ /** Unique identifier for a group of access codes that share the same code. */
225
295
  common_code_key: string | null;
296
+ /** Indicates whether the code is set on the device according to a preconfigured schedule. */
226
297
  is_scheduled_on_device?: boolean | undefined;
298
+ /** Nature of the access code. Values are "ongoing" for access codes that are active continuously until deactivated manually or "time_bound" for access codes that have a specific duration. */
227
299
  type: 'time_bound' | 'ongoing';
300
+ /** Indicates whether the access code is waiting for a code assignment. */
228
301
  is_waiting_for_code_assignment?: boolean | undefined;
302
+ /** Unique identifier for the access code. */
229
303
  access_code_id: string;
304
+ /** Unique identifier for the device associated with the access code. */
230
305
  device_id: string;
306
+ /** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. */
231
307
  name: string | null;
308
+ /** Code used for access. Typically, a numeric or alphanumeric string. */
232
309
  code: string | null;
310
+ /** Date and time at which the access code was created. */
233
311
  created_at: string;
312
+ /** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
234
313
  errors?: any;
314
+ /** Collection of warnings associated with the access code, structured in a dictionary format. A unique "warning_code" keys each warning. Each warning entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the warning. "created_at" is a date that indicates when the warning was generated. This structure enables detailed tracking and timely response to potential issues that are not critical but that may require attention. */
235
315
  warnings?: any;
316
+ /** Indicates whether Seam manages the access code. */
236
317
  is_managed: true;
318
+ /** Date and time at which the time-bound access code becomes active. */
237
319
  starts_at?: (string | null) | undefined;
320
+ /** Date and time after which the time-bound access code becomes inactive. */
238
321
  ends_at?: (string | null) | undefined;
322
+ /**
323
+ Current status of the access code within the operational lifecycle. Values are "setting," a transitional phase that indicates that the code is being configured or activated; "set", which indicates that the code is active and operational; "unset," which indicates a deactivated or unused state, either before activation or after deliberate deactivation; "removing," which indicates a transitional period in which the code is being deleted or made inactive; and "unknown," which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting.
324
+ */
239
325
  status: 'setting' | 'set' | 'unset' | 'removing' | 'unknown';
326
+ /** Indicates whether a backup access code is available for use if the primary access code is lost or compromised. */
240
327
  is_backup_access_code_available: boolean;
328
+ /** Indicates whether the access code is a backup code. */
241
329
  is_backup?: boolean | undefined;
330
+ /** Identifier of the pulled backup access code. Used to associate the pulled backup access code with the original access code. */
242
331
  pulled_backup_access_code_id?: (string | null) | undefined;
332
+ /** Indicates whether changes to the access code from external sources are permitted. */
243
333
  is_external_modification_allowed: boolean;
334
+ /** Indicates whether the access code can only be used once. If "true," the code becomes invalid after the first use. */
244
335
  is_one_time_use: boolean;
336
+ /** Indicates whether the access code is intended for use in offline scenarios. If "true," this code can be created on a device without a network connection. */
245
337
  is_offline_access_code: boolean;
246
338
  }>;
247
339
  };
@@ -257,26 +349,49 @@ export interface Routes {
257
349
  formData: {};
258
350
  jsonResponse: {
259
351
  backup_access_code: {
352
+ /** Unique identifier for a group of access codes that share the same code. */
260
353
  common_code_key: string | null;
354
+ /** Indicates whether the code is set on the device according to a preconfigured schedule. */
261
355
  is_scheduled_on_device?: boolean | undefined;
356
+ /** Nature of the access code. Values are "ongoing" for access codes that are active continuously until deactivated manually or "time_bound" for access codes that have a specific duration. */
262
357
  type: 'time_bound' | 'ongoing';
358
+ /** Indicates whether the access code is waiting for a code assignment. */
263
359
  is_waiting_for_code_assignment?: boolean | undefined;
360
+ /** Unique identifier for the access code. */
264
361
  access_code_id: string;
362
+ /** Unique identifier for the device associated with the access code. */
265
363
  device_id: string;
364
+ /** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. */
266
365
  name: string | null;
366
+ /** Code used for access. Typically, a numeric or alphanumeric string. */
267
367
  code: string | null;
368
+ /** Date and time at which the access code was created. */
268
369
  created_at: string;
370
+ /** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
269
371
  errors?: any;
372
+ /** Collection of warnings associated with the access code, structured in a dictionary format. A unique "warning_code" keys each warning. Each warning entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the warning. "created_at" is a date that indicates when the warning was generated. This structure enables detailed tracking and timely response to potential issues that are not critical but that may require attention. */
270
373
  warnings?: any;
374
+ /** Indicates whether Seam manages the access code. */
271
375
  is_managed: true;
376
+ /** Date and time at which the time-bound access code becomes active. */
272
377
  starts_at?: (string | null) | undefined;
378
+ /** Date and time after which the time-bound access code becomes inactive. */
273
379
  ends_at?: (string | null) | undefined;
380
+ /**
381
+ Current status of the access code within the operational lifecycle. Values are "setting," a transitional phase that indicates that the code is being configured or activated; "set", which indicates that the code is active and operational; "unset," which indicates a deactivated or unused state, either before activation or after deliberate deactivation; "removing," which indicates a transitional period in which the code is being deleted or made inactive; and "unknown," which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting.
382
+ */
274
383
  status: 'setting' | 'set' | 'unset' | 'removing' | 'unknown';
384
+ /** Indicates whether a backup access code is available for use if the primary access code is lost or compromised. */
275
385
  is_backup_access_code_available: boolean;
386
+ /** Indicates whether the access code is a backup code. */
276
387
  is_backup?: boolean | undefined;
388
+ /** Identifier of the pulled backup access code. Used to associate the pulled backup access code with the original access code. */
277
389
  pulled_backup_access_code_id?: (string | null) | undefined;
390
+ /** Indicates whether changes to the access code from external sources are permitted. */
278
391
  is_external_modification_allowed: boolean;
392
+ /** Indicates whether the access code can only be used once. If "true," the code becomes invalid after the first use. */
279
393
  is_one_time_use: boolean;
394
+ /** Indicates whether the access code is intended for use in offline scenarios. If "true," this code can be created on a device without a network connection. */
280
395
  is_offline_access_code: boolean;
281
396
  };
282
397
  };
@@ -294,16 +409,26 @@ export interface Routes {
294
409
  formData: {};
295
410
  jsonResponse: {
296
411
  access_code: {
412
+ /** Nature of the access code. Values are "ongoing" for access codes that are active continuously until deactivated manually or "time_bound" for access codes that have a specific duration. */
297
413
  type: 'time_bound' | 'ongoing';
414
+ /** Unique identifier for the access code. */
298
415
  access_code_id: string;
416
+ /** Unique identifier for the device associated with the access code. */
299
417
  device_id: string;
418
+ /** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. */
300
419
  name: string | null;
420
+ /** Code used for access. Typically, a numeric or alphanumeric string. */
301
421
  code: string | null;
422
+ /** Date and time at which the access code was created. */
302
423
  created_at: string;
424
+ /** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
303
425
  errors?: any;
426
+ /** Collection of warnings associated with the access code, structured in a dictionary format. A unique "warning_code" keys each warning. Each warning entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the warning. "created_at" is a date that indicates when the warning was generated. This structure enables detailed tracking and timely response to potential issues that are not critical but that may require attention. */
304
427
  warnings?: any;
305
428
  is_managed: false;
429
+ /** Date and time at which the time-bound access code becomes active. */
306
430
  starts_at?: (string | null) | undefined;
431
+ /** Date and time after which the time-bound access code becomes inactive. */
307
432
  ends_at?: (string | null) | undefined;
308
433
  status: 'set';
309
434
  };
@@ -372,16 +497,26 @@ export interface Routes {
372
497
  formData: {};
373
498
  jsonResponse: {
374
499
  access_code: {
500
+ /** Nature of the access code. Values are "ongoing" for access codes that are active continuously until deactivated manually or "time_bound" for access codes that have a specific duration. */
375
501
  type: 'time_bound' | 'ongoing';
502
+ /** Unique identifier for the access code. */
376
503
  access_code_id: string;
504
+ /** Unique identifier for the device associated with the access code. */
377
505
  device_id: string;
506
+ /** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. */
378
507
  name: string | null;
508
+ /** Code used for access. Typically, a numeric or alphanumeric string. */
379
509
  code: string | null;
510
+ /** Date and time at which the access code was created. */
380
511
  created_at: string;
512
+ /** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
381
513
  errors?: any;
514
+ /** Collection of warnings associated with the access code, structured in a dictionary format. A unique "warning_code" keys each warning. Each warning entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the warning. "created_at" is a date that indicates when the warning was generated. This structure enables detailed tracking and timely response to potential issues that are not critical but that may require attention. */
382
515
  warnings?: any;
383
516
  is_managed: false;
517
+ /** Date and time at which the time-bound access code becomes active. */
384
518
  starts_at?: (string | null) | undefined;
519
+ /** Date and time after which the time-bound access code becomes inactive. */
385
520
  ends_at?: (string | null) | undefined;
386
521
  status: 'set';
387
522
  };
@@ -399,16 +534,26 @@ export interface Routes {
399
534
  formData: {};
400
535
  jsonResponse: {
401
536
  access_codes: Array<{
537
+ /** Nature of the access code. Values are "ongoing" for access codes that are active continuously until deactivated manually or "time_bound" for access codes that have a specific duration. */
402
538
  type: 'time_bound' | 'ongoing';
539
+ /** Unique identifier for the access code. */
403
540
  access_code_id: string;
541
+ /** Unique identifier for the device associated with the access code. */
404
542
  device_id: string;
543
+ /** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. */
405
544
  name: string | null;
545
+ /** Code used for access. Typically, a numeric or alphanumeric string. */
406
546
  code: string | null;
547
+ /** Date and time at which the access code was created. */
407
548
  created_at: string;
549
+ /** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
408
550
  errors?: any;
551
+ /** Collection of warnings associated with the access code, structured in a dictionary format. A unique "warning_code" keys each warning. Each warning entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the warning. "created_at" is a date that indicates when the warning was generated. This structure enables detailed tracking and timely response to potential issues that are not critical but that may require attention. */
409
552
  warnings?: any;
410
553
  is_managed: false;
554
+ /** Date and time at which the time-bound access code becomes active. */
411
555
  starts_at?: (string | null) | undefined;
556
+ /** Date and time after which the time-bound access code becomes inactive. */
412
557
  ends_at?: (string | null) | undefined;
413
558
  status: 'set';
414
559
  }>;
@@ -582,6 +727,50 @@ export interface Routes {
582
727
  formData: {};
583
728
  jsonResponse: {};
584
729
  };
730
+ '/acs/credential_pools/list': {
731
+ route: '/acs/credential_pools/list';
732
+ method: 'GET' | 'POST';
733
+ queryParams: {};
734
+ jsonBody: {};
735
+ commonParams: {
736
+ acs_system_id: string;
737
+ };
738
+ formData: {};
739
+ jsonResponse: {
740
+ acs_credential_pools: Array<{
741
+ acs_credential_pool_id: string;
742
+ acs_system_id: string;
743
+ display_name: string;
744
+ external_type: 'hid_part_number';
745
+ external_type_display_name: string;
746
+ created_at: string;
747
+ workspace_id: string;
748
+ }>;
749
+ };
750
+ };
751
+ '/acs/credential_provisioning_automations/launch': {
752
+ route: '/acs/credential_provisioning_automations/launch';
753
+ method: 'POST';
754
+ queryParams: {};
755
+ jsonBody: {};
756
+ commonParams: {
757
+ user_identity_id: string;
758
+ credential_manager_acs_system_id: string;
759
+ acs_credential_pool_id?: string | undefined;
760
+ create_credential_manager_user?: boolean | undefined;
761
+ credential_manager_acs_user_id?: string | undefined;
762
+ };
763
+ formData: {};
764
+ jsonResponse: {
765
+ acs_credential_provisioning_automation: {
766
+ acs_credential_provisioning_automation_id: string;
767
+ credential_manager_acs_system_id: string;
768
+ user_identity_id: string;
769
+ created_at: string;
770
+ workspace_id: string;
771
+ };
772
+ };
773
+ };
585
774
  '/acs/credentials/assign': {
586
775
  route: '/acs/credentials/assign';
587
776
  method: 'PATCH' | 'POST';
@@ -596,10 +785,11 @@ export interface Routes {
596
785
  acs_credential: {
597
786
  acs_credential_id: string;
598
787
  acs_user_id?: string | undefined;
788
+ acs_credential_pool_id?: string | undefined;
599
789
  acs_system_id: string;
600
790
  display_name: string;
601
791
  code: string | null;
602
- external_type: 'pti_card' | 'brivo_credential' | 'hid_cm_credential';
792
+ external_type: 'pti_card' | 'brivo_credential' | 'hid_credential';
603
793
  external_type_display_name: string;
604
794
  created_at: string;
605
795
  workspace_id: string;
@@ -620,10 +810,11 @@ export interface Routes {
620
810
  acs_credential: {
621
811
  acs_credential_id: string;
622
812
  acs_user_id?: string | undefined;
813
+ acs_credential_pool_id?: string | undefined;
623
814
  acs_system_id: string;
624
815
  display_name: string;
625
816
  code: string | null;
626
- external_type: 'pti_card' | 'brivo_credential' | 'hid_cm_credential';
817
+ external_type: 'pti_card' | 'brivo_credential' | 'hid_credential';
627
818
  external_type_display_name: string;
628
819
  created_at: string;
629
820
  workspace_id: string;
@@ -654,10 +845,11 @@ export interface Routes {
654
845
  acs_credential: {
655
846
  acs_credential_id: string;
656
847
  acs_user_id?: string | undefined;
848
+ acs_credential_pool_id?: string | undefined;
657
849
  acs_system_id: string;
658
850
  display_name: string;
659
851
  code: string | null;
660
- external_type: 'pti_card' | 'brivo_credential' | 'hid_cm_credential';
852
+ external_type: 'pti_card' | 'brivo_credential' | 'hid_credential';
661
853
  external_type_display_name: string;
662
854
  created_at: string;
663
855
  workspace_id: string;
@@ -682,10 +874,11 @@ export interface Routes {
682
874
  acs_credentials: Array<{
683
875
  acs_credential_id: string;
684
876
  acs_user_id?: string | undefined;
877
+ acs_credential_pool_id?: string | undefined;
685
878
  acs_system_id: string;
686
879
  display_name: string;
687
880
  code: string | null;
688
- external_type: 'pti_card' | 'brivo_credential' | 'hid_cm_credential';
881
+ external_type: 'pti_card' | 'brivo_credential' | 'hid_credential';
689
882
  external_type_display_name: string;
690
883
  created_at: string;
691
884
  workspace_id: string;
@@ -706,10 +899,11 @@ export interface Routes {
706
899
  acs_credential: {
707
900
  acs_credential_id: string;
708
901
  acs_user_id?: string | undefined;
902
+ acs_credential_pool_id?: string | undefined;
709
903
  acs_system_id: string;
710
904
  display_name: string;
711
905
  code: string | null;
712
- external_type: 'pti_card' | 'brivo_credential' | 'hid_cm_credential';
906
+ external_type: 'pti_card' | 'brivo_credential' | 'hid_credential';
713
907
  external_type_display_name: string;
714
908
  created_at: string;
715
909
  workspace_id: string;
@@ -1402,7 +1596,7 @@ export interface Routes {
1402
1596
  display_name: string;
1403
1597
  manufacturer_display_name: string;
1404
1598
  offline_access_codes_supported?: boolean | undefined;
1405
- access_codes_supported?: boolean | undefined;
1599
+ online_access_codes_supported?: boolean | undefined;
1406
1600
  accessory_keypad_supported?: boolean | undefined;
1407
1601
  };
1408
1602
  has_direct_power?: boolean | undefined;
@@ -1821,7 +2015,7 @@ export interface Routes {
1821
2015
  display_name: string;
1822
2016
  manufacturer_display_name: string;
1823
2017
  offline_access_codes_supported?: boolean | undefined;
1824
- access_codes_supported?: boolean | undefined;
2018
+ online_access_codes_supported?: boolean | undefined;
1825
2019
  accessory_keypad_supported?: boolean | undefined;
1826
2020
  };
1827
2021
  has_direct_power?: boolean | undefined;
@@ -2495,7 +2689,7 @@ export interface Routes {
2495
2689
  display_name: string;
2496
2690
  manufacturer_display_name: string;
2497
2691
  offline_access_codes_supported?: boolean | undefined;
2498
- access_codes_supported?: boolean | undefined;
2692
+ online_access_codes_supported?: boolean | undefined;
2499
2693
  accessory_keypad_supported?: boolean | undefined;
2500
2694
  };
2501
2695
  has_direct_power?: boolean | undefined;
@@ -2892,7 +3086,7 @@ export interface Routes {
2892
3086
  display_name: string;
2893
3087
  manufacturer_display_name: string;
2894
3088
  offline_access_codes_supported?: boolean | undefined;
2895
- access_codes_supported?: boolean | undefined;
3089
+ online_access_codes_supported?: boolean | undefined;
2896
3090
  accessory_keypad_supported?: boolean | undefined;
2897
3091
  };
2898
3092
  has_direct_power?: boolean | undefined;
@@ -3311,7 +3505,7 @@ export interface Routes {
3311
3505
  display_name: string;
3312
3506
  manufacturer_display_name: string;
3313
3507
  offline_access_codes_supported?: boolean | undefined;
3314
- access_codes_supported?: boolean | undefined;
3508
+ online_access_codes_supported?: boolean | undefined;
3315
3509
  accessory_keypad_supported?: boolean | undefined;
3316
3510
  };
3317
3511
  has_direct_power?: boolean | undefined;
@@ -3708,7 +3902,7 @@ export interface Routes {
3708
3902
  display_name: string;
3709
3903
  manufacturer_display_name: string;
3710
3904
  offline_access_codes_supported?: boolean | undefined;
3711
- access_codes_supported?: boolean | undefined;
3905
+ online_access_codes_supported?: boolean | undefined;
3712
3906
  accessory_keypad_supported?: boolean | undefined;
3713
3907
  };
3714
3908
  has_direct_power?: boolean | undefined;
@@ -4525,7 +4719,7 @@ export interface Routes {
4525
4719
  display_name: string;
4526
4720
  manufacturer_display_name: string;
4527
4721
  offline_access_codes_supported?: boolean | undefined;
4528
- access_codes_supported?: boolean | undefined;
4722
+ online_access_codes_supported?: boolean | undefined;
4529
4723
  accessory_keypad_supported?: boolean | undefined;
4530
4724
  };
4531
4725
  has_direct_power?: boolean | undefined;
@@ -4974,7 +5168,7 @@ export interface Routes {
4974
5168
  display_name: string;
4975
5169
  manufacturer_display_name: string;
4976
5170
  offline_access_codes_supported?: boolean | undefined;
4977
- access_codes_supported?: boolean | undefined;
5171
+ online_access_codes_supported?: boolean | undefined;
4978
5172
  accessory_keypad_supported?: boolean | undefined;
4979
5173
  };
4980
5174
  has_direct_power?: boolean | undefined;
@@ -5495,7 +5689,7 @@ export interface Routes {
5495
5689
  display_name: string;
5496
5690
  manufacturer_display_name: string;
5497
5691
  offline_access_codes_supported?: boolean | undefined;
5498
- access_codes_supported?: boolean | undefined;
5692
+ online_access_codes_supported?: boolean | undefined;
5499
5693
  accessory_keypad_supported?: boolean | undefined;
5500
5694
  };
5501
5695
  has_direct_power?: boolean | undefined;
@@ -1 +1 @@
1
- export type { AccessCodeConstraint, AcsAccessGroup, AcsAccessGroupExternalType, AcsCredential, AcsCredentialExternalType, AcsSystem, AcsSystemExternalType, AcsUser, AcsUserExternalType, AnyDeviceType, BatteryStatus, Capabilities, ClimateSetting, DeviceMetadata, LockDeviceType, ManagedAccessCode, ManagedDevice, ManagedDeviceWithBackendMetadata, NoiseSensorDeviceType, ThermostatDeviceType, UnmanagedAccessCode, UnmanagedDevice, } from './models/index.js';
1
+ export type { AccessCodeConstraint, AcsAccessGroup, AcsAccessGroupExternalType, AcsCredential, AcsCredentialExternalType, AcsCredentialPool, AcsCredentialPoolExternalType, AcsSystem, AcsSystemExternalType, AcsUser, AcsUserExternalType, AnyDeviceType, BatteryStatus, Capabilities, ClimateSetting, DeviceMetadata, LockDeviceType, ManagedAccessCode, ManagedDevice, ManagedDeviceWithBackendMetadata, NoiseSensorDeviceType, ThermostatDeviceType, UnmanagedAccessCode, UnmanagedDevice, } from './models/index.js';