@seamapi/types 1.1107.0 → 1.1109.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/openapi.js +584 -0
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +202 -0
- package/package.json +1 -1
- package/src/lib/seam/connect/models/customer/customer-portal.ts +7 -0
- package/src/lib/seam/connect/openapi.ts +592 -0
- package/src/lib/seam/connect/route-types.ts +270 -0
|
@@ -45808,6 +45808,7 @@ const openapi = {
|
|
|
45808
45808
|
allow_access_automation_rule_customization: false,
|
|
45809
45809
|
allow_climate_automation_rule_customization: false,
|
|
45810
45810
|
allow_instant_key_customization: false,
|
|
45811
|
+
allow_notification_customization: false,
|
|
45811
45812
|
exclude: false,
|
|
45812
45813
|
},
|
|
45813
45814
|
connect: { exclude: false },
|
|
@@ -45938,6 +45939,11 @@ const openapi = {
|
|
|
45938
45939
|
description: 'Indicates whether the customer can customize the Instant Key profile for their properties.',
|
|
45939
45940
|
type: 'boolean',
|
|
45940
45941
|
},
|
|
45942
|
+
allow_notification_customization: {
|
|
45943
|
+
default: false,
|
|
45944
|
+
description: 'Indicates whether the customer can customize their notification settings, such as the low-battery alert threshold.',
|
|
45945
|
+
type: 'boolean',
|
|
45946
|
+
},
|
|
45941
45947
|
exclude: {
|
|
45942
45948
|
default: false,
|
|
45943
45949
|
description: 'Whether to exclude this feature from the portal.',
|
|
@@ -57147,6 +57153,101 @@ const openapi = {
|
|
|
57147
57153
|
type: 'object',
|
|
57148
57154
|
},
|
|
57149
57155
|
ok: { type: 'boolean' },
|
|
57156
|
+
sound_rules: {
|
|
57157
|
+
properties: {
|
|
57158
|
+
rules: {
|
|
57159
|
+
properties: {
|
|
57160
|
+
reservation_created: {
|
|
57161
|
+
properties: {
|
|
57162
|
+
on_check_in: {
|
|
57163
|
+
properties: {
|
|
57164
|
+
minutes_before_check_in: {
|
|
57165
|
+
maximum: 1440,
|
|
57166
|
+
minimum: 0,
|
|
57167
|
+
type: 'integer',
|
|
57168
|
+
},
|
|
57169
|
+
noise_sensors: {
|
|
57170
|
+
properties: {
|
|
57171
|
+
noise_thresholds: {
|
|
57172
|
+
items: {
|
|
57173
|
+
$ref: '#/components/schemas/noise_threshold',
|
|
57174
|
+
},
|
|
57175
|
+
maxItems: 10,
|
|
57176
|
+
type: 'array',
|
|
57177
|
+
},
|
|
57178
|
+
},
|
|
57179
|
+
required: ['noise_thresholds'],
|
|
57180
|
+
type: 'object',
|
|
57181
|
+
},
|
|
57182
|
+
speakers: {
|
|
57183
|
+
properties: {
|
|
57184
|
+
play_chime: { type: 'boolean' },
|
|
57185
|
+
set_volume_to: {
|
|
57186
|
+
maximum: 100,
|
|
57187
|
+
minimum: 0,
|
|
57188
|
+
type: 'integer',
|
|
57189
|
+
},
|
|
57190
|
+
unmute: { type: 'boolean' },
|
|
57191
|
+
},
|
|
57192
|
+
type: 'object',
|
|
57193
|
+
},
|
|
57194
|
+
},
|
|
57195
|
+
type: 'object',
|
|
57196
|
+
},
|
|
57197
|
+
on_check_out: {
|
|
57198
|
+
properties: {
|
|
57199
|
+
minutes_after_check_out: {
|
|
57200
|
+
maximum: 1440,
|
|
57201
|
+
minimum: 0,
|
|
57202
|
+
type: 'integer',
|
|
57203
|
+
},
|
|
57204
|
+
noise_sensors: {
|
|
57205
|
+
properties: {
|
|
57206
|
+
noise_thresholds: {
|
|
57207
|
+
items: {
|
|
57208
|
+
$ref: '#/components/schemas/noise_threshold',
|
|
57209
|
+
},
|
|
57210
|
+
maxItems: 10,
|
|
57211
|
+
type: 'array',
|
|
57212
|
+
},
|
|
57213
|
+
},
|
|
57214
|
+
required: ['noise_thresholds'],
|
|
57215
|
+
type: 'object',
|
|
57216
|
+
},
|
|
57217
|
+
speakers: {
|
|
57218
|
+
properties: {
|
|
57219
|
+
pause_playback: { type: 'boolean' },
|
|
57220
|
+
reset_volume_to: {
|
|
57221
|
+
maximum: 100,
|
|
57222
|
+
minimum: 0,
|
|
57223
|
+
type: 'integer',
|
|
57224
|
+
},
|
|
57225
|
+
unmute: { type: 'boolean' },
|
|
57226
|
+
},
|
|
57227
|
+
type: 'object',
|
|
57228
|
+
},
|
|
57229
|
+
},
|
|
57230
|
+
type: 'object',
|
|
57231
|
+
},
|
|
57232
|
+
},
|
|
57233
|
+
type: 'object',
|
|
57234
|
+
},
|
|
57235
|
+
reservation_deleted: {
|
|
57236
|
+
$ref: '#/components/schemas/access_code',
|
|
57237
|
+
},
|
|
57238
|
+
reservation_spaces_updated: {
|
|
57239
|
+
$ref: '#/components/schemas/access_code',
|
|
57240
|
+
},
|
|
57241
|
+
reservation_time_updated: {
|
|
57242
|
+
$ref: '#/components/schemas/access_code',
|
|
57243
|
+
},
|
|
57244
|
+
},
|
|
57245
|
+
type: 'object',
|
|
57246
|
+
},
|
|
57247
|
+
},
|
|
57248
|
+
required: ['rules'],
|
|
57249
|
+
type: 'object',
|
|
57250
|
+
},
|
|
57150
57251
|
},
|
|
57151
57252
|
required: ['ok'],
|
|
57152
57253
|
type: 'object',
|
|
@@ -57443,6 +57544,136 @@ const openapi = {
|
|
|
57443
57544
|
minLength: 1,
|
|
57444
57545
|
type: 'string',
|
|
57445
57546
|
},
|
|
57547
|
+
sound_rules: {
|
|
57548
|
+
description: 'Sound automation rules configuration.',
|
|
57549
|
+
properties: {
|
|
57550
|
+
rules: {
|
|
57551
|
+
properties: {
|
|
57552
|
+
reservation_created: {
|
|
57553
|
+
nullable: true,
|
|
57554
|
+
properties: {
|
|
57555
|
+
on_check_in: {
|
|
57556
|
+
properties: {
|
|
57557
|
+
minutes_before_check_in: {
|
|
57558
|
+
maximum: 1440,
|
|
57559
|
+
minimum: 0,
|
|
57560
|
+
type: 'integer',
|
|
57561
|
+
},
|
|
57562
|
+
noise_sensors: {
|
|
57563
|
+
properties: {
|
|
57564
|
+
noise_thresholds: {
|
|
57565
|
+
items: {
|
|
57566
|
+
properties: {
|
|
57567
|
+
ends_daily_at: { type: 'string' },
|
|
57568
|
+
name: { type: 'string' },
|
|
57569
|
+
noise_threshold_decibels: {
|
|
57570
|
+
format: 'float',
|
|
57571
|
+
type: 'number',
|
|
57572
|
+
},
|
|
57573
|
+
starts_daily_at: { type: 'string' },
|
|
57574
|
+
},
|
|
57575
|
+
required: [
|
|
57576
|
+
'starts_daily_at',
|
|
57577
|
+
'ends_daily_at',
|
|
57578
|
+
'noise_threshold_decibels',
|
|
57579
|
+
],
|
|
57580
|
+
type: 'object',
|
|
57581
|
+
},
|
|
57582
|
+
maxItems: 10,
|
|
57583
|
+
type: 'array',
|
|
57584
|
+
},
|
|
57585
|
+
},
|
|
57586
|
+
required: ['noise_thresholds'],
|
|
57587
|
+
type: 'object',
|
|
57588
|
+
},
|
|
57589
|
+
speakers: {
|
|
57590
|
+
properties: {
|
|
57591
|
+
play_chime: { type: 'boolean' },
|
|
57592
|
+
set_volume_to: {
|
|
57593
|
+
maximum: 100,
|
|
57594
|
+
minimum: 0,
|
|
57595
|
+
type: 'integer',
|
|
57596
|
+
},
|
|
57597
|
+
unmute: { type: 'boolean' },
|
|
57598
|
+
},
|
|
57599
|
+
type: 'object',
|
|
57600
|
+
},
|
|
57601
|
+
},
|
|
57602
|
+
type: 'object',
|
|
57603
|
+
},
|
|
57604
|
+
on_check_out: {
|
|
57605
|
+
properties: {
|
|
57606
|
+
minutes_after_check_out: {
|
|
57607
|
+
maximum: 1440,
|
|
57608
|
+
minimum: 0,
|
|
57609
|
+
type: 'integer',
|
|
57610
|
+
},
|
|
57611
|
+
noise_sensors: {
|
|
57612
|
+
properties: {
|
|
57613
|
+
noise_thresholds: {
|
|
57614
|
+
items: {
|
|
57615
|
+
properties: {
|
|
57616
|
+
ends_daily_at: { type: 'string' },
|
|
57617
|
+
name: { type: 'string' },
|
|
57618
|
+
noise_threshold_decibels: {
|
|
57619
|
+
format: 'float',
|
|
57620
|
+
type: 'number',
|
|
57621
|
+
},
|
|
57622
|
+
starts_daily_at: { type: 'string' },
|
|
57623
|
+
},
|
|
57624
|
+
required: [
|
|
57625
|
+
'starts_daily_at',
|
|
57626
|
+
'ends_daily_at',
|
|
57627
|
+
'noise_threshold_decibels',
|
|
57628
|
+
],
|
|
57629
|
+
type: 'object',
|
|
57630
|
+
},
|
|
57631
|
+
maxItems: 10,
|
|
57632
|
+
type: 'array',
|
|
57633
|
+
},
|
|
57634
|
+
},
|
|
57635
|
+
required: ['noise_thresholds'],
|
|
57636
|
+
type: 'object',
|
|
57637
|
+
},
|
|
57638
|
+
speakers: {
|
|
57639
|
+
properties: {
|
|
57640
|
+
pause_playback: { type: 'boolean' },
|
|
57641
|
+
reset_volume_to: {
|
|
57642
|
+
maximum: 100,
|
|
57643
|
+
minimum: 0,
|
|
57644
|
+
type: 'integer',
|
|
57645
|
+
},
|
|
57646
|
+
unmute: { type: 'boolean' },
|
|
57647
|
+
},
|
|
57648
|
+
type: 'object',
|
|
57649
|
+
},
|
|
57650
|
+
},
|
|
57651
|
+
type: 'object',
|
|
57652
|
+
},
|
|
57653
|
+
},
|
|
57654
|
+
type: 'object',
|
|
57655
|
+
},
|
|
57656
|
+
reservation_deleted: {
|
|
57657
|
+
nullable: true,
|
|
57658
|
+
properties: {},
|
|
57659
|
+
type: 'object',
|
|
57660
|
+
},
|
|
57661
|
+
reservation_spaces_updated: {
|
|
57662
|
+
nullable: true,
|
|
57663
|
+
properties: {},
|
|
57664
|
+
type: 'object',
|
|
57665
|
+
},
|
|
57666
|
+
reservation_time_updated: {
|
|
57667
|
+
nullable: true,
|
|
57668
|
+
properties: {},
|
|
57669
|
+
type: 'object',
|
|
57670
|
+
},
|
|
57671
|
+
},
|
|
57672
|
+
type: 'object',
|
|
57673
|
+
},
|
|
57674
|
+
},
|
|
57675
|
+
type: 'object',
|
|
57676
|
+
},
|
|
57446
57677
|
},
|
|
57447
57678
|
type: 'object',
|
|
57448
57679
|
},
|
|
@@ -58722,6 +58953,101 @@ const openapi = {
|
|
|
58722
58953
|
required: ['rules'],
|
|
58723
58954
|
type: 'object',
|
|
58724
58955
|
},
|
|
58956
|
+
sound_rules: {
|
|
58957
|
+
properties: {
|
|
58958
|
+
rules: {
|
|
58959
|
+
properties: {
|
|
58960
|
+
reservation_created: {
|
|
58961
|
+
properties: {
|
|
58962
|
+
on_check_in: {
|
|
58963
|
+
properties: {
|
|
58964
|
+
minutes_before_check_in: {
|
|
58965
|
+
maximum: 1440,
|
|
58966
|
+
minimum: 0,
|
|
58967
|
+
type: 'integer',
|
|
58968
|
+
},
|
|
58969
|
+
noise_sensors: {
|
|
58970
|
+
properties: {
|
|
58971
|
+
noise_thresholds: {
|
|
58972
|
+
items: {
|
|
58973
|
+
$ref: '#/components/schemas/noise_threshold',
|
|
58974
|
+
},
|
|
58975
|
+
maxItems: 10,
|
|
58976
|
+
type: 'array',
|
|
58977
|
+
},
|
|
58978
|
+
},
|
|
58979
|
+
required: ['noise_thresholds'],
|
|
58980
|
+
type: 'object',
|
|
58981
|
+
},
|
|
58982
|
+
speakers: {
|
|
58983
|
+
properties: {
|
|
58984
|
+
play_chime: { type: 'boolean' },
|
|
58985
|
+
set_volume_to: {
|
|
58986
|
+
maximum: 100,
|
|
58987
|
+
minimum: 0,
|
|
58988
|
+
type: 'integer',
|
|
58989
|
+
},
|
|
58990
|
+
unmute: { type: 'boolean' },
|
|
58991
|
+
},
|
|
58992
|
+
type: 'object',
|
|
58993
|
+
},
|
|
58994
|
+
},
|
|
58995
|
+
type: 'object',
|
|
58996
|
+
},
|
|
58997
|
+
on_check_out: {
|
|
58998
|
+
properties: {
|
|
58999
|
+
minutes_after_check_out: {
|
|
59000
|
+
maximum: 1440,
|
|
59001
|
+
minimum: 0,
|
|
59002
|
+
type: 'integer',
|
|
59003
|
+
},
|
|
59004
|
+
noise_sensors: {
|
|
59005
|
+
properties: {
|
|
59006
|
+
noise_thresholds: {
|
|
59007
|
+
items: {
|
|
59008
|
+
$ref: '#/components/schemas/noise_threshold',
|
|
59009
|
+
},
|
|
59010
|
+
maxItems: 10,
|
|
59011
|
+
type: 'array',
|
|
59012
|
+
},
|
|
59013
|
+
},
|
|
59014
|
+
required: ['noise_thresholds'],
|
|
59015
|
+
type: 'object',
|
|
59016
|
+
},
|
|
59017
|
+
speakers: {
|
|
59018
|
+
properties: {
|
|
59019
|
+
pause_playback: { type: 'boolean' },
|
|
59020
|
+
reset_volume_to: {
|
|
59021
|
+
maximum: 100,
|
|
59022
|
+
minimum: 0,
|
|
59023
|
+
type: 'integer',
|
|
59024
|
+
},
|
|
59025
|
+
unmute: { type: 'boolean' },
|
|
59026
|
+
},
|
|
59027
|
+
type: 'object',
|
|
59028
|
+
},
|
|
59029
|
+
},
|
|
59030
|
+
type: 'object',
|
|
59031
|
+
},
|
|
59032
|
+
},
|
|
59033
|
+
type: 'object',
|
|
59034
|
+
},
|
|
59035
|
+
reservation_deleted: {
|
|
59036
|
+
$ref: '#/components/schemas/access_code',
|
|
59037
|
+
},
|
|
59038
|
+
reservation_spaces_updated: {
|
|
59039
|
+
$ref: '#/components/schemas/access_code',
|
|
59040
|
+
},
|
|
59041
|
+
reservation_time_updated: {
|
|
59042
|
+
$ref: '#/components/schemas/access_code',
|
|
59043
|
+
},
|
|
59044
|
+
},
|
|
59045
|
+
type: 'object',
|
|
59046
|
+
},
|
|
59047
|
+
},
|
|
59048
|
+
required: ['rules'],
|
|
59049
|
+
type: 'object',
|
|
59050
|
+
},
|
|
58725
59051
|
},
|
|
58726
59052
|
type: 'object',
|
|
58727
59053
|
},
|
|
@@ -59027,6 +59353,136 @@ const openapi = {
|
|
|
59027
59353
|
},
|
|
59028
59354
|
type: 'object',
|
|
59029
59355
|
},
|
|
59356
|
+
sound_rules: {
|
|
59357
|
+
description: 'Sound automation rules configuration.',
|
|
59358
|
+
properties: {
|
|
59359
|
+
rules: {
|
|
59360
|
+
properties: {
|
|
59361
|
+
reservation_created: {
|
|
59362
|
+
nullable: true,
|
|
59363
|
+
properties: {
|
|
59364
|
+
on_check_in: {
|
|
59365
|
+
properties: {
|
|
59366
|
+
minutes_before_check_in: {
|
|
59367
|
+
maximum: 1440,
|
|
59368
|
+
minimum: 0,
|
|
59369
|
+
type: 'integer',
|
|
59370
|
+
},
|
|
59371
|
+
noise_sensors: {
|
|
59372
|
+
properties: {
|
|
59373
|
+
noise_thresholds: {
|
|
59374
|
+
items: {
|
|
59375
|
+
properties: {
|
|
59376
|
+
ends_daily_at: { type: 'string' },
|
|
59377
|
+
name: { type: 'string' },
|
|
59378
|
+
noise_threshold_decibels: {
|
|
59379
|
+
format: 'float',
|
|
59380
|
+
type: 'number',
|
|
59381
|
+
},
|
|
59382
|
+
starts_daily_at: { type: 'string' },
|
|
59383
|
+
},
|
|
59384
|
+
required: [
|
|
59385
|
+
'starts_daily_at',
|
|
59386
|
+
'ends_daily_at',
|
|
59387
|
+
'noise_threshold_decibels',
|
|
59388
|
+
],
|
|
59389
|
+
type: 'object',
|
|
59390
|
+
},
|
|
59391
|
+
maxItems: 10,
|
|
59392
|
+
type: 'array',
|
|
59393
|
+
},
|
|
59394
|
+
},
|
|
59395
|
+
required: ['noise_thresholds'],
|
|
59396
|
+
type: 'object',
|
|
59397
|
+
},
|
|
59398
|
+
speakers: {
|
|
59399
|
+
properties: {
|
|
59400
|
+
play_chime: { type: 'boolean' },
|
|
59401
|
+
set_volume_to: {
|
|
59402
|
+
maximum: 100,
|
|
59403
|
+
minimum: 0,
|
|
59404
|
+
type: 'integer',
|
|
59405
|
+
},
|
|
59406
|
+
unmute: { type: 'boolean' },
|
|
59407
|
+
},
|
|
59408
|
+
type: 'object',
|
|
59409
|
+
},
|
|
59410
|
+
},
|
|
59411
|
+
type: 'object',
|
|
59412
|
+
},
|
|
59413
|
+
on_check_out: {
|
|
59414
|
+
properties: {
|
|
59415
|
+
minutes_after_check_out: {
|
|
59416
|
+
maximum: 1440,
|
|
59417
|
+
minimum: 0,
|
|
59418
|
+
type: 'integer',
|
|
59419
|
+
},
|
|
59420
|
+
noise_sensors: {
|
|
59421
|
+
properties: {
|
|
59422
|
+
noise_thresholds: {
|
|
59423
|
+
items: {
|
|
59424
|
+
properties: {
|
|
59425
|
+
ends_daily_at: { type: 'string' },
|
|
59426
|
+
name: { type: 'string' },
|
|
59427
|
+
noise_threshold_decibels: {
|
|
59428
|
+
format: 'float',
|
|
59429
|
+
type: 'number',
|
|
59430
|
+
},
|
|
59431
|
+
starts_daily_at: { type: 'string' },
|
|
59432
|
+
},
|
|
59433
|
+
required: [
|
|
59434
|
+
'starts_daily_at',
|
|
59435
|
+
'ends_daily_at',
|
|
59436
|
+
'noise_threshold_decibels',
|
|
59437
|
+
],
|
|
59438
|
+
type: 'object',
|
|
59439
|
+
},
|
|
59440
|
+
maxItems: 10,
|
|
59441
|
+
type: 'array',
|
|
59442
|
+
},
|
|
59443
|
+
},
|
|
59444
|
+
required: ['noise_thresholds'],
|
|
59445
|
+
type: 'object',
|
|
59446
|
+
},
|
|
59447
|
+
speakers: {
|
|
59448
|
+
properties: {
|
|
59449
|
+
pause_playback: { type: 'boolean' },
|
|
59450
|
+
reset_volume_to: {
|
|
59451
|
+
maximum: 100,
|
|
59452
|
+
minimum: 0,
|
|
59453
|
+
type: 'integer',
|
|
59454
|
+
},
|
|
59455
|
+
unmute: { type: 'boolean' },
|
|
59456
|
+
},
|
|
59457
|
+
type: 'object',
|
|
59458
|
+
},
|
|
59459
|
+
},
|
|
59460
|
+
type: 'object',
|
|
59461
|
+
},
|
|
59462
|
+
},
|
|
59463
|
+
type: 'object',
|
|
59464
|
+
},
|
|
59465
|
+
reservation_deleted: {
|
|
59466
|
+
nullable: true,
|
|
59467
|
+
properties: {},
|
|
59468
|
+
type: 'object',
|
|
59469
|
+
},
|
|
59470
|
+
reservation_spaces_updated: {
|
|
59471
|
+
nullable: true,
|
|
59472
|
+
properties: {},
|
|
59473
|
+
type: 'object',
|
|
59474
|
+
},
|
|
59475
|
+
reservation_time_updated: {
|
|
59476
|
+
nullable: true,
|
|
59477
|
+
properties: {},
|
|
59478
|
+
type: 'object',
|
|
59479
|
+
},
|
|
59480
|
+
},
|
|
59481
|
+
type: 'object',
|
|
59482
|
+
},
|
|
59483
|
+
},
|
|
59484
|
+
type: 'object',
|
|
59485
|
+
},
|
|
59030
59486
|
},
|
|
59031
59487
|
type: 'object',
|
|
59032
59488
|
},
|
|
@@ -59238,6 +59694,124 @@ const openapi = {
|
|
|
59238
59694
|
'x-undocumented': 'Internal endpoint for customer portals.',
|
|
59239
59695
|
},
|
|
59240
59696
|
},
|
|
59697
|
+
'/seam/customer/v1/customers/notifications/get': {
|
|
59698
|
+
get: {
|
|
59699
|
+
description: 'Gets the notification settings for the authenticated customer, along with the workspace defaults they inherit when unset.',
|
|
59700
|
+
operationId: 'seamCustomerV1CustomersNotificationsGetGet',
|
|
59701
|
+
responses: {
|
|
59702
|
+
'200': {
|
|
59703
|
+
content: {
|
|
59704
|
+
'application/json': {
|
|
59705
|
+
schema: {
|
|
59706
|
+
properties: {
|
|
59707
|
+
notification_settings: {
|
|
59708
|
+
properties: {
|
|
59709
|
+
low_battery_alert_threshold: {
|
|
59710
|
+
description: "Battery level, from 0 to 1, at or below which `device.low_battery` events fire for this customer's devices. `null` means the workspace or device default applies.",
|
|
59711
|
+
format: 'float',
|
|
59712
|
+
nullable: true,
|
|
59713
|
+
type: 'number',
|
|
59714
|
+
},
|
|
59715
|
+
workspace_default_low_battery_alert_threshold: {
|
|
59716
|
+
description: 'Workspace-level low-battery alert threshold that applies when the customer has not set one. `null` means the device default applies.',
|
|
59717
|
+
format: 'float',
|
|
59718
|
+
nullable: true,
|
|
59719
|
+
type: 'number',
|
|
59720
|
+
},
|
|
59721
|
+
},
|
|
59722
|
+
required: [
|
|
59723
|
+
'low_battery_alert_threshold',
|
|
59724
|
+
'workspace_default_low_battery_alert_threshold',
|
|
59725
|
+
],
|
|
59726
|
+
type: 'object',
|
|
59727
|
+
},
|
|
59728
|
+
ok: { type: 'boolean' },
|
|
59729
|
+
},
|
|
59730
|
+
required: ['notification_settings', 'ok'],
|
|
59731
|
+
type: 'object',
|
|
59732
|
+
},
|
|
59733
|
+
},
|
|
59734
|
+
},
|
|
59735
|
+
description: 'OK',
|
|
59736
|
+
},
|
|
59737
|
+
'400': { description: 'Bad Request' },
|
|
59738
|
+
'401': { description: 'Unauthorized' },
|
|
59739
|
+
},
|
|
59740
|
+
security: [
|
|
59741
|
+
{ client_session_with_customer: [] },
|
|
59742
|
+
{ client_session_with_customer_ro: [] },
|
|
59743
|
+
],
|
|
59744
|
+
summary: '/seam/customer/v1/customers/notifications/get',
|
|
59745
|
+
tags: [],
|
|
59746
|
+
'x-fern-sdk-group-name': [
|
|
59747
|
+
'seam',
|
|
59748
|
+
'customer',
|
|
59749
|
+
'v1',
|
|
59750
|
+
'customers',
|
|
59751
|
+
'notifications',
|
|
59752
|
+
],
|
|
59753
|
+
'x-fern-sdk-method-name': 'get',
|
|
59754
|
+
'x-fern-sdk-return-value': 'notification_settings',
|
|
59755
|
+
'x-response-key': 'notification_settings',
|
|
59756
|
+
'x-title': 'Get Customer Notification Settings',
|
|
59757
|
+
'x-undocumented': 'Internal endpoint for customer portals.',
|
|
59758
|
+
},
|
|
59759
|
+
},
|
|
59760
|
+
'/seam/customer/v1/customers/notifications/update': {
|
|
59761
|
+
patch: {
|
|
59762
|
+
description: 'Updates the notification settings for the authenticated customer. Requires a customer portal with `features.configure.allow_notification_customization` enabled.',
|
|
59763
|
+
operationId: 'seamCustomerV1CustomersNotificationsUpdatePatch',
|
|
59764
|
+
requestBody: {
|
|
59765
|
+
content: {
|
|
59766
|
+
'application/json': {
|
|
59767
|
+
schema: {
|
|
59768
|
+
properties: {
|
|
59769
|
+
low_battery_alert_threshold: {
|
|
59770
|
+
description: "Battery level, from 0 to 1, at or below which `device.low_battery` events fire for this customer's devices. Pass `null` to fall back to the workspace default.",
|
|
59771
|
+
format: 'float',
|
|
59772
|
+
maximum: 1,
|
|
59773
|
+
minimum: 0,
|
|
59774
|
+
nullable: true,
|
|
59775
|
+
type: 'number',
|
|
59776
|
+
},
|
|
59777
|
+
},
|
|
59778
|
+
type: 'object',
|
|
59779
|
+
},
|
|
59780
|
+
},
|
|
59781
|
+
},
|
|
59782
|
+
},
|
|
59783
|
+
responses: {
|
|
59784
|
+
'200': {
|
|
59785
|
+
content: {
|
|
59786
|
+
'application/json': {
|
|
59787
|
+
schema: {
|
|
59788
|
+
properties: { ok: { type: 'boolean' } },
|
|
59789
|
+
required: ['ok'],
|
|
59790
|
+
type: 'object',
|
|
59791
|
+
},
|
|
59792
|
+
},
|
|
59793
|
+
},
|
|
59794
|
+
description: 'OK',
|
|
59795
|
+
},
|
|
59796
|
+
'400': { description: 'Bad Request' },
|
|
59797
|
+
'401': { description: 'Unauthorized' },
|
|
59798
|
+
},
|
|
59799
|
+
security: [{ client_session_with_customer: [] }],
|
|
59800
|
+
summary: '/seam/customer/v1/customers/notifications/update',
|
|
59801
|
+
tags: [],
|
|
59802
|
+
'x-fern-sdk-group-name': [
|
|
59803
|
+
'seam',
|
|
59804
|
+
'customer',
|
|
59805
|
+
'v1',
|
|
59806
|
+
'customers',
|
|
59807
|
+
'notifications',
|
|
59808
|
+
],
|
|
59809
|
+
'x-fern-sdk-method-name': 'update',
|
|
59810
|
+
'x-response-key': null,
|
|
59811
|
+
'x-title': 'Update Customer Notification Settings',
|
|
59812
|
+
'x-undocumented': 'Internal endpoint for customer portals.',
|
|
59813
|
+
},
|
|
59814
|
+
},
|
|
59241
59815
|
'/seam/customer/v1/customers/open_portal': {
|
|
59242
59816
|
post: {
|
|
59243
59817
|
description: 'Opens an existing customer portal or creates a new one if the previous portal has expired.\nReturns an error if no portal was ever created for this customer.',
|
|
@@ -59841,6 +60415,11 @@ const openapi = {
|
|
|
59841
60415
|
description: 'Indicates whether the customer can customize the Instant Key profile for their properties.',
|
|
59842
60416
|
type: 'boolean',
|
|
59843
60417
|
},
|
|
60418
|
+
allow_notification_customization: {
|
|
60419
|
+
default: false,
|
|
60420
|
+
description: 'Indicates whether the customer can customize their notification settings, such as the low-battery alert threshold.',
|
|
60421
|
+
type: 'boolean',
|
|
60422
|
+
},
|
|
59844
60423
|
exclude: {
|
|
59845
60424
|
default: false,
|
|
59846
60425
|
description: 'Whether to exclude this feature from the portal.',
|
|
@@ -60267,6 +60846,11 @@ const openapi = {
|
|
|
60267
60846
|
description: 'Indicates whether the customer can customize the Instant Key profile for their properties.',
|
|
60268
60847
|
type: 'boolean',
|
|
60269
60848
|
},
|
|
60849
|
+
allow_notification_customization: {
|
|
60850
|
+
default: false,
|
|
60851
|
+
description: 'Indicates whether the customer can customize their notification settings, such as the low-battery alert threshold.',
|
|
60852
|
+
type: 'boolean',
|
|
60853
|
+
},
|
|
60270
60854
|
exclude: {
|
|
60271
60855
|
default: false,
|
|
60272
60856
|
description: 'Whether to exclude this feature from the portal.',
|