vms-nest-api-document 1.0.0

package/dist/services/core/external_api.service.d.ts

@@ -0,0 +1,282 @@
+import { YesNo, APIAuthType, Status, PAGING, LoadParents, LoadChild, LoadChildCount, OrderBy } from '../../core/Enums.js';
+import { SBR, FBR } from '../../core/BaseResponse.js';
+import { z } from 'zod';
+
+interface ApiDataShareManagement extends Record<string, unknown> {
+    api_data_share_id: string;
+    api_name: string;
+    vendor_name: string;
+    purpose?: string;
+    description?: string;
+    is_enabled: YesNo;
+    auth_type: APIAuthType;
+    api_key?: string;
+    username?: string;
+    password?: string;
+    rate_limit_rpm: number;
+    allowed_ips: string[];
+    status: Status;
+    added_date_time: string;
+    modified_date_time: string;
+    ApiDataShareHitLog?: ApiDataShareHitLog[];
+    _count?: {
+        ApiDataShareHitLog?: number;
+    };
+}
+interface ApiDataShareHitLog extends Record<string, unknown> {
+    api_data_share_hit_log_id: string;
+    api_data_share_id: string;
+    ApiDataShareManagement?: ApiDataShareManagement;
+    api_name?: string;
+    vendor_name?: string;
+    request_date_time: string;
+    request_date_time_f?: string;
+    request_id?: string;
+    ip_address?: string;
+    user_agent?: string;
+    is_auth_success: YesNo;
+    failed_message?: string;
+    status: Status;
+    added_date_time: string;
+    modified_date_time: string;
+}
+interface ExternalApiReport extends Record<string, unknown> {
+    api_name: string;
+    vendor_name: string;
+    success_count: number;
+    failed_count: number;
+    total_count: number;
+}
+declare const ApiDataShareManagementSchema: z.ZodObject<{
+    api_name: z.ZodEffects<z.ZodString, string, string>;
+    vendor_name: z.ZodEffects<z.ZodString, string, string>;
+    purpose: z.ZodDefault<z.ZodEffects<z.ZodString, string, string>>;
+    description: z.ZodDefault<z.ZodEffects<z.ZodString, string, string>>;
+    is_enabled: z.ZodDefault<z.ZodOptional<z.ZodNativeEnum<typeof YesNo>>>;
+    auth_type: z.ZodDefault<z.ZodOptional<z.ZodNativeEnum<typeof APIAuthType>>>;
+    api_key: z.ZodDefault<z.ZodEffects<z.ZodString, string, string>>;
+    username: z.ZodDefault<z.ZodEffects<z.ZodString, string, string>>;
+    password: z.ZodDefault<z.ZodEffects<z.ZodString, string, string>>;
+    rate_limit_rpm: z.ZodEffects<z.ZodNumber, number, unknown>;
+    allowed_ips: z.ZodEffects<z.ZodArray<z.ZodString, "many">, string[], string[]>;
+    status: z.ZodType<Status, z.ZodTypeDef, Status>;
+}, "strip", z.ZodTypeAny, {
+    status: Status;
+    is_enabled: YesNo;
+    api_name: string;
+    vendor_name: string;
+    purpose: string;
+    description: string;
+    auth_type: APIAuthType;
+    api_key: string;
+    username: string;
+    password: string;
+    rate_limit_rpm: number;
+    allowed_ips: string[];
+}, {
+    status: Status;
+    api_name: string;
+    vendor_name: string;
+    allowed_ips: string[];
+    is_enabled?: YesNo | undefined;
+    purpose?: string | undefined;
+    description?: string | undefined;
+    auth_type?: APIAuthType | undefined;
+    api_key?: string | undefined;
+    username?: string | undefined;
+    password?: string | undefined;
+    rate_limit_rpm?: unknown;
+}>;
+type ApiDataShareManagementDTO = z.infer<typeof ApiDataShareManagementSchema>;
+declare const ApiDataShareManagementQuerySchema: z.ZodObject<{
+    search: z.ZodDefault<z.ZodEffects<z.ZodString, string, string>>;
+    status: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodNativeEnum<typeof Status>, "many">>>;
+    paging: z.ZodDefault<z.ZodOptional<z.ZodNativeEnum<typeof PAGING>>>;
+    page_count: z.ZodEffects<z.ZodDefault<z.ZodOptional<z.ZodNumber>>, number, unknown>;
+    page_index: z.ZodEffects<z.ZodDefault<z.ZodOptional<z.ZodNumber>>, number, unknown>;
+    load_parents: z.ZodDefault<z.ZodOptional<z.ZodNativeEnum<typeof LoadParents>>>;
+    load_parents_list: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodString, "many">>>;
+    load_child: z.ZodDefault<z.ZodOptional<z.ZodNativeEnum<typeof LoadChild>>>;
+    load_child_list: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodString, "many">>>;
+    load_child_count: z.ZodDefault<z.ZodOptional<z.ZodNativeEnum<typeof LoadChildCount>>>;
+    load_child_count_list: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodString, "many">>>;
+    include_details: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>>;
+    where_relations: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>>;
+    order_by: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodObject<{
+        name: z.ZodEffects<z.ZodString, string, string>;
+        field: z.ZodEffects<z.ZodString, string, string>;
+        direction: z.ZodType<OrderBy, z.ZodTypeDef, OrderBy>;
+    }, "strip", z.ZodTypeAny, {
+        name: string;
+        field: string;
+        direction: OrderBy;
+    }, {
+        name: string;
+        field: string;
+        direction: OrderBy;
+    }>, "many">>>;
+    include_master_data: z.ZodDefault<z.ZodOptional<z.ZodNativeEnum<typeof YesNo>>>;
+    date_format_id: z.ZodEffects<z.ZodString, string, string>;
+    time_zone_id: z.ZodEffects<z.ZodString, string, string>;
+} & {
+    api_data_share_ids: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodString, "many">>>;
+    is_enabled: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodNativeEnum<typeof YesNo>, "many">>>;
+    auth_type: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodNativeEnum<typeof APIAuthType>, "many">>>;
+}, "strip", z.ZodTypeAny, {
+    status: Status[];
+    is_enabled: YesNo[];
+    search: string;
+    paging: PAGING;
+    page_count: number;
+    page_index: number;
+    load_parents: LoadParents;
+    load_parents_list: string[];
+    load_child: LoadChild;
+    load_child_list: string[];
+    load_child_count: LoadChildCount;
+    load_child_count_list: string[];
+    include_details: Record<string, any>;
+    where_relations: Record<string, any>;
+    order_by: {
+        name: string;
+        field: string;
+        direction: OrderBy;
+    }[];
+    include_master_data: YesNo;
+    date_format_id: string;
+    time_zone_id: string;
+    auth_type: APIAuthType[];
+    api_data_share_ids: string[];
+}, {
+    date_format_id: string;
+    time_zone_id: string;
+    status?: Status[] | undefined;
+    is_enabled?: YesNo[] | undefined;
+    search?: string | undefined;
+    paging?: PAGING | undefined;
+    page_count?: unknown;
+    page_index?: unknown;
+    load_parents?: LoadParents | undefined;
+    load_parents_list?: string[] | undefined;
+    load_child?: LoadChild | undefined;
+    load_child_list?: string[] | undefined;
+    load_child_count?: LoadChildCount | undefined;
+    load_child_count_list?: string[] | undefined;
+    include_details?: Record<string, any> | undefined;
+    where_relations?: Record<string, any> | undefined;
+    order_by?: {
+        name: string;
+        field: string;
+        direction: OrderBy;
+    }[] | undefined;
+    include_master_data?: YesNo | undefined;
+    auth_type?: APIAuthType[] | undefined;
+    api_data_share_ids?: string[] | undefined;
+}>;
+type ApiDataShareManagementQueryDTO = z.infer<typeof ApiDataShareManagementQuerySchema>;
+declare const ApiDataShareHitLogQuerySchema: z.ZodObject<{
+    search: z.ZodDefault<z.ZodEffects<z.ZodString, string, string>>;
+    status: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodNativeEnum<typeof Status>, "many">>>;
+    paging: z.ZodDefault<z.ZodOptional<z.ZodNativeEnum<typeof PAGING>>>;
+    page_count: z.ZodEffects<z.ZodDefault<z.ZodOptional<z.ZodNumber>>, number, unknown>;
+    page_index: z.ZodEffects<z.ZodDefault<z.ZodOptional<z.ZodNumber>>, number, unknown>;
+    load_parents: z.ZodDefault<z.ZodOptional<z.ZodNativeEnum<typeof LoadParents>>>;
+    load_parents_list: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodString, "many">>>;
+    load_child: z.ZodDefault<z.ZodOptional<z.ZodNativeEnum<typeof LoadChild>>>;
+    load_child_list: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodString, "many">>>;
+    load_child_count: z.ZodDefault<z.ZodOptional<z.ZodNativeEnum<typeof LoadChildCount>>>;
+    load_child_count_list: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodString, "many">>>;
+    include_details: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>>;
+    where_relations: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>>;
+    order_by: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodObject<{
+        name: z.ZodEffects<z.ZodString, string, string>;
+        field: z.ZodEffects<z.ZodString, string, string>;
+        direction: z.ZodType<OrderBy, z.ZodTypeDef, OrderBy>;
+    }, "strip", z.ZodTypeAny, {
+        name: string;
+        field: string;
+        direction: OrderBy;
+    }, {
+        name: string;
+        field: string;
+        direction: OrderBy;
+    }>, "many">>>;
+    include_master_data: z.ZodDefault<z.ZodOptional<z.ZodNativeEnum<typeof YesNo>>>;
+    date_format_id: z.ZodEffects<z.ZodString, string, string>;
+    time_zone_id: z.ZodEffects<z.ZodString, string, string>;
+} & {
+    api_data_share_hit_log_ids: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodString, "many">>>;
+    api_data_share_ids: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodString, "many">>>;
+    is_auth_success: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodNativeEnum<typeof YesNo>, "many">>>;
+}, "strip", z.ZodTypeAny, {
+    status: Status[];
+    search: string;
+    paging: PAGING;
+    page_count: number;
+    page_index: number;
+    load_parents: LoadParents;
+    load_parents_list: string[];
+    load_child: LoadChild;
+    load_child_list: string[];
+    load_child_count: LoadChildCount;
+    load_child_count_list: string[];
+    include_details: Record<string, any>;
+    where_relations: Record<string, any>;
+    order_by: {
+        name: string;
+        field: string;
+        direction: OrderBy;
+    }[];
+    include_master_data: YesNo;
+    date_format_id: string;
+    time_zone_id: string;
+    is_auth_success: YesNo[];
+    api_data_share_ids: string[];
+    api_data_share_hit_log_ids: string[];
+}, {
+    date_format_id: string;
+    time_zone_id: string;
+    status?: Status[] | undefined;
+    search?: string | undefined;
+    paging?: PAGING | undefined;
+    page_count?: unknown;
+    page_index?: unknown;
+    load_parents?: LoadParents | undefined;
+    load_parents_list?: string[] | undefined;
+    load_child?: LoadChild | undefined;
+    load_child_list?: string[] | undefined;
+    load_child_count?: LoadChildCount | undefined;
+    load_child_count_list?: string[] | undefined;
+    include_details?: Record<string, any> | undefined;
+    where_relations?: Record<string, any> | undefined;
+    order_by?: {
+        name: string;
+        field: string;
+        direction: OrderBy;
+    }[] | undefined;
+    include_master_data?: YesNo | undefined;
+    is_auth_success?: YesNo[] | undefined;
+    api_data_share_ids?: string[] | undefined;
+    api_data_share_hit_log_ids?: string[] | undefined;
+}>;
+type ApiDataShareHitLogQueryDTO = z.infer<typeof ApiDataShareHitLogQuerySchema>;
+declare const ExternalApiReportSchema: z.ZodObject<{
+    date: z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodString, string, string>, string, string>, string, string>, string, string>, string, string>;
+}, "strip", z.ZodTypeAny, {
+    date: string;
+}, {
+    date: string;
+}>;
+type ExternalApiReportDTO = z.infer<typeof ExternalApiReportSchema>;
+declare const toApiDataShareManagementPayload: (row: ApiDataShareManagement) => ApiDataShareManagementDTO;
+declare const newApiDataShareManagementPayload: () => ApiDataShareManagementDTO;
+declare const findApiDataShareManagement: (data: ApiDataShareManagementQueryDTO) => Promise<FBR<ApiDataShareManagement[]>>;
+declare const createApiDataShareManagement: (data: ApiDataShareManagementDTO) => Promise<SBR>;
+declare const updateApiDataShareManagement: (id: string, data: ApiDataShareManagementDTO) => Promise<SBR>;
+declare const deleteApiDataShareManagement: (id: string) => Promise<SBR>;
+declare const findApiDataShareHitLog: (data: ApiDataShareHitLogQueryDTO) => Promise<FBR<ApiDataShareHitLog[]>>;
+declare const getExternalApiDailyReport: (data: ExternalApiReportDTO) => Promise<FBR<ExternalApiReport[]>>;
+declare const getExternalApiMonthlyReport: (data: ExternalApiReportDTO) => Promise<FBR<ExternalApiReport[]>>;
+declare const resetExternalApiCache: () => Promise<SBR>;
+
+export { type ApiDataShareHitLog, type ApiDataShareHitLogQueryDTO, ApiDataShareHitLogQuerySchema, type ApiDataShareManagement, type ApiDataShareManagementDTO, type ApiDataShareManagementQueryDTO, ApiDataShareManagementQuerySchema, ApiDataShareManagementSchema, type ExternalApiReport, type ExternalApiReportDTO, ExternalApiReportSchema, createApiDataShareManagement, deleteApiDataShareManagement, findApiDataShareHitLog, findApiDataShareManagement, getExternalApiDailyReport, getExternalApiMonthlyReport, newApiDataShareManagementPayload, resetExternalApiCache, toApiDataShareManagementPayload, updateApiDataShareManagement };