class Yapstone::Guest

The primary individual who will be staying in the booking.

Attributes

address[RW]
email_address[RW]

The email address of the customer.

external_guest_id[RW]

Optionally provide your system's internal identifier for this entity, for use later if you need to correlate data across systems or consolidate records.

guest_id[RW]

If you'd like to use an existing guest record instead of creating a new one, provide Yapstone's ID of that record here. In this case you can omit the other guest fields.

name[RW]
phone[RW]
same_as_customer[RW]

This indicates whether a customer's information is consistent and accurate everywhere across the system for the account.

Public Class Methods

attribute_map() click to toggle source

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

# File lib/yapstone-payments/models/guest.rb, line 37
def self.attribute_map
  {
    :'same_as_customer' => :'sameAsCustomer',
    :'address' => :'address',
    :'email_address' => :'emailAddress',
    :'name' => :'name',
    :'phone' => :'phone',
    :'guest_id' => :'guestId',
    :'external_guest_id' => :'externalGuestId'
  }
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/yapstone-payments/models/guest.rb, line 150
def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end
new(attributes = {}) click to toggle source

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

# File lib/yapstone-payments/models/guest.rb, line 64
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Yapstone::Guest` 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 `Yapstone::Guest`. 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?(:'same_as_customer')
    self.same_as_customer = attributes[:'same_as_customer']
  else
    self.same_as_customer = false
  end

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

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

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

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

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

  if attributes.key?(:'external_guest_id')
    self.external_guest_id = attributes[:'external_guest_id']
  end
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/yapstone-payments/models/guest.rb, line 50
def self.openapi_types
  {
    :'same_as_customer' => :'Boolean',
    :'address' => :'Address',
    :'email_address' => :'String',
    :'name' => :'Name',
    :'phone' => :'Phone',
    :'guest_id' => :'String',
    :'external_guest_id' => :'String'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/yapstone-payments/models/guest.rb, line 123
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      same_as_customer == o.same_as_customer &&
      address == o.address &&
      email_address == o.email_address &&
      name == o.name &&
      phone == o.phone &&
      guest_id == o.guest_id &&
      external_guest_id == o.external_guest_id
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/yapstone-payments/models/guest.rb, line 178
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
    Yapstone.const_get(type).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/yapstone-payments/models/guest.rb, line 243
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/yapstone-payments/models/guest.rb, line 157
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_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/yapstone-payments/models/guest.rb, line 137
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/yapstone-payments/models/guest.rb, line 143
def hash
  [same_as_customer, address, email_address, name, phone, guest_id, external_guest_id].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/yapstone-payments/models/guest.rb, line 110
def list_invalid_properties
  invalid_properties = Array.new
  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/yapstone-payments/models/guest.rb, line 223
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/yapstone-payments/models/guest.rb, line 229
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/yapstone-payments/models/guest.rb, line 217
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/yapstone-payments/models/guest.rb, line 117
def valid?
  true
end