Class: Zernio::FacebookPostEarningsResponse

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

Overview

Lifetime monetization earnings for one Facebook post. Same "unit" / "currency" contract and same unavailable-vs-zero contract as the Page-level response; there is no date range, no metricType, and no daily "values", because the single lifetime bucket IS the total.

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/zernio-sdk/models/facebook_post_earnings_response.rb', line 107

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

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

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

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

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

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

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

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

Instance Attribute Details

#account_id ⇒ Object

Returns the value of attribute account_id.



21
22
23
 
# File 'lib/zernio-sdk/models/facebook_post_earnings_response.rb', line 21

def 
  @account_id
end

#data_delay ⇒ Object

Returns the value of attribute data_delay.



37
38
39
 
# File 'lib/zernio-sdk/models/facebook_post_earnings_response.rb', line 37

def data_delay
  @data_delay
end

#metrics ⇒ Object

One entry per served metric. A metric reported here with "total": 0 genuinely earned nothing (or its Page is not enrolled, which Meta reports identically).



32
33
34
 
# File 'lib/zernio-sdk/models/facebook_post_earnings_response.rb', line 32

def metrics
  @metrics
end

#period ⇒ Object

Always "lifetime": the total is cumulative since publication and must not be summed across dates or across posts.



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

def period
  @period
end

#platform ⇒ Object

Returns the value of attribute platform.



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

def platform
  @platform
end

#post_id ⇒ Object

The platform post ID that was queried, echoed back.



24
25
26
 
# File 'lib/zernio-sdk/models/facebook_post_earnings_response.rb', line 24

def post_id
  @post_id
end

#success ⇒ Object

Returns the value of attribute success.



19
20
21
 
# File 'lib/zernio-sdk/models/facebook_post_earnings_response.rb', line 19

def success
  @success
end

#unavailable_metrics ⇒ Object

Requested metrics Meta could not serve. Present only when at least one metric is unavailable, and absent otherwise. Each listed metric is OMITTED from "metrics" rather than reported as 0. The request itself still succeeds with HTTP 200.



35
36
37
 
# File 'lib/zernio-sdk/models/facebook_post_earnings_response.rb', line 35

def unavailable_metrics
  @unavailable_metrics
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



76
77
78
 
# File 'lib/zernio-sdk/models/facebook_post_earnings_response.rb', line 76

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



81
82
83
 
# File 'lib/zernio-sdk/models/facebook_post_earnings_response.rb', line 81

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/zernio-sdk/models/facebook_post_earnings_response.rb', line 62

def self.attribute_map
  {
    :'success' => :'success',
    :'account_id' => :'accountId',
    :'post_id' => :'postId',
    :'platform' => :'platform',
    :'period' => :'period',
    :'metrics' => :'metrics',
    :'unavailable_metrics' => :'unavailableMetrics',
    :'data_delay' => :'dataDelay'
  }
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



215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'lib/zernio-sdk/models/facebook_post_earnings_response.rb', line 215

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



100
101
102
103
 
# File 'lib/zernio-sdk/models/facebook_post_earnings_response.rb', line 100

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

.openapi_types ⇒ Object

Attribute type mapping.



86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/zernio-sdk/models/facebook_post_earnings_response.rb', line 86

def self.openapi_types
  {
    :'success' => :'Boolean',
    :'account_id' => :'String',
    :'post_id' => :'String',
    :'platform' => :'String',
    :'period' => :'String',
    :'metrics' => :'Hash<String, FacebookPostEarningsResponseMetricsValue>',
    :'unavailable_metrics' => :'Array<FacebookPostEarningsResponseUnavailableMetricsInner>',
    :'data_delay' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/zernio-sdk/models/facebook_post_earnings_response.rb', line 187

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      success == o.success &&
       == o. &&
      post_id == o.post_id &&
      platform == o.platform &&
      period == o.period &&
      metrics == o.metrics &&
      unavailable_metrics == o.unavailable_metrics &&
      data_delay == o.data_delay
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


202
203
204
 
# File 'lib/zernio-sdk/models/facebook_post_earnings_response.rb', line 202

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



208
209
210
 
# File 'lib/zernio-sdk/models/facebook_post_earnings_response.rb', line 208

def hash
  [success, , post_id, platform, period, metrics, unavailable_metrics, data_delay].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



160
161
162
163
164
 
# File 'lib/zernio-sdk/models/facebook_post_earnings_response.rb', line 160

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



237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/zernio-sdk/models/facebook_post_earnings_response.rb', line 237

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



168
169
170
171
172
173
 
# File 'lib/zernio-sdk/models/facebook_post_earnings_response.rb', line 168

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