@seamapi/types 1.298.0 → 1.300.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.298.0",
3
+ "version": "1.300.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -12,7 +12,8 @@ export const start_end_schedule = z.object({
12
12
  .datetime()
13
13
  .describe(
14
14
  "Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
15
- ),
15
+ )
16
+ .nullable(),
16
17
  })
17
18
 
18
19
  // export const schedule = z.union([
@@ -1054,6 +1054,7 @@ export default {
1054
1054
  description:
1055
1055
  "Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
1056
1056
  format: 'date-time',
1057
+ nullable: true,
1057
1058
  type: 'string',
1058
1059
  },
1059
1060
  starts_at: {
@@ -11102,12 +11103,15 @@ export default {
11102
11103
  properties: {
11103
11104
  access_schedule: {
11104
11105
  description:
11105
- "`starts_at` and `ends_at` timestamps for the new `acs_user`'s access. If you specify an `access_schedule`, you must include both `starts_at` and `ends_at`. `ends_at` must be a time in the future and after `starts_at`. Only applicable to Salto KS access control systems.",
11106
+ "`starts_at` and `ends_at` timestamps for the new `acs_user`'s access. If you specify an `access_schedule`, you may include both `starts_at` and `ends_at`. `starts_at` defaults to the current time if not provided. `ends_at` is optional and must be a time in the future and after `starts_at`.",
11106
11107
  properties: {
11107
- ends_at: { format: 'date-time', type: 'string' },
11108
+ ends_at: {
11109
+ format: 'date-time',
11110
+ nullable: true,
11111
+ type: 'string',
11112
+ },
11108
11113
  starts_at: { format: 'date-time', type: 'string' },
11109
11114
  },
11110
- required: ['starts_at', 'ends_at'],
11111
11115
  type: 'object',
11112
11116
  },
11113
11117
  acs_access_group_ids: {
@@ -11619,6 +11623,7 @@ export default {
11619
11623
  description:
11620
11624
  "Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
11621
11625
  format: 'date-time',
11626
+ nullable: true,
11622
11627
  type: 'string',
11623
11628
  },
11624
11629
  starts_at: {
@@ -12011,6 +12016,7 @@ export default {
12011
12016
  description:
12012
12017
  "Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
12013
12018
  format: 'date-time',
12019
+ nullable: true,
12014
12020
  type: 'string',
12015
12021
  },
12016
12022
  starts_at: {
@@ -12433,7 +12439,7 @@ export default {
12433
12439
  properties: {
12434
12440
  access_schedule: {
12435
12441
  description:
12436
- "`starts_at` and `ends_at` timestamps for the `acs_user`'s access. If you specify an `access_schedule`, you must include both `starts_at` and `ends_at`. `ends_at` must be a time in the future and after `starts_at`. Only applicable to Salto KS access control systems.",
12442
+ "`starts_at` and `ends_at` timestamps for the `acs_user`'s access. If you specify an `access_schedule`, you must include both `starts_at` and `ends_at`. `ends_at` must be a time in the future and after `starts_at`.",
12437
12443
  nullable: true,
12438
12444
  properties: {
12439
12445
  ends_at: { format: 'date-time', type: 'string' },
@@ -12513,7 +12519,7 @@ export default {
12513
12519
  properties: {
12514
12520
  access_schedule: {
12515
12521
  description:
12516
- "`starts_at` and `ends_at` timestamps for the `acs_user`'s access. If you specify an `access_schedule`, you must include both `starts_at` and `ends_at`. `ends_at` must be a time in the future and after `starts_at`. Only applicable to Salto KS access control systems.",
12522
+ "`starts_at` and `ends_at` timestamps for the `acs_user`'s access. If you specify an `access_schedule`, you must include both `starts_at` and `ends_at`. `ends_at` must be a time in the future and after `starts_at`.",
12517
12523
  nullable: true,
12518
12524
  properties: {
12519
12525
  ends_at: { format: 'date-time', type: 'string' },
@@ -18055,6 +18061,157 @@ export default {
18055
18061
  'x-title': 'Set the Fan Mode Setting',
18056
18062
  },
18057
18063
  },
18064
+ '/thermostats/set_hvac_mode': {
18065
+ post: {
18066
+ description:
18067
+ '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).',
18068
+ operationId: 'thermostatsSetHvacModePost',
18069
+ requestBody: {
18070
+ content: {
18071
+ 'application/json': {
18072
+ schema: {
18073
+ discriminator: { propertyName: 'hvac_mode_setting' },
18074
+ oneOf: [
18075
+ {
18076
+ properties: {
18077
+ device_id: {
18078
+ description: 'ID of the desired thermostat device.',
18079
+ format: 'uuid',
18080
+ type: 'string',
18081
+ },
18082
+ hvac_mode_setting: { enum: ['off'], type: 'string' },
18083
+ },
18084
+ required: ['hvac_mode_setting', 'device_id'],
18085
+ type: 'object',
18086
+ },
18087
+ {
18088
+ properties: {
18089
+ cooling_set_point_celsius: {
18090
+ description:
18091
+ '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.',
18092
+ format: 'float',
18093
+ type: 'number',
18094
+ },
18095
+ cooling_set_point_fahrenheit: {
18096
+ description:
18097
+ '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.',
18098
+ format: 'float',
18099
+ type: 'number',
18100
+ },
18101
+ device_id: {
18102
+ description: 'ID of the desired thermostat device.',
18103
+ format: 'uuid',
18104
+ type: 'string',
18105
+ },
18106
+ hvac_mode_setting: { enum: ['cool'], type: 'string' },
18107
+ },
18108
+ required: ['hvac_mode_setting', 'device_id'],
18109
+ type: 'object',
18110
+ },
18111
+ {
18112
+ properties: {
18113
+ device_id: {
18114
+ description: 'ID of the desired thermostat device.',
18115
+ format: 'uuid',
18116
+ type: 'string',
18117
+ },
18118
+ heating_set_point_celsius: {
18119
+ description:
18120
+ '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.',
18121
+ format: 'float',
18122
+ type: 'number',
18123
+ },
18124
+ heating_set_point_fahrenheit: {
18125
+ description:
18126
+ '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.',
18127
+ format: 'float',
18128
+ type: 'number',
18129
+ },
18130
+ hvac_mode_setting: { enum: ['heat'], type: 'string' },
18131
+ },
18132
+ required: ['hvac_mode_setting', 'device_id'],
18133
+ type: 'object',
18134
+ },
18135
+ {
18136
+ properties: {
18137
+ cooling_set_point_celsius: {
18138
+ description:
18139
+ '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.',
18140
+ format: 'float',
18141
+ type: 'number',
18142
+ },
18143
+ cooling_set_point_fahrenheit: {
18144
+ description:
18145
+ '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.',
18146
+ format: 'float',
18147
+ type: 'number',
18148
+ },
18149
+ device_id: {
18150
+ description: 'ID of the desired thermostat device.',
18151
+ format: 'uuid',
18152
+ type: 'string',
18153
+ },
18154
+ heating_set_point_celsius: {
18155
+ description:
18156
+ '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.',
18157
+ format: 'float',
18158
+ type: 'number',
18159
+ },
18160
+ heating_set_point_fahrenheit: {
18161
+ description:
18162
+ '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.',
18163
+ format: 'float',
18164
+ type: 'number',
18165
+ },
18166
+ hvac_mode_setting: {
18167
+ enum: ['heat_cool'],
18168
+ type: 'string',
18169
+ },
18170
+ },
18171
+ required: ['hvac_mode_setting', 'device_id'],
18172
+ type: 'object',
18173
+ },
18174
+ ],
18175
+ },
18176
+ },
18177
+ },
18178
+ },
18179
+ responses: {
18180
+ 200: {
18181
+ content: {
18182
+ 'application/json': {
18183
+ schema: {
18184
+ properties: {
18185
+ action_attempt: {
18186
+ $ref: '#/components/schemas/action_attempt',
18187
+ },
18188
+ ok: { type: 'boolean' },
18189
+ },
18190
+ required: ['action_attempt', 'ok'],
18191
+ type: 'object',
18192
+ },
18193
+ },
18194
+ },
18195
+ description: 'OK',
18196
+ },
18197
+ 400: { description: 'Bad Request' },
18198
+ 401: { description: 'Unauthorized' },
18199
+ },
18200
+ security: [
18201
+ { client_session: [] },
18202
+ { pat_with_workspace: [] },
18203
+ { console_session: [] },
18204
+ { api_key: [] },
18205
+ ],
18206
+ summary: '/thermostats/set_hvac_mode',
18207
+ tags: ['/thermostats'],
18208
+ 'x-fern-sdk-group-name': ['thermostats'],
18209
+ 'x-fern-sdk-method-name': 'set_hvac_mode',
18210
+ 'x-fern-sdk-return-value': 'action_attempt',
18211
+ 'x-response-key': 'action_attempt',
18212
+ 'x-title': 'Set the HVAC Mode',
18213
+ },
18214
+ },
18058
18215
  '/thermostats/set_temperature_threshold': {
18059
18216
  patch: {
18060
18217
  description: