@ikatec/digisac-api-sdk 2.1.3 → 2.2.0

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

@@ -60,4 +60,22 @@ export type UpdateTicketPayload = {
     comments?: string | null;
     isOpen?: boolean;
 };
+/**
+ * Body for `PUT /tickets/close-many`.
+ *
+ * Either close an explicit list of tickets by id, or close every open ticket
+ * matching a query. For the query variant the outer `query` is an object whose
+ * `query` field is a JSON-stringified list query (e.g. `JSON.stringify({ where: {} })`);
+ * the backend always forces `where.isOpen = true`.
+ */
+export type CloseManyTicketsPayload = {
+    ids: string[];
+    ticketTopicIds?: string[] | string;
+    comments?: string;
+} | {
+    allContactsSelected: true;
+    query: {
+        query: string;
+    };
+};
 //# sourceMappingURL=types.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/apis/tickets/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAChD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAA;AACtD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAChD,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,gBAAgB,CAAA;AAE1C,MAAM,MAAM,YAAY,GAAG,WAAW,GAAG,QAAQ,GAAG,QAAQ,CAAA;AAE5D,MAAM,MAAM,aAAa,GAAG;IAC1B,6EAA6E;IAC7E,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,8EAA8E;IAC9E,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAC5B,2EAA2E;IAC3E,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,4DAA4D;IAC5D,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,iDAAiD;IACjD,uBAAuB,CAAC,EAAE,MAAM,CAAA;IAChC,kDAAkD;IAClD,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAC5B,yCAAyC;IACzC,uBAAuB,CAAC,EAAE,MAAM,CAAA;IAChC,cAAc,CAAC,EAAE,OAAO,CAAA;CACzB,CAAA;AAED,MAAM,MAAM,MAAM,GAAG;IACnB,EAAE,EAAE,MAAM,CAAA;IACV,MAAM,EAAE,OAAO,CAAA;IACf,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,MAAM,EAAE,YAAY,GAAG,IAAI,CAAA;IAC3B,OAAO,EAAE,aAAa,CAAA;IACtB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAA;IACtB,cAAc,EAAE,OAAO,CAAA;IACvB,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;IACpB,SAAS,EAAE,MAAM,CAAA;IACjB,YAAY,EAAE,MAAM,CAAA;IACpB,SAAS,EAAE,MAAM,CAAA;IACjB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAA;IACrB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB,cAAc,EAAE,MAAM,GAAG,IAAI,CAAA;IAC7B,aAAa,EAAE,MAAM,GAAG,IAAI,CAAA;IAC5B,uBAAuB,EAAE,MAAM,GAAG,IAAI,CAAA;IACtC,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IAEjB,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,UAAU,CAAC,EAAE,UAAU,CAAA;IACvB,IAAI,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;IAClB,OAAO,CAAC,EAAE,OAAO,GAAG,IAAI,CAAA;CACzB,CAAA;AAED,MAAM,MAAM,mBAAmB,GAAG,SAAS,GAAG,YAAY,GAAG,MAAM,GAAG,SAAS,CAAA;AAE/E,MAAM,MAAM,mBAAmB,GAAG;IAChC,SAAS,EAAE,MAAM,CAAA;IACjB,YAAY,EAAE,MAAM,CAAA;IACpB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,MAAM,CAAC,EAAE,YAAY,CAAA;CACtB,CAAA;AAED,MAAM,MAAM,mBAAmB,GAAG;IAChC,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACtB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB,MAAM,CAAC,EAAE,OAAO,CAAA;CACjB,CAAA"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/apis/tickets/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAChD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAA;AACtD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAChD,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,gBAAgB,CAAA;AAE1C,MAAM,MAAM,YAAY,GAAG,WAAW,GAAG,QAAQ,GAAG,QAAQ,CAAA;AAE5D,MAAM,MAAM,aAAa,GAAG;IAC1B,6EAA6E;IAC7E,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,8EAA8E;IAC9E,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAC5B,2EAA2E;IAC3E,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,4DAA4D;IAC5D,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,iDAAiD;IACjD,uBAAuB,CAAC,EAAE,MAAM,CAAA;IAChC,kDAAkD;IAClD,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAC5B,yCAAyC;IACzC,uBAAuB,CAAC,EAAE,MAAM,CAAA;IAChC,cAAc,CAAC,EAAE,OAAO,CAAA;CACzB,CAAA;AAED,MAAM,MAAM,MAAM,GAAG;IACnB,EAAE,EAAE,MAAM,CAAA;IACV,MAAM,EAAE,OAAO,CAAA;IACf,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,MAAM,EAAE,YAAY,GAAG,IAAI,CAAA;IAC3B,OAAO,EAAE,aAAa,CAAA;IACtB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAA;IACtB,cAAc,EAAE,OAAO,CAAA;IACvB,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;IACpB,SAAS,EAAE,MAAM,CAAA;IACjB,YAAY,EAAE,MAAM,CAAA;IACpB,SAAS,EAAE,MAAM,CAAA;IACjB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAA;IACrB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB,cAAc,EAAE,MAAM,GAAG,IAAI,CAAA;IAC7B,aAAa,EAAE,MAAM,GAAG,IAAI,CAAA;IAC5B,uBAAuB,EAAE,MAAM,GAAG,IAAI,CAAA;IACtC,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IAEjB,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,UAAU,CAAC,EAAE,UAAU,CAAA;IACvB,IAAI,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;IAClB,OAAO,CAAC,EAAE,OAAO,GAAG,IAAI,CAAA;CACzB,CAAA;AAED,MAAM,MAAM,mBAAmB,GAAG,SAAS,GAAG,YAAY,GAAG,MAAM,GAAG,SAAS,CAAA;AAE/E,MAAM,MAAM,mBAAmB,GAAG;IAChC,SAAS,EAAE,MAAM,CAAA;IACjB,YAAY,EAAE,MAAM,CAAA;IACpB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,MAAM,CAAC,EAAE,YAAY,CAAA;CACtB,CAAA;AAED,MAAM,MAAM,mBAAmB,GAAG;IAChC,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACtB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB,MAAM,CAAC,EAAE,OAAO,CAAA;CACjB,CAAA;AAED;;;;;;;GAOG;AACH,MAAM,MAAM,uBAAuB,GAC/B;IAAE,GAAG,EAAE,MAAM,EAAE,CAAC;IAAC,cAAc,CAAC,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC;IAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;CAAE,GACxE;IAAE,mBAAmB,EAAE,IAAI,CAAC;IAAC,KAAK,EAAE;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,CAAA;CAAE,CAAA"}

package/dist/apis/users/UsersApi.cjs

@@ -1,8 +1,8 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
-const require_core_BaseCrudApi = require('../../core/BaseCrudApi.cjs');
+const require_core_ArchivableCrudApi = require('../../core/ArchivableCrudApi.cjs');
 
 //#region src/apis/users/UsersApi.ts
-var UsersApi = class extends require_core_BaseCrudApi.BaseCrudApi {
+var UsersApi = class extends require_core_ArchivableCrudApi.ArchivableCrudApi {
 	constructor(client) {
 		super(client, "/users");
 	}

package/dist/apis/users/UsersApi.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"UsersApi.cjs","names":["BaseCrudApi"],"sources":["../../../src/apis/users/UsersApi.ts"],"sourcesContent":["import type { ApiClient } from '../../core/ApiClient'\nimport { BaseCrudApi } from '../../core/BaseCrudApi'\nimport type { User, CreateUserPayload, UpdateUserPayload } from './types'\n\nexport class UsersApi extends BaseCrudApi<User, CreateUserPayload, UpdateUserPayload> {\n  constructor(client: ApiClient) {\n    super(client, '/users')\n  }\n}\n"],"mappings":";;;;AAIA,IAAa,WAAb,cAA8BA,qCAAwD;CACpF,YAAY,QAAmB;AAC7B,QAAM,QAAQ,SAAS"}
+{"version":3,"file":"UsersApi.cjs","names":["ArchivableCrudApi"],"sources":["../../../src/apis/users/UsersApi.ts"],"sourcesContent":["import type { ApiClient } from '../../core/ApiClient'\nimport { ArchivableCrudApi } from '../../core/ArchivableCrudApi'\nimport type { User, CreateUserPayload, UpdateUserPayload } from './types'\n\nexport class UsersApi extends ArchivableCrudApi<User, CreateUserPayload, UpdateUserPayload> {\n  constructor(client: ApiClient) {\n    super(client, '/users')\n  }\n}\n"],"mappings":";;;;AAIA,IAAa,WAAb,cAA8BA,iDAA8D;CAC1F,YAAY,QAAmB;AAC7B,QAAM,QAAQ,SAAS"}

package/dist/apis/users/UsersApi.d.ts

@@ -1,7 +1,7 @@
 import type { ApiClient } from '../../core/ApiClient';
-import { BaseCrudApi } from '../../core/BaseCrudApi';
+import { ArchivableCrudApi } from '../../core/ArchivableCrudApi';
 import type { User, CreateUserPayload, UpdateUserPayload } from './types';
-export declare class UsersApi extends BaseCrudApi<User, CreateUserPayload, UpdateUserPayload> {
+export declare class UsersApi extends ArchivableCrudApi<User, CreateUserPayload, UpdateUserPayload> {
     constructor(client: ApiClient);
 }
 //# sourceMappingURL=UsersApi.d.ts.map

package/dist/apis/users/UsersApi.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"UsersApi.d.ts","sourceRoot":"","sources":["../../../src/apis/users/UsersApi.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAA;AACrD,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAA;AACpD,OAAO,KAAK,EAAE,IAAI,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAA;AAEzE,qBAAa,QAAS,SAAQ,WAAW,CAAC,IAAI,EAAE,iBAAiB,EAAE,iBAAiB,CAAC;gBACvE,MAAM,EAAE,SAAS;CAG9B"}
+{"version":3,"file":"UsersApi.d.ts","sourceRoot":"","sources":["../../../src/apis/users/UsersApi.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAA;AACrD,OAAO,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAA;AAChE,OAAO,KAAK,EAAE,IAAI,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAA;AAEzE,qBAAa,QAAS,SAAQ,iBAAiB,CAAC,IAAI,EAAE,iBAAiB,EAAE,iBAAiB,CAAC;gBAC7E,MAAM,EAAE,SAAS;CAG9B"}

package/dist/apis/users/UsersApi.mjs

@@ -1,7 +1,7 @@
-import { BaseCrudApi } from "../../core/BaseCrudApi.mjs";
+import { ArchivableCrudApi } from "../../core/ArchivableCrudApi.mjs";
 
 //#region src/apis/users/UsersApi.ts
-var UsersApi = class extends BaseCrudApi {
+var UsersApi = class extends ArchivableCrudApi {
 	constructor(client) {
 		super(client, "/users");
 	}

package/dist/apis/users/UsersApi.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"UsersApi.mjs","names":[],"sources":["../../../src/apis/users/UsersApi.ts"],"sourcesContent":["import type { ApiClient } from '../../core/ApiClient'\nimport { BaseCrudApi } from '../../core/BaseCrudApi'\nimport type { User, CreateUserPayload, UpdateUserPayload } from './types'\n\nexport class UsersApi extends BaseCrudApi<User, CreateUserPayload, UpdateUserPayload> {\n  constructor(client: ApiClient) {\n    super(client, '/users')\n  }\n}\n"],"mappings":";;;AAIA,IAAa,WAAb,cAA8B,YAAwD;CACpF,YAAY,QAAmB;AAC7B,QAAM,QAAQ,SAAS"}
+{"version":3,"file":"UsersApi.mjs","names":[],"sources":["../../../src/apis/users/UsersApi.ts"],"sourcesContent":["import type { ApiClient } from '../../core/ApiClient'\nimport { ArchivableCrudApi } from '../../core/ArchivableCrudApi'\nimport type { User, CreateUserPayload, UpdateUserPayload } from './types'\n\nexport class UsersApi extends ArchivableCrudApi<User, CreateUserPayload, UpdateUserPayload> {\n  constructor(client: ApiClient) {\n    super(client, '/users')\n  }\n}\n"],"mappings":";;;AAIA,IAAa,WAAb,cAA8B,kBAA8D;CAC1F,YAAY,QAAmB;AAC7B,QAAM,QAAQ,SAAS"}

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

@@ -60,5 +60,6 @@ export type UpdateUserPayload = {
     timetableId?: string | null;
     preferences?: UserPreferences;
     language?: string;
+    archivedAt?: string | null;
 };
 //# sourceMappingURL=types.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/apis/users/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAA;AACtD,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,gBAAgB,CAAA;AAC1C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAA;AAEnD,MAAM,MAAM,UAAU,GAAG,QAAQ,GAAG,SAAS,GAAG,MAAM,CAAA;AAEtD,MAAM,MAAM,eAAe,GAAG;IAC5B,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,cAAc,CAAC,EAAE,OAAO,CAAA;CACzB,CAAA;AAED,MAAM,MAAM,IAAI,GAAG;IACjB,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;IACb,WAAW,EAAE,MAAM,GAAG,IAAI,CAAA;IAC1B,MAAM,EAAE,MAAM,GAAG,IAAI,CAAA;IACrB,YAAY,EAAE,OAAO,CAAA;IACrB,YAAY,EAAE,OAAO,CAAA;IACrB,MAAM,EAAE,OAAO,CAAA;IACf,QAAQ,EAAE,MAAM,CAAA;IAChB,YAAY,EAAE,OAAO,CAAA;IACrB,MAAM,EAAE,UAAU,CAAA;IAClB,aAAa,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,IAAI,CAAA;IAC5C,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB,oBAAoB,EAAE,OAAO,CAAA;IAC7B,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAA;IAChC,aAAa,EAAE,OAAO,GAAG,IAAI,CAAA;IAC7B,WAAW,EAAE,eAAe,CAAA;IAC5B,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,SAAS,EAAE,MAAM,CAAA;IACjB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAA;IAC1B,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IAExB,SAAS,CAAC,EAAE,SAAS,GAAG,IAAI,CAAA;IAC5B,KAAK,CAAC,EAAE,IAAI,EAAE,CAAA;IACd,WAAW,CAAC,EAAE,UAAU,EAAE,CAAA;CAC3B,CAAA;AAED,MAAM,MAAM,iBAAiB,GAAG,WAAW,GAAG,OAAO,GAAG,aAAa,CAAA;AAErE,MAAM,MAAM,iBAAiB,GAAG;IAC9B,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;IACb,QAAQ,EAAE,MAAM,CAAA;IAChB,oBAAoB,EAAE,MAAM,CAAA;IAC5B,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,YAAY,CAAC,EAAE,OAAO,CAAA;IACtB,KAAK,CAAC,EAAE,MAAM,EAAE,CAAA;IAChB,WAAW,CAAC,EAAE,MAAM,EAAE,CAAA;IACtB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAA;IACnB,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB,CAAA;AAED,MAAM,MAAM,iBAAiB,GAAG;IAC9B,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACtB,YAAY,CAAC,EAAE,OAAO,CAAA;IACtB,KAAK,CAAC,EAAE,MAAM,EAAE,CAAA;IAChB,WAAW,CAAC,EAAE,MAAM,EAAE,CAAA;IACtB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAA;IACnB,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B,WAAW,CAAC,EAAE,eAAe,CAAA;IAC7B,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB,CAAA"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/apis/users/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAA;AACtD,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,gBAAgB,CAAA;AAC1C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAA;AAEnD,MAAM,MAAM,UAAU,GAAG,QAAQ,GAAG,SAAS,GAAG,MAAM,CAAA;AAEtD,MAAM,MAAM,eAAe,GAAG;IAC5B,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,cAAc,CAAC,EAAE,OAAO,CAAA;CACzB,CAAA;AAED,MAAM,MAAM,IAAI,GAAG;IACjB,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;IACb,WAAW,EAAE,MAAM,GAAG,IAAI,CAAA;IAC1B,MAAM,EAAE,MAAM,GAAG,IAAI,CAAA;IACrB,YAAY,EAAE,OAAO,CAAA;IACrB,YAAY,EAAE,OAAO,CAAA;IACrB,MAAM,EAAE,OAAO,CAAA;IACf,QAAQ,EAAE,MAAM,CAAA;IAChB,YAAY,EAAE,OAAO,CAAA;IACrB,MAAM,EAAE,UAAU,CAAA;IAClB,aAAa,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,IAAI,CAAA;IAC5C,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB,oBAAoB,EAAE,OAAO,CAAA;IAC7B,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAA;IAChC,aAAa,EAAE,OAAO,GAAG,IAAI,CAAA;IAC7B,WAAW,EAAE,eAAe,CAAA;IAC5B,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,SAAS,EAAE,MAAM,CAAA;IACjB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAA;IAC1B,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IAExB,SAAS,CAAC,EAAE,SAAS,GAAG,IAAI,CAAA;IAC5B,KAAK,CAAC,EAAE,IAAI,EAAE,CAAA;IACd,WAAW,CAAC,EAAE,UAAU,EAAE,CAAA;CAC3B,CAAA;AAED,MAAM,MAAM,iBAAiB,GAAG,WAAW,GAAG,OAAO,GAAG,aAAa,CAAA;AAErE,MAAM,MAAM,iBAAiB,GAAG;IAC9B,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;IACb,QAAQ,EAAE,MAAM,CAAA;IAChB,oBAAoB,EAAE,MAAM,CAAA;IAC5B,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,YAAY,CAAC,EAAE,OAAO,CAAA;IACtB,KAAK,CAAC,EAAE,MAAM,EAAE,CAAA;IAChB,WAAW,CAAC,EAAE,MAAM,EAAE,CAAA;IACtB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAA;IACnB,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB,CAAA;AAED,MAAM,MAAM,iBAAiB,GAAG;IAC9B,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACtB,YAAY,CAAC,EAAE,OAAO,CAAA;IACtB,KAAK,CAAC,EAAE,MAAM,EAAE,CAAA;IAChB,WAAW,CAAC,EAAE,MAAM,EAAE,CAAA;IACtB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAA;IACnB,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B,WAAW,CAAC,EAAE,eAAe,CAAA;IAC7B,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CAC3B,CAAA"}

package/dist/core/ArchivableCrudApi.cjs

@@ -0,0 +1,39 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
+const require_core_BaseCrudApi = require('./BaseCrudApi.cjs');
+
+//#region src/core/ArchivableCrudApi.ts
+/**
+* CRUD base for resources that support soft-delete via an `archivedAt` timestamp
+* (PUT `${basePath}/${id}` with `{ archivedAt }`). Adds `archive`/`unarchive` on
+* top of {@link BaseCrudApi}.
+*
+* Only extend this for resources whose archive write mechanism is `archivedAt`.
+* Resources that archive through a different field (e.g. cards use `isArchived`)
+* or a dedicated endpoint (e.g. ticket-topics POST `/archive`) must NOT use this
+* base and should implement `archive`/`unarchive` themselves.
+*/
+var ArchivableCrudApi = class extends require_core_BaseCrudApi.BaseCrudApi {
+	constructor(client, basePath) {
+		super(client, basePath);
+		this.archive = this.archive.bind(this);
+		this.unarchive = this.unarchive.bind(this);
+	}
+	/**
+	* Archives a resource (soft-delete) by setting `archivedAt` to the current time.
+	* @permissions $resourceName.update
+	*/
+	archive(id, headers) {
+		return this.updateById(id, { archivedAt: (/* @__PURE__ */ new Date()).toISOString() }, headers);
+	}
+	/**
+	* Restores a previously archived resource by clearing `archivedAt`.
+	* @permissions $resourceName.update
+	*/
+	unarchive(id, headers) {
+		return this.updateById(id, { archivedAt: null }, headers);
+	}
+};
+
+//#endregion
+exports.ArchivableCrudApi = ArchivableCrudApi;
+//# sourceMappingURL=ArchivableCrudApi.cjs.map

package/dist/core/ArchivableCrudApi.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"ArchivableCrudApi.cjs","names":["BaseCrudApi"],"sources":["../../src/core/ArchivableCrudApi.ts"],"sourcesContent":["import type { ApiClient } from './ApiClient'\nimport { BaseCrudApi } from './BaseCrudApi'\nimport type { ListQuery } from './types'\n\n/**\n * CRUD base for resources that support soft-delete via an `archivedAt` timestamp\n * (PUT `${basePath}/${id}` with `{ archivedAt }`). Adds `archive`/`unarchive` on\n * top of {@link BaseCrudApi}.\n *\n * Only extend this for resources whose archive write mechanism is `archivedAt`.\n * Resources that archive through a different field (e.g. cards use `isArchived`)\n * or a dedicated endpoint (e.g. ticket-topics POST `/archive`) must NOT use this\n * base and should implement `archive`/`unarchive` themselves.\n */\nexport class ArchivableCrudApi<\n  TResponse,\n  TCreate,\n  TUpdate extends { archivedAt?: string | null } = TCreate & { archivedAt?: string | null },\n  TQuery extends ListQuery<TResponse> = ListQuery<TResponse>,\n> extends BaseCrudApi<TResponse, TCreate, TUpdate, TQuery> {\n  constructor(client: ApiClient, basePath: string) {\n    super(client, basePath)\n    this.archive = this.archive.bind(this)\n    this.unarchive = this.unarchive.bind(this)\n  }\n\n  /**\n   * Archives a resource (soft-delete) by setting `archivedAt` to the current time.\n   * @permissions $resourceName.update\n   */\n  archive(id: string, headers?: Record<string, string>): Promise<TResponse> {\n    return this.updateById(id, { archivedAt: new Date().toISOString() } as TUpdate, headers)\n  }\n\n  /**\n   * Restores a previously archived resource by clearing `archivedAt`.\n   * @permissions $resourceName.update\n   */\n  unarchive(id: string, headers?: Record<string, string>): Promise<TResponse> {\n    return this.updateById(id, { archivedAt: null } as TUpdate, headers)\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;AAcA,IAAa,oBAAb,cAKUA,qCAAiD;CACzD,YAAY,QAAmB,UAAkB;AAC/C,QAAM,QAAQ,SAAS;AACvB,OAAK,UAAU,KAAK,QAAQ,KAAK,KAAK;AACtC,OAAK,YAAY,KAAK,UAAU,KAAK,KAAK;;;;;;CAO5C,QAAQ,IAAY,SAAsD;AACxE,SAAO,KAAK,WAAW,IAAI,EAAE,6BAAY,IAAI,MAAM,EAAC,aAAa,EAAE,EAAa,QAAQ;;;;;;CAO1F,UAAU,IAAY,SAAsD;AAC1E,SAAO,KAAK,WAAW,IAAI,EAAE,YAAY,MAAM,EAAa,QAAQ"}

package/dist/core/ArchivableCrudApi.d.ts

@@ -0,0 +1,31 @@
+import type { ApiClient } from './ApiClient';
+import { BaseCrudApi } from './BaseCrudApi';
+import type { ListQuery } from './types';
+/**
+ * CRUD base for resources that support soft-delete via an `archivedAt` timestamp
+ * (PUT `${basePath}/${id}` with `{ archivedAt }`). Adds `archive`/`unarchive` on
+ * top of {@link BaseCrudApi}.
+ *
+ * Only extend this for resources whose archive write mechanism is `archivedAt`.
+ * Resources that archive through a different field (e.g. cards use `isArchived`)
+ * or a dedicated endpoint (e.g. ticket-topics POST `/archive`) must NOT use this
+ * base and should implement `archive`/`unarchive` themselves.
+ */
+export declare class ArchivableCrudApi<TResponse, TCreate, TUpdate extends {
+    archivedAt?: string | null;
+} = TCreate & {
+    archivedAt?: string | null;
+}, TQuery extends ListQuery<TResponse> = ListQuery<TResponse>> extends BaseCrudApi<TResponse, TCreate, TUpdate, TQuery> {
+    constructor(client: ApiClient, basePath: string);
+    /**
+     * Archives a resource (soft-delete) by setting `archivedAt` to the current time.
+     * @permissions $resourceName.update
+     */
+    archive(id: string, headers?: Record<string, string>): Promise<TResponse>;
+    /**
+     * Restores a previously archived resource by clearing `archivedAt`.
+     * @permissions $resourceName.update
+     */
+    unarchive(id: string, headers?: Record<string, string>): Promise<TResponse>;
+}
+//# sourceMappingURL=ArchivableCrudApi.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ArchivableCrudApi.d.ts","sourceRoot":"","sources":["../../src/core/ArchivableCrudApi.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AAC5C,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAC3C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,SAAS,CAAA;AAExC;;;;;;;;;GASG;AACH,qBAAa,iBAAiB,CAC5B,SAAS,EACT,OAAO,EACP,OAAO,SAAS;IAAE,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CAAE,GAAG,OAAO,GAAG;IAAE,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CAAE,EACzF,MAAM,SAAS,SAAS,CAAC,SAAS,CAAC,GAAG,SAAS,CAAC,SAAS,CAAC,CAC1D,SAAQ,WAAW,CAAC,SAAS,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,CAAC;gBAC5C,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM;IAM/C;;;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,SAAS,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,SAAS,CAAC;CAG5E"}

package/dist/core/ArchivableCrudApi.mjs

@@ -0,0 +1,38 @@
+import { BaseCrudApi } from "./BaseCrudApi.mjs";
+
+//#region src/core/ArchivableCrudApi.ts
+/**
+* CRUD base for resources that support soft-delete via an `archivedAt` timestamp
+* (PUT `${basePath}/${id}` with `{ archivedAt }`). Adds `archive`/`unarchive` on
+* top of {@link BaseCrudApi}.
+*
+* Only extend this for resources whose archive write mechanism is `archivedAt`.
+* Resources that archive through a different field (e.g. cards use `isArchived`)
+* or a dedicated endpoint (e.g. ticket-topics POST `/archive`) must NOT use this
+* base and should implement `archive`/`unarchive` themselves.
+*/
+var ArchivableCrudApi = class extends BaseCrudApi {
+	constructor(client, basePath) {
+		super(client, basePath);
+		this.archive = this.archive.bind(this);
+		this.unarchive = this.unarchive.bind(this);
+	}
+	/**
+	* Archives a resource (soft-delete) by setting `archivedAt` to the current time.
+	* @permissions $resourceName.update
+	*/
+	archive(id, headers) {
+		return this.updateById(id, { archivedAt: (/* @__PURE__ */ new Date()).toISOString() }, headers);
+	}
+	/**
+	* Restores a previously archived resource by clearing `archivedAt`.
+	* @permissions $resourceName.update
+	*/
+	unarchive(id, headers) {
+		return this.updateById(id, { archivedAt: null }, headers);
+	}
+};
+
+//#endregion
+export { ArchivableCrudApi };
+//# sourceMappingURL=ArchivableCrudApi.mjs.map

package/dist/core/ArchivableCrudApi.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"ArchivableCrudApi.mjs","names":[],"sources":["../../src/core/ArchivableCrudApi.ts"],"sourcesContent":["import type { ApiClient } from './ApiClient'\nimport { BaseCrudApi } from './BaseCrudApi'\nimport type { ListQuery } from './types'\n\n/**\n * CRUD base for resources that support soft-delete via an `archivedAt` timestamp\n * (PUT `${basePath}/${id}` with `{ archivedAt }`). Adds `archive`/`unarchive` on\n * top of {@link BaseCrudApi}.\n *\n * Only extend this for resources whose archive write mechanism is `archivedAt`.\n * Resources that archive through a different field (e.g. cards use `isArchived`)\n * or a dedicated endpoint (e.g. ticket-topics POST `/archive`) must NOT use this\n * base and should implement `archive`/`unarchive` themselves.\n */\nexport class ArchivableCrudApi<\n  TResponse,\n  TCreate,\n  TUpdate extends { archivedAt?: string | null } = TCreate & { archivedAt?: string | null },\n  TQuery extends ListQuery<TResponse> = ListQuery<TResponse>,\n> extends BaseCrudApi<TResponse, TCreate, TUpdate, TQuery> {\n  constructor(client: ApiClient, basePath: string) {\n    super(client, basePath)\n    this.archive = this.archive.bind(this)\n    this.unarchive = this.unarchive.bind(this)\n  }\n\n  /**\n   * Archives a resource (soft-delete) by setting `archivedAt` to the current time.\n   * @permissions $resourceName.update\n   */\n  archive(id: string, headers?: Record<string, string>): Promise<TResponse> {\n    return this.updateById(id, { archivedAt: new Date().toISOString() } as TUpdate, headers)\n  }\n\n  /**\n   * Restores a previously archived resource by clearing `archivedAt`.\n   * @permissions $resourceName.update\n   */\n  unarchive(id: string, headers?: Record<string, string>): Promise<TResponse> {\n    return this.updateById(id, { archivedAt: null } as TUpdate, headers)\n  }\n}\n"],"mappings":";;;;;;;;;;;;;AAcA,IAAa,oBAAb,cAKU,YAAiD;CACzD,YAAY,QAAmB,UAAkB;AAC/C,QAAM,QAAQ,SAAS;AACvB,OAAK,UAAU,KAAK,QAAQ,KAAK,KAAK;AACtC,OAAK,YAAY,KAAK,UAAU,KAAK,KAAK;;;;;;CAO5C,QAAQ,IAAY,SAAsD;AACxE,SAAO,KAAK,WAAW,IAAI,EAAE,6BAAY,IAAI,MAAM,EAAC,aAAa,EAAE,EAAa,QAAQ;;;;;;CAO1F,UAAU,IAAY,SAAsD;AAC1E,SAAO,KAAK,WAAW,IAAI,EAAE,YAAY,MAAM,EAAa,QAAQ"}

package/dist/core/BaseCrudApi.cjs

@@ -11,6 +11,7 @@ var BaseCrudApi = class {
 		this.client = client;
 		this.basePath = basePath.replace(/\/$/, "");
 		this.getMany = this.getMany.bind(this);
+		this.getOne = this.getOne.bind(this);
 		this.getById = this.getById.bind(this);
 		this.create = this.create.bind(this);
 		this.updateById = this.updateById.bind(this);
@@ -21,6 +22,18 @@ var BaseCrudApi = class {
 		return this.client.get(`${this.basePath}${queryString}`, headers);
 	}
 	/**
+	* Returns the first resource matching the query, or `null` when none match.
+	* Convenience over `getMany` with `limit: 1`.
+	* @permissions $resourceName.view
+	*/
+	async getOne(query, headers) {
+		return (await this.getMany({
+			...query,
+			limit: 1,
+			paginate: false
+		}, headers))[0] ?? null;
+	}
+	/**
 	* Returns a single resource by ID.
 	* @permissions $resourceName.view
 	*/

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, 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  public readonly client: ApiClient\n  public 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,AAAgB;CAChB,AAAgB;CAEhB,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"}
+{"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  public readonly client: ApiClient\n  public 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.getOne = this.getOne.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 the first resource matching the query, or `null` when none match.\n   * Convenience over `getMany` with `limit: 1`.\n   * @permissions $resourceName.view\n   */\n  async getOne(query?: TQuery, headers?: Record<string, string>): Promise<TResponse | null> {\n    const results = await this.getMany(\n      { ...query, limit: 1, paginate: false } as TQuery & { paginate: false },\n      headers,\n    )\n    return results[0] ?? null\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,AAAgB;CAChB,AAAgB;CAEhB,YAAY,QAAmB,UAAkB;AAC/C,OAAK,SAAS;AACd,OAAK,WAAW,SAAS,QAAQ,OAAO,GAAG;AAC3C,OAAK,UAAU,KAAK,QAAQ,KAAK,KAAK;AACtC,OAAK,SAAS,KAAK,OAAO,KAAK,KAAK;AACpC,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;;;;;;;CAQH,MAAM,OAAO,OAAgB,SAA6D;AAKxF,UAJgB,MAAM,KAAK,QACzB;GAAE,GAAG;GAAO,OAAO;GAAG,UAAU;GAAO,EACvC,QACD,EACc,MAAM;;;;;;CAOvB,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

@@ -11,6 +11,12 @@ export declare class BaseCrudApi<TResponse, TCreate, TUpdate = TCreate, TQuery e
     getMany(query?: TQuery & {
         paginate?: true;
     }, headers?: Record<string, string>): Promise<Paginated<TResponse>>;
+    /**
+     * Returns the first resource matching the query, or `null` when none match.
+     * Convenience over `getMany` with `limit: 1`.
+     * @permissions $resourceName.view
+     */
+    getOne(query?: TQuery, headers?: Record<string, string>): Promise<TResponse | null>;
     /**
      * Returns a single resource by ID.
      * @permissions $resourceName.view

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,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,SAAgB,MAAM,EAAE,SAAS,CAAA;IACjC,SAAgB,QAAQ,EAAE,MAAM,CAAA;gBAEpB,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"}
+{"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,SAAgB,MAAM,EAAE,SAAS,CAAA;IACjC,SAAgB,QAAQ,EAAE,MAAM,CAAA;gBAEpB,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM;IAW/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;;;;OAIG;IACG,MAAM,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,SAAS,GAAG,IAAI,CAAC;IAQzF;;;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

@@ -8,6 +8,7 @@ var BaseCrudApi = class {
 		this.client = client;
 		this.basePath = basePath.replace(/\/$/, "");
 		this.getMany = this.getMany.bind(this);
+		this.getOne = this.getOne.bind(this);
 		this.getById = this.getById.bind(this);
 		this.create = this.create.bind(this);
 		this.updateById = this.updateById.bind(this);
@@ -18,6 +19,18 @@ var BaseCrudApi = class {
 		return this.client.get(`${this.basePath}${queryString}`, headers);
 	}
 	/**
+	* Returns the first resource matching the query, or `null` when none match.
+	* Convenience over `getMany` with `limit: 1`.
+	* @permissions $resourceName.view
+	*/
+	async getOne(query, headers) {
+		return (await this.getMany({
+			...query,
+			limit: 1,
+			paginate: false
+		}, headers))[0] ?? null;
+	}
+	/**
 	* Returns a single resource by ID.
 	* @permissions $resourceName.view
 	*/

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, 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  public readonly client: ApiClient\n  public 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,AAAgB;CAChB,AAAgB;CAEhB,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"}
+{"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  public readonly client: ApiClient\n  public 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.getOne = this.getOne.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 the first resource matching the query, or `null` when none match.\n   * Convenience over `getMany` with `limit: 1`.\n   * @permissions $resourceName.view\n   */\n  async getOne(query?: TQuery, headers?: Record<string, string>): Promise<TResponse | null> {\n    const results = await this.getMany(\n      { ...query, limit: 1, paginate: false } as TQuery & { paginate: false },\n      headers,\n    )\n    return results[0] ?? null\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,AAAgB;CAChB,AAAgB;CAEhB,YAAY,QAAmB,UAAkB;AAC/C,OAAK,SAAS;AACd,OAAK,WAAW,SAAS,QAAQ,OAAO,GAAG;AAC3C,OAAK,UAAU,KAAK,QAAQ,KAAK,KAAK;AACtC,OAAK,SAAS,KAAK,OAAO,KAAK,KAAK;AACpC,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;;;;;;;CAQH,MAAM,OAAO,OAAgB,SAA6D;AAKxF,UAJgB,MAAM,KAAK,QACzB;GAAE,GAAG;GAAO,OAAO;GAAG,UAAU;GAAO,EACvC,QACD,EACc,MAAM;;;;;;CAOvB,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.cjs

@@ -1,7 +1,9 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 const require_core_BaseApiClient = require('./BaseApiClient.cjs');
 const require_core_BaseCrudApi = require('./BaseCrudApi.cjs');
+const require_core_ArchivableCrudApi = require('./ArchivableCrudApi.cjs');
 
 exports.ApiError = require_core_BaseApiClient.ApiError;
+exports.ArchivableCrudApi = require_core_ArchivableCrudApi.ArchivableCrudApi;
 exports.BaseApiClient = require_core_BaseApiClient.BaseApiClient;
 exports.BaseCrudApi = require_core_BaseCrudApi.BaseCrudApi;

package/dist/core/index.d.ts

@@ -2,5 +2,6 @@ export type { ApiClient, HttpMethod } from './ApiClient';
 export { BaseApiClient, ApiError } from './BaseApiClient';
 export type { ValidationError } from './BaseApiClient';
 export { BaseCrudApi } from './BaseCrudApi';
+export { ArchivableCrudApi } from './ArchivableCrudApi';
 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,YAAY,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,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAA;AACvD,YAAY,EAAE,WAAW,EAAE,WAAW,EAAE,SAAS,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,SAAS,CAAA"}

package/dist/core/index.mjs

@@ -1,4 +1,5 @@
 import { ApiError, BaseApiClient } from "./BaseApiClient.mjs";
 import { BaseCrudApi } from "./BaseCrudApi.mjs";
+import { ArchivableCrudApi } from "./ArchivableCrudApi.mjs";
 
-export { ApiError, BaseApiClient, BaseCrudApi };
+export { ApiError, ArchivableCrudApi, BaseApiClient, BaseCrudApi };

package/dist/index.cjs

@@ -1,8 +1,10 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 const require_core_BaseApiClient = require('./core/BaseApiClient.cjs');
 const require_core_BaseCrudApi = require('./core/BaseCrudApi.cjs');
+const require_core_ArchivableCrudApi = require('./core/ArchivableCrudApi.cjs');
 require('./core/index.cjs');
 
 exports.ApiError = require_core_BaseApiClient.ApiError;
+exports.ArchivableCrudApi = require_core_ArchivableCrudApi.ArchivableCrudApi;
 exports.BaseApiClient = require_core_BaseApiClient.BaseApiClient;
 exports.BaseCrudApi = require_core_BaseCrudApi.BaseCrudApi;

package/dist/index.mjs

@@ -1,5 +1,6 @@
 import { ApiError, BaseApiClient } from "./core/BaseApiClient.mjs";
 import { BaseCrudApi } from "./core/BaseCrudApi.mjs";
+import { ArchivableCrudApi } from "./core/ArchivableCrudApi.mjs";
 import "./core/index.mjs";
 
-export { ApiError, BaseApiClient, BaseCrudApi };
+export { ApiError, ArchivableCrudApi, BaseApiClient, BaseCrudApi };

package/package.json

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

package/src/apis/contactBlockLists/types.ts

@@ -23,7 +23,8 @@ export type ContactBlockListRelationships = 'user'
 
 export type CreateContactBlockListPayload = {
   name: string
-  contacts: string[]
+  /** ID of an uploaded CSV file (POST /files/create-to-upload, attachedType 'contact_block_list.file'). */
+  fileId: string
   defaultDDI?: string
 }
 

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

@@ -341,6 +341,30 @@ describe('ContactsApi', () => {
     })
   })
 
+  describe('transferTicket', () => {
+    it('calls client.post with /contacts/:id/ticket/transfer and payload', async () => {
+      vi.mocked(client.post).mockResolvedValue({ ok: true })
+      const result = await api.transferTicket('c1', { departmentId: 'd1' })
+      expect(client.post).toHaveBeenCalledWith(
+        '/contacts/c1/ticket/transfer',
+        { departmentId: 'd1' },
+        undefined,
+      )
+      expect(result).toEqual({ ok: true })
+    })
+
+    it('includes optional userId and forwards custom headers', async () => {
+      vi.mocked(client.post).mockResolvedValue({ ok: true })
+      const headers = { 'X-Custom': 'h' }
+      await api.transferTicket('c1', { departmentId: 'd1', userId: 'u1' }, headers)
+      expect(client.post).toHaveBeenCalledWith(
+        '/contacts/c1/ticket/transfer',
+        { departmentId: 'd1', userId: 'u1' },
+        headers,
+      )
+    })
+  })
+
   // ── Error propagation ────────────────────────────────────────────
 
   describe('error propagation', () => {

package/src/apis/contacts/ContactsApi.ts

@@ -9,6 +9,7 @@ import type {
   CreateContactPayload,
   ExistsContactsParams,
   ExportTemplatePayload,
+  TransferTicketPayload,
   UpdateContactPayload,
 } from './types'
 
@@ -102,4 +103,21 @@ export class ContactsApi extends BaseCrudApi<Contact, CreateContactPayload, Upda
       headers,
     )
   }
+
+  /**
+   * Opens (or transfers) the contact's ticket to a department, and optionally a user.
+   * This is the real ticket-open flow used by the UI — there is no `POST /tickets`.
+   * @permissions tickets.transfer.all OR tickets.transfer.me
+   */
+  transferTicket(
+    contactId: string,
+    payload: TransferTicketPayload,
+    headers?: Record<string, string>,
+  ): Promise<unknown> {
+    return this.client.post<unknown, TransferTicketPayload>(
+      `${this.basePath}/${contactId}/ticket/transfer`,
+      payload,
+      headers,
+    )
+  }
 }

package/src/apis/contacts/types.ts

@@ -153,6 +153,8 @@ export type CreateContactPayload = {
   name?: string
   serviceId: string
   idFromService?: string
+  /** Top-level convenience input; the backend copies it into `data.number`. */
+  number?: string
   defaultDepartmentId?: string
   defaultUserId?: string
   data?: ContactData
@@ -170,6 +172,8 @@ export type UpdateContactPayload = {
   note?: string | null
   isSilenced?: boolean
   block?: boolean
+  /** Tag IDs to associate with the contact. */
+  tagIds?: string[]
 }
 
 export type ExportTemplatePayload = {
@@ -187,3 +191,16 @@ export type ExistsContactsParams = {
 }
 
 export type CountMediaResult = Record<string, number>
+
+/**
+ * Body for `POST /contacts/:id/ticket/transfer`. Opens or transfers the contact's
+ * ticket. The backend only reads these fields; it does not enforce a 24h window or template.
+ */
+export type TransferTicketPayload = {
+  departmentId: string
+  userId?: string
+  comments?: string
+  kanbanCardColumnId?: string
+  kanbanCardSubject?: string
+  initialMessage?: string
+}

package/src/apis/departments/DepartmentsApi.ts

@@ -1,8 +1,8 @@
 import type { ApiClient } from '../../core/ApiClient'
-import { BaseCrudApi } from '../../core/BaseCrudApi'
+import { ArchivableCrudApi } from '../../core/ArchivableCrudApi'
 import type { Department, CreateDepartmentPayload, UpdateDepartmentPayload } from './types'
 
-export class DepartmentsApi extends BaseCrudApi<
+export class DepartmentsApi extends ArchivableCrudApi<
   Department,
   CreateDepartmentPayload,
   UpdateDepartmentPayload

package/src/apis/departments/types.ts

@@ -24,4 +24,5 @@ export type CreateDepartmentPayload = {
 export type UpdateDepartmentPayload = {
   name?: string
   distributionId?: string | null
+  archivedAt?: string | null
 }

package/src/apis/kanbanBoards/types.ts

@@ -19,6 +19,8 @@ export type KanbanBoardRelationships = 'departments' | 'columns'
 export type CreateKanbanBoardPayload = {
   name: string
   timeoutAlertEnabled?: boolean
+  /** Department IDs to link to the board. Required by the backend on creation. */
+  departmentIds: string[]
 }
 
 export type UpdateKanbanBoardPayload = {

package/src/apis/services/ServicesApi.ts

@@ -1,8 +1,12 @@
 import type { ApiClient } from '../../core/ApiClient'
-import { BaseCrudApi } from '../../core/BaseCrudApi'
+import { ArchivableCrudApi } from '../../core/ArchivableCrudApi'
 import type { Service, CreateServicePayload, UpdateServicePayload } from './types'
 
-export class ServicesApi extends BaseCrudApi<Service, CreateServicePayload, UpdateServicePayload> {
+export class ServicesApi extends ArchivableCrudApi<
+  Service,
+  CreateServicePayload,
+  UpdateServicePayload
+> {
   constructor(client: ApiClient) {
     super(client, '/services')
   }

package/src/apis/services/types.ts

@@ -219,4 +219,5 @@ export type UpdateServicePayload = {
   settings?: ServiceSettings
   defaultDepartmentId?: string | null
   botId?: string | null
+  archivedAt?: string | null
 }

package/src/apis/tags/types.ts

@@ -19,6 +19,8 @@ export type TagRelationships = 'contacts' | 'departments'
 export type CreateTagPayload = {
   label: string
   backgroundColor?: string
+  /** Department IDs to link to the tag on creation. */
+  departments?: string[]
 }
 
 export type UpdateTagPayload = {