vgen-apimatic-sdk 0.0.1

data/lib/videogen/models/me_response.rb

@@ -0,0 +1,114 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # MeResponse Model.
+  class MeResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The id of the API key used to authenticate this request.
+    # @return [String]
+    attr_accessor :api_key_id
+
+    # The nickname given to the API key when it was created.
+    # @return [String]
+    attr_accessor :api_key_nickname
+
+    # The email address of the account the API key belongs to.
+    # @return [String]
+    attr_accessor :email
+
+    # The display name of the account the API key belongs to. `null` if the
+    # account has not set one.
+    # @return [String]
+    attr_accessor :display_name
+
+    # The id of the team the API key belongs to.
+    # @return [String]
+    attr_accessor :team_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['api_key_id'] = 'apiKeyId'
+      @_hash['api_key_nickname'] = 'apiKeyNickname'
+      @_hash['email'] = 'email'
+      @_hash['display_name'] = 'displayName'
+      @_hash['team_id'] = 'teamId'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        display_name
+      ]
+    end
+
+    def initialize(api_key_id:, api_key_nickname:, email:, display_name:,
+                   team_id:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @api_key_id = api_key_id
+      @api_key_nickname = api_key_nickname
+      @email = email
+      @display_name = display_name
+      @team_id = team_id
+      @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.
+      api_key_id = hash.key?('apiKeyId') ? hash['apiKeyId'] : nil
+      api_key_nickname =
+        hash.key?('apiKeyNickname') ? hash['apiKeyNickname'] : nil
+      email = hash.key?('email') ? hash['email'] : nil
+      display_name = hash.key?('displayName') ? hash['displayName'] : nil
+      team_id = hash.key?('teamId') ? hash['teamId'] : 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.
+      MeResponse.new(api_key_id: api_key_id,
+                     api_key_nickname: api_key_nickname,
+                     email: email,
+                     display_name: display_name,
+                     team_id: team_id,
+                     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} api_key_id: #{@api_key_id}, api_key_nickname: #{@api_key_nickname}, email:"\
+      " #{@email}, display_name: #{@display_name}, team_id: #{@team_id}, 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} api_key_id: #{@api_key_id.inspect}, api_key_nickname:"\
+      " #{@api_key_nickname.inspect}, email: #{@email.inspect}, display_name:"\
+      " #{@display_name.inspect}, team_id: #{@team_id.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/videogen/models/model_quality.rb

@@ -0,0 +1,51 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # AI generation quality tier, shared across every generative feature (image,
+  # video, text, and so on). `LOW` is fastest and cheapest, `STANDARD` balances
+  # quality and cost, `HIGH` is higher quality, and `MAX` is the highest
+  # quality. When a request omits the quality field, VideoGen falls back to your
+  # account's **Default AI quality** for that feature, which you can change at
+  # [Account settings](https://app.videogen.io/settings/account). Not every
+  # feature supports every tier; unsupported tiers are rejected with an error
+  # (see each field's description).
+  class ModelQuality
+    MODEL_QUALITY = [
+      # TODO: Write general description for LOW
+      LOW = 'LOW'.freeze,
+
+      # TODO: Write general description for STANDARD
+      STANDARD = 'STANDARD'.freeze,
+
+      # TODO: Write general description for HIGH
+      HIGH = 'HIGH'.freeze,
+
+      # TODO: Write general description for MAX
+      MAX = 'MAX'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      MODEL_QUALITY.include?(value)
+    end
+
+    def self.from_value(value, default_value = LOW)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'low' then LOW
+      when 'standard' then STANDARD
+      when 'high' then HIGH
+      when 'max' then MAX
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/videogen/models/model_quality1.rb

@@ -0,0 +1,47 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # Video generation quality tier for the image-to-video conversions (`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).
+  class ModelQuality1
+    MODEL_QUALITY1 = [
+      # TODO: Write general description for LOW
+      LOW = 'LOW'.freeze,
+
+      # TODO: Write general description for STANDARD
+      STANDARD = 'STANDARD'.freeze,
+
+      # TODO: Write general description for HIGH
+      HIGH = 'HIGH'.freeze,
+
+      # TODO: Write general description for MAX
+      MAX = 'MAX'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      MODEL_QUALITY1.include?(value)
+    end
+
+    def self.from_value(value, default_value = LOW)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'low' then LOW
+      when 'standard' then STANDARD
+      when 'high' then HIGH
+      when 'max' then MAX
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/videogen/models/model_quality10.rb

@@ -0,0 +1,46 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # Image generation quality tier. Optional; when omitted, your account's
+  # Default AI quality for images is used (change it at
+  # https://app.videogen.io/settings/account).
+  class ModelQuality10
+    MODEL_QUALITY10 = [
+      # TODO: Write general description for LOW
+      LOW = 'LOW'.freeze,
+
+      # TODO: Write general description for STANDARD
+      STANDARD = 'STANDARD'.freeze,
+
+      # TODO: Write general description for HIGH
+      HIGH = 'HIGH'.freeze,
+
+      # TODO: Write general description for MAX
+      MAX = 'MAX'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      MODEL_QUALITY10.include?(value)
+    end
+
+    def self.from_value(value, default_value = LOW)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'low' then LOW
+      when 'standard' then STANDARD
+      when 'high' then HIGH
+      when 'max' then MAX
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/videogen/models/model_quality11.rb

@@ -0,0 +1,46 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # 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).
+  class ModelQuality11
+    MODEL_QUALITY11 = [
+      # TODO: Write general description for LOW
+      LOW = 'LOW'.freeze,
+
+      # TODO: Write general description for STANDARD
+      STANDARD = 'STANDARD'.freeze,
+
+      # TODO: Write general description for HIGH
+      HIGH = 'HIGH'.freeze,
+
+      # TODO: Write general description for MAX
+      MAX = 'MAX'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      MODEL_QUALITY11.include?(value)
+    end
+
+    def self.from_value(value, default_value = LOW)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'low' then LOW
+      when 'standard' then STANDARD
+      when 'high' then HIGH
+      when 'max' then MAX
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/videogen/models/model_quality12.rb

@@ -0,0 +1,45 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # Avatar generation quality tier. Optional; when omitted, your account's
+  # Default AI quality for avatars is used.
+  class ModelQuality12
+    MODEL_QUALITY12 = [
+      # TODO: Write general description for LOW
+      LOW = 'LOW'.freeze,
+
+      # TODO: Write general description for STANDARD
+      STANDARD = 'STANDARD'.freeze,
+
+      # TODO: Write general description for HIGH
+      HIGH = 'HIGH'.freeze,
+
+      # TODO: Write general description for MAX
+      MAX = 'MAX'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      MODEL_QUALITY12.include?(value)
+    end
+
+    def self.from_value(value, default_value = LOW)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'low' then LOW
+      when 'standard' then STANDARD
+      when 'high' then HIGH
+      when 'max' then MAX
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/videogen/models/model_quality13.rb

@@ -0,0 +1,46 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # Text generation quality tier. Optional; when omitted, your account's Default
+  # AI quality for text is used (change it at
+  # https://app.videogen.io/settings/account).
+  class ModelQuality13
+    MODEL_QUALITY13 = [
+      # TODO: Write general description for LOW
+      LOW = 'LOW'.freeze,
+
+      # TODO: Write general description for STANDARD
+      STANDARD = 'STANDARD'.freeze,
+
+      # TODO: Write general description for HIGH
+      HIGH = 'HIGH'.freeze,
+
+      # TODO: Write general description for MAX
+      MAX = 'MAX'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      MODEL_QUALITY13.include?(value)
+    end
+
+    def self.from_value(value, default_value = LOW)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'low' then LOW
+      when 'standard' then STANDARD
+      when 'high' then HIGH
+      when 'max' then MAX
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/videogen/models/model_quality2.rb

@@ -0,0 +1,46 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # Image generation quality tier for the restyled images. Optional; when
+  # omitted, your account's Default AI quality for images is used (change it at
+  # https://app.videogen.io/settings/account).
+  class ModelQuality2
+    MODEL_QUALITY2 = [
+      # TODO: Write general description for LOW
+      LOW = 'LOW'.freeze,
+
+      # TODO: Write general description for STANDARD
+      STANDARD = 'STANDARD'.freeze,
+
+      # TODO: Write general description for HIGH
+      HIGH = 'HIGH'.freeze,
+
+      # TODO: Write general description for MAX
+      MAX = 'MAX'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      MODEL_QUALITY2.include?(value)
+    end
+
+    def self.from_value(value, default_value = LOW)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'low' then LOW
+      when 'standard' then STANDARD
+      when 'high' then HIGH
+      when 'max' then MAX
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/videogen/models/model_quality3.rb

@@ -0,0 +1,46 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # Avatar generation quality tier. Applies when `actorEntityId` is provided.
+  # Optional; when omitted, your account's Default AI quality for avatars is
+  # used.
+  class ModelQuality3
+    MODEL_QUALITY3 = [
+      # TODO: Write general description for LOW
+      LOW = 'LOW'.freeze,
+
+      # TODO: Write general description for STANDARD
+      STANDARD = 'STANDARD'.freeze,
+
+      # TODO: Write general description for HIGH
+      HIGH = 'HIGH'.freeze,
+
+      # TODO: Write general description for MAX
+      MAX = 'MAX'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      MODEL_QUALITY3.include?(value)
+    end
+
+    def self.from_value(value, default_value = LOW)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'low' then LOW
+      when 'standard' then STANDARD
+      when 'high' then HIGH
+      when 'max' then MAX
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/videogen/models/model_quality4.rb

@@ -0,0 +1,48 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # 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.
+  class ModelQuality4
+    MODEL_QUALITY4 = [
+      # TODO: Write general description for LOW
+      LOW = 'LOW'.freeze,
+
+      # TODO: Write general description for STANDARD
+      STANDARD = 'STANDARD'.freeze,
+
+      # TODO: Write general description for HIGH
+      HIGH = 'HIGH'.freeze,
+
+      # TODO: Write general description for MAX
+      MAX = 'MAX'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      MODEL_QUALITY4.include?(value)
+    end
+
+    def self.from_value(value, default_value = LOW)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'low' then LOW
+      when 'standard' then STANDARD
+      when 'high' then HIGH
+      when 'max' then MAX
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/videogen/models/model_quality9.rb

@@ -0,0 +1,47 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # Video generation quality tier (`LOW`, `STANDARD`, `HIGH`, or `MAX`). Also
+  # used for the opening-frame image. Optional; when omitted, your account's
+  # Default AI quality for video is used (change it at
+  # https://app.videogen.io/settings/account).
+  class ModelQuality9
+    MODEL_QUALITY9 = [
+      # TODO: Write general description for LOW
+      LOW = 'LOW'.freeze,
+
+      # TODO: Write general description for STANDARD
+      STANDARD = 'STANDARD'.freeze,
+
+      # TODO: Write general description for HIGH
+      HIGH = 'HIGH'.freeze,
+
+      # TODO: Write general description for MAX
+      MAX = 'MAX'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      MODEL_QUALITY9.include?(value)
+    end
+
+    def self.from_value(value, default_value = LOW)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'low' then LOW
+      when 'standard' then STANDARD
+      when 'high' then HIGH
+      when 'max' then MAX
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/videogen/models/motion_graphic_sub_tool_mode.rb

@@ -0,0 +1,44 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # Access mode for a motion graphic capability. AUTO uses the capability only
+  # when it is available on your plan (generated video clips require a paid
+  # plan). ENABLED forces the capability on and returns an upgrade error if your
+  # plan lacks it. DISABLED prevents the motion graphic from using the
+  # capability.
+  class MotionGraphicSubToolMode
+    MOTION_GRAPHIC_SUB_TOOL_MODE = [
+      # TODO: Write general description for AUTO
+      AUTO = 'AUTO'.freeze,
+
+      # TODO: Write general description for ENABLED
+      ENABLED = 'ENABLED'.freeze,
+
+      # TODO: Write general description for DISABLED
+      DISABLED = 'DISABLED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      MOTION_GRAPHIC_SUB_TOOL_MODE.include?(value)
+    end
+
+    def self.from_value(value, default_value = AUTO)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'auto' then AUTO
+      when 'enabled' then ENABLED
+      when 'disabled' then DISABLED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/videogen/models/motion_graphic_sub_tool_mode1.rb

@@ -0,0 +1,40 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # Whether the motion graphic may generate images. Defaults to AUTO.
+  class MotionGraphicSubToolMode1
+    MOTION_GRAPHIC_SUB_TOOL_MODE1 = [
+      # TODO: Write general description for AUTO
+      AUTO = 'AUTO'.freeze,
+
+      # TODO: Write general description for ENABLED
+      ENABLED = 'ENABLED'.freeze,
+
+      # TODO: Write general description for DISABLED
+      DISABLED = 'DISABLED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      MOTION_GRAPHIC_SUB_TOOL_MODE1.include?(value)
+    end
+
+    def self.from_value(value, default_value = AUTO)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'auto' then AUTO
+      when 'enabled' then ENABLED
+      when 'disabled' then DISABLED
+      else
+        default_value
+      end
+    end
+  end
+end