Skip to content

Commit 6f63db8

Browse files
stainless-app[bot]stainless-app[bot]
committed
chore(internal): annotate request options with type aliases in sorbet
1 parent b6d3a80 commit 6f63db8

35 files changed

+55
-105
lines changed

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
module FinchAPI
44
module Models
55
module Sandbox
6+
# @type [FinchAPI::Internal::Type::Converter]
67
DirectoryCreateResponse = FinchAPI::Internal::Type::ArrayOf[FinchAPI::Internal::Type::Unknown]
78
end
89
end

‎lib/finch_api/models/sandbox/jobs/configuration_retrieve_response.rb‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ module FinchAPI
44
module Models
55
module Sandbox
66
module Jobs
7+
# @type [FinchAPI::Internal::Type::Converter]
78
ConfigurationRetrieveResponse =
89
FinchAPI::Internal::Type::ArrayOf[-> { FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration }]
910
end

‎rbi/finch_api/internal/transport/base_client.rbi‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ module FinchAPI
3535
page: T.nilable(T::Class[FinchAPI::Internal::Type::BasePage[FinchAPI::Internal::Type::BaseModel]]),
3636
stream: T.nilable(T::Class[T.anything]),
3737
model: T.nilable(FinchAPI::Internal::Type::Converter::Input),
38-
options: T.nilable(T.any(FinchAPI::RequestOptions, FinchAPI::Internal::AnyHash))
38+
options: T.nilable(FinchAPI::RequestOpts)
3939
}
4040
end
4141

@@ -188,7 +188,7 @@ module FinchAPI
188188
page: T.nilable(T::Class[FinchAPI::Internal::Type::BasePage[FinchAPI::Internal::Type::BaseModel]]),
189189
stream: T.nilable(T::Class[T.anything]),
190190
model: T.nilable(FinchAPI::Internal::Type::Converter::Input),
191-
options: T.nilable(T.any(FinchAPI::RequestOptions, FinchAPI::Internal::AnyHash))
191+
options: T.nilable(FinchAPI::RequestOpts)
192192
)
193193
.returns(T.anything)
194194
end

‎rbi/finch_api/internal/type/request_parameters.rbi‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ module FinchAPI
66
# @api private
77
module RequestParameters
88
# Options to specify HTTP behaviour for this request.
9-
sig { returns(T.any(FinchAPI::RequestOptions, FinchAPI::Internal::AnyHash)) }
9+
sig { returns(FinchAPI::RequestOpts) }
1010
attr_accessor :request_options
1111

1212
# @api private

‎rbi/finch_api/request_options.rbi‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# typed: strong
22

33
module FinchAPI
4+
RequestOpts = T.type_alias { T.any(FinchAPI::RequestOptions, FinchAPI::Internal::AnyHash) }
5+
46
# Specify HTTP behaviour to use for a specific request. These options supplement
57
# or override those provided at the client level.
68
#

‎rbi/finch_api/resources/access_tokens.rbi‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ module FinchAPI
1010
client_id: String,
1111
client_secret: String,
1212
redirect_uri: String,
13-
request_options: T.nilable(T.any(FinchAPI::RequestOptions, FinchAPI::Internal::AnyHash))
13+
request_options: FinchAPI::RequestOpts
1414
)
1515
.returns(FinchAPI::Models::CreateAccessTokenResponse)
1616
end

‎rbi/finch_api/resources/account.rbi‎

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,11 @@ module FinchAPI
44
module Resources
55
class Account
66
# Disconnect one or more `access_token`s from your application.
7-
sig do
8-
params(request_options: T.nilable(T.any(FinchAPI::RequestOptions, FinchAPI::Internal::AnyHash)))
9-
.returns(FinchAPI::Models::DisconnectResponse)
10-
end
7+
sig { params(request_options: FinchAPI::RequestOpts).returns(FinchAPI::Models::DisconnectResponse) }
118
def disconnect(request_options: {}); end
129

1310
# Read account information associated with an `access_token`
14-
sig do
15-
params(request_options: T.nilable(T.any(FinchAPI::RequestOptions, FinchAPI::Internal::AnyHash)))
16-
.returns(FinchAPI::Models::Introspection)
17-
end
11+
sig { params(request_options: FinchAPI::RequestOpts).returns(FinchAPI::Models::Introspection) }
1812
def introspect(request_options: {}); end
1913

2014
# @api private

‎rbi/finch_api/resources/connect/sessions.rbi‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ module FinchAPI
1616
minutes_to_expire: T.nilable(Float),
1717
redirect_uri: T.nilable(String),
1818
sandbox: T.nilable(FinchAPI::Models::Connect::SessionNewParams::Sandbox::OrSymbol),
19-
request_options: T.nilable(T.any(FinchAPI::RequestOptions, FinchAPI::Internal::AnyHash))
19+
request_options: FinchAPI::RequestOpts
2020
)
2121
.returns(FinchAPI::Models::Connect::SessionNewResponse)
2222
end
@@ -41,7 +41,7 @@ module FinchAPI
4141
minutes_to_expire: T.nilable(Integer),
4242
products: T.nilable(T::Array[FinchAPI::Models::Connect::SessionReauthenticateParams::Product::OrSymbol]),
4343
redirect_uri: T.nilable(String),
44-
request_options: T.nilable(T.any(FinchAPI::RequestOptions, FinchAPI::Internal::AnyHash))
44+
request_options: FinchAPI::RequestOpts
4545
)
4646
.returns(FinchAPI::Models::Connect::SessionReauthenticateResponse)
4747
end

‎rbi/finch_api/resources/hris/benefits.rbi‎

Lines changed: 5 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ module FinchAPI
1414
description: String,
1515
frequency: T.nilable(FinchAPI::Models::HRIS::BenefitFrequency::OrSymbol),
1616
type: T.nilable(FinchAPI::Models::HRIS::BenefitType::OrSymbol),
17-
request_options: T.nilable(T.any(FinchAPI::RequestOptions, FinchAPI::Internal::AnyHash))
17+
request_options: FinchAPI::RequestOpts
1818
)
1919
.returns(FinchAPI::Models::HRIS::CreateCompanyBenefitsResponse)
2020
end
@@ -31,21 +31,14 @@ module FinchAPI
3131
); end
3232
# Lists deductions and contributions information for a given item
3333
sig do
34-
params(
35-
benefit_id: String,
36-
request_options: T.nilable(T.any(FinchAPI::RequestOptions, FinchAPI::Internal::AnyHash))
37-
)
34+
params(benefit_id: String, request_options: FinchAPI::RequestOpts)
3835
.returns(FinchAPI::Models::HRIS::CompanyBenefit)
3936
end
4037
def retrieve(benefit_id, request_options: {}); end
4138

4239
# Updates an existing company-wide deduction or contribution
4340
sig do
44-
params(
45-
benefit_id: String,
46-
description: String,
47-
request_options: T.nilable(T.any(FinchAPI::RequestOptions, FinchAPI::Internal::AnyHash))
48-
)
41+
params(benefit_id: String, description: String, request_options: FinchAPI::RequestOpts)
4942
.returns(FinchAPI::Models::HRIS::UpdateCompanyBenefitResponse)
5043
end
5144
def update(
@@ -56,14 +49,14 @@ module FinchAPI
5649
); end
5750
# List all company-wide deductions and contributions.
5851
sig do
59-
params(request_options: T.nilable(T.any(FinchAPI::RequestOptions, FinchAPI::Internal::AnyHash)))
52+
params(request_options: FinchAPI::RequestOpts)
6053
.returns(FinchAPI::Internal::SinglePage[FinchAPI::Models::HRIS::CompanyBenefit])
6154
end
6255
def list(request_options: {}); end
6356

6457
# Get deductions metadata
6558
sig do
66-
params(request_options: T.nilable(T.any(FinchAPI::RequestOptions, FinchAPI::Internal::AnyHash)))
59+
params(request_options: FinchAPI::RequestOpts)
6760
.returns(FinchAPI::Internal::SinglePage[FinchAPI::Models::HRIS::BenefitListSupportedBenefitsResponse])
6861
end
6962
def list_supported_benefits(request_options: {}); end

‎rbi/finch_api/resources/hris/benefits/individuals.rbi‎

Lines changed: 4 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ module FinchAPI
1818
FinchAPI::Internal::AnyHash
1919
)
2020
],
21-
request_options: T.nilable(T.any(FinchAPI::RequestOptions, FinchAPI::Internal::AnyHash))
21+
request_options: FinchAPI::RequestOpts
2222
)
2323
.returns(FinchAPI::Models::HRIS::Benefits::EnrolledIndividualBenefitResponse)
2424
end
@@ -30,21 +30,14 @@ module FinchAPI
3030
); end
3131
# Lists individuals currently enrolled in a given deduction.
3232
sig do
33-
params(
34-
benefit_id: String,
35-
request_options: T.nilable(T.any(FinchAPI::RequestOptions, FinchAPI::Internal::AnyHash))
36-
)
33+
params(benefit_id: String, request_options: FinchAPI::RequestOpts)
3734
.returns(FinchAPI::Models::HRIS::Benefits::IndividualEnrolledIDsResponse)
3835
end
3936
def enrolled_ids(benefit_id, request_options: {}); end
4037

4138
# Get enrollment information for the given individuals.
4239
sig do
43-
params(
44-
benefit_id: String,
45-
individual_ids: String,
46-
request_options: T.nilable(T.any(FinchAPI::RequestOptions, FinchAPI::Internal::AnyHash))
47-
)
40+
params(benefit_id: String, individual_ids: String, request_options: FinchAPI::RequestOpts)
4841
.returns(FinchAPI::Internal::SinglePage[FinchAPI::Models::HRIS::Benefits::IndividualBenefit])
4942
end
5043
def retrieve_many_benefits(
@@ -59,7 +52,7 @@ module FinchAPI
5952
params(
6053
benefit_id: String,
6154
individual_ids: T::Array[String],
62-
request_options: T.nilable(T.any(FinchAPI::RequestOptions, FinchAPI::Internal::AnyHash))
55+
request_options: FinchAPI::RequestOpts
6356
)
6457
.returns(FinchAPI::Models::HRIS::Benefits::UnenrolledIndividualBenefitResponse)
6558
end

0 commit comments

Comments
 (0)