umami-api-js 0.1.0 → 0.1.2

package/README.md

@@ -1,5 +1,5 @@
-A package to interact with [the API of self-hosted instances of Umami v3.0.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).
+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).
 
-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.0**, 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.2**, 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.0**, 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.1**, 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,34 +11,18 @@ 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 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 DeletionResult {
+    ok: boolean;
 }
 export interface Report extends Omit<GenericObject, "deletedAt"> {
-    userId: string;
-    websiteId: string;
+    userId: Users.User["id"];
+    websiteId: Websites.Website["id"];
     type: string;
     name: string;
     description: string;
@@ -65,6 +49,7 @@ export interface Timestamps {
     /** Timestamp of end date */
     endAt: Date | number;
 }
+/** An object with the properties `x`, `t`, and `y`, where they're respectively a name, a date, and an amount */
 export interface XTY {
     /** Event name */
     x: string;
@@ -107,8 +92,6 @@ export interface Filters {
     /** 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}! */
 export declare class APIError extends Error {
     message: string;
@@ -160,7 +143,10 @@ export declare class API {
     get server(): string;
     set server(server: string);
     private _headers;
-    /** Used in practically all requests, those are all the headers the package uses excluding `Authorization`, the one with the token */
+    /**
+     * Used in practically all requests, those are all the headers the package uses excluding `Authorization`, the one with the token
+     * @remarks If the User-Agent is not liked by https://isbot.js.org/, Umami might give responses akin to `{beep: "boop"}`
+     */
     get headers(): {
         [key: string]: any;
     };
@@ -169,20 +155,8 @@ export declare class API {
     });
     private _user;
     /** Information about the account that has been used to log in */
-    get user(): {
-        id: string;
-        username: string;
-        role: Role;
-        createdAt: Date;
-        isAdmin: boolean;
-    };
-    set user(user: {
-        id: string;
-        username: string;
-        role: Role;
-        createdAt: Date;
-        isAdmin: boolean;
-    });
+    get user(): Users.User;
+    set user(user: Users.User);
     private number_of_requests;
     /** Has {@link API.setNewToken} been called and not yet returned anything? */
     private is_setting_token;
@@ -276,37 +250,34 @@ export declare class API {
     }): Promise<any>;
     /**
      * To register an event
-     * (TODO UNTESTED)
      * @group Sending stats
      */
-    sendStats(payload: {
+    sendStats(websiteId: Websites.Website["id"], payload?: {
         /** Name of host */
-        hostname: string;
+        hostname?: Events.Event["hostname"];
         /** Screen resolution (ex. "1920x1080") */
-        screen: string;
+        screen?: string;
         /** Language of visitor (ex. "en-US") */
-        language: string;
+        language?: string;
         /** Page URL */
-        url: string;
+        url?: string;
         /** Referrer URL */
-        referrer: string;
+        referrer?: string;
         /** Page title */
-        title: string;
+        title?: string;
         /** Additional tag description */
-        tag: string;
+        tag?: string;
         /** Session identifier */
-        id: string;
-        /** Website ID */
-        website: string;
+        id?: Events.Event["sessionId"];
         /** Name of the event */
-        name: string;
+        name?: Events.Event["eventName"];
         /** Additional data for the event */
         data?: {
             [k: string]: any;
         };
     }): Promise<{
         cache: string;
-        sessionid: string;
+        sessionId: Events.Event["sessionId"];
         visitId: string;
     }>;
     /** @group Admin endpoints */

package/dist/index.js

@@ -94,15 +94,18 @@ export class API {
         "Accept": "application/json",
         "Accept-Encoding": "gzip",
         "Content-Type": "application/json",
-        "User-Agent": "umami-api-js (https://codeberg.org/Taevas/umami-api-js)",
+        "User-Agent": "umami-api-js (codeberg.org/Taevas/umami-api-js)",
     };
-    /** Used in practically all requests, those are all the headers the package uses excluding `Authorization`, the one with the token */
+    /**
+     * Used in practically all requests, those are all the headers the package uses excluding `Authorization`, the one with the token
+     * @remarks If the User-Agent is not liked by https://isbot.js.org/, Umami might give responses akin to `{beep: "boop"}`
+     */
     get headers() { return this._headers; }
     set headers(headers) { this._headers = headers; }
     _user = {
         id: "",
         username: "",
-        role: "",
+        role: "view-only",
         createdAt: new Date(),
         isAdmin: false,
     };
@@ -384,11 +387,10 @@ export class API {
     // UNCATEGORIZED
     /**
      * To register an event
-     * (TODO UNTESTED)
      * @group Sending stats
      */
-    async sendStats(payload) {
-        return await this.request("post", ["send"], { payload, type: "event" });
+    async sendStats(websiteId, payload) {
+        return await this.request("post", ["send"], { payload: { website: websiteId, ...payload }, type: "event" });
     }
     // ADMIN
     /** @group Admin endpoints */

package/dist/namespaces/Admin.d.ts

@@ -1,10 +1,10 @@
-import { API, GenericObject, GenericRequestParameters, MinimalUser, Role, Teams, Website } from "../index.js";
+import { API, GenericObject, 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: Role;
+        role: Users.Role;
         logoUrl: string | null;
         displayName: string | null;
         _count: {
@@ -12,20 +12,10 @@ export declare namespace Admin {
         };
     })[]>;
     /** Returns all websites: https://umami.is/docs/api/admin#get-apiadminwebsites */
-    function getWebsites(this: API, parameters?: GenericRequestParameters): Promise<(Website & {
-        user: MinimalUser;
+    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 */
         team: string | null;
     })[]>;
     /** Returns all teams: https://umami.is/docs/api/admin#get-apiadminteams */
-    function getTeams(this: API, parameters?: GenericRequestParameters): Promise<(GenericObject & {
-        name: string;
-        accessCode: string;
-        logoUrl: string | null;
-        members: Teams.TeamMember[];
-        _count: {
-            websites: number;
-            members: number;
-        };
-    })[]>;
+    function getTeams(this: API, parameters?: GenericRequestParameters): Promise<Teams.TeamWithMembersCount[]>;
 }

package/dist/namespaces/Events.d.ts

@@ -1,35 +1,36 @@
-import { API, Filters, GenericRequestParameters, Timestamps } from "../index.js";
+import { API, Filters, GenericRequestParameters, Timestamps, Websites } from "../index.js";
 /** Operations around Events and Event data: https://umami.is/docs/api/events */
 export declare namespace Events {
-    /** Gets website event details within a given time range: https://umami.is/docs/api/events#get-apiwebsiteswebsiteidevents (TODO UNTESTED) */
-    function get_WEBSITEID_Events(this: API, websiteId: string, parameters: Filters & Timestamps & GenericRequestParameters): Promise<{
+    interface Event {
         id: string;
-        websiteId: string;
+        websiteId: Websites.Website["id"];
         sessionId: string;
         createdAt: Date;
         hostname: string;
         urlPath: string;
         urlQuery: string;
-        referrerPath: string;
-        referrerQuery: string;
-        referrerDomain: string;
+        referrerPath: string | null;
+        referrerQuery: string | null;
+        referrerDomain: string | null;
         country: string;
         city: string;
         device: string;
-        os: string;
-        browser: string;
-        pageTitle: string;
+        os: string | null;
+        browser: string | null;
+        pageTitle: string | null;
         eventType: number;
         eventName: string;
-        hasData: number;
-    }[]>;
-    /** Gets event-data for a individual event: https://umami.is/docs/api/events#get-apiwebsiteswebsiteidevent-dataeventid (TODO UNTESTED) */
-    function get_WEBSITEID_Eventdata_EVENTID(this: API, websiteId: string, eventId: string): Promise<{
-        websiteId: string;
-        sessionId: string;
-        eventId: string;
-        urlPath: string;
-        eventName: string;
+        hasData?: number;
+    }
+    /** Gets website event details within a given time range: https://umami.is/docs/api/events#get-apiwebsiteswebsiteidevents */
+    function get_WEBSITEID_Events(this: API, websiteId: Websites.Website["id"], parameters: Filters & Timestamps & GenericRequestParameters): Promise<Event[]>;
+    /** 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;
+        eventId: Event["id"];
+        urlPath?: string;
+        eventName: Event["eventName"];
         dataKey: string;
         stringValue: string;
         numberValue: number | null;
@@ -37,43 +38,43 @@ export declare namespace Events {
         dataType: number;
         createdAt: Date;
     }[]>;
-    /** Gets event data names, properties, and counts: https://umami.is/docs/api/events#get-apiwebsiteswebsiteidevent-dataevents (TODO UNTESTED) */
-    function get_WEBSITEID_EventdataEvents(this: API, websiteId: string, parameters: Filters & Timestamps & {
+    /** Gets event data names, properties, and counts: https://umami.is/docs/api/events#get-apiwebsiteswebsiteidevent-dataevents (TODO Server returns a 500) */
+    function get_WEBSITEID_EventdataEvents(this: API, websiteId: Websites.Website["id"], parameters: Filters & Timestamps & {
         /** Event name filter */
-        event?: string;
+        event?: Event["eventName"];
     }): Promise<{
-        eventName: string;
+        eventName: Event["eventName"];
         propertyName: string;
         dataType: number;
         total: number;
     }[]>;
-    /** Gets event data property and value counts within a given time range: https://umami.is/docs/api/events#get-apiwebsiteswebsiteidevent-datafields (TODO UNTESTED) */
-    function get_WEBSITEID_EventdataFields(this: API, websiteId: string, parameters: Filters & Timestamps): Promise<{
+    /** Gets event data property and value counts within a given time range: https://umami.is/docs/api/events#get-apiwebsiteswebsiteidevent-datafields */
+    function get_WEBSITEID_EventdataFields(this: API, websiteId: Websites.Website["id"], 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#get-apiwebsiteswebsiteidevent-dataproperties (TODO UNTESTED) */
-    function get_WEBSITEID_EventdataProperties(this: API, websiteId: string, parameters: Filters & Timestamps): Promise<{
-        eventName: string;
+    /** Gets event name and property counts for a website: https://umami.is/docs/api/events#get-apiwebsiteswebsiteidevent-dataproperties */
+    function get_WEBSITEID_EventdataProperties(this: API, websiteId: Websites.Website["id"], parameters: Filters & Timestamps): Promise<{
+        eventName: Event["eventName"] | null;
         propertyName: string;
         total: number;
     }[]>;
-    /** Gets event data counts for a given event and property: https://umami.is/docs/api/events#get-apiwebsiteswebsiteidevent-datavalues (TODO UNTESTED) */
-    function get_WEBSITEID_EventdataValues(this: API, websiteId: string, parameters: Filters & Timestamps & {
+    /** Gets event data counts for a given event and property: https://umami.is/docs/api/events#get-apiwebsiteswebsiteidevent-datavalues */
+    function get_WEBSITEID_EventdataValues(this: API, websiteId: Websites.Website["id"], parameters: Filters & Timestamps & {
         /** Event name filter */
-        event: string;
+        event: Event["eventName"];
         /** Property name */
         propertyName: string;
     }): Promise<{
         value: string;
         total: number;
-    }>;
-    /** Gets aggregated website events, properties, and records within a given time range: https://umami.is/docs/api/events#get-apiwebsiteswebsiteidevent-datastats (TODO UNTESTED) */
-    function get_WEBSITEID_EventdataStats(this: API, websiteId: string, parameters: Filters & Timestamps): Promise<{
+    }[]>;
+    /** Gets aggregated website events, properties, and records within a given time range: https://umami.is/docs/api/events#get-apiwebsiteswebsiteidevent-datastats */
+    function get_WEBSITEID_EventdataStats(this: API, websiteId: Websites.Website["id"], parameters: Filters & Timestamps): Promise<{
         events: number;
         properties: number;
         records: number;
-    }[]>;
+    }>;
 }

package/dist/namespaces/Events.js

@@ -1,38 +1,38 @@
 /** Operations around Events and Event data: https://umami.is/docs/api/events */
 export var Events;
 (function (Events) {
-    /** Gets website event details within a given time range: https://umami.is/docs/api/events#get-apiwebsiteswebsiteidevents (TODO UNTESTED) */
+    /** Gets website event details within a given time range: https://umami.is/docs/api/events#get-apiwebsiteswebsiteidevents */
     async function get_WEBSITEID_Events(websiteId, parameters) {
         const response = await this.request("get", ["websites", websiteId, "events"], parameters);
         return response.data;
     }
     Events.get_WEBSITEID_Events = get_WEBSITEID_Events;
-    /** Gets event-data for a individual event: https://umami.is/docs/api/events#get-apiwebsiteswebsiteidevent-dataeventid (TODO UNTESTED) */
+    /** Gets event-data for a individual event: https://umami.is/docs/api/events#get-apiwebsiteswebsiteidevent-dataeventid */
     async function get_WEBSITEID_Eventdata_EVENTID(websiteId, eventId) {
         return await this.request("get", ["websites", websiteId, "event-data", eventId]);
     }
     Events.get_WEBSITEID_Eventdata_EVENTID = get_WEBSITEID_Eventdata_EVENTID;
-    /** Gets event data names, properties, and counts: https://umami.is/docs/api/events#get-apiwebsiteswebsiteidevent-dataevents (TODO UNTESTED) */
+    /** Gets event data names, properties, and counts: https://umami.is/docs/api/events#get-apiwebsiteswebsiteidevent-dataevents (TODO Server returns a 500) */
     async function get_WEBSITEID_EventdataEvents(websiteId, parameters) {
         return await this.request("get", ["websites", websiteId, "event-data", "events"], parameters);
     }
     Events.get_WEBSITEID_EventdataEvents = get_WEBSITEID_EventdataEvents;
-    /** Gets event data property and value counts within a given time range: https://umami.is/docs/api/events#get-apiwebsiteswebsiteidevent-datafields (TODO UNTESTED) */
+    /** Gets event data property and value counts within a given time range: https://umami.is/docs/api/events#get-apiwebsiteswebsiteidevent-datafields */
     async function get_WEBSITEID_EventdataFields(websiteId, parameters) {
         return await this.request("get", ["websites", websiteId, "event-data", "fields"], parameters);
     }
     Events.get_WEBSITEID_EventdataFields = get_WEBSITEID_EventdataFields;
-    /** Gets event name and property counts for a website: https://umami.is/docs/api/events#get-apiwebsiteswebsiteidevent-dataproperties (TODO UNTESTED) */
+    /** Gets event name and property counts for a website: https://umami.is/docs/api/events#get-apiwebsiteswebsiteidevent-dataproperties */
     async function get_WEBSITEID_EventdataProperties(websiteId, parameters) {
         return await this.request("get", ["websites", websiteId, "event-data", "properties"], parameters);
     }
     Events.get_WEBSITEID_EventdataProperties = get_WEBSITEID_EventdataProperties;
-    /** Gets event data counts for a given event and property: https://umami.is/docs/api/events#get-apiwebsiteswebsiteidevent-datavalues (TODO UNTESTED) */
+    /** Gets event data counts for a given event and property: https://umami.is/docs/api/events#get-apiwebsiteswebsiteidevent-datavalues */
     async function get_WEBSITEID_EventdataValues(websiteId, parameters) {
         return await this.request("get", ["websites", websiteId, "event-data", "values"], parameters);
     }
     Events.get_WEBSITEID_EventdataValues = get_WEBSITEID_EventdataValues;
-    /** Gets aggregated website events, properties, and records within a given time range: https://umami.is/docs/api/events#get-apiwebsiteswebsiteidevent-datastats (TODO UNTESTED) */
+    /** Gets aggregated website events, properties, and records within a given time range: https://umami.is/docs/api/events#get-apiwebsiteswebsiteidevent-datastats */
     async function get_WEBSITEID_EventdataStats(websiteId, parameters) {
         return await this.request("get", ["websites", websiteId, "event-data", "stats"], parameters);
     }

package/dist/namespaces/Links.d.ts

@@ -1,11 +1,11 @@
-import { API, GenericObject, GenericRequestParameters } from "../index.js";
+import { API, DeletionResult, GenericObject, GenericRequestParameters, Users } from "../index.js";
 /** Operations around Links management: https://umami.is/docs/api/links */
 export declare namespace Links {
     interface Link extends GenericObject {
         name: string;
         url: string;
         slug: string;
-        userId: string;
+        userId: Users.User["id"];
         teamid: string | null;
     }
     /** Returns all user links: https://umami.is/docs/api/links#get-apilinks (TODO UNTESTED) */
@@ -15,14 +15,12 @@ export declare namespace Links {
     /** Updates a link: https://umami.is/docs/api/links#post-apilinkslinkid (TODO UNTESTED) */
     function post_LINKID(this: API, linkId: Link["id"], parameters: {
         /** The link's name */
-        name?: string;
+        name?: Link["name"];
         /** The link's destination URL */
-        url?: string;
+        url?: Link["url"];
         /** The link's URL slug, **with a minimum of 8 characters** */
-        slug?: string;
+        slug?: Link["slug"];
     }): Promise<Link>;
     /** Deletes a link: https://umami.is/docs/api/links#delete-apilinkslinkid (TODO UNTESTED) */
-    function delete_LINKID(this: API, linkId: Link["id"]): Promise<{
-        ok: boolean;
-    }>;
+    function delete_LINKID(this: API, linkId: Link["id"]): Promise<DeletionResult>;
 }

package/dist/namespaces/Me.d.ts

@@ -1,44 +1,24 @@
-import { API, GenericObject, MinimalUser, Role, TeamRole } from "../index.js";
+import { API, GenericObject, Teams, Users } 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 (TODO UNTESTED) */
+    /** Get information based on your auth token: https://umami.is/docs/api/me#get-apime */
     function get(this: API): Promise<{
         token: string;
         authKey: string;
         shareToken: string | null;
-        user: {
-            id: string;
-            username: string;
-            role: Role;
-            createdAt: Date;
-            isAdmin: boolean;
-        };
+        user: Users.User;
     }>;
-    /** Get all your teams: https://umami.is/docs/api/me#get-apimeteams (TODO UNTESTED) */
-    function getTeams(this: API): Promise<(GenericObject & {
-        name: string;
-        accessCode: string;
-        logoUrl: string | null;
-        members: (Omit<GenericObject, "deletedAt"> & {
-            teamId: string;
-            userId: string;
-            role: TeamRole;
-            user: MinimalUser;
-        })[];
-        _count: {
-            websites: number;
-            members: number;
-        };
-    })[]>;
-    /** Get all your websites: https://umami.is/docs/api/me#get-apimeteams (TODO UNTESTED) */
+    /** 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: string;
+        userId: Users.User["id"];
         teamId: string | null;
         createdBy: string;
-        user: MinimalUser;
+        user: Users.MinimalUser;
     })[]>;
 }

package/dist/namespaces/Me.js

@@ -1,18 +1,18 @@
 /** All information about your session: https://umami.is/docs/api/me */
 export var Me;
 (function (Me) {
-    /** Get information based on your auth token: https://umami.is/docs/api/me#get-apime (TODO UNTESTED) */
+    /** Get information based on your auth token: https://umami.is/docs/api/me#get-apime */
     async function get() {
         return await this.request("get", ["me"]);
     }
     Me.get = get;
-    /** Get all your teams: https://umami.is/docs/api/me#get-apimeteams (TODO UNTESTED) */
+    /** Get all your teams: https://umami.is/docs/api/me#get-apimeteams */
     async function getTeams() {
         const response = await this.request("get", ["me", "teams"]);
         return response.data;
     }
     Me.getTeams = getTeams;
-    /** Get all your websites: https://umami.is/docs/api/me#get-apimeteams (TODO UNTESTED) */
+    /** Get all your websites: https://umami.is/docs/api/me#get-apimeteams */
     async function getWebsites() {
         const response = await this.request("get", ["me", "websites"]);
         return response.data;

package/dist/namespaces/Pixels.d.ts

@@ -1,10 +1,10 @@
-import { API, GenericObject, GenericRequestParameters } from "../index.js";
+import { API, DeletionResult, GenericObject, GenericRequestParameters, Users } from "../index.js";
 /** Operations around Pixels management: https://umami.is/docs/api/pixels */
 export declare namespace Pixels {
     interface Pixel extends GenericObject {
         name: string;
         slug: string;
-        userId: string;
+        userId: Users.User["id"];
         teamid: string | null;
     }
     /** Returns all user pixels: https://umami.is/docs/api/pixels#get-apipixels (TODO UNTESTED) */
@@ -14,12 +14,10 @@ export declare namespace Pixels {
     /** Updates a pixel: https://umami.is/docs/api/pixels#post-apipixelspixelid (TODO UNTESTED) */
     function post_PIXELID(this: API, pixelId: Pixel["id"], parameters: {
         /** The pixel's name */
-        name?: string;
+        name?: Pixel["name"];
         /** The pixel's URL slug, **with a minimum of 8 characters** */
-        slug?: string;
+        slug?: Pixel["slug"];
     }): Promise<Pixel>;
     /** Deletes a pixel: https://umami.is/docs/api/pixels#delete-apipixelspixelid (TODO UNTESTED) */
-    function delete_PIXELID(this: API, pixelId: Pixel["id"]): Promise<{
-        ok: boolean;
-    }>;
+    function delete_PIXELID(this: API, pixelId: Pixel["id"]): Promise<DeletionResult>;
 }

package/dist/namespaces/Realtime.d.ts

@@ -1,8 +1,8 @@
-import { API } from "../index.js";
+import { API, 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) */
-    function get_WEBSITEID(this: API, websiteId: string): Promise<{
+    function get_WEBSITEID(this: API, websiteId: Websites.Website["id"]): Promise<{
         countries: {
             [k: string]: number;
         };

package/dist/namespaces/Reports.d.ts

@@ -1,4 +1,4 @@
-import { API, Filters, GenericRequestParameters, NameValue, Report, Timestamps, XTY } from "../index.js";
+import { API, DeletionResult, Filters, GenericRequestParameters, NameValue, Report, Timestamps, Websites, XTY } from "../index.js";
 /** Using reports throught the api: https://umami.is/docs/api/reports */
 export declare namespace Reports {
     type ReportType = {
@@ -9,9 +9,9 @@ export declare namespace Reports {
         views: number;
     }
     /** Get all reports by website ID: https://umami.is/docs/api/reports#get-apireports (TODO UNTESTED) */
-    function get(this: API, websiteId: string, parameters: ReportType & Omit<GenericRequestParameters, "search">): Promise<Report[]>;
+    function get(this: API, websiteId: Websites.Website["id"], parameters: ReportType & Omit<GenericRequestParameters, "search">): Promise<Report[]>;
     /** Creates a report: https://umami.is/docs/api/reports#post-apireports (TODO UNTESTED) */
-    function post(this: API, websiteId: string, parameters: ReportType & {
+    function post(this: API, websiteId: Websites.Website["id"], parameters: ReportType & {
         /** Name of report */
         name: string;
         /** Description of report */
@@ -22,7 +22,7 @@ export declare namespace Reports {
     /** Gets a report by ID: https://umami.is/docs/api/reports#get-apireportsreportid (TODO UNTESTED) */
     function get_REPORTID(this: API, reportId: string): Promise<Report>;
     /** Updates a report: https://umami.is/docs/api/reports#post-apireportsreportid (TODO UNTESTED) */
-    function post_REPORTID(this: API, reportId: string, websiteId: string, parameters: ReportType & {
+    function post_REPORTID(this: API, reportId: string, websiteId: Websites.Website["id"], parameters: ReportType & {
         /** Name of report */
         name: string;
         /** Description of report */
@@ -31,11 +31,9 @@ export declare namespace Reports {
         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<{
-        ok: boolean;
-    }>;
+    function delete_REPORTID(this: API, reportId: string): 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: string, parameters: ReportType & Filters & Timestamps & {
+    function postAttribution(this: API, websiteId: Websites.Website["id"], parameters: ReportType & Filters & Timestamps & {
         /** Attribution model */
         model: "firstClick" | "lastClick";
         /** Conversion type */
@@ -57,7 +55,7 @@ export declare namespace Reports {
         };
     }>;
     /** Dive deeper into your data by using segments and filters: https://umami.is/docs/api/reports#post-apireportsbreakdown (TODO UNTESTED) */
-    function postBreakdown(this: API, websiteId: string, parameters: ReportType & Filters & Timestamps & {
+    function postBreakdown(this: API, websiteId: Websites.Website["id"], parameters: ReportType & Filters & Timestamps & {
         fields: ("path" | "title" | "query" | "referrer" | "browser" | "os" | "device" | "country" | "region" | "city" | "hostname" | "tag" | "event")[];
     }): Promise<{
         views: number;
@@ -69,7 +67,7 @@ export declare namespace Reports {
         country: string;
     }[]>;
     /** Understand the conversion and drop-off rate of users: https://umami.is/docs/api/reports#post-apireportsfunnel (TODO UNTESTED) */
-    function postFunnel(this: API, websiteId: string, parameters: ReportType & Filters & Timestamps & {
+    function postFunnel(this: API, websiteId: Websites.Website["id"], parameters: ReportType & Filters & Timestamps & {
         /** Type of event and conversion step */
         steps: {
             type: "path" | "event";
@@ -87,7 +85,7 @@ export declare namespace Reports {
         remaining: number;
     }[]>;
     /** Track your goals for pageviews and events: https://umami.is/docs/api/reports#post-apireportsgoals (TODO UNTESTED) */
-    function postGoals(this: API, websiteId: string, parameters: ReportType & Filters & Timestamps & {
+    function postGoals(this: API, websiteId: Websites.Website["id"], parameters: ReportType & Filters & Timestamps & {
         /** Conversion type */
         type: ("path" | "event")[];
         /** Conversion step value */
@@ -97,7 +95,7 @@ export declare namespace Reports {
         total: number;
     }>;
     /** Understand how users nagivate through your website: https://umami.is/docs/api/reports#post-apireportsjourney (TODO UNTESTED) */
-    function postJourney(this: API, websiteId: string, parameters: ReportType & Filters & Timestamps & {
+    function postJourney(this: API, websiteId: Websites.Website["id"], parameters: ReportType & Filters & Timestamps & {
         /** Number of steps from 3 to 7 */
         steps: number;
         /** Starting step URL or event name */
@@ -109,7 +107,7 @@ export declare namespace Reports {
         count: number;
     }[]>;
     /** Measure your website stickiness by tracking how often users return: https://umami.is/docs/api/reports#post-apireportsretention (TODO UNTESTED) */
-    function postRetention(this: API, websiteId: string, parameters: ReportType & Filters & Timestamps & {
+    function postRetention(this: API, websiteId: Websites.Website["id"], parameters: ReportType & Filters & Timestamps & {
         /** Timezone (ex. America/Los_Angeles) */
         timezone: string;
     }): Promise<{
@@ -120,7 +118,7 @@ export declare namespace Reports {
         percentage: number;
     }[]>;
     /** Get currency for given range. Needed for Revenue and optional in Attribution reports: https://umami.is/docs/api/reports#post-apireportsrevenue (TODO UNTESTED) */
-    function postRevenue(this: API, websiteId: string, parameters: ReportType & Filters & Timestamps & {
+    function postRevenue(this: API, websiteId: Websites.Website["id"], parameters: ReportType & Filters & Timestamps & {
         /** Timezone (ex. America/Los_Angeles) */
         timezone: string;
         /** Currency code (ISO 4217) */
@@ -136,7 +134,7 @@ export declare namespace Reports {
         };
     }>;
     /** Track your campaigns through UTM parameters: https://umami.is/docs/api/reports#post-apireportsutm (TODO UNTESTED) */
-    function postUTM(this: API, websiteId: string, parameters: ReportType & Filters & Timestamps): Promise<{
+    function postUTM(this: API, websiteId: Websites.Website["id"], parameters: ReportType & Filters & Timestamps): Promise<{
         utm_source: UTM[];
         utm_medium: UTM[];
         utm_campaign: UTM[];

package/dist/namespaces/Sessions.d.ts

@@ -1,9 +1,9 @@
-import { API, Filters, GenericRequestParameters, Timestamps } from "../index.js";
+import { API, 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 {
         id: string;
-        websiteId: string;
+        websiteId: Websites.Website["id"];
         browser: string;
         os: string;
         device: string;
@@ -18,12 +18,12 @@ export declare namespace Sessions {
         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: string, parameters: Filters & Timestamps & GenericRequestParameters): Promise<(GenericSession & {
+    function get_WEBSITEID_Sessions(this: API, websiteId: Websites.Website["id"], parameters: Filters & Timestamps & GenericRequestParameters): Promise<(GenericSession & {
         hostname: string;
         createdAt: Date;
     })[]>;
     /** Gets summarized website session statistics: https://umami.is/docs/api/sessions#get-apiwebsiteswebsiteidsessionsstats (TODO UNTESTED) */
-    function get_WEBSITEID_SessionsStats(this: API, websiteId: string, parameters: Filters & Timestamps): Promise<{
+    function get_WEBSITEID_SessionsStats(this: API, websiteId: Websites.Website["id"], parameters: Filters & Timestamps): Promise<{
         /** Pages hits */
         pageviews: {
             value: number;
@@ -46,17 +46,17 @@ export declare namespace Sessions {
         };
     }>;
     /** Get collected count of sessions by hour of weekday: https://umami.is/docs/api/sessions#get-apiwebsiteswebsiteidsessionsweekly (TODO UNTESTED) */
-    function get_WEBSITEID_SessionsWeekly(this: API, websiteId: string, parameters: Filters & Timestamps & {
+    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: string, sessionId: string): Promise<GenericSession & {
+    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: string, sessionId: string, parameters: Timestamps): Promise<{
+    function get_WEBSITEID_Sessions_SESSIONID_Activity(this: API, websiteId: Websites.Website["id"], sessionId: string, parameters: Timestamps): Promise<{
         createdAt: Date;
         urlPath: string;
         urlQuery: string;
@@ -68,8 +68,8 @@ export declare namespace Sessions {
         hasData: number;
     }[]>;
     /** 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: string, sessionId: string): Promise<{
-        websiteId: string;
+    function get_WEBSITEID_Sessions_SESSIONID_Properties(this: API, websiteId: Websites.Website["id"], sessionId: string): Promise<{
+        websiteId: Websites.Website["id"];
         sessionid: string;
         dataKey: string;
         dataType: number;
@@ -79,12 +79,12 @@ export declare namespace Sessions {
         createdAt: Date;
     }[]>;
     /** Gets session data counts by property name: https://umami.is/docs/api/sessions#get-apiwebsiteswebsiteidsession-dataproperties (TODO UNTESTED) */
-    function get_WEBSITEID_SessiondataProperties(this: API, websiteId: string, parameters: Filters & Timestamps): Promise<{
+    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) */
-    function get_WEBSITEID_SessiondataValues(this: API, websiteId: string, parameters: Filters & Timestamps & {
+    function get_WEBSITEID_SessiondataValues(this: API, websiteId: Websites.Website["id"], parameters: Filters & Timestamps & {
         propertyName: string;
     }): Promise<{
         value: string;

package/dist/namespaces/Teams.d.ts

@@ -1,35 +1,45 @@
-import { API, GenericObject, GenericRequestParameters, TeamRole } from "../index.js";
+import { API, DeletionResult, GenericRequestParameters, Users, Websites } from "../index.js";
 /** Operations around Team management: https://umami.is/docs/api/teams */
 export declare namespace Teams {
-    interface GenericTeam extends GenericObject {
+    interface Team {
+        id: string;
         name: string;
         accessCode: string;
         logoUrl: string | null;
+        createdAt: Date;
+        updatedAt: Date | null;
+        deletedAt: Date | null;
     }
-    interface TeamMember extends Omit<GenericObject, "deletedAt"> {
-        teamId: string;
-        userId: string;
+    interface TeamMember {
+        id: string;
+        teamId: Team["id"];
+        userId: Users.User["id"];
         role: TeamRole;
-        user: {
-            id: string;
-            username: string;
-        };
+        createdAt: Date;
+        updatedAt: Date;
     }
-    /** Returns all teams: https://umami.is/docs/api/teams#get-apiteams (TODO UNTESTED) */
-    function get(this: API, parameters?: Omit<GenericRequestParameters, "search">): Promise<(GenericTeam & {
-        members: TeamMember[];
+    interface TeamMemberWithUser extends TeamMember {
+        user: Users.MinimalUser;
+    }
+    interface TeamWithMembers extends Team {
+        members: TeamMemberWithUser[];
+    }
+    interface TeamWithMembersCount extends TeamWithMembers {
         _count: {
             websites: number;
             members: number;
         };
-    })[]>;
+    }
+    type TeamRole = "team-manager" | "team-member" | "team-view-only";
+    /** Returns all teams: https://umami.is/docs/api/teams#get-apiteams (TODO UNTESTED) */
+    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<[GenericTeam, Omit<TeamMember, "user">]>;
+    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<Omit<TeamMember, "user">>;
+    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<GenericTeam & {
-        members: Omit<TeamMember, "user">[];
+    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: {
@@ -37,40 +47,24 @@ export declare namespace Teams {
         name?: string;
         /** The team's access code */
         accessCode?: string;
-    }): Promise<GenericTeam>;
+    }): Promise<Team>;
     /** Delete a team: https://umami.is/docs/api/teams#delete-apiteamsteamid (TODO UNTESTED) */
-    function delete_TEAMID(this: API, teamId: string): Promise<{
-        ok: boolean;
-    }>;
+    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<TeamMember[]>;
+    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: {
         /** ID of user to be added */
-        userId: string;
+        userId: Users.User["id"];
         /** Team role for user */
         role: TeamRole;
-    }): Promise<Omit<TeamMember, "user">>;
+    }): 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: string): Promise<Omit<TeamMember, "user">>;
+    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: string, role: TeamRole): Promise<Omit<TeamMember, "user">>;
+    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: string): Promise<{
-        ok: boolean;
-    }>;
+    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<(GenericObject & {
-        name: string;
-        domain: string;
-        shareId: string;
-        resetAt: Date | null;
-        userId: string | null;
-        teamId: string | null;
-        createdBy: string;
-        createUser: {
-            id: string;
-            username: string;
-        };
-    })[]>;
+    function get_TEAMID_Websites(this: API, teamId: string, parameters: GenericRequestParameters): Promise<Websites.WebsiteWithCreateuser[]>;
 }

package/dist/namespaces/Users.d.ts

@@ -1,9 +1,22 @@
-import { API, GenericObject, GenericRequestParameters, MinimalUser, Role, TeamRole, Website } from "../index.js";
+import { API, DeletionResult, GenericRequestParameters, Teams, Websites } from "../index.js";
 /** Operations around User management: https://umami.is/docs/api/users */
 export declare namespace Users {
-    interface GenericUser extends MinimalUser {
+    type Role = "admin" | "user" | "view-only";
+    interface MinimalUser {
+        id: string;
+        username: string;
+    }
+    interface MinimalUserWithRole extends MinimalUser {
         role: Role;
     }
+    interface MinimalUserWithCreatedAt extends MinimalUserWithRole {
+        createdAt: Date;
+    }
+    interface MinimalUserWithRoleCreatedAt extends MinimalUserWithRole, MinimalUserWithCreatedAt {
+    }
+    interface User extends MinimalUserWithCreatedAt {
+        isAdmin: boolean;
+    }
     /** Creates a user: https://umami.is/docs/api/users#post-apiusers */
     function post(this: API, parameters: {
         /** The user's username */
@@ -14,46 +27,24 @@ export declare namespace Users {
         role: Role;
         /** Force a UUID assignment to the user */
         id?: string;
-    }): Promise<GenericUser>;
+    }): Promise<MinimalUserWithRole>;
     /** Gets a user by ID: https://umami.is/docs/api/users#get-apiusersuserid */
-    function get_USERID(this: API, userId: string): Promise<GenericUser & {
-        createdAt: Date;
-    }>;
+    function get_USERID(this: API, userId: User["id"]): Promise<MinimalUserWithRoleCreatedAt>;
     /** Updates a user: https://umami.is/docs/api/users#post-apiusersuserid */
-    function post_USERID(this: API, userId: string, parameters?: {
+    function post_USERID(this: API, userId: User["id"], parameters?: {
         /** The user's username */
         username?: string;
         /** The user's password */
         password?: string;
         /** The user's role */
         role?: Role;
-    }): Promise<GenericUser & {
-        createdAt: Date;
-    }>;
+    }): Promise<MinimalUserWithRoleCreatedAt>;
     /** Deletes a user: https://umami.is/docs/api/users#delete-apiusersuserid */
-    function delete_USERID(this: API, userId: string): Promise<{
-        ok: boolean;
-    }>;
+    function delete_USERID(this: API, userId: User["id"]): Promise<DeletionResult>;
     /** Gets all websites that belong to a user: https://umami.is/docs/api/users#get-apiusersuseridwebsites */
-    function get_USERID_Websites(this: API, userId: string, parameters?: GenericRequestParameters & {
+    function get_USERID_Websites(this: API, userId: User["id"], parameters?: GenericRequestParameters & {
         includeTeams?: boolean;
-    }): Promise<(Website & {
-        user: MinimalUser;
-    })[]>;
+    }): Promise<Websites.WebsiteWithUser[]>;
     /** Gets all teams that belong to a user: https://umami.is/docs/api/users#get-apiusersuseridteams */
-    function get_USERID_Teams(this: API, userId: string, parameters?: Omit<GenericRequestParameters, "search">): Promise<(GenericObject & {
-        name: string;
-        accessCode: string;
-        logoUrl: string | null;
-        members: Omit<GenericObject, "deletedAt"> & {
-            teamId: string;
-            userId: string;
-            role: TeamRole;
-            user: MinimalUser;
-        }[];
-        _count: {
-            websites: number;
-            members: number;
-        };
-    })[]>;
+    function get_USERID_Teams(this: API, userId: User["id"], parameters?: Omit<GenericRequestParameters, "search">): Promise<Teams.TeamWithMembersCount[]>;
 }

package/dist/namespaces/WebsiteStats.d.ts

@@ -1,4 +1,4 @@
-import { API, Filters, Timestamps, XTY } from "../index.js";
+import { API, Filters, Timestamps, Websites, XTY } from "../index.js";
 /** Operations around Website statistics: https://umami.is/docs/api/website-stats */
 export declare namespace WebsiteStats {
     /**
@@ -31,16 +31,16 @@ export declare namespace WebsiteStats {
     }
     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) */
-    function get_WEBSITEID_Active(this: API, websiteId: string): Promise<{
+    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) */
-    function get_WEBSITEID_EventsSeries(this: API, websiteId: string, parameters: Timestamps & Units & Filters & {
+    function get_WEBSITEID_EventsSeries(this: API, websiteId: Websites.Website["id"], 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#get-apiwebsiteswebsiteidmetrics (TODO UNTESTED) */
-    function get_WEBSITEID_Metrics(this: API, websiteId: string, parameters: Timestamps & Units & Filters & {
+    function get_WEBSITEID_Metrics(this: API, websiteId: Websites.Website["id"], parameters: Timestamps & Units & Filters & {
         /** Timezone (ex. America/Los_Angeles) */
         timezone: string;
         /** Metrics type */
@@ -61,7 +61,7 @@ export declare namespace WebsiteStats {
         name: string;
     })[]>;
     /** Gets pageviews within a given time range: https://umami.is/docs/api/website-stats#get-apiwebsiteswebsiteidpageviews (TODO UNTESTED) */
-    function get_WEBSITEID_Pageviews(this: API, websiteId: string, parameters: Timestamps & Units & Filters & {
+    function get_WEBSITEID_Pageviews(this: API, websiteId: Websites.Website["id"], parameters: Timestamps & Units & Filters & {
         /** Timezone (ex. America/Los_Angeles) */
         timezone: string;
         /** Comparison value `prev` | `yoy` */
@@ -81,7 +81,7 @@ export declare namespace WebsiteStats {
         }[];
     }>;
     /** Gets summarized website statistics: https://umami.is/docs/api/website-stats#get-apiwebsiteswebsiteidstats (TODO UNTESTED) */
-    function get_WEBSITEID_Stats(this: API, websiteId: string, parameters: Timestamps & Filters & Units & {
+    function get_WEBSITEID_Stats(this: API, websiteId: Websites.Website["id"], parameters: Timestamps & Filters & Units & {
         /** Timezone (ex. America/Los_Angeles) */
         timezone: string;
     }): Promise<Stats & {

package/dist/namespaces/Websites.d.ts

@@ -1,42 +1,57 @@
-import { API, GenericRequestParameters, MinimalUser, Website } from "../index.js";
+import { API, DeletionResult, GenericRequestParameters, Teams, Users } from "../index.js";
 /** Operations around Website management and statistics: https://umami.is/docs/api/websites */
 export declare namespace Websites {
-    /** Returns all user websites: https://umami.is/docs/api/websites#get-apiwebsites (TODO UNTESTED) */
-    function get(this: API, parameters: GenericRequestParameters & {
-        includeTeams: boolean;
-    }): Promise<(Website & {
-        user: MinimalUser;
-    })[]>;
-    /** Creates a website: https://umami.is/docs/api/websites#post-apiwebsites (TODO UNTESTED) */
+    interface Website {
+        id: string;
+        name: string;
+        domain: string;
+        shareId: string | null;
+        resetAt: Date | null;
+        /** @remarks Is null if the website is under a team (has a `teamId`) */
+        userId: Users.User["id"] | null;
+        teamId: Teams.Team["id"] | null;
+        createdBy: Users.User["id"];
+        createdAt: Date;
+        updatedAt: Date | null;
+        deletedAt: Date | null;
+    }
+    interface WebsiteWithCreateuser extends Website {
+        user: Users.MinimalUser;
+    }
+    interface WebsiteWithUser extends Website {
+        user: Users.MinimalUser;
+    }
+    /** Returns all user websites: https://umami.is/docs/api/websites#get-apiwebsites */
+    function get(this: API, parameters?: GenericRequestParameters & {
+        /** Set to true if you want to include websites where you are the team owner */
+        includeTeams?: boolean;
+    }): Promise<WebsiteWithUser[]>;
+    /** Creates a website: https://umami.is/docs/api/websites#post-apiwebsites */
     function post(this: API, parameters: {
         /** The name of the website in Umami */
-        name: string;
+        name: Website["name"];
         /** The full domain of the tracked website */
-        domain: string;
+        domain: Website["domain"];
         /** A unique string to enable a share url. Set `null` to unshare */
-        shareId?: string | null;
+        shareId?: Website["shareId"];
         /** The ID of the team the website will be created under */
-        teamId?: string;
+        teamId?: Website["teamId"];
         /** Force a UUID assignment to the website */
-        id?: string;
+        id?: Website["id"];
     }): Promise<Website>;
-    /** Gets a website by ID: https://umami.is/docs/api/websites#get-apiwebsiteswebsiteid (TODO UNTESTED) */
-    function get_WEBSITEID(this: API, websiteId: string): Promise<Website>;
-    /** Updates a website: https://umami.is/docs/api/websites#post-apiwebsiteswebsiteid (TODO UNTESTED) */
-    function post_WEBSITEID(this: API, websiteId: string, parameters: {
+    /** Gets a website by ID: https://umami.is/docs/api/websites#get-apiwebsiteswebsiteid */
+    function get_WEBSITEID(this: API, websiteId: Website["id"]): Promise<Website>;
+    /** Updates a website: https://umami.is/docs/api/websites#post-apiwebsiteswebsiteid */
+    function post_WEBSITEID(this: API, websiteId: Website["id"], parameters: {
         /** The name of the website in Umami */
-        name: string;
+        name?: Website["name"];
         /** The full domain of the tracked website */
-        domain: string;
+        domain?: Website["domain"];
         /** A unique string to enable a share url. Set `null` to unshare */
-        shareId?: string | null;
+        shareId?: Website["shareId"];
     }): Promise<Website>;
-    /** Deletes a website: https://umami.is/docs/api/websites#delete-apiwebsiteswebsiteid (TODO UNTESTED) */
-    function delete_WEBSITEID(this: API, websiteId: string): Promise<{
-        ok: boolean;
-    }>;
-    /** Resets a website by removing all data related to the website: https://umami.is/docs/api/websites#post-apiwebsiteswebsiteidreset (TODO UNTESTED) */
-    function post_WEBSITEID_Reset(this: API, websiteId: string): Promise<{
-        ok: boolean;
-    }>;
+    /** Deletes a website: https://umami.is/docs/api/websites#delete-apiwebsiteswebsiteid */
+    function delete_WEBSITEID(this: API, websiteId: Website["id"]): Promise<DeletionResult>;
+    /** Resets a website by removing all data related to the website: https://umami.is/docs/api/websites#post-apiwebsiteswebsiteidreset */
+    function post_WEBSITEID_Reset(this: API, websiteId: Website["id"]): Promise<DeletionResult>;
 }

package/dist/namespaces/Websites.js

@@ -1,33 +1,33 @@
 /** Operations around Website management and statistics: https://umami.is/docs/api/websites */
 export var Websites;
 (function (Websites) {
-    /** Returns all user websites: https://umami.is/docs/api/websites#get-apiwebsites (TODO UNTESTED) */
+    /** Returns all user websites: https://umami.is/docs/api/websites#get-apiwebsites */
     async function get(parameters) {
         const response = await this.request("get", ["websites"], parameters);
         return response.data;
     }
     Websites.get = get;
-    /** Creates a website: https://umami.is/docs/api/websites#post-apiwebsites (TODO UNTESTED) */
+    /** Creates a website: https://umami.is/docs/api/websites#post-apiwebsites */
     async function post(parameters) {
         return await this.request("post", ["websites"], parameters);
     }
     Websites.post = post;
-    /** Gets a website by ID: https://umami.is/docs/api/websites#get-apiwebsiteswebsiteid (TODO UNTESTED) */
+    /** Gets a website by ID: https://umami.is/docs/api/websites#get-apiwebsiteswebsiteid */
     async function get_WEBSITEID(websiteId) {
         return await this.request("get", ["websites", websiteId]);
     }
     Websites.get_WEBSITEID = get_WEBSITEID;
-    /** Updates a website: https://umami.is/docs/api/websites#post-apiwebsiteswebsiteid (TODO UNTESTED) */
+    /** Updates a website: https://umami.is/docs/api/websites#post-apiwebsiteswebsiteid */
     async function post_WEBSITEID(websiteId, parameters) {
         return await this.request("post", ["websites", websiteId], parameters);
     }
     Websites.post_WEBSITEID = post_WEBSITEID;
-    /** Deletes a website: https://umami.is/docs/api/websites#delete-apiwebsiteswebsiteid (TODO UNTESTED) */
+    /** Deletes a website: https://umami.is/docs/api/websites#delete-apiwebsiteswebsiteid */
     async function delete_WEBSITEID(websiteId) {
         return await this.request("delete", ["websites", websiteId]);
     }
     Websites.delete_WEBSITEID = delete_WEBSITEID;
-    /** Resets a website by removing all data related to the website: https://umami.is/docs/api/websites#post-apiwebsiteswebsiteidreset (TODO UNTESTED) */
+    /** Resets a website by removing all data related to the website: https://umami.is/docs/api/websites#post-apiwebsiteswebsiteidreset */
     async function post_WEBSITEID_Reset(websiteId) {
         return await this.request("post", ["websites", websiteId, "reset"]);
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "umami-api-js",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "Package to easily access the umami api!",
   "type": "module",
   "main": "dist/index.js",