@seamapi/types 1.495.0 → 1.496.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.
@@ -20091,6 +20091,54 @@ export type Routes = {
20091
20091
  /** Current status of the access code within the operational lifecycle. `set` indicates that the code is active and operational. */
20092
20092
  status: 'set';
20093
20093
  }[] | undefined;
20094
+ thermostat_daily_programs?: {
20095
+ /** ID of the thermostat daily program. */
20096
+ thermostat_daily_program_id: string;
20097
+ /** ID of the thermostat device on which the thermostat daily program is configured. */
20098
+ device_id: string;
20099
+ /** User-friendly name to identify the thermostat daily program. */
20100
+ name: string | null;
20101
+ /** Array of thermostat daily program periods. */
20102
+ periods: {
20103
+ /** Time at which the thermostat daily program period starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
20104
+ starts_at_time: string;
20105
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to activate at the `starts_at_time`. */
20106
+ climate_preset_key: string;
20107
+ }[];
20108
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the thermostat daily program. */
20109
+ workspace_id: string;
20110
+ /** Date and time at which the thermostat daily program was created. */
20111
+ created_at: string;
20112
+ }[] | undefined;
20113
+ thermostat_schedules?: {
20114
+ /** ID of the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules). */
20115
+ thermostat_schedule_id: string;
20116
+ /** ID of the desired [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) device. */
20117
+ device_id: string;
20118
+ /** User-friendly name to identify the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules). */
20119
+ name: string | null;
20120
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules). */
20121
+ climate_preset_key: string;
20122
+ /** Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets). See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). */
20123
+ max_override_period_minutes?: (number | null) | undefined;
20124
+ /** Date and time at which the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
20125
+ starts_at: string;
20126
+ /** Indicates whether a person at the thermostat can change the thermostat's settings after the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) starts. */
20127
+ is_override_allowed?: boolean | undefined;
20128
+ /** Date and time at which the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
20129
+ ends_at: string;
20130
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the thermostat schedule. */
20131
+ workspace_id: string;
20132
+ /** Date and time at which the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) was created. */
20133
+ created_at: string;
20134
+ /** Errors associated with the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules). */
20135
+ errors: {
20136
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
20137
+ error_code: string;
20138
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
20139
+ message: string;
20140
+ }[];
20141
+ }[] | undefined;
20094
20142
  };
20095
20143
  };
20096
20144
  };
@@ -85942,6 +85990,54 @@ export type Routes = {
85942
85990
  /** Current status of the access code within the operational lifecycle. `set` indicates that the code is active and operational. */
85943
85991
  status: 'set';
85944
85992
  }[] | undefined;
85993
+ thermostat_daily_programs?: {
85994
+ /** ID of the thermostat daily program. */
85995
+ thermostat_daily_program_id: string;
85996
+ /** ID of the thermostat device on which the thermostat daily program is configured. */
85997
+ device_id: string;
85998
+ /** User-friendly name to identify the thermostat daily program. */
85999
+ name: string | null;
86000
+ /** Array of thermostat daily program periods. */
86001
+ periods: {
86002
+ /** Time at which the thermostat daily program period starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
86003
+ starts_at_time: string;
86004
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to activate at the `starts_at_time`. */
86005
+ climate_preset_key: string;
86006
+ }[];
86007
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the thermostat daily program. */
86008
+ workspace_id: string;
86009
+ /** Date and time at which the thermostat daily program was created. */
86010
+ created_at: string;
86011
+ }[] | undefined;
86012
+ thermostat_schedules?: {
86013
+ /** ID of the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules). */
86014
+ thermostat_schedule_id: string;
86015
+ /** ID of the desired [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) device. */
86016
+ device_id: string;
86017
+ /** User-friendly name to identify the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules). */
86018
+ name: string | null;
86019
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules). */
86020
+ climate_preset_key: string;
86021
+ /** Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets). See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). */
86022
+ max_override_period_minutes?: (number | null) | undefined;
86023
+ /** Date and time at which the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
86024
+ starts_at: string;
86025
+ /** Indicates whether a person at the thermostat can change the thermostat's settings after the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) starts. */
86026
+ is_override_allowed?: boolean | undefined;
86027
+ /** Date and time at which the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
86028
+ ends_at: string;
86029
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the thermostat schedule. */
86030
+ workspace_id: string;
86031
+ /** Date and time at which the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) was created. */
86032
+ created_at: string;
86033
+ /** Errors associated with the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules). */
86034
+ errors: {
86035
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
86036
+ error_code: string;
86037
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
86038
+ message: string;
86039
+ }[];
86040
+ }[] | undefined;
85945
86041
  };
85946
86042
  };
85947
86043
  };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.495.0",
3
+ "version": "1.496.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -23,6 +23,10 @@ import { unmanaged_device } from './devices/unmanaged-device.js'
23
23
  import { seam_event } from './events/seam-event.js'
24
24
  import { instant_key } from './instant-keys/instant-key.js'
25
25
  import { space } from './spaces/index.js'
26
+ import {
27
+ thermostat_daily_program,
28
+ thermostat_schedule,
29
+ } from './thermostats/index.js'
26
30
  import { user_identity } from './user-identities/index.js'
27
31
  import { workspace } from './workspaces/index.js'
28
32
 
@@ -82,6 +86,8 @@ export const workspaces_batch = z
82
86
  instant_keys: instant_key.array().optional(),
83
87
  access_codes: access_code.array().optional(),
84
88
  unmanaged_access_codes: unmanaged_access_code.array().optional(),
89
+ thermostat_daily_programs: thermostat_daily_program.array().optional(),
90
+ thermostat_schedules: thermostat_schedule.array().optional(),
85
91
  })
86
92
  .describe('A batch of workspace resources.')
87
93
 
@@ -116,6 +122,8 @@ export const batch = z
116
122
  instant_keys: instant_key.array().optional(),
117
123
  access_codes: access_code.array().optional(),
118
124
  unmanaged_access_codes: unmanaged_access_code.array().optional(),
125
+ thermostat_daily_programs: thermostat_daily_program.array().optional(),
126
+ thermostat_schedules: thermostat_schedule.array().optional(),
119
127
  })
120
128
  .describe('A batch of workspace resources.')
121
129
 
@@ -29279,6 +29279,18 @@ export default {
29279
29279
  items: { $ref: '#/components/schemas/space' },
29280
29280
  type: 'array',
29281
29281
  },
29282
+ thermostat_daily_programs: {
29283
+ items: {
29284
+ $ref: '#/components/schemas/thermostat_daily_program',
29285
+ },
29286
+ type: 'array',
29287
+ },
29288
+ thermostat_schedules: {
29289
+ items: {
29290
+ $ref: '#/components/schemas/thermostat_schedule',
29291
+ },
29292
+ type: 'array',
29293
+ },
29282
29294
  unmanaged_access_codes: {
29283
29295
  items: {
29284
29296
  $ref: '#/components/schemas/unmanaged_access_code',
@@ -29476,6 +29488,18 @@ export default {
29476
29488
  items: { $ref: '#/components/schemas/space' },
29477
29489
  type: 'array',
29478
29490
  },
29491
+ thermostat_daily_programs: {
29492
+ items: {
29493
+ $ref: '#/components/schemas/thermostat_daily_program',
29494
+ },
29495
+ type: 'array',
29496
+ },
29497
+ thermostat_schedules: {
29498
+ items: {
29499
+ $ref: '#/components/schemas/thermostat_schedule',
29500
+ },
29501
+ type: 'array',
29502
+ },
29479
29503
  unmanaged_access_codes: {
29480
29504
  items: {
29481
29505
  $ref: '#/components/schemas/unmanaged_access_code',
@@ -56791,6 +56815,18 @@ export default {
56791
56815
  items: { $ref: '#/components/schemas/space' },
56792
56816
  type: 'array',
56793
56817
  },
56818
+ thermostat_daily_programs: {
56819
+ items: {
56820
+ $ref: '#/components/schemas/thermostat_daily_program',
56821
+ },
56822
+ type: 'array',
56823
+ },
56824
+ thermostat_schedules: {
56825
+ items: {
56826
+ $ref: '#/components/schemas/thermostat_schedule',
56827
+ },
56828
+ type: 'array',
56829
+ },
56794
56830
  unmanaged_access_codes: {
56795
56831
  items: {
56796
56832
  $ref: '#/components/schemas/unmanaged_access_code',
@@ -56966,6 +57002,18 @@ export default {
56966
57002
  items: { $ref: '#/components/schemas/space' },
56967
57003
  type: 'array',
56968
57004
  },
57005
+ thermostat_daily_programs: {
57006
+ items: {
57007
+ $ref: '#/components/schemas/thermostat_daily_program',
57008
+ },
57009
+ type: 'array',
57010
+ },
57011
+ thermostat_schedules: {
57012
+ items: {
57013
+ $ref: '#/components/schemas/thermostat_schedule',
57014
+ },
57015
+ type: 'array',
57016
+ },
56969
57017
  unmanaged_access_codes: {
56970
57018
  items: {
56971
57019
  $ref: '#/components/schemas/unmanaged_access_code',
@@ -23306,6 +23306,58 @@ export type Routes = {
23306
23306
  status: 'set'
23307
23307
  }[]
23308
23308
  | undefined
23309
+ thermostat_daily_programs?:
23310
+ | {
23311
+ /** ID of the thermostat daily program. */
23312
+ thermostat_daily_program_id: string
23313
+ /** ID of the thermostat device on which the thermostat daily program is configured. */
23314
+ device_id: string
23315
+ /** User-friendly name to identify the thermostat daily program. */
23316
+ name: string | null
23317
+ /** Array of thermostat daily program periods. */
23318
+ periods: {
23319
+ /** Time at which the thermostat daily program period starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
23320
+ starts_at_time: string
23321
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to activate at the `starts_at_time`. */
23322
+ climate_preset_key: string
23323
+ }[]
23324
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the thermostat daily program. */
23325
+ workspace_id: string
23326
+ /** Date and time at which the thermostat daily program was created. */
23327
+ created_at: string
23328
+ }[]
23329
+ | undefined
23330
+ thermostat_schedules?:
23331
+ | {
23332
+ /** ID of the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules). */
23333
+ thermostat_schedule_id: string
23334
+ /** ID of the desired [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) device. */
23335
+ device_id: string
23336
+ /** User-friendly name to identify the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules). */
23337
+ name: string | null
23338
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules). */
23339
+ climate_preset_key: string
23340
+ /** Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets). See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). */
23341
+ max_override_period_minutes?: (number | null) | undefined
23342
+ /** Date and time at which the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
23343
+ starts_at: string
23344
+ /** Indicates whether a person at the thermostat can change the thermostat's settings after the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) starts. */
23345
+ is_override_allowed?: boolean | undefined
23346
+ /** Date and time at which the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
23347
+ ends_at: string
23348
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the thermostat schedule. */
23349
+ workspace_id: string
23350
+ /** Date and time at which the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) was created. */
23351
+ created_at: string
23352
+ /** Errors associated with the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules). */
23353
+ errors: {
23354
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
23355
+ error_code: string
23356
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
23357
+ message: string
23358
+ }[]
23359
+ }[]
23360
+ | undefined
23309
23361
  }
23310
23362
  }
23311
23363
  }
@@ -101986,6 +102038,58 @@ export type Routes = {
101986
102038
  status: 'set'
101987
102039
  }[]
101988
102040
  | undefined
102041
+ thermostat_daily_programs?:
102042
+ | {
102043
+ /** ID of the thermostat daily program. */
102044
+ thermostat_daily_program_id: string
102045
+ /** ID of the thermostat device on which the thermostat daily program is configured. */
102046
+ device_id: string
102047
+ /** User-friendly name to identify the thermostat daily program. */
102048
+ name: string | null
102049
+ /** Array of thermostat daily program periods. */
102050
+ periods: {
102051
+ /** Time at which the thermostat daily program period starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
102052
+ starts_at_time: string
102053
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to activate at the `starts_at_time`. */
102054
+ climate_preset_key: string
102055
+ }[]
102056
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the thermostat daily program. */
102057
+ workspace_id: string
102058
+ /** Date and time at which the thermostat daily program was created. */
102059
+ created_at: string
102060
+ }[]
102061
+ | undefined
102062
+ thermostat_schedules?:
102063
+ | {
102064
+ /** ID of the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules). */
102065
+ thermostat_schedule_id: string
102066
+ /** ID of the desired [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) device. */
102067
+ device_id: string
102068
+ /** User-friendly name to identify the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules). */
102069
+ name: string | null
102070
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules). */
102071
+ climate_preset_key: string
102072
+ /** Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets). See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). */
102073
+ max_override_period_minutes?: (number | null) | undefined
102074
+ /** Date and time at which the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
102075
+ starts_at: string
102076
+ /** Indicates whether a person at the thermostat can change the thermostat's settings after the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) starts. */
102077
+ is_override_allowed?: boolean | undefined
102078
+ /** Date and time at which the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
102079
+ ends_at: string
102080
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the thermostat schedule. */
102081
+ workspace_id: string
102082
+ /** Date and time at which the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) was created. */
102083
+ created_at: string
102084
+ /** Errors associated with the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules). */
102085
+ errors: {
102086
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
102087
+ error_code: string
102088
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
102089
+ message: string
102090
+ }[]
102091
+ }[]
102092
+ | undefined
101989
102093
  }
101990
102094
  }
101991
102095
  }