straddle 0.1.1 → 0.3.0

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 (248) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +66 -0
  3. data/README.md +2 -2
  4. data/SECURITY.md +1 -1
  5. data/lib/straddle/client.rb +3 -3
  6. data/lib/straddle/errors.rb +25 -11
  7. data/lib/straddle/file_part.rb +10 -7
  8. data/lib/straddle/internal/page_number_schema.rb +1 -1
  9. data/lib/straddle/internal/transport/base_client.rb +19 -9
  10. data/lib/straddle/internal/transport/pooled_net_requester.rb +41 -42
  11. data/lib/straddle/internal/type/array_of.rb +1 -0
  12. data/lib/straddle/internal/type/base_model.rb +4 -9
  13. data/lib/straddle/internal/type/base_page.rb +1 -1
  14. data/lib/straddle/internal/type/converter.rb +27 -0
  15. data/lib/straddle/internal/type/file_input.rb +7 -4
  16. data/lib/straddle/internal/type/hash_of.rb +1 -0
  17. data/lib/straddle/internal/type/union.rb +9 -7
  18. data/lib/straddle/internal/util.rb +9 -8
  19. data/lib/straddle/models/bridge/link_bank_account_params.rb +39 -6
  20. data/lib/straddle/models/bridge/link_create_paykey_params.rb +39 -6
  21. data/lib/straddle/models/bridge/link_create_paykey_response.rb +31 -2
  22. data/lib/straddle/models/bridge/link_create_tan_params.rb +38 -6
  23. data/lib/straddle/models/bridge/link_create_tan_response.rb +31 -2
  24. data/lib/straddle/models/bridge/link_plaid_params.rb +37 -2
  25. data/lib/straddle/models/bridge_initialize_params.rb +37 -2
  26. data/lib/straddle/models/charge_cancel_params.rb +8 -1
  27. data/lib/straddle/models/charge_create_params.rb +8 -1
  28. data/lib/straddle/models/charge_hold_params.rb +8 -1
  29. data/lib/straddle/models/charge_release_params.rb +8 -1
  30. data/lib/straddle/models/charge_update_params.rb +8 -1
  31. data/lib/straddle/models/customer_create_params.rb +8 -1
  32. data/lib/straddle/models/customer_delete_params.rb +7 -1
  33. data/lib/straddle/models/customer_unmasked_v1.rb +1 -4
  34. data/lib/straddle/models/customer_update_params.rb +8 -1
  35. data/lib/straddle/models/customers/customer_review_v1.rb +15 -50
  36. data/lib/straddle/models/customers/review_decision_params.rb +8 -1
  37. data/lib/straddle/models/customers/review_refresh_review_params.rb +40 -0
  38. data/lib/straddle/models/embed/account_create_params.rb +8 -1
  39. data/lib/straddle/models/embed/account_onboard_params.rb +7 -1
  40. data/lib/straddle/models/embed/account_paged_v1.rb +3 -12
  41. data/lib/straddle/models/embed/account_simulate_params.rb +7 -1
  42. data/lib/straddle/models/embed/account_update_params.rb +8 -1
  43. data/lib/straddle/models/embed/account_v1.rb +2 -8
  44. data/lib/straddle/models/embed/accounts/capability_request_create_params.rb +8 -1
  45. data/lib/straddle/models/embed/accounts/capability_request_paged_v1.rb +3 -11
  46. data/lib/straddle/models/embed/linked_bank_account_cancel_params.rb +34 -0
  47. data/lib/straddle/models/embed/linked_bank_account_create_params.rb +51 -4
  48. data/lib/straddle/models/embed/linked_bank_account_list_params.rb +51 -1
  49. data/lib/straddle/models/embed/linked_bank_account_paged_v1.rb +33 -13
  50. data/lib/straddle/models/embed/linked_bank_account_unmask_v1.rb +3 -8
  51. data/lib/straddle/models/embed/linked_bank_account_update_params.rb +8 -1
  52. data/lib/straddle/models/embed/linked_bank_account_v1.rb +30 -1
  53. data/lib/straddle/models/embed/organization_create_params.rb +8 -1
  54. data/lib/straddle/models/embed/representative.rb +10 -1
  55. data/lib/straddle/models/embed/representative_create_params.rb +17 -1
  56. data/lib/straddle/models/embed/representative_paged.rb +10 -1
  57. data/lib/straddle/models/embed/representative_update_params.rb +17 -1
  58. data/lib/straddle/models/funding_event_list_params.rb +9 -1
  59. data/lib/straddle/models/funding_event_summary_item_v1.rb +25 -1
  60. data/lib/straddle/models/funding_event_summary_paged_v1.rb +25 -1
  61. data/lib/straddle/models/paykey_cancel_params.rb +7 -1
  62. data/lib/straddle/models/paykey_reveal_response.rb +31 -2
  63. data/lib/straddle/models/paykey_summary_paged_v1.rb +30 -2
  64. data/lib/straddle/models/paykey_unmasked_v1.rb +30 -2
  65. data/lib/straddle/models/{customer_refresh_review_params.rb → paykey_update_balance_params.rb} +9 -3
  66. data/lib/straddle/models/paykey_v1.rb +30 -2
  67. data/lib/straddle/models/paykeys/review_decision_params.rb +56 -0
  68. data/lib/straddle/models/paykeys/review_get_params.rb +34 -0
  69. data/lib/straddle/models/paykeys/review_get_response.rb +642 -0
  70. data/lib/straddle/models/paykeys/review_refresh_review_params.rb +40 -0
  71. data/lib/straddle/models/payment_summary_paged_v1.rb +9 -1
  72. data/lib/straddle/models/payout_cancel_params.rb +8 -1
  73. data/lib/straddle/models/payout_create_params.rb +8 -1
  74. data/lib/straddle/models/payout_hold_params.rb +8 -1
  75. data/lib/straddle/models/payout_release_params.rb +8 -1
  76. data/lib/straddle/models/payout_update_params.rb +8 -1
  77. data/lib/straddle/models.rb +4 -2
  78. data/lib/straddle/resources/bridge/link.rb +24 -4
  79. data/lib/straddle/resources/bridge.rb +6 -1
  80. data/lib/straddle/resources/charges.rb +20 -5
  81. data/lib/straddle/resources/customers/review.rb +41 -1
  82. data/lib/straddle/resources/customers.rb +12 -37
  83. data/lib/straddle/resources/embed/accounts/capability_requests.rb +5 -2
  84. data/lib/straddle/resources/embed/accounts.rb +19 -7
  85. data/lib/straddle/resources/embed/linked_bank_accounts.rb +66 -7
  86. data/lib/straddle/resources/embed/organizations.rb +5 -2
  87. data/lib/straddle/resources/embed/representatives.rb +14 -4
  88. data/lib/straddle/resources/funding_events.rb +4 -1
  89. data/lib/straddle/resources/paykeys/review.rb +128 -0
  90. data/lib/straddle/resources/paykeys.rb +44 -1
  91. data/lib/straddle/resources/payouts.rb +20 -5
  92. data/lib/straddle/version.rb +1 -1
  93. data/lib/straddle.rb +9 -1
  94. data/manifest.yaml +1 -0
  95. data/rbi/straddle/client.rbi +4 -4
  96. data/rbi/straddle/errors.rbi +31 -4
  97. data/rbi/straddle/file_part.rbi +1 -1
  98. data/rbi/straddle/internal/transport/base_client.rbi +10 -6
  99. data/rbi/straddle/internal/transport/pooled_net_requester.rbi +6 -2
  100. data/rbi/straddle/internal/type/base_model.rbi +8 -4
  101. data/rbi/straddle/internal/type/base_page.rbi +1 -1
  102. data/rbi/straddle/internal/type/converter.rbi +54 -0
  103. data/rbi/straddle/internal/type/union.rbi +9 -2
  104. data/rbi/straddle/internal/util.rbi +1 -1
  105. data/rbi/straddle/models/bridge/link_bank_account_params.rbi +85 -1
  106. data/rbi/straddle/models/bridge/link_create_paykey_params.rbi +85 -1
  107. data/rbi/straddle/models/bridge/link_create_paykey_response.rbi +76 -1
  108. data/rbi/straddle/models/bridge/link_create_tan_params.rbi +85 -1
  109. data/rbi/straddle/models/bridge/link_create_tan_response.rbi +76 -1
  110. data/rbi/straddle/models/bridge/link_plaid_params.rbi +85 -1
  111. data/rbi/straddle/models/bridge_initialize_params.rbi +85 -1
  112. data/rbi/straddle/models/charge_cancel_params.rbi +9 -0
  113. data/rbi/straddle/models/charge_create_params.rbi +9 -0
  114. data/rbi/straddle/models/charge_hold_params.rbi +9 -0
  115. data/rbi/straddle/models/charge_release_params.rbi +9 -0
  116. data/rbi/straddle/models/charge_update_params.rbi +9 -0
  117. data/rbi/straddle/models/customer_create_params.rbi +9 -0
  118. data/rbi/straddle/models/customer_delete_params.rbi +9 -0
  119. data/rbi/straddle/models/customer_update_params.rbi +9 -0
  120. data/rbi/straddle/models/customers/review_decision_params.rbi +9 -0
  121. data/rbi/straddle/models/customers/review_refresh_review_params.rbi +76 -0
  122. data/rbi/straddle/models/embed/account_create_params.rbi +9 -0
  123. data/rbi/straddle/models/embed/account_onboard_params.rbi +9 -0
  124. data/rbi/straddle/models/embed/account_simulate_params.rbi +9 -0
  125. data/rbi/straddle/models/embed/account_update_params.rbi +9 -0
  126. data/rbi/straddle/models/embed/accounts/capability_request_create_params.rbi +9 -0
  127. data/rbi/straddle/models/embed/linked_bank_account_cancel_params.rbi +67 -0
  128. data/rbi/straddle/models/embed/linked_bank_account_create_params.rbi +95 -3
  129. data/rbi/straddle/models/embed/linked_bank_account_list_params.rbi +149 -0
  130. data/rbi/straddle/models/embed/linked_bank_account_paged_v1.rbi +72 -0
  131. data/rbi/straddle/models/embed/linked_bank_account_unmask_v1.rbi +5 -0
  132. data/rbi/straddle/models/embed/linked_bank_account_update_params.rbi +9 -0
  133. data/rbi/straddle/models/embed/linked_bank_account_v1.rbi +72 -0
  134. data/rbi/straddle/models/embed/organization_create_params.rbi +9 -0
  135. data/rbi/straddle/models/embed/representative.rbi +10 -0
  136. data/rbi/straddle/models/embed/representative_create_params.rbi +19 -0
  137. data/rbi/straddle/models/embed/representative_paged.rbi +10 -0
  138. data/rbi/straddle/models/embed/representative_update_params.rbi +19 -0
  139. data/rbi/straddle/models/funding_event_list_params.rbi +8 -0
  140. data/rbi/straddle/models/funding_event_summary_item_v1.rbi +24 -0
  141. data/rbi/straddle/models/funding_event_summary_paged_v1.rbi +24 -0
  142. data/rbi/straddle/models/paykey_cancel_params.rbi +9 -0
  143. data/rbi/straddle/models/paykey_reveal_response.rbi +76 -1
  144. data/rbi/straddle/models/paykey_summary_paged_v1.rbi +76 -1
  145. data/rbi/straddle/models/paykey_unmasked_v1.rbi +76 -1
  146. data/rbi/straddle/models/{customer_refresh_review_params.rbi → paykey_update_balance_params.rbi} +11 -2
  147. data/rbi/straddle/models/paykey_v1.rbi +76 -1
  148. data/rbi/straddle/models/paykeys/review_decision_params.rbi +115 -0
  149. data/rbi/straddle/models/paykeys/review_get_params.rbi +67 -0
  150. data/rbi/straddle/models/paykeys/review_get_response.rbi +1524 -0
  151. data/rbi/straddle/models/paykeys/review_refresh_review_params.rbi +76 -0
  152. data/rbi/straddle/models/payment_summary_paged_v1.rbi +8 -0
  153. data/rbi/straddle/models/payout_cancel_params.rbi +9 -0
  154. data/rbi/straddle/models/payout_create_params.rbi +9 -0
  155. data/rbi/straddle/models/payout_hold_params.rbi +9 -0
  156. data/rbi/straddle/models/payout_release_params.rbi +9 -0
  157. data/rbi/straddle/models/payout_update_params.rbi +9 -0
  158. data/rbi/straddle/models.rbi +4 -2
  159. data/rbi/straddle/resources/bridge/link.rbi +28 -0
  160. data/rbi/straddle/resources/bridge.rbi +7 -0
  161. data/rbi/straddle/resources/charges.rbi +15 -0
  162. data/rbi/straddle/resources/customers/review.rbi +30 -0
  163. data/rbi/straddle/resources/customers.rbi +9 -24
  164. data/rbi/straddle/resources/embed/accounts/capability_requests.rbi +3 -0
  165. data/rbi/straddle/resources/embed/accounts.rbi +12 -0
  166. data/rbi/straddle/resources/embed/linked_bank_accounts.rbi +56 -1
  167. data/rbi/straddle/resources/embed/organizations.rbi +3 -0
  168. data/rbi/straddle/resources/embed/representatives.rbi +14 -0
  169. data/rbi/straddle/resources/funding_events.rbi +3 -0
  170. data/rbi/straddle/resources/paykeys/review.rbi +94 -0
  171. data/rbi/straddle/resources/paykeys.rbi +32 -0
  172. data/rbi/straddle/resources/payouts.rbi +15 -0
  173. data/sig/straddle/client.rbs +2 -2
  174. data/sig/straddle/errors.rbs +7 -0
  175. data/sig/straddle/file_part.rbs +1 -1
  176. data/sig/straddle/internal/transport/base_client.rbs +3 -1
  177. data/sig/straddle/internal/transport/pooled_net_requester.rbs +4 -1
  178. data/sig/straddle/internal/type/converter.rbs +17 -0
  179. data/sig/straddle/internal/type/union.rbs +2 -2
  180. data/sig/straddle/models/bridge/link_bank_account_params.rbs +35 -1
  181. data/sig/straddle/models/bridge/link_create_paykey_params.rbs +35 -1
  182. data/sig/straddle/models/bridge/link_create_paykey_response.rbs +28 -1
  183. data/sig/straddle/models/bridge/link_create_tan_params.rbs +35 -1
  184. data/sig/straddle/models/bridge/link_create_tan_response.rbs +28 -1
  185. data/sig/straddle/models/bridge/link_plaid_params.rbs +35 -1
  186. data/sig/straddle/models/bridge_initialize_params.rbs +35 -1
  187. data/sig/straddle/models/charge_cancel_params.rbs +7 -0
  188. data/sig/straddle/models/charge_create_params.rbs +7 -0
  189. data/sig/straddle/models/charge_hold_params.rbs +7 -0
  190. data/sig/straddle/models/charge_release_params.rbs +7 -0
  191. data/sig/straddle/models/charge_update_params.rbs +7 -0
  192. data/sig/straddle/models/customer_create_params.rbs +7 -0
  193. data/sig/straddle/models/customer_delete_params.rbs +7 -0
  194. data/sig/straddle/models/customer_update_params.rbs +7 -0
  195. data/sig/straddle/models/customers/review_decision_params.rbs +7 -0
  196. data/sig/straddle/models/customers/review_refresh_review_params.rbs +51 -0
  197. data/sig/straddle/models/embed/account_create_params.rbs +7 -0
  198. data/sig/straddle/models/embed/account_onboard_params.rbs +7 -0
  199. data/sig/straddle/models/embed/account_simulate_params.rbs +7 -0
  200. data/sig/straddle/models/embed/account_update_params.rbs +7 -0
  201. data/sig/straddle/models/embed/accounts/capability_request_create_params.rbs +7 -0
  202. data/sig/straddle/models/embed/linked_bank_account_cancel_params.rbs +40 -0
  203. data/sig/straddle/models/embed/linked_bank_account_create_params.rbs +38 -4
  204. data/sig/straddle/models/embed/linked_bank_account_list_params.rbs +46 -0
  205. data/sig/straddle/models/embed/linked_bank_account_paged_v1.rbs +25 -1
  206. data/sig/straddle/models/embed/linked_bank_account_unmask_v1.rbs +3 -1
  207. data/sig/straddle/models/embed/linked_bank_account_update_params.rbs +7 -0
  208. data/sig/straddle/models/embed/linked_bank_account_v1.rbs +25 -1
  209. data/sig/straddle/models/embed/organization_create_params.rbs +7 -0
  210. data/sig/straddle/models/embed/representative.rbs +5 -0
  211. data/sig/straddle/models/embed/representative_create_params.rbs +12 -0
  212. data/sig/straddle/models/embed/representative_paged.rbs +5 -0
  213. data/sig/straddle/models/embed/representative_update_params.rbs +12 -0
  214. data/sig/straddle/models/funding_event_list_params.rbs +5 -0
  215. data/sig/straddle/models/funding_event_summary_item_v1.rbs +15 -0
  216. data/sig/straddle/models/funding_event_summary_paged_v1.rbs +15 -0
  217. data/sig/straddle/models/paykey_cancel_params.rbs +7 -0
  218. data/sig/straddle/models/paykey_reveal_response.rbs +28 -1
  219. data/sig/straddle/models/paykey_summary_paged_v1.rbs +28 -1
  220. data/sig/straddle/models/paykey_unmasked_v1.rbs +28 -1
  221. data/sig/straddle/models/{customer_refresh_review_params.rbs → paykey_update_balance_params.rbs} +9 -2
  222. data/sig/straddle/models/paykey_v1.rbs +28 -1
  223. data/sig/straddle/models/paykeys/review_decision_params.rbs +67 -0
  224. data/sig/straddle/models/paykeys/review_get_params.rbs +44 -0
  225. data/sig/straddle/models/paykeys/review_get_response.rbs +627 -0
  226. data/sig/straddle/models/paykeys/review_refresh_review_params.rbs +51 -0
  227. data/sig/straddle/models/payment_summary_paged_v1.rbs +5 -0
  228. data/sig/straddle/models/payout_cancel_params.rbs +7 -0
  229. data/sig/straddle/models/payout_create_params.rbs +7 -0
  230. data/sig/straddle/models/payout_hold_params.rbs +7 -0
  231. data/sig/straddle/models/payout_release_params.rbs +7 -0
  232. data/sig/straddle/models/payout_update_params.rbs +7 -0
  233. data/sig/straddle/models.rbs +4 -2
  234. data/sig/straddle/resources/bridge/link.rbs +8 -0
  235. data/sig/straddle/resources/bridge.rbs +2 -0
  236. data/sig/straddle/resources/charges.rbs +5 -0
  237. data/sig/straddle/resources/customers/review.rbs +10 -0
  238. data/sig/straddle/resources/customers.rbs +3 -8
  239. data/sig/straddle/resources/embed/accounts/capability_requests.rbs +1 -0
  240. data/sig/straddle/resources/embed/accounts.rbs +4 -0
  241. data/sig/straddle/resources/embed/linked_bank_accounts.rbs +16 -1
  242. data/sig/straddle/resources/embed/organizations.rbs +1 -0
  243. data/sig/straddle/resources/embed/representatives.rbs +4 -0
  244. data/sig/straddle/resources/funding_events.rbs +1 -0
  245. data/sig/straddle/resources/paykeys/review.rbs +36 -0
  246. data/sig/straddle/resources/paykeys.rbs +12 -0
  247. data/sig/straddle/resources/payouts.rbs +5 -0
  248. metadata +27 -6
@@ -23,6 +23,7 @@ module Straddle
23
23
  signed_agreement:
24
24
  Straddle::Embed::Accounts::CapabilityRequestCreateParams::SignedAgreement::OrHash,
25
25
  correlation_id: String,
26
+ idempotency_key: String,
26
27
  request_id: String,
27
28
  request_options: Straddle::RequestOptions::OrHash
28
29
  ).returns(Straddle::Embed::Accounts::CapabilityRequestPagedV1)
@@ -47,6 +48,8 @@ module Straddle
47
48
  # Header param: Optional client generated identifier to trace and debug a series
48
49
  # of requests.
49
50
  correlation_id: nil,
51
+ # Header param: Optional client generated value to use for idempotent requests.
52
+ idempotency_key: nil,
50
53
  # Header param: Optional client generated identifier to trace and debug a request.
51
54
  request_id: nil,
52
55
  request_options: {}
@@ -23,6 +23,7 @@ module Straddle
23
23
  external_id: T.nilable(String),
24
24
  metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
25
25
  correlation_id: String,
26
+ idempotency_key: String,
26
27
  request_id: String,
27
28
  request_options: Straddle::RequestOptions::OrHash
28
29
  ).returns(Straddle::Embed::AccountV1)
@@ -47,6 +48,8 @@ module Straddle
47
48
  # Header param: Optional client generated identifier to trace and debug a series
48
49
  # of requests.
49
50
  correlation_id: nil,
51
+ # Header param: Optional client generated value to use for idempotent requests.
52
+ idempotency_key: nil,
50
53
  # Header param: Optional client generated identifier to trace and debug a request.
51
54
  request_id: nil,
52
55
  request_options: {}
@@ -62,6 +65,7 @@ module Straddle
62
65
  external_id: T.nilable(String),
63
66
  metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
64
67
  correlation_id: String,
68
+ idempotency_key: String,
65
69
  request_id: String,
66
70
  request_options: Straddle::RequestOptions::OrHash
67
71
  ).returns(Straddle::Embed::AccountV1)
@@ -80,6 +84,8 @@ module Straddle
80
84
  # Header param: Optional client generated identifier to trace and debug a series
81
85
  # of requests.
82
86
  correlation_id: nil,
87
+ # Header param: Optional client generated value to use for idempotent requests.
88
+ idempotency_key: nil,
83
89
  # Header param: Optional client generated identifier to trace and debug a request.
84
90
  request_id: nil,
85
91
  request_options: {}
@@ -162,6 +168,7 @@ module Straddle
162
168
  account_id: String,
163
169
  terms_of_service: Straddle::Embed::TermsOfServiceV1::OrHash,
164
170
  correlation_id: String,
171
+ idempotency_key: String,
165
172
  request_id: String,
166
173
  request_options: Straddle::RequestOptions::OrHash
167
174
  ).returns(Straddle::Embed::AccountV1)
@@ -174,6 +181,8 @@ module Straddle
174
181
  # Header param: Optional client generated identifier to trace and debug a series
175
182
  # of requests.
176
183
  correlation_id: nil,
184
+ # Header param: Optional client generated value to use for idempotent requests.
185
+ idempotency_key: nil,
177
186
  # Header param: Optional client generated identifier to trace and debug a request.
178
187
  request_id: nil,
179
188
  request_options: {}
@@ -188,6 +197,7 @@ module Straddle
188
197
  final_status:
189
198
  Straddle::Embed::AccountSimulateParams::FinalStatus::OrSymbol,
190
199
  correlation_id: String,
200
+ idempotency_key: String,
191
201
  request_id: String,
192
202
  request_options: Straddle::RequestOptions::OrHash
193
203
  ).returns(Straddle::Embed::AccountV1)
@@ -200,6 +210,8 @@ module Straddle
200
210
  # Header param: Optional client generated identifier to trace and debug a series
201
211
  # of requests.
202
212
  correlation_id: nil,
213
+ # Header param: Optional client generated value to use for idempotent requests.
214
+ idempotency_key: nil,
203
215
  # Header param: Optional client generated identifier to trace and debug a request.
204
216
  request_id: nil,
205
217
  request_options: {}
@@ -10,11 +10,20 @@ module Straddle
10
10
  # more.
11
11
  sig do
12
12
  params(
13
- account_id: String,
13
+ account_id: T.nilable(String),
14
14
  bank_account:
15
15
  Straddle::Embed::LinkedBankAccountCreateParams::BankAccount::OrHash,
16
+ description: T.nilable(String),
16
17
  metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
18
+ platform_id: T.nilable(String),
19
+ purposes:
20
+ T.nilable(
21
+ T::Array[
22
+ Straddle::Embed::LinkedBankAccountCreateParams::Purpose::OrSymbol
23
+ ]
24
+ ),
17
25
  correlation_id: String,
26
+ idempotency_key: String,
18
27
  request_id: String,
19
28
  request_options: Straddle::RequestOptions::OrHash
20
29
  ).returns(Straddle::Embed::LinkedBankAccountV1)
@@ -25,12 +34,21 @@ module Straddle
25
34
  account_id:,
26
35
  # Body param:
27
36
  bank_account:,
37
+ # Body param: Optional description for the bank account.
38
+ description: nil,
28
39
  # Body param: Up to 20 additional user-defined key-value pairs. Useful for storing
29
40
  # additional information about the linked bank account in a structured format.
30
41
  metadata: nil,
42
+ # Body param: The unique identifier of the Straddle Platform to associate this
43
+ # bank account with.
44
+ platform_id: nil,
45
+ # Body param: The purposes for the linked bank account.
46
+ purposes: nil,
31
47
  # Header param: Optional client generated identifier to trace and debug a series
32
48
  # of requests.
33
49
  correlation_id: nil,
50
+ # Header param: Optional client generated value to use for idempotent requests.
51
+ idempotency_key: nil,
34
52
  # Header param: Optional client generated identifier to trace and debug a request.
35
53
  request_id: nil,
36
54
  request_options: {}
@@ -48,6 +66,7 @@ module Straddle
48
66
  Straddle::Embed::LinkedBankAccountUpdateParams::BankAccount::OrHash,
49
67
  metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
50
68
  correlation_id: String,
69
+ idempotency_key: String,
51
70
  request_id: String,
52
71
  request_options: Straddle::RequestOptions::OrHash
53
72
  ).returns(Straddle::Embed::LinkedBankAccountV1)
@@ -63,6 +82,8 @@ module Straddle
63
82
  # Header param: Optional client generated identifier to trace and debug a series
64
83
  # of requests.
65
84
  correlation_id: nil,
85
+ # Header param: Optional client generated value to use for idempotent requests.
86
+ idempotency_key: nil,
66
87
  # Header param: Optional client generated identifier to trace and debug a request.
67
88
  request_id: nil,
68
89
  request_options: {}
@@ -80,9 +101,13 @@ module Straddle
80
101
  Straddle::Embed::LinkedBankAccountListParams::Level::OrSymbol,
81
102
  page_number: Integer,
82
103
  page_size: Integer,
104
+ purpose:
105
+ Straddle::Embed::LinkedBankAccountListParams::Purpose::OrSymbol,
83
106
  sort_by: String,
84
107
  sort_order:
85
108
  Straddle::Embed::LinkedBankAccountListParams::SortOrder::OrSymbol,
109
+ status:
110
+ Straddle::Embed::LinkedBankAccountListParams::Status::OrSymbol,
86
111
  correlation_id: String,
87
112
  request_id: String,
88
113
  request_options: Straddle::RequestOptions::OrHash
@@ -101,10 +126,16 @@ module Straddle
101
126
  page_number: nil,
102
127
  # Query param: Page size. Max value: 1000
103
128
  page_size: nil,
129
+ # Query param: The purpose of the linked bank accounts to return. Possible values:
130
+ # 'charges', 'payouts', 'billing'.
131
+ purpose: nil,
104
132
  # Query param: Sort By.
105
133
  sort_by: nil,
106
134
  # Query param: Sort Order.
107
135
  sort_order: nil,
136
+ # Query param: The status of the linked bank accounts to return. Possible values:
137
+ # 'created', 'onboarding', 'active', 'inactive', 'rejected'.
138
+ status: nil,
108
139
  # Header param: Optional client generated identifier to trace and debug a series
109
140
  # of requests.
110
141
  correlation_id: nil,
@@ -114,6 +145,30 @@ module Straddle
114
145
  )
115
146
  end
116
147
 
148
+ # Cancels an existing linked bank account. This can be used to cancel a linked
149
+ # bank account before it has been reviewed. The linked bank account must be in
150
+ # 'created' status.
151
+ sig do
152
+ params(
153
+ linked_bank_account_id: String,
154
+ correlation_id: String,
155
+ idempotency_key: String,
156
+ request_id: String,
157
+ request_options: Straddle::RequestOptions::OrHash
158
+ ).returns(Straddle::Embed::LinkedBankAccountV1)
159
+ end
160
+ def cancel(
161
+ linked_bank_account_id,
162
+ # Optional client generated identifier to trace and debug a series of requests.
163
+ correlation_id: nil,
164
+ # Optional client generated value to use for idempotent requests.
165
+ idempotency_key: nil,
166
+ # Optional client generated identifier to trace and debug a request.
167
+ request_id: nil,
168
+ request_options: {}
169
+ )
170
+ end
171
+
117
172
  # Retrieves the details of a linked bank account that has previously been created.
118
173
  # Supply the unique linked bank account `id`, and Straddle will return the
119
174
  # corresponding information. The response includes masked account details for
@@ -13,6 +13,7 @@ module Straddle
13
13
  external_id: T.nilable(String),
14
14
  metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
15
15
  correlation_id: String,
16
+ idempotency_key: String,
16
17
  request_id: String,
17
18
  request_options: Straddle::RequestOptions::OrHash
18
19
  ).returns(Straddle::Embed::OrganizationV1)
@@ -29,6 +30,8 @@ module Straddle
29
30
  # Header param: Optional client generated identifier to trace and debug a series
30
31
  # of requests.
31
32
  correlation_id: nil,
33
+ # Header param: Optional client generated value to use for idempotent requests.
34
+ idempotency_key: nil,
32
35
  # Header param: Optional client generated identifier to trace and debug a request.
33
36
  request_id: nil,
34
37
  request_options: {}
@@ -19,7 +19,9 @@ module Straddle
19
19
  Straddle::Embed::RepresentativeCreateParams::Relationship::OrHash,
20
20
  ssn_last4: String,
21
21
  external_id: T.nilable(String),
22
+ metadata: T.nilable(T::Hash[Symbol, String]),
22
23
  correlation_id: String,
24
+ idempotency_key: String,
23
25
  request_id: String,
24
26
  request_options: Straddle::RequestOptions::OrHash
25
27
  ).returns(Straddle::Embed::Representative)
@@ -46,9 +48,14 @@ module Straddle
46
48
  # Body param: Unique identifier for the representative in your database, used for
47
49
  # cross-referencing between Straddle and your systems.
48
50
  external_id: nil,
51
+ # Body param: Up to 20 additional user-defined key-value pairs. Useful for storing
52
+ # additional information about the represetative in a structured format.
53
+ metadata: nil,
49
54
  # Header param: Optional client generated identifier to trace and debug a series
50
55
  # of requests.
51
56
  correlation_id: nil,
57
+ # Header param: Optional client generated value to use for idempotent requests.
58
+ idempotency_key: nil,
52
59
  # Header param: Optional client generated identifier to trace and debug a request.
53
60
  request_id: nil,
54
61
  request_options: {}
@@ -70,7 +77,9 @@ module Straddle
70
77
  Straddle::Embed::RepresentativeUpdateParams::Relationship::OrHash,
71
78
  ssn_last4: String,
72
79
  external_id: T.nilable(String),
80
+ metadata: T.nilable(T::Hash[Symbol, String]),
73
81
  correlation_id: String,
82
+ idempotency_key: String,
74
83
  request_id: String,
75
84
  request_options: Straddle::RequestOptions::OrHash
76
85
  ).returns(Straddle::Embed::Representative)
@@ -96,9 +105,14 @@ module Straddle
96
105
  # Body param: Unique identifier for the representative in your database, used for
97
106
  # cross-referencing between Straddle and your systems.
98
107
  external_id: nil,
108
+ # Body param: Up to 20 additional user-defined key-value pairs. Useful for storing
109
+ # additional information about the represetative in a structured format.
110
+ metadata: nil,
99
111
  # Header param: Optional client generated identifier to trace and debug a series
100
112
  # of requests.
101
113
  correlation_id: nil,
114
+ # Header param: Optional client generated value to use for idempotent requests.
115
+ idempotency_key: nil,
102
116
  # Header param: Optional client generated identifier to trace and debug a request.
103
117
  request_id: nil,
104
118
  request_options: {}
@@ -13,6 +13,7 @@ module Straddle
13
13
  event_type: Straddle::FundingEventListParams::EventType::OrSymbol,
14
14
  page_number: Integer,
15
15
  page_size: Integer,
16
+ search_text: T.nilable(String),
16
17
  sort_by: Straddle::FundingEventListParams::SortBy::OrSymbol,
17
18
  sort_order: Straddle::FundingEventListParams::SortOrder::OrSymbol,
18
19
  trace_number: T.nilable(String),
@@ -43,6 +44,8 @@ module Straddle
43
44
  page_number: nil,
44
45
  # Query param: Results page size. Max value: 1000
45
46
  page_size: nil,
47
+ # Query param: Search text.
48
+ search_text: nil,
46
49
  # Query param: The field to sort the results by.
47
50
  sort_by: nil,
48
51
  # Query param: The order in which to sort the results.
@@ -0,0 +1,94 @@
1
+ # typed: strong
2
+
3
+ module Straddle
4
+ module Resources
5
+ class Paykeys
6
+ class Review
7
+ # Update the status of a paykey when in review status
8
+ sig do
9
+ params(
10
+ id: String,
11
+ status: Straddle::Paykeys::ReviewDecisionParams::Status::OrSymbol,
12
+ correlation_id: String,
13
+ idempotency_key: String,
14
+ request_id: String,
15
+ straddle_account_id: String,
16
+ request_options: Straddle::RequestOptions::OrHash
17
+ ).returns(Straddle::PaykeyV1)
18
+ end
19
+ def decision(
20
+ # Path param:
21
+ id,
22
+ # Body param:
23
+ status:,
24
+ # Header param: Optional client generated identifier to trace and debug a series
25
+ # of requests.
26
+ correlation_id: nil,
27
+ # Header param: Optional client generated value to use for idempotent requests.
28
+ idempotency_key: nil,
29
+ # Header param: Optional client generated identifier to trace and debug a request.
30
+ request_id: nil,
31
+ # Header param: For use by platforms to specify an account id and set scope of a
32
+ # request.
33
+ straddle_account_id: nil,
34
+ request_options: {}
35
+ )
36
+ end
37
+
38
+ # Get additional details about a paykey.
39
+ sig do
40
+ params(
41
+ id: String,
42
+ correlation_id: String,
43
+ request_id: String,
44
+ straddle_account_id: String,
45
+ request_options: Straddle::RequestOptions::OrHash
46
+ ).returns(Straddle::Models::Paykeys::ReviewGetResponse)
47
+ end
48
+ def get(
49
+ id,
50
+ # Optional client generated identifier to trace and debug a series of requests.
51
+ correlation_id: nil,
52
+ # Optional client generated identifier to trace and debug a request.
53
+ request_id: nil,
54
+ # For use by platforms to specify an account id and set scope of a request.
55
+ straddle_account_id: nil,
56
+ request_options: {}
57
+ )
58
+ end
59
+
60
+ # Updates the decision of a paykey's review validation. This endpoint allows you
61
+ # to refresh the outcome of a paykey's decision and is useful for correcting or
62
+ # updating the status of a paykey's verification.
63
+ sig do
64
+ params(
65
+ id: String,
66
+ correlation_id: String,
67
+ idempotency_key: String,
68
+ request_id: String,
69
+ straddle_account_id: String,
70
+ request_options: Straddle::RequestOptions::OrHash
71
+ ).returns(Straddle::PaykeyV1)
72
+ end
73
+ def refresh_review(
74
+ id,
75
+ # Optional client generated identifier to trace and debug a series of requests.
76
+ correlation_id: nil,
77
+ # Optional client generated value to use for idempotent requests.
78
+ idempotency_key: nil,
79
+ # Optional client generated identifier to trace and debug a request.
80
+ request_id: nil,
81
+ # For use by platforms to specify an account id and set scope of a request.
82
+ straddle_account_id: nil,
83
+ request_options: {}
84
+ )
85
+ end
86
+
87
+ # @api private
88
+ sig { params(client: Straddle::Client).returns(T.attached_class) }
89
+ def self.new(client:)
90
+ end
91
+ end
92
+ end
93
+ end
94
+ end
@@ -3,6 +3,9 @@
3
3
  module Straddle
4
4
  module Resources
5
5
  class Paykeys
6
+ sig { returns(Straddle::Resources::Paykeys::Review) }
7
+ attr_reader :review
8
+
6
9
  # Returns a list of paykeys associated with a Straddle account. This endpoint
7
10
  # supports advanced sorting and filtering options.
8
11
  sig do
@@ -56,6 +59,7 @@ module Straddle
56
59
  id: String,
57
60
  reason: T.nilable(String),
58
61
  correlation_id: String,
62
+ idempotency_key: String,
59
63
  request_id: String,
60
64
  straddle_account_id: String,
61
65
  request_options: Straddle::RequestOptions::OrHash
@@ -69,6 +73,8 @@ module Straddle
69
73
  # Header param: Optional client generated identifier to trace and debug a series
70
74
  # of requests.
71
75
  correlation_id: nil,
76
+ # Header param: Optional client generated value to use for idempotent requests.
77
+ idempotency_key: nil,
72
78
  # Header param: Optional client generated identifier to trace and debug a request.
73
79
  request_id: nil,
74
80
  # Header param: For use by platforms to specify an account id and set scope of a
@@ -152,6 +158,32 @@ module Straddle
152
158
  )
153
159
  end
154
160
 
161
+ # Updates the balance of a paykey. This endpoint allows you to refresh the balance
162
+ # of a paykey.
163
+ sig do
164
+ params(
165
+ id: String,
166
+ correlation_id: String,
167
+ idempotency_key: String,
168
+ request_id: String,
169
+ straddle_account_id: String,
170
+ request_options: Straddle::RequestOptions::OrHash
171
+ ).returns(Straddle::PaykeyV1)
172
+ end
173
+ def update_balance(
174
+ id,
175
+ # Optional client generated identifier to trace and debug a series of requests.
176
+ correlation_id: nil,
177
+ # Optional client generated value to use for idempotent requests.
178
+ idempotency_key: nil,
179
+ # Optional client generated identifier to trace and debug a request.
180
+ request_id: nil,
181
+ # For use by platforms to specify an account id and set scope of a request.
182
+ straddle_account_id: nil,
183
+ request_options: {}
184
+ )
185
+ end
186
+
155
187
  # @api private
156
188
  sig { params(client: Straddle::Client).returns(T.attached_class) }
157
189
  def self.new(client:)
@@ -16,6 +16,7 @@ module Straddle
16
16
  config: Straddle::PayoutCreateParams::Config::OrHash,
17
17
  metadata: T.nilable(T::Hash[Symbol, String]),
18
18
  correlation_id: String,
19
+ idempotency_key: String,
19
20
  request_id: String,
20
21
  straddle_account_id: String,
21
22
  request_options: Straddle::RequestOptions::OrHash
@@ -47,6 +48,8 @@ module Straddle
47
48
  # Header param: Optional client generated identifier to trace and debug a series
48
49
  # of requests.
49
50
  correlation_id: nil,
51
+ # Header param: Optional client generated value to use for idempotent requests.
52
+ idempotency_key: nil,
50
53
  # Header param: Optional client generated identifier to trace and debug a request.
51
54
  request_id: nil,
52
55
  # Header param: For use by platforms to specify an account id and set scope of a
@@ -66,6 +69,7 @@ module Straddle
66
69
  payment_date: Date,
67
70
  metadata: T.nilable(T::Hash[Symbol, String]),
68
71
  correlation_id: String,
72
+ idempotency_key: String,
69
73
  request_id: String,
70
74
  straddle_account_id: String,
71
75
  request_options: Straddle::RequestOptions::OrHash
@@ -87,6 +91,8 @@ module Straddle
87
91
  # Header param: Optional client generated identifier to trace and debug a series
88
92
  # of requests.
89
93
  correlation_id: nil,
94
+ # Header param: Optional client generated value to use for idempotent requests.
95
+ idempotency_key: nil,
90
96
  # Header param: Optional client generated identifier to trace and debug a request.
91
97
  request_id: nil,
92
98
  # Header param: For use by platforms to specify an account id and set scope of a
@@ -103,6 +109,7 @@ module Straddle
103
109
  id: String,
104
110
  reason: String,
105
111
  correlation_id: String,
112
+ idempotency_key: String,
106
113
  request_id: String,
107
114
  straddle_account_id: String,
108
115
  request_options: Straddle::RequestOptions::OrHash
@@ -116,6 +123,8 @@ module Straddle
116
123
  # Header param: Optional client generated identifier to trace and debug a series
117
124
  # of requests.
118
125
  correlation_id: nil,
126
+ # Header param: Optional client generated value to use for idempotent requests.
127
+ idempotency_key: nil,
119
128
  # Header param: Optional client generated identifier to trace and debug a request.
120
129
  request_id: nil,
121
130
  # Header param: For use by platforms to specify an account id and set scope of a
@@ -155,6 +164,7 @@ module Straddle
155
164
  id: String,
156
165
  reason: String,
157
166
  correlation_id: String,
167
+ idempotency_key: String,
158
168
  request_id: String,
159
169
  straddle_account_id: String,
160
170
  request_options: Straddle::RequestOptions::OrHash
@@ -168,6 +178,8 @@ module Straddle
168
178
  # Header param: Optional client generated identifier to trace and debug a series
169
179
  # of requests.
170
180
  correlation_id: nil,
181
+ # Header param: Optional client generated value to use for idempotent requests.
182
+ idempotency_key: nil,
171
183
  # Header param: Optional client generated identifier to trace and debug a request.
172
184
  request_id: nil,
173
185
  # Header param: For use by platforms to specify an account id and set scope of a
@@ -184,6 +196,7 @@ module Straddle
184
196
  id: String,
185
197
  reason: String,
186
198
  correlation_id: String,
199
+ idempotency_key: String,
187
200
  request_id: String,
188
201
  straddle_account_id: String,
189
202
  request_options: Straddle::RequestOptions::OrHash
@@ -197,6 +210,8 @@ module Straddle
197
210
  # Header param: Optional client generated identifier to trace and debug a series
198
211
  # of requests.
199
212
  correlation_id: nil,
213
+ # Header param: Optional client generated value to use for idempotent requests.
214
+ idempotency_key: nil,
200
215
  # Header param: Optional client generated identifier to trace and debug a request.
201
216
  request_id: nil,
202
217
  # Header param: For use by platforms to specify an account id and set scope of a
@@ -9,8 +9,8 @@ module Straddle
9
9
  DEFAULT_MAX_RETRY_DELAY: Float
10
10
 
11
11
  ENVIRONMENTS: {
12
- sandbox: "https://sandbox.straddle.io",
13
- production: "https://production.straddle.io"
12
+ sandbox: "https://sandbox.straddle.com",
13
+ production: "https://production.straddle.com"
14
14
  }
15
15
 
16
16
  attr_reader api_key: String
@@ -21,11 +21,14 @@ module Straddle
21
21
 
22
22
  attr_accessor status: Integer?
23
23
 
24
+ attr_accessor headers: ::Hash[String, String]?
25
+
24
26
  attr_accessor body: top?
25
27
 
26
28
  def initialize: (
27
29
  url: URI::Generic,
28
30
  ?status: Integer?,
31
+ ?headers: ::Hash[String, String]?,
29
32
  ?body: Object?,
30
33
  ?request: nil,
31
34
  ?response: nil,
@@ -37,6 +40,7 @@ module Straddle
37
40
  def initialize: (
38
41
  url: URI::Generic,
39
42
  ?status: nil,
43
+ ?headers: ::Hash[String, String]?,
40
44
  ?body: nil,
41
45
  ?request: nil,
42
46
  ?response: nil,
@@ -48,6 +52,7 @@ module Straddle
48
52
  def initialize: (
49
53
  url: URI::Generic,
50
54
  ?status: nil,
55
+ ?headers: ::Hash[String, String]?,
51
56
  ?body: nil,
52
57
  ?request: nil,
53
58
  ?response: nil,
@@ -59,6 +64,7 @@ module Straddle
59
64
  def self.for: (
60
65
  url: URI::Generic,
61
66
  status: Integer,
67
+ headers: ::Hash[String, String]?,
62
68
  body: Object?,
63
69
  request: nil,
64
70
  response: nil,
@@ -68,6 +74,7 @@ module Straddle
68
74
  def initialize: (
69
75
  url: URI::Generic,
70
76
  status: Integer,
77
+ headers: ::Hash[String, String]?,
71
78
  body: Object?,
72
79
  request: nil,
73
80
  response: nil,
@@ -14,7 +14,7 @@ module Straddle
14
14
 
15
15
  def initialize: (
16
16
  Pathname | StringIO | IO | String content,
17
- ?filename: String?,
17
+ ?filename: (Pathname | String)?,
18
18
  ?content_type: String?
19
19
  ) -> void
20
20
  end
@@ -87,6 +87,8 @@ module Straddle
87
87
 
88
88
  private def auth_headers: -> ::Hash[String, String]
89
89
 
90
+ private def user_agent: -> String
91
+
90
92
  private def generate_idempotency_key: -> String
91
93
 
92
94
  private def build_request: (
@@ -99,7 +101,7 @@ module Straddle
99
101
  retry_count: Integer
100
102
  ) -> Float
101
103
 
102
- private def send_request: (
104
+ def send_request: (
103
105
  Straddle::Internal::Transport::BaseClient::request_input request,
104
106
  redirect_count: Integer,
105
107
  retry_count: Integer,
@@ -17,7 +17,10 @@ module Straddle
17
17
 
18
18
  DEFAULT_MAX_CONNECTIONS: Integer
19
19
 
20
- def self.connect: (URI::Generic url) -> top
20
+ def self.connect: (
21
+ cert_store: OpenSSL::X509::Store,
22
+ url: URI::Generic
23
+ ) -> top
21
24
 
22
25
  def self.calibrate_socket_timeout: (top conn, Float deadline) -> void
23
26
 
@@ -39,6 +39,23 @@ module Straddle
39
39
  | Straddle::Internal::Type::Converter::input spec
40
40
  ) -> (^-> top)
41
41
 
42
+ def self.meta_info: (
43
+ {
44
+ const: (nil | bool | Integer | Float | Symbol)?,
45
+ enum: ^-> Straddle::Internal::Type::Converter::input?,
46
+ union: ^-> Straddle::Internal::Type::Converter::input?
47
+ }
48
+ | ^-> Straddle::Internal::Type::Converter::input
49
+ | Straddle::Internal::Type::Converter::input type_info,
50
+ {
51
+ const: (nil | bool | Integer | Float | Symbol)?,
52
+ enum: ^-> Straddle::Internal::Type::Converter::input?,
53
+ union: ^-> Straddle::Internal::Type::Converter::input?
54
+ }
55
+ | ^-> Straddle::Internal::Type::Converter::input
56
+ | Straddle::Internal::Type::Converter::input spec
57
+ ) -> ::Hash[Symbol, top]
58
+
42
59
  def self.new_coerce_state: (
43
60
  ?translate_names: bool
44
61
  ) -> Straddle::Internal::Type::Converter::coerce_state
@@ -5,9 +5,9 @@ module Straddle
5
5
  include Straddle::Internal::Type::Converter
6
6
  include Straddle::Internal::Util::SorbetRuntimeSupport
7
7
 
8
- private def self.known_variants: -> ::Array[[Symbol?, (^-> Straddle::Internal::Type::Converter::input)]]
8
+ private def self.known_variants: -> ::Array[[Symbol?, (^-> Straddle::Internal::Type::Converter::input), ::Hash[Symbol, top]]]
9
9
 
10
- def self.derefed_variants: -> ::Array[[Symbol?, top]]
10
+ def self.derefed_variants: -> ::Array[[Symbol?, top, ::Hash[Symbol, top]]]
11
11
 
12
12
  def self.variants: -> ::Array[top]
13
13