Class: Conekta::PlanRequest
- Inherits:
-
Object
- Object
- Conekta::PlanRequest
- Defined in:
- lib/conekta/models/plan_request.rb
Overview
a plan
Defined Under Namespace
Classes: EnumAttributeValidator
Instance Attribute Summary collapse
-
#amount ⇒ Object
The amount in cents that will be charged on the interval specified.
-
#currency ⇒ Object
ISO 4217 for currencies, for the Mexican peso it is MXN/USD.
-
#expiry_count ⇒ Object
Number of repetitions of the frequency NUMBER OF CHARGES TO BE MADE, considering the interval and frequency, this evolves over time, but is subject to the expiration count.
-
#frequency ⇒ Object
Frequency of the charge, which together with the interval, can be every 3 weeks, every 4 months, every 2 years, every 5 fortnights.
-
#id ⇒ Object
internal reference id.
-
#interval ⇒ Object
The interval of time between each charge.
-
#max_retries ⇒ Object
(optional) Specifies the maximum number of retry attempts for a subscription payment before it is canceled.
-
#name ⇒ Object
The name of the plan.
-
#retry_delay_hours ⇒ Object
(optional) Defines the number of hours between subscription payment retry attempts.
-
#trial_period_days ⇒ Object
The number of days the customer will have a free trial.
Class Method Summary collapse
-
._deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
.acceptable_attributes ⇒ Object
Returns all the JSON keys this model knows about.
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.build_from_hash(attributes) ⇒ Object
Builds the object from hash.
-
.openapi_nullable ⇒ Object
List of attributes with nullable: true.
-
.openapi_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Integer
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ PlanRequest
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ PlanRequest
Initializes the object
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 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 |
# File 'lib/conekta/models/plan_request.rb', line 116 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Conekta::PlanRequest` 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 `Conekta::PlanRequest`. 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?(:'amount') self.amount = attributes[:'amount'] else self.amount = nil end if attributes.key?(:'currency') self.currency = attributes[:'currency'] end if attributes.key?(:'expiry_count') self.expiry_count = attributes[:'expiry_count'] end if attributes.key?(:'frequency') self.frequency = attributes[:'frequency'] else self.frequency = nil end if attributes.key?(:'id') self.id = attributes[:'id'] end if attributes.key?(:'interval') self.interval = attributes[:'interval'] else self.interval = nil end if attributes.key?(:'name') self.name = attributes[:'name'] else self.name = nil end if attributes.key?(:'trial_period_days') self.trial_period_days = attributes[:'trial_period_days'] end if attributes.key?(:'max_retries') self.max_retries = attributes[:'max_retries'] end if attributes.key?(:'retry_delay_hours') self.retry_delay_hours = attributes[:'retry_delay_hours'] end end |
Instance Attribute Details
#amount ⇒ Object
The amount in cents that will be charged on the interval specified.
20 21 22 |
# File 'lib/conekta/models/plan_request.rb', line 20 def amount @amount end |
#currency ⇒ Object
ISO 4217 for currencies, for the Mexican peso it is MXN/USD
23 24 25 |
# File 'lib/conekta/models/plan_request.rb', line 23 def currency @currency end |
#expiry_count ⇒ Object
Number of repetitions of the frequency NUMBER OF CHARGES TO BE MADE, considering the interval and frequency, this evolves over time, but is subject to the expiration count.
26 27 28 |
# File 'lib/conekta/models/plan_request.rb', line 26 def expiry_count @expiry_count end |
#frequency ⇒ Object
Frequency of the charge, which together with the interval, can be every 3 weeks, every 4 months, every 2 years, every 5 fortnights
29 30 31 |
# File 'lib/conekta/models/plan_request.rb', line 29 def frequency @frequency end |
#id ⇒ Object
internal reference id
32 33 34 |
# File 'lib/conekta/models/plan_request.rb', line 32 def id @id end |
#interval ⇒ Object
The interval of time between each charge.
35 36 37 |
# File 'lib/conekta/models/plan_request.rb', line 35 def interval @interval end |
#max_retries ⇒ Object
(optional) Specifies the maximum number of retry attempts for a subscription payment before it is canceled.
44 45 46 |
# File 'lib/conekta/models/plan_request.rb', line 44 def max_retries @max_retries end |
#name ⇒ Object
The name of the plan.
38 39 40 |
# File 'lib/conekta/models/plan_request.rb', line 38 def name @name end |
#retry_delay_hours ⇒ Object
(optional) Defines the number of hours between subscription payment retry attempts.
47 48 49 |
# File 'lib/conekta/models/plan_request.rb', line 47 def retry_delay_hours @retry_delay_hours end |
#trial_period_days ⇒ Object
The number of days the customer will have a free trial.
41 42 43 |
# File 'lib/conekta/models/plan_request.rb', line 41 def trial_period_days @trial_period_days end |
Class Method Details
._deserialize(type, value) ⇒ Object
Deserializes the data based on type
376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 |
# File 'lib/conekta/models/plan_request.rb', line 376 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 = Conekta.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
88 89 90 |
# File 'lib/conekta/models/plan_request.rb', line 88 def self.acceptable_attributes attribute_map.values end |
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
72 73 74 75 76 77 78 79 80 81 82 83 84 85 |
# File 'lib/conekta/models/plan_request.rb', line 72 def self.attribute_map { :'amount' => :'amount', :'currency' => :'currency', :'expiry_count' => :'expiry_count', :'frequency' => :'frequency', :'id' => :'id', :'interval' => :'interval', :'name' => :'name', :'trial_period_days' => :'trial_period_days', :'max_retries' => :'max_retries', :'retry_delay_hours' => :'retry_delay_hours' } end |
.build_from_hash(attributes) ⇒ Object
Builds the object from hash
352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 |
# File 'lib/conekta/models/plan_request.rb', line 352 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
109 110 111 112 |
# File 'lib/conekta/models/plan_request.rb', line 109 def self.openapi_nullable Set.new([ ]) end |
.openapi_types ⇒ Object
Attribute type mapping.
93 94 95 96 97 98 99 100 101 102 103 104 105 106 |
# File 'lib/conekta/models/plan_request.rb', line 93 def self.openapi_types { :'amount' => :'Integer', :'currency' => :'String', :'expiry_count' => :'Integer', :'frequency' => :'Integer', :'id' => :'String', :'interval' => :'String', :'name' => :'String', :'trial_period_days' => :'Integer', :'max_retries' => :'Integer', :'retry_delay_hours' => :'Integer' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
322 323 324 325 326 327 328 329 330 331 332 333 334 335 |
# File 'lib/conekta/models/plan_request.rb', line 322 def ==(o) return true if self.equal?(o) self.class == o.class && amount == o.amount && currency == o.currency && expiry_count == o.expiry_count && frequency == o.frequency && id == o.id && interval == o.interval && name == o.name && trial_period_days == o.trial_period_days && max_retries == o.max_retries && retry_delay_hours == o.retry_delay_hours end |
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value
447 448 449 450 451 452 453 454 455 456 457 458 459 |
# File 'lib/conekta/models/plan_request.rb', line 447 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
339 340 341 |
# File 'lib/conekta/models/plan_request.rb', line 339 def eql?(o) self == o end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
345 346 347 |
# File 'lib/conekta/models/plan_request.rb', line 345 def hash [amount, currency, expiry_count, frequency, id, interval, name, trial_period_days, max_retries, retry_delay_hours].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 |
# File 'lib/conekta/models/plan_request.rb', line 180 def list_invalid_properties warn '[DEPRECATED] the `list_invalid_properties` method is obsolete' invalid_properties = Array.new if @amount.nil? invalid_properties.push('invalid value for "amount", amount cannot be nil.') end if @amount < 1 invalid_properties.push('invalid value for "amount", must be greater than or equal to 1.') end if !@currency.nil? && @currency.to_s.length > 3 invalid_properties.push('invalid value for "currency", the character length must be smaller than or equal to 3.') end if @frequency.nil? invalid_properties.push('invalid value for "frequency", frequency cannot be nil.') end if @frequency < 1 invalid_properties.push('invalid value for "frequency", must be greater than or equal to 1.') end if @interval.nil? invalid_properties.push('invalid value for "interval", interval cannot be nil.') end if @name.nil? invalid_properties.push('invalid value for "name", name cannot be nil.') end if !@max_retries.nil? && @max_retries < 3 invalid_properties.push('invalid value for "max_retries", must be greater than or equal to 3.') end if !@retry_delay_hours.nil? && @retry_delay_hours < 48 invalid_properties.push('invalid value for "retry_delay_hours", must be greater than or equal to 48.') end invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
423 424 425 |
# File 'lib/conekta/models/plan_request.rb', line 423 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
429 430 431 432 433 434 435 436 437 438 439 440 441 |
# File 'lib/conekta/models/plan_request.rb', line 429 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
417 418 419 |
# File 'lib/conekta/models/plan_request.rb', line 417 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 |
# File 'lib/conekta/models/plan_request.rb', line 224 def valid? warn '[DEPRECATED] the `valid?` method is obsolete' return false if @amount.nil? return false if @amount < 1 return false if !@currency.nil? && @currency.to_s.length > 3 return false if @frequency.nil? return false if @frequency < 1 return false if @interval.nil? interval_validator = EnumAttributeValidator.new('String', ["week", "half_month", "month", "year"]) return false unless interval_validator.valid?(@interval) return false if @name.nil? return false if !@max_retries.nil? && @max_retries < 3 return false if !@retry_delay_hours.nil? && @retry_delay_hours < 48 true end |