Class: FinchAPI::Models::Sandbox::CompanyUpdateResponse

Inherits:

BaseModel

• Object
• FinchAPI::Models::Sandbox::CompanyUpdateResponse

Defined in:

lib/finch-api/models/sandbox/company_update_response.rb

Defined Under Namespace

Classes: Account, Department, Entity

Instance Attribute Summary

• #accounts ⇒ Array<FinchAPI::Models::Sandbox::CompanyUpdateResponse::Account>^?

  An array of bank account objects associated with the payroll/HRIS system.

• #departments ⇒ Array<FinchAPI::Models::Sandbox::CompanyUpdateResponse::Department, nil>^?

  The array of company departments.

• #ein ⇒ String^?

  The employer identification number.

• #entity ⇒ FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity^?

  The entity type object.

• #legal_name ⇒ String^?

  The legal name of the company.

• #locations ⇒ Array<FinchAPI::Models::Location, nil>^?
• #primary_email ⇒ String^?

  The email of the main administrator on the account.

• #primary_phone_number ⇒ String^?

  The phone number of the main administrator on the account.

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(name: nil) ⇒ CompanyUpdateResponse constructor

  The parent department, if present.

Constructor Details

#initialize(name: nil) ⇒ CompanyUpdateResponse

The parent department, if present.

Parameters:

• name (String, nil) (defaults to: nil)

# File 'lib/finch-api/models/sandbox/company_update_response.rb', line 10

def initialize(accounts:, departments:, ein:, entity:, legal_name:, locations:, primary_email:, primary_phone_number:, **) = super

Instance Attribute Details

#accounts ⇒ Array<FinchAPI::Models::Sandbox::CompanyUpdateResponse::Account>^?

An array of bank account objects associated with the payroll/HRIS system.

Returns:

• (Array<FinchAPI::Models::Sandbox::CompanyUpdateResponse::Account>, nil)

# File 'lib/finch-api/models/sandbox/company_update_response.rb', line 11

required :accounts,
-> { FinchAPI::ArrayOf[FinchAPI::Models::Sandbox::CompanyUpdateResponse::Account] },
nil?: true

#departments ⇒ Array<FinchAPI::Models::Sandbox::CompanyUpdateResponse::Department, nil>^?

The array of company departments.

Returns:

• (Array<FinchAPI::Models::Sandbox::CompanyUpdateResponse::Department, nil>, nil)

# File 'lib/finch-api/models/sandbox/company_update_response.rb', line 19

required :departments,
-> { FinchAPI::ArrayOf[FinchAPI::Models::Sandbox::CompanyUpdateResponse::Department, nil?: true] },
nil?: true

#ein ⇒ String^?

The employer identification number.

Returns:

• (String, nil)

# File 'lib/finch-api/models/sandbox/company_update_response.rb', line 27

required :ein, String, nil?: true

#entity ⇒ FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity^?

The entity type object.

Returns:

• (FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity, nil)

# File 'lib/finch-api/models/sandbox/company_update_response.rb', line 33

required :entity, -> { FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity }, nil?: true

#legal_name ⇒ String^?

The legal name of the company.

Returns:

• (String, nil)

# File 'lib/finch-api/models/sandbox/company_update_response.rb', line 39

required :legal_name, String, nil?: true

#locations ⇒ Array<FinchAPI::Models::Location, nil>^?

Returns:

• (Array<FinchAPI::Models::Location, nil>, nil)

# File 'lib/finch-api/models/sandbox/company_update_response.rb', line 44

required :locations, -> { FinchAPI::ArrayOf[FinchAPI::Models::Location, nil?: true] }, nil?: true

#primary_email ⇒ String^?

The email of the main administrator on the account.

Returns:

• (String, nil)

# File 'lib/finch-api/models/sandbox/company_update_response.rb', line 50

required :primary_email, String, nil?: true

#primary_phone_number ⇒ String^?

The phone number of the main administrator on the account. Format: ‘XXXXXXXXXX`

Returns:

• (String, nil)

# File 'lib/finch-api/models/sandbox/company_update_response.rb', line 56

required :primary_phone_number, String, nil?: true

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/finch-api/models/sandbox/company_update_response.rb', line 2

def self.values; end