index.d.ts

export interface RevenueProperties {
  productId?: string;
  quantity?: number;
  price: number;
  revenueType?: string;
  receipt?: string;
  receiptSignature?: string;
  eventProperties?: {[key: string]: any},
}

export default class Amplitude {
  constructor(apiKey: string, trackSessionEvents?: boolean, eventPrefix?: string);

  // --------------------------------------------------
  // Identify
  // --------------------------------------------------
  setEventUploadThreshold(threshold: number): void;
  setUserId(userId: string | number | null): void;
  getUserId(): Promise<string | number | null>;
  setUserProperties(properties: Record<string, any>): void;
  setOptOut(optOut: boolean): void;
  clearUserProperties(): void;
  getSessionId(): Promise<number>;
  getDeviceId(): Promise<string>;
  setDeviceId(deviceId: string | number | null): void;
  regenerateDeviceId(): void;
  setLogEventPrefix(prefix: string): void;

  // --------------------------------------------------
  // Track
  // --------------------------------------------------

  logEvent(name: string, properties?: Record<string, any>): void;
  logEventWithTimestamp(name: string, timestamp: number, properties?: Record<string, any>): void;

  // --------------------------------------------------
  // Revenue
  // --------------------------------------------------
  logRevenue(productIdentifier: string, quantity: number, amount: number, receipt?: string): void;
  logRevenueV2(revenueProperties: RevenueProperties): void;
  addToUserProperty(property: string, amount: number): void;
  setUserPropertyOnce(property: string, value: string | number | null): void;
}