@webitel/api-services 0.0.3 → 0.0.9

package/src/gen/sources/sources.zod.gen.ts

@@ -0,0 +1,421 @@
+/**
+ * Generated by orval v7.9.0 🍺
+ * Do not edit manually.
+ * Webitel API
+ * OpenAPI spec version: 24.04.0
+ */
+import { z as zod } from 'zod';
+
+/**
+ * @summary Retrieve a list of sources or search sources
+ */
+export const listSourcesQueryParams = zod.object({
+	page: zod
+		.number()
+		.optional()
+		.describe('Page number of result dataset records. offset = (page*size)'),
+	size: zod
+		.number()
+		.optional()
+		.describe('Size count of records on result page. limit = (size++)'),
+	fields: zod
+		.array(zod.string())
+		.optional()
+		.describe('Fields to be retrieved as a result.'),
+	sort: zod
+		.string()
+		.optional()
+		.describe('Sort the result according to fields.'),
+	id: zod.array(zod.string()).optional().describe('Filter by unique IDs.'),
+	q: zod
+		.string()
+		.optional()
+		.describe(
+			'Search query string for filtering by name. Supports:\n- Wildcards (*) for substring matching\n- Placeholder (?) for single character substitution\n- Exact match for full names',
+		),
+	type: zod
+		.array(
+			zod.enum([
+				'TYPE_UNSPECIFIED',
+				'CALL',
+				'CHAT',
+				'SOCIAL_MEDIA',
+				'EMAIL',
+				'API',
+				'MANUAL',
+			]),
+		)
+		.optional()
+		.describe(
+			'Filter by source type.\n\n - TYPE_UNSPECIFIED: Unspecified source type.\n - CALL: Phone call source type.\n - CHAT: Chat source type.\n - SOCIAL_MEDIA: Social media source type.\n - EMAIL: Email source type.\n - API: API source type.\n - MANUAL: Manual source type.',
+		),
+});
+
+export const listSourcesResponseItemsItemTypeDefault = 'TYPE_UNSPECIFIED';
+
+export const listSourcesResponse = zod
+	.object({
+		items: zod
+			.array(
+				zod
+					.object({
+						createdAt: zod.string().optional(),
+						createdBy: zod
+							.object({
+								id: zod.string().optional(),
+								name: zod.string().optional(),
+							})
+							.optional(),
+						description: zod.string().optional(),
+						id: zod.string().optional(),
+						name: zod.string().optional(),
+						type: zod
+							.enum([
+								'TYPE_UNSPECIFIED',
+								'CALL',
+								'CHAT',
+								'SOCIAL_MEDIA',
+								'EMAIL',
+								'API',
+								'MANUAL',
+							])
+							.default(listSourcesResponseItemsItemTypeDefault)
+							.describe(
+								'Represents a source type for the source entity.\n\n - TYPE_UNSPECIFIED: Unspecified source type.\n - CALL: Phone call source type.\n - CHAT: Chat source type.\n - SOCIAL_MEDIA: Social media source type.\n - EMAIL: Email source type.\n - API: API source type.\n - MANUAL: Manual source type.',
+							),
+						updatedAt: zod.string().optional(),
+						updatedBy: zod
+							.object({
+								id: zod.string().optional(),
+								name: zod.string().optional(),
+							})
+							.optional(),
+					})
+					.describe('Represents a source entity in the contact system.'),
+			)
+			.optional()
+			.describe('List of sources.'),
+		next: zod.boolean().optional().describe('Have more records.'),
+		page: zod
+			.number()
+			.optional()
+			.describe('Page number of the partial result.'),
+	})
+	.describe('A list of sources.');
+
+/**
+ * @summary Create a new source
+ */
+export const createSourceQueryParams = zod.object({
+	fields: zod.array(zod.string()).optional(),
+});
+
+export const createSourceBodyTypeDefault = 'TYPE_UNSPECIFIED';
+
+export const createSourceBody = zod.object({
+	description: zod
+		.string()
+		.optional()
+		.describe('The description of the source.'),
+	name: zod.string().optional().describe('The name of the source.'),
+	type: zod
+		.enum([
+			'TYPE_UNSPECIFIED',
+			'CALL',
+			'CHAT',
+			'SOCIAL_MEDIA',
+			'EMAIL',
+			'API',
+			'MANUAL',
+		])
+		.default(createSourceBodyTypeDefault)
+		.describe(
+			'Represents a source type for the source entity.\n\n - TYPE_UNSPECIFIED: Unspecified source type.\n - CALL: Phone call source type.\n - CHAT: Chat source type.\n - SOCIAL_MEDIA: Social media source type.\n - EMAIL: Email source type.\n - API: API source type.\n - MANUAL: Manual source type.',
+		),
+});
+
+export const createSourceResponseTypeDefault = 'TYPE_UNSPECIFIED';
+
+export const createSourceResponse = zod
+	.object({
+		createdAt: zod.string().optional(),
+		createdBy: zod
+			.object({
+				id: zod.string().optional(),
+				name: zod.string().optional(),
+			})
+			.optional(),
+		description: zod.string().optional(),
+		id: zod.string().optional(),
+		name: zod.string().optional(),
+		type: zod
+			.enum([
+				'TYPE_UNSPECIFIED',
+				'CALL',
+				'CHAT',
+				'SOCIAL_MEDIA',
+				'EMAIL',
+				'API',
+				'MANUAL',
+			])
+			.default(createSourceResponseTypeDefault)
+			.describe(
+				'Represents a source type for the source entity.\n\n - TYPE_UNSPECIFIED: Unspecified source type.\n - CALL: Phone call source type.\n - CHAT: Chat source type.\n - SOCIAL_MEDIA: Social media source type.\n - EMAIL: Email source type.\n - API: API source type.\n - MANUAL: Manual source type.',
+			),
+		updatedAt: zod.string().optional(),
+		updatedBy: zod
+			.object({
+				id: zod.string().optional(),
+				name: zod.string().optional(),
+			})
+			.optional(),
+	})
+	.describe('Represents a source entity in the contact system.');
+
+/**
+ * @summary Delete a source
+ */
+export const deleteSourceParams = zod.object({
+	id: zod.string().describe('The unique ID of the source to delete.'),
+});
+
+export const deleteSourceResponseTypeDefault = 'TYPE_UNSPECIFIED';
+
+export const deleteSourceResponse = zod
+	.object({
+		createdAt: zod.string().optional(),
+		createdBy: zod
+			.object({
+				id: zod.string().optional(),
+				name: zod.string().optional(),
+			})
+			.optional(),
+		description: zod.string().optional(),
+		id: zod.string().optional(),
+		name: zod.string().optional(),
+		type: zod
+			.enum([
+				'TYPE_UNSPECIFIED',
+				'CALL',
+				'CHAT',
+				'SOCIAL_MEDIA',
+				'EMAIL',
+				'API',
+				'MANUAL',
+			])
+			.default(deleteSourceResponseTypeDefault)
+			.describe(
+				'Represents a source type for the source entity.\n\n - TYPE_UNSPECIFIED: Unspecified source type.\n - CALL: Phone call source type.\n - CHAT: Chat source type.\n - SOCIAL_MEDIA: Social media source type.\n - EMAIL: Email source type.\n - API: API source type.\n - MANUAL: Manual source type.',
+			),
+		updatedAt: zod.string().optional(),
+		updatedBy: zod
+			.object({
+				id: zod.string().optional(),
+				name: zod.string().optional(),
+			})
+			.optional(),
+	})
+	.describe('Represents a source entity in the contact system.');
+
+/**
+ * @summary Locate a source by ID
+ */
+export const locateSourceParams = zod.object({
+	id: zod.string().describe('The unique ID of the source to locate.'),
+});
+
+export const locateSourceQueryParams = zod.object({
+	fields: zod
+		.array(zod.string())
+		.optional()
+		.describe('Fields to be retrieved into result.'),
+});
+
+export const locateSourceResponseSourceTypeDefault = 'TYPE_UNSPECIFIED';
+
+export const locateSourceResponse = zod
+	.object({
+		source: zod
+			.object({
+				createdAt: zod.string().optional(),
+				createdBy: zod
+					.object({
+						id: zod.string().optional(),
+						name: zod.string().optional(),
+					})
+					.optional(),
+				description: zod.string().optional(),
+				id: zod.string().optional(),
+				name: zod.string().optional(),
+				type: zod
+					.enum([
+						'TYPE_UNSPECIFIED',
+						'CALL',
+						'CHAT',
+						'SOCIAL_MEDIA',
+						'EMAIL',
+						'API',
+						'MANUAL',
+					])
+					.default(locateSourceResponseSourceTypeDefault)
+					.describe(
+						'Represents a source type for the source entity.\n\n - TYPE_UNSPECIFIED: Unspecified source type.\n - CALL: Phone call source type.\n - CHAT: Chat source type.\n - SOCIAL_MEDIA: Social media source type.\n - EMAIL: Email source type.\n - API: API source type.\n - MANUAL: Manual source type.',
+					),
+				updatedAt: zod.string().optional(),
+				updatedBy: zod
+					.object({
+						id: zod.string().optional(),
+						name: zod.string().optional(),
+					})
+					.optional(),
+			})
+			.optional()
+			.describe('Represents a source entity in the contact system.'),
+	})
+	.describe('Response message for locating a source.');
+
+/**
+ * @summary Update an existing source
+ */
+export const updateSource2Params = zod.object({
+	id: zod.string(),
+});
+
+export const updateSource2QueryParams = zod.object({
+	fields: zod.array(zod.string()).optional(),
+});
+
+export const updateSource2BodyTypeDefault = 'TYPE_UNSPECIFIED';
+
+export const updateSource2Body = zod.object({
+	description: zod
+		.string()
+		.optional()
+		.describe('The description of the source.'),
+	name: zod.string().optional().describe('The name of the source.'),
+	type: zod
+		.enum([
+			'TYPE_UNSPECIFIED',
+			'CALL',
+			'CHAT',
+			'SOCIAL_MEDIA',
+			'EMAIL',
+			'API',
+			'MANUAL',
+		])
+		.default(updateSource2BodyTypeDefault)
+		.describe(
+			'Represents a source type for the source entity.\n\n - TYPE_UNSPECIFIED: Unspecified source type.\n - CALL: Phone call source type.\n - CHAT: Chat source type.\n - SOCIAL_MEDIA: Social media source type.\n - EMAIL: Email source type.\n - API: API source type.\n - MANUAL: Manual source type.',
+		),
+});
+
+export const updateSource2ResponseTypeDefault = 'TYPE_UNSPECIFIED';
+
+export const updateSource2Response = zod
+	.object({
+		createdAt: zod.string().optional(),
+		createdBy: zod
+			.object({
+				id: zod.string().optional(),
+				name: zod.string().optional(),
+			})
+			.optional(),
+		description: zod.string().optional(),
+		id: zod.string().optional(),
+		name: zod.string().optional(),
+		type: zod
+			.enum([
+				'TYPE_UNSPECIFIED',
+				'CALL',
+				'CHAT',
+				'SOCIAL_MEDIA',
+				'EMAIL',
+				'API',
+				'MANUAL',
+			])
+			.default(updateSource2ResponseTypeDefault)
+			.describe(
+				'Represents a source type for the source entity.\n\n - TYPE_UNSPECIFIED: Unspecified source type.\n - CALL: Phone call source type.\n - CHAT: Chat source type.\n - SOCIAL_MEDIA: Social media source type.\n - EMAIL: Email source type.\n - API: API source type.\n - MANUAL: Manual source type.',
+			),
+		updatedAt: zod.string().optional(),
+		updatedBy: zod
+			.object({
+				id: zod.string().optional(),
+				name: zod.string().optional(),
+			})
+			.optional(),
+	})
+	.describe('Represents a source entity in the contact system.');
+
+/**
+ * @summary Update an existing source
+ */
+export const updateSourceParams = zod.object({
+	id: zod.string(),
+});
+
+export const updateSourceQueryParams = zod.object({
+	fields: zod.array(zod.string()).optional(),
+});
+
+export const updateSourceBodyTypeDefault = 'TYPE_UNSPECIFIED';
+
+export const updateSourceBody = zod.object({
+	description: zod
+		.string()
+		.optional()
+		.describe('The description of the source.'),
+	name: zod.string().optional().describe('The name of the source.'),
+	type: zod
+		.enum([
+			'TYPE_UNSPECIFIED',
+			'CALL',
+			'CHAT',
+			'SOCIAL_MEDIA',
+			'EMAIL',
+			'API',
+			'MANUAL',
+		])
+		.default(updateSourceBodyTypeDefault)
+		.describe(
+			'Represents a source type for the source entity.\n\n - TYPE_UNSPECIFIED: Unspecified source type.\n - CALL: Phone call source type.\n - CHAT: Chat source type.\n - SOCIAL_MEDIA: Social media source type.\n - EMAIL: Email source type.\n - API: API source type.\n - MANUAL: Manual source type.',
+		),
+});
+
+export const updateSourceResponseTypeDefault = 'TYPE_UNSPECIFIED';
+
+export const updateSourceResponse = zod
+	.object({
+		createdAt: zod.string().optional(),
+		createdBy: zod
+			.object({
+				id: zod.string().optional(),
+				name: zod.string().optional(),
+			})
+			.optional(),
+		description: zod.string().optional(),
+		id: zod.string().optional(),
+		name: zod.string().optional(),
+		type: zod
+			.enum([
+				'TYPE_UNSPECIFIED',
+				'CALL',
+				'CHAT',
+				'SOCIAL_MEDIA',
+				'EMAIL',
+				'API',
+				'MANUAL',
+			])
+			.default(updateSourceResponseTypeDefault)
+			.describe(
+				'Represents a source type for the source entity.\n\n - TYPE_UNSPECIFIED: Unspecified source type.\n - CALL: Phone call source type.\n - CHAT: Chat source type.\n - SOCIAL_MEDIA: Social media source type.\n - EMAIL: Email source type.\n - API: API source type.\n - MANUAL: Manual source type.',
+			),
+		updatedAt: zod.string().optional(),
+		updatedBy: zod
+			.object({
+				id: zod.string().optional(),
+				name: zod.string().optional(),
+			})
+			.optional(),
+	})
+	.describe('Represents a source entity in the contact system.');

package/src/gen/spaces/spaces.api.gen.ts

@@ -0,0 +1,139 @@
+/**
+ * Generated by orval v7.9.0 🍺
+ * Do not edit manually.
+ * Webitel API
+ * OpenAPI spec version: 24.04.0
+ */
+import axios from '@aliasedDeps/api-services/axios';
+
+import type { AxiosRequestConfig, AxiosResponse } from 'axios';
+
+import type {
+	SpacesCreateSpaceParams,
+	SpacesDeleteSpaceParams,
+	SpacesListSpacesParams,
+	SpacesLocateSpaceParams,
+	SpacesUpdateSpaceBody,
+	SpacesUpdateSpaceParams,
+	WebitelKnowledgebaseInputSpace,
+	WebitelKnowledgebaseSpace,
+	WebitelKnowledgebaseSpaceList,
+} from '.././_models';
+
+// --- header start
+//
+
+export const // --- title start
+	getSpaces =
+		// --- title end
+		() => {
+			// --- header end
+			/**
+ * | Field       | Type 
+| ----------- | ---- 
+| **----------- READ-ONLY -----------** | 
+| `id`        | int64 
+| `ver`       | int32 
+| `etag`      | string 
+| **---------- OPERATIONAL ----------** | 
+| `created_at` | int64(epoch:milli) 
+| `created_by` | lookup(user) 
+| `updated_at` | int64(epoch:milli) 
+| `updated_by` | lookup(user) 
+| **---------- ATTRIBUTES -----------** | 
+| `name`      | name! 
+| `home_page`   | string (home_page) 
+| `state`       | bool 
+| `has_children`| bool 
+
+ */
+			const spacesListSpaces = <
+				TData = AxiosResponse<WebitelKnowledgebaseSpaceList>,
+			>(
+				params?: SpacesListSpacesParams,
+				options?: AxiosRequestConfig,
+			): Promise<TData> => {
+				return axios.get('/spaces', {
+					...options,
+					params: { ...params, ...options?.params },
+				});
+			};
+			/**
+			 * @summary Create NEW Space
+			 */
+			const spacesCreateSpace = <
+				TData = AxiosResponse<WebitelKnowledgebaseSpace>,
+			>(
+				webitelKnowledgebaseInputSpace: WebitelKnowledgebaseInputSpace[],
+				params?: SpacesCreateSpaceParams,
+				options?: AxiosRequestConfig,
+			): Promise<TData> => {
+				return axios.post('/spaces', webitelKnowledgebaseInputSpace, {
+					...options,
+					params: { ...params, ...options?.params },
+				});
+			};
+			/**
+			 * @summary Remove Space source
+			 */
+			const spacesDeleteSpace = <
+				TData = AxiosResponse<WebitelKnowledgebaseSpace>,
+			>(
+				etag: string,
+				params?: SpacesDeleteSpaceParams,
+				options?: AxiosRequestConfig,
+			): Promise<TData> => {
+				return axios.delete(`/spaces/${etag}`, {
+					...options,
+					params: { ...params, ...options?.params },
+				});
+			};
+			/**
+			 * @summary Locate spaces source
+			 */
+			const spacesLocateSpace = <
+				TData = AxiosResponse<WebitelKnowledgebaseSpace>,
+			>(
+				etag: string,
+				params?: SpacesLocateSpaceParams,
+				options?: AxiosRequestConfig,
+			): Promise<TData> => {
+				return axios.get(`/spaces/${etag}`, {
+					...options,
+					params: { ...params, ...options?.params },
+				});
+			};
+			/**
+			 * @summary NEW Update of the Space source
+			 */
+			const spacesUpdateSpace = <
+				TData = AxiosResponse<WebitelKnowledgebaseSpace>,
+			>(
+				etag: string,
+				spacesUpdateSpaceBody: SpacesUpdateSpaceBody,
+				params?: SpacesUpdateSpaceParams,
+				options?: AxiosRequestConfig,
+			): Promise<TData> => {
+				return axios.patch(`/spaces/${etag}`, spacesUpdateSpaceBody, {
+					...options,
+					params: { ...params, ...options?.params },
+				});
+			};
+
+			// --- footer start
+			return {
+				spacesListSpaces,
+				spacesCreateSpace,
+				spacesDeleteSpace,
+				spacesLocateSpace,
+				spacesUpdateSpace,
+			};
+		};
+export type SpacesListSpacesResult =
+	AxiosResponse<WebitelKnowledgebaseSpaceList>;
+export type SpacesCreateSpaceResult = AxiosResponse<WebitelKnowledgebaseSpace>;
+export type SpacesDeleteSpaceResult = AxiosResponse<WebitelKnowledgebaseSpace>;
+export type SpacesLocateSpaceResult = AxiosResponse<WebitelKnowledgebaseSpace>;
+export type SpacesUpdateSpaceResult = AxiosResponse<WebitelKnowledgebaseSpace>;
+
+// --- footer end