@ikatec/digisac-api-sdk 4.2.0 → 4.3.0

package/dist/apis/dashboard/DashboardApi.cjs

@@ -4,7 +4,8 @@ const require_core_BaseApi = require('../../core/BaseApi.cjs');
 //#region src/apis/dashboard/DashboardApi.ts
 /**
 * Service statistics ("Estatísticas de atendimento"). The `/dashboard` routes only require an
-* authenticated user (no permission check).
+* authenticated user (no permission check). Every route takes the same {@link DashboardQuery}
+* filters; the grouped routes answer one item per day, user, department, topic or connection.
 */
 var DashboardApi = class extends require_core_BaseApi.BaseApi {
 	basePath = "/dashboard";
@@ -12,6 +13,40 @@ var DashboardApi = class extends require_core_BaseApi.BaseApi {
 	getGeneral(query, headers) {
 		return this.client.get(`${this.basePath}/general${this.toQueryString(query)}`, headers);
 	}
+	getByPeriod(query, headers) {
+		return this.getGrouped("by-period", query, headers);
+	}
+	getByUser(query, headers) {
+		return this.getGrouped("by-user", query, headers);
+	}
+	getByDepartment(query, headers) {
+		return this.getGrouped("by-department", query, headers);
+	}
+	/**
+	* The counts of each ticket topic of the period (`GET /dashboard/by-topic`). Does not take
+	* `withTotals` (the backend ignores it).
+	*/
+	getByTopic(query, headers) {
+		return this.client.get(`${this.basePath}/by-topic${this.toQueryString(query)}`, headers);
+	}
+	/**
+	* The counts of each connection of the period (`GET /dashboard/by-service`). Does not take
+	* `withTotals` (the backend ignores it).
+	*/
+	getByService(query, headers) {
+		return this.client.get(`${this.basePath}/by-service${this.toQueryString(query)}`, headers);
+	}
+	/**
+	* `withTotals` is only sent when `true`: the backend reads it with a truthiness check, so in the
+	* `qs` format a serialized `withTotals=false` (the string `'false'`) would wrap the answer anyway.
+	*/
+	getGrouped(route, query, headers) {
+		const { withTotals, ...filters } = query ?? {};
+		return this.client.get(`${this.basePath}/${route}${this.toQueryString(withTotals ? {
+			...filters,
+			withTotals: true
+		} : filters)}`, headers);
+	}
 };
 
 //#endregion

package/dist/apis/dashboard/DashboardApi.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"DashboardApi.cjs","names":["BaseApi"],"sources":["../../../src/apis/dashboard/DashboardApi.ts"],"sourcesContent":["import { BaseApi } from '../../core/BaseApi'\nimport type { DashboardGeneral, DashboardQuery } from './types'\n\n/**\n * Service statistics (\"Estatísticas de atendimento\"). The `/dashboard` routes only require an\n * authenticated user (no permission check).\n */\nexport class DashboardApi extends BaseApi {\n  public readonly basePath = '/dashboard'\n\n  /** Message, ticket, contact and time counts of the period (`GET /dashboard/general`). */\n  getGeneral(query?: DashboardQuery, headers?: Record<string, string>): Promise<DashboardGeneral> {\n    return this.client.get<DashboardGeneral>(\n      `${this.basePath}/general${this.toQueryString(query)}`,\n      headers,\n    )\n  }\n}\n"],"mappings":";;;;;;;;AAOA,IAAa,eAAb,cAAkCA,6BAAQ;CACxC,AAAgB,WAAW;;CAG3B,WAAW,OAAwB,SAA6D;AAC9F,SAAO,KAAK,OAAO,IACjB,GAAG,KAAK,SAAS,UAAU,KAAK,cAAc,MAAM,IACpD,QACD"}
+{"version":3,"file":"DashboardApi.cjs","names":["BaseApi"],"sources":["../../../src/apis/dashboard/DashboardApi.ts"],"sourcesContent":["import { BaseApi } from '../../core/BaseApi'\nimport type {\n  DashboardDepartmentItem,\n  DashboardGeneral,\n  DashboardGrouped,\n  DashboardPeriodItem,\n  DashboardQuery,\n  DashboardServiceItem,\n  DashboardTopicItem,\n  DashboardUserItem,\n  DashboardWithTotals,\n} from './types'\n\n/**\n * Service statistics (\"Estatísticas de atendimento\"). The `/dashboard` routes only require an\n * authenticated user (no permission check). Every route takes the same {@link DashboardQuery}\n * filters; the grouped routes answer one item per day, user, department, topic or connection.\n */\nexport class DashboardApi extends BaseApi {\n  public readonly basePath = '/dashboard'\n\n  /** Message, ticket, contact and time counts of the period (`GET /dashboard/general`). */\n  getGeneral(query?: DashboardQuery, headers?: Record<string, string>): Promise<DashboardGeneral> {\n    return this.client.get<DashboardGeneral>(\n      `${this.basePath}/general${this.toQueryString(query)}`,\n      headers,\n    )\n  }\n\n  /**\n   * The counts of each bucket of the period (`GET /dashboard/by-period`): one item per day by default,\n   * or per `grouping` (hour, week, month, year). With `withTotals: true` the answer is\n   * `{ totals, items }`.\n   */\n  getByPeriod(\n    query: DashboardQuery & { withTotals: true },\n    headers?: Record<string, string>,\n  ): Promise<DashboardGrouped<DashboardPeriodItem>>\n  getByPeriod(\n    query?: DashboardQuery & { withTotals?: false },\n    headers?: Record<string, string>,\n  ): Promise<DashboardPeriodItem[]>\n  /** When `withTotals` is only known at runtime (e.g. a `boolean` variable). */\n  getByPeriod(\n    query?: DashboardQuery & DashboardWithTotals,\n    headers?: Record<string, string>,\n  ): Promise<DashboardPeriodItem[] | DashboardGrouped<DashboardPeriodItem>>\n  getByPeriod(\n    query?: DashboardQuery & DashboardWithTotals,\n    headers?: Record<string, string>,\n  ): Promise<DashboardPeriodItem[] | DashboardGrouped<DashboardPeriodItem>> {\n    return this.getGrouped<DashboardPeriodItem>('by-period', query, headers)\n  }\n\n  /**\n   * The counts of each user of the period (`GET /dashboard/by-user`). With `withTotals: true` the\n   * answer is `{ totals, items }`.\n   */\n  getByUser(\n    query: DashboardQuery & { withTotals: true },\n    headers?: Record<string, string>,\n  ): Promise<DashboardGrouped<DashboardUserItem>>\n  getByUser(\n    query?: DashboardQuery & { withTotals?: false },\n    headers?: Record<string, string>,\n  ): Promise<DashboardUserItem[]>\n  /** When `withTotals` is only known at runtime (e.g. a `boolean` variable). */\n  getByUser(\n    query?: DashboardQuery & DashboardWithTotals,\n    headers?: Record<string, string>,\n  ): Promise<DashboardUserItem[] | DashboardGrouped<DashboardUserItem>>\n  getByUser(\n    query?: DashboardQuery & DashboardWithTotals,\n    headers?: Record<string, string>,\n  ): Promise<DashboardUserItem[] | DashboardGrouped<DashboardUserItem>> {\n    return this.getGrouped<DashboardUserItem>('by-user', query, headers)\n  }\n\n  /**\n   * The counts of each department of the period (`GET /dashboard/by-department`). With\n   * `withTotals: true` the answer is `{ totals, items }`.\n   */\n  getByDepartment(\n    query: DashboardQuery & { withTotals: true },\n    headers?: Record<string, string>,\n  ): Promise<DashboardGrouped<DashboardDepartmentItem>>\n  getByDepartment(\n    query?: DashboardQuery & { withTotals?: false },\n    headers?: Record<string, string>,\n  ): Promise<DashboardDepartmentItem[]>\n  /** When `withTotals` is only known at runtime (e.g. a `boolean` variable). */\n  getByDepartment(\n    query?: DashboardQuery & DashboardWithTotals,\n    headers?: Record<string, string>,\n  ): Promise<DashboardDepartmentItem[] | DashboardGrouped<DashboardDepartmentItem>>\n  getByDepartment(\n    query?: DashboardQuery & DashboardWithTotals,\n    headers?: Record<string, string>,\n  ): Promise<DashboardDepartmentItem[] | DashboardGrouped<DashboardDepartmentItem>> {\n    return this.getGrouped<DashboardDepartmentItem>('by-department', query, headers)\n  }\n\n  /**\n   * The counts of each ticket topic of the period (`GET /dashboard/by-topic`). Does not take\n   * `withTotals` (the backend ignores it).\n   */\n  getByTopic(\n    query?: DashboardQuery,\n    headers?: Record<string, string>,\n  ): Promise<DashboardTopicItem[]> {\n    return this.client.get<DashboardTopicItem[]>(\n      `${this.basePath}/by-topic${this.toQueryString(query)}`,\n      headers,\n    )\n  }\n\n  /**\n   * The counts of each connection of the period (`GET /dashboard/by-service`). Does not take\n   * `withTotals` (the backend ignores it).\n   */\n  getByService(\n    query?: DashboardQuery,\n    headers?: Record<string, string>,\n  ): Promise<DashboardServiceItem[]> {\n    return this.client.get<DashboardServiceItem[]>(\n      `${this.basePath}/by-service${this.toQueryString(query)}`,\n      headers,\n    )\n  }\n\n  /**\n   * `withTotals` is only sent when `true`: the backend reads it with a truthiness check, so in the\n   * `qs` format a serialized `withTotals=false` (the string `'false'`) would wrap the answer anyway.\n   */\n  private getGrouped<TItem>(\n    route: string,\n    query?: DashboardQuery & DashboardWithTotals,\n    headers?: Record<string, string>,\n  ): Promise<TItem[] | DashboardGrouped<TItem>> {\n    const { withTotals, ...filters } = query ?? {}\n    return this.client.get<TItem[] | DashboardGrouped<TItem>>(\n      `${this.basePath}/${route}${this.toQueryString(withTotals ? { ...filters, withTotals: true } : filters)}`,\n      headers,\n    )\n  }\n}\n"],"mappings":";;;;;;;;;AAkBA,IAAa,eAAb,cAAkCA,6BAAQ;CACxC,AAAgB,WAAW;;CAG3B,WAAW,OAAwB,SAA6D;AAC9F,SAAO,KAAK,OAAO,IACjB,GAAG,KAAK,SAAS,UAAU,KAAK,cAAc,MAAM,IACpD,QACD;;CAqBH,YACE,OACA,SACwE;AACxE,SAAO,KAAK,WAAgC,aAAa,OAAO,QAAQ;;CAoB1E,UACE,OACA,SACoE;AACpE,SAAO,KAAK,WAA8B,WAAW,OAAO,QAAQ;;CAoBtE,gBACE,OACA,SACgF;AAChF,SAAO,KAAK,WAAoC,iBAAiB,OAAO,QAAQ;;;;;;CAOlF,WACE,OACA,SAC+B;AAC/B,SAAO,KAAK,OAAO,IACjB,GAAG,KAAK,SAAS,WAAW,KAAK,cAAc,MAAM,IACrD,QACD;;;;;;CAOH,aACE,OACA,SACiC;AACjC,SAAO,KAAK,OAAO,IACjB,GAAG,KAAK,SAAS,aAAa,KAAK,cAAc,MAAM,IACvD,QACD;;;;;;CAOH,AAAQ,WACN,OACA,OACA,SAC4C;EAC5C,MAAM,EAAE,YAAY,GAAG,YAAY,SAAS,EAAE;AAC9C,SAAO,KAAK,OAAO,IACjB,GAAG,KAAK,SAAS,GAAG,QAAQ,KAAK,cAAc,aAAa;GAAE,GAAG;GAAS,YAAY;GAAM,GAAG,QAAQ,IACvG,QACD"}

package/dist/apis/dashboard/DashboardApi.d.ts

@@ -1,12 +1,65 @@
 import { BaseApi } from '../../core/BaseApi';
-import type { DashboardGeneral, DashboardQuery } from './types';
+import type { DashboardDepartmentItem, DashboardGeneral, DashboardGrouped, DashboardPeriodItem, DashboardQuery, DashboardServiceItem, DashboardTopicItem, DashboardUserItem, DashboardWithTotals } from './types';
 /**
  * Service statistics ("Estatísticas de atendimento"). The `/dashboard` routes only require an
- * authenticated user (no permission check).
+ * authenticated user (no permission check). Every route takes the same {@link DashboardQuery}
+ * filters; the grouped routes answer one item per day, user, department, topic or connection.
  */
 export declare class DashboardApi extends BaseApi {
     readonly basePath = "/dashboard";
     /** Message, ticket, contact and time counts of the period (`GET /dashboard/general`). */
     getGeneral(query?: DashboardQuery, headers?: Record<string, string>): Promise<DashboardGeneral>;
+    /**
+     * The counts of each bucket of the period (`GET /dashboard/by-period`): one item per day by default,
+     * or per `grouping` (hour, week, month, year). With `withTotals: true` the answer is
+     * `{ totals, items }`.
+     */
+    getByPeriod(query: DashboardQuery & {
+        withTotals: true;
+    }, headers?: Record<string, string>): Promise<DashboardGrouped<DashboardPeriodItem>>;
+    getByPeriod(query?: DashboardQuery & {
+        withTotals?: false;
+    }, headers?: Record<string, string>): Promise<DashboardPeriodItem[]>;
+    /** When `withTotals` is only known at runtime (e.g. a `boolean` variable). */
+    getByPeriod(query?: DashboardQuery & DashboardWithTotals, headers?: Record<string, string>): Promise<DashboardPeriodItem[] | DashboardGrouped<DashboardPeriodItem>>;
+    /**
+     * The counts of each user of the period (`GET /dashboard/by-user`). With `withTotals: true` the
+     * answer is `{ totals, items }`.
+     */
+    getByUser(query: DashboardQuery & {
+        withTotals: true;
+    }, headers?: Record<string, string>): Promise<DashboardGrouped<DashboardUserItem>>;
+    getByUser(query?: DashboardQuery & {
+        withTotals?: false;
+    }, headers?: Record<string, string>): Promise<DashboardUserItem[]>;
+    /** When `withTotals` is only known at runtime (e.g. a `boolean` variable). */
+    getByUser(query?: DashboardQuery & DashboardWithTotals, headers?: Record<string, string>): Promise<DashboardUserItem[] | DashboardGrouped<DashboardUserItem>>;
+    /**
+     * The counts of each department of the period (`GET /dashboard/by-department`). With
+     * `withTotals: true` the answer is `{ totals, items }`.
+     */
+    getByDepartment(query: DashboardQuery & {
+        withTotals: true;
+    }, headers?: Record<string, string>): Promise<DashboardGrouped<DashboardDepartmentItem>>;
+    getByDepartment(query?: DashboardQuery & {
+        withTotals?: false;
+    }, headers?: Record<string, string>): Promise<DashboardDepartmentItem[]>;
+    /** When `withTotals` is only known at runtime (e.g. a `boolean` variable). */
+    getByDepartment(query?: DashboardQuery & DashboardWithTotals, headers?: Record<string, string>): Promise<DashboardDepartmentItem[] | DashboardGrouped<DashboardDepartmentItem>>;
+    /**
+     * The counts of each ticket topic of the period (`GET /dashboard/by-topic`). Does not take
+     * `withTotals` (the backend ignores it).
+     */
+    getByTopic(query?: DashboardQuery, headers?: Record<string, string>): Promise<DashboardTopicItem[]>;
+    /**
+     * The counts of each connection of the period (`GET /dashboard/by-service`). Does not take
+     * `withTotals` (the backend ignores it).
+     */
+    getByService(query?: DashboardQuery, headers?: Record<string, string>): Promise<DashboardServiceItem[]>;
+    /**
+     * `withTotals` is only sent when `true`: the backend reads it with a truthiness check, so in the
+     * `qs` format a serialized `withTotals=false` (the string `'false'`) would wrap the answer anyway.
+     */
+    private getGrouped;
 }
 //# sourceMappingURL=DashboardApi.d.ts.map

package/dist/apis/dashboard/DashboardApi.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"DashboardApi.d.ts","sourceRoot":"","sources":["../../../src/apis/dashboard/DashboardApi.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAA;AAC5C,OAAO,KAAK,EAAE,gBAAgB,EAAE,cAAc,EAAE,MAAM,SAAS,CAAA;AAE/D;;;GAGG;AACH,qBAAa,YAAa,SAAQ,OAAO;IACvC,SAAgB,QAAQ,gBAAe;IAEvC,yFAAyF;IACzF,UAAU,CAAC,KAAK,CAAC,EAAE,cAAc,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,gBAAgB,CAAC;CAMhG"}
+{"version":3,"file":"DashboardApi.d.ts","sourceRoot":"","sources":["../../../src/apis/dashboard/DashboardApi.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAA;AAC5C,OAAO,KAAK,EACV,uBAAuB,EACvB,gBAAgB,EAChB,gBAAgB,EAChB,mBAAmB,EACnB,cAAc,EACd,oBAAoB,EACpB,kBAAkB,EAClB,iBAAiB,EACjB,mBAAmB,EACpB,MAAM,SAAS,CAAA;AAEhB;;;;GAIG;AACH,qBAAa,YAAa,SAAQ,OAAO;IACvC,SAAgB,QAAQ,gBAAe;IAEvC,yFAAyF;IACzF,UAAU,CAAC,KAAK,CAAC,EAAE,cAAc,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAO/F;;;;OAIG;IACH,WAAW,CACT,KAAK,EAAE,cAAc,GAAG;QAAE,UAAU,EAAE,IAAI,CAAA;KAAE,EAC5C,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,gBAAgB,CAAC,mBAAmB,CAAC,CAAC;IACjD,WAAW,CACT,KAAK,CAAC,EAAE,cAAc,GAAG;QAAE,UAAU,CAAC,EAAE,KAAK,CAAA;KAAE,EAC/C,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,mBAAmB,EAAE,CAAC;IACjC,8EAA8E;IAC9E,WAAW,CACT,KAAK,CAAC,EAAE,cAAc,GAAG,mBAAmB,EAC5C,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,mBAAmB,EAAE,GAAG,gBAAgB,CAAC,mBAAmB,CAAC,CAAC;IAQzE;;;OAGG;IACH,SAAS,CACP,KAAK,EAAE,cAAc,GAAG;QAAE,UAAU,EAAE,IAAI,CAAA;KAAE,EAC5C,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,gBAAgB,CAAC,iBAAiB,CAAC,CAAC;IAC/C,SAAS,CACP,KAAK,CAAC,EAAE,cAAc,GAAG;QAAE,UAAU,CAAC,EAAE,KAAK,CAAA;KAAE,EAC/C,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,iBAAiB,EAAE,CAAC;IAC/B,8EAA8E;IAC9E,SAAS,CACP,KAAK,CAAC,EAAE,cAAc,GAAG,mBAAmB,EAC5C,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,iBAAiB,EAAE,GAAG,gBAAgB,CAAC,iBAAiB,CAAC,CAAC;IAQrE;;;OAGG;IACH,eAAe,CACb,KAAK,EAAE,cAAc,GAAG;QAAE,UAAU,EAAE,IAAI,CAAA;KAAE,EAC5C,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,gBAAgB,CAAC,uBAAuB,CAAC,CAAC;IACrD,eAAe,CACb,KAAK,CAAC,EAAE,cAAc,GAAG;QAAE,UAAU,CAAC,EAAE,KAAK,CAAA;KAAE,EAC/C,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,uBAAuB,EAAE,CAAC;IACrC,8EAA8E;IAC9E,eAAe,CACb,KAAK,CAAC,EAAE,cAAc,GAAG,mBAAmB,EAC5C,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,uBAAuB,EAAE,GAAG,gBAAgB,CAAC,uBAAuB,CAAC,CAAC;IAQjF;;;OAGG;IACH,UAAU,CACR,KAAK,CAAC,EAAE,cAAc,EACtB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,kBAAkB,EAAE,CAAC;IAOhC;;;OAGG;IACH,YAAY,CACV,KAAK,CAAC,EAAE,cAAc,EACtB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,oBAAoB,EAAE,CAAC;IAOlC;;;OAGG;IACH,OAAO,CAAC,UAAU;CAWnB"}

package/dist/apis/dashboard/DashboardApi.mjs

@@ -3,7 +3,8 @@ import { BaseApi } from "../../core/BaseApi.mjs";
 //#region src/apis/dashboard/DashboardApi.ts
 /**
 * Service statistics ("Estatísticas de atendimento"). The `/dashboard` routes only require an
-* authenticated user (no permission check).
+* authenticated user (no permission check). Every route takes the same {@link DashboardQuery}
+* filters; the grouped routes answer one item per day, user, department, topic or connection.
 */
 var DashboardApi = class extends BaseApi {
 	basePath = "/dashboard";
@@ -11,6 +12,40 @@ var DashboardApi = class extends BaseApi {
 	getGeneral(query, headers) {
 		return this.client.get(`${this.basePath}/general${this.toQueryString(query)}`, headers);
 	}
+	getByPeriod(query, headers) {
+		return this.getGrouped("by-period", query, headers);
+	}
+	getByUser(query, headers) {
+		return this.getGrouped("by-user", query, headers);
+	}
+	getByDepartment(query, headers) {
+		return this.getGrouped("by-department", query, headers);
+	}
+	/**
+	* The counts of each ticket topic of the period (`GET /dashboard/by-topic`). Does not take
+	* `withTotals` (the backend ignores it).
+	*/
+	getByTopic(query, headers) {
+		return this.client.get(`${this.basePath}/by-topic${this.toQueryString(query)}`, headers);
+	}
+	/**
+	* The counts of each connection of the period (`GET /dashboard/by-service`). Does not take
+	* `withTotals` (the backend ignores it).
+	*/
+	getByService(query, headers) {
+		return this.client.get(`${this.basePath}/by-service${this.toQueryString(query)}`, headers);
+	}
+	/**
+	* `withTotals` is only sent when `true`: the backend reads it with a truthiness check, so in the
+	* `qs` format a serialized `withTotals=false` (the string `'false'`) would wrap the answer anyway.
+	*/
+	getGrouped(route, query, headers) {
+		const { withTotals, ...filters } = query ?? {};
+		return this.client.get(`${this.basePath}/${route}${this.toQueryString(withTotals ? {
+			...filters,
+			withTotals: true
+		} : filters)}`, headers);
+	}
 };
 
 //#endregion

package/dist/apis/dashboard/DashboardApi.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"DashboardApi.mjs","names":[],"sources":["../../../src/apis/dashboard/DashboardApi.ts"],"sourcesContent":["import { BaseApi } from '../../core/BaseApi'\nimport type { DashboardGeneral, DashboardQuery } from './types'\n\n/**\n * Service statistics (\"Estatísticas de atendimento\"). The `/dashboard` routes only require an\n * authenticated user (no permission check).\n */\nexport class DashboardApi extends BaseApi {\n  public readonly basePath = '/dashboard'\n\n  /** Message, ticket, contact and time counts of the period (`GET /dashboard/general`). */\n  getGeneral(query?: DashboardQuery, headers?: Record<string, string>): Promise<DashboardGeneral> {\n    return this.client.get<DashboardGeneral>(\n      `${this.basePath}/general${this.toQueryString(query)}`,\n      headers,\n    )\n  }\n}\n"],"mappings":";;;;;;;AAOA,IAAa,eAAb,cAAkC,QAAQ;CACxC,AAAgB,WAAW;;CAG3B,WAAW,OAAwB,SAA6D;AAC9F,SAAO,KAAK,OAAO,IACjB,GAAG,KAAK,SAAS,UAAU,KAAK,cAAc,MAAM,IACpD,QACD"}
+{"version":3,"file":"DashboardApi.mjs","names":[],"sources":["../../../src/apis/dashboard/DashboardApi.ts"],"sourcesContent":["import { BaseApi } from '../../core/BaseApi'\nimport type {\n  DashboardDepartmentItem,\n  DashboardGeneral,\n  DashboardGrouped,\n  DashboardPeriodItem,\n  DashboardQuery,\n  DashboardServiceItem,\n  DashboardTopicItem,\n  DashboardUserItem,\n  DashboardWithTotals,\n} from './types'\n\n/**\n * Service statistics (\"Estatísticas de atendimento\"). The `/dashboard` routes only require an\n * authenticated user (no permission check). Every route takes the same {@link DashboardQuery}\n * filters; the grouped routes answer one item per day, user, department, topic or connection.\n */\nexport class DashboardApi extends BaseApi {\n  public readonly basePath = '/dashboard'\n\n  /** Message, ticket, contact and time counts of the period (`GET /dashboard/general`). */\n  getGeneral(query?: DashboardQuery, headers?: Record<string, string>): Promise<DashboardGeneral> {\n    return this.client.get<DashboardGeneral>(\n      `${this.basePath}/general${this.toQueryString(query)}`,\n      headers,\n    )\n  }\n\n  /**\n   * The counts of each bucket of the period (`GET /dashboard/by-period`): one item per day by default,\n   * or per `grouping` (hour, week, month, year). With `withTotals: true` the answer is\n   * `{ totals, items }`.\n   */\n  getByPeriod(\n    query: DashboardQuery & { withTotals: true },\n    headers?: Record<string, string>,\n  ): Promise<DashboardGrouped<DashboardPeriodItem>>\n  getByPeriod(\n    query?: DashboardQuery & { withTotals?: false },\n    headers?: Record<string, string>,\n  ): Promise<DashboardPeriodItem[]>\n  /** When `withTotals` is only known at runtime (e.g. a `boolean` variable). */\n  getByPeriod(\n    query?: DashboardQuery & DashboardWithTotals,\n    headers?: Record<string, string>,\n  ): Promise<DashboardPeriodItem[] | DashboardGrouped<DashboardPeriodItem>>\n  getByPeriod(\n    query?: DashboardQuery & DashboardWithTotals,\n    headers?: Record<string, string>,\n  ): Promise<DashboardPeriodItem[] | DashboardGrouped<DashboardPeriodItem>> {\n    return this.getGrouped<DashboardPeriodItem>('by-period', query, headers)\n  }\n\n  /**\n   * The counts of each user of the period (`GET /dashboard/by-user`). With `withTotals: true` the\n   * answer is `{ totals, items }`.\n   */\n  getByUser(\n    query: DashboardQuery & { withTotals: true },\n    headers?: Record<string, string>,\n  ): Promise<DashboardGrouped<DashboardUserItem>>\n  getByUser(\n    query?: DashboardQuery & { withTotals?: false },\n    headers?: Record<string, string>,\n  ): Promise<DashboardUserItem[]>\n  /** When `withTotals` is only known at runtime (e.g. a `boolean` variable). */\n  getByUser(\n    query?: DashboardQuery & DashboardWithTotals,\n    headers?: Record<string, string>,\n  ): Promise<DashboardUserItem[] | DashboardGrouped<DashboardUserItem>>\n  getByUser(\n    query?: DashboardQuery & DashboardWithTotals,\n    headers?: Record<string, string>,\n  ): Promise<DashboardUserItem[] | DashboardGrouped<DashboardUserItem>> {\n    return this.getGrouped<DashboardUserItem>('by-user', query, headers)\n  }\n\n  /**\n   * The counts of each department of the period (`GET /dashboard/by-department`). With\n   * `withTotals: true` the answer is `{ totals, items }`.\n   */\n  getByDepartment(\n    query: DashboardQuery & { withTotals: true },\n    headers?: Record<string, string>,\n  ): Promise<DashboardGrouped<DashboardDepartmentItem>>\n  getByDepartment(\n    query?: DashboardQuery & { withTotals?: false },\n    headers?: Record<string, string>,\n  ): Promise<DashboardDepartmentItem[]>\n  /** When `withTotals` is only known at runtime (e.g. a `boolean` variable). */\n  getByDepartment(\n    query?: DashboardQuery & DashboardWithTotals,\n    headers?: Record<string, string>,\n  ): Promise<DashboardDepartmentItem[] | DashboardGrouped<DashboardDepartmentItem>>\n  getByDepartment(\n    query?: DashboardQuery & DashboardWithTotals,\n    headers?: Record<string, string>,\n  ): Promise<DashboardDepartmentItem[] | DashboardGrouped<DashboardDepartmentItem>> {\n    return this.getGrouped<DashboardDepartmentItem>('by-department', query, headers)\n  }\n\n  /**\n   * The counts of each ticket topic of the period (`GET /dashboard/by-topic`). Does not take\n   * `withTotals` (the backend ignores it).\n   */\n  getByTopic(\n    query?: DashboardQuery,\n    headers?: Record<string, string>,\n  ): Promise<DashboardTopicItem[]> {\n    return this.client.get<DashboardTopicItem[]>(\n      `${this.basePath}/by-topic${this.toQueryString(query)}`,\n      headers,\n    )\n  }\n\n  /**\n   * The counts of each connection of the period (`GET /dashboard/by-service`). Does not take\n   * `withTotals` (the backend ignores it).\n   */\n  getByService(\n    query?: DashboardQuery,\n    headers?: Record<string, string>,\n  ): Promise<DashboardServiceItem[]> {\n    return this.client.get<DashboardServiceItem[]>(\n      `${this.basePath}/by-service${this.toQueryString(query)}`,\n      headers,\n    )\n  }\n\n  /**\n   * `withTotals` is only sent when `true`: the backend reads it with a truthiness check, so in the\n   * `qs` format a serialized `withTotals=false` (the string `'false'`) would wrap the answer anyway.\n   */\n  private getGrouped<TItem>(\n    route: string,\n    query?: DashboardQuery & DashboardWithTotals,\n    headers?: Record<string, string>,\n  ): Promise<TItem[] | DashboardGrouped<TItem>> {\n    const { withTotals, ...filters } = query ?? {}\n    return this.client.get<TItem[] | DashboardGrouped<TItem>>(\n      `${this.basePath}/${route}${this.toQueryString(withTotals ? { ...filters, withTotals: true } : filters)}`,\n      headers,\n    )\n  }\n}\n"],"mappings":";;;;;;;;AAkBA,IAAa,eAAb,cAAkC,QAAQ;CACxC,AAAgB,WAAW;;CAG3B,WAAW,OAAwB,SAA6D;AAC9F,SAAO,KAAK,OAAO,IACjB,GAAG,KAAK,SAAS,UAAU,KAAK,cAAc,MAAM,IACpD,QACD;;CAqBH,YACE,OACA,SACwE;AACxE,SAAO,KAAK,WAAgC,aAAa,OAAO,QAAQ;;CAoB1E,UACE,OACA,SACoE;AACpE,SAAO,KAAK,WAA8B,WAAW,OAAO,QAAQ;;CAoBtE,gBACE,OACA,SACgF;AAChF,SAAO,KAAK,WAAoC,iBAAiB,OAAO,QAAQ;;;;;;CAOlF,WACE,OACA,SAC+B;AAC/B,SAAO,KAAK,OAAO,IACjB,GAAG,KAAK,SAAS,WAAW,KAAK,cAAc,MAAM,IACrD,QACD;;;;;;CAOH,aACE,OACA,SACiC;AACjC,SAAO,KAAK,OAAO,IACjB,GAAG,KAAK,SAAS,aAAa,KAAK,cAAc,MAAM,IACvD,QACD;;;;;;CAOH,AAAQ,WACN,OACA,OACA,SAC4C;EAC5C,MAAM,EAAE,YAAY,GAAG,YAAY,SAAS,EAAE;AAC9C,SAAO,KAAK,OAAO,IACjB,GAAG,KAAK,SAAS,GAAG,QAAQ,KAAK,cAAc,aAAa;GAAE,GAAG;GAAS,YAAY;GAAM,GAAG,QAAQ,IACvG,QACD"}

package/dist/apis/dashboard/types.d.ts

@@ -1,3 +1,9 @@
+/**
+ * Granularity of the by-period items (`grouping`). Default: `daily`. Whatever the granularity, the
+ * `name` of each item is its day (`dd/MM/yyyy`), so with `hourly` the items of one day share the same
+ * `name` (they come in chronological order).
+ */
+export type DashboardGrouping = 'hourly' | 'daily' | 'weekly' | 'monthly' | 'yearly';
 /**
  * Filters of the service statistics (`/dashboard`). Every field is optional; the period defaults to
  * the last 7 days.
@@ -35,6 +41,20 @@ export type DashboardQuery = {
     serviceId?: string | string[];
     tagId?: string | string[];
     ticketTopicId?: string | string[];
+    /**
+     * Granularity of the `getByPeriod` items (the other routes ignore it). Default: `daily`. See
+     * {@link DashboardGrouping} for the `name` of the items.
+     */
+    grouping?: DashboardGrouping;
+};
+/**
+ * `withTotals: true` makes `getByPeriod`, `getByUser` and `getByDepartment` answer `{ totals, items }`,
+ * where `totals` are the `getGeneral` counts of the same filters (`getByTopic` and `getByService` do
+ * not take it). Kept out of `DashboardQuery` so a query without it keeps the plain array overload.
+ * Only sent to the backend when `true`.
+ */
+export type DashboardWithTotals = {
+    withTotals?: boolean;
 };
 /** `GET /dashboard/general` — counts of the period. Times are in seconds. */
 export type DashboardGeneral = {
@@ -50,4 +70,55 @@ export type DashboardGeneral = {
     ticketTime: number;
     contactsCount: number;
 };
+/**
+ * Counts shared by the grouped routes (`by-period`, `by-user`, `by-department`, `by-topic`,
+ * `by-service`). The backend builds each item from the rows it found, so a count is ABSENT (not 0)
+ * when the group has no row for it: read them with a default. Times are in seconds.
+ */
+export type DashboardGroupCounts = {
+    sentMessagesCount?: number;
+    receivedMessagesCount?: number;
+    openedTicketsCount?: number;
+    closedTicketsCount?: number;
+    waitingTime?: number;
+    ticketTime?: number;
+    contactsCount?: number;
+};
+/** `GET /dashboard/by-period` — the counts of one day of the period (`name` as `dd/MM/yyyy`). */
+export type DashboardPeriodItem = DashboardGroupCounts & {
+    name: string;
+    totalMessagesCount?: number;
+    totalTicketsCount?: number;
+    waitingTimeAfterBot?: number;
+    waitingTimeAvg?: number;
+};
+/** `GET /dashboard/by-user` — the counts of one user (`name` is the user's name). */
+export type DashboardUserItem = DashboardGroupCounts & {
+    name: string;
+    ticketTopicsCount?: number;
+};
+/** `GET /dashboard/by-department` — the counts of one department (`name` is its name). */
+export type DashboardDepartmentItem = DashboardGroupCounts & {
+    name: string;
+    ticketTopicsCount?: number;
+};
+/** `GET /dashboard/by-topic` — the counts of one ticket topic (`name` is the topic's name). */
+export type DashboardTopicItem = DashboardGroupCounts & {
+    name: string;
+    waitingTimeAfterBot?: number;
+    waitingTimeAvg?: number;
+};
+/** `GET /dashboard/by-service` — the counts of one connection (`name` is the connection's name). */
+export type DashboardServiceItem = DashboardGroupCounts & {
+    name: string;
+    waitingTimeAfterBot?: number;
+    waitingTimeAvg?: number;
+    ticketTopicsCount?: number;
+};
+/** Answer of `getByPeriod`, `getByUser` and `getByDepartment` with `withTotals: true`. */
+export type DashboardGrouped<TItem> = {
+    /** The `getGeneral` counts of the same filters. */
+    totals: DashboardGeneral;
+    items: TItem[];
+};
 //# sourceMappingURL=types.d.ts.map

package/dist/apis/dashboard/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/apis/dashboard/types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,iDAAiD;IACjD,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,8EAA8E;IAC9E,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,0EAA0E;IAC1E,UAAU,CAAC,EAAE,UAAU,GAAG,WAAW,CAAA;IACrC,6CAA6C;IAC7C,MAAM,CAAC,EAAE,KAAK,GAAG,MAAM,GAAG,QAAQ,CAAA;IAClC;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAChC;;;OAGG;IACH,uBAAuB,CAAC,EAAE,MAAM,GAAG,QAAQ,CAAA;IAC3C;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAC1B;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,QAAQ,CAAA;IACrC,UAAU,CAAC,EAAE,QAAQ,GAAG,UAAU,GAAG,KAAK,CAAA;IAC1C,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAC7B,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACzB,aAAa,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;CAClC,CAAA;AAED,6EAA6E;AAC7E,MAAM,MAAM,gBAAgB,GAAG;IAC7B,iBAAiB,EAAE,MAAM,CAAA;IACzB,qBAAqB,EAAE,MAAM,CAAA;IAC7B,kBAAkB,EAAE,MAAM,CAAA;IAC1B,kBAAkB,EAAE,MAAM,CAAA;IAC1B,kBAAkB,EAAE,MAAM,CAAA;IAC1B,iBAAiB,EAAE,MAAM,CAAA;IACzB,WAAW,EAAE,MAAM,CAAA;IACnB,mBAAmB,EAAE,MAAM,CAAA;IAC3B,cAAc,EAAE,MAAM,CAAA;IACtB,UAAU,EAAE,MAAM,CAAA;IAClB,aAAa,EAAE,MAAM,CAAA;CACtB,CAAA"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/apis/dashboard/types.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GAAG,QAAQ,GAAG,OAAO,GAAG,QAAQ,GAAG,SAAS,GAAG,QAAQ,CAAA;AAEpF;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,iDAAiD;IACjD,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,8EAA8E;IAC9E,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,0EAA0E;IAC1E,UAAU,CAAC,EAAE,UAAU,GAAG,WAAW,CAAA;IACrC,6CAA6C;IAC7C,MAAM,CAAC,EAAE,KAAK,GAAG,MAAM,GAAG,QAAQ,CAAA;IAClC;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAChC;;;OAGG;IACH,uBAAuB,CAAC,EAAE,MAAM,GAAG,QAAQ,CAAA;IAC3C;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAC1B;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,QAAQ,CAAA;IACrC,UAAU,CAAC,EAAE,QAAQ,GAAG,UAAU,GAAG,KAAK,CAAA;IAC1C,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAC7B,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACzB,aAAa,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACjC;;;OAGG;IACH,QAAQ,CAAC,EAAE,iBAAiB,CAAA;CAC7B,CAAA;AAED;;;;;GAKG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAAE,UAAU,CAAC,EAAE,OAAO,CAAA;CAAE,CAAA;AAE1D,6EAA6E;AAC7E,MAAM,MAAM,gBAAgB,GAAG;IAC7B,iBAAiB,EAAE,MAAM,CAAA;IACzB,qBAAqB,EAAE,MAAM,CAAA;IAC7B,kBAAkB,EAAE,MAAM,CAAA;IAC1B,kBAAkB,EAAE,MAAM,CAAA;IAC1B,kBAAkB,EAAE,MAAM,CAAA;IAC1B,iBAAiB,EAAE,MAAM,CAAA;IACzB,WAAW,EAAE,MAAM,CAAA;IACnB,mBAAmB,EAAE,MAAM,CAAA;IAC3B,cAAc,EAAE,MAAM,CAAA;IACtB,UAAU,EAAE,MAAM,CAAA;IAClB,aAAa,EAAE,MAAM,CAAA;CACtB,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC,iBAAiB,CAAC,EAAE,MAAM,CAAA;IAC1B,qBAAqB,CAAC,EAAE,MAAM,CAAA;IAC9B,kBAAkB,CAAC,EAAE,MAAM,CAAA;IAC3B,kBAAkB,CAAC,EAAE,MAAM,CAAA;IAC3B,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,aAAa,CAAC,EAAE,MAAM,CAAA;CACvB,CAAA;AAED,iGAAiG;AACjG,MAAM,MAAM,mBAAmB,GAAG,oBAAoB,GAAG;IACvD,IAAI,EAAE,MAAM,CAAA;IACZ,kBAAkB,CAAC,EAAE,MAAM,CAAA;IAC3B,iBAAiB,CAAC,EAAE,MAAM,CAAA;IAC1B,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAC5B,cAAc,CAAC,EAAE,MAAM,CAAA;CACxB,CAAA;AAED,qFAAqF;AACrF,MAAM,MAAM,iBAAiB,GAAG,oBAAoB,GAAG;IACrD,IAAI,EAAE,MAAM,CAAA;IACZ,iBAAiB,CAAC,EAAE,MAAM,CAAA;CAC3B,CAAA;AAED,0FAA0F;AAC1F,MAAM,MAAM,uBAAuB,GAAG,oBAAoB,GAAG;IAC3D,IAAI,EAAE,MAAM,CAAA;IACZ,iBAAiB,CAAC,EAAE,MAAM,CAAA;CAC3B,CAAA;AAED,+FAA+F;AAC/F,MAAM,MAAM,kBAAkB,GAAG,oBAAoB,GAAG;IACtD,IAAI,EAAE,MAAM,CAAA;IACZ,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAC5B,cAAc,CAAC,EAAE,MAAM,CAAA;CACxB,CAAA;AAED,oGAAoG;AACpG,MAAM,MAAM,oBAAoB,GAAG,oBAAoB,GAAG;IACxD,IAAI,EAAE,MAAM,CAAA;IACZ,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAC5B,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB,iBAAiB,CAAC,EAAE,MAAM,CAAA;CAC3B,CAAA;AAED,0FAA0F;AAC1F,MAAM,MAAM,gBAAgB,CAAC,KAAK,IAAI;IACpC,mDAAmD;IACnD,MAAM,EAAE,gBAAgB,CAAA;IACxB,KAAK,EAAE,KAAK,EAAE,CAAA;CACf,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ikatec/digisac-api-sdk",
-  "version": "4.2.0",
+  "version": "4.3.0",
   "type": "module",
   "main": "./dist/index.cjs",
   "module": "./dist/index.mjs",

package/src/apis/dashboard/DashboardApi.test-d.ts

@@ -0,0 +1,49 @@
+import { expectError, expectType } from 'tsd'
+import type { ApiClient } from '../../core/ApiClient'
+import { DashboardApi } from './DashboardApi'
+import type {
+  DashboardDepartmentItem,
+  DashboardGrouped,
+  DashboardPeriodItem,
+  DashboardQuery,
+  DashboardUserItem,
+} from './types'
+
+declare const client: ApiClient
+declare const filters: DashboardQuery
+declare const flag: boolean
+const dashboard = new DashboardApi(client)
+
+// ── without `withTotals` (or `false`): the plain array ──────────────
+
+expectType<Promise<DashboardPeriodItem[]>>(dashboard.getByPeriod())
+expectType<Promise<DashboardPeriodItem[]>>(dashboard.getByPeriod({ grouping: 'weekly' }))
+expectType<Promise<DashboardPeriodItem[]>>(dashboard.getByPeriod({ withTotals: false }))
+expectType<Promise<DashboardPeriodItem[]>>(dashboard.getByPeriod(filters))
+expectType<Promise<DashboardUserItem[]>>(dashboard.getByUser(filters))
+expectType<Promise<DashboardDepartmentItem[]>>(dashboard.getByDepartment(filters))
+
+// ── `withTotals: true`: `{ totals, items }` ─────────────────────────
+
+expectType<Promise<DashboardGrouped<DashboardPeriodItem>>>(
+  dashboard.getByPeriod({ withTotals: true }),
+)
+expectType<Promise<DashboardGrouped<DashboardPeriodItem>>>(
+  dashboard.getByPeriod({ ...filters, withTotals: true }),
+)
+expectType<Promise<DashboardGrouped<DashboardUserItem>>>(dashboard.getByUser({ withTotals: true }))
+expectType<Promise<DashboardGrouped<DashboardDepartmentItem>>>(
+  dashboard.getByDepartment({ withTotals: true }),
+)
+
+// ── `withTotals` only known at runtime: the union ───────────────────
+
+expectType<Promise<DashboardPeriodItem[] | DashboardGrouped<DashboardPeriodItem>>>(
+  dashboard.getByPeriod({ ...filters, withTotals: flag }),
+)
+
+// ── what the backend does not take ──────────────────────────────────
+
+expectError(dashboard.getByPeriod({ grouping: 'quarterly' }))
+expectError(dashboard.getByTopic({ withTotals: true }))
+expectError(dashboard.getByService({ withTotals: true }))

package/src/apis/dashboard/DashboardApi.test.ts

@@ -1,7 +1,16 @@
 import { beforeEach, describe, expect, it, vi } from 'vitest'
 import { DashboardApi } from './DashboardApi'
 import type { ApiClient } from '../../core/ApiClient'
-import type { DashboardGeneral } from './types'
+import type {
+  DashboardDepartmentItem,
+  DashboardGeneral,
+  DashboardPeriodItem,
+  DashboardQuery,
+  DashboardServiceItem,
+  DashboardTopicItem,
+  DashboardUserItem,
+  DashboardWithTotals,
+} from './types'
 
 // ── Mock client factory ──────────────────────────────────────────────
 
@@ -33,6 +42,37 @@ const general: DashboardGeneral = {
   contactsCount: 4,
 }
 
+const periodItems: DashboardPeriodItem[] = [
+  { name: '01/09/2026', sentMessagesCount: 4, receivedMessagesCount: 2, totalMessagesCount: 6 },
+  { name: '02/09/2026', openedTicketsCount: 1, closedTicketsCount: 1, totalTicketsCount: 2 },
+]
+
+const userItems: DashboardUserItem[] = [
+  { name: 'Alice', sentMessagesCount: 7, closedTicketsCount: 3, ticketTopicsCount: 1 },
+]
+
+const departmentItems: DashboardDepartmentItem[] = [
+  { name: 'Suporte', openedTicketsCount: 2, waitingTime: 60, ticketTime: 600 },
+]
+
+const topicItems: DashboardTopicItem[] = [
+  { name: 'Financeiro', openedTicketsCount: 1, waitingTimeAfterBot: 30, waitingTimeAvg: 45 },
+]
+
+const serviceItems: DashboardServiceItem[] = [
+  { name: 'WhatsApp', receivedMessagesCount: 5, contactsCount: 4, ticketTopicsCount: 2 },
+]
+
+const filters: DashboardQuery = {
+  startPeriod: '2026-09-01T00:00:00.000Z',
+  endPeriod: '2026-09-07T23:59:59.999Z',
+  status: 'closed',
+  departmentId: ['d1'],
+}
+
+const queryString = (query: DashboardQuery & DashboardWithTotals) =>
+  `?query=${encodeURIComponent(JSON.stringify(query))}`
+
 // ── Tests ────────────────────────────────────────────────────────────
 
 describe('DashboardApi', () => {
@@ -59,15 +99,9 @@ describe('DashboardApi', () => {
 
     it('sends the filters in the query string', async () => {
       vi.mocked(client.get).mockResolvedValue(general)
-      const query = {
-        startPeriod: '2026-09-01T00:00:00.000Z',
-        endPeriod: '2026-09-07T23:59:59.999Z',
-        status: 'closed' as const,
-        departmentId: ['d1'],
-      }
-      await api.getGeneral(query)
+      await api.getGeneral(filters)
       expect(client.get).toHaveBeenCalledWith(
-        `/dashboard/general?query=${encodeURIComponent(JSON.stringify(query))}`,
+        `/dashboard/general${queryString(filters)}`,
         undefined,
       )
     })
@@ -79,4 +113,158 @@ describe('DashboardApi', () => {
       expect(client.get).toHaveBeenCalledWith('/dashboard/general', headers)
     })
   })
+
+  describe('getByPeriod', () => {
+    it('calls client.get with /dashboard/by-period and no query string', async () => {
+      vi.mocked(client.get).mockResolvedValue(periodItems)
+      const result = await api.getByPeriod()
+      expect(client.get).toHaveBeenCalledWith('/dashboard/by-period', undefined)
+      expect(result).toEqual(periodItems)
+    })
+
+    it('sends the filters and the grouping in the query string', async () => {
+      vi.mocked(client.get).mockResolvedValue(periodItems)
+      const query: DashboardQuery = { ...filters, grouping: 'weekly' }
+      await api.getByPeriod(query)
+      expect(client.get).toHaveBeenCalledWith(
+        `/dashboard/by-period${queryString(query)}`,
+        undefined,
+      )
+    })
+
+    it('answers { totals, items } with withTotals: true', async () => {
+      const grouped = { totals: general, items: periodItems }
+      vi.mocked(client.get).mockResolvedValue(grouped)
+      const query = { ...filters, withTotals: true as const }
+      const result = await api.getByPeriod(query)
+      expect(client.get).toHaveBeenCalledWith(
+        `/dashboard/by-period${queryString(query)}`,
+        undefined,
+      )
+      expect(result).toEqual(grouped)
+      expect(result.totals.totalTicketsCount).toBe(5)
+      expect(result.items).toHaveLength(2)
+    })
+
+    it('does not send withTotals: false (the backend reads it as truthy in the qs format)', async () => {
+      vi.mocked(client.get).mockResolvedValue(periodItems)
+      await api.getByPeriod({ ...filters, withTotals: false })
+      expect(client.get).toHaveBeenCalledWith(
+        `/dashboard/by-period${queryString(filters)}`,
+        undefined,
+      )
+      await api.withQueryFormat('qs').getByPeriod({ withTotals: false, grouping: 'weekly' })
+      expect(client.get).toHaveBeenLastCalledWith('/dashboard/by-period?grouping=weekly', undefined)
+      await api.getByPeriod({ withTotals: false })
+      expect(client.get).toHaveBeenLastCalledWith('/dashboard/by-period', undefined)
+    })
+
+    it('forwards custom headers', async () => {
+      vi.mocked(client.get).mockResolvedValue(periodItems)
+      const headers = { 'X-Custom': 'h' }
+      await api.getByPeriod(undefined, headers)
+      expect(client.get).toHaveBeenCalledWith('/dashboard/by-period', headers)
+    })
+  })
+
+  describe('getByUser', () => {
+    it('calls client.get with /dashboard/by-user and the filters', async () => {
+      vi.mocked(client.get).mockResolvedValue(userItems)
+      const result = await api.getByUser(filters)
+      expect(client.get).toHaveBeenCalledWith(
+        `/dashboard/by-user${queryString(filters)}`,
+        undefined,
+      )
+      expect(result).toEqual(userItems)
+    })
+
+    it('answers { totals, items } with withTotals: true', async () => {
+      const grouped = { totals: general, items: userItems }
+      vi.mocked(client.get).mockResolvedValue(grouped)
+      const result = await api.getByUser({ withTotals: true })
+      expect(client.get).toHaveBeenCalledWith(
+        `/dashboard/by-user${queryString({ withTotals: true })}`,
+        undefined,
+      )
+      expect(result.items[0]?.name).toBe('Alice')
+    })
+
+    it('forwards custom headers', async () => {
+      vi.mocked(client.get).mockResolvedValue(userItems)
+      const headers = { 'X-Custom': 'h' }
+      await api.getByUser(undefined, headers)
+      expect(client.get).toHaveBeenCalledWith('/dashboard/by-user', headers)
+    })
+  })
+
+  describe('getByDepartment', () => {
+    it('calls client.get with /dashboard/by-department and the filters', async () => {
+      vi.mocked(client.get).mockResolvedValue(departmentItems)
+      const result = await api.getByDepartment(filters)
+      expect(client.get).toHaveBeenCalledWith(
+        `/dashboard/by-department${queryString(filters)}`,
+        undefined,
+      )
+      expect(result).toEqual(departmentItems)
+    })
+
+    it('answers { totals, items } with withTotals: true', async () => {
+      const grouped = { totals: general, items: departmentItems }
+      vi.mocked(client.get).mockResolvedValue(grouped)
+      const result = await api.getByDepartment({ withTotals: true })
+      expect(result).toEqual(grouped)
+    })
+
+    it('forwards custom headers', async () => {
+      vi.mocked(client.get).mockResolvedValue(departmentItems)
+      const headers = { 'X-Custom': 'h' }
+      await api.getByDepartment(undefined, headers)
+      expect(client.get).toHaveBeenCalledWith('/dashboard/by-department', headers)
+    })
+  })
+
+  describe('getByTopic', () => {
+    it('calls client.get with /dashboard/by-topic and the filters', async () => {
+      vi.mocked(client.get).mockResolvedValue(topicItems)
+      const result = await api.getByTopic(filters)
+      expect(client.get).toHaveBeenCalledWith(
+        `/dashboard/by-topic${queryString(filters)}`,
+        undefined,
+      )
+      expect(result).toEqual(topicItems)
+    })
+
+    it('forwards custom headers', async () => {
+      vi.mocked(client.get).mockResolvedValue(topicItems)
+      const headers = { 'X-Custom': 'h' }
+      await api.getByTopic(undefined, headers)
+      expect(client.get).toHaveBeenCalledWith('/dashboard/by-topic', headers)
+    })
+  })
+
+  describe('getByService', () => {
+    it('calls client.get with /dashboard/by-service and the filters', async () => {
+      vi.mocked(client.get).mockResolvedValue(serviceItems)
+      const result = await api.getByService(filters)
+      expect(client.get).toHaveBeenCalledWith(
+        `/dashboard/by-service${queryString(filters)}`,
+        undefined,
+      )
+      expect(result).toEqual(serviceItems)
+    })
+
+    it('forwards custom headers', async () => {
+      vi.mocked(client.get).mockResolvedValue(serviceItems)
+      const headers = { 'X-Custom': 'h' }
+      await api.getByService(undefined, headers)
+      expect(client.get).toHaveBeenCalledWith('/dashboard/by-service', headers)
+    })
+  })
+
+  describe('error propagation', () => {
+    it('propagates errors from the grouped routes', async () => {
+      vi.mocked(client.get).mockRejectedValue(new Error('Unauthorized'))
+      await expect(api.getByPeriod()).rejects.toThrow('Unauthorized')
+    })
+  })
 })

package/src/apis/dashboard/DashboardApi.ts

@@ -1,9 +1,20 @@
 import { BaseApi } from '../../core/BaseApi'
-import type { DashboardGeneral, DashboardQuery } from './types'
+import type {
+  DashboardDepartmentItem,
+  DashboardGeneral,
+  DashboardGrouped,
+  DashboardPeriodItem,
+  DashboardQuery,
+  DashboardServiceItem,
+  DashboardTopicItem,
+  DashboardUserItem,
+  DashboardWithTotals,
+} from './types'
 
 /**
  * Service statistics ("Estatísticas de atendimento"). The `/dashboard` routes only require an
- * authenticated user (no permission check).
+ * authenticated user (no permission check). Every route takes the same {@link DashboardQuery}
+ * filters; the grouped routes answer one item per day, user, department, topic or connection.
  */
 export class DashboardApi extends BaseApi {
   public readonly basePath = '/dashboard'
@@ -15,4 +26,121 @@ export class DashboardApi extends BaseApi {
       headers,
     )
   }
+
+  /**
+   * The counts of each bucket of the period (`GET /dashboard/by-period`): one item per day by default,
+   * or per `grouping` (hour, week, month, year). With `withTotals: true` the answer is
+   * `{ totals, items }`.
+   */
+  getByPeriod(
+    query: DashboardQuery & { withTotals: true },
+    headers?: Record<string, string>,
+  ): Promise<DashboardGrouped<DashboardPeriodItem>>
+  getByPeriod(
+    query?: DashboardQuery & { withTotals?: false },
+    headers?: Record<string, string>,
+  ): Promise<DashboardPeriodItem[]>
+  /** When `withTotals` is only known at runtime (e.g. a `boolean` variable). */
+  getByPeriod(
+    query?: DashboardQuery & DashboardWithTotals,
+    headers?: Record<string, string>,
+  ): Promise<DashboardPeriodItem[] | DashboardGrouped<DashboardPeriodItem>>
+  getByPeriod(
+    query?: DashboardQuery & DashboardWithTotals,
+    headers?: Record<string, string>,
+  ): Promise<DashboardPeriodItem[] | DashboardGrouped<DashboardPeriodItem>> {
+    return this.getGrouped<DashboardPeriodItem>('by-period', query, headers)
+  }
+
+  /**
+   * The counts of each user of the period (`GET /dashboard/by-user`). With `withTotals: true` the
+   * answer is `{ totals, items }`.
+   */
+  getByUser(
+    query: DashboardQuery & { withTotals: true },
+    headers?: Record<string, string>,
+  ): Promise<DashboardGrouped<DashboardUserItem>>
+  getByUser(
+    query?: DashboardQuery & { withTotals?: false },
+    headers?: Record<string, string>,
+  ): Promise<DashboardUserItem[]>
+  /** When `withTotals` is only known at runtime (e.g. a `boolean` variable). */
+  getByUser(
+    query?: DashboardQuery & DashboardWithTotals,
+    headers?: Record<string, string>,
+  ): Promise<DashboardUserItem[] | DashboardGrouped<DashboardUserItem>>
+  getByUser(
+    query?: DashboardQuery & DashboardWithTotals,
+    headers?: Record<string, string>,
+  ): Promise<DashboardUserItem[] | DashboardGrouped<DashboardUserItem>> {
+    return this.getGrouped<DashboardUserItem>('by-user', query, headers)
+  }
+
+  /**
+   * The counts of each department of the period (`GET /dashboard/by-department`). With
+   * `withTotals: true` the answer is `{ totals, items }`.
+   */
+  getByDepartment(
+    query: DashboardQuery & { withTotals: true },
+    headers?: Record<string, string>,
+  ): Promise<DashboardGrouped<DashboardDepartmentItem>>
+  getByDepartment(
+    query?: DashboardQuery & { withTotals?: false },
+    headers?: Record<string, string>,
+  ): Promise<DashboardDepartmentItem[]>
+  /** When `withTotals` is only known at runtime (e.g. a `boolean` variable). */
+  getByDepartment(
+    query?: DashboardQuery & DashboardWithTotals,
+    headers?: Record<string, string>,
+  ): Promise<DashboardDepartmentItem[] | DashboardGrouped<DashboardDepartmentItem>>
+  getByDepartment(
+    query?: DashboardQuery & DashboardWithTotals,
+    headers?: Record<string, string>,
+  ): Promise<DashboardDepartmentItem[] | DashboardGrouped<DashboardDepartmentItem>> {
+    return this.getGrouped<DashboardDepartmentItem>('by-department', query, headers)
+  }
+
+  /**
+   * The counts of each ticket topic of the period (`GET /dashboard/by-topic`). Does not take
+   * `withTotals` (the backend ignores it).
+   */
+  getByTopic(
+    query?: DashboardQuery,
+    headers?: Record<string, string>,
+  ): Promise<DashboardTopicItem[]> {
+    return this.client.get<DashboardTopicItem[]>(
+      `${this.basePath}/by-topic${this.toQueryString(query)}`,
+      headers,
+    )
+  }
+
+  /**
+   * The counts of each connection of the period (`GET /dashboard/by-service`). Does not take
+   * `withTotals` (the backend ignores it).
+   */
+  getByService(
+    query?: DashboardQuery,
+    headers?: Record<string, string>,
+  ): Promise<DashboardServiceItem[]> {
+    return this.client.get<DashboardServiceItem[]>(
+      `${this.basePath}/by-service${this.toQueryString(query)}`,
+      headers,
+    )
+  }
+
+  /**
+   * `withTotals` is only sent when `true`: the backend reads it with a truthiness check, so in the
+   * `qs` format a serialized `withTotals=false` (the string `'false'`) would wrap the answer anyway.
+   */
+  private getGrouped<TItem>(
+    route: string,
+    query?: DashboardQuery & DashboardWithTotals,
+    headers?: Record<string, string>,
+  ): Promise<TItem[] | DashboardGrouped<TItem>> {
+    const { withTotals, ...filters } = query ?? {}
+    return this.client.get<TItem[] | DashboardGrouped<TItem>>(
+      `${this.basePath}/${route}${this.toQueryString(withTotals ? { ...filters, withTotals: true } : filters)}`,
+      headers,
+    )
+  }
 }

package/src/apis/dashboard/types.ts

@@ -1,3 +1,10 @@
+/**
+ * Granularity of the by-period items (`grouping`). Default: `daily`. Whatever the granularity, the
+ * `name` of each item is its day (`dd/MM/yyyy`), so with `hourly` the items of one day share the same
+ * `name` (they come in chronological order).
+ */
+export type DashboardGrouping = 'hourly' | 'daily' | 'weekly' | 'monthly' | 'yearly'
+
 /**
  * Filters of the service statistics (`/dashboard`). Every field is optional; the period defaults to
  * the last 7 days.
@@ -35,8 +42,21 @@ export type DashboardQuery = {
   serviceId?: string | string[]
   tagId?: string | string[]
   ticketTopicId?: string | string[]
+  /**
+   * Granularity of the `getByPeriod` items (the other routes ignore it). Default: `daily`. See
+   * {@link DashboardGrouping} for the `name` of the items.
+   */
+  grouping?: DashboardGrouping
 }
 
+/**
+ * `withTotals: true` makes `getByPeriod`, `getByUser` and `getByDepartment` answer `{ totals, items }`,
+ * where `totals` are the `getGeneral` counts of the same filters (`getByTopic` and `getByService` do
+ * not take it). Kept out of `DashboardQuery` so a query without it keeps the plain array overload.
+ * Only sent to the backend when `true`.
+ */
+export type DashboardWithTotals = { withTotals?: boolean }
+
 /** `GET /dashboard/general` — counts of the period. Times are in seconds. */
 export type DashboardGeneral = {
   sentMessagesCount: number
@@ -51,3 +71,61 @@ export type DashboardGeneral = {
   ticketTime: number
   contactsCount: number
 }
+
+/**
+ * Counts shared by the grouped routes (`by-period`, `by-user`, `by-department`, `by-topic`,
+ * `by-service`). The backend builds each item from the rows it found, so a count is ABSENT (not 0)
+ * when the group has no row for it: read them with a default. Times are in seconds.
+ */
+export type DashboardGroupCounts = {
+  sentMessagesCount?: number
+  receivedMessagesCount?: number
+  openedTicketsCount?: number
+  closedTicketsCount?: number
+  waitingTime?: number
+  ticketTime?: number
+  contactsCount?: number
+}
+
+/** `GET /dashboard/by-period` — the counts of one day of the period (`name` as `dd/MM/yyyy`). */
+export type DashboardPeriodItem = DashboardGroupCounts & {
+  name: string
+  totalMessagesCount?: number
+  totalTicketsCount?: number
+  waitingTimeAfterBot?: number
+  waitingTimeAvg?: number
+}
+
+/** `GET /dashboard/by-user` — the counts of one user (`name` is the user's name). */
+export type DashboardUserItem = DashboardGroupCounts & {
+  name: string
+  ticketTopicsCount?: number
+}
+
+/** `GET /dashboard/by-department` — the counts of one department (`name` is its name). */
+export type DashboardDepartmentItem = DashboardGroupCounts & {
+  name: string
+  ticketTopicsCount?: number
+}
+
+/** `GET /dashboard/by-topic` — the counts of one ticket topic (`name` is the topic's name). */
+export type DashboardTopicItem = DashboardGroupCounts & {
+  name: string
+  waitingTimeAfterBot?: number
+  waitingTimeAvg?: number
+}
+
+/** `GET /dashboard/by-service` — the counts of one connection (`name` is the connection's name). */
+export type DashboardServiceItem = DashboardGroupCounts & {
+  name: string
+  waitingTimeAfterBot?: number
+  waitingTimeAvg?: number
+  ticketTopicsCount?: number
+}
+
+/** Answer of `getByPeriod`, `getByUser` and `getByDepartment` with `withTotals: true`. */
+export type DashboardGrouped<TItem> = {
+  /** The `getGeneral` counts of the same filters. */
+  totals: DashboardGeneral
+  items: TItem[]
+}

package/src/apis/queryFormat.test.ts

@@ -99,6 +99,70 @@ const cases: Case[] = [
       })
     },
   },
+  {
+    name: 'DashboardApi.getByPeriod',
+    path: '/dashboard/by-period',
+    query: { status: 'closed', departmentId: ['d1'], grouping: 'weekly', withTotals: true },
+    call: (client, f) => {
+      const api = new DashboardApi(client)
+      return (f ? api.withQueryFormat(f) : api).getByPeriod({
+        status: 'closed',
+        departmentId: ['d1'],
+        grouping: 'weekly',
+        withTotals: true,
+      })
+    },
+  },
+  {
+    name: 'DashboardApi.getByUser',
+    path: '/dashboard/by-user',
+    query: { status: 'closed', departmentId: ['d1'], withTotals: true },
+    call: (client, f) => {
+      const api = new DashboardApi(client)
+      return (f ? api.withQueryFormat(f) : api).getByUser({
+        status: 'closed',
+        departmentId: ['d1'],
+        withTotals: true,
+      })
+    },
+  },
+  {
+    name: 'DashboardApi.getByDepartment',
+    path: '/dashboard/by-department',
+    query: { status: 'closed', departmentId: ['d1'], withTotals: true },
+    call: (client, f) => {
+      const api = new DashboardApi(client)
+      return (f ? api.withQueryFormat(f) : api).getByDepartment({
+        status: 'closed',
+        departmentId: ['d1'],
+        withTotals: true,
+      })
+    },
+  },
+  {
+    name: 'DashboardApi.getByTopic',
+    path: '/dashboard/by-topic',
+    query: { status: 'closed', departmentId: ['d1'] },
+    call: (client, f) => {
+      const api = new DashboardApi(client)
+      return (f ? api.withQueryFormat(f) : api).getByTopic({
+        status: 'closed',
+        departmentId: ['d1'],
+      })
+    },
+  },
+  {
+    name: 'DashboardApi.getByService',
+    path: '/dashboard/by-service',
+    query: { status: 'closed', departmentId: ['d1'] },
+    call: (client, f) => {
+      const api = new DashboardApi(client)
+      return (f ? api.withQueryFormat(f) : api).getByService({
+        status: 'closed',
+        departmentId: ['d1'],
+      })
+    },
+  },
   {
     name: 'NowApi.getResume',
     path: '/now/resume',