class UltracartClient::OrderBilling

Attributes

address1[RW]

Address line 1

address2[RW]

Address line 2

cc_emails[RW]

CC emails. Multiple allowed, but total length of all emails can not exceed 100 characters.

city[RW]

City

company[RW]

Company

country_code[RW]

ISO-3166 two letter country code

day_phone[RW]

Day time phone

day_phone_e164[RW]

Day time phone (E164 format)

email[RW]

Email

evening_phone[RW]

Evening phone

first_name[RW]

First name

last_name[RW]

Last name

postal_code[RW]

Postal code

state_region[RW]

State for United States otherwise region or province for other countries

title[RW]

Title

Public Class Methods

attribute_map() click to toggle source

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

# File lib/ultracart_api/models/order_billing.rb, line 63
def self.attribute_map
  {
    :'address1' => :'address1',
    :'address2' => :'address2',
    :'cc_emails' => :'cc_emails',
    :'city' => :'city',
    :'company' => :'company',
    :'country_code' => :'country_code',
    :'day_phone' => :'day_phone',
    :'day_phone_e164' => :'day_phone_e164',
    :'email' => :'email',
    :'evening_phone' => :'evening_phone',
    :'first_name' => :'first_name',
    :'last_name' => :'last_name',
    :'postal_code' => :'postal_code',
    :'state_region' => :'state_region',
    :'title' => :'title'
  }
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/order_billing.rb, line 106
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?(:'address1')
    self.address1 = attributes[:'address1']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

  if attributes.has_key?(:'title')
    self.title = attributes[:'title']
  end
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/ultracart_api/models/order_billing.rb, line 84
def self.swagger_types
  {
    :'address1' => :'String',
    :'address2' => :'String',
    :'cc_emails' => :'Array<String>',
    :'city' => :'String',
    :'company' => :'String',
    :'country_code' => :'String',
    :'day_phone' => :'String',
    :'day_phone_e164' => :'String',
    :'email' => :'String',
    :'evening_phone' => :'String',
    :'first_name' => :'String',
    :'last_name' => :'String',
    :'postal_code' => :'String',
    :'state_region' => :'String',
    :'title' => :'String'
  }
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/order_billing.rb, line 400
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      address1 == o.address1 &&
      address2 == o.address2 &&
      cc_emails == o.cc_emails &&
      city == o.city &&
      company == o.company &&
      country_code == o.country_code &&
      day_phone == o.day_phone &&
      day_phone_e164 == o.day_phone_e164 &&
      email == o.email &&
      evening_phone == o.evening_phone &&
      first_name == o.first_name &&
      last_name == o.last_name &&
      postal_code == o.postal_code &&
      state_region == o.state_region &&
      title == o.title
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/order_billing.rb, line 456
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/order_billing.rb, line 522
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
address1=(address1) click to toggle source

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

# File lib/ultracart_api/models/order_billing.rb, line 260
def address1=(address1)
  if !address1.nil? && address1.to_s.length > 50
    fail ArgumentError, 'invalid value for "address1", the character length must be smaller than or equal to 50.'
  end

  @address1 = address1
end
address2=(address2) click to toggle source

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

# File lib/ultracart_api/models/order_billing.rb, line 270
def address2=(address2)
  if !address2.nil? && address2.to_s.length > 50
    fail ArgumentError, 'invalid value for "address2", the character length must be smaller than or equal to 50.'
  end

  @address2 = address2
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/order_billing.rb, line 435
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
city=(city) click to toggle source

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

# File lib/ultracart_api/models/order_billing.rb, line 280
def city=(city)
  if !city.nil? && city.to_s.length > 32
    fail ArgumentError, 'invalid value for "city", the character length must be smaller than or equal to 32.'
  end

  @city = city
end
company=(company) click to toggle source

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

# File lib/ultracart_api/models/order_billing.rb, line 290
def company=(company)
  if !company.nil? && company.to_s.length > 50
    fail ArgumentError, 'invalid value for "company", the character length must be smaller than or equal to 50.'
  end

  @company = company
end
country_code=(country_code) click to toggle source

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

# File lib/ultracart_api/models/order_billing.rb, line 300
def country_code=(country_code)
  if !country_code.nil? && country_code.to_s.length > 2
    fail ArgumentError, 'invalid value for "country_code", the character length must be smaller than or equal to 2.'
  end

  @country_code = country_code
end
day_phone=(day_phone) click to toggle source

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

# File lib/ultracart_api/models/order_billing.rb, line 310
def day_phone=(day_phone)
  if !day_phone.nil? && day_phone.to_s.length > 25
    fail ArgumentError, 'invalid value for "day_phone", the character length must be smaller than or equal to 25.'
  end

  @day_phone = day_phone
end
day_phone_e164=(day_phone_e164) click to toggle source

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

# File lib/ultracart_api/models/order_billing.rb, line 320
def day_phone_e164=(day_phone_e164)
  if !day_phone_e164.nil? && day_phone_e164.to_s.length > 25
    fail ArgumentError, 'invalid value for "day_phone_e164", the character length must be smaller than or equal to 25.'
  end

  @day_phone_e164 = day_phone_e164
end
email=(email) click to toggle source

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

# File lib/ultracart_api/models/order_billing.rb, line 330
def email=(email)
  if !email.nil? && email.to_s.length > 100
    fail ArgumentError, 'invalid value for "email", the character length must be smaller than or equal to 100.'
  end

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

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

# File lib/ultracart_api/models/order_billing.rb, line 422
def eql?(o)
  self == o
end
evening_phone=(evening_phone) click to toggle source

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

# File lib/ultracart_api/models/order_billing.rb, line 340
def evening_phone=(evening_phone)
  if !evening_phone.nil? && evening_phone.to_s.length > 25
    fail ArgumentError, 'invalid value for "evening_phone", the character length must be smaller than or equal to 25.'
  end

  @evening_phone = evening_phone
end
first_name=(first_name) click to toggle source

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

# File lib/ultracart_api/models/order_billing.rb, line 350
def first_name=(first_name)
  if !first_name.nil? && first_name.to_s.length > 30
    fail ArgumentError, 'invalid value for "first_name", the character length must be smaller than or equal to 30.'
  end

  @first_name = first_name
end
hash() click to toggle source

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

# File lib/ultracart_api/models/order_billing.rb, line 428
def hash
  [address1, address2, cc_emails, city, company, country_code, day_phone, day_phone_e164, email, evening_phone, first_name, last_name, postal_code, state_region, title].hash
end
last_name=(last_name) click to toggle source

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

# File lib/ultracart_api/models/order_billing.rb, line 360
def last_name=(last_name)
  if !last_name.nil? && last_name.to_s.length > 30
    fail ArgumentError, 'invalid value for "last_name", the character length must be smaller than or equal to 30.'
  end

  @last_name = last_name
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/order_billing.rb, line 177
def list_invalid_properties
  invalid_properties = Array.new
  if !@address1.nil? && @address1.to_s.length > 50
    invalid_properties.push('invalid value for "address1", the character length must be smaller than or equal to 50.')
  end

  if !@address2.nil? && @address2.to_s.length > 50
    invalid_properties.push('invalid value for "address2", the character length must be smaller than or equal to 50.')
  end

  if !@city.nil? && @city.to_s.length > 32
    invalid_properties.push('invalid value for "city", the character length must be smaller than or equal to 32.')
  end

  if !@company.nil? && @company.to_s.length > 50
    invalid_properties.push('invalid value for "company", the character length must be smaller than or equal to 50.')
  end

  if !@country_code.nil? && @country_code.to_s.length > 2
    invalid_properties.push('invalid value for "country_code", the character length must be smaller than or equal to 2.')
  end

  if !@day_phone.nil? && @day_phone.to_s.length > 25
    invalid_properties.push('invalid value for "day_phone", the character length must be smaller than or equal to 25.')
  end

  if !@day_phone_e164.nil? && @day_phone_e164.to_s.length > 25
    invalid_properties.push('invalid value for "day_phone_e164", the character length must be smaller than or equal to 25.')
  end

  if !@email.nil? && @email.to_s.length > 100
    invalid_properties.push('invalid value for "email", the character length must be smaller than or equal to 100.')
  end

  if !@evening_phone.nil? && @evening_phone.to_s.length > 25
    invalid_properties.push('invalid value for "evening_phone", the character length must be smaller than or equal to 25.')
  end

  if !@first_name.nil? && @first_name.to_s.length > 30
    invalid_properties.push('invalid value for "first_name", the character length must be smaller than or equal to 30.')
  end

  if !@last_name.nil? && @last_name.to_s.length > 30
    invalid_properties.push('invalid value for "last_name", the character length must be smaller than or equal to 30.')
  end

  if !@postal_code.nil? && @postal_code.to_s.length > 20
    invalid_properties.push('invalid value for "postal_code", the character length must be smaller than or equal to 20.')
  end

  if !@state_region.nil? && @state_region.to_s.length > 32
    invalid_properties.push('invalid value for "state_region", the character length must be smaller than or equal to 32.')
  end

  if !@title.nil? && @title.to_s.length > 50
    invalid_properties.push('invalid value for "title", the character length must be smaller than or equal to 50.')
  end

  invalid_properties
end
postal_code=(postal_code) click to toggle source

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

# File lib/ultracart_api/models/order_billing.rb, line 370
def postal_code=(postal_code)
  if !postal_code.nil? && postal_code.to_s.length > 20
    fail ArgumentError, 'invalid value for "postal_code", the character length must be smaller than or equal to 20.'
  end

  @postal_code = postal_code
end
state_region=(state_region) click to toggle source

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

# File lib/ultracart_api/models/order_billing.rb, line 380
def state_region=(state_region)
  if !state_region.nil? && state_region.to_s.length > 32
    fail ArgumentError, 'invalid value for "state_region", the character length must be smaller than or equal to 32.'
  end

  @state_region = state_region
end
title=(title) click to toggle source

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

# File lib/ultracart_api/models/order_billing.rb, line 390
def title=(title)
  if !title.nil? && title.to_s.length > 50
    fail ArgumentError, 'invalid value for "title", the character length must be smaller than or equal to 50.'
  end

  @title = title
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/order_billing.rb, line 502
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/order_billing.rb, line 508
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/order_billing.rb, line 496
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/order_billing.rb, line 240
def valid?
  return false if !@address1.nil? && @address1.to_s.length > 50
  return false if !@address2.nil? && @address2.to_s.length > 50
  return false if !@city.nil? && @city.to_s.length > 32
  return false if !@company.nil? && @company.to_s.length > 50
  return false if !@country_code.nil? && @country_code.to_s.length > 2
  return false if !@day_phone.nil? && @day_phone.to_s.length > 25
  return false if !@day_phone_e164.nil? && @day_phone_e164.to_s.length > 25
  return false if !@email.nil? && @email.to_s.length > 100
  return false if !@evening_phone.nil? && @evening_phone.to_s.length > 25
  return false if !@first_name.nil? && @first_name.to_s.length > 30
  return false if !@last_name.nil? && @last_name.to_s.length > 30
  return false if !@postal_code.nil? && @postal_code.to_s.length > 20
  return false if !@state_region.nil? && @state_region.to_s.length > 32
  return false if !@title.nil? && @title.to_s.length > 50
  true
end