straddle 0.3.0 → 0.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (265) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +127 -0
  3. data/README.md +32 -1
  4. data/lib/straddle/client.rb +49 -1
  5. data/lib/straddle/internal/transport/base_client.rb +5 -0
  6. data/lib/straddle/internal/transport/pooled_net_requester.rb +13 -11
  7. data/lib/straddle/internal/util.rb +61 -10
  8. data/lib/straddle/models/bridge/link_create_paykey_response.rb +8 -0
  9. data/lib/straddle/models/bridge/link_create_tan_response.rb +8 -0
  10. data/lib/straddle/models/charge_cancel_params.rb +8 -1
  11. data/lib/straddle/models/charge_create_params.rb +22 -4
  12. data/lib/straddle/models/charge_get_params.rb +7 -1
  13. data/lib/straddle/models/charge_hold_params.rb +8 -1
  14. data/lib/straddle/models/charge_release_params.rb +8 -1
  15. data/lib/straddle/models/charge_unmask_params.rb +7 -1
  16. data/lib/straddle/models/charge_unmask_response.rb +190 -5
  17. data/lib/straddle/models/charge_update_params.rb +11 -4
  18. data/lib/straddle/models/charge_v1.rb +188 -5
  19. data/lib/straddle/models/customer_delete_params.rb +7 -1
  20. data/lib/straddle/models/customer_get_params.rb +7 -1
  21. data/lib/straddle/models/customer_unmasked_params.rb +7 -1
  22. data/lib/straddle/models/customer_update_params.rb +8 -1
  23. data/lib/straddle/models/customers/review_decision_params.rb +8 -1
  24. data/lib/straddle/models/customers/review_get_params.rb +7 -1
  25. data/lib/straddle/models/customers/review_refresh_review_params.rb +7 -1
  26. data/lib/straddle/models/embed/account_get_params.rb +11 -1
  27. data/lib/straddle/models/embed/account_list_params.rb +8 -1
  28. data/lib/straddle/models/embed/account_onboard_params.rb +7 -1
  29. data/lib/straddle/models/embed/account_paged_v1.rb +4 -0
  30. data/lib/straddle/models/embed/account_simulate_params.rb +7 -1
  31. data/lib/straddle/models/embed/account_update_params.rb +8 -1
  32. data/lib/straddle/models/embed/account_v1.rb +4 -0
  33. data/lib/straddle/models/embed/accounts/capability_request_create_params.rb +8 -1
  34. data/lib/straddle/models/embed/accounts/capability_request_list_params.rb +8 -1
  35. data/lib/straddle/models/embed/accounts/capability_request_paged_v1.rb +9 -1
  36. data/lib/straddle/models/embed/address_v1.rb +14 -38
  37. data/lib/straddle/models/embed/linked_bank_account_cancel_params.rb +7 -1
  38. data/lib/straddle/models/embed/linked_bank_account_get_params.rb +7 -1
  39. data/lib/straddle/models/embed/linked_bank_account_unmask_params.rb +7 -1
  40. data/lib/straddle/models/embed/linked_bank_account_update_params.rb +8 -1
  41. data/lib/straddle/models/embed/organization_get_params.rb +7 -1
  42. data/lib/straddle/models/embed/representative.rb +2 -2
  43. data/lib/straddle/models/embed/representative_create_params.rb +2 -2
  44. data/lib/straddle/models/embed/representative_get_params.rb +7 -1
  45. data/lib/straddle/models/embed/representative_paged.rb +2 -2
  46. data/lib/straddle/models/embed/representative_unmask_params.rb +7 -1
  47. data/lib/straddle/models/embed/representative_update_params.rb +10 -3
  48. data/lib/straddle/models/funding_event_get_params.rb +7 -1
  49. data/lib/straddle/models/funding_event_list_params.rb +105 -1
  50. data/lib/straddle/models/funding_event_summary_item_v1.rb +128 -1
  51. data/lib/straddle/models/funding_event_summary_paged_v1.rb +128 -1
  52. data/lib/straddle/models/paykey_cancel_params.rb +7 -1
  53. data/lib/straddle/models/paykey_get_params.rb +7 -1
  54. data/lib/straddle/models/paykey_list_params.rb +40 -1
  55. data/lib/straddle/models/paykey_reveal_params.rb +7 -1
  56. data/lib/straddle/models/paykey_reveal_response.rb +8 -0
  57. data/lib/straddle/models/paykey_summary_paged_v1.rb +19 -1
  58. data/lib/straddle/models/paykey_unmasked_params.rb +7 -1
  59. data/lib/straddle/models/paykey_unmasked_v1.rb +8 -0
  60. data/lib/straddle/models/paykey_update_balance_params.rb +7 -1
  61. data/lib/straddle/models/paykey_v1.rb +19 -1
  62. data/lib/straddle/models/paykeys/review_decision_params.rb +7 -1
  63. data/lib/straddle/models/paykeys/review_get_params.rb +7 -1
  64. data/lib/straddle/models/paykeys/review_get_response.rb +19 -4
  65. data/lib/straddle/models/paykeys/review_refresh_review_params.rb +7 -1
  66. data/lib/straddle/models/payment_list_params.rb +71 -1
  67. data/lib/straddle/models/payment_summary_paged_v1.rb +110 -4
  68. data/lib/straddle/models/payout_cancel_params.rb +8 -1
  69. data/lib/straddle/models/payout_create_params.rb +22 -4
  70. data/lib/straddle/models/payout_get_params.rb +7 -1
  71. data/lib/straddle/models/payout_hold_params.rb +8 -1
  72. data/lib/straddle/models/payout_release_params.rb +8 -1
  73. data/lib/straddle/models/payout_unmask_params.rb +7 -1
  74. data/lib/straddle/models/payout_unmask_response.rb +193 -5
  75. data/lib/straddle/models/payout_update_params.rb +11 -4
  76. data/lib/straddle/models/payout_upload_authorization_document_params.rb +57 -0
  77. data/lib/straddle/models/payout_v1.rb +188 -5
  78. data/lib/straddle/models/status_details_v1.rb +7 -0
  79. data/lib/straddle/models.rb +2 -0
  80. data/lib/straddle/resources/bridge/link.rb +12 -6
  81. data/lib/straddle/resources/bridge.rb +13 -1
  82. data/lib/straddle/resources/charges.rb +13 -8
  83. data/lib/straddle/resources/customers/review.rb +7 -1
  84. data/lib/straddle/resources/customers.rb +23 -10
  85. data/lib/straddle/resources/embed/accounts/capability_requests.rb +9 -4
  86. data/lib/straddle/resources/embed/accounts.rb +29 -15
  87. data/lib/straddle/resources/embed/linked_bank_accounts.rb +11 -6
  88. data/lib/straddle/resources/embed/organizations.rb +7 -2
  89. data/lib/straddle/resources/embed/representatives.rb +15 -8
  90. data/lib/straddle/resources/embed.rb +19 -0
  91. data/lib/straddle/resources/funding_events.rb +22 -3
  92. data/lib/straddle/resources/paykeys/review.rb +7 -2
  93. data/lib/straddle/resources/paykeys.rb +42 -11
  94. data/lib/straddle/resources/payments.rb +30 -6
  95. data/lib/straddle/resources/payouts.rb +60 -7
  96. data/lib/straddle/version.rb +1 -1
  97. data/lib/straddle.rb +2 -0
  98. data/manifest.yaml +1 -0
  99. data/rbi/straddle/client.rbi +34 -0
  100. data/rbi/straddle/internal/util.rbi +29 -1
  101. data/rbi/straddle/models/bridge/link_create_paykey_response.rbi +40 -0
  102. data/rbi/straddle/models/bridge/link_create_tan_response.rbi +40 -0
  103. data/rbi/straddle/models/charge_cancel_params.rbi +6 -0
  104. data/rbi/straddle/models/charge_create_params.rbi +29 -3
  105. data/rbi/straddle/models/charge_get_params.rbi +6 -0
  106. data/rbi/straddle/models/charge_hold_params.rbi +6 -0
  107. data/rbi/straddle/models/charge_release_params.rbi +6 -0
  108. data/rbi/straddle/models/charge_unmask_params.rbi +6 -0
  109. data/rbi/straddle/models/charge_unmask_response.rbi +396 -6
  110. data/rbi/straddle/models/charge_update_params.rbi +9 -3
  111. data/rbi/straddle/models/charge_v1.rbi +364 -6
  112. data/rbi/straddle/models/customer_delete_params.rbi +6 -0
  113. data/rbi/straddle/models/customer_get_params.rbi +6 -0
  114. data/rbi/straddle/models/customer_unmasked_params.rbi +6 -0
  115. data/rbi/straddle/models/customer_update_params.rbi +6 -0
  116. data/rbi/straddle/models/customers/review_decision_params.rbi +6 -0
  117. data/rbi/straddle/models/customers/review_get_params.rbi +6 -0
  118. data/rbi/straddle/models/customers/review_refresh_review_params.rbi +6 -0
  119. data/rbi/straddle/models/embed/account_get_params.rbi +13 -1
  120. data/rbi/straddle/models/embed/account_list_params.rbi +9 -0
  121. data/rbi/straddle/models/embed/account_onboard_params.rbi +6 -0
  122. data/rbi/straddle/models/embed/account_paged_v1.rbi +20 -0
  123. data/rbi/straddle/models/embed/account_simulate_params.rbi +6 -0
  124. data/rbi/straddle/models/embed/account_update_params.rbi +6 -0
  125. data/rbi/straddle/models/embed/account_v1.rbi +20 -0
  126. data/rbi/straddle/models/embed/accounts/capability_request_create_params.rbi +6 -0
  127. data/rbi/straddle/models/embed/accounts/capability_request_list_params.rbi +6 -0
  128. data/rbi/straddle/models/embed/accounts/capability_request_paged_v1.rbi +8 -0
  129. data/rbi/straddle/models/embed/address_v1.rbi +18 -42
  130. data/rbi/straddle/models/embed/linked_bank_account_cancel_params.rbi +6 -0
  131. data/rbi/straddle/models/embed/linked_bank_account_get_params.rbi +11 -1
  132. data/rbi/straddle/models/embed/linked_bank_account_unmask_params.rbi +11 -1
  133. data/rbi/straddle/models/embed/linked_bank_account_update_params.rbi +6 -0
  134. data/rbi/straddle/models/embed/organization_get_params.rbi +11 -1
  135. data/rbi/straddle/models/embed/representative.rbi +2 -2
  136. data/rbi/straddle/models/embed/representative_create_params.rbi +2 -2
  137. data/rbi/straddle/models/embed/representative_get_params.rbi +11 -1
  138. data/rbi/straddle/models/embed/representative_paged.rbi +2 -2
  139. data/rbi/straddle/models/embed/representative_unmask_params.rbi +11 -1
  140. data/rbi/straddle/models/embed/representative_update_params.rbi +8 -2
  141. data/rbi/straddle/models/funding_event_get_params.rbi +6 -0
  142. data/rbi/straddle/models/funding_event_list_params.rbi +333 -0
  143. data/rbi/straddle/models/funding_event_summary_item_v1.rbi +392 -0
  144. data/rbi/straddle/models/funding_event_summary_paged_v1.rbi +393 -0
  145. data/rbi/straddle/models/paykey_cancel_params.rbi +6 -0
  146. data/rbi/straddle/models/paykey_get_params.rbi +6 -0
  147. data/rbi/straddle/models/paykey_list_params.rbi +52 -0
  148. data/rbi/straddle/models/paykey_reveal_params.rbi +6 -0
  149. data/rbi/straddle/models/paykey_reveal_response.rbi +40 -0
  150. data/rbi/straddle/models/paykey_summary_paged_v1.rbi +55 -3
  151. data/rbi/straddle/models/paykey_unmasked_params.rbi +6 -0
  152. data/rbi/straddle/models/paykey_unmasked_v1.rbi +40 -0
  153. data/rbi/straddle/models/paykey_update_balance_params.rbi +6 -0
  154. data/rbi/straddle/models/paykey_v1.rbi +52 -3
  155. data/rbi/straddle/models/paykeys/review_decision_params.rbi +6 -0
  156. data/rbi/straddle/models/paykeys/review_get_params.rbi +6 -0
  157. data/rbi/straddle/models/paykeys/review_get_response.rbi +55 -18
  158. data/rbi/straddle/models/paykeys/review_refresh_review_params.rbi +6 -0
  159. data/rbi/straddle/models/payment_list_params.rbi +126 -0
  160. data/rbi/straddle/models/payment_summary_paged_v1.rbi +214 -6
  161. data/rbi/straddle/models/payout_cancel_params.rbi +6 -0
  162. data/rbi/straddle/models/payout_create_params.rbi +29 -3
  163. data/rbi/straddle/models/payout_get_params.rbi +6 -0
  164. data/rbi/straddle/models/payout_hold_params.rbi +6 -0
  165. data/rbi/straddle/models/payout_release_params.rbi +6 -0
  166. data/rbi/straddle/models/payout_unmask_params.rbi +6 -0
  167. data/rbi/straddle/models/payout_unmask_response.rbi +393 -3
  168. data/rbi/straddle/models/payout_update_params.rbi +9 -3
  169. data/rbi/straddle/models/payout_upload_authorization_document_params.rbi +88 -0
  170. data/rbi/straddle/models/payout_v1.rbi +361 -3
  171. data/rbi/straddle/models/status_details_v1.rbi +29 -0
  172. data/rbi/straddle/models.rbi +3 -0
  173. data/rbi/straddle/resources/bridge/link.rbi +12 -6
  174. data/rbi/straddle/resources/bridge.rbi +13 -1
  175. data/rbi/straddle/resources/charges.rbi +13 -8
  176. data/rbi/straddle/resources/customers/review.rbi +7 -1
  177. data/rbi/straddle/resources/customers.rbi +20 -8
  178. data/rbi/straddle/resources/embed/accounts/capability_requests.rbi +6 -2
  179. data/rbi/straddle/resources/embed/accounts.rbi +22 -10
  180. data/rbi/straddle/resources/embed/linked_bank_accounts.rbi +8 -4
  181. data/rbi/straddle/resources/embed/organizations.rbi +4 -0
  182. data/rbi/straddle/resources/embed/representatives.rbi +12 -6
  183. data/rbi/straddle/resources/embed.rbi +19 -0
  184. data/rbi/straddle/resources/funding_events.rbi +27 -0
  185. data/rbi/straddle/resources/paykeys/review.rbi +7 -2
  186. data/rbi/straddle/resources/paykeys.rbi +32 -8
  187. data/rbi/straddle/resources/payments.rbi +28 -3
  188. data/rbi/straddle/resources/payouts.rbi +44 -7
  189. data/sig/straddle/internal/util.rbs +14 -0
  190. data/sig/straddle/models/bridge/link_create_paykey_response.rbs +17 -1
  191. data/sig/straddle/models/bridge/link_create_tan_response.rbs +17 -1
  192. data/sig/straddle/models/charge_cancel_params.rbs +5 -0
  193. data/sig/straddle/models/charge_create_params.rbs +18 -4
  194. data/sig/straddle/models/charge_get_params.rbs +5 -0
  195. data/sig/straddle/models/charge_hold_params.rbs +5 -0
  196. data/sig/straddle/models/charge_release_params.rbs +5 -0
  197. data/sig/straddle/models/charge_unmask_params.rbs +5 -0
  198. data/sig/straddle/models/charge_unmask_response.rbs +166 -7
  199. data/sig/straddle/models/charge_update_params.rbs +9 -4
  200. data/sig/straddle/models/charge_v1.rbs +166 -7
  201. data/sig/straddle/models/customer_delete_params.rbs +5 -0
  202. data/sig/straddle/models/customer_get_params.rbs +5 -0
  203. data/sig/straddle/models/customer_unmasked_params.rbs +5 -0
  204. data/sig/straddle/models/customer_update_params.rbs +5 -0
  205. data/sig/straddle/models/customers/review_decision_params.rbs +5 -0
  206. data/sig/straddle/models/customers/review_get_params.rbs +5 -0
  207. data/sig/straddle/models/customers/review_refresh_review_params.rbs +5 -0
  208. data/sig/straddle/models/embed/account_get_params.rbs +5 -1
  209. data/sig/straddle/models/embed/account_list_params.rbs +7 -0
  210. data/sig/straddle/models/embed/account_onboard_params.rbs +5 -0
  211. data/sig/straddle/models/embed/account_paged_v1.rbs +18 -2
  212. data/sig/straddle/models/embed/account_simulate_params.rbs +5 -0
  213. data/sig/straddle/models/embed/account_update_params.rbs +5 -0
  214. data/sig/straddle/models/embed/account_v1.rbs +18 -2
  215. data/sig/straddle/models/embed/accounts/capability_request_create_params.rbs +5 -0
  216. data/sig/straddle/models/embed/accounts/capability_request_list_params.rbs +5 -0
  217. data/sig/straddle/models/embed/accounts/capability_request_paged_v1.rbs +5 -0
  218. data/sig/straddle/models/embed/address_v1.rbs +12 -27
  219. data/sig/straddle/models/embed/linked_bank_account_cancel_params.rbs +10 -1
  220. data/sig/straddle/models/embed/linked_bank_account_get_params.rbs +9 -1
  221. data/sig/straddle/models/embed/linked_bank_account_unmask_params.rbs +9 -1
  222. data/sig/straddle/models/embed/linked_bank_account_update_params.rbs +5 -0
  223. data/sig/straddle/models/embed/organization_get_params.rbs +5 -1
  224. data/sig/straddle/models/embed/representative_get_params.rbs +9 -1
  225. data/sig/straddle/models/embed/representative_unmask_params.rbs +9 -1
  226. data/sig/straddle/models/embed/representative_update_params.rbs +5 -0
  227. data/sig/straddle/models/funding_event_get_params.rbs +5 -0
  228. data/sig/straddle/models/funding_event_list_params.rbs +125 -0
  229. data/sig/straddle/models/funding_event_summary_item_v1.rbs +164 -0
  230. data/sig/straddle/models/funding_event_summary_paged_v1.rbs +164 -0
  231. data/sig/straddle/models/paykey_cancel_params.rbs +5 -0
  232. data/sig/straddle/models/paykey_get_params.rbs +5 -0
  233. data/sig/straddle/models/paykey_list_params.rbs +31 -1
  234. data/sig/straddle/models/paykey_reveal_params.rbs +5 -0
  235. data/sig/straddle/models/paykey_reveal_response.rbs +17 -1
  236. data/sig/straddle/models/paykey_summary_paged_v1.rbs +25 -4
  237. data/sig/straddle/models/paykey_unmasked_params.rbs +5 -0
  238. data/sig/straddle/models/paykey_unmasked_v1.rbs +17 -1
  239. data/sig/straddle/models/paykey_update_balance_params.rbs +5 -0
  240. data/sig/straddle/models/paykey_v1.rbs +25 -4
  241. data/sig/straddle/models/paykeys/review_decision_params.rbs +5 -0
  242. data/sig/straddle/models/paykeys/review_get_params.rbs +5 -0
  243. data/sig/straddle/models/paykeys/review_get_response.rbs +28 -10
  244. data/sig/straddle/models/paykeys/review_refresh_review_params.rbs +5 -0
  245. data/sig/straddle/models/payment_list_params.rbs +80 -2
  246. data/sig/straddle/models/payment_summary_paged_v1.rbs +89 -7
  247. data/sig/straddle/models/payout_cancel_params.rbs +5 -0
  248. data/sig/straddle/models/payout_create_params.rbs +18 -4
  249. data/sig/straddle/models/payout_get_params.rbs +5 -0
  250. data/sig/straddle/models/payout_hold_params.rbs +5 -0
  251. data/sig/straddle/models/payout_release_params.rbs +5 -0
  252. data/sig/straddle/models/payout_unmask_params.rbs +5 -0
  253. data/sig/straddle/models/payout_unmask_response.rbs +163 -4
  254. data/sig/straddle/models/payout_update_params.rbs +9 -4
  255. data/sig/straddle/models/payout_upload_authorization_document_params.rbs +59 -0
  256. data/sig/straddle/models/payout_v1.rbs +163 -4
  257. data/sig/straddle/models/status_details_v1.rbs +14 -0
  258. data/sig/straddle/models.rbs +2 -0
  259. data/sig/straddle/resources/charges.rbs +2 -2
  260. data/sig/straddle/resources/embed/accounts.rbs +1 -0
  261. data/sig/straddle/resources/funding_events.rbs +4 -0
  262. data/sig/straddle/resources/paykeys.rbs +4 -0
  263. data/sig/straddle/resources/payments.rbs +7 -0
  264. data/sig/straddle/resources/payouts.rbs +12 -2
  265. metadata +19 -2
@@ -103,13 +103,24 @@ module Straddle
103
103
  # @return [Time]
104
104
  required :updated_at, Time
105
105
 
106
+ # @!attribute status
107
+ # The current status of the `charge` or `payout`.
108
+ #
109
+ # @return [Symbol, Straddle::Models::FundingEventSummaryItemV1::Data::Status, nil]
110
+ optional :status, enum: -> { Straddle::FundingEventSummaryItemV1::Data::Status }
111
+
112
+ # @!attribute status_details
113
+ #
114
+ # @return [Straddle::Models::FundingEventSummaryItemV1::Data::StatusDetails, nil]
115
+ optional :status_details, -> { Straddle::FundingEventSummaryItemV1::Data::StatusDetails }
116
+
106
117
  # @!attribute trace_number
107
118
  # The trace number of the funding event.
108
119
  #
109
120
  # @return [String, nil]
110
121
  optional :trace_number, String, nil?: true
111
122
 
112
- # @!method initialize(id:, amount:, created_at:, direction:, event_type:, payment_count:, trace_ids:, trace_numbers:, transfer_date:, updated_at:, trace_number: nil)
123
+ # @!method initialize(id:, amount:, created_at:, direction:, event_type:, payment_count:, trace_ids:, trace_numbers:, transfer_date:, updated_at:, status: nil, status_details: nil, trace_number: nil)
113
124
  # Some parameter documentations has been truncated, see
114
125
  # {Straddle::Models::FundingEventSummaryItemV1::Data} for more details.
115
126
  #
@@ -133,6 +144,10 @@ module Straddle
133
144
  #
134
145
  # @param updated_at [Time] Updated at.
135
146
  #
147
+ # @param status [Symbol, Straddle::Models::FundingEventSummaryItemV1::Data::Status] The current status of the `charge` or `payout`.
148
+ #
149
+ # @param status_details [Straddle::Models::FundingEventSummaryItemV1::Data::StatusDetails]
150
+ #
136
151
  # @param trace_number [String, nil] The trace number of the funding event.
137
152
 
138
153
  # Describes the direction of the funding event from the perspective of the
@@ -164,6 +179,118 @@ module Straddle
164
179
  # @!method self.values
165
180
  # @return [Array<Symbol>]
166
181
  end
182
+
183
+ # The current status of the `charge` or `payout`.
184
+ #
185
+ # @see Straddle::Models::FundingEventSummaryItemV1::Data#status
186
+ module Status
187
+ extend Straddle::Internal::Type::Enum
188
+
189
+ CREATED = :created
190
+ SCHEDULED = :scheduled
191
+ FAILED = :failed
192
+ CANCELLED = :cancelled
193
+ ON_HOLD = :on_hold
194
+ PENDING = :pending
195
+ PAID = :paid
196
+ REVERSED = :reversed
197
+ VALIDATING = :validating
198
+
199
+ # @!method self.values
200
+ # @return [Array<Symbol>]
201
+ end
202
+
203
+ # @see Straddle::Models::FundingEventSummaryItemV1::Data#status_details
204
+ class StatusDetails < Straddle::Internal::Type::BaseModel
205
+ # @!attribute changed_at
206
+ # The time the status change occurred.
207
+ #
208
+ # @return [Time]
209
+ required :changed_at, Time
210
+
211
+ # @!attribute message
212
+ # A human-readable description of the current status.
213
+ #
214
+ # @return [String]
215
+ required :message, String
216
+
217
+ # @!attribute reason
218
+ #
219
+ # @return [Symbol, Straddle::Models::FundingEventSummaryItemV1::Data::StatusDetails::Reason]
220
+ required :reason, enum: -> { Straddle::FundingEventSummaryItemV1::Data::StatusDetails::Reason }
221
+
222
+ # @!attribute source
223
+ #
224
+ # @return [Symbol, Straddle::Models::FundingEventSummaryItemV1::Data::StatusDetails::Source]
225
+ required :source, enum: -> { Straddle::FundingEventSummaryItemV1::Data::StatusDetails::Source }
226
+
227
+ # @!attribute code
228
+ # The status code if applicable.
229
+ #
230
+ # @return [String, nil]
231
+ optional :code, String, nil?: true
232
+
233
+ # @!method initialize(changed_at:, message:, reason:, source:, code: nil)
234
+ # @param changed_at [Time] The time the status change occurred.
235
+ #
236
+ # @param message [String] A human-readable description of the current status.
237
+ #
238
+ # @param reason [Symbol, Straddle::Models::FundingEventSummaryItemV1::Data::StatusDetails::Reason]
239
+ #
240
+ # @param source [Symbol, Straddle::Models::FundingEventSummaryItemV1::Data::StatusDetails::Source]
241
+ #
242
+ # @param code [String, nil] The status code if applicable.
243
+
244
+ # @see Straddle::Models::FundingEventSummaryItemV1::Data::StatusDetails#reason
245
+ module Reason
246
+ extend Straddle::Internal::Type::Enum
247
+
248
+ INSUFFICIENT_FUNDS = :insufficient_funds
249
+ CLOSED_BANK_ACCOUNT = :closed_bank_account
250
+ INVALID_BANK_ACCOUNT = :invalid_bank_account
251
+ INVALID_ROUTING = :invalid_routing
252
+ DISPUTED = :disputed
253
+ PAYMENT_STOPPED = :payment_stopped
254
+ OWNER_DECEASED = :owner_deceased
255
+ FROZEN_BANK_ACCOUNT = :frozen_bank_account
256
+ RISK_REVIEW = :risk_review
257
+ FRAUDULENT = :fraudulent
258
+ DUPLICATE_ENTRY = :duplicate_entry
259
+ INVALID_PAYKEY = :invalid_paykey
260
+ PAYMENT_BLOCKED = :payment_blocked
261
+ AMOUNT_TOO_LARGE = :amount_too_large
262
+ TOO_MANY_ATTEMPTS = :too_many_attempts
263
+ INTERNAL_SYSTEM_ERROR = :internal_system_error
264
+ USER_REQUEST = :user_request
265
+ OK = :ok
266
+ OTHER_NETWORK_RETURN = :other_network_return
267
+ PAYOUT_REFUSED = :payout_refused
268
+ CANCEL_REQUEST = :cancel_request
269
+ FAILED_VERIFICATION = :failed_verification
270
+ REQUIRE_REVIEW = :require_review
271
+ BLOCKED_BY_SYSTEM = :blocked_by_system
272
+ WATCHTOWER_REVIEW = :watchtower_review
273
+ VALIDATING = :validating
274
+ AUTO_HOLD = :auto_hold
275
+
276
+ # @!method self.values
277
+ # @return [Array<Symbol>]
278
+ end
279
+
280
+ # @see Straddle::Models::FundingEventSummaryItemV1::Data::StatusDetails#source
281
+ module Source
282
+ extend Straddle::Internal::Type::Enum
283
+
284
+ WATCHTOWER = :watchtower
285
+ BANK_DECLINE = :bank_decline
286
+ CUSTOMER_DISPUTE = :customer_dispute
287
+ USER_ACTION = :user_action
288
+ SYSTEM = :system
289
+
290
+ # @!method self.values
291
+ # @return [Array<Symbol>]
292
+ end
293
+ end
167
294
  end
168
295
 
169
296
  # Indicates the structure of the returned content.
@@ -100,13 +100,24 @@ module Straddle
100
100
  # @return [Time]
101
101
  required :updated_at, Time
102
102
 
103
+ # @!attribute status
104
+ # The current status of the `charge` or `payout`.
105
+ #
106
+ # @return [Symbol, Straddle::Models::FundingEventSummaryPagedV1::Data::Status, nil]
107
+ optional :status, enum: -> { Straddle::FundingEventSummaryPagedV1::Data::Status }
108
+
109
+ # @!attribute status_details
110
+ #
111
+ # @return [Straddle::Models::FundingEventSummaryPagedV1::Data::StatusDetails, nil]
112
+ optional :status_details, -> { Straddle::FundingEventSummaryPagedV1::Data::StatusDetails }
113
+
103
114
  # @!attribute trace_number
104
115
  # The trace number of the funding event.
105
116
  #
106
117
  # @return [String, nil]
107
118
  optional :trace_number, String, nil?: true
108
119
 
109
- # @!method initialize(id:, amount:, created_at:, direction:, event_type:, payment_count:, trace_ids:, trace_numbers:, transfer_date:, updated_at:, trace_number: nil)
120
+ # @!method initialize(id:, amount:, created_at:, direction:, event_type:, payment_count:, trace_ids:, trace_numbers:, transfer_date:, updated_at:, status: nil, status_details: nil, trace_number: nil)
110
121
  # Some parameter documentations has been truncated, see
111
122
  # {Straddle::Models::FundingEventSummaryPagedV1::Data} for more details.
112
123
  #
@@ -130,6 +141,10 @@ module Straddle
130
141
  #
131
142
  # @param updated_at [Time] Updated at.
132
143
  #
144
+ # @param status [Symbol, Straddle::Models::FundingEventSummaryPagedV1::Data::Status] The current status of the `charge` or `payout`.
145
+ #
146
+ # @param status_details [Straddle::Models::FundingEventSummaryPagedV1::Data::StatusDetails]
147
+ #
133
148
  # @param trace_number [String, nil] The trace number of the funding event.
134
149
 
135
150
  # Describes the direction of the funding event from the perspective of the
@@ -161,6 +176,118 @@ module Straddle
161
176
  # @!method self.values
162
177
  # @return [Array<Symbol>]
163
178
  end
179
+
180
+ # The current status of the `charge` or `payout`.
181
+ #
182
+ # @see Straddle::Models::FundingEventSummaryPagedV1::Data#status
183
+ module Status
184
+ extend Straddle::Internal::Type::Enum
185
+
186
+ CREATED = :created
187
+ SCHEDULED = :scheduled
188
+ FAILED = :failed
189
+ CANCELLED = :cancelled
190
+ ON_HOLD = :on_hold
191
+ PENDING = :pending
192
+ PAID = :paid
193
+ REVERSED = :reversed
194
+ VALIDATING = :validating
195
+
196
+ # @!method self.values
197
+ # @return [Array<Symbol>]
198
+ end
199
+
200
+ # @see Straddle::Models::FundingEventSummaryPagedV1::Data#status_details
201
+ class StatusDetails < Straddle::Internal::Type::BaseModel
202
+ # @!attribute changed_at
203
+ # The time the status change occurred.
204
+ #
205
+ # @return [Time]
206
+ required :changed_at, Time
207
+
208
+ # @!attribute message
209
+ # A human-readable description of the current status.
210
+ #
211
+ # @return [String]
212
+ required :message, String
213
+
214
+ # @!attribute reason
215
+ #
216
+ # @return [Symbol, Straddle::Models::FundingEventSummaryPagedV1::Data::StatusDetails::Reason]
217
+ required :reason, enum: -> { Straddle::FundingEventSummaryPagedV1::Data::StatusDetails::Reason }
218
+
219
+ # @!attribute source
220
+ #
221
+ # @return [Symbol, Straddle::Models::FundingEventSummaryPagedV1::Data::StatusDetails::Source]
222
+ required :source, enum: -> { Straddle::FundingEventSummaryPagedV1::Data::StatusDetails::Source }
223
+
224
+ # @!attribute code
225
+ # The status code if applicable.
226
+ #
227
+ # @return [String, nil]
228
+ optional :code, String, nil?: true
229
+
230
+ # @!method initialize(changed_at:, message:, reason:, source:, code: nil)
231
+ # @param changed_at [Time] The time the status change occurred.
232
+ #
233
+ # @param message [String] A human-readable description of the current status.
234
+ #
235
+ # @param reason [Symbol, Straddle::Models::FundingEventSummaryPagedV1::Data::StatusDetails::Reason]
236
+ #
237
+ # @param source [Symbol, Straddle::Models::FundingEventSummaryPagedV1::Data::StatusDetails::Source]
238
+ #
239
+ # @param code [String, nil] The status code if applicable.
240
+
241
+ # @see Straddle::Models::FundingEventSummaryPagedV1::Data::StatusDetails#reason
242
+ module Reason
243
+ extend Straddle::Internal::Type::Enum
244
+
245
+ INSUFFICIENT_FUNDS = :insufficient_funds
246
+ CLOSED_BANK_ACCOUNT = :closed_bank_account
247
+ INVALID_BANK_ACCOUNT = :invalid_bank_account
248
+ INVALID_ROUTING = :invalid_routing
249
+ DISPUTED = :disputed
250
+ PAYMENT_STOPPED = :payment_stopped
251
+ OWNER_DECEASED = :owner_deceased
252
+ FROZEN_BANK_ACCOUNT = :frozen_bank_account
253
+ RISK_REVIEW = :risk_review
254
+ FRAUDULENT = :fraudulent
255
+ DUPLICATE_ENTRY = :duplicate_entry
256
+ INVALID_PAYKEY = :invalid_paykey
257
+ PAYMENT_BLOCKED = :payment_blocked
258
+ AMOUNT_TOO_LARGE = :amount_too_large
259
+ TOO_MANY_ATTEMPTS = :too_many_attempts
260
+ INTERNAL_SYSTEM_ERROR = :internal_system_error
261
+ USER_REQUEST = :user_request
262
+ OK = :ok
263
+ OTHER_NETWORK_RETURN = :other_network_return
264
+ PAYOUT_REFUSED = :payout_refused
265
+ CANCEL_REQUEST = :cancel_request
266
+ FAILED_VERIFICATION = :failed_verification
267
+ REQUIRE_REVIEW = :require_review
268
+ BLOCKED_BY_SYSTEM = :blocked_by_system
269
+ WATCHTOWER_REVIEW = :watchtower_review
270
+ VALIDATING = :validating
271
+ AUTO_HOLD = :auto_hold
272
+
273
+ # @!method self.values
274
+ # @return [Array<Symbol>]
275
+ end
276
+
277
+ # @see Straddle::Models::FundingEventSummaryPagedV1::Data::StatusDetails#source
278
+ module Source
279
+ extend Straddle::Internal::Type::Enum
280
+
281
+ WATCHTOWER = :watchtower
282
+ BANK_DECLINE = :bank_decline
283
+ CUSTOMER_DISPUTE = :customer_dispute
284
+ USER_ACTION = :user_action
285
+ SYSTEM = :system
286
+
287
+ # @!method self.values
288
+ # @return [Array<Symbol>]
289
+ end
290
+ end
164
291
  end
165
292
 
166
293
  # @see Straddle::Models::FundingEventSummaryPagedV1#meta
@@ -7,6 +7,11 @@ module Straddle
7
7
  extend Straddle::Internal::Type::RequestParameters::Converter
8
8
  include Straddle::Internal::Type::RequestParameters
9
9
 
10
+ # @!attribute id
11
+ #
12
+ # @return [String]
13
+ required :id, String
14
+
10
15
  # @!attribute reason
11
16
  #
12
17
  # @return [String, nil]
@@ -32,7 +37,8 @@ module Straddle
32
37
  # @return [String, nil]
33
38
  optional :straddle_account_id, String
34
39
 
35
- # @!method initialize(reason: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
40
+ # @!method initialize(id:, reason: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
41
+ # @param id [String]
36
42
  # @param reason [String, nil]
37
43
  # @param correlation_id [String]
38
44
  # @param idempotency_key [String]
@@ -7,6 +7,11 @@ module Straddle
7
7
  extend Straddle::Internal::Type::RequestParameters::Converter
8
8
  include Straddle::Internal::Type::RequestParameters
9
9
 
10
+ # @!attribute id
11
+ #
12
+ # @return [String]
13
+ required :id, String
14
+
10
15
  # @!attribute correlation_id
11
16
  #
12
17
  # @return [String, nil]
@@ -22,7 +27,8 @@ module Straddle
22
27
  # @return [String, nil]
23
28
  optional :straddle_account_id, String
24
29
 
25
- # @!method initialize(correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
30
+ # @!method initialize(id:, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
31
+ # @param id [String]
26
32
  # @param correlation_id [String]
27
33
  # @param request_id [String]
28
34
  # @param straddle_account_id [String]
@@ -7,6 +7,18 @@ module Straddle
7
7
  extend Straddle::Internal::Type::RequestParameters::Converter
8
8
  include Straddle::Internal::Type::RequestParameters
9
9
 
10
+ # @!attribute created_from
11
+ # Start date for filtering by creation date.
12
+ #
13
+ # @return [Time, nil]
14
+ optional :created_from, Time
15
+
16
+ # @!attribute created_to
17
+ # End date for filtering by creation date.
18
+ #
19
+ # @return [Time, nil]
20
+ optional :created_to, Time
21
+
10
22
  # @!attribute customer_id
11
23
  # Filter paykeys by related customer ID.
12
24
  #
@@ -25,6 +37,12 @@ module Straddle
25
37
  # @return [Integer, nil]
26
38
  optional :page_size, Integer
27
39
 
40
+ # @!attribute search_text
41
+ # General search term to filter paykeys.
42
+ #
43
+ # @return [String, nil]
44
+ optional :search_text, String
45
+
28
46
  # @!attribute sort_by
29
47
  #
30
48
  # @return [Symbol, Straddle::Models::PaykeyListParams::SortBy, nil]
@@ -47,6 +65,15 @@ module Straddle
47
65
  # @return [Array<Symbol, Straddle::Models::PaykeyListParams::Status>, nil]
48
66
  optional :status, -> { Straddle::Internal::Type::ArrayOf[enum: Straddle::PaykeyListParams::Status] }
49
67
 
68
+ # @!attribute unblock_eligible
69
+ # Filter paykeys by unblock eligibility. When true, returns only blocked paykeys
70
+ # eligible for client-initiated unblocking (blocked due to R29 returns and not
71
+ # previously unblocked). When false, returns only blocked paykeys that are not
72
+ # eligible for unblocking.
73
+ #
74
+ # @return [Boolean, nil]
75
+ optional :unblock_eligible, Straddle::Internal::Type::Boolean
76
+
50
77
  # @!attribute correlation_id
51
78
  #
52
79
  # @return [String, nil]
@@ -62,13 +89,22 @@ module Straddle
62
89
  # @return [String, nil]
63
90
  optional :straddle_account_id, String
64
91
 
65
- # @!method initialize(customer_id: nil, page_number: nil, page_size: nil, sort_by: nil, sort_order: nil, source: nil, status: nil, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
92
+ # @!method initialize(created_from: nil, created_to: nil, customer_id: nil, page_number: nil, page_size: nil, search_text: nil, sort_by: nil, sort_order: nil, source: nil, status: nil, unblock_eligible: nil, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
93
+ # Some parameter documentations has been truncated, see
94
+ # {Straddle::Models::PaykeyListParams} for more details.
95
+ #
96
+ # @param created_from [Time] Start date for filtering by creation date.
97
+ #
98
+ # @param created_to [Time] End date for filtering by creation date.
99
+ #
66
100
  # @param customer_id [String] Filter paykeys by related customer ID.
67
101
  #
68
102
  # @param page_number [Integer] Page number for paginated results. Starts at 1.
69
103
  #
70
104
  # @param page_size [Integer] Number of results per page. Maximum: 1000.
71
105
  #
106
+ # @param search_text [String] General search term to filter paykeys.
107
+ #
72
108
  # @param sort_by [Symbol, Straddle::Models::PaykeyListParams::SortBy]
73
109
  #
74
110
  # @param sort_order [Symbol, Straddle::Models::PaykeyListParams::SortOrder]
@@ -77,6 +113,8 @@ module Straddle
77
113
  #
78
114
  # @param status [Array<Symbol, Straddle::Models::PaykeyListParams::Status>] Filter paykeys by their current status.
79
115
  #
116
+ # @param unblock_eligible [Boolean] Filter paykeys by unblock eligibility. When true, returns only blocked paykeys e
117
+ #
80
118
  # @param correlation_id [String]
81
119
  #
82
120
  # @param request_id [String]
@@ -128,6 +166,7 @@ module Straddle
128
166
  INACTIVE = :inactive
129
167
  REJECTED = :rejected
130
168
  REVIEW = :review
169
+ BLOCKED = :blocked
131
170
 
132
171
  # @!method self.values
133
172
  # @return [Array<Symbol>]
@@ -7,6 +7,11 @@ module Straddle
7
7
  extend Straddle::Internal::Type::RequestParameters::Converter
8
8
  include Straddle::Internal::Type::RequestParameters
9
9
 
10
+ # @!attribute id
11
+ #
12
+ # @return [String]
13
+ required :id, String
14
+
10
15
  # @!attribute correlation_id
11
16
  #
12
17
  # @return [String, nil]
@@ -22,7 +27,8 @@ module Straddle
22
27
  # @return [String, nil]
23
28
  optional :straddle_account_id, String
24
29
 
25
- # @!method initialize(correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
30
+ # @!method initialize(id:, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
31
+ # @param id [String]
26
32
  # @param correlation_id [String]
27
33
  # @param request_id [String]
28
34
  # @param straddle_account_id [String]
@@ -237,6 +237,7 @@ module Straddle
237
237
  INACTIVE = :inactive
238
238
  REJECTED = :rejected
239
239
  REVIEW = :review
240
+ BLOCKED = :blocked
240
241
 
241
242
  # @!method self.values
242
243
  # @return [Array<Symbol>]
@@ -388,6 +389,13 @@ module Straddle
388
389
  OK = :ok
389
390
  OTHER_NETWORK_RETURN = :other_network_return
390
391
  PAYOUT_REFUSED = :payout_refused
392
+ CANCEL_REQUEST = :cancel_request
393
+ FAILED_VERIFICATION = :failed_verification
394
+ REQUIRE_REVIEW = :require_review
395
+ BLOCKED_BY_SYSTEM = :blocked_by_system
396
+ WATCHTOWER_REVIEW = :watchtower_review
397
+ VALIDATING = :validating
398
+ AUTO_HOLD = :auto_hold
391
399
 
392
400
  # @!method self.values
393
401
  # @return [Array<Symbol>]
@@ -118,7 +118,15 @@ module Straddle
118
118
  # @return [Straddle::Models::PaykeySummaryPagedV1::Data::StatusDetails, nil]
119
119
  optional :status_details, -> { Straddle::PaykeySummaryPagedV1::Data::StatusDetails }
120
120
 
121
- # @!method initialize(id:, config:, created_at:, label:, paykey:, source:, status:, updated_at:, bank_data: nil, customer_id: nil, expires_at: nil, external_id: nil, institution_name: nil, status_details: nil)
121
+ # @!attribute unblock_eligible
122
+ # Indicates whether this paykey is eligible for client-initiated unblocking. Only
123
+ # present for blocked paykeys. True when blocked due to R29 returns and not
124
+ # previously unblocked, false otherwise. Null when paykey is not blocked.
125
+ #
126
+ # @return [Boolean, nil]
127
+ optional :unblock_eligible, Straddle::Internal::Type::Boolean, nil?: true
128
+
129
+ # @!method initialize(id:, config:, created_at:, label:, paykey:, source:, status:, updated_at:, bank_data: nil, customer_id: nil, expires_at: nil, external_id: nil, institution_name: nil, status_details: nil, unblock_eligible: nil)
122
130
  # Some parameter documentations has been truncated, see
123
131
  # {Straddle::Models::PaykeySummaryPagedV1::Data} for more details.
124
132
  #
@@ -149,6 +157,8 @@ module Straddle
149
157
  # @param institution_name [String, nil] Name of the financial institution.
150
158
  #
151
159
  # @param status_details [Straddle::Models::PaykeySummaryPagedV1::Data::StatusDetails]
160
+ #
161
+ # @param unblock_eligible [Boolean, nil] Indicates whether this paykey is eligible for client-initiated unblocking. Only
152
162
 
153
163
  # @see Straddle::Models::PaykeySummaryPagedV1::Data#config
154
164
  class Config < Straddle::Internal::Type::BaseModel
@@ -216,6 +226,7 @@ module Straddle
216
226
  INACTIVE = :inactive
217
227
  REJECTED = :rejected
218
228
  REVIEW = :review
229
+ BLOCKED = :blocked
219
230
 
220
231
  # @!method self.values
221
232
  # @return [Array<Symbol>]
@@ -328,6 +339,13 @@ module Straddle
328
339
  OK = :ok
329
340
  OTHER_NETWORK_RETURN = :other_network_return
330
341
  PAYOUT_REFUSED = :payout_refused
342
+ CANCEL_REQUEST = :cancel_request
343
+ FAILED_VERIFICATION = :failed_verification
344
+ REQUIRE_REVIEW = :require_review
345
+ BLOCKED_BY_SYSTEM = :blocked_by_system
346
+ WATCHTOWER_REVIEW = :watchtower_review
347
+ VALIDATING = :validating
348
+ AUTO_HOLD = :auto_hold
331
349
 
332
350
  # @!method self.values
333
351
  # @return [Array<Symbol>]
@@ -7,6 +7,11 @@ module Straddle
7
7
  extend Straddle::Internal::Type::RequestParameters::Converter
8
8
  include Straddle::Internal::Type::RequestParameters
9
9
 
10
+ # @!attribute id
11
+ #
12
+ # @return [String]
13
+ required :id, String
14
+
10
15
  # @!attribute correlation_id
11
16
  #
12
17
  # @return [String, nil]
@@ -22,7 +27,8 @@ module Straddle
22
27
  # @return [String, nil]
23
28
  optional :straddle_account_id, String
24
29
 
25
- # @!method initialize(correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
30
+ # @!method initialize(id:, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
31
+ # @param id [String]
26
32
  # @param correlation_id [String]
27
33
  # @param request_id [String]
28
34
  # @param straddle_account_id [String]
@@ -234,6 +234,7 @@ module Straddle
234
234
  INACTIVE = :inactive
235
235
  REJECTED = :rejected
236
236
  REVIEW = :review
237
+ BLOCKED = :blocked
237
238
 
238
239
  # @!method self.values
239
240
  # @return [Array<Symbol>]
@@ -381,6 +382,13 @@ module Straddle
381
382
  OK = :ok
382
383
  OTHER_NETWORK_RETURN = :other_network_return
383
384
  PAYOUT_REFUSED = :payout_refused
385
+ CANCEL_REQUEST = :cancel_request
386
+ FAILED_VERIFICATION = :failed_verification
387
+ REQUIRE_REVIEW = :require_review
388
+ BLOCKED_BY_SYSTEM = :blocked_by_system
389
+ WATCHTOWER_REVIEW = :watchtower_review
390
+ VALIDATING = :validating
391
+ AUTO_HOLD = :auto_hold
384
392
 
385
393
  # @!method self.values
386
394
  # @return [Array<Symbol>]
@@ -7,6 +7,11 @@ module Straddle
7
7
  extend Straddle::Internal::Type::RequestParameters::Converter
8
8
  include Straddle::Internal::Type::RequestParameters
9
9
 
10
+ # @!attribute id
11
+ #
12
+ # @return [String]
13
+ required :id, String
14
+
10
15
  # @!attribute correlation_id
11
16
  #
12
17
  # @return [String, nil]
@@ -27,7 +32,8 @@ module Straddle
27
32
  # @return [String, nil]
28
33
  optional :straddle_account_id, String
29
34
 
30
- # @!method initialize(correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
35
+ # @!method initialize(id:, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
36
+ # @param id [String]
31
37
  # @param correlation_id [String]
32
38
  # @param idempotency_key [String]
33
39
  # @param request_id [String]
@@ -132,7 +132,15 @@ module Straddle
132
132
  # @return [Straddle::Models::PaykeyV1::Data::StatusDetails, nil]
133
133
  optional :status_details, -> { Straddle::PaykeyV1::Data::StatusDetails }
134
134
 
135
- # @!method initialize(id:, config:, created_at:, label:, paykey:, source:, status:, updated_at:, balance: nil, bank_data: nil, customer_id: nil, expires_at: nil, external_id: nil, institution_name: nil, metadata: nil, status_details: nil)
135
+ # @!attribute unblock_eligible
136
+ # Indicates whether this paykey is eligible for client-initiated unblocking. Only
137
+ # present for blocked paykeys. True when blocked due to R29 returns and not
138
+ # previously unblocked, false otherwise. Null when paykey is not blocked.
139
+ #
140
+ # @return [Boolean, nil]
141
+ optional :unblock_eligible, Straddle::Internal::Type::Boolean, nil?: true
142
+
143
+ # @!method initialize(id:, config:, created_at:, label:, paykey:, source:, status:, updated_at:, balance: nil, bank_data: nil, customer_id: nil, expires_at: nil, external_id: nil, institution_name: nil, metadata: nil, status_details: nil, unblock_eligible: nil)
136
144
  # Some parameter documentations has been truncated, see
137
145
  # {Straddle::Models::PaykeyV1::Data} for more details.
138
146
  #
@@ -167,6 +175,8 @@ module Straddle
167
175
  # @param metadata [Hash{Symbol=>String}, nil] Up to 20 additional user-defined key-value pairs. Useful for storing additional
168
176
  #
169
177
  # @param status_details [Straddle::Models::PaykeyV1::Data::StatusDetails]
178
+ #
179
+ # @param unblock_eligible [Boolean, nil] Indicates whether this paykey is eligible for client-initiated unblocking. Only
170
180
 
171
181
  # @see Straddle::Models::PaykeyV1::Data#config
172
182
  class Config < Straddle::Internal::Type::BaseModel
@@ -234,6 +244,7 @@ module Straddle
234
244
  INACTIVE = :inactive
235
245
  REJECTED = :rejected
236
246
  REVIEW = :review
247
+ BLOCKED = :blocked
237
248
 
238
249
  # @!method self.values
239
250
  # @return [Array<Symbol>]
@@ -385,6 +396,13 @@ module Straddle
385
396
  OK = :ok
386
397
  OTHER_NETWORK_RETURN = :other_network_return
387
398
  PAYOUT_REFUSED = :payout_refused
399
+ CANCEL_REQUEST = :cancel_request
400
+ FAILED_VERIFICATION = :failed_verification
401
+ REQUIRE_REVIEW = :require_review
402
+ BLOCKED_BY_SYSTEM = :blocked_by_system
403
+ WATCHTOWER_REVIEW = :watchtower_review
404
+ VALIDATING = :validating
405
+ AUTO_HOLD = :auto_hold
388
406
 
389
407
  # @!method self.values
390
408
  # @return [Array<Symbol>]
@@ -8,6 +8,11 @@ module Straddle
8
8
  extend Straddle::Internal::Type::RequestParameters::Converter
9
9
  include Straddle::Internal::Type::RequestParameters
10
10
 
11
+ # @!attribute id
12
+ #
13
+ # @return [String]
14
+ required :id, String
15
+
11
16
  # @!attribute status
12
17
  #
13
18
  # @return [Symbol, Straddle::Models::Paykeys::ReviewDecisionParams::Status]
@@ -33,7 +38,8 @@ module Straddle
33
38
  # @return [String, nil]
34
39
  optional :straddle_account_id, String
35
40
 
36
- # @!method initialize(status:, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
41
+ # @!method initialize(id:, status:, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
42
+ # @param id [String]
37
43
  # @param status [Symbol, Straddle::Models::Paykeys::ReviewDecisionParams::Status]
38
44
  # @param correlation_id [String]
39
45
  # @param idempotency_key [String]