zelf-sdk 1.0.0

data/lib/zelf/models.rb

@@ -0,0 +1,1213 @@
+# Generated by codegen. Do not edit by hand.
+require_relative 'model'
+
+module Zelf
+  module Models
+    # Accepted values for AccountTypeEnum.
+    AccountTypeEnum = [
+      "tracked",
+      "influencer",
+      "owned",
+    ].freeze
+
+    # Accepted values for AnalysisScopeEnum.
+    AnalysisScopeEnum = [
+      "CONTENT",
+      "COMMENT",
+    ].freeze
+
+    # Accepted values for BlankEnum.
+    BlankEnum = [
+      "",
+    ].freeze
+
+    # Accepted values for ContentFormEnum.
+    ContentFormEnum = [
+      "VIDEO",
+      "IMAGE",
+    ].freeze
+
+    # Accepted values for KindEnum.
+    KindEnum = [
+      "snapshot",
+      "event",
+    ].freeze
+
+    # Accepted values for LastStatusEnum.
+    LastStatusEnum = [
+      "SUCCESS",
+      "FAILED",
+    ].freeze
+
+    # Accepted values for MentionTypeEnum.
+    MentionTypeEnum = [
+      "content",
+      "comment",
+    ].freeze
+
+    # Accepted values for PlatformEnum.
+    PlatformEnum = [
+      "instagram",
+      "tiktok",
+      "youtube",
+    ].freeze
+
+    # Accepted values for ResourceEnum.
+    ResourceEnum = [
+      "content",
+      "creator",
+    ].freeze
+
+    # Accepted values for SecretTypeEnum.
+    SecretTypeEnum = [
+      "default",
+      "new",
+    ].freeze
+
+    # Accepted values for StateEnum.
+    StateEnum = [
+      "PENDING",
+      "SUCCEEDED",
+      "FAILED",
+      "EXHAUSTED",
+      "QUOTA_EXHAUSTED",
+    ].freeze
+
+    # Accepted values for SubBrandTypeEnum.
+    SubBrandTypeEnum = [
+      "COMPETITIVE",
+      "THEME",
+    ].freeze
+
+    # Accepted values for TypeEnum.
+    TypeEnum = [
+      "USER_DEFINED_SAFETY_CRITERION",
+      "ADULT_CONTENT",
+      "ARMS_AND_AMMUNITION",
+      "MISINFORMATION",
+      "PROFANITY",
+      "POLITICS",
+      "DISCLOSURE",
+    ].freeze
+
+    class AiAnalysis < Zelf::Model; end
+    class AiAnalysisCreateRequest < Zelf::Model; end
+    class AiAnalysisResult < Zelf::Model; end
+    class AiAnalysisRun < Zelf::Model; end
+    class Brand < Zelf::Model; end
+    class BrandAccount < Zelf::Model; end
+    class BrandAccountGroups < Zelf::Model; end
+    class BrandAccountsWriteRequest < Zelf::Model; end
+    class BrandCatalog < Zelf::Model; end
+    class BrandCatalogItem < Zelf::Model; end
+    class BrandCreateSubBrandRequest < Zelf::Model; end
+    class BrandKeywords < Zelf::Model; end
+    class Comment < Zelf::Model; end
+    class CommentAuthor < Zelf::Model; end
+    class Content < Zelf::Model; end
+    class ContentActionRequestRequest < Zelf::Model; end
+    class ContentActionResponse < Zelf::Model; end
+    class ContentCreator < Zelf::Model; end
+    class ContentDiscovery < Zelf::Model; end
+    class ContentDiscoveryRequestRequest < Zelf::Model; end
+    class ContentFilterInputRequest < Zelf::Model; end
+    class ContentScopeRequest < Zelf::Model; end
+    class ContentStatistics < Zelf::Model; end
+    class Creator < Zelf::Model; end
+    class CreatorSync < Zelf::Model; end
+    class CreatorSyncCreateRequest < Zelf::Model; end
+    class CreatorVetting < Zelf::Model; end
+    class CreatorVettingRequest < Zelf::Model; end
+    class CreatorVettingResult < Zelf::Model; end
+    class CreatorVettingRun < Zelf::Model; end
+    class Detection < Zelf::Model; end
+    class DetectionBrandHint < Zelf::Model; end
+    class DetectionBrandHintRequest < Zelf::Model; end
+    class DetectionBrandResult < Zelf::Model; end
+    class DetectionBrandSummary < Zelf::Model; end
+    class DetectionContext < Zelf::Model; end
+    class DetectionContextInputRequest < Zelf::Model; end
+    class DetectionCreateRequest < Zelf::Model; end
+    class DetectionHints < Zelf::Model; end
+    class DetectionHintsRequest < Zelf::Model; end
+    class DetectionPlacement < Zelf::Model; end
+    class DetectionResult < Zelf::Model; end
+    class DetectionSummary < Zelf::Model; end
+    class DetectionVideo < Zelf::Model; end
+    class PatchedBrandUpdateRequest < Zelf::Model; end
+    class PatchedWebhookSubscriptionUpdateRequest < Zelf::Model; end
+    class ResultFile < Zelf::Model; end
+    class SafetyCheckRequest < Zelf::Model; end
+    class Usage < Zelf::Model; end
+    class UsageScope < Zelf::Model; end
+    class UsageWindow < Zelf::Model; end
+    class WebhookAvailableEvent < Zelf::Model; end
+    class WebhookData < Zelf::Model; end
+    class WebhookDeleteAcknowledgement < Zelf::Model; end
+    class WebhookDelivery < Zelf::Model; end
+    class WebhookFile < Zelf::Model; end
+    class WebhookPush < Zelf::Model; end
+    class WebhookSecret < Zelf::Model; end
+    class WebhookSecretCreateRequest < Zelf::Model; end
+    class WebhookSecretCreated < Zelf::Model; end
+    class WebhookSubscription < Zelf::Model; end
+    class WebhookSubscriptionCreateRequest < Zelf::Model; end
+    class WebhookSubscriptionCreated < Zelf::Model; end
+
+    # Response body for the AI analysis root.
+    class AiAnalysis
+      # ID of the analysis
+      field :id, "id"
+      # Always AI_ANALYSIS here
+      field :analysis_type, "analysis_type"
+      # The analysis label
+      field :name, "name"
+      # The subject the analysis focuses on
+      field :topic, "topic"
+      # When the analysis was created (UTC, ISO-8601)
+      field :created_at, "created_at", cast: :time
+      # When the analysis was last modified (UTC, ISO-8601)
+      field :modified_at, "modified_at", cast: :time
+      # The runs that make up this analysis, one per scope, ordered newest first
+      field :analyses, "analyses", cast: [AiAnalysisRun]
+    end
+
+    # Request body for ``POST /api/v1/ai_analysis/``.
+    class AiAnalysisCreateRequest
+      # A label for this analysis
+      field :name, "name"
+      # The brand, product, person or event to analyze, as a short term
+      field :topic, "topic"
+      # What to analyze: any of CONTENT, COMMENT
+      field :analysis_scope, "analysis_scope"
+      # Selects which content the analysis runs over
+      field :content_filters, "content_filters", cast: ContentFilterInputRequest
+    end
+
+    # A single analysis run with its downloadable ``result``.
+    class AiAnalysisResult
+      # ID of the analysis run
+      field :id, "id"
+      # ID of the analysis this run belongs to
+      field :analysis_id, "analysis_id"
+      # What this run covers: CONTENT or COMMENT
+      field :scope, "scope"
+      # Run status: one of IN_PROGRESS, COMPLETED, EMPTY_RESULT (finished with no...
+      field :status, "status"
+      # Signed, time-limited download of the run's analysis payload: download_url...
+      field :result, "result", cast: ResultFile
+      # When the run was created (UTC, ISO-8601)
+      field :created_at, "created_at", cast: :time
+      # When the run was last modified (UTC, ISO-8601)
+      field :modified_at, "modified_at", cast: :time
+    end
+
+    # A single analysis run, without its result payload. The run ``result`` is not
+    # included; retrieve it from `ai_analysis.results` once ``status`` is `COMPLETED`.
+    class AiAnalysisRun
+      # ID of the analysis run
+      field :id, "id"
+      # What this run covers: CONTENT or COMMENT
+      field :scope, "scope"
+      # Run status: one of IN_PROGRESS, COMPLETED, EMPTY_RESULT (finished with no...
+      field :status, "status"
+    end
+
+    # A brand you can reach.
+    class Brand
+      # Unique identifier for the brand
+      field :id, "id"
+      # Display name of the brand
+      field :title, "title"
+      # true for the brand this access belongs to, and false for every other brand the...
+      field :is_primary, "is_primary"
+      # COMPETITIVE or THEME for a sub-brand; null for a top-level brand
+      field :sub_brand_type, "sub_brand_type"
+      # Id of the parent brand for a sub-brand; null for a top-level brand
+      field :parent_brand_id, "parent_brand_id"
+      # The terms this brand uses to monitor social platforms
+      field :keywords, "keywords", cast: BrandKeywords
+    end
+
+    # An account tracked, marked as an influencer, or owned by the brand.
+    class BrandAccount
+      # The account's handle
+      field :username, "username"
+      # instagram or tiktok
+      field :platform, "platform"
+      # The account's profile URL, when available
+      field :external_url, "external_url"
+    end
+
+    # A brand's accounts, grouped into one list per account type. Every key is optional
+    # because `account_type` narrows the response to the single list it names.
+    class BrandAccountGroups
+      # Accounts the brand monitors
+      field :tracked, "tracked", cast: [BrandAccount]
+      # Accounts the brand treats as partnership candidates
+      field :influencer, "influencer", cast: [BrandAccount]
+      # Profiles the brand operates itself
+      field :owned, "owned", cast: [BrandAccount]
+    end
+
+    # Add or remove profiles in a brand's tracked/influencer/owned list.
+    class BrandAccountsWriteRequest
+      # Brand to modify, specified as an id from brands.list
+      field :brand_id, "brand_id"
+      # The list to modify: tracked, influencer, or owned for the brand's own profiles
+      field :account_type, "account_type"
+      # Profile URLs on a supported platform (instagram or tiktok)
+      field :profile_urls, "profile_urls"
+    end
+
+    # A brand in the curated catalog, readable by every api key.
+    class BrandCatalog
+      # Unique identifier for the brand
+      field :id, "id"
+      # Display name of the brand
+      field :title, "title"
+      # URL of the brand's logo, when one is on file
+      field :brand_logo, "brand_logo"
+      # Identifier of the brand's industry
+      field :industry_id, "industry_id"
+      # Name of the brand's industry
+      field :industry_name, "industry_name"
+      # Identifier of the brand's category
+      field :category_id, "category_id"
+      # Name of the brand's category
+      field :category_name, "category_name"
+    end
+
+    # An industry or a category, used to filter the brand catalog.
+    class BrandCatalogItem
+      # Identifier to pass as industry_id or category_id to brands.catalog
+      field :id, "id"
+      # Display name of the industry or category
+      field :name, "name"
+      # industry or category
+      field :level, "level"
+      # Industry id a category belongs to; null for an industry
+      field :parent_id, "parent_id"
+    end
+
+    # Create a sub-brand under the workspace brand.
+    class BrandCreateSubBrandRequest
+      # Plain keywords the brand monitors across platforms, matched as-is (case-...
+      field :search_terms, "search_terms"
+      # Terms that must be present for content to match
+      field :inclusion_terms, "inclusion_terms"
+      # Terms that disqualify content from matching
+      field :exclusion_terms, "exclusion_terms"
+      # Secondary inclusion terms layered on top of inclusion_terms
+      field :compound_inclusion_terms, "compound_inclusion_terms"
+      # Terms that mark matched content as influencer content
+      field :influencer_terms, "influencer_terms"
+      # ISO 639-1 codes to track, or the single value all
+      field :allowed_languages, "allowed_languages"
+      # Full-text search across the caption, transcript, summary, and hashtags
+      field :boolean_query, "boolean_query"
+      # Display name of the new sub-brand
+      field :title, "title"
+      # Type of sub-brand: COMPETITIVE or THEME
+      field :sub_brand_type, "sub_brand_type"
+    end
+
+    # The terms this brand uses to monitor social platforms.
+    class BrandKeywords
+      # Plain keywords the brand monitors across platforms, matched as-is (case-...
+      field :search_terms, "search_terms"
+      # Terms that must be present for content to match
+      field :inclusion_terms, "inclusion_terms"
+      # Terms that disqualify content from matching, even when other criteria are met
+      field :exclusion_terms, "exclusion_terms"
+      # Secondary inclusion terms layered on top of inclusion_terms
+      field :compound_inclusion_terms, "compound_inclusion_terms"
+      # Terms that mark matched content as influencer content (for example, sponsored,...
+      field :influencer_terms, "influencer_terms"
+      # ISO 639-1 codes for the languages the brand tracks
+      field :allowed_languages, "allowed_languages"
+      # Full-text search across the caption, transcript, summary, and hashtags
+      field :boolean_query, "boolean_query"
+    end
+
+    # A comment left on a piece of content.
+    class Comment
+      # Unique identifier for the comment
+      field :id, "id"
+      # The comment's text content
+      field :text, "text"
+      # The platform the comment was posted on
+      field :platform, "platform"
+      # Number of likes the comment has received
+      field :like_count, "like_count"
+      # Time the comment was posted on its platform (UTC)
+      field :posted_at, "posted_at", cast: :time
+      # Identifier of the content the comment was left on
+      field :content_id, "content_id"
+      # Identifier of the comment this is a reply to
+      field :parent_comment_id, "parent_comment_id"
+      # Whether this is a top-level comment, rather than a reply to another comment
+      field :is_parent_comment, "is_parent_comment"
+      # The creator who wrote the comment
+      field :author, "author", cast: CommentAuthor
+    end
+
+    # A short profile of the creator who wrote the comment.
+    class CommentAuthor
+      # Unique identifier for the author
+      field :id, "id"
+      # The author's username or handle on the platform (without the leading @)
+      field :username, "username"
+      # The author's display name on the platform
+      field :name, "name"
+      # URL of the author's profile picture
+      field :profile_picture_url, "profile_picture_url"
+    end
+
+    # A piece of content (a post, video, or image) and its metrics.
+    class Content
+      # Unique identifier for this piece of content
+      field :id, "id"
+      # The post's identifier on its platform
+      field :platform_post_id, "platform_post_id"
+      # The platform the content was published on
+      field :platform, "platform"
+      # Whether the content is a video or an image
+      field :content_form, "content_form"
+      # URL of the content's thumbnail image
+      field :thumbnail_url, "thumbnail_url"
+      # Time the content was originally published on its platform (UTC)
+      field :posted_at, "posted_at", cast: :time
+      # Total number of times the content has been viewed
+      field :view_count, "view_count"
+      # Total number of likes the content has received
+      field :like_count, "like_count"
+      # Total number of comments on the content
+      field :comment_count, "comment_count"
+      # Total number of times the content has been shared
+      field :share_count, "share_count"
+      # Sum of the likes, comments, and shares the content has received
+      field :total_engagement, "total_engagement"
+      # ISO 639 code of the content's primary language
+      field :language, "language"
+      # Length of the media in seconds
+      field :media_duration, "media_duration"
+      # Engagement per view (likes plus comments plus shares, divided by views)
+      field :engagement_rate, "engagement_rate"
+      # Estimated marketing value of the content, in US cents
+      field :earned_media_value_cents, "earned_media_value_cents"
+      # The creator who published the content
+      field :creator, "creator", cast: ContentCreator
+      # Identifier of the brand that the brand-specific signals on this row (is_owned,...
+      field :brand_id, "brand_id"
+      # Net promoter score for the content from the perspective of the scoped brand
+      field :net_promoter_score, "net_promoter_score"
+      # Whether the scoped brand owns the content; that is, whether it was published by...
+      field :is_owned, "is_owned"
+      # Whether the post tags the scoped brand on the platform
+      field :is_tagged, "is_tagged"
+      # Whether the scoped brand counts the content as influencer content: it matches the...
+      field :is_influencer, "is_influencer"
+      # How the scoped brand is mentioned in the content
+      field :mention_type, "mention_type"
+      # Short caption or title of the post (the primary user-visible text)
+      field :caption, "caption"
+      # Long-form description of the post
+      field :description, "description"
+      # Transcribed speech from the content's audio, when available
+      field :transcript, "transcript"
+      # Direct URL to the post on its platform
+      field :platform_url, "platform_url"
+      # Short AI-generated summary of the content
+      field :ai_summary, "ai_summary"
+      # The search term the content was most recently found by
+      field :last_keyword, "last_keyword"
+      # Hashtags used in the post, normalized to lowercase and without the leading #
+      field :hashtags, "hashtags"
+    end
+
+    # Request body for the content transcribe and AI summarize actions.
+    class ContentActionRequestRequest
+      # Identifier of the content, as returned by content.list
+      field :content_id, "content_id"
+    end
+
+    # State of a content transcribe or AI summarize request.
+    class ContentActionResponse
+      # Identifier of the content
+      field :content_id, "content_id"
+      # PENDING when the work was queued, COMPLETED when the content already has the result
+      field :status, "status"
+    end
+
+    # The creator who published the content.
+    class ContentCreator
+      # Unique identifier for the creator
+      field :id, "id"
+      # The creator's username or handle on the platform (without an @)
+      field :username, "username"
+      # The creator's display name on the platform
+      field :name, "name"
+      # The platform the creator publishes on
+      field :platform, "platform"
+      # The platform-side identifier of the creator's account
+      field :platform_handle, "platform_handle"
+      # Direct URL to the creator's profile on the platform
+      field :platform_url, "platform_url"
+      # URL of the creator's profile picture
+      field :profile_picture_url, "profile_picture_url"
+      # The creator's profile bio as it appears on the platform
+      field :profile_bio, "profile_bio"
+      # The creator's follower count as of the most recent observation
+      field :follower_count, "follower_count"
+      # Number of active content items attributed to the creator
+      field :active_content_count, "active_content_count"
+    end
+
+    # A content discovery job started for a search term.
+    class ContentDiscovery
+      # Identifier of the discovery job
+      field :id, "id"
+      # The search term the discovery job was started for
+      field :search_term, "search_term"
+      # When the discovery job was created (UTC, ISO 8601)
+      field :created_at, "created_at", cast: :time
+      # Time of the most recent change to the discovery job (UTC, ISO 8601)
+      field :updated_at, "updated_at", cast: :time
+      # Platforms the indexing job was dispatched to
+      field :platforms, "platforms"
+      # Status of the discovery job
+      field :status, "status"
+      # Whether a new indexing job was dispatched
+      field :dispatched, "dispatched"
+    end
+
+    # Request body for ``POST /api/v1/content/discovery/``.
+    class ContentDiscoveryRequestRequest
+      # The term to index content for (for example, nike running)
+      field :search_term, "search_term"
+      # Platforms to index (instagram, tiktok, youtube)
+      field :platforms, "platforms"
+    end
+
+    # Selects which content the analysis runs over. These parameters correspond one-to-one
+    # with the `content.list` filter parameters. At least one of `search`, `creator_id`,
+    # `creator_username`, `external_id`, or `brand_id` is required to scope the analysis.
+    # Supplied filters are combined with AND; min/max pairs are inclusive bounds, and
+    # dates are UTC ISO-8601 instants. When `posted_after`, `posted_before`, and
+    # `posted_within_days` are all omitted, the analysis defaults to the most recent
+    # window. The window between `posted_after` and `posted_before` must not exceed 366
+    # days. The analysis runs over the highest-ranked matching content by `order_by`, up
+    # to 500 items or the limit configured for your workspace. When `order_by` is omitted,
+    # content is ranked by `earned_media_value_cents` descending.
+    class ContentFilterInputRequest
+      # Include only content with at least this many views
+      field :view_count_min, "view_count_min"
+      # Include only content with at most this many views
+      field :view_count_max, "view_count_max"
+      # Include only content with at least this many comments
+      field :comment_count_min, "comment_count_min"
+      # Include only content with at most this many comments
+      field :comment_count_max, "comment_count_max"
+      # Include only content with at least this many likes
+      field :like_count_min, "like_count_min"
+      # Include only content with at most this many likes
+      field :like_count_max, "like_count_max"
+      # Include only content with at least this many shares
+      field :share_count_min, "share_count_min"
+      # Include only content with at most this many shares
+      field :share_count_max, "share_count_max"
+      # Minimum total engagement (likes + comments + shares)
+      field :total_engagement_min, "total_engagement_min"
+      # Maximum total engagement (likes + comments + shares)
+      field :total_engagement_max, "total_engagement_max"
+      # Minimum estimated earned media value, in cents
+      field :earned_media_value_cents_min, "earned_media_value_cents_min"
+      # Maximum estimated earned media value, in cents
+      field :earned_media_value_cents_max, "earned_media_value_cents_max"
+      # Include only content at least this many seconds long
+      field :media_duration_min, "media_duration_min"
+      # Include only content at most this many seconds long
+      field :media_duration_max, "media_duration_max"
+      # Include only content posted at or after this UTC ISO-8601 time
+      field :posted_after, "posted_after", cast: :time
+      # Include only content posted at or before this UTC ISO-8601 time
+      field :posted_before, "posted_before", cast: :time
+      # Platforms to include
+      field :platform, "platform"
+      # Language codes to include, for example en or es
+      field :language, "language"
+      # Content medium
+      field :content_form, "content_form"
+      # Full-text search across caption, transcript, and summary
+      field :search, "search"
+      # Restrict to a single creator by id (from creators.list)
+      field :creator_id, "creator_id"
+      # Restrict to an accessible brand id (from brands.list)
+      field :brand_id, "brand_id"
+      # Include only content owned by the brand
+      field :is_owned, "is_owned"
+      # Include only content where the brand is tagged
+      field :is_tagged, "is_tagged"
+      # Include only the brand's influencer content, or exclude it with false
+      field :is_influencer, "is_influencer"
+      # Platform-side post id
+      field :external_id, "external_id"
+      # Creator username substring
+      field :creator_username, "creator_username"
+      # Restrict to these mention kinds
+      field :mention_type, "mention_type"
+      # Exclude these mention kinds
+      field :mention_type_not, "mention_type_not"
+      # Include only content whose creator has at least this many followers
+      field :creator_follower_count_min, "creator_follower_count_min"
+      # Include only content whose creator has at most this many followers
+      field :creator_follower_count_max, "creator_follower_count_max"
+      # Minimum engagement as a fraction of views (e.g
+      field :engagement_rate_min, "engagement_rate_min"
+      # Maximum engagement as a fraction of views (e.g
+      field :engagement_rate_max, "engagement_rate_max"
+      # Minimum brand net promoter score for the content
+      field :net_promoter_score_min, "net_promoter_score_min"
+      # Maximum brand net promoter score for the content
+      field :net_promoter_score_max, "net_promoter_score_max"
+      # Start of the window, counted back from the current time, in days (1-365)
+      field :posted_within_days, "posted_within_days"
+      # Start of the window, counted back from the current time, in hours (1-8760)
+      field :posted_within_hours, "posted_within_hours"
+      # Sort the selected content
+      field :order_by, "order_by"
+    end
+
+    # Specifies which of the creator's content relationships feed the analysis. Flags that
+    # are omitted default to owned content only.
+    class ContentScopeRequest
+      # Whether to include content the creator originally posted
+      field :owned, "owned"
+      # Whether to include content the creator reposted
+      field :repost, "repost"
+      # Whether to include content the creator liked
+      field :liked, "liked"
+    end
+
+    # Aggregated totals for a filtered set of content.
+    class ContentStatistics
+      # Number of unique pieces of content in the filtered set
+      field :post_count, "post_count"
+      # Total views across the filtered set
+      field :total_views, "total_views"
+      # Total likes across the filtered set
+      field :total_likes, "total_likes"
+      # Total comments across the filtered set
+      field :total_comments, "total_comments"
+      # Total shares across the filtered set
+      field :total_shares, "total_shares"
+      # Total engagement (likes + comments + shares) across the filtered set
+      field :total_engagement, "total_engagement"
+      # Total estimated marketing value across the filtered set, in US cents
+      field :total_earned_media_value_cents, "total_earned_media_value_cents"
+      # Total media length in seconds across the filtered set
+      field :total_media_duration, "total_media_duration"
+      # Total engagement divided by total views across the filtered set
+      field :engagement_rate, "engagement_rate"
+      # Number of distinct creators represented in the filtered set
+      field :unique_creator_count, "unique_creator_count"
+    end
+
+    # A creator and their public profile fields.
+    class Creator
+      # Unique identifier of the creator
+      field :id, "id"
+      # The creator's username or handle on the platform, without the @
+      field :username, "username"
+      # The creator's display name on the platform
+      field :name, "name"
+      # The creator's email address when known by the platform; empty otherwise
+      field :email, "email"
+      # The platform the creator is on
+      field :platform, "platform"
+      # The platform-side identifier of the account
+      field :platform_handle, "platform_handle"
+      # The creator's follower count as of the most recent observation
+      field :follower_count, "follower_count"
+      # Number of active content items attributed to the creator
+      field :active_content_count, "active_content_count"
+      # The creator's profile bio as it appears on the platform
+      field :profile_bio, "profile_bio"
+      # Direct URL to the creator's profile on the platform
+      field :platform_url, "platform_url"
+      # URL of the creator's profile picture
+      field :profile_picture_url, "profile_picture_url"
+    end
+
+    # One creator sync job.
+    class CreatorSync
+      # Identifier of the sync job
+      field :id, "id"
+      # Time the job was created (UTC, ISO-8601)
+      field :created_at, "created_at", cast: :time
+      # Time the job was most recently modified (UTC, ISO-8601)
+      field :updated_at, "updated_at", cast: :time
+      # Identifier of the synced creator
+      field :creator_id, "creator_id"
+      # The profile URL this job syncs
+      field :profile_url, "profile_url"
+      # Where the job has got to
+      field :status, "status"
+    end
+
+    # Request body for ``POST /api/v1/creator_sync/``.
+    class CreatorSyncCreateRequest
+      # Direct URL to the creator's profile on a supported platform (tiktok, instagram,...
+      field :profile_url, "profile_url"
+    end
+
+    # A creator vetting, including its analysis runs and request settings.
+    class CreatorVetting
+      # Identifier of the vetting
+      field :id, "id"
+      # Time the vetting was created (UTC, ISO-8601)
+      field :created_at, "created_at", cast: :time
+      # Time the vetting was most recently modified (UTC, ISO-8601)
+      field :updated_at, "updated_at", cast: :time
+      # Identifier of the creator the vetting is tied to
+      field :creator_id, "creator_id"
+      # Status of the vetting
+      field :status, "status"
+      # The creator tied to this vetting
+      field :creator, "creator", cast: Creator
+      # Always CREATOR_ANALYSIS here
+      field :type, "type"
+      # Identifier of the scrape job triggered for this request
+      field :sync_job_id, "sync_job_id"
+      # The analysis runs tied to this vetting, ordered newest first
+      field :analysis, "analysis", cast: [CreatorVettingRun]
+      # The safety criteria submitted with this vetting request
+      field :safety_checks, "safety_checks"
+      # The content relationships analyzed for this creator
+      field :content_scope, "content_scope"
+    end
+
+    # Request body for ``POST /api/v1/creator/vetting/``.
+    class CreatorVettingRequest
+      # When true, re-indexes the creator even if they already exist in our database
+      field :resync_profile, "resync_profile"
+      # Direct URL to the creator's profile on a supported platform (instagram, tiktok,...
+      field :profile_url, "profile_url"
+      # The creator's content relationships to analyze
+      field :content_scope, "content_scope", cast: ContentScopeRequest
+      # Safety criteria for the AI pipeline to evaluate for this creator
+      field :safety_checks, "safety_checks", cast: [SafetyCheckRequest]
+    end
+
+    # An analysis run together with its downloadable ``result``. Returned by
+    # `creator_vetting.results` for the analysis `creator_vetting.list` points to.
+    class CreatorVettingResult
+      # Identifier of the analysis record
+      field :id, "id"
+      # The subject this analysis covers: CONTENT or COMMENT
+      field :scope, "scope"
+      # Time the analysis was created (UTC, ISO-8601)
+      field :created_at, "created_at", cast: :time
+      # Time the analysis was most recently modified (UTC, ISO-8601)
+      field :modified_at, "modified_at", cast: :time
+      # Identifier of the vetting this analysis belongs to
+      field :vetting_id, "vetting_id"
+      # Status of the analysis
+      field :status, "status"
+      # Signed, time-limited download of the run's analysis payload
+      field :result, "result", cast: ResultFile
+    end
+
+    # A lightweight analysis run that belongs to a vetting. This representation omits the
+    # ``result``. Retrieve it from `creator_vetting.results` once ``status`` is
+    # ``COMPLETED``.
+    class CreatorVettingRun
+      # Identifier of the analysis record
+      field :id, "id"
+      # The subject this analysis covers: CONTENT or COMMENT
+      field :scope, "scope"
+      # Status of the analysis
+      field :status, "status"
+    end
+
+    # One brand placement detection run.
+    class Detection
+      # Identifier of the detection
+      field :id, "id"
+      # Time the detection was created (UTC, ISO-8601)
+      field :created_at, "created_at", cast: :time
+      # Time the detection was most recently modified (UTC, ISO-8601)
+      field :updated_at, "updated_at", cast: :time
+      # Where the detection has got to
+      field :status, "status"
+      # The input this detection was created with
+      field :context, "context", cast: DetectionContext
+      # The placements document
+      field :result, "result", cast: DetectionResult
+    end
+
+    # One brand to look for, and what counts as evidence for it.
+    class DetectionBrandHint
+      # Display name of the brand, at most 60 characters
+      field :name, "name"
+      # 2 to 10 words, logos and product names that count as evidence of this brand, the...
+      field :identifiers, "identifiers"
+      # Up to 12 look-alikes that must not count, each at most 200 characters, for...
+      field :negatives, "negatives"
+    end
+
+    # One brand to look for, and what counts as evidence for it.
+    class DetectionBrandHintRequest
+      # Display name of the brand, at most 60 characters
+      field :name, "name"
+      # 2 to 10 words, logos and product names that count as evidence of this brand, the...
+      field :identifiers, "identifiers"
+      # Up to 12 look-alikes that must not count, each at most 200 characters, for...
+      field :negatives, "negatives"
+    end
+
+    # Everything found for one requested brand.
+    class DetectionBrandResult
+      # The requested brand, named exactly as it was asked for
+      field :brand_name, "brand_name"
+      # Whether the brand was present at all
+      field :found, "found"
+      # Counts for this brand
+      field :summary, "summary", cast: DetectionBrandSummary
+      # Every placement for this brand, earliest first
+      field :placements, "placements", cast: [DetectionPlacement]
+    end
+
+    # Counts for one brand.
+    class DetectionBrandSummary
+      # Placements for this brand
+      field :placements, "placements"
+      # Of those, confirmed
+      field :confirmed, "confirmed"
+      # Of those, left for review
+      field :review, "review"
+    end
+
+    # The input the detection run was given, as stored.
+    class DetectionContext
+      # URL of the content being analysed
+      field :external_url, "external_url"
+      # The brands to detect and the evidence that counts for each
+      field :hints, "hints", cast: DetectionHints
+    end
+
+    # What the caller supplies as the detection's input.
+    class DetectionContextInputRequest
+      # The brands to detect and the evidence that counts for each
+      field :hints, "hints", cast: DetectionHintsRequest
+    end
+
+    # Request body for ``POST /api/v1/detection/``.
+    class DetectionCreateRequest
+      # Identifier of content Zelf already holds, obtained from content.list
+      field :content_id, "content_id"
+      # Direct URL to the post or video to analyse
+      field :content_url, "content_url"
+      # The brands to detect and the evidence that counts for each
+      field :context, "context", cast: DetectionContextInputRequest
+    end
+
+    # What the detector is asked to look for.
+    class DetectionHints
+      # 1 to 200 brands to detect, in the order the results report them
+      field :brands, "brands", cast: [DetectionBrandHint]
+    end
+
+    # What the detector is asked to look for.
+    class DetectionHintsRequest
+      # 1 to 200 brands to detect, in the order the results report them
+      field :brands, "brands", cast: [DetectionBrandHintRequest]
+    end
+
+    # One brand present in the content at one moment, with its evidence.
+    class DetectionPlacement
+      # mm:ss-mm:ss, or mm:ss for a single moment
+      field :timestamp, "timestamp"
+      # YouTube: opens the video 5 seconds before the placement
+      field :video_url_at_timestamp, "video_url_at_timestamp"
+      # How it was detected
+      field :modality, "modality"
+      # What was observed, in the detector's own words
+      field :what_detected, "what_detected"
+      # Why the observation counts as this brand
+      field :reasoning, "reasoning"
+      # confirmed: passed a final check against the video's frames
+      field :confidence, "confidence"
+    end
+
+    # The placements document a finished detection produces.
+    class DetectionResult
+      # The content that was analysed
+      field :video, "video", cast: DetectionVideo
+      # Counts across the whole run
+      field :summary, "summary", cast: DetectionSummary
+      # One entry per requested brand, in request order, including the brands that were...
+      field :brands, "brands", cast: [DetectionBrandResult]
+    end
+
+    # Counts across the whole run.
+    class DetectionSummary
+      # How many brands the rubric asked for
+      field :brands_requested, "brands_requested"
+      # How many of those brands were present
+      field :brands_found, "brands_found"
+      # Total placements reported
+      field :placements, "placements"
+      # Placements that passed the final frame check
+      field :confirmed, "confirmed"
+      # Placements that did not pass the final frame check, including every Audio placement
+      field :review, "review"
+    end
+
+    # The content the placements were found in.
+    class DetectionVideo
+      # URL of the analysed content
+      field :video_url, "video_url"
+      # Platform the content was posted on
+      field :platform, "platform"
+      # Length of the content in seconds
+      field :duration_s, "duration_s"
+    end
+
+    # Partial update for a brand's monitoring keywords. Every field is optional, and only
+    # the supplied fields are changed, but at least one field is required.
+    class PatchedBrandUpdateRequest
+      # Plain keywords the brand monitors across platforms, matched as-is (case-...
+      field :search_terms, "search_terms"
+      # Terms that must be present for content to match
+      field :inclusion_terms, "inclusion_terms"
+      # Terms that disqualify content from matching
+      field :exclusion_terms, "exclusion_terms"
+      # Secondary inclusion terms layered on top of inclusion_terms
+      field :compound_inclusion_terms, "compound_inclusion_terms"
+      # Terms that mark matched content as influencer content
+      field :influencer_terms, "influencer_terms"
+      # ISO 639-1 codes to track, or the single value all
+      field :allowed_languages, "allowed_languages"
+      # Full-text search across the caption, transcript, summary, and hashtags
+      field :boolean_query, "boolean_query"
+      # Brand to update, specified as an id from brands.list
+      field :brand_id, "brand_id"
+    end
+
+    # The PatchedWebhookSubscriptionUpdateRequest object.
+    class PatchedWebhookSubscriptionUpdateRequest
+      # Destination URL where webhook payloads are sent
+      field :url, "url"
+      # Filters that scope which resources are delivered
+      field :resource_filters, "resource_filters"
+      # Extra HTTP headers sent with each webhook request
+      field :custom_headers, "custom_headers"
+      # Hours between snapshot deliveries
+      field :interval_hours, "interval_hours"
+      # Maximum number of items per delivery
+      field :max_items, "max_items"
+      # Whether this subscription is active and will be dispatched
+      field :enabled, "enabled"
+    end
+
+    # Signed, time-limited download of an analysis run's result payload.
+    class ResultFile
+      # Unix epoch seconds after which download_url expires
+      field :expires_at, "expires_at"
+      # Payload encoding
+      field :format, "format"
+      # Signed URL to request the JSON payload
+      field :download_url, "download_url"
+    end
+
+    # A single safety criterion the AI pipeline evaluates against the creator. Only
+    # ``type`` is required. The ``extra`` field supplies the label for the
+    # ``USER_DEFINED_SAFETY_CRITERION`` type and is ignored for the predefined types.
+    class SafetyCheckRequest
+      # Category of the safety criterion
+      field :type, "type"
+      # Label for USER_DEFINED_SAFETY_CRITERION, stored as the criterion's value
+      field :extra, "extra"
+    end
+
+    # Live consumption for the brand behind the current credentials.
+    class Usage
+      # Brand these figures belong to
+      field :brand_id, "brand_id"
+      # api_key or mcp, whichever made this call
+      field :authenticated_as, "authenticated_as"
+      # Keyed by group
+      field :scopes, "scopes"
+    end
+
+    # One metered group, with every window that has a limit.
+    class UsageScope
+      # Name of the group, as an admin sees it
+      field :human_name, "human_name"
+      # request counts calls; item counts rows returned
+      field :kind, "kind"
+      # Which product the group meters: api for direct requests, mcp for AI clients
+      field :section, "section"
+      # Keyed by window: rps, rpm, rph, rpd, rpmonth, or the item windows
+      field :windows, "windows"
+    end
+
+    # Consumption of one window, e.g. requests in the current hour.
+    class UsageWindow
+      # Most that may be spent in this window
+      field :limit, "limit"
+      # Spent so far in this window
+      field :used, "used"
+      # Still available in this window
+      field :remaining, "remaining"
+      # Seconds until the window resets
+      field :reset_in, "reset_in"
+    end
+
+    # The WebhookAvailableEvent object.
+    class WebhookAvailableEvent
+      # Event type identifier, e.g
+      field :event, "event"
+      # Human-readable grouping label
+      field :group, "group"
+      # What triggers the event and what the payload holds
+      field :description, "description"
+    end
+
+    # The carried content of a push. The populated key depends on `delivery_mode`.
+    # `manifest` deliveries populate `files` (downloadable snapshot files) and, for the
+    # content resource, `statistics`. `inline` deliveries populate `items` (the rows
+    # directly). The unused key is omitted.
+    class WebhookData
+      # Total number of rows in this delivery, summed across files or equal to the length...
+      field :item_count, "item_count"
+      # Aggregate totals over the snapshot, including post count, views, engagement,...
+      field :statistics, "statistics"
+      # Manifest mode only
+      field :files, "files", cast: [WebhookFile]
+      # Inline mode only
+      field :items, "items"
+    end
+
+    # The WebhookDeleteAcknowledgement object.
+    class WebhookDeleteAcknowledgement
+      # Always true; confirms the webhook resource delete was acknowledged
+      field :acknowledged, "acknowledged"
+      # Action that was performed
+      field :action, "action"
+      # Completion status of the action
+      field :status, "status"
+    end
+
+    # The WebhookDelivery object.
+    class WebhookDelivery
+      # Encoded identifier of the webhook delivery
+      field :id, "id"
+      # Encoded identifier of the parent subscription
+      field :subscription, "subscription"
+      # When this delivery is scheduled to be sent
+      field :scheduled_at, "scheduled_at", cast: :time
+      # Number of delivery attempts made so far
+      field :attempt_count, "attempt_count"
+      # Current state of the delivery
+      field :state, "state"
+      # HTTP status code returned by the most recent attempt
+      field :last_status_code, "last_status_code"
+      # Error message from the most recent failed attempt
+      field :last_error, "last_error"
+      # Excerpt of the response body returned by the endpoint
+      field :response_excerpt, "response_excerpt"
+      # When the delivery finished (succeeded or exhausted)
+      field :finished_at, "finished_at", cast: :time
+      # Number of items included in the delivered payload
+      field :item_count, "item_count"
+      # SHA-256 checksum of the delivered payload
+      field :sha256, "sha256"
+      # Size of the delivered payload in bytes
+      field :size_bytes, "size_bytes"
+      # Timestamp set once when the row is first created
+      field :created, "created", cast: :time
+      # Timestamp updated automatically on every save
+      field :modified, "modified", cast: :time
+    end
+
+    # One downloadable snapshot file in a manifest push. A delivery currently consists of
+    # a single file, so `files` carries one entry. The array shape allows a snapshot to be
+    # sharded across several files in the future without changing the envelope.
+    class WebhookFile
+      # File encoding
+      field :format, "format"
+      # Unix epoch seconds after which download_url stops working
+      field :expires_at, "expires_at"
+      # Hex SHA-256 of the file body
+      field :sha256, "sha256"
+      # Size of the file in bytes
+      field :size_bytes, "size_bytes"
+      # Number of rows in this file
+      field :item_count, "item_count"
+      # Signed, time-limited URL from which to retrieve the file
+      field :download_url, "download_url"
+    end
+
+    # The outer payload ZelfAI POSTs to receivers, uniform across all pushes. Top-level
+    # fields are delivery metadata and remain identical across modes. `data` carries the
+    # content; which key inside it is populated (`files` or `items`) is determined by
+    # `delivery_mode`. `manifest` deliveries use `data.files`, while `inline` event pushes
+    # use `data.items`.
+    class WebhookPush
+      # Unique id of this delivery attempt, stable across retries of the same push
+      field :id, "id"
+      # Event type
+      field :type, "type"
+      # Id of the subscription that produced this push
+      field :subscription_id, "subscription_id"
+      # Unix epoch seconds at which ZelfAI sent this push
+      field :delivered_at, "delivered_at"
+      # true for production data; false for test deliveries
+      field :livemode, "livemode"
+      # Resource the push covers (content or creator) for snapshots; null for event pushes
+      field :resource, "resource"
+      # The subscription's stored filters that scoped this snapshot, using the same query...
+      field :resource_filters, "resource_filters"
+      # manifest: data.files holds downloadable snapshot files
+      field :delivery_mode, "delivery_mode"
+      # The push payload
+      field :data, "data", cast: WebhookData
+    end
+
+    # The WebhookSecret object.
+    class WebhookSecret
+      # Encoded identifier of the webhook secret
+      field :id, "id"
+      # Type of webhook this secret applies to
+      field :kind, "kind"
+      # Non-sensitive prefix of the secret, shown for identification
+      field :secret_prefix, "secret_prefix"
+      # Whether this secret is currently active
+      field :is_active, "is_active"
+      # Whether this is the default secret for the brand and kind
+      field :is_default, "is_default"
+      # Timestamp set once when the row is first created
+      field :created, "created", cast: :time
+      # Timestamp updated automatically on every save
+      field :modified, "modified", cast: :time
+    end
+
+    # The WebhookSecretCreateRequest object.
+    class WebhookSecretCreateRequest
+      # Whether the secret is for snapshot or event webhooks
+      field :kind, "kind"
+      # Set this secret as the default for its kind
+      field :make_default, "make_default"
+    end
+
+    # The WebhookSecretCreated object.
+    class WebhookSecretCreated
+      # Encoded identifier of the webhook secret
+      field :id, "id"
+      # Type of webhook this secret applies to
+      field :kind, "kind"
+      # Non-sensitive prefix of the secret, shown for identification
+      field :secret_prefix, "secret_prefix"
+      # Whether this secret is currently active
+      field :is_active, "is_active"
+      # Whether this is the default secret for the brand and kind
+      field :is_default, "is_default"
+      # Timestamp set once when the row is first created
+      field :created, "created", cast: :time
+      # Timestamp updated automatically on every save
+      field :modified, "modified", cast: :time
+      # Full signing secret, returned only once on creation
+      field :secret, "secret"
+    end
+
+    # The WebhookSubscription object.
+    class WebhookSubscription
+      # Encoded identifier of the webhook subscription
+      field :id, "id"
+      # Type of webhook this subscription delivers
+      field :kind, "kind"
+      # Resource type the subscription is for (content or creator)
+      field :resource, "resource"
+      # Event types the subscription listens for
+      field :event_types, "event_types"
+      # Filters applied to select which resources are delivered
+      field :resource_filters, "resource_filters"
+      # Destination URL where webhook payloads are sent
+      field :url, "url"
+      # Custom HTTP headers to include with each delivery
+      field :custom_headers, "custom_headers"
+      # Hours between snapshot deliveries
+      field :interval_hours, "interval_hours"
+      # Max rows a real snapshot delivers
+      field :max_items, "max_items"
+      # Public prefix of the subscription signing secret
+      field :secret_prefix, "secret_prefix"
+      # Whether this subscription is active and will be dispatched
+      field :enabled, "enabled"
+      # When this subscription last dispatched a delivery
+      field :last_run_at, "last_run_at", cast: :time
+      # Outcome status of the most recent delivery
+      field :last_status, "last_status"
+      # Timestamp set once when the row is first created
+      field :created, "created", cast: :time
+      # Timestamp updated automatically on every save
+      field :modified, "modified", cast: :time
+    end
+
+    # The WebhookSubscriptionCreateRequest object.
+    class WebhookSubscriptionCreateRequest
+      # Whether the subscription is snapshot or event based
+      field :kind, "kind"
+      # Resource type for snapshot subscriptions
+      field :resource, "resource"
+      # Event names the subscription listens for
+      field :event_types, "event_types"
+      # Filters that scope which resources are delivered
+      field :resource_filters, "resource_filters"
+      # Destination URL where webhook payloads are sent
+      field :url, "url"
+      # Extra HTTP headers sent with each webhook request
+      field :custom_headers, "custom_headers"
+      # Hours between snapshot deliveries
+      field :interval_hours, "interval_hours"
+      # Maximum number of items per delivery
+      field :max_items, "max_items"
+      # Type of signing secret to attach to the subscription
+      field :secret_type, "secret_type"
+    end
+
+    # The WebhookSubscriptionCreated object.
+    class WebhookSubscriptionCreated
+      # Encoded identifier of the webhook subscription
+      field :id, "id"
+      # Type of webhook this subscription delivers
+      field :kind, "kind"
+      # Resource type the subscription is for (content or creator)
+      field :resource, "resource"
+      # Event types the subscription listens for
+      field :event_types, "event_types"
+      # Filters applied to select which resources are delivered
+      field :resource_filters, "resource_filters"
+      # Destination URL where webhook payloads are sent
+      field :url, "url"
+      # Custom HTTP headers to include with each delivery
+      field :custom_headers, "custom_headers"
+      # Hours between snapshot deliveries
+      field :interval_hours, "interval_hours"
+      # Max rows a real snapshot delivers
+      field :max_items, "max_items"
+      # Public prefix of the subscription signing secret
+      field :secret_prefix, "secret_prefix"
+      # Full signing secret, returned only once, at the moment it is minted
+      field :secret, "secret"
+      # Whether this subscription is active and will be dispatched
+      field :enabled, "enabled"
+      # Timestamp set once when the row is first created
+      field :created, "created", cast: :time
+    end
+
+  end
+end