updown.io 3.4.6 → 3.5.0

package/README.md

@@ -1,6 +1,6 @@
 # updown.io [![npm version](https://img.shields.io/npm/v/updown.io.svg)](https://www.npmjs.com/package/updown.io)
 
-An [updown.io](https://updown.io) API client. For a documentation on the API see https://updown.io/api/.
+An [updown.io](https://updown.io) API client. For a documentation on the API see [the updown.io API reference](https://updown.io/api/).
 
 ### Installation
 

package/dist/Endpoints.d.ts

@@ -0,0 +1,26 @@
+export declare const Endpoint: {
+    API: string;
+    CHECKS: string;
+    Checks: {
+        check(token: string): string;
+        downtimes(token: string): string;
+        metrics(token: string): string;
+    };
+    checks(token?: string): string;
+    DOWNTIMES: string;
+    IPS: string;
+    IPV4: string;
+    IPV6: string;
+    METRICS: string;
+    NODES: string;
+    Nodes: {
+        ips(): string;
+        ipv4(): string;
+        ipv6(): string;
+    };
+    nodes(): string;
+    RECIPIENTS: string;
+    recipients(id?: string): string;
+    STATUS_PAGES: string;
+    statusPages(token?: string): string;
+};

package/dist/Endpoints.js

@@ -0,0 +1,50 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Endpoint = void 0;
+const encode = encodeURIComponent;
+exports.Endpoint = {
+    API: 'api',
+    CHECKS: 'checks',
+    Checks: {
+        check(token) {
+            return `/${exports.Endpoint.API}/${exports.Endpoint.CHECKS}/${encode(token)}/`;
+        },
+        downtimes(token) {
+            return `/${exports.Endpoint.API}/${exports.Endpoint.CHECKS}/${encode(token)}/${exports.Endpoint.DOWNTIMES}/`;
+        },
+        metrics(token) {
+            return `/${exports.Endpoint.API}/${exports.Endpoint.CHECKS}/${encode(token)}/${exports.Endpoint.METRICS}/`;
+        },
+    },
+    checks(token) {
+        return `/${exports.Endpoint.API}/${exports.Endpoint.CHECKS}/${token ? `${encode(token)}/` : ''}`;
+    },
+    DOWNTIMES: 'downtimes',
+    IPS: 'ips',
+    IPV4: 'ipv4',
+    IPV6: 'ipv6',
+    METRICS: 'metrics',
+    NODES: 'nodes',
+    Nodes: {
+        ips() {
+            return `/${exports.Endpoint.API}/${exports.Endpoint.NODES}/${exports.Endpoint.IPS}/`;
+        },
+        ipv4() {
+            return `/${exports.Endpoint.API}/${exports.Endpoint.NODES}/${exports.Endpoint.IPV4}/`;
+        },
+        ipv6() {
+            return `/${exports.Endpoint.API}/${exports.Endpoint.NODES}/${exports.Endpoint.IPV6}/`;
+        },
+    },
+    nodes() {
+        return `/${exports.Endpoint.API}/${exports.Endpoint.NODES}/`;
+    },
+    RECIPIENTS: 'recipients',
+    recipients(id) {
+        return `/${exports.Endpoint.API}/${exports.Endpoint.RECIPIENTS}/${id ? `${encode(id)}/` : ''}`;
+    },
+    STATUS_PAGES: 'status_pages',
+    statusPages(token) {
+        return `/${exports.Endpoint.API}/${exports.Endpoint.STATUS_PAGES}/${token ? `${encode(token)}/` : ''}`;
+    },
+};

package/dist/UpdownIO.d.ts

@@ -0,0 +1,12 @@
+import type { API, ClientOptions } from './interfaces';
+export declare class UpdownIO {
+    api: API;
+    private readonly apiClient;
+    constructor(apiKey?: string);
+    constructor(options?: ClientOptions);
+    /**
+     * Set a new API URL.
+     * @param newURL The new API url
+     */
+    setApiUrl(newURL: string): void;
+}

package/dist/UpdownIO.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UpdownIO = void 0;
+const api_client_1 = require("@ffflorian/api-client");
+const api_1 = require("./api");
+class UpdownIO {
+    constructor(options) {
+        var _a;
+        if (typeof options === 'string') {
+            options = { apiKey: options };
+        }
+        this.apiClient = new api_client_1.APIClient((_a = options === null || options === void 0 ? void 0 : options.apiUrl) !== null && _a !== void 0 ? _a : 'https://updown.io', {
+            headers: Object.assign({}, ((options === null || options === void 0 ? void 0 : options.apiKey) && { 'X-API-KEY': options.apiKey })),
+        });
+        this.api = {
+            checks: new api_1.ChecksAPI(this.apiClient),
+            nodes: new api_1.NodesAPI(this.apiClient),
+            recipients: new api_1.RecipientsAPI(this.apiClient),
+            statusPages: new api_1.StatusPagesAPI(this.apiClient),
+        };
+    }
+    /**
+     * Set a new API URL.
+     * @param newURL The new API url
+     */
+    setApiUrl(newURL) {
+        this.api.checks.setApiUrl(newURL);
+        this.api.nodes.setApiUrl(newURL);
+        this.api.recipients.setApiUrl(newURL);
+        this.api.statusPages.setApiUrl(newURL);
+    }
+}
+exports.UpdownIO = UpdownIO;

package/dist/api/ChecksAPI.d.ts

@@ -0,0 +1,56 @@
+import type { APIClient } from '@ffflorian/api-client';
+import type { Check, CheckOptions, Deleted, Downtime, Metrics, MetricsOptions } from '../interfaces';
+export declare class ChecksAPI {
+    private readonly apiClient;
+    constructor(apiClient: APIClient);
+    private static mapCheckOptions;
+    /**
+     * Add a new check.
+     * @param url The URL you want to monitor.
+     * @param options Further check adding options
+     */
+    addCheck(url: string, options?: CheckOptions): Promise<Check>;
+    /**
+     * Delete a check.
+     * @param token The check unique token
+     */
+    deleteCheck(token: string): Promise<Deleted>;
+    /**
+     * Show a single check.
+     * @param token The check unique token
+     * @param metrics Include performance metrics (last hour only)
+     */
+    getCheck(token: string, metrics?: boolean): Promise<Check>;
+    /** List all your checks. */
+    getChecks(): Promise<Check[]>;
+    /**
+     * Get all the downtimes of a check.
+     *
+     * @param token The check unique token
+     * @param page The page to fetch (100 per page)
+     */
+    getDowntimes(token: string, page?: number): Promise<Downtime[]>;
+    /**
+     * Get detailed metrics about the check.
+     *
+     * Statistic are aggregated per hour which means you can't get more
+     * precise results than this. For example all requests performed
+     * between 5:00 and 5:59 will be reported at 5:00 in this API.
+     * The time range needs to be at least one hour to get data.
+     *
+     * @param token The check unique token
+     * @param options Metrics options
+     */
+    getMetrics(token: string, options?: MetricsOptions): Promise<Metrics>;
+    /**
+     * Set a new API URL.
+     * @param newURL The new API url
+     */
+    setApiUrl(newURL: string): void;
+    /**
+     * Update a check.
+     * @param token The check unique token
+     * @param options Further check updating options
+     */
+    updateCheck(token: string, options?: CheckOptions): Promise<Check>;
+}

package/dist/api/ChecksAPI.js

@@ -0,0 +1,131 @@
+"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());
+    });
+};
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ChecksAPI = void 0;
+const Endpoints_1 = require("../Endpoints");
+class ChecksAPI {
+    constructor(apiClient) {
+        this.apiClient = apiClient;
+    }
+    static mapCheckOptions(options) {
+        if (!options) {
+            return {};
+        }
+        const { customHeaders, disabledLocations } = options, rest = __rest(options, ["customHeaders", "disabledLocations"]);
+        return Object.assign(Object.assign(Object.assign({}, rest), (customHeaders && { custom_headers: customHeaders })), (disabledLocations && { disabled_locations: disabledLocations }));
+    }
+    /**
+     * Add a new check.
+     * @param url The URL you want to monitor.
+     * @param options Further check adding options
+     */
+    addCheck(url, options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const endpoint = Endpoints_1.Endpoint.checks();
+            const params = Object.assign({ url }, ChecksAPI.mapCheckOptions(options));
+            const { data } = yield this.apiClient.post(endpoint, params);
+            return data;
+        });
+    }
+    /**
+     * Delete a check.
+     * @param token The check unique token
+     */
+    deleteCheck(token) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const endpoint = Endpoints_1.Endpoint.checks(token);
+            const { data } = yield this.apiClient.delete(endpoint);
+            return data;
+        });
+    }
+    /**
+     * Show a single check.
+     * @param token The check unique token
+     * @param metrics Include performance metrics (last hour only)
+     */
+    getCheck(token, metrics) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const endpoint = Endpoints_1.Endpoint.Checks.check(token);
+            const { data } = yield this.apiClient.get(endpoint, { params: { metrics } });
+            return data;
+        });
+    }
+    /** List all your checks. */
+    getChecks() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const endpoint = Endpoints_1.Endpoint.checks();
+            const { data } = yield this.apiClient.get(endpoint);
+            return data;
+        });
+    }
+    /**
+     * Get all the downtimes of a check.
+     *
+     * @param token The check unique token
+     * @param page The page to fetch (100 per page)
+     */
+    getDowntimes(token, page) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const endpoint = Endpoints_1.Endpoint.Checks.downtimes(token);
+            const { data } = yield this.apiClient.get(endpoint, { params: { page } });
+            return data;
+        });
+    }
+    /**
+     * Get detailed metrics about the check.
+     *
+     * Statistic are aggregated per hour which means you can't get more
+     * precise results than this. For example all requests performed
+     * between 5:00 and 5:59 will be reported at 5:00 in this API.
+     * The time range needs to be at least one hour to get data.
+     *
+     * @param token The check unique token
+     * @param options Metrics options
+     */
+    getMetrics(token, options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const endpoint = Endpoints_1.Endpoint.Checks.metrics(token);
+            const { data } = yield this.apiClient.get(endpoint, { params: options });
+            return data;
+        });
+    }
+    /**
+     * Set a new API URL.
+     * @param newURL The new API url
+     */
+    setApiUrl(newURL) {
+        this.apiClient.setBaseURL(newURL);
+    }
+    /**
+     * Update a check.
+     * @param token The check unique token
+     * @param options Further check updating options
+     */
+    updateCheck(token, options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const endpoint = Endpoints_1.Endpoint.checks(token);
+            const { data } = yield this.apiClient.put(endpoint, ChecksAPI.mapCheckOptions(options));
+            return data;
+        });
+    }
+}
+exports.ChecksAPI = ChecksAPI;

package/dist/api/NodesAPI.d.ts

@@ -0,0 +1,19 @@
+import type { APIClient } from '@ffflorian/api-client';
+import type { Nodes } from '../interfaces';
+export declare class NodesAPI {
+    private readonly apiClient;
+    constructor(apiClient: APIClient);
+    /** List all updown.io monitoring nodes IPv4 addresses. */
+    getIps(): Promise<string[]>;
+    /** List all updown.io monitoring nodes IPv4 addresses. */
+    getIpv4Nodes(): Promise<string[]>;
+    /** List all updown.io monitoring nodes IPv6 addresses. */
+    getIpv6Nodes(): Promise<string[]>;
+    /** List all updown.io monitoring nodes. */
+    getNodes(): Promise<Nodes>;
+    /**
+     * Set a new API URL.
+     * @param newURL The new API url
+     */
+    setApiUrl(newURL: string): void;
+}

package/dist/api/NodesAPI.js

@@ -0,0 +1,58 @@
+"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.NodesAPI = void 0;
+const Endpoints_1 = require("../Endpoints");
+class NodesAPI {
+    constructor(apiClient) {
+        this.apiClient = apiClient;
+    }
+    /** List all updown.io monitoring nodes IPv4 addresses. */
+    getIps() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const endpoint = Endpoints_1.Endpoint.Nodes.ips();
+            const { data } = yield this.apiClient.get(endpoint);
+            return data;
+        });
+    }
+    /** List all updown.io monitoring nodes IPv4 addresses. */
+    getIpv4Nodes() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const endpoint = Endpoints_1.Endpoint.Nodes.ipv4();
+            const { data } = yield this.apiClient.get(endpoint);
+            return data;
+        });
+    }
+    /** List all updown.io monitoring nodes IPv6 addresses. */
+    getIpv6Nodes() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const endpoint = Endpoints_1.Endpoint.Nodes.ipv6();
+            const { data } = yield this.apiClient.get(endpoint);
+            return data;
+        });
+    }
+    /** List all updown.io monitoring nodes. */
+    getNodes() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const endpoint = Endpoints_1.Endpoint.nodes();
+            const { data } = yield this.apiClient.get(endpoint);
+            return data;
+        });
+    }
+    /**
+     * Set a new API URL.
+     * @param newURL The new API url
+     */
+    setApiUrl(newURL) {
+        this.apiClient.setBaseURL(newURL);
+    }
+}
+exports.NodesAPI = NodesAPI;

package/dist/api/RecipientsAPI.d.ts

@@ -0,0 +1,17 @@
+import type { APIClient } from '@ffflorian/api-client';
+import type { Deleted, Recipient, RecipientOptions } from '../interfaces';
+export declare class RecipientsAPI {
+    private readonly apiClient;
+    constructor(apiClient: APIClient);
+    /** Add a new recipient. */
+    addRecipient(options: RecipientOptions): Promise<Recipient>;
+    /** Delete a recipient. */
+    deleteRecipient(id: string): Promise<Deleted>;
+    /** List all possible alert recipients/channels on your account. */
+    getRecipients(): Promise<Recipient[]>;
+    /**
+     * Set a new API URL.
+     * @param newURL The new API url
+     */
+    setApiUrl(newURL: string): void;
+}

package/dist/api/RecipientsAPI.js

@@ -0,0 +1,50 @@
+"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.RecipientsAPI = void 0;
+const Endpoints_1 = require("../Endpoints");
+class RecipientsAPI {
+    constructor(apiClient) {
+        this.apiClient = apiClient;
+    }
+    /** Add a new recipient. */
+    addRecipient(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const endpoint = Endpoints_1.Endpoint.recipients();
+            const { data } = yield this.apiClient.post(endpoint, options);
+            return data;
+        });
+    }
+    /** Delete a recipient. */
+    deleteRecipient(id) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const endpoint = Endpoints_1.Endpoint.recipients(id);
+            const { data } = yield this.apiClient.delete(endpoint);
+            return data;
+        });
+    }
+    /** List all possible alert recipients/channels on your account. */
+    getRecipients() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const endpoint = Endpoints_1.Endpoint.recipients();
+            const { data } = yield this.apiClient.get(endpoint);
+            return data;
+        });
+    }
+    /**
+     * Set a new API URL.
+     * @param newURL The new API url
+     */
+    setApiUrl(newURL) {
+        this.apiClient.setBaseURL(newURL);
+    }
+}
+exports.RecipientsAPI = RecipientsAPI;

package/dist/api/StatusPagesAPI.d.ts

@@ -0,0 +1,19 @@
+import type { APIClient } from '@ffflorian/api-client';
+import type { Deleted, StatusPage, StatusPageOptions } from '../interfaces';
+export declare class StatusPagesAPI {
+    private readonly apiClient;
+    constructor(apiClient: APIClient);
+    /** Add a new status page. */
+    addStatusPage(options: StatusPageOptions): Promise<StatusPage>;
+    /** Delete a status page. */
+    deleteStatusPage(token: string): Promise<Deleted>;
+    /** List all status pages. */
+    getStatusPages(): Promise<StatusPage[]>;
+    /**
+     * Set a new API URL.
+     * @param newURL The new API url
+     */
+    setApiUrl(newURL: string): void;
+    /** Update a status page. */
+    updateStatusPage(token: string, options: StatusPageOptions): Promise<StatusPage>;
+}

package/dist/api/StatusPagesAPI.js

@@ -0,0 +1,58 @@
+"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.StatusPagesAPI = void 0;
+const Endpoints_1 = require("../Endpoints");
+class StatusPagesAPI {
+    constructor(apiClient) {
+        this.apiClient = apiClient;
+    }
+    /** Add a new status page. */
+    addStatusPage(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const endpoint = Endpoints_1.Endpoint.statusPages();
+            const { data } = yield this.apiClient.post(endpoint, options);
+            return data;
+        });
+    }
+    /** Delete a status page. */
+    deleteStatusPage(token) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const endpoint = Endpoints_1.Endpoint.statusPages(token);
+            const { data } = yield this.apiClient.delete(endpoint);
+            return data;
+        });
+    }
+    /** List all status pages. */
+    getStatusPages() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const endpoint = Endpoints_1.Endpoint.statusPages();
+            const { data } = yield this.apiClient.get(endpoint);
+            return data;
+        });
+    }
+    /**
+     * Set a new API URL.
+     * @param newURL The new API url
+     */
+    setApiUrl(newURL) {
+        this.apiClient.setBaseURL(newURL);
+    }
+    /** Update a status page. */
+    updateStatusPage(token, options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const endpoint = Endpoints_1.Endpoint.statusPages(token);
+            const { data } = yield this.apiClient.put(endpoint, options);
+            return data;
+        });
+    }
+}
+exports.StatusPagesAPI = StatusPagesAPI;

package/dist/api/index.d.ts

@@ -0,0 +1,4 @@
+export * from './ChecksAPI';
+export * from './NodesAPI';
+export * from './RecipientsAPI';
+export * from './StatusPagesAPI';

package/dist/api/index.js

@@ -0,0 +1,20 @@
+"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("./ChecksAPI"), exports);
+__exportStar(require("./NodesAPI"), exports);
+__exportStar(require("./RecipientsAPI"), exports);
+__exportStar(require("./StatusPagesAPI"), exports);

package/dist/index.d.ts

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

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("./UpdownIO"), exports);

package/dist/interfaces/API.d.ts

@@ -0,0 +1,7 @@
+import { ChecksAPI, NodesAPI, RecipientsAPI, StatusPagesAPI } from '../api/';
+export interface API {
+    checks: ChecksAPI;
+    nodes: NodesAPI;
+    recipients: RecipientsAPI;
+    statusPages: StatusPagesAPI;
+}

package/dist/interfaces/API.js

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

package/dist/interfaces/Check.d.ts

@@ -0,0 +1,40 @@
+import type { CustomHeaders } from './Options';
+export interface Check {
+    alias: string;
+    apdex_t: number;
+    created_at: string;
+    custom_headers: CustomHeaders;
+    disabled_locations: string[];
+    domain?: {
+        expires_at: string;
+        remaining_days: number;
+        source: string;
+        tested_at: string;
+    };
+    down: boolean;
+    down_since: null | string;
+    enabled: boolean;
+    error: null | string;
+    favicon_url: null | string;
+    http_body: string;
+    http_verb: string;
+    last_check_at: string;
+    last_status: null | number;
+    mute_until: null | string;
+    next_check_at: string;
+    period: number;
+    published: boolean;
+    recipients: string[];
+    ssl: {
+        error: null | string;
+        expires_at?: string;
+        tested_at: string;
+        valid: boolean;
+    };
+    string_match: string;
+    token: string;
+    type: string;
+    up_since: null | string;
+    uptime: number;
+    url: string;
+}

package/dist/interfaces/Check.js

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

package/dist/interfaces/Deleted.d.ts

@@ -0,0 +1,3 @@
+export interface Deleted {
+    deleted: boolean;
+}

package/dist/interfaces/Deleted.js

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

package/dist/interfaces/Downtime.d.ts

@@ -0,0 +1,9 @@
+export interface Downtime {
+    details_url: string;
+    duration: number;
+    ended_at: null | string;
+    error: string;
+    id: string;
+    partial: boolean;
+    started_at: string;
+}

package/dist/interfaces/Downtime.js

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

package/dist/interfaces/Metrics.d.ts

@@ -0,0 +1,26 @@
+export interface Metrics {
+    apdex: number;
+    requests: {
+        by_response_time: {
+            under1000: number;
+            under125: number;
+            under2000: number;
+            under250: number;
+            under4000: number;
+            under500: number;
+        };
+        failures: number;
+        samples: number;
+        satisfied: number;
+        tolerated: number;
+    };
+    timings: {
+        connection: number;
+        handshake: number;
+        namelookup: number;
+        redirect: number;
+        response: number;
+        total: number;
+    };
+    uptime?: number;
+}

package/dist/interfaces/Metrics.js

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

package/dist/interfaces/Nodes.d.ts

@@ -0,0 +1,11 @@
+export interface Nodes {
+    [name: string]: {
+        city: string;
+        country: string;
+        country_code: string;
+        ip: string;
+        ip6: string;
+        lat: number;
+        lng: number;
+    };
+}

package/dist/interfaces/Nodes.js

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

package/dist/interfaces/Options.d.ts

@@ -0,0 +1,95 @@
+export interface CheckOptions {
+    /** Human readable name */
+    alias?: string;
+    /** APDEX threshold in seconds (0.125, 0.25, 0.5, 1.0 or 2.0) */
+    apdex_t?: number;
+    custom_headers?: CustomHeaders;
+    /** The HTTP headers you want in updown requests. Ex: custom_headers[X-Api-Key]=xxxxxxxxx */
+    customHeaders?: CustomHeaders;
+    disabled_locations?: string[];
+    /** Disabled monitoring locations. It's an array of abbreviated location names. Can be any of these: ["lan", "mia", "bhs", "gra", "fra", "sin", "tok", "syd"]. Ex: disabled_locations[]=lan&disabled_locations[]=syd */
+    disabledLocations?: string[];
+    /** Is the check enabled (true or false) */
+    enabled?: boolean;
+    /** The HTTP body sent alongside the request */
+    http_body?: string;
+    /** The HTTP verb used to perform the request */
+    http_verb?: HttpVerb;
+    /** Mute notifications until given time, accepts a time, 'recovery' or 'forever' */
+    mute_until?: string;
+    /** Interval in seconds (15, 30, 60, 120, 300, 600, 1800 or 3600) */
+    period?: number;
+    /** Shall the status page be public (true or false) */
+    published?: boolean;
+    /** Selected alert recipients */
+    recipients?: string[];
+    /** Search for this string in the page */
+    string_match?: string;
+    /** The type of check to create */
+    type?: CheckType;
+}
+export type CheckType = 'http' | 'https' | 'icmp' | 'pulse' | 'tcp' | 'tcps';
+export interface ClientOptions {
+    apiKey: string;
+    apiUrl?: string;
+}
+export interface CustomHeaders {
+    [key: string]: boolean | number | string;
+}
+export type HttpMethod = 'delete' | 'get' | 'post' | 'put';
+export type HttpVerb = 'DELETE' | 'GET/HEAD' | 'OPTIONS' | 'PATCH' | 'POST' | 'PUT';
+export type MetricsGroup = 'host' | 'time';
+export interface MetricsOptions {
+    /** Start time, default to 1 month ago */
+    from?: string;
+    /** Group data by 'time' (hour) or 'host' (location) */
+    group: MetricsGroup;
+    /** End time, default to now */
+    to?: string;
+}
+export interface RecipientOptions {
+    /** Optional user-friendly label for supported recipient types */
+    name?: string;
+    /** Initial state on all existing checks */
+    selected?: boolean;
+    /** Type of recipient */
+    type: RecipientType;
+    /** Recipient value (email, phone or URL) */
+    value: string;
+}
+export type RecipientType = 'email' | 'msteams' | 'slack_compatible' | 'sms' | 'webhook';
+export interface RequestOptions {
+    alias?: string;
+    apdex_t?: number;
+    'api-key'?: string;
+    custom_headers?: CustomHeaders;
+    disabled_locations?: string[];
+    enabled?: boolean;
+    from?: string;
+    group?: MetricsGroup;
+    http_body?: string;
+    http_verb?: HttpVerb;
+    metrics?: boolean;
+    mute_until?: string;
+    page?: number;
+    period?: number;
+    published?: boolean;
+    recipients?: string[];
+    string_match?: string;
+    to?: string;
+    type?: CheckType;
+    url?: string;
+}
+export interface StatusPageOptions {
+    /** Access key for protected pages */
+    access_key?: string;
+    /** List of checks to show in the page */
+    checks?: string[];
+    /** Description text */
+    description?: string;
+    /** Name of the status page */
+    name?: string;
+    /** Page visibility */
+    visibility?: StatusPageVisibility;
+}
+export type StatusPageVisibility = 'private' | 'protected' | 'public';

package/dist/interfaces/Options.js

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

package/dist/interfaces/Recipient.d.ts

@@ -0,0 +1,8 @@
+import type { RecipientType } from './Options';
+export interface Recipient {
+    id: string;
+    immutable?: boolean;
+    name?: string;
+    type: RecipientType;
+    value?: string;
+}

package/dist/interfaces/Recipient.js

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

package/dist/interfaces/StatusPage.d.ts

@@ -0,0 +1,10 @@
+import type { StatusPageVisibility } from './Options';
+export interface StatusPage {
+    access_key: null | string;
+    checks: string[];
+    description: null | string;
+    name: string;
+    token: string;
+    url: string;
+    visibility: StatusPageVisibility;
+}

package/dist/interfaces/StatusPage.js

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

package/dist/interfaces/index.d.ts

@@ -0,0 +1,9 @@
+export * from './API';
+export * from './Check';
+export * from './Deleted';
+export * from './Downtime';
+export * from './Metrics';
+export * from './Nodes';
+export * from './Options';
+export * from './Recipient';
+export * from './StatusPage';

package/dist/interfaces/index.js

@@ -0,0 +1,25 @@
+"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("./Check"), exports);
+__exportStar(require("./Deleted"), exports);
+__exportStar(require("./Downtime"), exports);
+__exportStar(require("./Metrics"), exports);
+__exportStar(require("./Nodes"), exports);
+__exportStar(require("./Options"), exports);
+__exportStar(require("./Recipient"), exports);
+__exportStar(require("./StatusPage"), exports);

package/package.json

@@ -1,14 +1,16 @@
 {
   "author": "Florian Imdahl <git@ffflorian.de>",
   "dependencies": {
-    "@ffflorian/api-client": "2.5.0"
+    "@ffflorian/api-client": "2.5.1"
   },
   "description": "An updown.io API client",
   "devDependencies": {
     "@types/node": "~24",
+    "nock": "14.0.12",
     "rimraf": "6.1.3",
-    "typedoc": "0.28.18",
-    "typescript": "6.0.2"
+    "typedoc": "0.28.19",
+    "typescript": "6.0.3",
+    "vitest": "4.1.4"
   },
   "engines": {
     "node": ">= 21"
@@ -29,11 +31,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/updown.io src/index.ts",
     "clean": "rimraf dist",
-    "dist": "yarn clean && yarn build:ts",
-    "test": "exit 0"
+    "dist": "yarn clean && yarn build",
+    "test": "vitest"
   },
-  "version": "3.4.6"
+  "version": "3.5.0"
 }