@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.
@@ -50778,6 +50778,7 @@ const openapi: OpenAPISpec = {
50778
50778
  allow_access_automation_rule_customization: false,
50779
50779
  allow_climate_automation_rule_customization: false,
50780
50780
  allow_instant_key_customization: false,
50781
+ allow_notification_customization: false,
50781
50782
  exclude: false,
50782
50783
  },
50783
50784
  connect: { exclude: false },
@@ -50920,6 +50921,12 @@ const openapi: OpenAPISpec = {
50920
50921
  'Indicates whether the customer can customize the Instant Key profile for their properties.',
50921
50922
  type: 'boolean',
50922
50923
  },
50924
+ allow_notification_customization: {
50925
+ default: false,
50926
+ description:
50927
+ 'Indicates whether the customer can customize their notification settings, such as the low-battery alert threshold.',
50928
+ type: 'boolean',
50929
+ },
50923
50930
  exclude: {
50924
50931
  default: false,
50925
50932
  description:
@@ -62633,6 +62640,101 @@ const openapi: OpenAPISpec = {
62633
62640
  type: 'object',
62634
62641
  },
62635
62642
  ok: { type: 'boolean' },
62643
+ sound_rules: {
62644
+ properties: {
62645
+ rules: {
62646
+ properties: {
62647
+ reservation_created: {
62648
+ properties: {
62649
+ on_check_in: {
62650
+ properties: {
62651
+ minutes_before_check_in: {
62652
+ maximum: 1440,
62653
+ minimum: 0,
62654
+ type: 'integer',
62655
+ },
62656
+ noise_sensors: {
62657
+ properties: {
62658
+ noise_thresholds: {
62659
+ items: {
62660
+ $ref: '#/components/schemas/noise_threshold',
62661
+ },
62662
+ maxItems: 10,
62663
+ type: 'array',
62664
+ },
62665
+ },
62666
+ required: ['noise_thresholds'],
62667
+ type: 'object',
62668
+ },
62669
+ speakers: {
62670
+ properties: {
62671
+ play_chime: { type: 'boolean' },
62672
+ set_volume_to: {
62673
+ maximum: 100,
62674
+ minimum: 0,
62675
+ type: 'integer',
62676
+ },
62677
+ unmute: { type: 'boolean' },
62678
+ },
62679
+ type: 'object',
62680
+ },
62681
+ },
62682
+ type: 'object',
62683
+ },
62684
+ on_check_out: {
62685
+ properties: {
62686
+ minutes_after_check_out: {
62687
+ maximum: 1440,
62688
+ minimum: 0,
62689
+ type: 'integer',
62690
+ },
62691
+ noise_sensors: {
62692
+ properties: {
62693
+ noise_thresholds: {
62694
+ items: {
62695
+ $ref: '#/components/schemas/noise_threshold',
62696
+ },
62697
+ maxItems: 10,
62698
+ type: 'array',
62699
+ },
62700
+ },
62701
+ required: ['noise_thresholds'],
62702
+ type: 'object',
62703
+ },
62704
+ speakers: {
62705
+ properties: {
62706
+ pause_playback: { type: 'boolean' },
62707
+ reset_volume_to: {
62708
+ maximum: 100,
62709
+ minimum: 0,
62710
+ type: 'integer',
62711
+ },
62712
+ unmute: { type: 'boolean' },
62713
+ },
62714
+ type: 'object',
62715
+ },
62716
+ },
62717
+ type: 'object',
62718
+ },
62719
+ },
62720
+ type: 'object',
62721
+ },
62722
+ reservation_deleted: {
62723
+ $ref: '#/components/schemas/access_code',
62724
+ },
62725
+ reservation_spaces_updated: {
62726
+ $ref: '#/components/schemas/access_code',
62727
+ },
62728
+ reservation_time_updated: {
62729
+ $ref: '#/components/schemas/access_code',
62730
+ },
62731
+ },
62732
+ type: 'object',
62733
+ },
62734
+ },
62735
+ required: ['rules'],
62736
+ type: 'object',
62737
+ },
62636
62738
  },
62637
62739
  required: ['ok'],
62638
62740
  type: 'object',
@@ -62932,6 +63034,136 @@ const openapi: OpenAPISpec = {
62932
63034
  minLength: 1,
62933
63035
  type: 'string',
62934
63036
  },
63037
+ sound_rules: {
63038
+ description: 'Sound automation rules configuration.',
63039
+ properties: {
63040
+ rules: {
63041
+ properties: {
63042
+ reservation_created: {
63043
+ nullable: true,
63044
+ properties: {
63045
+ on_check_in: {
63046
+ properties: {
63047
+ minutes_before_check_in: {
63048
+ maximum: 1440,
63049
+ minimum: 0,
63050
+ type: 'integer',
63051
+ },
63052
+ noise_sensors: {
63053
+ properties: {
63054
+ noise_thresholds: {
63055
+ items: {
63056
+ properties: {
63057
+ ends_daily_at: { type: 'string' },
63058
+ name: { type: 'string' },
63059
+ noise_threshold_decibels: {
63060
+ format: 'float',
63061
+ type: 'number',
63062
+ },
63063
+ starts_daily_at: { type: 'string' },
63064
+ },
63065
+ required: [
63066
+ 'starts_daily_at',
63067
+ 'ends_daily_at',
63068
+ 'noise_threshold_decibels',
63069
+ ],
63070
+ type: 'object',
63071
+ },
63072
+ maxItems: 10,
63073
+ type: 'array',
63074
+ },
63075
+ },
63076
+ required: ['noise_thresholds'],
63077
+ type: 'object',
63078
+ },
63079
+ speakers: {
63080
+ properties: {
63081
+ play_chime: { type: 'boolean' },
63082
+ set_volume_to: {
63083
+ maximum: 100,
63084
+ minimum: 0,
63085
+ type: 'integer',
63086
+ },
63087
+ unmute: { type: 'boolean' },
63088
+ },
63089
+ type: 'object',
63090
+ },
63091
+ },
63092
+ type: 'object',
63093
+ },
63094
+ on_check_out: {
63095
+ properties: {
63096
+ minutes_after_check_out: {
63097
+ maximum: 1440,
63098
+ minimum: 0,
63099
+ type: 'integer',
63100
+ },
63101
+ noise_sensors: {
63102
+ properties: {
63103
+ noise_thresholds: {
63104
+ items: {
63105
+ properties: {
63106
+ ends_daily_at: { type: 'string' },
63107
+ name: { type: 'string' },
63108
+ noise_threshold_decibels: {
63109
+ format: 'float',
63110
+ type: 'number',
63111
+ },
63112
+ starts_daily_at: { type: 'string' },
63113
+ },
63114
+ required: [
63115
+ 'starts_daily_at',
63116
+ 'ends_daily_at',
63117
+ 'noise_threshold_decibels',
63118
+ ],
63119
+ type: 'object',
63120
+ },
63121
+ maxItems: 10,
63122
+ type: 'array',
63123
+ },
63124
+ },
63125
+ required: ['noise_thresholds'],
63126
+ type: 'object',
63127
+ },
63128
+ speakers: {
63129
+ properties: {
63130
+ pause_playback: { type: 'boolean' },
63131
+ reset_volume_to: {
63132
+ maximum: 100,
63133
+ minimum: 0,
63134
+ type: 'integer',
63135
+ },
63136
+ unmute: { type: 'boolean' },
63137
+ },
63138
+ type: 'object',
63139
+ },
63140
+ },
63141
+ type: 'object',
63142
+ },
63143
+ },
63144
+ type: 'object',
63145
+ },
63146
+ reservation_deleted: {
63147
+ nullable: true,
63148
+ properties: {},
63149
+ type: 'object',
63150
+ },
63151
+ reservation_spaces_updated: {
63152
+ nullable: true,
63153
+ properties: {},
63154
+ type: 'object',
63155
+ },
63156
+ reservation_time_updated: {
63157
+ nullable: true,
63158
+ properties: {},
63159
+ type: 'object',
63160
+ },
63161
+ },
63162
+ type: 'object',
63163
+ },
63164
+ },
63165
+ type: 'object',
63166
+ },
62935
63167
  },
62936
63168
  type: 'object',
62937
63169
  },
@@ -64249,6 +64481,101 @@ const openapi: OpenAPISpec = {
64249
64481
  required: ['rules'],
64250
64482
  type: 'object',
64251
64483
  },
64484
+ sound_rules: {
64485
+ properties: {
64486
+ rules: {
64487
+ properties: {
64488
+ reservation_created: {
64489
+ properties: {
64490
+ on_check_in: {
64491
+ properties: {
64492
+ minutes_before_check_in: {
64493
+ maximum: 1440,
64494
+ minimum: 0,
64495
+ type: 'integer',
64496
+ },
64497
+ noise_sensors: {
64498
+ properties: {
64499
+ noise_thresholds: {
64500
+ items: {
64501
+ $ref: '#/components/schemas/noise_threshold',
64502
+ },
64503
+ maxItems: 10,
64504
+ type: 'array',
64505
+ },
64506
+ },
64507
+ required: ['noise_thresholds'],
64508
+ type: 'object',
64509
+ },
64510
+ speakers: {
64511
+ properties: {
64512
+ play_chime: { type: 'boolean' },
64513
+ set_volume_to: {
64514
+ maximum: 100,
64515
+ minimum: 0,
64516
+ type: 'integer',
64517
+ },
64518
+ unmute: { type: 'boolean' },
64519
+ },
64520
+ type: 'object',
64521
+ },
64522
+ },
64523
+ type: 'object',
64524
+ },
64525
+ on_check_out: {
64526
+ properties: {
64527
+ minutes_after_check_out: {
64528
+ maximum: 1440,
64529
+ minimum: 0,
64530
+ type: 'integer',
64531
+ },
64532
+ noise_sensors: {
64533
+ properties: {
64534
+ noise_thresholds: {
64535
+ items: {
64536
+ $ref: '#/components/schemas/noise_threshold',
64537
+ },
64538
+ maxItems: 10,
64539
+ type: 'array',
64540
+ },
64541
+ },
64542
+ required: ['noise_thresholds'],
64543
+ type: 'object',
64544
+ },
64545
+ speakers: {
64546
+ properties: {
64547
+ pause_playback: { type: 'boolean' },
64548
+ reset_volume_to: {
64549
+ maximum: 100,
64550
+ minimum: 0,
64551
+ type: 'integer',
64552
+ },
64553
+ unmute: { type: 'boolean' },
64554
+ },
64555
+ type: 'object',
64556
+ },
64557
+ },
64558
+ type: 'object',
64559
+ },
64560
+ },
64561
+ type: 'object',
64562
+ },
64563
+ reservation_deleted: {
64564
+ $ref: '#/components/schemas/access_code',
64565
+ },
64566
+ reservation_spaces_updated: {
64567
+ $ref: '#/components/schemas/access_code',
64568
+ },
64569
+ reservation_time_updated: {
64570
+ $ref: '#/components/schemas/access_code',
64571
+ },
64572
+ },
64573
+ type: 'object',
64574
+ },
64575
+ },
64576
+ required: ['rules'],
64577
+ type: 'object',
64578
+ },
64252
64579
  },
64253
64580
  type: 'object',
64254
64581
  },
@@ -64556,6 +64883,136 @@ const openapi: OpenAPISpec = {
64556
64883
  },
64557
64884
  type: 'object',
64558
64885
  },
64886
+ sound_rules: {
64887
+ description: 'Sound automation rules configuration.',
64888
+ properties: {
64889
+ rules: {
64890
+ properties: {
64891
+ reservation_created: {
64892
+ nullable: true,
64893
+ properties: {
64894
+ on_check_in: {
64895
+ properties: {
64896
+ minutes_before_check_in: {
64897
+ maximum: 1440,
64898
+ minimum: 0,
64899
+ type: 'integer',
64900
+ },
64901
+ noise_sensors: {
64902
+ properties: {
64903
+ noise_thresholds: {
64904
+ items: {
64905
+ properties: {
64906
+ ends_daily_at: { type: 'string' },
64907
+ name: { type: 'string' },
64908
+ noise_threshold_decibels: {
64909
+ format: 'float',
64910
+ type: 'number',
64911
+ },
64912
+ starts_daily_at: { type: 'string' },
64913
+ },
64914
+ required: [
64915
+ 'starts_daily_at',
64916
+ 'ends_daily_at',
64917
+ 'noise_threshold_decibels',
64918
+ ],
64919
+ type: 'object',
64920
+ },
64921
+ maxItems: 10,
64922
+ type: 'array',
64923
+ },
64924
+ },
64925
+ required: ['noise_thresholds'],
64926
+ type: 'object',
64927
+ },
64928
+ speakers: {
64929
+ properties: {
64930
+ play_chime: { type: 'boolean' },
64931
+ set_volume_to: {
64932
+ maximum: 100,
64933
+ minimum: 0,
64934
+ type: 'integer',
64935
+ },
64936
+ unmute: { type: 'boolean' },
64937
+ },
64938
+ type: 'object',
64939
+ },
64940
+ },
64941
+ type: 'object',
64942
+ },
64943
+ on_check_out: {
64944
+ properties: {
64945
+ minutes_after_check_out: {
64946
+ maximum: 1440,
64947
+ minimum: 0,
64948
+ type: 'integer',
64949
+ },
64950
+ noise_sensors: {
64951
+ properties: {
64952
+ noise_thresholds: {
64953
+ items: {
64954
+ properties: {
64955
+ ends_daily_at: { type: 'string' },
64956
+ name: { type: 'string' },
64957
+ noise_threshold_decibels: {
64958
+ format: 'float',
64959
+ type: 'number',
64960
+ },
64961
+ starts_daily_at: { type: 'string' },
64962
+ },
64963
+ required: [
64964
+ 'starts_daily_at',
64965
+ 'ends_daily_at',
64966
+ 'noise_threshold_decibels',
64967
+ ],
64968
+ type: 'object',
64969
+ },
64970
+ maxItems: 10,
64971
+ type: 'array',
64972
+ },
64973
+ },
64974
+ required: ['noise_thresholds'],
64975
+ type: 'object',
64976
+ },
64977
+ speakers: {
64978
+ properties: {
64979
+ pause_playback: { type: 'boolean' },
64980
+ reset_volume_to: {
64981
+ maximum: 100,
64982
+ minimum: 0,
64983
+ type: 'integer',
64984
+ },
64985
+ unmute: { type: 'boolean' },
64986
+ },
64987
+ type: 'object',
64988
+ },
64989
+ },
64990
+ type: 'object',
64991
+ },
64992
+ },
64993
+ type: 'object',
64994
+ },
64995
+ reservation_deleted: {
64996
+ nullable: true,
64997
+ properties: {},
64998
+ type: 'object',
64999
+ },
65000
+ reservation_spaces_updated: {
65001
+ nullable: true,
65002
+ properties: {},
65003
+ type: 'object',
65004
+ },
65005
+ reservation_time_updated: {
65006
+ nullable: true,
65007
+ properties: {},
65008
+ type: 'object',
65009
+ },
65010
+ },
65011
+ type: 'object',
65012
+ },
65013
+ },
65014
+ type: 'object',
65015
+ },
64559
65016
  },
64560
65017
  type: 'object',
64561
65018
  },
@@ -64770,6 +65227,129 @@ const openapi: OpenAPISpec = {
64770
65227
  'x-undocumented': 'Internal endpoint for customer portals.',
64771
65228
  },
64772
65229
  },
65230
+ '/seam/customer/v1/customers/notifications/get': {
65231
+ get: {
65232
+ description:
65233
+ 'Gets the notification settings for the authenticated customer, along with the workspace defaults they inherit when unset.',
65234
+ operationId: 'seamCustomerV1CustomersNotificationsGetGet',
65235
+ responses: {
65236
+ '200': {
65237
+ content: {
65238
+ 'application/json': {
65239
+ schema: {
65240
+ properties: {
65241
+ notification_settings: {
65242
+ properties: {
65243
+ low_battery_alert_threshold: {
65244
+ description:
65245
+ "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.",
65246
+ format: 'float',
65247
+ nullable: true,
65248
+ type: 'number',
65249
+ },
65250
+ workspace_default_low_battery_alert_threshold: {
65251
+ description:
65252
+ 'Workspace-level low-battery alert threshold that applies when the customer has not set one. `null` means the device default applies.',
65253
+ format: 'float',
65254
+ nullable: true,
65255
+ type: 'number',
65256
+ },
65257
+ },
65258
+ required: [
65259
+ 'low_battery_alert_threshold',
65260
+ 'workspace_default_low_battery_alert_threshold',
65261
+ ],
65262
+ type: 'object',
65263
+ },
65264
+ ok: { type: 'boolean' },
65265
+ },
65266
+ required: ['notification_settings', 'ok'],
65267
+ type: 'object',
65268
+ },
65269
+ },
65270
+ },
65271
+ description: 'OK',
65272
+ },
65273
+ '400': { description: 'Bad Request' },
65274
+ '401': { description: 'Unauthorized' },
65275
+ },
65276
+ security: [
65277
+ { client_session_with_customer: [] },
65278
+ { client_session_with_customer_ro: [] },
65279
+ ],
65280
+ summary: '/seam/customer/v1/customers/notifications/get',
65281
+ tags: [],
65282
+ 'x-fern-sdk-group-name': [
65283
+ 'seam',
65284
+ 'customer',
65285
+ 'v1',
65286
+ 'customers',
65287
+ 'notifications',
65288
+ ],
65289
+ 'x-fern-sdk-method-name': 'get',
65290
+ 'x-fern-sdk-return-value': 'notification_settings',
65291
+ 'x-response-key': 'notification_settings',
65292
+ 'x-title': 'Get Customer Notification Settings',
65293
+ 'x-undocumented': 'Internal endpoint for customer portals.',
65294
+ },
65295
+ },
65296
+ '/seam/customer/v1/customers/notifications/update': {
65297
+ patch: {
65298
+ description:
65299
+ 'Updates the notification settings for the authenticated customer. Requires a customer portal with `features.configure.allow_notification_customization` enabled.',
65300
+ operationId: 'seamCustomerV1CustomersNotificationsUpdatePatch',
65301
+ requestBody: {
65302
+ content: {
65303
+ 'application/json': {
65304
+ schema: {
65305
+ properties: {
65306
+ low_battery_alert_threshold: {
65307
+ description:
65308
+ "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.",
65309
+ format: 'float',
65310
+ maximum: 1,
65311
+ minimum: 0,
65312
+ nullable: true,
65313
+ type: 'number',
65314
+ },
65315
+ },
65316
+ type: 'object',
65317
+ },
65318
+ },
65319
+ },
65320
+ },
65321
+ responses: {
65322
+ '200': {
65323
+ content: {
65324
+ 'application/json': {
65325
+ schema: {
65326
+ properties: { ok: { type: 'boolean' } },
65327
+ required: ['ok'],
65328
+ type: 'object',
65329
+ },
65330
+ },
65331
+ },
65332
+ description: 'OK',
65333
+ },
65334
+ '400': { description: 'Bad Request' },
65335
+ '401': { description: 'Unauthorized' },
65336
+ },
65337
+ security: [{ client_session_with_customer: [] }],
65338
+ summary: '/seam/customer/v1/customers/notifications/update',
65339
+ tags: [],
65340
+ 'x-fern-sdk-group-name': [
65341
+ 'seam',
65342
+ 'customer',
65343
+ 'v1',
65344
+ 'customers',
65345
+ 'notifications',
65346
+ ],
65347
+ 'x-fern-sdk-method-name': 'update',
65348
+ 'x-response-key': null,
65349
+ 'x-title': 'Update Customer Notification Settings',
65350
+ 'x-undocumented': 'Internal endpoint for customer portals.',
65351
+ },
65352
+ },
64773
65353
  '/seam/customer/v1/customers/open_portal': {
64774
65354
  post: {
64775
65355
  description:
@@ -65392,6 +65972,12 @@ const openapi: OpenAPISpec = {
65392
65972
  'Indicates whether the customer can customize the Instant Key profile for their properties.',
65393
65973
  type: 'boolean',
65394
65974
  },
65975
+ allow_notification_customization: {
65976
+ default: false,
65977
+ description:
65978
+ 'Indicates whether the customer can customize their notification settings, such as the low-battery alert threshold.',
65979
+ type: 'boolean',
65980
+ },
65395
65981
  exclude: {
65396
65982
  default: false,
65397
65983
  description:
@@ -65856,6 +66442,12 @@ const openapi: OpenAPISpec = {
65856
66442
  'Indicates whether the customer can customize the Instant Key profile for their properties.',
65857
66443
  type: 'boolean',
65858
66444
  },
66445
+ allow_notification_customization: {
66446
+ default: false,
66447
+ description:
66448
+ 'Indicates whether the customer can customize their notification settings, such as the low-battery alert threshold.',
66449
+ type: 'boolean',
66450
+ },
65859
66451
  exclude: {
65860
66452
  default: false,
65861
66453
  description: