vgen-apimatic-sdk 0.0.1

data/lib/videogen/models/assistant_action_detail1.rb

@@ -0,0 +1,117 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # Optional extra data for rendering this action inline without opening the
+  # app.
+  class AssistantActionDetail1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Human-readable summary of the proposed plan or edit (for `APPROVE_PLAN`
+    # and `APPLY_EDIT` actions).
+    # @return [String]
+    attr_accessor :summary
+
+    # Credits currently remaining on your team (for the usage/credits widget). A
+    # whole number of credits.
+    # @return [Integer]
+    attr_accessor :credits_remaining
+
+    # Estimated credit cost of the current workflow (for the cost-estimate
+    # widget). A whole number of credits.
+    # @return [Integer]
+    attr_accessor :estimated_credits
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['summary'] = 'summary'
+      @_hash['credits_remaining'] = 'creditsRemaining'
+      @_hash['estimated_credits'] = 'estimatedCredits'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        summary
+        credits_remaining
+        estimated_credits
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        summary
+        credits_remaining
+        estimated_credits
+      ]
+    end
+
+    def initialize(summary: SKIP, credits_remaining: SKIP,
+                   estimated_credits: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @summary = summary unless summary == SKIP
+      @credits_remaining = credits_remaining unless credits_remaining == SKIP
+      @estimated_credits = estimated_credits unless estimated_credits == 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.
+      summary = hash.key?('summary') ? hash['summary'] : SKIP
+      credits_remaining =
+        hash.key?('creditsRemaining') ? hash['creditsRemaining'] : SKIP
+      estimated_credits =
+        hash.key?('estimatedCredits') ? hash['estimatedCredits'] : 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.
+      AssistantActionDetail1.new(summary: summary,
+                                 credits_remaining: credits_remaining,
+                                 estimated_credits: estimated_credits,
+                                 additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [AssistantActionDetail1 | Hash] The value against the validation is performed.
+    def self.validate(value)
+      return true if value.instance_of? self
+
+      return false unless value.instance_of? Hash
+
+      true
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} summary: #{@summary}, credits_remaining: #{@credits_remaining},"\
+      " estimated_credits: #{@estimated_credits}, 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} summary: #{@summary.inspect}, credits_remaining:"\
+      " #{@credits_remaining.inspect}, estimated_credits: #{@estimated_credits.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/videogen/models/assistant_action_kind.rb

@@ -0,0 +1,52 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # Normalized category of an actionable widget the assistant offered.
+  # `APPROVE_PLAN` accepts a proposed generation plan; `APPLY_EDIT` applies a
+  # proposed edit (e.g. a rewritten script); `RUN_TOOL` runs an inline tool;
+  # `GENERATE` starts building the video; `OPEN_IN_APP` requires the full web
+  # app — open the assistant's `projectUrl` instead of acting via the API.
+  class AssistantActionKind
+    ASSISTANT_ACTION_KIND = [
+      # TODO: Write general description for APPROVE_PLAN
+      APPROVE_PLAN = 'APPROVE_PLAN'.freeze,
+
+      # TODO: Write general description for APPLY_EDIT
+      APPLY_EDIT = 'APPLY_EDIT'.freeze,
+
+      # TODO: Write general description for RUN_TOOL
+      RUN_TOOL = 'RUN_TOOL'.freeze,
+
+      # TODO: Write general description for GENERATE
+      GENERATE = 'GENERATE'.freeze,
+
+      # TODO: Write general description for OPEN_IN_APP
+      OPEN_IN_APP = 'OPEN_IN_APP'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      ASSISTANT_ACTION_KIND.include?(value)
+    end
+
+    def self.from_value(value, default_value = APPROVE_PLAN)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'approve_plan' then APPROVE_PLAN
+      when 'apply_edit' then APPLY_EDIT
+      when 'run_tool' then RUN_TOOL
+      when 'generate' then GENERATE
+      when 'open_in_app' then OPEN_IN_APP
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/videogen/models/assistant_message.rb

@@ -0,0 +1,167 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # A user-authored message in an assistant chat.
+  class AssistantMessage < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Discriminator value: user
+    # @return [String]
+    attr_reader :role
+
+    # Opaque assistant message id (e.g. `vg_mesg_...`).
+    # @return [String]
+    attr_accessor :message_id
+
+    # Lifecycle status of an assistant chat message. `pending` and `running` are
+    # in-progress; `succeeded`, `failed`, and `cancelled` are terminal.
+    # @return [AssistantMessageStatus]
+    attr_accessor :status
+
+    # The user's message text.
+    # @return [String]
+    attr_accessor :content
+
+    # Files attached to this message.
+    # @return [Array[AssistantMessageAttachment]]
+    attr_accessor :attachments
+
+    # Seconds since epoch (Unix timestamp) when the message was created.
+    # @return [Integer]
+    attr_accessor :created_at
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['role'] = 'role'
+      @_hash['message_id'] = 'messageId'
+      @_hash['status'] = 'status'
+      @_hash['content'] = 'content'
+      @_hash['attachments'] = 'attachments'
+      @_hash['created_at'] = 'createdAt'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(message_id:, status:, content:, attachments:, created_at:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @role = 'user'
+      @message_id = message_id
+      @status = status
+      @content = content
+      @attachments = attachments
+      @created_at = created_at
+      @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.
+      message_id = hash.key?('messageId') ? hash['messageId'] : nil
+      status = hash.key?('status') ? hash['status'] : nil
+      content = hash.key?('content') ? hash['content'] : nil
+      # Parameter is an array, so we need to iterate through it
+      attachments = nil
+      unless hash['attachments'].nil?
+        attachments = []
+        hash['attachments'].each do |structure|
+          attachments << (AssistantMessageAttachment.from_hash(structure) if structure)
+        end
+      end
+
+      attachments = nil unless hash.key?('attachments')
+      created_at = hash.key?('createdAt') ? hash['createdAt'] : 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.
+      AssistantMessage.new(message_id: message_id,
+                           status: status,
+                           content: content,
+                           attachments: attachments,
+                           created_at: created_at,
+                           additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [AssistantMessage | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.role,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.message_id,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.status,
+                                  ->(val) { AssistantMessageStatus.validate(val) }) and
+            APIHelper.valid_type?(value.content,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.attachments,
+                                  ->(val) { AssistantMessageAttachment.validate(val) },
+                                  is_model_hash: true,
+                                  is_inner_model_hash: true) and
+            APIHelper.valid_type?(value.created_at,
+                                  ->(val) { val.instance_of? Integer })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['role'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['messageId'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['status'],
+                                ->(val) { AssistantMessageStatus.validate(val) }) and
+          APIHelper.valid_type?(value['content'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['attachments'],
+                                ->(val) { AssistantMessageAttachment.validate(val) },
+                                is_model_hash: true,
+                                is_inner_model_hash: true) and
+          APIHelper.valid_type?(value['createdAt'],
+                                ->(val) { val.instance_of? Integer })
+      )
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} role: #{@role}, message_id: #{@message_id}, status: #{@status}, content:"\
+      " #{@content}, attachments: #{@attachments}, created_at: #{@created_at},"\
+      " 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} role: #{@role.inspect}, message_id: #{@message_id.inspect}, status:"\
+      " #{@status.inspect}, content: #{@content.inspect}, attachments: #{@attachments.inspect},"\
+      " created_at: #{@created_at.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/videogen/models/assistant_message1.rb

@@ -0,0 +1,259 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # An assistant-authored message in an assistant chat, including any
+  # suggestions or actions it offered.
+  class AssistantMessage1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Discriminator value: assistant
+    # @return [String]
+    attr_reader :role
+
+    # Opaque assistant message id (e.g. `vg_mesg_...`).
+    # @return [String]
+    attr_accessor :message_id
+
+    # Lifecycle status of an assistant chat message. `pending` and `running` are
+    # in-progress; `succeeded`, `failed`, and `cancelled` are terminal.
+    # @return [AssistantMessageStatus]
+    attr_accessor :status
+
+    # The assistant's text reply. `null` while `status` is `pending` or
+    # `running`; may be empty when the assistant only offered widgets.
+    # @return [String]
+    attr_accessor :content
+
+    # Files attached to this message.
+    # @return [Array[AssistantMessageAttachment]]
+    attr_accessor :attachments
+
+    # Workflow starting points the assistant suggested on this message. Empty
+    # when none were offered.
+    # @return [Array[AssistantWorkflowSuggestion]]
+    attr_accessor :workflow_suggestions
+
+    # Actionable widgets the assistant offered on this message (plans, edits,
+    # tools, generate). Empty when none were offered.
+    # @return [Array[AssistantAction]]
+    attr_accessor :actions
+
+    # Present when this message kicked off a workflow run (via `autoGenerate` on
+    # start, or acting on a workflow suggestion): the workflow run to poll via
+    # `GET /v1/workflows/runs/{workflowRunId}`.
+    # @return [StartWorkflowRunResponse]
+    attr_accessor :generation
+
+    # Error details. `null` unless `status` is `failed`.
+    # @return [ApiError]
+    attr_accessor :error
+
+    # Seconds since epoch (Unix timestamp) when the message was created.
+    # @return [Integer]
+    attr_accessor :created_at
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['role'] = 'role'
+      @_hash['message_id'] = 'messageId'
+      @_hash['status'] = 'status'
+      @_hash['content'] = 'content'
+      @_hash['attachments'] = 'attachments'
+      @_hash['workflow_suggestions'] = 'workflowSuggestions'
+      @_hash['actions'] = 'actions'
+      @_hash['generation'] = 'generation'
+      @_hash['error'] = 'error'
+      @_hash['created_at'] = 'createdAt'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        content
+        generation
+        error
+      ]
+    end
+
+    def initialize(message_id:, status:, content:, attachments:,
+                   workflow_suggestions:, actions:, generation:, error:,
+                   created_at:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @role = 'assistant'
+      @message_id = message_id
+      @status = status
+      @content = content
+      @attachments = attachments
+      @workflow_suggestions = workflow_suggestions
+      @actions = actions
+      @generation = generation
+      @error = error
+      @created_at = created_at
+      @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.
+      message_id = hash.key?('messageId') ? hash['messageId'] : nil
+      status = hash.key?('status') ? hash['status'] : nil
+      content = hash.key?('content') ? hash['content'] : nil
+      # Parameter is an array, so we need to iterate through it
+      attachments = nil
+      unless hash['attachments'].nil?
+        attachments = []
+        hash['attachments'].each do |structure|
+          attachments << (AssistantMessageAttachment.from_hash(structure) if structure)
+        end
+      end
+
+      attachments = nil unless hash.key?('attachments')
+      # Parameter is an array, so we need to iterate through it
+      workflow_suggestions = nil
+      unless hash['workflowSuggestions'].nil?
+        workflow_suggestions = []
+        hash['workflowSuggestions'].each do |structure|
+          workflow_suggestions << (AssistantWorkflowSuggestion.from_hash(structure) if structure)
+        end
+      end
+
+      workflow_suggestions = nil unless hash.key?('workflowSuggestions')
+      # Parameter is an array, so we need to iterate through it
+      actions = nil
+      unless hash['actions'].nil?
+        actions = []
+        hash['actions'].each do |structure|
+          actions << (AssistantAction.from_hash(structure) if structure)
+        end
+      end
+
+      actions = nil unless hash.key?('actions')
+      generation = StartWorkflowRunResponse.from_hash(hash['generation']) if hash['generation']
+      error = ApiError.from_hash(hash['error']) if hash['error']
+      created_at = hash.key?('createdAt') ? hash['createdAt'] : 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.
+      AssistantMessage1.new(message_id: message_id,
+                            status: status,
+                            content: content,
+                            attachments: attachments,
+                            workflow_suggestions: workflow_suggestions,
+                            actions: actions,
+                            generation: generation,
+                            error: error,
+                            created_at: created_at,
+                            additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [AssistantMessage1 | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.role,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.message_id,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.status,
+                                  ->(val) { AssistantMessageStatus.validate(val) }) and
+            APIHelper.valid_type?(value.content,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.attachments,
+                                  ->(val) { AssistantMessageAttachment.validate(val) },
+                                  is_model_hash: true,
+                                  is_inner_model_hash: true) and
+            APIHelper.valid_type?(value.workflow_suggestions,
+                                  ->(val) { AssistantWorkflowSuggestion.validate(val) },
+                                  is_model_hash: true,
+                                  is_inner_model_hash: true) and
+            APIHelper.valid_type?(value.actions,
+                                  ->(val) { AssistantAction.validate(val) },
+                                  is_model_hash: true,
+                                  is_inner_model_hash: true) and
+            APIHelper.valid_type?(value.generation,
+                                  ->(val) { StartWorkflowRunResponse.validate(val) },
+                                  is_model_hash: true) and
+            APIHelper.valid_type?(value.error,
+                                  ->(val) { ApiError.validate(val) },
+                                  is_model_hash: true) and
+            APIHelper.valid_type?(value.created_at,
+                                  ->(val) { val.instance_of? Integer })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['role'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['messageId'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['status'],
+                                ->(val) { AssistantMessageStatus.validate(val) }) and
+          APIHelper.valid_type?(value['content'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['attachments'],
+                                ->(val) { AssistantMessageAttachment.validate(val) },
+                                is_model_hash: true,
+                                is_inner_model_hash: true) and
+          APIHelper.valid_type?(value['workflowSuggestions'],
+                                ->(val) { AssistantWorkflowSuggestion.validate(val) },
+                                is_model_hash: true,
+                                is_inner_model_hash: true) and
+          APIHelper.valid_type?(value['actions'],
+                                ->(val) { AssistantAction.validate(val) },
+                                is_model_hash: true,
+                                is_inner_model_hash: true) and
+          APIHelper.valid_type?(value['generation'],
+                                ->(val) { StartWorkflowRunResponse.validate(val) },
+                                is_model_hash: true) and
+          APIHelper.valid_type?(value['error'],
+                                ->(val) { ApiError.validate(val) },
+                                is_model_hash: true) and
+          APIHelper.valid_type?(value['createdAt'],
+                                ->(val) { val.instance_of? Integer })
+      )
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} role: #{@role}, message_id: #{@message_id}, status: #{@status}, content:"\
+      " #{@content}, attachments: #{@attachments}, workflow_suggestions: #{@workflow_suggestions},"\
+      " actions: #{@actions}, generation: #{@generation}, error: #{@error}, created_at:"\
+      " #{@created_at}, 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} role: #{@role.inspect}, message_id: #{@message_id.inspect}, status:"\
+      " #{@status.inspect}, content: #{@content.inspect}, attachments: #{@attachments.inspect},"\
+      " workflow_suggestions: #{@workflow_suggestions.inspect}, actions: #{@actions.inspect},"\
+      " generation: #{@generation.inspect}, error: #{@error.inspect}, created_at:"\
+      " #{@created_at.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/videogen/models/assistant_message_attachment.rb

@@ -0,0 +1,101 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # A file linked to an assistant chat message.
+  class AssistantMessageAttachment < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # File id (e.g. `vg_file_...`) when the attachment is a storage file. `null`
+    # for attachments that are not resolvable storage files.
+    # @return [String]
+    attr_accessor :file_id
+
+    # Human-readable name of the attachment.
+    # @return [String]
+    attr_accessor :display_name
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['file_id'] = 'fileId'
+      @_hash['display_name'] = 'displayName'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        file_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        file_id
+      ]
+    end
+
+    def initialize(display_name:, file_id: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @file_id = file_id unless file_id == SKIP
+      @display_name = display_name
+      @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
+      file_id = hash.key?('fileId') ? hash['fileId'] : 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.
+      AssistantMessageAttachment.new(display_name: display_name,
+                                     file_id: file_id,
+                                     additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [AssistantMessageAttachment | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return APIHelper.valid_type?(value.display_name,
+                                     ->(val) { val.instance_of? String })
+      end
+
+      return false unless value.instance_of? Hash
+
+      APIHelper.valid_type?(value['displayName'],
+                            ->(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} file_id: #{@file_id}, display_name: #{@display_name},"\
+      " 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}, display_name: #{@display_name.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end