class Conekta::PlanRequest

a plan

Attributes

amount[RW]

The amount in cents that will be charged on the interval specified.

currency[RW]

ISO 4217 for currencies, for the Mexican peso it is MXN/USD

expiry_count[RW]

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[RW]

Frequency of the charge, which together with the interval, can be every 3 weeks, every 4 months, every 2 years, every 5 fortnights

id[RW]

internal reference id

interval[RW]

The interval of time between each charge.

name[RW]

The name of the plan.

trial_period_days[RW]

The number of days the customer will have a free trial.

Public Class Methods

_deserialize(type, value) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/conekta/models/plan_request.rb, line 318
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() click to toggle source

Returns all the JSON keys this model knows about

# File lib/conekta/models/plan_request.rb, line 80
def self.acceptable_attributes
  attribute_map.values
end
attribute_map() click to toggle source

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

# File lib/conekta/models/plan_request.rb, line 66
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'
  }
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/conekta/models/plan_request.rb, line 294
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
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/conekta/models/plan_request.rb, line 106
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
end
openapi_nullable() click to toggle source

List of attributes with nullable: true

# File lib/conekta/models/plan_request.rb, line 99
def self.openapi_nullable
  Set.new([
  ])
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/conekta/models/plan_request.rb, line 85
def self.openapi_types
  {
    :'amount' => :'Integer',
    :'currency' => :'String',
    :'expiry_count' => :'Integer',
    :'frequency' => :'Integer',
    :'id' => :'String',
    :'interval' => :'String',
    :'name' => :'String',
    :'trial_period_days' => :'Integer'
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/conekta/models/plan_request.rb, line 266
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
end
_to_hash(value) click to toggle source

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

# File lib/conekta/models/plan_request.rb, line 389
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
amount=(amount) click to toggle source

Custom attribute writer method with validation @param [Object] amount Value to be assigned

# File lib/conekta/models/plan_request.rb, line 214
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
currency=(currency) click to toggle source

Custom attribute writer method with validation @param [Object] currency Value to be assigned

# File lib/conekta/models/plan_request.rb, line 228
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
eql?(o) click to toggle source

@see the ‘==` method @param [Object] Object to be compared

# File lib/conekta/models/plan_request.rb, line 281
def eql?(o)
  self == o
end
frequency=(frequency) click to toggle source

Custom attribute writer method with validation @param [Object] frequency Value to be assigned

# File lib/conekta/models/plan_request.rb, line 242
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
hash() click to toggle source

Calculates hash code according to all attributes. @return [Integer] Hash code

# File lib/conekta/models/plan_request.rb, line 287
def hash
  [amount, currency, expiry_count, frequency, id, interval, name, trial_period_days].hash
end
interval=(interval) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] interval Object to be assigned

# File lib/conekta/models/plan_request.rb, line 256
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
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File lib/conekta/models/plan_request.rb, line 162
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

  invalid_properties
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/conekta/models/plan_request.rb, line 365
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/conekta/models/plan_request.rb, line 371
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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/conekta/models/plan_request.rb, line 359
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/conekta/models/plan_request.rb, line 198
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?
  true
end