Class: OryClient::QuotaUsage

Inherits:
Object
  • Object
show all
Defined in:
lib/ory-client/models/quota_usage.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ QuotaUsage

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/ory-client/models/quota_usage.rb', line 91

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `OryClient::QuotaUsage` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `OryClient::QuotaUsage`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'additional_price')
    self.additional_price = attributes[:'additional_price']
  else
    self.additional_price = nil
  end

  if attributes.key?(:'can_use_more')
    self.can_use_more = attributes[:'can_use_more']
  else
    self.can_use_more = nil
  end

  if attributes.key?(:'feature')
    self.feature = attributes[:'feature']
  else
    self.feature = nil
  end

  if attributes.key?(:'feature_available')
    self.feature_available = attributes[:'feature_available']
  else
    self.feature_available = nil
  end

  if attributes.key?(:'included')
    self.included = attributes[:'included']
  else
    self.included = nil
  end

  if attributes.key?(:'used')
    self.used = attributes[:'used']
  else
    self.used = nil
  end
end

Instance Attribute Details

#additional_price ⇒ Object

The additional price per unit in cents.



19
20
21
 
# File 'lib/ory-client/models/quota_usage.rb', line 19

def additional_price
  @additional_price
end

#can_use_more ⇒ Object

Returns the value of attribute can_use_more.



21
22
23
 
# File 'lib/ory-client/models/quota_usage.rb', line 21

def can_use_more
  @can_use_more
end

#feature ⇒ Object

region_eu RegionEU region_us RegionUS region_apac RegionAPAC region_global RegionGlobal production_projects ProductionProjects daily_active_users DailyActiveUsers custom_domains CustomDomains event_streams EventStreams sla SLA collaborator_seats CollaboratorSeats edge_cache EdgeCache branding_themes BrandingThemes zendesk_support ZendeskSupport project_metrics ProjectMetrics project_metrics_time_window ProjectMetricsTimeWindow project_metrics_events_history ProjectMetricsEventsHistory organizations Organizations rop_grant ResourceOwnerPasswordGrant concierge_onboarding ConciergeOnboarding rate_limit_tier RateLimitTier session_rate_limit_tier RateLimitTierSessions identities_list_rate_limit_tier RateLimitTierIdentitiesList permission_checks_rate_limit_tier RateLimitTierPermissionChecks oauth2_introspect_rate_limit_tier RateLimitTierOAuth2Introspect



24
25
26
 
# File 'lib/ory-client/models/quota_usage.rb', line 24

def feature
  @feature
end

#feature_available ⇒ Object

Returns the value of attribute feature_available.



26
27
28
 
# File 'lib/ory-client/models/quota_usage.rb', line 26

def feature_available
  @feature_available
end

#included ⇒ Object

Returns the value of attribute included.



28
29
30
 
# File 'lib/ory-client/models/quota_usage.rb', line 28

def included
  @included
end

#used ⇒ Object

Returns the value of attribute used.



30
31
32
 
# File 'lib/ory-client/models/quota_usage.rb', line 30

def used
  @used
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/ory-client/models/quota_usage.rb', line 250

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    # models (e.g. Pet) or oneOf
    klass = OryClient.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



67
68
69
 
# File 'lib/ory-client/models/quota_usage.rb', line 67

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



55
56
57
58
59
60
61
62
63
64
 
# File 'lib/ory-client/models/quota_usage.rb', line 55

def self.attribute_map
  {
    :'additional_price' => :'additional_price',
    :'can_use_more' => :'can_use_more',
    :'feature' => :'feature',
    :'feature_available' => :'feature_available',
    :'included' => :'included',
    :'used' => :'used'
  }
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



226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/ory-client/models/quota_usage.rb', line 226

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



84
85
86
87
 
# File 'lib/ory-client/models/quota_usage.rb', line 84

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

.openapi_types ⇒ Object

Attribute type mapping.



72
73
74
75
76
77
78
79
80
81
 
# File 'lib/ory-client/models/quota_usage.rb', line 72

def self.openapi_types
  {
    :'additional_price' => :'Integer',
    :'can_use_more' => :'Boolean',
    :'feature' => :'String',
    :'feature_available' => :'Boolean',
    :'included' => :'Integer',
    :'used' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



200
201
202
203
204
205
206
207
208
209
 
# File 'lib/ory-client/models/quota_usage.rb', line 200

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      additional_price == o.additional_price &&
      can_use_more == o.can_use_more &&
      feature == o.feature &&
      feature_available == o.feature_available &&
      included == o.included &&
      used == o.used
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



321
322
323
324
325
326
327
328
329
330
331
332
333
 
# File 'lib/ory-client/models/quota_usage.rb', line 321

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


213
214
215
 
# File 'lib/ory-client/models/quota_usage.rb', line 213

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



219
220
221
 
# File 'lib/ory-client/models/quota_usage.rb', line 219

def hash
  [additional_price, can_use_more, feature, feature_available, included, used].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



143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/ory-client/models/quota_usage.rb', line 143

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @additional_price.nil?
    invalid_properties.push('invalid value for "additional_price", additional_price cannot be nil.')
  end

  if @can_use_more.nil?
    invalid_properties.push('invalid value for "can_use_more", can_use_more cannot be nil.')
  end

  if @feature.nil?
    invalid_properties.push('invalid value for "feature", feature cannot be nil.')
  end

  if @feature_available.nil?
    invalid_properties.push('invalid value for "feature_available", feature_available cannot be nil.')
  end

  if @included.nil?
    invalid_properties.push('invalid value for "included", included cannot be nil.')
  end

  if @used.nil?
    invalid_properties.push('invalid value for "used", used cannot be nil.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



297
298
299
 
# File 'lib/ory-client/models/quota_usage.rb', line 297

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



303
304
305
306
307
308
309
310
311
312
313
314
315
 
# File 'lib/ory-client/models/quota_usage.rb', line 303

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

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



291
292
293
 
# File 'lib/ory-client/models/quota_usage.rb', line 291

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/ory-client/models/quota_usage.rb', line 175

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @additional_price.nil?
  return false if @can_use_more.nil?
  return false if @feature.nil?
  feature_validator = EnumAttributeValidator.new('String', ["region_eu", "region_us", "region_apac", "region_global", "production_projects", "daily_active_users", "custom_domains", "event_streams", "sla", "collaborator_seats", "edge_cache", "branding_themes", "zendesk_support", "project_metrics", "project_metrics_time_window", "project_metrics_events_history", "organizations", "rop_grant", "concierge_onboarding", "rate_limit_tier", "session_rate_limit_tier", "identities_list_rate_limit_tier", "permission_checks_rate_limit_tier", "oauth2_introspect_rate_limit_tier"])
  return false unless feature_validator.valid?(@feature)
  return false if @feature_available.nil?
  return false if @included.nil?
  return false if @used.nil?
  true
end