finch-api 0.1.0.pre.alpha.16 → 0.1.0.pre.alpha.17
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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +30 -0
- data/README.md +92 -53
- data/lib/finch_api/client.rb +4 -4
- data/lib/finch_api/errors.rb +1 -1
- data/lib/finch_api/internal/transport/base_client.rb +77 -5
- data/lib/finch_api/internal/transport/pooled_net_requester.rb +17 -1
- data/lib/finch_api/internal/type/array_of.rb +1 -1
- data/lib/finch_api/internal/type/base_model.rb +70 -30
- data/lib/finch_api/internal/type/converter.rb +18 -0
- data/lib/finch_api/internal/type/enum.rb +1 -0
- data/lib/finch_api/internal/type/hash_of.rb +1 -1
- data/lib/finch_api/internal/type/union.rb +1 -0
- data/lib/finch_api/internal/util.rb +56 -0
- data/lib/finch_api/internal.rb +6 -0
- data/lib/finch_api/models/hris/document_retreive_response.rb +4 -0
- data/lib/finch_api/models/hris/employment_data.rb +10 -0
- data/lib/finch_api/models/hris/individual.rb +6 -0
- data/lib/finch_api/models/hris/pay_statement.rb +1 -0
- data/lib/finch_api/models/sandbox/payment_create_params.rb +1 -0
- data/lib/finch_api/models/webhook_event.rb +15 -0
- data/lib/finch_api/models.rb +27 -0
- data/lib/finch_api/request_options.rb +4 -0
- data/lib/finch_api/version.rb +1 -1
- data/lib/finch_api.rb +2 -0
- data/rbi/finch_api/internal/transport/base_client.rbi +31 -16
- data/rbi/finch_api/internal/transport/pooled_net_requester.rbi +10 -5
- data/rbi/finch_api/internal/type/base_model.rbi +33 -15
- data/rbi/finch_api/internal/type/base_page.rbi +1 -2
- data/rbi/finch_api/internal/type/converter.rbi +2 -0
- data/rbi/finch_api/internal/type/enum.rbi +1 -0
- data/rbi/finch_api/internal/type/union.rbi +1 -0
- data/rbi/finch_api/internal/util.rbi +28 -5
- data/rbi/finch_api/internal.rbi +2 -0
- data/rbi/finch_api/models/access_token_create_params.rbi +4 -1
- data/rbi/finch_api/models/account_disconnect_params.rbi +4 -1
- data/rbi/finch_api/models/account_introspect_params.rbi +4 -1
- data/rbi/finch_api/models/account_update_event.rbi +156 -34
- data/rbi/finch_api/models/base_webhook_event.rbi +4 -1
- data/rbi/finch_api/models/company_event.rbi +4 -1
- data/rbi/finch_api/models/connect/session_new_params.rbi +12 -2
- data/rbi/finch_api/models/connect/session_new_response.rbi +6 -1
- data/rbi/finch_api/models/connect/session_reauthenticate_params.rbi +6 -1
- data/rbi/finch_api/models/connect/session_reauthenticate_response.rbi +6 -1
- data/rbi/finch_api/models/create_access_token_response.rbi +7 -1
- data/rbi/finch_api/models/directory_event.rbi +7 -2
- data/rbi/finch_api/models/disconnect_response.rbi +4 -1
- data/rbi/finch_api/models/employment_event.rbi +7 -2
- data/rbi/finch_api/models/hris/benefit_contribution.rbi +6 -1
- data/rbi/finch_api/models/hris/benefit_create_params.rbi +18 -3
- data/rbi/finch_api/models/hris/benefit_features_and_operations.rbi +12 -2
- data/rbi/finch_api/models/hris/benefit_list_params.rbi +6 -1
- data/rbi/finch_api/models/hris/benefit_list_supported_benefits_params.rbi +6 -1
- data/rbi/finch_api/models/hris/benefit_list_supported_benefits_response.rbi +6 -1
- data/rbi/finch_api/models/hris/benefit_retrieve_params.rbi +6 -1
- data/rbi/finch_api/models/hris/benefit_update_params.rbi +6 -1
- data/rbi/finch_api/models/hris/benefits/enrolled_individual_benefit_response.rbi +6 -1
- data/rbi/finch_api/models/hris/benefits/individual_benefit.rbi +12 -2
- data/rbi/finch_api/models/hris/benefits/individual_enroll_many_params.rbi +26 -5
- data/rbi/finch_api/models/hris/benefits/individual_enrolled_ids_params.rbi +6 -1
- data/rbi/finch_api/models/hris/benefits/individual_enrolled_ids_response.rbi +6 -1
- data/rbi/finch_api/models/hris/benefits/individual_retrieve_many_benefits_params.rbi +6 -1
- data/rbi/finch_api/models/hris/benefits/individual_unenroll_many_params.rbi +6 -1
- data/rbi/finch_api/models/hris/benefits/unenrolled_individual_benefit_response.rbi +6 -1
- data/rbi/finch_api/models/hris/benefits_support.rbi +3 -1
- data/rbi/finch_api/models/hris/company/pay_statement_item/rule_create_params.rbi +18 -3
- data/rbi/finch_api/models/hris/company/pay_statement_item/rule_create_response.rbi +18 -3
- data/rbi/finch_api/models/hris/company/pay_statement_item/rule_delete_params.rbi +6 -1
- data/rbi/finch_api/models/hris/company/pay_statement_item/rule_delete_response.rbi +18 -3
- data/rbi/finch_api/models/hris/company/pay_statement_item/rule_list_params.rbi +6 -1
- data/rbi/finch_api/models/hris/company/pay_statement_item/rule_list_response.rbi +18 -3
- data/rbi/finch_api/models/hris/company/pay_statement_item/rule_update_params.rbi +6 -1
- data/rbi/finch_api/models/hris/company/pay_statement_item/rule_update_response.rbi +18 -3
- data/rbi/finch_api/models/hris/company/pay_statement_item_list_params.rbi +6 -1
- data/rbi/finch_api/models/hris/company/pay_statement_item_list_response.rbi +12 -2
- data/rbi/finch_api/models/hris/company.rbi +27 -5
- data/rbi/finch_api/models/hris/company_benefit.rbi +15 -3
- data/rbi/finch_api/models/hris/company_retrieve_params.rbi +6 -1
- data/rbi/finch_api/models/hris/create_company_benefits_response.rbi +6 -1
- data/rbi/finch_api/models/hris/directory_list_individuals_params.rbi +6 -1
- data/rbi/finch_api/models/hris/directory_list_params.rbi +6 -1
- data/rbi/finch_api/models/hris/document_list_params.rbi +6 -1
- data/rbi/finch_api/models/hris/document_list_response.rbi +6 -1
- data/rbi/finch_api/models/hris/document_response.rbi +3 -1
- data/rbi/finch_api/models/hris/document_retreive_params.rbi +6 -1
- data/rbi/finch_api/models/hris/employment_data.rbi +36 -6
- data/rbi/finch_api/models/hris/employment_data_response.rbi +6 -1
- data/rbi/finch_api/models/hris/employment_retrieve_many_params.rbi +12 -2
- data/rbi/finch_api/models/hris/individual.rbi +24 -4
- data/rbi/finch_api/models/hris/individual_in_directory.rbi +18 -3
- data/rbi/finch_api/models/hris/individual_response.rbi +6 -1
- data/rbi/finch_api/models/hris/individual_retrieve_many_params.rbi +18 -3
- data/rbi/finch_api/models/hris/pay_statement.rbi +80 -13
- data/rbi/finch_api/models/hris/pay_statement_response.rbi +6 -1
- data/rbi/finch_api/models/hris/pay_statement_response_body.rbi +6 -1
- data/rbi/finch_api/models/hris/pay_statement_retrieve_many_params.rbi +12 -2
- data/rbi/finch_api/models/hris/payment.rbi +9 -2
- data/rbi/finch_api/models/hris/payment_list_params.rbi +6 -1
- data/rbi/finch_api/models/hris/support_per_benefit_type.rbi +6 -1
- data/rbi/finch_api/models/hris/supported_benefit.rbi +3 -1
- data/rbi/finch_api/models/hris/update_company_benefit_response.rbi +6 -1
- data/rbi/finch_api/models/hris/w42005.rbi +6 -2
- data/rbi/finch_api/models/hris/w42020.rbi +6 -2
- data/rbi/finch_api/models/income.rbi +2 -1
- data/rbi/finch_api/models/individual_event.rbi +7 -2
- data/rbi/finch_api/models/introspection.rbi +22 -4
- data/rbi/finch_api/models/job_completion_event.rbi +10 -2
- data/rbi/finch_api/models/jobs/automated_async_job.rbi +12 -2
- data/rbi/finch_api/models/jobs/automated_create_params.rbi +12 -2
- data/rbi/finch_api/models/jobs/automated_create_response.rbi +6 -1
- data/rbi/finch_api/models/jobs/automated_list_params.rbi +6 -1
- data/rbi/finch_api/models/jobs/automated_list_response.rbi +24 -4
- data/rbi/finch_api/models/jobs/automated_retrieve_params.rbi +6 -1
- data/rbi/finch_api/models/jobs/manual_async_job.rbi +3 -1
- data/rbi/finch_api/models/jobs/manual_retrieve_params.rbi +6 -1
- data/rbi/finch_api/models/location.rbi +2 -1
- data/rbi/finch_api/models/money.rbi +2 -1
- data/rbi/finch_api/models/operation_support_matrix.rbi +4 -1
- data/rbi/finch_api/models/paging.rbi +2 -1
- data/rbi/finch_api/models/pay_statement_event.rbi +10 -2
- data/rbi/finch_api/models/payment_event.rbi +7 -2
- data/rbi/finch_api/models/payroll/pay_group_list_params.rbi +6 -1
- data/rbi/finch_api/models/payroll/pay_group_list_response.rbi +6 -1
- data/rbi/finch_api/models/payroll/pay_group_retrieve_params.rbi +6 -1
- data/rbi/finch_api/models/payroll/pay_group_retrieve_response.rbi +6 -1
- data/rbi/finch_api/models/provider.rbi +182 -33
- data/rbi/finch_api/models/provider_list_params.rbi +4 -1
- data/rbi/finch_api/models/request_forwarding_forward_params.rbi +7 -1
- data/rbi/finch_api/models/request_forwarding_forward_response.rbi +13 -2
- data/rbi/finch_api/models/sandbox/company_update_params.rbi +30 -5
- data/rbi/finch_api/models/sandbox/company_update_response.rbi +30 -5
- data/rbi/finch_api/models/sandbox/connection_create_params.rbi +6 -1
- data/rbi/finch_api/models/sandbox/connection_create_response.rbi +6 -1
- data/rbi/finch_api/models/sandbox/connections/account_create_params.rbi +6 -1
- data/rbi/finch_api/models/sandbox/connections/account_create_response.rbi +6 -1
- data/rbi/finch_api/models/sandbox/connections/account_update_params.rbi +6 -1
- data/rbi/finch_api/models/sandbox/connections/account_update_response.rbi +6 -1
- data/rbi/finch_api/models/sandbox/directory_create_params.rbi +48 -8
- data/rbi/finch_api/models/sandbox/employment_update_params.rbi +30 -5
- data/rbi/finch_api/models/sandbox/employment_update_response.rbi +30 -5
- data/rbi/finch_api/models/sandbox/individual_update_params.rbi +18 -3
- data/rbi/finch_api/models/sandbox/individual_update_response.rbi +18 -3
- data/rbi/finch_api/models/sandbox/job_create_params.rbi +6 -1
- data/rbi/finch_api/models/sandbox/job_create_response.rbi +6 -1
- data/rbi/finch_api/models/sandbox/jobs/configuration_retrieve_params.rbi +6 -1
- data/rbi/finch_api/models/sandbox/jobs/configuration_update_params.rbi +6 -1
- data/rbi/finch_api/models/sandbox/jobs/sandbox_job_configuration.rbi +6 -1
- data/rbi/finch_api/models/sandbox/payment_create_params.rbi +81 -14
- data/rbi/finch_api/models/sandbox/payment_create_response.rbi +6 -1
- data/rbi/finch_api/request_options.rbi +4 -1
- data/sig/finch_api/internal/single_page.rbs +1 -1
- data/sig/finch_api/internal/transport/base_client.rbs +16 -1
- data/sig/finch_api/internal/transport/pooled_net_requester.rbs +4 -0
- data/sig/finch_api/internal/type/base_model.rbs +11 -5
- data/sig/finch_api/internal/type/base_page.rbs +1 -1
- data/sig/finch_api/internal/type/converter.rbs +2 -0
- data/sig/finch_api/internal/type/enum.rbs +1 -0
- data/sig/finch_api/internal/type/union.rbs +1 -0
- data/sig/finch_api/internal/util.rbs +13 -0
- data/sig/finch_api/internal.rbs +2 -0
- data/sig/finch_api/models/hris/pay_statement.rbs +2 -1
- data/sig/finch_api/models/sandbox/payment_create_params.rbs +2 -1
- metadata +2 -2
@@ -2,6 +2,8 @@ module FinchAPI
|
|
2
2
|
module Internal
|
3
3
|
module Transport
|
4
4
|
class BaseClient
|
5
|
+
extend FinchAPI::Internal::Util::SorbetRuntimeSupport
|
6
|
+
|
5
7
|
type request_components =
|
6
8
|
{
|
7
9
|
method: Symbol,
|
@@ -20,7 +22,6 @@ module FinchAPI
|
|
20
22
|
model: FinchAPI::Internal::Type::Converter::input?,
|
21
23
|
options: FinchAPI::request_opts?
|
22
24
|
}
|
23
|
-
|
24
25
|
type request_input =
|
25
26
|
{
|
26
27
|
method: Symbol,
|
@@ -55,6 +56,20 @@ module FinchAPI
|
|
55
56
|
stream: Enumerable[String]?
|
56
57
|
) -> void
|
57
58
|
|
59
|
+
attr_reader base_url: URI::Generic
|
60
|
+
|
61
|
+
attr_reader timeout: Float
|
62
|
+
|
63
|
+
attr_reader max_retries: Integer
|
64
|
+
|
65
|
+
attr_reader initial_retry_delay: Float
|
66
|
+
|
67
|
+
attr_reader max_retry_delay: Float
|
68
|
+
|
69
|
+
attr_reader headers: ::Hash[String, String]
|
70
|
+
|
71
|
+
attr_reader idempotency_header: String?
|
72
|
+
|
58
73
|
# @api private
|
59
74
|
attr_reader requester: FinchAPI::Internal::Transport::PooledNetRequester
|
60
75
|
|
@@ -2,6 +2,8 @@ module FinchAPI
|
|
2
2
|
module Internal
|
3
3
|
module Transport
|
4
4
|
class PooledNetRequester
|
5
|
+
extend FinchAPI::Internal::Util::SorbetRuntimeSupport
|
6
|
+
|
5
7
|
type request =
|
6
8
|
{
|
7
9
|
method: Symbol,
|
@@ -13,6 +15,8 @@ module FinchAPI
|
|
13
15
|
|
14
16
|
KEEP_ALIVE_TIMEOUT: 30
|
15
17
|
|
18
|
+
DEFAULT_MAX_CONNECTIONS: Integer
|
19
|
+
|
16
20
|
def self.connect: (URI::Generic url) -> top
|
17
21
|
|
18
22
|
def self.calibrate_socket_timeout: (top conn, Float deadline) -> void
|
@@ -3,10 +3,13 @@ module FinchAPI
|
|
3
3
|
module Type
|
4
4
|
class BaseModel
|
5
5
|
extend FinchAPI::Internal::Type::Converter
|
6
|
+
extend FinchAPI::Internal::Util::SorbetRuntimeSupport
|
6
7
|
|
7
8
|
type known_field =
|
8
9
|
{ mode: (:coerce | :dump)?, required: bool, nilable: bool }
|
9
10
|
|
11
|
+
def self.inherited: (self child) -> void
|
12
|
+
|
10
13
|
def self.known_fields: -> ::Hash[Symbol, (FinchAPI::Internal::Type::BaseModel::known_field
|
11
14
|
& { type_fn: (^-> FinchAPI::Internal::Type::Converter::input) })]
|
12
15
|
|
@@ -65,23 +68,26 @@ module FinchAPI
|
|
65
68
|
state: FinchAPI::Internal::Type::Converter::dump_state
|
66
69
|
) -> (::Hash[top, top] | top)
|
67
70
|
|
71
|
+
def self.recursively_to_h: (
|
72
|
+
FinchAPI::Internal::Type::BaseModel model,
|
73
|
+
convert: bool
|
74
|
+
) -> ::Hash[Symbol, top]
|
75
|
+
|
68
76
|
def []: (Symbol key) -> top?
|
69
77
|
|
70
78
|
def to_h: -> ::Hash[Symbol, top]
|
71
79
|
|
72
80
|
alias to_hash to_h
|
73
81
|
|
74
|
-
def
|
82
|
+
def deep_to_h: -> ::Hash[Symbol, top]
|
75
83
|
|
76
|
-
def
|
77
|
-
FinchAPI::Internal::Type::BaseModel model
|
78
|
-
) -> ::Hash[Symbol, top]
|
84
|
+
def deconstruct_keys: (::Array[Symbol]? keys) -> ::Hash[Symbol, top]
|
79
85
|
|
80
86
|
def to_json: (*top a) -> String
|
81
87
|
|
82
88
|
def to_yaml: (*top a) -> String
|
83
89
|
|
84
|
-
def initialize: (?::Hash[Symbol, top] |
|
90
|
+
def initialize: (?::Hash[Symbol, top] | instance data) -> void
|
85
91
|
|
86
92
|
def self.inspect: (?depth: Integer) -> String
|
87
93
|
|
@@ -1,6 +1,8 @@
|
|
1
1
|
module FinchAPI
|
2
2
|
module Internal
|
3
3
|
module Util
|
4
|
+
extend FinchAPI::Internal::Util::SorbetRuntimeSupport
|
5
|
+
|
4
6
|
def self?.monotonic_secs: -> Float
|
5
7
|
|
6
8
|
def self?.arch: -> String
|
@@ -155,6 +157,17 @@ module FinchAPI
|
|
155
157
|
def self?.decode_sse: (
|
156
158
|
Enumerable[String] lines
|
157
159
|
) -> Enumerable[FinchAPI::Internal::Util::server_sent_event]
|
160
|
+
|
161
|
+
module SorbetRuntimeSupport
|
162
|
+
class MissingSorbetRuntimeError < ::RuntimeError
|
163
|
+
end
|
164
|
+
|
165
|
+
private def sorbet_runtime_constants: -> ::Hash[Symbol, top]
|
166
|
+
|
167
|
+
def const_missing: (Symbol name) -> void
|
168
|
+
|
169
|
+
def define_sorbet_constant!: (Symbol name) { -> top } -> void
|
170
|
+
end
|
158
171
|
end
|
159
172
|
end
|
160
173
|
end
|
data/sig/finch_api/internal.rbs
CHANGED
@@ -262,13 +262,14 @@ module FinchAPI
|
|
262
262
|
end
|
263
263
|
end
|
264
264
|
|
265
|
-
type payment_method = :check | :direct_deposit
|
265
|
+
type payment_method = :check | :direct_deposit | :other
|
266
266
|
|
267
267
|
module PaymentMethod
|
268
268
|
extend FinchAPI::Internal::Type::Enum
|
269
269
|
|
270
270
|
CHECK: :check
|
271
271
|
DIRECT_DEPOSIT: :direct_deposit
|
272
|
+
OTHER: :other
|
272
273
|
|
273
274
|
def self?.values: -> ::Array[FinchAPI::HRIS::PayStatement::payment_method]
|
274
275
|
end
|
@@ -295,13 +295,14 @@ module FinchAPI
|
|
295
295
|
end
|
296
296
|
end
|
297
297
|
|
298
|
-
type payment_method = :check | :direct_deposit
|
298
|
+
type payment_method = :check | :direct_deposit | :other
|
299
299
|
|
300
300
|
module PaymentMethod
|
301
301
|
extend FinchAPI::Internal::Type::Enum
|
302
302
|
|
303
303
|
CHECK: :check
|
304
304
|
DIRECT_DEPOSIT: :direct_deposit
|
305
|
+
OTHER: :other
|
305
306
|
|
306
307
|
def self?.values: -> ::Array[FinchAPI::Sandbox::PaymentCreateParams::PayStatement::payment_method]
|
307
308
|
end
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: finch-api
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.1.0.pre.alpha.
|
4
|
+
version: 0.1.0.pre.alpha.17
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Finch
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2025-05-
|
11
|
+
date: 2025-05-16 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: connection_pool
|