sailfork / t3code-github / .repos/ alchemy-effect/ packages/ aws/ src/ Location/ GetDevicePositionHistory.ts

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

/**
 * `GetDevicePositionHistory` request with `TrackerName` injected from the bound
 * resource.
 */
export interface GetDevicePositionHistoryRequest extends Omit<
  location.GetDevicePositionHistoryRequest,
  "TrackerName"
> {}

/**
 * Retrieves the position history of a device from the tracker (positions are retained for 30 days).
 *
 * Runtime binding for the `GetDevicePositionHistory` operation (IAM action
 * `geo:GetDevicePositionHistory`), scoped to one {@link Tracker}. Provide the implementation with
 * `Effect.provide(AWS.Location.GetDevicePositionHistoryHttp)`.
 *
 * ### Reading Device Positions
 * **Example:** Read a Device's Position History
 * ```typescript
 * const getHistory = yield* Location.GetDevicePositionHistory(tracker);
 *
 * const history = yield* getHistory({ DeviceId: "vehicle-1" });
 * // history.DevicePositions → chronological position samples
 * ```
 *
 * @binding
 */
export interface GetDevicePositionHistory extends Binding.Service<
  GetDevicePositionHistory,
  "AWS.Location.GetDevicePositionHistory",
  (
    tracker: Tracker,
  ) => Effect.Effect<
    (
      request: GetDevicePositionHistoryRequest,
    ) => Effect.Effect<
      location.GetDevicePositionHistoryResponse,
      location.GetDevicePositionHistoryError
    >
  >
> {}
export const GetDevicePositionHistory = Binding.Service<GetDevicePositionHistory>(
  "AWS.Location.GetDevicePositionHistory",
);