@webitel/api-services 26.8.39 → 26.8.40

package/src/gen-wire/webitel-im-provider-v1-customservice/webitel-im-provider-v1-customservice.ts

@@ -0,0 +1,99 @@
+/**
+ * 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 {
+	WebitelImProviderV1CustomServiceUpdateCustomGateBody,
+	WebitelImProviderV1ProviderCreateCustomGateRequest,
+	WebitelImProviderV1ProviderCreateCustomGateResponse,
+	WebitelImProviderV1ProviderDeleteCustomGateResponse,
+	WebitelImProviderV1ProviderGetCustomGateResponse,
+	WebitelImProviderV1ProviderUpdateCustomGateResponse,
+} from '../_models';
+
+// --- header start
+//
+
+export const // --- title start
+	getWebitelImProviderV1Customservice =
+		// --- title end
+		(axiosInstance: AxiosInstance = axios) => {
+			// --- header end
+			/**
+			 * @summary / CreateCustomGate registers an external system as a messaging gateway.
+			 */
+			const customServiceCreateCustomGate = (
+				webitelImProviderV1ProviderCreateCustomGateRequest: WebitelImProviderV1ProviderCreateCustomGateRequest,
+				options?: AxiosRequestConfig,
+			): Promise<
+				AxiosResponse<WebitelImProviderV1ProviderCreateCustomGateResponse>
+			> => {
+				return axiosInstance.post(
+					`/im/gates/custom`,
+					webitelImProviderV1ProviderCreateCustomGateRequest,
+					options,
+				);
+			};
+			/**
+			 * @summary / DeleteCustomGate removes the custom gateway integration.
+			 */
+			const customServiceDeleteCustomGate = (
+				id: string,
+				options?: AxiosRequestConfig,
+			): Promise<
+				AxiosResponse<WebitelImProviderV1ProviderDeleteCustomGateResponse>
+			> => {
+				return axiosInstance.delete(`/im/gates/custom/${id}`, options);
+			};
+			/**
+			 * @summary / GetCustomGate retrieves configuration and status for a custom gateway.
+			 */
+			const customServiceGetCustomGate = (
+				id: string,
+				options?: AxiosRequestConfig,
+			): Promise<
+				AxiosResponse<WebitelImProviderV1ProviderGetCustomGateResponse>
+			> => {
+				return axiosInstance.get(`/im/gates/custom/${id}`, options);
+			};
+			/**
+			 * @summary / UpdateCustomGate updates custom gateway settings.
+			 */
+			const customServiceUpdateCustomGate = (
+				id: string,
+				webitelImProviderV1CustomServiceUpdateCustomGateBody: WebitelImProviderV1CustomServiceUpdateCustomGateBody,
+				options?: AxiosRequestConfig,
+			): Promise<
+				AxiosResponse<WebitelImProviderV1ProviderUpdateCustomGateResponse>
+			> => {
+				return axiosInstance.patch(
+					`/im/gates/custom/${id}`,
+					webitelImProviderV1CustomServiceUpdateCustomGateBody,
+					options,
+				);
+			};
+
+			// --- footer start
+			return {
+				customServiceCreateCustomGate,
+				customServiceDeleteCustomGate,
+				customServiceGetCustomGate,
+				customServiceUpdateCustomGate,
+			};
+		};
+export type CustomServiceCreateCustomGateResult =
+	AxiosResponse<WebitelImProviderV1ProviderCreateCustomGateResponse>;
+export type CustomServiceDeleteCustomGateResult =
+	AxiosResponse<WebitelImProviderV1ProviderDeleteCustomGateResponse>;
+export type CustomServiceGetCustomGateResult =
+	AxiosResponse<WebitelImProviderV1ProviderGetCustomGateResponse>;
+export type CustomServiceUpdateCustomGateResult =
+	AxiosResponse<WebitelImProviderV1ProviderUpdateCustomGateResponse>;
+
+// --- footer end

package/src/gen-wire/webitel-im-provider-v1-customservice/webitel-im-provider-v1-customservice.zod.ts

@@ -0,0 +1,319 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Webitel API
+ * OpenAPI spec version: 24.04.0
+ */
+import * as zod from 'zod';
+
+/**
+ * @summary / CreateCustomGate registers an external system as a messaging gateway.
+ */
+export const CustomServiceCreateCustomGateBody = zod
+	.object({
+		allowed_ips: zod.array(zod.string()).optional(),
+		app_secret: zod.string().optional(),
+		callback_url: zod.string().optional(),
+		enabled: zod.boolean().optional(),
+		name: zod.string().optional(),
+		peer: zod
+			.object({
+				iss: zod.string().optional(),
+				sub: zod.string().optional(),
+			})
+			.optional(),
+		request_timeout_ms: zod.int().optional(),
+		retry_attempts: zod.int().optional(),
+	})
+	.describe(
+		'/ ProviderCreateCustomGateRequest registers an arbitrary external communication\n/ system as a chat channel. Only configuration is required on the Webitel side:\n/ the external system posts signed updates to the generated webhook_url and\n/ receives operator replies on callback_url.',
+	);
+
+export const customServiceCreateCustomGateResponseItemStatusDefault = `PROVIDER_STATUS_UNSPECIFIED`;
+
+export const CustomServiceCreateCustomGateResponse = zod
+	.object({
+		item: zod
+			.object({
+				allowed_ips: zod
+					.array(zod.string())
+					.optional()
+					.describe(
+						'Optional CIDR allowlist; an empty list accepts any source address.',
+					),
+				app_secret: zod
+					.string()
+					.optional()
+					.describe(
+						'Shared secret used to sign and verify X-Webitel-Sign in both directions; handled as sensitive.',
+					),
+				callback_url: zod
+					.string()
+					.optional()
+					.describe(
+						'Customer-side webhook Webitel posts operator replies and events to.',
+					),
+				created_at: zod.string().optional(),
+				enabled: zod.boolean().optional(),
+				id: zod.string().optional(),
+				name: zod.string().optional(),
+				request_timeout_ms: zod
+					.int()
+					.optional()
+					.describe(
+						'Timeout of a single outbound callback attempt, in milliseconds.',
+					),
+				retry_attempts: zod
+					.int()
+					.optional()
+					.describe(
+						'How many times an outbound callback is retried before the message is marked failed.',
+					),
+				status: zod
+					.enum([
+						'PROVIDER_STATUS_UNSPECIFIED',
+						'PROVIDER_STATUS_ACTIVE',
+						'PROVIDER_STATUS_INACTIVE',
+						'PROVIDER_STATUS_ERROR',
+					])
+					.default(customServiceCreateCustomGateResponseItemStatusDefault)
+					.describe(
+						'/ ProviderStatus represents the operational state of a provider gateway.\n\n - PROVIDER_STATUS_ACTIVE: Provider is healthy and processing messages\n - PROVIDER_STATUS_INACTIVE: Manually disabled by user\n - PROVIDER_STATUS_ERROR: Connection or authentication failed',
+					),
+				updated_at: zod.string().optional(),
+				webhook_url: zod
+					.string()
+					.optional()
+					.describe(
+						'Webitel-side webhook the external system posts updates to.',
+					),
+			})
+			.optional(),
+	})
+	.describe(
+		'/ ProviderCreateCustomGateResponse returns the newly activated custom provider.',
+	);
+
+/**
+ * @summary / DeleteCustomGate removes the custom gateway integration.
+ */
+export const CustomServiceDeleteCustomGateParams = zod.object({
+	id: zod.string(),
+});
+
+export const customServiceDeleteCustomGateResponseItemStatusDefault = `PROVIDER_STATUS_UNSPECIFIED`;
+
+export const CustomServiceDeleteCustomGateResponse = zod.object({
+	item: zod
+		.object({
+			allowed_ips: zod
+				.array(zod.string())
+				.optional()
+				.describe(
+					'Optional CIDR allowlist; an empty list accepts any source address.',
+				),
+			app_secret: zod
+				.string()
+				.optional()
+				.describe(
+					'Shared secret used to sign and verify X-Webitel-Sign in both directions; handled as sensitive.',
+				),
+			callback_url: zod
+				.string()
+				.optional()
+				.describe(
+					'Customer-side webhook Webitel posts operator replies and events to.',
+				),
+			created_at: zod.string().optional(),
+			enabled: zod.boolean().optional(),
+			id: zod.string().optional(),
+			name: zod.string().optional(),
+			request_timeout_ms: zod
+				.int()
+				.optional()
+				.describe(
+					'Timeout of a single outbound callback attempt, in milliseconds.',
+				),
+			retry_attempts: zod
+				.int()
+				.optional()
+				.describe(
+					'How many times an outbound callback is retried before the message is marked failed.',
+				),
+			status: zod
+				.enum([
+					'PROVIDER_STATUS_UNSPECIFIED',
+					'PROVIDER_STATUS_ACTIVE',
+					'PROVIDER_STATUS_INACTIVE',
+					'PROVIDER_STATUS_ERROR',
+				])
+				.default(customServiceDeleteCustomGateResponseItemStatusDefault)
+				.describe(
+					'/ ProviderStatus represents the operational state of a provider gateway.\n\n - PROVIDER_STATUS_ACTIVE: Provider is healthy and processing messages\n - PROVIDER_STATUS_INACTIVE: Manually disabled by user\n - PROVIDER_STATUS_ERROR: Connection or authentication failed',
+				),
+			updated_at: zod.string().optional(),
+			webhook_url: zod
+				.string()
+				.optional()
+				.describe('Webitel-side webhook the external system posts updates to.'),
+		})
+		.optional(),
+});
+
+/**
+ * @summary / GetCustomGate retrieves configuration and status for a custom gateway.
+ */
+export const CustomServiceGetCustomGateParams = zod.object({
+	id: zod.string(),
+});
+
+export const customServiceGetCustomGateResponseItemStatusDefault = `PROVIDER_STATUS_UNSPECIFIED`;
+
+export const CustomServiceGetCustomGateResponse = zod.object({
+	item: zod
+		.object({
+			allowed_ips: zod
+				.array(zod.string())
+				.optional()
+				.describe(
+					'Optional CIDR allowlist; an empty list accepts any source address.',
+				),
+			app_secret: zod
+				.string()
+				.optional()
+				.describe(
+					'Shared secret used to sign and verify X-Webitel-Sign in both directions; handled as sensitive.',
+				),
+			callback_url: zod
+				.string()
+				.optional()
+				.describe(
+					'Customer-side webhook Webitel posts operator replies and events to.',
+				),
+			created_at: zod.string().optional(),
+			enabled: zod.boolean().optional(),
+			id: zod.string().optional(),
+			name: zod.string().optional(),
+			request_timeout_ms: zod
+				.int()
+				.optional()
+				.describe(
+					'Timeout of a single outbound callback attempt, in milliseconds.',
+				),
+			retry_attempts: zod
+				.int()
+				.optional()
+				.describe(
+					'How many times an outbound callback is retried before the message is marked failed.',
+				),
+			status: zod
+				.enum([
+					'PROVIDER_STATUS_UNSPECIFIED',
+					'PROVIDER_STATUS_ACTIVE',
+					'PROVIDER_STATUS_INACTIVE',
+					'PROVIDER_STATUS_ERROR',
+				])
+				.default(customServiceGetCustomGateResponseItemStatusDefault)
+				.describe(
+					'/ ProviderStatus represents the operational state of a provider gateway.\n\n - PROVIDER_STATUS_ACTIVE: Provider is healthy and processing messages\n - PROVIDER_STATUS_INACTIVE: Manually disabled by user\n - PROVIDER_STATUS_ERROR: Connection or authentication failed',
+				),
+			updated_at: zod.string().optional(),
+			webhook_url: zod
+				.string()
+				.optional()
+				.describe('Webitel-side webhook the external system posts updates to.'),
+		})
+		.optional(),
+});
+
+/**
+ * @summary / UpdateCustomGate updates custom gateway settings.
+ */
+export const CustomServiceUpdateCustomGateParams = zod.object({
+	id: zod.string(),
+});
+
+export const CustomServiceUpdateCustomGateBody = zod
+	.object({
+		allowed_ips: zod.array(zod.string()).optional(),
+		app_secret: zod.string().optional(),
+		callback_url: zod.string().optional(),
+		enabled: zod.boolean().optional(),
+		name: zod.string().optional(),
+		peer: zod
+			.object({
+				iss: zod.string().optional(),
+				sub: zod.string().optional(),
+			})
+			.optional(),
+		request_timeout_ms: zod.int().optional(),
+		retry_attempts: zod.int().optional(),
+	})
+	.describe(
+		'/ ProviderUpdateCustomGateRequest updates custom gateway settings. A non-empty\n/ app_secret rotates the signing secret and breaks the integration until the\n/ external system is updated too.',
+	);
+
+export const customServiceUpdateCustomGateResponseItemStatusDefault = `PROVIDER_STATUS_UNSPECIFIED`;
+
+export const CustomServiceUpdateCustomGateResponse = zod
+	.object({
+		item: zod
+			.object({
+				allowed_ips: zod
+					.array(zod.string())
+					.optional()
+					.describe(
+						'Optional CIDR allowlist; an empty list accepts any source address.',
+					),
+				app_secret: zod
+					.string()
+					.optional()
+					.describe(
+						'Shared secret used to sign and verify X-Webitel-Sign in both directions; handled as sensitive.',
+					),
+				callback_url: zod
+					.string()
+					.optional()
+					.describe(
+						'Customer-side webhook Webitel posts operator replies and events to.',
+					),
+				created_at: zod.string().optional(),
+				enabled: zod.boolean().optional(),
+				id: zod.string().optional(),
+				name: zod.string().optional(),
+				request_timeout_ms: zod
+					.int()
+					.optional()
+					.describe(
+						'Timeout of a single outbound callback attempt, in milliseconds.',
+					),
+				retry_attempts: zod
+					.int()
+					.optional()
+					.describe(
+						'How many times an outbound callback is retried before the message is marked failed.',
+					),
+				status: zod
+					.enum([
+						'PROVIDER_STATUS_UNSPECIFIED',
+						'PROVIDER_STATUS_ACTIVE',
+						'PROVIDER_STATUS_INACTIVE',
+						'PROVIDER_STATUS_ERROR',
+					])
+					.default(customServiceUpdateCustomGateResponseItemStatusDefault)
+					.describe(
+						'/ ProviderStatus represents the operational state of a provider gateway.\n\n - PROVIDER_STATUS_ACTIVE: Provider is healthy and processing messages\n - PROVIDER_STATUS_INACTIVE: Manually disabled by user\n - PROVIDER_STATUS_ERROR: Connection or authentication failed',
+					),
+				updated_at: zod.string().optional(),
+				webhook_url: zod
+					.string()
+					.optional()
+					.describe(
+						'Webitel-side webhook the external system posts updates to.',
+					),
+			})
+			.optional(),
+	})
+	.describe(
+		'/ ProviderUpdateCustomGateResponse returns the updated custom provider.',
+	);

package/src/gen-wire/webitel-im-provider-v1-gateservice/webitel-im-provider-v1-gateservice.zod.ts

@@ -25,6 +25,7 @@ export const GateServiceListGatesQueryParams = zod.object({
 				'PROVIDER_TYPE_FACEBOOK',
 				'PROVIDER_TYPE_INSTAGRAM',
 				'PROVIDER_TYPE_WHATSAPP',
+				'PROVIDER_TYPE_CUSTOM',
 			]),
 		)
 		.optional()
@@ -102,6 +103,7 @@ export const GateServiceListGatesResponse = zod
 							'PROVIDER_TYPE_FACEBOOK',
 							'PROVIDER_TYPE_INSTAGRAM',
 							'PROVIDER_TYPE_WHATSAPP',
+							'PROVIDER_TYPE_CUSTOM',
 						])
 						.default(gateServiceListGatesResponseItemsItemTypeDefault)
 						.describe(

package/src/gen-wire/webitel-im-provider-v1-providermessageservice/webitel-im-provider-v1-providermessageservice.zod.ts

@@ -36,6 +36,7 @@ export const ProviderMessageServiceSendContactBody = zod
 				'PROVIDER_TYPE_FACEBOOK',
 				'PROVIDER_TYPE_INSTAGRAM',
 				'PROVIDER_TYPE_WHATSAPP',
+				'PROVIDER_TYPE_CUSTOM',
 			])
 			.default(providerMessageServiceSendContactBodyTypeDefault)
 			.describe(
@@ -75,6 +76,43 @@ export const ProviderMessageServiceSendDocumentBody = zod
 			)
 			.optional(),
 		domain_id: zod.int().optional(),
+		entities: zod
+			.array(
+				zod
+					.object({
+						length: zod
+							.int()
+							.optional()
+							.describe(
+								'Length of the span, in UTF-8 bytes, matching `offset`.',
+							),
+						offset: zod
+							.int()
+							.optional()
+							.describe(
+								"Start of the span, as a UTF-8 byte offset into the message's text\n(`text` or `caption`). Bounded to reject pathological payloads.",
+							),
+						type: zod
+							.string()
+							.optional()
+							.describe(
+								'Span kind. Open allow-list -- see message comment above.',
+							),
+						value: zod
+							.string()
+							.optional()
+							.describe(
+								"Extra data the span kind needs, e.g. the target URL for a LINK entity.\nUnset for kinds that don't need one (BOLD, ITALIC, STRIKETHROUGH, CODE, PRE).",
+							),
+					})
+					.describe(
+						'Entity is a single formatting span over a message\'s plain-text content.\nim-gateway-service parses the original markdown exactly once and turns it\ninto a list of these canonical spans (the "parse-once-at-gateway" design);\nim-providers-service only relays and renders them for the destination\nchannel -- it does not re-parse markdown.\n\n`type` is an open allow-list, not an enum, so new span kinds can be added\nlater without breaking readers that don\'t know them yet. Values in use\ntoday: BOLD, ITALIC, STRIKETHROUGH, CODE, PRE, LINK.',
+					),
+			)
+			.optional()
+			.describe(
+				'Formatting spans over `caption`, produced once by im-gateway-service when it\nparses the original markdown (parse-once-at-gateway). im-providers-service\nonly relays/renders them for the destination channel; it does not\nre-parse markdown.',
+			),
 		external_user_id: zod.string().optional(),
 		gate_id: zod.string().optional(),
 		message_id: zod
@@ -101,6 +139,7 @@ export const ProviderMessageServiceSendDocumentBody = zod
 				'PROVIDER_TYPE_FACEBOOK',
 				'PROVIDER_TYPE_INSTAGRAM',
 				'PROVIDER_TYPE_WHATSAPP',
+				'PROVIDER_TYPE_CUSTOM',
 			])
 			.default(providerMessageServiceSendDocumentBodyTypeDefault)
 			.describe(
@@ -168,6 +207,7 @@ export const ProviderMessageServiceSendImageBody = zod
 				'PROVIDER_TYPE_FACEBOOK',
 				'PROVIDER_TYPE_INSTAGRAM',
 				'PROVIDER_TYPE_WHATSAPP',
+				'PROVIDER_TYPE_CUSTOM',
 			])
 			.default(providerMessageServiceSendImageBodyTypeDefault)
 			.describe(
@@ -426,6 +466,7 @@ export const ProviderMessageServiceSendLocationBody = zod
 				'PROVIDER_TYPE_FACEBOOK',
 				'PROVIDER_TYPE_INSTAGRAM',
 				'PROVIDER_TYPE_WHATSAPP',
+				'PROVIDER_TYPE_CUSTOM',
 			])
 			.default(providerMessageServiceSendLocationBodyTypeDefault)
 			.describe(
@@ -487,6 +528,7 @@ export const ProviderMessageServiceSendReactionBody = zod
 				'PROVIDER_TYPE_FACEBOOK',
 				'PROVIDER_TYPE_INSTAGRAM',
 				'PROVIDER_TYPE_WHATSAPP',
+				'PROVIDER_TYPE_CUSTOM',
 			])
 			.default(providerMessageServiceSendReactionBodyTypeDefault)
 			.describe(
@@ -560,6 +602,43 @@ export const providerMessageServiceSendTextBodyTypeDefault = `PROVIDER_TYPE_UNSP
 export const ProviderMessageServiceSendTextBody = zod
 	.object({
 		domain_id: zod.int().optional(),
+		entities: zod
+			.array(
+				zod
+					.object({
+						length: zod
+							.int()
+							.optional()
+							.describe(
+								'Length of the span, in UTF-8 bytes, matching `offset`.',
+							),
+						offset: zod
+							.int()
+							.optional()
+							.describe(
+								"Start of the span, as a UTF-8 byte offset into the message's text\n(`text` or `caption`). Bounded to reject pathological payloads.",
+							),
+						type: zod
+							.string()
+							.optional()
+							.describe(
+								'Span kind. Open allow-list -- see message comment above.',
+							),
+						value: zod
+							.string()
+							.optional()
+							.describe(
+								"Extra data the span kind needs, e.g. the target URL for a LINK entity.\nUnset for kinds that don't need one (BOLD, ITALIC, STRIKETHROUGH, CODE, PRE).",
+							),
+					})
+					.describe(
+						'Entity is a single formatting span over a message\'s plain-text content.\nim-gateway-service parses the original markdown exactly once and turns it\ninto a list of these canonical spans (the "parse-once-at-gateway" design);\nim-providers-service only relays and renders them for the destination\nchannel -- it does not re-parse markdown.\n\n`type` is an open allow-list, not an enum, so new span kinds can be added\nlater without breaking readers that don\'t know them yet. Values in use\ntoday: BOLD, ITALIC, STRIKETHROUGH, CODE, PRE, LINK.',
+					),
+			)
+			.optional()
+			.describe(
+				'Formatting spans over `text`, produced once by im-gateway-service when it\nparses the original markdown (parse-once-at-gateway). im-providers-service\nonly relays/renders them for the destination channel; it does not\nre-parse markdown.',
+			),
 		external_user_id: zod.string().optional(),
 		gate_id: zod.string().optional(),
 		message_id: zod
@@ -588,6 +667,7 @@ export const ProviderMessageServiceSendTextBody = zod
 				'PROVIDER_TYPE_FACEBOOK',
 				'PROVIDER_TYPE_INSTAGRAM',
 				'PROVIDER_TYPE_WHATSAPP',
+				'PROVIDER_TYPE_CUSTOM',
 			])
 			.default(providerMessageServiceSendTextBodyTypeDefault)
 			.describe(
@@ -629,6 +709,7 @@ export const ProviderMessageServiceSendTypingBody = zod
 				'PROVIDER_TYPE_FACEBOOK',
 				'PROVIDER_TYPE_INSTAGRAM',
 				'PROVIDER_TYPE_WHATSAPP',
+				'PROVIDER_TYPE_CUSTOM',
 			])
 			.default(providerMessageServiceSendTypingBodyTypeDefault)
 			.describe(