vgen-apimatic-sdk 0.0.1

data/lib/videogen/models/assistant_message_status.rb

@@ -0,0 +1,49 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # Lifecycle status of an assistant chat message. `pending` and `running` are
+  # in-progress; `succeeded`, `failed`, and `cancelled` are terminal.
+  class AssistantMessageStatus
+    ASSISTANT_MESSAGE_STATUS = [
+      # TODO: Write general description for PENDING
+      PENDING = 'pending'.freeze,
+
+      # TODO: Write general description for RUNNING
+      RUNNING = 'running'.freeze,
+
+      # TODO: Write general description for SUCCEEDED
+      SUCCEEDED = 'succeeded'.freeze,
+
+      # TODO: Write general description for FAILED
+      FAILED = 'failed'.freeze,
+
+      # TODO: Write general description for CANCELLED
+      CANCELLED = 'cancelled'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      ASSISTANT_MESSAGE_STATUS.include?(value)
+    end
+
+    def self.from_value(value, default_value = PENDING)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'pending' then PENDING
+      when 'running' then RUNNING
+      when 'succeeded' then SUCCEEDED
+      when 'failed' then FAILED
+      when 'cancelled' then CANCELLED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/videogen/models/assistant_workflow_suggestion.rb

@@ -0,0 +1,133 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # A starting-point workflow the assistant suggests for the conversation. Act
+  # on it with `POST /v1/assistants/{assistantId}/actions/{actionId}` to select
+  # the workflow and continue.
+  class AssistantWorkflowSuggestion < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Opaque id to pass to the act-on-action endpoint to select this workflow.
+    # @return [String]
+    attr_accessor :action_id
+
+    # Identifier of the suggested workflow.
+    # @return [WorkflowType1]
+    attr_accessor :workflow_type
+
+    # Short human-readable name of the suggested workflow.
+    # @return [String]
+    attr_accessor :title
+
+    # One-line explanation of what this workflow will do.
+    # @return [String]
+    attr_accessor :description
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['action_id'] = 'actionId'
+      @_hash['workflow_type'] = 'workflowType'
+      @_hash['title'] = 'title'
+      @_hash['description'] = 'description'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(action_id:, workflow_type:, title:, description:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @action_id = action_id
+      @workflow_type = workflow_type
+      @title = title
+      @description = description
+      @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.
+      action_id = hash.key?('actionId') ? hash['actionId'] : nil
+      workflow_type = hash.key?('workflowType') ? hash['workflowType'] : nil
+      title = hash.key?('title') ? hash['title'] : nil
+      description = hash.key?('description') ? hash['description'] : 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.
+      AssistantWorkflowSuggestion.new(action_id: action_id,
+                                      workflow_type: workflow_type,
+                                      title: title,
+                                      description: description,
+                                      additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [AssistantWorkflowSuggestion | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.action_id,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.workflow_type,
+                                  ->(val) { WorkflowType1.validate(val) }) and
+            APIHelper.valid_type?(value.title,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.description,
+                                  ->(val) { val.instance_of? String })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['actionId'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['workflowType'],
+                                ->(val) { WorkflowType1.validate(val) }) and
+          APIHelper.valid_type?(value['title'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['description'],
+                                ->(val) { val.instance_of? String })
+      )
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} action_id: #{@action_id}, workflow_type: #{@workflow_type}, title:"\
+      " #{@title}, description: #{@description}, 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} action_id: #{@action_id.inspect}, workflow_type: #{@workflow_type.inspect},"\
+      " title: #{@title.inspect}, description: #{@description.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/videogen/models/base_model.rb

@@ -0,0 +1,110 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # Base model.
+  # rubocop:disable all
+  class BaseModel < CoreLibrary::BaseModel
+    # Returns a Hash representation of the current object.
+    def to_hash
+      # validating the model being serialized
+      self.class.validate(self) if self.class.respond_to?(:validate)
+
+      hash = {}
+      instance_variables.each do |name|
+        value = instance_variable_get(name)
+        name = name[1..]
+        if name == 'additional_properties'
+          additional_properties = process_additional_properties(value, self.class.names)
+          hash.merge!(additional_properties)
+        else
+          key = self.class.names.key?(name) ? self.class.names[name] : name
+          optional_fields = self.class.optionals
+          nullable_fields = self.class.nullables
+          if value.nil?
+            next unless nullable_fields.include?(name)
+
+            if !optional_fields.include?(name) && !nullable_fields.include?(name)
+              raise ArgumentError,
+                    "`#{name}` cannot be nil in `#{self.class}`. Please specify a valid value."
+            end
+          end
+
+          hash[key] = nil
+          unless value.nil?
+            if respond_to?("to_custom_#{name}")
+              if (value.instance_of? Array) || (value.instance_of? Hash)
+                params = [hash, key]
+                hash[key] = send("to_custom_#{name}", *params)
+              else
+                hash[key] = send("to_custom_#{name}")
+              end
+            elsif respond_to?("to_union_type_#{name}")
+              hash[key] = send("to_union_type_#{name}")
+            elsif value.instance_of? Array
+              hash[key] = value.map { |v| v.is_a?(BaseModel) ? v.to_hash : v }
+            elsif value.instance_of? Hash
+              hash[key] = {}
+              value.each do |k, v|
+                hash[key][k] = v.is_a?(BaseModel) ? v.to_hash : v
+              end
+            else
+              hash[key] = value.is_a?(BaseModel) ? value.to_hash : value
+            end
+          end
+        end
+      end
+      hash
+    end
+
+    # Processes additional properties, ensuring no conflicts with existing properties.
+    def process_additional_properties(additional_properties, existing_prop_names)
+      hash = {}
+      additional_properties.each do |name, value|
+        check_for_conflict(name, existing_prop_names)
+
+        hash[name] = if value.is_a?(Array)
+                       process_array(value)
+                     elsif value.is_a?(Hash)
+                       process_hash(value)
+                     else
+                       process_basic_value(value)
+                     end
+      end
+      hash
+    end
+
+    # Checks if an additional property conflicts with a model's existing property.
+    def check_for_conflict(name, existing_prop_names)
+      return unless existing_prop_names.key?(name)
+
+      raise ArgumentError, "An additional property key, '#{name}' conflicts with one of the model's properties"
+    end
+
+    # Processes an array of values, recursively calling `to_hash` on BaseModel objects.
+    def process_array(value)
+      value.map { |v| v.is_a?(BaseModel) ? v.to_hash : v }
+    end
+
+    # Processes a hash of values, recursively calling `to_hash` on BaseModel objects.
+    def process_hash(value)
+      value.transform_values do |v|
+        v.is_a?(BaseModel) ? v.to_hash : v
+      end
+    end
+
+    # Processes a basic value (non-array, non-hash).
+    def process_basic_value(value)
+      value.is_a?(BaseModel) ? value.to_hash : value
+    end
+
+    # Returns a JSON representation of the curent object.
+    def to_json(options = {})
+      hash = to_hash
+      hash.to_json(options)
+    end
+  end
+  # rubocop:enable all
+end

data/lib/videogen/models/content_policy_config.rb

@@ -0,0 +1,80 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # Controls how content-policy rejections are handled during generation.
+  class ContentPolicyConfig < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Maximum number of automatic prompt rewrites to attempt after a
+    # content-policy rejection before failing. Must be an integer between 0 and
+    # 4. 0 (the default) fails on the first rejection and returns the moderation
+    # error so you can revise the prompt yourself. Higher values let the request
+    # automatically rephrase and retry the prompt.
+    # @return [Integer]
+    attr_accessor :max_prompt_rewrites
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['max_prompt_rewrites'] = 'maxPromptRewrites'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        max_prompt_rewrites
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(max_prompt_rewrites: 0, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @max_prompt_rewrites = max_prompt_rewrites unless max_prompt_rewrites == 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.
+      max_prompt_rewrites = hash['maxPromptRewrites'] ||= 0
+
+      # 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.
+      ContentPolicyConfig.new(max_prompt_rewrites: max_prompt_rewrites,
+                              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} max_prompt_rewrites: #{@max_prompt_rewrites}, 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} max_prompt_rewrites: #{@max_prompt_rewrites.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/videogen/models/create_entity_request.rb

@@ -0,0 +1,96 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # CreateEntityRequest Model.
+  class CreateEntityRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # ACTOR features a consistent character; PRODUCT features a consistent
+    # product or object; VISUAL_STYLE guides the look of generated images;
+    # SLIDESHOW_THEME is a shared slide design system (fonts, colors, layout)
+    # applied to every slide of a slideshow-to-video deck.
+    # @return [EntityEntityType]
+    attr_accessor :entity_type
+
+    # Display name.
+    # @return [String]
+    attr_accessor :name
+
+    # Optional description.
+    # @return [String]
+    attr_accessor :description
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['entity_type'] = 'entityType'
+      @_hash['name'] = 'name'
+      @_hash['description'] = 'description'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        description
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(entity_type:, name:, description: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @entity_type = entity_type
+      @name = name
+      @description = description unless description == 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.
+      entity_type = hash.key?('entityType') ? hash['entityType'] : nil
+      name = hash.key?('name') ? hash['name'] : nil
+      description = hash.key?('description') ? hash['description'] : 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.
+      CreateEntityRequest.new(entity_type: entity_type,
+                              name: name,
+                              description: description,
+                              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} entity_type: #{@entity_type}, name: #{@name}, description: #{@description},"\
+      " 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} entity_type: #{@entity_type.inspect}, name: #{@name.inspect}, description:"\
+      " #{@description.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/videogen/models/create_entity_request_entity_type.rb

@@ -0,0 +1,47 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # ACTOR features a consistent character; PRODUCT features a consistent product
+  # or object; VISUAL_STYLE guides the look of generated images; SLIDESHOW_THEME
+  # is a shared slide design system (fonts, colors, layout) applied to every
+  # slide of a slideshow-to-video deck.
+  class CreateEntityRequestEntityType
+    CREATE_ENTITY_REQUEST_ENTITY_TYPE = [
+      # TODO: Write general description for ACTOR
+      ACTOR = 'ACTOR'.freeze,
+
+      # TODO: Write general description for PRODUCT
+      PRODUCT = 'PRODUCT'.freeze,
+
+      # TODO: Write general description for VISUAL_STYLE
+      VISUAL_STYLE = 'VISUAL_STYLE'.freeze,
+
+      # TODO: Write general description for SLIDESHOW_THEME
+      SLIDESHOW_THEME = 'SLIDESHOW_THEME'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      CREATE_ENTITY_REQUEST_ENTITY_TYPE.include?(value)
+    end
+
+    def self.from_value(value, default_value = ACTOR)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'actor' then ACTOR
+      when 'product' then PRODUCT
+      when 'visual_style' then VISUAL_STYLE
+      when 'slideshow_theme' then SLIDESHOW_THEME
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/videogen/models/create_file_upload_request.rb

@@ -0,0 +1,125 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # CreateFileUploadRequest Model.
+  class CreateFileUploadRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The type of file to upload. Optional; when omitted, the type is inferred
+    # after upload processing completes.
+    # @return [FileType2]
+    attr_accessor :type
+
+    # Display name for the uploaded file.
+    # @return [String]
+    attr_accessor :display_name
+
+    # When true, the file is 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_temporary
+
+    # When true, the file is hidden from the VideoGen Media page by default. It
+    # remains accessible through the API. Defaults to false.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :hide_from_ui
+
+    # Optional pre-computed transcript for an audio or video upload, as timed
+    # `words`. When provided, transcription is skipped and caption timing
+    # matches your transcript. Ignored for non-audio/video files.
+    # @return [Transcript]
+    attr_accessor :transcript
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['type'] = 'type'
+      @_hash['display_name'] = 'displayName'
+      @_hash['is_temporary'] = 'isTemporary'
+      @_hash['hide_from_ui'] = 'hideFromUi'
+      @_hash['transcript'] = 'transcript'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        type
+        is_temporary
+        hide_from_ui
+        transcript
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        transcript
+      ]
+    end
+
+    def initialize(display_name:, type: SKIP, is_temporary: false,
+                   hide_from_ui: false, transcript: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @type = type unless type == SKIP
+      @display_name = display_name
+      @is_temporary = is_temporary unless is_temporary == SKIP
+      @hide_from_ui = hide_from_ui unless hide_from_ui == SKIP
+      @transcript = transcript unless transcript == 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.
+      display_name = hash.key?('displayName') ? hash['displayName'] : nil
+      type = hash.key?('type') ? hash['type'] : SKIP
+      is_temporary = hash['isTemporary'] ||= false
+      hide_from_ui = hash['hideFromUi'] ||= false
+      transcript = Transcript.from_hash(hash['transcript']) if hash['transcript']
+
+      # 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.
+      CreateFileUploadRequest.new(display_name: display_name,
+                                  type: type,
+                                  is_temporary: is_temporary,
+                                  hide_from_ui: hide_from_ui,
+                                  transcript: transcript,
+                                  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} type: #{@type}, display_name: #{@display_name}, is_temporary:"\
+      " #{@is_temporary}, hide_from_ui: #{@hide_from_ui}, transcript: #{@transcript},"\
+      " 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} type: #{@type.inspect}, display_name: #{@display_name.inspect},"\
+      " is_temporary: #{@is_temporary.inspect}, hide_from_ui: #{@hide_from_ui.inspect},"\
+      " transcript: #{@transcript.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end