From 29d7c48a1dbadc252006dafb9eb591fa2bb9881f Mon Sep 17 00:00:00 2001 From: dazzatronus <181476274+dazzatronus@users.noreply.github.com> Date: Tue, 12 May 2026 10:04:41 +0000 Subject: [PATCH] chore: regenerate SDK from @shotstack/schemas v1.11.0 --- .oas-version | 2 +- lib/shotstack/models/asset.rb | 2 + lib/shotstack/models/html5_asset.rb | 294 +++++++++++++++++++ lib/shotstack/models/rich_caption_asset.rb | 4 +- lib/shotstack/models/rich_text_background.rb | 20 +- lib/shotstack/models/text_background.rb | 18 +- lib/shotstack/version.rb | 2 +- 7 files changed, 330 insertions(+), 12 deletions(-) create mode 100644 lib/shotstack/models/html5_asset.rb diff --git a/.oas-version b/.oas-version index 18b3114..1cac385 100644 --- a/.oas-version +++ b/.oas-version @@ -1 +1 @@ -1.10.4 +1.11.0 diff --git a/lib/shotstack/models/asset.rb b/lib/shotstack/models/asset.rb index 59182bb..550a5da 100644 --- a/lib/shotstack/models/asset.rb +++ b/lib/shotstack/models/asset.rb @@ -22,6 +22,7 @@ def openapi_one_of [ :'AudioAsset', :'CaptionAsset', + :'Html5Asset', :'HtmlAsset', :'ImageAsset', :'ImageToVideoAsset', @@ -49,6 +50,7 @@ def openapi_discriminator_mapping :'audio' => :'AudioAsset', :'caption' => :'CaptionAsset', :'html' => :'HtmlAsset', + :'html5' => :'Html5Asset', :'image' => :'ImageAsset', :'image-to-video' => :'ImageToVideoAsset', :'luma' => :'LumaAsset', diff --git a/lib/shotstack/models/html5_asset.rb b/lib/shotstack/models/html5_asset.rb new file mode 100644 index 0000000..8e18c7d --- /dev/null +++ b/lib/shotstack/models/html5_asset.rb @@ -0,0 +1,294 @@ +=begin +#Shotstack + +# Official Ruby SDK for the Shotstack Cloud Video Editing API + +The version of the OpenAPI document: v1 + +Generated by: https://openapi-generator.tech +Generator version: 7.4.0 + +=end + +require 'date' +require 'time' + +module Shotstack + # The Html5Asset renders full HTML5/CSS3/JS. + class Html5Asset + # The type of asset - set to `html5` for HTML5/CSS3/JS. + attr_accessor :type + + # The HTML markup for the asset. + attr_accessor :html + + # The CSS string applied to the HTML. + attr_accessor :css + + # Optional JavaScript. Use for chart libraries, animations, or DOM manipulation. `gsap`, `d3`, `anime` and `lottie` are always available. CSS animations, transitions, and `Element.animate()` are also captured automatically. + attr_accessor :js + + class EnumAttributeValidator + attr_reader :datatype + attr_reader :allowable_values + + def initialize(datatype, allowable_values) + @allowable_values = allowable_values.map do |value| + case datatype.to_s + when /Integer/i + value.to_i + when /Float/i + value.to_f + else + value + end + end + end + + def valid?(value) + !value || allowable_values.include?(value) + end + end + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'type' => :'type', + :'html' => :'html', + :'css' => :'css', + :'js' => :'js' + } + end + + # Returns all the JSON keys this model knows about + def self.acceptable_attributes + attribute_map.values + end + + # Attribute type mapping. + def self.openapi_types + { + :'type' => :'String', + :'html' => :'String', + :'css' => :'String', + :'js' => :'String' + } + end + + # List of attributes with nullable: true + def self.openapi_nullable + Set.new([ + ]) + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `Shotstack::Html5Asset` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.attribute_map.key?(k.to_sym)) + fail ArgumentError, "`#{k}` is not a valid attribute in `Shotstack::Html5Asset`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'type') + self.type = attributes[:'type'] + else + self.type = 'html5' + end + + if attributes.key?(:'html') + self.html = attributes[:'html'] + else + self.html = nil + end + + if attributes.key?(:'css') + self.css = attributes[:'css'] + end + + if attributes.key?(:'js') + self.js = attributes[:'js'] + end + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + warn '[DEPRECATED] the `list_invalid_properties` method is obsolete' + invalid_properties = Array.new + if @type.nil? + invalid_properties.push('invalid value for "type", type cannot be nil.') + end + + if @html.nil? + invalid_properties.push('invalid value for "html", html cannot be nil.') + end + + invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + warn '[DEPRECATED] the `valid?` method is obsolete' + return false if @type.nil? + type_validator = EnumAttributeValidator.new('String', ["html5"]) + return false unless type_validator.valid?(@type) + return false if @html.nil? + true + end + + # Custom attribute writer method checking allowed values (enum). + # @param [Object] type Object to be assigned + def type=(type) + validator = EnumAttributeValidator.new('String', ["html5"]) + unless validator.valid?(type) + fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}." + end + @type = type + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + type == o.type && + html == o.html && + css == o.css && + js == o.js + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + def hash + [type, html, css, js].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def self.build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + attributes = attributes.transform_keys(&:to_sym) + transformed_hash = {} + openapi_types.each_pair do |key, type| + if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil? + transformed_hash["#{key}"] = nil + elsif type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the attribute + # is documented as an array but the input is not + if attributes[attribute_map[key]].is_a?(Array) + transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) } + end + elsif !attributes[attribute_map[key]].nil? + transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]]) + end + end + new(transformed_hash) + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def self._deserialize(type, value) + case type.to_sym + when :Time + Time.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :Boolean + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + # models (e.g. Pet) or oneOf + klass = Shotstack.const_get(type) + klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash + hash = {} + self.class.attribute_map.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + is_nullable = self.class.openapi_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value) + if value.is_a?(Array) + value.compact.map { |v| _to_hash(v) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v) } + end + elsif value.respond_to? :to_hash + value.to_hash + else + value + end + end + + end + +end diff --git a/lib/shotstack/models/rich_caption_asset.rb b/lib/shotstack/models/rich_caption_asset.rb index b1adfb8..6f97c08 100644 --- a/lib/shotstack/models/rich_caption_asset.rb +++ b/lib/shotstack/models/rich_caption_asset.rb @@ -14,12 +14,12 @@ require 'time' module Shotstack - # The RichCaptionAsset provides word-level caption animations with rich-text styling. It supports karaoke-style highlighting, word-by-word animations, and advanced typography. Use with SRT/VTT files or auto-transcription via aliases. + # The RichCaptionAsset provides word-level caption animations with rich-text styling. It supports karaoke-style highlighting, word-by-word animations, and advanced typography. Captions can be sourced from SRT/VTT/TTML subtitle files, from audio/video media URLs (auto-transcribed), or from alias references to other clips in the same timeline. class RichCaptionAsset # The type of asset - set to `rich-caption` for rich captions. attr_accessor :type - # The URL to an SRT or VTT subtitles file, or an alias reference to auto-generate captions from an audio or video clip. For file URLs, the URL must be publicly accessible or include credentials. For auto-captioning, use the format `alias://clip-name` where clip-name is the alias of an audio, video, or text-to-speech clip. + # Source for the caption words. Accepts three formats: (1) the URL to a subtitle file (`.srt`, `.vtt`, `.ttml`, or `.dfxp`) which is parsed directly; (2) the URL to an audio or video media file (`.mp4`, `.mov`, `.webm`, `.mp3`, `.wav`, `.m4a`, `.flac`, `.aac`, `.ogg`, and related formats) which is auto-transcribed; (3) an alias reference in the form `alias://clip-name` where `clip-name` is the alias of another audio, video, or text-to-speech clip in the same timeline — the referenced clip's source is auto-transcribed. For file URLs, the URL must be publicly accessible or include credentials. Content is classified at runtime and unsupported content types (HTML, PDF, images, archives) are rejected with a structured error. attr_accessor :src attr_accessor :font diff --git a/lib/shotstack/models/rich_text_background.rb b/lib/shotstack/models/rich_text_background.rb index 1df053c..677c853 100644 --- a/lib/shotstack/models/rich_text_background.rb +++ b/lib/shotstack/models/rich_text_background.rb @@ -25,12 +25,16 @@ class RichTextBackground # The border radius of the background box in pixels. Must be 0 or greater. attr_accessor :border_radius + # When true, the background pill shrinks to fit the rendered text bounding box plus the asset's padding (and stroke width, if present), producing a pill or badge effect. When false (default), the background fills the full asset content area. Available on rich-text and rich-caption assets only; not supported on legacy `type: text`. + attr_accessor :wrap + # Attribute mapping from ruby-style variable name to JSON key. def self.attribute_map { :'color' => :'color', :'opacity' => :'opacity', - :'border_radius' => :'borderRadius' + :'border_radius' => :'borderRadius', + :'wrap' => :'wrap' } end @@ -44,7 +48,8 @@ def self.openapi_types { :'color' => :'String', :'opacity' => :'Float', - :'border_radius' => :'Float' + :'border_radius' => :'Float', + :'wrap' => :'Boolean' } end @@ -84,6 +89,12 @@ def initialize(attributes = {}) else self.border_radius = 0 end + + if attributes.key?(:'wrap') + self.wrap = attributes[:'wrap'] + else + self.wrap = false + end end # Show invalid properties with the reasons. Usually used together with valid? @@ -176,7 +187,8 @@ def ==(o) self.class == o.class && color == o.color && opacity == o.opacity && - border_radius == o.border_radius + border_radius == o.border_radius && + wrap == o.wrap end # @see the `==` method @@ -188,7 +200,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Integer] Hash code def hash - [color, opacity, border_radius].hash + [color, opacity, border_radius, wrap].hash end # Builds the object from hash diff --git a/lib/shotstack/models/text_background.rb b/lib/shotstack/models/text_background.rb index 375cf90..fba4c52 100644 --- a/lib/shotstack/models/text_background.rb +++ b/lib/shotstack/models/text_background.rb @@ -28,13 +28,17 @@ class TextBackground # The border radius of the background box in pixels for rounded corners. attr_accessor :border_radius + # Not supported on legacy `text` assets. Accepted here only so validators can emit a clear migration error pointing users to `rich-text` or `rich-caption`, which support background wrapping natively. + attr_accessor :wrap + # Attribute mapping from ruby-style variable name to JSON key. def self.attribute_map { :'color' => :'color', :'opacity' => :'opacity', :'padding' => :'padding', - :'border_radius' => :'borderRadius' + :'border_radius' => :'borderRadius', + :'wrap' => :'wrap' } end @@ -49,7 +53,8 @@ def self.openapi_types :'color' => :'String', :'opacity' => :'Float', :'padding' => :'Float', - :'border_radius' => :'Float' + :'border_radius' => :'Float', + :'wrap' => :'Boolean' } end @@ -89,6 +94,10 @@ def initialize(attributes = {}) if attributes.key?(:'border_radius') self.border_radius = attributes[:'border_radius'] end + + if attributes.key?(:'wrap') + self.wrap = attributes[:'wrap'] + end end # Show invalid properties with the reasons. Usually used together with valid? @@ -210,7 +219,8 @@ def ==(o) color == o.color && opacity == o.opacity && padding == o.padding && - border_radius == o.border_radius + border_radius == o.border_radius && + wrap == o.wrap end # @see the `==` method @@ -222,7 +232,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Integer] Hash code def hash - [color, opacity, padding, border_radius].hash + [color, opacity, padding, border_radius, wrap].hash end # Builds the object from hash diff --git a/lib/shotstack/version.rb b/lib/shotstack/version.rb index 9dce678..98099f5 100644 --- a/lib/shotstack/version.rb +++ b/lib/shotstack/version.rb @@ -11,5 +11,5 @@ =end module Shotstack - VERSION = '1.10.4' + VERSION = '1.11.0' end