@webitel/api-services 0.0.51 → 0.0.53

package/src/gen/pdf-service/pdf-service.msw.api.gen.ts

@@ -0,0 +1,216 @@
+/**
+ * Generated by orval v7.10.0 🍺
+ * Do not edit manually.
+ * Webitel API
+ * OpenAPI spec version: 24.04.0
+ */
+import { faker } from '@faker-js/faker';
+
+import { delay, HttpResponse, http } from 'msw';
+import type {
+	DownloadPdfExport200,
+	WebitelPdfPdfExportMetadata,
+	WebitelPdfPdfHistoryResponse,
+} from '.././_models';
+import { WebitelPdfPdfExportStatus } from '.././_models';
+
+export const getGeneratePdfExportResponseMock = (
+	overrideResponse: Partial<WebitelPdfPdfExportMetadata> = {},
+): WebitelPdfPdfExportMetadata => ({
+	fileName: faker.helpers.arrayElement([
+		faker.string.alpha({ length: { min: 10, max: 20 } }),
+		undefined,
+	]),
+	mimeType: faker.helpers.arrayElement([
+		faker.string.alpha({ length: { min: 10, max: 20 } }),
+		undefined,
+	]),
+	size: faker.helpers.arrayElement([
+		faker.string.alpha({ length: { min: 10, max: 20 } }),
+		undefined,
+	]),
+	status: faker.helpers.arrayElement([
+		faker.string.alpha({ length: { min: 10, max: 20 } }),
+		undefined,
+	]),
+	taskId: faker.helpers.arrayElement([
+		faker.string.alpha({ length: { min: 10, max: 20 } }),
+		undefined,
+	]),
+	...overrideResponse,
+});
+
+export const getGetPdfExportHistoryResponseMock = (
+	overrideResponse: Partial<WebitelPdfPdfHistoryResponse> = {},
+): WebitelPdfPdfHistoryResponse => ({
+	data: faker.helpers.arrayElement([
+		Array.from(
+			{ length: faker.number.int({ min: 1, max: 10 }) },
+			(_, i) => i + 1,
+		).map(() => ({
+			createdAt: faker.helpers.arrayElement([
+				faker.string.alpha({ length: { min: 10, max: 20 } }),
+				undefined,
+			]),
+			createdBy: faker.helpers.arrayElement([
+				faker.string.alpha({ length: { min: 10, max: 20 } }),
+				undefined,
+			]),
+			fileId: faker.helpers.arrayElement([
+				faker.string.alpha({ length: { min: 10, max: 20 } }),
+				undefined,
+			]),
+			id: faker.helpers.arrayElement([
+				faker.string.alpha({ length: { min: 10, max: 20 } }),
+				undefined,
+			]),
+			mimeType: faker.helpers.arrayElement([
+				faker.string.alpha({ length: { min: 10, max: 20 } }),
+				undefined,
+			]),
+			name: faker.helpers.arrayElement([
+				faker.string.alpha({ length: { min: 10, max: 20 } }),
+				undefined,
+			]),
+			status: faker.helpers.arrayElement([
+				faker.helpers.arrayElement(Object.values(WebitelPdfPdfExportStatus)),
+				undefined,
+			]),
+			updatedAt: faker.helpers.arrayElement([
+				faker.string.alpha({ length: { min: 10, max: 20 } }),
+				undefined,
+			]),
+			updatedBy: faker.helpers.arrayElement([
+				faker.string.alpha({ length: { min: 10, max: 20 } }),
+				undefined,
+			]),
+		})),
+		undefined,
+	]),
+	next: faker.helpers.arrayElement([faker.datatype.boolean(), undefined]),
+	page: faker.helpers.arrayElement([
+		faker.number.int({ min: undefined, max: undefined, multipleOf: undefined }),
+		undefined,
+	]),
+	...overrideResponse,
+});
+
+export const getDownloadPdfExportResponseMock = (
+	overrideResponse: Partial<DownloadPdfExport200> = {},
+): DownloadPdfExport200 => ({
+	error: faker.helpers.arrayElement([
+		{
+			code: faker.helpers.arrayElement([
+				faker.number.int({
+					min: undefined,
+					max: undefined,
+					multipleOf: undefined,
+				}),
+				undefined,
+			]),
+			details: faker.helpers.arrayElement([
+				Array.from(
+					{ length: faker.number.int({ min: 1, max: 10 }) },
+					(_, i) => i + 1,
+				).map(() => ({
+					'@type': faker.helpers.arrayElement([
+						faker.string.alpha({ length: { min: 10, max: 20 } }),
+						undefined,
+					]),
+				})),
+				undefined,
+			]),
+			message: faker.helpers.arrayElement([
+				faker.string.alpha({ length: { min: 10, max: 20 } }),
+				undefined,
+			]),
+		},
+		undefined,
+	]),
+	result: faker.helpers.arrayElement([
+		{
+			data: faker.helpers.arrayElement([
+				faker.string.alpha({ length: { min: 10, max: 20 } }),
+				undefined,
+			]),
+		},
+		undefined,
+	]),
+	...overrideResponse,
+});
+
+export const getGeneratePdfExportMockHandler = (
+	overrideResponse?:
+		| WebitelPdfPdfExportMetadata
+		| ((
+				info: Parameters<Parameters<typeof http.post>[1]>[0],
+		  ) => Promise<WebitelPdfPdfExportMetadata> | WebitelPdfPdfExportMetadata),
+) => {
+	return http.post('*/export/pdf/:agentId', async (info) => {
+		await delay(1000);
+
+		return new HttpResponse(
+			JSON.stringify(
+				overrideResponse !== undefined
+					? typeof overrideResponse === 'function'
+						? await overrideResponse(info)
+						: overrideResponse
+					: getGeneratePdfExportResponseMock(),
+			),
+			{ status: 200, headers: { 'Content-Type': 'application/json' } },
+		);
+	});
+};
+
+export const getGetPdfExportHistoryMockHandler = (
+	overrideResponse?:
+		| WebitelPdfPdfHistoryResponse
+		| ((
+				info: Parameters<Parameters<typeof http.get>[1]>[0],
+		  ) =>
+				| Promise<WebitelPdfPdfHistoryResponse>
+				| WebitelPdfPdfHistoryResponse),
+) => {
+	return http.get('*/export/pdf/:agentId/history', async (info) => {
+		await delay(1000);
+
+		return new HttpResponse(
+			JSON.stringify(
+				overrideResponse !== undefined
+					? typeof overrideResponse === 'function'
+						? await overrideResponse(info)
+						: overrideResponse
+					: getGetPdfExportHistoryResponseMock(),
+			),
+			{ status: 200, headers: { 'Content-Type': 'application/json' } },
+		);
+	});
+};
+
+export const getDownloadPdfExportMockHandler = (
+	overrideResponse?:
+		| DownloadPdfExport200
+		| ((
+				info: Parameters<Parameters<typeof http.get>[1]>[0],
+		  ) => Promise<DownloadPdfExport200> | DownloadPdfExport200),
+) => {
+	return http.get('*/export/pdf/:fileId', async (info) => {
+		await delay(1000);
+
+		return new HttpResponse(
+			JSON.stringify(
+				overrideResponse !== undefined
+					? typeof overrideResponse === 'function'
+						? await overrideResponse(info)
+						: overrideResponse
+					: getDownloadPdfExportResponseMock(),
+			),
+			{ status: 200, headers: { 'Content-Type': 'application/json' } },
+		);
+	});
+};
+export const getPdfServiceMock = () => [
+	getGeneratePdfExportMockHandler(),
+	getGetPdfExportHistoryMockHandler(),
+	getDownloadPdfExportMockHandler(),
+];

package/src/gen/pdf-service/pdf-service.zod.gen.ts

@@ -0,0 +1,153 @@
+/**
+ * Generated by orval v7.10.0 🍺
+ * Do not edit manually.
+ * Webitel API
+ * OpenAPI spec version: 24.04.0
+ */
+import { z as zod } from 'zod/v4';
+
+/**
+ * @summary Generate a new PDF export asynchronously.
+Returns metadata about the created export task.
+ */
+export const generatePdfExportParams = zod.object({
+	agent_id: zod
+		.string()
+		.describe('Agent ID for which the export is generated.'),
+});
+
+export const generatePdfExportBody = zod
+	.object({
+		channel: zod
+			.string()
+			.optional()
+			.describe('Channel type (e.g., \"screenshot\").'),
+		fileIds: zod
+			.array(zod.string())
+			.optional()
+			.describe('Optional list of specific file IDs to include.'),
+		from: zod.string().optional().describe('Start timestamp (Unix millis).'),
+		to: zod.string().optional().describe('End timestamp (Unix millis).'),
+	})
+	.describe('Request for generating a PDF export.');
+
+export const generatePdfExportResponse = zod
+	.object({
+		fileName: zod.string().optional().describe('File name of the export.'),
+		mimeType: zod
+			.string()
+			.optional()
+			.describe('MIME type, e.g., \"application/pdf\".'),
+		size: zod
+			.string()
+			.optional()
+			.describe('File size in bytes (0 if not ready).'),
+		status: zod
+			.string()
+			.optional()
+			.describe('Task status: pending | processing | done | failed.'),
+		taskId: zod.string().optional().describe('Unique identifier of the task.'),
+	})
+	.describe('Metadata about a PDF export task.');
+
+/**
+ * @summary Get paginated history of PDF exports for a given agent.
+ */
+export const getPdfExportHistoryParams = zod.object({
+	agent_id: zod.string().describe('Agent ID.'),
+});
+
+export const getPdfExportHistoryQueryParams = zod.object({
+	page: zod.number().optional().describe('Page number (starting from 1).'),
+	size: zod
+		.number()
+		.optional()
+		.describe('Page size (number of records per page).'),
+});
+
+export const getPdfExportHistoryResponseDataItemStatusDefault =
+	'PDF_EXPORT_STATUS_UNSPECIFIED';
+
+export const getPdfExportHistoryResponse = zod
+	.object({
+		data: zod
+			.array(
+				zod
+					.object({
+						createdAt: zod
+							.string()
+							.optional()
+							.describe('Creation timestamp (Unix millis).'),
+						createdBy: zod
+							.string()
+							.optional()
+							.describe('User ID who created the export.'),
+						fileId: zod.string().optional().describe('Related file ID.'),
+						id: zod.string().optional().describe('Export ID.'),
+						mimeType: zod
+							.string()
+							.optional()
+							.describe('MIME type of the export.'),
+						name: zod.string().optional().describe('Export name.'),
+						status: zod
+							.enum([
+								'PDF_EXPORT_STATUS_UNSPECIFIED',
+								'PDF_EXPORT_STATUS_PENDING',
+								'PDF_EXPORT_STATUS_PROCESSING',
+								'PDF_EXPORT_STATUS_DONE',
+								'PDF_EXPORT_STATUS_FAILED',
+							])
+							.default(getPdfExportHistoryResponseDataItemStatusDefault)
+							.describe(
+								'Status of the PDF export process.\n\n - PDF_EXPORT_STATUS_UNSPECIFIED: Default value.\n - PDF_EXPORT_STATUS_PENDING: Task is waiting to start.\n - PDF_EXPORT_STATUS_PROCESSING: Task is in progress.\n - PDF_EXPORT_STATUS_DONE: Task is completed successfully.\n - PDF_EXPORT_STATUS_FAILED: Task failed.',
+							),
+						updatedAt: zod
+							.string()
+							.optional()
+							.describe('Update timestamp (Unix millis).'),
+						updatedBy: zod
+							.string()
+							.optional()
+							.describe('User ID who last updated the export.'),
+					})
+					.describe('Represents a single PDF export record.'),
+			)
+			.optional()
+			.describe('List of export history records.'),
+		next: zod.boolean().optional().describe('True if there is a next page.'),
+		page: zod.number().optional().describe('Current page number.'),
+	})
+	.describe('Response containing a page of export history.');
+
+/**
+ * @summary Download a previously generated PDF by export ID.
+ */
+export const downloadPdfExportParams = zod.object({
+	file_id: zod.string().describe('Unique export identifier.'),
+});
+
+export const downloadPdfExportQueryParams = zod.object({
+	domainId: zod.string().optional().describe('Domain ID for authorization.'),
+});
+
+export const downloadPdfExportResponse = zod.object({
+	error: zod
+		.object({
+			code: zod.number().optional(),
+			details: zod
+				.array(
+					zod.object({
+						'@type': zod.string().optional(),
+					}),
+				)
+				.optional(),
+			message: zod.string().optional(),
+		})
+		.optional(),
+	result: zod
+		.object({
+			data: zod.string().optional().describe('Raw PDF file bytes (chunked).'),
+		})
+		.optional()
+		.describe('Chunked response with PDF binary data.'),
+});

package/src/gen/records/records.api.gen.ts

@@ -13,8 +13,8 @@ import type {
 	Create200,
 	CreateBody,
 	DataDataset,
-	LocateMixin3Params,
-	LocateMixin3200,
+	Locate200,
+	LocateParams,
 	SearchParams,
 	Update2Body,
 	Update2Params,
@@ -73,10 +73,10 @@ export const // --- title start
 			 * (Record) {
 			 * @summary Locate dataset record
 			 */
-			const locateMixin3 = <TData = AxiosResponse<LocateMixin3200>>(
+			const locate = <TData = AxiosResponse<Locate200>>(
 				repo: string,
 				id: string,
-				params?: LocateMixin3Params,
+				params?: LocateParams,
 				options?: AxiosRequestConfig,
 			): Promise<TData> => {
 				return axios.get(`/v2/dataset/${repo}/${id}`, {
@@ -118,12 +118,12 @@ export const // --- title start
 			};
 
 			// --- footer start
-			return { _delete, search, create, locateMixin3, update, update2 };
+			return { _delete, search, create, locate, update, update2 };
 		};
 export type _DeleteResult = AxiosResponse<DataDataset>;
 export type SearchResult = AxiosResponse<DataDataset>;
 export type CreateResult = AxiosResponse<Create200>;
-export type LocateMixin3Result = AxiosResponse<LocateMixin3200>;
+export type LocateResult = AxiosResponse<Locate200>;
 export type UpdateResult = AxiosResponse<Update200>;
 export type Update2Result = AxiosResponse<Update2200>;
 

package/src/gen/records/records.msw.api.gen.ts

@@ -10,7 +10,7 @@ import { delay, HttpResponse, http } from 'msw';
 import type {
 	Create200,
 	DataDataset,
-	LocateMixin3200,
+	Locate200,
 	Update200,
 	Update2200,
 } from '.././_models';
@@ -1186,7 +1186,7 @@ export const getSearchResponseMock = (
 
 export const getCreateResponseMock = (): Create200 => ({});
 
-export const getLocateMixin3ResponseMock = (): LocateMixin3200 => ({});
+export const getLocateResponseMock = (): Locate200 => ({});
 
 export const getUpdateResponseMock = (): Update200 => ({});
 
@@ -1261,12 +1261,12 @@ export const getCreateMockHandler = (
 	});
 };
 
-export const getLocateMixin3MockHandler = (
+export const getLocateMockHandler = (
 	overrideResponse?:
-		| LocateMixin3200
+		| Locate200
 		| ((
 				info: Parameters<Parameters<typeof http.get>[1]>[0],
-		  ) => Promise<LocateMixin3200> | LocateMixin3200),
+		  ) => Promise<Locate200> | Locate200),
 ) => {
 	return http.get('*/v2/dataset/:repo/:id', async (info) => {
 		await delay(1000);
@@ -1277,7 +1277,7 @@ export const getLocateMixin3MockHandler = (
 					? typeof overrideResponse === 'function'
 						? await overrideResponse(info)
 						: overrideResponse
-					: getLocateMixin3ResponseMock(),
+					: getLocateResponseMock(),
 			),
 			{ status: 200, headers: { 'Content-Type': 'application/json' } },
 		);
@@ -1333,7 +1333,7 @@ export const getRecordsMock = () => [
 	getDeleteMockHandler(),
 	getSearchMockHandler(),
 	getCreateMockHandler(),
-	getLocateMixin3MockHandler(),
+	getLocateMockHandler(),
 	getUpdateMockHandler(),
 	getUpdate2MockHandler(),
 ];

package/src/gen/records/records.zod.gen.ts

@@ -787,14 +787,14 @@ export const createResponse = zod.object({});
  * (Record) {
  * @summary Locate dataset record
  */
-export const locateMixin3Params = zod.object({
+export const locateParams = zod.object({
 	repo: zod.string().describe('[`types.repo`]'),
 	id: zod.string().describe('[`record.id`]'),
 });
 
-export const locateMixin3QueryFieldsItemDefault = '*';
+export const locateQueryFieldsItemDefault = '*';
 
-export const locateMixin3QueryParams = zod.object({
+export const locateQueryParams = zod.object({
 	fields: zod
 		.array(zod.string())
 		.optional()
@@ -803,7 +803,7 @@ export const locateMixin3QueryParams = zod.object({
 		),
 });
 
-export const locateMixin3Response = zod.object({});
+export const locateResponse = zod.object({});
 
 /**
  * (Record) {

package/src/gen/types/types.api.gen.ts

@@ -37,7 +37,7 @@ export const // --- title start
 			/**
 			 * @summary Structured data type details.
 			 */
-			const locate = <TData = AxiosResponse<ProtodataStruct>>(
+			const locateMixin3 = <TData = AxiosResponse<ProtodataStruct>>(
 				path: string,
 				options?: AxiosRequestConfig,
 			): Promise<TData> => {
@@ -45,9 +45,9 @@ export const // --- title start
 			};
 
 			// --- footer start
-			return { searchMixin3, locate };
+			return { searchMixin3, locateMixin3 };
 		};
 export type SearchMixin3Result = AxiosResponse<DataStructList>;
-export type LocateResult = AxiosResponse<ProtodataStruct>;
+export type LocateMixin3Result = AxiosResponse<ProtodataStruct>;
 
 // --- footer end

package/src/gen/types/types.msw.api.gen.ts

@@ -590,7 +590,7 @@ export const getSearchMixin3ResponseMock = (
 	...overrideResponse,
 });
 
-export const getLocateResponseMock = (
+export const getLocateMixin3ResponseMock = (
 	overrideResponse: Partial<ProtodataStruct> = {},
 ): ProtodataStruct => ({
 	about: faker.helpers.arrayElement([
@@ -1171,7 +1171,7 @@ export const getSearchMixin3MockHandler = (
 	});
 };
 
-export const getLocateMockHandler = (
+export const getLocateMixin3MockHandler = (
 	overrideResponse?:
 		| ProtodataStruct
 		| ((
@@ -1187,7 +1187,7 @@ export const getLocateMockHandler = (
 					? typeof overrideResponse === 'function'
 						? await overrideResponse(info)
 						: overrideResponse
-					: getLocateResponseMock(),
+					: getLocateMixin3ResponseMock(),
 			),
 			{ status: 200, headers: { 'Content-Type': 'application/json' } },
 		);
@@ -1195,5 +1195,5 @@ export const getLocateMockHandler = (
 };
 export const getTypesMock = () => [
 	getSearchMixin3MockHandler(),
-	getLocateMockHandler(),
+	getLocateMixin3MockHandler(),
 ];

package/src/gen/types/types.zod.gen.ts

@@ -441,13 +441,13 @@ export const searchMixin3Response = zod
 /**
  * @summary Structured data type details.
  */
-export const locateParams = zod.object({
+export const locateMixin3Params = zod.object({
 	path: zod.string().describe('`types.path`'),
 });
 
-export const locateResponseFieldsItemKindDefault = 'none';
+export const locateMixin3ResponseFieldsItemKindDefault = 'none';
 
-export const locateResponse = zod
+export const locateMixin3Response = zod
 	.object({
 		about: zod.string().optional().describe('Optional. Short description.'),
 		administered: zod.boolean().optional(),
@@ -591,7 +591,7 @@ export const locateResponse = zod
 								'datetime',
 								'duration',
 							])
-							.default(locateResponseFieldsItemKindDefault)
+							.default(locateMixin3ResponseFieldsItemKindDefault)
 							.describe(
 								'Kind of primitive data types.\n\n - none: option allow_alias = true;\n - list: [array]\n - int: int32\n - uint: uint32\n - float: float32\n - datetime: date &| time',
 							),

package/types/gen/_models/downloadPdfExport200.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Generated by orval v7.10.0 🍺
+ * Do not edit manually.
+ * Webitel API
+ * OpenAPI spec version: 24.04.0
+ */
+import type { GoogleRpcStatus } from './googleRpcStatus';
+import type { WebitelPdfPdfExportChunk } from './webitelPdfPdfExportChunk';
+export type DownloadPdfExport200 = {
+    error?: GoogleRpcStatus;
+    result?: WebitelPdfPdfExportChunk;
+};

package/types/gen/_models/downloadPdfExportParams.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Generated by orval v7.10.0 🍺
+ * Do not edit manually.
+ * Webitel API
+ * OpenAPI spec version: 24.04.0
+ */
+export type DownloadPdfExportParams = {
+    /**
+     * Domain ID for authorization.
+     */
+    domainId?: string;
+};

package/types/gen/_models/getPdfExportHistoryParams.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Generated by orval v7.10.0 🍺
+ * Do not edit manually.
+ * Webitel API
+ * OpenAPI spec version: 24.04.0
+ */
+export type GetPdfExportHistoryParams = {
+    /**
+     * Page number (starting from 1).
+     */
+    page?: number;
+    /**
+     * Page size (number of records per page).
+     */
+    size?: number;
+};

package/types/gen/_models/{locateMixin3200.d.ts → locate200.d.ts}

@@ -4,6 +4,6 @@
  * Webitel API
  * OpenAPI spec version: 24.04.0
  */
-export type LocateMixin3200 = {
+export type Locate200 = {
     [key: string]: unknown;
 };

package/types/gen/_models/{locateMixin3Params.d.ts → locateParams.d.ts}

@@ -4,7 +4,7 @@
  * Webitel API
  * OpenAPI spec version: 24.04.0
  */
-export type LocateMixin3Params = {
+export type LocateParams = {
     /**
  * Fields [Q]uery to build result dataset record.
 ```

package/types/gen/_models/searchTypeMixin3Params.d.ts

@@ -6,49 +6,6 @@
  */
 export type SearchTypeMixin3Params = {
     /**
- * Search term:
-`?` - matches any character
-`*` - matches 0 or more characters
-e.g.: name,emails{type},labels etc...
- */
-    q?: string;
-    /**
-     * `types.id`
-     */
-    id?: string;
-    /**
-     * `types.name`
-     */
-    name?: string;
-    /**
-     * `types.repo`
-     */
-    repo?: string;
-    /**
-     * `types.path`
-     */
-    path?: string;
-    /**
-     * [NOT] [ system / custom ] types only
-     */
-    readonly?: boolean;
-    /**
-     * [NOT] Extend[able] types only.
-     */
-    extendable?: boolean;
-    /**
-     * [NOT] include extensions/* types.
-     */
-    extensions?: boolean;
-    /**
-     * [NOT] Extend[ed] types only.
-     */
-    extended?: boolean;
-    /**
-     * [NOT] Administer access control only
-     */
-    administered?: boolean;
-    /**
  * Number of result records (per page).
 Default: 16.
  */
@@ -96,4 +53,15 @@ USCORE   = %x5F ; underscore  ; "_"
 ```
  */
     fields?: string[];
+    /**
+ * Search term:
+`?` - matches any character
+`*` - matches 0 or more characters
+e.g.: name,emails{type},labels etc...
+ */
+    q?: string;
+    /**
+     * extension.type.id
+     */
+    id?: string[];
 };