umami-api-js 0.0.3 → 0.1.0

package/dist/namespaces/Websites.d.ts

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

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 (TODO UNTESTED) */
+    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 (TODO UNTESTED) */
+    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 (TODO UNTESTED) */
+    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 (TODO UNTESTED) */
+    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 (TODO UNTESTED) */
+    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 (TODO UNTESTED) */
+    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.3",
+  "version": "0.1.0",
   "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"
   }
 }

package/.forgejo/workflows/release.yaml

@@ -1,33 +0,0 @@
-on:
-  release:
-    types: [published]
-
-jobs:
-  docs:
-    runs-on: codeberg-tiny-lazy
-    steps:
-      - name: Checkout this very app
-        uses: actions/checkout@v4
-      - name: Install dependencies
-        run: npm install
-      - name: Generate documentation through the command defined in package.json
-        run: npm run docs
-      - name: Move the docs up and get rid of the rest (this preserves files that start with a dot)
-        run: |
-          mv docs/ ..
-          rm -rf *
-          mv ../docs/* .
-      - name: Add the .domains file
-        run: echo "umami-api-js.taevas.xyz" > .domains
-      - name: Configure our git client
-        run: |
-          git config user.name "forgejo-actions[bot]"
-          git config user.email "code@taevas.xyz"
-      - name: Create or switch to the "pages" branch
-        run: git switch -C pages
-      - name: Add and commit the changes
-        run: |
-          git add .
-          git commit -m "Automatically generated documentation"
-      - name: Send the changes to Codeberg, let Codeberg Pages do its magic~
-        run: git push