incidents.ts

// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.

import * as Core from '@mux/mux-node/core';
import { APIResource } from '@mux/mux-node/resource';
import { isRequestOptions } from '@mux/mux-node/core';
import * as IncidentsAPI from '@mux/mux-node/resources/data/incidents';
import { BasePage, type BasePageParams } from '@mux/mux-node/pagination';

export class Incidents extends APIResource {
  /**
   * Returns the details of an incident.
   */
  retrieve(incidentId: string, options?: Core.RequestOptions): Core.APIPromise<IncidentResponse> {
    return this._client.get(`/data/v1/incidents/${incidentId}`, options);
  }

  /**
   * Returns a list of incidents.
   */
  list(
    query?: IncidentListParams,
    options?: Core.RequestOptions,
  ): Core.PagePromise<IncidentsBasePage, Incident>;
  list(options?: Core.RequestOptions): Core.PagePromise<IncidentsBasePage, Incident>;
  list(
    query: IncidentListParams | Core.RequestOptions = {},
    options?: Core.RequestOptions,
  ): Core.PagePromise<IncidentsBasePage, Incident> {
    if (isRequestOptions(query)) {
      return this.list({}, query);
    }
    return this._client.getAPIList('/data/v1/incidents', IncidentsBasePage, { query, ...options });
  }

  /**
   * Returns all the incidents that seem related to a specific incident.
   */
  listRelated(
    incidentId: string,
    query?: IncidentListRelatedParams,
    options?: Core.RequestOptions,
  ): Core.PagePromise<IncidentsBasePage, Incident>;
  listRelated(
    incidentId: string,
    options?: Core.RequestOptions,
  ): Core.PagePromise<IncidentsBasePage, Incident>;
  listRelated(
    incidentId: string,
    query: IncidentListRelatedParams | Core.RequestOptions = {},
    options?: Core.RequestOptions,
  ): Core.PagePromise<IncidentsBasePage, Incident> {
    if (isRequestOptions(query)) {
      return this.listRelated(incidentId, {}, query);
    }
    return this._client.getAPIList(`/data/v1/incidents/${incidentId}/related`, IncidentsBasePage, {
      query,
      ...options,
    });
  }
}

export class IncidentsBasePage extends BasePage<Incident> {}

export interface Incident {
  id: string;

  affected_views: number;

  affected_views_per_hour: number;

  affected_views_per_hour_on_open: number;

  breakdowns: Array<Incident.Breakdown>;

  description: string;

  error_description: string;

  impact: string;

  incident_key: string;

  measured_value: number | null;

  measured_value_on_close: number | null;

  measurement: string;

  notification_rules: Array<Incident.NotificationRule>;

  notifications: Array<Incident.Notification>;

  resolved_at: string | null;

  sample_size: number;

  sample_size_unit: string;

  severity: string;

  started_at: string;

  status: string;

  threshold: number;
}

export namespace Incident {
  export interface Breakdown {
    id: string;

    name: string;

    value: string;
  }

  export interface NotificationRule {
    id: string;

    action: string;

    property_id: string;

    rules: Array<NotificationRule.Rule>;

    status: string;
  }

  export namespace NotificationRule {
    export interface Rule {
      id: string;

      name: string;

      value: string;
    }
  }

  export interface Notification {
    id: number;

    attempted_at: string;

    queued_at: string;
  }
}

export interface IncidentResponse {
  data: Incident;

  timeframe: Array<number>;

  total_row_count: number | null;
}

export interface IncidentListParams extends BasePageParams {
  /**
   * Value to order the results by
   */
  order_by?: 'negative_impact' | 'value' | 'views' | 'field';

  /**
   * Sort order.
   */
  order_direction?: 'asc' | 'desc';

  /**
   * Severity to filter incidents by
   */
  severity?: 'warning' | 'alert';

  /**
   * Status to filter incidents by
   */
  status?: 'open' | 'closed' | 'expired';
}

export interface IncidentListRelatedParams extends BasePageParams {
  /**
   * Value to order the results by
   */
  order_by?: 'negative_impact' | 'value' | 'views' | 'field';

  /**
   * Sort order.
   */
  order_direction?: 'asc' | 'desc';
}

export namespace Incidents {
  export import Incident = IncidentsAPI.Incident;
  export import IncidentResponse = IncidentsAPI.IncidentResponse;
  export import IncidentsBasePage = IncidentsAPI.IncidentsBasePage;
  export import IncidentListParams = IncidentsAPI.IncidentListParams;
  export import IncidentListRelatedParams = IncidentsAPI.IncidentListRelatedParams;
}