class ClickSendClient::PostRecipient

PostRecipient model

Attributes

address_city[RW]

City

address_country[RW]

Country

address_line_1[RW]

First line of address

address_line_2[RW]

Second line of address

address_name[RW]

Name of address

address_postal_code[RW]

Postal code

address_state[RW]

State

return_address_id[RW]

ID of return address to use

schedule[RW]

When to send letter (0/null=now)

Public Class Methods

attribute_map() click to toggle source

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

# File lib/clicksend_client/models/post_recipient.rb, line 46
def self.attribute_map
  {
    :'address_name' => :'address_name',
    :'address_line_1' => :'address_line_1',
    :'address_line_2' => :'address_line_2',
    :'address_city' => :'address_city',
    :'address_state' => :'address_state',
    :'address_postal_code' => :'address_postal_code',
    :'address_country' => :'address_country',
    :'return_address_id' => :'return_address_id',
    :'schedule' => :'schedule'
  }
end
clicksend_types() click to toggle source

Attribute type mapping.

# File lib/clicksend_client/models/post_recipient.rb, line 61
def self.clicksend_types
  {
    :'address_name' => :'String',
    :'address_line_1' => :'String',
    :'address_line_2' => :'String',
    :'address_city' => :'String',
    :'address_state' => :'String',
    :'address_postal_code' => :'String',
    :'address_country' => :'String',
    :'return_address_id' => :'Integer',
    :'schedule' => :'Integer'
  }
end
new(attributes = {}) click to toggle source

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

# File lib/clicksend_client/models/post_recipient.rb, line 77
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?(:'address_name')
    self.address_name = attributes[:'address_name']
  end

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

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

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

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

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

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

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

  if attributes.has_key?(:'schedule')
    self.schedule = attributes[:'schedule']
  else
    self.schedule = 0
  end
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/clicksend_client/models/post_recipient.rb, line 172
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      address_name == o.address_name &&
      address_line_1 == o.address_line_1 &&
      address_line_2 == o.address_line_2 &&
      address_city == o.address_city &&
      address_state == o.address_state &&
      address_postal_code == o.address_postal_code &&
      address_country == o.address_country &&
      return_address_id == o.return_address_id &&
      schedule == o.schedule
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/clicksend_client/models/post_recipient.rb, line 222
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 = ClickSendClient.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/clicksend_client/models/post_recipient.rb, line 288
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/clicksend_client/models/post_recipient.rb, line 201
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.clicksend_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the 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/clicksend_client/models/post_recipient.rb, line 188
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/clicksend_client/models/post_recipient.rb, line 194
def hash
  [address_name, address_line_1, address_line_2, address_city, address_state, address_postal_code, address_country, return_address_id, schedule].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/clicksend_client/models/post_recipient.rb, line 124
def list_invalid_properties
  invalid_properties = Array.new
  if @address_name.nil?
    invalid_properties.push('invalid value for "address_name", address_name cannot be nil.')
  end

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

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

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

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

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

  if @return_address_id.nil?
    invalid_properties.push('invalid value for "return_address_id", return_address_id 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/clicksend_client/models/post_recipient.rb, line 268
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/clicksend_client/models/post_recipient.rb, line 274
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/clicksend_client/models/post_recipient.rb, line 262
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/clicksend_client/models/post_recipient.rb, line 159
def valid?
  return false if @address_name.nil?
  return false if @address_line_1.nil?
  return false if @address_city.nil?
  return false if @address_state.nil?
  return false if @address_postal_code.nil?
  return false if @address_country.nil?
  return false if @return_address_id.nil?
  true
end