finch-api 0.1.0.pre.alpha.4 → 0.1.0.pre.alpha.5

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 (204) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +2 -8
  3. data/lib/finch-api/client.rb +1 -1
  4. data/lib/finch-api/individuals_page.rb +4 -4
  5. data/lib/finch-api/models/access_token_create_params.rb +1 -1
  6. data/lib/finch-api/models/account_disconnect_params.rb +1 -1
  7. data/lib/finch-api/models/account_introspect_params.rb +1 -1
  8. data/lib/finch-api/models/connect/session_new_params.rb +1 -1
  9. data/lib/finch-api/models/connect/session_reauthenticate_params.rb +1 -1
  10. data/lib/finch-api/models/hris/benefit_create_params.rb +1 -1
  11. data/lib/finch-api/models/hris/benefit_list_params.rb +1 -1
  12. data/lib/finch-api/models/hris/benefit_list_supported_benefits_params.rb +1 -1
  13. data/lib/finch-api/models/hris/benefit_retrieve_params.rb +1 -1
  14. data/lib/finch-api/models/hris/benefit_update_params.rb +1 -1
  15. data/lib/finch-api/models/hris/benefits/individual_enroll_many_params.rb +1 -1
  16. data/lib/finch-api/models/hris/benefits/individual_enrolled_ids_params.rb +1 -1
  17. data/lib/finch-api/models/hris/benefits/individual_retrieve_many_benefits_params.rb +1 -1
  18. data/lib/finch-api/models/hris/benefits/individual_unenroll_many_params.rb +1 -1
  19. data/lib/finch-api/models/hris/company_retrieve_params.rb +1 -1
  20. data/lib/finch-api/models/hris/directory_list_individuals_params.rb +1 -1
  21. data/lib/finch-api/models/hris/directory_list_params.rb +1 -1
  22. data/lib/finch-api/models/hris/document_list_params.rb +1 -1
  23. data/lib/finch-api/models/hris/document_retreive_params.rb +1 -1
  24. data/lib/finch-api/models/hris/employment_retrieve_many_params.rb +1 -1
  25. data/lib/finch-api/models/hris/individual_retrieve_many_params.rb +1 -1
  26. data/lib/finch-api/models/hris/pay_statement_retrieve_many_params.rb +1 -1
  27. data/lib/finch-api/models/hris/payment_list_params.rb +1 -1
  28. data/lib/finch-api/models/jobs/automated_create_params.rb +1 -1
  29. data/lib/finch-api/models/jobs/automated_list_params.rb +1 -1
  30. data/lib/finch-api/models/jobs/automated_retrieve_params.rb +1 -1
  31. data/lib/finch-api/models/jobs/manual_retrieve_params.rb +1 -1
  32. data/lib/finch-api/models/payroll/pay_group_list_params.rb +1 -1
  33. data/lib/finch-api/models/payroll/pay_group_retrieve_params.rb +1 -1
  34. data/lib/finch-api/models/provider_list_params.rb +1 -1
  35. data/lib/finch-api/models/request_forwarding_forward_params.rb +1 -1
  36. data/lib/finch-api/models/sandbox/company_update_params.rb +1 -1
  37. data/lib/finch-api/models/sandbox/connection_create_params.rb +1 -1
  38. data/lib/finch-api/models/sandbox/connections/account_create_params.rb +1 -1
  39. data/lib/finch-api/models/sandbox/connections/account_update_params.rb +1 -1
  40. data/lib/finch-api/models/sandbox/directory_create_params.rb +1 -1
  41. data/lib/finch-api/models/sandbox/employment_update_params.rb +1 -1
  42. data/lib/finch-api/models/sandbox/individual_update_params.rb +1 -1
  43. data/lib/finch-api/models/sandbox/job_create_params.rb +1 -1
  44. data/lib/finch-api/models/sandbox/jobs/configuration_retrieve_params.rb +1 -1
  45. data/lib/finch-api/models/sandbox/jobs/configuration_update_params.rb +1 -1
  46. data/lib/finch-api/models/sandbox/payment_create_params.rb +1 -1
  47. data/lib/finch-api/page.rb +4 -4
  48. data/lib/finch-api/request_options.rb +0 -33
  49. data/lib/finch-api/responses_page.rb +3 -3
  50. data/lib/finch-api/single_page.rb +3 -3
  51. data/lib/finch-api/transport/base_client.rb +459 -0
  52. data/lib/finch-api/transport/pooled_net_requester.rb +182 -0
  53. data/lib/finch-api/type/array_of.rb +110 -0
  54. data/lib/finch-api/type/base_model.rb +355 -0
  55. data/lib/finch-api/type/base_page.rb +61 -0
  56. data/lib/finch-api/type/boolean_model.rb +52 -0
  57. data/lib/finch-api/type/converter.rb +211 -0
  58. data/lib/finch-api/type/enum.rb +105 -0
  59. data/lib/finch-api/type/hash_of.rb +136 -0
  60. data/lib/finch-api/type/request_parameters.rb +38 -0
  61. data/lib/finch-api/type/union.rb +204 -0
  62. data/lib/finch-api/type/unknown.rb +56 -0
  63. data/lib/finch-api/type.rb +23 -0
  64. data/lib/finch-api/version.rb +1 -1
  65. data/lib/finch-api.rb +13 -4
  66. data/rbi/lib/finch-api/client.rbi +1 -1
  67. data/rbi/lib/finch-api/individuals_page.rbi +1 -1
  68. data/rbi/lib/finch-api/models/access_token_create_params.rbi +1 -1
  69. data/rbi/lib/finch-api/models/account_disconnect_params.rbi +1 -1
  70. data/rbi/lib/finch-api/models/account_introspect_params.rbi +1 -1
  71. data/rbi/lib/finch-api/models/connect/session_new_params.rbi +1 -1
  72. data/rbi/lib/finch-api/models/connect/session_reauthenticate_params.rbi +1 -1
  73. data/rbi/lib/finch-api/models/hris/benefit_create_params.rbi +1 -1
  74. data/rbi/lib/finch-api/models/hris/benefit_list_params.rbi +1 -1
  75. data/rbi/lib/finch-api/models/hris/benefit_list_supported_benefits_params.rbi +1 -1
  76. data/rbi/lib/finch-api/models/hris/benefit_retrieve_params.rbi +1 -1
  77. data/rbi/lib/finch-api/models/hris/benefit_update_params.rbi +1 -1
  78. data/rbi/lib/finch-api/models/hris/benefits/individual_enroll_many_params.rbi +1 -1
  79. data/rbi/lib/finch-api/models/hris/benefits/individual_enrolled_ids_params.rbi +1 -1
  80. data/rbi/lib/finch-api/models/hris/benefits/individual_retrieve_many_benefits_params.rbi +1 -1
  81. data/rbi/lib/finch-api/models/hris/benefits/individual_unenroll_many_params.rbi +1 -1
  82. data/rbi/lib/finch-api/models/hris/company_retrieve_params.rbi +1 -1
  83. data/rbi/lib/finch-api/models/hris/directory_list_individuals_params.rbi +1 -1
  84. data/rbi/lib/finch-api/models/hris/directory_list_params.rbi +1 -1
  85. data/rbi/lib/finch-api/models/hris/document_list_params.rbi +1 -1
  86. data/rbi/lib/finch-api/models/hris/document_retreive_params.rbi +1 -1
  87. data/rbi/lib/finch-api/models/hris/employment_retrieve_many_params.rbi +1 -1
  88. data/rbi/lib/finch-api/models/hris/individual_retrieve_many_params.rbi +1 -1
  89. data/rbi/lib/finch-api/models/hris/pay_statement_retrieve_many_params.rbi +1 -1
  90. data/rbi/lib/finch-api/models/hris/payment_list_params.rbi +1 -1
  91. data/rbi/lib/finch-api/models/jobs/automated_create_params.rbi +1 -1
  92. data/rbi/lib/finch-api/models/jobs/automated_list_params.rbi +1 -1
  93. data/rbi/lib/finch-api/models/jobs/automated_retrieve_params.rbi +1 -1
  94. data/rbi/lib/finch-api/models/jobs/manual_retrieve_params.rbi +1 -1
  95. data/rbi/lib/finch-api/models/payroll/pay_group_list_params.rbi +1 -1
  96. data/rbi/lib/finch-api/models/payroll/pay_group_retrieve_params.rbi +1 -1
  97. data/rbi/lib/finch-api/models/provider_list_params.rbi +1 -1
  98. data/rbi/lib/finch-api/models/request_forwarding_forward_params.rbi +1 -1
  99. data/rbi/lib/finch-api/models/sandbox/company_update_params.rbi +1 -1
  100. data/rbi/lib/finch-api/models/sandbox/connection_create_params.rbi +1 -1
  101. data/rbi/lib/finch-api/models/sandbox/connections/account_create_params.rbi +1 -1
  102. data/rbi/lib/finch-api/models/sandbox/connections/account_update_params.rbi +1 -1
  103. data/rbi/lib/finch-api/models/sandbox/directory_create_params.rbi +1 -1
  104. data/rbi/lib/finch-api/models/sandbox/directory_create_response.rbi +1 -1
  105. data/rbi/lib/finch-api/models/sandbox/employment_update_params.rbi +1 -1
  106. data/rbi/lib/finch-api/models/sandbox/individual_update_params.rbi +1 -1
  107. data/rbi/lib/finch-api/models/sandbox/job_create_params.rbi +1 -1
  108. data/rbi/lib/finch-api/models/sandbox/jobs/configuration_retrieve_params.rbi +1 -1
  109. data/rbi/lib/finch-api/models/sandbox/jobs/configuration_retrieve_response.rbi +4 -1
  110. data/rbi/lib/finch-api/models/sandbox/jobs/configuration_update_params.rbi +1 -1
  111. data/rbi/lib/finch-api/models/sandbox/payment_create_params.rbi +1 -1
  112. data/rbi/lib/finch-api/page.rbi +1 -1
  113. data/rbi/lib/finch-api/request_options.rbi +0 -15
  114. data/rbi/lib/finch-api/responses_page.rbi +1 -1
  115. data/rbi/lib/finch-api/single_page.rbi +1 -1
  116. data/rbi/lib/finch-api/transport/base_client.rbi +204 -0
  117. data/rbi/lib/finch-api/transport/pooled_net_requester.rbi +64 -0
  118. data/rbi/lib/finch-api/type/array_of.rbi +82 -0
  119. data/rbi/lib/finch-api/type/base_model.rbi +191 -0
  120. data/rbi/lib/finch-api/type/base_page.rbi +38 -0
  121. data/rbi/lib/finch-api/type/boolean_model.rbi +41 -0
  122. data/rbi/lib/finch-api/type/converter.rbi +101 -0
  123. data/rbi/lib/finch-api/type/enum.rbi +58 -0
  124. data/rbi/lib/finch-api/type/hash_of.rbi +86 -0
  125. data/rbi/lib/finch-api/type/request_parameters.rbi +20 -0
  126. data/rbi/lib/finch-api/type/union.rbi +66 -0
  127. data/rbi/lib/finch-api/type/unknown.rbi +37 -0
  128. data/rbi/lib/finch-api/type.rbi +23 -0
  129. data/rbi/lib/finch-api/version.rbi +1 -1
  130. data/sig/finch-api/client.rbs +1 -1
  131. data/sig/finch-api/individuals_page.rbs +1 -1
  132. data/sig/finch-api/models/access_token_create_params.rbs +1 -1
  133. data/sig/finch-api/models/account_disconnect_params.rbs +1 -1
  134. data/sig/finch-api/models/account_introspect_params.rbs +1 -1
  135. data/sig/finch-api/models/connect/session_new_params.rbs +1 -1
  136. data/sig/finch-api/models/connect/session_reauthenticate_params.rbs +1 -1
  137. data/sig/finch-api/models/hris/benefit_create_params.rbs +1 -1
  138. data/sig/finch-api/models/hris/benefit_list_params.rbs +1 -1
  139. data/sig/finch-api/models/hris/benefit_list_supported_benefits_params.rbs +1 -1
  140. data/sig/finch-api/models/hris/benefit_retrieve_params.rbs +1 -1
  141. data/sig/finch-api/models/hris/benefit_update_params.rbs +1 -1
  142. data/sig/finch-api/models/hris/benefits/individual_enroll_many_params.rbs +1 -1
  143. data/sig/finch-api/models/hris/benefits/individual_enrolled_ids_params.rbs +1 -1
  144. data/sig/finch-api/models/hris/benefits/individual_retrieve_many_benefits_params.rbs +1 -1
  145. data/sig/finch-api/models/hris/benefits/individual_unenroll_many_params.rbs +1 -1
  146. data/sig/finch-api/models/hris/company_retrieve_params.rbs +1 -1
  147. data/sig/finch-api/models/hris/directory_list_individuals_params.rbs +1 -1
  148. data/sig/finch-api/models/hris/directory_list_params.rbs +1 -1
  149. data/sig/finch-api/models/hris/document_list_params.rbs +1 -1
  150. data/sig/finch-api/models/hris/document_retreive_params.rbs +1 -1
  151. data/sig/finch-api/models/hris/employment_retrieve_many_params.rbs +1 -1
  152. data/sig/finch-api/models/hris/individual_retrieve_many_params.rbs +1 -1
  153. data/sig/finch-api/models/hris/pay_statement_retrieve_many_params.rbs +1 -1
  154. data/sig/finch-api/models/hris/payment_list_params.rbs +1 -1
  155. data/sig/finch-api/models/jobs/automated_create_params.rbs +1 -1
  156. data/sig/finch-api/models/jobs/automated_list_params.rbs +1 -1
  157. data/sig/finch-api/models/jobs/automated_retrieve_params.rbs +1 -1
  158. data/sig/finch-api/models/jobs/manual_retrieve_params.rbs +1 -1
  159. data/sig/finch-api/models/payroll/pay_group_list_params.rbs +1 -1
  160. data/sig/finch-api/models/payroll/pay_group_retrieve_params.rbs +1 -1
  161. data/sig/finch-api/models/provider_list_params.rbs +1 -1
  162. data/sig/finch-api/models/request_forwarding_forward_params.rbs +1 -1
  163. data/sig/finch-api/models/sandbox/company_update_params.rbs +1 -1
  164. data/sig/finch-api/models/sandbox/connection_create_params.rbs +1 -1
  165. data/sig/finch-api/models/sandbox/connections/account_create_params.rbs +1 -1
  166. data/sig/finch-api/models/sandbox/connections/account_update_params.rbs +1 -1
  167. data/sig/finch-api/models/sandbox/directory_create_params.rbs +1 -1
  168. data/sig/finch-api/models/sandbox/employment_update_params.rbs +1 -1
  169. data/sig/finch-api/models/sandbox/individual_update_params.rbs +1 -1
  170. data/sig/finch-api/models/sandbox/job_create_params.rbs +1 -1
  171. data/sig/finch-api/models/sandbox/jobs/configuration_retrieve_params.rbs +1 -1
  172. data/sig/finch-api/models/sandbox/jobs/configuration_update_params.rbs +1 -1
  173. data/sig/finch-api/models/sandbox/payment_create_params.rbs +1 -1
  174. data/sig/finch-api/page.rbs +1 -1
  175. data/sig/finch-api/request_options.rbs +0 -10
  176. data/sig/finch-api/responses_page.rbs +1 -1
  177. data/sig/finch-api/single_page.rbs +1 -1
  178. data/sig/finch-api/transport/base_client.rbs +110 -0
  179. data/sig/finch-api/transport/pooled_net_requester.rbs +39 -0
  180. data/sig/finch-api/type/array_of.rbs +36 -0
  181. data/sig/finch-api/type/base_model.rbs +73 -0
  182. data/sig/finch-api/type/base_page.rbs +22 -0
  183. data/sig/finch-api/type/boolean_model.rbs +18 -0
  184. data/sig/finch-api/type/converter.rbs +36 -0
  185. data/sig/finch-api/type/enum.rbs +22 -0
  186. data/sig/finch-api/type/hash_of.rbs +36 -0
  187. data/sig/finch-api/type/request_parameters.rbs +13 -0
  188. data/sig/finch-api/type/union.rbs +37 -0
  189. data/sig/finch-api/type/unknown.rbs +18 -0
  190. data/sig/finch-api/type.rbs +22 -0
  191. data/sig/finch-api/version.rbs +1 -1
  192. metadata +40 -13
  193. data/lib/finch-api/base_client.rb +0 -457
  194. data/lib/finch-api/base_model.rb +0 -1174
  195. data/lib/finch-api/base_page.rb +0 -59
  196. data/lib/finch-api/pooled_net_requester.rb +0 -180
  197. data/rbi/lib/finch-api/base_client.rbi +0 -196
  198. data/rbi/lib/finch-api/base_model.rbi +0 -609
  199. data/rbi/lib/finch-api/base_page.rbi +0 -36
  200. data/rbi/lib/finch-api/pooled_net_requester.rbi +0 -59
  201. data/sig/finch-api/base_client.rbs +0 -106
  202. data/sig/finch-api/base_model.rbs +0 -248
  203. data/sig/finch-api/base_page.rbs +0 -20
  204. data/sig/finch-api/pooled_net_requester.rbs +0 -37
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 1d0f37cf81a8ad6be396af08764b428df4f31061e0f67e66c7d9454d6dbad233
4
- data.tar.gz: 3db2ba7ab14b883db90cbaa5f0447854d81ba655ae9f11e68d5a2a568a3907f0
3
+ metadata.gz: 7b7c002fe1850b7514bb890e30becbae720836ae67040dd2406e8802488cac09
4
+ data.tar.gz: 27068a61a877b9a1be40eea72624799be1dfa252344ec992a8d519668b94b5af
5
5
  SHA512:
6
- metadata.gz: c5d436def57e5d2f8c5a7b1e076e028ffc2e35d344117830286147bcf0345c0d3b646b74d5e17113623f850913f7feaf5ac798d34234ff121a6cf6ee55726b87
7
- data.tar.gz: 3cd8ed0ecb5ee2ebaa2700901d74a253a36c94155d921320fbfb015bebacf7fe3ce2723723bc205cc90fe5bc309f923ce496d17b7029aab808c2c0f32d963d15
6
+ metadata.gz: f7a3bae7f45f32a72fe5b508f00db50b618e0795d0f9b064a5a7e0f4211d0dcc2de128eac55dd592471921b7e35840556187a7625fa1ee93792e4dffa71c5bc3
7
+ data.tar.gz: 602ff46f613222a0767bd2c5cf28c5c5c756c48320bf679e910995061f6ec87e72ad51a44a1633d4a2bd13d36b453f2679347aad61418b34f8ccbca6045f150c
data/README.md CHANGED
@@ -12,10 +12,10 @@ The underlying REST API documentation can be found on [developer.tryfinch.com](h
12
12
 
13
13
  ## Installation
14
14
 
15
- To use this gem during the beta, install directly from GitHub with Bundler by adding the following to your application's `Gemfile`:
15
+ To use this gem, install via Bundler by adding the following to your application's `Gemfile`:
16
16
 
17
17
  ```ruby
18
- gem "finch-api", git: "https://github.com/Finch-API/finch-api-ruby", branch: "main"
18
+ gem "finch-api", "~> 0.1.0.pre.alpha.4"
19
19
  ```
20
20
 
21
21
  To fetch an initial copy of the gem:
@@ -24,12 +24,6 @@ To fetch an initial copy of the gem:
24
24
  bundle install
25
25
  ```
26
26
 
27
- To update the version used by your application when updates are pushed to GitHub:
28
-
29
- ```sh
30
- bundle update finch-api
31
- ```
32
-
33
27
  ## Usage
34
28
 
35
29
  ```ruby
@@ -1,7 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module FinchAPI
4
- class Client < FinchAPI::BaseClient
4
+ class Client < FinchAPI::Transport::BaseClient
5
5
  # Default max number of retries to attempt after a failed retryable request.
6
6
  DEFAULT_MAX_RETRIES = 2
7
7
 
@@ -23,7 +23,7 @@ module FinchAPI
23
23
  #
24
24
  # directories => Array
25
25
  class IndividualsPage
26
- include FinchAPI::BasePage
26
+ include FinchAPI::Type::BasePage
27
27
 
28
28
  # @return [Array<Object>, nil]
29
29
  attr_accessor :individuals
@@ -33,7 +33,7 @@ module FinchAPI
33
33
 
34
34
  # @api private
35
35
  #
36
- # @param client [FinchAPI::BaseClient]
36
+ # @param client [FinchAPI::Transport::BaseClient]
37
37
  # @param req [Hash{Symbol=>Object}]
38
38
  # @param headers [Hash{String=>String}, Net::HTTPHeader]
39
39
  # @param page_data [Hash{Symbol=>Object}]
@@ -43,13 +43,13 @@ module FinchAPI
43
43
 
44
44
  case page_data
45
45
  in {individuals: Array | nil => individuals}
46
- @individuals = individuals&.map { FinchAPI::Converter.coerce(model, _1) }
46
+ @individuals = individuals&.map { FinchAPI::Type::Converter.coerce(model, _1) }
47
47
  else
48
48
  end
49
49
 
50
50
  case page_data
51
51
  in {paging: Hash | nil => paging}
52
- @paging = FinchAPI::Converter.coerce(FinchAPI::Models::Paging, paging)
52
+ @paging = FinchAPI::Type::Converter.coerce(FinchAPI::Models::Paging, paging)
53
53
  else
54
54
  end
55
55
  end
@@ -4,7 +4,7 @@ module FinchAPI
4
4
  module Models
5
5
  class AccessTokenCreateParams < FinchAPI::BaseModel
6
6
  # @!parse
7
- # extend FinchAPI::RequestParameters::Converter
7
+ # extend FinchAPI::Type::RequestParameters::Converter
8
8
  include FinchAPI::RequestParameters
9
9
 
10
10
  # @!attribute code
@@ -4,7 +4,7 @@ module FinchAPI
4
4
  module Models
5
5
  class AccountDisconnectParams < FinchAPI::BaseModel
6
6
  # @!parse
7
- # extend FinchAPI::RequestParameters::Converter
7
+ # extend FinchAPI::Type::RequestParameters::Converter
8
8
  include FinchAPI::RequestParameters
9
9
 
10
10
  # @!parse
@@ -4,7 +4,7 @@ module FinchAPI
4
4
  module Models
5
5
  class AccountIntrospectParams < FinchAPI::BaseModel
6
6
  # @!parse
7
- # extend FinchAPI::RequestParameters::Converter
7
+ # extend FinchAPI::Type::RequestParameters::Converter
8
8
  include FinchAPI::RequestParameters
9
9
 
10
10
  # @!parse
@@ -5,7 +5,7 @@ module FinchAPI
5
5
  module Connect
6
6
  class SessionNewParams < FinchAPI::BaseModel
7
7
  # @!parse
8
- # extend FinchAPI::RequestParameters::Converter
8
+ # extend FinchAPI::Type::RequestParameters::Converter
9
9
  include FinchAPI::RequestParameters
10
10
 
11
11
  # @!attribute customer_id
@@ -5,7 +5,7 @@ module FinchAPI
5
5
  module Connect
6
6
  class SessionReauthenticateParams < FinchAPI::BaseModel
7
7
  # @!parse
8
- # extend FinchAPI::RequestParameters::Converter
8
+ # extend FinchAPI::Type::RequestParameters::Converter
9
9
  include FinchAPI::RequestParameters
10
10
 
11
11
  # @!attribute connection_id
@@ -5,7 +5,7 @@ module FinchAPI
5
5
  module HRIS
6
6
  class BenefitCreateParams < FinchAPI::BaseModel
7
7
  # @!parse
8
- # extend FinchAPI::RequestParameters::Converter
8
+ # extend FinchAPI::Type::RequestParameters::Converter
9
9
  include FinchAPI::RequestParameters
10
10
 
11
11
  # @!attribute [r] description
@@ -5,7 +5,7 @@ module FinchAPI
5
5
  module HRIS
6
6
  class BenefitListParams < FinchAPI::BaseModel
7
7
  # @!parse
8
- # extend FinchAPI::RequestParameters::Converter
8
+ # extend FinchAPI::Type::RequestParameters::Converter
9
9
  include FinchAPI::RequestParameters
10
10
 
11
11
  # @!parse
@@ -5,7 +5,7 @@ module FinchAPI
5
5
  module HRIS
6
6
  class BenefitListSupportedBenefitsParams < FinchAPI::BaseModel
7
7
  # @!parse
8
- # extend FinchAPI::RequestParameters::Converter
8
+ # extend FinchAPI::Type::RequestParameters::Converter
9
9
  include FinchAPI::RequestParameters
10
10
 
11
11
  # @!parse
@@ -5,7 +5,7 @@ module FinchAPI
5
5
  module HRIS
6
6
  class BenefitRetrieveParams < FinchAPI::BaseModel
7
7
  # @!parse
8
- # extend FinchAPI::RequestParameters::Converter
8
+ # extend FinchAPI::Type::RequestParameters::Converter
9
9
  include FinchAPI::RequestParameters
10
10
 
11
11
  # @!parse
@@ -5,7 +5,7 @@ module FinchAPI
5
5
  module HRIS
6
6
  class BenefitUpdateParams < FinchAPI::BaseModel
7
7
  # @!parse
8
- # extend FinchAPI::RequestParameters::Converter
8
+ # extend FinchAPI::Type::RequestParameters::Converter
9
9
  include FinchAPI::RequestParameters
10
10
 
11
11
  # @!attribute [r] description
@@ -6,7 +6,7 @@ module FinchAPI
6
6
  module Benefits
7
7
  class IndividualEnrollManyParams < FinchAPI::BaseModel
8
8
  # @!parse
9
- # extend FinchAPI::RequestParameters::Converter
9
+ # extend FinchAPI::Type::RequestParameters::Converter
10
10
  include FinchAPI::RequestParameters
11
11
 
12
12
  # @!attribute [r] individuals
@@ -6,7 +6,7 @@ module FinchAPI
6
6
  module Benefits
7
7
  class IndividualEnrolledIDsParams < FinchAPI::BaseModel
8
8
  # @!parse
9
- # extend FinchAPI::RequestParameters::Converter
9
+ # extend FinchAPI::Type::RequestParameters::Converter
10
10
  include FinchAPI::RequestParameters
11
11
 
12
12
  # @!parse
@@ -6,7 +6,7 @@ module FinchAPI
6
6
  module Benefits
7
7
  class IndividualRetrieveManyBenefitsParams < FinchAPI::BaseModel
8
8
  # @!parse
9
- # extend FinchAPI::RequestParameters::Converter
9
+ # extend FinchAPI::Type::RequestParameters::Converter
10
10
  include FinchAPI::RequestParameters
11
11
 
12
12
  # @!attribute [r] individual_ids
@@ -6,7 +6,7 @@ module FinchAPI
6
6
  module Benefits
7
7
  class IndividualUnenrollManyParams < FinchAPI::BaseModel
8
8
  # @!parse
9
- # extend FinchAPI::RequestParameters::Converter
9
+ # extend FinchAPI::Type::RequestParameters::Converter
10
10
  include FinchAPI::RequestParameters
11
11
 
12
12
  # @!attribute [r] individual_ids
@@ -5,7 +5,7 @@ module FinchAPI
5
5
  module HRIS
6
6
  class CompanyRetrieveParams < FinchAPI::BaseModel
7
7
  # @!parse
8
- # extend FinchAPI::RequestParameters::Converter
8
+ # extend FinchAPI::Type::RequestParameters::Converter
9
9
  include FinchAPI::RequestParameters
10
10
 
11
11
  # @!parse
@@ -5,7 +5,7 @@ module FinchAPI
5
5
  module HRIS
6
6
  class DirectoryListIndividualsParams < FinchAPI::BaseModel
7
7
  # @!parse
8
- # extend FinchAPI::RequestParameters::Converter
8
+ # extend FinchAPI::Type::RequestParameters::Converter
9
9
  include FinchAPI::RequestParameters
10
10
 
11
11
  # @!attribute [r] limit
@@ -5,7 +5,7 @@ module FinchAPI
5
5
  module HRIS
6
6
  class DirectoryListParams < FinchAPI::BaseModel
7
7
  # @!parse
8
- # extend FinchAPI::RequestParameters::Converter
8
+ # extend FinchAPI::Type::RequestParameters::Converter
9
9
  include FinchAPI::RequestParameters
10
10
 
11
11
  # @!attribute [r] limit
@@ -5,7 +5,7 @@ module FinchAPI
5
5
  module HRIS
6
6
  class DocumentListParams < FinchAPI::BaseModel
7
7
  # @!parse
8
- # extend FinchAPI::RequestParameters::Converter
8
+ # extend FinchAPI::Type::RequestParameters::Converter
9
9
  include FinchAPI::RequestParameters
10
10
 
11
11
  # @!attribute [r] individual_ids
@@ -5,7 +5,7 @@ module FinchAPI
5
5
  module HRIS
6
6
  class DocumentRetreiveParams < FinchAPI::BaseModel
7
7
  # @!parse
8
- # extend FinchAPI::RequestParameters::Converter
8
+ # extend FinchAPI::Type::RequestParameters::Converter
9
9
  include FinchAPI::RequestParameters
10
10
 
11
11
  # @!parse
@@ -5,7 +5,7 @@ module FinchAPI
5
5
  module HRIS
6
6
  class EmploymentRetrieveManyParams < FinchAPI::BaseModel
7
7
  # @!parse
8
- # extend FinchAPI::RequestParameters::Converter
8
+ # extend FinchAPI::Type::RequestParameters::Converter
9
9
  include FinchAPI::RequestParameters
10
10
 
11
11
  # @!attribute requests
@@ -5,7 +5,7 @@ module FinchAPI
5
5
  module HRIS
6
6
  class IndividualRetrieveManyParams < FinchAPI::BaseModel
7
7
  # @!parse
8
- # extend FinchAPI::RequestParameters::Converter
8
+ # extend FinchAPI::Type::RequestParameters::Converter
9
9
  include FinchAPI::RequestParameters
10
10
 
11
11
  # @!attribute options
@@ -5,7 +5,7 @@ module FinchAPI
5
5
  module HRIS
6
6
  class PayStatementRetrieveManyParams < FinchAPI::BaseModel
7
7
  # @!parse
8
- # extend FinchAPI::RequestParameters::Converter
8
+ # extend FinchAPI::Type::RequestParameters::Converter
9
9
  include FinchAPI::RequestParameters
10
10
 
11
11
  # @!attribute requests
@@ -5,7 +5,7 @@ module FinchAPI
5
5
  module HRIS
6
6
  class PaymentListParams < FinchAPI::BaseModel
7
7
  # @!parse
8
- # extend FinchAPI::RequestParameters::Converter
8
+ # extend FinchAPI::Type::RequestParameters::Converter
9
9
  include FinchAPI::RequestParameters
10
10
 
11
11
  # @!attribute end_date
@@ -5,7 +5,7 @@ module FinchAPI
5
5
  module Jobs
6
6
  class AutomatedCreateParams < FinchAPI::BaseModel
7
7
  # @!parse
8
- # extend FinchAPI::RequestParameters::Converter
8
+ # extend FinchAPI::Type::RequestParameters::Converter
9
9
  include FinchAPI::RequestParameters
10
10
 
11
11
  # @!attribute type
@@ -5,7 +5,7 @@ module FinchAPI
5
5
  module Jobs
6
6
  class AutomatedListParams < FinchAPI::BaseModel
7
7
  # @!parse
8
- # extend FinchAPI::RequestParameters::Converter
8
+ # extend FinchAPI::Type::RequestParameters::Converter
9
9
  include FinchAPI::RequestParameters
10
10
 
11
11
  # @!attribute [r] limit
@@ -5,7 +5,7 @@ module FinchAPI
5
5
  module Jobs
6
6
  class AutomatedRetrieveParams < FinchAPI::BaseModel
7
7
  # @!parse
8
- # extend FinchAPI::RequestParameters::Converter
8
+ # extend FinchAPI::Type::RequestParameters::Converter
9
9
  include FinchAPI::RequestParameters
10
10
 
11
11
  # @!parse
@@ -5,7 +5,7 @@ module FinchAPI
5
5
  module Jobs
6
6
  class ManualRetrieveParams < FinchAPI::BaseModel
7
7
  # @!parse
8
- # extend FinchAPI::RequestParameters::Converter
8
+ # extend FinchAPI::Type::RequestParameters::Converter
9
9
  include FinchAPI::RequestParameters
10
10
 
11
11
  # @!parse
@@ -5,7 +5,7 @@ module FinchAPI
5
5
  module Payroll
6
6
  class PayGroupListParams < FinchAPI::BaseModel
7
7
  # @!parse
8
- # extend FinchAPI::RequestParameters::Converter
8
+ # extend FinchAPI::Type::RequestParameters::Converter
9
9
  include FinchAPI::RequestParameters
10
10
 
11
11
  # @!attribute [r] individual_id
@@ -5,7 +5,7 @@ module FinchAPI
5
5
  module Payroll
6
6
  class PayGroupRetrieveParams < FinchAPI::BaseModel
7
7
  # @!parse
8
- # extend FinchAPI::RequestParameters::Converter
8
+ # extend FinchAPI::Type::RequestParameters::Converter
9
9
  include FinchAPI::RequestParameters
10
10
 
11
11
  # @!parse
@@ -4,7 +4,7 @@ module FinchAPI
4
4
  module Models
5
5
  class ProviderListParams < FinchAPI::BaseModel
6
6
  # @!parse
7
- # extend FinchAPI::RequestParameters::Converter
7
+ # extend FinchAPI::Type::RequestParameters::Converter
8
8
  include FinchAPI::RequestParameters
9
9
 
10
10
  # @!parse
@@ -4,7 +4,7 @@ module FinchAPI
4
4
  module Models
5
5
  class RequestForwardingForwardParams < FinchAPI::BaseModel
6
6
  # @!parse
7
- # extend FinchAPI::RequestParameters::Converter
7
+ # extend FinchAPI::Type::RequestParameters::Converter
8
8
  include FinchAPI::RequestParameters
9
9
 
10
10
  # @!attribute method_
@@ -5,7 +5,7 @@ module FinchAPI
5
5
  module Sandbox
6
6
  class CompanyUpdateParams < FinchAPI::BaseModel
7
7
  # @!parse
8
- # extend FinchAPI::RequestParameters::Converter
8
+ # extend FinchAPI::Type::RequestParameters::Converter
9
9
  include FinchAPI::RequestParameters
10
10
 
11
11
  # @!attribute accounts
@@ -5,7 +5,7 @@ module FinchAPI
5
5
  module Sandbox
6
6
  class ConnectionCreateParams < FinchAPI::BaseModel
7
7
  # @!parse
8
- # extend FinchAPI::RequestParameters::Converter
8
+ # extend FinchAPI::Type::RequestParameters::Converter
9
9
  include FinchAPI::RequestParameters
10
10
 
11
11
  # @!attribute provider_id
@@ -6,7 +6,7 @@ module FinchAPI
6
6
  module Connections
7
7
  class AccountCreateParams < FinchAPI::BaseModel
8
8
  # @!parse
9
- # extend FinchAPI::RequestParameters::Converter
9
+ # extend FinchAPI::Type::RequestParameters::Converter
10
10
  include FinchAPI::RequestParameters
11
11
 
12
12
  # @!attribute company_id
@@ -6,7 +6,7 @@ module FinchAPI
6
6
  module Connections
7
7
  class AccountUpdateParams < FinchAPI::BaseModel
8
8
  # @!parse
9
- # extend FinchAPI::RequestParameters::Converter
9
+ # extend FinchAPI::Type::RequestParameters::Converter
10
10
  include FinchAPI::RequestParameters
11
11
 
12
12
  # @!attribute [r] connection_status
@@ -5,7 +5,7 @@ module FinchAPI
5
5
  module Sandbox
6
6
  class DirectoryCreateParams < FinchAPI::BaseModel
7
7
  # @!parse
8
- # extend FinchAPI::RequestParameters::Converter
8
+ # extend FinchAPI::Type::RequestParameters::Converter
9
9
  include FinchAPI::RequestParameters
10
10
 
11
11
  # @!attribute [r] body
@@ -5,7 +5,7 @@ module FinchAPI
5
5
  module Sandbox
6
6
  class EmploymentUpdateParams < FinchAPI::BaseModel
7
7
  # @!parse
8
- # extend FinchAPI::RequestParameters::Converter
8
+ # extend FinchAPI::Type::RequestParameters::Converter
9
9
  include FinchAPI::RequestParameters
10
10
 
11
11
  # @!attribute class_code
@@ -5,7 +5,7 @@ module FinchAPI
5
5
  module Sandbox
6
6
  class IndividualUpdateParams < FinchAPI::BaseModel
7
7
  # @!parse
8
- # extend FinchAPI::RequestParameters::Converter
8
+ # extend FinchAPI::Type::RequestParameters::Converter
9
9
  include FinchAPI::RequestParameters
10
10
 
11
11
  # @!attribute dob
@@ -5,7 +5,7 @@ module FinchAPI
5
5
  module Sandbox
6
6
  class JobCreateParams < FinchAPI::BaseModel
7
7
  # @!parse
8
- # extend FinchAPI::RequestParameters::Converter
8
+ # extend FinchAPI::Type::RequestParameters::Converter
9
9
  include FinchAPI::RequestParameters
10
10
 
11
11
  # @!attribute type
@@ -6,7 +6,7 @@ module FinchAPI
6
6
  module Jobs
7
7
  class ConfigurationRetrieveParams < FinchAPI::BaseModel
8
8
  # @!parse
9
- # extend FinchAPI::RequestParameters::Converter
9
+ # extend FinchAPI::Type::RequestParameters::Converter
10
10
  include FinchAPI::RequestParameters
11
11
 
12
12
  # @!parse
@@ -6,7 +6,7 @@ module FinchAPI
6
6
  module Jobs
7
7
  class ConfigurationUpdateParams < FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration
8
8
  # @!parse
9
- # extend FinchAPI::RequestParameters::Converter
9
+ # extend FinchAPI::Type::RequestParameters::Converter
10
10
  include FinchAPI::RequestParameters
11
11
 
12
12
  # @!parse
@@ -5,7 +5,7 @@ module FinchAPI
5
5
  module Sandbox
6
6
  class PaymentCreateParams < FinchAPI::BaseModel
7
7
  # @!parse
8
- # extend FinchAPI::RequestParameters::Converter
8
+ # extend FinchAPI::Type::RequestParameters::Converter
9
9
  include FinchAPI::RequestParameters
10
10
 
11
11
  # @!attribute [r] end_date
@@ -23,7 +23,7 @@ module FinchAPI
23
23
  #
24
24
  # items => Array
25
25
  class Page
26
- include FinchAPI::BasePage
26
+ include FinchAPI::Type::BasePage
27
27
 
28
28
  # @return [Array<Object>, nil]
29
29
  attr_accessor :data
@@ -33,7 +33,7 @@ module FinchAPI
33
33
 
34
34
  # @api private
35
35
  #
36
- # @param client [FinchAPI::BaseClient]
36
+ # @param client [FinchAPI::Transport::BaseClient]
37
37
  # @param req [Hash{Symbol=>Object}]
38
38
  # @param headers [Hash{String=>String}, Net::HTTPHeader]
39
39
  # @param page_data [Hash{Symbol=>Object}]
@@ -43,13 +43,13 @@ module FinchAPI
43
43
 
44
44
  case page_data
45
45
  in {data: Array | nil => data}
46
- @data = data&.map { FinchAPI::Converter.coerce(model, _1) }
46
+ @data = data&.map { FinchAPI::Type::Converter.coerce(model, _1) }
47
47
  else
48
48
  end
49
49
 
50
50
  case page_data
51
51
  in {paging: Hash | nil => paging}
52
- @paging = FinchAPI::Converter.coerce(FinchAPI::Models::Paging, paging)
52
+ @paging = FinchAPI::Type::Converter.coerce(FinchAPI::Models::Paging, paging)
53
53
  else
54
54
  end
55
55
  end
@@ -1,39 +1,6 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module FinchAPI
4
- # @api private
5
- module RequestParameters
6
- # @!parse
7
- # # Options to specify HTTP behaviour for this request.
8
- # # @return [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
9
- # attr_accessor :request_options
10
-
11
- # @param mod [Module]
12
- def self.included(mod)
13
- return unless mod <= FinchAPI::BaseModel
14
-
15
- mod.extend(FinchAPI::RequestParameters::Converter)
16
- mod.optional(:request_options, FinchAPI::RequestOptions)
17
- end
18
-
19
- # @api private
20
- module Converter
21
- # @api private
22
- #
23
- # @param params [Object]
24
- #
25
- # @return [Array(Object, Hash{Symbol=>Object})]
26
- def dump_request(params)
27
- case (dumped = dump(params))
28
- in Hash
29
- [dumped.except(:request_options), dumped[:request_options]]
30
- else
31
- [dumped, nil]
32
- end
33
- end
34
- end
35
- end
36
-
37
4
  # Specify HTTP behaviour to use for a specific request. These options supplement
38
5
  # or override those provided at the client level.
39
6
  #
@@ -23,14 +23,14 @@ module FinchAPI
23
23
  #
24
24
  # individuals => Array
25
25
  class ResponsesPage
26
- include FinchAPI::BasePage
26
+ include FinchAPI::Type::BasePage
27
27
 
28
28
  # @return [Array<Object>, nil]
29
29
  attr_accessor :responses
30
30
 
31
31
  # @api private
32
32
  #
33
- # @param client [FinchAPI::BaseClient]
33
+ # @param client [FinchAPI::Transport::BaseClient]
34
34
  # @param req [Hash{Symbol=>Object}]
35
35
  # @param headers [Hash{String=>String}, Net::HTTPHeader]
36
36
  # @param page_data [Array<Object>]
@@ -40,7 +40,7 @@ module FinchAPI
40
40
 
41
41
  case page_data
42
42
  in {responses: Array | nil => responses}
43
- @responses = responses&.map { FinchAPI::Converter.coerce(model, _1) }
43
+ @responses = responses&.map { FinchAPI::Type::Converter.coerce(model, _1) }
44
44
  else
45
45
  end
46
46
  end
@@ -23,11 +23,11 @@ module FinchAPI
23
23
  #
24
24
  # payments => Array
25
25
  class SinglePage < ::Array
26
- include FinchAPI::BasePage
26
+ include FinchAPI::Type::BasePage
27
27
 
28
28
  # @api private
29
29
  #
30
- # @param client [FinchAPI::BaseClient]
30
+ # @param client [FinchAPI::Transport::BaseClient]
31
31
  # @param req [Hash{Symbol=>Object}]
32
32
  # @param headers [Hash{String=>String}, Net::HTTPHeader]
33
33
  # @param page_data [Array<Object>]
@@ -37,7 +37,7 @@ module FinchAPI
37
37
 
38
38
  case page_data
39
39
  in Array
40
- replace(page_data.map { FinchAPI::Converter.coerce(model, _1) })
40
+ replace(page_data.map { FinchAPI::Type::Converter.coerce(model, _1) })
41
41
  else
42
42
  end
43
43
  end