Skip to content

Commit c7cf406

Browse files
stainless-app[bot]stainless-app[bot]
committed
feat(api): api update
1 parent 39ec8a9 commit c7cf406

20 files changed

Lines changed: 58 additions & 91 deletions

‎.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-ded87cb73affcaff9cf779d9cfd119a4026cfc1757b39be95d933edea48a0328.yml
3-
openapi_spec_hash: 0e6394b222fc68d7607114e70b72d23e
2+
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/finch%2Ffinch-46f433f34d440aa1dfcc48cc8d822c598571b68be2f723ec99e1b4fba6c13b1e.yml
3+
openapi_spec_hash: 5b5cd728776723ac773900f7e8a32c05
44
config_hash: 0892e2e0eeb0343a022afa62e9080dd1

‎lib/finch_api/models/hris/employment_data.rb‎

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,7 @@ class UnionMember0 < FinchAPI::Internal::Type::BaseModel
3636
required :employment, -> { FinchAPI::HRIS::EmploymentData::UnionMember0::Employment }, nil?: true
3737

3838
# @!attribute employment_status
39-
# The detailed employment status of the individual. Available options: `active`,
40-
# `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`.
39+
# The detailed employment status of the individual.
4140
#
4241
# @return [Symbol, FinchAPI::Models::HRIS::EmploymentData::UnionMember0::EmploymentStatus, nil]
4342
required :employment_status,
@@ -154,7 +153,7 @@ class UnionMember0 < FinchAPI::Internal::Type::BaseModel
154153
#
155154
# @param employment [FinchAPI::Models::HRIS::EmploymentData::UnionMember0::Employment, nil] The employment object.
156155
#
157-
# @param employment_status [Symbol, FinchAPI::Models::HRIS::EmploymentData::UnionMember0::EmploymentStatus, nil] The detailed employment status of the individual. Available options: `active`, `
156+
# @param employment_status [Symbol, FinchAPI::Models::HRIS::EmploymentData::UnionMember0::EmploymentStatus, nil] The detailed employment status of the individual.
158157
#
159158
# @param end_date [String, nil]
160159
#
@@ -264,8 +263,7 @@ module Type
264263
end
265264
end
266265

267-
# The detailed employment status of the individual. Available options: `active`,
268-
# `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`.
266+
# The detailed employment status of the individual.
269267
#
270268
# @see FinchAPI::Models::HRIS::EmploymentData::UnionMember0#employment_status
271269
module EmploymentStatus

‎lib/finch_api/models/hris/payment_list_params.rb‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,14 @@ class PaymentListParams < FinchAPI::Internal::Type::BaseModel
1010

1111
# @!attribute end_date
1212
# The end date to retrieve payments by a company (inclusive) in `YYYY-MM-DD`
13-
# format.
13+
# format. Filters payments by their **pay_date** field.
1414
#
1515
# @return [Date]
1616
required :end_date, Date
1717

1818
# @!attribute start_date
1919
# The start date to retrieve payments by a company (inclusive) in `YYYY-MM-DD`
20-
# format.
20+
# format. Filters payments by their **pay_date** field.
2121
#
2222
# @return [Date]
2323
required :start_date, Date

‎lib/finch_api/models/sandbox/directory_create_params.rb‎

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -69,8 +69,7 @@ class Body < FinchAPI::Internal::Type::BaseModel
6969
optional :employment, -> { FinchAPI::Sandbox::DirectoryCreateParams::Body::Employment }, nil?: true
7070

7171
# @!attribute employment_status
72-
# The detailed employment status of the individual. Available options: `active`,
73-
# `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`.
72+
# The detailed employment status of the individual.
7473
#
7574
# @return [Symbol, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::EmploymentStatus, nil]
7675
optional :employment_status,
@@ -225,7 +224,7 @@ class Body < FinchAPI::Internal::Type::BaseModel
225224
#
226225
# @param employment [FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment, nil] The employment object.
227226
#
228-
# @param employment_status [Symbol, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::EmploymentStatus, nil] The detailed employment status of the individual. Available options: `active`, `
227+
# @param employment_status [Symbol, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::EmploymentStatus, nil] The detailed employment status of the individual.
229228
#
230229
# @param encrypted_ssn [String, nil] Social Security Number of the individual in **encrypted** format. This field is
231230
#
@@ -392,8 +391,7 @@ module Type
392391
end
393392
end
394393

395-
# The detailed employment status of the individual. Available options: `active`,
396-
# `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`.
394+
# The detailed employment status of the individual.
397395
#
398396
# @see FinchAPI::Models::Sandbox::DirectoryCreateParams::Body#employment_status
399397
module EmploymentStatus

‎lib/finch_api/models/sandbox/employment_update_params.rb‎

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -39,8 +39,7 @@ class EmploymentUpdateParams < FinchAPI::Internal::Type::BaseModel
3939
optional :employment, -> { FinchAPI::Sandbox::EmploymentUpdateParams::Employment }, nil?: true
4040

4141
# @!attribute employment_status
42-
# The detailed employment status of the individual. Available options: `active`,
43-
# `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`.
42+
# The detailed employment status of the individual.
4443
#
4544
# @return [Symbol, FinchAPI::Models::Sandbox::EmploymentUpdateParams::EmploymentStatus, nil]
4645
optional :employment_status,
@@ -137,7 +136,7 @@ class EmploymentUpdateParams < FinchAPI::Internal::Type::BaseModel
137136
#
138137
# @param employment [FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment, nil] The employment object.
139138
#
140-
# @param employment_status [Symbol, FinchAPI::Models::Sandbox::EmploymentUpdateParams::EmploymentStatus, nil] The detailed employment status of the individual. Available options: `active`, `
139+
# @param employment_status [Symbol, FinchAPI::Models::Sandbox::EmploymentUpdateParams::EmploymentStatus, nil] The detailed employment status of the individual.
141140
#
142141
# @param end_date [String, nil]
143142
#
@@ -257,8 +256,7 @@ module Type
257256
end
258257
end
259258

260-
# The detailed employment status of the individual. Available options: `active`,
261-
# `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`.
259+
# The detailed employment status of the individual.
262260
module EmploymentStatus
263261
extend FinchAPI::Internal::Type::Enum
264262

‎lib/finch_api/models/sandbox/employment_update_response.rb‎

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,7 @@ class EmploymentUpdateResponse < FinchAPI::Internal::Type::BaseModel
4040
optional :employment, -> { FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment }, nil?: true
4141

4242
# @!attribute employment_status
43-
# The detailed employment status of the individual. Available options: `active`,
44-
# `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`.
43+
# The detailed employment status of the individual.
4544
#
4645
# @return [Symbol, FinchAPI::Models::Sandbox::EmploymentUpdateResponse::EmploymentStatus, nil]
4746
optional :employment_status,
@@ -140,7 +139,7 @@ class EmploymentUpdateResponse < FinchAPI::Internal::Type::BaseModel
140139
#
141140
# @param employment [FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment, nil] The employment object.
142141
#
143-
# @param employment_status [Symbol, FinchAPI::Models::Sandbox::EmploymentUpdateResponse::EmploymentStatus, nil] The detailed employment status of the individual. Available options: `active`, `
142+
# @param employment_status [Symbol, FinchAPI::Models::Sandbox::EmploymentUpdateResponse::EmploymentStatus, nil] The detailed employment status of the individual.
144143
#
145144
# @param end_date [String, nil]
146145
#
@@ -260,8 +259,7 @@ module Type
260259
end
261260
end
262261

263-
# The detailed employment status of the individual. Available options: `active`,
264-
# `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`.
262+
# The detailed employment status of the individual.
265263
#
266264
# @see FinchAPI::Models::Sandbox::EmploymentUpdateResponse#employment_status
267265
module EmploymentStatus

‎lib/finch_api/resources/hris/company/pay_statement_item.rb‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,8 @@ class PayStatementItem
1111
# Some parameter documentations has been truncated, see
1212
# {FinchAPI::Models::HRIS::Company::PayStatementItemListParams} for more details.
1313
#
14-
# **Beta:** this endpoint currently serves employers onboarded after March 4th and
15-
# historical support will be added soon Retrieve a list of detailed pay statement
16-
# items for the access token's connection account.
14+
# Retrieve a list of detailed pay statement items for the access token's
15+
# connection account.
1716
#
1817
# @overload list(categories: nil, end_date: nil, entity_ids: nil, name: nil, start_date: nil, type: nil, request_options: {})
1918
#

‎lib/finch_api/resources/hris/company/pay_statement_item/rules.rb‎

Lines changed: 7 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,10 @@ class Rules
1010
# {FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateParams} for more
1111
# details.
1212
#
13-
# **Beta:** this endpoint currently serves employers onboarded after March 4th and
14-
# historical support will be added soon Custom rules can be created to associate
15-
# specific attributes to pay statement items depending on the use case. For
16-
# example, pay statement items that meet certain conditions can be labeled as a
17-
# pre-tax 401k. This metadata can be retrieved where pay statement item
18-
# information is available.
13+
# Custom rules can be created to associate specific attributes to pay statement
14+
# items depending on the use case. For example, pay statement items that meet
15+
# certain conditions can be labeled as a pre-tax 401k. This metadata can be
16+
# retrieved where pay statement item information is available.
1917
#
2018
# @overload create(entity_ids: nil, attributes: nil, conditions: nil, effective_end_date: nil, effective_start_date: nil, entity_type: nil, request_options: {})
2119
#
@@ -49,8 +47,7 @@ def create(params = {})
4947
)
5048
end
5149

52-
# **Beta:** this endpoint currently serves employers onboarded after March 4th and
53-
# historical support will be added soon Update a rule for a pay statement item.
50+
# Update a rule for a pay statement item.
5451
#
5552
# @overload update(rule_id, entity_ids: nil, optional_property: nil, request_options: {})
5653
#
@@ -78,8 +75,7 @@ def update(rule_id, params = {})
7875
)
7976
end
8077

81-
# **Beta:** this endpoint currently serves employers onboarded after March 4th and
82-
# historical support will be added soon List all rules of a connection account.
78+
# List all rules of a connection account.
8379
#
8480
# @overload list(entity_ids: nil, request_options: {})
8581
#
@@ -102,8 +98,7 @@ def list(params = {})
10298
)
10399
end
104100

105-
# **Beta:** this endpoint currently serves employers onboarded after March 4th and
106-
# historical support will be added soon Delete a rule for a pay statement item.
101+
# Delete a rule for a pay statement item.
107102
#
108103
# @overload delete(rule_id, entity_ids: nil, request_options: {})
109104
#

‎lib/finch_api/resources/jobs/manual.rb‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ module FinchAPI
44
module Resources
55
class Jobs
66
class Manual
7-
# Get a manual job by `job_id`. Manual jobs are completed by a human and include
8-
# Assisted Benefits jobs.
7+
# Check the status and outcome of a job by `job_id`. This includes all deductions
8+
# jobs including those for both automated and assisted integrations.
99
#
1010
# @overload retrieve(job_id, request_options: {})
1111
#

‎lib/finch_api/resources/sandbox/employment.rb‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ class Employment
2121
#
2222
# @param employment [FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment, nil] The employment object.
2323
#
24-
# @param employment_status [Symbol, FinchAPI::Models::Sandbox::EmploymentUpdateParams::EmploymentStatus, nil] The detailed employment status of the individual. Available options: `active`, `
24+
# @param employment_status [Symbol, FinchAPI::Models::Sandbox::EmploymentUpdateParams::EmploymentStatus, nil] The detailed employment status of the individual.
2525
#
2626
# @param end_date [String, nil]
2727
#

0 commit comments

Comments
 (0)