@ikatec/digisac-api-sdk 4.3.0 → 4.4.0

package/dist/apis/tags/TagsApi.cjs

@@ -6,6 +6,29 @@ var TagsApi = class extends require_core_BaseCrudApi.BaseCrudApi {
 	constructor(client) {
 		super(client, "/tags");
 	}
+	/**
+	* Adds the tag to every contact of the account that matches the selection. Resolves to `'OK'`.
+	* @permissions tags.view
+	*/
+	attachContacts(id, body, headers) {
+		return this.client.post(`${this.basePath}/${id}/contacts`, body, headers);
+	}
+	/**
+	* Removes the tag from every contact of the account that matches the selection. Resolves to
+	* `'OK'`.
+	* @permissions tags.view OR tags.destroy
+	*/
+	detachContacts(id, body, headers) {
+		return this.client.request("DELETE", `${this.basePath}/${id}/contacts`, body, headers);
+	}
+	/**
+	* Links several tags to the given departments. Resolves to `'OK'`. A tag without departments
+	* is already available to all of them and is left unchanged.
+	* @permissions tags.view
+	*/
+	attachManyToDepartments(body, headers) {
+		return this.client.post(`${this.basePath}/attach-many-departments`, body, headers);
+	}
 };
 
 //#endregion

package/dist/apis/tags/TagsApi.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"TagsApi.cjs","names":["BaseCrudApi"],"sources":["../../../src/apis/tags/TagsApi.ts"],"sourcesContent":["import type { ApiClient } from '../../core/ApiClient'\nimport { BaseCrudApi } from '../../core/BaseCrudApi'\nimport type { Tag, CreateTagPayload, UpdateTagPayload } from './types'\n\nexport class TagsApi extends BaseCrudApi<Tag, CreateTagPayload, UpdateTagPayload> {\n  constructor(client: ApiClient) {\n    super(client, '/tags')\n  }\n}\n"],"mappings":";;;;AAIA,IAAa,UAAb,cAA6BA,qCAAqD;CAChF,YAAY,QAAmB;AAC7B,QAAM,QAAQ,QAAQ"}
+{"version":3,"file":"TagsApi.cjs","names":["BaseCrudApi"],"sources":["../../../src/apis/tags/TagsApi.ts"],"sourcesContent":["import type { ApiClient } from '../../core/ApiClient'\nimport { BaseCrudApi } from '../../core/BaseCrudApi'\nimport type { ContactsSelection } from '../contacts/types'\nimport type {\n  AttachTagsToDepartmentsPayload,\n  CreateTagPayload,\n  Tag,\n  UpdateTagPayload,\n} from './types'\n\nexport class TagsApi extends BaseCrudApi<Tag, CreateTagPayload, UpdateTagPayload> {\n  constructor(client: ApiClient) {\n    super(client, '/tags')\n  }\n\n  /**\n   * Adds the tag to every contact of the account that matches the selection. Resolves to `'OK'`.\n   * @permissions tags.view\n   */\n  attachContacts(\n    id: string,\n    body: ContactsSelection,\n    headers?: Record<string, string>,\n  ): Promise<string> {\n    return this.client.post<string, ContactsSelection>(\n      `${this.basePath}/${id}/contacts`,\n      body,\n      headers,\n    )\n  }\n\n  /**\n   * Removes the tag from every contact of the account that matches the selection. Resolves to\n   * `'OK'`.\n   * @permissions tags.view OR tags.destroy\n   */\n  detachContacts(\n    id: string,\n    body: ContactsSelection,\n    headers?: Record<string, string>,\n  ): Promise<string> {\n    return this.client.request<string, ContactsSelection>(\n      'DELETE',\n      `${this.basePath}/${id}/contacts`,\n      body,\n      headers,\n    )\n  }\n\n  /**\n   * Links several tags to the given departments. Resolves to `'OK'`. A tag without departments\n   * is already available to all of them and is left unchanged.\n   * @permissions tags.view\n   */\n  attachManyToDepartments(\n    body: AttachTagsToDepartmentsPayload,\n    headers?: Record<string, string>,\n  ): Promise<string> {\n    return this.client.post<string, AttachTagsToDepartmentsPayload>(\n      `${this.basePath}/attach-many-departments`,\n      body,\n      headers,\n    )\n  }\n}\n"],"mappings":";;;;AAUA,IAAa,UAAb,cAA6BA,qCAAqD;CAChF,YAAY,QAAmB;AAC7B,QAAM,QAAQ,QAAQ;;;;;;CAOxB,eACE,IACA,MACA,SACiB;AACjB,SAAO,KAAK,OAAO,KACjB,GAAG,KAAK,SAAS,GAAG,GAAG,YACvB,MACA,QACD;;;;;;;CAQH,eACE,IACA,MACA,SACiB;AACjB,SAAO,KAAK,OAAO,QACjB,UACA,GAAG,KAAK,SAAS,GAAG,GAAG,YACvB,MACA,QACD;;;;;;;CAQH,wBACE,MACA,SACiB;AACjB,SAAO,KAAK,OAAO,KACjB,GAAG,KAAK,SAAS,2BACjB,MACA,QACD"}

package/dist/apis/tags/TagsApi.d.ts

@@ -1,7 +1,25 @@
 import type { ApiClient } from '../../core/ApiClient';
 import { BaseCrudApi } from '../../core/BaseCrudApi';
-import type { Tag, CreateTagPayload, UpdateTagPayload } from './types';
+import type { ContactsSelection } from '../contacts/types';
+import type { AttachTagsToDepartmentsPayload, CreateTagPayload, Tag, UpdateTagPayload } from './types';
 export declare class TagsApi extends BaseCrudApi<Tag, CreateTagPayload, UpdateTagPayload> {
     constructor(client: ApiClient);
+    /**
+     * Adds the tag to every contact of the account that matches the selection. Resolves to `'OK'`.
+     * @permissions tags.view
+     */
+    attachContacts(id: string, body: ContactsSelection, headers?: Record<string, string>): Promise<string>;
+    /**
+     * Removes the tag from every contact of the account that matches the selection. Resolves to
+     * `'OK'`.
+     * @permissions tags.view OR tags.destroy
+     */
+    detachContacts(id: string, body: ContactsSelection, headers?: Record<string, string>): Promise<string>;
+    /**
+     * Links several tags to the given departments. Resolves to `'OK'`. A tag without departments
+     * is already available to all of them and is left unchanged.
+     * @permissions tags.view
+     */
+    attachManyToDepartments(body: AttachTagsToDepartmentsPayload, headers?: Record<string, string>): Promise<string>;
 }
 //# sourceMappingURL=TagsApi.d.ts.map

package/dist/apis/tags/TagsApi.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"TagsApi.d.ts","sourceRoot":"","sources":["../../../src/apis/tags/TagsApi.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAA;AACrD,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAA;AACpD,OAAO,KAAK,EAAE,GAAG,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAA;AAEtE,qBAAa,OAAQ,SAAQ,WAAW,CAAC,GAAG,EAAE,gBAAgB,EAAE,gBAAgB,CAAC;gBACnE,MAAM,EAAE,SAAS;CAG9B"}
+{"version":3,"file":"TagsApi.d.ts","sourceRoot":"","sources":["../../../src/apis/tags/TagsApi.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAA;AACrD,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAA;AACpD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAA;AAC1D,OAAO,KAAK,EACV,8BAA8B,EAC9B,gBAAgB,EAChB,GAAG,EACH,gBAAgB,EACjB,MAAM,SAAS,CAAA;AAEhB,qBAAa,OAAQ,SAAQ,WAAW,CAAC,GAAG,EAAE,gBAAgB,EAAE,gBAAgB,CAAC;gBACnE,MAAM,EAAE,SAAS;IAI7B;;;OAGG;IACH,cAAc,CACZ,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,iBAAiB,EACvB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,MAAM,CAAC;IAQlB;;;;OAIG;IACH,cAAc,CACZ,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,iBAAiB,EACvB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,MAAM,CAAC;IASlB;;;;OAIG;IACH,uBAAuB,CACrB,IAAI,EAAE,8BAA8B,EACpC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,MAAM,CAAC;CAOnB"}

package/dist/apis/tags/TagsApi.mjs

@@ -5,6 +5,29 @@ var TagsApi = class extends BaseCrudApi {
 	constructor(client) {
 		super(client, "/tags");
 	}
+	/**
+	* Adds the tag to every contact of the account that matches the selection. Resolves to `'OK'`.
+	* @permissions tags.view
+	*/
+	attachContacts(id, body, headers) {
+		return this.client.post(`${this.basePath}/${id}/contacts`, body, headers);
+	}
+	/**
+	* Removes the tag from every contact of the account that matches the selection. Resolves to
+	* `'OK'`.
+	* @permissions tags.view OR tags.destroy
+	*/
+	detachContacts(id, body, headers) {
+		return this.client.request("DELETE", `${this.basePath}/${id}/contacts`, body, headers);
+	}
+	/**
+	* Links several tags to the given departments. Resolves to `'OK'`. A tag without departments
+	* is already available to all of them and is left unchanged.
+	* @permissions tags.view
+	*/
+	attachManyToDepartments(body, headers) {
+		return this.client.post(`${this.basePath}/attach-many-departments`, body, headers);
+	}
 };
 
 //#endregion

package/dist/apis/tags/TagsApi.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"TagsApi.mjs","names":[],"sources":["../../../src/apis/tags/TagsApi.ts"],"sourcesContent":["import type { ApiClient } from '../../core/ApiClient'\nimport { BaseCrudApi } from '../../core/BaseCrudApi'\nimport type { Tag, CreateTagPayload, UpdateTagPayload } from './types'\n\nexport class TagsApi extends BaseCrudApi<Tag, CreateTagPayload, UpdateTagPayload> {\n  constructor(client: ApiClient) {\n    super(client, '/tags')\n  }\n}\n"],"mappings":";;;AAIA,IAAa,UAAb,cAA6B,YAAqD;CAChF,YAAY,QAAmB;AAC7B,QAAM,QAAQ,QAAQ"}
+{"version":3,"file":"TagsApi.mjs","names":[],"sources":["../../../src/apis/tags/TagsApi.ts"],"sourcesContent":["import type { ApiClient } from '../../core/ApiClient'\nimport { BaseCrudApi } from '../../core/BaseCrudApi'\nimport type { ContactsSelection } from '../contacts/types'\nimport type {\n  AttachTagsToDepartmentsPayload,\n  CreateTagPayload,\n  Tag,\n  UpdateTagPayload,\n} from './types'\n\nexport class TagsApi extends BaseCrudApi<Tag, CreateTagPayload, UpdateTagPayload> {\n  constructor(client: ApiClient) {\n    super(client, '/tags')\n  }\n\n  /**\n   * Adds the tag to every contact of the account that matches the selection. Resolves to `'OK'`.\n   * @permissions tags.view\n   */\n  attachContacts(\n    id: string,\n    body: ContactsSelection,\n    headers?: Record<string, string>,\n  ): Promise<string> {\n    return this.client.post<string, ContactsSelection>(\n      `${this.basePath}/${id}/contacts`,\n      body,\n      headers,\n    )\n  }\n\n  /**\n   * Removes the tag from every contact of the account that matches the selection. Resolves to\n   * `'OK'`.\n   * @permissions tags.view OR tags.destroy\n   */\n  detachContacts(\n    id: string,\n    body: ContactsSelection,\n    headers?: Record<string, string>,\n  ): Promise<string> {\n    return this.client.request<string, ContactsSelection>(\n      'DELETE',\n      `${this.basePath}/${id}/contacts`,\n      body,\n      headers,\n    )\n  }\n\n  /**\n   * Links several tags to the given departments. Resolves to `'OK'`. A tag without departments\n   * is already available to all of them and is left unchanged.\n   * @permissions tags.view\n   */\n  attachManyToDepartments(\n    body: AttachTagsToDepartmentsPayload,\n    headers?: Record<string, string>,\n  ): Promise<string> {\n    return this.client.post<string, AttachTagsToDepartmentsPayload>(\n      `${this.basePath}/attach-many-departments`,\n      body,\n      headers,\n    )\n  }\n}\n"],"mappings":";;;AAUA,IAAa,UAAb,cAA6B,YAAqD;CAChF,YAAY,QAAmB;AAC7B,QAAM,QAAQ,QAAQ;;;;;;CAOxB,eACE,IACA,MACA,SACiB;AACjB,SAAO,KAAK,OAAO,KACjB,GAAG,KAAK,SAAS,GAAG,GAAG,YACvB,MACA,QACD;;;;;;;CAQH,eACE,IACA,MACA,SACiB;AACjB,SAAO,KAAK,OAAO,QACjB,UACA,GAAG,KAAK,SAAS,GAAG,GAAG,YACvB,MACA,QACD;;;;;;;CAQH,wBACE,MACA,SACiB;AACjB,SAAO,KAAK,OAAO,KACjB,GAAG,KAAK,SAAS,2BACjB,MACA,QACD"}

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

@@ -22,4 +22,12 @@ export type UpdateTagPayload = {
     label?: string;
     backgroundColor?: string | null;
 };
+/**
+ * Body for `POST /tags/attach-many-departments`. An empty `departmentIds` makes the tags
+ * available to every department.
+ */
+export type AttachTagsToDepartmentsPayload = {
+    ids: string[];
+    departmentIds: string[];
+};
 //# sourceMappingURL=types.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/apis/tags/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAChD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAA;AAEtD,MAAM,MAAM,GAAG,GAAG;IAChB,EAAE,EAAE,MAAM,CAAA;IACV,KAAK,EAAE,MAAM,CAAA;IACb,eAAe,EAAE,MAAM,GAAG,IAAI,CAAA;IAC9B,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IAExB,QAAQ,CAAC,EAAE,OAAO,EAAE,CAAA;IACpB,WAAW,CAAC,EAAE,UAAU,EAAE,CAAA;CAC3B,CAAA;AAED,MAAM,MAAM,gBAAgB,GAAG,UAAU,GAAG,aAAa,CAAA;AAEzD,MAAM,MAAM,gBAAgB,GAAG;IAC7B,KAAK,EAAE,MAAM,CAAA;IACb,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB,qDAAqD;IACrD,WAAW,CAAC,EAAE,MAAM,EAAE,CAAA;CACvB,CAAA;AAED,MAAM,MAAM,gBAAgB,GAAG;IAC7B,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CAChC,CAAA"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/apis/tags/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAChD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAA;AAEtD,MAAM,MAAM,GAAG,GAAG;IAChB,EAAE,EAAE,MAAM,CAAA;IACV,KAAK,EAAE,MAAM,CAAA;IACb,eAAe,EAAE,MAAM,GAAG,IAAI,CAAA;IAC9B,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IAExB,QAAQ,CAAC,EAAE,OAAO,EAAE,CAAA;IACpB,WAAW,CAAC,EAAE,UAAU,EAAE,CAAA;CAC3B,CAAA;AAED,MAAM,MAAM,gBAAgB,GAAG,UAAU,GAAG,aAAa,CAAA;AAEzD,MAAM,MAAM,gBAAgB,GAAG;IAC7B,KAAK,EAAE,MAAM,CAAA;IACb,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB,qDAAqD;IACrD,WAAW,CAAC,EAAE,MAAM,EAAE,CAAA;CACvB,CAAA;AAED,MAAM,MAAM,gBAAgB,GAAG;IAC7B,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CAChC,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,8BAA8B,GAAG;IAC3C,GAAG,EAAE,MAAM,EAAE,CAAA;IACb,aAAa,EAAE,MAAM,EAAE,CAAA;CACxB,CAAA"}

package/dist/apis/users/UsersApi.cjs

@@ -6,6 +6,83 @@ var UsersApi = class extends require_core_ArchivableCrudApi.ArchivableCrudApi {
 	constructor(client) {
 		super(client, "/users");
 	}
+	/**
+	* Archives or restores a user through the dedicated route used by the UI, which also
+	* sets the user offline and ends its sessions. The route enforces the business rules that
+	* {@link archive}/{@link unarchive} (a plain `PUT { archivedAt }`) skip:
+	* - archiving refuses (403) a user referenced by a bot or with open tickets;
+	* - restoring refuses (402) when the plan has no free user slot.
+	* @permissions users.view OR users.archive
+	*/
+	archiveWithValidation(id, body, headers) {
+		return this.client.post(`${this.basePath}/${id}/archive`, body, headers);
+	}
+	/**
+	* Previews a bulk archive/unarchive without changing anything.
+	* @permissions users.archive
+	*/
+	previewBulkStatus(body, headers) {
+		return this.client.post(`${this.basePath}/bulk-status/preview`, body, headers);
+	}
+	/**
+	* Archives or unarchives up to 100 users at once.
+	* @permissions users.archive
+	*/
+	bulkStatus(body, headers) {
+		return this.client.post(`${this.basePath}/bulk-status`, body, headers);
+	}
+	/**
+	* Exports the users of the account as CSV. Resolves to the CSV text.
+	* @permissions users.export
+	*/
+	exportCsv(body, headers) {
+		return this.client.post(`${this.basePath}/export`, body, headers);
+	}
+	/**
+	* Validates a CSV file previously uploaded through `FilesApi` before importing it.
+	* @permissions users.create
+	*/
+	validateImport(body, headers) {
+		return this.client.post(`${this.basePath}/import/validate`, body, headers);
+	}
+	/**
+	* Starts the import of a CSV file previously uploaded through `FilesApi`. The import runs
+	* in the background (the route answers `202 Accepted`).
+	* @permissions users.create
+	*/
+	startImport(body, headers) {
+		return this.client.post(`${this.basePath}/import`, body, headers);
+	}
+	/**
+	* Turns off the two-factor authentication (OTP) of a user.
+	* @permissions users.update AND myAccount.update
+	*/
+	disableOtpAuth(id, headers) {
+		return this.client.post(`${this.basePath}/${id}/disable-otp-auth`, void 0, headers);
+	}
+	/**
+	* Clears the login throttling of a user blocked by too many failed attempts.
+	* @permissions users.update
+	*/
+	enableAccess(id, headers) {
+		return this.client.post(`${this.basePath}/${id}/enable-access`, void 0, headers);
+	}
+	/**
+	* Returns the contacts pinned by the logged user.
+	* @permissions contacts.pin
+	*/
+	getPinnedContacts(headers) {
+		return this.client.get(`${this.basePath}/pin`, headers);
+	}
+	/**
+	* Pins the contact for the logged user, or unpins it when already pinned. A user can pin
+	* up to 3 contacts. Resolves to the created link rows when pinning, or to the number of
+	* removed links when unpinning.
+	* @permissions contacts.pin
+	*/
+	togglePinContact(body, headers) {
+		return this.client.patch(`${this.basePath}/pin`, body, headers);
+	}
 };
 
 //#endregion

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

@@ -1 +1 @@
-{"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"}
+{"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 { Contact } from '../contacts/types'\nimport type {\n  ArchiveUserPayload,\n  BulkUsersStatusPayload,\n  BulkUsersStatusPreview,\n  BulkUsersStatusResult,\n  CreateUserPayload,\n  EnableUserAccessResult,\n  ExportUsersPayload,\n  ImportUsersPayload,\n  ImportUsersResult,\n  TogglePinContactPayload,\n  TogglePinContactResult,\n  UpdateUserPayload,\n  User,\n  ValidateUserImportPayload,\n  ValidateUserImportResult,\n} from './types'\n\nexport class UsersApi extends ArchivableCrudApi<User, CreateUserPayload, UpdateUserPayload> {\n  constructor(client: ApiClient) {\n    super(client, '/users')\n  }\n\n  /**\n   * Archives or restores a user through the dedicated route used by the UI, which also\n   * sets the user offline and ends its sessions. The route enforces the business rules that\n   * {@link archive}/{@link unarchive} (a plain `PUT { archivedAt }`) skip:\n   * - archiving refuses (403) a user referenced by a bot or with open tickets;\n   * - restoring refuses (402) when the plan has no free user slot.\n   * @permissions users.view OR users.archive\n   */\n  archiveWithValidation(\n    id: string,\n    body: ArchiveUserPayload,\n    headers?: Record<string, string>,\n  ): Promise<User> {\n    return this.client.post<User, ArchiveUserPayload>(\n      `${this.basePath}/${id}/archive`,\n      body,\n      headers,\n    )\n  }\n\n  /**\n   * Previews a bulk archive/unarchive without changing anything.\n   * @permissions users.archive\n   */\n  previewBulkStatus(\n    body: BulkUsersStatusPayload,\n    headers?: Record<string, string>,\n  ): Promise<BulkUsersStatusPreview> {\n    return this.client.post<BulkUsersStatusPreview, BulkUsersStatusPayload>(\n      `${this.basePath}/bulk-status/preview`,\n      body,\n      headers,\n    )\n  }\n\n  /**\n   * Archives or unarchives up to 100 users at once.\n   * @permissions users.archive\n   */\n  bulkStatus(\n    body: BulkUsersStatusPayload,\n    headers?: Record<string, string>,\n  ): Promise<BulkUsersStatusResult> {\n    return this.client.post<BulkUsersStatusResult, BulkUsersStatusPayload>(\n      `${this.basePath}/bulk-status`,\n      body,\n      headers,\n    )\n  }\n\n  /**\n   * Exports the users of the account as CSV. Resolves to the CSV text.\n   * @permissions users.export\n   */\n  exportCsv(body: ExportUsersPayload, headers?: Record<string, string>): Promise<string> {\n    return this.client.post<string, ExportUsersPayload>(`${this.basePath}/export`, body, headers)\n  }\n\n  /**\n   * Validates a CSV file previously uploaded through `FilesApi` before importing it.\n   * @permissions users.create\n   */\n  validateImport(\n    body: ValidateUserImportPayload,\n    headers?: Record<string, string>,\n  ): Promise<ValidateUserImportResult> {\n    return this.client.post<ValidateUserImportResult, ValidateUserImportPayload>(\n      `${this.basePath}/import/validate`,\n      body,\n      headers,\n    )\n  }\n\n  /**\n   * Starts the import of a CSV file previously uploaded through `FilesApi`. The import runs\n   * in the background (the route answers `202 Accepted`).\n   * @permissions users.create\n   */\n  startImport(\n    body: ImportUsersPayload,\n    headers?: Record<string, string>,\n  ): Promise<ImportUsersResult> {\n    return this.client.post<ImportUsersResult, ImportUsersPayload>(\n      `${this.basePath}/import`,\n      body,\n      headers,\n    )\n  }\n\n  /**\n   * Turns off the two-factor authentication (OTP) of a user.\n   * @permissions users.update AND myAccount.update\n   */\n  disableOtpAuth(id: string, headers?: Record<string, string>): Promise<User> {\n    return this.client.post<User>(`${this.basePath}/${id}/disable-otp-auth`, undefined, headers)\n  }\n\n  /**\n   * Clears the login throttling of a user blocked by too many failed attempts.\n   * @permissions users.update\n   */\n  enableAccess(id: string, headers?: Record<string, string>): Promise<EnableUserAccessResult> {\n    return this.client.post<EnableUserAccessResult>(\n      `${this.basePath}/${id}/enable-access`,\n      undefined,\n      headers,\n    )\n  }\n\n  /**\n   * Returns the contacts pinned by the logged user.\n   * @permissions contacts.pin\n   */\n  getPinnedContacts(headers?: Record<string, string>): Promise<Contact[]> {\n    return this.client.get<Contact[]>(`${this.basePath}/pin`, headers)\n  }\n\n  /**\n   * Pins the contact for the logged user, or unpins it when already pinned. A user can pin\n   * up to 3 contacts. Resolves to the created link rows when pinning, or to the number of\n   * removed links when unpinning.\n   * @permissions contacts.pin\n   */\n  togglePinContact(\n    body: TogglePinContactPayload,\n    headers?: Record<string, string>,\n  ): Promise<TogglePinContactResult> {\n    return this.client.patch<TogglePinContactResult, TogglePinContactPayload>(\n      `${this.basePath}/pin`,\n      body,\n      headers,\n    )\n  }\n}\n"],"mappings":";;;;AAqBA,IAAa,WAAb,cAA8BA,iDAA8D;CAC1F,YAAY,QAAmB;AAC7B,QAAM,QAAQ,SAAS;;;;;;;;;;CAWzB,sBACE,IACA,MACA,SACe;AACf,SAAO,KAAK,OAAO,KACjB,GAAG,KAAK,SAAS,GAAG,GAAG,WACvB,MACA,QACD;;;;;;CAOH,kBACE,MACA,SACiC;AACjC,SAAO,KAAK,OAAO,KACjB,GAAG,KAAK,SAAS,uBACjB,MACA,QACD;;;;;;CAOH,WACE,MACA,SACgC;AAChC,SAAO,KAAK,OAAO,KACjB,GAAG,KAAK,SAAS,eACjB,MACA,QACD;;;;;;CAOH,UAAU,MAA0B,SAAmD;AACrF,SAAO,KAAK,OAAO,KAAiC,GAAG,KAAK,SAAS,UAAU,MAAM,QAAQ;;;;;;CAO/F,eACE,MACA,SACmC;AACnC,SAAO,KAAK,OAAO,KACjB,GAAG,KAAK,SAAS,mBACjB,MACA,QACD;;;;;;;CAQH,YACE,MACA,SAC4B;AAC5B,SAAO,KAAK,OAAO,KACjB,GAAG,KAAK,SAAS,UACjB,MACA,QACD;;;;;;CAOH,eAAe,IAAY,SAAiD;AAC1E,SAAO,KAAK,OAAO,KAAW,GAAG,KAAK,SAAS,GAAG,GAAG,oBAAoB,QAAW,QAAQ;;;;;;CAO9F,aAAa,IAAY,SAAmE;AAC1F,SAAO,KAAK,OAAO,KACjB,GAAG,KAAK,SAAS,GAAG,GAAG,iBACvB,QACA,QACD;;;;;;CAOH,kBAAkB,SAAsD;AACtE,SAAO,KAAK,OAAO,IAAe,GAAG,KAAK,SAAS,OAAO,QAAQ;;;;;;;;CASpE,iBACE,MACA,SACiC;AACjC,SAAO,KAAK,OAAO,MACjB,GAAG,KAAK,SAAS,OACjB,MACA,QACD"}

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

@@ -1,7 +1,65 @@
 import type { ApiClient } from '../../core/ApiClient';
 import { ArchivableCrudApi } from '../../core/ArchivableCrudApi';
-import type { User, CreateUserPayload, UpdateUserPayload } from './types';
+import type { Contact } from '../contacts/types';
+import type { ArchiveUserPayload, BulkUsersStatusPayload, BulkUsersStatusPreview, BulkUsersStatusResult, CreateUserPayload, EnableUserAccessResult, ExportUsersPayload, ImportUsersPayload, ImportUsersResult, TogglePinContactPayload, TogglePinContactResult, UpdateUserPayload, User, ValidateUserImportPayload, ValidateUserImportResult } from './types';
 export declare class UsersApi extends ArchivableCrudApi<User, CreateUserPayload, UpdateUserPayload> {
     constructor(client: ApiClient);
+    /**
+     * Archives or restores a user through the dedicated route used by the UI, which also
+     * sets the user offline and ends its sessions. The route enforces the business rules that
+     * {@link archive}/{@link unarchive} (a plain `PUT { archivedAt }`) skip:
+     * - archiving refuses (403) a user referenced by a bot or with open tickets;
+     * - restoring refuses (402) when the plan has no free user slot.
+     * @permissions users.view OR users.archive
+     */
+    archiveWithValidation(id: string, body: ArchiveUserPayload, headers?: Record<string, string>): Promise<User>;
+    /**
+     * Previews a bulk archive/unarchive without changing anything.
+     * @permissions users.archive
+     */
+    previewBulkStatus(body: BulkUsersStatusPayload, headers?: Record<string, string>): Promise<BulkUsersStatusPreview>;
+    /**
+     * Archives or unarchives up to 100 users at once.
+     * @permissions users.archive
+     */
+    bulkStatus(body: BulkUsersStatusPayload, headers?: Record<string, string>): Promise<BulkUsersStatusResult>;
+    /**
+     * Exports the users of the account as CSV. Resolves to the CSV text.
+     * @permissions users.export
+     */
+    exportCsv(body: ExportUsersPayload, headers?: Record<string, string>): Promise<string>;
+    /**
+     * Validates a CSV file previously uploaded through `FilesApi` before importing it.
+     * @permissions users.create
+     */
+    validateImport(body: ValidateUserImportPayload, headers?: Record<string, string>): Promise<ValidateUserImportResult>;
+    /**
+     * Starts the import of a CSV file previously uploaded through `FilesApi`. The import runs
+     * in the background (the route answers `202 Accepted`).
+     * @permissions users.create
+     */
+    startImport(body: ImportUsersPayload, headers?: Record<string, string>): Promise<ImportUsersResult>;
+    /**
+     * Turns off the two-factor authentication (OTP) of a user.
+     * @permissions users.update AND myAccount.update
+     */
+    disableOtpAuth(id: string, headers?: Record<string, string>): Promise<User>;
+    /**
+     * Clears the login throttling of a user blocked by too many failed attempts.
+     * @permissions users.update
+     */
+    enableAccess(id: string, headers?: Record<string, string>): Promise<EnableUserAccessResult>;
+    /**
+     * Returns the contacts pinned by the logged user.
+     * @permissions contacts.pin
+     */
+    getPinnedContacts(headers?: Record<string, string>): Promise<Contact[]>;
+    /**
+     * Pins the contact for the logged user, or unpins it when already pinned. A user can pin
+     * up to 3 contacts. Resolves to the created link rows when pinning, or to the number of
+     * removed links when unpinning.
+     * @permissions contacts.pin
+     */
+    togglePinContact(body: TogglePinContactPayload, headers?: Record<string, string>): Promise<TogglePinContactResult>;
 }
 //# 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,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"}
+{"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,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAChD,OAAO,KAAK,EACV,kBAAkB,EAClB,sBAAsB,EACtB,sBAAsB,EACtB,qBAAqB,EACrB,iBAAiB,EACjB,sBAAsB,EACtB,kBAAkB,EAClB,kBAAkB,EAClB,iBAAiB,EACjB,uBAAuB,EACvB,sBAAsB,EACtB,iBAAiB,EACjB,IAAI,EACJ,yBAAyB,EACzB,wBAAwB,EACzB,MAAM,SAAS,CAAA;AAEhB,qBAAa,QAAS,SAAQ,iBAAiB,CAAC,IAAI,EAAE,iBAAiB,EAAE,iBAAiB,CAAC;gBAC7E,MAAM,EAAE,SAAS;IAI7B;;;;;;;OAOG;IACH,qBAAqB,CACnB,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,kBAAkB,EACxB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,IAAI,CAAC;IAQhB;;;OAGG;IACH,iBAAiB,CACf,IAAI,EAAE,sBAAsB,EAC5B,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,sBAAsB,CAAC;IAQlC;;;OAGG;IACH,UAAU,CACR,IAAI,EAAE,sBAAsB,EAC5B,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,qBAAqB,CAAC;IAQjC;;;OAGG;IACH,SAAS,CAAC,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC;IAItF;;;OAGG;IACH,cAAc,CACZ,IAAI,EAAE,yBAAyB,EAC/B,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,wBAAwB,CAAC;IAQpC;;;;OAIG;IACH,WAAW,CACT,IAAI,EAAE,kBAAkB,EACxB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,iBAAiB,CAAC;IAQ7B;;;OAGG;IACH,cAAc,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAI3E;;;OAGG;IACH,YAAY,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,sBAAsB,CAAC;IAQ3F;;;OAGG;IACH,iBAAiB,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IAIvE;;;;;OAKG;IACH,gBAAgB,CACd,IAAI,EAAE,uBAAuB,EAC7B,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,sBAAsB,CAAC;CAOnC"}

package/dist/apis/users/UsersApi.mjs

@@ -5,6 +5,83 @@ var UsersApi = class extends ArchivableCrudApi {
 	constructor(client) {
 		super(client, "/users");
 	}
+	/**
+	* Archives or restores a user through the dedicated route used by the UI, which also
+	* sets the user offline and ends its sessions. The route enforces the business rules that
+	* {@link archive}/{@link unarchive} (a plain `PUT { archivedAt }`) skip:
+	* - archiving refuses (403) a user referenced by a bot or with open tickets;
+	* - restoring refuses (402) when the plan has no free user slot.
+	* @permissions users.view OR users.archive
+	*/
+	archiveWithValidation(id, body, headers) {
+		return this.client.post(`${this.basePath}/${id}/archive`, body, headers);
+	}
+	/**
+	* Previews a bulk archive/unarchive without changing anything.
+	* @permissions users.archive
+	*/
+	previewBulkStatus(body, headers) {
+		return this.client.post(`${this.basePath}/bulk-status/preview`, body, headers);
+	}
+	/**
+	* Archives or unarchives up to 100 users at once.
+	* @permissions users.archive
+	*/
+	bulkStatus(body, headers) {
+		return this.client.post(`${this.basePath}/bulk-status`, body, headers);
+	}
+	/**
+	* Exports the users of the account as CSV. Resolves to the CSV text.
+	* @permissions users.export
+	*/
+	exportCsv(body, headers) {
+		return this.client.post(`${this.basePath}/export`, body, headers);
+	}
+	/**
+	* Validates a CSV file previously uploaded through `FilesApi` before importing it.
+	* @permissions users.create
+	*/
+	validateImport(body, headers) {
+		return this.client.post(`${this.basePath}/import/validate`, body, headers);
+	}
+	/**
+	* Starts the import of a CSV file previously uploaded through `FilesApi`. The import runs
+	* in the background (the route answers `202 Accepted`).
+	* @permissions users.create
+	*/
+	startImport(body, headers) {
+		return this.client.post(`${this.basePath}/import`, body, headers);
+	}
+	/**
+	* Turns off the two-factor authentication (OTP) of a user.
+	* @permissions users.update AND myAccount.update
+	*/
+	disableOtpAuth(id, headers) {
+		return this.client.post(`${this.basePath}/${id}/disable-otp-auth`, void 0, headers);
+	}
+	/**
+	* Clears the login throttling of a user blocked by too many failed attempts.
+	* @permissions users.update
+	*/
+	enableAccess(id, headers) {
+		return this.client.post(`${this.basePath}/${id}/enable-access`, void 0, headers);
+	}
+	/**
+	* Returns the contacts pinned by the logged user.
+	* @permissions contacts.pin
+	*/
+	getPinnedContacts(headers) {
+		return this.client.get(`${this.basePath}/pin`, headers);
+	}
+	/**
+	* Pins the contact for the logged user, or unpins it when already pinned. A user can pin
+	* up to 3 contacts. Resolves to the created link rows when pinning, or to the number of
+	* removed links when unpinning.
+	* @permissions contacts.pin
+	*/
+	togglePinContact(body, headers) {
+		return this.client.patch(`${this.basePath}/pin`, body, headers);
+	}
 };
 
 //#endregion

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 { 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"}
+{"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 { Contact } from '../contacts/types'\nimport type {\n  ArchiveUserPayload,\n  BulkUsersStatusPayload,\n  BulkUsersStatusPreview,\n  BulkUsersStatusResult,\n  CreateUserPayload,\n  EnableUserAccessResult,\n  ExportUsersPayload,\n  ImportUsersPayload,\n  ImportUsersResult,\n  TogglePinContactPayload,\n  TogglePinContactResult,\n  UpdateUserPayload,\n  User,\n  ValidateUserImportPayload,\n  ValidateUserImportResult,\n} from './types'\n\nexport class UsersApi extends ArchivableCrudApi<User, CreateUserPayload, UpdateUserPayload> {\n  constructor(client: ApiClient) {\n    super(client, '/users')\n  }\n\n  /**\n   * Archives or restores a user through the dedicated route used by the UI, which also\n   * sets the user offline and ends its sessions. The route enforces the business rules that\n   * {@link archive}/{@link unarchive} (a plain `PUT { archivedAt }`) skip:\n   * - archiving refuses (403) a user referenced by a bot or with open tickets;\n   * - restoring refuses (402) when the plan has no free user slot.\n   * @permissions users.view OR users.archive\n   */\n  archiveWithValidation(\n    id: string,\n    body: ArchiveUserPayload,\n    headers?: Record<string, string>,\n  ): Promise<User> {\n    return this.client.post<User, ArchiveUserPayload>(\n      `${this.basePath}/${id}/archive`,\n      body,\n      headers,\n    )\n  }\n\n  /**\n   * Previews a bulk archive/unarchive without changing anything.\n   * @permissions users.archive\n   */\n  previewBulkStatus(\n    body: BulkUsersStatusPayload,\n    headers?: Record<string, string>,\n  ): Promise<BulkUsersStatusPreview> {\n    return this.client.post<BulkUsersStatusPreview, BulkUsersStatusPayload>(\n      `${this.basePath}/bulk-status/preview`,\n      body,\n      headers,\n    )\n  }\n\n  /**\n   * Archives or unarchives up to 100 users at once.\n   * @permissions users.archive\n   */\n  bulkStatus(\n    body: BulkUsersStatusPayload,\n    headers?: Record<string, string>,\n  ): Promise<BulkUsersStatusResult> {\n    return this.client.post<BulkUsersStatusResult, BulkUsersStatusPayload>(\n      `${this.basePath}/bulk-status`,\n      body,\n      headers,\n    )\n  }\n\n  /**\n   * Exports the users of the account as CSV. Resolves to the CSV text.\n   * @permissions users.export\n   */\n  exportCsv(body: ExportUsersPayload, headers?: Record<string, string>): Promise<string> {\n    return this.client.post<string, ExportUsersPayload>(`${this.basePath}/export`, body, headers)\n  }\n\n  /**\n   * Validates a CSV file previously uploaded through `FilesApi` before importing it.\n   * @permissions users.create\n   */\n  validateImport(\n    body: ValidateUserImportPayload,\n    headers?: Record<string, string>,\n  ): Promise<ValidateUserImportResult> {\n    return this.client.post<ValidateUserImportResult, ValidateUserImportPayload>(\n      `${this.basePath}/import/validate`,\n      body,\n      headers,\n    )\n  }\n\n  /**\n   * Starts the import of a CSV file previously uploaded through `FilesApi`. The import runs\n   * in the background (the route answers `202 Accepted`).\n   * @permissions users.create\n   */\n  startImport(\n    body: ImportUsersPayload,\n    headers?: Record<string, string>,\n  ): Promise<ImportUsersResult> {\n    return this.client.post<ImportUsersResult, ImportUsersPayload>(\n      `${this.basePath}/import`,\n      body,\n      headers,\n    )\n  }\n\n  /**\n   * Turns off the two-factor authentication (OTP) of a user.\n   * @permissions users.update AND myAccount.update\n   */\n  disableOtpAuth(id: string, headers?: Record<string, string>): Promise<User> {\n    return this.client.post<User>(`${this.basePath}/${id}/disable-otp-auth`, undefined, headers)\n  }\n\n  /**\n   * Clears the login throttling of a user blocked by too many failed attempts.\n   * @permissions users.update\n   */\n  enableAccess(id: string, headers?: Record<string, string>): Promise<EnableUserAccessResult> {\n    return this.client.post<EnableUserAccessResult>(\n      `${this.basePath}/${id}/enable-access`,\n      undefined,\n      headers,\n    )\n  }\n\n  /**\n   * Returns the contacts pinned by the logged user.\n   * @permissions contacts.pin\n   */\n  getPinnedContacts(headers?: Record<string, string>): Promise<Contact[]> {\n    return this.client.get<Contact[]>(`${this.basePath}/pin`, headers)\n  }\n\n  /**\n   * Pins the contact for the logged user, or unpins it when already pinned. A user can pin\n   * up to 3 contacts. Resolves to the created link rows when pinning, or to the number of\n   * removed links when unpinning.\n   * @permissions contacts.pin\n   */\n  togglePinContact(\n    body: TogglePinContactPayload,\n    headers?: Record<string, string>,\n  ): Promise<TogglePinContactResult> {\n    return this.client.patch<TogglePinContactResult, TogglePinContactPayload>(\n      `${this.basePath}/pin`,\n      body,\n      headers,\n    )\n  }\n}\n"],"mappings":";;;AAqBA,IAAa,WAAb,cAA8B,kBAA8D;CAC1F,YAAY,QAAmB;AAC7B,QAAM,QAAQ,SAAS;;;;;;;;;;CAWzB,sBACE,IACA,MACA,SACe;AACf,SAAO,KAAK,OAAO,KACjB,GAAG,KAAK,SAAS,GAAG,GAAG,WACvB,MACA,QACD;;;;;;CAOH,kBACE,MACA,SACiC;AACjC,SAAO,KAAK,OAAO,KACjB,GAAG,KAAK,SAAS,uBACjB,MACA,QACD;;;;;;CAOH,WACE,MACA,SACgC;AAChC,SAAO,KAAK,OAAO,KACjB,GAAG,KAAK,SAAS,eACjB,MACA,QACD;;;;;;CAOH,UAAU,MAA0B,SAAmD;AACrF,SAAO,KAAK,OAAO,KAAiC,GAAG,KAAK,SAAS,UAAU,MAAM,QAAQ;;;;;;CAO/F,eACE,MACA,SACmC;AACnC,SAAO,KAAK,OAAO,KACjB,GAAG,KAAK,SAAS,mBACjB,MACA,QACD;;;;;;;CAQH,YACE,MACA,SAC4B;AAC5B,SAAO,KAAK,OAAO,KACjB,GAAG,KAAK,SAAS,UACjB,MACA,QACD;;;;;;CAOH,eAAe,IAAY,SAAiD;AAC1E,SAAO,KAAK,OAAO,KAAW,GAAG,KAAK,SAAS,GAAG,GAAG,oBAAoB,QAAW,QAAQ;;;;;;CAO9F,aAAa,IAAY,SAAmE;AAC1F,SAAO,KAAK,OAAO,KACjB,GAAG,KAAK,SAAS,GAAG,GAAG,iBACvB,QACA,QACD;;;;;;CAOH,kBAAkB,SAAsD;AACtE,SAAO,KAAK,OAAO,IAAe,GAAG,KAAK,SAAS,OAAO,QAAQ;;;;;;;;CASpE,iBACE,MACA,SACiC;AACjC,SAAO,KAAK,OAAO,MACjB,GAAG,KAAK,SAAS,OACjB,MACA,QACD"}

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

@@ -62,4 +62,106 @@ export type UpdateUserPayload = {
     language?: string;
     archivedAt?: string | null;
 };
+/** Body for `POST /users/:id/archive`. */
+export type ArchiveUserPayload = {
+    /** `true` archives the user; `false` restores it. */
+    archive: boolean;
+};
+/** Body for `POST /users/bulk-status` and `POST /users/bulk-status/preview` (1 to 100 IDs). */
+export type BulkUsersStatusPayload = {
+    ids: string[];
+    archive: boolean;
+};
+export type BulkUsersStatusScenario = 'emptySelection' | 'noneEligible' | 'allEligible' | 'partiallyBlocked' | 'onlySelfBlocked' | 'planLimitExceeded';
+/** Read-only preview of a bulk status change: nothing is written. */
+export type BulkUsersStatusPreview = {
+    scenario: BulkUsersStatusScenario;
+    totalSelected: number;
+    /** Users already in the target status. */
+    noop: number;
+    eligible: number;
+    /** Users that cannot change (e.g. referenced by a bot, or the acting user). */
+    blocked: number;
+    blockedSelf: boolean;
+    /** Free plan slots when unarchiving; `null` when archiving. */
+    planSlotsAvailable: number | null;
+};
+export type BulkUsersStatusResult = {
+    changed: number;
+    noop: number;
+    blocked: number;
+    failed: number;
+    changedIds: string[];
+    /** IDs of the batch that no longer exist in the account. */
+    missingIds: string[];
+};
+/** Body for `POST /users/export`. */
+export type ExportUsersPayload = {
+    filter: 'all' | 'active' | 'archived';
+};
+/** A file previously uploaded through `FilesApi`. */
+export type UserImportFile = {
+    id: string;
+    name: string;
+    mimetype: string;
+    url?: string;
+    urlToUpload?: string;
+};
+/** Body for `POST /users/import/validate`. */
+export type ValidateUserImportPayload = {
+    file: UserImportFile;
+};
+export type UserImportRowsSummary = {
+    total: number;
+    valid: number;
+    invalid: number;
+    hasInvalid: boolean;
+};
+export type ValidateUserImportResult = {
+    licenses: {
+        requestedRows: number;
+        available: number;
+        exceeded: boolean;
+    };
+    columns: {
+        required: {
+            name: string;
+            found: boolean;
+        }[];
+        missingRequired: string[];
+        optionalFound: string[];
+    };
+    rows: UserImportRowsSummary;
+    /** Same rows validated with the optional columns applied. */
+    rowsWithOptionalColumns: UserImportRowsSummary;
+};
+/** Body for `POST /users/import`. */
+export type ImportUsersPayload = {
+    file: UserImportFile;
+    useOptionalColumns?: boolean;
+};
+/** The import runs in the background (the route answers `202 Accepted`). */
+export type ImportUsersResult = {
+    importId: string;
+};
+export type EnableUserAccessResult = {
+    success: boolean;
+    message: string;
+};
+/** Body for `PATCH /users/pin`: toggles the pin of a contact for the logged user (max. 3). */
+export type TogglePinContactPayload = {
+    contactId: string;
+};
+/** Link row returned by `PATCH /users/pin` when the contact gets pinned. */
+export type UserPinnedContactLink = {
+    userId: string;
+    contactId: string;
+    createdAt: string;
+    updatedAt: string;
+};
+/**
+ * Result of `PATCH /users/pin`: the created link rows when the contact gets pinned, or the
+ * number of removed links when it gets unpinned.
+ */
+export type TogglePinContactResult = UserPinnedContactLink[] | number;
 //# 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;IACjB,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CAC3B,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;AAED,0CAA0C;AAC1C,MAAM,MAAM,kBAAkB,GAAG;IAC/B,qDAAqD;IACrD,OAAO,EAAE,OAAO,CAAA;CACjB,CAAA;AAED,+FAA+F;AAC/F,MAAM,MAAM,sBAAsB,GAAG;IACnC,GAAG,EAAE,MAAM,EAAE,CAAA;IACb,OAAO,EAAE,OAAO,CAAA;CACjB,CAAA;AAED,MAAM,MAAM,uBAAuB,GAC/B,gBAAgB,GAChB,cAAc,GACd,aAAa,GACb,kBAAkB,GAClB,iBAAiB,GACjB,mBAAmB,CAAA;AAEvB,qEAAqE;AACrE,MAAM,MAAM,sBAAsB,GAAG;IACnC,QAAQ,EAAE,uBAAuB,CAAA;IACjC,aAAa,EAAE,MAAM,CAAA;IACrB,0CAA0C;IAC1C,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,EAAE,MAAM,CAAA;IAChB,+EAA+E;IAC/E,OAAO,EAAE,MAAM,CAAA;IACf,WAAW,EAAE,OAAO,CAAA;IACpB,+DAA+D;IAC/D,kBAAkB,EAAE,MAAM,GAAG,IAAI,CAAA;CAClC,CAAA;AAED,MAAM,MAAM,qBAAqB,GAAG;IAClC,OAAO,EAAE,MAAM,CAAA;IACf,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,EAAE,MAAM,CAAA;IACf,MAAM,EAAE,MAAM,CAAA;IACd,UAAU,EAAE,MAAM,EAAE,CAAA;IACpB,4DAA4D;IAC5D,UAAU,EAAE,MAAM,EAAE,CAAA;CACrB,CAAA;AAED,qCAAqC;AACrC,MAAM,MAAM,kBAAkB,GAAG;IAC/B,MAAM,EAAE,KAAK,GAAG,QAAQ,GAAG,UAAU,CAAA;CACtC,CAAA;AAED,qDAAqD;AACrD,MAAM,MAAM,cAAc,GAAG;IAC3B,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,EAAE,MAAM,CAAA;IAChB,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB,CAAA;AAED,8CAA8C;AAC9C,MAAM,MAAM,yBAAyB,GAAG;IACtC,IAAI,EAAE,cAAc,CAAA;CACrB,CAAA;AAED,MAAM,MAAM,qBAAqB,GAAG;IAClC,KAAK,EAAE,MAAM,CAAA;IACb,KAAK,EAAE,MAAM,CAAA;IACb,OAAO,EAAE,MAAM,CAAA;IACf,UAAU,EAAE,OAAO,CAAA;CACpB,CAAA;AAED,MAAM,MAAM,wBAAwB,GAAG;IACrC,QAAQ,EAAE;QACR,aAAa,EAAE,MAAM,CAAA;QACrB,SAAS,EAAE,MAAM,CAAA;QACjB,QAAQ,EAAE,OAAO,CAAA;KAClB,CAAA;IACD,OAAO,EAAE;QACP,QAAQ,EAAE;YAAE,IAAI,EAAE,MAAM,CAAC;YAAC,KAAK,EAAE,OAAO,CAAA;SAAE,EAAE,CAAA;QAC5C,eAAe,EAAE,MAAM,EAAE,CAAA;QACzB,aAAa,EAAE,MAAM,EAAE,CAAA;KACxB,CAAA;IACD,IAAI,EAAE,qBAAqB,CAAA;IAC3B,6DAA6D;IAC7D,uBAAuB,EAAE,qBAAqB,CAAA;CAC/C,CAAA;AAED,qCAAqC;AACrC,MAAM,MAAM,kBAAkB,GAAG;IAC/B,IAAI,EAAE,cAAc,CAAA;IACpB,kBAAkB,CAAC,EAAE,OAAO,CAAA;CAC7B,CAAA;AAED,4EAA4E;AAC5E,MAAM,MAAM,iBAAiB,GAAG;IAC9B,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA;AAED,MAAM,MAAM,sBAAsB,GAAG;IACnC,OAAO,EAAE,OAAO,CAAA;IAChB,OAAO,EAAE,MAAM,CAAA;CAChB,CAAA;AAED,8FAA8F;AAC9F,MAAM,MAAM,uBAAuB,GAAG;IACpC,SAAS,EAAE,MAAM,CAAA;CAClB,CAAA;AAED,4EAA4E;AAC5E,MAAM,MAAM,qBAAqB,GAAG;IAClC,MAAM,EAAE,MAAM,CAAA;IACd,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;CAClB,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,sBAAsB,GAAG,qBAAqB,EAAE,GAAG,MAAM,CAAA"}

package/package.json

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

package/src/apis/acceptanceTerms/AcceptanceTermsApi.test.ts

@@ -87,7 +87,7 @@ describe('AcceptanceTermsApi', () => {
     it('includes the file relationship', async () => {
       vi.mocked(client.get).mockResolvedValue({ ...term, file: null })
       const result = await api.getById('at-1', { include: ['file'] })
-      const url = vi.mocked(client.get).mock.calls[0][0] as string
+      const url = vi.mocked(client.get).mock.calls[0]?.[0] as string
       expect(url).toContain('/acceptance-terms/at-1?')
       expect(url).toContain('include')
       expect(result.file).toBeNull()

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

@@ -66,7 +66,7 @@ describe('AuthHistoryApi', () => {
     it('serializes query parameters', async () => {
       vi.mocked(client.get).mockResolvedValue(paginated)
       await api.getMany({ page: 2, perPage: 5 })
-      const url = vi.mocked(client.get).mock.calls[0][0] as string
+      const url = vi.mocked(client.get).mock.calls[0]?.[0] as string
       expect(url).toContain('/auth-history?')
       expect(decodeURIComponent(url)).toContain('"page":2')
     })

package/src/apis/campaigns/CampaignsApi.test.ts

@@ -94,7 +94,7 @@ describe('CampaignsApi', () => {
     it('serializes query parameters', async () => {
       vi.mocked(client.get).mockResolvedValue(paginated)
       await api.getMany({ page: 2, perPage: 5 })
-      const url = vi.mocked(client.get).mock.calls[0][0] as string
+      const url = vi.mocked(client.get).mock.calls[0]?.[0] as string
       expect(url).toContain('/campaigns?')
       expect(decodeURIComponent(url)).toContain('"page":2')
     })