mirror of
https://github.com/hanzoai/insights.git
synced 2026-10-30 16:15:31 +00:00
zeekay
bc4ddf332b
Mechanically re-derived: bin/debrand runs over a fresh import of posthog/posthog@fa1a9a60d4 (2026-08-06). The pipeline (.hanzo/workflows), the Dockerfiles and bin/docker* entrypoints, compose files, LLM.md and the squashed initial migration are restored from the shipped tree, same as the previous import. The prune's import-closure guard kept 21 products the new core now imports; dropping them is a refactor now, recorded rather than forced.
528 lines
28 KiB
TypeScript
Generated
528 lines
28 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 subscriptionsCreateBodyAiPromptConfigOneWindowOneModeDefault = `since_last_sent`
|
|
export const subscriptionsCreateBodyAiPromptConfigOneWindowOneStartDaysAgoMax = 365
|
|
|
|
export const subscriptionsCreateBodyAiPromptConfigOneWindowOneEndDaysAgoMin = 0
|
|
export const subscriptionsCreateBodyAiPromptConfigOneWindowOneEndDaysAgoMax = 365
|
|
|
|
export const subscriptionsCreateBodyIntervalMax = 2147483647
|
|
|
|
export const subscriptionsCreateBodyBysetposMin = -2147483648
|
|
export const subscriptionsCreateBodyBysetposMax = 2147483647
|
|
|
|
export const subscriptionsCreateBodyCountMin = -2147483648
|
|
export const subscriptionsCreateBodyCountMax = 2147483647
|
|
|
|
export const subscriptionsCreateBodyTitleMax = 100
|
|
|
|
export const subscriptionsCreateBodySummaryPromptGuideMax = 500
|
|
|
|
export const SubscriptionsCreateBody = /* @__PURE__ */ zod
|
|
.object({
|
|
dashboard: zod
|
|
.number()
|
|
.nullish()
|
|
.describe('Dashboard ID to subscribe to (mutually exclusive with insight on create).'),
|
|
insight: zod
|
|
.number()
|
|
.nullish()
|
|
.describe('Insight ID to subscribe to (mutually exclusive with dashboard on create).'),
|
|
dashboard_export_insights: zod
|
|
.array(zod.number())
|
|
.optional()
|
|
.describe(
|
|
'List of insight IDs from the dashboard to include. Required for dashboard subscriptions, max 10.'
|
|
),
|
|
prompt: zod
|
|
.string()
|
|
.nullish()
|
|
.describe(
|
|
"Free-text prompt that drives the AI-generated report. Required when resource_type is 'ai_prompt'. Max 4000 characters."
|
|
),
|
|
ai_prompt_config: zod
|
|
.object({
|
|
window: zod
|
|
.object({
|
|
mode: zod
|
|
.enum(['since_last_sent', 'last_n_days', 'days_ago_range'])
|
|
.describe(
|
|
'\* `since_last_sent` - Since last report\n\* `last_n_days` - Last N days\n\* `days_ago_range` - Between X and Y days ago'
|
|
)
|
|
.default(subscriptionsCreateBodyAiPromptConfigOneWindowOneModeDefault)
|
|
.describe(
|
|
"What the report analyzes each run:\n\* `since_last_sent` (default) — everything since the previous successful scheduled delivery (gap-free; test\/manual sends don't move the anchor)\n\* `last_n_days` — a fixed trailing window of start_days_ago days\n\* `days_ago_range` — the explicit range from start_days_ago to end_days_ago days ago\n\n\* `since_last_sent` - Since last report\n\* `last_n_days` - Last N days\n\* `days_ago_range` - Between X and Y days ago"
|
|
),
|
|
start_days_ago: zod
|
|
.number()
|
|
.min(1)
|
|
.max(subscriptionsCreateBodyAiPromptConfigOneWindowOneStartDaysAgoMax)
|
|
.nullish()
|
|
.describe(
|
|
"Lower bound of the analysis window, in days before the run. Required for 'last_n_days' (the N) and 'days_ago_range'; ignored for 'since_last_sent'. 1-365."
|
|
),
|
|
end_days_ago: zod
|
|
.number()
|
|
.min(subscriptionsCreateBodyAiPromptConfigOneWindowOneEndDaysAgoMin)
|
|
.max(subscriptionsCreateBodyAiPromptConfigOneWindowOneEndDaysAgoMax)
|
|
.nullish()
|
|
.describe(
|
|
"Upper bound of the analysis window, in days before the run (0 = now). Required for 'days_ago_range' and must be less than start_days_ago; ignored for other modes. 0-365."
|
|
),
|
|
})
|
|
.optional()
|
|
.describe(
|
|
"Analysis window for the report. Omitted = 'since_last_sent' (everything since the previous scheduled delivery)."
|
|
),
|
|
})
|
|
.optional()
|
|
.describe(
|
|
"Configuration for AI report subscriptions (analysis window, future knobs). Only valid when resource_type is 'ai_prompt'. Replaced wholesale on writes."
|
|
),
|
|
target_type: zod
|
|
.enum(['email', 'slack'])
|
|
.describe('\* `email` - Email\n\* `slack` - Slack')
|
|
.describe('Delivery channel: email or slack.\n\n\* `email` - Email\n\* `slack` - Slack'),
|
|
target_value: zod
|
|
.string()
|
|
.describe('Recipient(s): comma-separated email addresses for email, or Slack channel name\/ID for slack.'),
|
|
frequency: zod
|
|
.enum(['daily', 'weekly', 'monthly', 'yearly'])
|
|
.describe('\* `daily` - Daily\n\* `weekly` - Weekly\n\* `monthly` - Monthly\n\* `yearly` - Yearly')
|
|
.describe(
|
|
'How often to deliver: daily, weekly, monthly, or yearly.\n\n\* `daily` - Daily\n\* `weekly` - Weekly\n\* `monthly` - Monthly\n\* `yearly` - Yearly'
|
|
),
|
|
interval: zod
|
|
.number()
|
|
.min(1)
|
|
.max(subscriptionsCreateBodyIntervalMax)
|
|
.describe(
|
|
'Interval multiplier (e.g. 2 with weekly frequency means every 2 weeks). Required on create; must be 1 or greater.'
|
|
),
|
|
byweekday: zod
|
|
.array(
|
|
zod
|
|
.enum(['monday', 'tuesday', 'wednesday', 'thursday', 'friday', 'saturday', 'sunday'])
|
|
.describe(
|
|
'\* `monday` - Monday\n\* `tuesday` - Tuesday\n\* `wednesday` - Wednesday\n\* `thursday` - Thursday\n\* `friday` - Friday\n\* `saturday` - Saturday\n\* `sunday` - Sunday'
|
|
)
|
|
)
|
|
.nullish()
|
|
.describe(
|
|
'Days of week for daily or weekly subscriptions: monday, tuesday, wednesday, thursday, friday, saturday, sunday.'
|
|
),
|
|
bysetpos: zod
|
|
.number()
|
|
.min(subscriptionsCreateBodyBysetposMin)
|
|
.max(subscriptionsCreateBodyBysetposMax)
|
|
.nullish()
|
|
.describe('Position within byweekday set for monthly frequency (e.g. 1 for first, -1 for last).'),
|
|
count: zod
|
|
.number()
|
|
.min(subscriptionsCreateBodyCountMin)
|
|
.max(subscriptionsCreateBodyCountMax)
|
|
.nullish()
|
|
.describe('Total number of deliveries before the subscription stops. Null for unlimited.'),
|
|
start_date: zod.iso.datetime({ offset: true }).describe('When to start delivering (ISO 8601 datetime).'),
|
|
until_date: zod.iso
|
|
.datetime({ offset: true })
|
|
.nullish()
|
|
.describe('When to stop delivering (ISO 8601 datetime). Null for indefinite.'),
|
|
deleted: zod.boolean().optional().describe('Set to true to soft-delete. Subscriptions cannot be hard-deleted.'),
|
|
enabled: zod
|
|
.boolean()
|
|
.optional()
|
|
.describe(
|
|
'Whether the subscription is active. Set to false to pause delivery without deleting. Auto-set to false when the delivery integration becomes invalid.'
|
|
),
|
|
title: zod
|
|
.string()
|
|
.max(subscriptionsCreateBodyTitleMax)
|
|
.nullish()
|
|
.describe('Human-readable name for this subscription.'),
|
|
integration_id: zod
|
|
.number()
|
|
.nullish()
|
|
.describe('ID of a connected Slack integration. Required when target_type is slack.'),
|
|
invite_message: zod
|
|
.string()
|
|
.nullish()
|
|
.describe('Optional message included in the invitation email when adding new recipients.'),
|
|
send_test_now: zod
|
|
.boolean()
|
|
.optional()
|
|
.describe(
|
|
'Whether to immediately deliver the subscription once on save so the editor can confirm it looks right. Defaults to true on create. When omitted on update, a delivery is sent only if the edit changed what gets delivered (recipient, channel, source) or re-enabled the subscription. The recurring schedule is unaffected.'
|
|
),
|
|
summary_enabled: zod
|
|
.boolean()
|
|
.optional()
|
|
.describe(
|
|
"Whether to attach an AI-generated summary to each delivery (insight and dashboard subscriptions only). Requires the organization to have approved AI data processing, and is subject to the org's active-summary cap and AI credit budget; otherwise the write is rejected. Not applicable to prompt subscriptions, which are themselves AI-generated."
|
|
),
|
|
summary_prompt_guide: zod
|
|
.string()
|
|
.max(subscriptionsCreateBodySummaryPromptGuideMax)
|
|
.optional()
|
|
.describe(
|
|
'Optional free-text guidance (max 500 chars) steering the AI summary, e.g. which metrics to emphasize. Only settable when AI summary context is enabled for the organization; clearing it (empty string) is always allowed.'
|
|
),
|
|
})
|
|
.describe('Standard Subscription serializer.')
|
|
|
|
export const subscriptionsUpdateBodyAiPromptConfigOneWindowOneModeDefault = `since_last_sent`
|
|
export const subscriptionsUpdateBodyAiPromptConfigOneWindowOneStartDaysAgoMax = 365
|
|
|
|
export const subscriptionsUpdateBodyAiPromptConfigOneWindowOneEndDaysAgoMin = 0
|
|
export const subscriptionsUpdateBodyAiPromptConfigOneWindowOneEndDaysAgoMax = 365
|
|
|
|
export const subscriptionsUpdateBodyIntervalMax = 2147483647
|
|
|
|
export const subscriptionsUpdateBodyBysetposMin = -2147483648
|
|
export const subscriptionsUpdateBodyBysetposMax = 2147483647
|
|
|
|
export const subscriptionsUpdateBodyCountMin = -2147483648
|
|
export const subscriptionsUpdateBodyCountMax = 2147483647
|
|
|
|
export const subscriptionsUpdateBodyTitleMax = 100
|
|
|
|
export const subscriptionsUpdateBodySummaryPromptGuideMax = 500
|
|
|
|
export const SubscriptionsUpdateBody = /* @__PURE__ */ zod
|
|
.object({
|
|
dashboard: zod
|
|
.number()
|
|
.nullish()
|
|
.describe('Dashboard ID to subscribe to (mutually exclusive with insight on create).'),
|
|
insight: zod
|
|
.number()
|
|
.nullish()
|
|
.describe('Insight ID to subscribe to (mutually exclusive with dashboard on create).'),
|
|
dashboard_export_insights: zod
|
|
.array(zod.number())
|
|
.optional()
|
|
.describe(
|
|
'List of insight IDs from the dashboard to include. Required for dashboard subscriptions, max 10.'
|
|
),
|
|
prompt: zod
|
|
.string()
|
|
.nullish()
|
|
.describe(
|
|
"Free-text prompt that drives the AI-generated report. Required when resource_type is 'ai_prompt'. Max 4000 characters."
|
|
),
|
|
ai_prompt_config: zod
|
|
.object({
|
|
window: zod
|
|
.object({
|
|
mode: zod
|
|
.enum(['since_last_sent', 'last_n_days', 'days_ago_range'])
|
|
.describe(
|
|
'\* `since_last_sent` - Since last report\n\* `last_n_days` - Last N days\n\* `days_ago_range` - Between X and Y days ago'
|
|
)
|
|
.default(subscriptionsUpdateBodyAiPromptConfigOneWindowOneModeDefault)
|
|
.describe(
|
|
"What the report analyzes each run:\n\* `since_last_sent` (default) — everything since the previous successful scheduled delivery (gap-free; test\/manual sends don't move the anchor)\n\* `last_n_days` — a fixed trailing window of start_days_ago days\n\* `days_ago_range` — the explicit range from start_days_ago to end_days_ago days ago\n\n\* `since_last_sent` - Since last report\n\* `last_n_days` - Last N days\n\* `days_ago_range` - Between X and Y days ago"
|
|
),
|
|
start_days_ago: zod
|
|
.number()
|
|
.min(1)
|
|
.max(subscriptionsUpdateBodyAiPromptConfigOneWindowOneStartDaysAgoMax)
|
|
.nullish()
|
|
.describe(
|
|
"Lower bound of the analysis window, in days before the run. Required for 'last_n_days' (the N) and 'days_ago_range'; ignored for 'since_last_sent'. 1-365."
|
|
),
|
|
end_days_ago: zod
|
|
.number()
|
|
.min(subscriptionsUpdateBodyAiPromptConfigOneWindowOneEndDaysAgoMin)
|
|
.max(subscriptionsUpdateBodyAiPromptConfigOneWindowOneEndDaysAgoMax)
|
|
.nullish()
|
|
.describe(
|
|
"Upper bound of the analysis window, in days before the run (0 = now). Required for 'days_ago_range' and must be less than start_days_ago; ignored for other modes. 0-365."
|
|
),
|
|
})
|
|
.optional()
|
|
.describe(
|
|
"Analysis window for the report. Omitted = 'since_last_sent' (everything since the previous scheduled delivery)."
|
|
),
|
|
})
|
|
.optional()
|
|
.describe(
|
|
"Configuration for AI report subscriptions (analysis window, future knobs). Only valid when resource_type is 'ai_prompt'. Replaced wholesale on writes."
|
|
),
|
|
target_type: zod
|
|
.enum(['email', 'slack'])
|
|
.describe('\* `email` - Email\n\* `slack` - Slack')
|
|
.describe('Delivery channel: email or slack.\n\n\* `email` - Email\n\* `slack` - Slack'),
|
|
target_value: zod
|
|
.string()
|
|
.describe('Recipient(s): comma-separated email addresses for email, or Slack channel name\/ID for slack.'),
|
|
frequency: zod
|
|
.enum(['daily', 'weekly', 'monthly', 'yearly'])
|
|
.describe('\* `daily` - Daily\n\* `weekly` - Weekly\n\* `monthly` - Monthly\n\* `yearly` - Yearly')
|
|
.describe(
|
|
'How often to deliver: daily, weekly, monthly, or yearly.\n\n\* `daily` - Daily\n\* `weekly` - Weekly\n\* `monthly` - Monthly\n\* `yearly` - Yearly'
|
|
),
|
|
interval: zod
|
|
.number()
|
|
.min(1)
|
|
.max(subscriptionsUpdateBodyIntervalMax)
|
|
.describe(
|
|
'Interval multiplier (e.g. 2 with weekly frequency means every 2 weeks). Required on create; must be 1 or greater.'
|
|
),
|
|
byweekday: zod
|
|
.array(
|
|
zod
|
|
.enum(['monday', 'tuesday', 'wednesday', 'thursday', 'friday', 'saturday', 'sunday'])
|
|
.describe(
|
|
'\* `monday` - Monday\n\* `tuesday` - Tuesday\n\* `wednesday` - Wednesday\n\* `thursday` - Thursday\n\* `friday` - Friday\n\* `saturday` - Saturday\n\* `sunday` - Sunday'
|
|
)
|
|
)
|
|
.nullish()
|
|
.describe(
|
|
'Days of week for daily or weekly subscriptions: monday, tuesday, wednesday, thursday, friday, saturday, sunday.'
|
|
),
|
|
bysetpos: zod
|
|
.number()
|
|
.min(subscriptionsUpdateBodyBysetposMin)
|
|
.max(subscriptionsUpdateBodyBysetposMax)
|
|
.nullish()
|
|
.describe('Position within byweekday set for monthly frequency (e.g. 1 for first, -1 for last).'),
|
|
count: zod
|
|
.number()
|
|
.min(subscriptionsUpdateBodyCountMin)
|
|
.max(subscriptionsUpdateBodyCountMax)
|
|
.nullish()
|
|
.describe('Total number of deliveries before the subscription stops. Null for unlimited.'),
|
|
start_date: zod.iso.datetime({ offset: true }).describe('When to start delivering (ISO 8601 datetime).'),
|
|
until_date: zod.iso
|
|
.datetime({ offset: true })
|
|
.nullish()
|
|
.describe('When to stop delivering (ISO 8601 datetime). Null for indefinite.'),
|
|
deleted: zod.boolean().optional().describe('Set to true to soft-delete. Subscriptions cannot be hard-deleted.'),
|
|
enabled: zod
|
|
.boolean()
|
|
.optional()
|
|
.describe(
|
|
'Whether the subscription is active. Set to false to pause delivery without deleting. Auto-set to false when the delivery integration becomes invalid.'
|
|
),
|
|
title: zod
|
|
.string()
|
|
.max(subscriptionsUpdateBodyTitleMax)
|
|
.nullish()
|
|
.describe('Human-readable name for this subscription.'),
|
|
integration_id: zod
|
|
.number()
|
|
.nullish()
|
|
.describe('ID of a connected Slack integration. Required when target_type is slack.'),
|
|
invite_message: zod
|
|
.string()
|
|
.nullish()
|
|
.describe('Optional message included in the invitation email when adding new recipients.'),
|
|
send_test_now: zod
|
|
.boolean()
|
|
.optional()
|
|
.describe(
|
|
'Whether to immediately deliver the subscription once on save so the editor can confirm it looks right. Defaults to true on create. When omitted on update, a delivery is sent only if the edit changed what gets delivered (recipient, channel, source) or re-enabled the subscription. The recurring schedule is unaffected.'
|
|
),
|
|
summary_enabled: zod
|
|
.boolean()
|
|
.optional()
|
|
.describe(
|
|
"Whether to attach an AI-generated summary to each delivery (insight and dashboard subscriptions only). Requires the organization to have approved AI data processing, and is subject to the org's active-summary cap and AI credit budget; otherwise the write is rejected. Not applicable to prompt subscriptions, which are themselves AI-generated."
|
|
),
|
|
summary_prompt_guide: zod
|
|
.string()
|
|
.max(subscriptionsUpdateBodySummaryPromptGuideMax)
|
|
.optional()
|
|
.describe(
|
|
'Optional free-text guidance (max 500 chars) steering the AI summary, e.g. which metrics to emphasize. Only settable when AI summary context is enabled for the organization; clearing it (empty string) is always allowed.'
|
|
),
|
|
})
|
|
.describe('Standard Subscription serializer.')
|
|
|
|
export const subscriptionsPartialUpdateBodyAiPromptConfigOneWindowOneModeDefault = `since_last_sent`
|
|
export const subscriptionsPartialUpdateBodyAiPromptConfigOneWindowOneStartDaysAgoMax = 365
|
|
|
|
export const subscriptionsPartialUpdateBodyAiPromptConfigOneWindowOneEndDaysAgoMin = 0
|
|
export const subscriptionsPartialUpdateBodyAiPromptConfigOneWindowOneEndDaysAgoMax = 365
|
|
|
|
export const subscriptionsPartialUpdateBodyIntervalMax = 2147483647
|
|
|
|
export const subscriptionsPartialUpdateBodyBysetposMin = -2147483648
|
|
export const subscriptionsPartialUpdateBodyBysetposMax = 2147483647
|
|
|
|
export const subscriptionsPartialUpdateBodyCountMin = -2147483648
|
|
export const subscriptionsPartialUpdateBodyCountMax = 2147483647
|
|
|
|
export const subscriptionsPartialUpdateBodyTitleMax = 100
|
|
|
|
export const subscriptionsPartialUpdateBodySummaryPromptGuideMax = 500
|
|
|
|
export const SubscriptionsPartialUpdateBody = /* @__PURE__ */ zod
|
|
.object({
|
|
dashboard: zod
|
|
.number()
|
|
.nullish()
|
|
.describe('Dashboard ID to subscribe to (mutually exclusive with insight on create).'),
|
|
insight: zod
|
|
.number()
|
|
.nullish()
|
|
.describe('Insight ID to subscribe to (mutually exclusive with dashboard on create).'),
|
|
dashboard_export_insights: zod
|
|
.array(zod.number())
|
|
.optional()
|
|
.describe(
|
|
'List of insight IDs from the dashboard to include. Required for dashboard subscriptions, max 10.'
|
|
),
|
|
prompt: zod
|
|
.string()
|
|
.nullish()
|
|
.describe(
|
|
"Free-text prompt that drives the AI-generated report. Required when resource_type is 'ai_prompt'. Max 4000 characters."
|
|
),
|
|
ai_prompt_config: zod
|
|
.object({
|
|
window: zod
|
|
.object({
|
|
mode: zod
|
|
.enum(['since_last_sent', 'last_n_days', 'days_ago_range'])
|
|
.describe(
|
|
'\* `since_last_sent` - Since last report\n\* `last_n_days` - Last N days\n\* `days_ago_range` - Between X and Y days ago'
|
|
)
|
|
.default(subscriptionsPartialUpdateBodyAiPromptConfigOneWindowOneModeDefault)
|
|
.describe(
|
|
"What the report analyzes each run:\n\* `since_last_sent` (default) — everything since the previous successful scheduled delivery (gap-free; test\/manual sends don't move the anchor)\n\* `last_n_days` — a fixed trailing window of start_days_ago days\n\* `days_ago_range` — the explicit range from start_days_ago to end_days_ago days ago\n\n\* `since_last_sent` - Since last report\n\* `last_n_days` - Last N days\n\* `days_ago_range` - Between X and Y days ago"
|
|
),
|
|
start_days_ago: zod
|
|
.number()
|
|
.min(1)
|
|
.max(subscriptionsPartialUpdateBodyAiPromptConfigOneWindowOneStartDaysAgoMax)
|
|
.nullish()
|
|
.describe(
|
|
"Lower bound of the analysis window, in days before the run. Required for 'last_n_days' (the N) and 'days_ago_range'; ignored for 'since_last_sent'. 1-365."
|
|
),
|
|
end_days_ago: zod
|
|
.number()
|
|
.min(subscriptionsPartialUpdateBodyAiPromptConfigOneWindowOneEndDaysAgoMin)
|
|
.max(subscriptionsPartialUpdateBodyAiPromptConfigOneWindowOneEndDaysAgoMax)
|
|
.nullish()
|
|
.describe(
|
|
"Upper bound of the analysis window, in days before the run (0 = now). Required for 'days_ago_range' and must be less than start_days_ago; ignored for other modes. 0-365."
|
|
),
|
|
})
|
|
.optional()
|
|
.describe(
|
|
"Analysis window for the report. Omitted = 'since_last_sent' (everything since the previous scheduled delivery)."
|
|
),
|
|
})
|
|
.optional()
|
|
.describe(
|
|
"Configuration for AI report subscriptions (analysis window, future knobs). Only valid when resource_type is 'ai_prompt'. Replaced wholesale on writes."
|
|
),
|
|
target_type: zod
|
|
.enum(['email', 'slack'])
|
|
.describe('\* `email` - Email\n\* `slack` - Slack')
|
|
.optional()
|
|
.describe('Delivery channel: email or slack.\n\n\* `email` - Email\n\* `slack` - Slack'),
|
|
target_value: zod
|
|
.string()
|
|
.optional()
|
|
.describe('Recipient(s): comma-separated email addresses for email, or Slack channel name\/ID for slack.'),
|
|
frequency: zod
|
|
.enum(['daily', 'weekly', 'monthly', 'yearly'])
|
|
.describe('\* `daily` - Daily\n\* `weekly` - Weekly\n\* `monthly` - Monthly\n\* `yearly` - Yearly')
|
|
.optional()
|
|
.describe(
|
|
'How often to deliver: daily, weekly, monthly, or yearly.\n\n\* `daily` - Daily\n\* `weekly` - Weekly\n\* `monthly` - Monthly\n\* `yearly` - Yearly'
|
|
),
|
|
interval: zod
|
|
.number()
|
|
.min(1)
|
|
.max(subscriptionsPartialUpdateBodyIntervalMax)
|
|
.optional()
|
|
.describe(
|
|
'Interval multiplier (e.g. 2 with weekly frequency means every 2 weeks). Required on create; must be 1 or greater.'
|
|
),
|
|
byweekday: zod
|
|
.array(
|
|
zod
|
|
.enum(['monday', 'tuesday', 'wednesday', 'thursday', 'friday', 'saturday', 'sunday'])
|
|
.describe(
|
|
'\* `monday` - Monday\n\* `tuesday` - Tuesday\n\* `wednesday` - Wednesday\n\* `thursday` - Thursday\n\* `friday` - Friday\n\* `saturday` - Saturday\n\* `sunday` - Sunday'
|
|
)
|
|
)
|
|
.nullish()
|
|
.describe(
|
|
'Days of week for daily or weekly subscriptions: monday, tuesday, wednesday, thursday, friday, saturday, sunday.'
|
|
),
|
|
bysetpos: zod
|
|
.number()
|
|
.min(subscriptionsPartialUpdateBodyBysetposMin)
|
|
.max(subscriptionsPartialUpdateBodyBysetposMax)
|
|
.nullish()
|
|
.describe('Position within byweekday set for monthly frequency (e.g. 1 for first, -1 for last).'),
|
|
count: zod
|
|
.number()
|
|
.min(subscriptionsPartialUpdateBodyCountMin)
|
|
.max(subscriptionsPartialUpdateBodyCountMax)
|
|
.nullish()
|
|
.describe('Total number of deliveries before the subscription stops. Null for unlimited.'),
|
|
start_date: zod.iso
|
|
.datetime({ offset: true })
|
|
.optional()
|
|
.describe('When to start delivering (ISO 8601 datetime).'),
|
|
until_date: zod.iso
|
|
.datetime({ offset: true })
|
|
.nullish()
|
|
.describe('When to stop delivering (ISO 8601 datetime). Null for indefinite.'),
|
|
deleted: zod.boolean().optional().describe('Set to true to soft-delete. Subscriptions cannot be hard-deleted.'),
|
|
enabled: zod
|
|
.boolean()
|
|
.optional()
|
|
.describe(
|
|
'Whether the subscription is active. Set to false to pause delivery without deleting. Auto-set to false when the delivery integration becomes invalid.'
|
|
),
|
|
title: zod
|
|
.string()
|
|
.max(subscriptionsPartialUpdateBodyTitleMax)
|
|
.nullish()
|
|
.describe('Human-readable name for this subscription.'),
|
|
integration_id: zod
|
|
.number()
|
|
.nullish()
|
|
.describe('ID of a connected Slack integration. Required when target_type is slack.'),
|
|
invite_message: zod
|
|
.string()
|
|
.nullish()
|
|
.describe('Optional message included in the invitation email when adding new recipients.'),
|
|
send_test_now: zod
|
|
.boolean()
|
|
.optional()
|
|
.describe(
|
|
'Whether to immediately deliver the subscription once on save so the editor can confirm it looks right. Defaults to true on create. When omitted on update, a delivery is sent only if the edit changed what gets delivered (recipient, channel, source) or re-enabled the subscription. The recurring schedule is unaffected.'
|
|
),
|
|
summary_enabled: zod
|
|
.boolean()
|
|
.optional()
|
|
.describe(
|
|
"Whether to attach an AI-generated summary to each delivery (insight and dashboard subscriptions only). Requires the organization to have approved AI data processing, and is subject to the org's active-summary cap and AI credit budget; otherwise the write is rejected. Not applicable to prompt subscriptions, which are themselves AI-generated."
|
|
),
|
|
summary_prompt_guide: zod
|
|
.string()
|
|
.max(subscriptionsPartialUpdateBodySummaryPromptGuideMax)
|
|
.optional()
|
|
.describe(
|
|
'Optional free-text guidance (max 500 chars) steering the AI summary, e.g. which metrics to emphasize. Only settable when AI summary context is enabled for the organization; clearing it (empty string) is always allowed.'
|
|
),
|
|
})
|
|
.describe('Standard Subscription serializer.')
|