@seamapi/types 1.48.0 → 1.49.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.
- package/dist/connect.cjs +252 -38
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +348 -17
- package/lib/seam/connect/openapi.d.ts +163 -3
- package/lib/seam/connect/openapi.js +251 -37
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +185 -14
- package/lib/seam/connect/unstable/model-types.d.ts +1 -1
- package/lib/seam/connect/unstable/models/access-codes/managed-access-code.js +81 -21
- package/lib/seam/connect/unstable/models/access-codes/managed-access-code.js.map +1 -1
- package/lib/seam/connect/unstable/models/acs/credential.d.ts +7 -4
- package/lib/seam/connect/unstable/models/acs/credential.js +2 -1
- package/lib/seam/connect/unstable/models/acs/credential.js.map +1 -1
- package/lib/seam/connect/unstable/models/acs/credential_pool.d.ts +29 -0
- package/lib/seam/connect/unstable/models/acs/credential_pool.js +12 -0
- package/lib/seam/connect/unstable/models/acs/credential_pool.js.map +1 -0
- package/lib/seam/connect/unstable/models/acs/index.d.ts +1 -0
- package/lib/seam/connect/unstable/models/acs/index.js +1 -0
- package/lib/seam/connect/unstable/models/acs/index.js.map +1 -1
- package/lib/seam/connect/unstable/models/devices/managed-device.d.ts +14 -14
- package/lib/seam/connect/unstable/models/devices/managed-device.js +1 -1
- package/lib/seam/connect/unstable/models/devices/managed-device.js.map +1 -1
- package/lib/seam/connect/unstable/schemas.d.ts +1 -1
- package/lib/seam/connect/unstable/schemas.js +1 -1
- package/lib/seam/connect/unstable/schemas.js.map +1 -1
- package/package.json +1 -1
- package/src/lib/seam/connect/openapi.ts +276 -37
- package/src/lib/seam/connect/route-types.ts +185 -14
- package/src/lib/seam/connect/unstable/model-types.ts +2 -0
- package/src/lib/seam/connect/unstable/models/access-codes/managed-access-code.ts +113 -21
- package/src/lib/seam/connect/unstable/models/acs/credential.ts +2 -1
- package/src/lib/seam/connect/unstable/models/acs/credential_pool.ts +19 -0
- package/src/lib/seam/connect/unstable/models/acs/index.ts +1 -0
- package/src/lib/seam/connect/unstable/models/devices/managed-device.ts +1 -1
- package/src/lib/seam/connect/unstable/schemas.ts +2 -0
|
@@ -50,26 +50,49 @@ export interface Routes {
|
|
|
50
50
|
}
|
|
51
51
|
}
|
|
52
52
|
access_code: {
|
|
53
|
+
/** Unique identifier for a group of access codes that share the same code. */
|
|
53
54
|
common_code_key: string | null
|
|
55
|
+
/** Indicates whether the code is set on the device according to a preconfigured schedule. */
|
|
54
56
|
is_scheduled_on_device?: boolean | undefined
|
|
57
|
+
/** 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. */
|
|
55
58
|
type: 'time_bound' | 'ongoing'
|
|
59
|
+
/** Indicates whether the access code is waiting for a code assignment. */
|
|
56
60
|
is_waiting_for_code_assignment?: boolean | undefined
|
|
61
|
+
/** Unique identifier for the access code. */
|
|
57
62
|
access_code_id: string
|
|
63
|
+
/** Unique identifier for the device associated with the access code. */
|
|
58
64
|
device_id: string
|
|
65
|
+
/** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. */
|
|
59
66
|
name: string | null
|
|
67
|
+
/** Code used for access. Typically, a numeric or alphanumeric string. */
|
|
60
68
|
code: string | null
|
|
69
|
+
/** Date and time at which the access code was created. */
|
|
61
70
|
created_at: string
|
|
71
|
+
/** 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. */
|
|
62
72
|
errors?: any
|
|
73
|
+
/** 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. */
|
|
63
74
|
warnings?: any
|
|
75
|
+
/** Indicates whether Seam manages the access code. */
|
|
64
76
|
is_managed: true
|
|
77
|
+
/** Date and time at which the time-bound access code becomes active. */
|
|
65
78
|
starts_at?: (string | null) | undefined
|
|
79
|
+
/** Date and time after which the time-bound access code becomes inactive. */
|
|
66
80
|
ends_at?: (string | null) | undefined
|
|
81
|
+
/**
|
|
82
|
+
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.
|
|
83
|
+
*/
|
|
67
84
|
status: 'setting' | 'set' | 'unset' | 'removing' | 'unknown'
|
|
85
|
+
/** Indicates whether a backup access code is available for use if the primary access code is lost or compromised. */
|
|
68
86
|
is_backup_access_code_available: boolean
|
|
87
|
+
/** Indicates whether the access code is a backup code. */
|
|
69
88
|
is_backup?: boolean | undefined
|
|
89
|
+
/** Identifier of the pulled backup access code. Used to associate the pulled backup access code with the original access code. */
|
|
70
90
|
pulled_backup_access_code_id?: (string | null) | undefined
|
|
91
|
+
/** Indicates whether changes to the access code from external sources are permitted. */
|
|
71
92
|
is_external_modification_allowed: boolean
|
|
93
|
+
/** Indicates whether the access code can only be used once. If "true," the code becomes invalid after the first use. */
|
|
72
94
|
is_one_time_use: boolean
|
|
95
|
+
/** 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. */
|
|
73
96
|
is_offline_access_code: boolean
|
|
74
97
|
}
|
|
75
98
|
}
|
|
@@ -99,26 +122,49 @@ export interface Routes {
|
|
|
99
122
|
formData: {}
|
|
100
123
|
jsonResponse: {
|
|
101
124
|
access_codes: Array<{
|
|
125
|
+
/** Unique identifier for a group of access codes that share the same code. */
|
|
102
126
|
common_code_key: string | null
|
|
127
|
+
/** Indicates whether the code is set on the device according to a preconfigured schedule. */
|
|
103
128
|
is_scheduled_on_device?: boolean | undefined
|
|
129
|
+
/** 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. */
|
|
104
130
|
type: 'time_bound' | 'ongoing'
|
|
131
|
+
/** Indicates whether the access code is waiting for a code assignment. */
|
|
105
132
|
is_waiting_for_code_assignment?: boolean | undefined
|
|
133
|
+
/** Unique identifier for the access code. */
|
|
106
134
|
access_code_id: string
|
|
135
|
+
/** Unique identifier for the device associated with the access code. */
|
|
107
136
|
device_id: string
|
|
137
|
+
/** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. */
|
|
108
138
|
name: string | null
|
|
139
|
+
/** Code used for access. Typically, a numeric or alphanumeric string. */
|
|
109
140
|
code: string | null
|
|
141
|
+
/** Date and time at which the access code was created. */
|
|
110
142
|
created_at: string
|
|
143
|
+
/** 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. */
|
|
111
144
|
errors?: any
|
|
145
|
+
/** 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. */
|
|
112
146
|
warnings?: any
|
|
147
|
+
/** Indicates whether Seam manages the access code. */
|
|
113
148
|
is_managed: true
|
|
149
|
+
/** Date and time at which the time-bound access code becomes active. */
|
|
114
150
|
starts_at?: (string | null) | undefined
|
|
151
|
+
/** Date and time after which the time-bound access code becomes inactive. */
|
|
115
152
|
ends_at?: (string | null) | undefined
|
|
153
|
+
/**
|
|
154
|
+
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.
|
|
155
|
+
*/
|
|
116
156
|
status: 'setting' | 'set' | 'unset' | 'removing' | 'unknown'
|
|
157
|
+
/** Indicates whether a backup access code is available for use if the primary access code is lost or compromised. */
|
|
117
158
|
is_backup_access_code_available: boolean
|
|
159
|
+
/** Indicates whether the access code is a backup code. */
|
|
118
160
|
is_backup?: boolean | undefined
|
|
161
|
+
/** Identifier of the pulled backup access code. Used to associate the pulled backup access code with the original access code. */
|
|
119
162
|
pulled_backup_access_code_id?: (string | null) | undefined
|
|
163
|
+
/** Indicates whether changes to the access code from external sources are permitted. */
|
|
120
164
|
is_external_modification_allowed: boolean
|
|
165
|
+
/** Indicates whether the access code can only be used once. If "true," the code becomes invalid after the first use. */
|
|
121
166
|
is_one_time_use: boolean
|
|
167
|
+
/** 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. */
|
|
122
168
|
is_offline_access_code: boolean
|
|
123
169
|
}>
|
|
124
170
|
}
|
|
@@ -191,26 +237,49 @@ export interface Routes {
|
|
|
191
237
|
formData: {}
|
|
192
238
|
jsonResponse: {
|
|
193
239
|
access_code: {
|
|
240
|
+
/** Unique identifier for a group of access codes that share the same code. */
|
|
194
241
|
common_code_key: string | null
|
|
242
|
+
/** Indicates whether the code is set on the device according to a preconfigured schedule. */
|
|
195
243
|
is_scheduled_on_device?: boolean | undefined
|
|
244
|
+
/** 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. */
|
|
196
245
|
type: 'time_bound' | 'ongoing'
|
|
246
|
+
/** Indicates whether the access code is waiting for a code assignment. */
|
|
197
247
|
is_waiting_for_code_assignment?: boolean | undefined
|
|
248
|
+
/** Unique identifier for the access code. */
|
|
198
249
|
access_code_id: string
|
|
250
|
+
/** Unique identifier for the device associated with the access code. */
|
|
199
251
|
device_id: string
|
|
252
|
+
/** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. */
|
|
200
253
|
name: string | null
|
|
254
|
+
/** Code used for access. Typically, a numeric or alphanumeric string. */
|
|
201
255
|
code: string | null
|
|
256
|
+
/** Date and time at which the access code was created. */
|
|
202
257
|
created_at: string
|
|
258
|
+
/** 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. */
|
|
203
259
|
errors?: any
|
|
260
|
+
/** 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. */
|
|
204
261
|
warnings?: any
|
|
262
|
+
/** Indicates whether Seam manages the access code. */
|
|
205
263
|
is_managed: true
|
|
264
|
+
/** Date and time at which the time-bound access code becomes active. */
|
|
206
265
|
starts_at?: (string | null) | undefined
|
|
266
|
+
/** Date and time after which the time-bound access code becomes inactive. */
|
|
207
267
|
ends_at?: (string | null) | undefined
|
|
268
|
+
/**
|
|
269
|
+
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.
|
|
270
|
+
*/
|
|
208
271
|
status: 'setting' | 'set' | 'unset' | 'removing' | 'unknown'
|
|
272
|
+
/** Indicates whether a backup access code is available for use if the primary access code is lost or compromised. */
|
|
209
273
|
is_backup_access_code_available: boolean
|
|
274
|
+
/** Indicates whether the access code is a backup code. */
|
|
210
275
|
is_backup?: boolean | undefined
|
|
276
|
+
/** Identifier of the pulled backup access code. Used to associate the pulled backup access code with the original access code. */
|
|
211
277
|
pulled_backup_access_code_id?: (string | null) | undefined
|
|
278
|
+
/** Indicates whether changes to the access code from external sources are permitted. */
|
|
212
279
|
is_external_modification_allowed: boolean
|
|
280
|
+
/** Indicates whether the access code can only be used once. If "true," the code becomes invalid after the first use. */
|
|
213
281
|
is_one_time_use: boolean
|
|
282
|
+
/** 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. */
|
|
214
283
|
is_offline_access_code: boolean
|
|
215
284
|
}
|
|
216
285
|
}
|
|
@@ -228,26 +297,49 @@ export interface Routes {
|
|
|
228
297
|
formData: {}
|
|
229
298
|
jsonResponse: {
|
|
230
299
|
access_codes: Array<{
|
|
300
|
+
/** Unique identifier for a group of access codes that share the same code. */
|
|
231
301
|
common_code_key: string | null
|
|
302
|
+
/** Indicates whether the code is set on the device according to a preconfigured schedule. */
|
|
232
303
|
is_scheduled_on_device?: boolean | undefined
|
|
304
|
+
/** 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. */
|
|
233
305
|
type: 'time_bound' | 'ongoing'
|
|
306
|
+
/** Indicates whether the access code is waiting for a code assignment. */
|
|
234
307
|
is_waiting_for_code_assignment?: boolean | undefined
|
|
308
|
+
/** Unique identifier for the access code. */
|
|
235
309
|
access_code_id: string
|
|
310
|
+
/** Unique identifier for the device associated with the access code. */
|
|
236
311
|
device_id: string
|
|
312
|
+
/** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. */
|
|
237
313
|
name: string | null
|
|
314
|
+
/** Code used for access. Typically, a numeric or alphanumeric string. */
|
|
238
315
|
code: string | null
|
|
316
|
+
/** Date and time at which the access code was created. */
|
|
239
317
|
created_at: string
|
|
318
|
+
/** 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. */
|
|
240
319
|
errors?: any
|
|
320
|
+
/** 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. */
|
|
241
321
|
warnings?: any
|
|
322
|
+
/** Indicates whether Seam manages the access code. */
|
|
242
323
|
is_managed: true
|
|
324
|
+
/** Date and time at which the time-bound access code becomes active. */
|
|
243
325
|
starts_at?: (string | null) | undefined
|
|
326
|
+
/** Date and time after which the time-bound access code becomes inactive. */
|
|
244
327
|
ends_at?: (string | null) | undefined
|
|
328
|
+
/**
|
|
329
|
+
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.
|
|
330
|
+
*/
|
|
245
331
|
status: 'setting' | 'set' | 'unset' | 'removing' | 'unknown'
|
|
332
|
+
/** Indicates whether a backup access code is available for use if the primary access code is lost or compromised. */
|
|
246
333
|
is_backup_access_code_available: boolean
|
|
334
|
+
/** Indicates whether the access code is a backup code. */
|
|
247
335
|
is_backup?: boolean | undefined
|
|
336
|
+
/** Identifier of the pulled backup access code. Used to associate the pulled backup access code with the original access code. */
|
|
248
337
|
pulled_backup_access_code_id?: (string | null) | undefined
|
|
338
|
+
/** Indicates whether changes to the access code from external sources are permitted. */
|
|
249
339
|
is_external_modification_allowed: boolean
|
|
340
|
+
/** Indicates whether the access code can only be used once. If "true," the code becomes invalid after the first use. */
|
|
250
341
|
is_one_time_use: boolean
|
|
342
|
+
/** 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. */
|
|
251
343
|
is_offline_access_code: boolean
|
|
252
344
|
}>
|
|
253
345
|
}
|
|
@@ -263,26 +355,49 @@ export interface Routes {
|
|
|
263
355
|
formData: {}
|
|
264
356
|
jsonResponse: {
|
|
265
357
|
backup_access_code: {
|
|
358
|
+
/** Unique identifier for a group of access codes that share the same code. */
|
|
266
359
|
common_code_key: string | null
|
|
360
|
+
/** Indicates whether the code is set on the device according to a preconfigured schedule. */
|
|
267
361
|
is_scheduled_on_device?: boolean | undefined
|
|
362
|
+
/** 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. */
|
|
268
363
|
type: 'time_bound' | 'ongoing'
|
|
364
|
+
/** Indicates whether the access code is waiting for a code assignment. */
|
|
269
365
|
is_waiting_for_code_assignment?: boolean | undefined
|
|
366
|
+
/** Unique identifier for the access code. */
|
|
270
367
|
access_code_id: string
|
|
368
|
+
/** Unique identifier for the device associated with the access code. */
|
|
271
369
|
device_id: string
|
|
370
|
+
/** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. */
|
|
272
371
|
name: string | null
|
|
372
|
+
/** Code used for access. Typically, a numeric or alphanumeric string. */
|
|
273
373
|
code: string | null
|
|
374
|
+
/** Date and time at which the access code was created. */
|
|
274
375
|
created_at: string
|
|
376
|
+
/** 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. */
|
|
275
377
|
errors?: any
|
|
378
|
+
/** 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. */
|
|
276
379
|
warnings?: any
|
|
380
|
+
/** Indicates whether Seam manages the access code. */
|
|
277
381
|
is_managed: true
|
|
382
|
+
/** Date and time at which the time-bound access code becomes active. */
|
|
278
383
|
starts_at?: (string | null) | undefined
|
|
384
|
+
/** Date and time after which the time-bound access code becomes inactive. */
|
|
279
385
|
ends_at?: (string | null) | undefined
|
|
386
|
+
/**
|
|
387
|
+
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.
|
|
388
|
+
*/
|
|
280
389
|
status: 'setting' | 'set' | 'unset' | 'removing' | 'unknown'
|
|
390
|
+
/** Indicates whether a backup access code is available for use if the primary access code is lost or compromised. */
|
|
281
391
|
is_backup_access_code_available: boolean
|
|
392
|
+
/** Indicates whether the access code is a backup code. */
|
|
282
393
|
is_backup?: boolean | undefined
|
|
394
|
+
/** Identifier of the pulled backup access code. Used to associate the pulled backup access code with the original access code. */
|
|
283
395
|
pulled_backup_access_code_id?: (string | null) | undefined
|
|
396
|
+
/** Indicates whether changes to the access code from external sources are permitted. */
|
|
284
397
|
is_external_modification_allowed: boolean
|
|
398
|
+
/** Indicates whether the access code can only be used once. If "true," the code becomes invalid after the first use. */
|
|
285
399
|
is_one_time_use: boolean
|
|
400
|
+
/** 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. */
|
|
286
401
|
is_offline_access_code: boolean
|
|
287
402
|
}
|
|
288
403
|
}
|
|
@@ -300,16 +415,26 @@ export interface Routes {
|
|
|
300
415
|
formData: {}
|
|
301
416
|
jsonResponse: {
|
|
302
417
|
access_code: {
|
|
418
|
+
/** 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. */
|
|
303
419
|
type: 'time_bound' | 'ongoing'
|
|
420
|
+
/** Unique identifier for the access code. */
|
|
304
421
|
access_code_id: string
|
|
422
|
+
/** Unique identifier for the device associated with the access code. */
|
|
305
423
|
device_id: string
|
|
424
|
+
/** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. */
|
|
306
425
|
name: string | null
|
|
426
|
+
/** Code used for access. Typically, a numeric or alphanumeric string. */
|
|
307
427
|
code: string | null
|
|
428
|
+
/** Date and time at which the access code was created. */
|
|
308
429
|
created_at: string
|
|
430
|
+
/** 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. */
|
|
309
431
|
errors?: any
|
|
432
|
+
/** 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. */
|
|
310
433
|
warnings?: any
|
|
311
434
|
is_managed: false
|
|
435
|
+
/** Date and time at which the time-bound access code becomes active. */
|
|
312
436
|
starts_at?: (string | null) | undefined
|
|
437
|
+
/** Date and time after which the time-bound access code becomes inactive. */
|
|
313
438
|
ends_at?: (string | null) | undefined
|
|
314
439
|
status: 'set'
|
|
315
440
|
}
|
|
@@ -381,16 +506,26 @@ export interface Routes {
|
|
|
381
506
|
formData: {}
|
|
382
507
|
jsonResponse: {
|
|
383
508
|
access_code: {
|
|
509
|
+
/** 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. */
|
|
384
510
|
type: 'time_bound' | 'ongoing'
|
|
511
|
+
/** Unique identifier for the access code. */
|
|
385
512
|
access_code_id: string
|
|
513
|
+
/** Unique identifier for the device associated with the access code. */
|
|
386
514
|
device_id: string
|
|
515
|
+
/** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. */
|
|
387
516
|
name: string | null
|
|
517
|
+
/** Code used for access. Typically, a numeric or alphanumeric string. */
|
|
388
518
|
code: string | null
|
|
519
|
+
/** Date and time at which the access code was created. */
|
|
389
520
|
created_at: string
|
|
521
|
+
/** 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. */
|
|
390
522
|
errors?: any
|
|
523
|
+
/** 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. */
|
|
391
524
|
warnings?: any
|
|
392
525
|
is_managed: false
|
|
526
|
+
/** Date and time at which the time-bound access code becomes active. */
|
|
393
527
|
starts_at?: (string | null) | undefined
|
|
528
|
+
/** Date and time after which the time-bound access code becomes inactive. */
|
|
394
529
|
ends_at?: (string | null) | undefined
|
|
395
530
|
status: 'set'
|
|
396
531
|
}
|
|
@@ -408,16 +543,26 @@ export interface Routes {
|
|
|
408
543
|
formData: {}
|
|
409
544
|
jsonResponse: {
|
|
410
545
|
access_codes: Array<{
|
|
546
|
+
/** 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. */
|
|
411
547
|
type: 'time_bound' | 'ongoing'
|
|
548
|
+
/** Unique identifier for the access code. */
|
|
412
549
|
access_code_id: string
|
|
550
|
+
/** Unique identifier for the device associated with the access code. */
|
|
413
551
|
device_id: string
|
|
552
|
+
/** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. */
|
|
414
553
|
name: string | null
|
|
554
|
+
/** Code used for access. Typically, a numeric or alphanumeric string. */
|
|
415
555
|
code: string | null
|
|
556
|
+
/** Date and time at which the access code was created. */
|
|
416
557
|
created_at: string
|
|
558
|
+
/** 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. */
|
|
417
559
|
errors?: any
|
|
560
|
+
/** 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. */
|
|
418
561
|
warnings?: any
|
|
419
562
|
is_managed: false
|
|
563
|
+
/** Date and time at which the time-bound access code becomes active. */
|
|
420
564
|
starts_at?: (string | null) | undefined
|
|
565
|
+
/** Date and time after which the time-bound access code becomes inactive. */
|
|
421
566
|
ends_at?: (string | null) | undefined
|
|
422
567
|
status: 'set'
|
|
423
568
|
}>
|
|
@@ -610,6 +755,27 @@ export interface Routes {
|
|
|
610
755
|
formData: {}
|
|
611
756
|
jsonResponse: {}
|
|
612
757
|
}
|
|
758
|
+
'/acs/credential_pools/list': {
|
|
759
|
+
route: '/acs/credential_pools/list'
|
|
760
|
+
method: 'GET' | 'POST'
|
|
761
|
+
queryParams: {}
|
|
762
|
+
jsonBody: {}
|
|
763
|
+
commonParams: {
|
|
764
|
+
acs_system_id: string
|
|
765
|
+
}
|
|
766
|
+
formData: {}
|
|
767
|
+
jsonResponse: {
|
|
768
|
+
acs_credential_pools: Array<{
|
|
769
|
+
acs_credential_pool_id: string
|
|
770
|
+
acs_system_id: string
|
|
771
|
+
display_name: string
|
|
772
|
+
external_type: 'hid_part_number'
|
|
773
|
+
external_type_display_name: string
|
|
774
|
+
created_at: string
|
|
775
|
+
workspace_id: string
|
|
776
|
+
}>
|
|
777
|
+
}
|
|
778
|
+
}
|
|
613
779
|
'/acs/credentials/assign': {
|
|
614
780
|
route: '/acs/credentials/assign'
|
|
615
781
|
method: 'PATCH' | 'POST'
|
|
@@ -624,10 +790,11 @@ export interface Routes {
|
|
|
624
790
|
acs_credential: {
|
|
625
791
|
acs_credential_id: string
|
|
626
792
|
acs_user_id?: string | undefined
|
|
793
|
+
acs_credential_pool_id?: string | undefined
|
|
627
794
|
acs_system_id: string
|
|
628
795
|
display_name: string
|
|
629
796
|
code: string | null
|
|
630
|
-
external_type: 'pti_card' | 'brivo_credential' | '
|
|
797
|
+
external_type: 'pti_card' | 'brivo_credential' | 'hid_credential'
|
|
631
798
|
external_type_display_name: string
|
|
632
799
|
created_at: string
|
|
633
800
|
workspace_id: string
|
|
@@ -648,10 +815,11 @@ export interface Routes {
|
|
|
648
815
|
acs_credential: {
|
|
649
816
|
acs_credential_id: string
|
|
650
817
|
acs_user_id?: string | undefined
|
|
818
|
+
acs_credential_pool_id?: string | undefined
|
|
651
819
|
acs_system_id: string
|
|
652
820
|
display_name: string
|
|
653
821
|
code: string | null
|
|
654
|
-
external_type: 'pti_card' | 'brivo_credential' | '
|
|
822
|
+
external_type: 'pti_card' | 'brivo_credential' | 'hid_credential'
|
|
655
823
|
external_type_display_name: string
|
|
656
824
|
created_at: string
|
|
657
825
|
workspace_id: string
|
|
@@ -682,10 +850,11 @@ export interface Routes {
|
|
|
682
850
|
acs_credential: {
|
|
683
851
|
acs_credential_id: string
|
|
684
852
|
acs_user_id?: string | undefined
|
|
853
|
+
acs_credential_pool_id?: string | undefined
|
|
685
854
|
acs_system_id: string
|
|
686
855
|
display_name: string
|
|
687
856
|
code: string | null
|
|
688
|
-
external_type: 'pti_card' | 'brivo_credential' | '
|
|
857
|
+
external_type: 'pti_card' | 'brivo_credential' | 'hid_credential'
|
|
689
858
|
external_type_display_name: string
|
|
690
859
|
created_at: string
|
|
691
860
|
workspace_id: string
|
|
@@ -713,10 +882,11 @@ export interface Routes {
|
|
|
713
882
|
acs_credentials: Array<{
|
|
714
883
|
acs_credential_id: string
|
|
715
884
|
acs_user_id?: string | undefined
|
|
885
|
+
acs_credential_pool_id?: string | undefined
|
|
716
886
|
acs_system_id: string
|
|
717
887
|
display_name: string
|
|
718
888
|
code: string | null
|
|
719
|
-
external_type: 'pti_card' | 'brivo_credential' | '
|
|
889
|
+
external_type: 'pti_card' | 'brivo_credential' | 'hid_credential'
|
|
720
890
|
external_type_display_name: string
|
|
721
891
|
created_at: string
|
|
722
892
|
workspace_id: string
|
|
@@ -737,10 +907,11 @@ export interface Routes {
|
|
|
737
907
|
acs_credential: {
|
|
738
908
|
acs_credential_id: string
|
|
739
909
|
acs_user_id?: string | undefined
|
|
910
|
+
acs_credential_pool_id?: string | undefined
|
|
740
911
|
acs_system_id: string
|
|
741
912
|
display_name: string
|
|
742
913
|
code: string | null
|
|
743
|
-
external_type: 'pti_card' | 'brivo_credential' | '
|
|
914
|
+
external_type: 'pti_card' | 'brivo_credential' | 'hid_credential'
|
|
744
915
|
external_type_display_name: string
|
|
745
916
|
created_at: string
|
|
746
917
|
workspace_id: string
|
|
@@ -1541,7 +1712,7 @@ export interface Routes {
|
|
|
1541
1712
|
display_name: string
|
|
1542
1713
|
manufacturer_display_name: string
|
|
1543
1714
|
offline_access_codes_supported?: boolean | undefined
|
|
1544
|
-
|
|
1715
|
+
online_access_codes_supported?: boolean | undefined
|
|
1545
1716
|
accessory_keypad_supported?: boolean | undefined
|
|
1546
1717
|
}
|
|
1547
1718
|
has_direct_power?: boolean | undefined
|
|
@@ -2248,7 +2419,7 @@ export interface Routes {
|
|
|
2248
2419
|
display_name: string
|
|
2249
2420
|
manufacturer_display_name: string
|
|
2250
2421
|
offline_access_codes_supported?: boolean | undefined
|
|
2251
|
-
|
|
2422
|
+
online_access_codes_supported?: boolean | undefined
|
|
2252
2423
|
accessory_keypad_supported?: boolean | undefined
|
|
2253
2424
|
}
|
|
2254
2425
|
has_direct_power?: boolean | undefined
|
|
@@ -3372,7 +3543,7 @@ export interface Routes {
|
|
|
3372
3543
|
display_name: string
|
|
3373
3544
|
manufacturer_display_name: string
|
|
3374
3545
|
offline_access_codes_supported?: boolean | undefined
|
|
3375
|
-
|
|
3546
|
+
online_access_codes_supported?: boolean | undefined
|
|
3376
3547
|
accessory_keypad_supported?: boolean | undefined
|
|
3377
3548
|
}
|
|
3378
3549
|
has_direct_power?: boolean | undefined
|
|
@@ -3958,7 +4129,7 @@ export interface Routes {
|
|
|
3958
4129
|
display_name: string
|
|
3959
4130
|
manufacturer_display_name: string
|
|
3960
4131
|
offline_access_codes_supported?: boolean | undefined
|
|
3961
|
-
|
|
4132
|
+
online_access_codes_supported?: boolean | undefined
|
|
3962
4133
|
accessory_keypad_supported?: boolean | undefined
|
|
3963
4134
|
}
|
|
3964
4135
|
has_direct_power?: boolean | undefined
|
|
@@ -4665,7 +4836,7 @@ export interface Routes {
|
|
|
4665
4836
|
display_name: string
|
|
4666
4837
|
manufacturer_display_name: string
|
|
4667
4838
|
offline_access_codes_supported?: boolean | undefined
|
|
4668
|
-
|
|
4839
|
+
online_access_codes_supported?: boolean | undefined
|
|
4669
4840
|
accessory_keypad_supported?: boolean | undefined
|
|
4670
4841
|
}
|
|
4671
4842
|
has_direct_power?: boolean | undefined
|
|
@@ -5251,7 +5422,7 @@ export interface Routes {
|
|
|
5251
5422
|
display_name: string
|
|
5252
5423
|
manufacturer_display_name: string
|
|
5253
5424
|
offline_access_codes_supported?: boolean | undefined
|
|
5254
|
-
|
|
5425
|
+
online_access_codes_supported?: boolean | undefined
|
|
5255
5426
|
accessory_keypad_supported?: boolean | undefined
|
|
5256
5427
|
}
|
|
5257
5428
|
has_direct_power?: boolean | undefined
|
|
@@ -6272,7 +6443,7 @@ export interface Routes {
|
|
|
6272
6443
|
display_name: string
|
|
6273
6444
|
manufacturer_display_name: string
|
|
6274
6445
|
offline_access_codes_supported?: boolean | undefined
|
|
6275
|
-
|
|
6446
|
+
online_access_codes_supported?: boolean | undefined
|
|
6276
6447
|
accessory_keypad_supported?: boolean | undefined
|
|
6277
6448
|
}
|
|
6278
6449
|
has_direct_power?: boolean | undefined
|
|
@@ -7009,7 +7180,7 @@ export interface Routes {
|
|
|
7009
7180
|
display_name: string
|
|
7010
7181
|
manufacturer_display_name: string
|
|
7011
7182
|
offline_access_codes_supported?: boolean | undefined
|
|
7012
|
-
|
|
7183
|
+
online_access_codes_supported?: boolean | undefined
|
|
7013
7184
|
accessory_keypad_supported?: boolean | undefined
|
|
7014
7185
|
}
|
|
7015
7186
|
has_direct_power?: boolean | undefined
|
|
@@ -7721,7 +7892,7 @@ export interface Routes {
|
|
|
7721
7892
|
display_name: string
|
|
7722
7893
|
manufacturer_display_name: string
|
|
7723
7894
|
offline_access_codes_supported?: boolean | undefined
|
|
7724
|
-
|
|
7895
|
+
online_access_codes_supported?: boolean | undefined
|
|
7725
7896
|
accessory_keypad_supported?: boolean | undefined
|
|
7726
7897
|
}
|
|
7727
7898
|
has_direct_power?: boolean | undefined
|