@seamapi/types 1.445.0 → 1.446.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.
Files changed (30) hide show
  1. package/dist/connect.cjs +148 -103
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +230 -135
  4. package/dist/index.cjs +148 -103
  5. package/dist/index.cjs.map +1 -1
  6. package/lib/seam/connect/models/access-grants/access-grant.d.ts +3 -0
  7. package/lib/seam/connect/models/access-grants/access-grant.js +16 -12
  8. package/lib/seam/connect/models/access-grants/access-grant.js.map +1 -1
  9. package/lib/seam/connect/models/access-grants/access-method.js +1 -1
  10. package/lib/seam/connect/models/access-grants/requested-access-method.js +1 -1
  11. package/lib/seam/connect/models/batches/batch.d.ts +5 -0
  12. package/lib/seam/connect/models/batches/spaces.d.ts +5 -0
  13. package/lib/seam/connect/models/events/access-grants.js +6 -6
  14. package/lib/seam/connect/models/events/access-methods.js +1 -1
  15. package/lib/seam/connect/models/spaces/space.d.ts +3 -0
  16. package/lib/seam/connect/models/spaces/space.js +4 -0
  17. package/lib/seam/connect/models/spaces/space.js.map +1 -1
  18. package/lib/seam/connect/openapi.d.ts +86 -38
  19. package/lib/seam/connect/openapi.js +140 -96
  20. package/lib/seam/connect/openapi.js.map +1 -1
  21. package/lib/seam/connect/route-types.d.ts +133 -97
  22. package/package.json +1 -1
  23. package/src/lib/seam/connect/models/access-grants/access-grant.ts +16 -12
  24. package/src/lib/seam/connect/models/access-grants/access-method.ts +1 -1
  25. package/src/lib/seam/connect/models/access-grants/requested-access-method.ts +1 -1
  26. package/src/lib/seam/connect/models/events/access-grants.ts +6 -6
  27. package/src/lib/seam/connect/models/events/access-methods.ts +1 -1
  28. package/src/lib/seam/connect/models/spaces/space.ts +4 -0
  29. package/src/lib/seam/connect/openapi.ts +147 -96
  30. package/src/lib/seam/connect/route-types.ts +144 -104
@@ -1569,34 +1569,38 @@ export default {
1569
1569
  'x-route-path': '/access_codes',
1570
1570
  },
1571
1571
  access_grant: {
1572
- description: 'Represents an access grant. Access grants enable you to grant a user identity access to spaces, entrances, and devices through one or more access methods, such as mobile keys, plastic cards, and PIN codes. You can create an access grant for an existing user identity, or you can create a new user identity *while* creating the new access grant.',
1572
+ description: 'Represents an Access Grant. Access Grants enable you to grant a user identity access to spaces, entrances, and devices through one or more access methods, such as mobile keys, plastic cards, and PIN codes. You can create an Access Grant for an existing user identity, or you can create a new user identity *while* creating the new Access Grant.',
1573
1573
  properties: {
1574
1574
  access_grant_id: {
1575
- description: 'ID of the access grant.',
1575
+ description: 'ID of the Access Grant.',
1576
1576
  format: 'uuid',
1577
1577
  type: 'string',
1578
1578
  },
1579
+ access_grant_key: {
1580
+ description: 'Unique key for the access grant within the workspace.',
1581
+ type: 'string',
1582
+ },
1579
1583
  access_method_ids: {
1580
- description: 'IDs of the access methods created for the access grant.',
1584
+ description: 'IDs of the access methods created for the Access Grant.',
1581
1585
  items: { format: 'uuid', type: 'string' },
1582
1586
  type: 'array',
1583
1587
  },
1584
1588
  created_at: {
1585
- description: 'Date and time at which the access grant was created.',
1589
+ description: 'Date and time at which the Access Grant was created.',
1586
1590
  format: 'date-time',
1587
1591
  type: 'string',
1588
1592
  },
1589
1593
  display_name: {
1590
- description: 'Display name of the access grant.',
1594
+ description: 'Display name of the Access Grant.',
1591
1595
  type: 'string',
1592
1596
  },
1593
1597
  ends_at: {
1594
- description: 'Date and time at which the access grant ends.',
1598
+ description: 'Date and time at which the Access Grant ends.',
1595
1599
  format: 'date-time',
1596
1600
  type: 'string',
1597
1601
  },
1598
1602
  instant_key_url: {
1599
- description: 'Instant Key URL. Only returned if the access grant has a single mobile_key access_method. ',
1603
+ description: 'Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method. ',
1600
1604
  format: 'uri',
1601
1605
  type: 'string',
1602
1606
  },
@@ -1607,7 +1611,7 @@ export default {
1607
1611
  'x-deprecated': 'Use `space_ids`.',
1608
1612
  },
1609
1613
  requested_access_methods: {
1610
- description: 'Access methods that the user requested for the access grant.',
1614
+ description: 'Access methods that the user requested for the Access Grant.',
1611
1615
  items: {
1612
1616
  properties: {
1613
1617
  created_access_method_ids: {
@@ -1616,7 +1620,7 @@ export default {
1616
1620
  type: 'array',
1617
1621
  },
1618
1622
  created_at: {
1619
- description: 'Date and time at which the requested access method was added to the access grant.',
1623
+ description: 'Date and time at which the requested access method was added to the Access Grant.',
1620
1624
  format: 'date-time',
1621
1625
  type: 'string',
1622
1626
  },
@@ -1641,22 +1645,22 @@ export default {
1641
1645
  type: 'array',
1642
1646
  },
1643
1647
  space_ids: {
1644
- description: 'IDs of the spaces to which the access grant gives access.',
1648
+ description: 'IDs of the spaces to which the Access Grant gives access.',
1645
1649
  items: { format: 'uuid', type: 'string' },
1646
1650
  type: 'array',
1647
1651
  },
1648
1652
  starts_at: {
1649
- description: 'Date and time at which the access grant starts.',
1653
+ description: 'Date and time at which the Access Grant starts.',
1650
1654
  format: 'date-time',
1651
1655
  type: 'string',
1652
1656
  },
1653
1657
  user_identity_id: {
1654
- description: 'ID of user identity to which the access grant gives access.',
1658
+ description: 'ID of user identity to which the Access Grant gives access.',
1655
1659
  format: 'uuid',
1656
1660
  type: 'string',
1657
1661
  },
1658
1662
  workspace_id: {
1659
- description: 'ID of the Seam workspace associated with the access grant.',
1663
+ description: 'ID of the Seam workspace associated with the Access Grant.',
1660
1664
  format: 'uuid',
1661
1665
  type: 'string',
1662
1666
  },
@@ -1677,7 +1681,7 @@ export default {
1677
1681
  'x-route-path': '/access_grants',
1678
1682
  },
1679
1683
  access_method: {
1680
- description: 'Represents an access method for an access grant. Access methods describe the modes of access, such as PIN codes, plastic cards, and mobile keys. For a mobile key, the access method also stores the URL for the associated Instant Key.',
1684
+ description: 'Represents an access method for an Access Grant. Access methods describe the modes of access, such as PIN codes, plastic cards, and mobile keys. For a mobile key, the access method also stores the URL for the associated Instant Key.',
1681
1685
  properties: {
1682
1686
  access_method_id: {
1683
1687
  description: 'ID of the access method.',
@@ -12648,10 +12652,10 @@ export default {
12648
12652
  'x-route-path': '/access_codes/unmanaged',
12649
12653
  },
12650
12654
  {
12651
- description: 'An access grant was created.',
12655
+ description: 'An Access Grant was created.',
12652
12656
  properties: {
12653
12657
  access_grant_id: {
12654
- description: 'ID of the affected access grant.',
12658
+ description: 'ID of the affected Access Grant.',
12655
12659
  format: 'uuid',
12656
12660
  type: 'string',
12657
12661
  },
@@ -12689,10 +12693,10 @@ export default {
12689
12693
  'x-route-path': '/access_grants',
12690
12694
  },
12691
12695
  {
12692
- description: 'An access grant was deleted.',
12696
+ description: 'An Access Grant was deleted.',
12693
12697
  properties: {
12694
12698
  access_grant_id: {
12695
- description: 'ID of the affected access grant.',
12699
+ description: 'ID of the affected Access Grant.',
12696
12700
  format: 'uuid',
12697
12701
  type: 'string',
12698
12702
  },
@@ -12730,10 +12734,10 @@ export default {
12730
12734
  'x-route-path': '/access_grants',
12731
12735
  },
12732
12736
  {
12733
- description: 'All access requested for an access grant was successfully granted.',
12737
+ description: 'All access requested for an Access Grant was successfully granted.',
12734
12738
  properties: {
12735
12739
  access_grant_id: {
12736
- description: 'ID of the affected access grant.',
12740
+ description: 'ID of the affected Access Grant.',
12737
12741
  format: 'uuid',
12738
12742
  type: 'string',
12739
12743
  },
@@ -12774,10 +12778,10 @@ export default {
12774
12778
  'x-route-path': '/access_grants',
12775
12779
  },
12776
12780
  {
12777
- description: 'Access requested as part of an access grant to a particular door was successfully granted.',
12781
+ description: 'Access requested as part of an Access Grant to a particular door was successfully granted.',
12778
12782
  properties: {
12779
12783
  access_grant_id: {
12780
- description: 'ID of the affected access grant.',
12784
+ description: 'ID of the affected Access Grant.',
12781
12785
  format: 'uuid',
12782
12786
  type: 'string',
12783
12787
  },
@@ -12824,10 +12828,10 @@ export default {
12824
12828
  'x-route-path': '/access_grants',
12825
12829
  },
12826
12830
  {
12827
- description: 'Access to a particular door that was requested as part of an access grant was lost.',
12831
+ description: 'Access to a particular door that was requested as part of an Access Grant was lost.',
12828
12832
  properties: {
12829
12833
  access_grant_id: {
12830
- description: 'ID of the affected access grant.',
12834
+ description: 'ID of the affected Access Grant.',
12831
12835
  format: 'uuid',
12832
12836
  type: 'string',
12833
12837
  },
@@ -13041,7 +13045,7 @@ export default {
13041
13045
  'x-route-path': '/access_methods',
13042
13046
  },
13043
13047
  {
13044
- description: 'An access method was reissued due to an access grant update.',
13048
+ description: 'An access method was reissued due to an Access Grant update.',
13045
13049
  properties: {
13046
13050
  access_method_id: {
13047
13051
  description: 'ID of the affected access method.',
@@ -18042,6 +18046,10 @@ export default {
18042
18046
  format: 'uuid',
18043
18047
  type: 'string',
18044
18048
  },
18049
+ space_key: {
18050
+ description: 'Unique key for the space within the workspace.',
18051
+ type: 'string',
18052
+ },
18045
18053
  workspace_id: {
18046
18054
  description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the space.',
18047
18055
  format: 'uuid',
@@ -24694,7 +24702,7 @@ export default {
24694
24702
  },
24695
24703
  '/access_grants/create': {
24696
24704
  post: {
24697
- description: 'Creates a new access grant.',
24705
+ description: 'Creates a new Access Grant.',
24698
24706
  operationId: 'accessGrantsCreatePost',
24699
24707
  requestBody: {
24700
24708
  content: {
@@ -24746,6 +24754,10 @@ export default {
24746
24754
  },
24747
24755
  {
24748
24756
  properties: {
24757
+ access_grant_key: {
24758
+ description: 'Unique key for the access grant within the workspace.',
24759
+ type: 'string',
24760
+ },
24749
24761
  acs_entrance_ids: {
24750
24762
  default: [],
24751
24763
  description: 'Set of IDs of the [entrances](https://docs.seam.co/latest/api/acs/systems/list) to which access is being granted.',
@@ -24861,7 +24873,7 @@ export default {
24861
24873
  },
24862
24874
  '/access_grants/delete': {
24863
24875
  delete: {
24864
- description: 'Delete an access grant.',
24876
+ description: 'Delete an Access Grant.',
24865
24877
  operationId: 'accessGrantsDeleteDelete',
24866
24878
  parameters: [
24867
24879
  {
@@ -24869,7 +24881,7 @@ export default {
24869
24881
  name: 'access_grant_id',
24870
24882
  required: true,
24871
24883
  schema: {
24872
- description: 'ID of access grant to delete.',
24884
+ description: 'ID of Access Grant to delete.',
24873
24885
  format: 'uuid',
24874
24886
  type: 'string',
24875
24887
  },
@@ -24906,7 +24918,7 @@ export default {
24906
24918
  'x-title': 'Delete an Access Grant',
24907
24919
  },
24908
24920
  post: {
24909
- description: 'Delete an access grant.',
24921
+ description: 'Delete an Access Grant.',
24910
24922
  operationId: 'accessGrantsDeletePost',
24911
24923
  requestBody: {
24912
24924
  content: {
@@ -24914,7 +24926,7 @@ export default {
24914
24926
  schema: {
24915
24927
  properties: {
24916
24928
  access_grant_id: {
24917
- description: 'ID of access grant to delete.',
24929
+ description: 'ID of Access Grant to delete.',
24918
24930
  format: 'uuid',
24919
24931
  type: 'string',
24920
24932
  },
@@ -24958,20 +24970,8 @@ export default {
24958
24970
  },
24959
24971
  '/access_grants/get': {
24960
24972
  get: {
24961
- description: 'Get an access grant.',
24973
+ description: 'Get an Access Grant.',
24962
24974
  operationId: 'accessGrantsGetGet',
24963
- parameters: [
24964
- {
24965
- in: 'query',
24966
- name: 'access_grant_id',
24967
- required: true,
24968
- schema: {
24969
- description: 'ID of access grant to get.',
24970
- format: 'uuid',
24971
- type: 'string',
24972
- },
24973
- },
24974
- ],
24975
24975
  responses: {
24976
24976
  200: {
24977
24977
  content: {
@@ -25007,21 +25007,35 @@ export default {
25007
25007
  'x-title': 'Get an Access Grant',
25008
25008
  },
25009
25009
  post: {
25010
- description: 'Get an access grant.',
25010
+ description: 'Get an Access Grant.',
25011
25011
  operationId: 'accessGrantsGetPost',
25012
25012
  requestBody: {
25013
25013
  content: {
25014
25014
  'application/json': {
25015
25015
  schema: {
25016
- properties: {
25017
- access_grant_id: {
25018
- description: 'ID of access grant to get.',
25019
- format: 'uuid',
25020
- type: 'string',
25016
+ oneOf: [
25017
+ {
25018
+ properties: {
25019
+ access_grant_id: {
25020
+ description: 'ID of Access Grant to get.',
25021
+ format: 'uuid',
25022
+ type: 'string',
25023
+ },
25024
+ },
25025
+ required: ['access_grant_id'],
25026
+ type: 'object',
25021
25027
  },
25022
- },
25023
- required: ['access_grant_id'],
25024
- type: 'object',
25028
+ {
25029
+ properties: {
25030
+ access_grant_key: {
25031
+ description: 'Unique key of Access Grant to get.',
25032
+ type: 'string',
25033
+ },
25034
+ },
25035
+ required: ['access_grant_key'],
25036
+ type: 'object',
25037
+ },
25038
+ ],
25025
25039
  },
25026
25040
  },
25027
25041
  },
@@ -25063,14 +25077,14 @@ export default {
25063
25077
  },
25064
25078
  '/access_grants/list': {
25065
25079
  get: {
25066
- description: 'Get an access grant.',
25080
+ description: 'Gets an Access Grant.',
25067
25081
  operationId: 'accessGrantsListGet',
25068
25082
  parameters: [
25069
25083
  {
25070
25084
  in: 'query',
25071
25085
  name: 'user_identity_id',
25072
25086
  schema: {
25073
- description: 'ID of user identity to filter list of access grants by.',
25087
+ description: 'ID of user identity by which you want to filter the list of Access Grants.',
25074
25088
  format: 'uuid',
25075
25089
  type: 'string',
25076
25090
  },
@@ -25079,7 +25093,7 @@ export default {
25079
25093
  in: 'query',
25080
25094
  name: 'acs_system_id',
25081
25095
  schema: {
25082
- description: 'ID of system to filter list of access grants by.',
25096
+ description: 'ID of the access system by which you want to filter the list of Access Grants.',
25083
25097
  format: 'uuid',
25084
25098
  type: 'string',
25085
25099
  },
@@ -25088,7 +25102,7 @@ export default {
25088
25102
  in: 'query',
25089
25103
  name: 'acs_entrance_id',
25090
25104
  schema: {
25091
- description: 'ID of entrance to filter list of access grants by.',
25105
+ description: 'ID of the entrance by which you want to filter the list of Access Grants.',
25092
25106
  format: 'uuid',
25093
25107
  type: 'string',
25094
25108
  },
@@ -25107,11 +25121,19 @@ export default {
25107
25121
  in: 'query',
25108
25122
  name: 'space_id',
25109
25123
  schema: {
25110
- description: 'ID of space to filter list of access grants by.',
25124
+ description: 'ID of the space by which you want to filter the list of Access Grants.',
25111
25125
  format: 'uuid',
25112
25126
  type: 'string',
25113
25127
  },
25114
25128
  },
25129
+ {
25130
+ in: 'query',
25131
+ name: 'access_grant_key',
25132
+ schema: {
25133
+ description: 'Filter Access Grants by access_grant_key.',
25134
+ type: 'string',
25135
+ },
25136
+ },
25115
25137
  ],
25116
25138
  responses: {
25117
25139
  200: {
@@ -25151,20 +25173,24 @@ export default {
25151
25173
  'x-title': 'List Access Grants',
25152
25174
  },
25153
25175
  post: {
25154
- description: 'Get an access grant.',
25176
+ description: 'Gets an Access Grant.',
25155
25177
  operationId: 'accessGrantsListPost',
25156
25178
  requestBody: {
25157
25179
  content: {
25158
25180
  'application/json': {
25159
25181
  schema: {
25160
25182
  properties: {
25183
+ access_grant_key: {
25184
+ description: 'Filter Access Grants by access_grant_key.',
25185
+ type: 'string',
25186
+ },
25161
25187
  acs_entrance_id: {
25162
- description: 'ID of entrance to filter list of access grants by.',
25188
+ description: 'ID of the entrance by which you want to filter the list of Access Grants.',
25163
25189
  format: 'uuid',
25164
25190
  type: 'string',
25165
25191
  },
25166
25192
  acs_system_id: {
25167
- description: 'ID of system to filter list of access grants by.',
25193
+ description: 'ID of the access system by which you want to filter the list of Access Grants.',
25168
25194
  format: 'uuid',
25169
25195
  type: 'string',
25170
25196
  },
@@ -25175,12 +25201,12 @@ export default {
25175
25201
  'x-deprecated': 'Use `space_id`.',
25176
25202
  },
25177
25203
  space_id: {
25178
- description: 'ID of space to filter list of access grants by.',
25204
+ description: 'ID of the space by which you want to filter the list of Access Grants.',
25179
25205
  format: 'uuid',
25180
25206
  type: 'string',
25181
25207
  },
25182
25208
  user_identity_id: {
25183
- description: 'ID of user identity to filter list of access grants by.',
25209
+ description: 'ID of user identity by which you want to filter the list of Access Grants.',
25184
25210
  format: 'uuid',
25185
25211
  type: 'string',
25186
25212
  },
@@ -25230,7 +25256,7 @@ export default {
25230
25256
  },
25231
25257
  '/access_grants/update': {
25232
25258
  patch: {
25233
- description: "Updates an existing access grant's time window.",
25259
+ description: "Updates an existing Access Grant's time window.",
25234
25260
  operationId: 'accessGrantsUpdatePatch',
25235
25261
  requestBody: {
25236
25262
  content: {
@@ -25238,7 +25264,7 @@ export default {
25238
25264
  schema: {
25239
25265
  properties: {
25240
25266
  access_grant_id: {
25241
- description: 'ID of the access grant to update.',
25267
+ description: 'ID of the Access Grant to update.',
25242
25268
  format: 'uuid',
25243
25269
  type: 'string',
25244
25270
  },
@@ -25292,7 +25318,7 @@ export default {
25292
25318
  'x-title': 'Update an Access Grant',
25293
25319
  },
25294
25320
  post: {
25295
- description: "Updates an existing access grant's time window.",
25321
+ description: "Updates an existing Access Grant's time window.",
25296
25322
  operationId: 'accessGrantsUpdatePost',
25297
25323
  requestBody: {
25298
25324
  content: {
@@ -25300,7 +25326,7 @@ export default {
25300
25326
  schema: {
25301
25327
  properties: {
25302
25328
  access_grant_id: {
25303
- description: 'ID of the access grant to update.',
25329
+ description: 'ID of the Access Grant to update.',
25304
25330
  format: 'uuid',
25305
25331
  type: 'string',
25306
25332
  },
@@ -25356,7 +25382,7 @@ export default {
25356
25382
  },
25357
25383
  '/access_methods/delete': {
25358
25384
  delete: {
25359
- description: 'Delete an access method.',
25385
+ description: 'Deletes an access method.',
25360
25386
  operationId: 'accessMethodsDeleteDelete',
25361
25387
  parameters: [
25362
25388
  {
@@ -25400,7 +25426,7 @@ export default {
25400
25426
  'x-title': 'Delete an Access Method',
25401
25427
  },
25402
25428
  post: {
25403
- description: 'Delete an access method.',
25429
+ description: 'Deletes an access method.',
25404
25430
  operationId: 'accessMethodsDeletePost',
25405
25431
  requestBody: {
25406
25432
  content: {
@@ -25451,7 +25477,7 @@ export default {
25451
25477
  },
25452
25478
  '/access_methods/encode': {
25453
25479
  post: {
25454
- description: 'Encodes an existing [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) onto a plastic card placed on the specified [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).',
25480
+ description: 'Encodes an existing access method onto a plastic card placed on the specified [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).',
25455
25481
  operationId: 'accessMethodsEncodePost',
25456
25482
  requestBody: {
25457
25483
  content: {
@@ -25464,7 +25490,7 @@ export default {
25464
25490
  type: 'string',
25465
25491
  },
25466
25492
  acs_encoder_id: {
25467
- description: 'ID of the `acs_encoder` to use to encode the `acs_credential`.',
25493
+ description: 'ID of the `acs_encoder` to use to encode the `access_method`.',
25468
25494
  format: 'uuid',
25469
25495
  type: 'string',
25470
25496
  },
@@ -25513,7 +25539,7 @@ export default {
25513
25539
  },
25514
25540
  '/access_methods/get': {
25515
25541
  get: {
25516
- description: 'Get an access method.',
25542
+ description: 'Gets an access method.',
25517
25543
  operationId: 'accessMethodsGetGet',
25518
25544
  parameters: [
25519
25545
  {
@@ -25563,7 +25589,7 @@ export default {
25563
25589
  'x-title': 'Get an Access Method',
25564
25590
  },
25565
25591
  post: {
25566
- description: 'Get an access method.',
25592
+ description: 'Gets an access method.',
25567
25593
  operationId: 'accessMethodsGetPost',
25568
25594
  requestBody: {
25569
25595
  content: {
@@ -25620,7 +25646,7 @@ export default {
25620
25646
  },
25621
25647
  '/access_methods/list': {
25622
25648
  get: {
25623
- description: 'List all access methods, usually filtered by access grant.',
25649
+ description: 'Lists all access methods, usually filtered by Access Grant.',
25624
25650
  operationId: 'accessMethodsListGet',
25625
25651
  parameters: [
25626
25652
  {
@@ -25628,7 +25654,7 @@ export default {
25628
25654
  name: 'access_grant_id',
25629
25655
  required: true,
25630
25656
  schema: {
25631
- description: 'ID of access grant to list access methods for.',
25657
+ description: 'ID of Access Grant to list access methods for.',
25632
25658
  format: 'uuid',
25633
25659
  type: 'string',
25634
25660
  },
@@ -25701,7 +25727,7 @@ export default {
25701
25727
  'x-title': 'List Access Methods',
25702
25728
  },
25703
25729
  post: {
25704
- description: 'List all access methods, usually filtered by access grant.',
25730
+ description: 'Lists all access methods, usually filtered by Access Grant.',
25705
25731
  operationId: 'accessMethodsListPost',
25706
25732
  requestBody: {
25707
25733
  content: {
@@ -25709,7 +25735,7 @@ export default {
25709
25735
  schema: {
25710
25736
  properties: {
25711
25737
  access_grant_id: {
25712
- description: 'ID of access grant to list access methods for.',
25738
+ description: 'ID of Access Grant to list access methods for.',
25713
25739
  format: 'uuid',
25714
25740
  type: 'string',
25715
25741
  },
@@ -43198,6 +43224,10 @@ export default {
43198
43224
  description: 'Name of the space that you want to create.',
43199
43225
  type: 'string',
43200
43226
  },
43227
+ space_key: {
43228
+ description: 'Unique key for the space within the workspace.',
43229
+ type: 'string',
43230
+ },
43201
43231
  },
43202
43232
  required: ['name'],
43203
43233
  type: 'object',
@@ -43343,18 +43373,6 @@ export default {
43343
43373
  get: {
43344
43374
  description: 'Gets a space.',
43345
43375
  operationId: 'spacesGetGet',
43346
- parameters: [
43347
- {
43348
- in: 'query',
43349
- name: 'space_id',
43350
- required: true,
43351
- schema: {
43352
- description: 'ID of the space that you want to get.',
43353
- format: 'uuid',
43354
- type: 'string',
43355
- },
43356
- },
43357
- ],
43358
43376
  responses: {
43359
43377
  200: {
43360
43378
  content: {
@@ -43395,15 +43413,29 @@ export default {
43395
43413
  content: {
43396
43414
  'application/json': {
43397
43415
  schema: {
43398
- properties: {
43399
- space_id: {
43400
- description: 'ID of the space that you want to get.',
43401
- format: 'uuid',
43402
- type: 'string',
43416
+ oneOf: [
43417
+ {
43418
+ properties: {
43419
+ space_id: {
43420
+ description: 'ID of the space that you want to get.',
43421
+ format: 'uuid',
43422
+ type: 'string',
43423
+ },
43424
+ },
43425
+ required: ['space_id'],
43426
+ type: 'object',
43403
43427
  },
43404
- },
43405
- required: ['space_id'],
43406
- type: 'object',
43428
+ {
43429
+ properties: {
43430
+ space_key: {
43431
+ description: 'Unique key of the space that you want to get.',
43432
+ type: 'string',
43433
+ },
43434
+ },
43435
+ required: ['space_key'],
43436
+ type: 'object',
43437
+ },
43438
+ ],
43407
43439
  },
43408
43440
  },
43409
43441
  },
@@ -43639,6 +43671,14 @@ export default {
43639
43671
  type: 'string',
43640
43672
  },
43641
43673
  },
43674
+ {
43675
+ in: 'query',
43676
+ name: 'space_key',
43677
+ schema: {
43678
+ description: 'Filter spaces by space_key.',
43679
+ type: 'string',
43680
+ },
43681
+ },
43642
43682
  ],
43643
43683
  responses: {
43644
43684
  200: {
@@ -43689,6 +43729,10 @@ export default {
43689
43729
  minLength: 1,
43690
43730
  type: 'string',
43691
43731
  },
43732
+ space_key: {
43733
+ description: 'Filter spaces by space_key.',
43734
+ type: 'string',
43735
+ },
43692
43736
  },
43693
43737
  type: 'object',
43694
43738
  },