@seamapi/types 1.461.0 → 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.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.461.0",
3
+ "version": "1.462.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -1,9 +1,17 @@
1
1
  import { z } from 'zod'
2
2
 
3
- import { acs_system } from './acs/acs-system.js'
4
- import { acs_entrance } from './acs/index.js'
3
+ import {
4
+ acs_access_group,
5
+ unmanaged_acs_access_group,
6
+ } from './acs/acs-access-group.js'
7
+ import { acs_encoder } from './acs/acs-encoder.js'
8
+ import { acs_user, unmanaged_acs_user } from './acs/acs-users/acs-user.js'
9
+ import { acs_entrance, acs_system } from './acs/index.js'
10
+ import { action_attempt } from './action-attempts/action-attempt.js'
11
+ import { client_session } from './client-sessions/client-session.js'
5
12
  import { connected_account } from './connected-accounts/index.js'
6
13
  import { device } from './devices/index.js'
14
+ import { unmanaged_device } from './devices/unmanaged-device.js'
7
15
  import { space } from './spaces/index.js'
8
16
  import { user_identity } from './user-identities/index.js'
9
17
  import { workspace } from './workspaces/index.js'
@@ -44,27 +52,42 @@ export const workspaces_batch = z
44
52
  spaces: space.array().optional(),
45
53
  devices: device.array().optional(),
46
54
  acs_entrances: acs_entrance.array().optional(),
55
+ acs_systems: acs_system.array().optional(),
56
+ acs_users: acs_user.array().optional(),
57
+ acs_access_groups: acs_access_group.array().optional(),
58
+ acs_encoders: acs_encoder.array().optional(),
59
+ action_attempts: action_attempt.array().optional(),
60
+ client_sessions: client_session.array().optional(),
61
+ unmanaged_acs_users: unmanaged_acs_user.array().optional(),
62
+ unmanaged_acs_access_groups: unmanaged_acs_access_group.array().optional(),
63
+ unmanaged_devices: unmanaged_device.array().optional(),
47
64
  })
48
- .describe('A batch of workspace-related resources.')
65
+ .describe('A batch of workspace resources.')
49
66
 
50
- export const batch = z.object({
51
- batch_type: z.enum([
52
- 'workspaces',
53
- 'access_grants',
54
- 'access_methods',
55
- 'spaces',
56
- ]),
57
- user_identities: user_identity.array().optional(),
58
- workspaces: workspace.array().optional(),
59
- spaces: space.array().optional(),
60
- devices: device.array().optional(),
61
- acs_entrances: acs_entrance.array().optional(),
62
- }).describe(`
63
- ---
64
- route_path: /
65
- ---
66
- Represents a resource batch.
67
- `)
67
+ export const batch = z
68
+ .object({
69
+ batch_type: z.enum([
70
+ 'workspaces',
71
+ 'spaces',
72
+ 'access_grants',
73
+ 'access_methods',
74
+ ]),
75
+ user_identities: user_identity.array().optional(),
76
+ workspaces: workspace.array().optional(),
77
+ spaces: space.array().optional(),
78
+ devices: device.array().optional(),
79
+ acs_entrances: acs_entrance.array().optional(),
80
+ acs_systems: acs_system.array().optional(),
81
+ acs_users: acs_user.array().optional(),
82
+ acs_access_groups: acs_access_group.array().optional(),
83
+ acs_encoders: acs_encoder.array().optional(),
84
+ action_attempts: action_attempt.array().optional(),
85
+ client_sessions: client_session.array().optional(),
86
+ unmanaged_acs_users: unmanaged_acs_user.array().optional(),
87
+ unmanaged_acs_access_groups: unmanaged_acs_access_group.array().optional(),
88
+ unmanaged_devices: unmanaged_device.array().optional(),
89
+ })
90
+ .describe('A batch of workspace resources.')
68
91
 
69
92
  // TODO: Resolve type issues blocking this approach.
70
93
  // export const batch = z.discriminatedUnion("batch_type", [
@@ -91,6 +91,7 @@ export const PROVIDER_CATEGORY_MAP = {
91
91
  'akiles',
92
92
  'sensi',
93
93
  'assa_abloy_vostio',
94
+ 'avigilon_alta',
94
95
  ],
95
96
 
96
97
  consumer_smartlocks: [
@@ -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
  },
@@ -29195,21 +29202,51 @@ export default {
29195
29202
  schema: {
29196
29203
  properties: {
29197
29204
  batch: {
29198
- description: 'Represents a resource batch.',
29205
+ description: 'A batch of workspace resources.',
29199
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
+ },
29200
29217
  acs_entrances: {
29201
29218
  items: { $ref: '#/components/schemas/acs_entrance' },
29202
29219
  type: 'array',
29203
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
+ },
29204
29235
  batch_type: {
29205
29236
  enum: [
29206
29237
  'workspaces',
29238
+ 'spaces',
29207
29239
  'access_grants',
29208
29240
  'access_methods',
29209
- 'spaces',
29210
29241
  ],
29211
29242
  type: 'string',
29212
29243
  },
29244
+ client_sessions: {
29245
+ items: {
29246
+ $ref: '#/components/schemas/client_session',
29247
+ },
29248
+ type: 'array',
29249
+ },
29213
29250
  devices: {
29214
29251
  items: { $ref: '#/components/schemas/device' },
29215
29252
  type: 'array',
@@ -29218,6 +29255,24 @@ export default {
29218
29255
  items: { $ref: '#/components/schemas/space' },
29219
29256
  type: 'array',
29220
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
+ },
29221
29276
  user_identities: {
29222
29277
  items: { $ref: '#/components/schemas/user_identity' },
29223
29278
  type: 'array',
@@ -29229,7 +29284,6 @@ export default {
29229
29284
  },
29230
29285
  required: ['batch_type'],
29231
29286
  type: 'object',
29232
- 'x-route-path': '/',
29233
29287
  },
29234
29288
  ok: { type: 'boolean' },
29235
29289
  },
@@ -29301,21 +29355,51 @@ export default {
29301
29355
  schema: {
29302
29356
  properties: {
29303
29357
  batch: {
29304
- description: 'Represents a resource batch.',
29358
+ description: 'A batch of workspace resources.',
29305
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
+ },
29306
29370
  acs_entrances: {
29307
29371
  items: { $ref: '#/components/schemas/acs_entrance' },
29308
29372
  type: 'array',
29309
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
+ },
29310
29388
  batch_type: {
29311
29389
  enum: [
29312
29390
  'workspaces',
29391
+ 'spaces',
29313
29392
  'access_grants',
29314
29393
  'access_methods',
29315
- 'spaces',
29316
29394
  ],
29317
29395
  type: 'string',
29318
29396
  },
29397
+ client_sessions: {
29398
+ items: {
29399
+ $ref: '#/components/schemas/client_session',
29400
+ },
29401
+ type: 'array',
29402
+ },
29319
29403
  devices: {
29320
29404
  items: { $ref: '#/components/schemas/device' },
29321
29405
  type: 'array',
@@ -29324,6 +29408,24 @@ export default {
29324
29408
  items: { $ref: '#/components/schemas/space' },
29325
29409
  type: 'array',
29326
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
+ },
29327
29429
  user_identities: {
29328
29430
  items: { $ref: '#/components/schemas/user_identity' },
29329
29431
  type: 'array',
@@ -29335,7 +29437,6 @@ export default {
29335
29437
  },
29336
29438
  required: ['batch_type'],
29337
29439
  type: 'object',
29338
- 'x-route-path': '/',
29339
29440
  },
29340
29441
  ok: { type: 'boolean' },
29341
29442
  },
@@ -42812,6 +42913,109 @@ export default {
42812
42913
  'x-title': 'List Events',
42813
42914
  },
42814
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
+ },
42815
43019
  '/instant_keys/list': {
42816
43020
  get: {
42817
43021
  description:
@@ -56928,21 +57132,51 @@ export default {
56928
57132
  schema: {
56929
57133
  properties: {
56930
57134
  batch: {
56931
- description: 'Represents a resource batch.',
57135
+ description: 'A batch of workspace resources.',
56932
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
+ },
56933
57147
  acs_entrances: {
56934
57148
  items: { $ref: '#/components/schemas/acs_entrance' },
56935
57149
  type: 'array',
56936
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
+ },
56937
57165
  batch_type: {
56938
57166
  enum: [
56939
57167
  'workspaces',
57168
+ 'spaces',
56940
57169
  'access_grants',
56941
57170
  'access_methods',
56942
- 'spaces',
56943
57171
  ],
56944
57172
  type: 'string',
56945
57173
  },
57174
+ client_sessions: {
57175
+ items: {
57176
+ $ref: '#/components/schemas/client_session',
57177
+ },
57178
+ type: 'array',
57179
+ },
56946
57180
  devices: {
56947
57181
  items: { $ref: '#/components/schemas/device' },
56948
57182
  type: 'array',
@@ -56951,6 +57185,24 @@ export default {
56951
57185
  items: { $ref: '#/components/schemas/space' },
56952
57186
  type: 'array',
56953
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
+ },
56954
57206
  user_identities: {
56955
57207
  items: { $ref: '#/components/schemas/user_identity' },
56956
57208
  type: 'array',
@@ -56962,7 +57214,6 @@ export default {
56962
57214
  },
56963
57215
  required: ['batch_type'],
56964
57216
  type: 'object',
56965
- 'x-route-path': '/',
56966
57217
  },
56967
57218
  ok: { type: 'boolean' },
56968
57219
  },
@@ -57009,21 +57260,51 @@ export default {
57009
57260
  schema: {
57010
57261
  properties: {
57011
57262
  batch: {
57012
- description: 'Represents a resource batch.',
57263
+ description: 'A batch of workspace resources.',
57013
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
+ },
57014
57275
  acs_entrances: {
57015
57276
  items: { $ref: '#/components/schemas/acs_entrance' },
57016
57277
  type: 'array',
57017
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
+ },
57018
57293
  batch_type: {
57019
57294
  enum: [
57020
57295
  'workspaces',
57296
+ 'spaces',
57021
57297
  'access_grants',
57022
57298
  'access_methods',
57023
- 'spaces',
57024
57299
  ],
57025
57300
  type: 'string',
57026
57301
  },
57302
+ client_sessions: {
57303
+ items: {
57304
+ $ref: '#/components/schemas/client_session',
57305
+ },
57306
+ type: 'array',
57307
+ },
57027
57308
  devices: {
57028
57309
  items: { $ref: '#/components/schemas/device' },
57029
57310
  type: 'array',
@@ -57032,6 +57313,24 @@ export default {
57032
57313
  items: { $ref: '#/components/schemas/space' },
57033
57314
  type: 'array',
57034
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
+ },
57035
57334
  user_identities: {
57036
57335
  items: { $ref: '#/components/schemas/user_identity' },
57037
57336
  type: 'array',
@@ -57043,7 +57342,6 @@ export default {
57043
57342
  },
57044
57343
  required: ['batch_type'],
57045
57344
  type: 'object',
57046
- 'x-route-path': '/',
57047
57345
  },
57048
57346
  ok: { type: 'boolean' },
57049
57347
  },