@ikatec/digisac-api-sdk 4.14.0 → 4.15.0

package/dist/apis/files/FilesApi.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"FilesApi.d.ts","sourceRoot":"","sources":["../../../src/apis/files/FilesApi.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAA;AACrD,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAA;AAEpD,OAAO,KAAK,EAAE,YAAY,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAA;AAC1E,OAAO,KAAK,EACV,IAAI,EACJ,iBAAiB,EACjB,iBAAiB,EACjB,qBAAqB,EACrB,oBAAoB,EACpB,gBAAgB,EACjB,MAAM,SAAS,CAAA;AAEhB;;;;;GAKG;AACH,qBAAa,QAAS,SAAQ,WAAW,CACvC,IAAI,EACJ,iBAAiB,EACjB,iBAAiB,EACjB,SAAS,CAAC,IAAI,CAAC,EACf,gBAAgB,CACjB;gBACa,MAAM,EAAE,SAAS;IAI7B,wFAAwF;IAC/E,OAAO,CACd,KAAK,EAAE,SAAS,CAAC,IAAI,CAAC,GAAG;QAAE,QAAQ,EAAE,KAAK,CAAA;KAAE,EAC5C,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,IAAI,EAAE,CAAC;IAClB,wFAAwF;IAC/E,OAAO,CACd,KAAK,CAAC,EAAE,SAAS,CAAC,IAAI,CAAC,GAAG;QAAE,QAAQ,CAAC,EAAE,IAAI,CAAA;KAAE,EAC7C,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IAC3B,wFAAwF;IAC/E,OAAO,CACd,KAAK,CAAC,EAAE,SAAS,CAAC,IAAI,CAAC,EACvB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,IAAI,EAAE,CAAC;IAQpC,wFAAwF;IAC/E,MAAM,CAAC,KAAK,CAAC,EAAE,SAAS,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC;IAIhG,4FAA4F;IACnF,OAAO,CACd,EAAE,EAAE,MAAM,EACV,KAAK,CAAC,EAAE,YAAY,CAAC,IAAI,CAAC,EAC1B,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,IAAI,CAAC;IAIhB,4FAA4F;IACnF,UAAU,CACjB,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,iBAAiB,EACvB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,IAAI,CAAC;IAIhB;;;OAGG;IACM,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAI5F;;;;;OAKG;IACH,cAAc,CACZ,IAAI,EAAE,qBAAqB,EAC3B,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,oBAAoB,CAAC;IAQhC;;;;;;OAMG;IACG,MAAM,CAAC,WAAW,EAAE,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAMtF"}
+{"version":3,"file":"FilesApi.d.ts","sourceRoot":"","sources":["../../../src/apis/files/FilesApi.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAA;AACrD,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAA;AAEpD,OAAO,KAAK,EAAE,YAAY,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAA;AAC1E,OAAO,KAAK,EACV,IAAI,EACJ,iBAAiB,EACjB,iBAAiB,EACjB,qBAAqB,EACrB,oBAAoB,EACpB,gBAAgB,EAChB,oBAAoB,EACrB,MAAM,SAAS,CAAA;AAEhB;;;;;GAKG;AACH,qBAAa,QAAS,SAAQ,WAAW,CACvC,IAAI,EACJ,iBAAiB,EACjB,iBAAiB,EACjB,SAAS,CAAC,IAAI,CAAC,EACf,gBAAgB,CACjB;gBACa,MAAM,EAAE,SAAS;IAI7B,wFAAwF;IAC/E,OAAO,CACd,KAAK,EAAE,SAAS,CAAC,IAAI,CAAC,GAAG;QAAE,QAAQ,EAAE,KAAK,CAAA;KAAE,EAC5C,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,IAAI,EAAE,CAAC;IAClB,wFAAwF;IAC/E,OAAO,CACd,KAAK,CAAC,EAAE,SAAS,CAAC,IAAI,CAAC,GAAG;QAAE,QAAQ,CAAC,EAAE,IAAI,CAAA;KAAE,EAC7C,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IAC3B,wFAAwF;IAC/E,OAAO,CACd,KAAK,CAAC,EAAE,SAAS,CAAC,IAAI,CAAC,EACvB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,IAAI,EAAE,CAAC;IAQpC,wFAAwF;IAC/E,MAAM,CAAC,KAAK,CAAC,EAAE,SAAS,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC;IAIhG,4FAA4F;IACnF,OAAO,CACd,EAAE,EAAE,MAAM,EACV,KAAK,CAAC,EAAE,YAAY,CAAC,IAAI,CAAC,EAC1B,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,IAAI,CAAC;IAIhB,4FAA4F;IACnF,UAAU,CACjB,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,iBAAiB,EACvB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,IAAI,CAAC;IAIhB;;;OAGG;IACM,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAI5F;;;;;;OAMG;IACH,cAAc,CACZ,IAAI,EAAE,qBAAqB,EAC3B,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,oBAAoB,CAAC;IAQhC;;;;;;;OAOG;IACH,aAAa,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC;IAQ5F;;;;;;OAMG;IACG,MAAM,CAAC,WAAW,EAAE,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAMtF"}

package/dist/apis/files/FilesApi.mjs

@@ -38,12 +38,24 @@ var FilesApi = class extends BaseCrudApi {
 	* Creates the record of a file and returns the signed URL to upload its content: send the
 	* content with {@link upload}. An audio that must be converted (a voice message for the
 	* connection) is sent in `base64` instead, and then no `urlToUpload` is returned. `name` and
-	* `mimetype` are required (500 without them; an audio without `name` is named `recording`).
+	* `mimetype` are required (500 without them; an audio without `name` is named `recording`). With
+	* `serviceId`, an extension the account blocks for the type of the connection answers 403.
 	*/
 	createToUpload(body, headers) {
 		return this.client.post(`${this.basePath}/create-to-upload`, body, headers);
 	}
 	/**
+	* Copies the content of a file. With `urlToUpload` (the signed URL of a record created by
+	* {@link createToUpload} with the same `mimetype` as the file copied), the content is sent to that
+	* record and the answer is the `fileId` given; without it, a new record (`attachedType`
+	* `'message.file'`) is created with the copied content and its id is the answer, and with
+	* `serviceId` an extension the account blocks for the type of the connection answers 403. An
+	* unknown `fileId` answers 500.
+	*/
+	duplicateFile(body, headers) {
+		return this.client.post(`${this.basePath}/duplicate-file`, body, headers);
+	}
+	/**
 	* Uploads the content of a file to the `urlToUpload` returned by {@link createToUpload}. The URL
 	* is signed by the storage, so the request goes straight to it, without the API token (the
 	* storage refuses an `Authorization` header). `mimetype` must be the one sent to

package/dist/apis/files/FilesApi.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"FilesApi.mjs","names":[],"sources":["../../../src/apis/files/FilesApi.ts"],"sourcesContent":["import type { ApiClient } from '../../core/ApiClient'\nimport { BaseCrudApi } from '../../core/BaseCrudApi'\nimport { requestExternal } from '../../core/requestExternal'\nimport type { GetByIdQuery, ListQuery, Paginated } from '../../core/types'\nimport type {\n  File,\n  CreateFilePayload,\n  UpdateFilePayload,\n  CreateToUploadPayload,\n  CreateToUploadResult,\n  DeleteFileResult,\n} from './types'\n\n/**\n * Files of the account. The backend serves `POST /files` (the record only, no content),\n * `POST /files/create-to-upload` (record + signed URL to upload the content), `POST\n * /files/duplicate-file`, `DELETE /files/:id` and the signed download `GET\n * /files/:accountId/:filename`; there is no list, read by id nor update.\n */\nexport class FilesApi extends BaseCrudApi<\n  File,\n  CreateFilePayload,\n  UpdateFilePayload,\n  ListQuery<File>,\n  DeleteFileResult\n> {\n  constructor(client: ApiClient) {\n    super(client, '/files')\n  }\n\n  /** @deprecated Not served: the backend has no GET /files, so this route answers 404. */\n  override getMany(\n    query: ListQuery<File> & { paginate: false },\n    headers?: Record<string, string>,\n  ): Promise<File[]>\n  /** @deprecated Not served: the backend has no GET /files, so this route answers 404. */\n  override getMany(\n    query?: ListQuery<File> & { paginate?: true },\n    headers?: Record<string, string>,\n  ): Promise<Paginated<File>>\n  /** @deprecated Not served: the backend has no GET /files, so this route answers 404. */\n  override getMany(\n    query?: ListQuery<File>,\n    headers?: Record<string, string>,\n  ): Promise<Paginated<File> | File[]>\n  override getMany(\n    query?: ListQuery<File>,\n    headers?: Record<string, string>,\n  ): Promise<Paginated<File> | File[]> {\n    return super.getMany(query, headers)\n  }\n\n  /** @deprecated Not served: the backend has no GET /files, so this route answers 404. */\n  override getOne(query?: ListQuery<File>, headers?: Record<string, string>): Promise<File | null> {\n    return super.getOne(query, headers)\n  }\n\n  /** @deprecated Not served: the backend has no GET /files/:id, so this route answers 404. */\n  override getById(\n    id: string,\n    query?: GetByIdQuery<File>,\n    headers?: Record<string, string>,\n  ): Promise<File> {\n    return super.getById(id, query, headers)\n  }\n\n  /** @deprecated Not served: the backend has no PUT /files/:id, so this route answers 404. */\n  override updateById(\n    id: string,\n    body: UpdateFilePayload,\n    headers?: Record<string, string>,\n  ): Promise<File> {\n    return super.updateById(id, body, headers)\n  }\n\n  /**\n   * Deletes a file. Resolves `{ success: true }`, also for an unknown id; a file of another\n   * account answers 403.\n   */\n  override deleteById(id: string, headers?: Record<string, string>): Promise<DeleteFileResult> {\n    return super.deleteById(id, headers)\n  }\n\n  /**\n   * Creates the record of a file and returns the signed URL to upload its content: send the\n   * content with {@link upload}. An audio that must be converted (a voice message for the\n   * connection) is sent in `base64` instead, and then no `urlToUpload` is returned. `name` and\n   * `mimetype` are required (500 without them; an audio without `name` is named `recording`).\n   */\n  createToUpload(\n    body: CreateToUploadPayload,\n    headers?: Record<string, string>,\n  ): Promise<CreateToUploadResult> {\n    return this.client.post<CreateToUploadResult, CreateToUploadPayload>(\n      `${this.basePath}/create-to-upload`,\n      body,\n      headers,\n    )\n  }\n\n  /**\n   * Uploads the content of a file to the `urlToUpload` returned by {@link createToUpload}. The URL\n   * is signed by the storage, so the request goes straight to it, without the API token (the\n   * storage refuses an `Authorization` header). `mimetype` must be the one sent to\n   * `createToUpload`. Sent through `client.requestExternal` (the global `fetch` for a client\n   * without it). A non-2xx answer of the storage throws `ApiError`.\n   */\n  async upload(urlToUpload: string, content: BodyInit, mimetype: string): Promise<void> {\n    const headers = { 'Content-Type': mimetype }\n    await (this.client.requestExternal\n      ? this.client.requestExternal('PUT', urlToUpload, content, headers)\n      : requestExternal('PUT', urlToUpload, content, headers))\n  }\n}\n"],"mappings":";;;;;;;;;;AAmBA,IAAa,WAAb,cAA8B,YAM5B;CACA,YAAY,QAAmB;AAC7B,QAAM,QAAQ,SAAS;;CAkBzB,AAAS,QACP,OACA,SACmC;AACnC,SAAO,MAAM,QAAQ,OAAO,QAAQ;;;CAItC,AAAS,OAAO,OAAyB,SAAwD;AAC/F,SAAO,MAAM,OAAO,OAAO,QAAQ;;;CAIrC,AAAS,QACP,IACA,OACA,SACe;AACf,SAAO,MAAM,QAAQ,IAAI,OAAO,QAAQ;;;CAI1C,AAAS,WACP,IACA,MACA,SACe;AACf,SAAO,MAAM,WAAW,IAAI,MAAM,QAAQ;;;;;;CAO5C,AAAS,WAAW,IAAY,SAA6D;AAC3F,SAAO,MAAM,WAAW,IAAI,QAAQ;;;;;;;;CAStC,eACE,MACA,SAC+B;AAC/B,SAAO,KAAK,OAAO,KACjB,GAAG,KAAK,SAAS,oBACjB,MACA,QACD;;;;;;;;;CAUH,MAAM,OAAO,aAAqB,SAAmB,UAAiC;EACpF,MAAM,UAAU,EAAE,gBAAgB,UAAU;AAC5C,SAAO,KAAK,OAAO,kBACf,KAAK,OAAO,gBAAgB,OAAO,aAAa,SAAS,QAAQ,GACjE,gBAAgB,OAAO,aAAa,SAAS,QAAQ"}
+{"version":3,"file":"FilesApi.mjs","names":[],"sources":["../../../src/apis/files/FilesApi.ts"],"sourcesContent":["import type { ApiClient } from '../../core/ApiClient'\nimport { BaseCrudApi } from '../../core/BaseCrudApi'\nimport { requestExternal } from '../../core/requestExternal'\nimport type { GetByIdQuery, ListQuery, Paginated } from '../../core/types'\nimport type {\n  File,\n  CreateFilePayload,\n  UpdateFilePayload,\n  CreateToUploadPayload,\n  CreateToUploadResult,\n  DeleteFileResult,\n  DuplicateFilePayload,\n} from './types'\n\n/**\n * Files of the account. The backend serves `POST /files` (the record only, no content),\n * `POST /files/create-to-upload` (record + signed URL to upload the content), `POST\n * /files/duplicate-file`, `DELETE /files/:id` and the signed download `GET\n * /files/:accountId/:filename`; there is no list, read by id nor update.\n */\nexport class FilesApi extends BaseCrudApi<\n  File,\n  CreateFilePayload,\n  UpdateFilePayload,\n  ListQuery<File>,\n  DeleteFileResult\n> {\n  constructor(client: ApiClient) {\n    super(client, '/files')\n  }\n\n  /** @deprecated Not served: the backend has no GET /files, so this route answers 404. */\n  override getMany(\n    query: ListQuery<File> & { paginate: false },\n    headers?: Record<string, string>,\n  ): Promise<File[]>\n  /** @deprecated Not served: the backend has no GET /files, so this route answers 404. */\n  override getMany(\n    query?: ListQuery<File> & { paginate?: true },\n    headers?: Record<string, string>,\n  ): Promise<Paginated<File>>\n  /** @deprecated Not served: the backend has no GET /files, so this route answers 404. */\n  override getMany(\n    query?: ListQuery<File>,\n    headers?: Record<string, string>,\n  ): Promise<Paginated<File> | File[]>\n  override getMany(\n    query?: ListQuery<File>,\n    headers?: Record<string, string>,\n  ): Promise<Paginated<File> | File[]> {\n    return super.getMany(query, headers)\n  }\n\n  /** @deprecated Not served: the backend has no GET /files, so this route answers 404. */\n  override getOne(query?: ListQuery<File>, headers?: Record<string, string>): Promise<File | null> {\n    return super.getOne(query, headers)\n  }\n\n  /** @deprecated Not served: the backend has no GET /files/:id, so this route answers 404. */\n  override getById(\n    id: string,\n    query?: GetByIdQuery<File>,\n    headers?: Record<string, string>,\n  ): Promise<File> {\n    return super.getById(id, query, headers)\n  }\n\n  /** @deprecated Not served: the backend has no PUT /files/:id, so this route answers 404. */\n  override updateById(\n    id: string,\n    body: UpdateFilePayload,\n    headers?: Record<string, string>,\n  ): Promise<File> {\n    return super.updateById(id, body, headers)\n  }\n\n  /**\n   * Deletes a file. Resolves `{ success: true }`, also for an unknown id; a file of another\n   * account answers 403.\n   */\n  override deleteById(id: string, headers?: Record<string, string>): Promise<DeleteFileResult> {\n    return super.deleteById(id, headers)\n  }\n\n  /**\n   * Creates the record of a file and returns the signed URL to upload its content: send the\n   * content with {@link upload}. An audio that must be converted (a voice message for the\n   * connection) is sent in `base64` instead, and then no `urlToUpload` is returned. `name` and\n   * `mimetype` are required (500 without them; an audio without `name` is named `recording`). With\n   * `serviceId`, an extension the account blocks for the type of the connection answers 403.\n   */\n  createToUpload(\n    body: CreateToUploadPayload,\n    headers?: Record<string, string>,\n  ): Promise<CreateToUploadResult> {\n    return this.client.post<CreateToUploadResult, CreateToUploadPayload>(\n      `${this.basePath}/create-to-upload`,\n      body,\n      headers,\n    )\n  }\n\n  /**\n   * Copies the content of a file. With `urlToUpload` (the signed URL of a record created by\n   * {@link createToUpload} with the same `mimetype` as the file copied), the content is sent to that\n   * record and the answer is the `fileId` given; without it, a new record (`attachedType`\n   * `'message.file'`) is created with the copied content and its id is the answer, and with\n   * `serviceId` an extension the account blocks for the type of the connection answers 403. An\n   * unknown `fileId` answers 500.\n   */\n  duplicateFile(body: DuplicateFilePayload, headers?: Record<string, string>): Promise<string> {\n    return this.client.post<string, DuplicateFilePayload>(\n      `${this.basePath}/duplicate-file`,\n      body,\n      headers,\n    )\n  }\n\n  /**\n   * Uploads the content of a file to the `urlToUpload` returned by {@link createToUpload}. The URL\n   * is signed by the storage, so the request goes straight to it, without the API token (the\n   * storage refuses an `Authorization` header). `mimetype` must be the one sent to\n   * `createToUpload`. Sent through `client.requestExternal` (the global `fetch` for a client\n   * without it). A non-2xx answer of the storage throws `ApiError`.\n   */\n  async upload(urlToUpload: string, content: BodyInit, mimetype: string): Promise<void> {\n    const headers = { 'Content-Type': mimetype }\n    await (this.client.requestExternal\n      ? this.client.requestExternal('PUT', urlToUpload, content, headers)\n      : requestExternal('PUT', urlToUpload, content, headers))\n  }\n}\n"],"mappings":";;;;;;;;;;AAoBA,IAAa,WAAb,cAA8B,YAM5B;CACA,YAAY,QAAmB;AAC7B,QAAM,QAAQ,SAAS;;CAkBzB,AAAS,QACP,OACA,SACmC;AACnC,SAAO,MAAM,QAAQ,OAAO,QAAQ;;;CAItC,AAAS,OAAO,OAAyB,SAAwD;AAC/F,SAAO,MAAM,OAAO,OAAO,QAAQ;;;CAIrC,AAAS,QACP,IACA,OACA,SACe;AACf,SAAO,MAAM,QAAQ,IAAI,OAAO,QAAQ;;;CAI1C,AAAS,WACP,IACA,MACA,SACe;AACf,SAAO,MAAM,WAAW,IAAI,MAAM,QAAQ;;;;;;CAO5C,AAAS,WAAW,IAAY,SAA6D;AAC3F,SAAO,MAAM,WAAW,IAAI,QAAQ;;;;;;;;;CAUtC,eACE,MACA,SAC+B;AAC/B,SAAO,KAAK,OAAO,KACjB,GAAG,KAAK,SAAS,oBACjB,MACA,QACD;;;;;;;;;;CAWH,cAAc,MAA4B,SAAmD;AAC3F,SAAO,KAAK,OAAO,KACjB,GAAG,KAAK,SAAS,kBACjB,MACA,QACD;;;;;;;;;CAUH,MAAM,OAAO,aAAqB,SAAmB,UAAiC;EACpF,MAAM,UAAU,EAAE,gBAAgB,UAAU;AAC5C,SAAO,KAAK,OAAO,kBACf,KAAK,OAAO,gBAAgB,OAAO,aAAa,SAAS,QAAQ,GACjE,gBAAgB,OAAO,aAAa,SAAS,QAAQ"}

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

@@ -60,7 +60,10 @@ export type CreateToUploadPayload = {
     mimetype: string;
     /** What the file is attached to, e.g. `'message.file'` (default), `'campaign.file'`, `'quickreply.file'`. */
     attachedType?: string;
-    /** Connection that will send the file (used to decide the audio conversion). */
+    /**
+     * Connection that will send the file: used to decide the audio conversion and to apply the
+     * extensions the account blocks for its type (403).
+     */
     serviceId?: string;
     /** Audio sent as a voice message (default `true`). */
     isPtt?: boolean;
@@ -77,6 +80,21 @@ export type CreateToUploadResult = {
     name: string;
     mimetype: string;
 };
+/** Body of `FilesApi.duplicateFile`. */
+export type DuplicateFilePayload = {
+    /** The file whose content is copied. */
+    fileId: string;
+    /**
+     * Signed URL of a record created by `FilesApi.createToUpload`, with the same `mimetype` as the file
+     * copied, to receive the content. Without it, a new record is created with the copied content.
+     */
+    urlToUpload?: string;
+    /**
+     * Connection that will send the new record (used only without `urlToUpload`): the extensions the
+     * account blocks for its type apply.
+     */
+    serviceId?: string;
+};
 /** Result of `FilesApi.deleteById`. */
 export type DeleteFileResult = {
     success: boolean;

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

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/apis/files/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,iBAAiB,GAAG;IAC9B,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,mEAAmE;IACnE,KAAK,CAAC,EAAE,MAAM,EAAE,CAAA;CACjB,CAAA;AAED,MAAM,MAAM,QAAQ,GAAG;IACrB,aAAa,CAAC,EAAE,iBAAiB,CAAA;CAClC,CAAA;AAED,MAAM,MAAM,WAAW,GACnB,IAAI,GACJ,QAAQ,GACR,IAAI,GACJ,gBAAgB,GAChB,QAAQ,GACR,iBAAiB,GACjB,WAAW,GACX,MAAM,CAAA;AAEV,MAAM,MAAM,IAAI,GAAG;IACjB,EAAE,EAAE,MAAM,CAAA;IACV,0CAA0C;IAC1C,GAAG,EAAE,MAAM,CAAA;IACX,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;IACnB,4DAA4D;IAC5D,cAAc,EAAE,MAAM,GAAG,IAAI,CAAA;IAC7B,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,QAAQ,EAAE,MAAM,CAAA;IAChB,SAAS,EAAE,MAAM,CAAA;IACjB,IAAI,EAAE,QAAQ,CAAA;IACd,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,sEAAsE;IACtE,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,sEAAsE;IACtE,EAAE,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAClB,sEAAsE;IACtE,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC1B,sEAAsE;IACtE,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC5B,sEAAsE;IACtE,OAAO,CAAC,EAAE,WAAW,CAAA;IACrB,sEAAsE;IACtE,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,sEAAsE;IACtE,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CAC1B,CAAA;AAED,MAAM,MAAM,iBAAiB,GAAG;IAC9B,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,QAAQ,EAAE,MAAM,CAAA;IAChB,SAAS,EAAE,MAAM,CAAA;IACjB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,IAAI,CAAC,EAAE,QAAQ,CAAA;CAChB,CAAA;AAED,MAAM,MAAM,iBAAiB,GAAG;IAC9B,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC1B,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CAC7B,CAAA;AAED,yCAAyC;AACzC,MAAM,MAAM,qBAAqB,GAAG;IAClC,gFAAgF;IAChF,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,QAAQ,EAAE,MAAM,CAAA;IAChB,6GAA6G;IAC7G,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,gFAAgF;IAChF,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,sDAAsD;IACtD,KAAK,CAAC,EAAE,OAAO,CAAA;IACf,sEAAsE;IACtE,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB,0EAA0E;IAC1E,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB,CAAA;AAED,2CAA2C;AAC3C,MAAM,MAAM,oBAAoB,GAAG;IACjC,kGAAkG;IAClG,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA;AAED,uCAAuC;AACvC,MAAM,MAAM,gBAAgB,GAAG;IAC7B,OAAO,EAAE,OAAO,CAAA;CACjB,CAAA"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/apis/files/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,iBAAiB,GAAG;IAC9B,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,mEAAmE;IACnE,KAAK,CAAC,EAAE,MAAM,EAAE,CAAA;CACjB,CAAA;AAED,MAAM,MAAM,QAAQ,GAAG;IACrB,aAAa,CAAC,EAAE,iBAAiB,CAAA;CAClC,CAAA;AAED,MAAM,MAAM,WAAW,GACnB,IAAI,GACJ,QAAQ,GACR,IAAI,GACJ,gBAAgB,GAChB,QAAQ,GACR,iBAAiB,GACjB,WAAW,GACX,MAAM,CAAA;AAEV,MAAM,MAAM,IAAI,GAAG;IACjB,EAAE,EAAE,MAAM,CAAA;IACV,0CAA0C;IAC1C,GAAG,EAAE,MAAM,CAAA;IACX,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;IACnB,4DAA4D;IAC5D,cAAc,EAAE,MAAM,GAAG,IAAI,CAAA;IAC7B,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,QAAQ,EAAE,MAAM,CAAA;IAChB,SAAS,EAAE,MAAM,CAAA;IACjB,IAAI,EAAE,QAAQ,CAAA;IACd,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,sEAAsE;IACtE,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,sEAAsE;IACtE,EAAE,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAClB,sEAAsE;IACtE,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC1B,sEAAsE;IACtE,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC5B,sEAAsE;IACtE,OAAO,CAAC,EAAE,WAAW,CAAA;IACrB,sEAAsE;IACtE,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,sEAAsE;IACtE,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CAC1B,CAAA;AAED,MAAM,MAAM,iBAAiB,GAAG;IAC9B,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,QAAQ,EAAE,MAAM,CAAA;IAChB,SAAS,EAAE,MAAM,CAAA;IACjB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,IAAI,CAAC,EAAE,QAAQ,CAAA;CAChB,CAAA;AAED,MAAM,MAAM,iBAAiB,GAAG;IAC9B,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC1B,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CAC7B,CAAA;AAED,yCAAyC;AACzC,MAAM,MAAM,qBAAqB,GAAG;IAClC,gFAAgF;IAChF,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,QAAQ,EAAE,MAAM,CAAA;IAChB,6GAA6G;IAC7G,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,sDAAsD;IACtD,KAAK,CAAC,EAAE,OAAO,CAAA;IACf,sEAAsE;IACtE,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB,0EAA0E;IAC1E,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB,CAAA;AAED,2CAA2C;AAC3C,MAAM,MAAM,oBAAoB,GAAG;IACjC,kGAAkG;IAClG,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA;AAED,wCAAwC;AACxC,MAAM,MAAM,oBAAoB,GAAG;IACjC,wCAAwC;IACxC,MAAM,EAAE,MAAM,CAAA;IACd;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB,CAAA;AAED,uCAAuC;AACvC,MAAM,MAAM,gBAAgB,GAAG;IAC7B,OAAO,EAAE,OAAO,CAAA;CACjB,CAAA"}

package/dist/core/BaseReadApi.cjs

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

package/dist/core/BaseReadApi.cjs.map

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

package/dist/core/BaseReadApi.d.ts

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

package/dist/core/BaseReadApi.mjs

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

package/dist/core/BaseReadApi.mjs.map

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ikatec/digisac-api-sdk",
-  "version": "4.14.0",
+  "version": "4.15.0",
   "type": "module",
   "main": "./dist/index.cjs",
   "module": "./dist/index.mjs",

package/src/apis/authHistory/AuthHistoryApi.test.ts

@@ -115,4 +115,20 @@ describe('AuthHistoryApi', () => {
       await expect(api.getById('missing')).rejects.toThrow('Not found')
     })
   })
+
+  describe('registerLogout', () => {
+    it('calls client.post with /auth-history and an empty body', async () => {
+      vi.mocked(client.post).mockResolvedValue(undefined)
+      const result = await api.registerLogout()
+      expect(client.post).toHaveBeenCalledWith('/auth-history', {}, undefined)
+      expect(result).toBeUndefined()
+    })
+
+    it('forwards custom headers', async () => {
+      vi.mocked(client.post).mockResolvedValue(undefined)
+      const headers = { 'X-Req': 'r-1' }
+      await api.registerLogout(headers)
+      expect(client.post).toHaveBeenCalledWith('/auth-history', {}, headers)
+    })
+  })
 })

package/src/apis/authHistory/AuthHistoryApi.ts

@@ -3,8 +3,8 @@ import { BaseReadApi } from '../../core/BaseReadApi'
 import type { AuthHistory } from './types'
 
 /**
- * Authentication events (auth, password_change, logout), read-only (guarded by
- * `authHistory.view`). Non-admin users can only see and access their own records.
+ * Authentication events (auth, password_change, logout, 2fa_disabled), read with
+ * `authHistory.view`. Non-admin users can only see and access their own records.
  *
  * Since 4.2 `getById` has the base signature `(id, query?, headers?)`: a call written as
  * `getById(id, headers)` with the headers in a variable still compiles, but the headers are sent
@@ -14,4 +14,12 @@ export class AuthHistoryApi extends BaseReadApi<AuthHistory> {
   constructor(client: ApiClient) {
     super(client, '/auth-history')
   }
+
+  /**
+   * Records the `logout` event of the current session, as the web app does before revoking its
+   * token (revoke the token apart: this call does not). Resolves with no body.
+   */
+  registerLogout(headers?: Record<string, string>): Promise<void> {
+    return this.client.post<void, Record<string, never>>(this.basePath, {}, headers)
+  }
 }

package/src/apis/authHistory/types.ts

@@ -1,7 +1,12 @@
 import type { Account } from '../accounts/types'
 import type { User } from '../users/types'
 
-export type AuthHistoryEvent = 'auth' | 'password_change' | 'logout'
+/**
+ * `auth`: a login (after the second factor, when active); `password_change`: by the user, by an
+ * admin or by the password reset; `logout`: recorded by `AuthHistoryApi.registerLogout`;
+ * `2fa_disabled`: the second factor turned off, by the user or by an admin.
+ */
+export type AuthHistoryEvent = 'auth' | 'password_change' | 'logout' | '2fa_disabled'
 
 export type AuthHistory = {
   id: string

package/src/apis/contacts/ContactsApi.test.ts

@@ -138,6 +138,19 @@ describe('ContactsApi', () => {
       await api.getById('cnt-1', undefined, headers)
       expect(client.get).toHaveBeenCalledWith('/contacts/cnt-1', headers)
     })
+
+    it('sends formatCustomFields and the include of the custom fields in the query', async () => {
+      vi.mocked(client.get).mockResolvedValue(contact)
+      const query = {
+        include: [{ model: 'customFieldValues' as const, include: ['customField' as const] }],
+        formatCustomFields: true,
+      }
+      await api.getById('cnt-1', query)
+      expect(client.get).toHaveBeenCalledWith(
+        `/contacts/cnt-1?query=${encodeURIComponent(JSON.stringify(query))}`,
+        undefined,
+      )
+    })
   })
 
   // ── create ───────────────────────────────────────────────────────

package/src/apis/contacts/ContactsApi.ts

@@ -7,6 +7,8 @@ import type {
   BulkTransferTicketsPayload,
   BulkTransferTicketsResult,
   Contact,
+  ContactGetByIdQuery,
+  ContactListQuery,
   ContactMediaPage,
   ContactMediaQuery,
   ContactsSelection,
@@ -24,11 +26,31 @@ import type {
   SummarizeTicketResult,
 } from './types'
 
-export class ContactsApi extends BaseCrudApi<Contact, CreateContactPayload, UpdateContactPayload> {
+export class ContactsApi extends BaseCrudApi<
+  Contact,
+  CreateContactPayload,
+  UpdateContactPayload,
+  ContactListQuery
+> {
   constructor(client: ApiClient) {
     super(client, '/contacts')
   }
 
+  /**
+   * Returns a contact by ID. When it does not exist the route answers 200 with an empty body, which
+   * resolves to `undefined`. With `formatCustomFields: true` (and the include
+   * `{ model: 'customFieldValues', include: ['customField'] }`), the custom fields come keyed by name
+   * in `customFields`.
+   * @permissions contacts.view
+   */
+  override getById(
+    id: string,
+    query?: ContactGetByIdQuery,
+    headers?: Record<string, string>,
+  ): Promise<Contact> {
+    return super.getById(id, query, headers)
+  }
+
   /**
    * Downloads the CSV template (`;`-separated header line, in the language of the user) for
    * importing contacts, with columns based on the service type. Answered with no Content-Type.

package/src/apis/contacts/types.ts

@@ -1,10 +1,11 @@
+import type { CustomField, CustomFieldType } from '../customFields/types'
 import type { Department } from '../departments/types'
 import type { Person } from '../people/types'
 import type { Service } from '../services/types'
 import type { Tag } from '../tags/types'
 import type { Ticket } from '../tickets/types'
 import type { User } from '../users/types'
-import type { IncludeItem, ListQuery, WhereClause } from '../../core/types'
+import type { GetByIdQuery, IncludeItem, ListQuery, WhereClause } from '../../core/types'
 
 export type ContactStatus = 'online' | 'offline' | 'absent'
 export type ContactOrigin = 'api' | 'app' | 'campaign' | 'driver' | 'import' | 'web'
@@ -95,6 +96,56 @@ export type ContactDataBlock = {
   description: string
 }
 
+/**
+ * A value of a custom field of the contact, as `include: ['customFieldValues']` answers it (the
+ * stored row).
+ */
+export type CustomFieldValue = {
+  id: string
+  customFieldId: string
+  /** The contact. */
+  relatedId: string
+  relatedType: string | null
+  /**
+   * The value as stored: text, or JSON text for the composite types (`date-range`, `hour-range`,
+   * `numeric`, `monetary`, `phone`, `postal-code`).
+   */
+  value: string
+  createdAt: string
+  updatedAt: string
+  deletedAt: string | null
+  // relationships
+  customField?: CustomField
+}
+
+/**
+ * A custom field of the contact as `formatCustomFields: true` answers it, keyed by the name of the
+ * field in `Contact.customFields`.
+ */
+export type FormattedCustomField = {
+  name: string
+  /** The value, parsed from JSON for the composite types. */
+  value: unknown
+  /** Id of the value. */
+  id: string
+  type: CustomFieldType
+  /** Id of the field. */
+  fieldId: string
+  /** When the field was created. */
+  createdAt: string
+}
+
+/** A custom field value sent in the create or update of a contact. */
+export type ContactCustomFieldInput = {
+  /**
+   * Id of the custom field (`CustomField.id`, `FormattedCustomField.fieldId` or
+   * `CustomFieldValue.customFieldId`), not the id of the value.
+   */
+  id: string
+  /** Text, or an object for the composite types (stored as JSON). */
+  value: unknown
+}
+
 export type Contact = {
   id: string
   idFromService: string | null
@@ -139,6 +190,13 @@ export type Contact = {
   person?: Person | null
   tags?: Tag[]
   currentTicket?: Ticket | null
+  /** With `include: ['customFieldValues']`, unless `formatCustomFields` is set. */
+  customFieldValues?: CustomFieldValue[]
+  /**
+   * With `formatCustomFields: true` and the include
+   * `{ model: 'customFieldValues', include: ['customField'] }`: the values keyed by the field name.
+   */
+  customFields?: Record<string, FormattedCustomField>
 }
 
 export type ContactRelationships =
@@ -148,6 +206,23 @@ export type ContactRelationships =
   | 'person'
   | 'tags'
   | 'currentTicket'
+  | 'customFieldValues'
+  | 'customFields'
+
+type FormatCustomFieldsOption = {
+  /**
+   * Answers `customFields` keyed by the field name instead of the raw `customFieldValues` (with the
+   * include `{ model: 'customFieldValues', include: ['customField'] }`; without the nested
+   * `customField`, `customFields` comes empty).
+   */
+  formatCustomFields?: boolean
+}
+
+/** Query of `ContactsApi.getById`. */
+export type ContactGetByIdQuery = GetByIdQuery<Contact> & FormatCustomFieldsOption
+
+/** Query of `ContactsApi.getMany` and `getOne`. */
+export type ContactListQuery = ListQuery<Contact> & FormatCustomFieldsOption
 
 export type CreateContactPayload = {
   name?: string
@@ -160,6 +235,8 @@ export type CreateContactPayload = {
   data?: ContactData
   note?: string
   origin?: ContactOrigin
+  /** Values of the custom fields of the account. An id that is not a custom field answers 400. */
+  customFields?: ContactCustomFieldInput[]
 }
 
 export type UpdateContactPayload = {
@@ -174,6 +251,11 @@ export type UpdateContactPayload = {
   block?: boolean
   /** Tag IDs to associate with the contact. */
   tagIds?: string[]
+  /**
+   * Values of the custom fields of the account: a value of the same field is updated. An id that is
+   * not a custom field is skipped.
+   */
+  customFields?: ContactCustomFieldInput[]
 }
 
 /** Result of `ContactsApi.summarizeTicket`. */

package/src/apis/files/FilesApi.test.ts

@@ -97,6 +97,27 @@ describe('FilesApi', () => {
     })
   })
 
+  describe('duplicateFile', () => {
+    it('calls client.post with /files/duplicate-file and resolves the id of the copy', async () => {
+      vi.mocked(client.post).mockResolvedValue('file-2')
+      const result = await api.duplicateFile({ fileId: 'file-1' })
+      expect(client.post).toHaveBeenCalledWith(
+        '/files/duplicate-file',
+        { fileId: 'file-1' },
+        undefined,
+      )
+      expect(result).toBe('file-2')
+    })
+
+    it('sends urlToUpload and serviceId in the body and forwards custom headers', async () => {
+      vi.mocked(client.post).mockResolvedValue('file-1')
+      const headers = { 'X-Req': 'r-1' }
+      const body = { fileId: 'file-1', urlToUpload: URL_TO_UPLOAD, serviceId: 'svc-1' }
+      await api.duplicateFile(body, headers)
+      expect(client.post).toHaveBeenCalledWith('/files/duplicate-file', body, headers)
+    })
+  })
+
   describe('deleteById', () => {
     it('calls client.delete with /files/:id and resolves { success }', async () => {
       vi.mocked(client.delete).mockResolvedValue({ success: true })

package/src/apis/files/FilesApi.ts

@@ -9,6 +9,7 @@ import type {
   CreateToUploadPayload,
   CreateToUploadResult,
   DeleteFileResult,
+  DuplicateFilePayload,
 } from './types'
 
 /**
@@ -85,7 +86,8 @@ export class FilesApi extends BaseCrudApi<
    * Creates the record of a file and returns the signed URL to upload its content: send the
    * content with {@link upload}. An audio that must be converted (a voice message for the
    * connection) is sent in `base64` instead, and then no `urlToUpload` is returned. `name` and
-   * `mimetype` are required (500 without them; an audio without `name` is named `recording`).
+   * `mimetype` are required (500 without them; an audio without `name` is named `recording`). With
+   * `serviceId`, an extension the account blocks for the type of the connection answers 403.
    */
   createToUpload(
     body: CreateToUploadPayload,
@@ -98,6 +100,22 @@ export class FilesApi extends BaseCrudApi<
     )
   }
 
+  /**
+   * Copies the content of a file. With `urlToUpload` (the signed URL of a record created by
+   * {@link createToUpload} with the same `mimetype` as the file copied), the content is sent to that
+   * record and the answer is the `fileId` given; without it, a new record (`attachedType`
+   * `'message.file'`) is created with the copied content and its id is the answer, and with
+   * `serviceId` an extension the account blocks for the type of the connection answers 403. An
+   * unknown `fileId` answers 500.
+   */
+  duplicateFile(body: DuplicateFilePayload, headers?: Record<string, string>): Promise<string> {
+    return this.client.post<string, DuplicateFilePayload>(
+      `${this.basePath}/duplicate-file`,
+      body,
+      headers,
+    )
+  }
+
   /**
    * Uploads the content of a file to the `urlToUpload` returned by {@link createToUpload}. The URL
    * is signed by the storage, so the request goes straight to it, without the API token (the

package/src/apis/files/types.ts

@@ -74,7 +74,10 @@ export type CreateToUploadPayload = {
   mimetype: string
   /** What the file is attached to, e.g. `'message.file'` (default), `'campaign.file'`, `'quickreply.file'`. */
   attachedType?: string
-  /** Connection that will send the file (used to decide the audio conversion). */
+  /**
+   * Connection that will send the file: used to decide the audio conversion and to apply the
+   * extensions the account blocks for its type (403).
+   */
   serviceId?: string
   /** Audio sent as a voice message (default `true`). */
   isPtt?: boolean
@@ -93,6 +96,22 @@ export type CreateToUploadResult = {
   mimetype: string
 }
 
+/** Body of `FilesApi.duplicateFile`. */
+export type DuplicateFilePayload = {
+  /** The file whose content is copied. */
+  fileId: string
+  /**
+   * Signed URL of a record created by `FilesApi.createToUpload`, with the same `mimetype` as the file
+   * copied, to receive the content. Without it, a new record is created with the copied content.
+   */
+  urlToUpload?: string
+  /**
+   * Connection that will send the new record (used only without `urlToUpload`): the extensions the
+   * account blocks for its type apply.
+   */
+  serviceId?: string
+}
+
 /** Result of `FilesApi.deleteById`. */
 export type DeleteFileResult = {
   success: boolean

package/src/apis/payloads.test-d.ts

@@ -54,7 +54,14 @@ import { AcceptanceTermsApi } from './acceptanceTerms/AcceptanceTermsApi'
 import { CategoriesApi } from './categories/CategoriesApi'
 import { ContactBlockListsApi } from './contactBlockLists/ContactBlockListsApi'
 import { ContactBlockListsControlsApi } from './contactBlockListsControls/ContactBlockListsControlsApi'
-import type { SummarizeTicketResult } from './contacts/types'
+import type {
+  Contact,
+  CustomFieldValue,
+  FormattedCustomField,
+  SummarizeTicketResult,
+} from './contacts/types'
+import { AuthHistoryApi } from './authHistory/AuthHistoryApi'
+import type { AuthHistoryEvent } from './authHistory/types'
 import { CustomFieldsApi } from './customFields/CustomFieldsApi'
 import { DepartmentsApi } from './departments/DepartmentsApi'
 import type { Department } from './departments/types'
@@ -769,3 +776,34 @@ expectAssignable<Awaited<ReturnType<ServicesApi['accessManagement']>>>({
 })
 expectNotAssignable<Awaited<ReturnType<ServicesApi['accessManagement']>>>({ message: 'denied' })
 expectError(new ServicesApi(client).accessManagement('s-1', { userIds: ['u-1'] }))
+
+// ── QARC-1015 (4.15.0): custom fields of the contact, file copy, logout event ─────
+
+expectAssignable<Parameters<ContactsApi['create']>[0]>({
+  serviceId: 's-1',
+  customFields: [
+    { id: 'f-1', value: 'text' },
+    { id: 'f-2', value: { value: '10,50', identifier: 'BRL', min: '', max: '' } },
+  ],
+})
+expectAssignable<Parameters<ContactsApi['updateById']>[1]>({
+  customFields: [{ id: 'f-1', value: 'new' }],
+})
+expectError(
+  new ContactsApi(client).create({ serviceId: 's-1', customFields: [{ value: 'no id' }] }),
+)
+expectAssignable<Parameters<ContactsApi['getById']>[1]>({
+  include: [{ model: 'customFieldValues', include: ['customField'] }],
+  formatCustomFields: true,
+})
+declare const contactWithFields: Contact
+expectType<CustomFieldValue[] | undefined>(contactWithFields.customFieldValues)
+expectType<Record<string, FormattedCustomField> | undefined>(contactWithFields.customFields)
+expectAssignable<Parameters<ContactsApi['getMany']>[0]>({
+  include: [{ model: 'customFieldValues', include: ['customField'] }],
+  formatCustomFields: true,
+})
+expectType<Promise<string>>(new FilesApi(client).duplicateFile({ fileId: 'file-1' }))
+expectError(new FilesApi(client).duplicateFile({ urlToUpload: 'https://storage' }))
+expectType<Promise<void>>(new AuthHistoryApi(client).registerLogout())
+expectAssignable<AuthHistoryEvent>('2fa_disabled')

package/src/core/BaseReadApi.ts

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