Class: Late::UpdatePostMetadataRequest

Inherits:
ApiModelBase show all
Defined in:
lib/late-sdk/models/update_post_metadata_request.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ UpdatePostMetadataRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/late-sdk/models/update_post_metadata_request.rb', line 115

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Late::UpdatePostMetadataRequest` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Late::UpdatePostMetadataRequest`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

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

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

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

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

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

  if attributes.key?(:'tags')
    if (value = attributes[:'tags']).is_a?(Array)
      self.tags = value
    end
  end

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

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

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

Instance Attribute Details

#account_id ⇒ Object

Zernio social account ID (required for direct mode, ignored for post-based mode)



25
26
27
 
# File 'lib/late-sdk/models/update_post_metadata_request.rb', line 25

def 
  @account_id
end

#category_id ⇒ Object

YouTube video category ID



37
38
39
 
# File 'lib/late-sdk/models/update_post_metadata_request.rb', line 37

def category_id
  @category_id
end

#description ⇒ Object

New video description



31
32
33
 
# File 'lib/late-sdk/models/update_post_metadata_request.rb', line 31

def description
  @description
end

#platform ⇒ Object

The platform to update metadata on



19
20
21
 
# File 'lib/late-sdk/models/update_post_metadata_request.rb', line 19

def platform
  @platform
end

#privacy_status ⇒ Object

Video privacy setting



40
41
42
 
# File 'lib/late-sdk/models/update_post_metadata_request.rb', line 40

def privacy_status
  @privacy_status
end

#tags ⇒ Object

Array of keyword tags (max 500 characters combined for YouTube)



34
35
36
 
# File 'lib/late-sdk/models/update_post_metadata_request.rb', line 34

def tags
  @tags
end

#thumbnail_url ⇒ Object

Public URL of a custom thumbnail image (JPEG, PNG, or GIF, max 2 MB, recommended 1280x720). Works on any video you own, including existing videos not published through Zernio. The channel must be verified (phone verification) to set custom thumbnails.



43
44
45
 
# File 'lib/late-sdk/models/update_post_metadata_request.rb', line 43

def thumbnail_url
  @thumbnail_url
end

#title ⇒ Object

New video title (max 100 characters for YouTube)



28
29
30
 
# File 'lib/late-sdk/models/update_post_metadata_request.rb', line 28

def title
  @title
end

#video_id ⇒ Object

YouTube video ID (required for direct mode, ignored for post-based mode)



22
23
24
 
# File 'lib/late-sdk/models/update_post_metadata_request.rb', line 22

def video_id
  @video_id
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



83
84
85
 
# File 'lib/late-sdk/models/update_post_metadata_request.rb', line 83

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



88
89
90
 
# File 'lib/late-sdk/models/update_post_metadata_request.rb', line 88

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/late-sdk/models/update_post_metadata_request.rb', line 68

def self.attribute_map
  {
    :'platform' => :'platform',
    :'video_id' => :'videoId',
    :'account_id' => :'accountId',
    :'title' => :'title',
    :'description' => :'description',
    :'tags' => :'tags',
    :'category_id' => :'categoryId',
    :'privacy_status' => :'privacyStatus',
    :'thumbnail_url' => :'thumbnailUrl'
  }
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



264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/late-sdk/models/update_post_metadata_request.rb', line 264

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



108
109
110
111
 
# File 'lib/late-sdk/models/update_post_metadata_request.rb', line 108

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

.openapi_types ⇒ Object

Attribute type mapping.



93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/late-sdk/models/update_post_metadata_request.rb', line 93

def self.openapi_types
  {
    :'platform' => :'String',
    :'video_id' => :'String',
    :'account_id' => :'String',
    :'title' => :'String',
    :'description' => :'String',
    :'tags' => :'Array<String>',
    :'category_id' => :'String',
    :'privacy_status' => :'String',
    :'thumbnail_url' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/late-sdk/models/update_post_metadata_request.rb', line 235

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      platform == o.platform &&
      video_id == o.video_id &&
       == o. &&
      title == o.title &&
      description == o.description &&
      tags == o.tags &&
      category_id == o.category_id &&
      privacy_status == o.privacy_status &&
      thumbnail_url == o.thumbnail_url
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


251
252
253
 
# File 'lib/late-sdk/models/update_post_metadata_request.rb', line 251

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



257
258
259
 
# File 'lib/late-sdk/models/update_post_metadata_request.rb', line 257

def hash
  [platform, video_id, , title, description, tags, category_id, privacy_status, thumbnail_url].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



172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'lib/late-sdk/models/update_post_metadata_request.rb', line 172

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

  if !@title.nil? && @title.to_s.length > 100
    invalid_properties.push('invalid value for "title", the character length must be smaller than or equal to 100.')
  end

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



286
287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'lib/late-sdk/models/update_post_metadata_request.rb', line 286

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

#valid? ⇒ Boolean

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

Returns:

  • (Boolean) —

    true if the model is valid



188
189
190
191
192
193
194
195
196
197
 
# File 'lib/late-sdk/models/update_post_metadata_request.rb', line 188

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @platform.nil?
  platform_validator = EnumAttributeValidator.new('String', ["youtube"])
  return false unless platform_validator.valid?(@platform)
  return false if !@title.nil? && @title.to_s.length > 100
  privacy_status_validator = EnumAttributeValidator.new('String', ["public", "private", "unlisted"])
  return false unless privacy_status_validator.valid?(@privacy_status)
  true
end