Class: Buildium::BankAccountPostMessageCheckPrintingInfo

Inherits:
Object
  • Object
show all
Defined in:
lib/buildium-ruby/models/bank_account_post_message_check_printing_info.rb

Overview

Check printing info.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ BankAccountPostMessageCheckPrintingInfo

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {})

    Model attributes in the form of hash



148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
# File 'lib/buildium-ruby/models/bank_account_post_message_check_printing_info.rb', line 148

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Buildium::BankAccountPostMessageCheckPrintingInfo` 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 `Buildium::BankAccountPostMessageCheckPrintingInfo`. 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?(:'enable_remote_check_printing')
    self.enable_remote_check_printing = attributes[:'enable_remote_check_printing']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#bank_information_line1Object

Bank information line 1.



35
36
37
# File 'lib/buildium-ruby/models/bank_account_post_message_check_printing_info.rb', line 35

def bank_information_line1
  @bank_information_line1
end

#bank_information_line2Object

Bank information line 2.



38
39
40
# File 'lib/buildium-ruby/models/bank_account_post_message_check_printing_info.rb', line 38

def bank_information_line2
  @bank_information_line2
end

#bank_information_line3Object

Bank information line 3.



41
42
43
# File 'lib/buildium-ruby/models/bank_account_post_message_check_printing_info.rb', line 41

def bank_information_line3
  @bank_information_line3
end

#bank_information_line4Object

Bank information line 4.



44
45
46
# File 'lib/buildium-ruby/models/bank_account_post_message_check_printing_info.rb', line 44

def bank_information_line4
  @bank_information_line4
end

#bank_information_line5Object

Bank information line 5.



47
48
49
# File 'lib/buildium-ruby/models/bank_account_post_message_check_printing_info.rb', line 47

def bank_information_line5
  @bank_information_line5
end

#check_layout_typeObject

The check layout type. Defaults to ‘Voucher2StubsPrePrintedLayout` if not specified.



26
27
28
# File 'lib/buildium-ruby/models/bank_account_post_message_check_printing_info.rb', line 26

def check_layout_type
  @check_layout_type
end

#company_information_line1Object

Company information 1. Defaults to the company name from the account if not specified.



50
51
52
# File 'lib/buildium-ruby/models/bank_account_post_message_check_printing_info.rb', line 50

def company_information_line1
  @company_information_line1
end

#company_information_line2Object

Company information 2. Defaults to the company address if not specified.



53
54
55
# File 'lib/buildium-ruby/models/bank_account_post_message_check_printing_info.rb', line 53

def company_information_line2
  @company_information_line2
end

#company_information_line3Object

Company information 3. Defaults to the company address if not specified.



56
57
58
# File 'lib/buildium-ruby/models/bank_account_post_message_check_printing_info.rb', line 56

def company_information_line3
  @company_information_line3
end

#company_information_line4Object

Company information 4. Defaults to the company address if not specified.



59
60
61
# File 'lib/buildium-ruby/models/bank_account_post_message_check_printing_info.rb', line 59

def company_information_line4
  @company_information_line4
end

#company_information_line5Object

Company information 5. Defaults to the company address if not specified.



62
63
64
# File 'lib/buildium-ruby/models/bank_account_post_message_check_printing_info.rb', line 62

def company_information_line5
  @company_information_line5
end

#enable_local_check_printingObject

Indicates whether local check printing is enabled.



23
24
25
# File 'lib/buildium-ruby/models/bank_account_post_message_check_printing_info.rb', line 23

def enable_local_check_printing
  @enable_local_check_printing
end

#enable_remote_check_printingObject

Indicates whether remote check printing is enabled.



20
21
22
# File 'lib/buildium-ruby/models/bank_account_post_message_check_printing_info.rb', line 20

def enable_remote_check_printing
  @enable_remote_check_printing
end

#fractional_numberObject

The fractional form of the routing number. Typically is used to identify the bank of the check in cases where the MICR is unreadable.



32
33
34
# File 'lib/buildium-ruby/models/bank_account_post_message_check_printing_info.rb', line 32

def fractional_number
  @fractional_number
end

#signature_headingObject

The signature heading. Defaults to "VOID AFTER 90 DAYS" if not specified.



29
30
31
# File 'lib/buildium-ruby/models/bank_account_post_message_check_printing_info.rb', line 29

def signature_heading
  @signature_heading
end

Class Method Details

.acceptable_attributesObject

Returns all the JSON keys this model knows about



108
109
110
# File 'lib/buildium-ruby/models/bank_account_post_message_check_printing_info.rb', line 108

def self.acceptable_attributes
  attribute_map.values
end

.attribute_mapObject

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



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
# File 'lib/buildium-ruby/models/bank_account_post_message_check_printing_info.rb', line 87

def self.attribute_map
  {
    :'enable_remote_check_printing' => :'EnableRemoteCheckPrinting',
    :'enable_local_check_printing' => :'EnableLocalCheckPrinting',
    :'check_layout_type' => :'CheckLayoutType',
    :'signature_heading' => :'SignatureHeading',
    :'fractional_number' => :'FractionalNumber',
    :'bank_information_line1' => :'BankInformationLine1',
    :'bank_information_line2' => :'BankInformationLine2',
    :'bank_information_line3' => :'BankInformationLine3',
    :'bank_information_line4' => :'BankInformationLine4',
    :'bank_information_line5' => :'BankInformationLine5',
    :'company_information_line1' => :'CompanyInformationLine1',
    :'company_information_line2' => :'CompanyInformationLine2',
    :'company_information_line3' => :'CompanyInformationLine3',
    :'company_information_line4' => :'CompanyInformationLine4',
    :'company_information_line5' => :'CompanyInformationLine5'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash)

    Model attributes in the form of hash

Returns:

  • (Object)

    Returns the model itself



284
285
286
# File 'lib/buildium-ruby/models/bank_account_post_message_check_printing_info.rb', line 284

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_all_ofObject

List of class defined in allOf (OpenAPI v3)



140
141
142
143
144
# File 'lib/buildium-ruby/models/bank_account_post_message_check_printing_info.rb', line 140

def self.openapi_all_of
  [
  :'CheckPrintingInfoPostMessage'
  ]
end

.openapi_nullableObject

List of attributes with nullable: true



134
135
136
137
# File 'lib/buildium-ruby/models/bank_account_post_message_check_printing_info.rb', line 134

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_typesObject

Attribute type mapping.



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
# File 'lib/buildium-ruby/models/bank_account_post_message_check_printing_info.rb', line 113

def self.openapi_types
  {
    :'enable_remote_check_printing' => :'Boolean',
    :'enable_local_check_printing' => :'Boolean',
    :'check_layout_type' => :'String',
    :'signature_heading' => :'String',
    :'fractional_number' => :'String',
    :'bank_information_line1' => :'String',
    :'bank_information_line2' => :'String',
    :'bank_information_line3' => :'String',
    :'bank_information_line4' => :'String',
    :'bank_information_line5' => :'String',
    :'company_information_line1' => :'String',
    :'company_information_line2' => :'String',
    :'company_information_line3' => :'String',
    :'company_information_line4' => :'String',
    :'company_information_line5' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
# File 'lib/buildium-ruby/models/bank_account_post_message_check_printing_info.rb', line 249

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      enable_remote_check_printing == o.enable_remote_check_printing &&
      enable_local_check_printing == o.enable_local_check_printing &&
      check_layout_type == o.check_layout_type &&
      signature_heading == o.signature_heading &&
      fractional_number == o.fractional_number &&
      bank_information_line1 == o.bank_information_line1 &&
      bank_information_line2 == o.bank_information_line2 &&
      bank_information_line3 == o.bank_information_line3 &&
      bank_information_line4 == o.bank_information_line4 &&
      bank_information_line5 == o.bank_information_line5 &&
      company_information_line1 == o.company_information_line1 &&
      company_information_line2 == o.company_information_line2 &&
      company_information_line3 == o.company_information_line3 &&
      company_information_line4 == o.company_information_line4 &&
      company_information_line5 == o.company_information_line5
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string

    type Data type

  • string

    value Value to be deserialized

Returns:

  • (Object)

    Deserialized data



315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
# File 'lib/buildium-ruby/models/bank_account_post_message_check_printing_info.rb', line 315

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = Buildium.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : 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

Parameters:

  • value (Object)

    Any valid value

Returns:

  • (Hash)

    Returns the value in the form of hash



386
387
388
389
390
391
392
393
394
395
396
397
398
# File 'lib/buildium-ruby/models/bank_account_post_message_check_printing_info.rb', line 386

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) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash)

    Model attributes in the form of hash

Returns:

  • (Object)

    Returns the model itself



291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
# File 'lib/buildium-ruby/models/bank_account_post_message_check_printing_info.rb', line 291

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif 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
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


271
272
273
# File 'lib/buildium-ruby/models/bank_account_post_message_check_printing_info.rb', line 271

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



277
278
279
# File 'lib/buildium-ruby/models/bank_account_post_message_check_printing_info.rb', line 277

def hash
  [enable_remote_check_printing, enable_local_check_printing, check_layout_type, signature_heading, fractional_number, bank_information_line1, bank_information_line2, bank_information_line3, bank_information_line4, bank_information_line5, company_information_line1, company_information_line2, company_information_line3, company_information_line4, company_information_line5].hash
end

#list_invalid_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



224
225
226
227
# File 'lib/buildium-ruby/models/bank_account_post_message_check_printing_info.rb', line 224

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



362
363
364
# File 'lib/buildium-ruby/models/bank_account_post_message_check_printing_info.rb', line 362

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



368
369
370
371
372
373
374
375
376
377
378
379
380
# File 'lib/buildium-ruby/models/bank_account_post_message_check_printing_info.rb', line 368

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



356
357
358
# File 'lib/buildium-ruby/models/bank_account_post_message_check_printing_info.rb', line 356

def to_s
  to_hash.to_s
end

#valid?Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean)

    true if the model is valid



231
232
233
234
235
# File 'lib/buildium-ruby/models/bank_account_post_message_check_printing_info.rb', line 231

def valid?
  check_layout_type_validator = EnumAttributeValidator.new('String', ["Voucher1StubBottomMemo1Signature", "Voucher2StubBottomMemo1Signature", "Voucher2StubBottomMemo2Signatures", "Voucher2StubTopMemo", "Voucher2StubsPrePrintedLayout"])
  return false unless check_layout_type_validator.valid?(@check_layout_type)
  true
end