Class: VitableConnect::Models::EmployerUpdateSettingsParams

Inherits:

Internal::Type::BaseModel

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

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/vitable_connect/models/employer_update_settings_params.rb

Overview

See Also:

• Resources::Employers#update_settings

Defined Under Namespace

Modules: PayFrequency

Instance Attribute Summary

• #employer_id ⇒ String

  Unique employer identifier (empr_*).

• #pay_frequency ⇒ Symbol, VitableConnect::Models::EmployerUpdateSettingsParams::PayFrequency

  • ‘weekly` - weekly - `bi_weekly` - bi_weekly - `semi_monthly` - semi_monthly - `monthly` - monthly.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(employer_id:, pay_frequency:, request_options: {}) ⇒ Object constructor

  Some parameter documentations has been truncated, see EmployerUpdateSettingsParams for more details.

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(employer_id:, pay_frequency:, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see VitableConnect::Models::EmployerUpdateSettingsParams for more details.

Parameters:

• employer_id (String) —

  Unique employer identifier (empr_*)

• pay_frequency (Symbol, VitableConnect::Models::EmployerUpdateSettingsParams::PayFrequency) —

  • ‘weekly` - weekly

• request_options (VitableConnect::RequestOptions, Hash{Symbol=>Object}) (defaults to: {})

# File 'lib/vitable_connect/models/employer_update_settings_params.rb', line 25

Instance Attribute Details

#employer_id ⇒ String

Unique employer identifier (empr_*)

Returns:

• (String)

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

required :employer_id, String

#pay_frequency ⇒ Symbol, VitableConnect::Models::EmployerUpdateSettingsParams::PayFrequency

• ‘weekly` - weekly

• ‘bi_weekly` - bi_weekly

• ‘semi_monthly` - semi_monthly

• ‘monthly` - monthly

Returns:

• (Symbol, VitableConnect::Models::EmployerUpdateSettingsParams::PayFrequency)

# File 'lib/vitable_connect/models/employer_update_settings_params.rb', line 23

required :pay_frequency, enum: -> { VitableConnect::EmployerUpdateSettingsParams::PayFrequency }