vgen-apimatic-sdk 0.0.1

data/lib/videogen/models/aspect_ratio.rb

@@ -0,0 +1,105 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # Aspect ratio as a width:height pair (e.g. 16 and 9 for 16:9). Not pixel
+  # dimensions.
+  class AspectRatio < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :width
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :height
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['width'] = 'width'
+      @_hash['height'] = 'height'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(width:, height:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @width = width
+      @height = height
+      @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.
+      width = hash.key?('width') ? hash['width'] : nil
+      height = hash.key?('height') ? hash['height'] : 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.
+      AspectRatio.new(width: width,
+                      height: height,
+                      additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [AspectRatio | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.width,
+                                ->(val) { val.instance_of? Integer }) and
+            APIHelper.valid_type?(value.height,
+                                  ->(val) { val.instance_of? Integer })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['width'],
+                              ->(val) { val.instance_of? Integer }) and
+          APIHelper.valid_type?(value['height'],
+                                ->(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} width: #{@width}, height: #{@height}, 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} width: #{@width.inspect}, height: #{@height.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/videogen/models/aspect_ratio1.rb

@@ -0,0 +1,82 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # Aspect ratio for the generated video. Defaults to 16:9 when omitted.
+  class AspectRatio1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :width
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :height
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['width'] = 'width'
+      @_hash['height'] = 'height'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(width:, height:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @width = width
+      @height = height
+      @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.
+      width = hash.key?('width') ? hash['width'] : nil
+      height = hash.key?('height') ? hash['height'] : 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.
+      AspectRatio1.new(width: width,
+                       height: height,
+                       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} width: #{@width}, height: #{@height}, 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} width: #{@width.inspect}, height: #{@height.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/videogen/models/aspect_ratio2.rb

@@ -0,0 +1,82 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # Aspect ratio for the generated image. Defaults to 16:9 when omitted.
+  class AspectRatio2 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :width
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :height
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['width'] = 'width'
+      @_hash['height'] = 'height'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(width:, height:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @width = width
+      @height = height
+      @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.
+      width = hash.key?('width') ? hash['width'] : nil
+      height = hash.key?('height') ? hash['height'] : 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.
+      AspectRatio2.new(width: width,
+                       height: height,
+                       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} width: #{@width}, height: #{@height}, 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} width: #{@width.inspect}, height: #{@height.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/videogen/models/aspect_ratio4.rb

@@ -0,0 +1,83 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # Aspect ratio for the generated motion graphic. Defaults to 16:9 when
+  # omitted.
+  class AspectRatio4 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :width
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :height
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['width'] = 'width'
+      @_hash['height'] = 'height'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(width:, height:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @width = width
+      @height = height
+      @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.
+      width = hash.key?('width') ? hash['width'] : nil
+      height = hash.key?('height') ? hash['height'] : 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.
+      AspectRatio4.new(width: width,
+                       height: height,
+                       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} width: #{@width}, height: #{@height}, 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} width: #{@width.inspect}, height: #{@height.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/videogen/models/assistant_action.rb

@@ -0,0 +1,148 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # An actionable widget the assistant offered on this turn. Act on it with
+  # `POST /v1/assistants/{assistantId}/actions/{actionId}` unless `requiresApp`
+  # is true.
+  class AssistantAction < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Opaque id to pass to the act-on-action endpoint.
+    # @return [String]
+    attr_accessor :action_id
+
+    # 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.
+    # @return [AssistantActionKind]
+    attr_accessor :kind
+
+    # Human-readable label describing what acting on this will do.
+    # @return [String]
+    attr_accessor :label
+
+    # When true, this action can only be completed in the web app; open the
+    # assistant's `projectUrl` instead of calling the API.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :requires_app
+
+    # Optional extra data for rendering this action inline without opening the
+    # app.
+    # @return [AssistantActionDetail1]
+    attr_accessor :detail
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['action_id'] = 'actionId'
+      @_hash['kind'] = 'kind'
+      @_hash['label'] = 'label'
+      @_hash['requires_app'] = 'requiresApp'
+      @_hash['detail'] = 'detail'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        detail
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(action_id:, kind:, label:, requires_app:, detail: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @action_id = action_id
+      @kind = kind
+      @label = label
+      @requires_app = requires_app
+      @detail = detail unless detail == 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.
+      action_id = hash.key?('actionId') ? hash['actionId'] : nil
+      kind = hash.key?('kind') ? hash['kind'] : nil
+      label = hash.key?('label') ? hash['label'] : nil
+      requires_app = hash.key?('requiresApp') ? hash['requiresApp'] : nil
+      detail = AssistantActionDetail1.from_hash(hash['detail']) if hash['detail']
+
+      # 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.
+      AssistantAction.new(action_id: action_id,
+                          kind: kind,
+                          label: label,
+                          requires_app: requires_app,
+                          detail: detail,
+                          additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [AssistantAction | 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.kind,
+                                  ->(val) { AssistantActionKind.validate(val) }) and
+            APIHelper.valid_type?(value.label,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.requires_app,
+                                  ->(val) { val.instance_of? TrueClass or val.instance_of? FalseClass })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['actionId'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['kind'],
+                                ->(val) { AssistantActionKind.validate(val) }) and
+          APIHelper.valid_type?(value['label'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['requiresApp'],
+                                ->(val) { val.instance_of? TrueClass or val.instance_of? FalseClass })
+      )
+    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}, kind: #{@kind}, label: #{@label}, requires_app:"\
+      " #{@requires_app}, detail: #{@detail}, 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}, kind: #{@kind.inspect}, label:"\
+      " #{@label.inspect}, requires_app: #{@requires_app.inspect}, detail: #{@detail.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/videogen/models/assistant_action_detail.rb

@@ -0,0 +1,108 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # Extra data for rendering this action inline (in a chat surface or
+  # integration) without opening the web app. Fields are populated only when
+  # relevant to the action's kind; all are optional.
+  class AssistantActionDetail < 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.
+      AssistantActionDetail.new(summary: summary,
+                                credits_remaining: credits_remaining,
+                                estimated_credits: estimated_credits,
+                                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} 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