@seamapi/types 1.453.0 → 1.455.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.
@@ -25128,6 +25128,251 @@ export default {
25128
25128
  'x-title': 'Get an Access Grant',
25129
25129
  },
25130
25130
  },
25131
+ '/access_grants/get_related': {
25132
+ get: {
25133
+ description: 'Gets all related resources for one or more Access Grants.',
25134
+ operationId: 'accessGrantsGetRelatedGet',
25135
+ parameters: [
25136
+ {
25137
+ in: 'query',
25138
+ name: 'access_grant_ids',
25139
+ required: true,
25140
+ schema: {
25141
+ description: 'IDs of the access grants that you want to get along with their related resources.',
25142
+ items: { format: 'uuid', type: 'string' },
25143
+ type: 'array',
25144
+ },
25145
+ },
25146
+ {
25147
+ in: 'query',
25148
+ name: 'include',
25149
+ required: false,
25150
+ schema: {
25151
+ items: {
25152
+ enum: ['spaces', 'devices', 'acs_entrances'],
25153
+ type: 'string',
25154
+ },
25155
+ type: 'array',
25156
+ },
25157
+ },
25158
+ {
25159
+ in: 'query',
25160
+ name: 'exclude',
25161
+ required: false,
25162
+ schema: {
25163
+ items: {
25164
+ enum: ['spaces', 'devices', 'acs_entrances'],
25165
+ type: 'string',
25166
+ },
25167
+ type: 'array',
25168
+ },
25169
+ },
25170
+ ],
25171
+ responses: {
25172
+ 200: {
25173
+ content: {
25174
+ 'application/json': {
25175
+ schema: {
25176
+ properties: {
25177
+ batch: {
25178
+ description: 'Represents a resource batch.',
25179
+ oneOf: [
25180
+ {
25181
+ description: 'ID of the affected access system user.',
25182
+ properties: {
25183
+ acs_entrances: {
25184
+ items: {
25185
+ $ref: '#/components/schemas/acs_entrance',
25186
+ },
25187
+ type: 'array',
25188
+ },
25189
+ batch_type: { enum: ['spaces'], type: 'string' },
25190
+ devices: {
25191
+ items: { $ref: '#/components/schemas/device' },
25192
+ type: 'array',
25193
+ },
25194
+ spaces: {
25195
+ items: { $ref: '#/components/schemas/space' },
25196
+ type: 'array',
25197
+ },
25198
+ },
25199
+ required: ['batch_type'],
25200
+ type: 'object',
25201
+ },
25202
+ {
25203
+ properties: {
25204
+ acs_entrances: {
25205
+ items: {
25206
+ $ref: '#/components/schemas/acs_entrance',
25207
+ },
25208
+ type: 'array',
25209
+ },
25210
+ batch_type: {
25211
+ enum: ['access_grants'],
25212
+ type: 'string',
25213
+ },
25214
+ devices: {
25215
+ items: { $ref: '#/components/schemas/device' },
25216
+ type: 'array',
25217
+ },
25218
+ spaces: {
25219
+ items: { $ref: '#/components/schemas/space' },
25220
+ type: 'array',
25221
+ },
25222
+ },
25223
+ required: ['batch_type'],
25224
+ type: 'object',
25225
+ },
25226
+ ],
25227
+ 'x-route-path': '/',
25228
+ },
25229
+ ok: { type: 'boolean' },
25230
+ },
25231
+ required: ['batch', 'ok'],
25232
+ type: 'object',
25233
+ },
25234
+ },
25235
+ },
25236
+ description: 'OK',
25237
+ },
25238
+ 400: { description: 'Bad Request' },
25239
+ 401: { description: 'Unauthorized' },
25240
+ },
25241
+ security: [
25242
+ { pat_with_workspace: [] },
25243
+ { console_session_with_workspace: [] },
25244
+ { api_key: [] },
25245
+ ],
25246
+ summary: '/access_grants/get_related',
25247
+ tags: [],
25248
+ 'x-batch-type': 'access_grants',
25249
+ 'x-draft': 'Early access.',
25250
+ 'x-fern-sdk-group-name': ['access_grants'],
25251
+ 'x-fern-sdk-method-name': 'get_related',
25252
+ 'x-fern-sdk-return-value': 'batch',
25253
+ 'x-response-key': 'batch',
25254
+ 'x-title': 'Get related Access Grant resources',
25255
+ },
25256
+ post: {
25257
+ description: 'Gets all related resources for one or more Access Grants.',
25258
+ operationId: 'accessGrantsGetRelatedPost',
25259
+ requestBody: {
25260
+ content: {
25261
+ 'application/json': {
25262
+ schema: {
25263
+ properties: {
25264
+ access_grant_ids: {
25265
+ description: 'IDs of the access grants that you want to get along with their related resources.',
25266
+ items: { format: 'uuid', type: 'string' },
25267
+ type: 'array',
25268
+ },
25269
+ exclude: {
25270
+ items: {
25271
+ enum: ['spaces', 'devices', 'acs_entrances'],
25272
+ type: 'string',
25273
+ },
25274
+ type: 'array',
25275
+ },
25276
+ include: {
25277
+ items: {
25278
+ enum: ['spaces', 'devices', 'acs_entrances'],
25279
+ type: 'string',
25280
+ },
25281
+ type: 'array',
25282
+ },
25283
+ },
25284
+ required: ['access_grant_ids'],
25285
+ type: 'object',
25286
+ },
25287
+ },
25288
+ },
25289
+ },
25290
+ responses: {
25291
+ 200: {
25292
+ content: {
25293
+ 'application/json': {
25294
+ schema: {
25295
+ properties: {
25296
+ batch: {
25297
+ description: 'Represents a resource batch.',
25298
+ oneOf: [
25299
+ {
25300
+ description: 'ID of the affected access system user.',
25301
+ properties: {
25302
+ acs_entrances: {
25303
+ items: {
25304
+ $ref: '#/components/schemas/acs_entrance',
25305
+ },
25306
+ type: 'array',
25307
+ },
25308
+ batch_type: { enum: ['spaces'], type: 'string' },
25309
+ devices: {
25310
+ items: { $ref: '#/components/schemas/device' },
25311
+ type: 'array',
25312
+ },
25313
+ spaces: {
25314
+ items: { $ref: '#/components/schemas/space' },
25315
+ type: 'array',
25316
+ },
25317
+ },
25318
+ required: ['batch_type'],
25319
+ type: 'object',
25320
+ },
25321
+ {
25322
+ properties: {
25323
+ acs_entrances: {
25324
+ items: {
25325
+ $ref: '#/components/schemas/acs_entrance',
25326
+ },
25327
+ type: 'array',
25328
+ },
25329
+ batch_type: {
25330
+ enum: ['access_grants'],
25331
+ type: 'string',
25332
+ },
25333
+ devices: {
25334
+ items: { $ref: '#/components/schemas/device' },
25335
+ type: 'array',
25336
+ },
25337
+ spaces: {
25338
+ items: { $ref: '#/components/schemas/space' },
25339
+ type: 'array',
25340
+ },
25341
+ },
25342
+ required: ['batch_type'],
25343
+ type: 'object',
25344
+ },
25345
+ ],
25346
+ 'x-route-path': '/',
25347
+ },
25348
+ ok: { type: 'boolean' },
25349
+ },
25350
+ required: ['batch', 'ok'],
25351
+ type: 'object',
25352
+ },
25353
+ },
25354
+ },
25355
+ description: 'OK',
25356
+ },
25357
+ 400: { description: 'Bad Request' },
25358
+ 401: { description: 'Unauthorized' },
25359
+ },
25360
+ security: [
25361
+ { pat_with_workspace: [] },
25362
+ { console_session_with_workspace: [] },
25363
+ { api_key: [] },
25364
+ ],
25365
+ summary: '/access_grants/get_related',
25366
+ tags: [],
25367
+ 'x-batch-type': 'access_grants',
25368
+ 'x-draft': 'Early access.',
25369
+ 'x-fern-sdk-group-name': ['access_grants'],
25370
+ 'x-fern-sdk-method-name': 'get_related',
25371
+ 'x-fern-sdk-return-value': 'batch',
25372
+ 'x-response-key': 'batch',
25373
+ 'x-title': 'Get related Access Grant resources',
25374
+ },
25375
+ },
25131
25376
  '/access_grants/list': {
25132
25377
  get: {
25133
25378
  description: 'Gets an Access Grant.',
@@ -43608,23 +43853,54 @@ export default {
43608
43853
  properties: {
43609
43854
  batch: {
43610
43855
  description: 'Represents a resource batch.',
43611
- properties: {
43612
- acs_entrances: {
43613
- items: { $ref: '#/components/schemas/acs_entrance' },
43614
- type: 'array',
43615
- },
43616
- batch_type: { enum: ['spaces'], type: 'string' },
43617
- devices: {
43618
- items: { $ref: '#/components/schemas/device' },
43619
- type: 'array',
43856
+ oneOf: [
43857
+ {
43858
+ description: 'ID of the affected access system user.',
43859
+ properties: {
43860
+ acs_entrances: {
43861
+ items: {
43862
+ $ref: '#/components/schemas/acs_entrance',
43863
+ },
43864
+ type: 'array',
43865
+ },
43866
+ batch_type: { enum: ['spaces'], type: 'string' },
43867
+ devices: {
43868
+ items: { $ref: '#/components/schemas/device' },
43869
+ type: 'array',
43870
+ },
43871
+ spaces: {
43872
+ items: { $ref: '#/components/schemas/space' },
43873
+ type: 'array',
43874
+ },
43875
+ },
43876
+ required: ['batch_type'],
43877
+ type: 'object',
43620
43878
  },
43621
- spaces: {
43622
- items: { $ref: '#/components/schemas/space' },
43623
- type: 'array',
43879
+ {
43880
+ properties: {
43881
+ acs_entrances: {
43882
+ items: {
43883
+ $ref: '#/components/schemas/acs_entrance',
43884
+ },
43885
+ type: 'array',
43886
+ },
43887
+ batch_type: {
43888
+ enum: ['access_grants'],
43889
+ type: 'string',
43890
+ },
43891
+ devices: {
43892
+ items: { $ref: '#/components/schemas/device' },
43893
+ type: 'array',
43894
+ },
43895
+ spaces: {
43896
+ items: { $ref: '#/components/schemas/space' },
43897
+ type: 'array',
43898
+ },
43899
+ },
43900
+ required: ['batch_type'],
43901
+ type: 'object',
43624
43902
  },
43625
- },
43626
- required: ['batch_type'],
43627
- type: 'object',
43903
+ ],
43628
43904
  'x-route-path': '/',
43629
43905
  },
43630
43906
  ok: { type: 'boolean' },
@@ -43696,23 +43972,54 @@ export default {
43696
43972
  properties: {
43697
43973
  batch: {
43698
43974
  description: 'Represents a resource batch.',
43699
- properties: {
43700
- acs_entrances: {
43701
- items: { $ref: '#/components/schemas/acs_entrance' },
43702
- type: 'array',
43703
- },
43704
- batch_type: { enum: ['spaces'], type: 'string' },
43705
- devices: {
43706
- items: { $ref: '#/components/schemas/device' },
43707
- type: 'array',
43975
+ oneOf: [
43976
+ {
43977
+ description: 'ID of the affected access system user.',
43978
+ properties: {
43979
+ acs_entrances: {
43980
+ items: {
43981
+ $ref: '#/components/schemas/acs_entrance',
43982
+ },
43983
+ type: 'array',
43984
+ },
43985
+ batch_type: { enum: ['spaces'], type: 'string' },
43986
+ devices: {
43987
+ items: { $ref: '#/components/schemas/device' },
43988
+ type: 'array',
43989
+ },
43990
+ spaces: {
43991
+ items: { $ref: '#/components/schemas/space' },
43992
+ type: 'array',
43993
+ },
43994
+ },
43995
+ required: ['batch_type'],
43996
+ type: 'object',
43708
43997
  },
43709
- spaces: {
43710
- items: { $ref: '#/components/schemas/space' },
43711
- type: 'array',
43998
+ {
43999
+ properties: {
44000
+ acs_entrances: {
44001
+ items: {
44002
+ $ref: '#/components/schemas/acs_entrance',
44003
+ },
44004
+ type: 'array',
44005
+ },
44006
+ batch_type: {
44007
+ enum: ['access_grants'],
44008
+ type: 'string',
44009
+ },
44010
+ devices: {
44011
+ items: { $ref: '#/components/schemas/device' },
44012
+ type: 'array',
44013
+ },
44014
+ spaces: {
44015
+ items: { $ref: '#/components/schemas/space' },
44016
+ type: 'array',
44017
+ },
44018
+ },
44019
+ required: ['batch_type'],
44020
+ type: 'object',
43712
44021
  },
43713
- },
43714
- required: ['batch_type'],
43715
- type: 'object',
44022
+ ],
43716
44023
  'x-route-path': '/',
43717
44024
  },
43718
44025
  ok: { type: 'boolean' },
@@ -46576,6 +46883,18 @@ export default {
46576
46883
  required: ['hvac_mode_setting', 'device_id'],
46577
46884
  type: 'object',
46578
46885
  },
46886
+ {
46887
+ properties: {
46888
+ device_id: {
46889
+ description: 'ID of the thermostat device for which you want to set the HVAC mode.',
46890
+ format: 'uuid',
46891
+ type: 'string',
46892
+ },
46893
+ hvac_mode_setting: { enum: ['eco'], type: 'string' },
46894
+ },
46895
+ required: ['hvac_mode_setting', 'device_id'],
46896
+ type: 'object',
46897
+ },
46579
46898
  ],
46580
46899
  },
46581
46900
  },