@seamapi/types 1.1105.0 → 1.1107.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.1105.0",
3
+ "version": "1.1107.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -114,6 +114,15 @@ export const customer_data = z
114
114
  .describe(
115
115
  "ID of the customization profile to use for this customer. Access grants that automations create for this customer use this profile. Pass `null` to remove the customer's customization profile.",
116
116
  ),
117
+ low_battery_alert_threshold: z
118
+ .number()
119
+ .min(0)
120
+ .max(1)
121
+ .nullable()
122
+ .optional()
123
+ .describe(
124
+ "Battery level, from 0 to 1, at or below which `device.low_battery` events fire for this customer's devices. Overrides the workspace and device defaults. Pass `null` to remove the customer's override.",
125
+ ),
117
126
  })
118
127
  .merge(external_resources)
119
128
 
@@ -20,6 +20,12 @@ export const customer = z.object({
20
20
  .describe(
21
21
  'ID of the customization profile the customer uses. Access grants that automations create for this customer use this profile. This can differ from the profiles the customer owns.',
22
22
  ),
23
+ low_battery_alert_threshold: z
24
+ .number()
25
+ .nullable()
26
+ .describe(
27
+ "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.",
28
+ ),
23
29
  }).describe(`
24
30
  ---
25
31
  route_path: /customers
@@ -14406,6 +14406,13 @@ const openapi: OpenAPISpec = {
14406
14406
  nullable: true,
14407
14407
  type: 'string',
14408
14408
  },
14409
+ low_battery_alert_threshold: {
14410
+ description:
14411
+ "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.",
14412
+ format: 'float',
14413
+ nullable: true,
14414
+ type: 'number',
14415
+ },
14409
14416
  workspace_id: {
14410
14417
  description: 'ID of the workspace associated with the customer.',
14411
14418
  format: 'uuid',
@@ -14417,6 +14424,7 @@ const openapi: OpenAPISpec = {
14417
14424
  'workspace_id',
14418
14425
  'created_at',
14419
14426
  'customization_profile_id',
14427
+ 'low_battery_alert_threshold',
14420
14428
  ],
14421
14429
  type: 'object',
14422
14430
  'x-route-path': '/customers',
@@ -51566,6 +51574,15 @@ const openapi: OpenAPISpec = {
51566
51574
  },
51567
51575
  type: 'array',
51568
51576
  },
51577
+ low_battery_alert_threshold: {
51578
+ description:
51579
+ "Battery level, from 0 to 1, at or below which `device.low_battery` events fire for this customer's devices. Overrides the workspace and device defaults. Pass `null` to remove the customer's override.",
51580
+ format: 'float',
51581
+ maximum: 1,
51582
+ minimum: 0,
51583
+ nullable: true,
51584
+ type: 'number',
51585
+ },
51569
51586
  properties: {
51570
51587
  description:
51571
51588
  'List of short-term rental properties.',
@@ -52750,6 +52767,15 @@ const openapi: OpenAPISpec = {
52750
52767
  },
52751
52768
  type: 'array',
52752
52769
  },
52770
+ low_battery_alert_threshold: {
52771
+ description:
52772
+ "Battery level, from 0 to 1, at or below which `device.low_battery` events fire for this customer's devices. Overrides the workspace and device defaults. Pass `null` to remove the customer's override.",
52773
+ format: 'float',
52774
+ maximum: 1,
52775
+ minimum: 0,
52776
+ nullable: true,
52777
+ type: 'number',
52778
+ },
52753
52779
  properties: {
52754
52780
  description: 'List of short-term rental properties.',
52755
52781
  items: {
@@ -69905,6 +69931,382 @@ const openapi: OpenAPISpec = {
69905
69931
  'x-title': 'Update a Space',
69906
69932
  },
69907
69933
  },
69934
+ '/speakers/mute': {
69935
+ post: {
69936
+ description:
69937
+ 'Mutes a specified speaker. To check whether a speaker supports muting, use `device.can_mute_speaker`.',
69938
+ operationId: 'speakersMutePost',
69939
+ requestBody: {
69940
+ content: {
69941
+ 'application/json': {
69942
+ schema: {
69943
+ properties: {
69944
+ device_id: {
69945
+ description: 'ID of the speaker that you want to mute.',
69946
+ format: 'uuid',
69947
+ type: 'string',
69948
+ },
69949
+ },
69950
+ required: ['device_id'],
69951
+ type: 'object',
69952
+ },
69953
+ },
69954
+ },
69955
+ },
69956
+ responses: {
69957
+ '200': {
69958
+ content: {
69959
+ 'application/json': {
69960
+ schema: {
69961
+ properties: {
69962
+ action_attempt: {
69963
+ $ref: '#/components/schemas/action_attempt',
69964
+ },
69965
+ ok: { type: 'boolean' },
69966
+ },
69967
+ required: ['action_attempt', 'ok'],
69968
+ type: 'object',
69969
+ },
69970
+ },
69971
+ },
69972
+ description: 'OK',
69973
+ },
69974
+ '400': { description: 'Bad Request' },
69975
+ '401': { description: 'Unauthorized' },
69976
+ },
69977
+ security: [
69978
+ { client_session: [] },
69979
+ { pat_with_workspace: [] },
69980
+ { console_session_with_workspace: [] },
69981
+ { api_key: [] },
69982
+ ],
69983
+ summary: '/speakers/mute',
69984
+ tags: [],
69985
+ 'x-action-attempt-type': 'SET_SPEAKER_MUTE',
69986
+ 'x-fern-sdk-group-name': ['speakers'],
69987
+ 'x-fern-sdk-method-name': 'mute',
69988
+ 'x-fern-sdk-return-value': 'action_attempt',
69989
+ 'x-response-key': 'action_attempt',
69990
+ 'x-title': 'Mute a Speaker',
69991
+ 'x-undocumented': 'Unreleased.',
69992
+ },
69993
+ },
69994
+ '/speakers/pause': {
69995
+ post: {
69996
+ description:
69997
+ '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`.',
69998
+ operationId: 'speakersPausePost',
69999
+ requestBody: {
70000
+ content: {
70001
+ 'application/json': {
70002
+ schema: {
70003
+ properties: {
70004
+ device_id: {
70005
+ description:
70006
+ 'ID of the speaker on which you want to pause playback.',
70007
+ format: 'uuid',
70008
+ type: 'string',
70009
+ },
70010
+ },
70011
+ required: ['device_id'],
70012
+ type: 'object',
70013
+ },
70014
+ },
70015
+ },
70016
+ },
70017
+ responses: {
70018
+ '200': {
70019
+ content: {
70020
+ 'application/json': {
70021
+ schema: {
70022
+ properties: {
70023
+ action_attempt: {
70024
+ $ref: '#/components/schemas/action_attempt',
70025
+ },
70026
+ ok: { type: 'boolean' },
70027
+ },
70028
+ required: ['action_attempt', 'ok'],
70029
+ type: 'object',
70030
+ },
70031
+ },
70032
+ },
70033
+ description: 'OK',
70034
+ },
70035
+ '400': { description: 'Bad Request' },
70036
+ '401': { description: 'Unauthorized' },
70037
+ },
70038
+ security: [
70039
+ { client_session: [] },
70040
+ { pat_with_workspace: [] },
70041
+ { console_session_with_workspace: [] },
70042
+ { api_key: [] },
70043
+ ],
70044
+ summary: '/speakers/pause',
70045
+ tags: [],
70046
+ 'x-action-attempt-type': 'PAUSE_SPEAKER_PLAYBACK',
70047
+ 'x-fern-sdk-group-name': ['speakers'],
70048
+ 'x-fern-sdk-method-name': 'pause',
70049
+ 'x-fern-sdk-return-value': 'action_attempt',
70050
+ 'x-response-key': 'action_attempt',
70051
+ 'x-title': 'Pause Playback on a Speaker',
70052
+ 'x-undocumented': 'Unreleased.',
70053
+ },
70054
+ },
70055
+ '/speakers/play_chime': {
70056
+ post: {
70057
+ description:
70058
+ 'Plays a short chime on a specified speaker. To check whether a speaker supports playing a chime, use `device.can_play_speaker_chime`.',
70059
+ operationId: 'speakersPlayChimePost',
70060
+ requestBody: {
70061
+ content: {
70062
+ 'application/json': {
70063
+ schema: {
70064
+ properties: {
70065
+ device_id: {
70066
+ description:
70067
+ 'ID of the speaker on which you want to play a chime.',
70068
+ format: 'uuid',
70069
+ type: 'string',
70070
+ },
70071
+ volume: {
70072
+ description:
70073
+ "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.",
70074
+ format: 'float',
70075
+ type: 'number',
70076
+ },
70077
+ },
70078
+ required: ['device_id'],
70079
+ type: 'object',
70080
+ },
70081
+ },
70082
+ },
70083
+ },
70084
+ responses: {
70085
+ '200': {
70086
+ content: {
70087
+ 'application/json': {
70088
+ schema: {
70089
+ properties: {
70090
+ action_attempt: {
70091
+ $ref: '#/components/schemas/action_attempt',
70092
+ },
70093
+ ok: { type: 'boolean' },
70094
+ },
70095
+ required: ['action_attempt', 'ok'],
70096
+ type: 'object',
70097
+ },
70098
+ },
70099
+ },
70100
+ description: 'OK',
70101
+ },
70102
+ '400': { description: 'Bad Request' },
70103
+ '401': { description: 'Unauthorized' },
70104
+ },
70105
+ security: [
70106
+ { client_session: [] },
70107
+ { pat_with_workspace: [] },
70108
+ { console_session_with_workspace: [] },
70109
+ { api_key: [] },
70110
+ ],
70111
+ summary: '/speakers/play_chime',
70112
+ tags: [],
70113
+ 'x-action-attempt-type': 'PLAY_SPEAKER_CHIME',
70114
+ 'x-fern-sdk-group-name': ['speakers'],
70115
+ 'x-fern-sdk-method-name': 'play_chime',
70116
+ 'x-fern-sdk-return-value': 'action_attempt',
70117
+ 'x-response-key': 'action_attempt',
70118
+ 'x-title': 'Play a Chime on a Speaker',
70119
+ 'x-undocumented': 'Unreleased.',
70120
+ },
70121
+ },
70122
+ '/speakers/resume': {
70123
+ post: {
70124
+ description:
70125
+ '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`.',
70126
+ operationId: 'speakersResumePost',
70127
+ requestBody: {
70128
+ content: {
70129
+ 'application/json': {
70130
+ schema: {
70131
+ properties: {
70132
+ device_id: {
70133
+ description:
70134
+ 'ID of the speaker on which you want to resume playback.',
70135
+ format: 'uuid',
70136
+ type: 'string',
70137
+ },
70138
+ },
70139
+ required: ['device_id'],
70140
+ type: 'object',
70141
+ },
70142
+ },
70143
+ },
70144
+ },
70145
+ responses: {
70146
+ '200': {
70147
+ content: {
70148
+ 'application/json': {
70149
+ schema: {
70150
+ properties: {
70151
+ action_attempt: {
70152
+ $ref: '#/components/schemas/action_attempt',
70153
+ },
70154
+ ok: { type: 'boolean' },
70155
+ },
70156
+ required: ['action_attempt', 'ok'],
70157
+ type: 'object',
70158
+ },
70159
+ },
70160
+ },
70161
+ description: 'OK',
70162
+ },
70163
+ '400': { description: 'Bad Request' },
70164
+ '401': { description: 'Unauthorized' },
70165
+ },
70166
+ security: [
70167
+ { client_session: [] },
70168
+ { pat_with_workspace: [] },
70169
+ { console_session_with_workspace: [] },
70170
+ { api_key: [] },
70171
+ ],
70172
+ summary: '/speakers/resume',
70173
+ tags: [],
70174
+ 'x-action-attempt-type': 'RESUME_SPEAKER_PLAYBACK',
70175
+ 'x-fern-sdk-group-name': ['speakers'],
70176
+ 'x-fern-sdk-method-name': 'resume',
70177
+ 'x-fern-sdk-return-value': 'action_attempt',
70178
+ 'x-response-key': 'action_attempt',
70179
+ 'x-title': 'Resume Playback on a Speaker',
70180
+ 'x-undocumented': 'Unreleased.',
70181
+ },
70182
+ },
70183
+ '/speakers/set_volume': {
70184
+ post: {
70185
+ description:
70186
+ "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`.",
70187
+ operationId: 'speakersSetVolumePost',
70188
+ requestBody: {
70189
+ content: {
70190
+ 'application/json': {
70191
+ schema: {
70192
+ properties: {
70193
+ device_id: {
70194
+ description:
70195
+ 'ID of the speaker for which you want to set the volume.',
70196
+ format: 'uuid',
70197
+ type: 'string',
70198
+ },
70199
+ volume: {
70200
+ description:
70201
+ "Volume that you want to set, on the speaker's native volume scale.",
70202
+ format: 'float',
70203
+ type: 'number',
70204
+ },
70205
+ },
70206
+ required: ['device_id', 'volume'],
70207
+ type: 'object',
70208
+ },
70209
+ },
70210
+ },
70211
+ },
70212
+ responses: {
70213
+ '200': {
70214
+ content: {
70215
+ 'application/json': {
70216
+ schema: {
70217
+ properties: {
70218
+ action_attempt: {
70219
+ $ref: '#/components/schemas/action_attempt',
70220
+ },
70221
+ ok: { type: 'boolean' },
70222
+ },
70223
+ required: ['action_attempt', 'ok'],
70224
+ type: 'object',
70225
+ },
70226
+ },
70227
+ },
70228
+ description: 'OK',
70229
+ },
70230
+ '400': { description: 'Bad Request' },
70231
+ '401': { description: 'Unauthorized' },
70232
+ },
70233
+ security: [
70234
+ { client_session: [] },
70235
+ { pat_with_workspace: [] },
70236
+ { console_session_with_workspace: [] },
70237
+ { api_key: [] },
70238
+ ],
70239
+ summary: '/speakers/set_volume',
70240
+ tags: [],
70241
+ 'x-action-attempt-type': 'SET_SPEAKER_VOLUME',
70242
+ 'x-fern-sdk-group-name': ['speakers'],
70243
+ 'x-fern-sdk-method-name': 'set_volume',
70244
+ 'x-fern-sdk-return-value': 'action_attempt',
70245
+ 'x-response-key': 'action_attempt',
70246
+ 'x-title': 'Set the Volume of a Speaker',
70247
+ 'x-undocumented': 'Unreleased.',
70248
+ },
70249
+ },
70250
+ '/speakers/unmute': {
70251
+ post: {
70252
+ description:
70253
+ 'Unmutes a specified speaker. To check whether a speaker supports unmuting, use `device.can_mute_speaker`.',
70254
+ operationId: 'speakersUnmutePost',
70255
+ requestBody: {
70256
+ content: {
70257
+ 'application/json': {
70258
+ schema: {
70259
+ properties: {
70260
+ device_id: {
70261
+ description: 'ID of the speaker that you want to unmute.',
70262
+ format: 'uuid',
70263
+ type: 'string',
70264
+ },
70265
+ },
70266
+ required: ['device_id'],
70267
+ type: 'object',
70268
+ },
70269
+ },
70270
+ },
70271
+ },
70272
+ responses: {
70273
+ '200': {
70274
+ content: {
70275
+ 'application/json': {
70276
+ schema: {
70277
+ properties: {
70278
+ action_attempt: {
70279
+ $ref: '#/components/schemas/action_attempt',
70280
+ },
70281
+ ok: { type: 'boolean' },
70282
+ },
70283
+ required: ['action_attempt', 'ok'],
70284
+ type: 'object',
70285
+ },
70286
+ },
70287
+ },
70288
+ description: 'OK',
70289
+ },
70290
+ '400': { description: 'Bad Request' },
70291
+ '401': { description: 'Unauthorized' },
70292
+ },
70293
+ security: [
70294
+ { client_session: [] },
70295
+ { pat_with_workspace: [] },
70296
+ { console_session_with_workspace: [] },
70297
+ { api_key: [] },
70298
+ ],
70299
+ summary: '/speakers/unmute',
70300
+ tags: [],
70301
+ 'x-action-attempt-type': 'SET_SPEAKER_MUTE',
70302
+ 'x-fern-sdk-group-name': ['speakers'],
70303
+ 'x-fern-sdk-method-name': 'unmute',
70304
+ 'x-fern-sdk-return-value': 'action_attempt',
70305
+ 'x-response-key': 'action_attempt',
70306
+ 'x-title': 'Unmute a Speaker',
70307
+ 'x-undocumented': 'Unreleased.',
70308
+ },
70309
+ },
69908
70310
  '/thermostats/activate_climate_preset': {
69909
70311
  post: {
69910
70312
  description: