@seamapi/http 2.23.6 → 2.24.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/README.md +5 -0
- package/lib/request-parameters.d.ts +1 -1
- package/lib/request-parameters.js +3 -3
- package/lib/request-parameters.js.map +1 -1
- package/lib/resolve-action-attempt.d.ts +2 -0
- package/lib/resolve-action-attempt.js +25 -27
- package/lib/resolve-action-attempt.js.map +1 -1
- package/lib/routes/access-codes/access-codes.d.ts +5 -5
- package/lib/routes/access-codes/access-codes.js +20 -1
- package/lib/routes/access-codes/access-codes.js.map +1 -1
- package/lib/routes/access-codes/simulate/simulate.d.ts +2 -2
- package/lib/routes/access-codes/simulate/simulate.js +2 -1
- package/lib/routes/access-codes/simulate/simulate.js.map +1 -1
- package/lib/routes/access-codes/unmanaged/unmanaged.d.ts +4 -4
- package/lib/routes/access-codes/unmanaged/unmanaged.js +6 -1
- package/lib/routes/access-codes/unmanaged/unmanaged.js.map +1 -1
- package/lib/routes/access-grants/access-grants.d.ts +6 -6
- package/lib/routes/access-grants/access-grants.js +19 -1
- package/lib/routes/access-grants/access-grants.js.map +1 -1
- package/lib/routes/access-grants/unmanaged/unmanaged.d.ts +3 -3
- package/lib/routes/access-grants/unmanaged/unmanaged.js +4 -1
- package/lib/routes/access-grants/unmanaged/unmanaged.js.map +1 -1
- package/lib/routes/access-methods/access-methods.d.ts +5 -5
- package/lib/routes/access-methods/access-methods.js +22 -4
- package/lib/routes/access-methods/access-methods.js.map +1 -1
- package/lib/routes/access-methods/unmanaged/unmanaged.d.ts +2 -2
- package/lib/routes/access-methods/unmanaged/unmanaged.js +3 -1
- package/lib/routes/access-methods/unmanaged/unmanaged.js.map +1 -1
- package/lib/routes/acs/access-groups/access-groups.d.ts +2 -2
- package/lib/routes/acs/access-groups/access-groups.js +8 -1
- package/lib/routes/acs/access-groups/access-groups.js.map +1 -1
- package/lib/routes/acs/acs.d.ts +2 -2
- package/lib/routes/acs/acs.js.map +1 -1
- package/lib/routes/acs/credentials/credentials.d.ts +3 -3
- package/lib/routes/acs/credentials/credentials.js +9 -1
- package/lib/routes/acs/credentials/credentials.js.map +1 -1
- package/lib/routes/acs/encoders/encoders.d.ts +3 -3
- package/lib/routes/acs/encoders/encoders.js +9 -4
- package/lib/routes/acs/encoders/encoders.js.map +1 -1
- package/lib/routes/acs/encoders/simulate/simulate.d.ts +2 -2
- package/lib/routes/acs/encoders/simulate/simulate.js +5 -1
- package/lib/routes/acs/encoders/simulate/simulate.js.map +1 -1
- package/lib/routes/acs/entrances/entrances.d.ts +3 -3
- package/lib/routes/acs/entrances/entrances.js +7 -2
- package/lib/routes/acs/entrances/entrances.js.map +1 -1
- package/lib/routes/acs/systems/systems.d.ts +2 -2
- package/lib/routes/acs/systems/systems.js +5 -1
- package/lib/routes/acs/systems/systems.js.map +1 -1
- package/lib/routes/acs/users/users.d.ts +10 -10
- package/lib/routes/acs/users/users.js +46 -1
- package/lib/routes/acs/users/users.js.map +1 -1
- package/lib/routes/action-attempts/action-attempts.d.ts +3 -3
- package/lib/routes/action-attempts/action-attempts.js +4 -2
- package/lib/routes/action-attempts/action-attempts.js.map +1 -1
- package/lib/routes/client-sessions/client-sessions.d.ts +3 -3
- package/lib/routes/client-sessions/client-sessions.js +15 -1
- package/lib/routes/client-sessions/client-sessions.js.map +1 -1
- package/lib/routes/connect-webviews/connect-webviews.d.ts +3 -3
- package/lib/routes/connect-webviews/connect-webviews.js +5 -1
- package/lib/routes/connect-webviews/connect-webviews.js.map +1 -1
- package/lib/routes/connected-accounts/connected-accounts.d.ts +4 -4
- package/lib/routes/connected-accounts/connected-accounts.js +6 -1
- package/lib/routes/connected-accounts/connected-accounts.js.map +1 -1
- package/lib/routes/connected-accounts/simulate/simulate.d.ts +2 -2
- package/lib/routes/connected-accounts/simulate/simulate.js +2 -1
- package/lib/routes/connected-accounts/simulate/simulate.js.map +1 -1
- package/lib/routes/customers/customers.d.ts +2 -2
- package/lib/routes/customers/customers.js +4 -1
- package/lib/routes/customers/customers.js.map +1 -1
- package/lib/routes/devices/devices.d.ts +4 -4
- package/lib/routes/devices/devices.js +6 -1
- package/lib/routes/devices/devices.js.map +1 -1
- package/lib/routes/devices/simulate/simulate.d.ts +2 -2
- package/lib/routes/devices/simulate/simulate.js +7 -1
- package/lib/routes/devices/simulate/simulate.js.map +1 -1
- package/lib/routes/devices/unmanaged/unmanaged.d.ts +4 -4
- package/lib/routes/devices/unmanaged/unmanaged.js +4 -1
- package/lib/routes/devices/unmanaged/unmanaged.js.map +1 -1
- package/lib/routes/events/events.d.ts +4 -4
- package/lib/routes/events/events.js +31 -1
- package/lib/routes/events/events.js.map +1 -1
- package/lib/routes/instant-keys/instant-keys.d.ts +3 -3
- package/lib/routes/instant-keys/instant-keys.js +4 -1
- package/lib/routes/instant-keys/instant-keys.js.map +1 -1
- package/lib/routes/locks/locks.d.ts +3 -3
- package/lib/routes/locks/locks.js +9 -4
- package/lib/routes/locks/locks.js.map +1 -1
- package/lib/routes/locks/simulate/simulate.d.ts +2 -2
- package/lib/routes/locks/simulate/simulate.js +5 -3
- package/lib/routes/locks/simulate/simulate.js.map +1 -1
- package/lib/routes/noise-sensors/noise-sensors.d.ts +2 -2
- package/lib/routes/noise-sensors/noise-sensors.js +2 -1
- package/lib/routes/noise-sensors/noise-sensors.js.map +1 -1
- package/lib/routes/noise-sensors/noise-thresholds/noise-thresholds.d.ts +2 -2
- package/lib/routes/noise-sensors/noise-thresholds/noise-thresholds.js +6 -1
- package/lib/routes/noise-sensors/noise-thresholds/noise-thresholds.js.map +1 -1
- package/lib/routes/noise-sensors/simulate/simulate.d.ts +2 -2
- package/lib/routes/noise-sensors/simulate/simulate.js +2 -1
- package/lib/routes/noise-sensors/simulate/simulate.js.map +1 -1
- package/lib/routes/phones/phones.d.ts +2 -2
- package/lib/routes/phones/phones.js +4 -1
- package/lib/routes/phones/phones.js.map +1 -1
- package/lib/routes/phones/simulate/simulate.d.ts +2 -2
- package/lib/routes/phones/simulate/simulate.js +2 -1
- package/lib/routes/phones/simulate/simulate.js.map +1 -1
- package/lib/routes/seam-http-endpoints.d.ts +2 -2
- package/lib/routes/seam-http-endpoints.js.map +1 -1
- package/lib/routes/seam-http.d.ts +2 -2
- package/lib/routes/seam-http.js.map +1 -1
- package/lib/routes/spaces/spaces.d.ts +5 -5
- package/lib/routes/spaces/spaces.js +18 -1
- package/lib/routes/spaces/spaces.js.map +1 -1
- package/lib/routes/thermostats/daily-programs/daily-programs.d.ts +2 -2
- package/lib/routes/thermostats/daily-programs/daily-programs.js +5 -2
- package/lib/routes/thermostats/daily-programs/daily-programs.js.map +1 -1
- package/lib/routes/thermostats/schedules/schedules.d.ts +2 -2
- package/lib/routes/thermostats/schedules/schedules.js +6 -1
- package/lib/routes/thermostats/schedules/schedules.js.map +1 -1
- package/lib/routes/thermostats/simulate/simulate.d.ts +2 -2
- package/lib/routes/thermostats/simulate/simulate.js +3 -1
- package/lib/routes/thermostats/simulate/simulate.js.map +1 -1
- package/lib/routes/thermostats/thermostats.d.ts +2 -2
- package/lib/routes/thermostats/thermostats.js +23 -9
- package/lib/routes/thermostats/thermostats.js.map +1 -1
- package/lib/routes/user-identities/unmanaged/unmanaged.d.ts +3 -3
- package/lib/routes/user-identities/unmanaged/unmanaged.js +4 -1
- package/lib/routes/user-identities/unmanaged/unmanaged.js.map +1 -1
- package/lib/routes/user-identities/user-identities.d.ts +5 -5
- package/lib/routes/user-identities/user-identities.js +21 -1
- package/lib/routes/user-identities/user-identities.js.map +1 -1
- package/lib/routes/webhooks/webhooks.d.ts +2 -2
- package/lib/routes/webhooks/webhooks.js +6 -1
- package/lib/routes/webhooks/webhooks.js.map +1 -1
- package/lib/routes/workspaces/workspaces.d.ts +2 -2
- package/lib/routes/workspaces/workspaces.js +7 -2
- package/lib/routes/workspaces/workspaces.js.map +1 -1
- package/lib/seam-http-request.d.ts +8 -3
- package/lib/seam-http-request.js +15 -6
- package/lib/seam-http-request.js.map +1 -1
- package/lib/seam-paginator.d.ts +2 -2
- package/lib/seam-paginator.js +12 -8
- package/lib/seam-paginator.js.map +1 -1
- package/lib/version.d.ts +1 -1
- package/lib/version.js +1 -1
- package/package.json +1 -1
- package/src/lib/request-parameters.ts +5 -2
- package/src/lib/resolve-action-attempt.ts +34 -37
- package/src/lib/routes/access-codes/access-codes.ts +94 -59
- package/src/lib/routes/access-codes/simulate/simulate.ts +6 -2
- package/src/lib/routes/access-codes/unmanaged/unmanaged.ts +28 -17
- package/src/lib/routes/access-grants/access-grants.ts +101 -71
- package/src/lib/routes/access-grants/unmanaged/unmanaged.ts +9 -3
- package/src/lib/routes/access-methods/access-methods.ts +98 -63
- package/src/lib/routes/access-methods/unmanaged/unmanaged.ts +7 -2
- package/src/lib/routes/acs/access-groups/access-groups.ts +12 -2
- package/src/lib/routes/acs/acs.ts +2 -2
- package/src/lib/routes/acs/credentials/credentials.ts +14 -3
- package/src/lib/routes/acs/encoders/encoders.ts +26 -15
- package/src/lib/routes/acs/encoders/simulate/simulate.ts +9 -2
- package/src/lib/routes/acs/entrances/entrances.ts +16 -7
- package/src/lib/routes/acs/systems/systems.ts +9 -2
- package/src/lib/routes/acs/users/users.ts +214 -137
- package/src/lib/routes/action-attempts/action-attempts.ts +13 -7
- package/src/lib/routes/client-sessions/client-sessions.ts +54 -29
- package/src/lib/routes/connect-webviews/connect-webviews.ts +10 -3
- package/src/lib/routes/connected-accounts/connected-accounts.ts +24 -13
- package/src/lib/routes/connected-accounts/simulate/simulate.ts +6 -2
- package/src/lib/routes/customers/customers.ts +8 -2
- package/src/lib/routes/devices/devices.ts +27 -13
- package/src/lib/routes/devices/simulate/simulate.ts +11 -2
- package/src/lib/routes/devices/unmanaged/unmanaged.ts +22 -13
- package/src/lib/routes/events/events.ts +427 -362
- package/src/lib/routes/instant-keys/instant-keys.ts +21 -12
- package/src/lib/routes/locks/locks.ts +38 -24
- package/src/lib/routes/locks/simulate/simulate.ts +17 -10
- package/src/lib/routes/noise-sensors/noise-sensors.ts +6 -2
- package/src/lib/routes/noise-sensors/noise-thresholds/noise-thresholds.ts +10 -2
- package/src/lib/routes/noise-sensors/simulate/simulate.ts +6 -2
- package/src/lib/routes/phones/phones.ts +8 -2
- package/src/lib/routes/phones/simulate/simulate.ts +6 -2
- package/src/lib/routes/seam-http-endpoints.ts +2 -2
- package/src/lib/routes/seam-http.ts +2 -2
- package/src/lib/routes/spaces/spaces.ts +73 -44
- package/src/lib/routes/thermostats/daily-programs/daily-programs.ts +13 -6
- package/src/lib/routes/thermostats/schedules/schedules.ts +10 -2
- package/src/lib/routes/thermostats/simulate/simulate.ts +7 -2
- package/src/lib/routes/thermostats/thermostats.ts +59 -34
- package/src/lib/routes/user-identities/unmanaged/unmanaged.ts +9 -3
- package/src/lib/routes/user-identities/user-identities.ts +60 -28
- package/src/lib/routes/webhooks/webhooks.ts +10 -2
- package/src/lib/routes/workspaces/workspaces.ts +15 -6
- package/src/lib/seam-http-request.ts +30 -8
- package/src/lib/seam-paginator.ts +22 -12
- package/src/lib/version.ts +1 -1
|
@@ -32,7 +32,10 @@ import type { RequireAtLeastOne } from 'lib/request-parameters.js'
|
|
|
32
32
|
import type { AcsEntrance } from 'lib/resources/acs-entrance.js'
|
|
33
33
|
import type { AcsUser } from 'lib/resources/acs-user.js'
|
|
34
34
|
import { SeamHttpClientSessions } from 'lib/routes/client-sessions/index.js'
|
|
35
|
-
import {
|
|
35
|
+
import {
|
|
36
|
+
SeamHttpRequest,
|
|
37
|
+
type SeamPaginatedRequest,
|
|
38
|
+
} from 'lib/seam-http-request.js'
|
|
36
39
|
import { SeamPaginator } from 'lib/seam-paginator.js'
|
|
37
40
|
|
|
38
41
|
export class SeamHttpAcsUsers {
|
|
@@ -136,7 +139,7 @@ export class SeamHttpAcsUsers {
|
|
|
136
139
|
}
|
|
137
140
|
|
|
138
141
|
createPaginator<const TResponse, const TResponseKey extends keyof TResponse>(
|
|
139
|
-
request:
|
|
142
|
+
request: SeamPaginatedRequest<TResponse, TResponseKey>,
|
|
140
143
|
): SeamPaginator<TResponse, TResponseKey> {
|
|
141
144
|
return new SeamPaginator<TResponse, TResponseKey>(this, request)
|
|
142
145
|
}
|
|
@@ -174,6 +177,7 @@ export class SeamHttpAcsUsers {
|
|
|
174
177
|
parameters,
|
|
175
178
|
hasRequiredParameters: true,
|
|
176
179
|
requiredParameterNames: ['acs_access_group_id', 'acs_user_id'],
|
|
180
|
+
atLeastOneParameterNames: [],
|
|
177
181
|
responseKey: undefined,
|
|
178
182
|
options,
|
|
179
183
|
})
|
|
@@ -193,6 +197,7 @@ export class SeamHttpAcsUsers {
|
|
|
193
197
|
parameters,
|
|
194
198
|
hasRequiredParameters: true,
|
|
195
199
|
requiredParameterNames: ['acs_system_id', 'full_name'],
|
|
200
|
+
atLeastOneParameterNames: [],
|
|
196
201
|
responseKey: 'acs_user',
|
|
197
202
|
options,
|
|
198
203
|
})
|
|
@@ -212,6 +217,11 @@ export class SeamHttpAcsUsers {
|
|
|
212
217
|
parameters,
|
|
213
218
|
hasRequiredParameters: true,
|
|
214
219
|
requiredParameterNames: [],
|
|
220
|
+
atLeastOneParameterNames: [
|
|
221
|
+
'acs_system_id',
|
|
222
|
+
'acs_user_id',
|
|
223
|
+
'user_identity_id',
|
|
224
|
+
],
|
|
215
225
|
responseKey: undefined,
|
|
216
226
|
options,
|
|
217
227
|
})
|
|
@@ -231,6 +241,11 @@ export class SeamHttpAcsUsers {
|
|
|
231
241
|
parameters,
|
|
232
242
|
hasRequiredParameters: true,
|
|
233
243
|
requiredParameterNames: [],
|
|
244
|
+
atLeastOneParameterNames: [
|
|
245
|
+
'acs_system_id',
|
|
246
|
+
'acs_user_id',
|
|
247
|
+
'user_identity_id',
|
|
248
|
+
],
|
|
234
249
|
responseKey: 'acs_user',
|
|
235
250
|
options,
|
|
236
251
|
})
|
|
@@ -250,6 +265,7 @@ export class SeamHttpAcsUsers {
|
|
|
250
265
|
parameters,
|
|
251
266
|
hasRequiredParameters: false,
|
|
252
267
|
requiredParameterNames: [],
|
|
268
|
+
atLeastOneParameterNames: [],
|
|
253
269
|
responseKey: 'acs_users',
|
|
254
270
|
hasPagination: true,
|
|
255
271
|
options,
|
|
@@ -270,6 +286,11 @@ export class SeamHttpAcsUsers {
|
|
|
270
286
|
parameters,
|
|
271
287
|
hasRequiredParameters: true,
|
|
272
288
|
requiredParameterNames: [],
|
|
289
|
+
atLeastOneParameterNames: [
|
|
290
|
+
'acs_system_id',
|
|
291
|
+
'acs_user_id',
|
|
292
|
+
'user_identity_id',
|
|
293
|
+
],
|
|
273
294
|
responseKey: 'acs_entrances',
|
|
274
295
|
options,
|
|
275
296
|
})
|
|
@@ -289,6 +310,7 @@ export class SeamHttpAcsUsers {
|
|
|
289
310
|
parameters,
|
|
290
311
|
hasRequiredParameters: true,
|
|
291
312
|
requiredParameterNames: ['acs_access_group_id'],
|
|
313
|
+
atLeastOneParameterNames: [],
|
|
292
314
|
responseKey: undefined,
|
|
293
315
|
options,
|
|
294
316
|
})
|
|
@@ -308,6 +330,11 @@ export class SeamHttpAcsUsers {
|
|
|
308
330
|
parameters,
|
|
309
331
|
hasRequiredParameters: true,
|
|
310
332
|
requiredParameterNames: [],
|
|
333
|
+
atLeastOneParameterNames: [
|
|
334
|
+
'acs_system_id',
|
|
335
|
+
'acs_user_id',
|
|
336
|
+
'user_identity_id',
|
|
337
|
+
],
|
|
311
338
|
responseKey: undefined,
|
|
312
339
|
options,
|
|
313
340
|
})
|
|
@@ -327,6 +354,11 @@ export class SeamHttpAcsUsers {
|
|
|
327
354
|
parameters,
|
|
328
355
|
hasRequiredParameters: true,
|
|
329
356
|
requiredParameterNames: [],
|
|
357
|
+
atLeastOneParameterNames: [
|
|
358
|
+
'acs_system_id',
|
|
359
|
+
'acs_user_id',
|
|
360
|
+
'user_identity_id',
|
|
361
|
+
],
|
|
330
362
|
responseKey: undefined,
|
|
331
363
|
options,
|
|
332
364
|
})
|
|
@@ -346,6 +378,11 @@ export class SeamHttpAcsUsers {
|
|
|
346
378
|
parameters,
|
|
347
379
|
hasRequiredParameters: true,
|
|
348
380
|
requiredParameterNames: [],
|
|
381
|
+
atLeastOneParameterNames: [
|
|
382
|
+
'acs_system_id',
|
|
383
|
+
'acs_user_id',
|
|
384
|
+
'user_identity_id',
|
|
385
|
+
],
|
|
349
386
|
responseKey: undefined,
|
|
350
387
|
options,
|
|
351
388
|
})
|
|
@@ -365,6 +402,17 @@ export class SeamHttpAcsUsers {
|
|
|
365
402
|
parameters,
|
|
366
403
|
hasRequiredParameters: true,
|
|
367
404
|
requiredParameterNames: [],
|
|
405
|
+
atLeastOneParameterNames: [
|
|
406
|
+
'access_schedule',
|
|
407
|
+
'acs_system_id',
|
|
408
|
+
'acs_user_id',
|
|
409
|
+
'email',
|
|
410
|
+
'email_address',
|
|
411
|
+
'full_name',
|
|
412
|
+
'hid_acs_system_id',
|
|
413
|
+
'phone_number',
|
|
414
|
+
'user_identity_id',
|
|
415
|
+
],
|
|
368
416
|
responseKey: undefined,
|
|
369
417
|
options,
|
|
370
418
|
})
|
|
@@ -452,20 +500,23 @@ export type AcsUsersCreateRequest = SeamHttpRequest<
|
|
|
452
500
|
|
|
453
501
|
export interface AcsUsersCreateOptions {}
|
|
454
502
|
|
|
455
|
-
export type AcsUsersDeleteParameters = RequireAtLeastOne<
|
|
456
|
-
|
|
457
|
-
|
|
458
|
-
|
|
459
|
-
|
|
460
|
-
|
|
461
|
-
|
|
462
|
-
|
|
463
|
-
|
|
464
|
-
|
|
465
|
-
|
|
466
|
-
|
|
467
|
-
|
|
468
|
-
|
|
503
|
+
export type AcsUsersDeleteParameters = RequireAtLeastOne<
|
|
504
|
+
{
|
|
505
|
+
/**
|
|
506
|
+
* ID of the access system that you want to delete. You must provide acs_system_id with user_identity_id.
|
|
507
|
+
*/
|
|
508
|
+
acs_system_id?: string | undefined
|
|
509
|
+
/**
|
|
510
|
+
* ID of the access system user that you want to delete. You must provide either acs_user_id or user_identity_id
|
|
511
|
+
*/
|
|
512
|
+
acs_user_id?: string | undefined
|
|
513
|
+
/**
|
|
514
|
+
* ID of the user identity that you want to delete. You must provide either acs_user_id or user_identity_id. If you provide user_identity_id, you must also provide acs_system_id.
|
|
515
|
+
*/
|
|
516
|
+
user_identity_id?: string | undefined
|
|
517
|
+
},
|
|
518
|
+
'acs_system_id' | 'acs_user_id' | 'user_identity_id'
|
|
519
|
+
>
|
|
469
520
|
|
|
470
521
|
/**
|
|
471
522
|
* @deprecated Use AcsUsersDeleteRequest instead.
|
|
@@ -476,20 +527,23 @@ export type AcsUsersDeleteRequest = SeamHttpRequest<void, undefined>
|
|
|
476
527
|
|
|
477
528
|
export interface AcsUsersDeleteOptions {}
|
|
478
529
|
|
|
479
|
-
export type AcsUsersGetParameters = RequireAtLeastOne<
|
|
480
|
-
|
|
481
|
-
|
|
482
|
-
|
|
483
|
-
|
|
484
|
-
|
|
485
|
-
|
|
486
|
-
|
|
487
|
-
|
|
488
|
-
|
|
489
|
-
|
|
490
|
-
|
|
491
|
-
|
|
492
|
-
|
|
530
|
+
export type AcsUsersGetParameters = RequireAtLeastOne<
|
|
531
|
+
{
|
|
532
|
+
/**
|
|
533
|
+
* ID of the access system that you want to get. You can only provide acs_user_id or user_identity_id.
|
|
534
|
+
*/
|
|
535
|
+
acs_system_id?: string | undefined
|
|
536
|
+
/**
|
|
537
|
+
* ID of the access system user that you want to get. You can only provide acs_user_id or user_identity_id.
|
|
538
|
+
*/
|
|
539
|
+
acs_user_id?: string | undefined
|
|
540
|
+
/**
|
|
541
|
+
* ID of the user identity that you want to get. You can only provide acs_user_id or user_identity_id.
|
|
542
|
+
*/
|
|
543
|
+
user_identity_id?: string | undefined
|
|
544
|
+
},
|
|
545
|
+
'acs_system_id' | 'acs_user_id' | 'user_identity_id'
|
|
546
|
+
>
|
|
493
547
|
|
|
494
548
|
/**
|
|
495
549
|
* @deprecated Use AcsUsersGetRequest instead.
|
|
@@ -543,27 +597,30 @@ export type AcsUsersListParameters = {
|
|
|
543
597
|
*/
|
|
544
598
|
export type AcsUsersListResponse = { acs_users: Array<AcsUser> }
|
|
545
599
|
|
|
546
|
-
export type AcsUsersListRequest =
|
|
600
|
+
export type AcsUsersListRequest = SeamPaginatedRequest<
|
|
547
601
|
AcsUsersListResponse,
|
|
548
602
|
'acs_users'
|
|
549
603
|
>
|
|
550
604
|
|
|
551
605
|
export interface AcsUsersListOptions {}
|
|
552
606
|
|
|
553
|
-
export type AcsUsersListAccessibleEntrancesParameters = RequireAtLeastOne<
|
|
554
|
-
|
|
555
|
-
|
|
556
|
-
|
|
557
|
-
|
|
558
|
-
|
|
559
|
-
|
|
560
|
-
|
|
561
|
-
|
|
562
|
-
|
|
563
|
-
|
|
564
|
-
|
|
565
|
-
|
|
566
|
-
|
|
607
|
+
export type AcsUsersListAccessibleEntrancesParameters = RequireAtLeastOne<
|
|
608
|
+
{
|
|
609
|
+
/**
|
|
610
|
+
* ID of the access system for which you want to list accessible entrances. You can only provide acs_system_id with user_identity_id.
|
|
611
|
+
*/
|
|
612
|
+
acs_system_id?: string | undefined
|
|
613
|
+
/**
|
|
614
|
+
* ID of the access system user for whom you want to list accessible entrances. You can only provide acs_user_id or user_identity_id.
|
|
615
|
+
*/
|
|
616
|
+
acs_user_id?: string | undefined
|
|
617
|
+
/**
|
|
618
|
+
* ID of the user identity for whom you want to list accessible entrances. You can only provide acs_user_id or user_identity_id.
|
|
619
|
+
*/
|
|
620
|
+
user_identity_id?: string | undefined
|
|
621
|
+
},
|
|
622
|
+
'acs_system_id' | 'acs_user_id' | 'user_identity_id'
|
|
623
|
+
>
|
|
567
624
|
|
|
568
625
|
/**
|
|
569
626
|
* @deprecated Use AcsUsersListAccessibleEntrancesRequest instead.
|
|
@@ -607,20 +664,23 @@ export type AcsUsersRemoveFromAccessGroupRequest = SeamHttpRequest<
|
|
|
607
664
|
|
|
608
665
|
export interface AcsUsersRemoveFromAccessGroupOptions {}
|
|
609
666
|
|
|
610
|
-
export type AcsUsersRevokeAccessToAllEntrancesParameters = RequireAtLeastOne<
|
|
611
|
-
|
|
612
|
-
|
|
613
|
-
|
|
614
|
-
|
|
615
|
-
|
|
616
|
-
|
|
617
|
-
|
|
618
|
-
|
|
619
|
-
|
|
620
|
-
|
|
621
|
-
|
|
622
|
-
|
|
623
|
-
|
|
667
|
+
export type AcsUsersRevokeAccessToAllEntrancesParameters = RequireAtLeastOne<
|
|
668
|
+
{
|
|
669
|
+
/**
|
|
670
|
+
* ID of the access system for which you want to revoke access. You can only provide acs_system_id with user_identity_id.
|
|
671
|
+
*/
|
|
672
|
+
acs_system_id?: string | undefined
|
|
673
|
+
/**
|
|
674
|
+
* ID of the access system user for whom you want to revoke access. You can only provide acs_user_id or user_identity_id.
|
|
675
|
+
*/
|
|
676
|
+
acs_user_id?: string | undefined
|
|
677
|
+
/**
|
|
678
|
+
* ID of the user identity for whom you want to revoke access. You can only provide acs_user_id or user_identity_id.
|
|
679
|
+
*/
|
|
680
|
+
user_identity_id?: string | undefined
|
|
681
|
+
},
|
|
682
|
+
'acs_system_id' | 'acs_user_id' | 'user_identity_id'
|
|
683
|
+
>
|
|
624
684
|
|
|
625
685
|
/**
|
|
626
686
|
* @deprecated Use AcsUsersRevokeAccessToAllEntrancesRequest instead.
|
|
@@ -634,20 +694,23 @@ export type AcsUsersRevokeAccessToAllEntrancesRequest = SeamHttpRequest<
|
|
|
634
694
|
|
|
635
695
|
export interface AcsUsersRevokeAccessToAllEntrancesOptions {}
|
|
636
696
|
|
|
637
|
-
export type AcsUsersSuspendParameters = RequireAtLeastOne<
|
|
638
|
-
|
|
639
|
-
|
|
640
|
-
|
|
641
|
-
|
|
642
|
-
|
|
643
|
-
|
|
644
|
-
|
|
645
|
-
|
|
646
|
-
|
|
647
|
-
|
|
648
|
-
|
|
649
|
-
|
|
650
|
-
|
|
697
|
+
export type AcsUsersSuspendParameters = RequireAtLeastOne<
|
|
698
|
+
{
|
|
699
|
+
/**
|
|
700
|
+
* ID of the access system that you want to suspend. You can only provide acs_user_id or the combination of acs_system_id and user_identity_id.
|
|
701
|
+
*/
|
|
702
|
+
acs_system_id?: string | undefined
|
|
703
|
+
/**
|
|
704
|
+
* ID of the access system user that you want to suspend. You can only provide acs_user_id or the combination of acs_system_id and user_identity_id.
|
|
705
|
+
*/
|
|
706
|
+
acs_user_id?: string | undefined
|
|
707
|
+
/**
|
|
708
|
+
* ID of the user identity that you want to suspend. You can only provide acs_user_id or the combination of acs_system_id and user_identity_id.
|
|
709
|
+
*/
|
|
710
|
+
user_identity_id?: string | undefined
|
|
711
|
+
},
|
|
712
|
+
'acs_system_id' | 'acs_user_id' | 'user_identity_id'
|
|
713
|
+
>
|
|
651
714
|
|
|
652
715
|
/**
|
|
653
716
|
* @deprecated Use AcsUsersSuspendRequest instead.
|
|
@@ -658,20 +721,23 @@ export type AcsUsersSuspendRequest = SeamHttpRequest<void, undefined>
|
|
|
658
721
|
|
|
659
722
|
export interface AcsUsersSuspendOptions {}
|
|
660
723
|
|
|
661
|
-
export type AcsUsersUnsuspendParameters = RequireAtLeastOne<
|
|
662
|
-
|
|
663
|
-
|
|
664
|
-
|
|
665
|
-
|
|
666
|
-
|
|
667
|
-
|
|
668
|
-
|
|
669
|
-
|
|
670
|
-
|
|
671
|
-
|
|
672
|
-
|
|
673
|
-
|
|
674
|
-
|
|
724
|
+
export type AcsUsersUnsuspendParameters = RequireAtLeastOne<
|
|
725
|
+
{
|
|
726
|
+
/**
|
|
727
|
+
* ID of the access system of the user that you want to unsuspend. You can only provide acs_system_id with user_identity_id.
|
|
728
|
+
*/
|
|
729
|
+
acs_system_id?: string | undefined
|
|
730
|
+
/**
|
|
731
|
+
* ID of the access system user that you want to unsuspend. You can only provide acs_user_id or the combination of acs_system_id and user_identity_id.
|
|
732
|
+
*/
|
|
733
|
+
acs_user_id?: string | undefined
|
|
734
|
+
/**
|
|
735
|
+
* ID of the user identity that you want to unsuspend. You can only provide acs_user_id or the combination of acs_system_id and user_identity_id.
|
|
736
|
+
*/
|
|
737
|
+
user_identity_id?: string | undefined
|
|
738
|
+
},
|
|
739
|
+
'acs_system_id' | 'acs_user_id' | 'user_identity_id'
|
|
740
|
+
>
|
|
675
741
|
|
|
676
742
|
/**
|
|
677
743
|
* @deprecated Use AcsUsersUnsuspendRequest instead.
|
|
@@ -682,56 +748,67 @@ export type AcsUsersUnsuspendRequest = SeamHttpRequest<void, undefined>
|
|
|
682
748
|
|
|
683
749
|
export interface AcsUsersUnsuspendOptions {}
|
|
684
750
|
|
|
685
|
-
export type AcsUsersUpdateParameters = RequireAtLeastOne<
|
|
686
|
-
|
|
687
|
-
|
|
688
|
-
|
|
689
|
-
|
|
690
|
-
|
|
691
|
-
|
|
692
|
-
|
|
693
|
-
|
|
694
|
-
|
|
695
|
-
|
|
696
|
-
|
|
697
|
-
|
|
698
|
-
|
|
699
|
-
|
|
700
|
-
|
|
701
|
-
|
|
702
|
-
|
|
703
|
-
|
|
704
|
-
|
|
705
|
-
|
|
706
|
-
|
|
707
|
-
|
|
708
|
-
|
|
709
|
-
|
|
710
|
-
|
|
711
|
-
|
|
712
|
-
|
|
713
|
-
|
|
714
|
-
|
|
715
|
-
|
|
716
|
-
|
|
717
|
-
|
|
718
|
-
|
|
719
|
-
|
|
720
|
-
|
|
721
|
-
|
|
722
|
-
|
|
723
|
-
|
|
724
|
-
|
|
725
|
-
|
|
726
|
-
|
|
727
|
-
|
|
728
|
-
|
|
729
|
-
|
|
730
|
-
|
|
731
|
-
|
|
732
|
-
|
|
733
|
-
|
|
734
|
-
|
|
751
|
+
export type AcsUsersUpdateParameters = RequireAtLeastOne<
|
|
752
|
+
{
|
|
753
|
+
/**
|
|
754
|
+
* `starts_at` and `ends_at` timestamps for the access system user's access. If you specify an `access_schedule`, you may include both `starts_at` and `ends_at`. If you omit `starts_at`, it defaults to the current time. `ends_at` is optional and must be a time in the future and after `starts_at`.
|
|
755
|
+
*/
|
|
756
|
+
access_schedule?:
|
|
757
|
+
| {
|
|
758
|
+
/**
|
|
759
|
+
* Ending timestamp for the access system user's access.
|
|
760
|
+
*/
|
|
761
|
+
ends_at?: string | Date | Temporal.Instant | undefined
|
|
762
|
+
/**
|
|
763
|
+
* Starting timestamp for the access system user's access.
|
|
764
|
+
*/
|
|
765
|
+
starts_at?: string | Date | Temporal.Instant | undefined
|
|
766
|
+
}
|
|
767
|
+
| null
|
|
768
|
+
| undefined
|
|
769
|
+
/**
|
|
770
|
+
* ID of the access system that you want to update. You can only provide acs_system_id with user_identity_id.
|
|
771
|
+
*/
|
|
772
|
+
acs_system_id?: string | undefined
|
|
773
|
+
/**
|
|
774
|
+
* ID of the access system user that you want to update. You can only provide acs_user_id or user_identity_id.
|
|
775
|
+
*/
|
|
776
|
+
acs_user_id?: string | undefined
|
|
777
|
+
/**
|
|
778
|
+
* @deprecated use email_address.
|
|
779
|
+
*/
|
|
780
|
+
email?: string | undefined
|
|
781
|
+
/**
|
|
782
|
+
* Email address of the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management).
|
|
783
|
+
*/
|
|
784
|
+
email_address?: string | undefined
|
|
785
|
+
/**
|
|
786
|
+
* Full name of the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management).
|
|
787
|
+
*/
|
|
788
|
+
full_name?: string | undefined
|
|
789
|
+
/**
|
|
790
|
+
* ID of the HID access control system associated with the user.
|
|
791
|
+
*/
|
|
792
|
+
hid_acs_system_id?: string | undefined
|
|
793
|
+
/**
|
|
794
|
+
* Phone number of the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) in E.164 format (for example, `+15555550100`).
|
|
795
|
+
*/
|
|
796
|
+
phone_number?: string | undefined
|
|
797
|
+
/**
|
|
798
|
+
* ID of the user identity that you want to update. You can only provide acs_user_id or user_identity_id. If you provide user_identity_id, you must also provide acs_system_id.
|
|
799
|
+
*/
|
|
800
|
+
user_identity_id?: string | undefined
|
|
801
|
+
},
|
|
802
|
+
| 'access_schedule'
|
|
803
|
+
| 'acs_system_id'
|
|
804
|
+
| 'acs_user_id'
|
|
805
|
+
| 'email'
|
|
806
|
+
| 'email_address'
|
|
807
|
+
| 'full_name'
|
|
808
|
+
| 'hid_acs_system_id'
|
|
809
|
+
| 'phone_number'
|
|
810
|
+
| 'user_identity_id'
|
|
811
|
+
>
|
|
735
812
|
|
|
736
813
|
/**
|
|
737
814
|
* @deprecated Use AcsUsersUpdateRequest instead.
|
|
@@ -30,7 +30,10 @@ import {
|
|
|
30
30
|
} from 'lib/parse-options.js'
|
|
31
31
|
import type { ActionAttempt } from 'lib/resources/action-attempt.js'
|
|
32
32
|
import { SeamHttpClientSessions } from 'lib/routes/client-sessions/index.js'
|
|
33
|
-
import {
|
|
33
|
+
import {
|
|
34
|
+
SeamHttpRequest,
|
|
35
|
+
type SeamPaginatedRequest,
|
|
36
|
+
} from 'lib/seam-http-request.js'
|
|
34
37
|
import { SeamPaginator } from 'lib/seam-paginator.js'
|
|
35
38
|
|
|
36
39
|
export class SeamHttpActionAttempts {
|
|
@@ -134,7 +137,7 @@ export class SeamHttpActionAttempts {
|
|
|
134
137
|
}
|
|
135
138
|
|
|
136
139
|
createPaginator<const TResponse, const TResponseKey extends keyof TResponse>(
|
|
137
|
-
request:
|
|
140
|
+
request: SeamPaginatedRequest<TResponse, TResponseKey>,
|
|
138
141
|
): SeamPaginator<TResponse, TResponseKey> {
|
|
139
142
|
return new SeamPaginator<TResponse, TResponseKey>(this, request)
|
|
140
143
|
}
|
|
@@ -172,12 +175,14 @@ export class SeamHttpActionAttempts {
|
|
|
172
175
|
parameters,
|
|
173
176
|
hasRequiredParameters: true,
|
|
174
177
|
requiredParameterNames: ['action_attempt_id'],
|
|
178
|
+
atLeastOneParameterNames: [],
|
|
175
179
|
responseKey: 'action_attempt',
|
|
176
180
|
options,
|
|
177
|
-
actionAttempts:
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
+
actionAttempts: () =>
|
|
182
|
+
SeamHttpActionAttempts.fromClient(this.client, {
|
|
183
|
+
...this.defaults,
|
|
184
|
+
waitForActionAttempt: false,
|
|
185
|
+
}),
|
|
181
186
|
})
|
|
182
187
|
}
|
|
183
188
|
|
|
@@ -195,6 +200,7 @@ export class SeamHttpActionAttempts {
|
|
|
195
200
|
parameters,
|
|
196
201
|
hasRequiredParameters: false,
|
|
197
202
|
requiredParameterNames: [],
|
|
203
|
+
atLeastOneParameterNames: [],
|
|
198
204
|
responseKey: 'action_attempts',
|
|
199
205
|
hasPagination: true,
|
|
200
206
|
options,
|
|
@@ -250,7 +256,7 @@ export type ActionAttemptsListResponse = {
|
|
|
250
256
|
action_attempts: Array<ActionAttempt>
|
|
251
257
|
}
|
|
252
258
|
|
|
253
|
-
export type ActionAttemptsListRequest =
|
|
259
|
+
export type ActionAttemptsListRequest = SeamPaginatedRequest<
|
|
254
260
|
ActionAttemptsListResponse,
|
|
255
261
|
'action_attempts'
|
|
256
262
|
>
|