@seamapi/types 1.456.0 → 1.457.1

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 (36) hide show
  1. package/dist/connect.cjs +418 -225
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +15440 -3086
  4. package/dist/devicedb.d.cts +56 -56
  5. package/dist/index.cjs +418 -225
  6. package/dist/index.cjs.map +1 -1
  7. package/lib/seam/connect/models/batches/access_grants.d.ts +48 -49
  8. package/lib/seam/connect/models/batches/access_methods.d.ts +5681 -0
  9. package/lib/seam/connect/models/batches/access_methods.js +11 -0
  10. package/lib/seam/connect/models/batches/access_methods.js.map +1 -0
  11. package/lib/seam/connect/models/batches/batch.d.ts +5774 -98
  12. package/lib/seam/connect/models/batches/batch.js +6 -1
  13. package/lib/seam/connect/models/batches/batch.js.map +1 -1
  14. package/lib/seam/connect/models/batches/index.d.ts +1 -0
  15. package/lib/seam/connect/models/batches/index.js +1 -0
  16. package/lib/seam/connect/models/batches/index.js.map +1 -1
  17. package/lib/seam/connect/models/batches/spaces.d.ts +48 -49
  18. package/lib/seam/connect/models/devices/device-metadata.d.ts +22 -22
  19. package/lib/seam/connect/models/devices/device-provider.d.ts +0 -1
  20. package/lib/seam/connect/models/devices/device.d.ts +49 -51
  21. package/lib/seam/connect/models/devices/device.js +16 -7
  22. package/lib/seam/connect/models/devices/device.js.map +1 -1
  23. package/lib/seam/connect/models/devices/unmanaged-device.d.ts +29 -31
  24. package/lib/seam/connect/openapi.d.ts +285 -0
  25. package/lib/seam/connect/openapi.js +390 -1
  26. package/lib/seam/connect/openapi.js.map +1 -1
  27. package/lib/seam/connect/route-types.d.ts +9300 -2903
  28. package/lib/seam/devicedb/models/device-model.d.ts +20 -20
  29. package/lib/seam/devicedb/route-specs.d.ts +41 -41
  30. package/package.json +1 -1
  31. package/src/lib/seam/connect/models/batches/access_methods.ts +14 -0
  32. package/src/lib/seam/connect/models/batches/batch.ts +6 -1
  33. package/src/lib/seam/connect/models/batches/index.ts +1 -0
  34. package/src/lib/seam/connect/models/devices/device.ts +15 -8
  35. package/src/lib/seam/connect/openapi.ts +394 -1
  36. package/src/lib/seam/connect/route-types.ts +9271 -1024
@@ -25230,6 +25230,30 @@ export default {
25230
25230
  required: ['batch_type'],
25231
25231
  type: 'object',
25232
25232
  },
25233
+ {
25234
+ properties: {
25235
+ acs_entrances: {
25236
+ items: {
25237
+ $ref: '#/components/schemas/acs_entrance',
25238
+ },
25239
+ type: 'array',
25240
+ },
25241
+ batch_type: {
25242
+ enum: ['access_methods'],
25243
+ type: 'string',
25244
+ },
25245
+ devices: {
25246
+ items: { $ref: '#/components/schemas/device' },
25247
+ type: 'array',
25248
+ },
25249
+ spaces: {
25250
+ items: { $ref: '#/components/schemas/space' },
25251
+ type: 'array',
25252
+ },
25253
+ },
25254
+ required: ['batch_type'],
25255
+ type: 'object',
25256
+ },
25233
25257
  ],
25234
25258
  'x-route-path': '/',
25235
25259
  },
@@ -25349,6 +25373,30 @@ export default {
25349
25373
  required: ['batch_type'],
25350
25374
  type: 'object',
25351
25375
  },
25376
+ {
25377
+ properties: {
25378
+ acs_entrances: {
25379
+ items: {
25380
+ $ref: '#/components/schemas/acs_entrance',
25381
+ },
25382
+ type: 'array',
25383
+ },
25384
+ batch_type: {
25385
+ enum: ['access_methods'],
25386
+ type: 'string',
25387
+ },
25388
+ devices: {
25389
+ items: { $ref: '#/components/schemas/device' },
25390
+ type: 'array',
25391
+ },
25392
+ spaces: {
25393
+ items: { $ref: '#/components/schemas/space' },
25394
+ type: 'array',
25395
+ },
25396
+ },
25397
+ required: ['batch_type'],
25398
+ type: 'object',
25399
+ },
25352
25400
  ],
25353
25401
  'x-route-path': '/',
25354
25402
  },
@@ -25959,6 +26007,299 @@ export default {
25959
26007
  'x-title': 'Get an Access Method',
25960
26008
  },
25961
26009
  },
26010
+ '/access_methods/get_related': {
26011
+ get: {
26012
+ description: 'Gets all related resources for one or more Access Methods.',
26013
+ operationId: 'accessMethodsGetRelatedGet',
26014
+ parameters: [
26015
+ {
26016
+ in: 'query',
26017
+ name: 'access_method_ids',
26018
+ required: true,
26019
+ schema: {
26020
+ description: 'IDs of the access methods that you want to get along with their related resources.',
26021
+ items: { format: 'uuid', type: 'string' },
26022
+ type: 'array',
26023
+ },
26024
+ },
26025
+ {
26026
+ in: 'query',
26027
+ name: 'include',
26028
+ required: false,
26029
+ schema: {
26030
+ items: {
26031
+ enum: ['spaces', 'devices', 'acs_entrances'],
26032
+ type: 'string',
26033
+ },
26034
+ type: 'array',
26035
+ },
26036
+ },
26037
+ {
26038
+ in: 'query',
26039
+ name: 'exclude',
26040
+ required: false,
26041
+ schema: {
26042
+ items: {
26043
+ enum: ['spaces', 'devices', 'acs_entrances'],
26044
+ type: 'string',
26045
+ },
26046
+ type: 'array',
26047
+ },
26048
+ },
26049
+ ],
26050
+ responses: {
26051
+ 200: {
26052
+ content: {
26053
+ 'application/json': {
26054
+ schema: {
26055
+ properties: {
26056
+ batch: {
26057
+ description: 'Represents a resource batch.',
26058
+ oneOf: [
26059
+ {
26060
+ description: 'ID of the affected access system user.',
26061
+ properties: {
26062
+ acs_entrances: {
26063
+ items: {
26064
+ $ref: '#/components/schemas/acs_entrance',
26065
+ },
26066
+ type: 'array',
26067
+ },
26068
+ batch_type: { enum: ['spaces'], type: 'string' },
26069
+ devices: {
26070
+ items: { $ref: '#/components/schemas/device' },
26071
+ type: 'array',
26072
+ },
26073
+ spaces: {
26074
+ items: { $ref: '#/components/schemas/space' },
26075
+ type: 'array',
26076
+ },
26077
+ },
26078
+ required: ['batch_type'],
26079
+ type: 'object',
26080
+ },
26081
+ {
26082
+ properties: {
26083
+ acs_entrances: {
26084
+ items: {
26085
+ $ref: '#/components/schemas/acs_entrance',
26086
+ },
26087
+ type: 'array',
26088
+ },
26089
+ batch_type: {
26090
+ enum: ['access_grants'],
26091
+ type: 'string',
26092
+ },
26093
+ devices: {
26094
+ items: { $ref: '#/components/schemas/device' },
26095
+ type: 'array',
26096
+ },
26097
+ spaces: {
26098
+ items: { $ref: '#/components/schemas/space' },
26099
+ type: 'array',
26100
+ },
26101
+ },
26102
+ required: ['batch_type'],
26103
+ type: 'object',
26104
+ },
26105
+ {
26106
+ properties: {
26107
+ acs_entrances: {
26108
+ items: {
26109
+ $ref: '#/components/schemas/acs_entrance',
26110
+ },
26111
+ type: 'array',
26112
+ },
26113
+ batch_type: {
26114
+ enum: ['access_methods'],
26115
+ type: 'string',
26116
+ },
26117
+ devices: {
26118
+ items: { $ref: '#/components/schemas/device' },
26119
+ type: 'array',
26120
+ },
26121
+ spaces: {
26122
+ items: { $ref: '#/components/schemas/space' },
26123
+ type: 'array',
26124
+ },
26125
+ },
26126
+ required: ['batch_type'],
26127
+ type: 'object',
26128
+ },
26129
+ ],
26130
+ 'x-route-path': '/',
26131
+ },
26132
+ ok: { type: 'boolean' },
26133
+ },
26134
+ required: ['batch', 'ok'],
26135
+ type: 'object',
26136
+ },
26137
+ },
26138
+ },
26139
+ description: 'OK',
26140
+ },
26141
+ 400: { description: 'Bad Request' },
26142
+ 401: { description: 'Unauthorized' },
26143
+ },
26144
+ security: [
26145
+ { pat_with_workspace: [] },
26146
+ { console_session_with_workspace: [] },
26147
+ { api_key: [] },
26148
+ ],
26149
+ summary: '/access_methods/get_related',
26150
+ tags: [],
26151
+ 'x-batch-type': 'access_methods',
26152
+ 'x-draft': 'Early access.',
26153
+ 'x-fern-sdk-group-name': ['access_methods'],
26154
+ 'x-fern-sdk-method-name': 'get_related',
26155
+ 'x-fern-sdk-return-value': 'batch',
26156
+ 'x-response-key': 'batch',
26157
+ 'x-title': 'Get related Access Method resources',
26158
+ },
26159
+ post: {
26160
+ description: 'Gets all related resources for one or more Access Methods.',
26161
+ operationId: 'accessMethodsGetRelatedPost',
26162
+ requestBody: {
26163
+ content: {
26164
+ 'application/json': {
26165
+ schema: {
26166
+ properties: {
26167
+ access_method_ids: {
26168
+ description: 'IDs of the access methods that you want to get along with their related resources.',
26169
+ items: { format: 'uuid', type: 'string' },
26170
+ type: 'array',
26171
+ },
26172
+ exclude: {
26173
+ items: {
26174
+ enum: ['spaces', 'devices', 'acs_entrances'],
26175
+ type: 'string',
26176
+ },
26177
+ type: 'array',
26178
+ },
26179
+ include: {
26180
+ items: {
26181
+ enum: ['spaces', 'devices', 'acs_entrances'],
26182
+ type: 'string',
26183
+ },
26184
+ type: 'array',
26185
+ },
26186
+ },
26187
+ required: ['access_method_ids'],
26188
+ type: 'object',
26189
+ },
26190
+ },
26191
+ },
26192
+ },
26193
+ responses: {
26194
+ 200: {
26195
+ content: {
26196
+ 'application/json': {
26197
+ schema: {
26198
+ properties: {
26199
+ batch: {
26200
+ description: 'Represents a resource batch.',
26201
+ oneOf: [
26202
+ {
26203
+ description: 'ID of the affected access system user.',
26204
+ properties: {
26205
+ acs_entrances: {
26206
+ items: {
26207
+ $ref: '#/components/schemas/acs_entrance',
26208
+ },
26209
+ type: 'array',
26210
+ },
26211
+ batch_type: { enum: ['spaces'], type: 'string' },
26212
+ devices: {
26213
+ items: { $ref: '#/components/schemas/device' },
26214
+ type: 'array',
26215
+ },
26216
+ spaces: {
26217
+ items: { $ref: '#/components/schemas/space' },
26218
+ type: 'array',
26219
+ },
26220
+ },
26221
+ required: ['batch_type'],
26222
+ type: 'object',
26223
+ },
26224
+ {
26225
+ properties: {
26226
+ acs_entrances: {
26227
+ items: {
26228
+ $ref: '#/components/schemas/acs_entrance',
26229
+ },
26230
+ type: 'array',
26231
+ },
26232
+ batch_type: {
26233
+ enum: ['access_grants'],
26234
+ type: 'string',
26235
+ },
26236
+ devices: {
26237
+ items: { $ref: '#/components/schemas/device' },
26238
+ type: 'array',
26239
+ },
26240
+ spaces: {
26241
+ items: { $ref: '#/components/schemas/space' },
26242
+ type: 'array',
26243
+ },
26244
+ },
26245
+ required: ['batch_type'],
26246
+ type: 'object',
26247
+ },
26248
+ {
26249
+ properties: {
26250
+ acs_entrances: {
26251
+ items: {
26252
+ $ref: '#/components/schemas/acs_entrance',
26253
+ },
26254
+ type: 'array',
26255
+ },
26256
+ batch_type: {
26257
+ enum: ['access_methods'],
26258
+ type: 'string',
26259
+ },
26260
+ devices: {
26261
+ items: { $ref: '#/components/schemas/device' },
26262
+ type: 'array',
26263
+ },
26264
+ spaces: {
26265
+ items: { $ref: '#/components/schemas/space' },
26266
+ type: 'array',
26267
+ },
26268
+ },
26269
+ required: ['batch_type'],
26270
+ type: 'object',
26271
+ },
26272
+ ],
26273
+ 'x-route-path': '/',
26274
+ },
26275
+ ok: { type: 'boolean' },
26276
+ },
26277
+ required: ['batch', 'ok'],
26278
+ type: 'object',
26279
+ },
26280
+ },
26281
+ },
26282
+ description: 'OK',
26283
+ },
26284
+ 400: { description: 'Bad Request' },
26285
+ 401: { description: 'Unauthorized' },
26286
+ },
26287
+ security: [
26288
+ { pat_with_workspace: [] },
26289
+ { console_session_with_workspace: [] },
26290
+ { api_key: [] },
26291
+ ],
26292
+ summary: '/access_methods/get_related',
26293
+ tags: [],
26294
+ 'x-batch-type': 'access_methods',
26295
+ 'x-draft': 'Early access.',
26296
+ 'x-fern-sdk-group-name': ['access_methods'],
26297
+ 'x-fern-sdk-method-name': 'get_related',
26298
+ 'x-fern-sdk-return-value': 'batch',
26299
+ 'x-response-key': 'batch',
26300
+ 'x-title': 'Get related Access Method resources',
26301
+ },
26302
+ },
25962
26303
  '/access_methods/list': {
25963
26304
  get: {
25964
26305
  description: 'Lists all access methods, usually filtered by Access Grant.',
@@ -36460,7 +36801,7 @@ export default {
36460
36801
  },
36461
36802
  '/devices/simulate/connect_to_hub': {
36462
36803
  post: {
36463
- description: 'Simulates bringing the Wi-Fi hub (bridge) back online for a device. \nOnly applicable for [sandbox workspaces](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces) and August locks today, but designed so we can extend to other providers later. \nThis will clear the `hub_disconnected` error on the device.',
36804
+ description: 'Simulates bringing the WiFi hub (bridge) back online for a device.\nOnly applicable for sandbox workspaces and currently\nimplemented for August and TTLock locks.\nThis will clear the corresponding `hub_disconnected` or\n`ttlock_lock_not_paired_to_gateway` error on the device.',
36464
36805
  operationId: 'devicesSimulateConnectToHubPost',
36465
36806
  requestBody: {
36466
36807
  content: {
@@ -43907,6 +44248,30 @@ export default {
43907
44248
  required: ['batch_type'],
43908
44249
  type: 'object',
43909
44250
  },
44251
+ {
44252
+ properties: {
44253
+ acs_entrances: {
44254
+ items: {
44255
+ $ref: '#/components/schemas/acs_entrance',
44256
+ },
44257
+ type: 'array',
44258
+ },
44259
+ batch_type: {
44260
+ enum: ['access_methods'],
44261
+ type: 'string',
44262
+ },
44263
+ devices: {
44264
+ items: { $ref: '#/components/schemas/device' },
44265
+ type: 'array',
44266
+ },
44267
+ spaces: {
44268
+ items: { $ref: '#/components/schemas/space' },
44269
+ type: 'array',
44270
+ },
44271
+ },
44272
+ required: ['batch_type'],
44273
+ type: 'object',
44274
+ },
43910
44275
  ],
43911
44276
  'x-route-path': '/',
43912
44277
  },
@@ -44026,6 +44391,30 @@ export default {
44026
44391
  required: ['batch_type'],
44027
44392
  type: 'object',
44028
44393
  },
44394
+ {
44395
+ properties: {
44396
+ acs_entrances: {
44397
+ items: {
44398
+ $ref: '#/components/schemas/acs_entrance',
44399
+ },
44400
+ type: 'array',
44401
+ },
44402
+ batch_type: {
44403
+ enum: ['access_methods'],
44404
+ type: 'string',
44405
+ },
44406
+ devices: {
44407
+ items: { $ref: '#/components/schemas/device' },
44408
+ type: 'array',
44409
+ },
44410
+ spaces: {
44411
+ items: { $ref: '#/components/schemas/space' },
44412
+ type: 'array',
44413
+ },
44414
+ },
44415
+ required: ['batch_type'],
44416
+ type: 'object',
44417
+ },
44029
44418
  ],
44030
44419
  'x-route-path': '/',
44031
44420
  },