class OpenapiClient::SepaMandate

Model for the SEPA Mandate information.

Attributes

reference[RW]

Existing mandate reference, managed by merchant. Must match [A-Za-z0-9:?/+(),. -]{1,35} and not start with two slashes ("//"). Also known as the mandate ID.

signature_date[RW]

Date of mandate signature.

type[RW]

Sequence type of the direct debit. This defaults to 'SINGLE' if not provided.

url[RW]

Valid URL pointing to the SEPA mandate (PDF / HTML format recommended). When your store is enabled for SEPA Direct Debit as part of the Local Payments offering, this field allows you to transmit a valid URL of SEPA Direct Debit mandate to enable the Risk and Compliance department to access the details. Please note that it is mandatory to submit a mandateReference and a mandateDate together with a mandateUrl in case you manage SEPA Direct Debit mandates on your side in the combination with the Local Payments offering.

Public Class Methods

attribute_map() click to toggle source

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

# File lib/openapi_client/models/sepa_mandate.rb, line 53
def self.attribute_map
  {
    :'reference' => :'reference',
    :'url' => :'url',
    :'signature_date' => :'signatureDate',
    :'type' => :'type'
  }
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/sepa_mandate.rb, line 228
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/sepa_mandate.rb, line 74
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::SepaMandate` 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::SepaMandate`. 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?(:'reference')
    self.reference = attributes[:'reference']
  end

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

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

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

Attribute type mapping.

# File lib/openapi_client/models/sepa_mandate.rb, line 63
def self.openapi_types
  {
    :'reference' => :'String',
    :'url' => :'String',
    :'signature_date' => :'Date',
    :'type' => :'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/sepa_mandate.rb, line 204
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      reference == o.reference &&
      url == o.url &&
      signature_date == o.signature_date &&
      type == o.type
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/sepa_mandate.rb, line 256
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
    klass = OpenapiClient.const_get(type)
    if klass.respond_to?(:openapi_discriminator_name)
      klass = OpenapiClient.const_get(value[klass.attribute_map[klass.openapi_discriminator_name]])
    end
 
    klass.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/sepa_mandate.rb, line 330
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, attribute_map = self.class.attribute_map, openapi_types = self.class.openapi_types) 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/sepa_mandate.rb, line 235
def build_from_hash(attributes, attribute_map = self.class.attribute_map, openapi_types = self.class.openapi_types)
  return nil unless attributes.is_a?(Hash)
  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[attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[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/openapi_client/models/sepa_mandate.rb, line 215
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/sepa_mandate.rb, line 221
def hash
  [reference, url, signature_date, type].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/sepa_mandate.rb, line 108
def list_invalid_properties
  invalid_properties = Array.new
  if @reference.nil?
    invalid_properties.push('invalid value for "reference", reference cannot be nil.')
  end

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

  pattern = Regexp.new(/[A-Za-z0-9:?\/+(),. -]{1,35}/)
  if @reference !~ pattern
    invalid_properties.push("invalid value for \"reference\", must conform to the pattern #{pattern}.")
  end

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

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

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

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

  invalid_properties
end
reference=(reference) click to toggle source

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

# File lib/openapi_client/models/sepa_mandate.rb, line 160
def reference=(reference)
  if reference.nil?
    fail ArgumentError, 'reference cannot be nil'
  end

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

  pattern = Regexp.new(/[A-Za-z0-9:?\/+(),. -]{1,35}/)
  if reference !~ pattern
    fail ArgumentError, "invalid value for \"reference\", must conform to the pattern #{pattern}."
  end

  @reference = reference
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/sepa_mandate.rb, line 306
def to_body
  to_hash
end
to_hash(attribute_map = self.class.attribute_map, openapi_nullable = Set.new([])) 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/sepa_mandate.rb, line 312
def to_hash(attribute_map = self.class.attribute_map, openapi_nullable = Set.new([]))
  hash = {}
  attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = 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/sepa_mandate.rb, line 300
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/openapi_client/models/sepa_mandate.rb, line 194
def type=(type)
  validator = EnumAttributeValidator.new('String', ["SINGLE", "FIRST_COLLECTION", "RECURRING_COLLECTION", "FINAL_COLLECTION"])
  unless validator.valid?(type)
    fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
  end
  @type = type
end
url=(url) click to toggle source

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

# File lib/openapi_client/models/sepa_mandate.rb, line 179
def url=(url)
  if !url.nil? && url.to_s.length > 100
    fail ArgumentError, 'invalid value for "url", the character length must be smaller than or equal to 100.'
  end

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

  @url = url
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/sepa_mandate.rb, line 145
def valid?
  return false if @reference.nil?
  return false if @reference.to_s.length > 35
  return false if @reference !~ Regexp.new(/[A-Za-z0-9:?\/+(),. -]{1,35}/)
  return false if !@url.nil? && @url.to_s.length > 100
  return false if !@url.nil? && @url !~ Regexp.new(/^(?!\s*$).+/)
  return false if @signature_date.nil?
  return false if @type.nil?
  type_validator = EnumAttributeValidator.new('String', ["SINGLE", "FIRST_COLLECTION", "RECURRING_COLLECTION", "FINAL_COLLECTION"])
  return false unless type_validator.valid?(@type)
  true
end