@seamapi/types 1.1123.0 → 1.1125.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/customer/customer-portal.d.ts +14 -0
- package/lib/seam/connect/models/customer/customer-portal.js +5 -0
- package/lib/seam/connect/models/customer/customer-portal.js.map +1 -1
- package/lib/seam/connect/models/devices/device-provider.d.ts +6 -0
- package/lib/seam/connect/models/devices/device.d.ts +12 -0
- package/lib/seam/connect/models/devices/device.js +8 -2
- package/lib/seam/connect/models/devices/device.js.map +1 -1
- package/lib/seam/connect/models/devices/unmanaged-device.d.ts +8 -0
- package/lib/seam/connect/openapi.js +57 -79
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +136 -66
- package/package.json +1 -1
- package/src/lib/seam/connect/models/customer/customer-portal.ts +7 -0
- package/src/lib/seam/connect/models/devices/device.ts +8 -4
- package/src/lib/seam/connect/openapi.ts +63 -85
- package/src/lib/seam/connect/route-types.ts +140 -62
|
@@ -14977,13 +14977,12 @@ const openapi: OpenAPISpec = {
|
|
|
14977
14977
|
type: 'boolean',
|
|
14978
14978
|
},
|
|
14979
14979
|
can_mute_speaker: {
|
|
14980
|
-
description:
|
|
14981
|
-
'Indicates whether the speaker supports muting and unmuting.',
|
|
14980
|
+
description: 'Indicates whether the speaker supports muting.',
|
|
14982
14981
|
type: 'boolean',
|
|
14983
14982
|
},
|
|
14984
14983
|
can_pause_speaker_playback: {
|
|
14985
14984
|
description:
|
|
14986
|
-
'Indicates whether the speaker supports pausing
|
|
14985
|
+
'Indicates whether the speaker supports pausing playback.',
|
|
14987
14986
|
type: 'boolean',
|
|
14988
14987
|
},
|
|
14989
14988
|
can_play_speaker_chime: {
|
|
@@ -15026,6 +15025,11 @@ const openapi: OpenAPISpec = {
|
|
|
15026
15025
|
'Indicates whether the device supports remote unlocking.',
|
|
15027
15026
|
type: 'boolean',
|
|
15028
15027
|
},
|
|
15028
|
+
can_resume_speaker_playback: {
|
|
15029
|
+
description:
|
|
15030
|
+
'Indicates whether the speaker supports resuming playback.',
|
|
15031
|
+
type: 'boolean',
|
|
15032
|
+
},
|
|
15029
15033
|
can_run_thermostat_programs: {
|
|
15030
15034
|
description:
|
|
15031
15035
|
'Indicates whether the thermostat supports running climate programs.',
|
|
@@ -15080,6 +15084,10 @@ const openapi: OpenAPISpec = {
|
|
|
15080
15084
|
'Indicates whether the lock supports unlocking with an access code.',
|
|
15081
15085
|
type: 'boolean',
|
|
15082
15086
|
},
|
|
15087
|
+
can_unmute_speaker: {
|
|
15088
|
+
description: 'Indicates whether the speaker supports unmuting.',
|
|
15089
|
+
type: 'boolean',
|
|
15090
|
+
},
|
|
15083
15091
|
capabilities_supported: {
|
|
15084
15092
|
description:
|
|
15085
15093
|
'\n Collection of capabilities that the device supports when connected to Seam. Values are `access_code`, which indicates that the device can manage and utilize digital PIN codes for secure access; `lock`, which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; `noise_detection`, which indicates that the device supports monitoring and responding to ambient noise levels; `thermostat`, which indicates that the device can regulate and adjust indoor temperatures; `battery`, which indicates that the device can manage battery life and health; and `phone`, which indicates that the device is a mobile device, such as a smartphone. **Important:** Superseded by [capability flags](https://www.seam.co/docs/capability-guides/device-and-system-capabilities#capability-flags).\n ',
|
|
@@ -19759,13 +19767,12 @@ const openapi: OpenAPISpec = {
|
|
|
19759
19767
|
type: 'boolean',
|
|
19760
19768
|
},
|
|
19761
19769
|
can_mute_speaker: {
|
|
19762
|
-
description:
|
|
19763
|
-
'Indicates whether the speaker supports muting and unmuting.',
|
|
19770
|
+
description: 'Indicates whether the speaker supports muting.',
|
|
19764
19771
|
type: 'boolean',
|
|
19765
19772
|
},
|
|
19766
19773
|
can_pause_speaker_playback: {
|
|
19767
19774
|
description:
|
|
19768
|
-
'Indicates whether the speaker supports pausing
|
|
19775
|
+
'Indicates whether the speaker supports pausing playback.',
|
|
19769
19776
|
type: 'boolean',
|
|
19770
19777
|
},
|
|
19771
19778
|
can_play_speaker_chime: {
|
|
@@ -19808,6 +19815,11 @@ const openapi: OpenAPISpec = {
|
|
|
19808
19815
|
'Indicates whether the device supports remote unlocking.',
|
|
19809
19816
|
type: 'boolean',
|
|
19810
19817
|
},
|
|
19818
|
+
can_resume_speaker_playback: {
|
|
19819
|
+
description:
|
|
19820
|
+
'Indicates whether the speaker supports resuming playback.',
|
|
19821
|
+
type: 'boolean',
|
|
19822
|
+
},
|
|
19811
19823
|
can_run_thermostat_programs: {
|
|
19812
19824
|
description:
|
|
19813
19825
|
'Indicates whether the thermostat supports running climate programs.',
|
|
@@ -19862,6 +19874,10 @@ const openapi: OpenAPISpec = {
|
|
|
19862
19874
|
'Indicates whether the lock supports unlocking with an access code.',
|
|
19863
19875
|
type: 'boolean',
|
|
19864
19876
|
},
|
|
19877
|
+
can_unmute_speaker: {
|
|
19878
|
+
description: 'Indicates whether the speaker supports unmuting.',
|
|
19879
|
+
type: 'boolean',
|
|
19880
|
+
},
|
|
19865
19881
|
device_provider_name: {
|
|
19866
19882
|
description: 'Name of the device provider.',
|
|
19867
19883
|
enum: [
|
|
@@ -39702,13 +39718,12 @@ const openapi: OpenAPISpec = {
|
|
|
39702
39718
|
type: 'boolean',
|
|
39703
39719
|
},
|
|
39704
39720
|
can_mute_speaker: {
|
|
39705
|
-
description:
|
|
39706
|
-
'Indicates whether the speaker supports muting and unmuting.',
|
|
39721
|
+
description: 'Indicates whether the speaker supports muting.',
|
|
39707
39722
|
type: 'boolean',
|
|
39708
39723
|
},
|
|
39709
39724
|
can_pause_speaker_playback: {
|
|
39710
39725
|
description:
|
|
39711
|
-
'Indicates whether the speaker supports pausing
|
|
39726
|
+
'Indicates whether the speaker supports pausing playback.',
|
|
39712
39727
|
type: 'boolean',
|
|
39713
39728
|
},
|
|
39714
39729
|
can_play_speaker_chime: {
|
|
@@ -39751,6 +39766,11 @@ const openapi: OpenAPISpec = {
|
|
|
39751
39766
|
'Indicates whether the device supports remote unlocking.',
|
|
39752
39767
|
type: 'boolean',
|
|
39753
39768
|
},
|
|
39769
|
+
can_resume_speaker_playback: {
|
|
39770
|
+
description:
|
|
39771
|
+
'Indicates whether the speaker supports resuming playback.',
|
|
39772
|
+
type: 'boolean',
|
|
39773
|
+
},
|
|
39754
39774
|
can_run_thermostat_programs: {
|
|
39755
39775
|
description:
|
|
39756
39776
|
'Indicates whether the thermostat supports running climate programs.',
|
|
@@ -39805,6 +39825,10 @@ const openapi: OpenAPISpec = {
|
|
|
39805
39825
|
'Indicates whether the lock supports unlocking with an access code.',
|
|
39806
39826
|
type: 'boolean',
|
|
39807
39827
|
},
|
|
39828
|
+
can_unmute_speaker: {
|
|
39829
|
+
description: 'Indicates whether the speaker supports unmuting.',
|
|
39830
|
+
type: 'boolean',
|
|
39831
|
+
},
|
|
39808
39832
|
capabilities_supported: {
|
|
39809
39833
|
description:
|
|
39810
39834
|
'\n Collection of capabilities that the device supports when connected to Seam. Values are `access_code`, which indicates that the device can manage and utilize digital PIN codes for secure access; `lock`, which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; `noise_detection`, which indicates that the device supports monitoring and responding to ambient noise levels; `thermostat`, which indicates that the device can regulate and adjust indoor temperatures; `battery`, which indicates that the device can manage battery life and health; and `phone`, which indicates that the device is a mobile device, such as a smartphone. **Important:** Superseded by [capability flags](https://www.seam.co/docs/capability-guides/device-and-system-capabilities#capability-flags).\n ',
|
|
@@ -51581,6 +51605,7 @@ const openapi: OpenAPISpec = {
|
|
|
51581
51605
|
allow_climate_automation_rule_customization: false,
|
|
51582
51606
|
allow_instant_key_customization: false,
|
|
51583
51607
|
allow_notification_customization: false,
|
|
51608
|
+
allow_sound_automation_rule_customization: false,
|
|
51584
51609
|
exclude: false,
|
|
51585
51610
|
},
|
|
51586
51611
|
connect: { exclude: false },
|
|
@@ -51730,6 +51755,12 @@ const openapi: OpenAPISpec = {
|
|
|
51730
51755
|
'Indicates whether the customer can customize their notification settings, such as the low-battery alert threshold.',
|
|
51731
51756
|
type: 'boolean',
|
|
51732
51757
|
},
|
|
51758
|
+
allow_sound_automation_rule_customization: {
|
|
51759
|
+
default: false,
|
|
51760
|
+
description:
|
|
51761
|
+
'Indicates whether the customer can customize the sound automation rules for their properties.',
|
|
51762
|
+
type: 'boolean',
|
|
51763
|
+
},
|
|
51733
51764
|
exclude: {
|
|
51734
51765
|
default: false,
|
|
51735
51766
|
description:
|
|
@@ -54762,7 +54793,9 @@ const openapi: OpenAPISpec = {
|
|
|
54762
54793
|
'can_stream_live_video',
|
|
54763
54794
|
'can_set_speaker_volume',
|
|
54764
54795
|
'can_mute_speaker',
|
|
54796
|
+
'can_unmute_speaker',
|
|
54765
54797
|
'can_pause_speaker_playback',
|
|
54798
|
+
'can_resume_speaker_playback',
|
|
54766
54799
|
'can_play_speaker_chime',
|
|
54767
54800
|
],
|
|
54768
54801
|
type: 'string',
|
|
@@ -54801,7 +54834,9 @@ const openapi: OpenAPISpec = {
|
|
|
54801
54834
|
'can_stream_live_video',
|
|
54802
54835
|
'can_set_speaker_volume',
|
|
54803
54836
|
'can_mute_speaker',
|
|
54837
|
+
'can_unmute_speaker',
|
|
54804
54838
|
'can_pause_speaker_playback',
|
|
54839
|
+
'can_resume_speaker_playback',
|
|
54805
54840
|
'can_play_speaker_chime',
|
|
54806
54841
|
],
|
|
54807
54842
|
type: 'string',
|
|
@@ -57065,7 +57100,9 @@ const openapi: OpenAPISpec = {
|
|
|
57065
57100
|
'can_stream_live_video',
|
|
57066
57101
|
'can_set_speaker_volume',
|
|
57067
57102
|
'can_mute_speaker',
|
|
57103
|
+
'can_unmute_speaker',
|
|
57068
57104
|
'can_pause_speaker_playback',
|
|
57105
|
+
'can_resume_speaker_playback',
|
|
57069
57106
|
'can_play_speaker_chime',
|
|
57070
57107
|
],
|
|
57071
57108
|
type: 'string',
|
|
@@ -57104,7 +57141,9 @@ const openapi: OpenAPISpec = {
|
|
|
57104
57141
|
'can_stream_live_video',
|
|
57105
57142
|
'can_set_speaker_volume',
|
|
57106
57143
|
'can_mute_speaker',
|
|
57144
|
+
'can_unmute_speaker',
|
|
57107
57145
|
'can_pause_speaker_playback',
|
|
57146
|
+
'can_resume_speaker_playback',
|
|
57108
57147
|
'can_play_speaker_chime',
|
|
57109
57148
|
],
|
|
57110
57149
|
type: 'string',
|
|
@@ -62551,7 +62590,7 @@ const openapi: OpenAPISpec = {
|
|
|
62551
62590
|
},
|
|
62552
62591
|
'/seam/console/v1/workspace/feature_flags/list': {
|
|
62553
62592
|
get: {
|
|
62554
|
-
description: 'Lists workspace feature flags.',
|
|
62593
|
+
description: 'Lists the workspace feature flags the Console reads.',
|
|
62555
62594
|
operationId: 'seamConsoleV1WorkspaceFeatureFlagsListGet',
|
|
62556
62595
|
responses: {
|
|
62557
62596
|
'200': {
|
|
@@ -62591,79 +62630,6 @@ const openapi: OpenAPISpec = {
|
|
|
62591
62630
|
'x-undocumented': 'Internal endpoint for Console',
|
|
62592
62631
|
},
|
|
62593
62632
|
},
|
|
62594
|
-
'/seam/console/v1/workspace/feature_flags/update': {
|
|
62595
|
-
post: {
|
|
62596
|
-
description:
|
|
62597
|
-
'Enables or disables a per-workspace feature flag (e.g. whether the Lynx\nmigration is enabled for the workspace). Only flags in the workspace-toggleable\nset can be updated.',
|
|
62598
|
-
operationId: 'seamConsoleV1WorkspaceFeatureFlagsUpdatePost',
|
|
62599
|
-
requestBody: {
|
|
62600
|
-
content: {
|
|
62601
|
-
'application/json': {
|
|
62602
|
-
schema: {
|
|
62603
|
-
properties: {
|
|
62604
|
-
enabled: {
|
|
62605
|
-
description:
|
|
62606
|
-
'Whether the feature flag should be enabled for the workspace.',
|
|
62607
|
-
type: 'boolean',
|
|
62608
|
-
},
|
|
62609
|
-
feature_flag_name: {
|
|
62610
|
-
description:
|
|
62611
|
-
'Name of the workspace feature flag to update.',
|
|
62612
|
-
type: 'string',
|
|
62613
|
-
},
|
|
62614
|
-
},
|
|
62615
|
-
required: ['feature_flag_name', 'enabled'],
|
|
62616
|
-
type: 'object',
|
|
62617
|
-
},
|
|
62618
|
-
},
|
|
62619
|
-
},
|
|
62620
|
-
},
|
|
62621
|
-
responses: {
|
|
62622
|
-
'200': {
|
|
62623
|
-
content: {
|
|
62624
|
-
'application/json': {
|
|
62625
|
-
schema: {
|
|
62626
|
-
properties: {
|
|
62627
|
-
feature_flag: {
|
|
62628
|
-
properties: {
|
|
62629
|
-
enabled: { type: 'boolean' },
|
|
62630
|
-
feature_flag_name: { type: 'string' },
|
|
62631
|
-
},
|
|
62632
|
-
required: ['feature_flag_name', 'enabled'],
|
|
62633
|
-
type: 'object',
|
|
62634
|
-
},
|
|
62635
|
-
ok: { type: 'boolean' },
|
|
62636
|
-
},
|
|
62637
|
-
required: ['feature_flag', 'ok'],
|
|
62638
|
-
type: 'object',
|
|
62639
|
-
},
|
|
62640
|
-
},
|
|
62641
|
-
},
|
|
62642
|
-
description: 'OK',
|
|
62643
|
-
},
|
|
62644
|
-
'400': { description: 'Bad Request' },
|
|
62645
|
-
'401': { description: 'Unauthorized' },
|
|
62646
|
-
},
|
|
62647
|
-
security: [
|
|
62648
|
-
{ pat_with_workspace: [] },
|
|
62649
|
-
{ console_session_with_workspace: [] },
|
|
62650
|
-
{ api_key: [] },
|
|
62651
|
-
],
|
|
62652
|
-
summary: '/seam/console/v1/workspace/feature_flags/update',
|
|
62653
|
-
tags: [],
|
|
62654
|
-
'x-fern-sdk-group-name': [
|
|
62655
|
-
'seam',
|
|
62656
|
-
'console',
|
|
62657
|
-
'v1',
|
|
62658
|
-
'workspace',
|
|
62659
|
-
'feature_flags',
|
|
62660
|
-
],
|
|
62661
|
-
'x-fern-sdk-method-name': 'update',
|
|
62662
|
-
'x-fern-sdk-return-value': 'feature_flag',
|
|
62663
|
-
'x-response-key': 'feature_flag',
|
|
62664
|
-
'x-undocumented': 'Internal endpoint for Console',
|
|
62665
|
-
},
|
|
62666
|
-
},
|
|
62667
62633
|
'/seam/customer/v1/access_grants/list': {
|
|
62668
62634
|
get: {
|
|
62669
62635
|
description: 'Gets an Access Grant.',
|
|
@@ -66910,6 +66876,12 @@ const openapi: OpenAPISpec = {
|
|
|
66910
66876
|
'Indicates whether the customer can customize their notification settings, such as the low-battery alert threshold.',
|
|
66911
66877
|
type: 'boolean',
|
|
66912
66878
|
},
|
|
66879
|
+
allow_sound_automation_rule_customization: {
|
|
66880
|
+
default: false,
|
|
66881
|
+
description:
|
|
66882
|
+
'Indicates whether the customer can customize the sound automation rules for their properties.',
|
|
66883
|
+
type: 'boolean',
|
|
66884
|
+
},
|
|
66913
66885
|
exclude: {
|
|
66914
66886
|
default: false,
|
|
66915
66887
|
description:
|
|
@@ -67386,6 +67358,12 @@ const openapi: OpenAPISpec = {
|
|
|
67386
67358
|
'Indicates whether the customer can customize their notification settings, such as the low-battery alert threshold.',
|
|
67387
67359
|
type: 'boolean',
|
|
67388
67360
|
},
|
|
67361
|
+
allow_sound_automation_rule_customization: {
|
|
67362
|
+
default: false,
|
|
67363
|
+
description:
|
|
67364
|
+
'Indicates whether the customer can customize the sound automation rules for their properties.',
|
|
67365
|
+
type: 'boolean',
|
|
67366
|
+
},
|
|
67389
67367
|
exclude: {
|
|
67390
67368
|
default: false,
|
|
67391
67369
|
description:
|
|
@@ -71658,7 +71636,7 @@ const openapi: OpenAPISpec = {
|
|
|
71658
71636
|
'/speakers/resume': {
|
|
71659
71637
|
post: {
|
|
71660
71638
|
description:
|
|
71661
|
-
'Resumes playback on a specified speaker. Playback also resumes on the speakers grouped with it, and the action attempt result lists every affected speaker. To check whether a speaker supports resuming playback, use `device.
|
|
71639
|
+
'Resumes playback on a specified speaker. Playback also resumes on the speakers grouped with it, and the action attempt result lists every affected speaker. To check whether a speaker supports resuming playback, use `device.can_resume_speaker_playback`.',
|
|
71662
71640
|
operationId: 'speakersResumePost',
|
|
71663
71641
|
requestBody: {
|
|
71664
71642
|
content: {
|
|
@@ -71786,7 +71764,7 @@ const openapi: OpenAPISpec = {
|
|
|
71786
71764
|
'/speakers/unmute': {
|
|
71787
71765
|
post: {
|
|
71788
71766
|
description:
|
|
71789
|
-
'Unmutes a specified speaker. To check whether a speaker supports unmuting, use `device.
|
|
71767
|
+
'Unmutes a specified speaker. To check whether a speaker supports unmuting, use `device.can_unmute_speaker`.',
|
|
71790
71768
|
operationId: 'speakersUnmutePost',
|
|
71791
71769
|
requestBody: {
|
|
71792
71770
|
content: {
|