class PostFinanceCheckout::ShopifySubscriptionAddress

Attributes

city[RW]
commercial_register_number[RW]
country[RW]
date_of_birth[RW]
dependent_locality[RW]
email_address[RW]
family_name[RW]
gender[RW]
given_name[RW]
mobile_phone_number[RW]
organization_name[RW]
phone_number[RW]
postal_state[RW]
postcode[RW]
sales_tax_number[RW]
salutation[RW]
social_security_number[RW]
sorting_code[RW]

The sorting code identifies the post office at which the post box is located in.

street[RW]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/postfinancecheckout-ruby-sdk/models/shopify_subscription_address.rb, line 84
def self.attribute_map
  {
    :'city' => :'city',
    :'commercial_register_number' => :'commercialRegisterNumber',
    :'country' => :'country',
    :'date_of_birth' => :'dateOfBirth',
    :'dependent_locality' => :'dependentLocality',
    :'email_address' => :'emailAddress',
    :'family_name' => :'familyName',
    :'gender' => :'gender',
    :'given_name' => :'givenName',
    :'legal_organization_form' => :'legalOrganizationForm',
    :'mobile_phone_number' => :'mobilePhoneNumber',
    :'organization_name' => :'organizationName',
    :'phone_number' => :'phoneNumber',
    :'postal_state' => :'postalState',
    :'postcode' => :'postcode',
    :'sales_tax_number' => :'salesTaxNumber',
    :'salutation' => :'salutation',
    :'social_security_number' => :'socialSecurityNumber',
    :'sorting_code' => :'sortingCode',
    :'street' => :'street'
  }
end
new(attributes = {}) click to toggle source

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

# File lib/postfinancecheckout-ruby-sdk/models/shopify_subscription_address.rb, line 137
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?(:'city')
    self.city = attributes[:'city']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  if attributes.has_key?(:'street')
    self.street = attributes[:'street']
  end
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/postfinancecheckout-ruby-sdk/models/shopify_subscription_address.rb, line 110
def self.swagger_types
  {
    :'city' => :'String',
    :'commercial_register_number' => :'String',
    :'country' => :'String',
    :'date_of_birth' => :'Date',
    :'dependent_locality' => :'String',
    :'email_address' => :'String',
    :'family_name' => :'String',
    :'gender' => :'Gender',
    :'given_name' => :'String',
    :'legal_organization_form' => :'LegalOrganizationForm',
    :'mobile_phone_number' => :'String',
    :'organization_name' => :'String',
    :'phone_number' => :'String',
    :'postal_state' => :'String',
    :'postcode' => :'String',
    :'sales_tax_number' => :'String',
    :'salutation' => :'String',
    :'social_security_number' => :'String',
    :'sorting_code' => :'String',
    :'street' => :'String'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/postfinancecheckout-ruby-sdk/models/shopify_subscription_address.rb, line 404
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      city == o.city &&
      commercial_register_number == o.commercial_register_number &&
      country == o.country &&
      date_of_birth == o.date_of_birth &&
      dependent_locality == o.dependent_locality &&
      email_address == o.email_address &&
      family_name == o.family_name &&
      gender == o.gender &&
      given_name == o.given_name &&
      legal_organization_form == o.legal_organization_form &&
      mobile_phone_number == o.mobile_phone_number &&
      organization_name == o.organization_name &&
      phone_number == o.phone_number &&
      postal_state == o.postal_state &&
      postcode == o.postcode &&
      sales_tax_number == o.sales_tax_number &&
      salutation == o.salutation &&
      social_security_number == o.social_security_number &&
      sorting_code == o.sorting_code &&
      street == o.street
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/postfinancecheckout-ruby-sdk/models/shopify_subscription_address.rb, line 465
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 = PostFinanceCheckout.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/postfinancecheckout-ruby-sdk/models/shopify_subscription_address.rb, line 531
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/postfinancecheckout-ruby-sdk/models/shopify_subscription_address.rb, line 444
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 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
commercial_register_number=(commercial_register_number) click to toggle source

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

# File lib/postfinancecheckout-ruby-sdk/models/shopify_subscription_address.rb, line 294
def commercial_register_number=(commercial_register_number)
  if !commercial_register_number.nil? && commercial_register_number.to_s.length > 100
    fail ArgumentError, 'invalid value for "commercial_register_number", the character length must be smaller than or equal to 100.'
  end

  @commercial_register_number = commercial_register_number
end
dependent_locality=(dependent_locality) click to toggle source

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

# File lib/postfinancecheckout-ruby-sdk/models/shopify_subscription_address.rb, line 304
def dependent_locality=(dependent_locality)
  if !dependent_locality.nil? && dependent_locality.to_s.length > 100
    fail ArgumentError, 'invalid value for "dependent_locality", the character length must be smaller than or equal to 100.'
  end

  @dependent_locality = dependent_locality
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/postfinancecheckout-ruby-sdk/models/shopify_subscription_address.rb, line 314
def email_address=(email_address)
  if !email_address.nil? && email_address.to_s.length > 254
    fail ArgumentError, 'invalid value for "email_address", the character length must be smaller than or equal to 254.'
  end

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

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

# File lib/postfinancecheckout-ruby-sdk/models/shopify_subscription_address.rb, line 431
def eql?(o)
  self == o
end
given_name=(given_name) click to toggle source

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

# File lib/postfinancecheckout-ruby-sdk/models/shopify_subscription_address.rb, line 324
def given_name=(given_name)
  if !given_name.nil? && given_name.to_s.length > 100
    fail ArgumentError, 'invalid value for "given_name", the character length must be smaller than or equal to 100.'
  end

  @given_name = given_name
end
hash() click to toggle source

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

# File lib/postfinancecheckout-ruby-sdk/models/shopify_subscription_address.rb, line 437
def hash
  [city, commercial_register_number, country, date_of_birth, dependent_locality, email_address, family_name, gender, given_name, legal_organization_form, mobile_phone_number, organization_name, phone_number, postal_state, postcode, sales_tax_number, salutation, social_security_number, sorting_code, street].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/postfinancecheckout-ruby-sdk/models/shopify_subscription_address.rb, line 226
def list_invalid_properties
  invalid_properties = Array.new
  if !@commercial_register_number.nil? && @commercial_register_number.to_s.length > 100
    invalid_properties.push('invalid value for "commercial_register_number", the character length must be smaller than or equal to 100.')
  end

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

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

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

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

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

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

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

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

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

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

  invalid_properties
end
mobile_phone_number=(mobile_phone_number) click to toggle source

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

# File lib/postfinancecheckout-ruby-sdk/models/shopify_subscription_address.rb, line 334
def mobile_phone_number=(mobile_phone_number)
  if !mobile_phone_number.nil? && mobile_phone_number.to_s.length > 100
    fail ArgumentError, 'invalid value for "mobile_phone_number", the character length must be smaller than or equal to 100.'
  end

  @mobile_phone_number = mobile_phone_number
end
organization_name=(organization_name) click to toggle source

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

# File lib/postfinancecheckout-ruby-sdk/models/shopify_subscription_address.rb, line 344
def organization_name=(organization_name)
  if !organization_name.nil? && organization_name.to_s.length > 100
    fail ArgumentError, 'invalid value for "organization_name", the character length must be smaller than or equal to 100.'
  end

  @organization_name = organization_name
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/postfinancecheckout-ruby-sdk/models/shopify_subscription_address.rb, line 354
def phone_number=(phone_number)
  if !phone_number.nil? && phone_number.to_s.length > 100
    fail ArgumentError, 'invalid value for "phone_number", the character length must be smaller than or equal to 100.'
  end

  @phone_number = phone_number
end
sales_tax_number=(sales_tax_number) click to toggle source

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

# File lib/postfinancecheckout-ruby-sdk/models/shopify_subscription_address.rb, line 364
def sales_tax_number=(sales_tax_number)
  if !sales_tax_number.nil? && sales_tax_number.to_s.length > 100
    fail ArgumentError, 'invalid value for "sales_tax_number", the character length must be smaller than or equal to 100.'
  end

  @sales_tax_number = sales_tax_number
end
salutation=(salutation) click to toggle source

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

# File lib/postfinancecheckout-ruby-sdk/models/shopify_subscription_address.rb, line 374
def salutation=(salutation)
  if !salutation.nil? && salutation.to_s.length > 20
    fail ArgumentError, 'invalid value for "salutation", the character length must be smaller than or equal to 20.'
  end

  @salutation = salutation
end
social_security_number=(social_security_number) click to toggle source

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

# File lib/postfinancecheckout-ruby-sdk/models/shopify_subscription_address.rb, line 384
def social_security_number=(social_security_number)
  if !social_security_number.nil? && social_security_number.to_s.length > 100
    fail ArgumentError, 'invalid value for "social_security_number", the character length must be smaller than or equal to 100.'
  end

  @social_security_number = social_security_number
end
sorting_code=(sorting_code) click to toggle source

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

# File lib/postfinancecheckout-ruby-sdk/models/shopify_subscription_address.rb, line 394
def sorting_code=(sorting_code)
  if !sorting_code.nil? && sorting_code.to_s.length > 100
    fail ArgumentError, 'invalid value for "sorting_code", the character length must be smaller than or equal to 100.'
  end

  @sorting_code = sorting_code
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/postfinancecheckout-ruby-sdk/models/shopify_subscription_address.rb, line 511
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/postfinancecheckout-ruby-sdk/models/shopify_subscription_address.rb, line 517
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/postfinancecheckout-ruby-sdk/models/shopify_subscription_address.rb, line 505
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/postfinancecheckout-ruby-sdk/models/shopify_subscription_address.rb, line 277
def valid?
  return false if !@commercial_register_number.nil? && @commercial_register_number.to_s.length > 100
  return false if !@dependent_locality.nil? && @dependent_locality.to_s.length > 100
  return false if !@email_address.nil? && @email_address.to_s.length > 254
  return false if !@given_name.nil? && @given_name.to_s.length > 100
  return false if !@mobile_phone_number.nil? && @mobile_phone_number.to_s.length > 100
  return false if !@organization_name.nil? && @organization_name.to_s.length > 100
  return false if !@phone_number.nil? && @phone_number.to_s.length > 100
  return false if !@sales_tax_number.nil? && @sales_tax_number.to_s.length > 100
  return false if !@salutation.nil? && @salutation.to_s.length > 20
  return false if !@social_security_number.nil? && @social_security_number.to_s.length > 100
  return false if !@sorting_code.nil? && @sorting_code.to_s.length > 100
  true
end