import {z} from 'zod' export type GetApiV2AnalyticsCoursesCourseIdRatingsArgs = {course_id: string, 'page[size]'?: number | undefined, 'page[cursor]'?: (string | null) | undefined, 'filter[student.id]'?: (string | null) | undefined}; export type GetApiV2AnalyticsCoursesCourseIdRatingsOptions = {baseUrl: string, JWTAuth?: string | undefined, fetch?: typeof fetch | undefined}; export const courseRatingAttributes = z.object({rating: z.number().int(), scale_max: z.number().int(), feedback: z.string().nullable().optional(), created_at: z.string()}); export const studentIdentifier = z.object({type: z.string().optional(), id: z.string()}); export const studentRelationship = z.object({data: studentIdentifier.nullable().optional()}); export const courseIdentifier = z.object({type: z.literal("courses"), id: z.string()}); export const courseRelationship = z.object({data: courseIdentifier}); export const courseRatingRelationships = z.object({student: studentRelationship, course: courseRelationship}); export const courseRatingResource = z.object({type: z.string().optional(), id: z.string(), attributes: courseRatingAttributes, relationships: courseRatingRelationships}); export const paginationLinks = z.object({self: z.string().nullable().optional(), next: z.string().nullable().optional(), prev: z.string().nullable().optional()}); export const paginatedListResponseCourseRatingResource = z.object({data: z.array(courseRatingResource), meta: z.record(z.string(), z.unknown()).nullable().optional(), links: paginationLinks.nullable().optional(), included: z.array(z.record(z.string(), z.unknown())).nullable().optional()}); 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 }; /** * List a course's ratings * * GET /v2/analytics/courses/{course_id}/ratings/ */ export const getApiV2AnalyticsCoursesCourseIdRatings = async (args: GetApiV2AnalyticsCoursesCourseIdRatingsArgs, options: GetApiV2AnalyticsCoursesCourseIdRatingsOptions) => { const {baseUrl, fetch: fetchFn = fetch, JWTAuth} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/vnd.api+json") if (args['page[size]'] != null) query.append("page[size]", String(args['page[size]'])) if (args['page[cursor]'] != null) query.append("page[cursor]", String(args['page[cursor]'])) if (args['filter[student.id]'] != null) query.append("filter[student.id]", String(args['filter[student.id]'])) if (JWTAuth !== undefined) headers.set('authorization', `Bearer ${JWTAuth}`) const url = `${baseUrl.replace(/\/+$/, '')}/v2/analytics/courses/${encodeURIComponent(String(args.course_id))}/ratings/${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(paginatedListResponseCourseRatingResource, await res.json()) };