import {z} from 'zod' export type GetApiReportsDrArgs = {api_key: string, customer_id: string, requestor_id: string, begin_date: string, end_date: string, metric_type?: string | undefined, granularity?: string | undefined, attributes_to_show?: string | undefined}; export type GetApiReportsDrOptions = {baseUrl?: string | undefined, key?: string | undefined, fetch?: typeof fetch | undefined}; export const sUSHIErrorModel = z.object({Code: z.number().int(), Severity: z.enum(["Warning", "Error", "Fatal", "Debug", "Info"]), Message: z.string(), Help_URL: z.string().optional(), Data: z.string().optional()}); export const sUSHIReportHeader = z.object({Created: z.string().optional(), Created_By: z.string().optional(), Customer_ID: z.string().optional(), Report_ID: z.string(), Release: z.string(), Report_Name: z.string(), Institution_Name: z.string().optional(), Report_Filters: z.array(z.object({Name: z.string(), Value: z.string()})).optional(), Report_Attributes: z.array(z.object({Name: z.string(), Value: z.string()})).optional(), Exceptions: z.array(sUSHIErrorModel).optional()}); export const cOUNTERPublisherIdentifiers = z.object({Type: z.enum(["ISNI", "Proprietary"]), Value: z.string()}); export const cOUNTERItemPerformance = z.object({Period: z.object({Begin_Date: z.string(), End_Date: z.string()}), Instance: z.array(z.object({Metric_Type: z.enum(["Searches_Automated", "Searches_Federated", "Searches_Platform", "Searches_Regular", "Total_Item_Investigations", "Total_Item_Requests", "Unique_Item_Investigations", "Unique_Item_Requests", "Unique_Title_Investigations", "Unique_Title_Requests", "No_License", "Limit_Exceeded"]), Count: z.number().int()}))}); export const cOUNTERDatabaseUsage = z.object({Database: z.string(), Platform: z.string(), Publisher: z.string(), Publisher_ID: z.array(cOUNTERPublisherIdentifiers).optional(), Performance: z.array(cOUNTERItemPerformance)}); export const cOUNTERDatabaseReport = z.object({Report_Header: sUSHIReportHeader, Report_Items: z.array(cOUNTERDatabaseUsage)}); export const validateResponse = async ( schema: { readonly '~standard': { readonly validate: (value: unknown) => ({ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }) | Promise<{ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }> } }, value: unknown ): Promise => { const result = await schema['~standard'].validate(value) if (result.issues !== undefined) { const detail = result.issues .map(({ message, path }) => path?.length ? `${path.map((segment) => String(typeof segment === 'object' ? segment.key : segment)).join('.')}: ${message}` : message ) .join('; ') throw new Error(`Response does not match the schema: ${detail}`, { cause: { issues: result.issues } }) } return result.value }; /** * This resource returns Database Master Report (DR). A customizable report detailing activity by database that allows the user to apply filters and select other configuration options. * * GET /reports/dr */ export const getApiReportsDr = async (args: GetApiReportsDrArgs, options?: GetApiReportsDrOptions) => { const {baseUrl = "https://api.clarivate.com/api/counter/r5", fetch: fetchFn = fetch, key} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.api_key != null) query.append("api_key", String(args.api_key)) if (args.customer_id != null) query.append("customer_id", String(args.customer_id)) if (args.requestor_id != null) query.append("requestor_id", String(args.requestor_id)) if (args.begin_date != null) query.append("begin_date", String(args.begin_date)) if (args.end_date != null) query.append("end_date", String(args.end_date)) if (args.metric_type != null) query.append("metric_type", String(args.metric_type)) if (args.granularity != null) query.append("granularity", String(args.granularity)) if (args.attributes_to_show != null) query.append("attributes_to_show", String(args.attributes_to_show)) if (key !== undefined) headers.set("X-ApiKey", key) const url = `${baseUrl.replace(/\/+$/, '')}/reports/dr${query.size > 0 ? `?${query}` : ''}` const res = await fetchFn(url, {method: "GET", headers}) if (!res.ok) throw new Error(`Request failed with status ${res.status}`, {cause: {status: res.status, body: await res.text()}}) return validateResponse(cOUNTERDatabaseReport, await res.json()) };