finch-api 0.1.0.pre.alpha.47 → 0.1.0.pre.alpha.49

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.
Files changed (95) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +16 -0
  3. data/README.md +1 -1
  4. data/lib/finch_api/models/base_webhook_event.rb +2 -5
  5. data/lib/finch_api/models/create_access_token_response.rb +2 -5
  6. data/lib/finch_api/models/hris/benefit_create_params.rb +3 -2
  7. data/lib/finch_api/models/hris/benefit_list_params.rb +6 -2
  8. data/lib/finch_api/models/hris/benefit_list_supported_benefits_params.rb +6 -2
  9. data/lib/finch_api/models/hris/benefit_register_params.rb +6 -2
  10. data/lib/finch_api/models/hris/benefit_retrieve_params.rb +6 -2
  11. data/lib/finch_api/models/hris/benefit_update_params.rb +6 -2
  12. data/lib/finch_api/models/hris/benefits/individual_enroll_many_params.rb +6 -2
  13. data/lib/finch_api/models/hris/benefits/individual_enrolled_ids_params.rb +7 -2
  14. data/lib/finch_api/models/hris/benefits/individual_retrieve_many_benefits_params.rb +3 -2
  15. data/lib/finch_api/models/hris/benefits/individual_unenroll_many_params.rb +7 -2
  16. data/lib/finch_api/models/hris/company_retrieve_params.rb +6 -2
  17. data/lib/finch_api/models/hris/directory_list_individuals_params.rb +8 -4
  18. data/lib/finch_api/models/hris/directory_list_params.rb +8 -4
  19. data/lib/finch_api/models/hris/document_list_params.rb +3 -2
  20. data/lib/finch_api/models/hris/document_retreive_params.rb +6 -2
  21. data/lib/finch_api/models/hris/employment_retrieve_many_params.rb +10 -12
  22. data/lib/finch_api/models/hris/individual_retrieve_many_params.rb +25 -20
  23. data/lib/finch_api/models/hris/pay_statement_item/rule_create_params.rb +6 -2
  24. data/lib/finch_api/models/hris/pay_statement_item/rule_delete_params.rb +6 -2
  25. data/lib/finch_api/models/hris/pay_statement_item/rule_list_params.rb +6 -2
  26. data/lib/finch_api/models/hris/pay_statement_item/rule_update_params.rb +6 -2
  27. data/lib/finch_api/models/hris/pay_statement_item_list_params.rb +3 -2
  28. data/lib/finch_api/models/hris/pay_statement_retrieve_many_params.rb +10 -6
  29. data/lib/finch_api/models/hris/payment_list_params.rb +3 -2
  30. data/lib/finch_api/models/introspection.rb +2 -5
  31. data/lib/finch_api/models/payroll/pay_group_list_params.rb +6 -2
  32. data/lib/finch_api/models/payroll/pay_group_retrieve_params.rb +6 -2
  33. data/lib/finch_api/models/sandbox/connection_create_response.rb +2 -4
  34. data/lib/finch_api/models/sandbox/connections/account_create_response.rb +2 -4
  35. data/lib/finch_api/models/sandbox/connections/account_update_response.rb +2 -4
  36. data/lib/finch_api/resources/hris/benefits/individuals.rb +15 -4
  37. data/lib/finch_api/resources/hris/benefits.rb +21 -6
  38. data/lib/finch_api/resources/hris/company.rb +4 -1
  39. data/lib/finch_api/resources/hris/directory.rb +5 -2
  40. data/lib/finch_api/resources/hris/documents.rb +5 -2
  41. data/lib/finch_api/resources/hris/employments.rb +5 -2
  42. data/lib/finch_api/resources/hris/individuals.rb +8 -5
  43. data/lib/finch_api/resources/hris/pay_statement_item/rules.rb +13 -4
  44. data/lib/finch_api/resources/hris/pay_statement_item.rb +1 -1
  45. data/lib/finch_api/resources/hris/pay_statements.rb +5 -2
  46. data/lib/finch_api/resources/hris/payments.rb +1 -1
  47. data/lib/finch_api/resources/payroll/pay_groups.rb +8 -2
  48. data/lib/finch_api/version.rb +1 -1
  49. data/rbi/finch_api/models/base_webhook_event.rbi +2 -4
  50. data/rbi/finch_api/models/create_access_token_response.rbi +2 -4
  51. data/rbi/finch_api/models/hris/benefit_create_params.rbi +4 -2
  52. data/rbi/finch_api/models/hris/benefit_list_params.rbi +4 -2
  53. data/rbi/finch_api/models/hris/benefit_list_supported_benefits_params.rbi +4 -2
  54. data/rbi/finch_api/models/hris/benefit_register_params.rbi +4 -2
  55. data/rbi/finch_api/models/hris/benefit_retrieve_params.rbi +4 -2
  56. data/rbi/finch_api/models/hris/benefit_update_params.rbi +4 -2
  57. data/rbi/finch_api/models/hris/benefits/individual_enroll_many_params.rbi +4 -2
  58. data/rbi/finch_api/models/hris/benefits/individual_enrolled_ids_params.rbi +4 -2
  59. data/rbi/finch_api/models/hris/benefits/individual_retrieve_many_benefits_params.rbi +4 -2
  60. data/rbi/finch_api/models/hris/benefits/individual_unenroll_many_params.rbi +4 -2
  61. data/rbi/finch_api/models/hris/company_retrieve_params.rbi +4 -2
  62. data/rbi/finch_api/models/hris/directory_list_individuals_params.rbi +6 -4
  63. data/rbi/finch_api/models/hris/directory_list_params.rbi +6 -4
  64. data/rbi/finch_api/models/hris/document_list_params.rbi +4 -2
  65. data/rbi/finch_api/models/hris/document_retreive_params.rbi +4 -2
  66. data/rbi/finch_api/models/hris/employment_retrieve_many_params.rbi +8 -10
  67. data/rbi/finch_api/models/hris/individual_retrieve_many_params.rbi +33 -44
  68. data/rbi/finch_api/models/hris/pay_statement_item/rule_create_params.rbi +4 -2
  69. data/rbi/finch_api/models/hris/pay_statement_item/rule_delete_params.rbi +4 -2
  70. data/rbi/finch_api/models/hris/pay_statement_item/rule_list_params.rbi +4 -2
  71. data/rbi/finch_api/models/hris/pay_statement_item/rule_update_params.rbi +4 -2
  72. data/rbi/finch_api/models/hris/pay_statement_item_list_params.rbi +4 -2
  73. data/rbi/finch_api/models/hris/pay_statement_retrieve_many_params.rbi +8 -6
  74. data/rbi/finch_api/models/hris/payment_list_params.rbi +4 -2
  75. data/rbi/finch_api/models/introspection.rbi +2 -4
  76. data/rbi/finch_api/models/payroll/pay_group_list_params.rbi +4 -2
  77. data/rbi/finch_api/models/payroll/pay_group_retrieve_params.rbi +4 -2
  78. data/rbi/finch_api/models/sandbox/connection_create_response.rbi +2 -2
  79. data/rbi/finch_api/models/sandbox/connections/account_create_response.rbi +2 -2
  80. data/rbi/finch_api/models/sandbox/connections/account_update_response.rbi +2 -2
  81. data/rbi/finch_api/resources/hris/benefits/individuals.rbi +8 -4
  82. data/rbi/finch_api/resources/hris/benefits.rbi +12 -6
  83. data/rbi/finch_api/resources/hris/company.rbi +2 -1
  84. data/rbi/finch_api/resources/hris/directory.rbi +3 -2
  85. data/rbi/finch_api/resources/hris/documents.rbi +4 -2
  86. data/rbi/finch_api/resources/hris/employments.rbi +3 -2
  87. data/rbi/finch_api/resources/hris/individuals.rbi +8 -7
  88. data/rbi/finch_api/resources/hris/pay_statement_item/rules.rbi +8 -4
  89. data/rbi/finch_api/resources/hris/pay_statement_item.rbi +2 -1
  90. data/rbi/finch_api/resources/hris/pay_statements.rbi +3 -2
  91. data/rbi/finch_api/resources/hris/payments.rbi +2 -1
  92. data/rbi/finch_api/resources/payroll/pay_groups.rbi +4 -2
  93. data/sig/finch_api/models/hris/individual_retrieve_many_params.rbs +16 -22
  94. data/sig/finch_api/resources/hris/individuals.rbs +1 -1
  95. metadata +2 -2
@@ -16,7 +16,8 @@ module FinchAPI
16
16
  )
17
17
  end
18
18
 
19
- # The entity IDs to retrieve rules for.
19
+ # The entity IDs to retrieve rules for. Provide exactly one entity ID per request;
20
+ # a maximum of one is accepted.
20
21
  sig { returns(T.nilable(T::Array[String])) }
21
22
  attr_reader :entity_ids
22
23
 
@@ -30,7 +31,8 @@ module FinchAPI
30
31
  ).returns(T.attached_class)
31
32
  end
32
33
  def self.new(
33
- # The entity IDs to retrieve rules for.
34
+ # The entity IDs to retrieve rules for. Provide exactly one entity ID per request;
35
+ # a maximum of one is accepted.
34
36
  entity_ids: nil,
35
37
  request_options: {}
36
38
  )
@@ -19,7 +19,8 @@ module FinchAPI
19
19
  sig { returns(String) }
20
20
  attr_accessor :rule_id
21
21
 
22
- # The entity IDs to update the rule for.
22
+ # The entity IDs to update the rule for. Provide exactly one entity ID per
23
+ # request; a maximum of one is accepted.
23
24
  sig { returns(T.nilable(T::Array[String])) }
24
25
  attr_reader :entity_ids
25
26
 
@@ -42,7 +43,8 @@ module FinchAPI
42
43
  end
43
44
  def self.new(
44
45
  rule_id:,
45
- # The entity IDs to update the rule for.
46
+ # The entity IDs to update the rule for. Provide exactly one entity ID per
47
+ # request; a maximum of one is accepted.
46
48
  entity_ids: nil,
47
49
  optional_property: nil,
48
50
  request_options: {}
@@ -46,7 +46,8 @@ module FinchAPI
46
46
  sig { params(end_date: Date).void }
47
47
  attr_writer :end_date
48
48
 
49
- # The entity IDs to specify which entities' data to access.
49
+ # The entity IDs to specify which entities' data to access. Provide exactly one
50
+ # entity ID per request; a maximum of one is accepted.
50
51
  sig { returns(T.nilable(T::Array[String])) }
51
52
  attr_reader :entity_ids
52
53
 
@@ -96,7 +97,8 @@ module FinchAPI
96
97
  # The end date to retrieve pay statement items by via their last seen pay date in
97
98
  # `YYYY-MM-DD` format.
98
99
  end_date: nil,
99
- # The entity IDs to specify which entities' data to access.
100
+ # The entity IDs to specify which entities' data to access. Provide exactly one
101
+ # entity ID per request; a maximum of one is accepted.
100
102
  entity_ids: nil,
101
103
  # Case-insensitive partial match search by pay statement item name.
102
104
  name: 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 10 payment_ids per request.
19
19
  sig do
20
20
  returns(
21
21
  T::Array[FinchAPI::HRIS::PayStatementRetrieveManyParams::Request]
@@ -23,7 +23,8 @@ module FinchAPI
23
23
  end
24
24
  attr_accessor :requests
25
25
 
26
- # The entity IDs to specify which entities' data to access.
26
+ # The entity IDs to specify which entities' data to access. Provide exactly one
27
+ # entity ID per request; a maximum of one is accepted.
27
28
  sig { returns(T.nilable(T::Array[String])) }
28
29
  attr_reader :entity_ids
29
30
 
@@ -41,9 +42,10 @@ module FinchAPI
41
42
  ).returns(T.attached_class)
42
43
  end
43
44
  def self.new(
44
- # The array of batch requests.
45
+ # The array of batch requests. Maximum 10 payment_ids per request.
45
46
  requests:,
46
- # The entity IDs to specify which entities' data to access.
47
+ # The entity IDs to specify which entities' data to access. Provide exactly one
48
+ # entity ID per request; a maximum of one is accepted.
47
49
  entity_ids: nil,
48
50
  request_options: {}
49
51
  )
@@ -77,7 +79,7 @@ module FinchAPI
77
79
  sig { returns(String) }
78
80
  attr_accessor :payment_id
79
81
 
80
- # Number of pay statements to return (defaults to all).
82
+ # Number of pay statements to return (defaults to 100, maximum 5000).
81
83
  sig { returns(T.nilable(Integer)) }
82
84
  attr_reader :limit
83
85
 
@@ -99,7 +101,7 @@ module FinchAPI
99
101
  def self.new(
100
102
  # A stable Finch `id` (UUID v4) for a payment.
101
103
  payment_id:,
102
- # Number of pay statements to return (defaults to all).
104
+ # Number of pay statements to return (defaults to 100, maximum 5000).
103
105
  limit: nil,
104
106
  # Index to start from.
105
107
  offset: nil
@@ -25,7 +25,8 @@ module FinchAPI
25
25
  sig { returns(Date) }
26
26
  attr_accessor :start_date
27
27
 
28
- # The entity IDs to specify which entities' data to access.
28
+ # The entity IDs to specify which entities' data to access. Provide exactly one
29
+ # entity ID per request; a maximum of one is accepted.
29
30
  sig { returns(T.nilable(T::Array[String])) }
30
31
  attr_reader :entity_ids
31
32
 
@@ -47,7 +48,8 @@ module FinchAPI
47
48
  # The start date to retrieve payments by a company (inclusive) in `YYYY-MM-DD`
48
49
  # format. Filters payments by their **pay_date** field.
49
50
  start_date:,
50
- # The entity IDs to specify which entities' data to access.
51
+ # The entity IDs to specify which entities' data to access. Provide exactly one
52
+ # entity ID per request; a maximum of one is accepted.
51
53
  entity_ids: nil,
52
54
  request_options: {}
53
55
  )
@@ -72,8 +72,7 @@ module FinchAPI
72
72
  end
73
73
  attr_writer :authentication_methods
74
74
 
75
- # [DEPRECATED] Use `connection_id` to associate tokens with a Finch connection
76
- # instead of this company ID
75
+ # The Finch UUID of the company associated with the `access_token`.
77
76
  sig { returns(T.nilable(String)) }
78
77
  attr_reader :company_id
79
78
 
@@ -172,8 +171,7 @@ module FinchAPI
172
171
  # instead of this account ID
173
172
  account_id: nil,
174
173
  authentication_methods: nil,
175
- # [DEPRECATED] Use `connection_id` to associate tokens with a Finch connection
176
- # instead of this company ID
174
+ # The Finch UUID of the company associated with the `access_token`.
177
175
  company_id: nil,
178
176
  # The email of your customer you provided to Finch when a connect session was
179
177
  # created for this connection
@@ -15,7 +15,8 @@ module FinchAPI
15
15
  )
16
16
  end
17
17
 
18
- # The entity IDs to specify which entities' data to access.
18
+ # The entity IDs to specify which entities' data to access. Provide exactly one
19
+ # entity ID per request; a maximum of one is accepted.
19
20
  sig { returns(T.nilable(T::Array[String])) }
20
21
  attr_reader :entity_ids
21
22
 
@@ -43,7 +44,8 @@ module FinchAPI
43
44
  ).returns(T.attached_class)
44
45
  end
45
46
  def self.new(
46
- # The entity IDs to specify which entities' data to access.
47
+ # The entity IDs to specify which entities' data to access. Provide exactly one
48
+ # entity ID per request; a maximum of one is accepted.
47
49
  entity_ids: nil,
48
50
  individual_id: nil,
49
51
  pay_frequencies: nil,
@@ -18,7 +18,8 @@ module FinchAPI
18
18
  sig { returns(String) }
19
19
  attr_accessor :pay_group_id
20
20
 
21
- # The entity IDs to specify which entities' data to access.
21
+ # The entity IDs to specify which entities' data to access. Provide exactly one
22
+ # entity ID per request; a maximum of one is accepted.
22
23
  sig { returns(T.nilable(T::Array[String])) }
23
24
  attr_reader :entity_ids
24
25
 
@@ -34,7 +35,8 @@ module FinchAPI
34
35
  end
35
36
  def self.new(
36
37
  pay_group_id:,
37
- # The entity IDs to specify which entities' data to access.
38
+ # The entity IDs to specify which entities' data to access. Provide exactly one
39
+ # entity ID per request; a maximum of one is accepted.
38
40
  entity_ids: nil,
39
41
  request_options: {}
40
42
  )
@@ -26,7 +26,7 @@ module FinchAPI
26
26
  end
27
27
  attr_accessor :authentication_type
28
28
 
29
- # [DEPRECATED] Use `connection_id` to associate a connection with an access token
29
+ # The Finch UUID of the company associated with the `access_token`.
30
30
  sig { returns(String) }
31
31
  attr_accessor :company_id
32
32
 
@@ -70,7 +70,7 @@ module FinchAPI
70
70
  # [DEPRECATED] Use `connection_id` to associate a connection with an access token
71
71
  account_id:,
72
72
  authentication_type:,
73
- # [DEPRECATED] Use `connection_id` to associate a connection with an access token
73
+ # The Finch UUID of the company associated with the `access_token`.
74
74
  company_id:,
75
75
  # The ID of the new connection
76
76
  connection_id:,
@@ -27,7 +27,7 @@ module FinchAPI
27
27
  end
28
28
  attr_accessor :authentication_type
29
29
 
30
- # [DEPRECATED] Use `connection_id` to associate a connection with an access token
30
+ # The Finch UUID of the company associated with the `access_token`.
31
31
  sig { returns(String) }
32
32
  attr_accessor :company_id
33
33
 
@@ -64,7 +64,7 @@ module FinchAPI
64
64
  # [DEPRECATED] Use `connection_id` to associate a connection with an access token
65
65
  account_id:,
66
66
  authentication_type:,
67
- # [DEPRECATED] Use `connection_id` to associate a connection with an access token
67
+ # The Finch UUID of the company associated with the `access_token`.
68
68
  company_id:,
69
69
  # The ID of the new connection
70
70
  connection_id:,
@@ -24,7 +24,7 @@ module FinchAPI
24
24
  end
25
25
  attr_accessor :authentication_type
26
26
 
27
- # [DEPRECATED] Use `connection_id` to associate a connection with an access token
27
+ # The Finch UUID of the company associated with the `access_token`.
28
28
  sig { returns(String) }
29
29
  attr_accessor :company_id
30
30
 
@@ -59,7 +59,7 @@ module FinchAPI
59
59
  # [DEPRECATED] Use `connection_id` to associate a connection with an access token
60
60
  account_id:,
61
61
  authentication_type:,
62
- # [DEPRECATED] Use `connection_id` to associate a connection with an access token
62
+ # The Finch UUID of the company associated with the `access_token`.
63
63
  company_id:,
64
64
  # The ID of the new connection
65
65
  connection_id:,
@@ -25,7 +25,8 @@ module FinchAPI
25
25
  def enroll_many(
26
26
  # Path param
27
27
  benefit_id,
28
- # Query param: The entity IDs to specify which entities' data to access.
28
+ # Query param: The entity IDs to specify which entities' data to access. Provide
29
+ # exactly one entity ID per request; a maximum of one is accepted.
29
30
  entity_ids: nil,
30
31
  # Body param: Array of the individual_id to enroll and a configuration object.
31
32
  individuals: nil,
@@ -45,7 +46,8 @@ module FinchAPI
45
46
  end
46
47
  def enrolled_ids(
47
48
  benefit_id,
48
- # The entity IDs to specify which entities' data to access.
49
+ # The entity IDs to specify which entities' data to access. Provide exactly one
50
+ # entity ID per request; a maximum of one is accepted.
49
51
  entity_ids: nil,
50
52
  request_options: {}
51
53
  )
@@ -66,7 +68,8 @@ module FinchAPI
66
68
  end
67
69
  def retrieve_many_benefits(
68
70
  benefit_id,
69
- # The entity IDs to specify which entities' data to access.
71
+ # The entity IDs to specify which entities' data to access. Provide exactly one
72
+ # entity ID per request; a maximum of one is accepted.
70
73
  entity_ids: nil,
71
74
  # comma-delimited list of stable Finch uuids for each individual. If empty,
72
75
  # defaults to all individuals
@@ -89,7 +92,8 @@ module FinchAPI
89
92
  def unenroll_many(
90
93
  # Path param
91
94
  benefit_id,
92
- # Query param: The entity IDs to specify which entities' data to access.
95
+ # Query param: The entity IDs to specify which entities' data to access. Provide
96
+ # exactly one entity ID per request; a maximum of one is accepted.
93
97
  entity_ids: nil,
94
98
  # Body param: Array of individual_ids to unenroll.
95
99
  individual_ids: nil,
@@ -23,7 +23,8 @@ module FinchAPI
23
23
  ).returns(FinchAPI::HRIS::CreateCompanyBenefitsResponse)
24
24
  end
25
25
  def create(
26
- # Query param: The entity IDs to specify which entities' data to access.
26
+ # Query param: The entity IDs to specify which entities' data to access. Provide
27
+ # exactly one entity ID per request; a maximum of one is accepted.
27
28
  entity_ids: nil,
28
29
  # Body param: The company match for this benefit.
29
30
  company_contribution: nil,
@@ -49,7 +50,8 @@ module FinchAPI
49
50
  end
50
51
  def retrieve(
51
52
  benefit_id,
52
- # The entity IDs to specify which entities' data to access.
53
+ # The entity IDs to specify which entities' data to access. Provide exactly one
54
+ # entity ID per request; a maximum of one is accepted.
53
55
  entity_ids: nil,
54
56
  request_options: {}
55
57
  )
@@ -67,7 +69,8 @@ module FinchAPI
67
69
  def update(
68
70
  # Path param
69
71
  benefit_id,
70
- # Query param: The entity IDs to specify which entities' data to access.
72
+ # Query param: The entity IDs to specify which entities' data to access. Provide
73
+ # exactly one entity ID per request; a maximum of one is accepted.
71
74
  entity_ids: nil,
72
75
  # Body param: Updated name or description.
73
76
  description: nil,
@@ -85,7 +88,8 @@ module FinchAPI
85
88
  )
86
89
  end
87
90
  def list(
88
- # The entity IDs to specify which entities' data to access.
91
+ # The entity IDs to specify which entities' data to access. Provide exactly one
92
+ # entity ID per request; a maximum of one is accepted.
89
93
  entity_ids: nil,
90
94
  request_options: {}
91
95
  )
@@ -101,7 +105,8 @@ module FinchAPI
101
105
  )
102
106
  end
103
107
  def list_supported_benefits(
104
- # The entity IDs to specify which entities' data to access.
108
+ # The entity IDs to specify which entities' data to access. Provide exactly one
109
+ # entity ID per request; a maximum of one is accepted.
105
110
  entity_ids: nil,
106
111
  request_options: {}
107
112
  )
@@ -119,7 +124,8 @@ module FinchAPI
119
124
  ).returns(FinchAPI::HRIS::RegisterCompanyBenefitResponse)
120
125
  end
121
126
  def register(
122
- # Query param: The entity IDs to specify which entities' data to access.
127
+ # Query param: The entity IDs to specify which entities' data to access. Provide
128
+ # exactly one entity ID per request; a maximum of one is accepted.
123
129
  entity_ids: nil,
124
130
  # Body param
125
131
  description: nil,
@@ -12,7 +12,8 @@ module FinchAPI
12
12
  ).returns(FinchAPI::HRIS::HRISCompany)
13
13
  end
14
14
  def retrieve(
15
- # The entity IDs to specify which entities' data to access.
15
+ # The entity IDs to specify which entities' data to access. Provide exactly one
16
+ # entity ID per request; a maximum of one is accepted.
16
17
  entity_ids: nil,
17
18
  request_options: {}
18
19
  )
@@ -18,9 +18,10 @@ module FinchAPI
18
18
  )
19
19
  end
20
20
  def list(
21
- # The entity IDs to specify which entities' data to access.
21
+ # The entity IDs to specify which entities' data to access. Provide exactly one
22
+ # entity ID per request; a maximum of one is accepted.
22
23
  entity_ids: nil,
23
- # Number of employees to return (defaults to all)
24
+ # Number of employees to return (defaults to 100, maximum 10000)
24
25
  limit: nil,
25
26
  # Index to start from (defaults to 0)
26
27
  offset: nil,
@@ -17,7 +17,8 @@ module FinchAPI
17
17
  ).returns(FinchAPI::Models::HRIS::DocumentListResponse)
18
18
  end
19
19
  def list(
20
- # The entity IDs to specify which entities' data to access.
20
+ # The entity IDs to specify which entities' data to access. Provide exactly one
21
+ # entity ID per request; a maximum of one is accepted.
21
22
  entity_ids: nil,
22
23
  # Comma-delimited list of stable Finch uuids for each individual. If empty,
23
24
  # defaults to all individuals
@@ -45,7 +46,8 @@ module FinchAPI
45
46
  def retreive(
46
47
  # The unique identifier of the document.
47
48
  document_id,
48
- # The entity IDs to specify which entities' data to access.
49
+ # The entity IDs to specify which entities' data to access. Provide exactly one
50
+ # entity ID per request; a maximum of one is accepted.
49
51
  entity_ids: nil,
50
52
  request_options: {}
51
53
  )
@@ -20,9 +20,10 @@ 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
- # Query param: The entity IDs to specify which entities' data to access.
25
+ # Query param: The entity IDs to specify which entities' data to access. Provide
26
+ # exactly one entity ID per request; a maximum of one is accepted.
26
27
  entity_ids: nil,
27
28
  request_options: {}
28
29
  )
@@ -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,13 @@ module FinchAPI
24
24
  )
25
25
  end
26
26
  def retrieve_many(
27
- # Query param: The entity IDs to specify which entities' data to access.
27
+ # Body param: The array of batch requests. Maximum 10000 items per request.
28
+ requests:,
29
+ # Query param: The entity IDs to specify which entities' data to access. Provide
30
+ # exactly one entity ID per request; a maximum of one is accepted.
28
31
  entity_ids: nil,
29
32
  # Body param
30
33
  options: nil,
31
- # Body param
32
- requests: nil,
33
34
  request_options: {}
34
35
  )
35
36
  end
@@ -28,7 +28,8 @@ module FinchAPI
28
28
  )
29
29
  end
30
30
  def create(
31
- # Query param: The entity IDs to create the rule for.
31
+ # Query param: The entity IDs to create the rule for. Provide exactly one entity
32
+ # ID per request; a maximum of one is accepted.
32
33
  entity_ids: nil,
33
34
  # Body param: Specifies the fields to be applied when the condition is met.
34
35
  attributes: nil,
@@ -59,7 +60,8 @@ module FinchAPI
59
60
  def update(
60
61
  # Path param
61
62
  rule_id,
62
- # Query param: The entity IDs to update the rule for.
63
+ # Query param: The entity IDs to update the rule for. Provide exactly one entity
64
+ # ID per request; a maximum of one is accepted.
63
65
  entity_ids: nil,
64
66
  # Body param
65
67
  optional_property: nil,
@@ -79,7 +81,8 @@ module FinchAPI
79
81
  )
80
82
  end
81
83
  def list(
82
- # The entity IDs to retrieve rules for.
84
+ # The entity IDs to retrieve rules for. Provide exactly one entity ID per request;
85
+ # a maximum of one is accepted.
83
86
  entity_ids: nil,
84
87
  request_options: {}
85
88
  )
@@ -97,7 +100,8 @@ module FinchAPI
97
100
  end
98
101
  def delete(
99
102
  rule_id,
100
- # The entity IDs to delete the rule for.
103
+ # The entity IDs to delete the rule for. Provide exactly one entity ID per
104
+ # request; a maximum of one is accepted.
101
105
  entity_ids: nil,
102
106
  request_options: {}
103
107
  )
@@ -34,7 +34,8 @@ module FinchAPI
34
34
  # The end date to retrieve pay statement items by via their last seen pay date in
35
35
  # `YYYY-MM-DD` format.
36
36
  end_date: nil,
37
- # The entity IDs to specify which entities' data to access.
37
+ # The entity IDs to specify which entities' data to access. Provide exactly one
38
+ # entity ID per request; a maximum of one is accepted.
38
39
  entity_ids: nil,
39
40
  # Case-insensitive partial match search by pay statement item name.
40
41
  name: nil,
@@ -23,9 +23,10 @@ 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
- # Query param: The entity IDs to specify which entities' data to access.
28
+ # Query param: The entity IDs to specify which entities' data to access. Provide
29
+ # exactly one entity ID per request; a maximum of one is accepted.
29
30
  entity_ids: nil,
30
31
  request_options: {}
31
32
  )
@@ -20,7 +20,8 @@ module FinchAPI
20
20
  # The start date to retrieve payments by a company (inclusive) in `YYYY-MM-DD`
21
21
  # format. Filters payments by their **pay_date** field.
22
22
  start_date:,
23
- # The entity IDs to specify which entities' data to access.
23
+ # The entity IDs to specify which entities' data to access. Provide exactly one
24
+ # entity ID per request; a maximum of one is accepted.
24
25
  entity_ids: nil,
25
26
  request_options: {}
26
27
  )
@@ -14,7 +14,8 @@ module FinchAPI
14
14
  end
15
15
  def retrieve(
16
16
  pay_group_id,
17
- # The entity IDs to specify which entities' data to access.
17
+ # The entity IDs to specify which entities' data to access. Provide exactly one
18
+ # entity ID per request; a maximum of one is accepted.
18
19
  entity_ids: nil,
19
20
  request_options: {}
20
21
  )
@@ -34,7 +35,8 @@ module FinchAPI
34
35
  )
35
36
  end
36
37
  def list(
37
- # The entity IDs to specify which entities' data to access.
38
+ # The entity IDs to specify which entities' data to access. Provide exactly one
39
+ # entity ID per request; a maximum of one is accepted.
38
40
  entity_ids: nil,
39
41
  individual_id: nil,
40
42
  pay_frequencies: 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.47
4
+ version: 0.1.0.pre.alpha.49
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-07 00:00:00.000000000 Z
11
+ date: 2026-07-15 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: cgi