@webitel/api-services 26.8.87 → 26.8.88

package/src/gen-wire/webitel-im-api-gateway-v1-threadpreviewservice/webitel-im-api-gateway-v1-threadpreviewservice.ts

@@ -0,0 +1,89 @@
+/**
+ * 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 {
+	WebitelImApiGatewayV1GivePreviewResponse,
+	WebitelImApiGatewayV1RemoveFromPreviewResponse,
+	WebitelImApiGatewayV1ThreadPreviewServiceGivePreviewBody,
+	WebitelImApiGatewayV1ThreadPreviewServiceRemoveFromPreviewBody,
+	WebitelImApiGatewayV1ThreadPreviewServiceUpgradePreviewToFullMemberBody,
+	WebitelImApiGatewayV1UpgradePreviewToFullMemberResponse,
+} from '../_models';
+
+// --- header start
+//
+
+export const // --- title start
+	getWebitelImApiGatewayV1Threadpreviewservice =
+		// --- title end
+		(axiosInstance: AxiosInstance = axios) => {
+			// --- header end
+			/**
+			 * @summary GivePreview grants (or, while active, extends) a preview.
+			 */
+			const threadPreviewServiceGivePreview = (
+				threadId: string,
+				webitelImApiGatewayV1ThreadPreviewServiceGivePreviewBody: WebitelImApiGatewayV1ThreadPreviewServiceGivePreviewBody,
+				options?: AxiosRequestConfig,
+			): Promise<AxiosResponse<WebitelImApiGatewayV1GivePreviewResponse>> => {
+				return axiosInstance.post(
+					`/v1/threads/${threadId}/preview`,
+					webitelImApiGatewayV1ThreadPreviewServiceGivePreviewBody,
+					options,
+				);
+			};
+			/**
+			 * @summary RemoveFromPreview revokes the contact's active preview.
+			 */
+			const threadPreviewServiceRemoveFromPreview = (
+				threadId: string,
+				webitelImApiGatewayV1ThreadPreviewServiceRemoveFromPreviewBody: WebitelImApiGatewayV1ThreadPreviewServiceRemoveFromPreviewBody,
+				options?: AxiosRequestConfig,
+			): Promise<
+				AxiosResponse<WebitelImApiGatewayV1RemoveFromPreviewResponse>
+			> => {
+				return axiosInstance.post(
+					`/v1/threads/${threadId}/preview/remove`,
+					webitelImApiGatewayV1ThreadPreviewServiceRemoveFromPreviewBody,
+					options,
+				);
+			};
+			/**
+			 * @summary UpgradePreviewToFullMember atomically revokes the active preview and adds the contact as a full member.
+			 */
+			const threadPreviewServiceUpgradePreviewToFullMember = (
+				threadId: string,
+				webitelImApiGatewayV1ThreadPreviewServiceUpgradePreviewToFullMemberBody: WebitelImApiGatewayV1ThreadPreviewServiceUpgradePreviewToFullMemberBody,
+				options?: AxiosRequestConfig,
+			): Promise<
+				AxiosResponse<WebitelImApiGatewayV1UpgradePreviewToFullMemberResponse>
+			> => {
+				return axiosInstance.post(
+					`/v1/threads/${threadId}/preview/upgrade`,
+					webitelImApiGatewayV1ThreadPreviewServiceUpgradePreviewToFullMemberBody,
+					options,
+				);
+			};
+
+			// --- footer start
+			return {
+				threadPreviewServiceGivePreview,
+				threadPreviewServiceRemoveFromPreview,
+				threadPreviewServiceUpgradePreviewToFullMember,
+			};
+		};
+export type ThreadPreviewServiceGivePreviewResult =
+	AxiosResponse<WebitelImApiGatewayV1GivePreviewResponse>;
+export type ThreadPreviewServiceRemoveFromPreviewResult =
+	AxiosResponse<WebitelImApiGatewayV1RemoveFromPreviewResponse>;
+export type ThreadPreviewServiceUpgradePreviewToFullMemberResult =
+	AxiosResponse<WebitelImApiGatewayV1UpgradePreviewToFullMemberResponse>;
+
+// --- footer end

package/src/gen-wire/webitel-im-api-gateway-v1-threadpreviewservice/webitel-im-api-gateway-v1-threadpreviewservice.zod.ts

@@ -0,0 +1,351 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Webitel API
+ * OpenAPI spec version: 24.04.0
+ */
+import * as zod from 'zod';
+
+/**
+ * @summary GivePreview grants (or, while active, extends) a preview.
+ */
+export const ThreadPreviewServiceGivePreviewParams = zod.object({
+	thread_id: zod.string(),
+});
+
+export const ThreadPreviewServiceGivePreviewBody = zod.object({
+	contact: zod
+		.object({
+			chat_name: zod
+				.string()
+				.optional()
+				.describe(
+					'chat_name is the name external clients see instead of the real one.',
+				),
+			iss: zod.string().optional(),
+			sub: zod.string().optional(),
+			via: zod.string().optional(),
+		})
+		.optional()
+		.describe('The contact receiving the preview.'),
+	duration_ms: zod
+		.string()
+		.optional()
+		.describe('Preview lifetime from now, in milliseconds.'),
+});
+
+export const ThreadPreviewServiceGivePreviewResponse = zod.object({
+	preview: zod
+		.object({
+			contact: zod
+				.object({
+					app_id: zod
+						.string()
+						.optional()
+						.describe('Identifier of the specific integration app or bot.'),
+					created_at: zod
+						.string()
+						.optional()
+						.describe(
+							'Record creation timestamp (Unix Epoch in milliseconds).',
+						),
+					is_bot: zod
+						.boolean()
+						.optional()
+						.describe(
+							'Represents if usere is real person or automatic script.',
+						),
+					iss: zod
+						.string()
+						.optional()
+						.describe('Provider-specific unique identifier (Issuer ID).'),
+					metadata: zod
+						.record(zod.string(), zod.string())
+						.optional()
+						.describe(
+							'Additional dynamic attributes provided by the messenger.',
+						),
+					name: zod
+						.string()
+						.optional()
+						.describe('Display name of the contact.'),
+					sub: zod
+						.string()
+						.optional()
+						.describe('Associated internal system subject/identifier.'),
+					type: zod
+						.string()
+						.optional()
+						.describe("Channel type (e.g., 'webchat', 'telegram')."),
+					updated_at: zod
+						.string()
+						.optional()
+						.describe(
+							'Last record update timestamp (Unix Epoch in milliseconds).',
+						),
+					username: zod
+						.string()
+						.optional()
+						.describe('Technical username or handle.'),
+					vias: zod
+						.array(
+							zod.object({
+								contact_id: zod.string().optional(),
+								created_at: zod.string().optional(),
+								disable: zod.boolean().optional(),
+								disable_reason: zod.string().optional(),
+								metadata: zod.looseObject({}).optional(),
+								updated_at: zod.string().optional(),
+								via: zod.string().optional(),
+							}),
+						)
+						.optional(),
+				})
+				.optional()
+				.describe('Contact represents an external messaging identity.'),
+			created_at: zod.string().optional().describe('Unix milliseconds.'),
+			expires_at: zod
+				.string()
+				.optional()
+				.describe(
+					'Unix milliseconds; the preview stops granting access at this moment.',
+				),
+			id: zod.string().optional(),
+			initiator: zod
+				.object({
+					app_id: zod
+						.string()
+						.optional()
+						.describe('Identifier of the specific integration app or bot.'),
+					created_at: zod
+						.string()
+						.optional()
+						.describe(
+							'Record creation timestamp (Unix Epoch in milliseconds).',
+						),
+					is_bot: zod
+						.boolean()
+						.optional()
+						.describe(
+							'Represents if usere is real person or automatic script.',
+						),
+					iss: zod
+						.string()
+						.optional()
+						.describe('Provider-specific unique identifier (Issuer ID).'),
+					metadata: zod
+						.record(zod.string(), zod.string())
+						.optional()
+						.describe(
+							'Additional dynamic attributes provided by the messenger.',
+						),
+					name: zod
+						.string()
+						.optional()
+						.describe('Display name of the contact.'),
+					sub: zod
+						.string()
+						.optional()
+						.describe('Associated internal system subject/identifier.'),
+					type: zod
+						.string()
+						.optional()
+						.describe("Channel type (e.g., 'webchat', 'telegram')."),
+					updated_at: zod
+						.string()
+						.optional()
+						.describe(
+							'Last record update timestamp (Unix Epoch in milliseconds).',
+						),
+					username: zod
+						.string()
+						.optional()
+						.describe('Technical username or handle.'),
+					vias: zod
+						.array(
+							zod.object({
+								contact_id: zod.string().optional(),
+								created_at: zod.string().optional(),
+								disable: zod.boolean().optional(),
+								disable_reason: zod.string().optional(),
+								metadata: zod.looseObject({}).optional(),
+								updated_at: zod.string().optional(),
+								via: zod.string().optional(),
+							}),
+						)
+						.optional(),
+				})
+				.optional()
+				.describe('Contact represents an external messaging identity.'),
+			thread_id: zod.string().optional(),
+		})
+		.optional(),
+});
+
+/**
+ * @summary RemoveFromPreview revokes the contact's active preview.
+ */
+export const ThreadPreviewServiceRemoveFromPreviewParams = zod.object({
+	thread_id: zod.string(),
+});
+
+export const ThreadPreviewServiceRemoveFromPreviewBody = zod.object({
+	contact: zod
+		.object({
+			chat_name: zod
+				.string()
+				.optional()
+				.describe(
+					'chat_name is the name external clients see instead of the real one.',
+				),
+			iss: zod.string().optional(),
+			sub: zod.string().optional(),
+			via: zod.string().optional(),
+		})
+		.optional()
+		.describe('The contact whose preview is revoked.'),
+});
+
+export const ThreadPreviewServiceRemoveFromPreviewResponse = zod.looseObject(
+	{},
+);
+
+/**
+ * @summary UpgradePreviewToFullMember atomically revokes the active preview and adds the contact as a full member.
+ */
+export const ThreadPreviewServiceUpgradePreviewToFullMemberParams = zod.object({
+	thread_id: zod.string(),
+});
+
+export const threadPreviewServiceUpgradePreviewToFullMemberBodyRoleDefault = `ROLE_UNSPECIFIED`;
+
+export const ThreadPreviewServiceUpgradePreviewToFullMemberBody = zod.object({
+	contact: zod
+		.object({
+			chat_name: zod
+				.string()
+				.optional()
+				.describe(
+					'chat_name is the name external clients see instead of the real one.',
+				),
+			iss: zod.string().optional(),
+			sub: zod.string().optional(),
+			via: zod.string().optional(),
+		})
+		.optional()
+		.describe('The contact to upgrade to a full member.'),
+	role: zod
+		.enum([
+			'ROLE_UNSPECIFIED',
+			'ROLE_MEMBER',
+			'ROLE_ADMIN',
+			'ROLE_OWNER',
+			'ROLE_SUPERVISOR',
+		])
+		.default(threadPreviewServiceUpgradePreviewToFullMemberBodyRoleDefault),
+});
+
+export const threadPreviewServiceUpgradePreviewToFullMemberResponseMemberRoleDefault = `ROLE_UNSPECIFIED`;
+
+export const ThreadPreviewServiceUpgradePreviewToFullMemberResponse =
+	zod.object({
+		member: zod
+			.object({
+				contact: zod
+					.object({
+						app_id: zod
+							.string()
+							.optional()
+							.describe('Identifier of the specific integration app or bot.'),
+						created_at: zod
+							.string()
+							.optional()
+							.describe(
+								'Record creation timestamp (Unix Epoch in milliseconds).',
+							),
+						is_bot: zod
+							.boolean()
+							.optional()
+							.describe(
+								'Represents if usere is real person or automatic script.',
+							),
+						iss: zod
+							.string()
+							.optional()
+							.describe('Provider-specific unique identifier (Issuer ID).'),
+						metadata: zod
+							.record(zod.string(), zod.string())
+							.optional()
+							.describe(
+								'Additional dynamic attributes provided by the messenger.',
+							),
+						name: zod
+							.string()
+							.optional()
+							.describe('Display name of the contact.'),
+						sub: zod
+							.string()
+							.optional()
+							.describe('Associated internal system subject/identifier.'),
+						type: zod
+							.string()
+							.optional()
+							.describe("Channel type (e.g., 'webchat', 'telegram')."),
+						updated_at: zod
+							.string()
+							.optional()
+							.describe(
+								'Last record update timestamp (Unix Epoch in milliseconds).',
+							),
+						username: zod
+							.string()
+							.optional()
+							.describe('Technical username or handle.'),
+						vias: zod
+							.array(
+								zod.object({
+									contact_id: zod.string().optional(),
+									created_at: zod.string().optional(),
+									disable: zod.boolean().optional(),
+									disable_reason: zod.string().optional(),
+									metadata: zod.looseObject({}).optional(),
+									updated_at: zod.string().optional(),
+									via: zod.string().optional(),
+								}),
+							)
+							.optional(),
+					})
+					.optional()
+					.describe('Contact represents an external messaging identity.'),
+				id: zod.string().optional(),
+				permissions: zod
+					.object({
+						can_add_members: zod.boolean().optional(),
+						can_change_members_permissions: zod.boolean().optional(),
+						can_change_thread_info: zod.boolean().optional(),
+						can_delete_messages: zod.boolean().optional(),
+						can_remove_members: zod.boolean().optional(),
+						can_send_messages: zod.boolean().optional(),
+						created_at: zod.string().optional(),
+						id: zod.string().optional(),
+						member_id: zod.string().optional(),
+						updated_at: zod.string().optional(),
+					})
+					.optional(),
+				role: zod
+					.enum([
+						'ROLE_UNSPECIFIED',
+						'ROLE_MEMBER',
+						'ROLE_ADMIN',
+						'ROLE_OWNER',
+						'ROLE_SUPERVISOR',
+					])
+					.default(
+						threadPreviewServiceUpgradePreviewToFullMemberResponseMemberRoleDefault,
+					),
+			})
+			.optional()
+			.describe(
+				'ThreadMember represents a thread participant\nwith optional type-specific settings.',
+			),
+	});