Class: Zernio::UsageStatsUsage

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

Overview

Per-period usage counts. Fields present depend on billingSystem: Stripe returns uploads / profiles / lastReset; Metronome returns connectedAccounts / xApiCalls / xApiCallsByOperation.

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



78
79
80
81
82
83
84
85
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
112
113
114
115
116
117
 
# File 'lib/zernio-sdk/models/usage_stats_usage.rb', line 78

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

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

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

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

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

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

Instance Attribute Details

#connected_accounts ⇒ Object

Metronome users only. Accounts currently connected across the team.



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

def connected_accounts
  @connected_accounts
end

#last_reset ⇒ Object

Stripe users only.



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

def last_reset
  @last_reset
end

#profiles ⇒ Object

Stripe users only. Profiles currently owned.



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

def profiles
  @profiles
end

#uploads ⇒ Object

Stripe users only. Uploads consumed in the current period.



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

def uploads
  @uploads
end

#x_api_calls ⇒ Object

Returns the value of attribute x_api_calls.



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

def x_api_calls
  @x_api_calls
end

#x_api_calls_by_operation ⇒ Object

Metronome users only. Per-operation X API call counts keyed by operation (e.g. posts_read, content_create, content_create_with_url). Resolve each key to price and metadata via GET /v1/billing/x-pricing. This is the canonical source — covers every price tier including the $0.200 URL tier that xApiCalls excludes.



34
35
36
 
# File 'lib/zernio-sdk/models/usage_stats_usage.rb', line 34

def x_api_calls_by_operation
  @x_api_calls_by_operation
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



49
50
51
 
# File 'lib/zernio-sdk/models/usage_stats_usage.rb', line 49

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



54
55
56
 
# File 'lib/zernio-sdk/models/usage_stats_usage.rb', line 54

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



37
38
39
40
41
42
43
44
45
46
 
# File 'lib/zernio-sdk/models/usage_stats_usage.rb', line 37

def self.attribute_map
  {
    :'uploads' => :'uploads',
    :'profiles' => :'profiles',
    :'last_reset' => :'lastReset',
    :'connected_accounts' => :'connectedAccounts',
    :'x_api_calls' => :'xApiCalls',
    :'x_api_calls_by_operation' => :'xApiCallsByOperation'
  }
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



162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/zernio-sdk/models/usage_stats_usage.rb', line 162

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



71
72
73
74
 
# File 'lib/zernio-sdk/models/usage_stats_usage.rb', line 71

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'uploads' => :'Integer',
    :'profiles' => :'Integer',
    :'last_reset' => :'Time',
    :'connected_accounts' => :'Integer',
    :'x_api_calls' => :'UsageStatsUsageXApiCalls',
    :'x_api_calls_by_operation' => :'Hash<String, Integer>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



136
137
138
139
140
141
142
143
144
145
 
# File 'lib/zernio-sdk/models/usage_stats_usage.rb', line 136

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      uploads == o.uploads &&
      profiles == o.profiles &&
      last_reset == o.last_reset &&
      connected_accounts == o.connected_accounts &&
      x_api_calls == o.x_api_calls &&
      x_api_calls_by_operation == o.x_api_calls_by_operation
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


149
150
151
 
# File 'lib/zernio-sdk/models/usage_stats_usage.rb', line 149

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



155
156
157
 
# File 'lib/zernio-sdk/models/usage_stats_usage.rb', line 155

def hash
  [uploads, profiles, last_reset, connected_accounts, x_api_calls, x_api_calls_by_operation].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



121
122
123
124
125
 
# File 'lib/zernio-sdk/models/usage_stats_usage.rb', line 121

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



184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/zernio-sdk/models/usage_stats_usage.rb', line 184

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



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

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