@ikatec/digisac-api-sdk 4.11.0 → 4.13.0

package/dist/apis/creditMovements/CreditMovementsApi.mjs

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

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

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

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

@@ -4,6 +4,7 @@ import type { User } from '../users/types';
 export type CreditMovementType = 'in' | 'out';
 export type CreditMovementServiceType = 'sms-wavy' | 'transcription' | 'summary' | 'magic-text' | 'copilot' | 'csat' | 'agent';
 export type CreditMovementOrigin = 'trial' | 'single' | 'bulk' | 'chargeback' | 'renewal' | 'reset' | 'agnus' | 'marketplace' | 'copilot' | 'additional' | 'agent';
+/** A movement as the transformer answers it (no `userId`; the relations are never served). */
 export type CreditMovement = {
     id: string;
     type: CreditMovementType;
@@ -11,16 +12,86 @@ export type CreditMovement = {
     serviceType: CreditMovementServiceType;
     origin: CreditMovementOrigin | null;
     accountId: string;
-    serviceId: string;
-    userId: string | null;
+    /** `null` on the movements of the account (e.g. the trial SMS credits of a new account). */
+    serviceId: string | null;
+    /** @deprecated Not answered: the transformer of the backend does not send it. */
+    userId?: string | null;
     campaignId: string | null;
     createdAt: string;
     updatedAt: string;
+    /** @deprecated Not served: the include is dropped by the backend. */
     service?: Service;
+    /** @deprecated Not served: the include is dropped by the backend. */
     user?: User | null;
+    /** @deprecated Not served: the include is dropped by the backend. */
     campaign?: Campaign | null;
 };
+/** None is served: the backend drops every include of this route. */
 export type CreditMovementRelationships = 'service' | 'user' | 'campaign';
+/** The balance of each service type (`balances`): the movements in minus the movements out. */
+export type CreditBalances = Record<CreditMovementServiceType, number>;
+/** The totals of a service type in `balancesV2`. */
+export type CreditBalanceTotals = {
+    ins: number;
+    outs: number;
+    balance: number;
+    used: number;
+    contractedCredits?: number;
+    additionalCredits?: number;
+    realConsumption?: number;
+};
+/**
+ * A service type in `balancesV2`: `all` with the totals, `history` with the rows of the period, and one
+ * key per connection name with its totals. The `ins` count the credits of the plan (`plan.ai`) and the
+ * additional ones: the trial SMS credits are not counted (they show in `balances`).
+ */
+export type CreditBalanceV2 = {
+    all: CreditBalanceTotals;
+    history?: Record<string, unknown>[];
+    [serviceName: string]: unknown;
+};
+export type CreditBalancesV2Query = {
+    from?: string;
+    to?: string;
+    serviceId?: string;
+};
+/**
+ * Query of `totalServices`: without `filters.from`, `filters.to`, `filters.serviceType` and `page` the route
+ * answers 200 with no body.
+ */
+export type CreditTotalServicesQuery = {
+    filters: {
+        from: string;
+        to: string;
+        serviceType: CreditMovementServiceType;
+        servicesIds?: string[];
+    };
+    /** From 1 (`0` answers 500 `Invalid param`). Five connections per page. */
+    page: number;
+};
+/** The total of credits of each connection in the period, five per page (the counts come as text). */
+export type CreditTotalServices = {
+    data: {
+        id: string;
+        name: string;
+        total: string;
+    }[];
+    total: string;
+    limit: number;
+    skip: number;
+    currentPage: string | number;
+    lastPage: number;
+    from: number;
+    to: number;
+};
+/** Query of `exportXlsx`: the period and the conditions in `where.$and` (required by the backend). */
+export type CreditMovementsExportQuery = {
+    from: string;
+    to: string;
+    where: {
+        $and: Record<string, unknown>[];
+    };
+};
 export type CreateCreditMovementPayload = {
     type: CreditMovementType;
     serviceType: CreditMovementServiceType;

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

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/apis/creditMovements/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAA;AAClD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAChD,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,gBAAgB,CAAA;AAE1C,MAAM,MAAM,kBAAkB,GAAG,IAAI,GAAG,KAAK,CAAA;AAE7C,MAAM,MAAM,yBAAyB,GACjC,UAAU,GACV,eAAe,GACf,SAAS,GACT,YAAY,GACZ,SAAS,GACT,MAAM,GACN,OAAO,CAAA;AAEX,MAAM,MAAM,oBAAoB,GAC5B,OAAO,GACP,QAAQ,GACR,MAAM,GACN,YAAY,GACZ,SAAS,GACT,OAAO,GACP,OAAO,GACP,aAAa,GACb,SAAS,GACT,YAAY,GACZ,OAAO,CAAA;AAEX,MAAM,MAAM,cAAc,GAAG;IAC3B,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,kBAAkB,CAAA;IACxB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAA;IACrB,WAAW,EAAE,yBAAyB,CAAA;IACtC,MAAM,EAAE,oBAAoB,GAAG,IAAI,CAAA;IACnC,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAA;IACrB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IAEjB,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,IAAI,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;IAClB,QAAQ,CAAC,EAAE,QAAQ,GAAG,IAAI,CAAA;CAC3B,CAAA;AAED,MAAM,MAAM,2BAA2B,GAAG,SAAS,GAAG,MAAM,GAAG,UAAU,CAAA;AAEzE,MAAM,MAAM,2BAA2B,GAAG;IACxC,IAAI,EAAE,kBAAkB,CAAA;IACxB,WAAW,EAAE,yBAAyB,CAAA;IACtC,SAAS,EAAE,MAAM,CAAA;IACjB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,MAAM,CAAC,EAAE,oBAAoB,CAAA;IAC7B,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB,CAAA;AAED,MAAM,MAAM,2BAA2B,GAAG;IACxC,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB,CAAA"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/apis/creditMovements/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAA;AAClD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAChD,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,gBAAgB,CAAA;AAE1C,MAAM,MAAM,kBAAkB,GAAG,IAAI,GAAG,KAAK,CAAA;AAE7C,MAAM,MAAM,yBAAyB,GACjC,UAAU,GACV,eAAe,GACf,SAAS,GACT,YAAY,GACZ,SAAS,GACT,MAAM,GACN,OAAO,CAAA;AAEX,MAAM,MAAM,oBAAoB,GAC5B,OAAO,GACP,QAAQ,GACR,MAAM,GACN,YAAY,GACZ,SAAS,GACT,OAAO,GACP,OAAO,GACP,aAAa,GACb,SAAS,GACT,YAAY,GACZ,OAAO,CAAA;AAEX,8FAA8F;AAC9F,MAAM,MAAM,cAAc,GAAG;IAC3B,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,kBAAkB,CAAA;IACxB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAA;IACrB,WAAW,EAAE,yBAAyB,CAAA;IACtC,MAAM,EAAE,oBAAoB,GAAG,IAAI,CAAA;IACnC,SAAS,EAAE,MAAM,CAAA;IACjB,4FAA4F;IAC5F,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB,iFAAiF;IACjF,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACtB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IAEjB,qEAAqE;IACrE,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,qEAAqE;IACrE,IAAI,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;IAClB,qEAAqE;IACrE,QAAQ,CAAC,EAAE,QAAQ,GAAG,IAAI,CAAA;CAC3B,CAAA;AAED,qEAAqE;AACrE,MAAM,MAAM,2BAA2B,GAAG,SAAS,GAAG,MAAM,GAAG,UAAU,CAAA;AAEzE,+FAA+F;AAC/F,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC,yBAAyB,EAAE,MAAM,CAAC,CAAA;AAEtE,oDAAoD;AACpD,MAAM,MAAM,mBAAmB,GAAG;IAChC,GAAG,EAAE,MAAM,CAAA;IACX,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,EAAE,MAAM,CAAA;IACf,IAAI,EAAE,MAAM,CAAA;IACZ,iBAAiB,CAAC,EAAE,MAAM,CAAA;IAC1B,iBAAiB,CAAC,EAAE,MAAM,CAAA;IAC1B,eAAe,CAAC,EAAE,MAAM,CAAA;CACzB,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,GAAG,EAAE,mBAAmB,CAAA;IACxB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,CAAA;IACnC,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAA;CAC/B,CAAA;AAED,MAAM,MAAM,qBAAqB,GAAG;IAClC,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,EAAE,CAAC,EAAE,MAAM,CAAA;IACX,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC,OAAO,EAAE;QACP,IAAI,EAAE,MAAM,CAAA;QACZ,EAAE,EAAE,MAAM,CAAA;QACV,WAAW,EAAE,yBAAyB,CAAA;QACtC,WAAW,CAAC,EAAE,MAAM,EAAE,CAAA;KACvB,CAAA;IACD,2EAA2E;IAC3E,IAAI,EAAE,MAAM,CAAA;CACb,CAAA;AAED,sGAAsG;AACtG,MAAM,MAAM,mBAAmB,GAAG;IAChC,IAAI,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,EAAE,CAAA;IACnD,KAAK,EAAE,MAAM,CAAA;IACb,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,EAAE,MAAM,GAAG,MAAM,CAAA;IAC5B,QAAQ,EAAE,MAAM,CAAA;IAChB,IAAI,EAAE,MAAM,CAAA;IACZ,EAAE,EAAE,MAAM,CAAA;CACX,CAAA;AAED,sGAAsG;AACtG,MAAM,MAAM,0BAA0B,GAAG;IACvC,IAAI,EAAE,MAAM,CAAA;IACZ,EAAE,EAAE,MAAM,CAAA;IACV,KAAK,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,CAAA;KAAE,CAAA;CAC3C,CAAA;AAED,MAAM,MAAM,2BAA2B,GAAG;IACxC,IAAI,EAAE,kBAAkB,CAAA;IACxB,WAAW,EAAE,yBAAyB,CAAA;IACtC,SAAS,EAAE,MAAM,CAAA;IACjB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,MAAM,CAAC,EAAE,oBAAoB,CAAA;IAC7B,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB,CAAA;AAED,MAAM,MAAM,2BAA2B,GAAG;IACxC,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB,CAAA"}

package/dist/apis/interactiveMessages/InteractiveMessagesApi.cjs

@@ -7,6 +7,21 @@ var InteractiveMessagesApi = class extends require_core_BaseCrudApi.BaseCrudApi
 		super(client, "/interactive-messages");
 	}
 	/**
+	* Counts the interactive messages matching the query.
+	* @permissions interactive-messages.view OR interactive-messages.management.all.departments
+	*/
+	count(query, headers) {
+		return this.client.get(`${this.basePath}/count${this.toQueryString(query)}`, headers);
+	}
+	/**
+	* Creates an interactive message. Only `cta_url` is validated by the backend (the other types are stored as
+	* sent). The answer has no `departments` nor `file`: read them with `getById` and `include`.
+	* @permissions interactive-messages.create OR interactive-messages.management.all.departments
+	*/
+	create(body, headers) {
+		return super.create(body, headers);
+	}
+	/**
 	* Deletes an interactive message. Resolves the text `'OK'`; an unknown id answers 500.
 	* @permissions interactive-messages.destroy OR interactive-messages.management.all.departments
 	*/

package/dist/apis/interactiveMessages/InteractiveMessagesApi.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"InteractiveMessagesApi.cjs","names":["BaseCrudApi"],"sources":["../../../src/apis/interactiveMessages/InteractiveMessagesApi.ts"],"sourcesContent":["import type { ApiClient } from '../../core/ApiClient'\nimport type { ListQuery } from '../../core/types'\nimport { BaseCrudApi } from '../../core/BaseCrudApi'\nimport type {\n  InteractiveMessage,\n  CreateInteractiveMessagePayload,\n  UpdateInteractiveMessagePayload,\n} from './types'\n\nexport class InteractiveMessagesApi extends BaseCrudApi<\n  InteractiveMessage,\n  CreateInteractiveMessagePayload,\n  UpdateInteractiveMessagePayload,\n  ListQuery<InteractiveMessage>,\n  'OK'\n> {\n  constructor(client: ApiClient) {\n    super(client, '/interactive-messages')\n  }\n\n  /**\n   * Deletes an interactive message. Resolves the text `'OK'`; an unknown id answers 500.\n   * @permissions interactive-messages.destroy OR interactive-messages.management.all.departments\n   */\n  override deleteById(id: string, headers?: Record<string, string>): Promise<'OK'> {\n    return super.deleteById(id, headers)\n  }\n}\n"],"mappings":";;;;AASA,IAAa,yBAAb,cAA4CA,qCAM1C;CACA,YAAY,QAAmB;AAC7B,QAAM,QAAQ,wBAAwB;;;;;;CAOxC,AAAS,WAAW,IAAY,SAAiD;AAC/E,SAAO,MAAM,WAAW,IAAI,QAAQ"}
+{"version":3,"file":"InteractiveMessagesApi.cjs","names":["BaseCrudApi"],"sources":["../../../src/apis/interactiveMessages/InteractiveMessagesApi.ts"],"sourcesContent":["import type { ApiClient } from '../../core/ApiClient'\nimport type { ListQuery } from '../../core/types'\nimport { BaseCrudApi } from '../../core/BaseCrudApi'\nimport type {\n  InteractiveMessage,\n  CreateInteractiveMessagePayload,\n  UpdateInteractiveMessagePayload,\n} from './types'\n\nexport class InteractiveMessagesApi extends BaseCrudApi<\n  InteractiveMessage,\n  CreateInteractiveMessagePayload,\n  UpdateInteractiveMessagePayload,\n  ListQuery<InteractiveMessage>,\n  'OK'\n> {\n  constructor(client: ApiClient) {\n    super(client, '/interactive-messages')\n  }\n\n  /**\n   * Counts the interactive messages matching the query.\n   * @permissions interactive-messages.view OR interactive-messages.management.all.departments\n   */\n  count(\n    query?: ListQuery<InteractiveMessage>,\n    headers?: Record<string, string>,\n  ): Promise<{ count: number }> {\n    return this.client.get<{ count: number }>(\n      `${this.basePath}/count${this.toQueryString(query)}`,\n      headers,\n    )\n  }\n\n  /**\n   * Creates an interactive message. Only `cta_url` is validated by the backend (the other types are stored as\n   * sent). The answer has no `departments` nor `file`: read them with `getById` and `include`.\n   * @permissions interactive-messages.create OR interactive-messages.management.all.departments\n   */\n  override create(\n    body: CreateInteractiveMessagePayload,\n    headers?: Record<string, string>,\n  ): Promise<InteractiveMessage> {\n    return super.create(body, headers)\n  }\n\n  /**\n   * Deletes an interactive message. Resolves the text `'OK'`; an unknown id answers 500.\n   * @permissions interactive-messages.destroy OR interactive-messages.management.all.departments\n   */\n  override deleteById(id: string, headers?: Record<string, string>): Promise<'OK'> {\n    return super.deleteById(id, headers)\n  }\n}\n"],"mappings":";;;;AASA,IAAa,yBAAb,cAA4CA,qCAM1C;CACA,YAAY,QAAmB;AAC7B,QAAM,QAAQ,wBAAwB;;;;;;CAOxC,MACE,OACA,SAC4B;AAC5B,SAAO,KAAK,OAAO,IACjB,GAAG,KAAK,SAAS,QAAQ,KAAK,cAAc,MAAM,IAClD,QACD;;;;;;;CAQH,AAAS,OACP,MACA,SAC6B;AAC7B,SAAO,MAAM,OAAO,MAAM,QAAQ;;;;;;CAOpC,AAAS,WAAW,IAAY,SAAiD;AAC/E,SAAO,MAAM,WAAW,IAAI,QAAQ"}

package/dist/apis/interactiveMessages/InteractiveMessagesApi.d.ts

@@ -4,6 +4,19 @@ import { BaseCrudApi } from '../../core/BaseCrudApi';
 import type { InteractiveMessage, CreateInteractiveMessagePayload, UpdateInteractiveMessagePayload } from './types';
 export declare class InteractiveMessagesApi extends BaseCrudApi<InteractiveMessage, CreateInteractiveMessagePayload, UpdateInteractiveMessagePayload, ListQuery<InteractiveMessage>, 'OK'> {
     constructor(client: ApiClient);
+    /**
+     * Counts the interactive messages matching the query.
+     * @permissions interactive-messages.view OR interactive-messages.management.all.departments
+     */
+    count(query?: ListQuery<InteractiveMessage>, headers?: Record<string, string>): Promise<{
+        count: number;
+    }>;
+    /**
+     * Creates an interactive message. Only `cta_url` is validated by the backend (the other types are stored as
+     * sent). The answer has no `departments` nor `file`: read them with `getById` and `include`.
+     * @permissions interactive-messages.create OR interactive-messages.management.all.departments
+     */
+    create(body: CreateInteractiveMessagePayload, headers?: Record<string, string>): Promise<InteractiveMessage>;
     /**
      * Deletes an interactive message. Resolves the text `'OK'`; an unknown id answers 500.
      * @permissions interactive-messages.destroy OR interactive-messages.management.all.departments

package/dist/apis/interactiveMessages/InteractiveMessagesApi.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"InteractiveMessagesApi.d.ts","sourceRoot":"","sources":["../../../src/apis/interactiveMessages/InteractiveMessagesApi.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAA;AACrD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAA;AACjD,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAA;AACpD,OAAO,KAAK,EACV,kBAAkB,EAClB,+BAA+B,EAC/B,+BAA+B,EAChC,MAAM,SAAS,CAAA;AAEhB,qBAAa,sBAAuB,SAAQ,WAAW,CACrD,kBAAkB,EAClB,+BAA+B,EAC/B,+BAA+B,EAC/B,SAAS,CAAC,kBAAkB,CAAC,EAC7B,IAAI,CACL;gBACa,MAAM,EAAE,SAAS;IAI7B;;;OAGG;IACM,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;CAGjF"}
+{"version":3,"file":"InteractiveMessagesApi.d.ts","sourceRoot":"","sources":["../../../src/apis/interactiveMessages/InteractiveMessagesApi.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAA;AACrD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAA;AACjD,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAA;AACpD,OAAO,KAAK,EACV,kBAAkB,EAClB,+BAA+B,EAC/B,+BAA+B,EAChC,MAAM,SAAS,CAAA;AAEhB,qBAAa,sBAAuB,SAAQ,WAAW,CACrD,kBAAkB,EAClB,+BAA+B,EAC/B,+BAA+B,EAC/B,SAAS,CAAC,kBAAkB,CAAC,EAC7B,IAAI,CACL;gBACa,MAAM,EAAE,SAAS;IAI7B;;;OAGG;IACH,KAAK,CACH,KAAK,CAAC,EAAE,SAAS,CAAC,kBAAkB,CAAC,EACrC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC;IAO7B;;;;OAIG;IACM,MAAM,CACb,IAAI,EAAE,+BAA+B,EACrC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,kBAAkB,CAAC;IAI9B;;;OAGG;IACM,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;CAGjF"}

package/dist/apis/interactiveMessages/InteractiveMessagesApi.mjs

@@ -6,6 +6,21 @@ var InteractiveMessagesApi = class extends BaseCrudApi {
 		super(client, "/interactive-messages");
 	}
 	/**
+	* Counts the interactive messages matching the query.
+	* @permissions interactive-messages.view OR interactive-messages.management.all.departments
+	*/
+	count(query, headers) {
+		return this.client.get(`${this.basePath}/count${this.toQueryString(query)}`, headers);
+	}
+	/**
+	* Creates an interactive message. Only `cta_url` is validated by the backend (the other types are stored as
+	* sent). The answer has no `departments` nor `file`: read them with `getById` and `include`.
+	* @permissions interactive-messages.create OR interactive-messages.management.all.departments
+	*/
+	create(body, headers) {
+		return super.create(body, headers);
+	}
+	/**
 	* Deletes an interactive message. Resolves the text `'OK'`; an unknown id answers 500.
 	* @permissions interactive-messages.destroy OR interactive-messages.management.all.departments
 	*/

package/dist/apis/interactiveMessages/InteractiveMessagesApi.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"InteractiveMessagesApi.mjs","names":[],"sources":["../../../src/apis/interactiveMessages/InteractiveMessagesApi.ts"],"sourcesContent":["import type { ApiClient } from '../../core/ApiClient'\nimport type { ListQuery } from '../../core/types'\nimport { BaseCrudApi } from '../../core/BaseCrudApi'\nimport type {\n  InteractiveMessage,\n  CreateInteractiveMessagePayload,\n  UpdateInteractiveMessagePayload,\n} from './types'\n\nexport class InteractiveMessagesApi extends BaseCrudApi<\n  InteractiveMessage,\n  CreateInteractiveMessagePayload,\n  UpdateInteractiveMessagePayload,\n  ListQuery<InteractiveMessage>,\n  'OK'\n> {\n  constructor(client: ApiClient) {\n    super(client, '/interactive-messages')\n  }\n\n  /**\n   * Deletes an interactive message. Resolves the text `'OK'`; an unknown id answers 500.\n   * @permissions interactive-messages.destroy OR interactive-messages.management.all.departments\n   */\n  override deleteById(id: string, headers?: Record<string, string>): Promise<'OK'> {\n    return super.deleteById(id, headers)\n  }\n}\n"],"mappings":";;;AASA,IAAa,yBAAb,cAA4C,YAM1C;CACA,YAAY,QAAmB;AAC7B,QAAM,QAAQ,wBAAwB;;;;;;CAOxC,AAAS,WAAW,IAAY,SAAiD;AAC/E,SAAO,MAAM,WAAW,IAAI,QAAQ"}
+{"version":3,"file":"InteractiveMessagesApi.mjs","names":[],"sources":["../../../src/apis/interactiveMessages/InteractiveMessagesApi.ts"],"sourcesContent":["import type { ApiClient } from '../../core/ApiClient'\nimport type { ListQuery } from '../../core/types'\nimport { BaseCrudApi } from '../../core/BaseCrudApi'\nimport type {\n  InteractiveMessage,\n  CreateInteractiveMessagePayload,\n  UpdateInteractiveMessagePayload,\n} from './types'\n\nexport class InteractiveMessagesApi extends BaseCrudApi<\n  InteractiveMessage,\n  CreateInteractiveMessagePayload,\n  UpdateInteractiveMessagePayload,\n  ListQuery<InteractiveMessage>,\n  'OK'\n> {\n  constructor(client: ApiClient) {\n    super(client, '/interactive-messages')\n  }\n\n  /**\n   * Counts the interactive messages matching the query.\n   * @permissions interactive-messages.view OR interactive-messages.management.all.departments\n   */\n  count(\n    query?: ListQuery<InteractiveMessage>,\n    headers?: Record<string, string>,\n  ): Promise<{ count: number }> {\n    return this.client.get<{ count: number }>(\n      `${this.basePath}/count${this.toQueryString(query)}`,\n      headers,\n    )\n  }\n\n  /**\n   * Creates an interactive message. Only `cta_url` is validated by the backend (the other types are stored as\n   * sent). The answer has no `departments` nor `file`: read them with `getById` and `include`.\n   * @permissions interactive-messages.create OR interactive-messages.management.all.departments\n   */\n  override create(\n    body: CreateInteractiveMessagePayload,\n    headers?: Record<string, string>,\n  ): Promise<InteractiveMessage> {\n    return super.create(body, headers)\n  }\n\n  /**\n   * Deletes an interactive message. Resolves the text `'OK'`; an unknown id answers 500.\n   * @permissions interactive-messages.destroy OR interactive-messages.management.all.departments\n   */\n  override deleteById(id: string, headers?: Record<string, string>): Promise<'OK'> {\n    return super.deleteById(id, headers)\n  }\n}\n"],"mappings":";;;AASA,IAAa,yBAAb,cAA4C,YAM1C;CACA,YAAY,QAAmB;AAC7B,QAAM,QAAQ,wBAAwB;;;;;;CAOxC,MACE,OACA,SAC4B;AAC5B,SAAO,KAAK,OAAO,IACjB,GAAG,KAAK,SAAS,QAAQ,KAAK,cAAc,MAAM,IAClD,QACD;;;;;;;CAQH,AAAS,OACP,MACA,SAC6B;AAC7B,SAAO,MAAM,OAAO,MAAM,QAAQ;;;;;;CAOpC,AAAS,WAAW,IAAY,SAAiD;AAC/E,SAAO,MAAM,WAAW,IAAI,QAAQ"}

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

@@ -154,7 +154,8 @@ type InteractiveMessageFilePayload = {
 export type InteractiveMessage = {
     id: string;
     name: string;
-    type: 'list' | 'button' | 'cta_url' | 'request_contact_info';
+    /** @deprecated Not a field of the backend (no such column): the type is `interactive.type`. */
+    type?: 'list' | 'button' | 'cta_url' | 'request_contact_info';
     interactive: InteractiveMessageContent;
     archivedAt: string | null;
     accountId: string;
@@ -163,8 +164,9 @@ export type InteractiveMessage = {
     deletedAt: string | null;
     file?: File | null;
     departments?: Department[];
+    account?: Record<string, unknown>;
 };
-export type InteractiveMessageRelationships = 'file' | 'departments';
+export type InteractiveMessageRelationships = 'file' | 'departments' | 'account';
 export type CreateInteractiveMessagePayload = {
     name: string;
     interactive: InteractiveMessageContentInput;
@@ -174,6 +176,10 @@ export type CreateInteractiveMessagePayload = {
     }[];
     file?: InteractiveMessageFilePayload;
 };
+/**
+ * The backend requires `name` and `interactive` on the update too. It replaces the departments: omitting
+ * `departmentIds`/`departments` clears them. Only `file.base64Url` is read (a `file.id` is ignored).
+ */
 export type UpdateInteractiveMessagePayload = {
     name?: string;
     interactive?: InteractiveMessageContentInput;

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

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/apis/interactiveMessages/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AAChD,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,UAAU,CAAA;AAIpC,KAAK,wBAAwB,GAAG;IAC9B,IAAI,EAAE,OAAO,CAAA;IACb,KAAK,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAA;CACrC,CAAA;AAED,KAAK,4BAA4B,GAAG,MAAM,GAAG;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE,CAAA;AAE7D,MAAM,MAAM,sBAAsB,GAAG,UAAU,GAAG,UAAU,GAAG,WAAW,GAAG,SAAS,CAAA;AAEtF,MAAM,MAAM,6BAA6B,GAAG,OAAO,GAAG,SAAS,CAAA;AAE/D;;;;;GAKG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,OAAO,EAAE,OAAO,CAAA;IAChB,OAAO,CAAC,EAAE,sBAAsB,CAAA;IAChC,2FAA2F;IAC3F,cAAc,CAAC,EAAE,6BAA6B,CAAA;IAC9C,yFAAyF;IACzF,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,gEAAgE;IAChE,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB,CAAA;AAED,KAAK,YAAY,GAAG;IAClB,IAAI,EAAE,SAAS,CAAA;IACf,UAAU,EAAE;QACV,6DAA6D;QAC7D,YAAY,EAAE,MAAM,CAAA;QACpB,2EAA2E;QAC3E,GAAG,EAAE,MAAM,CAAA;KACZ,CAAA;CACF,CAAA;AAID,KAAK,gBAAgB,GAAG;IACtB,EAAE,CAAC,EAAE,MAAM,CAAA;IACX,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB,CAAA;AAED,KAAK,qBAAqB,GAAG;IAC3B,EAAE,EAAE,MAAM,CAAA;IACV,KAAK,EAAE,MAAM,CAAA;IACb,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB,CAAA;AAED,KAAK,yBAAyB,GAAG;IAC/B,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,qBAAqB,EAAE,CAAA;CAC9B,CAAA;AAED,KAAK,6BAA6B,GAAG;IACnC,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,CAAC,EAAE;QACP,IAAI,EAAE,MAAM,CAAA;QACZ,IAAI,CAAC,EAAE,MAAM,GAAG;YAAE,IAAI,EAAE,MAAM,CAAA;SAAE,CAAA;KACjC,CAAA;IACD,IAAI,EAAE,4BAA4B,CAAA;IAClC,MAAM,CAAC,EAAE,4BAA4B,CAAA;IACrC,MAAM,EAAE;QACN,yCAAyC;QACzC,MAAM,EAAE,MAAM,CAAA;QACd,QAAQ,EAAE,yBAAyB,EAAE,CAAA;KACtC,CAAA;CACF,CAAA;AAED,KAAK,+BAA+B,GAAG;IACrC,IAAI,EAAE,QAAQ,CAAA;IACd,MAAM,CAAC,EAAE;QACP,IAAI,EAAE,MAAM,GAAG,UAAU,GAAG,OAAO,GAAG,OAAO,CAAA;QAC7C,IAAI,CAAC,EAAE,MAAM,GAAG;YAAE,IAAI,EAAE,MAAM,CAAA;SAAE,CAAA;QAChC,QAAQ,CAAC,EAAE,gBAAgB,CAAA;QAC3B,KAAK,CAAC,EAAE,gBAAgB,CAAA;QACxB,KAAK,CAAC,EAAE,gBAAgB,CAAA;KACzB,CAAA;IACD,IAAI,EAAE,4BAA4B,CAAA;IAClC,MAAM,CAAC,EAAE,4BAA4B,CAAA;IACrC,MAAM,EAAE;QACN,OAAO,EAAE,wBAAwB,EAAE,CAAA;KACpC,CAAA;CACF,CAAA;AAED,MAAM,MAAM,+BAA+B,GAAG;IAC5C,IAAI,EAAE,SAAS,CAAA;IACf,MAAM,CAAC,EAAE,+BAA+B,CAAC,QAAQ,CAAC,CAAA;IAClD,IAAI,EAAE,4BAA4B,CAAA;IAClC,MAAM,CAAC,EAAE,4BAA4B,CAAA;IACrC,MAAM,EAAE,YAAY,CAAA;IACpB,eAAe,CAAC,EAAE,eAAe,CAAA;CAClC,CAAA;AAED,mEAAmE;AACnE,MAAM,MAAM,2CAA2C,GAAG;IACxD,IAAI,EAAE,sBAAsB,CAAA;IAC5B,IAAI,EAAE,4BAA4B,CAAA;IAClC,MAAM,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,CAAA;CAC1B,CAAA;AAED,MAAM,MAAM,yBAAyB,GACjC,6BAA6B,GAC7B,+BAA+B,GAC/B,+BAA+B,GAC/B,2CAA2C,CAAA;AAI/C,KAAK,kCAAkC,GAAG;IACxC,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,CAAC,EAAE;QACP,IAAI,EAAE,MAAM,CAAA;QACZ,IAAI,CAAC,EAAE,MAAM,CAAA;KACd,CAAA;IACD,IAAI,EAAE,4BAA4B,CAAA;IAClC,MAAM,CAAC,EAAE,4BAA4B,CAAA;IACrC,MAAM,EAAE;QACN,MAAM,EAAE,MAAM,CAAA;QACd,QAAQ,EAAE,yBAAyB,EAAE,CAAA;KACtC,CAAA;CACF,CAAA;AAED,KAAK,oCAAoC,GAAG;IAC1C,IAAI,EAAE,QAAQ,CAAA;IACd,MAAM,CAAC,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG;QAAE,IAAI,EAAE,OAAO,GAAG,UAAU,GAAG,OAAO,CAAA;KAAE,CAAA;IACnF,IAAI,EAAE,4BAA4B,CAAA;IAClC,MAAM,CAAC,EAAE,4BAA4B,CAAA;IACrC,MAAM,EAAE;QACN,OAAO,EAAE,wBAAwB,EAAE,CAAA;KACpC,CAAA;CACF,CAAA;AAED,KAAK,oCAAoC,GAAG;IAC1C,IAAI,EAAE,SAAS,CAAA;IACf,MAAM,CAAC,EAAE,oCAAoC,CAAC,QAAQ,CAAC,CAAA;IACvD,IAAI,EAAE,4BAA4B,CAAA;IAClC,MAAM,CAAC,EAAE,4BAA4B,CAAA;IACrC,MAAM,EAAE,YAAY,CAAA;IACpB,eAAe,CAAC,EAAE,eAAe,CAAA;CAClC,CAAA;AAED,KAAK,gDAAgD,GAAG;IACtD,IAAI,EAAE,sBAAsB,CAAA;IAC5B,IAAI,EAAE,4BAA4B,CAAA;IAClC,MAAM,EAAE;QAAE,IAAI,EAAE,sBAAsB,CAAA;KAAE,CAAA;CACzC,CAAA;AAED,KAAK,8BAA8B,GAC/B,kCAAkC,GAClC,oCAAoC,GACpC,oCAAoC,GACpC,gDAAgD,CAAA;AAEpD,KAAK,6BAA6B,GAC9B;IAAE,EAAE,EAAE,MAAM,CAAA;CAAE,GACd;IAAE,QAAQ,EAAE,MAAM,CAAC;IAAC,SAAS,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CAAE,CAAA;AAI7D,MAAM,MAAM,kBAAkB,GAAG;IAC/B,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,GAAG,QAAQ,GAAG,SAAS,GAAG,sBAAsB,CAAA;IAC5D,WAAW,EAAE,yBAAyB,CAAA;IACtC,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IAExB,IAAI,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;IAClB,WAAW,CAAC,EAAE,UAAU,EAAE,CAAA;CAC3B,CAAA;AAED,MAAM,MAAM,+BAA+B,GAAG,MAAM,GAAG,aAAa,CAAA;AAEpE,MAAM,MAAM,+BAA+B,GAAG;IAC5C,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,EAAE,8BAA8B,CAAA;IAC3C,aAAa,CAAC,EAAE,MAAM,EAAE,CAAA;IACxB,WAAW,CAAC,EAAE;QAAE,EAAE,EAAE,MAAM,CAAA;KAAE,EAAE,CAAA;IAC9B,IAAI,CAAC,EAAE,6BAA6B,CAAA;CACrC,CAAA;AAED,MAAM,MAAM,+BAA+B,GAAG;IAC5C,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,WAAW,CAAC,EAAE,8BAA8B,CAAA;IAC5C,aAAa,CAAC,EAAE,MAAM,EAAE,CAAA;IACxB,WAAW,CAAC,EAAE;QAAE,EAAE,EAAE,MAAM,CAAA;KAAE,EAAE,CAAA;IAC9B,IAAI,CAAC,EAAE,6BAA6B,CAAA;CACrC,CAAA"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/apis/interactiveMessages/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AAChD,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,UAAU,CAAA;AAIpC,KAAK,wBAAwB,GAAG;IAC9B,IAAI,EAAE,OAAO,CAAA;IACb,KAAK,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAA;CACrC,CAAA;AAED,KAAK,4BAA4B,GAAG,MAAM,GAAG;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE,CAAA;AAE7D,MAAM,MAAM,sBAAsB,GAAG,UAAU,GAAG,UAAU,GAAG,WAAW,GAAG,SAAS,CAAA;AAEtF,MAAM,MAAM,6BAA6B,GAAG,OAAO,GAAG,SAAS,CAAA;AAE/D;;;;;GAKG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,OAAO,EAAE,OAAO,CAAA;IAChB,OAAO,CAAC,EAAE,sBAAsB,CAAA;IAChC,2FAA2F;IAC3F,cAAc,CAAC,EAAE,6BAA6B,CAAA;IAC9C,yFAAyF;IACzF,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,gEAAgE;IAChE,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB,CAAA;AAED,KAAK,YAAY,GAAG;IAClB,IAAI,EAAE,SAAS,CAAA;IACf,UAAU,EAAE;QACV,6DAA6D;QAC7D,YAAY,EAAE,MAAM,CAAA;QACpB,2EAA2E;QAC3E,GAAG,EAAE,MAAM,CAAA;KACZ,CAAA;CACF,CAAA;AAID,KAAK,gBAAgB,GAAG;IACtB,EAAE,CAAC,EAAE,MAAM,CAAA;IACX,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB,CAAA;AAED,KAAK,qBAAqB,GAAG;IAC3B,EAAE,EAAE,MAAM,CAAA;IACV,KAAK,EAAE,MAAM,CAAA;IACb,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB,CAAA;AAED,KAAK,yBAAyB,GAAG;IAC/B,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,qBAAqB,EAAE,CAAA;CAC9B,CAAA;AAED,KAAK,6BAA6B,GAAG;IACnC,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,CAAC,EAAE;QACP,IAAI,EAAE,MAAM,CAAA;QACZ,IAAI,CAAC,EAAE,MAAM,GAAG;YAAE,IAAI,EAAE,MAAM,CAAA;SAAE,CAAA;KACjC,CAAA;IACD,IAAI,EAAE,4BAA4B,CAAA;IAClC,MAAM,CAAC,EAAE,4BAA4B,CAAA;IACrC,MAAM,EAAE;QACN,yCAAyC;QACzC,MAAM,EAAE,MAAM,CAAA;QACd,QAAQ,EAAE,yBAAyB,EAAE,CAAA;KACtC,CAAA;CACF,CAAA;AAED,KAAK,+BAA+B,GAAG;IACrC,IAAI,EAAE,QAAQ,CAAA;IACd,MAAM,CAAC,EAAE;QACP,IAAI,EAAE,MAAM,GAAG,UAAU,GAAG,OAAO,GAAG,OAAO,CAAA;QAC7C,IAAI,CAAC,EAAE,MAAM,GAAG;YAAE,IAAI,EAAE,MAAM,CAAA;SAAE,CAAA;QAChC,QAAQ,CAAC,EAAE,gBAAgB,CAAA;QAC3B,KAAK,CAAC,EAAE,gBAAgB,CAAA;QACxB,KAAK,CAAC,EAAE,gBAAgB,CAAA;KACzB,CAAA;IACD,IAAI,EAAE,4BAA4B,CAAA;IAClC,MAAM,CAAC,EAAE,4BAA4B,CAAA;IACrC,MAAM,EAAE;QACN,OAAO,EAAE,wBAAwB,EAAE,CAAA;KACpC,CAAA;CACF,CAAA;AAED,MAAM,MAAM,+BAA+B,GAAG;IAC5C,IAAI,EAAE,SAAS,CAAA;IACf,MAAM,CAAC,EAAE,+BAA+B,CAAC,QAAQ,CAAC,CAAA;IAClD,IAAI,EAAE,4BAA4B,CAAA;IAClC,MAAM,CAAC,EAAE,4BAA4B,CAAA;IACrC,MAAM,EAAE,YAAY,CAAA;IACpB,eAAe,CAAC,EAAE,eAAe,CAAA;CAClC,CAAA;AAED,mEAAmE;AACnE,MAAM,MAAM,2CAA2C,GAAG;IACxD,IAAI,EAAE,sBAAsB,CAAA;IAC5B,IAAI,EAAE,4BAA4B,CAAA;IAClC,MAAM,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,CAAA;CAC1B,CAAA;AAED,MAAM,MAAM,yBAAyB,GACjC,6BAA6B,GAC7B,+BAA+B,GAC/B,+BAA+B,GAC/B,2CAA2C,CAAA;AAI/C,KAAK,kCAAkC,GAAG;IACxC,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,CAAC,EAAE;QACP,IAAI,EAAE,MAAM,CAAA;QACZ,IAAI,CAAC,EAAE,MAAM,CAAA;KACd,CAAA;IACD,IAAI,EAAE,4BAA4B,CAAA;IAClC,MAAM,CAAC,EAAE,4BAA4B,CAAA;IACrC,MAAM,EAAE;QACN,MAAM,EAAE,MAAM,CAAA;QACd,QAAQ,EAAE,yBAAyB,EAAE,CAAA;KACtC,CAAA;CACF,CAAA;AAED,KAAK,oCAAoC,GAAG;IAC1C,IAAI,EAAE,QAAQ,CAAA;IACd,MAAM,CAAC,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG;QAAE,IAAI,EAAE,OAAO,GAAG,UAAU,GAAG,OAAO,CAAA;KAAE,CAAA;IACnF,IAAI,EAAE,4BAA4B,CAAA;IAClC,MAAM,CAAC,EAAE,4BAA4B,CAAA;IACrC,MAAM,EAAE;QACN,OAAO,EAAE,wBAAwB,EAAE,CAAA;KACpC,CAAA;CACF,CAAA;AAED,KAAK,oCAAoC,GAAG;IAC1C,IAAI,EAAE,SAAS,CAAA;IACf,MAAM,CAAC,EAAE,oCAAoC,CAAC,QAAQ,CAAC,CAAA;IACvD,IAAI,EAAE,4BAA4B,CAAA;IAClC,MAAM,CAAC,EAAE,4BAA4B,CAAA;IACrC,MAAM,EAAE,YAAY,CAAA;IACpB,eAAe,CAAC,EAAE,eAAe,CAAA;CAClC,CAAA;AAED,KAAK,gDAAgD,GAAG;IACtD,IAAI,EAAE,sBAAsB,CAAA;IAC5B,IAAI,EAAE,4BAA4B,CAAA;IAClC,MAAM,EAAE;QAAE,IAAI,EAAE,sBAAsB,CAAA;KAAE,CAAA;CACzC,CAAA;AAED,KAAK,8BAA8B,GAC/B,kCAAkC,GAClC,oCAAoC,GACpC,oCAAoC,GACpC,gDAAgD,CAAA;AAEpD,KAAK,6BAA6B,GAC9B;IAAE,EAAE,EAAE,MAAM,CAAA;CAAE,GACd;IAAE,QAAQ,EAAE,MAAM,CAAC;IAAC,SAAS,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CAAE,CAAA;AAI7D,MAAM,MAAM,kBAAkB,GAAG;IAC/B,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,+FAA+F;IAC/F,IAAI,CAAC,EAAE,MAAM,GAAG,QAAQ,GAAG,SAAS,GAAG,sBAAsB,CAAA;IAC7D,WAAW,EAAE,yBAAyB,CAAA;IACtC,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IAExB,IAAI,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;IAClB,WAAW,CAAC,EAAE,UAAU,EAAE,CAAA;IAC1B,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAClC,CAAA;AAED,MAAM,MAAM,+BAA+B,GAAG,MAAM,GAAG,aAAa,GAAG,SAAS,CAAA;AAEhF,MAAM,MAAM,+BAA+B,GAAG;IAC5C,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,EAAE,8BAA8B,CAAA;IAC3C,aAAa,CAAC,EAAE,MAAM,EAAE,CAAA;IACxB,WAAW,CAAC,EAAE;QAAE,EAAE,EAAE,MAAM,CAAA;KAAE,EAAE,CAAA;IAC9B,IAAI,CAAC,EAAE,6BAA6B,CAAA;CACrC,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,+BAA+B,GAAG;IAC5C,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,WAAW,CAAC,EAAE,8BAA8B,CAAA;IAC5C,aAAa,CAAC,EAAE,MAAM,EAAE,CAAA;IACxB,WAAW,CAAC,EAAE;QAAE,EAAE,EAAE,MAAM,CAAA;KAAE,EAAE,CAAA;IAC9B,IAAI,CAAC,EAAE,6BAA6B,CAAA;CACrC,CAAA"}

package/dist/apis/knowledgeBase/KnowledgeBaseApi.cjs

@@ -2,6 +2,11 @@ Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 const require_core_BaseCrudApi = require('../../core/BaseCrudApi.cjs');
 
 //#region src/apis/knowledgeBase/KnowledgeBaseApi.ts
+/**
+* Knowledge bases of the AI (copilot). The CRUD of a base without items only touches the database; an item
+* VECTORIZES its content in the AI service, and the suggestions call the AI and DEBIT the copilot credits of
+* the account.
+*/
 var KnowledgeBaseApi = class extends require_core_BaseCrudApi.BaseCrudApi {
 	constructor(client) {
 		super(client, "/knowledge-base");
@@ -14,6 +19,28 @@ var KnowledgeBaseApi = class extends require_core_BaseCrudApi.BaseCrudApi {
 	deleteById(id, headers) {
 		return super.deleteById(id, headers);
 	}
+	/**
+	* Creates a base, or updates the one of `id`, with its items, in a transaction. Each item VECTORIZES its
+	* content in the AI service (with `items: []` only the database is touched). Resolves the stored base
+	* (raw). A body out of the schema answers 500 with the issues of the validation.
+	*/
+	saveWithItems(body, headers) {
+		return this.client.post(`${this.basePath}/save-with-items`, body, headers);
+	}
+	/**
+	* Suggests an answer to a message with the AI (copilot) and DEBITS the copilot credits of the account; an
+	* audio is transcribed first (charged too).
+	*/
+	suggestByMessage(body, headers) {
+		return this.client.post(`${this.basePath}/suggest-by-message`, body, headers);
+	}
+	/**
+	* Suggests an answer to a ticket with the AI (copilot) and DEBITS the copilot credits of the account; the
+	* audios of the ticket are transcribed first (charged too).
+	*/
+	suggestByTicket(body, headers) {
+		return this.client.post(`${this.basePath}/suggest-by-ticket`, body, headers);
+	}
 };
 
 //#endregion

package/dist/apis/knowledgeBase/KnowledgeBaseApi.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"KnowledgeBaseApi.cjs","names":["BaseCrudApi"],"sources":["../../../src/apis/knowledgeBase/KnowledgeBaseApi.ts"],"sourcesContent":["import type { ApiClient } from '../../core/ApiClient'\nimport type { ListQuery } from '../../core/types'\nimport { BaseCrudApi } from '../../core/BaseCrudApi'\nimport type { KnowledgeBase, CreateKnowledgeBasePayload, UpdateKnowledgeBasePayload } from './types'\n\nexport class KnowledgeBaseApi extends BaseCrudApi<\n  KnowledgeBase,\n  CreateKnowledgeBasePayload,\n  UpdateKnowledgeBasePayload,\n  ListQuery<KnowledgeBase>,\n  false\n> {\n  constructor(client: ApiClient) {\n    super(client, '/knowledge-base')\n  }\n\n  /**\n   * Deletes a knowledge base. Resolves `false` even when it deleted (the backend answers nothing\n   * from the deletion), so do not read it as the result: check with `getById`. An unknown id\n   * answers 500.\n   */\n  override deleteById(id: string, headers?: Record<string, string>): Promise<false> {\n    return super.deleteById(id, headers)\n  }\n}\n"],"mappings":";;;;AAKA,IAAa,mBAAb,cAAsCA,qCAMpC;CACA,YAAY,QAAmB;AAC7B,QAAM,QAAQ,kBAAkB;;;;;;;CAQlC,AAAS,WAAW,IAAY,SAAkD;AAChF,SAAO,MAAM,WAAW,IAAI,QAAQ"}
+{"version":3,"file":"KnowledgeBaseApi.cjs","names":["BaseCrudApi"],"sources":["../../../src/apis/knowledgeBase/KnowledgeBaseApi.ts"],"sourcesContent":["import type { ApiClient } from '../../core/ApiClient'\nimport type { ListQuery } from '../../core/types'\nimport { BaseCrudApi } from '../../core/BaseCrudApi'\nimport type {\n  KnowledgeBase,\n  CreateKnowledgeBasePayload,\n  UpdateKnowledgeBasePayload,\n  KnowledgeBaseSuggestion,\n  SaveKnowledgeBaseWithItemsPayload,\n  SavedKnowledgeBase,\n  SuggestByMessagePayload,\n  SuggestByTicketPayload,\n} from './types'\n\n/**\n * Knowledge bases of the AI (copilot). The CRUD of a base without items only touches the database; an item\n * VECTORIZES its content in the AI service, and the suggestions call the AI and DEBIT the copilot credits of\n * the account.\n */\nexport class KnowledgeBaseApi extends BaseCrudApi<\n  KnowledgeBase,\n  CreateKnowledgeBasePayload,\n  UpdateKnowledgeBasePayload,\n  ListQuery<KnowledgeBase>,\n  false\n> {\n  constructor(client: ApiClient) {\n    super(client, '/knowledge-base')\n  }\n\n  /**\n   * Deletes a knowledge base. Resolves `false` even when it deleted (the backend answers nothing\n   * from the deletion), so do not read it as the result: check with `getById`. An unknown id\n   * answers 500.\n   */\n  override deleteById(id: string, headers?: Record<string, string>): Promise<false> {\n    return super.deleteById(id, headers)\n  }\n\n  /**\n   * Creates a base, or updates the one of `id`, with its items, in a transaction. Each item VECTORIZES its\n   * content in the AI service (with `items: []` only the database is touched). Resolves the stored base\n   * (raw). A body out of the schema answers 500 with the issues of the validation.\n   */\n  saveWithItems(\n    body: SaveKnowledgeBaseWithItemsPayload,\n    headers?: Record<string, string>,\n  ): Promise<SavedKnowledgeBase> {\n    return this.client.post<SavedKnowledgeBase, SaveKnowledgeBaseWithItemsPayload>(\n      `${this.basePath}/save-with-items`,\n      body,\n      headers,\n    )\n  }\n\n  /**\n   * Suggests an answer to a message with the AI (copilot) and DEBITS the copilot credits of the account; an\n   * audio is transcribed first (charged too).\n   */\n  suggestByMessage(\n    body: SuggestByMessagePayload,\n    headers?: Record<string, string>,\n  ): Promise<KnowledgeBaseSuggestion> {\n    return this.client.post<KnowledgeBaseSuggestion, SuggestByMessagePayload>(\n      `${this.basePath}/suggest-by-message`,\n      body,\n      headers,\n    )\n  }\n\n  /**\n   * Suggests an answer to a ticket with the AI (copilot) and DEBITS the copilot credits of the account; the\n   * audios of the ticket are transcribed first (charged too).\n   */\n  suggestByTicket(\n    body: SuggestByTicketPayload,\n    headers?: Record<string, string>,\n  ): Promise<KnowledgeBaseSuggestion> {\n    return this.client.post<KnowledgeBaseSuggestion, SuggestByTicketPayload>(\n      `${this.basePath}/suggest-by-ticket`,\n      body,\n      headers,\n    )\n  }\n}\n"],"mappings":";;;;;;;;;AAmBA,IAAa,mBAAb,cAAsCA,qCAMpC;CACA,YAAY,QAAmB;AAC7B,QAAM,QAAQ,kBAAkB;;;;;;;CAQlC,AAAS,WAAW,IAAY,SAAkD;AAChF,SAAO,MAAM,WAAW,IAAI,QAAQ;;;;;;;CAQtC,cACE,MACA,SAC6B;AAC7B,SAAO,KAAK,OAAO,KACjB,GAAG,KAAK,SAAS,mBACjB,MACA,QACD;;;;;;CAOH,iBACE,MACA,SACkC;AAClC,SAAO,KAAK,OAAO,KACjB,GAAG,KAAK,SAAS,sBACjB,MACA,QACD;;;;;;CAOH,gBACE,MACA,SACkC;AAClC,SAAO,KAAK,OAAO,KACjB,GAAG,KAAK,SAAS,qBACjB,MACA,QACD"}

package/dist/apis/knowledgeBase/KnowledgeBaseApi.d.ts

@@ -1,7 +1,12 @@
 import type { ApiClient } from '../../core/ApiClient';
 import type { ListQuery } from '../../core/types';
 import { BaseCrudApi } from '../../core/BaseCrudApi';
-import type { KnowledgeBase, CreateKnowledgeBasePayload, UpdateKnowledgeBasePayload } from './types';
+import type { KnowledgeBase, CreateKnowledgeBasePayload, UpdateKnowledgeBasePayload, KnowledgeBaseSuggestion, SaveKnowledgeBaseWithItemsPayload, SavedKnowledgeBase, SuggestByMessagePayload, SuggestByTicketPayload } from './types';
+/**
+ * Knowledge bases of the AI (copilot). The CRUD of a base without items only touches the database; an item
+ * VECTORIZES its content in the AI service, and the suggestions call the AI and DEBIT the copilot credits of
+ * the account.
+ */
 export declare class KnowledgeBaseApi extends BaseCrudApi<KnowledgeBase, CreateKnowledgeBasePayload, UpdateKnowledgeBasePayload, ListQuery<KnowledgeBase>, false> {
     constructor(client: ApiClient);
     /**
@@ -10,5 +15,21 @@ export declare class KnowledgeBaseApi extends BaseCrudApi<KnowledgeBase, CreateK
      * answers 500.
      */
     deleteById(id: string, headers?: Record<string, string>): Promise<false>;
+    /**
+     * Creates a base, or updates the one of `id`, with its items, in a transaction. Each item VECTORIZES its
+     * content in the AI service (with `items: []` only the database is touched). Resolves the stored base
+     * (raw). A body out of the schema answers 500 with the issues of the validation.
+     */
+    saveWithItems(body: SaveKnowledgeBaseWithItemsPayload, headers?: Record<string, string>): Promise<SavedKnowledgeBase>;
+    /**
+     * Suggests an answer to a message with the AI (copilot) and DEBITS the copilot credits of the account; an
+     * audio is transcribed first (charged too).
+     */
+    suggestByMessage(body: SuggestByMessagePayload, headers?: Record<string, string>): Promise<KnowledgeBaseSuggestion>;
+    /**
+     * Suggests an answer to a ticket with the AI (copilot) and DEBITS the copilot credits of the account; the
+     * audios of the ticket are transcribed first (charged too).
+     */
+    suggestByTicket(body: SuggestByTicketPayload, headers?: Record<string, string>): Promise<KnowledgeBaseSuggestion>;
 }
 //# sourceMappingURL=KnowledgeBaseApi.d.ts.map

package/dist/apis/knowledgeBase/KnowledgeBaseApi.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"KnowledgeBaseApi.d.ts","sourceRoot":"","sources":["../../../src/apis/knowledgeBase/KnowledgeBaseApi.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAA;AACrD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAA;AACjD,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAA;AACpD,OAAO,KAAK,EAAE,aAAa,EAAE,0BAA0B,EAAE,0BAA0B,EAAE,MAAM,SAAS,CAAA;AAEpG,qBAAa,gBAAiB,SAAQ,WAAW,CAC/C,aAAa,EACb,0BAA0B,EAC1B,0BAA0B,EAC1B,SAAS,CAAC,aAAa,CAAC,EACxB,KAAK,CACN;gBACa,MAAM,EAAE,SAAS;IAI7B;;;;OAIG;IACM,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,KAAK,CAAC;CAGlF"}
+{"version":3,"file":"KnowledgeBaseApi.d.ts","sourceRoot":"","sources":["../../../src/apis/knowledgeBase/KnowledgeBaseApi.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAA;AACrD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAA;AACjD,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAA;AACpD,OAAO,KAAK,EACV,aAAa,EACb,0BAA0B,EAC1B,0BAA0B,EAC1B,uBAAuB,EACvB,iCAAiC,EACjC,kBAAkB,EAClB,uBAAuB,EACvB,sBAAsB,EACvB,MAAM,SAAS,CAAA;AAEhB;;;;GAIG;AACH,qBAAa,gBAAiB,SAAQ,WAAW,CAC/C,aAAa,EACb,0BAA0B,EAC1B,0BAA0B,EAC1B,SAAS,CAAC,aAAa,CAAC,EACxB,KAAK,CACN;gBACa,MAAM,EAAE,SAAS;IAI7B;;;;OAIG;IACM,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,KAAK,CAAC;IAIjF;;;;OAIG;IACH,aAAa,CACX,IAAI,EAAE,iCAAiC,EACvC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,kBAAkB,CAAC;IAQ9B;;;OAGG;IACH,gBAAgB,CACd,IAAI,EAAE,uBAAuB,EAC7B,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,uBAAuB,CAAC;IAQnC;;;OAGG;IACH,eAAe,CACb,IAAI,EAAE,sBAAsB,EAC5B,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,uBAAuB,CAAC;CAOpC"}

package/dist/apis/knowledgeBase/KnowledgeBaseApi.mjs

@@ -1,6 +1,11 @@
 import { BaseCrudApi } from "../../core/BaseCrudApi.mjs";
 
 //#region src/apis/knowledgeBase/KnowledgeBaseApi.ts
+/**
+* Knowledge bases of the AI (copilot). The CRUD of a base without items only touches the database; an item
+* VECTORIZES its content in the AI service, and the suggestions call the AI and DEBIT the copilot credits of
+* the account.
+*/
 var KnowledgeBaseApi = class extends BaseCrudApi {
 	constructor(client) {
 		super(client, "/knowledge-base");
@@ -13,6 +18,28 @@ var KnowledgeBaseApi = class extends BaseCrudApi {
 	deleteById(id, headers) {
 		return super.deleteById(id, headers);
 	}
+	/**
+	* Creates a base, or updates the one of `id`, with its items, in a transaction. Each item VECTORIZES its
+	* content in the AI service (with `items: []` only the database is touched). Resolves the stored base
+	* (raw). A body out of the schema answers 500 with the issues of the validation.
+	*/
+	saveWithItems(body, headers) {
+		return this.client.post(`${this.basePath}/save-with-items`, body, headers);
+	}
+	/**
+	* Suggests an answer to a message with the AI (copilot) and DEBITS the copilot credits of the account; an
+	* audio is transcribed first (charged too).
+	*/
+	suggestByMessage(body, headers) {
+		return this.client.post(`${this.basePath}/suggest-by-message`, body, headers);
+	}
+	/**
+	* Suggests an answer to a ticket with the AI (copilot) and DEBITS the copilot credits of the account; the
+	* audios of the ticket are transcribed first (charged too).
+	*/
+	suggestByTicket(body, headers) {
+		return this.client.post(`${this.basePath}/suggest-by-ticket`, body, headers);
+	}
 };
 
 //#endregion

package/dist/apis/knowledgeBase/KnowledgeBaseApi.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"KnowledgeBaseApi.mjs","names":[],"sources":["../../../src/apis/knowledgeBase/KnowledgeBaseApi.ts"],"sourcesContent":["import type { ApiClient } from '../../core/ApiClient'\nimport type { ListQuery } from '../../core/types'\nimport { BaseCrudApi } from '../../core/BaseCrudApi'\nimport type { KnowledgeBase, CreateKnowledgeBasePayload, UpdateKnowledgeBasePayload } from './types'\n\nexport class KnowledgeBaseApi extends BaseCrudApi<\n  KnowledgeBase,\n  CreateKnowledgeBasePayload,\n  UpdateKnowledgeBasePayload,\n  ListQuery<KnowledgeBase>,\n  false\n> {\n  constructor(client: ApiClient) {\n    super(client, '/knowledge-base')\n  }\n\n  /**\n   * Deletes a knowledge base. Resolves `false` even when it deleted (the backend answers nothing\n   * from the deletion), so do not read it as the result: check with `getById`. An unknown id\n   * answers 500.\n   */\n  override deleteById(id: string, headers?: Record<string, string>): Promise<false> {\n    return super.deleteById(id, headers)\n  }\n}\n"],"mappings":";;;AAKA,IAAa,mBAAb,cAAsC,YAMpC;CACA,YAAY,QAAmB;AAC7B,QAAM,QAAQ,kBAAkB;;;;;;;CAQlC,AAAS,WAAW,IAAY,SAAkD;AAChF,SAAO,MAAM,WAAW,IAAI,QAAQ"}
+{"version":3,"file":"KnowledgeBaseApi.mjs","names":[],"sources":["../../../src/apis/knowledgeBase/KnowledgeBaseApi.ts"],"sourcesContent":["import type { ApiClient } from '../../core/ApiClient'\nimport type { ListQuery } from '../../core/types'\nimport { BaseCrudApi } from '../../core/BaseCrudApi'\nimport type {\n  KnowledgeBase,\n  CreateKnowledgeBasePayload,\n  UpdateKnowledgeBasePayload,\n  KnowledgeBaseSuggestion,\n  SaveKnowledgeBaseWithItemsPayload,\n  SavedKnowledgeBase,\n  SuggestByMessagePayload,\n  SuggestByTicketPayload,\n} from './types'\n\n/**\n * Knowledge bases of the AI (copilot). The CRUD of a base without items only touches the database; an item\n * VECTORIZES its content in the AI service, and the suggestions call the AI and DEBIT the copilot credits of\n * the account.\n */\nexport class KnowledgeBaseApi extends BaseCrudApi<\n  KnowledgeBase,\n  CreateKnowledgeBasePayload,\n  UpdateKnowledgeBasePayload,\n  ListQuery<KnowledgeBase>,\n  false\n> {\n  constructor(client: ApiClient) {\n    super(client, '/knowledge-base')\n  }\n\n  /**\n   * Deletes a knowledge base. Resolves `false` even when it deleted (the backend answers nothing\n   * from the deletion), so do not read it as the result: check with `getById`. An unknown id\n   * answers 500.\n   */\n  override deleteById(id: string, headers?: Record<string, string>): Promise<false> {\n    return super.deleteById(id, headers)\n  }\n\n  /**\n   * Creates a base, or updates the one of `id`, with its items, in a transaction. Each item VECTORIZES its\n   * content in the AI service (with `items: []` only the database is touched). Resolves the stored base\n   * (raw). A body out of the schema answers 500 with the issues of the validation.\n   */\n  saveWithItems(\n    body: SaveKnowledgeBaseWithItemsPayload,\n    headers?: Record<string, string>,\n  ): Promise<SavedKnowledgeBase> {\n    return this.client.post<SavedKnowledgeBase, SaveKnowledgeBaseWithItemsPayload>(\n      `${this.basePath}/save-with-items`,\n      body,\n      headers,\n    )\n  }\n\n  /**\n   * Suggests an answer to a message with the AI (copilot) and DEBITS the copilot credits of the account; an\n   * audio is transcribed first (charged too).\n   */\n  suggestByMessage(\n    body: SuggestByMessagePayload,\n    headers?: Record<string, string>,\n  ): Promise<KnowledgeBaseSuggestion> {\n    return this.client.post<KnowledgeBaseSuggestion, SuggestByMessagePayload>(\n      `${this.basePath}/suggest-by-message`,\n      body,\n      headers,\n    )\n  }\n\n  /**\n   * Suggests an answer to a ticket with the AI (copilot) and DEBITS the copilot credits of the account; the\n   * audios of the ticket are transcribed first (charged too).\n   */\n  suggestByTicket(\n    body: SuggestByTicketPayload,\n    headers?: Record<string, string>,\n  ): Promise<KnowledgeBaseSuggestion> {\n    return this.client.post<KnowledgeBaseSuggestion, SuggestByTicketPayload>(\n      `${this.basePath}/suggest-by-ticket`,\n      body,\n      headers,\n    )\n  }\n}\n"],"mappings":";;;;;;;;AAmBA,IAAa,mBAAb,cAAsC,YAMpC;CACA,YAAY,QAAmB;AAC7B,QAAM,QAAQ,kBAAkB;;;;;;;CAQlC,AAAS,WAAW,IAAY,SAAkD;AAChF,SAAO,MAAM,WAAW,IAAI,QAAQ;;;;;;;CAQtC,cACE,MACA,SAC6B;AAC7B,SAAO,KAAK,OAAO,KACjB,GAAG,KAAK,SAAS,mBACjB,MACA,QACD;;;;;;CAOH,iBACE,MACA,SACkC;AAClC,SAAO,KAAK,OAAO,KACjB,GAAG,KAAK,SAAS,sBACjB,MACA,QACD;;;;;;CAOH,gBACE,MACA,SACkC;AAClC,SAAO,KAAK,OAAO,KACjB,GAAG,KAAK,SAAS,qBACjB,MACA,QACD"}

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

@@ -1,4 +1,5 @@
 import type { KnowledgeBaseItem } from '../knowledgeBaseItem/types';
+/** A knowledge base as the transformer answers it (`items` always comes: `[]` without the include). */
 export type KnowledgeBase = {
     id: string;
     name: string;
@@ -6,16 +7,69 @@ export type KnowledgeBase = {
     accountId: string;
     createdAt: string;
     updatedAt: string;
-    deletedAt: string | null;
+    /** @deprecated Not answered: the transformer of the backend does not send it. */
+    deletedAt?: string | null;
     items?: KnowledgeBaseItem[];
+    account?: Record<string, unknown>;
 };
-export type KnowledgeBaseRelationships = 'items';
+export type KnowledgeBaseRelationships = 'items' | 'account';
 export type CreateKnowledgeBasePayload = {
+    /** Up to 60 characters. */
     name: string;
+    /** Up to 600 characters. */
     description?: string;
 };
+/** The backend requires `name` on the update too (400 without it). */
 export type UpdateKnowledgeBasePayload = {
     name?: string;
     description?: string | null;
 };
+/**
+ * An item of `saveWithItems`. Any item VECTORIZES its content in the AI service (Haystack) on the save:
+ * `text` for `messages`, `url` for `urls` (the service fetches the page), `fileId` for `files`.
+ */
+export type SaveKnowledgeBaseItemInput = {
+    name: string;
+    type: 'urls' | 'files' | 'messages';
+    url?: string;
+    fileId?: string;
+    text?: string;
+};
+/** The body of `saveWithItems`: creates the base, or updates the one of `id`, with its items. */
+export type SaveKnowledgeBaseWithItemsPayload = {
+    /** 1 to 60 characters. */
+    name: string;
+    /** Up to 600 characters. */
+    description?: string;
+    /** The base to update (absent: a new base). */
+    id?: string;
+    items?: SaveKnowledgeBaseItemInput[];
+    /** Items of the base to delete. */
+    deleteItemIds?: string[];
+};
+/** The stored base answered by `saveWithItems` (raw: with `synchronized`, without `items`). */
+export type SavedKnowledgeBase = Omit<KnowledgeBase, 'items' | 'account' | 'deletedAt'> & {
+    synchronized: boolean | null;
+    deletedAt: string | null;
+};
+/**
+ * What the suggestions answer: the suggested text, or a `message` code when nothing was suggested (e.g.
+ * `COPILOT_LIMIT_REACHED`, `COPILOT_TRANSCRIPTION_NOT_ENABLED`, `TRANSCRIBING_AUDIO_MESSAGES`).
+ */
+export type KnowledgeBaseSuggestion = {
+    message: string;
+    hasAudioMessage?: boolean;
+    hadEnoughCreditsToTranscribe?: boolean;
+    [key: string]: unknown;
+};
+export type SuggestByMessagePayload = {
+    messageId: string;
+    /** Lets the AI answer beyond the knowledge base. */
+    outsideTheKnowledgeBase?: boolean;
+};
+export type SuggestByTicketPayload = {
+    ticketId: string;
+    /** Lets the AI answer beyond the knowledge base. */
+    outsideTheKnowledgeBase?: boolean;
+};
 //# sourceMappingURL=types.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/apis/knowledgeBase/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAA;AAEnE,MAAM,MAAM,aAAa,GAAG;IAC1B,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,EAAE,MAAM,GAAG,IAAI,CAAA;IAC1B,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IAExB,KAAK,CAAC,EAAE,iBAAiB,EAAE,CAAA;CAC5B,CAAA;AAED,MAAM,MAAM,0BAA0B,GAAG,OAAO,CAAA;AAEhD,MAAM,MAAM,0BAA0B,GAAG;IACvC,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB,CAAA;AAED,MAAM,MAAM,0BAA0B,GAAG;IACvC,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CAC5B,CAAA"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/apis/knowledgeBase/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAA;AAEnE,uGAAuG;AACvG,MAAM,MAAM,aAAa,GAAG;IAC1B,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,EAAE,MAAM,GAAG,IAAI,CAAA;IAC1B,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,iFAAiF;IACjF,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAEzB,KAAK,CAAC,EAAE,iBAAiB,EAAE,CAAA;IAC3B,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAClC,CAAA;AAED,MAAM,MAAM,0BAA0B,GAAG,OAAO,GAAG,SAAS,CAAA;AAE5D,MAAM,MAAM,0BAA0B,GAAG;IACvC,2BAA2B;IAC3B,IAAI,EAAE,MAAM,CAAA;IACZ,4BAA4B;IAC5B,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB,CAAA;AAED,sEAAsE;AACtE,MAAM,MAAM,0BAA0B,GAAG;IACvC,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CAC5B,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,0BAA0B,GAAG;IACvC,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,GAAG,OAAO,GAAG,UAAU,CAAA;IACnC,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,IAAI,CAAC,EAAE,MAAM,CAAA;CACd,CAAA;AAED,iGAAiG;AACjG,MAAM,MAAM,iCAAiC,GAAG;IAC9C,0BAA0B;IAC1B,IAAI,EAAE,MAAM,CAAA;IACZ,4BAA4B;IAC5B,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,+CAA+C;IAC/C,EAAE,CAAC,EAAE,MAAM,CAAA;IACX,KAAK,CAAC,EAAE,0BAA0B,EAAE,CAAA;IACpC,mCAAmC;IACnC,aAAa,CAAC,EAAE,MAAM,EAAE,CAAA;CACzB,CAAA;AAED,+FAA+F;AAC/F,MAAM,MAAM,kBAAkB,GAAG,IAAI,CAAC,aAAa,EAAE,OAAO,GAAG,SAAS,GAAG,WAAW,CAAC,GAAG;IACxF,YAAY,EAAE,OAAO,GAAG,IAAI,CAAA;IAC5B,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;CACzB,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,uBAAuB,GAAG;IACpC,OAAO,EAAE,MAAM,CAAA;IACf,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB,4BAA4B,CAAC,EAAE,OAAO,CAAA;IACtC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;CACvB,CAAA;AAED,MAAM,MAAM,uBAAuB,GAAG;IACpC,SAAS,EAAE,MAAM,CAAA;IACjB,oDAAoD;IACpD,uBAAuB,CAAC,EAAE,OAAO,CAAA;CAClC,CAAA;AAED,MAAM,MAAM,sBAAsB,GAAG;IACnC,QAAQ,EAAE,MAAM,CAAA;IAChB,oDAAoD;IACpD,uBAAuB,CAAC,EAAE,OAAO,CAAA;CAClC,CAAA"}

package/dist/apis/knowledgeBaseItem/KnowledgeBaseItemApi.cjs

@@ -2,6 +2,10 @@ Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 const require_core_BaseCrudApi = require('../../core/BaseCrudApi.cjs');
 
 //#region src/apis/knowledgeBaseItem/KnowledgeBaseItemApi.ts
+/**
+* Items of the knowledge bases. Creating an item VECTORIZES its content in the AI service; reading the
+* `docs` (include, `fetchMany`) reads them from it.
+*/
 var KnowledgeBaseItemApi = class extends require_core_BaseCrudApi.BaseCrudApi {
 	constructor(client) {
 		super(client, "/knowledge-base-item");
@@ -14,6 +18,28 @@ var KnowledgeBaseItemApi = class extends require_core_BaseCrudApi.BaseCrudApi {
 	deleteById(id, headers) {
 		return super.deleteById(id, headers);
 	}
+	/**
+	* Reads the items of `ids` with their documents (read from the AI service). Resolves the stored items, raw:
+	* unlike the other reads they carry `knowledgeBaseId`, `fileId` and `deletedAt`. An empty or absent `ids`
+	* answers 400 `Invalid knowledge base item ids`.
+	*/
+	fetchMany(ids, headers) {
+		return this.client.post(`${this.basePath}/fetch-many`, { ids }, headers);
+	}
+	/**
+	* Deletes the items of `ids` of the account (soft delete; their documents stay in the AI service).
+	* Resolves `true`; an empty or absent `ids` answers 400 `Invalid knowledge base item ids`.
+	*/
+	deleteMany(ids, headers) {
+		return this.client.request("DELETE", `${this.basePath}/many`, { ids }, headers);
+	}
+	/**
+	* Tells whether the PDF of `fileId` has text to be vectorized (read locally, no AI). Without `fileId` it
+	* resolves `{ hasText: false }`.
+	*/
+	checkPdfText(body, headers) {
+		return this.client.post(`${this.basePath}/check-pdf-text`, body, headers);
+	}
 };
 
 //#endregion