class Conekta::PlanRequest
a plan
Attributes
The amount in cents that will be charged on the interval specified.
ISO 4217 for currencies, for the Mexican peso it is MXN/USD
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 of the charge, which together with the interval, can be every 3 weeks, every 4 months, every 2 years, every 5 fortnights
internal reference id
The interval of time between each charge.
(optional) Specifies the maximum number of retry attempts for a subscription payment before it is canceled.
The name of the plan.
(optional) Defines the number of hours between subscription payment retry attempts.
The number of days the customer will have a free trial.
Public Class Methods
Source
# 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
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
Source
# File lib/conekta/models/plan_request.rb, line 88 def self.acceptable_attributes attribute_map.values end
Returns all the JSON keys this model knows about
Source
# 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
Attribute mapping from ruby-style variable name to JSON key.
Source
# 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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
Source
# 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
Initializes the object @param [Hash] attributes Model attributes in the form of hash
Source
# File lib/conekta/models/plan_request.rb, line 109 def self.openapi_nullable Set.new([ ]) end
List of attributes with nullable: true
Source
# 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
Attribute type mapping.
Public Instance Methods
Source
# 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
Checks equality by comparing each attribute. @param [Object] Object to be compared
Source
# 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
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash
Source
# File lib/conekta/models/plan_request.rb, line 242 def amount=(amount) if amount.nil? fail ArgumentError, 'amount cannot be nil' end if amount < 1 fail ArgumentError, 'invalid value for "amount", must be greater than or equal to 1.' end @amount = amount end
Custom attribute writer method with validation @param [Object] amount Value to be assigned
Source
# File lib/conekta/models/plan_request.rb, line 256 def currency=(currency) if currency.nil? fail ArgumentError, 'currency cannot be nil' end if currency.to_s.length > 3 fail ArgumentError, 'invalid value for "currency", the character length must be smaller than or equal to 3.' end @currency = currency end
Custom attribute writer method with validation @param [Object] currency Value to be assigned
Source
# File lib/conekta/models/plan_request.rb, line 339 def eql?(o) self == o end
@see the ‘==` method @param [Object] Object to be compared
Source
# File lib/conekta/models/plan_request.rb, line 270 def frequency=(frequency) if frequency.nil? fail ArgumentError, 'frequency cannot be nil' end if frequency < 1 fail ArgumentError, 'invalid value for "frequency", must be greater than or equal to 1.' end @frequency = frequency end
Custom attribute writer method with validation @param [Object] frequency Value to be assigned
Source
# 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
Calculates hash code according to all attributes. @return [Integer] Hash code
Source
# File lib/conekta/models/plan_request.rb, line 284 def interval=(interval) validator = EnumAttributeValidator.new('String', ["week", "half_month", "month", "year"]) unless validator.valid?(interval) fail ArgumentError, "invalid value for \"interval\", must be one of #{validator.allowable_values}." end @interval = interval end
Custom attribute writer method checking allowed values (enum). @param [Object] interval Object to be assigned
Source
# 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
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
Source
# File lib/conekta/models/plan_request.rb, line 294 def max_retries=(max_retries) if max_retries.nil? fail ArgumentError, 'max_retries cannot be nil' end if max_retries < 3 fail ArgumentError, 'invalid value for "max_retries", must be greater than or equal to 3.' end @max_retries = max_retries end
Custom attribute writer method with validation @param [Object] max_retries
Value to be assigned
Source
# File lib/conekta/models/plan_request.rb, line 308 def retry_delay_hours=(retry_delay_hours) if retry_delay_hours.nil? fail ArgumentError, 'retry_delay_hours cannot be nil' end if retry_delay_hours < 48 fail ArgumentError, 'invalid value for "retry_delay_hours", must be greater than or equal to 48.' end @retry_delay_hours = retry_delay_hours end
Custom attribute writer method with validation @param [Object] retry_delay_hours
Value to be assigned
Source
Source
# 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
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
Source
# File lib/conekta/models/plan_request.rb, line 417 def to_s to_hash.to_s end
Returns the string representation of the object @return [String] String presentation of the object
Source
# 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
Check to see if the all the properties in the model are valid @return true if the model is valid