@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.
@@ -31389,6 +31389,87 @@ declare const _default: {
31389
31389
  'x-response-key': string;
31390
31390
  };
31391
31391
  };
31392
+ '/bridges/list': {
31393
+ post: {
31394
+ operationId: string;
31395
+ requestBody: {
31396
+ content: {
31397
+ 'application/json': {
31398
+ schema: {
31399
+ properties: {};
31400
+ type: string;
31401
+ };
31402
+ };
31403
+ };
31404
+ };
31405
+ responses: {
31406
+ 200: {
31407
+ content: {
31408
+ 'application/json': {
31409
+ schema: {
31410
+ properties: {
31411
+ bridges: {
31412
+ items: {
31413
+ properties: {
31414
+ bridge_id: {
31415
+ format: string;
31416
+ type: string;
31417
+ };
31418
+ created_at: {
31419
+ format: string;
31420
+ type: string;
31421
+ };
31422
+ workspace_id: {
31423
+ format: string;
31424
+ type: string;
31425
+ };
31426
+ };
31427
+ required: string[];
31428
+ type: string;
31429
+ 'x-route-path': string;
31430
+ 'x-undocumented': string;
31431
+ };
31432
+ type: string;
31433
+ };
31434
+ ok: {
31435
+ type: string;
31436
+ };
31437
+ };
31438
+ required: string[];
31439
+ type: string;
31440
+ };
31441
+ };
31442
+ };
31443
+ description: string;
31444
+ };
31445
+ 400: {
31446
+ description: string;
31447
+ };
31448
+ 401: {
31449
+ description: string;
31450
+ };
31451
+ };
31452
+ security: ({
31453
+ pat_with_workspace: never[];
31454
+ console_session_with_workspace?: never;
31455
+ api_key?: never;
31456
+ } | {
31457
+ console_session_with_workspace: never[];
31458
+ pat_with_workspace?: never;
31459
+ api_key?: never;
31460
+ } | {
31461
+ api_key: never[];
31462
+ pat_with_workspace?: never;
31463
+ console_session_with_workspace?: never;
31464
+ })[];
31465
+ summary: string;
31466
+ tags: never[];
31467
+ 'x-fern-sdk-group-name': string[];
31468
+ 'x-fern-sdk-method-name': string;
31469
+ 'x-fern-sdk-return-value': string;
31470
+ 'x-response-key': string;
31471
+ };
31472
+ };
31392
31473
  '/client_sessions/create': {
31393
31474
  post: {
31394
31475
  operationId: string;
@@ -35611,6 +35692,76 @@ declare const _default: {
35611
35692
  'x-title': string;
35612
35693
  };
35613
35694
  };
35695
+ '/phones/get': {
35696
+ post: {
35697
+ description: string;
35698
+ operationId: string;
35699
+ requestBody: {
35700
+ content: {
35701
+ 'application/json': {
35702
+ schema: {
35703
+ properties: {
35704
+ device_id: {
35705
+ description: string;
35706
+ format: string;
35707
+ type: string;
35708
+ };
35709
+ };
35710
+ required: string[];
35711
+ type: string;
35712
+ };
35713
+ };
35714
+ };
35715
+ };
35716
+ responses: {
35717
+ 200: {
35718
+ content: {
35719
+ 'application/json': {
35720
+ schema: {
35721
+ properties: {
35722
+ ok: {
35723
+ type: string;
35724
+ };
35725
+ phone: {
35726
+ $ref: string;
35727
+ };
35728
+ };
35729
+ required: string[];
35730
+ type: string;
35731
+ };
35732
+ };
35733
+ };
35734
+ description: string;
35735
+ };
35736
+ 400: {
35737
+ description: string;
35738
+ };
35739
+ 401: {
35740
+ description: string;
35741
+ };
35742
+ };
35743
+ security: ({
35744
+ api_key: never[];
35745
+ pat_with_workspace?: never;
35746
+ console_session_with_workspace?: never;
35747
+ } | {
35748
+ pat_with_workspace: never[];
35749
+ api_key?: never;
35750
+ console_session_with_workspace?: never;
35751
+ } | {
35752
+ console_session_with_workspace: never[];
35753
+ api_key?: never;
35754
+ pat_with_workspace?: never;
35755
+ })[];
35756
+ summary: string;
35757
+ tags: string[];
35758
+ 'x-fern-sdk-group-name': string[];
35759
+ 'x-fern-sdk-method-name': string;
35760
+ 'x-fern-sdk-return-value': string;
35761
+ 'x-response-key': string;
35762
+ 'x-title': string;
35763
+ };
35764
+ };
35614
35765
  '/phones/list': {
35615
35766
  post: {
35616
35767
  description: string;
@@ -36094,6 +36245,89 @@ declare const _default: {
36094
36245
  'x-title': string;
36095
36246
  };
36096
36247
  };
36248
+ '/seam/bridge/v1/bridge_client_sessions/regenerate_pairing_code': {
36249
+ post: {
36250
+ description: string;
36251
+ operationId: string;
36252
+ responses: {
36253
+ 200: {
36254
+ content: {
36255
+ 'application/json': {
36256
+ schema: {
36257
+ properties: {
36258
+ bridge_client_session: {
36259
+ properties: {
36260
+ bridge_client_machine_identifier_key: {
36261
+ type: string;
36262
+ };
36263
+ bridge_client_name: {
36264
+ type: string;
36265
+ };
36266
+ bridge_client_session_id: {
36267
+ format: string;
36268
+ type: string;
36269
+ };
36270
+ bridge_client_session_token: {
36271
+ type: string;
36272
+ };
36273
+ bridge_client_time_zone: {
36274
+ type: string;
36275
+ };
36276
+ created_at: {
36277
+ format: string;
36278
+ type: string;
36279
+ };
36280
+ pairing_code: {
36281
+ maxLength: number;
36282
+ minLength: number;
36283
+ type: string;
36284
+ };
36285
+ pairing_code_expires_at: {
36286
+ format: string;
36287
+ type: string;
36288
+ };
36289
+ tailscale_auth_key: {
36290
+ nullable: boolean;
36291
+ type: string;
36292
+ };
36293
+ tailscale_hostname: {
36294
+ type: string;
36295
+ };
36296
+ };
36297
+ required: string[];
36298
+ type: string;
36299
+ 'x-route-path': string;
36300
+ };
36301
+ ok: {
36302
+ type: string;
36303
+ };
36304
+ };
36305
+ required: string[];
36306
+ type: string;
36307
+ };
36308
+ };
36309
+ };
36310
+ description: string;
36311
+ };
36312
+ 400: {
36313
+ description: string;
36314
+ };
36315
+ 401: {
36316
+ description: string;
36317
+ };
36318
+ };
36319
+ security: {
36320
+ bridge_client_session: never[];
36321
+ }[];
36322
+ summary: string;
36323
+ tags: never[];
36324
+ 'x-fern-sdk-group-name': string[];
36325
+ 'x-fern-sdk-method-name': string;
36326
+ 'x-fern-sdk-return-value': string;
36327
+ 'x-response-key': string;
36328
+ 'x-title': string;
36329
+ };
36330
+ };
36097
36331
  '/thermostats/activate_climate_preset': {
36098
36332
  post: {
36099
36333
  description: string;
@@ -53478,6 +53712,21 @@ interface Routes {
53478
53712
  };
53479
53713
  };
53480
53714
  };
53715
+ '/bridges/list': {
53716
+ route: '/bridges/list';
53717
+ method: 'GET' | 'POST';
53718
+ queryParams: {};
53719
+ jsonBody: {};
53720
+ commonParams: {};
53721
+ formData: {};
53722
+ jsonResponse: {
53723
+ bridges: Array<{
53724
+ bridge_id: string;
53725
+ workspace_id: string;
53726
+ created_at: string;
53727
+ }>;
53728
+ };
53729
+ };
53481
53730
  '/client_sessions/create': {
53482
53731
  route: '/client_sessions/create';
53483
53732
  method: 'POST' | 'PUT';
@@ -66772,6 +67021,66 @@ interface Routes {
66772
67021
  formData: {};
66773
67022
  jsonResponse: {};
66774
67023
  };
67024
+ '/phones/get': {
67025
+ route: '/phones/get';
67026
+ method: 'GET' | 'POST';
67027
+ queryParams: {};
67028
+ jsonBody: {};
67029
+ commonParams: {
67030
+ /** Device ID of the desired phone. */
67031
+ device_id: string;
67032
+ };
67033
+ formData: {};
67034
+ jsonResponse: {
67035
+ /** Represents an app user's mobile phone. */
67036
+ phone: {
67037
+ /** ID of the `phone`. */
67038
+ device_id: string;
67039
+ /** Optional nickname to describe the phone, settable through Seam. */
67040
+ nickname?: string | undefined;
67041
+ /** 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. */
67042
+ display_name: string;
67043
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `phone`. */
67044
+ workspace_id: string;
67045
+ /** Date and time at which the `phone` was created. */
67046
+ created_at: string;
67047
+ /** Optional [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) for the phone. */
67048
+ custom_metadata: Record<string, string | boolean>;
67049
+ /** Errors associated with the `phone`. */
67050
+ errors: Array<{
67051
+ error_code: string;
67052
+ message: string;
67053
+ }>;
67054
+ /** Warnings associated with the `phone`. */
67055
+ warnings: Array<{
67056
+ warning_code: string;
67057
+ message: string;
67058
+ }>;
67059
+ /** Type of phone. */
67060
+ device_type: 'ios_phone' | 'android_phone';
67061
+ /** Properties of the phone. */
67062
+ properties: {
67063
+ /** ASSA ABLOY Credential Service metadata for the phone. */
67064
+ assa_abloy_credential_service_metadata?: {
67065
+ /** Indicates whether the credential service has active endpoints associated with the phone. */
67066
+ has_active_endpoint: boolean;
67067
+ /** Endpoints associated with the phone. */
67068
+ endpoints: Array<{
67069
+ /** ID of the associated endpoint. */
67070
+ endpoint_id: string;
67071
+ /** Indicated whether the endpoint is active. */
67072
+ is_active: boolean;
67073
+ }>;
67074
+ } | undefined;
67075
+ /** Salto Space credential service metadata for the phone. */
67076
+ salto_space_credential_service_metadata?: {
67077
+ /** Indicates whether the credential service has an active associated phone. */
67078
+ has_active_phone: boolean;
67079
+ } | undefined;
67080
+ };
67081
+ };
67082
+ };
67083
+ };
66775
67084
  '/phones/list': {
66776
67085
  route: '/phones/list';
66777
67086
  method: 'GET' | 'POST';
@@ -66971,6 +67280,29 @@ interface Routes {
66971
67280
  };
66972
67281
  };
66973
67282
  };
67283
+ '/seam/bridge/v1/bridge_client_sessions/regenerate_pairing_code': {
67284
+ route: '/seam/bridge/v1/bridge_client_sessions/regenerate_pairing_code';
67285
+ method: 'POST';
67286
+ queryParams: {};
67287
+ jsonBody: {};
67288
+ commonParams: {};
67289
+ formData: {};
67290
+ jsonResponse: {
67291
+ /** */
67292
+ bridge_client_session: {
67293
+ created_at: string;
67294
+ bridge_client_session_id: string;
67295
+ bridge_client_session_token: string;
67296
+ pairing_code: string;
67297
+ pairing_code_expires_at: string;
67298
+ tailscale_hostname: string;
67299
+ tailscale_auth_key: string | null;
67300
+ bridge_client_name: string;
67301
+ bridge_client_time_zone: string;
67302
+ bridge_client_machine_identifier_key: string;
67303
+ };
67304
+ };
67305
+ };
66974
67306
  '/thermostats/activate_climate_preset': {
66975
67307
  route: '/thermostats/activate_climate_preset';
66976
67308
  method: 'POST';
@@ -14788,6 +14788,87 @@ declare const _default: {
14788
14788
  'x-response-key': string;
14789
14789
  };
14790
14790
  };
14791
+ '/bridges/list': {
14792
+ post: {
14793
+ operationId: string;
14794
+ requestBody: {
14795
+ content: {
14796
+ 'application/json': {
14797
+ schema: {
14798
+ properties: {};
14799
+ type: string;
14800
+ };
14801
+ };
14802
+ };
14803
+ };
14804
+ responses: {
14805
+ 200: {
14806
+ content: {
14807
+ 'application/json': {
14808
+ schema: {
14809
+ properties: {
14810
+ bridges: {
14811
+ items: {
14812
+ properties: {
14813
+ bridge_id: {
14814
+ format: string;
14815
+ type: string;
14816
+ };
14817
+ created_at: {
14818
+ format: string;
14819
+ type: string;
14820
+ };
14821
+ workspace_id: {
14822
+ format: string;
14823
+ type: string;
14824
+ };
14825
+ };
14826
+ required: string[];
14827
+ type: string;
14828
+ 'x-route-path': string;
14829
+ 'x-undocumented': string;
14830
+ };
14831
+ type: string;
14832
+ };
14833
+ ok: {
14834
+ type: string;
14835
+ };
14836
+ };
14837
+ required: string[];
14838
+ type: string;
14839
+ };
14840
+ };
14841
+ };
14842
+ description: string;
14843
+ };
14844
+ 400: {
14845
+ description: string;
14846
+ };
14847
+ 401: {
14848
+ description: string;
14849
+ };
14850
+ };
14851
+ security: ({
14852
+ pat_with_workspace: never[];
14853
+ console_session_with_workspace?: never;
14854
+ api_key?: never;
14855
+ } | {
14856
+ console_session_with_workspace: never[];
14857
+ pat_with_workspace?: never;
14858
+ api_key?: never;
14859
+ } | {
14860
+ api_key: never[];
14861
+ pat_with_workspace?: never;
14862
+ console_session_with_workspace?: never;
14863
+ })[];
14864
+ summary: string;
14865
+ tags: never[];
14866
+ 'x-fern-sdk-group-name': string[];
14867
+ 'x-fern-sdk-method-name': string;
14868
+ 'x-fern-sdk-return-value': string;
14869
+ 'x-response-key': string;
14870
+ };
14871
+ };
14791
14872
  '/client_sessions/create': {
14792
14873
  post: {
14793
14874
  operationId: string;
@@ -19010,6 +19091,76 @@ declare const _default: {
19010
19091
  'x-title': string;
19011
19092
  };
19012
19093
  };
19094
+ '/phones/get': {
19095
+ post: {
19096
+ description: string;
19097
+ operationId: string;
19098
+ requestBody: {
19099
+ content: {
19100
+ 'application/json': {
19101
+ schema: {
19102
+ properties: {
19103
+ device_id: {
19104
+ description: string;
19105
+ format: string;
19106
+ type: string;
19107
+ };
19108
+ };
19109
+ required: string[];
19110
+ type: string;
19111
+ };
19112
+ };
19113
+ };
19114
+ };
19115
+ responses: {
19116
+ 200: {
19117
+ content: {
19118
+ 'application/json': {
19119
+ schema: {
19120
+ properties: {
19121
+ ok: {
19122
+ type: string;
19123
+ };
19124
+ phone: {
19125
+ $ref: string;
19126
+ };
19127
+ };
19128
+ required: string[];
19129
+ type: string;
19130
+ };
19131
+ };
19132
+ };
19133
+ description: string;
19134
+ };
19135
+ 400: {
19136
+ description: string;
19137
+ };
19138
+ 401: {
19139
+ description: string;
19140
+ };
19141
+ };
19142
+ security: ({
19143
+ api_key: never[];
19144
+ pat_with_workspace?: never;
19145
+ console_session_with_workspace?: never;
19146
+ } | {
19147
+ pat_with_workspace: never[];
19148
+ api_key?: never;
19149
+ console_session_with_workspace?: never;
19150
+ } | {
19151
+ console_session_with_workspace: never[];
19152
+ api_key?: never;
19153
+ pat_with_workspace?: never;
19154
+ })[];
19155
+ summary: string;
19156
+ tags: string[];
19157
+ 'x-fern-sdk-group-name': string[];
19158
+ 'x-fern-sdk-method-name': string;
19159
+ 'x-fern-sdk-return-value': string;
19160
+ 'x-response-key': string;
19161
+ 'x-title': string;
19162
+ };
19163
+ };
19013
19164
  '/phones/list': {
19014
19165
  post: {
19015
19166
  description: string;
@@ -19493,6 +19644,89 @@ declare const _default: {
19493
19644
  'x-title': string;
19494
19645
  };
19495
19646
  };
19647
+ '/seam/bridge/v1/bridge_client_sessions/regenerate_pairing_code': {
19648
+ post: {
19649
+ description: string;
19650
+ operationId: string;
19651
+ responses: {
19652
+ 200: {
19653
+ content: {
19654
+ 'application/json': {
19655
+ schema: {
19656
+ properties: {
19657
+ bridge_client_session: {
19658
+ properties: {
19659
+ bridge_client_machine_identifier_key: {
19660
+ type: string;
19661
+ };
19662
+ bridge_client_name: {
19663
+ type: string;
19664
+ };
19665
+ bridge_client_session_id: {
19666
+ format: string;
19667
+ type: string;
19668
+ };
19669
+ bridge_client_session_token: {
19670
+ type: string;
19671
+ };
19672
+ bridge_client_time_zone: {
19673
+ type: string;
19674
+ };
19675
+ created_at: {
19676
+ format: string;
19677
+ type: string;
19678
+ };
19679
+ pairing_code: {
19680
+ maxLength: number;
19681
+ minLength: number;
19682
+ type: string;
19683
+ };
19684
+ pairing_code_expires_at: {
19685
+ format: string;
19686
+ type: string;
19687
+ };
19688
+ tailscale_auth_key: {
19689
+ nullable: boolean;
19690
+ type: string;
19691
+ };
19692
+ tailscale_hostname: {
19693
+ type: string;
19694
+ };
19695
+ };
19696
+ required: string[];
19697
+ type: string;
19698
+ 'x-route-path': string;
19699
+ };
19700
+ ok: {
19701
+ type: string;
19702
+ };
19703
+ };
19704
+ required: string[];
19705
+ type: string;
19706
+ };
19707
+ };
19708
+ };
19709
+ description: string;
19710
+ };
19711
+ 400: {
19712
+ description: string;
19713
+ };
19714
+ 401: {
19715
+ description: string;
19716
+ };
19717
+ };
19718
+ security: {
19719
+ bridge_client_session: never[];
19720
+ }[];
19721
+ summary: string;
19722
+ tags: never[];
19723
+ 'x-fern-sdk-group-name': string[];
19724
+ 'x-fern-sdk-method-name': string;
19725
+ 'x-fern-sdk-return-value': string;
19726
+ 'x-response-key': string;
19727
+ 'x-title': string;
19728
+ };
19729
+ };
19496
19730
  '/thermostats/activate_climate_preset': {
19497
19731
  post: {
19498
19732
  description: string;