@ikatec/digisac-api-sdk 4.5.1 → 4.7.0

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

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/apis/ticketTopics/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,WAAW,GAAG;IACxB,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,SAAS,EAAE,MAAM,CAAA;IACjB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;CACzB,CAAA;AAED,MAAM,MAAM,wBAAwB,GAAG;IACrC,IAAI,EAAE,MAAM,CAAA;CACb,CAAA;AAED,MAAM,MAAM,wBAAwB,GAAG;IACrC,IAAI,CAAC,EAAE,MAAM,CAAA;CACd,CAAA"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/apis/ticketTopics/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAA;AACjD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAA;AAEtD,MAAM,MAAM,WAAW,GAAG;IACxB,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,SAAS,EAAE,MAAM,CAAA;IACjB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IAExB,uGAAuG;IACvG,WAAW,CAAC,EAAE,UAAU,EAAE,CAAA;CAC3B,CAAA;AAED,MAAM,MAAM,wBAAwB,GAAG,aAAa,CAAA;AAEpD;;;GAGG;AACH,MAAM,MAAM,oBAAoB,GAAG,SAAS,CAAC,WAAW,CAAC,GAAG;IAC1D,iDAAiD;IACjD,aAAa,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACjC,sGAAsG;IACtG,mBAAmB,CAAC,EAAE,OAAO,CAAA;CAC9B,CAAA;AAED,MAAM,MAAM,wBAAwB,GAAG;IACrC,uFAAuF;IACvF,IAAI,EAAE,MAAM,CAAA;IACZ,6GAA6G;IAC7G,WAAW,EAAE,MAAM,EAAE,CAAA;CACtB,CAAA;AAED,MAAM,MAAM,wBAAwB,GAAG;IACrC,8BAA8B;IAC9B,IAAI,EAAE,MAAM,CAAA;IACZ,sEAAsE;IACtE,WAAW,CAAC,EAAE,MAAM,EAAE,CAAA;CACvB,CAAA"}

package/dist/apis/tickets/TicketsApi.cjs

@@ -2,21 +2,94 @@ Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 const require_core_BaseCrudApi = require('../../core/BaseCrudApi.cjs');
 
 //#region src/apis/tickets/TicketsApi.ts
+/**
+* Tickets. The backend only serves them for reading (`getMany`, `getOne`, `getById`, the counts,
+* the first waiting time and the exports) plus `closeMany`: a ticket is opened and transferred by
+* `ContactsApi.transferTicket`. The reads check no permission (any authenticated user): the
+* `@permissions` of the inherited `getMany`, `getOne` and `getById` do not apply here. `getById`
+* of an unknown id resolves `null`. For a user who is not an admin, `getMany` leaves out the
+* tickets of the contacts of the connections restricted to that user; the counts and `getById`
+* do not.
+*/
 var TicketsApi = class extends require_core_BaseCrudApi.BaseCrudApi {
 	constructor(client) {
 		super(client, "/tickets");
 	}
+	/** @deprecated Not served: `POST /tickets` answers 404 `Route not found.`. Open a ticket through `ContactsApi.transferTicket`. */
+	create(body, headers) {
+		return super.create(body, headers);
+	}
+	/** @deprecated Not served: `PUT /tickets/{id}` answers 404 `Route not found.`. Transfer through `ContactsApi.transferTicket`, close through `closeMany`. */
+	updateById(id, body, headers) {
+		return super.updateById(id, body, headers);
+	}
+	/** @deprecated Not served: `DELETE /tickets/{id}` answers 404 `Route not found.`. */
+	deleteById(id, headers) {
+		return super.deleteById(id, headers);
+	}
 	/**
 	* Closes multiple tickets in a single request. This is the only ticket-close
 	* endpoint exposed by the API — there is no per-ticket close/update route.
 	*
 	* Pass `{ ids }` to close specific tickets, or `{ allContactsSelected: true, query }`
-	* to close every OPEN ticket matching `query` (the backend forces `isOpen: true`).
+	* to close every OPEN ticket matching `query` (the backend forces `isOpen: true`): an empty
+	* `where` closes every open ticket of the account. The answer has no body. Ids of closed,
+	* unknown or other accounts' tickets are skipped in silence; no id and no
+	* `allContactsSelected` answers 400 `ids not found`.
 	* @permissions tickets.close.all OR tickets.close.me
 	*/
 	closeMany(payload, headers) {
 		return this.client.put(`${this.basePath}/close-many`, payload, headers);
 	}
+	count(query, headers) {
+		return this.client.get(`${this.basePath}/count${this.toQueryString(query)}`, headers);
+	}
+	countPost(body, headers) {
+		return this.client.post(`${this.basePath}/count`, body, headers);
+	}
+	/** Counts the open tickets of the contacts of a connection. An unknown id counts 0. */
+	countOpenByService(serviceId, headers) {
+		return this.client.get(`${this.basePath}/count-open/${serviceId}`, headers);
+	}
+	/** Counts the open tickets of a department. An unknown id counts 0. */
+	countOpenByDepartment(departmentId, headers) {
+		return this.client.get(`${this.basePath}/count-open-by-department/${departmentId}`, headers);
+	}
+	/** Counts the open tickets assigned to a user. An unknown id counts 0. */
+	countOpenByUser(userId, headers) {
+		return this.client.get(`${this.basePath}/count-open-by-user/${userId}`, headers);
+	}
+	/**
+	* The first waiting time of the ticket (`metrics.waitingTime`) as `HH:mm:ss`; `'00:00:00'` while
+	* it was not measured. The hours wrap every 24 h (a wait of 25 h answers `'01:00:00'`): read
+	* `metrics.waitingTime` (seconds) for the full value. An unknown id answers 500.
+	*/
+	getFirstWaitingTime(id, headers) {
+		return this.client.get(`${this.basePath}/${id}/first-waiting-time`, headers);
+	}
+	/**
+	* Exports the conversation of a ticket as text, by its protocol (contact, attendants, subjects,
+	* summary, dates and the messages without the internal comments), sent as the attachment
+	* `<protocol>.txt` (Content-Type `plain/text`). Without a protocol the body is empty
+	* (`undefined`); an unknown protocol never answers.
+	*/
+	exportTxt(protocol, headers) {
+		return this.client.post(`${this.basePath}/export`, { protocol }, headers);
+	}
+	/**
+	* Exports the tickets matching the query as CSV (`;`, a header of 20 columns in the language of
+	* the user, dates in the timezone of the account), streamed without a Content-Type.
+	*
+	* The query must include `contact` with its `service` (the History screen also includes
+	* `contact.tags`, `contact.person`, `user`, `department`, `ticketTopics` and `firstMessage`),
+	* and `order` must name unambiguous columns (e.g. `startedAt`): when a row fails after the header
+	* is sent, the answer never ends. Leave `page` out: the route pages through every match itself
+	* (`perPage` only sets the size of each batch), and a `page` in the query is read on every
+	* batch, so its rows are repeated or the CSV comes with the header only.
+	*/
+	exportHistory(query, headers) {
+		return this.client.post(`${this.basePath}/export-history${this.toQueryString(query)}`, void 0, headers);
+	}
 };
 
 //#endregion

package/dist/apis/tickets/TicketsApi.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"TicketsApi.cjs","names":["BaseCrudApi"],"sources":["../../../src/apis/tickets/TicketsApi.ts"],"sourcesContent":["import type { ApiClient } from '../../core/ApiClient'\nimport { BaseCrudApi } from '../../core/BaseCrudApi'\nimport type {\n  Ticket,\n  CreateTicketPayload,\n  UpdateTicketPayload,\n  CloseManyTicketsPayload,\n} from './types'\n\nexport class TicketsApi extends BaseCrudApi<Ticket, CreateTicketPayload, UpdateTicketPayload> {\n  constructor(client: ApiClient) {\n    super(client, '/tickets')\n  }\n\n  /**\n   * Closes multiple tickets in a single request. This is the only ticket-close\n   * endpoint exposed by the API — there is no per-ticket close/update route.\n   *\n   * Pass `{ ids }` to close specific tickets, or `{ allContactsSelected: true, query }`\n   * to close every OPEN ticket matching `query` (the backend forces `isOpen: true`).\n   * @permissions tickets.close.all OR tickets.close.me\n   */\n  closeMany(payload: CloseManyTicketsPayload, headers?: Record<string, string>): Promise<unknown> {\n    return this.client.put<unknown, CloseManyTicketsPayload>(\n      `${this.basePath}/close-many`,\n      payload,\n      headers,\n    )\n  }\n}\n"],"mappings":";;;;AASA,IAAa,aAAb,cAAgCA,qCAA8D;CAC5F,YAAY,QAAmB;AAC7B,QAAM,QAAQ,WAAW;;;;;;;;;;CAW3B,UAAU,SAAkC,SAAoD;AAC9F,SAAO,KAAK,OAAO,IACjB,GAAG,KAAK,SAAS,cACjB,SACA,QACD"}
+{"version":3,"file":"TicketsApi.cjs","names":["BaseCrudApi"],"sources":["../../../src/apis/tickets/TicketsApi.ts"],"sourcesContent":["import type { ApiClient } from '../../core/ApiClient'\nimport { BaseCrudApi } from '../../core/BaseCrudApi'\nimport type {\n  Ticket,\n  CreateTicketPayload,\n  UpdateTicketPayload,\n  CloseManyTicketsPayload,\n  TicketsCount,\n  TicketsCountManyQuery,\n  TicketsCountPostPayload,\n  TicketsCounts,\n  TicketsListQuery,\n} from './types'\n\n/**\n * Tickets. The backend only serves them for reading (`getMany`, `getOne`, `getById`, the counts,\n * the first waiting time and the exports) plus `closeMany`: a ticket is opened and transferred by\n * `ContactsApi.transferTicket`. The reads check no permission (any authenticated user): the\n * `@permissions` of the inherited `getMany`, `getOne` and `getById` do not apply here. `getById`\n * of an unknown id resolves `null`. For a user who is not an admin, `getMany` leaves out the\n * tickets of the contacts of the connections restricted to that user; the counts and `getById`\n * do not.\n */\nexport class TicketsApi extends BaseCrudApi<Ticket, CreateTicketPayload, UpdateTicketPayload> {\n  constructor(client: ApiClient) {\n    super(client, '/tickets')\n  }\n\n  /** @deprecated Not served: `POST /tickets` answers 404 `Route not found.`. Open a ticket through `ContactsApi.transferTicket`. */\n  override create(body: CreateTicketPayload, headers?: Record<string, string>): Promise<Ticket> {\n    return super.create(body, headers)\n  }\n\n  /** @deprecated Not served: `PUT /tickets/{id}` answers 404 `Route not found.`. Transfer through `ContactsApi.transferTicket`, close through `closeMany`. */\n  override updateById(\n    id: string,\n    body: UpdateTicketPayload,\n    headers?: Record<string, string>,\n  ): Promise<Ticket> {\n    return super.updateById(id, body, headers)\n  }\n\n  /** @deprecated Not served: `DELETE /tickets/{id}` answers 404 `Route not found.`. */\n  override deleteById(id: string, headers?: Record<string, string>): Promise<Ticket> {\n    return super.deleteById(id, headers)\n  }\n\n  /**\n   * Closes multiple tickets in a single request. This is the only ticket-close\n   * endpoint exposed by the API — there is no per-ticket close/update route.\n   *\n   * Pass `{ ids }` to close specific tickets, or `{ allContactsSelected: true, query }`\n   * to close every OPEN ticket matching `query` (the backend forces `isOpen: true`): an empty\n   * `where` closes every open ticket of the account. The answer has no body. Ids of closed,\n   * unknown or other accounts' tickets are skipped in silence; no id and no\n   * `allContactsSelected` answers 400 `ids not found`.\n   * @permissions tickets.close.all OR tickets.close.me\n   */\n  closeMany(payload: CloseManyTicketsPayload, headers?: Record<string, string>): Promise<void> {\n    return this.client.put<void, CloseManyTicketsPayload>(\n      `${this.basePath}/close-many`,\n      payload,\n      headers,\n    )\n  }\n\n  /**\n   * Counts the tickets matching the query. With `queries`, answers one count per query, in the\n   * same order (the root filters are then ignored).\n   */\n  count(query: TicketsCountManyQuery, headers?: Record<string, string>): Promise<TicketsCounts>\n  count(query?: TicketsListQuery, headers?: Record<string, string>): Promise<TicketsCount>\n  count(\n    query?: TicketsListQuery | TicketsCountManyQuery,\n    headers?: Record<string, string>,\n  ): Promise<TicketsCount | TicketsCounts> {\n    return this.client.get<TicketsCount | TicketsCounts>(\n      `${this.basePath}/count${this.toQueryString(query)}`,\n      headers,\n    )\n  }\n\n  /**\n   * POST variant of `count`, for queries too long for the URL. See {@link TicketsCountPostPayload}:\n   * `query` is required.\n   */\n  countPost(\n    body: TicketsCountPostPayload & { query: { queries: TicketsListQuery[] } },\n    headers?: Record<string, string>,\n  ): Promise<TicketsCounts>\n  countPost(body: TicketsCountPostPayload, headers?: Record<string, string>): Promise<TicketsCount>\n  countPost(\n    body: TicketsCountPostPayload,\n    headers?: Record<string, string>,\n  ): Promise<TicketsCount | TicketsCounts> {\n    return this.client.post<TicketsCount | TicketsCounts, TicketsCountPostPayload>(\n      `${this.basePath}/count`,\n      body,\n      headers,\n    )\n  }\n\n  /** Counts the open tickets of the contacts of a connection. An unknown id counts 0. */\n  countOpenByService(serviceId: string, headers?: Record<string, string>): Promise<number> {\n    return this.client.get<number>(`${this.basePath}/count-open/${serviceId}`, headers)\n  }\n\n  /** Counts the open tickets of a department. An unknown id counts 0. */\n  countOpenByDepartment(departmentId: string, headers?: Record<string, string>): Promise<number> {\n    return this.client.get<number>(\n      `${this.basePath}/count-open-by-department/${departmentId}`,\n      headers,\n    )\n  }\n\n  /** Counts the open tickets assigned to a user. An unknown id counts 0. */\n  countOpenByUser(userId: string, headers?: Record<string, string>): Promise<number> {\n    return this.client.get<number>(`${this.basePath}/count-open-by-user/${userId}`, headers)\n  }\n\n  /**\n   * The first waiting time of the ticket (`metrics.waitingTime`) as `HH:mm:ss`; `'00:00:00'` while\n   * it was not measured. The hours wrap every 24 h (a wait of 25 h answers `'01:00:00'`): read\n   * `metrics.waitingTime` (seconds) for the full value. An unknown id answers 500.\n   */\n  getFirstWaitingTime(id: string, headers?: Record<string, string>): Promise<string> {\n    return this.client.get<string>(`${this.basePath}/${id}/first-waiting-time`, headers)\n  }\n\n  /**\n   * Exports the conversation of a ticket as text, by its protocol (contact, attendants, subjects,\n   * summary, dates and the messages without the internal comments), sent as the attachment\n   * `<protocol>.txt` (Content-Type `plain/text`). Without a protocol the body is empty\n   * (`undefined`); an unknown protocol never answers.\n   */\n  exportTxt(protocol: string, headers?: Record<string, string>): Promise<string> {\n    return this.client.post<string, { protocol: string }>(\n      `${this.basePath}/export`,\n      { protocol },\n      headers,\n    )\n  }\n\n  /**\n   * Exports the tickets matching the query as CSV (`;`, a header of 20 columns in the language of\n   * the user, dates in the timezone of the account), streamed without a Content-Type.\n   *\n   * The query must include `contact` with its `service` (the History screen also includes\n   * `contact.tags`, `contact.person`, `user`, `department`, `ticketTopics` and `firstMessage`),\n   * and `order` must name unambiguous columns (e.g. `startedAt`): when a row fails after the header\n   * is sent, the answer never ends. Leave `page` out: the route pages through every match itself\n   * (`perPage` only sets the size of each batch), and a `page` in the query is read on every\n   * batch, so its rows are repeated or the CSV comes with the header only.\n   */\n  exportHistory(query: TicketsListQuery, headers?: Record<string, string>): Promise<string> {\n    return this.client.post<string>(\n      `${this.basePath}/export-history${this.toQueryString(query)}`,\n      undefined,\n      headers,\n    )\n  }\n}\n"],"mappings":";;;;;;;;;;;;;AAuBA,IAAa,aAAb,cAAgCA,qCAA8D;CAC5F,YAAY,QAAmB;AAC7B,QAAM,QAAQ,WAAW;;;CAI3B,AAAS,OAAO,MAA2B,SAAmD;AAC5F,SAAO,MAAM,OAAO,MAAM,QAAQ;;;CAIpC,AAAS,WACP,IACA,MACA,SACiB;AACjB,SAAO,MAAM,WAAW,IAAI,MAAM,QAAQ;;;CAI5C,AAAS,WAAW,IAAY,SAAmD;AACjF,SAAO,MAAM,WAAW,IAAI,QAAQ;;;;;;;;;;;;;CActC,UAAU,SAAkC,SAAiD;AAC3F,SAAO,KAAK,OAAO,IACjB,GAAG,KAAK,SAAS,cACjB,SACA,QACD;;CASH,MACE,OACA,SACuC;AACvC,SAAO,KAAK,OAAO,IACjB,GAAG,KAAK,SAAS,QAAQ,KAAK,cAAc,MAAM,IAClD,QACD;;CAYH,UACE,MACA,SACuC;AACvC,SAAO,KAAK,OAAO,KACjB,GAAG,KAAK,SAAS,SACjB,MACA,QACD;;;CAIH,mBAAmB,WAAmB,SAAmD;AACvF,SAAO,KAAK,OAAO,IAAY,GAAG,KAAK,SAAS,cAAc,aAAa,QAAQ;;;CAIrF,sBAAsB,cAAsB,SAAmD;AAC7F,SAAO,KAAK,OAAO,IACjB,GAAG,KAAK,SAAS,4BAA4B,gBAC7C,QACD;;;CAIH,gBAAgB,QAAgB,SAAmD;AACjF,SAAO,KAAK,OAAO,IAAY,GAAG,KAAK,SAAS,sBAAsB,UAAU,QAAQ;;;;;;;CAQ1F,oBAAoB,IAAY,SAAmD;AACjF,SAAO,KAAK,OAAO,IAAY,GAAG,KAAK,SAAS,GAAG,GAAG,sBAAsB,QAAQ;;;;;;;;CAStF,UAAU,UAAkB,SAAmD;AAC7E,SAAO,KAAK,OAAO,KACjB,GAAG,KAAK,SAAS,UACjB,EAAE,UAAU,EACZ,QACD;;;;;;;;;;;;;CAcH,cAAc,OAAyB,SAAmD;AACxF,SAAO,KAAK,OAAO,KACjB,GAAG,KAAK,SAAS,iBAAiB,KAAK,cAAc,MAAM,IAC3D,QACA,QACD"}

package/dist/apis/tickets/TicketsApi.d.ts

@@ -1,16 +1,81 @@
 import type { ApiClient } from '../../core/ApiClient';
 import { BaseCrudApi } from '../../core/BaseCrudApi';
-import type { Ticket, CreateTicketPayload, UpdateTicketPayload, CloseManyTicketsPayload } from './types';
+import type { Ticket, CreateTicketPayload, UpdateTicketPayload, CloseManyTicketsPayload, TicketsCount, TicketsCountManyQuery, TicketsCountPostPayload, TicketsCounts, TicketsListQuery } from './types';
+/**
+ * Tickets. The backend only serves them for reading (`getMany`, `getOne`, `getById`, the counts,
+ * the first waiting time and the exports) plus `closeMany`: a ticket is opened and transferred by
+ * `ContactsApi.transferTicket`. The reads check no permission (any authenticated user): the
+ * `@permissions` of the inherited `getMany`, `getOne` and `getById` do not apply here. `getById`
+ * of an unknown id resolves `null`. For a user who is not an admin, `getMany` leaves out the
+ * tickets of the contacts of the connections restricted to that user; the counts and `getById`
+ * do not.
+ */
 export declare class TicketsApi extends BaseCrudApi<Ticket, CreateTicketPayload, UpdateTicketPayload> {
     constructor(client: ApiClient);
+    /** @deprecated Not served: `POST /tickets` answers 404 `Route not found.`. Open a ticket through `ContactsApi.transferTicket`. */
+    create(body: CreateTicketPayload, headers?: Record<string, string>): Promise<Ticket>;
+    /** @deprecated Not served: `PUT /tickets/{id}` answers 404 `Route not found.`. Transfer through `ContactsApi.transferTicket`, close through `closeMany`. */
+    updateById(id: string, body: UpdateTicketPayload, headers?: Record<string, string>): Promise<Ticket>;
+    /** @deprecated Not served: `DELETE /tickets/{id}` answers 404 `Route not found.`. */
+    deleteById(id: string, headers?: Record<string, string>): Promise<Ticket>;
     /**
      * Closes multiple tickets in a single request. This is the only ticket-close
      * endpoint exposed by the API — there is no per-ticket close/update route.
      *
      * Pass `{ ids }` to close specific tickets, or `{ allContactsSelected: true, query }`
-     * to close every OPEN ticket matching `query` (the backend forces `isOpen: true`).
+     * to close every OPEN ticket matching `query` (the backend forces `isOpen: true`): an empty
+     * `where` closes every open ticket of the account. The answer has no body. Ids of closed,
+     * unknown or other accounts' tickets are skipped in silence; no id and no
+     * `allContactsSelected` answers 400 `ids not found`.
      * @permissions tickets.close.all OR tickets.close.me
      */
-    closeMany(payload: CloseManyTicketsPayload, headers?: Record<string, string>): Promise<unknown>;
+    closeMany(payload: CloseManyTicketsPayload, headers?: Record<string, string>): Promise<void>;
+    /**
+     * Counts the tickets matching the query. With `queries`, answers one count per query, in the
+     * same order (the root filters are then ignored).
+     */
+    count(query: TicketsCountManyQuery, headers?: Record<string, string>): Promise<TicketsCounts>;
+    count(query?: TicketsListQuery, headers?: Record<string, string>): Promise<TicketsCount>;
+    /**
+     * POST variant of `count`, for queries too long for the URL. See {@link TicketsCountPostPayload}:
+     * `query` is required.
+     */
+    countPost(body: TicketsCountPostPayload & {
+        query: {
+            queries: TicketsListQuery[];
+        };
+    }, headers?: Record<string, string>): Promise<TicketsCounts>;
+    countPost(body: TicketsCountPostPayload, headers?: Record<string, string>): Promise<TicketsCount>;
+    /** Counts the open tickets of the contacts of a connection. An unknown id counts 0. */
+    countOpenByService(serviceId: string, headers?: Record<string, string>): Promise<number>;
+    /** Counts the open tickets of a department. An unknown id counts 0. */
+    countOpenByDepartment(departmentId: string, headers?: Record<string, string>): Promise<number>;
+    /** Counts the open tickets assigned to a user. An unknown id counts 0. */
+    countOpenByUser(userId: string, headers?: Record<string, string>): Promise<number>;
+    /**
+     * The first waiting time of the ticket (`metrics.waitingTime`) as `HH:mm:ss`; `'00:00:00'` while
+     * it was not measured. The hours wrap every 24 h (a wait of 25 h answers `'01:00:00'`): read
+     * `metrics.waitingTime` (seconds) for the full value. An unknown id answers 500.
+     */
+    getFirstWaitingTime(id: string, headers?: Record<string, string>): Promise<string>;
+    /**
+     * Exports the conversation of a ticket as text, by its protocol (contact, attendants, subjects,
+     * summary, dates and the messages without the internal comments), sent as the attachment
+     * `<protocol>.txt` (Content-Type `plain/text`). Without a protocol the body is empty
+     * (`undefined`); an unknown protocol never answers.
+     */
+    exportTxt(protocol: string, headers?: Record<string, string>): Promise<string>;
+    /**
+     * Exports the tickets matching the query as CSV (`;`, a header of 20 columns in the language of
+     * the user, dates in the timezone of the account), streamed without a Content-Type.
+     *
+     * The query must include `contact` with its `service` (the History screen also includes
+     * `contact.tags`, `contact.person`, `user`, `department`, `ticketTopics` and `firstMessage`),
+     * and `order` must name unambiguous columns (e.g. `startedAt`): when a row fails after the header
+     * is sent, the answer never ends. Leave `page` out: the route pages through every match itself
+     * (`perPage` only sets the size of each batch), and a `page` in the query is read on every
+     * batch, so its rows are repeated or the CSV comes with the header only.
+     */
+    exportHistory(query: TicketsListQuery, headers?: Record<string, string>): Promise<string>;
 }
 //# sourceMappingURL=TicketsApi.d.ts.map

package/dist/apis/tickets/TicketsApi.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"TicketsApi.d.ts","sourceRoot":"","sources":["../../../src/apis/tickets/TicketsApi.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAA;AACrD,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAA;AACpD,OAAO,KAAK,EACV,MAAM,EACN,mBAAmB,EACnB,mBAAmB,EACnB,uBAAuB,EACxB,MAAM,SAAS,CAAA;AAEhB,qBAAa,UAAW,SAAQ,WAAW,CAAC,MAAM,EAAE,mBAAmB,EAAE,mBAAmB,CAAC;gBAC/E,MAAM,EAAE,SAAS;IAI7B;;;;;;;OAOG;IACH,SAAS,CAAC,OAAO,EAAE,uBAAuB,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC;CAOhG"}
+{"version":3,"file":"TicketsApi.d.ts","sourceRoot":"","sources":["../../../src/apis/tickets/TicketsApi.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAA;AACrD,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAA;AACpD,OAAO,KAAK,EACV,MAAM,EACN,mBAAmB,EACnB,mBAAmB,EACnB,uBAAuB,EACvB,YAAY,EACZ,qBAAqB,EACrB,uBAAuB,EACvB,aAAa,EACb,gBAAgB,EACjB,MAAM,SAAS,CAAA;AAEhB;;;;;;;;GAQG;AACH,qBAAa,UAAW,SAAQ,WAAW,CAAC,MAAM,EAAE,mBAAmB,EAAE,mBAAmB,CAAC;gBAC/E,MAAM,EAAE,SAAS;IAI7B,kIAAkI;IACzH,MAAM,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC;IAI7F,4JAA4J;IACnJ,UAAU,CACjB,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,mBAAmB,EACzB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,MAAM,CAAC;IAIlB,qFAAqF;IAC5E,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC;IAIlF;;;;;;;;;;OAUG;IACH,SAAS,CAAC,OAAO,EAAE,uBAAuB,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAQ5F;;;OAGG;IACH,KAAK,CAAC,KAAK,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,aAAa,CAAC;IAC7F,KAAK,CAAC,KAAK,CAAC,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,YAAY,CAAC;IAWxF;;;OAGG;IACH,SAAS,CACP,IAAI,EAAE,uBAAuB,GAAG;QAAE,KAAK,EAAE;YAAE,OAAO,EAAE,gBAAgB,EAAE,CAAA;SAAE,CAAA;KAAE,EAC1E,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,aAAa,CAAC;IACzB,SAAS,CAAC,IAAI,EAAE,uBAAuB,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,YAAY,CAAC;IAYjG,uFAAuF;IACvF,kBAAkB,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC;IAIxF,uEAAuE;IACvE,qBAAqB,CAAC,YAAY,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC;IAO9F,0EAA0E;IAC1E,eAAe,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC;IAIlF;;;;OAIG;IACH,mBAAmB,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC;IAIlF;;;;;OAKG;IACH,SAAS,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC;IAQ9E;;;;;;;;;;OAUG;IACH,aAAa,CAAC,KAAK,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC;CAO1F"}

package/dist/apis/tickets/TicketsApi.mjs

@@ -1,21 +1,94 @@
 import { BaseCrudApi } from "../../core/BaseCrudApi.mjs";
 
 //#region src/apis/tickets/TicketsApi.ts
+/**
+* Tickets. The backend only serves them for reading (`getMany`, `getOne`, `getById`, the counts,
+* the first waiting time and the exports) plus `closeMany`: a ticket is opened and transferred by
+* `ContactsApi.transferTicket`. The reads check no permission (any authenticated user): the
+* `@permissions` of the inherited `getMany`, `getOne` and `getById` do not apply here. `getById`
+* of an unknown id resolves `null`. For a user who is not an admin, `getMany` leaves out the
+* tickets of the contacts of the connections restricted to that user; the counts and `getById`
+* do not.
+*/
 var TicketsApi = class extends BaseCrudApi {
 	constructor(client) {
 		super(client, "/tickets");
 	}
+	/** @deprecated Not served: `POST /tickets` answers 404 `Route not found.`. Open a ticket through `ContactsApi.transferTicket`. */
+	create(body, headers) {
+		return super.create(body, headers);
+	}
+	/** @deprecated Not served: `PUT /tickets/{id}` answers 404 `Route not found.`. Transfer through `ContactsApi.transferTicket`, close through `closeMany`. */
+	updateById(id, body, headers) {
+		return super.updateById(id, body, headers);
+	}
+	/** @deprecated Not served: `DELETE /tickets/{id}` answers 404 `Route not found.`. */
+	deleteById(id, headers) {
+		return super.deleteById(id, headers);
+	}
 	/**
 	* Closes multiple tickets in a single request. This is the only ticket-close
 	* endpoint exposed by the API — there is no per-ticket close/update route.
 	*
 	* Pass `{ ids }` to close specific tickets, or `{ allContactsSelected: true, query }`
-	* to close every OPEN ticket matching `query` (the backend forces `isOpen: true`).
+	* to close every OPEN ticket matching `query` (the backend forces `isOpen: true`): an empty
+	* `where` closes every open ticket of the account. The answer has no body. Ids of closed,
+	* unknown or other accounts' tickets are skipped in silence; no id and no
+	* `allContactsSelected` answers 400 `ids not found`.
 	* @permissions tickets.close.all OR tickets.close.me
 	*/
 	closeMany(payload, headers) {
 		return this.client.put(`${this.basePath}/close-many`, payload, headers);
 	}
+	count(query, headers) {
+		return this.client.get(`${this.basePath}/count${this.toQueryString(query)}`, headers);
+	}
+	countPost(body, headers) {
+		return this.client.post(`${this.basePath}/count`, body, headers);
+	}
+	/** Counts the open tickets of the contacts of a connection. An unknown id counts 0. */
+	countOpenByService(serviceId, headers) {
+		return this.client.get(`${this.basePath}/count-open/${serviceId}`, headers);
+	}
+	/** Counts the open tickets of a department. An unknown id counts 0. */
+	countOpenByDepartment(departmentId, headers) {
+		return this.client.get(`${this.basePath}/count-open-by-department/${departmentId}`, headers);
+	}
+	/** Counts the open tickets assigned to a user. An unknown id counts 0. */
+	countOpenByUser(userId, headers) {
+		return this.client.get(`${this.basePath}/count-open-by-user/${userId}`, headers);
+	}
+	/**
+	* The first waiting time of the ticket (`metrics.waitingTime`) as `HH:mm:ss`; `'00:00:00'` while
+	* it was not measured. The hours wrap every 24 h (a wait of 25 h answers `'01:00:00'`): read
+	* `metrics.waitingTime` (seconds) for the full value. An unknown id answers 500.
+	*/
+	getFirstWaitingTime(id, headers) {
+		return this.client.get(`${this.basePath}/${id}/first-waiting-time`, headers);
+	}
+	/**
+	* Exports the conversation of a ticket as text, by its protocol (contact, attendants, subjects,
+	* summary, dates and the messages without the internal comments), sent as the attachment
+	* `<protocol>.txt` (Content-Type `plain/text`). Without a protocol the body is empty
+	* (`undefined`); an unknown protocol never answers.
+	*/
+	exportTxt(protocol, headers) {
+		return this.client.post(`${this.basePath}/export`, { protocol }, headers);
+	}
+	/**
+	* Exports the tickets matching the query as CSV (`;`, a header of 20 columns in the language of
+	* the user, dates in the timezone of the account), streamed without a Content-Type.
+	*
+	* The query must include `contact` with its `service` (the History screen also includes
+	* `contact.tags`, `contact.person`, `user`, `department`, `ticketTopics` and `firstMessage`),
+	* and `order` must name unambiguous columns (e.g. `startedAt`): when a row fails after the header
+	* is sent, the answer never ends. Leave `page` out: the route pages through every match itself
+	* (`perPage` only sets the size of each batch), and a `page` in the query is read on every
+	* batch, so its rows are repeated or the CSV comes with the header only.
+	*/
+	exportHistory(query, headers) {
+		return this.client.post(`${this.basePath}/export-history${this.toQueryString(query)}`, void 0, headers);
+	}
 };
 
 //#endregion

package/dist/apis/tickets/TicketsApi.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"TicketsApi.mjs","names":[],"sources":["../../../src/apis/tickets/TicketsApi.ts"],"sourcesContent":["import type { ApiClient } from '../../core/ApiClient'\nimport { BaseCrudApi } from '../../core/BaseCrudApi'\nimport type {\n  Ticket,\n  CreateTicketPayload,\n  UpdateTicketPayload,\n  CloseManyTicketsPayload,\n} from './types'\n\nexport class TicketsApi extends BaseCrudApi<Ticket, CreateTicketPayload, UpdateTicketPayload> {\n  constructor(client: ApiClient) {\n    super(client, '/tickets')\n  }\n\n  /**\n   * Closes multiple tickets in a single request. This is the only ticket-close\n   * endpoint exposed by the API — there is no per-ticket close/update route.\n   *\n   * Pass `{ ids }` to close specific tickets, or `{ allContactsSelected: true, query }`\n   * to close every OPEN ticket matching `query` (the backend forces `isOpen: true`).\n   * @permissions tickets.close.all OR tickets.close.me\n   */\n  closeMany(payload: CloseManyTicketsPayload, headers?: Record<string, string>): Promise<unknown> {\n    return this.client.put<unknown, CloseManyTicketsPayload>(\n      `${this.basePath}/close-many`,\n      payload,\n      headers,\n    )\n  }\n}\n"],"mappings":";;;AASA,IAAa,aAAb,cAAgC,YAA8D;CAC5F,YAAY,QAAmB;AAC7B,QAAM,QAAQ,WAAW;;;;;;;;;;CAW3B,UAAU,SAAkC,SAAoD;AAC9F,SAAO,KAAK,OAAO,IACjB,GAAG,KAAK,SAAS,cACjB,SACA,QACD"}
+{"version":3,"file":"TicketsApi.mjs","names":[],"sources":["../../../src/apis/tickets/TicketsApi.ts"],"sourcesContent":["import type { ApiClient } from '../../core/ApiClient'\nimport { BaseCrudApi } from '../../core/BaseCrudApi'\nimport type {\n  Ticket,\n  CreateTicketPayload,\n  UpdateTicketPayload,\n  CloseManyTicketsPayload,\n  TicketsCount,\n  TicketsCountManyQuery,\n  TicketsCountPostPayload,\n  TicketsCounts,\n  TicketsListQuery,\n} from './types'\n\n/**\n * Tickets. The backend only serves them for reading (`getMany`, `getOne`, `getById`, the counts,\n * the first waiting time and the exports) plus `closeMany`: a ticket is opened and transferred by\n * `ContactsApi.transferTicket`. The reads check no permission (any authenticated user): the\n * `@permissions` of the inherited `getMany`, `getOne` and `getById` do not apply here. `getById`\n * of an unknown id resolves `null`. For a user who is not an admin, `getMany` leaves out the\n * tickets of the contacts of the connections restricted to that user; the counts and `getById`\n * do not.\n */\nexport class TicketsApi extends BaseCrudApi<Ticket, CreateTicketPayload, UpdateTicketPayload> {\n  constructor(client: ApiClient) {\n    super(client, '/tickets')\n  }\n\n  /** @deprecated Not served: `POST /tickets` answers 404 `Route not found.`. Open a ticket through `ContactsApi.transferTicket`. */\n  override create(body: CreateTicketPayload, headers?: Record<string, string>): Promise<Ticket> {\n    return super.create(body, headers)\n  }\n\n  /** @deprecated Not served: `PUT /tickets/{id}` answers 404 `Route not found.`. Transfer through `ContactsApi.transferTicket`, close through `closeMany`. */\n  override updateById(\n    id: string,\n    body: UpdateTicketPayload,\n    headers?: Record<string, string>,\n  ): Promise<Ticket> {\n    return super.updateById(id, body, headers)\n  }\n\n  /** @deprecated Not served: `DELETE /tickets/{id}` answers 404 `Route not found.`. */\n  override deleteById(id: string, headers?: Record<string, string>): Promise<Ticket> {\n    return super.deleteById(id, headers)\n  }\n\n  /**\n   * Closes multiple tickets in a single request. This is the only ticket-close\n   * endpoint exposed by the API — there is no per-ticket close/update route.\n   *\n   * Pass `{ ids }` to close specific tickets, or `{ allContactsSelected: true, query }`\n   * to close every OPEN ticket matching `query` (the backend forces `isOpen: true`): an empty\n   * `where` closes every open ticket of the account. The answer has no body. Ids of closed,\n   * unknown or other accounts' tickets are skipped in silence; no id and no\n   * `allContactsSelected` answers 400 `ids not found`.\n   * @permissions tickets.close.all OR tickets.close.me\n   */\n  closeMany(payload: CloseManyTicketsPayload, headers?: Record<string, string>): Promise<void> {\n    return this.client.put<void, CloseManyTicketsPayload>(\n      `${this.basePath}/close-many`,\n      payload,\n      headers,\n    )\n  }\n\n  /**\n   * Counts the tickets matching the query. With `queries`, answers one count per query, in the\n   * same order (the root filters are then ignored).\n   */\n  count(query: TicketsCountManyQuery, headers?: Record<string, string>): Promise<TicketsCounts>\n  count(query?: TicketsListQuery, headers?: Record<string, string>): Promise<TicketsCount>\n  count(\n    query?: TicketsListQuery | TicketsCountManyQuery,\n    headers?: Record<string, string>,\n  ): Promise<TicketsCount | TicketsCounts> {\n    return this.client.get<TicketsCount | TicketsCounts>(\n      `${this.basePath}/count${this.toQueryString(query)}`,\n      headers,\n    )\n  }\n\n  /**\n   * POST variant of `count`, for queries too long for the URL. See {@link TicketsCountPostPayload}:\n   * `query` is required.\n   */\n  countPost(\n    body: TicketsCountPostPayload & { query: { queries: TicketsListQuery[] } },\n    headers?: Record<string, string>,\n  ): Promise<TicketsCounts>\n  countPost(body: TicketsCountPostPayload, headers?: Record<string, string>): Promise<TicketsCount>\n  countPost(\n    body: TicketsCountPostPayload,\n    headers?: Record<string, string>,\n  ): Promise<TicketsCount | TicketsCounts> {\n    return this.client.post<TicketsCount | TicketsCounts, TicketsCountPostPayload>(\n      `${this.basePath}/count`,\n      body,\n      headers,\n    )\n  }\n\n  /** Counts the open tickets of the contacts of a connection. An unknown id counts 0. */\n  countOpenByService(serviceId: string, headers?: Record<string, string>): Promise<number> {\n    return this.client.get<number>(`${this.basePath}/count-open/${serviceId}`, headers)\n  }\n\n  /** Counts the open tickets of a department. An unknown id counts 0. */\n  countOpenByDepartment(departmentId: string, headers?: Record<string, string>): Promise<number> {\n    return this.client.get<number>(\n      `${this.basePath}/count-open-by-department/${departmentId}`,\n      headers,\n    )\n  }\n\n  /** Counts the open tickets assigned to a user. An unknown id counts 0. */\n  countOpenByUser(userId: string, headers?: Record<string, string>): Promise<number> {\n    return this.client.get<number>(`${this.basePath}/count-open-by-user/${userId}`, headers)\n  }\n\n  /**\n   * The first waiting time of the ticket (`metrics.waitingTime`) as `HH:mm:ss`; `'00:00:00'` while\n   * it was not measured. The hours wrap every 24 h (a wait of 25 h answers `'01:00:00'`): read\n   * `metrics.waitingTime` (seconds) for the full value. An unknown id answers 500.\n   */\n  getFirstWaitingTime(id: string, headers?: Record<string, string>): Promise<string> {\n    return this.client.get<string>(`${this.basePath}/${id}/first-waiting-time`, headers)\n  }\n\n  /**\n   * Exports the conversation of a ticket as text, by its protocol (contact, attendants, subjects,\n   * summary, dates and the messages without the internal comments), sent as the attachment\n   * `<protocol>.txt` (Content-Type `plain/text`). Without a protocol the body is empty\n   * (`undefined`); an unknown protocol never answers.\n   */\n  exportTxt(protocol: string, headers?: Record<string, string>): Promise<string> {\n    return this.client.post<string, { protocol: string }>(\n      `${this.basePath}/export`,\n      { protocol },\n      headers,\n    )\n  }\n\n  /**\n   * Exports the tickets matching the query as CSV (`;`, a header of 20 columns in the language of\n   * the user, dates in the timezone of the account), streamed without a Content-Type.\n   *\n   * The query must include `contact` with its `service` (the History screen also includes\n   * `contact.tags`, `contact.person`, `user`, `department`, `ticketTopics` and `firstMessage`),\n   * and `order` must name unambiguous columns (e.g. `startedAt`): when a row fails after the header\n   * is sent, the answer never ends. Leave `page` out: the route pages through every match itself\n   * (`perPage` only sets the size of each batch), and a `page` in the query is read on every\n   * batch, so its rows are repeated or the CSV comes with the header only.\n   */\n  exportHistory(query: TicketsListQuery, headers?: Record<string, string>): Promise<string> {\n    return this.client.post<string>(\n      `${this.basePath}/export-history${this.toQueryString(query)}`,\n      undefined,\n      headers,\n    )\n  }\n}\n"],"mappings":";;;;;;;;;;;;AAuBA,IAAa,aAAb,cAAgC,YAA8D;CAC5F,YAAY,QAAmB;AAC7B,QAAM,QAAQ,WAAW;;;CAI3B,AAAS,OAAO,MAA2B,SAAmD;AAC5F,SAAO,MAAM,OAAO,MAAM,QAAQ;;;CAIpC,AAAS,WACP,IACA,MACA,SACiB;AACjB,SAAO,MAAM,WAAW,IAAI,MAAM,QAAQ;;;CAI5C,AAAS,WAAW,IAAY,SAAmD;AACjF,SAAO,MAAM,WAAW,IAAI,QAAQ;;;;;;;;;;;;;CActC,UAAU,SAAkC,SAAiD;AAC3F,SAAO,KAAK,OAAO,IACjB,GAAG,KAAK,SAAS,cACjB,SACA,QACD;;CASH,MACE,OACA,SACuC;AACvC,SAAO,KAAK,OAAO,IACjB,GAAG,KAAK,SAAS,QAAQ,KAAK,cAAc,MAAM,IAClD,QACD;;CAYH,UACE,MACA,SACuC;AACvC,SAAO,KAAK,OAAO,KACjB,GAAG,KAAK,SAAS,SACjB,MACA,QACD;;;CAIH,mBAAmB,WAAmB,SAAmD;AACvF,SAAO,KAAK,OAAO,IAAY,GAAG,KAAK,SAAS,cAAc,aAAa,QAAQ;;;CAIrF,sBAAsB,cAAsB,SAAmD;AAC7F,SAAO,KAAK,OAAO,IACjB,GAAG,KAAK,SAAS,4BAA4B,gBAC7C,QACD;;;CAIH,gBAAgB,QAAgB,SAAmD;AACjF,SAAO,KAAK,OAAO,IAAY,GAAG,KAAK,SAAS,sBAAsB,UAAU,QAAQ;;;;;;;CAQ1F,oBAAoB,IAAY,SAAmD;AACjF,SAAO,KAAK,OAAO,IAAY,GAAG,KAAK,SAAS,GAAG,GAAG,sBAAsB,QAAQ;;;;;;;;CAStF,UAAU,UAAkB,SAAmD;AAC7E,SAAO,KAAK,OAAO,KACjB,GAAG,KAAK,SAAS,UACjB,EAAE,UAAU,EACZ,QACD;;;;;;;;;;;;;CAcH,cAAc,OAAyB,SAAmD;AACxF,SAAO,KAAK,OAAO,KACjB,GAAG,KAAK,SAAS,iBAAiB,KAAK,cAAc,MAAM,IAC3D,QACA,QACD"}

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

@@ -1,7 +1,10 @@
+import type { ListQuery } from '../../core/types';
+import type { Account } from '../accounts/types';
 import type { Contact } from '../contacts/types';
 import type { Department } from '../departments/types';
 import type { Message } from '../messages/types';
 import type { Service } from '../services/types';
+import type { TicketTopic } from '../ticketTopics/types';
 import type { User } from '../users/types';
 export type TicketOrigin = 'automatic' | 'manual' | 'widget';
 export type TicketMetrics = {
@@ -20,6 +23,14 @@ export type TicketMetrics = {
     /** Average waiting time per transfer. */
     waitingTimeTransfersAvg?: number;
     isActiveTicket?: boolean;
+    /** Longest waiting time in seconds, among the opening and the transfers. */
+    maxWaitingTime?: number;
+    /** Department where the longest wait happened. */
+    maxWaitingTimeDepartmentId?: string;
+    /** Name of that department when the wait was measured (the history export prefers the current name). */
+    maxWaitingTimeDepartmentName?: string;
+    maxWaitingTimeStartedAt?: string;
+    maxWaitingTimeEndedAt?: string;
 };
 export type TicketTransferAction = 'opened' | 'transferred' | 'closed';
 /**
@@ -55,6 +66,16 @@ export type TicketTransfer = {
     firstMessage?: Message | null;
     lastMessage?: Message | null;
 };
+/**
+ * A ticket as `GET /tickets` and `GET /tickets/{id}` answer it. The relationships come only when
+ * asked in `include`, except `firstMessage` and `lastMessage`, which always come: `null` when not
+ * included (or when the ticket has no message).
+ *
+ * The `include` whitelist of the route takes `contact` (and `contact.avatar`, `.thumbAvatar`,
+ * `.lastMessage`, `.tags`, `.service`, `.person`), `department`, `user`, `account`, `ticketTopics`,
+ * `firstMessage` and `ticketTransfers` (with `fromUser`, `toUser`, `fromDepartment`,
+ * `toDepartment`, `byUser`); anything else is dropped in silence.
+ */
 export type Ticket = {
     id: string;
     isOpen: boolean;
@@ -64,13 +85,18 @@ export type Ticket = {
     metrics: TicketMetrics;
     startedAt: string | null;
     endedAt: string | null;
-    isDistributing: boolean;
-    count: number | null;
+    /** Only in the `ticket.*` webhooks (the stored ticket): the routes of `/tickets` never send it. */
+    isDistributing?: boolean;
+    /** Only in the `ticket.*` webhooks (the stored ticket): the routes of `/tickets` never send it. */
+    distributingAt?: string | null;
+    /** Only in the `ticket.*` webhooks (the stored ticket): the routes of `/tickets` never send it. */
+    count?: number | null;
     accountId: string;
     departmentId: string;
     contactId: string;
     userId: string | null;
-    serviceId: string | null;
+    /** @deprecated Never comes: a ticket has no connection of its own. Read `contact.serviceId`. */
+    serviceId?: string | null;
     firstMessageId: string | null;
     lastMessageId: string | null;
     currentTicketTransferId: string | null;
@@ -79,10 +105,17 @@ export type Ticket = {
     contact?: Contact;
     department?: Department;
     user?: User | null;
+    account?: Account;
+    ticketTopics?: TicketTopic[];
+    firstMessage?: Message | null;
+    /** @deprecated Always `null`: `lastMessage` is out of the include whitelist. Include `contact.lastMessage`. */
+    lastMessage?: Message | null;
+    /** @deprecated Never comes: `service` is out of the include whitelist. Include `contact.service`. */
     service?: Service | null;
     ticketTransfers?: TicketTransfer[];
 };
-export type TicketRelationships = 'contact' | 'department' | 'user' | 'service' | 'ticketTransfers';
+export type TicketRelationships = 'contact' | 'department' | 'user' | 'account' | 'ticketTopics' | 'firstMessage' | 'lastMessage' | 'service' | 'ticketTransfers';
+/** @deprecated Not served: the backend has no `POST /tickets`. A ticket is opened by `ContactsApi.transferTicket`. */
 export type CreateTicketPayload = {
     contactId: string;
     departmentId: string;
@@ -90,12 +123,20 @@ export type CreateTicketPayload = {
     comments?: string;
     origin?: TicketOrigin;
 };
+/** @deprecated Not served: the backend has no `PUT /tickets/{id}`. Transfer through `ContactsApi.transferTicket`, close through `TicketsApi.closeMany`. */
 export type UpdateTicketPayload = {
     departmentId?: string;
     userId?: string | null;
     comments?: string | null;
     isOpen?: boolean;
 };
+/** What `closeMany` records on every ticket it closes. */
+export type CloseTicketsData = {
+    /** Subjects of the closing (one id or a list). */
+    ticketTopicIds?: string[] | string;
+    /** Summary of the closing, stored in `comments`. */
+    comments?: string;
+};
 /**
  * Body for `PUT /tickets/close-many`.
  *
@@ -104,14 +145,34 @@ export type UpdateTicketPayload = {
  * `query` field is a JSON-stringified list query (e.g. `JSON.stringify({ where: {} })`);
  * the backend always forces `where.isOpen = true`.
  */
-export type CloseManyTicketsPayload = {
+export type CloseManyTicketsPayload = ({
     ids: string[];
-    ticketTopicIds?: string[] | string;
-    comments?: string;
-} | {
+} & CloseTicketsData) | ({
     allContactsSelected: true;
     query: {
         query: string;
     };
+} & CloseTicketsData);
+/** A list query of tickets, as `count` and `exportHistory` take it. */
+export type TicketsListQuery = ListQuery<Ticket>;
+/** `count` with `queries`: one count per query, in the same order. */
+export type TicketsCountManyQuery = TicketsListQuery & {
+    queries: TicketsListQuery[];
+};
+/**
+ * Body of `POST /tickets/count`. The filters go at the root, as in a list query, and `query` is
+ * required: without it the route answers 500. `query: {}` counts the root filters into
+ * `{ count }`; `query: { queries }` ignores them and answers `{ counts }`, one per query.
+ */
+export type TicketsCountPostPayload = TicketsListQuery & {
+    query: {
+        queries?: TicketsListQuery[];
+    };
+};
+export type TicketsCount = {
+    count: number;
+};
+export type TicketsCounts = {
+    counts: number[];
 };
 //# sourceMappingURL=types.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/apis/tickets/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAChD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAA;AACtD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAChD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAChD,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,gBAAgB,CAAA;AAE1C,MAAM,MAAM,YAAY,GAAG,WAAW,GAAG,QAAQ,GAAG,QAAQ,CAAA;AAE5D,MAAM,MAAM,aAAa,GAAG;IAC1B,6EAA6E;IAC7E,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,8EAA8E;IAC9E,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAC5B,2EAA2E;IAC3E,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,4DAA4D;IAC5D,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,iDAAiD;IACjD,uBAAuB,CAAC,EAAE,MAAM,CAAA;IAChC,kDAAkD;IAClD,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAC5B,yCAAyC;IACzC,uBAAuB,CAAC,EAAE,MAAM,CAAA;IAChC,cAAc,CAAC,EAAE,OAAO,CAAA;CACzB,CAAA;AAED,MAAM,MAAM,oBAAoB,GAAG,QAAQ,GAAG,aAAa,GAAG,QAAQ,CAAA;AAEtE;;;;;;GAMG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,EAAE,EAAE,MAAM,CAAA;IACV,MAAM,EAAE,oBAAoB,GAAG,IAAI,CAAA;IACnC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,gBAAgB,EAAE,OAAO,CAAA;IACzB,SAAS,EAAE,MAAM,CAAA;IACjB,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAA;IAC/B,cAAc,EAAE,MAAM,GAAG,IAAI,CAAA;IAC7B,oBAAoB,EAAE,MAAM,GAAG,IAAI,CAAA;IACnC,cAAc,EAAE,MAAM,GAAG,IAAI,CAAA;IAC7B,aAAa,EAAE,MAAM,GAAG,IAAI,CAAA;IAC5B,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IAEjB,MAAM,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;IACpB,QAAQ,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;IACtB,MAAM,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;IACpB,cAAc,CAAC,EAAE,UAAU,GAAG,IAAI,CAAA;IAClC,YAAY,CAAC,EAAE,UAAU,GAAG,IAAI,CAAA;IAChC,kBAAkB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAA;IACnC,YAAY,CAAC,EAAE,OAAO,GAAG,IAAI,CAAA;IAC7B,WAAW,CAAC,EAAE,OAAO,GAAG,IAAI,CAAA;CAC7B,CAAA;AAED,MAAM,MAAM,MAAM,GAAG;IACnB,EAAE,EAAE,MAAM,CAAA;IACV,MAAM,EAAE,OAAO,CAAA;IACf,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,MAAM,EAAE,YAAY,GAAG,IAAI,CAAA;IAC3B,OAAO,EAAE,aAAa,CAAA;IACtB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAA;IACtB,cAAc,EAAE,OAAO,CAAA;IACvB,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;IACpB,SAAS,EAAE,MAAM,CAAA;IACjB,YAAY,EAAE,MAAM,CAAA;IACpB,SAAS,EAAE,MAAM,CAAA;IACjB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAA;IACrB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB,cAAc,EAAE,MAAM,GAAG,IAAI,CAAA;IAC7B,aAAa,EAAE,MAAM,GAAG,IAAI,CAAA;IAC5B,uBAAuB,EAAE,MAAM,GAAG,IAAI,CAAA;IACtC,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IAEjB,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,UAAU,CAAC,EAAE,UAAU,CAAA;IACvB,IAAI,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;IAClB,OAAO,CAAC,EAAE,OAAO,GAAG,IAAI,CAAA;IACxB,eAAe,CAAC,EAAE,cAAc,EAAE,CAAA;CACnC,CAAA;AAED,MAAM,MAAM,mBAAmB,GAAG,SAAS,GAAG,YAAY,GAAG,MAAM,GAAG,SAAS,GAAG,iBAAiB,CAAA;AAEnG,MAAM,MAAM,mBAAmB,GAAG;IAChC,SAAS,EAAE,MAAM,CAAA;IACjB,YAAY,EAAE,MAAM,CAAA;IACpB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,MAAM,CAAC,EAAE,YAAY,CAAA;CACtB,CAAA;AAED,MAAM,MAAM,mBAAmB,GAAG;IAChC,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACtB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB,MAAM,CAAC,EAAE,OAAO,CAAA;CACjB,CAAA;AAED;;;;;;;GAOG;AACH,MAAM,MAAM,uBAAuB,GAC/B;IAAE,GAAG,EAAE,MAAM,EAAE,CAAC;IAAC,cAAc,CAAC,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC;IAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;CAAE,GACxE;IAAE,mBAAmB,EAAE,IAAI,CAAC;IAAC,KAAK,EAAE;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,CAAA;CAAE,CAAA"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/apis/tickets/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAA;AACjD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAChD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAChD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAA;AACtD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAChD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAChD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AACxD,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,gBAAgB,CAAA;AAE1C,MAAM,MAAM,YAAY,GAAG,WAAW,GAAG,QAAQ,GAAG,QAAQ,CAAA;AAE5D,MAAM,MAAM,aAAa,GAAG;IAC1B,6EAA6E;IAC7E,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,8EAA8E;IAC9E,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAC5B,2EAA2E;IAC3E,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,4DAA4D;IAC5D,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,iDAAiD;IACjD,uBAAuB,CAAC,EAAE,MAAM,CAAA;IAChC,kDAAkD;IAClD,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAC5B,yCAAyC;IACzC,uBAAuB,CAAC,EAAE,MAAM,CAAA;IAChC,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB,4EAA4E;IAC5E,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB,kDAAkD;IAClD,0BAA0B,CAAC,EAAE,MAAM,CAAA;IACnC,wGAAwG;IACxG,4BAA4B,CAAC,EAAE,MAAM,CAAA;IACrC,uBAAuB,CAAC,EAAE,MAAM,CAAA;IAChC,qBAAqB,CAAC,EAAE,MAAM,CAAA;CAC/B,CAAA;AAED,MAAM,MAAM,oBAAoB,GAAG,QAAQ,GAAG,aAAa,GAAG,QAAQ,CAAA;AAEtE;;;;;;GAMG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,EAAE,EAAE,MAAM,CAAA;IACV,MAAM,EAAE,oBAAoB,GAAG,IAAI,CAAA;IACnC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,gBAAgB,EAAE,OAAO,CAAA;IACzB,SAAS,EAAE,MAAM,CAAA;IACjB,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAA;IAC/B,cAAc,EAAE,MAAM,GAAG,IAAI,CAAA;IAC7B,oBAAoB,EAAE,MAAM,GAAG,IAAI,CAAA;IACnC,cAAc,EAAE,MAAM,GAAG,IAAI,CAAA;IAC7B,aAAa,EAAE,MAAM,GAAG,IAAI,CAAA;IAC5B,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IAEjB,MAAM,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;IACpB,QAAQ,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;IACtB,MAAM,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;IACpB,cAAc,CAAC,EAAE,UAAU,GAAG,IAAI,CAAA;IAClC,YAAY,CAAC,EAAE,UAAU,GAAG,IAAI,CAAA;IAChC,kBAAkB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAA;IACnC,YAAY,CAAC,EAAE,OAAO,GAAG,IAAI,CAAA;IAC7B,WAAW,CAAC,EAAE,OAAO,GAAG,IAAI,CAAA;CAC7B,CAAA;AAED;;;;;;;;;GASG;AACH,MAAM,MAAM,MAAM,GAAG;IACnB,EAAE,EAAE,MAAM,CAAA;IACV,MAAM,EAAE,OAAO,CAAA;IACf,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,MAAM,EAAE,YAAY,GAAG,IAAI,CAAA;IAC3B,OAAO,EAAE,aAAa,CAAA;IACtB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAA;IACtB,mGAAmG;IACnG,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB,mGAAmG;IACnG,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC9B,mGAAmG;IACnG,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACrB,SAAS,EAAE,MAAM,CAAA;IACjB,YAAY,EAAE,MAAM,CAAA;IACpB,SAAS,EAAE,MAAM,CAAA;IACjB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAA;IACrB,gGAAgG;IAChG,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,cAAc,EAAE,MAAM,GAAG,IAAI,CAAA;IAC7B,aAAa,EAAE,MAAM,GAAG,IAAI,CAAA;IAC5B,uBAAuB,EAAE,MAAM,GAAG,IAAI,CAAA;IACtC,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IAEjB,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,UAAU,CAAC,EAAE,UAAU,CAAA;IACvB,IAAI,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;IAClB,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,YAAY,CAAC,EAAE,WAAW,EAAE,CAAA;IAC5B,YAAY,CAAC,EAAE,OAAO,GAAG,IAAI,CAAA;IAC7B,+GAA+G;IAC/G,WAAW,CAAC,EAAE,OAAO,GAAG,IAAI,CAAA;IAC5B,qGAAqG;IACrG,OAAO,CAAC,EAAE,OAAO,GAAG,IAAI,CAAA;IACxB,eAAe,CAAC,EAAE,cAAc,EAAE,CAAA;CACnC,CAAA;AAED,MAAM,MAAM,mBAAmB,GAC3B,SAAS,GACT,YAAY,GACZ,MAAM,GACN,SAAS,GACT,cAAc,GACd,cAAc,GACd,aAAa,GACb,SAAS,GACT,iBAAiB,CAAA;AAErB,sHAAsH;AACtH,MAAM,MAAM,mBAAmB,GAAG;IAChC,SAAS,EAAE,MAAM,CAAA;IACjB,YAAY,EAAE,MAAM,CAAA;IACpB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,MAAM,CAAC,EAAE,YAAY,CAAA;CACtB,CAAA;AAED,2JAA2J;AAC3J,MAAM,MAAM,mBAAmB,GAAG;IAChC,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACtB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB,MAAM,CAAC,EAAE,OAAO,CAAA;CACjB,CAAA;AAED,0DAA0D;AAC1D,MAAM,MAAM,gBAAgB,GAAG;IAC7B,kDAAkD;IAClD,cAAc,CAAC,EAAE,MAAM,EAAE,GAAG,MAAM,CAAA;IAClC,oDAAoD;IACpD,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB,CAAA;AAED;;;;;;;GAOG;AACH,MAAM,MAAM,uBAAuB,GAC/B,CAAC;IAAE,GAAG,EAAE,MAAM,EAAE,CAAA;CAAE,GAAG,gBAAgB,CAAC,GACtC,CAAC;IAAE,mBAAmB,EAAE,IAAI,CAAC;IAAC,KAAK,EAAE;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,CAAA;CAAE,GAAG,gBAAgB,CAAC,CAAA;AAEhF,uEAAuE;AACvE,MAAM,MAAM,gBAAgB,GAAG,SAAS,CAAC,MAAM,CAAC,CAAA;AAEhD,sEAAsE;AACtE,MAAM,MAAM,qBAAqB,GAAG,gBAAgB,GAAG;IAAE,OAAO,EAAE,gBAAgB,EAAE,CAAA;CAAE,CAAA;AAEtF;;;;GAIG;AACH,MAAM,MAAM,uBAAuB,GAAG,gBAAgB,GAAG;IACvD,KAAK,EAAE;QAAE,OAAO,CAAC,EAAE,gBAAgB,EAAE,CAAA;KAAE,CAAA;CACxC,CAAA;AAED,MAAM,MAAM,YAAY,GAAG;IAAE,KAAK,EAAE,MAAM,CAAA;CAAE,CAAA;AAE5C,MAAM,MAAM,aAAa,GAAG;IAAE,MAAM,EAAE,MAAM,EAAE,CAAA;CAAE,CAAA"}

package/dist/core/BaseCrudApi.cjs

@@ -2,7 +2,10 @@ Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 const require_core_BaseReadApi = require('./BaseReadApi.cjs');
 
 //#region src/core/BaseCrudApi.ts
-/** Generic CRUD resource: the reads of `BaseReadApi` plus `create`, `updateById` and `deleteById`. */
+/**
+* Generic CRUD resource: the reads of `BaseReadApi` plus `create`, `updateById` and `deleteById`.
+* `TDeleteResponse` is what `deleteById` resolves to (most routes answer the text `'OK'`).
+*/
 var BaseCrudApi = class extends require_core_BaseReadApi.BaseReadApi {
 	/**
 	* Creates a new resource.
@@ -20,7 +23,7 @@ var BaseCrudApi = class extends require_core_BaseReadApi.BaseReadApi {
 	}
 	/**
 	* Deletes a resource by ID.
-	* @permissions $resourceName.delete
+	* @permissions $resourceName.destroy
 	*/
 	deleteById(id, headers) {
 		return this.client.delete(`${this.basePath}/${id}`, headers);

package/dist/core/BaseCrudApi.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"BaseCrudApi.cjs","names":["BaseReadApi"],"sources":["../../src/core/BaseCrudApi.ts"],"sourcesContent":["import { BaseReadApi } from './BaseReadApi'\nimport type { CrudApi, ListQuery } from './types'\nexport type {\n  WhereClause,\n  IncludeItem,\n  ListQuery,\n  GetByIdQuery,\n  Paginated,\n  HasGetMany,\n  HasGetById,\n  HasCreate,\n  HasUpdateById,\n  HasDeleteById,\n  CrudApi,\n} from './types'\n\n/** Generic CRUD resource: the reads of `BaseReadApi` plus `create`, `updateById` and `deleteById`. */\nexport class BaseCrudApi<\n  TResponse,\n  TCreate,\n  TUpdate = TCreate,\n  TQuery extends ListQuery<TResponse> = ListQuery<TResponse>,\n>\n  extends BaseReadApi<TResponse, TQuery>\n  implements CrudApi<TResponse, TCreate, TUpdate, TQuery>\n{\n  /**\n   * Creates a new resource.\n   * @permissions $resourceName.create\n   */\n  create(body: TCreate, headers?: Record<string, string>): Promise<TResponse> {\n    return this.client.post<TResponse, TCreate>(this.basePath, body, headers)\n  }\n\n  /**\n   * Updates an existing resource by ID.\n   * @permissions $resourceName.update\n   */\n  updateById(id: string, body: TUpdate, headers?: Record<string, string>): Promise<TResponse> {\n    return this.client.put<TResponse, TUpdate>(`${this.basePath}/${id}`, body, headers)\n  }\n\n  /**\n   * Deletes a resource by ID.\n   * @permissions $resourceName.delete\n   */\n  deleteById(id: string, headers?: Record<string, string>): Promise<TResponse> {\n    return this.client.delete<TResponse>(`${this.basePath}/${id}`, headers)\n  }\n}\n"],"mappings":";;;;;AAiBA,IAAa,cAAb,cAMUA,qCAEV;;;;;CAKE,OAAO,MAAe,SAAsD;AAC1E,SAAO,KAAK,OAAO,KAAyB,KAAK,UAAU,MAAM,QAAQ;;;;;;CAO3E,WAAW,IAAY,MAAe,SAAsD;AAC1F,SAAO,KAAK,OAAO,IAAwB,GAAG,KAAK,SAAS,GAAG,MAAM,MAAM,QAAQ;;;;;;CAOrF,WAAW,IAAY,SAAsD;AAC3E,SAAO,KAAK,OAAO,OAAkB,GAAG,KAAK,SAAS,GAAG,MAAM,QAAQ"}
+{"version":3,"file":"BaseCrudApi.cjs","names":["BaseReadApi"],"sources":["../../src/core/BaseCrudApi.ts"],"sourcesContent":["import { BaseReadApi } from './BaseReadApi'\nimport type { CrudApi, ListQuery } from './types'\nexport type {\n  WhereClause,\n  IncludeItem,\n  ListQuery,\n  GetByIdQuery,\n  Paginated,\n  HasGetMany,\n  HasGetById,\n  HasCreate,\n  HasUpdateById,\n  HasDeleteById,\n  CrudApi,\n} from './types'\n\n/**\n * Generic CRUD resource: the reads of `BaseReadApi` plus `create`, `updateById` and `deleteById`.\n * `TDeleteResponse` is what `deleteById` resolves to (most routes answer the text `'OK'`).\n */\nexport class BaseCrudApi<\n  TResponse,\n  TCreate,\n  TUpdate = TCreate,\n  TQuery extends ListQuery<TResponse> = ListQuery<TResponse>,\n  TDeleteResponse = TResponse,\n>\n  extends BaseReadApi<TResponse, TQuery>\n  implements CrudApi<TResponse, TCreate, TUpdate, TQuery, TDeleteResponse>\n{\n  /**\n   * Creates a new resource.\n   * @permissions $resourceName.create\n   */\n  create(body: TCreate, headers?: Record<string, string>): Promise<TResponse> {\n    return this.client.post<TResponse, TCreate>(this.basePath, body, headers)\n  }\n\n  /**\n   * Updates an existing resource by ID.\n   * @permissions $resourceName.update\n   */\n  updateById(id: string, body: TUpdate, headers?: Record<string, string>): Promise<TResponse> {\n    return this.client.put<TResponse, TUpdate>(`${this.basePath}/${id}`, body, headers)\n  }\n\n  /**\n   * Deletes a resource by ID.\n   * @permissions $resourceName.destroy\n   */\n  deleteById(id: string, headers?: Record<string, string>): Promise<TDeleteResponse> {\n    return this.client.delete<TDeleteResponse>(`${this.basePath}/${id}`, headers)\n  }\n}\n"],"mappings":";;;;;;;;AAoBA,IAAa,cAAb,cAOUA,qCAEV;;;;;CAKE,OAAO,MAAe,SAAsD;AAC1E,SAAO,KAAK,OAAO,KAAyB,KAAK,UAAU,MAAM,QAAQ;;;;;;CAO3E,WAAW,IAAY,MAAe,SAAsD;AAC1F,SAAO,KAAK,OAAO,IAAwB,GAAG,KAAK,SAAS,GAAG,MAAM,MAAM,QAAQ;;;;;;CAOrF,WAAW,IAAY,SAA4D;AACjF,SAAO,KAAK,OAAO,OAAwB,GAAG,KAAK,SAAS,GAAG,MAAM,QAAQ"}

package/dist/core/BaseCrudApi.d.ts

@@ -1,8 +1,11 @@
 import { BaseReadApi } from './BaseReadApi';
 import type { CrudApi, ListQuery } from './types';
 export type { WhereClause, IncludeItem, ListQuery, GetByIdQuery, Paginated, HasGetMany, HasGetById, HasCreate, HasUpdateById, HasDeleteById, CrudApi, } from './types';
-/** Generic CRUD resource: the reads of `BaseReadApi` plus `create`, `updateById` and `deleteById`. */
-export declare class BaseCrudApi<TResponse, TCreate, TUpdate = TCreate, TQuery extends ListQuery<TResponse> = ListQuery<TResponse>> extends BaseReadApi<TResponse, TQuery> implements CrudApi<TResponse, TCreate, TUpdate, TQuery> {
+/**
+ * Generic CRUD resource: the reads of `BaseReadApi` plus `create`, `updateById` and `deleteById`.
+ * `TDeleteResponse` is what `deleteById` resolves to (most routes answer the text `'OK'`).
+ */
+export declare class BaseCrudApi<TResponse, TCreate, TUpdate = TCreate, TQuery extends ListQuery<TResponse> = ListQuery<TResponse>, TDeleteResponse = TResponse> extends BaseReadApi<TResponse, TQuery> implements CrudApi<TResponse, TCreate, TUpdate, TQuery, TDeleteResponse> {
     /**
      * Creates a new resource.
      * @permissions $resourceName.create
@@ -15,8 +18,8 @@ export declare class BaseCrudApi<TResponse, TCreate, TUpdate = TCreate, TQuery e
     updateById(id: string, body: TUpdate, headers?: Record<string, string>): Promise<TResponse>;
     /**
      * Deletes a resource by ID.
-     * @permissions $resourceName.delete
+     * @permissions $resourceName.destroy
      */
-    deleteById(id: string, headers?: Record<string, string>): Promise<TResponse>;
+    deleteById(id: string, headers?: Record<string, string>): Promise<TDeleteResponse>;
 }
 //# sourceMappingURL=BaseCrudApi.d.ts.map

package/dist/core/BaseCrudApi.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"BaseCrudApi.d.ts","sourceRoot":"","sources":["../../src/core/BaseCrudApi.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAC3C,OAAO,KAAK,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,SAAS,CAAA;AACjD,YAAY,EACV,WAAW,EACX,WAAW,EACX,SAAS,EACT,YAAY,EACZ,SAAS,EACT,UAAU,EACV,UAAU,EACV,SAAS,EACT,aAAa,EACb,aAAa,EACb,OAAO,GACR,MAAM,SAAS,CAAA;AAEhB,sGAAsG;AACtG,qBAAa,WAAW,CACtB,SAAS,EACT,OAAO,EACP,OAAO,GAAG,OAAO,EACjB,MAAM,SAAS,SAAS,CAAC,SAAS,CAAC,GAAG,SAAS,CAAC,SAAS,CAAC,CAE1D,SAAQ,WAAW,CAAC,SAAS,EAAE,MAAM,CACrC,YAAW,OAAO,CAAC,SAAS,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,CAAC;IAEvD;;;OAGG;IACH,MAAM,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,SAAS,CAAC;IAI3E;;;OAGG;IACH,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,SAAS,CAAC;IAI3F;;;OAGG;IACH,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,SAAS,CAAC;CAG7E"}
+{"version":3,"file":"BaseCrudApi.d.ts","sourceRoot":"","sources":["../../src/core/BaseCrudApi.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAC3C,OAAO,KAAK,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,SAAS,CAAA;AACjD,YAAY,EACV,WAAW,EACX,WAAW,EACX,SAAS,EACT,YAAY,EACZ,SAAS,EACT,UAAU,EACV,UAAU,EACV,SAAS,EACT,aAAa,EACb,aAAa,EACb,OAAO,GACR,MAAM,SAAS,CAAA;AAEhB;;;GAGG;AACH,qBAAa,WAAW,CACtB,SAAS,EACT,OAAO,EACP,OAAO,GAAG,OAAO,EACjB,MAAM,SAAS,SAAS,CAAC,SAAS,CAAC,GAAG,SAAS,CAAC,SAAS,CAAC,EAC1D,eAAe,GAAG,SAAS,CAE3B,SAAQ,WAAW,CAAC,SAAS,EAAE,MAAM,CACrC,YAAW,OAAO,CAAC,SAAS,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,eAAe,CAAC;IAExE;;;OAGG;IACH,MAAM,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,SAAS,CAAC;IAI3E;;;OAGG;IACH,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,SAAS,CAAC;IAI3F;;;OAGG;IACH,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,eAAe,CAAC;CAGnF"}

package/dist/core/BaseCrudApi.mjs

@@ -1,7 +1,10 @@
 import { BaseReadApi } from "./BaseReadApi.mjs";
 
 //#region src/core/BaseCrudApi.ts
-/** Generic CRUD resource: the reads of `BaseReadApi` plus `create`, `updateById` and `deleteById`. */
+/**
+* Generic CRUD resource: the reads of `BaseReadApi` plus `create`, `updateById` and `deleteById`.
+* `TDeleteResponse` is what `deleteById` resolves to (most routes answer the text `'OK'`).
+*/
 var BaseCrudApi = class extends BaseReadApi {
 	/**
 	* Creates a new resource.
@@ -19,7 +22,7 @@ var BaseCrudApi = class extends BaseReadApi {
 	}
 	/**
 	* Deletes a resource by ID.
-	* @permissions $resourceName.delete
+	* @permissions $resourceName.destroy
 	*/
 	deleteById(id, headers) {
 		return this.client.delete(`${this.basePath}/${id}`, headers);

package/dist/core/BaseCrudApi.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"BaseCrudApi.mjs","names":[],"sources":["../../src/core/BaseCrudApi.ts"],"sourcesContent":["import { BaseReadApi } from './BaseReadApi'\nimport type { CrudApi, ListQuery } from './types'\nexport type {\n  WhereClause,\n  IncludeItem,\n  ListQuery,\n  GetByIdQuery,\n  Paginated,\n  HasGetMany,\n  HasGetById,\n  HasCreate,\n  HasUpdateById,\n  HasDeleteById,\n  CrudApi,\n} from './types'\n\n/** Generic CRUD resource: the reads of `BaseReadApi` plus `create`, `updateById` and `deleteById`. */\nexport class BaseCrudApi<\n  TResponse,\n  TCreate,\n  TUpdate = TCreate,\n  TQuery extends ListQuery<TResponse> = ListQuery<TResponse>,\n>\n  extends BaseReadApi<TResponse, TQuery>\n  implements CrudApi<TResponse, TCreate, TUpdate, TQuery>\n{\n  /**\n   * Creates a new resource.\n   * @permissions $resourceName.create\n   */\n  create(body: TCreate, headers?: Record<string, string>): Promise<TResponse> {\n    return this.client.post<TResponse, TCreate>(this.basePath, body, headers)\n  }\n\n  /**\n   * Updates an existing resource by ID.\n   * @permissions $resourceName.update\n   */\n  updateById(id: string, body: TUpdate, headers?: Record<string, string>): Promise<TResponse> {\n    return this.client.put<TResponse, TUpdate>(`${this.basePath}/${id}`, body, headers)\n  }\n\n  /**\n   * Deletes a resource by ID.\n   * @permissions $resourceName.delete\n   */\n  deleteById(id: string, headers?: Record<string, string>): Promise<TResponse> {\n    return this.client.delete<TResponse>(`${this.basePath}/${id}`, headers)\n  }\n}\n"],"mappings":";;;;AAiBA,IAAa,cAAb,cAMU,YAEV;;;;;CAKE,OAAO,MAAe,SAAsD;AAC1E,SAAO,KAAK,OAAO,KAAyB,KAAK,UAAU,MAAM,QAAQ;;;;;;CAO3E,WAAW,IAAY,MAAe,SAAsD;AAC1F,SAAO,KAAK,OAAO,IAAwB,GAAG,KAAK,SAAS,GAAG,MAAM,MAAM,QAAQ;;;;;;CAOrF,WAAW,IAAY,SAAsD;AAC3E,SAAO,KAAK,OAAO,OAAkB,GAAG,KAAK,SAAS,GAAG,MAAM,QAAQ"}
+{"version":3,"file":"BaseCrudApi.mjs","names":[],"sources":["../../src/core/BaseCrudApi.ts"],"sourcesContent":["import { BaseReadApi } from './BaseReadApi'\nimport type { CrudApi, ListQuery } from './types'\nexport type {\n  WhereClause,\n  IncludeItem,\n  ListQuery,\n  GetByIdQuery,\n  Paginated,\n  HasGetMany,\n  HasGetById,\n  HasCreate,\n  HasUpdateById,\n  HasDeleteById,\n  CrudApi,\n} from './types'\n\n/**\n * Generic CRUD resource: the reads of `BaseReadApi` plus `create`, `updateById` and `deleteById`.\n * `TDeleteResponse` is what `deleteById` resolves to (most routes answer the text `'OK'`).\n */\nexport class BaseCrudApi<\n  TResponse,\n  TCreate,\n  TUpdate = TCreate,\n  TQuery extends ListQuery<TResponse> = ListQuery<TResponse>,\n  TDeleteResponse = TResponse,\n>\n  extends BaseReadApi<TResponse, TQuery>\n  implements CrudApi<TResponse, TCreate, TUpdate, TQuery, TDeleteResponse>\n{\n  /**\n   * Creates a new resource.\n   * @permissions $resourceName.create\n   */\n  create(body: TCreate, headers?: Record<string, string>): Promise<TResponse> {\n    return this.client.post<TResponse, TCreate>(this.basePath, body, headers)\n  }\n\n  /**\n   * Updates an existing resource by ID.\n   * @permissions $resourceName.update\n   */\n  updateById(id: string, body: TUpdate, headers?: Record<string, string>): Promise<TResponse> {\n    return this.client.put<TResponse, TUpdate>(`${this.basePath}/${id}`, body, headers)\n  }\n\n  /**\n   * Deletes a resource by ID.\n   * @permissions $resourceName.destroy\n   */\n  deleteById(id: string, headers?: Record<string, string>): Promise<TDeleteResponse> {\n    return this.client.delete<TDeleteResponse>(`${this.basePath}/${id}`, headers)\n  }\n}\n"],"mappings":";;;;;;;AAoBA,IAAa,cAAb,cAOU,YAEV;;;;;CAKE,OAAO,MAAe,SAAsD;AAC1E,SAAO,KAAK,OAAO,KAAyB,KAAK,UAAU,MAAM,QAAQ;;;;;;CAO3E,WAAW,IAAY,MAAe,SAAsD;AAC1F,SAAO,KAAK,OAAO,IAAwB,GAAG,KAAK,SAAS,GAAG,MAAM,MAAM,QAAQ;;;;;;CAOrF,WAAW,IAAY,SAA4D;AACjF,SAAO,KAAK,OAAO,OAAwB,GAAG,KAAK,SAAS,GAAG,MAAM,QAAQ"}

package/dist/core/types.d.ts

@@ -107,6 +107,6 @@ export interface HasUpdateById<TResponse, TUpdate> {
 export interface HasDeleteById<TResponse> {
     deleteById(id: string, headers?: Record<string, string>): Promise<TResponse>;
 }
-export type CrudApi<TResponse, TCreate, TUpdate = TCreate, TQuery extends ListQuery<TResponse> = ListQuery<TResponse>> = HasGetMany<TResponse, TQuery> & HasGetById<TResponse> & HasCreate<TResponse, TCreate> & HasUpdateById<TResponse, TUpdate> & HasDeleteById<TResponse>;
+export type CrudApi<TResponse, TCreate, TUpdate = TCreate, TQuery extends ListQuery<TResponse> = ListQuery<TResponse>, TDeleteResponse = TResponse> = HasGetMany<TResponse, TQuery> & HasGetById<TResponse> & HasCreate<TResponse, TCreate> & HasUpdateById<TResponse, TUpdate> & HasDeleteById<TDeleteResponse>;
 export {};
 //# sourceMappingURL=types.d.ts.map