class Conekta::Product

Attributes

antifraud_info[RW]
brand[RW]

The brand of the item.

description[RW]

Short description of the item

metadata[RW]

It is a key/value hash that can hold custom fields. Maximum 100 elements and allows special characters.

name[RW]

The name of the item. It will be displayed in the order.

quantity[RW]

The quantity of the item in the order.

sku[RW]

The stock keeping unit for the item. It is used to identify the item in the order.

tags[RW]

List of tags for the item. It is used to identify the item in the order.

unit_price[RW]

The price of the item in cents.

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/product.rb, line 310
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/product.rb, line 60
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/product.rb, line 45
def self.attribute_map
  {
    :'antifraud_info' => :'antifraud_info',
    :'brand' => :'brand',
    :'description' => :'description',
    :'metadata' => :'metadata',
    :'name' => :'name',
    :'quantity' => :'quantity',
    :'sku' => :'sku',
    :'tags' => :'tags',
    :'unit_price' => :'unit_price'
  }
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/product.rb, line 286
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/product.rb, line 87
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Conekta::Product` 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::Product`. 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?(:'antifraud_info')
    if (value = attributes[:'antifraud_info']).is_a?(Hash)
      self.antifraud_info = value
    end
  end

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

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

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

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

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

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

  if attributes.key?(:'tags')
    if (value = attributes[:'tags']).is_a?(Array)
      self.tags = value
    end
  end

  if attributes.key?(:'unit_price')
    self.unit_price = attributes[:'unit_price']
  else
    self.unit_price = nil
  end
end
openapi_nullable() click to toggle source

List of attributes with nullable: true

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

Attribute type mapping.

# File lib/conekta/models/product.rb, line 65
def self.openapi_types
  {
    :'antifraud_info' => :'Hash<String, Object>',
    :'brand' => :'String',
    :'description' => :'String',
    :'metadata' => :'Hash<String, Object>',
    :'name' => :'String',
    :'quantity' => :'Integer',
    :'sku' => :'String',
    :'tags' => :'Array<String>',
    :'unit_price' => :'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/product.rb, line 257
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      antifraud_info == o.antifraud_info &&
      brand == o.brand &&
      description == o.description &&
      metadata == o.metadata &&
      name == o.name &&
      quantity == o.quantity &&
      sku == o.sku &&
      tags == o.tags &&
      unit_price == o.unit_price
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/product.rb, line 381
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
description=(description) click to toggle source

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

# File lib/conekta/models/product.rb, line 201
def description=(description)
  if description.nil?
    fail ArgumentError, 'description cannot be nil'
  end

  if description.to_s.length > 250
    fail ArgumentError, 'invalid value for "description", the character length must be smaller than or equal to 250.'
  end

  @description = description
end
eql?(o) click to toggle source

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

# File lib/conekta/models/product.rb, line 273
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/conekta/models/product.rb, line 279
def hash
  [antifraud_info, brand, description, metadata, name, quantity, sku, tags, unit_price].hash
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/product.rb, line 151
def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if !@description.nil? && @description.to_s.length > 250
    invalid_properties.push('invalid value for "description", the character length must be smaller than or equal to 250.')
  end

  if !@metadata.nil? && @metadata.length > 100
    invalid_properties.push('invalid value for "metadata", number of items must be less than or equal to 100.')
  end

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

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

  if @quantity < 1
    invalid_properties.push('invalid value for "quantity", must be greater than or equal to 1.')
  end

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

  if @unit_price < 0
    invalid_properties.push('invalid value for "unit_price", must be greater than or equal to 0.')
  end

  invalid_properties
end
metadata=(metadata) click to toggle source

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

# File lib/conekta/models/product.rb, line 215
def metadata=(metadata)
  if metadata.nil?
    fail ArgumentError, 'metadata cannot be nil'
  end

  if metadata.length > 100
    fail ArgumentError, 'invalid value for "metadata", number of items must be less than or equal to 100.'
  end

  @metadata = metadata
end
quantity=(quantity) click to toggle source

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

# File lib/conekta/models/product.rb, line 229
def quantity=(quantity)
  if quantity.nil?
    fail ArgumentError, 'quantity cannot be nil'
  end

  if quantity < 1
    fail ArgumentError, 'invalid value for "quantity", must be greater than or equal to 1.'
  end

  @quantity = quantity
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/product.rb, line 357
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/product.rb, line 363
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/product.rb, line 351
def to_s
  to_hash.to_s
end
unit_price=(unit_price) click to toggle source

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

# File lib/conekta/models/product.rb, line 243
def unit_price=(unit_price)
  if unit_price.nil?
    fail ArgumentError, 'unit_price cannot be nil'
  end

  if unit_price < 0
    fail ArgumentError, 'invalid value for "unit_price", must be greater than or equal to 0.'
  end

  @unit_price = unit_price
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/product.rb, line 187
def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !@description.nil? && @description.to_s.length > 250
  return false if !@metadata.nil? && @metadata.length > 100
  return false if @name.nil?
  return false if @quantity.nil?
  return false if @quantity < 1
  return false if @unit_price.nil?
  return false if @unit_price < 0
  true
end