Class: TripletexApi::TripletexAccount

Inherits:
Object
  • Object
show all
Defined in:
lib/tripletex_api/models/tripletex_account.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TripletexAccount

Initializes the object

Parameters:

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

    Model attributes in the form of hash



121
122
123
124
125
126
127
128
129
130
131
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
 
# File 'lib/tripletex_api/models/tripletex_account.rb', line 121

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?(:'company')
    self.company = attributes[:'company']
  end

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

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

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

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

  if attributes.has_key?(:'sendEmails')
    self.send_emails = attributes[:'sendEmails']
  else
    self.send_emails = false
  end

  if attributes.has_key?(:'autoValidateUserLogin')
    self. = attributes[:'autoValidateUserLogin']
  else
    self. = false
  end

  if attributes.has_key?(:'createAdministratorApiToken')
    self.create_administrator_api_token = attributes[:'createAdministratorApiToken']
  else
    self.create_administrator_api_token = false
  end

  if attributes.has_key?(:'createCompanyOwnedApiToken')
    self.create_company_owned_api_token = attributes[:'createCompanyOwnedApiToken']
  else
    self.create_company_owned_api_token = false
  end

  if attributes.has_key?(:'mayCreateTripletexAccounts')
    self.may_create_tripletex_accounts = attributes[:'mayCreateTripletexAccounts']
  else
    self.may_create_tripletex_accounts = false
  end

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

  if attributes.has_key?(:'accountingOffice')
    self.accounting_office = attributes[:'accountingOffice']
  else
    self.accounting_office = false
  end

  if attributes.has_key?(:'auditor')
    self.auditor = attributes[:'auditor']
  else
    self.auditor = false
  end

  if attributes.has_key?(:'reseller')
    self.reseller = attributes[:'reseller']
  else
    self.reseller = false
  end

end

Instance Attribute Details

#account_type ⇒ Object

Is this a test account or a paying account?



25
26
27
 
# File 'lib/tripletex_api/models/tripletex_account.rb', line 25

def 
  @account_type
end

#accounting_office ⇒ Object

Returns the value of attribute accounting_office.



51
52
53
 
# File 'lib/tripletex_api/models/tripletex_account.rb', line 51

def accounting_office
  @accounting_office
end

#administrator ⇒ Object

Employee to create. Department on this object will also be created if supplied. If null a dummy user and department will be created instead



22
23
24
 
# File 'lib/tripletex_api/models/tripletex_account.rb', line 22

def administrator
  @administrator
end

#administrator_password ⇒ Object

Password for the administrator user to create. Not a part of the administrator employee object since this is a value that never can be read (it is salted and hashed before storing)



31
32
33
 
# File 'lib/tripletex_api/models/tripletex_account.rb', line 31

def administrator_password
  @administrator_password
end

#auditor ⇒ Object

Returns the value of attribute auditor.



53
54
55
 
# File 'lib/tripletex_api/models/tripletex_account.rb', line 53

def auditor
  @auditor
end

#auto_validate_user_login ⇒ Object

If true, the users created will be allowed to log in without validating their email address. ONLY USE THIS IF YOU ALREADY HAVE VALIDATED THE USER EMAILS.



37
38
39
 
# File 'lib/tripletex_api/models/tripletex_account.rb', line 37

def 
  @auto_validate_user_login
end

#company ⇒ Object

Information about the company to create. Supply as much info as you have, but at least name, type and address.



19
20
21
 
# File 'lib/tripletex_api/models/tripletex_account.rb', line 19

def company
  @company
end

#create_administrator_api_token ⇒ Object

Create an API token for the administrator user for the consumer token used during this call. The token will be returned in the response.



40
41
42
 
# File 'lib/tripletex_api/models/tripletex_account.rb', line 40

def create_administrator_api_token
  @create_administrator_api_token
end

#create_company_owned_api_token ⇒ Object

Create an API token for the company to use to call their clients, only possible for accounting and auditor accounts. The token will be returned in the response.



43
44
45
 
# File 'lib/tripletex_api/models/tripletex_account.rb', line 43

def create_company_owned_api_token
  @create_company_owned_api_token
end

#may_create_tripletex_accounts ⇒ Object

Should the company we are creating be able to create new Tripletex accounts?



46
47
48
 
# File 'lib/tripletex_api/models/tripletex_account.rb', line 46

def may_create_tripletex_accounts
  @may_create_tripletex_accounts
end

#modules ⇒ Object

Modules (functionality in the application) to activate for the newly created account. Some modules have extra costs.



28
29
30
 
# File 'lib/tripletex_api/models/tripletex_account.rb', line 28

def modules
  @modules
end

#number_of_vouchers ⇒ Object

Used to calculate prices.



49
50
51
 
# File 'lib/tripletex_api/models/tripletex_account.rb', line 49

def number_of_vouchers
  @number_of_vouchers
end

#reseller ⇒ Object

Returns the value of attribute reseller.



55
56
57
 
# File 'lib/tripletex_api/models/tripletex_account.rb', line 55

def reseller
  @reseller
end

#send_emails ⇒ Object

Should the regular creation emails be sent to the company created and its users? If false you probably want to set autoValidateUserLogin to true



34
35
36
 
# File 'lib/tripletex_api/models/tripletex_account.rb', line 34

def send_emails
  @send_emails
end

Class Method Details

.attribute_map ⇒ Object

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



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/tripletex_api/models/tripletex_account.rb', line 80

def self.attribute_map
  {
    :'company' => :'company',
    :'administrator' => :'administrator',
    :'account_type' => :'accountType',
    :'modules' => :'modules',
    :'administrator_password' => :'administratorPassword',
    :'send_emails' => :'sendEmails',
    :'auto_validate_user_login' => :'autoValidateUserLogin',
    :'create_administrator_api_token' => :'createAdministratorApiToken',
    :'create_company_owned_api_token' => :'createCompanyOwnedApiToken',
    :'may_create_tripletex_accounts' => :'mayCreateTripletexAccounts',
    :'number_of_vouchers' => :'numberOfVouchers',
    :'accounting_office' => :'accountingOffice',
    :'auditor' => :'auditor',
    :'reseller' => :'reseller'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/tripletex_api/models/tripletex_account.rb', line 100

def self.swagger_types
  {
    :'company' => :'Company',
    :'administrator' => :'Employee',
    :'account_type' => :'String',
    :'modules' => :'Modules',
    :'administrator_password' => :'String',
    :'send_emails' => :'BOOLEAN',
    :'auto_validate_user_login' => :'BOOLEAN',
    :'create_administrator_api_token' => :'BOOLEAN',
    :'create_company_owned_api_token' => :'BOOLEAN',
    :'may_create_tripletex_accounts' => :'BOOLEAN',
    :'number_of_vouchers' => :'String',
    :'accounting_office' => :'BOOLEAN',
    :'auditor' => :'BOOLEAN',
    :'reseller' => :'BOOLEAN'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/tripletex_api/models/tripletex_account.rb', line 265

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      company == o.company &&
      administrator == o.administrator &&
       == o. &&
      modules == o.modules &&
      administrator_password == o.administrator_password &&
      send_emails == o.send_emails &&
       == o. &&
      create_administrator_api_token == o.create_administrator_api_token &&
      create_company_owned_api_token == o.create_company_owned_api_token &&
      may_create_tripletex_accounts == o.may_create_tripletex_accounts &&
      number_of_vouchers == o.number_of_vouchers &&
      accounting_office == o.accounting_office &&
      auditor == o.auditor &&
      reseller == o.reseller
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



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
353
354
355
356
 
# File 'lib/tripletex_api/models/tripletex_account.rb', line 320

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 = TripletexApi.const_get(type).new
    temp_model.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/tripletex_api/models/tripletex_account.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



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

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


286
287
288
 
# File 'lib/tripletex_api/models/tripletex_account.rb', line 286

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



292
293
294
 
# File 'lib/tripletex_api/models/tripletex_account.rb', line 292

def hash
  [company, administrator, , modules, administrator_password, send_emails, , create_administrator_api_token, create_company_owned_api_token, may_create_tripletex_accounts, number_of_vouchers, accounting_office, auditor, reseller].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



203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/tripletex_api/models/tripletex_account.rb', line 203

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

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

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

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

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

  return 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



366
367
368
 
# File 'lib/tripletex_api/models/tripletex_account.rb', line 366

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



372
373
374
375
376
377
378
379
380
 
# File 'lib/tripletex_api/models/tripletex_account.rb', line 372

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

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



360
361
362
 
# File 'lib/tripletex_api/models/tripletex_account.rb', line 360

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



230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/tripletex_api/models/tripletex_account.rb', line 230

def valid?
  return false if @company.nil?
  return false if @account_type.nil?
   = EnumAttributeValidator.new('String', ["TEST", "PAYING"])
  return false unless .valid?(@account_type)
  return false if @modules.nil?
  return false if @administrator_password.nil?
  return false if @number_of_vouchers.nil?
  number_of_vouchers_validator = EnumAttributeValidator.new('String', ["INTERVAL_0_100", "INTERVAL_101_500", "INTERVAL_0_500", "INTERVAL_501_1000", "INTERVAL_1001_2000", "INTERVAL_2001_3500", "INTERVAL_3501_5000", "INTERVAL_5001_10000", "INTERVAL_UNLIMITED"])
  return false unless number_of_vouchers_validator.valid?(@number_of_vouchers)
  return true
end