Type Reference

The package exports the client plus request and response types from the root module.

Exports

import {
  Noketa,
  type CreateProfileRequest,
  type CreateProfileResponse,
  type NoketaApiResponse,
  type ProfileAttributes,
  type SendEmailRequest,
  type SendEmailResponse,
} from "noketa";

ProfileAttributes

ProfileAttributes supports known optional fields and any additional custom keys:

• first_name?: string
• last_name?: string
• locale?: string
• gender?: string
• age?: number
• birthdate?: Date
• external_id?: string
• last_event_date?: Date
• properties?: Record<string, unknown>
• [key: string]: unknown

Shared API Response

Both CreateProfileResponse and SendEmailResponse are currently aliases of NoketaApiResponse:

type NoketaApiResponse = {
  message?: string;
  [key: string]: unknown;
};