finch-api 0.1.0.pre.alpha.41 → 0.1.0.pre.alpha.43
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 +73 -0
- data/README.md +3 -3
- data/lib/finch_api/client.rb +22 -4
- data/lib/finch_api/internal/transport/base_client.rb +30 -3
- data/lib/finch_api/internal/transport/pooled_net_requester.rb +1 -1
- data/lib/finch_api/internal/util.rb +54 -8
- data/lib/finch_api/models/account_disconnect_entity_params.rb +22 -0
- data/lib/finch_api/models/base_webhook_event.rb +9 -1
- data/lib/finch_api/models/connect/session_new_params.rb +5 -3
- data/lib/finch_api/models/connect/session_reauthenticate_params.rb +5 -3
- data/lib/finch_api/models/create_access_token_response.rb +10 -1
- data/lib/finch_api/models/disconnect_entity_response.rb +17 -0
- data/lib/finch_api/models/hris/benefit_contribution.rb +24 -23
- data/lib/finch_api/models/hris/benefit_register_params.rb +47 -0
- data/lib/finch_api/models/hris/benefit_retrieve_params.rb +8 -1
- data/lib/finch_api/models/hris/benefit_update_params.rb +8 -1
- data/lib/finch_api/models/hris/benefits/individual_benefit.rb +63 -59
- data/lib/finch_api/models/hris/benefits/individual_enroll_many_params.rb +8 -1
- data/lib/finch_api/models/hris/benefits/individual_enrolled_ids_params.rb +8 -1
- data/lib/finch_api/models/hris/benefits/individual_retrieve_many_benefits_params.rb +8 -1
- data/lib/finch_api/models/hris/benefits/individual_unenroll_many_params.rb +8 -1
- data/lib/finch_api/models/hris/company/pay_statement_item/rule_delete_params.rb +8 -1
- data/lib/finch_api/models/hris/company/pay_statement_item/rule_update_params.rb +8 -1
- data/lib/finch_api/models/hris/document_retreive_params.rb +8 -1
- data/lib/finch_api/models/hris/employment_data.rb +76 -37
- data/lib/finch_api/models/hris/employment_data_response.rb +2 -2
- data/lib/finch_api/models/hris/individual.rb +38 -28
- data/lib/finch_api/models/hris/individual_response.rb +2 -2
- data/lib/finch_api/models/hris/register_company_benefit_response.rb +26 -0
- data/lib/finch_api/models/introspection.rb +27 -1
- data/lib/finch_api/models/job_completion_event.rb +3 -0
- data/lib/finch_api/models/jobs/automated_create_params.rb +53 -29
- data/lib/finch_api/models/jobs/automated_retrieve_params.rb +7 -1
- data/lib/finch_api/models/jobs/manual_retrieve_params.rb +7 -1
- data/lib/finch_api/models/payroll/pay_group_retrieve_params.rb +8 -1
- data/lib/finch_api/models/sandbox/directory_create_params.rb +55 -4
- data/lib/finch_api/models/sandbox/employment_update_params.rb +58 -4
- data/lib/finch_api/models/sandbox/employment_update_response.rb +53 -4
- data/lib/finch_api/models/sandbox/individual_update_params.rb +8 -1
- data/lib/finch_api/models.rb +4 -0
- data/lib/finch_api/resources/access_tokens.rb +1 -0
- data/lib/finch_api/resources/account.rb +26 -0
- data/lib/finch_api/resources/connect/sessions.rb +4 -2
- data/lib/finch_api/resources/hris/benefits/individuals.rb +13 -5
- data/lib/finch_api/resources/hris/benefits.rb +50 -7
- data/lib/finch_api/resources/hris/company/pay_statement_item/rules.rb +14 -6
- data/lib/finch_api/resources/hris/company/pay_statement_item.rb +3 -1
- data/lib/finch_api/resources/hris/company.rb +3 -1
- data/lib/finch_api/resources/hris/directory.rb +3 -1
- data/lib/finch_api/resources/hris/documents.rb +6 -2
- data/lib/finch_api/resources/hris/employments.rb +4 -2
- data/lib/finch_api/resources/hris/individuals.rb +4 -2
- data/lib/finch_api/resources/hris/pay_statements.rb +4 -2
- data/lib/finch_api/resources/hris/payments.rb +3 -1
- data/lib/finch_api/resources/jobs/automated.rb +8 -7
- data/lib/finch_api/resources/jobs/manual.rb +1 -0
- data/lib/finch_api/resources/payroll/pay_groups.rb +6 -2
- data/lib/finch_api/resources/providers.rb +1 -0
- data/lib/finch_api/resources/request_forwarding.rb +1 -0
- data/lib/finch_api/resources/sandbox/company.rb +1 -0
- data/lib/finch_api/resources/sandbox/connections/accounts.rb +2 -0
- data/lib/finch_api/resources/sandbox/connections.rb +1 -0
- data/lib/finch_api/resources/sandbox/directory.rb +1 -0
- data/lib/finch_api/resources/sandbox/employment.rb +4 -1
- data/lib/finch_api/resources/sandbox/individual.rb +1 -0
- data/lib/finch_api/resources/sandbox/jobs/configuration.rb +2 -0
- data/lib/finch_api/resources/sandbox/jobs.rb +1 -0
- data/lib/finch_api/resources/sandbox/payment.rb +1 -0
- data/lib/finch_api/version.rb +1 -1
- data/lib/finch_api.rb +4 -0
- data/rbi/finch_api/client.rbi +12 -2
- data/rbi/finch_api/internal/transport/base_client.rbi +6 -1
- data/rbi/finch_api/internal/util.rbi +29 -1
- data/rbi/finch_api/models/account_disconnect_entity_params.rbi +46 -0
- data/rbi/finch_api/models/base_webhook_event.rbi +18 -3
- data/rbi/finch_api/models/connect/session_new_params.rbi +11 -3
- data/rbi/finch_api/models/connect/session_reauthenticate_params.rbi +11 -3
- data/rbi/finch_api/models/create_access_token_response.rbi +13 -3
- data/rbi/finch_api/models/disconnect_entity_response.rbi +27 -0
- data/rbi/finch_api/models/hris/benefit_contribution.rbi +33 -31
- data/rbi/finch_api/models/hris/benefit_register_params.rbi +76 -0
- data/rbi/finch_api/models/hris/benefit_retrieve_params.rbi +6 -0
- data/rbi/finch_api/models/hris/benefit_update_params.rbi +6 -0
- data/rbi/finch_api/models/hris/benefits/individual_benefit.rbi +71 -71
- data/rbi/finch_api/models/hris/benefits/individual_enroll_many_params.rbi +6 -0
- data/rbi/finch_api/models/hris/benefits/individual_enrolled_ids_params.rbi +6 -0
- data/rbi/finch_api/models/hris/benefits/individual_retrieve_many_benefits_params.rbi +6 -0
- data/rbi/finch_api/models/hris/benefits/individual_unenroll_many_params.rbi +6 -0
- data/rbi/finch_api/models/hris/company/pay_statement_item/rule_delete_params.rbi +6 -0
- data/rbi/finch_api/models/hris/company/pay_statement_item/rule_update_params.rbi +6 -0
- data/rbi/finch_api/models/hris/document_retreive_params.rbi +6 -0
- data/rbi/finch_api/models/hris/employment_data.rbi +121 -56
- data/rbi/finch_api/models/hris/employment_data_response.rbi +1 -1
- data/rbi/finch_api/models/hris/individual.rbi +54 -47
- data/rbi/finch_api/models/hris/individual_response.rbi +1 -1
- data/rbi/finch_api/models/hris/register_company_benefit_response.rbi +38 -0
- data/rbi/finch_api/models/introspection.rbi +66 -3
- data/rbi/finch_api/models/job_completion_event.rbi +15 -0
- data/rbi/finch_api/models/jobs/automated_create_params.rbi +126 -56
- data/rbi/finch_api/models/jobs/automated_retrieve_params.rbi +13 -5
- data/rbi/finch_api/models/jobs/manual_retrieve_params.rbi +13 -5
- data/rbi/finch_api/models/payroll/pay_group_retrieve_params.rbi +6 -0
- data/rbi/finch_api/models/sandbox/directory_create_params.rbi +122 -9
- data/rbi/finch_api/models/sandbox/employment_update_params.rbi +128 -9
- data/rbi/finch_api/models/sandbox/employment_update_response.rbi +122 -9
- data/rbi/finch_api/models/sandbox/individual_update_params.rbi +6 -0
- data/rbi/finch_api/models.rbi +5 -0
- data/rbi/finch_api/resources/account.rbi +15 -0
- data/rbi/finch_api/resources/connect/sessions.rbi +6 -2
- data/rbi/finch_api/resources/hris/benefits.rbi +24 -0
- data/rbi/finch_api/resources/jobs/automated.rbi +6 -8
- data/rbi/finch_api/resources/sandbox/employment.rbi +7 -0
- data/sig/finch_api/client.rbs +6 -1
- data/sig/finch_api/internal/transport/base_client.rbs +2 -0
- data/sig/finch_api/internal/util.rbs +14 -0
- data/sig/finch_api/models/account_disconnect_entity_params.rbs +24 -0
- data/sig/finch_api/models/base_webhook_event.rbs +14 -3
- data/sig/finch_api/models/connect/session_new_params.rbs +2 -0
- data/sig/finch_api/models/connect/session_reauthenticate_params.rbs +2 -0
- data/sig/finch_api/models/create_access_token_response.rbs +8 -3
- data/sig/finch_api/models/disconnect_entity_response.rbs +13 -0
- data/sig/finch_api/models/hris/benefit_contribution.rbs +28 -28
- data/sig/finch_api/models/hris/benefit_register_params.rbs +47 -0
- data/sig/finch_api/models/hris/benefit_retrieve_params.rbs +5 -1
- data/sig/finch_api/models/hris/benefit_update_params.rbs +5 -1
- data/sig/finch_api/models/hris/benefits/individual_benefit.rbs +62 -62
- data/sig/finch_api/models/hris/benefits/individual_enroll_many_params.rbs +5 -0
- data/sig/finch_api/models/hris/benefits/individual_enrolled_ids_params.rbs +5 -1
- data/sig/finch_api/models/hris/benefits/individual_retrieve_many_benefits_params.rbs +9 -1
- data/sig/finch_api/models/hris/benefits/individual_unenroll_many_params.rbs +9 -1
- data/sig/finch_api/models/hris/company/pay_statement_item/rule_delete_params.rbs +5 -1
- data/sig/finch_api/models/hris/company/pay_statement_item/rule_update_params.rbs +9 -1
- data/sig/finch_api/models/hris/document_retreive_params.rbs +5 -1
- data/sig/finch_api/models/hris/employment_data.rbs +56 -39
- data/sig/finch_api/models/hris/individual.rbs +31 -31
- data/sig/finch_api/models/hris/register_company_benefit_response.rbs +18 -0
- data/sig/finch_api/models/introspection.rbs +44 -3
- data/sig/finch_api/models/job_completion_event.rbs +6 -0
- data/sig/finch_api/models/jobs/automated_create_params.rbs +47 -22
- data/sig/finch_api/models/jobs/automated_retrieve_params.rbs +11 -3
- data/sig/finch_api/models/jobs/manual_retrieve_params.rbs +11 -3
- data/sig/finch_api/models/payroll/pay_group_retrieve_params.rbs +5 -1
- data/sig/finch_api/models/sandbox/directory_create_params.rbs +40 -5
- data/sig/finch_api/models/sandbox/employment_update_params.rbs +45 -5
- data/sig/finch_api/models/sandbox/employment_update_response.rbs +40 -5
- data/sig/finch_api/models/sandbox/individual_update_params.rbs +5 -0
- data/sig/finch_api/models.rbs +4 -0
- data/sig/finch_api/resources/account.rbs +5 -0
- data/sig/finch_api/resources/hris/benefits.rbs +8 -0
- data/sig/finch_api/resources/jobs/automated.rbs +1 -2
- data/sig/finch_api/resources/sandbox/employment.rbs +1 -0
- metadata +14 -2
|
@@ -16,6 +16,9 @@ module FinchAPI
|
|
|
16
16
|
)
|
|
17
17
|
end
|
|
18
18
|
|
|
19
|
+
sig { returns(String) }
|
|
20
|
+
attr_accessor :benefit_id
|
|
21
|
+
|
|
19
22
|
# The entity IDs to specify which entities' data to access.
|
|
20
23
|
sig { returns(T.nilable(T::Array[String])) }
|
|
21
24
|
attr_reader :entity_ids
|
|
@@ -47,6 +50,7 @@ module FinchAPI
|
|
|
47
50
|
|
|
48
51
|
sig do
|
|
49
52
|
params(
|
|
53
|
+
benefit_id: String,
|
|
50
54
|
entity_ids: T::Array[String],
|
|
51
55
|
individuals:
|
|
52
56
|
T::Array[
|
|
@@ -56,6 +60,7 @@ module FinchAPI
|
|
|
56
60
|
).returns(T.attached_class)
|
|
57
61
|
end
|
|
58
62
|
def self.new(
|
|
63
|
+
benefit_id:,
|
|
59
64
|
# The entity IDs to specify which entities' data to access.
|
|
60
65
|
entity_ids: nil,
|
|
61
66
|
# Array of the individual_id to enroll and a configuration object.
|
|
@@ -67,6 +72,7 @@ module FinchAPI
|
|
|
67
72
|
sig do
|
|
68
73
|
override.returns(
|
|
69
74
|
{
|
|
75
|
+
benefit_id: String,
|
|
70
76
|
entity_ids: T::Array[String],
|
|
71
77
|
individuals:
|
|
72
78
|
T::Array[
|
|
@@ -16,6 +16,9 @@ module FinchAPI
|
|
|
16
16
|
)
|
|
17
17
|
end
|
|
18
18
|
|
|
19
|
+
sig { returns(String) }
|
|
20
|
+
attr_accessor :benefit_id
|
|
21
|
+
|
|
19
22
|
# The entity IDs to specify which entities' data to access.
|
|
20
23
|
sig { returns(T.nilable(T::Array[String])) }
|
|
21
24
|
attr_reader :entity_ids
|
|
@@ -25,11 +28,13 @@ module FinchAPI
|
|
|
25
28
|
|
|
26
29
|
sig do
|
|
27
30
|
params(
|
|
31
|
+
benefit_id: String,
|
|
28
32
|
entity_ids: T::Array[String],
|
|
29
33
|
request_options: FinchAPI::RequestOptions::OrHash
|
|
30
34
|
).returns(T.attached_class)
|
|
31
35
|
end
|
|
32
36
|
def self.new(
|
|
37
|
+
benefit_id:,
|
|
33
38
|
# The entity IDs to specify which entities' data to access.
|
|
34
39
|
entity_ids: nil,
|
|
35
40
|
request_options: {}
|
|
@@ -39,6 +44,7 @@ module FinchAPI
|
|
|
39
44
|
sig do
|
|
40
45
|
override.returns(
|
|
41
46
|
{
|
|
47
|
+
benefit_id: String,
|
|
42
48
|
entity_ids: T::Array[String],
|
|
43
49
|
request_options: FinchAPI::RequestOptions
|
|
44
50
|
}
|
|
@@ -16,6 +16,9 @@ module FinchAPI
|
|
|
16
16
|
)
|
|
17
17
|
end
|
|
18
18
|
|
|
19
|
+
sig { returns(String) }
|
|
20
|
+
attr_accessor :benefit_id
|
|
21
|
+
|
|
19
22
|
# The entity IDs to specify which entities' data to access.
|
|
20
23
|
sig { returns(T.nilable(T::Array[String])) }
|
|
21
24
|
attr_reader :entity_ids
|
|
@@ -33,12 +36,14 @@ module FinchAPI
|
|
|
33
36
|
|
|
34
37
|
sig do
|
|
35
38
|
params(
|
|
39
|
+
benefit_id: String,
|
|
36
40
|
entity_ids: T::Array[String],
|
|
37
41
|
individual_ids: String,
|
|
38
42
|
request_options: FinchAPI::RequestOptions::OrHash
|
|
39
43
|
).returns(T.attached_class)
|
|
40
44
|
end
|
|
41
45
|
def self.new(
|
|
46
|
+
benefit_id:,
|
|
42
47
|
# The entity IDs to specify which entities' data to access.
|
|
43
48
|
entity_ids: nil,
|
|
44
49
|
# comma-delimited list of stable Finch uuids for each individual. If empty,
|
|
@@ -51,6 +56,7 @@ module FinchAPI
|
|
|
51
56
|
sig do
|
|
52
57
|
override.returns(
|
|
53
58
|
{
|
|
59
|
+
benefit_id: String,
|
|
54
60
|
entity_ids: T::Array[String],
|
|
55
61
|
individual_ids: String,
|
|
56
62
|
request_options: FinchAPI::RequestOptions
|
|
@@ -16,6 +16,9 @@ module FinchAPI
|
|
|
16
16
|
)
|
|
17
17
|
end
|
|
18
18
|
|
|
19
|
+
sig { returns(String) }
|
|
20
|
+
attr_accessor :benefit_id
|
|
21
|
+
|
|
19
22
|
# The entity IDs to specify which entities' data to access.
|
|
20
23
|
sig { returns(T.nilable(T::Array[String])) }
|
|
21
24
|
attr_reader :entity_ids
|
|
@@ -32,12 +35,14 @@ module FinchAPI
|
|
|
32
35
|
|
|
33
36
|
sig do
|
|
34
37
|
params(
|
|
38
|
+
benefit_id: String,
|
|
35
39
|
entity_ids: T::Array[String],
|
|
36
40
|
individual_ids: T::Array[String],
|
|
37
41
|
request_options: FinchAPI::RequestOptions::OrHash
|
|
38
42
|
).returns(T.attached_class)
|
|
39
43
|
end
|
|
40
44
|
def self.new(
|
|
45
|
+
benefit_id:,
|
|
41
46
|
# The entity IDs to specify which entities' data to access.
|
|
42
47
|
entity_ids: nil,
|
|
43
48
|
# Array of individual_ids to unenroll.
|
|
@@ -49,6 +54,7 @@ module FinchAPI
|
|
|
49
54
|
sig do
|
|
50
55
|
override.returns(
|
|
51
56
|
{
|
|
57
|
+
benefit_id: String,
|
|
52
58
|
entity_ids: T::Array[String],
|
|
53
59
|
individual_ids: T::Array[String],
|
|
54
60
|
request_options: FinchAPI::RequestOptions
|
|
@@ -17,6 +17,9 @@ module FinchAPI
|
|
|
17
17
|
)
|
|
18
18
|
end
|
|
19
19
|
|
|
20
|
+
sig { returns(String) }
|
|
21
|
+
attr_accessor :rule_id
|
|
22
|
+
|
|
20
23
|
# The entity IDs to delete the rule for.
|
|
21
24
|
sig { returns(T.nilable(T::Array[String])) }
|
|
22
25
|
attr_reader :entity_ids
|
|
@@ -26,11 +29,13 @@ module FinchAPI
|
|
|
26
29
|
|
|
27
30
|
sig do
|
|
28
31
|
params(
|
|
32
|
+
rule_id: String,
|
|
29
33
|
entity_ids: T::Array[String],
|
|
30
34
|
request_options: FinchAPI::RequestOptions::OrHash
|
|
31
35
|
).returns(T.attached_class)
|
|
32
36
|
end
|
|
33
37
|
def self.new(
|
|
38
|
+
rule_id:,
|
|
34
39
|
# The entity IDs to delete the rule for.
|
|
35
40
|
entity_ids: nil,
|
|
36
41
|
request_options: {}
|
|
@@ -40,6 +45,7 @@ module FinchAPI
|
|
|
40
45
|
sig do
|
|
41
46
|
override.returns(
|
|
42
47
|
{
|
|
48
|
+
rule_id: String,
|
|
43
49
|
entity_ids: T::Array[String],
|
|
44
50
|
request_options: FinchAPI::RequestOptions
|
|
45
51
|
}
|
|
@@ -17,6 +17,9 @@ module FinchAPI
|
|
|
17
17
|
)
|
|
18
18
|
end
|
|
19
19
|
|
|
20
|
+
sig { returns(String) }
|
|
21
|
+
attr_accessor :rule_id
|
|
22
|
+
|
|
20
23
|
# The entity IDs to update the rule for.
|
|
21
24
|
sig { returns(T.nilable(T::Array[String])) }
|
|
22
25
|
attr_reader :entity_ids
|
|
@@ -32,12 +35,14 @@ module FinchAPI
|
|
|
32
35
|
|
|
33
36
|
sig do
|
|
34
37
|
params(
|
|
38
|
+
rule_id: String,
|
|
35
39
|
entity_ids: T::Array[String],
|
|
36
40
|
optional_property: T.anything,
|
|
37
41
|
request_options: FinchAPI::RequestOptions::OrHash
|
|
38
42
|
).returns(T.attached_class)
|
|
39
43
|
end
|
|
40
44
|
def self.new(
|
|
45
|
+
rule_id:,
|
|
41
46
|
# The entity IDs to update the rule for.
|
|
42
47
|
entity_ids: nil,
|
|
43
48
|
optional_property: nil,
|
|
@@ -48,6 +53,7 @@ module FinchAPI
|
|
|
48
53
|
sig do
|
|
49
54
|
override.returns(
|
|
50
55
|
{
|
|
56
|
+
rule_id: String,
|
|
51
57
|
entity_ids: T::Array[String],
|
|
52
58
|
optional_property: T.anything,
|
|
53
59
|
request_options: FinchAPI::RequestOptions
|
|
@@ -15,6 +15,9 @@ module FinchAPI
|
|
|
15
15
|
)
|
|
16
16
|
end
|
|
17
17
|
|
|
18
|
+
sig { returns(String) }
|
|
19
|
+
attr_accessor :document_id
|
|
20
|
+
|
|
18
21
|
# The entity IDs to specify which entities' data to access.
|
|
19
22
|
sig { returns(T.nilable(T::Array[String])) }
|
|
20
23
|
attr_reader :entity_ids
|
|
@@ -24,11 +27,13 @@ module FinchAPI
|
|
|
24
27
|
|
|
25
28
|
sig do
|
|
26
29
|
params(
|
|
30
|
+
document_id: String,
|
|
27
31
|
entity_ids: T::Array[String],
|
|
28
32
|
request_options: FinchAPI::RequestOptions::OrHash
|
|
29
33
|
).returns(T.attached_class)
|
|
30
34
|
end
|
|
31
35
|
def self.new(
|
|
36
|
+
document_id:,
|
|
32
37
|
# The entity IDs to specify which entities' data to access.
|
|
33
38
|
entity_ids: nil,
|
|
34
39
|
request_options: {}
|
|
@@ -38,6 +43,7 @@ module FinchAPI
|
|
|
38
43
|
sig do
|
|
39
44
|
override.returns(
|
|
40
45
|
{
|
|
46
|
+
document_id: String,
|
|
41
47
|
entity_ids: T::Array[String],
|
|
42
48
|
request_options: FinchAPI::RequestOptions
|
|
43
49
|
}
|