vgen-apimatic-sdk 0.0.1

data/lib/videogen/models/voiceover_to_video_request.rb

@@ -0,0 +1,297 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # VoiceoverToVideoRequest Model.
+  class VoiceoverToVideoRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Opaque file id of an uploaded voiceover audio file (e.g. `vg_file_...`).
+    # Upload the file first via `POST /v1/files/upload`. Attach a pre-computed
+    # transcript at upload time (via the `transcript` field on `POST
+    # /v1/files/upload`) to skip re-transcription.
+    # @return [String]
+    attr_accessor :file_id
+
+    # Optional timed scene descriptions guiding what to show on screen during
+    # each absolute time range of the video. Ranges must be sorted by
+    # `startSeconds` and non-overlapping. Omit to let the workflow choose
+    # visuals automatically.
+    # @return [Array[SceneDescriptionRange]]
+    attr_accessor :scenes
+
+    # Aspect ratio as a width:height pair (e.g. 16 and 9 for 16:9). Not pixel
+    # dimensions.
+    # @return [AspectRatio]
+    attr_accessor :aspect_ratio
+
+    # Visual style for the generated b-roll.
+    # @return [WorkflowVisualStyle]
+    attr_accessor :visual_style
+
+    # How quickly visuals change. FAST shows more, shorter shots; SLOW holds
+    # each visual longer. Defaults to MEDIUM.
+    # @return [VisualPacing]
+    attr_accessor :visual_pacing
+
+    # Image generation quality tier for AI-generated visuals. Optional; when
+    # omitted, your account's Default AI quality for images is used (change it
+    # at https://app.videogen.io/settings/account). Only applies when
+    # `visualStyle.type` is AI_IMAGE; STOCK pulls existing footage and is
+    # unaffected.
+    # @return [ModelQuality4]
+    attr_accessor :quality
+
+    # Output language as a BCP-47 code (e.g. `en`, `es`, `fr`). Defaults to
+    # English.
+    # @return [String]
+    attr_accessor :language
+
+    # Recommended. Optional id of a built-in stock actor or an ACTOR entity
+    # (e.g. `vg_enti_...`) with an image reference. When set, narration is
+    # delivered by that actor avatar. Omit or pass `null` for voiceover without
+    # an avatar.
+    # @return [String]
+    attr_accessor :actor_entity_id
+
+    # Avatar generation quality tier. Applies when `actorEntityId` is provided.
+    # Optional; when omitted, your account's Default AI quality for avatars is
+    # used.
+    # @return [ModelQuality3]
+    attr_accessor :avatar_quality
+
+    # Caption styling. Omit to use the default style with captions shown. Pass
+    # an object to override individual style fields (any omitted field uses the
+    # default). Pass `null` to hide captions entirely.
+    # @return [WorkflowCaptionStyle]
+    attr_accessor :caption_style
+
+    # Optional file id of an uploaded logo image to overlay on the video (e.g.
+    # `vg_file_...`). Upload the image first via `POST /v1/files/upload`. Only
+    # image files are accepted.
+    # @return [String]
+    attr_accessor :logo_file_id
+
+    # Optional production notes for the AI that builds the video — visual
+    # direction for how to illustrate the voiceover (e.g. on-screen code or text
+    # to display, specific b-roll to feature, or scene-by-scene staging). Never
+    # spoken; does not change the uploaded voiceover audio or its transcript.
+    # @return [String]
+    attr_accessor :workflow_agent_context
+
+    # Optional edits applied to the project after the video is built, in order.
+    # Each action runs asynchronously; the response returns one remix action id
+    # per action. Captions and a logo are set with the `captionStyle` and
+    # `logoFileId` request fields above; recommended remix actions here are
+    # `CONVERT_IMAGES_TO_VIDEOS` to animate still images into clips, and
+    # `ADD_TRANSITIONS` to stamp transitions between sections and assets. See
+    # the [Remix actions](/remix-actions) guide.
+    # @return [Array[Object]]
+    attr_accessor :remix_actions
+
+    # When true, the video's generated OUTPUT files (AI images, video clips,
+    # voiceover audio, avatars) are created as temporary: guaranteed available
+    # for 24 hours, after which they may be archived and later deleted. This
+    # also covers files produced by post-build remix actions (e.g. generated
+    # background music, image-to-video conversions). Use this when your
+    # integration downloads or re-hosts the results itself and does not need
+    # VideoGen to retain them. The project and its metadata are unaffected.
+    # Defaults to false.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_output_temporary
+
+    # When true, generated files are hidden from the VideoGen Media page by
+    # default. They remain accessible through the API. Defaults to false.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :hide_from_ui
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['file_id'] = 'fileId'
+      @_hash['scenes'] = 'scenes'
+      @_hash['aspect_ratio'] = 'aspectRatio'
+      @_hash['visual_style'] = 'visualStyle'
+      @_hash['visual_pacing'] = 'visualPacing'
+      @_hash['quality'] = 'quality'
+      @_hash['language'] = 'language'
+      @_hash['actor_entity_id'] = 'actorEntityId'
+      @_hash['avatar_quality'] = 'avatarQuality'
+      @_hash['caption_style'] = 'captionStyle'
+      @_hash['logo_file_id'] = 'logoFileId'
+      @_hash['workflow_agent_context'] = 'workflowAgentContext'
+      @_hash['remix_actions'] = 'remixActions'
+      @_hash['is_output_temporary'] = 'isOutputTemporary'
+      @_hash['hide_from_ui'] = 'hideFromUi'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        scenes
+        aspect_ratio
+        visual_pacing
+        quality
+        language
+        actor_entity_id
+        avatar_quality
+        caption_style
+        logo_file_id
+        workflow_agent_context
+        remix_actions
+        is_output_temporary
+        hide_from_ui
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        actor_entity_id
+        caption_style
+        logo_file_id
+      ]
+    end
+
+    def initialize(file_id:, visual_style:, scenes: SKIP, aspect_ratio: SKIP,
+                   visual_pacing: VisualPacing::MEDIUM, quality: SKIP,
+                   language: SKIP, actor_entity_id: SKIP, avatar_quality: SKIP,
+                   caption_style: SKIP, logo_file_id: SKIP,
+                   workflow_agent_context: SKIP, remix_actions: SKIP,
+                   is_output_temporary: false, hide_from_ui: false,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @file_id = file_id
+      @scenes = scenes unless scenes == SKIP
+      @aspect_ratio = aspect_ratio unless aspect_ratio == SKIP
+      @visual_style = visual_style
+      @visual_pacing = visual_pacing unless visual_pacing == SKIP
+      @quality = quality unless quality == SKIP
+      @language = language unless language == SKIP
+      @actor_entity_id = actor_entity_id unless actor_entity_id == SKIP
+      @avatar_quality = avatar_quality unless avatar_quality == SKIP
+      @caption_style = caption_style unless caption_style == SKIP
+      @logo_file_id = logo_file_id unless logo_file_id == SKIP
+      @workflow_agent_context = workflow_agent_context unless workflow_agent_context == SKIP
+      @remix_actions = remix_actions unless remix_actions == SKIP
+      @is_output_temporary = is_output_temporary unless is_output_temporary == SKIP
+      @hide_from_ui = hide_from_ui unless hide_from_ui == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      file_id = hash.key?('fileId') ? hash['fileId'] : nil
+      visual_style = WorkflowVisualStyle.from_hash(hash['visualStyle']) if hash['visualStyle']
+      # Parameter is an array, so we need to iterate through it
+      scenes = nil
+      unless hash['scenes'].nil?
+        scenes = []
+        hash['scenes'].each do |structure|
+          scenes << (SceneDescriptionRange.from_hash(structure) if structure)
+        end
+      end
+
+      scenes = SKIP unless hash.key?('scenes')
+      aspect_ratio = AspectRatio.from_hash(hash['aspectRatio']) if hash['aspectRatio']
+      visual_pacing = hash['visualPacing'] ||= VisualPacing::MEDIUM
+      quality = hash.key?('quality') ? hash['quality'] : SKIP
+      language = hash.key?('language') ? hash['language'] : SKIP
+      actor_entity_id =
+        hash.key?('actorEntityId') ? hash['actorEntityId'] : SKIP
+      avatar_quality = hash.key?('avatarQuality') ? hash['avatarQuality'] : SKIP
+      caption_style = WorkflowCaptionStyle.from_hash(hash['captionStyle']) if hash['captionStyle']
+      logo_file_id = hash.key?('logoFileId') ? hash['logoFileId'] : SKIP
+      workflow_agent_context =
+        hash.key?('workflowAgentContext') ? hash['workflowAgentContext'] : SKIP
+      remix_actions = hash.key?('remixActions') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:RemixAction15), hash['remixActions']
+      ) : SKIP
+      is_output_temporary = hash['isOutputTemporary'] ||= false
+      hide_from_ui = hash['hideFromUi'] ||= false
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      VoiceoverToVideoRequest.new(file_id: file_id,
+                                  visual_style: visual_style,
+                                  scenes: scenes,
+                                  aspect_ratio: aspect_ratio,
+                                  visual_pacing: visual_pacing,
+                                  quality: quality,
+                                  language: language,
+                                  actor_entity_id: actor_entity_id,
+                                  avatar_quality: avatar_quality,
+                                  caption_style: caption_style,
+                                  logo_file_id: logo_file_id,
+                                  workflow_agent_context: workflow_agent_context,
+                                  remix_actions: remix_actions,
+                                  is_output_temporary: is_output_temporary,
+                                  hide_from_ui: hide_from_ui,
+                                  additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [VoiceoverToVideoRequest | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.file_id,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.visual_style,
+                                  ->(val) { WorkflowVisualStyle.validate(val) },
+                                  is_model_hash: true)
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['fileId'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['visualStyle'],
+                                ->(val) { WorkflowVisualStyle.validate(val) },
+                                is_model_hash: true)
+      )
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} file_id: #{@file_id}, scenes: #{@scenes}, aspect_ratio: #{@aspect_ratio},"\
+      " visual_style: #{@visual_style}, visual_pacing: #{@visual_pacing}, quality: #{@quality},"\
+      " language: #{@language}, actor_entity_id: #{@actor_entity_id}, avatar_quality:"\
+      " #{@avatar_quality}, caption_style: #{@caption_style}, logo_file_id: #{@logo_file_id},"\
+      " workflow_agent_context: #{@workflow_agent_context}, remix_actions: #{@remix_actions},"\
+      " is_output_temporary: #{@is_output_temporary}, hide_from_ui: #{@hide_from_ui},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} file_id: #{@file_id.inspect}, scenes: #{@scenes.inspect}, aspect_ratio:"\
+      " #{@aspect_ratio.inspect}, visual_style: #{@visual_style.inspect}, visual_pacing:"\
+      " #{@visual_pacing.inspect}, quality: #{@quality.inspect}, language: #{@language.inspect},"\
+      " actor_entity_id: #{@actor_entity_id.inspect}, avatar_quality: #{@avatar_quality.inspect},"\
+      " caption_style: #{@caption_style.inspect}, logo_file_id: #{@logo_file_id.inspect},"\
+      " workflow_agent_context: #{@workflow_agent_context.inspect}, remix_actions:"\
+      " #{@remix_actions.inspect}, is_output_temporary: #{@is_output_temporary.inspect},"\
+      " hide_from_ui: #{@hide_from_ui.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/videogen/models/watermark_mode.rb

@@ -0,0 +1,43 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # Controls whether the VideoGen watermark is applied to the output. `AUTO`
+  # applies the watermark unless you have a Pro plan. `VIDEO_GEN` always applies
+  # it. `NONE` removes the watermark (requires Pro; returns an error if you
+  # don't have it).
+  class WatermarkMode
+    WATERMARK_MODE = [
+      # TODO: Write general description for NONE
+      NONE = 'NONE'.freeze,
+
+      # TODO: Write general description for VIDEO_GEN
+      VIDEO_GEN = 'VIDEO_GEN'.freeze,
+
+      # TODO: Write general description for AUTO
+      AUTO = 'AUTO'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      WATERMARK_MODE.include?(value)
+    end
+
+    def self.from_value(value, default_value = NONE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'none' then NONE
+      when 'video_gen' then VIDEO_GEN
+      when 'auto' then AUTO
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/videogen/models/webhook_endpoint.rb

@@ -0,0 +1,137 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # WebhookEndpoint Model.
+  class WebhookEndpoint < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Webhook endpoint id (e.g. `ep_...`).
+    # @return [String]
+    attr_accessor :endpoint_id
+
+    # Webhook endpoint id (e.g. `ep_...`).
+    # @return [String]
+    attr_accessor :url
+
+    # Webhook endpoint id (e.g. `ep_...`).
+    # @return [Array[WebhookEventName]]
+    attr_accessor :events
+
+    # Webhook endpoint id (e.g. `ep_...`).
+    # @return [String]
+    attr_accessor :description
+
+    # Seconds since epoch (Unix timestamp) when the endpoint was created.
+    # @return [Integer]
+    attr_accessor :created_at
+
+    # HMAC secret for verifying [Standard
+    # Webhooks](https://www.standardwebhooks.com/) signatures. Only returned
+    # once on create; store it securely.
+    # @return [String]
+    attr_accessor :signing_secret
+
+    # Last four characters of the signing secret, for display purposes.
+    # @return [String]
+    attr_accessor :signing_secret_last4
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['endpoint_id'] = 'endpointId'
+      @_hash['url'] = 'url'
+      @_hash['events'] = 'events'
+      @_hash['description'] = 'description'
+      @_hash['created_at'] = 'createdAt'
+      @_hash['signing_secret'] = 'signingSecret'
+      @_hash['signing_secret_last4'] = 'signingSecretLast4'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        description
+        signing_secret
+        signing_secret_last4
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        description
+      ]
+    end
+
+    def initialize(endpoint_id:, url:, events:, created_at:, description: SKIP,
+                   signing_secret: SKIP, signing_secret_last4: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @endpoint_id = endpoint_id
+      @url = url
+      @events = events
+      @description = description unless description == SKIP
+      @created_at = created_at
+      @signing_secret = signing_secret unless signing_secret == SKIP
+      @signing_secret_last4 = signing_secret_last4 unless signing_secret_last4 == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      endpoint_id = hash.key?('endpointId') ? hash['endpointId'] : nil
+      url = hash.key?('url') ? hash['url'] : nil
+      events = hash.key?('events') ? hash['events'] : nil
+      created_at = hash.key?('createdAt') ? hash['createdAt'] : nil
+      description = hash.key?('description') ? hash['description'] : SKIP
+      signing_secret = hash.key?('signingSecret') ? hash['signingSecret'] : SKIP
+      signing_secret_last4 =
+        hash.key?('signingSecretLast4') ? hash['signingSecretLast4'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      WebhookEndpoint.new(endpoint_id: endpoint_id,
+                          url: url,
+                          events: events,
+                          created_at: created_at,
+                          description: description,
+                          signing_secret: signing_secret,
+                          signing_secret_last4: signing_secret_last4,
+                          additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} endpoint_id: #{@endpoint_id}, url: #{@url}, events: #{@events},"\
+      " description: #{@description}, created_at: #{@created_at}, signing_secret:"\
+      " #{@signing_secret}, signing_secret_last4: #{@signing_secret_last4}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} endpoint_id: #{@endpoint_id.inspect}, url: #{@url.inspect}, events:"\
+      " #{@events.inspect}, description: #{@description.inspect}, created_at:"\
+      " #{@created_at.inspect}, signing_secret: #{@signing_secret.inspect}, signing_secret_last4:"\
+      " #{@signing_secret_last4.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/videogen/models/webhook_endpoint_list_response.rb

@@ -0,0 +1,103 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # WebhookEndpointListResponse Model.
+  class WebhookEndpointListResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[WebhookEndpoint]]
+    attr_accessor :endpoints
+
+    # When true, there are more endpoints available. Pass `nextCursor` as the
+    # `cursor` query param to fetch the next page.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :has_more
+
+    # Opaque cursor to fetch the next page. `null` when `hasMore` is false.
+    # @return [String]
+    attr_accessor :next_cursor
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['endpoints'] = 'endpoints'
+      @_hash['has_more'] = 'hasMore'
+      @_hash['next_cursor'] = 'nextCursor'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        next_cursor
+      ]
+    end
+
+    def initialize(endpoints:, has_more:, next_cursor:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @endpoints = endpoints
+      @has_more = has_more
+      @next_cursor = next_cursor
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      # Parameter is an array, so we need to iterate through it
+      endpoints = nil
+      unless hash['endpoints'].nil?
+        endpoints = []
+        hash['endpoints'].each do |structure|
+          endpoints << (WebhookEndpoint.from_hash(structure) if structure)
+        end
+      end
+
+      endpoints = nil unless hash.key?('endpoints')
+      has_more = hash.key?('hasMore') ? hash['hasMore'] : nil
+      next_cursor = hash.key?('nextCursor') ? hash['nextCursor'] : nil
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      WebhookEndpointListResponse.new(endpoints: endpoints,
+                                      has_more: has_more,
+                                      next_cursor: next_cursor,
+                                      additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} endpoints: #{@endpoints}, has_more: #{@has_more}, next_cursor:"\
+      " #{@next_cursor}, additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} endpoints: #{@endpoints.inspect}, has_more: #{@has_more.inspect},"\
+      " next_cursor: #{@next_cursor.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/videogen/models/webhook_event_name.rb

@@ -0,0 +1,100 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # All webhook event types. Use when creating or listing webhook endpoints.
+  class WebhookEventName
+    WEBHOOK_EVENT_NAME = [
+      # TODO: Write general description for ENUM_TOOL_EXECUTIONSUCCEEDED
+      ENUM_TOOL_EXECUTIONSUCCEEDED = 'tool_execution.succeeded'.freeze,
+
+      # TODO: Write general description for ENUM_TOOL_EXECUTIONFAILED
+      ENUM_TOOL_EXECUTIONFAILED = 'tool_execution.failed'.freeze,
+
+      # TODO: Write general description for ENUM_TOOL_EXECUTIONCANCELLED
+      ENUM_TOOL_EXECUTIONCANCELLED = 'tool_execution.cancelled'.freeze,
+
+      # TODO: Write general description for ENUM_WORKFLOW_RUNSUCCEEDED
+      ENUM_WORKFLOW_RUNSUCCEEDED = 'workflow_run.succeeded'.freeze,
+
+      # TODO: Write general description for ENUM_WORKFLOW_RUNFAILED
+      ENUM_WORKFLOW_RUNFAILED = 'workflow_run.failed'.freeze,
+
+      # TODO: Write general description for ENUM_WORKFLOW_RUNCANCELLED
+      ENUM_WORKFLOW_RUNCANCELLED = 'workflow_run.cancelled'.freeze,
+
+      # TODO: Write general description for ENUM_PROJECT_EXPORTSUCCEEDED
+      ENUM_PROJECT_EXPORTSUCCEEDED = 'project_export.succeeded'.freeze,
+
+      # TODO: Write general description for ENUM_PROJECT_EXPORTFAILED
+      ENUM_PROJECT_EXPORTFAILED = 'project_export.failed'.freeze,
+
+      # TODO: Write general description for ENUM_PROJECT_EXPORTCANCELLED
+      ENUM_PROJECT_EXPORTCANCELLED = 'project_export.cancelled'.freeze,
+
+      # TODO: Write general description for ENUM_ASSISTANT_MESSAGESUCCEEDED
+      ENUM_ASSISTANT_MESSAGESUCCEEDED = 'assistant_message.succeeded'.freeze,
+
+      # TODO: Write general description for ENUM_ASSISTANT_MESSAGEFAILED
+      ENUM_ASSISTANT_MESSAGEFAILED = 'assistant_message.failed'.freeze,
+
+      # TODO: Write general description for ENUM_ASSISTANT_MESSAGECANCELLED
+      ENUM_ASSISTANT_MESSAGECANCELLED = 'assistant_message.cancelled'.freeze,
+
+      # TODO: Write general description for ENUM_FILEUPLOADCOMPLETED
+      ENUM_FILEUPLOADCOMPLETED = 'file.upload.completed'.freeze,
+
+      # TODO: Write general description for ENUM_FILEUPLOADFAILED
+      ENUM_FILEUPLOADFAILED = 'file.upload.failed'.freeze,
+
+      # TODO: Write general description for ENUM_FILEPLAYBACK_READY
+      ENUM_FILEPLAYBACK_READY = 'file.playback_ready'.freeze,
+
+      # TODO: Write general description for ENUM_FILEDOWNLOAD_READY
+      ENUM_FILEDOWNLOAD_READY = 'file.download_ready'.freeze,
+
+      # TODO: Write general description for ENUM_FILEANALYSIS_COMPLETED
+      ENUM_FILEANALYSIS_COMPLETED = 'file.analysis_completed'.freeze,
+
+      # TODO: Write general description for ENUM_FILEANALYSIS_FAILED
+      ENUM_FILEANALYSIS_FAILED = 'file.analysis_failed'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      WEBHOOK_EVENT_NAME.include?(value)
+    end
+
+    def self.from_value(value, default_value = ENUM_TOOL_EXECUTIONSUCCEEDED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'enum_tool_executionsucceeded' then ENUM_TOOL_EXECUTIONSUCCEEDED
+      when 'enum_tool_executionfailed' then ENUM_TOOL_EXECUTIONFAILED
+      when 'enum_tool_executioncancelled' then ENUM_TOOL_EXECUTIONCANCELLED
+      when 'enum_workflow_runsucceeded' then ENUM_WORKFLOW_RUNSUCCEEDED
+      when 'enum_workflow_runfailed' then ENUM_WORKFLOW_RUNFAILED
+      when 'enum_workflow_runcancelled' then ENUM_WORKFLOW_RUNCANCELLED
+      when 'enum_project_exportsucceeded' then ENUM_PROJECT_EXPORTSUCCEEDED
+      when 'enum_project_exportfailed' then ENUM_PROJECT_EXPORTFAILED
+      when 'enum_project_exportcancelled' then ENUM_PROJECT_EXPORTCANCELLED
+      when 'enum_assistant_messagesucceeded' then ENUM_ASSISTANT_MESSAGESUCCEEDED
+      when 'enum_assistant_messagefailed' then ENUM_ASSISTANT_MESSAGEFAILED
+      when 'enum_assistant_messagecancelled' then ENUM_ASSISTANT_MESSAGECANCELLED
+      when 'enum_fileuploadcompleted' then ENUM_FILEUPLOADCOMPLETED
+      when 'enum_fileuploadfailed' then ENUM_FILEUPLOADFAILED
+      when 'enum_fileplayback_ready' then ENUM_FILEPLAYBACK_READY
+      when 'enum_filedownload_ready' then ENUM_FILEDOWNLOAD_READY
+      when 'enum_fileanalysis_completed' then ENUM_FILEANALYSIS_COMPLETED
+      when 'enum_fileanalysis_failed' then ENUM_FILEANALYSIS_FAILED
+      else
+        default_value
+      end
+    end
+  end
+end