@ikatec/digisac-api-sdk 4.1.0 → 4.2.0

package/dist/apis/now/NowApi.cjs

@@ -0,0 +1,37 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
+const require_core_BaseApi = require('../../core/BaseApi.cjs');
+
+//#region src/apis/now/NowApi.ts
+/**
+* The "Agora" (now) overview: live totals of tickets and attendants. Every route requires
+* `overview.now.view.all` or `overview.now.view.departments` (the latter is scoped to the user's
+* departments).
+*/
+var NowApi = class extends require_core_BaseApi.BaseApi {
+	basePath = "/now";
+	/**
+	* Account totals: open/queued tickets, attendants with/without attendance and online/offline/absent users.
+	* @permissions overview.now.view.all | overview.now.view.departments
+	*/
+	getResume(query, headers) {
+		return this.client.get(`${this.basePath}/resume${this.toQueryString(query)}`, headers);
+	}
+	/**
+	* Per-attendant totals (name, departments, status and open tickets).
+	* @permissions overview.now.view.all | overview.now.view.departments
+	*/
+	getAttendanceResume(query, headers) {
+		return this.client.get(`${this.basePath}/attendance-resume${this.toQueryString(query)}`, headers);
+	}
+	/**
+	* Per-department totals (online/offline/absent users, queued and open tickets).
+	* @permissions overview.now.view.all | overview.now.view.departments
+	*/
+	getDepartmentsResume(query, headers) {
+		return this.client.get(`${this.basePath}/departments-resume${this.toQueryString(query)}`, headers);
+	}
+};
+
+//#endregion
+exports.NowApi = NowApi;
+//# sourceMappingURL=NowApi.cjs.map

package/dist/apis/now/NowApi.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"NowApi.cjs","names":["BaseApi"],"sources":["../../../src/apis/now/NowApi.ts"],"sourcesContent":["import { BaseApi } from '../../core/BaseApi'\nimport type {\n  NowAttendanceResume,\n  NowDepartmentResume,\n  NowQuery,\n  NowResponse,\n  NowResumeTotals,\n} from './types'\n\n/**\n * The \"Agora\" (now) overview: live totals of tickets and attendants. Every route requires\n * `overview.now.view.all` or `overview.now.view.departments` (the latter is scoped to the user's\n * departments).\n */\nexport class NowApi extends BaseApi {\n  public readonly basePath = '/now'\n\n  /**\n   * Account totals: open/queued tickets, attendants with/without attendance and online/offline/absent users.\n   * @permissions overview.now.view.all | overview.now.view.departments\n   */\n  getResume(\n    query?: NowQuery,\n    headers?: Record<string, string>,\n  ): Promise<NowResponse<NowResumeTotals>> {\n    return this.client.get<NowResponse<NowResumeTotals>>(\n      `${this.basePath}/resume${this.toQueryString(query)}`,\n      headers,\n    )\n  }\n\n  /**\n   * Per-attendant totals (name, departments, status and open tickets).\n   * @permissions overview.now.view.all | overview.now.view.departments\n   */\n  getAttendanceResume(\n    query?: NowQuery,\n    headers?: Record<string, string>,\n  ): Promise<NowResponse<NowAttendanceResume[]>> {\n    return this.client.get<NowResponse<NowAttendanceResume[]>>(\n      `${this.basePath}/attendance-resume${this.toQueryString(query)}`,\n      headers,\n    )\n  }\n\n  /**\n   * Per-department totals (online/offline/absent users, queued and open tickets).\n   * @permissions overview.now.view.all | overview.now.view.departments\n   */\n  getDepartmentsResume(\n    query?: NowQuery,\n    headers?: Record<string, string>,\n  ): Promise<NowResponse<NowDepartmentResume[]>> {\n    return this.client.get<NowResponse<NowDepartmentResume[]>>(\n      `${this.basePath}/departments-resume${this.toQueryString(query)}`,\n      headers,\n    )\n  }\n}\n"],"mappings":";;;;;;;;;AAcA,IAAa,SAAb,cAA4BA,6BAAQ;CAClC,AAAgB,WAAW;;;;;CAM3B,UACE,OACA,SACuC;AACvC,SAAO,KAAK,OAAO,IACjB,GAAG,KAAK,SAAS,SAAS,KAAK,cAAc,MAAM,IACnD,QACD;;;;;;CAOH,oBACE,OACA,SAC6C;AAC7C,SAAO,KAAK,OAAO,IACjB,GAAG,KAAK,SAAS,oBAAoB,KAAK,cAAc,MAAM,IAC9D,QACD;;;;;;CAOH,qBACE,OACA,SAC6C;AAC7C,SAAO,KAAK,OAAO,IACjB,GAAG,KAAK,SAAS,qBAAqB,KAAK,cAAc,MAAM,IAC/D,QACD"}

package/dist/apis/now/NowApi.d.ts

@@ -0,0 +1,26 @@
+import { BaseApi } from '../../core/BaseApi';
+import type { NowAttendanceResume, NowDepartmentResume, NowQuery, NowResponse, NowResumeTotals } from './types';
+/**
+ * The "Agora" (now) overview: live totals of tickets and attendants. Every route requires
+ * `overview.now.view.all` or `overview.now.view.departments` (the latter is scoped to the user's
+ * departments).
+ */
+export declare class NowApi extends BaseApi {
+    readonly basePath = "/now";
+    /**
+     * Account totals: open/queued tickets, attendants with/without attendance and online/offline/absent users.
+     * @permissions overview.now.view.all | overview.now.view.departments
+     */
+    getResume(query?: NowQuery, headers?: Record<string, string>): Promise<NowResponse<NowResumeTotals>>;
+    /**
+     * Per-attendant totals (name, departments, status and open tickets).
+     * @permissions overview.now.view.all | overview.now.view.departments
+     */
+    getAttendanceResume(query?: NowQuery, headers?: Record<string, string>): Promise<NowResponse<NowAttendanceResume[]>>;
+    /**
+     * Per-department totals (online/offline/absent users, queued and open tickets).
+     * @permissions overview.now.view.all | overview.now.view.departments
+     */
+    getDepartmentsResume(query?: NowQuery, headers?: Record<string, string>): Promise<NowResponse<NowDepartmentResume[]>>;
+}
+//# sourceMappingURL=NowApi.d.ts.map

package/dist/apis/now/NowApi.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"NowApi.d.ts","sourceRoot":"","sources":["../../../src/apis/now/NowApi.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAA;AAC5C,OAAO,KAAK,EACV,mBAAmB,EACnB,mBAAmB,EACnB,QAAQ,EACR,WAAW,EACX,eAAe,EAChB,MAAM,SAAS,CAAA;AAEhB;;;;GAIG;AACH,qBAAa,MAAO,SAAQ,OAAO;IACjC,SAAgB,QAAQ,UAAS;IAEjC;;;OAGG;IACH,SAAS,CACP,KAAK,CAAC,EAAE,QAAQ,EAChB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,WAAW,CAAC,eAAe,CAAC,CAAC;IAOxC;;;OAGG;IACH,mBAAmB,CACjB,KAAK,CAAC,EAAE,QAAQ,EAChB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,WAAW,CAAC,mBAAmB,EAAE,CAAC,CAAC;IAO9C;;;OAGG;IACH,oBAAoB,CAClB,KAAK,CAAC,EAAE,QAAQ,EAChB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,WAAW,CAAC,mBAAmB,EAAE,CAAC,CAAC;CAM/C"}

package/dist/apis/now/NowApi.mjs

@@ -0,0 +1,36 @@
+import { BaseApi } from "../../core/BaseApi.mjs";
+
+//#region src/apis/now/NowApi.ts
+/**
+* The "Agora" (now) overview: live totals of tickets and attendants. Every route requires
+* `overview.now.view.all` or `overview.now.view.departments` (the latter is scoped to the user's
+* departments).
+*/
+var NowApi = class extends BaseApi {
+	basePath = "/now";
+	/**
+	* Account totals: open/queued tickets, attendants with/without attendance and online/offline/absent users.
+	* @permissions overview.now.view.all | overview.now.view.departments
+	*/
+	getResume(query, headers) {
+		return this.client.get(`${this.basePath}/resume${this.toQueryString(query)}`, headers);
+	}
+	/**
+	* Per-attendant totals (name, departments, status and open tickets).
+	* @permissions overview.now.view.all | overview.now.view.departments
+	*/
+	getAttendanceResume(query, headers) {
+		return this.client.get(`${this.basePath}/attendance-resume${this.toQueryString(query)}`, headers);
+	}
+	/**
+	* Per-department totals (online/offline/absent users, queued and open tickets).
+	* @permissions overview.now.view.all | overview.now.view.departments
+	*/
+	getDepartmentsResume(query, headers) {
+		return this.client.get(`${this.basePath}/departments-resume${this.toQueryString(query)}`, headers);
+	}
+};
+
+//#endregion
+export { NowApi };
+//# sourceMappingURL=NowApi.mjs.map

package/dist/apis/now/NowApi.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"NowApi.mjs","names":[],"sources":["../../../src/apis/now/NowApi.ts"],"sourcesContent":["import { BaseApi } from '../../core/BaseApi'\nimport type {\n  NowAttendanceResume,\n  NowDepartmentResume,\n  NowQuery,\n  NowResponse,\n  NowResumeTotals,\n} from './types'\n\n/**\n * The \"Agora\" (now) overview: live totals of tickets and attendants. Every route requires\n * `overview.now.view.all` or `overview.now.view.departments` (the latter is scoped to the user's\n * departments).\n */\nexport class NowApi extends BaseApi {\n  public readonly basePath = '/now'\n\n  /**\n   * Account totals: open/queued tickets, attendants with/without attendance and online/offline/absent users.\n   * @permissions overview.now.view.all | overview.now.view.departments\n   */\n  getResume(\n    query?: NowQuery,\n    headers?: Record<string, string>,\n  ): Promise<NowResponse<NowResumeTotals>> {\n    return this.client.get<NowResponse<NowResumeTotals>>(\n      `${this.basePath}/resume${this.toQueryString(query)}`,\n      headers,\n    )\n  }\n\n  /**\n   * Per-attendant totals (name, departments, status and open tickets).\n   * @permissions overview.now.view.all | overview.now.view.departments\n   */\n  getAttendanceResume(\n    query?: NowQuery,\n    headers?: Record<string, string>,\n  ): Promise<NowResponse<NowAttendanceResume[]>> {\n    return this.client.get<NowResponse<NowAttendanceResume[]>>(\n      `${this.basePath}/attendance-resume${this.toQueryString(query)}`,\n      headers,\n    )\n  }\n\n  /**\n   * Per-department totals (online/offline/absent users, queued and open tickets).\n   * @permissions overview.now.view.all | overview.now.view.departments\n   */\n  getDepartmentsResume(\n    query?: NowQuery,\n    headers?: Record<string, string>,\n  ): Promise<NowResponse<NowDepartmentResume[]>> {\n    return this.client.get<NowResponse<NowDepartmentResume[]>>(\n      `${this.basePath}/departments-resume${this.toQueryString(query)}`,\n      headers,\n    )\n  }\n}\n"],"mappings":";;;;;;;;AAcA,IAAa,SAAb,cAA4B,QAAQ;CAClC,AAAgB,WAAW;;;;;CAM3B,UACE,OACA,SACuC;AACvC,SAAO,KAAK,OAAO,IACjB,GAAG,KAAK,SAAS,SAAS,KAAK,cAAc,MAAM,IACnD,QACD;;;;;;CAOH,oBACE,OACA,SAC6C;AAC7C,SAAO,KAAK,OAAO,IACjB,GAAG,KAAK,SAAS,oBAAoB,KAAK,cAAc,MAAM,IAC9D,QACD;;;;;;CAOH,qBACE,OACA,SAC6C;AAC7C,SAAO,KAAK,OAAO,IACjB,GAAG,KAAK,SAAS,qBAAqB,KAAK,cAAc,MAAM,IAC/D,QACD"}

package/dist/apis/now/index.cjs

@@ -0,0 +1,4 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
+const require_apis_now_NowApi = require('./NowApi.cjs');
+
+exports.NowApi = require_apis_now_NowApi.NowApi;

package/dist/apis/now/index.d.ts

@@ -0,0 +1,3 @@
+export { NowApi } from './NowApi';
+export type * from './types';
+//# sourceMappingURL=index.d.ts.map

package/dist/apis/now/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/apis/now/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAA;AACjC,mBAAmB,SAAS,CAAA"}

package/dist/apis/now/index.mjs

@@ -0,0 +1,3 @@
+import { NowApi } from "./NowApi.mjs";
+
+export { NowApi };

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

@@ -0,0 +1,45 @@
+import type { User } from '../users/types';
+/**
+ * Filters of the "Agora" (now) overview. Each accepts one id, an array or a comma-separated list.
+ * A user with only `overview.now.view.departments` gets 403 for departments/users outside their
+ * departments.
+ */
+export type NowQuery = {
+    departmentId?: string | string[];
+    userId?: string | string[];
+};
+/** Every `/now` route answers its data under `totals`. */
+export type NowResponse<T> = {
+    totals: T;
+};
+export type NowResumeTotals = {
+    openTickets: number;
+    queueTickets: number;
+    usersWithAttendance: number;
+    usersWithoutAttendance: number;
+    /** Postgres `avg()` — a numeric string, or `0` when there is no data. */
+    averageOpenTicketsTime: number | string;
+    /** Postgres `avg()` — a numeric string, or `0` when there is no data. */
+    averageOpenTicketsWaitTime: number | string;
+    onlineUsersCount: number;
+    offlineUsersCount: number;
+    absentUsersCount: number;
+};
+/** One entry per department. */
+export type NowDepartmentResume = {
+    name: string;
+    onlineUserCount: number;
+    offlineUserCount: number;
+    absentUserCount: number;
+    onQueueTicketCount: number;
+    openTicketCount: number;
+};
+/** One entry per attendant (user). */
+export type NowAttendanceResume = {
+    name?: string;
+    /** Department names — `0` when the attendant has no department. */
+    departments: string[] | 0;
+    status?: User['status'];
+    ticketsOpenCount: number;
+};
+//# sourceMappingURL=types.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/apis/now/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,gBAAgB,CAAA;AAE1C;;;;GAIG;AACH,MAAM,MAAM,QAAQ,GAAG;IACrB,YAAY,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAChC,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;CAC3B,CAAA;AAED,0DAA0D;AAC1D,MAAM,MAAM,WAAW,CAAC,CAAC,IAAI;IAAE,MAAM,EAAE,CAAC,CAAA;CAAE,CAAA;AAE1C,MAAM,MAAM,eAAe,GAAG;IAC5B,WAAW,EAAE,MAAM,CAAA;IACnB,YAAY,EAAE,MAAM,CAAA;IACpB,mBAAmB,EAAE,MAAM,CAAA;IAC3B,sBAAsB,EAAE,MAAM,CAAA;IAC9B,yEAAyE;IACzE,sBAAsB,EAAE,MAAM,GAAG,MAAM,CAAA;IACvC,yEAAyE;IACzE,0BAA0B,EAAE,MAAM,GAAG,MAAM,CAAA;IAC3C,gBAAgB,EAAE,MAAM,CAAA;IACxB,iBAAiB,EAAE,MAAM,CAAA;IACzB,gBAAgB,EAAE,MAAM,CAAA;CACzB,CAAA;AAED,gCAAgC;AAChC,MAAM,MAAM,mBAAmB,GAAG;IAChC,IAAI,EAAE,MAAM,CAAA;IACZ,eAAe,EAAE,MAAM,CAAA;IACvB,gBAAgB,EAAE,MAAM,CAAA;IACxB,eAAe,EAAE,MAAM,CAAA;IACvB,kBAAkB,EAAE,MAAM,CAAA;IAC1B,eAAe,EAAE,MAAM,CAAA;CACxB,CAAA;AAED,sCAAsC;AACtC,MAAM,MAAM,mBAAmB,GAAG;IAChC,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,mEAAmE;IACnE,WAAW,EAAE,MAAM,EAAE,GAAG,CAAC,CAAA;IACzB,MAAM,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAA;IACvB,gBAAgB,EAAE,MAAM,CAAA;CACzB,CAAA"}

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

@@ -13,10 +13,15 @@ export type Person = {
 export type PersonRelationships = 'organizations' | 'contacts';
 export type CreatePersonPayload = {
     name: string;
-    document?: string;
+    document?: string | null;
+    /** Organizations of the account to link the person to (400 if any belongs to another account). */
+    organizationIds?: string[];
 };
 export type UpdatePersonPayload = {
-    name?: string;
+    /** Required by the backend on every update (400 `required` otherwise). */
+    name: string;
     document?: string | null;
+    /** Replaces the linked organizations: `[]` unlinks all, omitting it keeps them. */
+    organizationIds?: string[];
 };
 //# sourceMappingURL=types.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/apis/people/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAChD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAA;AAE1D,MAAM,MAAM,MAAM,GAAG;IACnB,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;IACnB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IAEjB,aAAa,CAAC,EAAE,YAAY,EAAE,CAAA;IAC9B,QAAQ,CAAC,EAAE,OAAO,EAAE,CAAA;CACrB,CAAA;AAED,MAAM,MAAM,mBAAmB,GAAG,eAAe,GAAG,UAAU,CAAA;AAE9D,MAAM,MAAM,mBAAmB,GAAG;IAChC,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB,CAAA;AAED,MAAM,MAAM,mBAAmB,GAAG;IAChC,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CACzB,CAAA"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/apis/people/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAChD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAA;AAE1D,MAAM,MAAM,MAAM,GAAG;IACnB,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;IACnB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IAEjB,aAAa,CAAC,EAAE,YAAY,EAAE,CAAA;IAC9B,QAAQ,CAAC,EAAE,OAAO,EAAE,CAAA;CACrB,CAAA;AAED,MAAM,MAAM,mBAAmB,GAAG,eAAe,GAAG,UAAU,CAAA;AAE9D,MAAM,MAAM,mBAAmB,GAAG;IAChC,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB,kGAAkG;IAClG,eAAe,CAAC,EAAE,MAAM,EAAE,CAAA;CAC3B,CAAA;AAED,MAAM,MAAM,mBAAmB,GAAG;IAChC,0EAA0E;IAC1E,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB,mFAAmF;IACnF,eAAe,CAAC,EAAE,MAAM,EAAE,CAAA;CAC3B,CAAA"}

package/dist/apis/permissions/PermissionsApi.cjs

@@ -1,8 +1,12 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
-const require_core_BaseCrudApi = require('../../core/BaseCrudApi.cjs');
+const require_core_BaseReadApi = require('../../core/BaseReadApi.cjs');
 
 //#region src/apis/permissions/PermissionsApi.ts
-var PermissionsApi = class extends require_core_BaseCrudApi.BaseCrudApi {
+/**
+* The permission catalog used by roles. The backend only serves `GET /permissions` and
+* `GET /permissions/:id` (guarded by `roles.view`), so there is no create/update/delete.
+*/
+var PermissionsApi = class extends require_core_BaseReadApi.BaseReadApi {
 	constructor(client) {
 		super(client, "/permissions");
 	}

package/dist/apis/permissions/PermissionsApi.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"PermissionsApi.cjs","names":["BaseCrudApi"],"sources":["../../../src/apis/permissions/PermissionsApi.ts"],"sourcesContent":["import type { ApiClient } from '../../core/ApiClient'\nimport { BaseCrudApi } from '../../core/BaseCrudApi'\nimport type { Permission, CreatePermissionPayload, UpdatePermissionPayload } from './types'\n\nexport class PermissionsApi extends BaseCrudApi<\n  Permission,\n  CreatePermissionPayload,\n  UpdatePermissionPayload\n> {\n  constructor(client: ApiClient) {\n    super(client, '/permissions')\n  }\n}\n"],"mappings":";;;;AAIA,IAAa,iBAAb,cAAoCA,qCAIlC;CACA,YAAY,QAAmB;AAC7B,QAAM,QAAQ,eAAe"}
+{"version":3,"file":"PermissionsApi.cjs","names":["BaseReadApi"],"sources":["../../../src/apis/permissions/PermissionsApi.ts"],"sourcesContent":["import type { ApiClient } from '../../core/ApiClient'\nimport { BaseReadApi } from '../../core/BaseReadApi'\nimport type { Permission } from './types'\n\n/**\n * The permission catalog used by roles. The backend only serves `GET /permissions` and\n * `GET /permissions/:id` (guarded by `roles.view`), so there is no create/update/delete.\n */\nexport class PermissionsApi extends BaseReadApi<Permission> {\n  constructor(client: ApiClient) {\n    super(client, '/permissions')\n  }\n}\n"],"mappings":";;;;;;;;AAQA,IAAa,iBAAb,cAAoCA,qCAAwB;CAC1D,YAAY,QAAmB;AAC7B,QAAM,QAAQ,eAAe"}

package/dist/apis/permissions/PermissionsApi.d.ts

@@ -1,7 +1,11 @@
 import type { ApiClient } from '../../core/ApiClient';
-import { BaseCrudApi } from '../../core/BaseCrudApi';
-import type { Permission, CreatePermissionPayload, UpdatePermissionPayload } from './types';
-export declare class PermissionsApi extends BaseCrudApi<Permission, CreatePermissionPayload, UpdatePermissionPayload> {
+import { BaseReadApi } from '../../core/BaseReadApi';
+import type { Permission } from './types';
+/**
+ * The permission catalog used by roles. The backend only serves `GET /permissions` and
+ * `GET /permissions/:id` (guarded by `roles.view`), so there is no create/update/delete.
+ */
+export declare class PermissionsApi extends BaseReadApi<Permission> {
     constructor(client: ApiClient);
 }
 //# sourceMappingURL=PermissionsApi.d.ts.map

package/dist/apis/permissions/PermissionsApi.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"PermissionsApi.d.ts","sourceRoot":"","sources":["../../../src/apis/permissions/PermissionsApi.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAA;AACrD,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAA;AACpD,OAAO,KAAK,EAAE,UAAU,EAAE,uBAAuB,EAAE,uBAAuB,EAAE,MAAM,SAAS,CAAA;AAE3F,qBAAa,cAAe,SAAQ,WAAW,CAC7C,UAAU,EACV,uBAAuB,EACvB,uBAAuB,CACxB;gBACa,MAAM,EAAE,SAAS;CAG9B"}
+{"version":3,"file":"PermissionsApi.d.ts","sourceRoot":"","sources":["../../../src/apis/permissions/PermissionsApi.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAA;AACrD,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAA;AACpD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,SAAS,CAAA;AAEzC;;;GAGG;AACH,qBAAa,cAAe,SAAQ,WAAW,CAAC,UAAU,CAAC;gBAC7C,MAAM,EAAE,SAAS;CAG9B"}

package/dist/apis/permissions/PermissionsApi.mjs

@@ -1,7 +1,11 @@
-import { BaseCrudApi } from "../../core/BaseCrudApi.mjs";
+import { BaseReadApi } from "../../core/BaseReadApi.mjs";
 
 //#region src/apis/permissions/PermissionsApi.ts
-var PermissionsApi = class extends BaseCrudApi {
+/**
+* The permission catalog used by roles. The backend only serves `GET /permissions` and
+* `GET /permissions/:id` (guarded by `roles.view`), so there is no create/update/delete.
+*/
+var PermissionsApi = class extends BaseReadApi {
 	constructor(client) {
 		super(client, "/permissions");
 	}

package/dist/apis/permissions/PermissionsApi.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"PermissionsApi.mjs","names":[],"sources":["../../../src/apis/permissions/PermissionsApi.ts"],"sourcesContent":["import type { ApiClient } from '../../core/ApiClient'\nimport { BaseCrudApi } from '../../core/BaseCrudApi'\nimport type { Permission, CreatePermissionPayload, UpdatePermissionPayload } from './types'\n\nexport class PermissionsApi extends BaseCrudApi<\n  Permission,\n  CreatePermissionPayload,\n  UpdatePermissionPayload\n> {\n  constructor(client: ApiClient) {\n    super(client, '/permissions')\n  }\n}\n"],"mappings":";;;AAIA,IAAa,iBAAb,cAAoC,YAIlC;CACA,YAAY,QAAmB;AAC7B,QAAM,QAAQ,eAAe"}
+{"version":3,"file":"PermissionsApi.mjs","names":[],"sources":["../../../src/apis/permissions/PermissionsApi.ts"],"sourcesContent":["import type { ApiClient } from '../../core/ApiClient'\nimport { BaseReadApi } from '../../core/BaseReadApi'\nimport type { Permission } from './types'\n\n/**\n * The permission catalog used by roles. The backend only serves `GET /permissions` and\n * `GET /permissions/:id` (guarded by `roles.view`), so there is no create/update/delete.\n */\nexport class PermissionsApi extends BaseReadApi<Permission> {\n  constructor(client: ApiClient) {\n    super(client, '/permissions')\n  }\n}\n"],"mappings":";;;;;;;AAQA,IAAa,iBAAb,cAAoC,YAAwB;CAC1D,YAAY,QAAmB;AAC7B,QAAM,QAAQ,eAAe"}

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

@@ -1,22 +1,12 @@
 export type PermissionType = 'chat' | 'miscellaneous' | 'users' | 'roles' | 'services' | 'campaigns' | 'tags' | 'tickets' | 'departments' | 'bots' | 'contacts' | 'quickReplies' | 'pipelines' | 'automation' | 'evaluation' | 'holidays' | 'myAccount' | 'settingsApi' | 'authHistory' | 'overview' | 'messages' | 'ticketTopics' | 'distribution' | 'people' | 'acceptanceTerms' | 'organizations' | 'hsm' | 'interactive-messages' | 'integrations' | 'customFields' | 'schedule' | 'notification' | 'timetables' | 'stickers' | 'groups' | 'download' | 'aIConsumption' | 'knowledgeBase' | 'kanban';
 export type PermissionName = 'chat' | 'chat.view.contacts' | 'ignore-ip-restriction' | 'users.view' | 'users.create' | 'users.update' | 'users.archive' | 'roles.view' | 'roles.create' | 'roles.update' | 'roles.destroy' | 'services.view' | 'services.create' | 'services.update' | 'services.destroy' | 'services.operate' | 'services.disabled' | 'campaigns.view' | 'campaigns.create' | 'campaigns.update' | 'campaigns.destroy' | 'campaigns.autoPause' | 'tags.view' | 'tags.create' | 'tags.update' | 'tags.destroy' | 'tickets.transfer.all' | 'tickets.transfer.me' | 'tickets.transfer.departments' | 'tickets.close.all' | 'tickets.close.me' | 'tickets.update' | 'tickets.open' | 'tickets.view.all.departments' | 'tickets.view.all' | 'tickets.transfer.all.bulk' | 'tickets.comment' | 'departments.view' | 'departments.create' | 'departments.update' | 'departments.archive' | 'bots.view' | 'bots.create' | 'bots.update' | 'bots.destroy' | 'contacts.view.number' | 'contacts.view' | 'contacts.create' | 'contacts.update' | 'contacts.destroy' | 'contacts.export' | 'contacts.pin' | 'contacts.block' | 'quickReplies.view' | 'quickReplies.create' | 'quickReplies.update' | 'quickReplies.destroy' | 'pipelines.view' | 'pipelines.create' | 'pipelines.update' | 'pipelines.destroy' | 'pipelines.opportunity.view' | 'pipelines.opportunity.create' | 'pipelines.opportunity.update' | 'pipelines.opportunity.destroy' | 'automation.view' | 'automation.management' | 'evaluation.view' | 'evaluation.create' | 'evaluation.update' | 'evaluation.destroy' | 'holidays.view' | 'holidays.create' | 'holidays.update' | 'holidays.destroy' | 'myAccount.view' | 'myAccount.update' | 'myAccount.myPlan' | 'myAccount.absence' | 'settingsApi.update' | 'authHistory.view' | 'overview.now.view.all' | 'overview.now.view.departments' | 'overview.history.view' | 'overview.hsm.statistic.view' | 'overview.evaluation.view' | 'overview.absence.view' | 'messages.destroy' | 'messages.view.out.queue' | 'messages.view.all' | 'messages.view.ticket.mine' | 'messages.view.ticket.department' | 'messages.view.transfer.mine' | 'messages.view.transfer.department' | 'messages.view.ticket.mine.current' | 'messages.view.ticket.department.current' | 'ticketTopics.view' | 'ticketTopics.create' | 'ticketTopics.update' | 'ticketTopics.destroy' | 'ticketTopics.archive' | 'distribution.view' | 'distribution.create' | 'distribution.update' | 'distribution.destroy' | 'people.view' | 'people.create' | 'people.update' | 'people.destroy' | 'acceptanceTerms.view' | 'acceptanceTerms.create' | 'acceptanceTerms.update' | 'acceptanceTerms.destroy' | 'organizations.view' | 'organizations.create' | 'organizations.update' | 'organizations.destroy' | 'hsm.view' | 'hsm.create' | 'hsm.update' | 'hsm.destroy' | 'hsm.send.before.expire' | 'hsm.send' | 'interactive-messages.view' | 'interactive-messages.create' | 'interactive-messages.management.all.departments' | 'interactive-messages.update' | 'interactive-messages.destroy' | 'interactive-messages.send' | 'integrations.view' | 'integrations.create' | 'integrations.update' | 'integrations.destroy' | 'customFields.view' | 'customFields.create' | 'customFields.update' | 'customFields.destroy' | 'schedule.view' | 'schedule.create' | 'schedule.update' | 'schedule.destroy' | 'schedule.create.all' | 'notification.view.all' | 'timetables.view' | 'timetables.create' | 'timetables.update' | 'timetables.destroy' | 'stickers.management' | 'stickers.send' | 'groups.create' | 'groups.view' | 'groups.update' | 'groups.add.members' | 'groups.remove.members' | 'groups.promote.admin' | 'groups.demote.admin' | 'groups.leave' | 'download.image' | 'download.audio' | 'download.video' | 'aIConsumption.view' | 'knowledgeBase.view' | 'knowledgeBase.create' | 'knowledgeBase.update' | 'knowledgeBase.destroy' | 'kanban.view' | 'kanban.create' | 'kanban.update' | 'kanban.destroy';
+/**
+ * A permission, as `GET /permissions` answers it (the transformer only picks these fields).
+ * Permissions are a fixed catalog: the API is read-only.
+ */
 export type Permission = {
     id: string;
     name: PermissionName;
     type: PermissionType | null;
-    description: string | null;
-    createdAt: string;
-    updatedAt: string;
-    deletedAt: string | null;
-};
-export type CreatePermissionPayload = {
-    name: PermissionName;
-    type?: PermissionType;
-    description?: string;
-};
-export type UpdatePermissionPayload = {
-    name?: PermissionName;
-    type?: PermissionType | null;
-    description?: string | null;
 };
 //# sourceMappingURL=types.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/apis/permissions/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,cAAc,GACtB,MAAM,GACN,eAAe,GACf,OAAO,GACP,OAAO,GACP,UAAU,GACV,WAAW,GACX,MAAM,GACN,SAAS,GACT,aAAa,GACb,MAAM,GACN,UAAU,GACV,cAAc,GACd,WAAW,GACX,YAAY,GACZ,YAAY,GACZ,UAAU,GACV,WAAW,GACX,aAAa,GACb,aAAa,GACb,UAAU,GACV,UAAU,GACV,cAAc,GACd,cAAc,GACd,QAAQ,GACR,iBAAiB,GACjB,eAAe,GACf,KAAK,GACL,sBAAsB,GACtB,cAAc,GACd,cAAc,GACd,UAAU,GACV,cAAc,GACd,YAAY,GACZ,UAAU,GACV,QAAQ,GACR,UAAU,GACV,eAAe,GACf,eAAe,GACf,QAAQ,CAAA;AAEZ,MAAM,MAAM,cAAc,GACtB,MAAM,GACN,oBAAoB,GACpB,uBAAuB,GACvB,YAAY,GACZ,cAAc,GACd,cAAc,GACd,eAAe,GACf,YAAY,GACZ,cAAc,GACd,cAAc,GACd,eAAe,GACf,eAAe,GACf,iBAAiB,GACjB,iBAAiB,GACjB,kBAAkB,GAClB,kBAAkB,GAClB,mBAAmB,GACnB,gBAAgB,GAChB,kBAAkB,GAClB,kBAAkB,GAClB,mBAAmB,GACnB,qBAAqB,GACrB,WAAW,GACX,aAAa,GACb,aAAa,GACb,cAAc,GACd,sBAAsB,GACtB,qBAAqB,GACrB,8BAA8B,GAC9B,mBAAmB,GACnB,kBAAkB,GAClB,gBAAgB,GAChB,cAAc,GACd,8BAA8B,GAC9B,kBAAkB,GAClB,2BAA2B,GAC3B,iBAAiB,GACjB,kBAAkB,GAClB,oBAAoB,GACpB,oBAAoB,GACpB,qBAAqB,GACrB,WAAW,GACX,aAAa,GACb,aAAa,GACb,cAAc,GACd,sBAAsB,GACtB,eAAe,GACf,iBAAiB,GACjB,iBAAiB,GACjB,kBAAkB,GAClB,iBAAiB,GACjB,cAAc,GACd,gBAAgB,GAChB,mBAAmB,GACnB,qBAAqB,GACrB,qBAAqB,GACrB,sBAAsB,GACtB,gBAAgB,GAChB,kBAAkB,GAClB,kBAAkB,GAClB,mBAAmB,GACnB,4BAA4B,GAC5B,8BAA8B,GAC9B,8BAA8B,GAC9B,+BAA+B,GAC/B,iBAAiB,GACjB,uBAAuB,GACvB,iBAAiB,GACjB,mBAAmB,GACnB,mBAAmB,GACnB,oBAAoB,GACpB,eAAe,GACf,iBAAiB,GACjB,iBAAiB,GACjB,kBAAkB,GAClB,gBAAgB,GAChB,kBAAkB,GAClB,kBAAkB,GAClB,mBAAmB,GACnB,oBAAoB,GACpB,kBAAkB,GAClB,uBAAuB,GACvB,+BAA+B,GAC/B,uBAAuB,GACvB,6BAA6B,GAC7B,0BAA0B,GAC1B,uBAAuB,GACvB,kBAAkB,GAClB,yBAAyB,GACzB,mBAAmB,GACnB,2BAA2B,GAC3B,iCAAiC,GACjC,6BAA6B,GAC7B,mCAAmC,GACnC,mCAAmC,GACnC,yCAAyC,GACzC,mBAAmB,GACnB,qBAAqB,GACrB,qBAAqB,GACrB,sBAAsB,GACtB,sBAAsB,GACtB,mBAAmB,GACnB,qBAAqB,GACrB,qBAAqB,GACrB,sBAAsB,GACtB,aAAa,GACb,eAAe,GACf,eAAe,GACf,gBAAgB,GAChB,sBAAsB,GACtB,wBAAwB,GACxB,wBAAwB,GACxB,yBAAyB,GACzB,oBAAoB,GACpB,sBAAsB,GACtB,sBAAsB,GACtB,uBAAuB,GACvB,UAAU,GACV,YAAY,GACZ,YAAY,GACZ,aAAa,GACb,wBAAwB,GACxB,UAAU,GACV,2BAA2B,GAC3B,6BAA6B,GAC7B,iDAAiD,GACjD,6BAA6B,GAC7B,8BAA8B,GAC9B,2BAA2B,GAC3B,mBAAmB,GACnB,qBAAqB,GACrB,qBAAqB,GACrB,sBAAsB,GACtB,mBAAmB,GACnB,qBAAqB,GACrB,qBAAqB,GACrB,sBAAsB,GACtB,eAAe,GACf,iBAAiB,GACjB,iBAAiB,GACjB,kBAAkB,GAClB,qBAAqB,GACrB,uBAAuB,GACvB,iBAAiB,GACjB,mBAAmB,GACnB,mBAAmB,GACnB,oBAAoB,GACpB,qBAAqB,GACrB,eAAe,GACf,eAAe,GACf,aAAa,GACb,eAAe,GACf,oBAAoB,GACpB,uBAAuB,GACvB,sBAAsB,GACtB,qBAAqB,GACrB,cAAc,GACd,gBAAgB,GAChB,gBAAgB,GAChB,gBAAgB,GAChB,oBAAoB,GACpB,oBAAoB,GACpB,sBAAsB,GACtB,sBAAsB,GACtB,uBAAuB,GACvB,aAAa,GACb,eAAe,GACf,eAAe,GACf,gBAAgB,CAAA;AAEpB,MAAM,MAAM,UAAU,GAAG;IACvB,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,cAAc,CAAA;IACpB,IAAI,EAAE,cAAc,GAAG,IAAI,CAAA;IAC3B,WAAW,EAAE,MAAM,GAAG,IAAI,CAAA;IAC1B,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;CACzB,CAAA;AAED,MAAM,MAAM,uBAAuB,GAAG;IACpC,IAAI,EAAE,cAAc,CAAA;IACpB,IAAI,CAAC,EAAE,cAAc,CAAA;IACrB,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB,CAAA;AAED,MAAM,MAAM,uBAAuB,GAAG;IACpC,IAAI,CAAC,EAAE,cAAc,CAAA;IACrB,IAAI,CAAC,EAAE,cAAc,GAAG,IAAI,CAAA;IAC5B,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CAC5B,CAAA"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/apis/permissions/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,cAAc,GACtB,MAAM,GACN,eAAe,GACf,OAAO,GACP,OAAO,GACP,UAAU,GACV,WAAW,GACX,MAAM,GACN,SAAS,GACT,aAAa,GACb,MAAM,GACN,UAAU,GACV,cAAc,GACd,WAAW,GACX,YAAY,GACZ,YAAY,GACZ,UAAU,GACV,WAAW,GACX,aAAa,GACb,aAAa,GACb,UAAU,GACV,UAAU,GACV,cAAc,GACd,cAAc,GACd,QAAQ,GACR,iBAAiB,GACjB,eAAe,GACf,KAAK,GACL,sBAAsB,GACtB,cAAc,GACd,cAAc,GACd,UAAU,GACV,cAAc,GACd,YAAY,GACZ,UAAU,GACV,QAAQ,GACR,UAAU,GACV,eAAe,GACf,eAAe,GACf,QAAQ,CAAA;AAEZ,MAAM,MAAM,cAAc,GACtB,MAAM,GACN,oBAAoB,GACpB,uBAAuB,GACvB,YAAY,GACZ,cAAc,GACd,cAAc,GACd,eAAe,GACf,YAAY,GACZ,cAAc,GACd,cAAc,GACd,eAAe,GACf,eAAe,GACf,iBAAiB,GACjB,iBAAiB,GACjB,kBAAkB,GAClB,kBAAkB,GAClB,mBAAmB,GACnB,gBAAgB,GAChB,kBAAkB,GAClB,kBAAkB,GAClB,mBAAmB,GACnB,qBAAqB,GACrB,WAAW,GACX,aAAa,GACb,aAAa,GACb,cAAc,GACd,sBAAsB,GACtB,qBAAqB,GACrB,8BAA8B,GAC9B,mBAAmB,GACnB,kBAAkB,GAClB,gBAAgB,GAChB,cAAc,GACd,8BAA8B,GAC9B,kBAAkB,GAClB,2BAA2B,GAC3B,iBAAiB,GACjB,kBAAkB,GAClB,oBAAoB,GACpB,oBAAoB,GACpB,qBAAqB,GACrB,WAAW,GACX,aAAa,GACb,aAAa,GACb,cAAc,GACd,sBAAsB,GACtB,eAAe,GACf,iBAAiB,GACjB,iBAAiB,GACjB,kBAAkB,GAClB,iBAAiB,GACjB,cAAc,GACd,gBAAgB,GAChB,mBAAmB,GACnB,qBAAqB,GACrB,qBAAqB,GACrB,sBAAsB,GACtB,gBAAgB,GAChB,kBAAkB,GAClB,kBAAkB,GAClB,mBAAmB,GACnB,4BAA4B,GAC5B,8BAA8B,GAC9B,8BAA8B,GAC9B,+BAA+B,GAC/B,iBAAiB,GACjB,uBAAuB,GACvB,iBAAiB,GACjB,mBAAmB,GACnB,mBAAmB,GACnB,oBAAoB,GACpB,eAAe,GACf,iBAAiB,GACjB,iBAAiB,GACjB,kBAAkB,GAClB,gBAAgB,GAChB,kBAAkB,GAClB,kBAAkB,GAClB,mBAAmB,GACnB,oBAAoB,GACpB,kBAAkB,GAClB,uBAAuB,GACvB,+BAA+B,GAC/B,uBAAuB,GACvB,6BAA6B,GAC7B,0BAA0B,GAC1B,uBAAuB,GACvB,kBAAkB,GAClB,yBAAyB,GACzB,mBAAmB,GACnB,2BAA2B,GAC3B,iCAAiC,GACjC,6BAA6B,GAC7B,mCAAmC,GACnC,mCAAmC,GACnC,yCAAyC,GACzC,mBAAmB,GACnB,qBAAqB,GACrB,qBAAqB,GACrB,sBAAsB,GACtB,sBAAsB,GACtB,mBAAmB,GACnB,qBAAqB,GACrB,qBAAqB,GACrB,sBAAsB,GACtB,aAAa,GACb,eAAe,GACf,eAAe,GACf,gBAAgB,GAChB,sBAAsB,GACtB,wBAAwB,GACxB,wBAAwB,GACxB,yBAAyB,GACzB,oBAAoB,GACpB,sBAAsB,GACtB,sBAAsB,GACtB,uBAAuB,GACvB,UAAU,GACV,YAAY,GACZ,YAAY,GACZ,aAAa,GACb,wBAAwB,GACxB,UAAU,GACV,2BAA2B,GAC3B,6BAA6B,GAC7B,iDAAiD,GACjD,6BAA6B,GAC7B,8BAA8B,GAC9B,2BAA2B,GAC3B,mBAAmB,GACnB,qBAAqB,GACrB,qBAAqB,GACrB,sBAAsB,GACtB,mBAAmB,GACnB,qBAAqB,GACrB,qBAAqB,GACrB,sBAAsB,GACtB,eAAe,GACf,iBAAiB,GACjB,iBAAiB,GACjB,kBAAkB,GAClB,qBAAqB,GACrB,uBAAuB,GACvB,iBAAiB,GACjB,mBAAmB,GACnB,mBAAmB,GACnB,oBAAoB,GACpB,qBAAqB,GACrB,eAAe,GACf,eAAe,GACf,aAAa,GACb,eAAe,GACf,oBAAoB,GACpB,uBAAuB,GACvB,sBAAsB,GACtB,qBAAqB,GACrB,cAAc,GACd,gBAAgB,GAChB,gBAAgB,GAChB,gBAAgB,GAChB,oBAAoB,GACpB,oBAAoB,GACpB,sBAAsB,GACtB,sBAAsB,GACtB,uBAAuB,GACvB,aAAa,GACb,eAAe,GACf,eAAe,GACf,gBAAgB,CAAA;AAEpB;;;GAGG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,cAAc,CAAA;IACpB,IAAI,EAAE,cAAc,GAAG,IAAI,CAAA;CAC5B,CAAA"}

package/dist/apis/personalAccessTokens/PersonalAccessTokensApi.cjs

@@ -2,6 +2,11 @@ Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 const require_core_BaseCrudApi = require('../../core/BaseCrudApi.cjs');
 
 //#region src/apis/personalAccessTokens/PersonalAccessTokensApi.ts
+/**
+* Personal access tokens of the authenticated user (`/me/tokens`, all routes guarded by
+* `settingsApi.update`). The listing is scoped to the user; `getById` of a missing token answers
+* 404 (`{ message: 'Not found' }`) instead of `null`.
+*/
 var PersonalAccessTokensApi = class extends require_core_BaseCrudApi.BaseCrudApi {
 	constructor(client) {
 		super(client, "/me/tokens");

package/dist/apis/personalAccessTokens/PersonalAccessTokensApi.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"PersonalAccessTokensApi.cjs","names":["BaseCrudApi"],"sources":["../../../src/apis/personalAccessTokens/PersonalAccessTokensApi.ts"],"sourcesContent":["import type { ApiClient } from '../../core/ApiClient'\nimport { BaseCrudApi } from '../../core/BaseCrudApi'\nimport type {\n  PersonalAccessToken,\n  CreatePersonalAccessTokenPayload,\n  UpdatePersonalAccessTokenPayload,\n} from './types'\n\nexport class PersonalAccessTokensApi extends BaseCrudApi<\n  PersonalAccessToken,\n  CreatePersonalAccessTokenPayload,\n  UpdatePersonalAccessTokenPayload\n> {\n  constructor(client: ApiClient) {\n    super(client, '/me/tokens')\n  }\n}\n"],"mappings":";;;;AAQA,IAAa,0BAAb,cAA6CA,qCAI3C;CACA,YAAY,QAAmB;AAC7B,QAAM,QAAQ,aAAa"}
+{"version":3,"file":"PersonalAccessTokensApi.cjs","names":["BaseCrudApi"],"sources":["../../../src/apis/personalAccessTokens/PersonalAccessTokensApi.ts"],"sourcesContent":["import type { ApiClient } from '../../core/ApiClient'\nimport { BaseCrudApi } from '../../core/BaseCrudApi'\nimport type {\n  PersonalAccessToken,\n  CreatePersonalAccessTokenPayload,\n  UpdatePersonalAccessTokenPayload,\n} from './types'\n\n/**\n * Personal access tokens of the authenticated user (`/me/tokens`, all routes guarded by\n * `settingsApi.update`). The listing is scoped to the user; `getById` of a missing token answers\n * 404 (`{ message: 'Not found' }`) instead of `null`.\n */\nexport class PersonalAccessTokensApi extends BaseCrudApi<\n  PersonalAccessToken,\n  CreatePersonalAccessTokenPayload,\n  UpdatePersonalAccessTokenPayload\n> {\n  constructor(client: ApiClient) {\n    super(client, '/me/tokens')\n  }\n}\n"],"mappings":";;;;;;;;;AAaA,IAAa,0BAAb,cAA6CA,qCAI3C;CACA,YAAY,QAAmB;AAC7B,QAAM,QAAQ,aAAa"}

package/dist/apis/personalAccessTokens/PersonalAccessTokensApi.d.ts

@@ -1,6 +1,11 @@
 import type { ApiClient } from '../../core/ApiClient';
 import { BaseCrudApi } from '../../core/BaseCrudApi';
 import type { PersonalAccessToken, CreatePersonalAccessTokenPayload, UpdatePersonalAccessTokenPayload } from './types';
+/**
+ * Personal access tokens of the authenticated user (`/me/tokens`, all routes guarded by
+ * `settingsApi.update`). The listing is scoped to the user; `getById` of a missing token answers
+ * 404 (`{ message: 'Not found' }`) instead of `null`.
+ */
 export declare class PersonalAccessTokensApi extends BaseCrudApi<PersonalAccessToken, CreatePersonalAccessTokenPayload, UpdatePersonalAccessTokenPayload> {
     constructor(client: ApiClient);
 }

package/dist/apis/personalAccessTokens/PersonalAccessTokensApi.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"PersonalAccessTokensApi.d.ts","sourceRoot":"","sources":["../../../src/apis/personalAccessTokens/PersonalAccessTokensApi.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAA;AACrD,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAA;AACpD,OAAO,KAAK,EACV,mBAAmB,EACnB,gCAAgC,EAChC,gCAAgC,EACjC,MAAM,SAAS,CAAA;AAEhB,qBAAa,uBAAwB,SAAQ,WAAW,CACtD,mBAAmB,EACnB,gCAAgC,EAChC,gCAAgC,CACjC;gBACa,MAAM,EAAE,SAAS;CAG9B"}
+{"version":3,"file":"PersonalAccessTokensApi.d.ts","sourceRoot":"","sources":["../../../src/apis/personalAccessTokens/PersonalAccessTokensApi.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAA;AACrD,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAA;AACpD,OAAO,KAAK,EACV,mBAAmB,EACnB,gCAAgC,EAChC,gCAAgC,EACjC,MAAM,SAAS,CAAA;AAEhB;;;;GAIG;AACH,qBAAa,uBAAwB,SAAQ,WAAW,CACtD,mBAAmB,EACnB,gCAAgC,EAChC,gCAAgC,CACjC;gBACa,MAAM,EAAE,SAAS;CAG9B"}

package/dist/apis/personalAccessTokens/PersonalAccessTokensApi.mjs

@@ -1,6 +1,11 @@
 import { BaseCrudApi } from "../../core/BaseCrudApi.mjs";
 
 //#region src/apis/personalAccessTokens/PersonalAccessTokensApi.ts
+/**
+* Personal access tokens of the authenticated user (`/me/tokens`, all routes guarded by
+* `settingsApi.update`). The listing is scoped to the user; `getById` of a missing token answers
+* 404 (`{ message: 'Not found' }`) instead of `null`.
+*/
 var PersonalAccessTokensApi = class extends BaseCrudApi {
 	constructor(client) {
 		super(client, "/me/tokens");

package/dist/apis/personalAccessTokens/PersonalAccessTokensApi.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"PersonalAccessTokensApi.mjs","names":[],"sources":["../../../src/apis/personalAccessTokens/PersonalAccessTokensApi.ts"],"sourcesContent":["import type { ApiClient } from '../../core/ApiClient'\nimport { BaseCrudApi } from '../../core/BaseCrudApi'\nimport type {\n  PersonalAccessToken,\n  CreatePersonalAccessTokenPayload,\n  UpdatePersonalAccessTokenPayload,\n} from './types'\n\nexport class PersonalAccessTokensApi extends BaseCrudApi<\n  PersonalAccessToken,\n  CreatePersonalAccessTokenPayload,\n  UpdatePersonalAccessTokenPayload\n> {\n  constructor(client: ApiClient) {\n    super(client, '/me/tokens')\n  }\n}\n"],"mappings":";;;AAQA,IAAa,0BAAb,cAA6C,YAI3C;CACA,YAAY,QAAmB;AAC7B,QAAM,QAAQ,aAAa"}
+{"version":3,"file":"PersonalAccessTokensApi.mjs","names":[],"sources":["../../../src/apis/personalAccessTokens/PersonalAccessTokensApi.ts"],"sourcesContent":["import type { ApiClient } from '../../core/ApiClient'\nimport { BaseCrudApi } from '../../core/BaseCrudApi'\nimport type {\n  PersonalAccessToken,\n  CreatePersonalAccessTokenPayload,\n  UpdatePersonalAccessTokenPayload,\n} from './types'\n\n/**\n * Personal access tokens of the authenticated user (`/me/tokens`, all routes guarded by\n * `settingsApi.update`). The listing is scoped to the user; `getById` of a missing token answers\n * 404 (`{ message: 'Not found' }`) instead of `null`.\n */\nexport class PersonalAccessTokensApi extends BaseCrudApi<\n  PersonalAccessToken,\n  CreatePersonalAccessTokenPayload,\n  UpdatePersonalAccessTokenPayload\n> {\n  constructor(client: ApiClient) {\n    super(client, '/me/tokens')\n  }\n}\n"],"mappings":";;;;;;;;AAaA,IAAa,0BAAb,cAA6C,YAI3C;CACA,YAAY,QAAmB;AAC7B,QAAM,QAAQ,aAAa"}

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

@@ -1,24 +1,43 @@
 import type { User } from '../users/types';
+export type PersonalAccessTokenStatus = 'active' | 'revoked' | 'expired';
+/** Accepted lifetimes of a token (`No expiration` keeps `accessTokenExpiresAt` null). */
+export type PersonalAccessTokenExpiresIn = '30d' | '90d' | '180d' | '1y' | 'No expiration';
+/**
+ * A personal access token of the authenticated user.
+ *
+ * `accessToken` comes in full only in the `create` answer; every other route masks it
+ * (`abcde***vwxyz`). `status` and `user` (only `{ name }`) come on `getMany`/`getById`.
+ * `deleteById` revokes the token (soft delete): it keeps being listed with `status: 'revoked'`.
+ */
 export type PersonalAccessToken = {
     id: string;
     name: string;
+    /** `*` when created without a scope. */
     scope: string | null;
     accessToken: string;
     accessTokenExpiresAt: string | null;
     userId: string;
+    clientId: string | null;
+    impersonate?: boolean | null;
     createdAt: string;
     updatedAt: string;
     deletedAt: string | null;
-    user?: User;
+    /** Only on `getMany`/`getById` answers. */
+    status?: PersonalAccessTokenStatus;
+    /** Only on `getMany`/`getById` answers, with just the name. */
+    user?: Pick<User, 'name'>;
 };
 export type PersonalAccessTokenRelationships = 'user';
 export type CreatePersonalAccessTokenPayload = {
+    /** Up to 255 characters. */
     name: string;
+    /** Up to 255 characters (`*` by default). */
     scope?: string;
-    accessTokenExpiresAt?: string;
+    expiresIn?: PersonalAccessTokenExpiresIn;
 };
 export type UpdatePersonalAccessTokenPayload = {
-    name?: string;
-    scope?: string | null;
+    /** Required by the backend on every update (400 `required` otherwise). */
+    name: string;
+    scope?: string;
 };
 //# sourceMappingURL=types.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/apis/personalAccessTokens/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,gBAAgB,CAAA;AAE1C,MAAM,MAAM,mBAAmB,GAAG;IAChC,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;IACpB,WAAW,EAAE,MAAM,CAAA;IACnB,oBAAoB,EAAE,MAAM,GAAG,IAAI,CAAA;IACnC,MAAM,EAAE,MAAM,CAAA;IACd,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,gCAAgC,GAAG,MAAM,CAAA;AAErD,MAAM,MAAM,gCAAgC,GAAG;IAC7C,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,oBAAoB,CAAC,EAAE,MAAM,CAAA;CAC9B,CAAA;AAED,MAAM,MAAM,gCAAgC,GAAG;IAC7C,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CACtB,CAAA"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/apis/personalAccessTokens/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,gBAAgB,CAAA;AAE1C,MAAM,MAAM,yBAAyB,GAAG,QAAQ,GAAG,SAAS,GAAG,SAAS,CAAA;AAExE,yFAAyF;AACzF,MAAM,MAAM,4BAA4B,GAAG,KAAK,GAAG,KAAK,GAAG,MAAM,GAAG,IAAI,GAAG,eAAe,CAAA;AAE1F;;;;;;GAMG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,wCAAwC;IACxC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;IACpB,WAAW,EAAE,MAAM,CAAA;IACnB,oBAAoB,EAAE,MAAM,GAAG,IAAI,CAAA;IACnC,MAAM,EAAE,MAAM,CAAA;IACd,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,WAAW,CAAC,EAAE,OAAO,GAAG,IAAI,CAAA;IAC5B,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB,2CAA2C;IAC3C,MAAM,CAAC,EAAE,yBAAyB,CAAA;IAElC,+DAA+D;IAC/D,IAAI,CAAC,EAAE,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;CAC1B,CAAA;AAED,MAAM,MAAM,gCAAgC,GAAG,MAAM,CAAA;AAErD,MAAM,MAAM,gCAAgC,GAAG;IAC7C,4BAA4B;IAC5B,IAAI,EAAE,MAAM,CAAA;IACZ,6CAA6C;IAC7C,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,SAAS,CAAC,EAAE,4BAA4B,CAAA;CACzC,CAAA;AAED,MAAM,MAAM,gCAAgC,GAAG;IAC7C,0EAA0E;IAC1E,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,CAAC,EAAE,MAAM,CAAA;CACf,CAAA"}

package/dist/apis/roles/RolesApi.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"RolesApi.cjs","names":["BaseCrudApi"],"sources":["../../../src/apis/roles/RolesApi.ts"],"sourcesContent":["import type { ApiClient } from '../../core/ApiClient'\nimport { BaseCrudApi } from '../../core/BaseCrudApi'\nimport type { Role, CreateRolePayload, UpdateRolePayload } from './types'\n\nexport class RolesApi extends BaseCrudApi<Role, CreateRolePayload, UpdateRolePayload> {\n  constructor(client: ApiClient) {\n    super(client, '/roles')\n  }\n}\n"],"mappings":";;;;AAIA,IAAa,WAAb,cAA8BA,qCAAwD;CACpF,YAAY,QAAmB;AAC7B,QAAM,QAAQ,SAAS"}
+{"version":3,"file":"RolesApi.cjs","names":["BaseCrudApi"],"sources":["../../../src/apis/roles/RolesApi.ts"],"sourcesContent":["import type { ApiClient } from '../../core/ApiClient'\nimport { BaseCrudApi } from '../../core/BaseCrudApi'\nimport type { Role, CreateRolePayload, UpdateRolePayload, RolesListQuery } from './types'\n\nexport class RolesApi extends BaseCrudApi<\n  Role,\n  CreateRolePayload,\n  UpdateRolePayload,\n  RolesListQuery\n> {\n  constructor(client: ApiClient) {\n    super(client, '/roles')\n  }\n}\n"],"mappings":";;;;AAIA,IAAa,WAAb,cAA8BA,qCAK5B;CACA,YAAY,QAAmB;AAC7B,QAAM,QAAQ,SAAS"}

package/dist/apis/roles/RolesApi.d.ts

@@ -1,7 +1,7 @@
 import type { ApiClient } from '../../core/ApiClient';
 import { BaseCrudApi } from '../../core/BaseCrudApi';
-import type { Role, CreateRolePayload, UpdateRolePayload } from './types';
-export declare class RolesApi extends BaseCrudApi<Role, CreateRolePayload, UpdateRolePayload> {
+import type { Role, CreateRolePayload, UpdateRolePayload, RolesListQuery } from './types';
+export declare class RolesApi extends BaseCrudApi<Role, CreateRolePayload, UpdateRolePayload, RolesListQuery> {
     constructor(client: ApiClient);
 }
 //# sourceMappingURL=RolesApi.d.ts.map

package/dist/apis/roles/RolesApi.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"RolesApi.d.ts","sourceRoot":"","sources":["../../../src/apis/roles/RolesApi.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAA;AACrD,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAA;AACpD,OAAO,KAAK,EAAE,IAAI,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAA;AAEzE,qBAAa,QAAS,SAAQ,WAAW,CAAC,IAAI,EAAE,iBAAiB,EAAE,iBAAiB,CAAC;gBACvE,MAAM,EAAE,SAAS;CAG9B"}
+{"version":3,"file":"RolesApi.d.ts","sourceRoot":"","sources":["../../../src/apis/roles/RolesApi.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAA;AACrD,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAA;AACpD,OAAO,KAAK,EAAE,IAAI,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,cAAc,EAAE,MAAM,SAAS,CAAA;AAEzF,qBAAa,QAAS,SAAQ,WAAW,CACvC,IAAI,EACJ,iBAAiB,EACjB,iBAAiB,EACjB,cAAc,CACf;gBACa,MAAM,EAAE,SAAS;CAG9B"}

package/dist/apis/roles/RolesApi.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"RolesApi.mjs","names":[],"sources":["../../../src/apis/roles/RolesApi.ts"],"sourcesContent":["import type { ApiClient } from '../../core/ApiClient'\nimport { BaseCrudApi } from '../../core/BaseCrudApi'\nimport type { Role, CreateRolePayload, UpdateRolePayload } from './types'\n\nexport class RolesApi extends BaseCrudApi<Role, CreateRolePayload, UpdateRolePayload> {\n  constructor(client: ApiClient) {\n    super(client, '/roles')\n  }\n}\n"],"mappings":";;;AAIA,IAAa,WAAb,cAA8B,YAAwD;CACpF,YAAY,QAAmB;AAC7B,QAAM,QAAQ,SAAS"}
+{"version":3,"file":"RolesApi.mjs","names":[],"sources":["../../../src/apis/roles/RolesApi.ts"],"sourcesContent":["import type { ApiClient } from '../../core/ApiClient'\nimport { BaseCrudApi } from '../../core/BaseCrudApi'\nimport type { Role, CreateRolePayload, UpdateRolePayload, RolesListQuery } from './types'\n\nexport class RolesApi extends BaseCrudApi<\n  Role,\n  CreateRolePayload,\n  UpdateRolePayload,\n  RolesListQuery\n> {\n  constructor(client: ApiClient) {\n    super(client, '/roles')\n  }\n}\n"],"mappings":";;;AAIA,IAAa,WAAb,cAA8B,YAK5B;CACA,YAAY,QAAmB;AAC7B,QAAM,QAAQ,SAAS"}

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

@@ -1,4 +1,8 @@
+import type { ListQuery } from '../../core/types';
 import type { Permission } from '../permissions/types';
+/**
+ * A role (cargo). Roles are not soft-deleted, so there is no `deletedAt`.
+ */
 export type Role = {
     id: string;
     displayName: string;
@@ -6,18 +10,37 @@ export type Role = {
     accountId: string;
     createdAt: string;
     updatedAt: string;
-    deletedAt: string | null;
+    /** Only when listed with `customInclude: ['usersCount']`. */
+    usersCount?: number;
     permissions?: Permission[];
 };
 export type RoleRelationships = 'permissions';
+/**
+ * The permissions of a role, by id or `{ id }`. The backend reads the `permissions` key (also
+ * `permissionsId`/`permissionsIds`) — any other key is silently ignored and the role ends up with
+ * no permissions.
+ */
+export type RolePermissionRef = string | {
+    id: string;
+};
 export type CreateRolePayload = {
+    /** Up to 255 characters; must be unique in the account. */
     displayName: string;
     isAdmin?: boolean;
-    permissionIds?: string[];
+    permissions?: RolePermissionRef[];
 };
 export type UpdateRolePayload = {
-    displayName?: string;
+    /** Required by the backend on every update (400 `required` otherwise). */
+    displayName: string;
     isAdmin?: boolean | null;
-    permissionIds?: string[];
+    /** Replaces the role permissions. An empty array leaves them unchanged. */
+    permissions?: RolePermissionRef[];
+};
+/** List query of `/roles`, with the backend extras to count the users of each role. */
+export type RolesListQuery = ListQuery<Role> & {
+    /** `['usersCount']` adds `usersCount` to each role. */
+    customInclude?: 'usersCount'[];
+    /** Which users `usersCount` counts (default `all`). */
+    usersCountFilter?: 'all' | 'active' | 'archived';
 };
 //# sourceMappingURL=types.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/apis/roles/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAA;AAEtD,MAAM,MAAM,IAAI,GAAG;IACjB,EAAE,EAAE,MAAM,CAAA;IACV,WAAW,EAAE,MAAM,CAAA;IACnB,OAAO,EAAE,OAAO,GAAG,IAAI,CAAA;IACvB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IAExB,WAAW,CAAC,EAAE,UAAU,EAAE,CAAA;CAC3B,CAAA;AAED,MAAM,MAAM,iBAAiB,GAAG,aAAa,CAAA;AAE7C,MAAM,MAAM,iBAAiB,GAAG;IAC9B,WAAW,EAAE,MAAM,CAAA;IACnB,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,aAAa,CAAC,EAAE,MAAM,EAAE,CAAA;CACzB,CAAA;AAED,MAAM,MAAM,iBAAiB,GAAG;IAC9B,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,OAAO,CAAC,EAAE,OAAO,GAAG,IAAI,CAAA;IACxB,aAAa,CAAC,EAAE,MAAM,EAAE,CAAA;CACzB,CAAA"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/apis/roles/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAA;AACjD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAA;AAEtD;;GAEG;AACH,MAAM,MAAM,IAAI,GAAG;IACjB,EAAE,EAAE,MAAM,CAAA;IACV,WAAW,EAAE,MAAM,CAAA;IACnB,OAAO,EAAE,OAAO,GAAG,IAAI,CAAA;IACvB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,6DAA6D;IAC7D,UAAU,CAAC,EAAE,MAAM,CAAA;IAEnB,WAAW,CAAC,EAAE,UAAU,EAAE,CAAA;CAC3B,CAAA;AAED,MAAM,MAAM,iBAAiB,GAAG,aAAa,CAAA;AAE7C;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GAAG,MAAM,GAAG;IAAE,EAAE,EAAE,MAAM,CAAA;CAAE,CAAA;AAEvD,MAAM,MAAM,iBAAiB,GAAG;IAC9B,2DAA2D;IAC3D,WAAW,EAAE,MAAM,CAAA;IACnB,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,WAAW,CAAC,EAAE,iBAAiB,EAAE,CAAA;CAClC,CAAA;AAED,MAAM,MAAM,iBAAiB,GAAG;IAC9B,0EAA0E;IAC1E,WAAW,EAAE,MAAM,CAAA;IACnB,OAAO,CAAC,EAAE,OAAO,GAAG,IAAI,CAAA;IACxB,2EAA2E;IAC3E,WAAW,CAAC,EAAE,iBAAiB,EAAE,CAAA;CAClC,CAAA;AAED,uFAAuF;AACvF,MAAM,MAAM,cAAc,GAAG,SAAS,CAAC,IAAI,CAAC,GAAG;IAC7C,uDAAuD;IACvD,aAAa,CAAC,EAAE,YAAY,EAAE,CAAA;IAC9B,uDAAuD;IACvD,gBAAgB,CAAC,EAAE,KAAK,GAAG,QAAQ,GAAG,UAAU,CAAA;CACjD,CAAA"}

package/dist/apis/terms/TermsApi.cjs

@@ -11,7 +11,10 @@ const require_core_BaseApi = require('../../core/BaseApi.cjs');
 */
 var TermsApi = class extends require_core_BaseApi.BaseApi {
 	basePath = "/terms";
-	/** Returns a single term by its ID, scoped to the current account (`null` when not found). */
+	/**
+	* Returns a single term by its ID, scoped to the current account. When it does not exist the
+	* backend answers 200 with an empty body, which resolves to `undefined`.
+	*/
 	getById(id, query, headers) {
 		const queryString = this.toQueryString(query);
 		return this.client.get(`${this.basePath}/${id}${queryString}`, headers);

package/dist/apis/terms/TermsApi.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"TermsApi.cjs","names":["BaseApi"],"sources":["../../../src/apis/terms/TermsApi.ts"],"sourcesContent":["import { BaseApi } from '../../core/BaseApi'\nimport type { GetByIdQuery, HasGetById } from '../../core/types'\nimport type { Term } from './types'\n\n/**\n * Platform terms of use. Terms are published by Agnus (billing) and accepted by the account users,\n * so the `/terms` route has no create/list/update/delete — only the routes below.\n *\n * `GET /terms/:id/export-pdf` is not exposed: it answers a binary PDF, and `ApiClient` only\n * handles JSON/text bodies.\n */\nexport class TermsApi extends BaseApi implements HasGetById<Term> {\n  public readonly basePath = '/terms'\n\n  /** Returns a single term by its ID, scoped to the current account (`null` when not found). */\n  getById(id: string, query?: GetByIdQuery<Term>, headers?: Record<string, string>): Promise<Term> {\n    const queryString = this.toQueryString(query)\n    return this.client.get<Term>(`${this.basePath}/${id}${queryString}`, headers)\n  }\n\n  /**\n   * Returns the terms of the current account that were not agreed to yet (`agreementDate` null).\n   * The backend answers a plain array (not paginated) and ignores query parameters.\n   */\n  getNotAgreed(headers?: Record<string, string>): Promise<Term[]> {\n    return this.client.get<Term[]>(`${this.basePath}/terms-not-agreed`, headers)\n  }\n\n  /**\n   * Agrees to the given terms on behalf of the authenticated user. IRREVERSIBLE: the acceptance is\n   * registered on Agnus, the terms get `agreementDate`/`userId`, and the signed PDFs are e-mailed\n   * to the user. Only terms of the current account are affected.\n   *\n   * The response is passed through from Agnus as-is, so it is not typed.\n   */\n  agree(termIds: string[], headers?: Record<string, string>): Promise<unknown> {\n    return this.client.patch<unknown, { terms: string[] }>(\n      `${this.basePath}/agree`,\n      { terms: termIds },\n      headers,\n    )\n  }\n}\n"],"mappings":";;;;;;;;;;;AAWA,IAAa,WAAb,cAA8BA,6BAAoC;CAChE,AAAgB,WAAW;;CAG3B,QAAQ,IAAY,OAA4B,SAAiD;EAC/F,MAAM,cAAc,KAAK,cAAc,MAAM;AAC7C,SAAO,KAAK,OAAO,IAAU,GAAG,KAAK,SAAS,GAAG,KAAK,eAAe,QAAQ;;;;;;CAO/E,aAAa,SAAmD;AAC9D,SAAO,KAAK,OAAO,IAAY,GAAG,KAAK,SAAS,oBAAoB,QAAQ;;;;;;;;;CAU9E,MAAM,SAAmB,SAAoD;AAC3E,SAAO,KAAK,OAAO,MACjB,GAAG,KAAK,SAAS,SACjB,EAAE,OAAO,SAAS,EAClB,QACD"}
+{"version":3,"file":"TermsApi.cjs","names":["BaseApi"],"sources":["../../../src/apis/terms/TermsApi.ts"],"sourcesContent":["import { BaseApi } from '../../core/BaseApi'\nimport type { GetByIdQuery, HasGetById } from '../../core/types'\nimport type { Term } from './types'\n\n/**\n * Platform terms of use. Terms are published by Agnus (billing) and accepted by the account users,\n * so the `/terms` route has no create/list/update/delete — only the routes below.\n *\n * `GET /terms/:id/export-pdf` is not exposed: it answers a binary PDF, and `ApiClient` only\n * handles JSON/text bodies.\n */\nexport class TermsApi extends BaseApi implements HasGetById<Term> {\n  public readonly basePath = '/terms'\n\n  /**\n   * Returns a single term by its ID, scoped to the current account. When it does not exist the\n   * backend answers 200 with an empty body, which resolves to `undefined`.\n   */\n  getById(id: string, query?: GetByIdQuery<Term>, headers?: Record<string, string>): Promise<Term> {\n    const queryString = this.toQueryString(query)\n    return this.client.get<Term>(`${this.basePath}/${id}${queryString}`, headers)\n  }\n\n  /**\n   * Returns the terms of the current account that were not agreed to yet (`agreementDate` null).\n   * The backend answers a plain array (not paginated) and ignores query parameters.\n   */\n  getNotAgreed(headers?: Record<string, string>): Promise<Term[]> {\n    return this.client.get<Term[]>(`${this.basePath}/terms-not-agreed`, headers)\n  }\n\n  /**\n   * Agrees to the given terms on behalf of the authenticated user. IRREVERSIBLE: the acceptance is\n   * registered on Agnus, the terms get `agreementDate`/`userId`, and the signed PDFs are e-mailed\n   * to the user. Only terms of the current account are affected.\n   *\n   * The response is passed through from Agnus as-is, so it is not typed.\n   */\n  agree(termIds: string[], headers?: Record<string, string>): Promise<unknown> {\n    return this.client.patch<unknown, { terms: string[] }>(\n      `${this.basePath}/agree`,\n      { terms: termIds },\n      headers,\n    )\n  }\n}\n"],"mappings":";;;;;;;;;;;AAWA,IAAa,WAAb,cAA8BA,6BAAoC;CAChE,AAAgB,WAAW;;;;;CAM3B,QAAQ,IAAY,OAA4B,SAAiD;EAC/F,MAAM,cAAc,KAAK,cAAc,MAAM;AAC7C,SAAO,KAAK,OAAO,IAAU,GAAG,KAAK,SAAS,GAAG,KAAK,eAAe,QAAQ;;;;;;CAO/E,aAAa,SAAmD;AAC9D,SAAO,KAAK,OAAO,IAAY,GAAG,KAAK,SAAS,oBAAoB,QAAQ;;;;;;;;;CAU9E,MAAM,SAAmB,SAAoD;AAC3E,SAAO,KAAK,OAAO,MACjB,GAAG,KAAK,SAAS,SACjB,EAAE,OAAO,SAAS,EAClB,QACD"}

package/dist/apis/terms/TermsApi.d.ts

@@ -10,7 +10,10 @@ import type { Term } from './types';
  */
 export declare class TermsApi extends BaseApi implements HasGetById<Term> {
     readonly basePath = "/terms";
-    /** Returns a single term by its ID, scoped to the current account (`null` when not found). */
+    /**
+     * Returns a single term by its ID, scoped to the current account. When it does not exist the
+     * backend answers 200 with an empty body, which resolves to `undefined`.
+     */
     getById(id: string, query?: GetByIdQuery<Term>, headers?: Record<string, string>): Promise<Term>;
     /**
      * Returns the terms of the current account that were not agreed to yet (`agreementDate` null).