Class: FinchAPI::Models::HRIS::PayStatementItem::RuleCreateResponse

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/finch_api/models/hris/pay_statement_item/rule_create_response.rb

Overview

See Also:

Defined Under Namespace

Modules: EntityType Classes: Attributes, Condition

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

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/pay_statement_item/rule_create_response.rb', line 64

Instance Attribute Details

#attributes ⇒ FinchAPI::Models::HRIS::PayStatementItem::RuleCreateResponse::Attributes?

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

Returns:



19
 
# File 'lib/finch_api/models/hris/pay_statement_item/rule_create_response.rb', line 19

optional :attributes, -> { FinchAPI::Models::HRIS::PayStatementItem::RuleCreateResponse::Attributes }

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

Returns:



24
25
 
# File 'lib/finch_api/models/hris/pay_statement_item/rule_create_response.rb', line 24

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

#created_at ⇒ Time?

The datetime when the rule was created.

Returns:

  • (Time, nil) 


31
 
# File 'lib/finch_api/models/hris/pay_statement_item/rule_create_response.rb', line 31

optional :created_at, Time

#effective_end_date ⇒ String?

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

Returns:

  • (String, nil) 


37
 
# File 'lib/finch_api/models/hris/pay_statement_item/rule_create_response.rb', line 37

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) 


43
 
# File 'lib/finch_api/models/hris/pay_statement_item/rule_create_response.rb', line 43

optional :effective_start_date, String, nil?: true

#entity_type ⇒ Symbol, ...

The entity type to which the rule is applied.

Returns:



49
50
 
# File 'lib/finch_api/models/hris/pay_statement_item/rule_create_response.rb', line 49

optional :entity_type,
enum: -> { FinchAPI::Models::HRIS::PayStatementItem::RuleCreateResponse::EntityType }

#id ⇒ String?

Finch id (uuidv4) for the rule.

Returns:

  • (String, nil) 


13
 
# File 'lib/finch_api/models/hris/pay_statement_item/rule_create_response.rb', line 13

optional :id, String

#priority ⇒ Integer?

The priority of the rule.

Returns:

  • (Integer, nil) 


56
 
# File 'lib/finch_api/models/hris/pay_statement_item/rule_create_response.rb', line 56

optional :priority, Integer

#updated_at ⇒ Time?

The datetime when the rule was last updated.

Returns:

  • (Time, nil) 


62
 
# File 'lib/finch_api/models/hris/pay_statement_item/rule_create_response.rb', line 62

optional :updated_at, Time

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/finch_api/models/hris/pay_statement_item/rule_create_response.rb', line 137