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
@@ -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 correlation_id
12
17
  #
13
18
  # @return [String, nil]
@@ -23,7 +28,8 @@ module Straddle
23
28
  # @return [String, nil]
24
29
  optional :straddle_account_id, String
25
30
 
26
- # @!method initialize(correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
31
+ # @!method initialize(id:, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
32
+ # @param id [String]
27
33
  # @param correlation_id [String]
28
34
  # @param request_id [String]
29
35
  # @param straddle_account_id [String]
@@ -151,7 +151,15 @@ module Straddle
151
151
  optional :status_details,
152
152
  -> { Straddle::Models::Paykeys::ReviewGetResponse::Data::PaykeyDetails::StatusDetails }
153
153
 
154
- # @!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)
154
+ # @!attribute unblock_eligible
155
+ # Indicates whether this paykey is eligible for client-initiated unblocking. Only
156
+ # present for blocked paykeys. True when blocked due to R29 returns and not
157
+ # previously unblocked, false otherwise. Null when paykey is not blocked.
158
+ #
159
+ # @return [Boolean, nil]
160
+ optional :unblock_eligible, Straddle::Internal::Type::Boolean, nil?: true
161
+
162
+ # @!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)
155
163
  # Some parameter documentations has been truncated, see
156
164
  # {Straddle::Models::Paykeys::ReviewGetResponse::Data::PaykeyDetails} for more
157
165
  # details.
@@ -187,6 +195,8 @@ module Straddle
187
195
  # @param metadata [Hash{Symbol=>String}, nil] Up to 20 additional user-defined key-value pairs. Useful for storing additional
188
196
  #
189
197
  # @param status_details [Straddle::Models::Paykeys::ReviewGetResponse::Data::PaykeyDetails::StatusDetails]
198
+ #
199
+ # @param unblock_eligible [Boolean, nil] Indicates whether this paykey is eligible for client-initiated unblocking. Only
190
200
 
191
201
  # @see Straddle::Models::Paykeys::ReviewGetResponse::Data::PaykeyDetails#config
192
202
  class Config < Straddle::Internal::Type::BaseModel
@@ -256,6 +266,7 @@ module Straddle
256
266
  INACTIVE = :inactive
257
267
  REJECTED = :rejected
258
268
  REVIEW = :review
269
+ BLOCKED = :blocked
259
270
 
260
271
  # @!method self.values
261
272
  # @return [Array<Symbol>]
@@ -412,6 +423,13 @@ module Straddle
412
423
  OK = :ok
413
424
  OTHER_NETWORK_RETURN = :other_network_return
414
425
  PAYOUT_REFUSED = :payout_refused
426
+ CANCEL_REQUEST = :cancel_request
427
+ FAILED_VERIFICATION = :failed_verification
428
+ REQUIRE_REVIEW = :require_review
429
+ BLOCKED_BY_SYSTEM = :blocked_by_system
430
+ WATCHTOWER_REVIEW = :watchtower_review
431
+ VALIDATING = :validating
432
+ AUTO_HOLD = :auto_hold
415
433
 
416
434
  # @!method self.values
417
435
  # @return [Array<Symbol>]
@@ -529,7 +547,6 @@ module Straddle
529
547
  module Decision
530
548
  extend Straddle::Internal::Type::Enum
531
549
 
532
- UNKNOWN = :unknown
533
550
  ACCEPT = :accept
534
551
  REJECT = :reject
535
552
  REVIEW = :review
@@ -590,7 +607,6 @@ module Straddle
590
607
  module Decision
591
608
  extend Straddle::Internal::Type::Enum
592
609
 
593
- UNKNOWN = :unknown
594
610
  ACCEPT = :accept
595
611
  REJECT = :reject
596
612
  REVIEW = :review
@@ -605,7 +621,6 @@ module Straddle
605
621
  module Decision
606
622
  extend Straddle::Internal::Type::Enum
607
623
 
608
- UNKNOWN = :unknown
609
624
  ACCEPT = :accept
610
625
  REJECT = :reject
611
626
  REVIEW = :review
@@ -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 correlation_id
12
17
  #
13
18
  # @return [String, nil]
@@ -28,7 +33,8 @@ module Straddle
28
33
  # @return [String, nil]
29
34
  optional :straddle_account_id, String
30
35
 
31
- # @!method initialize(correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
36
+ # @!method initialize(id:, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
37
+ # @param id [String]
32
38
  # @param correlation_id [String]
33
39
  # @param idempotency_key [String]
34
40
  # @param request_id [String]
@@ -41,6 +41,37 @@ module Straddle
41
41
  # @return [String, nil]
42
42
  optional :funding_id, String
43
43
 
44
+ # @!attribute has_refund
45
+ # Has the payment been refunded by an associated payout (only applicable to
46
+ # charges).
47
+ #
48
+ # @return [Boolean, nil]
49
+ optional :has_refund, Straddle::Internal::Type::Boolean
50
+
51
+ # @!attribute has_resubmit
52
+ # Has the payment been resubmitted.
53
+ #
54
+ # @return [Boolean, nil]
55
+ optional :has_resubmit, Straddle::Internal::Type::Boolean
56
+
57
+ # @!attribute include_metadata
58
+ # Include the metadata for payments in the returned data.
59
+ #
60
+ # @return [Boolean, nil]
61
+ optional :include_metadata, Straddle::Internal::Type::Boolean
62
+
63
+ # @!attribute is_refund
64
+ # Is the payment a refund of an original charge (only applicable to payouts).
65
+ #
66
+ # @return [Boolean, nil]
67
+ optional :is_refund, Straddle::Internal::Type::Boolean
68
+
69
+ # @!attribute is_resubmit
70
+ # Is the payment a resubmit of an original payment.
71
+ #
72
+ # @return [Boolean, nil]
73
+ optional :is_resubmit, Straddle::Internal::Type::Boolean
74
+
44
75
  # @!attribute max_amount
45
76
  # Search using a maximum `amount` of a `charge` or `payout`.
46
77
  #
@@ -65,6 +96,12 @@ module Straddle
65
96
  # @return [Date, nil]
66
97
  optional :max_payment_date, Date
67
98
 
99
+ # @!attribute max_updated_at
100
+ # Filter to payments last updated on or before this timestamp.
101
+ #
102
+ # @return [Time, nil]
103
+ optional :max_updated_at, Time
104
+
68
105
  # @!attribute min_amount
69
106
  # Search using the minimum `amount of a `charge`or`payout`.
70
107
  #
@@ -89,6 +126,12 @@ module Straddle
89
126
  # @return [Date, nil]
90
127
  optional :min_payment_date, Date
91
128
 
129
+ # @!attribute min_updated_at
130
+ # Filter to payments last updated on or after this timestamp.
131
+ #
132
+ # @return [Time, nil]
133
+ optional :min_updated_at, Time
134
+
92
135
  # @!attribute page_number
93
136
  # Results page number. Starts at page 1.
94
137
  #
@@ -179,7 +222,10 @@ module Straddle
179
222
  # @return [String, nil]
180
223
  optional :straddle_account_id, String
181
224
 
182
- # @!method initialize(customer_id: nil, default_page_size: nil, default_sort: nil, default_sort_order: nil, external_id: nil, funding_id: nil, max_amount: nil, max_created_at: nil, max_effective_at: nil, max_payment_date: nil, min_amount: nil, min_created_at: nil, min_effective_at: nil, min_payment_date: nil, page_number: nil, page_size: nil, paykey: nil, paykey_id: nil, payment_id: nil, payment_status: nil, payment_type: nil, search_text: nil, sort_by: nil, sort_order: nil, status_reason: nil, status_source: nil, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
225
+ # @!method initialize(customer_id: nil, default_page_size: nil, default_sort: nil, default_sort_order: nil, external_id: nil, funding_id: nil, has_refund: nil, has_resubmit: nil, include_metadata: nil, is_refund: nil, is_resubmit: nil, max_amount: nil, max_created_at: nil, max_effective_at: nil, max_payment_date: nil, max_updated_at: nil, min_amount: nil, min_created_at: nil, min_effective_at: nil, min_payment_date: nil, min_updated_at: nil, page_number: nil, page_size: nil, paykey: nil, paykey_id: nil, payment_id: nil, payment_status: nil, payment_type: nil, search_text: nil, sort_by: nil, sort_order: nil, status_reason: nil, status_source: nil, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
226
+ # Some parameter documentations has been truncated, see
227
+ # {Straddle::Models::PaymentListParams} for more details.
228
+ #
183
229
  # @param customer_id [String] Search using the `customer_id` of a `charge` or `payout`.
184
230
  #
185
231
  # @param default_page_size [Integer]
@@ -192,6 +238,16 @@ module Straddle
192
238
  #
193
239
  # @param funding_id [String] Search using the `funding_id` of a `charge` or `payout`.
194
240
  #
241
+ # @param has_refund [Boolean] Has the payment been refunded by an associated payout (only applicable to charge
242
+ #
243
+ # @param has_resubmit [Boolean] Has the payment been resubmitted.
244
+ #
245
+ # @param include_metadata [Boolean] Include the metadata for payments in the returned data.
246
+ #
247
+ # @param is_refund [Boolean] Is the payment a refund of an original charge (only applicable to payouts).
248
+ #
249
+ # @param is_resubmit [Boolean] Is the payment a resubmit of an original payment.
250
+ #
195
251
  # @param max_amount [Integer] Search using a maximum `amount` of a `charge` or `payout`.
196
252
  #
197
253
  # @param max_created_at [Time] Search using the latest `created_at` date of a `charge` or `payout`.
@@ -200,6 +256,8 @@ module Straddle
200
256
  #
201
257
  # @param max_payment_date [Date] Search using the latest `payment_date` of a `charge` or `payout`.
202
258
  #
259
+ # @param max_updated_at [Time] Filter to payments last updated on or before this timestamp.
260
+ #
203
261
  # @param min_amount [Integer] Search using the minimum `amount of a `charge`or`payout`.
204
262
  #
205
263
  # @param min_created_at [Time] Search using the earliest `created_at` date of a `charge` or `payout`.
@@ -208,6 +266,8 @@ module Straddle
208
266
  #
209
267
  # @param min_payment_date [Date] Search using the earliest ` `of a `charge` or `payout`.
210
268
  #
269
+ # @param min_updated_at [Time] Filter to payments last updated on or after this timestamp.
270
+ #
211
271
  # @param page_number [Integer] Results page number. Starts at page 1.
212
272
  #
213
273
  # @param page_size [Integer] Results page size. Max value: 1000
@@ -249,6 +309,7 @@ module Straddle
249
309
  EFFECTIVE_AT = :effective_at
250
310
  ID = :id
251
311
  AMOUNT = :amount
312
+ UPDATED_AT = :updated_at
252
313
 
253
314
  # @!method self.values
254
315
  # @return [Array<Symbol>]
@@ -276,6 +337,7 @@ module Straddle
276
337
  PENDING = :pending
277
338
  PAID = :paid
278
339
  REVERSED = :reversed
340
+ VALIDATING = :validating
279
341
 
280
342
  # @!method self.values
281
343
  # @return [Array<Symbol>]
@@ -301,6 +363,7 @@ module Straddle
301
363
  EFFECTIVE_AT = :effective_at
302
364
  ID = :id
303
365
  AMOUNT = :amount
366
+ UPDATED_AT = :updated_at
304
367
 
305
368
  # @!method self.values
306
369
  # @return [Array<Symbol>]
@@ -339,6 +402,13 @@ module Straddle
339
402
  OK = :ok
340
403
  OTHER_NETWORK_RETURN = :other_network_return
341
404
  PAYOUT_REFUSED = :payout_refused
405
+ CANCEL_REQUEST = :cancel_request
406
+ FAILED_VERIFICATION = :failed_verification
407
+ REQUIRE_REVIEW = :require_review
408
+ BLOCKED_BY_SYSTEM = :blocked_by_system
409
+ WATCHTOWER_REVIEW = :watchtower_review
410
+ VALIDATING = :validating
411
+ AUTO_HOLD = :auto_hold
342
412
 
343
413
  # @!method self.values
344
414
  # @return [Array<Symbol>]
@@ -63,8 +63,8 @@ module Straddle
63
63
  # @!attribute description
64
64
  # An arbitrary description for the `charge` or `payout`.
65
65
  #
66
- # @return [String]
67
- required :description, String
66
+ # @return [String, nil]
67
+ required :description, String, nil?: true
68
68
 
69
69
  # @!attribute external_id
70
70
  # Unique identifier for the `charge` or `payout` in your database. This value must
@@ -79,6 +79,31 @@ module Straddle
79
79
  # @return [Array<String>]
80
80
  required :funding_ids, Straddle::Internal::Type::ArrayOf[String]
81
81
 
82
+ # @!attribute has_refund
83
+ # Has the payment been refunded by an associated payout (only applicable to
84
+ # charges).
85
+ #
86
+ # @return [Boolean]
87
+ required :has_refund, Straddle::Internal::Type::Boolean
88
+
89
+ # @!attribute has_resubmit
90
+ # Has the payment been resubmitted.
91
+ #
92
+ # @return [Boolean]
93
+ required :has_resubmit, Straddle::Internal::Type::Boolean
94
+
95
+ # @!attribute is_refund
96
+ # Is the payment a refund of an original charge (only applicable to payouts).
97
+ #
98
+ # @return [Boolean]
99
+ required :is_refund, Straddle::Internal::Type::Boolean
100
+
101
+ # @!attribute is_resubmit
102
+ # Is the payment a resubmit of an original payment.
103
+ #
104
+ # @return [Boolean]
105
+ required :is_resubmit, Straddle::Internal::Type::Boolean
106
+
82
107
  # @!attribute paykey
83
108
  # Value of the `paykey` used for the `charge` or `payout`.
84
109
  #
@@ -144,13 +169,30 @@ module Straddle
144
169
  # @return [String, nil]
145
170
  optional :funding_id, String, nil?: true
146
171
 
172
+ # @!attribute metadata
173
+ # Metadata for payment - only included if requested.
174
+ #
175
+ # @return [Hash{Symbol=>String}, nil]
176
+ optional :metadata, Straddle::Internal::Type::HashOf[String], nil?: true
177
+
147
178
  # @!attribute paykey_details
148
179
  # Information about the paykey used for the `charge` or `payout`.
149
180
  #
150
181
  # @return [Straddle::Models::PaykeyDetailsV1, nil]
151
182
  optional :paykey_details, -> { Straddle::PaykeyDetailsV1 }
152
183
 
153
- # @!method initialize(id:, amount:, created_at:, currency:, description:, external_id:, funding_ids:, paykey:, payment_date:, payment_type:, status:, status_details:, trace_ids:, updated_at:, customer_details: nil, effective_at: nil, funding_id: nil, paykey_details: nil)
184
+ # @!attribute related_payments
185
+ # Payments related to this one (e.g. refunds, resubmissions), mapped by payment ID
186
+ # to relationship type.
187
+ #
188
+ # @return [Array<Straddle::Models::PaymentSummaryPagedV1::Data::RelatedPayment>, nil]
189
+ optional :related_payments,
190
+ -> {
191
+ Straddle::Internal::Type::ArrayOf[Straddle::PaymentSummaryPagedV1::Data::RelatedPayment]
192
+ },
193
+ nil?: true
194
+
195
+ # @!method initialize(id:, amount:, created_at:, currency:, description:, external_id:, funding_ids:, has_refund:, has_resubmit:, is_refund:, is_resubmit:, paykey:, payment_date:, payment_type:, status:, status_details:, trace_ids:, updated_at:, customer_details: nil, effective_at: nil, funding_id: nil, metadata: nil, paykey_details: nil, related_payments: nil)
154
196
  # Some parameter documentations has been truncated, see
155
197
  # {Straddle::Models::PaymentSummaryPagedV1::Data} for more details.
156
198
  #
@@ -162,12 +204,20 @@ module Straddle
162
204
  #
163
205
  # @param currency [String] The currency of the `charge` or `payout`. Only USD is supported.
164
206
  #
165
- # @param description [String] An arbitrary description for the `charge` or `payout`.
207
+ # @param description [String, nil] An arbitrary description for the `charge` or `payout`.
166
208
  #
167
209
  # @param external_id [String] Unique identifier for the `charge` or `payout` in your database. This value must
168
210
  #
169
211
  # @param funding_ids [Array<String>] Funding ids.
170
212
  #
213
+ # @param has_refund [Boolean] Has the payment been refunded by an associated payout (only applicable to charge
214
+ #
215
+ # @param has_resubmit [Boolean] Has the payment been resubmitted.
216
+ #
217
+ # @param is_refund [Boolean] Is the payment a refund of an original charge (only applicable to payouts).
218
+ #
219
+ # @param is_resubmit [Boolean] Is the payment a resubmit of an original payment.
220
+ #
171
221
  # @param paykey [String] Value of the `paykey` used for the `charge` or `payout`.
172
222
  #
173
223
  # @param payment_date [Date] The desired date on which the payment should be occur. For charges, this means t
@@ -188,7 +238,11 @@ module Straddle
188
238
  #
189
239
  # @param funding_id [String, nil] Unique identifier for the funding event associated with the `charge` or `payout`
190
240
  #
241
+ # @param metadata [Hash{Symbol=>String}, nil] Metadata for payment - only included if requested.
242
+ #
191
243
  # @param paykey_details [Straddle::Models::PaykeyDetailsV1] Information about the paykey used for the `charge` or `payout`.
244
+ #
245
+ # @param related_payments [Array<Straddle::Models::PaymentSummaryPagedV1::Data::RelatedPayment>, nil] Payments related to this one (e.g. refunds, resubmissions), mapped by payment ID
192
246
 
193
247
  # The type of payment. Valid values are `charge` or `payout`.
194
248
  #
@@ -217,10 +271,62 @@ module Straddle
217
271
  PENDING = :pending
218
272
  PAID = :paid
219
273
  REVERSED = :reversed
274
+ VALIDATING = :validating
220
275
 
221
276
  # @!method self.values
222
277
  # @return [Array<Symbol>]
223
278
  end
279
+
280
+ class RelatedPayment < Straddle::Internal::Type::BaseModel
281
+ # @!attribute id
282
+ # The ID of the related payment.
283
+ #
284
+ # @return [String]
285
+ required :id, String
286
+
287
+ # @!attribute payment_type
288
+ # The type of payment.
289
+ #
290
+ # @return [Symbol, Straddle::Models::PaymentSummaryPagedV1::Data::RelatedPayment::PaymentType]
291
+ required :payment_type, enum: -> { Straddle::PaymentSummaryPagedV1::Data::RelatedPayment::PaymentType }
292
+
293
+ # @!attribute relationship
294
+ #
295
+ # @return [Symbol, Straddle::Models::PaymentSummaryPagedV1::Data::RelatedPayment::Relationship]
296
+ required :relationship, enum: -> { Straddle::PaymentSummaryPagedV1::Data::RelatedPayment::Relationship }
297
+
298
+ # @!method initialize(id:, payment_type:, relationship:)
299
+ # @param id [String] The ID of the related payment.
300
+ #
301
+ # @param payment_type [Symbol, Straddle::Models::PaymentSummaryPagedV1::Data::RelatedPayment::PaymentType] The type of payment.
302
+ #
303
+ # @param relationship [Symbol, Straddle::Models::PaymentSummaryPagedV1::Data::RelatedPayment::Relationship]
304
+
305
+ # The type of payment.
306
+ #
307
+ # @see Straddle::Models::PaymentSummaryPagedV1::Data::RelatedPayment#payment_type
308
+ module PaymentType
309
+ extend Straddle::Internal::Type::Enum
310
+
311
+ CHARGE = :charge
312
+ PAYOUT = :payout
313
+
314
+ # @!method self.values
315
+ # @return [Array<Symbol>]
316
+ end
317
+
318
+ # @see Straddle::Models::PaymentSummaryPagedV1::Data::RelatedPayment#relationship
319
+ module Relationship
320
+ extend Straddle::Internal::Type::Enum
321
+
322
+ ORIGINAL = :original
323
+ RESUBMIT = :resubmit
324
+ REFUND = :refund
325
+
326
+ # @!method self.values
327
+ # @return [Array<Symbol>]
328
+ end
329
+ end
224
330
  end
225
331
 
226
332
  # @see Straddle::Models::PaymentSummaryPagedV1#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
  # Details about why the payout status was updated.
12
17
  #
@@ -33,7 +38,9 @@ module Straddle
33
38
  # @return [String, nil]
34
39
  optional :straddle_account_id, String
35
40
 
36
- # @!method initialize(reason:, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
41
+ # @!method initialize(id:, reason:, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
42
+ # @param id [String]
43
+ #
37
44
  # @param reason [String] Details about why the payout status was updated.
38
45
  #
39
46
  # @param correlation_id [String]
@@ -22,8 +22,8 @@ module Straddle
22
22
  # @!attribute description
23
23
  # An arbitrary description for the payout.
24
24
  #
25
- # @return [String]
26
- required :description, String
25
+ # @return [String, nil]
26
+ required :description, String, nil?: true
27
27
 
28
28
  # @!attribute device
29
29
  # Information about the device used when the customer authorized the payout.
@@ -91,7 +91,7 @@ module Straddle
91
91
  #
92
92
  # @param currency [String] The currency of the payout. Only USD is supported.
93
93
  #
94
- # @param description [String] An arbitrary description for the payout.
94
+ # @param description [String, nil] An arbitrary description for the payout.
95
95
  #
96
96
  # @param device [Straddle::Models::DeviceInfoV1] Information about the device used when the customer authorized the payout.
97
97
  #
@@ -116,13 +116,29 @@ module Straddle
116
116
  # @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}]
117
117
 
118
118
  class Config < Straddle::Internal::Type::BaseModel
119
+ # @!attribute auto_hold
120
+ # Defines whether to automatically place this charge on hold after being created.
121
+ #
122
+ # @return [Boolean, nil]
123
+ optional :auto_hold, Straddle::Internal::Type::Boolean, nil?: true
124
+
125
+ # @!attribute auto_hold_message
126
+ # The reason the payout is being automatically held on creation.
127
+ #
128
+ # @return [String, nil]
129
+ optional :auto_hold_message, String, nil?: true
130
+
119
131
  # @!attribute sandbox_outcome
120
132
  # Payment will simulate processing if not Standard.
121
133
  #
122
134
  # @return [Symbol, Straddle::Models::PayoutCreateParams::Config::SandboxOutcome, nil]
123
135
  optional :sandbox_outcome, enum: -> { Straddle::PayoutCreateParams::Config::SandboxOutcome }
124
136
 
125
- # @!method initialize(sandbox_outcome: nil)
137
+ # @!method initialize(auto_hold: nil, auto_hold_message: nil, sandbox_outcome: nil)
138
+ # @param auto_hold [Boolean, nil] Defines whether to automatically place this charge on hold after being created.
139
+ #
140
+ # @param auto_hold_message [String, nil] The reason the payout is being automatically held on creation.
141
+ #
126
142
  # @param sandbox_outcome [Symbol, Straddle::Models::PayoutCreateParams::Config::SandboxOutcome] Payment will simulate processing if not Standard.
127
143
 
128
144
  # Payment will simulate processing if not Standard.
@@ -142,6 +158,8 @@ module Straddle
142
158
  REVERSED_CUSTOMER_DISPUTE = :reversed_customer_dispute
143
159
  FAILED_CLOSED_BANK_ACCOUNT = :failed_closed_bank_account
144
160
  REVERSED_CLOSED_BANK_ACCOUNT = :reversed_closed_bank_account
161
+ FAILED_NOT_AUTHORIZED = :failed_not_authorized
162
+ REVERSED_NOT_AUTHORIZED = :reversed_not_authorized
145
163
 
146
164
  # @!method self.values
147
165
  # @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]
@@ -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
  # Details about why the payout status was updated.
12
17
  #
@@ -33,7 +38,9 @@ module Straddle
33
38
  # @return [String, nil]
34
39
  optional :straddle_account_id, String
35
40
 
36
- # @!method initialize(reason:, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
41
+ # @!method initialize(id:, reason:, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
42
+ # @param id [String]
43
+ #
37
44
  # @param reason [String] Details about why the payout status was updated.
38
45
  #
39
46
  # @param correlation_id [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 reason
11
16
  # Details about why the payout status was updated.
12
17
  #
@@ -33,7 +38,9 @@ module Straddle
33
38
  # @return [String, nil]
34
39
  optional :straddle_account_id, String
35
40
 
36
- # @!method initialize(reason:, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
41
+ # @!method initialize(id:, reason:, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
42
+ # @param id [String]
43
+ #
37
44
  # @param reason [String] Details about why the payout status was updated.
38
45
  #
39
46
  # @param correlation_id [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]