Class: OryClient::QuotaUsage

Inherits:
ApiModelBase 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

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ QuotaUsage

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/ory-client/models/quota_usage.rb', line 100

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
  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 `OryClient::QuotaUsage`. 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?(:'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?(:'is_unlimited')
    self.is_unlimited = attributes[:'is_unlimited']
  else
    self.is_unlimited = 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

production_projects ProductionProjects staging_projects StagingProjects development_projects DevelopmentProjects daily_active_users DailyActiveUsers custom_domains CustomDomains event_streams EventStreams event_stream_events EventStreamEvents sla SLA collaborator_seats CollaboratorSeats edge_cache EdgeCache branding_themes BrandingThemes zendesk_support ZendeskSupport zendesk_support_on_call ZendeskSupportOnCall project_metrics ProjectMetrics project_metrics_time_window ProjectMetricsTimeWindow project_metrics_events_history ProjectMetricsEventsHistory organizations Organizations rop_grant ResourceOwnerPasswordGrant concierge_onboarding ConciergeOnboarding credit Credit data_location_global DataLocationGlobal data_location_us DataLocationUS data_location_asiane DataLocationAsiaNorthEast m2m_token_issuance M2MTokenIssuance permission_checks PermissionChecks captcha Captcha identity_search_api IdentitySearchAPI saml_sp SAMLSP saml_idp SAMLIDP auto_link_policy AutoLinkPolicy scim_clients SCIMClients default_smtp_email_customization DefaultSMTPEmailCustomization onboarding_portal OnboardingPortal update_self_service_registration_rate_limit_tier RateLimitTierUpdateSelfServiceRegistration Self-service rate limits update_self_service_recovery_rate_limit_tier RateLimitTierUpdateSelfServiceRecovery update_self_service_settings_rate_limit_tier RateLimitTierUpdateSelfServiceSettings update_self_service_verification_rate_limit_tier RateLimitTierUpdateSelfServiceVerification identities_create_rate_limit_tier RateLimitTierIdentitiesCreate identities_import_rate_limit_tier RateLimitTierIdentitiesImport fed_cm_parameters_rate_limit_tier RateLimitTierFedCMParameters data_location_regional DataLocationRegional Required Features 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 create_recovery_admin_rate_limit_tier RateLimitTierCreateAdminRecovery scim_rate_limit_tier RateLimitTierSCIM



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

#is_unlimited ⇒ Object

Returns the value of attribute is_unlimited.



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

def is_unlimited
  @is_unlimited
end

#used ⇒ Object

Returns the value of attribute used.



32
33
34
 
# File 'lib/ory-client/models/quota_usage.rb', line 32

def used
  @used
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



70
71
72
 
# File 'lib/ory-client/models/quota_usage.rb', line 70

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



75
76
77
 
# File 'lib/ory-client/models/quota_usage.rb', line 75

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



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

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



308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
 
# File 'lib/ory-client/models/quota_usage.rb', line 308

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



93
94
95
96
 
# File 'lib/ory-client/models/quota_usage.rb', line 93

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

.openapi_types ⇒ Object

Attribute type mapping.



80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/ory-client/models/quota_usage.rb', line 80

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/ory-client/models/quota_usage.rb', line 281

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 &&
      is_unlimited == o.is_unlimited &&
      used == o.used
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


295
296
297
 
# File 'lib/ory-client/models/quota_usage.rb', line 295

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



301
302
303
 
# File 'lib/ory-client/models/quota_usage.rb', line 301

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



159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/ory-client/models/quota_usage.rb', line 159

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 @is_unlimited.nil?
    invalid_properties.push('invalid value for "is_unlimited", is_unlimited cannot be nil.')
  end

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

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



330
331
332
333
334
335
336
337
338
339
340
341
342
 
# File 'lib/ory-client/models/quota_usage.rb', line 330

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



195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/ory-client/models/quota_usage.rb', line 195

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', ["production_projects", "staging_projects", "development_projects", "daily_active_users", "custom_domains", "event_streams", "event_stream_events", "sla", "collaborator_seats", "edge_cache", "branding_themes", "zendesk_support", "zendesk_support_on_call", "project_metrics", "project_metrics_time_window", "project_metrics_events_history", "organizations", "rop_grant", "concierge_onboarding", "credit", "data_location_global", "data_location_us", "data_location_asiane", "m2m_token_issuance", "permission_checks", "captcha", "identity_search_api", "saml_sp", "saml_idp", "auto_link_policy", "scim_clients", "default_smtp_email_customization", "onboarding_portal", "update_self_service_registration_rate_limit_tier", "update_self_service_recovery_rate_limit_tier", "update_self_service_settings_rate_limit_tier", "update_self_service_verification_rate_limit_tier", "identities_create_rate_limit_tier", "identities_import_rate_limit_tier", "fed_cm_parameters_rate_limit_tier", "data_location_regional", "rate_limit_tier", "session_rate_limit_tier", "identities_list_rate_limit_tier", "permission_checks_rate_limit_tier", "oauth2_introspect_rate_limit_tier", "create_recovery_admin_rate_limit_tier", "scim_rate_limit_tier"])
  return false unless feature_validator.valid?(@feature)
  return false if @feature_available.nil?
  return false if @included.nil?
  return false if @is_unlimited.nil?
  return false if @used.nil?
  true
end