Skip to content

Commit 9ef0063

Browse files
feat(api): api update
1 parent ed1ac81 commit 9ef0063

File tree

6 files changed

+143
-65
lines changed

6 files changed

+143
-65
lines changed

.stats.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
configured_endpoints: 46
2-
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/finch%2Ffinch-6190639c909b62f2e182a32dc56a80a87ca470e8970efd6ce8d3d7bd659d237c.yml
3-
openapi_spec_hash: c4078fa61a4ab0b480a2c7b40e495104
2+
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/finch%2Ffinch-970ab04a97244c68824c0c52e06925cba14fb7dbfc36c03167c1afe74cd1b150.yml
3+
openapi_spec_hash: 315e7859c3f77311261fb824b74a8247
44
config_hash: f2846563903bf75ab0858872154df0f7

lib/finch_api/models/hris/benefits/individual_benefit.rb

Lines changed: 68 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,9 @@ class UnionMember0 < FinchAPI::Internal::Type::BaseModel
4949
required :catch_up, FinchAPI::Internal::Type::Boolean, nil?: true
5050

5151
# @!attribute company_contribution
52+
# Company contribution configuration. Supports fixed amounts (in cents),
53+
# percentage-based contributions (in basis points where 100 = 1%), or tiered
54+
# matching structures.
5255
#
5356
# @return [FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::UnionMember0::CompanyContribution::UnionMember0, FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::UnionMember0::CompanyContribution::UnionMember1, FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::UnionMember0::CompanyContribution::UnionMember2, nil]
5457
required :company_contribution,
@@ -58,6 +61,8 @@ class UnionMember0 < FinchAPI::Internal::Type::BaseModel
5861
nil?: true
5962

6063
# @!attribute employee_deduction
64+
# Employee deduction configuration. Supports both fixed amounts (in cents) and
65+
# percentage-based contributions (in basis points where 100 = 1%).
6166
#
6267
# @return [FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::UnionMember0::EmployeeDeduction::UnionMember0, FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::UnionMember0::EmployeeDeduction::UnionMember1, nil]
6368
required :employee_deduction,
@@ -85,12 +90,16 @@ class UnionMember0 < FinchAPI::Internal::Type::BaseModel
8590
#
8691
# @param catch_up [Boolean, nil] If the benefit supports catch up (401k, 403b, etc.), whether catch up is enabled
8792
#
88-
# @param company_contribution [FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::UnionMember0::CompanyContribution::UnionMember0, FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::UnionMember0::CompanyContribution::UnionMember1, FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::UnionMember0::CompanyContribution::UnionMember2, nil]
93+
# @param company_contribution [FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::UnionMember0::CompanyContribution::UnionMember0, FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::UnionMember0::CompanyContribution::UnionMember1, FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::UnionMember0::CompanyContribution::UnionMember2, nil] Company contribution configuration. Supports fixed amounts (in cents), percentag
8994
#
90-
# @param employee_deduction [FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::UnionMember0::EmployeeDeduction::UnionMember0, FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::UnionMember0::EmployeeDeduction::UnionMember1, nil]
95+
# @param employee_deduction [FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::UnionMember0::EmployeeDeduction::UnionMember0, FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::UnionMember0::EmployeeDeduction::UnionMember1, nil] Employee deduction configuration. Supports both fixed amounts (in cents) and per
9196
#
9297
# @param hsa_contribution_limit [Symbol, FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::UnionMember0::HsaContributionLimit, nil] Type for HSA contribution limit if the benefit is a HSA.
9398

99+
# Company contribution configuration. Supports fixed amounts (in cents),
100+
# percentage-based contributions (in basis points where 100 = 1%), or tiered
101+
# matching structures.
102+
#
94103
# @see FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::UnionMember0#company_contribution
95104
module CompanyContribution
96105
extend FinchAPI::Internal::Type::Union
@@ -103,24 +112,31 @@ module CompanyContribution
103112

104113
class UnionMember0 < FinchAPI::Internal::Type::BaseModel
105114
# @!attribute amount
106-
# Contribution amount in cents.
115+
# Contribution amount in cents (for type=fixed) or basis points (for type=percent,
116+
# where 100 = 1%). Not used for type=tiered.
107117
#
108118
# @return [Integer]
109119
required :amount, Integer
110120

111121
# @!attribute type
112-
# Fixed contribution type.
122+
# Contribution type. Supported values: "fixed" (amount in cents), "percent"
123+
# (amount in basis points), or "tiered" (multi-tier matching).
113124
#
114125
# @return [Symbol, FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::UnionMember0::CompanyContribution::UnionMember0::Type]
115126
required :type,
116127
enum: -> { FinchAPI::HRIS::Benefits::IndividualBenefit::Body::UnionMember0::CompanyContribution::UnionMember0::Type }
117128

118129
# @!method initialize(amount:, type:)
119-
# @param amount [Integer] Contribution amount in cents.
130+
# Some parameter documentations has been truncated, see
131+
# {FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::UnionMember0::CompanyContribution::UnionMember0}
132+
# for more details.
133+
#
134+
# @param amount [Integer] Contribution amount in cents (for type=fixed) or basis points (for type=percent,
120135
#
121-
# @param type [Symbol, FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::UnionMember0::CompanyContribution::UnionMember0::Type] Fixed contribution type.
136+
# @param type [Symbol, FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::UnionMember0::CompanyContribution::UnionMember0::Type] Contribution type. Supported values: "fixed" (amount in cents), "percent" (amoun
122137

123-
# Fixed contribution type.
138+
# Contribution type. Supported values: "fixed" (amount in cents), "percent"
139+
# (amount in basis points), or "tiered" (multi-tier matching).
124140
#
125141
# @see FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::UnionMember0::CompanyContribution::UnionMember0#type
126142
module Type
@@ -135,24 +151,31 @@ module Type
135151

136152
class UnionMember1 < FinchAPI::Internal::Type::BaseModel
137153
# @!attribute amount
138-
# Contribution amount in basis points (1/100th of a percent).
154+
# Contribution amount in cents (for type=fixed) or basis points (for type=percent,
155+
# where 100 = 1%). Not used for type=tiered.
139156
#
140157
# @return [Integer]
141158
required :amount, Integer
142159

143160
# @!attribute type
144-
# Percentage contribution type.
161+
# Contribution type. Supported values: "fixed" (amount in cents), "percent"
162+
# (amount in basis points), or "tiered" (multi-tier matching).
145163
#
146164
# @return [Symbol, FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::UnionMember0::CompanyContribution::UnionMember1::Type]
147165
required :type,
148166
enum: -> { FinchAPI::HRIS::Benefits::IndividualBenefit::Body::UnionMember0::CompanyContribution::UnionMember1::Type }
149167

150168
# @!method initialize(amount:, type:)
151-
# @param amount [Integer] Contribution amount in basis points (1/100th of a percent).
169+
# Some parameter documentations has been truncated, see
170+
# {FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::UnionMember0::CompanyContribution::UnionMember1}
171+
# for more details.
172+
#
173+
# @param amount [Integer] Contribution amount in cents (for type=fixed) or basis points (for type=percent,
152174
#
153-
# @param type [Symbol, FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::UnionMember0::CompanyContribution::UnionMember1::Type] Percentage contribution type.
175+
# @param type [Symbol, FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::UnionMember0::CompanyContribution::UnionMember1::Type] Contribution type. Supported values: "fixed" (amount in cents), "percent" (amoun
154176

155-
# Percentage contribution type.
177+
# Contribution type. Supported values: "fixed" (amount in cents), "percent"
178+
# (amount in basis points), or "tiered" (multi-tier matching).
156179
#
157180
# @see FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::UnionMember0::CompanyContribution::UnionMember1#type
158181
module Type
@@ -168,14 +191,15 @@ module Type
168191
class UnionMember2 < FinchAPI::Internal::Type::BaseModel
169192
# @!attribute tiers
170193
# Array of tier objects defining employer match tiers based on employee
171-
# contribution thresholds.
194+
# contribution thresholds. Required when type=tiered.
172195
#
173196
# @return [Array<FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::UnionMember0::CompanyContribution::UnionMember2::Tier>]
174197
required :tiers,
175198
-> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::Benefits::IndividualBenefit::Body::UnionMember0::CompanyContribution::UnionMember2::Tier] }
176199

177200
# @!attribute type
178-
# Tiered contribution type (only valid for company_contribution).
201+
# Contribution type. Supported values: "fixed" (amount in cents), "percent"
202+
# (amount in basis points), or "tiered" (multi-tier matching).
179203
#
180204
# @return [Symbol, FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::UnionMember0::CompanyContribution::UnionMember2::Type]
181205
required :type,
@@ -188,7 +212,7 @@ class UnionMember2 < FinchAPI::Internal::Type::BaseModel
188212
#
189213
# @param tiers [Array<FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::UnionMember0::CompanyContribution::UnionMember2::Tier>] Array of tier objects defining employer match tiers based on employee contributi
190214
#
191-
# @param type [Symbol, FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::UnionMember0::CompanyContribution::UnionMember2::Type] Tiered contribution type (only valid for company_contribution).
215+
# @param type [Symbol, FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::UnionMember0::CompanyContribution::UnionMember2::Type] Contribution type. Supported values: "fixed" (amount in cents), "percent" (amoun
192216

193217
class Tier < FinchAPI::Internal::Type::BaseModel
194218
# @!attribute match
@@ -206,7 +230,8 @@ class Tier < FinchAPI::Internal::Type::BaseModel
206230
# @param threshold [Integer]
207231
end
208232

209-
# Tiered contribution type (only valid for company_contribution).
233+
# Contribution type. Supported values: "fixed" (amount in cents), "percent"
234+
# (amount in basis points), or "tiered" (multi-tier matching).
210235
#
211236
# @see FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::UnionMember0::CompanyContribution::UnionMember2#type
212237
module Type
@@ -223,6 +248,9 @@ module Type
223248
# @return [Array(FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::UnionMember0::CompanyContribution::UnionMember0, FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::UnionMember0::CompanyContribution::UnionMember1, FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::UnionMember0::CompanyContribution::UnionMember2)]
224249
end
225250

251+
# Employee deduction configuration. Supports both fixed amounts (in cents) and
252+
# percentage-based contributions (in basis points where 100 = 1%).
253+
#
226254
# @see FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::UnionMember0#employee_deduction
227255
module EmployeeDeduction
228256
extend FinchAPI::Internal::Type::Union
@@ -233,24 +261,31 @@ module EmployeeDeduction
233261

234262
class UnionMember0 < FinchAPI::Internal::Type::BaseModel
235263
# @!attribute amount
236-
# Contribution amount in cents.
264+
# Contribution amount in cents (for type=fixed) or basis points (for type=percent,
265+
# where 100 = 1%).
237266
#
238267
# @return [Integer]
239268
required :amount, Integer
240269

241270
# @!attribute type
242-
# Fixed contribution type.
271+
# Contribution type. Supported values: "fixed" (amount in cents) or "percent"
272+
# (amount in basis points).
243273
#
244274
# @return [Symbol, FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::UnionMember0::EmployeeDeduction::UnionMember0::Type]
245275
required :type,
246276
enum: -> { FinchAPI::HRIS::Benefits::IndividualBenefit::Body::UnionMember0::EmployeeDeduction::UnionMember0::Type }
247277

248278
# @!method initialize(amount:, type:)
249-
# @param amount [Integer] Contribution amount in cents.
279+
# Some parameter documentations has been truncated, see
280+
# {FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::UnionMember0::EmployeeDeduction::UnionMember0}
281+
# for more details.
282+
#
283+
# @param amount [Integer] Contribution amount in cents (for type=fixed) or basis points (for type=percent,
250284
#
251-
# @param type [Symbol, FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::UnionMember0::EmployeeDeduction::UnionMember0::Type] Fixed contribution type.
285+
# @param type [Symbol, FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::UnionMember0::EmployeeDeduction::UnionMember0::Type] Contribution type. Supported values: "fixed" (amount in cents) or "percent" (amo
252286

253-
# Fixed contribution type.
287+
# Contribution type. Supported values: "fixed" (amount in cents) or "percent"
288+
# (amount in basis points).
254289
#
255290
# @see FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::UnionMember0::EmployeeDeduction::UnionMember0#type
256291
module Type
@@ -265,24 +300,31 @@ module Type
265300

266301
class UnionMember1 < FinchAPI::Internal::Type::BaseModel
267302
# @!attribute amount
268-
# Contribution amount in basis points (1/100th of a percent).
303+
# Contribution amount in cents (for type=fixed) or basis points (for type=percent,
304+
# where 100 = 1%).
269305
#
270306
# @return [Integer]
271307
required :amount, Integer
272308

273309
# @!attribute type
274-
# Percentage contribution type.
310+
# Contribution type. Supported values: "fixed" (amount in cents) or "percent"
311+
# (amount in basis points).
275312
#
276313
# @return [Symbol, FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::UnionMember0::EmployeeDeduction::UnionMember1::Type]
277314
required :type,
278315
enum: -> { FinchAPI::HRIS::Benefits::IndividualBenefit::Body::UnionMember0::EmployeeDeduction::UnionMember1::Type }
279316

280317
# @!method initialize(amount:, type:)
281-
# @param amount [Integer] Contribution amount in basis points (1/100th of a percent).
318+
# Some parameter documentations has been truncated, see
319+
# {FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::UnionMember0::EmployeeDeduction::UnionMember1}
320+
# for more details.
321+
#
322+
# @param amount [Integer] Contribution amount in cents (for type=fixed) or basis points (for type=percent,
282323
#
283-
# @param type [Symbol, FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::UnionMember0::EmployeeDeduction::UnionMember1::Type] Percentage contribution type.
324+
# @param type [Symbol, FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::UnionMember0::EmployeeDeduction::UnionMember1::Type] Contribution type. Supported values: "fixed" (amount in cents) or "percent" (amo
284325

285-
# Percentage contribution type.
326+
# Contribution type. Supported values: "fixed" (amount in cents) or "percent"
327+
# (amount in basis points).
286328
#
287329
# @see FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::UnionMember0::EmployeeDeduction::UnionMember1#type
288330
module Type

lib/finch_api/models/request_forwarding_forward_response.rb

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -73,10 +73,8 @@ class Request < FinchAPI::Internal::Type::BaseModel
7373
# @!attribute headers
7474
# The HTTP headers that were specified for the forwarded request.
7575
#
76-
# @return [Hash{Symbol=>Object, nil}, nil]
77-
optional :headers,
78-
FinchAPI::Internal::Type::HashOf[FinchAPI::Internal::Type::Unknown, nil?: true],
79-
nil?: true
76+
# @return [Hash{Symbol=>String}, nil]
77+
optional :headers, FinchAPI::Internal::Type::HashOf[String], nil?: true
8078

8179
# @!attribute params
8280
# The query parameters that were specified for the forwarded request.
@@ -99,7 +97,7 @@ class Request < FinchAPI::Internal::Type::BaseModel
9997
#
10098
# @param data [String, Hash{Symbol=>Object, nil}, nil] The body that was specified for the forwarded request.
10199
#
102-
# @param headers [Hash{Symbol=>Object, nil}, nil] The HTTP headers that were specified for the forwarded request.
100+
# @param headers [Hash{Symbol=>String}, nil] The HTTP headers that were specified for the forwarded request.
103101
#
104102
# @param params [Hash{Symbol=>Object, nil}, nil] The query parameters that were specified for the forwarded request.
105103

0 commit comments

Comments
 (0)