Class: LWS::Auth::Company

Inherits:
Generic::Model show all
Defined in:
lib/lws/apps/auth.rb

Overview

The company class

Instance Attribute Summary collapse

Instance Attribute Details

#accounts ⇒ Array<Account>

Returns the accounts that are assigned to the company.

Returns:

  • (Array<Account>) —

    the accounts that are assigned to the company



167
 
# File 'lib/lws/apps/auth.rb', line 167

has_many :accounts

#activated ⇒ Boolean

Returns whether the company has been activated.

Returns:

  • (Boolean) —

    whether the company has been activated



171
 
# File 'lib/lws/apps/auth.rb', line 171

attribute :activated

#address ⇒ String

Returns the address of the company (at least 2 characters long).

Returns:

  • (String) —

    the address of the company (at least 2 characters long)



180
 
# File 'lib/lws/apps/auth.rb', line 180

attribute :address

#apps ⇒ Array<App>

Returns the apps that are assigned to the company.

Returns:

  • (Array<App>) —

    the apps that are assigned to the company



175
 
# File 'lib/lws/apps/auth.rb', line 175

has_many :apps

#city ⇒ String

Returns the city of the company (at least 2 characters long).

Returns:

  • (String) —

    the city of the company (at least 2 characters long)



185
 
# File 'lib/lws/apps/auth.rb', line 185

attribute :city

#contact_person ⇒ Account

Returns the contact person of the company.

Returns:

  • (Account) —

    the contact person of the company



189
190
191
 
# File 'lib/lws/apps/auth.rb', line 189

belongs_to :contact_person, class_name: "LWS::Auth::Account",
foreign_key: :contact_person_id,
uri: "accounts/:id"

#contact_person_id ⇒ Fixnum

Returns the ID of the contact person of the company.

Returns:

  • (Fixnum) —

    the ID of the contact person of the company



195
 
# File 'lib/lws/apps/auth.rb', line 195

attribute :contact_person_id

#contracts ⇒ Array<Contract>

Returns the contracts of the company.

Returns:

  • (Array<Contract>) —

    the contracts of the company



199
 
# File 'lib/lws/apps/auth.rb', line 199

has_many :contracts

#country ⇒ String

Returns the country of the company (at least 2 characters long).

Returns:

  • (String) —

    the country of the company (at least 2 characters long)



204
 
# File 'lib/lws/apps/auth.rb', line 204

attribute :country

#created_at ⇒ String (readonly)

Returns the timestamp of when the company was created.

Returns:

  • (String) —

    the timestamp of when the company was created



256
 
# File 'lib/lws/apps/auth.rb', line 256

attribute :created_at

#expire ⇒ Boolean

Returns whether the company is planned to be discontinued after the contract ends.

Returns:

  • (Boolean) —

    whether the company is planned to be discontinued after the contract ends



209
 
# File 'lib/lws/apps/auth.rb', line 209

attribute :expire

#id ⇒ Fixnum (readonly)

Returns the (unique) ID of the company.

Returns:

  • (Fixnum) —

    the (unique) ID of the company



163
 
# File 'lib/lws/apps/auth.rb', line 163

attribute :id

#licenses ⇒ Array<License>

Returns the licenses of the company.

Returns:

  • (Array<License>) —

    the licenses of the company



213
 
# File 'lib/lws/apps/auth.rb', line 213

has_many :licenses

#name ⇒ String

Returns the name of the company (at least 2 characters long).

Returns:

  • (String) —

    the name of the company (at least 2 characters long)



218
 
# File 'lib/lws/apps/auth.rb', line 218

attribute :name

#number ⇒ String

Returns the street address number of the company (at least 1 character long).

Returns:

  • (String) —

    the street address number of the company (at least 1 character long)



223
 
# File 'lib/lws/apps/auth.rb', line 223

attribute :number

#parent ⇒ Company?

Returns the parenty company.

Returns:

  • (Company, nil) —

    the parenty company



227
228
229
 
# File 'lib/lws/apps/auth.rb', line 227

belongs_to :parent, class_name: "LWS::Auth::Company",
foreign_key: :parent_id,
uri: "companies/:id"

#parent_id ⇒ Fixnum?

Returns the ID of the parenty company.

Returns:

  • (Fixnum, nil) —

    the ID of the parenty company



233
 
# File 'lib/lws/apps/auth.rb', line 233

attribute :parent_id

#telephone_number ⇒ String

Returns the telephone number of the company (at least 2 characters long).

Returns:

  • (String) —

    the telephone number of the company (at least 2 characters long)



238
 
# File 'lib/lws/apps/auth.rb', line 238

attribute :telephone_number

#updated_at ⇒ String (readonly)

Returns the timestamp of when the company was last updated.

Returns:

  • (String) —

    the timestamp of when the company was last updated



260
 
# File 'lib/lws/apps/auth.rb', line 260

attribute :updated_at

#usage_reports ⇒ Array<UsageReport>

Returns the usage reports available/generated for the company.

Returns:

  • (Array<UsageReport>) —

    the usage reports available/generated for the company



243
 
# File 'lib/lws/apps/auth.rb', line 243

has_many :usage_reports, uri: "company/:company_id/reports"

#uuid ⇒ String

Returns the UUID of the company.

Returns:

  • (String) —

    the UUID of the company



247
 
# File 'lib/lws/apps/auth.rb', line 247

attribute :uuid

#zip_code ⇒ String

Returns the zip code of the company (at least 2 characters long).

Returns:

  • (String) —

    the zip code of the company (at least 2 characters long)



252
 
# File 'lib/lws/apps/auth.rb', line 252

attribute :zip_code