Qualtrics API

/**
 * QualtricsAPI - generated by OmniStream from Qualtrics API's OpenAPI spec.
 * One typed method per endpoint. A single Omni key reaches the API.
 */
const DEFAULT_BASE = "https://grid.skinvaults.online/v1/proxy/qualtrics";

export class QualtricsAPIError extends Error {
  status: number;
  code?: string;
  constructor(status: number, code: string | undefined, message?: string) {
    super(message || `QualtricsAPI error ${status}`);
    this.name = "QualtricsAPIError";
    this.status = status;
    this.code = code;
  }
}

export interface QualtricsAPIOptions {
  baseUrl?: string;
  fetch?: typeof fetch;
  timeoutMs?: number;
}

export class QualtricsAPI {
  /** @param token Your OmniStream key (one key for every API). */
  constructor(private token: string, private opts: QualtricsAPIOptions = {}) {
    if (!token) throw new Error("QualtricsAPI: token is required");
  }
  rateLimit: { remainingMinute?: number; remainingDay?: number } | null = null;

  private async _request(method: string, path: string, { params, body }: { params?: Record<string, unknown>; body?: unknown } = {}): Promise<any> {
    const f = this.opts.fetch ?? globalThis.fetch;
    const url = new URL((this.opts.baseUrl ?? DEFAULT_BASE).replace(/\/+$/, "") + path);
    if (params) for (const [k, v] of Object.entries(params)) if (v != null) url.searchParams.set(k, String(v));
    const headers: Record<string, string> = { "x-omni-key": this.token };
    if (body !== undefined) headers["content-type"] = "application/json";
    const res = await f(url, { method, headers, body: body !== undefined ? JSON.stringify(body) : undefined });
    this.rateLimit = {
      remainingMinute: Number(res.headers.get("x-ratelimit-remaining-minute")) || undefined,
      remainingDay: Number(res.headers.get("x-ratelimit-remaining-day")) || undefined,
    };
    const data = await res.json().catch(() => ({}));
    if (!res.ok) throw new QualtricsAPIError(res.status, data?.error?.code, data?.error?.message);
    return data.data ?? data;
  }

  /** Create contact in mailing list */
  createContactInMailinglist(body: unknown, params: { "DirectoryId": string; "MailingListId": string }): Promise<any> {
    return this._request("POST", "/directories/{DirectoryId}/mailinglists/{MailingListId}/contacts", { body, params });
  }

  /** Get distributions for survey */
  getDistributions(params: { "surveyId": string }): Promise<any> {
    return this._request("GET", "/distributions", { params });
  }

  /** Generate distribution links */
  generateDistributionLinks(body: unknown): Promise<any> {
    return this._request("POST", "/distributions", { body });
  }

  /** Retrieve distribution links */
  retrievedistributionlinks(params: { "surveyId": string; "DistributionId": string }): Promise<any> {
    return this._request("GET", "/distributions/{DistributionId}/links", { params });
  }

  /** Triggers when a response is submitted to a qualtrics survey */
  whenAResponseIsReceived(): Promise<any> {
    return this._request("POST", "/eventsubscriptions/", {  });
  }

  /** Remove subscription to response event */
  webhookDelete(): Promise<any> {
    return this._request("DELETE", "/eventsubscriptions/", {});
  }

  /** Get event subscriptions */
  getEventSubscriptions(params: { "SubscriptionId": string }): Promise<any> {
    return this._request("GET", "/eventsubscriptions/{SubscriptionId}", { params });
  }

  /** Get survey */
  getSurvey(params: { "SurveyId": string }): Promise<any> {
    return this._request("GET", "/survey-definitions/{SurveyId}", { params });
  }
}

export default QualtricsAPI;