umami-api-js 0.0.2 → 0.0.4

package/README.md

@@ -1,5 +1,4 @@
 A package to interact with [the API of self-hosted instances of Umami v2.19.0](https://umami.is/docs/api). It is a lightweight alternative to [@umami/api-client](https://github.com/umami-software/api-client), forked from [osu-api-v2-js](https://github.com/TTTaevas/osu-api-v2-js).
 
-Please note that this package is not expected to work with Umami Cloud, the instance of Umami hosted by its creators.
+Please note that this package is expected to work with self-hosted instances of **Umami v2.19.0**, and is *not* expected to work with [Umami Cloud](https://umami.is/docs/cloud), the instance of Umami hosted by its creators.
 
-Please also note that this is currently being built mainly to serve as a component to my [taevas.xyz](https://codeberg.org/Taevas/taevas.xyz) project, meaning it currently doesn't perfectly cover the API!

package/dist/index.d.ts

@@ -1,21 +1,53 @@
 import { Admin } from "./namespaces/Admin.js";
 import { Events } from "./namespaces/Events.js";
 import { Realtime } from "./namespaces/Realtime.js";
+import { Reports } from "./namespaces/Reports.js";
+import { Sessions } from "./namespaces/Sessions.js";
 import { Teams } from "./namespaces/Teams.js";
 import { Users } from "./namespaces/Users.js";
-export { Admin, Users, Teams, Events, Realtime };
+import { Websites } from "./namespaces/Websites.js";
+import { WebsiteStats } from "./namespaces/WebsiteStats.js";
+export { Admin, Users, Teams, Events, Sessions, Websites, WebsiteStats, Realtime, Reports };
 export interface ValueAndPrev {
     /** The actual value for the given time period */
     value: number;
     /** The value for the same *timespan* for the time period that ends where the time period for value starts  */
     prev: number;
 }
+export interface MinimalUser {
+    id: string;
+    username: string;
+}
 export interface GenericObject {
     id: string;
     createdAt: Date;
     updatedAt: Date | null;
     deletedAt: Date | null;
 }
+export interface Website extends GenericObject {
+    name: string;
+    domain: string;
+    shareId: string | null;
+    resetAt: Date | null;
+    userId: string;
+    teamId: string | null;
+    createdBy: string;
+}
+export interface Report extends Omit<GenericObject, "deletedAt"> {
+    userId: string;
+    websiteId: string;
+    type: string;
+    name: string;
+    description: string;
+    parameters: {
+        type: string;
+        value: string;
+    };
+}
+export interface NameValue {
+    name: string;
+    value: number;
+}
 export interface GenericRequestParameters {
     /** Search text */
     search?: string;
@@ -24,6 +56,54 @@ export interface GenericRequestParameters {
     /** Determines how many results to return **(default: 20)** */
     pageSize?: number;
 }
+export interface Timestamps {
+    /** Timestamp of starting date */
+    startAt: Date | number;
+    /** Timestamp of end date */
+    endAt: Date | number;
+}
+export interface XTY {
+    /** Event name */
+    x: string;
+    /** Timestamp */
+    t: Date;
+    /** Number of events */
+    y: number;
+}
+/**
+ * Many endpoints can make use of the filters in this interface
+ * @remarks As defined in the server documentation for the Endpoints in: Events, Sessions, Website stats, Reports
+ */
+export interface Filters {
+    /** Name of URL */
+    path?: string;
+    /** Name of referrer */
+    referrer?: string;
+    /** Name of page title */
+    title?: string;
+    /** Name of query parameter */
+    query?: string;
+    /** Name of browser */
+    browser?: string;
+    /** Name of operating system */
+    os?: string;
+    /** Name of device (ex. Mobile) */
+    device?: string;
+    /** Name of country */
+    country?: string;
+    /** Name of region/state/province */
+    region?: string;
+    /** Name of city */
+    city?: string;
+    /** Name of hostname */
+    hostname?: string;
+    /** Name of tag */
+    tag?: string;
+    /** UUID of segment */
+    segment?: string;
+    /** UUID of cohort */
+    cohort?: string;
+}
 export type Role = "admin" | "user" | "view-only";
 export type TeamRole = "team-manager" | "team-member" | "team-view-only";
 /** If the {@link API} throws an error, it should always be an {@link APIError}! */
@@ -106,9 +186,9 @@ export declare class API {
     /** If {@link API.setNewToken} has been called, you can wait for it to be done through this promise */
     private token_promise;
     /**
-     * This creates a new {@link API.token}, alongside a new {@link API.refresh_token} if arguments are provided or if a refresh_token already exists
+     * This contacts the server in order to get and set a new {@link API.token}!
      * @remarks The API object requires a {@link API.username} and a {@link API.password} to successfully get any token
-     * @returns Whether or not the token has changed (this should never throw)
+     * @returns Whether or not the token has changed (**should be true** as otherwise the server would complain and an {@link APIError} would be thrown to give you some details)
      */
     setNewToken(): Promise<boolean>;
     private _set_token_on_401;
@@ -186,12 +266,12 @@ export declare class API {
      * @param method The type of request, each endpoint uses a specific one (if it uses multiple, the intent and parameters become different)
      * @param endpoint What comes in the URL after `api/`, **DO NOT USE TEMPLATE LITERALS (\`) OR THE ADDITION OPERATOR (+), put everything separately for type safety**
      * @param parameters The things to specify in the request, such as the beatmap_id when looking for a beatmap
-     * @param settings Additional settings **to add** to the current settings of the `fetch()` request
      * @returns A Promise with the API's response
      */
     request(method: "get" | "post" | "put" | "delete", endpoint: Array<string | number>, parameters?: {
         [k: string]: any;
     }): Promise<any>;
+    /** @remarks To be replaced by {@link API.getWebsiteStats2}, no deprecation warning as the new method is unreliable */
     getWebsiteStats(website_id: string, startAt: Date, endAt: Date): Promise<{
         pageviews: ValueAndPrev;
         visitors: ValueAndPrev;
@@ -227,5 +307,39 @@ export declare class API {
     readonly getWebsiteEventsDataProperties: typeof Events.getWebsiteEventsDataProperties;
     readonly getWebsiteEventsDataValues: typeof Events.getWebsiteEventsDataValues;
     readonly getWebsiteEventsDataStats: typeof Events.getWebsiteEventsDataStats;
+    readonly getWebsiteSessions: typeof Sessions.getWebsiteSessions;
+    readonly getWebsiteSessionsStats: typeof Sessions.getWebsiteSessionsStats;
+    readonly getWebsiteSessionsWeekly: typeof Sessions.getWebsiteSessionsWeekly;
+    readonly getWebsiteSession: typeof Sessions.getWebsiteSession;
+    readonly getWebsiteSessionActivity: typeof Sessions.getWebsiteSessionActivity;
+    readonly getWebsiteSessionProperties: typeof Sessions.getWebsiteSessionProperties;
+    readonly getWebsiteSessionDataProperties: typeof Sessions.getWebsiteSessionDataProperties;
+    readonly getWebsiteSessionDataValues: typeof Sessions.getWebsiteSessionDataValues;
+    readonly getWebsites: typeof Websites.getWebsites;
+    readonly createWebsite: typeof Websites.createWebsite;
+    readonly getWebsite: typeof Websites.getWebsite;
+    readonly updateWebsite: typeof Websites.updateWebsite;
+    readonly deleteWebsite: typeof Websites.deleteWebsite;
+    readonly resetWebsite: typeof Websites.resetWebsite;
+    readonly getWebsiteActiveVisitors: typeof WebsiteStats.getWebsiteActiveVisitors;
+    readonly getWebsiteEventsStats: typeof WebsiteStats.getWebsiteEvents;
+    readonly getWebsiteMetrics: typeof WebsiteStats.getWebsiteMetrics;
+    readonly getWebsiteMetricsExpanded: typeof WebsiteStats.getWebsiteMetricsExpanded;
+    readonly getWebsitePageviews: typeof WebsiteStats.getWebsitePageviews;
+    /** @remarks Will replace {@link API.getWebsiteStats}, which you should use for a reliable experience */
+    readonly getWebsiteStats2: typeof WebsiteStats.getWebsiteStats;
     readonly getRealtime: typeof Realtime.getRealtime;
+    readonly getReports: typeof Reports.getReports;
+    readonly createReport: typeof Reports.createReport;
+    readonly getReport: typeof Reports.getReport;
+    readonly updateReport: typeof Reports.updateReport;
+    readonly deleteReport: typeof Reports.deleteReport;
+    readonly getReportsAttribution: typeof Reports.getReportsAttribution;
+    readonly getReportsBreakdown: typeof Reports.getReportsBreakdown;
+    readonly getReportsFunnel: typeof Reports.getReportsFunnel;
+    readonly getReportsGoals: typeof Reports.getReportsGoals;
+    readonly getReportsJourney: typeof Reports.getReportsJourney;
+    readonly getReportsRetention: typeof Reports.getReportsRetention;
+    readonly getReportsRevenue: typeof Reports.getReportsRevenue;
+    readonly getReportsUTM: typeof Reports.getReportsUTM;
 }

package/dist/index.js

@@ -1,10 +1,14 @@
 import { Admin } from "./namespaces/Admin.js";
 import { Events } from "./namespaces/Events.js";
 import { Realtime } from "./namespaces/Realtime.js";
+import { Reports } from "./namespaces/Reports.js";
+import { Sessions } from "./namespaces/Sessions.js";
 import { Teams } from "./namespaces/Teams.js";
 import { Users } from "./namespaces/Users.js";
+import { Websites } from "./namespaces/Websites.js";
+import { WebsiteStats } from "./namespaces/WebsiteStats.js";
 import { adaptParametersForGETRequests, correctType } from "./utilities.js";
-export { Admin, Users, Teams, Events, Realtime };
+export { Admin, Users, Teams, Events, Sessions, Websites, WebsiteStats, Realtime, Reports };
 /** If the {@link API} throws an error, it should always be an {@link APIError}! */
 export class APIError extends Error {
     message;
@@ -109,9 +113,9 @@ export class API {
     /** If {@link API.setNewToken} has been called, you can wait for it to be done through this promise */
     token_promise = new Promise(r => r);
     /**
-     * This creates a new {@link API.token}, alongside a new {@link API.refresh_token} if arguments are provided or if a refresh_token already exists
+     * This contacts the server in order to get and set a new {@link API.token}!
      * @remarks The API object requires a {@link API.username} and a {@link API.password} to successfully get any token
-     * @returns Whether or not the token has changed (this should never throw)
+     * @returns Whether or not the token has changed (**should be true** as otherwise the server would complain and an {@link APIError} would be thrown to give you some details)
      */
     async setNewToken() {
         const old_token = this.token;
@@ -265,6 +269,9 @@ export class API {
         let error_message = "no error message available";
         if (!is_token_related)
             await this.token_promise.catch(() => this.token_promise = new Promise(r => r));
+        for (const [p, v] of Object.entries(parameters)) {
+            parameters[p] = v instanceof Date ? Number(v) : v; // Convert Dates to ms
+        }
         let url = `${this.server}`;
         if (url.slice(-1) !== "/")
             url += "/";
@@ -346,7 +353,6 @@ export class API {
      * @param method The type of request, each endpoint uses a specific one (if it uses multiple, the intent and parameters become different)
      * @param endpoint What comes in the URL after `api/`, **DO NOT USE TEMPLATE LITERALS (\`) OR THE ADDITION OPERATOR (+), put everything separately for type safety**
      * @param parameters The things to specify in the request, such as the beatmap_id when looking for a beatmap
-     * @param settings Additional settings **to add** to the current settings of the `fetch()` request
      * @returns A Promise with the API's response
      */
     async request(method, endpoint, parameters = {}) {
@@ -372,8 +378,9 @@ export class API {
             throw new APIError(`${e?.name} (${e?.message ?? e?.errno ?? e?.type})`, this.server, method, endpoint, parameters, undefined, e);
         }
     }
+    /** @remarks To be replaced by {@link API.getWebsiteStats2}, no deprecation warning as the new method is unreliable */
     async getWebsiteStats(website_id, startAt, endAt) {
-        return await this.request("get", ["websites", website_id, "stats"], { startAt: Number(startAt), endAt: Number(endAt) });
+        return await this.request("get", ["websites", website_id, "stats"], { startAt, endAt });
     }
     // ADMIN
     getUsersAsAdmin = Admin.getUsers;
@@ -407,6 +414,44 @@ export class API {
     getWebsiteEventsDataProperties = Events.getWebsiteEventsDataProperties;
     getWebsiteEventsDataValues = Events.getWebsiteEventsDataValues;
     getWebsiteEventsDataStats = Events.getWebsiteEventsDataStats;
+    // SESSIONS
+    getWebsiteSessions = Sessions.getWebsiteSessions;
+    getWebsiteSessionsStats = Sessions.getWebsiteSessionsStats;
+    getWebsiteSessionsWeekly = Sessions.getWebsiteSessionsWeekly;
+    getWebsiteSession = Sessions.getWebsiteSession;
+    getWebsiteSessionActivity = Sessions.getWebsiteSessionActivity;
+    getWebsiteSessionProperties = Sessions.getWebsiteSessionProperties;
+    getWebsiteSessionDataProperties = Sessions.getWebsiteSessionDataProperties;
+    getWebsiteSessionDataValues = Sessions.getWebsiteSessionDataValues;
+    // WEBSITES
+    getWebsites = Websites.getWebsites;
+    createWebsite = Websites.createWebsite;
+    getWebsite = Websites.getWebsite;
+    updateWebsite = Websites.updateWebsite;
+    deleteWebsite = Websites.deleteWebsite;
+    resetWebsite = Websites.resetWebsite;
+    // WEBSITE STATS
+    getWebsiteActiveVisitors = WebsiteStats.getWebsiteActiveVisitors;
+    getWebsiteEventsStats = WebsiteStats.getWebsiteEvents;
+    getWebsiteMetrics = WebsiteStats.getWebsiteMetrics;
+    getWebsiteMetricsExpanded = WebsiteStats.getWebsiteMetricsExpanded;
+    getWebsitePageviews = WebsiteStats.getWebsitePageviews;
+    /** @remarks Will replace {@link API.getWebsiteStats}, which you should use for a reliable experience */
+    getWebsiteStats2 = WebsiteStats.getWebsiteStats;
     // REALTIME
     getRealtime = Realtime.getRealtime;
+    // REPORTS
+    getReports = Reports.getReports;
+    createReport = Reports.createReport;
+    getReport = Reports.getReport;
+    updateReport = Reports.updateReport;
+    deleteReport = Reports.deleteReport;
+    getReportsAttribution = Reports.getReportsAttribution;
+    getReportsBreakdown = Reports.getReportsBreakdown;
+    getReportsFunnel = Reports.getReportsFunnel;
+    getReportsGoals = Reports.getReportsGoals;
+    getReportsJourney = Reports.getReportsJourney;
+    getReportsRetention = Reports.getReportsRetention;
+    getReportsRevenue = Reports.getReportsRevenue;
+    getReportsUTM = Reports.getReportsUTM;
 }

package/dist/namespaces/Admin.d.ts

@@ -1,4 +1,4 @@
-import { API, GenericObject, GenericRequestParameters, Role, Teams } from "../index.js";
+import { API, GenericObject, GenericRequestParameters, MinimalUser, Role, Teams, Website } from "../index.js";
 /** For endpoints listed on: https://umami.is/docs/api/admin-api */
 export declare namespace Admin {
     /** Returns all users: https://umami.is/docs/api/admin-api#get-apiadminusers */
@@ -18,18 +18,8 @@ export declare namespace Admin {
      * Returns all websites: https://umami.is/docs/api/admin-api#get-apiadminwebsites
      * @remarks TODO Possibly doesn't work? (throws 400 on my end)
      */
-    function getWebsites(this: API, parameters?: GenericRequestParameters): Promise<(GenericObject & {
-        name: string;
-        domain: string;
-        shareId: number | null;
-        resetAt: Date | null;
-        userId: string;
-        teamid: string | null;
-        createdBy: string;
-        user: {
-            username: string;
-            id: string;
-        };
+    function getWebsites(this: API, parameters?: GenericRequestParameters): Promise<(Website & {
+        user: MinimalUser;
         /** @remarks TODO Documentation says it can be null but doesn't actually say what else it can be, ***presumed* to be string**, check */
         team: string | null;
     })[]>;

package/dist/namespaces/Events.d.ts

@@ -1,45 +1,8 @@
-import { API, GenericRequestParameters } from "../index.js";
+import { API, Filters, GenericRequestParameters, Timestamps } from "../index.js";
 /** For endpoints listed on: https://umami.is/docs/api/events-api */
 export declare namespace Events {
-    interface Timestamps {
-        /** Timestamp of starting date */
-        startAt: Date | number;
-        /** Timestamp of end date */
-        endAt: Date | number;
-    }
-    /** Many endpoints can make use of the filters in this interface: https://umami.is/docs/api/events-api#filters */
-    interface FiltersAndTimestamps extends Timestamps {
-        /** Name of URL */
-        path?: string;
-        /** Name of referrer */
-        referrer?: string;
-        /** Name of page title */
-        title?: string;
-        /** Name of query parameter */
-        query?: string;
-        /** Name of browser */
-        browser?: string;
-        /** Name of operating system */
-        os?: string;
-        /** Name of device (ex. Mobile) */
-        device?: string;
-        /** Name of country */
-        country?: string;
-        /** Name of region/state/province */
-        region?: string;
-        /** Name of city */
-        city?: string;
-        /** Name of hostname */
-        hostname?: string;
-        /** Name of tag */
-        tag?: string;
-        /** UUID of segment */
-        segment?: string;
-        /** UUID of cohort */
-        cohort?: string;
-    }
     /** Gets website event details within a given time range: https://umami.is/docs/api/events-api#get-apiwebsiteswebsiteidevents (TODO UNTESTED) */
-    function getWebsiteEvents(this: API, websiteId: string, parameters: FiltersAndTimestamps & GenericRequestParameters): Promise<{
+    function getWebsiteEvents(this: API, websiteId: string, parameters: Filters & Timestamps & GenericRequestParameters): Promise<{
         id: string;
         websiteId: string;
         sessionId: string;
@@ -75,7 +38,7 @@ export declare namespace Events {
         createdAt: Date;
     }[]>;
     /** Gets event data names, properties, and counts: https://umami.is/docs/api/events-api#get-apiwebsiteswebsiteidevent-dataevents (TODO UNTESTED) */
-    function getWebsiteEventsData(this: API, websiteId: string, parameters: FiltersAndTimestamps & {
+    function getWebsiteEventsData(this: API, websiteId: string, parameters: Filters & Timestamps & {
         /** Event name filter */
         event?: string;
     }): Promise<{
@@ -85,20 +48,20 @@ export declare namespace Events {
         total: number;
     }[]>;
     /** Gets event data property and value counts within a given time range: https://umami.is/docs/api/events-api#get-apiwebsiteswebsiteidevent-datafields (TODO UNTESTED) */
-    function getWebsiteEventsDataFields(this: API, websiteId: string, parameters: FiltersAndTimestamps): Promise<{
+    function getWebsiteEventsDataFields(this: API, websiteId: string, parameters: Filters & Timestamps): Promise<{
         propertyName: string;
         dataType: number;
         value: string;
         total: number;
     }[]>;
     /** Gets event name and property counts for a website: https://umami.is/docs/api/events-api#get-apiwebsiteswebsiteidevent-dataproperties (TODO UNTESTED) */
-    function getWebsiteEventsDataProperties(this: API, websiteId: string, parameters: FiltersAndTimestamps): Promise<{
+    function getWebsiteEventsDataProperties(this: API, websiteId: string, parameters: Filters & Timestamps): Promise<{
         eventName: string;
         propertyName: string;
         total: number;
     }[]>;
     /** Gets event data counts for a given event and property: https://umami.is/docs/api/events-api#get-apiwebsiteswebsiteidevent-datavalues (TODO UNTESTED) */
-    function getWebsiteEventsDataValues(this: API, websiteId: string, parameters: FiltersAndTimestamps & {
+    function getWebsiteEventsDataValues(this: API, websiteId: string, parameters: Filters & Timestamps & {
         /** Event name filter */
         event: string;
         /** Property name */
@@ -108,7 +71,7 @@ export declare namespace Events {
         total: number;
     }>;
     /** Gets aggregated website events, properties, and records within a given time range https://umami.is/docs/api/events-api#get-apiwebsiteswebsiteidevent-datastats (TODO UNTESTED) */
-    function getWebsiteEventsDataStats(this: API, websiteId: string, parameters: FiltersAndTimestamps): Promise<{
+    function getWebsiteEventsDataStats(this: API, websiteId: string, parameters: Filters & Timestamps): Promise<{
         events: number;
         properties: number;
         records: number;

package/dist/namespaces/Events.js

@@ -3,10 +3,6 @@ export var Events;
 (function (Events) {
     /** Gets website event details within a given time range: https://umami.is/docs/api/events-api#get-apiwebsiteswebsiteidevents (TODO UNTESTED) */
     async function getWebsiteEvents(websiteId, parameters) {
-        if (parameters.startAt instanceof Date)
-            parameters.startAt = Number(parameters.startAt);
-        if (parameters.endAt instanceof Date)
-            parameters.endAt = Number(parameters.endAt);
         const response = await this.request("get", ["websites", websiteId, "events"], parameters);
         return response.data;
     }

package/dist/namespaces/Reports.d.ts

@@ -0,0 +1,146 @@
+import { API, Filters, GenericRequestParameters, NameValue, Report, Timestamps, XTY } from "../index.js";
+/** For endpoints listed on: https://umami.is/docs/api/reports-api */
+export declare namespace Reports {
+    type ReportType = {
+        type: "attribution" | "breakdown" | "funnel" | "goal" | "journey" | "retention" | "revenue" | "utm";
+    };
+    interface UTM {
+        utm: string;
+        views: number;
+    }
+    /** Get all reports by website ID: https://umami.is/docs/api/reports-api#get-apireports (TODO UNTESTED) */
+    function getReports(this: API, websiteId: string, parameters: ReportType & Omit<GenericRequestParameters, "search">): Promise<Report[]>;
+    /** Creates a report: https://umami.is/docs/api/reports-api#post-apireports (TODO UNTESTED) */
+    function createReport(this: API, websiteId: string, parameters: ReportType & {
+        /** Name of report */
+        name: string;
+        /** Description of report */
+        description?: string;
+        /** Parameters for report */
+        parameters?: any;
+    }): Promise<Report>;
+    /** Gets a report by ID: https://umami.is/docs/api/reports-api#get-apireportsreportid (TODO UNTESTED) */
+    function getReport(this: API, reportId: string): Promise<Report>;
+    /** Updates a report: https://umami.is/docs/api/reports-api#post-apireportsreportid (TODO UNTESTED) */
+    function updateReport(this: API, reportId: string, websiteId: string, parameters: ReportType & {
+        /** Name of report */
+        name: string;
+        /** Description of report */
+        description?: string;
+        /** Parameters for report */
+        parameters?: any;
+    }): Promise<Report>;
+    /** Deletes a report: https://umami.is/docs/api/reports-api#delete-apireportsreportid (TODO UNTESTED) */
+    function deleteReport(this: API, reportId: string): Promise<{
+        ok: boolean;
+    }>;
+    /** See how users engage with your marketing and what drives conversions: https://umami.is/docs/api/reports-api#post-apireportsattribution (TODO UNTESTED) */
+    function getReportsAttribution(this: API, websiteId: string, parameters: ReportType & Filters & Timestamps & {
+        /** Attribution model */
+        model: "firstClick" | "lastClick";
+        /** Conversion type */
+        type: ("path" | "event")[];
+        /** Conversion step */
+        step: string;
+    }): Promise<{
+        referrer: NameValue[];
+        paidAds: NameValue[];
+        utm_source: NameValue[];
+        utm_medium: NameValue[];
+        utm_campaign: NameValue[];
+        utm_content: NameValue[];
+        utm_term: NameValue[];
+        total: {
+            pageviews: number;
+            visitors: number;
+            visits: number;
+        };
+    }>;
+    /** Dive deeper into your data by using segments and filters: https://umami.is/docs/api/reports-api#post-apireportsbreakdown (TODO UNTESTED) */
+    function getReportsBreakdown(this: API, websiteId: string, parameters: ReportType & Filters & Timestamps & {
+        fields: ("path" | "title" | "query" | "referrer" | "browser" | "os" | "device" | "country" | "region" | "city" | "hostname" | "tag" | "event")[];
+    }): Promise<{
+        views: number;
+        visitors: number;
+        visits: number;
+        bounces: number;
+        totaltime: number;
+        os: string;
+        country: string;
+    }[]>;
+    /** Understand the conversion and drop-off rate of users: https://umami.is/docs/api/reports-api#post-apireportsfunnel (TODO UNTESTED) */
+    function getReportsFunnel(this: API, websiteId: string, parameters: ReportType & Filters & Timestamps & {
+        /** Type of event and conversion step */
+        steps: {
+            type: "path" | "event";
+            value: string;
+        }[];
+        /** Window of days between funnel steps to be considered a conversion */
+        window: number;
+    }): Promise<{
+        type: string;
+        value: string;
+        visitors: number;
+        previous: number;
+        dropped: number;
+        dropoff: number | null;
+        remaining: number;
+    }[]>;
+    /** Track your goals for pageviews and events: https://umami.is/docs/api/reports-api#post-apireportsgoals (TODO UNTESTED) */
+    function getReportsGoals(this: API, websiteId: string, parameters: ReportType & Filters & Timestamps & {
+        /** Conversion type */
+        type: ("path" | "event")[];
+        /** Conversion step value */
+        value: string;
+    }): Promise<{
+        num: number;
+        total: number;
+    }>;
+    /** Understand how users nagivate through your website: https://umami.is/docs/api/reports-api#post-apireportsjourney (TODO UNTESTED) */
+    function getReportsJourney(this: API, websiteId: string, parameters: ReportType & Filters & Timestamps & {
+        /** Number of steps from 3 to 7 */
+        steps: number;
+        /** Starting step URL or event name */
+        startStep: string;
+        /** Ending step URL or event name */
+        endStep?: string;
+    }): Promise<{
+        items: (string | null)[];
+        count: number;
+    }[]>;
+    /** Measure your website stickiness by tracking how often users return: https://umami.is/docs/api/reports-api#post-apireportsretention (TODO UNTESTED) */
+    function getReportsRetention(this: API, websiteId: string, parameters: ReportType & Filters & Timestamps & {
+        /** Timezone (ex. America/Los_Angeles) */
+        timezone: string;
+    }): Promise<{
+        date: Date;
+        day: number;
+        visitors: number;
+        returnVisitors: number;
+        percentage: number;
+    }[]>;
+    /** Get currency for given range. Needed for Revenue and optional in Attribution reports: https://umami.is/docs/api/reports-api#post-apireportsrevenue (TODO UNTESTED) */
+    function getReportsRevenue(this: API, websiteId: string, parameters: ReportType & Filters & Timestamps & {
+        /** Timezone (ex. America/Los_Angeles) */
+        timezone: string;
+        /** Currency code (ISO 4217) */
+        currency: string;
+    }): Promise<{
+        chart: XTY[];
+        country: NameValue[];
+        total: {
+            sum: number;
+            count: number;
+            unique_count: number;
+            average: number;
+        };
+    }>;
+    /** Track your campaigns through UTM parameters: https://umami.is/docs/api/reports-api#post-apireportsutm (TODO UNTESTED) */
+    function getReportsUTM(this: API, websiteId: string, parameters: ReportType & Filters & Timestamps): Promise<{
+        utm_source: UTM[];
+        utm_medium: UTM[];
+        utm_campaign: UTM[];
+        utm_term: UTM[];
+        utm_content: UTM[];
+    }>;
+}

package/dist/namespaces/Reports.js

@@ -0,0 +1,70 @@
+/** For endpoints listed on: https://umami.is/docs/api/reports-api */
+export var Reports;
+(function (Reports) {
+    /** Get all reports by website ID: https://umami.is/docs/api/reports-api#get-apireports (TODO UNTESTED) */
+    async function getReports(websiteId, parameters) {
+        const response = await this.request("get", ["reports"], { websiteId, ...parameters });
+        return response.data;
+    }
+    Reports.getReports = getReports;
+    /** Creates a report: https://umami.is/docs/api/reports-api#post-apireports (TODO UNTESTED) */
+    async function createReport(websiteId, parameters) {
+        return await this.request("post", ["reports"], { websiteId, ...parameters });
+    }
+    Reports.createReport = createReport;
+    /** Gets a report by ID: https://umami.is/docs/api/reports-api#get-apireportsreportid (TODO UNTESTED) */
+    async function getReport(reportId) {
+        return await this.request("get", ["reports", reportId]);
+    }
+    Reports.getReport = getReport;
+    /** Updates a report: https://umami.is/docs/api/reports-api#post-apireportsreportid (TODO UNTESTED) */
+    async function updateReport(reportId, websiteId, parameters) {
+        return await this.request("get", ["reports", reportId], { websiteId, ...parameters });
+    }
+    Reports.updateReport = updateReport;
+    /** Deletes a report: https://umami.is/docs/api/reports-api#delete-apireportsreportid (TODO UNTESTED) */
+    async function deleteReport(reportId) {
+        return await this.request("delete", ["reports", reportId]);
+    }
+    Reports.deleteReport = deleteReport;
+    /** See how users engage with your marketing and what drives conversions: https://umami.is/docs/api/reports-api#post-apireportsattribution (TODO UNTESTED) */
+    async function getReportsAttribution(websiteId, parameters) {
+        return await this.request("post", ["reports", "attribution"], { websiteId, ...parameters });
+    }
+    Reports.getReportsAttribution = getReportsAttribution;
+    /** Dive deeper into your data by using segments and filters: https://umami.is/docs/api/reports-api#post-apireportsbreakdown (TODO UNTESTED) */
+    async function getReportsBreakdown(websiteId, parameters) {
+        return await this.request("post", ["reports", "breakdown"], { websiteId, ...parameters });
+    }
+    Reports.getReportsBreakdown = getReportsBreakdown;
+    /** Understand the conversion and drop-off rate of users: https://umami.is/docs/api/reports-api#post-apireportsfunnel (TODO UNTESTED) */
+    async function getReportsFunnel(websiteId, parameters) {
+        return await this.request("post", ["reports", "funnel"], { websiteId, ...parameters });
+    }
+    Reports.getReportsFunnel = getReportsFunnel;
+    /** Track your goals for pageviews and events: https://umami.is/docs/api/reports-api#post-apireportsgoals (TODO UNTESTED) */
+    async function getReportsGoals(websiteId, parameters) {
+        return await this.request("post", ["reports", "goals"], { websiteId, ...parameters });
+    }
+    Reports.getReportsGoals = getReportsGoals;
+    /** Understand how users nagivate through your website: https://umami.is/docs/api/reports-api#post-apireportsjourney (TODO UNTESTED) */
+    async function getReportsJourney(websiteId, parameters) {
+        return await this.request("post", ["reports", "journey"], { websiteId, ...parameters });
+    }
+    Reports.getReportsJourney = getReportsJourney;
+    /** Measure your website stickiness by tracking how often users return: https://umami.is/docs/api/reports-api#post-apireportsretention (TODO UNTESTED) */
+    async function getReportsRetention(websiteId, parameters) {
+        return await this.request("post", ["reports", "retention"], { websiteId, ...parameters });
+    }
+    Reports.getReportsRetention = getReportsRetention;
+    /** Get currency for given range. Needed for Revenue and optional in Attribution reports: https://umami.is/docs/api/reports-api#post-apireportsrevenue (TODO UNTESTED) */
+    async function getReportsRevenue(websiteId, parameters) {
+        return await this.request("post", ["reports", "revenue"], { websiteId, ...parameters });
+    }
+    Reports.getReportsRevenue = getReportsRevenue;
+    /** Track your campaigns through UTM parameters: https://umami.is/docs/api/reports-api#post-apireportsutm (TODO UNTESTED) */
+    async function getReportsUTM(websiteId, parameters) {
+        return await this.request("post", ["reports", "utm"], { websiteId, ...parameters });
+    }
+    Reports.getReportsUTM = getReportsUTM;
+})(Reports || (Reports = {}));

package/dist/namespaces/Sessions.d.ts

@@ -0,0 +1,93 @@
+import { API, Filters, GenericRequestParameters, Timestamps } from "../index.js";
+/** For endpoints listed on: https://umami.is/docs/api/sessions-api */
+export declare namespace Sessions {
+    interface GenericSession {
+        id: string;
+        websiteId: string;
+        browser: string;
+        os: string;
+        device: string;
+        screen: string;
+        language: string;
+        country: string;
+        region: string;
+        city: string;
+        firstAt: Date;
+        lastAt: Date;
+        visits: number;
+        views: number;
+    }
+    /** Gets website session details within a given time range: https://umami.is/docs/api/sessions-api#get-apiwebsiteswebsiteidsessions (TODO UNTESTED) */
+    function getWebsiteSessions(this: API, websiteId: string, parameters: Filters & Timestamps & GenericRequestParameters): Promise<(GenericSession & {
+        hostname: string;
+        createdAt: Date;
+    })[]>;
+    /** Gets summarized website session statistics: https://umami.is/docs/api/sessions-api#get-apiwebsiteswebsiteidsessionsstats (TODO UNTESTED) */
+    function getWebsiteSessionsStats(this: API, websiteId: string, parameters: Filters & Timestamps): Promise<{
+        /** Pages hits */
+        pageviews: {
+            value: number;
+        };
+        /** Number of unique visitors */
+        visitors: {
+            value: number;
+        };
+        /** Number of unique visits */
+        visits: {
+            value: number;
+        };
+        /** Number of visitors who only visit a single page */
+        bounces: {
+            value: number;
+        };
+        /** Time spent on the website */
+        totaltime: {
+            value: number;
+        };
+    }>;
+    /** Get collected count of sessions by hour of weekday: https://umami.is/docs/api/sessions-api#get-apiwebsiteswebsiteidsessionsweekly (TODO UNTESTED) */
+    function getWebsiteSessionsWeekly(this: API, websiteId: string, parameters: Filters & Timestamps & {
+        timezone: string;
+    }): Promise<number[][]>;
+    /** Gets session details for a individual session: https://umami.is/docs/api/sessions-api#get-apiwebsiteswebsiteidsessionssessionid (TODO UNTESTED) */
+    function getWebsiteSession(this: API, websiteId: string, sessionId: string): Promise<GenericSession & {
+        distinctId: string;
+        events: number;
+        totaltime: number;
+    }>;
+    /** Gets session activity for a individual session: https://umami.is/docs/api/sessions-api#get-apiwebsiteswebsiteidsessionssessionidactivity (TODO UNTESTED) */
+    function getWebsiteSessionActivity(this: API, websiteId: string, sessionId: string, parameters: Timestamps): Promise<{
+        createdAt: Date;
+        urlPath: string;
+        urlQuery: string;
+        referrerDomain: string;
+        eventId: string;
+        eventType: number;
+        eventName: string;
+        visitId: string;
+        hasData: number;
+    }[]>;
+    /** Gets session properties for a individual session: https://umami.is/docs/api/sessions-api#get-apiwebsiteswebsiteidsessionssessionidproperties (TODO UNTESTED) */
+    function getWebsiteSessionProperties(this: API, websiteId: string, sessionId: string): Promise<{
+        websiteId: string;
+        sessionid: string;
+        dataKey: string;
+        dataType: number;
+        stringValue: string;
+        numberValue: number | null;
+        dateValue: Date | null;
+        createdAt: Date;
+    }[]>;
+    /** Gets session data counts by property name: https://umami.is/docs/api/sessions-api#get-apiwebsiteswebsiteidsession-dataproperties (TODO UNTESTED) */
+    function getWebsiteSessionDataProperties(this: API, websiteId: string, parameters: Filters & Timestamps): Promise<{
+        propertyName: string;
+        total: number;
+    }[]>;
+    /** Gets session data counts for a given property: https://umami.is/docs/api/sessions-api#get-apiwebsiteswebsiteidsession-datavalues (TODO UNTESTED) */
+    function getWebsiteSessionDataValues(this: API, websiteId: string, parameters: Filters & Timestamps & {
+        propertyName: string;
+    }): Promise<{
+        value: string;
+        total: number;
+    }[]>;
+}

package/dist/namespaces/Sessions.js

@@ -0,0 +1,45 @@
+/** For endpoints listed on: https://umami.is/docs/api/sessions-api */
+export var Sessions;
+(function (Sessions) {
+    /** Gets website session details within a given time range: https://umami.is/docs/api/sessions-api#get-apiwebsiteswebsiteidsessions (TODO UNTESTED) */
+    async function getWebsiteSessions(websiteId, parameters) {
+        const response = await this.request("get", ["websites", websiteId, "sessions"], parameters);
+        return response.data;
+    }
+    Sessions.getWebsiteSessions = getWebsiteSessions;
+    /** Gets summarized website session statistics: https://umami.is/docs/api/sessions-api#get-apiwebsiteswebsiteidsessionsstats (TODO UNTESTED) */
+    async function getWebsiteSessionsStats(websiteId, parameters) {
+        return await this.request("get", ["websites", websiteId, "sessions"], parameters);
+    }
+    Sessions.getWebsiteSessionsStats = getWebsiteSessionsStats;
+    /** Get collected count of sessions by hour of weekday: https://umami.is/docs/api/sessions-api#get-apiwebsiteswebsiteidsessionsweekly (TODO UNTESTED) */
+    async function getWebsiteSessionsWeekly(websiteId, parameters) {
+        return await this.request("get", ["websites", websiteId, "sessions", "weekly"], parameters);
+    }
+    Sessions.getWebsiteSessionsWeekly = getWebsiteSessionsWeekly;
+    /** Gets session details for a individual session: https://umami.is/docs/api/sessions-api#get-apiwebsiteswebsiteidsessionssessionid (TODO UNTESTED) */
+    async function getWebsiteSession(websiteId, sessionId) {
+        return await this.request("get", ["websites", websiteId, "sessions", sessionId]);
+    }
+    Sessions.getWebsiteSession = getWebsiteSession;
+    /** Gets session activity for a individual session: https://umami.is/docs/api/sessions-api#get-apiwebsiteswebsiteidsessionssessionidactivity (TODO UNTESTED) */
+    async function getWebsiteSessionActivity(websiteId, sessionId, parameters) {
+        return await this.request("get", ["websites", websiteId, "sessions", sessionId, "activity"], parameters);
+    }
+    Sessions.getWebsiteSessionActivity = getWebsiteSessionActivity;
+    /** Gets session properties for a individual session: https://umami.is/docs/api/sessions-api#get-apiwebsiteswebsiteidsessionssessionidproperties (TODO UNTESTED) */
+    async function getWebsiteSessionProperties(websiteId, sessionId) {
+        return await this.request("get", ["websites", websiteId, "sessions", sessionId, "activity", "properties"]);
+    }
+    Sessions.getWebsiteSessionProperties = getWebsiteSessionProperties;
+    /** Gets session data counts by property name: https://umami.is/docs/api/sessions-api#get-apiwebsiteswebsiteidsession-dataproperties (TODO UNTESTED) */
+    async function getWebsiteSessionDataProperties(websiteId, parameters) {
+        return await this.request("get", ["websites", websiteId, "session-data", "properties"], parameters);
+    }
+    Sessions.getWebsiteSessionDataProperties = getWebsiteSessionDataProperties;
+    /** Gets session data counts for a given property: https://umami.is/docs/api/sessions-api#get-apiwebsiteswebsiteidsession-datavalues (TODO UNTESTED) */
+    async function getWebsiteSessionDataValues(websiteId, parameters) {
+        return await this.request("get", ["websites", websiteId, "session-data", "values"], parameters);
+    }
+    Sessions.getWebsiteSessionDataValues = getWebsiteSessionDataValues;
+})(Sessions || (Sessions = {}));

package/dist/namespaces/Users.d.ts

@@ -1,9 +1,7 @@
-import { API, GenericObject, GenericRequestParameters, Role, TeamRole } from "../index.js";
+import { API, GenericObject, GenericRequestParameters, MinimalUser, Role, TeamRole, Website } from "../index.js";
 /** For endpoints listed on: https://umami.is/docs/api/users-api */
 export declare namespace Users {
-    interface GenericUser {
-        id: string;
-        username: string;
+    interface GenericUser extends MinimalUser {
         role: Role;
     }
     /** Creates a user: https://umami.is/docs/api/users-api#post-apiusers */
@@ -39,18 +37,8 @@ export declare namespace Users {
     /** Gets all websites that belong to a user: https://umami.is/docs/api/users-api#get-apiusersuseridwebsites */
     function getUserWebsites(this: API, id: string, parameters: GenericRequestParameters & {
         includeTeams: boolean;
-    }): Promise<(GenericObject & {
-        name: string;
-        domain: string;
-        shareId: string | null;
-        resetAt: Date | null;
-        userId: string;
-        teamId: string | null;
-        createdBy: string;
-        user: {
-            username: string;
-            id: string;
-        };
+    }): Promise<(Website & {
+        user: MinimalUser;
     })[]>;
     /** Gets all teams that belong to a user: https://umami.is/docs/api/users-api#get-apiusersuseridteams */
     function getUserTeams(this: API, id: string, parameters?: Omit<GenericRequestParameters, "search">): Promise<(GenericObject & {

package/dist/namespaces/WebsiteStats.d.ts

@@ -0,0 +1,90 @@
+import { API, Filters, Timestamps, XTY } from "../index.js";
+/** For endpoints listed on: https://umami.is/docs/api/website-stats-api */
+export declare namespace WebsiteStats {
+    /**
+     * The unit parameter buckets the data returned
+     * @remarks The unit is automatically converted to the next largest applicable time unit if the maximum is exceeded
+     */
+    interface Units {
+        /** Up to 60 minutes */
+        minute?: number;
+        /** Up to 48 hours */
+        hour?: number;
+        /** Up to 12 months */
+        day?: number;
+        /** No limit */
+        month?: number;
+        /** No limit */
+        year?: number;
+    }
+    interface Stats {
+        /** Pages hits */
+        pageviews: string;
+        /** Number of unique visitors */
+        visitors: string;
+        /** Number of unique visits */
+        visits: string;
+        /** Number of visitors who only visit a single page */
+        bounces: string;
+        /** Time spent on the website */
+        totaltime: string;
+    }
+    type MetricsTypes = "path" | "entry" | "exit" | "title" | "query" | "referrer" | "channel" | "domain" | "country" | "region" | "city" | "browser" | "os" | "device" | "language" | "screen" | "event" | "hostname" | "tag";
+    /** Gets the number of active users on a website: https://umami.is/docs/api/website-stats-api#get-apiwebsiteswebsiteidactive (TODO UNTESTED) */
+    function getWebsiteActiveVisitors(this: API, websiteId: string): Promise<{
+        visitors: number;
+    }>;
+    /** Gets events within a given time range: https://umami.is/docs/api/website-stats-api#get-apiwebsiteswebsiteideventsseries (TODO UNTESTED) */
+    function getWebsiteEvents(this: API, websiteId: string, parameters: Timestamps & Units & Filters & {
+        /** Timezone (ex. America/Los_Angeles) */
+        timezone: string;
+    }): Promise<XTY[]>;
+    /** Gets metrics for a given time range: https://umami.is/docs/api/website-stats-api#get-apiwebsiteswebsiteidmetrics (TODO UNTESTED) */
+    function getWebsiteMetrics(this: API, websiteId: string, parameters: Timestamps & Units & Filters & {
+        /** Timezone (ex. America/Los_Angeles) */
+        timezone: string;
+        /** Metrics type */
+        type: MetricsTypes;
+        /** (optional, default 500) Number of rows returned */
+        limit?: number;
+        /** (optional, default 0) Number of ows to skip */
+        offset?: number;
+    }): Promise<{
+        /** Unique value, depending on metric type */
+        x: string;
+        /** Number of visitors */
+        y: number;
+    }[]>;
+    /** Gets expanded metrics for a given time range: https://umami.is/docs/api/website-stats-api#get-apiwebsiteswebsiteidmetricsexpanded (TODO UNTESTED) */
+    function getWebsiteMetricsExpanded(this: API, ...args: Parameters<typeof getWebsiteMetrics>): Promise<(Stats & {
+        /** Unique value, depending on metric type */
+        name: string;
+    })[]>;
+    /** Gets pageviews within a given time range: https://umami.is/docs/api/website-stats-api#get-apiwebsiteswebsiteidpageviews (TODO UNTESTED) */
+    function getWebsitePageviews(this: API, websiteId: string, parameters: Timestamps & Units & Filters & {
+        /** Timezone (ex. America/Los_Angeles) */
+        timezone: string;
+        /** Comparison value `prev` | `yoy` */
+        compare?: string;
+    }): Promise<{
+        pageviews: {
+            /** Timestamp */
+            x: Date;
+            /** Number of pageviews or visitors */
+            y: number;
+        }[];
+        sessions: {
+            /** Timestamp */
+            x: Date;
+            /** Number of pageviews or visitors */
+            y: number;
+        }[];
+    }>;
+    /** Gets summarized website statistics: https://umami.is/docs/api/website-stats-api#get-apiwebsiteswebsiteidstats (TODO UNTESTED) */
+    function getWebsiteStats(this: API, websiteId: string, parameters: Timestamps & Filters & Units & {
+        /** Timezone (ex. America/Los_Angeles) */
+        timezone: string;
+    }): Promise<Stats & {
+        comparison: Stats;
+    }>;
+}

package/dist/namespaces/WebsiteStats.js

@@ -0,0 +1,34 @@
+/** For endpoints listed on: https://umami.is/docs/api/website-stats-api */
+export var WebsiteStats;
+(function (WebsiteStats) {
+    /** Gets the number of active users on a website: https://umami.is/docs/api/website-stats-api#get-apiwebsiteswebsiteidactive (TODO UNTESTED) */
+    async function getWebsiteActiveVisitors(websiteId) {
+        return await this.request("get", ["websites", websiteId, "active"]);
+    }
+    WebsiteStats.getWebsiteActiveVisitors = getWebsiteActiveVisitors;
+    /** Gets events within a given time range: https://umami.is/docs/api/website-stats-api#get-apiwebsiteswebsiteideventsseries (TODO UNTESTED) */
+    async function getWebsiteEvents(websiteId, parameters) {
+        return await this.request("get", ["websites", websiteId, "events", "series"], parameters);
+    }
+    WebsiteStats.getWebsiteEvents = getWebsiteEvents;
+    /** Gets metrics for a given time range: https://umami.is/docs/api/website-stats-api#get-apiwebsiteswebsiteidmetrics (TODO UNTESTED) */
+    async function getWebsiteMetrics(websiteId, parameters) {
+        return await this.request("get", ["websites", websiteId, "metrics"], parameters);
+    }
+    WebsiteStats.getWebsiteMetrics = getWebsiteMetrics;
+    /** Gets expanded metrics for a given time range: https://umami.is/docs/api/website-stats-api#get-apiwebsiteswebsiteidmetricsexpanded (TODO UNTESTED) */
+    async function getWebsiteMetricsExpanded(...args) {
+        return await this.request("get", ["websites", args[0], "metrics", "expanded"], args[1]);
+    }
+    WebsiteStats.getWebsiteMetricsExpanded = getWebsiteMetricsExpanded;
+    /** Gets pageviews within a given time range: https://umami.is/docs/api/website-stats-api#get-apiwebsiteswebsiteidpageviews (TODO UNTESTED) */
+    async function getWebsitePageviews(websiteId, parameters) {
+        return await this.request("get", ["websites", websiteId, "pageviews"], parameters);
+    }
+    WebsiteStats.getWebsitePageviews = getWebsitePageviews;
+    /** Gets summarized website statistics: https://umami.is/docs/api/website-stats-api#get-apiwebsiteswebsiteidstats (TODO UNTESTED) */
+    async function getWebsiteStats(websiteId, parameters) {
+        return await this.request("get", ["websites", websiteId, "stats"], parameters);
+    }
+    WebsiteStats.getWebsiteStats = getWebsiteStats;
+})(WebsiteStats || (WebsiteStats = {}));

package/dist/namespaces/Websites.d.ts

@@ -0,0 +1,42 @@
+import { API, GenericRequestParameters, MinimalUser, Website } from "../index.js";
+/** For endpoints listed on: https://umami.is/docs/api/websites-api */
+export declare namespace Websites {
+    /** Returns all user websites: https://umami.is/docs/api/websites-api#get-apiwebsites (TODO UNTESTED) */
+    function getWebsites(this: API, parameters: GenericRequestParameters & {
+        includeTeams: boolean;
+    }): Promise<(Website & {
+        user: MinimalUser;
+    })[]>;
+    /** Creates a website: https://umami.is/docs/api/websites-api#post-apiwebsites (TODO UNTESTED) */
+    function createWebsite(this: API, parameters: {
+        /** The name of the website in Umami */
+        name: string;
+        /** The full domain of the tracked website */
+        domain: string;
+        /** A unique string to enable a share url. Set `null` to unshare */
+        shareId?: string | null;
+        /** The ID of the team the website will be created under */
+        teamId?: string;
+        /** Force a UUID assignment to the website */
+        id?: string;
+    }): Promise<Website>;
+    /** Gets a website by ID: https://umami.is/docs/api/websites-api#get-apiwebsiteswebsiteid (TODO UNTESTED) */
+    function getWebsite(this: API, websiteId: string): Promise<Website>;
+    /** Updates a website: https://umami.is/docs/api/websites-api#post-apiwebsiteswebsiteid (TODO UNTESTED) */
+    function updateWebsite(this: API, websiteId: string, parameters: {
+        /** The name of the website in Umami */
+        name: string;
+        /** The full domain of the tracked website */
+        domain: string;
+        /** A unique string to enable a share url. Set `null` to unshare */
+        shareId?: string | null;
+    }): Promise<Website>;
+    /** Deletes a website: https://umami.is/docs/api/websites-api#delete-apiwebsiteswebsiteid (TODO UNTESTED) */
+    function deleteWebsite(this: API, websiteId: string): Promise<{
+        ok: boolean;
+    }>;
+    /** Resets a website by removing all data related to the website: https://umami.is/docs/api/websites-api#post-apiwebsiteswebsiteidreset (TODO UNTESTED) */
+    function resetWebsite(this: API, websiteId: string): Promise<{
+        ok: boolean;
+    }>;
+}

package/dist/namespaces/Websites.js

@@ -0,0 +1,35 @@
+/** For endpoints listed on: https://umami.is/docs/api/websites-api */
+export var Websites;
+(function (Websites) {
+    /** Returns all user websites: https://umami.is/docs/api/websites-api#get-apiwebsites (TODO UNTESTED) */
+    async function getWebsites(parameters) {
+        const response = await this.request("get", ["websites"], parameters);
+        return response.data;
+    }
+    Websites.getWebsites = getWebsites;
+    /** Creates a website: https://umami.is/docs/api/websites-api#post-apiwebsites (TODO UNTESTED) */
+    async function createWebsite(parameters) {
+        return await this.request("post", ["websites"], parameters);
+    }
+    Websites.createWebsite = createWebsite;
+    /** Gets a website by ID: https://umami.is/docs/api/websites-api#get-apiwebsiteswebsiteid (TODO UNTESTED) */
+    async function getWebsite(websiteId) {
+        return await this.request("get", ["websites", websiteId]);
+    }
+    Websites.getWebsite = getWebsite;
+    /** Updates a website: https://umami.is/docs/api/websites-api#post-apiwebsiteswebsiteid (TODO UNTESTED) */
+    async function updateWebsite(websiteId, parameters) {
+        return await this.request("post", ["websites", websiteId], parameters);
+    }
+    Websites.updateWebsite = updateWebsite;
+    /** Deletes a website: https://umami.is/docs/api/websites-api#delete-apiwebsiteswebsiteid (TODO UNTESTED) */
+    async function deleteWebsite(websiteId) {
+        return await this.request("delete", ["websites", websiteId]);
+    }
+    Websites.deleteWebsite = deleteWebsite;
+    /** Resets a website by removing all data related to the website: https://umami.is/docs/api/websites-api#post-apiwebsiteswebsiteidreset (TODO UNTESTED) */
+    async function resetWebsite(websiteId) {
+        return await this.request("post", ["websites", websiteId, "reset"]);
+    }
+    Websites.resetWebsite = resetWebsite;
+})(Websites || (Websites = {}));

package/dist/utilities.js

@@ -58,7 +58,7 @@ export function correctType(x, force_string) {
         const unconvertables = ["value"];
         const unconvertables_substrings = ["string", "name"]; // or if the key contains any of those substrings
         for (let i = 0; i < keys.length; i++) {
-            x[keys[i]] = correctType(vals[i], unconvertables.some((u) => keys[i] === u) ?? unconvertables_substrings.some((s) => keys[i].toLowerCase().includes(s)));
+            x[keys[i]] = correctType(vals[i], unconvertables.some((u) => keys[i] === u) || unconvertables_substrings.some((s) => keys[i].toLowerCase().includes(s)));
         }
         return x;
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "umami-api-js",
-  "version": "0.0.2",
+  "version": "0.0.4",
   "description": "Package to easily access the umami api!",
   "type": "module",
   "main": "dist/index.js",
@@ -8,7 +8,8 @@
   "scripts": {
     "prepublish": "npm run build",
     "build": "tsc",
-    "test": "npm run build && node ./dist/test.js"
+    "test": "npm run build && node ./dist/test.js",
+    "docs": "npx typedoc lib/index.ts"
   },
   "engines": {
     "node": ">=20.0.0"
@@ -27,9 +28,9 @@
   ],
   "license": "Unlicense",
   "devDependencies": {
-    "@types/chai": "^5.2.2",
     "@types/node": "^24.3.1",
     "dotenv": "^17.2.2",
+    "typedoc": "^0.28.14",
     "typescript": "^5.9.2"
   }
 }