@webitel/api-services 26.8.38 → 26.8.40

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

@@ -0,0 +1,256 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Webitel API
+ * OpenAPI spec version: 24.04.0
+ */
+import * as zod from 'zod';
+
+/**
+ * @summary Cases of an article the user can read.
+ */
+export const ListArticleCasesParams = zod.object({
+	article_id: zod.string(),
+});
+
+export const ListArticleCasesQueryParams = zod.object({
+	page: zod.int().optional(),
+	size: zod.int().optional(),
+});
+
+export const listArticleCasesResponseItemsItemSourceDefault = `CASE_ARTICLE_SOURCE_UNSPECIFIED`;
+
+export const ListArticleCasesResponse = zod.object({
+	items: zod
+		.array(
+			zod
+				.object({
+					article: zod
+						.object({
+							id: zod.string().optional(),
+							name: zod.string().optional(),
+						})
+						.optional()
+						.describe('Knowledge base article; id only.'),
+					case: zod
+						.object({
+							color: zod.string().optional(),
+							etag: zod.string().optional(),
+							id: zod.string().optional(),
+							name: zod.string().optional(),
+							subject: zod.string().optional(),
+							ver: zod.int().optional(),
+						})
+						.optional()
+						.describe('Linked case; set on the article side.'),
+					created_at: zod
+						.string()
+						.optional()
+						.describe('Unixmilli; empty for the close article.'),
+					created_by: zod
+						.object({
+							id: zod.string().optional(),
+							name: zod.string().optional(),
+						})
+						.optional()
+						.describe('Empty for the close article.'),
+					source: zod
+						.enum([
+							'CASE_ARTICLE_SOURCE_UNSPECIFIED',
+							'CASE_ARTICLE_SOURCE_MANUAL',
+							'CASE_ARTICLE_SOURCE_RESOLUTION',
+						])
+						.default(listArticleCasesResponseItemsItemSourceDefault)
+						.describe(
+							'How a knowledge base article got linked to a case.\n\n - CASE_ARTICLE_SOURCE_MANUAL: Linked by an operator.\n - CASE_ARTICLE_SOURCE_RESOLUTION: The close article of the case.',
+						),
+				})
+				.describe('Knowledge base article linked to a case.'),
+		)
+		.optional(),
+	next: zod.boolean().optional(),
+	page: zod.string().optional(),
+});
+
+/**
+ * @summary Articles of a case, the close article first.
+ */
+export const ListCaseArticlesParams = zod.object({
+	case_etag: zod.string(),
+});
+
+export const ListCaseArticlesQueryParams = zod.object({
+	page: zod.int().optional(),
+	size: zod.int().optional(),
+});
+
+export const listCaseArticlesResponseItemsItemSourceDefault = `CASE_ARTICLE_SOURCE_UNSPECIFIED`;
+
+export const ListCaseArticlesResponse = zod.object({
+	items: zod
+		.array(
+			zod
+				.object({
+					article: zod
+						.object({
+							id: zod.string().optional(),
+							name: zod.string().optional(),
+						})
+						.optional()
+						.describe('Knowledge base article; id only.'),
+					case: zod
+						.object({
+							color: zod.string().optional(),
+							etag: zod.string().optional(),
+							id: zod.string().optional(),
+							name: zod.string().optional(),
+							subject: zod.string().optional(),
+							ver: zod.int().optional(),
+						})
+						.optional()
+						.describe('Linked case; set on the article side.'),
+					created_at: zod
+						.string()
+						.optional()
+						.describe('Unixmilli; empty for the close article.'),
+					created_by: zod
+						.object({
+							id: zod.string().optional(),
+							name: zod.string().optional(),
+						})
+						.optional()
+						.describe('Empty for the close article.'),
+					source: zod
+						.enum([
+							'CASE_ARTICLE_SOURCE_UNSPECIFIED',
+							'CASE_ARTICLE_SOURCE_MANUAL',
+							'CASE_ARTICLE_SOURCE_RESOLUTION',
+						])
+						.default(listCaseArticlesResponseItemsItemSourceDefault)
+						.describe(
+							'How a knowledge base article got linked to a case.\n\n - CASE_ARTICLE_SOURCE_MANUAL: Linked by an operator.\n - CASE_ARTICLE_SOURCE_RESOLUTION: The close article of the case.',
+						),
+				})
+				.describe('Knowledge base article linked to a case.'),
+		)
+		.optional(),
+	next: zod.boolean().optional(),
+	page: zod.string().optional(),
+});
+
+/**
+ * @summary Links an article to a case; linking it again returns the same link.
+ */
+export const LinkCaseArticleParams = zod.object({
+	case_etag: zod.string(),
+});
+
+export const LinkCaseArticleBody = zod.object({
+	article: zod
+		.object({
+			id: zod.string().optional(),
+			name: zod.string().optional(),
+		})
+		.optional()
+		.describe('Knowledge base article to link.'),
+});
+
+export const linkCaseArticleResponseSourceDefault = `CASE_ARTICLE_SOURCE_UNSPECIFIED`;
+
+export const LinkCaseArticleResponse = zod
+	.object({
+		article: zod
+			.object({
+				id: zod.string().optional(),
+				name: zod.string().optional(),
+			})
+			.optional()
+			.describe('Knowledge base article; id only.'),
+		case: zod
+			.object({
+				color: zod.string().optional(),
+				etag: zod.string().optional(),
+				id: zod.string().optional(),
+				name: zod.string().optional(),
+				subject: zod.string().optional(),
+				ver: zod.int().optional(),
+			})
+			.optional()
+			.describe('Linked case; set on the article side.'),
+		created_at: zod
+			.string()
+			.optional()
+			.describe('Unixmilli; empty for the close article.'),
+		created_by: zod
+			.object({
+				id: zod.string().optional(),
+				name: zod.string().optional(),
+			})
+			.optional()
+			.describe('Empty for the close article.'),
+		source: zod
+			.enum([
+				'CASE_ARTICLE_SOURCE_UNSPECIFIED',
+				'CASE_ARTICLE_SOURCE_MANUAL',
+				'CASE_ARTICLE_SOURCE_RESOLUTION',
+			])
+			.default(linkCaseArticleResponseSourceDefault)
+			.describe(
+				'How a knowledge base article got linked to a case.\n\n - CASE_ARTICLE_SOURCE_MANUAL: Linked by an operator.\n - CASE_ARTICLE_SOURCE_RESOLUTION: The close article of the case.',
+			),
+	})
+	.describe('Knowledge base article linked to a case.');
+
+/**
+ * @summary Removes a manual link; the close article is changed on the case itself.
+ */
+export const UnlinkCaseArticleParams = zod.object({
+	case_etag: zod.string(),
+	article_id: zod.string(),
+});
+
+export const unlinkCaseArticleResponseSourceDefault = `CASE_ARTICLE_SOURCE_UNSPECIFIED`;
+
+export const UnlinkCaseArticleResponse = zod
+	.object({
+		article: zod
+			.object({
+				id: zod.string().optional(),
+				name: zod.string().optional(),
+			})
+			.optional()
+			.describe('Knowledge base article; id only.'),
+		case: zod
+			.object({
+				color: zod.string().optional(),
+				etag: zod.string().optional(),
+				id: zod.string().optional(),
+				name: zod.string().optional(),
+				subject: zod.string().optional(),
+				ver: zod.int().optional(),
+			})
+			.optional()
+			.describe('Linked case; set on the article side.'),
+		created_at: zod
+			.string()
+			.optional()
+			.describe('Unixmilli; empty for the close article.'),
+		created_by: zod
+			.object({
+				id: zod.string().optional(),
+				name: zod.string().optional(),
+			})
+			.optional()
+			.describe('Empty for the close article.'),
+		source: zod
+			.enum([
+				'CASE_ARTICLE_SOURCE_UNSPECIFIED',
+				'CASE_ARTICLE_SOURCE_MANUAL',
+				'CASE_ARTICLE_SOURCE_RESOLUTION',
+			])
+			.default(unlinkCaseArticleResponseSourceDefault)
+			.describe(
+				'How a knowledge base article got linked to a case.\n\n - CASE_ARTICLE_SOURCE_MANUAL: Linked by an operator.\n - CASE_ARTICLE_SOURCE_RESOLUTION: The close article of the case.',
+			),
+	})
+	.describe('Knowledge base article linked to a case.');

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

@@ -13,6 +13,7 @@ import type {
 	DeleteCaseParams,
 	ExportCases200,
 	ExportCasesParams,
+	LocateCaseNeighborParams,
 	LocateCaseParams,
 	SearchCases2Params,
 	SearchCasesParams,
@@ -112,6 +113,22 @@ export const // --- title start
 					},
 				});
 			};
+			/**
+			 * @summary RPC method to step one case forward or backward through the list.
+			 */
+			const locateCaseNeighbor = (
+				etag: string,
+				params?: LocateCaseNeighborParams,
+				options?: AxiosRequestConfig,
+			): Promise<AxiosResponse<WebitelCasesCase>> => {
+				return axiosInstance.get(`/cases/${etag}/neighbor`, {
+					...options,
+					params: {
+						...params,
+						...options?.params,
+					},
+				});
+			};
 			/**
 			 * @summary RPC method for updating an existing case.
 			 */
@@ -170,6 +187,7 @@ export const // --- title start
 				exportCases,
 				deleteCase,
 				locateCase,
+				locateCaseNeighbor,
 				updateCase2,
 				updateCase,
 				searchCases2,
@@ -180,6 +198,7 @@ export type CreateCaseResult = AxiosResponse<WebitelCasesCase>;
 export type ExportCasesResult = AxiosResponse<ExportCases200>;
 export type DeleteCaseResult = AxiosResponse<WebitelCasesCase>;
 export type LocateCaseResult = AxiosResponse<WebitelCasesCase>;
+export type LocateCaseNeighborResult = AxiosResponse<WebitelCasesCase>;
 export type UpdateCase2Result = AxiosResponse<WebitelCasesUpdateCaseResponse>;
 export type UpdateCaseResult = AxiosResponse<WebitelCasesUpdateCaseResponse>;
 export type SearchCases2Result = AxiosResponse<WebitelCasesCaseList>;