Class: OpenapiClient::SepaMandate
- Inherits:
-
Object
- Object
- OpenapiClient::SepaMandate
- Defined in:
- lib/openapi_client/models/sepa_mandate.rb
Overview
Model for the SEPA Mandate information.
Defined Under Namespace
Classes: EnumAttributeValidator
Instance Attribute Summary collapse
-
#reference ⇒ Object
Existing mandate reference, managed by merchant.
-
#signature_date ⇒ Object
Date of mandate signature.
-
#type ⇒ Object
Sequence type of the direct debit.
-
#url ⇒ Object
Valid URL pointing to the SEPA mandate (PDF / HTML format recommended).
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.build_from_hash(attributes) ⇒ Object
Builds the object from hash.
-
.openapi_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes, attribute_map = self.class.attribute_map, openapi_types = self.class.openapi_types) ⇒ Object
Builds the object from hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Integer
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ SepaMandate
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash(attribute_map = self.class.attribute_map, openapi_nullable = Set.new([])) ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ SepaMandate
Initializes the object
74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 |
# 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 |
Instance Attribute Details
#reference ⇒ Object
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.
19 20 21 |
# File 'lib/openapi_client/models/sepa_mandate.rb', line 19 def reference @reference end |
#signature_date ⇒ Object
Date of mandate signature.
25 26 27 |
# File 'lib/openapi_client/models/sepa_mandate.rb', line 25 def signature_date @signature_date end |
#type ⇒ Object
Sequence type of the direct debit. This defaults to ‘SINGLE’ if not provided.
28 29 30 |
# File 'lib/openapi_client/models/sepa_mandate.rb', line 28 def type @type end |
#url ⇒ Object
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.
22 23 24 |
# File 'lib/openapi_client/models/sepa_mandate.rb', line 22 def url @url end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
53 54 55 56 57 58 59 60 |
# 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) ⇒ Object
Builds the object from hash
228 229 230 |
# File 'lib/openapi_client/models/sepa_mandate.rb', line 228 def self.build_from_hash(attributes) new.build_from_hash(attributes) end |
.openapi_types ⇒ Object
Attribute type mapping.
63 64 65 66 67 68 69 70 |
# File 'lib/openapi_client/models/sepa_mandate.rb', line 63 def self.openapi_types { :'reference' => :'String', :'url' => :'String', :'signature_date' => :'Date', :'type' => :'String' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
204 205 206 207 208 209 210 211 |
# 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) ⇒ Object
Deserializes the data based on type
256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 |
# 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) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value
330 331 332 333 334 335 336 337 338 339 340 341 342 |
# 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) ⇒ Object
Builds the object from hash
235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 |
# 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) ⇒ Boolean
215 216 217 |
# File 'lib/openapi_client/models/sepa_mandate.rb', line 215 def eql?(o) self == o end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
221 222 223 |
# File 'lib/openapi_client/models/sepa_mandate.rb', line 221 def hash [reference, url, signature_date, type].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 |
# 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 |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
306 307 308 |
# 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([])) ⇒ Hash
Returns the object in the form of hash
312 313 314 315 316 317 318 319 320 321 322 323 324 |
# 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 ⇒ String
Returns the string representation of the object
300 301 302 |
# File 'lib/openapi_client/models/sepa_mandate.rb', line 300 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
145 146 147 148 149 150 151 152 153 154 155 156 |
# 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 |