@seamapi/types 1.452.0 → 1.454.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.
@@ -23948,6 +23948,27 @@ export default {
23948
23948
  type: 'string',
23949
23949
  },
23950
23950
  },
23951
+ {
23952
+ in: 'query',
23953
+ name: 'limit',
23954
+ required: false,
23955
+ schema: {
23956
+ default: 300000,
23957
+ description: 'Numerical limit on the number of unmanaged access codes to return.',
23958
+ format: 'float',
23959
+ type: 'number',
23960
+ },
23961
+ },
23962
+ {
23963
+ in: 'query',
23964
+ name: 'page_cursor',
23965
+ required: false,
23966
+ schema: {
23967
+ description: "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.",
23968
+ nullable: true,
23969
+ type: 'string',
23970
+ },
23971
+ },
23951
23972
  ],
23952
23973
  responses: {
23953
23974
  200: {
@@ -23962,8 +23983,9 @@ export default {
23962
23983
  type: 'array',
23963
23984
  },
23964
23985
  ok: { type: 'boolean' },
23986
+ pagination: { $ref: '#/components/schemas/pagination' },
23965
23987
  },
23966
- required: ['access_codes', 'ok'],
23988
+ required: ['access_codes', 'pagination', 'ok'],
23967
23989
  type: 'object',
23968
23990
  },
23969
23991
  },
@@ -24000,6 +24022,17 @@ export default {
24000
24022
  format: 'uuid',
24001
24023
  type: 'string',
24002
24024
  },
24025
+ limit: {
24026
+ default: 300000,
24027
+ description: 'Numerical limit on the number of unmanaged access codes to return.',
24028
+ format: 'float',
24029
+ type: 'number',
24030
+ },
24031
+ page_cursor: {
24032
+ description: "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.",
24033
+ nullable: true,
24034
+ type: 'string',
24035
+ },
24003
24036
  user_identifier_key: {
24004
24037
  description: 'Your user ID for the user by which to filter unmanaged access codes.',
24005
24038
  type: 'string',
@@ -24024,8 +24057,9 @@ export default {
24024
24057
  type: 'array',
24025
24058
  },
24026
24059
  ok: { type: 'boolean' },
24060
+ pagination: { $ref: '#/components/schemas/pagination' },
24027
24061
  },
24028
- required: ['access_codes', 'ok'],
24062
+ required: ['access_codes', 'pagination', 'ok'],
24029
24063
  type: 'object',
24030
24064
  },
24031
24065
  },
@@ -25094,6 +25128,251 @@ export default {
25094
25128
  'x-title': 'Get an Access Grant',
25095
25129
  },
25096
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
+ },
25097
25376
  '/access_grants/list': {
25098
25377
  get: {
25099
25378
  description: 'Gets an Access Grant.',
@@ -43574,23 +43853,54 @@ export default {
43574
43853
  properties: {
43575
43854
  batch: {
43576
43855
  description: 'Represents a resource batch.',
43577
- properties: {
43578
- acs_entrances: {
43579
- items: { $ref: '#/components/schemas/acs_entrance' },
43580
- type: 'array',
43581
- },
43582
- batch_type: { enum: ['spaces'], type: 'string' },
43583
- devices: {
43584
- items: { $ref: '#/components/schemas/device' },
43585
- 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',
43586
43878
  },
43587
- spaces: {
43588
- items: { $ref: '#/components/schemas/space' },
43589
- 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',
43590
43902
  },
43591
- },
43592
- required: ['batch_type'],
43593
- type: 'object',
43903
+ ],
43594
43904
  'x-route-path': '/',
43595
43905
  },
43596
43906
  ok: { type: 'boolean' },
@@ -43662,23 +43972,54 @@ export default {
43662
43972
  properties: {
43663
43973
  batch: {
43664
43974
  description: 'Represents a resource batch.',
43665
- properties: {
43666
- acs_entrances: {
43667
- items: { $ref: '#/components/schemas/acs_entrance' },
43668
- type: 'array',
43669
- },
43670
- batch_type: { enum: ['spaces'], type: 'string' },
43671
- devices: {
43672
- items: { $ref: '#/components/schemas/device' },
43673
- 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',
43674
43997
  },
43675
- spaces: {
43676
- items: { $ref: '#/components/schemas/space' },
43677
- 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',
43678
44021
  },
43679
- },
43680
- required: ['batch_type'],
43681
- type: 'object',
44022
+ ],
43682
44023
  'x-route-path': '/',
43683
44024
  },
43684
44025
  ok: { type: 'boolean' },