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
@@ -127,6 +127,13 @@ module Straddle
127
127
  # @return [String, nil]
128
128
  optional :external_id, String, nil?: true
129
129
 
130
+ # @!attribute metadata
131
+ # Up to 20 additional user-defined key-value pairs. Useful for storing additional
132
+ # information about the represetative in a structured format.
133
+ #
134
+ # @return [Hash{Symbol=>String}, nil]
135
+ optional :metadata, Straddle::Internal::Type::HashOf[String], nil?: true
136
+
130
137
  # @!attribute phone
131
138
  #
132
139
  # @return [String, nil]
@@ -139,7 +146,7 @@ module Straddle
139
146
  # @return [String, nil]
140
147
  optional :user_id, String, nil?: true
141
148
 
142
- # @!method initialize(id:, account_id:, created_at:, dob:, email:, first_name:, last_name:, mobile_number:, name:, relationship:, ssn_last4:, status:, status_detail:, updated_at:, external_id: nil, phone: nil, user_id: nil)
149
+ # @!method initialize(id:, account_id:, created_at:, dob:, email:, first_name:, last_name:, mobile_number:, name:, relationship:, ssn_last4:, status:, status_detail:, updated_at:, external_id: nil, metadata: nil, phone: nil, user_id: nil)
143
150
  # Some parameter documentations has been truncated, see
144
151
  # {Straddle::Models::Embed::RepresentativePaged::Data} for more details.
145
152
  #
@@ -173,6 +180,8 @@ module Straddle
173
180
  #
174
181
  # @param external_id [String, nil] Unique identifier for the representative in your database, used for cross-refere
175
182
  #
183
+ # @param metadata [Hash{Symbol=>String}, nil] Up to 20 additional user-defined key-value pairs. Useful for storing additional
184
+ #
176
185
  # @param phone [String, nil]
177
186
  #
178
187
  # @param user_id [String, nil] The unique identifier of the user account associated with this representative, i
@@ -56,17 +56,29 @@ module Straddle
56
56
  # @return [String, nil]
57
57
  optional :external_id, String, nil?: true
58
58
 
59
+ # @!attribute metadata
60
+ # Up to 20 additional user-defined key-value pairs. Useful for storing additional
61
+ # information about the represetative in a structured format.
62
+ #
63
+ # @return [Hash{Symbol=>String}, nil]
64
+ optional :metadata, Straddle::Internal::Type::HashOf[String], nil?: true
65
+
59
66
  # @!attribute correlation_id
60
67
  #
61
68
  # @return [String, nil]
62
69
  optional :correlation_id, String
63
70
 
71
+ # @!attribute idempotency_key
72
+ #
73
+ # @return [String, nil]
74
+ optional :idempotency_key, String
75
+
64
76
  # @!attribute request_id
65
77
  #
66
78
  # @return [String, nil]
67
79
  optional :request_id, String
68
80
 
69
- # @!method initialize(dob:, email:, first_name:, last_name:, mobile_number:, relationship:, ssn_last4:, external_id: nil, correlation_id: nil, request_id: nil, request_options: {})
81
+ # @!method initialize(dob:, email:, first_name:, last_name:, mobile_number:, relationship:, ssn_last4:, external_id: nil, metadata: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, request_options: {})
70
82
  # Some parameter documentations has been truncated, see
71
83
  # {Straddle::Models::Embed::RepresentativeUpdateParams} for more details.
72
84
  #
@@ -86,8 +98,12 @@ module Straddle
86
98
  #
87
99
  # @param external_id [String, nil] Unique identifier for the representative in your database, used for cross-refere
88
100
  #
101
+ # @param metadata [Hash{Symbol=>String}, nil] Up to 20 additional user-defined key-value pairs. Useful for storing additional
102
+ #
89
103
  # @param correlation_id [String]
90
104
  #
105
+ # @param idempotency_key [String]
106
+ #
91
107
  # @param request_id [String]
92
108
  #
93
109
  # @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}]
@@ -17,6 +17,11 @@ module Straddle
17
17
  # @return [String, nil]
18
18
  optional :correlation_id, String
19
19
 
20
+ # @!attribute idempotency_key
21
+ #
22
+ # @return [String, nil]
23
+ optional :idempotency_key, String
24
+
20
25
  # @!attribute request_id
21
26
  #
22
27
  # @return [String, nil]
@@ -27,9 +32,10 @@ module Straddle
27
32
  # @return [String, nil]
28
33
  optional :straddle_account_id, String
29
34
 
30
- # @!method initialize(reason: nil, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
35
+ # @!method initialize(reason: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
31
36
  # @param reason [String, nil]
32
37
  # @param correlation_id [String]
38
+ # @param idempotency_key [String]
33
39
  # @param request_id [String]
34
40
  # @param straddle_account_id [String]
35
41
  # @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}]
@@ -0,0 +1,54 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Straddle
4
+ module Models
5
+ # @see Straddle::Resources::Paykeys#review
6
+ class PaykeyReviewParams < Straddle::Internal::Type::BaseModel
7
+ extend Straddle::Internal::Type::RequestParameters::Converter
8
+ include Straddle::Internal::Type::RequestParameters
9
+
10
+ # @!attribute status
11
+ #
12
+ # @return [Symbol, Straddle::Models::PaykeyReviewParams::Status]
13
+ required :status, enum: -> { Straddle::PaykeyReviewParams::Status }
14
+
15
+ # @!attribute correlation_id
16
+ #
17
+ # @return [String, nil]
18
+ optional :correlation_id, String
19
+
20
+ # @!attribute idempotency_key
21
+ #
22
+ # @return [String, nil]
23
+ optional :idempotency_key, String
24
+
25
+ # @!attribute request_id
26
+ #
27
+ # @return [String, nil]
28
+ optional :request_id, String
29
+
30
+ # @!attribute straddle_account_id
31
+ #
32
+ # @return [String, nil]
33
+ optional :straddle_account_id, String
34
+
35
+ # @!method initialize(status:, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
36
+ # @param status [Symbol, Straddle::Models::PaykeyReviewParams::Status]
37
+ # @param correlation_id [String]
38
+ # @param idempotency_key [String]
39
+ # @param request_id [String]
40
+ # @param straddle_account_id [String]
41
+ # @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}]
42
+
43
+ module Status
44
+ extend Straddle::Internal::Type::Enum
45
+
46
+ ACTIVE = :active
47
+ REJECTED = :rejected
48
+
49
+ # @!method self.values
50
+ # @return [Array<Symbol>]
51
+ end
52
+ end
53
+ end
54
+ end
@@ -18,6 +18,11 @@ module Straddle
18
18
  # @return [String, nil]
19
19
  optional :correlation_id, String
20
20
 
21
+ # @!attribute idempotency_key
22
+ #
23
+ # @return [String, nil]
24
+ optional :idempotency_key, String
25
+
21
26
  # @!attribute request_id
22
27
  #
23
28
  # @return [String, nil]
@@ -28,11 +33,13 @@ module Straddle
28
33
  # @return [String, nil]
29
34
  optional :straddle_account_id, String
30
35
 
31
- # @!method initialize(reason:, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
36
+ # @!method initialize(reason:, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
32
37
  # @param reason [String] Details about why the payout status was updated.
33
38
  #
34
39
  # @param correlation_id [String]
35
40
  #
41
+ # @param idempotency_key [String]
42
+ #
36
43
  # @param request_id [String]
37
44
  #
38
45
  # @param straddle_account_id [String]
@@ -68,6 +68,11 @@ module Straddle
68
68
  # @return [String, nil]
69
69
  optional :correlation_id, String
70
70
 
71
+ # @!attribute idempotency_key
72
+ #
73
+ # @return [String, nil]
74
+ optional :idempotency_key, String
75
+
71
76
  # @!attribute request_id
72
77
  #
73
78
  # @return [String, nil]
@@ -78,7 +83,7 @@ module Straddle
78
83
  # @return [String, nil]
79
84
  optional :straddle_account_id, String
80
85
 
81
- # @!method initialize(amount:, currency:, description:, device:, external_id:, paykey:, payment_date:, config: nil, metadata: nil, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
86
+ # @!method initialize(amount:, currency:, description:, device:, external_id:, paykey:, payment_date:, config: nil, metadata: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
82
87
  # Some parameter documentations has been truncated, see
83
88
  # {Straddle::Models::PayoutCreateParams} for more details.
84
89
  #
@@ -102,6 +107,8 @@ module Straddle
102
107
  #
103
108
  # @param correlation_id [String]
104
109
  #
110
+ # @param idempotency_key [String]
111
+ #
105
112
  # @param request_id [String]
106
113
  #
107
114
  # @param straddle_account_id [String]
@@ -18,6 +18,11 @@ module Straddle
18
18
  # @return [String, nil]
19
19
  optional :correlation_id, String
20
20
 
21
+ # @!attribute idempotency_key
22
+ #
23
+ # @return [String, nil]
24
+ optional :idempotency_key, String
25
+
21
26
  # @!attribute request_id
22
27
  #
23
28
  # @return [String, nil]
@@ -28,11 +33,13 @@ module Straddle
28
33
  # @return [String, nil]
29
34
  optional :straddle_account_id, String
30
35
 
31
- # @!method initialize(reason:, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
36
+ # @!method initialize(reason:, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
32
37
  # @param reason [String] Details about why the payout status was updated.
33
38
  #
34
39
  # @param correlation_id [String]
35
40
  #
41
+ # @param idempotency_key [String]
42
+ #
36
43
  # @param request_id [String]
37
44
  #
38
45
  # @param straddle_account_id [String]
@@ -18,6 +18,11 @@ module Straddle
18
18
  # @return [String, nil]
19
19
  optional :correlation_id, String
20
20
 
21
+ # @!attribute idempotency_key
22
+ #
23
+ # @return [String, nil]
24
+ optional :idempotency_key, String
25
+
21
26
  # @!attribute request_id
22
27
  #
23
28
  # @return [String, nil]
@@ -28,11 +33,13 @@ module Straddle
28
33
  # @return [String, nil]
29
34
  optional :straddle_account_id, String
30
35
 
31
- # @!method initialize(reason:, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
36
+ # @!method initialize(reason:, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
32
37
  # @param reason [String] Details about why the payout status was updated.
33
38
  #
34
39
  # @param correlation_id [String]
35
40
  #
41
+ # @param idempotency_key [String]
42
+ #
36
43
  # @param request_id [String]
37
44
  #
38
45
  # @param straddle_account_id [String]
@@ -38,6 +38,11 @@ module Straddle
38
38
  # @return [String, nil]
39
39
  optional :correlation_id, String
40
40
 
41
+ # @!attribute idempotency_key
42
+ #
43
+ # @return [String, nil]
44
+ optional :idempotency_key, String
45
+
41
46
  # @!attribute request_id
42
47
  #
43
48
  # @return [String, nil]
@@ -48,7 +53,7 @@ module Straddle
48
53
  # @return [String, nil]
49
54
  optional :straddle_account_id, String
50
55
 
51
- # @!method initialize(amount:, description:, payment_date:, metadata: nil, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
56
+ # @!method initialize(amount:, description:, payment_date:, metadata: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
52
57
  # Some parameter documentations has been truncated, see
53
58
  # {Straddle::Models::PayoutUpdateParams} for more details.
54
59
  #
@@ -62,6 +67,8 @@ module Straddle
62
67
  #
63
68
  # @param correlation_id [String]
64
69
  #
70
+ # @param idempotency_key [String]
71
+ #
65
72
  # @param request_id [String]
66
73
  #
67
74
  # @param straddle_account_id [String]
@@ -113,6 +113,8 @@ module Straddle
113
113
 
114
114
  PaykeyRevealParams = Straddle::Models::PaykeyRevealParams
115
115
 
116
+ PaykeyReviewParams = Straddle::Models::PaykeyReviewParams
117
+
116
118
  PaykeySummaryPagedV1 = Straddle::Models::PaykeySummaryPagedV1
117
119
 
118
120
  PaykeyUnmaskedParams = Straddle::Models::PaykeyUnmaskedParams
@@ -11,7 +11,7 @@ module Straddle
11
11
  # source. This endpoint allows you to create a secure payment token linked to a
12
12
  # specific bank account.
13
13
  #
14
- # @overload bank_account(account_number:, account_type:, customer_id:, routing_number:, config: nil, metadata: nil, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
14
+ # @overload bank_account(account_number:, account_type:, customer_id:, routing_number:, config: nil, metadata: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
15
15
  #
16
16
  # @param account_number [String] Body param: The bank account number.
17
17
  #
@@ -27,6 +27,8 @@ module Straddle
27
27
  #
28
28
  # @param correlation_id [String] Header param: Optional client generated identifier to trace and debug a series o
29
29
  #
30
+ # @param idempotency_key [String] Header param: Optional client generated value to use for idempotent requests.
31
+ #
30
32
  # @param request_id [String] Header param: Optional client generated identifier to trace and debug a request.
31
33
  #
32
34
  # @param straddle_account_id [String] Header param: For use by platforms to specify an account id and set scope of a r
@@ -41,6 +43,7 @@ module Straddle
41
43
  header_params =
42
44
  {
43
45
  correlation_id: "correlation-id",
46
+ idempotency_key: "idempotency-key",
44
47
  request_id: "request-id",
45
48
  straddle_account_id: "straddle-account-id"
46
49
  }
@@ -61,7 +64,7 @@ module Straddle
61
64
  # you to create a secure payment token linked to a bank account authenticated
62
65
  # through Quiltt.
63
66
  #
64
- # @overload create_paykey(customer_id:, quiltt_token:, config: nil, metadata: nil, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
67
+ # @overload create_paykey(customer_id:, quiltt_token:, config: nil, metadata: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
65
68
  #
66
69
  # @param customer_id [String] Body param: Unique identifier of the related customer object.
67
70
  #
@@ -73,6 +76,8 @@ module Straddle
73
76
  #
74
77
  # @param correlation_id [String] Header param: Optional client generated identifier to trace and debug a series o
75
78
  #
79
+ # @param idempotency_key [String] Header param: Optional client generated value to use for idempotent requests.
80
+ #
76
81
  # @param request_id [String] Header param: Optional client generated identifier to trace and debug a request.
77
82
  #
78
83
  # @param straddle_account_id [String] Header param: For use by platforms to specify an account id and set scope of a r
@@ -87,6 +92,7 @@ module Straddle
87
92
  header_params =
88
93
  {
89
94
  correlation_id: "correlation-id",
95
+ idempotency_key: "idempotency-key",
90
96
  request_id: "request-id",
91
97
  straddle_account_id: "straddle-account-id"
92
98
  }
@@ -103,7 +109,7 @@ module Straddle
103
109
  # Some parameter documentations has been truncated, see
104
110
  # {Straddle::Models::Bridge::LinkCreateTanParams} for more details.
105
111
  #
106
- # @overload create_tan(account_type:, customer_id:, routing_number:, tan:, config: nil, metadata: nil, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
112
+ # @overload create_tan(account_type:, customer_id:, routing_number:, tan:, config: nil, metadata: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
107
113
  #
108
114
  # @param account_type [Symbol, Straddle::Models::Bridge::LinkCreateTanParams::AccountType] Body param:
109
115
  #
@@ -119,6 +125,8 @@ module Straddle
119
125
  #
120
126
  # @param correlation_id [String] Header param: Optional client generated identifier to trace and debug a series o
121
127
  #
128
+ # @param idempotency_key [String] Header param: Optional client generated value to use for idempotent requests.
129
+ #
122
130
  # @param request_id [String] Header param: Optional client generated identifier to trace and debug a request.
123
131
  #
124
132
  # @param straddle_account_id [String] Header param: For use by platforms to specify an account id and set scope of a r
@@ -133,6 +141,7 @@ module Straddle
133
141
  header_params =
134
142
  {
135
143
  correlation_id: "correlation-id",
144
+ idempotency_key: "idempotency-key",
136
145
  request_id: "request-id",
137
146
  straddle_account_id: "straddle-account-id"
138
147
  }
@@ -153,7 +162,7 @@ module Straddle
153
162
  # endpoint allows you to create a secure payment token linked to a bank account
154
163
  # authenticated through Plaid.
155
164
  #
156
- # @overload plaid(customer_id:, plaid_token:, config: nil, metadata: nil, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
165
+ # @overload plaid(customer_id:, plaid_token:, config: nil, metadata: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
157
166
  #
158
167
  # @param customer_id [String] Body param: Unique identifier of the related customer object.
159
168
  #
@@ -165,6 +174,8 @@ module Straddle
165
174
  #
166
175
  # @param correlation_id [String] Header param: Optional client generated identifier to trace and debug a series o
167
176
  #
177
+ # @param idempotency_key [String] Header param: Optional client generated value to use for idempotent requests.
178
+ #
168
179
  # @param request_id [String] Header param: Optional client generated identifier to trace and debug a request.
169
180
  #
170
181
  # @param straddle_account_id [String] Header param: For use by platforms to specify an account id and set scope of a r
@@ -179,6 +190,7 @@ module Straddle
179
190
  header_params =
180
191
  {
181
192
  correlation_id: "correlation-id",
193
+ idempotency_key: "idempotency-key",
182
194
  request_id: "request-id",
183
195
  straddle_account_id: "straddle-account-id"
184
196
  }
@@ -11,7 +11,7 @@ module Straddle
11
11
  #
12
12
  # Use this endpoint to generate a session token for use in the Bridge widget.
13
13
  #
14
- # @overload initialize_(customer_id:, config: nil, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
14
+ # @overload initialize_(customer_id:, config: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
15
15
  #
16
16
  # @param customer_id [String] Body param: The Straddle generated unique identifier of the `customer` to create
17
17
  #
@@ -19,6 +19,8 @@ module Straddle
19
19
  #
20
20
  # @param correlation_id [String] Header param: Optional client generated identifier to trace and debug a series o
21
21
  #
22
+ # @param idempotency_key [String] Header param: Optional client generated value to use for idempotent requests.
23
+ #
22
24
  # @param request_id [String] Header param: Optional client generated identifier to trace and debug a request.
23
25
  #
24
26
  # @param straddle_account_id [String] Header param: For use by platforms to specify an account id and set scope of a r
@@ -33,6 +35,7 @@ module Straddle
33
35
  header_params =
34
36
  {
35
37
  correlation_id: "correlation-id",
38
+ idempotency_key: "idempotency-key",
36
39
  request_id: "request-id",
37
40
  straddle_account_id: "straddle-account-id"
38
41
  }
@@ -8,7 +8,7 @@ module Straddle
8
8
  #
9
9
  # Use charges to collect money from a customer for the sale of goods or services.
10
10
  #
11
- # @overload create(amount:, config:, consent_type:, currency:, description:, device:, external_id:, paykey:, payment_date:, metadata: nil, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
11
+ # @overload create(amount:, config:, consent_type:, currency:, description:, device:, external_id:, paykey:, payment_date:, metadata: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
12
12
  #
13
13
  # @param amount [Integer] Body param: The amount of the charge in cents.
14
14
  #
@@ -32,6 +32,8 @@ module Straddle
32
32
  #
33
33
  # @param correlation_id [String] Header param: Optional client generated identifier to trace and debug a series o
34
34
  #
35
+ # @param idempotency_key [String] Header param: Optional client generated value to use for idempotent requests.
36
+ #
35
37
  # @param request_id [String] Header param: Optional client generated identifier to trace and debug a request.
36
38
  #
37
39
  # @param straddle_account_id [String] Header param: For use by platforms to specify an account id and set scope of a r
@@ -46,6 +48,7 @@ module Straddle
46
48
  header_params =
47
49
  {
48
50
  correlation_id: "correlation-id",
51
+ idempotency_key: "idempotency-key",
49
52
  request_id: "request-id",
50
53
  straddle_account_id: "straddle-account-id"
51
54
  }
@@ -65,7 +68,7 @@ module Straddle
65
68
  # Change the values of parameters associated with a charge prior to processing.
66
69
  # The status of the charge must be `created`, `scheduled`, or `on_hold`.
67
70
  #
68
- # @overload update(id, amount:, description:, payment_date:, metadata: nil, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
71
+ # @overload update(id, amount:, description:, payment_date:, metadata: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
69
72
  #
70
73
  # @param id [String] Path param:
71
74
  #
@@ -79,6 +82,8 @@ module Straddle
79
82
  #
80
83
  # @param correlation_id [String] Header param: Optional client generated identifier to trace and debug a series o
81
84
  #
85
+ # @param idempotency_key [String] Header param: Optional client generated value to use for idempotent requests.
86
+ #
82
87
  # @param request_id [String] Header param: Optional client generated identifier to trace and debug a request.
83
88
  #
84
89
  # @param straddle_account_id [String] Header param: For use by platforms to specify an account id and set scope of a r
@@ -93,6 +98,7 @@ module Straddle
93
98
  header_params =
94
99
  {
95
100
  correlation_id: "correlation-id",
101
+ idempotency_key: "idempotency-key",
96
102
  request_id: "request-id",
97
103
  straddle_account_id: "straddle-account-id"
98
104
  }
@@ -112,7 +118,7 @@ module Straddle
112
118
  # Cancel a charge to prevent it from being originated for processing. The status
113
119
  # of the charge must be `created`, `scheduled`, or `on_hold`.
114
120
  #
115
- # @overload cancel(id, reason: nil, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
121
+ # @overload cancel(id, reason: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
116
122
  #
117
123
  # @param id [String] Path param:
118
124
  #
@@ -120,6 +126,8 @@ module Straddle
120
126
  #
121
127
  # @param correlation_id [String] Header param: Optional client generated identifier to trace and debug a series o
122
128
  #
129
+ # @param idempotency_key [String] Header param: Optional client generated value to use for idempotent requests.
130
+ #
123
131
  # @param request_id [String] Header param: Optional client generated identifier to trace and debug a request.
124
132
  #
125
133
  # @param straddle_account_id [String] Header param: For use by platforms to specify an account id and set scope of a r
@@ -134,6 +142,7 @@ module Straddle
134
142
  header_params =
135
143
  {
136
144
  correlation_id: "correlation-id",
145
+ idempotency_key: "idempotency-key",
137
146
  request_id: "request-id",
138
147
  straddle_account_id: "straddle-account-id"
139
148
  }
@@ -186,7 +195,7 @@ module Straddle
186
195
  # Place a charge on hold to prevent it from being originated for processing. The
187
196
  # status of the charge must be `created` or `scheduled`.
188
197
  #
189
- # @overload hold(id, reason: nil, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
198
+ # @overload hold(id, reason: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
190
199
  #
191
200
  # @param id [String] Path param:
192
201
  #
@@ -194,6 +203,8 @@ module Straddle
194
203
  #
195
204
  # @param correlation_id [String] Header param: Optional client generated identifier to trace and debug a series o
196
205
  #
206
+ # @param idempotency_key [String] Header param: Optional client generated value to use for idempotent requests.
207
+ #
197
208
  # @param request_id [String] Header param: Optional client generated identifier to trace and debug a request.
198
209
  #
199
210
  # @param straddle_account_id [String] Header param: For use by platforms to specify an account id and set scope of a r
@@ -208,6 +219,7 @@ module Straddle
208
219
  header_params =
209
220
  {
210
221
  correlation_id: "correlation-id",
222
+ idempotency_key: "idempotency-key",
211
223
  request_id: "request-id",
212
224
  straddle_account_id: "straddle-account-id"
213
225
  }
@@ -227,7 +239,7 @@ module Straddle
227
239
  # Release a charge from an `on_hold` status to allow it to be rescheduled for
228
240
  # processing.
229
241
  #
230
- # @overload release(id, reason: nil, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
242
+ # @overload release(id, reason: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
231
243
  #
232
244
  # @param id [String] Path param:
233
245
  #
@@ -235,6 +247,8 @@ module Straddle
235
247
  #
236
248
  # @param correlation_id [String] Header param: Optional client generated identifier to trace and debug a series o
237
249
  #
250
+ # @param idempotency_key [String] Header param: Optional client generated value to use for idempotent requests.
251
+ #
238
252
  # @param request_id [String] Header param: Optional client generated identifier to trace and debug a request.
239
253
  #
240
254
  # @param straddle_account_id [String] Header param: For use by platforms to specify an account id and set scope of a r
@@ -249,6 +263,7 @@ module Straddle
249
263
  header_params =
250
264
  {
251
265
  correlation_id: "correlation-id",
266
+ idempotency_key: "idempotency-key",
252
267
  request_id: "request-id",
253
268
  straddle_account_id: "straddle-account-id"
254
269
  }
@@ -12,7 +12,7 @@ module Straddle
12
12
  # or updating the status of a customer's verification. Note that this endpoint is
13
13
  # only available for customers with a current status of `review`.
14
14
  #
15
- # @overload decision(id, status:, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
15
+ # @overload decision(id, status:, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
16
16
  #
17
17
  # @param id [String] Path param:
18
18
  #
@@ -20,6 +20,8 @@ module Straddle
20
20
  #
21
21
  # @param correlation_id [String] Header param: Optional client generated identifier to trace and debug a series o
22
22
  #
23
+ # @param idempotency_key [String] Header param: Optional client generated value to use for idempotent requests.
24
+ #
23
25
  # @param request_id [String] Header param: Optional client generated identifier to trace and debug a request.
24
26
  #
25
27
  # @param straddle_account_id [String] Header param: For use by platforms to specify an account id and set scope of a r
@@ -34,6 +36,7 @@ module Straddle
34
36
  header_params =
35
37
  {
36
38
  correlation_id: "correlation-id",
39
+ idempotency_key: "idempotency-key",
37
40
  request_id: "request-id",
38
41
  straddle_account_id: "straddle-account-id"
39
42
  }