umami-api-js 0.1.2 → 0.1.4

package/README.md

@@ -1,5 +1,5 @@
-A package to interact with [the API of self-hosted instances of Umami v3.0.1](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).
+A package to interact with [the API of self-hosted instances of Umami](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).
 
-If you are reading this from the [package's documentation](https://umami-api-js.taevas.xyz/), please be aware that the documentation is for **umami-api-js@0.1.2**, so make sure your package is up to date! Report any bug on [Codeberg](https://codeberg.org/Taevas/umami-api-js/issues).
+If you are reading this from the [package's documentation](https://umami-api-js.taevas.xyz/), please be aware that the documentation is for **umami-api-js@0.1.4**, so make sure your package is up to date! Report any bug on [Codeberg](https://codeberg.org/Taevas/umami-api-js/issues).
 
-Please note that this package is expected to work with self-hosted instances of **Umami v3.0.1**, and is *not* expected to work with [Umami Cloud](https://umami.is/docs/cloud), the instance of Umami hosted by its creators.
+Please note that this package is expected to work with self-hosted instances of **Umami v3.0.3**, and is *not* expected to work with [Umami Cloud](https://umami.is/docs/cloud), the instance of Umami hosted by its creators.

package/dist/index.d.ts

@@ -11,26 +11,9 @@ import { Users } from "./namespaces/Users.js";
 import { Websites } from "./namespaces/Websites.js";
 import { WebsiteStats } from "./namespaces/WebsiteStats.js";
 export { Admin, Events, Links, Me, Pixels, Websites, WebsiteStats, Realtime, Reports, Sessions, Teams, Users };
-export interface GenericObject {
-    id: string;
-    createdAt: Date;
-    updatedAt: Date | null;
-    deletedAt: Date | null;
-}
 export interface DeletionResult {
     ok: boolean;
 }
-export interface Report extends Omit<GenericObject, "deletedAt"> {
-    userId: Users.User["id"];
-    websiteId: Websites.Website["id"];
-    type: string;
-    name: string;
-    description: string;
-    parameters: {
-        type: string;
-        value: string;
-    };
-}
 export interface NameValue {
     name: string;
     value: number;

package/dist/index.js

@@ -140,6 +140,7 @@ export class API {
                         this.log(true, "Unable to obtain a token! Here's what was received from the API:", json);
                         reject(new APIError(error_message, this.server, "post", ["auth", "login"], body, response.status));
                     }
+                    // Note: `json` currently only has `token` & `user`
                     this.token = json.token;
                     this.user = json.user;
                     const expiration_date = new Date();

package/dist/namespaces/Admin.d.ts

@@ -1,16 +1,8 @@
-import { API, GenericObject, GenericRequestParameters, Teams, Users, Websites } from "../index.js";
+import { API, GenericRequestParameters, Teams, Users, Websites } from "../index.js";
 /** Operations around admin management: https://umami.is/docs/api/admin */
 export declare namespace Admin {
     /** Returns all users: https://umami.is/docs/api/admin#get-apiadminusers */
-    function getUsers(this: API, parameters?: GenericRequestParameters): Promise<(GenericObject & {
-        username: string;
-        role: Users.Role;
-        logoUrl: string | null;
-        displayName: string | null;
-        _count: {
-            websites: number;
-        };
-    })[]>;
+    function getUsers(this: API, parameters?: GenericRequestParameters): Promise<Users.DetailedUser[]>;
     /** Returns all websites: https://umami.is/docs/api/admin#get-apiadminwebsites */
     function getWebsites(this: API, parameters?: GenericRequestParameters): Promise<(Websites.WebsiteWithUser & {
         /** @remarks TODO Documentation says it can be null but doesn't actually say what else it can be, ***presumed* to be string**, check */

package/dist/namespaces/Events.d.ts

@@ -1,10 +1,10 @@
-import { API, Filters, GenericRequestParameters, Timestamps, Websites } from "../index.js";
+import { API, Filters, GenericRequestParameters, Sessions, Timestamps, Websites } from "../index.js";
 /** Operations around Events and Event data: https://umami.is/docs/api/events */
 export declare namespace Events {
     interface Event {
         id: string;
         websiteId: Websites.Website["id"];
-        sessionId: string;
+        sessionId: Sessions.Session["id"];
         createdAt: Date;
         hostname: string;
         urlPath: string;
@@ -27,7 +27,7 @@ export declare namespace Events {
     /** Gets event-data for a individual event: https://umami.is/docs/api/events#get-apiwebsiteswebsiteidevent-dataeventid */
     function get_WEBSITEID_Eventdata_EVENTID(this: API, websiteId: Websites.Website["id"], eventId: Event["id"]): Promise<{
         websiteId: Websites.Website["id"];
-        sessionId?: string;
+        sessionId?: Sessions.Session["id"];
         eventId: Event["id"];
         urlPath?: string;
         eventName: Event["eventName"];

package/dist/namespaces/Links.d.ts

@@ -1,12 +1,16 @@
-import { API, DeletionResult, GenericObject, GenericRequestParameters, Users } from "../index.js";
+import { API, DeletionResult, GenericRequestParameters, Users } from "../index.js";
 /** Operations around Links management: https://umami.is/docs/api/links */
 export declare namespace Links {
-    interface Link extends GenericObject {
+    interface Link {
+        id: string;
         name: string;
         url: string;
         slug: string;
         userId: Users.User["id"];
-        teamid: string | null;
+        teamId: string | null;
+        createdAt: Date;
+        updatedAt: Date;
+        deletedAt: Date | null;
     }
     /** Returns all user links: https://umami.is/docs/api/links#get-apilinks (TODO UNTESTED) */
     function get(this: API, parameters?: GenericRequestParameters): Promise<Link[]>;

package/dist/namespaces/Me.d.ts

@@ -1,24 +1,16 @@
-import { API, GenericObject, Teams, Users } from "../index.js";
+import { API, Teams, Users, Websites } from "../index.js";
 /** All information about your session: https://umami.is/docs/api/me */
 export declare namespace Me {
-    /** Get information based on your auth token: https://umami.is/docs/api/me#get-apime */
-    function get(this: API): Promise<{
-        token: string;
+    interface TokenInformation {
+        token: API["token"];
         authKey: string;
         shareToken: string | null;
         user: Users.User;
-    }>;
+    }
+    /** Get information based on your auth token: https://umami.is/docs/api/me#get-apime */
+    function get(this: API): Promise<TokenInformation>;
     /** Get all your teams: https://umami.is/docs/api/me#get-apimeteams */
     function getTeams(this: API): Promise<Teams.TeamWithMembersCount[]>;
     /** Get all your websites: https://umami.is/docs/api/me#get-apimeteams */
-    function getWebsites(this: API): Promise<(GenericObject & {
-        name: string;
-        domain: string;
-        shareId: string | null;
-        resetAt: Date | null;
-        userId: Users.User["id"];
-        teamId: string | null;
-        createdBy: string;
-        user: Users.MinimalUser;
-    })[]>;
+    function getWebsites(this: API): Promise<Websites.WebsiteWithUser[]>;
 }

package/dist/namespaces/Pixels.d.ts

@@ -1,11 +1,15 @@
-import { API, DeletionResult, GenericObject, GenericRequestParameters, Users } from "../index.js";
+import { API, DeletionResult, GenericRequestParameters, Users } from "../index.js";
 /** Operations around Pixels management: https://umami.is/docs/api/pixels */
 export declare namespace Pixels {
-    interface Pixel extends GenericObject {
+    interface Pixel {
+        id: string;
         name: string;
         slug: string;
         userId: Users.User["id"];
-        teamid: string | null;
+        teamId: string | null;
+        createdAt: Date;
+        updatedAt: Date;
+        deletedAt: Date | null;
     }
     /** Returns all user pixels: https://umami.is/docs/api/pixels#get-apipixels (TODO UNTESTED) */
     function get(this: API, parameters?: GenericRequestParameters): Promise<Pixel[]>;

package/dist/namespaces/Realtime.d.ts

@@ -1,7 +1,7 @@
-import { API, Websites } from "../index.js";
+import { API, Sessions, Websites } from "../index.js";
 /** Realtime data for your website: https://umami.is/docs/api/realtime */
 export declare namespace Realtime {
-    /** Realtime stats within the last 30 minutes: https://umami.is/docs/api/realtime#get-apirealtimewebsiteid (TODO UNTESTED) */
+    /** Realtime stats within the last 30 minutes: https://umami.is/docs/api/realtime#get-apirealtimewebsiteid */
     function get_WEBSITEID(this: API, websiteId: Websites.Website["id"]): Promise<{
         countries: {
             [k: string]: number;
@@ -14,7 +14,7 @@ export declare namespace Realtime {
         };
         events: {
             __type: string;
-            sessionId: string;
+            sessionId: Sessions.Session["id"];
             eventName: string;
             createdAt: Date;
             browser: string;

package/dist/namespaces/Realtime.js

@@ -1,9 +1,9 @@
 /** Realtime data for your website: https://umami.is/docs/api/realtime */
 export var Realtime;
 (function (Realtime) {
-    /** Realtime stats within the last 30 minutes: https://umami.is/docs/api/realtime#get-apirealtimewebsiteid (TODO UNTESTED) */
+    /** Realtime stats within the last 30 minutes: https://umami.is/docs/api/realtime#get-apirealtimewebsiteid */
     async function get_WEBSITEID(websiteId) {
-        return await this.request("post", ["realtime", websiteId]);
+        return await this.request("get", ["realtime", websiteId]);
     }
     Realtime.get_WEBSITEID = get_WEBSITEID;
 })(Realtime || (Realtime = {}));

package/dist/namespaces/Reports.d.ts

@@ -1,6 +1,20 @@
-import { API, DeletionResult, Filters, GenericRequestParameters, NameValue, Report, Timestamps, Websites, XTY } from "../index.js";
+import { API, DeletionResult, Filters, GenericRequestParameters, NameValue, Timestamps, Users, Websites, XTY } from "../index.js";
 /** Using reports throught the api: https://umami.is/docs/api/reports */
 export declare namespace Reports {
+    interface Report {
+        id: string;
+        userId: Users.User["id"];
+        websiteId: Websites.Website["id"];
+        type: ReportType;
+        name: string;
+        description: string;
+        parameters: {
+            type: string;
+            value: string;
+        };
+        createdAt: Date;
+        updatedAt: Date;
+    }
     type ReportType = {
         type: "attribution" | "breakdown" | "funnel" | "goal" | "journey" | "retention" | "revenue" | "utm";
     };
@@ -13,25 +27,25 @@ export declare namespace Reports {
     /** Creates a report: https://umami.is/docs/api/reports#post-apireports (TODO UNTESTED) */
     function post(this: API, websiteId: Websites.Website["id"], parameters: ReportType & {
         /** Name of report */
-        name: string;
+        name: Report["name"];
         /** Description of report */
-        description?: string;
+        description?: Report["description"];
         /** Parameters for report */
         parameters?: any;
     }): Promise<Report>;
     /** Gets a report by ID: https://umami.is/docs/api/reports#get-apireportsreportid (TODO UNTESTED) */
-    function get_REPORTID(this: API, reportId: string): Promise<Report>;
+    function get_REPORTID(this: API, reportId: Report["id"]): Promise<Report>;
     /** Updates a report: https://umami.is/docs/api/reports#post-apireportsreportid (TODO UNTESTED) */
-    function post_REPORTID(this: API, reportId: string, websiteId: Websites.Website["id"], parameters: ReportType & {
+    function post_REPORTID(this: API, reportId: Report["id"], websiteId: Websites.Website["id"], parameters: ReportType & {
         /** Name of report */
-        name: string;
+        name: Report["name"];
         /** Description of report */
-        description?: string;
+        description?: Report["description"];
         /** Parameters for report */
         parameters?: any;
     }): Promise<Report>;
     /** Deletes a report: https://umami.is/docs/api/reports#delete-apireportsreportid (TODO UNTESTED) */
-    function delete_REPORTID(this: API, reportId: string): Promise<DeletionResult>;
+    function delete_REPORTID(this: API, reportId: Report["id"]): Promise<DeletionResult>;
     /** See how users engage with your marketing and what drives conversions: https://umami.is/docs/api/reports#post-apireportsattribution (TODO UNTESTED) */
     function postAttribution(this: API, websiteId: Websites.Website["id"], parameters: ReportType & Filters & Timestamps & {
         /** Attribution model */

package/dist/namespaces/Sessions.d.ts

@@ -1,14 +1,14 @@
-import { API, Filters, GenericRequestParameters, Timestamps, Websites } from "../index.js";
+import { API, Events, Filters, GenericRequestParameters, Timestamps, Websites } from "../index.js";
 /** Operations around Sessions and Session data: https://umami.is/docs/api/sessions */
 export declare namespace Sessions {
-    interface GenericSession {
+    interface Session {
         id: string;
         websiteId: Websites.Website["id"];
-        browser: string;
-        os: string;
+        browser: string | null;
+        os: string | null;
         device: string;
         screen: string;
-        language: string;
+        language: string | null;
         country: string;
         region: string;
         city: string;
@@ -17,12 +17,18 @@ export declare namespace Sessions {
         visits: number;
         views: number;
     }
-    /** Gets website session details within a given time range: https://umami.is/docs/api/sessions#get-apiwebsiteswebsiteidsessions (TODO UNTESTED) */
-    function get_WEBSITEID_Sessions(this: API, websiteId: Websites.Website["id"], parameters: Filters & Timestamps & GenericRequestParameters): Promise<(GenericSession & {
+    interface SessionWithHostnameCreatedat extends Session {
         hostname: string;
         createdAt: Date;
-    })[]>;
-    /** Gets summarized website session statistics: https://umami.is/docs/api/sessions#get-apiwebsiteswebsiteidsessionsstats (TODO UNTESTED) */
+    }
+    interface SessionWithDistinctidEventsTotaltime extends Session {
+        distinctId: string | null;
+        events: number;
+        totaltime: number;
+    }
+    /** Gets website session details within a given time range: https://umami.is/docs/api/sessions#get-apiwebsiteswebsiteidsessions */
+    function get_WEBSITEID_Sessions(this: API, websiteId: Websites.Website["id"], parameters: Filters & Timestamps & GenericRequestParameters): Promise<SessionWithHostnameCreatedat[]>;
+    /** Gets summarized website session statistics: https://umami.is/docs/api/sessions#get-apiwebsiteswebsiteidsessionsstats */
     function get_WEBSITEID_SessionsStats(this: API, websiteId: Websites.Website["id"], parameters: Filters & Timestamps): Promise<{
         /** Pages hits */
         pageviews: {
@@ -36,41 +42,51 @@ export declare namespace Sessions {
         visits: {
             value: number;
         };
-        /** Number of visitors who only visit a single page */
-        bounces: {
+        /** @remarks Undocumented */
+        countries: {
+            value: number;
+        };
+        /** @remarks Undocumented */
+        events: {
             value: number;
         };
-        /** Time spent on the website */
-        totaltime: {
+        /**
+         * Number of visitors who only visit a single page
+         * @remarks While featured in the documentation, it doesn't seem to exist
+         */
+        bounces?: {
+            value: number;
+        };
+        /**
+         * Time spent on the website
+         * @remarks While featured in the documentation, it doesn't seem to exist
+         */
+        totaltime?: {
             value: number;
         };
     }>;
-    /** Get collected count of sessions by hour of weekday: https://umami.is/docs/api/sessions#get-apiwebsiteswebsiteidsessionsweekly (TODO UNTESTED) */
+    /** Get collected count of sessions by hour of weekday: https://umami.is/docs/api/sessions#get-apiwebsiteswebsiteidsessionsweekly */
     function get_WEBSITEID_SessionsWeekly(this: API, websiteId: Websites.Website["id"], parameters: Filters & Timestamps & {
         timezone: string;
     }): Promise<number[][]>;
-    /** Gets session details for a individual session: https://umami.is/docs/api/sessions#get-apiwebsiteswebsiteidsessionssessionid (TODO UNTESTED) */
-    function get_WEBSITEID_Sessions_SESSIONID(this: API, websiteId: Websites.Website["id"], sessionId: string): Promise<GenericSession & {
-        distinctId: string;
-        events: number;
-        totaltime: number;
-    }>;
-    /** Gets session activity for a individual session: https://umami.is/docs/api/sessions#get-apiwebsiteswebsiteidsessionssessionidactivity (TODO UNTESTED) */
-    function get_WEBSITEID_Sessions_SESSIONID_Activity(this: API, websiteId: Websites.Website["id"], sessionId: string, parameters: Timestamps): Promise<{
+    /** Gets session details for a individual session: https://umami.is/docs/api/sessions#get-apiwebsiteswebsiteidsessionssessionid */
+    function get_WEBSITEID_Sessions_SESSIONID(this: API, websiteId: Websites.Website["id"], sessionId: Session["id"]): Promise<SessionWithDistinctidEventsTotaltime>;
+    /** Gets session activity for a individual session: https://umami.is/docs/api/sessions#get-apiwebsiteswebsiteidsessionssessionidactivity */
+    function get_WEBSITEID_Sessions_SESSIONID_Activity(this: API, websiteId: Websites.Website["id"], sessionId: Session["id"], parameters: Timestamps): Promise<{
         createdAt: Date;
         urlPath: string;
         urlQuery: string;
-        referrerDomain: string;
-        eventId: string;
-        eventType: number;
-        eventName: string;
+        referrerDomain: string | null;
+        eventId: Events.Event["id"];
+        eventType: Events.Event["eventType"];
+        eventName: Events.Event["eventName"] | null;
         visitId: string;
-        hasData: number;
+        hasData: boolean;
     }[]>;
-    /** Gets session properties for a individual session: https://umami.is/docs/api/sessions#get-apiwebsiteswebsiteidsessionssessionidproperties (TODO UNTESTED) */
-    function get_WEBSITEID_Sessions_SESSIONID_Properties(this: API, websiteId: Websites.Website["id"], sessionId: string): Promise<{
+    /** Gets session properties for a individual session: https://umami.is/docs/api/sessions#get-apiwebsiteswebsiteidsessionssessionidproperties (TODO Server returns empty array) */
+    function get_WEBSITEID_Sessions_SESSIONID_Properties(this: API, websiteId: Websites.Website["id"], sessionId: Session["id"]): Promise<{
         websiteId: Websites.Website["id"];
-        sessionid: string;
+        sessionId: Session["id"];
         dataKey: string;
         dataType: number;
         stringValue: string;
@@ -78,12 +94,12 @@ export declare namespace Sessions {
         dateValue: Date | null;
         createdAt: Date;
     }[]>;
-    /** Gets session data counts by property name: https://umami.is/docs/api/sessions#get-apiwebsiteswebsiteidsession-dataproperties (TODO UNTESTED) */
+    /** Gets session data counts by property name: https://umami.is/docs/api/sessions#get-apiwebsiteswebsiteidsession-dataproperties (TODO Server returns empty array) */
     function get_WEBSITEID_SessiondataProperties(this: API, websiteId: Websites.Website["id"], parameters: Filters & Timestamps): Promise<{
         propertyName: string;
         total: number;
     }[]>;
-    /** Gets session data counts for a given property: https://umami.is/docs/api/sessions#get-apiwebsiteswebsiteidsession-datavalues (TODO UNTESTED) */
+    /** Gets session data counts for a given property: https://umami.is/docs/api/sessions#get-apiwebsiteswebsiteidsession-datavalues (TODO Server returns empty array) */
     function get_WEBSITEID_SessiondataValues(this: API, websiteId: Websites.Website["id"], parameters: Filters & Timestamps & {
         propertyName: string;
     }): Promise<{

package/dist/namespaces/Sessions.js

@@ -1,43 +1,45 @@
 /** Operations around Sessions and Session data: https://umami.is/docs/api/sessions */
 export var Sessions;
 (function (Sessions) {
-    /** Gets website session details within a given time range: https://umami.is/docs/api/sessions#get-apiwebsiteswebsiteidsessions (TODO UNTESTED) */
+    /** Gets website session details within a given time range: https://umami.is/docs/api/sessions#get-apiwebsiteswebsiteidsessions */
     async function get_WEBSITEID_Sessions(websiteId, parameters) {
         const response = await this.request("get", ["websites", websiteId, "sessions"], parameters);
         return response.data;
     }
     Sessions.get_WEBSITEID_Sessions = get_WEBSITEID_Sessions;
-    /** Gets summarized website session statistics: https://umami.is/docs/api/sessions#get-apiwebsiteswebsiteidsessionsstats (TODO UNTESTED) */
+    /** Gets summarized website session statistics: https://umami.is/docs/api/sessions#get-apiwebsiteswebsiteidsessionsstats */
     async function get_WEBSITEID_SessionsStats(websiteId, parameters) {
-        return await this.request("get", ["websites", websiteId, "sessions"], parameters);
+        const response = await this.request("get", ["websites", websiteId, "sessions", "stats"], parameters);
+        Object.values(response).forEach((v) => { v.value = Number(v.value); });
+        return response;
     }
     Sessions.get_WEBSITEID_SessionsStats = get_WEBSITEID_SessionsStats;
-    /** Get collected count of sessions by hour of weekday: https://umami.is/docs/api/sessions#get-apiwebsiteswebsiteidsessionsweekly (TODO UNTESTED) */
+    /** Get collected count of sessions by hour of weekday: https://umami.is/docs/api/sessions#get-apiwebsiteswebsiteidsessionsweekly */
     async function get_WEBSITEID_SessionsWeekly(websiteId, parameters) {
         return await this.request("get", ["websites", websiteId, "sessions", "weekly"], parameters);
     }
     Sessions.get_WEBSITEID_SessionsWeekly = get_WEBSITEID_SessionsWeekly;
-    /** Gets session details for a individual session: https://umami.is/docs/api/sessions#get-apiwebsiteswebsiteidsessionssessionid (TODO UNTESTED) */
+    /** Gets session details for a individual session: https://umami.is/docs/api/sessions#get-apiwebsiteswebsiteidsessionssessionid */
     async function get_WEBSITEID_Sessions_SESSIONID(websiteId, sessionId) {
         return await this.request("get", ["websites", websiteId, "sessions", sessionId]);
     }
     Sessions.get_WEBSITEID_Sessions_SESSIONID = get_WEBSITEID_Sessions_SESSIONID;
-    /** Gets session activity for a individual session: https://umami.is/docs/api/sessions#get-apiwebsiteswebsiteidsessionssessionidactivity (TODO UNTESTED) */
+    /** Gets session activity for a individual session: https://umami.is/docs/api/sessions#get-apiwebsiteswebsiteidsessionssessionidactivity */
     async function get_WEBSITEID_Sessions_SESSIONID_Activity(websiteId, sessionId, parameters) {
         return await this.request("get", ["websites", websiteId, "sessions", sessionId, "activity"], parameters);
     }
     Sessions.get_WEBSITEID_Sessions_SESSIONID_Activity = get_WEBSITEID_Sessions_SESSIONID_Activity;
-    /** Gets session properties for a individual session: https://umami.is/docs/api/sessions#get-apiwebsiteswebsiteidsessionssessionidproperties (TODO UNTESTED) */
+    /** Gets session properties for a individual session: https://umami.is/docs/api/sessions#get-apiwebsiteswebsiteidsessionssessionidproperties (TODO Server returns empty array) */
     async function get_WEBSITEID_Sessions_SESSIONID_Properties(websiteId, sessionId) {
-        return await this.request("get", ["websites", websiteId, "sessions", sessionId, "activity", "properties"]);
+        return await this.request("get", ["websites", websiteId, "sessions", sessionId, "properties"]);
     }
     Sessions.get_WEBSITEID_Sessions_SESSIONID_Properties = get_WEBSITEID_Sessions_SESSIONID_Properties;
-    /** Gets session data counts by property name: https://umami.is/docs/api/sessions#get-apiwebsiteswebsiteidsession-dataproperties (TODO UNTESTED) */
+    /** Gets session data counts by property name: https://umami.is/docs/api/sessions#get-apiwebsiteswebsiteidsession-dataproperties (TODO Server returns empty array) */
     async function get_WEBSITEID_SessiondataProperties(websiteId, parameters) {
         return await this.request("get", ["websites", websiteId, "session-data", "properties"], parameters);
     }
     Sessions.get_WEBSITEID_SessiondataProperties = get_WEBSITEID_SessiondataProperties;
-    /** Gets session data counts for a given property: https://umami.is/docs/api/sessions#get-apiwebsiteswebsiteidsession-datavalues (TODO UNTESTED) */
+    /** Gets session data counts for a given property: https://umami.is/docs/api/sessions#get-apiwebsiteswebsiteidsession-datavalues (TODO Server returns empty array) */
     async function get_WEBSITEID_SessiondataValues(websiteId, parameters) {
         return await this.request("get", ["websites", websiteId, "session-data", "values"], parameters);
     }

package/dist/namespaces/Teams.d.ts

@@ -7,7 +7,7 @@ export declare namespace Teams {
         accessCode: string;
         logoUrl: string | null;
         createdAt: Date;
-        updatedAt: Date | null;
+        updatedAt: Date;
         deletedAt: Date | null;
     }
     interface TeamMember {
@@ -30,41 +30,42 @@ export declare namespace Teams {
             members: number;
         };
     }
-    type TeamRole = "team-manager" | "team-member" | "team-view-only";
-    /** Returns all teams: https://umami.is/docs/api/teams#get-apiteams (TODO UNTESTED) */
+    type TeamRole = "team-owner" | "team-manager" | "team-member" | "team-view-only";
+    /** Returns all teams: https://umami.is/docs/api/teams#get-apiteams */
     function get(this: API, parameters?: Omit<GenericRequestParameters, "search">): Promise<TeamWithMembersCount[]>;
-    /** Creates a team: https://umami.is/docs/api/teams#post-apiteams (TODO UNTESTED) */
-    function post(this: API, name: string): Promise<[Team, TeamMember]>;
-    /** Join a team: https://umami.is/docs/api/teams#post-apiteamsjoin (TODO UNTESTED) */
-    function postJoin(this: API, accessCode: string): Promise<TeamMember>;
-    /** Get a team: https://umami.is/docs/api/teams#get-apiteamsteamid (TODO UNTESTED) */
-    function get_TEAMID(this: API, teamId: string): Promise<Team & {
-        members: TeamMember[];
-    }>;
-    /** Update a team: https://umami.is/docs/api/teams#post-apiteamsteamid (TODO UNTESTED) */
-    function post_TEAMID(this: API, teamId: string, parameters: {
+    /**
+     * Creates a team: https://umami.is/docs/api/teams#post-apiteams
+     * @returns An Array where its first element is the created team, and its second element is its owner
+     */
+    function post(this: API, name: Team["name"]): Promise<[Team, TeamMember]>;
+    /** Join a team: https://umami.is/docs/api/teams#post-apiteamsjoin */
+    function postJoin(this: API, accessCode: Team["accessCode"]): Promise<TeamMember>;
+    /** Get a team: https://umami.is/docs/api/teams#get-apiteamsteamid */
+    function get_TEAMID(this: API, teamId: Team["id"]): Promise<TeamWithMembers>;
+    /** Update a team: https://umami.is/docs/api/teams#post-apiteamsteamid */
+    function post_TEAMID(this: API, teamId: Team["id"], parameters: {
         /** The team's name */
-        name?: string;
+        name?: Team["name"];
         /** The team's access code */
-        accessCode?: string;
+        accessCode?: Team["accessCode"];
     }): Promise<Team>;
-    /** Delete a team: https://umami.is/docs/api/teams#delete-apiteamsteamid (TODO UNTESTED) */
-    function delete_TEAMID(this: API, teamId: string): Promise<DeletionResult>;
-    /** Get all users that belong to a team: https://umami.is/docs/api/teams#get-apiteamsteamidusers (TODO UNTESTED) */
-    function get_TEAMID_Users(this: API, teamId: string, parameters: GenericRequestParameters): Promise<TeamMemberWithUser[]>;
-    /** Add a user to a team: https://umami.is/docs/api/teams#post-apiteamsteamidusers (TODO UNTESTED) */
-    function post_TEAMID_Users(this: API, teamId: string, parameters: {
+    /** Delete a team: https://umami.is/docs/api/teams#delete-apiteamsteamid */
+    function delete_TEAMID(this: API, teamId: Team["id"]): Promise<DeletionResult>;
+    /** Get all users that belong to a team: https://umami.is/docs/api/teams#get-apiteamsteamidusers */
+    function get_TEAMID_Users(this: API, teamId: Team["id"], parameters?: GenericRequestParameters): Promise<TeamMemberWithUser[]>;
+    /** Add a user to a team: https://umami.is/docs/api/teams#post-apiteamsteamidusers */
+    function post_TEAMID_Users(this: API, teamId: Team["id"], parameters: {
         /** ID of user to be added */
         userId: Users.User["id"];
         /** Team role for user */
-        role: TeamRole;
+        role: Exclude<TeamRole, "team-owner">;
     }): Promise<TeamMember>;
-    /** Get a user belonging to a team: https://umami.is/docs/api/teams#get-apiteamsteamidusersuserid (TODO UNTESTED) */
-    function get_TEAMID_Users_USERID(this: API, teamId: string, userId: Users.User["id"]): Promise<TeamMember>;
-    /** Update a user's role on a team: https://umami.is/docs/api/teams#post-apiteamsteamidusersuserid (TODO UNTESTED) */
-    function post_TEAMID_Users_USERID(this: API, teamId: string, userId: Users.User["id"], role: TeamRole): Promise<TeamMember>;
-    /** Remove a user from a team: https://umami.is/docs/api/teams#delete-apiteamsteamidusersuserid (TODO UNTESTED) */
-    function delete_TEAMID_Users_USERID(this: API, teamId: string, userId: Users.User["id"]): Promise<DeletionResult>;
-    /** Get all websites that belong to a team: https://umami.is/docs/api/teams#get-apiteamsteamidwebsites (TODO UNTESTED) */
-    function get_TEAMID_Websites(this: API, teamId: string, parameters: GenericRequestParameters): Promise<Websites.WebsiteWithCreateuser[]>;
+    /** Get a user belonging to a team: https://umami.is/docs/api/teams#get-apiteamsteamidusersuserid */
+    function get_TEAMID_Users_USERID(this: API, teamId: Team["id"], userId: Users.User["id"]): Promise<TeamMember>;
+    /** Update a user's role on a team: https://umami.is/docs/api/teams#post-apiteamsteamidusersuserid */
+    function post_TEAMID_Users_USERID(this: API, teamId: Team["id"], userId: Users.User["id"], role: Exclude<TeamRole, "team-owner">): Promise<TeamMember>;
+    /** Remove a user from a team: https://umami.is/docs/api/teams#delete-apiteamsteamidusersuserid */
+    function delete_TEAMID_Users_USERID(this: API, teamId: Team["id"], userId: Users.User["id"]): Promise<DeletionResult>;
+    /** Get all websites that belong to a team: https://umami.is/docs/api/teams#get-apiteamsteamidwebsites */
+    function get_TEAMID_Websites(this: API, teamId: Team["id"], parameters?: GenericRequestParameters): Promise<Websites.WebsiteWithCreateuser[]>;
 }

package/dist/namespaces/Teams.js

@@ -1,64 +1,67 @@
 /** Operations around Team management: https://umami.is/docs/api/teams */
 export var Teams;
 (function (Teams) {
-    /** Returns all teams: https://umami.is/docs/api/teams#get-apiteams (TODO UNTESTED) */
+    /** Returns all teams: https://umami.is/docs/api/teams#get-apiteams */
     async function get(parameters) {
         const response = await this.request("get", ["teams"], parameters);
         return response.data;
     }
     Teams.get = get;
-    /** Creates a team: https://umami.is/docs/api/teams#post-apiteams (TODO UNTESTED) */
+    /**
+     * Creates a team: https://umami.is/docs/api/teams#post-apiteams
+     * @returns An Array where its first element is the created team, and its second element is its owner
+     */
     async function post(name) {
         return await this.request("post", ["teams"], { name });
     }
     Teams.post = post;
-    /** Join a team: https://umami.is/docs/api/teams#post-apiteamsjoin (TODO UNTESTED) */
+    /** Join a team: https://umami.is/docs/api/teams#post-apiteamsjoin */
     async function postJoin(accessCode) {
         return await this.request("post", ["teams", "join"], { accessCode });
     }
     Teams.postJoin = postJoin;
-    /** Get a team: https://umami.is/docs/api/teams#get-apiteamsteamid (TODO UNTESTED) */
+    /** Get a team: https://umami.is/docs/api/teams#get-apiteamsteamid */
     async function get_TEAMID(teamId) {
         return await this.request("get", ["teams", teamId]);
     }
     Teams.get_TEAMID = get_TEAMID;
-    /** Update a team: https://umami.is/docs/api/teams#post-apiteamsteamid (TODO UNTESTED) */
+    /** Update a team: https://umami.is/docs/api/teams#post-apiteamsteamid */
     async function post_TEAMID(teamId, parameters) {
         return await this.request("post", ["teams", teamId], parameters);
     }
     Teams.post_TEAMID = post_TEAMID;
-    /** Delete a team: https://umami.is/docs/api/teams#delete-apiteamsteamid (TODO UNTESTED) */
+    /** Delete a team: https://umami.is/docs/api/teams#delete-apiteamsteamid */
     async function delete_TEAMID(teamId) {
         return await this.request("delete", ["teams", teamId]);
     }
     Teams.delete_TEAMID = delete_TEAMID;
-    /** Get all users that belong to a team: https://umami.is/docs/api/teams#get-apiteamsteamidusers (TODO UNTESTED) */
+    /** Get all users that belong to a team: https://umami.is/docs/api/teams#get-apiteamsteamidusers */
     async function get_TEAMID_Users(teamId, parameters) {
         const response = await this.request("get", ["teams", teamId, "users"], parameters);
         return response.data;
     }
     Teams.get_TEAMID_Users = get_TEAMID_Users;
-    /** Add a user to a team: https://umami.is/docs/api/teams#post-apiteamsteamidusers (TODO UNTESTED) */
+    /** Add a user to a team: https://umami.is/docs/api/teams#post-apiteamsteamidusers */
     async function post_TEAMID_Users(teamId, parameters) {
         return await this.request("post", ["teams", teamId, "users"], parameters);
     }
     Teams.post_TEAMID_Users = post_TEAMID_Users;
-    /** Get a user belonging to a team: https://umami.is/docs/api/teams#get-apiteamsteamidusersuserid (TODO UNTESTED) */
+    /** Get a user belonging to a team: https://umami.is/docs/api/teams#get-apiteamsteamidusersuserid */
     async function get_TEAMID_Users_USERID(teamId, userId) {
         return await this.request("get", ["teams", teamId, "users", userId]);
     }
     Teams.get_TEAMID_Users_USERID = get_TEAMID_Users_USERID;
-    /** Update a user's role on a team: https://umami.is/docs/api/teams#post-apiteamsteamidusersuserid (TODO UNTESTED) */
+    /** Update a user's role on a team: https://umami.is/docs/api/teams#post-apiteamsteamidusersuserid */
     async function post_TEAMID_Users_USERID(teamId, userId, role) {
         return await this.request("post", ["teams", teamId, "users", userId], { role });
     }
     Teams.post_TEAMID_Users_USERID = post_TEAMID_Users_USERID;
-    /** Remove a user from a team: https://umami.is/docs/api/teams#delete-apiteamsteamidusersuserid (TODO UNTESTED) */
+    /** Remove a user from a team: https://umami.is/docs/api/teams#delete-apiteamsteamidusersuserid */
     async function delete_TEAMID_Users_USERID(teamId, userId) {
         return await this.request("delete", ["teams", teamId, "users", userId]);
     }
     Teams.delete_TEAMID_Users_USERID = delete_TEAMID_Users_USERID;
-    /** Get all websites that belong to a team: https://umami.is/docs/api/teams#get-apiteamsteamidwebsites (TODO UNTESTED) */
+    /** Get all websites that belong to a team: https://umami.is/docs/api/teams#get-apiteamsteamidwebsites */
     async function get_TEAMID_Websites(teamId, parameters) {
         const response = await this.request("get", ["teams", teamId, "websites"], parameters);
         return response.data;

package/dist/namespaces/Users.d.ts

@@ -17,6 +17,15 @@ export declare namespace Users {
     interface User extends MinimalUserWithCreatedAt {
         isAdmin: boolean;
     }
+    interface DetailedUser extends MinimalUserWithRole, MinimalUserWithCreatedAt {
+        logoUrl: string | null;
+        displayName: string | null;
+        updatedAt: Date;
+        deletedAt: Date | null;
+        _count: {
+            websites: number;
+        };
+    }
     /** Creates a user: https://umami.is/docs/api/users#post-apiusers */
     function post(this: API, parameters: {
         /** The user's username */

package/dist/namespaces/WebsiteStats.d.ts

@@ -30,11 +30,11 @@ export declare namespace WebsiteStats {
         totaltime: number;
     }
     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#get-apiwebsiteswebsiteidactive (TODO UNTESTED) */
+    /** Gets the number of active users on a website: https://umami.is/docs/api/website-stats#get-apiwebsiteswebsiteidactive */
     function get_WEBSITEID_Active(this: API, websiteId: Websites.Website["id"]): Promise<{
         visitors: number;
     }>;
-    /** Gets events within a given time range: https://umami.is/docs/api/website-stats#get-apiwebsiteswebsiteideventsseries (TODO UNTESTED) */
+    /** Gets events within a given time range: https://umami.is/docs/api/website-stats#get-apiwebsiteswebsiteideventsseries */
     function get_WEBSITEID_EventsSeries(this: API, websiteId: Websites.Website["id"], parameters: Timestamps & Units & Filters & {
         /** Timezone (ex. America/Los_Angeles) */
         timezone: string;

package/dist/namespaces/WebsiteStats.js

@@ -1,14 +1,16 @@
 /** Operations around Website statistics: https://umami.is/docs/api/website-stats */
 export var WebsiteStats;
 (function (WebsiteStats) {
-    /** Gets the number of active users on a website: https://umami.is/docs/api/website-stats#get-apiwebsiteswebsiteidactive (TODO UNTESTED) */
+    /** Gets the number of active users on a website: https://umami.is/docs/api/website-stats#get-apiwebsiteswebsiteidactive */
     async function get_WEBSITEID_Active(websiteId) {
         return await this.request("get", ["websites", websiteId, "active"]);
     }
     WebsiteStats.get_WEBSITEID_Active = get_WEBSITEID_Active;
-    /** Gets events within a given time range: https://umami.is/docs/api/website-stats#get-apiwebsiteswebsiteideventsseries (TODO UNTESTED) */
+    /** Gets events within a given time range: https://umami.is/docs/api/website-stats#get-apiwebsiteswebsiteideventsseries */
     async function get_WEBSITEID_EventsSeries(websiteId, parameters) {
-        return await this.request("get", ["websites", websiteId, "events", "series"], parameters);
+        const response = await this.request("get", ["websites", websiteId, "events", "series"], parameters);
+        response.t = new Date(response.t);
+        return response;
     }
     WebsiteStats.get_WEBSITEID_EventsSeries = get_WEBSITEID_EventsSeries;
     /** Gets metrics for a given time range: https://umami.is/docs/api/website-stats#get-apiwebsiteswebsiteidmetrics (TODO UNTESTED) */
@@ -23,7 +25,10 @@ export var WebsiteStats;
     WebsiteStats.get_WEBSITEID_MetricsExpanded = get_WEBSITEID_MetricsExpanded;
     /** Gets pageviews within a given time range: https://umami.is/docs/api/website-stats#get-apiwebsiteswebsiteidpageviews (TODO UNTESTED) */
     async function get_WEBSITEID_Pageviews(websiteId, parameters) {
-        return await this.request("get", ["websites", websiteId, "pageviews"], parameters);
+        const response = await this.request("get", ["websites", websiteId, "pageviews"], parameters);
+        response.pageviews = response.pageviews.map((v) => { v.x = new Date(v.x); return v; });
+        response.sessions = response.sessions.map((s) => { s.x = new Date(s.x); return s; });
+        return response;
     }
     WebsiteStats.get_WEBSITEID_Pageviews = get_WEBSITEID_Pageviews;
     /** Gets summarized website statistics: https://umami.is/docs/api/website-stats#get-apiwebsiteswebsiteidstats (TODO UNTESTED) */

package/dist/namespaces/Websites.d.ts

@@ -16,7 +16,7 @@ export declare namespace Websites {
         deletedAt: Date | null;
     }
     interface WebsiteWithCreateuser extends Website {
-        user: Users.MinimalUser;
+        createUser: Users.MinimalUser;
     }
     interface WebsiteWithUser extends Website {
         user: Users.MinimalUser;

package/dist/utilities.js

@@ -56,7 +56,7 @@ export function correctType(x, force_string) {
         const vals = Object.values(x);
         // If a key is any of those, the value is expected to be a string, so we use `force_string` to make correctType convert them to string for us
         const unconvertables = ["value"];
-        const unconvertables_substrings = ["string", "name"]; // or if the key contains any of those substrings
+        const unconvertables_substrings = ["string", "name", "Id"]; // 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)));
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "umami-api-js",
-  "version": "0.1.2",
+  "version": "0.1.4",
   "description": "Package to easily access the umami api!",
   "type": "module",
   "main": "dist/index.js",
@@ -30,9 +30,9 @@
   "devDependencies": {
     "@types/chai": "^5.2.3",
     "@types/node": "^24.9.2",
-    "chai": "^6.2.0",
+    "chai": "^6.2.2",
     "dotenv": "^17.2.3",
-    "typedoc": "^0.28.14",
+    "typedoc": "^0.28.16",
     "typescript": "^5.9.3"
   }
 }