@seamapi/types 1.1156.0 → 1.1158.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.
@@ -91325,6 +91325,39 @@ export type Routes = {
91325
91325
  };
91326
91326
  maxDuration: undefined;
91327
91327
  };
91328
+ '/seam/console/v1/cameras/live_views/create': {
91329
+ route: '/seam/console/v1/cameras/live_views/create';
91330
+ method: 'POST';
91331
+ queryParams: {};
91332
+ jsonBody: {
91333
+ /** ID of the camera to view. */
91334
+ device_id: string;
91335
+ /** Indicates whether to include the camera's audio. */
91336
+ include_audio?: boolean;
91337
+ /** Number of seconds for which the live view session is valid, up to 600. */
91338
+ duration_seconds?: number;
91339
+ };
91340
+ commonParams: {};
91341
+ formData: {};
91342
+ jsonResponse: {
91343
+ /** Represents a short-lived live view session for a single camera. Use the session ID and token to start a WebRTC stream and to stop the session. */
91344
+ camera_live_view_session: {
91345
+ /** ID of the camera live view session. */
91346
+ camera_live_view_session_id: string;
91347
+ /** ID of the camera. */
91348
+ device_id: string;
91349
+ /** Token that authorizes the offer and stop requests for this session. */
91350
+ token: string;
91351
+ /** Date and time at which the live view session expires. */
91352
+ expires_at: string;
91353
+ };
91354
+ client_session: {
91355
+ client_session_id: string;
91356
+ token: string;
91357
+ };
91358
+ };
91359
+ maxDuration: undefined;
91360
+ };
91328
91361
  '/seam/console/v1/get_resource_locator': {
91329
91362
  route: '/seam/console/v1/get_resource_locator';
91330
91363
  method: 'GET' | 'POST';
@@ -92486,6 +92519,66 @@ export type Routes = {
92486
92519
  };
92487
92520
  maxDuration: undefined;
92488
92521
  };
92522
+ '/seam/console/v1/workspace/console_settings/get': {
92523
+ route: '/seam/console/v1/workspace/console_settings/get';
92524
+ method: 'GET' | 'POST';
92525
+ queryParams: {};
92526
+ jsonBody: {};
92527
+ commonParams: {};
92528
+ formData: {};
92529
+ jsonResponse: {
92530
+ console_settings: {
92531
+ /** Pages shown as shortcuts in the console sidebar, in order. */
92532
+ sidebar_shortcuts?: string[] | undefined;
92533
+ /** Resources pinned in the console sidebar, in order. */
92534
+ pinned_resources?: {
92535
+ resource_type: 'device' | 'space' | 'access_grant' | 'access_code' | 'reservation' | 'user_identity' | 'connected_account' | 'acs_system';
92536
+ resource_id: string;
92537
+ /** Name shown in the sidebar, as it was when pinned. */
92538
+ display_name: string;
92539
+ }[] | undefined;
92540
+ /** Customer the console was last scoped to. `null` means all customers. */
92541
+ selected_customer_key?: (string | null) | undefined;
92542
+ };
92543
+ };
92544
+ maxDuration: undefined;
92545
+ };
92546
+ '/seam/console/v1/workspace/console_settings/update': {
92547
+ route: '/seam/console/v1/workspace/console_settings/update';
92548
+ method: 'PATCH' | 'POST';
92549
+ queryParams: {};
92550
+ jsonBody: {
92551
+ /** Pages shown as shortcuts in the console sidebar, in order. */
92552
+ sidebar_shortcuts?: string[] | undefined;
92553
+ /** Resources pinned in the console sidebar, in order. */
92554
+ pinned_resources?: {
92555
+ resource_type: 'device' | 'space' | 'access_grant' | 'access_code' | 'reservation' | 'user_identity' | 'connected_account' | 'acs_system';
92556
+ resource_id: string;
92557
+ /** Name shown in the sidebar, as it was when pinned. */
92558
+ display_name: string;
92559
+ }[] | undefined;
92560
+ /** Customer the console was last scoped to. `null` means all customers. */
92561
+ selected_customer_key?: (string | null) | undefined;
92562
+ };
92563
+ commonParams: {};
92564
+ formData: {};
92565
+ jsonResponse: {
92566
+ console_settings: {
92567
+ /** Pages shown as shortcuts in the console sidebar, in order. */
92568
+ sidebar_shortcuts?: string[] | undefined;
92569
+ /** Resources pinned in the console sidebar, in order. */
92570
+ pinned_resources?: {
92571
+ resource_type: 'device' | 'space' | 'access_grant' | 'access_code' | 'reservation' | 'user_identity' | 'connected_account' | 'acs_system';
92572
+ resource_id: string;
92573
+ /** Name shown in the sidebar, as it was when pinned. */
92574
+ display_name: string;
92575
+ }[] | undefined;
92576
+ /** Customer the console was last scoped to. `null` means all customers. */
92577
+ selected_customer_key?: (string | null) | undefined;
92578
+ };
92579
+ };
92580
+ maxDuration: undefined;
92581
+ };
92489
92582
  '/seam/console/v1/workspace/feature_flags/list': {
92490
92583
  route: '/seam/console/v1/workspace/feature_flags/list';
92491
92584
  method: 'GET' | 'POST';
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.1156.0",
3
+ "version": "1.1158.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -61558,6 +61558,88 @@ const openapi: OpenAPISpec = {
61558
61558
  'Internal endpoint for driving Connect Webview flows programmatically.',
61559
61559
  },
61560
61560
  },
61561
+ '/seam/console/v1/cameras/live_views/create': {
61562
+ post: {
61563
+ description:
61564
+ 'Creates a camera live view session and a short-lived client session that owns it. Console passes the returned client session token to `/cameras/live_views/offer` and `/cameras/live_views/stop`.',
61565
+ operationId: 'seamConsoleV1CamerasLiveViewsCreatePost',
61566
+ requestBody: {
61567
+ content: {
61568
+ 'application/json': {
61569
+ schema: {
61570
+ additionalProperties: false,
61571
+ properties: {
61572
+ device_id: {
61573
+ description: 'ID of the camera to view.',
61574
+ format: 'uuid',
61575
+ type: 'string',
61576
+ },
61577
+ duration_seconds: {
61578
+ default: 600,
61579
+ description:
61580
+ 'Number of seconds for which the live view session is valid, up to 600.',
61581
+ maximum: 600,
61582
+ minimum: 1,
61583
+ type: 'integer',
61584
+ },
61585
+ include_audio: {
61586
+ default: false,
61587
+ description:
61588
+ "Indicates whether to include the camera's audio.",
61589
+ type: 'boolean',
61590
+ },
61591
+ },
61592
+ required: ['device_id'],
61593
+ type: 'object',
61594
+ },
61595
+ },
61596
+ },
61597
+ },
61598
+ responses: {
61599
+ '200': {
61600
+ content: {
61601
+ 'application/json': {
61602
+ schema: {
61603
+ properties: {
61604
+ camera_live_view_session: {
61605
+ $ref: '#/components/schemas/camera_live_view_session',
61606
+ },
61607
+ client_session: {
61608
+ $ref: '#/components/schemas/client_session',
61609
+ },
61610
+ ok: { type: 'boolean' },
61611
+ },
61612
+ required: [
61613
+ 'camera_live_view_session',
61614
+ 'client_session',
61615
+ 'ok',
61616
+ ],
61617
+ type: 'object',
61618
+ },
61619
+ },
61620
+ },
61621
+ description: 'OK',
61622
+ },
61623
+ '400': { description: 'Bad Request' },
61624
+ '401': { description: 'Unauthorized' },
61625
+ },
61626
+ security: [{ console_session_with_workspace: [] }],
61627
+ summary: '/seam/console/v1/cameras/live_views/create',
61628
+ tags: [],
61629
+ 'x-fern-sdk-group-name': [
61630
+ 'seam',
61631
+ 'console',
61632
+ 'v1',
61633
+ 'cameras',
61634
+ 'live_views',
61635
+ ],
61636
+ 'x-fern-sdk-method-name': 'create',
61637
+ 'x-fern-sdk-return-value': 'camera_live_view_session',
61638
+ 'x-response-key': 'camera_live_view_session',
61639
+ 'x-title': 'Create a Camera Live View Session for Console',
61640
+ 'x-undocumented': 'Internal endpoint for Console',
61641
+ },
61642
+ },
61561
61643
  '/seam/console/v1/get_resource_locator': {
61562
61644
  get: {
61563
61645
  description:
@@ -63970,6 +64052,249 @@ const openapi: OpenAPISpec = {
63970
64052
  'x-undocumented': 'Internal endpoint for Console',
63971
64053
  },
63972
64054
  },
64055
+ '/seam/console/v1/workspace/console_settings/get': {
64056
+ get: {
64057
+ description:
64058
+ "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.",
64059
+ operationId: 'seamConsoleV1WorkspaceConsoleSettingsGetGet',
64060
+ responses: {
64061
+ '200': {
64062
+ content: {
64063
+ 'application/json': {
64064
+ schema: {
64065
+ properties: {
64066
+ console_settings: {
64067
+ properties: {
64068
+ pinned_resources: {
64069
+ description:
64070
+ 'Resources pinned in the console sidebar, in order.',
64071
+ items: {
64072
+ properties: {
64073
+ display_name: {
64074
+ description:
64075
+ 'Name shown in the sidebar, as it was when pinned.',
64076
+ type: 'string',
64077
+ },
64078
+ resource_id: { type: 'string' },
64079
+ resource_type: {
64080
+ enum: [
64081
+ 'device',
64082
+ 'space',
64083
+ 'access_grant',
64084
+ 'access_code',
64085
+ 'reservation',
64086
+ 'user_identity',
64087
+ 'connected_account',
64088
+ 'acs_system',
64089
+ ],
64090
+ type: 'string',
64091
+ },
64092
+ },
64093
+ required: [
64094
+ 'resource_type',
64095
+ 'resource_id',
64096
+ 'display_name',
64097
+ ],
64098
+ type: 'object',
64099
+ },
64100
+ maxItems: 100,
64101
+ type: 'array',
64102
+ },
64103
+ selected_customer_key: {
64104
+ description:
64105
+ 'Customer the console was last scoped to. `null` means all customers.',
64106
+ nullable: true,
64107
+ type: 'string',
64108
+ },
64109
+ sidebar_shortcuts: {
64110
+ description:
64111
+ 'Pages shown as shortcuts in the console sidebar, in order.',
64112
+ items: { type: 'string' },
64113
+ maxItems: 100,
64114
+ type: 'array',
64115
+ },
64116
+ },
64117
+ type: 'object',
64118
+ },
64119
+ ok: { type: 'boolean' },
64120
+ },
64121
+ required: ['console_settings', 'ok'],
64122
+ type: 'object',
64123
+ },
64124
+ },
64125
+ },
64126
+ description: 'OK',
64127
+ },
64128
+ '400': { description: 'Bad Request' },
64129
+ '401': { description: 'Unauthorized' },
64130
+ },
64131
+ security: [{ console_session_with_workspace: [] }],
64132
+ summary: '/seam/console/v1/workspace/console_settings/get',
64133
+ tags: [],
64134
+ 'x-fern-sdk-group-name': [
64135
+ 'seam',
64136
+ 'console',
64137
+ 'v1',
64138
+ 'workspace',
64139
+ 'console_settings',
64140
+ ],
64141
+ 'x-fern-sdk-method-name': 'get',
64142
+ 'x-fern-sdk-return-value': 'console_settings',
64143
+ 'x-response-key': 'console_settings',
64144
+ 'x-undocumented': 'Internal endpoint for Console',
64145
+ },
64146
+ },
64147
+ '/seam/console/v1/workspace/console_settings/update': {
64148
+ patch: {
64149
+ description:
64150
+ "Updates the signed-in user's console settings for the workspace. Only the settings you pass change.",
64151
+ operationId: 'seamConsoleV1WorkspaceConsoleSettingsUpdatePatch',
64152
+ requestBody: {
64153
+ content: {
64154
+ 'application/json': {
64155
+ schema: {
64156
+ properties: {
64157
+ pinned_resources: {
64158
+ description:
64159
+ 'Resources pinned in the console sidebar, in order.',
64160
+ items: {
64161
+ properties: {
64162
+ display_name: {
64163
+ description:
64164
+ 'Name shown in the sidebar, as it was when pinned.',
64165
+ type: 'string',
64166
+ },
64167
+ resource_id: { type: 'string' },
64168
+ resource_type: {
64169
+ enum: [
64170
+ 'device',
64171
+ 'space',
64172
+ 'access_grant',
64173
+ 'access_code',
64174
+ 'reservation',
64175
+ 'user_identity',
64176
+ 'connected_account',
64177
+ 'acs_system',
64178
+ ],
64179
+ type: 'string',
64180
+ },
64181
+ },
64182
+ required: [
64183
+ 'resource_type',
64184
+ 'resource_id',
64185
+ 'display_name',
64186
+ ],
64187
+ type: 'object',
64188
+ },
64189
+ maxItems: 100,
64190
+ type: 'array',
64191
+ },
64192
+ selected_customer_key: {
64193
+ description:
64194
+ 'Customer the console was last scoped to. `null` means all customers.',
64195
+ nullable: true,
64196
+ type: 'string',
64197
+ },
64198
+ sidebar_shortcuts: {
64199
+ description:
64200
+ 'Pages shown as shortcuts in the console sidebar, in order.',
64201
+ items: { type: 'string' },
64202
+ maxItems: 100,
64203
+ type: 'array',
64204
+ },
64205
+ },
64206
+ type: 'object',
64207
+ },
64208
+ },
64209
+ },
64210
+ },
64211
+ responses: {
64212
+ '200': {
64213
+ content: {
64214
+ 'application/json': {
64215
+ schema: {
64216
+ properties: {
64217
+ console_settings: {
64218
+ properties: {
64219
+ pinned_resources: {
64220
+ description:
64221
+ 'Resources pinned in the console sidebar, in order.',
64222
+ items: {
64223
+ properties: {
64224
+ display_name: {
64225
+ description:
64226
+ 'Name shown in the sidebar, as it was when pinned.',
64227
+ type: 'string',
64228
+ },
64229
+ resource_id: { type: 'string' },
64230
+ resource_type: {
64231
+ enum: [
64232
+ 'device',
64233
+ 'space',
64234
+ 'access_grant',
64235
+ 'access_code',
64236
+ 'reservation',
64237
+ 'user_identity',
64238
+ 'connected_account',
64239
+ 'acs_system',
64240
+ ],
64241
+ type: 'string',
64242
+ },
64243
+ },
64244
+ required: [
64245
+ 'resource_type',
64246
+ 'resource_id',
64247
+ 'display_name',
64248
+ ],
64249
+ type: 'object',
64250
+ },
64251
+ maxItems: 100,
64252
+ type: 'array',
64253
+ },
64254
+ selected_customer_key: {
64255
+ description:
64256
+ 'Customer the console was last scoped to. `null` means all customers.',
64257
+ nullable: true,
64258
+ type: 'string',
64259
+ },
64260
+ sidebar_shortcuts: {
64261
+ description:
64262
+ 'Pages shown as shortcuts in the console sidebar, in order.',
64263
+ items: { type: 'string' },
64264
+ maxItems: 100,
64265
+ type: 'array',
64266
+ },
64267
+ },
64268
+ type: 'object',
64269
+ },
64270
+ ok: { type: 'boolean' },
64271
+ },
64272
+ required: ['console_settings', 'ok'],
64273
+ type: 'object',
64274
+ },
64275
+ },
64276
+ },
64277
+ description: 'OK',
64278
+ },
64279
+ '400': { description: 'Bad Request' },
64280
+ '401': { description: 'Unauthorized' },
64281
+ },
64282
+ security: [{ console_session_with_workspace: [] }],
64283
+ summary: '/seam/console/v1/workspace/console_settings/update',
64284
+ tags: [],
64285
+ 'x-fern-sdk-group-name': [
64286
+ 'seam',
64287
+ 'console',
64288
+ 'v1',
64289
+ 'workspace',
64290
+ 'console_settings',
64291
+ ],
64292
+ 'x-fern-sdk-method-name': 'update',
64293
+ 'x-fern-sdk-return-value': 'console_settings',
64294
+ 'x-response-key': 'console_settings',
64295
+ 'x-undocumented': 'Internal endpoint for Console',
64296
+ },
64297
+ },
63973
64298
  '/seam/console/v1/workspace/feature_flags/list': {
63974
64299
  get: {
63975
64300
  description: 'Lists the workspace feature flags the Console reads.',
@@ -109042,6 +109042,39 @@ export type Routes = {
109042
109042
  }
109043
109043
  maxDuration: undefined
109044
109044
  }
109045
+ '/seam/console/v1/cameras/live_views/create': {
109046
+ route: '/seam/console/v1/cameras/live_views/create'
109047
+ method: 'POST'
109048
+ queryParams: {}
109049
+ jsonBody: {
109050
+ /** ID of the camera to view. */
109051
+ device_id: string
109052
+ /** Indicates whether to include the camera's audio. */
109053
+ include_audio?: boolean
109054
+ /** Number of seconds for which the live view session is valid, up to 600. */
109055
+ duration_seconds?: number
109056
+ }
109057
+ commonParams: {}
109058
+ formData: {}
109059
+ jsonResponse: {
109060
+ /** Represents a short-lived live view session for a single camera. Use the session ID and token to start a WebRTC stream and to stop the session. */
109061
+ camera_live_view_session: {
109062
+ /** ID of the camera live view session. */
109063
+ camera_live_view_session_id: string
109064
+ /** ID of the camera. */
109065
+ device_id: string
109066
+ /** Token that authorizes the offer and stop requests for this session. */
109067
+ token: string
109068
+ /** Date and time at which the live view session expires. */
109069
+ expires_at: string
109070
+ }
109071
+ client_session: {
109072
+ client_session_id: string
109073
+ token: string
109074
+ }
109075
+ }
109076
+ maxDuration: undefined
109077
+ }
109045
109078
  '/seam/console/v1/get_resource_locator': {
109046
109079
  route: '/seam/console/v1/get_resource_locator'
109047
109080
  method: 'GET' | 'POST'
@@ -110295,6 +110328,96 @@ export type Routes = {
110295
110328
  }
110296
110329
  maxDuration: undefined
110297
110330
  }
110331
+ '/seam/console/v1/workspace/console_settings/get': {
110332
+ route: '/seam/console/v1/workspace/console_settings/get'
110333
+ method: 'GET' | 'POST'
110334
+ queryParams: {}
110335
+ jsonBody: {}
110336
+ commonParams: {}
110337
+ formData: {}
110338
+ jsonResponse: {
110339
+ console_settings: {
110340
+ /** Pages shown as shortcuts in the console sidebar, in order. */
110341
+ sidebar_shortcuts?: string[] | undefined
110342
+ /** Resources pinned in the console sidebar, in order. */
110343
+ pinned_resources?:
110344
+ | {
110345
+ resource_type:
110346
+ | 'device'
110347
+ | 'space'
110348
+ | 'access_grant'
110349
+ | 'access_code'
110350
+ | 'reservation'
110351
+ | 'user_identity'
110352
+ | 'connected_account'
110353
+ | 'acs_system'
110354
+ resource_id: string
110355
+ /** Name shown in the sidebar, as it was when pinned. */
110356
+ display_name: string
110357
+ }[]
110358
+ | undefined
110359
+ /** Customer the console was last scoped to. `null` means all customers. */
110360
+ selected_customer_key?: (string | null) | undefined
110361
+ }
110362
+ }
110363
+ maxDuration: undefined
110364
+ }
110365
+ '/seam/console/v1/workspace/console_settings/update': {
110366
+ route: '/seam/console/v1/workspace/console_settings/update'
110367
+ method: 'PATCH' | 'POST'
110368
+ queryParams: {}
110369
+ jsonBody: {
110370
+ /** Pages shown as shortcuts in the console sidebar, in order. */
110371
+ sidebar_shortcuts?: string[] | undefined
110372
+ /** Resources pinned in the console sidebar, in order. */
110373
+ pinned_resources?:
110374
+ | {
110375
+ resource_type:
110376
+ | 'device'
110377
+ | 'space'
110378
+ | 'access_grant'
110379
+ | 'access_code'
110380
+ | 'reservation'
110381
+ | 'user_identity'
110382
+ | 'connected_account'
110383
+ | 'acs_system'
110384
+ resource_id: string
110385
+ /** Name shown in the sidebar, as it was when pinned. */
110386
+ display_name: string
110387
+ }[]
110388
+ | undefined
110389
+ /** Customer the console was last scoped to. `null` means all customers. */
110390
+ selected_customer_key?: (string | null) | undefined
110391
+ }
110392
+ commonParams: {}
110393
+ formData: {}
110394
+ jsonResponse: {
110395
+ console_settings: {
110396
+ /** Pages shown as shortcuts in the console sidebar, in order. */
110397
+ sidebar_shortcuts?: string[] | undefined
110398
+ /** Resources pinned in the console sidebar, in order. */
110399
+ pinned_resources?:
110400
+ | {
110401
+ resource_type:
110402
+ | 'device'
110403
+ | 'space'
110404
+ | 'access_grant'
110405
+ | 'access_code'
110406
+ | 'reservation'
110407
+ | 'user_identity'
110408
+ | 'connected_account'
110409
+ | 'acs_system'
110410
+ resource_id: string
110411
+ /** Name shown in the sidebar, as it was when pinned. */
110412
+ display_name: string
110413
+ }[]
110414
+ | undefined
110415
+ /** Customer the console was last scoped to. `null` means all customers. */
110416
+ selected_customer_key?: (string | null) | undefined
110417
+ }
110418
+ }
110419
+ maxDuration: undefined
110420
+ }
110298
110421
  '/seam/console/v1/workspace/feature_flags/list': {
110299
110422
  route: '/seam/console/v1/workspace/feature_flags/list'
110300
110423
  method: 'GET' | 'POST'