@ikatec/digisac-api-sdk 4.2.0 → 4.4.0

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.2.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')
     })

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

@@ -2,12 +2,20 @@ import { beforeEach, describe, expect, it, vi } from 'vitest'
 import { ContactsApi } from './ContactsApi'
 import type { ApiClient } from '../../core/ApiClient'
 import type {
+  BlockContactPayload,
+  BulkTransferTicketsPayload,
+  BulkTransferTicketsResult,
   Contact,
+  ContactMediaPage,
+  ContactsSelection,
   CreateContactPayload,
+  CreateManyContactsItem,
+  ExportCsvPayload,
   ExportTemplatePayload,
   CountContactsQuery,
   ExistsContactsParams,
   CountMediaResult,
+  ImportContactsPayload,
 } from './types'
 import type { Paginated } from '../../core/types'
 
@@ -101,7 +109,7 @@ describe('ContactsApi', () => {
     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('/contacts?')
       expect(decodeURIComponent(url)).toContain('"page":2')
     })
@@ -225,7 +233,7 @@ describe('ContactsApi', () => {
       vi.mocked(client.get).mockResolvedValue({ count: 10 })
       const query: CountContactsQuery = { where: { name: 'Alice' } }
       await api.count(query)
-      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('/contacts/count?')
       expect(url).toContain('where')
     })
@@ -270,7 +278,7 @@ describe('ContactsApi', () => {
     it('serializes query parameters', async () => {
       vi.mocked(client.get).mockResolvedValue(paginated)
       await api.forward({ page: 1, perPage: 10 })
-      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('/contacts/forward?')
     })
 
@@ -289,7 +297,7 @@ describe('ContactsApi', () => {
       vi.mocked(client.get).mockResolvedValue({ '1234567890': true })
       const params: ExistsContactsParams = { serviceId: 'svc-1', numbers: ['1234567890'] }
       const result = await api.exists(params)
-      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('/contacts/exists?')
       expect(url).toContain('serviceId=svc-1')
       expect(result).toEqual({ '1234567890': true })
@@ -299,7 +307,7 @@ describe('ContactsApi', () => {
       vi.mocked(client.get).mockResolvedValue({})
       const headers = { 'X-Custom': 'h' }
       await api.exists({ serviceId: 'svc-1', numbers: [] }, headers)
-      expect(vi.mocked(client.get).mock.calls[0][1]).toEqual(headers)
+      expect(vi.mocked(client.get).mock.calls[0]?.[1]).toEqual(headers)
     })
   })
 
@@ -365,6 +373,175 @@ describe('ContactsApi', () => {
     })
   })
 
+  // ── createMany ───────────────────────────────────────────────────
+
+  describe('createMany', () => {
+    const items: CreateManyContactsItem[] = [
+      { serviceId: 'svc-1', name: 'Alice', number: '5511999990001' },
+      { serviceId: 'svc-1', name: 'Bob', number: '5511999990002', tagIds: ['t1'] },
+    ]
+
+    it('calls client.post with /contacts/many and the array body', async () => {
+      vi.mocked(client.post).mockResolvedValue([contact])
+      const result = await api.createMany(items)
+      expect(client.post).toHaveBeenCalledWith('/contacts/many', items, undefined)
+      expect(result).toEqual([contact])
+    })
+
+    it('serializes the query and forwards custom headers', async () => {
+      const headers = { 'X-Custom': 'value' }
+      await api.createMany(items, { include: ['tags'] }, headers)
+      const [url, body, sentHeaders] = vi.mocked(client.post).mock.calls[0] ?? []
+      expect(decodeURIComponent(url as string)).toBe('/contacts/many?query={"include":["tags"]}')
+      expect(body).toBe(items)
+      expect(sentHeaders).toBe(headers)
+    })
+  })
+
+  // ── deleteMany ───────────────────────────────────────────────────
+
+  describe('deleteMany', () => {
+    it('calls client.request with DELETE /contacts/many and the selection', async () => {
+      vi.mocked(client.request).mockResolvedValue(true)
+      const body: ContactsSelection = { where: { id: { $in: ['c1', 'c2'] } } }
+      const result = await api.deleteMany(body)
+      expect(client.request).toHaveBeenCalledWith('DELETE', '/contacts/many', body, undefined)
+      expect(result).toBe(true)
+    })
+
+    it('forwards custom headers', async () => {
+      const headers = { 'X-Custom': 'value' }
+      await api.deleteMany({ where: { id: 'c1' } }, headers)
+      expect(client.request).toHaveBeenCalledWith(
+        'DELETE',
+        '/contacts/many',
+        { where: { id: 'c1' } },
+        headers,
+      )
+    })
+  })
+
+  // ── exportCsv ────────────────────────────────────────────────────
+
+  describe('exportCsv', () => {
+    it('calls client.post with /contacts/export/csv and resolves to the CSV text', async () => {
+      const csv = 'Nome,DDI,Número\nAlice,55,11999990001\n'
+      vi.mocked(client.post).mockResolvedValue(csv)
+      const body: ExportCsvPayload = {
+        serviceType: 'whatsapp',
+        type: 'comma',
+        where: { id: 'cnt-1' },
+      }
+      const result = await api.exportCsv(body)
+      expect(client.post).toHaveBeenCalledWith('/contacts/export/csv', body, undefined)
+      expect(result).toBe(csv)
+    })
+  })
+
+  // ── importCsv ────────────────────────────────────────────────────
+
+  describe('importCsv', () => {
+    it('calls client.post with /contacts/import-contacts and body', async () => {
+      const body: ImportContactsPayload = {
+        service: { id: 'svc-1', accountId: 'acc-1', type: 'whatsapp' },
+        file: { id: 'f1', name: 'contacts.csv', mimetype: 'text/csv', urlToUpload: 'https://s3' },
+        csvHeaderLine: ['Nome', 'DDI', 'Número'],
+        type: 'comma',
+        tagsIds: ['t1'],
+      }
+      vi.mocked(client.post).mockResolvedValue('OK')
+      const headers = { 'X-Custom': 'value' }
+      const result = await api.importCsv(body, headers)
+      expect(client.post).toHaveBeenCalledWith('/contacts/import-contacts', body, headers)
+      expect(result).toBe('OK')
+    })
+  })
+
+  // ── sync ─────────────────────────────────────────────────────────
+
+  describe('sync', () => {
+    it('calls client.post with /contacts/:id/sync and an empty body by default', async () => {
+      vi.mocked(client.post).mockResolvedValue('OK')
+      const result = await api.sync('c1')
+      expect(client.post).toHaveBeenCalledWith('/contacts/c1/sync', {}, undefined)
+      expect(result).toBe('OK')
+    })
+
+    it('sends forceSync and forwards custom headers', async () => {
+      const headers = { 'X-Custom': 'value' }
+      await api.sync('c1', { forceSync: true }, headers)
+      expect(client.post).toHaveBeenCalledWith('/contacts/c1/sync', { forceSync: true }, headers)
+    })
+  })
+
+  // ── block ────────────────────────────────────────────────────────
+
+  describe('block', () => {
+    it('calls client.post with /contacts/:id/block and body', async () => {
+      vi.mocked(client.post).mockResolvedValue({ ...contact, block: true })
+      const body: BlockContactPayload = { block: true, description: 'spam' }
+      const result = await api.block('c1', body)
+      expect(client.post).toHaveBeenCalledWith('/contacts/c1/block', body, undefined)
+      expect(result.block).toBe(true)
+    })
+  })
+
+  // ── markRead ─────────────────────────────────────────────────────
+
+  describe('markRead', () => {
+    it('calls client.post with /contacts/:id/mark-read and no body', async () => {
+      vi.mocked(client.post).mockResolvedValue('OK')
+      const headers = { 'X-Custom': 'value' }
+      const result = await api.markRead('c1', headers)
+      expect(client.post).toHaveBeenCalledWith('/contacts/c1/mark-read', undefined, headers)
+      expect(result).toBe('OK')
+    })
+  })
+
+  // ── getMedia ─────────────────────────────────────────────────────
+
+  describe('getMedia', () => {
+    const page: ContactMediaPage = { data: [], limit: 50, hasNextPage: false, nextCursor: null }
+
+    it('calls client.get with /contacts/:id/media when no query is provided', async () => {
+      vi.mocked(client.get).mockResolvedValue(page)
+      const result = await api.getMedia('c1')
+      expect(client.get).toHaveBeenCalledWith('/contacts/c1/media', undefined)
+      expect(result).toEqual(page)
+    })
+
+    it('serializes the type, cursor and perPage', async () => {
+      await api.getMedia('c1', {
+        where: { type: 'document', cursor: '2026-01-01T00:00:00Z' },
+        perPage: 10,
+      })
+      const url = decodeURIComponent(vi.mocked(client.get).mock.calls[0]?.[0] as string)
+      expect(url).toBe(
+        '/contacts/c1/media?query={"where":{"type":"document","cursor":"2026-01-01T00:00:00Z"},"perPage":10}',
+      )
+    })
+  })
+
+  // ── bulkTransferTickets ──────────────────────────────────────────
+
+  describe('bulkTransferTickets', () => {
+    it('calls client.post with /contacts/ticket/bulk-transfer and body', async () => {
+      const response: BulkTransferTicketsResult = {
+        message: 'Transferência realizada com sucesso',
+        ticketsSelectedId: ['t1'],
+      }
+      vi.mocked(client.post).mockResolvedValue(response)
+      const body: BulkTransferTicketsPayload = {
+        departmentId: 'd1',
+        userId: null,
+        ticketsSelectedId: ['t1'],
+      }
+      const result = await api.bulkTransferTickets(body)
+      expect(client.post).toHaveBeenCalledWith('/contacts/ticket/bulk-transfer', body, undefined)
+      expect(result).toEqual(response)
+    })
+  })
+
   // ── Error propagation ────────────────────────────────────────────
 
   describe('error propagation', () => {

package/src/apis/contacts/ContactsApi.ts

@@ -3,12 +3,22 @@ import type { ApiClient } from '../../core/ApiClient'
 import { BaseCrudApi } from '../../core/BaseCrudApi'
 import type { ListQuery, Paginated } from '../../core/types'
 import type {
+  BlockContactPayload,
+  BulkTransferTicketsPayload,
+  BulkTransferTicketsResult,
   Contact,
+  ContactMediaPage,
+  ContactMediaQuery,
+  ContactsSelection,
   CountContactsQuery,
   CountMediaResult,
   CreateContactPayload,
+  CreateManyContactsItem,
   ExistsContactsParams,
+  ExportCsvPayload,
   ExportTemplatePayload,
+  ImportContactsPayload,
+  SyncContactPayload,
   TransferTicketPayload,
   UpdateContactPayload,
 } from './types'
@@ -120,4 +130,122 @@ export class ContactsApi extends BaseCrudApi<Contact, CreateContactPayload, Upda
       headers,
     )
   }
+
+  /**
+   * Creates or updates several contacts in one call. Existing contacts (same service and
+   * number or e-mail) are updated; the others are created. Returns the resulting contacts.
+   * @permissions contacts.view OR contacts.update OR contacts.create
+   */
+  createMany(
+    body: CreateManyContactsItem[],
+    query?: ListQuery<Contact>,
+    headers?: Record<string, string>,
+  ): Promise<Contact[]> {
+    const queryString = this.toQueryString(query)
+    return this.client.post<Contact[], CreateManyContactsItem[]>(
+      `${this.basePath}/many${queryString}`,
+      body,
+      headers,
+    )
+  }
+
+  /**
+   * Deletes every contact of the account that matches the selection.
+   * @permissions contacts.view OR contacts.destroy
+   */
+  deleteMany(body: ContactsSelection, headers?: Record<string, string>): Promise<boolean> {
+    return this.client.request<boolean, ContactsSelection>(
+      'DELETE',
+      `${this.basePath}/many`,
+      body,
+      headers,
+    )
+  }
+
+  /**
+   * Exports the contacts that match the filter as CSV. Resolves to the CSV text.
+   * @permissions contacts.view AND contacts.export
+   */
+  exportCsv(body: ExportCsvPayload, headers?: Record<string, string>): Promise<string> {
+    return this.client.post<string, ExportCsvPayload>(`${this.basePath}/export/csv`, body, headers)
+  }
+
+  /**
+   * Starts the import of a CSV file previously uploaded through `FilesApi`. The import runs
+   * in the background; the header line is validated against the service type template.
+   * Resolves to `'OK'`.
+   * @permissions contacts.view OR contacts.update OR contacts.create
+   */
+  importCsv(body: ImportContactsPayload, headers?: Record<string, string>): Promise<string> {
+    return this.client.post<string, ImportContactsPayload>(
+      `${this.basePath}/import-contacts`,
+      body,
+      headers,
+    )
+  }
+
+  /**
+   * Marks the contact as read and, when needed, syncs it with the messaging service.
+   * Resolves to `'OK'`.
+   * @permissions contacts.view OR contacts.update
+   */
+  sync(id: string, body?: SyncContactPayload, headers?: Record<string, string>): Promise<string> {
+    return this.client.post<string, SyncContactPayload>(
+      `${this.basePath}/${id}/sync`,
+      body ?? {},
+      headers,
+    )
+  }
+
+  /**
+   * Blocks or unblocks a contact. Blocking closes the contact's open ticket. Requires the
+   * block list to be active on the account.
+   * @permissions contacts.block
+   */
+  block(id: string, body: BlockContactPayload, headers?: Record<string, string>): Promise<Contact> {
+    return this.client.post<Contact, BlockContactPayload>(
+      `${this.basePath}/${id}/block`,
+      body,
+      headers,
+    )
+  }
+
+  /**
+   * Resets the contact's unread counter. Resolves to `'OK'`.
+   * @permissions contacts.view OR contacts.update
+   */
+  markRead(id: string, headers?: Record<string, string>): Promise<string> {
+    return this.client.post<string>(`${this.basePath}/${id}/mark-read`, undefined, headers)
+  }
+
+  /**
+   * Returns the files and links exchanged with a contact, cursor-paginated.
+   * @permissions contacts.view
+   */
+  getMedia(
+    contactId: string,
+    query?: ContactMediaQuery,
+    headers?: Record<string, string>,
+  ): Promise<ContactMediaPage> {
+    const queryString = this.toQueryString(query)
+    return this.client.get<ContactMediaPage>(
+      `${this.basePath}/${contactId}/media${queryString}`,
+      headers,
+    )
+  }
+
+  /**
+   * Transfers several tickets at once to a department and/or user.
+   * @permissions tickets.transfer.all.bulk
+   */
+  bulkTransferTickets(
+    body: BulkTransferTicketsPayload,
+    headers?: Record<string, string>,
+  ): Promise<BulkTransferTicketsResult> {
+    return this.client.post<BulkTransferTicketsResult, BulkTransferTicketsPayload>(
+      `${this.basePath}/ticket/bulk-transfer`,
+      body,
+      headers,
+    )
+  }
 }