@seamapi/types 1.410.2 → 1.411.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1369,6 +1369,149 @@ export default {
1369
1369
  type: 'object',
1370
1370
  'x-route-path': '/access_codes',
1371
1371
  },
1372
+ access_grant: {
1373
+ properties: {
1374
+ access_grant_id: {
1375
+ description: 'ID of the access grant.',
1376
+ format: 'uuid',
1377
+ type: 'string',
1378
+ },
1379
+ access_method_ids: {
1380
+ description: 'IDs of the access methods that were created for this access grant.',
1381
+ items: { format: 'uuid', type: 'string' },
1382
+ type: 'array',
1383
+ },
1384
+ created_at: {
1385
+ description: 'Date and time at which the access grant was created.',
1386
+ format: 'date-time',
1387
+ type: 'string',
1388
+ },
1389
+ display_name: {
1390
+ description: 'Display name of the access grant.',
1391
+ type: 'string',
1392
+ },
1393
+ location_ids: {
1394
+ deprecated: true,
1395
+ items: { format: 'uuid', type: 'string' },
1396
+ type: 'array',
1397
+ 'x-deprecated': 'Use `space_ids`.',
1398
+ },
1399
+ requested_access_methods: {
1400
+ description: 'Access methods that the user requested for this access grant.',
1401
+ items: {
1402
+ properties: {
1403
+ created_access_method_ids: {
1404
+ description: 'IDs of the access methods that were created for this requested access method.',
1405
+ items: { format: 'uuid', type: 'string' },
1406
+ type: 'array',
1407
+ },
1408
+ created_at: {
1409
+ description: 'Date and time at which the requested access method was added to this access grant.',
1410
+ format: 'date-time',
1411
+ type: 'string',
1412
+ },
1413
+ display_name: {
1414
+ description: 'Display name of the access method.',
1415
+ type: 'string',
1416
+ },
1417
+ mode: {
1418
+ description: 'Access method mode. Supported values: `code`, `card`, `mobile_key`.',
1419
+ enum: ['code', 'card', 'mobile_key'],
1420
+ type: 'string',
1421
+ },
1422
+ },
1423
+ required: [
1424
+ 'display_name',
1425
+ 'mode',
1426
+ 'created_at',
1427
+ 'created_access_method_ids',
1428
+ ],
1429
+ type: 'object',
1430
+ },
1431
+ type: 'array',
1432
+ },
1433
+ space_ids: {
1434
+ description: 'IDs of the spaces to which access is being given.',
1435
+ items: { format: 'uuid', type: 'string' },
1436
+ type: 'array',
1437
+ },
1438
+ user_identity_id: {
1439
+ description: 'ID of user identity to which access is being granted.',
1440
+ format: 'uuid',
1441
+ type: 'string',
1442
+ },
1443
+ workspace_id: {
1444
+ description: 'Unique identifier for the Seam workspace associated with the access grant.',
1445
+ format: 'uuid',
1446
+ type: 'string',
1447
+ },
1448
+ },
1449
+ required: [
1450
+ 'workspace_id',
1451
+ 'access_grant_id',
1452
+ 'user_identity_id',
1453
+ 'location_ids',
1454
+ 'space_ids',
1455
+ 'requested_access_methods',
1456
+ 'access_method_ids',
1457
+ 'display_name',
1458
+ 'created_at',
1459
+ ],
1460
+ type: 'object',
1461
+ 'x-draft': 'Early access.',
1462
+ 'x-route-path': '/access_grants',
1463
+ },
1464
+ access_method: {
1465
+ properties: {
1466
+ access_method_id: {
1467
+ description: 'ID of the access method.',
1468
+ format: 'uuid',
1469
+ type: 'string',
1470
+ },
1471
+ created_at: {
1472
+ description: 'Date and time at which the access method was created.',
1473
+ format: 'date-time',
1474
+ type: 'string',
1475
+ },
1476
+ display_name: {
1477
+ description: 'Display name of the access method.',
1478
+ type: 'string',
1479
+ },
1480
+ instant_key_url: {
1481
+ description: 'URL of instant key for mobile key access methods.',
1482
+ type: 'string',
1483
+ },
1484
+ is_card_encoding_required: {
1485
+ description: 'Whether card encoding is required for plastic card access methods.',
1486
+ type: 'boolean',
1487
+ },
1488
+ issued_at: {
1489
+ description: 'Date and time at which the access method was issued.',
1490
+ format: 'date-time',
1491
+ type: 'string',
1492
+ },
1493
+ mode: {
1494
+ description: 'Access method mode. Supported values: `code`, `card`, `mobile_key`.',
1495
+ enum: ['code', 'card', 'mobile_key'],
1496
+ type: 'string',
1497
+ },
1498
+ workspace_id: {
1499
+ description: 'Unique identifier for the Seam workspace associated with the access grant.',
1500
+ format: 'uuid',
1501
+ type: 'string',
1502
+ },
1503
+ },
1504
+ required: [
1505
+ 'workspace_id',
1506
+ 'access_method_id',
1507
+ 'display_name',
1508
+ 'mode',
1509
+ 'created_at',
1510
+ ],
1511
+ type: 'object',
1512
+ 'x-draft': 'Early access.',
1513
+ 'x-route-path': '/access_methods',
1514
+ },
1372
1515
  acs_access_group: {
1373
1516
  description: 'Group that defines the entrances to which a set of users has access and, in some cases, the access schedule for these entrances and users.\n\nSome access control systems use [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups), which are sets of users, combined with sets of permissions. These permissions include both the set of areas or assets that the users can access and the schedule during which the users can access these areas or assets. Instead of assigning access rights individually to each access control system user, which can be time-consuming and error-prone, administrators can assign users to an access group, thereby ensuring that the users inherit all the permissions associated with the access group. Using access groups streamlines the process of managing large numbers of access control system users, especially in bigger organizations or complexes.\n\nTo learn whether your access control system supports access groups, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides/overview#access-control-systems).',
1374
1517
  properties: {
@@ -14585,7 +14728,12 @@ export default {
14585
14728
  magic_link: {
14586
14729
  properties: {
14587
14730
  building_block_type: {
14588
- enum: ['connect_accounts', 'manage_devices', 'organize_spaces'],
14731
+ enum: [
14732
+ 'connect_accounts',
14733
+ 'manage_devices',
14734
+ 'organize_spaces',
14735
+ 'console',
14736
+ ],
14589
14737
  type: 'string',
14590
14738
  },
14591
14739
  created_at: { format: 'date-time', type: 'string' },
@@ -20818,98 +20966,7 @@ export default {
20818
20966
  'application/json': {
20819
20967
  schema: {
20820
20968
  properties: {
20821
- access_grant: {
20822
- properties: {
20823
- access_grant_id: {
20824
- description: 'ID of the access grant.',
20825
- format: 'uuid',
20826
- type: 'string',
20827
- },
20828
- access_method_ids: {
20829
- description: 'IDs of the access methods that were created for this access grant.',
20830
- items: { format: 'uuid', type: 'string' },
20831
- type: 'array',
20832
- },
20833
- created_at: {
20834
- description: 'Date and time at which the access grant was created.',
20835
- format: 'date-time',
20836
- type: 'string',
20837
- },
20838
- display_name: {
20839
- description: 'Display name of the access grant.',
20840
- type: 'string',
20841
- },
20842
- location_ids: {
20843
- deprecated: true,
20844
- items: { format: 'uuid', type: 'string' },
20845
- type: 'array',
20846
- 'x-deprecated': 'Use `space_ids`.',
20847
- },
20848
- requested_access_methods: {
20849
- description: 'Access methods that the user requested for this access grant.',
20850
- items: {
20851
- properties: {
20852
- created_access_method_ids: {
20853
- description: 'IDs of the access methods that were created for this requested access method.',
20854
- items: { format: 'uuid', type: 'string' },
20855
- type: 'array',
20856
- },
20857
- created_at: {
20858
- description: 'Date and time at which the requested access method was added to this access grant.',
20859
- format: 'date-time',
20860
- type: 'string',
20861
- },
20862
- display_name: {
20863
- description: 'Display name of the access method.',
20864
- type: 'string',
20865
- },
20866
- mode: {
20867
- description: 'Access method mode. Supported values: `code`, `card`, `mobile_key`.',
20868
- enum: ['code', 'card', 'mobile_key'],
20869
- type: 'string',
20870
- },
20871
- },
20872
- required: [
20873
- 'display_name',
20874
- 'mode',
20875
- 'created_at',
20876
- 'created_access_method_ids',
20877
- ],
20878
- type: 'object',
20879
- },
20880
- type: 'array',
20881
- },
20882
- space_ids: {
20883
- description: 'IDs of the spaces to which access is being given.',
20884
- items: { format: 'uuid', type: 'string' },
20885
- type: 'array',
20886
- },
20887
- user_identity_id: {
20888
- description: 'ID of user identity to which access is being granted.',
20889
- format: 'uuid',
20890
- type: 'string',
20891
- },
20892
- workspace_id: {
20893
- description: 'Unique identifier for the Seam workspace associated with the access grant.',
20894
- format: 'uuid',
20895
- type: 'string',
20896
- },
20897
- },
20898
- required: [
20899
- 'workspace_id',
20900
- 'access_grant_id',
20901
- 'user_identity_id',
20902
- 'location_ids',
20903
- 'space_ids',
20904
- 'requested_access_methods',
20905
- 'access_method_ids',
20906
- 'display_name',
20907
- 'created_at',
20908
- ],
20909
- type: 'object',
20910
- 'x-draft': 'Early access.',
20911
- 'x-route-path': '/access_grants',
20912
- },
20969
+ access_grant: { $ref: '#/components/schemas/access_grant' },
20913
20970
  ok: { type: 'boolean' },
20914
20971
  },
20915
20972
  required: ['access_grant', 'ok'],
@@ -21017,98 +21074,7 @@ export default {
21017
21074
  'application/json': {
21018
21075
  schema: {
21019
21076
  properties: {
21020
- access_grant: {
21021
- properties: {
21022
- access_grant_id: {
21023
- description: 'ID of the access grant.',
21024
- format: 'uuid',
21025
- type: 'string',
21026
- },
21027
- access_method_ids: {
21028
- description: 'IDs of the access methods that were created for this access grant.',
21029
- items: { format: 'uuid', type: 'string' },
21030
- type: 'array',
21031
- },
21032
- created_at: {
21033
- description: 'Date and time at which the access grant was created.',
21034
- format: 'date-time',
21035
- type: 'string',
21036
- },
21037
- display_name: {
21038
- description: 'Display name of the access grant.',
21039
- type: 'string',
21040
- },
21041
- location_ids: {
21042
- deprecated: true,
21043
- items: { format: 'uuid', type: 'string' },
21044
- type: 'array',
21045
- 'x-deprecated': 'Use `space_ids`.',
21046
- },
21047
- requested_access_methods: {
21048
- description: 'Access methods that the user requested for this access grant.',
21049
- items: {
21050
- properties: {
21051
- created_access_method_ids: {
21052
- description: 'IDs of the access methods that were created for this requested access method.',
21053
- items: { format: 'uuid', type: 'string' },
21054
- type: 'array',
21055
- },
21056
- created_at: {
21057
- description: 'Date and time at which the requested access method was added to this access grant.',
21058
- format: 'date-time',
21059
- type: 'string',
21060
- },
21061
- display_name: {
21062
- description: 'Display name of the access method.',
21063
- type: 'string',
21064
- },
21065
- mode: {
21066
- description: 'Access method mode. Supported values: `code`, `card`, `mobile_key`.',
21067
- enum: ['code', 'card', 'mobile_key'],
21068
- type: 'string',
21069
- },
21070
- },
21071
- required: [
21072
- 'display_name',
21073
- 'mode',
21074
- 'created_at',
21075
- 'created_access_method_ids',
21076
- ],
21077
- type: 'object',
21078
- },
21079
- type: 'array',
21080
- },
21081
- space_ids: {
21082
- description: 'IDs of the spaces to which access is being given.',
21083
- items: { format: 'uuid', type: 'string' },
21084
- type: 'array',
21085
- },
21086
- user_identity_id: {
21087
- description: 'ID of user identity to which access is being granted.',
21088
- format: 'uuid',
21089
- type: 'string',
21090
- },
21091
- workspace_id: {
21092
- description: 'Unique identifier for the Seam workspace associated with the access grant.',
21093
- format: 'uuid',
21094
- type: 'string',
21095
- },
21096
- },
21097
- required: [
21098
- 'workspace_id',
21099
- 'access_grant_id',
21100
- 'user_identity_id',
21101
- 'location_ids',
21102
- 'space_ids',
21103
- 'requested_access_methods',
21104
- 'access_method_ids',
21105
- 'display_name',
21106
- 'created_at',
21107
- ],
21108
- type: 'object',
21109
- 'x-draft': 'Early access.',
21110
- 'x-route-path': '/access_grants',
21111
- },
21077
+ access_grant: { $ref: '#/components/schemas/access_grant' },
21112
21078
  ok: { type: 'boolean' },
21113
21079
  },
21114
21080
  required: ['access_grant', 'ok'],
@@ -21185,98 +21151,7 @@ export default {
21185
21151
  schema: {
21186
21152
  properties: {
21187
21153
  access_grants: {
21188
- items: {
21189
- properties: {
21190
- access_grant_id: {
21191
- description: 'ID of the access grant.',
21192
- format: 'uuid',
21193
- type: 'string',
21194
- },
21195
- access_method_ids: {
21196
- description: 'IDs of the access methods that were created for this access grant.',
21197
- items: { format: 'uuid', type: 'string' },
21198
- type: 'array',
21199
- },
21200
- created_at: {
21201
- description: 'Date and time at which the access grant was created.',
21202
- format: 'date-time',
21203
- type: 'string',
21204
- },
21205
- display_name: {
21206
- description: 'Display name of the access grant.',
21207
- type: 'string',
21208
- },
21209
- location_ids: {
21210
- deprecated: true,
21211
- items: { format: 'uuid', type: 'string' },
21212
- type: 'array',
21213
- 'x-deprecated': 'Use `space_ids`.',
21214
- },
21215
- requested_access_methods: {
21216
- description: 'Access methods that the user requested for this access grant.',
21217
- items: {
21218
- properties: {
21219
- created_access_method_ids: {
21220
- description: 'IDs of the access methods that were created for this requested access method.',
21221
- items: { format: 'uuid', type: 'string' },
21222
- type: 'array',
21223
- },
21224
- created_at: {
21225
- description: 'Date and time at which the requested access method was added to this access grant.',
21226
- format: 'date-time',
21227
- type: 'string',
21228
- },
21229
- display_name: {
21230
- description: 'Display name of the access method.',
21231
- type: 'string',
21232
- },
21233
- mode: {
21234
- description: 'Access method mode. Supported values: `code`, `card`, `mobile_key`.',
21235
- enum: ['code', 'card', 'mobile_key'],
21236
- type: 'string',
21237
- },
21238
- },
21239
- required: [
21240
- 'display_name',
21241
- 'mode',
21242
- 'created_at',
21243
- 'created_access_method_ids',
21244
- ],
21245
- type: 'object',
21246
- },
21247
- type: 'array',
21248
- },
21249
- space_ids: {
21250
- description: 'IDs of the spaces to which access is being given.',
21251
- items: { format: 'uuid', type: 'string' },
21252
- type: 'array',
21253
- },
21254
- user_identity_id: {
21255
- description: 'ID of user identity to which access is being granted.',
21256
- format: 'uuid',
21257
- type: 'string',
21258
- },
21259
- workspace_id: {
21260
- description: 'Unique identifier for the Seam workspace associated with the access grant.',
21261
- format: 'uuid',
21262
- type: 'string',
21263
- },
21264
- },
21265
- required: [
21266
- 'workspace_id',
21267
- 'access_grant_id',
21268
- 'user_identity_id',
21269
- 'location_ids',
21270
- 'space_ids',
21271
- 'requested_access_methods',
21272
- 'access_method_ids',
21273
- 'display_name',
21274
- 'created_at',
21275
- ],
21276
- type: 'object',
21277
- 'x-draft': 'Early access.',
21278
- 'x-route-path': '/access_grants',
21279
- },
21154
+ items: { $ref: '#/components/schemas/access_grant' },
21280
21155
  type: 'array',
21281
21156
  },
21282
21157
  ok: { type: 'boolean' },
@@ -21386,55 +21261,7 @@ export default {
21386
21261
  schema: {
21387
21262
  properties: {
21388
21263
  access_method: {
21389
- properties: {
21390
- access_method_id: {
21391
- description: 'ID of the access method.',
21392
- format: 'uuid',
21393
- type: 'string',
21394
- },
21395
- created_at: {
21396
- description: 'Date and time at which the access method was created.',
21397
- format: 'date-time',
21398
- type: 'string',
21399
- },
21400
- display_name: {
21401
- description: 'Display name of the access method.',
21402
- type: 'string',
21403
- },
21404
- instant_key_url: {
21405
- description: 'URL of instant key for mobile key access methods.',
21406
- type: 'string',
21407
- },
21408
- is_card_encoding_required: {
21409
- description: 'Whether card encoding is required for plastic card access methods.',
21410
- type: 'boolean',
21411
- },
21412
- issued_at: {
21413
- description: 'Date and time at which the access method was issued.',
21414
- format: 'date-time',
21415
- type: 'string',
21416
- },
21417
- mode: {
21418
- description: 'Access method mode. Supported values: `code`, `card`, `mobile_key`.',
21419
- enum: ['code', 'card', 'mobile_key'],
21420
- type: 'string',
21421
- },
21422
- workspace_id: {
21423
- description: 'Unique identifier for the Seam workspace associated with the access grant.',
21424
- format: 'uuid',
21425
- type: 'string',
21426
- },
21427
- },
21428
- required: [
21429
- 'workspace_id',
21430
- 'access_method_id',
21431
- 'display_name',
21432
- 'mode',
21433
- 'created_at',
21434
- ],
21435
- type: 'object',
21436
- 'x-draft': 'Early access.',
21437
- 'x-route-path': '/access_methods',
21264
+ $ref: '#/components/schemas/access_method',
21438
21265
  },
21439
21266
  ok: { type: 'boolean' },
21440
21267
  },
@@ -21491,57 +21318,7 @@ export default {
21491
21318
  schema: {
21492
21319
  properties: {
21493
21320
  access_methods: {
21494
- items: {
21495
- properties: {
21496
- access_method_id: {
21497
- description: 'ID of the access method.',
21498
- format: 'uuid',
21499
- type: 'string',
21500
- },
21501
- created_at: {
21502
- description: 'Date and time at which the access method was created.',
21503
- format: 'date-time',
21504
- type: 'string',
21505
- },
21506
- display_name: {
21507
- description: 'Display name of the access method.',
21508
- type: 'string',
21509
- },
21510
- instant_key_url: {
21511
- description: 'URL of instant key for mobile key access methods.',
21512
- type: 'string',
21513
- },
21514
- is_card_encoding_required: {
21515
- description: 'Whether card encoding is required for plastic card access methods.',
21516
- type: 'boolean',
21517
- },
21518
- issued_at: {
21519
- description: 'Date and time at which the access method was issued.',
21520
- format: 'date-time',
21521
- type: 'string',
21522
- },
21523
- mode: {
21524
- description: 'Access method mode. Supported values: `code`, `card`, `mobile_key`.',
21525
- enum: ['code', 'card', 'mobile_key'],
21526
- type: 'string',
21527
- },
21528
- workspace_id: {
21529
- description: 'Unique identifier for the Seam workspace associated with the access grant.',
21530
- format: 'uuid',
21531
- type: 'string',
21532
- },
21533
- },
21534
- required: [
21535
- 'workspace_id',
21536
- 'access_method_id',
21537
- 'display_name',
21538
- 'mode',
21539
- 'created_at',
21540
- ],
21541
- type: 'object',
21542
- 'x-draft': 'Early access.',
21543
- 'x-route-path': '/access_methods',
21544
- },
21321
+ items: { $ref: '#/components/schemas/access_method' },
21545
21322
  type: 'array',
21546
21323
  },
21547
21324
  ok: { type: 'boolean' },
@@ -35099,98 +34876,7 @@ export default {
35099
34876
  'application/json': {
35100
34877
  schema: {
35101
34878
  properties: {
35102
- access_grant: {
35103
- properties: {
35104
- access_grant_id: {
35105
- description: 'ID of the access grant.',
35106
- format: 'uuid',
35107
- type: 'string',
35108
- },
35109
- access_method_ids: {
35110
- description: 'IDs of the access methods that were created for this access grant.',
35111
- items: { format: 'uuid', type: 'string' },
35112
- type: 'array',
35113
- },
35114
- created_at: {
35115
- description: 'Date and time at which the access grant was created.',
35116
- format: 'date-time',
35117
- type: 'string',
35118
- },
35119
- display_name: {
35120
- description: 'Display name of the access grant.',
35121
- type: 'string',
35122
- },
35123
- location_ids: {
35124
- deprecated: true,
35125
- items: { format: 'uuid', type: 'string' },
35126
- type: 'array',
35127
- 'x-deprecated': 'Use `space_ids`.',
35128
- },
35129
- requested_access_methods: {
35130
- description: 'Access methods that the user requested for this access grant.',
35131
- items: {
35132
- properties: {
35133
- created_access_method_ids: {
35134
- description: 'IDs of the access methods that were created for this requested access method.',
35135
- items: { format: 'uuid', type: 'string' },
35136
- type: 'array',
35137
- },
35138
- created_at: {
35139
- description: 'Date and time at which the requested access method was added to this access grant.',
35140
- format: 'date-time',
35141
- type: 'string',
35142
- },
35143
- display_name: {
35144
- description: 'Display name of the access method.',
35145
- type: 'string',
35146
- },
35147
- mode: {
35148
- description: 'Access method mode. Supported values: `code`, `card`, `mobile_key`.',
35149
- enum: ['code', 'card', 'mobile_key'],
35150
- type: 'string',
35151
- },
35152
- },
35153
- required: [
35154
- 'display_name',
35155
- 'mode',
35156
- 'created_at',
35157
- 'created_access_method_ids',
35158
- ],
35159
- type: 'object',
35160
- },
35161
- type: 'array',
35162
- },
35163
- space_ids: {
35164
- description: 'IDs of the spaces to which access is being given.',
35165
- items: { format: 'uuid', type: 'string' },
35166
- type: 'array',
35167
- },
35168
- user_identity_id: {
35169
- description: 'ID of user identity to which access is being granted.',
35170
- format: 'uuid',
35171
- type: 'string',
35172
- },
35173
- workspace_id: {
35174
- description: 'Unique identifier for the Seam workspace associated with the access grant.',
35175
- format: 'uuid',
35176
- type: 'string',
35177
- },
35178
- },
35179
- required: [
35180
- 'workspace_id',
35181
- 'access_grant_id',
35182
- 'user_identity_id',
35183
- 'location_ids',
35184
- 'space_ids',
35185
- 'requested_access_methods',
35186
- 'access_method_ids',
35187
- 'display_name',
35188
- 'created_at',
35189
- ],
35190
- type: 'object',
35191
- 'x-draft': 'Early access.',
35192
- 'x-route-path': '/access_grants',
35193
- },
34879
+ access_grant: { $ref: '#/components/schemas/access_grant' },
35194
34880
  ok: { type: 'boolean' },
35195
34881
  },
35196
34882
  required: ['access_grant', 'ok'],
@@ -35298,98 +34984,7 @@ export default {
35298
34984
  'application/json': {
35299
34985
  schema: {
35300
34986
  properties: {
35301
- access_grant: {
35302
- properties: {
35303
- access_grant_id: {
35304
- description: 'ID of the access grant.',
35305
- format: 'uuid',
35306
- type: 'string',
35307
- },
35308
- access_method_ids: {
35309
- description: 'IDs of the access methods that were created for this access grant.',
35310
- items: { format: 'uuid', type: 'string' },
35311
- type: 'array',
35312
- },
35313
- created_at: {
35314
- description: 'Date and time at which the access grant was created.',
35315
- format: 'date-time',
35316
- type: 'string',
35317
- },
35318
- display_name: {
35319
- description: 'Display name of the access grant.',
35320
- type: 'string',
35321
- },
35322
- location_ids: {
35323
- deprecated: true,
35324
- items: { format: 'uuid', type: 'string' },
35325
- type: 'array',
35326
- 'x-deprecated': 'Use `space_ids`.',
35327
- },
35328
- requested_access_methods: {
35329
- description: 'Access methods that the user requested for this access grant.',
35330
- items: {
35331
- properties: {
35332
- created_access_method_ids: {
35333
- description: 'IDs of the access methods that were created for this requested access method.',
35334
- items: { format: 'uuid', type: 'string' },
35335
- type: 'array',
35336
- },
35337
- created_at: {
35338
- description: 'Date and time at which the requested access method was added to this access grant.',
35339
- format: 'date-time',
35340
- type: 'string',
35341
- },
35342
- display_name: {
35343
- description: 'Display name of the access method.',
35344
- type: 'string',
35345
- },
35346
- mode: {
35347
- description: 'Access method mode. Supported values: `code`, `card`, `mobile_key`.',
35348
- enum: ['code', 'card', 'mobile_key'],
35349
- type: 'string',
35350
- },
35351
- },
35352
- required: [
35353
- 'display_name',
35354
- 'mode',
35355
- 'created_at',
35356
- 'created_access_method_ids',
35357
- ],
35358
- type: 'object',
35359
- },
35360
- type: 'array',
35361
- },
35362
- space_ids: {
35363
- description: 'IDs of the spaces to which access is being given.',
35364
- items: { format: 'uuid', type: 'string' },
35365
- type: 'array',
35366
- },
35367
- user_identity_id: {
35368
- description: 'ID of user identity to which access is being granted.',
35369
- format: 'uuid',
35370
- type: 'string',
35371
- },
35372
- workspace_id: {
35373
- description: 'Unique identifier for the Seam workspace associated with the access grant.',
35374
- format: 'uuid',
35375
- type: 'string',
35376
- },
35377
- },
35378
- required: [
35379
- 'workspace_id',
35380
- 'access_grant_id',
35381
- 'user_identity_id',
35382
- 'location_ids',
35383
- 'space_ids',
35384
- 'requested_access_methods',
35385
- 'access_method_ids',
35386
- 'display_name',
35387
- 'created_at',
35388
- ],
35389
- type: 'object',
35390
- 'x-draft': 'Early access.',
35391
- 'x-route-path': '/access_grants',
35392
- },
34987
+ access_grant: { $ref: '#/components/schemas/access_grant' },
35393
34988
  ok: { type: 'boolean' },
35394
34989
  },
35395
34990
  required: ['access_grant', 'ok'],
@@ -35466,98 +35061,7 @@ export default {
35466
35061
  schema: {
35467
35062
  properties: {
35468
35063
  access_grants: {
35469
- items: {
35470
- properties: {
35471
- access_grant_id: {
35472
- description: 'ID of the access grant.',
35473
- format: 'uuid',
35474
- type: 'string',
35475
- },
35476
- access_method_ids: {
35477
- description: 'IDs of the access methods that were created for this access grant.',
35478
- items: { format: 'uuid', type: 'string' },
35479
- type: 'array',
35480
- },
35481
- created_at: {
35482
- description: 'Date and time at which the access grant was created.',
35483
- format: 'date-time',
35484
- type: 'string',
35485
- },
35486
- display_name: {
35487
- description: 'Display name of the access grant.',
35488
- type: 'string',
35489
- },
35490
- location_ids: {
35491
- deprecated: true,
35492
- items: { format: 'uuid', type: 'string' },
35493
- type: 'array',
35494
- 'x-deprecated': 'Use `space_ids`.',
35495
- },
35496
- requested_access_methods: {
35497
- description: 'Access methods that the user requested for this access grant.',
35498
- items: {
35499
- properties: {
35500
- created_access_method_ids: {
35501
- description: 'IDs of the access methods that were created for this requested access method.',
35502
- items: { format: 'uuid', type: 'string' },
35503
- type: 'array',
35504
- },
35505
- created_at: {
35506
- description: 'Date and time at which the requested access method was added to this access grant.',
35507
- format: 'date-time',
35508
- type: 'string',
35509
- },
35510
- display_name: {
35511
- description: 'Display name of the access method.',
35512
- type: 'string',
35513
- },
35514
- mode: {
35515
- description: 'Access method mode. Supported values: `code`, `card`, `mobile_key`.',
35516
- enum: ['code', 'card', 'mobile_key'],
35517
- type: 'string',
35518
- },
35519
- },
35520
- required: [
35521
- 'display_name',
35522
- 'mode',
35523
- 'created_at',
35524
- 'created_access_method_ids',
35525
- ],
35526
- type: 'object',
35527
- },
35528
- type: 'array',
35529
- },
35530
- space_ids: {
35531
- description: 'IDs of the spaces to which access is being given.',
35532
- items: { format: 'uuid', type: 'string' },
35533
- type: 'array',
35534
- },
35535
- user_identity_id: {
35536
- description: 'ID of user identity to which access is being granted.',
35537
- format: 'uuid',
35538
- type: 'string',
35539
- },
35540
- workspace_id: {
35541
- description: 'Unique identifier for the Seam workspace associated with the access grant.',
35542
- format: 'uuid',
35543
- type: 'string',
35544
- },
35545
- },
35546
- required: [
35547
- 'workspace_id',
35548
- 'access_grant_id',
35549
- 'user_identity_id',
35550
- 'location_ids',
35551
- 'space_ids',
35552
- 'requested_access_methods',
35553
- 'access_method_ids',
35554
- 'display_name',
35555
- 'created_at',
35556
- ],
35557
- type: 'object',
35558
- 'x-draft': 'Early access.',
35559
- 'x-route-path': '/access_grants',
35560
- },
35064
+ items: { $ref: '#/components/schemas/access_grant' },
35561
35065
  type: 'array',
35562
35066
  },
35563
35067
  ok: { type: 'boolean' },
@@ -35667,55 +35171,7 @@ export default {
35667
35171
  schema: {
35668
35172
  properties: {
35669
35173
  access_method: {
35670
- properties: {
35671
- access_method_id: {
35672
- description: 'ID of the access method.',
35673
- format: 'uuid',
35674
- type: 'string',
35675
- },
35676
- created_at: {
35677
- description: 'Date and time at which the access method was created.',
35678
- format: 'date-time',
35679
- type: 'string',
35680
- },
35681
- display_name: {
35682
- description: 'Display name of the access method.',
35683
- type: 'string',
35684
- },
35685
- instant_key_url: {
35686
- description: 'URL of instant key for mobile key access methods.',
35687
- type: 'string',
35688
- },
35689
- is_card_encoding_required: {
35690
- description: 'Whether card encoding is required for plastic card access methods.',
35691
- type: 'boolean',
35692
- },
35693
- issued_at: {
35694
- description: 'Date and time at which the access method was issued.',
35695
- format: 'date-time',
35696
- type: 'string',
35697
- },
35698
- mode: {
35699
- description: 'Access method mode. Supported values: `code`, `card`, `mobile_key`.',
35700
- enum: ['code', 'card', 'mobile_key'],
35701
- type: 'string',
35702
- },
35703
- workspace_id: {
35704
- description: 'Unique identifier for the Seam workspace associated with the access grant.',
35705
- format: 'uuid',
35706
- type: 'string',
35707
- },
35708
- },
35709
- required: [
35710
- 'workspace_id',
35711
- 'access_method_id',
35712
- 'display_name',
35713
- 'mode',
35714
- 'created_at',
35715
- ],
35716
- type: 'object',
35717
- 'x-draft': 'Early access.',
35718
- 'x-route-path': '/access_methods',
35174
+ $ref: '#/components/schemas/access_method',
35719
35175
  },
35720
35176
  ok: { type: 'boolean' },
35721
35177
  },
@@ -35772,57 +35228,7 @@ export default {
35772
35228
  schema: {
35773
35229
  properties: {
35774
35230
  access_methods: {
35775
- items: {
35776
- properties: {
35777
- access_method_id: {
35778
- description: 'ID of the access method.',
35779
- format: 'uuid',
35780
- type: 'string',
35781
- },
35782
- created_at: {
35783
- description: 'Date and time at which the access method was created.',
35784
- format: 'date-time',
35785
- type: 'string',
35786
- },
35787
- display_name: {
35788
- description: 'Display name of the access method.',
35789
- type: 'string',
35790
- },
35791
- instant_key_url: {
35792
- description: 'URL of instant key for mobile key access methods.',
35793
- type: 'string',
35794
- },
35795
- is_card_encoding_required: {
35796
- description: 'Whether card encoding is required for plastic card access methods.',
35797
- type: 'boolean',
35798
- },
35799
- issued_at: {
35800
- description: 'Date and time at which the access method was issued.',
35801
- format: 'date-time',
35802
- type: 'string',
35803
- },
35804
- mode: {
35805
- description: 'Access method mode. Supported values: `code`, `card`, `mobile_key`.',
35806
- enum: ['code', 'card', 'mobile_key'],
35807
- type: 'string',
35808
- },
35809
- workspace_id: {
35810
- description: 'Unique identifier for the Seam workspace associated with the access grant.',
35811
- format: 'uuid',
35812
- type: 'string',
35813
- },
35814
- },
35815
- required: [
35816
- 'workspace_id',
35817
- 'access_method_id',
35818
- 'display_name',
35819
- 'mode',
35820
- 'created_at',
35821
- ],
35822
- type: 'object',
35823
- 'x-draft': 'Early access.',
35824
- 'x-route-path': '/access_methods',
35825
- },
35231
+ items: { $ref: '#/components/schemas/access_method' },
35826
35232
  type: 'array',
35827
35233
  },
35828
35234
  ok: { type: 'boolean' },
@@ -36931,72 +36337,43 @@ export default {
36931
36337
  content: {
36932
36338
  'application/json': {
36933
36339
  schema: {
36934
- oneOf: [
36935
- {
36936
- properties: {
36937
- building_block_type: {
36938
- description: '`connect_accounts` building block type.',
36939
- enum: ['connect_accounts'],
36940
- type: 'string',
36941
- },
36942
- customer_key: {
36943
- description: 'Customer key for which you want to create a new building block magic link.',
36944
- type: 'string',
36945
- },
36946
- },
36947
- required: ['building_block_type', 'customer_key'],
36948
- type: 'object',
36340
+ properties: {
36341
+ building_block_type: {
36342
+ description: 'Type of building block to create a magic link for.',
36343
+ enum: [
36344
+ 'connect_accounts',
36345
+ 'organize_spaces',
36346
+ 'console',
36347
+ 'manage_devices',
36348
+ ],
36349
+ type: 'string',
36949
36350
  },
36950
- {
36951
- properties: {
36952
- building_block_type: {
36953
- description: '`manage_devices` building block type.',
36954
- enum: ['manage_devices'],
36955
- type: 'string',
36956
- },
36957
- customer_key: {
36958
- description: 'Customer key for which you want to create a new building block magic link.',
36959
- type: 'string',
36960
- },
36961
- },
36962
- required: ['building_block_type', 'customer_key'],
36963
- type: 'object',
36351
+ customer_key: {
36352
+ description: 'Customer key for which you want to create a new building block magic link.',
36353
+ type: 'string',
36964
36354
  },
36965
- {
36966
- properties: {
36967
- building_block_type: {
36968
- description: '`organize_spaces` building block type.',
36969
- enum: ['organize_spaces'],
36970
- type: 'string',
36971
- },
36972
- customer_key: {
36973
- description: 'Customer key for which you want to create a new building block magic link.',
36974
- type: 'string',
36975
- },
36976
- partner_resources: {
36977
- description: 'Optional list of partner resources that you want to include in the new building block magic link.',
36978
- items: {
36979
- properties: {
36980
- custom_metadata: {
36981
- additionalProperties: { type: 'string' },
36982
- type: 'object',
36983
- },
36984
- description: { type: 'string' },
36985
- name: { type: 'string' },
36986
- partner_resource_key: { type: 'string' },
36987
- },
36988
- required: ['partner_resource_key', 'name'],
36355
+ spaces: {
36356
+ description: 'Optional list of spaces that you want to include in the new building block magic link.',
36357
+ items: {
36358
+ properties: {
36359
+ custom_metadata: {
36360
+ additionalProperties: { type: 'string' },
36989
36361
  type: 'object',
36990
- 'x-route-path': '/unstable_partner/resources',
36991
- 'x-undocumented': 'Unreleased.',
36992
36362
  },
36993
- type: 'array',
36363
+ description: { type: 'string' },
36364
+ name: { type: 'string' },
36365
+ space_key: { type: 'string' },
36994
36366
  },
36367
+ required: ['space_key', 'name'],
36368
+ type: 'object',
36369
+ 'x-route-path': '/unstable_partner/resources',
36370
+ 'x-undocumented': 'Unreleased.',
36995
36371
  },
36996
- required: ['building_block_type', 'customer_key'],
36997
- type: 'object',
36372
+ type: 'array',
36998
36373
  },
36999
- ],
36374
+ },
36375
+ required: ['building_block_type', 'customer_key'],
36376
+ type: 'object',
37000
36377
  },
37001
36378
  },
37002
36379
  },
@@ -37102,8 +36479,8 @@ export default {
37102
36479
  description: 'Customer key for which you want to organize spaces.',
37103
36480
  type: 'string',
37104
36481
  },
37105
- partner_resources: {
37106
- description: 'Optional list of partner resources that you want to include in the new building block magic link.',
36482
+ spaces: {
36483
+ description: 'Optional list of spaces that you want to include in the new building block magic link.',
37107
36484
  items: {
37108
36485
  properties: {
37109
36486
  custom_metadata: {
@@ -37112,9 +36489,9 @@ export default {
37112
36489
  },
37113
36490
  description: { type: 'string' },
37114
36491
  name: { type: 'string' },
37115
- partner_resource_key: { type: 'string' },
36492
+ space_key: { type: 'string' },
37116
36493
  },
37117
- required: ['partner_resource_key', 'name'],
36494
+ required: ['space_key', 'name'],
37118
36495
  type: 'object',
37119
36496
  'x-route-path': '/unstable_partner/resources',
37120
36497
  'x-undocumented': 'Unreleased.',