umami-api-js 0.0.4 → 0.1.1

package/dist/namespaces/Users.js

@@ -1,36 +1,36 @@
-/** For endpoints listed on: https://umami.is/docs/api/users-api */
+/** Operations around User management: https://umami.is/docs/api/users */
 export var Users;
 (function (Users) {
-    /** Creates a user: https://umami.is/docs/api/users-api#post-apiusers */
-    async function createUser(parameters) {
+    /** Creates a user: https://umami.is/docs/api/users#post-apiusers */
+    async function post(parameters) {
         return await this.request("post", ["users"], parameters);
     }
-    Users.createUser = createUser;
-    /** Gets a user by ID: https://umami.is/docs/api/users-api#get-apiusersuserid */
-    async function getUser(id) {
-        return await this.request("get", ["users", id]);
+    Users.post = post;
+    /** Gets a user by ID: https://umami.is/docs/api/users#get-apiusersuserid */
+    async function get_USERID(userId) {
+        return await this.request("get", ["users", userId]);
     }
-    Users.getUser = getUser;
-    /** Updates a user: https://umami.is/docs/api/users-api#post-apiusersuserid */
-    async function updateUser(id, parameters) {
-        return await this.request("post", ["users", id], parameters);
+    Users.get_USERID = get_USERID;
+    /** Updates a user: https://umami.is/docs/api/users#post-apiusersuserid */
+    async function post_USERID(userId, parameters) {
+        return await this.request("post", ["users", userId], parameters);
     }
-    Users.updateUser = updateUser;
-    /** Deletes a user: https://umami.is/docs/api/users-api#delete-apiusersuserid */
-    async function deleteUser(id) {
-        return await this.request("delete", ["users", id]);
+    Users.post_USERID = post_USERID;
+    /** Deletes a user: https://umami.is/docs/api/users#delete-apiusersuserid */
+    async function delete_USERID(userId) {
+        return await this.request("delete", ["users", userId]);
     }
-    Users.deleteUser = deleteUser;
-    /** Gets all websites that belong to a user: https://umami.is/docs/api/users-api#get-apiusersuseridwebsites */
-    async function getUserWebsites(id, parameters) {
-        const response = await this.request("get", ["users", id, "websites"], parameters);
+    Users.delete_USERID = delete_USERID;
+    /** Gets all websites that belong to a user: https://umami.is/docs/api/users#get-apiusersuseridwebsites */
+    async function get_USERID_Websites(userId, parameters) {
+        const response = await this.request("get", ["users", userId, "websites"], parameters);
         return response.data;
     }
-    Users.getUserWebsites = getUserWebsites;
-    /** Gets all teams that belong to a user: https://umami.is/docs/api/users-api#get-apiusersuseridteams */
-    async function getUserTeams(id, parameters) {
-        const response = await this.request("get", ["users", id, "teams"], parameters);
+    Users.get_USERID_Websites = get_USERID_Websites;
+    /** Gets all teams that belong to a user: https://umami.is/docs/api/users#get-apiusersuseridteams */
+    async function get_USERID_Teams(userId, parameters) {
+        const response = await this.request("get", ["users", userId, "teams"], parameters);
         return response.data;
     }
-    Users.getUserTeams = getUserTeams;
+    Users.get_USERID_Teams = get_USERID_Teams;
 })(Users || (Users = {}));

package/dist/namespaces/WebsiteStats.d.ts

@@ -1,5 +1,5 @@
 import { API, Filters, Timestamps, XTY } from "../index.js";
-/** For endpoints listed on: https://umami.is/docs/api/website-stats-api */
+/** Operations around Website statistics: https://umami.is/docs/api/website-stats */
 export declare namespace WebsiteStats {
     /**
      * The unit parameter buckets the data returned
@@ -19,28 +19,28 @@ export declare namespace WebsiteStats {
     }
     interface Stats {
         /** Pages hits */
-        pageviews: string;
+        pageviews: number;
         /** Number of unique visitors */
-        visitors: string;
+        visitors: number;
         /** Number of unique visits */
-        visits: string;
+        visits: number;
         /** Number of visitors who only visit a single page */
-        bounces: string;
+        bounces: number;
         /** Time spent on the website */
-        totaltime: string;
+        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-api#get-apiwebsiteswebsiteidactive (TODO UNTESTED) */
-    function getWebsiteActiveVisitors(this: API, websiteId: string): Promise<{
+    /** 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<{
         visitors: number;
     }>;
-    /** Gets events within a given time range: https://umami.is/docs/api/website-stats-api#get-apiwebsiteswebsiteideventsseries (TODO UNTESTED) */
-    function getWebsiteEvents(this: API, websiteId: string, parameters: Timestamps & Units & Filters & {
+    /** 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 & {
         /** Timezone (ex. America/Los_Angeles) */
         timezone: string;
     }): Promise<XTY[]>;
-    /** Gets metrics for a given time range: https://umami.is/docs/api/website-stats-api#get-apiwebsiteswebsiteidmetrics (TODO UNTESTED) */
-    function getWebsiteMetrics(this: API, websiteId: string, parameters: Timestamps & Units & Filters & {
+    /** 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 & {
         /** Timezone (ex. America/Los_Angeles) */
         timezone: string;
         /** Metrics type */
@@ -55,13 +55,13 @@ export declare namespace WebsiteStats {
         /** Number of visitors */
         y: number;
     }[]>;
-    /** Gets expanded metrics for a given time range: https://umami.is/docs/api/website-stats-api#get-apiwebsiteswebsiteidmetricsexpanded (TODO UNTESTED) */
-    function getWebsiteMetricsExpanded(this: API, ...args: Parameters<typeof getWebsiteMetrics>): Promise<(Stats & {
+    /** Gets expanded metrics for a given time range: https://umami.is/docs/api/website-stats#get-apiwebsiteswebsiteidmetricsexpanded (TODO UNTESTED) */
+    function get_WEBSITEID_MetricsExpanded(this: API, ...args: Parameters<typeof get_WEBSITEID_Metrics>): Promise<(Stats & {
         /** Unique value, depending on metric type */
         name: string;
     })[]>;
-    /** Gets pageviews within a given time range: https://umami.is/docs/api/website-stats-api#get-apiwebsiteswebsiteidpageviews (TODO UNTESTED) */
-    function getWebsitePageviews(this: API, websiteId: string, parameters: Timestamps & Units & Filters & {
+    /** 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 & {
         /** Timezone (ex. America/Los_Angeles) */
         timezone: string;
         /** Comparison value `prev` | `yoy` */
@@ -80,8 +80,8 @@ export declare namespace WebsiteStats {
             y: number;
         }[];
     }>;
-    /** Gets summarized website statistics: https://umami.is/docs/api/website-stats-api#get-apiwebsiteswebsiteidstats (TODO UNTESTED) */
-    function getWebsiteStats(this: API, websiteId: string, parameters: Timestamps & Filters & Units & {
+    /** 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 & {
         /** Timezone (ex. America/Los_Angeles) */
         timezone: string;
     }): Promise<Stats & {

package/dist/namespaces/WebsiteStats.js

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

package/dist/namespaces/Websites.d.ts

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

package/dist/namespaces/Websites.js

@@ -1,35 +1,35 @@
-/** For endpoints listed on: https://umami.is/docs/api/websites-api */
+/** 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-api#get-apiwebsites (TODO UNTESTED) */
-    async function getWebsites(parameters) {
+    /** 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.getWebsites = getWebsites;
-    /** Creates a website: https://umami.is/docs/api/websites-api#post-apiwebsites (TODO UNTESTED) */
-    async function createWebsite(parameters) {
+    Websites.get = get;
+    /** Creates a website: https://umami.is/docs/api/websites#post-apiwebsites */
+    async function post(parameters) {
         return await this.request("post", ["websites"], parameters);
     }
-    Websites.createWebsite = createWebsite;
-    /** Gets a website by ID: https://umami.is/docs/api/websites-api#get-apiwebsiteswebsiteid (TODO UNTESTED) */
-    async function getWebsite(websiteId) {
+    Websites.post = post;
+    /** 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.getWebsite = getWebsite;
-    /** Updates a website: https://umami.is/docs/api/websites-api#post-apiwebsiteswebsiteid (TODO UNTESTED) */
-    async function updateWebsite(websiteId, parameters) {
+    Websites.get_WEBSITEID = get_WEBSITEID;
+    /** 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.updateWebsite = updateWebsite;
-    /** Deletes a website: https://umami.is/docs/api/websites-api#delete-apiwebsiteswebsiteid (TODO UNTESTED) */
-    async function deleteWebsite(websiteId) {
+    Websites.post_WEBSITEID = post_WEBSITEID;
+    /** Deletes a website: https://umami.is/docs/api/websites#delete-apiwebsiteswebsiteid */
+    async function delete_WEBSITEID(websiteId) {
         return await this.request("delete", ["websites", websiteId]);
     }
-    Websites.deleteWebsite = deleteWebsite;
-    /** Resets a website by removing all data related to the website: https://umami.is/docs/api/websites-api#post-apiwebsiteswebsiteidreset (TODO UNTESTED) */
-    async function resetWebsite(websiteId) {
+    Websites.delete_WEBSITEID = delete_WEBSITEID;
+    /** 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"]);
     }
-    Websites.resetWebsite = resetWebsite;
+    Websites.post_WEBSITEID_Reset = post_WEBSITEID_Reset;
 })(Websites || (Websites = {}));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "umami-api-js",
-  "version": "0.0.4",
+  "version": "0.1.1",
   "description": "Package to easily access the umami api!",
   "type": "module",
   "main": "dist/index.js",
@@ -19,7 +19,7 @@
     "type": "git",
     "url": "https://codeberg.org/Taevas/umami-api-js"
   },
-  "homepage": "https://codeberg.org/Taevas/umami-api-js",
+  "homepage": "https://umami-api-js.taevas.xyz/",
   "keywords": [
     "umami",
     "api",
@@ -28,9 +28,11 @@
   ],
   "license": "Unlicense",
   "devDependencies": {
-    "@types/node": "^24.3.1",
-    "dotenv": "^17.2.2",
+    "@types/chai": "^5.2.3",
+    "@types/node": "^24.9.2",
+    "chai": "^6.2.0",
+    "dotenv": "^17.2.3",
     "typedoc": "^0.28.14",
-    "typescript": "^5.9.2"
+    "typescript": "^5.9.3"
   }
 }