Class: Phyllo::PublishContentResponse1Data

Inherits:
Object
  • Object
show all
Defined in:
lib/phyllo/models/publish_content_response1_data.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PublishContentResponse1Data

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/phyllo/models/publish_content_response1_data.rb', line 127

def initialize(attributes = {})
  if !attributes.is_a?(Hash)
    fail ArgumentError, "The input argument (attributes) must be a hash in `Phyllo::PublishContentResponse1Data` 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 `Phyllo::PublishContentResponse1Data`. 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
  }

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

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

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

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

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

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

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

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

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

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

  self.visibility = if attributes.key?(:visibility)
    attributes[:visibility]
  else
    "PUBLIC"
  end

  self._retry = if attributes.key?(:_retry)
    attributes[:_retry]
  else
    false
  end

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

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

Instance Attribute Details

#_retry ⇒ Object

Whether Phyllo should retry posting the content in case of any technical failures. Our retry mechanism and policies are defined on our publishing content guide.



46
47
48
 
# File 'lib/phyllo/models/publish_content_response1_data.rb', line 46

def _retry
  @_retry
end

#account ⇒ Object

Returns the value of attribute account.



21
22
23
 
# File 'lib/phyllo/models/publish_content_response1_data.rb', line 21

def 
  @account
end

#additional_info ⇒ Object

Returns the value of attribute additional_info.



48
49
50
 
# File 'lib/phyllo/models/publish_content_response1_data.rb', line 48

def additional_info
  @additional_info
end

#description ⇒ Object

Description for the post being published. Supports HTML for certain platforms (eg. YouTube).



37
38
39
 
# File 'lib/phyllo/models/publish_content_response1_data.rb', line 37

def description
  @description
end

#format ⇒ Object

Media type of the content being published.



29
30
31
 
# File 'lib/phyllo/models/publish_content_response1_data.rb', line 29

def format
  @format
end

#id ⇒ Object

Unique ID for the publishing request.



17
18
19
 
# File 'lib/phyllo/models/publish_content_response1_data.rb', line 17

def id
  @id
end

#media ⇒ Object

List of media items to be published.



51
52
53
 
# File 'lib/phyllo/models/publish_content_response1_data.rb', line 51

def media
  @media
end

#published_info ⇒ Object

Returns the value of attribute published_info.



31
32
33
 
# File 'lib/phyllo/models/publish_content_response1_data.rb', line 31

def published_info
  @published_info
end

#status ⇒ Object

Status of the publishing request.



26
27
28
 
# File 'lib/phyllo/models/publish_content_response1_data.rb', line 26

def status
  @status
end

#title ⇒ Object

Title of the post (put the entire text here for tweets).



34
35
36
 
# File 'lib/phyllo/models/publish_content_response1_data.rb', line 34

def title
  @title
end

#type ⇒ Object

Platform specific content type of the post being published.



40
41
42
 
# File 'lib/phyllo/models/publish_content_response1_data.rb', line 40

def type
  @type
end

#user ⇒ Object

Returns the value of attribute user.



19
20
21
 
# File 'lib/phyllo/models/publish_content_response1_data.rb', line 19

def user
  @user
end

#visibility ⇒ Object

Visibility of the post.



43
44
45
 
# File 'lib/phyllo/models/publish_content_response1_data.rb', line 43

def visibility
  @visibility
end

#work_platform ⇒ Object

Returns the value of attribute work_platform.



23
24
25
 
# File 'lib/phyllo/models/publish_content_response1_data.rb', line 23

def work_platform
  @work_platform
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



361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
 
# File 'lib/phyllo/models/publish_content_response1_data.rb', line 361

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 = Phyllo.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



96
97
98
 
# File 'lib/phyllo/models/publish_content_response1_data.rb', line 96

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/phyllo/models/publish_content_response1_data.rb', line 76

def self.attribute_map
  {
    id: :id,
    user: :user,
    account: :account,
    work_platform: :work_platform,
    status: :status,
    format: :format,
    published_info: :published_info,
    title: :title,
    description: :description,
    type: :type,
    visibility: :visibility,
    _retry: :retry,
    additional_info: :additional_info,
    media: :media
  }
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



337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
 
# File 'lib/phyllo/models/publish_content_response1_data.rb', line 337

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.to_s] = 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.to_s] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash[key.to_s] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



121
122
123
 
# File 'lib/phyllo/models/publish_content_response1_data.rb', line 121

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

.openapi_types ⇒ Object

Attribute type mapping.



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/phyllo/models/publish_content_response1_data.rb', line 101

def self.openapi_types
  {
    id: :String,
    user: :UserAttribute1,
    account: :AccountAttribute1,
    work_platform: :WorkPlatformAttribute1,
    status: :String,
    format: :String,
    published_info: :PublishContentResponse1DataAllOfPublishedInfo,
    title: :String,
    description: :String,
    type: :String,
    visibility: :String,
    _retry: :Boolean,
    additional_info: :PublishContent1AdditionalInfo,
    media: :"Array<PublishContentMedia1>"
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
 
# File 'lib/phyllo/models/publish_content_response1_data.rb', line 303

def ==(other)
  return true if equal?(other)
  self.class == other.class &&
    id == other.id &&
    user == other.user &&
     == other. &&
    work_platform == other.work_platform &&
    status == other.status &&
    format == other.format &&
    published_info == other.published_info &&
    title == other.title &&
    description == other.description &&
    type == other.type &&
    visibility == other.visibility &&
    _retry == other._retry &&
    additional_info == other.additional_info &&
    media == other.media
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



432
433
434
435
436
437
438
439
440
441
442
443
444
 
# File 'lib/phyllo/models/publish_content_response1_data.rb', line 432

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?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


324
325
326
 
# File 'lib/phyllo/models/publish_content_response1_data.rb', line 324

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



330
331
332
 
# File 'lib/phyllo/models/publish_content_response1_data.rb', line 330

def hash
  [id, user, , work_platform, status, format, published_info, title, description, type, visibility, _retry, additional_info, media].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



205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/phyllo/models/publish_content_response1_data.rb', line 205

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

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

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

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

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

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

  if @type.nil?
    invalid_properties.push('invalid value for "type", type 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



408
409
410
 
# File 'lib/phyllo/models/publish_content_response1_data.rb', line 408

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



414
415
416
417
418
419
420
421
422
423
424
425
426
 
# File 'lib/phyllo/models/publish_content_response1_data.rb', line 414

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = 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



402
403
404
 
# File 'lib/phyllo/models/publish_content_response1_data.rb', line 402

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



241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'lib/phyllo/models/publish_content_response1_data.rb', line 241

def valid?
  warn "[DEPRECATED] the `valid?` method is obsolete"
  return false if @id.nil?
  return false if @user.nil?
  return false if @account.nil?
  return false if @work_platform.nil?
  return false if @status.nil?
  status_validator = EnumAttributeValidator.new("String", ["READY", "SUCCESS", "FAILURE", "IN_PROGRESS"])
  return false unless status_validator.valid?(@status)
  return false if @format.nil?
  format_validator = EnumAttributeValidator.new("String", ["VIDEO", "AUDIO", "IMAGE", "TEXT", "COLLECTION"])
  return false unless format_validator.valid?(@format)
  return false if @type.nil?
  type_validator = EnumAttributeValidator.new("String", ["TWEET", "REELS", "STORY", "VIDEO", "IMAGE", "BLOG", "THREAD", "POST", "PODCAST", "TRACK", "STREAM", "FEED", "SHORTS"])
  return false unless type_validator.valid?(@type)
  visibility_validator = EnumAttributeValidator.new("String", ["PUBLIC", "PRIVATE", "UNLISTED"])
  return false unless visibility_validator.valid?(@visibility)
  true
end