import {z} from 'zod' export type GetApiWorkspacesWorkspaceIdSurveysSurveyIdArgs = {survey_id: string, workspace_id: string}; export type GetApiWorkspacesWorkspaceIdSurveysSurveyIdOptions = {baseUrl: string, HTTPBearer?: string | undefined, fetch?: typeof fetch | undefined}; export const surveyPopulationRef = z.object({id: z.string(), name: z.string(), subtitle: z.string().nullable().optional()}); export const surveyConceptDetail = z.object({id: z.string(), survey_id: z.string(), section_id: z.string(), position: z.number().int(), name: z.string(), body: z.string().nullable().optional(), asset_id: z.string().nullable().optional(), image_url: z.string().nullable().optional(), created_at: z.string(), updated_at: z.string()}); export const rationaleTheme = z.object({label: z.string(), summary: z.string(), count: z.number().int()}); export const rationaleSegmentSummary = z.object({label: z.string(), min: z.number().int(), max: z.number().int(), themes: z.array(rationaleTheme)}); export const openTextTheme = z.object({label: z.string(), summary: z.string(), count: z.number().int(), share: z.number(), quote_persona_ids: z.array(z.string())}); export const openTextRespondent = z.object({persona_id: z.string(), name: z.string(), chips: z.array(z.string()), theme: z.number().int().nullable().optional()}); export const openTextSummary = z.object({summary: z.string(), answered: z.number().int(), themes: z.array(openTextTheme).optional(), respondents: z.array(openTextRespondent).optional()}); export const rationaleConceptSummary = z.object({options: z.record(z.string(), z.array(rationaleTheme)).optional(), segments: z.array(rationaleSegmentSummary).optional(), open_text: openTextSummary.nullable().optional()}); export const rationaleSummary = z.object({by_concept: z.record(z.string(), rationaleConceptSummary).optional()}); export const surveyQuestionDetail = z.object({id: z.string(), survey_id: z.string(), section_id: z.string(), position: z.number().int(), key: z.string(), type: z.enum(["open_ended", "multiple_choice", "scale", "ranking"]), question: z.string(), asset_id: z.string().nullable().optional(), image_url: z.string().nullable().optional(), answer_config: z.record(z.string(), z.unknown()), rationale_summary: rationaleSummary.nullable().optional(), created_at: z.string(), updated_at: z.string()}); export const surveySectionDetail = z.object({id: z.string(), survey_id: z.string(), position: z.number().int(), section_type: z.enum(["question_group", "concept_test"]), concept_category: z.enum(["creatives", "messaging", "scenarios", "websites"]), title: z.string(), created_at: z.string(), updated_at: z.string(), survey_concepts: z.array(surveyConceptDetail), survey_questions: z.array(surveyQuestionDetail)}); export const surveyResponseDetail = z.object({id: z.string(), survey_id: z.string(), section_id: z.string(), question_id: z.string(), concept_id: z.string().nullable().optional(), persona_id: z.string(), answer_text: z.string().nullable().optional(), answer_number: z.number().nullable().optional(), answer_choices: z.array(z.string()).nullable().optional(), rationale: z.string().nullable().optional(), raw_response: z.unknown(), created_at: z.string()}); export const surveyPersonaFailureDetail = z.object({id: z.string(), survey_id: z.string(), section_id: z.string().nullable().optional(), question_id: z.string().nullable().optional(), concept_id: z.string().nullable().optional(), persona_id: z.string(), error_message: z.string(), created_at: z.string()}); export const surveyRankingOption = z.object({ref: z.string(), label: z.string().nullable().optional(), assetId: z.string().nullable().optional(), imageUrl: z.string().nullable().optional(), distribution: z.array(z.number().int()), top1Count: z.number().int(), meanRank: z.number().nullable().optional(), responseCount: z.number().int(), rationaleCount: z.number().int()}); export const surveyConceptRollup = z.object({conceptId: z.string().nullable().optional(), conceptName: z.string().nullable().optional(), responseCount: z.number().int(), averageNumber: z.number().nullable().optional(), numericPercentiles: z.array(z.record(z.string(), z.unknown())).optional(), numberDistribution: z.array(z.record(z.string(), z.unknown())).optional(), choiceCounts: z.array(z.record(z.string(), z.unknown())).optional(), textAnswers: z.array(z.record(z.string(), z.unknown())).optional(), rankingOptions: z.array(surveyRankingOption).optional()}); export const surveyQuestionRollup = z.object({questionId: z.string(), questionKey: z.string(), type: z.enum(["open_ended", "multiple_choice", "scale", "ranking"]), answerConfig: z.record(z.string(), z.unknown()), concepts: z.array(surveyConceptRollup)}); export const surveyDetail = z.object({id: z.string(), owner_id: z.string(), workspace_id: z.string(), population_id: z.string(), name: z.string(), context: z.string().nullable().optional(), status: z.enum(["draft", "running", "completed", "failed"]), started_at: z.string().nullable().optional(), completed_at: z.string().nullable().optional(), demographic_filter: z.record(z.string(), z.unknown()).nullable().optional(), created_at: z.string(), updated_at: z.string(), populations: surveyPopulationRef.nullable().optional(), survey_sections: z.array(surveySectionDetail), survey_responses: z.array(surveyResponseDetail), survey_persona_failures: z.array(surveyPersonaFailureDetail), response_count: z.number().int(), expected_response_count: z.number().int(), persona_count: z.number().int(), failure_count: z.number().int(), rationale_summary_total: z.number().int(), rationale_summary_done: z.number().int(), rollups: z.array(surveyQuestionRollup), can_write: z.boolean()}); export const surveyReadResponse = z.object({survey: surveyDetail}); 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 }; /** * Read Survey * * GET /workspaces/{workspace_id}/surveys/{survey_id} */ export const getApiWorkspacesWorkspaceIdSurveysSurveyId = async (args: GetApiWorkspacesWorkspaceIdSurveysSurveyIdArgs, options: GetApiWorkspacesWorkspaceIdSurveysSurveyIdOptions) => { const {baseUrl, fetch: fetchFn = fetch, HTTPBearer} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (HTTPBearer !== undefined) headers.set('authorization', `Bearer ${HTTPBearer}`) const url = `${baseUrl.replace(/\/+$/, '')}/workspaces/${encodeURIComponent(String(args.workspace_id))}/surveys/${encodeURIComponent(String(args.survey_id))}${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(surveyReadResponse, await res.json()) };