@webitel/api-services 0.1.37 → 0.1.39

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

@@ -0,0 +1,133 @@
+/**
+ * Generated by orval v8.5.3 🍺
+ * Do not edit manually.
+ * Webitel API
+ * OpenAPI spec version: 24.04.0
+ */
+import * as zod from 'zod';
+
+/**
+ * @summary / CreateMetaApp registers a new Meta Application.
+ */
+export const MetaAppServiceCreateMetaAppBody = zod
+	.object({
+		appId: zod.string().optional(),
+		appSecret: zod.string().optional(),
+		name: zod.string().optional(),
+		oauthRedirectUri: zod.string().optional(),
+		scopes: zod.array(zod.string()).optional(),
+		uri: zod.string().optional(),
+		verifyToken: zod.string().optional(),
+	})
+	.describe(
+		'/ ProviderCreateMetaAppRequest is used to register a new Meta Developer Application.\n/ This configuration is the foundation for all subsequent OAuth-based integrations.',
+	);
+
+export const MetaAppServiceCreateMetaAppResponse = zod
+	.object({
+		item: zod
+			.object({
+				appId: zod.string().optional(),
+				createdAt: zod.string().optional(),
+				id: zod.string().optional(),
+				name: zod.string().optional(),
+				oauthRedirectUri: zod.string().optional(),
+				scopes: zod.array(zod.string()).optional(),
+				updatedAt: zod.string().optional(),
+				verifyToken: zod.string().optional(),
+			})
+			.optional(),
+	})
+	.describe(
+		'/ ProviderCreateMetaAppResponse returns the successfully registered Meta application.',
+	);
+
+/**
+ * @summary / DeleteMetaApp removes a Meta Application registration.
+ */
+export const MetaAppServiceDeleteMetaAppParams = zod.object({
+	id_1: zod.string(),
+});
+
+export const MetaAppServiceDeleteMetaAppResponse = zod
+	.object({
+		item: zod
+			.object({
+				appId: zod.string().optional(),
+				createdAt: zod.string().optional(),
+				id: zod.string().optional(),
+				name: zod.string().optional(),
+				oauthRedirectUri: zod.string().optional(),
+				scopes: zod.array(zod.string()).optional(),
+				updatedAt: zod.string().optional(),
+				verifyToken: zod.string().optional(),
+			})
+			.optional(),
+	})
+	.describe(
+		'/ ProviderDeleteMetaAppResponse returns the details of the deleted application.',
+	);
+
+/**
+ * @summary / GetMetaApp retrieves the configuration details of a specific Meta Application by its ID.
+ */
+export const MetaAppServiceGetMetaAppParams = zod.object({
+	id_1: zod.string(),
+});
+
+export const MetaAppServiceGetMetaAppResponse = zod
+	.object({
+		item: zod
+			.object({
+				appId: zod.string().optional(),
+				createdAt: zod.string().optional(),
+				id: zod.string().optional(),
+				name: zod.string().optional(),
+				oauthRedirectUri: zod.string().optional(),
+				scopes: zod.array(zod.string()).optional(),
+				updatedAt: zod.string().optional(),
+				verifyToken: zod.string().optional(),
+			})
+			.optional(),
+	})
+	.describe(
+		'/ ProviderGetMetaAppResponse returns the requested Meta application details.',
+	);
+
+/**
+ * @summary / UpdateMetaApp modifies an existing Meta Application configuration.
+ */
+export const MetaAppServiceUpdateMetaAppParams = zod.object({
+	id_1: zod.string().describe('The internal ID of the MetaApp record'),
+});
+
+export const MetaAppServiceUpdateMetaAppBody = zod
+	.object({
+		appSecret: zod.string().optional(),
+		name: zod.string().optional(),
+		oauthRedirectUri: zod.string().optional(),
+		scopes: zod.array(zod.string()).optional(),
+		verifyToken: zod.string().optional(),
+	})
+	.describe(
+		'/ ProviderUpdateMetaAppRequest updates the settings for an existing Meta application.',
+	);
+
+export const MetaAppServiceUpdateMetaAppResponse = zod
+	.object({
+		item: zod
+			.object({
+				appId: zod.string().optional(),
+				createdAt: zod.string().optional(),
+				id: zod.string().optional(),
+				name: zod.string().optional(),
+				oauthRedirectUri: zod.string().optional(),
+				scopes: zod.array(zod.string()).optional(),
+				updatedAt: zod.string().optional(),
+				verifyToken: zod.string().optional(),
+			})
+			.optional(),
+	})
+	.describe(
+		'/ ProviderUpdateMetaAppResponse returns the Meta application after modifications.',
+	);

package/src/gen/webitel-im-provider-v1-metaoauthservice/webitel-im-provider-v1-metaoauthservice.msw.ts

@@ -0,0 +1,166 @@
+/**
+ * Generated by orval v8.5.3 🍺
+ * Do not edit manually.
+ * Webitel API
+ * OpenAPI spec version: 24.04.0
+ */
+import { faker } from '@faker-js/faker';
+import type { RequestHandlerOptions } from 'msw';
+import { HttpResponse, http } from 'msw';
+
+import type {
+	WebitelImProviderV1ProviderMetaOAuthCallbackResponse,
+	WebitelImProviderV1ProviderMetaOAuthStartResponse,
+} from '../_models';
+
+export const getMetaOAuthServiceMetaOAuthCallbackResponseMock = (
+	overrideResponse: Partial<
+		Extract<WebitelImProviderV1ProviderMetaOAuthCallbackResponse, object>
+	> = {},
+): WebitelImProviderV1ProviderMetaOAuthCallbackResponse => ({
+	pages: faker.helpers.arrayElement([
+		Array.from(
+			{
+				length: faker.number.int({
+					min: 1,
+					max: 10,
+				}),
+			},
+			(_, i) => i + 1,
+		).map(() => ({
+			accessToken: faker.helpers.arrayElement([
+				faker.string.alpha({
+					length: {
+						min: 10,
+						max: 20,
+					},
+				}),
+				undefined,
+			]),
+			pageId: faker.helpers.arrayElement([
+				faker.string.alpha({
+					length: {
+						min: 10,
+						max: 20,
+					},
+				}),
+				undefined,
+			]),
+			pageName: faker.helpers.arrayElement([
+				faker.string.alpha({
+					length: {
+						min: 10,
+						max: 20,
+					},
+				}),
+				undefined,
+			]),
+			platform: faker.helpers.arrayElement([
+				faker.string.alpha({
+					length: {
+						min: 10,
+						max: 20,
+					},
+				}),
+				undefined,
+			]),
+		})),
+		undefined,
+	]),
+	userAccessToken: faker.helpers.arrayElement([
+		faker.string.alpha({
+			length: {
+				min: 10,
+				max: 20,
+			},
+		}),
+		undefined,
+	]),
+	...overrideResponse,
+});
+
+export const getMetaOAuthServiceStartMetaOAuthResponseMock = (
+	overrideResponse: Partial<
+		Extract<WebitelImProviderV1ProviderMetaOAuthStartResponse, object>
+	> = {},
+): WebitelImProviderV1ProviderMetaOAuthStartResponse => ({
+	authUrl: faker.helpers.arrayElement([
+		faker.string.alpha({
+			length: {
+				min: 10,
+				max: 20,
+			},
+		}),
+		undefined,
+	]),
+	state: faker.helpers.arrayElement([
+		faker.string.alpha({
+			length: {
+				min: 10,
+				max: 20,
+			},
+		}),
+		undefined,
+	]),
+	...overrideResponse,
+});
+
+export const getMetaOAuthServiceMetaOAuthCallbackMockHandler = (
+	overrideResponse?:
+		| WebitelImProviderV1ProviderMetaOAuthCallbackResponse
+		| ((
+				info: Parameters<Parameters<typeof http.post>[1]>[0],
+		  ) =>
+				| Promise<WebitelImProviderV1ProviderMetaOAuthCallbackResponse>
+				| WebitelImProviderV1ProviderMetaOAuthCallbackResponse),
+	options?: RequestHandlerOptions,
+) => {
+	return http.post(
+		'*/im/meta-apps/:metaAppId1/oauth/callback',
+		async (info: Parameters<Parameters<typeof http.post>[1]>[0]) => {
+			return HttpResponse.json(
+				overrideResponse !== undefined
+					? typeof overrideResponse === 'function'
+						? await overrideResponse(info)
+						: overrideResponse
+					: getMetaOAuthServiceMetaOAuthCallbackResponseMock(),
+				{
+					status: 200,
+				},
+			);
+		},
+		options,
+	);
+};
+
+export const getMetaOAuthServiceStartMetaOAuthMockHandler = (
+	overrideResponse?:
+		| WebitelImProviderV1ProviderMetaOAuthStartResponse
+		| ((
+				info: Parameters<Parameters<typeof http.post>[1]>[0],
+		  ) =>
+				| Promise<WebitelImProviderV1ProviderMetaOAuthStartResponse>
+				| WebitelImProviderV1ProviderMetaOAuthStartResponse),
+	options?: RequestHandlerOptions,
+) => {
+	return http.post(
+		'*/im/meta-apps/:metaAppId1/oauth/start',
+		async (info: Parameters<Parameters<typeof http.post>[1]>[0]) => {
+			return HttpResponse.json(
+				overrideResponse !== undefined
+					? typeof overrideResponse === 'function'
+						? await overrideResponse(info)
+						: overrideResponse
+					: getMetaOAuthServiceStartMetaOAuthResponseMock(),
+				{
+					status: 200,
+				},
+			);
+		},
+		options,
+	);
+};
+export const getWebitelImProviderV1MetaoauthserviceMock = () => [
+	getMetaOAuthServiceMetaOAuthCallbackMockHandler(),
+	getMetaOAuthServiceStartMetaOAuthMockHandler(),
+];

package/src/gen/webitel-im-provider-v1-metaoauthservice/webitel-im-provider-v1-metaoauthservice.ts

@@ -0,0 +1,70 @@
+/**
+ * Generated by orval v8.5.3 🍺
+ * 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 {
+	WebitelImProviderV1MetaOAuthServiceMetaOAuthCallbackBody,
+	WebitelImProviderV1MetaOAuthServiceStartMetaOAuthBody,
+	WebitelImProviderV1ProviderMetaOAuthCallbackResponse,
+	WebitelImProviderV1ProviderMetaOAuthStartResponse,
+} from '../_models';
+
+// --- header start
+//
+
+export const // --- title start
+	getWebitelImProviderV1Metaoauthservice =
+		// --- title end
+		(axiosInstance: AxiosInstance = axios) => {
+			// --- header end
+			/**
+			 * @summary / MetaOAuthCallback processes the authorization code returned by Facebook.
+			 */
+			const metaOAuthServiceMetaOAuthCallback = (
+				metaAppId1: string,
+				webitelImProviderV1MetaOAuthServiceMetaOAuthCallbackBody: WebitelImProviderV1MetaOAuthServiceMetaOAuthCallbackBody,
+				options?: AxiosRequestConfig,
+			): Promise<
+				AxiosResponse<WebitelImProviderV1ProviderMetaOAuthCallbackResponse>
+			> => {
+				return axiosInstance.post(
+					`/im/meta-apps/${metaAppId1}/oauth/callback`,
+					webitelImProviderV1MetaOAuthServiceMetaOAuthCallbackBody,
+					options,
+				);
+			};
+			/**
+			 * @summary / StartMetaOAuth generates a secure Facebook Authorization URL.
+			 */
+			const metaOAuthServiceStartMetaOAuth = (
+				metaAppId1: string,
+				webitelImProviderV1MetaOAuthServiceStartMetaOAuthBody: WebitelImProviderV1MetaOAuthServiceStartMetaOAuthBody,
+				options?: AxiosRequestConfig,
+			): Promise<
+				AxiosResponse<WebitelImProviderV1ProviderMetaOAuthStartResponse>
+			> => {
+				return axiosInstance.post(
+					`/im/meta-apps/${metaAppId1}/oauth/start`,
+					webitelImProviderV1MetaOAuthServiceStartMetaOAuthBody,
+					options,
+				);
+			};
+
+			// --- footer start
+			return {
+				metaOAuthServiceMetaOAuthCallback,
+				metaOAuthServiceStartMetaOAuth,
+			};
+		};
+export type MetaOAuthServiceMetaOAuthCallbackResult =
+	AxiosResponse<WebitelImProviderV1ProviderMetaOAuthCallbackResponse>;
+export type MetaOAuthServiceStartMetaOAuthResult =
+	AxiosResponse<WebitelImProviderV1ProviderMetaOAuthStartResponse>;
+
+// --- footer end

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

@@ -0,0 +1,71 @@
+/**
+ * Generated by orval v8.5.3 🍺
+ * Do not edit manually.
+ * Webitel API
+ * OpenAPI spec version: 24.04.0
+ */
+import * as zod from 'zod';
+
+/**
+ * @summary / MetaOAuthCallback processes the authorization code returned by Facebook.
+ */
+export const MetaOAuthServiceMetaOAuthCallbackParams = zod.object({
+	meta_app_id_1: zod.string(),
+});
+
+export const MetaOAuthServiceMetaOAuthCallbackBody = zod
+	.object({
+		code: zod.string().optional(),
+		state: zod.string().optional(),
+	})
+	.describe(
+		'/ ProviderMetaOAuthCallbackRequest handles the verification and exchange of the auth code.',
+	);
+
+export const MetaOAuthServiceMetaOAuthCallbackResponse = zod
+	.object({
+		pages: zod
+			.array(
+				zod
+					.object({
+						accessToken: zod.string().optional(),
+						pageId: zod.string().optional(),
+						pageName: zod.string().optional(),
+						platform: zod.string().optional(),
+					})
+					.describe(
+						'/ ProviderMetaLinkedPage represents a single Meta asset (Page/Account) found during OAuth.',
+					),
+			)
+			.optional(),
+		userAccessToken: zod.string().optional(),
+	})
+	.describe(
+		'/ ProviderMetaOAuthCallbackResponse provides the user token and discovered assets.',
+	);
+
+/**
+ * @summary / StartMetaOAuth generates a secure Facebook Authorization URL.
+ */
+export const MetaOAuthServiceStartMetaOAuthParams = zod.object({
+	meta_app_id_1: zod
+		.string()
+		.describe('Internal ID of the MetaApp to use for this flow'),
+});
+
+export const MetaOAuthServiceStartMetaOAuthBody = zod
+	.object({
+		extraScopes: zod.array(zod.string()).optional(),
+	})
+	.describe(
+		'/ ProviderMetaOAuthStartRequest initiates the handshake with Meta.',
+	);
+
+export const MetaOAuthServiceStartMetaOAuthResponse = zod
+	.object({
+		authUrl: zod.string().optional(),
+		state: zod.string().optional(),
+	})
+	.describe(
+		'/ ProviderMetaOAuthStartResponse provides the entry point for the user authorization.',
+	);

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

@@ -0,0 +1,178 @@
+/**
+ * Generated by orval v8.5.3 🍺
+ * Do not edit manually.
+ * Webitel API
+ * OpenAPI spec version: 24.04.0
+ */
+import { faker } from '@faker-js/faker';
+import type { RequestHandlerOptions } from 'msw';
+import { HttpResponse, http } from 'msw';
+
+import type { WebitelImProviderV1ProviderSendMessageResponse } from '../_models';
+
+export const getProviderMessageServiceSendDocumentResponseMock = (
+	overrideResponse: Partial<
+		Extract<WebitelImProviderV1ProviderSendMessageResponse, object>
+	> = {},
+): WebitelImProviderV1ProviderSendMessageResponse => ({
+	createdAt: faker.helpers.arrayElement([
+		faker.string.alpha({
+			length: {
+				min: 10,
+				max: 20,
+			},
+		}),
+		undefined,
+	]),
+	externalId: faker.helpers.arrayElement([
+		faker.string.alpha({
+			length: {
+				min: 10,
+				max: 20,
+			},
+		}),
+		undefined,
+	]),
+	...overrideResponse,
+});
+
+export const getProviderMessageServiceSendImageResponseMock = (
+	overrideResponse: Partial<
+		Extract<WebitelImProviderV1ProviderSendMessageResponse, object>
+	> = {},
+): WebitelImProviderV1ProviderSendMessageResponse => ({
+	createdAt: faker.helpers.arrayElement([
+		faker.string.alpha({
+			length: {
+				min: 10,
+				max: 20,
+			},
+		}),
+		undefined,
+	]),
+	externalId: faker.helpers.arrayElement([
+		faker.string.alpha({
+			length: {
+				min: 10,
+				max: 20,
+			},
+		}),
+		undefined,
+	]),
+	...overrideResponse,
+});
+
+export const getProviderMessageServiceSendTextResponseMock = (
+	overrideResponse: Partial<
+		Extract<WebitelImProviderV1ProviderSendMessageResponse, object>
+	> = {},
+): WebitelImProviderV1ProviderSendMessageResponse => ({
+	createdAt: faker.helpers.arrayElement([
+		faker.string.alpha({
+			length: {
+				min: 10,
+				max: 20,
+			},
+		}),
+		undefined,
+	]),
+	externalId: faker.helpers.arrayElement([
+		faker.string.alpha({
+			length: {
+				min: 10,
+				max: 20,
+			},
+		}),
+		undefined,
+	]),
+	...overrideResponse,
+});
+
+export const getProviderMessageServiceSendDocumentMockHandler = (
+	overrideResponse?:
+		| WebitelImProviderV1ProviderSendMessageResponse
+		| ((
+				info: Parameters<Parameters<typeof http.post>[1]>[0],
+		  ) =>
+				| Promise<WebitelImProviderV1ProviderSendMessageResponse>
+				| WebitelImProviderV1ProviderSendMessageResponse),
+	options?: RequestHandlerOptions,
+) => {
+	return http.post(
+		'*/im/provider/send/document',
+		async (info: Parameters<Parameters<typeof http.post>[1]>[0]) => {
+			return HttpResponse.json(
+				overrideResponse !== undefined
+					? typeof overrideResponse === 'function'
+						? await overrideResponse(info)
+						: overrideResponse
+					: getProviderMessageServiceSendDocumentResponseMock(),
+				{
+					status: 200,
+				},
+			);
+		},
+		options,
+	);
+};
+
+export const getProviderMessageServiceSendImageMockHandler = (
+	overrideResponse?:
+		| WebitelImProviderV1ProviderSendMessageResponse
+		| ((
+				info: Parameters<Parameters<typeof http.post>[1]>[0],
+		  ) =>
+				| Promise<WebitelImProviderV1ProviderSendMessageResponse>
+				| WebitelImProviderV1ProviderSendMessageResponse),
+	options?: RequestHandlerOptions,
+) => {
+	return http.post(
+		'*/im/provider/send/image',
+		async (info: Parameters<Parameters<typeof http.post>[1]>[0]) => {
+			return HttpResponse.json(
+				overrideResponse !== undefined
+					? typeof overrideResponse === 'function'
+						? await overrideResponse(info)
+						: overrideResponse
+					: getProviderMessageServiceSendImageResponseMock(),
+				{
+					status: 200,
+				},
+			);
+		},
+		options,
+	);
+};
+
+export const getProviderMessageServiceSendTextMockHandler = (
+	overrideResponse?:
+		| WebitelImProviderV1ProviderSendMessageResponse
+		| ((
+				info: Parameters<Parameters<typeof http.post>[1]>[0],
+		  ) =>
+				| Promise<WebitelImProviderV1ProviderSendMessageResponse>
+				| WebitelImProviderV1ProviderSendMessageResponse),
+	options?: RequestHandlerOptions,
+) => {
+	return http.post(
+		'*/im/provider/send/text',
+		async (info: Parameters<Parameters<typeof http.post>[1]>[0]) => {
+			return HttpResponse.json(
+				overrideResponse !== undefined
+					? typeof overrideResponse === 'function'
+						? await overrideResponse(info)
+						: overrideResponse
+					: getProviderMessageServiceSendTextResponseMock(),
+				{
+					status: 200,
+				},
+			);
+		},
+		options,
+	);
+};
+export const getWebitelImProviderV1ProvidermessageserviceMock = () => [
+	getProviderMessageServiceSendDocumentMockHandler(),
+	getProviderMessageServiceSendImageMockHandler(),
+	getProviderMessageServiceSendTextMockHandler(),
+];

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

@@ -0,0 +1,86 @@
+/**
+ * Generated by orval v8.5.3 🍺
+ * 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 {
+	WebitelImProviderV1ProviderSendDocumentRequest,
+	WebitelImProviderV1ProviderSendImageRequest,
+	WebitelImProviderV1ProviderSendMessageResponse,
+	WebitelImProviderV1ProviderSendTextRequest,
+} from '../_models';
+
+// --- header start
+//
+
+export const // --- title start
+	getWebitelImProviderV1Providermessageservice =
+		// --- title end
+		(axiosInstance: AxiosInstance = axios) => {
+			// --- header end
+			/**
+			 * @summary SendDocument delivers file attachments to the external chat partner.
+			 */
+			const providerMessageServiceSendDocument = (
+				webitelImProviderV1ProviderSendDocumentRequest: WebitelImProviderV1ProviderSendDocumentRequest,
+				options?: AxiosRequestConfig,
+			): Promise<
+				AxiosResponse<WebitelImProviderV1ProviderSendMessageResponse>
+			> => {
+				return axiosInstance.post(
+					`/im/provider/send/document`,
+					webitelImProviderV1ProviderSendDocumentRequest,
+					options,
+				);
+			};
+			/**
+			 * @summary SendImage delivers images to the external chat partner.
+			 */
+			const providerMessageServiceSendImage = (
+				webitelImProviderV1ProviderSendImageRequest: WebitelImProviderV1ProviderSendImageRequest,
+				options?: AxiosRequestConfig,
+			): Promise<
+				AxiosResponse<WebitelImProviderV1ProviderSendMessageResponse>
+			> => {
+				return axiosInstance.post(
+					`/im/provider/send/image`,
+					webitelImProviderV1ProviderSendImageRequest,
+					options,
+				);
+			};
+			/**
+			 * @summary SendText delivers a plain text message to the external chat partner.
+			 */
+			const providerMessageServiceSendText = (
+				webitelImProviderV1ProviderSendTextRequest: WebitelImProviderV1ProviderSendTextRequest,
+				options?: AxiosRequestConfig,
+			): Promise<
+				AxiosResponse<WebitelImProviderV1ProviderSendMessageResponse>
+			> => {
+				return axiosInstance.post(
+					`/im/provider/send/text`,
+					webitelImProviderV1ProviderSendTextRequest,
+					options,
+				);
+			};
+
+			// --- footer start
+			return {
+				providerMessageServiceSendDocument,
+				providerMessageServiceSendImage,
+				providerMessageServiceSendText,
+			};
+		};
+export type ProviderMessageServiceSendDocumentResult =
+	AxiosResponse<WebitelImProviderV1ProviderSendMessageResponse>;
+export type ProviderMessageServiceSendImageResult =
+	AxiosResponse<WebitelImProviderV1ProviderSendMessageResponse>;
+export type ProviderMessageServiceSendTextResult =
+	AxiosResponse<WebitelImProviderV1ProviderSendMessageResponse>;
+
+// --- footer end