@seamapi/types 1.1210.0 → 1.1211.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.
@@ -29045,6 +29045,279 @@ const openapi = {
29045
29045
  type: 'object',
29046
29046
  'x-route-path': '/thermostats',
29047
29047
  },
29048
+ {
29049
+ description: 'The water temperature of a pool or spa changed by at least 1 °C. Seam reports water temperature only while the water is circulating.',
29050
+ properties: {
29051
+ connected_account_custom_metadata: {
29052
+ additionalProperties: {
29053
+ oneOf: [{ type: 'string' }, { type: 'boolean' }],
29054
+ },
29055
+ description: 'Custom metadata of the connected account, present when connected_account_id is provided.',
29056
+ type: 'object',
29057
+ },
29058
+ connected_account_id: {
29059
+ description: 'ID of the connected account associated with the event.',
29060
+ format: 'uuid',
29061
+ type: 'string',
29062
+ },
29063
+ created_at: {
29064
+ description: 'Date and time at which the event was created.',
29065
+ format: 'date-time',
29066
+ type: 'string',
29067
+ },
29068
+ customer_key: {
29069
+ description: 'The customer key associated with the device, if any.',
29070
+ type: 'string',
29071
+ },
29072
+ device_custom_metadata: {
29073
+ additionalProperties: {
29074
+ oneOf: [{ type: 'string' }, { type: 'boolean' }],
29075
+ },
29076
+ description: 'Custom metadata of the device, present when device_id is provided.',
29077
+ type: 'object',
29078
+ },
29079
+ device_id: {
29080
+ description: 'ID of the affected device.',
29081
+ format: 'uuid',
29082
+ type: 'string',
29083
+ },
29084
+ event_description: {
29085
+ description: 'Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.',
29086
+ type: 'string',
29087
+ },
29088
+ event_id: {
29089
+ description: 'ID of the event.',
29090
+ format: 'uuid',
29091
+ type: 'string',
29092
+ },
29093
+ event_type: {
29094
+ enum: ['pool.temperature_changed'],
29095
+ type: 'string',
29096
+ },
29097
+ occurred_at: {
29098
+ description: 'Date and time at which the event occurred.',
29099
+ format: 'date-time',
29100
+ type: 'string',
29101
+ },
29102
+ temperature_celsius: {
29103
+ description: 'Water temperature, in °C, reported by the affected pool or spa.',
29104
+ format: 'float',
29105
+ type: 'number',
29106
+ },
29107
+ temperature_fahrenheit: {
29108
+ description: 'Water temperature, in °F, reported by the affected pool or spa.',
29109
+ format: 'float',
29110
+ type: 'number',
29111
+ },
29112
+ workspace_id: {
29113
+ description: 'ID of the workspace associated with the event.',
29114
+ format: 'uuid',
29115
+ type: 'string',
29116
+ },
29117
+ },
29118
+ required: [
29119
+ 'event_id',
29120
+ 'workspace_id',
29121
+ 'created_at',
29122
+ 'occurred_at',
29123
+ 'device_id',
29124
+ 'connected_account_id',
29125
+ 'event_type',
29126
+ 'temperature_celsius',
29127
+ 'temperature_fahrenheit',
29128
+ ],
29129
+ type: 'object',
29130
+ 'x-route-path': '/pools',
29131
+ 'x-undocumented': 'Unreleased.',
29132
+ },
29133
+ {
29134
+ description: 'A heated pool or spa reached its heating set point: heating is on and the water temperature is within 1 °C of the set point or above it. Fires again only after the water falls more than 1 °C below the set point or heating is turned off.',
29135
+ properties: {
29136
+ connected_account_custom_metadata: {
29137
+ additionalProperties: {
29138
+ oneOf: [{ type: 'string' }, { type: 'boolean' }],
29139
+ },
29140
+ description: 'Custom metadata of the connected account, present when connected_account_id is provided.',
29141
+ type: 'object',
29142
+ },
29143
+ connected_account_id: {
29144
+ description: 'ID of the connected account associated with the event.',
29145
+ format: 'uuid',
29146
+ type: 'string',
29147
+ },
29148
+ created_at: {
29149
+ description: 'Date and time at which the event was created.',
29150
+ format: 'date-time',
29151
+ type: 'string',
29152
+ },
29153
+ customer_key: {
29154
+ description: 'The customer key associated with the device, if any.',
29155
+ type: 'string',
29156
+ },
29157
+ desired_temperature_celsius: {
29158
+ description: 'Desired water temperature, in °C, defined by the heating set point of the affected pool or spa.',
29159
+ format: 'float',
29160
+ type: 'number',
29161
+ },
29162
+ desired_temperature_fahrenheit: {
29163
+ description: 'Desired water temperature, in °F, defined by the heating set point of the affected pool or spa.',
29164
+ format: 'float',
29165
+ type: 'number',
29166
+ },
29167
+ device_custom_metadata: {
29168
+ additionalProperties: {
29169
+ oneOf: [{ type: 'string' }, { type: 'boolean' }],
29170
+ },
29171
+ description: 'Custom metadata of the device, present when device_id is provided.',
29172
+ type: 'object',
29173
+ },
29174
+ device_id: {
29175
+ description: 'ID of the affected device.',
29176
+ format: 'uuid',
29177
+ type: 'string',
29178
+ },
29179
+ event_description: {
29180
+ description: 'Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.',
29181
+ type: 'string',
29182
+ },
29183
+ event_id: {
29184
+ description: 'ID of the event.',
29185
+ format: 'uuid',
29186
+ type: 'string',
29187
+ },
29188
+ event_type: {
29189
+ enum: ['pool.temperature_reached_set_point'],
29190
+ type: 'string',
29191
+ },
29192
+ occurred_at: {
29193
+ description: 'Date and time at which the event occurred.',
29194
+ format: 'date-time',
29195
+ type: 'string',
29196
+ },
29197
+ temperature_celsius: {
29198
+ description: 'Water temperature, in °C, reported by the affected pool or spa.',
29199
+ format: 'float',
29200
+ type: 'number',
29201
+ },
29202
+ temperature_fahrenheit: {
29203
+ description: 'Water temperature, in °F, reported by the affected pool or spa.',
29204
+ format: 'float',
29205
+ type: 'number',
29206
+ },
29207
+ workspace_id: {
29208
+ description: 'ID of the workspace associated with the event.',
29209
+ format: 'uuid',
29210
+ type: 'string',
29211
+ },
29212
+ },
29213
+ required: [
29214
+ 'event_id',
29215
+ 'workspace_id',
29216
+ 'created_at',
29217
+ 'occurred_at',
29218
+ 'device_id',
29219
+ 'connected_account_id',
29220
+ 'event_type',
29221
+ 'temperature_celsius',
29222
+ 'temperature_fahrenheit',
29223
+ 'desired_temperature_celsius',
29224
+ 'desired_temperature_fahrenheit',
29225
+ ],
29226
+ type: 'object',
29227
+ 'x-route-path': '/pools',
29228
+ 'x-undocumented': 'Unreleased.',
29229
+ },
29230
+ {
29231
+ description: 'The heating mode or heating set point of a pool or spa changed.',
29232
+ properties: {
29233
+ connected_account_custom_metadata: {
29234
+ additionalProperties: {
29235
+ oneOf: [{ type: 'string' }, { type: 'boolean' }],
29236
+ },
29237
+ description: 'Custom metadata of the connected account, present when connected_account_id is provided.',
29238
+ type: 'object',
29239
+ },
29240
+ connected_account_id: {
29241
+ description: 'ID of the connected account associated with the event.',
29242
+ format: 'uuid',
29243
+ type: 'string',
29244
+ },
29245
+ controller_mode: {
29246
+ description: 'New heating mode of the affected pool or spa. Present only if the mode changed.',
29247
+ enum: ['heat', 'off'],
29248
+ type: 'string',
29249
+ },
29250
+ created_at: {
29251
+ description: 'Date and time at which the event was created.',
29252
+ format: 'date-time',
29253
+ type: 'string',
29254
+ },
29255
+ customer_key: {
29256
+ description: 'The customer key associated with the device, if any.',
29257
+ type: 'string',
29258
+ },
29259
+ device_custom_metadata: {
29260
+ additionalProperties: {
29261
+ oneOf: [{ type: 'string' }, { type: 'boolean' }],
29262
+ },
29263
+ description: 'Custom metadata of the device, present when device_id is provided.',
29264
+ type: 'object',
29265
+ },
29266
+ device_id: {
29267
+ description: 'ID of the affected device.',
29268
+ format: 'uuid',
29269
+ type: 'string',
29270
+ },
29271
+ event_description: {
29272
+ description: 'Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.',
29273
+ type: 'string',
29274
+ },
29275
+ event_id: {
29276
+ description: 'ID of the event.',
29277
+ format: 'uuid',
29278
+ type: 'string',
29279
+ },
29280
+ event_type: { enum: ['pool.manually_adjusted'], type: 'string' },
29281
+ heating_set_point_celsius: {
29282
+ description: 'New heating set point, in °C, of the affected pool or spa. Present only if the set point changed.',
29283
+ format: 'float',
29284
+ type: 'number',
29285
+ },
29286
+ heating_set_point_fahrenheit: {
29287
+ description: 'New heating set point, in °F, of the affected pool or spa. Present only if the set point changed.',
29288
+ format: 'float',
29289
+ type: 'number',
29290
+ },
29291
+ method: {
29292
+ description: "Method used to adjust the affected pool or spa. `seam` indicates that the Seam API, Seam CLI, or Seam Console was used. `external` indicates a change made outside Seam, such as in the manufacturer's app or on the controller panel.",
29293
+ enum: ['seam', 'external'],
29294
+ type: 'string',
29295
+ },
29296
+ occurred_at: {
29297
+ description: 'Date and time at which the event occurred.',
29298
+ format: 'date-time',
29299
+ type: 'string',
29300
+ },
29301
+ workspace_id: {
29302
+ description: 'ID of the workspace associated with the event.',
29303
+ format: 'uuid',
29304
+ type: 'string',
29305
+ },
29306
+ },
29307
+ required: [
29308
+ 'event_id',
29309
+ 'workspace_id',
29310
+ 'created_at',
29311
+ 'occurred_at',
29312
+ 'device_id',
29313
+ 'connected_account_id',
29314
+ 'event_type',
29315
+ 'method',
29316
+ ],
29317
+ type: 'object',
29318
+ 'x-route-path': '/pools',
29319
+ 'x-undocumented': 'Unreleased.',
29320
+ },
29048
29321
  {
29049
29322
  description: 'The name of a device was changed.',
29050
29323
  properties: {
@@ -54665,6 +54938,9 @@ const openapi = {
54665
54938
  'thermostat.temperature_threshold_no_longer_exceeded',
54666
54939
  'thermostat.temperature_reached_set_point',
54667
54940
  'thermostat.temperature_changed',
54941
+ 'pool.temperature_changed',
54942
+ 'pool.temperature_reached_set_point',
54943
+ 'pool.manually_adjusted',
54668
54944
  'device.name_changed',
54669
54945
  'camera.activated',
54670
54946
  'device.doorbell_rang',
@@ -54793,6 +55069,9 @@ const openapi = {
54793
55069
  'thermostat.temperature_threshold_no_longer_exceeded',
54794
55070
  'thermostat.temperature_reached_set_point',
54795
55071
  'thermostat.temperature_changed',
55072
+ 'pool.temperature_changed',
55073
+ 'pool.temperature_reached_set_point',
55074
+ 'pool.manually_adjusted',
54796
55075
  'device.name_changed',
54797
55076
  'camera.activated',
54798
55077
  'device.doorbell_rang',
@@ -66663,6 +66942,9 @@ const openapi = {
66663
66942
  'thermostat.temperature_threshold_no_longer_exceeded',
66664
66943
  'thermostat.temperature_reached_set_point',
66665
66944
  'thermostat.temperature_changed',
66945
+ 'pool.temperature_changed',
66946
+ 'pool.temperature_reached_set_point',
66947
+ 'pool.manually_adjusted',
66666
66948
  'device.name_changed',
66667
66949
  'camera.activated',
66668
66950
  'device.doorbell_rang',
@@ -66792,6 +67074,9 @@ const openapi = {
66792
67074
  'thermostat.temperature_threshold_no_longer_exceeded',
66793
67075
  'thermostat.temperature_reached_set_point',
66794
67076
  'thermostat.temperature_changed',
67077
+ 'pool.temperature_changed',
67078
+ 'pool.temperature_reached_set_point',
67079
+ 'pool.manually_adjusted',
66795
67080
  'device.name_changed',
66796
67081
  'camera.activated',
66797
67082
  'device.doorbell_rang',
@@ -70316,6 +70601,9 @@ const openapi = {
70316
70601
  'thermostat.temperature_threshold_no_longer_exceeded',
70317
70602
  'thermostat.temperature_reached_set_point',
70318
70603
  'thermostat.temperature_changed',
70604
+ 'pool.temperature_changed',
70605
+ 'pool.temperature_reached_set_point',
70606
+ 'pool.manually_adjusted',
70319
70607
  'device.name_changed',
70320
70608
  'camera.activated',
70321
70609
  'device.doorbell_rang',
@@ -70522,6 +70810,9 @@ const openapi = {
70522
70810
  'thermostat.temperature_threshold_no_longer_exceeded',
70523
70811
  'thermostat.temperature_reached_set_point',
70524
70812
  'thermostat.temperature_changed',
70813
+ 'pool.temperature_changed',
70814
+ 'pool.temperature_reached_set_point',
70815
+ 'pool.manually_adjusted',
70525
70816
  'device.name_changed',
70526
70817
  'camera.activated',
70527
70818
  'device.doorbell_rang',