import {z} from 'zod' export type GetApiV6ReportTypesArgs = {report_type_id?: string | undefined, display_name?: string | undefined, description?: string | undefined, visibility?: ('EXTOLE_ONLY' | 'PRIVATE' | 'PUBLIC') | undefined, tags?: string | undefined, exclude_tags?: string | undefined, search_query?: string | undefined, limit?: number | undefined, offset?: number | undefined, order_by?: ('DISPLAY_NAME' | 'ID' | 'TYPE' | 'VISIBILITY') | undefined, order?: ('ASCENDING' | 'DESCENDING') | undefined}; export type GetApiV6ReportTypesOptions = {baseUrl?: string | undefined, HEADER?: string | undefined, fetch?: typeof fetch | undefined}; export const componentReferenceResponse = z.object({component_id: z.string().optional(), socket_names: z.array(z.string()).optional()}); export const zonedDateTime = z.string(); export const reportParameterTypeResponse = z.object({name: z.enum(["AUDIENCE_ID", "AUDIENCE_IDS", "AUDIENCE_MEMBERSHIPS_METRIC_MAPPING", "AUDIENCE_MEMBERSHIPS_ROW_MAPPINGS", "AUDIENCE_MEMBERS_ROW_MAPPINGS", "BOOLEAN", "CAMPAIGN_ID", "CAMPAIGN_IDS", "CHANNEL_MAPPING", "CLIENT_EVENT_METRIC_MAPPINGS", "CLIENT_ID", "CLIENT_IDS", "DATE", "DATE_RANGE", "DECIMAL", "EMAIL_NAMES", "ENUM", "ENUM_LIST", "EQUALITY", "FILTER_MAPPINGS", "FLOWS", "FLOW_FILTER", "GRANULAR_TIME_RANGE", "ID", "IDS", "INPUT_RECORD_METRIC_MAPPING", "INPUT_RECORD_ROW_MAPPINGS", "INTEGER", "LONG", "MESSAGE_SUMMARY_METRIC_MAPPINGS", "METRIC_MAPPINGS", "MODEL_CONFIGURATION_METRIC_MAPPING", "NORMALIZED_EMAIL", "NOT_ARCHIVED_CAMPAIGN_ID", "PERSON_DIMENSION_MAPPINGS", "PERSON_MAPPINGS", "PROGRAM_LABEL", "PROGRAM_LABELS", "REGEX", "REWARD_EVENT_METRIC_MAPPINGS", "REWARD_ROW_MAPPINGS", "REWARD_SUPPLIER_DISPLAY_TYPES", "REWARD_SUPPLIER_IDS", "REWARD_SUPPLIER_TYPES", "ROW_MAPPINGS", "SORT_ORDER_MAPPINGS", "SORT_ORDER_MAPPINGS_ON_STEPS", "STEP", "STEPS", "STEP_COLUMN_LIST", "STRING", "STRING_LIST", "TIERS", "TIME", "TIME_RANGE", "WEBHOOK_DISPATCH_METRIC_MAPPING", "WEBHOOK_DISPATCH_ROW_MAPPINGS", "WEBHOOK_METRIC_MAPPING", "WEBHOOK_ROW_MAPPINGS"]).optional(), value_type: z.enum(["DYNAMIC", "STATIC"]).nullable().optional(), values: z.array(z.string()).nullable().optional()}); export const reportTypeParameterDetailsResponse = z.object({category: z.string().nullable().optional(), default_value: z.string().nullable().optional(), description: z.string().optional(), display_name: z.string().optional(), is_required: z.boolean().optional(), name: z.string().optional(), order: z.number().int().optional(), type: reportParameterTypeResponse.optional()}); export const reportTypeColumnResponse = z.object({name: z.string().optional(), note: z.string().nullable().optional(), sample_value: z.string().nullable().optional()}); export const reportTypeTagResponse = z.object({name: z.string().optional(), type: z.enum(["GLOBAL", "PRIVATE"]).optional()}); export const reportTypeResponse = z.discriminatedUnion("type", [z.object({allowed_scopes: z.array(z.enum(["CLIENT_ADMIN", "CLIENT_SUPERUSER", "CONSUMER_PUBLIC"])), categories: z.array(z.string()), component_ids: z.array(z.string()), component_references: z.array(componentReferenceResponse), data_sources: z.array(z.enum(["AUDIT_EMAIL", "BATCH", "CLIENT", "CLIENT_CHANGE", "CONSUMER", "CONSUMER_PROFILE", "DASHBOARD", "DATA_INTELLIGENCE", "MESSAGE", "NOTIFICATION", "PROFILE", "REWARD", "REWARD_COMMAND", "WEBHOOK", "WEBHOOK_DISPATCH_RESULT"])), data_start: zonedDateTime, description: z.string(), display_name: z.string(), executor_type: z.enum(["DASHBOARD", "SPARK", "SQL"]), formats: z.array(z.enum(["CSV", "HEADLESS_CSV", "HEADLESS_PSV", "JSON", "JSONL", "PSV", "XLSX"])), name: z.string(), parameters: z.array(reportTypeParameterDetailsResponse), preview_columns: z.array(reportTypeColumnResponse), scopes: z.array(z.enum(["CLIENT_ADMIN", "CLIENT_SUPERUSER", "CONSUMER_PUBLIC"])), tags: z.array(reportTypeTagResponse), type: z.literal("CONFIGURED"), visibility: z.enum(["EXTOLE_ONLY", "PRIVATE", "PUBLIC"]), created_date: zonedDateTime, updated_date: zonedDateTime}), z.object({allowed_scopes: z.array(z.enum(["CLIENT_ADMIN", "CLIENT_SUPERUSER", "CONSUMER_PUBLIC"])), categories: z.array(z.string()), component_ids: z.array(z.string()), component_references: z.array(componentReferenceResponse), data_sources: z.array(z.enum(["AUDIT_EMAIL", "BATCH", "CLIENT", "CLIENT_CHANGE", "CONSUMER", "CONSUMER_PROFILE", "DASHBOARD", "DATA_INTELLIGENCE", "MESSAGE", "NOTIFICATION", "PROFILE", "REWARD", "REWARD_COMMAND", "WEBHOOK", "WEBHOOK_DISPATCH_RESULT"])), data_start: zonedDateTime, description: z.string(), display_name: z.string(), executor_type: z.enum(["DASHBOARD", "SPARK", "SQL"]), formats: z.array(z.enum(["CSV", "HEADLESS_CSV", "HEADLESS_PSV", "JSON", "JSONL", "PSV", "XLSX"])), name: z.string(), parameters: z.array(reportTypeParameterDetailsResponse), preview_columns: z.array(reportTypeColumnResponse), scopes: z.array(z.enum(["CLIENT_ADMIN", "CLIENT_SUPERUSER", "CONSUMER_PUBLIC"])), tags: z.array(reportTypeTagResponse), type: z.literal("DASHBOARD"), visibility: z.enum(["EXTOLE_ONLY", "PRIVATE", "PUBLIC"])}), z.object({allowed_scopes: z.array(z.enum(["CLIENT_ADMIN", "CLIENT_SUPERUSER", "CONSUMER_PUBLIC"])), categories: z.array(z.string()), component_ids: z.array(z.string()), component_references: z.array(componentReferenceResponse), data_sources: z.array(z.enum(["AUDIT_EMAIL", "BATCH", "CLIENT", "CLIENT_CHANGE", "CONSUMER", "CONSUMER_PROFILE", "DASHBOARD", "DATA_INTELLIGENCE", "MESSAGE", "NOTIFICATION", "PROFILE", "REWARD", "REWARD_COMMAND", "WEBHOOK", "WEBHOOK_DISPATCH_RESULT"])), data_start: zonedDateTime, description: z.string(), display_name: z.string(), executor_type: z.enum(["DASHBOARD", "SPARK", "SQL"]), formats: z.array(z.enum(["CSV", "HEADLESS_CSV", "HEADLESS_PSV", "JSON", "JSONL", "PSV", "XLSX"])), name: z.string(), parameters: z.array(reportTypeParameterDetailsResponse), preview_columns: z.array(reportTypeColumnResponse), scopes: z.array(z.enum(["CLIENT_ADMIN", "CLIENT_SUPERUSER", "CONSUMER_PUBLIC"])), tags: z.array(reportTypeTagResponse), type: z.literal("SPARK"), visibility: z.enum(["EXTOLE_ONLY", "PRIVATE", "PUBLIC"])}), z.object({allowed_scopes: z.array(z.enum(["CLIENT_ADMIN", "CLIENT_SUPERUSER", "CONSUMER_PUBLIC"])), categories: z.array(z.string()), component_ids: z.array(z.string()), component_references: z.array(componentReferenceResponse), data_sources: z.array(z.enum(["AUDIT_EMAIL", "BATCH", "CLIENT", "CLIENT_CHANGE", "CONSUMER", "CONSUMER_PROFILE", "DASHBOARD", "DATA_INTELLIGENCE", "MESSAGE", "NOTIFICATION", "PROFILE", "REWARD", "REWARD_COMMAND", "WEBHOOK", "WEBHOOK_DISPATCH_RESULT"])), data_start: zonedDateTime, description: z.string(), display_name: z.string(), executor_type: z.enum(["DASHBOARD", "SPARK", "SQL"]), formats: z.array(z.enum(["CSV", "HEADLESS_CSV", "HEADLESS_PSV", "JSON", "JSONL", "PSV", "XLSX"])), name: z.string(), parameters: z.array(reportTypeParameterDetailsResponse), preview_columns: z.array(reportTypeColumnResponse), scopes: z.array(z.enum(["CLIENT_ADMIN", "CLIENT_SUPERUSER", "CONSUMER_PUBLIC"])), tags: z.array(reportTypeTagResponse), type: z.literal("SQL"), visibility: z.enum(["EXTOLE_ONLY", "PRIVATE", "PUBLIC"]), created_date: zonedDateTime, database: z.enum(["ANALYTICS", "CUSTOMER_PORTAL", "INCENTIVES", "LABS", "OPTOUT"]), query: z.string(), updated_date: zonedDateTime})]); export const getApiV6ReportTypesResponse = z.array(reportTypeResponse); 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 report types * * GET /v6/report-types * * Also accepts auth: QUERY, COOKIE */ export const getApiV6ReportTypes = async (args: GetApiV6ReportTypesArgs, options?: GetApiV6ReportTypesOptions) => { const {baseUrl = "https://api.extole.io", fetch: fetchFn = fetch, HEADER} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.report_type_id != null) query.append("report_type_id", String(args.report_type_id)) if (args.display_name != null) query.append("display_name", String(args.display_name)) if (args.description != null) query.append("description", String(args.description)) if (args.visibility != null) query.append("visibility", String(args.visibility)) if (args.tags != null) query.append("tags", String(args.tags)) if (args.exclude_tags != null) query.append("exclude_tags", String(args.exclude_tags)) if (args.search_query != null) query.append("search_query", String(args.search_query)) if (args.limit != null) query.append("limit", String(args.limit)) if (args.offset != null) query.append("offset", String(args.offset)) if (args.order_by != null) query.append("order_by", String(args.order_by)) if (args.order != null) query.append("order", String(args.order)) if (HEADER !== undefined) headers.set("Authorization", HEADER) const url = `${baseUrl.replace(/\/+$/, '')}/v6/report-types${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(getApiV6ReportTypesResponse, await res.json()) };