Class: Late::FacebookPlatformData

Inherits:
ApiModelBase show all
Defined in:
lib/late-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).

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



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

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

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



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

def content_type
  @content_type
end

#draft ⇒ Object

When true, creates the post as an unpublished draft visible in Facebook Publishing Tools instead of publishing immediately. Supported for feed posts (text, link, image, video) and reels. Not supported for stories. Drafts expire after ~30 days.



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

def draft
  @draft
end

#first_comment ⇒ Object

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



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

def first_comment
  @first_comment
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.



32
33
34
 
# File 'lib/late-sdk/models/facebook_platform_data.rb', line 32

def page_id
  @page_id
end

#title ⇒ Object

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



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

def title
  @title
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



68
69
70
 
# File 'lib/late-sdk/models/facebook_platform_data.rb', line 68

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



73
74
75
 
# File 'lib/late-sdk/models/facebook_platform_data.rb', line 73

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



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

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



187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/late-sdk/models/facebook_platform_data.rb', line 187

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



89
90
91
92
 
# File 'lib/late-sdk/models/facebook_platform_data.rb', line 89

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

.openapi_types ⇒ Object

Attribute type mapping.



78
79
80
81
82
83
84
85
86
 
# File 'lib/late-sdk/models/facebook_platform_data.rb', line 78

def self.openapi_types
  {
    :'draft' => :'Boolean',
    :'content_type' => :'String',
    :'title' => :'String',
    :'first_comment' => :'String',
    :'page_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



162
163
164
165
166
167
168
169
170
 
# File 'lib/late-sdk/models/facebook_platform_data.rb', line 162

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


174
175
176
 
# File 'lib/late-sdk/models/facebook_platform_data.rb', line 174

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



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

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



135
136
137
138
139
 
# File 'lib/late-sdk/models/facebook_platform_data.rb', line 135

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



209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/late-sdk/models/facebook_platform_data.rb', line 209

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



143
144
145
146
147
148
 
# File 'lib/late-sdk/models/facebook_platform_data.rb', line 143

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