@ikatec/digisac-api-sdk 4.10.0 → 4.12.0

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

@@ -5,7 +5,8 @@ export type WhatsappBusinessTemplateComponentType = 'HEADER' | 'BODY' | 'FOOTER'
 export type WhatsappBusinessTemplateHeaderFormat = 'TEXT' | 'IMAGE' | 'VIDEO' | 'DOCUMENT';
 export type WhatsappBusinessTemplateButton = {
     type: string;
-    text: string;
+    /** Overwritten by the backend on `REQUEST_CONTACT_INFO` buttons. */
+    text?: string;
     url?: string;
     params?: string[];
     phone_number?: string;
@@ -37,17 +38,49 @@ export type WhatsappBusinessTemplate = {
     createdAt: string;
     updatedAt: string;
     deletedAt: string | null;
+    /** Only the listing includes it by default; `getById` answers it with `include: ['fileExample']`. */
+    fileExample?: WhatsappBusinessTemplateFileExample | null;
+    service?: Record<string, unknown>;
+    account?: Record<string, unknown>;
+};
+/** The media example of a template with a media header. */
+export type WhatsappBusinessTemplateFileExample = Record<string, unknown>;
+/** The media example sent on create/update (`base64Url` as a data URL). */
+export type WhatsappBusinessTemplateFileExampleInput = {
+    fileName: string;
+    base64Url: string;
+    mimetype: string;
+};
+export type WhatsappBusinessTemplateHsmLimit = {
+    hsmLimit: number;
+    hsmUsedLimit: number;
+    /** The balance left (a number), or `true` when the account has no limit. */
+    hasLimit: number | boolean;
 };
+/**
+ * Stored locally (nothing goes to Meta until `sendToReview`). `status` is `''` for a draft and `namespace` is `''`
+ * until Meta answers — both are required by the database (500 without them).
+ */
 export type CreateWhatsappBusinessTemplatePayload = {
     name: string;
     internalName: string;
+    status: string;
+    namespace: string;
+    fileExample?: WhatsappBusinessTemplateFileExampleInput;
     components: WhatsappBusinessTemplateComponent[];
     serviceId: string;
     messageType: WhatsappBusinessTemplateMessageType;
     language: WhatsappBusinessTemplateLanguage;
     category: WhatsappBusinessTemplateCategory;
 };
+/**
+ * The backend validates the same 7 fields of the create on the update (`name`, `internalName`, `components`,
+ * `serviceId`, `messageType`, `language`, `category`), but ignores `name`.
+ */
 export type UpdateWhatsappBusinessTemplatePayload = {
+    status?: string;
+    namespace?: string;
+    fileExample?: WhatsappBusinessTemplateFileExampleInput;
     name?: string;
     internalName?: string;
     components?: WhatsappBusinessTemplateComponent[];

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

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/apis/whatsappBusinessTemplates/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,mCAAmC,GAAG,WAAW,GAAG,aAAa,CAAA;AAE7E,MAAM,MAAM,gCAAgC,GAAG,OAAO,GAAG,IAAI,GAAG,IAAI,CAAA;AAEpE,MAAM,MAAM,gCAAgC,GAAG,gBAAgB,GAAG,WAAW,GAAG,SAAS,CAAA;AAEzF,MAAM,MAAM,qCAAqC,GAAG,QAAQ,GAAG,MAAM,GAAG,QAAQ,GAAG,SAAS,CAAA;AAE5F,MAAM,MAAM,oCAAoC,GAAG,MAAM,GAAG,OAAO,GAAG,OAAO,GAAG,UAAU,CAAA;AAE1F,MAAM,MAAM,8BAA8B,GAAG;IAC3C,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;IACZ,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;IACjB,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB,CAAA;AAED,MAAM,MAAM,iCAAiC,GAAG;IAC9C,IAAI,EAAE,qCAAqC,CAAA;IAC3C,MAAM,CAAC,EAAE,oCAAoC,CAAA;IAC7C,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;IACjB,OAAO,CAAC,EAAE,8BAA8B,EAAE,CAAA;IAC1C,uBAAuB,CAAC,EAAE,MAAM,CAAA;CACjC,CAAA;AAED,MAAM,MAAM,wBAAwB,GAAG;IACrC,EAAE,EAAE,MAAM,CAAA;IACV,YAAY,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B,QAAQ,EAAE,MAAM,CAAA;IAChB,UAAU,EAAE,iCAAiC,EAAE,CAAA;IAC/C,QAAQ,EAAE,MAAM,CAAA;IAChB,IAAI,EAAE,MAAM,CAAA;IACZ,SAAS,EAAE,MAAM,CAAA;IACjB,cAAc,EAAE,MAAM,GAAG,IAAI,CAAA;IAC7B,MAAM,EAAE,MAAM,CAAA;IACd,WAAW,EAAE,MAAM,CAAA;IACnB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAA;IACtB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;CACzB,CAAA;AAED,MAAM,MAAM,qCAAqC,GAAG;IAClD,IAAI,EAAE,MAAM,CAAA;IACZ,YAAY,EAAE,MAAM,CAAA;IACpB,UAAU,EAAE,iCAAiC,EAAE,CAAA;IAC/C,SAAS,EAAE,MAAM,CAAA;IACjB,WAAW,EAAE,mCAAmC,CAAA;IAChD,QAAQ,EAAE,gCAAgC,CAAA;IAC1C,QAAQ,EAAE,gCAAgC,CAAA;CAC3C,CAAA;AAED,MAAM,MAAM,qCAAqC,GAAG;IAClD,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,UAAU,CAAC,EAAE,iCAAiC,EAAE,CAAA;IAChD,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,WAAW,CAAC,EAAE,mCAAmC,CAAA;IACjD,QAAQ,CAAC,EAAE,gCAAgC,CAAA;IAC3C,QAAQ,CAAC,EAAE,gCAAgC,CAAA;CAC5C,CAAA"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/apis/whatsappBusinessTemplates/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,mCAAmC,GAAG,WAAW,GAAG,aAAa,CAAA;AAE7E,MAAM,MAAM,gCAAgC,GAAG,OAAO,GAAG,IAAI,GAAG,IAAI,CAAA;AAEpE,MAAM,MAAM,gCAAgC,GAAG,gBAAgB,GAAG,WAAW,GAAG,SAAS,CAAA;AAEzF,MAAM,MAAM,qCAAqC,GAAG,QAAQ,GAAG,MAAM,GAAG,QAAQ,GAAG,SAAS,CAAA;AAE5F,MAAM,MAAM,oCAAoC,GAAG,MAAM,GAAG,OAAO,GAAG,OAAO,GAAG,UAAU,CAAA;AAE1F,MAAM,MAAM,8BAA8B,GAAG;IAC3C,IAAI,EAAE,MAAM,CAAA;IACZ,oEAAoE;IACpE,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;IACjB,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB,CAAA;AAED,MAAM,MAAM,iCAAiC,GAAG;IAC9C,IAAI,EAAE,qCAAqC,CAAA;IAC3C,MAAM,CAAC,EAAE,oCAAoC,CAAA;IAC7C,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;IACjB,OAAO,CAAC,EAAE,8BAA8B,EAAE,CAAA;IAC1C,uBAAuB,CAAC,EAAE,MAAM,CAAA;CACjC,CAAA;AAED,MAAM,MAAM,wBAAwB,GAAG;IACrC,EAAE,EAAE,MAAM,CAAA;IACV,YAAY,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B,QAAQ,EAAE,MAAM,CAAA;IAChB,UAAU,EAAE,iCAAiC,EAAE,CAAA;IAC/C,QAAQ,EAAE,MAAM,CAAA;IAChB,IAAI,EAAE,MAAM,CAAA;IACZ,SAAS,EAAE,MAAM,CAAA;IACjB,cAAc,EAAE,MAAM,GAAG,IAAI,CAAA;IAC7B,MAAM,EAAE,MAAM,CAAA;IACd,WAAW,EAAE,MAAM,CAAA;IACnB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAA;IACtB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB,qGAAqG;IACrG,WAAW,CAAC,EAAE,mCAAmC,GAAG,IAAI,CAAA;IAExD,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACjC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAClC,CAAA;AAED,2DAA2D;AAC3D,MAAM,MAAM,mCAAmC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;AAEzE,2EAA2E;AAC3E,MAAM,MAAM,wCAAwC,GAAG;IACrD,QAAQ,EAAE,MAAM,CAAA;IAChB,SAAS,EAAE,MAAM,CAAA;IACjB,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA;AAED,MAAM,MAAM,gCAAgC,GAAG;IAC7C,QAAQ,EAAE,MAAM,CAAA;IAChB,YAAY,EAAE,MAAM,CAAA;IACpB,4EAA4E;IAC5E,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAA;CAC3B,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,qCAAqC,GAAG;IAClD,IAAI,EAAE,MAAM,CAAA;IACZ,YAAY,EAAE,MAAM,CAAA;IACpB,MAAM,EAAE,MAAM,CAAA;IACd,SAAS,EAAE,MAAM,CAAA;IACjB,WAAW,CAAC,EAAE,wCAAwC,CAAA;IACtD,UAAU,EAAE,iCAAiC,EAAE,CAAA;IAC/C,SAAS,EAAE,MAAM,CAAA;IACjB,WAAW,EAAE,mCAAmC,CAAA;IAChD,QAAQ,EAAE,gCAAgC,CAAA;IAC1C,QAAQ,EAAE,gCAAgC,CAAA;CAC3C,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,qCAAqC,GAAG;IAClD,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,WAAW,CAAC,EAAE,wCAAwC,CAAA;IACtD,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,UAAU,CAAC,EAAE,iCAAiC,EAAE,CAAA;IAChD,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,WAAW,CAAC,EAAE,mCAAmC,CAAA;IACjD,QAAQ,CAAC,EAAE,gCAAgC,CAAA;IAC3C,QAAQ,CAAC,EAAE,gCAAgC,CAAA;CAC5C,CAAA"}

package/dist/core/BaseCrudApi.cjs

@@ -4,7 +4,9 @@ const require_core_BaseReadApi = require('./BaseReadApi.cjs');
 //#region src/core/BaseCrudApi.ts
 /**
 * Generic CRUD resource: the reads of `BaseReadApi` plus `create`, `updateById` and `deleteById`.
-* `TDeleteResponse` is what `deleteById` resolves to (most routes answer the text `'OK'`).
+* `TDeleteResponse` is what `deleteById` resolves to (most routes answer the text `'OK'`);
+* `TCreateResponse` and `TUpdateResponse` are what `create` and `updateById` resolve to, for the routes
+* that do not answer the resource (an empty body, `{}`, another model).
 */
 var BaseCrudApi = class extends require_core_BaseReadApi.BaseReadApi {
 	/**

package/dist/core/BaseCrudApi.cjs.map

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

package/dist/core/BaseCrudApi.d.ts

@@ -3,19 +3,21 @@ import type { CrudApi, ListQuery } from './types';
 export type { WhereClause, IncludeItem, ListQuery, GetByIdQuery, Paginated, HasGetMany, HasGetById, HasCreate, HasUpdateById, HasDeleteById, CrudApi, } from './types';
 /**
  * Generic CRUD resource: the reads of `BaseReadApi` plus `create`, `updateById` and `deleteById`.
- * `TDeleteResponse` is what `deleteById` resolves to (most routes answer the text `'OK'`).
+ * `TDeleteResponse` is what `deleteById` resolves to (most routes answer the text `'OK'`);
+ * `TCreateResponse` and `TUpdateResponse` are what `create` and `updateById` resolve to, for the routes
+ * that do not answer the resource (an empty body, `{}`, another model).
  */
-export declare class BaseCrudApi<TResponse, TCreate, TUpdate = TCreate, TQuery extends ListQuery<TResponse> = ListQuery<TResponse>, TDeleteResponse = TResponse> extends BaseReadApi<TResponse, TQuery> implements CrudApi<TResponse, TCreate, TUpdate, TQuery, TDeleteResponse> {
+export declare class BaseCrudApi<TResponse, TCreate, TUpdate = TCreate, TQuery extends ListQuery<TResponse> = ListQuery<TResponse>, TDeleteResponse = TResponse, TCreateResponse = TResponse, TUpdateResponse = TResponse> extends BaseReadApi<TResponse, TQuery> implements CrudApi<TResponse, TCreate, TUpdate, TQuery, TDeleteResponse, TCreateResponse, TUpdateResponse> {
     /**
      * Creates a new resource.
      * @permissions $resourceName.create
      */
-    create(body: TCreate, headers?: Record<string, string>): Promise<TResponse>;
+    create(body: TCreate, headers?: Record<string, string>): Promise<TCreateResponse>;
     /**
      * Updates an existing resource by ID.
      * @permissions $resourceName.update
      */
-    updateById(id: string, body: TUpdate, headers?: Record<string, string>): Promise<TResponse>;
+    updateById(id: string, body: TUpdate, headers?: Record<string, string>): Promise<TUpdateResponse>;
     /**
      * Deletes a resource by ID.
      * @permissions $resourceName.destroy

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

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

package/dist/core/BaseCrudApi.mjs

@@ -3,7 +3,9 @@ import { BaseReadApi } from "./BaseReadApi.mjs";
 //#region src/core/BaseCrudApi.ts
 /**
 * Generic CRUD resource: the reads of `BaseReadApi` plus `create`, `updateById` and `deleteById`.
-* `TDeleteResponse` is what `deleteById` resolves to (most routes answer the text `'OK'`).
+* `TDeleteResponse` is what `deleteById` resolves to (most routes answer the text `'OK'`);
+* `TCreateResponse` and `TUpdateResponse` are what `create` and `updateById` resolve to, for the routes
+* that do not answer the resource (an empty body, `{}`, another model).
 */
 var BaseCrudApi = class extends BaseReadApi {
 	/**

package/dist/core/BaseCrudApi.mjs.map

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

package/dist/core/types.d.ts

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

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

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/core/types.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,SAAS,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,CAAA;AAIxD,KAAK,mBAAmB,CAAC,CAAC,GAAG,SAAS,IAAI;IACxC,GAAG,CAAC,EAAE,CAAC,CAAA;IACP,GAAG,CAAC,EAAE,CAAC,CAAA;IACP,GAAG,CAAC,EAAE,CAAC,CAAA;IACP,IAAI,CAAC,EAAE,CAAC,CAAA;IACR,GAAG,CAAC,EAAE,CAAC,CAAA;IACP,IAAI,CAAC,EAAE,CAAC,CAAA;IACR,GAAG,CAAC,EAAE,IAAI,GAAG,OAAO,CAAA;IACpB,IAAI,CAAC,EAAE,CAAC,CAAA;CACT,CAAA;AAED,KAAK,eAAe,GAAG;IACrB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB,CAAA;AAED,KAAK,cAAc,CAAC,CAAC,GAAG,SAAS,IAAI;IACnC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAA;IACT,MAAM,CAAC,EAAE,CAAC,EAAE,CAAA;IACZ,QAAQ,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;IACjB,WAAW,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;IACpB,SAAS,CAAC,EAAE,CAAC,EAAE,CAAA;IACf,UAAU,CAAC,EAAE,CAAC,EAAE,CAAA;IAChB,QAAQ,CAAC,EAAE,CAAC,EAAE,CAAA;IACd,IAAI,CAAC,EAAE,CAAC,EAAE,CAAA;IACV,IAAI,CAAC,EAAE,CAAC,EAAE,CAAA;CACX,CAAA;AAED,KAAK,cAAc,CAAC,CAAC,GAAG,SAAS,IAAI,mBAAmB,CAAC,CAAC,CAAC,GAAG,eAAe,GAAG,cAAc,CAAC,CAAC,CAAC,CAAA;AAEjG,KAAK,UAAU,CAAC,CAAC,IAAI,CAAC,GAAG,cAAc,CAAC,CAAC,CAAC,CAAA;AAE1C,KAAK,WAAW,CAAC,CAAC,IAAI;KACnB,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CAClC,CAAA;AAED,KAAK,gBAAgB,CAAC,CAAC,IAAI;IACzB,IAAI,CAAC,EAAE,WAAW,CAAC,CAAC,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,EAAE,CAAA;IACxC,GAAG,CAAC,EAAE,WAAW,CAAC,CAAC,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,EAAE,CAAA;CACxC,CAAA;AAED,MAAM,MAAM,WAAW,CAAC,CAAC,IAAI,WAAW,CAAC,CAAC,CAAC,GAAG,gBAAgB,CAAC,CAAC,CAAC,CAAA;AAIjE,wEAAwE;AACxE,KAAK,MAAM,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,EAAE,GAAG,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,CAAA;AAE3D,sFAAsF;AACtF,KAAK,eAAe,CAAC,CAAC,IAAI;KACvB,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,SAAS,GAAG,IAAI,GACnD,KAAK,GACL,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,MAAM,GACzB,CAAC,GAAG,MAAM,GACV,KAAK;CACZ,CAAC,MAAM,CAAC,CAAC,CAAA;AAIV,0GAA0G;AAC1G,KAAK,kBAAkB,CAAC,CAAC,IAAI;KAC1B,CAAC,IAAI,eAAe,CAAC,CAAC,CAAC,GAAG;QACzB,KAAK,EAAE,CAAC,CAAA;QACR,EAAE,CAAC,EAAE,MAAM,CAAA;QACX,UAAU,CAAC,EAAE,CAAC,MAAM,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,EAAE,CAAA;QAC5C,OAAO,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAA;QACrC,QAAQ,CAAC,EAAE,OAAO,CAAA;QAClB,KAAK,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;KAClC;CACF,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAAA;AAErB,MAAM,MAAM,WAAW,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,eAAe,CAAC,CAAC,CAAC,GAAG,kBAAkB,CAAC,CAAC,CAAC,CAAA;AAIjG,MAAM,MAAM,SAAS,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI;IACnD,KAAK,CAAC,EAAE,WAAW,CAAC,CAAC,CAAC,CAAA;IACtB,OAAO,CAAC,EAAE,WAAW,CAAC,CAAC,CAAC,EAAE,CAAA;IAC1B,UAAU,CAAC,EAAE,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC,EAAE,CAAA;IACjC,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC,EAAE,CAAA;IAC7B,KAAK,CAAC,EAAE,CAAC,MAAM,CAAC,GAAG,MAAM,EAAE,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,MAAM,CAAC,EAAE,CAAA;IAC7D,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACjC,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,QAAQ,CAAC,EAAE,OAAO,CAAA;CACnB,CAAA;AAGD,MAAM,MAAM,SAAS,CAAC,CAAC,IAAI;IACzB,IAAI,EAAE,CAAC,EAAE,CAAA;IACT,KAAK,EAAE,MAAM,CAAA;IACb,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,EAAE,MAAM,CAAA;IACnB,QAAQ,EAAE,MAAM,CAAA;IAChB,IAAI,EAAE,MAAM,CAAA;IACZ,EAAE,EAAE,MAAM,CAAA;CACX,CAAA;AAID,MAAM,WAAW,UAAU,CAAC,SAAS,EAAE,MAAM,SAAS,SAAS,CAAC,SAAS,CAAC,GAAG,SAAS,CAAC,SAAS,CAAC;IAC/F,OAAO,CACL,KAAK,EAAE,MAAM,GAAG;QAAE,QAAQ,EAAE,KAAK,CAAA;KAAE,EACnC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,SAAS,EAAE,CAAC,CAAA;IACvB,OAAO,CACL,KAAK,CAAC,EAAE,MAAM,GAAG;QAAE,QAAQ,CAAC,EAAE,IAAI,CAAA;KAAE,EACpC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,CAAA;IAChC,4EAA4E;IAC5E,OAAO,CACL,KAAK,CAAC,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,SAAS,CAAC,SAAS,CAAC,GAAG,SAAS,EAAE,CAAC,CAAA;CAC/C;AAED,MAAM,MAAM,YAAY,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,SAAS,GAAG,YAAY,CAAC,CAAA;AAEpG,MAAM,WAAW,UAAU,CAAC,SAAS;IACnC,OAAO,CACL,EAAE,EAAE,MAAM,EACV,KAAK,CAAC,EAAE,YAAY,CAAC,SAAS,CAAC,EAC/B,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,SAAS,CAAC,CAAA;CACtB;AAED,MAAM,WAAW,SAAS,CAAC,SAAS,EAAE,OAAO;IAC3C,MAAM,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,SAAS,CAAC,CAAA;CAC5E;AAED,MAAM,WAAW,aAAa,CAAC,SAAS,EAAE,OAAO;IAC/C,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,SAAS,CAAC,CAAA;CAC5F;AAED,MAAM,WAAW,aAAa,CAAC,SAAS;IACtC,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,SAAS,CAAC,CAAA;CAC7E;AAED,MAAM,MAAM,OAAO,CACjB,SAAS,EACT,OAAO,EACP,OAAO,GAAG,OAAO,EACjB,MAAM,SAAS,SAAS,CAAC,SAAS,CAAC,GAAG,SAAS,CAAC,SAAS,CAAC,EAC1D,eAAe,GAAG,SAAS,IACzB,UAAU,CAAC,SAAS,EAAE,MAAM,CAAC,GAC/B,UAAU,CAAC,SAAS,CAAC,GACrB,SAAS,CAAC,SAAS,EAAE,OAAO,CAAC,GAC7B,aAAa,CAAC,SAAS,EAAE,OAAO,CAAC,GACjC,aAAa,CAAC,eAAe,CAAC,CAAA"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/core/types.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,SAAS,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,CAAA;AAIxD,KAAK,mBAAmB,CAAC,CAAC,GAAG,SAAS,IAAI;IACxC,GAAG,CAAC,EAAE,CAAC,CAAA;IACP,GAAG,CAAC,EAAE,CAAC,CAAA;IACP,GAAG,CAAC,EAAE,CAAC,CAAA;IACP,IAAI,CAAC,EAAE,CAAC,CAAA;IACR,GAAG,CAAC,EAAE,CAAC,CAAA;IACP,IAAI,CAAC,EAAE,CAAC,CAAA;IACR,GAAG,CAAC,EAAE,IAAI,GAAG,OAAO,CAAA;IACpB,IAAI,CAAC,EAAE,CAAC,CAAA;CACT,CAAA;AAED,KAAK,eAAe,GAAG;IACrB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB,CAAA;AAED,KAAK,cAAc,CAAC,CAAC,GAAG,SAAS,IAAI;IACnC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAA;IACT,MAAM,CAAC,EAAE,CAAC,EAAE,CAAA;IACZ,QAAQ,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;IACjB,WAAW,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;IACpB,SAAS,CAAC,EAAE,CAAC,EAAE,CAAA;IACf,UAAU,CAAC,EAAE,CAAC,EAAE,CAAA;IAChB,QAAQ,CAAC,EAAE,CAAC,EAAE,CAAA;IACd,IAAI,CAAC,EAAE,CAAC,EAAE,CAAA;IACV,IAAI,CAAC,EAAE,CAAC,EAAE,CAAA;CACX,CAAA;AAED,KAAK,cAAc,CAAC,CAAC,GAAG,SAAS,IAAI,mBAAmB,CAAC,CAAC,CAAC,GAAG,eAAe,GAAG,cAAc,CAAC,CAAC,CAAC,CAAA;AAEjG,KAAK,UAAU,CAAC,CAAC,IAAI,CAAC,GAAG,cAAc,CAAC,CAAC,CAAC,CAAA;AAE1C,KAAK,WAAW,CAAC,CAAC,IAAI;KACnB,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CAClC,CAAA;AAED,KAAK,gBAAgB,CAAC,CAAC,IAAI;IACzB,IAAI,CAAC,EAAE,WAAW,CAAC,CAAC,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,EAAE,CAAA;IACxC,GAAG,CAAC,EAAE,WAAW,CAAC,CAAC,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,EAAE,CAAA;CACxC,CAAA;AAED,MAAM,MAAM,WAAW,CAAC,CAAC,IAAI,WAAW,CAAC,CAAC,CAAC,GAAG,gBAAgB,CAAC,CAAC,CAAC,CAAA;AAIjE,wEAAwE;AACxE,KAAK,MAAM,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,EAAE,GAAG,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,CAAA;AAE3D,sFAAsF;AACtF,KAAK,eAAe,CAAC,CAAC,IAAI;KACvB,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,SAAS,GAAG,IAAI,GACnD,KAAK,GACL,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,MAAM,GACzB,CAAC,GAAG,MAAM,GACV,KAAK;CACZ,CAAC,MAAM,CAAC,CAAC,CAAA;AAIV,0GAA0G;AAC1G,KAAK,kBAAkB,CAAC,CAAC,IAAI;KAC1B,CAAC,IAAI,eAAe,CAAC,CAAC,CAAC,GAAG;QACzB,KAAK,EAAE,CAAC,CAAA;QACR,EAAE,CAAC,EAAE,MAAM,CAAA;QACX,UAAU,CAAC,EAAE,CAAC,MAAM,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,EAAE,CAAA;QAC5C,OAAO,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAA;QACrC,QAAQ,CAAC,EAAE,OAAO,CAAA;QAClB,KAAK,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;KAClC;CACF,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAAA;AAErB,MAAM,MAAM,WAAW,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,eAAe,CAAC,CAAC,CAAC,GAAG,kBAAkB,CAAC,CAAC,CAAC,CAAA;AAIjG,MAAM,MAAM,SAAS,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI;IACnD,KAAK,CAAC,EAAE,WAAW,CAAC,CAAC,CAAC,CAAA;IACtB,OAAO,CAAC,EAAE,WAAW,CAAC,CAAC,CAAC,EAAE,CAAA;IAC1B,UAAU,CAAC,EAAE,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC,EAAE,CAAA;IACjC,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC,EAAE,CAAA;IAC7B,KAAK,CAAC,EAAE,CAAC,MAAM,CAAC,GAAG,MAAM,EAAE,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,MAAM,CAAC,EAAE,CAAA;IAC7D,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACjC,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,QAAQ,CAAC,EAAE,OAAO,CAAA;CACnB,CAAA;AAGD,MAAM,MAAM,SAAS,CAAC,CAAC,IAAI;IACzB,IAAI,EAAE,CAAC,EAAE,CAAA;IACT,KAAK,EAAE,MAAM,CAAA;IACb,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,EAAE,MAAM,CAAA;IACnB,QAAQ,EAAE,MAAM,CAAA;IAChB,IAAI,EAAE,MAAM,CAAA;IACZ,EAAE,EAAE,MAAM,CAAA;CACX,CAAA;AAID,MAAM,WAAW,UAAU,CAAC,SAAS,EAAE,MAAM,SAAS,SAAS,CAAC,SAAS,CAAC,GAAG,SAAS,CAAC,SAAS,CAAC;IAC/F,OAAO,CACL,KAAK,EAAE,MAAM,GAAG;QAAE,QAAQ,EAAE,KAAK,CAAA;KAAE,EACnC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,SAAS,EAAE,CAAC,CAAA;IACvB,OAAO,CACL,KAAK,CAAC,EAAE,MAAM,GAAG;QAAE,QAAQ,CAAC,EAAE,IAAI,CAAA;KAAE,EACpC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,CAAA;IAChC,4EAA4E;IAC5E,OAAO,CACL,KAAK,CAAC,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,SAAS,CAAC,SAAS,CAAC,GAAG,SAAS,EAAE,CAAC,CAAA;CAC/C;AAED,MAAM,MAAM,YAAY,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,SAAS,GAAG,YAAY,CAAC,CAAA;AAEpG,MAAM,WAAW,UAAU,CAAC,SAAS;IACnC,OAAO,CACL,EAAE,EAAE,MAAM,EACV,KAAK,CAAC,EAAE,YAAY,CAAC,SAAS,CAAC,EAC/B,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,SAAS,CAAC,CAAA;CACtB;AAED,MAAM,WAAW,SAAS,CAAC,SAAS,EAAE,OAAO;IAC3C,MAAM,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,SAAS,CAAC,CAAA;CAC5E;AAED,MAAM,WAAW,aAAa,CAAC,SAAS,EAAE,OAAO;IAC/C,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,SAAS,CAAC,CAAA;CAC5F;AAED,MAAM,WAAW,aAAa,CAAC,SAAS;IACtC,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,SAAS,CAAC,CAAA;CAC7E;AAED,MAAM,MAAM,OAAO,CACjB,SAAS,EACT,OAAO,EACP,OAAO,GAAG,OAAO,EACjB,MAAM,SAAS,SAAS,CAAC,SAAS,CAAC,GAAG,SAAS,CAAC,SAAS,CAAC,EAC1D,eAAe,GAAG,SAAS,EAC3B,eAAe,GAAG,SAAS,EAC3B,eAAe,GAAG,SAAS,IACzB,UAAU,CAAC,SAAS,EAAE,MAAM,CAAC,GAC/B,UAAU,CAAC,SAAS,CAAC,GACrB,SAAS,CAAC,eAAe,EAAE,OAAO,CAAC,GACnC,aAAa,CAAC,eAAe,EAAE,OAAO,CAAC,GACvC,aAAa,CAAC,eAAe,CAAC,CAAA"}

package/package.json

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

package/src/apis/categories/types.ts

@@ -11,6 +11,7 @@ export type CreateCategoryPayload = {
   title: string
 }
 
+/** The backend requires `title` on the update too (400 without it). */
 export type UpdateCategoryPayload = {
   title?: string
 }

package/src/apis/contactBlockLists/ContactBlockListsApi.test.ts

@@ -0,0 +1,57 @@
+import { beforeEach, describe, expect, it, vi } from 'vitest'
+import { ContactBlockListsApi } from './ContactBlockListsApi'
+import type { ApiClient } from '../../core/ApiClient'
+
+// ── Mock client factory ──────────────────────────────────────────────
+
+function createMockClient(): ApiClient {
+  return {
+    setAccessToken: vi.fn().mockReturnThis(),
+    request: vi.fn(),
+    get: vi.fn(),
+    post: vi.fn(),
+    put: vi.fn(),
+    patch: vi.fn(),
+    delete: vi.fn(),
+  }
+}
+
+// ── Tests ────────────────────────────────────────────────────────────
+
+describe('ContactBlockListsApi', () => {
+  let client: ReturnType<typeof createMockClient>
+  let api: ContactBlockListsApi
+
+  beforeEach(() => {
+    client = createMockClient()
+    api = new ContactBlockListsApi(client)
+  })
+
+  describe('count', () => {
+    it('calls client.get with /contact-block-lists/count when no query is provided', async () => {
+      vi.mocked(client.get).mockResolvedValue({ count: 3 })
+      await expect(api.count()).resolves.toEqual({ count: 3 })
+      expect(client.get).toHaveBeenCalledWith('/contact-block-lists/count', undefined)
+    })
+
+    it('serializes the query and forwards custom headers', async () => {
+      const headers = { 'X-Custom': 'value' }
+      vi.mocked(client.get).mockResolvedValue({ count: 1 })
+      await api.count({ where: { name: 'QA' } }, headers)
+      const [url, sent] = vi.mocked(client.get).mock.calls[0] ?? []
+      expect(url).toContain('/contact-block-lists/count?')
+      expect(url).toContain('where')
+      expect(sent).toBe(headers)
+    })
+  })
+
+  it('create posts the name and the file of the CSV', async () => {
+    vi.mocked(client.post).mockResolvedValue({ id: 'list-1', status: 'ready' })
+    await api.create({ name: 'QA', fileId: 'file-1', defaultDDI: '55' })
+    expect(client.post).toHaveBeenCalledWith(
+      '/contact-block-lists',
+      { name: 'QA', fileId: 'file-1', defaultDDI: '55' },
+      undefined,
+    )
+  })
+})

package/src/apis/contactBlockLists/ContactBlockListsApi.ts

@@ -7,6 +7,10 @@ import type {
   UpdateContactBlockListPayload,
 } from './types'
 
+/**
+ * Lists of numbers to block. A list is processed in the background after it is created (`status`
+ * `ready` → `done` or `error`). `getById` answers `null` for an unknown id.
+ */
 export class ContactBlockListsApi extends BaseCrudApi<
   ContactBlockList,
   CreateContactBlockListPayload,
@@ -18,6 +22,46 @@ export class ContactBlockListsApi extends BaseCrudApi<
     super(client, '/contact-block-lists')
   }
 
+  /**
+   * Counts the block lists matching the query.
+   * @permissions contacts.view OR contacts.block
+   */
+  count(
+    query?: ListQuery<ContactBlockList>,
+    headers?: Record<string, string>,
+  ): Promise<{ count: number }> {
+    return this.client.get<{ count: number }>(
+      `${this.basePath}/count${this.toQueryString(query)}`,
+      headers,
+    )
+  }
+
+  /**
+   * Creates a block list from a CSV uploaded with `FilesApi.createToUpload` (`attachedType:
+   * 'contact_block_list.file'` — with any other type the list is never processed). The CSV is
+   * comma-separated with the columns `ddi,number` (an empty DDI takes `defaultDDI`); invalid numbers are
+   * skipped. Resolves the list with `status: 'ready'`.
+   * @permissions contacts.view OR contacts.block
+   */
+  override create(
+    body: CreateContactBlockListPayload,
+    headers?: Record<string, string>,
+  ): Promise<ContactBlockList> {
+    return super.create(body, headers)
+  }
+
+  /**
+   * Updates a block list. `name` is required by the backend (400 without it). An unknown id answers 500.
+   * @permissions contacts.view OR contacts.update OR contacts.block
+   */
+  override updateById(
+    id: string,
+    body: UpdateContactBlockListPayload,
+    headers?: Record<string, string>,
+  ): Promise<ContactBlockList> {
+    return super.updateById(id, body, headers)
+  }
+
   /**
    * Deletes a block list and its numbers. Resolves the text `'OK'`; a list being processed (or with
    * a block/unblock in progress) answers 500.

package/src/apis/contactBlockLists/types.ts

@@ -1,3 +1,4 @@
+import type { File } from '../files/types'
 import type { User } from '../users/types'
 
 export type ContactBlockListStatus = 'ready' | 'processing' | 'done' | 'error'
@@ -17,9 +18,11 @@ export type ContactBlockList = {
   deletedAt: string | null
   // relationships
   user?: User
+  /** The uploaded CSV (`include: ['importFile']`). */
+  importFile?: File
 }
 
-export type ContactBlockListRelationships = 'user'
+export type ContactBlockListRelationships = 'user' | 'importFile'
 
 export type CreateContactBlockListPayload = {
   name: string
@@ -29,7 +32,9 @@ export type CreateContactBlockListPayload = {
 }
 
 export type UpdateContactBlockListPayload = {
+  /** Required by the backend (400 without it), even to change only `defaultDDI`. */
   name?: string
+  /** @deprecated Ignored by the backend: the numbers come only from the CSV of the create. */
   contacts?: string[]
   defaultDDI?: string | null
 }

package/src/apis/contactBlockListsControls/ContactBlockListsControlsApi.test.ts

@@ -0,0 +1,48 @@
+import { beforeEach, describe, expect, it, vi } from 'vitest'
+import { ContactBlockListsControlsApi } from './ContactBlockListsControlsApi'
+import type { ApiClient } from '../../core/ApiClient'
+
+// ── Mock client factory ──────────────────────────────────────────────
+
+function createMockClient(): ApiClient {
+  return {
+    setAccessToken: vi.fn().mockReturnThis(),
+    request: vi.fn(),
+    get: vi.fn(),
+    post: vi.fn(),
+    put: vi.fn(),
+    patch: vi.fn(),
+    delete: vi.fn(),
+  }
+}
+
+// ── Tests ────────────────────────────────────────────────────────────
+
+describe('ContactBlockListsControlsApi', () => {
+  let client: ReturnType<typeof createMockClient>
+  let api: ContactBlockListsControlsApi
+
+  beforeEach(() => {
+    client = createMockClient()
+    api = new ContactBlockListsControlsApi(client)
+  })
+
+  it('count calls client.get with /contact-block-lists-controls/count', async () => {
+    vi.mocked(client.get).mockResolvedValue({ count: 2 })
+    await expect(api.count()).resolves.toEqual({ count: 2 })
+    expect(client.get).toHaveBeenCalledWith('/contact-block-lists-controls/count', undefined)
+  })
+
+  it('create posts the runs and resolves with no body', async () => {
+    vi.mocked(client.post).mockResolvedValue(undefined)
+    const body = {
+      reason: 'QA',
+      servicesIds: ['svc-1'],
+      contactBlockListsIds: ['list-1'],
+      action: 'block' as const,
+      revertExceptions: false,
+    }
+    await expect(api.create(body)).resolves.toBeUndefined()
+    expect(client.post).toHaveBeenCalledWith('/contact-block-lists-controls', body, undefined)
+  })
+})

package/src/apis/contactBlockListsControls/ContactBlockListsControlsApi.ts

@@ -7,19 +7,66 @@ import type {
   UpdateContactBlockListsControlPayload,
 } from './types'
 
+/**
+ * Block/unblock runs of block lists over connections. A run blocks (or unblocks) the contacts of the
+ * connection whose numbers are in the list, in the background, and blocking closes their open tickets.
+ * `getById` answers `null` for an unknown id.
+ */
 export class ContactBlockListsControlsApi extends BaseCrudApi<
   ContactBlockListsControl,
   CreateContactBlockListsControlPayload,
   UpdateContactBlockListsControlPayload,
   ListQuery<ContactBlockListsControl>,
-  'OK'
+  'OK',
+  void
 > {
   constructor(client: ApiClient) {
     super(client, '/contact-block-lists-controls')
   }
 
   /**
-   * Deletes a block/unblock run. Resolves the text `'OK'`.
+   * Counts the runs matching the query.
+   * @permissions contacts.view OR contacts.block
+   */
+  count(
+    query?: ListQuery<ContactBlockListsControl>,
+    headers?: Record<string, string>,
+  ): Promise<{ count: number }> {
+    return this.client.get<{ count: number }>(
+      `${this.basePath}/count${this.toQueryString(query)}`,
+      headers,
+    )
+  }
+
+  /**
+   * Starts the runs: one per connection × list of the body, all with the same `reason`. Resolves with no
+   * body — find the runs with `getMany` by `reason`.
+   * @permissions contacts.view OR contacts.block
+   */
+  override create(
+    body: CreateContactBlockListsControlPayload,
+    headers?: Record<string, string>,
+  ): Promise<void> {
+    return super.create(body, headers)
+  }
+
+  /**
+   * Updates a run. The backend requires `reason`, `servicesIds`, `contactBlockListsIds` and `action` (400
+   * without them), but ignores the ids, and a new `action` does not run anything again. An unknown id
+   * answers 500.
+   * @permissions contacts.view OR contacts.update OR contacts.block
+   */
+  override updateById(
+    id: string,
+    body: UpdateContactBlockListsControlPayload,
+    headers?: Record<string, string>,
+  ): Promise<ContactBlockListsControl> {
+    return super.updateById(id, body, headers)
+  }
+
+  /**
+   * Deletes a block/unblock run. Resolves the text `'OK'`; it does not undo the contacts already
+   * blocked or unblocked.
    * @permissions contacts.view OR contacts.destroy OR contacts.block
    */
   override deleteById(id: string, headers?: Record<string, string>): Promise<'OK'> {

package/src/apis/contactBlockListsControls/types.ts

@@ -31,12 +31,19 @@ export type ContactBlockListsControl = {
 export type ContactBlockListsControlRelationships = 'contactBlockList' | 'user' | 'service'
 
 export type CreateContactBlockListsControlPayload = {
+  /** Unique in the account (409 when another run already has it). */
   reason: string
   servicesIds: string[]
   contactBlockListsIds: string[]
   action: ContactBlockListsControlAction
+  /**
+   * Applies the opposite action to the contacts of the connection that are NOT in the list: with `block`, it
+   * unblocks them; with `unblock`, it blocks all of them.
+   */
+  revertExceptions?: boolean
 }
 
+/** The backend requires the four fields (400 without them); the ids are ignored. */
 export type UpdateContactBlockListsControlPayload = {
   reason?: string
   servicesIds?: string[]

package/src/apis/distribution/DistributionApi.test.ts

@@ -0,0 +1,65 @@
+import { beforeEach, describe, expect, it, vi } from 'vitest'
+import { DistributionApi } from './DistributionApi'
+import type { ApiClient } from '../../core/ApiClient'
+
+// ── Mock client factory ──────────────────────────────────────────────
+
+function createMockClient(): ApiClient {
+  return {
+    setAccessToken: vi.fn().mockReturnThis(),
+    request: vi.fn(),
+    get: vi.fn(),
+    post: vi.fn(),
+    put: vi.fn(),
+    patch: vi.fn(),
+    delete: vi.fn(),
+  }
+}
+
+// ── Tests ────────────────────────────────────────────────────────────
+
+describe('DistributionApi', () => {
+  let client: ReturnType<typeof createMockClient>
+  let api: DistributionApi
+
+  beforeEach(() => {
+    client = createMockClient()
+    api = new DistributionApi(client)
+  })
+
+  describe('create', () => {
+    it('posts the body, links included, to /distribution', async () => {
+      vi.mocked(client.post).mockResolvedValue(undefined)
+      const body = { name: 'QA', maxNum: 1, redistributeAll: false, departments: [{ id: 'dep-1' }] }
+      const result = await api.create(body)
+      expect(client.post).toHaveBeenCalledWith('/distribution', body, undefined)
+      expect(result).toBeUndefined()
+    })
+  })
+
+  describe('updateById', () => {
+    it('sends the id in the body too, which is where the backend reads it', async () => {
+      vi.mocked(client.put).mockResolvedValue([])
+      await api.updateById('dist-1', { name: 'QA', roles: [{ id: 'role-1' }] })
+      expect(client.put).toHaveBeenCalledWith(
+        '/distribution/dist-1',
+        { name: 'QA', roles: [{ id: 'role-1' }], id: 'dist-1' },
+        undefined,
+      )
+    })
+
+    it('keeps the id of the URL over an id of the body and forwards custom headers', async () => {
+      const headers = { 'X-Custom': 'value' }
+      await api.updateById('dist-1', { id: 'other' } as never, headers)
+      expect(client.put).toHaveBeenCalledWith('/distribution/dist-1', { id: 'dist-1' }, headers)
+    })
+  })
+
+  describe('deleteById', () => {
+    it('calls client.delete with /distribution/:id', async () => {
+      vi.mocked(client.delete).mockResolvedValue(undefined)
+      await api.deleteById('dist-1')
+      expect(client.delete).toHaveBeenCalledWith('/distribution/dist-1', undefined)
+    })
+  })
+})

package/src/apis/distribution/DistributionApi.ts

@@ -1,19 +1,57 @@
 import type { ApiClient } from '../../core/ApiClient'
 import type { ListQuery } from '../../core/types'
 import { BaseCrudApi } from '../../core/BaseCrudApi'
+import type { Department } from '../departments/types'
 import type { Distribution, CreateDistributionPayload, UpdateDistributionPayload } from './types'
 
+/**
+ * Ticket distribution rules. `getById` answers `null` for an unknown id and always includes `departments` and
+ * `roles` (the query is ignored).
+ */
 export class DistributionApi extends BaseCrudApi<
   Distribution,
   CreateDistributionPayload,
   UpdateDistributionPayload,
   ListQuery<Distribution>,
-  void
+  void,
+  Distribution | undefined,
+  Distribution | Department[]
 > {
   constructor(client: ApiClient) {
     super(client, '/distribution')
   }
 
+  /**
+   * Creates a distribution. Resolves the distribution (without `departments`/`roles`), or no body
+   * (`undefined`) when `departments` is sent — find it by name with `getMany` in that case.
+   * @permissions distribution.create
+   */
+  override create(
+    body: CreateDistributionPayload,
+    headers?: Record<string, string>,
+  ): Promise<Distribution | undefined> {
+    return super.create(body, headers)
+  }
+
+  /**
+   * Updates a distribution. The backend reads the id from the body, so it is sent there too. It replaces
+   * the links: omitting `roles` or `departments` clears them. Resolves the stored distribution (with
+   * `deletedAt`, without the links) or, when `departments` is sent, the updated departments. An unknown id
+   * answers 500.
+   * @permissions distribution.view OR distribution.update
+   */
+  override updateById(
+    id: string,
+    body: UpdateDistributionPayload,
+    headers?: Record<string, string>,
+  ): Promise<Distribution | Department[]> {
+    return this.client.put<Distribution | Department[], UpdateDistributionPayload & { id: string }>(
+      `${this.basePath}/${id}`,
+      { ...body, id },
+      headers,
+    )
+  }
+
   /**
    * Deletes a distribution. Resolves with no body, also for an unknown id (200).
    * @permissions distribution.view OR distribution.destroy