Platform API

/**
 * PlatformAPI - generated by OmniStream from Platform 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/ably";

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

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

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

  /** Enumerate all active channels of the application */
  getMetadataOfAllChannels(params: { "X-Ably-Version"?: string; "format"?: string; "limit"?: number; "prefix"?: string; "by"?: string }): Promise<any> {
    return this._request("GET", "/channels", { params });
  }

  /** Get metadata of a channel */
  getMetadataOfChannel(params: { "channel_id": string; "X-Ably-Version"?: string; "format"?: string }): Promise<any> {
    return this._request("GET", "/channels/{channel_id}", { params });
  }

  /** Get message history for a channel */
  getMessagesByChannel(params: { "channel_id": string; "X-Ably-Version"?: string; "format"?: string; "start"?: string; "limit"?: number; "end"?: string; "direction"?: string }): Promise<any> {
    return this._request("GET", "/channels/{channel_id}/messages", { params });
  }

  /** Publish a message to a channel */
  publishMessagesToChannel(body: unknown, params: { "channel_id": string; "X-Ably-Version"?: string; "format"?: string }): Promise<any> {
    return this._request("POST", "/channels/{channel_id}/messages", { body, params });
  }

  /** Get presence of a channel */
  getPresenceOfChannel(params: { "channel_id": string; "X-Ably-Version"?: string; "format"?: string; "clientId"?: string; "connectionId"?: string; "limit"?: number }): Promise<any> {
    return this._request("GET", "/channels/{channel_id}/presence", { params });
  }

  /** Get presence history of a channel */
  getPresenceHistoryOfChannel(params: { "channel_id": string; "X-Ably-Version"?: string; "format"?: string; "start"?: string; "limit"?: number; "end"?: string; "direction"?: string }): Promise<any> {
    return this._request("GET", "/channels/{channel_id}/presence/history", { params });
  }

  /** Request an access token */
  requestAccessToken(body: unknown, params: { "keyName": string; "X-Ably-Version"?: string; "format"?: string }): Promise<any> {
    return this._request("POST", "/keys/{keyName}/requestToken", { body, params });
  }

  /** List channel subscriptions */
  getPushSubscriptionsOnChannels(params: { "X-Ably-Version"?: string; "format"?: string; "channel"?: string; "deviceId"?: string; "clientId"?: string; "limit"?: number }): Promise<any> {
    return this._request("GET", "/push/channelSubscriptions", { params });
  }

  /** Subscribe a device to a channel */
  subscribePushDeviceToChannel(body: unknown, params: { "X-Ably-Version"?: string; "format"?: string }): Promise<any> {
    return this._request("POST", "/push/channelSubscriptions", { body, params });
  }

  /** Delete a registered device's update token */
  deletePushDeviceDetails(params: { "X-Ably-Version"?: string; "format"?: string; "channel"?: string; "deviceId"?: string; "clientId"?: string }): Promise<any> {
    return this._request("DELETE", "/push/channelSubscriptions", { params });
  }

  /** List all channels with at least one subscribed device */
  getChannelsWithPushSubscribers(params: { "X-Ably-Version"?: string; "format"?: string }): Promise<any> {
    return this._request("GET", "/push/channels", { params });
  }

  /** List devices registered for receiving push notifications */
  getRegisteredPushDevices(params: { "X-Ably-Version"?: string; "format"?: string; "deviceId"?: string; "clientId"?: string; "limit"?: number }): Promise<any> {
    return this._request("GET", "/push/deviceRegistrations", { params });
  }

  /** Register a device for receiving push notifications */
  registerPushDevice(body: unknown, params: { "X-Ably-Version"?: string; "format"?: string }): Promise<any> {
    return this._request("POST", "/push/deviceRegistrations", { body, params });
  }

  /** Unregister matching devices for push notifications */
  unregisterAllPushDevices(params: { "X-Ably-Version"?: string; "format"?: string; "deviceId"?: string; "clientId"?: string }): Promise<any> {
    return this._request("DELETE", "/push/deviceRegistrations", { params });
  }

  /** Get a device registration */
  getPushDeviceDetails(params: { "device_id": string; "X-Ably-Version"?: string; "format"?: string }): Promise<any> {
    return this._request("GET", "/push/deviceRegistrations/{device_id}", { params });
  }

  /** Update a device registration */
  putPushDeviceDetails(body: unknown, params: { "device_id": string; "X-Ably-Version"?: string; "format"?: string }): Promise<any> {
    return this._request("PUT", "/push/deviceRegistrations/{device_id}", { body, params });
  }

  /** Update a device registration */
  patchPushDeviceDetails(body: unknown, params: { "device_id": string; "X-Ably-Version"?: string; "format"?: string }): Promise<any> {
    return this._request("PATCH", "/push/deviceRegistrations/{device_id}", { body, params });
  }

  /** Unregister a single device for push notifications */
  unregisterPushDevice(params: { "device_id": string; "X-Ably-Version"?: string; "format"?: string }): Promise<any> {
    return this._request("DELETE", "/push/deviceRegistrations/{device_id}", { params });
  }

  /** Reset a registered device's update token */
  updatePushDeviceDetails(params: { "device_id": string; "X-Ably-Version"?: string; "format"?: string }): Promise<any> {
    return this._request("GET", "/push/deviceRegistrations/{device_id}/resetUpdateToken", { params });
  }

  /** Publish a push notification to device(s) */
  publishPushNotificationToDevices(body: unknown, params: { "X-Ably-Version"?: string; "format"?: string }): Promise<any> {
    return this._request("POST", "/push/publish", { body, params });
  }

  /** Retrieve usage statistics for an application */
  getStats(params: { "X-Ably-Version"?: string; "format"?: string; "start"?: string; "limit"?: number; "end"?: string; "direction"?: string; "unit"?: string }): Promise<any> {
    return this._request("GET", "/stats", { params });
  }

  /** Get the service time */
  getTime(params: { "X-Ably-Version"?: string; "format"?: string }): Promise<any> {
    return this._request("GET", "/time", { params });
  }
}

export default PlatformAPI;