@webitel/api-services 0.0.1

package/src/gen/case-communications/case-communications.msw.api.gen.ts

@@ -0,0 +1,173 @@
+/**
+ * Generated by orval v7.9.0 🍺
+ * Do not edit manually.
+ * service.proto
+ * OpenAPI spec version: version not set
+ */
+import { faker } from '@faker-js/faker';
+
+import { http, HttpResponse, delay } from 'msw';
+
+import { CasesCaseCommunicationsTypes } from '.././_models';
+import type {
+	CasesLinkCommunicationResponse,
+	CasesListCommunicationsResponse,
+	CasesUnlinkCommunicationResponse,
+} from '.././_models';
+
+export const getListCommunicationsResponseMock = (
+	overrideResponse: Partial<CasesListCommunicationsResponse> = {},
+): CasesListCommunicationsResponse => ({
+	data: faker.helpers.arrayElement([
+		Array.from(
+			{ length: faker.number.int({ min: 1, max: 10 }) },
+			(_, i) => i + 1,
+		).map(() => ({
+			communicationId: faker.helpers.arrayElement([
+				faker.string.alpha(20),
+				undefined,
+			]),
+			communicationType: faker.helpers.arrayElement([
+				faker.helpers.arrayElement(Object.values(CasesCaseCommunicationsTypes)),
+				undefined,
+			]),
+			etag: faker.helpers.arrayElement([faker.string.alpha(20), undefined]),
+			id: faker.helpers.arrayElement([
+				faker.number.int({ min: undefined, max: undefined }),
+				undefined,
+			]),
+			ver: faker.helpers.arrayElement([
+				faker.number.int({ min: undefined, max: undefined }),
+				undefined,
+			]),
+		})),
+		undefined,
+	]),
+	next: faker.helpers.arrayElement([faker.datatype.boolean(), undefined]),
+	page: faker.helpers.arrayElement([
+		faker.number.int({ min: undefined, max: undefined }),
+		undefined,
+	]),
+	...overrideResponse,
+});
+
+export const getLinkCommunicationResponseMock = (
+	overrideResponse: Partial<CasesLinkCommunicationResponse> = {},
+): CasesLinkCommunicationResponse => ({
+	data: faker.helpers.arrayElement([
+		Array.from(
+			{ length: faker.number.int({ min: 1, max: 10 }) },
+			(_, i) => i + 1,
+		).map(() => ({
+			communicationId: faker.helpers.arrayElement([
+				faker.string.alpha(20),
+				undefined,
+			]),
+			communicationType: faker.helpers.arrayElement([
+				faker.helpers.arrayElement(Object.values(CasesCaseCommunicationsTypes)),
+				undefined,
+			]),
+			etag: faker.helpers.arrayElement([faker.string.alpha(20), undefined]),
+			id: faker.helpers.arrayElement([
+				faker.number.int({ min: undefined, max: undefined }),
+				undefined,
+			]),
+			ver: faker.helpers.arrayElement([
+				faker.number.int({ min: undefined, max: undefined }),
+				undefined,
+			]),
+		})),
+		undefined,
+	]),
+	...overrideResponse,
+});
+
+export const getUnlinkCommunicationResponseMock = (
+	overrideResponse: Partial<CasesUnlinkCommunicationResponse> = {},
+): CasesUnlinkCommunicationResponse => ({
+	affected: faker.helpers.arrayElement([
+		faker.number.int({ min: undefined, max: undefined }),
+		undefined,
+	]),
+	...overrideResponse,
+});
+
+export const getListCommunicationsMockHandler = (
+	overrideResponse?:
+		| CasesListCommunicationsResponse
+		| ((
+				info: Parameters<Parameters<typeof http.get>[1]>[0],
+		  ) =>
+				| Promise<CasesListCommunicationsResponse>
+				| CasesListCommunicationsResponse),
+) => {
+	return http.get('*/cases/:caseEtag/communication', async (info) => {
+		await delay(1000);
+
+		return new HttpResponse(
+			JSON.stringify(
+				overrideResponse !== undefined
+					? typeof overrideResponse === 'function'
+						? await overrideResponse(info)
+						: overrideResponse
+					: getListCommunicationsResponseMock(),
+			),
+			{ status: 200, headers: { 'Content-Type': 'application/json' } },
+		);
+	});
+};
+
+export const getLinkCommunicationMockHandler = (
+	overrideResponse?:
+		| CasesLinkCommunicationResponse
+		| ((
+				info: Parameters<Parameters<typeof http.post>[1]>[0],
+		  ) =>
+				| Promise<CasesLinkCommunicationResponse>
+				| CasesLinkCommunicationResponse),
+) => {
+	return http.post('*/cases/:caseEtag/communication', async (info) => {
+		await delay(1000);
+
+		return new HttpResponse(
+			JSON.stringify(
+				overrideResponse !== undefined
+					? typeof overrideResponse === 'function'
+						? await overrideResponse(info)
+						: overrideResponse
+					: getLinkCommunicationResponseMock(),
+			),
+			{ status: 200, headers: { 'Content-Type': 'application/json' } },
+		);
+	});
+};
+
+export const getUnlinkCommunicationMockHandler = (
+	overrideResponse?:
+		| CasesUnlinkCommunicationResponse
+		| ((
+				info: Parameters<Parameters<typeof http.delete>[1]>[0],
+		  ) =>
+				| Promise<CasesUnlinkCommunicationResponse>
+				| CasesUnlinkCommunicationResponse),
+) => {
+	return http.delete('*/cases/:caseEtag/communication/:id', async (info) => {
+		await delay(1000);
+
+		return new HttpResponse(
+			JSON.stringify(
+				overrideResponse !== undefined
+					? typeof overrideResponse === 'function'
+						? await overrideResponse(info)
+						: overrideResponse
+					: getUnlinkCommunicationResponseMock(),
+			),
+			{ status: 200, headers: { 'Content-Type': 'application/json' } },
+		);
+	});
+};
+export const getCaseCommunicationsMock = () => [
+	getListCommunicationsMockHandler(),
+	getLinkCommunicationMockHandler(),
+	getUnlinkCommunicationMockHandler(),
+];

package/src/gen/case-communications/case-communications.zod.gen.ts

@@ -0,0 +1,177 @@
+/**
+ * Generated by orval v7.9.0 🍺
+ * Do not edit manually.
+ * service.proto
+ * OpenAPI spec version: version not set
+ */
+import { z as zod } from 'zod';
+
+/**
+ * @summary Lists all communications linked to a specific case.
+Currently a feature for future development.
+ */
+export const listCommunicationsParams = zod.object({
+	case_etag: zod.string().describe('Case identifier.'),
+});
+
+export const listCommunicationsQueryParams = zod.object({
+	fields: zod
+		.array(zod.string())
+		.optional()
+		.describe('List of fields to include in the response.'),
+	q: zod.string().optional().describe('Query string for filtering results.'),
+	size: zod.number().optional().describe('Number of records per page.'),
+	page: zod.number().optional().describe('Page number for pagination.'),
+	sort: zod.string().optional().describe('Sorting order.'),
+});
+
+export const listCommunicationsResponseDataItemCommunicationTypeDefault =
+	'NO_TYPE';
+
+export const listCommunicationsResponse = zod
+	.object({
+		data: zod
+			.array(
+				zod
+					.object({
+						communicationId: zod
+							.string()
+							.optional()
+							.describe('External communication ID.'),
+						communicationType: zod
+							.enum([
+								'NO_TYPE',
+								'COMMUNICATION_CHAT',
+								'COMMUNICATION_CALL',
+								'COMMUNICATION_EMAIL',
+							])
+							.default(
+								listCommunicationsResponseDataItemCommunicationTypeDefault,
+							)
+							.describe(
+								'Enum to define types of case communications.\n\n - NO_TYPE: Default value, no type specified.\n - COMMUNICATION_CHAT: Communication type: Chat.\n - COMMUNICATION_CALL: Communication type: Call.\n - COMMUNICATION_EMAIL: Communication type: Email.',
+							),
+						etag: zod
+							.string()
+							.optional()
+							.describe('Version of the communication record.'),
+						id: zod
+							.string()
+							.optional()
+							.describe('Database ID of the communication.'),
+						ver: zod
+							.number()
+							.optional()
+							.describe('Version of the communication record.'),
+					})
+					.describe('Represents a single case communication.'),
+			)
+			.optional()
+			.describe('List of communications.'),
+		next: zod.boolean().optional(),
+		page: zod.number().optional().describe('Current page number.'),
+	})
+	.describe('Response message for listing communications linked to a case.');
+
+/**
+ * @summary Links a communication to a specific case.
+ */
+export const linkCommunicationParams = zod.object({
+	case_etag: zod.string().describe('Case identifier.'),
+});
+
+export const linkCommunicationQueryParams = zod.object({
+	fields: zod
+		.array(zod.string())
+		.optional()
+		.describe('List of fields to include in the response.'),
+});
+
+export const linkCommunicationBodyCommunicationTypeDefault = 'NO_TYPE';
+
+export const linkCommunicationBody = zod
+	.object({
+		communicationId: zod
+			.string()
+			.optional()
+			.describe('External communication ID.'),
+		communicationType: zod
+			.enum([
+				'NO_TYPE',
+				'COMMUNICATION_CHAT',
+				'COMMUNICATION_CALL',
+				'COMMUNICATION_EMAIL',
+			])
+			.default(linkCommunicationBodyCommunicationTypeDefault)
+			.describe(
+				'Enum to define types of case communications.\n\n - NO_TYPE: Default value, no type specified.\n - COMMUNICATION_CHAT: Communication type: Chat.\n - COMMUNICATION_CALL: Communication type: Call.\n - COMMUNICATION_EMAIL: Communication type: Email.',
+			),
+	})
+	.describe('Represents input data for creating or linking a communication.');
+
+export const linkCommunicationResponseDataItemCommunicationTypeDefault =
+	'NO_TYPE';
+
+export const linkCommunicationResponse = zod
+	.object({
+		data: zod
+			.array(
+				zod
+					.object({
+						communicationId: zod
+							.string()
+							.optional()
+							.describe('External communication ID.'),
+						communicationType: zod
+							.enum([
+								'NO_TYPE',
+								'COMMUNICATION_CHAT',
+								'COMMUNICATION_CALL',
+								'COMMUNICATION_EMAIL',
+							])
+							.default(
+								linkCommunicationResponseDataItemCommunicationTypeDefault,
+							)
+							.describe(
+								'Enum to define types of case communications.\n\n - NO_TYPE: Default value, no type specified.\n - COMMUNICATION_CHAT: Communication type: Chat.\n - COMMUNICATION_CALL: Communication type: Call.\n - COMMUNICATION_EMAIL: Communication type: Email.',
+							),
+						etag: zod
+							.string()
+							.optional()
+							.describe('Version of the communication record.'),
+						id: zod
+							.string()
+							.optional()
+							.describe('Database ID of the communication.'),
+						ver: zod
+							.number()
+							.optional()
+							.describe('Version of the communication record.'),
+					})
+					.describe('Represents a single case communication.'),
+			)
+			.optional()
+			.describe('List of linked communications.'),
+	})
+	.describe('Response message after linking communications to a case.');
+
+/**
+ * @summary Unlinks a communication from a specific case.
+ */
+export const unlinkCommunicationParams = zod.object({
+	case_etag: zod.string(),
+	id: zod.string().describe('Communication identifier.'),
+});
+
+export const unlinkCommunicationQueryParams = zod.object({
+	fields: zod
+		.array(zod.string())
+		.optional()
+		.describe('List of fields to include in the response.'),
+});
+
+export const unlinkCommunicationResponse = zod
+	.object({
+		affected: zod.string().optional().describe('Affected rows.'),
+	})
+	.describe('Response message after unlinking a communication from a case.');

package/src/gen/case-files/case-files.api.gen.ts

@@ -0,0 +1,55 @@
+/**
+ * Generated by orval v7.9.0 🍺
+ * Do not edit manually.
+ * service.proto
+ * OpenAPI spec version: version not set
+ */
+import axios from '@aliasedDeps/api-services/axios';
+
+import type { AxiosRequestConfig, AxiosResponse } from 'axios';
+
+import type {
+	CasesCaseFileList,
+	CasesFile,
+	ListFilesParams,
+} from '.././_models';
+
+// --- header start
+//
+
+export const // --- title start
+	getCaseFiles =
+		// --- title end
+		() => {
+			// --- header end
+			/**
+			 * @summary Retrieve a list of files associated with a case
+			 */
+			const listFiles = <TData = AxiosResponse<CasesCaseFileList>>(
+				caseEtag: string,
+				params?: ListFilesParams,
+				options?: AxiosRequestConfig,
+			): Promise<TData> => {
+				return axios.get(`/cases/${caseEtag}/files`, {
+					...options,
+					params: { ...params, ...options?.params },
+				});
+			};
+			/**
+			 * @summary Delete a file
+			 */
+			const deleteFile = <TData = AxiosResponse<CasesFile>>(
+				caseEtag: string,
+				id: string,
+				options?: AxiosRequestConfig,
+			): Promise<TData> => {
+				return axios.delete(`/cases/${caseEtag}/files/${id}`, options);
+			};
+
+			// --- footer start
+			return { listFiles, deleteFile };
+		};
+export type ListFilesResult = AxiosResponse<CasesCaseFileList>;
+export type DeleteFileResult = AxiosResponse<CasesFile>;
+
+// --- footer end

package/src/gen/case-files/case-files.msw.api.gen.ts

@@ -0,0 +1,156 @@
+/**
+ * Generated by orval v7.9.0 🍺
+ * Do not edit manually.
+ * service.proto
+ * OpenAPI spec version: version not set
+ */
+import { faker } from '@faker-js/faker';
+
+import { http, HttpResponse, delay } from 'msw';
+
+import type { CasesCaseFileList, CasesFile } from '.././_models';
+
+export const getListFilesResponseMock = (
+	overrideResponse: Partial<CasesCaseFileList> = {},
+): CasesCaseFileList => ({
+	items: faker.helpers.arrayElement([
+		Array.from(
+			{ length: faker.number.int({ min: 1, max: 10 }) },
+			(_, i) => i + 1,
+		).map(() => ({
+			author: faker.helpers.arrayElement([
+				{
+					id: faker.helpers.arrayElement([
+						faker.number.int({ min: undefined, max: undefined }),
+						undefined,
+					]),
+					name: faker.helpers.arrayElement([faker.string.alpha(20), undefined]),
+				},
+				undefined,
+			]),
+			createdAt: faker.helpers.arrayElement([
+				faker.number.int({ min: undefined, max: undefined }),
+				undefined,
+			]),
+			createdBy: faker.helpers.arrayElement([
+				{
+					id: faker.helpers.arrayElement([
+						faker.number.int({ min: undefined, max: undefined }),
+						undefined,
+					]),
+					name: faker.helpers.arrayElement([faker.string.alpha(20), undefined]),
+				},
+				undefined,
+			]),
+			id: faker.helpers.arrayElement([
+				faker.number.int({ min: undefined, max: undefined }),
+				undefined,
+			]),
+			mime: faker.helpers.arrayElement([faker.string.alpha(20), undefined]),
+			name: faker.helpers.arrayElement([faker.string.alpha(20), undefined]),
+			size: faker.helpers.arrayElement([
+				faker.number.int({ min: undefined, max: undefined }),
+				undefined,
+			]),
+			url: faker.helpers.arrayElement([faker.string.alpha(20), undefined]),
+		})),
+		undefined,
+	]),
+	next: faker.helpers.arrayElement([faker.datatype.boolean(), undefined]),
+	page: faker.helpers.arrayElement([
+		faker.number.int({ min: undefined, max: undefined }),
+		undefined,
+	]),
+	...overrideResponse,
+});
+
+export const getDeleteFileResponseMock = (
+	overrideResponse: Partial<CasesFile> = {},
+): CasesFile => ({
+	author: faker.helpers.arrayElement([
+		{
+			id: faker.helpers.arrayElement([
+				faker.number.int({ min: undefined, max: undefined }),
+				undefined,
+			]),
+			name: faker.helpers.arrayElement([faker.string.alpha(20), undefined]),
+		},
+		undefined,
+	]),
+	createdAt: faker.helpers.arrayElement([
+		faker.number.int({ min: undefined, max: undefined }),
+		undefined,
+	]),
+	createdBy: faker.helpers.arrayElement([
+		{
+			id: faker.helpers.arrayElement([
+				faker.number.int({ min: undefined, max: undefined }),
+				undefined,
+			]),
+			name: faker.helpers.arrayElement([faker.string.alpha(20), undefined]),
+		},
+		undefined,
+	]),
+	id: faker.helpers.arrayElement([
+		faker.number.int({ min: undefined, max: undefined }),
+		undefined,
+	]),
+	mime: faker.helpers.arrayElement([faker.string.alpha(20), undefined]),
+	name: faker.helpers.arrayElement([faker.string.alpha(20), undefined]),
+	size: faker.helpers.arrayElement([
+		faker.number.int({ min: undefined, max: undefined }),
+		undefined,
+	]),
+	url: faker.helpers.arrayElement([faker.string.alpha(20), undefined]),
+	...overrideResponse,
+});
+
+export const getListFilesMockHandler = (
+	overrideResponse?:
+		| CasesCaseFileList
+		| ((
+				info: Parameters<Parameters<typeof http.get>[1]>[0],
+		  ) => Promise<CasesCaseFileList> | CasesCaseFileList),
+) => {
+	return http.get('*/cases/:caseEtag/files', async (info) => {
+		await delay(1000);
+
+		return new HttpResponse(
+			JSON.stringify(
+				overrideResponse !== undefined
+					? typeof overrideResponse === 'function'
+						? await overrideResponse(info)
+						: overrideResponse
+					: getListFilesResponseMock(),
+			),
+			{ status: 200, headers: { 'Content-Type': 'application/json' } },
+		);
+	});
+};
+
+export const getDeleteFileMockHandler = (
+	overrideResponse?:
+		| CasesFile
+		| ((
+				info: Parameters<Parameters<typeof http.delete>[1]>[0],
+		  ) => Promise<CasesFile> | CasesFile),
+) => {
+	return http.delete('*/cases/:caseEtag/files/:id', async (info) => {
+		await delay(1000);
+
+		return new HttpResponse(
+			JSON.stringify(
+				overrideResponse !== undefined
+					? typeof overrideResponse === 'function'
+						? await overrideResponse(info)
+						: overrideResponse
+					: getDeleteFileResponseMock(),
+			),
+			{ status: 200, headers: { 'Content-Type': 'application/json' } },
+		);
+	});
+};
+export const getCaseFilesMock = () => [
+	getListFilesMockHandler(),
+	getDeleteFileMockHandler(),
+];

package/src/gen/case-files/case-files.zod.gen.ts

@@ -0,0 +1,102 @@
+/**
+ * Generated by orval v7.9.0 🍺
+ * Do not edit manually.
+ * service.proto
+ * OpenAPI spec version: version not set
+ */
+import { z as zod } from 'zod';
+
+/**
+ * @summary Retrieve a list of files associated with a case
+ */
+export const listFilesParams = zod.object({
+	case_etag: zod
+		.string()
+		.describe('ID of the case to fetch files for (required).'),
+});
+
+export const listFilesQueryParams = zod.object({
+	page: zod.number().optional().describe('The page number to retrieve.'),
+	size: zod.number().optional().describe('Number of items per page.'),
+	q: zod.string().optional().describe('Search term.'),
+	fields: zod
+		.array(zod.string())
+		.optional()
+		.describe('Fields to include in the response.'),
+	ids: zod.array(zod.string()).optional().describe('Array of requested id.'),
+	sort: zod.string().optional().describe('Sorting'),
+});
+
+export const listFilesResponse = zod
+	.object({
+		items: zod
+			.array(
+				zod
+					.object({
+						author: zod
+							.object({
+								id: zod.string().optional(),
+								name: zod.string().optional(),
+							})
+							.optional(),
+						createdAt: zod
+							.string()
+							.optional()
+							.describe('Creation timestamp in Unix milliseconds.'),
+						createdBy: zod
+							.object({
+								id: zod.string().optional(),
+								name: zod.string().optional(),
+							})
+							.optional(),
+						id: zod.string().optional().describe('Storage file ID.'),
+						mime: zod.string().optional().describe('MIME type of the file.'),
+						name: zod.string().optional().describe('File name.'),
+						size: zod.string().optional().describe('File size in bytes.'),
+						url: zod.string().optional(),
+					})
+					.describe('Metadata for a file associated with a case.'),
+			)
+			.optional()
+			.describe('List of case files.'),
+		next: zod
+			.boolean()
+			.optional()
+			.describe('Indicator if there is a next page.'),
+		page: zod.string().optional().describe('Current page number.'),
+	})
+	.describe('Contains a list of case files with pagination.');
+
+/**
+ * @summary Delete a file
+ */
+export const deleteFileParams = zod.object({
+	case_etag: zod.string(),
+	id: zod.string().describe('The unique ID of the file to delete.'),
+});
+
+export const deleteFileResponse = zod
+	.object({
+		author: zod
+			.object({
+				id: zod.string().optional(),
+				name: zod.string().optional(),
+			})
+			.optional(),
+		createdAt: zod
+			.string()
+			.optional()
+			.describe('Creation timestamp in Unix milliseconds.'),
+		createdBy: zod
+			.object({
+				id: zod.string().optional(),
+				name: zod.string().optional(),
+			})
+			.optional(),
+		id: zod.string().optional().describe('Storage file ID.'),
+		mime: zod.string().optional().describe('MIME type of the file.'),
+		name: zod.string().optional().describe('File name.'),
+		size: zod.string().optional().describe('File size in bytes.'),
+		url: zod.string().optional(),
+	})
+	.describe('Metadata for a file associated with a case.');