straddle 0.1.1 → 0.2.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 (193) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +43 -0
  3. data/README.md +2 -2
  4. data/SECURITY.md +1 -1
  5. data/lib/straddle/client.rb +3 -3
  6. data/lib/straddle/errors.rb +25 -11
  7. data/lib/straddle/file_part.rb +10 -7
  8. data/lib/straddle/internal/page_number_schema.rb +1 -1
  9. data/lib/straddle/internal/transport/base_client.rb +12 -8
  10. data/lib/straddle/internal/transport/pooled_net_requester.rb +8 -19
  11. data/lib/straddle/internal/type/array_of.rb +1 -0
  12. data/lib/straddle/internal/type/base_model.rb +4 -9
  13. data/lib/straddle/internal/type/base_page.rb +1 -1
  14. data/lib/straddle/internal/type/converter.rb +27 -0
  15. data/lib/straddle/internal/type/file_input.rb +7 -4
  16. data/lib/straddle/internal/type/hash_of.rb +1 -0
  17. data/lib/straddle/internal/type/union.rb +9 -7
  18. data/lib/straddle/internal/util.rb +4 -3
  19. data/lib/straddle/models/bridge/link_bank_account_params.rb +9 -5
  20. data/lib/straddle/models/bridge/link_create_paykey_params.rb +9 -5
  21. data/lib/straddle/models/bridge/link_create_tan_params.rb +9 -5
  22. data/lib/straddle/models/bridge/link_plaid_params.rb +8 -1
  23. data/lib/straddle/models/bridge_initialize_params.rb +8 -1
  24. data/lib/straddle/models/charge_cancel_params.rb +8 -1
  25. data/lib/straddle/models/charge_create_params.rb +8 -1
  26. data/lib/straddle/models/charge_hold_params.rb +8 -1
  27. data/lib/straddle/models/charge_release_params.rb +8 -1
  28. data/lib/straddle/models/charge_update_params.rb +8 -1
  29. data/lib/straddle/models/customer_create_params.rb +8 -1
  30. data/lib/straddle/models/customer_delete_params.rb +7 -1
  31. data/lib/straddle/models/customer_refresh_review_params.rb +7 -1
  32. data/lib/straddle/models/customer_unmasked_v1.rb +1 -4
  33. data/lib/straddle/models/customer_update_params.rb +8 -1
  34. data/lib/straddle/models/customers/customer_review_v1.rb +15 -50
  35. data/lib/straddle/models/customers/review_decision_params.rb +8 -1
  36. data/lib/straddle/models/embed/account_create_params.rb +8 -1
  37. data/lib/straddle/models/embed/account_onboard_params.rb +7 -1
  38. data/lib/straddle/models/embed/account_paged_v1.rb +3 -12
  39. data/lib/straddle/models/embed/account_simulate_params.rb +7 -1
  40. data/lib/straddle/models/embed/account_update_params.rb +8 -1
  41. data/lib/straddle/models/embed/account_v1.rb +2 -8
  42. data/lib/straddle/models/embed/accounts/capability_request_create_params.rb +8 -1
  43. data/lib/straddle/models/embed/accounts/capability_request_paged_v1.rb +3 -11
  44. data/lib/straddle/models/embed/linked_bank_account_cancel_params.rb +34 -0
  45. data/lib/straddle/models/embed/linked_bank_account_create_params.rb +51 -4
  46. data/lib/straddle/models/embed/linked_bank_account_paged_v1.rb +33 -13
  47. data/lib/straddle/models/embed/linked_bank_account_unmask_v1.rb +3 -8
  48. data/lib/straddle/models/embed/linked_bank_account_update_params.rb +8 -1
  49. data/lib/straddle/models/embed/linked_bank_account_v1.rb +30 -1
  50. data/lib/straddle/models/embed/organization_create_params.rb +8 -1
  51. data/lib/straddle/models/embed/representative.rb +10 -1
  52. data/lib/straddle/models/embed/representative_create_params.rb +17 -1
  53. data/lib/straddle/models/embed/representative_paged.rb +10 -1
  54. data/lib/straddle/models/embed/representative_update_params.rb +17 -1
  55. data/lib/straddle/models/paykey_cancel_params.rb +7 -1
  56. data/lib/straddle/models/paykey_review_params.rb +54 -0
  57. data/lib/straddle/models/payout_cancel_params.rb +8 -1
  58. data/lib/straddle/models/payout_create_params.rb +8 -1
  59. data/lib/straddle/models/payout_hold_params.rb +8 -1
  60. data/lib/straddle/models/payout_release_params.rb +8 -1
  61. data/lib/straddle/models/payout_update_params.rb +8 -1
  62. data/lib/straddle/models.rb +2 -0
  63. data/lib/straddle/resources/bridge/link.rb +16 -4
  64. data/lib/straddle/resources/bridge.rb +4 -1
  65. data/lib/straddle/resources/charges.rb +20 -5
  66. data/lib/straddle/resources/customers/review.rb +4 -1
  67. data/lib/straddle/resources/customers.rb +16 -4
  68. data/lib/straddle/resources/embed/accounts/capability_requests.rb +5 -2
  69. data/lib/straddle/resources/embed/accounts.rb +19 -7
  70. data/lib/straddle/resources/embed/linked_bank_accounts.rb +51 -5
  71. data/lib/straddle/resources/embed/organizations.rb +5 -2
  72. data/lib/straddle/resources/embed/representatives.rb +14 -4
  73. data/lib/straddle/resources/paykeys.rb +47 -1
  74. data/lib/straddle/resources/payouts.rb +20 -5
  75. data/lib/straddle/version.rb +1 -1
  76. data/lib/straddle.rb +2 -0
  77. data/rbi/straddle/client.rbi +4 -4
  78. data/rbi/straddle/errors.rbi +31 -4
  79. data/rbi/straddle/file_part.rbi +1 -1
  80. data/rbi/straddle/internal/transport/base_client.rbi +5 -6
  81. data/rbi/straddle/internal/type/base_page.rbi +1 -1
  82. data/rbi/straddle/internal/type/converter.rbi +54 -0
  83. data/rbi/straddle/internal/type/union.rbi +9 -2
  84. data/rbi/straddle/internal/util.rbi +1 -1
  85. data/rbi/straddle/models/bridge/link_bank_account_params.rbi +9 -0
  86. data/rbi/straddle/models/bridge/link_create_paykey_params.rbi +9 -0
  87. data/rbi/straddle/models/bridge/link_create_tan_params.rbi +9 -0
  88. data/rbi/straddle/models/bridge/link_plaid_params.rbi +9 -0
  89. data/rbi/straddle/models/bridge_initialize_params.rbi +9 -0
  90. data/rbi/straddle/models/charge_cancel_params.rbi +9 -0
  91. data/rbi/straddle/models/charge_create_params.rbi +9 -0
  92. data/rbi/straddle/models/charge_hold_params.rbi +9 -0
  93. data/rbi/straddle/models/charge_release_params.rbi +9 -0
  94. data/rbi/straddle/models/charge_update_params.rbi +9 -0
  95. data/rbi/straddle/models/customer_create_params.rbi +9 -0
  96. data/rbi/straddle/models/customer_delete_params.rbi +9 -0
  97. data/rbi/straddle/models/customer_refresh_review_params.rbi +9 -0
  98. data/rbi/straddle/models/customer_update_params.rbi +9 -0
  99. data/rbi/straddle/models/customers/review_decision_params.rbi +9 -0
  100. data/rbi/straddle/models/embed/account_create_params.rbi +9 -0
  101. data/rbi/straddle/models/embed/account_onboard_params.rbi +9 -0
  102. data/rbi/straddle/models/embed/account_simulate_params.rbi +9 -0
  103. data/rbi/straddle/models/embed/account_update_params.rbi +9 -0
  104. data/rbi/straddle/models/embed/accounts/capability_request_create_params.rbi +9 -0
  105. data/rbi/straddle/models/embed/linked_bank_account_cancel_params.rbi +67 -0
  106. data/rbi/straddle/models/embed/linked_bank_account_create_params.rbi +95 -3
  107. data/rbi/straddle/models/embed/linked_bank_account_paged_v1.rbi +72 -0
  108. data/rbi/straddle/models/embed/linked_bank_account_unmask_v1.rbi +5 -0
  109. data/rbi/straddle/models/embed/linked_bank_account_update_params.rbi +9 -0
  110. data/rbi/straddle/models/embed/linked_bank_account_v1.rbi +72 -0
  111. data/rbi/straddle/models/embed/organization_create_params.rbi +9 -0
  112. data/rbi/straddle/models/embed/representative.rbi +10 -0
  113. data/rbi/straddle/models/embed/representative_create_params.rbi +19 -0
  114. data/rbi/straddle/models/embed/representative_paged.rbi +10 -0
  115. data/rbi/straddle/models/embed/representative_update_params.rbi +19 -0
  116. data/rbi/straddle/models/paykey_cancel_params.rbi +9 -0
  117. data/rbi/straddle/models/paykey_review_params.rbi +98 -0
  118. data/rbi/straddle/models/payout_cancel_params.rbi +9 -0
  119. data/rbi/straddle/models/payout_create_params.rbi +9 -0
  120. data/rbi/straddle/models/payout_hold_params.rbi +9 -0
  121. data/rbi/straddle/models/payout_release_params.rbi +9 -0
  122. data/rbi/straddle/models/payout_update_params.rbi +9 -0
  123. data/rbi/straddle/models.rbi +2 -0
  124. data/rbi/straddle/resources/bridge/link.rbi +12 -0
  125. data/rbi/straddle/resources/bridge.rbi +3 -0
  126. data/rbi/straddle/resources/charges.rbi +15 -0
  127. data/rbi/straddle/resources/customers/review.rbi +3 -0
  128. data/rbi/straddle/resources/customers.rbi +12 -0
  129. data/rbi/straddle/resources/embed/accounts/capability_requests.rbi +3 -0
  130. data/rbi/straddle/resources/embed/accounts.rbi +12 -0
  131. data/rbi/straddle/resources/embed/linked_bank_accounts.rbi +46 -1
  132. data/rbi/straddle/resources/embed/organizations.rbi +3 -0
  133. data/rbi/straddle/resources/embed/representatives.rbi +14 -0
  134. data/rbi/straddle/resources/paykeys.rbi +34 -0
  135. data/rbi/straddle/resources/payouts.rbi +15 -0
  136. data/sig/straddle/client.rbs +2 -2
  137. data/sig/straddle/errors.rbs +7 -0
  138. data/sig/straddle/file_part.rbs +1 -1
  139. data/sig/straddle/internal/transport/base_client.rbs +1 -1
  140. data/sig/straddle/internal/type/converter.rbs +17 -0
  141. data/sig/straddle/internal/type/union.rbs +2 -2
  142. data/sig/straddle/models/bridge/link_bank_account_params.rbs +7 -0
  143. data/sig/straddle/models/bridge/link_create_paykey_params.rbs +7 -0
  144. data/sig/straddle/models/bridge/link_create_tan_params.rbs +7 -0
  145. data/sig/straddle/models/bridge/link_plaid_params.rbs +7 -0
  146. data/sig/straddle/models/bridge_initialize_params.rbs +7 -0
  147. data/sig/straddle/models/charge_cancel_params.rbs +7 -0
  148. data/sig/straddle/models/charge_create_params.rbs +7 -0
  149. data/sig/straddle/models/charge_hold_params.rbs +7 -0
  150. data/sig/straddle/models/charge_release_params.rbs +7 -0
  151. data/sig/straddle/models/charge_update_params.rbs +7 -0
  152. data/sig/straddle/models/customer_create_params.rbs +7 -0
  153. data/sig/straddle/models/customer_delete_params.rbs +7 -0
  154. data/sig/straddle/models/customer_refresh_review_params.rbs +7 -0
  155. data/sig/straddle/models/customer_update_params.rbs +7 -0
  156. data/sig/straddle/models/customers/review_decision_params.rbs +7 -0
  157. data/sig/straddle/models/embed/account_create_params.rbs +7 -0
  158. data/sig/straddle/models/embed/account_onboard_params.rbs +7 -0
  159. data/sig/straddle/models/embed/account_simulate_params.rbs +7 -0
  160. data/sig/straddle/models/embed/account_update_params.rbs +7 -0
  161. data/sig/straddle/models/embed/accounts/capability_request_create_params.rbs +7 -0
  162. data/sig/straddle/models/embed/linked_bank_account_cancel_params.rbs +40 -0
  163. data/sig/straddle/models/embed/linked_bank_account_create_params.rbs +38 -4
  164. data/sig/straddle/models/embed/linked_bank_account_paged_v1.rbs +25 -1
  165. data/sig/straddle/models/embed/linked_bank_account_unmask_v1.rbs +3 -1
  166. data/sig/straddle/models/embed/linked_bank_account_update_params.rbs +7 -0
  167. data/sig/straddle/models/embed/linked_bank_account_v1.rbs +25 -1
  168. data/sig/straddle/models/embed/organization_create_params.rbs +7 -0
  169. data/sig/straddle/models/embed/representative.rbs +5 -0
  170. data/sig/straddle/models/embed/representative_create_params.rbs +12 -0
  171. data/sig/straddle/models/embed/representative_paged.rbs +5 -0
  172. data/sig/straddle/models/embed/representative_update_params.rbs +12 -0
  173. data/sig/straddle/models/paykey_cancel_params.rbs +7 -0
  174. data/sig/straddle/models/paykey_review_params.rbs +65 -0
  175. data/sig/straddle/models/payout_cancel_params.rbs +7 -0
  176. data/sig/straddle/models/payout_create_params.rbs +7 -0
  177. data/sig/straddle/models/payout_hold_params.rbs +7 -0
  178. data/sig/straddle/models/payout_release_params.rbs +7 -0
  179. data/sig/straddle/models/payout_update_params.rbs +7 -0
  180. data/sig/straddle/models.rbs +2 -0
  181. data/sig/straddle/resources/bridge/link.rbs +4 -0
  182. data/sig/straddle/resources/bridge.rbs +1 -0
  183. data/sig/straddle/resources/charges.rbs +5 -0
  184. data/sig/straddle/resources/customers/review.rbs +1 -0
  185. data/sig/straddle/resources/customers.rbs +4 -0
  186. data/sig/straddle/resources/embed/accounts/capability_requests.rbs +1 -0
  187. data/sig/straddle/resources/embed/accounts.rbs +4 -0
  188. data/sig/straddle/resources/embed/linked_bank_accounts.rbs +14 -1
  189. data/sig/straddle/resources/embed/organizations.rbs +1 -0
  190. data/sig/straddle/resources/embed/representatives.rbs +4 -0
  191. data/sig/straddle/resources/paykeys.rbs +11 -0
  192. data/sig/straddle/resources/payouts.rbs +5 -0
  193. metadata +9 -3
@@ -35,6 +35,12 @@ module Straddle
35
35
  sig { params(correlation_id: String).void }
36
36
  attr_writer :correlation_id
37
37
 
38
+ sig { returns(T.nilable(String)) }
39
+ attr_reader :idempotency_key
40
+
41
+ sig { params(idempotency_key: String).void }
42
+ attr_writer :idempotency_key
43
+
38
44
  sig { returns(T.nilable(String)) }
39
45
  attr_reader :request_id
40
46
 
@@ -54,6 +60,7 @@ module Straddle
54
60
  payment_date: Date,
55
61
  metadata: T.nilable(T::Hash[Symbol, String]),
56
62
  correlation_id: String,
63
+ idempotency_key: String,
57
64
  request_id: String,
58
65
  straddle_account_id: String,
59
66
  request_options: Straddle::RequestOptions::OrHash
@@ -71,6 +78,7 @@ module Straddle
71
78
  # information about the payout in a structured format.
72
79
  metadata: nil,
73
80
  correlation_id: nil,
81
+ idempotency_key: nil,
74
82
  request_id: nil,
75
83
  straddle_account_id: nil,
76
84
  request_options: {}
@@ -85,6 +93,7 @@ module Straddle
85
93
  payment_date: Date,
86
94
  metadata: T.nilable(T::Hash[Symbol, String]),
87
95
  correlation_id: String,
96
+ idempotency_key: String,
88
97
  request_id: String,
89
98
  straddle_account_id: String,
90
99
  request_options: Straddle::RequestOptions
@@ -75,6 +75,8 @@ module Straddle
75
75
 
76
76
  PaykeyRevealParams = Straddle::Models::PaykeyRevealParams
77
77
 
78
+ PaykeyReviewParams = Straddle::Models::PaykeyReviewParams
79
+
78
80
  PaykeySummaryPagedV1 = Straddle::Models::PaykeySummaryPagedV1
79
81
 
80
82
  PaykeyUnmaskedParams = Straddle::Models::PaykeyUnmaskedParams
@@ -17,6 +17,7 @@ module Straddle
17
17
  config: Straddle::Bridge::LinkBankAccountParams::Config::OrHash,
18
18
  metadata: T.nilable(T::Hash[Symbol, String]),
19
19
  correlation_id: String,
20
+ idempotency_key: String,
20
21
  request_id: String,
21
22
  straddle_account_id: String,
22
23
  request_options: Straddle::RequestOptions::OrHash
@@ -39,6 +40,8 @@ module Straddle
39
40
  # Header param: Optional client generated identifier to trace and debug a series
40
41
  # of requests.
41
42
  correlation_id: nil,
43
+ # Header param: Optional client generated value to use for idempotent requests.
44
+ idempotency_key: nil,
42
45
  # Header param: Optional client generated identifier to trace and debug a request.
43
46
  request_id: nil,
44
47
  # Header param: For use by platforms to specify an account id and set scope of a
@@ -58,6 +61,7 @@ module Straddle
58
61
  config: Straddle::Bridge::LinkCreatePaykeyParams::Config::OrHash,
59
62
  metadata: T.nilable(T::Hash[Symbol, String]),
60
63
  correlation_id: String,
64
+ idempotency_key: String,
61
65
  request_id: String,
62
66
  straddle_account_id: String,
63
67
  request_options: Straddle::RequestOptions::OrHash
@@ -77,6 +81,8 @@ module Straddle
77
81
  # Header param: Optional client generated identifier to trace and debug a series
78
82
  # of requests.
79
83
  correlation_id: nil,
84
+ # Header param: Optional client generated value to use for idempotent requests.
85
+ idempotency_key: nil,
80
86
  # Header param: Optional client generated identifier to trace and debug a request.
81
87
  request_id: nil,
82
88
  # Header param: For use by platforms to specify an account id and set scope of a
@@ -96,6 +102,7 @@ module Straddle
96
102
  config: Straddle::Bridge::LinkCreateTanParams::Config::OrHash,
97
103
  metadata: T.nilable(T::Hash[Symbol, String]),
98
104
  correlation_id: String,
105
+ idempotency_key: String,
99
106
  request_id: String,
100
107
  straddle_account_id: String,
101
108
  request_options: Straddle::RequestOptions::OrHash
@@ -118,6 +125,8 @@ module Straddle
118
125
  # Header param: Optional client generated identifier to trace and debug a series
119
126
  # of requests.
120
127
  correlation_id: nil,
128
+ # Header param: Optional client generated value to use for idempotent requests.
129
+ idempotency_key: nil,
121
130
  # Header param: Optional client generated identifier to trace and debug a request.
122
131
  request_id: nil,
123
132
  # Header param: For use by platforms to specify an account id and set scope of a
@@ -137,6 +146,7 @@ module Straddle
137
146
  config: Straddle::Bridge::LinkPlaidParams::Config::OrHash,
138
147
  metadata: T.nilable(T::Hash[Symbol, String]),
139
148
  correlation_id: String,
149
+ idempotency_key: String,
140
150
  request_id: String,
141
151
  straddle_account_id: String,
142
152
  request_options: Straddle::RequestOptions::OrHash
@@ -156,6 +166,8 @@ module Straddle
156
166
  # Header param: Optional client generated identifier to trace and debug a series
157
167
  # of requests.
158
168
  correlation_id: nil,
169
+ # Header param: Optional client generated value to use for idempotent requests.
170
+ idempotency_key: nil,
159
171
  # Header param: Optional client generated identifier to trace and debug a request.
160
172
  request_id: nil,
161
173
  # Header param: For use by platforms to specify an account id and set scope of a
@@ -12,6 +12,7 @@ module Straddle
12
12
  customer_id: String,
13
13
  config: Straddle::BridgeInitializeParams::Config::OrHash,
14
14
  correlation_id: String,
15
+ idempotency_key: String,
15
16
  request_id: String,
16
17
  straddle_account_id: String,
17
18
  request_options: Straddle::RequestOptions::OrHash
@@ -26,6 +27,8 @@ module Straddle
26
27
  # Header param: Optional client generated identifier to trace and debug a series
27
28
  # of requests.
28
29
  correlation_id: nil,
30
+ # Header param: Optional client generated value to use for idempotent requests.
31
+ idempotency_key: nil,
29
32
  # Header param: Optional client generated identifier to trace and debug a request.
30
33
  request_id: nil,
31
34
  # Header param: For use by platforms to specify an account id and set scope of a
@@ -17,6 +17,7 @@ module Straddle
17
17
  payment_date: Date,
18
18
  metadata: T.nilable(T::Hash[Symbol, String]),
19
19
  correlation_id: String,
20
+ idempotency_key: String,
20
21
  request_id: String,
21
22
  straddle_account_id: String,
22
23
  request_options: Straddle::RequestOptions::OrHash
@@ -52,6 +53,8 @@ module Straddle
52
53
  # Header param: Optional client generated identifier to trace and debug a series
53
54
  # of requests.
54
55
  correlation_id: nil,
56
+ # Header param: Optional client generated value to use for idempotent requests.
57
+ idempotency_key: nil,
55
58
  # Header param: Optional client generated identifier to trace and debug a request.
56
59
  request_id: nil,
57
60
  # Header param: For use by platforms to specify an account id and set scope of a
@@ -71,6 +74,7 @@ module Straddle
71
74
  payment_date: Date,
72
75
  metadata: T.nilable(T::Hash[Symbol, String]),
73
76
  correlation_id: String,
77
+ idempotency_key: String,
74
78
  request_id: String,
75
79
  straddle_account_id: String,
76
80
  request_options: Straddle::RequestOptions::OrHash
@@ -92,6 +96,8 @@ module Straddle
92
96
  # Header param: Optional client generated identifier to trace and debug a series
93
97
  # of requests.
94
98
  correlation_id: nil,
99
+ # Header param: Optional client generated value to use for idempotent requests.
100
+ idempotency_key: nil,
95
101
  # Header param: Optional client generated identifier to trace and debug a request.
96
102
  request_id: nil,
97
103
  # Header param: For use by platforms to specify an account id and set scope of a
@@ -108,6 +114,7 @@ module Straddle
108
114
  id: String,
109
115
  reason: T.nilable(String),
110
116
  correlation_id: String,
117
+ idempotency_key: String,
111
118
  request_id: String,
112
119
  straddle_account_id: String,
113
120
  request_options: Straddle::RequestOptions::OrHash
@@ -121,6 +128,8 @@ module Straddle
121
128
  # Header param: Optional client generated identifier to trace and debug a series
122
129
  # of requests.
123
130
  correlation_id: nil,
131
+ # Header param: Optional client generated value to use for idempotent requests.
132
+ idempotency_key: nil,
124
133
  # Header param: Optional client generated identifier to trace and debug a request.
125
134
  request_id: nil,
126
135
  # Header param: For use by platforms to specify an account id and set scope of a
@@ -160,6 +169,7 @@ module Straddle
160
169
  id: String,
161
170
  reason: T.nilable(String),
162
171
  correlation_id: String,
172
+ idempotency_key: String,
163
173
  request_id: String,
164
174
  straddle_account_id: String,
165
175
  request_options: Straddle::RequestOptions::OrHash
@@ -173,6 +183,8 @@ module Straddle
173
183
  # Header param: Optional client generated identifier to trace and debug a series
174
184
  # of requests.
175
185
  correlation_id: nil,
186
+ # Header param: Optional client generated value to use for idempotent requests.
187
+ idempotency_key: nil,
176
188
  # Header param: Optional client generated identifier to trace and debug a request.
177
189
  request_id: nil,
178
190
  # Header param: For use by platforms to specify an account id and set scope of a
@@ -189,6 +201,7 @@ module Straddle
189
201
  id: String,
190
202
  reason: T.nilable(String),
191
203
  correlation_id: String,
204
+ idempotency_key: String,
192
205
  request_id: String,
193
206
  straddle_account_id: String,
194
207
  request_options: Straddle::RequestOptions::OrHash
@@ -202,6 +215,8 @@ module Straddle
202
215
  # Header param: Optional client generated identifier to trace and debug a series
203
216
  # of requests.
204
217
  correlation_id: nil,
218
+ # Header param: Optional client generated value to use for idempotent requests.
219
+ idempotency_key: nil,
205
220
  # Header param: Optional client generated identifier to trace and debug a request.
206
221
  request_id: nil,
207
222
  # Header param: For use by platforms to specify an account id and set scope of a
@@ -13,6 +13,7 @@ module Straddle
13
13
  id: String,
14
14
  status: Straddle::Customers::ReviewDecisionParams::Status::OrSymbol,
15
15
  correlation_id: String,
16
+ idempotency_key: String,
16
17
  request_id: String,
17
18
  straddle_account_id: String,
18
19
  request_options: Straddle::RequestOptions::OrHash
@@ -26,6 +27,8 @@ module Straddle
26
27
  # Header param: Optional client generated identifier to trace and debug a series
27
28
  # of requests.
28
29
  correlation_id: nil,
30
+ # Header param: Optional client generated value to use for idempotent requests.
31
+ idempotency_key: nil,
29
32
  # Header param: Optional client generated identifier to trace and debug a request.
30
33
  request_id: nil,
31
34
  # Header param: For use by platforms to specify an account id and set scope of a
@@ -28,6 +28,7 @@ module Straddle
28
28
  external_id: T.nilable(String),
29
29
  metadata: T.nilable(T::Hash[Symbol, String]),
30
30
  correlation_id: String,
31
+ idempotency_key: String,
31
32
  request_id: String,
32
33
  straddle_account_id: String,
33
34
  request_options: Straddle::RequestOptions::OrHash
@@ -63,6 +64,8 @@ module Straddle
63
64
  # Header param: Optional client generated identifier to trace and debug a series
64
65
  # of requests.
65
66
  correlation_id: nil,
67
+ # Header param: Optional client generated value to use for idempotent requests.
68
+ idempotency_key: nil,
66
69
  # Header param: Optional client generated identifier to trace and debug a request.
67
70
  request_id: nil,
68
71
  # Header param: For use by platforms to specify an account id and set scope of a
@@ -93,6 +96,7 @@ module Straddle
93
96
  external_id: T.nilable(String),
94
97
  metadata: T.nilable(T::Hash[Symbol, String]),
95
98
  correlation_id: String,
99
+ idempotency_key: String,
96
100
  request_id: String,
97
101
  straddle_account_id: String,
98
102
  request_options: Straddle::RequestOptions::OrHash
@@ -126,6 +130,8 @@ module Straddle
126
130
  # Header param: Optional client generated identifier to trace and debug a series
127
131
  # of requests.
128
132
  correlation_id: nil,
133
+ # Header param: Optional client generated value to use for idempotent requests.
134
+ idempotency_key: nil,
129
135
  # Header param: Optional client generated identifier to trace and debug a request.
130
136
  request_id: nil,
131
137
  # Header param: For use by platforms to specify an account id and set scope of a
@@ -207,6 +213,7 @@ module Straddle
207
213
  params(
208
214
  id: String,
209
215
  correlation_id: String,
216
+ idempotency_key: String,
210
217
  request_id: String,
211
218
  straddle_account_id: String,
212
219
  request_options: Straddle::RequestOptions::OrHash
@@ -216,6 +223,8 @@ module Straddle
216
223
  id,
217
224
  # Optional client generated identifier to trace and debug a series of requests.
218
225
  correlation_id: nil,
226
+ # Optional client generated value to use for idempotent requests.
227
+ idempotency_key: nil,
219
228
  # Optional client generated identifier to trace and debug a request.
220
229
  request_id: nil,
221
230
  # For use by platforms to specify an account id and set scope of a request.
@@ -255,6 +264,7 @@ module Straddle
255
264
  params(
256
265
  id: String,
257
266
  correlation_id: String,
267
+ idempotency_key: String,
258
268
  request_id: String,
259
269
  straddle_account_id: String,
260
270
  request_options: Straddle::RequestOptions::OrHash
@@ -264,6 +274,8 @@ module Straddle
264
274
  id,
265
275
  # Optional client generated identifier to trace and debug a series of requests.
266
276
  correlation_id: nil,
277
+ # Optional client generated value to use for idempotent requests.
278
+ idempotency_key: nil,
267
279
  # Optional client generated identifier to trace and debug a request.
268
280
  request_id: nil,
269
281
  # For use by platforms to specify an account id and set scope of a request.
@@ -23,6 +23,7 @@ module Straddle
23
23
  signed_agreement:
24
24
  Straddle::Embed::Accounts::CapabilityRequestCreateParams::SignedAgreement::OrHash,
25
25
  correlation_id: String,
26
+ idempotency_key: String,
26
27
  request_id: String,
27
28
  request_options: Straddle::RequestOptions::OrHash
28
29
  ).returns(Straddle::Embed::Accounts::CapabilityRequestPagedV1)
@@ -47,6 +48,8 @@ module Straddle
47
48
  # Header param: Optional client generated identifier to trace and debug a series
48
49
  # of requests.
49
50
  correlation_id: nil,
51
+ # Header param: Optional client generated value to use for idempotent requests.
52
+ idempotency_key: nil,
50
53
  # Header param: Optional client generated identifier to trace and debug a request.
51
54
  request_id: nil,
52
55
  request_options: {}
@@ -23,6 +23,7 @@ module Straddle
23
23
  external_id: T.nilable(String),
24
24
  metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
25
25
  correlation_id: String,
26
+ idempotency_key: String,
26
27
  request_id: String,
27
28
  request_options: Straddle::RequestOptions::OrHash
28
29
  ).returns(Straddle::Embed::AccountV1)
@@ -47,6 +48,8 @@ module Straddle
47
48
  # Header param: Optional client generated identifier to trace and debug a series
48
49
  # of requests.
49
50
  correlation_id: nil,
51
+ # Header param: Optional client generated value to use for idempotent requests.
52
+ idempotency_key: nil,
50
53
  # Header param: Optional client generated identifier to trace and debug a request.
51
54
  request_id: nil,
52
55
  request_options: {}
@@ -62,6 +65,7 @@ module Straddle
62
65
  external_id: T.nilable(String),
63
66
  metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
64
67
  correlation_id: String,
68
+ idempotency_key: String,
65
69
  request_id: String,
66
70
  request_options: Straddle::RequestOptions::OrHash
67
71
  ).returns(Straddle::Embed::AccountV1)
@@ -80,6 +84,8 @@ module Straddle
80
84
  # Header param: Optional client generated identifier to trace and debug a series
81
85
  # of requests.
82
86
  correlation_id: nil,
87
+ # Header param: Optional client generated value to use for idempotent requests.
88
+ idempotency_key: nil,
83
89
  # Header param: Optional client generated identifier to trace and debug a request.
84
90
  request_id: nil,
85
91
  request_options: {}
@@ -162,6 +168,7 @@ module Straddle
162
168
  account_id: String,
163
169
  terms_of_service: Straddle::Embed::TermsOfServiceV1::OrHash,
164
170
  correlation_id: String,
171
+ idempotency_key: String,
165
172
  request_id: String,
166
173
  request_options: Straddle::RequestOptions::OrHash
167
174
  ).returns(Straddle::Embed::AccountV1)
@@ -174,6 +181,8 @@ module Straddle
174
181
  # Header param: Optional client generated identifier to trace and debug a series
175
182
  # of requests.
176
183
  correlation_id: nil,
184
+ # Header param: Optional client generated value to use for idempotent requests.
185
+ idempotency_key: nil,
177
186
  # Header param: Optional client generated identifier to trace and debug a request.
178
187
  request_id: nil,
179
188
  request_options: {}
@@ -188,6 +197,7 @@ module Straddle
188
197
  final_status:
189
198
  Straddle::Embed::AccountSimulateParams::FinalStatus::OrSymbol,
190
199
  correlation_id: String,
200
+ idempotency_key: String,
191
201
  request_id: String,
192
202
  request_options: Straddle::RequestOptions::OrHash
193
203
  ).returns(Straddle::Embed::AccountV1)
@@ -200,6 +210,8 @@ module Straddle
200
210
  # Header param: Optional client generated identifier to trace and debug a series
201
211
  # of requests.
202
212
  correlation_id: nil,
213
+ # Header param: Optional client generated value to use for idempotent requests.
214
+ idempotency_key: nil,
203
215
  # Header param: Optional client generated identifier to trace and debug a request.
204
216
  request_id: nil,
205
217
  request_options: {}
@@ -10,11 +10,20 @@ module Straddle
10
10
  # more.
11
11
  sig do
12
12
  params(
13
- account_id: String,
13
+ account_id: T.nilable(String),
14
14
  bank_account:
15
15
  Straddle::Embed::LinkedBankAccountCreateParams::BankAccount::OrHash,
16
+ description: T.nilable(String),
16
17
  metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
18
+ platform_id: T.nilable(String),
19
+ purposes:
20
+ T.nilable(
21
+ T::Array[
22
+ Straddle::Embed::LinkedBankAccountCreateParams::Purpose::OrSymbol
23
+ ]
24
+ ),
17
25
  correlation_id: String,
26
+ idempotency_key: String,
18
27
  request_id: String,
19
28
  request_options: Straddle::RequestOptions::OrHash
20
29
  ).returns(Straddle::Embed::LinkedBankAccountV1)
@@ -25,12 +34,21 @@ module Straddle
25
34
  account_id:,
26
35
  # Body param:
27
36
  bank_account:,
37
+ # Body param: Optional description for the bank account.
38
+ description: nil,
28
39
  # Body param: Up to 20 additional user-defined key-value pairs. Useful for storing
29
40
  # additional information about the linked bank account in a structured format.
30
41
  metadata: nil,
42
+ # Body param: The unique identifier of the Straddle Platform to associate this
43
+ # bank account with.
44
+ platform_id: nil,
45
+ # Body param: The purposes for the linked bank account.
46
+ purposes: nil,
31
47
  # Header param: Optional client generated identifier to trace and debug a series
32
48
  # of requests.
33
49
  correlation_id: nil,
50
+ # Header param: Optional client generated value to use for idempotent requests.
51
+ idempotency_key: nil,
34
52
  # Header param: Optional client generated identifier to trace and debug a request.
35
53
  request_id: nil,
36
54
  request_options: {}
@@ -48,6 +66,7 @@ module Straddle
48
66
  Straddle::Embed::LinkedBankAccountUpdateParams::BankAccount::OrHash,
49
67
  metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
50
68
  correlation_id: String,
69
+ idempotency_key: String,
51
70
  request_id: String,
52
71
  request_options: Straddle::RequestOptions::OrHash
53
72
  ).returns(Straddle::Embed::LinkedBankAccountV1)
@@ -63,6 +82,8 @@ module Straddle
63
82
  # Header param: Optional client generated identifier to trace and debug a series
64
83
  # of requests.
65
84
  correlation_id: nil,
85
+ # Header param: Optional client generated value to use for idempotent requests.
86
+ idempotency_key: nil,
66
87
  # Header param: Optional client generated identifier to trace and debug a request.
67
88
  request_id: nil,
68
89
  request_options: {}
@@ -114,6 +135,30 @@ module Straddle
114
135
  )
115
136
  end
116
137
 
138
+ # Cancels an existing linked bank account. This can be used to cancel a linked
139
+ # bank account before it has been reviewed. The linked bank account must be in
140
+ # 'created' status.
141
+ sig do
142
+ params(
143
+ linked_bank_account_id: String,
144
+ correlation_id: String,
145
+ idempotency_key: String,
146
+ request_id: String,
147
+ request_options: Straddle::RequestOptions::OrHash
148
+ ).returns(Straddle::Embed::LinkedBankAccountV1)
149
+ end
150
+ def cancel(
151
+ linked_bank_account_id,
152
+ # Optional client generated identifier to trace and debug a series of requests.
153
+ correlation_id: nil,
154
+ # Optional client generated value to use for idempotent requests.
155
+ idempotency_key: nil,
156
+ # Optional client generated identifier to trace and debug a request.
157
+ request_id: nil,
158
+ request_options: {}
159
+ )
160
+ end
161
+
117
162
  # Retrieves the details of a linked bank account that has previously been created.
118
163
  # Supply the unique linked bank account `id`, and Straddle will return the
119
164
  # corresponding information. The response includes masked account details for
@@ -13,6 +13,7 @@ module Straddle
13
13
  external_id: T.nilable(String),
14
14
  metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
15
15
  correlation_id: String,
16
+ idempotency_key: String,
16
17
  request_id: String,
17
18
  request_options: Straddle::RequestOptions::OrHash
18
19
  ).returns(Straddle::Embed::OrganizationV1)
@@ -29,6 +30,8 @@ module Straddle
29
30
  # Header param: Optional client generated identifier to trace and debug a series
30
31
  # of requests.
31
32
  correlation_id: nil,
33
+ # Header param: Optional client generated value to use for idempotent requests.
34
+ idempotency_key: nil,
32
35
  # Header param: Optional client generated identifier to trace and debug a request.
33
36
  request_id: nil,
34
37
  request_options: {}
@@ -19,7 +19,9 @@ module Straddle
19
19
  Straddle::Embed::RepresentativeCreateParams::Relationship::OrHash,
20
20
  ssn_last4: String,
21
21
  external_id: T.nilable(String),
22
+ metadata: T.nilable(T::Hash[Symbol, String]),
22
23
  correlation_id: String,
24
+ idempotency_key: String,
23
25
  request_id: String,
24
26
  request_options: Straddle::RequestOptions::OrHash
25
27
  ).returns(Straddle::Embed::Representative)
@@ -46,9 +48,14 @@ module Straddle
46
48
  # Body param: Unique identifier for the representative in your database, used for
47
49
  # cross-referencing between Straddle and your systems.
48
50
  external_id: nil,
51
+ # Body param: Up to 20 additional user-defined key-value pairs. Useful for storing
52
+ # additional information about the represetative in a structured format.
53
+ metadata: nil,
49
54
  # Header param: Optional client generated identifier to trace and debug a series
50
55
  # of requests.
51
56
  correlation_id: nil,
57
+ # Header param: Optional client generated value to use for idempotent requests.
58
+ idempotency_key: nil,
52
59
  # Header param: Optional client generated identifier to trace and debug a request.
53
60
  request_id: nil,
54
61
  request_options: {}
@@ -70,7 +77,9 @@ module Straddle
70
77
  Straddle::Embed::RepresentativeUpdateParams::Relationship::OrHash,
71
78
  ssn_last4: String,
72
79
  external_id: T.nilable(String),
80
+ metadata: T.nilable(T::Hash[Symbol, String]),
73
81
  correlation_id: String,
82
+ idempotency_key: String,
74
83
  request_id: String,
75
84
  request_options: Straddle::RequestOptions::OrHash
76
85
  ).returns(Straddle::Embed::Representative)
@@ -96,9 +105,14 @@ module Straddle
96
105
  # Body param: Unique identifier for the representative in your database, used for
97
106
  # cross-referencing between Straddle and your systems.
98
107
  external_id: nil,
108
+ # Body param: Up to 20 additional user-defined key-value pairs. Useful for storing
109
+ # additional information about the represetative in a structured format.
110
+ metadata: nil,
99
111
  # Header param: Optional client generated identifier to trace and debug a series
100
112
  # of requests.
101
113
  correlation_id: nil,
114
+ # Header param: Optional client generated value to use for idempotent requests.
115
+ idempotency_key: nil,
102
116
  # Header param: Optional client generated identifier to trace and debug a request.
103
117
  request_id: nil,
104
118
  request_options: {}
@@ -56,6 +56,7 @@ module Straddle
56
56
  id: String,
57
57
  reason: T.nilable(String),
58
58
  correlation_id: String,
59
+ idempotency_key: String,
59
60
  request_id: String,
60
61
  straddle_account_id: String,
61
62
  request_options: Straddle::RequestOptions::OrHash
@@ -69,6 +70,8 @@ module Straddle
69
70
  # Header param: Optional client generated identifier to trace and debug a series
70
71
  # of requests.
71
72
  correlation_id: nil,
73
+ # Header param: Optional client generated value to use for idempotent requests.
74
+ idempotency_key: nil,
72
75
  # Header param: Optional client generated identifier to trace and debug a request.
73
76
  request_id: nil,
74
77
  # Header param: For use by platforms to specify an account id and set scope of a
@@ -127,6 +130,37 @@ module Straddle
127
130
  )
128
131
  end
129
132
 
133
+ # Update the status of a paykey when in review status
134
+ sig do
135
+ params(
136
+ id: String,
137
+ status: Straddle::PaykeyReviewParams::Status::OrSymbol,
138
+ correlation_id: String,
139
+ idempotency_key: String,
140
+ request_id: String,
141
+ straddle_account_id: String,
142
+ request_options: Straddle::RequestOptions::OrHash
143
+ ).returns(Straddle::PaykeyV1)
144
+ end
145
+ def review(
146
+ # Path param:
147
+ id,
148
+ # Body param:
149
+ status:,
150
+ # Header param: Optional client generated identifier to trace and debug a series
151
+ # of requests.
152
+ correlation_id: nil,
153
+ # Header param: Optional client generated value to use for idempotent requests.
154
+ idempotency_key: nil,
155
+ # Header param: Optional client generated identifier to trace and debug a request.
156
+ request_id: nil,
157
+ # Header param: For use by platforms to specify an account id and set scope of a
158
+ # request.
159
+ straddle_account_id: nil,
160
+ request_options: {}
161
+ )
162
+ end
163
+
130
164
  # Retrieves the unmasked details of an existing paykey. Supply the unique paykey
131
165
  # `id` and Straddle will return the corresponding paykey record, including the
132
166
  # unmasked bank account details. This endpoint needs to be enabled by Straddle for
@@ -16,6 +16,7 @@ module Straddle
16
16
  config: Straddle::PayoutCreateParams::Config::OrHash,
17
17
  metadata: T.nilable(T::Hash[Symbol, String]),
18
18
  correlation_id: String,
19
+ idempotency_key: String,
19
20
  request_id: String,
20
21
  straddle_account_id: String,
21
22
  request_options: Straddle::RequestOptions::OrHash
@@ -47,6 +48,8 @@ module Straddle
47
48
  # Header param: Optional client generated identifier to trace and debug a series
48
49
  # of requests.
49
50
  correlation_id: nil,
51
+ # Header param: Optional client generated value to use for idempotent requests.
52
+ idempotency_key: nil,
50
53
  # Header param: Optional client generated identifier to trace and debug a request.
51
54
  request_id: nil,
52
55
  # Header param: For use by platforms to specify an account id and set scope of a
@@ -66,6 +69,7 @@ module Straddle
66
69
  payment_date: Date,
67
70
  metadata: T.nilable(T::Hash[Symbol, String]),
68
71
  correlation_id: String,
72
+ idempotency_key: String,
69
73
  request_id: String,
70
74
  straddle_account_id: String,
71
75
  request_options: Straddle::RequestOptions::OrHash
@@ -87,6 +91,8 @@ module Straddle
87
91
  # Header param: Optional client generated identifier to trace and debug a series
88
92
  # of requests.
89
93
  correlation_id: nil,
94
+ # Header param: Optional client generated value to use for idempotent requests.
95
+ idempotency_key: nil,
90
96
  # Header param: Optional client generated identifier to trace and debug a request.
91
97
  request_id: nil,
92
98
  # Header param: For use by platforms to specify an account id and set scope of a
@@ -103,6 +109,7 @@ module Straddle
103
109
  id: String,
104
110
  reason: String,
105
111
  correlation_id: String,
112
+ idempotency_key: String,
106
113
  request_id: String,
107
114
  straddle_account_id: String,
108
115
  request_options: Straddle::RequestOptions::OrHash
@@ -116,6 +123,8 @@ module Straddle
116
123
  # Header param: Optional client generated identifier to trace and debug a series
117
124
  # of requests.
118
125
  correlation_id: nil,
126
+ # Header param: Optional client generated value to use for idempotent requests.
127
+ idempotency_key: nil,
119
128
  # Header param: Optional client generated identifier to trace and debug a request.
120
129
  request_id: nil,
121
130
  # Header param: For use by platforms to specify an account id and set scope of a
@@ -155,6 +164,7 @@ module Straddle
155
164
  id: String,
156
165
  reason: String,
157
166
  correlation_id: String,
167
+ idempotency_key: String,
158
168
  request_id: String,
159
169
  straddle_account_id: String,
160
170
  request_options: Straddle::RequestOptions::OrHash
@@ -168,6 +178,8 @@ module Straddle
168
178
  # Header param: Optional client generated identifier to trace and debug a series
169
179
  # of requests.
170
180
  correlation_id: nil,
181
+ # Header param: Optional client generated value to use for idempotent requests.
182
+ idempotency_key: nil,
171
183
  # Header param: Optional client generated identifier to trace and debug a request.
172
184
  request_id: nil,
173
185
  # Header param: For use by platforms to specify an account id and set scope of a
@@ -184,6 +196,7 @@ module Straddle
184
196
  id: String,
185
197
  reason: String,
186
198
  correlation_id: String,
199
+ idempotency_key: String,
187
200
  request_id: String,
188
201
  straddle_account_id: String,
189
202
  request_options: Straddle::RequestOptions::OrHash
@@ -197,6 +210,8 @@ module Straddle
197
210
  # Header param: Optional client generated identifier to trace and debug a series
198
211
  # of requests.
199
212
  correlation_id: nil,
213
+ # Header param: Optional client generated value to use for idempotent requests.
214
+ idempotency_key: nil,
200
215
  # Header param: Optional client generated identifier to trace and debug a request.
201
216
  request_id: nil,
202
217
  # Header param: For use by platforms to specify an account id and set scope of a