@seamapi/types 1.460.1 → 1.462.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 (22) hide show
  1. package/dist/connect.cjs +505 -86
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +18022 -1242
  4. package/dist/index.cjs +505 -86
  5. package/dist/index.cjs.map +1 -1
  6. package/lib/seam/connect/models/batch.d.ts +26164 -2844
  7. package/lib/seam/connect/models/batch.js +31 -11
  8. package/lib/seam/connect/models/batch.js.map +1 -1
  9. package/lib/seam/connect/models/client-sessions/client-session.d.ts +2 -2
  10. package/lib/seam/connect/models/devices/device-provider.d.ts +1 -1
  11. package/lib/seam/connect/models/devices/device-provider.js +1 -0
  12. package/lib/seam/connect/models/devices/device-provider.js.map +1 -1
  13. package/lib/seam/connect/models/spaces/space.d.ts +2 -2
  14. package/lib/seam/connect/openapi.d.ts +495 -4
  15. package/lib/seam/connect/openapi.js +417 -12
  16. package/lib/seam/connect/openapi.js.map +1 -1
  17. package/lib/seam/connect/route-types.d.ts +15025 -10396
  18. package/package.json +1 -1
  19. package/src/lib/seam/connect/models/batch.ts +44 -21
  20. package/src/lib/seam/connect/models/devices/device-provider.ts +1 -0
  21. package/src/lib/seam/connect/openapi.ts +425 -12
  22. package/src/lib/seam/connect/route-types.ts +6727 -1192
package/src/lib/seam/connect/openapi.ts CHANGED
@@ -27960,6 +27960,13 @@ export default {
27960
27960
  nullable: true,
27961
27961
  type: 'string',
27962
27962
  },
27963
+ user_identity_key: {
27964
+ description:
27965
+ 'Unique key for the user identity.',
27966
+ minLength: 1,
27967
+ nullable: true,
27968
+ type: 'string',
27969
+ },
27963
27970
  },
27964
27971
  type: 'object',
27965
27972
  },
@@ -28054,6 +28061,12 @@ export default {
28054
28061
  items: { format: 'uuid', type: 'string' },
28055
28062
  type: 'array',
28056
28063
  },
28064
+ space_keys: {
28065
+ description:
28066
+ 'Set of keys of existing spaces to which access is being granted.',
28067
+ items: { type: 'string' },
28068
+ type: 'array',
28069
+ },
28057
28070
  starts_at: {
28058
28071
  description:
28059
28072
  'Date and time at which the validity of the new grant starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
@@ -29189,21 +29202,51 @@ export default {
29189
29202
  schema: {
29190
29203
  properties: {
29191
29204
  batch: {
29192
- description: 'Represents a resource batch.',
29205
+ description: 'A batch of workspace resources.',
29193
29206
  properties: {
29207
+ acs_access_groups: {
29208
+ items: {
29209
+ $ref: '#/components/schemas/acs_access_group',
29210
+ },
29211
+ type: 'array',
29212
+ },
29213
+ acs_encoders: {
29214
+ items: { $ref: '#/components/schemas/acs_encoder' },
29215
+ type: 'array',
29216
+ },
29194
29217
  acs_entrances: {
29195
29218
  items: { $ref: '#/components/schemas/acs_entrance' },
29196
29219
  type: 'array',
29197
29220
  },
29221
+ acs_systems: {
29222
+ items: { $ref: '#/components/schemas/acs_system' },
29223
+ type: 'array',
29224
+ },
29225
+ acs_users: {
29226
+ items: { $ref: '#/components/schemas/acs_user' },
29227
+ type: 'array',
29228
+ },
29229
+ action_attempts: {
29230
+ items: {
29231
+ $ref: '#/components/schemas/action_attempt',
29232
+ },
29233
+ type: 'array',
29234
+ },
29198
29235
  batch_type: {
29199
29236
  enum: [
29200
29237
  'workspaces',
29238
+ 'spaces',
29201
29239
  'access_grants',
29202
29240
  'access_methods',
29203
- 'spaces',
29204
29241
  ],
29205
29242
  type: 'string',
29206
29243
  },
29244
+ client_sessions: {
29245
+ items: {
29246
+ $ref: '#/components/schemas/client_session',
29247
+ },
29248
+ type: 'array',
29249
+ },
29207
29250
  devices: {
29208
29251
  items: { $ref: '#/components/schemas/device' },
29209
29252
  type: 'array',
@@ -29212,6 +29255,24 @@ export default {
29212
29255
  items: { $ref: '#/components/schemas/space' },
29213
29256
  type: 'array',
29214
29257
  },
29258
+ unmanaged_acs_access_groups: {
29259
+ items: {
29260
+ $ref: '#/components/schemas/unmanaged_acs_access_group',
29261
+ },
29262
+ type: 'array',
29263
+ },
29264
+ unmanaged_acs_users: {
29265
+ items: {
29266
+ $ref: '#/components/schemas/unmanaged_acs_user',
29267
+ },
29268
+ type: 'array',
29269
+ },
29270
+ unmanaged_devices: {
29271
+ items: {
29272
+ $ref: '#/components/schemas/unmanaged_device',
29273
+ },
29274
+ type: 'array',
29275
+ },
29215
29276
  user_identities: {
29216
29277
  items: { $ref: '#/components/schemas/user_identity' },
29217
29278
  type: 'array',
@@ -29223,7 +29284,6 @@ export default {
29223
29284
  },
29224
29285
  required: ['batch_type'],
29225
29286
  type: 'object',
29226
- 'x-route-path': '/',
29227
29287
  },
29228
29288
  ok: { type: 'boolean' },
29229
29289
  },
@@ -29295,21 +29355,51 @@ export default {
29295
29355
  schema: {
29296
29356
  properties: {
29297
29357
  batch: {
29298
- description: 'Represents a resource batch.',
29358
+ description: 'A batch of workspace resources.',
29299
29359
  properties: {
29360
+ acs_access_groups: {
29361
+ items: {
29362
+ $ref: '#/components/schemas/acs_access_group',
29363
+ },
29364
+ type: 'array',
29365
+ },
29366
+ acs_encoders: {
29367
+ items: { $ref: '#/components/schemas/acs_encoder' },
29368
+ type: 'array',
29369
+ },
29300
29370
  acs_entrances: {
29301
29371
  items: { $ref: '#/components/schemas/acs_entrance' },
29302
29372
  type: 'array',
29303
29373
  },
29374
+ acs_systems: {
29375
+ items: { $ref: '#/components/schemas/acs_system' },
29376
+ type: 'array',
29377
+ },
29378
+ acs_users: {
29379
+ items: { $ref: '#/components/schemas/acs_user' },
29380
+ type: 'array',
29381
+ },
29382
+ action_attempts: {
29383
+ items: {
29384
+ $ref: '#/components/schemas/action_attempt',
29385
+ },
29386
+ type: 'array',
29387
+ },
29304
29388
  batch_type: {
29305
29389
  enum: [
29306
29390
  'workspaces',
29391
+ 'spaces',
29307
29392
  'access_grants',
29308
29393
  'access_methods',
29309
- 'spaces',
29310
29394
  ],
29311
29395
  type: 'string',
29312
29396
  },
29397
+ client_sessions: {
29398
+ items: {
29399
+ $ref: '#/components/schemas/client_session',
29400
+ },
29401
+ type: 'array',
29402
+ },
29313
29403
  devices: {
29314
29404
  items: { $ref: '#/components/schemas/device' },
29315
29405
  type: 'array',
@@ -29318,6 +29408,24 @@ export default {
29318
29408
  items: { $ref: '#/components/schemas/space' },
29319
29409
  type: 'array',
29320
29410
  },
29411
+ unmanaged_acs_access_groups: {
29412
+ items: {
29413
+ $ref: '#/components/schemas/unmanaged_acs_access_group',
29414
+ },
29415
+ type: 'array',
29416
+ },
29417
+ unmanaged_acs_users: {
29418
+ items: {
29419
+ $ref: '#/components/schemas/unmanaged_acs_user',
29420
+ },
29421
+ type: 'array',
29422
+ },
29423
+ unmanaged_devices: {
29424
+ items: {
29425
+ $ref: '#/components/schemas/unmanaged_device',
29426
+ },
29427
+ type: 'array',
29428
+ },
29321
29429
  user_identities: {
29322
29430
  items: { $ref: '#/components/schemas/user_identity' },
29323
29431
  type: 'array',
@@ -29329,7 +29437,6 @@ export default {
29329
29437
  },
29330
29438
  required: ['batch_type'],
29331
29439
  type: 'object',
29332
- 'x-route-path': '/',
29333
29440
  },
29334
29441
  ok: { type: 'boolean' },
29335
29442
  },
@@ -42806,6 +42913,218 @@ export default {
42806
42913
  'x-title': 'List Events',
42807
42914
  },
42808
42915
  },
42916
+ '/instant_keys/get': {
42917
+ get: {
42918
+ description:
42919
+ 'Gets an [instant key](https://docs.seam.co/latest/capability-guides/mobile-access/instant-keys).',
42920
+ operationId: 'instantKeysGetGet',
42921
+ parameters: [
42922
+ {
42923
+ in: 'query',
42924
+ name: 'instant_key_id',
42925
+ required: true,
42926
+ schema: {
42927
+ description: 'ID of the instant key to get.',
42928
+ format: 'uuid',
42929
+ type: 'string',
42930
+ },
42931
+ },
42932
+ ],
42933
+ responses: {
42934
+ 200: {
42935
+ content: {
42936
+ 'application/json': {
42937
+ schema: {
42938
+ properties: {
42939
+ instant_key: { $ref: '#/components/schemas/instant_key' },
42940
+ ok: { type: 'boolean' },
42941
+ },
42942
+ required: ['instant_key', 'ok'],
42943
+ type: 'object',
42944
+ },
42945
+ },
42946
+ },
42947
+ description: 'OK',
42948
+ },
42949
+ 400: { description: 'Bad Request' },
42950
+ 401: { description: 'Unauthorized' },
42951
+ },
42952
+ security: [
42953
+ { api_key: [] },
42954
+ { pat_with_workspace: [] },
42955
+ { console_session_with_workspace: [] },
42956
+ ],
42957
+ summary: '/instant_keys/get',
42958
+ tags: [],
42959
+ 'x-fern-sdk-group-name': ['instant_keys'],
42960
+ 'x-fern-sdk-method-name': 'get',
42961
+ 'x-fern-sdk-return-value': 'instant_key',
42962
+ 'x-response-key': 'instant_key',
42963
+ 'x-title': 'Get an Instant Key',
42964
+ },
42965
+ post: {
42966
+ description:
42967
+ 'Gets an [instant key](https://docs.seam.co/latest/capability-guides/mobile-access/instant-keys).',
42968
+ operationId: 'instantKeysGetPost',
42969
+ requestBody: {
42970
+ content: {
42971
+ 'application/json': {
42972
+ schema: {
42973
+ properties: {
42974
+ instant_key_id: {
42975
+ description: 'ID of the instant key to get.',
42976
+ format: 'uuid',
42977
+ type: 'string',
42978
+ },
42979
+ },
42980
+ required: ['instant_key_id'],
42981
+ type: 'object',
42982
+ },
42983
+ },
42984
+ },
42985
+ },
42986
+ responses: {
42987
+ 200: {
42988
+ content: {
42989
+ 'application/json': {
42990
+ schema: {
42991
+ properties: {
42992
+ instant_key: { $ref: '#/components/schemas/instant_key' },
42993
+ ok: { type: 'boolean' },
42994
+ },
42995
+ required: ['instant_key', 'ok'],
42996
+ type: 'object',
42997
+ },
42998
+ },
42999
+ },
43000
+ description: 'OK',
43001
+ },
43002
+ 400: { description: 'Bad Request' },
43003
+ 401: { description: 'Unauthorized' },
43004
+ },
43005
+ security: [
43006
+ { api_key: [] },
43007
+ { pat_with_workspace: [] },
43008
+ { console_session_with_workspace: [] },
43009
+ ],
43010
+ summary: '/instant_keys/get',
43011
+ tags: [],
43012
+ 'x-fern-sdk-group-name': ['instant_keys'],
43013
+ 'x-fern-sdk-method-name': 'get',
43014
+ 'x-fern-sdk-return-value': 'instant_key',
43015
+ 'x-response-key': 'instant_key',
43016
+ 'x-title': 'Get an Instant Key',
43017
+ },
43018
+ },
43019
+ '/instant_keys/list': {
43020
+ get: {
43021
+ description:
43022
+ 'Returns a list of all [instant keys](https://docs.seam.co/latest/capability-guides/mobile-access/instant-keys).',
43023
+ operationId: 'instantKeysListGet',
43024
+ parameters: [
43025
+ {
43026
+ in: 'query',
43027
+ name: 'user_identity_id',
43028
+ schema: {
43029
+ description:
43030
+ 'ID of the user identity by which you want to filter the list of Instant Keys.',
43031
+ format: 'uuid',
43032
+ type: 'string',
43033
+ },
43034
+ },
43035
+ ],
43036
+ responses: {
43037
+ 200: {
43038
+ content: {
43039
+ 'application/json': {
43040
+ schema: {
43041
+ properties: {
43042
+ instant_keys: {
43043
+ items: { $ref: '#/components/schemas/instant_key' },
43044
+ type: 'array',
43045
+ },
43046
+ ok: { type: 'boolean' },
43047
+ },
43048
+ required: ['instant_keys', 'ok'],
43049
+ type: 'object',
43050
+ },
43051
+ },
43052
+ },
43053
+ description: 'OK',
43054
+ },
43055
+ 400: { description: 'Bad Request' },
43056
+ 401: { description: 'Unauthorized' },
43057
+ },
43058
+ security: [
43059
+ { api_key: [] },
43060
+ { pat_with_workspace: [] },
43061
+ { console_session_with_workspace: [] },
43062
+ ],
43063
+ summary: '/instant_keys/list',
43064
+ tags: [],
43065
+ 'x-fern-sdk-group-name': ['instant_keys'],
43066
+ 'x-fern-sdk-method-name': 'list',
43067
+ 'x-fern-sdk-return-value': 'instant_keys',
43068
+ 'x-response-key': 'instant_keys',
43069
+ 'x-title': 'List Instant Keys',
43070
+ },
43071
+ post: {
43072
+ description:
43073
+ 'Returns a list of all [instant keys](https://docs.seam.co/latest/capability-guides/mobile-access/instant-keys).',
43074
+ operationId: 'instantKeysListPost',
43075
+ requestBody: {
43076
+ content: {
43077
+ 'application/json': {
43078
+ schema: {
43079
+ properties: {
43080
+ user_identity_id: {
43081
+ description:
43082
+ 'ID of the user identity by which you want to filter the list of Instant Keys.',
43083
+ format: 'uuid',
43084
+ type: 'string',
43085
+ },
43086
+ },
43087
+ type: 'object',
43088
+ },
43089
+ },
43090
+ },
43091
+ },
43092
+ responses: {
43093
+ 200: {
43094
+ content: {
43095
+ 'application/json': {
43096
+ schema: {
43097
+ properties: {
43098
+ instant_keys: {
43099
+ items: { $ref: '#/components/schemas/instant_key' },
43100
+ type: 'array',
43101
+ },
43102
+ ok: { type: 'boolean' },
43103
+ },
43104
+ required: ['instant_keys', 'ok'],
43105
+ type: 'object',
43106
+ },
43107
+ },
43108
+ },
43109
+ description: 'OK',
43110
+ },
43111
+ 400: { description: 'Bad Request' },
43112
+ 401: { description: 'Unauthorized' },
43113
+ },
43114
+ security: [
43115
+ { api_key: [] },
43116
+ { pat_with_workspace: [] },
43117
+ { console_session_with_workspace: [] },
43118
+ ],
43119
+ summary: '/instant_keys/list',
43120
+ tags: [],
43121
+ 'x-fern-sdk-group-name': ['instant_keys'],
43122
+ 'x-fern-sdk-method-name': 'list',
43123
+ 'x-fern-sdk-return-value': 'instant_keys',
43124
+ 'x-response-key': 'instant_keys',
43125
+ 'x-title': 'List Instant Keys',
43126
+ },
43127
+ },
42809
43128
  '/locks/get': {
42810
43129
  get: {
42811
43130
  description:
@@ -56813,21 +57132,51 @@ export default {
56813
57132
  schema: {
56814
57133
  properties: {
56815
57134
  batch: {
56816
- description: 'Represents a resource batch.',
57135
+ description: 'A batch of workspace resources.',
56817
57136
  properties: {
57137
+ acs_access_groups: {
57138
+ items: {
57139
+ $ref: '#/components/schemas/acs_access_group',
57140
+ },
57141
+ type: 'array',
57142
+ },
57143
+ acs_encoders: {
57144
+ items: { $ref: '#/components/schemas/acs_encoder' },
57145
+ type: 'array',
57146
+ },
56818
57147
  acs_entrances: {
56819
57148
  items: { $ref: '#/components/schemas/acs_entrance' },
56820
57149
  type: 'array',
56821
57150
  },
57151
+ acs_systems: {
57152
+ items: { $ref: '#/components/schemas/acs_system' },
57153
+ type: 'array',
57154
+ },
57155
+ acs_users: {
57156
+ items: { $ref: '#/components/schemas/acs_user' },
57157
+ type: 'array',
57158
+ },
57159
+ action_attempts: {
57160
+ items: {
57161
+ $ref: '#/components/schemas/action_attempt',
57162
+ },
57163
+ type: 'array',
57164
+ },
56822
57165
  batch_type: {
56823
57166
  enum: [
56824
57167
  'workspaces',
57168
+ 'spaces',
56825
57169
  'access_grants',
56826
57170
  'access_methods',
56827
- 'spaces',
56828
57171
  ],
56829
57172
  type: 'string',
56830
57173
  },
57174
+ client_sessions: {
57175
+ items: {
57176
+ $ref: '#/components/schemas/client_session',
57177
+ },
57178
+ type: 'array',
57179
+ },
56831
57180
  devices: {
56832
57181
  items: { $ref: '#/components/schemas/device' },
56833
57182
  type: 'array',
@@ -56836,6 +57185,24 @@ export default {
56836
57185
  items: { $ref: '#/components/schemas/space' },
56837
57186
  type: 'array',
56838
57187
  },
57188
+ unmanaged_acs_access_groups: {
57189
+ items: {
57190
+ $ref: '#/components/schemas/unmanaged_acs_access_group',
57191
+ },
57192
+ type: 'array',
57193
+ },
57194
+ unmanaged_acs_users: {
57195
+ items: {
57196
+ $ref: '#/components/schemas/unmanaged_acs_user',
57197
+ },
57198
+ type: 'array',
57199
+ },
57200
+ unmanaged_devices: {
57201
+ items: {
57202
+ $ref: '#/components/schemas/unmanaged_device',
57203
+ },
57204
+ type: 'array',
57205
+ },
56839
57206
  user_identities: {
56840
57207
  items: { $ref: '#/components/schemas/user_identity' },
56841
57208
  type: 'array',
@@ -56847,7 +57214,6 @@ export default {
56847
57214
  },
56848
57215
  required: ['batch_type'],
56849
57216
  type: 'object',
56850
- 'x-route-path': '/',
56851
57217
  },
56852
57218
  ok: { type: 'boolean' },
56853
57219
  },
@@ -56894,21 +57260,51 @@ export default {
56894
57260
  schema: {
56895
57261
  properties: {
56896
57262
  batch: {
56897
- description: 'Represents a resource batch.',
57263
+ description: 'A batch of workspace resources.',
56898
57264
  properties: {
57265
+ acs_access_groups: {
57266
+ items: {
57267
+ $ref: '#/components/schemas/acs_access_group',
57268
+ },
57269
+ type: 'array',
57270
+ },
57271
+ acs_encoders: {
57272
+ items: { $ref: '#/components/schemas/acs_encoder' },
57273
+ type: 'array',
57274
+ },
56899
57275
  acs_entrances: {
56900
57276
  items: { $ref: '#/components/schemas/acs_entrance' },
56901
57277
  type: 'array',
56902
57278
  },
57279
+ acs_systems: {
57280
+ items: { $ref: '#/components/schemas/acs_system' },
57281
+ type: 'array',
57282
+ },
57283
+ acs_users: {
57284
+ items: { $ref: '#/components/schemas/acs_user' },
57285
+ type: 'array',
57286
+ },
57287
+ action_attempts: {
57288
+ items: {
57289
+ $ref: '#/components/schemas/action_attempt',
57290
+ },
57291
+ type: 'array',
57292
+ },
56903
57293
  batch_type: {
56904
57294
  enum: [
56905
57295
  'workspaces',
57296
+ 'spaces',
56906
57297
  'access_grants',
56907
57298
  'access_methods',
56908
- 'spaces',
56909
57299
  ],
56910
57300
  type: 'string',
56911
57301
  },
57302
+ client_sessions: {
57303
+ items: {
57304
+ $ref: '#/components/schemas/client_session',
57305
+ },
57306
+ type: 'array',
57307
+ },
56912
57308
  devices: {
56913
57309
  items: { $ref: '#/components/schemas/device' },
56914
57310
  type: 'array',
@@ -56917,6 +57313,24 @@ export default {
56917
57313
  items: { $ref: '#/components/schemas/space' },
56918
57314
  type: 'array',
56919
57315
  },
57316
+ unmanaged_acs_access_groups: {
57317
+ items: {
57318
+ $ref: '#/components/schemas/unmanaged_acs_access_group',
57319
+ },
57320
+ type: 'array',
57321
+ },
57322
+ unmanaged_acs_users: {
57323
+ items: {
57324
+ $ref: '#/components/schemas/unmanaged_acs_user',
57325
+ },
57326
+ type: 'array',
57327
+ },
57328
+ unmanaged_devices: {
57329
+ items: {
57330
+ $ref: '#/components/schemas/unmanaged_device',
57331
+ },
57332
+ type: 'array',
57333
+ },
56920
57334
  user_identities: {
56921
57335
  items: { $ref: '#/components/schemas/user_identity' },
56922
57336
  type: 'array',
@@ -56928,7 +57342,6 @@ export default {
56928
57342
  },
56929
57343
  required: ['batch_type'],
56930
57344
  type: 'object',
56931
- 'x-route-path': '/',
56932
57345
  },
56933
57346
  ok: { type: 'boolean' },
56934
57347
  },