vgen-apimatic-sdk 0.0.1

data/lib/videogen/models/generate_video_clip_request.rb

@@ -0,0 +1,297 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # At least one of `prompt`, `startFrameFileId`, `imageFileIds`,
+  # `videoFileIds`, `audioFileIds`, or `spokenDialogue` must be provided.
+  class GenerateVideoClipRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Text prompt describing the video to generate. Optional when reference
+    # media, `startFrameFileId`, or `spokenDialogue` is provided. Describe the
+    # video in plain language; any reference media you provide is incorporated
+    # automatically.
+    # @return [String]
+    attr_accessor :prompt
+
+    # Optional file id of the opening-frame still (e.g. `vg_file_...`). Upload
+    # first via `POST /v1/files/upload`. When set, this image is the first frame
+    # of the clip. If the same id also appears in `imageFileIds`, it is used
+    # only as the opening frame and dropped from the reference list. Can be the
+    # only input (prompt optional).
+    # @return [String]
+    attr_accessor :start_frame_file_id
+
+    # Optional file ids of reference images (e.g. `["vg_file_..."]`). Upload
+    # files first via `POST /v1/files/upload`, then pass the returned ids here.
+    # When provided, the images are used as visual guidance. To animate a
+    # specific still as the opening frame, pass it as `startFrameFileId`
+    # instead.
+    # @return [Array[String]]
+    attr_accessor :image_file_ids
+
+    # Optional file ids of reference videos (e.g. `["vg_file_..."]`). Upload
+    # files first via `POST /v1/files/upload`, then pass the returned ids here.
+    # They are used as motion or style guidance for the generated video.
+    # @return [Array[String]]
+    attr_accessor :video_file_ids
+
+    # Optional file ids of reference audio clips (e.g. `["vg_file_..."]`) used
+    # for lip-sync from that recording. Upload files first via `POST
+    # /v1/files/upload`, then pass the returned ids here. To have the model
+    # speak a line it generates itself, pass `spokenDialogue` instead (or in
+    # addition).
+    # @return [Array[String]]
+    attr_accessor :audio_file_ids
+
+    # Optional exact line the subject should speak as native, lip-synced speech
+    # in the generated clip. The model synthesizes the voice from this text. Can
+    # be the only input. Combine with a visual `prompt`, `startFrameFileId`, or
+    # reference media. Combine with `audioFileIds` when you also have a
+    # reference recording.
+    # @return [String]
+    attr_accessor :spoken_dialogue
+
+    # Optional natural-language description of the voice that speaks
+    # `spokenDialogue` (for example, a warm, confident young man's voice). Used
+    # when `spokenDialogue` is set. When omitted, a clear natural voice is used.
+    # @return [String]
+    attr_accessor :voice_description
+
+    # When true, the generated video is guaranteed to include audio. When false,
+    # audio may still be present. Defaults to false.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :generate_audio
+
+    # When true, the generated clip will not include a musical soundtrack.
+    # Spoken dialogue and environmental sound are still allowed. Use this when
+    # you will add background music separately (for example at the project
+    # level). Defaults to false.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :suppress_background_music
+
+    # Desired clip length in seconds. A whole number between 1 and 30. Defaults
+    # to 6 when omitted. The generated clip is clamped to the selected quality's
+    # supported range. This endpoint produces a single short clip. For longer,
+    # multi-scene, professionally edited videos, use a video workflow such as
+    # `POST /v1/workflows/script-to-video`.
+    # @return [Integer]
+    attr_accessor :duration_seconds
+
+    # Aspect ratio for the generated video. Defaults to 16:9 when omitted.
+    # @return [AspectRatio1]
+    attr_accessor :aspect_ratio
+
+    # Video generation quality tier (`LOW`, `STANDARD`, `HIGH`, or `MAX`).
+    # Optional; when omitted, your account's Default AI quality for video is
+    # used (change it at https://app.videogen.io/settings/account).
+    # @return [ModelQuality11]
+    attr_accessor :quality
+
+    # Controls how content-policy rejections are handled during generation.
+    # @return [ContentPolicyConfig]
+    attr_accessor :content_policy_config
+
+    # 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).
+    # @return [WatermarkMode]
+    attr_accessor :watermark_mode
+
+    # Number of output results to generate. Defaults to 1.
+    # @return [Integer]
+    attr_accessor :num_results
+
+    # When true, generated files are temporary. Temporary files are guaranteed
+    # to be available for 24 hours, after which they may be archived at any
+    # time. Temporary files are not analyzed (no description, transcript, or
+    # embedding will be generated), so they will not appear in search results.
+    # 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['prompt'] = 'prompt'
+      @_hash['start_frame_file_id'] = 'startFrameFileId'
+      @_hash['image_file_ids'] = 'imageFileIds'
+      @_hash['video_file_ids'] = 'videoFileIds'
+      @_hash['audio_file_ids'] = 'audioFileIds'
+      @_hash['spoken_dialogue'] = 'spokenDialogue'
+      @_hash['voice_description'] = 'voiceDescription'
+      @_hash['generate_audio'] = 'generateAudio'
+      @_hash['suppress_background_music'] = 'suppressBackgroundMusic'
+      @_hash['duration_seconds'] = 'durationSeconds'
+      @_hash['aspect_ratio'] = 'aspectRatio'
+      @_hash['quality'] = 'quality'
+      @_hash['content_policy_config'] = 'contentPolicyConfig'
+      @_hash['watermark_mode'] = 'watermarkMode'
+      @_hash['num_results'] = 'numResults'
+      @_hash['is_output_temporary'] = 'isOutputTemporary'
+      @_hash['hide_from_ui'] = 'hideFromUi'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        prompt
+        start_frame_file_id
+        image_file_ids
+        video_file_ids
+        audio_file_ids
+        spoken_dialogue
+        voice_description
+        generate_audio
+        suppress_background_music
+        duration_seconds
+        aspect_ratio
+        quality
+        content_policy_config
+        watermark_mode
+        num_results
+        is_output_temporary
+        hide_from_ui
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        duration_seconds
+      ]
+    end
+
+    def initialize(prompt: SKIP, start_frame_file_id: SKIP,
+                   image_file_ids: SKIP, video_file_ids: SKIP,
+                   audio_file_ids: SKIP, spoken_dialogue: SKIP,
+                   voice_description: SKIP, generate_audio: false,
+                   suppress_background_music: false, duration_seconds: SKIP,
+                   aspect_ratio: SKIP, quality: SKIP,
+                   content_policy_config: SKIP,
+                   watermark_mode: WatermarkMode::AUTO, num_results: 1,
+                   is_output_temporary: false, hide_from_ui: false,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @prompt = prompt unless prompt == SKIP
+      @start_frame_file_id = start_frame_file_id unless start_frame_file_id == SKIP
+      @image_file_ids = image_file_ids unless image_file_ids == SKIP
+      @video_file_ids = video_file_ids unless video_file_ids == SKIP
+      @audio_file_ids = audio_file_ids unless audio_file_ids == SKIP
+      @spoken_dialogue = spoken_dialogue unless spoken_dialogue == SKIP
+      @voice_description = voice_description unless voice_description == SKIP
+      @generate_audio = generate_audio unless generate_audio == SKIP
+      unless suppress_background_music == SKIP
+        @suppress_background_music =
+          suppress_background_music
+      end
+      @duration_seconds = duration_seconds unless duration_seconds == SKIP
+      @aspect_ratio = aspect_ratio unless aspect_ratio == SKIP
+      @quality = quality unless quality == SKIP
+      @content_policy_config = content_policy_config unless content_policy_config == SKIP
+      @watermark_mode = watermark_mode unless watermark_mode == SKIP
+      @num_results = num_results unless num_results == 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.
+      prompt = hash.key?('prompt') ? hash['prompt'] : SKIP
+      start_frame_file_id =
+        hash.key?('startFrameFileId') ? hash['startFrameFileId'] : SKIP
+      image_file_ids = hash.key?('imageFileIds') ? hash['imageFileIds'] : SKIP
+      video_file_ids = hash.key?('videoFileIds') ? hash['videoFileIds'] : SKIP
+      audio_file_ids = hash.key?('audioFileIds') ? hash['audioFileIds'] : SKIP
+      spoken_dialogue =
+        hash.key?('spokenDialogue') ? hash['spokenDialogue'] : SKIP
+      voice_description =
+        hash.key?('voiceDescription') ? hash['voiceDescription'] : SKIP
+      generate_audio = hash['generateAudio'] ||= false
+      suppress_background_music = hash['suppressBackgroundMusic'] ||= false
+      duration_seconds =
+        hash.key?('durationSeconds') ? hash['durationSeconds'] : SKIP
+      aspect_ratio = AspectRatio1.from_hash(hash['aspectRatio']) if hash['aspectRatio']
+      quality = hash.key?('quality') ? hash['quality'] : SKIP
+      content_policy_config = ContentPolicyConfig.from_hash(hash['contentPolicyConfig']) if
+        hash['contentPolicyConfig']
+      watermark_mode = hash['watermarkMode'] ||= WatermarkMode::AUTO
+      num_results = hash['numResults'] ||= 1
+      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.
+      GenerateVideoClipRequest.new(prompt: prompt,
+                                   start_frame_file_id: start_frame_file_id,
+                                   image_file_ids: image_file_ids,
+                                   video_file_ids: video_file_ids,
+                                   audio_file_ids: audio_file_ids,
+                                   spoken_dialogue: spoken_dialogue,
+                                   voice_description: voice_description,
+                                   generate_audio: generate_audio,
+                                   suppress_background_music: suppress_background_music,
+                                   duration_seconds: duration_seconds,
+                                   aspect_ratio: aspect_ratio,
+                                   quality: quality,
+                                   content_policy_config: content_policy_config,
+                                   watermark_mode: watermark_mode,
+                                   num_results: num_results,
+                                   is_output_temporary: is_output_temporary,
+                                   hide_from_ui: hide_from_ui,
+                                   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} prompt: #{@prompt}, start_frame_file_id: #{@start_frame_file_id},"\
+      " image_file_ids: #{@image_file_ids}, video_file_ids: #{@video_file_ids}, audio_file_ids:"\
+      " #{@audio_file_ids}, spoken_dialogue: #{@spoken_dialogue}, voice_description:"\
+      " #{@voice_description}, generate_audio: #{@generate_audio}, suppress_background_music:"\
+      " #{@suppress_background_music}, duration_seconds: #{@duration_seconds}, aspect_ratio:"\
+      " #{@aspect_ratio}, quality: #{@quality}, content_policy_config: #{@content_policy_config},"\
+      " watermark_mode: #{@watermark_mode}, num_results: #{@num_results}, 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} prompt: #{@prompt.inspect}, start_frame_file_id:"\
+      " #{@start_frame_file_id.inspect}, image_file_ids: #{@image_file_ids.inspect},"\
+      " video_file_ids: #{@video_file_ids.inspect}, audio_file_ids: #{@audio_file_ids.inspect},"\
+      " spoken_dialogue: #{@spoken_dialogue.inspect}, voice_description:"\
+      " #{@voice_description.inspect}, generate_audio: #{@generate_audio.inspect},"\
+      " suppress_background_music: #{@suppress_background_music.inspect}, duration_seconds:"\
+      " #{@duration_seconds.inspect}, aspect_ratio: #{@aspect_ratio.inspect}, quality:"\
+      " #{@quality.inspect}, content_policy_config: #{@content_policy_config.inspect},"\
+      " watermark_mode: #{@watermark_mode.inspect}, num_results: #{@num_results.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/get_assistant_response.rb

@@ -0,0 +1,135 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # An assistant chat and every message it currently contains.
+  class GetAssistantResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Opaque assistant chat id (e.g. `vg_asst_...`).
+    # @return [String]
+    attr_accessor :assistant_id
+
+    # Opaque project id of the project this chat belongs to (e.g.
+    # `vg_proj_...`).
+    # @return [String]
+    attr_accessor :project_id
+
+    # Deep link to open this chat's project in the VideoGen web app. Visible
+    # only to members of your team and project collaborators.
+    # @return [String]
+    attr_accessor :project_url
+
+    # Every message in the chat in chronological order (oldest first).
+    # @return [Array[Object]]
+    attr_accessor :messages
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['assistant_id'] = 'assistantId'
+      @_hash['project_id'] = 'projectId'
+      @_hash['project_url'] = 'projectUrl'
+      @_hash['messages'] = 'messages'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(assistant_id:, project_id:, project_url:, messages:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @assistant_id = assistant_id
+      @project_id = project_id
+      @project_url = project_url
+      @messages = messages
+      @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.
+      assistant_id = hash.key?('assistantId') ? hash['assistantId'] : nil
+      project_id = hash.key?('projectId') ? hash['projectId'] : nil
+      project_url = hash.key?('projectUrl') ? hash['projectUrl'] : nil
+      messages = hash.key?('messages') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:AssistantMessage22), hash['messages']
+      ) : 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.
+      GetAssistantResponse.new(assistant_id: assistant_id,
+                               project_id: project_id,
+                               project_url: project_url,
+                               messages: messages,
+                               additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [GetAssistantResponse | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.assistant_id,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.project_id,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.project_url,
+                                  ->(val) { val.instance_of? String }) and
+            UnionTypeLookUp.get(:AssistantMessage22)
+                           .validate(value.messages)
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['assistantId'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['projectId'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['projectUrl'],
+                                ->(val) { val.instance_of? String }) and
+          UnionTypeLookUp.get(:AssistantMessage22)
+                         .validate(value['messages'])
+      )
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} assistant_id: #{@assistant_id}, project_id: #{@project_id}, project_url:"\
+      " #{@project_url}, messages: #{@messages}, 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} assistant_id: #{@assistant_id.inspect}, project_id: #{@project_id.inspect},"\
+      " project_url: #{@project_url.inspect}, messages: #{@messages.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/videogen/models/get_files_response.rb

@@ -0,0 +1,102 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # GetFilesResponse Model.
+  class GetFilesResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[FileInfo]]
+    attr_accessor :files
+
+    # When true, there are more files 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['files'] = 'files'
+      @_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(files:, has_more:, next_cursor:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @files = files
+      @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
+      files = nil
+      unless hash['files'].nil?
+        files = []
+        hash['files'].each do |structure|
+          files << (FileInfo.from_hash(structure) if structure)
+        end
+      end
+
+      files = nil unless hash.key?('files')
+      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.
+      GetFilesResponse.new(files: files,
+                           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} files: #{@files}, 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} files: #{@files.inspect}, has_more: #{@has_more.inspect}, next_cursor:"\
+      " #{@next_cursor.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/videogen/models/image_asset_request.rb

@@ -0,0 +1,125 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # ImageAssetRequest Model.
+  class ImageAssetRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # File id of the source image (e.g. `vg_file_...`). Upload a file first via
+    # `POST /v1/files/upload`, then pass the returned id here.
+    # @return [String]
+    attr_accessor :image_file_id
+
+    # 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).
+    # @return [WatermarkMode]
+    attr_accessor :watermark_mode
+
+    # Number of output results to generate. Defaults to 1.
+    # @return [Integer]
+    attr_accessor :num_results
+
+    # When true, generated files are temporary. Temporary files are guaranteed
+    # to be available for 24 hours, after which they may be archived at any
+    # time. Temporary files are not analyzed (no description, transcript, or
+    # embedding will be generated), so they will not appear in search results.
+    # 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['image_file_id'] = 'imageFileId'
+      @_hash['watermark_mode'] = 'watermarkMode'
+      @_hash['num_results'] = 'numResults'
+      @_hash['is_output_temporary'] = 'isOutputTemporary'
+      @_hash['hide_from_ui'] = 'hideFromUi'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        watermark_mode
+        num_results
+        is_output_temporary
+        hide_from_ui
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(image_file_id:, watermark_mode: WatermarkMode::AUTO,
+                   num_results: 1, is_output_temporary: false,
+                   hide_from_ui: false, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @image_file_id = image_file_id
+      @watermark_mode = watermark_mode unless watermark_mode == SKIP
+      @num_results = num_results unless num_results == 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.
+      image_file_id = hash.key?('imageFileId') ? hash['imageFileId'] : nil
+      watermark_mode = hash['watermarkMode'] ||= WatermarkMode::AUTO
+      num_results = hash['numResults'] ||= 1
+      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.
+      ImageAssetRequest.new(image_file_id: image_file_id,
+                            watermark_mode: watermark_mode,
+                            num_results: num_results,
+                            is_output_temporary: is_output_temporary,
+                            hide_from_ui: hide_from_ui,
+                            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} image_file_id: #{@image_file_id}, watermark_mode: #{@watermark_mode},"\
+      " num_results: #{@num_results}, 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} image_file_id: #{@image_file_id.inspect}, watermark_mode:"\
+      " #{@watermark_mode.inspect}, num_results: #{@num_results.inspect}, is_output_temporary:"\
+      " #{@is_output_temporary.inspect}, hide_from_ui: #{@hide_from_ui.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end