SIGNL4 API

/**
 * SIGNL4API - generated by OmniStream from SIGNL4 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/signl4";

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

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

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

  /** Trigger Alert */
  postalerts(body: unknown): Promise<any> {
    return this._request("POST", "/alerts", { body });
  }

  /** Confirms all visible alerts */
  postalertsAcknowledgeall(body: unknown, params: { "userId"?: string }): Promise<any> {
    return this._request("POST", "/alerts/acknowledgeAll", { body, params });
  }

  /** Acknowlegde multiple alerts */
  postalertsAcknowledgemultiple(body: unknown): Promise<any> {
    return this._request("POST", "/alerts/acknowledgeMultiple", { body });
  }

  /** Close all acknowledged alerts. */
  postalertsCloseall(body: unknown, params: { "userId"?: string }): Promise<any> {
    return this._request("POST", "/alerts/closeAll", { body, params });
  }

  /** Close multiple alerts */
  postalertsClosemultiple(body: unknown): Promise<any> {
    return this._request("POST", "/alerts/closeMultiple", { body });
  }

  /** Gets alerts paged */
  postalertsPaged(body: unknown, params: { "maxResults"?: number; "userId"?: string }): Promise<any> {
    return this._request("POST", "/alerts/paged", { body, params });
  }

  /** Get Alert Report */
  getalertsReport(params: { "userId"?: string }): Promise<any> {
    return this._request("GET", "/alerts/report", { params });
  }

  /** Queue undo of multiple acknowledgments. */
  postalertsUndoacknowledgemultiple(body: unknown): Promise<any> {
    return this._request("POST", "/alerts/undoAcknowledgeMultiple", { body });
  }

  /** Withdraw closure of multiple alerts */
  postalertsUndoclosemultiple(body: unknown): Promise<any> {
    return this._request("POST", "/alerts/undoCloseMultiple", { body });
  }

  /** Get Alert */
  getalertsAlertid(params: { "alertId": string }): Promise<any> {
    return this._request("GET", "/alerts/{alertId}", { params });
  }

  /** Acknowledge an alert */
  postalertsAlertidAcknowledge(body: unknown, params: { "alertId": string }): Promise<any> {
    return this._request("POST", "/alerts/{alertId}/acknowledge", { body, params });
  }

  /** Annotate Alert */
  postalertsAlertidAnnotate(body: unknown, params: { "alertId": string }): Promise<any> {
    return this._request("POST", "/alerts/{alertId}/annotate", { body, params });
  }

  /** Get annotations of an alert */
  getalertsAlertidAnnotations(params: { "alertId": string }): Promise<any> {
    return this._request("GET", "/alerts/{alertId}/annotations", { params });
  }

  /** Get attachments of an alert */
  getalertsAlertidAttachments(params: { "alertId": string }): Promise<any> {
    return this._request("GET", "/alerts/{alertId}/attachments", { params });
  }

  /** Gets a specified attachment of a specified alert. */
  getalertsAlertidAttachmentsAttachmentid(params: { "alertId": string; "attachmentId": string; "width"?: number; "height"?: number; "scale"?: boolean }): Promise<any> {
    return this._request("GET", "/alerts/{alertId}/attachments/{attachmentId}", { params });
  }

  /** Close an alert */
  postalertsAlertidClose(body: unknown, params: { "alertId": string }): Promise<any> {
    return this._request("POST", "/alerts/{alertId}/close", { body, params });
  }

  /** Get alert notifications */
  getalertsAlertidNotifications(params: { "alertId": string }): Promise<any> {
    return this._request("GET", "/alerts/{alertId}/notifications", { params });
  }

  /** Get an overview alert. */
  getalertsAlertidOverview(params: { "alertId": string }): Promise<any> {
    return this._request("GET", "/alerts/{alertId}/overview", { params });
  }

  /** Undo the acknowledgement of an alert. */
  postalertsAlertidUndoacknowledge(body: unknown, params: { "alertId": string }): Promise<any> {
    return this._request("POST", "/alerts/{alertId}/undoAcknowledge", { body, params });
  }

  /** Undo the closure of an alert. */
  postalertsAlertidUndoclose(body: unknown, params: { "alertId": string }): Promise<any> {
    return this._request("POST", "/alerts/{alertId}/undoClose", { body, params });
  }

  /** Gets the names of all alert category images.
You can get the image by going to account.signl4.com/images/alerts/categoryImageName.svg */
  getcategoriesImages(): Promise<any> {
    return this._request("GET", "/categories/images", {});
  }

  /** Get all categories */
  getcategoriesTeamid(params: { "teamId": string }): Promise<any> {
    return this._request("GET", "/categories/{teamId}", { params });
  }

  /** Create a new category */
  postcategoriesTeamid(body: unknown, params: { "teamId": string }): Promise<any> {
    return this._request("POST", "/categories/{teamId}", { body, params });
  }

  /** Get metrics for all categories */
  getcategoriesTeamidMetrics(params: { "teamId": string }): Promise<any> {
    return this._request("GET", "/categories/{teamId}/metrics", { params });
  }

  /** Get a specific category */
  getcategoriesTeamidCategoryid(params: { "teamId": string; "categoryId": string }): Promise<any> {
    return this._request("GET", "/categories/{teamId}/{categoryId}", { params });
  }

  /** Update an existing category */
  putcategoriesTeamidCategoryid(body: unknown, params: { "teamId": string; "categoryId": string }): Promise<any> {
    return this._request("PUT", "/categories/{teamId}/{categoryId}", { body, params });
  }

  /** Delete an existing category */
  deletecategoriesTeamidCategoryid(params: { "teamId": string; "categoryId": string }): Promise<any> {
    return this._request("DELETE", "/categories/{teamId}/{categoryId}", { params });
  }

  /** Get metrics for a specific category */
  getcategoriesTeamidCategoryidMetrics(params: { "teamId": string; "categoryId": string }): Promise<any> {
    return this._request("GET", "/categories/{teamId}/{categoryId}/metrics", { params });
  }

  /** Get category subscriptions */
  getcategoriesTeamidCategoryidSubscriptions(params: { "teamId": string; "categoryId": string }): Promise<any> {
    return this._request("GET", "/categories/{teamId}/{categoryId}/subscriptions", { params });
  }

  /** Set category subscriptions */
  postcategoriesTeamidCategoryidSubscriptions(body: unknown, params: { "teamId": string; "categoryId": string }): Promise<any> {
    return this._request("POST", "/categories/{teamId}/{categoryId}/subscriptions", { body, params });
  }

  /** Get overview event paged. */
  posteventsPaged(body: unknown, params: { "maxResults"?: number }): Promise<any> {
    return this._request("POST", "/events/paged", { body, params });
  }

  /** Get overview event */
  geteventsEventidOverview(params: { "eventId": string }): Promise<any> {
    return this._request("GET", "/events/{eventId}/overview", { params });
  }

  /** Get event parameters */
  geteventsEventidParameters(params: { "eventId": string }): Promise<any> {
    return this._request("GET", "/events/{eventId}/parameters", { params });
  }

  /** Get your subscription's current prepaid balance. */
  getprepaidBalance(): Promise<any> {
    return this._request("GET", "/prepaid/balance", {});
  }

  /** Get your subscription's current prepaid settings. */
  getprepaidSettings(): Promise<any> {
    return this._request("GET", "/prepaid/settings", {});
  }

  /** Update your subscription's current prepaid settings. */
  putprepaidSettings(body: unknown): Promise<any> {
    return this._request("PUT", "/prepaid/settings", { body });
  }

  /** Get your subscription's prepaid transactions. */
  getprepaidTransactions(): Promise<any> {
    return this._request("GET", "/prepaid/transactions", {});
  }

  /** Returns all script instances of the SIGNL4 team */
  getscriptsInstances(params: { "teamId"?: string }): Promise<any> {
    return this._request("GET", "/scripts/instances", { params });
  }

  /** Creates a new script instance in the in the SIGNL4 team. */
  postscriptsInstances(body: unknown): Promise<any> {
    return this._request("POST", "/scripts/instances", { body });
  }

  /** Returns all information about a given script instance which includes its runtime status. */
  getscriptsInstancesInstanceid(params: { "instanceId": string }): Promise<any> {
    return this._request("GET", "/scripts/instances/{instanceId}", { params });
  }

  /** Updates a given script instance, typically used for updating the configuration of a script. */
  putscriptsInstancesInstanceid(body: unknown, params: { "instanceId": string }): Promise<any> {
    return this._request("PUT", "/scripts/instances/{instanceId}", { body, params });
  }

  /** Deletes a script instance. */
  deletescriptsInstancesInstanceid(params: { "instanceId": string }): Promise<any> {
    return this._request("DELETE", "/scripts/instances/{instanceId}", { params });
  }

  /** Updates custom data of a given script instance which includes its display name. */
  putscriptsInstancesInstanceidData(body: unknown, params: { "instanceId": string }): Promise<any> {
    return this._request("PUT", "/scripts/instances/{instanceId}/data", { body, params });
  }

  /** Disables a given script instance. */
  postscriptsInstancesInstanceidDisable(params: { "instanceId": string }): Promise<any> {
    return this._request("POST", "/scripts/instances/{instanceId}/disable", { params });
  }

  /** Enables a script instance. */
  postscriptsInstancesInstanceidEnable(params: { "instanceId": string }): Promise<any> {
    return this._request("POST", "/scripts/instances/{instanceId}/enable", { params });
  }

  /** Returns all available inventory scripts which can be added to a SIGNL4 subscription. */
  getscriptsInventory(): Promise<any> {
    return this._request("GET", "/scripts/inventory", {});
  }

  /** Returns all inventory scripts. */
  getscriptsInventoryParsed(params: { "language"?: string }): Promise<any> {
    return this._request("GET", "/scripts/inventory/parsed", { params });
  }

  /** Returns an inventory script by its id. */
  getscriptsInventoryParsedScriptid(params: { "scriptId": string; "language"?: string }): Promise<any> {
    return this._request("GET", "/scripts/inventory/parsed/{scriptId}", { params });
  }

  /** Get infos of all available/managed subscriptions. */
  getsubscriptions(): Promise<any> {
    return this._request("GET", "/subscriptions", {});
  }

  /** Get infos of a specific subscription. */
  getsubscriptionsSubscriptionid(params: { "subscriptionId": string }): Promise<any> {
    return this._request("GET", "/subscriptions/{subscriptionId}", { params });
  }

  /** Returns the subscription's channel price information. */
  getsubscriptionsSubscriptionidChannelprices(params: { "subscriptionId": string }): Promise<any> {
    return this._request("GET", "/subscriptions/{subscriptionId}/channelPrices", { params });
  }

  /** Returns the features of a specified subscription. */
  getsubscriptionsSubscriptionidFeatures(params: { "subscriptionId": string }): Promise<any> {
    return this._request("GET", "/subscriptions/{subscriptionId}/features", { params });
  }

  /** Get a subscription's current prepaid balance. */
  getsubscriptionsSubscriptionidPrepaidbalance(params: { "subscriptionId": string }): Promise<any> {
    return this._request("GET", "/subscriptions/{subscriptionId}/prepaidBalance", { params });
  }

  /** Get a subscription's current prepaid settings. */
  getsubscriptionsSubscriptionidPrepaidsettings(params: { "subscriptionId": string }): Promise<any> {
    return this._request("GET", "/subscriptions/{subscriptionId}/prepaidSettings", { params });
  }

  /** Update a subscription's current prepaid settings. */
  putsubscriptionsSubscriptionidPrepaidsettings(body: unknown, params: { "subscriptionId": string }): Promise<any> {
    return this._request("PUT", "/subscriptions/{subscriptionId}/prepaidSettings", { body, params });
  }

  /** Get a subscription's prepaid transactions. */
  getsubscriptionsSubscriptionidPrepaidtransactions(params: { "subscriptionId": string }): Promise<any> {
    return this._request("GET", "/subscriptions/{subscriptionId}/prepaidTransactions", { params });
  }

  /** Updates a subscriptions profile. */
  putsubscriptionsSubscriptionidProfile(body: unknown, params: { "subscriptionId": string }): Promise<any> {
    return this._request("PUT", "/subscriptions/{subscriptionId}/profile", { body, params });
  }

  /** Get infos for all teams of the subscription. */
  getsubscriptionsSubscriptionidTeams(params: { "subscriptionId": string }): Promise<any> {
    return this._request("GET", "/subscriptions/{subscriptionId}/teams", { params });
  }

  /** Gets a subscription's user licenses. */
  getsubscriptionsSubscriptionidUserlicenses(params: { "subscriptionId": string }): Promise<any> {
    return this._request("GET", "/subscriptions/{subscriptionId}/userLicenses", { params });
  }

  /** Get infos of all teams. */
  getteams(): Promise<any> {
    return this._request("GET", "/teams", {});
  }

  /** Gets infos of a specific team. */
  getteamsTeamid(params: { "teamId": string }): Promise<any> {
    return this._request("GET", "/teams/{teamId}", { params });
  }

  /** Get information about downloadable alert reports */
  getteamsTeamidAlertreports(params: { "teamId": string }): Promise<any> {
    return this._request("GET", "/teams/{teamId}/alertReports", { params });
  }

  /** Returns Alert Report */
  getteamsTeamidAlertreportsFilename(params: { "teamId": string; "fileName": string }): Promise<any> {
    return this._request("GET", "/teams/{teamId}/alertReports/{fileName}", { params });
  }

  /** Gets alert settings of a specific team. */
  getteamsTeamidAlertsettings(params: { "teamId": string }): Promise<any> {
    return this._request("GET", "/teams/{teamId}/alertSettings", { params });
  }

  /** Sets alert settings of a specific team. */
  postteamsTeamidAlertsettings(body: unknown, params: { "teamId": string }): Promise<any> {
    return this._request("POST", "/teams/{teamId}/alertSettings", { body, params });
  }

  /** Get Information about downloadable reports */
  getteamsTeamidDutyreports(params: { "teamId": string }): Promise<any> {
    return this._request("GET", "/teams/{teamId}/dutyReports", { params });
  }

  /** Download duty report with a specific fileName */
  getteamsTeamidDutyreportsFilename(params: { "teamId": string; "fileName": string }): Promise<any> {
    return this._request("GET", "/teams/{teamId}/dutyReports/{fileName}", { params });
  }

  /** Get duty assistant info for a team */
  getteamsTeamidDutysummary(params: { "teamId": string; "lastTwoDuties"?: boolean }): Promise<any> {
    return this._request("GET", "/teams/{teamId}/dutysummary", { params });
  }

  /** Gets event sources of a specific team. */
  getteamsTeamidEventsources(params: { "teamId": string }): Promise<any> {
    return this._request("GET", "/teams/{teamId}/eventSources", { params });
  }

  /** Get all invites of a team. */
  getteamsTeamidMemberships(params: { "teamId": string }): Promise<any> {
    return this._request("GET", "/teams/{teamId}/memberships", { params });
  }

  /** Invite users to a team */
  postteamsTeamidMemberships(body: unknown, params: { "teamId": string }): Promise<any> {
    return this._request("POST", "/teams/{teamId}/memberships", { body, params });
  }

  /** Sends invite email again if an invite exists */
  postteamsTeamidMembershipsResendinvitemail(body: unknown, params: { "teamId": string }): Promise<any> {
    return this._request("POST", "/teams/{teamId}/memberships/resendInviteMail", { body, params });
  }

  /** Update user's team membership. */
  putteamsTeamidMembershipsUserid(body: unknown, params: { "teamId": string; "userId": string; "requesterUserId"?: string }): Promise<any> {
    return this._request("PUT", "/teams/{teamId}/memberships/{userId}", { body, params });
  }

  /** Removes a user or invitation from a team, and may delete the user if he is not in any team. */
  deleteteamsTeamidMembershipsUserid(params: { "teamId": string; "userId": string; "requesterUserId"?: string }): Promise<any> {
    return this._request("DELETE", "/teams/{teamId}/memberships/{userId}", { params });
  }

  /** Updates team profile of a team */
  putteamsTeamidProfile(body: unknown, params: { "teamId": string }): Promise<any> {
    return this._request("PUT", "/teams/{teamId}/profile", { body, params });
  }

  /** Returns information about all duties that belong to the team. */
  getteamsTeamidSchedules(params: { "teamId": string; "UserId"?: string; "MinDate"?: string; "Limit"?: number }): Promise<any> {
    return this._request("GET", "/teams/{teamId}/schedules", { params });
  }

  /** Create/Update given duty schedule. */
  postteamsTeamidSchedules(body: unknown, params: { "teamId": string }): Promise<any> {
    return this._request("POST", "/teams/{teamId}/schedules", { body, params });
  }

  /** Delete duty schedules in range */
  postteamsTeamidSchedulesDeleterange(body: unknown, params: { "teamId": string }): Promise<any> {
    return this._request("POST", "/teams/{teamId}/schedules/deleteRange", { body, params });
  }

  /** Save multiple schedules. It is possible to override existing schedules if you wish */
  postteamsTeamidSchedulesMultiple(body: unknown, params: { "teamId": string; "overrideExisting"?: boolean }): Promise<any> {
    return this._request("POST", "/teams/{teamId}/schedules/multiple", { body, params });
  }

  /** Delete a specific duty. */
  deleteteamsTeamidSchedulesDutyid(params: { "teamId": string; "dutyId": string }): Promise<any> {
    return this._request("DELETE", "/teams/{teamId}/schedules/{dutyId}", { params });
  }

  /** Returns information of the duty schedule with the specified Id. */
  getteamsTeamidSchedulesScheduleid(params: { "teamId": string; "scheduleId": string }): Promise<any> {
    return this._request("GET", "/teams/{teamId}/schedules/{scheduleId}", { params });
  }

  /** Gets setup progress of a specific team. */
  getteamsTeamidSetupprogress(params: { "teamId": string }): Promise<any> {
    return this._request("GET", "/teams/{teamId}/setupProgress", { params });
  }

  /** Get all Users */
  getusers(): Promise<any> {
    return this._request("GET", "/users", {});
  }

  /** Get User by Id */
  getusersUserid(params: { "userId": string }): Promise<any> {
    return this._request("GET", "/users/{userId}", { params });
  }

  /** Updates the password of a user */
  putusersUseridChangepassword(body: unknown, params: { "userId": string }): Promise<any> {
    return this._request("PUT", "/users/{userId}/changePassword", { body, params });
  }

  /** Checks if a user has the provided permission. */
  postusersUseridCheckpermissions(body: unknown, params: { "userId": string; "teamId"?: string }): Promise<any> {
    return this._request("POST", "/users/{userId}/checkPermissions", { body, params });
  }

  /** Get duty status by user Id */
  getusersUseridDutystatus(params: { "userId": string }): Promise<any> {
    return this._request("GET", "/users/{userId}/dutyStatus", { params });
  }

  getusersUseridImage(params: { "userId": string; "height"?: number; "width"?: number }): Promise<any> {
    return this._request("GET", "/users/{userId}/image", { params });
  }

  /** Uploaded a profile image for a specified user. */
  postusersUseridImage(params: { "userId": string }): Promise<any> {
    return this._request("POST", "/users/{userId}/image", { params });
  }

  /** Updates user profile of an user */
  putusersUseridProfile(body: unknown, params: { "userId": string }): Promise<any> {
    return this._request("PUT", "/users/{userId}/profile", { body, params });
  }

  /** Punch User in */
  postusersUseridPunchin(params: { "userId": string }): Promise<any> {
    return this._request("POST", "/users/{userId}/punchIn", { params });
  }

  /** Punch User in as Manager */
  postusersUseridPunchinasmanager(params: { "userId": string }): Promise<any> {
    return this._request("POST", "/users/{userId}/punchInAsManager", { params });
  }

  /** Punch User out */
  postusersUseridPunchout(params: { "userId": string }): Promise<any> {
    return this._request("POST", "/users/{userId}/punchOut", { params });
  }

  /** Gets setup progress of a specific user. */
  getusersUseridSetupprogress(params: { "userId": string }): Promise<any> {
    return this._request("GET", "/users/{userId}/setupProgress", { params });
  }

  /** Get Webhooks */
  getwebhooks(params: { "teamId"?: string }): Promise<any> {
    return this._request("GET", "/webhooks", { params });
  }

  /** Create Webhook */
  postwebhooks(body: unknown): Promise<any> {
    return this._request("POST", "/webhooks", { body });
  }

  /** Get Webhook by Id */
  getWebhookById(params: { "webhookId": string }): Promise<any> {
    return this._request("GET", "/webhooks/{webhookId}", { params });
  }

  /** Update Webhook by Id */
  putwebhooksWebhookid(body: unknown, params: { "webhookId": string }): Promise<any> {
    return this._request("PUT", "/webhooks/{webhookId}", { body, params });
  }

  /** Delete Webhook by Id */
  deletewebhooksWebhookid(params: { "webhookId": string }): Promise<any> {
    return this._request("DELETE", "/webhooks/{webhookId}", { params });
  }

  /** Ability to enable a webHook. */
  postwebhooksWebhookidDisable(params: { "webhookId": string }): Promise<any> {
    return this._request("POST", "/webhooks/{webhookId}/disable", { params });
  }

  /** Ability to disable a webHook. */
  postwebhooksWebhookidEnable(params: { "webhookId": string }): Promise<any> {
    return this._request("POST", "/webhooks/{webhookId}/enable", { params });
  }
}

export default SIGNL4API;