class OpenapiClient::ConnectRoyalMailRequestBody

A Royal Mail account information request body

Attributes

account_number[RW]

Account number

city[RW]

City

company_name[RW]

Company name

contact_name[RW]

Contact name

email[RW]

The email address

nickname[RW]

Nickname

oba_email[RW]

The oba email address

phone[RW]

Phone

postal_code[RW]

Postal code

street_line1[RW]

Street line1

street_line2[RW]

Street line2

street_line3[RW]

Street line3

Public Class Methods

attribute_map() click to toggle source

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

# File lib/openapi_client/models/connect_royal_mail_request_body.rb, line 55
def self.attribute_map
  {
    :'account_number' => :'account_number',
    :'oba_email' => :'oba_email',
    :'contact_name' => :'contact_name',
    :'email' => :'email',
    :'company_name' => :'company_name',
    :'street_line1' => :'street_line1',
    :'street_line2' => :'street_line2',
    :'street_line3' => :'street_line3',
    :'city' => :'city',
    :'postal_code' => :'postal_code',
    :'phone' => :'phone',
    :'nickname' => :'nickname'
  }
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/openapi_client/models/connect_royal_mail_request_body.rb, line 402
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/openapi_client/models/connect_royal_mail_request_body.rb, line 98
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::ConnectRoyalMailRequestBody` 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 `OpenapiClient::ConnectRoyalMailRequestBody`. 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?(:'account_number')
    self.account_number = attributes[:'account_number']
  end

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

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

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

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

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

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

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

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

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

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

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

List of attributes with nullable: true

# File lib/openapi_client/models/connect_royal_mail_request_body.rb, line 91
def self.openapi_nullable
  Set.new([
  ])
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/openapi_client/models/connect_royal_mail_request_body.rb, line 73
def self.openapi_types
  {
    :'account_number' => :'String',
    :'oba_email' => :'String',
    :'contact_name' => :'String',
    :'email' => :'String',
    :'company_name' => :'String',
    :'street_line1' => :'String',
    :'street_line2' => :'String',
    :'street_line3' => :'String',
    :'city' => :'String',
    :'postal_code' => :'String',
    :'phone' => :'String',
    :'nickname' => :'String'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/openapi_client/models/connect_royal_mail_request_body.rb, line 370
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      account_number == o.account_number &&
      oba_email == o.oba_email &&
      contact_name == o.contact_name &&
      email == o.email &&
      company_name == o.company_name &&
      street_line1 == o.street_line1 &&
      street_line2 == o.street_line2 &&
      street_line3 == o.street_line3 &&
      city == o.city &&
      postal_code == o.postal_code &&
      phone == o.phone &&
      nickname == o.nickname
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/openapi_client/models/connect_royal_mail_request_body.rb, line 430
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
    OpenapiClient.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/openapi_client/models/connect_royal_mail_request_body.rb, line 499
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
account_number=(account_number) click to toggle source

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

# File lib/openapi_client/models/connect_royal_mail_request_body.rb, line 250
def account_number=(account_number)
  if account_number.nil?
    fail ArgumentError, 'account_number cannot be nil'
  end

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

  @account_number = account_number
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/openapi_client/models/connect_royal_mail_request_body.rb, line 409
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
city=(city) click to toggle source

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

# File lib/openapi_client/models/connect_royal_mail_request_body.rb, line 318
def city=(city)
  if city.nil?
    fail ArgumentError, 'city cannot be nil'
  end

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

  @city = city
end
company_name=(company_name) click to toggle source

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

# File lib/openapi_client/models/connect_royal_mail_request_body.rb, line 278
def company_name=(company_name)
  if !company_name.nil? && company_name.to_s.length < 1
    fail ArgumentError, 'invalid value for "company_name", the character length must be great than or equal to 1.'
  end

  @company_name = company_name
end
contact_name=(contact_name) click to toggle source

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

# File lib/openapi_client/models/connect_royal_mail_request_body.rb, line 264
def contact_name=(contact_name)
  if contact_name.nil?
    fail ArgumentError, 'contact_name cannot be nil'
  end

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

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

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

# File lib/openapi_client/models/connect_royal_mail_request_body.rb, line 389
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/openapi_client/models/connect_royal_mail_request_body.rb, line 395
def hash
  [account_number, oba_email, contact_name, email, company_name, street_line1, street_line2, street_line3, city, postal_code, phone, nickname].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/openapi_client/models/connect_royal_mail_request_body.rb, line 162
def list_invalid_properties
  invalid_properties = Array.new
  if @account_number.nil?
    invalid_properties.push('invalid value for "account_number", account_number cannot be nil.')
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  invalid_properties
end
nickname=(nickname) click to toggle source

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

# File lib/openapi_client/models/connect_royal_mail_request_body.rb, line 356
def nickname=(nickname)
  if nickname.nil?
    fail ArgumentError, 'nickname cannot be nil'
  end

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

  @nickname = nickname
end
phone=(phone) click to toggle source

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

# File lib/openapi_client/models/connect_royal_mail_request_body.rb, line 346
def phone=(phone)
  if !phone.nil? && phone.to_s.length < 1
    fail ArgumentError, 'invalid value for "phone", the character length must be great than or equal to 1.'
  end

  @phone = phone
end
postal_code=(postal_code) click to toggle source

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

# File lib/openapi_client/models/connect_royal_mail_request_body.rb, line 332
def postal_code=(postal_code)
  if postal_code.nil?
    fail ArgumentError, 'postal_code cannot be nil'
  end

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

  @postal_code = postal_code
end
street_line1=(street_line1) click to toggle source

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

# File lib/openapi_client/models/connect_royal_mail_request_body.rb, line 288
def street_line1=(street_line1)
  if !street_line1.nil? && street_line1.to_s.length < 1
    fail ArgumentError, 'invalid value for "street_line1", the character length must be great than or equal to 1.'
  end

  @street_line1 = street_line1
end
street_line2=(street_line2) click to toggle source

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

# File lib/openapi_client/models/connect_royal_mail_request_body.rb, line 298
def street_line2=(street_line2)
  if !street_line2.nil? && street_line2.to_s.length < 1
    fail ArgumentError, 'invalid value for "street_line2", the character length must be great than or equal to 1.'
  end

  @street_line2 = street_line2
end
street_line3=(street_line3) click to toggle source

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

# File lib/openapi_client/models/connect_royal_mail_request_body.rb, line 308
def street_line3=(street_line3)
  if !street_line3.nil? && street_line3.to_s.length < 1
    fail ArgumentError, 'invalid value for "street_line3", the character length must be great than or equal to 1.'
  end

  @street_line3 = street_line3
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/openapi_client/models/connect_royal_mail_request_body.rb, line 475
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/openapi_client/models/connect_royal_mail_request_body.rb, line 481
def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end
    
    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/openapi_client/models/connect_royal_mail_request_body.rb, line 469
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/openapi_client/models/connect_royal_mail_request_body.rb, line 229
def valid?
  return false if @account_number.nil?
  return false if @account_number.to_s.length < 1
  return false if @contact_name.nil?
  return false if @contact_name.to_s.length < 1
  return false if !@company_name.nil? && @company_name.to_s.length < 1
  return false if !@street_line1.nil? && @street_line1.to_s.length < 1
  return false if !@street_line2.nil? && @street_line2.to_s.length < 1
  return false if !@street_line3.nil? && @street_line3.to_s.length < 1
  return false if @city.nil?
  return false if @city.to_s.length < 1
  return false if @postal_code.nil?
  return false if @postal_code.to_s.length < 1
  return false if !@phone.nil? && @phone.to_s.length < 1
  return false if @nickname.nil?
  return false if @nickname.to_s.length < 1
  true
end