Ex Libris APIs

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

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

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

export class ExLibrisAPIs {
  /** @param token Your OmniStream key (one key for every API). */
  constructor(private token: string, private opts: ExLibrisAPIsOptions = {}) {
    if (!token) throw new Error("ExLibrisAPIs: 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 ExLibrisAPIsError(res.status, data?.error?.code, data?.error?.message);
    return data.data ?? data;
  }

  /** Retrieve Printouts */
  getAlmawsV1TaskListsPrintouts(params: { "letter"?: string; "status"?: string; "printer_id"?: string; "printout_id"?: string; "limit"?: number; "offset"?: number }): Promise<any> {
    return this._request("GET", "/almaws/v1/task-lists/printouts", { params });
  }

  /** Act on Printouts */
  postAlmawsV1TaskListsPrintouts(params: { "op": string; "letter"?: string; "status"?: string; "printer_id"?: string; "printout_id"?: string }): Promise<any> {
    return this._request("POST", "/almaws/v1/task-lists/printouts", { params });
  }

  /** Retrieve a Printout */
  getAlmawsV1TaskListsPrintoutsPrintoutId(params: { "printout_id": string }): Promise<any> {
    return this._request("GET", "/almaws/v1/task-lists/printouts/{printout_id}", { params });
  }

  /** Printout Service */
  postAlmawsV1TaskListsPrintoutsPrintoutId(params: { "printout_id": string; "op": string }): Promise<any> {
    return this._request("POST", "/almaws/v1/task-lists/printouts/{printout_id}", { params });
  }

  /** Get Requested Resources */
  getAlmawsV1TaskListsRequestedResources(params: { "library": string; "circ_desk": string; "location"?: string; "order_by"?: string; "direction"?: string; "pickup_inst"?: string; "reported"?: string; "printed"?: string; "limit"?: number; "offset"?: number }): Promise<any> {
    return this._request("GET", "/almaws/v1/task-lists/requested-resources", { params });
  }

  /** Act on Requested Resources */
  postAlmawsV1TaskListsRequestedResources(params: { "library"?: string; "circ_desk"?: string; "op"?: string; "location"?: string; "pickup_inst"?: string; "reported"?: string; "printed"?: string }): Promise<any> {
    return this._request("POST", "/almaws/v1/task-lists/requested-resources", { params });
  }

  /** Get Lending Requests */
  getAlmawsV1TaskListsRsLendingRequests(params: { "library"?: string; "status"?: string; "printed"?: string; "reported"?: string; "partner"?: string; "requested_format"?: string; "supplied_format"?: string }): Promise<any> {
    return this._request("GET", "/almaws/v1/task-lists/rs/lending-requests", { params });
  }

  /** Act on Lending Requests */
  postAlmawsV1TaskListsRsLendingRequests(params: { "library"?: string; "op"?: string; "status"?: string; "printed"?: string; "reported"?: string; "partner"?: string; "requested_format"?: string; "supplied_format"?: string }): Promise<any> {
    return this._request("POST", "/almaws/v1/task-lists/rs/lending-requests", { params });
  }

  /** GET Task-lists Test API */
  getAlmawsV1TaskListsTest(): Promise<any> {
    return this._request("GET", "/almaws/v1/task-lists/test", {});
  }

  /** POST Task-lists Test API */
  postAlmawsV1TaskListsTest(): Promise<any> {
    return this._request("POST", "/almaws/v1/task-lists/test", {  });
  }
}

export default ExLibrisAPIs;