@ikatec/digisac-api-sdk 4.15.0 → 4.17.0

package/README.md

@@ -91,7 +91,7 @@ Available resources:
 | Campaigns | `CampaignsApi` | `/campaigns` |
 | Cards | `CardsApi` | `/cards` |
 | Categories | `CategoriesApi` | `/categories` |
-| Client Feedback (deprecated: the route is broken in the backend) | `ClientFeedbackApi` | `/client-feedback` |
+| Client Feedback (deprecated: send the rating of the AI summary with `ContactsApi.closeTicket`) | `ClientFeedbackApi` | `/client-feedback` |
 | Contact Block Lists | `ContactBlockListsApi` | `/contact-block-lists` |
 | Contact Block Lists Controls | `ContactBlockListsControlsApi` | `/contact-block-lists-controls` |
 | Contacts | `ContactsApi` | `/contacts` |
@@ -365,6 +365,8 @@ response.headers.get('Content-Type') // 'application/pdf'
 const pdf = await response.arrayBuffer()
 ```
 
+The methods built on it need a client that implements `requestRaw`: `CreditMovementsApi.exportXlsx` and `BotsApi.exportErrors` (xlsx as an `ArrayBuffer`), and `AnswersApi.exportCsvRaw` / `exportTxtRaw` (the whole `Response`).
+
 ## Uploading files
 
 The content of a file goes straight to the storage, through a signed URL. `upload` sends it with `client.requestExternal`, which leaves out the base URL and the access token (the storage refuses an `Authorization` header), so a `BaseApiClient` subclass can intercept it by overriding that method:

package/dist/apis/absence/AbsenceApi.cjs

@@ -13,8 +13,8 @@ var AbsenceApi = class extends require_core_BaseCrudApi.BaseCrudApi {
 		super(client, "/absence");
 	}
 	/**
-	* The absence report of the account (`GET /absence`), always paginated, with its own query (the rows are
-	* raw: see `AbsenceReportItem`). Prefer it to `getMany`, whose `where`/`include`/`paginate` the backend
+	* The absence report of the account (`GET /absence`), always paginated, with its own query (see
+	* `AbsenceReportItem`). Prefer it to `getMany`, whose `where`/`include`/`paginate` the backend
 	* ignores. Requires both permissions, always: without them it answers 403
 	* `MISSING_ABSENCE_REPORT_PERMISSION`.
 	* @permissions overview.absence.view AND myAccount.absence

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

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

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

@@ -11,8 +11,8 @@ import type { Absence, AbsenceReportItem, AbsenceReportQuery, CreateAbsencePaylo
 export declare class AbsenceApi extends BaseCrudApi<Absence, CreateAbsencePayload, UpdateAbsencePayload> {
     constructor(client: ApiClient);
     /**
-     * The absence report of the account (`GET /absence`), always paginated, with its own query (the rows are
-     * raw: see `AbsenceReportItem`). Prefer it to `getMany`, whose `where`/`include`/`paginate` the backend
+     * The absence report of the account (`GET /absence`), always paginated, with its own query (see
+     * `AbsenceReportItem`). Prefer it to `getMany`, whose `where`/`include`/`paginate` the backend
      * ignores. Requires both permissions, always: without them it answers 403
      * `MISSING_ABSENCE_REPORT_PERMISSION`.
      * @permissions overview.absence.view AND myAccount.absence

package/dist/apis/absence/AbsenceApi.mjs

@@ -12,8 +12,8 @@ var AbsenceApi = class extends BaseCrudApi {
 		super(client, "/absence");
 	}
 	/**
-	* The absence report of the account (`GET /absence`), always paginated, with its own query (the rows are
-	* raw: see `AbsenceReportItem`). Prefer it to `getMany`, whose `where`/`include`/`paginate` the backend
+	* The absence report of the account (`GET /absence`), always paginated, with its own query (see
+	* `AbsenceReportItem`). Prefer it to `getMany`, whose `where`/`include`/`paginate` the backend
 	* ignores. Requires both permissions, always: without them it answers 403
 	* `MISSING_ABSENCE_REPORT_PERMISSION`.
 	* @permissions overview.absence.view AND myAccount.absence

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

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

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

@@ -48,7 +48,7 @@ export type AbsenceReportQuery = {
     timezone?: string;
 };
 /**
- * A row of the report: the stored absence with its user, both raw (not transformed).
+ * A row of the report: the stored absence with its `user`.
  */
 export type AbsenceReportItem = Omit<Absence, 'deletedAt' | 'user'> & {
     user?: Record<string, unknown>;

package/dist/apis/answers/AnswersApi.cjs

@@ -3,8 +3,7 @@ const require_core_BaseCrudApi = require('../../core/BaseCrudApi.cjs');
 
 //#region src/apis/answers/AnswersApi.ts
 /**
-* Answers of the evaluation questions. They are written by the bot flow (`SEND_QUESTION`); the
-* CRUD routes exist but validate nothing.
+* Answers of the evaluation questions. They are written by the bot flow (`SEND_QUESTION`).
 *
 * Permissions: `evaluation.view` to read, `evaluation.create`/`update`/`destroy` to write.
 */
@@ -44,6 +43,28 @@ var AnswersApi = class extends require_core_BaseCrudApi.BaseCrudApi {
 	exportTxt(query, headers) {
 		return this.client.get(`${this.basePath}/exportation-txt${this.toQueryString(query)}`, headers);
 	}
+	/**
+	* The {@link exportCsv} export as the whole `Response`, to read its headers (`Content-Type`,
+	* `Content-Disposition`) as well as the body. Needs a client with `requestRaw`. Errors are thrown
+	* as in `exportCsv`.
+	* @permissions overview.evaluation.view
+	*/
+	exportCsvRaw(query, headers) {
+		return this.exportResponse("exportation-csv", "exportCsvRaw", query, headers);
+	}
+	/**
+	* The {@link exportTxt} export as the whole `Response`, to read its headers (`Content-Type`,
+	* `Content-Disposition`) as well as the body. The Content-Type is `plain/text` (not
+	* `text/plain`). Needs a client with `requestRaw`. Errors are thrown as in `exportTxt`.
+	* @permissions overview.evaluation.view
+	*/
+	exportTxtRaw(query, headers) {
+		return this.exportResponse("exportation-txt", "exportTxtRaw", query, headers);
+	}
+	async exportResponse(route, method, query, headers) {
+		if (!this.client.requestRaw) throw new Error(`${method} needs a client with requestRaw (the answer is read as a Response)`);
+		return this.client.requestRaw("GET", `${this.basePath}/${route}${this.toQueryString(query)}`, void 0, headers);
+	}
 };
 
 //#endregion

package/dist/apis/answers/AnswersApi.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"AnswersApi.cjs","names":["BaseCrudApi"],"sources":["../../../src/apis/answers/AnswersApi.ts"],"sourcesContent":["import type { ApiClient } from '../../core/ApiClient'\nimport { BaseCrudApi } from '../../core/BaseCrudApi'\nimport type { ListQuery } from '../../core/types'\nimport type {\n  Answer,\n  AnswersOverview,\n  AnswersReportQuery,\n  CreateAnswerPayload,\n  UpdateAnswerPayload,\n} from './types'\n\n/**\n * Answers of the evaluation questions. They are written by the bot flow (`SEND_QUESTION`); the\n * CRUD routes exist but validate nothing.\n *\n * Permissions: `evaluation.view` to read, `evaluation.create`/`update`/`destroy` to write.\n */\nexport class AnswersApi extends BaseCrudApi<\n  Answer,\n  CreateAnswerPayload,\n  UpdateAnswerPayload,\n  ListQuery<Answer>,\n  'OK'\n> {\n  constructor(client: ApiClient) {\n    super(client, '/answers')\n  }\n\n  /**\n   * Deletes an answer (soft delete). Resolves to `'OK'`.\n   * @permissions evaluation.destroy\n   */\n  override deleteById(id: string, headers?: Record<string, string>): Promise<'OK'> {\n    return super.deleteById(id, headers)\n  }\n\n  /**\n   * Counts the NPS and CSAT answers of closed tickets. An error answers 500 with a string body.\n   * @permissions overview.evaluation.view\n   */\n  overview(query?: AnswersReportQuery, headers?: Record<string, string>): Promise<AnswersOverview> {\n    return this.client.get<AnswersOverview>(\n      `${this.basePath}/overview${this.toQueryString(query)}`,\n      headers,\n    )\n  }\n\n  /**\n   * Exports the answers as CSV (`,`, header in the language of the user, dates in the timezone of\n   * the account), sent as the attachment `evaluation-reports.csv`. An unknown `type` answers 400\n   * `{ error: 'Tipo de consulta inválido' }`.\n   * @permissions overview.evaluation.view\n   */\n  exportCsv(query?: AnswersReportQuery, headers?: Record<string, string>): Promise<string> {\n    return this.client.get<string>(\n      `${this.basePath}/exportation-csv${this.toQueryString(query)}`,\n      headers,\n    )\n  }\n\n  /**\n   * Exports the answers as text, one block per answer and the count of unanswered ones at the\n   * end, sent as the attachment `evaluation-reports.txt` (Content-Type `plain/text`). An unknown\n   * `type` answers 400 `{ error: 'Tipo de consulta inválido' }`.\n   * @permissions overview.evaluation.view\n   */\n  exportTxt(query?: AnswersReportQuery, headers?: Record<string, string>): Promise<string> {\n    return this.client.get<string>(\n      `${this.basePath}/exportation-txt${this.toQueryString(query)}`,\n      headers,\n    )\n  }\n}\n"],"mappings":";;;;;;;;;;AAiBA,IAAa,aAAb,cAAgCA,qCAM9B;CACA,YAAY,QAAmB;AAC7B,QAAM,QAAQ,WAAW;;;;;;CAO3B,AAAS,WAAW,IAAY,SAAiD;AAC/E,SAAO,MAAM,WAAW,IAAI,QAAQ;;;;;;CAOtC,SAAS,OAA4B,SAA4D;AAC/F,SAAO,KAAK,OAAO,IACjB,GAAG,KAAK,SAAS,WAAW,KAAK,cAAc,MAAM,IACrD,QACD;;;;;;;;CASH,UAAU,OAA4B,SAAmD;AACvF,SAAO,KAAK,OAAO,IACjB,GAAG,KAAK,SAAS,kBAAkB,KAAK,cAAc,MAAM,IAC5D,QACD;;;;;;;;CASH,UAAU,OAA4B,SAAmD;AACvF,SAAO,KAAK,OAAO,IACjB,GAAG,KAAK,SAAS,kBAAkB,KAAK,cAAc,MAAM,IAC5D,QACD"}
+{"version":3,"file":"AnswersApi.cjs","names":["BaseCrudApi"],"sources":["../../../src/apis/answers/AnswersApi.ts"],"sourcesContent":["import type { ApiClient } from '../../core/ApiClient'\nimport { BaseCrudApi } from '../../core/BaseCrudApi'\nimport type { ListQuery } from '../../core/types'\nimport type {\n  Answer,\n  AnswersOverview,\n  AnswersReportQuery,\n  CreateAnswerPayload,\n  UpdateAnswerPayload,\n} from './types'\n\n/**\n * Answers of the evaluation questions. They are written by the bot flow (`SEND_QUESTION`).\n *\n * Permissions: `evaluation.view` to read, `evaluation.create`/`update`/`destroy` to write.\n */\nexport class AnswersApi extends BaseCrudApi<\n  Answer,\n  CreateAnswerPayload,\n  UpdateAnswerPayload,\n  ListQuery<Answer>,\n  'OK'\n> {\n  constructor(client: ApiClient) {\n    super(client, '/answers')\n  }\n\n  /**\n   * Deletes an answer (soft delete). Resolves to `'OK'`.\n   * @permissions evaluation.destroy\n   */\n  override deleteById(id: string, headers?: Record<string, string>): Promise<'OK'> {\n    return super.deleteById(id, headers)\n  }\n\n  /**\n   * Counts the NPS and CSAT answers of closed tickets. An error answers 500 with a string body.\n   * @permissions overview.evaluation.view\n   */\n  overview(query?: AnswersReportQuery, headers?: Record<string, string>): Promise<AnswersOverview> {\n    return this.client.get<AnswersOverview>(\n      `${this.basePath}/overview${this.toQueryString(query)}`,\n      headers,\n    )\n  }\n\n  /**\n   * Exports the answers as CSV (`,`, header in the language of the user, dates in the timezone of\n   * the account), sent as the attachment `evaluation-reports.csv`. An unknown `type` answers 400\n   * `{ error: 'Tipo de consulta inválido' }`.\n   * @permissions overview.evaluation.view\n   */\n  exportCsv(query?: AnswersReportQuery, headers?: Record<string, string>): Promise<string> {\n    return this.client.get<string>(\n      `${this.basePath}/exportation-csv${this.toQueryString(query)}`,\n      headers,\n    )\n  }\n\n  /**\n   * Exports the answers as text, one block per answer and the count of unanswered ones at the\n   * end, sent as the attachment `evaluation-reports.txt` (Content-Type `plain/text`). An unknown\n   * `type` answers 400 `{ error: 'Tipo de consulta inválido' }`.\n   * @permissions overview.evaluation.view\n   */\n  exportTxt(query?: AnswersReportQuery, headers?: Record<string, string>): Promise<string> {\n    return this.client.get<string>(\n      `${this.basePath}/exportation-txt${this.toQueryString(query)}`,\n      headers,\n    )\n  }\n\n  /**\n   * The {@link exportCsv} export as the whole `Response`, to read its headers (`Content-Type`,\n   * `Content-Disposition`) as well as the body. Needs a client with `requestRaw`. Errors are thrown\n   * as in `exportCsv`.\n   * @permissions overview.evaluation.view\n   */\n  exportCsvRaw(query?: AnswersReportQuery, headers?: Record<string, string>): Promise<Response> {\n    return this.exportResponse('exportation-csv', 'exportCsvRaw', query, headers)\n  }\n\n  /**\n   * The {@link exportTxt} export as the whole `Response`, to read its headers (`Content-Type`,\n   * `Content-Disposition`) as well as the body. The Content-Type is `plain/text` (not\n   * `text/plain`). Needs a client with `requestRaw`. Errors are thrown as in `exportTxt`.\n   * @permissions overview.evaluation.view\n   */\n  exportTxtRaw(query?: AnswersReportQuery, headers?: Record<string, string>): Promise<Response> {\n    return this.exportResponse('exportation-txt', 'exportTxtRaw', query, headers)\n  }\n\n  private async exportResponse(\n    route: 'exportation-csv' | 'exportation-txt',\n    method: 'exportCsvRaw' | 'exportTxtRaw',\n    query?: AnswersReportQuery,\n    headers?: Record<string, string>,\n  ): Promise<Response> {\n    if (!this.client.requestRaw) {\n      throw new Error(`${method} needs a client with requestRaw (the answer is read as a Response)`)\n    }\n    return this.client.requestRaw(\n      'GET',\n      `${this.basePath}/${route}${this.toQueryString(query)}`,\n      undefined,\n      headers,\n    )\n  }\n}\n"],"mappings":";;;;;;;;;AAgBA,IAAa,aAAb,cAAgCA,qCAM9B;CACA,YAAY,QAAmB;AAC7B,QAAM,QAAQ,WAAW;;;;;;CAO3B,AAAS,WAAW,IAAY,SAAiD;AAC/E,SAAO,MAAM,WAAW,IAAI,QAAQ;;;;;;CAOtC,SAAS,OAA4B,SAA4D;AAC/F,SAAO,KAAK,OAAO,IACjB,GAAG,KAAK,SAAS,WAAW,KAAK,cAAc,MAAM,IACrD,QACD;;;;;;;;CASH,UAAU,OAA4B,SAAmD;AACvF,SAAO,KAAK,OAAO,IACjB,GAAG,KAAK,SAAS,kBAAkB,KAAK,cAAc,MAAM,IAC5D,QACD;;;;;;;;CASH,UAAU,OAA4B,SAAmD;AACvF,SAAO,KAAK,OAAO,IACjB,GAAG,KAAK,SAAS,kBAAkB,KAAK,cAAc,MAAM,IAC5D,QACD;;;;;;;;CASH,aAAa,OAA4B,SAAqD;AAC5F,SAAO,KAAK,eAAe,mBAAmB,gBAAgB,OAAO,QAAQ;;;;;;;;CAS/E,aAAa,OAA4B,SAAqD;AAC5F,SAAO,KAAK,eAAe,mBAAmB,gBAAgB,OAAO,QAAQ;;CAG/E,MAAc,eACZ,OACA,QACA,OACA,SACmB;AACnB,MAAI,CAAC,KAAK,OAAO,WACf,OAAM,IAAI,MAAM,GAAG,OAAO,oEAAoE;AAEhG,SAAO,KAAK,OAAO,WACjB,OACA,GAAG,KAAK,SAAS,GAAG,QAAQ,KAAK,cAAc,MAAM,IACrD,QACA,QACD"}

package/dist/apis/answers/AnswersApi.d.ts

@@ -3,8 +3,7 @@ import { BaseCrudApi } from '../../core/BaseCrudApi';
 import type { ListQuery } from '../../core/types';
 import type { Answer, AnswersOverview, AnswersReportQuery, CreateAnswerPayload, UpdateAnswerPayload } from './types';
 /**
- * Answers of the evaluation questions. They are written by the bot flow (`SEND_QUESTION`); the
- * CRUD routes exist but validate nothing.
+ * Answers of the evaluation questions. They are written by the bot flow (`SEND_QUESTION`).
  *
  * Permissions: `evaluation.view` to read, `evaluation.create`/`update`/`destroy` to write.
  */
@@ -34,5 +33,20 @@ export declare class AnswersApi extends BaseCrudApi<Answer, CreateAnswerPayload,
      * @permissions overview.evaluation.view
      */
     exportTxt(query?: AnswersReportQuery, headers?: Record<string, string>): Promise<string>;
+    /**
+     * The {@link exportCsv} export as the whole `Response`, to read its headers (`Content-Type`,
+     * `Content-Disposition`) as well as the body. Needs a client with `requestRaw`. Errors are thrown
+     * as in `exportCsv`.
+     * @permissions overview.evaluation.view
+     */
+    exportCsvRaw(query?: AnswersReportQuery, headers?: Record<string, string>): Promise<Response>;
+    /**
+     * The {@link exportTxt} export as the whole `Response`, to read its headers (`Content-Type`,
+     * `Content-Disposition`) as well as the body. The Content-Type is `plain/text` (not
+     * `text/plain`). Needs a client with `requestRaw`. Errors are thrown as in `exportTxt`.
+     * @permissions overview.evaluation.view
+     */
+    exportTxtRaw(query?: AnswersReportQuery, headers?: Record<string, string>): Promise<Response>;
+    private exportResponse;
 }
 //# sourceMappingURL=AnswersApi.d.ts.map

package/dist/apis/answers/AnswersApi.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"AnswersApi.d.ts","sourceRoot":"","sources":["../../../src/apis/answers/AnswersApi.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAA;AACrD,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAA;AACpD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAA;AACjD,OAAO,KAAK,EACV,MAAM,EACN,eAAe,EACf,kBAAkB,EAClB,mBAAmB,EACnB,mBAAmB,EACpB,MAAM,SAAS,CAAA;AAEhB;;;;;GAKG;AACH,qBAAa,UAAW,SAAQ,WAAW,CACzC,MAAM,EACN,mBAAmB,EACnB,mBAAmB,EACnB,SAAS,CAAC,MAAM,CAAC,EACjB,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;IAIhF;;;OAGG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,eAAe,CAAC;IAOhG;;;;;OAKG;IACH,SAAS,CAAC,KAAK,CAAC,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC;IAOxF;;;;;OAKG;IACH,SAAS,CAAC,KAAK,CAAC,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC;CAMzF"}
+{"version":3,"file":"AnswersApi.d.ts","sourceRoot":"","sources":["../../../src/apis/answers/AnswersApi.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAA;AACrD,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAA;AACpD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAA;AACjD,OAAO,KAAK,EACV,MAAM,EACN,eAAe,EACf,kBAAkB,EAClB,mBAAmB,EACnB,mBAAmB,EACpB,MAAM,SAAS,CAAA;AAEhB;;;;GAIG;AACH,qBAAa,UAAW,SAAQ,WAAW,CACzC,MAAM,EACN,mBAAmB,EACnB,mBAAmB,EACnB,SAAS,CAAC,MAAM,CAAC,EACjB,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;IAIhF;;;OAGG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,eAAe,CAAC;IAOhG;;;;;OAKG;IACH,SAAS,CAAC,KAAK,CAAC,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC;IAOxF;;;;;OAKG;IACH,SAAS,CAAC,KAAK,CAAC,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC;IAOxF;;;;;OAKG;IACH,YAAY,CAAC,KAAK,CAAC,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,QAAQ,CAAC;IAI7F;;;;;OAKG;IACH,YAAY,CAAC,KAAK,CAAC,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,QAAQ,CAAC;YAI/E,cAAc;CAgB7B"}

package/dist/apis/answers/AnswersApi.mjs

@@ -2,8 +2,7 @@ import { BaseCrudApi } from "../../core/BaseCrudApi.mjs";
 
 //#region src/apis/answers/AnswersApi.ts
 /**
-* Answers of the evaluation questions. They are written by the bot flow (`SEND_QUESTION`); the
-* CRUD routes exist but validate nothing.
+* Answers of the evaluation questions. They are written by the bot flow (`SEND_QUESTION`).
 *
 * Permissions: `evaluation.view` to read, `evaluation.create`/`update`/`destroy` to write.
 */
@@ -43,6 +42,28 @@ var AnswersApi = class extends BaseCrudApi {
 	exportTxt(query, headers) {
 		return this.client.get(`${this.basePath}/exportation-txt${this.toQueryString(query)}`, headers);
 	}
+	/**
+	* The {@link exportCsv} export as the whole `Response`, to read its headers (`Content-Type`,
+	* `Content-Disposition`) as well as the body. Needs a client with `requestRaw`. Errors are thrown
+	* as in `exportCsv`.
+	* @permissions overview.evaluation.view
+	*/
+	exportCsvRaw(query, headers) {
+		return this.exportResponse("exportation-csv", "exportCsvRaw", query, headers);
+	}
+	/**
+	* The {@link exportTxt} export as the whole `Response`, to read its headers (`Content-Type`,
+	* `Content-Disposition`) as well as the body. The Content-Type is `plain/text` (not
+	* `text/plain`). Needs a client with `requestRaw`. Errors are thrown as in `exportTxt`.
+	* @permissions overview.evaluation.view
+	*/
+	exportTxtRaw(query, headers) {
+		return this.exportResponse("exportation-txt", "exportTxtRaw", query, headers);
+	}
+	async exportResponse(route, method, query, headers) {
+		if (!this.client.requestRaw) throw new Error(`${method} needs a client with requestRaw (the answer is read as a Response)`);
+		return this.client.requestRaw("GET", `${this.basePath}/${route}${this.toQueryString(query)}`, void 0, headers);
+	}
 };
 
 //#endregion

package/dist/apis/answers/AnswersApi.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"AnswersApi.mjs","names":[],"sources":["../../../src/apis/answers/AnswersApi.ts"],"sourcesContent":["import type { ApiClient } from '../../core/ApiClient'\nimport { BaseCrudApi } from '../../core/BaseCrudApi'\nimport type { ListQuery } from '../../core/types'\nimport type {\n  Answer,\n  AnswersOverview,\n  AnswersReportQuery,\n  CreateAnswerPayload,\n  UpdateAnswerPayload,\n} from './types'\n\n/**\n * Answers of the evaluation questions. They are written by the bot flow (`SEND_QUESTION`); the\n * CRUD routes exist but validate nothing.\n *\n * Permissions: `evaluation.view` to read, `evaluation.create`/`update`/`destroy` to write.\n */\nexport class AnswersApi extends BaseCrudApi<\n  Answer,\n  CreateAnswerPayload,\n  UpdateAnswerPayload,\n  ListQuery<Answer>,\n  'OK'\n> {\n  constructor(client: ApiClient) {\n    super(client, '/answers')\n  }\n\n  /**\n   * Deletes an answer (soft delete). Resolves to `'OK'`.\n   * @permissions evaluation.destroy\n   */\n  override deleteById(id: string, headers?: Record<string, string>): Promise<'OK'> {\n    return super.deleteById(id, headers)\n  }\n\n  /**\n   * Counts the NPS and CSAT answers of closed tickets. An error answers 500 with a string body.\n   * @permissions overview.evaluation.view\n   */\n  overview(query?: AnswersReportQuery, headers?: Record<string, string>): Promise<AnswersOverview> {\n    return this.client.get<AnswersOverview>(\n      `${this.basePath}/overview${this.toQueryString(query)}`,\n      headers,\n    )\n  }\n\n  /**\n   * Exports the answers as CSV (`,`, header in the language of the user, dates in the timezone of\n   * the account), sent as the attachment `evaluation-reports.csv`. An unknown `type` answers 400\n   * `{ error: 'Tipo de consulta inválido' }`.\n   * @permissions overview.evaluation.view\n   */\n  exportCsv(query?: AnswersReportQuery, headers?: Record<string, string>): Promise<string> {\n    return this.client.get<string>(\n      `${this.basePath}/exportation-csv${this.toQueryString(query)}`,\n      headers,\n    )\n  }\n\n  /**\n   * Exports the answers as text, one block per answer and the count of unanswered ones at the\n   * end, sent as the attachment `evaluation-reports.txt` (Content-Type `plain/text`). An unknown\n   * `type` answers 400 `{ error: 'Tipo de consulta inválido' }`.\n   * @permissions overview.evaluation.view\n   */\n  exportTxt(query?: AnswersReportQuery, headers?: Record<string, string>): Promise<string> {\n    return this.client.get<string>(\n      `${this.basePath}/exportation-txt${this.toQueryString(query)}`,\n      headers,\n    )\n  }\n}\n"],"mappings":";;;;;;;;;AAiBA,IAAa,aAAb,cAAgC,YAM9B;CACA,YAAY,QAAmB;AAC7B,QAAM,QAAQ,WAAW;;;;;;CAO3B,AAAS,WAAW,IAAY,SAAiD;AAC/E,SAAO,MAAM,WAAW,IAAI,QAAQ;;;;;;CAOtC,SAAS,OAA4B,SAA4D;AAC/F,SAAO,KAAK,OAAO,IACjB,GAAG,KAAK,SAAS,WAAW,KAAK,cAAc,MAAM,IACrD,QACD;;;;;;;;CASH,UAAU,OAA4B,SAAmD;AACvF,SAAO,KAAK,OAAO,IACjB,GAAG,KAAK,SAAS,kBAAkB,KAAK,cAAc,MAAM,IAC5D,QACD;;;;;;;;CASH,UAAU,OAA4B,SAAmD;AACvF,SAAO,KAAK,OAAO,IACjB,GAAG,KAAK,SAAS,kBAAkB,KAAK,cAAc,MAAM,IAC5D,QACD"}
+{"version":3,"file":"AnswersApi.mjs","names":[],"sources":["../../../src/apis/answers/AnswersApi.ts"],"sourcesContent":["import type { ApiClient } from '../../core/ApiClient'\nimport { BaseCrudApi } from '../../core/BaseCrudApi'\nimport type { ListQuery } from '../../core/types'\nimport type {\n  Answer,\n  AnswersOverview,\n  AnswersReportQuery,\n  CreateAnswerPayload,\n  UpdateAnswerPayload,\n} from './types'\n\n/**\n * Answers of the evaluation questions. They are written by the bot flow (`SEND_QUESTION`).\n *\n * Permissions: `evaluation.view` to read, `evaluation.create`/`update`/`destroy` to write.\n */\nexport class AnswersApi extends BaseCrudApi<\n  Answer,\n  CreateAnswerPayload,\n  UpdateAnswerPayload,\n  ListQuery<Answer>,\n  'OK'\n> {\n  constructor(client: ApiClient) {\n    super(client, '/answers')\n  }\n\n  /**\n   * Deletes an answer (soft delete). Resolves to `'OK'`.\n   * @permissions evaluation.destroy\n   */\n  override deleteById(id: string, headers?: Record<string, string>): Promise<'OK'> {\n    return super.deleteById(id, headers)\n  }\n\n  /**\n   * Counts the NPS and CSAT answers of closed tickets. An error answers 500 with a string body.\n   * @permissions overview.evaluation.view\n   */\n  overview(query?: AnswersReportQuery, headers?: Record<string, string>): Promise<AnswersOverview> {\n    return this.client.get<AnswersOverview>(\n      `${this.basePath}/overview${this.toQueryString(query)}`,\n      headers,\n    )\n  }\n\n  /**\n   * Exports the answers as CSV (`,`, header in the language of the user, dates in the timezone of\n   * the account), sent as the attachment `evaluation-reports.csv`. An unknown `type` answers 400\n   * `{ error: 'Tipo de consulta inválido' }`.\n   * @permissions overview.evaluation.view\n   */\n  exportCsv(query?: AnswersReportQuery, headers?: Record<string, string>): Promise<string> {\n    return this.client.get<string>(\n      `${this.basePath}/exportation-csv${this.toQueryString(query)}`,\n      headers,\n    )\n  }\n\n  /**\n   * Exports the answers as text, one block per answer and the count of unanswered ones at the\n   * end, sent as the attachment `evaluation-reports.txt` (Content-Type `plain/text`). An unknown\n   * `type` answers 400 `{ error: 'Tipo de consulta inválido' }`.\n   * @permissions overview.evaluation.view\n   */\n  exportTxt(query?: AnswersReportQuery, headers?: Record<string, string>): Promise<string> {\n    return this.client.get<string>(\n      `${this.basePath}/exportation-txt${this.toQueryString(query)}`,\n      headers,\n    )\n  }\n\n  /**\n   * The {@link exportCsv} export as the whole `Response`, to read its headers (`Content-Type`,\n   * `Content-Disposition`) as well as the body. Needs a client with `requestRaw`. Errors are thrown\n   * as in `exportCsv`.\n   * @permissions overview.evaluation.view\n   */\n  exportCsvRaw(query?: AnswersReportQuery, headers?: Record<string, string>): Promise<Response> {\n    return this.exportResponse('exportation-csv', 'exportCsvRaw', query, headers)\n  }\n\n  /**\n   * The {@link exportTxt} export as the whole `Response`, to read its headers (`Content-Type`,\n   * `Content-Disposition`) as well as the body. The Content-Type is `plain/text` (not\n   * `text/plain`). Needs a client with `requestRaw`. Errors are thrown as in `exportTxt`.\n   * @permissions overview.evaluation.view\n   */\n  exportTxtRaw(query?: AnswersReportQuery, headers?: Record<string, string>): Promise<Response> {\n    return this.exportResponse('exportation-txt', 'exportTxtRaw', query, headers)\n  }\n\n  private async exportResponse(\n    route: 'exportation-csv' | 'exportation-txt',\n    method: 'exportCsvRaw' | 'exportTxtRaw',\n    query?: AnswersReportQuery,\n    headers?: Record<string, string>,\n  ): Promise<Response> {\n    if (!this.client.requestRaw) {\n      throw new Error(`${method} needs a client with requestRaw (the answer is read as a Response)`)\n    }\n    return this.client.requestRaw(\n      'GET',\n      `${this.basePath}/${route}${this.toQueryString(query)}`,\n      undefined,\n      headers,\n    )\n  }\n}\n"],"mappings":";;;;;;;;AAgBA,IAAa,aAAb,cAAgC,YAM9B;CACA,YAAY,QAAmB;AAC7B,QAAM,QAAQ,WAAW;;;;;;CAO3B,AAAS,WAAW,IAAY,SAAiD;AAC/E,SAAO,MAAM,WAAW,IAAI,QAAQ;;;;;;CAOtC,SAAS,OAA4B,SAA4D;AAC/F,SAAO,KAAK,OAAO,IACjB,GAAG,KAAK,SAAS,WAAW,KAAK,cAAc,MAAM,IACrD,QACD;;;;;;;;CASH,UAAU,OAA4B,SAAmD;AACvF,SAAO,KAAK,OAAO,IACjB,GAAG,KAAK,SAAS,kBAAkB,KAAK,cAAc,MAAM,IAC5D,QACD;;;;;;;;CASH,UAAU,OAA4B,SAAmD;AACvF,SAAO,KAAK,OAAO,IACjB,GAAG,KAAK,SAAS,kBAAkB,KAAK,cAAc,MAAM,IAC5D,QACD;;;;;;;;CASH,aAAa,OAA4B,SAAqD;AAC5F,SAAO,KAAK,eAAe,mBAAmB,gBAAgB,OAAO,QAAQ;;;;;;;;CAS/E,aAAa,OAA4B,SAAqD;AAC5F,SAAO,KAAK,eAAe,mBAAmB,gBAAgB,OAAO,QAAQ;;CAG/E,MAAc,eACZ,OACA,QACA,OACA,SACmB;AACnB,MAAI,CAAC,KAAK,OAAO,WACf,OAAM,IAAI,MAAM,GAAG,OAAO,oEAAoE;AAEhG,SAAO,KAAK,OAAO,WACjB,OACA,GAAG,KAAK,SAAS,GAAG,QAAQ,KAAK,cAAc,MAAM,IACrD,QACA,QACD"}

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

@@ -23,8 +23,7 @@ export type Answer = {
 /** @deprecated The route drops every `include` (empty whitelist). */
 export type AnswerRelationships = 'question' | 'ticket';
 /**
- * The route validates nothing: not the question, the ticket nor their account, and the answer is
- * saved even for an open ticket.
+ * The answer of a question of the account to a ticket of the account (an open ticket included).
  */
 export type CreateAnswerPayload = {
     text: string;

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

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/apis/answers/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAA;AAClD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAA;AAE9C,MAAM,MAAM,MAAM,GAAG;IACnB,EAAE,EAAE,MAAM,CAAA;IACV;;;OAGG;IACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;IACnB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAA;IACrB,WAAW,EAAE,OAAO,CAAA;IACpB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAA;IACrB,UAAU,EAAE,MAAM,CAAA;IAClB,QAAQ,EAAE,MAAM,CAAA;IAChB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB,kFAAkF;IAClF,QAAQ,CAAC,EAAE,QAAQ,CAAA;IACnB,kFAAkF;IAClF,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB,CAAA;AAED,qEAAqE;AACrE,MAAM,MAAM,mBAAmB,GAAG,UAAU,GAAG,QAAQ,CAAA;AAEvD;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC,IAAI,EAAE,MAAM,CAAA;IACZ,UAAU,EAAE,MAAM,CAAA;IAClB,QAAQ,EAAE,MAAM,CAAA;IAChB,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB,CAAA;AAED,MAAM,MAAM,mBAAmB,GAAG;IAChC,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B,4GAA4G;IAC5G,IAAI,CAAC,EAAE,KAAK,GAAG,MAAM,GAAG,SAAS,CAAA;IACjC,gHAAgH;IAChH,UAAU,CAAC,EAAE,KAAK,GAAG,UAAU,GAAG,WAAW,CAAA;IAC7C,gBAAgB;IAChB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,gBAAgB;IAChB,EAAE,CAAC,EAAE,MAAM,CAAA;IACX,+BAA+B;IAC/B,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,gCAAgC;IAChC,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,iCAAiC;IACjC,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB,CAAA;AAED,MAAM,MAAM,mBAAmB,GAAG;IAChC,cAAc,EAAE,MAAM,CAAA;IACtB,SAAS,EAAE,MAAM,CAAA;IACjB,OAAO,EAAE,MAAM,CAAA;IACf,WAAW,EAAE,MAAM,CAAA;IACnB,gBAAgB,EAAE,MAAM,CAAA;IACxB,SAAS,EAAE,MAAM,CAAA;IACjB,OAAO,EAAE,MAAM,CAAA;IACf;;;OAGG;IACH,EAAE,EAAE,MAAM,CAAA;CACX,CAAA;AAED,uGAAuG;AACvG,MAAM,MAAM,kBAAkB,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,GAAG,EAAE,CAAA;AAE9E,MAAM,MAAM,eAAe,GAAG;IAC5B,KAAK,EAAE;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,CAAA;IACrD,IAAI,EAAE;QACJ,GAAG,EAAE,kBAAkB,CAAA;QACvB,mCAAmC;QACnC,IAAI,EAAE,mBAAmB,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAA;QACjD,2EAA2E;QAC3E,uBAAuB,CAAC,EAAE,OAAO,CAAA;QACjC,mEAAmE;QACnE,MAAM,CAAC,EAAE,mBAAmB,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAA;KACrD,CAAA;CACF,CAAA"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/apis/answers/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAA;AAClD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAA;AAE9C,MAAM,MAAM,MAAM,GAAG;IACnB,EAAE,EAAE,MAAM,CAAA;IACV;;;OAGG;IACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;IACnB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAA;IACrB,WAAW,EAAE,OAAO,CAAA;IACpB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAA;IACrB,UAAU,EAAE,MAAM,CAAA;IAClB,QAAQ,EAAE,MAAM,CAAA;IAChB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB,kFAAkF;IAClF,QAAQ,CAAC,EAAE,QAAQ,CAAA;IACnB,kFAAkF;IAClF,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB,CAAA;AAED,qEAAqE;AACrE,MAAM,MAAM,mBAAmB,GAAG,UAAU,GAAG,QAAQ,CAAA;AAEvD;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC,IAAI,EAAE,MAAM,CAAA;IACZ,UAAU,EAAE,MAAM,CAAA;IAClB,QAAQ,EAAE,MAAM,CAAA;IAChB,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB,CAAA;AAED,MAAM,MAAM,mBAAmB,GAAG;IAChC,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B,4GAA4G;IAC5G,IAAI,CAAC,EAAE,KAAK,GAAG,MAAM,GAAG,SAAS,CAAA;IACjC,gHAAgH;IAChH,UAAU,CAAC,EAAE,KAAK,GAAG,UAAU,GAAG,WAAW,CAAA;IAC7C,gBAAgB;IAChB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,gBAAgB;IAChB,EAAE,CAAC,EAAE,MAAM,CAAA;IACX,+BAA+B;IAC/B,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,gCAAgC;IAChC,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,iCAAiC;IACjC,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB,CAAA;AAED,MAAM,MAAM,mBAAmB,GAAG;IAChC,cAAc,EAAE,MAAM,CAAA;IACtB,SAAS,EAAE,MAAM,CAAA;IACjB,OAAO,EAAE,MAAM,CAAA;IACf,WAAW,EAAE,MAAM,CAAA;IACnB,gBAAgB,EAAE,MAAM,CAAA;IACxB,SAAS,EAAE,MAAM,CAAA;IACjB,OAAO,EAAE,MAAM,CAAA;IACf;;;OAGG;IACH,EAAE,EAAE,MAAM,CAAA;CACX,CAAA;AAED,uGAAuG;AACvG,MAAM,MAAM,kBAAkB,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,GAAG,EAAE,CAAA;AAE9E,MAAM,MAAM,eAAe,GAAG;IAC5B,KAAK,EAAE;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,CAAA;IACrD,IAAI,EAAE;QACJ,GAAG,EAAE,kBAAkB,CAAA;QACvB,mCAAmC;QACnC,IAAI,EAAE,mBAAmB,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAA;QACjD,2EAA2E;QAC3E,uBAAuB,CAAC,EAAE,OAAO,CAAA;QACjC,mEAAmE;QACnE,MAAM,CAAC,EAAE,mBAAmB,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAA;KACrD,CAAA;CACF,CAAA"}

package/dist/apis/bots/BotsApi.cjs

@@ -6,9 +6,6 @@ const require_core_BaseApi = require('../../core/BaseApi.cjs');
 * Bots. The list route always paginates (`paginate: false` is ignored), so this class does not
 * extend `BaseCrudApi`. The contexts travel as a list (`BotContextInput` / `BotParsedContext`),
 * not as the stored map that `BotVersionsApi` serves.
-*
-* `GET /bots/:id/errors/export` is not exposed: it answers a binary xlsx, and `ApiClient` only
-* handles JSON/text bodies.
 */
 var BotsApi = class extends require_core_BaseApi.BaseApi {
 	basePath = "/bots";
@@ -74,9 +71,22 @@ var BotsApi = class extends require_core_BaseApi.BaseApi {
 		return this.client.get(`${this.basePath}/${id}/errors${this.toQueryString(query)}`, headers);
 	}
 	/**
+	* Exports the failed steps of the bot runs of the last 30 days as an xlsx workbook (binary).
+	* Needs a client with `requestRaw`. A period without errors answers 400 `No errors found to
+	* export`; an unknown bot answers 404.
+	* @permissions bots.view
+	*/
+	async exportErrors(id, headers) {
+		if (!this.client.requestRaw) throw new Error("exportErrors needs a client with requestRaw (the answer is a binary xlsx)");
+		return (await this.client.requestRaw("GET", `${this.basePath}/${id}/errors/export`, void 0, headers)).arrayBuffer();
+	}
+	/**
 	* Fires the `API_SIGNAL` trigger of the bot for the contact, with an optional `flag` (read by
 	* the `api_signal_flag` condition). Asynchronous: always resolves with no content, and the
-	* worker only runs it when the contact has an open ticket.
+	* worker only runs it when the contact has an open ticket. The worker runs the flow of `botId`
+	* on the engine of the bot of the contact's connection (see `BotSettings.botCreatedVersion`; when
+	* the connection has no bot, the engine of the `botId` bot). `triggerSignal` does not reach the
+	* bot simulator (there the `API_SIGNAL` path is picked by hand, with no `flag`).
 	* @permissions bots.view
 	*/
 	triggerSignal(botId, contactId, flag, headers) {
@@ -94,9 +104,8 @@ var BotsApi = class extends require_core_BaseApi.BaseApi {
 	}
 	/**
 	* Generates a prompt for an AI agent of the bot. COSTS one AI agent credit of the account and
-	* calls OpenAI. No permission check: any authenticated user. A missing field answers 400; an
-	* option outside the lists, or the AI agent limit of the account reached
-	* (`Agent limit reached`), answers 500.
+	* calls OpenAI. A missing field answers 400; an option outside the lists, or the AI agent limit
+	* of the account reached (`Agent limit reached`), answers 500.
 	*/
 	suggestAgentPrompt(body, headers) {
 		return this.client.post(`${this.basePath}/suggest-agent-prompt`, body, headers);

package/dist/apis/bots/BotsApi.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"BotsApi.cjs","names":["BaseApi"],"sources":["../../../src/apis/bots/BotsApi.ts"],"sourcesContent":["import { BaseApi } from '../../core/BaseApi'\nimport type {\n  GetByIdQuery,\n  HasCreate,\n  HasDeleteById,\n  HasGetById,\n  HasUpdateById,\n  ListQuery,\n  Paginated,\n} from '../../core/types'\nimport type {\n  Bot,\n  BotErrorsQuery,\n  BotHistory,\n  CreateBotPayload,\n  SuggestAgentPromptPayload,\n  UpdateBotPayload,\n} from './types'\n\n/**\n * Bots. The list route always paginates (`paginate: false` is ignored), so this class does not\n * extend `BaseCrudApi`. The contexts travel as a list (`BotContextInput` / `BotParsedContext`),\n * not as the stored map that `BotVersionsApi` serves.\n *\n * `GET /bots/:id/errors/export` is not exposed: it answers a binary xlsx, and `ApiClient` only\n * handles JSON/text bodies.\n */\nexport class BotsApi\n  extends BaseApi\n  implements\n    HasGetById<Bot>,\n    HasCreate<Bot, CreateBotPayload>,\n    HasUpdateById<Bot, UpdateBotPayload>,\n    HasDeleteById<'OK' | false>\n{\n  public readonly basePath = '/bots'\n\n  /**\n   * Lists the bots of the account. Always paginated, even with `paginate: false`.\n   * @permissions bots.view\n   */\n  getMany(query?: ListQuery<Bot>, headers?: Record<string, string>): Promise<Paginated<Bot>> {\n    return this.client.get<Paginated<Bot>>(`${this.basePath}${this.toQueryString(query)}`, headers)\n  }\n\n  /**\n   * Returns the first bot matching the query, or `null` when none match.\n   * @permissions bots.view\n   */\n  async getOne(query?: ListQuery<Bot>, headers?: Record<string, string>): Promise<Bot | null> {\n    const page = await this.getMany({ ...query, perPage: 1, page: 1 }, headers)\n    return page?.data?.[0] ?? null\n  }\n\n  /**\n   * Returns a bot by ID, with `defaultContexts` (the stored map, as a JSON string). An unknown id\n   * answers 500, not an empty body.\n   * @permissions bots.view\n   */\n  getById(id: string, query?: GetByIdQuery<Bot>, headers?: Record<string, string>): Promise<Bot> {\n    return this.client.get<Bot>(`${this.basePath}/${id}${this.toQueryString(query)}`, headers)\n  }\n\n  /**\n   * Creates a bot and its first version (published, or a draft with `isDraft`). A duplicate name\n   * answers 409, unless the account allows duplicate names. Send `flowJson` with `edges`, or the\n   * bot never sends a message (SD-2323).\n   * @permissions bots.create\n   */\n  create(body: CreateBotPayload, headers?: Record<string, string>): Promise<Bot> {\n    return this.client.post<Bot, CreateBotPayload>(this.basePath, body, headers)\n  }\n\n  /**\n   * Saves the flow (publishing a version, or into the draft with `isDraft`), or only renames the\n   * bot with `onlyUpdateBotName`. Resolves to the bot with `defaultContexts` as an object.\n   * @permissions bots.view OR bots.update\n   */\n  updateById(id: string, body: UpdateBotPayload, headers?: Record<string, string>): Promise<Bot> {\n    return this.client.put<Bot, UpdateBotPayload>(`${this.basePath}/${id}`, body, headers)\n  }\n\n  /**\n   * Deletes a bot and its versions (hard delete). Today resolves to `false` even when the bot was\n   * deleted (the backend destroy returns nothing); it becomes `'OK'` once the destroy returns the\n   * bot, as in the other routes. Do not read the result as success or failure. An unknown id\n   * answers 500.\n   * @permissions bots.view OR bots.destroy\n   */\n  deleteById(id: string, headers?: Record<string, string>): Promise<'OK' | false> {\n    return this.client.delete<'OK' | false>(`${this.basePath}/${id}`, headers)\n  }\n\n  /**\n   * Lists the failed steps of the bot runs, newest first by default. An unknown bot answers an\n   * empty page.\n   * @permissions bots.view\n   */\n  getErrors(\n    id: string,\n    query?: BotErrorsQuery,\n    headers?: Record<string, string>,\n  ): Promise<Paginated<BotHistory>> {\n    return this.client.get<Paginated<BotHistory>>(\n      `${this.basePath}/${id}/errors${this.toQueryString(query)}`,\n      headers,\n    )\n  }\n\n  /**\n   * Fires the `API_SIGNAL` trigger of the bot for the contact, with an optional `flag` (read by\n   * the `api_signal_flag` condition). Asynchronous: always resolves with no content, and the\n   * worker only runs it when the contact has an open ticket.\n   * @permissions bots.view\n   */\n  triggerSignal(\n    botId: string,\n    contactId: string,\n    flag?: string,\n    headers?: Record<string, string>,\n  ): Promise<void> {\n    return this.client.post<void, { flag: string } | undefined>(\n      `${this.basePath}/${botId}/trigger-signal/${contactId}`,\n      flag === undefined ? undefined : { flag },\n      headers,\n    )\n  }\n\n  /**\n   * Answers a pending asynchronous `HTTP_REQUEST` action: `body` becomes the response the bot\n   * reads. Resolves with no content. An unknown history answers 404; a history that is not\n   * `PENDING`, or of another bot, answers 400. JSON bodies only (the route also takes text, XML\n   * and CSV), up to 250 KB.\n   * @permissions bots.view\n   */\n  requestCallback(\n    id: string,\n    pendingRequestId: string,\n    body: unknown,\n    headers?: Record<string, string>,\n  ): Promise<void> {\n    return this.client.post<void, unknown>(\n      `${this.basePath}/${id}/request-callback/${pendingRequestId}`,\n      body,\n      headers,\n    )\n  }\n\n  /**\n   * Generates a prompt for an AI agent of the bot. COSTS one AI agent credit of the account and\n   * calls OpenAI. No permission check: any authenticated user. A missing field answers 400; an\n   * option outside the lists, or the AI agent limit of the account reached\n   * (`Agent limit reached`), answers 500.\n   */\n  suggestAgentPrompt(\n    body: SuggestAgentPromptPayload,\n    headers?: Record<string, string>,\n  ): Promise<string> {\n    return this.client.post<string, SuggestAgentPromptPayload>(\n      `${this.basePath}/suggest-agent-prompt`,\n      body,\n      headers,\n    )\n  }\n}\n"],"mappings":";;;;;;;;;;;;AA2BA,IAAa,UAAb,cACUA,6BAMV;CACE,AAAgB,WAAW;;;;;CAM3B,QAAQ,OAAwB,SAA2D;AACzF,SAAO,KAAK,OAAO,IAAoB,GAAG,KAAK,WAAW,KAAK,cAAc,MAAM,IAAI,QAAQ;;;;;;CAOjG,MAAM,OAAO,OAAwB,SAAuD;AAE1F,UADa,MAAM,KAAK,QAAQ;GAAE,GAAG;GAAO,SAAS;GAAG,MAAM;GAAG,EAAE,QAAQ,GAC9D,OAAO,MAAM;;;;;;;CAQ5B,QAAQ,IAAY,OAA2B,SAAgD;AAC7F,SAAO,KAAK,OAAO,IAAS,GAAG,KAAK,SAAS,GAAG,KAAK,KAAK,cAAc,MAAM,IAAI,QAAQ;;;;;;;;CAS5F,OAAO,MAAwB,SAAgD;AAC7E,SAAO,KAAK,OAAO,KAA4B,KAAK,UAAU,MAAM,QAAQ;;;;;;;CAQ9E,WAAW,IAAY,MAAwB,SAAgD;AAC7F,SAAO,KAAK,OAAO,IAA2B,GAAG,KAAK,SAAS,GAAG,MAAM,MAAM,QAAQ;;;;;;;;;CAUxF,WAAW,IAAY,SAAyD;AAC9E,SAAO,KAAK,OAAO,OAAqB,GAAG,KAAK,SAAS,GAAG,MAAM,QAAQ;;;;;;;CAQ5E,UACE,IACA,OACA,SACgC;AAChC,SAAO,KAAK,OAAO,IACjB,GAAG,KAAK,SAAS,GAAG,GAAG,SAAS,KAAK,cAAc,MAAM,IACzD,QACD;;;;;;;;CASH,cACE,OACA,WACA,MACA,SACe;AACf,SAAO,KAAK,OAAO,KACjB,GAAG,KAAK,SAAS,GAAG,MAAM,kBAAkB,aAC5C,SAAS,SAAY,SAAY,EAAE,MAAM,EACzC,QACD;;;;;;;;;CAUH,gBACE,IACA,kBACA,MACA,SACe;AACf,SAAO,KAAK,OAAO,KACjB,GAAG,KAAK,SAAS,GAAG,GAAG,oBAAoB,oBAC3C,MACA,QACD;;;;;;;;CASH,mBACE,MACA,SACiB;AACjB,SAAO,KAAK,OAAO,KACjB,GAAG,KAAK,SAAS,wBACjB,MACA,QACD"}
+{"version":3,"file":"BotsApi.cjs","names":["BaseApi"],"sources":["../../../src/apis/bots/BotsApi.ts"],"sourcesContent":["import { BaseApi } from '../../core/BaseApi'\nimport type {\n  GetByIdQuery,\n  HasCreate,\n  HasDeleteById,\n  HasGetById,\n  HasUpdateById,\n  ListQuery,\n  Paginated,\n} from '../../core/types'\nimport type {\n  Bot,\n  BotErrorsQuery,\n  BotHistory,\n  CreateBotPayload,\n  SuggestAgentPromptPayload,\n  UpdateBotPayload,\n} from './types'\n\n/**\n * Bots. The list route always paginates (`paginate: false` is ignored), so this class does not\n * extend `BaseCrudApi`. The contexts travel as a list (`BotContextInput` / `BotParsedContext`),\n * not as the stored map that `BotVersionsApi` serves.\n */\nexport class BotsApi\n  extends BaseApi\n  implements\n    HasGetById<Bot>,\n    HasCreate<Bot, CreateBotPayload>,\n    HasUpdateById<Bot, UpdateBotPayload>,\n    HasDeleteById<'OK' | false>\n{\n  public readonly basePath = '/bots'\n\n  /**\n   * Lists the bots of the account. Always paginated, even with `paginate: false`.\n   * @permissions bots.view\n   */\n  getMany(query?: ListQuery<Bot>, headers?: Record<string, string>): Promise<Paginated<Bot>> {\n    return this.client.get<Paginated<Bot>>(`${this.basePath}${this.toQueryString(query)}`, headers)\n  }\n\n  /**\n   * Returns the first bot matching the query, or `null` when none match.\n   * @permissions bots.view\n   */\n  async getOne(query?: ListQuery<Bot>, headers?: Record<string, string>): Promise<Bot | null> {\n    const page = await this.getMany({ ...query, perPage: 1, page: 1 }, headers)\n    return page?.data?.[0] ?? null\n  }\n\n  /**\n   * Returns a bot by ID, with `defaultContexts` (the stored map, as a JSON string). An unknown id\n   * answers 500, not an empty body.\n   * @permissions bots.view\n   */\n  getById(id: string, query?: GetByIdQuery<Bot>, headers?: Record<string, string>): Promise<Bot> {\n    return this.client.get<Bot>(`${this.basePath}/${id}${this.toQueryString(query)}`, headers)\n  }\n\n  /**\n   * Creates a bot and its first version (published, or a draft with `isDraft`). A duplicate name\n   * answers 409, unless the account allows duplicate names. Send `flowJson` with `edges`, or the\n   * bot never sends a message (SD-2323).\n   * @permissions bots.create\n   */\n  create(body: CreateBotPayload, headers?: Record<string, string>): Promise<Bot> {\n    return this.client.post<Bot, CreateBotPayload>(this.basePath, body, headers)\n  }\n\n  /**\n   * Saves the flow (publishing a version, or into the draft with `isDraft`), or only renames the\n   * bot with `onlyUpdateBotName`. Resolves to the bot with `defaultContexts` as an object.\n   * @permissions bots.view OR bots.update\n   */\n  updateById(id: string, body: UpdateBotPayload, headers?: Record<string, string>): Promise<Bot> {\n    return this.client.put<Bot, UpdateBotPayload>(`${this.basePath}/${id}`, body, headers)\n  }\n\n  /**\n   * Deletes a bot and its versions (hard delete). Today resolves to `false` even when the bot was\n   * deleted (the backend destroy returns nothing); it becomes `'OK'` once the destroy returns the\n   * bot, as in the other routes. Do not read the result as success or failure. An unknown id\n   * answers 500.\n   * @permissions bots.view OR bots.destroy\n   */\n  deleteById(id: string, headers?: Record<string, string>): Promise<'OK' | false> {\n    return this.client.delete<'OK' | false>(`${this.basePath}/${id}`, headers)\n  }\n\n  /**\n   * Lists the failed steps of the bot runs, newest first by default. An unknown bot answers an\n   * empty page.\n   * @permissions bots.view\n   */\n  getErrors(\n    id: string,\n    query?: BotErrorsQuery,\n    headers?: Record<string, string>,\n  ): Promise<Paginated<BotHistory>> {\n    return this.client.get<Paginated<BotHistory>>(\n      `${this.basePath}/${id}/errors${this.toQueryString(query)}`,\n      headers,\n    )\n  }\n\n  /**\n   * Exports the failed steps of the bot runs of the last 30 days as an xlsx workbook (binary).\n   * Needs a client with `requestRaw`. A period without errors answers 400 `No errors found to\n   * export`; an unknown bot answers 404.\n   * @permissions bots.view\n   */\n  async exportErrors(id: string, headers?: Record<string, string>): Promise<ArrayBuffer> {\n    if (!this.client.requestRaw) {\n      throw new Error('exportErrors needs a client with requestRaw (the answer is a binary xlsx)')\n    }\n    const response = await this.client.requestRaw(\n      'GET',\n      `${this.basePath}/${id}/errors/export`,\n      undefined,\n      headers,\n    )\n    return response.arrayBuffer()\n  }\n\n  /**\n   * Fires the `API_SIGNAL` trigger of the bot for the contact, with an optional `flag` (read by\n   * the `api_signal_flag` condition). Asynchronous: always resolves with no content, and the\n   * worker only runs it when the contact has an open ticket. The worker runs the flow of `botId`\n   * on the engine of the bot of the contact's connection (see `BotSettings.botCreatedVersion`; when\n   * the connection has no bot, the engine of the `botId` bot). `triggerSignal` does not reach the\n   * bot simulator (there the `API_SIGNAL` path is picked by hand, with no `flag`).\n   * @permissions bots.view\n   */\n  triggerSignal(\n    botId: string,\n    contactId: string,\n    flag?: string,\n    headers?: Record<string, string>,\n  ): Promise<void> {\n    return this.client.post<void, { flag: string } | undefined>(\n      `${this.basePath}/${botId}/trigger-signal/${contactId}`,\n      flag === undefined ? undefined : { flag },\n      headers,\n    )\n  }\n\n  /**\n   * Answers a pending asynchronous `HTTP_REQUEST` action: `body` becomes the response the bot\n   * reads. Resolves with no content. An unknown history answers 404; a history that is not\n   * `PENDING`, or of another bot, answers 400. JSON bodies only (the route also takes text, XML\n   * and CSV), up to 250 KB.\n   * @permissions bots.view\n   */\n  requestCallback(\n    id: string,\n    pendingRequestId: string,\n    body: unknown,\n    headers?: Record<string, string>,\n  ): Promise<void> {\n    return this.client.post<void, unknown>(\n      `${this.basePath}/${id}/request-callback/${pendingRequestId}`,\n      body,\n      headers,\n    )\n  }\n\n  /**\n   * Generates a prompt for an AI agent of the bot. COSTS one AI agent credit of the account and\n   * calls OpenAI. A missing field answers 400; an option outside the lists, or the AI agent limit\n   * of the account reached (`Agent limit reached`), answers 500.\n   */\n  suggestAgentPrompt(\n    body: SuggestAgentPromptPayload,\n    headers?: Record<string, string>,\n  ): Promise<string> {\n    return this.client.post<string, SuggestAgentPromptPayload>(\n      `${this.basePath}/suggest-agent-prompt`,\n      body,\n      headers,\n    )\n  }\n}\n"],"mappings":";;;;;;;;;AAwBA,IAAa,UAAb,cACUA,6BAMV;CACE,AAAgB,WAAW;;;;;CAM3B,QAAQ,OAAwB,SAA2D;AACzF,SAAO,KAAK,OAAO,IAAoB,GAAG,KAAK,WAAW,KAAK,cAAc,MAAM,IAAI,QAAQ;;;;;;CAOjG,MAAM,OAAO,OAAwB,SAAuD;AAE1F,UADa,MAAM,KAAK,QAAQ;GAAE,GAAG;GAAO,SAAS;GAAG,MAAM;GAAG,EAAE,QAAQ,GAC9D,OAAO,MAAM;;;;;;;CAQ5B,QAAQ,IAAY,OAA2B,SAAgD;AAC7F,SAAO,KAAK,OAAO,IAAS,GAAG,KAAK,SAAS,GAAG,KAAK,KAAK,cAAc,MAAM,IAAI,QAAQ;;;;;;;;CAS5F,OAAO,MAAwB,SAAgD;AAC7E,SAAO,KAAK,OAAO,KAA4B,KAAK,UAAU,MAAM,QAAQ;;;;;;;CAQ9E,WAAW,IAAY,MAAwB,SAAgD;AAC7F,SAAO,KAAK,OAAO,IAA2B,GAAG,KAAK,SAAS,GAAG,MAAM,MAAM,QAAQ;;;;;;;;;CAUxF,WAAW,IAAY,SAAyD;AAC9E,SAAO,KAAK,OAAO,OAAqB,GAAG,KAAK,SAAS,GAAG,MAAM,QAAQ;;;;;;;CAQ5E,UACE,IACA,OACA,SACgC;AAChC,SAAO,KAAK,OAAO,IACjB,GAAG,KAAK,SAAS,GAAG,GAAG,SAAS,KAAK,cAAc,MAAM,IACzD,QACD;;;;;;;;CASH,MAAM,aAAa,IAAY,SAAwD;AACrF,MAAI,CAAC,KAAK,OAAO,WACf,OAAM,IAAI,MAAM,4EAA4E;AAQ9F,UANiB,MAAM,KAAK,OAAO,WACjC,OACA,GAAG,KAAK,SAAS,GAAG,GAAG,iBACvB,QACA,QACD,EACe,aAAa;;;;;;;;;;;CAY/B,cACE,OACA,WACA,MACA,SACe;AACf,SAAO,KAAK,OAAO,KACjB,GAAG,KAAK,SAAS,GAAG,MAAM,kBAAkB,aAC5C,SAAS,SAAY,SAAY,EAAE,MAAM,EACzC,QACD;;;;;;;;;CAUH,gBACE,IACA,kBACA,MACA,SACe;AACf,SAAO,KAAK,OAAO,KACjB,GAAG,KAAK,SAAS,GAAG,GAAG,oBAAoB,oBAC3C,MACA,QACD;;;;;;;CAQH,mBACE,MACA,SACiB;AACjB,SAAO,KAAK,OAAO,KACjB,GAAG,KAAK,SAAS,wBACjB,MACA,QACD"}

package/dist/apis/bots/BotsApi.d.ts

@@ -5,9 +5,6 @@ import type { Bot, BotErrorsQuery, BotHistory, CreateBotPayload, SuggestAgentPro
  * Bots. The list route always paginates (`paginate: false` is ignored), so this class does not
  * extend `BaseCrudApi`. The contexts travel as a list (`BotContextInput` / `BotParsedContext`),
  * not as the stored map that `BotVersionsApi` serves.
- *
- * `GET /bots/:id/errors/export` is not exposed: it answers a binary xlsx, and `ApiClient` only
- * handles JSON/text bodies.
  */
 export declare class BotsApi extends BaseApi implements HasGetById<Bot>, HasCreate<Bot, CreateBotPayload>, HasUpdateById<Bot, UpdateBotPayload>, HasDeleteById<'OK' | false> {
     readonly basePath = "/bots";
@@ -54,10 +51,20 @@ export declare class BotsApi extends BaseApi implements HasGetById<Bot>, HasCrea
      * @permissions bots.view
      */
     getErrors(id: string, query?: BotErrorsQuery, headers?: Record<string, string>): Promise<Paginated<BotHistory>>;
+    /**
+     * Exports the failed steps of the bot runs of the last 30 days as an xlsx workbook (binary).
+     * Needs a client with `requestRaw`. A period without errors answers 400 `No errors found to
+     * export`; an unknown bot answers 404.
+     * @permissions bots.view
+     */
+    exportErrors(id: string, headers?: Record<string, string>): Promise<ArrayBuffer>;
     /**
      * Fires the `API_SIGNAL` trigger of the bot for the contact, with an optional `flag` (read by
      * the `api_signal_flag` condition). Asynchronous: always resolves with no content, and the
-     * worker only runs it when the contact has an open ticket.
+     * worker only runs it when the contact has an open ticket. The worker runs the flow of `botId`
+     * on the engine of the bot of the contact's connection (see `BotSettings.botCreatedVersion`; when
+     * the connection has no bot, the engine of the `botId` bot). `triggerSignal` does not reach the
+     * bot simulator (there the `API_SIGNAL` path is picked by hand, with no `flag`).
      * @permissions bots.view
      */
     triggerSignal(botId: string, contactId: string, flag?: string, headers?: Record<string, string>): Promise<void>;
@@ -71,9 +78,8 @@ export declare class BotsApi extends BaseApi implements HasGetById<Bot>, HasCrea
     requestCallback(id: string, pendingRequestId: string, body: unknown, headers?: Record<string, string>): Promise<void>;
     /**
      * Generates a prompt for an AI agent of the bot. COSTS one AI agent credit of the account and
-     * calls OpenAI. No permission check: any authenticated user. A missing field answers 400; an
-     * option outside the lists, or the AI agent limit of the account reached
-     * (`Agent limit reached`), answers 500.
+     * calls OpenAI. A missing field answers 400; an option outside the lists, or the AI agent limit
+     * of the account reached (`Agent limit reached`), answers 500.
      */
     suggestAgentPrompt(body: SuggestAgentPromptPayload, headers?: Record<string, string>): Promise<string>;
 }

package/dist/apis/bots/BotsApi.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"BotsApi.d.ts","sourceRoot":"","sources":["../../../src/apis/bots/BotsApi.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAA;AAC5C,OAAO,KAAK,EACV,YAAY,EACZ,SAAS,EACT,aAAa,EACb,UAAU,EACV,aAAa,EACb,SAAS,EACT,SAAS,EACV,MAAM,kBAAkB,CAAA;AACzB,OAAO,KAAK,EACV,GAAG,EACH,cAAc,EACd,UAAU,EACV,gBAAgB,EAChB,yBAAyB,EACzB,gBAAgB,EACjB,MAAM,SAAS,CAAA;AAEhB;;;;;;;GAOG;AACH,qBAAa,OACX,SAAQ,OACR,YACE,UAAU,CAAC,GAAG,CAAC,EACf,SAAS,CAAC,GAAG,EAAE,gBAAgB,CAAC,EAChC,aAAa,CAAC,GAAG,EAAE,gBAAgB,CAAC,EACpC,aAAa,CAAC,IAAI,GAAG,KAAK,CAAC;IAE7B,SAAgB,QAAQ,WAAU;IAElC;;;OAGG;IACH,OAAO,CAAC,KAAK,CAAC,EAAE,SAAS,CAAC,GAAG,CAAC,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;IAI1F;;;OAGG;IACG,MAAM,CAAC,KAAK,CAAC,EAAE,SAAS,CAAC,GAAG,CAAC,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,GAAG,GAAG,IAAI,CAAC;IAK3F;;;;OAIG;IACH,OAAO,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,YAAY,CAAC,GAAG,CAAC,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,GAAG,CAAC;IAI9F;;;;;OAKG;IACH,MAAM,CAAC,IAAI,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,GAAG,CAAC;IAI9E;;;;OAIG;IACH,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,GAAG,CAAC;IAI9F;;;;;;OAMG;IACH,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,IAAI,GAAG,KAAK,CAAC;IAI/E;;;;OAIG;IACH,SAAS,CACP,EAAE,EAAE,MAAM,EACV,KAAK,CAAC,EAAE,cAAc,EACtB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;IAOjC;;;;;OAKG;IACH,aAAa,CACX,KAAK,EAAE,MAAM,EACb,SAAS,EAAE,MAAM,EACjB,IAAI,CAAC,EAAE,MAAM,EACb,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,IAAI,CAAC;IAQhB;;;;;;OAMG;IACH,eAAe,CACb,EAAE,EAAE,MAAM,EACV,gBAAgB,EAAE,MAAM,EACxB,IAAI,EAAE,OAAO,EACb,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,IAAI,CAAC;IAQhB;;;;;OAKG;IACH,kBAAkB,CAChB,IAAI,EAAE,yBAAyB,EAC/B,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,MAAM,CAAC;CAOnB"}
+{"version":3,"file":"BotsApi.d.ts","sourceRoot":"","sources":["../../../src/apis/bots/BotsApi.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAA;AAC5C,OAAO,KAAK,EACV,YAAY,EACZ,SAAS,EACT,aAAa,EACb,UAAU,EACV,aAAa,EACb,SAAS,EACT,SAAS,EACV,MAAM,kBAAkB,CAAA;AACzB,OAAO,KAAK,EACV,GAAG,EACH,cAAc,EACd,UAAU,EACV,gBAAgB,EAChB,yBAAyB,EACzB,gBAAgB,EACjB,MAAM,SAAS,CAAA;AAEhB;;;;GAIG;AACH,qBAAa,OACX,SAAQ,OACR,YACE,UAAU,CAAC,GAAG,CAAC,EACf,SAAS,CAAC,GAAG,EAAE,gBAAgB,CAAC,EAChC,aAAa,CAAC,GAAG,EAAE,gBAAgB,CAAC,EACpC,aAAa,CAAC,IAAI,GAAG,KAAK,CAAC;IAE7B,SAAgB,QAAQ,WAAU;IAElC;;;OAGG;IACH,OAAO,CAAC,KAAK,CAAC,EAAE,SAAS,CAAC,GAAG,CAAC,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;IAI1F;;;OAGG;IACG,MAAM,CAAC,KAAK,CAAC,EAAE,SAAS,CAAC,GAAG,CAAC,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,GAAG,GAAG,IAAI,CAAC;IAK3F;;;;OAIG;IACH,OAAO,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,YAAY,CAAC,GAAG,CAAC,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,GAAG,CAAC;IAI9F;;;;;OAKG;IACH,MAAM,CAAC,IAAI,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,GAAG,CAAC;IAI9E;;;;OAIG;IACH,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,GAAG,CAAC;IAI9F;;;;;;OAMG;IACH,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,IAAI,GAAG,KAAK,CAAC;IAI/E;;;;OAIG;IACH,SAAS,CACP,EAAE,EAAE,MAAM,EACV,KAAK,CAAC,EAAE,cAAc,EACtB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;IAOjC;;;;;OAKG;IACG,YAAY,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,WAAW,CAAC;IAatF;;;;;;;;OAQG;IACH,aAAa,CACX,KAAK,EAAE,MAAM,EACb,SAAS,EAAE,MAAM,EACjB,IAAI,CAAC,EAAE,MAAM,EACb,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,IAAI,CAAC;IAQhB;;;;;;OAMG;IACH,eAAe,CACb,EAAE,EAAE,MAAM,EACV,gBAAgB,EAAE,MAAM,EACxB,IAAI,EAAE,OAAO,EACb,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,IAAI,CAAC;IAQhB;;;;OAIG;IACH,kBAAkB,CAChB,IAAI,EAAE,yBAAyB,EAC/B,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,MAAM,CAAC;CAOnB"}

package/dist/apis/bots/BotsApi.mjs

@@ -5,9 +5,6 @@ import { BaseApi } from "../../core/BaseApi.mjs";
 * Bots. The list route always paginates (`paginate: false` is ignored), so this class does not
 * extend `BaseCrudApi`. The contexts travel as a list (`BotContextInput` / `BotParsedContext`),
 * not as the stored map that `BotVersionsApi` serves.
-*
-* `GET /bots/:id/errors/export` is not exposed: it answers a binary xlsx, and `ApiClient` only
-* handles JSON/text bodies.
 */
 var BotsApi = class extends BaseApi {
 	basePath = "/bots";
@@ -73,9 +70,22 @@ var BotsApi = class extends BaseApi {
 		return this.client.get(`${this.basePath}/${id}/errors${this.toQueryString(query)}`, headers);
 	}
 	/**
+	* Exports the failed steps of the bot runs of the last 30 days as an xlsx workbook (binary).
+	* Needs a client with `requestRaw`. A period without errors answers 400 `No errors found to
+	* export`; an unknown bot answers 404.
+	* @permissions bots.view
+	*/
+	async exportErrors(id, headers) {
+		if (!this.client.requestRaw) throw new Error("exportErrors needs a client with requestRaw (the answer is a binary xlsx)");
+		return (await this.client.requestRaw("GET", `${this.basePath}/${id}/errors/export`, void 0, headers)).arrayBuffer();
+	}
+	/**
 	* Fires the `API_SIGNAL` trigger of the bot for the contact, with an optional `flag` (read by
 	* the `api_signal_flag` condition). Asynchronous: always resolves with no content, and the
-	* worker only runs it when the contact has an open ticket.
+	* worker only runs it when the contact has an open ticket. The worker runs the flow of `botId`
+	* on the engine of the bot of the contact's connection (see `BotSettings.botCreatedVersion`; when
+	* the connection has no bot, the engine of the `botId` bot). `triggerSignal` does not reach the
+	* bot simulator (there the `API_SIGNAL` path is picked by hand, with no `flag`).
 	* @permissions bots.view
 	*/
 	triggerSignal(botId, contactId, flag, headers) {
@@ -93,9 +103,8 @@ var BotsApi = class extends BaseApi {
 	}
 	/**
 	* Generates a prompt for an AI agent of the bot. COSTS one AI agent credit of the account and
-	* calls OpenAI. No permission check: any authenticated user. A missing field answers 400; an
-	* option outside the lists, or the AI agent limit of the account reached
-	* (`Agent limit reached`), answers 500.
+	* calls OpenAI. A missing field answers 400; an option outside the lists, or the AI agent limit
+	* of the account reached (`Agent limit reached`), answers 500.
 	*/
 	suggestAgentPrompt(body, headers) {
 		return this.client.post(`${this.basePath}/suggest-agent-prompt`, body, headers);

package/dist/apis/bots/BotsApi.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"BotsApi.mjs","names":[],"sources":["../../../src/apis/bots/BotsApi.ts"],"sourcesContent":["import { BaseApi } from '../../core/BaseApi'\nimport type {\n  GetByIdQuery,\n  HasCreate,\n  HasDeleteById,\n  HasGetById,\n  HasUpdateById,\n  ListQuery,\n  Paginated,\n} from '../../core/types'\nimport type {\n  Bot,\n  BotErrorsQuery,\n  BotHistory,\n  CreateBotPayload,\n  SuggestAgentPromptPayload,\n  UpdateBotPayload,\n} from './types'\n\n/**\n * Bots. The list route always paginates (`paginate: false` is ignored), so this class does not\n * extend `BaseCrudApi`. The contexts travel as a list (`BotContextInput` / `BotParsedContext`),\n * not as the stored map that `BotVersionsApi` serves.\n *\n * `GET /bots/:id/errors/export` is not exposed: it answers a binary xlsx, and `ApiClient` only\n * handles JSON/text bodies.\n */\nexport class BotsApi\n  extends BaseApi\n  implements\n    HasGetById<Bot>,\n    HasCreate<Bot, CreateBotPayload>,\n    HasUpdateById<Bot, UpdateBotPayload>,\n    HasDeleteById<'OK' | false>\n{\n  public readonly basePath = '/bots'\n\n  /**\n   * Lists the bots of the account. Always paginated, even with `paginate: false`.\n   * @permissions bots.view\n   */\n  getMany(query?: ListQuery<Bot>, headers?: Record<string, string>): Promise<Paginated<Bot>> {\n    return this.client.get<Paginated<Bot>>(`${this.basePath}${this.toQueryString(query)}`, headers)\n  }\n\n  /**\n   * Returns the first bot matching the query, or `null` when none match.\n   * @permissions bots.view\n   */\n  async getOne(query?: ListQuery<Bot>, headers?: Record<string, string>): Promise<Bot | null> {\n    const page = await this.getMany({ ...query, perPage: 1, page: 1 }, headers)\n    return page?.data?.[0] ?? null\n  }\n\n  /**\n   * Returns a bot by ID, with `defaultContexts` (the stored map, as a JSON string). An unknown id\n   * answers 500, not an empty body.\n   * @permissions bots.view\n   */\n  getById(id: string, query?: GetByIdQuery<Bot>, headers?: Record<string, string>): Promise<Bot> {\n    return this.client.get<Bot>(`${this.basePath}/${id}${this.toQueryString(query)}`, headers)\n  }\n\n  /**\n   * Creates a bot and its first version (published, or a draft with `isDraft`). A duplicate name\n   * answers 409, unless the account allows duplicate names. Send `flowJson` with `edges`, or the\n   * bot never sends a message (SD-2323).\n   * @permissions bots.create\n   */\n  create(body: CreateBotPayload, headers?: Record<string, string>): Promise<Bot> {\n    return this.client.post<Bot, CreateBotPayload>(this.basePath, body, headers)\n  }\n\n  /**\n   * Saves the flow (publishing a version, or into the draft with `isDraft`), or only renames the\n   * bot with `onlyUpdateBotName`. Resolves to the bot with `defaultContexts` as an object.\n   * @permissions bots.view OR bots.update\n   */\n  updateById(id: string, body: UpdateBotPayload, headers?: Record<string, string>): Promise<Bot> {\n    return this.client.put<Bot, UpdateBotPayload>(`${this.basePath}/${id}`, body, headers)\n  }\n\n  /**\n   * Deletes a bot and its versions (hard delete). Today resolves to `false` even when the bot was\n   * deleted (the backend destroy returns nothing); it becomes `'OK'` once the destroy returns the\n   * bot, as in the other routes. Do not read the result as success or failure. An unknown id\n   * answers 500.\n   * @permissions bots.view OR bots.destroy\n   */\n  deleteById(id: string, headers?: Record<string, string>): Promise<'OK' | false> {\n    return this.client.delete<'OK' | false>(`${this.basePath}/${id}`, headers)\n  }\n\n  /**\n   * Lists the failed steps of the bot runs, newest first by default. An unknown bot answers an\n   * empty page.\n   * @permissions bots.view\n   */\n  getErrors(\n    id: string,\n    query?: BotErrorsQuery,\n    headers?: Record<string, string>,\n  ): Promise<Paginated<BotHistory>> {\n    return this.client.get<Paginated<BotHistory>>(\n      `${this.basePath}/${id}/errors${this.toQueryString(query)}`,\n      headers,\n    )\n  }\n\n  /**\n   * Fires the `API_SIGNAL` trigger of the bot for the contact, with an optional `flag` (read by\n   * the `api_signal_flag` condition). Asynchronous: always resolves with no content, and the\n   * worker only runs it when the contact has an open ticket.\n   * @permissions bots.view\n   */\n  triggerSignal(\n    botId: string,\n    contactId: string,\n    flag?: string,\n    headers?: Record<string, string>,\n  ): Promise<void> {\n    return this.client.post<void, { flag: string } | undefined>(\n      `${this.basePath}/${botId}/trigger-signal/${contactId}`,\n      flag === undefined ? undefined : { flag },\n      headers,\n    )\n  }\n\n  /**\n   * Answers a pending asynchronous `HTTP_REQUEST` action: `body` becomes the response the bot\n   * reads. Resolves with no content. An unknown history answers 404; a history that is not\n   * `PENDING`, or of another bot, answers 400. JSON bodies only (the route also takes text, XML\n   * and CSV), up to 250 KB.\n   * @permissions bots.view\n   */\n  requestCallback(\n    id: string,\n    pendingRequestId: string,\n    body: unknown,\n    headers?: Record<string, string>,\n  ): Promise<void> {\n    return this.client.post<void, unknown>(\n      `${this.basePath}/${id}/request-callback/${pendingRequestId}`,\n      body,\n      headers,\n    )\n  }\n\n  /**\n   * Generates a prompt for an AI agent of the bot. COSTS one AI agent credit of the account and\n   * calls OpenAI. No permission check: any authenticated user. A missing field answers 400; an\n   * option outside the lists, or the AI agent limit of the account reached\n   * (`Agent limit reached`), answers 500.\n   */\n  suggestAgentPrompt(\n    body: SuggestAgentPromptPayload,\n    headers?: Record<string, string>,\n  ): Promise<string> {\n    return this.client.post<string, SuggestAgentPromptPayload>(\n      `${this.basePath}/suggest-agent-prompt`,\n      body,\n      headers,\n    )\n  }\n}\n"],"mappings":";;;;;;;;;;;AA2BA,IAAa,UAAb,cACU,QAMV;CACE,AAAgB,WAAW;;;;;CAM3B,QAAQ,OAAwB,SAA2D;AACzF,SAAO,KAAK,OAAO,IAAoB,GAAG,KAAK,WAAW,KAAK,cAAc,MAAM,IAAI,QAAQ;;;;;;CAOjG,MAAM,OAAO,OAAwB,SAAuD;AAE1F,UADa,MAAM,KAAK,QAAQ;GAAE,GAAG;GAAO,SAAS;GAAG,MAAM;GAAG,EAAE,QAAQ,GAC9D,OAAO,MAAM;;;;;;;CAQ5B,QAAQ,IAAY,OAA2B,SAAgD;AAC7F,SAAO,KAAK,OAAO,IAAS,GAAG,KAAK,SAAS,GAAG,KAAK,KAAK,cAAc,MAAM,IAAI,QAAQ;;;;;;;;CAS5F,OAAO,MAAwB,SAAgD;AAC7E,SAAO,KAAK,OAAO,KAA4B,KAAK,UAAU,MAAM,QAAQ;;;;;;;CAQ9E,WAAW,IAAY,MAAwB,SAAgD;AAC7F,SAAO,KAAK,OAAO,IAA2B,GAAG,KAAK,SAAS,GAAG,MAAM,MAAM,QAAQ;;;;;;;;;CAUxF,WAAW,IAAY,SAAyD;AAC9E,SAAO,KAAK,OAAO,OAAqB,GAAG,KAAK,SAAS,GAAG,MAAM,QAAQ;;;;;;;CAQ5E,UACE,IACA,OACA,SACgC;AAChC,SAAO,KAAK,OAAO,IACjB,GAAG,KAAK,SAAS,GAAG,GAAG,SAAS,KAAK,cAAc,MAAM,IACzD,QACD;;;;;;;;CASH,cACE,OACA,WACA,MACA,SACe;AACf,SAAO,KAAK,OAAO,KACjB,GAAG,KAAK,SAAS,GAAG,MAAM,kBAAkB,aAC5C,SAAS,SAAY,SAAY,EAAE,MAAM,EACzC,QACD;;;;;;;;;CAUH,gBACE,IACA,kBACA,MACA,SACe;AACf,SAAO,KAAK,OAAO,KACjB,GAAG,KAAK,SAAS,GAAG,GAAG,oBAAoB,oBAC3C,MACA,QACD;;;;;;;;CASH,mBACE,MACA,SACiB;AACjB,SAAO,KAAK,OAAO,KACjB,GAAG,KAAK,SAAS,wBACjB,MACA,QACD"}
+{"version":3,"file":"BotsApi.mjs","names":[],"sources":["../../../src/apis/bots/BotsApi.ts"],"sourcesContent":["import { BaseApi } from '../../core/BaseApi'\nimport type {\n  GetByIdQuery,\n  HasCreate,\n  HasDeleteById,\n  HasGetById,\n  HasUpdateById,\n  ListQuery,\n  Paginated,\n} from '../../core/types'\nimport type {\n  Bot,\n  BotErrorsQuery,\n  BotHistory,\n  CreateBotPayload,\n  SuggestAgentPromptPayload,\n  UpdateBotPayload,\n} from './types'\n\n/**\n * Bots. The list route always paginates (`paginate: false` is ignored), so this class does not\n * extend `BaseCrudApi`. The contexts travel as a list (`BotContextInput` / `BotParsedContext`),\n * not as the stored map that `BotVersionsApi` serves.\n */\nexport class BotsApi\n  extends BaseApi\n  implements\n    HasGetById<Bot>,\n    HasCreate<Bot, CreateBotPayload>,\n    HasUpdateById<Bot, UpdateBotPayload>,\n    HasDeleteById<'OK' | false>\n{\n  public readonly basePath = '/bots'\n\n  /**\n   * Lists the bots of the account. Always paginated, even with `paginate: false`.\n   * @permissions bots.view\n   */\n  getMany(query?: ListQuery<Bot>, headers?: Record<string, string>): Promise<Paginated<Bot>> {\n    return this.client.get<Paginated<Bot>>(`${this.basePath}${this.toQueryString(query)}`, headers)\n  }\n\n  /**\n   * Returns the first bot matching the query, or `null` when none match.\n   * @permissions bots.view\n   */\n  async getOne(query?: ListQuery<Bot>, headers?: Record<string, string>): Promise<Bot | null> {\n    const page = await this.getMany({ ...query, perPage: 1, page: 1 }, headers)\n    return page?.data?.[0] ?? null\n  }\n\n  /**\n   * Returns a bot by ID, with `defaultContexts` (the stored map, as a JSON string). An unknown id\n   * answers 500, not an empty body.\n   * @permissions bots.view\n   */\n  getById(id: string, query?: GetByIdQuery<Bot>, headers?: Record<string, string>): Promise<Bot> {\n    return this.client.get<Bot>(`${this.basePath}/${id}${this.toQueryString(query)}`, headers)\n  }\n\n  /**\n   * Creates a bot and its first version (published, or a draft with `isDraft`). A duplicate name\n   * answers 409, unless the account allows duplicate names. Send `flowJson` with `edges`, or the\n   * bot never sends a message (SD-2323).\n   * @permissions bots.create\n   */\n  create(body: CreateBotPayload, headers?: Record<string, string>): Promise<Bot> {\n    return this.client.post<Bot, CreateBotPayload>(this.basePath, body, headers)\n  }\n\n  /**\n   * Saves the flow (publishing a version, or into the draft with `isDraft`), or only renames the\n   * bot with `onlyUpdateBotName`. Resolves to the bot with `defaultContexts` as an object.\n   * @permissions bots.view OR bots.update\n   */\n  updateById(id: string, body: UpdateBotPayload, headers?: Record<string, string>): Promise<Bot> {\n    return this.client.put<Bot, UpdateBotPayload>(`${this.basePath}/${id}`, body, headers)\n  }\n\n  /**\n   * Deletes a bot and its versions (hard delete). Today resolves to `false` even when the bot was\n   * deleted (the backend destroy returns nothing); it becomes `'OK'` once the destroy returns the\n   * bot, as in the other routes. Do not read the result as success or failure. An unknown id\n   * answers 500.\n   * @permissions bots.view OR bots.destroy\n   */\n  deleteById(id: string, headers?: Record<string, string>): Promise<'OK' | false> {\n    return this.client.delete<'OK' | false>(`${this.basePath}/${id}`, headers)\n  }\n\n  /**\n   * Lists the failed steps of the bot runs, newest first by default. An unknown bot answers an\n   * empty page.\n   * @permissions bots.view\n   */\n  getErrors(\n    id: string,\n    query?: BotErrorsQuery,\n    headers?: Record<string, string>,\n  ): Promise<Paginated<BotHistory>> {\n    return this.client.get<Paginated<BotHistory>>(\n      `${this.basePath}/${id}/errors${this.toQueryString(query)}`,\n      headers,\n    )\n  }\n\n  /**\n   * Exports the failed steps of the bot runs of the last 30 days as an xlsx workbook (binary).\n   * Needs a client with `requestRaw`. A period without errors answers 400 `No errors found to\n   * export`; an unknown bot answers 404.\n   * @permissions bots.view\n   */\n  async exportErrors(id: string, headers?: Record<string, string>): Promise<ArrayBuffer> {\n    if (!this.client.requestRaw) {\n      throw new Error('exportErrors needs a client with requestRaw (the answer is a binary xlsx)')\n    }\n    const response = await this.client.requestRaw(\n      'GET',\n      `${this.basePath}/${id}/errors/export`,\n      undefined,\n      headers,\n    )\n    return response.arrayBuffer()\n  }\n\n  /**\n   * Fires the `API_SIGNAL` trigger of the bot for the contact, with an optional `flag` (read by\n   * the `api_signal_flag` condition). Asynchronous: always resolves with no content, and the\n   * worker only runs it when the contact has an open ticket. The worker runs the flow of `botId`\n   * on the engine of the bot of the contact's connection (see `BotSettings.botCreatedVersion`; when\n   * the connection has no bot, the engine of the `botId` bot). `triggerSignal` does not reach the\n   * bot simulator (there the `API_SIGNAL` path is picked by hand, with no `flag`).\n   * @permissions bots.view\n   */\n  triggerSignal(\n    botId: string,\n    contactId: string,\n    flag?: string,\n    headers?: Record<string, string>,\n  ): Promise<void> {\n    return this.client.post<void, { flag: string } | undefined>(\n      `${this.basePath}/${botId}/trigger-signal/${contactId}`,\n      flag === undefined ? undefined : { flag },\n      headers,\n    )\n  }\n\n  /**\n   * Answers a pending asynchronous `HTTP_REQUEST` action: `body` becomes the response the bot\n   * reads. Resolves with no content. An unknown history answers 404; a history that is not\n   * `PENDING`, or of another bot, answers 400. JSON bodies only (the route also takes text, XML\n   * and CSV), up to 250 KB.\n   * @permissions bots.view\n   */\n  requestCallback(\n    id: string,\n    pendingRequestId: string,\n    body: unknown,\n    headers?: Record<string, string>,\n  ): Promise<void> {\n    return this.client.post<void, unknown>(\n      `${this.basePath}/${id}/request-callback/${pendingRequestId}`,\n      body,\n      headers,\n    )\n  }\n\n  /**\n   * Generates a prompt for an AI agent of the bot. COSTS one AI agent credit of the account and\n   * calls OpenAI. A missing field answers 400; an option outside the lists, or the AI agent limit\n   * of the account reached (`Agent limit reached`), answers 500.\n   */\n  suggestAgentPrompt(\n    body: SuggestAgentPromptPayload,\n    headers?: Record<string, string>,\n  ): Promise<string> {\n    return this.client.post<string, SuggestAgentPromptPayload>(\n      `${this.basePath}/suggest-agent-prompt`,\n      body,\n      headers,\n    )\n  }\n}\n"],"mappings":";;;;;;;;AAwBA,IAAa,UAAb,cACU,QAMV;CACE,AAAgB,WAAW;;;;;CAM3B,QAAQ,OAAwB,SAA2D;AACzF,SAAO,KAAK,OAAO,IAAoB,GAAG,KAAK,WAAW,KAAK,cAAc,MAAM,IAAI,QAAQ;;;;;;CAOjG,MAAM,OAAO,OAAwB,SAAuD;AAE1F,UADa,MAAM,KAAK,QAAQ;GAAE,GAAG;GAAO,SAAS;GAAG,MAAM;GAAG,EAAE,QAAQ,GAC9D,OAAO,MAAM;;;;;;;CAQ5B,QAAQ,IAAY,OAA2B,SAAgD;AAC7F,SAAO,KAAK,OAAO,IAAS,GAAG,KAAK,SAAS,GAAG,KAAK,KAAK,cAAc,MAAM,IAAI,QAAQ;;;;;;;;CAS5F,OAAO,MAAwB,SAAgD;AAC7E,SAAO,KAAK,OAAO,KAA4B,KAAK,UAAU,MAAM,QAAQ;;;;;;;CAQ9E,WAAW,IAAY,MAAwB,SAAgD;AAC7F,SAAO,KAAK,OAAO,IAA2B,GAAG,KAAK,SAAS,GAAG,MAAM,MAAM,QAAQ;;;;;;;;;CAUxF,WAAW,IAAY,SAAyD;AAC9E,SAAO,KAAK,OAAO,OAAqB,GAAG,KAAK,SAAS,GAAG,MAAM,QAAQ;;;;;;;CAQ5E,UACE,IACA,OACA,SACgC;AAChC,SAAO,KAAK,OAAO,IACjB,GAAG,KAAK,SAAS,GAAG,GAAG,SAAS,KAAK,cAAc,MAAM,IACzD,QACD;;;;;;;;CASH,MAAM,aAAa,IAAY,SAAwD;AACrF,MAAI,CAAC,KAAK,OAAO,WACf,OAAM,IAAI,MAAM,4EAA4E;AAQ9F,UANiB,MAAM,KAAK,OAAO,WACjC,OACA,GAAG,KAAK,SAAS,GAAG,GAAG,iBACvB,QACA,QACD,EACe,aAAa;;;;;;;;;;;CAY/B,cACE,OACA,WACA,MACA,SACe;AACf,SAAO,KAAK,OAAO,KACjB,GAAG,KAAK,SAAS,GAAG,MAAM,kBAAkB,aAC5C,SAAS,SAAY,SAAY,EAAE,MAAM,EACzC,QACD;;;;;;;;;CAUH,gBACE,IACA,kBACA,MACA,SACe;AACf,SAAO,KAAK,OAAO,KACjB,GAAG,KAAK,SAAS,GAAG,GAAG,oBAAoB,oBAC3C,MACA,QACD;;;;;;;CAQH,mBACE,MACA,SACiB;AACjB,SAAO,KAAK,OAAO,KACjB,GAAG,KAAK,SAAS,wBACjB,MACA,QACD"}

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

@@ -9,7 +9,11 @@ export type BotLimitations = {
 export type BotSettings = {
     /** If true, only the first matching rule per trigger fires; otherwise all matching rules fire. */
     sequentialRuleExecution?: boolean;
-    /** Version of the bot builder used to create this bot. v3 uses the visual flow builder. */
+    /**
+     * Version of the bot builder used to create this bot, which also picks the engine that runs it:
+     * `v3` (the visual flow builder) runs on the flow engine; `v1`, `v2` or absent, on the legacy
+     * engine. The bot simulator always runs the flow engine.
+     */
     botCreatedVersion?: BotCreatedVersion;
     limitations?: BotLimitations;
 };
@@ -162,6 +166,11 @@ export type BotActionDataMap = {
             waitSeconds?: number;
         };
     };
+    /**
+     * Runs on the flow engine (`botCreatedVersion: 'v3'`). `endpointUrl`, `httpMethod`, `retries`,
+     * `timeout` and `bodyType` are required to run it: without one of them the step does not run.
+     * The bot simulator does not run it.
+     */
     HTTP_REQUEST: {
         requestName?: string;
         endpointUrl?: string;
@@ -182,8 +191,9 @@ export type BotActionDataMap = {
         }[];
         requestBodyJson?: string;
         requestBodyXml?: string;
+        /** Number of attempts (at least 1), not of retries after the first one. */
         retries?: number;
-        /** Timeout in milliseconds. */
+        /** Timeout of each attempt, in SECONDS. */
         timeout?: number;
         /** Response properties to extract into bot session variables. */
         variables?: {