Class: Zernio::FacebookPlatformData

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

Overview

Feed posts support up to 10 images (no mixed video+image). Stories require single media (24h, no captions). Reels require single vertical video (9:16, 3-60s). Geo-restriction is a hard visibility restriction: users outside the specified countries cannot see the post. Not supported for stories. Draft, carousel, and colored-background text options live under facebookSettings, see FacebookSettings.

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/zernio-sdk/models/facebook_platform_data.rb', line 99

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

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

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

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

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

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

Instance Attribute Details

#content_type ⇒ Object

Set to 'story' for Page Stories (24h ephemeral) or 'reel' for Reels (short vertical video). Defaults to feed post if omitted.



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

def content_type
  @content_type
end

#facebook_settings ⇒ Object

Returns the value of attribute facebook_settings.



33
34
35
 
# File 'lib/zernio-sdk/models/facebook_platform_data.rb', line 33

def facebook_settings
  @facebook_settings
end

#first_comment ⇒ Object

Optional first comment to post immediately after publishing (feed posts and reels, not stories). Skipped when facebookSettings.draft is true.



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

def first_comment
  @first_comment
end

#geo_restriction ⇒ Object

Returns the value of attribute geo_restriction.



31
32
33
 
# File 'lib/zernio-sdk/models/facebook_platform_data.rb', line 31

def geo_restriction
  @geo_restriction
end

#page_id ⇒ Object

Target Facebook Page ID for multi-page posting. If omitted, uses the default page. Use GET /v1/accounts/id/facebook-page to list pages.



29
30
31
 
# File 'lib/zernio-sdk/models/facebook_platform_data.rb', line 29

def page_id
  @page_id
end

#title ⇒ Object

Reel title (only for contentType=reel). Separate from the caption/content field.



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

def title
  @title
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



70
71
72
 
# File 'lib/zernio-sdk/models/facebook_platform_data.rb', line 70

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



75
76
77
 
# File 'lib/zernio-sdk/models/facebook_platform_data.rb', line 75

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



58
59
60
61
62
63
64
65
66
67
 
# File 'lib/zernio-sdk/models/facebook_platform_data.rb', line 58

def self.attribute_map
  {
    :'content_type' => :'contentType',
    :'title' => :'title',
    :'first_comment' => :'firstComment',
    :'page_id' => :'pageId',
    :'geo_restriction' => :'geoRestriction',
    :'facebook_settings' => :'facebookSettings'
  }
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



193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/zernio-sdk/models/facebook_platform_data.rb', line 193

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



92
93
94
95
 
# File 'lib/zernio-sdk/models/facebook_platform_data.rb', line 92

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

.openapi_types ⇒ Object

Attribute type mapping.



80
81
82
83
84
85
86
87
88
89
 
# File 'lib/zernio-sdk/models/facebook_platform_data.rb', line 80

def self.openapi_types
  {
    :'content_type' => :'String',
    :'title' => :'String',
    :'first_comment' => :'String',
    :'page_id' => :'String',
    :'geo_restriction' => :'GeoRestriction',
    :'facebook_settings' => :'FacebookSettings'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



167
168
169
170
171
172
173
174
175
176
 
# File 'lib/zernio-sdk/models/facebook_platform_data.rb', line 167

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      content_type == o.content_type &&
      title == o.title &&
      first_comment == o.first_comment &&
      page_id == o.page_id &&
      geo_restriction == o.geo_restriction &&
      facebook_settings == o.facebook_settings
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


180
181
182
 
# File 'lib/zernio-sdk/models/facebook_platform_data.rb', line 180

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



186
187
188
 
# File 'lib/zernio-sdk/models/facebook_platform_data.rb', line 186

def hash
  [content_type, title, first_comment, page_id, geo_restriction, facebook_settings].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



140
141
142
143
144
 
# File 'lib/zernio-sdk/models/facebook_platform_data.rb', line 140

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/zernio-sdk/models/facebook_platform_data.rb', line 215

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



148
149
150
151
152
153
 
# File 'lib/zernio-sdk/models/facebook_platform_data.rb', line 148

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  content_type_validator = EnumAttributeValidator.new('String', ["story", "reel"])
  return false unless content_type_validator.valid?(@content_type)
  true
end