finch-api 0.1.0.pre.alpha.26 → 0.1.0.pre.alpha.28
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 +16 -0
- data/README.md +1 -1
- data/lib/finch_api/internal/transport/pooled_net_requester.rb +1 -9
- data/lib/finch_api/internal/type/base_model.rb +1 -8
- data/lib/finch_api/internal/util.rb +1 -1
- data/lib/finch_api/models/access_token_create_params.rb +21 -13
- data/lib/finch_api/models/account_update_event.rb +28 -84
- data/lib/finch_api/models/create_access_token_response.rb +42 -42
- data/lib/finch_api/models/hris/benefit_create_params.rb +1 -3
- data/lib/finch_api/models/hris/benefits/individual_enroll_many_params.rb +6 -18
- data/lib/finch_api/models/hris/company/pay_statement_item/rule_create_params.rb +3 -10
- data/lib/finch_api/models/hris/company/pay_statement_item_list_params.rb +1 -3
- data/lib/finch_api/models/hris/company_benefit.rb +1 -3
- data/lib/finch_api/models/hris/document_list_params.rb +1 -4
- data/lib/finch_api/models/hris/employment_retrieve_many_params.rb +1 -3
- data/lib/finch_api/models/hris/individual_retrieve_many_params.rb +1 -3
- data/lib/finch_api/models/hris/pay_statement.rb +1 -4
- data/lib/finch_api/models/hris/pay_statement_retrieve_many_params.rb +1 -3
- data/lib/finch_api/models/introspection.rb +180 -137
- data/lib/finch_api/models/provider.rb +19 -68
- data/lib/finch_api/models/sandbox/connection_create_params.rb +1 -4
- data/lib/finch_api/models/sandbox/directory_create_params.rb +1 -4
- data/lib/finch_api/models/sandbox/payment_create_params.rb +7 -22
- data/lib/finch_api/resources/access_tokens.rb +9 -5
- data/lib/finch_api/version.rb +1 -1
- data/rbi/finch_api/errors.rbi +2 -2
- data/rbi/finch_api/models/access_token_create_params.rbi +17 -15
- data/rbi/finch_api/models/create_access_token_response.rbi +54 -51
- data/rbi/finch_api/models/introspection.rbi +309 -236
- data/rbi/finch_api/resources/access_tokens.rbi +7 -3
- data/sig/finch_api/models/access_token_create_params.rbs +7 -11
- data/sig/finch_api/models/create_access_token_response.rbs +25 -23
- data/sig/finch_api/models/introspection.rbs +139 -117
- data/sig/finch_api/resources/access_tokens.rbs +2 -2
- 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: ecf78c65c2b898a2b5031cd7fcc3328bfdc13e98431b09900bc6e1d8210edca8
|
4
|
+
data.tar.gz: 9d8bb5ffed3d5db0299511d1204935d73e3b3cf039e876925135cc17a8e405b9
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 7886c407c082c9c2ca8070104bd1024515434914420b22e1a20df818cfe8d37aebac55d0687ea126f93dc3a0d1b7c4628d7b178dc5f7dcf8bdd93e5c9ede7be8
|
7
|
+
data.tar.gz: 23e139493a3c37ed53380063b9f3dd3507e542baea5f5c5afe59c95b2850f00e311bff1fe5fb645499c2ff10f337b91d3de7e51232f4fac3d3b6949ef16015b0
|
data/CHANGELOG.md
CHANGED
@@ -1,5 +1,21 @@
|
|
1
1
|
# Changelog
|
2
2
|
|
3
|
+
## 0.1.0-alpha.28 (2025-08-20)
|
4
|
+
|
5
|
+
Full Changelog: [v0.1.0-alpha.27...v0.1.0-alpha.28](https://github.com/Finch-API/finch-api-ruby/compare/v0.1.0-alpha.27...v0.1.0-alpha.28)
|
6
|
+
|
7
|
+
### Features
|
8
|
+
|
9
|
+
* **api:** api update ([e615899](https://github.com/Finch-API/finch-api-ruby/commit/e615899d0e9c1243db7fa677f08411ef4c291bbd))
|
10
|
+
|
11
|
+
## 0.1.0-alpha.27 (2025-08-19)
|
12
|
+
|
13
|
+
Full Changelog: [v0.1.0-alpha.26...v0.1.0-alpha.27](https://github.com/Finch-API/finch-api-ruby/compare/v0.1.0-alpha.26...v0.1.0-alpha.27)
|
14
|
+
|
15
|
+
### Bug Fixes
|
16
|
+
|
17
|
+
* bump sorbet version and fix new type errors from the breaking change ([166381e](https://github.com/Finch-API/finch-api-ruby/commit/166381ebd49719646b7c0242605bd7caace4b780))
|
18
|
+
|
3
19
|
## 0.1.0-alpha.26 (2025-08-14)
|
4
20
|
|
5
21
|
Full Changelog: [v0.1.0-alpha.25...v0.1.0-alpha.26](https://github.com/Finch-API/finch-api-ruby/compare/v0.1.0-alpha.25...v0.1.0-alpha.26)
|
data/README.md
CHANGED
@@ -17,7 +17,7 @@ To use this gem, install via Bundler by adding the following to your application
|
|
17
17
|
<!-- x-release-please-start-version -->
|
18
18
|
|
19
19
|
```ruby
|
20
|
-
gem "finch-api", "~> 0.1.0.pre.alpha.
|
20
|
+
gem "finch-api", "~> 0.1.0.pre.alpha.28"
|
21
21
|
```
|
22
22
|
|
23
23
|
<!-- x-release-please-end -->
|
@@ -193,15 +193,7 @@ module FinchAPI
|
|
193
193
|
end
|
194
194
|
|
195
195
|
define_sorbet_constant!(:Request) do
|
196
|
-
T.type_alias
|
197
|
-
{
|
198
|
-
method: Symbol,
|
199
|
-
url: URI::Generic,
|
200
|
-
headers: T::Hash[String, String],
|
201
|
-
body: T.anything,
|
202
|
-
deadline: Float
|
203
|
-
}
|
204
|
-
end
|
196
|
+
T.type_alias { {method: Symbol, url: URI::Generic, headers: T::Hash[String, String], body: T.anything, deadline: Float} }
|
205
197
|
end
|
206
198
|
end
|
207
199
|
end
|
@@ -64,14 +64,7 @@ module FinchAPI
|
|
64
64
|
setter = :"#{name_sym}="
|
65
65
|
api_name = info.fetch(:api_name, name_sym)
|
66
66
|
nilable = info.fetch(:nil?, false)
|
67
|
-
const =
|
68
|
-
info.fetch(
|
69
|
-
:const,
|
70
|
-
FinchAPI::Internal::OMIT
|
71
|
-
)
|
72
|
-
else
|
73
|
-
FinchAPI::Internal::OMIT
|
74
|
-
end
|
67
|
+
const = required && !nilable ? info.fetch(:const, FinchAPI::Internal::OMIT) : FinchAPI::Internal::OMIT
|
75
68
|
|
76
69
|
[name_sym, setter].each { undef_method(_1) } if known_fields.key?(name_sym)
|
77
70
|
|
@@ -244,7 +244,7 @@ module FinchAPI
|
|
244
244
|
#
|
245
245
|
# @return [String]
|
246
246
|
def uri_origin(uri)
|
247
|
-
"#{uri.scheme}://#{uri.host}#{uri.port
|
247
|
+
"#{uri.scheme}://#{uri.host}#{":#{uri.port}" unless uri.port == uri.default_port}"
|
248
248
|
end
|
249
249
|
|
250
250
|
# @api private
|
@@ -7,31 +7,39 @@ module FinchAPI
|
|
7
7
|
extend FinchAPI::Internal::Type::RequestParameters::Converter
|
8
8
|
include FinchAPI::Internal::Type::RequestParameters
|
9
9
|
|
10
|
-
# @!attribute
|
10
|
+
# @!attribute client_id
|
11
|
+
# The client ID for your application
|
11
12
|
#
|
12
13
|
# @return [String]
|
13
|
-
required :
|
14
|
+
required :client_id, String
|
14
15
|
|
15
|
-
# @!attribute
|
16
|
+
# @!attribute client_secret
|
17
|
+
# The client secret for your application
|
16
18
|
#
|
17
|
-
# @return [String
|
18
|
-
|
19
|
+
# @return [String]
|
20
|
+
required :client_secret, String
|
19
21
|
|
20
|
-
# @!attribute
|
22
|
+
# @!attribute code
|
23
|
+
# The authorization code received from the authorization server
|
21
24
|
#
|
22
|
-
# @return [String
|
23
|
-
|
25
|
+
# @return [String]
|
26
|
+
required :code, String
|
24
27
|
|
25
28
|
# @!attribute redirect_uri
|
29
|
+
# The redirect URI used in the authorization request (optional)
|
26
30
|
#
|
27
31
|
# @return [String, nil]
|
28
32
|
optional :redirect_uri, String
|
29
33
|
|
30
|
-
# @!method initialize(
|
31
|
-
# @param
|
32
|
-
#
|
33
|
-
# @param client_secret [String]
|
34
|
-
#
|
34
|
+
# @!method initialize(client_id:, client_secret:, code:, redirect_uri: nil, request_options: {})
|
35
|
+
# @param client_id [String] The client ID for your application
|
36
|
+
#
|
37
|
+
# @param client_secret [String] The client secret for your application
|
38
|
+
#
|
39
|
+
# @param code [String] The authorization code received from the authorization server
|
40
|
+
#
|
41
|
+
# @param redirect_uri [String] The redirect URI used in the authorization request (optional)
|
42
|
+
#
|
35
43
|
# @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
|
36
44
|
end
|
37
45
|
end
|
@@ -78,41 +78,31 @@ module FinchAPI
|
|
78
78
|
#
|
79
79
|
# @return [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory, nil]
|
80
80
|
optional :directory,
|
81
|
-
-> {
|
82
|
-
FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory
|
83
|
-
}
|
81
|
+
-> { FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory }
|
84
82
|
|
85
83
|
# @!attribute employment
|
86
84
|
#
|
87
85
|
# @return [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment, nil]
|
88
86
|
optional :employment,
|
89
|
-
-> {
|
90
|
-
FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment
|
91
|
-
}
|
87
|
+
-> { FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment }
|
92
88
|
|
93
89
|
# @!attribute individual
|
94
90
|
#
|
95
91
|
# @return [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual, nil]
|
96
92
|
optional :individual,
|
97
|
-
-> {
|
98
|
-
FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual
|
99
|
-
}
|
93
|
+
-> { FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual }
|
100
94
|
|
101
95
|
# @!attribute pay_group
|
102
96
|
#
|
103
97
|
# @return [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayGroup, nil]
|
104
98
|
optional :pay_group,
|
105
|
-
-> {
|
106
|
-
FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayGroup
|
107
|
-
}
|
99
|
+
-> { FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayGroup }
|
108
100
|
|
109
101
|
# @!attribute pay_statement
|
110
102
|
#
|
111
103
|
# @return [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement, nil]
|
112
104
|
optional :pay_statement,
|
113
|
-
-> {
|
114
|
-
FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement
|
115
|
-
}
|
105
|
+
-> { FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement }
|
116
106
|
|
117
107
|
# @!attribute payment
|
118
108
|
#
|
@@ -142,17 +132,13 @@ module FinchAPI
|
|
142
132
|
#
|
143
133
|
# @return [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Accounts, nil]
|
144
134
|
optional :accounts,
|
145
|
-
-> {
|
146
|
-
FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Accounts
|
147
|
-
}
|
135
|
+
-> { FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Accounts }
|
148
136
|
|
149
137
|
# @!attribute departments
|
150
138
|
#
|
151
139
|
# @return [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Departments, nil]
|
152
140
|
optional :departments,
|
153
|
-
-> {
|
154
|
-
FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Departments
|
155
|
-
}
|
141
|
+
-> { FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Departments }
|
156
142
|
|
157
143
|
# @!attribute ein
|
158
144
|
#
|
@@ -163,9 +149,7 @@ module FinchAPI
|
|
163
149
|
#
|
164
150
|
# @return [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Entity, nil]
|
165
151
|
optional :entity,
|
166
|
-
-> {
|
167
|
-
FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Entity
|
168
|
-
}
|
152
|
+
-> { FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Entity }
|
169
153
|
|
170
154
|
# @!attribute legal_name
|
171
155
|
#
|
@@ -176,9 +160,7 @@ module FinchAPI
|
|
176
160
|
#
|
177
161
|
# @return [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Locations, nil]
|
178
162
|
optional :locations,
|
179
|
-
-> {
|
180
|
-
FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Locations
|
181
|
-
}
|
163
|
+
-> { FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Locations }
|
182
164
|
|
183
165
|
# @!attribute primary_email
|
184
166
|
#
|
@@ -247,9 +229,7 @@ module FinchAPI
|
|
247
229
|
#
|
248
230
|
# @return [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Departments::Parent, nil]
|
249
231
|
optional :parent,
|
250
|
-
-> {
|
251
|
-
FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Departments::Parent
|
252
|
-
}
|
232
|
+
-> { FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Departments::Parent }
|
253
233
|
|
254
234
|
# @!method initialize(name: nil, parent: nil)
|
255
235
|
# @param name [Boolean]
|
@@ -332,17 +312,13 @@ module FinchAPI
|
|
332
312
|
#
|
333
313
|
# @return [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Individuals, nil]
|
334
314
|
optional :individuals,
|
335
|
-
-> {
|
336
|
-
FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Individuals
|
337
|
-
}
|
315
|
+
-> { FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Individuals }
|
338
316
|
|
339
317
|
# @!attribute paging
|
340
318
|
#
|
341
319
|
# @return [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Paging, nil]
|
342
320
|
optional :paging,
|
343
|
-
-> {
|
344
|
-
FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Paging
|
345
|
-
}
|
321
|
+
-> { FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Paging }
|
346
322
|
|
347
323
|
# @!method initialize(individuals: nil, paging: nil)
|
348
324
|
# @param individuals [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Individuals]
|
@@ -379,9 +355,7 @@ module FinchAPI
|
|
379
355
|
#
|
380
356
|
# @return [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Individuals::Manager, nil]
|
381
357
|
optional :manager,
|
382
|
-
-> {
|
383
|
-
FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Individuals::Manager
|
384
|
-
}
|
358
|
+
-> { FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Individuals::Manager }
|
385
359
|
|
386
360
|
# @!attribute middle_name
|
387
361
|
#
|
@@ -448,17 +422,13 @@ module FinchAPI
|
|
448
422
|
#
|
449
423
|
# @return [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Department, nil]
|
450
424
|
optional :department,
|
451
|
-
-> {
|
452
|
-
FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Department
|
453
|
-
}
|
425
|
+
-> { FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Department }
|
454
426
|
|
455
427
|
# @!attribute employment
|
456
428
|
#
|
457
429
|
# @return [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Employment, nil]
|
458
430
|
optional :employment,
|
459
|
-
-> {
|
460
|
-
FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Employment
|
461
|
-
}
|
431
|
+
-> { FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Employment }
|
462
432
|
|
463
433
|
# @!attribute employment_status
|
464
434
|
#
|
@@ -479,9 +449,7 @@ module FinchAPI
|
|
479
449
|
#
|
480
450
|
# @return [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Income, nil]
|
481
451
|
optional :income,
|
482
|
-
-> {
|
483
|
-
FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Income
|
484
|
-
}
|
452
|
+
-> { FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Income }
|
485
453
|
|
486
454
|
# @!attribute income_history
|
487
455
|
#
|
@@ -502,17 +470,13 @@ module FinchAPI
|
|
502
470
|
#
|
503
471
|
# @return [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Location, nil]
|
504
472
|
optional :location,
|
505
|
-
-> {
|
506
|
-
FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Location
|
507
|
-
}
|
473
|
+
-> { FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Location }
|
508
474
|
|
509
475
|
# @!attribute manager
|
510
476
|
#
|
511
477
|
# @return [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Manager, nil]
|
512
478
|
optional :manager,
|
513
|
-
-> {
|
514
|
-
FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Manager
|
515
|
-
}
|
479
|
+
-> { FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Manager }
|
516
480
|
|
517
481
|
# @!attribute middle_name
|
518
482
|
#
|
@@ -668,9 +632,7 @@ module FinchAPI
|
|
668
632
|
#
|
669
633
|
# @return [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::Emails, nil]
|
670
634
|
optional :emails,
|
671
|
-
-> {
|
672
|
-
FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::Emails
|
673
|
-
}
|
635
|
+
-> { FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::Emails }
|
674
636
|
|
675
637
|
# @!attribute encrypted_ssn
|
676
638
|
#
|
@@ -706,9 +668,7 @@ module FinchAPI
|
|
706
668
|
#
|
707
669
|
# @return [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::PhoneNumbers, nil]
|
708
670
|
optional :phone_numbers,
|
709
|
-
-> {
|
710
|
-
FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::PhoneNumbers
|
711
|
-
}
|
671
|
+
-> { FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::PhoneNumbers }
|
712
672
|
|
713
673
|
# @!attribute preferred_name
|
714
674
|
#
|
@@ -719,9 +679,7 @@ module FinchAPI
|
|
719
679
|
#
|
720
680
|
# @return [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::Residence, nil]
|
721
681
|
optional :residence,
|
722
|
-
-> {
|
723
|
-
FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::Residence
|
724
|
-
}
|
682
|
+
-> { FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::Residence }
|
725
683
|
|
726
684
|
# @!attribute ssn
|
727
685
|
#
|
@@ -854,17 +812,13 @@ module FinchAPI
|
|
854
812
|
#
|
855
813
|
# @return [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::Paging, nil]
|
856
814
|
optional :paging,
|
857
|
-
-> {
|
858
|
-
FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::Paging
|
859
|
-
}
|
815
|
+
-> { FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::Paging }
|
860
816
|
|
861
817
|
# @!attribute pay_statements
|
862
818
|
#
|
863
819
|
# @return [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements, nil]
|
864
820
|
optional :pay_statements,
|
865
|
-
-> {
|
866
|
-
FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements
|
867
|
-
}
|
821
|
+
-> { FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements }
|
868
822
|
|
869
823
|
# @!method initialize(paging: nil, pay_statements: nil)
|
870
824
|
# @param paging [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::Paging]
|
@@ -893,25 +847,19 @@ module FinchAPI
|
|
893
847
|
#
|
894
848
|
# @return [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Earnings, nil]
|
895
849
|
optional :earnings,
|
896
|
-
-> {
|
897
|
-
FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Earnings
|
898
|
-
}
|
850
|
+
-> { FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Earnings }
|
899
851
|
|
900
852
|
# @!attribute employee_deductions
|
901
853
|
#
|
902
854
|
# @return [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployeeDeductions, nil]
|
903
855
|
optional :employee_deductions,
|
904
|
-
-> {
|
905
|
-
FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployeeDeductions
|
906
|
-
}
|
856
|
+
-> { FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployeeDeductions }
|
907
857
|
|
908
858
|
# @!attribute employer_contributions
|
909
859
|
#
|
910
860
|
# @return [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployerContributions, nil]
|
911
861
|
optional :employer_contributions,
|
912
|
-
-> {
|
913
|
-
FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployerContributions
|
914
|
-
}
|
862
|
+
-> { FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployerContributions }
|
915
863
|
|
916
864
|
# @!attribute gross_pay
|
917
865
|
#
|
@@ -937,9 +885,7 @@ module FinchAPI
|
|
937
885
|
#
|
938
886
|
# @return [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Taxes, nil]
|
939
887
|
optional :taxes,
|
940
|
-
-> {
|
941
|
-
FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Taxes
|
942
|
-
}
|
888
|
+
-> { FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Taxes }
|
943
889
|
|
944
890
|
# @!attribute total_hours
|
945
891
|
#
|
@@ -1148,9 +1094,7 @@ module FinchAPI
|
|
1148
1094
|
#
|
1149
1095
|
# @return [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Payment::PayPeriod, nil]
|
1150
1096
|
optional :pay_period,
|
1151
|
-
-> {
|
1152
|
-
FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Payment::PayPeriod
|
1153
|
-
}
|
1097
|
+
-> { FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Payment::PayPeriod }
|
1154
1098
|
|
1155
1099
|
# @!method initialize(id: nil, company_debit: nil, debit_date: nil, employee_taxes: nil, employer_taxes: nil, gross_pay: nil, individual_ids: nil, net_pay: nil, pay_date: nil, pay_frequencies: nil, pay_group_ids: nil, pay_period: nil)
|
1156
1100
|
# @param id [Boolean]
|
@@ -5,37 +5,19 @@ module FinchAPI
|
|
5
5
|
# @see FinchAPI::Resources::AccessTokens#create
|
6
6
|
class CreateAccessTokenResponse < FinchAPI::Internal::Type::BaseModel
|
7
7
|
# @!attribute access_token
|
8
|
-
# The access token for the connection
|
8
|
+
# The access token for the connection
|
9
9
|
#
|
10
10
|
# @return [String]
|
11
11
|
required :access_token, String
|
12
12
|
|
13
|
-
# @!attribute account_id
|
14
|
-
# @deprecated
|
15
|
-
#
|
16
|
-
# [DEPRECATED] Use `connection_id` to identify the connection instead of this
|
17
|
-
# account ID.
|
18
|
-
#
|
19
|
-
# @return [String]
|
20
|
-
required :account_id, String
|
21
|
-
|
22
13
|
# @!attribute client_type
|
23
14
|
# The type of application associated with a token.
|
24
15
|
#
|
25
16
|
# @return [Symbol, FinchAPI::Models::CreateAccessTokenResponse::ClientType]
|
26
17
|
required :client_type, enum: -> { FinchAPI::CreateAccessTokenResponse::ClientType }
|
27
18
|
|
28
|
-
# @!attribute company_id
|
29
|
-
# @deprecated
|
30
|
-
#
|
31
|
-
# [DEPRECATED] Use `connection_id` to identify the connection instead of this
|
32
|
-
# company ID.
|
33
|
-
#
|
34
|
-
# @return [String]
|
35
|
-
required :company_id, String
|
36
|
-
|
37
19
|
# @!attribute connection_id
|
38
|
-
# The Finch UUID of the connection associated with the `access_token
|
20
|
+
# The Finch UUID of the connection associated with the `access_token`
|
39
21
|
#
|
40
22
|
# @return [String]
|
41
23
|
required :connection_id, String
|
@@ -50,53 +32,71 @@ module FinchAPI
|
|
50
32
|
required :connection_type, enum: -> { FinchAPI::CreateAccessTokenResponse::ConnectionType }
|
51
33
|
|
52
34
|
# @!attribute products
|
53
|
-
# An array of the authorized products associated with the `access_token
|
35
|
+
# An array of the authorized products associated with the `access_token`
|
54
36
|
#
|
55
37
|
# @return [Array<String>]
|
56
38
|
required :products, FinchAPI::Internal::Type::ArrayOf[String]
|
57
39
|
|
58
40
|
# @!attribute provider_id
|
59
|
-
# The ID of the provider associated with the `access_token
|
41
|
+
# The ID of the provider associated with the `access_token`
|
60
42
|
#
|
61
43
|
# @return [String]
|
62
44
|
required :provider_id, String
|
63
45
|
|
64
|
-
# @!attribute
|
65
|
-
# The
|
66
|
-
#
|
46
|
+
# @!attribute token_type
|
47
|
+
# The RFC 8693 token type (Finch uses `bearer` tokens)
|
48
|
+
#
|
49
|
+
# @return [String]
|
50
|
+
required :token_type, String
|
51
|
+
|
52
|
+
# @!attribute account_id
|
53
|
+
# @deprecated
|
54
|
+
#
|
55
|
+
# [DEPRECATED] Use `connection_id` to identify the connection instead of this
|
56
|
+
# account ID
|
67
57
|
#
|
68
58
|
# @return [String, nil]
|
69
|
-
optional :
|
59
|
+
optional :account_id, String
|
70
60
|
|
71
|
-
# @!attribute
|
72
|
-
#
|
61
|
+
# @!attribute company_id
|
62
|
+
# @deprecated
|
63
|
+
#
|
64
|
+
# [DEPRECATED] Use `connection_id` to identify the connection instead of this
|
65
|
+
# company ID
|
66
|
+
#
|
67
|
+
# @return [String, nil]
|
68
|
+
optional :company_id, String
|
69
|
+
|
70
|
+
# @!attribute customer_id
|
71
|
+
# The ID of your customer you provided to Finch when a connect session was created
|
72
|
+
# for this connection
|
73
73
|
#
|
74
74
|
# @return [String, nil]
|
75
|
-
optional :
|
75
|
+
optional :customer_id, String, nil?: true
|
76
76
|
|
77
|
-
# @!method initialize(access_token:,
|
77
|
+
# @!method initialize(access_token:, client_type:, connection_id:, connection_type:, products:, provider_id:, token_type:, account_id: nil, company_id: nil, customer_id: nil)
|
78
78
|
# Some parameter documentations has been truncated, see
|
79
79
|
# {FinchAPI::Models::CreateAccessTokenResponse} for more details.
|
80
80
|
#
|
81
|
-
# @param access_token [String] The access token for the connection
|
82
|
-
#
|
83
|
-
# @param account_id [String] [DEPRECATED] Use `connection_id` to identify the connection instead of this acco
|
81
|
+
# @param access_token [String] The access token for the connection
|
84
82
|
#
|
85
83
|
# @param client_type [Symbol, FinchAPI::Models::CreateAccessTokenResponse::ClientType] The type of application associated with a token.
|
86
84
|
#
|
87
|
-
# @param
|
88
|
-
#
|
89
|
-
# @param connection_id [String] The Finch UUID of the connection associated with the `access_token`.
|
85
|
+
# @param connection_id [String] The Finch UUID of the connection associated with the `access_token`
|
90
86
|
#
|
91
87
|
# @param connection_type [Symbol, FinchAPI::Models::CreateAccessTokenResponse::ConnectionType] The type of the connection associated with the token.
|
92
88
|
#
|
93
|
-
# @param products [Array<String>] An array of the authorized products associated with the `access_token
|
94
|
-
#
|
95
|
-
# @param provider_id [String] The ID of the provider associated with the `access_token`.
|
89
|
+
# @param products [Array<String>] An array of the authorized products associated with the `access_token`
|
96
90
|
#
|
97
|
-
# @param
|
91
|
+
# @param provider_id [String] The ID of the provider associated with the `access_token`
|
98
92
|
#
|
99
93
|
# @param token_type [String] The RFC 8693 token type (Finch uses `bearer` tokens)
|
94
|
+
#
|
95
|
+
# @param account_id [String] [DEPRECATED] Use `connection_id` to identify the connection instead of this acco
|
96
|
+
#
|
97
|
+
# @param company_id [String] [DEPRECATED] Use `connection_id` to identify the connection instead of this comp
|
98
|
+
#
|
99
|
+
# @param customer_id [String, nil] The ID of your customer you provided to Finch when a connect session was created
|
100
100
|
|
101
101
|
# The type of application associated with a token.
|
102
102
|
#
|
@@ -104,8 +104,8 @@ module FinchAPI
|
|
104
104
|
module ClientType
|
105
105
|
extend FinchAPI::Internal::Type::Enum
|
106
106
|
|
107
|
-
PRODUCTION = :production
|
108
107
|
DEVELOPMENT = :development
|
108
|
+
PRODUCTION = :production
|
109
109
|
SANDBOX = :sandbox
|
110
110
|
|
111
111
|
# @!method self.values
|
@@ -121,8 +121,8 @@ module FinchAPI
|
|
121
121
|
module ConnectionType
|
122
122
|
extend FinchAPI::Internal::Type::Enum
|
123
123
|
|
124
|
-
PROVIDER = :provider
|
125
124
|
FINCH = :finch
|
125
|
+
PROVIDER = :provider
|
126
126
|
|
127
127
|
# @!method self.values
|
128
128
|
# @return [Array<Symbol>]
|
@@ -55,9 +55,7 @@ module FinchAPI
|
|
55
55
|
#
|
56
56
|
# @return [Array<FinchAPI::Models::HRIS::BenefitCreateParams::CompanyContribution::Tier>]
|
57
57
|
required :tiers,
|
58
|
-
-> {
|
59
|
-
FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::BenefitCreateParams::CompanyContribution::Tier]
|
60
|
-
}
|
58
|
+
-> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::BenefitCreateParams::CompanyContribution::Tier] }
|
61
59
|
|
62
60
|
# @!attribute type
|
63
61
|
#
|
@@ -14,9 +14,7 @@ module FinchAPI
|
|
14
14
|
#
|
15
15
|
# @return [Array<FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual>, nil]
|
16
16
|
optional :individuals,
|
17
|
-
-> {
|
18
|
-
FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual]
|
19
|
-
}
|
17
|
+
-> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual] }
|
20
18
|
|
21
19
|
# @!method initialize(individuals: nil, request_options: {})
|
22
20
|
# @param individuals [Array<FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual>] Array of the individual_id to enroll and a configuration object.
|
@@ -49,9 +47,7 @@ module FinchAPI
|
|
49
47
|
#
|
50
48
|
# @return [Symbol, FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::AnnualContributionLimit, nil]
|
51
49
|
optional :annual_contribution_limit,
|
52
|
-
enum: -> {
|
53
|
-
FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::AnnualContributionLimit
|
54
|
-
}
|
50
|
+
enum: -> { FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::AnnualContributionLimit }
|
55
51
|
|
56
52
|
# @!attribute annual_maximum
|
57
53
|
# Maximum annual amount in cents
|
@@ -69,9 +65,7 @@ module FinchAPI
|
|
69
65
|
#
|
70
66
|
# @return [FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution, nil]
|
71
67
|
optional :company_contribution,
|
72
|
-
-> {
|
73
|
-
FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution
|
74
|
-
}
|
68
|
+
-> { FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution }
|
75
69
|
|
76
70
|
# @!attribute effective_date
|
77
71
|
# The date the enrollment will take effect
|
@@ -83,9 +77,7 @@ module FinchAPI
|
|
83
77
|
#
|
84
78
|
# @return [FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction, nil]
|
85
79
|
optional :employee_deduction,
|
86
|
-
-> {
|
87
|
-
FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction
|
88
|
-
}
|
80
|
+
-> { FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction }
|
89
81
|
|
90
82
|
# @!method initialize(annual_contribution_limit: nil, annual_maximum: nil, catch_up: nil, company_contribution: nil, effective_date: nil, employee_deduction: nil)
|
91
83
|
# Some parameter documentations has been truncated, see
|
@@ -131,9 +123,7 @@ module FinchAPI
|
|
131
123
|
#
|
132
124
|
# @return [Symbol, FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::Type, nil]
|
133
125
|
optional :type,
|
134
|
-
enum: -> {
|
135
|
-
FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::Type
|
136
|
-
}
|
126
|
+
enum: -> { FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::Type }
|
137
127
|
|
138
128
|
# @!method initialize(amount: nil, type: nil)
|
139
129
|
# Some parameter documentations has been truncated, see
|
@@ -169,9 +159,7 @@ module FinchAPI
|
|
169
159
|
#
|
170
160
|
# @return [Symbol, FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction::Type, nil]
|
171
161
|
optional :type,
|
172
|
-
enum: -> {
|
173
|
-
FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction::Type
|
174
|
-
}
|
162
|
+
enum: -> { FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction::Type }
|
175
163
|
|
176
164
|
# @!method initialize(amount: nil, type: nil)
|
177
165
|
# Some parameter documentations has been truncated, see
|