@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.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.1106.0",
3
+ "version": "1.1108.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -109,6 +109,12 @@ const base_configure_feature = base_feature.extend({
109
109
  .describe(
110
110
  'Indicates whether the customer can customize the Instant Key profile for their properties.',
111
111
  ),
112
+ allow_notification_customization: z
113
+ .boolean()
114
+ .default(false)
115
+ .describe(
116
+ 'Indicates whether the customer can customize their notification settings, such as the low-battery alert threshold.',
117
+ ),
112
118
  })
113
119
 
114
120
  const base_features = z.object({
@@ -263,6 +269,7 @@ export const portal_configuration = portal_configuration_base
263
269
  allow_instant_key_customization: false,
264
270
  allow_access_automation_rule_customization: false,
265
271
  allow_climate_automation_rule_customization: false,
272
+ allow_notification_customization: false,
266
273
  },
267
274
  },
268
275
  is_embedded: false,
@@ -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:
@@ -64770,6 +64777,129 @@ const openapi: OpenAPISpec = {
64770
64777
  'x-undocumented': 'Internal endpoint for customer portals.',
64771
64778
  },
64772
64779
  },
64780
+ '/seam/customer/v1/customers/notifications/get': {
64781
+ get: {
64782
+ description:
64783
+ 'Gets the notification settings for the authenticated customer, along with the workspace defaults they inherit when unset.',
64784
+ operationId: 'seamCustomerV1CustomersNotificationsGetGet',
64785
+ responses: {
64786
+ '200': {
64787
+ content: {
64788
+ 'application/json': {
64789
+ schema: {
64790
+ properties: {
64791
+ notification_settings: {
64792
+ properties: {
64793
+ low_battery_alert_threshold: {
64794
+ description:
64795
+ "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.",
64796
+ format: 'float',
64797
+ nullable: true,
64798
+ type: 'number',
64799
+ },
64800
+ workspace_default_low_battery_alert_threshold: {
64801
+ description:
64802
+ 'Workspace-level low-battery alert threshold that applies when the customer has not set one. `null` means the device default applies.',
64803
+ format: 'float',
64804
+ nullable: true,
64805
+ type: 'number',
64806
+ },
64807
+ },
64808
+ required: [
64809
+ 'low_battery_alert_threshold',
64810
+ 'workspace_default_low_battery_alert_threshold',
64811
+ ],
64812
+ type: 'object',
64813
+ },
64814
+ ok: { type: 'boolean' },
64815
+ },
64816
+ required: ['notification_settings', 'ok'],
64817
+ type: 'object',
64818
+ },
64819
+ },
64820
+ },
64821
+ description: 'OK',
64822
+ },
64823
+ '400': { description: 'Bad Request' },
64824
+ '401': { description: 'Unauthorized' },
64825
+ },
64826
+ security: [
64827
+ { client_session_with_customer: [] },
64828
+ { client_session_with_customer_ro: [] },
64829
+ ],
64830
+ summary: '/seam/customer/v1/customers/notifications/get',
64831
+ tags: [],
64832
+ 'x-fern-sdk-group-name': [
64833
+ 'seam',
64834
+ 'customer',
64835
+ 'v1',
64836
+ 'customers',
64837
+ 'notifications',
64838
+ ],
64839
+ 'x-fern-sdk-method-name': 'get',
64840
+ 'x-fern-sdk-return-value': 'notification_settings',
64841
+ 'x-response-key': 'notification_settings',
64842
+ 'x-title': 'Get Customer Notification Settings',
64843
+ 'x-undocumented': 'Internal endpoint for customer portals.',
64844
+ },
64845
+ },
64846
+ '/seam/customer/v1/customers/notifications/update': {
64847
+ patch: {
64848
+ description:
64849
+ 'Updates the notification settings for the authenticated customer. Requires a customer portal with `features.configure.allow_notification_customization` enabled.',
64850
+ operationId: 'seamCustomerV1CustomersNotificationsUpdatePatch',
64851
+ requestBody: {
64852
+ content: {
64853
+ 'application/json': {
64854
+ schema: {
64855
+ properties: {
64856
+ low_battery_alert_threshold: {
64857
+ description:
64858
+ "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.",
64859
+ format: 'float',
64860
+ maximum: 1,
64861
+ minimum: 0,
64862
+ nullable: true,
64863
+ type: 'number',
64864
+ },
64865
+ },
64866
+ type: 'object',
64867
+ },
64868
+ },
64869
+ },
64870
+ },
64871
+ responses: {
64872
+ '200': {
64873
+ content: {
64874
+ 'application/json': {
64875
+ schema: {
64876
+ properties: { ok: { type: 'boolean' } },
64877
+ required: ['ok'],
64878
+ type: 'object',
64879
+ },
64880
+ },
64881
+ },
64882
+ description: 'OK',
64883
+ },
64884
+ '400': { description: 'Bad Request' },
64885
+ '401': { description: 'Unauthorized' },
64886
+ },
64887
+ security: [{ client_session_with_customer: [] }],
64888
+ summary: '/seam/customer/v1/customers/notifications/update',
64889
+ tags: [],
64890
+ 'x-fern-sdk-group-name': [
64891
+ 'seam',
64892
+ 'customer',
64893
+ 'v1',
64894
+ 'customers',
64895
+ 'notifications',
64896
+ ],
64897
+ 'x-fern-sdk-method-name': 'update',
64898
+ 'x-response-key': null,
64899
+ 'x-title': 'Update Customer Notification Settings',
64900
+ 'x-undocumented': 'Internal endpoint for customer portals.',
64901
+ },
64902
+ },
64773
64903
  '/seam/customer/v1/customers/open_portal': {
64774
64904
  post: {
64775
64905
  description:
@@ -65392,6 +65522,12 @@ const openapi: OpenAPISpec = {
65392
65522
  'Indicates whether the customer can customize the Instant Key profile for their properties.',
65393
65523
  type: 'boolean',
65394
65524
  },
65525
+ allow_notification_customization: {
65526
+ default: false,
65527
+ description:
65528
+ 'Indicates whether the customer can customize their notification settings, such as the low-battery alert threshold.',
65529
+ type: 'boolean',
65530
+ },
65395
65531
  exclude: {
65396
65532
  default: false,
65397
65533
  description:
@@ -65856,6 +65992,12 @@ const openapi: OpenAPISpec = {
65856
65992
  'Indicates whether the customer can customize the Instant Key profile for their properties.',
65857
65993
  type: 'boolean',
65858
65994
  },
65995
+ allow_notification_customization: {
65996
+ default: false,
65997
+ description:
65998
+ 'Indicates whether the customer can customize their notification settings, such as the low-battery alert threshold.',
65999
+ type: 'boolean',
66000
+ },
65859
66001
  exclude: {
65860
66002
  default: false,
65861
66003
  description:
@@ -69931,6 +70073,382 @@ const openapi: OpenAPISpec = {
69931
70073
  'x-title': 'Update a Space',
69932
70074
  },
69933
70075
  },
70076
+ '/speakers/mute': {
70077
+ post: {
70078
+ description:
70079
+ 'Mutes a specified speaker. To check whether a speaker supports muting, use `device.can_mute_speaker`.',
70080
+ operationId: 'speakersMutePost',
70081
+ requestBody: {
70082
+ content: {
70083
+ 'application/json': {
70084
+ schema: {
70085
+ properties: {
70086
+ device_id: {
70087
+ description: 'ID of the speaker that you want to mute.',
70088
+ format: 'uuid',
70089
+ type: 'string',
70090
+ },
70091
+ },
70092
+ required: ['device_id'],
70093
+ type: 'object',
70094
+ },
70095
+ },
70096
+ },
70097
+ },
70098
+ responses: {
70099
+ '200': {
70100
+ content: {
70101
+ 'application/json': {
70102
+ schema: {
70103
+ properties: {
70104
+ action_attempt: {
70105
+ $ref: '#/components/schemas/action_attempt',
70106
+ },
70107
+ ok: { type: 'boolean' },
70108
+ },
70109
+ required: ['action_attempt', 'ok'],
70110
+ type: 'object',
70111
+ },
70112
+ },
70113
+ },
70114
+ description: 'OK',
70115
+ },
70116
+ '400': { description: 'Bad Request' },
70117
+ '401': { description: 'Unauthorized' },
70118
+ },
70119
+ security: [
70120
+ { client_session: [] },
70121
+ { pat_with_workspace: [] },
70122
+ { console_session_with_workspace: [] },
70123
+ { api_key: [] },
70124
+ ],
70125
+ summary: '/speakers/mute',
70126
+ tags: [],
70127
+ 'x-action-attempt-type': 'SET_SPEAKER_MUTE',
70128
+ 'x-fern-sdk-group-name': ['speakers'],
70129
+ 'x-fern-sdk-method-name': 'mute',
70130
+ 'x-fern-sdk-return-value': 'action_attempt',
70131
+ 'x-response-key': 'action_attempt',
70132
+ 'x-title': 'Mute a Speaker',
70133
+ 'x-undocumented': 'Unreleased.',
70134
+ },
70135
+ },
70136
+ '/speakers/pause': {
70137
+ post: {
70138
+ description:
70139
+ '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`.',
70140
+ operationId: 'speakersPausePost',
70141
+ requestBody: {
70142
+ content: {
70143
+ 'application/json': {
70144
+ schema: {
70145
+ properties: {
70146
+ device_id: {
70147
+ description:
70148
+ 'ID of the speaker on which you want to pause playback.',
70149
+ format: 'uuid',
70150
+ type: 'string',
70151
+ },
70152
+ },
70153
+ required: ['device_id'],
70154
+ type: 'object',
70155
+ },
70156
+ },
70157
+ },
70158
+ },
70159
+ responses: {
70160
+ '200': {
70161
+ content: {
70162
+ 'application/json': {
70163
+ schema: {
70164
+ properties: {
70165
+ action_attempt: {
70166
+ $ref: '#/components/schemas/action_attempt',
70167
+ },
70168
+ ok: { type: 'boolean' },
70169
+ },
70170
+ required: ['action_attempt', 'ok'],
70171
+ type: 'object',
70172
+ },
70173
+ },
70174
+ },
70175
+ description: 'OK',
70176
+ },
70177
+ '400': { description: 'Bad Request' },
70178
+ '401': { description: 'Unauthorized' },
70179
+ },
70180
+ security: [
70181
+ { client_session: [] },
70182
+ { pat_with_workspace: [] },
70183
+ { console_session_with_workspace: [] },
70184
+ { api_key: [] },
70185
+ ],
70186
+ summary: '/speakers/pause',
70187
+ tags: [],
70188
+ 'x-action-attempt-type': 'PAUSE_SPEAKER_PLAYBACK',
70189
+ 'x-fern-sdk-group-name': ['speakers'],
70190
+ 'x-fern-sdk-method-name': 'pause',
70191
+ 'x-fern-sdk-return-value': 'action_attempt',
70192
+ 'x-response-key': 'action_attempt',
70193
+ 'x-title': 'Pause Playback on a Speaker',
70194
+ 'x-undocumented': 'Unreleased.',
70195
+ },
70196
+ },
70197
+ '/speakers/play_chime': {
70198
+ post: {
70199
+ description:
70200
+ 'Plays a short chime on a specified speaker. To check whether a speaker supports playing a chime, use `device.can_play_speaker_chime`.',
70201
+ operationId: 'speakersPlayChimePost',
70202
+ requestBody: {
70203
+ content: {
70204
+ 'application/json': {
70205
+ schema: {
70206
+ properties: {
70207
+ device_id: {
70208
+ description:
70209
+ 'ID of the speaker on which you want to play a chime.',
70210
+ format: 'uuid',
70211
+ type: 'string',
70212
+ },
70213
+ volume: {
70214
+ description:
70215
+ "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.",
70216
+ format: 'float',
70217
+ type: 'number',
70218
+ },
70219
+ },
70220
+ required: ['device_id'],
70221
+ type: 'object',
70222
+ },
70223
+ },
70224
+ },
70225
+ },
70226
+ responses: {
70227
+ '200': {
70228
+ content: {
70229
+ 'application/json': {
70230
+ schema: {
70231
+ properties: {
70232
+ action_attempt: {
70233
+ $ref: '#/components/schemas/action_attempt',
70234
+ },
70235
+ ok: { type: 'boolean' },
70236
+ },
70237
+ required: ['action_attempt', 'ok'],
70238
+ type: 'object',
70239
+ },
70240
+ },
70241
+ },
70242
+ description: 'OK',
70243
+ },
70244
+ '400': { description: 'Bad Request' },
70245
+ '401': { description: 'Unauthorized' },
70246
+ },
70247
+ security: [
70248
+ { client_session: [] },
70249
+ { pat_with_workspace: [] },
70250
+ { console_session_with_workspace: [] },
70251
+ { api_key: [] },
70252
+ ],
70253
+ summary: '/speakers/play_chime',
70254
+ tags: [],
70255
+ 'x-action-attempt-type': 'PLAY_SPEAKER_CHIME',
70256
+ 'x-fern-sdk-group-name': ['speakers'],
70257
+ 'x-fern-sdk-method-name': 'play_chime',
70258
+ 'x-fern-sdk-return-value': 'action_attempt',
70259
+ 'x-response-key': 'action_attempt',
70260
+ 'x-title': 'Play a Chime on a Speaker',
70261
+ 'x-undocumented': 'Unreleased.',
70262
+ },
70263
+ },
70264
+ '/speakers/resume': {
70265
+ post: {
70266
+ description:
70267
+ '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`.',
70268
+ operationId: 'speakersResumePost',
70269
+ requestBody: {
70270
+ content: {
70271
+ 'application/json': {
70272
+ schema: {
70273
+ properties: {
70274
+ device_id: {
70275
+ description:
70276
+ 'ID of the speaker on which you want to resume playback.',
70277
+ format: 'uuid',
70278
+ type: 'string',
70279
+ },
70280
+ },
70281
+ required: ['device_id'],
70282
+ type: 'object',
70283
+ },
70284
+ },
70285
+ },
70286
+ },
70287
+ responses: {
70288
+ '200': {
70289
+ content: {
70290
+ 'application/json': {
70291
+ schema: {
70292
+ properties: {
70293
+ action_attempt: {
70294
+ $ref: '#/components/schemas/action_attempt',
70295
+ },
70296
+ ok: { type: 'boolean' },
70297
+ },
70298
+ required: ['action_attempt', 'ok'],
70299
+ type: 'object',
70300
+ },
70301
+ },
70302
+ },
70303
+ description: 'OK',
70304
+ },
70305
+ '400': { description: 'Bad Request' },
70306
+ '401': { description: 'Unauthorized' },
70307
+ },
70308
+ security: [
70309
+ { client_session: [] },
70310
+ { pat_with_workspace: [] },
70311
+ { console_session_with_workspace: [] },
70312
+ { api_key: [] },
70313
+ ],
70314
+ summary: '/speakers/resume',
70315
+ tags: [],
70316
+ 'x-action-attempt-type': 'RESUME_SPEAKER_PLAYBACK',
70317
+ 'x-fern-sdk-group-name': ['speakers'],
70318
+ 'x-fern-sdk-method-name': 'resume',
70319
+ 'x-fern-sdk-return-value': 'action_attempt',
70320
+ 'x-response-key': 'action_attempt',
70321
+ 'x-title': 'Resume Playback on a Speaker',
70322
+ 'x-undocumented': 'Unreleased.',
70323
+ },
70324
+ },
70325
+ '/speakers/set_volume': {
70326
+ post: {
70327
+ description:
70328
+ "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`.",
70329
+ operationId: 'speakersSetVolumePost',
70330
+ requestBody: {
70331
+ content: {
70332
+ 'application/json': {
70333
+ schema: {
70334
+ properties: {
70335
+ device_id: {
70336
+ description:
70337
+ 'ID of the speaker for which you want to set the volume.',
70338
+ format: 'uuid',
70339
+ type: 'string',
70340
+ },
70341
+ volume: {
70342
+ description:
70343
+ "Volume that you want to set, on the speaker's native volume scale.",
70344
+ format: 'float',
70345
+ type: 'number',
70346
+ },
70347
+ },
70348
+ required: ['device_id', 'volume'],
70349
+ type: 'object',
70350
+ },
70351
+ },
70352
+ },
70353
+ },
70354
+ responses: {
70355
+ '200': {
70356
+ content: {
70357
+ 'application/json': {
70358
+ schema: {
70359
+ properties: {
70360
+ action_attempt: {
70361
+ $ref: '#/components/schemas/action_attempt',
70362
+ },
70363
+ ok: { type: 'boolean' },
70364
+ },
70365
+ required: ['action_attempt', 'ok'],
70366
+ type: 'object',
70367
+ },
70368
+ },
70369
+ },
70370
+ description: 'OK',
70371
+ },
70372
+ '400': { description: 'Bad Request' },
70373
+ '401': { description: 'Unauthorized' },
70374
+ },
70375
+ security: [
70376
+ { client_session: [] },
70377
+ { pat_with_workspace: [] },
70378
+ { console_session_with_workspace: [] },
70379
+ { api_key: [] },
70380
+ ],
70381
+ summary: '/speakers/set_volume',
70382
+ tags: [],
70383
+ 'x-action-attempt-type': 'SET_SPEAKER_VOLUME',
70384
+ 'x-fern-sdk-group-name': ['speakers'],
70385
+ 'x-fern-sdk-method-name': 'set_volume',
70386
+ 'x-fern-sdk-return-value': 'action_attempt',
70387
+ 'x-response-key': 'action_attempt',
70388
+ 'x-title': 'Set the Volume of a Speaker',
70389
+ 'x-undocumented': 'Unreleased.',
70390
+ },
70391
+ },
70392
+ '/speakers/unmute': {
70393
+ post: {
70394
+ description:
70395
+ 'Unmutes a specified speaker. To check whether a speaker supports unmuting, use `device.can_mute_speaker`.',
70396
+ operationId: 'speakersUnmutePost',
70397
+ requestBody: {
70398
+ content: {
70399
+ 'application/json': {
70400
+ schema: {
70401
+ properties: {
70402
+ device_id: {
70403
+ description: 'ID of the speaker that you want to unmute.',
70404
+ format: 'uuid',
70405
+ type: 'string',
70406
+ },
70407
+ },
70408
+ required: ['device_id'],
70409
+ type: 'object',
70410
+ },
70411
+ },
70412
+ },
70413
+ },
70414
+ responses: {
70415
+ '200': {
70416
+ content: {
70417
+ 'application/json': {
70418
+ schema: {
70419
+ properties: {
70420
+ action_attempt: {
70421
+ $ref: '#/components/schemas/action_attempt',
70422
+ },
70423
+ ok: { type: 'boolean' },
70424
+ },
70425
+ required: ['action_attempt', 'ok'],
70426
+ type: 'object',
70427
+ },
70428
+ },
70429
+ },
70430
+ description: 'OK',
70431
+ },
70432
+ '400': { description: 'Bad Request' },
70433
+ '401': { description: 'Unauthorized' },
70434
+ },
70435
+ security: [
70436
+ { client_session: [] },
70437
+ { pat_with_workspace: [] },
70438
+ { console_session_with_workspace: [] },
70439
+ { api_key: [] },
70440
+ ],
70441
+ summary: '/speakers/unmute',
70442
+ tags: [],
70443
+ 'x-action-attempt-type': 'SET_SPEAKER_MUTE',
70444
+ 'x-fern-sdk-group-name': ['speakers'],
70445
+ 'x-fern-sdk-method-name': 'unmute',
70446
+ 'x-fern-sdk-return-value': 'action_attempt',
70447
+ 'x-response-key': 'action_attempt',
70448
+ 'x-title': 'Unmute a Speaker',
70449
+ 'x-undocumented': 'Unreleased.',
70450
+ },
70451
+ },
69934
70452
  '/thermostats/activate_climate_preset': {
69935
70453
  post: {
69936
70454
  description: