@ikatec/digisac-api-sdk 4.14.0 → 4.16.0

package/dist/apis/tickets/TicketsApi.mjs

@@ -4,21 +4,31 @@ import { BaseCrudApi } from "../../core/BaseCrudApi.mjs";
 /**
 * 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.
+* `ContactsApi.transferTicket`, and the ticket of one contact is closed by
+* `ContactsApi.closeTicket`. `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.
 */
 var TicketsApi = class extends BaseCrudApi {
 	constructor(client) {
 		super(client, "/tickets");
 	}
+	/** Returns the first ticket matching the query, or `null` when none match. */
+	getOne(query, headers) {
+		return super.getOne(query, headers);
+	}
+	/** Returns a ticket by ID; an unknown id resolves `null`. */
+	getById(id, query, headers) {
+		return super.getById(id, query, headers);
+	}
 	/** @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`. */
+	/**
+	* @deprecated Not served: `PUT /tickets/{id}` answers 404 `Route not found.`. Transfer through
+	* `ContactsApi.transferTicket`, close through `ContactsApi.closeTicket` or `closeMany`.
+	*/
 	updateById(id, body, headers) {
 		return super.updateById(id, body, headers);
 	}
@@ -27,8 +37,8 @@ var TicketsApi = class extends BaseCrudApi {
 		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.
+	* Closes multiple tickets in a single request. `ContactsApi.closeTicket` closes the ticket of one
+	* contact by the contact id, and also takes the rating of the AI summary.
 	*
 	* Pass `{ ids }` to close specific tickets, or `{ allContactsSelected: true, query }`
 	* to close every OPEN ticket matching `query` (the backend forces `isOpen: true`): an empty

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  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"}
+{"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 { GetByIdQuery } from '../../core/types'\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`, and the ticket of one contact is closed by\n * `ContactsApi.closeTicket`. `getById` of an unknown id resolves `null`. For a user who is not an\n * admin, `getMany` leaves out the tickets of the contacts of the connections restricted to that\n * user.\n */\nexport class TicketsApi extends BaseCrudApi<Ticket, CreateTicketPayload, UpdateTicketPayload> {\n  constructor(client: ApiClient) {\n    super(client, '/tickets')\n  }\n\n  /** Returns the first ticket matching the query, or `null` when none match. */\n  override getOne(\n    query?: TicketsListQuery,\n    headers?: Record<string, string>,\n  ): Promise<Ticket | null> {\n    return super.getOne(query, headers)\n  }\n\n  /** Returns a ticket by ID; an unknown id resolves `null`. */\n  override getById(\n    id: string,\n    query?: GetByIdQuery<Ticket>,\n    headers?: Record<string, string>,\n  ): Promise<Ticket> {\n    return super.getById(id, query, headers)\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  /**\n   * @deprecated Not served: `PUT /tickets/{id}` answers 404 `Route not found.`. Transfer through\n   * `ContactsApi.transferTicket`, close through `ContactsApi.closeTicket` or `closeMany`.\n   */\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. `ContactsApi.closeTicket` closes the ticket of one\n   * contact by the contact id, and also takes the rating of the AI summary.\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,OACP,OACA,SACwB;AACxB,SAAO,MAAM,OAAO,OAAO,QAAQ;;;CAIrC,AAAS,QACP,IACA,OACA,SACiB;AACjB,SAAO,MAAM,QAAQ,IAAI,OAAO,QAAQ;;;CAI1C,AAAS,OAAO,MAA2B,SAAmD;AAC5F,SAAO,MAAM,OAAO,MAAM,QAAQ;;;;;;CAOpC,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

@@ -123,7 +123,10 @@ 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`. */
+/**
+ * @deprecated Not served: the backend has no `PUT /tickets/{id}`. Transfer through
+ * `ContactsApi.transferTicket`, close through `ContactsApi.closeTicket` or `TicketsApi.closeMany`.
+ */
 export type UpdateTicketPayload = {
     departmentId?: string;
     userId?: string | null;

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,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"}
+{"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;;;GAGG;AACH,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/apis/timetable/TimetableApi.cjs

@@ -2,6 +2,12 @@ Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 const require_core_BaseCrudApi = require('../../core/BaseCrudApi.cjs');
 
 //#region src/apis/timetable/TimetableApi.ts
+/**
+* Timetables (work hours) of the users. Out of the timetable of the user, most authenticated routes
+* answer 403 `Is out of office hours`, with the `workPlan` of the timetable in the `extra` of the
+* error body (see `OutOfOfficeHoursErrorExtra`). Logging in (`POST /oauth/token`) and setting
+* the status to `offline` still work.
+*/
 var TimetableApi = class extends require_core_BaseCrudApi.BaseCrudApi {
 	constructor(client) {
 		super(client, "/timetable");

package/dist/apis/timetable/TimetableApi.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"TimetableApi.cjs","names":["BaseCrudApi"],"sources":["../../../src/apis/timetable/TimetableApi.ts"],"sourcesContent":["import type { ApiClient } from '../../core/ApiClient'\nimport type { ListQuery } from '../../core/types'\nimport { BaseCrudApi } from '../../core/BaseCrudApi'\nimport type { Timetable, CreateTimetablePayload, UpdateTimetablePayload } from './types'\n\nexport class TimetableApi extends BaseCrudApi<\n  Timetable,\n  CreateTimetablePayload,\n  UpdateTimetablePayload,\n  ListQuery<Timetable>,\n  'OK'\n> {\n  constructor(client: ApiClient) {\n    super(client, '/timetable')\n  }\n\n  /**\n   * Deletes a timetable. Resolves the text `'OK'`.\n   * @permissions timetables.view OR timetables.destroy\n   */\n  override deleteById(id: string, headers?: Record<string, string>): Promise<'OK'> {\n    return super.deleteById(id, headers)\n  }\n}\n"],"mappings":";;;;AAKA,IAAa,eAAb,cAAkCA,qCAMhC;CACA,YAAY,QAAmB;AAC7B,QAAM,QAAQ,aAAa;;;;;;CAO7B,AAAS,WAAW,IAAY,SAAiD;AAC/E,SAAO,MAAM,WAAW,IAAI,QAAQ"}
+{"version":3,"file":"TimetableApi.cjs","names":["BaseCrudApi"],"sources":["../../../src/apis/timetable/TimetableApi.ts"],"sourcesContent":["import type { ApiClient } from '../../core/ApiClient'\nimport type { ListQuery } from '../../core/types'\nimport { BaseCrudApi } from '../../core/BaseCrudApi'\nimport type { Timetable, CreateTimetablePayload, UpdateTimetablePayload } from './types'\n\n/**\n * Timetables (work hours) of the users. Out of the timetable of the user, most authenticated routes\n * answer 403 `Is out of office hours`, with the `workPlan` of the timetable in the `extra` of the\n * error body (see `OutOfOfficeHoursErrorExtra`). Logging in (`POST /oauth/token`) and setting\n * the status to `offline` still work.\n */\nexport class TimetableApi extends BaseCrudApi<\n  Timetable,\n  CreateTimetablePayload,\n  UpdateTimetablePayload,\n  ListQuery<Timetable>,\n  'OK'\n> {\n  constructor(client: ApiClient) {\n    super(client, '/timetable')\n  }\n\n  /**\n   * Deletes a timetable. Resolves the text `'OK'`.\n   * @permissions timetables.view OR timetables.destroy\n   */\n  override deleteById(id: string, headers?: Record<string, string>): Promise<'OK'> {\n    return super.deleteById(id, headers)\n  }\n}\n"],"mappings":";;;;;;;;;;AAWA,IAAa,eAAb,cAAkCA,qCAMhC;CACA,YAAY,QAAmB;AAC7B,QAAM,QAAQ,aAAa;;;;;;CAO7B,AAAS,WAAW,IAAY,SAAiD;AAC/E,SAAO,MAAM,WAAW,IAAI,QAAQ"}

package/dist/apis/timetable/TimetableApi.d.ts

@@ -2,6 +2,12 @@ import type { ApiClient } from '../../core/ApiClient';
 import type { ListQuery } from '../../core/types';
 import { BaseCrudApi } from '../../core/BaseCrudApi';
 import type { Timetable, CreateTimetablePayload, UpdateTimetablePayload } from './types';
+/**
+ * Timetables (work hours) of the users. Out of the timetable of the user, most authenticated routes
+ * answer 403 `Is out of office hours`, with the `workPlan` of the timetable in the `extra` of the
+ * error body (see `OutOfOfficeHoursErrorExtra`). Logging in (`POST /oauth/token`) and setting
+ * the status to `offline` still work.
+ */
 export declare class TimetableApi extends BaseCrudApi<Timetable, CreateTimetablePayload, UpdateTimetablePayload, ListQuery<Timetable>, 'OK'> {
     constructor(client: ApiClient);
     /**

package/dist/apis/timetable/TimetableApi.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"TimetableApi.d.ts","sourceRoot":"","sources":["../../../src/apis/timetable/TimetableApi.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAA;AACrD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAA;AACjD,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAA;AACpD,OAAO,KAAK,EAAE,SAAS,EAAE,sBAAsB,EAAE,sBAAsB,EAAE,MAAM,SAAS,CAAA;AAExF,qBAAa,YAAa,SAAQ,WAAW,CAC3C,SAAS,EACT,sBAAsB,EACtB,sBAAsB,EACtB,SAAS,CAAC,SAAS,CAAC,EACpB,IAAI,CACL;gBACa,MAAM,EAAE,SAAS;IAI7B;;;OAGG;IACM,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;CAGjF"}
+{"version":3,"file":"TimetableApi.d.ts","sourceRoot":"","sources":["../../../src/apis/timetable/TimetableApi.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAA;AACrD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAA;AACjD,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAA;AACpD,OAAO,KAAK,EAAE,SAAS,EAAE,sBAAsB,EAAE,sBAAsB,EAAE,MAAM,SAAS,CAAA;AAExF;;;;;GAKG;AACH,qBAAa,YAAa,SAAQ,WAAW,CAC3C,SAAS,EACT,sBAAsB,EACtB,sBAAsB,EACtB,SAAS,CAAC,SAAS,CAAC,EACpB,IAAI,CACL;gBACa,MAAM,EAAE,SAAS;IAI7B;;;OAGG;IACM,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;CAGjF"}

package/dist/apis/timetable/TimetableApi.mjs

@@ -1,6 +1,12 @@
 import { BaseCrudApi } from "../../core/BaseCrudApi.mjs";
 
 //#region src/apis/timetable/TimetableApi.ts
+/**
+* Timetables (work hours) of the users. Out of the timetable of the user, most authenticated routes
+* answer 403 `Is out of office hours`, with the `workPlan` of the timetable in the `extra` of the
+* error body (see `OutOfOfficeHoursErrorExtra`). Logging in (`POST /oauth/token`) and setting
+* the status to `offline` still work.
+*/
 var TimetableApi = class extends BaseCrudApi {
 	constructor(client) {
 		super(client, "/timetable");

package/dist/apis/timetable/TimetableApi.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"TimetableApi.mjs","names":[],"sources":["../../../src/apis/timetable/TimetableApi.ts"],"sourcesContent":["import type { ApiClient } from '../../core/ApiClient'\nimport type { ListQuery } from '../../core/types'\nimport { BaseCrudApi } from '../../core/BaseCrudApi'\nimport type { Timetable, CreateTimetablePayload, UpdateTimetablePayload } from './types'\n\nexport class TimetableApi extends BaseCrudApi<\n  Timetable,\n  CreateTimetablePayload,\n  UpdateTimetablePayload,\n  ListQuery<Timetable>,\n  'OK'\n> {\n  constructor(client: ApiClient) {\n    super(client, '/timetable')\n  }\n\n  /**\n   * Deletes a timetable. Resolves the text `'OK'`.\n   * @permissions timetables.view OR timetables.destroy\n   */\n  override deleteById(id: string, headers?: Record<string, string>): Promise<'OK'> {\n    return super.deleteById(id, headers)\n  }\n}\n"],"mappings":";;;AAKA,IAAa,eAAb,cAAkC,YAMhC;CACA,YAAY,QAAmB;AAC7B,QAAM,QAAQ,aAAa;;;;;;CAO7B,AAAS,WAAW,IAAY,SAAiD;AAC/E,SAAO,MAAM,WAAW,IAAI,QAAQ"}
+{"version":3,"file":"TimetableApi.mjs","names":[],"sources":["../../../src/apis/timetable/TimetableApi.ts"],"sourcesContent":["import type { ApiClient } from '../../core/ApiClient'\nimport type { ListQuery } from '../../core/types'\nimport { BaseCrudApi } from '../../core/BaseCrudApi'\nimport type { Timetable, CreateTimetablePayload, UpdateTimetablePayload } from './types'\n\n/**\n * Timetables (work hours) of the users. Out of the timetable of the user, most authenticated routes\n * answer 403 `Is out of office hours`, with the `workPlan` of the timetable in the `extra` of the\n * error body (see `OutOfOfficeHoursErrorExtra`). Logging in (`POST /oauth/token`) and setting\n * the status to `offline` still work.\n */\nexport class TimetableApi extends BaseCrudApi<\n  Timetable,\n  CreateTimetablePayload,\n  UpdateTimetablePayload,\n  ListQuery<Timetable>,\n  'OK'\n> {\n  constructor(client: ApiClient) {\n    super(client, '/timetable')\n  }\n\n  /**\n   * Deletes a timetable. Resolves the text `'OK'`.\n   * @permissions timetables.view OR timetables.destroy\n   */\n  override deleteById(id: string, headers?: Record<string, string>): Promise<'OK'> {\n    return super.deleteById(id, headers)\n  }\n}\n"],"mappings":";;;;;;;;;AAWA,IAAa,eAAb,cAAkC,YAMhC;CACA,YAAY,QAAmB;AAC7B,QAAM,QAAQ,aAAa;;;;;;CAO7B,AAAS,WAAW,IAAY,SAAiD;AAC/E,SAAO,MAAM,WAAW,IAAI,QAAQ"}

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

@@ -28,4 +28,12 @@ export type CreateTimetablePayload = {
 };
 /** The backend requires the three fields on every update (400 `required` otherwise). */
 export type UpdateTimetablePayload = CreateTimetablePayload;
+/**
+ * The `extra` of the 403 `Is out of office hours` error body: the timetable of the user. The error
+ * is a `PermissionDeniedError` with that `message`; read it as
+ * `(error.body as { extra?: OutOfOfficeHoursErrorExtra }).extra?.workPlan`.
+ */
+export type OutOfOfficeHoursErrorExtra = {
+    workPlan: TimetableWorkSlot[];
+};
 //# sourceMappingURL=types.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/apis/timetable/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,gBAAgB,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,CAAA;AAEpF;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,cAAc;IACd,KAAK,EAAE,MAAM,CAAA;IACb,mCAAmC;IACnC,GAAG,EAAE,MAAM,CAAA;IACX,QAAQ,EAAE,gBAAgB,EAAE,CAAA;CAC7B,CAAA;AAED,MAAM,MAAM,SAAS,GAAG;IACtB,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,0BAA0B,EAAE,MAAM,CAAA;IAClC,QAAQ,EAAE,iBAAiB,EAAE,CAAA;IAC7B,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;CAClB,CAAA;AAED,MAAM,MAAM,sBAAsB,GAAG;IACnC,gGAAgG;IAChG,IAAI,EAAE,MAAM,CAAA;IACZ,kGAAkG;IAClG,0BAA0B,EAAE,MAAM,CAAA;IAClC,QAAQ,EAAE,iBAAiB,EAAE,CAAA;CAC9B,CAAA;AAED,wFAAwF;AACxF,MAAM,MAAM,sBAAsB,GAAG,sBAAsB,CAAA"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/apis/timetable/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,gBAAgB,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,CAAA;AAEpF;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,cAAc;IACd,KAAK,EAAE,MAAM,CAAA;IACb,mCAAmC;IACnC,GAAG,EAAE,MAAM,CAAA;IACX,QAAQ,EAAE,gBAAgB,EAAE,CAAA;CAC7B,CAAA;AAED,MAAM,MAAM,SAAS,GAAG;IACtB,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,0BAA0B,EAAE,MAAM,CAAA;IAClC,QAAQ,EAAE,iBAAiB,EAAE,CAAA;IAC7B,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;CAClB,CAAA;AAED,MAAM,MAAM,sBAAsB,GAAG;IACnC,gGAAgG;IAChG,IAAI,EAAE,MAAM,CAAA;IACZ,kGAAkG;IAClG,0BAA0B,EAAE,MAAM,CAAA;IAClC,QAAQ,EAAE,iBAAiB,EAAE,CAAA;CAC9B,CAAA;AAED,wFAAwF;AACxF,MAAM,MAAM,sBAAsB,GAAG,sBAAsB,CAAA;AAE3D;;;;GAIG;AACH,MAAM,MAAM,0BAA0B,GAAG;IACvC,QAAQ,EAAE,iBAAiB,EAAE,CAAA;CAC9B,CAAA"}

package/dist/apis/users/UsersApi.cjs

@@ -15,9 +15,8 @@ var UsersApi = class extends require_core_ArchivableCrudApi.ArchivableCrudApi {
 		return super.deleteById(id, headers);
 	}
 	/**
-	* Archives or restores a user through the dedicated route used by the UI, which also
-	* sets the user offline and ends its sessions. The route enforces the business rules that
-	* {@link archive}/{@link unarchive} (a plain `PUT { archivedAt }`) skip:
+	* Archives or restores a user through the route used by the UI, which also sets the user
+	* offline and ends its sessions:
 	* - archiving refuses (403) a user referenced by a bot or with open tickets;
 	* - restoring refuses (402) when the plan has no free user slot.
 	* @permissions users.view OR users.archive
@@ -33,6 +32,15 @@ var UsersApi = class extends require_core_ArchivableCrudApi.ArchivableCrudApi {
 		return this.client.post(`${this.basePath}/bulk-status/preview`, body, headers);
 	}
 	/**
+	* Links up to 100 users at once to a timetable, departments or roles (see
+	* {@link BulkUpdateUsersLinksPayload}). The timetable is written for the whole batch at once; the
+	* departments and roles user by user, so the result may be partial (`failed`).
+	* @permissions users.update
+	*/
+	bulkUpdateLinks(body, headers) {
+		return this.client.put(`${this.basePath}/v2/bulk-update`, body, headers);
+	}
+	/**
 	* Archives or unarchives up to 100 users at once.
 	* @permissions users.archive
 	*/

package/dist/apis/users/UsersApi.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"UsersApi.cjs","names":["ArchivableCrudApi"],"sources":["../../../src/apis/users/UsersApi.ts"],"sourcesContent":["import type { ApiClient } from '../../core/ApiClient'\nimport type { ListQuery } from '../../core/types'\nimport { ArchivableCrudApi } from '../../core/ArchivableCrudApi'\nimport type { Contact } from '../contacts/types'\nimport type {\n  ArchiveUserPayload,\n  BulkUsersStatusPayload,\n  BulkUsersStatusPreview,\n  BulkUsersStatusResult,\n  CreateUserPayload,\n  EnableUserAccessResult,\n  ExportUsersPayload,\n  ImportUsersPayload,\n  ImportUsersResult,\n  TogglePinContactPayload,\n  TogglePinContactResult,\n  UpdateUserPayload,\n  User,\n  ValidateUserImportPayload,\n  ValidateUserImportResult,\n} from './types'\n\nexport class UsersApi extends ArchivableCrudApi<\n  User,\n  CreateUserPayload,\n  UpdateUserPayload,\n  ListQuery<User>,\n  'OK'\n> {\n  constructor(client: ApiClient) {\n    super(client, '/users')\n  }\n\n  /**\n   * Deletes a user (removes it as the default user of the contacts and deletes its webhooks first).\n   * Resolves the text `'OK'`.\n   * @permissions users.destroy\n   */\n  override deleteById(id: string, headers?: Record<string, string>): Promise<'OK'> {\n    return super.deleteById(id, headers)\n  }\n\n  /**\n   * Archives or restores a user through the dedicated route used by the UI, which also\n   * sets the user offline and ends its sessions. The route enforces the business rules that\n   * {@link archive}/{@link unarchive} (a plain `PUT { archivedAt }`) skip:\n   * - archiving refuses (403) a user referenced by a bot or with open tickets;\n   * - restoring refuses (402) when the plan has no free user slot.\n   * @permissions users.view OR users.archive\n   */\n  archiveWithValidation(\n    id: string,\n    body: ArchiveUserPayload,\n    headers?: Record<string, string>,\n  ): Promise<User> {\n    return this.client.post<User, ArchiveUserPayload>(\n      `${this.basePath}/${id}/archive`,\n      body,\n      headers,\n    )\n  }\n\n  /**\n   * Previews a bulk archive/unarchive without changing anything.\n   * @permissions users.archive\n   */\n  previewBulkStatus(\n    body: BulkUsersStatusPayload,\n    headers?: Record<string, string>,\n  ): Promise<BulkUsersStatusPreview> {\n    return this.client.post<BulkUsersStatusPreview, BulkUsersStatusPayload>(\n      `${this.basePath}/bulk-status/preview`,\n      body,\n      headers,\n    )\n  }\n\n  /**\n   * Archives or unarchives up to 100 users at once.\n   * @permissions users.archive\n   */\n  bulkStatus(\n    body: BulkUsersStatusPayload,\n    headers?: Record<string, string>,\n  ): Promise<BulkUsersStatusResult> {\n    return this.client.post<BulkUsersStatusResult, BulkUsersStatusPayload>(\n      `${this.basePath}/bulk-status`,\n      body,\n      headers,\n    )\n  }\n\n  /**\n   * Exports the users of the account as CSV. Resolves to the CSV text.\n   * @permissions users.export\n   */\n  exportCsv(body: ExportUsersPayload, headers?: Record<string, string>): Promise<string> {\n    return this.client.post<string, ExportUsersPayload>(`${this.basePath}/export`, body, headers)\n  }\n\n  /**\n   * Validates a CSV file previously uploaded through `FilesApi` before importing it.\n   * @permissions users.create\n   */\n  validateImport(\n    body: ValidateUserImportPayload,\n    headers?: Record<string, string>,\n  ): Promise<ValidateUserImportResult> {\n    return this.client.post<ValidateUserImportResult, ValidateUserImportPayload>(\n      `${this.basePath}/import/validate`,\n      body,\n      headers,\n    )\n  }\n\n  /**\n   * Starts the import of a CSV file previously uploaded through `FilesApi`. The import runs\n   * in the background (the route answers `202 Accepted`).\n   * @permissions users.create\n   */\n  startImport(\n    body: ImportUsersPayload,\n    headers?: Record<string, string>,\n  ): Promise<ImportUsersResult> {\n    return this.client.post<ImportUsersResult, ImportUsersPayload>(\n      `${this.basePath}/import`,\n      body,\n      headers,\n    )\n  }\n\n  /**\n   * Turns off the two-factor authentication (OTP) of a user.\n   * @permissions users.update AND myAccount.update\n   */\n  disableOtpAuth(id: string, headers?: Record<string, string>): Promise<User> {\n    return this.client.post<User>(`${this.basePath}/${id}/disable-otp-auth`, undefined, headers)\n  }\n\n  /**\n   * Clears the login throttling of a user blocked by too many failed attempts.\n   * @permissions users.update\n   */\n  enableAccess(id: string, headers?: Record<string, string>): Promise<EnableUserAccessResult> {\n    return this.client.post<EnableUserAccessResult>(\n      `${this.basePath}/${id}/enable-access`,\n      undefined,\n      headers,\n    )\n  }\n\n  /**\n   * Returns the contacts pinned by the logged user.\n   * @permissions contacts.pin\n   */\n  getPinnedContacts(headers?: Record<string, string>): Promise<Contact[]> {\n    return this.client.get<Contact[]>(`${this.basePath}/pin`, headers)\n  }\n\n  /**\n   * Pins the contact for the logged user, or unpins it when already pinned. A user can pin\n   * up to 3 contacts. Resolves to the created link rows when pinning, or to the number of\n   * removed links when unpinning.\n   * @permissions contacts.pin\n   */\n  togglePinContact(\n    body: TogglePinContactPayload,\n    headers?: Record<string, string>,\n  ): Promise<TogglePinContactResult> {\n    return this.client.patch<TogglePinContactResult, TogglePinContactPayload>(\n      `${this.basePath}/pin`,\n      body,\n      headers,\n    )\n  }\n}\n"],"mappings":";;;;AAsBA,IAAa,WAAb,cAA8BA,iDAM5B;CACA,YAAY,QAAmB;AAC7B,QAAM,QAAQ,SAAS;;;;;;;CAQzB,AAAS,WAAW,IAAY,SAAiD;AAC/E,SAAO,MAAM,WAAW,IAAI,QAAQ;;;;;;;;;;CAWtC,sBACE,IACA,MACA,SACe;AACf,SAAO,KAAK,OAAO,KACjB,GAAG,KAAK,SAAS,GAAG,GAAG,WACvB,MACA,QACD;;;;;;CAOH,kBACE,MACA,SACiC;AACjC,SAAO,KAAK,OAAO,KACjB,GAAG,KAAK,SAAS,uBACjB,MACA,QACD;;;;;;CAOH,WACE,MACA,SACgC;AAChC,SAAO,KAAK,OAAO,KACjB,GAAG,KAAK,SAAS,eACjB,MACA,QACD;;;;;;CAOH,UAAU,MAA0B,SAAmD;AACrF,SAAO,KAAK,OAAO,KAAiC,GAAG,KAAK,SAAS,UAAU,MAAM,QAAQ;;;;;;CAO/F,eACE,MACA,SACmC;AACnC,SAAO,KAAK,OAAO,KACjB,GAAG,KAAK,SAAS,mBACjB,MACA,QACD;;;;;;;CAQH,YACE,MACA,SAC4B;AAC5B,SAAO,KAAK,OAAO,KACjB,GAAG,KAAK,SAAS,UACjB,MACA,QACD;;;;;;CAOH,eAAe,IAAY,SAAiD;AAC1E,SAAO,KAAK,OAAO,KAAW,GAAG,KAAK,SAAS,GAAG,GAAG,oBAAoB,QAAW,QAAQ;;;;;;CAO9F,aAAa,IAAY,SAAmE;AAC1F,SAAO,KAAK,OAAO,KACjB,GAAG,KAAK,SAAS,GAAG,GAAG,iBACvB,QACA,QACD;;;;;;CAOH,kBAAkB,SAAsD;AACtE,SAAO,KAAK,OAAO,IAAe,GAAG,KAAK,SAAS,OAAO,QAAQ;;;;;;;;CASpE,iBACE,MACA,SACiC;AACjC,SAAO,KAAK,OAAO,MACjB,GAAG,KAAK,SAAS,OACjB,MACA,QACD"}
+{"version":3,"file":"UsersApi.cjs","names":["ArchivableCrudApi"],"sources":["../../../src/apis/users/UsersApi.ts"],"sourcesContent":["import type { ApiClient } from '../../core/ApiClient'\nimport type { ListQuery } from '../../core/types'\nimport { ArchivableCrudApi } from '../../core/ArchivableCrudApi'\nimport type { Contact } from '../contacts/types'\nimport type {\n  ArchiveUserPayload,\n  BulkUsersStatusPayload,\n  BulkUsersStatusPreview,\n  BulkUsersStatusResult,\n  BulkUpdateUsersLinksPayload,\n  BulkUpdateUsersLinksResult,\n  CreateUserPayload,\n  EnableUserAccessResult,\n  ExportUsersPayload,\n  ImportUsersPayload,\n  ImportUsersResult,\n  TogglePinContactPayload,\n  TogglePinContactResult,\n  UpdateUserPayload,\n  User,\n  ValidateUserImportPayload,\n  ValidateUserImportResult,\n} from './types'\n\nexport class UsersApi extends ArchivableCrudApi<\n  User,\n  CreateUserPayload,\n  UpdateUserPayload,\n  ListQuery<User>,\n  'OK'\n> {\n  constructor(client: ApiClient) {\n    super(client, '/users')\n  }\n\n  /**\n   * Deletes a user (removes it as the default user of the contacts and deletes its webhooks first).\n   * Resolves the text `'OK'`.\n   * @permissions users.destroy\n   */\n  override deleteById(id: string, headers?: Record<string, string>): Promise<'OK'> {\n    return super.deleteById(id, headers)\n  }\n\n  /**\n   * Archives or restores a user through the route used by the UI, which also sets the user\n   * offline and ends its sessions:\n   * - archiving refuses (403) a user referenced by a bot or with open tickets;\n   * - restoring refuses (402) when the plan has no free user slot.\n   * @permissions users.view OR users.archive\n   */\n  archiveWithValidation(\n    id: string,\n    body: ArchiveUserPayload,\n    headers?: Record<string, string>,\n  ): Promise<User> {\n    return this.client.post<User, ArchiveUserPayload>(\n      `${this.basePath}/${id}/archive`,\n      body,\n      headers,\n    )\n  }\n\n  /**\n   * Previews a bulk archive/unarchive without changing anything.\n   * @permissions users.archive\n   */\n  previewBulkStatus(\n    body: BulkUsersStatusPayload,\n    headers?: Record<string, string>,\n  ): Promise<BulkUsersStatusPreview> {\n    return this.client.post<BulkUsersStatusPreview, BulkUsersStatusPayload>(\n      `${this.basePath}/bulk-status/preview`,\n      body,\n      headers,\n    )\n  }\n\n  /**\n   * Links up to 100 users at once to a timetable, departments or roles (see\n   * {@link BulkUpdateUsersLinksPayload}). The timetable is written for the whole batch at once; the\n   * departments and roles user by user, so the result may be partial (`failed`).\n   * @permissions users.update\n   */\n  bulkUpdateLinks(\n    body: BulkUpdateUsersLinksPayload,\n    headers?: Record<string, string>,\n  ): Promise<BulkUpdateUsersLinksResult> {\n    return this.client.put<BulkUpdateUsersLinksResult, BulkUpdateUsersLinksPayload>(\n      `${this.basePath}/v2/bulk-update`,\n      body,\n      headers,\n    )\n  }\n\n  /**\n   * Archives or unarchives up to 100 users at once.\n   * @permissions users.archive\n   */\n  bulkStatus(\n    body: BulkUsersStatusPayload,\n    headers?: Record<string, string>,\n  ): Promise<BulkUsersStatusResult> {\n    return this.client.post<BulkUsersStatusResult, BulkUsersStatusPayload>(\n      `${this.basePath}/bulk-status`,\n      body,\n      headers,\n    )\n  }\n\n  /**\n   * Exports the users of the account as CSV. Resolves to the CSV text.\n   * @permissions users.export\n   */\n  exportCsv(body: ExportUsersPayload, headers?: Record<string, string>): Promise<string> {\n    return this.client.post<string, ExportUsersPayload>(`${this.basePath}/export`, body, headers)\n  }\n\n  /**\n   * Validates a CSV file previously uploaded through `FilesApi` before importing it.\n   * @permissions users.create\n   */\n  validateImport(\n    body: ValidateUserImportPayload,\n    headers?: Record<string, string>,\n  ): Promise<ValidateUserImportResult> {\n    return this.client.post<ValidateUserImportResult, ValidateUserImportPayload>(\n      `${this.basePath}/import/validate`,\n      body,\n      headers,\n    )\n  }\n\n  /**\n   * Starts the import of a CSV file previously uploaded through `FilesApi`. The import runs\n   * in the background (the route answers `202 Accepted`).\n   * @permissions users.create\n   */\n  startImport(\n    body: ImportUsersPayload,\n    headers?: Record<string, string>,\n  ): Promise<ImportUsersResult> {\n    return this.client.post<ImportUsersResult, ImportUsersPayload>(\n      `${this.basePath}/import`,\n      body,\n      headers,\n    )\n  }\n\n  /**\n   * Turns off the two-factor authentication (OTP) of a user.\n   * @permissions users.update AND myAccount.update\n   */\n  disableOtpAuth(id: string, headers?: Record<string, string>): Promise<User> {\n    return this.client.post<User>(`${this.basePath}/${id}/disable-otp-auth`, undefined, headers)\n  }\n\n  /**\n   * Clears the login throttling of a user blocked by too many failed attempts.\n   * @permissions users.update\n   */\n  enableAccess(id: string, headers?: Record<string, string>): Promise<EnableUserAccessResult> {\n    return this.client.post<EnableUserAccessResult>(\n      `${this.basePath}/${id}/enable-access`,\n      undefined,\n      headers,\n    )\n  }\n\n  /**\n   * Returns the contacts pinned by the logged user.\n   * @permissions contacts.pin\n   */\n  getPinnedContacts(headers?: Record<string, string>): Promise<Contact[]> {\n    return this.client.get<Contact[]>(`${this.basePath}/pin`, headers)\n  }\n\n  /**\n   * Pins the contact for the logged user, or unpins it when already pinned. A user can pin\n   * up to 3 contacts. Resolves to the created link rows when pinning, or to the number of\n   * removed links when unpinning.\n   * @permissions contacts.pin\n   */\n  togglePinContact(\n    body: TogglePinContactPayload,\n    headers?: Record<string, string>,\n  ): Promise<TogglePinContactResult> {\n    return this.client.patch<TogglePinContactResult, TogglePinContactPayload>(\n      `${this.basePath}/pin`,\n      body,\n      headers,\n    )\n  }\n}\n"],"mappings":";;;;AAwBA,IAAa,WAAb,cAA8BA,iDAM5B;CACA,YAAY,QAAmB;AAC7B,QAAM,QAAQ,SAAS;;;;;;;CAQzB,AAAS,WAAW,IAAY,SAAiD;AAC/E,SAAO,MAAM,WAAW,IAAI,QAAQ;;;;;;;;;CAUtC,sBACE,IACA,MACA,SACe;AACf,SAAO,KAAK,OAAO,KACjB,GAAG,KAAK,SAAS,GAAG,GAAG,WACvB,MACA,QACD;;;;;;CAOH,kBACE,MACA,SACiC;AACjC,SAAO,KAAK,OAAO,KACjB,GAAG,KAAK,SAAS,uBACjB,MACA,QACD;;;;;;;;CASH,gBACE,MACA,SACqC;AACrC,SAAO,KAAK,OAAO,IACjB,GAAG,KAAK,SAAS,kBACjB,MACA,QACD;;;;;;CAOH,WACE,MACA,SACgC;AAChC,SAAO,KAAK,OAAO,KACjB,GAAG,KAAK,SAAS,eACjB,MACA,QACD;;;;;;CAOH,UAAU,MAA0B,SAAmD;AACrF,SAAO,KAAK,OAAO,KAAiC,GAAG,KAAK,SAAS,UAAU,MAAM,QAAQ;;;;;;CAO/F,eACE,MACA,SACmC;AACnC,SAAO,KAAK,OAAO,KACjB,GAAG,KAAK,SAAS,mBACjB,MACA,QACD;;;;;;;CAQH,YACE,MACA,SAC4B;AAC5B,SAAO,KAAK,OAAO,KACjB,GAAG,KAAK,SAAS,UACjB,MACA,QACD;;;;;;CAOH,eAAe,IAAY,SAAiD;AAC1E,SAAO,KAAK,OAAO,KAAW,GAAG,KAAK,SAAS,GAAG,GAAG,oBAAoB,QAAW,QAAQ;;;;;;CAO9F,aAAa,IAAY,SAAmE;AAC1F,SAAO,KAAK,OAAO,KACjB,GAAG,KAAK,SAAS,GAAG,GAAG,iBACvB,QACA,QACD;;;;;;CAOH,kBAAkB,SAAsD;AACtE,SAAO,KAAK,OAAO,IAAe,GAAG,KAAK,SAAS,OAAO,QAAQ;;;;;;;;CASpE,iBACE,MACA,SACiC;AACjC,SAAO,KAAK,OAAO,MACjB,GAAG,KAAK,SAAS,OACjB,MACA,QACD"}

package/dist/apis/users/UsersApi.d.ts

@@ -2,7 +2,7 @@ import type { ApiClient } from '../../core/ApiClient';
 import type { ListQuery } from '../../core/types';
 import { ArchivableCrudApi } from '../../core/ArchivableCrudApi';
 import type { Contact } from '../contacts/types';
-import type { ArchiveUserPayload, BulkUsersStatusPayload, BulkUsersStatusPreview, BulkUsersStatusResult, CreateUserPayload, EnableUserAccessResult, ExportUsersPayload, ImportUsersPayload, ImportUsersResult, TogglePinContactPayload, TogglePinContactResult, UpdateUserPayload, User, ValidateUserImportPayload, ValidateUserImportResult } from './types';
+import type { ArchiveUserPayload, BulkUsersStatusPayload, BulkUsersStatusPreview, BulkUsersStatusResult, BulkUpdateUsersLinksPayload, BulkUpdateUsersLinksResult, CreateUserPayload, EnableUserAccessResult, ExportUsersPayload, ImportUsersPayload, ImportUsersResult, TogglePinContactPayload, TogglePinContactResult, UpdateUserPayload, User, ValidateUserImportPayload, ValidateUserImportResult } from './types';
 export declare class UsersApi extends ArchivableCrudApi<User, CreateUserPayload, UpdateUserPayload, ListQuery<User>, 'OK'> {
     constructor(client: ApiClient);
     /**
@@ -12,9 +12,8 @@ export declare class UsersApi extends ArchivableCrudApi<User, CreateUserPayload,
      */
     deleteById(id: string, headers?: Record<string, string>): Promise<'OK'>;
     /**
-     * Archives or restores a user through the dedicated route used by the UI, which also
-     * sets the user offline and ends its sessions. The route enforces the business rules that
-     * {@link archive}/{@link unarchive} (a plain `PUT { archivedAt }`) skip:
+     * Archives or restores a user through the route used by the UI, which also sets the user
+     * offline and ends its sessions:
      * - archiving refuses (403) a user referenced by a bot or with open tickets;
      * - restoring refuses (402) when the plan has no free user slot.
      * @permissions users.view OR users.archive
@@ -25,6 +24,13 @@ export declare class UsersApi extends ArchivableCrudApi<User, CreateUserPayload,
      * @permissions users.archive
      */
     previewBulkStatus(body: BulkUsersStatusPayload, headers?: Record<string, string>): Promise<BulkUsersStatusPreview>;
+    /**
+     * Links up to 100 users at once to a timetable, departments or roles (see
+     * {@link BulkUpdateUsersLinksPayload}). The timetable is written for the whole batch at once; the
+     * departments and roles user by user, so the result may be partial (`failed`).
+     * @permissions users.update
+     */
+    bulkUpdateLinks(body: BulkUpdateUsersLinksPayload, headers?: Record<string, string>): Promise<BulkUpdateUsersLinksResult>;
     /**
      * Archives or unarchives up to 100 users at once.
      * @permissions users.archive

package/dist/apis/users/UsersApi.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"UsersApi.d.ts","sourceRoot":"","sources":["../../../src/apis/users/UsersApi.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAA;AACrD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAA;AACjD,OAAO,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAA;AAChE,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAChD,OAAO,KAAK,EACV,kBAAkB,EAClB,sBAAsB,EACtB,sBAAsB,EACtB,qBAAqB,EACrB,iBAAiB,EACjB,sBAAsB,EACtB,kBAAkB,EAClB,kBAAkB,EAClB,iBAAiB,EACjB,uBAAuB,EACvB,sBAAsB,EACtB,iBAAiB,EACjB,IAAI,EACJ,yBAAyB,EACzB,wBAAwB,EACzB,MAAM,SAAS,CAAA;AAEhB,qBAAa,QAAS,SAAQ,iBAAiB,CAC7C,IAAI,EACJ,iBAAiB,EACjB,iBAAiB,EACjB,SAAS,CAAC,IAAI,CAAC,EACf,IAAI,CACL;gBACa,MAAM,EAAE,SAAS;IAI7B;;;;OAIG;IACM,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAIhF;;;;;;;OAOG;IACH,qBAAqB,CACnB,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,kBAAkB,EACxB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,IAAI,CAAC;IAQhB;;;OAGG;IACH,iBAAiB,CACf,IAAI,EAAE,sBAAsB,EAC5B,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,sBAAsB,CAAC;IAQlC;;;OAGG;IACH,UAAU,CACR,IAAI,EAAE,sBAAsB,EAC5B,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,qBAAqB,CAAC;IAQjC;;;OAGG;IACH,SAAS,CAAC,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC;IAItF;;;OAGG;IACH,cAAc,CACZ,IAAI,EAAE,yBAAyB,EAC/B,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,wBAAwB,CAAC;IAQpC;;;;OAIG;IACH,WAAW,CACT,IAAI,EAAE,kBAAkB,EACxB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,iBAAiB,CAAC;IAQ7B;;;OAGG;IACH,cAAc,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAI3E;;;OAGG;IACH,YAAY,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,sBAAsB,CAAC;IAQ3F;;;OAGG;IACH,iBAAiB,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IAIvE;;;;;OAKG;IACH,gBAAgB,CACd,IAAI,EAAE,uBAAuB,EAC7B,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,sBAAsB,CAAC;CAOnC"}
+{"version":3,"file":"UsersApi.d.ts","sourceRoot":"","sources":["../../../src/apis/users/UsersApi.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAA;AACrD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAA;AACjD,OAAO,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAA;AAChE,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAChD,OAAO,KAAK,EACV,kBAAkB,EAClB,sBAAsB,EACtB,sBAAsB,EACtB,qBAAqB,EACrB,2BAA2B,EAC3B,0BAA0B,EAC1B,iBAAiB,EACjB,sBAAsB,EACtB,kBAAkB,EAClB,kBAAkB,EAClB,iBAAiB,EACjB,uBAAuB,EACvB,sBAAsB,EACtB,iBAAiB,EACjB,IAAI,EACJ,yBAAyB,EACzB,wBAAwB,EACzB,MAAM,SAAS,CAAA;AAEhB,qBAAa,QAAS,SAAQ,iBAAiB,CAC7C,IAAI,EACJ,iBAAiB,EACjB,iBAAiB,EACjB,SAAS,CAAC,IAAI,CAAC,EACf,IAAI,CACL;gBACa,MAAM,EAAE,SAAS;IAI7B;;;;OAIG;IACM,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAIhF;;;;;;OAMG;IACH,qBAAqB,CACnB,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,kBAAkB,EACxB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,IAAI,CAAC;IAQhB;;;OAGG;IACH,iBAAiB,CACf,IAAI,EAAE,sBAAsB,EAC5B,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,sBAAsB,CAAC;IAQlC;;;;;OAKG;IACH,eAAe,CACb,IAAI,EAAE,2BAA2B,EACjC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,0BAA0B,CAAC;IAQtC;;;OAGG;IACH,UAAU,CACR,IAAI,EAAE,sBAAsB,EAC5B,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,qBAAqB,CAAC;IAQjC;;;OAGG;IACH,SAAS,CAAC,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC;IAItF;;;OAGG;IACH,cAAc,CACZ,IAAI,EAAE,yBAAyB,EAC/B,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,wBAAwB,CAAC;IAQpC;;;;OAIG;IACH,WAAW,CACT,IAAI,EAAE,kBAAkB,EACxB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,iBAAiB,CAAC;IAQ7B;;;OAGG;IACH,cAAc,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAI3E;;;OAGG;IACH,YAAY,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,sBAAsB,CAAC;IAQ3F;;;OAGG;IACH,iBAAiB,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IAIvE;;;;;OAKG;IACH,gBAAgB,CACd,IAAI,EAAE,uBAAuB,EAC7B,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,sBAAsB,CAAC;CAOnC"}

package/dist/apis/users/UsersApi.mjs

@@ -14,9 +14,8 @@ var UsersApi = class extends ArchivableCrudApi {
 		return super.deleteById(id, headers);
 	}
 	/**
-	* Archives or restores a user through the dedicated route used by the UI, which also
-	* sets the user offline and ends its sessions. The route enforces the business rules that
-	* {@link archive}/{@link unarchive} (a plain `PUT { archivedAt }`) skip:
+	* Archives or restores a user through the route used by the UI, which also sets the user
+	* offline and ends its sessions:
 	* - archiving refuses (403) a user referenced by a bot or with open tickets;
 	* - restoring refuses (402) when the plan has no free user slot.
 	* @permissions users.view OR users.archive
@@ -32,6 +31,15 @@ var UsersApi = class extends ArchivableCrudApi {
 		return this.client.post(`${this.basePath}/bulk-status/preview`, body, headers);
 	}
 	/**
+	* Links up to 100 users at once to a timetable, departments or roles (see
+	* {@link BulkUpdateUsersLinksPayload}). The timetable is written for the whole batch at once; the
+	* departments and roles user by user, so the result may be partial (`failed`).
+	* @permissions users.update
+	*/
+	bulkUpdateLinks(body, headers) {
+		return this.client.put(`${this.basePath}/v2/bulk-update`, body, headers);
+	}
+	/**
 	* Archives or unarchives up to 100 users at once.
 	* @permissions users.archive
 	*/

package/dist/apis/users/UsersApi.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"UsersApi.mjs","names":[],"sources":["../../../src/apis/users/UsersApi.ts"],"sourcesContent":["import type { ApiClient } from '../../core/ApiClient'\nimport type { ListQuery } from '../../core/types'\nimport { ArchivableCrudApi } from '../../core/ArchivableCrudApi'\nimport type { Contact } from '../contacts/types'\nimport type {\n  ArchiveUserPayload,\n  BulkUsersStatusPayload,\n  BulkUsersStatusPreview,\n  BulkUsersStatusResult,\n  CreateUserPayload,\n  EnableUserAccessResult,\n  ExportUsersPayload,\n  ImportUsersPayload,\n  ImportUsersResult,\n  TogglePinContactPayload,\n  TogglePinContactResult,\n  UpdateUserPayload,\n  User,\n  ValidateUserImportPayload,\n  ValidateUserImportResult,\n} from './types'\n\nexport class UsersApi extends ArchivableCrudApi<\n  User,\n  CreateUserPayload,\n  UpdateUserPayload,\n  ListQuery<User>,\n  'OK'\n> {\n  constructor(client: ApiClient) {\n    super(client, '/users')\n  }\n\n  /**\n   * Deletes a user (removes it as the default user of the contacts and deletes its webhooks first).\n   * Resolves the text `'OK'`.\n   * @permissions users.destroy\n   */\n  override deleteById(id: string, headers?: Record<string, string>): Promise<'OK'> {\n    return super.deleteById(id, headers)\n  }\n\n  /**\n   * Archives or restores a user through the dedicated route used by the UI, which also\n   * sets the user offline and ends its sessions. The route enforces the business rules that\n   * {@link archive}/{@link unarchive} (a plain `PUT { archivedAt }`) skip:\n   * - archiving refuses (403) a user referenced by a bot or with open tickets;\n   * - restoring refuses (402) when the plan has no free user slot.\n   * @permissions users.view OR users.archive\n   */\n  archiveWithValidation(\n    id: string,\n    body: ArchiveUserPayload,\n    headers?: Record<string, string>,\n  ): Promise<User> {\n    return this.client.post<User, ArchiveUserPayload>(\n      `${this.basePath}/${id}/archive`,\n      body,\n      headers,\n    )\n  }\n\n  /**\n   * Previews a bulk archive/unarchive without changing anything.\n   * @permissions users.archive\n   */\n  previewBulkStatus(\n    body: BulkUsersStatusPayload,\n    headers?: Record<string, string>,\n  ): Promise<BulkUsersStatusPreview> {\n    return this.client.post<BulkUsersStatusPreview, BulkUsersStatusPayload>(\n      `${this.basePath}/bulk-status/preview`,\n      body,\n      headers,\n    )\n  }\n\n  /**\n   * Archives or unarchives up to 100 users at once.\n   * @permissions users.archive\n   */\n  bulkStatus(\n    body: BulkUsersStatusPayload,\n    headers?: Record<string, string>,\n  ): Promise<BulkUsersStatusResult> {\n    return this.client.post<BulkUsersStatusResult, BulkUsersStatusPayload>(\n      `${this.basePath}/bulk-status`,\n      body,\n      headers,\n    )\n  }\n\n  /**\n   * Exports the users of the account as CSV. Resolves to the CSV text.\n   * @permissions users.export\n   */\n  exportCsv(body: ExportUsersPayload, headers?: Record<string, string>): Promise<string> {\n    return this.client.post<string, ExportUsersPayload>(`${this.basePath}/export`, body, headers)\n  }\n\n  /**\n   * Validates a CSV file previously uploaded through `FilesApi` before importing it.\n   * @permissions users.create\n   */\n  validateImport(\n    body: ValidateUserImportPayload,\n    headers?: Record<string, string>,\n  ): Promise<ValidateUserImportResult> {\n    return this.client.post<ValidateUserImportResult, ValidateUserImportPayload>(\n      `${this.basePath}/import/validate`,\n      body,\n      headers,\n    )\n  }\n\n  /**\n   * Starts the import of a CSV file previously uploaded through `FilesApi`. The import runs\n   * in the background (the route answers `202 Accepted`).\n   * @permissions users.create\n   */\n  startImport(\n    body: ImportUsersPayload,\n    headers?: Record<string, string>,\n  ): Promise<ImportUsersResult> {\n    return this.client.post<ImportUsersResult, ImportUsersPayload>(\n      `${this.basePath}/import`,\n      body,\n      headers,\n    )\n  }\n\n  /**\n   * Turns off the two-factor authentication (OTP) of a user.\n   * @permissions users.update AND myAccount.update\n   */\n  disableOtpAuth(id: string, headers?: Record<string, string>): Promise<User> {\n    return this.client.post<User>(`${this.basePath}/${id}/disable-otp-auth`, undefined, headers)\n  }\n\n  /**\n   * Clears the login throttling of a user blocked by too many failed attempts.\n   * @permissions users.update\n   */\n  enableAccess(id: string, headers?: Record<string, string>): Promise<EnableUserAccessResult> {\n    return this.client.post<EnableUserAccessResult>(\n      `${this.basePath}/${id}/enable-access`,\n      undefined,\n      headers,\n    )\n  }\n\n  /**\n   * Returns the contacts pinned by the logged user.\n   * @permissions contacts.pin\n   */\n  getPinnedContacts(headers?: Record<string, string>): Promise<Contact[]> {\n    return this.client.get<Contact[]>(`${this.basePath}/pin`, headers)\n  }\n\n  /**\n   * Pins the contact for the logged user, or unpins it when already pinned. A user can pin\n   * up to 3 contacts. Resolves to the created link rows when pinning, or to the number of\n   * removed links when unpinning.\n   * @permissions contacts.pin\n   */\n  togglePinContact(\n    body: TogglePinContactPayload,\n    headers?: Record<string, string>,\n  ): Promise<TogglePinContactResult> {\n    return this.client.patch<TogglePinContactResult, TogglePinContactPayload>(\n      `${this.basePath}/pin`,\n      body,\n      headers,\n    )\n  }\n}\n"],"mappings":";;;AAsBA,IAAa,WAAb,cAA8B,kBAM5B;CACA,YAAY,QAAmB;AAC7B,QAAM,QAAQ,SAAS;;;;;;;CAQzB,AAAS,WAAW,IAAY,SAAiD;AAC/E,SAAO,MAAM,WAAW,IAAI,QAAQ;;;;;;;;;;CAWtC,sBACE,IACA,MACA,SACe;AACf,SAAO,KAAK,OAAO,KACjB,GAAG,KAAK,SAAS,GAAG,GAAG,WACvB,MACA,QACD;;;;;;CAOH,kBACE,MACA,SACiC;AACjC,SAAO,KAAK,OAAO,KACjB,GAAG,KAAK,SAAS,uBACjB,MACA,QACD;;;;;;CAOH,WACE,MACA,SACgC;AAChC,SAAO,KAAK,OAAO,KACjB,GAAG,KAAK,SAAS,eACjB,MACA,QACD;;;;;;CAOH,UAAU,MAA0B,SAAmD;AACrF,SAAO,KAAK,OAAO,KAAiC,GAAG,KAAK,SAAS,UAAU,MAAM,QAAQ;;;;;;CAO/F,eACE,MACA,SACmC;AACnC,SAAO,KAAK,OAAO,KACjB,GAAG,KAAK,SAAS,mBACjB,MACA,QACD;;;;;;;CAQH,YACE,MACA,SAC4B;AAC5B,SAAO,KAAK,OAAO,KACjB,GAAG,KAAK,SAAS,UACjB,MACA,QACD;;;;;;CAOH,eAAe,IAAY,SAAiD;AAC1E,SAAO,KAAK,OAAO,KAAW,GAAG,KAAK,SAAS,GAAG,GAAG,oBAAoB,QAAW,QAAQ;;;;;;CAO9F,aAAa,IAAY,SAAmE;AAC1F,SAAO,KAAK,OAAO,KACjB,GAAG,KAAK,SAAS,GAAG,GAAG,iBACvB,QACA,QACD;;;;;;CAOH,kBAAkB,SAAsD;AACtE,SAAO,KAAK,OAAO,IAAe,GAAG,KAAK,SAAS,OAAO,QAAQ;;;;;;;;CASpE,iBACE,MACA,SACiC;AACjC,SAAO,KAAK,OAAO,MACjB,GAAG,KAAK,SAAS,OACjB,MACA,QACD"}
+{"version":3,"file":"UsersApi.mjs","names":[],"sources":["../../../src/apis/users/UsersApi.ts"],"sourcesContent":["import type { ApiClient } from '../../core/ApiClient'\nimport type { ListQuery } from '../../core/types'\nimport { ArchivableCrudApi } from '../../core/ArchivableCrudApi'\nimport type { Contact } from '../contacts/types'\nimport type {\n  ArchiveUserPayload,\n  BulkUsersStatusPayload,\n  BulkUsersStatusPreview,\n  BulkUsersStatusResult,\n  BulkUpdateUsersLinksPayload,\n  BulkUpdateUsersLinksResult,\n  CreateUserPayload,\n  EnableUserAccessResult,\n  ExportUsersPayload,\n  ImportUsersPayload,\n  ImportUsersResult,\n  TogglePinContactPayload,\n  TogglePinContactResult,\n  UpdateUserPayload,\n  User,\n  ValidateUserImportPayload,\n  ValidateUserImportResult,\n} from './types'\n\nexport class UsersApi extends ArchivableCrudApi<\n  User,\n  CreateUserPayload,\n  UpdateUserPayload,\n  ListQuery<User>,\n  'OK'\n> {\n  constructor(client: ApiClient) {\n    super(client, '/users')\n  }\n\n  /**\n   * Deletes a user (removes it as the default user of the contacts and deletes its webhooks first).\n   * Resolves the text `'OK'`.\n   * @permissions users.destroy\n   */\n  override deleteById(id: string, headers?: Record<string, string>): Promise<'OK'> {\n    return super.deleteById(id, headers)\n  }\n\n  /**\n   * Archives or restores a user through the route used by the UI, which also sets the user\n   * offline and ends its sessions:\n   * - archiving refuses (403) a user referenced by a bot or with open tickets;\n   * - restoring refuses (402) when the plan has no free user slot.\n   * @permissions users.view OR users.archive\n   */\n  archiveWithValidation(\n    id: string,\n    body: ArchiveUserPayload,\n    headers?: Record<string, string>,\n  ): Promise<User> {\n    return this.client.post<User, ArchiveUserPayload>(\n      `${this.basePath}/${id}/archive`,\n      body,\n      headers,\n    )\n  }\n\n  /**\n   * Previews a bulk archive/unarchive without changing anything.\n   * @permissions users.archive\n   */\n  previewBulkStatus(\n    body: BulkUsersStatusPayload,\n    headers?: Record<string, string>,\n  ): Promise<BulkUsersStatusPreview> {\n    return this.client.post<BulkUsersStatusPreview, BulkUsersStatusPayload>(\n      `${this.basePath}/bulk-status/preview`,\n      body,\n      headers,\n    )\n  }\n\n  /**\n   * Links up to 100 users at once to a timetable, departments or roles (see\n   * {@link BulkUpdateUsersLinksPayload}). The timetable is written for the whole batch at once; the\n   * departments and roles user by user, so the result may be partial (`failed`).\n   * @permissions users.update\n   */\n  bulkUpdateLinks(\n    body: BulkUpdateUsersLinksPayload,\n    headers?: Record<string, string>,\n  ): Promise<BulkUpdateUsersLinksResult> {\n    return this.client.put<BulkUpdateUsersLinksResult, BulkUpdateUsersLinksPayload>(\n      `${this.basePath}/v2/bulk-update`,\n      body,\n      headers,\n    )\n  }\n\n  /**\n   * Archives or unarchives up to 100 users at once.\n   * @permissions users.archive\n   */\n  bulkStatus(\n    body: BulkUsersStatusPayload,\n    headers?: Record<string, string>,\n  ): Promise<BulkUsersStatusResult> {\n    return this.client.post<BulkUsersStatusResult, BulkUsersStatusPayload>(\n      `${this.basePath}/bulk-status`,\n      body,\n      headers,\n    )\n  }\n\n  /**\n   * Exports the users of the account as CSV. Resolves to the CSV text.\n   * @permissions users.export\n   */\n  exportCsv(body: ExportUsersPayload, headers?: Record<string, string>): Promise<string> {\n    return this.client.post<string, ExportUsersPayload>(`${this.basePath}/export`, body, headers)\n  }\n\n  /**\n   * Validates a CSV file previously uploaded through `FilesApi` before importing it.\n   * @permissions users.create\n   */\n  validateImport(\n    body: ValidateUserImportPayload,\n    headers?: Record<string, string>,\n  ): Promise<ValidateUserImportResult> {\n    return this.client.post<ValidateUserImportResult, ValidateUserImportPayload>(\n      `${this.basePath}/import/validate`,\n      body,\n      headers,\n    )\n  }\n\n  /**\n   * Starts the import of a CSV file previously uploaded through `FilesApi`. The import runs\n   * in the background (the route answers `202 Accepted`).\n   * @permissions users.create\n   */\n  startImport(\n    body: ImportUsersPayload,\n    headers?: Record<string, string>,\n  ): Promise<ImportUsersResult> {\n    return this.client.post<ImportUsersResult, ImportUsersPayload>(\n      `${this.basePath}/import`,\n      body,\n      headers,\n    )\n  }\n\n  /**\n   * Turns off the two-factor authentication (OTP) of a user.\n   * @permissions users.update AND myAccount.update\n   */\n  disableOtpAuth(id: string, headers?: Record<string, string>): Promise<User> {\n    return this.client.post<User>(`${this.basePath}/${id}/disable-otp-auth`, undefined, headers)\n  }\n\n  /**\n   * Clears the login throttling of a user blocked by too many failed attempts.\n   * @permissions users.update\n   */\n  enableAccess(id: string, headers?: Record<string, string>): Promise<EnableUserAccessResult> {\n    return this.client.post<EnableUserAccessResult>(\n      `${this.basePath}/${id}/enable-access`,\n      undefined,\n      headers,\n    )\n  }\n\n  /**\n   * Returns the contacts pinned by the logged user.\n   * @permissions contacts.pin\n   */\n  getPinnedContacts(headers?: Record<string, string>): Promise<Contact[]> {\n    return this.client.get<Contact[]>(`${this.basePath}/pin`, headers)\n  }\n\n  /**\n   * Pins the contact for the logged user, or unpins it when already pinned. A user can pin\n   * up to 3 contacts. Resolves to the created link rows when pinning, or to the number of\n   * removed links when unpinning.\n   * @permissions contacts.pin\n   */\n  togglePinContact(\n    body: TogglePinContactPayload,\n    headers?: Record<string, string>,\n  ): Promise<TogglePinContactResult> {\n    return this.client.patch<TogglePinContactResult, TogglePinContactPayload>(\n      `${this.basePath}/pin`,\n      body,\n      headers,\n    )\n  }\n}\n"],"mappings":";;;AAwBA,IAAa,WAAb,cAA8B,kBAM5B;CACA,YAAY,QAAmB;AAC7B,QAAM,QAAQ,SAAS;;;;;;;CAQzB,AAAS,WAAW,IAAY,SAAiD;AAC/E,SAAO,MAAM,WAAW,IAAI,QAAQ;;;;;;;;;CAUtC,sBACE,IACA,MACA,SACe;AACf,SAAO,KAAK,OAAO,KACjB,GAAG,KAAK,SAAS,GAAG,GAAG,WACvB,MACA,QACD;;;;;;CAOH,kBACE,MACA,SACiC;AACjC,SAAO,KAAK,OAAO,KACjB,GAAG,KAAK,SAAS,uBACjB,MACA,QACD;;;;;;;;CASH,gBACE,MACA,SACqC;AACrC,SAAO,KAAK,OAAO,IACjB,GAAG,KAAK,SAAS,kBACjB,MACA,QACD;;;;;;CAOH,WACE,MACA,SACgC;AAChC,SAAO,KAAK,OAAO,KACjB,GAAG,KAAK,SAAS,eACjB,MACA,QACD;;;;;;CAOH,UAAU,MAA0B,SAAmD;AACrF,SAAO,KAAK,OAAO,KAAiC,GAAG,KAAK,SAAS,UAAU,MAAM,QAAQ;;;;;;CAO/F,eACE,MACA,SACmC;AACnC,SAAO,KAAK,OAAO,KACjB,GAAG,KAAK,SAAS,mBACjB,MACA,QACD;;;;;;;CAQH,YACE,MACA,SAC4B;AAC5B,SAAO,KAAK,OAAO,KACjB,GAAG,KAAK,SAAS,UACjB,MACA,QACD;;;;;;CAOH,eAAe,IAAY,SAAiD;AAC1E,SAAO,KAAK,OAAO,KAAW,GAAG,KAAK,SAAS,GAAG,GAAG,oBAAoB,QAAW,QAAQ;;;;;;CAO9F,aAAa,IAAY,SAAmE;AAC1F,SAAO,KAAK,OAAO,KACjB,GAAG,KAAK,SAAS,GAAG,GAAG,iBACvB,QACA,QACD;;;;;;CAOH,kBAAkB,SAAsD;AACtE,SAAO,KAAK,OAAO,IAAe,GAAG,KAAK,SAAS,OAAO,QAAQ;;;;;;;;CASpE,iBACE,MACA,SACiC;AACjC,SAAO,KAAK,OAAO,MACjB,GAAG,KAAK,SAAS,OACjB,MACA,QACD"}

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

@@ -128,6 +128,32 @@ export type BulkUsersStatusResult = {
     /** IDs of the batch that no longer exist in the account. */
     missingIds: string[];
 };
+/**
+ * Body for `PUT /users/v2/bulk-update` (1 to 100 user IDs). Send at least one of `timetableId`,
+ * `departmentIds` and `roleIds` (400 otherwise). A link id of another account, or unknown, refuses
+ * the whole batch with 400 (`<field> contains ids that do not belong to the account.`).
+ */
+export type BulkUpdateUsersLinksPayload = {
+    ids: string[];
+    /** Sets the timetable of every user; `null` removes it. */
+    timetableId?: string | null;
+    /** Adds the departments to every user (the current ones are kept). At least one id. */
+    departmentIds?: string[];
+    /** Adds the roles to every user (the current ones are kept). At least one id. */
+    roleIds?: string[];
+};
+export type BulkUpdateUsersLinksResult = {
+    /**
+     * Users of the batch written by at least one of the steps (with `timetableId`, `null` included,
+     * every user found; with `departmentIds`/`roleIds`, also those that already had them).
+     */
+    changed: number;
+    /** Failures of the per-user writes (departments and roles), one per user and field. */
+    failed: number;
+    changedIds: string[];
+    /** IDs of the batch that are not users of the account (they are skipped). */
+    missingIds: string[];
+};
 /** Body for `POST /users/export`. */
 export type ExportUsersPayload = {
     filter: 'all' | 'active' | 'archived';

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

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/apis/users/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAA;AACtD,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,gBAAgB,CAAA;AAC1C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAA;AAEnD,MAAM,MAAM,UAAU,GAAG,QAAQ,GAAG,SAAS,GAAG,MAAM,CAAA;AAEtD,MAAM,MAAM,eAAe,GAAG;IAC5B,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,cAAc,CAAC,EAAE,OAAO,CAAA;CACzB,CAAA;AAED,MAAM,MAAM,QAAQ,GAAG;IACrB,gFAAgF;IAChF,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC7B,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;CACvB,CAAA;AAED,qFAAqF;AACrF,MAAM,MAAM,qBAAqB,GAAG;IAClC,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;CACb,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,IAAI,GAAG;IACjB,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;IACb,WAAW,EAAE,MAAM,GAAG,IAAI,CAAA;IAC1B,MAAM,EAAE,MAAM,GAAG,IAAI,CAAA;IACrB,YAAY,EAAE,OAAO,CAAA;IACrB,QAAQ,EAAE,MAAM,CAAA;IAChB,YAAY,EAAE,OAAO,CAAA;IACrB,MAAM,EAAE,UAAU,CAAA;IAClB,aAAa,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,IAAI,CAAA;IAC5C,oBAAoB,EAAE,OAAO,CAAA;IAC7B,2GAA2G;IAC3G,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAA;IAChC,4DAA4D;IAC5D,aAAa,EAAE,OAAO,CAAA;IACtB,IAAI,EAAE,QAAQ,CAAA;IACd,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAA;IAChC,aAAa,EAAE,OAAO,GAAG,IAAI,CAAA;IAC7B,WAAW,EAAE,eAAe,CAAA;IAC5B,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,SAAS,EAAE,MAAM,CAAA;IACjB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAA;IAC1B,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IAExB,SAAS,CAAC,EAAE,SAAS,GAAG,IAAI,CAAA;IAC5B,KAAK,CAAC,EAAE,IAAI,EAAE,CAAA;IACd,WAAW,CAAC,EAAE,UAAU,EAAE,CAAA;IAC1B,kEAAkE;IAClE,kBAAkB,CAAC,EAAE,qBAAqB,EAAE,CAAA;CAC7C,CAAA;AAED,MAAM,MAAM,iBAAiB,GAAG,WAAW,GAAG,OAAO,GAAG,aAAa,CAAA;AAErE,MAAM,MAAM,iBAAiB,GAAG;IAC9B,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;IACb,QAAQ,EAAE,MAAM,CAAA;IAChB,oBAAoB,EAAE,MAAM,CAAA;IAC5B,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,YAAY,CAAC,EAAE,OAAO,CAAA;IACtB,KAAK,CAAC,EAAE,MAAM,EAAE,CAAA;IAChB,WAAW,CAAC,EAAE,MAAM,EAAE,CAAA;IACtB,+FAA+F;IAC/F,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAA;IACnB,qEAAqE;IACrE,kBAAkB,CAAC,EAAE;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,EAAE,CAAA;IACxC,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB,CAAA;AAED,MAAM,MAAM,iBAAiB,GAAG;IAC9B,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACtB,YAAY,CAAC,EAAE,OAAO,CAAA;IACtB,KAAK,CAAC,EAAE,MAAM,EAAE,CAAA;IAChB,WAAW,CAAC,EAAE,MAAM,EAAE,CAAA;IACtB,+FAA+F;IAC/F,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAA;IACnB;;;OAGG;IACH,kBAAkB,CAAC,EAAE;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,EAAE,CAAA;IACxC,gCAAgC;IAChC,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B,WAAW,CAAC,EAAE,eAAe,CAAA;IAC7B,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CAC3B,CAAA;AAED,0CAA0C;AAC1C,MAAM,MAAM,kBAAkB,GAAG;IAC/B,qDAAqD;IACrD,OAAO,EAAE,OAAO,CAAA;CACjB,CAAA;AAED,+FAA+F;AAC/F,MAAM,MAAM,sBAAsB,GAAG;IACnC,GAAG,EAAE,MAAM,EAAE,CAAA;IACb,OAAO,EAAE,OAAO,CAAA;CACjB,CAAA;AAED,MAAM,MAAM,uBAAuB,GAC/B,gBAAgB,GAChB,cAAc,GACd,aAAa,GACb,kBAAkB,GAClB,iBAAiB,GACjB,mBAAmB,CAAA;AAEvB,qEAAqE;AACrE,MAAM,MAAM,sBAAsB,GAAG;IACnC,QAAQ,EAAE,uBAAuB,CAAA;IACjC,aAAa,EAAE,MAAM,CAAA;IACrB,0CAA0C;IAC1C,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,EAAE,MAAM,CAAA;IAChB,+EAA+E;IAC/E,OAAO,EAAE,MAAM,CAAA;IACf,WAAW,EAAE,OAAO,CAAA;IACpB,+DAA+D;IAC/D,kBAAkB,EAAE,MAAM,GAAG,IAAI,CAAA;CAClC,CAAA;AAED,MAAM,MAAM,qBAAqB,GAAG;IAClC,OAAO,EAAE,MAAM,CAAA;IACf,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,EAAE,MAAM,CAAA;IACf,MAAM,EAAE,MAAM,CAAA;IACd,UAAU,EAAE,MAAM,EAAE,CAAA;IACpB,4DAA4D;IAC5D,UAAU,EAAE,MAAM,EAAE,CAAA;CACrB,CAAA;AAED,qCAAqC;AACrC,MAAM,MAAM,kBAAkB,GAAG;IAC/B,MAAM,EAAE,KAAK,GAAG,QAAQ,GAAG,UAAU,CAAA;CACtC,CAAA;AAED,qDAAqD;AACrD,MAAM,MAAM,cAAc,GAAG;IAC3B,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,EAAE,MAAM,CAAA;IAChB,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB,CAAA;AAED,8CAA8C;AAC9C,MAAM,MAAM,yBAAyB,GAAG;IACtC,IAAI,EAAE,cAAc,CAAA;CACrB,CAAA;AAED,MAAM,MAAM,qBAAqB,GAAG;IAClC,KAAK,EAAE,MAAM,CAAA;IACb,KAAK,EAAE,MAAM,CAAA;IACb,OAAO,EAAE,MAAM,CAAA;IACf,UAAU,EAAE,OAAO,CAAA;CACpB,CAAA;AAED,MAAM,MAAM,wBAAwB,GAAG;IACrC,QAAQ,EAAE;QACR,aAAa,EAAE,MAAM,CAAA;QACrB,SAAS,EAAE,MAAM,CAAA;QACjB,QAAQ,EAAE,OAAO,CAAA;KAClB,CAAA;IACD,OAAO,EAAE;QACP,QAAQ,EAAE;YAAE,IAAI,EAAE,MAAM,CAAC;YAAC,KAAK,EAAE,OAAO,CAAA;SAAE,EAAE,CAAA;QAC5C,eAAe,EAAE,MAAM,EAAE,CAAA;QACzB,aAAa,EAAE,MAAM,EAAE,CAAA;KACxB,CAAA;IACD,IAAI,EAAE,qBAAqB,CAAA;IAC3B,6DAA6D;IAC7D,uBAAuB,EAAE,qBAAqB,CAAA;CAC/C,CAAA;AAED,qCAAqC;AACrC,MAAM,MAAM,kBAAkB,GAAG;IAC/B,IAAI,EAAE,cAAc,CAAA;IACpB,kBAAkB,CAAC,EAAE,OAAO,CAAA;CAC7B,CAAA;AAED,4EAA4E;AAC5E,MAAM,MAAM,iBAAiB,GAAG;IAC9B,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA;AAED,MAAM,MAAM,sBAAsB,GAAG;IACnC,OAAO,EAAE,OAAO,CAAA;IAChB,OAAO,EAAE,MAAM,CAAA;CAChB,CAAA;AAED,8FAA8F;AAC9F,MAAM,MAAM,uBAAuB,GAAG;IACpC,SAAS,EAAE,MAAM,CAAA;CAClB,CAAA;AAED,4EAA4E;AAC5E,MAAM,MAAM,qBAAqB,GAAG;IAClC,MAAM,EAAE,MAAM,CAAA;IACd,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;CAClB,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,sBAAsB,GAAG,qBAAqB,EAAE,GAAG,MAAM,CAAA"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/apis/users/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAA;AACtD,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,gBAAgB,CAAA;AAC1C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAA;AAEnD,MAAM,MAAM,UAAU,GAAG,QAAQ,GAAG,SAAS,GAAG,MAAM,CAAA;AAEtD,MAAM,MAAM,eAAe,GAAG;IAC5B,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,cAAc,CAAC,EAAE,OAAO,CAAA;CACzB,CAAA;AAED,MAAM,MAAM,QAAQ,GAAG;IACrB,gFAAgF;IAChF,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC7B,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;CACvB,CAAA;AAED,qFAAqF;AACrF,MAAM,MAAM,qBAAqB,GAAG;IAClC,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;CACb,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,IAAI,GAAG;IACjB,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;IACb,WAAW,EAAE,MAAM,GAAG,IAAI,CAAA;IAC1B,MAAM,EAAE,MAAM,GAAG,IAAI,CAAA;IACrB,YAAY,EAAE,OAAO,CAAA;IACrB,QAAQ,EAAE,MAAM,CAAA;IAChB,YAAY,EAAE,OAAO,CAAA;IACrB,MAAM,EAAE,UAAU,CAAA;IAClB,aAAa,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,IAAI,CAAA;IAC5C,oBAAoB,EAAE,OAAO,CAAA;IAC7B,2GAA2G;IAC3G,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAA;IAChC,4DAA4D;IAC5D,aAAa,EAAE,OAAO,CAAA;IACtB,IAAI,EAAE,QAAQ,CAAA;IACd,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAA;IAChC,aAAa,EAAE,OAAO,GAAG,IAAI,CAAA;IAC7B,WAAW,EAAE,eAAe,CAAA;IAC5B,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,SAAS,EAAE,MAAM,CAAA;IACjB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAA;IAC1B,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IAExB,SAAS,CAAC,EAAE,SAAS,GAAG,IAAI,CAAA;IAC5B,KAAK,CAAC,EAAE,IAAI,EAAE,CAAA;IACd,WAAW,CAAC,EAAE,UAAU,EAAE,CAAA;IAC1B,kEAAkE;IAClE,kBAAkB,CAAC,EAAE,qBAAqB,EAAE,CAAA;CAC7C,CAAA;AAED,MAAM,MAAM,iBAAiB,GAAG,WAAW,GAAG,OAAO,GAAG,aAAa,CAAA;AAErE,MAAM,MAAM,iBAAiB,GAAG;IAC9B,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;IACb,QAAQ,EAAE,MAAM,CAAA;IAChB,oBAAoB,EAAE,MAAM,CAAA;IAC5B,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,YAAY,CAAC,EAAE,OAAO,CAAA;IACtB,KAAK,CAAC,EAAE,MAAM,EAAE,CAAA;IAChB,WAAW,CAAC,EAAE,MAAM,EAAE,CAAA;IACtB,+FAA+F;IAC/F,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAA;IACnB,qEAAqE;IACrE,kBAAkB,CAAC,EAAE;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,EAAE,CAAA;IACxC,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB,CAAA;AAED,MAAM,MAAM,iBAAiB,GAAG;IAC9B,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACtB,YAAY,CAAC,EAAE,OAAO,CAAA;IACtB,KAAK,CAAC,EAAE,MAAM,EAAE,CAAA;IAChB,WAAW,CAAC,EAAE,MAAM,EAAE,CAAA;IACtB,+FAA+F;IAC/F,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAA;IACnB;;;OAGG;IACH,kBAAkB,CAAC,EAAE;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,EAAE,CAAA;IACxC,gCAAgC;IAChC,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B,WAAW,CAAC,EAAE,eAAe,CAAA;IAC7B,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CAC3B,CAAA;AAED,0CAA0C;AAC1C,MAAM,MAAM,kBAAkB,GAAG;IAC/B,qDAAqD;IACrD,OAAO,EAAE,OAAO,CAAA;CACjB,CAAA;AAED,+FAA+F;AAC/F,MAAM,MAAM,sBAAsB,GAAG;IACnC,GAAG,EAAE,MAAM,EAAE,CAAA;IACb,OAAO,EAAE,OAAO,CAAA;CACjB,CAAA;AAED,MAAM,MAAM,uBAAuB,GAC/B,gBAAgB,GAChB,cAAc,GACd,aAAa,GACb,kBAAkB,GAClB,iBAAiB,GACjB,mBAAmB,CAAA;AAEvB,qEAAqE;AACrE,MAAM,MAAM,sBAAsB,GAAG;IACnC,QAAQ,EAAE,uBAAuB,CAAA;IACjC,aAAa,EAAE,MAAM,CAAA;IACrB,0CAA0C;IAC1C,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,EAAE,MAAM,CAAA;IAChB,+EAA+E;IAC/E,OAAO,EAAE,MAAM,CAAA;IACf,WAAW,EAAE,OAAO,CAAA;IACpB,+DAA+D;IAC/D,kBAAkB,EAAE,MAAM,GAAG,IAAI,CAAA;CAClC,CAAA;AAED,MAAM,MAAM,qBAAqB,GAAG;IAClC,OAAO,EAAE,MAAM,CAAA;IACf,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,EAAE,MAAM,CAAA;IACf,MAAM,EAAE,MAAM,CAAA;IACd,UAAU,EAAE,MAAM,EAAE,CAAA;IACpB,4DAA4D;IAC5D,UAAU,EAAE,MAAM,EAAE,CAAA;CACrB,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,2BAA2B,GAAG;IACxC,GAAG,EAAE,MAAM,EAAE,CAAA;IACb,2DAA2D;IAC3D,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B,uFAAuF;IACvF,aAAa,CAAC,EAAE,MAAM,EAAE,CAAA;IACxB,iFAAiF;IACjF,OAAO,CAAC,EAAE,MAAM,EAAE,CAAA;CACnB,CAAA;AAED,MAAM,MAAM,0BAA0B,GAAG;IACvC;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAA;IACf,uFAAuF;IACvF,MAAM,EAAE,MAAM,CAAA;IACd,UAAU,EAAE,MAAM,EAAE,CAAA;IACpB,6EAA6E;IAC7E,UAAU,EAAE,MAAM,EAAE,CAAA;CACrB,CAAA;AAED,qCAAqC;AACrC,MAAM,MAAM,kBAAkB,GAAG;IAC/B,MAAM,EAAE,KAAK,GAAG,QAAQ,GAAG,UAAU,CAAA;CACtC,CAAA;AAED,qDAAqD;AACrD,MAAM,MAAM,cAAc,GAAG;IAC3B,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,EAAE,MAAM,CAAA;IAChB,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB,CAAA;AAED,8CAA8C;AAC9C,MAAM,MAAM,yBAAyB,GAAG;IACtC,IAAI,EAAE,cAAc,CAAA;CACrB,CAAA;AAED,MAAM,MAAM,qBAAqB,GAAG;IAClC,KAAK,EAAE,MAAM,CAAA;IACb,KAAK,EAAE,MAAM,CAAA;IACb,OAAO,EAAE,MAAM,CAAA;IACf,UAAU,EAAE,OAAO,CAAA;CACpB,CAAA;AAED,MAAM,MAAM,wBAAwB,GAAG;IACrC,QAAQ,EAAE;QACR,aAAa,EAAE,MAAM,CAAA;QACrB,SAAS,EAAE,MAAM,CAAA;QACjB,QAAQ,EAAE,OAAO,CAAA;KAClB,CAAA;IACD,OAAO,EAAE;QACP,QAAQ,EAAE;YAAE,IAAI,EAAE,MAAM,CAAC;YAAC,KAAK,EAAE,OAAO,CAAA;SAAE,EAAE,CAAA;QAC5C,eAAe,EAAE,MAAM,EAAE,CAAA;QACzB,aAAa,EAAE,MAAM,EAAE,CAAA;KACxB,CAAA;IACD,IAAI,EAAE,qBAAqB,CAAA;IAC3B,6DAA6D;IAC7D,uBAAuB,EAAE,qBAAqB,CAAA;CAC/C,CAAA;AAED,qCAAqC;AACrC,MAAM,MAAM,kBAAkB,GAAG;IAC/B,IAAI,EAAE,cAAc,CAAA;IACpB,kBAAkB,CAAC,EAAE,OAAO,CAAA;CAC7B,CAAA;AAED,4EAA4E;AAC5E,MAAM,MAAM,iBAAiB,GAAG;IAC9B,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA;AAED,MAAM,MAAM,sBAAsB,GAAG;IACnC,OAAO,EAAE,OAAO,CAAA;IAChB,OAAO,EAAE,MAAM,CAAA;CAChB,CAAA;AAED,8FAA8F;AAC9F,MAAM,MAAM,uBAAuB,GAAG;IACpC,SAAS,EAAE,MAAM,CAAA;CAClB,CAAA;AAED,4EAA4E;AAC5E,MAAM,MAAM,qBAAqB,GAAG;IAClC,MAAM,EAAE,MAAM,CAAA;IACd,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;CAClB,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,sBAAsB,GAAG,qBAAqB,EAAE,GAAG,MAAM,CAAA"}

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

@@ -1,13 +1,43 @@
 import type { Service } from '../services/types';
+/**
+ * `by_service` and `whatsapp_low_level` only get the events of the connections in `services`.
+ * Events not tied to a connection (users, departments, tags...) reach `by_service` too. A webhook
+ * with `services`, whatever its type, only gets the events of those connections (events not tied
+ * to a connection reach it too); a `general` webhook is meant to have none.
+ */
+export type WebhookType = 'general' | 'by_service' | 'whatsapp_low_level';
+/**
+ * The categories of message the `message.created` event delivers. Only `false` leaves a category
+ * out (an absent key keeps it); `null`, or no filter, delivers every message. The other events are
+ * not filtered. A key outside these answers 400.
+ */
+export type WebhookMessageFilters = {
+    /** Messages of the contact (not their reactions). */
+    received?: boolean;
+    /** Messages sent through the connection, except the bot's (and the reactions). */
+    sent?: boolean;
+    /** Messages sent by the bot. */
+    bot?: boolean;
+    /**
+     * Internal comments, ticket events, reactions, summaries, schedules, AI evaluations, the notices
+     * of the message block rule and the message types the platform does not know.
+     */
+    system?: boolean;
+};
 export type Webhook = {
     id: string;
     name: string;
     url: string;
-    type: string;
+    /** A webhook created before the type was validated may hold another value. */
+    type: WebhookType;
     active: boolean;
     events: string[];
+    /** `null` when `events` has no `message.created` (the backend clears it on every write). */
+    messageFilters?: WebhookMessageFilters | null;
     errorAt: string | null;
     errorNotifiedAt: string | null;
+    /** The average delivery latency, in ms (shown in the list of webhooks); `null` until measured. */
+    avgLatencyMs?: number | null;
     userId: string;
     accountId: string;
     createdAt: string;
@@ -19,15 +49,30 @@ export type WebhookRelationships = 'services';
 export type CreateWebhookPayload = {
     name: string;
     url: string;
-    type: string;
+    type: WebhookType;
     events: string[];
     active?: boolean;
+    /** The connections of a `by_service` or `whatsapp_low_level` webhook (none for `general`). */
+    services?: string[];
+    /** Only kept with the `message.created` event. */
+    messageFilters?: WebhookMessageFilters | null;
 };
+/**
+ * `updateById` sends a `PUT`: `name`, `url`, `type` and `events` are required (400 without them),
+ * as in the create.
+ */
 export type UpdateWebhookPayload = {
-    name?: string;
-    url?: string;
-    type?: string;
-    events?: string[];
+    name: string;
+    url: string;
+    type: WebhookType;
+    events: string[];
     active?: boolean;
+    /**
+     * Replaces the connections of the webhook; omitted keeps them. Send `[]` when the type becomes
+     * `general`: the connections kept also filter a `general` webhook.
+     */
+    services?: string[];
+    /** Only kept with the `message.created` event. */
+    messageFilters?: WebhookMessageFilters | null;
 };
 //# sourceMappingURL=types.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/apis/webhooks/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAEhD,MAAM,MAAM,OAAO,GAAG;IACpB,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,GAAG,EAAE,MAAM,CAAA;IACX,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,OAAO,CAAA;IACf,MAAM,EAAE,MAAM,EAAE,CAAA;IAChB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAA;IACtB,eAAe,EAAE,MAAM,GAAG,IAAI,CAAA;IAC9B,MAAM,EAAE,MAAM,CAAA;IACd,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IAExB,QAAQ,CAAC,EAAE,OAAO,EAAE,CAAA;CACrB,CAAA;AAED,MAAM,MAAM,oBAAoB,GAAG,UAAU,CAAA;AAE7C,MAAM,MAAM,oBAAoB,GAAG;IACjC,IAAI,EAAE,MAAM,CAAA;IACZ,GAAG,EAAE,MAAM,CAAA;IACX,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,MAAM,EAAE,CAAA;IAChB,MAAM,CAAC,EAAE,OAAO,CAAA;CACjB,CAAA;AAED,MAAM,MAAM,oBAAoB,GAAG;IACjC,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;IACjB,MAAM,CAAC,EAAE,OAAO,CAAA;CACjB,CAAA"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/apis/webhooks/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAEhD;;;;;GAKG;AACH,MAAM,MAAM,WAAW,GAAG,SAAS,GAAG,YAAY,GAAG,oBAAoB,CAAA;AAEzE;;;;GAIG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC,qDAAqD;IACrD,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,kFAAkF;IAClF,IAAI,CAAC,EAAE,OAAO,CAAA;IACd,gCAAgC;IAChC,GAAG,CAAC,EAAE,OAAO,CAAA;IACb;;;OAGG;IACH,MAAM,CAAC,EAAE,OAAO,CAAA;CACjB,CAAA;AAED,MAAM,MAAM,OAAO,GAAG;IACpB,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,GAAG,EAAE,MAAM,CAAA;IACX,8EAA8E;IAC9E,IAAI,EAAE,WAAW,CAAA;IACjB,MAAM,EAAE,OAAO,CAAA;IACf,MAAM,EAAE,MAAM,EAAE,CAAA;IAChB,4FAA4F;IAC5F,cAAc,CAAC,EAAE,qBAAqB,GAAG,IAAI,CAAA;IAC7C,OAAO,EAAE,MAAM,GAAG,IAAI,CAAA;IACtB,eAAe,EAAE,MAAM,GAAG,IAAI,CAAA;IAC9B,kGAAkG;IAClG,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC5B,MAAM,EAAE,MAAM,CAAA;IACd,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IAExB,QAAQ,CAAC,EAAE,OAAO,EAAE,CAAA;CACrB,CAAA;AAED,MAAM,MAAM,oBAAoB,GAAG,UAAU,CAAA;AAE7C,MAAM,MAAM,oBAAoB,GAAG;IACjC,IAAI,EAAE,MAAM,CAAA;IACZ,GAAG,EAAE,MAAM,CAAA;IACX,IAAI,EAAE,WAAW,CAAA;IACjB,MAAM,EAAE,MAAM,EAAE,CAAA;IAChB,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB,8FAA8F;IAC9F,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAA;IACnB,kDAAkD;IAClD,cAAc,CAAC,EAAE,qBAAqB,GAAG,IAAI,CAAA;CAC9C,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC,IAAI,EAAE,MAAM,CAAA;IACZ,GAAG,EAAE,MAAM,CAAA;IACX,IAAI,EAAE,WAAW,CAAA;IACjB,MAAM,EAAE,MAAM,EAAE,CAAA;IAChB,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAA;IACnB,kDAAkD;IAClD,cAAc,CAAC,EAAE,qBAAqB,GAAG,IAAI,CAAA;CAC9C,CAAA"}

package/dist/core/BaseReadApi.cjs

@@ -4,8 +4,8 @@ const require_core_BaseApi = require('./BaseApi.cjs');
 //#region src/core/BaseReadApi.ts
 /**
 * Generic read-only resource: `getMany`, `getOne` and `getById` under `basePath`. Base of
-* `BaseCrudApi`, and of the resources the backend only serves for reading (e.g. permissions,
-* auth history).
+* `BaseCrudApi`, and of the resources the backend serves for reading, plus their own actions (e.g.
+* permissions, auth history).
 */
 var BaseReadApi = class extends require_core_BaseApi.BaseApi {
 	basePath;

package/dist/core/BaseReadApi.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"BaseReadApi.cjs","names":["BaseApi"],"sources":["../../src/core/BaseReadApi.ts"],"sourcesContent":["import type { ApiClient } from './ApiClient'\nimport { BaseApi } from './BaseApi'\nimport type { GetByIdQuery, HasGetById, HasGetMany, ListQuery, Paginated } from './types'\n\n/**\n * Generic read-only resource: `getMany`, `getOne` and `getById` under `basePath`. Base of\n * `BaseCrudApi`, and of the resources the backend only serves for reading (e.g. permissions,\n * auth history).\n */\nexport class BaseReadApi<TResponse, TQuery extends ListQuery<TResponse> = ListQuery<TResponse>>\n  extends BaseApi\n  implements HasGetMany<TResponse, TQuery>, HasGetById<TResponse>\n{\n  public readonly basePath: string\n\n  constructor(client: ApiClient, basePath: string) {\n    super(client)\n    this.basePath = basePath.replace(/\\/$/, '')\n  }\n\n  getMany(\n    query: TQuery & { paginate: false },\n    headers?: Record<string, string>,\n  ): Promise<TResponse[]>\n  getMany(\n    query?: TQuery & { paginate?: true },\n    headers?: Record<string, string>,\n  ): Promise<Paginated<TResponse>>\n  getMany(\n    query?: TQuery,\n    headers?: Record<string, string>,\n  ): Promise<Paginated<TResponse> | TResponse[]>\n  getMany(\n    query?: TQuery,\n    headers?: Record<string, string>,\n  ): Promise<Paginated<TResponse> | TResponse[]> {\n    const queryString = this.toQueryString(query)\n    return this.client.get<Paginated<TResponse> | TResponse[]>(\n      `${this.basePath}${queryString}`,\n      headers,\n    )\n  }\n\n  /**\n   * Returns the first resource matching the query, or `null` when none match.\n   * Convenience over `getMany` with `limit: 1`.\n   * @permissions $resourceName.view\n   */\n  async getOne(query?: TQuery, headers?: Record<string, string>): Promise<TResponse | null> {\n    const results = await this.getMany(\n      { ...query, limit: 1, paginate: false } as TQuery & { paginate: false },\n      headers,\n    )\n    // An empty response body resolves to `undefined`.\n    return results?.[0] ?? null\n  }\n\n  /**\n   * Returns a single resource by ID. When it does not exist most routes answer 200 with an empty\n   * body, which resolves to `undefined`.\n   * @permissions $resourceName.view\n   */\n  getById(\n    id: string,\n    query?: GetByIdQuery<TResponse>,\n    headers?: Record<string, string>,\n  ): Promise<TResponse> {\n    return this.client.get<TResponse>(`${this.basePath}/${id}${this.toQueryString(query)}`, headers)\n  }\n}\n"],"mappings":";;;;;;;;;AASA,IAAa,cAAb,cACUA,6BAEV;CACE,AAAgB;CAEhB,YAAY,QAAmB,UAAkB;AAC/C,QAAM,OAAO;AACb,OAAK,WAAW,SAAS,QAAQ,OAAO,GAAG;;CAe7C,QACE,OACA,SAC6C;EAC7C,MAAM,cAAc,KAAK,cAAc,MAAM;AAC7C,SAAO,KAAK,OAAO,IACjB,GAAG,KAAK,WAAW,eACnB,QACD;;;;;;;CAQH,MAAM,OAAO,OAAgB,SAA6D;AAMxF,UALgB,MAAM,KAAK,QACzB;GAAE,GAAG;GAAO,OAAO;GAAG,UAAU;GAAO,EACvC,QACD,IAEgB,MAAM;;;;;;;CAQzB,QACE,IACA,OACA,SACoB;AACpB,SAAO,KAAK,OAAO,IAAe,GAAG,KAAK,SAAS,GAAG,KAAK,KAAK,cAAc,MAAM,IAAI,QAAQ"}
+{"version":3,"file":"BaseReadApi.cjs","names":["BaseApi"],"sources":["../../src/core/BaseReadApi.ts"],"sourcesContent":["import type { ApiClient } from './ApiClient'\nimport { BaseApi } from './BaseApi'\nimport type { GetByIdQuery, HasGetById, HasGetMany, ListQuery, Paginated } from './types'\n\n/**\n * Generic read-only resource: `getMany`, `getOne` and `getById` under `basePath`. Base of\n * `BaseCrudApi`, and of the resources the backend serves for reading, plus their own actions (e.g.\n * permissions, auth history).\n */\nexport class BaseReadApi<TResponse, TQuery extends ListQuery<TResponse> = ListQuery<TResponse>>\n  extends BaseApi\n  implements HasGetMany<TResponse, TQuery>, HasGetById<TResponse>\n{\n  public readonly basePath: string\n\n  constructor(client: ApiClient, basePath: string) {\n    super(client)\n    this.basePath = basePath.replace(/\\/$/, '')\n  }\n\n  getMany(\n    query: TQuery & { paginate: false },\n    headers?: Record<string, string>,\n  ): Promise<TResponse[]>\n  getMany(\n    query?: TQuery & { paginate?: true },\n    headers?: Record<string, string>,\n  ): Promise<Paginated<TResponse>>\n  getMany(\n    query?: TQuery,\n    headers?: Record<string, string>,\n  ): Promise<Paginated<TResponse> | TResponse[]>\n  getMany(\n    query?: TQuery,\n    headers?: Record<string, string>,\n  ): Promise<Paginated<TResponse> | TResponse[]> {\n    const queryString = this.toQueryString(query)\n    return this.client.get<Paginated<TResponse> | TResponse[]>(\n      `${this.basePath}${queryString}`,\n      headers,\n    )\n  }\n\n  /**\n   * Returns the first resource matching the query, or `null` when none match.\n   * Convenience over `getMany` with `limit: 1`.\n   * @permissions $resourceName.view\n   */\n  async getOne(query?: TQuery, headers?: Record<string, string>): Promise<TResponse | null> {\n    const results = await this.getMany(\n      { ...query, limit: 1, paginate: false } as TQuery & { paginate: false },\n      headers,\n    )\n    // An empty response body resolves to `undefined`.\n    return results?.[0] ?? null\n  }\n\n  /**\n   * Returns a single resource by ID. When it does not exist most routes answer 200 with an empty\n   * body, which resolves to `undefined`.\n   * @permissions $resourceName.view\n   */\n  getById(\n    id: string,\n    query?: GetByIdQuery<TResponse>,\n    headers?: Record<string, string>,\n  ): Promise<TResponse> {\n    return this.client.get<TResponse>(`${this.basePath}/${id}${this.toQueryString(query)}`, headers)\n  }\n}\n"],"mappings":";;;;;;;;;AASA,IAAa,cAAb,cACUA,6BAEV;CACE,AAAgB;CAEhB,YAAY,QAAmB,UAAkB;AAC/C,QAAM,OAAO;AACb,OAAK,WAAW,SAAS,QAAQ,OAAO,GAAG;;CAe7C,QACE,OACA,SAC6C;EAC7C,MAAM,cAAc,KAAK,cAAc,MAAM;AAC7C,SAAO,KAAK,OAAO,IACjB,GAAG,KAAK,WAAW,eACnB,QACD;;;;;;;CAQH,MAAM,OAAO,OAAgB,SAA6D;AAMxF,UALgB,MAAM,KAAK,QACzB;GAAE,GAAG;GAAO,OAAO;GAAG,UAAU;GAAO,EACvC,QACD,IAEgB,MAAM;;;;;;;CAQzB,QACE,IACA,OACA,SACoB;AACpB,SAAO,KAAK,OAAO,IAAe,GAAG,KAAK,SAAS,GAAG,KAAK,KAAK,cAAc,MAAM,IAAI,QAAQ"}

package/dist/core/BaseReadApi.d.ts

@@ -3,8 +3,8 @@ import { BaseApi } from './BaseApi';
 import type { GetByIdQuery, HasGetById, HasGetMany, ListQuery, Paginated } from './types';
 /**
  * Generic read-only resource: `getMany`, `getOne` and `getById` under `basePath`. Base of
- * `BaseCrudApi`, and of the resources the backend only serves for reading (e.g. permissions,
- * auth history).
+ * `BaseCrudApi`, and of the resources the backend serves for reading, plus their own actions (e.g.
+ * permissions, auth history).
  */
 export declare class BaseReadApi<TResponse, TQuery extends ListQuery<TResponse> = ListQuery<TResponse>> extends BaseApi implements HasGetMany<TResponse, TQuery>, HasGetById<TResponse> {
     readonly basePath: string;