statuspage.io/dist/interfaces/Result.d.ts

A statuspage.io API client

export interface Component {
    created_at: string;
    description: string | null;
    group: boolean;
    group_id: string | null;
    id: string;
    name: string;
    only_show_if_degraded: boolean;
    page_id: string;
    position: number;
    showcase: boolean;
    start_date: string | null;
    status: string;
    updated_at: string;
}
export interface Page {
    page: {
        id: string;
        name: string;
        time_zone: string;
        updated_at: string;
        url: string;
    };
}
export interface Incidents extends Page {
    incidents: Incident[];
}
export interface Components extends Page {
    components: Component[];
}
export declare enum MaintenanceStatus {
    Completed = "completed",
    InProgress = "in_progress",
    Scheduled = "scheduled",
    Verifying = "verifying"
}
export declare type ScheduledMaintenance = Incident & {
    scheduled_for: string;
    scheduled_until: string;
    status: MaintenanceStatus;
};
export interface ScheduledMaintenances extends Page {
    scheduled_maintenances: ScheduledMaintenance[];
}
export interface Subscriber extends Page {
    can_select_components: boolean;
}
export interface WebhookSubscriber extends Subscriber {
    mode: 'webhook';
    webhook: string;
}
export interface EmailSubscriber extends Subscriber {
    email: string;
    mode: 'email_sms';
}
export interface PhoneSubscriber extends Subscriber {
    mode: 'email_sms';
    phone: string;
}
export declare enum IncidentImpact {
    Critical = "critical",
    Major = "major",
    Minor = "minor",
    None = "none"
}
export declare enum IncidentStatus {
    Identified = "identified",
    Investigating = "investigating",
    Monitoring = "monitoring",
    Postmortem = "postmortem",
    Resolved = "resolved"
}
export interface Incident {
    created_at: string;
    id: string;
    impact: IncidentImpact;
    incident_updates: IncidentUpdate[];
    monitoring_at: string | null;
    name: string;
    page_id: string;
    resolved_at: string | null;
    shortlink: string;
    status: IncidentStatus;
    updated_at: string;
}
export interface IncidentUpdate {
    body: string;
    created_at: string;
    display_at: string;
    id: string;
    incident_id: string;
    status: IncidentStatus;
    updated_at: string;
}
export interface Status extends Page {
    status: {
        description: string;
        indicator: string;
    };
}
export declare type CombinedSubscriber = PhoneSubscriber | EmailSubscriber | WebhookSubscriber;
export declare type Summary = Status & ScheduledMaintenance & Components & Incidents;