@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
|
@@ -13291,11 +13291,11 @@ const openapi = {
|
|
|
13291
13291
|
type: 'boolean',
|
|
13292
13292
|
},
|
|
13293
13293
|
can_mute_speaker: {
|
|
13294
|
-
description: 'Indicates whether the speaker supports muting
|
|
13294
|
+
description: 'Indicates whether the speaker supports muting.',
|
|
13295
13295
|
type: 'boolean',
|
|
13296
13296
|
},
|
|
13297
13297
|
can_pause_speaker_playback: {
|
|
13298
|
-
description: 'Indicates whether the speaker supports pausing
|
|
13298
|
+
description: 'Indicates whether the speaker supports pausing playback.',
|
|
13299
13299
|
type: 'boolean',
|
|
13300
13300
|
},
|
|
13301
13301
|
can_play_speaker_chime: {
|
|
@@ -13330,6 +13330,10 @@ const openapi = {
|
|
|
13330
13330
|
description: 'Indicates whether the device supports remote unlocking.',
|
|
13331
13331
|
type: 'boolean',
|
|
13332
13332
|
},
|
|
13333
|
+
can_resume_speaker_playback: {
|
|
13334
|
+
description: 'Indicates whether the speaker supports resuming playback.',
|
|
13335
|
+
type: 'boolean',
|
|
13336
|
+
},
|
|
13333
13337
|
can_run_thermostat_programs: {
|
|
13334
13338
|
description: 'Indicates whether the thermostat supports running climate programs.',
|
|
13335
13339
|
type: 'boolean',
|
|
@@ -13374,6 +13378,10 @@ const openapi = {
|
|
|
13374
13378
|
description: 'Indicates whether the lock supports unlocking with an access code.',
|
|
13375
13379
|
type: 'boolean',
|
|
13376
13380
|
},
|
|
13381
|
+
can_unmute_speaker: {
|
|
13382
|
+
description: 'Indicates whether the speaker supports unmuting.',
|
|
13383
|
+
type: 'boolean',
|
|
13384
|
+
},
|
|
13377
13385
|
capabilities_supported: {
|
|
13378
13386
|
description: '\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 ',
|
|
13379
13387
|
items: {
|
|
@@ -17502,11 +17510,11 @@ const openapi = {
|
|
|
17502
17510
|
type: 'boolean',
|
|
17503
17511
|
},
|
|
17504
17512
|
can_mute_speaker: {
|
|
17505
|
-
description: 'Indicates whether the speaker supports muting
|
|
17513
|
+
description: 'Indicates whether the speaker supports muting.',
|
|
17506
17514
|
type: 'boolean',
|
|
17507
17515
|
},
|
|
17508
17516
|
can_pause_speaker_playback: {
|
|
17509
|
-
description: 'Indicates whether the speaker supports pausing
|
|
17517
|
+
description: 'Indicates whether the speaker supports pausing playback.',
|
|
17510
17518
|
type: 'boolean',
|
|
17511
17519
|
},
|
|
17512
17520
|
can_play_speaker_chime: {
|
|
@@ -17541,6 +17549,10 @@ const openapi = {
|
|
|
17541
17549
|
description: 'Indicates whether the device supports remote unlocking.',
|
|
17542
17550
|
type: 'boolean',
|
|
17543
17551
|
},
|
|
17552
|
+
can_resume_speaker_playback: {
|
|
17553
|
+
description: 'Indicates whether the speaker supports resuming playback.',
|
|
17554
|
+
type: 'boolean',
|
|
17555
|
+
},
|
|
17544
17556
|
can_run_thermostat_programs: {
|
|
17545
17557
|
description: 'Indicates whether the thermostat supports running climate programs.',
|
|
17546
17558
|
type: 'boolean',
|
|
@@ -17585,6 +17597,10 @@ const openapi = {
|
|
|
17585
17597
|
description: 'Indicates whether the lock supports unlocking with an access code.',
|
|
17586
17598
|
type: 'boolean',
|
|
17587
17599
|
},
|
|
17600
|
+
can_unmute_speaker: {
|
|
17601
|
+
description: 'Indicates whether the speaker supports unmuting.',
|
|
17602
|
+
type: 'boolean',
|
|
17603
|
+
},
|
|
17588
17604
|
device_provider_name: {
|
|
17589
17605
|
description: 'Name of the device provider.',
|
|
17590
17606
|
enum: [
|
|
@@ -35484,11 +35500,11 @@ const openapi = {
|
|
|
35484
35500
|
type: 'boolean',
|
|
35485
35501
|
},
|
|
35486
35502
|
can_mute_speaker: {
|
|
35487
|
-
description: 'Indicates whether the speaker supports muting
|
|
35503
|
+
description: 'Indicates whether the speaker supports muting.',
|
|
35488
35504
|
type: 'boolean',
|
|
35489
35505
|
},
|
|
35490
35506
|
can_pause_speaker_playback: {
|
|
35491
|
-
description: 'Indicates whether the speaker supports pausing
|
|
35507
|
+
description: 'Indicates whether the speaker supports pausing playback.',
|
|
35492
35508
|
type: 'boolean',
|
|
35493
35509
|
},
|
|
35494
35510
|
can_play_speaker_chime: {
|
|
@@ -35523,6 +35539,10 @@ const openapi = {
|
|
|
35523
35539
|
description: 'Indicates whether the device supports remote unlocking.',
|
|
35524
35540
|
type: 'boolean',
|
|
35525
35541
|
},
|
|
35542
|
+
can_resume_speaker_playback: {
|
|
35543
|
+
description: 'Indicates whether the speaker supports resuming playback.',
|
|
35544
|
+
type: 'boolean',
|
|
35545
|
+
},
|
|
35526
35546
|
can_run_thermostat_programs: {
|
|
35527
35547
|
description: 'Indicates whether the thermostat supports running climate programs.',
|
|
35528
35548
|
type: 'boolean',
|
|
@@ -35567,6 +35587,10 @@ const openapi = {
|
|
|
35567
35587
|
description: 'Indicates whether the lock supports unlocking with an access code.',
|
|
35568
35588
|
type: 'boolean',
|
|
35569
35589
|
},
|
|
35590
|
+
can_unmute_speaker: {
|
|
35591
|
+
description: 'Indicates whether the speaker supports unmuting.',
|
|
35592
|
+
type: 'boolean',
|
|
35593
|
+
},
|
|
35570
35594
|
capabilities_supported: {
|
|
35571
35595
|
description: '\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 ',
|
|
35572
35596
|
items: {
|
|
@@ -46571,6 +46595,7 @@ const openapi = {
|
|
|
46571
46595
|
allow_climate_automation_rule_customization: false,
|
|
46572
46596
|
allow_instant_key_customization: false,
|
|
46573
46597
|
allow_notification_customization: false,
|
|
46598
|
+
allow_sound_automation_rule_customization: false,
|
|
46574
46599
|
exclude: false,
|
|
46575
46600
|
},
|
|
46576
46601
|
connect: { exclude: false },
|
|
@@ -46707,6 +46732,11 @@ const openapi = {
|
|
|
46707
46732
|
description: 'Indicates whether the customer can customize their notification settings, such as the low-battery alert threshold.',
|
|
46708
46733
|
type: 'boolean',
|
|
46709
46734
|
},
|
|
46735
|
+
allow_sound_automation_rule_customization: {
|
|
46736
|
+
default: false,
|
|
46737
|
+
description: 'Indicates whether the customer can customize the sound automation rules for their properties.',
|
|
46738
|
+
type: 'boolean',
|
|
46739
|
+
},
|
|
46710
46740
|
exclude: {
|
|
46711
46741
|
default: false,
|
|
46712
46742
|
description: 'Whether to exclude this feature from the portal.',
|
|
@@ -49443,7 +49473,9 @@ const openapi = {
|
|
|
49443
49473
|
'can_stream_live_video',
|
|
49444
49474
|
'can_set_speaker_volume',
|
|
49445
49475
|
'can_mute_speaker',
|
|
49476
|
+
'can_unmute_speaker',
|
|
49446
49477
|
'can_pause_speaker_playback',
|
|
49478
|
+
'can_resume_speaker_playback',
|
|
49447
49479
|
'can_play_speaker_chime',
|
|
49448
49480
|
],
|
|
49449
49481
|
type: 'string',
|
|
@@ -49482,7 +49514,9 @@ const openapi = {
|
|
|
49482
49514
|
'can_stream_live_video',
|
|
49483
49515
|
'can_set_speaker_volume',
|
|
49484
49516
|
'can_mute_speaker',
|
|
49517
|
+
'can_unmute_speaker',
|
|
49485
49518
|
'can_pause_speaker_playback',
|
|
49519
|
+
'can_resume_speaker_playback',
|
|
49486
49520
|
'can_play_speaker_chime',
|
|
49487
49521
|
],
|
|
49488
49522
|
type: 'string',
|
|
@@ -51719,7 +51753,9 @@ const openapi = {
|
|
|
51719
51753
|
'can_stream_live_video',
|
|
51720
51754
|
'can_set_speaker_volume',
|
|
51721
51755
|
'can_mute_speaker',
|
|
51756
|
+
'can_unmute_speaker',
|
|
51722
51757
|
'can_pause_speaker_playback',
|
|
51758
|
+
'can_resume_speaker_playback',
|
|
51723
51759
|
'can_play_speaker_chime',
|
|
51724
51760
|
],
|
|
51725
51761
|
type: 'string',
|
|
@@ -51758,7 +51794,9 @@ const openapi = {
|
|
|
51758
51794
|
'can_stream_live_video',
|
|
51759
51795
|
'can_set_speaker_volume',
|
|
51760
51796
|
'can_mute_speaker',
|
|
51797
|
+
'can_unmute_speaker',
|
|
51761
51798
|
'can_pause_speaker_playback',
|
|
51799
|
+
'can_resume_speaker_playback',
|
|
51762
51800
|
'can_play_speaker_chime',
|
|
51763
51801
|
],
|
|
51764
51802
|
type: 'string',
|
|
@@ -57048,7 +57086,7 @@ const openapi = {
|
|
|
57048
57086
|
},
|
|
57049
57087
|
'/seam/console/v1/workspace/feature_flags/list': {
|
|
57050
57088
|
get: {
|
|
57051
|
-
description: 'Lists workspace feature flags.',
|
|
57089
|
+
description: 'Lists the workspace feature flags the Console reads.',
|
|
57052
57090
|
operationId: 'seamConsoleV1WorkspaceFeatureFlagsListGet',
|
|
57053
57091
|
responses: {
|
|
57054
57092
|
'200': {
|
|
@@ -57088,76 +57126,6 @@ const openapi = {
|
|
|
57088
57126
|
'x-undocumented': 'Internal endpoint for Console',
|
|
57089
57127
|
},
|
|
57090
57128
|
},
|
|
57091
|
-
'/seam/console/v1/workspace/feature_flags/update': {
|
|
57092
|
-
post: {
|
|
57093
|
-
description: '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.',
|
|
57094
|
-
operationId: 'seamConsoleV1WorkspaceFeatureFlagsUpdatePost',
|
|
57095
|
-
requestBody: {
|
|
57096
|
-
content: {
|
|
57097
|
-
'application/json': {
|
|
57098
|
-
schema: {
|
|
57099
|
-
properties: {
|
|
57100
|
-
enabled: {
|
|
57101
|
-
description: 'Whether the feature flag should be enabled for the workspace.',
|
|
57102
|
-
type: 'boolean',
|
|
57103
|
-
},
|
|
57104
|
-
feature_flag_name: {
|
|
57105
|
-
description: 'Name of the workspace feature flag to update.',
|
|
57106
|
-
type: 'string',
|
|
57107
|
-
},
|
|
57108
|
-
},
|
|
57109
|
-
required: ['feature_flag_name', 'enabled'],
|
|
57110
|
-
type: 'object',
|
|
57111
|
-
},
|
|
57112
|
-
},
|
|
57113
|
-
},
|
|
57114
|
-
},
|
|
57115
|
-
responses: {
|
|
57116
|
-
'200': {
|
|
57117
|
-
content: {
|
|
57118
|
-
'application/json': {
|
|
57119
|
-
schema: {
|
|
57120
|
-
properties: {
|
|
57121
|
-
feature_flag: {
|
|
57122
|
-
properties: {
|
|
57123
|
-
enabled: { type: 'boolean' },
|
|
57124
|
-
feature_flag_name: { type: 'string' },
|
|
57125
|
-
},
|
|
57126
|
-
required: ['feature_flag_name', 'enabled'],
|
|
57127
|
-
type: 'object',
|
|
57128
|
-
},
|
|
57129
|
-
ok: { type: 'boolean' },
|
|
57130
|
-
},
|
|
57131
|
-
required: ['feature_flag', 'ok'],
|
|
57132
|
-
type: 'object',
|
|
57133
|
-
},
|
|
57134
|
-
},
|
|
57135
|
-
},
|
|
57136
|
-
description: 'OK',
|
|
57137
|
-
},
|
|
57138
|
-
'400': { description: 'Bad Request' },
|
|
57139
|
-
'401': { description: 'Unauthorized' },
|
|
57140
|
-
},
|
|
57141
|
-
security: [
|
|
57142
|
-
{ pat_with_workspace: [] },
|
|
57143
|
-
{ console_session_with_workspace: [] },
|
|
57144
|
-
{ api_key: [] },
|
|
57145
|
-
],
|
|
57146
|
-
summary: '/seam/console/v1/workspace/feature_flags/update',
|
|
57147
|
-
tags: [],
|
|
57148
|
-
'x-fern-sdk-group-name': [
|
|
57149
|
-
'seam',
|
|
57150
|
-
'console',
|
|
57151
|
-
'v1',
|
|
57152
|
-
'workspace',
|
|
57153
|
-
'feature_flags',
|
|
57154
|
-
],
|
|
57155
|
-
'x-fern-sdk-method-name': 'update',
|
|
57156
|
-
'x-fern-sdk-return-value': 'feature_flag',
|
|
57157
|
-
'x-response-key': 'feature_flag',
|
|
57158
|
-
'x-undocumented': 'Internal endpoint for Console',
|
|
57159
|
-
},
|
|
57160
|
-
},
|
|
57161
57129
|
'/seam/customer/v1/access_grants/list': {
|
|
57162
57130
|
get: {
|
|
57163
57131
|
description: 'Gets an Access Grant.',
|
|
@@ -61297,6 +61265,11 @@ const openapi = {
|
|
|
61297
61265
|
description: 'Indicates whether the customer can customize their notification settings, such as the low-battery alert threshold.',
|
|
61298
61266
|
type: 'boolean',
|
|
61299
61267
|
},
|
|
61268
|
+
allow_sound_automation_rule_customization: {
|
|
61269
|
+
default: false,
|
|
61270
|
+
description: 'Indicates whether the customer can customize the sound automation rules for their properties.',
|
|
61271
|
+
type: 'boolean',
|
|
61272
|
+
},
|
|
61300
61273
|
exclude: {
|
|
61301
61274
|
default: false,
|
|
61302
61275
|
description: 'Whether to exclude this feature from the portal.',
|
|
@@ -61733,6 +61706,11 @@ const openapi = {
|
|
|
61733
61706
|
description: 'Indicates whether the customer can customize their notification settings, such as the low-battery alert threshold.',
|
|
61734
61707
|
type: 'boolean',
|
|
61735
61708
|
},
|
|
61709
|
+
allow_sound_automation_rule_customization: {
|
|
61710
|
+
default: false,
|
|
61711
|
+
description: 'Indicates whether the customer can customize the sound automation rules for their properties.',
|
|
61712
|
+
type: 'boolean',
|
|
61713
|
+
},
|
|
61736
61714
|
exclude: {
|
|
61737
61715
|
default: false,
|
|
61738
61716
|
description: 'Whether to exclude this feature from the portal.',
|
|
@@ -65834,7 +65812,7 @@ const openapi = {
|
|
|
65834
65812
|
},
|
|
65835
65813
|
'/speakers/resume': {
|
|
65836
65814
|
post: {
|
|
65837
|
-
description: '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.
|
|
65815
|
+
description: '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`.',
|
|
65838
65816
|
operationId: 'speakersResumePost',
|
|
65839
65817
|
requestBody: {
|
|
65840
65818
|
content: {
|
|
@@ -65957,7 +65935,7 @@ const openapi = {
|
|
|
65957
65935
|
},
|
|
65958
65936
|
'/speakers/unmute': {
|
|
65959
65937
|
post: {
|
|
65960
|
-
description: 'Unmutes a specified speaker. To check whether a speaker supports unmuting, use `device.
|
|
65938
|
+
description: 'Unmutes a specified speaker. To check whether a speaker supports unmuting, use `device.can_unmute_speaker`.',
|
|
65961
65939
|
operationId: 'speakersUnmutePost',
|
|
65962
65940
|
requestBody: {
|
|
65963
65941
|
content: {
|