@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.
@@ -92486,6 +92486,66 @@ export type Routes = {
92486
92486
  };
92487
92487
  maxDuration: undefined;
92488
92488
  };
92489
+ '/seam/console/v1/workspace/console_settings/get': {
92490
+ route: '/seam/console/v1/workspace/console_settings/get';
92491
+ method: 'GET' | 'POST';
92492
+ queryParams: {};
92493
+ jsonBody: {};
92494
+ commonParams: {};
92495
+ formData: {};
92496
+ jsonResponse: {
92497
+ console_settings: {
92498
+ /** Pages shown as shortcuts in the console sidebar, in order. */
92499
+ sidebar_shortcuts?: string[] | undefined;
92500
+ /** Resources pinned in the console sidebar, in order. */
92501
+ pinned_resources?: {
92502
+ resource_type: 'device' | 'space' | 'access_grant' | 'access_code' | 'reservation' | 'user_identity' | 'connected_account' | 'acs_system';
92503
+ resource_id: string;
92504
+ /** Name shown in the sidebar, as it was when pinned. */
92505
+ display_name: string;
92506
+ }[] | undefined;
92507
+ /** Customer the console was last scoped to. `null` means all customers. */
92508
+ selected_customer_key?: (string | null) | undefined;
92509
+ };
92510
+ };
92511
+ maxDuration: undefined;
92512
+ };
92513
+ '/seam/console/v1/workspace/console_settings/update': {
92514
+ route: '/seam/console/v1/workspace/console_settings/update';
92515
+ method: 'PATCH' | 'POST';
92516
+ queryParams: {};
92517
+ jsonBody: {
92518
+ /** Pages shown as shortcuts in the console sidebar, in order. */
92519
+ sidebar_shortcuts?: string[] | undefined;
92520
+ /** Resources pinned in the console sidebar, in order. */
92521
+ pinned_resources?: {
92522
+ resource_type: 'device' | 'space' | 'access_grant' | 'access_code' | 'reservation' | 'user_identity' | 'connected_account' | 'acs_system';
92523
+ resource_id: string;
92524
+ /** Name shown in the sidebar, as it was when pinned. */
92525
+ display_name: string;
92526
+ }[] | undefined;
92527
+ /** Customer the console was last scoped to. `null` means all customers. */
92528
+ selected_customer_key?: (string | null) | undefined;
92529
+ };
92530
+ commonParams: {};
92531
+ formData: {};
92532
+ jsonResponse: {
92533
+ console_settings: {
92534
+ /** Pages shown as shortcuts in the console sidebar, in order. */
92535
+ sidebar_shortcuts?: string[] | undefined;
92536
+ /** Resources pinned in the console sidebar, in order. */
92537
+ pinned_resources?: {
92538
+ resource_type: 'device' | 'space' | 'access_grant' | 'access_code' | 'reservation' | 'user_identity' | 'connected_account' | 'acs_system';
92539
+ resource_id: string;
92540
+ /** Name shown in the sidebar, as it was when pinned. */
92541
+ display_name: string;
92542
+ }[] | undefined;
92543
+ /** Customer the console was last scoped to. `null` means all customers. */
92544
+ selected_customer_key?: (string | null) | undefined;
92545
+ };
92546
+ };
92547
+ maxDuration: undefined;
92548
+ };
92489
92549
  '/seam/console/v1/workspace/feature_flags/list': {
92490
92550
  route: '/seam/console/v1/workspace/feature_flags/list';
92491
92551
  method: 'GET' | 'POST';
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.1155.0",
3
+ "version": "1.1157.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -862,7 +862,7 @@ export const camera_activated_event = device_event.extend({
862
862
  ---
863
863
  route_path: /devices
864
864
  ---
865
- A camera was activated, for example, by motion detection.
865
+ 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.
866
866
  `)
867
867
 
868
868
  export type CameraActivatedEvent = z.infer<typeof camera_activated_event>
@@ -893,7 +893,7 @@ export const device_doorbell_rang_event = device_event.extend({
893
893
  ---
894
894
  route_path: /devices
895
895
  ---
896
- A doorbell button was pressed on a device.
896
+ 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.
897
897
  `)
898
898
 
899
899
  export type DeviceDoorbellRangEvent = z.infer<typeof device_doorbell_rang_event>
@@ -31501,7 +31501,7 @@ const openapi: OpenAPISpec = {
31501
31501
  },
31502
31502
  {
31503
31503
  description:
31504
- 'A camera was activated, for example, by motion detection.',
31504
+ '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.',
31505
31505
  properties: {
31506
31506
  activation_reason: {
31507
31507
  description: 'The reason the camera was activated.',
@@ -31604,7 +31604,8 @@ const openapi: OpenAPISpec = {
31604
31604
  'x-route-path': '/devices',
31605
31605
  },
31606
31606
  {
31607
- description: 'A doorbell button was pressed on a device.',
31607
+ description:
31608
+ '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.',
31608
31609
  properties: {
31609
31610
  connected_account_custom_metadata: {
31610
31611
  additionalProperties: {
@@ -63969,6 +63970,249 @@ const openapi: OpenAPISpec = {
63969
63970
  'x-undocumented': 'Internal endpoint for Console',
63970
63971
  },
63971
63972
  },
63973
+ '/seam/console/v1/workspace/console_settings/get': {
63974
+ get: {
63975
+ description:
63976
+ "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.",
63977
+ operationId: 'seamConsoleV1WorkspaceConsoleSettingsGetGet',
63978
+ responses: {
63979
+ '200': {
63980
+ content: {
63981
+ 'application/json': {
63982
+ schema: {
63983
+ properties: {
63984
+ console_settings: {
63985
+ properties: {
63986
+ pinned_resources: {
63987
+ description:
63988
+ 'Resources pinned in the console sidebar, in order.',
63989
+ items: {
63990
+ properties: {
63991
+ display_name: {
63992
+ description:
63993
+ 'Name shown in the sidebar, as it was when pinned.',
63994
+ type: 'string',
63995
+ },
63996
+ resource_id: { type: 'string' },
63997
+ resource_type: {
63998
+ enum: [
63999
+ 'device',
64000
+ 'space',
64001
+ 'access_grant',
64002
+ 'access_code',
64003
+ 'reservation',
64004
+ 'user_identity',
64005
+ 'connected_account',
64006
+ 'acs_system',
64007
+ ],
64008
+ type: 'string',
64009
+ },
64010
+ },
64011
+ required: [
64012
+ 'resource_type',
64013
+ 'resource_id',
64014
+ 'display_name',
64015
+ ],
64016
+ type: 'object',
64017
+ },
64018
+ maxItems: 100,
64019
+ type: 'array',
64020
+ },
64021
+ selected_customer_key: {
64022
+ description:
64023
+ 'Customer the console was last scoped to. `null` means all customers.',
64024
+ nullable: true,
64025
+ type: 'string',
64026
+ },
64027
+ sidebar_shortcuts: {
64028
+ description:
64029
+ 'Pages shown as shortcuts in the console sidebar, in order.',
64030
+ items: { type: 'string' },
64031
+ maxItems: 100,
64032
+ type: 'array',
64033
+ },
64034
+ },
64035
+ type: 'object',
64036
+ },
64037
+ ok: { type: 'boolean' },
64038
+ },
64039
+ required: ['console_settings', 'ok'],
64040
+ type: 'object',
64041
+ },
64042
+ },
64043
+ },
64044
+ description: 'OK',
64045
+ },
64046
+ '400': { description: 'Bad Request' },
64047
+ '401': { description: 'Unauthorized' },
64048
+ },
64049
+ security: [{ console_session_with_workspace: [] }],
64050
+ summary: '/seam/console/v1/workspace/console_settings/get',
64051
+ tags: [],
64052
+ 'x-fern-sdk-group-name': [
64053
+ 'seam',
64054
+ 'console',
64055
+ 'v1',
64056
+ 'workspace',
64057
+ 'console_settings',
64058
+ ],
64059
+ 'x-fern-sdk-method-name': 'get',
64060
+ 'x-fern-sdk-return-value': 'console_settings',
64061
+ 'x-response-key': 'console_settings',
64062
+ 'x-undocumented': 'Internal endpoint for Console',
64063
+ },
64064
+ },
64065
+ '/seam/console/v1/workspace/console_settings/update': {
64066
+ patch: {
64067
+ description:
64068
+ "Updates the signed-in user's console settings for the workspace. Only the settings you pass change.",
64069
+ operationId: 'seamConsoleV1WorkspaceConsoleSettingsUpdatePatch',
64070
+ requestBody: {
64071
+ content: {
64072
+ 'application/json': {
64073
+ schema: {
64074
+ properties: {
64075
+ pinned_resources: {
64076
+ description:
64077
+ 'Resources pinned in the console sidebar, in order.',
64078
+ items: {
64079
+ properties: {
64080
+ display_name: {
64081
+ description:
64082
+ 'Name shown in the sidebar, as it was when pinned.',
64083
+ type: 'string',
64084
+ },
64085
+ resource_id: { type: 'string' },
64086
+ resource_type: {
64087
+ enum: [
64088
+ 'device',
64089
+ 'space',
64090
+ 'access_grant',
64091
+ 'access_code',
64092
+ 'reservation',
64093
+ 'user_identity',
64094
+ 'connected_account',
64095
+ 'acs_system',
64096
+ ],
64097
+ type: 'string',
64098
+ },
64099
+ },
64100
+ required: [
64101
+ 'resource_type',
64102
+ 'resource_id',
64103
+ 'display_name',
64104
+ ],
64105
+ type: 'object',
64106
+ },
64107
+ maxItems: 100,
64108
+ type: 'array',
64109
+ },
64110
+ selected_customer_key: {
64111
+ description:
64112
+ 'Customer the console was last scoped to. `null` means all customers.',
64113
+ nullable: true,
64114
+ type: 'string',
64115
+ },
64116
+ sidebar_shortcuts: {
64117
+ description:
64118
+ 'Pages shown as shortcuts in the console sidebar, in order.',
64119
+ items: { type: 'string' },
64120
+ maxItems: 100,
64121
+ type: 'array',
64122
+ },
64123
+ },
64124
+ type: 'object',
64125
+ },
64126
+ },
64127
+ },
64128
+ },
64129
+ responses: {
64130
+ '200': {
64131
+ content: {
64132
+ 'application/json': {
64133
+ schema: {
64134
+ properties: {
64135
+ console_settings: {
64136
+ properties: {
64137
+ pinned_resources: {
64138
+ description:
64139
+ 'Resources pinned in the console sidebar, in order.',
64140
+ items: {
64141
+ properties: {
64142
+ display_name: {
64143
+ description:
64144
+ 'Name shown in the sidebar, as it was when pinned.',
64145
+ type: 'string',
64146
+ },
64147
+ resource_id: { type: 'string' },
64148
+ resource_type: {
64149
+ enum: [
64150
+ 'device',
64151
+ 'space',
64152
+ 'access_grant',
64153
+ 'access_code',
64154
+ 'reservation',
64155
+ 'user_identity',
64156
+ 'connected_account',
64157
+ 'acs_system',
64158
+ ],
64159
+ type: 'string',
64160
+ },
64161
+ },
64162
+ required: [
64163
+ 'resource_type',
64164
+ 'resource_id',
64165
+ 'display_name',
64166
+ ],
64167
+ type: 'object',
64168
+ },
64169
+ maxItems: 100,
64170
+ type: 'array',
64171
+ },
64172
+ selected_customer_key: {
64173
+ description:
64174
+ 'Customer the console was last scoped to. `null` means all customers.',
64175
+ nullable: true,
64176
+ type: 'string',
64177
+ },
64178
+ sidebar_shortcuts: {
64179
+ description:
64180
+ 'Pages shown as shortcuts in the console sidebar, in order.',
64181
+ items: { type: 'string' },
64182
+ maxItems: 100,
64183
+ type: 'array',
64184
+ },
64185
+ },
64186
+ type: 'object',
64187
+ },
64188
+ ok: { type: 'boolean' },
64189
+ },
64190
+ required: ['console_settings', 'ok'],
64191
+ type: 'object',
64192
+ },
64193
+ },
64194
+ },
64195
+ description: 'OK',
64196
+ },
64197
+ '400': { description: 'Bad Request' },
64198
+ '401': { description: 'Unauthorized' },
64199
+ },
64200
+ security: [{ console_session_with_workspace: [] }],
64201
+ summary: '/seam/console/v1/workspace/console_settings/update',
64202
+ tags: [],
64203
+ 'x-fern-sdk-group-name': [
64204
+ 'seam',
64205
+ 'console',
64206
+ 'v1',
64207
+ 'workspace',
64208
+ 'console_settings',
64209
+ ],
64210
+ 'x-fern-sdk-method-name': 'update',
64211
+ 'x-fern-sdk-return-value': 'console_settings',
64212
+ 'x-response-key': 'console_settings',
64213
+ 'x-undocumented': 'Internal endpoint for Console',
64214
+ },
64215
+ },
63972
64216
  '/seam/console/v1/workspace/feature_flags/list': {
63973
64217
  get: {
63974
64218
  description: 'Lists the workspace feature flags the Console reads.',
@@ -110295,6 +110295,96 @@ export type Routes = {
110295
110295
  }
110296
110296
  maxDuration: undefined
110297
110297
  }
110298
+ '/seam/console/v1/workspace/console_settings/get': {
110299
+ route: '/seam/console/v1/workspace/console_settings/get'
110300
+ method: 'GET' | 'POST'
110301
+ queryParams: {}
110302
+ jsonBody: {}
110303
+ commonParams: {}
110304
+ formData: {}
110305
+ jsonResponse: {
110306
+ console_settings: {
110307
+ /** Pages shown as shortcuts in the console sidebar, in order. */
110308
+ sidebar_shortcuts?: string[] | undefined
110309
+ /** Resources pinned in the console sidebar, in order. */
110310
+ pinned_resources?:
110311
+ | {
110312
+ resource_type:
110313
+ | 'device'
110314
+ | 'space'
110315
+ | 'access_grant'
110316
+ | 'access_code'
110317
+ | 'reservation'
110318
+ | 'user_identity'
110319
+ | 'connected_account'
110320
+ | 'acs_system'
110321
+ resource_id: string
110322
+ /** Name shown in the sidebar, as it was when pinned. */
110323
+ display_name: string
110324
+ }[]
110325
+ | undefined
110326
+ /** Customer the console was last scoped to. `null` means all customers. */
110327
+ selected_customer_key?: (string | null) | undefined
110328
+ }
110329
+ }
110330
+ maxDuration: undefined
110331
+ }
110332
+ '/seam/console/v1/workspace/console_settings/update': {
110333
+ route: '/seam/console/v1/workspace/console_settings/update'
110334
+ method: 'PATCH' | 'POST'
110335
+ queryParams: {}
110336
+ jsonBody: {
110337
+ /** Pages shown as shortcuts in the console sidebar, in order. */
110338
+ sidebar_shortcuts?: string[] | undefined
110339
+ /** Resources pinned in the console sidebar, in order. */
110340
+ pinned_resources?:
110341
+ | {
110342
+ resource_type:
110343
+ | 'device'
110344
+ | 'space'
110345
+ | 'access_grant'
110346
+ | 'access_code'
110347
+ | 'reservation'
110348
+ | 'user_identity'
110349
+ | 'connected_account'
110350
+ | 'acs_system'
110351
+ resource_id: string
110352
+ /** Name shown in the sidebar, as it was when pinned. */
110353
+ display_name: string
110354
+ }[]
110355
+ | undefined
110356
+ /** Customer the console was last scoped to. `null` means all customers. */
110357
+ selected_customer_key?: (string | null) | undefined
110358
+ }
110359
+ commonParams: {}
110360
+ formData: {}
110361
+ jsonResponse: {
110362
+ console_settings: {
110363
+ /** Pages shown as shortcuts in the console sidebar, in order. */
110364
+ sidebar_shortcuts?: string[] | undefined
110365
+ /** Resources pinned in the console sidebar, in order. */
110366
+ pinned_resources?:
110367
+ | {
110368
+ resource_type:
110369
+ | 'device'
110370
+ | 'space'
110371
+ | 'access_grant'
110372
+ | 'access_code'
110373
+ | 'reservation'
110374
+ | 'user_identity'
110375
+ | 'connected_account'
110376
+ | 'acs_system'
110377
+ resource_id: string
110378
+ /** Name shown in the sidebar, as it was when pinned. */
110379
+ display_name: string
110380
+ }[]
110381
+ | undefined
110382
+ /** Customer the console was last scoped to. `null` means all customers. */
110383
+ selected_customer_key?: (string | null) | undefined
110384
+ }
110385
+ }
110386
+ maxDuration: undefined
110387
+ }
110298
110388
  '/seam/console/v1/workspace/feature_flags/list': {
110299
110389
  route: '/seam/console/v1/workspace/feature_flags/list'
110300
110390
  method: 'GET' | 'POST'