@seamapi/types 1.349.1 → 1.351.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.
@@ -12608,6 +12608,21 @@ export interface Routes {
12608
12608
  };
12609
12609
  };
12610
12610
  };
12611
+ '/bridges/list': {
12612
+ route: '/bridges/list';
12613
+ method: 'GET' | 'POST';
12614
+ queryParams: {};
12615
+ jsonBody: {};
12616
+ commonParams: {};
12617
+ formData: {};
12618
+ jsonResponse: {
12619
+ bridges: Array<{
12620
+ bridge_id: string;
12621
+ workspace_id: string;
12622
+ created_at: string;
12623
+ }>;
12624
+ };
12625
+ };
12611
12626
  '/client_sessions/create': {
12612
12627
  route: '/client_sessions/create';
12613
12628
  method: 'POST' | 'PUT';
@@ -25902,6 +25917,66 @@ export interface Routes {
25902
25917
  formData: {};
25903
25918
  jsonResponse: {};
25904
25919
  };
25920
+ '/phones/get': {
25921
+ route: '/phones/get';
25922
+ method: 'GET' | 'POST';
25923
+ queryParams: {};
25924
+ jsonBody: {};
25925
+ commonParams: {
25926
+ /** Device ID of the desired phone. */
25927
+ device_id: string;
25928
+ };
25929
+ formData: {};
25930
+ jsonResponse: {
25931
+ /** Represents an app user's mobile phone. */
25932
+ phone: {
25933
+ /** ID of the `phone`. */
25934
+ device_id: string;
25935
+ /** Optional nickname to describe the phone, settable through Seam. */
25936
+ nickname?: string | undefined;
25937
+ /** Display name of the phone. Defaults to `nickname` (if it is set) or `properties.appearance.name` otherwise. Enables administrators and users to identify the phone easily, especially when there are numerous phones. */
25938
+ display_name: string;
25939
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `phone`. */
25940
+ workspace_id: string;
25941
+ /** Date and time at which the `phone` was created. */
25942
+ created_at: string;
25943
+ /** Optional [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) for the phone. */
25944
+ custom_metadata: Record<string, string | boolean>;
25945
+ /** Errors associated with the `phone`. */
25946
+ errors: Array<{
25947
+ error_code: string;
25948
+ message: string;
25949
+ }>;
25950
+ /** Warnings associated with the `phone`. */
25951
+ warnings: Array<{
25952
+ warning_code: string;
25953
+ message: string;
25954
+ }>;
25955
+ /** Type of phone. */
25956
+ device_type: 'ios_phone' | 'android_phone';
25957
+ /** Properties of the phone. */
25958
+ properties: {
25959
+ /** ASSA ABLOY Credential Service metadata for the phone. */
25960
+ assa_abloy_credential_service_metadata?: {
25961
+ /** Indicates whether the credential service has active endpoints associated with the phone. */
25962
+ has_active_endpoint: boolean;
25963
+ /** Endpoints associated with the phone. */
25964
+ endpoints: Array<{
25965
+ /** ID of the associated endpoint. */
25966
+ endpoint_id: string;
25967
+ /** Indicated whether the endpoint is active. */
25968
+ is_active: boolean;
25969
+ }>;
25970
+ } | undefined;
25971
+ /** Salto Space credential service metadata for the phone. */
25972
+ salto_space_credential_service_metadata?: {
25973
+ /** Indicates whether the credential service has an active associated phone. */
25974
+ has_active_phone: boolean;
25975
+ } | undefined;
25976
+ };
25977
+ };
25978
+ };
25979
+ };
25905
25980
  '/phones/list': {
25906
25981
  route: '/phones/list';
25907
25982
  method: 'GET' | 'POST';
@@ -26101,6 +26176,29 @@ export interface Routes {
26101
26176
  };
26102
26177
  };
26103
26178
  };
26179
+ '/seam/bridge/v1/bridge_client_sessions/regenerate_pairing_code': {
26180
+ route: '/seam/bridge/v1/bridge_client_sessions/regenerate_pairing_code';
26181
+ method: 'POST';
26182
+ queryParams: {};
26183
+ jsonBody: {};
26184
+ commonParams: {};
26185
+ formData: {};
26186
+ jsonResponse: {
26187
+ /** */
26188
+ bridge_client_session: {
26189
+ created_at: string;
26190
+ bridge_client_session_id: string;
26191
+ bridge_client_session_token: string;
26192
+ pairing_code: string;
26193
+ pairing_code_expires_at: string;
26194
+ tailscale_hostname: string;
26195
+ tailscale_auth_key: string | null;
26196
+ bridge_client_name: string;
26197
+ bridge_client_time_zone: string;
26198
+ bridge_client_machine_identifier_key: string;
26199
+ };
26200
+ };
26201
+ };
26104
26202
  '/thermostats/activate_climate_preset': {
26105
26203
  route: '/thermostats/activate_climate_preset';
26106
26204
  method: 'POST';
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.349.1",
3
+ "version": "1.351.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -19463,6 +19463,59 @@ export default {
19463
19463
  'x-response-key': 'bridge',
19464
19464
  },
19465
19465
  },
19466
+ '/bridges/list': {
19467
+ post: {
19468
+ operationId: 'bridgesListPost',
19469
+ requestBody: {
19470
+ content: {
19471
+ 'application/json': { schema: { properties: {}, type: 'object' } },
19472
+ },
19473
+ },
19474
+ responses: {
19475
+ 200: {
19476
+ content: {
19477
+ 'application/json': {
19478
+ schema: {
19479
+ properties: {
19480
+ bridges: {
19481
+ items: {
19482
+ properties: {
19483
+ bridge_id: { format: 'uuid', type: 'string' },
19484
+ created_at: { format: 'date-time', type: 'string' },
19485
+ workspace_id: { format: 'uuid', type: 'string' },
19486
+ },
19487
+ required: ['bridge_id', 'workspace_id', 'created_at'],
19488
+ type: 'object',
19489
+ 'x-route-path': '/bridges',
19490
+ 'x-undocumented': 'Unreleased.',
19491
+ },
19492
+ type: 'array',
19493
+ },
19494
+ ok: { type: 'boolean' },
19495
+ },
19496
+ required: ['bridges', 'ok'],
19497
+ type: 'object',
19498
+ },
19499
+ },
19500
+ },
19501
+ description: 'OK',
19502
+ },
19503
+ 400: { description: 'Bad Request' },
19504
+ 401: { description: 'Unauthorized' },
19505
+ },
19506
+ security: [
19507
+ { pat_with_workspace: [] },
19508
+ { console_session_with_workspace: [] },
19509
+ { api_key: [] },
19510
+ ],
19511
+ summary: '/bridges/list',
19512
+ tags: [],
19513
+ 'x-fern-sdk-group-name': ['bridges'],
19514
+ 'x-fern-sdk-method-name': 'list',
19515
+ 'x-fern-sdk-return-value': 'bridges',
19516
+ 'x-response-key': 'bridges',
19517
+ },
19518
+ },
19466
19519
  '/client_sessions/create': {
19467
19520
  post: {
19468
19521
  operationId: 'clientSessionsCreatePost',
@@ -23227,6 +23280,61 @@ export default {
23227
23280
  'x-title': 'Deactivate a Phone',
23228
23281
  },
23229
23282
  },
23283
+ '/phones/get': {
23284
+ post: {
23285
+ description:
23286
+ 'Returns a single phone entry matching the provided `device_id`.',
23287
+ operationId: 'phonesGetPost',
23288
+ requestBody: {
23289
+ content: {
23290
+ 'application/json': {
23291
+ schema: {
23292
+ properties: {
23293
+ device_id: {
23294
+ description: 'Device ID of the desired phone.',
23295
+ format: 'uuid',
23296
+ type: 'string',
23297
+ },
23298
+ },
23299
+ required: ['device_id'],
23300
+ type: 'object',
23301
+ },
23302
+ },
23303
+ },
23304
+ },
23305
+ responses: {
23306
+ 200: {
23307
+ content: {
23308
+ 'application/json': {
23309
+ schema: {
23310
+ properties: {
23311
+ ok: { type: 'boolean' },
23312
+ phone: { $ref: '#/components/schemas/phone' },
23313
+ },
23314
+ required: ['phone', 'ok'],
23315
+ type: 'object',
23316
+ },
23317
+ },
23318
+ },
23319
+ description: 'OK',
23320
+ },
23321
+ 400: { description: 'Bad Request' },
23322
+ 401: { description: 'Unauthorized' },
23323
+ },
23324
+ security: [
23325
+ { api_key: [] },
23326
+ { pat_with_workspace: [] },
23327
+ { console_session_with_workspace: [] },
23328
+ ],
23329
+ summary: '/phones/get',
23330
+ tags: ['/phones'],
23331
+ 'x-fern-sdk-group-name': ['phones'],
23332
+ 'x-fern-sdk-method-name': 'get',
23333
+ 'x-fern-sdk-return-value': 'phone',
23334
+ 'x-response-key': 'phone',
23335
+ 'x-title': 'Get Phone',
23336
+ },
23337
+ },
23230
23338
  '/phones/list': {
23231
23339
  post: {
23232
23340
  description:
@@ -23673,6 +23781,86 @@ export default {
23673
23781
  'x-title': 'Get a Bridge Client Session',
23674
23782
  },
23675
23783
  },
23784
+ '/seam/bridge/v1/bridge_client_sessions/regenerate_pairing_code': {
23785
+ post: {
23786
+ description:
23787
+ 'Generate a new pairing code and return the updated bridge client session.',
23788
+ operationId:
23789
+ 'seamBridgeV1BridgeClientSessionsRegeneratePairingCodePost',
23790
+ responses: {
23791
+ 200: {
23792
+ content: {
23793
+ 'application/json': {
23794
+ schema: {
23795
+ properties: {
23796
+ bridge_client_session: {
23797
+ properties: {
23798
+ bridge_client_machine_identifier_key: {
23799
+ type: 'string',
23800
+ },
23801
+ bridge_client_name: { type: 'string' },
23802
+ bridge_client_session_id: {
23803
+ format: 'uuid',
23804
+ type: 'string',
23805
+ },
23806
+ bridge_client_session_token: { type: 'string' },
23807
+ bridge_client_time_zone: { type: 'string' },
23808
+ created_at: { format: 'date-time', type: 'string' },
23809
+ pairing_code: {
23810
+ maxLength: 6,
23811
+ minLength: 6,
23812
+ type: 'string',
23813
+ },
23814
+ pairing_code_expires_at: {
23815
+ format: 'date-time',
23816
+ type: 'string',
23817
+ },
23818
+ tailscale_auth_key: { nullable: true, type: 'string' },
23819
+ tailscale_hostname: { type: 'string' },
23820
+ },
23821
+ required: [
23822
+ 'created_at',
23823
+ 'bridge_client_session_id',
23824
+ 'bridge_client_session_token',
23825
+ 'pairing_code',
23826
+ 'pairing_code_expires_at',
23827
+ 'tailscale_hostname',
23828
+ 'tailscale_auth_key',
23829
+ 'bridge_client_name',
23830
+ 'bridge_client_time_zone',
23831
+ 'bridge_client_machine_identifier_key',
23832
+ ],
23833
+ type: 'object',
23834
+ 'x-route-path': '/seam/bridge/v1/bridge_client_sessions',
23835
+ },
23836
+ ok: { type: 'boolean' },
23837
+ },
23838
+ required: ['bridge_client_session', 'ok'],
23839
+ type: 'object',
23840
+ },
23841
+ },
23842
+ },
23843
+ description: 'OK',
23844
+ },
23845
+ 400: { description: 'Bad Request' },
23846
+ 401: { description: 'Unauthorized' },
23847
+ },
23848
+ security: [{ bridge_client_session: [] }],
23849
+ summary:
23850
+ '/seam/bridge/v1/bridge_client_sessions/regenerate_pairing_code',
23851
+ tags: [],
23852
+ 'x-fern-sdk-group-name': [
23853
+ 'seam',
23854
+ 'bridge',
23855
+ 'v1',
23856
+ 'bridge_client_sessions',
23857
+ ],
23858
+ 'x-fern-sdk-method-name': 'regenerate_pairing_code',
23859
+ 'x-fern-sdk-return-value': 'bridge_client_session',
23860
+ 'x-response-key': 'bridge_client_session',
23861
+ 'x-title': 'Regenerate a Bridge Client Session Pairing Code',
23862
+ },
23863
+ },
23676
23864
  '/thermostats/activate_climate_preset': {
23677
23865
  post: {
23678
23866
  description:
@@ -15101,6 +15101,21 @@ export interface Routes {
15101
15101
  }
15102
15102
  }
15103
15103
  }
15104
+ '/bridges/list': {
15105
+ route: '/bridges/list'
15106
+ method: 'GET' | 'POST'
15107
+ queryParams: {}
15108
+ jsonBody: {}
15109
+ commonParams: {}
15110
+ formData: {}
15111
+ jsonResponse: {
15112
+ bridges: Array<{
15113
+ bridge_id: string
15114
+ workspace_id: string
15115
+ created_at: string
15116
+ }>
15117
+ }
15118
+ }
15104
15119
  '/client_sessions/create': {
15105
15120
  route: '/client_sessions/create'
15106
15121
  method: 'POST' | 'PUT'
@@ -32226,6 +32241,70 @@ export interface Routes {
32226
32241
  formData: {}
32227
32242
  jsonResponse: {}
32228
32243
  }
32244
+ '/phones/get': {
32245
+ route: '/phones/get'
32246
+ method: 'GET' | 'POST'
32247
+ queryParams: {}
32248
+ jsonBody: {}
32249
+ commonParams: {
32250
+ /** Device ID of the desired phone. */
32251
+ device_id: string
32252
+ }
32253
+ formData: {}
32254
+ jsonResponse: {
32255
+ /** Represents an app user's mobile phone. */
32256
+ phone: {
32257
+ /** ID of the `phone`. */
32258
+ device_id: string
32259
+ /** Optional nickname to describe the phone, settable through Seam. */
32260
+ nickname?: string | undefined
32261
+ /** Display name of the phone. Defaults to `nickname` (if it is set) or `properties.appearance.name` otherwise. Enables administrators and users to identify the phone easily, especially when there are numerous phones. */
32262
+ display_name: string
32263
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `phone`. */
32264
+ workspace_id: string
32265
+ /** Date and time at which the `phone` was created. */
32266
+ created_at: string
32267
+ /** Optional [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) for the phone. */
32268
+ custom_metadata: Record<string, string | boolean>
32269
+ /** Errors associated with the `phone`. */
32270
+ errors: Array<{
32271
+ error_code: string
32272
+ message: string
32273
+ }>
32274
+ /** Warnings associated with the `phone`. */
32275
+ warnings: Array<{
32276
+ warning_code: string
32277
+ message: string
32278
+ }>
32279
+ /** Type of phone. */
32280
+ device_type: 'ios_phone' | 'android_phone'
32281
+ /** Properties of the phone. */
32282
+ properties: {
32283
+ /** ASSA ABLOY Credential Service metadata for the phone. */
32284
+ assa_abloy_credential_service_metadata?:
32285
+ | {
32286
+ /** Indicates whether the credential service has active endpoints associated with the phone. */
32287
+ has_active_endpoint: boolean
32288
+ /** Endpoints associated with the phone. */
32289
+ endpoints: Array<{
32290
+ /** ID of the associated endpoint. */
32291
+ endpoint_id: string
32292
+ /** Indicated whether the endpoint is active. */
32293
+ is_active: boolean
32294
+ }>
32295
+ }
32296
+ | undefined
32297
+ /** Salto Space credential service metadata for the phone. */
32298
+ salto_space_credential_service_metadata?:
32299
+ | {
32300
+ /** Indicates whether the credential service has an active associated phone. */
32301
+ has_active_phone: boolean
32302
+ }
32303
+ | undefined
32304
+ }
32305
+ }
32306
+ }
32307
+ }
32229
32308
  '/phones/list': {
32230
32309
  route: '/phones/list'
32231
32310
  method: 'GET' | 'POST'
@@ -32433,6 +32512,29 @@ export interface Routes {
32433
32512
  }
32434
32513
  }
32435
32514
  }
32515
+ '/seam/bridge/v1/bridge_client_sessions/regenerate_pairing_code': {
32516
+ route: '/seam/bridge/v1/bridge_client_sessions/regenerate_pairing_code'
32517
+ method: 'POST'
32518
+ queryParams: {}
32519
+ jsonBody: {}
32520
+ commonParams: {}
32521
+ formData: {}
32522
+ jsonResponse: {
32523
+ /** */
32524
+ bridge_client_session: {
32525
+ created_at: string
32526
+ bridge_client_session_id: string
32527
+ bridge_client_session_token: string
32528
+ pairing_code: string
32529
+ pairing_code_expires_at: string
32530
+ tailscale_hostname: string
32531
+ tailscale_auth_key: string | null
32532
+ bridge_client_name: string
32533
+ bridge_client_time_zone: string
32534
+ bridge_client_machine_identifier_key: string
32535
+ }
32536
+ }
32537
+ }
32436
32538
  '/thermostats/activate_climate_preset': {
32437
32539
  route: '/thermostats/activate_climate_preset'
32438
32540
  method: 'POST'