@seamapi/types 1.1106.0 → 1.1108.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.
@@ -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.',
@@ -59238,6 +59244,124 @@ const openapi = {
59238
59244
  'x-undocumented': 'Internal endpoint for customer portals.',
59239
59245
  },
59240
59246
  },
59247
+ '/seam/customer/v1/customers/notifications/get': {
59248
+ get: {
59249
+ description: 'Gets the notification settings for the authenticated customer, along with the workspace defaults they inherit when unset.',
59250
+ operationId: 'seamCustomerV1CustomersNotificationsGetGet',
59251
+ responses: {
59252
+ '200': {
59253
+ content: {
59254
+ 'application/json': {
59255
+ schema: {
59256
+ properties: {
59257
+ notification_settings: {
59258
+ properties: {
59259
+ low_battery_alert_threshold: {
59260
+ 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.",
59261
+ format: 'float',
59262
+ nullable: true,
59263
+ type: 'number',
59264
+ },
59265
+ workspace_default_low_battery_alert_threshold: {
59266
+ description: 'Workspace-level low-battery alert threshold that applies when the customer has not set one. `null` means the device default applies.',
59267
+ format: 'float',
59268
+ nullable: true,
59269
+ type: 'number',
59270
+ },
59271
+ },
59272
+ required: [
59273
+ 'low_battery_alert_threshold',
59274
+ 'workspace_default_low_battery_alert_threshold',
59275
+ ],
59276
+ type: 'object',
59277
+ },
59278
+ ok: { type: 'boolean' },
59279
+ },
59280
+ required: ['notification_settings', 'ok'],
59281
+ type: 'object',
59282
+ },
59283
+ },
59284
+ },
59285
+ description: 'OK',
59286
+ },
59287
+ '400': { description: 'Bad Request' },
59288
+ '401': { description: 'Unauthorized' },
59289
+ },
59290
+ security: [
59291
+ { client_session_with_customer: [] },
59292
+ { client_session_with_customer_ro: [] },
59293
+ ],
59294
+ summary: '/seam/customer/v1/customers/notifications/get',
59295
+ tags: [],
59296
+ 'x-fern-sdk-group-name': [
59297
+ 'seam',
59298
+ 'customer',
59299
+ 'v1',
59300
+ 'customers',
59301
+ 'notifications',
59302
+ ],
59303
+ 'x-fern-sdk-method-name': 'get',
59304
+ 'x-fern-sdk-return-value': 'notification_settings',
59305
+ 'x-response-key': 'notification_settings',
59306
+ 'x-title': 'Get Customer Notification Settings',
59307
+ 'x-undocumented': 'Internal endpoint for customer portals.',
59308
+ },
59309
+ },
59310
+ '/seam/customer/v1/customers/notifications/update': {
59311
+ patch: {
59312
+ description: 'Updates the notification settings for the authenticated customer. Requires a customer portal with `features.configure.allow_notification_customization` enabled.',
59313
+ operationId: 'seamCustomerV1CustomersNotificationsUpdatePatch',
59314
+ requestBody: {
59315
+ content: {
59316
+ 'application/json': {
59317
+ schema: {
59318
+ properties: {
59319
+ low_battery_alert_threshold: {
59320
+ 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.",
59321
+ format: 'float',
59322
+ maximum: 1,
59323
+ minimum: 0,
59324
+ nullable: true,
59325
+ type: 'number',
59326
+ },
59327
+ },
59328
+ type: 'object',
59329
+ },
59330
+ },
59331
+ },
59332
+ },
59333
+ responses: {
59334
+ '200': {
59335
+ content: {
59336
+ 'application/json': {
59337
+ schema: {
59338
+ properties: { ok: { type: 'boolean' } },
59339
+ required: ['ok'],
59340
+ type: 'object',
59341
+ },
59342
+ },
59343
+ },
59344
+ description: 'OK',
59345
+ },
59346
+ '400': { description: 'Bad Request' },
59347
+ '401': { description: 'Unauthorized' },
59348
+ },
59349
+ security: [{ client_session_with_customer: [] }],
59350
+ summary: '/seam/customer/v1/customers/notifications/update',
59351
+ tags: [],
59352
+ 'x-fern-sdk-group-name': [
59353
+ 'seam',
59354
+ 'customer',
59355
+ 'v1',
59356
+ 'customers',
59357
+ 'notifications',
59358
+ ],
59359
+ 'x-fern-sdk-method-name': 'update',
59360
+ 'x-response-key': null,
59361
+ 'x-title': 'Update Customer Notification Settings',
59362
+ 'x-undocumented': 'Internal endpoint for customer portals.',
59363
+ },
59364
+ },
59241
59365
  '/seam/customer/v1/customers/open_portal': {
59242
59366
  post: {
59243
59367
  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 +59965,11 @@ const openapi = {
59841
59965
  description: 'Indicates whether the customer can customize the Instant Key profile for their properties.',
59842
59966
  type: 'boolean',
59843
59967
  },
59968
+ allow_notification_customization: {
59969
+ default: false,
59970
+ description: 'Indicates whether the customer can customize their notification settings, such as the low-battery alert threshold.',
59971
+ type: 'boolean',
59972
+ },
59844
59973
  exclude: {
59845
59974
  default: false,
59846
59975
  description: 'Whether to exclude this feature from the portal.',
@@ -60267,6 +60396,11 @@ const openapi = {
60267
60396
  description: 'Indicates whether the customer can customize the Instant Key profile for their properties.',
60268
60397
  type: 'boolean',
60269
60398
  },
60399
+ allow_notification_customization: {
60400
+ default: false,
60401
+ description: 'Indicates whether the customer can customize their notification settings, such as the low-battery alert threshold.',
60402
+ type: 'boolean',
60403
+ },
60270
60404
  exclude: {
60271
60405
  default: false,
60272
60406
  description: 'Whether to exclude this feature from the portal.',
@@ -64179,6 +64313,370 @@ const openapi = {
64179
64313
  'x-title': 'Update a Space',
64180
64314
  },
64181
64315
  },
64316
+ '/speakers/mute': {
64317
+ post: {
64318
+ description: 'Mutes a specified speaker. To check whether a speaker supports muting, use `device.can_mute_speaker`.',
64319
+ operationId: 'speakersMutePost',
64320
+ requestBody: {
64321
+ content: {
64322
+ 'application/json': {
64323
+ schema: {
64324
+ properties: {
64325
+ device_id: {
64326
+ description: 'ID of the speaker that you want to mute.',
64327
+ format: 'uuid',
64328
+ type: 'string',
64329
+ },
64330
+ },
64331
+ required: ['device_id'],
64332
+ type: 'object',
64333
+ },
64334
+ },
64335
+ },
64336
+ },
64337
+ responses: {
64338
+ '200': {
64339
+ content: {
64340
+ 'application/json': {
64341
+ schema: {
64342
+ properties: {
64343
+ action_attempt: {
64344
+ $ref: '#/components/schemas/action_attempt',
64345
+ },
64346
+ ok: { type: 'boolean' },
64347
+ },
64348
+ required: ['action_attempt', 'ok'],
64349
+ type: 'object',
64350
+ },
64351
+ },
64352
+ },
64353
+ description: 'OK',
64354
+ },
64355
+ '400': { description: 'Bad Request' },
64356
+ '401': { description: 'Unauthorized' },
64357
+ },
64358
+ security: [
64359
+ { client_session: [] },
64360
+ { pat_with_workspace: [] },
64361
+ { console_session_with_workspace: [] },
64362
+ { api_key: [] },
64363
+ ],
64364
+ summary: '/speakers/mute',
64365
+ tags: [],
64366
+ 'x-action-attempt-type': 'SET_SPEAKER_MUTE',
64367
+ 'x-fern-sdk-group-name': ['speakers'],
64368
+ 'x-fern-sdk-method-name': 'mute',
64369
+ 'x-fern-sdk-return-value': 'action_attempt',
64370
+ 'x-response-key': 'action_attempt',
64371
+ 'x-title': 'Mute a Speaker',
64372
+ 'x-undocumented': 'Unreleased.',
64373
+ },
64374
+ },
64375
+ '/speakers/pause': {
64376
+ post: {
64377
+ description: 'Pauses playback on a specified speaker. Playback also pauses on the speakers grouped with it, and the action attempt result lists every affected speaker. To check whether a speaker supports pausing playback, use `device.can_pause_speaker_playback`.',
64378
+ operationId: 'speakersPausePost',
64379
+ requestBody: {
64380
+ content: {
64381
+ 'application/json': {
64382
+ schema: {
64383
+ properties: {
64384
+ device_id: {
64385
+ description: 'ID of the speaker on which you want to pause playback.',
64386
+ format: 'uuid',
64387
+ type: 'string',
64388
+ },
64389
+ },
64390
+ required: ['device_id'],
64391
+ type: 'object',
64392
+ },
64393
+ },
64394
+ },
64395
+ },
64396
+ responses: {
64397
+ '200': {
64398
+ content: {
64399
+ 'application/json': {
64400
+ schema: {
64401
+ properties: {
64402
+ action_attempt: {
64403
+ $ref: '#/components/schemas/action_attempt',
64404
+ },
64405
+ ok: { type: 'boolean' },
64406
+ },
64407
+ required: ['action_attempt', 'ok'],
64408
+ type: 'object',
64409
+ },
64410
+ },
64411
+ },
64412
+ description: 'OK',
64413
+ },
64414
+ '400': { description: 'Bad Request' },
64415
+ '401': { description: 'Unauthorized' },
64416
+ },
64417
+ security: [
64418
+ { client_session: [] },
64419
+ { pat_with_workspace: [] },
64420
+ { console_session_with_workspace: [] },
64421
+ { api_key: [] },
64422
+ ],
64423
+ summary: '/speakers/pause',
64424
+ tags: [],
64425
+ 'x-action-attempt-type': 'PAUSE_SPEAKER_PLAYBACK',
64426
+ 'x-fern-sdk-group-name': ['speakers'],
64427
+ 'x-fern-sdk-method-name': 'pause',
64428
+ 'x-fern-sdk-return-value': 'action_attempt',
64429
+ 'x-response-key': 'action_attempt',
64430
+ 'x-title': 'Pause Playback on a Speaker',
64431
+ 'x-undocumented': 'Unreleased.',
64432
+ },
64433
+ },
64434
+ '/speakers/play_chime': {
64435
+ post: {
64436
+ description: 'Plays a short chime on a specified speaker. To check whether a speaker supports playing a chime, use `device.can_play_speaker_chime`.',
64437
+ operationId: 'speakersPlayChimePost',
64438
+ requestBody: {
64439
+ content: {
64440
+ 'application/json': {
64441
+ schema: {
64442
+ properties: {
64443
+ device_id: {
64444
+ description: 'ID of the speaker on which you want to play a chime.',
64445
+ format: 'uuid',
64446
+ type: 'string',
64447
+ },
64448
+ volume: {
64449
+ description: "Volume at which to play the chime, on the speaker's native volume scale. If you omit this parameter, the chime plays at the speaker's current volume.",
64450
+ format: 'float',
64451
+ type: 'number',
64452
+ },
64453
+ },
64454
+ required: ['device_id'],
64455
+ type: 'object',
64456
+ },
64457
+ },
64458
+ },
64459
+ },
64460
+ responses: {
64461
+ '200': {
64462
+ content: {
64463
+ 'application/json': {
64464
+ schema: {
64465
+ properties: {
64466
+ action_attempt: {
64467
+ $ref: '#/components/schemas/action_attempt',
64468
+ },
64469
+ ok: { type: 'boolean' },
64470
+ },
64471
+ required: ['action_attempt', 'ok'],
64472
+ type: 'object',
64473
+ },
64474
+ },
64475
+ },
64476
+ description: 'OK',
64477
+ },
64478
+ '400': { description: 'Bad Request' },
64479
+ '401': { description: 'Unauthorized' },
64480
+ },
64481
+ security: [
64482
+ { client_session: [] },
64483
+ { pat_with_workspace: [] },
64484
+ { console_session_with_workspace: [] },
64485
+ { api_key: [] },
64486
+ ],
64487
+ summary: '/speakers/play_chime',
64488
+ tags: [],
64489
+ 'x-action-attempt-type': 'PLAY_SPEAKER_CHIME',
64490
+ 'x-fern-sdk-group-name': ['speakers'],
64491
+ 'x-fern-sdk-method-name': 'play_chime',
64492
+ 'x-fern-sdk-return-value': 'action_attempt',
64493
+ 'x-response-key': 'action_attempt',
64494
+ 'x-title': 'Play a Chime on a Speaker',
64495
+ 'x-undocumented': 'Unreleased.',
64496
+ },
64497
+ },
64498
+ '/speakers/resume': {
64499
+ post: {
64500
+ 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_pause_speaker_playback`.',
64501
+ operationId: 'speakersResumePost',
64502
+ requestBody: {
64503
+ content: {
64504
+ 'application/json': {
64505
+ schema: {
64506
+ properties: {
64507
+ device_id: {
64508
+ description: 'ID of the speaker on which you want to resume playback.',
64509
+ format: 'uuid',
64510
+ type: 'string',
64511
+ },
64512
+ },
64513
+ required: ['device_id'],
64514
+ type: 'object',
64515
+ },
64516
+ },
64517
+ },
64518
+ },
64519
+ responses: {
64520
+ '200': {
64521
+ content: {
64522
+ 'application/json': {
64523
+ schema: {
64524
+ properties: {
64525
+ action_attempt: {
64526
+ $ref: '#/components/schemas/action_attempt',
64527
+ },
64528
+ ok: { type: 'boolean' },
64529
+ },
64530
+ required: ['action_attempt', 'ok'],
64531
+ type: 'object',
64532
+ },
64533
+ },
64534
+ },
64535
+ description: 'OK',
64536
+ },
64537
+ '400': { description: 'Bad Request' },
64538
+ '401': { description: 'Unauthorized' },
64539
+ },
64540
+ security: [
64541
+ { client_session: [] },
64542
+ { pat_with_workspace: [] },
64543
+ { console_session_with_workspace: [] },
64544
+ { api_key: [] },
64545
+ ],
64546
+ summary: '/speakers/resume',
64547
+ tags: [],
64548
+ 'x-action-attempt-type': 'RESUME_SPEAKER_PLAYBACK',
64549
+ 'x-fern-sdk-group-name': ['speakers'],
64550
+ 'x-fern-sdk-method-name': 'resume',
64551
+ 'x-fern-sdk-return-value': 'action_attempt',
64552
+ 'x-response-key': 'action_attempt',
64553
+ 'x-title': 'Resume Playback on a Speaker',
64554
+ 'x-undocumented': 'Unreleased.',
64555
+ },
64556
+ },
64557
+ '/speakers/set_volume': {
64558
+ post: {
64559
+ description: "Sets the volume of a specified speaker. The volume must be between the speaker's `properties.speaker.min_volume` and `properties.speaker.max_volume`, in increments of `properties.speaker.volume_step`. To check whether a speaker supports setting its volume, use `device.can_set_speaker_volume`.",
64560
+ operationId: 'speakersSetVolumePost',
64561
+ requestBody: {
64562
+ content: {
64563
+ 'application/json': {
64564
+ schema: {
64565
+ properties: {
64566
+ device_id: {
64567
+ description: 'ID of the speaker for which you want to set the volume.',
64568
+ format: 'uuid',
64569
+ type: 'string',
64570
+ },
64571
+ volume: {
64572
+ description: "Volume that you want to set, on the speaker's native volume scale.",
64573
+ format: 'float',
64574
+ type: 'number',
64575
+ },
64576
+ },
64577
+ required: ['device_id', 'volume'],
64578
+ type: 'object',
64579
+ },
64580
+ },
64581
+ },
64582
+ },
64583
+ responses: {
64584
+ '200': {
64585
+ content: {
64586
+ 'application/json': {
64587
+ schema: {
64588
+ properties: {
64589
+ action_attempt: {
64590
+ $ref: '#/components/schemas/action_attempt',
64591
+ },
64592
+ ok: { type: 'boolean' },
64593
+ },
64594
+ required: ['action_attempt', 'ok'],
64595
+ type: 'object',
64596
+ },
64597
+ },
64598
+ },
64599
+ description: 'OK',
64600
+ },
64601
+ '400': { description: 'Bad Request' },
64602
+ '401': { description: 'Unauthorized' },
64603
+ },
64604
+ security: [
64605
+ { client_session: [] },
64606
+ { pat_with_workspace: [] },
64607
+ { console_session_with_workspace: [] },
64608
+ { api_key: [] },
64609
+ ],
64610
+ summary: '/speakers/set_volume',
64611
+ tags: [],
64612
+ 'x-action-attempt-type': 'SET_SPEAKER_VOLUME',
64613
+ 'x-fern-sdk-group-name': ['speakers'],
64614
+ 'x-fern-sdk-method-name': 'set_volume',
64615
+ 'x-fern-sdk-return-value': 'action_attempt',
64616
+ 'x-response-key': 'action_attempt',
64617
+ 'x-title': 'Set the Volume of a Speaker',
64618
+ 'x-undocumented': 'Unreleased.',
64619
+ },
64620
+ },
64621
+ '/speakers/unmute': {
64622
+ post: {
64623
+ description: 'Unmutes a specified speaker. To check whether a speaker supports unmuting, use `device.can_mute_speaker`.',
64624
+ operationId: 'speakersUnmutePost',
64625
+ requestBody: {
64626
+ content: {
64627
+ 'application/json': {
64628
+ schema: {
64629
+ properties: {
64630
+ device_id: {
64631
+ description: 'ID of the speaker that you want to unmute.',
64632
+ format: 'uuid',
64633
+ type: 'string',
64634
+ },
64635
+ },
64636
+ required: ['device_id'],
64637
+ type: 'object',
64638
+ },
64639
+ },
64640
+ },
64641
+ },
64642
+ responses: {
64643
+ '200': {
64644
+ content: {
64645
+ 'application/json': {
64646
+ schema: {
64647
+ properties: {
64648
+ action_attempt: {
64649
+ $ref: '#/components/schemas/action_attempt',
64650
+ },
64651
+ ok: { type: 'boolean' },
64652
+ },
64653
+ required: ['action_attempt', 'ok'],
64654
+ type: 'object',
64655
+ },
64656
+ },
64657
+ },
64658
+ description: 'OK',
64659
+ },
64660
+ '400': { description: 'Bad Request' },
64661
+ '401': { description: 'Unauthorized' },
64662
+ },
64663
+ security: [
64664
+ { client_session: [] },
64665
+ { pat_with_workspace: [] },
64666
+ { console_session_with_workspace: [] },
64667
+ { api_key: [] },
64668
+ ],
64669
+ summary: '/speakers/unmute',
64670
+ tags: [],
64671
+ 'x-action-attempt-type': 'SET_SPEAKER_MUTE',
64672
+ 'x-fern-sdk-group-name': ['speakers'],
64673
+ 'x-fern-sdk-method-name': 'unmute',
64674
+ 'x-fern-sdk-return-value': 'action_attempt',
64675
+ 'x-response-key': 'action_attempt',
64676
+ 'x-title': 'Unmute a Speaker',
64677
+ 'x-undocumented': 'Unreleased.',
64678
+ },
64679
+ },
64182
64680
  '/thermostats/activate_climate_preset': {
64183
64681
  post: {
64184
64682
  description: 'Activates a specified [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) for a specified [thermostat](https://www.seam.co/docs/capability-guides/thermostats).',