statuspage.io 3.4.4 → 3.4.6

package/package.json

@@ -1,14 +1,14 @@
 {
   "author": "Florian Imdahl <git@ffflorian.de>",
   "dependencies": {
-    "@ffflorian/api-client": "2.2.0"
+    "@ffflorian/api-client": "2.5.0"
   },
   "description": "A statuspage.io API client",
   "devDependencies": {
     "@types/node": "~24",
-    "rimraf": "6.1.2",
-    "typedoc": "0.28.15",
-    "typescript": "5.9.3"
+    "rimraf": "6.1.3",
+    "typedoc": "0.28.18",
+    "typescript": "6.0.2"
   },
   "engines": {
     "node": ">= 21"
@@ -35,6 +35,5 @@
     "dist": "yarn clean && yarn build:ts",
     "test": "exit 0"
   },
-  "version": "3.4.4",
-  "gitHead": "12bebfb90528bb894bccb99670373af33c6a5159"
+  "version": "3.4.6"
 }

package/dist/Endpoints.d.ts

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

package/dist/Endpoints.js

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

package/dist/Statuspage.d.ts

@@ -1,28 +0,0 @@
-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

@@ -1,68 +0,0 @@
-"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

@@ -1,16 +0,0 @@
-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

@@ -1,41 +0,0 @@
-"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

@@ -1,22 +0,0 @@
-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

@@ -1,53 +0,0 @@
-"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

@@ -1,38 +0,0 @@
-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);
-    /**
-     * @param options Subscriber options.
-     */
-    createComponentSubscription(emailSubscriber: EmailSubscriberData & ComponentSubscriberData): Promise<EmailSubscriber>;
-    createComponentSubscription(smsSubscriber: PhoneSubscriberData & ComponentSubscriberData): Promise<PhoneSubscriber>;
-    createComponentSubscription(webhookSubscriber: WebhookSubscriberData & ComponentSubscriberData): 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.
-     * @param options Subscriber options.
-     */
-    createIncidentSubscription(emailSubscriber: EmailSubscriberData & IncidentSubscriberData): Promise<EmailSubscriber>;
-    createIncidentSubscription(smsSubscriber: PhoneSubscriberData & IncidentSubscriberData): Promise<PhoneSubscriber>;
-    createIncidentSubscription(webhookSubscriber: WebhookSubscriberData & IncidentSubscriberData): Promise<WebhookSubscriber>;
-    /**
-     * A page subscriber is by default subscribed to all incidents associated with a page.
-     * @param options Subscriber options.
-     */
-    createPageSubscription(emailSubscriber: EmailSubscriberData): Promise<EmailSubscriber>;
-    createPageSubscription(smsSubscriber: PhoneSubscriberData): Promise<PhoneSubscriber>;
-    createPageSubscription(webhookSubscriber: WebhookSubscriberData): Promise<WebhookSubscriber>;
-    /**
-     * @param options Subscriber options.
-     */
-    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

@@ -1,60 +0,0 @@
-"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 options Subscriber options.
-     */
-    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

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

package/dist/api/index.js

@@ -1,19 +0,0 @@
-"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

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

package/dist/index.js

@@ -1,18 +0,0 @@
-"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("./Statuspage"), exports);
-__exportStar(require("./interfaces/"), exports);

package/dist/interfaces/API.d.ts

@@ -1,34 +0,0 @@
-import { IncidentsAPI, ScheduledMaintenancesAPI, SubscribersAPI } from '../api';
-import type { Components, Status, Summary } from './Result';
-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

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

package/dist/interfaces/Request.d.ts

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

package/dist/interfaces/Request.js

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

package/dist/interfaces/Result.d.ts

@@ -1,102 +0,0 @@
-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 type ScheduledMaintenance = Omit<Incident, 'status'> & {
-    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 type CombinedSubscriber = PhoneSubscriber | EmailSubscriber | WebhookSubscriber;
-export type Summary = Status & ScheduledMaintenances & Components & Incidents;

package/dist/interfaces/Result.js

@@ -1,25 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.IncidentStatus = exports.IncidentImpact = exports.MaintenanceStatus = void 0;
-var MaintenanceStatus;
-(function (MaintenanceStatus) {
-    MaintenanceStatus["Completed"] = "completed";
-    MaintenanceStatus["InProgress"] = "in_progress";
-    MaintenanceStatus["Scheduled"] = "scheduled";
-    MaintenanceStatus["Verifying"] = "verifying";
-})(MaintenanceStatus || (exports.MaintenanceStatus = MaintenanceStatus = {}));
-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 = {}));

package/dist/interfaces/index.d.ts

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

package/dist/interfaces/index.js

@@ -1,19 +0,0 @@
-"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);