@seamapi/http 2.1.0 → 2.3.0

package/lib/routes/thermostats/simulate/simulate.d.ts

@@ -0,0 +1,81 @@
+import { type Client } from '../../../client.js';
+import { type SeamHttpFromPublishableKeyOptions, type SeamHttpOptions, type SeamHttpOptionsWithApiKey, type SeamHttpOptionsWithClient, type SeamHttpOptionsWithClientSessionToken, type SeamHttpOptionsWithConsoleSessionToken, type SeamHttpOptionsWithPersonalAccessToken, type SeamHttpRequestOptions } from '../../../options.js';
+import { SeamHttpRequest } from '../../../seam-http-request.js';
+import { SeamPaginator } from '../../../seam-paginator.js';
+export declare class SeamHttpThermostatsSimulate {
+    client: Client;
+    readonly defaults: Required<SeamHttpRequestOptions>;
+    readonly ltsVersion = "1.0.0";
+    static ltsVersion: string;
+    constructor(apiKeyOrOptions?: string | SeamHttpOptions);
+    static fromClient(client: SeamHttpOptionsWithClient['client'], options?: Omit<SeamHttpOptionsWithClient, 'client'>): SeamHttpThermostatsSimulate;
+    static fromApiKey(apiKey: SeamHttpOptionsWithApiKey['apiKey'], options?: Omit<SeamHttpOptionsWithApiKey, 'apiKey'>): SeamHttpThermostatsSimulate;
+    static fromClientSessionToken(clientSessionToken: SeamHttpOptionsWithClientSessionToken['clientSessionToken'], options?: Omit<SeamHttpOptionsWithClientSessionToken, 'clientSessionToken'>): SeamHttpThermostatsSimulate;
+    static fromPublishableKey(publishableKey: string, userIdentifierKey: string, options?: SeamHttpFromPublishableKeyOptions): Promise<SeamHttpThermostatsSimulate>;
+    static fromConsoleSessionToken(consoleSessionToken: SeamHttpOptionsWithConsoleSessionToken['consoleSessionToken'], workspaceId: SeamHttpOptionsWithConsoleSessionToken['workspaceId'], options?: Omit<SeamHttpOptionsWithConsoleSessionToken, 'consoleSessionToken' | 'workspaceId'>): SeamHttpThermostatsSimulate;
+    static fromPersonalAccessToken(personalAccessToken: SeamHttpOptionsWithPersonalAccessToken['personalAccessToken'], workspaceId: SeamHttpOptionsWithPersonalAccessToken['workspaceId'], options?: Omit<SeamHttpOptionsWithPersonalAccessToken, 'personalAccessToken' | 'workspaceId'>): SeamHttpThermostatsSimulate;
+    createPaginator<const TResponse, const TResponseKey extends keyof TResponse>(request: SeamHttpRequest<TResponse, TResponseKey>): SeamPaginator<TResponse, TResponseKey>;
+    updateClientSessionToken(clientSessionToken: SeamHttpOptionsWithClientSessionToken['clientSessionToken']): Promise<void>;
+    /**
+     * Simulates having adjusted the [HVAC mode](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) for a [thermostat](https://docs.seam.co/capability-guides/thermostats). Only applicable for [sandbox devices](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces). See also [Testing Your Thermostat App with Simulate Endpoints](https://docs.seam.co/capability-guides/thermostats/testing-your-thermostat-app-with-simulate-endpoints).
+     */
+    hvacModeAdjusted(parameters: ThermostatsSimulateHvacModeAdjustedParameters, options?: ThermostatsSimulateHvacModeAdjustedOptions): ThermostatsSimulateHvacModeAdjustedRequest;
+    /**
+     * Simulates a [thermostat](https://docs.seam.co/capability-guides/thermostats) reaching a specified temperature. Only applicable for [sandbox devices](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces). See also [Testing Your Thermostat App with Simulate Endpoints](https://docs.seam.co/capability-guides/thermostats/testing-your-thermostat-app-with-simulate-endpoints).
+     */
+    temperatureReached(parameters: ThermostatsSimulateTemperatureReachedParameters, options?: ThermostatsSimulateTemperatureReachedOptions): ThermostatsSimulateTemperatureReachedRequest;
+}
+export type ThermostatsSimulateHvacModeAdjustedParameters = {
+    /**
+     * ID of the thermostat device for which you want to simulate having adjusted the HVAC mode.
+     */
+    device_id: string;
+    /**
+     * HVAC mode that you want to simulate.
+     */
+    hvac_mode: 'off' | 'cool' | 'heat' | 'heat_cool';
+    /**
+     * Cooling [set point](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to simulate. You must set `cooling_set_point_celsius` or `cooling_set_point_fahrenheit`.
+     */
+    cooling_set_point_celsius?: number | undefined;
+    /**
+     * Cooling [set point](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to simulate. You must set `cooling_set_point_fahrenheit` or `cooling_set_point_celsius`.
+     */
+    cooling_set_point_fahrenheit?: number | undefined;
+    /**
+     * Heating [set point](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to simulate. You must set `heating_set_point_celsius` or `heating_set_point_fahrenheit`.
+     */
+    heating_set_point_celsius?: number | undefined;
+    /**
+     * Heating [set point](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to simulate. You must set `heating_set_point_fahrenheit` or `heating_set_point_celsius`.
+     */
+    heating_set_point_fahrenheit?: number | undefined;
+};
+/**
+ * @deprecated Use ThermostatsSimulateHvacModeAdjustedRequest instead.
+ */
+export type ThermostatsSimulateHvacModeAdjustedResponse = void;
+export type ThermostatsSimulateHvacModeAdjustedRequest = SeamHttpRequest<void, undefined>;
+export interface ThermostatsSimulateHvacModeAdjustedOptions {
+}
+export type ThermostatsSimulateTemperatureReachedParameters = {
+    /**
+     * ID of the thermostat device that you want to simulate reaching a specified temperature.
+     */
+    device_id: string;
+    /**
+     * Temperature in °C that you want simulate the thermostat reaching. You must set `temperature_celsius` or `temperature_fahrenheit`.
+     */
+    temperature_celsius?: number | undefined;
+    /**
+     * Temperature in °F that you want simulate the thermostat reaching. You must set `temperature_fahrenheit` or `temperature_celsius`.
+     */
+    temperature_fahrenheit?: number | undefined;
+};
+/**
+ * @deprecated Use ThermostatsSimulateTemperatureReachedRequest instead.
+ */
+export type ThermostatsSimulateTemperatureReachedResponse = void;
+export type ThermostatsSimulateTemperatureReachedRequest = SeamHttpRequest<void, undefined>;
+export interface ThermostatsSimulateTemperatureReachedOptions {
+}

package/lib/routes/thermostats/simulate/simulate.js

@@ -0,0 +1,113 @@
+/*
+ * Automatically generated by codegen/smith.ts.
+ * Do not edit this file or add other files to this directory.
+ */
+import { getAuthHeadersForClientSessionToken, warnOnInsecureuserIdentifierKey, } from '../../../auth.js';
+import { createClient } from '../../../client.js';
+import { seamApiLtsVersion } from '../../../lts-version.js';
+import { isSeamHttpOptionsWithApiKey, isSeamHttpOptionsWithClient, isSeamHttpOptionsWithClientSessionToken, isSeamHttpOptionsWithConsoleSessionToken, isSeamHttpOptionsWithPersonalAccessToken, SeamHttpInvalidOptionsError, } from '../../../options.js';
+import { limitToSeamHttpRequestOptions, parseOptions, } from '../../../parse-options.js';
+import { SeamHttpClientSessions } from '../../../routes/client-sessions/index.js';
+import { SeamHttpRequest } from '../../../seam-http-request.js';
+import { SeamPaginator } from '../../../seam-paginator.js';
+export class SeamHttpThermostatsSimulate {
+    client;
+    defaults;
+    ltsVersion = seamApiLtsVersion;
+    static ltsVersion = seamApiLtsVersion;
+    constructor(apiKeyOrOptions = {}) {
+        const options = parseOptions(apiKeyOrOptions);
+        this.client = 'client' in options ? options.client : createClient(options);
+        this.defaults = limitToSeamHttpRequestOptions(options);
+    }
+    static fromClient(client, options = {}) {
+        const constructorOptions = { ...options, client };
+        if (!isSeamHttpOptionsWithClient(constructorOptions)) {
+            throw new SeamHttpInvalidOptionsError('Missing client');
+        }
+        return new SeamHttpThermostatsSimulate(constructorOptions);
+    }
+    static fromApiKey(apiKey, options = {}) {
+        const constructorOptions = { ...options, apiKey };
+        if (!isSeamHttpOptionsWithApiKey(constructorOptions)) {
+            throw new SeamHttpInvalidOptionsError('Missing apiKey');
+        }
+        return new SeamHttpThermostatsSimulate(constructorOptions);
+    }
+    static fromClientSessionToken(clientSessionToken, options = {}) {
+        const constructorOptions = { ...options, clientSessionToken };
+        if (!isSeamHttpOptionsWithClientSessionToken(constructorOptions)) {
+            throw new SeamHttpInvalidOptionsError('Missing clientSessionToken');
+        }
+        return new SeamHttpThermostatsSimulate(constructorOptions);
+    }
+    static async fromPublishableKey(publishableKey, userIdentifierKey, options = {}) {
+        warnOnInsecureuserIdentifierKey(userIdentifierKey);
+        const clientOptions = parseOptions({ ...options, publishableKey });
+        if (isSeamHttpOptionsWithClient(clientOptions)) {
+            throw new SeamHttpInvalidOptionsError('The client option cannot be used with SeamHttpThermostatsSimulate.fromPublishableKey');
+        }
+        const client = createClient(clientOptions);
+        const clientSessions = SeamHttpClientSessions.fromClient(client);
+        const { token } = await clientSessions.getOrCreate({
+            user_identifier_key: userIdentifierKey,
+        });
+        return SeamHttpThermostatsSimulate.fromClientSessionToken(token, options);
+    }
+    static fromConsoleSessionToken(consoleSessionToken, workspaceId, options = {}) {
+        const constructorOptions = { ...options, consoleSessionToken, workspaceId };
+        if (!isSeamHttpOptionsWithConsoleSessionToken(constructorOptions)) {
+            throw new SeamHttpInvalidOptionsError('Missing consoleSessionToken or workspaceId');
+        }
+        return new SeamHttpThermostatsSimulate(constructorOptions);
+    }
+    static fromPersonalAccessToken(personalAccessToken, workspaceId, options = {}) {
+        const constructorOptions = { ...options, personalAccessToken, workspaceId };
+        if (!isSeamHttpOptionsWithPersonalAccessToken(constructorOptions)) {
+            throw new SeamHttpInvalidOptionsError('Missing personalAccessToken or workspaceId');
+        }
+        return new SeamHttpThermostatsSimulate(constructorOptions);
+    }
+    createPaginator(request) {
+        return new SeamPaginator(this, request);
+    }
+    async updateClientSessionToken(clientSessionToken) {
+        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();
+    }
+    /**
+     * Simulates having adjusted the [HVAC mode](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) for a [thermostat](https://docs.seam.co/capability-guides/thermostats). Only applicable for [sandbox devices](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces). See also [Testing Your Thermostat App with Simulate Endpoints](https://docs.seam.co/capability-guides/thermostats/testing-your-thermostat-app-with-simulate-endpoints).
+     */
+    hvacModeAdjusted(parameters, options = {}) {
+        return new SeamHttpRequest(this, {
+            pathname: '/thermostats/simulate/hvac_mode_adjusted',
+            method: 'POST',
+            body: parameters,
+            responseKey: undefined,
+            options,
+        });
+    }
+    /**
+     * Simulates a [thermostat](https://docs.seam.co/capability-guides/thermostats) reaching a specified temperature. Only applicable for [sandbox devices](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces). See also [Testing Your Thermostat App with Simulate Endpoints](https://docs.seam.co/capability-guides/thermostats/testing-your-thermostat-app-with-simulate-endpoints).
+     */
+    temperatureReached(parameters, options = {}) {
+        return new SeamHttpRequest(this, {
+            pathname: '/thermostats/simulate/temperature_reached',
+            method: 'POST',
+            body: parameters,
+            responseKey: undefined,
+            options,
+        });
+    }
+}
+//# sourceMappingURL=simulate.js.map

package/lib/routes/thermostats/simulate/simulate.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"simulate.js","sourceRoot":"","sources":["../../../../src/lib/routes/thermostats/simulate/simulate.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACL,mCAAmC,EACnC,+BAA+B,GAChC,MAAM,aAAa,CAAA;AACpB,OAAO,EAAe,YAAY,EAAE,MAAM,eAAe,CAAA;AACzD,OAAO,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAA;AACtD,OAAO,EACL,2BAA2B,EAC3B,2BAA2B,EAC3B,uCAAuC,EACvC,wCAAwC,EACxC,wCAAwC,EAExC,2BAA2B,GAQ5B,MAAM,gBAAgB,CAAA;AACvB,OAAO,EACL,6BAA6B,EAC7B,YAAY,GACb,MAAM,sBAAsB,CAAA;AAC7B,OAAO,EAAE,sBAAsB,EAAE,MAAM,qCAAqC,CAAA;AAC5E,OAAO,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAA;AAC1D,OAAO,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAA;AAErD,MAAM,OAAO,2BAA2B;IACtC,MAAM,CAAQ;IACL,QAAQ,CAAkC;IAC1C,UAAU,GAAG,iBAAiB,CAAA;IACvC,MAAM,CAAC,UAAU,GAAG,iBAAiB,CAAA;IAErC,YAAY,kBAA4C,EAAE;QACxD,MAAM,OAAO,GAAG,YAAY,CAAC,eAAe,CAAC,CAAA;QAC7C,IAAI,CAAC,MAAM,GAAG,QAAQ,IAAI,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,YAAY,CAAC,OAAO,CAAC,CAAA;QAC1E,IAAI,CAAC,QAAQ,GAAG,6BAA6B,CAAC,OAAO,CAAC,CAAA;IACxD,CAAC;IAED,MAAM,CAAC,UAAU,CACf,MAA2C,EAC3C,UAAqD,EAAE;QAEvD,MAAM,kBAAkB,GAAG,EAAE,GAAG,OAAO,EAAE,MAAM,EAAE,CAAA;QACjD,IAAI,CAAC,2BAA2B,CAAC,kBAAkB,CAAC,EAAE,CAAC;YACrD,MAAM,IAAI,2BAA2B,CAAC,gBAAgB,CAAC,CAAA;QACzD,CAAC;QACD,OAAO,IAAI,2BAA2B,CAAC,kBAAkB,CAAC,CAAA;IAC5D,CAAC;IAED,MAAM,CAAC,UAAU,CACf,MAA2C,EAC3C,UAAqD,EAAE;QAEvD,MAAM,kBAAkB,GAAG,EAAE,GAAG,OAAO,EAAE,MAAM,EAAE,CAAA;QACjD,IAAI,CAAC,2BAA2B,CAAC,kBAAkB,CAAC,EAAE,CAAC;YACrD,MAAM,IAAI,2BAA2B,CAAC,gBAAgB,CAAC,CAAA;QACzD,CAAC;QACD,OAAO,IAAI,2BAA2B,CAAC,kBAAkB,CAAC,CAAA;IAC5D,CAAC;IAED,MAAM,CAAC,sBAAsB,CAC3B,kBAA+E,EAC/E,UAGI,EAAE;QAEN,MAAM,kBAAkB,GAAG,EAAE,GAAG,OAAO,EAAE,kBAAkB,EAAE,CAAA;QAC7D,IAAI,CAAC,uCAAuC,CAAC,kBAAkB,CAAC,EAAE,CAAC;YACjE,MAAM,IAAI,2BAA2B,CAAC,4BAA4B,CAAC,CAAA;QACrE,CAAC;QACD,OAAO,IAAI,2BAA2B,CAAC,kBAAkB,CAAC,CAAA;IAC5D,CAAC;IAED,MAAM,CAAC,KAAK,CAAC,kBAAkB,CAC7B,cAAsB,EACtB,iBAAyB,EACzB,UAA6C,EAAE;QAE/C,+BAA+B,CAAC,iBAAiB,CAAC,CAAA;QAClD,MAAM,aAAa,GAAG,YAAY,CAAC,EAAE,GAAG,OAAO,EAAE,cAAc,EAAE,CAAC,CAAA;QAClE,IAAI,2BAA2B,CAAC,aAAa,CAAC,EAAE,CAAC;YAC/C,MAAM,IAAI,2BAA2B,CACnC,sFAAsF,CACvF,CAAA;QACH,CAAC;QACD,MAAM,MAAM,GAAG,YAAY,CAAC,aAAa,CAAC,CAAA;QAC1C,MAAM,cAAc,GAAG,sBAAsB,CAAC,UAAU,CAAC,MAAM,CAAC,CAAA;QAChE,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,cAAc,CAAC,WAAW,CAAC;YACjD,mBAAmB,EAAE,iBAAiB;SACvC,CAAC,CAAA;QACF,OAAO,2BAA2B,CAAC,sBAAsB,CAAC,KAAK,EAAE,OAAO,CAAC,CAAA;IAC3E,CAAC;IAED,MAAM,CAAC,uBAAuB,CAC5B,mBAAkF,EAClF,WAAkE,EAClE,UAGI,EAAE;QAEN,MAAM,kBAAkB,GAAG,EAAE,GAAG,OAAO,EAAE,mBAAmB,EAAE,WAAW,EAAE,CAAA;QAC3E,IAAI,CAAC,wCAAwC,CAAC,kBAAkB,CAAC,EAAE,CAAC;YAClE,MAAM,IAAI,2BAA2B,CACnC,4CAA4C,CAC7C,CAAA;QACH,CAAC;QACD,OAAO,IAAI,2BAA2B,CAAC,kBAAkB,CAAC,CAAA;IAC5D,CAAC;IAED,MAAM,CAAC,uBAAuB,CAC5B,mBAAkF,EAClF,WAAkE,EAClE,UAGI,EAAE;QAEN,MAAM,kBAAkB,GAAG,EAAE,GAAG,OAAO,EAAE,mBAAmB,EAAE,WAAW,EAAE,CAAA;QAC3E,IAAI,CAAC,wCAAwC,CAAC,kBAAkB,CAAC,EAAE,CAAC;YAClE,MAAM,IAAI,2BAA2B,CACnC,4CAA4C,CAC7C,CAAA;QACH,CAAC;QACD,OAAO,IAAI,2BAA2B,CAAC,kBAAkB,CAAC,CAAA;IAC5D,CAAC;IAED,eAAe,CACb,OAAiD;QAEjD,OAAO,IAAI,aAAa,CAA0B,IAAI,EAAE,OAAO,CAAC,CAAA;IAClE,CAAC;IAED,KAAK,CAAC,wBAAwB,CAC5B,kBAA+E;QAE/E,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAA;QACxC,MAAM,WAAW,GAAG,mCAAmC,CAAC;YACtD,kBAAkB;SACnB,CAAC,CAAA;QACF,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC;YAC3C,IAAI,OAAO,CAAC,GAAG,CAAC,IAAI,IAAI,EAAE,CAAC;gBACzB,MAAM,IAAI,KAAK,CACb,qFAAqF,CACtF,CAAA;YACH,CAAC;QACH,CAAC;QACD,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,GAAG,EAAE,GAAG,OAAO,EAAE,GAAG,WAAW,EAAE,CAAA;QAC7D,MAAM,cAAc,GAAG,sBAAsB,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;QACrE,MAAM,cAAc,CAAC,GAAG,EAAE,CAAA;IAC5B,CAAC;IAED;;OAEG;IACH,gBAAgB,CACd,UAAyD,EACzD,UAAsD,EAAE;QAExD,OAAO,IAAI,eAAe,CAAC,IAAI,EAAE;YAC/B,QAAQ,EAAE,0CAA0C;YACpD,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,UAAU;YAChB,WAAW,EAAE,SAAS;YACtB,OAAO;SACR,CAAC,CAAA;IACJ,CAAC;IAED;;OAEG;IACH,kBAAkB,CAChB,UAA2D,EAC3D,UAAwD,EAAE;QAE1D,OAAO,IAAI,eAAe,CAAC,IAAI,EAAE;YAC/B,QAAQ,EAAE,2CAA2C;YACrD,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,UAAU;YAChB,WAAW,EAAE,SAAS;YACtB,OAAO;SACR,CAAC,CAAA;IACJ,CAAC"}