@seamapi/types 1.460.1 → 1.462.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.
@@ -25104,6 +25104,12 @@ export default {
25104
25104
  nullable: true,
25105
25105
  type: 'string',
25106
25106
  },
25107
+ user_identity_key: {
25108
+ description: 'Unique key for the user identity.',
25109
+ minLength: 1,
25110
+ nullable: true,
25111
+ type: 'string',
25112
+ },
25107
25113
  },
25108
25114
  type: 'object',
25109
25115
  },
@@ -25189,6 +25195,11 @@ export default {
25189
25195
  items: { format: 'uuid', type: 'string' },
25190
25196
  type: 'array',
25191
25197
  },
25198
+ space_keys: {
25199
+ description: 'Set of keys of existing spaces to which access is being granted.',
25200
+ items: { type: 'string' },
25201
+ type: 'array',
25202
+ },
25192
25203
  starts_at: {
25193
25204
  description: 'Date and time at which the validity of the new grant starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
25194
25205
  type: 'string',
@@ -26302,21 +26313,51 @@ export default {
26302
26313
  schema: {
26303
26314
  properties: {
26304
26315
  batch: {
26305
- description: 'Represents a resource batch.',
26316
+ description: 'A batch of workspace resources.',
26306
26317
  properties: {
26318
+ acs_access_groups: {
26319
+ items: {
26320
+ $ref: '#/components/schemas/acs_access_group',
26321
+ },
26322
+ type: 'array',
26323
+ },
26324
+ acs_encoders: {
26325
+ items: { $ref: '#/components/schemas/acs_encoder' },
26326
+ type: 'array',
26327
+ },
26307
26328
  acs_entrances: {
26308
26329
  items: { $ref: '#/components/schemas/acs_entrance' },
26309
26330
  type: 'array',
26310
26331
  },
26332
+ acs_systems: {
26333
+ items: { $ref: '#/components/schemas/acs_system' },
26334
+ type: 'array',
26335
+ },
26336
+ acs_users: {
26337
+ items: { $ref: '#/components/schemas/acs_user' },
26338
+ type: 'array',
26339
+ },
26340
+ action_attempts: {
26341
+ items: {
26342
+ $ref: '#/components/schemas/action_attempt',
26343
+ },
26344
+ type: 'array',
26345
+ },
26311
26346
  batch_type: {
26312
26347
  enum: [
26313
26348
  'workspaces',
26349
+ 'spaces',
26314
26350
  'access_grants',
26315
26351
  'access_methods',
26316
- 'spaces',
26317
26352
  ],
26318
26353
  type: 'string',
26319
26354
  },
26355
+ client_sessions: {
26356
+ items: {
26357
+ $ref: '#/components/schemas/client_session',
26358
+ },
26359
+ type: 'array',
26360
+ },
26320
26361
  devices: {
26321
26362
  items: { $ref: '#/components/schemas/device' },
26322
26363
  type: 'array',
@@ -26325,6 +26366,24 @@ export default {
26325
26366
  items: { $ref: '#/components/schemas/space' },
26326
26367
  type: 'array',
26327
26368
  },
26369
+ unmanaged_acs_access_groups: {
26370
+ items: {
26371
+ $ref: '#/components/schemas/unmanaged_acs_access_group',
26372
+ },
26373
+ type: 'array',
26374
+ },
26375
+ unmanaged_acs_users: {
26376
+ items: {
26377
+ $ref: '#/components/schemas/unmanaged_acs_user',
26378
+ },
26379
+ type: 'array',
26380
+ },
26381
+ unmanaged_devices: {
26382
+ items: {
26383
+ $ref: '#/components/schemas/unmanaged_device',
26384
+ },
26385
+ type: 'array',
26386
+ },
26328
26387
  user_identities: {
26329
26388
  items: { $ref: '#/components/schemas/user_identity' },
26330
26389
  type: 'array',
@@ -26336,7 +26395,6 @@ export default {
26336
26395
  },
26337
26396
  required: ['batch_type'],
26338
26397
  type: 'object',
26339
- 'x-route-path': '/',
26340
26398
  },
26341
26399
  ok: { type: 'boolean' },
26342
26400
  },
@@ -26406,21 +26464,51 @@ export default {
26406
26464
  schema: {
26407
26465
  properties: {
26408
26466
  batch: {
26409
- description: 'Represents a resource batch.',
26467
+ description: 'A batch of workspace resources.',
26410
26468
  properties: {
26469
+ acs_access_groups: {
26470
+ items: {
26471
+ $ref: '#/components/schemas/acs_access_group',
26472
+ },
26473
+ type: 'array',
26474
+ },
26475
+ acs_encoders: {
26476
+ items: { $ref: '#/components/schemas/acs_encoder' },
26477
+ type: 'array',
26478
+ },
26411
26479
  acs_entrances: {
26412
26480
  items: { $ref: '#/components/schemas/acs_entrance' },
26413
26481
  type: 'array',
26414
26482
  },
26483
+ acs_systems: {
26484
+ items: { $ref: '#/components/schemas/acs_system' },
26485
+ type: 'array',
26486
+ },
26487
+ acs_users: {
26488
+ items: { $ref: '#/components/schemas/acs_user' },
26489
+ type: 'array',
26490
+ },
26491
+ action_attempts: {
26492
+ items: {
26493
+ $ref: '#/components/schemas/action_attempt',
26494
+ },
26495
+ type: 'array',
26496
+ },
26415
26497
  batch_type: {
26416
26498
  enum: [
26417
26499
  'workspaces',
26500
+ 'spaces',
26418
26501
  'access_grants',
26419
26502
  'access_methods',
26420
- 'spaces',
26421
26503
  ],
26422
26504
  type: 'string',
26423
26505
  },
26506
+ client_sessions: {
26507
+ items: {
26508
+ $ref: '#/components/schemas/client_session',
26509
+ },
26510
+ type: 'array',
26511
+ },
26424
26512
  devices: {
26425
26513
  items: { $ref: '#/components/schemas/device' },
26426
26514
  type: 'array',
@@ -26429,6 +26517,24 @@ export default {
26429
26517
  items: { $ref: '#/components/schemas/space' },
26430
26518
  type: 'array',
26431
26519
  },
26520
+ unmanaged_acs_access_groups: {
26521
+ items: {
26522
+ $ref: '#/components/schemas/unmanaged_acs_access_group',
26523
+ },
26524
+ type: 'array',
26525
+ },
26526
+ unmanaged_acs_users: {
26527
+ items: {
26528
+ $ref: '#/components/schemas/unmanaged_acs_user',
26529
+ },
26530
+ type: 'array',
26531
+ },
26532
+ unmanaged_devices: {
26533
+ items: {
26534
+ $ref: '#/components/schemas/unmanaged_device',
26535
+ },
26536
+ type: 'array',
26537
+ },
26432
26538
  user_identities: {
26433
26539
  items: { $ref: '#/components/schemas/user_identity' },
26434
26540
  type: 'array',
@@ -26440,7 +26546,6 @@ export default {
26440
26546
  },
26441
26547
  required: ['batch_type'],
26442
26548
  type: 'object',
26443
- 'x-route-path': '/',
26444
26549
  },
26445
26550
  ok: { type: 'boolean' },
26446
26551
  },
@@ -39129,6 +39234,212 @@ export default {
39129
39234
  'x-title': 'List Events',
39130
39235
  },
39131
39236
  },
39237
+ '/instant_keys/get': {
39238
+ get: {
39239
+ description: 'Gets an [instant key](https://docs.seam.co/latest/capability-guides/mobile-access/instant-keys).',
39240
+ operationId: 'instantKeysGetGet',
39241
+ parameters: [
39242
+ {
39243
+ in: 'query',
39244
+ name: 'instant_key_id',
39245
+ required: true,
39246
+ schema: {
39247
+ description: 'ID of the instant key to get.',
39248
+ format: 'uuid',
39249
+ type: 'string',
39250
+ },
39251
+ },
39252
+ ],
39253
+ responses: {
39254
+ 200: {
39255
+ content: {
39256
+ 'application/json': {
39257
+ schema: {
39258
+ properties: {
39259
+ instant_key: { $ref: '#/components/schemas/instant_key' },
39260
+ ok: { type: 'boolean' },
39261
+ },
39262
+ required: ['instant_key', 'ok'],
39263
+ type: 'object',
39264
+ },
39265
+ },
39266
+ },
39267
+ description: 'OK',
39268
+ },
39269
+ 400: { description: 'Bad Request' },
39270
+ 401: { description: 'Unauthorized' },
39271
+ },
39272
+ security: [
39273
+ { api_key: [] },
39274
+ { pat_with_workspace: [] },
39275
+ { console_session_with_workspace: [] },
39276
+ ],
39277
+ summary: '/instant_keys/get',
39278
+ tags: [],
39279
+ 'x-fern-sdk-group-name': ['instant_keys'],
39280
+ 'x-fern-sdk-method-name': 'get',
39281
+ 'x-fern-sdk-return-value': 'instant_key',
39282
+ 'x-response-key': 'instant_key',
39283
+ 'x-title': 'Get an Instant Key',
39284
+ },
39285
+ post: {
39286
+ description: 'Gets an [instant key](https://docs.seam.co/latest/capability-guides/mobile-access/instant-keys).',
39287
+ operationId: 'instantKeysGetPost',
39288
+ requestBody: {
39289
+ content: {
39290
+ 'application/json': {
39291
+ schema: {
39292
+ properties: {
39293
+ instant_key_id: {
39294
+ description: 'ID of the instant key to get.',
39295
+ format: 'uuid',
39296
+ type: 'string',
39297
+ },
39298
+ },
39299
+ required: ['instant_key_id'],
39300
+ type: 'object',
39301
+ },
39302
+ },
39303
+ },
39304
+ },
39305
+ responses: {
39306
+ 200: {
39307
+ content: {
39308
+ 'application/json': {
39309
+ schema: {
39310
+ properties: {
39311
+ instant_key: { $ref: '#/components/schemas/instant_key' },
39312
+ ok: { type: 'boolean' },
39313
+ },
39314
+ required: ['instant_key', 'ok'],
39315
+ type: 'object',
39316
+ },
39317
+ },
39318
+ },
39319
+ description: 'OK',
39320
+ },
39321
+ 400: { description: 'Bad Request' },
39322
+ 401: { description: 'Unauthorized' },
39323
+ },
39324
+ security: [
39325
+ { api_key: [] },
39326
+ { pat_with_workspace: [] },
39327
+ { console_session_with_workspace: [] },
39328
+ ],
39329
+ summary: '/instant_keys/get',
39330
+ tags: [],
39331
+ 'x-fern-sdk-group-name': ['instant_keys'],
39332
+ 'x-fern-sdk-method-name': 'get',
39333
+ 'x-fern-sdk-return-value': 'instant_key',
39334
+ 'x-response-key': 'instant_key',
39335
+ 'x-title': 'Get an Instant Key',
39336
+ },
39337
+ },
39338
+ '/instant_keys/list': {
39339
+ get: {
39340
+ description: 'Returns a list of all [instant keys](https://docs.seam.co/latest/capability-guides/mobile-access/instant-keys).',
39341
+ operationId: 'instantKeysListGet',
39342
+ parameters: [
39343
+ {
39344
+ in: 'query',
39345
+ name: 'user_identity_id',
39346
+ schema: {
39347
+ description: 'ID of the user identity by which you want to filter the list of Instant Keys.',
39348
+ format: 'uuid',
39349
+ type: 'string',
39350
+ },
39351
+ },
39352
+ ],
39353
+ responses: {
39354
+ 200: {
39355
+ content: {
39356
+ 'application/json': {
39357
+ schema: {
39358
+ properties: {
39359
+ instant_keys: {
39360
+ items: { $ref: '#/components/schemas/instant_key' },
39361
+ type: 'array',
39362
+ },
39363
+ ok: { type: 'boolean' },
39364
+ },
39365
+ required: ['instant_keys', 'ok'],
39366
+ type: 'object',
39367
+ },
39368
+ },
39369
+ },
39370
+ description: 'OK',
39371
+ },
39372
+ 400: { description: 'Bad Request' },
39373
+ 401: { description: 'Unauthorized' },
39374
+ },
39375
+ security: [
39376
+ { api_key: [] },
39377
+ { pat_with_workspace: [] },
39378
+ { console_session_with_workspace: [] },
39379
+ ],
39380
+ summary: '/instant_keys/list',
39381
+ tags: [],
39382
+ 'x-fern-sdk-group-name': ['instant_keys'],
39383
+ 'x-fern-sdk-method-name': 'list',
39384
+ 'x-fern-sdk-return-value': 'instant_keys',
39385
+ 'x-response-key': 'instant_keys',
39386
+ 'x-title': 'List Instant Keys',
39387
+ },
39388
+ post: {
39389
+ description: 'Returns a list of all [instant keys](https://docs.seam.co/latest/capability-guides/mobile-access/instant-keys).',
39390
+ operationId: 'instantKeysListPost',
39391
+ requestBody: {
39392
+ content: {
39393
+ 'application/json': {
39394
+ schema: {
39395
+ properties: {
39396
+ user_identity_id: {
39397
+ description: 'ID of the user identity by which you want to filter the list of Instant Keys.',
39398
+ format: 'uuid',
39399
+ type: 'string',
39400
+ },
39401
+ },
39402
+ type: 'object',
39403
+ },
39404
+ },
39405
+ },
39406
+ },
39407
+ responses: {
39408
+ 200: {
39409
+ content: {
39410
+ 'application/json': {
39411
+ schema: {
39412
+ properties: {
39413
+ instant_keys: {
39414
+ items: { $ref: '#/components/schemas/instant_key' },
39415
+ type: 'array',
39416
+ },
39417
+ ok: { type: 'boolean' },
39418
+ },
39419
+ required: ['instant_keys', 'ok'],
39420
+ type: 'object',
39421
+ },
39422
+ },
39423
+ },
39424
+ description: 'OK',
39425
+ },
39426
+ 400: { description: 'Bad Request' },
39427
+ 401: { description: 'Unauthorized' },
39428
+ },
39429
+ security: [
39430
+ { api_key: [] },
39431
+ { pat_with_workspace: [] },
39432
+ { console_session_with_workspace: [] },
39433
+ ],
39434
+ summary: '/instant_keys/list',
39435
+ tags: [],
39436
+ 'x-fern-sdk-group-name': ['instant_keys'],
39437
+ 'x-fern-sdk-method-name': 'list',
39438
+ 'x-fern-sdk-return-value': 'instant_keys',
39439
+ 'x-response-key': 'instant_keys',
39440
+ 'x-title': 'List Instant Keys',
39441
+ },
39442
+ },
39132
39443
  '/locks/get': {
39133
39444
  get: {
39134
39445
  description: 'Returns a specified [lock](https://docs.seam.co/latest/capability-guides/smart-locks). **Use `/devices/get` instead.**',
@@ -52505,21 +52816,51 @@ export default {
52505
52816
  schema: {
52506
52817
  properties: {
52507
52818
  batch: {
52508
- description: 'Represents a resource batch.',
52819
+ description: 'A batch of workspace resources.',
52509
52820
  properties: {
52821
+ acs_access_groups: {
52822
+ items: {
52823
+ $ref: '#/components/schemas/acs_access_group',
52824
+ },
52825
+ type: 'array',
52826
+ },
52827
+ acs_encoders: {
52828
+ items: { $ref: '#/components/schemas/acs_encoder' },
52829
+ type: 'array',
52830
+ },
52510
52831
  acs_entrances: {
52511
52832
  items: { $ref: '#/components/schemas/acs_entrance' },
52512
52833
  type: 'array',
52513
52834
  },
52835
+ acs_systems: {
52836
+ items: { $ref: '#/components/schemas/acs_system' },
52837
+ type: 'array',
52838
+ },
52839
+ acs_users: {
52840
+ items: { $ref: '#/components/schemas/acs_user' },
52841
+ type: 'array',
52842
+ },
52843
+ action_attempts: {
52844
+ items: {
52845
+ $ref: '#/components/schemas/action_attempt',
52846
+ },
52847
+ type: 'array',
52848
+ },
52514
52849
  batch_type: {
52515
52850
  enum: [
52516
52851
  'workspaces',
52852
+ 'spaces',
52517
52853
  'access_grants',
52518
52854
  'access_methods',
52519
- 'spaces',
52520
52855
  ],
52521
52856
  type: 'string',
52522
52857
  },
52858
+ client_sessions: {
52859
+ items: {
52860
+ $ref: '#/components/schemas/client_session',
52861
+ },
52862
+ type: 'array',
52863
+ },
52523
52864
  devices: {
52524
52865
  items: { $ref: '#/components/schemas/device' },
52525
52866
  type: 'array',
@@ -52528,6 +52869,24 @@ export default {
52528
52869
  items: { $ref: '#/components/schemas/space' },
52529
52870
  type: 'array',
52530
52871
  },
52872
+ unmanaged_acs_access_groups: {
52873
+ items: {
52874
+ $ref: '#/components/schemas/unmanaged_acs_access_group',
52875
+ },
52876
+ type: 'array',
52877
+ },
52878
+ unmanaged_acs_users: {
52879
+ items: {
52880
+ $ref: '#/components/schemas/unmanaged_acs_user',
52881
+ },
52882
+ type: 'array',
52883
+ },
52884
+ unmanaged_devices: {
52885
+ items: {
52886
+ $ref: '#/components/schemas/unmanaged_device',
52887
+ },
52888
+ type: 'array',
52889
+ },
52531
52890
  user_identities: {
52532
52891
  items: { $ref: '#/components/schemas/user_identity' },
52533
52892
  type: 'array',
@@ -52539,7 +52898,6 @@ export default {
52539
52898
  },
52540
52899
  required: ['batch_type'],
52541
52900
  type: 'object',
52542
- 'x-route-path': '/',
52543
52901
  },
52544
52902
  ok: { type: 'boolean' },
52545
52903
  },
@@ -52586,21 +52944,51 @@ export default {
52586
52944
  schema: {
52587
52945
  properties: {
52588
52946
  batch: {
52589
- description: 'Represents a resource batch.',
52947
+ description: 'A batch of workspace resources.',
52590
52948
  properties: {
52949
+ acs_access_groups: {
52950
+ items: {
52951
+ $ref: '#/components/schemas/acs_access_group',
52952
+ },
52953
+ type: 'array',
52954
+ },
52955
+ acs_encoders: {
52956
+ items: { $ref: '#/components/schemas/acs_encoder' },
52957
+ type: 'array',
52958
+ },
52591
52959
  acs_entrances: {
52592
52960
  items: { $ref: '#/components/schemas/acs_entrance' },
52593
52961
  type: 'array',
52594
52962
  },
52963
+ acs_systems: {
52964
+ items: { $ref: '#/components/schemas/acs_system' },
52965
+ type: 'array',
52966
+ },
52967
+ acs_users: {
52968
+ items: { $ref: '#/components/schemas/acs_user' },
52969
+ type: 'array',
52970
+ },
52971
+ action_attempts: {
52972
+ items: {
52973
+ $ref: '#/components/schemas/action_attempt',
52974
+ },
52975
+ type: 'array',
52976
+ },
52595
52977
  batch_type: {
52596
52978
  enum: [
52597
52979
  'workspaces',
52980
+ 'spaces',
52598
52981
  'access_grants',
52599
52982
  'access_methods',
52600
- 'spaces',
52601
52983
  ],
52602
52984
  type: 'string',
52603
52985
  },
52986
+ client_sessions: {
52987
+ items: {
52988
+ $ref: '#/components/schemas/client_session',
52989
+ },
52990
+ type: 'array',
52991
+ },
52604
52992
  devices: {
52605
52993
  items: { $ref: '#/components/schemas/device' },
52606
52994
  type: 'array',
@@ -52609,6 +52997,24 @@ export default {
52609
52997
  items: { $ref: '#/components/schemas/space' },
52610
52998
  type: 'array',
52611
52999
  },
53000
+ unmanaged_acs_access_groups: {
53001
+ items: {
53002
+ $ref: '#/components/schemas/unmanaged_acs_access_group',
53003
+ },
53004
+ type: 'array',
53005
+ },
53006
+ unmanaged_acs_users: {
53007
+ items: {
53008
+ $ref: '#/components/schemas/unmanaged_acs_user',
53009
+ },
53010
+ type: 'array',
53011
+ },
53012
+ unmanaged_devices: {
53013
+ items: {
53014
+ $ref: '#/components/schemas/unmanaged_device',
53015
+ },
53016
+ type: 'array',
53017
+ },
52612
53018
  user_identities: {
52613
53019
  items: { $ref: '#/components/schemas/user_identity' },
52614
53020
  type: 'array',
@@ -52620,7 +53026,6 @@ export default {
52620
53026
  },
52621
53027
  required: ['batch_type'],
52622
53028
  type: 'object',
52623
- 'x-route-path': '/',
52624
53029
  },
52625
53030
  ok: { type: 'boolean' },
52626
53031
  },