@ikatec/digisac-api-sdk 4.12.0 → 4.14.0

package/dist/apis/absence/AbsenceApi.cjs

@@ -3,13 +3,57 @@ const require_core_BaseCrudApi = require('../../core/BaseCrudApi.cjs');
 
 //#region src/apis/absence/AbsenceApi.ts
 /**
-* Absences of the users. The backend serves the report (`GET /absence`), `POST /absence` and
-* `PUT /absence/:id`; there is no read by id nor delete.
+* Absences of the users. The backend serves the report (`GET /absence`, `GET /absence/export-csv`),
+* `GET /absence/find-open-absence`, `POST /absence`, `POST /absence/unlock` and `PUT /absence/:id`; there is
+* no read by id nor delete. Creating an absence sets the status of the user to `away` and `unlock` sets it
+* back to `online` (both emit `user.updated` to the webhooks).
 */
 var AbsenceApi = class extends require_core_BaseCrudApi.BaseCrudApi {
 	constructor(client) {
 		super(client, "/absence");
 	}
+	/**
+	* The absence report of the account (`GET /absence`), always paginated, with its own query (the rows are
+	* raw: see `AbsenceReportItem`). Prefer it to `getMany`, whose `where`/`include`/`paginate` the backend
+	* ignores. Requires both permissions, always: without them it answers 403
+	* `MISSING_ABSENCE_REPORT_PERMISSION`.
+	* @permissions overview.absence.view AND myAccount.absence
+	*/
+	report(query, headers) {
+		return this.client.get(`${this.basePath}${this.toQueryString(query)}`, headers);
+	}
+	/**
+	* Creates an absence for the current user (whatever `userId` says) and sets the user `away`. Resolves the
+	* stored absence (raw, without `user`).
+	* @permissions myAccount.absence
+	*/
+	create(body, headers) {
+		return super.create(body, headers);
+	}
+	/**
+	* The open absence of the current user, or `null` — also `null` while `settings.absence.enabled` is off.
+	* @permissions myAccount.absence
+	*/
+	findOpenAbsence(headers) {
+		return this.client.get(`${this.basePath}/find-open-absence`, headers);
+	}
+	/**
+	* Ends an absence (the open one of the user when `id` is absent) and sets the user `online`. The refusals
+	* of `settings.absence` come with status 200 (`INVALID_REASON`, `INVALID_PASSWORD`); without an open
+	* absence it answers 500.
+	* @permissions myAccount.absence
+	*/
+	unlock(body, headers) {
+		return this.client.post(`${this.basePath}/unlock`, body, headers);
+	}
+	/**
+	* Exports the report as CSV (`Usuário, De, Até, Motivo`; an open absence shows `Em andamento`), sent as
+	* the attachment `<yyyy-MM-dd>_absence-control.csv`.
+	* @permissions overview.absence.view AND myAccount.absence
+	*/
+	exportCsv(query, headers) {
+		return this.client.get(`${this.basePath}/export-csv${this.toQueryString(query)}`, headers);
+	}
 	/** @deprecated Not served: the backend has no GET /absence/:id, so this route answers 404. */
 	getById(id, query, headers) {
 		return super.getById(id, query, headers);

package/dist/apis/absence/AbsenceApi.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"AbsenceApi.cjs","names":["BaseCrudApi"],"sources":["../../../src/apis/absence/AbsenceApi.ts"],"sourcesContent":["import type { ApiClient } from '../../core/ApiClient'\nimport { BaseCrudApi } from '../../core/BaseCrudApi'\nimport type { GetByIdQuery } from '../../core/types'\nimport type { Absence, CreateAbsencePayload, UpdateAbsencePayload } from './types'\n\n/**\n * Absences of the users. The backend serves the report (`GET /absence`), `POST /absence` and\n * `PUT /absence/:id`; there is no read by id nor delete.\n */\nexport class AbsenceApi extends BaseCrudApi<Absence, CreateAbsencePayload, UpdateAbsencePayload> {\n  constructor(client: ApiClient) {\n    super(client, '/absence')\n  }\n\n  /** @deprecated Not served: the backend has no GET /absence/:id, so this route answers 404. */\n  override getById(\n    id: string,\n    query?: GetByIdQuery<Absence>,\n    headers?: Record<string, string>,\n  ): Promise<Absence> {\n    return super.getById(id, query, headers)\n  }\n\n  /** @deprecated Not served: the backend has no DELETE /absence/:id, so this route answers 404. */\n  override deleteById(id: string, headers?: Record<string, string>): Promise<Absence> {\n    return super.deleteById(id, headers)\n  }\n}\n"],"mappings":";;;;;;;;AASA,IAAa,aAAb,cAAgCA,qCAAiE;CAC/F,YAAY,QAAmB;AAC7B,QAAM,QAAQ,WAAW;;;CAI3B,AAAS,QACP,IACA,OACA,SACkB;AAClB,SAAO,MAAM,QAAQ,IAAI,OAAO,QAAQ;;;CAI1C,AAAS,WAAW,IAAY,SAAoD;AAClF,SAAO,MAAM,WAAW,IAAI,QAAQ"}
+{"version":3,"file":"AbsenceApi.cjs","names":["BaseCrudApi"],"sources":["../../../src/apis/absence/AbsenceApi.ts"],"sourcesContent":["import type { ApiClient } from '../../core/ApiClient'\nimport { BaseCrudApi } from '../../core/BaseCrudApi'\nimport type { GetByIdQuery, Paginated } from '../../core/types'\nimport type {\n  Absence,\n  AbsenceReportItem,\n  AbsenceReportQuery,\n  CreateAbsencePayload,\n  UnlockAbsencePayload,\n  UnlockAbsenceResponse,\n  UpdateAbsencePayload,\n} from './types'\n\n/**\n * Absences of the users. The backend serves the report (`GET /absence`, `GET /absence/export-csv`),\n * `GET /absence/find-open-absence`, `POST /absence`, `POST /absence/unlock` and `PUT /absence/:id`; there is\n * no read by id nor delete. Creating an absence sets the status of the user to `away` and `unlock` sets it\n * back to `online` (both emit `user.updated` to the webhooks).\n */\nexport class AbsenceApi extends BaseCrudApi<Absence, CreateAbsencePayload, UpdateAbsencePayload> {\n  constructor(client: ApiClient) {\n    super(client, '/absence')\n  }\n\n  /**\n   * The absence report of the account (`GET /absence`), always paginated, with its own query (the rows are\n   * raw: see `AbsenceReportItem`). Prefer it to `getMany`, whose `where`/`include`/`paginate` the backend\n   * ignores. Requires both permissions, always: without them it answers 403\n   * `MISSING_ABSENCE_REPORT_PERMISSION`.\n   * @permissions overview.absence.view AND myAccount.absence\n   */\n  report(\n    query?: AbsenceReportQuery,\n    headers?: Record<string, string>,\n  ): Promise<Paginated<AbsenceReportItem>> {\n    return this.client.get<Paginated<AbsenceReportItem>>(\n      `${this.basePath}${this.toQueryString(query)}`,\n      headers,\n    )\n  }\n\n  /**\n   * Creates an absence for the current user (whatever `userId` says) and sets the user `away`. Resolves the\n   * stored absence (raw, without `user`).\n   * @permissions myAccount.absence\n   */\n  override create(body: CreateAbsencePayload, headers?: Record<string, string>): Promise<Absence> {\n    return super.create(body, headers)\n  }\n\n  /**\n   * The open absence of the current user, or `null` — also `null` while `settings.absence.enabled` is off.\n   * @permissions myAccount.absence\n   */\n  findOpenAbsence(headers?: Record<string, string>): Promise<AbsenceReportItem | null> {\n    return this.client.get<AbsenceReportItem | null>(`${this.basePath}/find-open-absence`, headers)\n  }\n\n  /**\n   * Ends an absence (the open one of the user when `id` is absent) and sets the user `online`. The refusals\n   * of `settings.absence` come with status 200 (`INVALID_REASON`, `INVALID_PASSWORD`); without an open\n   * absence it answers 500.\n   * @permissions myAccount.absence\n   */\n  unlock(\n    body: UnlockAbsencePayload,\n    headers?: Record<string, string>,\n  ): Promise<UnlockAbsenceResponse> {\n    return this.client.post<UnlockAbsenceResponse, UnlockAbsencePayload>(\n      `${this.basePath}/unlock`,\n      body,\n      headers,\n    )\n  }\n\n  /**\n   * Exports the report as CSV (`Usuário, De, Até, Motivo`; an open absence shows `Em andamento`), sent as\n   * the attachment `<yyyy-MM-dd>_absence-control.csv`.\n   * @permissions overview.absence.view AND myAccount.absence\n   */\n  exportCsv(query?: AbsenceReportQuery, headers?: Record<string, string>): Promise<string> {\n    return this.client.get<string>(\n      `${this.basePath}/export-csv${this.toQueryString(query)}`,\n      headers,\n    )\n  }\n\n  /** @deprecated Not served: the backend has no GET /absence/:id, so this route answers 404. */\n  override getById(\n    id: string,\n    query?: GetByIdQuery<Absence>,\n    headers?: Record<string, string>,\n  ): Promise<Absence> {\n    return super.getById(id, query, headers)\n  }\n\n  /** @deprecated Not served: the backend has no DELETE /absence/:id, so this route answers 404. */\n  override deleteById(id: string, headers?: Record<string, string>): Promise<Absence> {\n    return super.deleteById(id, headers)\n  }\n}\n"],"mappings":";;;;;;;;;;AAmBA,IAAa,aAAb,cAAgCA,qCAAiE;CAC/F,YAAY,QAAmB;AAC7B,QAAM,QAAQ,WAAW;;;;;;;;;CAU3B,OACE,OACA,SACuC;AACvC,SAAO,KAAK,OAAO,IACjB,GAAG,KAAK,WAAW,KAAK,cAAc,MAAM,IAC5C,QACD;;;;;;;CAQH,AAAS,OAAO,MAA4B,SAAoD;AAC9F,SAAO,MAAM,OAAO,MAAM,QAAQ;;;;;;CAOpC,gBAAgB,SAAqE;AACnF,SAAO,KAAK,OAAO,IAA8B,GAAG,KAAK,SAAS,qBAAqB,QAAQ;;;;;;;;CASjG,OACE,MACA,SACgC;AAChC,SAAO,KAAK,OAAO,KACjB,GAAG,KAAK,SAAS,UACjB,MACA,QACD;;;;;;;CAQH,UAAU,OAA4B,SAAmD;AACvF,SAAO,KAAK,OAAO,IACjB,GAAG,KAAK,SAAS,aAAa,KAAK,cAAc,MAAM,IACvD,QACD;;;CAIH,AAAS,QACP,IACA,OACA,SACkB;AAClB,SAAO,MAAM,QAAQ,IAAI,OAAO,QAAQ;;;CAI1C,AAAS,WAAW,IAAY,SAAoD;AAClF,SAAO,MAAM,WAAW,IAAI,QAAQ"}

package/dist/apis/absence/AbsenceApi.d.ts

@@ -1,13 +1,47 @@
 import type { ApiClient } from '../../core/ApiClient';
 import { BaseCrudApi } from '../../core/BaseCrudApi';
-import type { GetByIdQuery } from '../../core/types';
-import type { Absence, CreateAbsencePayload, UpdateAbsencePayload } from './types';
+import type { GetByIdQuery, Paginated } from '../../core/types';
+import type { Absence, AbsenceReportItem, AbsenceReportQuery, CreateAbsencePayload, UnlockAbsencePayload, UnlockAbsenceResponse, UpdateAbsencePayload } from './types';
 /**
- * Absences of the users. The backend serves the report (`GET /absence`), `POST /absence` and
- * `PUT /absence/:id`; there is no read by id nor delete.
+ * Absences of the users. The backend serves the report (`GET /absence`, `GET /absence/export-csv`),
+ * `GET /absence/find-open-absence`, `POST /absence`, `POST /absence/unlock` and `PUT /absence/:id`; there is
+ * no read by id nor delete. Creating an absence sets the status of the user to `away` and `unlock` sets it
+ * back to `online` (both emit `user.updated` to the webhooks).
  */
 export declare class AbsenceApi extends BaseCrudApi<Absence, CreateAbsencePayload, UpdateAbsencePayload> {
     constructor(client: ApiClient);
+    /**
+     * The absence report of the account (`GET /absence`), always paginated, with its own query (the rows are
+     * raw: see `AbsenceReportItem`). Prefer it to `getMany`, whose `where`/`include`/`paginate` the backend
+     * ignores. Requires both permissions, always: without them it answers 403
+     * `MISSING_ABSENCE_REPORT_PERMISSION`.
+     * @permissions overview.absence.view AND myAccount.absence
+     */
+    report(query?: AbsenceReportQuery, headers?: Record<string, string>): Promise<Paginated<AbsenceReportItem>>;
+    /**
+     * Creates an absence for the current user (whatever `userId` says) and sets the user `away`. Resolves the
+     * stored absence (raw, without `user`).
+     * @permissions myAccount.absence
+     */
+    create(body: CreateAbsencePayload, headers?: Record<string, string>): Promise<Absence>;
+    /**
+     * The open absence of the current user, or `null` — also `null` while `settings.absence.enabled` is off.
+     * @permissions myAccount.absence
+     */
+    findOpenAbsence(headers?: Record<string, string>): Promise<AbsenceReportItem | null>;
+    /**
+     * Ends an absence (the open one of the user when `id` is absent) and sets the user `online`. The refusals
+     * of `settings.absence` come with status 200 (`INVALID_REASON`, `INVALID_PASSWORD`); without an open
+     * absence it answers 500.
+     * @permissions myAccount.absence
+     */
+    unlock(body: UnlockAbsencePayload, headers?: Record<string, string>): Promise<UnlockAbsenceResponse>;
+    /**
+     * Exports the report as CSV (`Usuário, De, Até, Motivo`; an open absence shows `Em andamento`), sent as
+     * the attachment `<yyyy-MM-dd>_absence-control.csv`.
+     * @permissions overview.absence.view AND myAccount.absence
+     */
+    exportCsv(query?: AbsenceReportQuery, headers?: Record<string, string>): Promise<string>;
     /** @deprecated Not served: the backend has no GET /absence/:id, so this route answers 404. */
     getById(id: string, query?: GetByIdQuery<Absence>, headers?: Record<string, string>): Promise<Absence>;
     /** @deprecated Not served: the backend has no DELETE /absence/:id, so this route answers 404. */

package/dist/apis/absence/AbsenceApi.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"AbsenceApi.d.ts","sourceRoot":"","sources":["../../../src/apis/absence/AbsenceApi.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAA;AACrD,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAA;AACpD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAA;AACpD,OAAO,KAAK,EAAE,OAAO,EAAE,oBAAoB,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAA;AAElF;;;GAGG;AACH,qBAAa,UAAW,SAAQ,WAAW,CAAC,OAAO,EAAE,oBAAoB,EAAE,oBAAoB,CAAC;gBAClF,MAAM,EAAE,SAAS;IAI7B,8FAA8F;IACrF,OAAO,CACd,EAAE,EAAE,MAAM,EACV,KAAK,CAAC,EAAE,YAAY,CAAC,OAAO,CAAC,EAC7B,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,OAAO,CAAC;IAInB,iGAAiG;IACxF,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC;CAGpF"}
+{"version":3,"file":"AbsenceApi.d.ts","sourceRoot":"","sources":["../../../src/apis/absence/AbsenceApi.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAA;AACrD,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAA;AACpD,OAAO,KAAK,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAA;AAC/D,OAAO,KAAK,EACV,OAAO,EACP,iBAAiB,EACjB,kBAAkB,EAClB,oBAAoB,EACpB,oBAAoB,EACpB,qBAAqB,EACrB,oBAAoB,EACrB,MAAM,SAAS,CAAA;AAEhB;;;;;GAKG;AACH,qBAAa,UAAW,SAAQ,WAAW,CAAC,OAAO,EAAE,oBAAoB,EAAE,oBAAoB,CAAC;gBAClF,MAAM,EAAE,SAAS;IAI7B;;;;;;OAMG;IACH,MAAM,CACJ,KAAK,CAAC,EAAE,kBAAkB,EAC1B,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,SAAS,CAAC,iBAAiB,CAAC,CAAC;IAOxC;;;;OAIG;IACM,MAAM,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC;IAI/F;;;OAGG;IACH,eAAe,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,iBAAiB,GAAG,IAAI,CAAC;IAIpF;;;;;OAKG;IACH,MAAM,CACJ,IAAI,EAAE,oBAAoB,EAC1B,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,qBAAqB,CAAC;IAQjC;;;;OAIG;IACH,SAAS,CAAC,KAAK,CAAC,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC;IAOxF,8FAA8F;IACrF,OAAO,CACd,EAAE,EAAE,MAAM,EACV,KAAK,CAAC,EAAE,YAAY,CAAC,OAAO,CAAC,EAC7B,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,OAAO,CAAC;IAInB,iGAAiG;IACxF,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC;CAGpF"}

package/dist/apis/absence/AbsenceApi.mjs

@@ -2,13 +2,57 @@ import { BaseCrudApi } from "../../core/BaseCrudApi.mjs";
 
 //#region src/apis/absence/AbsenceApi.ts
 /**
-* Absences of the users. The backend serves the report (`GET /absence`), `POST /absence` and
-* `PUT /absence/:id`; there is no read by id nor delete.
+* Absences of the users. The backend serves the report (`GET /absence`, `GET /absence/export-csv`),
+* `GET /absence/find-open-absence`, `POST /absence`, `POST /absence/unlock` and `PUT /absence/:id`; there is
+* no read by id nor delete. Creating an absence sets the status of the user to `away` and `unlock` sets it
+* back to `online` (both emit `user.updated` to the webhooks).
 */
 var AbsenceApi = class extends BaseCrudApi {
 	constructor(client) {
 		super(client, "/absence");
 	}
+	/**
+	* The absence report of the account (`GET /absence`), always paginated, with its own query (the rows are
+	* raw: see `AbsenceReportItem`). Prefer it to `getMany`, whose `where`/`include`/`paginate` the backend
+	* ignores. Requires both permissions, always: without them it answers 403
+	* `MISSING_ABSENCE_REPORT_PERMISSION`.
+	* @permissions overview.absence.view AND myAccount.absence
+	*/
+	report(query, headers) {
+		return this.client.get(`${this.basePath}${this.toQueryString(query)}`, headers);
+	}
+	/**
+	* Creates an absence for the current user (whatever `userId` says) and sets the user `away`. Resolves the
+	* stored absence (raw, without `user`).
+	* @permissions myAccount.absence
+	*/
+	create(body, headers) {
+		return super.create(body, headers);
+	}
+	/**
+	* The open absence of the current user, or `null` — also `null` while `settings.absence.enabled` is off.
+	* @permissions myAccount.absence
+	*/
+	findOpenAbsence(headers) {
+		return this.client.get(`${this.basePath}/find-open-absence`, headers);
+	}
+	/**
+	* Ends an absence (the open one of the user when `id` is absent) and sets the user `online`. The refusals
+	* of `settings.absence` come with status 200 (`INVALID_REASON`, `INVALID_PASSWORD`); without an open
+	* absence it answers 500.
+	* @permissions myAccount.absence
+	*/
+	unlock(body, headers) {
+		return this.client.post(`${this.basePath}/unlock`, body, headers);
+	}
+	/**
+	* Exports the report as CSV (`Usuário, De, Até, Motivo`; an open absence shows `Em andamento`), sent as
+	* the attachment `<yyyy-MM-dd>_absence-control.csv`.
+	* @permissions overview.absence.view AND myAccount.absence
+	*/
+	exportCsv(query, headers) {
+		return this.client.get(`${this.basePath}/export-csv${this.toQueryString(query)}`, headers);
+	}
 	/** @deprecated Not served: the backend has no GET /absence/:id, so this route answers 404. */
 	getById(id, query, headers) {
 		return super.getById(id, query, headers);

package/dist/apis/absence/AbsenceApi.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"AbsenceApi.mjs","names":[],"sources":["../../../src/apis/absence/AbsenceApi.ts"],"sourcesContent":["import type { ApiClient } from '../../core/ApiClient'\nimport { BaseCrudApi } from '../../core/BaseCrudApi'\nimport type { GetByIdQuery } from '../../core/types'\nimport type { Absence, CreateAbsencePayload, UpdateAbsencePayload } from './types'\n\n/**\n * Absences of the users. The backend serves the report (`GET /absence`), `POST /absence` and\n * `PUT /absence/:id`; there is no read by id nor delete.\n */\nexport class AbsenceApi extends BaseCrudApi<Absence, CreateAbsencePayload, UpdateAbsencePayload> {\n  constructor(client: ApiClient) {\n    super(client, '/absence')\n  }\n\n  /** @deprecated Not served: the backend has no GET /absence/:id, so this route answers 404. */\n  override getById(\n    id: string,\n    query?: GetByIdQuery<Absence>,\n    headers?: Record<string, string>,\n  ): Promise<Absence> {\n    return super.getById(id, query, headers)\n  }\n\n  /** @deprecated Not served: the backend has no DELETE /absence/:id, so this route answers 404. */\n  override deleteById(id: string, headers?: Record<string, string>): Promise<Absence> {\n    return super.deleteById(id, headers)\n  }\n}\n"],"mappings":";;;;;;;AASA,IAAa,aAAb,cAAgC,YAAiE;CAC/F,YAAY,QAAmB;AAC7B,QAAM,QAAQ,WAAW;;;CAI3B,AAAS,QACP,IACA,OACA,SACkB;AAClB,SAAO,MAAM,QAAQ,IAAI,OAAO,QAAQ;;;CAI1C,AAAS,WAAW,IAAY,SAAoD;AAClF,SAAO,MAAM,WAAW,IAAI,QAAQ"}
+{"version":3,"file":"AbsenceApi.mjs","names":[],"sources":["../../../src/apis/absence/AbsenceApi.ts"],"sourcesContent":["import type { ApiClient } from '../../core/ApiClient'\nimport { BaseCrudApi } from '../../core/BaseCrudApi'\nimport type { GetByIdQuery, Paginated } from '../../core/types'\nimport type {\n  Absence,\n  AbsenceReportItem,\n  AbsenceReportQuery,\n  CreateAbsencePayload,\n  UnlockAbsencePayload,\n  UnlockAbsenceResponse,\n  UpdateAbsencePayload,\n} from './types'\n\n/**\n * Absences of the users. The backend serves the report (`GET /absence`, `GET /absence/export-csv`),\n * `GET /absence/find-open-absence`, `POST /absence`, `POST /absence/unlock` and `PUT /absence/:id`; there is\n * no read by id nor delete. Creating an absence sets the status of the user to `away` and `unlock` sets it\n * back to `online` (both emit `user.updated` to the webhooks).\n */\nexport class AbsenceApi extends BaseCrudApi<Absence, CreateAbsencePayload, UpdateAbsencePayload> {\n  constructor(client: ApiClient) {\n    super(client, '/absence')\n  }\n\n  /**\n   * The absence report of the account (`GET /absence`), always paginated, with its own query (the rows are\n   * raw: see `AbsenceReportItem`). Prefer it to `getMany`, whose `where`/`include`/`paginate` the backend\n   * ignores. Requires both permissions, always: without them it answers 403\n   * `MISSING_ABSENCE_REPORT_PERMISSION`.\n   * @permissions overview.absence.view AND myAccount.absence\n   */\n  report(\n    query?: AbsenceReportQuery,\n    headers?: Record<string, string>,\n  ): Promise<Paginated<AbsenceReportItem>> {\n    return this.client.get<Paginated<AbsenceReportItem>>(\n      `${this.basePath}${this.toQueryString(query)}`,\n      headers,\n    )\n  }\n\n  /**\n   * Creates an absence for the current user (whatever `userId` says) and sets the user `away`. Resolves the\n   * stored absence (raw, without `user`).\n   * @permissions myAccount.absence\n   */\n  override create(body: CreateAbsencePayload, headers?: Record<string, string>): Promise<Absence> {\n    return super.create(body, headers)\n  }\n\n  /**\n   * The open absence of the current user, or `null` — also `null` while `settings.absence.enabled` is off.\n   * @permissions myAccount.absence\n   */\n  findOpenAbsence(headers?: Record<string, string>): Promise<AbsenceReportItem | null> {\n    return this.client.get<AbsenceReportItem | null>(`${this.basePath}/find-open-absence`, headers)\n  }\n\n  /**\n   * Ends an absence (the open one of the user when `id` is absent) and sets the user `online`. The refusals\n   * of `settings.absence` come with status 200 (`INVALID_REASON`, `INVALID_PASSWORD`); without an open\n   * absence it answers 500.\n   * @permissions myAccount.absence\n   */\n  unlock(\n    body: UnlockAbsencePayload,\n    headers?: Record<string, string>,\n  ): Promise<UnlockAbsenceResponse> {\n    return this.client.post<UnlockAbsenceResponse, UnlockAbsencePayload>(\n      `${this.basePath}/unlock`,\n      body,\n      headers,\n    )\n  }\n\n  /**\n   * Exports the report as CSV (`Usuário, De, Até, Motivo`; an open absence shows `Em andamento`), sent as\n   * the attachment `<yyyy-MM-dd>_absence-control.csv`.\n   * @permissions overview.absence.view AND myAccount.absence\n   */\n  exportCsv(query?: AbsenceReportQuery, headers?: Record<string, string>): Promise<string> {\n    return this.client.get<string>(\n      `${this.basePath}/export-csv${this.toQueryString(query)}`,\n      headers,\n    )\n  }\n\n  /** @deprecated Not served: the backend has no GET /absence/:id, so this route answers 404. */\n  override getById(\n    id: string,\n    query?: GetByIdQuery<Absence>,\n    headers?: Record<string, string>,\n  ): Promise<Absence> {\n    return super.getById(id, query, headers)\n  }\n\n  /** @deprecated Not served: the backend has no DELETE /absence/:id, so this route answers 404. */\n  override deleteById(id: string, headers?: Record<string, string>): Promise<Absence> {\n    return super.deleteById(id, headers)\n  }\n}\n"],"mappings":";;;;;;;;;AAmBA,IAAa,aAAb,cAAgC,YAAiE;CAC/F,YAAY,QAAmB;AAC7B,QAAM,QAAQ,WAAW;;;;;;;;;CAU3B,OACE,OACA,SACuC;AACvC,SAAO,KAAK,OAAO,IACjB,GAAG,KAAK,WAAW,KAAK,cAAc,MAAM,IAC5C,QACD;;;;;;;CAQH,AAAS,OAAO,MAA4B,SAAoD;AAC9F,SAAO,MAAM,OAAO,MAAM,QAAQ;;;;;;CAOpC,gBAAgB,SAAqE;AACnF,SAAO,KAAK,OAAO,IAA8B,GAAG,KAAK,SAAS,qBAAqB,QAAQ;;;;;;;;CASjG,OACE,MACA,SACgC;AAChC,SAAO,KAAK,OAAO,KACjB,GAAG,KAAK,SAAS,UACjB,MACA,QACD;;;;;;;CAQH,UAAU,OAA4B,SAAmD;AACvF,SAAO,KAAK,OAAO,IACjB,GAAG,KAAK,SAAS,aAAa,KAAK,cAAc,MAAM,IACvD,QACD;;;CAIH,AAAS,QACP,IACA,OACA,SACkB;AAClB,SAAO,MAAM,QAAQ,IAAI,OAAO,QAAQ;;;CAI1C,AAAS,WAAW,IAAY,SAAoD;AAClF,SAAO,MAAM,WAAW,IAAI,QAAQ"}

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

@@ -1,4 +1,5 @@
 import type { User } from '../users';
+/** An absence as `PUT /absence/:id` answers it (the transformer of the backend). */
 export type Absence = {
     id: string;
     accountId: string;
@@ -7,16 +8,64 @@ export type Absence = {
     endedAt: string | null;
     createdAt: string;
     updatedAt: string;
-    deletedAt: string | null;
+    /** @deprecated Not a field of the backend: the model has no soft delete. */
+    deletedAt?: string | null;
     user?: User;
 };
 export type AbsenceRelationships = 'user';
 export type CreateAbsencePayload = {
-    userId: string;
+    /** Ignored: the backend creates the absence for the current user. */
+    userId?: string;
+    /** Up to 255 characters. */
     reason?: string;
 };
 export type UpdateAbsencePayload = {
     reason?: string;
     endedAt?: string | null;
 };
+/** Columns the report can be sorted by (an unknown one falls back to the default order). */
+export type AbsenceReportSortField = 'user' | 'createdAt' | 'endedAt';
+/**
+ * Query of the absence report (`GET /absence` and `GET /absence/export-csv`). The backend ignores
+ * `where` and `include`: it reads only these fields.
+ */
+export type AbsenceReportQuery = {
+    filters?: {
+        userId?: string;
+        reason?: string;
+        /** Absences created at or after this date. An invalid date answers 400 `Invalid date.`. */
+        createdAt?: string;
+        /** Absences ended at or before this date. */
+        endedAt?: string;
+    };
+    sort?: AbsenceReportSortField;
+    /** Only `'ASC'` sorts ascending: any other value sorts descending. */
+    order?: 'ASC' | 'DESC';
+    page?: number;
+    /** Up to 200 (a larger value is clamped, not refused). Defaults to 15. */
+    perPage?: number;
+    /** IANA zone of the dates of the CSV export (e.g. `America/Sao_Paulo`). */
+    timezone?: string;
+};
+/**
+ * A row of the report: the stored absence with its user, both raw (not transformed).
+ */
+export type AbsenceReportItem = Omit<Absence, 'deletedAt' | 'user'> & {
+    user?: Record<string, unknown>;
+};
+/** The body of `unlock`: the absence to end (the open one of the user when `id` is absent). */
+export type UnlockAbsencePayload = {
+    id?: string;
+    /** Required when `settings.absence.reason_required` is on. */
+    reason?: string;
+    /** Required when `settings.absence.password_required` is on: the password of the user. */
+    password?: string;
+};
+/** What `unlock` answers: the business refusals come with status 200. */
+export type UnlockAbsenceResponse = {
+    success: true;
+} | {
+    success: false;
+    message: 'INVALID_REASON' | 'INVALID_PASSWORD';
+};
 //# sourceMappingURL=types.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/apis/absence/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,UAAU,CAAA;AAEpC,MAAM,MAAM,OAAO,GAAG;IACpB,EAAE,EAAE,MAAM,CAAA;IACV,SAAS,EAAE,MAAM,CAAA;IACjB,MAAM,EAAE,MAAM,CAAA;IACd,MAAM,EAAE,MAAM,GAAG,IAAI,CAAA;IACrB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAA;IACtB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IAExB,IAAI,CAAC,EAAE,IAAI,CAAA;CACZ,CAAA;AAED,MAAM,MAAM,oBAAoB,GAAG,MAAM,CAAA;AAEzC,MAAM,MAAM,oBAAoB,GAAG;IACjC,MAAM,EAAE,MAAM,CAAA;IACd,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB,CAAA;AAED,MAAM,MAAM,oBAAoB,GAAG;IACjC,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CACxB,CAAA"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/apis/absence/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,UAAU,CAAA;AAEpC,oFAAoF;AACpF,MAAM,MAAM,OAAO,GAAG;IACpB,EAAE,EAAE,MAAM,CAAA;IACV,SAAS,EAAE,MAAM,CAAA;IACjB,MAAM,EAAE,MAAM,CAAA;IACd,MAAM,EAAE,MAAM,GAAG,IAAI,CAAA;IACrB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAA;IACtB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,4EAA4E;IAC5E,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAEzB,IAAI,CAAC,EAAE,IAAI,CAAA;CACZ,CAAA;AAED,MAAM,MAAM,oBAAoB,GAAG,MAAM,CAAA;AAEzC,MAAM,MAAM,oBAAoB,GAAG;IACjC,qEAAqE;IACrE,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,4BAA4B;IAC5B,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB,CAAA;AAED,MAAM,MAAM,oBAAoB,GAAG;IACjC,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CACxB,CAAA;AAED,4FAA4F;AAC5F,MAAM,MAAM,sBAAsB,GAAG,MAAM,GAAG,WAAW,GAAG,SAAS,CAAA;AAErE;;;GAGG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B,OAAO,CAAC,EAAE;QACR,MAAM,CAAC,EAAE,MAAM,CAAA;QACf,MAAM,CAAC,EAAE,MAAM,CAAA;QACf,2FAA2F;QAC3F,SAAS,CAAC,EAAE,MAAM,CAAA;QAClB,6CAA6C;QAC7C,OAAO,CAAC,EAAE,MAAM,CAAA;KACjB,CAAA;IACD,IAAI,CAAC,EAAE,sBAAsB,CAAA;IAC7B,sEAAsE;IACtE,KAAK,CAAC,EAAE,KAAK,GAAG,MAAM,CAAA;IACtB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,0EAA0E;IAC1E,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,2EAA2E;IAC3E,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,IAAI,CAAC,OAAO,EAAE,WAAW,GAAG,MAAM,CAAC,GAAG;IACpE,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAC/B,CAAA;AAED,+FAA+F;AAC/F,MAAM,MAAM,oBAAoB,GAAG;IACjC,EAAE,CAAC,EAAE,MAAM,CAAA;IACX,8DAA8D;IAC9D,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,0FAA0F;IAC1F,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB,CAAA;AAED,yEAAyE;AACzE,MAAM,MAAM,qBAAqB,GAC7B;IAAE,OAAO,EAAE,IAAI,CAAA;CAAE,GACjB;IAAE,OAAO,EAAE,KAAK,CAAC;IAAC,OAAO,EAAE,gBAAgB,GAAG,kBAAkB,CAAA;CAAE,CAAA"}

package/dist/apis/activityLog/ActivityLogApi.cjs

@@ -4,12 +4,21 @@ const require_core_BaseCrudApi = require('../../core/BaseCrudApi.cjs');
 //#region src/apis/activityLog/ActivityLogApi.ts
 /**
 * Activity log of the account (stored in MongoDB: the routes answer 503 when it is unavailable).
-* The backend serves `GET /log`, `GET /log/:id` and `POST /log`; there is no update or delete.
+* The backend serves `GET /log`, `GET /log/export-csv`, `GET /log/:id` and `POST /log`; there is no update
+* or delete, so an entry created is permanent. `GET /log/:id` takes a MongoDB
+* id (an UUID answers 500).
 */
 var ActivityLogApi = class extends require_core_BaseCrudApi.BaseCrudApi {
 	constructor(client) {
 		super(client, "/log");
 	}
+	/**
+	* Exports the entries of the period (`filters.from`/`filters.to`) as CSV, sent as the attachment
+	* `exportation.csv`.
+	*/
+	exportCsv(query, headers) {
+		return this.client.get(`${this.basePath}/export-csv${this.toQueryString(query)}`, headers);
+	}
 	/** @deprecated Not served: the backend has no PUT /log/:id, so this route answers 404. */
 	updateById(id, body, headers) {
 		return super.updateById(id, body, headers);

package/dist/apis/activityLog/ActivityLogApi.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"ActivityLogApi.cjs","names":["BaseCrudApi"],"sources":["../../../src/apis/activityLog/ActivityLogApi.ts"],"sourcesContent":["import type { ApiClient } from '../../core/ApiClient'\nimport { BaseCrudApi } from '../../core/BaseCrudApi'\nimport type { ActivityLog, CreateActivityLogPayload, UpdateActivityLogPayload } from './types'\n\n/**\n * Activity log of the account (stored in MongoDB: the routes answer 503 when it is unavailable).\n * The backend serves `GET /log`, `GET /log/:id` and `POST /log`; there is no update or delete.\n */\nexport class ActivityLogApi extends BaseCrudApi<\n  ActivityLog,\n  CreateActivityLogPayload,\n  UpdateActivityLogPayload\n> {\n  constructor(client: ApiClient) {\n    super(client, '/log')\n  }\n\n  /** @deprecated Not served: the backend has no PUT /log/:id, so this route answers 404. */\n  override updateById(\n    id: string,\n    body: UpdateActivityLogPayload,\n    headers?: Record<string, string>,\n  ): Promise<ActivityLog> {\n    return super.updateById(id, body, headers)\n  }\n\n  /** @deprecated Not served: the backend has no DELETE /log/:id, so this route answers 404. */\n  override deleteById(id: string, headers?: Record<string, string>): Promise<ActivityLog> {\n    return super.deleteById(id, headers)\n  }\n}\n"],"mappings":";;;;;;;;AAQA,IAAa,iBAAb,cAAoCA,qCAIlC;CACA,YAAY,QAAmB;AAC7B,QAAM,QAAQ,OAAO;;;CAIvB,AAAS,WACP,IACA,MACA,SACsB;AACtB,SAAO,MAAM,WAAW,IAAI,MAAM,QAAQ;;;CAI5C,AAAS,WAAW,IAAY,SAAwD;AACtF,SAAO,MAAM,WAAW,IAAI,QAAQ"}
+{"version":3,"file":"ActivityLogApi.cjs","names":["BaseCrudApi"],"sources":["../../../src/apis/activityLog/ActivityLogApi.ts"],"sourcesContent":["import type { ApiClient } from '../../core/ApiClient'\nimport { BaseCrudApi } from '../../core/BaseCrudApi'\nimport type {\n  ActivityLog,\n  ActivityLogListQuery,\n  CreateActivityLogPayload,\n  UpdateActivityLogPayload,\n} from './types'\n\n/**\n * Activity log of the account (stored in MongoDB: the routes answer 503 when it is unavailable).\n * The backend serves `GET /log`, `GET /log/export-csv`, `GET /log/:id` and `POST /log`; there is no update\n * or delete, so an entry created is permanent. `GET /log/:id` takes a MongoDB\n * id (an UUID answers 500).\n */\nexport class ActivityLogApi extends BaseCrudApi<\n  ActivityLog,\n  CreateActivityLogPayload,\n  UpdateActivityLogPayload,\n  ActivityLogListQuery\n> {\n  constructor(client: ApiClient) {\n    super(client, '/log')\n  }\n\n  /**\n   * Exports the entries of the period (`filters.from`/`filters.to`) as CSV, sent as the attachment\n   * `exportation.csv`.\n   */\n  exportCsv(query: ActivityLogListQuery, headers?: Record<string, string>): Promise<string> {\n    return this.client.get<string>(\n      `${this.basePath}/export-csv${this.toQueryString(query)}`,\n      headers,\n    )\n  }\n\n  /** @deprecated Not served: the backend has no PUT /log/:id, so this route answers 404. */\n  override updateById(\n    id: string,\n    body: UpdateActivityLogPayload,\n    headers?: Record<string, string>,\n  ): Promise<ActivityLog> {\n    return super.updateById(id, body, headers)\n  }\n\n  /** @deprecated Not served: the backend has no DELETE /log/:id, so this route answers 404. */\n  override deleteById(id: string, headers?: Record<string, string>): Promise<ActivityLog> {\n    return super.deleteById(id, headers)\n  }\n}\n"],"mappings":";;;;;;;;;;AAeA,IAAa,iBAAb,cAAoCA,qCAKlC;CACA,YAAY,QAAmB;AAC7B,QAAM,QAAQ,OAAO;;;;;;CAOvB,UAAU,OAA6B,SAAmD;AACxF,SAAO,KAAK,OAAO,IACjB,GAAG,KAAK,SAAS,aAAa,KAAK,cAAc,MAAM,IACvD,QACD;;;CAIH,AAAS,WACP,IACA,MACA,SACsB;AACtB,SAAO,MAAM,WAAW,IAAI,MAAM,QAAQ;;;CAI5C,AAAS,WAAW,IAAY,SAAwD;AACtF,SAAO,MAAM,WAAW,IAAI,QAAQ"}

package/dist/apis/activityLog/ActivityLogApi.d.ts

@@ -1,12 +1,19 @@
 import type { ApiClient } from '../../core/ApiClient';
 import { BaseCrudApi } from '../../core/BaseCrudApi';
-import type { ActivityLog, CreateActivityLogPayload, UpdateActivityLogPayload } from './types';
+import type { ActivityLog, ActivityLogListQuery, CreateActivityLogPayload, UpdateActivityLogPayload } from './types';
 /**
  * Activity log of the account (stored in MongoDB: the routes answer 503 when it is unavailable).
- * The backend serves `GET /log`, `GET /log/:id` and `POST /log`; there is no update or delete.
+ * The backend serves `GET /log`, `GET /log/export-csv`, `GET /log/:id` and `POST /log`; there is no update
+ * or delete, so an entry created is permanent. `GET /log/:id` takes a MongoDB
+ * id (an UUID answers 500).
  */
-export declare class ActivityLogApi extends BaseCrudApi<ActivityLog, CreateActivityLogPayload, UpdateActivityLogPayload> {
+export declare class ActivityLogApi extends BaseCrudApi<ActivityLog, CreateActivityLogPayload, UpdateActivityLogPayload, ActivityLogListQuery> {
     constructor(client: ApiClient);
+    /**
+     * Exports the entries of the period (`filters.from`/`filters.to`) as CSV, sent as the attachment
+     * `exportation.csv`.
+     */
+    exportCsv(query: ActivityLogListQuery, headers?: Record<string, string>): Promise<string>;
     /** @deprecated Not served: the backend has no PUT /log/:id, so this route answers 404. */
     updateById(id: string, body: UpdateActivityLogPayload, headers?: Record<string, string>): Promise<ActivityLog>;
     /** @deprecated Not served: the backend has no DELETE /log/:id, so this route answers 404. */

package/dist/apis/activityLog/ActivityLogApi.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ActivityLogApi.d.ts","sourceRoot":"","sources":["../../../src/apis/activityLog/ActivityLogApi.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAA;AACrD,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAA;AACpD,OAAO,KAAK,EAAE,WAAW,EAAE,wBAAwB,EAAE,wBAAwB,EAAE,MAAM,SAAS,CAAA;AAE9F;;;GAGG;AACH,qBAAa,cAAe,SAAQ,WAAW,CAC7C,WAAW,EACX,wBAAwB,EACxB,wBAAwB,CACzB;gBACa,MAAM,EAAE,SAAS;IAI7B,0FAA0F;IACjF,UAAU,CACjB,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,wBAAwB,EAC9B,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,WAAW,CAAC;IAIvB,6FAA6F;IACpF,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,WAAW,CAAC;CAGxF"}
+{"version":3,"file":"ActivityLogApi.d.ts","sourceRoot":"","sources":["../../../src/apis/activityLog/ActivityLogApi.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAA;AACrD,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAA;AACpD,OAAO,KAAK,EACV,WAAW,EACX,oBAAoB,EACpB,wBAAwB,EACxB,wBAAwB,EACzB,MAAM,SAAS,CAAA;AAEhB;;;;;GAKG;AACH,qBAAa,cAAe,SAAQ,WAAW,CAC7C,WAAW,EACX,wBAAwB,EACxB,wBAAwB,EACxB,oBAAoB,CACrB;gBACa,MAAM,EAAE,SAAS;IAI7B;;;OAGG;IACH,SAAS,CAAC,KAAK,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC;IAOzF,0FAA0F;IACjF,UAAU,CACjB,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,wBAAwB,EAC9B,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,WAAW,CAAC;IAIvB,6FAA6F;IACpF,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,WAAW,CAAC;CAGxF"}

package/dist/apis/activityLog/ActivityLogApi.mjs

@@ -3,12 +3,21 @@ import { BaseCrudApi } from "../../core/BaseCrudApi.mjs";
 //#region src/apis/activityLog/ActivityLogApi.ts
 /**
 * Activity log of the account (stored in MongoDB: the routes answer 503 when it is unavailable).
-* The backend serves `GET /log`, `GET /log/:id` and `POST /log`; there is no update or delete.
+* The backend serves `GET /log`, `GET /log/export-csv`, `GET /log/:id` and `POST /log`; there is no update
+* or delete, so an entry created is permanent. `GET /log/:id` takes a MongoDB
+* id (an UUID answers 500).
 */
 var ActivityLogApi = class extends BaseCrudApi {
 	constructor(client) {
 		super(client, "/log");
 	}
+	/**
+	* Exports the entries of the period (`filters.from`/`filters.to`) as CSV, sent as the attachment
+	* `exportation.csv`.
+	*/
+	exportCsv(query, headers) {
+		return this.client.get(`${this.basePath}/export-csv${this.toQueryString(query)}`, headers);
+	}
 	/** @deprecated Not served: the backend has no PUT /log/:id, so this route answers 404. */
 	updateById(id, body, headers) {
 		return super.updateById(id, body, headers);

package/dist/apis/activityLog/ActivityLogApi.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"ActivityLogApi.mjs","names":[],"sources":["../../../src/apis/activityLog/ActivityLogApi.ts"],"sourcesContent":["import type { ApiClient } from '../../core/ApiClient'\nimport { BaseCrudApi } from '../../core/BaseCrudApi'\nimport type { ActivityLog, CreateActivityLogPayload, UpdateActivityLogPayload } from './types'\n\n/**\n * Activity log of the account (stored in MongoDB: the routes answer 503 when it is unavailable).\n * The backend serves `GET /log`, `GET /log/:id` and `POST /log`; there is no update or delete.\n */\nexport class ActivityLogApi extends BaseCrudApi<\n  ActivityLog,\n  CreateActivityLogPayload,\n  UpdateActivityLogPayload\n> {\n  constructor(client: ApiClient) {\n    super(client, '/log')\n  }\n\n  /** @deprecated Not served: the backend has no PUT /log/:id, so this route answers 404. */\n  override updateById(\n    id: string,\n    body: UpdateActivityLogPayload,\n    headers?: Record<string, string>,\n  ): Promise<ActivityLog> {\n    return super.updateById(id, body, headers)\n  }\n\n  /** @deprecated Not served: the backend has no DELETE /log/:id, so this route answers 404. */\n  override deleteById(id: string, headers?: Record<string, string>): Promise<ActivityLog> {\n    return super.deleteById(id, headers)\n  }\n}\n"],"mappings":";;;;;;;AAQA,IAAa,iBAAb,cAAoC,YAIlC;CACA,YAAY,QAAmB;AAC7B,QAAM,QAAQ,OAAO;;;CAIvB,AAAS,WACP,IACA,MACA,SACsB;AACtB,SAAO,MAAM,WAAW,IAAI,MAAM,QAAQ;;;CAI5C,AAAS,WAAW,IAAY,SAAwD;AACtF,SAAO,MAAM,WAAW,IAAI,QAAQ"}
+{"version":3,"file":"ActivityLogApi.mjs","names":[],"sources":["../../../src/apis/activityLog/ActivityLogApi.ts"],"sourcesContent":["import type { ApiClient } from '../../core/ApiClient'\nimport { BaseCrudApi } from '../../core/BaseCrudApi'\nimport type {\n  ActivityLog,\n  ActivityLogListQuery,\n  CreateActivityLogPayload,\n  UpdateActivityLogPayload,\n} from './types'\n\n/**\n * Activity log of the account (stored in MongoDB: the routes answer 503 when it is unavailable).\n * The backend serves `GET /log`, `GET /log/export-csv`, `GET /log/:id` and `POST /log`; there is no update\n * or delete, so an entry created is permanent. `GET /log/:id` takes a MongoDB\n * id (an UUID answers 500).\n */\nexport class ActivityLogApi extends BaseCrudApi<\n  ActivityLog,\n  CreateActivityLogPayload,\n  UpdateActivityLogPayload,\n  ActivityLogListQuery\n> {\n  constructor(client: ApiClient) {\n    super(client, '/log')\n  }\n\n  /**\n   * Exports the entries of the period (`filters.from`/`filters.to`) as CSV, sent as the attachment\n   * `exportation.csv`.\n   */\n  exportCsv(query: ActivityLogListQuery, headers?: Record<string, string>): Promise<string> {\n    return this.client.get<string>(\n      `${this.basePath}/export-csv${this.toQueryString(query)}`,\n      headers,\n    )\n  }\n\n  /** @deprecated Not served: the backend has no PUT /log/:id, so this route answers 404. */\n  override updateById(\n    id: string,\n    body: UpdateActivityLogPayload,\n    headers?: Record<string, string>,\n  ): Promise<ActivityLog> {\n    return super.updateById(id, body, headers)\n  }\n\n  /** @deprecated Not served: the backend has no DELETE /log/:id, so this route answers 404. */\n  override deleteById(id: string, headers?: Record<string, string>): Promise<ActivityLog> {\n    return super.deleteById(id, headers)\n  }\n}\n"],"mappings":";;;;;;;;;AAeA,IAAa,iBAAb,cAAoC,YAKlC;CACA,YAAY,QAAmB;AAC7B,QAAM,QAAQ,OAAO;;;;;;CAOvB,UAAU,OAA6B,SAAmD;AACxF,SAAO,KAAK,OAAO,IACjB,GAAG,KAAK,SAAS,aAAa,KAAK,cAAc,MAAM,IACvD,QACD;;;CAIH,AAAS,WACP,IACA,MACA,SACsB;AACtB,SAAO,MAAM,WAAW,IAAI,MAAM,QAAQ;;;CAI5C,AAAS,WAAW,IAAY,SAAwD;AACtF,SAAO,MAAM,WAAW,IAAI,QAAQ"}

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

@@ -1,21 +1,61 @@
+import type { ListQuery } from '../../core/types';
+/**
+ * An entry of the activity log (MongoDB). The stored fields are `resourceType`, `resourceId`, `event`,
+ * `userId`, `accessTokenId` and `data`. `create` and `getById` answer through a transformer that keeps only
+ * `id`, `accountId`, `createdAt` and `updatedAt`; the list answers every stored field plus `user`.
+ */
 export type ActivityLog = {
     id: string;
     accountId: string;
-    userId: string | null;
-    action: string;
-    entity: string;
-    entityId: string | null;
-    data: Record<string, unknown>;
+    resourceType?: string;
+    resourceId?: string | null;
+    event?: string;
+    userId?: string | null;
+    accessTokenId?: string | null;
+    data?: Record<string, unknown>;
     createdAt: string;
     updatedAt: string;
+    /** On the list: the user of the entry. */
+    user?: {
+        id: string;
+        name: string;
+    };
+    /** @deprecated Not a field of the backend (it is dropped on create): use `event`. */
+    action?: string;
+    /** @deprecated Not a field of the backend (it is dropped on create): use `resourceType`. */
+    entity?: string;
+    /** @deprecated Not a field of the backend (it is dropped on create): use `resourceId`. */
+    entityId?: string | null;
 };
 export type CreateActivityLogPayload = {
-    action: string;
-    entity: string;
-    entityId?: string;
+    resourceType?: string;
+    resourceId?: string;
+    event?: string;
+    userId?: string;
+    accessTokenId?: string;
     data?: Record<string, unknown>;
+    /** @deprecated Dropped by the backend (not a field of the log): use `event`. */
+    action?: string;
+    /** @deprecated Dropped by the backend (not a field of the log): use `resourceType`. */
+    entity?: string;
+    /** @deprecated Dropped by the backend (not a field of the log): use `resourceId`. */
+    entityId?: string;
 };
 export type UpdateActivityLogPayload = {
     data?: Record<string, unknown>;
 };
+/**
+ * Query of the list and of the CSV export. The backend requires `filters.from` and `filters.to` (the
+ * period of `createdAt`); the other `filters` match the stored fields.
+ */
+export type ActivityLogListQuery = ListQuery<ActivityLog> & {
+    filters?: {
+        from?: string;
+        to?: string;
+        resourceType?: string;
+        resourceId?: string;
+        event?: string;
+        userId?: string;
+    };
+};
 //# sourceMappingURL=types.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/apis/activityLog/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,WAAW,GAAG;IACxB,EAAE,EAAE,MAAM,CAAA;IACV,SAAS,EAAE,MAAM,CAAA;IACjB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAA;IACrB,MAAM,EAAE,MAAM,CAAA;IACd,MAAM,EAAE,MAAM,CAAA;IACd,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAC7B,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;CAClB,CAAA;AAED,MAAM,MAAM,wBAAwB,GAAG;IACrC,MAAM,EAAE,MAAM,CAAA;IACd,MAAM,EAAE,MAAM,CAAA;IACd,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAC/B,CAAA;AAED,MAAM,MAAM,wBAAwB,GAAG;IACrC,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAC/B,CAAA"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/apis/activityLog/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAA;AAEjD;;;;GAIG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB,EAAE,EAAE,MAAM,CAAA;IACV,SAAS,EAAE,MAAM,CAAA;IACjB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC1B,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACtB,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC7B,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAC9B,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,0CAA0C;IAC1C,IAAI,CAAC,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,CAAA;IACnC,qFAAqF;IACrF,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,4FAA4F;IAC5F,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,0FAA0F;IAC1F,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CACzB,CAAA;AAED,MAAM,MAAM,wBAAwB,GAAG;IACrC,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAC9B,gFAAgF;IAChF,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,uFAAuF;IACvF,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,qFAAqF;IACrF,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB,CAAA;AAED,MAAM,MAAM,wBAAwB,GAAG;IACrC,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAC/B,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,oBAAoB,GAAG,SAAS,CAAC,WAAW,CAAC,GAAG;IAC1D,OAAO,CAAC,EAAE;QACR,IAAI,CAAC,EAAE,MAAM,CAAA;QACb,EAAE,CAAC,EAAE,MAAM,CAAA;QACX,YAAY,CAAC,EAAE,MAAM,CAAA;QACrB,UAAU,CAAC,EAAE,MAAM,CAAA;QACnB,KAAK,CAAC,EAAE,MAAM,CAAA;QACd,MAAM,CAAC,EAAE,MAAM,CAAA;KAChB,CAAA;CACF,CAAA"}

package/dist/apis/creditMovements/CreditMovementsApi.cjs

@@ -4,8 +4,8 @@ const require_core_BaseCrudApi = require('../../core/BaseCrudApi.cjs');
 //#region src/apis/creditMovements/CreditMovementsApi.ts
 /**
 * Credit movements of the account (SMS and AI credits), only for reading: the writes are super
-* admin routes (`/admin/credit-movements`). The backend serves only `GET /credit-movements` and
-* `GET /credit-movements/:id`.
+* admin routes (`/admin/credit-movements`). Besides the list and the read by id, the backend serves the
+* balances, the totals per connection and the xlsx export.
 */
 var CreditMovementsApi = class extends require_core_BaseCrudApi.BaseCrudApi {
 	constructor(client) {
@@ -23,6 +23,35 @@ var CreditMovementsApi = class extends require_core_BaseCrudApi.BaseCrudApi {
 	deleteById(id, headers) {
 		return super.deleteById(id, headers);
 	}
+	/** The balance of each service type of the account. */
+	balances(headers) {
+		return this.client.get(`${this.basePath}/balances`, headers);
+	}
+	/**
+	* The balance of one service type (a read, despite the POST). Without `serviceType` the route answers 500.
+	*/
+	balance(serviceType, headers) {
+		return this.client.post(`${this.basePath}/balance`, { serviceType }, headers);
+	}
+	/** The balances of the period by service type and connection (`ins` without the trial credits). */
+	balancesV2(query, headers) {
+		return this.client.get(`${this.basePath}/v2/balances${this.toQueryString(query)}`, headers);
+	}
+	/**
+	* The total of credits of each connection in the period (five per page). Resolves `undefined` (no body)
+	* when `filters.from`, `filters.to`, `filters.serviceType` or `page` is missing.
+	*/
+	totalServices(query, headers) {
+		return this.client.get(`${this.basePath}/total-services${this.toQueryString(query)}`, headers);
+	}
+	/**
+	* Exports the movements of the period as an xlsx workbook (binary). Needs a client with `requestRaw`.
+	* Without `where.$and` the route answers 500.
+	*/
+	async exportXlsx(query, headers) {
+		if (!this.client.requestRaw) throw new Error("exportXlsx needs a client with requestRaw (the answer is a binary xlsx)");
+		return (await this.client.requestRaw("GET", `${this.basePath}/export${this.toQueryString(query)}`, void 0, headers)).arrayBuffer();
+	}
 };
 
 //#endregion

package/dist/apis/creditMovements/CreditMovementsApi.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"CreditMovementsApi.cjs","names":["BaseCrudApi"],"sources":["../../../src/apis/creditMovements/CreditMovementsApi.ts"],"sourcesContent":["import type { ApiClient } from '../../core/ApiClient'\nimport { BaseCrudApi } from '../../core/BaseCrudApi'\nimport type {\n  CreditMovement,\n  CreateCreditMovementPayload,\n  UpdateCreditMovementPayload,\n} from './types'\n\n/**\n * Credit movements of the account (SMS and AI credits), only for reading: the writes are super\n * admin routes (`/admin/credit-movements`). The backend serves only `GET /credit-movements` and\n * `GET /credit-movements/:id`.\n */\nexport class CreditMovementsApi extends BaseCrudApi<\n  CreditMovement,\n  CreateCreditMovementPayload,\n  UpdateCreditMovementPayload\n> {\n  constructor(client: ApiClient) {\n    super(client, '/credit-movements')\n  }\n\n  /** @deprecated Not served: the backend has no POST /credit-movements, so this route answers 404. */\n  override create(\n    body: CreateCreditMovementPayload,\n    headers?: Record<string, string>,\n  ): Promise<CreditMovement> {\n    return super.create(body, headers)\n  }\n\n  /** @deprecated Not served: the backend has no PUT /credit-movements/:id, so this route answers 404. */\n  override updateById(\n    id: string,\n    body: UpdateCreditMovementPayload,\n    headers?: Record<string, string>,\n  ): Promise<CreditMovement> {\n    return super.updateById(id, body, headers)\n  }\n\n  /** @deprecated Not served: the backend has no DELETE /credit-movements/:id, so this route answers 404. */\n  override deleteById(id: string, headers?: Record<string, string>): Promise<CreditMovement> {\n    return super.deleteById(id, headers)\n  }\n}\n"],"mappings":";;;;;;;;;AAaA,IAAa,qBAAb,cAAwCA,qCAItC;CACA,YAAY,QAAmB;AAC7B,QAAM,QAAQ,oBAAoB;;;CAIpC,AAAS,OACP,MACA,SACyB;AACzB,SAAO,MAAM,OAAO,MAAM,QAAQ;;;CAIpC,AAAS,WACP,IACA,MACA,SACyB;AACzB,SAAO,MAAM,WAAW,IAAI,MAAM,QAAQ;;;CAI5C,AAAS,WAAW,IAAY,SAA2D;AACzF,SAAO,MAAM,WAAW,IAAI,QAAQ"}
+{"version":3,"file":"CreditMovementsApi.cjs","names":["BaseCrudApi"],"sources":["../../../src/apis/creditMovements/CreditMovementsApi.ts"],"sourcesContent":["import type { ApiClient } from '../../core/ApiClient'\nimport { BaseCrudApi } from '../../core/BaseCrudApi'\nimport type {\n  CreditMovement,\n  CreateCreditMovementPayload,\n  UpdateCreditMovementPayload,\n  CreditBalances,\n  CreditBalanceV2,\n  CreditBalancesV2Query,\n  CreditMovementServiceType,\n  CreditMovementsExportQuery,\n  CreditTotalServices,\n  CreditTotalServicesQuery,\n} from './types'\n\n/**\n * Credit movements of the account (SMS and AI credits), only for reading: the writes are super\n * admin routes (`/admin/credit-movements`). Besides the list and the read by id, the backend serves the\n * balances, the totals per connection and the xlsx export.\n */\nexport class CreditMovementsApi extends BaseCrudApi<\n  CreditMovement,\n  CreateCreditMovementPayload,\n  UpdateCreditMovementPayload\n> {\n  constructor(client: ApiClient) {\n    super(client, '/credit-movements')\n  }\n\n  /** @deprecated Not served: the backend has no POST /credit-movements, so this route answers 404. */\n  override create(\n    body: CreateCreditMovementPayload,\n    headers?: Record<string, string>,\n  ): Promise<CreditMovement> {\n    return super.create(body, headers)\n  }\n\n  /** @deprecated Not served: the backend has no PUT /credit-movements/:id, so this route answers 404. */\n  override updateById(\n    id: string,\n    body: UpdateCreditMovementPayload,\n    headers?: Record<string, string>,\n  ): Promise<CreditMovement> {\n    return super.updateById(id, body, headers)\n  }\n\n  /** @deprecated Not served: the backend has no DELETE /credit-movements/:id, so this route answers 404. */\n  override deleteById(id: string, headers?: Record<string, string>): Promise<CreditMovement> {\n    return super.deleteById(id, headers)\n  }\n\n  /** The balance of each service type of the account. */\n  balances(headers?: Record<string, string>): Promise<CreditBalances> {\n    return this.client.get<CreditBalances>(`${this.basePath}/balances`, headers)\n  }\n\n  /**\n   * The balance of one service type (a read, despite the POST). Without `serviceType` the route answers 500.\n   */\n  balance(\n    serviceType: CreditMovementServiceType,\n    headers?: Record<string, string>,\n  ): Promise<number> {\n    return this.client.post<number, { serviceType: CreditMovementServiceType }>(\n      `${this.basePath}/balance`,\n      { serviceType },\n      headers,\n    )\n  }\n\n  /** The balances of the period by service type and connection (`ins` without the trial credits). */\n  balancesV2(\n    query?: CreditBalancesV2Query,\n    headers?: Record<string, string>,\n  ): Promise<Record<CreditMovementServiceType, CreditBalanceV2>> {\n    return this.client.get<Record<CreditMovementServiceType, CreditBalanceV2>>(\n      `${this.basePath}/v2/balances${this.toQueryString(query)}`,\n      headers,\n    )\n  }\n\n  /**\n   * The total of credits of each connection in the period (five per page). Resolves `undefined` (no body)\n   * when `filters.from`, `filters.to`, `filters.serviceType` or `page` is missing.\n   */\n  totalServices(\n    query: CreditTotalServicesQuery,\n    headers?: Record<string, string>,\n  ): Promise<CreditTotalServices | undefined> {\n    return this.client.get<CreditTotalServices | undefined>(\n      `${this.basePath}/total-services${this.toQueryString(query)}`,\n      headers,\n    )\n  }\n\n  /**\n   * Exports the movements of the period as an xlsx workbook (binary). Needs a client with `requestRaw`.\n   * Without `where.$and` the route answers 500.\n   */\n  async exportXlsx(\n    query: CreditMovementsExportQuery,\n    headers?: Record<string, string>,\n  ): Promise<ArrayBuffer> {\n    if (!this.client.requestRaw) {\n      throw new Error('exportXlsx needs a client with requestRaw (the answer is a binary xlsx)')\n    }\n    const response = await this.client.requestRaw(\n      'GET',\n      `${this.basePath}/export${this.toQueryString(query)}`,\n      undefined,\n      headers,\n    )\n    return response.arrayBuffer()\n  }\n}\n"],"mappings":";;;;;;;;;AAoBA,IAAa,qBAAb,cAAwCA,qCAItC;CACA,YAAY,QAAmB;AAC7B,QAAM,QAAQ,oBAAoB;;;CAIpC,AAAS,OACP,MACA,SACyB;AACzB,SAAO,MAAM,OAAO,MAAM,QAAQ;;;CAIpC,AAAS,WACP,IACA,MACA,SACyB;AACzB,SAAO,MAAM,WAAW,IAAI,MAAM,QAAQ;;;CAI5C,AAAS,WAAW,IAAY,SAA2D;AACzF,SAAO,MAAM,WAAW,IAAI,QAAQ;;;CAItC,SAAS,SAA2D;AAClE,SAAO,KAAK,OAAO,IAAoB,GAAG,KAAK,SAAS,YAAY,QAAQ;;;;;CAM9E,QACE,aACA,SACiB;AACjB,SAAO,KAAK,OAAO,KACjB,GAAG,KAAK,SAAS,WACjB,EAAE,aAAa,EACf,QACD;;;CAIH,WACE,OACA,SAC6D;AAC7D,SAAO,KAAK,OAAO,IACjB,GAAG,KAAK,SAAS,cAAc,KAAK,cAAc,MAAM,IACxD,QACD;;;;;;CAOH,cACE,OACA,SAC0C;AAC1C,SAAO,KAAK,OAAO,IACjB,GAAG,KAAK,SAAS,iBAAiB,KAAK,cAAc,MAAM,IAC3D,QACD;;;;;;CAOH,MAAM,WACJ,OACA,SACsB;AACtB,MAAI,CAAC,KAAK,OAAO,WACf,OAAM,IAAI,MAAM,0EAA0E;AAQ5F,UANiB,MAAM,KAAK,OAAO,WACjC,OACA,GAAG,KAAK,SAAS,SAAS,KAAK,cAAc,MAAM,IACnD,QACA,QACD,EACe,aAAa"}

package/dist/apis/creditMovements/CreditMovementsApi.d.ts

@@ -1,10 +1,10 @@
 import type { ApiClient } from '../../core/ApiClient';
 import { BaseCrudApi } from '../../core/BaseCrudApi';
-import type { CreditMovement, CreateCreditMovementPayload, UpdateCreditMovementPayload } from './types';
+import type { CreditMovement, CreateCreditMovementPayload, UpdateCreditMovementPayload, CreditBalances, CreditBalanceV2, CreditBalancesV2Query, CreditMovementServiceType, CreditMovementsExportQuery, CreditTotalServices, CreditTotalServicesQuery } from './types';
 /**
  * Credit movements of the account (SMS and AI credits), only for reading: the writes are super
- * admin routes (`/admin/credit-movements`). The backend serves only `GET /credit-movements` and
- * `GET /credit-movements/:id`.
+ * admin routes (`/admin/credit-movements`). Besides the list and the read by id, the backend serves the
+ * balances, the totals per connection and the xlsx export.
  */
 export declare class CreditMovementsApi extends BaseCrudApi<CreditMovement, CreateCreditMovementPayload, UpdateCreditMovementPayload> {
     constructor(client: ApiClient);
@@ -14,5 +14,23 @@ export declare class CreditMovementsApi extends BaseCrudApi<CreditMovement, Crea
     updateById(id: string, body: UpdateCreditMovementPayload, headers?: Record<string, string>): Promise<CreditMovement>;
     /** @deprecated Not served: the backend has no DELETE /credit-movements/:id, so this route answers 404. */
     deleteById(id: string, headers?: Record<string, string>): Promise<CreditMovement>;
+    /** The balance of each service type of the account. */
+    balances(headers?: Record<string, string>): Promise<CreditBalances>;
+    /**
+     * The balance of one service type (a read, despite the POST). Without `serviceType` the route answers 500.
+     */
+    balance(serviceType: CreditMovementServiceType, headers?: Record<string, string>): Promise<number>;
+    /** The balances of the period by service type and connection (`ins` without the trial credits). */
+    balancesV2(query?: CreditBalancesV2Query, headers?: Record<string, string>): Promise<Record<CreditMovementServiceType, CreditBalanceV2>>;
+    /**
+     * The total of credits of each connection in the period (five per page). Resolves `undefined` (no body)
+     * when `filters.from`, `filters.to`, `filters.serviceType` or `page` is missing.
+     */
+    totalServices(query: CreditTotalServicesQuery, headers?: Record<string, string>): Promise<CreditTotalServices | undefined>;
+    /**
+     * Exports the movements of the period as an xlsx workbook (binary). Needs a client with `requestRaw`.
+     * Without `where.$and` the route answers 500.
+     */
+    exportXlsx(query: CreditMovementsExportQuery, headers?: Record<string, string>): Promise<ArrayBuffer>;
 }
 //# sourceMappingURL=CreditMovementsApi.d.ts.map

package/dist/apis/creditMovements/CreditMovementsApi.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"CreditMovementsApi.d.ts","sourceRoot":"","sources":["../../../src/apis/creditMovements/CreditMovementsApi.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAA;AACrD,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAA;AACpD,OAAO,KAAK,EACV,cAAc,EACd,2BAA2B,EAC3B,2BAA2B,EAC5B,MAAM,SAAS,CAAA;AAEhB;;;;GAIG;AACH,qBAAa,kBAAmB,SAAQ,WAAW,CACjD,cAAc,EACd,2BAA2B,EAC3B,2BAA2B,CAC5B;gBACa,MAAM,EAAE,SAAS;IAI7B,oGAAoG;IAC3F,MAAM,CACb,IAAI,EAAE,2BAA2B,EACjC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,cAAc,CAAC;IAI1B,uGAAuG;IAC9F,UAAU,CACjB,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,2BAA2B,EACjC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,cAAc,CAAC;IAI1B,0GAA0G;IACjG,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,cAAc,CAAC;CAG3F"}
+{"version":3,"file":"CreditMovementsApi.d.ts","sourceRoot":"","sources":["../../../src/apis/creditMovements/CreditMovementsApi.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAA;AACrD,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAA;AACpD,OAAO,KAAK,EACV,cAAc,EACd,2BAA2B,EAC3B,2BAA2B,EAC3B,cAAc,EACd,eAAe,EACf,qBAAqB,EACrB,yBAAyB,EACzB,0BAA0B,EAC1B,mBAAmB,EACnB,wBAAwB,EACzB,MAAM,SAAS,CAAA;AAEhB;;;;GAIG;AACH,qBAAa,kBAAmB,SAAQ,WAAW,CACjD,cAAc,EACd,2BAA2B,EAC3B,2BAA2B,CAC5B;gBACa,MAAM,EAAE,SAAS;IAI7B,oGAAoG;IAC3F,MAAM,CACb,IAAI,EAAE,2BAA2B,EACjC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,cAAc,CAAC;IAI1B,uGAAuG;IAC9F,UAAU,CACjB,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,2BAA2B,EACjC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,cAAc,CAAC;IAI1B,0GAA0G;IACjG,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,cAAc,CAAC;IAI1F,uDAAuD;IACvD,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,cAAc,CAAC;IAInE;;OAEG;IACH,OAAO,CACL,WAAW,EAAE,yBAAyB,EACtC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,MAAM,CAAC;IAQlB,mGAAmG;IACnG,UAAU,CACR,KAAK,CAAC,EAAE,qBAAqB,EAC7B,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,MAAM,CAAC,yBAAyB,EAAE,eAAe,CAAC,CAAC;IAO9D;;;OAGG;IACH,aAAa,CACX,KAAK,EAAE,wBAAwB,EAC/B,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,mBAAmB,GAAG,SAAS,CAAC;IAO3C;;;OAGG;IACG,UAAU,CACd,KAAK,EAAE,0BAA0B,EACjC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,WAAW,CAAC;CAYxB"}