Class: TripletexApi::TripletexAccount
- Inherits:
-
Object
- Object
- TripletexApi::TripletexAccount
- Defined in:
- lib/tripletex_api/models/tripletex_account.rb
Defined Under Namespace
Classes: EnumAttributeValidator
Instance Attribute Summary collapse
-
#account_type ⇒ Object
Is this a test account or a paying account?.
-
#accounting_office ⇒ Object
Returns the value of attribute accounting_office.
-
#administrator ⇒ Object
Employee to create.
-
#administrator_password ⇒ Object
Password for the administrator user to create.
-
#auditor ⇒ Object
Returns the value of attribute auditor.
-
#auto_validate_user_login ⇒ Object
If true, the users created will be allowed to log in without validating their email address.
-
#chart_of_accounts_type ⇒ Object
The chart of accounts to use for the new company.
-
#company ⇒ Object
Information about the company to create.
-
#create_administrator_api_token ⇒ Object
Create an API token for the administrator user for the consumer token used during this call.
-
#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.
-
#may_create_tripletex_accounts ⇒ Object
Should the company we are creating be able to create new Tripletex accounts?.
-
#modules ⇒ Object
Modules (functionality in the application) to activate for the newly created account.
-
#number_of_vouchers ⇒ Object
Used to calculate prices.
-
#reseller ⇒ Object
Returns the value of attribute reseller.
-
#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.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_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) ⇒ Object
Builds the object from hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ TripletexAccount
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 ⇒ 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 = {}) ⇒ TripletexAccount
Initializes the object
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 200 201 202 203 204 205 206 207 208 |
# File 'lib/tripletex_api/models/tripletex_account.rb', line 126 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.account_type = 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.auto_validate_user_login = attributes[:'autoValidateUserLogin'] else self.auto_validate_user_login = 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?(:'chartOfAccountsType') self.chart_of_accounts_type = attributes[:'chartOfAccountsType'] end if attributes.has_key?(:'reseller') self.reseller = attributes[:'reseller'] else self.reseller = false 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 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 @account_type end |
#accounting_office ⇒ Object
Returns the value of attribute accounting_office.
56 57 58 |
# File 'lib/tripletex_api/models/tripletex_account.rb', line 56 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.
58 59 60 |
# File 'lib/tripletex_api/models/tripletex_account.rb', line 58 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 @auto_validate_user_login end |
#chart_of_accounts_type ⇒ Object
The chart of accounts to use for the new company
52 53 54 |
# File 'lib/tripletex_api/models/tripletex_account.rb', line 52 def chart_of_accounts_type @chart_of_accounts_type 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.
54 55 56 |
# File 'lib/tripletex_api/models/tripletex_account.rb', line 54 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.
83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 |
# File 'lib/tripletex_api/models/tripletex_account.rb', line 83 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', :'chart_of_accounts_type' => :'chartOfAccountsType', :'reseller' => :'reseller', :'accounting_office' => :'accountingOffice', :'auditor' => :'auditor' } end |
.swagger_types ⇒ Object
Attribute type mapping.
104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 |
# File 'lib/tripletex_api/models/tripletex_account.rb', line 104 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', :'chart_of_accounts_type' => :'String', :'reseller' => :'BOOLEAN', :'accounting_office' => :'BOOLEAN', :'auditor' => :'BOOLEAN' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 |
# File 'lib/tripletex_api/models/tripletex_account.rb', line 286 def ==(o) return true if self.equal?(o) self.class == o.class && company == o.company && administrator == o.administrator && account_type == o.account_type && modules == o.modules && administrator_password == o.administrator_password && send_emails == o.send_emails && auto_validate_user_login == o.auto_validate_user_login && 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 && chart_of_accounts_type == o.chart_of_accounts_type && reseller == o.reseller && accounting_office == o.accounting_office && auditor == o.auditor end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 |
# File 'lib/tripletex_api/models/tripletex_account.rb', line 342 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
408 409 410 411 412 413 414 415 416 417 418 419 420 |
# File 'lib/tripletex_api/models/tripletex_account.rb', line 408 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
321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 |
# File 'lib/tripletex_api/models/tripletex_account.rb', line 321 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
308 309 310 |
# File 'lib/tripletex_api/models/tripletex_account.rb', line 308 def eql?(o) self == o end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
314 315 316 |
# File 'lib/tripletex_api/models/tripletex_account.rb', line 314 def hash [company, administrator, account_type, modules, administrator_password, send_emails, auto_validate_user_login, create_administrator_api_token, create_company_owned_api_token, may_create_tripletex_accounts, number_of_vouchers, chart_of_accounts_type, reseller, accounting_office, auditor].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 |
# File 'lib/tripletex_api/models/tripletex_account.rb', line 212 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)
388 389 390 |
# File 'lib/tripletex_api/models/tripletex_account.rb', line 388 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
394 395 396 397 398 399 400 401 402 |
# File 'lib/tripletex_api/models/tripletex_account.rb', line 394 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
382 383 384 |
# File 'lib/tripletex_api/models/tripletex_account.rb', line 382 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
239 240 241 242 243 244 245 246 247 248 249 250 251 252 |
# File 'lib/tripletex_api/models/tripletex_account.rb', line 239 def valid? return false if @company.nil? return false if @account_type.nil? account_type_validator = EnumAttributeValidator.new('String', ["TEST", "PAYING"]) return false unless account_type_validator.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) chart_of_accounts_type_validator = EnumAttributeValidator.new('String', ["DEFAULT", "MAMUT_STD_PAYROLL", "MAMUT_NARF_PAYROLL", "AGRO_FORRETNING_PAYROLL", "AGRO_LANDBRUK_PAYROLL", "AGRO_FISKE_PAYROLL", "AGRO_FORSOKSRING_PAYROLL", "AGRO_IDRETTSLAG_PAYROLL", "AGRO_FORENING_PAYROLL"]) return false unless chart_of_accounts_type_validator.valid?(@chart_of_accounts_type) return true end |