class UltracartClient::PaymentsConfigurationRestrictions

Attributes

descriptions[RW]
maximum_subtotal[RW]

Maximum subtotal

minimum_subtotal[RW]

Minimum subtotal

payment_method[RW]

Payment method

restriction_alaska_hawaii[RW]

Alaska and Hawaii restriction

restriction_apo_fpo[RW]

APO/FPO restriction

restriction_canada[RW]

Canada restriction

restriction_continental_us[RW]

Continental US restriction

restriction_domestic_only[RW]

Domestic only restriction

restriction_international_only[RW]

International only restriction

restriction_po_box[RW]

PO Box restriction

restriction_puerto_rico[RW]

Puerto Rico restriction

restriction_us_territories[RW]

US Territories restriction

themes[RW]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/ultracart_api/models/payments_configuration_restrictions.rb, line 80
def self.attribute_map
  {
    :'descriptions' => :'descriptions',
    :'maximum_subtotal' => :'maximum_subtotal',
    :'minimum_subtotal' => :'minimum_subtotal',
    :'payment_method' => :'payment_method',
    :'restriction_alaska_hawaii' => :'restriction_alaska_hawaii',
    :'restriction_apo_fpo' => :'restriction_apo_fpo',
    :'restriction_canada' => :'restriction_canada',
    :'restriction_continental_us' => :'restriction_continental_us',
    :'restriction_domestic_only' => :'restriction_domestic_only',
    :'restriction_international_only' => :'restriction_international_only',
    :'restriction_po_box' => :'restriction_po_box',
    :'restriction_puerto_rico' => :'restriction_puerto_rico',
    :'restriction_us_territories' => :'restriction_us_territories',
    :'themes' => :'themes'
  }
end
new(attributes = {}) click to toggle source

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

# File lib/ultracart_api/models/payments_configuration_restrictions.rb, line 121
def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

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

  if attributes.has_key?(:'maximum_subtotal')
    self.maximum_subtotal = attributes[:'maximum_subtotal']
  end

  if attributes.has_key?(:'minimum_subtotal')
    self.minimum_subtotal = attributes[:'minimum_subtotal']
  end

  if attributes.has_key?(:'payment_method')
    self.payment_method = attributes[:'payment_method']
  end

  if attributes.has_key?(:'restriction_alaska_hawaii')
    self.restriction_alaska_hawaii = attributes[:'restriction_alaska_hawaii']
  end

  if attributes.has_key?(:'restriction_apo_fpo')
    self.restriction_apo_fpo = attributes[:'restriction_apo_fpo']
  end

  if attributes.has_key?(:'restriction_canada')
    self.restriction_canada = attributes[:'restriction_canada']
  end

  if attributes.has_key?(:'restriction_continental_us')
    self.restriction_continental_us = attributes[:'restriction_continental_us']
  end

  if attributes.has_key?(:'restriction_domestic_only')
    self.restriction_domestic_only = attributes[:'restriction_domestic_only']
  end

  if attributes.has_key?(:'restriction_international_only')
    self.restriction_international_only = attributes[:'restriction_international_only']
  end

  if attributes.has_key?(:'restriction_po_box')
    self.restriction_po_box = attributes[:'restriction_po_box']
  end

  if attributes.has_key?(:'restriction_puerto_rico')
    self.restriction_puerto_rico = attributes[:'restriction_puerto_rico']
  end

  if attributes.has_key?(:'restriction_us_territories')
    self.restriction_us_territories = attributes[:'restriction_us_territories']
  end

  if attributes.has_key?(:'themes')
    if (value = attributes[:'themes']).is_a?(Array)
      self.themes = value
    end
  end
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/ultracart_api/models/payments_configuration_restrictions.rb, line 100
def self.swagger_types
  {
    :'descriptions' => :'Array<String>',
    :'maximum_subtotal' => :'Float',
    :'minimum_subtotal' => :'Float',
    :'payment_method' => :'String',
    :'restriction_alaska_hawaii' => :'String',
    :'restriction_apo_fpo' => :'String',
    :'restriction_canada' => :'String',
    :'restriction_continental_us' => :'String',
    :'restriction_domestic_only' => :'String',
    :'restriction_international_only' => :'String',
    :'restriction_po_box' => :'String',
    :'restriction_puerto_rico' => :'String',
    :'restriction_us_territories' => :'String',
    :'themes' => :'Array<PaymentsConfigurationRestrictionsTheme>'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/ultracart_api/models/payments_configuration_restrictions.rb, line 311
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      descriptions == o.descriptions &&
      maximum_subtotal == o.maximum_subtotal &&
      minimum_subtotal == o.minimum_subtotal &&
      payment_method == o.payment_method &&
      restriction_alaska_hawaii == o.restriction_alaska_hawaii &&
      restriction_apo_fpo == o.restriction_apo_fpo &&
      restriction_canada == o.restriction_canada &&
      restriction_continental_us == o.restriction_continental_us &&
      restriction_domestic_only == o.restriction_domestic_only &&
      restriction_international_only == o.restriction_international_only &&
      restriction_po_box == o.restriction_po_box &&
      restriction_puerto_rico == o.restriction_puerto_rico &&
      restriction_us_territories == o.restriction_us_territories &&
      themes == o.themes
end
_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/ultracart_api/models/payments_configuration_restrictions.rb, line 366
def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.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
    temp_model = UltracartClient.const_get(type).new
    temp_model.build_from_hash(value)
  end
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/ultracart_api/models/payments_configuration_restrictions.rb, line 432
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
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/ultracart_api/models/payments_configuration_restrictions.rb, line 345
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if 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[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end
eql?(o) click to toggle source

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

# File lib/ultracart_api/models/payments_configuration_restrictions.rb, line 332
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/ultracart_api/models/payments_configuration_restrictions.rb, line 338
def hash
  [descriptions, maximum_subtotal, minimum_subtotal, payment_method, restriction_alaska_hawaii, restriction_apo_fpo, restriction_canada, restriction_continental_us, restriction_domestic_only, restriction_international_only, restriction_po_box, restriction_puerto_rico, restriction_us_territories, themes].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/ultracart_api/models/payments_configuration_restrictions.rb, line 190
def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end
restriction_alaska_hawaii=(restriction_alaska_hawaii) click to toggle source

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

# File lib/ultracart_api/models/payments_configuration_restrictions.rb, line 221
def restriction_alaska_hawaii=(restriction_alaska_hawaii)
  validator = EnumAttributeValidator.new('String', ['invalid', 'invalidOnly', 'valid'])
  unless validator.valid?(restriction_alaska_hawaii)
    fail ArgumentError, 'invalid value for "restriction_alaska_hawaii", must be one of #{validator.allowable_values}.'
  end
  @restriction_alaska_hawaii = restriction_alaska_hawaii
end
restriction_apo_fpo=(restriction_apo_fpo) click to toggle source

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

# File lib/ultracart_api/models/payments_configuration_restrictions.rb, line 231
def restriction_apo_fpo=(restriction_apo_fpo)
  validator = EnumAttributeValidator.new('String', ['invalid', 'invalidOnly', 'valid'])
  unless validator.valid?(restriction_apo_fpo)
    fail ArgumentError, 'invalid value for "restriction_apo_fpo", must be one of #{validator.allowable_values}.'
  end
  @restriction_apo_fpo = restriction_apo_fpo
end
restriction_canada=(restriction_canada) click to toggle source

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

# File lib/ultracart_api/models/payments_configuration_restrictions.rb, line 241
def restriction_canada=(restriction_canada)
  validator = EnumAttributeValidator.new('String', ['invalid', 'invalidOnly', 'valid'])
  unless validator.valid?(restriction_canada)
    fail ArgumentError, 'invalid value for "restriction_canada", must be one of #{validator.allowable_values}.'
  end
  @restriction_canada = restriction_canada
end
restriction_continental_us=(restriction_continental_us) click to toggle source

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

# File lib/ultracart_api/models/payments_configuration_restrictions.rb, line 251
def restriction_continental_us=(restriction_continental_us)
  validator = EnumAttributeValidator.new('String', ['invalid', 'invalidOnly', 'valid'])
  unless validator.valid?(restriction_continental_us)
    fail ArgumentError, 'invalid value for "restriction_continental_us", must be one of #{validator.allowable_values}.'
  end
  @restriction_continental_us = restriction_continental_us
end
restriction_domestic_only=(restriction_domestic_only) click to toggle source

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

# File lib/ultracart_api/models/payments_configuration_restrictions.rb, line 261
def restriction_domestic_only=(restriction_domestic_only)
  validator = EnumAttributeValidator.new('String', ['invalid', 'invalidOnly', 'valid'])
  unless validator.valid?(restriction_domestic_only)
    fail ArgumentError, 'invalid value for "restriction_domestic_only", must be one of #{validator.allowable_values}.'
  end
  @restriction_domestic_only = restriction_domestic_only
end
restriction_international_only=(restriction_international_only) click to toggle source

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

# File lib/ultracart_api/models/payments_configuration_restrictions.rb, line 271
def restriction_international_only=(restriction_international_only)
  validator = EnumAttributeValidator.new('String', ['invalid', 'invalidOnly', 'valid'])
  unless validator.valid?(restriction_international_only)
    fail ArgumentError, 'invalid value for "restriction_international_only", must be one of #{validator.allowable_values}.'
  end
  @restriction_international_only = restriction_international_only
end
restriction_po_box=(restriction_po_box) click to toggle source

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

# File lib/ultracart_api/models/payments_configuration_restrictions.rb, line 281
def restriction_po_box=(restriction_po_box)
  validator = EnumAttributeValidator.new('String', ['invalid', 'invalidOnly', 'valid'])
  unless validator.valid?(restriction_po_box)
    fail ArgumentError, 'invalid value for "restriction_po_box", must be one of #{validator.allowable_values}.'
  end
  @restriction_po_box = restriction_po_box
end
restriction_puerto_rico=(restriction_puerto_rico) click to toggle source

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

# File lib/ultracart_api/models/payments_configuration_restrictions.rb, line 291
def restriction_puerto_rico=(restriction_puerto_rico)
  validator = EnumAttributeValidator.new('String', ['invalid', 'invalidOnly', 'valid'])
  unless validator.valid?(restriction_puerto_rico)
    fail ArgumentError, 'invalid value for "restriction_puerto_rico", must be one of #{validator.allowable_values}.'
  end
  @restriction_puerto_rico = restriction_puerto_rico
end
restriction_us_territories=(restriction_us_territories) click to toggle source

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

# File lib/ultracart_api/models/payments_configuration_restrictions.rb, line 301
def restriction_us_territories=(restriction_us_territories)
  validator = EnumAttributeValidator.new('String', ['invalid', 'invalidOnly', 'valid'])
  unless validator.valid?(restriction_us_territories)
    fail ArgumentError, 'invalid value for "restriction_us_territories", must be one of #{validator.allowable_values}.'
  end
  @restriction_us_territories = restriction_us_territories
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/ultracart_api/models/payments_configuration_restrictions.rb, line 412
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/ultracart_api/models/payments_configuration_restrictions.rb, line 418
def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    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/ultracart_api/models/payments_configuration_restrictions.rb, line 406
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/ultracart_api/models/payments_configuration_restrictions.rb, line 197
def valid?
  restriction_alaska_hawaii_validator = EnumAttributeValidator.new('String', ['invalid', 'invalidOnly', 'valid'])
  return false unless restriction_alaska_hawaii_validator.valid?(@restriction_alaska_hawaii)
  restriction_apo_fpo_validator = EnumAttributeValidator.new('String', ['invalid', 'invalidOnly', 'valid'])
  return false unless restriction_apo_fpo_validator.valid?(@restriction_apo_fpo)
  restriction_canada_validator = EnumAttributeValidator.new('String', ['invalid', 'invalidOnly', 'valid'])
  return false unless restriction_canada_validator.valid?(@restriction_canada)
  restriction_continental_us_validator = EnumAttributeValidator.new('String', ['invalid', 'invalidOnly', 'valid'])
  return false unless restriction_continental_us_validator.valid?(@restriction_continental_us)
  restriction_domestic_only_validator = EnumAttributeValidator.new('String', ['invalid', 'invalidOnly', 'valid'])
  return false unless restriction_domestic_only_validator.valid?(@restriction_domestic_only)
  restriction_international_only_validator = EnumAttributeValidator.new('String', ['invalid', 'invalidOnly', 'valid'])
  return false unless restriction_international_only_validator.valid?(@restriction_international_only)
  restriction_po_box_validator = EnumAttributeValidator.new('String', ['invalid', 'invalidOnly', 'valid'])
  return false unless restriction_po_box_validator.valid?(@restriction_po_box)
  restriction_puerto_rico_validator = EnumAttributeValidator.new('String', ['invalid', 'invalidOnly', 'valid'])
  return false unless restriction_puerto_rico_validator.valid?(@restriction_puerto_rico)
  restriction_us_territories_validator = EnumAttributeValidator.new('String', ['invalid', 'invalidOnly', 'valid'])
  return false unless restriction_us_territories_validator.valid?(@restriction_us_territories)
  true
end