vgen-apimatic-sdk 0.0.1

data/lib/videogen/models/create_timeline_interchange_request.rb

@@ -0,0 +1,93 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # CreateTimelineInterchangeRequest Model.
+  class CreateTimelineInterchangeRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Editor interchange document format. `FCPXML` is Final Cut Pro (also
+    # imported by DaVinci Resolve and others). `PREMIERE_XML` is the Final Cut 7
+    # `xmeml` XML that Adobe Premiere Pro imports natively. `OTIO` is
+    # OpenTimelineIO, the vendor-neutral format. `SRT` is a SubRip caption
+    # sidecar.
+    # @return [TimelineInterchangeFormat]
+    attr_accessor :format
+
+    # How the interchange document references media. `REMOTE_URLS` produces a
+    # single document that links to signed media URLs. `BUNDLE` produces a zip
+    # containing the document plus every referenced media file, referenced by
+    # relative path, for durable offline relinking.
+    # @return [TimelineInterchangeMediaDelivery]
+    attr_accessor :media_delivery
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['format'] = 'format'
+      @_hash['media_delivery'] = 'mediaDelivery'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        format
+        media_delivery
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(format: SKIP, media_delivery: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @format = format unless format == SKIP
+      @media_delivery = media_delivery unless media_delivery == 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.
+      format = hash.key?('format') ? hash['format'] : SKIP
+      media_delivery = hash.key?('mediaDelivery') ? hash['mediaDelivery'] : 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.
+      CreateTimelineInterchangeRequest.new(format: format,
+                                           media_delivery: media_delivery,
+                                           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} format: #{@format}, media_delivery: #{@media_delivery},"\
+      " 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} format: #{@format.inspect}, media_delivery: #{@media_delivery.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/videogen/models/create_timeline_interchange_response.rb

@@ -0,0 +1,76 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # CreateTimelineInterchangeResponse Model.
+  class CreateTimelineInterchangeResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Opaque timeline interchange job id (e.g. `vg_inte_...`). Poll `GET
+    # /v1/timeline-interchange/{interchangeJobId}` for completion.
+    # @return [String]
+    attr_accessor :interchange_job_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['interchange_job_id'] = 'interchangeJobId'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(interchange_job_id:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @interchange_job_id = interchange_job_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.
+      interchange_job_id =
+        hash.key?('interchangeJobId') ? hash['interchangeJobId'] : 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.
+      CreateTimelineInterchangeResponse.new(interchange_job_id: interchange_job_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} interchange_job_id: #{@interchange_job_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} interchange_job_id: #{@interchange_job_id.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/videogen/models/create_webhook_endpoint_request.rb

@@ -0,0 +1,94 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # CreateWebhookEndpointRequest Model.
+  class CreateWebhookEndpointRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # HTTPS URL that will receive webhook POST requests.
+    # @return [String]
+    attr_accessor :url
+
+    # HTTPS URL that will receive webhook POST requests.
+    # @return [String]
+    attr_accessor :description
+
+    # Webhook event names to subscribe to. Must contain at least one event.
+    # @return [Array[WebhookEventName]]
+    attr_accessor :events
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['url'] = 'url'
+      @_hash['description'] = 'description'
+      @_hash['events'] = 'events'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        description
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        description
+      ]
+    end
+
+    def initialize(url:, events:, description: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @url = url
+      @description = description unless description == SKIP
+      @events = events
+      @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.
+      url = hash.key?('url') ? hash['url'] : nil
+      events = hash.key?('events') ? hash['events'] : 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.
+      CreateWebhookEndpointRequest.new(url: url,
+                                       events: events,
+                                       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} url: #{@url}, description: #{@description}, events: #{@events},"\
+      " 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} url: #{@url.inspect}, description: #{@description.inspect}, events:"\
+      " #{@events.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/videogen/models/end_screen_mode.rb

@@ -0,0 +1,43 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # Controls whether a short 'Made with VideoGen' end screen is appended to the
+  # output. `AUTO` appends it unless you have a Pro plan. `VIDEO_GEN` always
+  # appends it. `NONE` removes it (requires Pro; returns an error if you don't
+  # have it).
+  class EndScreenMode
+    END_SCREEN_MODE = [
+      # TODO: Write general description for NONE
+      NONE = 'NONE'.freeze,
+
+      # TODO: Write general description for VIDEO_GEN
+      VIDEO_GEN = 'VIDEO_GEN'.freeze,
+
+      # TODO: Write general description for AUTO
+      AUTO = 'AUTO'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      END_SCREEN_MODE.include?(value)
+    end
+
+    def self.from_value(value, default_value = NONE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'none' then NONE
+      when 'video_gen' then VIDEO_GEN
+      when 'auto' then AUTO
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/videogen/models/entity.rb

@@ -0,0 +1,166 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # A reusable actor, product, visual style, or slideshow theme. Attach its
+  # reference images to workflows for consistent characters, looks, and slide
+  # designs.
+  class Entity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The entity id (e.g. `vg_enti_...`).
+    # @return [String]
+    attr_accessor :entity_id
+
+    # 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. Empty string when not set.
+    # @return [String]
+    attr_accessor :description
+
+    # Voice and presenter summary for ACTOR entities. Null for non-ACTOR
+    # entities.
+    # @return [EntityActorConfig]
+    attr_accessor :actor_config
+
+    # Reference images attached to the entity.
+    # @return [Array[EntityReference]]
+    attr_accessor :references
+
+    # Seconds since epoch (Unix timestamp) when the entity was created.
+    # @return [Integer]
+    attr_accessor :created_at
+
+    # Seconds since epoch (Unix timestamp) when the entity was last updated.
+    # @return [Integer]
+    attr_accessor :updated_at
+
+    # When true, this is a VideoGen catalog entity. Built-in entities cannot be
+    # updated, archived, or have references added or removed.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_built_in
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['entity_id'] = 'entityId'
+      @_hash['entity_type'] = 'entityType'
+      @_hash['name'] = 'name'
+      @_hash['description'] = 'description'
+      @_hash['actor_config'] = 'actorConfig'
+      @_hash['references'] = 'references'
+      @_hash['created_at'] = 'createdAt'
+      @_hash['updated_at'] = 'updatedAt'
+      @_hash['is_built_in'] = 'isBuiltIn'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        actor_config
+        is_built_in
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        actor_config
+      ]
+    end
+
+    def initialize(entity_id:, entity_type:, name:, description:, references:,
+                   created_at:, updated_at:, actor_config: SKIP,
+                   is_built_in: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @entity_id = entity_id
+      @entity_type = entity_type
+      @name = name
+      @description = description
+      @actor_config = actor_config unless actor_config == SKIP
+      @references = references
+      @created_at = created_at
+      @updated_at = updated_at
+      @is_built_in = is_built_in unless is_built_in == 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_id = hash.key?('entityId') ? hash['entityId'] : nil
+      entity_type = hash.key?('entityType') ? hash['entityType'] : nil
+      name = hash.key?('name') ? hash['name'] : nil
+      description = hash.key?('description') ? hash['description'] : nil
+      # Parameter is an array, so we need to iterate through it
+      references = nil
+      unless hash['references'].nil?
+        references = []
+        hash['references'].each do |structure|
+          references << (EntityReference.from_hash(structure) if structure)
+        end
+      end
+
+      references = nil unless hash.key?('references')
+      created_at = hash.key?('createdAt') ? hash['createdAt'] : nil
+      updated_at = hash.key?('updatedAt') ? hash['updatedAt'] : nil
+      actor_config = EntityActorConfig.from_hash(hash['actorConfig']) if hash['actorConfig']
+      is_built_in = hash.key?('isBuiltIn') ? hash['isBuiltIn'] : 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.
+      Entity.new(entity_id: entity_id,
+                 entity_type: entity_type,
+                 name: name,
+                 description: description,
+                 references: references,
+                 created_at: created_at,
+                 updated_at: updated_at,
+                 actor_config: actor_config,
+                 is_built_in: is_built_in,
+                 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_id: #{@entity_id}, entity_type: #{@entity_type}, name: #{@name},"\
+      " description: #{@description}, actor_config: #{@actor_config}, references: #{@references},"\
+      " created_at: #{@created_at}, updated_at: #{@updated_at}, is_built_in: #{@is_built_in},"\
+      " 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_id: #{@entity_id.inspect}, entity_type: #{@entity_type.inspect},"\
+      " name: #{@name.inspect}, description: #{@description.inspect}, actor_config:"\
+      " #{@actor_config.inspect}, references: #{@references.inspect}, created_at:"\
+      " #{@created_at.inspect}, updated_at: #{@updated_at.inspect}, is_built_in:"\
+      " #{@is_built_in.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/videogen/models/entity_actor_config.rb

@@ -0,0 +1,101 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # Read-only voice and avatar summary for an ACTOR entity. Always null for
+  # non-ACTOR entities.
+  class EntityActorConfig < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Display name of the actor's voice when one is configured. Null otherwise.
+    # @return [String]
+    attr_accessor :voice_display_name
+
+    # True when the actor has a configured voice.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :has_voice
+
+    # True when the actor has a built-in presenter or image reference that can
+    # be used with `actorEntityId` for avatar generation.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :has_avatar_presenter
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['voice_display_name'] = 'voiceDisplayName'
+      @_hash['has_voice'] = 'hasVoice'
+      @_hash['has_avatar_presenter'] = 'hasAvatarPresenter'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        voice_display_name
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        voice_display_name
+      ]
+    end
+
+    def initialize(has_voice:, has_avatar_presenter:, voice_display_name: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @voice_display_name = voice_display_name unless voice_display_name == SKIP
+      @has_voice = has_voice
+      @has_avatar_presenter = has_avatar_presenter
+      @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.
+      has_voice = hash.key?('hasVoice') ? hash['hasVoice'] : nil
+      has_avatar_presenter =
+        hash.key?('hasAvatarPresenter') ? hash['hasAvatarPresenter'] : nil
+      voice_display_name =
+        hash.key?('voiceDisplayName') ? hash['voiceDisplayName'] : 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.
+      EntityActorConfig.new(has_voice: has_voice,
+                            has_avatar_presenter: has_avatar_presenter,
+                            voice_display_name: voice_display_name,
+                            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} voice_display_name: #{@voice_display_name}, has_voice: #{@has_voice},"\
+      " has_avatar_presenter: #{@has_avatar_presenter}, 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} voice_display_name: #{@voice_display_name.inspect}, has_voice:"\
+      " #{@has_voice.inspect}, has_avatar_presenter: #{@has_avatar_presenter.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/videogen/models/entity_archive_response.rb

@@ -0,0 +1,82 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # EntityArchiveResponse Model.
+  class EntityArchiveResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The id of the archived entity.
+    # @return [String]
+    attr_accessor :entity_id
+
+    # Always true on success.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :archived
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['entity_id'] = 'entityId'
+      @_hash['archived'] = 'archived'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(entity_id:, archived:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @entity_id = entity_id
+      @archived = archived
+      @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_id = hash.key?('entityId') ? hash['entityId'] : nil
+      archived = hash.key?('archived') ? hash['archived'] : 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.
+      EntityArchiveResponse.new(entity_id: entity_id,
+                                archived: archived,
+                                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_id: #{@entity_id}, archived: #{@archived}, 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_id: #{@entity_id.inspect}, archived: #{@archived.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end