@seamapi/types 1.297.1 → 1.299.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.297.1",
3
+ "version": "1.299.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -115,6 +115,13 @@ const account_disconnected = common_acs_system_error
115
115
  'Indicates that the login credentials are invalid. Reconnect the account using the Connect Webview to restore access.',
116
116
  )
117
117
 
118
+ const salto_ks_certification_expired = common_acs_system_error.extend({
119
+ error_code: z
120
+ .literal('salto_ks_certification_expired')
121
+ .describe(
122
+ 'Indicates that the access system has lost its Salto KS certification. Please contact support to regain access.',
123
+ ),
124
+ })
118
125
  const acs_system_error = z
119
126
  .union([
120
127
  seam_bridge_disconnected,
@@ -122,6 +129,7 @@ const acs_system_error = z
122
129
  salto_ks_subscription_limit_exceeded,
123
130
  acs_system_disconnected,
124
131
  account_disconnected,
132
+ salto_ks_certification_expired,
125
133
  ])
126
134
  .describe('Error associated with the `acs_system`.')
127
135
 
@@ -135,6 +143,9 @@ export const acs_system_error_map = z.object({
135
143
  .nullable(),
136
144
  acs_system_disconnected: acs_system_disconnected.optional().nullable(),
137
145
  account_disconnected: account_disconnected.optional().nullable(),
146
+ salto_ks_certification_expired: salto_ks_certification_expired
147
+ .optional()
148
+ .nullable(),
138
149
  })
139
150
 
140
151
  export type AcsSystemErrorMap = z.infer<typeof acs_system_error_map>
@@ -873,6 +873,29 @@ export default {
873
873
  required: ['created_at', 'message', 'error_code'],
874
874
  type: 'object',
875
875
  },
876
+ {
877
+ properties: {
878
+ created_at: {
879
+ description:
880
+ 'Date and time at which Seam created the error.',
881
+ format: 'date-time',
882
+ type: 'string',
883
+ },
884
+ error_code: {
885
+ description:
886
+ 'Indicates that the access system has lost its Salto KS certification. Please contact support to regain access.',
887
+ enum: ['salto_ks_certification_expired'],
888
+ type: 'string',
889
+ },
890
+ message: {
891
+ description:
892
+ 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
893
+ type: 'string',
894
+ },
895
+ },
896
+ required: ['created_at', 'message', 'error_code'],
897
+ type: 'object',
898
+ },
876
899
  ],
877
900
  },
878
901
  type: 'array',
@@ -18032,6 +18055,157 @@ export default {
18032
18055
  'x-title': 'Set the Fan Mode Setting',
18033
18056
  },
18034
18057
  },
18058
+ '/thermostats/set_hvac_mode': {
18059
+ post: {
18060
+ description:
18061
+ 'Sets the [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).',
18062
+ operationId: 'thermostatsSetHvacModePost',
18063
+ requestBody: {
18064
+ content: {
18065
+ 'application/json': {
18066
+ schema: {
18067
+ discriminator: { propertyName: 'hvac_mode_setting' },
18068
+ oneOf: [
18069
+ {
18070
+ properties: {
18071
+ device_id: {
18072
+ description: 'ID of the desired thermostat device.',
18073
+ format: 'uuid',
18074
+ type: 'string',
18075
+ },
18076
+ hvac_mode_setting: { enum: ['off'], type: 'string' },
18077
+ },
18078
+ required: ['hvac_mode_setting', 'device_id'],
18079
+ type: 'object',
18080
+ },
18081
+ {
18082
+ properties: {
18083
+ cooling_set_point_celsius: {
18084
+ description:
18085
+ 'Desired [cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C. You must set one of the `cooling_set_point` parameters.',
18086
+ format: 'float',
18087
+ type: 'number',
18088
+ },
18089
+ cooling_set_point_fahrenheit: {
18090
+ description:
18091
+ 'Desired [cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F. You must set one of the `cooling_set_point` parameters.',
18092
+ format: 'float',
18093
+ type: 'number',
18094
+ },
18095
+ device_id: {
18096
+ description: 'ID of the desired thermostat device.',
18097
+ format: 'uuid',
18098
+ type: 'string',
18099
+ },
18100
+ hvac_mode_setting: { enum: ['cool'], type: 'string' },
18101
+ },
18102
+ required: ['hvac_mode_setting', 'device_id'],
18103
+ type: 'object',
18104
+ },
18105
+ {
18106
+ properties: {
18107
+ device_id: {
18108
+ description: 'ID of the desired thermostat device.',
18109
+ format: 'uuid',
18110
+ type: 'string',
18111
+ },
18112
+ heating_set_point_celsius: {
18113
+ description:
18114
+ 'Desired [heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C. You must set one of the `heating_set_point` parameters.',
18115
+ format: 'float',
18116
+ type: 'number',
18117
+ },
18118
+ heating_set_point_fahrenheit: {
18119
+ description:
18120
+ 'Desired [heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F. You must set one of the `heating_set_point` parameters.',
18121
+ format: 'float',
18122
+ type: 'number',
18123
+ },
18124
+ hvac_mode_setting: { enum: ['heat'], type: 'string' },
18125
+ },
18126
+ required: ['hvac_mode_setting', 'device_id'],
18127
+ type: 'object',
18128
+ },
18129
+ {
18130
+ properties: {
18131
+ cooling_set_point_celsius: {
18132
+ description:
18133
+ 'Desired [cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C. You must set one of the `cooling_set_point` parameters.',
18134
+ format: 'float',
18135
+ type: 'number',
18136
+ },
18137
+ cooling_set_point_fahrenheit: {
18138
+ description:
18139
+ 'Desired [cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F. You must set one of the `cooling_set_point` parameters.',
18140
+ format: 'float',
18141
+ type: 'number',
18142
+ },
18143
+ device_id: {
18144
+ description: 'ID of the desired thermostat device.',
18145
+ format: 'uuid',
18146
+ type: 'string',
18147
+ },
18148
+ heating_set_point_celsius: {
18149
+ description:
18150
+ 'Desired [heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C. You must set one of the `heating_set_point` parameters.',
18151
+ format: 'float',
18152
+ type: 'number',
18153
+ },
18154
+ heating_set_point_fahrenheit: {
18155
+ description:
18156
+ 'Desired [heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F. You must set one of the `heating_set_point` parameters.',
18157
+ format: 'float',
18158
+ type: 'number',
18159
+ },
18160
+ hvac_mode_setting: {
18161
+ enum: ['heat_cool'],
18162
+ type: 'string',
18163
+ },
18164
+ },
18165
+ required: ['hvac_mode_setting', 'device_id'],
18166
+ type: 'object',
18167
+ },
18168
+ ],
18169
+ },
18170
+ },
18171
+ },
18172
+ },
18173
+ responses: {
18174
+ 200: {
18175
+ content: {
18176
+ 'application/json': {
18177
+ schema: {
18178
+ properties: {
18179
+ action_attempt: {
18180
+ $ref: '#/components/schemas/action_attempt',
18181
+ },
18182
+ ok: { type: 'boolean' },
18183
+ },
18184
+ required: ['action_attempt', 'ok'],
18185
+ type: 'object',
18186
+ },
18187
+ },
18188
+ },
18189
+ description: 'OK',
18190
+ },
18191
+ 400: { description: 'Bad Request' },
18192
+ 401: { description: 'Unauthorized' },
18193
+ },
18194
+ security: [
18195
+ { client_session: [] },
18196
+ { pat_with_workspace: [] },
18197
+ { console_session: [] },
18198
+ { api_key: [] },
18199
+ ],
18200
+ summary: '/thermostats/set_hvac_mode',
18201
+ tags: ['/thermostats'],
18202
+ 'x-fern-sdk-group-name': ['thermostats'],
18203
+ 'x-fern-sdk-method-name': 'set_hvac_mode',
18204
+ 'x-fern-sdk-return-value': 'action_attempt',
18205
+ 'x-response-key': 'action_attempt',
18206
+ 'x-title': 'Set the HVAC Mode',
18207
+ },
18208
+ },
18035
18209
  '/thermostats/set_temperature_threshold': {
18036
18210
  patch: {
18037
18211
  description: