Class: Billabear::Customer

Inherits:
Object
  • Object
show all
Defined in:
lib/billabear/models/customer.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Customer

Initializes the object

Parameters:

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

    Model attributes in the form of hash



132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
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
 
# File 'lib/billabear/models/customer.rb', line 132

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#address ⇒ Object

Returns the value of attribute address.



39
40
41
 
# File 'lib/billabear/models/customer.rb', line 39

def address
  @address
end

#billing_type ⇒ Object

Choice between card and invoice



30
31
32
 
# File 'lib/billabear/models/customer.rb', line 30

def billing_type
  @billing_type
end

#brand ⇒ Object

Defaults to ‘default’ if not sent.



45
46
47
 
# File 'lib/billabear/models/customer.rb', line 45

def brand
  @brand
end

#digital_tax_rate ⇒ Object

The tax rate for the customer on digital services <strong>Since 1.1</strong>



27
28
29
 
# File 'lib/billabear/models/customer.rb', line 27

def digital_tax_rate
  @digital_tax_rate
end

#email ⇒ Object

Returns the value of attribute email.



18
19
20
 
# File 'lib/billabear/models/customer.rb', line 18

def email
  @email
end

#external_reference ⇒ Object

Returns the value of attribute external_reference.



37
38
39
 
# File 'lib/billabear/models/customer.rb', line 37

def external_reference
  @external_reference
end

#id ⇒ Object

Returns the value of attribute id.



16
17
18
 
# File 'lib/billabear/models/customer.rb', line 16

def id
  @id
end

#invoice_format ⇒ Object

Choice between ‘pdf’ and ‘xrechnung’. <strong>Since 2024.02.01</strong>



48
49
50
 
# File 'lib/billabear/models/customer.rb', line 48

def invoice_format
  @invoice_format
end

#locale ⇒ Object

Defaults to ‘en’ if not sent.



42
43
44
 
# File 'lib/billabear/models/customer.rb', line 42

def locale
  @locale
end

#marketing_opt_in ⇒ Object

If the customer has opted in for marketing



51
52
53
 
# File 'lib/billabear/models/customer.rb', line 51

def marketing_opt_in
  @marketing_opt_in
end

#reference ⇒ Object

Returns the value of attribute reference.



35
36
37
 
# File 'lib/billabear/models/customer.rb', line 35

def reference
  @reference
end

#standard_tax_rate ⇒ Object

The tax rate for the customer on for standard services a <strong>Since 1.1</strong>



24
25
26
 
# File 'lib/billabear/models/customer.rb', line 24

def standard_tax_rate
  @standard_tax_rate
end

#tax_number ⇒ Object

The tax number for the customer <strong>Since 1.1</strong>



21
22
23
 
# File 'lib/billabear/models/customer.rb', line 21

def tax_number
  @tax_number
end

#type ⇒ Object

Choice between ‘individual’ and ‘business’. When not provided ‘individual’ is used. <strong>Since 1.1</strong>



33
34
35
 
# File 'lib/billabear/models/customer.rb', line 33

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/billabear/models/customer.rb', line 76

def self.attribute_map
  {
    :'id' => :'id',
    :'email' => :'email',
    :'tax_number' => :'tax_number',
    :'standard_tax_rate' => :'standard_tax_rate',
    :'digital_tax_rate' => :'digital_tax_rate',
    :'billing_type' => :'billing_type',
    :'type' => :'type',
    :'reference' => :'reference',
    :'external_reference' => :'external_reference',
    :'address' => :'address',
    :'locale' => :'locale',
    :'brand' => :'brand',
    :'invoice_format' => :'invoice_format',
    :'marketing_opt_in' => :'marketing_opt_in'
  }
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



292
293
294
 
# File 'lib/billabear/models/customer.rb', line 292

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/billabear/models/customer.rb', line 116

def self.openapi_nullable
  Set.new([
    :'tax_number',
    :'standard_tax_rate',
    :'digital_tax_rate',
    :'billing_type',
    :'type',
    :'locale',
    :'brand',
    :'invoice_format',
    :'marketing_opt_in'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/billabear/models/customer.rb', line 96

def self.openapi_types
  {
    :'id' => :'Object',
    :'email' => :'Object',
    :'tax_number' => :'Object',
    :'standard_tax_rate' => :'Object',
    :'digital_tax_rate' => :'Object',
    :'billing_type' => :'Object',
    :'type' => :'Object',
    :'reference' => :'Object',
    :'external_reference' => :'Object',
    :'address' => :'Object',
    :'locale' => :'Object',
    :'brand' => :'Object',
    :'invoice_format' => :'Object',
    :'marketing_opt_in' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/billabear/models/customer.rb', line 258

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      email == o.email &&
      tax_number == o.tax_number &&
      standard_tax_rate == o.standard_tax_rate &&
      digital_tax_rate == o.digital_tax_rate &&
      billing_type == o.billing_type &&
      type == o.type &&
      reference == o.reference &&
      external_reference == o.external_reference &&
      address == o.address &&
      locale == o.locale &&
      brand == o.brand &&
      invoice_format == o.invoice_format &&
      marketing_opt_in == o.marketing_opt_in
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



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
353
354
355
356
357
 
# File 'lib/billabear/models/customer.rb', line 322

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
    Billabear.const_get(type).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



391
392
393
394
395
396
397
398
399
400
401
402
403
 
# File 'lib/billabear/models/customer.rb', line 391

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



299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/billabear/models/customer.rb', line 299

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]]))
    elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


279
280
281
 
# File 'lib/billabear/models/customer.rb', line 279

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



285
286
287
 
# File 'lib/billabear/models/customer.rb', line 285

def hash
  [id, email, tax_number, standard_tax_rate, digital_tax_rate, billing_type, type, reference, external_reference, address, locale, brand, invoice_format, marketing_opt_in].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properties with the reasons



204
205
206
207
208
209
210
211
 
# File 'lib/billabear/models/customer.rb', line 204

def list_invalid_properties
  invalid_properties = Array.new
  if @email.nil?
    invalid_properties.push('invalid value for "email", email cannot be nil.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



367
368
369
 
# File 'lib/billabear/models/customer.rb', line 367

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



373
374
375
376
377
378
379
380
381
382
383
384
385
 
# File 'lib/billabear/models/customer.rb', line 373

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 ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



361
362
363
 
# File 'lib/billabear/models/customer.rb', line 361

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



215
216
217
218
219
220
221
222
223
224
 
# File 'lib/billabear/models/customer.rb', line 215

def valid?
  return false if @email.nil?
  billing_type_validator = EnumAttributeValidator.new('Object', ['card', 'invoice'])
  return false unless billing_type_validator.valid?(@billing_type)
  type_validator = EnumAttributeValidator.new('Object', ['individual', 'business'])
  return false unless type_validator.valid?(@type)
  invoice_format_validator = EnumAttributeValidator.new('Object', ['pdf', 'xrechnung'])
  return false unless invoice_format_validator.valid?(@invoice_format)
  true
end