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

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateResponse

Defined in:

lib/finch_api/models/hris/company/pay_statement_item/rule_create_response.rb

Overview

See Also:

• Resources::HRIS::Company::PayStatementItem::Rules#create

Defined Under Namespace

Modules: EntityType Classes: Attributes, Condition

Instance Attribute Summary

• #attributes ⇒ FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateResponse::Attributes^?

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

• #conditions ⇒ Array<FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateResponse::Condition>^?
• #created_at ⇒ Time^?

  The datetime when the rule was created.

• #effective_end_date ⇒ String^?

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

• #effective_start_date ⇒ String^?

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

• #entity_type ⇒ Symbol, ...

  The entity type to which the rule is applied.

• #id ⇒ String^?

  Finch id (uuidv4) for the rule.

• #priority ⇒ Integer^?

  The priority of the rule.

• #updated_at ⇒ Time^?

  The datetime when the rule was last updated.

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(metadata: nil) ⇒ Object constructor

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

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_response.rb', line 66

Instance Attribute Details

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

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

Returns:

• (FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateResponse::Attributes, nil)

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

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

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

Returns:

• (Array<FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateResponse::Condition>, nil)

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

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

#created_at ⇒ Time^?

The datetime when the rule was created.

Returns:

• (Time, nil)

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

optional :created_at, Time

#effective_end_date ⇒ String^?

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

Returns:

• (String, nil)

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

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)

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

optional :effective_start_date, String, nil?: true

#entity_type ⇒ Symbol, ...

The entity type to which the rule is applied.

Returns:

• (Symbol, FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateResponse::EntityType, nil)

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

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

#id ⇒ String^?

Finch id (uuidv4) for the rule.

Returns:

• (String, nil)

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

optional :id, String

#priority ⇒ Integer^?

The priority of the rule.

Returns:

• (Integer, nil)

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

optional :priority, Integer

#updated_at ⇒ Time^?

The datetime when the rule was last updated.

Returns:

• (Time, nil)

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

optional :updated_at, Time

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

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