class SquareConnect::OrderFulfillmentRecipient

The recipient of a fulfillment.

Attributes

customer_id[RW]

The Customer ID of the customer associated with the fulfillment. If customer_id is provided, the corresponding recipient information fields (`display_name`, `email_address`, and `phone_number`) are automatically populated from the relevant customer profile. If the targeted profile information does not contain the necessary required information, the request will result in an error.

display_name[RW]

The display name of the fulfillment recipient. If provided, overrides the value from customer profile indicated by customer_id.

email_address[RW]

The email address of the fulfillment recipient. If provided, overrides the value from customer profile indicated by customer_id.

phone_number[RW]

The phone number of the fulfillment recipient. If provided, overrides the value from customer profile indicated by customer_id.

Public Class Methods

attribute_map() click to toggle source

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

# File lib/square_connect/models/order_fulfillment_recipient.rb, line 29
def self.attribute_map
  {
    :'customer_id' => :'customer_id',
    :'display_name' => :'display_name',
    :'email_address' => :'email_address',
    :'phone_number' => :'phone_number'
  }
end
new(attributes = {}) click to toggle source

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

# File lib/square_connect/models/order_fulfillment_recipient.rb, line 50
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?(:'customer_id')
    self.customer_id = attributes[:'customer_id']
  end

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

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

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

end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/square_connect/models/order_fulfillment_recipient.rb, line 39
def self.swagger_types
  {
    :'customer_id' => :'String',
    :'display_name' => :'String',
    :'email_address' => :'String',
    :'phone_number' => :'String'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/square_connect/models/order_fulfillment_recipient.rb, line 137
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      customer_id == o.customer_id &&
      display_name == o.display_name &&
      email_address == o.email_address &&
      phone_number == o.phone_number
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/square_connect/models/order_fulfillment_recipient.rb, line 182
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 = SquareConnect.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/square_connect/models/order_fulfillment_recipient.rb, line 248
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/square_connect/models/order_fulfillment_recipient.rb, line 161
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 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
display_name=(display_name) click to toggle source

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

# File lib/square_connect/models/order_fulfillment_recipient.rb, line 104
def display_name=(display_name)

  if !display_name.nil? && display_name.to_s.length > 255
    fail ArgumentError, "invalid value for 'display_name', the character length must be smaller than or equal to 255."
  end

  @display_name = display_name
end
email_address=(email_address) click to toggle source

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

# File lib/square_connect/models/order_fulfillment_recipient.rb, line 115
def email_address=(email_address)

  if !email_address.nil? && email_address.to_s.length > 255
    fail ArgumentError, "invalid value for 'email_address', the character length must be smaller than or equal to 255."
  end

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

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

# File lib/square_connect/models/order_fulfillment_recipient.rb, line 148
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/square_connect/models/order_fulfillment_recipient.rb, line 154
def hash
  [customer_id, display_name, email_address, phone_number].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properies with the reasons

# File lib/square_connect/models/order_fulfillment_recipient.rb, line 76
def list_invalid_properties
  invalid_properties = Array.new
  if !@display_name.nil? && @display_name.to_s.length > 255
    invalid_properties.push("invalid value for 'display_name', the character length must be smaller than or equal to 255.")
  end

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

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

  return invalid_properties
end
phone_number=(phone_number) click to toggle source

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

# File lib/square_connect/models/order_fulfillment_recipient.rb, line 126
def phone_number=(phone_number)

  if !phone_number.nil? && phone_number.to_s.length > 16
    fail ArgumentError, "invalid value for 'phone_number', the character length must be smaller than or equal to 16."
  end

  @phone_number = phone_number
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/square_connect/models/order_fulfillment_recipient.rb, line 228
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/square_connect/models/order_fulfillment_recipient.rb, line 234
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/square_connect/models/order_fulfillment_recipient.rb, line 222
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/square_connect/models/order_fulfillment_recipient.rb, line 95
def valid?
  return false if !@display_name.nil? && @display_name.to_s.length > 255
  return false if !@email_address.nil? && @email_address.to_s.length > 255
  return false if !@phone_number.nil? && @phone_number.to_s.length > 16
  return true
end