class Bfwd::Profile

Profile

Attributes

account_id[RW]

{ "description" : "", "verbs":["GET"] }

additional_information[RW]

{ "description" : "Any additional information", "verbs":["POST","PUT","GET"] }

addresses[RW]

{ "description" : "Address associated with the profile", "verbs":["POST","PUT","GET"] }

changed_by[RW]

{ "description" : "ID of the user who last updated the entity.", "verbs":[] }

company_name[RW]

{ "description" : "", "verbs":["POST","PUT","GET"] }

created[RW]

{ "description" : "The UTC DateTime when the object was created.", "verbs":[] }

dob[RW]

{ "description" : "Date of birth in YYYY-MM-DD format", "verbs":["POST","PUT","GET"] }

email[RW]

{ "description" : "E-mail address", "verbs":["POST","PUT","GET"] }

fax[RW]

{ "description" : "Fax number", "verbs":["POST","PUT","GET"] }

first_name[RW]

{ "description" : "", "verbs":["POST","PUT","GET"] }

id[RW]

{ "description" : "ID of the profile.", "verbs":["PUT","GET"] }

landline[RW]

{ "description" : "Home telephone number", "verbs":["POST","PUT","GET"] }

last_name[RW]

{ "description" : "", "verbs":["POST","PUT","GET"] }

logo_url[RW]

{ "description" : "", "verbs":["POST","PUT","GET"] }

mobile[RW]

{ "description" : "Mobile telephone number", "verbs":["POST","PUT","GET"] }

organization_id[RW]

{ "description" : "", "verbs":[] }

updated[RW]

{ "description" : "The UTC DateTime when the object was last updated.", "verbs":[] }

vat_number[RW]

{ "description" : "VAT number", "verbs":["POST","PUT","GET"] }

Public Class Methods

attribute_map() click to toggle source

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

# File lib/bf_ruby2/models/profile.rb, line 74
def self.attribute_map
  {
    :'created' => :'created',
    :'changed_by' => :'changedBy',
    :'updated' => :'updated',
    :'id' => :'id',
    :'account_id' => :'accountID',
    :'organization_id' => :'organizationID',
    :'email' => :'email',
    :'first_name' => :'firstName',
    :'last_name' => :'lastName',
    :'company_name' => :'companyName',
    :'logo_url' => :'logoURL',
    :'addresses' => :'addresses',
    :'mobile' => :'mobile',
    :'landline' => :'landline',
    :'fax' => :'fax',
    :'dob' => :'dob',
    :'vat_number' => :'vatNumber',
    :'additional_information' => :'additionalInformation'
  }
end
new(attributes = {}) click to toggle source

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

# File lib/bf_ruby2/models/profile.rb, line 123
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?(:'created')
    self.created = attributes[:'created']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/bf_ruby2/models/profile.rb, line 98
def self.swagger_types
  {
    :'created' => :'DateTime',
    :'changed_by' => :'String',
    :'updated' => :'DateTime',
    :'id' => :'String',
    :'account_id' => :'String',
    :'organization_id' => :'String',
    :'email' => :'String',
    :'first_name' => :'String',
    :'last_name' => :'String',
    :'company_name' => :'String',
    :'logo_url' => :'String',
    :'addresses' => :'Array<Address>',
    :'mobile' => :'String',
    :'landline' => :'String',
    :'fax' => :'String',
    :'dob' => :'DateTime',
    :'vat_number' => :'String',
    :'additional_information' => :'String'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/bf_ruby2/models/profile.rb, line 250
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      created == o.created &&
      changed_by == o.changed_by &&
      updated == o.updated &&
      id == o.id &&
      account_id == o.account_id &&
      organization_id == o.organization_id &&
      email == o.email &&
      first_name == o.first_name &&
      last_name == o.last_name &&
      company_name == o.company_name &&
      logo_url == o.logo_url &&
      addresses == o.addresses &&
      mobile == o.mobile &&
      landline == o.landline &&
      fax == o.fax &&
      dob == o.dob &&
      vat_number == o.vat_number &&
      additional_information == o.additional_information
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/bf_ruby2/models/profile.rb, line 309
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 = Bfwd.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/bf_ruby2/models/profile.rb, line 375
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/bf_ruby2/models/profile.rb, line 288
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
eql?(o) click to toggle source

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

# File lib/bf_ruby2/models/profile.rb, line 275
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/bf_ruby2/models/profile.rb, line 281
def hash
  [created, changed_by, updated, id, account_id, organization_id, email, first_name, last_name, company_name, logo_url, addresses, mobile, landline, fax, dob, vat_number, additional_information].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/bf_ruby2/models/profile.rb, line 207
def list_invalid_properties
  invalid_properties = Array.new
  if @id.nil?
    invalid_properties.push("invalid value for 'id', id cannot be nil.")
  end

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

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

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

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

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

  return 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/bf_ruby2/models/profile.rb, line 355
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/bf_ruby2/models/profile.rb, line 361
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/bf_ruby2/models/profile.rb, line 349
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/bf_ruby2/models/profile.rb, line 238
def valid?
  return false if @id.nil?
  return false if @account_id.nil?
  return false if @organization_id.nil?
  return false if @email.nil?
  return false if @first_name.nil?
  return false if @last_name.nil?
  return true
end