Class: Shotstack::GeneratedAssetResponseAttributes

Inherits:
Object
  • Object
show all
Defined in:
lib/shotstack/models/generated_asset_response_attributes.rb

Overview

The id and attributes of the generated asset.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ GeneratedAssetResponseAttributes

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/shotstack/models/generated_asset_response_attributes.rb', line 101

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Shotstack::GeneratedAssetResponseAttributes` 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::GeneratedAssetResponseAttributes`. 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?(:'owner')
    self.owner = attributes[:'owner']
  else
    self.owner = nil
  end

  if attributes.key?(:'provider')
    self.provider = attributes[:'provider']
  else
    self.provider = nil
  end

  if attributes.key?(:'type')
    self.type = attributes[:'type']
  else
    self.type = nil
  end

  if attributes.key?(:'url')
    self.url = attributes[:'url']
  end

  if attributes.key?(:'status')
    self.status = attributes[:'status']
  else
    self.status = nil
  end

  if attributes.key?(:'created')
    self.created = attributes[:'created']
  else
    self.created = nil
  end

  if attributes.key?(:'updated')
    self.updated = attributes[:'updated']
  else
    self.updated = nil
  end
end

Instance Attribute Details

#created ⇒ Object

The time the generate asset task was initially queued.



35
36
37
 
# File 'lib/shotstack/models/generated_asset_response_attributes.rb', line 35

def created
  @created
end

#owner ⇒ Object

The owner id of the asset.



20
21
22
 
# File 'lib/shotstack/models/generated_asset_response_attributes.rb', line 20

def owner
  @owner
end

#provider ⇒ Object

The native or third party provider that generated the asset, ‘shotstack`, `elevenlabs`, `heygen` or `d-id`.



23
24
25
 
# File 'lib/shotstack/models/generated_asset_response_attributes.rb', line 23

def provider
  @provider
end

#status ⇒ Object

The status of the asset file generation task. <ul> <li>‘queued` - generation task is queued waiting to be processed</li> <li>`processing` - the asset is being generated by the provider</li> <li>`saving` - the asset is being saved to Shotstack</li> <li>`done` - the asset has been generated and stored</li> <li>`failed` - there was an error generating the asset</li> </ul>



32
33
34
 
# File 'lib/shotstack/models/generated_asset_response_attributes.rb', line 32

def status
  @status
end

#type ⇒ Object

The type of service used to generate the asset, ‘text-to-speech` or `text-to-avatar`.



26
27
28
 
# File 'lib/shotstack/models/generated_asset_response_attributes.rb', line 26

def type
  @type
end

#updated ⇒ Object

The time the asset status was last updated.



38
39
40
 
# File 'lib/shotstack/models/generated_asset_response_attributes.rb', line 38

def updated
  @updated
end

#url ⇒ Object

The URL of the asset file hosted by Shotstack. The file at the URL can be used by the Edit API. Generated asset file URL’s consist of a base URL (AWS bucket), owner id, asset id and extension. The extension varies depending on the type of file generated.



29
30
31
 
# File 'lib/shotstack/models/generated_asset_response_attributes.rb', line 29

def url
  @url
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
 
# File 'lib/shotstack/models/generated_asset_response_attributes.rb', line 289

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<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\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

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



76
77
78
 
# File 'lib/shotstack/models/generated_asset_response_attributes.rb', line 76

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/shotstack/models/generated_asset_response_attributes.rb', line 63

def self.attribute_map
  {
    :'owner' => :'owner',
    :'provider' => :'provider',
    :'type' => :'type',
    :'url' => :'url',
    :'status' => :'status',
    :'created' => :'created',
    :'updated' => :'updated'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/shotstack/models/generated_asset_response_attributes.rb', line 265

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



94
95
96
97
 
# File 'lib/shotstack/models/generated_asset_response_attributes.rb', line 94

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/shotstack/models/generated_asset_response_attributes.rb', line 81

def self.openapi_types
  {
    :'owner' => :'String',
    :'provider' => :'String',
    :'type' => :'String',
    :'url' => :'String',
    :'status' => :'String',
    :'created' => :'String',
    :'updated' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



238
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/shotstack/models/generated_asset_response_attributes.rb', line 238

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      owner == o.owner &&
      provider == o.provider &&
      type == o.type &&
      url == o.url &&
      status == o.status &&
      created == o.created &&
      updated == o.updated
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



360
361
362
363
364
365
366
367
368
369
370
371
372
 
# File 'lib/shotstack/models/generated_asset_response_attributes.rb', line 360

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


252
253
254
 
# File 'lib/shotstack/models/generated_asset_response_attributes.rb', line 252

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



258
259
260
 
# File 'lib/shotstack/models/generated_asset_response_attributes.rb', line 258

def hash
  [owner, provider, type, url, status, created, updated].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/shotstack/models/generated_asset_response_attributes.rb', line 157

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @owner.nil?
    invalid_properties.push('invalid value for "owner", owner cannot be nil.')
  end

  if @provider.nil?
    invalid_properties.push('invalid value for "provider", provider cannot be nil.')
  end

  if @type.nil?
    invalid_properties.push('invalid value for "type", type cannot be nil.')
  end

  if @status.nil?
    invalid_properties.push('invalid value for "status", status cannot be nil.')
  end

  if @created.nil?
    invalid_properties.push('invalid value for "created", created cannot be nil.')
  end

  if @updated.nil?
    invalid_properties.push('invalid value for "updated", updated cannot be nil.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



336
337
338
 
# File 'lib/shotstack/models/generated_asset_response_attributes.rb', line 336

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



342
343
344
345
346
347
348
349
350
351
352
353
354
 
# File 'lib/shotstack/models/generated_asset_response_attributes.rb', line 342

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

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



330
331
332
 
# File 'lib/shotstack/models/generated_asset_response_attributes.rb', line 330

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/shotstack/models/generated_asset_response_attributes.rb', line 189

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @owner.nil?
  return false if @provider.nil?
  provider_validator = EnumAttributeValidator.new('String', ["shotstack", "elevenlabs", "heygen", "d-id"])
  return false unless provider_validator.valid?(@provider)
  return false if @type.nil?
  type_validator = EnumAttributeValidator.new('String', ["text-to-speech", "text-to-avatar"])
  return false unless type_validator.valid?(@type)
  return false if @status.nil?
  status_validator = EnumAttributeValidator.new('String', ["queued", "processing", "saving", "done", "failed"])
  return false unless status_validator.valid?(@status)
  return false if @created.nil?
  return false if @updated.nil?
  true
end