Class: Zernio::UsageStatsSpend

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

Overview

Metronome users only. Current-period spend summary.

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/zernio-sdk/models/usage_stats_spend.rb', line 70

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

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

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

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

Instance Attribute Details

#credits_remaining_cents ⇒ Object

Free-tier credit remaining in cents. Applied before any charge.



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

def credits_remaining_cents
  @credits_remaining_cents
end

#current_period_cents ⇒ Object

Total current-period spend in cents (all products combined).



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

def current_period_cents
  @current_period_cents
end

#x_spend_cents ⇒ Object

Current-period X/Twitter API spend in cents, summed from xApiCallsByOperation × per-operation prices. Tier-agnostic (covers every price including the $0.200 URL tier). Rounded up for conservative enforcement against xSpendLimitCents.



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

def x_spend_cents
  @x_spend_cents
end

#x_spend_limit_cents ⇒ Object

Monthly X spend cap set by the account owner, or null if no cap. When current X spend hits this cap, analytics and inbox sync are auto-paused for X accounts. Publishing is never blocked by this cap.



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

def x_spend_limit_cents
  @x_spend_limit_cents
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



42
43
44
 
# File 'lib/zernio-sdk/models/usage_stats_spend.rb', line 42

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



47
48
49
 
# File 'lib/zernio-sdk/models/usage_stats_spend.rb', line 47

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



32
33
34
35
36
37
38
39
 
# File 'lib/zernio-sdk/models/usage_stats_spend.rb', line 32

def self.attribute_map
  {
    :'current_period_cents' => :'currentPeriodCents',
    :'credits_remaining_cents' => :'creditsRemainingCents',
    :'x_spend_cents' => :'xSpendCents',
    :'x_spend_limit_cents' => :'xSpendLimitCents'
  }
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



142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/zernio-sdk/models/usage_stats_spend.rb', line 142

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



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

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

.openapi_types ⇒ Object

Attribute type mapping.



52
53
54
55
56
57
58
59
 
# File 'lib/zernio-sdk/models/usage_stats_spend.rb', line 52

def self.openapi_types
  {
    :'current_period_cents' => :'Integer',
    :'credits_remaining_cents' => :'Integer',
    :'x_spend_cents' => :'Integer',
    :'x_spend_limit_cents' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



118
119
120
121
122
123
124
125
 
# File 'lib/zernio-sdk/models/usage_stats_spend.rb', line 118

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      current_period_cents == o.current_period_cents &&
      credits_remaining_cents == o.credits_remaining_cents &&
      x_spend_cents == o.x_spend_cents &&
      x_spend_limit_cents == o.x_spend_limit_cents
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


129
130
131
 
# File 'lib/zernio-sdk/models/usage_stats_spend.rb', line 129

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



135
136
137
 
# File 'lib/zernio-sdk/models/usage_stats_spend.rb', line 135

def hash
  [current_period_cents, credits_remaining_cents, x_spend_cents, x_spend_limit_cents].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



103
104
105
106
107
 
# File 'lib/zernio-sdk/models/usage_stats_spend.rb', line 103

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



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

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



111
112
113
114
 
# File 'lib/zernio-sdk/models/usage_stats_spend.rb', line 111

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end