@webitel/api-services 1.0.9 → 1.0.11

package/src/api/clients/agentSkills/agentSkills.ts

@@ -0,0 +1,193 @@
+import { getAgentSkillService } from '../../../gen-wire';
+import { getDefaultGetListResponse, getDefaultGetParams } from '../../defaults';
+import {
+	applyTransform,
+	camelToSnake,
+	merge,
+	mergeEach,
+	notify,
+	sanitize,
+	snakeToCamel,
+	starToSearch,
+} from '../../transformers';
+import type {
+	ApiId,
+	ApiParams,
+	NestedAddItemParams,
+	NestedDeleteItemParams,
+	NestedGetItemParams,
+	NestedPatchItemParams,
+	NestedUpdateItemParams,
+} from '../_shared/types';
+
+const defaultObject = {
+	skill: {},
+	capacity: 0,
+	enabled: false,
+};
+
+const fieldsToSend = [
+	'capacity',
+	'agentId',
+	'skill',
+	'enabled',
+];
+
+const preRequestHandler = (parentId: ApiId) => (item: ApiParams) => ({
+	...item,
+	agentId: parentId,
+});
+
+const getAgentSkillsList = async (params: ApiParams) => {
+	const { parentId, page, size, search, sort, fields, id } = applyTransform(
+		params,
+		[
+			merge(getDefaultGetParams()),
+			starToSearch('search'),
+		],
+	);
+
+	try {
+		const response = await getAgentSkillService().searchAgentSkill(
+			String(parentId),
+			{
+				page,
+				size,
+				// the generated param is `q`; `search` is what the datalist store sends
+				q: search,
+				sort,
+				fields,
+				id,
+			},
+		);
+		const { items, next } = applyTransform(response.data, [
+			snakeToCamel(),
+			merge(getDefaultGetListResponse()),
+		]);
+		return {
+			items: applyTransform(items, [
+				mergeEach(defaultObject),
+			]),
+			next,
+		};
+	} catch (err) {
+		throw applyTransform(err, [
+			notify,
+		]);
+	}
+};
+
+const getAgentSkill = async ({ parentId, itemId: id }: NestedGetItemParams) => {
+	try {
+		const response = await getAgentSkillService().readAgentSkill(
+			String(parentId),
+			String(id),
+		);
+		return applyTransform(response.data, [
+			snakeToCamel(),
+			merge(defaultObject),
+		]);
+	} catch (err) {
+		throw applyTransform(err, [
+			notify,
+		]);
+	}
+};
+
+const addAgentSkill = async ({
+	parentId,
+	itemInstance,
+}: NestedAddItemParams) => {
+	const item = applyTransform(itemInstance, [
+		preRequestHandler(parentId),
+		sanitize(fieldsToSend),
+		camelToSnake(),
+	]);
+	try {
+		const response = await getAgentSkillService().createAgentSkill(
+			String(parentId),
+			item,
+		);
+		return applyTransform(response.data, [
+			snakeToCamel(),
+		]);
+	} catch (err) {
+		throw applyTransform(err, [
+			notify,
+		]);
+	}
+};
+
+const patchAgentSkill = async ({
+	parentId,
+	changes,
+	id,
+}: NestedPatchItemParams) => {
+	const body = applyTransform(changes, [
+		sanitize(fieldsToSend),
+		camelToSnake(),
+	]);
+	try {
+		const response = await getAgentSkillService().patchAgentSkill(
+			String(parentId),
+			String(id),
+			body,
+		);
+		return applyTransform(response.data, [
+			snakeToCamel(),
+		]);
+	} catch (err) {
+		throw applyTransform(err, [
+			notify,
+		]);
+	}
+};
+
+const updateAgentSkill = async ({
+	parentId,
+	itemInstance,
+	itemId: id,
+}: NestedUpdateItemParams) => {
+	const item = applyTransform(itemInstance, [
+		preRequestHandler(parentId),
+		sanitize(fieldsToSend),
+		camelToSnake(),
+	]);
+	try {
+		const response = await getAgentSkillService().updateAgentSkill(
+			String(parentId),
+			String(id),
+			item,
+		);
+		return applyTransform(response.data, [
+			snakeToCamel(),
+		]);
+	} catch (err) {
+		throw applyTransform(err, [
+			notify,
+		]);
+	}
+};
+
+const deleteAgentSkill = async ({ parentId, id }: NestedDeleteItemParams) => {
+	try {
+		const response = await getAgentSkillService().deleteAgentSkill(
+			String(parentId),
+			String(id),
+		);
+		return applyTransform(response.data, []);
+	} catch (err) {
+		throw applyTransform(err, [
+			notify,
+		]);
+	}
+};
+
+export const AgentSkillsAPI = {
+	getList: getAgentSkillsList,
+	get: getAgentSkill,
+	add: addAgentSkill,
+	patch: patchAgentSkill,
+	update: updateAgentSkill,
+	delete: deleteAgentSkill,
+};

package/src/api/clients/agents/__tests__/agents.wireParams.spec.ts

@@ -0,0 +1,51 @@
+import { beforeEach, describe, expect, it, vi } from 'vitest';
+
+const searchAgent = vi.fn(() =>
+	Promise.resolve({
+		data: {},
+	}),
+);
+
+vi.mock('../../../../gen-wire', async (importOriginal) => ({
+	...(await importOriginal<Record<string, unknown>>()),
+	getAgentService: () => ({
+		searchAgent,
+	}),
+}));
+
+const { SearchAgentQueryParams } = await import('../../../../gen-wire');
+const { AgentsAPI } = await import('../agents');
+
+/**
+ * Callers spell these filters after the entity, the endpoint after the column.
+ * Left unmapped they were sanitized away, so the filters silently did nothing.
+ */
+describe('AgentsAPI.getList', () => {
+	beforeEach(() => searchAgent.mockClear());
+
+	it('maps team and skill onto team_id and skill_id', async () => {
+		await AgentsAPI.getList({
+			page: 1,
+			size: 10,
+			team: [
+				1,
+			],
+			skill: [
+				2,
+			],
+		});
+
+		const [params] = searchAgent.mock.calls[0];
+		expect(params).toMatchObject({
+			team_id: [
+				1,
+			],
+			skill_id: [
+				2,
+			],
+		});
+		expect(SearchAgentQueryParams.strict().safeParse(params).success).toBe(
+			true,
+		);
+	});
+});

package/src/api/clients/agents/agents.ts

@@ -9,6 +9,7 @@ import {
 	applyTransform,
 	camelToSnake,
 	merge,
+	mergeEach,
 	notify,
 	sanitize,
 	snakeToCamel,
@@ -16,6 +17,7 @@ import {
 } from '../../transformers';
 import type {
 	AddItemParams,
+	ApiId,
 	ApiParams,
 	DeleteItemParams,
 	GetItemParams,
@@ -43,13 +45,13 @@ const getAgentsList = async (params: ApiParams) => {
 		'fields',
 		'id',
 		'allow_channels',
-		'team',
+		'team_id',
 		'region_id',
 		'auditor_id',
-		'skill',
+		'skill_id',
 		'queue_id',
 		'is_supervisor',
-		'is_not_Supervisor',
+		'not_supervisor',
 		'user_id',
 		'not_team_id',
 		'supervisor_id',
@@ -58,10 +60,18 @@ const getAgentsList = async (params: ApiParams) => {
 	];
 	const requestParams = applyTransform(params, [
 		camelToSnake(),
-		merge(getDefaultGetListResponse()),
+		merge(getDefaultGetParams()),
 		(params) => ({
 			...params,
 			q: params.search,
+			/*
+			 * Callers spell these filters after the entity rather than the
+			 * generated query param. Left unmapped they were sanitized away and
+			 * the filter silently did nothing.
+			 */
+			team_id: params.team_id ?? params.team,
+			skill_id: params.skill_id ?? params.skill,
+			not_supervisor: params.not_supervisor ?? params.is_not_supervisor,
 		}),
 		sanitize(fieldsToSend),
 	]);
@@ -85,21 +95,31 @@ const getAgentsList = async (params: ApiParams) => {
 	}
 };
 
-const getAgent = async ({ itemId: id }: GetItemParams) => {
-	const defaultObject = {
-		user: {},
-		team: {},
-		supervisor: [],
-		auditor: [],
-		region: {},
-		progressiveCount: 0,
-		chatCount: 0,
-		taskCount: 0,
-		isSupervisor: false,
-		description: '',
-		greetingMedia: {},
-	};
+const AGENT_DEFAULTS = {
+	user: {},
+	team: {},
+	supervisor: [],
+	auditor: [],
+	region: {},
+	progressiveCount: 0,
+	chatCount: 0,
+	taskCount: 0,
+	isSupervisor: false,
+	description: '',
+	greetingMedia: {},
+};
 
+/**
+ * `defaultObject` overrides the defaults merged into the response. Cards that
+ * bind a validated numeric field need `null` rather than `0` for "unset", so
+ * they pass their own.
+ */
+const getAgent = async ({
+	itemId: id,
+	defaultObject = AGENT_DEFAULTS,
+}: GetItemParams & {
+	defaultObject?: ApiParams;
+}) => {
 	try {
 		const response = await getAgentService().readAgent(String(id));
 		return applyTransform(response.data, [
@@ -124,6 +144,8 @@ const fieldsToSend = [
 	'chatCount',
 	'taskCount',
 	'isSupervisor',
+	'screenControl',
+	'extraChatCount',
 ];
 
 const addAgent = async ({ itemInstance }: AddItemParams) => {
@@ -188,6 +210,165 @@ const deleteAgent = async ({ id }: DeleteItemParams) => {
 	}
 };
 
+/**
+ * Per-agent status/occupancy statistics over a time window — the supervisor
+ * agents table. Durations come back raw; formatting them is the caller's job.
+ */
+const getAgentStatusStatistics = async (params: ApiParams) => {
+	const {
+		page,
+		size,
+		search,
+		sort,
+		ids,
+		fields,
+		from,
+		to,
+		status,
+		queue,
+		team,
+		skill,
+		supervisor,
+		auditor,
+		region,
+		utilizationFrom,
+		utilizationTo,
+		callNow,
+	} = applyTransform(params, [
+		merge(getDefaultGetParams()),
+	]);
+
+	try {
+		const response = await getAgentService().searchAgentStatusStatistic({
+			page,
+			size,
+			// the generated param is `q`; `search` is what the datalist store sends
+			q: search,
+			sort,
+			fields,
+			agent_id: ids,
+			'time.from': from,
+			'time.to': to,
+			status,
+			queue_id: queue,
+			team_id: team,
+			'utilization.from': utilizationFrom,
+			'utilization.to': utilizationTo,
+			has_call: callNow,
+			skill_id: skill,
+			region_id: region,
+			supervisor_id: supervisor,
+			auditor_id: auditor,
+		});
+		const { items, next } = applyTransform(response.data, [
+			snakeToCamel(),
+			merge(getDefaultGetListResponse()),
+		]);
+		return {
+			items,
+			next,
+		};
+	} catch (err) {
+		throw applyTransform(err, [
+			notify,
+		]);
+	}
+};
+
+/** The same statistics for a single agent. */
+const getAgentStatusStatisticsItem = async ({
+	agentId,
+	from,
+	to,
+}: {
+	agentId: ApiId;
+	from?: string;
+	to?: string;
+}) => {
+	try {
+		const response = await getAgentService().searchAgentStatusStatisticItem(
+			String(agentId),
+			{
+				'time.from': from,
+				'time.to': to,
+			},
+		);
+		return applyTransform(response.data, [
+			snakeToCamel(),
+		]);
+	} catch (err) {
+		throw applyTransform(err, [
+			notify,
+		]);
+	}
+};
+
+/** Queues the given agent is assigned to. */
+const getAgentQueues = async (params: ApiParams) => {
+	const { parentId, page, size, search, sort, fields } = applyTransform(
+		params,
+		[
+			merge(getDefaultGetParams()),
+			starToSearch('search'),
+		],
+	);
+
+	try {
+		const response = await getAgentService().searchAgentInQueue(
+			String(parentId),
+			{
+				page,
+				size,
+				// the generated param is `q`; `search` is what the datalist store sends
+				q: search,
+				sort,
+				fields,
+			},
+		);
+		const { items, next } = applyTransform(response.data, [
+			snakeToCamel(),
+			merge(getDefaultGetListResponse()),
+		]);
+		return {
+			items,
+			next,
+		};
+	} catch (err) {
+		throw applyTransform(err, [
+			notify,
+		]);
+	}
+};
+
+/** Pause causes the given agent is allowed to select. */
+const getPauseCausesForAgent = async ({ agentId }: { agentId: ApiId }) => {
+	const defaultObject = {
+		name: '',
+		durationMin: 0,
+		limitMin: 0,
+	};
+
+	try {
+		const response = await getAgentService().searchPauseCauseForAgent(
+			String(agentId),
+		);
+		const { items, next } = applyTransform(response.data, [
+			snakeToCamel(),
+			merge(getDefaultGetListResponse()),
+		]);
+		return {
+			items: applyTransform(items, [
+				mergeEach(defaultObject),
+			]),
+			next,
+		};
+	} catch (err) {
+		throw applyTransform(err, [
+			notify,
+		]);
+	}
+};
+
 const getAgentsLookup = (params: Parameters<typeof getAgentsList>[0]) =>
 	getAgentsList({
 		...params,
@@ -331,4 +512,8 @@ export const AgentsAPI = {
 	getAgentUsersOptions,
 	getSupervisorOptions,
 	getUsersStatus,
+	getPauseCausesForAgent,
+	getAgentQueues,
+	getStatusStatistics: getAgentStatusStatistics,
+	getStatusStatisticsItem: getAgentStatusStatisticsItem,
 };

package/src/api/clients/auditForms/auditForms.ts

@@ -27,7 +27,11 @@ import type {
 	UpdateItemParams,
 } from '../_shared/types';
 
-const itemResponseHandler = (response: ApiParams) => ({
+/**
+ * Fills in the defaults the backend omits for each question type. Shared with
+ * the audit rate client, whose payload embeds the same question list.
+ */
+export const auditFormQuestionsResponseHandler = (response: ApiParams) => ({
 	...response,
 	questions:
 		response.questions?.map((question: ApiParams) => {
@@ -104,7 +108,7 @@ const getAuditForm = async ({ itemId: id }: GetItemParams) => {
 		const response = await getAuditFormService().readAuditForm(Number(id));
 		return applyTransform(response.data, [
 			snakeToCamel(),
-			itemResponseHandler,
+			auditFormQuestionsResponseHandler,
 		]);
 	} catch (err) {
 		throw applyTransform(err, [

package/src/api/clients/auditForms/auditRates.ts

@@ -0,0 +1,91 @@
+import type { EngineAuditRate } from '@webitel/api-services/gen/models';
+import { getAuditFormService } from '../../../gen-wire';
+import {
+	applyTransform,
+	camelToSnake,
+	notify,
+	snakeToCamel,
+} from '../../transformers';
+import { auditFormQuestionsResponseHandler } from './auditForms';
+
+/**
+ * Answers carry no timestamp of their own; the rate's is the one the UI shows.
+ */
+const fillAnswersCreatedAtFromRate = (rate: EngineAuditRate) => ({
+	...rate,
+	answers: (rate.answers ?? []).map((answer) => ({
+		...answer,
+		createdAt: rate.createdAt,
+	})),
+});
+
+const responseTransformers = [
+	snakeToCamel(),
+	auditFormQuestionsResponseHandler,
+	fillAnswersCreatedAtFromRate,
+];
+
+const getAuditRate = async (rateId: EngineAuditRate['id']) => {
+	try {
+		const response = await getAuditFormService().readAuditRate(String(rateId));
+		return applyTransform(response.data, responseTransformers);
+	} catch (err) {
+		throw applyTransform(err, [
+			notify,
+		]);
+	}
+};
+
+const addAuditRate = async (itemInstance: EngineAuditRate) => {
+	const item = applyTransform(itemInstance, [
+		camelToSnake(),
+	]);
+	try {
+		const response = await getAuditFormService().createAuditFormRate(item);
+		return applyTransform(response.data, responseTransformers);
+	} catch (err) {
+		throw applyTransform(err, [
+			notify,
+		]);
+	}
+};
+
+const updateAuditRate = async ({
+	itemId,
+	itemInstance,
+}: {
+	itemId: EngineAuditRate['id'];
+	itemInstance: EngineAuditRate;
+}) => {
+	const item = applyTransform(itemInstance, [
+		camelToSnake(),
+	]);
+	try {
+		const response = await getAuditFormService().updateAuditRate(
+			String(itemId),
+			item,
+		);
+		return applyTransform(response.data, responseTransformers);
+	} catch (err) {
+		throw applyTransform(err, [
+			notify,
+		]);
+	}
+};
+
+const deleteAuditRate = async (rateId: EngineAuditRate['id']) => {
+	try {
+		await getAuditFormService().deleteAuditRate(String(rateId));
+	} catch (err) {
+		throw applyTransform(err, [
+			notify,
+		]);
+	}
+};
+
+export const AuditRatesAPI = {
+	get: getAuditRate,
+	add: addAuditRate,
+	update: updateAuditRate,
+	delete: deleteAuditRate,
+};