@seamapi/types 1.1155.0 → 1.1157.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/lib/seam/connect/models/events/devices.js +2 -2
- package/lib/seam/connect/openapi.js +231 -2
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +60 -0
- package/package.json +1 -1
- package/src/lib/seam/connect/models/events/devices.ts +2 -2
- package/src/lib/seam/connect/openapi.ts +246 -2
- package/src/lib/seam/connect/route-types.ts +90 -0
|
@@ -642,7 +642,7 @@ export const camera_activated_event = device_event.extend({
|
|
|
642
642
|
---
|
|
643
643
|
route_path: /devices
|
|
644
644
|
---
|
|
645
|
-
A camera was activated, for example, by motion detection.
|
|
645
|
+
A camera was activated, for example, by motion detection. For Ring cameras, this event is available only in the Seam Console, not through the API or webhooks.
|
|
646
646
|
`);
|
|
647
647
|
export const device_doorbell_rang_event = device_event.extend({
|
|
648
648
|
event_type: z.literal('device.doorbell_rang'),
|
|
@@ -664,7 +664,7 @@ export const device_doorbell_rang_event = device_event.extend({
|
|
|
664
664
|
---
|
|
665
665
|
route_path: /devices
|
|
666
666
|
---
|
|
667
|
-
A doorbell button was pressed on a device.
|
|
667
|
+
A doorbell button was pressed on a device. For Ring cameras, this event is available only in the Seam Console, not through the API or webhooks.
|
|
668
668
|
`);
|
|
669
669
|
export const device_events = [
|
|
670
670
|
device_connected_event,
|
|
@@ -28227,7 +28227,7 @@ const openapi = {
|
|
|
28227
28227
|
'x-route-path': '/devices',
|
|
28228
28228
|
},
|
|
28229
28229
|
{
|
|
28230
|
-
description: 'A camera was activated, for example, by motion detection.',
|
|
28230
|
+
description: 'A camera was activated, for example, by motion detection. For Ring cameras, this event is available only in the Seam Console, not through the API or webhooks.',
|
|
28231
28231
|
properties: {
|
|
28232
28232
|
activation_reason: {
|
|
28233
28233
|
description: 'The reason the camera was activated.',
|
|
@@ -28322,7 +28322,7 @@ const openapi = {
|
|
|
28322
28322
|
'x-route-path': '/devices',
|
|
28323
28323
|
},
|
|
28324
28324
|
{
|
|
28325
|
-
description: 'A doorbell button was pressed on a device.',
|
|
28325
|
+
description: 'A doorbell button was pressed on a device. For Ring cameras, this event is available only in the Seam Console, not through the API or webhooks.',
|
|
28326
28326
|
properties: {
|
|
28327
28327
|
connected_account_custom_metadata: {
|
|
28328
28328
|
additionalProperties: {
|
|
@@ -58286,6 +58286,235 @@ const openapi = {
|
|
|
58286
58286
|
'x-undocumented': 'Internal endpoint for Console',
|
|
58287
58287
|
},
|
|
58288
58288
|
},
|
|
58289
|
+
'/seam/console/v1/workspace/console_settings/get': {
|
|
58290
|
+
get: {
|
|
58291
|
+
description: "Gets the signed-in user's console settings for the workspace: the sidebar shortcuts and pinned resources, in order, and the customer the console was last scoped to.",
|
|
58292
|
+
operationId: 'seamConsoleV1WorkspaceConsoleSettingsGetGet',
|
|
58293
|
+
responses: {
|
|
58294
|
+
'200': {
|
|
58295
|
+
content: {
|
|
58296
|
+
'application/json': {
|
|
58297
|
+
schema: {
|
|
58298
|
+
properties: {
|
|
58299
|
+
console_settings: {
|
|
58300
|
+
properties: {
|
|
58301
|
+
pinned_resources: {
|
|
58302
|
+
description: 'Resources pinned in the console sidebar, in order.',
|
|
58303
|
+
items: {
|
|
58304
|
+
properties: {
|
|
58305
|
+
display_name: {
|
|
58306
|
+
description: 'Name shown in the sidebar, as it was when pinned.',
|
|
58307
|
+
type: 'string',
|
|
58308
|
+
},
|
|
58309
|
+
resource_id: { type: 'string' },
|
|
58310
|
+
resource_type: {
|
|
58311
|
+
enum: [
|
|
58312
|
+
'device',
|
|
58313
|
+
'space',
|
|
58314
|
+
'access_grant',
|
|
58315
|
+
'access_code',
|
|
58316
|
+
'reservation',
|
|
58317
|
+
'user_identity',
|
|
58318
|
+
'connected_account',
|
|
58319
|
+
'acs_system',
|
|
58320
|
+
],
|
|
58321
|
+
type: 'string',
|
|
58322
|
+
},
|
|
58323
|
+
},
|
|
58324
|
+
required: [
|
|
58325
|
+
'resource_type',
|
|
58326
|
+
'resource_id',
|
|
58327
|
+
'display_name',
|
|
58328
|
+
],
|
|
58329
|
+
type: 'object',
|
|
58330
|
+
},
|
|
58331
|
+
maxItems: 100,
|
|
58332
|
+
type: 'array',
|
|
58333
|
+
},
|
|
58334
|
+
selected_customer_key: {
|
|
58335
|
+
description: 'Customer the console was last scoped to. `null` means all customers.',
|
|
58336
|
+
nullable: true,
|
|
58337
|
+
type: 'string',
|
|
58338
|
+
},
|
|
58339
|
+
sidebar_shortcuts: {
|
|
58340
|
+
description: 'Pages shown as shortcuts in the console sidebar, in order.',
|
|
58341
|
+
items: { type: 'string' },
|
|
58342
|
+
maxItems: 100,
|
|
58343
|
+
type: 'array',
|
|
58344
|
+
},
|
|
58345
|
+
},
|
|
58346
|
+
type: 'object',
|
|
58347
|
+
},
|
|
58348
|
+
ok: { type: 'boolean' },
|
|
58349
|
+
},
|
|
58350
|
+
required: ['console_settings', 'ok'],
|
|
58351
|
+
type: 'object',
|
|
58352
|
+
},
|
|
58353
|
+
},
|
|
58354
|
+
},
|
|
58355
|
+
description: 'OK',
|
|
58356
|
+
},
|
|
58357
|
+
'400': { description: 'Bad Request' },
|
|
58358
|
+
'401': { description: 'Unauthorized' },
|
|
58359
|
+
},
|
|
58360
|
+
security: [{ console_session_with_workspace: [] }],
|
|
58361
|
+
summary: '/seam/console/v1/workspace/console_settings/get',
|
|
58362
|
+
tags: [],
|
|
58363
|
+
'x-fern-sdk-group-name': [
|
|
58364
|
+
'seam',
|
|
58365
|
+
'console',
|
|
58366
|
+
'v1',
|
|
58367
|
+
'workspace',
|
|
58368
|
+
'console_settings',
|
|
58369
|
+
],
|
|
58370
|
+
'x-fern-sdk-method-name': 'get',
|
|
58371
|
+
'x-fern-sdk-return-value': 'console_settings',
|
|
58372
|
+
'x-response-key': 'console_settings',
|
|
58373
|
+
'x-undocumented': 'Internal endpoint for Console',
|
|
58374
|
+
},
|
|
58375
|
+
},
|
|
58376
|
+
'/seam/console/v1/workspace/console_settings/update': {
|
|
58377
|
+
patch: {
|
|
58378
|
+
description: "Updates the signed-in user's console settings for the workspace. Only the settings you pass change.",
|
|
58379
|
+
operationId: 'seamConsoleV1WorkspaceConsoleSettingsUpdatePatch',
|
|
58380
|
+
requestBody: {
|
|
58381
|
+
content: {
|
|
58382
|
+
'application/json': {
|
|
58383
|
+
schema: {
|
|
58384
|
+
properties: {
|
|
58385
|
+
pinned_resources: {
|
|
58386
|
+
description: 'Resources pinned in the console sidebar, in order.',
|
|
58387
|
+
items: {
|
|
58388
|
+
properties: {
|
|
58389
|
+
display_name: {
|
|
58390
|
+
description: 'Name shown in the sidebar, as it was when pinned.',
|
|
58391
|
+
type: 'string',
|
|
58392
|
+
},
|
|
58393
|
+
resource_id: { type: 'string' },
|
|
58394
|
+
resource_type: {
|
|
58395
|
+
enum: [
|
|
58396
|
+
'device',
|
|
58397
|
+
'space',
|
|
58398
|
+
'access_grant',
|
|
58399
|
+
'access_code',
|
|
58400
|
+
'reservation',
|
|
58401
|
+
'user_identity',
|
|
58402
|
+
'connected_account',
|
|
58403
|
+
'acs_system',
|
|
58404
|
+
],
|
|
58405
|
+
type: 'string',
|
|
58406
|
+
},
|
|
58407
|
+
},
|
|
58408
|
+
required: [
|
|
58409
|
+
'resource_type',
|
|
58410
|
+
'resource_id',
|
|
58411
|
+
'display_name',
|
|
58412
|
+
],
|
|
58413
|
+
type: 'object',
|
|
58414
|
+
},
|
|
58415
|
+
maxItems: 100,
|
|
58416
|
+
type: 'array',
|
|
58417
|
+
},
|
|
58418
|
+
selected_customer_key: {
|
|
58419
|
+
description: 'Customer the console was last scoped to. `null` means all customers.',
|
|
58420
|
+
nullable: true,
|
|
58421
|
+
type: 'string',
|
|
58422
|
+
},
|
|
58423
|
+
sidebar_shortcuts: {
|
|
58424
|
+
description: 'Pages shown as shortcuts in the console sidebar, in order.',
|
|
58425
|
+
items: { type: 'string' },
|
|
58426
|
+
maxItems: 100,
|
|
58427
|
+
type: 'array',
|
|
58428
|
+
},
|
|
58429
|
+
},
|
|
58430
|
+
type: 'object',
|
|
58431
|
+
},
|
|
58432
|
+
},
|
|
58433
|
+
},
|
|
58434
|
+
},
|
|
58435
|
+
responses: {
|
|
58436
|
+
'200': {
|
|
58437
|
+
content: {
|
|
58438
|
+
'application/json': {
|
|
58439
|
+
schema: {
|
|
58440
|
+
properties: {
|
|
58441
|
+
console_settings: {
|
|
58442
|
+
properties: {
|
|
58443
|
+
pinned_resources: {
|
|
58444
|
+
description: 'Resources pinned in the console sidebar, in order.',
|
|
58445
|
+
items: {
|
|
58446
|
+
properties: {
|
|
58447
|
+
display_name: {
|
|
58448
|
+
description: 'Name shown in the sidebar, as it was when pinned.',
|
|
58449
|
+
type: 'string',
|
|
58450
|
+
},
|
|
58451
|
+
resource_id: { type: 'string' },
|
|
58452
|
+
resource_type: {
|
|
58453
|
+
enum: [
|
|
58454
|
+
'device',
|
|
58455
|
+
'space',
|
|
58456
|
+
'access_grant',
|
|
58457
|
+
'access_code',
|
|
58458
|
+
'reservation',
|
|
58459
|
+
'user_identity',
|
|
58460
|
+
'connected_account',
|
|
58461
|
+
'acs_system',
|
|
58462
|
+
],
|
|
58463
|
+
type: 'string',
|
|
58464
|
+
},
|
|
58465
|
+
},
|
|
58466
|
+
required: [
|
|
58467
|
+
'resource_type',
|
|
58468
|
+
'resource_id',
|
|
58469
|
+
'display_name',
|
|
58470
|
+
],
|
|
58471
|
+
type: 'object',
|
|
58472
|
+
},
|
|
58473
|
+
maxItems: 100,
|
|
58474
|
+
type: 'array',
|
|
58475
|
+
},
|
|
58476
|
+
selected_customer_key: {
|
|
58477
|
+
description: 'Customer the console was last scoped to. `null` means all customers.',
|
|
58478
|
+
nullable: true,
|
|
58479
|
+
type: 'string',
|
|
58480
|
+
},
|
|
58481
|
+
sidebar_shortcuts: {
|
|
58482
|
+
description: 'Pages shown as shortcuts in the console sidebar, in order.',
|
|
58483
|
+
items: { type: 'string' },
|
|
58484
|
+
maxItems: 100,
|
|
58485
|
+
type: 'array',
|
|
58486
|
+
},
|
|
58487
|
+
},
|
|
58488
|
+
type: 'object',
|
|
58489
|
+
},
|
|
58490
|
+
ok: { type: 'boolean' },
|
|
58491
|
+
},
|
|
58492
|
+
required: ['console_settings', 'ok'],
|
|
58493
|
+
type: 'object',
|
|
58494
|
+
},
|
|
58495
|
+
},
|
|
58496
|
+
},
|
|
58497
|
+
description: 'OK',
|
|
58498
|
+
},
|
|
58499
|
+
'400': { description: 'Bad Request' },
|
|
58500
|
+
'401': { description: 'Unauthorized' },
|
|
58501
|
+
},
|
|
58502
|
+
security: [{ console_session_with_workspace: [] }],
|
|
58503
|
+
summary: '/seam/console/v1/workspace/console_settings/update',
|
|
58504
|
+
tags: [],
|
|
58505
|
+
'x-fern-sdk-group-name': [
|
|
58506
|
+
'seam',
|
|
58507
|
+
'console',
|
|
58508
|
+
'v1',
|
|
58509
|
+
'workspace',
|
|
58510
|
+
'console_settings',
|
|
58511
|
+
],
|
|
58512
|
+
'x-fern-sdk-method-name': 'update',
|
|
58513
|
+
'x-fern-sdk-return-value': 'console_settings',
|
|
58514
|
+
'x-response-key': 'console_settings',
|
|
58515
|
+
'x-undocumented': 'Internal endpoint for Console',
|
|
58516
|
+
},
|
|
58517
|
+
},
|
|
58289
58518
|
'/seam/console/v1/workspace/feature_flags/list': {
|
|
58290
58519
|
get: {
|
|
58291
58520
|
description: 'Lists the workspace feature flags the Console reads.',
|