straddle 0.1.0.pre.alpha.1

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 (428) hide show
  1. checksums.yaml +7 -0
  2. data/.ignore +2 -0
  3. data/CHANGELOG.md +9 -0
  4. data/README.md +344 -0
  5. data/SECURITY.md +27 -0
  6. data/lib/straddle/client.rb +125 -0
  7. data/lib/straddle/errors.rb +214 -0
  8. data/lib/straddle/file_part.rb +55 -0
  9. data/lib/straddle/internal/page_number_schema.rb +127 -0
  10. data/lib/straddle/internal/transport/base_client.rb +563 -0
  11. data/lib/straddle/internal/transport/pooled_net_requester.rb +209 -0
  12. data/lib/straddle/internal/type/array_of.rb +167 -0
  13. data/lib/straddle/internal/type/base_model.rb +536 -0
  14. data/lib/straddle/internal/type/base_page.rb +55 -0
  15. data/lib/straddle/internal/type/boolean.rb +77 -0
  16. data/lib/straddle/internal/type/converter.rb +300 -0
  17. data/lib/straddle/internal/type/enum.rb +131 -0
  18. data/lib/straddle/internal/type/file_input.rb +108 -0
  19. data/lib/straddle/internal/type/hash_of.rb +187 -0
  20. data/lib/straddle/internal/type/request_parameters.rb +42 -0
  21. data/lib/straddle/internal/type/union.rb +235 -0
  22. data/lib/straddle/internal/type/unknown.rb +81 -0
  23. data/lib/straddle/internal/util.rb +914 -0
  24. data/lib/straddle/internal.rb +20 -0
  25. data/lib/straddle/models/bridge/link_bank_account_params.rb +122 -0
  26. data/lib/straddle/models/bridge/link_create_paykey_params.rb +98 -0
  27. data/lib/straddle/models/bridge/link_create_paykey_response.rb +411 -0
  28. data/lib/straddle/models/bridge/link_create_tan_params.rb +122 -0
  29. data/lib/straddle/models/bridge/link_create_tan_response.rb +411 -0
  30. data/lib/straddle/models/bridge/link_plaid_params.rb +95 -0
  31. data/lib/straddle/models/bridge_initialize_params.rb +76 -0
  32. data/lib/straddle/models/bridge_token_v1.rb +74 -0
  33. data/lib/straddle/models/charge_cancel_params.rb +43 -0
  34. data/lib/straddle/models/charge_create_params.rb +191 -0
  35. data/lib/straddle/models/charge_get_params.rb +32 -0
  36. data/lib/straddle/models/charge_hold_params.rb +43 -0
  37. data/lib/straddle/models/charge_release_params.rb +43 -0
  38. data/lib/straddle/models/charge_unmask_params.rb +32 -0
  39. data/lib/straddle/models/charge_unmask_response.rb +485 -0
  40. data/lib/straddle/models/charge_update_params.rb +72 -0
  41. data/lib/straddle/models/charge_v1.rb +485 -0
  42. data/lib/straddle/models/customer_address_v1.rb +51 -0
  43. data/lib/straddle/models/customer_create_params.rb +287 -0
  44. data/lib/straddle/models/customer_delete_params.rb +32 -0
  45. data/lib/straddle/models/customer_details_v1.rb +63 -0
  46. data/lib/straddle/models/customer_get_params.rb +32 -0
  47. data/lib/straddle/models/customer_list_params.rb +173 -0
  48. data/lib/straddle/models/customer_refresh_review_params.rb +32 -0
  49. data/lib/straddle/models/customer_summary_paged_v1.rb +248 -0
  50. data/lib/straddle/models/customer_unmasked_params.rb +32 -0
  51. data/lib/straddle/models/customer_unmasked_v1.rb +366 -0
  52. data/lib/straddle/models/customer_update_params.rb +239 -0
  53. data/lib/straddle/models/customer_v1.rb +371 -0
  54. data/lib/straddle/models/customers/customer_review_v1.rb +1091 -0
  55. data/lib/straddle/models/customers/identity_verification_breakdown_v1.rb +79 -0
  56. data/lib/straddle/models/customers/review_decision_params.rb +56 -0
  57. data/lib/straddle/models/customers/review_get_params.rb +34 -0
  58. data/lib/straddle/models/device_info_v1.rb +20 -0
  59. data/lib/straddle/models/device_unmasked_v1.rb +20 -0
  60. data/lib/straddle/models/embed/account_create_params.rb +106 -0
  61. data/lib/straddle/models/embed/account_get_params.rb +28 -0
  62. data/lib/straddle/models/embed/account_list_params.rb +116 -0
  63. data/lib/straddle/models/embed/account_onboard_params.rb +34 -0
  64. data/lib/straddle/models/embed/account_paged_v1.rb +561 -0
  65. data/lib/straddle/models/embed/account_simulate_params.rb +44 -0
  66. data/lib/straddle/models/embed/account_update_params.rb +58 -0
  67. data/lib/straddle/models/embed/account_v1.rb +557 -0
  68. data/lib/straddle/models/embed/accounts/capability_request_create_params.rb +227 -0
  69. data/lib/straddle/models/embed/accounts/capability_request_list_params.rb +139 -0
  70. data/lib/straddle/models/embed/accounts/capability_request_paged_v1.rb +201 -0
  71. data/lib/straddle/models/embed/address_v1.rb +84 -0
  72. data/lib/straddle/models/embed/business_profile_v1.rb +88 -0
  73. data/lib/straddle/models/embed/capability_v1.rb +28 -0
  74. data/lib/straddle/models/embed/industry_v1.rb +37 -0
  75. data/lib/straddle/models/embed/linked_bank_account_create_params.rb +90 -0
  76. data/lib/straddle/models/embed/linked_bank_account_get_params.rb +28 -0
  77. data/lib/straddle/models/embed/linked_bank_account_list_params.rb +98 -0
  78. data/lib/straddle/models/embed/linked_bank_account_paged_v1.rb +271 -0
  79. data/lib/straddle/models/embed/linked_bank_account_unmask_params.rb +28 -0
  80. data/lib/straddle/models/embed/linked_bank_account_unmask_v1.rb +262 -0
  81. data/lib/straddle/models/embed/linked_bank_account_update_params.rb +81 -0
  82. data/lib/straddle/models/embed/linked_bank_account_v1.rb +263 -0
  83. data/lib/straddle/models/embed/organization_create_params.rb +59 -0
  84. data/lib/straddle/models/embed/organization_get_params.rb +28 -0
  85. data/lib/straddle/models/embed/organization_list_params.rb +89 -0
  86. data/lib/straddle/models/embed/organization_paged_v1.rb +120 -0
  87. data/lib/straddle/models/embed/organization_v1.rb +121 -0
  88. data/lib/straddle/models/embed/representative.rb +351 -0
  89. data/lib/straddle/models/embed/representative_create_params.rb +160 -0
  90. data/lib/straddle/models/embed/representative_get_params.rb +28 -0
  91. data/lib/straddle/models/embed/representative_list_params.rb +112 -0
  92. data/lib/straddle/models/embed/representative_paged.rb +352 -0
  93. data/lib/straddle/models/embed/representative_unmask_params.rb +28 -0
  94. data/lib/straddle/models/embed/representative_update_params.rb +152 -0
  95. data/lib/straddle/models/embed/support_channels_v1.rb +34 -0
  96. data/lib/straddle/models/embed/terms_of_service_v1.rb +68 -0
  97. data/lib/straddle/models/funding_event_get_params.rb +32 -0
  98. data/lib/straddle/models/funding_event_list_params.rb +161 -0
  99. data/lib/straddle/models/funding_event_summary_item_v1.rb +167 -0
  100. data/lib/straddle/models/funding_event_summary_paged_v1.rb +249 -0
  101. data/lib/straddle/models/paged_response_metadata.rb +93 -0
  102. data/lib/straddle/models/paykey_cancel_params.rb +38 -0
  103. data/lib/straddle/models/paykey_details_v1.rb +45 -0
  104. data/lib/straddle/models/paykey_get_params.rb +32 -0
  105. data/lib/straddle/models/paykey_list_params.rb +137 -0
  106. data/lib/straddle/models/paykey_reveal_params.rb +32 -0
  107. data/lib/straddle/models/paykey_reveal_response.rb +405 -0
  108. data/lib/straddle/models/paykey_summary_paged_v1.rb +431 -0
  109. data/lib/straddle/models/paykey_unmasked_params.rb +32 -0
  110. data/lib/straddle/models/paykey_unmasked_v1.rb +399 -0
  111. data/lib/straddle/models/paykey_v1.rb +403 -0
  112. data/lib/straddle/models/payment_list_params.rb +361 -0
  113. data/lib/straddle/models/payment_summary_paged_v1.rb +325 -0
  114. data/lib/straddle/models/payout_cancel_params.rb +43 -0
  115. data/lib/straddle/models/payout_create_params.rb +145 -0
  116. data/lib/straddle/models/payout_get_params.rb +32 -0
  117. data/lib/straddle/models/payout_hold_params.rb +43 -0
  118. data/lib/straddle/models/payout_release_params.rb +43 -0
  119. data/lib/straddle/models/payout_unmask_params.rb +32 -0
  120. data/lib/straddle/models/payout_unmask_response.rb +433 -0
  121. data/lib/straddle/models/payout_update_params.rb +72 -0
  122. data/lib/straddle/models/payout_v1.rb +434 -0
  123. data/lib/straddle/models/report_create_total_customers_by_status_params.rb +32 -0
  124. data/lib/straddle/models/report_create_total_customers_by_status_response.rb +98 -0
  125. data/lib/straddle/models/response_metadata.rb +26 -0
  126. data/lib/straddle/models/status_details_v1.rb +102 -0
  127. data/lib/straddle/models.rb +149 -0
  128. data/lib/straddle/request_options.rb +77 -0
  129. data/lib/straddle/resources/bridge/link.rb +204 -0
  130. data/lib/straddle/resources/bridge.rb +58 -0
  131. data/lib/straddle/resources/charges.rb +305 -0
  132. data/lib/straddle/resources/customers/review.rb +99 -0
  133. data/lib/straddle/resources/customers.rb +349 -0
  134. data/lib/straddle/resources/embed/accounts/capability_requests.rb +115 -0
  135. data/lib/straddle/resources/embed/accounts.rb +251 -0
  136. data/lib/straddle/resources/embed/linked_bank_accounts.rb +199 -0
  137. data/lib/straddle/resources/embed/organizations.rb +129 -0
  138. data/lib/straddle/resources/embed/representatives.rb +233 -0
  139. data/lib/straddle/resources/embed.rb +30 -0
  140. data/lib/straddle/resources/funding_events.rb +114 -0
  141. data/lib/straddle/resources/paykeys.rb +207 -0
  142. data/lib/straddle/resources/payments.rb +131 -0
  143. data/lib/straddle/resources/payouts.rb +303 -0
  144. data/lib/straddle/resources/reports.rb +42 -0
  145. data/lib/straddle/version.rb +5 -0
  146. data/lib/straddle.rb +172 -0
  147. data/manifest.yaml +15 -0
  148. data/rbi/straddle/client.rbi +93 -0
  149. data/rbi/straddle/errors.rbi +178 -0
  150. data/rbi/straddle/file_part.rbi +37 -0
  151. data/rbi/straddle/internal/page_number_schema.rbi +79 -0
  152. data/rbi/straddle/internal/transport/base_client.rbi +293 -0
  153. data/rbi/straddle/internal/transport/pooled_net_requester.rbi +79 -0
  154. data/rbi/straddle/internal/type/array_of.rbi +104 -0
  155. data/rbi/straddle/internal/type/base_model.rbi +302 -0
  156. data/rbi/straddle/internal/type/base_page.rbi +42 -0
  157. data/rbi/straddle/internal/type/boolean.rbi +58 -0
  158. data/rbi/straddle/internal/type/converter.rbi +162 -0
  159. data/rbi/straddle/internal/type/enum.rbi +82 -0
  160. data/rbi/straddle/internal/type/file_input.rbi +59 -0
  161. data/rbi/straddle/internal/type/hash_of.rbi +104 -0
  162. data/rbi/straddle/internal/type/request_parameters.rbi +29 -0
  163. data/rbi/straddle/internal/type/union.rbi +121 -0
  164. data/rbi/straddle/internal/type/unknown.rbi +58 -0
  165. data/rbi/straddle/internal/util.rbi +487 -0
  166. data/rbi/straddle/internal.rbi +16 -0
  167. data/rbi/straddle/models/bridge/link_bank_account_params.rbi +248 -0
  168. data/rbi/straddle/models/bridge/link_create_paykey_params.rbi +196 -0
  169. data/rbi/straddle/models/bridge/link_create_paykey_response.rbi +976 -0
  170. data/rbi/straddle/models/bridge/link_create_tan_params.rbi +243 -0
  171. data/rbi/straddle/models/bridge/link_create_tan_response.rbi +972 -0
  172. data/rbi/straddle/models/bridge/link_plaid_params.rbi +192 -0
  173. data/rbi/straddle/models/bridge_initialize_params.rbi +169 -0
  174. data/rbi/straddle/models/bridge_token_v1.rbi +122 -0
  175. data/rbi/straddle/models/charge_cancel_params.rbi +70 -0
  176. data/rbi/straddle/models/charge_create_params.rbi +369 -0
  177. data/rbi/straddle/models/charge_get_params.rbi +62 -0
  178. data/rbi/straddle/models/charge_hold_params.rbi +70 -0
  179. data/rbi/straddle/models/charge_release_params.rbi +70 -0
  180. data/rbi/straddle/models/charge_unmask_params.rbi +62 -0
  181. data/rbi/straddle/models/charge_unmask_response.rbi +1078 -0
  182. data/rbi/straddle/models/charge_update_params.rbi +98 -0
  183. data/rbi/straddle/models/charge_v1.rbi +932 -0
  184. data/rbi/straddle/models/customer_address_v1.rbi +71 -0
  185. data/rbi/straddle/models/customer_create_params.rbi +542 -0
  186. data/rbi/straddle/models/customer_delete_params.rbi +62 -0
  187. data/rbi/straddle/models/customer_details_v1.rbi +101 -0
  188. data/rbi/straddle/models/customer_get_params.rbi +62 -0
  189. data/rbi/straddle/models/customer_list_params.rbi +306 -0
  190. data/rbi/straddle/models/customer_refresh_review_params.rbi +65 -0
  191. data/rbi/straddle/models/customer_summary_paged_v1.rbi +432 -0
  192. data/rbi/straddle/models/customer_unmasked_params.rbi +62 -0
  193. data/rbi/straddle/models/customer_unmasked_v1.rbi +700 -0
  194. data/rbi/straddle/models/customer_update_params.rbi +381 -0
  195. data/rbi/straddle/models/customer_v1.rbi +667 -0
  196. data/rbi/straddle/models/customers/customer_review_v1.rbi +2212 -0
  197. data/rbi/straddle/models/customers/identity_verification_breakdown_v1.rbi +194 -0
  198. data/rbi/straddle/models/customers/review_decision_params.rbi +110 -0
  199. data/rbi/straddle/models/customers/review_get_params.rbi +67 -0
  200. data/rbi/straddle/models/device_info_v1.rbi +29 -0
  201. data/rbi/straddle/models/device_unmasked_v1.rbi +29 -0
  202. data/rbi/straddle/models/embed/account_create_params.rbi +190 -0
  203. data/rbi/straddle/models/embed/account_get_params.rbi +54 -0
  204. data/rbi/straddle/models/embed/account_list_params.rbi +250 -0
  205. data/rbi/straddle/models/embed/account_onboard_params.rbi +71 -0
  206. data/rbi/straddle/models/embed/account_paged_v1.rbi +1193 -0
  207. data/rbi/straddle/models/embed/account_simulate_params.rbi +111 -0
  208. data/rbi/straddle/models/embed/account_update_params.rbi +91 -0
  209. data/rbi/straddle/models/embed/account_v1.rbi +1162 -0
  210. data/rbi/straddle/models/embed/accounts/capability_request_create_params.rbi +434 -0
  211. data/rbi/straddle/models/embed/accounts/capability_request_list_params.rbi +364 -0
  212. data/rbi/straddle/models/embed/accounts/capability_request_paged_v1.rbi +409 -0
  213. data/rbi/straddle/models/embed/address_v1.rbi +104 -0
  214. data/rbi/straddle/models/embed/business_profile_v1.rbi +125 -0
  215. data/rbi/straddle/models/embed/capability_v1.rbi +70 -0
  216. data/rbi/straddle/models/embed/industry_v1.rbi +55 -0
  217. data/rbi/straddle/models/embed/linked_bank_account_create_params.rbi +149 -0
  218. data/rbi/straddle/models/embed/linked_bank_account_get_params.rbi +54 -0
  219. data/rbi/straddle/models/embed/linked_bank_account_list_params.rbi +213 -0
  220. data/rbi/straddle/models/embed/linked_bank_account_paged_v1.rbi +539 -0
  221. data/rbi/straddle/models/embed/linked_bank_account_unmask_params.rbi +54 -0
  222. data/rbi/straddle/models/embed/linked_bank_account_unmask_v1.rbi +535 -0
  223. data/rbi/straddle/models/embed/linked_bank_account_update_params.rbi +139 -0
  224. data/rbi/straddle/models/embed/linked_bank_account_v1.rbi +532 -0
  225. data/rbi/straddle/models/embed/organization_create_params.rbi +86 -0
  226. data/rbi/straddle/models/embed/organization_get_params.rbi +54 -0
  227. data/rbi/straddle/models/embed/organization_list_params.rbi +169 -0
  228. data/rbi/straddle/models/embed/organization_paged_v1.rbi +206 -0
  229. data/rbi/straddle/models/embed/organization_v1.rbi +202 -0
  230. data/rbi/straddle/models/embed/representative.rbi +609 -0
  231. data/rbi/straddle/models/embed/representative_create_params.rbi +225 -0
  232. data/rbi/straddle/models/embed/representative_get_params.rbi +54 -0
  233. data/rbi/straddle/models/embed/representative_list_params.rbi +229 -0
  234. data/rbi/straddle/models/embed/representative_paged.rbi +623 -0
  235. data/rbi/straddle/models/embed/representative_unmask_params.rbi +54 -0
  236. data/rbi/straddle/models/embed/representative_update_params.rbi +217 -0
  237. data/rbi/straddle/models/embed/support_channels_v1.rbi +58 -0
  238. data/rbi/straddle/models/embed/terms_of_service_v1.rbi +113 -0
  239. data/rbi/straddle/models/funding_event_get_params.rbi +62 -0
  240. data/rbi/straddle/models/funding_event_list_params.rbi +311 -0
  241. data/rbi/straddle/models/funding_event_summary_item_v1.rbi +319 -0
  242. data/rbi/straddle/models/funding_event_summary_paged_v1.rbi +451 -0
  243. data/rbi/straddle/models/paged_response_metadata.rbi +125 -0
  244. data/rbi/straddle/models/paykey_cancel_params.rbi +68 -0
  245. data/rbi/straddle/models/paykey_details_v1.rbi +65 -0
  246. data/rbi/straddle/models/paykey_get_params.rbi +62 -0
  247. data/rbi/straddle/models/paykey_list_params.rbi +253 -0
  248. data/rbi/straddle/models/paykey_reveal_params.rbi +62 -0
  249. data/rbi/straddle/models/paykey_reveal_response.rbi +953 -0
  250. data/rbi/straddle/models/paykey_summary_paged_v1.rbi +926 -0
  251. data/rbi/straddle/models/paykey_unmasked_params.rbi +62 -0
  252. data/rbi/straddle/models/paykey_unmasked_v1.rbi +871 -0
  253. data/rbi/straddle/models/paykey_v1.rbi +800 -0
  254. data/rbi/straddle/models/payment_list_params.rbi +781 -0
  255. data/rbi/straddle/models/payment_summary_paged_v1.rbi +536 -0
  256. data/rbi/straddle/models/payout_cancel_params.rbi +70 -0
  257. data/rbi/straddle/models/payout_create_params.rbi +275 -0
  258. data/rbi/straddle/models/payout_get_params.rbi +62 -0
  259. data/rbi/straddle/models/payout_hold_params.rbi +70 -0
  260. data/rbi/straddle/models/payout_release_params.rbi +70 -0
  261. data/rbi/straddle/models/payout_unmask_params.rbi +62 -0
  262. data/rbi/straddle/models/payout_unmask_response.rbi +966 -0
  263. data/rbi/straddle/models/payout_update_params.rbi +98 -0
  264. data/rbi/straddle/models/payout_v1.rbi +836 -0
  265. data/rbi/straddle/models/report_create_total_customers_by_status_params.rbi +65 -0
  266. data/rbi/straddle/models/report_create_total_customers_by_status_response.rbi +191 -0
  267. data/rbi/straddle/models/response_metadata.rbi +42 -0
  268. data/rbi/straddle/models/status_details_v1.rbi +207 -0
  269. data/rbi/straddle/models.rbi +112 -0
  270. data/rbi/straddle/request_options.rbi +59 -0
  271. data/rbi/straddle/resources/bridge/link.rbi +175 -0
  272. data/rbi/straddle/resources/bridge.rbi +44 -0
  273. data/rbi/straddle/resources/charges.rbi +242 -0
  274. data/rbi/straddle/resources/customers/review.rbi +75 -0
  275. data/rbi/straddle/resources/customers.rbi +307 -0
  276. data/rbi/straddle/resources/embed/accounts/capability_requests.rbi +116 -0
  277. data/rbi/straddle/resources/embed/accounts.rbi +216 -0
  278. data/rbi/straddle/resources/embed/linked_bank_accounts.rbi +169 -0
  279. data/rbi/straddle/resources/embed/organizations.rbi +110 -0
  280. data/rbi/straddle/resources/embed/representatives.rbi +208 -0
  281. data/rbi/straddle/resources/embed.rbi +24 -0
  282. data/rbi/straddle/resources/funding_events.rbi +94 -0
  283. data/rbi/straddle/resources/paykeys.rbi +161 -0
  284. data/rbi/straddle/resources/payments.rbi +125 -0
  285. data/rbi/straddle/resources/payouts.rbi +237 -0
  286. data/rbi/straddle/resources/reports.rbi +31 -0
  287. data/rbi/straddle/version.rbi +5 -0
  288. data/sig/straddle/client.rbs +48 -0
  289. data/sig/straddle/errors.rbs +110 -0
  290. data/sig/straddle/file_part.rbs +21 -0
  291. data/sig/straddle/internal/page_number_schema.rbs +52 -0
  292. data/sig/straddle/internal/transport/base_client.rbs +131 -0
  293. data/sig/straddle/internal/transport/pooled_net_requester.rbs +45 -0
  294. data/sig/straddle/internal/type/array_of.rbs +48 -0
  295. data/sig/straddle/internal/type/base_model.rbs +102 -0
  296. data/sig/straddle/internal/type/base_page.rbs +24 -0
  297. data/sig/straddle/internal/type/boolean.rbs +26 -0
  298. data/sig/straddle/internal/type/converter.rbs +62 -0
  299. data/sig/straddle/internal/type/enum.rbs +32 -0
  300. data/sig/straddle/internal/type/file_input.rbs +25 -0
  301. data/sig/straddle/internal/type/hash_of.rbs +48 -0
  302. data/sig/straddle/internal/type/request_parameters.rbs +17 -0
  303. data/sig/straddle/internal/type/union.rbs +52 -0
  304. data/sig/straddle/internal/type/unknown.rbs +26 -0
  305. data/sig/straddle/internal/util.rbs +185 -0
  306. data/sig/straddle/internal.rbs +9 -0
  307. data/sig/straddle/models/bridge/link_bank_account_params.rbs +122 -0
  308. data/sig/straddle/models/bridge/link_create_paykey_params.rbs +101 -0
  309. data/sig/straddle/models/bridge/link_create_paykey_response.rbs +389 -0
  310. data/sig/straddle/models/bridge/link_create_tan_params.rbs +122 -0
  311. data/sig/straddle/models/bridge/link_create_tan_response.rbs +389 -0
  312. data/sig/straddle/models/bridge/link_plaid_params.rbs +101 -0
  313. data/sig/straddle/models/bridge_initialize_params.rbs +89 -0
  314. data/sig/straddle/models/bridge_token_v1.rbs +53 -0
  315. data/sig/straddle/models/charge_cancel_params.rbs +47 -0
  316. data/sig/straddle/models/charge_create_params.rbs +172 -0
  317. data/sig/straddle/models/charge_get_params.rbs +42 -0
  318. data/sig/straddle/models/charge_hold_params.rbs +47 -0
  319. data/sig/straddle/models/charge_release_params.rbs +47 -0
  320. data/sig/straddle/models/charge_unmask_params.rbs +42 -0
  321. data/sig/straddle/models/charge_unmask_response.rbs +437 -0
  322. data/sig/straddle/models/charge_update_params.rbs +62 -0
  323. data/sig/straddle/models/charge_v1.rbs +427 -0
  324. data/sig/straddle/models/customer_address_v1.rbs +40 -0
  325. data/sig/straddle/models/customer_create_params.rbs +235 -0
  326. data/sig/straddle/models/customer_delete_params.rbs +42 -0
  327. data/sig/straddle/models/customer_details_v1.rbs +51 -0
  328. data/sig/straddle/models/customer_get_params.rbs +42 -0
  329. data/sig/straddle/models/customer_list_params.rbs +182 -0
  330. data/sig/straddle/models/customer_refresh_review_params.rbs +42 -0
  331. data/sig/straddle/models/customer_summary_paged_v1.rbs +194 -0
  332. data/sig/straddle/models/customer_unmasked_params.rbs +42 -0
  333. data/sig/straddle/models/customer_unmasked_v1.rbs +285 -0
  334. data/sig/straddle/models/customer_update_params.rbs +173 -0
  335. data/sig/straddle/models/customer_v1.rbs +297 -0
  336. data/sig/straddle/models/customers/customer_review_v1.rbs +1001 -0
  337. data/sig/straddle/models/customers/identity_verification_breakdown_v1.rbs +81 -0
  338. data/sig/straddle/models/customers/review_decision_params.rbs +60 -0
  339. data/sig/straddle/models/customers/review_get_params.rbs +44 -0
  340. data/sig/straddle/models/device_info_v1.rbs +13 -0
  341. data/sig/straddle/models/device_unmasked_v1.rbs +13 -0
  342. data/sig/straddle/models/embed/account_create_params.rbs +89 -0
  343. data/sig/straddle/models/embed/account_get_params.rbs +34 -0
  344. data/sig/straddle/models/embed/account_list_params.rbs +127 -0
  345. data/sig/straddle/models/embed/account_onboard_params.rbs +42 -0
  346. data/sig/straddle/models/embed/account_paged_v1.rbs +493 -0
  347. data/sig/straddle/models/embed/account_simulate_params.rbs +57 -0
  348. data/sig/straddle/models/embed/account_update_params.rbs +52 -0
  349. data/sig/straddle/models/embed/account_v1.rbs +493 -0
  350. data/sig/straddle/models/embed/accounts/capability_request_create_params.rbs +207 -0
  351. data/sig/straddle/models/embed/accounts/capability_request_list_params.rbs +153 -0
  352. data/sig/straddle/models/embed/accounts/capability_request_paged_v1.rbs +153 -0
  353. data/sig/straddle/models/embed/address_v1.rbs +62 -0
  354. data/sig/straddle/models/embed/business_profile_v1.rbs +75 -0
  355. data/sig/straddle/models/embed/capability_v1.rbs +33 -0
  356. data/sig/straddle/models/embed/industry_v1.rbs +23 -0
  357. data/sig/straddle/models/embed/linked_bank_account_create_params.rbs +79 -0
  358. data/sig/straddle/models/embed/linked_bank_account_get_params.rbs +34 -0
  359. data/sig/straddle/models/embed/linked_bank_account_list_params.rbs +105 -0
  360. data/sig/straddle/models/embed/linked_bank_account_paged_v1.rbs +215 -0
  361. data/sig/straddle/models/embed/linked_bank_account_unmask_params.rbs +34 -0
  362. data/sig/straddle/models/embed/linked_bank_account_unmask_v1.rbs +210 -0
  363. data/sig/straddle/models/embed/linked_bank_account_update_params.rbs +74 -0
  364. data/sig/straddle/models/embed/linked_bank_account_v1.rbs +215 -0
  365. data/sig/straddle/models/embed/organization_create_params.rbs +52 -0
  366. data/sig/straddle/models/embed/organization_get_params.rbs +34 -0
  367. data/sig/straddle/models/embed/organization_list_params.rbs +92 -0
  368. data/sig/straddle/models/embed/organization_paged_v1.rbs +87 -0
  369. data/sig/straddle/models/embed/organization_v1.rbs +87 -0
  370. data/sig/straddle/models/embed/representative.rbs +260 -0
  371. data/sig/straddle/models/embed/representative_create_params.rbs +119 -0
  372. data/sig/straddle/models/embed/representative_get_params.rbs +34 -0
  373. data/sig/straddle/models/embed/representative_list_params.rbs +119 -0
  374. data/sig/straddle/models/embed/representative_paged.rbs +260 -0
  375. data/sig/straddle/models/embed/representative_unmask_params.rbs +34 -0
  376. data/sig/straddle/models/embed/representative_update_params.rbs +114 -0
  377. data/sig/straddle/models/embed/support_channels_v1.rbs +24 -0
  378. data/sig/straddle/models/embed/terms_of_service_v1.rbs +53 -0
  379. data/sig/straddle/models/funding_event_get_params.rbs +42 -0
  380. data/sig/straddle/models/funding_event_list_params.rbs +155 -0
  381. data/sig/straddle/models/funding_event_summary_item_v1.rbs +123 -0
  382. data/sig/straddle/models/funding_event_summary_paged_v1.rbs +191 -0
  383. data/sig/straddle/models/paged_response_metadata.rbs +71 -0
  384. data/sig/straddle/models/paykey_cancel_params.rbs +47 -0
  385. data/sig/straddle/models/paykey_details_v1.rbs +30 -0
  386. data/sig/straddle/models/paykey_get_params.rbs +42 -0
  387. data/sig/straddle/models/paykey_list_params.rbs +151 -0
  388. data/sig/straddle/models/paykey_reveal_params.rbs +42 -0
  389. data/sig/straddle/models/paykey_reveal_response.rbs +386 -0
  390. data/sig/straddle/models/paykey_summary_paged_v1.rbs +401 -0
  391. data/sig/straddle/models/paykey_unmasked_params.rbs +42 -0
  392. data/sig/straddle/models/paykey_unmasked_v1.rbs +386 -0
  393. data/sig/straddle/models/paykey_v1.rbs +386 -0
  394. data/sig/straddle/models/payment_list_params.rbs +391 -0
  395. data/sig/straddle/models/payment_summary_paged_v1.rbs +252 -0
  396. data/sig/straddle/models/payout_cancel_params.rbs +47 -0
  397. data/sig/straddle/models/payout_create_params.rbs +143 -0
  398. data/sig/straddle/models/payout_get_params.rbs +42 -0
  399. data/sig/straddle/models/payout_hold_params.rbs +47 -0
  400. data/sig/straddle/models/payout_release_params.rbs +47 -0
  401. data/sig/straddle/models/payout_unmask_params.rbs +42 -0
  402. data/sig/straddle/models/payout_unmask_response.rbs +404 -0
  403. data/sig/straddle/models/payout_update_params.rbs +62 -0
  404. data/sig/straddle/models/payout_v1.rbs +394 -0
  405. data/sig/straddle/models/report_create_total_customers_by_status_params.rbs +42 -0
  406. data/sig/straddle/models/report_create_total_customers_by_status_response.rbs +80 -0
  407. data/sig/straddle/models/response_metadata.rbs +19 -0
  408. data/sig/straddle/models/status_details_v1.rbs +104 -0
  409. data/sig/straddle/models.rbs +109 -0
  410. data/sig/straddle/request_options.rbs +34 -0
  411. data/sig/straddle/resources/bridge/link.rbs +57 -0
  412. data/sig/straddle/resources/bridge.rbs +18 -0
  413. data/sig/straddle/resources/charges.rbs +79 -0
  414. data/sig/straddle/resources/customers/review.rbs +26 -0
  415. data/sig/straddle/resources/customers.rbs +94 -0
  416. data/sig/straddle/resources/embed/accounts/capability_requests.rbs +38 -0
  417. data/sig/straddle/resources/embed/accounts.rbs +69 -0
  418. data/sig/straddle/resources/embed/linked_bank_accounts.rbs +53 -0
  419. data/sig/straddle/resources/embed/organizations.rbs +37 -0
  420. data/sig/straddle/resources/embed/representatives.rbs +67 -0
  421. data/sig/straddle/resources/embed.rbs +15 -0
  422. data/sig/straddle/resources/funding_events.rbs +31 -0
  423. data/sig/straddle/resources/paykeys.rbs +54 -0
  424. data/sig/straddle/resources/payments.rbs +40 -0
  425. data/sig/straddle/resources/payouts.rbs +78 -0
  426. data/sig/straddle/resources/reports.rbs +14 -0
  427. data/sig/straddle/version.rbs +3 -0
  428. metadata +485 -0
@@ -0,0 +1,434 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Straddle
4
+ module Models
5
+ # @see Straddle::Resources::Payouts#create
6
+ class PayoutV1 < Straddle::Internal::Type::BaseModel
7
+ # @!attribute data
8
+ #
9
+ # @return [Straddle::Models::PayoutV1::Data]
10
+ required :data, -> { Straddle::PayoutV1::Data }
11
+
12
+ # @!attribute meta
13
+ # Metadata about the API request, including an identifier and timestamp.
14
+ #
15
+ # @return [Straddle::Models::ResponseMetadata]
16
+ required :meta, -> { Straddle::ResponseMetadata }
17
+
18
+ # @!attribute response_type
19
+ # Indicates the structure of the returned content.
20
+ #
21
+ # - "object" means the `data` field contains a single JSON object.
22
+ # - "array" means the `data` field contains an array of objects.
23
+ # - "error" means the `data` field contains an error object with details of the
24
+ # issue.
25
+ # - "none" means no data is returned.
26
+ #
27
+ # @return [Symbol, Straddle::Models::PayoutV1::ResponseType]
28
+ required :response_type, enum: -> { Straddle::PayoutV1::ResponseType }
29
+
30
+ # @!method initialize(data:, meta:, response_type:)
31
+ # Some parameter documentations has been truncated, see
32
+ # {Straddle::Models::PayoutV1} for more details.
33
+ #
34
+ # @param data [Straddle::Models::PayoutV1::Data]
35
+ #
36
+ # @param meta [Straddle::Models::ResponseMetadata] Metadata about the API request, including an identifier and timestamp.
37
+ #
38
+ # @param response_type [Symbol, Straddle::Models::PayoutV1::ResponseType] Indicates the structure of the returned content.
39
+
40
+ # @see Straddle::Models::PayoutV1#data
41
+ class Data < Straddle::Internal::Type::BaseModel
42
+ # @!attribute id
43
+ # Unique identifier for the payout.
44
+ #
45
+ # @return [String]
46
+ required :id, String
47
+
48
+ # @!attribute amount
49
+ # The amount of the payout in cents.
50
+ #
51
+ # @return [Integer]
52
+ required :amount, Integer
53
+
54
+ # @!attribute config
55
+ # Configuration for the payout.
56
+ #
57
+ # @return [Straddle::Models::PayoutV1::Data::Config]
58
+ required :config, -> { Straddle::PayoutV1::Data::Config }
59
+
60
+ # @!attribute currency
61
+ # The currency of the payout. Only USD is supported.
62
+ #
63
+ # @return [String]
64
+ required :currency, String
65
+
66
+ # @!attribute description
67
+ # An arbitrary description for the payout.
68
+ #
69
+ # @return [String]
70
+ required :description, String
71
+
72
+ # @!attribute device
73
+ # Information about the device used when the customer authorized the payout.
74
+ #
75
+ # @return [Straddle::Models::DeviceInfoV1]
76
+ required :device, -> { Straddle::DeviceInfoV1 }
77
+
78
+ # @!attribute external_id
79
+ # Unique identifier for the payout in your database. This value must be unique
80
+ # across all payouts.
81
+ #
82
+ # @return [String]
83
+ required :external_id, String
84
+
85
+ # @!attribute funding_ids
86
+ # Funding Ids
87
+ #
88
+ # @return [Array<String>]
89
+ required :funding_ids, Straddle::Internal::Type::ArrayOf[String]
90
+
91
+ # @!attribute paykey
92
+ # Value of the `paykey` used for the payout.
93
+ #
94
+ # @return [String]
95
+ required :paykey, String
96
+
97
+ # @!attribute payment_date
98
+ # The desired date on which the payment should be occur. For payouts, this means
99
+ # the date you want the funds to be sent from your bank account.
100
+ #
101
+ # @return [Date]
102
+ required :payment_date, Date
103
+
104
+ # @!attribute status
105
+ # The current status of the payout.
106
+ #
107
+ # @return [Symbol, Straddle::Models::PayoutV1::Data::Status]
108
+ required :status, enum: -> { Straddle::PayoutV1::Data::Status }
109
+
110
+ # @!attribute status_details
111
+ # Details about the current status of the payout.
112
+ #
113
+ # @return [Straddle::Models::StatusDetailsV1]
114
+ required :status_details, -> { Straddle::StatusDetailsV1 }
115
+
116
+ # @!attribute status_history
117
+ # History of the status changes for the payout.
118
+ #
119
+ # @return [Array<Straddle::Models::PayoutV1::Data::StatusHistory>]
120
+ required :status_history,
121
+ -> { Straddle::Internal::Type::ArrayOf[Straddle::PayoutV1::Data::StatusHistory] }
122
+
123
+ # @!attribute created_at
124
+ # The time the payout was created.
125
+ #
126
+ # @return [Time, nil]
127
+ optional :created_at, Time, nil?: true
128
+
129
+ # @!attribute customer_details
130
+ # Information about the customer associated with the payout.
131
+ #
132
+ # @return [Straddle::Models::CustomerDetailsV1, nil]
133
+ optional :customer_details, -> { Straddle::CustomerDetailsV1 }
134
+
135
+ # @!attribute effective_at
136
+ # The actual date on which the payment occurred. For payouts, this is the date the
137
+ # funds were sent from your bank account.
138
+ #
139
+ # @return [Time, nil]
140
+ optional :effective_at, Time, nil?: true
141
+
142
+ # @!attribute metadata
143
+ # Up to 20 additional user-defined key-value pairs. Useful for storing additional
144
+ # information about the payout in a structured format.
145
+ #
146
+ # @return [Hash{Symbol=>String}, nil]
147
+ optional :metadata, Straddle::Internal::Type::HashOf[String], nil?: true
148
+
149
+ # @!attribute paykey_details
150
+ # Information about the paykey used for the payout.
151
+ #
152
+ # @return [Straddle::Models::PaykeyDetailsV1, nil]
153
+ optional :paykey_details, -> { Straddle::PaykeyDetailsV1 }
154
+
155
+ # @!attribute payment_rail
156
+ # The payment rail used for the payout.
157
+ #
158
+ # @return [Symbol, Straddle::Models::PayoutV1::Data::PaymentRail, nil]
159
+ optional :payment_rail, enum: -> { Straddle::PayoutV1::Data::PaymentRail }
160
+
161
+ # @!attribute processed_at
162
+ # The time the payout was processed by Straddle and originated to the payment
163
+ # rail.
164
+ #
165
+ # @return [Time, nil]
166
+ optional :processed_at, Time, nil?: true
167
+
168
+ # @!attribute updated_at
169
+ # The time the payout was last updated.
170
+ #
171
+ # @return [Time, nil]
172
+ optional :updated_at, Time, nil?: true
173
+
174
+ # @!method initialize(id:, amount:, config:, currency:, description:, device:, external_id:, funding_ids:, paykey:, payment_date:, status:, status_details:, status_history:, created_at: nil, customer_details: nil, effective_at: nil, metadata: nil, paykey_details: nil, payment_rail: nil, processed_at: nil, updated_at: nil)
175
+ # Some parameter documentations has been truncated, see
176
+ # {Straddle::Models::PayoutV1::Data} for more details.
177
+ #
178
+ # @param id [String] Unique identifier for the payout.
179
+ #
180
+ # @param amount [Integer] The amount of the payout in cents.
181
+ #
182
+ # @param config [Straddle::Models::PayoutV1::Data::Config] Configuration for the payout.
183
+ #
184
+ # @param currency [String] The currency of the payout. Only USD is supported.
185
+ #
186
+ # @param description [String] An arbitrary description for the payout.
187
+ #
188
+ # @param device [Straddle::Models::DeviceInfoV1] Information about the device used when the customer authorized the payout.
189
+ #
190
+ # @param external_id [String] Unique identifier for the payout in your database. This value must be unique acr
191
+ #
192
+ # @param funding_ids [Array<String>] Funding Ids
193
+ #
194
+ # @param paykey [String] Value of the `paykey` used for the payout.
195
+ #
196
+ # @param payment_date [Date] The desired date on which the payment should be occur. For payouts, this means t
197
+ #
198
+ # @param status [Symbol, Straddle::Models::PayoutV1::Data::Status] The current status of the payout.
199
+ #
200
+ # @param status_details [Straddle::Models::StatusDetailsV1] Details about the current status of the payout.
201
+ #
202
+ # @param status_history [Array<Straddle::Models::PayoutV1::Data::StatusHistory>] History of the status changes for the payout.
203
+ #
204
+ # @param created_at [Time, nil] The time the payout was created.
205
+ #
206
+ # @param customer_details [Straddle::Models::CustomerDetailsV1] Information about the customer associated with the payout.
207
+ #
208
+ # @param effective_at [Time, nil] The actual date on which the payment occurred. For payouts, this is the date the
209
+ #
210
+ # @param metadata [Hash{Symbol=>String}, nil] Up to 20 additional user-defined key-value pairs. Useful for storing additional
211
+ #
212
+ # @param paykey_details [Straddle::Models::PaykeyDetailsV1] Information about the paykey used for the payout.
213
+ #
214
+ # @param payment_rail [Symbol, Straddle::Models::PayoutV1::Data::PaymentRail] The payment rail used for the payout.
215
+ #
216
+ # @param processed_at [Time, nil] The time the payout was processed by Straddle and originated to the payment rail
217
+ #
218
+ # @param updated_at [Time, nil] The time the payout was last updated.
219
+
220
+ # @see Straddle::Models::PayoutV1::Data#config
221
+ class Config < Straddle::Internal::Type::BaseModel
222
+ # @!attribute sandbox_outcome
223
+ # Payment will simulate processing if not Standard.
224
+ #
225
+ # @return [Symbol, Straddle::Models::PayoutV1::Data::Config::SandboxOutcome, nil]
226
+ optional :sandbox_outcome, enum: -> { Straddle::PayoutV1::Data::Config::SandboxOutcome }
227
+
228
+ # @!method initialize(sandbox_outcome: nil)
229
+ # Configuration for the payout.
230
+ #
231
+ # @param sandbox_outcome [Symbol, Straddle::Models::PayoutV1::Data::Config::SandboxOutcome] Payment will simulate processing if not Standard.
232
+
233
+ # Payment will simulate processing if not Standard.
234
+ #
235
+ # @see Straddle::Models::PayoutV1::Data::Config#sandbox_outcome
236
+ module SandboxOutcome
237
+ extend Straddle::Internal::Type::Enum
238
+
239
+ STANDARD = :standard
240
+ PAID = :paid
241
+ ON_HOLD_DAILY_LIMIT = :on_hold_daily_limit
242
+ CANCELLED_FOR_FRAUD_RISK = :cancelled_for_fraud_risk
243
+ CANCELLED_FOR_BALANCE_CHECK = :cancelled_for_balance_check
244
+ FAILED_INSUFFICIENT_FUNDS = :failed_insufficient_funds
245
+ REVERSED_INSUFFICIENT_FUNDS = :reversed_insufficient_funds
246
+ FAILED_CUSTOMER_DISPUTE = :failed_customer_dispute
247
+ REVERSED_CUSTOMER_DISPUTE = :reversed_customer_dispute
248
+ FAILED_CLOSED_BANK_ACCOUNT = :failed_closed_bank_account
249
+ REVERSED_CLOSED_BANK_ACCOUNT = :reversed_closed_bank_account
250
+
251
+ # @!method self.values
252
+ # @return [Array<Symbol>]
253
+ end
254
+ end
255
+
256
+ # The current status of the payout.
257
+ #
258
+ # @see Straddle::Models::PayoutV1::Data#status
259
+ module Status
260
+ extend Straddle::Internal::Type::Enum
261
+
262
+ CREATED = :created
263
+ SCHEDULED = :scheduled
264
+ FAILED = :failed
265
+ CANCELLED = :cancelled
266
+ ON_HOLD = :on_hold
267
+ PENDING = :pending
268
+ PAID = :paid
269
+ REVERSED = :reversed
270
+
271
+ # @!method self.values
272
+ # @return [Array<Symbol>]
273
+ end
274
+
275
+ class StatusHistory < Straddle::Internal::Type::BaseModel
276
+ # @!attribute changed_at
277
+ # The time the status change occurred.
278
+ #
279
+ # @return [Time]
280
+ required :changed_at, Time
281
+
282
+ # @!attribute message
283
+ # A human-readable description of the status.
284
+ #
285
+ # @return [String]
286
+ required :message, String
287
+
288
+ # @!attribute reason
289
+ # A machine-readable identifier for the specific status, useful for programmatic
290
+ # handling.
291
+ #
292
+ # @return [Symbol, Straddle::Models::PayoutV1::Data::StatusHistory::Reason]
293
+ required :reason, enum: -> { Straddle::PayoutV1::Data::StatusHistory::Reason }
294
+
295
+ # @!attribute source
296
+ # Identifies the origin of the status change (e.g., `bank_decline`, `watchtower`).
297
+ # This helps in tracking the cause of status updates.
298
+ #
299
+ # @return [Symbol, Straddle::Models::PayoutV1::Data::StatusHistory::Source]
300
+ required :source, enum: -> { Straddle::PayoutV1::Data::StatusHistory::Source }
301
+
302
+ # @!attribute status
303
+ # The current status of the `charge` or `payout`.
304
+ #
305
+ # @return [Symbol, Straddle::Models::PayoutV1::Data::StatusHistory::Status]
306
+ required :status, enum: -> { Straddle::PayoutV1::Data::StatusHistory::Status }
307
+
308
+ # @!attribute code
309
+ # The status code if applicable.
310
+ #
311
+ # @return [String, nil]
312
+ optional :code, String, nil?: true
313
+
314
+ # @!method initialize(changed_at:, message:, reason:, source:, status:, code: nil)
315
+ # Some parameter documentations has been truncated, see
316
+ # {Straddle::Models::PayoutV1::Data::StatusHistory} for more details.
317
+ #
318
+ # @param changed_at [Time] The time the status change occurred.
319
+ #
320
+ # @param message [String] A human-readable description of the status.
321
+ #
322
+ # @param reason [Symbol, Straddle::Models::PayoutV1::Data::StatusHistory::Reason] A machine-readable identifier for the specific status, useful for programmatic h
323
+ #
324
+ # @param source [Symbol, Straddle::Models::PayoutV1::Data::StatusHistory::Source] Identifies the origin of the status change (e.g., `bank_decline`, `watchtower`).
325
+ #
326
+ # @param status [Symbol, Straddle::Models::PayoutV1::Data::StatusHistory::Status] The current status of the `charge` or `payout`.
327
+ #
328
+ # @param code [String, nil] The status code if applicable.
329
+
330
+ # A machine-readable identifier for the specific status, useful for programmatic
331
+ # handling.
332
+ #
333
+ # @see Straddle::Models::PayoutV1::Data::StatusHistory#reason
334
+ module Reason
335
+ extend Straddle::Internal::Type::Enum
336
+
337
+ INSUFFICIENT_FUNDS = :insufficient_funds
338
+ CLOSED_BANK_ACCOUNT = :closed_bank_account
339
+ INVALID_BANK_ACCOUNT = :invalid_bank_account
340
+ INVALID_ROUTING = :invalid_routing
341
+ DISPUTED = :disputed
342
+ PAYMENT_STOPPED = :payment_stopped
343
+ OWNER_DECEASED = :owner_deceased
344
+ FROZEN_BANK_ACCOUNT = :frozen_bank_account
345
+ RISK_REVIEW = :risk_review
346
+ FRAUDULENT = :fraudulent
347
+ DUPLICATE_ENTRY = :duplicate_entry
348
+ INVALID_PAYKEY = :invalid_paykey
349
+ PAYMENT_BLOCKED = :payment_blocked
350
+ AMOUNT_TOO_LARGE = :amount_too_large
351
+ TOO_MANY_ATTEMPTS = :too_many_attempts
352
+ INTERNAL_SYSTEM_ERROR = :internal_system_error
353
+ USER_REQUEST = :user_request
354
+ OK = :ok
355
+ OTHER_NETWORK_RETURN = :other_network_return
356
+ PAYOUT_REFUSED = :payout_refused
357
+
358
+ # @!method self.values
359
+ # @return [Array<Symbol>]
360
+ end
361
+
362
+ # Identifies the origin of the status change (e.g., `bank_decline`, `watchtower`).
363
+ # This helps in tracking the cause of status updates.
364
+ #
365
+ # @see Straddle::Models::PayoutV1::Data::StatusHistory#source
366
+ module Source
367
+ extend Straddle::Internal::Type::Enum
368
+
369
+ WATCHTOWER = :watchtower
370
+ BANK_DECLINE = :bank_decline
371
+ CUSTOMER_DISPUTE = :customer_dispute
372
+ USER_ACTION = :user_action
373
+ SYSTEM = :system
374
+
375
+ # @!method self.values
376
+ # @return [Array<Symbol>]
377
+ end
378
+
379
+ # The current status of the `charge` or `payout`.
380
+ #
381
+ # @see Straddle::Models::PayoutV1::Data::StatusHistory#status
382
+ module Status
383
+ extend Straddle::Internal::Type::Enum
384
+
385
+ CREATED = :created
386
+ SCHEDULED = :scheduled
387
+ FAILED = :failed
388
+ CANCELLED = :cancelled
389
+ ON_HOLD = :on_hold
390
+ PENDING = :pending
391
+ PAID = :paid
392
+ REVERSED = :reversed
393
+
394
+ # @!method self.values
395
+ # @return [Array<Symbol>]
396
+ end
397
+ end
398
+
399
+ # The payment rail used for the payout.
400
+ #
401
+ # @see Straddle::Models::PayoutV1::Data#payment_rail
402
+ module PaymentRail
403
+ extend Straddle::Internal::Type::Enum
404
+
405
+ ACH = :ach
406
+
407
+ # @!method self.values
408
+ # @return [Array<Symbol>]
409
+ end
410
+ end
411
+
412
+ # Indicates the structure of the returned content.
413
+ #
414
+ # - "object" means the `data` field contains a single JSON object.
415
+ # - "array" means the `data` field contains an array of objects.
416
+ # - "error" means the `data` field contains an error object with details of the
417
+ # issue.
418
+ # - "none" means no data is returned.
419
+ #
420
+ # @see Straddle::Models::PayoutV1#response_type
421
+ module ResponseType
422
+ extend Straddle::Internal::Type::Enum
423
+
424
+ OBJECT = :object
425
+ ARRAY = :array
426
+ ERROR = :error
427
+ NONE = :none
428
+
429
+ # @!method self.values
430
+ # @return [Array<Symbol>]
431
+ end
432
+ end
433
+ end
434
+ end
@@ -0,0 +1,32 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Straddle
4
+ module Models
5
+ # @see Straddle::Resources::Reports#create_total_customers_by_status
6
+ class ReportCreateTotalCustomersByStatusParams < Straddle::Internal::Type::BaseModel
7
+ extend Straddle::Internal::Type::RequestParameters::Converter
8
+ include Straddle::Internal::Type::RequestParameters
9
+
10
+ # @!attribute correlation_id
11
+ #
12
+ # @return [String, nil]
13
+ optional :correlation_id, String
14
+
15
+ # @!attribute request_id
16
+ #
17
+ # @return [String, nil]
18
+ optional :request_id, String
19
+
20
+ # @!attribute straddle_account_id
21
+ #
22
+ # @return [String, nil]
23
+ optional :straddle_account_id, String
24
+
25
+ # @!method initialize(correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
26
+ # @param correlation_id [String]
27
+ # @param request_id [String]
28
+ # @param straddle_account_id [String]
29
+ # @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}]
30
+ end
31
+ end
32
+ end
@@ -0,0 +1,98 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Straddle
4
+ module Models
5
+ # @see Straddle::Resources::Reports#create_total_customers_by_status
6
+ class ReportCreateTotalCustomersByStatusResponse < Straddle::Internal::Type::BaseModel
7
+ # @!attribute data
8
+ #
9
+ # @return [Straddle::Models::ReportCreateTotalCustomersByStatusResponse::Data]
10
+ required :data, -> { Straddle::Models::ReportCreateTotalCustomersByStatusResponse::Data }
11
+
12
+ # @!attribute meta
13
+ # Metadata about the API request, including an identifier and timestamp.
14
+ #
15
+ # @return [Straddle::Models::ResponseMetadata]
16
+ required :meta, -> { Straddle::ResponseMetadata }
17
+
18
+ # @!attribute response_type
19
+ # Indicates the structure of the returned content.
20
+ #
21
+ # - "object" means the `data` field contains a single JSON object.
22
+ # - "array" means the `data` field contains an array of objects.
23
+ # - "error" means the `data` field contains an error object with details of the
24
+ # issue.
25
+ # - "none" means no data is returned.
26
+ #
27
+ # @return [Symbol, Straddle::Models::ReportCreateTotalCustomersByStatusResponse::ResponseType]
28
+ required :response_type,
29
+ enum: -> { Straddle::Models::ReportCreateTotalCustomersByStatusResponse::ResponseType }
30
+
31
+ # @!method initialize(data:, meta:, response_type:)
32
+ # Some parameter documentations has been truncated, see
33
+ # {Straddle::Models::ReportCreateTotalCustomersByStatusResponse} for more details.
34
+ #
35
+ # @param data [Straddle::Models::ReportCreateTotalCustomersByStatusResponse::Data]
36
+ #
37
+ # @param meta [Straddle::Models::ResponseMetadata] Metadata about the API request, including an identifier and timestamp.
38
+ #
39
+ # @param response_type [Symbol, Straddle::Models::ReportCreateTotalCustomersByStatusResponse::ResponseType] Indicates the structure of the returned content.
40
+
41
+ # @see Straddle::Models::ReportCreateTotalCustomersByStatusResponse#data
42
+ class Data < Straddle::Internal::Type::BaseModel
43
+ # @!attribute inactive
44
+ #
45
+ # @return [Integer]
46
+ required :inactive, Integer
47
+
48
+ # @!attribute pending
49
+ #
50
+ # @return [Integer]
51
+ required :pending, Integer
52
+
53
+ # @!attribute rejected
54
+ #
55
+ # @return [Integer]
56
+ required :rejected, Integer
57
+
58
+ # @!attribute review
59
+ #
60
+ # @return [Integer]
61
+ required :review, Integer
62
+
63
+ # @!attribute verified
64
+ #
65
+ # @return [Integer]
66
+ required :verified, Integer
67
+
68
+ # @!method initialize(inactive:, pending:, rejected:, review:, verified:)
69
+ # @param inactive [Integer]
70
+ # @param pending [Integer]
71
+ # @param rejected [Integer]
72
+ # @param review [Integer]
73
+ # @param verified [Integer]
74
+ end
75
+
76
+ # Indicates the structure of the returned content.
77
+ #
78
+ # - "object" means the `data` field contains a single JSON object.
79
+ # - "array" means the `data` field contains an array of objects.
80
+ # - "error" means the `data` field contains an error object with details of the
81
+ # issue.
82
+ # - "none" means no data is returned.
83
+ #
84
+ # @see Straddle::Models::ReportCreateTotalCustomersByStatusResponse#response_type
85
+ module ResponseType
86
+ extend Straddle::Internal::Type::Enum
87
+
88
+ OBJECT = :object
89
+ ARRAY = :array
90
+ ERROR = :error
91
+ NONE = :none
92
+
93
+ # @!method self.values
94
+ # @return [Array<Symbol>]
95
+ end
96
+ end
97
+ end
98
+ end
@@ -0,0 +1,26 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Straddle
4
+ module Models
5
+ class ResponseMetadata < Straddle::Internal::Type::BaseModel
6
+ # @!attribute api_request_id
7
+ # Unique identifier for this API request, useful for troubleshooting.
8
+ #
9
+ # @return [String]
10
+ required :api_request_id, String
11
+
12
+ # @!attribute api_request_timestamp
13
+ # Timestamp for this API request, useful for troubleshooting.
14
+ #
15
+ # @return [Time]
16
+ required :api_request_timestamp, Time
17
+
18
+ # @!method initialize(api_request_id:, api_request_timestamp:)
19
+ # Metadata about the API request, including an identifier and timestamp.
20
+ #
21
+ # @param api_request_id [String] Unique identifier for this API request, useful for troubleshooting.
22
+ #
23
+ # @param api_request_timestamp [Time] Timestamp for this API request, useful for troubleshooting.
24
+ end
25
+ end
26
+ end
@@ -0,0 +1,102 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Straddle
4
+ module Models
5
+ class StatusDetailsV1 < Straddle::Internal::Type::BaseModel
6
+ # @!attribute changed_at
7
+ # The time the status change occurred.
8
+ #
9
+ # @return [Time]
10
+ required :changed_at, Time
11
+
12
+ # @!attribute message
13
+ # A human-readable description of the current status.
14
+ #
15
+ # @return [String]
16
+ required :message, String
17
+
18
+ # @!attribute reason
19
+ # A machine-readable identifier for the specific status, useful for programmatic
20
+ # handling.
21
+ #
22
+ # @return [Symbol, Straddle::Models::StatusDetailsV1::Reason]
23
+ required :reason, enum: -> { Straddle::StatusDetailsV1::Reason }
24
+
25
+ # @!attribute source
26
+ # Identifies the origin of the status change (e.g., `bank_decline`, `watchtower`).
27
+ # This helps in tracking the cause of status updates.
28
+ #
29
+ # @return [Symbol, Straddle::Models::StatusDetailsV1::Source]
30
+ required :source, enum: -> { Straddle::StatusDetailsV1::Source }
31
+
32
+ # @!attribute code
33
+ # The status code if applicable.
34
+ #
35
+ # @return [String, nil]
36
+ optional :code, String, nil?: true
37
+
38
+ # @!method initialize(changed_at:, message:, reason:, source:, code: nil)
39
+ # Some parameter documentations has been truncated, see
40
+ # {Straddle::Models::StatusDetailsV1} for more details.
41
+ #
42
+ # @param changed_at [Time] The time the status change occurred.
43
+ #
44
+ # @param message [String] A human-readable description of the current status.
45
+ #
46
+ # @param reason [Symbol, Straddle::Models::StatusDetailsV1::Reason] A machine-readable identifier for the specific status, useful for programmatic h
47
+ #
48
+ # @param source [Symbol, Straddle::Models::StatusDetailsV1::Source] Identifies the origin of the status change (e.g., `bank_decline`, `watchtower`).
49
+ #
50
+ # @param code [String, nil] The status code if applicable.
51
+
52
+ # A machine-readable identifier for the specific status, useful for programmatic
53
+ # handling.
54
+ #
55
+ # @see Straddle::Models::StatusDetailsV1#reason
56
+ module Reason
57
+ extend Straddle::Internal::Type::Enum
58
+
59
+ INSUFFICIENT_FUNDS = :insufficient_funds
60
+ CLOSED_BANK_ACCOUNT = :closed_bank_account
61
+ INVALID_BANK_ACCOUNT = :invalid_bank_account
62
+ INVALID_ROUTING = :invalid_routing
63
+ DISPUTED = :disputed
64
+ PAYMENT_STOPPED = :payment_stopped
65
+ OWNER_DECEASED = :owner_deceased
66
+ FROZEN_BANK_ACCOUNT = :frozen_bank_account
67
+ RISK_REVIEW = :risk_review
68
+ FRAUDULENT = :fraudulent
69
+ DUPLICATE_ENTRY = :duplicate_entry
70
+ INVALID_PAYKEY = :invalid_paykey
71
+ PAYMENT_BLOCKED = :payment_blocked
72
+ AMOUNT_TOO_LARGE = :amount_too_large
73
+ TOO_MANY_ATTEMPTS = :too_many_attempts
74
+ INTERNAL_SYSTEM_ERROR = :internal_system_error
75
+ USER_REQUEST = :user_request
76
+ OK = :ok
77
+ OTHER_NETWORK_RETURN = :other_network_return
78
+ PAYOUT_REFUSED = :payout_refused
79
+
80
+ # @!method self.values
81
+ # @return [Array<Symbol>]
82
+ end
83
+
84
+ # Identifies the origin of the status change (e.g., `bank_decline`, `watchtower`).
85
+ # This helps in tracking the cause of status updates.
86
+ #
87
+ # @see Straddle::Models::StatusDetailsV1#source
88
+ module Source
89
+ extend Straddle::Internal::Type::Enum
90
+
91
+ WATCHTOWER = :watchtower
92
+ BANK_DECLINE = :bank_decline
93
+ CUSTOMER_DISPUTE = :customer_dispute
94
+ USER_ACTION = :user_action
95
+ SYSTEM = :system
96
+
97
+ # @!method self.values
98
+ # @return [Array<Symbol>]
99
+ end
100
+ end
101
+ end
102
+ end