Class: OryClient::PlanDetails

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PlanDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
 
# File 'lib/ory-client/models/plan_details.rb', line 87

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

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

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

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

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

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

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

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

Instance Attribute Details

#base_fee_monthly ⇒ Object

BaseFeeMonthly is the monthly base fee for the plan.



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

def base_fee_monthly
  @base_fee_monthly
end

#base_fee_yearly ⇒ Object

BaseFeeYearly is the yearly base fee for the plan.



22
23
24
 
# File 'lib/ory-client/models/plan_details.rb', line 22

def base_fee_yearly
  @base_fee_yearly
end

#custom ⇒ Object

Custom is true if the plan is custom. This means it will be hidden from the pricing page.



25
26
27
 
# File 'lib/ory-client/models/plan_details.rb', line 25

def custom
  @custom
end

#description ⇒ Object

Description is the description of the plan.



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

def description
  @description
end

#features ⇒ Object

Returns the value of attribute features.



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

def features
  @features
end

#latest ⇒ Object

Latest is true if the plan is the latest version of a plan and should be available for self-service usage.



33
34
35
 
# File 'lib/ory-client/models/plan_details.rb', line 33

def latest
  @latest
end

#name ⇒ Object

Name is the name of the plan.



36
37
38
 
# File 'lib/ory-client/models/plan_details.rb', line 36

def name
  @name
end

#version ⇒ Object

Version is the version of the plan. The combination of ‘name@version` must be unique.



39
40
41
 
# File 'lib/ory-client/models/plan_details.rb', line 39

def version
  @version
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



324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
 
# File 'lib/ory-client/models/plan_details.rb', line 324

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_attribute_map ⇒ Object

Returns attribute mapping this model knows about



56
57
58
 
# File 'lib/ory-client/models/plan_details.rb', line 56

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



61
62
63
 
# File 'lib/ory-client/models/plan_details.rb', line 61

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/ory-client/models/plan_details.rb', line 42

def self.attribute_map
  {
    :'base_fee_monthly' => :'base_fee_monthly',
    :'base_fee_yearly' => :'base_fee_yearly',
    :'custom' => :'custom',
    :'description' => :'description',
    :'features' => :'features',
    :'latest' => :'latest',
    :'name' => :'name',
    :'version' => :'version'
  }
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



300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
 
# File 'lib/ory-client/models/plan_details.rb', line 300

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



80
81
82
83
 
# File 'lib/ory-client/models/plan_details.rb', line 80

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

.openapi_types ⇒ Object

Attribute type mapping.



66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/ory-client/models/plan_details.rb', line 66

def self.openapi_types
  {
    :'base_fee_monthly' => :'Integer',
    :'base_fee_yearly' => :'Integer',
    :'custom' => :'Boolean',
    :'description' => :'String',
    :'features' => :'Hash<String, GenericUsage>',
    :'latest' => :'Boolean',
    :'name' => :'String',
    :'version' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/ory-client/models/plan_details.rb', line 272

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      base_fee_monthly == o.base_fee_monthly &&
      base_fee_yearly == o.base_fee_yearly &&
      custom == o.custom &&
      description == o.description &&
      features == o.features &&
      latest == o.latest &&
      name == o.name &&
      version == o.version
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



395
396
397
398
399
400
401
402
403
404
405
406
407
 
# File 'lib/ory-client/models/plan_details.rb', line 395

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


287
288
289
 
# File 'lib/ory-client/models/plan_details.rb', line 287

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



293
294
295
 
# File 'lib/ory-client/models/plan_details.rb', line 293

def hash
  [base_fee_monthly, base_fee_yearly, custom, description, features, latest, name, version].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



152
153
154
155
156
157
158
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
 
# File 'lib/ory-client/models/plan_details.rb', line 152

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

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

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

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

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

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

  if @version.nil?
    invalid_properties.push('invalid value for "version", version 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



371
372
373
 
# File 'lib/ory-client/models/plan_details.rb', line 371

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



377
378
379
380
381
382
383
384
385
386
387
388
389
 
# File 'lib/ory-client/models/plan_details.rb', line 377

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



365
366
367
 
# File 'lib/ory-client/models/plan_details.rb', line 365

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



188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/ory-client/models/plan_details.rb', line 188

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @base_fee_monthly.nil?
  return false if @base_fee_yearly.nil?
  return false if @custom.nil?
  return false if @description.nil?
  return false if @features.nil?
  return false if @name.nil?
  return false if @version.nil?
  true
end