/* * Automatically generated by codegen/smith.ts. * Do not edit this file or add other files to this directory. */ import { seamApiLtsVersion } from 'lib/lts-version.js' import { getAuthHeadersForClientSessionToken, warnOnInsecureuserIdentifierKey, } from 'lib/seam/connect/auth.js' import { type Client, createClient } from 'lib/seam/connect/client.js' import { isSeamHttpOptionsWithApiKey, isSeamHttpOptionsWithClient, isSeamHttpOptionsWithClientSessionToken, isSeamHttpOptionsWithConsoleSessionToken, isSeamHttpOptionsWithPersonalAccessToken, type SeamHttpFromPublishableKeyOptions, SeamHttpInvalidOptionsError, type SeamHttpOptions, type SeamHttpOptionsWithApiKey, type SeamHttpOptionsWithClient, type SeamHttpOptionsWithClientSessionToken, type SeamHttpOptionsWithConsoleSessionToken, type SeamHttpOptionsWithPersonalAccessToken, type SeamHttpRequestOptions, } from 'lib/seam/connect/options.js' import { limitToSeamHttpRequestOptions, parseOptions, } from 'lib/seam/connect/parse-options.js' import type { ThermostatSchedule } from 'lib/seam/connect/resources/thermostat-schedule.js' import { SeamHttpClientSessions } from 'lib/seam/connect/routes/client-sessions/index.js' import { SeamHttpRequest } from 'lib/seam/connect/seam-http-request.js' import { SeamPaginator } from 'lib/seam/connect/seam-paginator.js' export class SeamHttpThermostatsSchedules { client: Client readonly defaults: Required readonly ltsVersion = seamApiLtsVersion static ltsVersion = seamApiLtsVersion constructor(apiKeyOrOptions: string | SeamHttpOptions = {}) { const options = parseOptions(apiKeyOrOptions) this.client = 'client' in options ? options.client : createClient(options) this.defaults = limitToSeamHttpRequestOptions(options) } static fromClient( client: SeamHttpOptionsWithClient['client'], options: Omit = {}, ): SeamHttpThermostatsSchedules { const constructorOptions = { ...options, client } if (!isSeamHttpOptionsWithClient(constructorOptions)) { throw new SeamHttpInvalidOptionsError('Missing client') } return new SeamHttpThermostatsSchedules(constructorOptions) } static fromApiKey( apiKey: SeamHttpOptionsWithApiKey['apiKey'], options: Omit = {}, ): SeamHttpThermostatsSchedules { const constructorOptions = { ...options, apiKey } if (!isSeamHttpOptionsWithApiKey(constructorOptions)) { throw new SeamHttpInvalidOptionsError('Missing apiKey') } return new SeamHttpThermostatsSchedules(constructorOptions) } static fromClientSessionToken( clientSessionToken: SeamHttpOptionsWithClientSessionToken['clientSessionToken'], options: Omit< SeamHttpOptionsWithClientSessionToken, 'clientSessionToken' > = {}, ): SeamHttpThermostatsSchedules { const constructorOptions = { ...options, clientSessionToken } if (!isSeamHttpOptionsWithClientSessionToken(constructorOptions)) { throw new SeamHttpInvalidOptionsError('Missing clientSessionToken') } return new SeamHttpThermostatsSchedules(constructorOptions) } static async fromPublishableKey( publishableKey: string, userIdentifierKey: string, options: SeamHttpFromPublishableKeyOptions = {}, ): Promise { warnOnInsecureuserIdentifierKey(userIdentifierKey) const clientOptions = parseOptions({ ...options, publishableKey }) if (isSeamHttpOptionsWithClient(clientOptions)) { throw new SeamHttpInvalidOptionsError( 'The client option cannot be used with SeamHttpThermostatsSchedules.fromPublishableKey', ) } const client = createClient(clientOptions) const clientSessions = SeamHttpClientSessions.fromClient(client) const { token } = await clientSessions.getOrCreate({ user_identifier_key: userIdentifierKey, }) return SeamHttpThermostatsSchedules.fromClientSessionToken(token, options) } static fromConsoleSessionToken( consoleSessionToken: SeamHttpOptionsWithConsoleSessionToken['consoleSessionToken'], workspaceId: SeamHttpOptionsWithConsoleSessionToken['workspaceId'], options: Omit< SeamHttpOptionsWithConsoleSessionToken, 'consoleSessionToken' | 'workspaceId' > = {}, ): SeamHttpThermostatsSchedules { const constructorOptions = { ...options, consoleSessionToken, workspaceId } if (!isSeamHttpOptionsWithConsoleSessionToken(constructorOptions)) { throw new SeamHttpInvalidOptionsError( 'Missing consoleSessionToken or workspaceId', ) } return new SeamHttpThermostatsSchedules(constructorOptions) } static fromPersonalAccessToken( personalAccessToken: SeamHttpOptionsWithPersonalAccessToken['personalAccessToken'], workspaceId: SeamHttpOptionsWithPersonalAccessToken['workspaceId'], options: Omit< SeamHttpOptionsWithPersonalAccessToken, 'personalAccessToken' | 'workspaceId' > = {}, ): SeamHttpThermostatsSchedules { const constructorOptions = { ...options, personalAccessToken, workspaceId } if (!isSeamHttpOptionsWithPersonalAccessToken(constructorOptions)) { throw new SeamHttpInvalidOptionsError( 'Missing personalAccessToken or workspaceId', ) } return new SeamHttpThermostatsSchedules(constructorOptions) } createPaginator( request: SeamHttpRequest, ): SeamPaginator { return new SeamPaginator(this, request) } async updateClientSessionToken( clientSessionToken: SeamHttpOptionsWithClientSessionToken['clientSessionToken'], ): Promise { const { headers } = this.client.defaults const authHeaders = getAuthHeadersForClientSessionToken({ clientSessionToken, }) for (const key of Object.keys(authHeaders)) { if (headers[key] == null) { throw new Error( 'Cannot update a clientSessionToken on a client created without a clientSessionToken', ) } } this.client.defaults.headers = { ...headers, ...authHeaders } const clientSessions = SeamHttpClientSessions.fromClient(this.client) await clientSessions.get() } /** * Creates a new [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules) for a specified [thermostat](https://docs.seam.co/capability-guides/thermostats). */ create( parameters: ThermostatsSchedulesCreateParameters, options: ThermostatsSchedulesCreateOptions = {}, ): ThermostatsSchedulesCreateRequest { return new SeamHttpRequest(this, { pathname: '/thermostats/schedules/create', method: 'POST', body: parameters, responseKey: 'thermostat_schedule', options, }) } /** * Deletes a [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules) for a specified [thermostat](https://docs.seam.co/capability-guides/thermostats). */ delete( parameters: ThermostatsSchedulesDeleteParameters, options: ThermostatsSchedulesDeleteOptions = {}, ): ThermostatsSchedulesDeleteRequest { return new SeamHttpRequest(this, { pathname: '/thermostats/schedules/delete', method: 'POST', body: parameters, responseKey: undefined, options, }) } /** * Returns a specified [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules). */ get( parameters: ThermostatsSchedulesGetParameters, options: ThermostatsSchedulesGetOptions = {}, ): ThermostatsSchedulesGetRequest { return new SeamHttpRequest(this, { pathname: '/thermostats/schedules/get', method: 'POST', body: parameters, responseKey: 'thermostat_schedule', options, }) } /** * Returns a list of all [thermostat schedules](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules) for a specified [thermostat](https://docs.seam.co/capability-guides/thermostats). */ list( parameters: ThermostatsSchedulesListParameters, options: ThermostatsSchedulesListOptions = {}, ): ThermostatsSchedulesListRequest { return new SeamHttpRequest(this, { pathname: '/thermostats/schedules/list', method: 'POST', body: parameters, responseKey: 'thermostat_schedules', options, }) } /** * Updates a specified [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules). */ update( parameters: ThermostatsSchedulesUpdateParameters, options: ThermostatsSchedulesUpdateOptions = {}, ): ThermostatsSchedulesUpdateRequest { return new SeamHttpRequest(this, { pathname: '/thermostats/schedules/update', method: 'PATCH', body: parameters, responseKey: undefined, options, }) } } export type ThermostatsSchedulesCreateParameters = { /** * Key of the [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the new thermostat schedule. */ climate_preset_key: string /** * ID of the thermostat device for which you want to create a schedule. */ device_id: string /** * Date and time at which the new thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ ends_at: string /** * Indicates whether a person at the thermostat or using the API can change the thermostat's settings while the new schedule is active. See also [Specifying Manual Override Permissions](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). */ is_override_allowed?: boolean | undefined /** * Number of minutes for which a person at the thermostat or using the API can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). */ max_override_period_minutes?: number | undefined /** * Name of the thermostat schedule. */ name?: string | undefined /** * Date and time at which the new thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at: string } /** * @deprecated Use ThermostatsSchedulesCreateRequest instead. */ export type ThermostatsSchedulesCreateResponse = { thermostat_schedule: ThermostatSchedule } export type ThermostatsSchedulesCreateRequest = SeamHttpRequest< ThermostatsSchedulesCreateResponse, 'thermostat_schedule' > export interface ThermostatsSchedulesCreateOptions {} export type ThermostatsSchedulesDeleteParameters = { /** * ID of the thermostat schedule that you want to delete. */ thermostat_schedule_id: string } /** * @deprecated Use ThermostatsSchedulesDeleteRequest instead. */ export type ThermostatsSchedulesDeleteResponse = void export type ThermostatsSchedulesDeleteRequest = SeamHttpRequest export interface ThermostatsSchedulesDeleteOptions {} export type ThermostatsSchedulesGetParameters = { /** * ID of the thermostat schedule that you want to get. */ thermostat_schedule_id: string } /** * @deprecated Use ThermostatsSchedulesGetRequest instead. */ export type ThermostatsSchedulesGetResponse = { thermostat_schedule: ThermostatSchedule } export type ThermostatsSchedulesGetRequest = SeamHttpRequest< ThermostatsSchedulesGetResponse, 'thermostat_schedule' > export interface ThermostatsSchedulesGetOptions {} export type ThermostatsSchedulesListParameters = { /** * ID of the thermostat device for which you want to list schedules. */ device_id: string /** * User identifier key by which to filter the list of returned thermostat schedules. */ user_identifier_key?: string | undefined } /** * @deprecated Use ThermostatsSchedulesListRequest instead. */ export type ThermostatsSchedulesListResponse = { thermostat_schedules: Array } export type ThermostatsSchedulesListRequest = SeamHttpRequest< ThermostatsSchedulesListResponse, 'thermostat_schedules' > export interface ThermostatsSchedulesListOptions {} export type ThermostatsSchedulesUpdateParameters = { /** * Key of the [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. */ climate_preset_key?: string | undefined /** * Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ ends_at?: string | undefined /** * Indicates whether a person at the thermostat or using the API can change the thermostat's settings while the schedule is active. See also [Specifying Manual Override Permissions](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). */ is_override_allowed?: boolean | undefined /** * Number of minutes for which a person at the thermostat or using the API can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). */ max_override_period_minutes?: number | undefined /** * Name of the thermostat schedule. */ name?: string | undefined /** * Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined /** * ID of the thermostat schedule that you want to update. */ thermostat_schedule_id: string } /** * @deprecated Use ThermostatsSchedulesUpdateRequest instead. */ export type ThermostatsSchedulesUpdateResponse = void export type ThermostatsSchedulesUpdateRequest = SeamHttpRequest export interface ThermostatsSchedulesUpdateOptions {}