sailfork / t3code-github / .repos/ alchemy-effect/ packages/ aws/ src/ Personalize/ PutEvents.ts

import type * as personalizeevents from "@distilled.cloud/aws/personalize-events";
import * as Binding from "alchemy/Binding";
import type * as Effect from "effect/Effect";
import type { EventTracker } from "./EventTracker.ts";

/**
 * `PutEvents` request with `trackingId` injected from the bound tracker.
 */
export interface PutEventsRequest extends Omit<personalizeevents.PutEventsRequest, "trackingId"> {}

/**
 * Runtime binding for `personalize:PutEvents`, scoped to one {@link EventTracker} —
 * Records item-interaction events (clicks, views, purchases, …) in real
 * time through the bound {@link EventTracker}. Events stream into the
 * dataset group's Interactions dataset and are used by recommenders as
 * they happen.
 * Provide the implementation with
 * `Effect.provide(AWS.Personalize.PutEventsHttp)`.
 *
 * ### Streaming Events
 * **Example:** Record a Click Event
 * ```typescript
 * // init
 * const putEvents = yield* Personalize.PutEvents(tracker);
 *
 * yield* putEvents({
 *   sessionId: "session-1",
 *   userId: "user-1",
 *   eventList: [{ eventType: "click", itemId: "item-42", sentAt: new Date() }],
 * });
 * ```
 *
 * @binding
 */
export interface PutEvents extends Binding.Service<
  PutEvents,
  "AWS.Personalize.PutEvents",
  (
    tracker: EventTracker,
  ) => Effect.Effect<
    (
      request: PutEventsRequest,
    ) => Effect.Effect<personalizeevents.PutEventsResponse, personalizeevents.PutEventsError>
  >
> {}
export const PutEvents = Binding.Service<PutEvents>("AWS.Personalize.PutEvents");