@ikatec/digisac-api-sdk 1.3.2 → 2.0.0

package/dist/core/BaseCrudApi.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"BaseCrudApi.cjs","names":[],"sources":["../../src/core/BaseCrudApi.ts"],"sourcesContent":["import qs from 'qs'\nimport type { ApiClient } from './ApiClient'\nimport type { CrudApi, ListQuery, Paginated } from './types'\nexport type {\n  WhereClause,\n  IncludeItem,\n  ListQuery,\n  Paginated,\n  HasGetMany,\n  HasGetById,\n  HasCreate,\n  HasUpdateById,\n  HasDeleteById,\n  CrudApi,\n} from './types'\n\nexport class BaseCrudApi<\n  TResponse,\n  TCreate,\n  TUpdate = TCreate,\n  TQuery extends ListQuery<TResponse> = ListQuery<TResponse>,\n> implements CrudApi<TResponse, TCreate, TUpdate, TQuery> {\n  protected readonly client: ApiClient\n  protected readonly basePath: string\n\n  constructor(client: ApiClient, basePath: string) {\n    this.client = 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    const queryString = query ? `?${qs.stringify(query)}` : ''\n    return this.client.get<Paginated<TResponse> | TResponse[]>(\n      `${this.basePath}${queryString}`,\n      headers,\n    )\n  }\n\n  /**\n   * Returns a single resource by ID.\n   * @permissions $resourceName.view\n   */\n  getById(id: string, headers?: Record<string, string>): Promise<TResponse> {\n    return this.client.get<TResponse>(`${this.basePath}/${id}`, headers)\n  }\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.delete\n   */\n  deleteById(id: string, headers?: Record<string, string>): Promise<TResponse> {\n    return this.client.delete<TResponse>(`${this.basePath}/${id}`, headers)\n  }\n}\n"],"mappings":";;;;;;AAgBA,IAAa,cAAb,MAK0D;CACxD,AAAmB;CACnB,AAAmB;CAEnB,YAAY,QAAmB,UAAkB;AAC/C,OAAK,SAAS;AACd,OAAK,WAAW,SAAS,QAAQ,OAAO,GAAG;;CAW7C,QACE,OACA,SAC6C;EAC7C,MAAM,cAAc,QAAQ,IAAI,WAAG,UAAU,MAAM,KAAK;AACxD,SAAO,KAAK,OAAO,IACjB,GAAG,KAAK,WAAW,eACnB,QACD;;;;;;CAOH,QAAQ,IAAY,SAAsD;AACxE,SAAO,KAAK,OAAO,IAAe,GAAG,KAAK,SAAS,GAAG,MAAM,QAAQ;;;;;;CAOtE,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,SAAsD;AAC3E,SAAO,KAAK,OAAO,OAAkB,GAAG,KAAK,SAAS,GAAG,MAAM,QAAQ"}
+{"version":3,"file":"BaseCrudApi.cjs","names":[],"sources":["../../src/core/BaseCrudApi.ts"],"sourcesContent":["import qs from 'qs'\nimport type { ApiClient } from './ApiClient'\nimport type { CrudApi, GetByIdQuery, ListQuery, Paginated } 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\nexport class BaseCrudApi<\n  TResponse,\n  TCreate,\n  TUpdate = TCreate,\n  TQuery extends ListQuery<TResponse> = ListQuery<TResponse>,\n> implements CrudApi<TResponse, TCreate, TUpdate, TQuery> {\n  protected readonly client: ApiClient\n  protected readonly basePath: string\n\n  constructor(client: ApiClient, basePath: string) {\n    this.client = client\n    this.basePath = basePath.replace(/\\/$/, '')\n    this.getMany = this.getMany.bind(this)\n    this.getById = this.getById.bind(this)\n    this.create = this.create.bind(this)\n    this.updateById = this.updateById.bind(this)\n    this.deleteById = this.deleteById.bind(this)\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    const queryString = query ? `?${qs.stringify(query)}` : ''\n    return this.client.get<Paginated<TResponse> | TResponse[]>(\n      `${this.basePath}${queryString}`,\n      headers,\n    )\n  }\n\n  /**\n   * Returns a single resource by ID.\n   * @permissions $resourceName.view\n   */\n  getById(\n    id: string,\n    query?: GetByIdQuery<TResponse>,\n    headers?: Record<string, string>,\n  ): Promise<TResponse> {\n    const queryString = query ? `?${qs.stringify(query)}` : ''\n    return this.client.get<TResponse>(`${this.basePath}/${id}${queryString}`, headers)\n  }\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.delete\n   */\n  deleteById(id: string, headers?: Record<string, string>): Promise<TResponse> {\n    return this.client.delete<TResponse>(`${this.basePath}/${id}`, headers)\n  }\n}\n"],"mappings":";;;;;;AAiBA,IAAa,cAAb,MAK0D;CACxD,AAAmB;CACnB,AAAmB;CAEnB,YAAY,QAAmB,UAAkB;AAC/C,OAAK,SAAS;AACd,OAAK,WAAW,SAAS,QAAQ,OAAO,GAAG;AAC3C,OAAK,UAAU,KAAK,QAAQ,KAAK,KAAK;AACtC,OAAK,UAAU,KAAK,QAAQ,KAAK,KAAK;AACtC,OAAK,SAAS,KAAK,OAAO,KAAK,KAAK;AACpC,OAAK,aAAa,KAAK,WAAW,KAAK,KAAK;AAC5C,OAAK,aAAa,KAAK,WAAW,KAAK,KAAK;;CAW9C,QACE,OACA,SAC6C;EAC7C,MAAM,cAAc,QAAQ,IAAI,WAAG,UAAU,MAAM,KAAK;AACxD,SAAO,KAAK,OAAO,IACjB,GAAG,KAAK,WAAW,eACnB,QACD;;;;;;CAOH,QACE,IACA,OACA,SACoB;EACpB,MAAM,cAAc,QAAQ,IAAI,WAAG,UAAU,MAAM,KAAK;AACxD,SAAO,KAAK,OAAO,IAAe,GAAG,KAAK,SAAS,GAAG,KAAK,eAAe,QAAQ;;;;;;CAOpF,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,SAAsD;AAC3E,SAAO,KAAK,OAAO,OAAkB,GAAG,KAAK,SAAS,GAAG,MAAM,QAAQ"}

package/dist/core/BaseCrudApi.d.ts

@@ -1,6 +1,6 @@
 import type { ApiClient } from './ApiClient';
-import type { CrudApi, ListQuery, Paginated } from './types';
-export type { WhereClause, IncludeItem, ListQuery, Paginated, HasGetMany, HasGetById, HasCreate, HasUpdateById, HasDeleteById, CrudApi, } from './types';
+import type { CrudApi, GetByIdQuery, ListQuery, Paginated } from './types';
+export type { WhereClause, IncludeItem, ListQuery, GetByIdQuery, Paginated, HasGetMany, HasGetById, HasCreate, HasUpdateById, HasDeleteById, CrudApi, } from './types';
 export declare class BaseCrudApi<TResponse, TCreate, TUpdate = TCreate, TQuery extends ListQuery<TResponse> = ListQuery<TResponse>> implements CrudApi<TResponse, TCreate, TUpdate, TQuery> {
     protected readonly client: ApiClient;
     protected readonly basePath: string;
@@ -15,7 +15,7 @@ export declare class BaseCrudApi<TResponse, TCreate, TUpdate = TCreate, TQuery e
      * Returns a single resource by ID.
      * @permissions $resourceName.view
      */
-    getById(id: string, headers?: Record<string, string>): Promise<TResponse>;
+    getById(id: string, query?: GetByIdQuery<TResponse>, headers?: Record<string, string>): Promise<TResponse>;
     /**
      * Creates a new resource.
      * @permissions $resourceName.create

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

@@ -1 +1 @@
-{"version":3,"file":"BaseCrudApi.d.ts","sourceRoot":"","sources":["../../src/core/BaseCrudApi.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AAC5C,OAAO,KAAK,EAAE,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,SAAS,CAAA;AAC5D,YAAY,EACV,WAAW,EACX,WAAW,EACX,SAAS,EACT,SAAS,EACT,UAAU,EACV,UAAU,EACV,SAAS,EACT,aAAa,EACb,aAAa,EACb,OAAO,GACR,MAAM,SAAS,CAAA;AAEhB,qBAAa,WAAW,CACtB,SAAS,EACT,OAAO,EACP,OAAO,GAAG,OAAO,EACjB,MAAM,SAAS,SAAS,CAAC,SAAS,CAAC,GAAG,SAAS,CAAC,SAAS,CAAC,CAC1D,YAAW,OAAO,CAAC,SAAS,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,CAAC;IACvD,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,SAAS,CAAA;IACpC,SAAS,CAAC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;gBAEvB,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM;IAK/C,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;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;IAYhC;;;OAGG;IACH,OAAO,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,SAAS,CAAC;IAIzE;;;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,SAAS,CAAC;CAG7E"}
+{"version":3,"file":"BaseCrudApi.d.ts","sourceRoot":"","sources":["../../src/core/BaseCrudApi.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AAC5C,OAAO,KAAK,EAAE,OAAO,EAAE,YAAY,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,SAAS,CAAA;AAC1E,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,qBAAa,WAAW,CACtB,SAAS,EACT,OAAO,EACP,OAAO,GAAG,OAAO,EACjB,MAAM,SAAS,SAAS,CAAC,SAAS,CAAC,GAAG,SAAS,CAAC,SAAS,CAAC,CAC1D,YAAW,OAAO,CAAC,SAAS,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,CAAC;IACvD,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,SAAS,CAAA;IACpC,SAAS,CAAC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;gBAEvB,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM;IAU/C,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;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;IAYhC;;;OAGG;IACH,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;IAKrB;;;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,SAAS,CAAC;CAG7E"}

package/dist/core/BaseCrudApi.mjs

@@ -7,6 +7,11 @@ var BaseCrudApi = class {
 	constructor(client, basePath) {
 		this.client = client;
 		this.basePath = basePath.replace(/\/$/, "");
+		this.getMany = this.getMany.bind(this);
+		this.getById = this.getById.bind(this);
+		this.create = this.create.bind(this);
+		this.updateById = this.updateById.bind(this);
+		this.deleteById = this.deleteById.bind(this);
 	}
 	getMany(query, headers) {
 		const queryString = query ? `?${qs.stringify(query)}` : "";
@@ -16,8 +21,9 @@ var BaseCrudApi = class {
 	* Returns a single resource by ID.
 	* @permissions $resourceName.view
 	*/
-	getById(id, headers) {
-		return this.client.get(`${this.basePath}/${id}`, headers);
+	getById(id, query, headers) {
+		const queryString = query ? `?${qs.stringify(query)}` : "";
+		return this.client.get(`${this.basePath}/${id}${queryString}`, headers);
 	}
 	/**
 	* Creates a new resource.

package/dist/core/BaseCrudApi.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"BaseCrudApi.mjs","names":[],"sources":["../../src/core/BaseCrudApi.ts"],"sourcesContent":["import qs from 'qs'\nimport type { ApiClient } from './ApiClient'\nimport type { CrudApi, ListQuery, Paginated } from './types'\nexport type {\n  WhereClause,\n  IncludeItem,\n  ListQuery,\n  Paginated,\n  HasGetMany,\n  HasGetById,\n  HasCreate,\n  HasUpdateById,\n  HasDeleteById,\n  CrudApi,\n} from './types'\n\nexport class BaseCrudApi<\n  TResponse,\n  TCreate,\n  TUpdate = TCreate,\n  TQuery extends ListQuery<TResponse> = ListQuery<TResponse>,\n> implements CrudApi<TResponse, TCreate, TUpdate, TQuery> {\n  protected readonly client: ApiClient\n  protected readonly basePath: string\n\n  constructor(client: ApiClient, basePath: string) {\n    this.client = 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    const queryString = query ? `?${qs.stringify(query)}` : ''\n    return this.client.get<Paginated<TResponse> | TResponse[]>(\n      `${this.basePath}${queryString}`,\n      headers,\n    )\n  }\n\n  /**\n   * Returns a single resource by ID.\n   * @permissions $resourceName.view\n   */\n  getById(id: string, headers?: Record<string, string>): Promise<TResponse> {\n    return this.client.get<TResponse>(`${this.basePath}/${id}`, headers)\n  }\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.delete\n   */\n  deleteById(id: string, headers?: Record<string, string>): Promise<TResponse> {\n    return this.client.delete<TResponse>(`${this.basePath}/${id}`, headers)\n  }\n}\n"],"mappings":";;;AAgBA,IAAa,cAAb,MAK0D;CACxD,AAAmB;CACnB,AAAmB;CAEnB,YAAY,QAAmB,UAAkB;AAC/C,OAAK,SAAS;AACd,OAAK,WAAW,SAAS,QAAQ,OAAO,GAAG;;CAW7C,QACE,OACA,SAC6C;EAC7C,MAAM,cAAc,QAAQ,IAAI,GAAG,UAAU,MAAM,KAAK;AACxD,SAAO,KAAK,OAAO,IACjB,GAAG,KAAK,WAAW,eACnB,QACD;;;;;;CAOH,QAAQ,IAAY,SAAsD;AACxE,SAAO,KAAK,OAAO,IAAe,GAAG,KAAK,SAAS,GAAG,MAAM,QAAQ;;;;;;CAOtE,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,SAAsD;AAC3E,SAAO,KAAK,OAAO,OAAkB,GAAG,KAAK,SAAS,GAAG,MAAM,QAAQ"}
+{"version":3,"file":"BaseCrudApi.mjs","names":[],"sources":["../../src/core/BaseCrudApi.ts"],"sourcesContent":["import qs from 'qs'\nimport type { ApiClient } from './ApiClient'\nimport type { CrudApi, GetByIdQuery, ListQuery, Paginated } 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\nexport class BaseCrudApi<\n  TResponse,\n  TCreate,\n  TUpdate = TCreate,\n  TQuery extends ListQuery<TResponse> = ListQuery<TResponse>,\n> implements CrudApi<TResponse, TCreate, TUpdate, TQuery> {\n  protected readonly client: ApiClient\n  protected readonly basePath: string\n\n  constructor(client: ApiClient, basePath: string) {\n    this.client = client\n    this.basePath = basePath.replace(/\\/$/, '')\n    this.getMany = this.getMany.bind(this)\n    this.getById = this.getById.bind(this)\n    this.create = this.create.bind(this)\n    this.updateById = this.updateById.bind(this)\n    this.deleteById = this.deleteById.bind(this)\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    const queryString = query ? `?${qs.stringify(query)}` : ''\n    return this.client.get<Paginated<TResponse> | TResponse[]>(\n      `${this.basePath}${queryString}`,\n      headers,\n    )\n  }\n\n  /**\n   * Returns a single resource by ID.\n   * @permissions $resourceName.view\n   */\n  getById(\n    id: string,\n    query?: GetByIdQuery<TResponse>,\n    headers?: Record<string, string>,\n  ): Promise<TResponse> {\n    const queryString = query ? `?${qs.stringify(query)}` : ''\n    return this.client.get<TResponse>(`${this.basePath}/${id}${queryString}`, headers)\n  }\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.delete\n   */\n  deleteById(id: string, headers?: Record<string, string>): Promise<TResponse> {\n    return this.client.delete<TResponse>(`${this.basePath}/${id}`, headers)\n  }\n}\n"],"mappings":";;;AAiBA,IAAa,cAAb,MAK0D;CACxD,AAAmB;CACnB,AAAmB;CAEnB,YAAY,QAAmB,UAAkB;AAC/C,OAAK,SAAS;AACd,OAAK,WAAW,SAAS,QAAQ,OAAO,GAAG;AAC3C,OAAK,UAAU,KAAK,QAAQ,KAAK,KAAK;AACtC,OAAK,UAAU,KAAK,QAAQ,KAAK,KAAK;AACtC,OAAK,SAAS,KAAK,OAAO,KAAK,KAAK;AACpC,OAAK,aAAa,KAAK,WAAW,KAAK,KAAK;AAC5C,OAAK,aAAa,KAAK,WAAW,KAAK,KAAK;;CAW9C,QACE,OACA,SAC6C;EAC7C,MAAM,cAAc,QAAQ,IAAI,GAAG,UAAU,MAAM,KAAK;AACxD,SAAO,KAAK,OAAO,IACjB,GAAG,KAAK,WAAW,eACnB,QACD;;;;;;CAOH,QACE,IACA,OACA,SACoB;EACpB,MAAM,cAAc,QAAQ,IAAI,GAAG,UAAU,MAAM,KAAK;AACxD,SAAO,KAAK,OAAO,IAAe,GAAG,KAAK,SAAS,GAAG,KAAK,eAAe,QAAQ;;;;;;CAOpF,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,SAAsD;AAC3E,SAAO,KAAK,OAAO,OAAkB,GAAG,KAAK,SAAS,GAAG,MAAM,QAAQ"}

package/dist/core/index.d.ts

@@ -2,5 +2,5 @@ export type { ApiClient, HttpMethod } from './ApiClient';
 export { BaseApiClient, ApiError } from './BaseApiClient';
 export type { ValidationError } from './BaseApiClient';
 export { BaseCrudApi } from './BaseCrudApi';
-export type { WhereClause, IncludeItem, ListQuery, Paginated } from './types';
+export type { WhereClause, IncludeItem, ListQuery, GetByIdQuery, Paginated } from './types';
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/core/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AACxD,OAAO,EAAE,aAAa,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAA;AACzD,YAAY,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAA;AACtD,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAC3C,YAAY,EAAE,WAAW,EAAE,WAAW,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,SAAS,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/core/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AACxD,OAAO,EAAE,aAAa,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAA;AACzD,YAAY,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAA;AACtD,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAC3C,YAAY,EAAE,WAAW,EAAE,WAAW,EAAE,SAAS,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,SAAS,CAAA"}

package/dist/core/types.d.ts

@@ -51,6 +51,7 @@ type TypedIncludeObject<T> = {
     [K in AssociationKeys<T>]: {
         model: K;
         as?: string;
+        attributes?: (keyof Unwrap<T[K]> & string)[];
         include?: IncludeItem<Unwrap<T[K]>>[];
         required?: boolean;
         where?: WhereClause<Unwrap<T[K]>>;
@@ -91,8 +92,9 @@ export interface HasGetMany<TResponse, TQuery extends ListQuery<TResponse> = Lis
         paginate?: true;
     }, headers?: Record<string, string>): Promise<Paginated<TResponse>>;
 }
+export type GetByIdQuery<T = Record<string, unknown>> = Pick<ListQuery<T>, 'include' | 'attributes'>;
 export interface HasGetById<TResponse> {
-    getById(id: string, headers?: Record<string, string>): Promise<TResponse>;
+    getById(id: string, query?: GetByIdQuery<TResponse>, headers?: Record<string, string>): Promise<TResponse>;
 }
 export interface HasCreate<TResponse, TCreate> {
     create(body: TCreate, headers?: Record<string, string>): Promise<TResponse>;

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,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;CACjC;AAED,MAAM,WAAW,UAAU,CAAC,SAAS;IACnC,OAAO,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,SAAS,CAAC,CAAA;CAC1E;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,IACxD,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,SAAS,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;CACjC;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,IACxD,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,SAAS,CAAC,CAAA"}

package/dist/index.d.ts

@@ -1,2 +1,2 @@
-export * from './core/index';
+export * from './core';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,QAAQ,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ikatec/digisac-api-sdk",
-  "version": "1.3.2",
+  "version": "2.0.0",
   "type": "module",
   "main": "./dist/index.cjs",
   "module": "./dist/index.mjs",
@@ -12,6 +12,12 @@
       "import": "./dist/index.mjs",
       "require": "./dist/index.cjs"
     },
+    "./apis": {
+      "typescript": "./src/apis/index.ts",
+      "types": "./dist/apis/index.d.ts",
+      "import": "./dist/apis/index.mjs",
+      "require": "./dist/apis/index.cjs"
+    },
     "./incommingWebhooks": {
       "typescript": "./src/incommingWebhooks/index.ts",
       "types": "./dist/incommingWebhooks/index.d.ts",

package/src/apis/campaigns/CampaignsApi.ts

@@ -1,6 +1,16 @@
-import type { ApiClient } from '../../core/ApiClient'
-import { BaseCrudApi } from '../../core/BaseCrudApi'
-import type { Campaign, CreateCampaignPayload, UpdateCampaignPayload } from './types'
+import type { ApiClient } from '../../core'
+import { BaseCrudApi } from '../../core'
+import type {
+  AutoPauseModePayload,
+  Campaign,
+  CampaignStats,
+  CreateCampaignPayload,
+  ExportCampaignResultPayload,
+  ExportTemplateCsvPayload,
+  HsmLimit,
+  SetIntervalPayload,
+  UpdateCampaignPayload,
+} from './types'
 
 export class CampaignsApi extends BaseCrudApi<
   Campaign,
@@ -9,5 +19,72 @@ export class CampaignsApi extends BaseCrudApi<
 > {
   constructor(client: ApiClient) {
     super(client, '/campaigns')
+
+    this.sendById = this.sendById.bind(this)
+    this.pauseById = this.pauseById.bind(this)
+    this.resumeById = this.resumeById.bind(this)
+    this.duplicateById = this.duplicateById.bind(this)
+    this.getStatsById = this.getStatsById.bind(this)
+    this.setIntervalById = this.setIntervalById.bind(this)
+    this.getContactCount = this.getContactCount.bind(this)
+    this.setAutoPauseMode = this.setAutoPauseMode.bind(this)
+    this.exportCampaignResult = this.exportCampaignResult.bind(this)
+    this.exportTemplateCsv = this.exportTemplateCsv.bind(this)
+    this.getHsmLimit = this.getHsmLimit.bind(this)
+  }
+
+  /** Starts sending messages for the given campaign. */
+  sendById(id: string): Promise<Campaign> {
+    return this.client.post<Campaign>(`${this.basePath}/${id}/send`)
+  }
+
+  /** Pauses a campaign that is currently sending. */
+  pauseById(id: string): Promise<Campaign> {
+    return this.client.post<Campaign>(`${this.basePath}/${id}/pause`)
+  }
+
+  /** Resumes a previously paused campaign. */
+  resumeById(id: string): Promise<Campaign> {
+    return this.client.post<Campaign>(`${this.basePath}/${id}/resume`)
+  }
+
+  /** Creates a copy of an existing campaign. */
+  duplicateById(id: string): Promise<Campaign> {
+    return this.client.post<Campaign>(`${this.basePath}/${id}/duplicate`)
+  }
+
+  /** Returns send/delivery/view statistics for a campaign. */
+  getStatsById(id: string): Promise<CampaignStats> {
+    return this.client.get<CampaignStats>(`${this.basePath}/${id}/stats`)
+  }
+
+  /** Updates the min/max send interval for a campaign. */
+  setIntervalById(id: string, data: SetIntervalPayload): Promise<Campaign> {
+    return this.client.post<Campaign, SetIntervalPayload>(`${this.basePath}/${id}/interval`, data)
+  }
+
+  /** Returns the total number of contacts targeted by a campaign. */
+  getContactCount(id: string): Promise<number> {
+    return this.client.get<number>(`${this.basePath}/${id}/contactCount`)
+  }
+
+  /** Configures the auto-pause behavior for campaigns. */
+  setAutoPauseMode(data: AutoPauseModePayload): Promise<unknown> {
+    return this.client.put(`${this.basePath}/autoPauseMode`, data)
+  }
+
+  /** Exports campaign send results as a CSV file. */
+  exportCampaignResult(data: ExportCampaignResultPayload): Promise<unknown> {
+    return this.client.post(`${this.basePath}/export/csv`, data)
+  }
+
+  /** Exports a CSV template for importing contacts into an HSM campaign. */
+  exportTemplateCsv(data: ExportTemplateCsvPayload): Promise<unknown> {
+    return this.client.post(`${this.basePath}/exportTemplate`, data)
+  }
+
+  /** Returns the HSM message usage and limit for an account. */
+  getHsmLimit(accountId: string): Promise<HsmLimit> {
+    return this.client.get<HsmLimit>(`/whatsapp-business-templates/${accountId}/hsmLimit`)
   }
 }

package/src/apis/campaigns/index.ts

@@ -1,2 +1,3 @@
 export { CampaignsApi } from './CampaignsApi'
+export * as scopes from './scopes'
 export type * from './types'

package/src/apis/campaigns/scopes/getManyViewScope.ts

@@ -0,0 +1,79 @@
+import type { IncludeItem, ListQuery, WhereClause } from '../../../core'
+import type { Campaign, CampaignStatus } from '../types'
+
+export type GetManyPaginatedFilters = {
+  title?: string
+  status?: CampaignStatus
+  serviceId?: string
+  createdAtFrom?: string
+  createdAtTo?: string
+  startedAtFrom?: string
+  startedAtTo?: string
+  quality?: string
+  page?: number
+  perPage?: number
+  sort?: string
+  order?: 'ASC' | 'DESC'
+  paginate?: boolean
+}
+
+export function getManyViewScope(
+  filters: GetManyPaginatedFilters = {},
+): ListQuery<Campaign> & { paginate: true } {
+  const where: WhereClause<Campaign> = {}
+  const $and: WhereClause<Campaign>[] = []
+
+  if (filters.title) {
+    where.title = { $iLike: `%${filters.title}%` }
+  }
+  if (filters.status) {
+    where.status = filters.status
+  }
+  if (filters.serviceId) {
+    where.serviceId = filters.serviceId
+  }
+  if (filters.createdAtFrom) {
+    $and.push({ createdAt: { $gte: filters.createdAtFrom } })
+  }
+  if (filters.createdAtTo) {
+    $and.push({ createdAt: { $lte: filters.createdAtTo } })
+  }
+  if (filters.startedAtFrom) {
+    $and.push({ startedAt: { $gte: filters.startedAtFrom } })
+  }
+  if (filters.startedAtTo) {
+    $and.push({ startedAt: { $lte: filters.startedAtTo } })
+  }
+
+  if ($and.length > 0) {
+    where.$and = $and
+  }
+
+  const include: IncludeItem<Campaign>[] = [
+    'service',
+    'tags',
+    {
+      model: 'messages',
+      ...(filters.quality && { required: true }),
+      include: [
+        'file',
+        {
+          model: 'hsm',
+          ...(filters.quality && { where: { quality: filters.quality }, required: true }),
+        },
+      ],
+    },
+    { model: 'createdBy', attributes: ['id', 'name'] },
+    { model: 'sentBy', attributes: ['id', 'name'] },
+  ]
+
+  return {
+    where,
+    order: [[(filters.sort ?? 'createdAt') as keyof Campaign & string, filters.order ?? 'DESC']],
+    page: filters.page ?? 1,
+    perPage: filters.perPage ?? 15,
+    paginate: true as const,
+    ...(filters.quality && { subQuery: false }),
+    include,
+  }
+}

package/src/apis/campaigns/scopes/getOneViewScope.ts

@@ -0,0 +1,21 @@
+import type { GetByIdQuery } from '../../../core'
+import type { Campaign } from '../types'
+
+/** Query scope that includes all associations for a detailed campaign view. */
+export function getOneViewScope(): GetByIdQuery<Campaign> {
+  return {
+    include: [
+      'service',
+      'tags',
+      {
+        model: 'messages',
+        include: ['file', 'hsm', 'hsmFile'],
+      },
+      'importFile',
+      'defaultDepartment',
+      'defaultUser',
+      'createdBy',
+      'sentBy',
+    ],
+  }
+}

package/src/apis/campaigns/scopes/index.ts

@@ -0,0 +1,2 @@
+export { getOneViewScope } from './getOneViewScope'
+export { getManyViewScope, type GetManyPaginatedFilters } from './getManyViewScope'

package/src/apis/campaigns/types.ts

@@ -1,7 +1,9 @@
-import type { Department } from '../departments/types'
-import type { Service } from '../services/types'
-import type { Tag } from '../tags/types'
-import type { User } from '../users/types'
+import type { Department } from '../departments'
+import type { File } from '../files'
+import type { Message } from '../messages'
+import type { Service } from '../services'
+import type { Tag } from '../tags'
+import type { User } from '../users'
 
 export type CampaignStatus =
   | 'ready'
@@ -47,6 +49,9 @@ export type Campaign = {
   totalContacts: number | null
   totalContactsImported: number | null
   totalValidContacts: number | null
+  sentContacts: number | null
+  viewedContacts: number | null
+  contactCount: number | null
   mustOpenTicket: boolean
   marketingIntegration: boolean
   accountId: string
@@ -65,6 +70,8 @@ export type Campaign = {
   createdBy?: User | null
   sentBy?: User | null
   tags?: Tag[]
+  messages?: Message[]
+  importFile?: File | null
 }
 
 export type CampaignRelationships =
@@ -74,24 +81,74 @@ export type CampaignRelationships =
   | 'createdBy'
   | 'sentBy'
   | 'tags'
+  | 'messages'
+  | 'importFile'
 
 export type CreateCampaignPayload = {
   title: string
   serviceId: string
-  config: CampaignConfig
-  defaultDepartmentId?: string
-  defaultUserId?: string
-  sendsAt?: string
+  config?: { minInterval: number | string; maxInterval: number | string }
+  tagIds?: string[]
+  messages?: { text?: string; fileId?: string }[]
   isScheduled?: boolean
+  sendsAt?: string | null
   mustOpenTicket?: boolean
-}
-
-export type UpdateCampaignPayload = {
-  title?: string
-  config?: CampaignConfig
   defaultDepartmentId?: string | null
   defaultUserId?: string | null
-  sendsAt?: string | null
-  isScheduled?: boolean
-  mustOpenTicket?: boolean
+  hsm?: unknown
+  parameters?: unknown
+  fileTemplate?: unknown
+  contacts?: unknown[]
+  useTags?: boolean
+  marketingIntegration?: boolean
+  fileId?: string
+  nameField?: string
+  numberField?: string
+}
+
+export type UpdateCampaignPayload = Partial<CreateCampaignPayload>
+
+export type CampaignStatsInfo = {
+  totalValidContacts: number
+  totalContacts: number
+  totalContactsImported: number
+  firedSuccessCount: number
+  firedFailedCount: number
+  totalMessagesCount: number
+  totalFiredCount: number
+  firedBlockedByMessageRuleCount: number
+}
+
+export type CampaignStatsMessages = {
+  error: number
+  received: number
+  viewed: number
+  answered: number
+}
+
+export type CampaignStats = {
+  campaignInfo: CampaignStatsInfo
+  messageInfo: CampaignStatsMessages
+}
+
+export type SetIntervalPayload = {
+  minInterval: string
+  maxInterval: string
+}
+
+export type ExportCampaignResultPayload = {
+  campaignId: string
+}
+
+export type ExportTemplateCsvPayload = {
+  hsmId: string
+}
+
+export type AutoPauseModePayload = {
+  mode: string
+}
+
+export type HsmLimit = {
+  hsmLimit: number
+  hsmUsedLimit: number
 }

package/src/apis/files/types.ts

@@ -23,6 +23,7 @@ export type FileStorage =
 
 export type File = {
   id: string
+  url: string
   name: string | null
   checksum: string | null
   mimetype: string

package/src/apis/index.ts

@@ -0,0 +1,55 @@
+export * from './absence'
+export * from './acceptanceTerms'
+export * from './accounts'
+export * from './activityLog'
+export * from './answers'
+export * from './authHistory'
+export * from './botVersions'
+export * from './bots'
+export * from './campaigns'
+export * from './cards'
+export * from './categories'
+export * from './clientFeedback'
+export * from './contactBlockLists'
+export * from './contactBlockListsControls'
+export * from './contacts'
+export * from './creditMovements'
+export * from './customFields'
+export * from './departments'
+export * from './distribution'
+export * from './files'
+export * from './holiday'
+export * from './integrations'
+export * from './interactiveMessages'
+export * from './kanbanBoards'
+export * from './kanbanCards'
+export * from './kanbanColumns'
+export * from './knowledgeBase'
+export * from './knowledgeBaseItem'
+export * from './me'
+export * from './messages'
+export * from './notifications'
+export * from './organizations'
+export * from './people'
+export * from './permissions'
+export * from './personalAccessTokens'
+export * from './pipeline'
+export * from './planAiHistory'
+export * from './questions'
+export * from './quickReplies'
+export * from './roles'
+export * from './schedule'
+export * from './serviceAccessManagement'
+export * from './serviceEvents'
+export * from './services'
+export * from './stickerUsers'
+export * from './stickers'
+export * from './tags'
+export * from './terms'
+export * from './ticketTopics'
+export * from './tickets'
+export * from './timetable'
+export * from './transcripts'
+export * from './users'
+export * from './webhooks'
+export * from './whatsappBusinessTemplates'

package/src/apis/messages/types.ts

@@ -3,6 +3,7 @@ import type { Department } from '../departments/types'
 import type { File } from '../files/types'
 import type { Ticket } from '../tickets/types'
 import type { User } from '../users/types'
+import type { WhatsappBusinessTemplate } from '../whatsappBusinessTemplates/types'
 
 export type MessageType =
   | 'chat'
@@ -127,7 +128,7 @@ export type Message = {
   quotedMessage?: Message | null
   ticketUser?: User | null
   ticketDepartment?: Department | null
-  hsm?: unknown
+  hsm?: WhatsappBusinessTemplate | null
   hsmFile?: File | null
   reactions?: Message[]
   reactionParentMessage?: Message | null

package/src/core/BaseCrudApi.test.ts

@@ -147,7 +147,7 @@ describe('BaseCrudApi', () => {
       vi.mocked(client.get).mockResolvedValue({ id: '1', name: 'x' })
       const headers = { 'X-Tenant': '123' }
 
-      await api.getById('1', headers)
+      await api.getById('1', undefined, headers)
       expect(client.get).toHaveBeenCalledWith('/items/1', headers)
     })
   })

package/src/core/BaseCrudApi.ts

@@ -1,10 +1,11 @@
 import qs from 'qs'
 import type { ApiClient } from './ApiClient'
-import type { CrudApi, ListQuery, Paginated } from './types'
+import type { CrudApi, GetByIdQuery, ListQuery, Paginated } from './types'
 export type {
   WhereClause,
   IncludeItem,
   ListQuery,
+  GetByIdQuery,
   Paginated,
   HasGetMany,
   HasGetById,
@@ -26,6 +27,11 @@ export class BaseCrudApi<
   constructor(client: ApiClient, basePath: string) {
     this.client = client
     this.basePath = basePath.replace(/\/$/, '')
+    this.getMany = this.getMany.bind(this)
+    this.getById = this.getById.bind(this)
+    this.create = this.create.bind(this)
+    this.updateById = this.updateById.bind(this)
+    this.deleteById = this.deleteById.bind(this)
   }
 
   getMany(
@@ -51,8 +57,13 @@ export class BaseCrudApi<
    * Returns a single resource by ID.
    * @permissions $resourceName.view
    */
-  getById(id: string, headers?: Record<string, string>): Promise<TResponse> {
-    return this.client.get<TResponse>(`${this.basePath}/${id}`, headers)
+  getById(
+    id: string,
+    query?: GetByIdQuery<TResponse>,
+    headers?: Record<string, string>,
+  ): Promise<TResponse> {
+    const queryString = query ? `?${qs.stringify(query)}` : ''
+    return this.client.get<TResponse>(`${this.basePath}/${id}${queryString}`, headers)
   }
 
   /**

package/src/core/index.ts

@@ -2,4 +2,4 @@ export type { ApiClient, HttpMethod } from './ApiClient'
 export { BaseApiClient, ApiError } from './BaseApiClient'
 export type { ValidationError } from './BaseApiClient'
 export { BaseCrudApi } from './BaseCrudApi'
-export type { WhereClause, IncludeItem, ListQuery, Paginated } from './types'
+export type { WhereClause, IncludeItem, ListQuery, GetByIdQuery, Paginated } from './types'