statuspage.io 3.4.6 → 3.4.7

package/dist/Endpoints.d.ts

@@ -0,0 +1,27 @@
+export declare const Endpoint: {
+    ACTIVE_JSON: string;
+    API_V2_BASE: string;
+    components(): string;
+    COMPONENTS_JSON: string;
+    INCIDENTS: string;
+    Incidents: {
+        all(): string;
+        unresolved(): string;
+    };
+    INCIDENTS_JSON: string;
+    SCHEDULED_MAINTENANCES: string;
+    SCHEDULED_MAINTENANCES_JSON: string;
+    ScheduledMaintenances: {
+        active(): string;
+        all(): string;
+        upcoming(): string;
+    };
+    status(): string;
+    STATUS_JSON: string;
+    subscribers(): string;
+    SUBSCRIBERS_JSON: string;
+    summary(): string;
+    SUMMARY_JSON: string;
+    UNRESOLVED_JSON: string;
+    UPCOMING_JSON: string;
+};

package/dist/Endpoints.js

@@ -0,0 +1,48 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Endpoint = void 0;
+exports.Endpoint = {
+    ACTIVE_JSON: 'upcoming.json',
+    API_V2_BASE: 'api/v2',
+    components() {
+        return `/${exports.Endpoint.API_V2_BASE}/${exports.Endpoint.COMPONENTS_JSON}`;
+    },
+    COMPONENTS_JSON: 'components.json',
+    INCIDENTS: 'incidents',
+    Incidents: {
+        all() {
+            return `/${exports.Endpoint.API_V2_BASE}/${exports.Endpoint.INCIDENTS_JSON}`;
+        },
+        unresolved() {
+            return `/${exports.Endpoint.API_V2_BASE}/${exports.Endpoint.INCIDENTS}/${exports.Endpoint.UNRESOLVED_JSON}`;
+        },
+    },
+    INCIDENTS_JSON: 'incidents.json',
+    SCHEDULED_MAINTENANCES: 'scheduled-maintenances',
+    SCHEDULED_MAINTENANCES_JSON: 'scheduled-maintenances.json',
+    ScheduledMaintenances: {
+        active() {
+            return `/${exports.Endpoint.API_V2_BASE}/${exports.Endpoint.SCHEDULED_MAINTENANCES}/${exports.Endpoint.ACTIVE_JSON}`;
+        },
+        all() {
+            return `/${exports.Endpoint.API_V2_BASE}/${exports.Endpoint.SCHEDULED_MAINTENANCES_JSON}`;
+        },
+        upcoming() {
+            return `/${exports.Endpoint.API_V2_BASE}/${exports.Endpoint.SCHEDULED_MAINTENANCES}/${exports.Endpoint.UPCOMING_JSON}`;
+        },
+    },
+    status() {
+        return `/${exports.Endpoint.API_V2_BASE}/${exports.Endpoint.STATUS_JSON}`;
+    },
+    STATUS_JSON: 'status.json',
+    subscribers() {
+        return `/${exports.Endpoint.API_V2_BASE}/${exports.Endpoint.SUBSCRIBERS_JSON}`;
+    },
+    SUBSCRIBERS_JSON: 'subscribers.json',
+    summary() {
+        return `/${exports.Endpoint.API_V2_BASE}/${exports.Endpoint.SUMMARY_JSON}`;
+    },
+    SUMMARY_JSON: 'summary.json',
+    UNRESOLVED_JSON: 'unresolved.json',
+    UPCOMING_JSON: 'upcoming.json',
+};

package/dist/Statuspage.d.ts

@@ -0,0 +1,28 @@
+import type { API } from './interfaces/API';
+export declare class Statuspage {
+    readonly api: API;
+    private readonly apiClient;
+    constructor(pageId: string);
+    /**
+     * Set a new API URL.
+     * @param newURL The new API url
+     */
+    setApiUrl(newURL: string): void;
+    /**
+     * Get the components for the page. Each component is listed along with its status -
+     * one of `operational`, `degraded_performance`, `partial_outage`, or `major_outage`.
+     */
+    private readonly getComponents;
+    /**
+     * Get the status rollup for the whole page. This endpoint includes an indicator -
+     * one of `none`, `minor`, `major`, or `critical`, as well as a human description of the
+     * blended component status. Examples of the blended status include "All Systems
+     * Operational", "Partially Degraded Service", and "Major Service Outage".
+     */
+    private readonly getStatus;
+    /**
+     * Get a summary of the status page, including a status indicator, component statuses,
+     * unresolved incidents, and any upcoming or in-progress scheduled maintenances.
+     */
+    private readonly getSummary;
+}

package/dist/Statuspage.js

@@ -0,0 +1,68 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Statuspage = void 0;
+const api_client_1 = require("@ffflorian/api-client");
+const api_1 = require("./api");
+const Endpoints_1 = require("./Endpoints");
+class Statuspage {
+    constructor(pageId) {
+        /**
+         * Get the components for the page. Each component is listed along with its status -
+         * one of `operational`, `degraded_performance`, `partial_outage`, or `major_outage`.
+         */
+        this.getComponents = () => __awaiter(this, void 0, void 0, function* () {
+            const endpoint = Endpoints_1.Endpoint.components();
+            const { data } = yield this.apiClient.get(endpoint);
+            return data;
+        });
+        /**
+         * Get the status rollup for the whole page. This endpoint includes an indicator -
+         * one of `none`, `minor`, `major`, or `critical`, as well as a human description of the
+         * blended component status. Examples of the blended status include "All Systems
+         * Operational", "Partially Degraded Service", and "Major Service Outage".
+         */
+        this.getStatus = () => __awaiter(this, void 0, void 0, function* () {
+            const endpoint = Endpoints_1.Endpoint.status();
+            const { data } = yield this.apiClient.get(endpoint);
+            return data;
+        });
+        /**
+         * Get a summary of the status page, including a status indicator, component statuses,
+         * unresolved incidents, and any upcoming or in-progress scheduled maintenances.
+         */
+        this.getSummary = () => __awaiter(this, void 0, void 0, function* () {
+            const endpoint = Endpoints_1.Endpoint.summary();
+            const { data } = yield this.apiClient.get(endpoint);
+            return data;
+        });
+        if (!pageId) {
+            throw new Error('A page ID needs to be set in order to use the client.');
+        }
+        this.apiClient = new api_client_1.APIClient(`https://${pageId}.statuspage.io`);
+        this.api = {
+            getComponents: this.getComponents,
+            getStatus: this.getStatus,
+            getSummary: this.getSummary,
+            incidents: new api_1.IncidentsAPI(this.apiClient),
+            scheduledMaintenances: new api_1.ScheduledMaintenancesAPI(this.apiClient),
+            subscribers: new api_1.SubscribersAPI(this.apiClient),
+        };
+    }
+    /**
+     * Set a new API URL.
+     * @param newURL The new API url
+     */
+    setApiUrl(newURL) {
+        this.apiClient.setBaseURL(newURL);
+    }
+}
+exports.Statuspage = Statuspage;

package/dist/api/IncidentsAPI.d.ts

@@ -0,0 +1,16 @@
+import type { APIClient } from '@ffflorian/api-client';
+import type { Incidents } from '../interfaces/Result';
+export declare class IncidentsAPI {
+    private readonly apiClient;
+    constructor(apiClient: APIClient);
+    /**
+     * Get a list of the 50 most recent incidents. This includes all unresolved
+     * incidents as described above, as well as those in the *Resolved* and *Postmortem* state.
+     */
+    getAll(): Promise<Incidents>;
+    /**
+     * Get a list of any unresolved incidents. This endpoint will only return
+     * incidents in the *Investigating*, *Identified*, or *Monitoring* state.
+     */
+    getUnresolved(): Promise<Incidents>;
+}

package/dist/api/IncidentsAPI.js

@@ -0,0 +1,41 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IncidentsAPI = void 0;
+const Endpoints_1 = require("../Endpoints");
+class IncidentsAPI {
+    constructor(apiClient) {
+        this.apiClient = apiClient;
+    }
+    /**
+     * Get a list of the 50 most recent incidents. This includes all unresolved
+     * incidents as described above, as well as those in the *Resolved* and *Postmortem* state.
+     */
+    getAll() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const endpoint = Endpoints_1.Endpoint.Incidents.all();
+            const { data } = yield this.apiClient.get(endpoint);
+            return data;
+        });
+    }
+    /**
+     * Get a list of any unresolved incidents. This endpoint will only return
+     * incidents in the *Investigating*, *Identified*, or *Monitoring* state.
+     */
+    getUnresolved() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const endpoint = Endpoints_1.Endpoint.Incidents.unresolved();
+            const { data } = yield this.apiClient.get(endpoint);
+            return data;
+        });
+    }
+}
+exports.IncidentsAPI = IncidentsAPI;

package/dist/api/ScheduledMaintenancesAPI.d.ts

@@ -0,0 +1,22 @@
+import type { APIClient } from '@ffflorian/api-client';
+import type { ScheduledMaintenances } from '../interfaces/Result';
+export declare class ScheduledMaintenancesAPI {
+    private readonly apiClient;
+    constructor(requestService: APIClient);
+    /**
+     * Get a list of any active maintenances. This endpoint will only return
+     * scheduled maintenances in the *In Progress* or *Verifying* state.
+     */
+    getActive(): Promise<ScheduledMaintenances>;
+    /**
+     * Get a list of the 50 most recent scheduled maintenances. This includes
+     * scheduled maintenances as described in the above two endpoints, as well
+     * as those in the *Completed* state.
+     */
+    getAll(): Promise<ScheduledMaintenances>;
+    /**
+     * Get a list of any upcoming maintenances. This endpoint will only return
+     * scheduled maintenances still in the *Scheduled* state.
+     */
+    getUpcoming(): Promise<ScheduledMaintenances>;
+}

package/dist/api/ScheduledMaintenancesAPI.js

@@ -0,0 +1,53 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ScheduledMaintenancesAPI = void 0;
+const Endpoints_1 = require("../Endpoints");
+class ScheduledMaintenancesAPI {
+    constructor(requestService) {
+        this.apiClient = requestService;
+    }
+    /**
+     * Get a list of any active maintenances. This endpoint will only return
+     * scheduled maintenances in the *In Progress* or *Verifying* state.
+     */
+    getActive() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const endpoint = Endpoints_1.Endpoint.ScheduledMaintenances.upcoming();
+            const { data } = yield this.apiClient.get(endpoint);
+            return data;
+        });
+    }
+    /**
+     * Get a list of the 50 most recent scheduled maintenances. This includes
+     * scheduled maintenances as described in the above two endpoints, as well
+     * as those in the *Completed* state.
+     */
+    getAll() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const endpoint = Endpoints_1.Endpoint.ScheduledMaintenances.upcoming();
+            const { data } = yield this.apiClient.get(endpoint);
+            return data;
+        });
+    }
+    /**
+     * Get a list of any upcoming maintenances. This endpoint will only return
+     * scheduled maintenances still in the *Scheduled* state.
+     */
+    getUpcoming() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const endpoint = Endpoints_1.Endpoint.ScheduledMaintenances.upcoming();
+            const { data } = yield this.apiClient.get(endpoint);
+            return data;
+        });
+    }
+}
+exports.ScheduledMaintenancesAPI = ScheduledMaintenancesAPI;

package/dist/api/SubscribersAPI.d.ts

@@ -0,0 +1,33 @@
+import type { APIClient } from '@ffflorian/api-client';
+import type { ComponentSubscriberData, EmailSubscriberData, IncidentSubscriberData, PhoneSubscriberData, WebhookSubscriberData } from '../interfaces/Request';
+import type { CombinedSubscriber, EmailSubscriber, PhoneSubscriber, WebhookSubscriber } from '../interfaces/Result';
+export declare class SubscribersAPI {
+    private readonly apiClient;
+    constructor(apiClient: APIClient);
+    createComponentSubscription(emailSubscriber: ComponentSubscriberData & EmailSubscriberData): Promise<EmailSubscriber>;
+    createComponentSubscription(smsSubscriber: ComponentSubscriberData & PhoneSubscriberData): Promise<PhoneSubscriber>;
+    createComponentSubscription(webhookSubscriber: ComponentSubscriberData & WebhookSubscriberData): Promise<WebhookSubscriber>;
+    /**
+     * When an incident is created, a subscriber can be associated
+     * to that incident to receive notifications on updates until the
+     * incident is resolved. The incident must be in an unresolved
+     * state to subscribe to it.
+     */
+    createIncidentSubscription(emailSubscriber: EmailSubscriberData & IncidentSubscriberData): Promise<EmailSubscriber>;
+    createIncidentSubscription(smsSubscriber: IncidentSubscriberData & PhoneSubscriberData): Promise<PhoneSubscriber>;
+    createIncidentSubscription(webhookSubscriber: IncidentSubscriberData & WebhookSubscriberData): Promise<WebhookSubscriber>;
+    /**
+     * A page subscriber is by default subscribed to all incidents associated with a page.
+     */
+    createPageSubscription(emailSubscriber: EmailSubscriberData): Promise<EmailSubscriber>;
+    createPageSubscription(smsSubscriber: PhoneSubscriberData): Promise<PhoneSubscriber>;
+    createPageSubscription(webhookSubscriber: WebhookSubscriberData): Promise<WebhookSubscriber>;
+    /**
+     * @param subscriberId The subscriber ID.
+     */
+    getSubscription(subscriberId: string): Promise<CombinedSubscriber>;
+    /**
+     * To cancel a subscription, you need to submit a 'DELETE' request with the the subscription id.
+     */
+    removeSubscription(subscriberId: string): Promise<boolean>;
+}

package/dist/api/SubscribersAPI.js

@@ -0,0 +1,60 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SubscribersAPI = void 0;
+const Endpoints_1 = require("../Endpoints");
+class SubscribersAPI {
+    constructor(apiClient) {
+        this.apiClient = apiClient;
+    }
+    createComponentSubscription(subscriberData) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const endpoint = Endpoints_1.Endpoint.subscribers();
+            const { data } = yield this.apiClient.get(endpoint, { params: { subscriber: subscriberData } });
+            return data;
+        });
+    }
+    createIncidentSubscription(subscriberData) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const endpoint = Endpoints_1.Endpoint.subscribers();
+            const { data } = yield this.apiClient.get(endpoint, { params: { subscriber: subscriberData } });
+            return data;
+        });
+    }
+    createPageSubscription(subscriptionData) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const endpoint = Endpoints_1.Endpoint.subscribers();
+            const { data } = yield this.apiClient.get(endpoint, { params: { subscriber: subscriptionData } });
+            return data;
+        });
+    }
+    /**
+     * @param subscriberId The subscriber ID.
+     */
+    getSubscription(subscriberId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const endpoint = Endpoints_1.Endpoint.subscribers();
+            const { data } = yield this.apiClient.get(endpoint, { params: { subscriber: { id: subscriberId } } });
+            return data;
+        });
+    }
+    /**
+     * To cancel a subscription, you need to submit a 'DELETE' request with the the subscription id.
+     */
+    removeSubscription(subscriberId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const endpoint = Endpoints_1.Endpoint.Incidents.all();
+            const { data } = yield this.apiClient.delete(endpoint, { params: { subscriber: { id: subscriberId } } });
+            return data;
+        });
+    }
+}
+exports.SubscribersAPI = SubscribersAPI;

package/dist/api/index.d.ts

@@ -0,0 +1,3 @@
+export * from './IncidentsAPI';
+export * from './ScheduledMaintenancesAPI';
+export * from './SubscribersAPI';

package/dist/api/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./IncidentsAPI"), exports);
+__exportStar(require("./ScheduledMaintenancesAPI"), exports);
+__exportStar(require("./SubscribersAPI"), exports);

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export * from './api/';
+export * from './interfaces/';
+export * from './Statuspage';

package/dist/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./api/"), exports);
+__exportStar(require("./interfaces/"), exports);
+__exportStar(require("./Statuspage"), exports);

package/dist/interfaces/API.d.ts

@@ -0,0 +1,34 @@
+import type { Components, Status, Summary } from './Result';
+import { IncidentsAPI, ScheduledMaintenancesAPI, SubscribersAPI } from '../api';
+export interface API {
+    getComponents(): Promise<Components>;
+    getStatus(): Promise<Status>;
+    getSummary(): Promise<Summary>;
+    /**
+     * Incidents are the cornerstone of any status page, being composed of many incident
+     * updates. Each incident usually goes through a progression of statuses listed below,
+     * with an impact calculated from a blend of component statuses (or an optional override).
+     *
+     * **Status**: *Investigating*, *Identified*, *Monitoring*, *Resolved*, or *Postmortem*
+     *
+     * **Impact**: *None (black*), *Minor (yellow*), *Major (orange*), or *Critical (red)*
+     */
+    incidents: IncidentsAPI;
+    /**
+     * Scheduled Maintenances are planned outages, upgrades, or general notices that
+     * you're working on infrastructure and disruptions may occurr. A close sibling
+     * of Incidents, each usually goes through a progression of statuses listed below,
+     * with an impact calculated from a blend of component statuses (or an optional
+     * override).
+     *
+     * **Status**: *Scheduled*, *In Progress*, *Verifying*, or *Completed*
+     *
+     * **Impact**: *None (black)*, *Minor (yellow)*, *Major (orange)*, or *Critical (red)*
+     */
+    scheduledMaintenances: ScheduledMaintenancesAPI;
+    /**
+     * Subscribers receive notifications via a webhook, email or SMS. You can create and
+     * disable subscriptions for pages and unresolved incidents using the subscribers api.
+     */
+    subscribers: SubscribersAPI;
+}

package/dist/interfaces/API.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/interfaces/Request.d.ts

@@ -0,0 +1,26 @@
+export type CombinedSubscriberData = EmailSubscriberData | PhoneSubscriberData | WebhookSubscriberData;
+export interface ComponentSubscriberData {
+    component_id: string;
+}
+export interface EmailSubscriberData {
+    email: string;
+}
+export interface IncidentSubscriberData {
+    incident_id: string;
+}
+export interface PhoneSubscriberData {
+    /** Defaults to `us` if not supplied. */
+    phone_country?: string;
+    phone_number: string;
+}
+export interface RequestOptions {
+    subscriber?: {
+        id: string;
+    } | CombinedSubscriberData | (CombinedSubscriberData & IncidentSubscriberData);
+}
+export interface SubscriberOptions {
+    isSubscribed: boolean;
+}
+export interface WebhookSubscriberData extends EmailSubscriberData {
+    endpoint: string;
+}

package/dist/interfaces/Request.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/interfaces/Result.d.ts

@@ -0,0 +1,102 @@
+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 declare enum MaintenanceStatus {
+    Completed = "completed",
+    InProgress = "in_progress",
+    Scheduled = "scheduled",
+    Verifying = "verifying"
+}
+export type CombinedSubscriber = EmailSubscriber | PhoneSubscriber | WebhookSubscriber;
+export interface Component {
+    created_at: string;
+    description: null | string;
+    group: boolean;
+    group_id: null | string;
+    id: string;
+    name: string;
+    only_show_if_degraded: boolean;
+    page_id: string;
+    position: number;
+    showcase: boolean;
+    start_date: null | string;
+    status: string;
+    updated_at: string;
+}
+export interface Components extends Page {
+    components: Component[];
+}
+export interface EmailSubscriber extends Subscriber {
+    email: string;
+    mode: 'email_sms';
+}
+export interface Incident {
+    created_at: string;
+    id: string;
+    impact: IncidentImpact;
+    incident_updates: IncidentUpdate[];
+    monitoring_at: null | string;
+    name: string;
+    page_id: string;
+    resolved_at: null | string;
+    shortlink: string;
+    status: IncidentStatus;
+    updated_at: string;
+}
+export interface Incidents extends Page {
+    incidents: Incident[];
+}
+export interface IncidentUpdate {
+    body: string;
+    created_at: string;
+    display_at: string;
+    id: string;
+    incident_id: string;
+    status: IncidentStatus;
+    updated_at: string;
+}
+export interface Page {
+    page: {
+        id: string;
+        name: string;
+        time_zone: string;
+        updated_at: string;
+        url: string;
+    };
+}
+export interface PhoneSubscriber extends Subscriber {
+    mode: 'email_sms';
+    phone: string;
+}
+export type ScheduledMaintenance = {
+    scheduled_for: string;
+    scheduled_until: string;
+    status: MaintenanceStatus;
+} & Omit<Incident, 'status'>;
+export interface ScheduledMaintenances extends Page {
+    scheduled_maintenances: ScheduledMaintenance[];
+}
+export interface Status extends Page {
+    status: {
+        description: string;
+        indicator: string;
+    };
+}
+export interface Subscriber extends Page {
+    can_select_components: boolean;
+}
+export type Summary = Components & Incidents & ScheduledMaintenances & Status;
+export interface WebhookSubscriber extends Subscriber {
+    mode: 'webhook';
+    webhook: string;
+}

package/dist/interfaces/Result.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MaintenanceStatus = exports.IncidentStatus = exports.IncidentImpact = void 0;
+var IncidentImpact;
+(function (IncidentImpact) {
+    IncidentImpact["Critical"] = "critical";
+    IncidentImpact["Major"] = "major";
+    IncidentImpact["Minor"] = "minor";
+    IncidentImpact["None"] = "none";
+})(IncidentImpact || (exports.IncidentImpact = IncidentImpact = {}));
+var IncidentStatus;
+(function (IncidentStatus) {
+    IncidentStatus["Identified"] = "identified";
+    IncidentStatus["Investigating"] = "investigating";
+    IncidentStatus["Monitoring"] = "monitoring";
+    IncidentStatus["Postmortem"] = "postmortem";
+    IncidentStatus["Resolved"] = "resolved";
+})(IncidentStatus || (exports.IncidentStatus = IncidentStatus = {}));
+var MaintenanceStatus;
+(function (MaintenanceStatus) {
+    MaintenanceStatus["Completed"] = "completed";
+    MaintenanceStatus["InProgress"] = "in_progress";
+    MaintenanceStatus["Scheduled"] = "scheduled";
+    MaintenanceStatus["Verifying"] = "verifying";
+})(MaintenanceStatus || (exports.MaintenanceStatus = MaintenanceStatus = {}));

package/dist/interfaces/index.d.ts

@@ -0,0 +1,3 @@
+export * from './API';
+export * from './Request';
+export * from './Result';

package/dist/interfaces/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./API"), exports);
+__exportStar(require("./Request"), exports);
+__exportStar(require("./Result"), exports);

package/package.json

@@ -1,7 +1,7 @@
 {
   "author": "Florian Imdahl <git@ffflorian.de>",
   "dependencies": {
-    "@ffflorian/api-client": "2.5.0"
+    "@ffflorian/api-client": "2.5.1"
   },
   "description": "A statuspage.io API client",
   "devDependencies": {
@@ -29,11 +29,12 @@
   "readme": "https://github.com/ffflorian/api-clients#readme",
   "repository": "https://github.com/ffflorian/api-clients.git",
   "scripts": {
+    "build": "yarn build:ts",
     "build:ts": "tsc -p tsconfig.build.json",
     "build:docs": "typedoc --tsconfig tsconfig.build.json --options ../../typedoc.json --out ../../docs/packages/statuspage.io src/index.ts",
     "clean": "rimraf dist",
-    "dist": "yarn clean && yarn build:ts",
+    "dist": "yarn clean && yarn build",
     "test": "exit 0"
   },
-  "version": "3.4.6"
+  "version": "3.4.7"
 }