Class: FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/finch_api/models/hris/company/pay_statement_item/rule_create_params.rb

Overview

See Also:

Defined Under Namespace

Modules: EntityType Classes: Attributes, Condition

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary collapse

Instance Method Summary collapse

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(metadata: nil) ⇒ Object

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

Specifies the fields to be applied when the condition is met.

Parameters:

  • metadata (Hash{Symbol=>Object}) (defaults to: nil) —

    The metadata to be attached in the entity. It is a key-value pairs where the val




# File 'lib/finch_api/models/hris/company/pay_statement_item/rule_create_params.rb', line 65

Instance Attribute Details

#attributes ⇒ FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateParams::Attributes?

Specifies the fields to be applied when the condition is met.

Returns:



17
 
# File 'lib/finch_api/models/hris/company/pay_statement_item/rule_create_params.rb', line 17

optional :attributes, -> { FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::Attributes }

#conditions ⇒ Array<FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateParams::Condition>?

Returns:



22
23
 
# File 'lib/finch_api/models/hris/company/pay_statement_item/rule_create_params.rb', line 22

optional :conditions,
-> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::Condition] }

#effective_end_date ⇒ String?

Specifies when the rules should stop applying rules based on the date.

Returns:

  • (String, nil) 


29
 
# File 'lib/finch_api/models/hris/company/pay_statement_item/rule_create_params.rb', line 29

optional :effective_end_date, String, nil?: true

#effective_start_date ⇒ String?

Specifies when the rule should begin applying based on the date.

Returns:

  • (String, nil) 


35
 
# File 'lib/finch_api/models/hris/company/pay_statement_item/rule_create_params.rb', line 35

optional :effective_start_date, String, nil?: true

#entity_type ⇒ Symbol, ...

The entity type to which the rule is applied.

Returns:



41
42
 
# File 'lib/finch_api/models/hris/company/pay_statement_item/rule_create_params.rb', line 41

optional :entity_type,
enum: -> { FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::EntityType }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/finch_api/models/hris/company/pay_statement_item/rule_create_params.rb', line 110