Class: Zernio::ThreadsPlatformData

Inherits:
ApiModelBase show all
Defined in:
lib/zernio-sdk/models/threads_platform_data.rb

Overview

Up to 10 images per carousel (no videos). Videos must be H.264/AAC MP4, max 5 min. Images JPEG/PNG, max 8 MB. Use threadItems for reply chains.

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 = {}) ⇒ ThreadsPlatformData

Initializes the object

Parameters:

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

    Model attributes in the form of hash



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/zernio-sdk/models/threads_platform_data.rb', line 64

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

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

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

Instance Attribute Details

#first_comment ⇒ Object

Optional first comment to post immediately after publishing, as a reply to the published post. With threadItems, it replies to the root post. Up to 500 characters (the Threads post limit). The reply is itself a Threads post, so it consumes one of the 250 posts a profile may publish per 24 hours.



23
24
25
 
# File 'lib/zernio-sdk/models/threads_platform_data.rb', line 23

def first_comment
  @first_comment
end

#thread_items ⇒ Object

Complete sequence of posts in a Threads thread. The first item becomes the root post, subsequent items are chained as replies. When threadItems is provided, the top-level content field is used only for display and search purposes, it is NOT published. You must include your first post as threadItems.



26
27
28
 
# File 'lib/zernio-sdk/models/threads_platform_data.rb', line 26

def thread_items
  @thread_items
end

#topic_tag ⇒ Object

Topic tag for post categorization and discoverability on Threads. Must be 1-50 characters, cannot contain periods (.) or ampersands (&). Overrides auto-extraction from content hashtags when provided.



20
21
22
 
# File 'lib/zernio-sdk/models/threads_platform_data.rb', line 20

def topic_tag
  @topic_tag
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



38
39
40
 
# File 'lib/zernio-sdk/models/threads_platform_data.rb', line 38

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



43
44
45
 
# File 'lib/zernio-sdk/models/threads_platform_data.rb', line 43

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



29
30
31
32
33
34
35
 
# File 'lib/zernio-sdk/models/threads_platform_data.rb', line 29

def self.attribute_map
  {
    :'topic_tag' => :'topic_tag',
    :'first_comment' => :'firstComment',
    :'thread_items' => :'threadItems'
  }
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



180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/zernio-sdk/models/threads_platform_data.rb', line 180

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



57
58
59
60
 
# File 'lib/zernio-sdk/models/threads_platform_data.rb', line 57

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

.openapi_types ⇒ Object

Attribute type mapping.



48
49
50
51
52
53
54
 
# File 'lib/zernio-sdk/models/threads_platform_data.rb', line 48

def self.openapi_types
  {
    :'topic_tag' => :'String',
    :'first_comment' => :'String',
    :'thread_items' => :'Array<TwitterPlatformDataThreadItemsInner>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



157
158
159
160
161
162
163
 
# File 'lib/zernio-sdk/models/threads_platform_data.rb', line 157

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      topic_tag == o.topic_tag &&
      first_comment == o.first_comment &&
      thread_items == o.thread_items
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


167
168
169
 
# File 'lib/zernio-sdk/models/threads_platform_data.rb', line 167

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



173
174
175
 
# File 'lib/zernio-sdk/models/threads_platform_data.rb', line 173

def hash
  [topic_tag, first_comment, thread_items].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



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/zernio-sdk/models/threads_platform_data.rb', line 95

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if !@topic_tag.nil? && @topic_tag.to_s.length > 50
    invalid_properties.push('invalid value for "topic_tag", the character length must be smaller than or equal to 50.')
  end

  if !@topic_tag.nil? && @topic_tag.to_s.length < 1
    invalid_properties.push('invalid value for "topic_tag", the character length must be greater than or equal to 1.')
  end

  if !@first_comment.nil? && @first_comment.to_s.length > 500
    invalid_properties.push('invalid value for "first_comment", the character length must be smaller than or equal to 500.')
  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



202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/zernio-sdk/models/threads_platform_data.rb', line 202

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



115
116
117
118
119
120
121
 
# File 'lib/zernio-sdk/models/threads_platform_data.rb', line 115

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !@topic_tag.nil? && @topic_tag.to_s.length > 50
  return false if !@topic_tag.nil? && @topic_tag.to_s.length < 1
  return false if !@first_comment.nil? && @first_comment.to_s.length > 500
  true
end