mirror of
https://github.com/hanzoai/insights.git
synced 2026-11-03 00:52:32 +00:00
zeekay
1b367e2b62
The tree was a debranded snapshot of upstream taken around 2026-02-20, and upstream has moved about five months since. This replaces it with upstream master, mechanically re-derived: bin/debrand does the rename, and the pipeline and squashed migrations are restored from the shipped tree. Not a merge. The previous import replaced the tree wholesale in a single commit, so there is no shared content history to merge against. Reproducing the rename on the new tree is what actually converges. What survives: .hanzo/workflows, the Dockerfiles and bin/docker* entrypoints, compose files, LLM.md, and insights/migrations. The squashed initial migration is load-bearing — the live database records it by name, so upstream's ~918 individual migrations cannot come back. Nine products are dropped as unreferenced. Twenty-one more that we do not run are kept anyway because the core app still imports them; unpicking those is a refactor and does not belong in a rebase. This base does not build yet, and the reasons are not in the rename: upstream now wants Python 3.13.13 against our 3.12.12 and Django 5.2 against our 4.2, and the dependency manifests still name upstream packages that we republish under our own names. Those are decisions, not renames.
2231 lines
160 KiB
TypeScript
Generated
2231 lines
160 KiB
TypeScript
Generated
/**
|
|
* Auto-generated Zod validation schemas from the Django backend OpenAPI schema.
|
|
* To modify these schemas, update the Django serializers or views, then run:
|
|
* insightscli build:openapi
|
|
* Questions or issues? #team-devex on Slack
|
|
*
|
|
* Insights API - generated
|
|
* OpenAPI spec version: 1.0.0
|
|
*/
|
|
import * as zod from 'zod'
|
|
|
|
export const surveysCreateBodyNameMax = 400
|
|
|
|
export const surveysCreateBodyTargetingFlagFiltersOneEarlyExitDefault = false
|
|
export const surveysCreateBodyQuestionsItemThreeBranchingOneThreeIndexMin = 0
|
|
|
|
export const surveysCreateBodyQuestionsItemThreeBranchingOneFourResponseValuesOneMin = 0
|
|
|
|
export const surveysCreateBodyQuestionsItemFourChoicesMin = 2
|
|
export const surveysCreateBodyQuestionsItemFourChoicesMax = 20
|
|
|
|
export const surveysCreateBodyQuestionsItemFourBranchingOneThreeIndexMin = 0
|
|
|
|
export const surveysCreateBodyQuestionsItemFourBranchingOneFourResponseValuesOneMin = 0
|
|
|
|
export const surveysCreateBodyQuestionsItemFiveChoicesMin = 2
|
|
export const surveysCreateBodyQuestionsItemFiveChoicesMax = 20
|
|
|
|
export const surveysCreateBodyConditionsOneSeenSurveyWaitPeriodInDaysMin = 0
|
|
|
|
export const surveysCreateBodyIterationCountMax = 500
|
|
|
|
export const surveysCreateBodyIterationFrequencyDaysMax = 365
|
|
|
|
export const surveysCreateBodyCurrentIterationMin = 0
|
|
export const surveysCreateBodyCurrentIterationMax = 2147483647
|
|
|
|
export const surveysCreateBodyResponseSamplingIntervalMin = 0
|
|
export const surveysCreateBodyResponseSamplingIntervalMax = 2147483647
|
|
|
|
export const surveysCreateBodyResponseSamplingLimitMin = 0
|
|
export const surveysCreateBodyResponseSamplingLimitMax = 2147483647
|
|
|
|
export const surveysCreateBodyBaseLanguageMax = 20
|
|
|
|
export const SurveysCreateBody = /* @__PURE__ */ zod.object({
|
|
name: zod.string().min(1).max(surveysCreateBodyNameMax).describe('Survey name.'),
|
|
description: zod.string().optional().describe('Survey description.'),
|
|
type: zod
|
|
.enum(['popover', 'widget', 'external_survey', 'api'])
|
|
.describe(
|
|
'\* `popover` - popover\n\* `widget` - widget\n\* `external_survey` - external survey\n\* `api` - api'
|
|
)
|
|
.describe(
|
|
'Survey type.\n\n\* `popover` - popover\n\* `widget` - widget\n\* `external_survey` - external survey\n\* `api` - api'
|
|
),
|
|
schedule: zod
|
|
.union([
|
|
zod
|
|
.enum(['once', 'recurring', 'always'])
|
|
.describe('\* `once` - once\n\* `recurring` - recurring\n\* `always` - always'),
|
|
zod.null(),
|
|
])
|
|
.optional()
|
|
.describe(
|
|
"Survey scheduling behavior: 'once' = show once per user (default), 'recurring' = repeat based on iteration_count and iteration_frequency_days settings, 'always' = show every time conditions are met (mainly for widget surveys)\n\n\* `once` - once\n\* `recurring` - recurring\n\* `always` - always"
|
|
),
|
|
linked_flag_id: zod.number().nullish().describe('The feature flag linked to this survey.'),
|
|
linked_insight_id: zod.number().nullish(),
|
|
targeting_flag_id: zod.number().optional().describe('An existing targeting flag to use for this survey.'),
|
|
targeting_flag_filters: zod
|
|
.union([
|
|
zod.object({
|
|
groups: zod
|
|
.array(
|
|
zod.object({
|
|
properties: zod
|
|
.array(
|
|
zod.union([
|
|
zod.object({
|
|
key: zod
|
|
.string()
|
|
.describe('Property key used in this feature flag condition.'),
|
|
type: zod
|
|
.enum(['cohort', 'person', 'group'])
|
|
.describe(
|
|
'\* `cohort` - cohort\n\* `person` - person\n\* `group` - group'
|
|
)
|
|
.optional()
|
|
.describe(
|
|
"Property filter type. Common values are 'person' and 'cohort'.\n\n\* `cohort` - cohort\n\* `person` - person\n\* `group` - group"
|
|
),
|
|
cohort_name: zod
|
|
.string()
|
|
.nullish()
|
|
.describe('Resolved cohort name for cohort-type filters.'),
|
|
group_type_index: zod
|
|
.number()
|
|
.nullish()
|
|
.describe('Group type index when using group-based filters.'),
|
|
value: zod
|
|
.unknown()
|
|
.describe(
|
|
'Comparison value for the property filter. Supports strings, numbers, booleans, and arrays.'
|
|
),
|
|
operator: zod
|
|
.enum([
|
|
'exact',
|
|
'is_not',
|
|
'icontains',
|
|
'not_icontains',
|
|
'starts_with',
|
|
'not_starts_with',
|
|
'ends_with',
|
|
'not_ends_with',
|
|
'regex',
|
|
'not_regex',
|
|
'gt',
|
|
'gte',
|
|
'lt',
|
|
'lte',
|
|
])
|
|
.describe(
|
|
'\* `exact` - exact\n\* `is_not` - is_not\n\* `icontains` - icontains\n\* `not_icontains` - not_icontains\n\* `starts_with` - starts_with\n\* `not_starts_with` - not_starts_with\n\* `ends_with` - ends_with\n\* `not_ends_with` - not_ends_with\n\* `regex` - regex\n\* `not_regex` - not_regex\n\* `gt` - gt\n\* `gte` - gte\n\* `lt` - lt\n\* `lte` - lte'
|
|
)
|
|
.describe(
|
|
'Operator used to compare the property value.\n\n\* `exact` - exact\n\* `is_not` - is_not\n\* `icontains` - icontains\n\* `not_icontains` - not_icontains\n\* `starts_with` - starts_with\n\* `not_starts_with` - not_starts_with\n\* `ends_with` - ends_with\n\* `not_ends_with` - not_ends_with\n\* `regex` - regex\n\* `not_regex` - not_regex\n\* `gt` - gt\n\* `gte` - gte\n\* `lt` - lt\n\* `lte` - lte'
|
|
),
|
|
}),
|
|
zod.object({
|
|
key: zod
|
|
.string()
|
|
.describe('Property key used in this feature flag condition.'),
|
|
type: zod
|
|
.enum(['cohort', 'person', 'group'])
|
|
.describe(
|
|
'\* `cohort` - cohort\n\* `person` - person\n\* `group` - group'
|
|
)
|
|
.optional()
|
|
.describe(
|
|
"Property filter type. Common values are 'person' and 'cohort'.\n\n\* `cohort` - cohort\n\* `person` - person\n\* `group` - group"
|
|
),
|
|
cohort_name: zod
|
|
.string()
|
|
.nullish()
|
|
.describe('Resolved cohort name for cohort-type filters.'),
|
|
group_type_index: zod
|
|
.number()
|
|
.nullish()
|
|
.describe('Group type index when using group-based filters.'),
|
|
operator: zod
|
|
.enum(['is_set', 'is_not_set'])
|
|
.describe('\* `is_set` - is_set\n\* `is_not_set` - is_not_set')
|
|
.describe(
|
|
'Existence operator.\n\n\* `is_set` - is_set\n\* `is_not_set` - is_not_set'
|
|
),
|
|
value: zod
|
|
.unknown()
|
|
.optional()
|
|
.describe(
|
|
'Optional value. Runtime behavior determines whether this is ignored.'
|
|
),
|
|
}),
|
|
zod.object({
|
|
key: zod
|
|
.string()
|
|
.describe('Property key used in this feature flag condition.'),
|
|
type: zod
|
|
.enum(['cohort', 'person', 'group'])
|
|
.describe(
|
|
'\* `cohort` - cohort\n\* `person` - person\n\* `group` - group'
|
|
)
|
|
.optional()
|
|
.describe(
|
|
"Property filter type. Common values are 'person' and 'cohort'.\n\n\* `cohort` - cohort\n\* `person` - person\n\* `group` - group"
|
|
),
|
|
cohort_name: zod
|
|
.string()
|
|
.nullish()
|
|
.describe('Resolved cohort name for cohort-type filters.'),
|
|
group_type_index: zod
|
|
.number()
|
|
.nullish()
|
|
.describe('Group type index when using group-based filters.'),
|
|
operator: zod
|
|
.enum(['is_date_exact', 'is_date_before', 'is_date_after'])
|
|
.describe(
|
|
'\* `is_date_exact` - is_date_exact\n\* `is_date_before` - is_date_before\n\* `is_date_after` - is_date_after'
|
|
)
|
|
.describe(
|
|
'Date comparison operator.\n\n\* `is_date_exact` - is_date_exact\n\* `is_date_after` - is_date_after\n\* `is_date_before` - is_date_before'
|
|
),
|
|
value: zod
|
|
.string()
|
|
.describe('Date value in ISO format or relative date expression.'),
|
|
}),
|
|
zod.object({
|
|
key: zod
|
|
.string()
|
|
.describe('Property key used in this feature flag condition.'),
|
|
type: zod
|
|
.enum(['cohort', 'person', 'group'])
|
|
.describe(
|
|
'\* `cohort` - cohort\n\* `person` - person\n\* `group` - group'
|
|
)
|
|
.optional()
|
|
.describe(
|
|
"Property filter type. Common values are 'person' and 'cohort'.\n\n\* `cohort` - cohort\n\* `person` - person\n\* `group` - group"
|
|
),
|
|
cohort_name: zod
|
|
.string()
|
|
.nullish()
|
|
.describe('Resolved cohort name for cohort-type filters.'),
|
|
group_type_index: zod
|
|
.number()
|
|
.nullish()
|
|
.describe('Group type index when using group-based filters.'),
|
|
operator: zod
|
|
.enum([
|
|
'semver_gt',
|
|
'semver_gte',
|
|
'semver_lt',
|
|
'semver_lte',
|
|
'semver_eq',
|
|
'semver_neq',
|
|
'semver_tilde',
|
|
'semver_caret',
|
|
'semver_wildcard',
|
|
])
|
|
.describe(
|
|
'\* `semver_gt` - semver_gt\n\* `semver_gte` - semver_gte\n\* `semver_lt` - semver_lt\n\* `semver_lte` - semver_lte\n\* `semver_eq` - semver_eq\n\* `semver_neq` - semver_neq\n\* `semver_tilde` - semver_tilde\n\* `semver_caret` - semver_caret\n\* `semver_wildcard` - semver_wildcard'
|
|
)
|
|
.describe(
|
|
'Semantic version comparison operator.\n\n\* `semver_gt` - semver_gt\n\* `semver_gte` - semver_gte\n\* `semver_lt` - semver_lt\n\* `semver_lte` - semver_lte\n\* `semver_eq` - semver_eq\n\* `semver_neq` - semver_neq\n\* `semver_tilde` - semver_tilde\n\* `semver_caret` - semver_caret\n\* `semver_wildcard` - semver_wildcard'
|
|
),
|
|
value: zod.string().describe('Semantic version string.'),
|
|
}),
|
|
zod.object({
|
|
key: zod
|
|
.string()
|
|
.describe('Property key used in this feature flag condition.'),
|
|
type: zod
|
|
.enum(['cohort', 'person', 'group'])
|
|
.describe(
|
|
'\* `cohort` - cohort\n\* `person` - person\n\* `group` - group'
|
|
)
|
|
.optional()
|
|
.describe(
|
|
"Property filter type. Common values are 'person' and 'cohort'.\n\n\* `cohort` - cohort\n\* `person` - person\n\* `group` - group"
|
|
),
|
|
cohort_name: zod
|
|
.string()
|
|
.nullish()
|
|
.describe('Resolved cohort name for cohort-type filters.'),
|
|
group_type_index: zod
|
|
.number()
|
|
.nullish()
|
|
.describe('Group type index when using group-based filters.'),
|
|
operator: zod
|
|
.enum(['icontains_multi', 'not_icontains_multi'])
|
|
.describe(
|
|
'\* `icontains_multi` - icontains_multi\n\* `not_icontains_multi` - not_icontains_multi'
|
|
)
|
|
.describe(
|
|
'Multi-contains operator.\n\n\* `icontains_multi` - icontains_multi\n\* `not_icontains_multi` - not_icontains_multi'
|
|
),
|
|
value: zod
|
|
.array(zod.string())
|
|
.describe('List of strings to evaluate against.'),
|
|
}),
|
|
zod.object({
|
|
key: zod
|
|
.string()
|
|
.describe('Property key used in this feature flag condition.'),
|
|
type: zod
|
|
.enum(['cohort'])
|
|
.describe('\* `cohort` - cohort')
|
|
.describe(
|
|
'Cohort property type required for in\/not_in operators.\n\n\* `cohort` - cohort'
|
|
),
|
|
cohort_name: zod
|
|
.string()
|
|
.nullish()
|
|
.describe('Resolved cohort name for cohort-type filters.'),
|
|
group_type_index: zod
|
|
.number()
|
|
.nullish()
|
|
.describe('Group type index when using group-based filters.'),
|
|
operator: zod
|
|
.enum(['in', 'not_in'])
|
|
.describe('\* `in` - in\n\* `not_in` - not_in')
|
|
.describe(
|
|
'Membership operator for cohort properties.\n\n\* `in` - in\n\* `not_in` - not_in'
|
|
),
|
|
value: zod
|
|
.unknown()
|
|
.describe(
|
|
'Cohort comparison value (single or list, depending on usage).'
|
|
),
|
|
}),
|
|
zod.object({
|
|
key: zod
|
|
.string()
|
|
.describe('Property key used in this feature flag condition.'),
|
|
type: zod
|
|
.enum(['flag'])
|
|
.describe('\* `flag` - flag')
|
|
.describe(
|
|
'Flag property type required for flag dependency checks.\n\n\* `flag` - flag'
|
|
),
|
|
cohort_name: zod
|
|
.string()
|
|
.nullish()
|
|
.describe('Resolved cohort name for cohort-type filters.'),
|
|
group_type_index: zod
|
|
.number()
|
|
.nullish()
|
|
.describe('Group type index when using group-based filters.'),
|
|
operator: zod
|
|
.enum(['flag_evaluates_to'])
|
|
.describe('\* `flag_evaluates_to` - flag_evaluates_to')
|
|
.describe(
|
|
'Operator for feature flag dependency evaluation.\n\n\* `flag_evaluates_to` - flag_evaluates_to'
|
|
),
|
|
value: zod.unknown().describe('Value to compare flag evaluation against.'),
|
|
}),
|
|
])
|
|
)
|
|
.optional()
|
|
.describe('Property conditions for this release condition group.'),
|
|
rollout_percentage: zod
|
|
.number()
|
|
.optional()
|
|
.describe('Rollout percentage for this release condition group.'),
|
|
variant: zod.string().nullish().describe('Variant key override for multivariate flags.'),
|
|
aggregation_group_type_index: zod
|
|
.number()
|
|
.nullish()
|
|
.describe(
|
|
'Group type index for this condition set. None means person-level aggregation.'
|
|
),
|
|
})
|
|
)
|
|
.optional()
|
|
.describe('Release condition groups for the feature flag.'),
|
|
multivariate: zod
|
|
.union([
|
|
zod.object({
|
|
variants: zod
|
|
.array(
|
|
zod.object({
|
|
key: zod.string().describe('Unique key for this variant.'),
|
|
name: zod.string().optional().describe('Human-readable name for this variant.'),
|
|
rollout_percentage: zod.number().describe('Variant rollout percentage.'),
|
|
})
|
|
)
|
|
.describe('Variant definitions for multivariate feature flags.'),
|
|
}),
|
|
zod.null(),
|
|
])
|
|
.optional()
|
|
.describe('Multivariate configuration for variant-based rollouts.'),
|
|
aggregation_group_type_index: zod
|
|
.number()
|
|
.nullish()
|
|
.describe('Group type index for group-based feature flags.'),
|
|
payloads: zod
|
|
.record(zod.string(), zod.string())
|
|
.optional()
|
|
.describe('Optional payload values keyed by variant key.'),
|
|
feature_enrollment: zod
|
|
.boolean()
|
|
.nullish()
|
|
.describe(
|
|
'Whether this flag has early access feature enrollment enabled. When true, the flag is evaluated against the person property $feature_enrollment\/{flag_key}.'
|
|
),
|
|
early_exit: zod
|
|
.boolean()
|
|
.default(surveysCreateBodyTargetingFlagFiltersOneEarlyExitDefault)
|
|
.describe(
|
|
'When true, condition evaluation stops at the first matching condition set rather than continuing to evaluate subsequent groups.'
|
|
),
|
|
}),
|
|
zod.null(),
|
|
])
|
|
.optional()
|
|
.describe(
|
|
"Target specific users based on their properties. Example: {groups: [{properties: [{key: 'email', value: ['@company.com'], operator: 'icontains'}], rollout_percentage: 100}]}"
|
|
),
|
|
remove_targeting_flag: zod
|
|
.boolean()
|
|
.nullish()
|
|
.describe(
|
|
'Set to true to completely remove all targeting filters from the survey, making it visible to all users (subject to other display conditions like URL matching).'
|
|
),
|
|
questions: zod
|
|
.array(
|
|
zod.union([
|
|
zod.object({
|
|
id: zod
|
|
.string()
|
|
.optional()
|
|
.describe(
|
|
'Stable question identifier (UUID). When editing an existing question, send back its current id so its responses (keyed by $survey_response_<id>) stay attached; omit it for new questions and the server generates one.'
|
|
),
|
|
type: zod.enum(['open']).describe('\* `open` - open'),
|
|
question: zod.string().describe('Question text shown to respondents.'),
|
|
description: zod.string().optional().describe('Optional helper text.'),
|
|
descriptionContentType: zod
|
|
.enum(['html', 'text'])
|
|
.describe('\* `html` - html\n\* `text` - text')
|
|
.optional()
|
|
.describe('Format for the description field.\n\n\* `text` - text\n\* `html` - html'),
|
|
optional: zod.boolean().optional().describe('Whether respondents may skip this question.'),
|
|
buttonText: zod.string().optional().describe('Custom button label.'),
|
|
}),
|
|
zod.object({
|
|
id: zod
|
|
.string()
|
|
.optional()
|
|
.describe(
|
|
'Stable question identifier (UUID). When editing an existing question, send back its current id so its responses (keyed by $survey_response_<id>) stay attached; omit it for new questions and the server generates one.'
|
|
),
|
|
type: zod.enum(['link']).describe('\* `link` - link'),
|
|
question: zod.string().describe('Question text shown to respondents.'),
|
|
description: zod.string().optional().describe('Optional helper text.'),
|
|
descriptionContentType: zod
|
|
.enum(['html', 'text'])
|
|
.describe('\* `html` - html\n\* `text` - text')
|
|
.optional()
|
|
.describe('Format for the description field.\n\n\* `text` - text\n\* `html` - html'),
|
|
optional: zod.boolean().optional().describe('Whether respondents may skip this question.'),
|
|
buttonText: zod.string().optional().describe('Custom button label.'),
|
|
link: zod.string().describe('HTTPS or mailto URL for link questions.'),
|
|
}),
|
|
zod.object({
|
|
id: zod
|
|
.string()
|
|
.optional()
|
|
.describe(
|
|
'Stable question identifier (UUID). When editing an existing question, send back its current id so its responses (keyed by $survey_response_<id>) stay attached; omit it for new questions and the server generates one.'
|
|
),
|
|
type: zod.enum(['rating']).describe('\* `rating` - rating'),
|
|
question: zod.string().describe('Question text shown to respondents.'),
|
|
description: zod.string().optional().describe('Optional helper text.'),
|
|
descriptionContentType: zod
|
|
.enum(['html', 'text'])
|
|
.describe('\* `html` - html\n\* `text` - text')
|
|
.optional()
|
|
.describe('Format for the description field.\n\n\* `text` - text\n\* `html` - html'),
|
|
optional: zod.boolean().optional().describe('Whether respondents may skip this question.'),
|
|
buttonText: zod.string().optional().describe('Custom button label.'),
|
|
display: zod
|
|
.enum(['number', 'emoji'])
|
|
.describe('\* `number` - number\n\* `emoji` - emoji')
|
|
.optional()
|
|
.describe(
|
|
"Display format: 'number' shows numeric scale, 'emoji' shows emoji scale.\n\n\* `number` - number\n\* `emoji` - emoji"
|
|
),
|
|
scale: zod.number().min(1).optional().describe('Rating scale can be one of 3, 5, or 7'),
|
|
lowerBoundLabel: zod
|
|
.string()
|
|
.optional()
|
|
.describe("Label for the lowest rating (e.g., 'Very Poor')"),
|
|
upperBoundLabel: zod
|
|
.string()
|
|
.optional()
|
|
.describe("Label for the highest rating (e.g., 'Excellent')"),
|
|
branching: zod
|
|
.union([
|
|
zod.union([
|
|
zod.object({
|
|
type: zod
|
|
.enum(['next_question'])
|
|
.describe('\* `next_question` - next_question')
|
|
.describe(
|
|
'Continue to the next question in sequence.\n\n\* `next_question` - next_question'
|
|
),
|
|
}),
|
|
zod.object({
|
|
type: zod
|
|
.enum(['end'])
|
|
.describe('\* `end` - end')
|
|
.describe('End the survey.\n\n\* `end` - end'),
|
|
}),
|
|
zod.object({
|
|
type: zod
|
|
.enum(['specific_question'])
|
|
.describe('\* `specific_question` - specific_question')
|
|
.describe(
|
|
'Jump to a specific question index.\n\n\* `specific_question` - specific_question'
|
|
),
|
|
index: zod
|
|
.number()
|
|
.min(surveysCreateBodyQuestionsItemThreeBranchingOneThreeIndexMin)
|
|
.describe('0-based index of the next question.'),
|
|
}),
|
|
zod.object({
|
|
type: zod
|
|
.enum(['response_based'])
|
|
.describe('\* `response_based` - response_based')
|
|
.describe(
|
|
'Branch based on the selected or entered response.\n\n\* `response_based` - response_based'
|
|
),
|
|
responseValues: zod
|
|
.record(
|
|
zod.string(),
|
|
zod.union([
|
|
zod
|
|
.number()
|
|
.min(
|
|
surveysCreateBodyQuestionsItemThreeBranchingOneFourResponseValuesOneMin
|
|
),
|
|
zod.enum(['end']),
|
|
])
|
|
)
|
|
.describe(
|
|
"Response-based branching map. Values can be a question index or 'end'."
|
|
),
|
|
}),
|
|
]),
|
|
zod.null(),
|
|
])
|
|
.optional(),
|
|
}),
|
|
zod.object({
|
|
id: zod
|
|
.string()
|
|
.optional()
|
|
.describe(
|
|
'Stable question identifier (UUID). When editing an existing question, send back its current id so its responses (keyed by $survey_response_<id>) stay attached; omit it for new questions and the server generates one.'
|
|
),
|
|
type: zod.enum(['single_choice']).describe('\* `single_choice` - single_choice'),
|
|
question: zod.string().describe('Question text shown to respondents.'),
|
|
description: zod.string().optional().describe('Optional helper text.'),
|
|
descriptionContentType: zod
|
|
.enum(['html', 'text'])
|
|
.describe('\* `html` - html\n\* `text` - text')
|
|
.optional()
|
|
.describe('Format for the description field.\n\n\* `text` - text\n\* `html` - html'),
|
|
optional: zod.boolean().optional().describe('Whether respondents may skip this question.'),
|
|
buttonText: zod.string().optional().describe('Custom button label.'),
|
|
choices: zod
|
|
.array(zod.string())
|
|
.min(surveysCreateBodyQuestionsItemFourChoicesMin)
|
|
.max(surveysCreateBodyQuestionsItemFourChoicesMax)
|
|
.describe(
|
|
'Array of choice options. Choice indices (0, 1, 2, ...) are used for branching logic.'
|
|
),
|
|
shuffleOptions: zod
|
|
.boolean()
|
|
.optional()
|
|
.describe('Whether to randomize the order of choices for each respondent.'),
|
|
hasOpenChoice: zod
|
|
.boolean()
|
|
.optional()
|
|
.describe("Whether the final option should be an open-text choice (for example, 'Other')."),
|
|
branching: zod
|
|
.union([
|
|
zod.union([
|
|
zod.object({
|
|
type: zod
|
|
.enum(['next_question'])
|
|
.describe('\* `next_question` - next_question')
|
|
.describe(
|
|
'Continue to the next question in sequence.\n\n\* `next_question` - next_question'
|
|
),
|
|
}),
|
|
zod.object({
|
|
type: zod
|
|
.enum(['end'])
|
|
.describe('\* `end` - end')
|
|
.describe('End the survey.\n\n\* `end` - end'),
|
|
}),
|
|
zod.object({
|
|
type: zod
|
|
.enum(['specific_question'])
|
|
.describe('\* `specific_question` - specific_question')
|
|
.describe(
|
|
'Jump to a specific question index.\n\n\* `specific_question` - specific_question'
|
|
),
|
|
index: zod
|
|
.number()
|
|
.min(surveysCreateBodyQuestionsItemFourBranchingOneThreeIndexMin)
|
|
.describe('0-based index of the next question.'),
|
|
}),
|
|
zod.object({
|
|
type: zod
|
|
.enum(['response_based'])
|
|
.describe('\* `response_based` - response_based')
|
|
.describe(
|
|
'Branch based on the selected or entered response.\n\n\* `response_based` - response_based'
|
|
),
|
|
responseValues: zod
|
|
.record(
|
|
zod.string(),
|
|
zod.union([
|
|
zod
|
|
.number()
|
|
.min(
|
|
surveysCreateBodyQuestionsItemFourBranchingOneFourResponseValuesOneMin
|
|
),
|
|
zod.enum(['end']),
|
|
])
|
|
)
|
|
.describe(
|
|
"Response-based branching map. Values can be a question index or 'end'."
|
|
),
|
|
}),
|
|
]),
|
|
zod.null(),
|
|
])
|
|
.optional(),
|
|
}),
|
|
zod.object({
|
|
id: zod
|
|
.string()
|
|
.optional()
|
|
.describe(
|
|
'Stable question identifier (UUID). When editing an existing question, send back its current id so its responses (keyed by $survey_response_<id>) stay attached; omit it for new questions and the server generates one.'
|
|
),
|
|
type: zod.enum(['multiple_choice']).describe('\* `multiple_choice` - multiple_choice'),
|
|
question: zod.string().describe('Question text shown to respondents.'),
|
|
description: zod.string().optional().describe('Optional helper text.'),
|
|
descriptionContentType: zod
|
|
.enum(['html', 'text'])
|
|
.describe('\* `html` - html\n\* `text` - text')
|
|
.optional()
|
|
.describe('Format for the description field.\n\n\* `text` - text\n\* `html` - html'),
|
|
optional: zod.boolean().optional().describe('Whether respondents may skip this question.'),
|
|
buttonText: zod.string().optional().describe('Custom button label.'),
|
|
choices: zod
|
|
.array(zod.string())
|
|
.min(surveysCreateBodyQuestionsItemFiveChoicesMin)
|
|
.max(surveysCreateBodyQuestionsItemFiveChoicesMax)
|
|
.describe(
|
|
'Array of choice options. Multiple selections allowed. No branching logic supported.'
|
|
),
|
|
shuffleOptions: zod
|
|
.boolean()
|
|
.optional()
|
|
.describe('Whether to randomize the order of choices for each respondent.'),
|
|
hasOpenChoice: zod
|
|
.boolean()
|
|
.optional()
|
|
.describe("Whether the final option should be an open-text choice (for example, 'Other')."),
|
|
}),
|
|
])
|
|
)
|
|
.nullish()
|
|
.describe(
|
|
'\n The `array` of questions included in the survey. Each question must conform to one of the defined question types: Basic, Link, Rating, or Multiple Choice.\n\n Basic (open-ended question)\n - `id`: The question ID\n - `type`: `open`\n - `question`: The text of the question.\n - `description`: Optional description of the question.\n - `descriptionContentType`: Content type of the description (`html` or `text`).\n - `optional`: Whether the question is optional (`boolean`).\n - `buttonText`: Text displayed on the submit button.\n - `branching`: Branching logic for the question. See branching types below for details.\n\n Link (a question with a link)\n - `id`: The question ID\n - `type`: `link`\n - `question`: The text of the question.\n - `description`: Optional description of the question.\n - `descriptionContentType`: Content type of the description (`html` or `text`).\n - `optional`: Whether the question is optional (`boolean`).\n - `buttonText`: Text displayed on the submit button.\n - `link`: The URL associated with the question.\n - `branching`: Branching logic for the question. See branching types below for details.\n\n Rating (a question with a rating scale)\n - `id`: The question ID\n - `type`: `rating`\n - `question`: The text of the question.\n - `description`: Optional description of the question.\n - `descriptionContentType`: Content type of the description (`html` or `text`).\n - `optional`: Whether the question is optional (`boolean`).\n - `buttonText`: Text displayed on the submit button.\n - `display`: Display style of the rating (`number` or `emoji`).\n - `scale`: The scale of the rating (`number`).\n - `lowerBoundLabel`: Label for the lower bound of the scale.\n - `upperBoundLabel`: Label for the upper bound of the scale.\n - `isNpsQuestion`: Whether the question is an NPS rating.\n - `branching`: Branching logic for the question. See branching types below for details.\n\n Multiple choice\n - `id`: The question ID\n - `type`: `single_choice` or `multiple_choice`\n - `question`: The text of the question.\n - `description`: Optional description of the question.\n - `descriptionContentType`: Content type of the description (`html` or `text`).\n - `optional`: Whether the question is optional (`boolean`).\n - `buttonText`: Text displayed on the submit button.\n - `choices`: An array of choices for the question.\n - `shuffleOptions`: Whether to shuffle the order of the choices (`boolean`).\n - `hasOpenChoice`: Whether the question allows an open-ended response (`boolean`).\n - `branching`: Branching logic for the question. See branching types below for details.\n\n Branching logic can be one of the following types:\n\n Next question: Proceeds to the next question\n ```json\n {\n \"type\": \"next_question\"\n }\n ```\n\n End: Ends the survey, optionally displaying a confirmation message.\n ```json\n {\n \"type\": \"end\"\n }\n ```\n\n Response-based: Branches based on the response values. Available for the `rating` and `single_choice` question types.\n ```json\n {\n \"type\": \"response_based\",\n \"responseValues\": {\n \"responseKey\": \"value\"\n }\n }\n ```\n\n Specific question: Proceeds to a specific question by index.\n ```json\n {\n \"type\": \"specific_question\",\n \"index\": 2\n }\n ```\n\n Translations: Each question can include inline translations.\n - `translations`: Object mapping language codes to translated fields.\n - Language codes: Canonical BCP-47-ish strings (e.g., \"es\", \"es-MX\", \"zh-CN\"). Aliases like \"english\" or \"default\" are rejected. The survey\'s `base_language` (default \"en\") declares the language of the untranslated text and cannot also appear as a translation key.\n - Translatable fields: `question`, `description`, `buttonText`, `choices`, `lowerBoundLabel`, `upperBoundLabel`, `link`\n\n Example with translations:\n ```json\n {\n \"id\": \"uuid\",\n \"type\": \"rating\",\n \"question\": \"How satisfied are you?\",\n \"lowerBoundLabel\": \"Not satisfied\",\n \"upperBoundLabel\": \"Very satisfied\",\n \"translations\": {\n \"es\": {\n \"question\": \"¿Qué tan satisfecho estás?\",\n \"lowerBoundLabel\": \"No satisfecho\",\n \"upperBoundLabel\": \"Muy satisfecho\"\n },\n \"fr\": {\n \"question\": \"Dans quelle mesure êtes-vous satisfait?\"\n }\n }\n }\n ```\n '
|
|
),
|
|
conditions: zod
|
|
.union([
|
|
zod.object({
|
|
url: zod.string().optional(),
|
|
selector: zod.string().optional(),
|
|
seenSurveyWaitPeriodInDays: zod
|
|
.number()
|
|
.min(surveysCreateBodyConditionsOneSeenSurveyWaitPeriodInDaysMin)
|
|
.optional()
|
|
.describe("Don't show this survey to users who saw any survey in the last x days."),
|
|
urlMatchType: zod
|
|
.enum(['regex', 'not_regex', 'exact', 'is_not', 'icontains', 'not_icontains'])
|
|
.describe(
|
|
'\* `regex` - regex\n\* `not_regex` - not_regex\n\* `exact` - exact\n\* `is_not` - is_not\n\* `icontains` - icontains\n\* `not_icontains` - not_icontains'
|
|
)
|
|
.optional()
|
|
.describe(
|
|
"URL\/device matching types: 'regex' (matches regex pattern), 'not_regex' (does not match regex pattern), 'exact' (exact string match), 'is_not' (not exact match), 'icontains' (case-insensitive contains), 'not_icontains' (case-insensitive does not contain).\n\n\* `regex` - regex\n\* `not_regex` - not_regex\n\* `exact` - exact\n\* `is_not` - is_not\n\* `icontains` - icontains\n\* `not_icontains` - not_icontains"
|
|
),
|
|
events: zod
|
|
.object({
|
|
repeatedActivation: zod
|
|
.boolean()
|
|
.optional()
|
|
.describe(
|
|
'Whether to show the survey every time one of the events is triggered (true), or just once (false).'
|
|
),
|
|
values: zod
|
|
.array(
|
|
zod.object({
|
|
name: zod.string().describe('Event name that triggers the survey.'),
|
|
})
|
|
)
|
|
.optional()
|
|
.describe('Array of event names that trigger the survey.'),
|
|
})
|
|
.optional(),
|
|
deviceTypes: zod
|
|
.array(
|
|
zod
|
|
.enum(['Desktop', 'Mobile', 'Tablet'])
|
|
.describe('\* `Desktop` - Desktop\n\* `Mobile` - Mobile\n\* `Tablet` - Tablet')
|
|
)
|
|
.optional()
|
|
.describe('Device types that should match for this survey to be shown.'),
|
|
deviceTypesMatchType: zod
|
|
.enum(['regex', 'not_regex', 'exact', 'is_not', 'icontains', 'not_icontains'])
|
|
.describe(
|
|
'\* `regex` - regex\n\* `not_regex` - not_regex\n\* `exact` - exact\n\* `is_not` - is_not\n\* `icontains` - icontains\n\* `not_icontains` - not_icontains'
|
|
)
|
|
.optional()
|
|
.describe(
|
|
"URL\/device matching types: 'regex' (matches regex pattern), 'not_regex' (does not match regex pattern), 'exact' (exact string match), 'is_not' (not exact match), 'icontains' (case-insensitive contains), 'not_icontains' (case-insensitive does not contain).\n\n\* `regex` - regex\n\* `not_regex` - not_regex\n\* `exact` - exact\n\* `is_not` - is_not\n\* `icontains` - icontains\n\* `not_icontains` - not_icontains"
|
|
),
|
|
linkedFlagVariant: zod
|
|
.string()
|
|
.optional()
|
|
.describe('The variant of the feature flag linked to this survey.'),
|
|
}),
|
|
zod.null(),
|
|
])
|
|
.optional()
|
|
.describe('Display and targeting conditions for the survey.'),
|
|
appearance: zod
|
|
.union([
|
|
zod.object({
|
|
backgroundColor: zod.string().optional(),
|
|
submitButtonColor: zod.string().optional(),
|
|
textColor: zod.string().optional(),
|
|
submitButtonText: zod.string().optional(),
|
|
submitButtonTextColor: zod.string().optional(),
|
|
descriptionTextColor: zod.string().optional(),
|
|
ratingButtonColor: zod.string().optional(),
|
|
ratingButtonActiveColor: zod.string().optional(),
|
|
ratingButtonHoverColor: zod.string().optional(),
|
|
whiteLabel: zod.boolean().optional(),
|
|
autoDisappear: zod.boolean().optional(),
|
|
displayThankYouMessage: zod.boolean().optional(),
|
|
thankYouMessageHeader: zod.string().optional(),
|
|
thankYouMessageDescription: zod.string().optional(),
|
|
thankYouMessageDescriptionContentType: zod
|
|
.enum(['html', 'text'])
|
|
.optional()
|
|
.describe('\* `html` - html\n\* `text` - text'),
|
|
thankYouMessageCloseButtonText: zod.string().optional(),
|
|
borderColor: zod.string().optional(),
|
|
placeholder: zod.string().optional(),
|
|
shuffleQuestions: zod.boolean().optional(),
|
|
surveyPopupDelaySeconds: zod.number().optional(),
|
|
allowGoBack: zod
|
|
.boolean()
|
|
.optional()
|
|
.describe(
|
|
"Whether to show a 'Back' button on web surveys after the first question, letting respondents return to a previously visited question. Defaults to false."
|
|
),
|
|
backButtonText: zod
|
|
.string()
|
|
.optional()
|
|
.describe("Optional override for the back button label. Defaults to 'Back'."),
|
|
widgetType: zod
|
|
.enum(['button', 'tab', 'selector'])
|
|
.optional()
|
|
.describe('\* `button` - button\n\* `tab` - tab\n\* `selector` - selector'),
|
|
widgetSelector: zod.string().optional(),
|
|
widgetLabel: zod.string().optional(),
|
|
widgetColor: zod.string().optional(),
|
|
fontFamily: zod.string().optional(),
|
|
maxWidth: zod.string().optional(),
|
|
zIndex: zod.string().optional(),
|
|
disabledButtonOpacity: zod.string().optional(),
|
|
boxPadding: zod.string().optional(),
|
|
}),
|
|
zod.null(),
|
|
])
|
|
.optional()
|
|
.describe('Survey appearance customization.'),
|
|
start_date: zod.iso
|
|
.datetime({ offset: true })
|
|
.nullish()
|
|
.describe(
|
|
"Setting this will launch the survey immediately. Don't add a start_date unless explicitly requested to do so."
|
|
),
|
|
end_date: zod.iso
|
|
.datetime({ offset: true })
|
|
.nullish()
|
|
.describe('When the survey stopped being shown to users. Setting this will complete the survey.'),
|
|
archived: zod.boolean().optional().describe('Archive state for the survey.'),
|
|
responses_limit: zod
|
|
.number()
|
|
.nullish()
|
|
.describe('The maximum number of responses before automatically stopping the survey.'),
|
|
iteration_count: zod
|
|
.number()
|
|
.min(1)
|
|
.max(surveysCreateBodyIterationCountMax)
|
|
.nullish()
|
|
.describe(
|
|
"For a recurring schedule, this field specifies the number of times the survey should be shown to the user. Use 1 for 'once every X days', higher numbers for multiple repetitions. Works together with iteration_frequency_days to determine the overall survey schedule."
|
|
),
|
|
iteration_frequency_days: zod
|
|
.number()
|
|
.min(1)
|
|
.max(surveysCreateBodyIterationFrequencyDaysMax)
|
|
.nullish()
|
|
.describe(
|
|
'For a recurring schedule, this field specifies the interval in days between each survey instance shown to the user, used alongside iteration_count for precise scheduling.'
|
|
),
|
|
iteration_start_dates: zod.array(zod.iso.datetime({ offset: true }).nullable()).nullish(),
|
|
current_iteration: zod
|
|
.number()
|
|
.min(surveysCreateBodyCurrentIterationMin)
|
|
.max(surveysCreateBodyCurrentIterationMax)
|
|
.nullish(),
|
|
current_iteration_start_date: zod.iso.datetime({ offset: true }).nullish(),
|
|
response_sampling_start_date: zod.iso.datetime({ offset: true }).nullish(),
|
|
response_sampling_interval_type: zod
|
|
.union([
|
|
zod.enum(['day', 'week', 'month']).describe('\* `day` - day\n\* `week` - week\n\* `month` - month'),
|
|
zod.enum(['']),
|
|
zod.null(),
|
|
])
|
|
.optional(),
|
|
response_sampling_interval: zod
|
|
.number()
|
|
.min(surveysCreateBodyResponseSamplingIntervalMin)
|
|
.max(surveysCreateBodyResponseSamplingIntervalMax)
|
|
.nullish(),
|
|
response_sampling_limit: zod
|
|
.number()
|
|
.min(surveysCreateBodyResponseSamplingLimitMin)
|
|
.max(surveysCreateBodyResponseSamplingLimitMax)
|
|
.nullish(),
|
|
response_sampling_daily_limits: zod.unknown().optional(),
|
|
enable_partial_responses: zod
|
|
.boolean()
|
|
.nullish()
|
|
.describe(
|
|
'When at least one question is answered, the response is stored (true). The response is stored when all questions are answered (false).'
|
|
),
|
|
enable_iframe_embedding: zod.boolean().nullish(),
|
|
base_language: zod
|
|
.string()
|
|
.max(surveysCreateBodyBaseLanguageMax)
|
|
.optional()
|
|
.describe(
|
|
"BCP-47 language code (e.g. 'en', 'es', 'es-MX') describing the language of the survey's untranslated text. Defaults to 'en'. Cannot also appear as a key in `translations`."
|
|
),
|
|
translations: zod.unknown().optional(),
|
|
_create_in_folder: zod.string().optional(),
|
|
form_content: zod.unknown().optional(),
|
|
})
|
|
|
|
export const surveysUpdateBodyNameMax = 400
|
|
|
|
export const surveysUpdateBodyResponsesLimitMin = 0
|
|
export const surveysUpdateBodyResponsesLimitMax = 2147483647
|
|
|
|
export const surveysUpdateBodyIterationCountMin = 0
|
|
export const surveysUpdateBodyIterationCountMax = 500
|
|
|
|
export const surveysUpdateBodyIterationFrequencyDaysMin = 0
|
|
export const surveysUpdateBodyIterationFrequencyDaysMax = 2147483647
|
|
|
|
export const surveysUpdateBodyCurrentIterationMin = 0
|
|
export const surveysUpdateBodyCurrentIterationMax = 2147483647
|
|
|
|
export const surveysUpdateBodyResponseSamplingIntervalMin = 0
|
|
export const surveysUpdateBodyResponseSamplingIntervalMax = 2147483647
|
|
|
|
export const surveysUpdateBodyResponseSamplingLimitMin = 0
|
|
export const surveysUpdateBodyResponseSamplingLimitMax = 2147483647
|
|
|
|
export const surveysUpdateBodyBaseLanguageMax = 20
|
|
|
|
export const SurveysUpdateBody = /* @__PURE__ */ zod
|
|
.object({
|
|
name: zod.string().max(surveysUpdateBodyNameMax),
|
|
description: zod.string().optional(),
|
|
type: zod
|
|
.enum(['popover', 'widget', 'external_survey', 'api'])
|
|
.describe(
|
|
'\* `popover` - popover\n\* `widget` - widget\n\* `external_survey` - external survey\n\* `api` - api'
|
|
),
|
|
schedule: zod.string().nullish(),
|
|
linked_flag_id: zod.number().nullish(),
|
|
linked_insight_id: zod.number().nullish(),
|
|
questions: zod
|
|
.unknown()
|
|
.optional()
|
|
.describe(
|
|
'\n The `array` of questions included in the survey. Each question must conform to one of the defined question types: Basic, Link, Rating, or Multiple Choice.\n\n Basic (open-ended question)\n - `id`: The question ID\n - `type`: `open`\n - `question`: The text of the question.\n - `description`: Optional description of the question.\n - `descriptionContentType`: Content type of the description (`html` or `text`).\n - `optional`: Whether the question is optional (`boolean`).\n - `buttonText`: Text displayed on the submit button.\n - `branching`: Branching logic for the question. See branching types below for details.\n\n Link (a question with a link)\n - `id`: The question ID\n - `type`: `link`\n - `question`: The text of the question.\n - `description`: Optional description of the question.\n - `descriptionContentType`: Content type of the description (`html` or `text`).\n - `optional`: Whether the question is optional (`boolean`).\n - `buttonText`: Text displayed on the submit button.\n - `link`: The URL associated with the question.\n - `branching`: Branching logic for the question. See branching types below for details.\n\n Rating (a question with a rating scale)\n - `id`: The question ID\n - `type`: `rating`\n - `question`: The text of the question.\n - `description`: Optional description of the question.\n - `descriptionContentType`: Content type of the description (`html` or `text`).\n - `optional`: Whether the question is optional (`boolean`).\n - `buttonText`: Text displayed on the submit button.\n - `display`: Display style of the rating (`number` or `emoji`).\n - `scale`: The scale of the rating (`number`).\n - `lowerBoundLabel`: Label for the lower bound of the scale.\n - `upperBoundLabel`: Label for the upper bound of the scale.\n - `isNpsQuestion`: Whether the question is an NPS rating.\n - `branching`: Branching logic for the question. See branching types below for details.\n\n Multiple choice\n - `id`: The question ID\n - `type`: `single_choice` or `multiple_choice`\n - `question`: The text of the question.\n - `description`: Optional description of the question.\n - `descriptionContentType`: Content type of the description (`html` or `text`).\n - `optional`: Whether the question is optional (`boolean`).\n - `buttonText`: Text displayed on the submit button.\n - `choices`: An array of choices for the question.\n - `shuffleOptions`: Whether to shuffle the order of the choices (`boolean`).\n - `hasOpenChoice`: Whether the question allows an open-ended response (`boolean`).\n - `branching`: Branching logic for the question. See branching types below for details.\n\n Branching logic can be one of the following types:\n\n Next question: Proceeds to the next question\n ```json\n {\n \"type\": \"next_question\"\n }\n ```\n\n End: Ends the survey, optionally displaying a confirmation message.\n ```json\n {\n \"type\": \"end\"\n }\n ```\n\n Response-based: Branches based on the response values. Available for the `rating` and `single_choice` question types.\n ```json\n {\n \"type\": \"response_based\",\n \"responseValues\": {\n \"responseKey\": \"value\"\n }\n }\n ```\n\n Specific question: Proceeds to a specific question by index.\n ```json\n {\n \"type\": \"specific_question\",\n \"index\": 2\n }\n ```\n\n Translations: Each question can include inline translations.\n - `translations`: Object mapping language codes to translated fields.\n - Language codes: Canonical BCP-47-ish strings (e.g., \"es\", \"es-MX\", \"zh-CN\"). Aliases like \"english\" or \"default\" are rejected. The survey\'s `base_language` (default \"en\") declares the language of the untranslated text and cannot also appear as a translation key.\n - Translatable fields: `question`, `description`, `buttonText`, `choices`, `lowerBoundLabel`, `upperBoundLabel`, `link`\n\n Example with translations:\n ```json\n {\n \"id\": \"uuid\",\n \"type\": \"rating\",\n \"question\": \"How satisfied are you?\",\n \"lowerBoundLabel\": \"Not satisfied\",\n \"upperBoundLabel\": \"Very satisfied\",\n \"translations\": {\n \"es\": {\n \"question\": \"¿Qué tan satisfecho estás?\",\n \"lowerBoundLabel\": \"No satisfecho\",\n \"upperBoundLabel\": \"Muy satisfecho\"\n },\n \"fr\": {\n \"question\": \"Dans quelle mesure êtes-vous satisfait?\"\n }\n }\n }\n ```\n '
|
|
),
|
|
appearance: zod.unknown().optional(),
|
|
start_date: zod.iso.datetime({ offset: true }).nullish(),
|
|
end_date: zod.iso.datetime({ offset: true }).nullish(),
|
|
archived: zod.boolean().optional(),
|
|
responses_limit: zod
|
|
.number()
|
|
.min(surveysUpdateBodyResponsesLimitMin)
|
|
.max(surveysUpdateBodyResponsesLimitMax)
|
|
.nullish(),
|
|
iteration_count: zod
|
|
.number()
|
|
.min(surveysUpdateBodyIterationCountMin)
|
|
.max(surveysUpdateBodyIterationCountMax)
|
|
.nullish(),
|
|
iteration_frequency_days: zod
|
|
.number()
|
|
.min(surveysUpdateBodyIterationFrequencyDaysMin)
|
|
.max(surveysUpdateBodyIterationFrequencyDaysMax)
|
|
.nullish(),
|
|
iteration_start_dates: zod.array(zod.iso.datetime({ offset: true }).nullable()).nullish(),
|
|
current_iteration: zod
|
|
.number()
|
|
.min(surveysUpdateBodyCurrentIterationMin)
|
|
.max(surveysUpdateBodyCurrentIterationMax)
|
|
.nullish(),
|
|
current_iteration_start_date: zod.iso.datetime({ offset: true }).nullish(),
|
|
response_sampling_start_date: zod.iso.datetime({ offset: true }).nullish(),
|
|
response_sampling_interval_type: zod
|
|
.union([
|
|
zod.enum(['day', 'week', 'month']).describe('\* `day` - day\n\* `week` - week\n\* `month` - month'),
|
|
zod.enum(['']),
|
|
zod.null(),
|
|
])
|
|
.optional(),
|
|
response_sampling_interval: zod
|
|
.number()
|
|
.min(surveysUpdateBodyResponseSamplingIntervalMin)
|
|
.max(surveysUpdateBodyResponseSamplingIntervalMax)
|
|
.nullish(),
|
|
response_sampling_limit: zod
|
|
.number()
|
|
.min(surveysUpdateBodyResponseSamplingLimitMin)
|
|
.max(surveysUpdateBodyResponseSamplingLimitMax)
|
|
.nullish(),
|
|
response_sampling_daily_limits: zod.unknown().optional(),
|
|
enable_partial_responses: zod.boolean().nullish(),
|
|
enable_iframe_embedding: zod.boolean().nullish(),
|
|
base_language: zod
|
|
.string()
|
|
.max(surveysUpdateBodyBaseLanguageMax)
|
|
.optional()
|
|
.describe(
|
|
"BCP-47 language code (e.g. 'en', 'es', 'es-MX') describing the language of the survey's untranslated text. Defaults to 'en'. Cannot also appear as a key in `translations`."
|
|
),
|
|
translations: zod.unknown().optional(),
|
|
form_content: zod.unknown().optional(),
|
|
})
|
|
.describe('Mixin for serializers to add user access control fields')
|
|
|
|
export const surveysPartialUpdateBodyNameMax = 400
|
|
|
|
export const surveysPartialUpdateBodyTargetingFlagFiltersOneEarlyExitDefault = false
|
|
export const surveysPartialUpdateBodyQuestionsItemThreeBranchingOneThreeIndexMin = 0
|
|
|
|
export const surveysPartialUpdateBodyQuestionsItemThreeBranchingOneFourResponseValuesOneMin = 0
|
|
|
|
export const surveysPartialUpdateBodyQuestionsItemFourChoicesMin = 2
|
|
export const surveysPartialUpdateBodyQuestionsItemFourChoicesMax = 20
|
|
|
|
export const surveysPartialUpdateBodyQuestionsItemFourBranchingOneThreeIndexMin = 0
|
|
|
|
export const surveysPartialUpdateBodyQuestionsItemFourBranchingOneFourResponseValuesOneMin = 0
|
|
|
|
export const surveysPartialUpdateBodyQuestionsItemFiveChoicesMin = 2
|
|
export const surveysPartialUpdateBodyQuestionsItemFiveChoicesMax = 20
|
|
|
|
export const surveysPartialUpdateBodyConditionsOneSeenSurveyWaitPeriodInDaysMin = 0
|
|
|
|
export const surveysPartialUpdateBodyIterationCountMax = 500
|
|
|
|
export const surveysPartialUpdateBodyIterationFrequencyDaysMax = 365
|
|
|
|
export const surveysPartialUpdateBodyCurrentIterationMin = 0
|
|
export const surveysPartialUpdateBodyCurrentIterationMax = 2147483647
|
|
|
|
export const surveysPartialUpdateBodyResponseSamplingIntervalMin = 0
|
|
export const surveysPartialUpdateBodyResponseSamplingIntervalMax = 2147483647
|
|
|
|
export const surveysPartialUpdateBodyResponseSamplingLimitMin = 0
|
|
export const surveysPartialUpdateBodyResponseSamplingLimitMax = 2147483647
|
|
|
|
export const surveysPartialUpdateBodyBaseLanguageMax = 20
|
|
|
|
export const SurveysPartialUpdateBody = /* @__PURE__ */ zod.object({
|
|
name: zod.string().min(1).max(surveysPartialUpdateBodyNameMax).optional().describe('Survey name.'),
|
|
description: zod.string().optional().describe('Survey description.'),
|
|
type: zod
|
|
.enum(['popover', 'widget', 'external_survey', 'api'])
|
|
.describe(
|
|
'\* `popover` - popover\n\* `widget` - widget\n\* `external_survey` - external survey\n\* `api` - api'
|
|
)
|
|
.optional()
|
|
.describe(
|
|
'Survey type.\n\n\* `popover` - popover\n\* `widget` - widget\n\* `external_survey` - external survey\n\* `api` - api'
|
|
),
|
|
schedule: zod
|
|
.union([
|
|
zod
|
|
.enum(['once', 'recurring', 'always'])
|
|
.describe('\* `once` - once\n\* `recurring` - recurring\n\* `always` - always'),
|
|
zod.null(),
|
|
])
|
|
.optional()
|
|
.describe(
|
|
"Survey scheduling behavior: 'once' = show once per user (default), 'recurring' = repeat based on iteration_count and iteration_frequency_days settings, 'always' = show every time conditions are met (mainly for widget surveys)\n\n\* `once` - once\n\* `recurring` - recurring\n\* `always` - always"
|
|
),
|
|
linked_flag_id: zod.number().nullish().describe('The feature flag linked to this survey.'),
|
|
linked_insight_id: zod.number().nullish(),
|
|
targeting_flag_id: zod.number().optional().describe('An existing targeting flag to use for this survey.'),
|
|
targeting_flag_filters: zod
|
|
.union([
|
|
zod.object({
|
|
groups: zod
|
|
.array(
|
|
zod.object({
|
|
properties: zod
|
|
.array(
|
|
zod.union([
|
|
zod.object({
|
|
key: zod
|
|
.string()
|
|
.describe('Property key used in this feature flag condition.'),
|
|
type: zod
|
|
.enum(['cohort', 'person', 'group'])
|
|
.describe(
|
|
'\* `cohort` - cohort\n\* `person` - person\n\* `group` - group'
|
|
)
|
|
.optional()
|
|
.describe(
|
|
"Property filter type. Common values are 'person' and 'cohort'.\n\n\* `cohort` - cohort\n\* `person` - person\n\* `group` - group"
|
|
),
|
|
cohort_name: zod
|
|
.string()
|
|
.nullish()
|
|
.describe('Resolved cohort name for cohort-type filters.'),
|
|
group_type_index: zod
|
|
.number()
|
|
.nullish()
|
|
.describe('Group type index when using group-based filters.'),
|
|
value: zod
|
|
.unknown()
|
|
.describe(
|
|
'Comparison value for the property filter. Supports strings, numbers, booleans, and arrays.'
|
|
),
|
|
operator: zod
|
|
.enum([
|
|
'exact',
|
|
'is_not',
|
|
'icontains',
|
|
'not_icontains',
|
|
'starts_with',
|
|
'not_starts_with',
|
|
'ends_with',
|
|
'not_ends_with',
|
|
'regex',
|
|
'not_regex',
|
|
'gt',
|
|
'gte',
|
|
'lt',
|
|
'lte',
|
|
])
|
|
.describe(
|
|
'\* `exact` - exact\n\* `is_not` - is_not\n\* `icontains` - icontains\n\* `not_icontains` - not_icontains\n\* `starts_with` - starts_with\n\* `not_starts_with` - not_starts_with\n\* `ends_with` - ends_with\n\* `not_ends_with` - not_ends_with\n\* `regex` - regex\n\* `not_regex` - not_regex\n\* `gt` - gt\n\* `gte` - gte\n\* `lt` - lt\n\* `lte` - lte'
|
|
)
|
|
.describe(
|
|
'Operator used to compare the property value.\n\n\* `exact` - exact\n\* `is_not` - is_not\n\* `icontains` - icontains\n\* `not_icontains` - not_icontains\n\* `starts_with` - starts_with\n\* `not_starts_with` - not_starts_with\n\* `ends_with` - ends_with\n\* `not_ends_with` - not_ends_with\n\* `regex` - regex\n\* `not_regex` - not_regex\n\* `gt` - gt\n\* `gte` - gte\n\* `lt` - lt\n\* `lte` - lte'
|
|
),
|
|
}),
|
|
zod.object({
|
|
key: zod
|
|
.string()
|
|
.describe('Property key used in this feature flag condition.'),
|
|
type: zod
|
|
.enum(['cohort', 'person', 'group'])
|
|
.describe(
|
|
'\* `cohort` - cohort\n\* `person` - person\n\* `group` - group'
|
|
)
|
|
.optional()
|
|
.describe(
|
|
"Property filter type. Common values are 'person' and 'cohort'.\n\n\* `cohort` - cohort\n\* `person` - person\n\* `group` - group"
|
|
),
|
|
cohort_name: zod
|
|
.string()
|
|
.nullish()
|
|
.describe('Resolved cohort name for cohort-type filters.'),
|
|
group_type_index: zod
|
|
.number()
|
|
.nullish()
|
|
.describe('Group type index when using group-based filters.'),
|
|
operator: zod
|
|
.enum(['is_set', 'is_not_set'])
|
|
.describe('\* `is_set` - is_set\n\* `is_not_set` - is_not_set')
|
|
.describe(
|
|
'Existence operator.\n\n\* `is_set` - is_set\n\* `is_not_set` - is_not_set'
|
|
),
|
|
value: zod
|
|
.unknown()
|
|
.optional()
|
|
.describe(
|
|
'Optional value. Runtime behavior determines whether this is ignored.'
|
|
),
|
|
}),
|
|
zod.object({
|
|
key: zod
|
|
.string()
|
|
.describe('Property key used in this feature flag condition.'),
|
|
type: zod
|
|
.enum(['cohort', 'person', 'group'])
|
|
.describe(
|
|
'\* `cohort` - cohort\n\* `person` - person\n\* `group` - group'
|
|
)
|
|
.optional()
|
|
.describe(
|
|
"Property filter type. Common values are 'person' and 'cohort'.\n\n\* `cohort` - cohort\n\* `person` - person\n\* `group` - group"
|
|
),
|
|
cohort_name: zod
|
|
.string()
|
|
.nullish()
|
|
.describe('Resolved cohort name for cohort-type filters.'),
|
|
group_type_index: zod
|
|
.number()
|
|
.nullish()
|
|
.describe('Group type index when using group-based filters.'),
|
|
operator: zod
|
|
.enum(['is_date_exact', 'is_date_before', 'is_date_after'])
|
|
.describe(
|
|
'\* `is_date_exact` - is_date_exact\n\* `is_date_before` - is_date_before\n\* `is_date_after` - is_date_after'
|
|
)
|
|
.describe(
|
|
'Date comparison operator.\n\n\* `is_date_exact` - is_date_exact\n\* `is_date_after` - is_date_after\n\* `is_date_before` - is_date_before'
|
|
),
|
|
value: zod
|
|
.string()
|
|
.describe('Date value in ISO format or relative date expression.'),
|
|
}),
|
|
zod.object({
|
|
key: zod
|
|
.string()
|
|
.describe('Property key used in this feature flag condition.'),
|
|
type: zod
|
|
.enum(['cohort', 'person', 'group'])
|
|
.describe(
|
|
'\* `cohort` - cohort\n\* `person` - person\n\* `group` - group'
|
|
)
|
|
.optional()
|
|
.describe(
|
|
"Property filter type. Common values are 'person' and 'cohort'.\n\n\* `cohort` - cohort\n\* `person` - person\n\* `group` - group"
|
|
),
|
|
cohort_name: zod
|
|
.string()
|
|
.nullish()
|
|
.describe('Resolved cohort name for cohort-type filters.'),
|
|
group_type_index: zod
|
|
.number()
|
|
.nullish()
|
|
.describe('Group type index when using group-based filters.'),
|
|
operator: zod
|
|
.enum([
|
|
'semver_gt',
|
|
'semver_gte',
|
|
'semver_lt',
|
|
'semver_lte',
|
|
'semver_eq',
|
|
'semver_neq',
|
|
'semver_tilde',
|
|
'semver_caret',
|
|
'semver_wildcard',
|
|
])
|
|
.describe(
|
|
'\* `semver_gt` - semver_gt\n\* `semver_gte` - semver_gte\n\* `semver_lt` - semver_lt\n\* `semver_lte` - semver_lte\n\* `semver_eq` - semver_eq\n\* `semver_neq` - semver_neq\n\* `semver_tilde` - semver_tilde\n\* `semver_caret` - semver_caret\n\* `semver_wildcard` - semver_wildcard'
|
|
)
|
|
.describe(
|
|
'Semantic version comparison operator.\n\n\* `semver_gt` - semver_gt\n\* `semver_gte` - semver_gte\n\* `semver_lt` - semver_lt\n\* `semver_lte` - semver_lte\n\* `semver_eq` - semver_eq\n\* `semver_neq` - semver_neq\n\* `semver_tilde` - semver_tilde\n\* `semver_caret` - semver_caret\n\* `semver_wildcard` - semver_wildcard'
|
|
),
|
|
value: zod.string().describe('Semantic version string.'),
|
|
}),
|
|
zod.object({
|
|
key: zod
|
|
.string()
|
|
.describe('Property key used in this feature flag condition.'),
|
|
type: zod
|
|
.enum(['cohort', 'person', 'group'])
|
|
.describe(
|
|
'\* `cohort` - cohort\n\* `person` - person\n\* `group` - group'
|
|
)
|
|
.optional()
|
|
.describe(
|
|
"Property filter type. Common values are 'person' and 'cohort'.\n\n\* `cohort` - cohort\n\* `person` - person\n\* `group` - group"
|
|
),
|
|
cohort_name: zod
|
|
.string()
|
|
.nullish()
|
|
.describe('Resolved cohort name for cohort-type filters.'),
|
|
group_type_index: zod
|
|
.number()
|
|
.nullish()
|
|
.describe('Group type index when using group-based filters.'),
|
|
operator: zod
|
|
.enum(['icontains_multi', 'not_icontains_multi'])
|
|
.describe(
|
|
'\* `icontains_multi` - icontains_multi\n\* `not_icontains_multi` - not_icontains_multi'
|
|
)
|
|
.describe(
|
|
'Multi-contains operator.\n\n\* `icontains_multi` - icontains_multi\n\* `not_icontains_multi` - not_icontains_multi'
|
|
),
|
|
value: zod
|
|
.array(zod.string())
|
|
.describe('List of strings to evaluate against.'),
|
|
}),
|
|
zod.object({
|
|
key: zod
|
|
.string()
|
|
.describe('Property key used in this feature flag condition.'),
|
|
type: zod
|
|
.enum(['cohort'])
|
|
.describe('\* `cohort` - cohort')
|
|
.describe(
|
|
'Cohort property type required for in\/not_in operators.\n\n\* `cohort` - cohort'
|
|
),
|
|
cohort_name: zod
|
|
.string()
|
|
.nullish()
|
|
.describe('Resolved cohort name for cohort-type filters.'),
|
|
group_type_index: zod
|
|
.number()
|
|
.nullish()
|
|
.describe('Group type index when using group-based filters.'),
|
|
operator: zod
|
|
.enum(['in', 'not_in'])
|
|
.describe('\* `in` - in\n\* `not_in` - not_in')
|
|
.describe(
|
|
'Membership operator for cohort properties.\n\n\* `in` - in\n\* `not_in` - not_in'
|
|
),
|
|
value: zod
|
|
.unknown()
|
|
.describe(
|
|
'Cohort comparison value (single or list, depending on usage).'
|
|
),
|
|
}),
|
|
zod.object({
|
|
key: zod
|
|
.string()
|
|
.describe('Property key used in this feature flag condition.'),
|
|
type: zod
|
|
.enum(['flag'])
|
|
.describe('\* `flag` - flag')
|
|
.describe(
|
|
'Flag property type required for flag dependency checks.\n\n\* `flag` - flag'
|
|
),
|
|
cohort_name: zod
|
|
.string()
|
|
.nullish()
|
|
.describe('Resolved cohort name for cohort-type filters.'),
|
|
group_type_index: zod
|
|
.number()
|
|
.nullish()
|
|
.describe('Group type index when using group-based filters.'),
|
|
operator: zod
|
|
.enum(['flag_evaluates_to'])
|
|
.describe('\* `flag_evaluates_to` - flag_evaluates_to')
|
|
.describe(
|
|
'Operator for feature flag dependency evaluation.\n\n\* `flag_evaluates_to` - flag_evaluates_to'
|
|
),
|
|
value: zod.unknown().describe('Value to compare flag evaluation against.'),
|
|
}),
|
|
])
|
|
)
|
|
.optional()
|
|
.describe('Property conditions for this release condition group.'),
|
|
rollout_percentage: zod
|
|
.number()
|
|
.optional()
|
|
.describe('Rollout percentage for this release condition group.'),
|
|
variant: zod.string().nullish().describe('Variant key override for multivariate flags.'),
|
|
aggregation_group_type_index: zod
|
|
.number()
|
|
.nullish()
|
|
.describe(
|
|
'Group type index for this condition set. None means person-level aggregation.'
|
|
),
|
|
})
|
|
)
|
|
.optional()
|
|
.describe('Release condition groups for the feature flag.'),
|
|
multivariate: zod
|
|
.union([
|
|
zod.object({
|
|
variants: zod
|
|
.array(
|
|
zod.object({
|
|
key: zod.string().describe('Unique key for this variant.'),
|
|
name: zod.string().optional().describe('Human-readable name for this variant.'),
|
|
rollout_percentage: zod.number().describe('Variant rollout percentage.'),
|
|
})
|
|
)
|
|
.describe('Variant definitions for multivariate feature flags.'),
|
|
}),
|
|
zod.null(),
|
|
])
|
|
.optional()
|
|
.describe('Multivariate configuration for variant-based rollouts.'),
|
|
aggregation_group_type_index: zod
|
|
.number()
|
|
.nullish()
|
|
.describe('Group type index for group-based feature flags.'),
|
|
payloads: zod
|
|
.record(zod.string(), zod.string())
|
|
.optional()
|
|
.describe('Optional payload values keyed by variant key.'),
|
|
feature_enrollment: zod
|
|
.boolean()
|
|
.nullish()
|
|
.describe(
|
|
'Whether this flag has early access feature enrollment enabled. When true, the flag is evaluated against the person property $feature_enrollment\/{flag_key}.'
|
|
),
|
|
early_exit: zod
|
|
.boolean()
|
|
.default(surveysPartialUpdateBodyTargetingFlagFiltersOneEarlyExitDefault)
|
|
.describe(
|
|
'When true, condition evaluation stops at the first matching condition set rather than continuing to evaluate subsequent groups.'
|
|
),
|
|
}),
|
|
zod.null(),
|
|
])
|
|
.optional()
|
|
.describe(
|
|
"Target specific users based on their properties. Example: {groups: [{properties: [{key: 'email', value: ['@company.com'], operator: 'icontains'}], rollout_percentage: 100}]}"
|
|
),
|
|
remove_targeting_flag: zod
|
|
.boolean()
|
|
.nullish()
|
|
.describe(
|
|
'Set to true to completely remove all targeting filters from the survey, making it visible to all users (subject to other display conditions like URL matching).'
|
|
),
|
|
questions: zod
|
|
.array(
|
|
zod.union([
|
|
zod.object({
|
|
id: zod
|
|
.string()
|
|
.optional()
|
|
.describe(
|
|
'Stable question identifier (UUID). When editing an existing question, send back its current id so its responses (keyed by $survey_response_<id>) stay attached; omit it for new questions and the server generates one.'
|
|
),
|
|
type: zod.enum(['open']).describe('\* `open` - open'),
|
|
question: zod.string().describe('Question text shown to respondents.'),
|
|
description: zod.string().optional().describe('Optional helper text.'),
|
|
descriptionContentType: zod
|
|
.enum(['html', 'text'])
|
|
.describe('\* `html` - html\n\* `text` - text')
|
|
.optional()
|
|
.describe('Format for the description field.\n\n\* `text` - text\n\* `html` - html'),
|
|
optional: zod.boolean().optional().describe('Whether respondents may skip this question.'),
|
|
buttonText: zod.string().optional().describe('Custom button label.'),
|
|
}),
|
|
zod.object({
|
|
id: zod
|
|
.string()
|
|
.optional()
|
|
.describe(
|
|
'Stable question identifier (UUID). When editing an existing question, send back its current id so its responses (keyed by $survey_response_<id>) stay attached; omit it for new questions and the server generates one.'
|
|
),
|
|
type: zod.enum(['link']).describe('\* `link` - link'),
|
|
question: zod.string().describe('Question text shown to respondents.'),
|
|
description: zod.string().optional().describe('Optional helper text.'),
|
|
descriptionContentType: zod
|
|
.enum(['html', 'text'])
|
|
.describe('\* `html` - html\n\* `text` - text')
|
|
.optional()
|
|
.describe('Format for the description field.\n\n\* `text` - text\n\* `html` - html'),
|
|
optional: zod.boolean().optional().describe('Whether respondents may skip this question.'),
|
|
buttonText: zod.string().optional().describe('Custom button label.'),
|
|
link: zod.string().describe('HTTPS or mailto URL for link questions.'),
|
|
}),
|
|
zod.object({
|
|
id: zod
|
|
.string()
|
|
.optional()
|
|
.describe(
|
|
'Stable question identifier (UUID). When editing an existing question, send back its current id so its responses (keyed by $survey_response_<id>) stay attached; omit it for new questions and the server generates one.'
|
|
),
|
|
type: zod.enum(['rating']).describe('\* `rating` - rating'),
|
|
question: zod.string().describe('Question text shown to respondents.'),
|
|
description: zod.string().optional().describe('Optional helper text.'),
|
|
descriptionContentType: zod
|
|
.enum(['html', 'text'])
|
|
.describe('\* `html` - html\n\* `text` - text')
|
|
.optional()
|
|
.describe('Format for the description field.\n\n\* `text` - text\n\* `html` - html'),
|
|
optional: zod.boolean().optional().describe('Whether respondents may skip this question.'),
|
|
buttonText: zod.string().optional().describe('Custom button label.'),
|
|
display: zod
|
|
.enum(['number', 'emoji'])
|
|
.describe('\* `number` - number\n\* `emoji` - emoji')
|
|
.optional()
|
|
.describe(
|
|
"Display format: 'number' shows numeric scale, 'emoji' shows emoji scale.\n\n\* `number` - number\n\* `emoji` - emoji"
|
|
),
|
|
scale: zod.number().min(1).optional().describe('Rating scale can be one of 3, 5, or 7'),
|
|
lowerBoundLabel: zod
|
|
.string()
|
|
.optional()
|
|
.describe("Label for the lowest rating (e.g., 'Very Poor')"),
|
|
upperBoundLabel: zod
|
|
.string()
|
|
.optional()
|
|
.describe("Label for the highest rating (e.g., 'Excellent')"),
|
|
branching: zod
|
|
.union([
|
|
zod.union([
|
|
zod.object({
|
|
type: zod
|
|
.enum(['next_question'])
|
|
.describe('\* `next_question` - next_question')
|
|
.describe(
|
|
'Continue to the next question in sequence.\n\n\* `next_question` - next_question'
|
|
),
|
|
}),
|
|
zod.object({
|
|
type: zod
|
|
.enum(['end'])
|
|
.describe('\* `end` - end')
|
|
.describe('End the survey.\n\n\* `end` - end'),
|
|
}),
|
|
zod.object({
|
|
type: zod
|
|
.enum(['specific_question'])
|
|
.describe('\* `specific_question` - specific_question')
|
|
.describe(
|
|
'Jump to a specific question index.\n\n\* `specific_question` - specific_question'
|
|
),
|
|
index: zod
|
|
.number()
|
|
.min(surveysPartialUpdateBodyQuestionsItemThreeBranchingOneThreeIndexMin)
|
|
.describe('0-based index of the next question.'),
|
|
}),
|
|
zod.object({
|
|
type: zod
|
|
.enum(['response_based'])
|
|
.describe('\* `response_based` - response_based')
|
|
.describe(
|
|
'Branch based on the selected or entered response.\n\n\* `response_based` - response_based'
|
|
),
|
|
responseValues: zod
|
|
.record(
|
|
zod.string(),
|
|
zod.union([
|
|
zod
|
|
.number()
|
|
.min(
|
|
surveysPartialUpdateBodyQuestionsItemThreeBranchingOneFourResponseValuesOneMin
|
|
),
|
|
zod.enum(['end']),
|
|
])
|
|
)
|
|
.describe(
|
|
"Response-based branching map. Values can be a question index or 'end'."
|
|
),
|
|
}),
|
|
]),
|
|
zod.null(),
|
|
])
|
|
.optional(),
|
|
}),
|
|
zod.object({
|
|
id: zod
|
|
.string()
|
|
.optional()
|
|
.describe(
|
|
'Stable question identifier (UUID). When editing an existing question, send back its current id so its responses (keyed by $survey_response_<id>) stay attached; omit it for new questions and the server generates one.'
|
|
),
|
|
type: zod.enum(['single_choice']).describe('\* `single_choice` - single_choice'),
|
|
question: zod.string().describe('Question text shown to respondents.'),
|
|
description: zod.string().optional().describe('Optional helper text.'),
|
|
descriptionContentType: zod
|
|
.enum(['html', 'text'])
|
|
.describe('\* `html` - html\n\* `text` - text')
|
|
.optional()
|
|
.describe('Format for the description field.\n\n\* `text` - text\n\* `html` - html'),
|
|
optional: zod.boolean().optional().describe('Whether respondents may skip this question.'),
|
|
buttonText: zod.string().optional().describe('Custom button label.'),
|
|
choices: zod
|
|
.array(zod.string())
|
|
.min(surveysPartialUpdateBodyQuestionsItemFourChoicesMin)
|
|
.max(surveysPartialUpdateBodyQuestionsItemFourChoicesMax)
|
|
.describe(
|
|
'Array of choice options. Choice indices (0, 1, 2, ...) are used for branching logic.'
|
|
),
|
|
shuffleOptions: zod
|
|
.boolean()
|
|
.optional()
|
|
.describe('Whether to randomize the order of choices for each respondent.'),
|
|
hasOpenChoice: zod
|
|
.boolean()
|
|
.optional()
|
|
.describe("Whether the final option should be an open-text choice (for example, 'Other')."),
|
|
branching: zod
|
|
.union([
|
|
zod.union([
|
|
zod.object({
|
|
type: zod
|
|
.enum(['next_question'])
|
|
.describe('\* `next_question` - next_question')
|
|
.describe(
|
|
'Continue to the next question in sequence.\n\n\* `next_question` - next_question'
|
|
),
|
|
}),
|
|
zod.object({
|
|
type: zod
|
|
.enum(['end'])
|
|
.describe('\* `end` - end')
|
|
.describe('End the survey.\n\n\* `end` - end'),
|
|
}),
|
|
zod.object({
|
|
type: zod
|
|
.enum(['specific_question'])
|
|
.describe('\* `specific_question` - specific_question')
|
|
.describe(
|
|
'Jump to a specific question index.\n\n\* `specific_question` - specific_question'
|
|
),
|
|
index: zod
|
|
.number()
|
|
.min(surveysPartialUpdateBodyQuestionsItemFourBranchingOneThreeIndexMin)
|
|
.describe('0-based index of the next question.'),
|
|
}),
|
|
zod.object({
|
|
type: zod
|
|
.enum(['response_based'])
|
|
.describe('\* `response_based` - response_based')
|
|
.describe(
|
|
'Branch based on the selected or entered response.\n\n\* `response_based` - response_based'
|
|
),
|
|
responseValues: zod
|
|
.record(
|
|
zod.string(),
|
|
zod.union([
|
|
zod
|
|
.number()
|
|
.min(
|
|
surveysPartialUpdateBodyQuestionsItemFourBranchingOneFourResponseValuesOneMin
|
|
),
|
|
zod.enum(['end']),
|
|
])
|
|
)
|
|
.describe(
|
|
"Response-based branching map. Values can be a question index or 'end'."
|
|
),
|
|
}),
|
|
]),
|
|
zod.null(),
|
|
])
|
|
.optional(),
|
|
}),
|
|
zod.object({
|
|
id: zod
|
|
.string()
|
|
.optional()
|
|
.describe(
|
|
'Stable question identifier (UUID). When editing an existing question, send back its current id so its responses (keyed by $survey_response_<id>) stay attached; omit it for new questions and the server generates one.'
|
|
),
|
|
type: zod.enum(['multiple_choice']).describe('\* `multiple_choice` - multiple_choice'),
|
|
question: zod.string().describe('Question text shown to respondents.'),
|
|
description: zod.string().optional().describe('Optional helper text.'),
|
|
descriptionContentType: zod
|
|
.enum(['html', 'text'])
|
|
.describe('\* `html` - html\n\* `text` - text')
|
|
.optional()
|
|
.describe('Format for the description field.\n\n\* `text` - text\n\* `html` - html'),
|
|
optional: zod.boolean().optional().describe('Whether respondents may skip this question.'),
|
|
buttonText: zod.string().optional().describe('Custom button label.'),
|
|
choices: zod
|
|
.array(zod.string())
|
|
.min(surveysPartialUpdateBodyQuestionsItemFiveChoicesMin)
|
|
.max(surveysPartialUpdateBodyQuestionsItemFiveChoicesMax)
|
|
.describe(
|
|
'Array of choice options. Multiple selections allowed. No branching logic supported.'
|
|
),
|
|
shuffleOptions: zod
|
|
.boolean()
|
|
.optional()
|
|
.describe('Whether to randomize the order of choices for each respondent.'),
|
|
hasOpenChoice: zod
|
|
.boolean()
|
|
.optional()
|
|
.describe("Whether the final option should be an open-text choice (for example, 'Other')."),
|
|
}),
|
|
])
|
|
)
|
|
.nullish()
|
|
.describe(
|
|
'\n The `array` of questions included in the survey. Each question must conform to one of the defined question types: Basic, Link, Rating, or Multiple Choice.\n\n Basic (open-ended question)\n - `id`: The question ID\n - `type`: `open`\n - `question`: The text of the question.\n - `description`: Optional description of the question.\n - `descriptionContentType`: Content type of the description (`html` or `text`).\n - `optional`: Whether the question is optional (`boolean`).\n - `buttonText`: Text displayed on the submit button.\n - `branching`: Branching logic for the question. See branching types below for details.\n\n Link (a question with a link)\n - `id`: The question ID\n - `type`: `link`\n - `question`: The text of the question.\n - `description`: Optional description of the question.\n - `descriptionContentType`: Content type of the description (`html` or `text`).\n - `optional`: Whether the question is optional (`boolean`).\n - `buttonText`: Text displayed on the submit button.\n - `link`: The URL associated with the question.\n - `branching`: Branching logic for the question. See branching types below for details.\n\n Rating (a question with a rating scale)\n - `id`: The question ID\n - `type`: `rating`\n - `question`: The text of the question.\n - `description`: Optional description of the question.\n - `descriptionContentType`: Content type of the description (`html` or `text`).\n - `optional`: Whether the question is optional (`boolean`).\n - `buttonText`: Text displayed on the submit button.\n - `display`: Display style of the rating (`number` or `emoji`).\n - `scale`: The scale of the rating (`number`).\n - `lowerBoundLabel`: Label for the lower bound of the scale.\n - `upperBoundLabel`: Label for the upper bound of the scale.\n - `isNpsQuestion`: Whether the question is an NPS rating.\n - `branching`: Branching logic for the question. See branching types below for details.\n\n Multiple choice\n - `id`: The question ID\n - `type`: `single_choice` or `multiple_choice`\n - `question`: The text of the question.\n - `description`: Optional description of the question.\n - `descriptionContentType`: Content type of the description (`html` or `text`).\n - `optional`: Whether the question is optional (`boolean`).\n - `buttonText`: Text displayed on the submit button.\n - `choices`: An array of choices for the question.\n - `shuffleOptions`: Whether to shuffle the order of the choices (`boolean`).\n - `hasOpenChoice`: Whether the question allows an open-ended response (`boolean`).\n - `branching`: Branching logic for the question. See branching types below for details.\n\n Branching logic can be one of the following types:\n\n Next question: Proceeds to the next question\n ```json\n {\n \"type\": \"next_question\"\n }\n ```\n\n End: Ends the survey, optionally displaying a confirmation message.\n ```json\n {\n \"type\": \"end\"\n }\n ```\n\n Response-based: Branches based on the response values. Available for the `rating` and `single_choice` question types.\n ```json\n {\n \"type\": \"response_based\",\n \"responseValues\": {\n \"responseKey\": \"value\"\n }\n }\n ```\n\n Specific question: Proceeds to a specific question by index.\n ```json\n {\n \"type\": \"specific_question\",\n \"index\": 2\n }\n ```\n\n Translations: Each question can include inline translations.\n - `translations`: Object mapping language codes to translated fields.\n - Language codes: Canonical BCP-47-ish strings (e.g., \"es\", \"es-MX\", \"zh-CN\"). Aliases like \"english\" or \"default\" are rejected. The survey\'s `base_language` (default \"en\") declares the language of the untranslated text and cannot also appear as a translation key.\n - Translatable fields: `question`, `description`, `buttonText`, `choices`, `lowerBoundLabel`, `upperBoundLabel`, `link`\n\n Example with translations:\n ```json\n {\n \"id\": \"uuid\",\n \"type\": \"rating\",\n \"question\": \"How satisfied are you?\",\n \"lowerBoundLabel\": \"Not satisfied\",\n \"upperBoundLabel\": \"Very satisfied\",\n \"translations\": {\n \"es\": {\n \"question\": \"¿Qué tan satisfecho estás?\",\n \"lowerBoundLabel\": \"No satisfecho\",\n \"upperBoundLabel\": \"Muy satisfecho\"\n },\n \"fr\": {\n \"question\": \"Dans quelle mesure êtes-vous satisfait?\"\n }\n }\n }\n ```\n '
|
|
),
|
|
conditions: zod
|
|
.union([
|
|
zod.object({
|
|
url: zod.string().optional(),
|
|
selector: zod.string().optional(),
|
|
seenSurveyWaitPeriodInDays: zod
|
|
.number()
|
|
.min(surveysPartialUpdateBodyConditionsOneSeenSurveyWaitPeriodInDaysMin)
|
|
.optional()
|
|
.describe("Don't show this survey to users who saw any survey in the last x days."),
|
|
urlMatchType: zod
|
|
.enum(['regex', 'not_regex', 'exact', 'is_not', 'icontains', 'not_icontains'])
|
|
.describe(
|
|
'\* `regex` - regex\n\* `not_regex` - not_regex\n\* `exact` - exact\n\* `is_not` - is_not\n\* `icontains` - icontains\n\* `not_icontains` - not_icontains'
|
|
)
|
|
.optional()
|
|
.describe(
|
|
"URL\/device matching types: 'regex' (matches regex pattern), 'not_regex' (does not match regex pattern), 'exact' (exact string match), 'is_not' (not exact match), 'icontains' (case-insensitive contains), 'not_icontains' (case-insensitive does not contain).\n\n\* `regex` - regex\n\* `not_regex` - not_regex\n\* `exact` - exact\n\* `is_not` - is_not\n\* `icontains` - icontains\n\* `not_icontains` - not_icontains"
|
|
),
|
|
events: zod
|
|
.object({
|
|
repeatedActivation: zod
|
|
.boolean()
|
|
.optional()
|
|
.describe(
|
|
'Whether to show the survey every time one of the events is triggered (true), or just once (false).'
|
|
),
|
|
values: zod
|
|
.array(
|
|
zod.object({
|
|
name: zod.string().describe('Event name that triggers the survey.'),
|
|
})
|
|
)
|
|
.optional()
|
|
.describe('Array of event names that trigger the survey.'),
|
|
})
|
|
.optional(),
|
|
deviceTypes: zod
|
|
.array(
|
|
zod
|
|
.enum(['Desktop', 'Mobile', 'Tablet'])
|
|
.describe('\* `Desktop` - Desktop\n\* `Mobile` - Mobile\n\* `Tablet` - Tablet')
|
|
)
|
|
.optional()
|
|
.describe('Device types that should match for this survey to be shown.'),
|
|
deviceTypesMatchType: zod
|
|
.enum(['regex', 'not_regex', 'exact', 'is_not', 'icontains', 'not_icontains'])
|
|
.describe(
|
|
'\* `regex` - regex\n\* `not_regex` - not_regex\n\* `exact` - exact\n\* `is_not` - is_not\n\* `icontains` - icontains\n\* `not_icontains` - not_icontains'
|
|
)
|
|
.optional()
|
|
.describe(
|
|
"URL\/device matching types: 'regex' (matches regex pattern), 'not_regex' (does not match regex pattern), 'exact' (exact string match), 'is_not' (not exact match), 'icontains' (case-insensitive contains), 'not_icontains' (case-insensitive does not contain).\n\n\* `regex` - regex\n\* `not_regex` - not_regex\n\* `exact` - exact\n\* `is_not` - is_not\n\* `icontains` - icontains\n\* `not_icontains` - not_icontains"
|
|
),
|
|
linkedFlagVariant: zod
|
|
.string()
|
|
.optional()
|
|
.describe('The variant of the feature flag linked to this survey.'),
|
|
}),
|
|
zod.null(),
|
|
])
|
|
.optional()
|
|
.describe('Display and targeting conditions for the survey.'),
|
|
appearance: zod
|
|
.union([
|
|
zod.object({
|
|
backgroundColor: zod.string().optional(),
|
|
submitButtonColor: zod.string().optional(),
|
|
textColor: zod.string().optional(),
|
|
submitButtonText: zod.string().optional(),
|
|
submitButtonTextColor: zod.string().optional(),
|
|
descriptionTextColor: zod.string().optional(),
|
|
ratingButtonColor: zod.string().optional(),
|
|
ratingButtonActiveColor: zod.string().optional(),
|
|
ratingButtonHoverColor: zod.string().optional(),
|
|
whiteLabel: zod.boolean().optional(),
|
|
autoDisappear: zod.boolean().optional(),
|
|
displayThankYouMessage: zod.boolean().optional(),
|
|
thankYouMessageHeader: zod.string().optional(),
|
|
thankYouMessageDescription: zod.string().optional(),
|
|
thankYouMessageDescriptionContentType: zod
|
|
.enum(['html', 'text'])
|
|
.optional()
|
|
.describe('\* `html` - html\n\* `text` - text'),
|
|
thankYouMessageCloseButtonText: zod.string().optional(),
|
|
borderColor: zod.string().optional(),
|
|
placeholder: zod.string().optional(),
|
|
shuffleQuestions: zod.boolean().optional(),
|
|
surveyPopupDelaySeconds: zod.number().optional(),
|
|
allowGoBack: zod
|
|
.boolean()
|
|
.optional()
|
|
.describe(
|
|
"Whether to show a 'Back' button on web surveys after the first question, letting respondents return to a previously visited question. Defaults to false."
|
|
),
|
|
backButtonText: zod
|
|
.string()
|
|
.optional()
|
|
.describe("Optional override for the back button label. Defaults to 'Back'."),
|
|
widgetType: zod
|
|
.enum(['button', 'tab', 'selector'])
|
|
.optional()
|
|
.describe('\* `button` - button\n\* `tab` - tab\n\* `selector` - selector'),
|
|
widgetSelector: zod.string().optional(),
|
|
widgetLabel: zod.string().optional(),
|
|
widgetColor: zod.string().optional(),
|
|
fontFamily: zod.string().optional(),
|
|
maxWidth: zod.string().optional(),
|
|
zIndex: zod.string().optional(),
|
|
disabledButtonOpacity: zod.string().optional(),
|
|
boxPadding: zod.string().optional(),
|
|
}),
|
|
zod.null(),
|
|
])
|
|
.optional()
|
|
.describe('Survey appearance customization.'),
|
|
start_date: zod.iso
|
|
.datetime({ offset: true })
|
|
.nullish()
|
|
.describe(
|
|
"Setting this will launch the survey immediately. Don't add a start_date unless explicitly requested to do so."
|
|
),
|
|
end_date: zod.iso
|
|
.datetime({ offset: true })
|
|
.nullish()
|
|
.describe('When the survey stopped being shown to users. Setting this will complete the survey.'),
|
|
archived: zod.boolean().optional().describe('Archive state for the survey.'),
|
|
responses_limit: zod
|
|
.number()
|
|
.nullish()
|
|
.describe('The maximum number of responses before automatically stopping the survey.'),
|
|
iteration_count: zod
|
|
.number()
|
|
.min(1)
|
|
.max(surveysPartialUpdateBodyIterationCountMax)
|
|
.nullish()
|
|
.describe(
|
|
"For a recurring schedule, this field specifies the number of times the survey should be shown to the user. Use 1 for 'once every X days', higher numbers for multiple repetitions. Works together with iteration_frequency_days to determine the overall survey schedule."
|
|
),
|
|
iteration_frequency_days: zod
|
|
.number()
|
|
.min(1)
|
|
.max(surveysPartialUpdateBodyIterationFrequencyDaysMax)
|
|
.nullish()
|
|
.describe(
|
|
'For a recurring schedule, this field specifies the interval in days between each survey instance shown to the user, used alongside iteration_count for precise scheduling.'
|
|
),
|
|
iteration_start_dates: zod.array(zod.iso.datetime({ offset: true }).nullable()).nullish(),
|
|
current_iteration: zod
|
|
.number()
|
|
.min(surveysPartialUpdateBodyCurrentIterationMin)
|
|
.max(surveysPartialUpdateBodyCurrentIterationMax)
|
|
.nullish(),
|
|
current_iteration_start_date: zod.iso.datetime({ offset: true }).nullish(),
|
|
response_sampling_start_date: zod.iso.datetime({ offset: true }).nullish(),
|
|
response_sampling_interval_type: zod
|
|
.union([
|
|
zod.enum(['day', 'week', 'month']).describe('\* `day` - day\n\* `week` - week\n\* `month` - month'),
|
|
zod.enum(['']),
|
|
zod.null(),
|
|
])
|
|
.optional(),
|
|
response_sampling_interval: zod
|
|
.number()
|
|
.min(surveysPartialUpdateBodyResponseSamplingIntervalMin)
|
|
.max(surveysPartialUpdateBodyResponseSamplingIntervalMax)
|
|
.nullish(),
|
|
response_sampling_limit: zod
|
|
.number()
|
|
.min(surveysPartialUpdateBodyResponseSamplingLimitMin)
|
|
.max(surveysPartialUpdateBodyResponseSamplingLimitMax)
|
|
.nullish(),
|
|
response_sampling_daily_limits: zod.unknown().optional(),
|
|
enable_partial_responses: zod
|
|
.boolean()
|
|
.nullish()
|
|
.describe(
|
|
'When at least one question is answered, the response is stored (true). The response is stored when all questions are answered (false).'
|
|
),
|
|
enable_iframe_embedding: zod.boolean().nullish(),
|
|
base_language: zod
|
|
.string()
|
|
.max(surveysPartialUpdateBodyBaseLanguageMax)
|
|
.optional()
|
|
.describe(
|
|
"BCP-47 language code (e.g. 'en', 'es', 'es-MX') describing the language of the survey's untranslated text. Defaults to 'en'. Cannot also appear as a key in `translations`."
|
|
),
|
|
translations: zod.unknown().optional(),
|
|
_create_in_folder: zod.string().optional(),
|
|
form_content: zod.unknown().optional(),
|
|
})
|
|
|
|
/**
|
|
* Duplicate a survey to multiple projects in a single transaction.
|
|
*
|
|
* Accepts a list of target team IDs and creates a copy of the survey in each project.
|
|
* Uses an all-or-nothing approach - if any duplication fails, all changes are rolled back.
|
|
*/
|
|
export const surveysDuplicateToProjectsCreateBodyNameMax = 400
|
|
|
|
export const surveysDuplicateToProjectsCreateBodyResponsesLimitMin = 0
|
|
export const surveysDuplicateToProjectsCreateBodyResponsesLimitMax = 2147483647
|
|
|
|
export const surveysDuplicateToProjectsCreateBodyIterationCountMin = 0
|
|
export const surveysDuplicateToProjectsCreateBodyIterationCountMax = 500
|
|
|
|
export const surveysDuplicateToProjectsCreateBodyIterationFrequencyDaysMin = 0
|
|
export const surveysDuplicateToProjectsCreateBodyIterationFrequencyDaysMax = 2147483647
|
|
|
|
export const surveysDuplicateToProjectsCreateBodyCurrentIterationMin = 0
|
|
export const surveysDuplicateToProjectsCreateBodyCurrentIterationMax = 2147483647
|
|
|
|
export const surveysDuplicateToProjectsCreateBodyResponseSamplingIntervalMin = 0
|
|
export const surveysDuplicateToProjectsCreateBodyResponseSamplingIntervalMax = 2147483647
|
|
|
|
export const surveysDuplicateToProjectsCreateBodyResponseSamplingLimitMin = 0
|
|
export const surveysDuplicateToProjectsCreateBodyResponseSamplingLimitMax = 2147483647
|
|
|
|
export const surveysDuplicateToProjectsCreateBodyBaseLanguageMax = 20
|
|
|
|
export const SurveysDuplicateToProjectsCreateBody = /* @__PURE__ */ zod.object({
|
|
name: zod.string().max(surveysDuplicateToProjectsCreateBodyNameMax),
|
|
description: zod.string().optional(),
|
|
type: zod
|
|
.enum(['popover', 'widget', 'external_survey', 'api'])
|
|
.describe(
|
|
'\* `popover` - popover\n\* `widget` - widget\n\* `external_survey` - external survey\n\* `api` - api'
|
|
),
|
|
schedule: zod.string().nullish(),
|
|
linked_flag_id: zod.number().nullish(),
|
|
linked_insight_id: zod.number().nullish(),
|
|
targeting_flag_id: zod.number().optional(),
|
|
targeting_flag_filters: zod.unknown().optional(),
|
|
remove_targeting_flag: zod.boolean().nullish(),
|
|
questions: zod
|
|
.unknown()
|
|
.optional()
|
|
.describe(
|
|
'\n The `array` of questions included in the survey. Each question must conform to one of the defined question types: Basic, Link, Rating, or Multiple Choice.\n\n Basic (open-ended question)\n - `id`: The question ID\n - `type`: `open`\n - `question`: The text of the question.\n - `description`: Optional description of the question.\n - `descriptionContentType`: Content type of the description (`html` or `text`).\n - `optional`: Whether the question is optional (`boolean`).\n - `buttonText`: Text displayed on the submit button.\n - `branching`: Branching logic for the question. See branching types below for details.\n\n Link (a question with a link)\n - `id`: The question ID\n - `type`: `link`\n - `question`: The text of the question.\n - `description`: Optional description of the question.\n - `descriptionContentType`: Content type of the description (`html` or `text`).\n - `optional`: Whether the question is optional (`boolean`).\n - `buttonText`: Text displayed on the submit button.\n - `link`: The URL associated with the question.\n - `branching`: Branching logic for the question. See branching types below for details.\n\n Rating (a question with a rating scale)\n - `id`: The question ID\n - `type`: `rating`\n - `question`: The text of the question.\n - `description`: Optional description of the question.\n - `descriptionContentType`: Content type of the description (`html` or `text`).\n - `optional`: Whether the question is optional (`boolean`).\n - `buttonText`: Text displayed on the submit button.\n - `display`: Display style of the rating (`number` or `emoji`).\n - `scale`: The scale of the rating (`number`).\n - `lowerBoundLabel`: Label for the lower bound of the scale.\n - `upperBoundLabel`: Label for the upper bound of the scale.\n - `isNpsQuestion`: Whether the question is an NPS rating.\n - `branching`: Branching logic for the question. See branching types below for details.\n\n Multiple choice\n - `id`: The question ID\n - `type`: `single_choice` or `multiple_choice`\n - `question`: The text of the question.\n - `description`: Optional description of the question.\n - `descriptionContentType`: Content type of the description (`html` or `text`).\n - `optional`: Whether the question is optional (`boolean`).\n - `buttonText`: Text displayed on the submit button.\n - `choices`: An array of choices for the question.\n - `shuffleOptions`: Whether to shuffle the order of the choices (`boolean`).\n - `hasOpenChoice`: Whether the question allows an open-ended response (`boolean`).\n - `branching`: Branching logic for the question. See branching types below for details.\n\n Branching logic can be one of the following types:\n\n Next question: Proceeds to the next question\n ```json\n {\n \"type\": \"next_question\"\n }\n ```\n\n End: Ends the survey, optionally displaying a confirmation message.\n ```json\n {\n \"type\": \"end\"\n }\n ```\n\n Response-based: Branches based on the response values. Available for the `rating` and `single_choice` question types.\n ```json\n {\n \"type\": \"response_based\",\n \"responseValues\": {\n \"responseKey\": \"value\"\n }\n }\n ```\n\n Specific question: Proceeds to a specific question by index.\n ```json\n {\n \"type\": \"specific_question\",\n \"index\": 2\n }\n ```\n\n Translations: Each question can include inline translations.\n - `translations`: Object mapping language codes to translated fields.\n - Language codes: Canonical BCP-47-ish strings (e.g., \"es\", \"es-MX\", \"zh-CN\"). Aliases like \"english\" or \"default\" are rejected. The survey\'s `base_language` (default \"en\") declares the language of the untranslated text and cannot also appear as a translation key.\n - Translatable fields: `question`, `description`, `buttonText`, `choices`, `lowerBoundLabel`, `upperBoundLabel`, `link`\n\n Example with translations:\n ```json\n {\n \"id\": \"uuid\",\n \"type\": \"rating\",\n \"question\": \"How satisfied are you?\",\n \"lowerBoundLabel\": \"Not satisfied\",\n \"upperBoundLabel\": \"Very satisfied\",\n \"translations\": {\n \"es\": {\n \"question\": \"¿Qué tan satisfecho estás?\",\n \"lowerBoundLabel\": \"No satisfecho\",\n \"upperBoundLabel\": \"Muy satisfecho\"\n },\n \"fr\": {\n \"question\": \"Dans quelle mesure êtes-vous satisfait?\"\n }\n }\n }\n ```\n '
|
|
),
|
|
conditions: zod.unknown().optional(),
|
|
appearance: zod.unknown().optional(),
|
|
start_date: zod.iso.datetime({ offset: true }).nullish(),
|
|
end_date: zod.iso.datetime({ offset: true }).nullish(),
|
|
archived: zod.boolean().optional(),
|
|
responses_limit: zod
|
|
.number()
|
|
.min(surveysDuplicateToProjectsCreateBodyResponsesLimitMin)
|
|
.max(surveysDuplicateToProjectsCreateBodyResponsesLimitMax)
|
|
.nullish(),
|
|
iteration_count: zod
|
|
.number()
|
|
.min(surveysDuplicateToProjectsCreateBodyIterationCountMin)
|
|
.max(surveysDuplicateToProjectsCreateBodyIterationCountMax)
|
|
.nullish(),
|
|
iteration_frequency_days: zod
|
|
.number()
|
|
.min(surveysDuplicateToProjectsCreateBodyIterationFrequencyDaysMin)
|
|
.max(surveysDuplicateToProjectsCreateBodyIterationFrequencyDaysMax)
|
|
.nullish(),
|
|
iteration_start_dates: zod.array(zod.iso.datetime({ offset: true }).nullable()).nullish(),
|
|
current_iteration: zod
|
|
.number()
|
|
.min(surveysDuplicateToProjectsCreateBodyCurrentIterationMin)
|
|
.max(surveysDuplicateToProjectsCreateBodyCurrentIterationMax)
|
|
.nullish(),
|
|
current_iteration_start_date: zod.iso.datetime({ offset: true }).nullish(),
|
|
response_sampling_start_date: zod.iso.datetime({ offset: true }).nullish(),
|
|
response_sampling_interval_type: zod
|
|
.union([
|
|
zod.enum(['day', 'week', 'month']).describe('\* `day` - day\n\* `week` - week\n\* `month` - month'),
|
|
zod.enum(['']),
|
|
zod.null(),
|
|
])
|
|
.optional(),
|
|
response_sampling_interval: zod
|
|
.number()
|
|
.min(surveysDuplicateToProjectsCreateBodyResponseSamplingIntervalMin)
|
|
.max(surveysDuplicateToProjectsCreateBodyResponseSamplingIntervalMax)
|
|
.nullish(),
|
|
response_sampling_limit: zod
|
|
.number()
|
|
.min(surveysDuplicateToProjectsCreateBodyResponseSamplingLimitMin)
|
|
.max(surveysDuplicateToProjectsCreateBodyResponseSamplingLimitMax)
|
|
.nullish(),
|
|
response_sampling_daily_limits: zod.unknown().optional(),
|
|
enable_partial_responses: zod.boolean().nullish(),
|
|
enable_iframe_embedding: zod.boolean().nullish(),
|
|
base_language: zod
|
|
.string()
|
|
.max(surveysDuplicateToProjectsCreateBodyBaseLanguageMax)
|
|
.optional()
|
|
.describe(
|
|
"BCP-47 language code (e.g. 'en', 'es', 'es-MX') describing the language of the survey's untranslated text. Defaults to 'en'. Cannot also appear as a key in `translations`."
|
|
),
|
|
translations: zod.unknown().optional(),
|
|
_create_in_folder: zod.string().optional(),
|
|
form_content: zod.unknown().optional(),
|
|
})
|
|
|
|
export const surveysGenerateTranslationsCreateBodyOverwriteDefault = false
|
|
|
|
export const SurveysGenerateTranslationsCreateBody = /* @__PURE__ */ zod.object({
|
|
target_language: zod.string().describe('Language code to generate translations for, for example pt-BR.'),
|
|
source_language: zod
|
|
.string()
|
|
.optional()
|
|
.describe(
|
|
"Optional override for the source language code. Defaults to the survey's `base_language` (or 'en' if unset)."
|
|
),
|
|
overwrite: zod
|
|
.boolean()
|
|
.default(surveysGenerateTranslationsCreateBodyOverwriteDefault)
|
|
.describe('Whether to overwrite existing translations for this language.'),
|
|
survey: zod
|
|
.record(zod.string(), zod.unknown().describe('Draft survey field value.'))
|
|
.optional()
|
|
.describe('Optional translation-only draft survey payload to translate instead of the last saved survey.'),
|
|
})
|
|
|
|
/**
|
|
* Archive a single survey response.
|
|
*/
|
|
export const surveysResponsesArchiveCreateBodyNameMax = 400
|
|
|
|
export const surveysResponsesArchiveCreateBodyResponsesLimitMin = 0
|
|
export const surveysResponsesArchiveCreateBodyResponsesLimitMax = 2147483647
|
|
|
|
export const surveysResponsesArchiveCreateBodyIterationCountMin = 0
|
|
export const surveysResponsesArchiveCreateBodyIterationCountMax = 500
|
|
|
|
export const surveysResponsesArchiveCreateBodyIterationFrequencyDaysMin = 0
|
|
export const surveysResponsesArchiveCreateBodyIterationFrequencyDaysMax = 2147483647
|
|
|
|
export const surveysResponsesArchiveCreateBodyCurrentIterationMin = 0
|
|
export const surveysResponsesArchiveCreateBodyCurrentIterationMax = 2147483647
|
|
|
|
export const surveysResponsesArchiveCreateBodyResponseSamplingIntervalMin = 0
|
|
export const surveysResponsesArchiveCreateBodyResponseSamplingIntervalMax = 2147483647
|
|
|
|
export const surveysResponsesArchiveCreateBodyResponseSamplingLimitMin = 0
|
|
export const surveysResponsesArchiveCreateBodyResponseSamplingLimitMax = 2147483647
|
|
|
|
export const surveysResponsesArchiveCreateBodyBaseLanguageMax = 20
|
|
|
|
export const SurveysResponsesArchiveCreateBody = /* @__PURE__ */ zod.object({
|
|
name: zod.string().max(surveysResponsesArchiveCreateBodyNameMax),
|
|
description: zod.string().optional(),
|
|
type: zod
|
|
.enum(['popover', 'widget', 'external_survey', 'api'])
|
|
.describe(
|
|
'\* `popover` - popover\n\* `widget` - widget\n\* `external_survey` - external survey\n\* `api` - api'
|
|
),
|
|
schedule: zod.string().nullish(),
|
|
linked_flag_id: zod.number().nullish(),
|
|
linked_insight_id: zod.number().nullish(),
|
|
targeting_flag_id: zod.number().optional(),
|
|
targeting_flag_filters: zod.unknown().optional(),
|
|
remove_targeting_flag: zod.boolean().nullish(),
|
|
questions: zod
|
|
.unknown()
|
|
.optional()
|
|
.describe(
|
|
'\n The `array` of questions included in the survey. Each question must conform to one of the defined question types: Basic, Link, Rating, or Multiple Choice.\n\n Basic (open-ended question)\n - `id`: The question ID\n - `type`: `open`\n - `question`: The text of the question.\n - `description`: Optional description of the question.\n - `descriptionContentType`: Content type of the description (`html` or `text`).\n - `optional`: Whether the question is optional (`boolean`).\n - `buttonText`: Text displayed on the submit button.\n - `branching`: Branching logic for the question. See branching types below for details.\n\n Link (a question with a link)\n - `id`: The question ID\n - `type`: `link`\n - `question`: The text of the question.\n - `description`: Optional description of the question.\n - `descriptionContentType`: Content type of the description (`html` or `text`).\n - `optional`: Whether the question is optional (`boolean`).\n - `buttonText`: Text displayed on the submit button.\n - `link`: The URL associated with the question.\n - `branching`: Branching logic for the question. See branching types below for details.\n\n Rating (a question with a rating scale)\n - `id`: The question ID\n - `type`: `rating`\n - `question`: The text of the question.\n - `description`: Optional description of the question.\n - `descriptionContentType`: Content type of the description (`html` or `text`).\n - `optional`: Whether the question is optional (`boolean`).\n - `buttonText`: Text displayed on the submit button.\n - `display`: Display style of the rating (`number` or `emoji`).\n - `scale`: The scale of the rating (`number`).\n - `lowerBoundLabel`: Label for the lower bound of the scale.\n - `upperBoundLabel`: Label for the upper bound of the scale.\n - `isNpsQuestion`: Whether the question is an NPS rating.\n - `branching`: Branching logic for the question. See branching types below for details.\n\n Multiple choice\n - `id`: The question ID\n - `type`: `single_choice` or `multiple_choice`\n - `question`: The text of the question.\n - `description`: Optional description of the question.\n - `descriptionContentType`: Content type of the description (`html` or `text`).\n - `optional`: Whether the question is optional (`boolean`).\n - `buttonText`: Text displayed on the submit button.\n - `choices`: An array of choices for the question.\n - `shuffleOptions`: Whether to shuffle the order of the choices (`boolean`).\n - `hasOpenChoice`: Whether the question allows an open-ended response (`boolean`).\n - `branching`: Branching logic for the question. See branching types below for details.\n\n Branching logic can be one of the following types:\n\n Next question: Proceeds to the next question\n ```json\n {\n \"type\": \"next_question\"\n }\n ```\n\n End: Ends the survey, optionally displaying a confirmation message.\n ```json\n {\n \"type\": \"end\"\n }\n ```\n\n Response-based: Branches based on the response values. Available for the `rating` and `single_choice` question types.\n ```json\n {\n \"type\": \"response_based\",\n \"responseValues\": {\n \"responseKey\": \"value\"\n }\n }\n ```\n\n Specific question: Proceeds to a specific question by index.\n ```json\n {\n \"type\": \"specific_question\",\n \"index\": 2\n }\n ```\n\n Translations: Each question can include inline translations.\n - `translations`: Object mapping language codes to translated fields.\n - Language codes: Canonical BCP-47-ish strings (e.g., \"es\", \"es-MX\", \"zh-CN\"). Aliases like \"english\" or \"default\" are rejected. The survey\'s `base_language` (default \"en\") declares the language of the untranslated text and cannot also appear as a translation key.\n - Translatable fields: `question`, `description`, `buttonText`, `choices`, `lowerBoundLabel`, `upperBoundLabel`, `link`\n\n Example with translations:\n ```json\n {\n \"id\": \"uuid\",\n \"type\": \"rating\",\n \"question\": \"How satisfied are you?\",\n \"lowerBoundLabel\": \"Not satisfied\",\n \"upperBoundLabel\": \"Very satisfied\",\n \"translations\": {\n \"es\": {\n \"question\": \"¿Qué tan satisfecho estás?\",\n \"lowerBoundLabel\": \"No satisfecho\",\n \"upperBoundLabel\": \"Muy satisfecho\"\n },\n \"fr\": {\n \"question\": \"Dans quelle mesure êtes-vous satisfait?\"\n }\n }\n }\n ```\n '
|
|
),
|
|
conditions: zod.unknown().optional(),
|
|
appearance: zod.unknown().optional(),
|
|
start_date: zod.iso.datetime({ offset: true }).nullish(),
|
|
end_date: zod.iso.datetime({ offset: true }).nullish(),
|
|
archived: zod.boolean().optional(),
|
|
responses_limit: zod
|
|
.number()
|
|
.min(surveysResponsesArchiveCreateBodyResponsesLimitMin)
|
|
.max(surveysResponsesArchiveCreateBodyResponsesLimitMax)
|
|
.nullish(),
|
|
iteration_count: zod
|
|
.number()
|
|
.min(surveysResponsesArchiveCreateBodyIterationCountMin)
|
|
.max(surveysResponsesArchiveCreateBodyIterationCountMax)
|
|
.nullish(),
|
|
iteration_frequency_days: zod
|
|
.number()
|
|
.min(surveysResponsesArchiveCreateBodyIterationFrequencyDaysMin)
|
|
.max(surveysResponsesArchiveCreateBodyIterationFrequencyDaysMax)
|
|
.nullish(),
|
|
iteration_start_dates: zod.array(zod.iso.datetime({ offset: true }).nullable()).nullish(),
|
|
current_iteration: zod
|
|
.number()
|
|
.min(surveysResponsesArchiveCreateBodyCurrentIterationMin)
|
|
.max(surveysResponsesArchiveCreateBodyCurrentIterationMax)
|
|
.nullish(),
|
|
current_iteration_start_date: zod.iso.datetime({ offset: true }).nullish(),
|
|
response_sampling_start_date: zod.iso.datetime({ offset: true }).nullish(),
|
|
response_sampling_interval_type: zod
|
|
.union([
|
|
zod.enum(['day', 'week', 'month']).describe('\* `day` - day\n\* `week` - week\n\* `month` - month'),
|
|
zod.enum(['']),
|
|
zod.null(),
|
|
])
|
|
.optional(),
|
|
response_sampling_interval: zod
|
|
.number()
|
|
.min(surveysResponsesArchiveCreateBodyResponseSamplingIntervalMin)
|
|
.max(surveysResponsesArchiveCreateBodyResponseSamplingIntervalMax)
|
|
.nullish(),
|
|
response_sampling_limit: zod
|
|
.number()
|
|
.min(surveysResponsesArchiveCreateBodyResponseSamplingLimitMin)
|
|
.max(surveysResponsesArchiveCreateBodyResponseSamplingLimitMax)
|
|
.nullish(),
|
|
response_sampling_daily_limits: zod.unknown().optional(),
|
|
enable_partial_responses: zod.boolean().nullish(),
|
|
enable_iframe_embedding: zod.boolean().nullish(),
|
|
base_language: zod
|
|
.string()
|
|
.max(surveysResponsesArchiveCreateBodyBaseLanguageMax)
|
|
.optional()
|
|
.describe(
|
|
"BCP-47 language code (e.g. 'en', 'es', 'es-MX') describing the language of the survey's untranslated text. Defaults to 'en'. Cannot also appear as a key in `translations`."
|
|
),
|
|
translations: zod.unknown().optional(),
|
|
_create_in_folder: zod.string().optional(),
|
|
form_content: zod.unknown().optional(),
|
|
})
|
|
|
|
/**
|
|
* Unarchive a single survey response.
|
|
*/
|
|
export const surveysResponsesUnarchiveCreateBodyNameMax = 400
|
|
|
|
export const surveysResponsesUnarchiveCreateBodyResponsesLimitMin = 0
|
|
export const surveysResponsesUnarchiveCreateBodyResponsesLimitMax = 2147483647
|
|
|
|
export const surveysResponsesUnarchiveCreateBodyIterationCountMin = 0
|
|
export const surveysResponsesUnarchiveCreateBodyIterationCountMax = 500
|
|
|
|
export const surveysResponsesUnarchiveCreateBodyIterationFrequencyDaysMin = 0
|
|
export const surveysResponsesUnarchiveCreateBodyIterationFrequencyDaysMax = 2147483647
|
|
|
|
export const surveysResponsesUnarchiveCreateBodyCurrentIterationMin = 0
|
|
export const surveysResponsesUnarchiveCreateBodyCurrentIterationMax = 2147483647
|
|
|
|
export const surveysResponsesUnarchiveCreateBodyResponseSamplingIntervalMin = 0
|
|
export const surveysResponsesUnarchiveCreateBodyResponseSamplingIntervalMax = 2147483647
|
|
|
|
export const surveysResponsesUnarchiveCreateBodyResponseSamplingLimitMin = 0
|
|
export const surveysResponsesUnarchiveCreateBodyResponseSamplingLimitMax = 2147483647
|
|
|
|
export const surveysResponsesUnarchiveCreateBodyBaseLanguageMax = 20
|
|
|
|
export const SurveysResponsesUnarchiveCreateBody = /* @__PURE__ */ zod.object({
|
|
name: zod.string().max(surveysResponsesUnarchiveCreateBodyNameMax),
|
|
description: zod.string().optional(),
|
|
type: zod
|
|
.enum(['popover', 'widget', 'external_survey', 'api'])
|
|
.describe(
|
|
'\* `popover` - popover\n\* `widget` - widget\n\* `external_survey` - external survey\n\* `api` - api'
|
|
),
|
|
schedule: zod.string().nullish(),
|
|
linked_flag_id: zod.number().nullish(),
|
|
linked_insight_id: zod.number().nullish(),
|
|
targeting_flag_id: zod.number().optional(),
|
|
targeting_flag_filters: zod.unknown().optional(),
|
|
remove_targeting_flag: zod.boolean().nullish(),
|
|
questions: zod
|
|
.unknown()
|
|
.optional()
|
|
.describe(
|
|
'\n The `array` of questions included in the survey. Each question must conform to one of the defined question types: Basic, Link, Rating, or Multiple Choice.\n\n Basic (open-ended question)\n - `id`: The question ID\n - `type`: `open`\n - `question`: The text of the question.\n - `description`: Optional description of the question.\n - `descriptionContentType`: Content type of the description (`html` or `text`).\n - `optional`: Whether the question is optional (`boolean`).\n - `buttonText`: Text displayed on the submit button.\n - `branching`: Branching logic for the question. See branching types below for details.\n\n Link (a question with a link)\n - `id`: The question ID\n - `type`: `link`\n - `question`: The text of the question.\n - `description`: Optional description of the question.\n - `descriptionContentType`: Content type of the description (`html` or `text`).\n - `optional`: Whether the question is optional (`boolean`).\n - `buttonText`: Text displayed on the submit button.\n - `link`: The URL associated with the question.\n - `branching`: Branching logic for the question. See branching types below for details.\n\n Rating (a question with a rating scale)\n - `id`: The question ID\n - `type`: `rating`\n - `question`: The text of the question.\n - `description`: Optional description of the question.\n - `descriptionContentType`: Content type of the description (`html` or `text`).\n - `optional`: Whether the question is optional (`boolean`).\n - `buttonText`: Text displayed on the submit button.\n - `display`: Display style of the rating (`number` or `emoji`).\n - `scale`: The scale of the rating (`number`).\n - `lowerBoundLabel`: Label for the lower bound of the scale.\n - `upperBoundLabel`: Label for the upper bound of the scale.\n - `isNpsQuestion`: Whether the question is an NPS rating.\n - `branching`: Branching logic for the question. See branching types below for details.\n\n Multiple choice\n - `id`: The question ID\n - `type`: `single_choice` or `multiple_choice`\n - `question`: The text of the question.\n - `description`: Optional description of the question.\n - `descriptionContentType`: Content type of the description (`html` or `text`).\n - `optional`: Whether the question is optional (`boolean`).\n - `buttonText`: Text displayed on the submit button.\n - `choices`: An array of choices for the question.\n - `shuffleOptions`: Whether to shuffle the order of the choices (`boolean`).\n - `hasOpenChoice`: Whether the question allows an open-ended response (`boolean`).\n - `branching`: Branching logic for the question. See branching types below for details.\n\n Branching logic can be one of the following types:\n\n Next question: Proceeds to the next question\n ```json\n {\n \"type\": \"next_question\"\n }\n ```\n\n End: Ends the survey, optionally displaying a confirmation message.\n ```json\n {\n \"type\": \"end\"\n }\n ```\n\n Response-based: Branches based on the response values. Available for the `rating` and `single_choice` question types.\n ```json\n {\n \"type\": \"response_based\",\n \"responseValues\": {\n \"responseKey\": \"value\"\n }\n }\n ```\n\n Specific question: Proceeds to a specific question by index.\n ```json\n {\n \"type\": \"specific_question\",\n \"index\": 2\n }\n ```\n\n Translations: Each question can include inline translations.\n - `translations`: Object mapping language codes to translated fields.\n - Language codes: Canonical BCP-47-ish strings (e.g., \"es\", \"es-MX\", \"zh-CN\"). Aliases like \"english\" or \"default\" are rejected. The survey\'s `base_language` (default \"en\") declares the language of the untranslated text and cannot also appear as a translation key.\n - Translatable fields: `question`, `description`, `buttonText`, `choices`, `lowerBoundLabel`, `upperBoundLabel`, `link`\n\n Example with translations:\n ```json\n {\n \"id\": \"uuid\",\n \"type\": \"rating\",\n \"question\": \"How satisfied are you?\",\n \"lowerBoundLabel\": \"Not satisfied\",\n \"upperBoundLabel\": \"Very satisfied\",\n \"translations\": {\n \"es\": {\n \"question\": \"¿Qué tan satisfecho estás?\",\n \"lowerBoundLabel\": \"No satisfecho\",\n \"upperBoundLabel\": \"Muy satisfecho\"\n },\n \"fr\": {\n \"question\": \"Dans quelle mesure êtes-vous satisfait?\"\n }\n }\n }\n ```\n '
|
|
),
|
|
conditions: zod.unknown().optional(),
|
|
appearance: zod.unknown().optional(),
|
|
start_date: zod.iso.datetime({ offset: true }).nullish(),
|
|
end_date: zod.iso.datetime({ offset: true }).nullish(),
|
|
archived: zod.boolean().optional(),
|
|
responses_limit: zod
|
|
.number()
|
|
.min(surveysResponsesUnarchiveCreateBodyResponsesLimitMin)
|
|
.max(surveysResponsesUnarchiveCreateBodyResponsesLimitMax)
|
|
.nullish(),
|
|
iteration_count: zod
|
|
.number()
|
|
.min(surveysResponsesUnarchiveCreateBodyIterationCountMin)
|
|
.max(surveysResponsesUnarchiveCreateBodyIterationCountMax)
|
|
.nullish(),
|
|
iteration_frequency_days: zod
|
|
.number()
|
|
.min(surveysResponsesUnarchiveCreateBodyIterationFrequencyDaysMin)
|
|
.max(surveysResponsesUnarchiveCreateBodyIterationFrequencyDaysMax)
|
|
.nullish(),
|
|
iteration_start_dates: zod.array(zod.iso.datetime({ offset: true }).nullable()).nullish(),
|
|
current_iteration: zod
|
|
.number()
|
|
.min(surveysResponsesUnarchiveCreateBodyCurrentIterationMin)
|
|
.max(surveysResponsesUnarchiveCreateBodyCurrentIterationMax)
|
|
.nullish(),
|
|
current_iteration_start_date: zod.iso.datetime({ offset: true }).nullish(),
|
|
response_sampling_start_date: zod.iso.datetime({ offset: true }).nullish(),
|
|
response_sampling_interval_type: zod
|
|
.union([
|
|
zod.enum(['day', 'week', 'month']).describe('\* `day` - day\n\* `week` - week\n\* `month` - month'),
|
|
zod.enum(['']),
|
|
zod.null(),
|
|
])
|
|
.optional(),
|
|
response_sampling_interval: zod
|
|
.number()
|
|
.min(surveysResponsesUnarchiveCreateBodyResponseSamplingIntervalMin)
|
|
.max(surveysResponsesUnarchiveCreateBodyResponseSamplingIntervalMax)
|
|
.nullish(),
|
|
response_sampling_limit: zod
|
|
.number()
|
|
.min(surveysResponsesUnarchiveCreateBodyResponseSamplingLimitMin)
|
|
.max(surveysResponsesUnarchiveCreateBodyResponseSamplingLimitMax)
|
|
.nullish(),
|
|
response_sampling_daily_limits: zod.unknown().optional(),
|
|
enable_partial_responses: zod.boolean().nullish(),
|
|
enable_iframe_embedding: zod.boolean().nullish(),
|
|
base_language: zod
|
|
.string()
|
|
.max(surveysResponsesUnarchiveCreateBodyBaseLanguageMax)
|
|
.optional()
|
|
.describe(
|
|
"BCP-47 language code (e.g. 'en', 'es', 'es-MX') describing the language of the survey's untranslated text. Defaults to 'en'. Cannot also appear as a key in `translations`."
|
|
),
|
|
translations: zod.unknown().optional(),
|
|
_create_in_folder: zod.string().optional(),
|
|
form_content: zod.unknown().optional(),
|
|
})
|
|
|
|
/**
|
|
* Summarize survey responses. When `question_index` or `question_id` is provided, returns a per-question theme summary using cached `survey.question_summaries` when fresh. When neither is provided, returns the survey-wide headline summary (delegates to summary_headline). Pass `force_refresh=true` in the body to bypass caches.
|
|
*/
|
|
export const surveysSummarizeResponsesCreateBodyForceRefreshDefault = false
|
|
|
|
export const SurveysSummarizeResponsesCreateBody = /* @__PURE__ */ zod.object({
|
|
force_refresh: zod
|
|
.boolean()
|
|
.default(surveysSummarizeResponsesCreateBodyForceRefreshDefault)
|
|
.describe('When true, bypass cached summaries and regenerate. Defaults to false.'),
|
|
})
|
|
|
|
export const surveysSummaryHeadlineCreateBodyNameMax = 400
|
|
|
|
export const surveysSummaryHeadlineCreateBodyResponsesLimitMin = 0
|
|
export const surveysSummaryHeadlineCreateBodyResponsesLimitMax = 2147483647
|
|
|
|
export const surveysSummaryHeadlineCreateBodyIterationCountMin = 0
|
|
export const surveysSummaryHeadlineCreateBodyIterationCountMax = 500
|
|
|
|
export const surveysSummaryHeadlineCreateBodyIterationFrequencyDaysMin = 0
|
|
export const surveysSummaryHeadlineCreateBodyIterationFrequencyDaysMax = 2147483647
|
|
|
|
export const surveysSummaryHeadlineCreateBodyCurrentIterationMin = 0
|
|
export const surveysSummaryHeadlineCreateBodyCurrentIterationMax = 2147483647
|
|
|
|
export const surveysSummaryHeadlineCreateBodyResponseSamplingIntervalMin = 0
|
|
export const surveysSummaryHeadlineCreateBodyResponseSamplingIntervalMax = 2147483647
|
|
|
|
export const surveysSummaryHeadlineCreateBodyResponseSamplingLimitMin = 0
|
|
export const surveysSummaryHeadlineCreateBodyResponseSamplingLimitMax = 2147483647
|
|
|
|
export const surveysSummaryHeadlineCreateBodyBaseLanguageMax = 20
|
|
|
|
export const SurveysSummaryHeadlineCreateBody = /* @__PURE__ */ zod.object({
|
|
name: zod.string().max(surveysSummaryHeadlineCreateBodyNameMax),
|
|
description: zod.string().optional(),
|
|
type: zod
|
|
.enum(['popover', 'widget', 'external_survey', 'api'])
|
|
.describe(
|
|
'\* `popover` - popover\n\* `widget` - widget\n\* `external_survey` - external survey\n\* `api` - api'
|
|
),
|
|
schedule: zod.string().nullish(),
|
|
linked_flag_id: zod.number().nullish(),
|
|
linked_insight_id: zod.number().nullish(),
|
|
targeting_flag_id: zod.number().optional(),
|
|
targeting_flag_filters: zod.unknown().optional(),
|
|
remove_targeting_flag: zod.boolean().nullish(),
|
|
questions: zod
|
|
.unknown()
|
|
.optional()
|
|
.describe(
|
|
'\n The `array` of questions included in the survey. Each question must conform to one of the defined question types: Basic, Link, Rating, or Multiple Choice.\n\n Basic (open-ended question)\n - `id`: The question ID\n - `type`: `open`\n - `question`: The text of the question.\n - `description`: Optional description of the question.\n - `descriptionContentType`: Content type of the description (`html` or `text`).\n - `optional`: Whether the question is optional (`boolean`).\n - `buttonText`: Text displayed on the submit button.\n - `branching`: Branching logic for the question. See branching types below for details.\n\n Link (a question with a link)\n - `id`: The question ID\n - `type`: `link`\n - `question`: The text of the question.\n - `description`: Optional description of the question.\n - `descriptionContentType`: Content type of the description (`html` or `text`).\n - `optional`: Whether the question is optional (`boolean`).\n - `buttonText`: Text displayed on the submit button.\n - `link`: The URL associated with the question.\n - `branching`: Branching logic for the question. See branching types below for details.\n\n Rating (a question with a rating scale)\n - `id`: The question ID\n - `type`: `rating`\n - `question`: The text of the question.\n - `description`: Optional description of the question.\n - `descriptionContentType`: Content type of the description (`html` or `text`).\n - `optional`: Whether the question is optional (`boolean`).\n - `buttonText`: Text displayed on the submit button.\n - `display`: Display style of the rating (`number` or `emoji`).\n - `scale`: The scale of the rating (`number`).\n - `lowerBoundLabel`: Label for the lower bound of the scale.\n - `upperBoundLabel`: Label for the upper bound of the scale.\n - `isNpsQuestion`: Whether the question is an NPS rating.\n - `branching`: Branching logic for the question. See branching types below for details.\n\n Multiple choice\n - `id`: The question ID\n - `type`: `single_choice` or `multiple_choice`\n - `question`: The text of the question.\n - `description`: Optional description of the question.\n - `descriptionContentType`: Content type of the description (`html` or `text`).\n - `optional`: Whether the question is optional (`boolean`).\n - `buttonText`: Text displayed on the submit button.\n - `choices`: An array of choices for the question.\n - `shuffleOptions`: Whether to shuffle the order of the choices (`boolean`).\n - `hasOpenChoice`: Whether the question allows an open-ended response (`boolean`).\n - `branching`: Branching logic for the question. See branching types below for details.\n\n Branching logic can be one of the following types:\n\n Next question: Proceeds to the next question\n ```json\n {\n \"type\": \"next_question\"\n }\n ```\n\n End: Ends the survey, optionally displaying a confirmation message.\n ```json\n {\n \"type\": \"end\"\n }\n ```\n\n Response-based: Branches based on the response values. Available for the `rating` and `single_choice` question types.\n ```json\n {\n \"type\": \"response_based\",\n \"responseValues\": {\n \"responseKey\": \"value\"\n }\n }\n ```\n\n Specific question: Proceeds to a specific question by index.\n ```json\n {\n \"type\": \"specific_question\",\n \"index\": 2\n }\n ```\n\n Translations: Each question can include inline translations.\n - `translations`: Object mapping language codes to translated fields.\n - Language codes: Canonical BCP-47-ish strings (e.g., \"es\", \"es-MX\", \"zh-CN\"). Aliases like \"english\" or \"default\" are rejected. The survey\'s `base_language` (default \"en\") declares the language of the untranslated text and cannot also appear as a translation key.\n - Translatable fields: `question`, `description`, `buttonText`, `choices`, `lowerBoundLabel`, `upperBoundLabel`, `link`\n\n Example with translations:\n ```json\n {\n \"id\": \"uuid\",\n \"type\": \"rating\",\n \"question\": \"How satisfied are you?\",\n \"lowerBoundLabel\": \"Not satisfied\",\n \"upperBoundLabel\": \"Very satisfied\",\n \"translations\": {\n \"es\": {\n \"question\": \"¿Qué tan satisfecho estás?\",\n \"lowerBoundLabel\": \"No satisfecho\",\n \"upperBoundLabel\": \"Muy satisfecho\"\n },\n \"fr\": {\n \"question\": \"Dans quelle mesure êtes-vous satisfait?\"\n }\n }\n }\n ```\n '
|
|
),
|
|
conditions: zod.unknown().optional(),
|
|
appearance: zod.unknown().optional(),
|
|
start_date: zod.iso.datetime({ offset: true }).nullish(),
|
|
end_date: zod.iso.datetime({ offset: true }).nullish(),
|
|
archived: zod.boolean().optional(),
|
|
responses_limit: zod
|
|
.number()
|
|
.min(surveysSummaryHeadlineCreateBodyResponsesLimitMin)
|
|
.max(surveysSummaryHeadlineCreateBodyResponsesLimitMax)
|
|
.nullish(),
|
|
iteration_count: zod
|
|
.number()
|
|
.min(surveysSummaryHeadlineCreateBodyIterationCountMin)
|
|
.max(surveysSummaryHeadlineCreateBodyIterationCountMax)
|
|
.nullish(),
|
|
iteration_frequency_days: zod
|
|
.number()
|
|
.min(surveysSummaryHeadlineCreateBodyIterationFrequencyDaysMin)
|
|
.max(surveysSummaryHeadlineCreateBodyIterationFrequencyDaysMax)
|
|
.nullish(),
|
|
iteration_start_dates: zod.array(zod.iso.datetime({ offset: true }).nullable()).nullish(),
|
|
current_iteration: zod
|
|
.number()
|
|
.min(surveysSummaryHeadlineCreateBodyCurrentIterationMin)
|
|
.max(surveysSummaryHeadlineCreateBodyCurrentIterationMax)
|
|
.nullish(),
|
|
current_iteration_start_date: zod.iso.datetime({ offset: true }).nullish(),
|
|
response_sampling_start_date: zod.iso.datetime({ offset: true }).nullish(),
|
|
response_sampling_interval_type: zod
|
|
.union([
|
|
zod.enum(['day', 'week', 'month']).describe('\* `day` - day\n\* `week` - week\n\* `month` - month'),
|
|
zod.enum(['']),
|
|
zod.null(),
|
|
])
|
|
.optional(),
|
|
response_sampling_interval: zod
|
|
.number()
|
|
.min(surveysSummaryHeadlineCreateBodyResponseSamplingIntervalMin)
|
|
.max(surveysSummaryHeadlineCreateBodyResponseSamplingIntervalMax)
|
|
.nullish(),
|
|
response_sampling_limit: zod
|
|
.number()
|
|
.min(surveysSummaryHeadlineCreateBodyResponseSamplingLimitMin)
|
|
.max(surveysSummaryHeadlineCreateBodyResponseSamplingLimitMax)
|
|
.nullish(),
|
|
response_sampling_daily_limits: zod.unknown().optional(),
|
|
enable_partial_responses: zod.boolean().nullish(),
|
|
enable_iframe_embedding: zod.boolean().nullish(),
|
|
base_language: zod
|
|
.string()
|
|
.max(surveysSummaryHeadlineCreateBodyBaseLanguageMax)
|
|
.optional()
|
|
.describe(
|
|
"BCP-47 language code (e.g. 'en', 'es', 'es-MX') describing the language of the survey's untranslated text. Defaults to 'en'. Cannot also appear as a key in `translations`."
|
|
),
|
|
translations: zod.unknown().optional(),
|
|
_create_in_folder: zod.string().optional(),
|
|
form_content: zod.unknown().optional(),
|
|
})
|