sailfork / t3code-github / .repos/ alchemy-effect/ packages/ aws/ src/ IoTSiteWise/ GetInterpolatedAssetPropertyValues.ts

import type * as sitewise from "@distilled.cloud/aws/iotsitewise";
import * as Binding from "alchemy/Binding";
import type * as Effect from "effect/Effect";
import type { Asset } from "./Asset.ts";

/**
 * Request for {@link GetInterpolatedAssetPropertyValues}. The bound asset's
 * id is injected automatically.
 *
 * The `startTimeInSeconds` / `endTimeInSeconds` / `intervalInSeconds`
 * fields keep their wire names: they are epoch timestamps and an interval
 * that are part of this operation's request shape, passed through verbatim.
 */
export interface GetInterpolatedAssetPropertyValuesRequest extends Omit<
  sitewise.GetInterpolatedAssetPropertyValuesRequest,
  "assetId"
> {}

/**
 * Runtime binding for `iotsitewise:GetInterpolatedAssetPropertyValues` —
 * compute interpolated values (`LINEAR_INTERPOLATION` or
 * `LOCF_INTERPOLATION`) of one property of the bound asset at a fixed
 * interval from a deployed Lambda or Task.
 *
 * ### Reading Interpolated Values
 * Provide the `GetInterpolatedAssetPropertyValuesHttp` implementation layer
 * on the Function effect, bind the asset in the init phase, then call the
 * returned client at runtime.
 *
 * **Example:** Interpolate at 1-Minute Intervals
 * ```typescript
 * // init
 * const getInterpolated =
 *   yield* AWS.IoTSiteWise.GetInterpolatedAssetPropertyValues(asset);
 *
 * // runtime
 * const now = yield* Effect.sync(() => Math.floor(Date.now() / 1000));
 * const { interpolatedAssetPropertyValues } = yield* getInterpolated({
 *   propertyId,
 *   startTimeInSeconds: now - 3600,
 *   endTimeInSeconds: now,
 *   intervalInSeconds: 60,
 *   quality: "GOOD",
 *   type: "LINEAR_INTERPOLATION",
 * });
 * // on the Function effect:
 * // .pipe(Effect.provide(AWS.IoTSiteWise.GetInterpolatedAssetPropertyValuesHttp))
 * ```
 *
 * @binding
 */
export interface GetInterpolatedAssetPropertyValues extends Binding.Service<
  GetInterpolatedAssetPropertyValues,
  "AWS.IoTSiteWise.GetInterpolatedAssetPropertyValues",
  (
    asset: Asset,
  ) => Effect.Effect<
    (
      request: GetInterpolatedAssetPropertyValuesRequest,
    ) => Effect.Effect<
      sitewise.GetInterpolatedAssetPropertyValuesResponse,
      sitewise.GetInterpolatedAssetPropertyValuesError
    >
  >
> {}
export const GetInterpolatedAssetPropertyValues =
  Binding.Service<GetInterpolatedAssetPropertyValues>(
    "AWS.IoTSiteWise.GetInterpolatedAssetPropertyValues",
  );