finch-api 0.1.0.pre.alpha.47 → 0.1.0.pre.alpha.48
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 +8 -0
- data/README.md +1 -1
- data/lib/finch_api/models/hris/directory_list_individuals_params.rb +2 -2
- data/lib/finch_api/models/hris/directory_list_params.rb +2 -2
- data/lib/finch_api/models/hris/employment_retrieve_many_params.rb +4 -10
- data/lib/finch_api/models/hris/individual_retrieve_many_params.rb +19 -18
- data/lib/finch_api/models/hris/pay_statement_retrieve_many_params.rb +4 -4
- data/lib/finch_api/resources/hris/directory.rb +1 -1
- data/lib/finch_api/resources/hris/employments.rb +1 -1
- data/lib/finch_api/resources/hris/individuals.rb +4 -4
- data/lib/finch_api/resources/hris/pay_statements.rb +1 -1
- data/lib/finch_api/version.rb +1 -1
- data/rbi/finch_api/models/hris/directory_list_individuals_params.rbi +2 -2
- data/rbi/finch_api/models/hris/directory_list_params.rbi +2 -2
- data/rbi/finch_api/models/hris/employment_retrieve_many_params.rbi +4 -8
- data/rbi/finch_api/models/hris/individual_retrieve_many_params.rbi +29 -42
- data/rbi/finch_api/models/hris/pay_statement_retrieve_many_params.rbi +4 -4
- data/rbi/finch_api/resources/hris/directory.rbi +1 -1
- data/rbi/finch_api/resources/hris/employments.rbi +1 -1
- data/rbi/finch_api/resources/hris/individuals.rbi +6 -6
- data/rbi/finch_api/resources/hris/pay_statements.rbi +1 -1
- data/sig/finch_api/models/hris/individual_retrieve_many_params.rbs +16 -22
- data/sig/finch_api/resources/hris/individuals.rbs +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 6a516f81f01b9ea7b24c991040f7e588ce4f22f522774c44bda36f84fa4c0d95
|
|
4
|
+
data.tar.gz: 698f1bb3796033699051458fe674ee2c37c8054f57044b18be53d5a3083997c2
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: '09ef57663d79aebd52343bc5c40e7120ae29687dfbf6e1a471c120ddae9dec213b544cb4fc0e0b3b9a14920f6cc3d13a48eb159b1f6e762d2d5a6fbcbf2c2359'
|
|
7
|
+
data.tar.gz: 8f1be6bedac4265bb4587fa9788d87c5a0278072772c196d5e55f7b7f1e8bbc03d980d69d4d7a7674fc14b6cb2dee1ab022b05c7eb8537eabc3531998144fe35
|
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,13 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 0.1.0-alpha.48 (2026-07-13)
|
|
4
|
+
|
|
5
|
+
Full Changelog: [v0.1.0-alpha.47...v0.1.0-alpha.48](https://github.com/Finch-API/finch-api-ruby/compare/v0.1.0-alpha.47...v0.1.0-alpha.48)
|
|
6
|
+
|
|
7
|
+
### Features
|
|
8
|
+
|
|
9
|
+
* **api:** api update ([69e8027](https://github.com/Finch-API/finch-api-ruby/commit/69e8027b72120985c9e601d517162a0225f3dd6d))
|
|
10
|
+
|
|
3
11
|
## 0.1.0-alpha.47 (2026-07-01)
|
|
4
12
|
|
|
5
13
|
Full Changelog: [v0.1.0-alpha.46...v0.1.0-alpha.47](https://github.com/Finch-API/finch-api-ruby/compare/v0.1.0-alpha.46...v0.1.0-alpha.47)
|
data/README.md
CHANGED
|
@@ -26,7 +26,7 @@ To use this gem, install via Bundler by adding the following to your application
|
|
|
26
26
|
<!-- x-release-please-start-version -->
|
|
27
27
|
|
|
28
28
|
```ruby
|
|
29
|
-
gem "finch-api", "~> 0.1.0.pre.alpha.
|
|
29
|
+
gem "finch-api", "~> 0.1.0.pre.alpha.48"
|
|
30
30
|
```
|
|
31
31
|
|
|
32
32
|
<!-- x-release-please-end -->
|
|
@@ -15,7 +15,7 @@ module FinchAPI
|
|
|
15
15
|
optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String]
|
|
16
16
|
|
|
17
17
|
# @!attribute limit
|
|
18
|
-
# Number of employees to return (defaults to
|
|
18
|
+
# Number of employees to return (defaults to 100, maximum 10000)
|
|
19
19
|
#
|
|
20
20
|
# @return [Integer, nil]
|
|
21
21
|
optional :limit, Integer
|
|
@@ -29,7 +29,7 @@ module FinchAPI
|
|
|
29
29
|
# @!method initialize(entity_ids: nil, limit: nil, offset: nil, request_options: {})
|
|
30
30
|
# @param entity_ids [Array<String>] The entity IDs to specify which entities' data to access.
|
|
31
31
|
#
|
|
32
|
-
# @param limit [Integer] Number of employees to return (defaults to
|
|
32
|
+
# @param limit [Integer] Number of employees to return (defaults to 100, maximum 10000)
|
|
33
33
|
#
|
|
34
34
|
# @param offset [Integer] Index to start from (defaults to 0)
|
|
35
35
|
#
|
|
@@ -15,7 +15,7 @@ module FinchAPI
|
|
|
15
15
|
optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String]
|
|
16
16
|
|
|
17
17
|
# @!attribute limit
|
|
18
|
-
# Number of employees to return (defaults to
|
|
18
|
+
# Number of employees to return (defaults to 100, maximum 10000)
|
|
19
19
|
#
|
|
20
20
|
# @return [Integer, nil]
|
|
21
21
|
optional :limit, Integer
|
|
@@ -29,7 +29,7 @@ module FinchAPI
|
|
|
29
29
|
# @!method initialize(entity_ids: nil, limit: nil, offset: nil, request_options: {})
|
|
30
30
|
# @param entity_ids [Array<String>] The entity IDs to specify which entities' data to access.
|
|
31
31
|
#
|
|
32
|
-
# @param limit [Integer] Number of employees to return (defaults to
|
|
32
|
+
# @param limit [Integer] Number of employees to return (defaults to 100, maximum 10000)
|
|
33
33
|
#
|
|
34
34
|
# @param offset [Integer] Index to start from (defaults to 0)
|
|
35
35
|
#
|
|
@@ -9,7 +9,7 @@ module FinchAPI
|
|
|
9
9
|
include FinchAPI::Internal::Type::RequestParameters
|
|
10
10
|
|
|
11
11
|
# @!attribute requests
|
|
12
|
-
# The array of batch requests.
|
|
12
|
+
# The array of batch requests. Maximum 10000 items per request.
|
|
13
13
|
#
|
|
14
14
|
# @return [Array<FinchAPI::Models::HRIS::EmploymentRetrieveManyParams::Request>]
|
|
15
15
|
required :requests,
|
|
@@ -22,7 +22,7 @@ module FinchAPI
|
|
|
22
22
|
optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String]
|
|
23
23
|
|
|
24
24
|
# @!method initialize(requests:, entity_ids: nil, request_options: {})
|
|
25
|
-
# @param requests [Array<FinchAPI::Models::HRIS::EmploymentRetrieveManyParams::Request>] The array of batch requests.
|
|
25
|
+
# @param requests [Array<FinchAPI::Models::HRIS::EmploymentRetrieveManyParams::Request>] The array of batch requests. Maximum 10000 items per request.
|
|
26
26
|
#
|
|
27
27
|
# @param entity_ids [Array<String>] The entity IDs to specify which entities' data to access.
|
|
28
28
|
#
|
|
@@ -30,19 +30,13 @@ module FinchAPI
|
|
|
30
30
|
|
|
31
31
|
class Request < FinchAPI::Internal::Type::BaseModel
|
|
32
32
|
# @!attribute individual_id
|
|
33
|
-
# A stable Finch `id` (UUID v4) for an individual in the company.
|
|
34
|
-
# limit to the number of `individual_id` to send per request. It is preferantial
|
|
35
|
-
# to send all ids in a single request for Finch to optimize provider rate-limits.
|
|
33
|
+
# A stable Finch `id` (UUID v4) for an individual in the company.
|
|
36
34
|
#
|
|
37
35
|
# @return [String]
|
|
38
36
|
required :individual_id, String
|
|
39
37
|
|
|
40
38
|
# @!method initialize(individual_id:)
|
|
41
|
-
#
|
|
42
|
-
# {FinchAPI::Models::HRIS::EmploymentRetrieveManyParams::Request} for more
|
|
43
|
-
# details.
|
|
44
|
-
#
|
|
45
|
-
# @param individual_id [String] A stable Finch `id` (UUID v4) for an individual in the company. There is no limi
|
|
39
|
+
# @param individual_id [String] A stable Finch `id` (UUID v4) for an individual in the company.
|
|
46
40
|
end
|
|
47
41
|
end
|
|
48
42
|
end
|
|
@@ -8,6 +8,13 @@ module FinchAPI
|
|
|
8
8
|
extend FinchAPI::Internal::Type::RequestParameters::Converter
|
|
9
9
|
include FinchAPI::Internal::Type::RequestParameters
|
|
10
10
|
|
|
11
|
+
# @!attribute requests
|
|
12
|
+
# The array of batch requests. Maximum 10000 items per request.
|
|
13
|
+
#
|
|
14
|
+
# @return [Array<FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Request>]
|
|
15
|
+
required :requests,
|
|
16
|
+
-> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::IndividualRetrieveManyParams::Request] }
|
|
17
|
+
|
|
11
18
|
# @!attribute entity_ids
|
|
12
19
|
# The entity IDs to specify which entities' data to access.
|
|
13
20
|
#
|
|
@@ -19,21 +26,25 @@ module FinchAPI
|
|
|
19
26
|
# @return [FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Options, nil]
|
|
20
27
|
optional :options, -> { FinchAPI::HRIS::IndividualRetrieveManyParams::Options }, nil?: true
|
|
21
28
|
|
|
22
|
-
# @!
|
|
29
|
+
# @!method initialize(requests:, entity_ids: nil, options: nil, request_options: {})
|
|
30
|
+
# @param requests [Array<FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Request>] The array of batch requests. Maximum 10000 items per request.
|
|
23
31
|
#
|
|
24
|
-
# @return [Array<FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Request>, nil]
|
|
25
|
-
optional :requests,
|
|
26
|
-
-> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::IndividualRetrieveManyParams::Request] }
|
|
27
|
-
|
|
28
|
-
# @!method initialize(entity_ids: nil, options: nil, requests: nil, request_options: {})
|
|
29
32
|
# @param entity_ids [Array<String>] The entity IDs to specify which entities' data to access.
|
|
30
33
|
#
|
|
31
34
|
# @param options [FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Options, nil]
|
|
32
35
|
#
|
|
33
|
-
# @param requests [Array<FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Request>]
|
|
34
|
-
#
|
|
35
36
|
# @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
|
|
36
37
|
|
|
38
|
+
class Request < FinchAPI::Internal::Type::BaseModel
|
|
39
|
+
# @!attribute individual_id
|
|
40
|
+
#
|
|
41
|
+
# @return [String]
|
|
42
|
+
required :individual_id, String
|
|
43
|
+
|
|
44
|
+
# @!method initialize(individual_id:)
|
|
45
|
+
# @param individual_id [String]
|
|
46
|
+
end
|
|
47
|
+
|
|
37
48
|
class Options < FinchAPI::Internal::Type::BaseModel
|
|
38
49
|
# @!attribute include
|
|
39
50
|
#
|
|
@@ -43,16 +54,6 @@ module FinchAPI
|
|
|
43
54
|
# @!method initialize(include: nil)
|
|
44
55
|
# @param include [Array<String>]
|
|
45
56
|
end
|
|
46
|
-
|
|
47
|
-
class Request < FinchAPI::Internal::Type::BaseModel
|
|
48
|
-
# @!attribute individual_id
|
|
49
|
-
#
|
|
50
|
-
# @return [String, nil]
|
|
51
|
-
optional :individual_id, String
|
|
52
|
-
|
|
53
|
-
# @!method initialize(individual_id: nil)
|
|
54
|
-
# @param individual_id [String]
|
|
55
|
-
end
|
|
56
57
|
end
|
|
57
58
|
end
|
|
58
59
|
end
|
|
@@ -9,7 +9,7 @@ module FinchAPI
|
|
|
9
9
|
include FinchAPI::Internal::Type::RequestParameters
|
|
10
10
|
|
|
11
11
|
# @!attribute requests
|
|
12
|
-
# The array of batch requests.
|
|
12
|
+
# The array of batch requests. Maximum 10 payment_ids per request.
|
|
13
13
|
#
|
|
14
14
|
# @return [Array<FinchAPI::Models::HRIS::PayStatementRetrieveManyParams::Request>]
|
|
15
15
|
required :requests,
|
|
@@ -22,7 +22,7 @@ module FinchAPI
|
|
|
22
22
|
optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String]
|
|
23
23
|
|
|
24
24
|
# @!method initialize(requests:, entity_ids: nil, request_options: {})
|
|
25
|
-
# @param requests [Array<FinchAPI::Models::HRIS::PayStatementRetrieveManyParams::Request>] The array of batch requests.
|
|
25
|
+
# @param requests [Array<FinchAPI::Models::HRIS::PayStatementRetrieveManyParams::Request>] The array of batch requests. Maximum 10 payment_ids per request.
|
|
26
26
|
#
|
|
27
27
|
# @param entity_ids [Array<String>] The entity IDs to specify which entities' data to access.
|
|
28
28
|
#
|
|
@@ -36,7 +36,7 @@ module FinchAPI
|
|
|
36
36
|
required :payment_id, String
|
|
37
37
|
|
|
38
38
|
# @!attribute limit
|
|
39
|
-
# Number of pay statements to return (defaults to
|
|
39
|
+
# Number of pay statements to return (defaults to 100, maximum 5000).
|
|
40
40
|
#
|
|
41
41
|
# @return [Integer, nil]
|
|
42
42
|
optional :limit, Integer
|
|
@@ -50,7 +50,7 @@ module FinchAPI
|
|
|
50
50
|
# @!method initialize(payment_id:, limit: nil, offset: nil)
|
|
51
51
|
# @param payment_id [String] A stable Finch `id` (UUID v4) for a payment.
|
|
52
52
|
#
|
|
53
|
-
# @param limit [Integer] Number of pay statements to return (defaults to
|
|
53
|
+
# @param limit [Integer] Number of pay statements to return (defaults to 100, maximum 5000).
|
|
54
54
|
#
|
|
55
55
|
# @param offset [Integer] Index to start from.
|
|
56
56
|
end
|
|
@@ -10,7 +10,7 @@ module FinchAPI
|
|
|
10
10
|
#
|
|
11
11
|
# @param entity_ids [Array<String>] The entity IDs to specify which entities' data to access.
|
|
12
12
|
#
|
|
13
|
-
# @param limit [Integer] Number of employees to return (defaults to
|
|
13
|
+
# @param limit [Integer] Number of employees to return (defaults to 100, maximum 10000)
|
|
14
14
|
#
|
|
15
15
|
# @param offset [Integer] Index to start from (defaults to 0)
|
|
16
16
|
#
|
|
@@ -8,7 +8,7 @@ module FinchAPI
|
|
|
8
8
|
#
|
|
9
9
|
# @overload retrieve_many(requests:, entity_ids: nil, request_options: {})
|
|
10
10
|
#
|
|
11
|
-
# @param requests [Array<FinchAPI::Models::HRIS::EmploymentRetrieveManyParams::Request>] Body param: The array of batch requests.
|
|
11
|
+
# @param requests [Array<FinchAPI::Models::HRIS::EmploymentRetrieveManyParams::Request>] Body param: The array of batch requests. Maximum 10000 items per request.
|
|
12
12
|
#
|
|
13
13
|
# @param entity_ids [Array<String>] Query param: The entity IDs to specify which entities' data to access.
|
|
14
14
|
#
|
|
@@ -6,20 +6,20 @@ module FinchAPI
|
|
|
6
6
|
class Individuals
|
|
7
7
|
# Read individual data, excluding income and employment data
|
|
8
8
|
#
|
|
9
|
-
# @overload retrieve_many(entity_ids: nil, options: nil,
|
|
9
|
+
# @overload retrieve_many(requests:, entity_ids: nil, options: nil, request_options: {})
|
|
10
|
+
#
|
|
11
|
+
# @param requests [Array<FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Request>] Body param: The array of batch requests. Maximum 10000 items per request.
|
|
10
12
|
#
|
|
11
13
|
# @param entity_ids [Array<String>] Query param: The entity IDs to specify which entities' data to access.
|
|
12
14
|
#
|
|
13
15
|
# @param options [FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Options, nil] Body param
|
|
14
16
|
#
|
|
15
|
-
# @param requests [Array<FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Request>] Body param
|
|
16
|
-
#
|
|
17
17
|
# @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
18
18
|
#
|
|
19
19
|
# @return [FinchAPI::Internal::ResponsesPage<FinchAPI::Models::HRIS::IndividualResponse>]
|
|
20
20
|
#
|
|
21
21
|
# @see FinchAPI::Models::HRIS::IndividualRetrieveManyParams
|
|
22
|
-
def retrieve_many(params
|
|
22
|
+
def retrieve_many(params)
|
|
23
23
|
query_params = [:entity_ids]
|
|
24
24
|
parsed, options = FinchAPI::HRIS::IndividualRetrieveManyParams.dump_request(params)
|
|
25
25
|
query = FinchAPI::Internal::Util.encode_query_params(parsed.slice(*query_params))
|
|
@@ -11,7 +11,7 @@ module FinchAPI
|
|
|
11
11
|
#
|
|
12
12
|
# @overload retrieve_many(requests:, entity_ids: nil, request_options: {})
|
|
13
13
|
#
|
|
14
|
-
# @param requests [Array<FinchAPI::Models::HRIS::PayStatementRetrieveManyParams::Request>] Body param: The array of batch requests.
|
|
14
|
+
# @param requests [Array<FinchAPI::Models::HRIS::PayStatementRetrieveManyParams::Request>] Body param: The array of batch requests. Maximum 10 payment_ids per request.
|
|
15
15
|
#
|
|
16
16
|
# @param entity_ids [Array<String>] Query param: The entity IDs to specify which entities' data to access.
|
|
17
17
|
#
|
data/lib/finch_api/version.rb
CHANGED
|
@@ -22,7 +22,7 @@ module FinchAPI
|
|
|
22
22
|
sig { params(entity_ids: T::Array[String]).void }
|
|
23
23
|
attr_writer :entity_ids
|
|
24
24
|
|
|
25
|
-
# Number of employees to return (defaults to
|
|
25
|
+
# Number of employees to return (defaults to 100, maximum 10000)
|
|
26
26
|
sig { returns(T.nilable(Integer)) }
|
|
27
27
|
attr_reader :limit
|
|
28
28
|
|
|
@@ -47,7 +47,7 @@ module FinchAPI
|
|
|
47
47
|
def self.new(
|
|
48
48
|
# The entity IDs to specify which entities' data to access.
|
|
49
49
|
entity_ids: nil,
|
|
50
|
-
# Number of employees to return (defaults to
|
|
50
|
+
# Number of employees to return (defaults to 100, maximum 10000)
|
|
51
51
|
limit: nil,
|
|
52
52
|
# Index to start from (defaults to 0)
|
|
53
53
|
offset: nil,
|
|
@@ -22,7 +22,7 @@ module FinchAPI
|
|
|
22
22
|
sig { params(entity_ids: T::Array[String]).void }
|
|
23
23
|
attr_writer :entity_ids
|
|
24
24
|
|
|
25
|
-
# Number of employees to return (defaults to
|
|
25
|
+
# Number of employees to return (defaults to 100, maximum 10000)
|
|
26
26
|
sig { returns(T.nilable(Integer)) }
|
|
27
27
|
attr_reader :limit
|
|
28
28
|
|
|
@@ -47,7 +47,7 @@ module FinchAPI
|
|
|
47
47
|
def self.new(
|
|
48
48
|
# The entity IDs to specify which entities' data to access.
|
|
49
49
|
entity_ids: nil,
|
|
50
|
-
# Number of employees to return (defaults to
|
|
50
|
+
# Number of employees to return (defaults to 100, maximum 10000)
|
|
51
51
|
limit: nil,
|
|
52
52
|
# Index to start from (defaults to 0)
|
|
53
53
|
offset: nil,
|
|
@@ -15,7 +15,7 @@ module FinchAPI
|
|
|
15
15
|
)
|
|
16
16
|
end
|
|
17
17
|
|
|
18
|
-
# The array of batch requests.
|
|
18
|
+
# The array of batch requests. Maximum 10000 items per request.
|
|
19
19
|
sig do
|
|
20
20
|
returns(
|
|
21
21
|
T::Array[FinchAPI::HRIS::EmploymentRetrieveManyParams::Request]
|
|
@@ -41,7 +41,7 @@ module FinchAPI
|
|
|
41
41
|
).returns(T.attached_class)
|
|
42
42
|
end
|
|
43
43
|
def self.new(
|
|
44
|
-
# The array of batch requests.
|
|
44
|
+
# The array of batch requests. Maximum 10000 items per request.
|
|
45
45
|
requests:,
|
|
46
46
|
# The entity IDs to specify which entities' data to access.
|
|
47
47
|
entity_ids: nil,
|
|
@@ -71,17 +71,13 @@ module FinchAPI
|
|
|
71
71
|
)
|
|
72
72
|
end
|
|
73
73
|
|
|
74
|
-
# A stable Finch `id` (UUID v4) for an individual in the company.
|
|
75
|
-
# limit to the number of `individual_id` to send per request. It is preferantial
|
|
76
|
-
# to send all ids in a single request for Finch to optimize provider rate-limits.
|
|
74
|
+
# A stable Finch `id` (UUID v4) for an individual in the company.
|
|
77
75
|
sig { returns(String) }
|
|
78
76
|
attr_accessor :individual_id
|
|
79
77
|
|
|
80
78
|
sig { params(individual_id: String).returns(T.attached_class) }
|
|
81
79
|
def self.new(
|
|
82
|
-
# A stable Finch `id` (UUID v4) for an individual in the company.
|
|
83
|
-
# limit to the number of `individual_id` to send per request. It is preferantial
|
|
84
|
-
# to send all ids in a single request for Finch to optimize provider rate-limits.
|
|
80
|
+
# A stable Finch `id` (UUID v4) for an individual in the company.
|
|
85
81
|
individual_id:
|
|
86
82
|
)
|
|
87
83
|
end
|
|
@@ -15,6 +15,14 @@ module FinchAPI
|
|
|
15
15
|
)
|
|
16
16
|
end
|
|
17
17
|
|
|
18
|
+
# The array of batch requests. Maximum 10000 items per request.
|
|
19
|
+
sig do
|
|
20
|
+
returns(
|
|
21
|
+
T::Array[FinchAPI::HRIS::IndividualRetrieveManyParams::Request]
|
|
22
|
+
)
|
|
23
|
+
end
|
|
24
|
+
attr_accessor :requests
|
|
25
|
+
|
|
18
26
|
# The entity IDs to specify which entities' data to access.
|
|
19
27
|
sig { returns(T.nilable(T::Array[String])) }
|
|
20
28
|
attr_reader :entity_ids
|
|
@@ -39,44 +47,26 @@ module FinchAPI
|
|
|
39
47
|
end
|
|
40
48
|
attr_writer :options
|
|
41
49
|
|
|
42
|
-
sig do
|
|
43
|
-
returns(
|
|
44
|
-
T.nilable(
|
|
45
|
-
T::Array[FinchAPI::HRIS::IndividualRetrieveManyParams::Request]
|
|
46
|
-
)
|
|
47
|
-
)
|
|
48
|
-
end
|
|
49
|
-
attr_reader :requests
|
|
50
|
-
|
|
51
50
|
sig do
|
|
52
51
|
params(
|
|
53
52
|
requests:
|
|
54
53
|
T::Array[
|
|
55
54
|
FinchAPI::HRIS::IndividualRetrieveManyParams::Request::OrHash
|
|
56
|
-
]
|
|
57
|
-
).void
|
|
58
|
-
end
|
|
59
|
-
attr_writer :requests
|
|
60
|
-
|
|
61
|
-
sig do
|
|
62
|
-
params(
|
|
55
|
+
],
|
|
63
56
|
entity_ids: T::Array[String],
|
|
64
57
|
options:
|
|
65
58
|
T.nilable(
|
|
66
59
|
FinchAPI::HRIS::IndividualRetrieveManyParams::Options::OrHash
|
|
67
60
|
),
|
|
68
|
-
requests:
|
|
69
|
-
T::Array[
|
|
70
|
-
FinchAPI::HRIS::IndividualRetrieveManyParams::Request::OrHash
|
|
71
|
-
],
|
|
72
61
|
request_options: FinchAPI::RequestOptions::OrHash
|
|
73
62
|
).returns(T.attached_class)
|
|
74
63
|
end
|
|
75
64
|
def self.new(
|
|
65
|
+
# The array of batch requests. Maximum 10000 items per request.
|
|
66
|
+
requests:,
|
|
76
67
|
# The entity IDs to specify which entities' data to access.
|
|
77
68
|
entity_ids: nil,
|
|
78
69
|
options: nil,
|
|
79
|
-
requests: nil,
|
|
80
70
|
request_options: {}
|
|
81
71
|
)
|
|
82
72
|
end
|
|
@@ -84,13 +74,13 @@ module FinchAPI
|
|
|
84
74
|
sig do
|
|
85
75
|
override.returns(
|
|
86
76
|
{
|
|
77
|
+
requests:
|
|
78
|
+
T::Array[FinchAPI::HRIS::IndividualRetrieveManyParams::Request],
|
|
87
79
|
entity_ids: T::Array[String],
|
|
88
80
|
options:
|
|
89
81
|
T.nilable(
|
|
90
82
|
FinchAPI::HRIS::IndividualRetrieveManyParams::Options
|
|
91
83
|
),
|
|
92
|
-
requests:
|
|
93
|
-
T::Array[FinchAPI::HRIS::IndividualRetrieveManyParams::Request],
|
|
94
84
|
request_options: FinchAPI::RequestOptions
|
|
95
85
|
}
|
|
96
86
|
)
|
|
@@ -98,50 +88,47 @@ module FinchAPI
|
|
|
98
88
|
def to_hash
|
|
99
89
|
end
|
|
100
90
|
|
|
101
|
-
class
|
|
91
|
+
class Request < FinchAPI::Internal::Type::BaseModel
|
|
102
92
|
OrHash =
|
|
103
93
|
T.type_alias do
|
|
104
94
|
T.any(
|
|
105
|
-
FinchAPI::HRIS::IndividualRetrieveManyParams::
|
|
95
|
+
FinchAPI::HRIS::IndividualRetrieveManyParams::Request,
|
|
106
96
|
FinchAPI::Internal::AnyHash
|
|
107
97
|
)
|
|
108
98
|
end
|
|
109
99
|
|
|
110
|
-
sig { returns(
|
|
111
|
-
|
|
100
|
+
sig { returns(String) }
|
|
101
|
+
attr_accessor :individual_id
|
|
112
102
|
|
|
113
|
-
sig { params(
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
sig { params(include: T::Array[String]).returns(T.attached_class) }
|
|
117
|
-
def self.new(include: nil)
|
|
103
|
+
sig { params(individual_id: String).returns(T.attached_class) }
|
|
104
|
+
def self.new(individual_id:)
|
|
118
105
|
end
|
|
119
106
|
|
|
120
|
-
sig { override.returns({
|
|
107
|
+
sig { override.returns({ individual_id: String }) }
|
|
121
108
|
def to_hash
|
|
122
109
|
end
|
|
123
110
|
end
|
|
124
111
|
|
|
125
|
-
class
|
|
112
|
+
class Options < FinchAPI::Internal::Type::BaseModel
|
|
126
113
|
OrHash =
|
|
127
114
|
T.type_alias do
|
|
128
115
|
T.any(
|
|
129
|
-
FinchAPI::HRIS::IndividualRetrieveManyParams::
|
|
116
|
+
FinchAPI::HRIS::IndividualRetrieveManyParams::Options,
|
|
130
117
|
FinchAPI::Internal::AnyHash
|
|
131
118
|
)
|
|
132
119
|
end
|
|
133
120
|
|
|
134
|
-
sig { returns(T.nilable(String)) }
|
|
135
|
-
attr_reader :
|
|
121
|
+
sig { returns(T.nilable(T::Array[String])) }
|
|
122
|
+
attr_reader :include
|
|
136
123
|
|
|
137
|
-
sig { params(
|
|
138
|
-
attr_writer :
|
|
124
|
+
sig { params(include: T::Array[String]).void }
|
|
125
|
+
attr_writer :include
|
|
139
126
|
|
|
140
|
-
sig { params(
|
|
141
|
-
def self.new(
|
|
127
|
+
sig { params(include: T::Array[String]).returns(T.attached_class) }
|
|
128
|
+
def self.new(include: nil)
|
|
142
129
|
end
|
|
143
130
|
|
|
144
|
-
sig { override.returns({
|
|
131
|
+
sig { override.returns({ include: T::Array[String] }) }
|
|
145
132
|
def to_hash
|
|
146
133
|
end
|
|
147
134
|
end
|
|
@@ -15,7 +15,7 @@ module FinchAPI
|
|
|
15
15
|
)
|
|
16
16
|
end
|
|
17
17
|
|
|
18
|
-
# The array of batch requests.
|
|
18
|
+
# The array of batch requests. Maximum 10 payment_ids per request.
|
|
19
19
|
sig do
|
|
20
20
|
returns(
|
|
21
21
|
T::Array[FinchAPI::HRIS::PayStatementRetrieveManyParams::Request]
|
|
@@ -41,7 +41,7 @@ module FinchAPI
|
|
|
41
41
|
).returns(T.attached_class)
|
|
42
42
|
end
|
|
43
43
|
def self.new(
|
|
44
|
-
# The array of batch requests.
|
|
44
|
+
# The array of batch requests. Maximum 10 payment_ids per request.
|
|
45
45
|
requests:,
|
|
46
46
|
# The entity IDs to specify which entities' data to access.
|
|
47
47
|
entity_ids: nil,
|
|
@@ -77,7 +77,7 @@ module FinchAPI
|
|
|
77
77
|
sig { returns(String) }
|
|
78
78
|
attr_accessor :payment_id
|
|
79
79
|
|
|
80
|
-
# Number of pay statements to return (defaults to
|
|
80
|
+
# Number of pay statements to return (defaults to 100, maximum 5000).
|
|
81
81
|
sig { returns(T.nilable(Integer)) }
|
|
82
82
|
attr_reader :limit
|
|
83
83
|
|
|
@@ -99,7 +99,7 @@ module FinchAPI
|
|
|
99
99
|
def self.new(
|
|
100
100
|
# A stable Finch `id` (UUID v4) for a payment.
|
|
101
101
|
payment_id:,
|
|
102
|
-
# Number of pay statements to return (defaults to
|
|
102
|
+
# Number of pay statements to return (defaults to 100, maximum 5000).
|
|
103
103
|
limit: nil,
|
|
104
104
|
# Index to start from.
|
|
105
105
|
offset: nil
|
|
@@ -20,7 +20,7 @@ module FinchAPI
|
|
|
20
20
|
def list(
|
|
21
21
|
# The entity IDs to specify which entities' data to access.
|
|
22
22
|
entity_ids: nil,
|
|
23
|
-
# Number of employees to return (defaults to
|
|
23
|
+
# Number of employees to return (defaults to 100, maximum 10000)
|
|
24
24
|
limit: nil,
|
|
25
25
|
# Index to start from (defaults to 0)
|
|
26
26
|
offset: nil,
|
|
@@ -20,7 +20,7 @@ module FinchAPI
|
|
|
20
20
|
)
|
|
21
21
|
end
|
|
22
22
|
def retrieve_many(
|
|
23
|
-
# Body param: The array of batch requests.
|
|
23
|
+
# Body param: The array of batch requests. Maximum 10000 items per request.
|
|
24
24
|
requests:,
|
|
25
25
|
# Query param: The entity IDs to specify which entities' data to access.
|
|
26
26
|
entity_ids: nil,
|
|
@@ -7,15 +7,15 @@ module FinchAPI
|
|
|
7
7
|
# Read individual data, excluding income and employment data
|
|
8
8
|
sig do
|
|
9
9
|
params(
|
|
10
|
+
requests:
|
|
11
|
+
T::Array[
|
|
12
|
+
FinchAPI::HRIS::IndividualRetrieveManyParams::Request::OrHash
|
|
13
|
+
],
|
|
10
14
|
entity_ids: T::Array[String],
|
|
11
15
|
options:
|
|
12
16
|
T.nilable(
|
|
13
17
|
FinchAPI::HRIS::IndividualRetrieveManyParams::Options::OrHash
|
|
14
18
|
),
|
|
15
|
-
requests:
|
|
16
|
-
T::Array[
|
|
17
|
-
FinchAPI::HRIS::IndividualRetrieveManyParams::Request::OrHash
|
|
18
|
-
],
|
|
19
19
|
request_options: FinchAPI::RequestOptions::OrHash
|
|
20
20
|
).returns(
|
|
21
21
|
FinchAPI::Internal::ResponsesPage[
|
|
@@ -24,12 +24,12 @@ module FinchAPI
|
|
|
24
24
|
)
|
|
25
25
|
end
|
|
26
26
|
def retrieve_many(
|
|
27
|
+
# Body param: The array of batch requests. Maximum 10000 items per request.
|
|
28
|
+
requests:,
|
|
27
29
|
# Query param: The entity IDs to specify which entities' data to access.
|
|
28
30
|
entity_ids: nil,
|
|
29
31
|
# Body param
|
|
30
32
|
options: nil,
|
|
31
|
-
# Body param
|
|
32
|
-
requests: nil,
|
|
33
33
|
request_options: {}
|
|
34
34
|
)
|
|
35
35
|
end
|
|
@@ -23,7 +23,7 @@ module FinchAPI
|
|
|
23
23
|
)
|
|
24
24
|
end
|
|
25
25
|
def retrieve_many(
|
|
26
|
-
# Body param: The array of batch requests.
|
|
26
|
+
# Body param: The array of batch requests. Maximum 10 payment_ids per request.
|
|
27
27
|
requests:,
|
|
28
28
|
# Query param: The entity IDs to specify which entities' data to access.
|
|
29
29
|
entity_ids: nil,
|
|
@@ -3,9 +3,9 @@ module FinchAPI
|
|
|
3
3
|
module HRIS
|
|
4
4
|
type individual_retrieve_many_params =
|
|
5
5
|
{
|
|
6
|
+
requests: ::Array[FinchAPI::HRIS::IndividualRetrieveManyParams::Request],
|
|
6
7
|
entity_ids: ::Array[String],
|
|
7
|
-
options: FinchAPI::HRIS::IndividualRetrieveManyParams::Options
|
|
8
|
-
requests: ::Array[FinchAPI::HRIS::IndividualRetrieveManyParams::Request]
|
|
8
|
+
options: FinchAPI::HRIS::IndividualRetrieveManyParams::Options?
|
|
9
9
|
}
|
|
10
10
|
& FinchAPI::Internal::Type::request_parameters
|
|
11
11
|
|
|
@@ -13,32 +13,38 @@ module FinchAPI
|
|
|
13
13
|
extend FinchAPI::Internal::Type::RequestParameters::Converter
|
|
14
14
|
include FinchAPI::Internal::Type::RequestParameters
|
|
15
15
|
|
|
16
|
+
attr_accessor requests: ::Array[FinchAPI::HRIS::IndividualRetrieveManyParams::Request]
|
|
17
|
+
|
|
16
18
|
attr_reader entity_ids: ::Array[String]?
|
|
17
19
|
|
|
18
20
|
def entity_ids=: (::Array[String]) -> ::Array[String]
|
|
19
21
|
|
|
20
22
|
attr_accessor options: FinchAPI::HRIS::IndividualRetrieveManyParams::Options?
|
|
21
23
|
|
|
22
|
-
attr_reader requests: ::Array[FinchAPI::HRIS::IndividualRetrieveManyParams::Request]?
|
|
23
|
-
|
|
24
|
-
def requests=: (
|
|
25
|
-
::Array[FinchAPI::HRIS::IndividualRetrieveManyParams::Request]
|
|
26
|
-
) -> ::Array[FinchAPI::HRIS::IndividualRetrieveManyParams::Request]
|
|
27
|
-
|
|
28
24
|
def initialize: (
|
|
25
|
+
requests: ::Array[FinchAPI::HRIS::IndividualRetrieveManyParams::Request],
|
|
29
26
|
?entity_ids: ::Array[String],
|
|
30
27
|
?options: FinchAPI::HRIS::IndividualRetrieveManyParams::Options?,
|
|
31
|
-
?requests: ::Array[FinchAPI::HRIS::IndividualRetrieveManyParams::Request],
|
|
32
28
|
?request_options: FinchAPI::request_opts
|
|
33
29
|
) -> void
|
|
34
30
|
|
|
35
31
|
def to_hash: -> {
|
|
32
|
+
requests: ::Array[FinchAPI::HRIS::IndividualRetrieveManyParams::Request],
|
|
36
33
|
entity_ids: ::Array[String],
|
|
37
34
|
options: FinchAPI::HRIS::IndividualRetrieveManyParams::Options?,
|
|
38
|
-
requests: ::Array[FinchAPI::HRIS::IndividualRetrieveManyParams::Request],
|
|
39
35
|
request_options: FinchAPI::RequestOptions
|
|
40
36
|
}
|
|
41
37
|
|
|
38
|
+
type request = { individual_id: String }
|
|
39
|
+
|
|
40
|
+
class Request < FinchAPI::Internal::Type::BaseModel
|
|
41
|
+
attr_accessor individual_id: String
|
|
42
|
+
|
|
43
|
+
def initialize: (individual_id: String) -> void
|
|
44
|
+
|
|
45
|
+
def to_hash: -> { individual_id: String }
|
|
46
|
+
end
|
|
47
|
+
|
|
42
48
|
type options = { include: ::Array[String] }
|
|
43
49
|
|
|
44
50
|
class Options < FinchAPI::Internal::Type::BaseModel
|
|
@@ -50,18 +56,6 @@ module FinchAPI
|
|
|
50
56
|
|
|
51
57
|
def to_hash: -> { include: ::Array[String] }
|
|
52
58
|
end
|
|
53
|
-
|
|
54
|
-
type request = { individual_id: String }
|
|
55
|
-
|
|
56
|
-
class Request < FinchAPI::Internal::Type::BaseModel
|
|
57
|
-
attr_reader individual_id: String?
|
|
58
|
-
|
|
59
|
-
def individual_id=: (String) -> String
|
|
60
|
-
|
|
61
|
-
def initialize: (?individual_id: String) -> void
|
|
62
|
-
|
|
63
|
-
def to_hash: -> { individual_id: String }
|
|
64
|
-
end
|
|
65
59
|
end
|
|
66
60
|
end
|
|
67
61
|
end
|
|
@@ -3,9 +3,9 @@ module FinchAPI
|
|
|
3
3
|
class HRIS
|
|
4
4
|
class Individuals
|
|
5
5
|
def retrieve_many: (
|
|
6
|
+
requests: ::Array[FinchAPI::HRIS::IndividualRetrieveManyParams::Request],
|
|
6
7
|
?entity_ids: ::Array[String],
|
|
7
8
|
?options: FinchAPI::HRIS::IndividualRetrieveManyParams::Options?,
|
|
8
|
-
?requests: ::Array[FinchAPI::HRIS::IndividualRetrieveManyParams::Request],
|
|
9
9
|
?request_options: FinchAPI::request_opts
|
|
10
10
|
) -> FinchAPI::Internal::ResponsesPage[FinchAPI::HRIS::IndividualResponse]
|
|
11
11
|
|
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.48
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Finch
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2026-07-
|
|
11
|
+
date: 2026-07-13 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: cgi
|