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,1091 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Straddle
4
+ module Models
5
+ module Customers
6
+ # @see Straddle::Resources::Customers::Review#get
7
+ class CustomerReviewV1 < Straddle::Internal::Type::BaseModel
8
+ # @!attribute data
9
+ #
10
+ # @return [Straddle::Models::Customers::CustomerReviewV1::Data]
11
+ required :data, -> { Straddle::Customers::CustomerReviewV1::Data }
12
+
13
+ # @!attribute meta
14
+ # Metadata about the API request, including an identifier and timestamp.
15
+ #
16
+ # @return [Straddle::Models::ResponseMetadata]
17
+ required :meta, -> { Straddle::ResponseMetadata }
18
+
19
+ # @!attribute response_type
20
+ # Indicates the structure of the returned content.
21
+ #
22
+ # - "object" means the `data` field contains a single JSON object.
23
+ # - "array" means the `data` field contains an array of objects.
24
+ # - "error" means the `data` field contains an error object with details of the
25
+ # issue.
26
+ # - "none" means no data is returned.
27
+ #
28
+ # @return [Symbol, Straddle::Models::Customers::CustomerReviewV1::ResponseType]
29
+ required :response_type, enum: -> { Straddle::Customers::CustomerReviewV1::ResponseType }
30
+
31
+ # @!method initialize(data:, meta:, response_type:)
32
+ # Some parameter documentations has been truncated, see
33
+ # {Straddle::Models::Customers::CustomerReviewV1} for more details.
34
+ #
35
+ # @param data [Straddle::Models::Customers::CustomerReviewV1::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::Customers::CustomerReviewV1::ResponseType] Indicates the structure of the returned content.
40
+
41
+ # @see Straddle::Models::Customers::CustomerReviewV1#data
42
+ class Data < Straddle::Internal::Type::BaseModel
43
+ # @!attribute customer_details
44
+ #
45
+ # @return [Straddle::Models::Customers::CustomerReviewV1::Data::CustomerDetails]
46
+ required :customer_details, -> { Straddle::Customers::CustomerReviewV1::Data::CustomerDetails }
47
+
48
+ # @!attribute identity_details
49
+ #
50
+ # @return [Straddle::Models::Customers::CustomerReviewV1::Data::IdentityDetails, nil]
51
+ optional :identity_details, -> { Straddle::Customers::CustomerReviewV1::Data::IdentityDetails }
52
+
53
+ # @!method initialize(customer_details:, identity_details: nil)
54
+ # @param customer_details [Straddle::Models::Customers::CustomerReviewV1::Data::CustomerDetails]
55
+ # @param identity_details [Straddle::Models::Customers::CustomerReviewV1::Data::IdentityDetails]
56
+
57
+ # @see Straddle::Models::Customers::CustomerReviewV1::Data#customer_details
58
+ class CustomerDetails < Straddle::Internal::Type::BaseModel
59
+ # @!attribute id
60
+ # Unique identifier for the customer.
61
+ #
62
+ # @return [String]
63
+ required :id, String
64
+
65
+ # @!attribute created_at
66
+ # Timestamp of when the customer record was created.
67
+ #
68
+ # @return [Time]
69
+ required :created_at, Time
70
+
71
+ # @!attribute email
72
+ # The customer's email address.
73
+ #
74
+ # @return [String]
75
+ required :email, String
76
+
77
+ # @!attribute name
78
+ # Full name of the individual or business name.
79
+ #
80
+ # @return [String]
81
+ required :name, String
82
+
83
+ # @!attribute phone
84
+ # The customer's phone number in E.164 format.
85
+ #
86
+ # @return [String]
87
+ required :phone, String
88
+
89
+ # @!attribute status
90
+ #
91
+ # @return [Symbol, Straddle::Models::Customers::CustomerReviewV1::Data::CustomerDetails::Status]
92
+ required :status,
93
+ enum: -> {
94
+ Straddle::Customers::CustomerReviewV1::Data::CustomerDetails::Status
95
+ }
96
+
97
+ # @!attribute type
98
+ #
99
+ # @return [Symbol, Straddle::Models::Customers::CustomerReviewV1::Data::CustomerDetails::Type]
100
+ required :type, enum: -> { Straddle::Customers::CustomerReviewV1::Data::CustomerDetails::Type }
101
+
102
+ # @!attribute updated_at
103
+ # Timestamp of the most recent update to the customer record.
104
+ #
105
+ # @return [Time]
106
+ required :updated_at, Time
107
+
108
+ # @!attribute address
109
+ # An object containing the customer's address. This is optional, but if provided,
110
+ # all required fields must be present.
111
+ #
112
+ # @return [Straddle::Models::CustomerAddressV1, nil]
113
+ optional :address, -> { Straddle::CustomerAddressV1 }, nil?: true
114
+
115
+ # @!attribute compliance_profile
116
+ # PII required to trigger Patriot Act compliant KYC verification.
117
+ #
118
+ # @return [Straddle::Models::Customers::CustomerReviewV1::Data::CustomerDetails::ComplianceProfile::IndividualComplianceProfile, Straddle::Models::Customers::CustomerReviewV1::Data::CustomerDetails::ComplianceProfile::BusinessComplianceProfile, nil]
119
+ optional :compliance_profile,
120
+ union: -> {
121
+ Straddle::Customers::CustomerReviewV1::Data::CustomerDetails::ComplianceProfile
122
+ },
123
+ nil?: true
124
+
125
+ # @!attribute config
126
+ #
127
+ # @return [Straddle::Models::Customers::CustomerReviewV1::Data::CustomerDetails::Config, nil]
128
+ optional :config, -> { Straddle::Customers::CustomerReviewV1::Data::CustomerDetails::Config }
129
+
130
+ # @!attribute device
131
+ #
132
+ # @return [Straddle::Models::Customers::CustomerReviewV1::Data::CustomerDetails::Device, nil]
133
+ optional :device, -> { Straddle::Customers::CustomerReviewV1::Data::CustomerDetails::Device }
134
+
135
+ # @!attribute external_id
136
+ # Unique identifier for the customer in your database, used for cross-referencing
137
+ # between Straddle and your systems.
138
+ #
139
+ # @return [String, nil]
140
+ optional :external_id, String, nil?: true
141
+
142
+ # @!attribute metadata
143
+ # Up to 20 additional user-defined key-value pairs. Useful for storing additional
144
+ # information about the customer in a structured format.
145
+ #
146
+ # @return [Hash{Symbol=>String}, nil]
147
+ optional :metadata, Straddle::Internal::Type::HashOf[String], nil?: true
148
+
149
+ # @!method initialize(id:, created_at:, email:, name:, phone:, status:, type:, updated_at:, address: nil, compliance_profile: nil, config: nil, device: nil, external_id: nil, metadata: nil)
150
+ # Some parameter documentations has been truncated, see
151
+ # {Straddle::Models::Customers::CustomerReviewV1::Data::CustomerDetails} for more
152
+ # details.
153
+ #
154
+ # @param id [String] Unique identifier for the customer.
155
+ #
156
+ # @param created_at [Time] Timestamp of when the customer record was created.
157
+ #
158
+ # @param email [String] The customer's email address.
159
+ #
160
+ # @param name [String] Full name of the individual or business name.
161
+ #
162
+ # @param phone [String] The customer's phone number in E.164 format.
163
+ #
164
+ # @param status [Symbol, Straddle::Models::Customers::CustomerReviewV1::Data::CustomerDetails::Status]
165
+ #
166
+ # @param type [Symbol, Straddle::Models::Customers::CustomerReviewV1::Data::CustomerDetails::Type]
167
+ #
168
+ # @param updated_at [Time] Timestamp of the most recent update to the customer record.
169
+ #
170
+ # @param address [Straddle::Models::CustomerAddressV1, nil] An object containing the customer's address. This is optional, but if provided,
171
+ #
172
+ # @param compliance_profile [Straddle::Models::Customers::CustomerReviewV1::Data::CustomerDetails::ComplianceProfile::IndividualComplianceProfile, Straddle::Models::Customers::CustomerReviewV1::Data::CustomerDetails::ComplianceProfile::BusinessComplianceProfile, nil] PII required to trigger Patriot Act compliant KYC verification.
173
+ #
174
+ # @param config [Straddle::Models::Customers::CustomerReviewV1::Data::CustomerDetails::Config]
175
+ #
176
+ # @param device [Straddle::Models::Customers::CustomerReviewV1::Data::CustomerDetails::Device]
177
+ #
178
+ # @param external_id [String, nil] Unique identifier for the customer in your database, used for cross-referencing
179
+ #
180
+ # @param metadata [Hash{Symbol=>String}, nil] Up to 20 additional user-defined key-value pairs. Useful for storing additional
181
+
182
+ # @see Straddle::Models::Customers::CustomerReviewV1::Data::CustomerDetails#status
183
+ module Status
184
+ extend Straddle::Internal::Type::Enum
185
+
186
+ PENDING = :pending
187
+ REVIEW = :review
188
+ VERIFIED = :verified
189
+ INACTIVE = :inactive
190
+ REJECTED = :rejected
191
+
192
+ # @!method self.values
193
+ # @return [Array<Symbol>]
194
+ end
195
+
196
+ # @see Straddle::Models::Customers::CustomerReviewV1::Data::CustomerDetails#type
197
+ module Type
198
+ extend Straddle::Internal::Type::Enum
199
+
200
+ INDIVIDUAL = :individual
201
+ BUSINESS = :business
202
+ UNKNOWN = :unknown
203
+
204
+ # @!method self.values
205
+ # @return [Array<Symbol>]
206
+ end
207
+
208
+ # PII required to trigger Patriot Act compliant KYC verification.
209
+ #
210
+ # @see Straddle::Models::Customers::CustomerReviewV1::Data::CustomerDetails#compliance_profile
211
+ module ComplianceProfile
212
+ extend Straddle::Internal::Type::Union
213
+
214
+ # PII required to trigger Patriot Act compliant KYC verification.
215
+ variant -> {
216
+ Straddle::Customers::CustomerReviewV1::Data::CustomerDetails::ComplianceProfile::IndividualComplianceProfile
217
+ }
218
+
219
+ # Business registration data required to trigger Patriot Act compliant KYB verification.
220
+ variant -> {
221
+ Straddle::Customers::CustomerReviewV1::Data::CustomerDetails::ComplianceProfile::BusinessComplianceProfile
222
+ }
223
+
224
+ class IndividualComplianceProfile < Straddle::Internal::Type::BaseModel
225
+ # @!attribute dob
226
+ # Masked date of birth in \***\*-**-\*\* format.
227
+ #
228
+ # @return [Date, nil]
229
+ required :dob, Date, nil?: true
230
+
231
+ # @!attribute ssn
232
+ # Masked Social Security Number in the format **\*-**-\*\*\*\*.
233
+ #
234
+ # @return [String, nil]
235
+ required :ssn, String, nil?: true
236
+
237
+ # @!method initialize(dob:, ssn:)
238
+ # PII required to trigger Patriot Act compliant KYC verification.
239
+ #
240
+ # @param dob [Date, nil] Masked date of birth in \***\*-**-\*\* format.
241
+ #
242
+ # @param ssn [String, nil] Masked Social Security Number in the format **\*-**-\*\*\*\*.
243
+ end
244
+
245
+ class BusinessComplianceProfile < Straddle::Internal::Type::BaseModel
246
+ # @!attribute ein
247
+ # Masked Employer Identification Number in the format **-**\*****
248
+ #
249
+ # @return [String, nil]
250
+ required :ein, String, nil?: true
251
+
252
+ # @!attribute legal_business_name
253
+ # The official registered name of the business. This name should be correlated
254
+ # with the `ein` value.
255
+ #
256
+ # @return [String, nil]
257
+ required :legal_business_name, String, nil?: true
258
+
259
+ # @!attribute representatives
260
+ # A list of people related to the company. Only valid where customer type is
261
+ # 'business'.
262
+ #
263
+ # @return [Array<Straddle::Models::Customers::CustomerReviewV1::Data::CustomerDetails::ComplianceProfile::BusinessComplianceProfile::Representative>, nil]
264
+ optional :representatives,
265
+ -> do
266
+ Straddle::Internal::Type::ArrayOf[
267
+ Straddle::Customers::CustomerReviewV1::Data::CustomerDetails::ComplianceProfile::BusinessComplianceProfile::Representative
268
+ ]
269
+ end,
270
+ nil?: true
271
+
272
+ # @!attribute website
273
+ # Official business website URL. Optional but recommended for enhanced KYB.
274
+ #
275
+ # @return [String, nil]
276
+ optional :website, String, nil?: true
277
+
278
+ # @!method initialize(ein:, legal_business_name:, representatives: nil, website: nil)
279
+ # Some parameter documentations has been truncated, see
280
+ # {Straddle::Models::Customers::CustomerReviewV1::Data::CustomerDetails::ComplianceProfile::BusinessComplianceProfile}
281
+ # for more details.
282
+ #
283
+ # Business registration data required to trigger Patriot Act compliant KYB
284
+ # verification.
285
+ #
286
+ # @param ein [String, nil] Masked Employer Identification Number in the format **-**\*****
287
+ #
288
+ # @param legal_business_name [String, nil] The official registered name of the business. This name should be correlated wit
289
+ #
290
+ # @param representatives [Array<Straddle::Models::Customers::CustomerReviewV1::Data::CustomerDetails::ComplianceProfile::BusinessComplianceProfile::Representative>, nil] A list of people related to the company. Only valid where customer type is 'busi
291
+ #
292
+ # @param website [String, nil] Official business website URL. Optional but recommended for enhanced KYB.
293
+
294
+ class Representative < Straddle::Internal::Type::BaseModel
295
+ # @!attribute name
296
+ #
297
+ # @return [String]
298
+ required :name, String
299
+
300
+ # @!attribute email
301
+ #
302
+ # @return [String, nil]
303
+ optional :email, String, nil?: true
304
+
305
+ # @!attribute phone
306
+ #
307
+ # @return [String, nil]
308
+ optional :phone, String, nil?: true
309
+
310
+ # @!method initialize(name:, email: nil, phone: nil)
311
+ # @param name [String]
312
+ # @param email [String, nil]
313
+ # @param phone [String, nil]
314
+ end
315
+ end
316
+
317
+ # @!method self.variants
318
+ # @return [Array(Straddle::Models::Customers::CustomerReviewV1::Data::CustomerDetails::ComplianceProfile::IndividualComplianceProfile, Straddle::Models::Customers::CustomerReviewV1::Data::CustomerDetails::ComplianceProfile::BusinessComplianceProfile)]
319
+ end
320
+
321
+ # @see Straddle::Models::Customers::CustomerReviewV1::Data::CustomerDetails#config
322
+ class Config < Straddle::Internal::Type::BaseModel
323
+ # @!attribute processing_method
324
+ #
325
+ # @return [Symbol, Straddle::Models::Customers::CustomerReviewV1::Data::CustomerDetails::Config::ProcessingMethod, nil]
326
+ optional :processing_method,
327
+ enum: -> {
328
+ Straddle::Customers::CustomerReviewV1::Data::CustomerDetails::Config::ProcessingMethod
329
+ }
330
+
331
+ # @!attribute sandbox_outcome
332
+ #
333
+ # @return [Symbol, Straddle::Models::Customers::CustomerReviewV1::Data::CustomerDetails::Config::SandboxOutcome, nil]
334
+ optional :sandbox_outcome,
335
+ enum: -> {
336
+ Straddle::Customers::CustomerReviewV1::Data::CustomerDetails::Config::SandboxOutcome
337
+ }
338
+
339
+ # @!method initialize(processing_method: nil, sandbox_outcome: nil)
340
+ # @param processing_method [Symbol, Straddle::Models::Customers::CustomerReviewV1::Data::CustomerDetails::Config::ProcessingMethod]
341
+ # @param sandbox_outcome [Symbol, Straddle::Models::Customers::CustomerReviewV1::Data::CustomerDetails::Config::SandboxOutcome]
342
+
343
+ # @see Straddle::Models::Customers::CustomerReviewV1::Data::CustomerDetails::Config#processing_method
344
+ module ProcessingMethod
345
+ extend Straddle::Internal::Type::Enum
346
+
347
+ INLINE = :inline
348
+ BACKGROUND = :background
349
+ SKIP = :skip
350
+
351
+ # @!method self.values
352
+ # @return [Array<Symbol>]
353
+ end
354
+
355
+ # @see Straddle::Models::Customers::CustomerReviewV1::Data::CustomerDetails::Config#sandbox_outcome
356
+ module SandboxOutcome
357
+ extend Straddle::Internal::Type::Enum
358
+
359
+ STANDARD = :standard
360
+ VERIFIED = :verified
361
+ REJECTED = :rejected
362
+ REVIEW = :review
363
+
364
+ # @!method self.values
365
+ # @return [Array<Symbol>]
366
+ end
367
+ end
368
+
369
+ # @see Straddle::Models::Customers::CustomerReviewV1::Data::CustomerDetails#device
370
+ class Device < Straddle::Internal::Type::BaseModel
371
+ # @!attribute ip_address
372
+ # The customer's IP address at the time of profile creation. Use `0.0.0.0` to
373
+ # represent an offline customer registration.
374
+ #
375
+ # @return [String]
376
+ required :ip_address, String
377
+
378
+ # @!method initialize(ip_address:)
379
+ # Some parameter documentations has been truncated, see
380
+ # {Straddle::Models::Customers::CustomerReviewV1::Data::CustomerDetails::Device}
381
+ # for more details.
382
+ #
383
+ # @param ip_address [String] The customer's IP address at the time of profile creation. Use `0.0.0.0` to repr
384
+ end
385
+ end
386
+
387
+ # @see Straddle::Models::Customers::CustomerReviewV1::Data#identity_details
388
+ class IdentityDetails < Straddle::Internal::Type::BaseModel
389
+ # @!attribute breakdown
390
+ # Detailed breakdown of the customer verification results, including decisions,
391
+ # risk scores, correlation score, and more.
392
+ #
393
+ # @return [Straddle::Models::Customers::CustomerReviewV1::Data::IdentityDetails::Breakdown]
394
+ required :breakdown,
395
+ -> {
396
+ Straddle::Customers::CustomerReviewV1::Data::IdentityDetails::Breakdown
397
+ }
398
+
399
+ # @!attribute created_at
400
+ # Timestamp of when the review was initiated.
401
+ #
402
+ # @return [Time]
403
+ required :created_at, Time
404
+
405
+ # @!attribute decision
406
+ #
407
+ # @return [Symbol, Straddle::Models::Customers::CustomerReviewV1::Data::IdentityDetails::Decision]
408
+ required :decision,
409
+ enum: -> {
410
+ Straddle::Customers::CustomerReviewV1::Data::IdentityDetails::Decision
411
+ }
412
+
413
+ # @!attribute review_id
414
+ # Unique identifier for the review.
415
+ #
416
+ # @return [String]
417
+ required :review_id, String
418
+
419
+ # @!attribute updated_at
420
+ # Timestamp of the most recent update to the review.
421
+ #
422
+ # @return [Time]
423
+ required :updated_at, Time
424
+
425
+ # @!attribute kyc
426
+ #
427
+ # @return [Straddle::Models::Customers::CustomerReviewV1::Data::IdentityDetails::KYC, nil]
428
+ optional :kyc, -> { Straddle::Customers::CustomerReviewV1::Data::IdentityDetails::KYC }
429
+
430
+ # @!attribute messages
431
+ # Dictionary of all messages from the customer verification process.
432
+ #
433
+ # @return [Hash{Symbol=>String}, nil]
434
+ optional :messages, Straddle::Internal::Type::HashOf[String], nil?: true
435
+
436
+ # @!attribute network_alerts
437
+ #
438
+ # @return [Straddle::Models::Customers::CustomerReviewV1::Data::IdentityDetails::NetworkAlerts, nil]
439
+ optional :network_alerts,
440
+ -> { Straddle::Customers::CustomerReviewV1::Data::IdentityDetails::NetworkAlerts }
441
+
442
+ # @!attribute reputation
443
+ #
444
+ # @return [Straddle::Models::Customers::CustomerReviewV1::Data::IdentityDetails::Reputation, nil]
445
+ optional :reputation,
446
+ -> {
447
+ Straddle::Customers::CustomerReviewV1::Data::IdentityDetails::Reputation
448
+ }
449
+
450
+ # @!attribute watch_list
451
+ #
452
+ # @return [Straddle::Models::Customers::CustomerReviewV1::Data::IdentityDetails::WatchList, nil]
453
+ optional :watch_list,
454
+ -> {
455
+ Straddle::Customers::CustomerReviewV1::Data::IdentityDetails::WatchList
456
+ }
457
+
458
+ # @!method initialize(breakdown:, created_at:, decision:, review_id:, updated_at:, kyc: nil, messages: nil, network_alerts: nil, reputation: nil, watch_list: nil)
459
+ # Some parameter documentations has been truncated, see
460
+ # {Straddle::Models::Customers::CustomerReviewV1::Data::IdentityDetails} for more
461
+ # details.
462
+ #
463
+ # @param breakdown [Straddle::Models::Customers::CustomerReviewV1::Data::IdentityDetails::Breakdown] Detailed breakdown of the customer verification results, including decisions, ri
464
+ #
465
+ # @param created_at [Time] Timestamp of when the review was initiated.
466
+ #
467
+ # @param decision [Symbol, Straddle::Models::Customers::CustomerReviewV1::Data::IdentityDetails::Decision]
468
+ #
469
+ # @param review_id [String] Unique identifier for the review.
470
+ #
471
+ # @param updated_at [Time] Timestamp of the most recent update to the review.
472
+ #
473
+ # @param kyc [Straddle::Models::Customers::CustomerReviewV1::Data::IdentityDetails::KYC]
474
+ #
475
+ # @param messages [Hash{Symbol=>String}, nil] Dictionary of all messages from the customer verification process.
476
+ #
477
+ # @param network_alerts [Straddle::Models::Customers::CustomerReviewV1::Data::IdentityDetails::NetworkAlerts]
478
+ #
479
+ # @param reputation [Straddle::Models::Customers::CustomerReviewV1::Data::IdentityDetails::Reputation]
480
+ #
481
+ # @param watch_list [Straddle::Models::Customers::CustomerReviewV1::Data::IdentityDetails::WatchList]
482
+
483
+ # @see Straddle::Models::Customers::CustomerReviewV1::Data::IdentityDetails#breakdown
484
+ class Breakdown < Straddle::Internal::Type::BaseModel
485
+ # @!attribute address
486
+ #
487
+ # @return [Straddle::Models::Customers::IdentityVerificationBreakdownV1, nil]
488
+ optional :address, -> { Straddle::Customers::IdentityVerificationBreakdownV1 }
489
+
490
+ # @!attribute business_evaluation
491
+ #
492
+ # @return [Straddle::Models::Customers::IdentityVerificationBreakdownV1, nil]
493
+ optional :business_evaluation, -> { Straddle::Customers::IdentityVerificationBreakdownV1 }
494
+
495
+ # @!attribute business_identification
496
+ #
497
+ # @return [Straddle::Models::Customers::IdentityVerificationBreakdownV1, nil]
498
+ optional :business_identification, -> { Straddle::Customers::IdentityVerificationBreakdownV1 }
499
+
500
+ # @!attribute business_validation
501
+ #
502
+ # @return [Straddle::Models::Customers::IdentityVerificationBreakdownV1, nil]
503
+ optional :business_validation, -> { Straddle::Customers::IdentityVerificationBreakdownV1 }
504
+
505
+ # @!attribute email
506
+ #
507
+ # @return [Straddle::Models::Customers::IdentityVerificationBreakdownV1, nil]
508
+ optional :email, -> { Straddle::Customers::IdentityVerificationBreakdownV1 }
509
+
510
+ # @!attribute fraud
511
+ #
512
+ # @return [Straddle::Models::Customers::IdentityVerificationBreakdownV1, nil]
513
+ optional :fraud, -> { Straddle::Customers::IdentityVerificationBreakdownV1 }
514
+
515
+ # @!attribute phone
516
+ #
517
+ # @return [Straddle::Models::Customers::IdentityVerificationBreakdownV1, nil]
518
+ optional :phone, -> { Straddle::Customers::IdentityVerificationBreakdownV1 }
519
+
520
+ # @!attribute synthetic
521
+ #
522
+ # @return [Straddle::Models::Customers::IdentityVerificationBreakdownV1, nil]
523
+ optional :synthetic, -> { Straddle::Customers::IdentityVerificationBreakdownV1 }
524
+
525
+ # @!method initialize(address: nil, business_evaluation: nil, business_identification: nil, business_validation: nil, email: nil, fraud: nil, phone: nil, synthetic: nil)
526
+ # Detailed breakdown of the customer verification results, including decisions,
527
+ # risk scores, correlation score, and more.
528
+ #
529
+ # @param address [Straddle::Models::Customers::IdentityVerificationBreakdownV1]
530
+ # @param business_evaluation [Straddle::Models::Customers::IdentityVerificationBreakdownV1]
531
+ # @param business_identification [Straddle::Models::Customers::IdentityVerificationBreakdownV1]
532
+ # @param business_validation [Straddle::Models::Customers::IdentityVerificationBreakdownV1]
533
+ # @param email [Straddle::Models::Customers::IdentityVerificationBreakdownV1]
534
+ # @param fraud [Straddle::Models::Customers::IdentityVerificationBreakdownV1]
535
+ # @param phone [Straddle::Models::Customers::IdentityVerificationBreakdownV1]
536
+ # @param synthetic [Straddle::Models::Customers::IdentityVerificationBreakdownV1]
537
+ end
538
+
539
+ # @see Straddle::Models::Customers::CustomerReviewV1::Data::IdentityDetails#decision
540
+ module Decision
541
+ extend Straddle::Internal::Type::Enum
542
+
543
+ ACCEPT = :accept
544
+ REJECT = :reject
545
+ REVIEW = :review
546
+
547
+ # @!method self.values
548
+ # @return [Array<Symbol>]
549
+ end
550
+
551
+ # @see Straddle::Models::Customers::CustomerReviewV1::Data::IdentityDetails#kyc
552
+ class KYC < Straddle::Internal::Type::BaseModel
553
+ # @!attribute validations
554
+ # Boolean values indicating the result of each validation in the KYC process.
555
+ #
556
+ # @return [Straddle::Models::Customers::CustomerReviewV1::Data::IdentityDetails::KYC::Validations]
557
+ required :validations,
558
+ -> { Straddle::Customers::CustomerReviewV1::Data::IdentityDetails::KYC::Validations }
559
+
560
+ # @!attribute codes
561
+ # List of specific result codes from the KYC screening process.
562
+ #
563
+ # @return [Array<String>, nil]
564
+ optional :codes, Straddle::Internal::Type::ArrayOf[String], nil?: true
565
+
566
+ # @!attribute decision
567
+ #
568
+ # @return [Symbol, Straddle::Models::Customers::CustomerReviewV1::Data::IdentityDetails::KYC::Decision, nil]
569
+ optional :decision,
570
+ enum: -> {
571
+ Straddle::Customers::CustomerReviewV1::Data::IdentityDetails::KYC::Decision
572
+ }
573
+
574
+ # @!method initialize(validations:, codes: nil, decision: nil)
575
+ # @param validations [Straddle::Models::Customers::CustomerReviewV1::Data::IdentityDetails::KYC::Validations] Boolean values indicating the result of each validation in the KYC process.
576
+ #
577
+ # @param codes [Array<String>, nil] List of specific result codes from the KYC screening process.
578
+ #
579
+ # @param decision [Symbol, Straddle::Models::Customers::CustomerReviewV1::Data::IdentityDetails::KYC::Decision]
580
+
581
+ # @see Straddle::Models::Customers::CustomerReviewV1::Data::IdentityDetails::KYC#validations
582
+ class Validations < Straddle::Internal::Type::BaseModel
583
+ # @!attribute address
584
+ #
585
+ # @return [Boolean, nil]
586
+ optional :address, Straddle::Internal::Type::Boolean
587
+
588
+ # @!attribute city
589
+ #
590
+ # @return [Boolean, nil]
591
+ optional :city, Straddle::Internal::Type::Boolean
592
+
593
+ # @!attribute dob
594
+ #
595
+ # @return [Boolean, nil]
596
+ optional :dob, Straddle::Internal::Type::Boolean
597
+
598
+ # @!attribute email
599
+ #
600
+ # @return [Boolean, nil]
601
+ optional :email, Straddle::Internal::Type::Boolean
602
+
603
+ # @!attribute first_name
604
+ #
605
+ # @return [Boolean, nil]
606
+ optional :first_name, Straddle::Internal::Type::Boolean
607
+
608
+ # @!attribute last_name
609
+ #
610
+ # @return [Boolean, nil]
611
+ optional :last_name, Straddle::Internal::Type::Boolean
612
+
613
+ # @!attribute phone
614
+ #
615
+ # @return [Boolean, nil]
616
+ optional :phone, Straddle::Internal::Type::Boolean
617
+
618
+ # @!attribute ssn
619
+ #
620
+ # @return [Boolean, nil]
621
+ optional :ssn, Straddle::Internal::Type::Boolean
622
+
623
+ # @!attribute state
624
+ #
625
+ # @return [Boolean, nil]
626
+ optional :state, Straddle::Internal::Type::Boolean
627
+
628
+ # @!attribute zip
629
+ #
630
+ # @return [Boolean, nil]
631
+ optional :zip, Straddle::Internal::Type::Boolean
632
+
633
+ # @!method initialize(address: nil, city: nil, dob: nil, email: nil, first_name: nil, last_name: nil, phone: nil, ssn: nil, state: nil, zip: nil)
634
+ # Boolean values indicating the result of each validation in the KYC process.
635
+ #
636
+ # @param address [Boolean]
637
+ # @param city [Boolean]
638
+ # @param dob [Boolean]
639
+ # @param email [Boolean]
640
+ # @param first_name [Boolean]
641
+ # @param last_name [Boolean]
642
+ # @param phone [Boolean]
643
+ # @param ssn [Boolean]
644
+ # @param state [Boolean]
645
+ # @param zip [Boolean]
646
+ end
647
+
648
+ # @see Straddle::Models::Customers::CustomerReviewV1::Data::IdentityDetails::KYC#decision
649
+ module Decision
650
+ extend Straddle::Internal::Type::Enum
651
+
652
+ ACCEPT = :accept
653
+ REJECT = :reject
654
+ REVIEW = :review
655
+
656
+ # @!method self.values
657
+ # @return [Array<Symbol>]
658
+ end
659
+ end
660
+
661
+ # @see Straddle::Models::Customers::CustomerReviewV1::Data::IdentityDetails#network_alerts
662
+ class NetworkAlerts < Straddle::Internal::Type::BaseModel
663
+ # @!attribute alerts
664
+ # Any alerts or flags raised during the consortium alert screening.
665
+ #
666
+ # @return [Array<String>, nil]
667
+ optional :alerts, Straddle::Internal::Type::ArrayOf[String], nil?: true
668
+
669
+ # @!attribute codes
670
+ # List of specific result codes from the consortium alert screening.
671
+ #
672
+ # @return [Array<String>, nil]
673
+ optional :codes, Straddle::Internal::Type::ArrayOf[String], nil?: true
674
+
675
+ # @!attribute decision
676
+ #
677
+ # @return [Symbol, Straddle::Models::Customers::CustomerReviewV1::Data::IdentityDetails::NetworkAlerts::Decision, nil]
678
+ optional :decision,
679
+ enum: -> {
680
+ Straddle::Customers::CustomerReviewV1::Data::IdentityDetails::NetworkAlerts::Decision
681
+ }
682
+
683
+ # @!method initialize(alerts: nil, codes: nil, decision: nil)
684
+ # @param alerts [Array<String>, nil] Any alerts or flags raised during the consortium alert screening.
685
+ #
686
+ # @param codes [Array<String>, nil] List of specific result codes from the consortium alert screening.
687
+ #
688
+ # @param decision [Symbol, Straddle::Models::Customers::CustomerReviewV1::Data::IdentityDetails::NetworkAlerts::Decision]
689
+
690
+ # @see Straddle::Models::Customers::CustomerReviewV1::Data::IdentityDetails::NetworkAlerts#decision
691
+ module Decision
692
+ extend Straddle::Internal::Type::Enum
693
+
694
+ ACCEPT = :accept
695
+ REJECT = :reject
696
+ REVIEW = :review
697
+
698
+ # @!method self.values
699
+ # @return [Array<Symbol>]
700
+ end
701
+ end
702
+
703
+ # @see Straddle::Models::Customers::CustomerReviewV1::Data::IdentityDetails#reputation
704
+ class Reputation < Straddle::Internal::Type::BaseModel
705
+ # @!attribute codes
706
+ # Specific codes related to the Straddle reputation screening results.
707
+ #
708
+ # @return [Array<String>, nil]
709
+ optional :codes, Straddle::Internal::Type::ArrayOf[String], nil?: true
710
+
711
+ # @!attribute decision
712
+ #
713
+ # @return [Symbol, Straddle::Models::Customers::CustomerReviewV1::Data::IdentityDetails::Reputation::Decision, nil]
714
+ optional :decision,
715
+ enum: -> {
716
+ Straddle::Customers::CustomerReviewV1::Data::IdentityDetails::Reputation::Decision
717
+ }
718
+
719
+ # @!attribute insights
720
+ #
721
+ # @return [Straddle::Models::Customers::CustomerReviewV1::Data::IdentityDetails::Reputation::Insights, nil]
722
+ optional :insights,
723
+ -> {
724
+ Straddle::Customers::CustomerReviewV1::Data::IdentityDetails::Reputation::Insights
725
+ }
726
+
727
+ # @!attribute risk_score
728
+ #
729
+ # @return [Float, nil]
730
+ optional :risk_score, Float, nil?: true
731
+
732
+ # @!method initialize(codes: nil, decision: nil, insights: nil, risk_score: nil)
733
+ # @param codes [Array<String>, nil] Specific codes related to the Straddle reputation screening results.
734
+ #
735
+ # @param decision [Symbol, Straddle::Models::Customers::CustomerReviewV1::Data::IdentityDetails::Reputation::Decision]
736
+ #
737
+ # @param insights [Straddle::Models::Customers::CustomerReviewV1::Data::IdentityDetails::Reputation::Insights]
738
+ #
739
+ # @param risk_score [Float, nil]
740
+
741
+ # @see Straddle::Models::Customers::CustomerReviewV1::Data::IdentityDetails::Reputation#decision
742
+ module Decision
743
+ extend Straddle::Internal::Type::Enum
744
+
745
+ ACCEPT = :accept
746
+ REJECT = :reject
747
+ REVIEW = :review
748
+
749
+ # @!method self.values
750
+ # @return [Array<Symbol>]
751
+ end
752
+
753
+ # @see Straddle::Models::Customers::CustomerReviewV1::Data::IdentityDetails::Reputation#insights
754
+ class Insights < Straddle::Internal::Type::BaseModel
755
+ # @!attribute accounts_active_count
756
+ #
757
+ # @return [Integer, nil]
758
+ optional :accounts_active_count, Integer, nil?: true
759
+
760
+ # @!attribute accounts_closed_count
761
+ #
762
+ # @return [Integer, nil]
763
+ optional :accounts_closed_count, Integer, nil?: true
764
+
765
+ # @!attribute accounts_closed_dates
766
+ #
767
+ # @return [Array<Date>, nil]
768
+ optional :accounts_closed_dates, Straddle::Internal::Type::ArrayOf[Date], nil?: true
769
+
770
+ # @!attribute accounts_count
771
+ #
772
+ # @return [Integer, nil]
773
+ optional :accounts_count, Integer, nil?: true
774
+
775
+ # @!attribute accounts_fraud_count
776
+ #
777
+ # @return [Integer, nil]
778
+ optional :accounts_fraud_count, Integer, nil?: true
779
+
780
+ # @!attribute accounts_fraud_labeled_dates
781
+ #
782
+ # @return [Array<Date>, nil]
783
+ optional :accounts_fraud_labeled_dates, Straddle::Internal::Type::ArrayOf[Date], nil?: true
784
+
785
+ # @!attribute accounts_fraud_loss_total_amount
786
+ #
787
+ # @return [Float, nil]
788
+ optional :accounts_fraud_loss_total_amount, Float, nil?: true
789
+
790
+ # @!attribute ach_fraud_transactions_count
791
+ #
792
+ # @return [Integer, nil]
793
+ optional :ach_fraud_transactions_count, Integer, nil?: true
794
+
795
+ # @!attribute ach_fraud_transactions_dates
796
+ #
797
+ # @return [Array<Date>, nil]
798
+ optional :ach_fraud_transactions_dates, Straddle::Internal::Type::ArrayOf[Date], nil?: true
799
+
800
+ # @!attribute ach_fraud_transactions_total_amount
801
+ #
802
+ # @return [Float, nil]
803
+ optional :ach_fraud_transactions_total_amount, Float, nil?: true
804
+
805
+ # @!attribute ach_returned_transactions_count
806
+ #
807
+ # @return [Integer, nil]
808
+ optional :ach_returned_transactions_count, Integer, nil?: true
809
+
810
+ # @!attribute ach_returned_transactions_dates
811
+ #
812
+ # @return [Array<Date>, nil]
813
+ optional :ach_returned_transactions_dates, Straddle::Internal::Type::ArrayOf[Date], nil?: true
814
+
815
+ # @!attribute ach_returned_transactions_total_amount
816
+ #
817
+ # @return [Float, nil]
818
+ optional :ach_returned_transactions_total_amount, Float, nil?: true
819
+
820
+ # @!attribute applications_approved_count
821
+ #
822
+ # @return [Integer, nil]
823
+ optional :applications_approved_count, Integer, nil?: true
824
+
825
+ # @!attribute applications_count
826
+ #
827
+ # @return [Integer, nil]
828
+ optional :applications_count, Integer, nil?: true
829
+
830
+ # @!attribute applications_dates
831
+ #
832
+ # @return [Array<Date>, nil]
833
+ optional :applications_dates, Straddle::Internal::Type::ArrayOf[Date], nil?: true
834
+
835
+ # @!attribute applications_declined_count
836
+ #
837
+ # @return [Integer, nil]
838
+ optional :applications_declined_count, Integer, nil?: true
839
+
840
+ # @!attribute applications_fraud_count
841
+ #
842
+ # @return [Integer, nil]
843
+ optional :applications_fraud_count, Integer, nil?: true
844
+
845
+ # @!attribute card_disputed_transactions_count
846
+ #
847
+ # @return [Integer, nil]
848
+ optional :card_disputed_transactions_count, Integer, nil?: true
849
+
850
+ # @!attribute card_disputed_transactions_dates
851
+ #
852
+ # @return [Array<Date>, nil]
853
+ optional :card_disputed_transactions_dates,
854
+ Straddle::Internal::Type::ArrayOf[Date],
855
+ nil?: true
856
+
857
+ # @!attribute card_disputed_transactions_total_amount
858
+ #
859
+ # @return [Float, nil]
860
+ optional :card_disputed_transactions_total_amount, Float, nil?: true
861
+
862
+ # @!attribute card_fraud_transactions_count
863
+ #
864
+ # @return [Integer, nil]
865
+ optional :card_fraud_transactions_count, Integer, nil?: true
866
+
867
+ # @!attribute card_fraud_transactions_dates
868
+ #
869
+ # @return [Array<Date>, nil]
870
+ optional :card_fraud_transactions_dates, Straddle::Internal::Type::ArrayOf[Date], nil?: true
871
+
872
+ # @!attribute card_fraud_transactions_total_amount
873
+ #
874
+ # @return [Float, nil]
875
+ optional :card_fraud_transactions_total_amount, Float, nil?: true
876
+
877
+ # @!attribute card_stopped_transactions_count
878
+ #
879
+ # @return [Integer, nil]
880
+ optional :card_stopped_transactions_count, Integer, nil?: true
881
+
882
+ # @!attribute card_stopped_transactions_dates
883
+ #
884
+ # @return [Array<Date>, nil]
885
+ optional :card_stopped_transactions_dates, Straddle::Internal::Type::ArrayOf[Date], nil?: true
886
+
887
+ # @!attribute user_active_profile_count
888
+ #
889
+ # @return [Integer, nil]
890
+ optional :user_active_profile_count, Integer, nil?: true
891
+
892
+ # @!attribute user_address_count
893
+ #
894
+ # @return [Integer, nil]
895
+ optional :user_address_count, Integer, nil?: true
896
+
897
+ # @!attribute user_closed_profile_count
898
+ #
899
+ # @return [Integer, nil]
900
+ optional :user_closed_profile_count, Integer, nil?: true
901
+
902
+ # @!attribute user_dob_count
903
+ #
904
+ # @return [Integer, nil]
905
+ optional :user_dob_count, Integer, nil?: true
906
+
907
+ # @!attribute user_email_count
908
+ #
909
+ # @return [Integer, nil]
910
+ optional :user_email_count, Integer, nil?: true
911
+
912
+ # @!attribute user_institution_count
913
+ #
914
+ # @return [Integer, nil]
915
+ optional :user_institution_count, Integer, nil?: true
916
+
917
+ # @!attribute user_mobile_count
918
+ #
919
+ # @return [Integer, nil]
920
+ optional :user_mobile_count, Integer, nil?: true
921
+
922
+ # @!method initialize(accounts_active_count: nil, accounts_closed_count: nil, accounts_closed_dates: nil, accounts_count: nil, accounts_fraud_count: nil, accounts_fraud_labeled_dates: nil, accounts_fraud_loss_total_amount: nil, ach_fraud_transactions_count: nil, ach_fraud_transactions_dates: nil, ach_fraud_transactions_total_amount: nil, ach_returned_transactions_count: nil, ach_returned_transactions_dates: nil, ach_returned_transactions_total_amount: nil, applications_approved_count: nil, applications_count: nil, applications_dates: nil, applications_declined_count: nil, applications_fraud_count: nil, card_disputed_transactions_count: nil, card_disputed_transactions_dates: nil, card_disputed_transactions_total_amount: nil, card_fraud_transactions_count: nil, card_fraud_transactions_dates: nil, card_fraud_transactions_total_amount: nil, card_stopped_transactions_count: nil, card_stopped_transactions_dates: nil, user_active_profile_count: nil, user_address_count: nil, user_closed_profile_count: nil, user_dob_count: nil, user_email_count: nil, user_institution_count: nil, user_mobile_count: nil)
923
+ # @param accounts_active_count [Integer, nil]
924
+ # @param accounts_closed_count [Integer, nil]
925
+ # @param accounts_closed_dates [Array<Date>, nil]
926
+ # @param accounts_count [Integer, nil]
927
+ # @param accounts_fraud_count [Integer, nil]
928
+ # @param accounts_fraud_labeled_dates [Array<Date>, nil]
929
+ # @param accounts_fraud_loss_total_amount [Float, nil]
930
+ # @param ach_fraud_transactions_count [Integer, nil]
931
+ # @param ach_fraud_transactions_dates [Array<Date>, nil]
932
+ # @param ach_fraud_transactions_total_amount [Float, nil]
933
+ # @param ach_returned_transactions_count [Integer, nil]
934
+ # @param ach_returned_transactions_dates [Array<Date>, nil]
935
+ # @param ach_returned_transactions_total_amount [Float, nil]
936
+ # @param applications_approved_count [Integer, nil]
937
+ # @param applications_count [Integer, nil]
938
+ # @param applications_dates [Array<Date>, nil]
939
+ # @param applications_declined_count [Integer, nil]
940
+ # @param applications_fraud_count [Integer, nil]
941
+ # @param card_disputed_transactions_count [Integer, nil]
942
+ # @param card_disputed_transactions_dates [Array<Date>, nil]
943
+ # @param card_disputed_transactions_total_amount [Float, nil]
944
+ # @param card_fraud_transactions_count [Integer, nil]
945
+ # @param card_fraud_transactions_dates [Array<Date>, nil]
946
+ # @param card_fraud_transactions_total_amount [Float, nil]
947
+ # @param card_stopped_transactions_count [Integer, nil]
948
+ # @param card_stopped_transactions_dates [Array<Date>, nil]
949
+ # @param user_active_profile_count [Integer, nil]
950
+ # @param user_address_count [Integer, nil]
951
+ # @param user_closed_profile_count [Integer, nil]
952
+ # @param user_dob_count [Integer, nil]
953
+ # @param user_email_count [Integer, nil]
954
+ # @param user_institution_count [Integer, nil]
955
+ # @param user_mobile_count [Integer, nil]
956
+ end
957
+ end
958
+
959
+ # @see Straddle::Models::Customers::CustomerReviewV1::Data::IdentityDetails#watch_list
960
+ class WatchList < Straddle::Internal::Type::BaseModel
961
+ # @!attribute codes
962
+ # Specific codes related to the Straddle watchlist screening results.
963
+ #
964
+ # @return [Array<String>, nil]
965
+ optional :codes, Straddle::Internal::Type::ArrayOf[String], nil?: true
966
+
967
+ # @!attribute decision
968
+ #
969
+ # @return [Symbol, Straddle::Models::Customers::CustomerReviewV1::Data::IdentityDetails::WatchList::Decision, nil]
970
+ optional :decision,
971
+ enum: -> {
972
+ Straddle::Customers::CustomerReviewV1::Data::IdentityDetails::WatchList::Decision
973
+ }
974
+
975
+ # @!attribute matched
976
+ # Information about any matches found during screening.
977
+ #
978
+ # @return [Array<String>, nil]
979
+ optional :matched, Straddle::Internal::Type::ArrayOf[String], nil?: true
980
+
981
+ # @!attribute matches
982
+ # Information about any matches found during screening.
983
+ #
984
+ # @return [Array<Straddle::Models::Customers::CustomerReviewV1::Data::IdentityDetails::WatchList::Match>, nil]
985
+ optional :matches,
986
+ -> {
987
+ Straddle::Internal::Type::ArrayOf[Straddle::Customers::CustomerReviewV1::Data::IdentityDetails::WatchList::Match]
988
+ },
989
+ nil?: true
990
+
991
+ # @!method initialize(codes: nil, decision: nil, matched: nil, matches: nil)
992
+ # @param codes [Array<String>, nil] Specific codes related to the Straddle watchlist screening results.
993
+ #
994
+ # @param decision [Symbol, Straddle::Models::Customers::CustomerReviewV1::Data::IdentityDetails::WatchList::Decision]
995
+ #
996
+ # @param matched [Array<String>, nil] Information about any matches found during screening.
997
+ #
998
+ # @param matches [Array<Straddle::Models::Customers::CustomerReviewV1::Data::IdentityDetails::WatchList::Match>, nil] Information about any matches found during screening.
999
+
1000
+ # @see Straddle::Models::Customers::CustomerReviewV1::Data::IdentityDetails::WatchList#decision
1001
+ module Decision
1002
+ extend Straddle::Internal::Type::Enum
1003
+
1004
+ ACCEPT = :accept
1005
+ REJECT = :reject
1006
+ REVIEW = :review
1007
+
1008
+ # @!method self.values
1009
+ # @return [Array<Symbol>]
1010
+ end
1011
+
1012
+ class Match < Straddle::Internal::Type::BaseModel
1013
+ # @!attribute correlation
1014
+ #
1015
+ # @return [Symbol, Straddle::Models::Customers::CustomerReviewV1::Data::IdentityDetails::WatchList::Match::Correlation]
1016
+ required :correlation,
1017
+ enum: -> {
1018
+ Straddle::Customers::CustomerReviewV1::Data::IdentityDetails::WatchList::Match::Correlation
1019
+ }
1020
+
1021
+ # @!attribute list_name
1022
+ # The name of the list the match was found.
1023
+ #
1024
+ # @return [String]
1025
+ required :list_name, String
1026
+
1027
+ # @!attribute match_fields
1028
+ # Data fields that matched.
1029
+ #
1030
+ # @return [Array<String>]
1031
+ required :match_fields, Straddle::Internal::Type::ArrayOf[String]
1032
+
1033
+ # @!attribute urls
1034
+ # Relevent Urls to review.
1035
+ #
1036
+ # @return [Array<String>]
1037
+ required :urls, Straddle::Internal::Type::ArrayOf[String]
1038
+
1039
+ # @!method initialize(correlation:, list_name:, match_fields:, urls:)
1040
+ # @param correlation [Symbol, Straddle::Models::Customers::CustomerReviewV1::Data::IdentityDetails::WatchList::Match::Correlation]
1041
+ #
1042
+ # @param list_name [String] The name of the list the match was found.
1043
+ #
1044
+ # @param match_fields [Array<String>] Data fields that matched.
1045
+ #
1046
+ # @param urls [Array<String>] Relevent Urls to review.
1047
+
1048
+ # @see Straddle::Models::Customers::CustomerReviewV1::Data::IdentityDetails::WatchList::Match#correlation
1049
+ module Correlation
1050
+ extend Straddle::Internal::Type::Enum
1051
+
1052
+ LOW_CONFIDENCE = :low_confidence
1053
+ POTENTIAL_MATCH = :potential_match
1054
+ LIKELY_MATCH = :likely_match
1055
+ HIGH_CONFIDENCE = :high_confidence
1056
+ UNKNOWN = :unknown
1057
+
1058
+ # @!method self.values
1059
+ # @return [Array<Symbol>]
1060
+ end
1061
+ end
1062
+ end
1063
+ end
1064
+ end
1065
+
1066
+ # Indicates the structure of the returned content.
1067
+ #
1068
+ # - "object" means the `data` field contains a single JSON object.
1069
+ # - "array" means the `data` field contains an array of objects.
1070
+ # - "error" means the `data` field contains an error object with details of the
1071
+ # issue.
1072
+ # - "none" means no data is returned.
1073
+ #
1074
+ # @see Straddle::Models::Customers::CustomerReviewV1#response_type
1075
+ module ResponseType
1076
+ extend Straddle::Internal::Type::Enum
1077
+
1078
+ OBJECT = :object
1079
+ ARRAY = :array
1080
+ ERROR = :error
1081
+ NONE = :none
1082
+
1083
+ # @!method self.values
1084
+ # @return [Array<Symbol>]
1085
+ end
1086
+ end
1087
+ end
1088
+
1089
+ CustomerReviewV1 = Customers::CustomerReviewV1
1090
+ end
1091
+ end