Class: Zernio::FacebookPostEarningsResponseMetricsValue

Inherits:
ApiModelBase
  • Object
show all
Defined in:
lib/zernio-sdk/models/facebook_post_earnings_response_metrics_value.rb

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

Initializes the object



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/zernio-sdk/models/facebook_post_earnings_response_metrics_value.rb', line 86

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

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

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

Instance Attribute Details

#currency ⇒ Object

ISO 4217 currency, or null when Meta omitted it. Always null on monetization_approximate_earnings; always present on content_monetization_earnings.



25
26
27
 
# File 'lib/zernio-sdk/models/facebook_post_earnings_response_metrics_value.rb', line 25

def currency
  @currency
end

#total ⇒ Object

Lifetime earnings in "unit", exactly as Meta returned them. Never rescaled.



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

def total
  @total
end

#unit ⇒ Object

"micro_amount": Meta returned an object shape carrying a micro amount, and "total" is that integer, unconverted. Zernio does not publish a divisor because Meta does not document one; divide by the scale you have verified against the Page's own Meta Business Suite export. This is always content_monetization_earnings. "unspecified": Meta returned a bare number with no unit metadata, passed through as-is; Meta does not state whether it is major or minor currency units. This is always monetization_approximate_earnings.



22
23
24
 
# File 'lib/zernio-sdk/models/facebook_post_earnings_response_metrics_value.rb', line 22

def unit
  @unit
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



59
60
61
 
# File 'lib/zernio-sdk/models/facebook_post_earnings_response_metrics_value.rb', line 59

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



64
65
66
 
# File 'lib/zernio-sdk/models/facebook_post_earnings_response_metrics_value.rb', line 64

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



50
51
52
53
54
55
56
 
# File 'lib/zernio-sdk/models/facebook_post_earnings_response_metrics_value.rb', line 50

def self.attribute_map
  {
    :'total' => :'total',
    :'unit' => :'unit',
    :'currency' => :'currency'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/zernio-sdk/models/facebook_post_earnings_response_metrics_value.rb', line 165

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



78
79
80
81
82
 
# File 'lib/zernio-sdk/models/facebook_post_earnings_response_metrics_value.rb', line 78

def self.openapi_nullable
  Set.new([
    :'currency'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



69
70
71
72
73
74
75
 
# File 'lib/zernio-sdk/models/facebook_post_earnings_response_metrics_value.rb', line 69

def self.openapi_types
  {
    :'total' => :'Float',
    :'unit' => :'String',
    :'currency' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



142
143
144
145
146
147
148
 
# File 'lib/zernio-sdk/models/facebook_post_earnings_response_metrics_value.rb', line 142

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      total == o.total &&
      unit == o.unit &&
      currency == o.currency
end

#eql?(o) ⇒ Boolean

See Also:

  • `==` method


152
153
154
 
# File 'lib/zernio-sdk/models/facebook_post_earnings_response_metrics_value.rb', line 152

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



158
159
160
 
# File 'lib/zernio-sdk/models/facebook_post_earnings_response_metrics_value.rb', line 158

def hash
  [total, unit, currency].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?



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

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



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

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



123
124
125
126
127
128
 
# File 'lib/zernio-sdk/models/facebook_post_earnings_response_metrics_value.rb', line 123

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