umami-api-js 0.0.4 → 0.1.1

package/dist/namespaces/Reports.js

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

package/dist/namespaces/Sessions.d.ts

@@ -1,5 +1,5 @@
 import { API, Filters, GenericRequestParameters, Timestamps } from "../index.js";
-/** For endpoints listed on: https://umami.is/docs/api/sessions-api */
+/** Operations around Sessions and Session data: https://umami.is/docs/api/sessions */
 export declare namespace Sessions {
     interface GenericSession {
         id: string;
@@ -17,13 +17,13 @@ export declare namespace Sessions {
         visits: number;
         views: number;
     }
-    /** Gets website session details within a given time range: https://umami.is/docs/api/sessions-api#get-apiwebsiteswebsiteidsessions (TODO UNTESTED) */
-    function getWebsiteSessions(this: API, websiteId: string, parameters: Filters & Timestamps & GenericRequestParameters): Promise<(GenericSession & {
+    /** 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 & {
         hostname: string;
         createdAt: Date;
     })[]>;
-    /** Gets summarized website session statistics: https://umami.is/docs/api/sessions-api#get-apiwebsiteswebsiteidsessionsstats (TODO UNTESTED) */
-    function getWebsiteSessionsStats(this: API, websiteId: string, parameters: Filters & Timestamps): Promise<{
+    /** 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<{
         /** Pages hits */
         pageviews: {
             value: number;
@@ -45,18 +45,18 @@ export declare namespace Sessions {
             value: number;
         };
     }>;
-    /** Get collected count of sessions by hour of weekday: https://umami.is/docs/api/sessions-api#get-apiwebsiteswebsiteidsessionsweekly (TODO UNTESTED) */
-    function getWebsiteSessionsWeekly(this: API, websiteId: string, parameters: Filters & Timestamps & {
+    /** 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 & {
         timezone: string;
     }): Promise<number[][]>;
-    /** Gets session details for a individual session: https://umami.is/docs/api/sessions-api#get-apiwebsiteswebsiteidsessionssessionid (TODO UNTESTED) */
-    function getWebsiteSession(this: API, websiteId: string, sessionId: string): Promise<GenericSession & {
+    /** 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 & {
         distinctId: string;
         events: number;
         totaltime: number;
     }>;
-    /** Gets session activity for a individual session: https://umami.is/docs/api/sessions-api#get-apiwebsiteswebsiteidsessionssessionidactivity (TODO UNTESTED) */
-    function getWebsiteSessionActivity(this: API, websiteId: string, sessionId: string, parameters: Timestamps): Promise<{
+    /** 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<{
         createdAt: Date;
         urlPath: string;
         urlQuery: string;
@@ -67,8 +67,8 @@ export declare namespace Sessions {
         visitId: string;
         hasData: number;
     }[]>;
-    /** Gets session properties for a individual session: https://umami.is/docs/api/sessions-api#get-apiwebsiteswebsiteidsessionssessionidproperties (TODO UNTESTED) */
-    function getWebsiteSessionProperties(this: API, websiteId: string, sessionId: string): Promise<{
+    /** 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;
         sessionid: string;
         dataKey: string;
@@ -78,13 +78,13 @@ export declare namespace Sessions {
         dateValue: Date | null;
         createdAt: Date;
     }[]>;
-    /** Gets session data counts by property name: https://umami.is/docs/api/sessions-api#get-apiwebsiteswebsiteidsession-dataproperties (TODO UNTESTED) */
-    function getWebsiteSessionDataProperties(this: API, websiteId: string, parameters: Filters & Timestamps): Promise<{
+    /** 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<{
         propertyName: string;
         total: number;
     }[]>;
-    /** Gets session data counts for a given property: https://umami.is/docs/api/sessions-api#get-apiwebsiteswebsiteidsession-datavalues (TODO UNTESTED) */
-    function getWebsiteSessionDataValues(this: API, websiteId: string, parameters: Filters & Timestamps & {
+    /** 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 & {
         propertyName: string;
     }): Promise<{
         value: string;

package/dist/namespaces/Sessions.js

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

package/dist/namespaces/Teams.d.ts

@@ -1,5 +1,5 @@
-import { API, GenericObject, GenericRequestParameters, TeamRole } from "../index.js";
-/** For endpoints listed on: https://umami.is/docs/api/teams-api */
+import { API, DeletionResult, GenericObject, GenericRequestParameters, TeamRole, Users } from "../index.js";
+/** Operations around Team management: https://umami.is/docs/api/teams */
 export declare namespace Teams {
     interface GenericTeam extends GenericObject {
         name: string;
@@ -8,64 +8,60 @@ export declare namespace Teams {
     }
     interface TeamMember extends Omit<GenericObject, "deletedAt"> {
         teamId: string;
-        userId: string;
+        userId: Users.User["id"];
         role: TeamRole;
         user: {
             id: string;
             username: string;
         };
     }
-    /** Returns all teams: https://umami.is/docs/api/teams-api#get-apiteams (TODO UNTESTED) */
-    function getTeams(this: API, parameters?: Omit<GenericRequestParameters, "search">): Promise<(GenericTeam & {
+    /** 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[];
         _count: {
             websites: number;
             members: number;
         };
     })[]>;
-    /** Creates a team: https://umami.is/docs/api/teams-api#post-apiteams (TODO UNTESTED) */
-    function createTeam(this: API, name: string): Promise<[GenericTeam, Omit<TeamMember, "user">]>;
-    /** Join a team: https://umami.is/docs/api/teams-api#post-apiteamsjoin (TODO UNTESTED) */
-    function joinTeam(this: API, accessCode: string): Promise<Omit<TeamMember, "user">>;
-    /** Get a team: https://umami.is/docs/api/teams-api#get-apiteamsteamid (TODO UNTESTED) */
-    function getTeam(this: API, teamId: string): Promise<GenericTeam & {
+    /** Creates a team: https://umami.is/docs/api/teams#post-apiteams (TODO UNTESTED) */
+    function post(this: API, name: string): Promise<[GenericTeam, Omit<TeamMember, "user">]>;
+    /** Join a team: https://umami.is/docs/api/teams#post-apiteamsjoin (TODO UNTESTED) */
+    function postJoin(this: API, accessCode: string): Promise<Omit<TeamMember, "user">>;
+    /** 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">[];
     }>;
-    /** Update a team: https://umami.is/docs/api/teams-api#post-apiteamsteamid (TODO UNTESTED) */
-    function updateTeam(this: API, teamId: string, parameters: {
+    /** Update a team: https://umami.is/docs/api/teams#post-apiteamsteamid (TODO UNTESTED) */
+    function post_TEAMID(this: API, teamId: string, parameters: {
         /** The team's name */
         name?: string;
         /** The team's access code */
         accessCode?: string;
     }): Promise<GenericTeam>;
-    /** Delete a team: https://umami.is/docs/api/teams-api#delete-apiteamsteamid (TODO UNTESTED) */
-    function deleteTeam(this: API, teamId: string): Promise<{
-        ok: boolean;
-    }>;
-    /** Get all users that belong to a team: https://umami.is/docs/api/teams-api#get-apiteamsteamidusers (TODO UNTESTED) */
-    function getTeamUsers(this: API, teamId: string, parameters: GenericRequestParameters): Promise<TeamMember[]>;
-    /** Add a user to a team: https://umami.is/docs/api/teams-api#post-apiteamsteamidusers (TODO UNTESTED) */
-    function addTeamUser(this: API, teamId: string, parameters: {
+    /** 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<TeamMember[]>;
+    /** 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">>;
-    /** Get a user belonging to a team: https://umami.is/docs/api/teams-api#get-apiteamsteamidusersuserid (TODO UNTESTED) */
-    function getTeamUser(this: API, teamId: string, userId: string): Promise<Omit<TeamMember, "user">>;
-    /** Update a user's role on a team: https://umami.is/docs/api/teams-api#post-apiteamsteamidusersuserid (TODO UNTESTED) */
-    function updateTeamUser(this: API, teamId: string, userId: string, role: TeamRole): Promise<Omit<TeamMember, "user">>;
-    /** Remove a user from a team: https://umami.is/docs/api/teams-api#delete-apiteamsteamidusersuserid (TODO UNTESTED) */
-    function removeTeamUser(this: API, teamId: string, userId: string): Promise<{
-        ok: boolean;
-    }>;
-    /** Get all websites that belong to a team: https://umami.is/docs/api/teams-api#get-apiteamsteamidwebsites (TODO UNTESTED) */
-    function getTeamWebsites(this: API, teamId: string, parameters: GenericRequestParameters): Promise<(GenericObject & {
+    /** 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<Omit<TeamMember, "user">>;
+    /** 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<Omit<TeamMember, "user">>;
+    /** 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<(GenericObject & {
         name: string;
         domain: string;
         shareId: string;
         resetAt: Date | null;
-        userId: string | null;
+        userId: Users.User["id"] | null;
         teamId: string | null;
         createdBy: string;
         createUser: {

package/dist/namespaces/Teams.js

@@ -1,67 +1,67 @@
-/** For endpoints listed on: https://umami.is/docs/api/teams-api */
+/** Operations around Team management: https://umami.is/docs/api/teams */
 export var Teams;
 (function (Teams) {
-    /** Returns all teams: https://umami.is/docs/api/teams-api#get-apiteams (TODO UNTESTED) */
-    async function getTeams(parameters) {
+    /** Returns all teams: https://umami.is/docs/api/teams#get-apiteams (TODO UNTESTED) */
+    async function get(parameters) {
         const response = await this.request("get", ["teams"], parameters);
         return response.data;
     }
-    Teams.getTeams = getTeams;
-    /** Creates a team: https://umami.is/docs/api/teams-api#post-apiteams (TODO UNTESTED) */
-    async function createTeam(name) {
+    Teams.get = get;
+    /** Creates a team: https://umami.is/docs/api/teams#post-apiteams (TODO UNTESTED) */
+    async function post(name) {
         return await this.request("post", ["teams"], { name });
     }
-    Teams.createTeam = createTeam;
-    /** Join a team: https://umami.is/docs/api/teams-api#post-apiteamsjoin (TODO UNTESTED) */
-    async function joinTeam(accessCode) {
+    Teams.post = post;
+    /** Join a team: https://umami.is/docs/api/teams#post-apiteamsjoin (TODO UNTESTED) */
+    async function postJoin(accessCode) {
         return await this.request("post", ["teams", "join"], { accessCode });
     }
-    Teams.joinTeam = joinTeam;
-    /** Get a team: https://umami.is/docs/api/teams-api#get-apiteamsteamid (TODO UNTESTED) */
-    async function getTeam(teamId) {
+    Teams.postJoin = postJoin;
+    /** Get a team: https://umami.is/docs/api/teams#get-apiteamsteamid (TODO UNTESTED) */
+    async function get_TEAMID(teamId) {
         return await this.request("get", ["teams", teamId]);
     }
-    Teams.getTeam = getTeam;
-    /** Update a team: https://umami.is/docs/api/teams-api#post-apiteamsteamid (TODO UNTESTED) */
-    async function updateTeam(teamId, parameters) {
+    Teams.get_TEAMID = get_TEAMID;
+    /** Update a team: https://umami.is/docs/api/teams#post-apiteamsteamid (TODO UNTESTED) */
+    async function post_TEAMID(teamId, parameters) {
         return await this.request("post", ["teams", teamId], parameters);
     }
-    Teams.updateTeam = updateTeam;
-    /** Delete a team: https://umami.is/docs/api/teams-api#delete-apiteamsteamid (TODO UNTESTED) */
-    async function deleteTeam(teamId) {
+    Teams.post_TEAMID = post_TEAMID;
+    /** Delete a team: https://umami.is/docs/api/teams#delete-apiteamsteamid (TODO UNTESTED) */
+    async function delete_TEAMID(teamId) {
         return await this.request("delete", ["teams", teamId]);
     }
-    Teams.deleteTeam = deleteTeam;
-    /** Get all users that belong to a team: https://umami.is/docs/api/teams-api#get-apiteamsteamidusers (TODO UNTESTED) */
-    async function getTeamUsers(teamId, parameters) {
+    Teams.delete_TEAMID = delete_TEAMID;
+    /** Get all users that belong to a team: https://umami.is/docs/api/teams#get-apiteamsteamidusers (TODO UNTESTED) */
+    async function get_TEAMID_Users(teamId, parameters) {
         const response = await this.request("get", ["teams", teamId, "users"], parameters);
         return response.data;
     }
-    Teams.getTeamUsers = getTeamUsers;
-    /** Add a user to a team: https://umami.is/docs/api/teams-api#post-apiteamsteamidusers (TODO UNTESTED) */
-    async function addTeamUser(teamId, parameters) {
+    Teams.get_TEAMID_Users = get_TEAMID_Users;
+    /** Add a user to a team: https://umami.is/docs/api/teams#post-apiteamsteamidusers (TODO UNTESTED) */
+    async function post_TEAMID_Users(teamId, parameters) {
         return await this.request("post", ["teams", teamId, "users"], parameters);
     }
-    Teams.addTeamUser = addTeamUser;
-    /** Get a user belonging to a team: https://umami.is/docs/api/teams-api#get-apiteamsteamidusersuserid (TODO UNTESTED) */
-    async function getTeamUser(teamId, userId) {
+    Teams.post_TEAMID_Users = post_TEAMID_Users;
+    /** Get a user belonging to a team: https://umami.is/docs/api/teams#get-apiteamsteamidusersuserid (TODO UNTESTED) */
+    async function get_TEAMID_Users_USERID(teamId, userId) {
         return await this.request("get", ["teams", teamId, "users", userId]);
     }
-    Teams.getTeamUser = getTeamUser;
-    /** Update a user's role on a team: https://umami.is/docs/api/teams-api#post-apiteamsteamidusersuserid (TODO UNTESTED) */
-    async function updateTeamUser(teamId, userId, role) {
+    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) */
+    async function post_TEAMID_Users_USERID(teamId, userId, role) {
         return await this.request("post", ["teams", teamId, "users", userId], { role });
     }
-    Teams.updateTeamUser = updateTeamUser;
-    /** Remove a user from a team: https://umami.is/docs/api/teams-api#delete-apiteamsteamidusersuserid (TODO UNTESTED) */
-    async function removeTeamUser(teamId, userId) {
+    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) */
+    async function delete_TEAMID_Users_USERID(teamId, userId) {
         return await this.request("delete", ["teams", teamId, "users", userId]);
     }
-    Teams.removeTeamUser = removeTeamUser;
-    /** Get all websites that belong to a team: https://umami.is/docs/api/teams-api#get-apiteamsteamidwebsites (TODO UNTESTED) */
-    async function getTeamWebsites(teamId, parameters) {
+    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) */
+    async function get_TEAMID_Websites(teamId, parameters) {
         const response = await this.request("get", ["teams", teamId, "websites"], parameters);
         return response.data;
     }
-    Teams.getTeamWebsites = getTeamWebsites;
+    Teams.get_TEAMID_Websites = get_TEAMID_Websites;
 })(Teams || (Teams = {}));

package/dist/namespaces/Users.d.ts

@@ -1,11 +1,24 @@
-import { API, GenericObject, GenericRequestParameters, MinimalUser, Role, TeamRole, Website } from "../index.js";
-/** For endpoints listed on: https://umami.is/docs/api/users-api */
+import { API, DeletionResult, GenericObject, GenericRequestParameters, TeamRole, Website } 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;
     }
-    /** Creates a user: https://umami.is/docs/api/users-api#post-apiusers */
-    function createUser(this: API, parameters: {
+    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 */
         username: string;
         /** The user's password */
@@ -14,45 +27,36 @@ export declare namespace Users {
         role: Role;
         /** Force a UUID assignment to the user */
         id?: string;
-    }): Promise<GenericUser>;
-    /** Gets a user by ID: https://umami.is/docs/api/users-api#get-apiusersuserid */
-    function getUser(this: API, id: string): Promise<GenericUser & {
-        createdAt: Date;
-    }>;
-    /** Updates a user: https://umami.is/docs/api/users-api#post-apiusersuserid */
-    function updateUser(this: API, id: string, parameters?: {
+    }): Promise<MinimalUserWithRole>;
+    /** Gets a user by ID: https://umami.is/docs/api/users#get-apiusersuserid */
+    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: 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;
-    }>;
-    /** Deletes a user: https://umami.is/docs/api/users-api#delete-apiusersuserid */
-    function deleteUser(this: API, id: string): Promise<{
-        ok: boolean;
-    }>;
-    /** Gets all websites that belong to a user: https://umami.is/docs/api/users-api#get-apiusersuseridwebsites */
-    function getUserWebsites(this: API, id: string, parameters: GenericRequestParameters & {
-        includeTeams: boolean;
+    }): Promise<MinimalUserWithRoleCreatedAt>;
+    /** Deletes a user: https://umami.is/docs/api/users#delete-apiusersuserid */
+    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: User["id"], parameters?: GenericRequestParameters & {
+        includeTeams?: boolean;
     }): Promise<(Website & {
         user: MinimalUser;
     })[]>;
-    /** Gets all teams that belong to a user: https://umami.is/docs/api/users-api#get-apiusersuseridteams */
-    function getUserTeams(this: API, id: string, parameters?: Omit<GenericRequestParameters, "search">): Promise<(GenericObject & {
+    /** Gets all teams that belong to a user: https://umami.is/docs/api/users#get-apiusersuseridteams */
+    function get_USERID_Teams(this: API, userId: User["id"], parameters?: Omit<GenericRequestParameters, "search">): Promise<(GenericObject & {
         name: string;
         accessCode: string;
         logoUrl: string | null;
         members: Omit<GenericObject, "deletedAt"> & {
             teamId: string;
-            userId: string;
+            userId: User["id"];
             role: TeamRole;
-            user: {
-                id: string;
-                username: string;
-            };
+            user: MinimalUser;
         }[];
         _count: {
             websites: number;