Class: Phyllo::PublishContent
- Inherits:
-
Object
- Object
- Phyllo::PublishContent
- Defined in:
- lib/phyllo/models/publish_content.rb
Defined Under Namespace
Classes: EnumAttributeValidator
Instance Attribute Summary collapse
-
#_retry ⇒ Object
Whether Phyllo should retry posting the content in case of any technical failures.
-
#additional_info ⇒ Object
Returns the value of attribute additional_info.
-
#description ⇒ Object
Description for the post being published.
-
#media ⇒ Object
List of media items to be published.
-
#title ⇒ Object
Title of the post (put the entire text here for tweets).
-
#type ⇒ Object
Platform specific content type of the post being published.
-
#visibility ⇒ Object
Visibility of the post.
Class Method Summary collapse
-
._deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
.acceptable_attributes ⇒ Object
Returns all the JSON keys this model knows about.
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.build_from_hash(attributes) ⇒ Object
Builds the object from hash.
-
.openapi_nullable ⇒ Object
List of attributes with nullable: true.
-
.openapi_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(other) ⇒ Object
Checks equality by comparing each attribute.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
- #eql?(other) ⇒ Boolean
-
#hash ⇒ Integer
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ PublishContent
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ PublishContent
Initializes the object
96 97 98 99 100 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 |
# File 'lib/phyllo/models/publish_content.rb', line 96 def initialize(attributes = {}) if !attributes.is_a?(Hash) fail ArgumentError, "The input argument (attributes) must be a hash in `Phyllo::PublishContent` 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::PublishContent`. 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?(: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.
29 30 31 |
# File 'lib/phyllo/models/publish_content.rb', line 29 def _retry @_retry end |
#additional_info ⇒ Object
Returns the value of attribute additional_info.
31 32 33 |
# File 'lib/phyllo/models/publish_content.rb', line 31 def additional_info @additional_info end |
#description ⇒ Object
Description for the post being published. Supports HTML for certain platforms (eg. YouTube).
20 21 22 |
# File 'lib/phyllo/models/publish_content.rb', line 20 def description @description end |
#media ⇒ Object
List of media items to be published.
34 35 36 |
# File 'lib/phyllo/models/publish_content.rb', line 34 def media @media end |
#title ⇒ Object
Title of the post (put the entire text here for tweets).
17 18 19 |
# File 'lib/phyllo/models/publish_content.rb', line 17 def title @title end |
#type ⇒ Object
Platform specific content type of the post being published.
23 24 25 |
# File 'lib/phyllo/models/publish_content.rb', line 23 def type @type end |
#visibility ⇒ Object
Visibility of the post.
26 27 28 |
# File 'lib/phyllo/models/publish_content.rb', line 26 def visibility @visibility end |
Class Method Details
._deserialize(type, value) ⇒ Object
Deserializes the data based on type
241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 |
# File 'lib/phyllo/models/publish_content.rb', line 241 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
72 73 74 |
# File 'lib/phyllo/models/publish_content.rb', line 72 def self.acceptable_attributes attribute_map.values end |
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
59 60 61 62 63 64 65 66 67 68 69 |
# File 'lib/phyllo/models/publish_content.rb', line 59 def self.attribute_map { 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
217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 |
# File 'lib/phyllo/models/publish_content.rb', line 217 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
90 91 92 |
# File 'lib/phyllo/models/publish_content.rb', line 90 def self.openapi_nullable Set.new([]) end |
.openapi_types ⇒ Object
Attribute type mapping.
77 78 79 80 81 82 83 84 85 86 87 |
# File 'lib/phyllo/models/publish_content.rb', line 77 def self.openapi_types { 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.
190 191 192 193 194 195 196 197 198 199 200 |
# File 'lib/phyllo/models/publish_content.rb', line 190 def ==(other) return true if equal?(other) self.class == other.class && 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
312 313 314 315 316 317 318 319 320 321 322 323 324 |
# File 'lib/phyllo/models/publish_content.rb', line 312 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
204 205 206 |
# File 'lib/phyllo/models/publish_content.rb', line 204 def eql?(other) self == other end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
210 211 212 |
# File 'lib/phyllo/models/publish_content.rb', line 210 def hash [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?
146 147 148 149 150 151 152 153 154 |
# File 'lib/phyllo/models/publish_content.rb', line 146 def list_invalid_properties warn "[DEPRECATED] the `list_invalid_properties` method is obsolete" invalid_properties = [] 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)
288 289 290 |
# File 'lib/phyllo/models/publish_content.rb', line 288 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
294 295 296 297 298 299 300 301 302 303 304 305 306 |
# File 'lib/phyllo/models/publish_content.rb', line 294 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
282 283 284 |
# File 'lib/phyllo/models/publish_content.rb', line 282 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
158 159 160 161 162 163 164 165 166 |
# File 'lib/phyllo/models/publish_content.rb', line 158 def valid? warn "[DEPRECATED] the `valid?` method is obsolete" 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 |