class Yapstone::BusinessProfileResource

Business profile information. Contains information such as doing business as, taxId fo the business, etc.

Attributes

address[RW]
business_identification[RW]
dba[RW]

Doing business as name list.

email[RW]

The email address.

name[RW]

The name of the business.

phone[RW]
registration[RW]
type[RW]

The type of business unit (sole_prop, corp, llc)

website_url[RW]

The website hostname.

Public Class Methods

attribute_map() click to toggle source

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

# File lib/yapstone-so/models/business_profile_resource.rb, line 64
def self.attribute_map
  {
    :'name' => :'name',
    :'type' => :'type',
    :'dba' => :'dba',
    :'email' => :'email',
    :'address' => :'address',
    :'phone' => :'phone',
    :'business_identification' => :'businessIdentification',
    :'registration' => :'registration',
    :'website_url' => :'websiteURL'
  }
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-so/models/business_profile_resource.rb, line 309
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-so/models/business_profile_resource.rb, line 95
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Yapstone::BusinessProfileResource` 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::BusinessProfileResource`. 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?(:'name')
    self.name = attributes[:'name']
  end

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

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

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

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

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

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

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

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

Attribute type mapping.

# File lib/yapstone-so/models/business_profile_resource.rb, line 79
def self.openapi_types
  {
    :'name' => :'String',
    :'type' => :'String',
    :'dba' => :'Array<String>',
    :'email' => :'String',
    :'address' => :'AddressResource',
    :'phone' => :'PhoneResource',
    :'business_identification' => :'BusinessIdentificationResource',
    :'registration' => :'RegistrationResource',
    :'website_url' => :'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-so/models/business_profile_resource.rb, line 280
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      type == o.type &&
      dba == o.dba &&
      email == o.email &&
      address == o.address &&
      phone == o.phone &&
      business_identification == o.business_identification &&
      registration == o.registration &&
      website_url == o.website_url
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-so/models/business_profile_resource.rb, line 337
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-so/models/business_profile_resource.rb, line 402
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-so/models/business_profile_resource.rb, line 316
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
email=(email) click to toggle source

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

# File lib/yapstone-so/models/business_profile_resource.rb, line 243
def email=(email)
  if email.nil?
    fail ArgumentError, 'email cannot be nil'
  end

  if email.to_s.length > 512
    fail ArgumentError, 'invalid value for "email", the character length must be smaller than or equal to 512.'
  end

  if email.to_s.length < 1
    fail ArgumentError, 'invalid value for "email", the character length must be great than or equal to 1.'
  end

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

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

# File lib/yapstone-so/models/business_profile_resource.rb, line 296
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-so/models/business_profile_resource.rb, line 302
def hash
  [name, type, dba, email, address, phone, business_identification, registration, website_url].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-so/models/business_profile_resource.rb, line 149
def list_invalid_properties
  invalid_properties = Array.new
  if @name.nil?
    invalid_properties.push('invalid value for "name", name cannot be nil.')
  end

  if @name.to_s.length > 512
    invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 512.')
  end

  if @name.to_s.length < 2
    invalid_properties.push('invalid value for "name", the character length must be great than or equal to 2.')
  end

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

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

  if @email.to_s.length < 1
    invalid_properties.push('invalid value for "email", the character length must be great than or equal to 1.')
  end

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

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

  if !@website_url.nil? && @website_url.to_s.length < 4
    invalid_properties.push('invalid value for "website_url", the character length must be great than or equal to 4.')
  end

  pattern = Regexp.new(/.*[^\s].*/)
  if !@website_url.nil? && @website_url !~ pattern
    invalid_properties.push("invalid value for \"website_url\", must conform to the pattern #{pattern}.")
  end

  invalid_properties
end
name=(name) click to toggle source

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

# File lib/yapstone-so/models/business_profile_resource.rb, line 215
def name=(name)
  if name.nil?
    fail ArgumentError, 'name cannot be nil'
  end

  if name.to_s.length > 512
    fail ArgumentError, 'invalid value for "name", the character length must be smaller than or equal to 512.'
  end

  if name.to_s.length < 2
    fail ArgumentError, 'invalid value for "name", the character length must be great than or equal to 2.'
  end

  @name = name
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-so/models/business_profile_resource.rb, line 382
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-so/models/business_profile_resource.rb, line 388
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-so/models/business_profile_resource.rb, line 376
def to_s
  to_hash.to_s
end
type=(type) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] type Object to be assigned

# File lib/yapstone-so/models/business_profile_resource.rb, line 233
def type=(type)
  validator = EnumAttributeValidator.new('String', ["SOLE_PROPRIETOR", "PARTNERSHIP", "LLC", "S_CORP", "CORPORATION"])
  unless validator.valid?(type)
    fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
  end
  @type = type
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-so/models/business_profile_resource.rb, line 197
def valid?
  return false if @name.nil?
  return false if @name.to_s.length > 512
  return false if @name.to_s.length < 2
  type_validator = EnumAttributeValidator.new('String', ["SOLE_PROPRIETOR", "PARTNERSHIP", "LLC", "S_CORP", "CORPORATION"])
  return false unless type_validator.valid?(@type)
  return false if @email.nil?
  return false if @email.to_s.length > 512
  return false if @email.to_s.length < 1
  return false if @address.nil?
  return false if !@website_url.nil? && @website_url.to_s.length > 24
  return false if !@website_url.nil? && @website_url.to_s.length < 4
  return false if !@website_url.nil? && @website_url !~ Regexp.new(/.*[^\s].*/)
  true
end
website_url=(website_url) click to toggle source

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

# File lib/yapstone-so/models/business_profile_resource.rb, line 261
def website_url=(website_url)
  if !website_url.nil? && website_url.to_s.length > 24
    fail ArgumentError, 'invalid value for "website_url", the character length must be smaller than or equal to 24.'
  end

  if !website_url.nil? && website_url.to_s.length < 4
    fail ArgumentError, 'invalid value for "website_url", the character length must be great than or equal to 4.'
  end

  pattern = Regexp.new(/.*[^\s].*/)
  if !website_url.nil? && website_url !~ pattern
    fail ArgumentError, "invalid value for \"website_url\", must conform to the pattern #{pattern}."
  end

  @website_url = website_url
end