finch-api 0.1.0.pre.alpha.43 → 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 (90) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +16 -0
  3. data/README.md +1 -1
  4. data/lib/finch_api/models/hris/{pay_statement_response_body.rb → pay_statement_data.rb} +5 -5
  5. data/lib/finch_api/models/hris/pay_statement_item/rule_create_params.rb +133 -0
  6. data/lib/finch_api/models/hris/pay_statement_item/rule_create_response.rb +157 -0
  7. data/lib/finch_api/models/hris/pay_statement_item/rule_delete_params.rb +33 -0
  8. data/lib/finch_api/models/hris/pay_statement_item/rule_delete_response.rb +165 -0
  9. data/lib/finch_api/models/hris/pay_statement_item/rule_list_params.rb +26 -0
  10. data/lib/finch_api/models/hris/pay_statement_item/rule_list_response.rb +156 -0
  11. data/lib/finch_api/models/hris/pay_statement_item/rule_update_params.rb +40 -0
  12. data/lib/finch_api/models/hris/pay_statement_item/rule_update_response.rb +157 -0
  13. data/lib/finch_api/models/hris/pay_statement_item_list_params.rb +83 -0
  14. data/lib/finch_api/models/hris/pay_statement_item_list_response.rb +97 -0
  15. data/lib/finch_api/models/hris/pay_statement_response.rb +4 -4
  16. data/lib/finch_api/resources/hris/company.rb +0 -4
  17. data/lib/finch_api/resources/hris/pay_statement_item/rules.rb +141 -0
  18. data/lib/finch_api/resources/hris/pay_statement_item.rb +59 -0
  19. data/lib/finch_api/resources/hris.rb +4 -0
  20. data/lib/finch_api/version.rb +1 -1
  21. data/lib/finch_api.rb +13 -13
  22. data/rbi/finch_api/models/hris/{pay_statement_response_body.rbi → pay_statement_data.rbi} +7 -12
  23. data/rbi/finch_api/models/hris/pay_statement_item/rule_create_params.rbi +315 -0
  24. data/rbi/finch_api/models/hris/pay_statement_item/rule_create_response.rbi +342 -0
  25. data/rbi/finch_api/models/hris/pay_statement_item/rule_delete_params.rbi +59 -0
  26. data/rbi/finch_api/models/hris/pay_statement_item/rule_delete_response.rbi +353 -0
  27. data/rbi/finch_api/models/hris/pay_statement_item/rule_list_params.rbi +53 -0
  28. data/rbi/finch_api/models/hris/pay_statement_item/rule_list_response.rbi +342 -0
  29. data/rbi/finch_api/models/hris/pay_statement_item/rule_update_params.rbi +68 -0
  30. data/rbi/finch_api/models/hris/pay_statement_item/rule_update_response.rbi +342 -0
  31. data/rbi/finch_api/models/hris/pay_statement_item_list_params.rbi +177 -0
  32. data/rbi/finch_api/models/hris/pay_statement_item_list_response.rbi +189 -0
  33. data/rbi/finch_api/models/hris/pay_statement_response.rbi +2 -2
  34. data/rbi/finch_api/resources/hris/company.rbi +0 -3
  35. data/rbi/finch_api/resources/hris/pay_statement_item/rules.rbi +114 -0
  36. data/rbi/finch_api/resources/hris/pay_statement_item.rbi +57 -0
  37. data/rbi/finch_api/resources/hris.rbi +3 -0
  38. data/sig/finch_api/models/hris/{pay_statement_response_body.rbs → pay_statement_data.rbs} +6 -6
  39. data/sig/finch_api/models/hris/pay_statement_item/rule_create_params.rbs +136 -0
  40. data/sig/finch_api/models/hris/pay_statement_item/rule_create_response.rbs +151 -0
  41. data/sig/finch_api/models/hris/pay_statement_item/rule_delete_params.rbs +34 -0
  42. data/sig/finch_api/models/hris/pay_statement_item/rule_delete_response.rbs +158 -0
  43. data/sig/finch_api/models/hris/pay_statement_item/rule_list_params.rbs +30 -0
  44. data/sig/finch_api/models/hris/pay_statement_item/rule_list_response.rbs +151 -0
  45. data/sig/finch_api/models/hris/pay_statement_item/rule_update_params.rbs +44 -0
  46. data/sig/finch_api/models/hris/pay_statement_item/rule_update_response.rbs +151 -0
  47. data/sig/finch_api/models/hris/pay_statement_item_list_params.rbs +81 -0
  48. data/sig/finch_api/models/hris/pay_statement_item_list_response.rbs +78 -0
  49. data/sig/finch_api/models/hris/pay_statement_response.rbs +1 -1
  50. data/sig/finch_api/resources/hris/company.rbs +0 -2
  51. data/sig/finch_api/resources/hris/pay_statement_item/rules.rbs +39 -0
  52. data/sig/finch_api/resources/hris/pay_statement_item.rbs +21 -0
  53. data/sig/finch_api/resources/hris.rbs +2 -0
  54. metadata +41 -41
  55. data/lib/finch_api/models/hris/company/pay_statement_item/rule_create_params.rb +0 -137
  56. data/lib/finch_api/models/hris/company/pay_statement_item/rule_create_response.rb +0 -160
  57. data/lib/finch_api/models/hris/company/pay_statement_item/rule_delete_params.rb +0 -35
  58. data/lib/finch_api/models/hris/company/pay_statement_item/rule_delete_response.rb +0 -168
  59. data/lib/finch_api/models/hris/company/pay_statement_item/rule_list_params.rb +0 -28
  60. data/lib/finch_api/models/hris/company/pay_statement_item/rule_list_response.rb +0 -160
  61. data/lib/finch_api/models/hris/company/pay_statement_item/rule_update_params.rb +0 -42
  62. data/lib/finch_api/models/hris/company/pay_statement_item/rule_update_response.rb +0 -160
  63. data/lib/finch_api/models/hris/company/pay_statement_item_list_params.rb +0 -85
  64. data/lib/finch_api/models/hris/company/pay_statement_item_list_response.rb +0 -99
  65. data/lib/finch_api/resources/hris/company/pay_statement_item/rules.rb +0 -144
  66. data/lib/finch_api/resources/hris/company/pay_statement_item.rb +0 -61
  67. data/rbi/finch_api/models/hris/company/pay_statement_item/rule_create_params.rbi +0 -319
  68. data/rbi/finch_api/models/hris/company/pay_statement_item/rule_create_response.rbi +0 -346
  69. data/rbi/finch_api/models/hris/company/pay_statement_item/rule_delete_params.rbi +0 -61
  70. data/rbi/finch_api/models/hris/company/pay_statement_item/rule_delete_response.rbi +0 -357
  71. data/rbi/finch_api/models/hris/company/pay_statement_item/rule_list_params.rbi +0 -55
  72. data/rbi/finch_api/models/hris/company/pay_statement_item/rule_list_response.rbi +0 -346
  73. data/rbi/finch_api/models/hris/company/pay_statement_item/rule_update_params.rbi +0 -70
  74. data/rbi/finch_api/models/hris/company/pay_statement_item/rule_update_response.rbi +0 -346
  75. data/rbi/finch_api/models/hris/company/pay_statement_item_list_params.rbi +0 -179
  76. data/rbi/finch_api/models/hris/company/pay_statement_item_list_response.rbi +0 -191
  77. data/rbi/finch_api/resources/hris/company/pay_statement_item/rules.rbi +0 -116
  78. data/rbi/finch_api/resources/hris/company/pay_statement_item.rbi +0 -61
  79. data/sig/finch_api/models/hris/company/pay_statement_item/rule_create_params.rbs +0 -138
  80. data/sig/finch_api/models/hris/company/pay_statement_item/rule_create_response.rbs +0 -153
  81. data/sig/finch_api/models/hris/company/pay_statement_item/rule_delete_params.rbs +0 -36
  82. data/sig/finch_api/models/hris/company/pay_statement_item/rule_delete_response.rbs +0 -160
  83. data/sig/finch_api/models/hris/company/pay_statement_item/rule_list_params.rbs +0 -32
  84. data/sig/finch_api/models/hris/company/pay_statement_item/rule_list_response.rbs +0 -153
  85. data/sig/finch_api/models/hris/company/pay_statement_item/rule_update_params.rbs +0 -46
  86. data/sig/finch_api/models/hris/company/pay_statement_item/rule_update_response.rbs +0 -153
  87. data/sig/finch_api/models/hris/company/pay_statement_item_list_params.rbs +0 -83
  88. data/sig/finch_api/models/hris/company/pay_statement_item_list_response.rbs +0 -80
  89. data/sig/finch_api/resources/hris/company/pay_statement_item/rules.rbs +0 -41
  90. data/sig/finch_api/resources/hris/company/pay_statement_item.rbs +0 -23
@@ -1,168 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module FinchAPI
4
- module Models
5
- module HRIS
6
- module Company
7
- module PayStatementItem
8
- # @see FinchAPI::Resources::HRIS::Company::PayStatementItem::Rules#delete
9
- class RuleDeleteResponse < FinchAPI::Internal::Type::BaseModel
10
- # @!attribute id
11
- # Finch id (uuidv4) for the rule.
12
- #
13
- # @return [String, nil]
14
- optional :id, String
15
-
16
- # @!attribute attributes
17
- # Specifies the fields to be applied when the condition is met.
18
- #
19
- # @return [FinchAPI::Models::HRIS::Company::PayStatementItem::RuleDeleteResponse::Attributes, nil]
20
- optional :attributes,
21
- -> { FinchAPI::Models::HRIS::Company::PayStatementItem::RuleDeleteResponse::Attributes }
22
-
23
- # @!attribute conditions
24
- #
25
- # @return [Array<FinchAPI::Models::HRIS::Company::PayStatementItem::RuleDeleteResponse::Condition>, nil]
26
- optional :conditions,
27
- -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Models::HRIS::Company::PayStatementItem::RuleDeleteResponse::Condition] }
28
-
29
- # @!attribute created_at
30
- # The datetime when the rule was created.
31
- #
32
- # @return [Time, nil]
33
- optional :created_at, Time
34
-
35
- # @!attribute deleted_at
36
- # The datetime when the rule was deleted.
37
- #
38
- # @return [Time, nil]
39
- optional :deleted_at, Time
40
-
41
- # @!attribute effective_end_date
42
- # Specifies when the rules should stop applying rules based on the date.
43
- #
44
- # @return [String, nil]
45
- optional :effective_end_date, String, nil?: true
46
-
47
- # @!attribute effective_start_date
48
- # Specifies when the rule should begin applying based on the date.
49
- #
50
- # @return [String, nil]
51
- optional :effective_start_date, String, nil?: true
52
-
53
- # @!attribute entity_type
54
- # The entity type to which the rule is applied.
55
- #
56
- # @return [Symbol, FinchAPI::Models::HRIS::Company::PayStatementItem::RuleDeleteResponse::EntityType, nil]
57
- optional :entity_type,
58
- enum: -> { FinchAPI::Models::HRIS::Company::PayStatementItem::RuleDeleteResponse::EntityType }
59
-
60
- # @!attribute priority
61
- # The priority of the rule.
62
- #
63
- # @return [Integer, nil]
64
- optional :priority, Integer
65
-
66
- # @!attribute updated_at
67
- # The datetime when the rule was last updated.
68
- #
69
- # @return [Time, nil]
70
- optional :updated_at, Time
71
-
72
- # @!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)
73
- # @param id [String] Finch id (uuidv4) for the rule.
74
- #
75
- # @param attributes [FinchAPI::Models::HRIS::Company::PayStatementItem::RuleDeleteResponse::Attributes] Specifies the fields to be applied when the condition is met.
76
- #
77
- # @param conditions [Array<FinchAPI::Models::HRIS::Company::PayStatementItem::RuleDeleteResponse::Condition>]
78
- #
79
- # @param created_at [Time] The datetime when the rule was created.
80
- #
81
- # @param deleted_at [Time] The datetime when the rule was deleted.
82
- #
83
- # @param effective_end_date [String, nil] Specifies when the rules should stop applying rules based on the date.
84
- #
85
- # @param effective_start_date [String, nil] Specifies when the rule should begin applying based on the date.
86
- #
87
- # @param entity_type [Symbol, FinchAPI::Models::HRIS::Company::PayStatementItem::RuleDeleteResponse::EntityType] The entity type to which the rule is applied.
88
- #
89
- # @param priority [Integer] The priority of the rule.
90
- #
91
- # @param updated_at [Time] The datetime when the rule was last updated.
92
-
93
- # @see FinchAPI::Models::HRIS::Company::PayStatementItem::RuleDeleteResponse#attributes
94
- class Attributes < FinchAPI::Internal::Type::BaseModel
95
- # @!attribute metadata
96
- # The metadata to be attached in the entity. It is a key-value pairs where the
97
- # values can be of any type (string, number, boolean, object, array, etc.).
98
- #
99
- # @return [Hash{Symbol=>Object}, nil]
100
- optional :metadata, FinchAPI::Internal::Type::HashOf[FinchAPI::Internal::Type::Unknown]
101
-
102
- # @!method initialize(metadata: nil)
103
- # Some parameter documentations has been truncated, see
104
- # {FinchAPI::Models::HRIS::Company::PayStatementItem::RuleDeleteResponse::Attributes}
105
- # for more details.
106
- #
107
- # Specifies the fields to be applied when the condition is met.
108
- #
109
- # @param metadata [Hash{Symbol=>Object}] The metadata to be attached in the entity. It is a key-value pairs where the val
110
- end
111
-
112
- class Condition < FinchAPI::Internal::Type::BaseModel
113
- # @!attribute field
114
- # The field to be checked in the rule.
115
- #
116
- # @return [String, nil]
117
- optional :field, String
118
-
119
- # @!attribute operator
120
- # The operator to be used in the rule.
121
- #
122
- # @return [Symbol, FinchAPI::Models::HRIS::Company::PayStatementItem::RuleDeleteResponse::Condition::Operator, nil]
123
- optional :operator,
124
- enum: -> { FinchAPI::Models::HRIS::Company::PayStatementItem::RuleDeleteResponse::Condition::Operator }
125
-
126
- # @!attribute value
127
- # The value of the field to be checked in the rule.
128
- #
129
- # @return [String, nil]
130
- optional :value, String
131
-
132
- # @!method initialize(field: nil, operator: nil, value: nil)
133
- # @param field [String] The field to be checked in the rule.
134
- #
135
- # @param operator [Symbol, FinchAPI::Models::HRIS::Company::PayStatementItem::RuleDeleteResponse::Condition::Operator] The operator to be used in the rule.
136
- #
137
- # @param value [String] The value of the field to be checked in the rule.
138
-
139
- # The operator to be used in the rule.
140
- #
141
- # @see FinchAPI::Models::HRIS::Company::PayStatementItem::RuleDeleteResponse::Condition#operator
142
- module Operator
143
- extend FinchAPI::Internal::Type::Enum
144
-
145
- EQUALS = :equals
146
-
147
- # @!method self.values
148
- # @return [Array<Symbol>]
149
- end
150
- end
151
-
152
- # The entity type to which the rule is applied.
153
- #
154
- # @see FinchAPI::Models::HRIS::Company::PayStatementItem::RuleDeleteResponse#entity_type
155
- module EntityType
156
- extend FinchAPI::Internal::Type::Enum
157
-
158
- PAY_STATEMENT_ITEM = :pay_statement_item
159
-
160
- # @!method self.values
161
- # @return [Array<Symbol>]
162
- end
163
- end
164
- end
165
- end
166
- end
167
- end
168
- end
@@ -1,28 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module FinchAPI
4
- module Models
5
- module HRIS
6
- module Company
7
- module PayStatementItem
8
- # @see FinchAPI::Resources::HRIS::Company::PayStatementItem::Rules#list
9
- class RuleListParams < FinchAPI::Internal::Type::BaseModel
10
- extend FinchAPI::Internal::Type::RequestParameters::Converter
11
- include FinchAPI::Internal::Type::RequestParameters
12
-
13
- # @!attribute entity_ids
14
- # The entity IDs to retrieve rules for.
15
- #
16
- # @return [Array<String>, nil]
17
- optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String]
18
-
19
- # @!method initialize(entity_ids: nil, request_options: {})
20
- # @param entity_ids [Array<String>] The entity IDs to retrieve rules for.
21
- #
22
- # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
23
- end
24
- end
25
- end
26
- end
27
- end
28
- end
@@ -1,160 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module FinchAPI
4
- module Models
5
- module HRIS
6
- module Company
7
- module PayStatementItem
8
- # @see FinchAPI::Resources::HRIS::Company::PayStatementItem::Rules#list
9
- class RuleListResponse < FinchAPI::Internal::Type::BaseModel
10
- # @!attribute id
11
- # Finch id (uuidv4) for the rule.
12
- #
13
- # @return [String, nil]
14
- optional :id, String
15
-
16
- # @!attribute attributes
17
- # Specifies the fields to be applied when the condition is met.
18
- #
19
- # @return [FinchAPI::Models::HRIS::Company::PayStatementItem::RuleListResponse::Attributes, nil]
20
- optional :attributes,
21
- -> { FinchAPI::Models::HRIS::Company::PayStatementItem::RuleListResponse::Attributes }
22
-
23
- # @!attribute conditions
24
- #
25
- # @return [Array<FinchAPI::Models::HRIS::Company::PayStatementItem::RuleListResponse::Condition>, nil]
26
- optional :conditions,
27
- -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Models::HRIS::Company::PayStatementItem::RuleListResponse::Condition] }
28
-
29
- # @!attribute created_at
30
- # The datetime when the rule was created.
31
- #
32
- # @return [Time, nil]
33
- optional :created_at, Time
34
-
35
- # @!attribute effective_end_date
36
- # Specifies when the rules should stop applying rules based on the date.
37
- #
38
- # @return [String, nil]
39
- optional :effective_end_date, String, nil?: true
40
-
41
- # @!attribute effective_start_date
42
- # Specifies when the rule should begin applying based on the date.
43
- #
44
- # @return [String, nil]
45
- optional :effective_start_date, String, nil?: true
46
-
47
- # @!attribute entity_type
48
- # The entity type to which the rule is applied.
49
- #
50
- # @return [Symbol, FinchAPI::Models::HRIS::Company::PayStatementItem::RuleListResponse::EntityType, nil]
51
- optional :entity_type,
52
- enum: -> { FinchAPI::Models::HRIS::Company::PayStatementItem::RuleListResponse::EntityType }
53
-
54
- # @!attribute priority
55
- # The priority of the rule.
56
- #
57
- # @return [Integer, nil]
58
- optional :priority, Integer
59
-
60
- # @!attribute updated_at
61
- # The datetime when the rule was last updated.
62
- #
63
- # @return [Time, nil]
64
- optional :updated_at, Time
65
-
66
- # @!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)
67
- # @param id [String] Finch id (uuidv4) for the rule.
68
- #
69
- # @param attributes [FinchAPI::Models::HRIS::Company::PayStatementItem::RuleListResponse::Attributes] Specifies the fields to be applied when the condition is met.
70
- #
71
- # @param conditions [Array<FinchAPI::Models::HRIS::Company::PayStatementItem::RuleListResponse::Condition>]
72
- #
73
- # @param created_at [Time] The datetime when the rule was created.
74
- #
75
- # @param effective_end_date [String, nil] Specifies when the rules should stop applying rules based on the date.
76
- #
77
- # @param effective_start_date [String, nil] Specifies when the rule should begin applying based on the date.
78
- #
79
- # @param entity_type [Symbol, FinchAPI::Models::HRIS::Company::PayStatementItem::RuleListResponse::EntityType] The entity type to which the rule is applied.
80
- #
81
- # @param priority [Integer] The priority of the rule.
82
- #
83
- # @param updated_at [Time] The datetime when the rule was last updated.
84
-
85
- # @see FinchAPI::Models::HRIS::Company::PayStatementItem::RuleListResponse#attributes
86
- class Attributes < FinchAPI::Internal::Type::BaseModel
87
- # @!attribute metadata
88
- # The metadata to be attached in the entity. It is a key-value pairs where the
89
- # values can be of any type (string, number, boolean, object, array, etc.).
90
- #
91
- # @return [Hash{Symbol=>Object}, nil]
92
- optional :metadata, FinchAPI::Internal::Type::HashOf[FinchAPI::Internal::Type::Unknown]
93
-
94
- # @!method initialize(metadata: nil)
95
- # Some parameter documentations has been truncated, see
96
- # {FinchAPI::Models::HRIS::Company::PayStatementItem::RuleListResponse::Attributes}
97
- # for more details.
98
- #
99
- # Specifies the fields to be applied when the condition is met.
100
- #
101
- # @param metadata [Hash{Symbol=>Object}] The metadata to be attached in the entity. It is a key-value pairs where the val
102
- end
103
-
104
- class Condition < FinchAPI::Internal::Type::BaseModel
105
- # @!attribute field
106
- # The field to be checked in the rule.
107
- #
108
- # @return [String, nil]
109
- optional :field, String
110
-
111
- # @!attribute operator
112
- # The operator to be used in the rule.
113
- #
114
- # @return [Symbol, FinchAPI::Models::HRIS::Company::PayStatementItem::RuleListResponse::Condition::Operator, nil]
115
- optional :operator,
116
- enum: -> { FinchAPI::Models::HRIS::Company::PayStatementItem::RuleListResponse::Condition::Operator }
117
-
118
- # @!attribute value
119
- # The value of the field to be checked in the rule.
120
- #
121
- # @return [String, nil]
122
- optional :value, String
123
-
124
- # @!method initialize(field: nil, operator: nil, value: nil)
125
- # @param field [String] The field to be checked in the rule.
126
- #
127
- # @param operator [Symbol, FinchAPI::Models::HRIS::Company::PayStatementItem::RuleListResponse::Condition::Operator] The operator to be used in the rule.
128
- #
129
- # @param value [String] The value of the field to be checked in the rule.
130
-
131
- # The operator to be used in the rule.
132
- #
133
- # @see FinchAPI::Models::HRIS::Company::PayStatementItem::RuleListResponse::Condition#operator
134
- module Operator
135
- extend FinchAPI::Internal::Type::Enum
136
-
137
- EQUALS = :equals
138
-
139
- # @!method self.values
140
- # @return [Array<Symbol>]
141
- end
142
- end
143
-
144
- # The entity type to which the rule is applied.
145
- #
146
- # @see FinchAPI::Models::HRIS::Company::PayStatementItem::RuleListResponse#entity_type
147
- module EntityType
148
- extend FinchAPI::Internal::Type::Enum
149
-
150
- PAY_STATEMENT_ITEM = :pay_statement_item
151
-
152
- # @!method self.values
153
- # @return [Array<Symbol>]
154
- end
155
- end
156
- end
157
- end
158
- end
159
- end
160
- end
@@ -1,42 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module FinchAPI
4
- module Models
5
- module HRIS
6
- module Company
7
- module PayStatementItem
8
- # @see FinchAPI::Resources::HRIS::Company::PayStatementItem::Rules#update
9
- class RuleUpdateParams < FinchAPI::Internal::Type::BaseModel
10
- extend FinchAPI::Internal::Type::RequestParameters::Converter
11
- include FinchAPI::Internal::Type::RequestParameters
12
-
13
- # @!attribute rule_id
14
- #
15
- # @return [String]
16
- required :rule_id, String
17
-
18
- # @!attribute entity_ids
19
- # The entity IDs to update the rule for.
20
- #
21
- # @return [Array<String>, nil]
22
- optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String]
23
-
24
- # @!attribute optional_property
25
- #
26
- # @return [Object, nil]
27
- optional :optional_property, FinchAPI::Internal::Type::Unknown, api_name: :optionalProperty
28
-
29
- # @!method initialize(rule_id:, entity_ids: nil, optional_property: nil, request_options: {})
30
- # @param rule_id [String]
31
- #
32
- # @param entity_ids [Array<String>] The entity IDs to update the rule for.
33
- #
34
- # @param optional_property [Object]
35
- #
36
- # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
37
- end
38
- end
39
- end
40
- end
41
- end
42
- end
@@ -1,160 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module FinchAPI
4
- module Models
5
- module HRIS
6
- module Company
7
- module PayStatementItem
8
- # @see FinchAPI::Resources::HRIS::Company::PayStatementItem::Rules#update
9
- class RuleUpdateResponse < FinchAPI::Internal::Type::BaseModel
10
- # @!attribute id
11
- # Finch id (uuidv4) for the rule.
12
- #
13
- # @return [String, nil]
14
- optional :id, String
15
-
16
- # @!attribute attributes
17
- # Specifies the fields to be applied when the condition is met.
18
- #
19
- # @return [FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::Attributes, nil]
20
- optional :attributes,
21
- -> { FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::Attributes }
22
-
23
- # @!attribute conditions
24
- #
25
- # @return [Array<FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::Condition>, nil]
26
- optional :conditions,
27
- -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::Condition] }
28
-
29
- # @!attribute created_at
30
- # The datetime when the rule was created.
31
- #
32
- # @return [Time, nil]
33
- optional :created_at, Time
34
-
35
- # @!attribute effective_end_date
36
- # Specifies when the rules should stop applying rules based on the date.
37
- #
38
- # @return [String, nil]
39
- optional :effective_end_date, String, nil?: true
40
-
41
- # @!attribute effective_start_date
42
- # Specifies when the rule should begin applying based on the date.
43
- #
44
- # @return [String, nil]
45
- optional :effective_start_date, String, nil?: true
46
-
47
- # @!attribute entity_type
48
- # The entity type to which the rule is applied.
49
- #
50
- # @return [Symbol, FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::EntityType, nil]
51
- optional :entity_type,
52
- enum: -> { FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::EntityType }
53
-
54
- # @!attribute priority
55
- # The priority of the rule.
56
- #
57
- # @return [Integer, nil]
58
- optional :priority, Integer
59
-
60
- # @!attribute updated_at
61
- # The datetime when the rule was last updated.
62
- #
63
- # @return [Time, nil]
64
- optional :updated_at, Time
65
-
66
- # @!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)
67
- # @param id [String] Finch id (uuidv4) for the rule.
68
- #
69
- # @param attributes [FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::Attributes] Specifies the fields to be applied when the condition is met.
70
- #
71
- # @param conditions [Array<FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::Condition>]
72
- #
73
- # @param created_at [Time] The datetime when the rule was created.
74
- #
75
- # @param effective_end_date [String, nil] Specifies when the rules should stop applying rules based on the date.
76
- #
77
- # @param effective_start_date [String, nil] Specifies when the rule should begin applying based on the date.
78
- #
79
- # @param entity_type [Symbol, FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::EntityType] The entity type to which the rule is applied.
80
- #
81
- # @param priority [Integer] The priority of the rule.
82
- #
83
- # @param updated_at [Time] The datetime when the rule was last updated.
84
-
85
- # @see FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse#attributes
86
- class Attributes < FinchAPI::Internal::Type::BaseModel
87
- # @!attribute metadata
88
- # The metadata to be attached in the entity. It is a key-value pairs where the
89
- # values can be of any type (string, number, boolean, object, array, etc.).
90
- #
91
- # @return [Hash{Symbol=>Object}, nil]
92
- optional :metadata, FinchAPI::Internal::Type::HashOf[FinchAPI::Internal::Type::Unknown]
93
-
94
- # @!method initialize(metadata: nil)
95
- # Some parameter documentations has been truncated, see
96
- # {FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::Attributes}
97
- # for more details.
98
- #
99
- # Specifies the fields to be applied when the condition is met.
100
- #
101
- # @param metadata [Hash{Symbol=>Object}] The metadata to be attached in the entity. It is a key-value pairs where the val
102
- end
103
-
104
- class Condition < FinchAPI::Internal::Type::BaseModel
105
- # @!attribute field
106
- # The field to be checked in the rule.
107
- #
108
- # @return [String, nil]
109
- optional :field, String
110
-
111
- # @!attribute operator
112
- # The operator to be used in the rule.
113
- #
114
- # @return [Symbol, FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::Condition::Operator, nil]
115
- optional :operator,
116
- enum: -> { FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::Condition::Operator }
117
-
118
- # @!attribute value
119
- # The value of the field to be checked in the rule.
120
- #
121
- # @return [String, nil]
122
- optional :value, String
123
-
124
- # @!method initialize(field: nil, operator: nil, value: nil)
125
- # @param field [String] The field to be checked in the rule.
126
- #
127
- # @param operator [Symbol, FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::Condition::Operator] The operator to be used in the rule.
128
- #
129
- # @param value [String] The value of the field to be checked in the rule.
130
-
131
- # The operator to be used in the rule.
132
- #
133
- # @see FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::Condition#operator
134
- module Operator
135
- extend FinchAPI::Internal::Type::Enum
136
-
137
- EQUALS = :equals
138
-
139
- # @!method self.values
140
- # @return [Array<Symbol>]
141
- end
142
- end
143
-
144
- # The entity type to which the rule is applied.
145
- #
146
- # @see FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse#entity_type
147
- module EntityType
148
- extend FinchAPI::Internal::Type::Enum
149
-
150
- PAY_STATEMENT_ITEM = :pay_statement_item
151
-
152
- # @!method self.values
153
- # @return [Array<Symbol>]
154
- end
155
- end
156
- end
157
- end
158
- end
159
- end
160
- end
@@ -1,85 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module FinchAPI
4
- module Models
5
- module HRIS
6
- module Company
7
- # @see FinchAPI::Resources::HRIS::Company::PayStatementItem#list
8
- class PayStatementItemListParams < FinchAPI::Internal::Type::BaseModel
9
- extend FinchAPI::Internal::Type::RequestParameters::Converter
10
- include FinchAPI::Internal::Type::RequestParameters
11
-
12
- # @!attribute categories
13
- # Comma-delimited list of pay statement item categories to filter on. If empty,
14
- # defaults to all categories.
15
- #
16
- # @return [Array<Symbol, FinchAPI::Models::HRIS::Company::PayStatementItemListParams::Category>, nil]
17
- optional :categories,
18
- -> { FinchAPI::Internal::Type::ArrayOf[enum: FinchAPI::HRIS::Company::PayStatementItemListParams::Category] }
19
-
20
- # @!attribute end_date
21
- # The end date to retrieve pay statement items by via their last seen pay date in
22
- # `YYYY-MM-DD` format.
23
- #
24
- # @return [Date, nil]
25
- optional :end_date, Date
26
-
27
- # @!attribute entity_ids
28
- # The entity IDs to specify which entities' data to access.
29
- #
30
- # @return [Array<String>, nil]
31
- optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String]
32
-
33
- # @!attribute name
34
- # Case-insensitive partial match search by pay statement item name.
35
- #
36
- # @return [String, nil]
37
- optional :name, String
38
-
39
- # @!attribute start_date
40
- # The start date to retrieve pay statement items by via their last seen pay date
41
- # (inclusive) in `YYYY-MM-DD` format.
42
- #
43
- # @return [Date, nil]
44
- optional :start_date, Date
45
-
46
- # @!attribute type
47
- # String search by pay statement item type.
48
- #
49
- # @return [String, nil]
50
- optional :type, String
51
-
52
- # @!method initialize(categories: nil, end_date: nil, entity_ids: nil, name: nil, start_date: nil, type: nil, request_options: {})
53
- # Some parameter documentations has been truncated, see
54
- # {FinchAPI::Models::HRIS::Company::PayStatementItemListParams} for more details.
55
- #
56
- # @param categories [Array<Symbol, FinchAPI::Models::HRIS::Company::PayStatementItemListParams::Category>] Comma-delimited list of pay statement item categories to filter on. If empty, de
57
- #
58
- # @param end_date [Date] The end date to retrieve pay statement items by via their last seen pay date in
59
- #
60
- # @param entity_ids [Array<String>] The entity IDs to specify which entities' data to access.
61
- #
62
- # @param name [String] Case-insensitive partial match search by pay statement item name.
63
- #
64
- # @param start_date [Date] The start date to retrieve pay statement items by via their last seen pay date (
65
- #
66
- # @param type [String] String search by pay statement item type.
67
- #
68
- # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
69
-
70
- module Category
71
- extend FinchAPI::Internal::Type::Enum
72
-
73
- EARNINGS = :earnings
74
- TAXES = :taxes
75
- EMPLOYEE_DEDUCTIONS = :employee_deductions
76
- EMPLOYER_CONTRIBUTIONS = :employer_contributions
77
-
78
- # @!method self.values
79
- # @return [Array<Symbol>]
80
- end
81
- end
82
- end
83
- end
84
- end
85
- end