statuspage.io 3.4.5 → 3.4.7

package/dist/Endpoints.d.ts

@@ -1,27 +1,27 @@
 export declare const Endpoint: {
     ACTIVE_JSON: string;
     API_V2_BASE: string;
+    components(): 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;
     };
+    INCIDENTS_JSON: string;
+    SCHEDULED_MAINTENANCES: string;
+    SCHEDULED_MAINTENANCES_JSON: string;
     ScheduledMaintenances: {
         active(): string;
         all(): string;
         upcoming(): string;
     };
-    components(): string;
-    summary(): 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

@@ -4,16 +4,11 @@ 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_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}`;
@@ -22,6 +17,9 @@ exports.Endpoint = {
             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}`;
@@ -33,16 +31,18 @@ exports.Endpoint = {
             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}`;
     },
+    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/api/SubscribersAPI.d.ts

@@ -4,31 +4,26 @@ import type { CombinedSubscriber, EmailSubscriber, PhoneSubscriber, WebhookSubsc
 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>;
+    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.
-     * @param options Subscriber options.
      */
     createIncidentSubscription(emailSubscriber: EmailSubscriberData & IncidentSubscriberData): Promise<EmailSubscriber>;
-    createIncidentSubscription(smsSubscriber: PhoneSubscriberData & IncidentSubscriberData): Promise<PhoneSubscriber>;
-    createIncidentSubscription(webhookSubscriber: WebhookSubscriberData & IncidentSubscriberData): Promise<WebhookSubscriber>;
+    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.
-     * @param options Subscriber options.
      */
     createPageSubscription(emailSubscriber: EmailSubscriberData): Promise<EmailSubscriber>;
     createPageSubscription(smsSubscriber: PhoneSubscriberData): Promise<PhoneSubscriber>;
     createPageSubscription(webhookSubscriber: WebhookSubscriberData): Promise<WebhookSubscriber>;
     /**
-     * @param options Subscriber options.
+     * @param subscriberId The subscriber ID.
      */
     getSubscription(subscriberId: string): Promise<CombinedSubscriber>;
     /**

package/dist/api/SubscribersAPI.js

@@ -37,7 +37,7 @@ class SubscribersAPI {
         });
     }
     /**
-     * @param options Subscriber options.
+     * @param subscriberId The subscriber ID.
      */
     getSubscription(subscriberId) {
         return __awaiter(this, void 0, void 0, function* () {

package/dist/index.d.ts

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

package/dist/index.js

@@ -14,5 +14,6 @@ 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("./api/"), exports);
 __exportStar(require("./interfaces/"), exports);
+__exportStar(require("./Statuspage"), exports);

package/dist/interfaces/API.d.ts

@@ -1,5 +1,5 @@
-import { IncidentsAPI, ScheduledMaintenancesAPI, SubscribersAPI } from '../api';
 import type { Components, Status, Summary } from './Result';
+import { IncidentsAPI, ScheduledMaintenancesAPI, SubscribersAPI } from '../api';
 export interface API {
     getComponents(): Promise<Components>;
     getStatus(): Promise<Status>;

package/dist/interfaces/Request.d.ts

@@ -1,3 +1,4 @@
+export type CombinedSubscriberData = EmailSubscriberData | PhoneSubscriberData | WebhookSubscriberData;
 export interface ComponentSubscriberData {
     component_id: string;
 }
@@ -7,20 +8,19 @@ export interface EmailSubscriberData {
 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 RequestOptions {
+    subscriber?: {
+        id: string;
+    } | CombinedSubscriberData | (CombinedSubscriberData & IncidentSubscriberData);
+}
 export interface SubscriberOptions {
     isSubscribed: boolean;
 }
 export interface WebhookSubscriberData extends EmailSubscriberData {
     endpoint: string;
 }
-export type CombinedSubscriberData = PhoneSubscriberData | EmailSubscriberData | WebhookSubscriberData;

package/dist/interfaces/Result.d.ts

@@ -1,88 +1,61 @@
+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: string | null;
+    description: null | string;
     group: boolean;
-    group_id: string | null;
+    group_id: null | string;
     id: string;
     name: string;
     only_show_if_degraded: boolean;
     page_id: string;
     position: number;
     showcase: boolean;
-    start_date: string | null;
+    start_date: null | string;
     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;
+    monitoring_at: null | string;
     name: string;
     page_id: string;
-    resolved_at: string | null;
+    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;
@@ -92,11 +65,38 @@ export interface IncidentUpdate {
     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 type CombinedSubscriber = PhoneSubscriber | EmailSubscriber | WebhookSubscriber;
-export type Summary = Status & ScheduledMaintenances & Components & Incidents;
+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

@@ -1,13 +1,6 @@
 "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 = {}));
+exports.MaintenanceStatus = exports.IncidentStatus = exports.IncidentImpact = void 0;
 var IncidentImpact;
 (function (IncidentImpact) {
     IncidentImpact["Critical"] = "critical";
@@ -23,3 +16,10 @@ var IncidentStatus;
     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/package.json

@@ -1,14 +1,14 @@
 {
   "author": "Florian Imdahl <git@ffflorian.de>",
   "dependencies": {
-    "@ffflorian/api-client": "2.2.0"
+    "@ffflorian/api-client": "2.5.1"
   },
   "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"
@@ -29,12 +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.5",
-  "gitHead": "8d7471cbe490305b3e441c27acbc81e36a4bd9df"
+  "version": "3.4.7"
 }