@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.
@@ -1561,6 +1561,160 @@ export default {
1561
1561
  type: 'object',
1562
1562
  'x-route-path': '/access_codes',
1563
1563
  },
1564
+ access_grant: {
1565
+ properties: {
1566
+ access_grant_id: {
1567
+ description: 'ID of the access grant.',
1568
+ format: 'uuid',
1569
+ type: 'string',
1570
+ },
1571
+ access_method_ids: {
1572
+ description:
1573
+ 'IDs of the access methods that were created for this access grant.',
1574
+ items: { format: 'uuid', type: 'string' },
1575
+ type: 'array',
1576
+ },
1577
+ created_at: {
1578
+ description: 'Date and time at which the access grant was created.',
1579
+ format: 'date-time',
1580
+ type: 'string',
1581
+ },
1582
+ display_name: {
1583
+ description: 'Display name of the access grant.',
1584
+ type: 'string',
1585
+ },
1586
+ location_ids: {
1587
+ deprecated: true,
1588
+ items: { format: 'uuid', type: 'string' },
1589
+ type: 'array',
1590
+ 'x-deprecated': 'Use `space_ids`.',
1591
+ },
1592
+ requested_access_methods: {
1593
+ description:
1594
+ 'Access methods that the user requested for this access grant.',
1595
+ items: {
1596
+ properties: {
1597
+ created_access_method_ids: {
1598
+ description:
1599
+ 'IDs of the access methods that were created for this requested access method.',
1600
+ items: { format: 'uuid', type: 'string' },
1601
+ type: 'array',
1602
+ },
1603
+ created_at: {
1604
+ description:
1605
+ 'Date and time at which the requested access method was added to this access grant.',
1606
+ format: 'date-time',
1607
+ type: 'string',
1608
+ },
1609
+ display_name: {
1610
+ description: 'Display name of the access method.',
1611
+ type: 'string',
1612
+ },
1613
+ mode: {
1614
+ description:
1615
+ 'Access method mode. Supported values: `code`, `card`, `mobile_key`.',
1616
+ enum: ['code', 'card', 'mobile_key'],
1617
+ type: 'string',
1618
+ },
1619
+ },
1620
+ required: [
1621
+ 'display_name',
1622
+ 'mode',
1623
+ 'created_at',
1624
+ 'created_access_method_ids',
1625
+ ],
1626
+ type: 'object',
1627
+ },
1628
+ type: 'array',
1629
+ },
1630
+ space_ids: {
1631
+ description: 'IDs of the spaces to which access is being given.',
1632
+ items: { format: 'uuid', type: 'string' },
1633
+ type: 'array',
1634
+ },
1635
+ user_identity_id: {
1636
+ description:
1637
+ 'ID of user identity to which access is being granted.',
1638
+ format: 'uuid',
1639
+ type: 'string',
1640
+ },
1641
+ workspace_id: {
1642
+ description:
1643
+ 'Unique identifier for the Seam workspace associated with the access grant.',
1644
+ format: 'uuid',
1645
+ type: 'string',
1646
+ },
1647
+ },
1648
+ required: [
1649
+ 'workspace_id',
1650
+ 'access_grant_id',
1651
+ 'user_identity_id',
1652
+ 'location_ids',
1653
+ 'space_ids',
1654
+ 'requested_access_methods',
1655
+ 'access_method_ids',
1656
+ 'display_name',
1657
+ 'created_at',
1658
+ ],
1659
+ type: 'object',
1660
+ 'x-draft': 'Early access.',
1661
+ 'x-route-path': '/access_grants',
1662
+ },
1663
+ access_method: {
1664
+ properties: {
1665
+ access_method_id: {
1666
+ description: 'ID of the access method.',
1667
+ format: 'uuid',
1668
+ type: 'string',
1669
+ },
1670
+ created_at: {
1671
+ description:
1672
+ 'Date and time at which the access method was created.',
1673
+ format: 'date-time',
1674
+ type: 'string',
1675
+ },
1676
+ display_name: {
1677
+ description: 'Display name of the access method.',
1678
+ type: 'string',
1679
+ },
1680
+ instant_key_url: {
1681
+ description: 'URL of instant key for mobile key access methods.',
1682
+ type: 'string',
1683
+ },
1684
+ is_card_encoding_required: {
1685
+ description:
1686
+ 'Whether card encoding is required for plastic card access methods.',
1687
+ type: 'boolean',
1688
+ },
1689
+ issued_at: {
1690
+ description: 'Date and time at which the access method was issued.',
1691
+ format: 'date-time',
1692
+ type: 'string',
1693
+ },
1694
+ mode: {
1695
+ description:
1696
+ 'Access method mode. Supported values: `code`, `card`, `mobile_key`.',
1697
+ enum: ['code', 'card', 'mobile_key'],
1698
+ type: 'string',
1699
+ },
1700
+ workspace_id: {
1701
+ description:
1702
+ 'Unique identifier for the Seam workspace associated with the access grant.',
1703
+ format: 'uuid',
1704
+ type: 'string',
1705
+ },
1706
+ },
1707
+ required: [
1708
+ 'workspace_id',
1709
+ 'access_method_id',
1710
+ 'display_name',
1711
+ 'mode',
1712
+ 'created_at',
1713
+ ],
1714
+ type: 'object',
1715
+ 'x-draft': 'Early access.',
1716
+ 'x-route-path': '/access_methods',
1717
+ },
1564
1718
  acs_access_group: {
1565
1719
  description:
1566
1720
  '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).',
@@ -15970,7 +16124,12 @@ export default {
15970
16124
  magic_link: {
15971
16125
  properties: {
15972
16126
  building_block_type: {
15973
- enum: ['connect_accounts', 'manage_devices', 'organize_spaces'],
16127
+ enum: [
16128
+ 'connect_accounts',
16129
+ 'manage_devices',
16130
+ 'organize_spaces',
16131
+ 'console',
16132
+ ],
15974
16133
  type: 'string',
15975
16134
  },
15976
16135
  created_at: { format: 'date-time', type: 'string' },
@@ -22849,108 +23008,7 @@ export default {
22849
23008
  'application/json': {
22850
23009
  schema: {
22851
23010
  properties: {
22852
- access_grant: {
22853
- properties: {
22854
- access_grant_id: {
22855
- description: 'ID of the access grant.',
22856
- format: 'uuid',
22857
- type: 'string',
22858
- },
22859
- access_method_ids: {
22860
- description:
22861
- 'IDs of the access methods that were created for this access grant.',
22862
- items: { format: 'uuid', type: 'string' },
22863
- type: 'array',
22864
- },
22865
- created_at: {
22866
- description:
22867
- 'Date and time at which the access grant was created.',
22868
- format: 'date-time',
22869
- type: 'string',
22870
- },
22871
- display_name: {
22872
- description: 'Display name of the access grant.',
22873
- type: 'string',
22874
- },
22875
- location_ids: {
22876
- deprecated: true,
22877
- items: { format: 'uuid', type: 'string' },
22878
- type: 'array',
22879
- 'x-deprecated': 'Use `space_ids`.',
22880
- },
22881
- requested_access_methods: {
22882
- description:
22883
- 'Access methods that the user requested for this access grant.',
22884
- items: {
22885
- properties: {
22886
- created_access_method_ids: {
22887
- description:
22888
- 'IDs of the access methods that were created for this requested access method.',
22889
- items: { format: 'uuid', type: 'string' },
22890
- type: 'array',
22891
- },
22892
- created_at: {
22893
- description:
22894
- 'Date and time at which the requested access method was added to this access grant.',
22895
- format: 'date-time',
22896
- type: 'string',
22897
- },
22898
- display_name: {
22899
- description:
22900
- 'Display name of the access method.',
22901
- type: 'string',
22902
- },
22903
- mode: {
22904
- description:
22905
- 'Access method mode. Supported values: `code`, `card`, `mobile_key`.',
22906
- enum: ['code', 'card', 'mobile_key'],
22907
- type: 'string',
22908
- },
22909
- },
22910
- required: [
22911
- 'display_name',
22912
- 'mode',
22913
- 'created_at',
22914
- 'created_access_method_ids',
22915
- ],
22916
- type: 'object',
22917
- },
22918
- type: 'array',
22919
- },
22920
- space_ids: {
22921
- description:
22922
- 'IDs of the spaces to which access is being given.',
22923
- items: { format: 'uuid', type: 'string' },
22924
- type: 'array',
22925
- },
22926
- user_identity_id: {
22927
- description:
22928
- 'ID of user identity to which access is being granted.',
22929
- format: 'uuid',
22930
- type: 'string',
22931
- },
22932
- workspace_id: {
22933
- description:
22934
- 'Unique identifier for the Seam workspace associated with the access grant.',
22935
- format: 'uuid',
22936
- type: 'string',
22937
- },
22938
- },
22939
- required: [
22940
- 'workspace_id',
22941
- 'access_grant_id',
22942
- 'user_identity_id',
22943
- 'location_ids',
22944
- 'space_ids',
22945
- 'requested_access_methods',
22946
- 'access_method_ids',
22947
- 'display_name',
22948
- 'created_at',
22949
- ],
22950
- type: 'object',
22951
- 'x-draft': 'Early access.',
22952
- 'x-route-path': '/access_grants',
22953
- },
23011
+ access_grant: { $ref: '#/components/schemas/access_grant' },
22954
23012
  ok: { type: 'boolean' },
22955
23013
  },
22956
23014
  required: ['access_grant', 'ok'],
@@ -23058,108 +23116,7 @@ export default {
23058
23116
  'application/json': {
23059
23117
  schema: {
23060
23118
  properties: {
23061
- access_grant: {
23062
- properties: {
23063
- access_grant_id: {
23064
- description: 'ID of the access grant.',
23065
- format: 'uuid',
23066
- type: 'string',
23067
- },
23068
- access_method_ids: {
23069
- description:
23070
- 'IDs of the access methods that were created for this access grant.',
23071
- items: { format: 'uuid', type: 'string' },
23072
- type: 'array',
23073
- },
23074
- created_at: {
23075
- description:
23076
- 'Date and time at which the access grant was created.',
23077
- format: 'date-time',
23078
- type: 'string',
23079
- },
23080
- display_name: {
23081
- description: 'Display name of the access grant.',
23082
- type: 'string',
23083
- },
23084
- location_ids: {
23085
- deprecated: true,
23086
- items: { format: 'uuid', type: 'string' },
23087
- type: 'array',
23088
- 'x-deprecated': 'Use `space_ids`.',
23089
- },
23090
- requested_access_methods: {
23091
- description:
23092
- 'Access methods that the user requested for this access grant.',
23093
- items: {
23094
- properties: {
23095
- created_access_method_ids: {
23096
- description:
23097
- 'IDs of the access methods that were created for this requested access method.',
23098
- items: { format: 'uuid', type: 'string' },
23099
- type: 'array',
23100
- },
23101
- created_at: {
23102
- description:
23103
- 'Date and time at which the requested access method was added to this access grant.',
23104
- format: 'date-time',
23105
- type: 'string',
23106
- },
23107
- display_name: {
23108
- description:
23109
- 'Display name of the access method.',
23110
- type: 'string',
23111
- },
23112
- mode: {
23113
- description:
23114
- 'Access method mode. Supported values: `code`, `card`, `mobile_key`.',
23115
- enum: ['code', 'card', 'mobile_key'],
23116
- type: 'string',
23117
- },
23118
- },
23119
- required: [
23120
- 'display_name',
23121
- 'mode',
23122
- 'created_at',
23123
- 'created_access_method_ids',
23124
- ],
23125
- type: 'object',
23126
- },
23127
- type: 'array',
23128
- },
23129
- space_ids: {
23130
- description:
23131
- 'IDs of the spaces to which access is being given.',
23132
- items: { format: 'uuid', type: 'string' },
23133
- type: 'array',
23134
- },
23135
- user_identity_id: {
23136
- description:
23137
- 'ID of user identity to which access is being granted.',
23138
- format: 'uuid',
23139
- type: 'string',
23140
- },
23141
- workspace_id: {
23142
- description:
23143
- 'Unique identifier for the Seam workspace associated with the access grant.',
23144
- format: 'uuid',
23145
- type: 'string',
23146
- },
23147
- },
23148
- required: [
23149
- 'workspace_id',
23150
- 'access_grant_id',
23151
- 'user_identity_id',
23152
- 'location_ids',
23153
- 'space_ids',
23154
- 'requested_access_methods',
23155
- 'access_method_ids',
23156
- 'display_name',
23157
- 'created_at',
23158
- ],
23159
- type: 'object',
23160
- 'x-draft': 'Early access.',
23161
- 'x-route-path': '/access_grants',
23162
- },
23119
+ access_grant: { $ref: '#/components/schemas/access_grant' },
23163
23120
  ok: { type: 'boolean' },
23164
23121
  },
23165
23122
  required: ['access_grant', 'ok'],
@@ -23240,108 +23197,7 @@ export default {
23240
23197
  schema: {
23241
23198
  properties: {
23242
23199
  access_grants: {
23243
- items: {
23244
- properties: {
23245
- access_grant_id: {
23246
- description: 'ID of the access grant.',
23247
- format: 'uuid',
23248
- type: 'string',
23249
- },
23250
- access_method_ids: {
23251
- description:
23252
- 'IDs of the access methods that were created for this access grant.',
23253
- items: { format: 'uuid', type: 'string' },
23254
- type: 'array',
23255
- },
23256
- created_at: {
23257
- description:
23258
- 'Date and time at which the access grant was created.',
23259
- format: 'date-time',
23260
- type: 'string',
23261
- },
23262
- display_name: {
23263
- description: 'Display name of the access grant.',
23264
- type: 'string',
23265
- },
23266
- location_ids: {
23267
- deprecated: true,
23268
- items: { format: 'uuid', type: 'string' },
23269
- type: 'array',
23270
- 'x-deprecated': 'Use `space_ids`.',
23271
- },
23272
- requested_access_methods: {
23273
- description:
23274
- 'Access methods that the user requested for this access grant.',
23275
- items: {
23276
- properties: {
23277
- created_access_method_ids: {
23278
- description:
23279
- 'IDs of the access methods that were created for this requested access method.',
23280
- items: { format: 'uuid', type: 'string' },
23281
- type: 'array',
23282
- },
23283
- created_at: {
23284
- description:
23285
- 'Date and time at which the requested access method was added to this access grant.',
23286
- format: 'date-time',
23287
- type: 'string',
23288
- },
23289
- display_name: {
23290
- description:
23291
- 'Display name of the access method.',
23292
- type: 'string',
23293
- },
23294
- mode: {
23295
- description:
23296
- 'Access method mode. Supported values: `code`, `card`, `mobile_key`.',
23297
- enum: ['code', 'card', 'mobile_key'],
23298
- type: 'string',
23299
- },
23300
- },
23301
- required: [
23302
- 'display_name',
23303
- 'mode',
23304
- 'created_at',
23305
- 'created_access_method_ids',
23306
- ],
23307
- type: 'object',
23308
- },
23309
- type: 'array',
23310
- },
23311
- space_ids: {
23312
- description:
23313
- 'IDs of the spaces to which access is being given.',
23314
- items: { format: 'uuid', type: 'string' },
23315
- type: 'array',
23316
- },
23317
- user_identity_id: {
23318
- description:
23319
- 'ID of user identity to which access is being granted.',
23320
- format: 'uuid',
23321
- type: 'string',
23322
- },
23323
- workspace_id: {
23324
- description:
23325
- 'Unique identifier for the Seam workspace associated with the access grant.',
23326
- format: 'uuid',
23327
- type: 'string',
23328
- },
23329
- },
23330
- required: [
23331
- 'workspace_id',
23332
- 'access_grant_id',
23333
- 'user_identity_id',
23334
- 'location_ids',
23335
- 'space_ids',
23336
- 'requested_access_methods',
23337
- 'access_method_ids',
23338
- 'display_name',
23339
- 'created_at',
23340
- ],
23341
- type: 'object',
23342
- 'x-draft': 'Early access.',
23343
- 'x-route-path': '/access_grants',
23344
- },
23200
+ items: { $ref: '#/components/schemas/access_grant' },
23345
23201
  type: 'array',
23346
23202
  },
23347
23203
  ok: { type: 'boolean' },
@@ -23451,61 +23307,7 @@ export default {
23451
23307
  schema: {
23452
23308
  properties: {
23453
23309
  access_method: {
23454
- properties: {
23455
- access_method_id: {
23456
- description: 'ID of the access method.',
23457
- format: 'uuid',
23458
- type: 'string',
23459
- },
23460
- created_at: {
23461
- description:
23462
- 'Date and time at which the access method was created.',
23463
- format: 'date-time',
23464
- type: 'string',
23465
- },
23466
- display_name: {
23467
- description: 'Display name of the access method.',
23468
- type: 'string',
23469
- },
23470
- instant_key_url: {
23471
- description:
23472
- 'URL of instant key for mobile key access methods.',
23473
- type: 'string',
23474
- },
23475
- is_card_encoding_required: {
23476
- description:
23477
- 'Whether card encoding is required for plastic card access methods.',
23478
- type: 'boolean',
23479
- },
23480
- issued_at: {
23481
- description:
23482
- 'Date and time at which the access method was issued.',
23483
- format: 'date-time',
23484
- type: 'string',
23485
- },
23486
- mode: {
23487
- description:
23488
- 'Access method mode. Supported values: `code`, `card`, `mobile_key`.',
23489
- enum: ['code', 'card', 'mobile_key'],
23490
- type: 'string',
23491
- },
23492
- workspace_id: {
23493
- description:
23494
- 'Unique identifier for the Seam workspace associated with the access grant.',
23495
- format: 'uuid',
23496
- type: 'string',
23497
- },
23498
- },
23499
- required: [
23500
- 'workspace_id',
23501
- 'access_method_id',
23502
- 'display_name',
23503
- 'mode',
23504
- 'created_at',
23505
- ],
23506
- type: 'object',
23507
- 'x-draft': 'Early access.',
23508
- 'x-route-path': '/access_methods',
23310
+ $ref: '#/components/schemas/access_method',
23509
23311
  },
23510
23312
  ok: { type: 'boolean' },
23511
23313
  },
@@ -23564,63 +23366,7 @@ export default {
23564
23366
  schema: {
23565
23367
  properties: {
23566
23368
  access_methods: {
23567
- items: {
23568
- properties: {
23569
- access_method_id: {
23570
- description: 'ID of the access method.',
23571
- format: 'uuid',
23572
- type: 'string',
23573
- },
23574
- created_at: {
23575
- description:
23576
- 'Date and time at which the access method was created.',
23577
- format: 'date-time',
23578
- type: 'string',
23579
- },
23580
- display_name: {
23581
- description: 'Display name of the access method.',
23582
- type: 'string',
23583
- },
23584
- instant_key_url: {
23585
- description:
23586
- 'URL of instant key for mobile key access methods.',
23587
- type: 'string',
23588
- },
23589
- is_card_encoding_required: {
23590
- description:
23591
- 'Whether card encoding is required for plastic card access methods.',
23592
- type: 'boolean',
23593
- },
23594
- issued_at: {
23595
- description:
23596
- 'Date and time at which the access method was issued.',
23597
- format: 'date-time',
23598
- type: 'string',
23599
- },
23600
- mode: {
23601
- description:
23602
- 'Access method mode. Supported values: `code`, `card`, `mobile_key`.',
23603
- enum: ['code', 'card', 'mobile_key'],
23604
- type: 'string',
23605
- },
23606
- workspace_id: {
23607
- description:
23608
- 'Unique identifier for the Seam workspace associated with the access grant.',
23609
- format: 'uuid',
23610
- type: 'string',
23611
- },
23612
- },
23613
- required: [
23614
- 'workspace_id',
23615
- 'access_method_id',
23616
- 'display_name',
23617
- 'mode',
23618
- 'created_at',
23619
- ],
23620
- type: 'object',
23621
- 'x-draft': 'Early access.',
23622
- 'x-route-path': '/access_methods',
23623
- },
23369
+ items: { $ref: '#/components/schemas/access_method' },
23624
23370
  type: 'array',
23625
23371
  },
23626
23372
  ok: { type: 'boolean' },
@@ -37967,108 +37713,7 @@ export default {
37967
37713
  'application/json': {
37968
37714
  schema: {
37969
37715
  properties: {
37970
- access_grant: {
37971
- properties: {
37972
- access_grant_id: {
37973
- description: 'ID of the access grant.',
37974
- format: 'uuid',
37975
- type: 'string',
37976
- },
37977
- access_method_ids: {
37978
- description:
37979
- 'IDs of the access methods that were created for this access grant.',
37980
- items: { format: 'uuid', type: 'string' },
37981
- type: 'array',
37982
- },
37983
- created_at: {
37984
- description:
37985
- 'Date and time at which the access grant was created.',
37986
- format: 'date-time',
37987
- type: 'string',
37988
- },
37989
- display_name: {
37990
- description: 'Display name of the access grant.',
37991
- type: 'string',
37992
- },
37993
- location_ids: {
37994
- deprecated: true,
37995
- items: { format: 'uuid', type: 'string' },
37996
- type: 'array',
37997
- 'x-deprecated': 'Use `space_ids`.',
37998
- },
37999
- requested_access_methods: {
38000
- description:
38001
- 'Access methods that the user requested for this access grant.',
38002
- items: {
38003
- properties: {
38004
- created_access_method_ids: {
38005
- description:
38006
- 'IDs of the access methods that were created for this requested access method.',
38007
- items: { format: 'uuid', type: 'string' },
38008
- type: 'array',
38009
- },
38010
- created_at: {
38011
- description:
38012
- 'Date and time at which the requested access method was added to this access grant.',
38013
- format: 'date-time',
38014
- type: 'string',
38015
- },
38016
- display_name: {
38017
- description:
38018
- 'Display name of the access method.',
38019
- type: 'string',
38020
- },
38021
- mode: {
38022
- description:
38023
- 'Access method mode. Supported values: `code`, `card`, `mobile_key`.',
38024
- enum: ['code', 'card', 'mobile_key'],
38025
- type: 'string',
38026
- },
38027
- },
38028
- required: [
38029
- 'display_name',
38030
- 'mode',
38031
- 'created_at',
38032
- 'created_access_method_ids',
38033
- ],
38034
- type: 'object',
38035
- },
38036
- type: 'array',
38037
- },
38038
- space_ids: {
38039
- description:
38040
- 'IDs of the spaces to which access is being given.',
38041
- items: { format: 'uuid', type: 'string' },
38042
- type: 'array',
38043
- },
38044
- user_identity_id: {
38045
- description:
38046
- 'ID of user identity to which access is being granted.',
38047
- format: 'uuid',
38048
- type: 'string',
38049
- },
38050
- workspace_id: {
38051
- description:
38052
- 'Unique identifier for the Seam workspace associated with the access grant.',
38053
- format: 'uuid',
38054
- type: 'string',
38055
- },
38056
- },
38057
- required: [
38058
- 'workspace_id',
38059
- 'access_grant_id',
38060
- 'user_identity_id',
38061
- 'location_ids',
38062
- 'space_ids',
38063
- 'requested_access_methods',
38064
- 'access_method_ids',
38065
- 'display_name',
38066
- 'created_at',
38067
- ],
38068
- type: 'object',
38069
- 'x-draft': 'Early access.',
38070
- 'x-route-path': '/access_grants',
38071
- },
37716
+ access_grant: { $ref: '#/components/schemas/access_grant' },
38072
37717
  ok: { type: 'boolean' },
38073
37718
  },
38074
37719
  required: ['access_grant', 'ok'],
@@ -38176,108 +37821,7 @@ export default {
38176
37821
  'application/json': {
38177
37822
  schema: {
38178
37823
  properties: {
38179
- access_grant: {
38180
- properties: {
38181
- access_grant_id: {
38182
- description: 'ID of the access grant.',
38183
- format: 'uuid',
38184
- type: 'string',
38185
- },
38186
- access_method_ids: {
38187
- description:
38188
- 'IDs of the access methods that were created for this access grant.',
38189
- items: { format: 'uuid', type: 'string' },
38190
- type: 'array',
38191
- },
38192
- created_at: {
38193
- description:
38194
- 'Date and time at which the access grant was created.',
38195
- format: 'date-time',
38196
- type: 'string',
38197
- },
38198
- display_name: {
38199
- description: 'Display name of the access grant.',
38200
- type: 'string',
38201
- },
38202
- location_ids: {
38203
- deprecated: true,
38204
- items: { format: 'uuid', type: 'string' },
38205
- type: 'array',
38206
- 'x-deprecated': 'Use `space_ids`.',
38207
- },
38208
- requested_access_methods: {
38209
- description:
38210
- 'Access methods that the user requested for this access grant.',
38211
- items: {
38212
- properties: {
38213
- created_access_method_ids: {
38214
- description:
38215
- 'IDs of the access methods that were created for this requested access method.',
38216
- items: { format: 'uuid', type: 'string' },
38217
- type: 'array',
38218
- },
38219
- created_at: {
38220
- description:
38221
- 'Date and time at which the requested access method was added to this access grant.',
38222
- format: 'date-time',
38223
- type: 'string',
38224
- },
38225
- display_name: {
38226
- description:
38227
- 'Display name of the access method.',
38228
- type: 'string',
38229
- },
38230
- mode: {
38231
- description:
38232
- 'Access method mode. Supported values: `code`, `card`, `mobile_key`.',
38233
- enum: ['code', 'card', 'mobile_key'],
38234
- type: 'string',
38235
- },
38236
- },
38237
- required: [
38238
- 'display_name',
38239
- 'mode',
38240
- 'created_at',
38241
- 'created_access_method_ids',
38242
- ],
38243
- type: 'object',
38244
- },
38245
- type: 'array',
38246
- },
38247
- space_ids: {
38248
- description:
38249
- 'IDs of the spaces to which access is being given.',
38250
- items: { format: 'uuid', type: 'string' },
38251
- type: 'array',
38252
- },
38253
- user_identity_id: {
38254
- description:
38255
- 'ID of user identity to which access is being granted.',
38256
- format: 'uuid',
38257
- type: 'string',
38258
- },
38259
- workspace_id: {
38260
- description:
38261
- 'Unique identifier for the Seam workspace associated with the access grant.',
38262
- format: 'uuid',
38263
- type: 'string',
38264
- },
38265
- },
38266
- required: [
38267
- 'workspace_id',
38268
- 'access_grant_id',
38269
- 'user_identity_id',
38270
- 'location_ids',
38271
- 'space_ids',
38272
- 'requested_access_methods',
38273
- 'access_method_ids',
38274
- 'display_name',
38275
- 'created_at',
38276
- ],
38277
- type: 'object',
38278
- 'x-draft': 'Early access.',
38279
- 'x-route-path': '/access_grants',
38280
- },
37824
+ access_grant: { $ref: '#/components/schemas/access_grant' },
38281
37825
  ok: { type: 'boolean' },
38282
37826
  },
38283
37827
  required: ['access_grant', 'ok'],
@@ -38358,108 +37902,7 @@ export default {
38358
37902
  schema: {
38359
37903
  properties: {
38360
37904
  access_grants: {
38361
- items: {
38362
- properties: {
38363
- access_grant_id: {
38364
- description: 'ID of the access grant.',
38365
- format: 'uuid',
38366
- type: 'string',
38367
- },
38368
- access_method_ids: {
38369
- description:
38370
- 'IDs of the access methods that were created for this access grant.',
38371
- items: { format: 'uuid', type: 'string' },
38372
- type: 'array',
38373
- },
38374
- created_at: {
38375
- description:
38376
- 'Date and time at which the access grant was created.',
38377
- format: 'date-time',
38378
- type: 'string',
38379
- },
38380
- display_name: {
38381
- description: 'Display name of the access grant.',
38382
- type: 'string',
38383
- },
38384
- location_ids: {
38385
- deprecated: true,
38386
- items: { format: 'uuid', type: 'string' },
38387
- type: 'array',
38388
- 'x-deprecated': 'Use `space_ids`.',
38389
- },
38390
- requested_access_methods: {
38391
- description:
38392
- 'Access methods that the user requested for this access grant.',
38393
- items: {
38394
- properties: {
38395
- created_access_method_ids: {
38396
- description:
38397
- 'IDs of the access methods that were created for this requested access method.',
38398
- items: { format: 'uuid', type: 'string' },
38399
- type: 'array',
38400
- },
38401
- created_at: {
38402
- description:
38403
- 'Date and time at which the requested access method was added to this access grant.',
38404
- format: 'date-time',
38405
- type: 'string',
38406
- },
38407
- display_name: {
38408
- description:
38409
- 'Display name of the access method.',
38410
- type: 'string',
38411
- },
38412
- mode: {
38413
- description:
38414
- 'Access method mode. Supported values: `code`, `card`, `mobile_key`.',
38415
- enum: ['code', 'card', 'mobile_key'],
38416
- type: 'string',
38417
- },
38418
- },
38419
- required: [
38420
- 'display_name',
38421
- 'mode',
38422
- 'created_at',
38423
- 'created_access_method_ids',
38424
- ],
38425
- type: 'object',
38426
- },
38427
- type: 'array',
38428
- },
38429
- space_ids: {
38430
- description:
38431
- 'IDs of the spaces to which access is being given.',
38432
- items: { format: 'uuid', type: 'string' },
38433
- type: 'array',
38434
- },
38435
- user_identity_id: {
38436
- description:
38437
- 'ID of user identity to which access is being granted.',
38438
- format: 'uuid',
38439
- type: 'string',
38440
- },
38441
- workspace_id: {
38442
- description:
38443
- 'Unique identifier for the Seam workspace associated with the access grant.',
38444
- format: 'uuid',
38445
- type: 'string',
38446
- },
38447
- },
38448
- required: [
38449
- 'workspace_id',
38450
- 'access_grant_id',
38451
- 'user_identity_id',
38452
- 'location_ids',
38453
- 'space_ids',
38454
- 'requested_access_methods',
38455
- 'access_method_ids',
38456
- 'display_name',
38457
- 'created_at',
38458
- ],
38459
- type: 'object',
38460
- 'x-draft': 'Early access.',
38461
- 'x-route-path': '/access_grants',
38462
- },
37905
+ items: { $ref: '#/components/schemas/access_grant' },
38463
37906
  type: 'array',
38464
37907
  },
38465
37908
  ok: { type: 'boolean' },
@@ -38571,61 +38014,7 @@ export default {
38571
38014
  schema: {
38572
38015
  properties: {
38573
38016
  access_method: {
38574
- properties: {
38575
- access_method_id: {
38576
- description: 'ID of the access method.',
38577
- format: 'uuid',
38578
- type: 'string',
38579
- },
38580
- created_at: {
38581
- description:
38582
- 'Date and time at which the access method was created.',
38583
- format: 'date-time',
38584
- type: 'string',
38585
- },
38586
- display_name: {
38587
- description: 'Display name of the access method.',
38588
- type: 'string',
38589
- },
38590
- instant_key_url: {
38591
- description:
38592
- 'URL of instant key for mobile key access methods.',
38593
- type: 'string',
38594
- },
38595
- is_card_encoding_required: {
38596
- description:
38597
- 'Whether card encoding is required for plastic card access methods.',
38598
- type: 'boolean',
38599
- },
38600
- issued_at: {
38601
- description:
38602
- 'Date and time at which the access method was issued.',
38603
- format: 'date-time',
38604
- type: 'string',
38605
- },
38606
- mode: {
38607
- description:
38608
- 'Access method mode. Supported values: `code`, `card`, `mobile_key`.',
38609
- enum: ['code', 'card', 'mobile_key'],
38610
- type: 'string',
38611
- },
38612
- workspace_id: {
38613
- description:
38614
- 'Unique identifier for the Seam workspace associated with the access grant.',
38615
- format: 'uuid',
38616
- type: 'string',
38617
- },
38618
- },
38619
- required: [
38620
- 'workspace_id',
38621
- 'access_method_id',
38622
- 'display_name',
38623
- 'mode',
38624
- 'created_at',
38625
- ],
38626
- type: 'object',
38627
- 'x-draft': 'Early access.',
38628
- 'x-route-path': '/access_methods',
38017
+ $ref: '#/components/schemas/access_method',
38629
38018
  },
38630
38019
  ok: { type: 'boolean' },
38631
38020
  },
@@ -38684,63 +38073,7 @@ export default {
38684
38073
  schema: {
38685
38074
  properties: {
38686
38075
  access_methods: {
38687
- items: {
38688
- properties: {
38689
- access_method_id: {
38690
- description: 'ID of the access method.',
38691
- format: 'uuid',
38692
- type: 'string',
38693
- },
38694
- created_at: {
38695
- description:
38696
- 'Date and time at which the access method was created.',
38697
- format: 'date-time',
38698
- type: 'string',
38699
- },
38700
- display_name: {
38701
- description: 'Display name of the access method.',
38702
- type: 'string',
38703
- },
38704
- instant_key_url: {
38705
- description:
38706
- 'URL of instant key for mobile key access methods.',
38707
- type: 'string',
38708
- },
38709
- is_card_encoding_required: {
38710
- description:
38711
- 'Whether card encoding is required for plastic card access methods.',
38712
- type: 'boolean',
38713
- },
38714
- issued_at: {
38715
- description:
38716
- 'Date and time at which the access method was issued.',
38717
- format: 'date-time',
38718
- type: 'string',
38719
- },
38720
- mode: {
38721
- description:
38722
- 'Access method mode. Supported values: `code`, `card`, `mobile_key`.',
38723
- enum: ['code', 'card', 'mobile_key'],
38724
- type: 'string',
38725
- },
38726
- workspace_id: {
38727
- description:
38728
- 'Unique identifier for the Seam workspace associated with the access grant.',
38729
- format: 'uuid',
38730
- type: 'string',
38731
- },
38732
- },
38733
- required: [
38734
- 'workspace_id',
38735
- 'access_method_id',
38736
- 'display_name',
38737
- 'mode',
38738
- 'created_at',
38739
- ],
38740
- type: 'object',
38741
- 'x-draft': 'Early access.',
38742
- 'x-route-path': '/access_methods',
38743
- },
38076
+ items: { $ref: '#/components/schemas/access_method' },
38744
38077
  type: 'array',
38745
38078
  },
38746
38079
  ok: { type: 'boolean' },
@@ -39881,76 +39214,46 @@ export default {
39881
39214
  content: {
39882
39215
  'application/json': {
39883
39216
  schema: {
39884
- oneOf: [
39885
- {
39886
- properties: {
39887
- building_block_type: {
39888
- description: '`connect_accounts` building block type.',
39889
- enum: ['connect_accounts'],
39890
- type: 'string',
39891
- },
39892
- customer_key: {
39893
- description:
39894
- 'Customer key for which you want to create a new building block magic link.',
39895
- type: 'string',
39896
- },
39897
- },
39898
- required: ['building_block_type', 'customer_key'],
39899
- type: 'object',
39217
+ properties: {
39218
+ building_block_type: {
39219
+ description:
39220
+ 'Type of building block to create a magic link for.',
39221
+ enum: [
39222
+ 'connect_accounts',
39223
+ 'organize_spaces',
39224
+ 'console',
39225
+ 'manage_devices',
39226
+ ],
39227
+ type: 'string',
39900
39228
  },
39901
- {
39902
- properties: {
39903
- building_block_type: {
39904
- description: '`manage_devices` building block type.',
39905
- enum: ['manage_devices'],
39906
- type: 'string',
39907
- },
39908
- customer_key: {
39909
- description:
39910
- 'Customer key for which you want to create a new building block magic link.',
39911
- type: 'string',
39912
- },
39913
- },
39914
- required: ['building_block_type', 'customer_key'],
39915
- type: 'object',
39229
+ customer_key: {
39230
+ description:
39231
+ 'Customer key for which you want to create a new building block magic link.',
39232
+ type: 'string',
39916
39233
  },
39917
- {
39918
- properties: {
39919
- building_block_type: {
39920
- description: '`organize_spaces` building block type.',
39921
- enum: ['organize_spaces'],
39922
- type: 'string',
39923
- },
39924
- customer_key: {
39925
- description:
39926
- 'Customer key for which you want to create a new building block magic link.',
39927
- type: 'string',
39928
- },
39929
- partner_resources: {
39930
- description:
39931
- 'Optional list of partner resources that you want to include in the new building block magic link.',
39932
- items: {
39933
- properties: {
39934
- custom_metadata: {
39935
- additionalProperties: { type: 'string' },
39936
- type: 'object',
39937
- },
39938
- description: { type: 'string' },
39939
- name: { type: 'string' },
39940
- partner_resource_key: { type: 'string' },
39941
- },
39942
- required: ['partner_resource_key', 'name'],
39234
+ spaces: {
39235
+ description:
39236
+ 'Optional list of spaces that you want to include in the new building block magic link.',
39237
+ items: {
39238
+ properties: {
39239
+ custom_metadata: {
39240
+ additionalProperties: { type: 'string' },
39943
39241
  type: 'object',
39944
- 'x-route-path': '/unstable_partner/resources',
39945
- 'x-undocumented': 'Unreleased.',
39946
39242
  },
39947
- type: 'array',
39243
+ description: { type: 'string' },
39244
+ name: { type: 'string' },
39245
+ space_key: { type: 'string' },
39948
39246
  },
39247
+ required: ['space_key', 'name'],
39248
+ type: 'object',
39249
+ 'x-route-path': '/unstable_partner/resources',
39250
+ 'x-undocumented': 'Unreleased.',
39949
39251
  },
39950
- required: ['building_block_type', 'customer_key'],
39951
- type: 'object',
39252
+ type: 'array',
39952
39253
  },
39953
- ],
39254
+ },
39255
+ required: ['building_block_type', 'customer_key'],
39256
+ type: 'object',
39954
39257
  },
39955
39258
  },
39956
39259
  },
@@ -40060,9 +39363,9 @@ export default {
40060
39363
  'Customer key for which you want to organize spaces.',
40061
39364
  type: 'string',
40062
39365
  },
40063
- partner_resources: {
39366
+ spaces: {
40064
39367
  description:
40065
- 'Optional list of partner resources that you want to include in the new building block magic link.',
39368
+ 'Optional list of spaces that you want to include in the new building block magic link.',
40066
39369
  items: {
40067
39370
  properties: {
40068
39371
  custom_metadata: {
@@ -40071,9 +39374,9 @@ export default {
40071
39374
  },
40072
39375
  description: { type: 'string' },
40073
39376
  name: { type: 'string' },
40074
- partner_resource_key: { type: 'string' },
39377
+ space_key: { type: 'string' },
40075
39378
  },
40076
- required: ['partner_resource_key', 'name'],
39379
+ required: ['space_key', 'name'],
40077
39380
  type: 'object',
40078
39381
  'x-route-path': '/unstable_partner/resources',
40079
39382
  'x-undocumented': 'Unreleased.',