Class: VitableConnect::Models::EmployerUpdateParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• VitableConnect::Models::EmployerUpdateParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/vitable_connect/models/employer_update_params.rb,
sig/vitable_connect/models/employer_update_params.rbs

Overview

See Also:

• VitableConnect::Resources::Employers#update

Defined Under Namespace

Classes: Address

Constant Summary

Constants included from Internal::Type::RequestParameters

Internal::Type::RequestParameters::VitableConnect

Instance Attribute Summary

• #active ⇒ Boolean^?

  Whether the employer is active.

• #address ⇒ VitableConnect::Models::EmployerUpdateParams::Address^?

  Employer address.

• #employer_id ⇒ String

  Unique employer identifier (empr_*).

• #legal_name ⇒ String^?

  Legal business name.

• #name ⇒ String^?

  Employer display name.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize ⇒ Object constructor
• #to_hash ⇒ {

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize ⇒ Object

# File 'sig/vitable_connect/models/employer_update_params.rbs', line 27

def initialize: (

Instance Attribute Details

#active ⇒ Boolean^?

Whether the employer is active

Parameters:

• value (Boolean, nil)

Returns:

• (Boolean, nil)

# File 'lib/vitable_connect/models/employer_update_params.rb', line 20

optional :active, VitableConnect::Internal::Type::Boolean, nil?: true

#address ⇒ VitableConnect::Models::EmployerUpdateParams::Address^?

Employer address

Parameters:

• value (VitableConnect::EmployerUpdateParams::Address, nil)

Returns:

• (VitableConnect::Models::EmployerUpdateParams::Address, nil)

# File 'lib/vitable_connect/models/employer_update_params.rb', line 26

optional :address, -> { VitableConnect::EmployerUpdateParams::Address }, nil?: true

#employer_id ⇒ String

Unique employer identifier (empr_*)

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/vitable_connect/models/employer_update_params.rb', line 14

required :employer_id, String

#legal_name ⇒ String^?

Legal business name

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/vitable_connect/models/employer_update_params.rb', line 32

optional :legal_name, String, nil?: true

#name ⇒ String^?

Employer display name

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/vitable_connect/models/employer_update_params.rb', line 38

optional :name, String, nil?: true

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/vitable_connect/models/employer_update_params.rbs', line 36

def to_hash: -> {