finch-api 0.1.0.pre.alpha.44 → 0.1.0.pre.alpha.45

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (84) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +8 -0
  3. data/README.md +1 -1
  4. data/lib/finch_api/models/hris/pay_statement_item/rule_create_params.rb +133 -0
  5. data/lib/finch_api/models/hris/pay_statement_item/rule_create_response.rb +157 -0
  6. data/lib/finch_api/models/hris/pay_statement_item/rule_delete_params.rb +33 -0
  7. data/lib/finch_api/models/hris/pay_statement_item/rule_delete_response.rb +165 -0
  8. data/lib/finch_api/models/hris/pay_statement_item/rule_list_params.rb +26 -0
  9. data/lib/finch_api/models/hris/pay_statement_item/rule_list_response.rb +156 -0
  10. data/lib/finch_api/models/hris/pay_statement_item/rule_update_params.rb +40 -0
  11. data/lib/finch_api/models/hris/pay_statement_item/rule_update_response.rb +157 -0
  12. data/lib/finch_api/models/hris/pay_statement_item_list_params.rb +83 -0
  13. data/lib/finch_api/models/hris/pay_statement_item_list_response.rb +97 -0
  14. data/lib/finch_api/resources/hris/company.rb +0 -4
  15. data/lib/finch_api/resources/hris/pay_statement_item/rules.rb +141 -0
  16. data/lib/finch_api/resources/hris/pay_statement_item.rb +59 -0
  17. data/lib/finch_api/resources/hris.rb +4 -0
  18. data/lib/finch_api/version.rb +1 -1
  19. data/lib/finch_api.rb +12 -12
  20. data/rbi/finch_api/models/hris/pay_statement_item/rule_create_params.rbi +315 -0
  21. data/rbi/finch_api/models/hris/pay_statement_item/rule_create_response.rbi +342 -0
  22. data/rbi/finch_api/models/hris/pay_statement_item/rule_delete_params.rbi +59 -0
  23. data/rbi/finch_api/models/hris/pay_statement_item/rule_delete_response.rbi +353 -0
  24. data/rbi/finch_api/models/hris/pay_statement_item/rule_list_params.rbi +53 -0
  25. data/rbi/finch_api/models/hris/pay_statement_item/rule_list_response.rbi +342 -0
  26. data/rbi/finch_api/models/hris/pay_statement_item/rule_update_params.rbi +68 -0
  27. data/rbi/finch_api/models/hris/pay_statement_item/rule_update_response.rbi +342 -0
  28. data/rbi/finch_api/models/hris/pay_statement_item_list_params.rbi +177 -0
  29. data/rbi/finch_api/models/hris/pay_statement_item_list_response.rbi +189 -0
  30. data/rbi/finch_api/resources/hris/company.rbi +0 -3
  31. data/rbi/finch_api/resources/hris/pay_statement_item/rules.rbi +114 -0
  32. data/rbi/finch_api/resources/hris/pay_statement_item.rbi +57 -0
  33. data/rbi/finch_api/resources/hris.rbi +3 -0
  34. data/sig/finch_api/models/hris/pay_statement_item/rule_create_params.rbs +136 -0
  35. data/sig/finch_api/models/hris/pay_statement_item/rule_create_response.rbs +151 -0
  36. data/sig/finch_api/models/hris/pay_statement_item/rule_delete_params.rbs +34 -0
  37. data/sig/finch_api/models/hris/pay_statement_item/rule_delete_response.rbs +158 -0
  38. data/sig/finch_api/models/hris/pay_statement_item/rule_list_params.rbs +30 -0
  39. data/sig/finch_api/models/hris/pay_statement_item/rule_list_response.rbs +151 -0
  40. data/sig/finch_api/models/hris/pay_statement_item/rule_update_params.rbs +44 -0
  41. data/sig/finch_api/models/hris/pay_statement_item/rule_update_response.rbs +151 -0
  42. data/sig/finch_api/models/hris/pay_statement_item_list_params.rbs +81 -0
  43. data/sig/finch_api/models/hris/pay_statement_item_list_response.rbs +78 -0
  44. data/sig/finch_api/resources/hris/company.rbs +0 -2
  45. data/sig/finch_api/resources/hris/pay_statement_item/rules.rbs +39 -0
  46. data/sig/finch_api/resources/hris/pay_statement_item.rbs +21 -0
  47. data/sig/finch_api/resources/hris.rbs +2 -0
  48. metadata +37 -37
  49. data/lib/finch_api/models/hris/company/pay_statement_item/rule_create_params.rb +0 -137
  50. data/lib/finch_api/models/hris/company/pay_statement_item/rule_create_response.rb +0 -160
  51. data/lib/finch_api/models/hris/company/pay_statement_item/rule_delete_params.rb +0 -35
  52. data/lib/finch_api/models/hris/company/pay_statement_item/rule_delete_response.rb +0 -168
  53. data/lib/finch_api/models/hris/company/pay_statement_item/rule_list_params.rb +0 -28
  54. data/lib/finch_api/models/hris/company/pay_statement_item/rule_list_response.rb +0 -160
  55. data/lib/finch_api/models/hris/company/pay_statement_item/rule_update_params.rb +0 -42
  56. data/lib/finch_api/models/hris/company/pay_statement_item/rule_update_response.rb +0 -160
  57. data/lib/finch_api/models/hris/company/pay_statement_item_list_params.rb +0 -85
  58. data/lib/finch_api/models/hris/company/pay_statement_item_list_response.rb +0 -99
  59. data/lib/finch_api/resources/hris/company/pay_statement_item/rules.rb +0 -144
  60. data/lib/finch_api/resources/hris/company/pay_statement_item.rb +0 -61
  61. data/rbi/finch_api/models/hris/company/pay_statement_item/rule_create_params.rbi +0 -319
  62. data/rbi/finch_api/models/hris/company/pay_statement_item/rule_create_response.rbi +0 -346
  63. data/rbi/finch_api/models/hris/company/pay_statement_item/rule_delete_params.rbi +0 -61
  64. data/rbi/finch_api/models/hris/company/pay_statement_item/rule_delete_response.rbi +0 -357
  65. data/rbi/finch_api/models/hris/company/pay_statement_item/rule_list_params.rbi +0 -55
  66. data/rbi/finch_api/models/hris/company/pay_statement_item/rule_list_response.rbi +0 -346
  67. data/rbi/finch_api/models/hris/company/pay_statement_item/rule_update_params.rbi +0 -70
  68. data/rbi/finch_api/models/hris/company/pay_statement_item/rule_update_response.rbi +0 -346
  69. data/rbi/finch_api/models/hris/company/pay_statement_item_list_params.rbi +0 -179
  70. data/rbi/finch_api/models/hris/company/pay_statement_item_list_response.rbi +0 -191
  71. data/rbi/finch_api/resources/hris/company/pay_statement_item/rules.rbi +0 -116
  72. data/rbi/finch_api/resources/hris/company/pay_statement_item.rbi +0 -61
  73. data/sig/finch_api/models/hris/company/pay_statement_item/rule_create_params.rbs +0 -138
  74. data/sig/finch_api/models/hris/company/pay_statement_item/rule_create_response.rbs +0 -153
  75. data/sig/finch_api/models/hris/company/pay_statement_item/rule_delete_params.rbs +0 -36
  76. data/sig/finch_api/models/hris/company/pay_statement_item/rule_delete_response.rbs +0 -160
  77. data/sig/finch_api/models/hris/company/pay_statement_item/rule_list_params.rbs +0 -32
  78. data/sig/finch_api/models/hris/company/pay_statement_item/rule_list_response.rbs +0 -153
  79. data/sig/finch_api/models/hris/company/pay_statement_item/rule_update_params.rbs +0 -46
  80. data/sig/finch_api/models/hris/company/pay_statement_item/rule_update_response.rbs +0 -153
  81. data/sig/finch_api/models/hris/company/pay_statement_item_list_params.rbs +0 -83
  82. data/sig/finch_api/models/hris/company/pay_statement_item_list_response.rbs +0 -80
  83. data/sig/finch_api/resources/hris/company/pay_statement_item/rules.rbs +0 -41
  84. data/sig/finch_api/resources/hris/company/pay_statement_item.rbs +0 -23
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 12794deec4b43f622c3c367e7f5c2122b74b79ef8b95cd977c8c2dd0c750e35f
4
- data.tar.gz: 0a09ac11b13a0f0898ab04f8112a50029b451251bdb90162c0e4c3de681d281d
3
+ metadata.gz: 3f97166361d7e397236ca46a3c47e3a7d0a28b053f11b53bf69e13d777a33737
4
+ data.tar.gz: 29c7f020329111b79aecb549c68d19ace8a65071231a75e8cbb2673aa7427c5c
5
5
  SHA512:
6
- metadata.gz: 47acb9bed05c5983db93765eca4c5da6f381c3bca5f07fb10c696aaa45b3e7fe028208119063f30db56d2365d8bf0e8fbaeab3bed4a979b532377151c88ca3ab
7
- data.tar.gz: 01b7a7babc340e497da88144345b326b3eda2c65b24226c858be1c9e4d565359a2f7b0f0ccea47971d52aeb5f5ea3da81dd796365e0e98859fee6d261030bd00
6
+ metadata.gz: 8d4b2a0c575443ce25eab434eabc2477b683a3cf0c7956220cd017848567030025210d6d01b6488bedc787ce855e9d25f4d4f25b6bb6c10dda4b5ef62c9205fb
7
+ data.tar.gz: 898a9b0f3df0407af7d150f7778c3cc3c4d77611fb51675a6cbf07e4a29d4aad73d3d74aa2ee9a8a37f92933b53f873ca706e778769f7887b798ed33911b25d5
data/CHANGELOG.md CHANGED
@@ -1,5 +1,13 @@
1
1
  # Changelog
2
2
 
3
+ ## 0.1.0-alpha.45 (2026-06-22)
4
+
5
+ Full Changelog: [v0.1.0-alpha.44...v0.1.0-alpha.45](https://github.com/Finch-API/finch-api-ruby/compare/v0.1.0-alpha.44...v0.1.0-alpha.45)
6
+
7
+ ### Bug Fixes
8
+
9
+ * **payroll:** pay_statement_item is now a direct subresource of hris instead of company ([83b50ae](https://github.com/Finch-API/finch-api-ruby/commit/83b50ae945eb5a7db1cc1212ec7de522553ea050))
10
+
3
11
  ## 0.1.0-alpha.44 (2026-06-22)
4
12
 
5
13
  Full Changelog: [v0.1.0-alpha.43...v0.1.0-alpha.44](https://github.com/Finch-API/finch-api-ruby/compare/v0.1.0-alpha.43...v0.1.0-alpha.44)
data/README.md CHANGED
@@ -26,7 +26,7 @@ To use this gem, install via Bundler by adding the following to your application
26
26
  <!-- x-release-please-start-version -->
27
27
 
28
28
  ```ruby
29
- gem "finch-api", "~> 0.1.0.pre.alpha.44"
29
+ gem "finch-api", "~> 0.1.0.pre.alpha.45"
30
30
  ```
31
31
 
32
32
  <!-- x-release-please-end -->
@@ -0,0 +1,133 @@
1
+ # frozen_string_literal: true
2
+
3
+ module FinchAPI
4
+ module Models
5
+ module HRIS
6
+ module PayStatementItem
7
+ # @see FinchAPI::Resources::HRIS::PayStatementItem::Rules#create
8
+ class RuleCreateParams < FinchAPI::Internal::Type::BaseModel
9
+ extend FinchAPI::Internal::Type::RequestParameters::Converter
10
+ include FinchAPI::Internal::Type::RequestParameters
11
+
12
+ # @!attribute entity_ids
13
+ # The entity IDs to create the rule for.
14
+ #
15
+ # @return [Array<String>, nil]
16
+ optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String]
17
+
18
+ # @!attribute attributes
19
+ # Specifies the fields to be applied when the condition is met.
20
+ #
21
+ # @return [FinchAPI::Models::HRIS::PayStatementItem::RuleCreateParams::Attributes, nil]
22
+ optional :attributes, -> { FinchAPI::HRIS::PayStatementItem::RuleCreateParams::Attributes }
23
+
24
+ # @!attribute conditions
25
+ #
26
+ # @return [Array<FinchAPI::Models::HRIS::PayStatementItem::RuleCreateParams::Condition>, nil]
27
+ optional :conditions,
28
+ -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::PayStatementItem::RuleCreateParams::Condition] }
29
+
30
+ # @!attribute effective_end_date
31
+ # Specifies when the rules should stop applying rules based on the date.
32
+ #
33
+ # @return [String, nil]
34
+ optional :effective_end_date, String, nil?: true
35
+
36
+ # @!attribute effective_start_date
37
+ # Specifies when the rule should begin applying based on the date.
38
+ #
39
+ # @return [String, nil]
40
+ optional :effective_start_date, String, nil?: true
41
+
42
+ # @!attribute entity_type
43
+ # The entity type to which the rule is applied.
44
+ #
45
+ # @return [Symbol, FinchAPI::Models::HRIS::PayStatementItem::RuleCreateParams::EntityType, nil]
46
+ optional :entity_type, enum: -> { FinchAPI::HRIS::PayStatementItem::RuleCreateParams::EntityType }
47
+
48
+ # @!method initialize(entity_ids: nil, attributes: nil, conditions: nil, effective_end_date: nil, effective_start_date: nil, entity_type: nil, request_options: {})
49
+ # @param entity_ids [Array<String>] The entity IDs to create the rule for.
50
+ #
51
+ # @param attributes [FinchAPI::Models::HRIS::PayStatementItem::RuleCreateParams::Attributes] Specifies the fields to be applied when the condition is met.
52
+ #
53
+ # @param conditions [Array<FinchAPI::Models::HRIS::PayStatementItem::RuleCreateParams::Condition>]
54
+ #
55
+ # @param effective_end_date [String, nil] Specifies when the rules should stop applying rules based on the date.
56
+ #
57
+ # @param effective_start_date [String, nil] Specifies when the rule should begin applying based on the date.
58
+ #
59
+ # @param entity_type [Symbol, FinchAPI::Models::HRIS::PayStatementItem::RuleCreateParams::EntityType] The entity type to which the rule is applied.
60
+ #
61
+ # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
62
+
63
+ class Attributes < FinchAPI::Internal::Type::BaseModel
64
+ # @!attribute metadata
65
+ # The metadata to be attached in the entity. It is a key-value pairs where the
66
+ # values can be of any type (string, number, boolean, object, array, etc.).
67
+ #
68
+ # @return [Hash{Symbol=>Object}, nil]
69
+ optional :metadata, FinchAPI::Internal::Type::HashOf[FinchAPI::Internal::Type::Unknown]
70
+
71
+ # @!method initialize(metadata: nil)
72
+ # Some parameter documentations has been truncated, see
73
+ # {FinchAPI::Models::HRIS::PayStatementItem::RuleCreateParams::Attributes} for
74
+ # more details.
75
+ #
76
+ # Specifies the fields to be applied when the condition is met.
77
+ #
78
+ # @param metadata [Hash{Symbol=>Object}] The metadata to be attached in the entity. It is a key-value pairs where the val
79
+ end
80
+
81
+ class Condition < FinchAPI::Internal::Type::BaseModel
82
+ # @!attribute field
83
+ # The field to be checked in the rule.
84
+ #
85
+ # @return [String, nil]
86
+ optional :field, String
87
+
88
+ # @!attribute operator
89
+ # The operator to be used in the rule.
90
+ #
91
+ # @return [Symbol, FinchAPI::Models::HRIS::PayStatementItem::RuleCreateParams::Condition::Operator, nil]
92
+ optional :operator, enum: -> { FinchAPI::HRIS::PayStatementItem::RuleCreateParams::Condition::Operator }
93
+
94
+ # @!attribute value
95
+ # The value of the field to be checked in the rule.
96
+ #
97
+ # @return [String, nil]
98
+ optional :value, String
99
+
100
+ # @!method initialize(field: nil, operator: nil, value: nil)
101
+ # @param field [String] The field to be checked in the rule.
102
+ #
103
+ # @param operator [Symbol, FinchAPI::Models::HRIS::PayStatementItem::RuleCreateParams::Condition::Operator] The operator to be used in the rule.
104
+ #
105
+ # @param value [String] The value of the field to be checked in the rule.
106
+
107
+ # The operator to be used in the rule.
108
+ #
109
+ # @see FinchAPI::Models::HRIS::PayStatementItem::RuleCreateParams::Condition#operator
110
+ module Operator
111
+ extend FinchAPI::Internal::Type::Enum
112
+
113
+ EQUALS = :equals
114
+
115
+ # @!method self.values
116
+ # @return [Array<Symbol>]
117
+ end
118
+ end
119
+
120
+ # The entity type to which the rule is applied.
121
+ module EntityType
122
+ extend FinchAPI::Internal::Type::Enum
123
+
124
+ PAY_STATEMENT_ITEM = :pay_statement_item
125
+
126
+ # @!method self.values
127
+ # @return [Array<Symbol>]
128
+ end
129
+ end
130
+ end
131
+ end
132
+ end
133
+ end
@@ -0,0 +1,157 @@
1
+ # frozen_string_literal: true
2
+
3
+ module FinchAPI
4
+ module Models
5
+ module HRIS
6
+ module PayStatementItem
7
+ # @see FinchAPI::Resources::HRIS::PayStatementItem::Rules#create
8
+ class RuleCreateResponse < FinchAPI::Internal::Type::BaseModel
9
+ # @!attribute id
10
+ # Finch id (uuidv4) for the rule.
11
+ #
12
+ # @return [String, nil]
13
+ optional :id, String
14
+
15
+ # @!attribute attributes
16
+ # Specifies the fields to be applied when the condition is met.
17
+ #
18
+ # @return [FinchAPI::Models::HRIS::PayStatementItem::RuleCreateResponse::Attributes, nil]
19
+ optional :attributes, -> { FinchAPI::Models::HRIS::PayStatementItem::RuleCreateResponse::Attributes }
20
+
21
+ # @!attribute conditions
22
+ #
23
+ # @return [Array<FinchAPI::Models::HRIS::PayStatementItem::RuleCreateResponse::Condition>, nil]
24
+ optional :conditions,
25
+ -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Models::HRIS::PayStatementItem::RuleCreateResponse::Condition] }
26
+
27
+ # @!attribute created_at
28
+ # The datetime when the rule was created.
29
+ #
30
+ # @return [Time, nil]
31
+ optional :created_at, Time
32
+
33
+ # @!attribute effective_end_date
34
+ # Specifies when the rules should stop applying rules based on the date.
35
+ #
36
+ # @return [String, nil]
37
+ optional :effective_end_date, String, nil?: true
38
+
39
+ # @!attribute effective_start_date
40
+ # Specifies when the rule should begin applying based on the date.
41
+ #
42
+ # @return [String, nil]
43
+ optional :effective_start_date, String, nil?: true
44
+
45
+ # @!attribute entity_type
46
+ # The entity type to which the rule is applied.
47
+ #
48
+ # @return [Symbol, FinchAPI::Models::HRIS::PayStatementItem::RuleCreateResponse::EntityType, nil]
49
+ optional :entity_type,
50
+ enum: -> { FinchAPI::Models::HRIS::PayStatementItem::RuleCreateResponse::EntityType }
51
+
52
+ # @!attribute priority
53
+ # The priority of the rule.
54
+ #
55
+ # @return [Integer, nil]
56
+ optional :priority, Integer
57
+
58
+ # @!attribute updated_at
59
+ # The datetime when the rule was last updated.
60
+ #
61
+ # @return [Time, nil]
62
+ optional :updated_at, Time
63
+
64
+ # @!method initialize(id: nil, attributes: nil, conditions: nil, created_at: nil, effective_end_date: nil, effective_start_date: nil, entity_type: nil, priority: nil, updated_at: nil)
65
+ # @param id [String] Finch id (uuidv4) for the rule.
66
+ #
67
+ # @param attributes [FinchAPI::Models::HRIS::PayStatementItem::RuleCreateResponse::Attributes] Specifies the fields to be applied when the condition is met.
68
+ #
69
+ # @param conditions [Array<FinchAPI::Models::HRIS::PayStatementItem::RuleCreateResponse::Condition>]
70
+ #
71
+ # @param created_at [Time] The datetime when the rule was created.
72
+ #
73
+ # @param effective_end_date [String, nil] Specifies when the rules should stop applying rules based on the date.
74
+ #
75
+ # @param effective_start_date [String, nil] Specifies when the rule should begin applying based on the date.
76
+ #
77
+ # @param entity_type [Symbol, FinchAPI::Models::HRIS::PayStatementItem::RuleCreateResponse::EntityType] The entity type to which the rule is applied.
78
+ #
79
+ # @param priority [Integer] The priority of the rule.
80
+ #
81
+ # @param updated_at [Time] The datetime when the rule was last updated.
82
+
83
+ # @see FinchAPI::Models::HRIS::PayStatementItem::RuleCreateResponse#attributes
84
+ class Attributes < FinchAPI::Internal::Type::BaseModel
85
+ # @!attribute metadata
86
+ # The metadata to be attached in the entity. It is a key-value pairs where the
87
+ # values can be of any type (string, number, boolean, object, array, etc.).
88
+ #
89
+ # @return [Hash{Symbol=>Object}, nil]
90
+ optional :metadata, FinchAPI::Internal::Type::HashOf[FinchAPI::Internal::Type::Unknown]
91
+
92
+ # @!method initialize(metadata: nil)
93
+ # Some parameter documentations has been truncated, see
94
+ # {FinchAPI::Models::HRIS::PayStatementItem::RuleCreateResponse::Attributes} for
95
+ # more details.
96
+ #
97
+ # Specifies the fields to be applied when the condition is met.
98
+ #
99
+ # @param metadata [Hash{Symbol=>Object}] The metadata to be attached in the entity. It is a key-value pairs where the val
100
+ end
101
+
102
+ class Condition < FinchAPI::Internal::Type::BaseModel
103
+ # @!attribute field
104
+ # The field to be checked in the rule.
105
+ #
106
+ # @return [String, nil]
107
+ optional :field, String
108
+
109
+ # @!attribute operator
110
+ # The operator to be used in the rule.
111
+ #
112
+ # @return [Symbol, FinchAPI::Models::HRIS::PayStatementItem::RuleCreateResponse::Condition::Operator, nil]
113
+ optional :operator,
114
+ enum: -> { FinchAPI::Models::HRIS::PayStatementItem::RuleCreateResponse::Condition::Operator }
115
+
116
+ # @!attribute value
117
+ # The value of the field to be checked in the rule.
118
+ #
119
+ # @return [String, nil]
120
+ optional :value, String
121
+
122
+ # @!method initialize(field: nil, operator: nil, value: nil)
123
+ # @param field [String] The field to be checked in the rule.
124
+ #
125
+ # @param operator [Symbol, FinchAPI::Models::HRIS::PayStatementItem::RuleCreateResponse::Condition::Operator] The operator to be used in the rule.
126
+ #
127
+ # @param value [String] The value of the field to be checked in the rule.
128
+
129
+ # The operator to be used in the rule.
130
+ #
131
+ # @see FinchAPI::Models::HRIS::PayStatementItem::RuleCreateResponse::Condition#operator
132
+ module Operator
133
+ extend FinchAPI::Internal::Type::Enum
134
+
135
+ EQUALS = :equals
136
+
137
+ # @!method self.values
138
+ # @return [Array<Symbol>]
139
+ end
140
+ end
141
+
142
+ # The entity type to which the rule is applied.
143
+ #
144
+ # @see FinchAPI::Models::HRIS::PayStatementItem::RuleCreateResponse#entity_type
145
+ module EntityType
146
+ extend FinchAPI::Internal::Type::Enum
147
+
148
+ PAY_STATEMENT_ITEM = :pay_statement_item
149
+
150
+ # @!method self.values
151
+ # @return [Array<Symbol>]
152
+ end
153
+ end
154
+ end
155
+ end
156
+ end
157
+ end
@@ -0,0 +1,33 @@
1
+ # frozen_string_literal: true
2
+
3
+ module FinchAPI
4
+ module Models
5
+ module HRIS
6
+ module PayStatementItem
7
+ # @see FinchAPI::Resources::HRIS::PayStatementItem::Rules#delete
8
+ class RuleDeleteParams < FinchAPI::Internal::Type::BaseModel
9
+ extend FinchAPI::Internal::Type::RequestParameters::Converter
10
+ include FinchAPI::Internal::Type::RequestParameters
11
+
12
+ # @!attribute rule_id
13
+ #
14
+ # @return [String]
15
+ required :rule_id, String
16
+
17
+ # @!attribute entity_ids
18
+ # The entity IDs to delete the rule for.
19
+ #
20
+ # @return [Array<String>, nil]
21
+ optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String]
22
+
23
+ # @!method initialize(rule_id:, entity_ids: nil, request_options: {})
24
+ # @param rule_id [String]
25
+ #
26
+ # @param entity_ids [Array<String>] The entity IDs to delete the rule for.
27
+ #
28
+ # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
29
+ end
30
+ end
31
+ end
32
+ end
33
+ end
@@ -0,0 +1,165 @@
1
+ # frozen_string_literal: true
2
+
3
+ module FinchAPI
4
+ module Models
5
+ module HRIS
6
+ module PayStatementItem
7
+ # @see FinchAPI::Resources::HRIS::PayStatementItem::Rules#delete
8
+ class RuleDeleteResponse < FinchAPI::Internal::Type::BaseModel
9
+ # @!attribute id
10
+ # Finch id (uuidv4) for the rule.
11
+ #
12
+ # @return [String, nil]
13
+ optional :id, String
14
+
15
+ # @!attribute attributes
16
+ # Specifies the fields to be applied when the condition is met.
17
+ #
18
+ # @return [FinchAPI::Models::HRIS::PayStatementItem::RuleDeleteResponse::Attributes, nil]
19
+ optional :attributes, -> { FinchAPI::Models::HRIS::PayStatementItem::RuleDeleteResponse::Attributes }
20
+
21
+ # @!attribute conditions
22
+ #
23
+ # @return [Array<FinchAPI::Models::HRIS::PayStatementItem::RuleDeleteResponse::Condition>, nil]
24
+ optional :conditions,
25
+ -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Models::HRIS::PayStatementItem::RuleDeleteResponse::Condition] }
26
+
27
+ # @!attribute created_at
28
+ # The datetime when the rule was created.
29
+ #
30
+ # @return [Time, nil]
31
+ optional :created_at, Time
32
+
33
+ # @!attribute deleted_at
34
+ # The datetime when the rule was deleted.
35
+ #
36
+ # @return [Time, nil]
37
+ optional :deleted_at, Time
38
+
39
+ # @!attribute effective_end_date
40
+ # Specifies when the rules should stop applying rules based on the date.
41
+ #
42
+ # @return [String, nil]
43
+ optional :effective_end_date, String, nil?: true
44
+
45
+ # @!attribute effective_start_date
46
+ # Specifies when the rule should begin applying based on the date.
47
+ #
48
+ # @return [String, nil]
49
+ optional :effective_start_date, String, nil?: true
50
+
51
+ # @!attribute entity_type
52
+ # The entity type to which the rule is applied.
53
+ #
54
+ # @return [Symbol, FinchAPI::Models::HRIS::PayStatementItem::RuleDeleteResponse::EntityType, nil]
55
+ optional :entity_type,
56
+ enum: -> { FinchAPI::Models::HRIS::PayStatementItem::RuleDeleteResponse::EntityType }
57
+
58
+ # @!attribute priority
59
+ # The priority of the rule.
60
+ #
61
+ # @return [Integer, nil]
62
+ optional :priority, Integer
63
+
64
+ # @!attribute updated_at
65
+ # The datetime when the rule was last updated.
66
+ #
67
+ # @return [Time, nil]
68
+ optional :updated_at, Time
69
+
70
+ # @!method initialize(id: nil, attributes: nil, conditions: nil, created_at: nil, deleted_at: nil, effective_end_date: nil, effective_start_date: nil, entity_type: nil, priority: nil, updated_at: nil)
71
+ # @param id [String] Finch id (uuidv4) for the rule.
72
+ #
73
+ # @param attributes [FinchAPI::Models::HRIS::PayStatementItem::RuleDeleteResponse::Attributes] Specifies the fields to be applied when the condition is met.
74
+ #
75
+ # @param conditions [Array<FinchAPI::Models::HRIS::PayStatementItem::RuleDeleteResponse::Condition>]
76
+ #
77
+ # @param created_at [Time] The datetime when the rule was created.
78
+ #
79
+ # @param deleted_at [Time] The datetime when the rule was deleted.
80
+ #
81
+ # @param effective_end_date [String, nil] Specifies when the rules should stop applying rules based on the date.
82
+ #
83
+ # @param effective_start_date [String, nil] Specifies when the rule should begin applying based on the date.
84
+ #
85
+ # @param entity_type [Symbol, FinchAPI::Models::HRIS::PayStatementItem::RuleDeleteResponse::EntityType] The entity type to which the rule is applied.
86
+ #
87
+ # @param priority [Integer] The priority of the rule.
88
+ #
89
+ # @param updated_at [Time] The datetime when the rule was last updated.
90
+
91
+ # @see FinchAPI::Models::HRIS::PayStatementItem::RuleDeleteResponse#attributes
92
+ class Attributes < FinchAPI::Internal::Type::BaseModel
93
+ # @!attribute metadata
94
+ # The metadata to be attached in the entity. It is a key-value pairs where the
95
+ # values can be of any type (string, number, boolean, object, array, etc.).
96
+ #
97
+ # @return [Hash{Symbol=>Object}, nil]
98
+ optional :metadata, FinchAPI::Internal::Type::HashOf[FinchAPI::Internal::Type::Unknown]
99
+
100
+ # @!method initialize(metadata: nil)
101
+ # Some parameter documentations has been truncated, see
102
+ # {FinchAPI::Models::HRIS::PayStatementItem::RuleDeleteResponse::Attributes} for
103
+ # more details.
104
+ #
105
+ # Specifies the fields to be applied when the condition is met.
106
+ #
107
+ # @param metadata [Hash{Symbol=>Object}] The metadata to be attached in the entity. It is a key-value pairs where the val
108
+ end
109
+
110
+ class Condition < FinchAPI::Internal::Type::BaseModel
111
+ # @!attribute field
112
+ # The field to be checked in the rule.
113
+ #
114
+ # @return [String, nil]
115
+ optional :field, String
116
+
117
+ # @!attribute operator
118
+ # The operator to be used in the rule.
119
+ #
120
+ # @return [Symbol, FinchAPI::Models::HRIS::PayStatementItem::RuleDeleteResponse::Condition::Operator, nil]
121
+ optional :operator,
122
+ enum: -> { FinchAPI::Models::HRIS::PayStatementItem::RuleDeleteResponse::Condition::Operator }
123
+
124
+ # @!attribute value
125
+ # The value of the field to be checked in the rule.
126
+ #
127
+ # @return [String, nil]
128
+ optional :value, String
129
+
130
+ # @!method initialize(field: nil, operator: nil, value: nil)
131
+ # @param field [String] The field to be checked in the rule.
132
+ #
133
+ # @param operator [Symbol, FinchAPI::Models::HRIS::PayStatementItem::RuleDeleteResponse::Condition::Operator] The operator to be used in the rule.
134
+ #
135
+ # @param value [String] The value of the field to be checked in the rule.
136
+
137
+ # The operator to be used in the rule.
138
+ #
139
+ # @see FinchAPI::Models::HRIS::PayStatementItem::RuleDeleteResponse::Condition#operator
140
+ module Operator
141
+ extend FinchAPI::Internal::Type::Enum
142
+
143
+ EQUALS = :equals
144
+
145
+ # @!method self.values
146
+ # @return [Array<Symbol>]
147
+ end
148
+ end
149
+
150
+ # The entity type to which the rule is applied.
151
+ #
152
+ # @see FinchAPI::Models::HRIS::PayStatementItem::RuleDeleteResponse#entity_type
153
+ module EntityType
154
+ extend FinchAPI::Internal::Type::Enum
155
+
156
+ PAY_STATEMENT_ITEM = :pay_statement_item
157
+
158
+ # @!method self.values
159
+ # @return [Array<Symbol>]
160
+ end
161
+ end
162
+ end
163
+ end
164
+ end
165
+ end
@@ -0,0 +1,26 @@
1
+ # frozen_string_literal: true
2
+
3
+ module FinchAPI
4
+ module Models
5
+ module HRIS
6
+ module PayStatementItem
7
+ # @see FinchAPI::Resources::HRIS::PayStatementItem::Rules#list
8
+ class RuleListParams < FinchAPI::Internal::Type::BaseModel
9
+ extend FinchAPI::Internal::Type::RequestParameters::Converter
10
+ include FinchAPI::Internal::Type::RequestParameters
11
+
12
+ # @!attribute entity_ids
13
+ # The entity IDs to retrieve rules for.
14
+ #
15
+ # @return [Array<String>, nil]
16
+ optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String]
17
+
18
+ # @!method initialize(entity_ids: nil, request_options: {})
19
+ # @param entity_ids [Array<String>] The entity IDs to retrieve rules for.
20
+ #
21
+ # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
22
+ end
23
+ end
24
+ end
25
+ end
26
+ end