@webitel/api-services 26.8.39 → 26.8.41

package/src/gen-wire/_models/webitelImProviderV1ProviderUpdateCustomGateResponse.ts

@@ -0,0 +1,14 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Webitel API
+ * OpenAPI spec version: 24.04.0
+ */
+import type { WebitelImProviderV1ProviderCustomGate } from './webitelImProviderV1ProviderCustomGate';
+
+/**
+ * / ProviderUpdateCustomGateResponse returns the updated custom provider.
+ */
+export interface WebitelImProviderV1ProviderUpdateCustomGateResponse {
+	item?: WebitelImProviderV1ProviderCustomGate;
+}

package/src/gen-wire/_models/webitelImProviderV1ProviderUpdateViberBmGateResponse.ts

@@ -0,0 +1,14 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Webitel API
+ * OpenAPI spec version: 24.04.0
+ */
+import type { WebitelImProviderV1ProviderViberBmGate } from './webitelImProviderV1ProviderViberBmGate';
+
+/**
+ * / ProviderUpdateViberBmGateResponse returns the updated gateway.
+ */
+export interface WebitelImProviderV1ProviderUpdateViberBmGateResponse {
+	item?: WebitelImProviderV1ProviderViberBmGate;
+}

package/src/gen-wire/_models/webitelImProviderV1ProviderViberBmGate.ts

@@ -0,0 +1,22 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Webitel API
+ * OpenAPI spec version: 24.04.0
+ */
+import type { WebitelImProviderV1ProviderStatus } from './webitelImProviderV1ProviderStatus';
+
+/**
+ * / ProviderViberBmGate is a configured InfoBip Viber BM gateway.
+ */
+export interface WebitelImProviderV1ProviderViberBmGate {
+	base_url?: string;
+	created_at?: string;
+	enabled?: boolean;
+	id?: string;
+	name?: string;
+	sender_name?: string;
+	status?: WebitelImProviderV1ProviderStatus;
+	updated_at?: string;
+	webhook_url?: string;
+}

package/src/gen-wire/_models/webitelImProviderV1SendViberBmTemplateResponse.ts

@@ -0,0 +1,14 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Webitel API
+ * OpenAPI spec version: 24.04.0
+ */
+
+/**
+ * / SendViberBmTemplateResponse confirms the template dispatch.
+ */
+export interface WebitelImProviderV1SendViberBmTemplateResponse {
+	bulk_id?: string;
+	message_id?: string;
+}

package/src/gen-wire/_models/webitelImProviderV1ViberBmServiceSendViberBmTemplateBody.ts

@@ -0,0 +1,17 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Webitel API
+ * OpenAPI spec version: 24.04.0
+ */
+import type { WebitelImProviderV1ViberBmServiceSendViberBmTemplateBodyParameters } from './webitelImProviderV1ViberBmServiceSendViberBmTemplateBodyParameters';
+
+/**
+ * / SendViberBmTemplateRequest sends an approved cold-start template.
+ */
+export interface WebitelImProviderV1ViberBmServiceSendViberBmTemplateBody {
+	parameters?: WebitelImProviderV1ViberBmServiceSendViberBmTemplateBodyParameters;
+	language?: string;
+	template_id?: string;
+	to?: string;
+}

package/src/gen-wire/_models/webitelImProviderV1ViberBmServiceSendViberBmTemplateBodyParameters.ts

@@ -0,0 +1,11 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Webitel API
+ * OpenAPI spec version: 24.04.0
+ */
+
+export type WebitelImProviderV1ViberBmServiceSendViberBmTemplateBodyParameters =
+	{
+		[key: string]: string;
+	};

package/src/gen-wire/_models/webitelImProviderV1ViberBmServiceUpdateViberBmBody.ts

@@ -0,0 +1,20 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Webitel API
+ * OpenAPI spec version: 24.04.0
+ */
+import type { WebitelImProviderV1Peer } from './webitelImProviderV1Peer';
+
+/**
+ * / ProviderUpdateViberBmGateRequest updates settings. A non-empty api_key rotates the key.
+ */
+export interface WebitelImProviderV1ViberBmServiceUpdateViberBmBody {
+	api_key?: string;
+	base_url?: string;
+	enabled?: boolean;
+	name?: string;
+	peer?: WebitelImProviderV1Peer;
+	sender_name?: string;
+	webhook_secret?: string;
+}

package/src/gen-wire/_models/webitelKbArticleType.ts

@@ -6,7 +6,7 @@
  */
 
 /**
- * Article type.
+ * Article kind.
  */
 export type WebitelKbArticleType =
 	(typeof WebitelKbArticleType)[keyof typeof WebitelKbArticleType];

package/src/gen-wire/_models/webitelKbAttachmentsAttachFileBody.ts

@@ -0,0 +1,14 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Webitel API
+ * OpenAPI spec version: 24.04.0
+ */
+
+/**
+ * AttachFileRequest binds a file already uploaded to Storage.
+ */
+export interface WebitelKbAttachmentsAttachFileBody {
+	/** Storage file id, as the upload returned it. */
+	file_id?: string;
+}

package/src/gen-wire/_models/webitelKbFile.ts

@@ -12,7 +12,7 @@ import type { GeneralExtendedLookup } from './generalExtendedLookup';
 export interface WebitelKbFile {
 	/** CreatedAt timestamp (epoch ms). */
 	created_at?: string;
-	/** User who uploaded the file. */
+	/** User who attached the file. */
 	created_by?: GeneralExtendedLookup;
 	/** Storage file id. */
 	id?: string;
@@ -22,8 +22,6 @@ export interface WebitelKbFile {
 	name?: string;
 	/** File size in bytes. */
 	size?: string;
-	/** Storage source. */
-	source?: string;
 	/** Download url. */
 	url?: string;
 }

package/src/gen-wire/agent-chat-service/agent-chat-service.zod.ts

@@ -26,6 +26,10 @@ export const AgentChatServiceGetAgentChatsResponse = zod.object({
 				closed_at: zod.string().optional(),
 				contact: zod
 					.object({
+						etag: zod
+							.string()
+							.optional()
+							.describe('Contact source identifier.'),
 						id: zod
 							.string()
 							.optional()
@@ -42,6 +46,10 @@ export const AgentChatServiceGetAgentChatsResponse = zod.object({
 					.describe('Peer contact.'),
 				gateway: zod
 					.object({
+						etag: zod
+							.string()
+							.optional()
+							.describe('Contact source identifier.'),
 						id: zod
 							.string()
 							.optional()
@@ -91,6 +99,10 @@ export const AgentChatServiceGetAgentChatsResponse = zod.object({
 								left: zod.string().optional(),
 								peer: zod
 									.object({
+										etag: zod
+											.string()
+											.optional()
+											.describe('Contact source identifier.'),
 										id: zod
 											.string()
 											.optional()
@@ -110,6 +122,10 @@ export const AgentChatServiceGetAgentChatsResponse = zod.object({
 									.describe('[FROM]: User identity. Seed.'),
 								queue: zod
 									.object({
+										etag: zod
+											.string()
+											.optional()
+											.describe('Contact source identifier.'),
 										id: zod
 											.string()
 											.optional()
@@ -130,6 +146,10 @@ export const AgentChatServiceGetAgentChatsResponse = zod.object({
 								title: zod.string().optional().describe('[TO]: Chat title.'),
 								via: zod
 									.object({
+										etag: zod
+											.string()
+											.optional()
+											.describe('Contact source identifier.'),
 										id: zod
 											.string()
 											.optional()
@@ -174,6 +194,10 @@ export const AgentChatServiceGetAgentChatsResponse = zod.object({
 							.describe('Message Media. Attachment.'),
 						from: zod
 							.object({
+								etag: zod
+									.string()
+									.optional()
+									.describe('Contact source identifier.'),
 								id: zod
 									.string()
 									.optional()
@@ -291,6 +315,10 @@ export const AgentChatServiceGetAgentChatsResponse = zod.object({
 								left: zod.string().optional(),
 								peer: zod
 									.object({
+										etag: zod
+											.string()
+											.optional()
+											.describe('Contact source identifier.'),
 										id: zod
 											.string()
 											.optional()
@@ -310,6 +338,10 @@ export const AgentChatServiceGetAgentChatsResponse = zod.object({
 									.describe('[FROM]: User identity. Seed.'),
 								queue: zod
 									.object({
+										etag: zod
+											.string()
+											.optional()
+											.describe('Contact source identifier.'),
 										id: zod
 											.string()
 											.optional()
@@ -330,6 +362,10 @@ export const AgentChatServiceGetAgentChatsResponse = zod.object({
 								title: zod.string().optional().describe('[TO]: Chat title.'),
 								via: zod
 									.object({
+										etag: zod
+											.string()
+											.optional()
+											.describe('Contact source identifier.'),
 										id: zod
 											.string()
 											.optional()
@@ -358,6 +394,10 @@ export const AgentChatServiceGetAgentChatsResponse = zod.object({
 					.describe('Chat Message.'),
 				queue: zod
 					.object({
+						etag: zod
+							.string()
+							.optional()
+							.describe('Contact source identifier.'),
 						id: zod
 							.string()
 							.optional()

package/src/gen-wire/agent-chat-tag-service/agent-chat-tag-service.ts

@@ -0,0 +1,41 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Webitel API
+ * OpenAPI spec version: 24.04.0
+ */
+import type { AxiosInstance, AxiosRequestConfig, AxiosResponse } from 'axios';
+
+import axios from '../../api/axios/genClient';
+
+import type { EngineListChatTag, SearchAgentChatTagParams } from '../_models';
+
+// --- header start
+//
+
+export const // --- title start
+	getAgentChatTagService =
+		// --- title end
+		(axiosInstance: AxiosInstance = axios) => {
+			// --- header end
+			const searchAgentChatTag = (
+				params?: SearchAgentChatTagParams,
+				options?: AxiosRequestConfig,
+			): Promise<AxiosResponse<EngineListChatTag>> => {
+				return axiosInstance.get(`/call_center/agents/chat_tags`, {
+					...options,
+					params: {
+						...params,
+						...options?.params,
+					},
+				});
+			};
+
+			// --- footer start
+			return {
+				searchAgentChatTag,
+			};
+		};
+export type SearchAgentChatTagResult = AxiosResponse<EngineListChatTag>;
+
+// --- footer end

package/src/gen-wire/agent-chat-tag-service/agent-chat-tag-service.zod.ts

@@ -0,0 +1,28 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Webitel API
+ * OpenAPI spec version: 24.04.0
+ */
+import * as zod from 'zod';
+
+export const SearchAgentChatTagQueryParams = zod.object({
+	page: zod.int().optional(),
+	size: zod.int().optional(),
+	q: zod.string().optional(),
+	sort: zod.string().optional(),
+	fields: zod.array(zod.string()).optional(),
+	id: zod.array(zod.int()).optional(),
+});
+
+export const SearchAgentChatTagResponse = zod.object({
+	items: zod
+		.array(
+			zod.object({
+				id: zod.int().optional(),
+				tag: zod.string().optional(),
+			}),
+		)
+		.optional(),
+	next: zod.boolean().optional(),
+});

package/src/gen-wire/attachments/attachments.ts

@@ -10,6 +10,7 @@ import axios from '../../api/axios/genClient';
 
 import type {
 	ListFilesAttachmentsParams,
+	WebitelKbAttachmentsAttachFileBody,
 	WebitelKbFile,
 	WebitelKbFileList,
 } from '../_models';
@@ -38,6 +39,20 @@ export const // --- title start
 					},
 				});
 			};
+			/**
+			 * @summary AttachFile binds an uploaded file to an article.
+			 */
+			const attachFile = (
+				articleEtag: string,
+				webitelKbAttachmentsAttachFileBody: WebitelKbAttachmentsAttachFileBody,
+				options?: AxiosRequestConfig,
+			): Promise<AxiosResponse<WebitelKbFile>> => {
+				return axiosInstance.post(
+					`/v1/kb/articles/${articleEtag}/files`,
+					webitelKbAttachmentsAttachFileBody,
+					options,
+				);
+			};
 			/**
 			 * @summary DeleteFile unbinds and removes a file from an article.
 			 */
@@ -55,10 +70,12 @@ export const // --- title start
 			// --- footer start
 			return {
 				listFilesAttachments,
+				attachFile,
 				deleteFileAttachments,
 			};
 		};
 export type ListFilesAttachmentsResult = AxiosResponse<WebitelKbFileList>;
+export type AttachFileResult = AxiosResponse<WebitelKbFile>;
 export type DeleteFileAttachmentsResult = AxiosResponse<WebitelKbFile>;
 
 // --- footer end

package/src/gen-wire/attachments/attachments.zod.ts

@@ -47,12 +47,11 @@ export const ListFilesAttachmentsResponse = zod
 								type: zod.string().optional(),
 							})
 							.optional()
-							.describe('User who uploaded the file.'),
+							.describe('User who attached the file.'),
 						id: zod.string().optional().describe('Storage file id.'),
 						mime: zod.string().optional().describe('MIME type.'),
 						name: zod.string().optional().describe('File name.'),
 						size: zod.string().optional().describe('File size in bytes.'),
-						source: zod.string().optional().describe('Storage source.'),
 						url: zod.string().optional().describe('Download url.'),
 					})
 					.describe('File is metadata of a stored file bound to an article.'),
@@ -63,6 +62,46 @@ export const ListFilesAttachmentsResponse = zod
 	})
 	.describe('FileList is a page of files.');
 
+/**
+ * @summary AttachFile binds an uploaded file to an article.
+ */
+export const AttachFileParams = zod.object({
+	article_etag: zod
+		.string()
+		.describe('Concurrency token / locator of the owning article.'),
+});
+
+export const AttachFileBody = zod
+	.object({
+		file_id: zod
+			.string()
+			.optional()
+			.describe('Storage file id, as the upload returned it.'),
+	})
+	.describe('AttachFileRequest binds a file already uploaded to Storage.');
+
+export const AttachFileResponse = zod
+	.object({
+		created_at: zod
+			.string()
+			.optional()
+			.describe('CreatedAt timestamp (epoch ms).'),
+		created_by: zod
+			.object({
+				id: zod.string().optional(),
+				name: zod.string().optional(),
+				type: zod.string().optional(),
+			})
+			.optional()
+			.describe('User who attached the file.'),
+		id: zod.string().optional().describe('Storage file id.'),
+		mime: zod.string().optional().describe('MIME type.'),
+		name: zod.string().optional().describe('File name.'),
+		size: zod.string().optional().describe('File size in bytes.'),
+		url: zod.string().optional().describe('Download url.'),
+	})
+	.describe('File is metadata of a stored file bound to an article.');
+
 /**
  * @summary DeleteFile unbinds and removes a file from an article.
  */
@@ -86,12 +125,11 @@ export const DeleteFileAttachmentsResponse = zod
 				type: zod.string().optional(),
 			})
 			.optional()
-			.describe('User who uploaded the file.'),
+			.describe('User who attached the file.'),
 		id: zod.string().optional().describe('Storage file id.'),
 		mime: zod.string().optional().describe('MIME type.'),
 		name: zod.string().optional().describe('File name.'),
 		size: zod.string().optional().describe('File size in bytes.'),
-		source: zod.string().optional().describe('Storage source.'),
 		url: zod.string().optional().describe('Download url.'),
 	})
 	.describe('File is metadata of a stored file bound to an article.');

package/src/gen-wire/call-service/call-service.ts

@@ -19,6 +19,7 @@ import type {
 	EngineCallServiceEavesdropCallBody,
 	EngineCallServiceHangupCallBody,
 	EngineCallServiceHoldCallBody,
+	EngineCallServicePatchHistoryCallAttemptBody,
 	EngineCallServicePatchHistoryCallBody,
 	EngineCallServiceRedialCallBody,
 	EngineCallServiceSetVariablesCallBody,
@@ -34,6 +35,7 @@ import type {
 	EngineListAggregate,
 	EngineListCall,
 	EngineListHistoryCall,
+	EnginePatchHistoryCallAttemptResponse,
 	EngineSearchHistoryCallRequest,
 	EngineSetVariablesCallResponse,
 	ReadCallParams,
@@ -313,6 +315,20 @@ Group and aggregate metrics like average duration, call counts, or peak hours.
 					options,
 				);
 			};
+			/**
+			 * @summary PatchHistoryCallAttempt performs update of history attempt binded to call.
+			 */
+			const patchHistoryCallAttempt = (
+				id: string,
+				engineCallServicePatchHistoryCallAttemptBody: EngineCallServicePatchHistoryCallAttemptBody,
+				options?: AxiosRequestConfig,
+			): Promise<AxiosResponse<EnginePatchHistoryCallAttemptResponse>> => {
+				return axiosInstance.patch(
+					`/calls/history/${id}/attempt`,
+					engineCallServicePatchHistoryCallAttemptBody,
+					options,
+				);
+			};
 
 			// --- footer start
 			return {
@@ -335,6 +351,7 @@ Group and aggregate metrics like average duration, call counts, or peak hours.
 				updateCallAnnotation,
 				redialCall,
 				patchHistoryCall,
+				patchHistoryCallAttempt,
 			};
 		};
 export type CreateCallResult = AxiosResponse<EngineCreateCallResponse>;
@@ -358,5 +375,7 @@ export type DeleteCallAnnotationResult = AxiosResponse<EngineCallAnnotation>;
 export type UpdateCallAnnotationResult = AxiosResponse<EngineCallAnnotation>;
 export type RedialCallResult = AxiosResponse<EngineCreateCallResponse>;
 export type PatchHistoryCallResult = AxiosResponse<EngineHistoryCall>;
+export type PatchHistoryCallAttemptResult =
+	AxiosResponse<EnginePatchHistoryCallAttemptResponse>;
 
 // --- footer end

package/src/gen-wire/call-service/call-service.zod.ts

@@ -773,6 +773,7 @@ export const SearchHistoryCallResponse = zod.object({
 						name: zod.string().optional(),
 					})
 					.optional(),
+				user_agent: zod.string().optional(),
 				variables: zod.record(zod.string(), zod.string()).optional(),
 				wait_sec: zod.int().optional(),
 			}),
@@ -1170,6 +1171,7 @@ export const SearchHistoryCallPostResponse = zod.object({
 						name: zod.string().optional(),
 					})
 					.optional(),
+				user_agent: zod.string().optional(),
 				variables: zod.record(zod.string(), zod.string()).optional(),
 				wait_sec: zod.int().optional(),
 			}),
@@ -1695,6 +1697,25 @@ export const PatchHistoryCallResponse = zod.object({
 			name: zod.string().optional(),
 		})
 		.optional(),
+	user_agent: zod.string().optional(),
 	variables: zod.record(zod.string(), zod.string()).optional(),
 	wait_sec: zod.int().optional(),
 });
+
+/**
+ * @summary PatchHistoryCallAttempt performs update of history attempt binded to call.
+ */
+export const PatchHistoryCallAttemptParams = zod.object({
+	id: zod.string(),
+});
+
+export const PatchHistoryCallAttemptBody = zod.object({
+	description: zod.string().optional(),
+	variables: zod.record(zod.string(), zod.string()).optional(),
+});
+
+export const PatchHistoryCallAttemptResponse = zod.object({
+	description: zod.string().optional(),
+	id: zod.string().optional(),
+	variables: zod.record(zod.string(), zod.string()).optional(),
+});

package/src/gen-wire/case-articles/case-articles.ts

@@ -0,0 +1,100 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Webitel API
+ * OpenAPI spec version: 24.04.0
+ */
+import type { AxiosInstance, AxiosRequestConfig, AxiosResponse } from 'axios';
+
+import axios from '../../api/axios/genClient';
+
+import type {
+	ListArticleCasesParams,
+	ListCaseArticlesParams,
+	WebitelCasesCaseArticle,
+	WebitelCasesCaseArticleList,
+	WebitelCasesInputCaseArticle,
+} from '../_models';
+
+// --- header start
+//
+
+export const // --- title start
+	getCaseArticles =
+		// --- title end
+		(axiosInstance: AxiosInstance = axios) => {
+			// --- header end
+			/**
+			 * @summary Cases of an article the user can read.
+			 */
+			const listArticleCases = (
+				articleId: string,
+				params?: ListArticleCasesParams,
+				options?: AxiosRequestConfig,
+			): Promise<AxiosResponse<WebitelCasesCaseArticleList>> => {
+				return axiosInstance.get(`/cases/articles/${articleId}/cases`, {
+					...options,
+					params: {
+						...params,
+						...options?.params,
+					},
+				});
+			};
+			/**
+			 * @summary Articles of a case, the close article first.
+			 */
+			const listCaseArticles = (
+				caseEtag: string,
+				params?: ListCaseArticlesParams,
+				options?: AxiosRequestConfig,
+			): Promise<AxiosResponse<WebitelCasesCaseArticleList>> => {
+				return axiosInstance.get(`/cases/${caseEtag}/articles`, {
+					...options,
+					params: {
+						...params,
+						...options?.params,
+					},
+				});
+			};
+			/**
+			 * @summary Links an article to a case; linking it again returns the same link.
+			 */
+			const linkCaseArticle = (
+				caseEtag: string,
+				webitelCasesInputCaseArticle: WebitelCasesInputCaseArticle,
+				options?: AxiosRequestConfig,
+			): Promise<AxiosResponse<WebitelCasesCaseArticle>> => {
+				return axiosInstance.post(
+					`/cases/${caseEtag}/articles`,
+					webitelCasesInputCaseArticle,
+					options,
+				);
+			};
+			/**
+			 * @summary Removes a manual link; the close article is changed on the case itself.
+			 */
+			const unlinkCaseArticle = (
+				caseEtag: string,
+				articleId: string,
+				options?: AxiosRequestConfig,
+			): Promise<AxiosResponse<WebitelCasesCaseArticle>> => {
+				return axiosInstance.delete(
+					`/cases/${caseEtag}/articles/${articleId}`,
+					options,
+				);
+			};
+
+			// --- footer start
+			return {
+				listArticleCases,
+				listCaseArticles,
+				linkCaseArticle,
+				unlinkCaseArticle,
+			};
+		};
+export type ListArticleCasesResult = AxiosResponse<WebitelCasesCaseArticleList>;
+export type ListCaseArticlesResult = AxiosResponse<WebitelCasesCaseArticleList>;
+export type LinkCaseArticleResult = AxiosResponse<WebitelCasesCaseArticle>;
+export type UnlinkCaseArticleResult = AxiosResponse<WebitelCasesCaseArticle>;
+
+// --- footer end