straddle 0.2.0 → 0.3.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +23 -0
- data/README.md +1 -1
- data/lib/straddle/internal/transport/base_client.rb +7 -1
- data/lib/straddle/internal/transport/pooled_net_requester.rb +36 -26
- data/lib/straddle/internal/util.rb +5 -5
- data/lib/straddle/models/bridge/link_bank_account_params.rb +31 -2
- data/lib/straddle/models/bridge/link_create_paykey_params.rb +31 -2
- data/lib/straddle/models/bridge/link_create_paykey_response.rb +31 -2
- data/lib/straddle/models/bridge/link_create_tan_params.rb +30 -2
- data/lib/straddle/models/bridge/link_create_tan_response.rb +31 -2
- data/lib/straddle/models/bridge/link_plaid_params.rb +30 -2
- data/lib/straddle/models/bridge_initialize_params.rb +30 -2
- data/lib/straddle/models/customers/review_refresh_review_params.rb +40 -0
- data/lib/straddle/models/embed/linked_bank_account_list_params.rb +51 -1
- data/lib/straddle/models/funding_event_list_params.rb +9 -1
- data/lib/straddle/models/funding_event_summary_item_v1.rb +25 -1
- data/lib/straddle/models/funding_event_summary_paged_v1.rb +25 -1
- data/lib/straddle/models/paykey_reveal_response.rb +31 -2
- data/lib/straddle/models/paykey_summary_paged_v1.rb +30 -2
- data/lib/straddle/models/paykey_unmasked_v1.rb +30 -2
- data/lib/straddle/models/{customer_refresh_review_params.rb → paykey_update_balance_params.rb} +2 -2
- data/lib/straddle/models/paykey_v1.rb +30 -2
- data/lib/straddle/models/paykeys/review_decision_params.rb +56 -0
- data/lib/straddle/models/paykeys/review_get_params.rb +34 -0
- data/lib/straddle/models/paykeys/review_get_response.rb +642 -0
- data/lib/straddle/models/paykeys/review_refresh_review_params.rb +40 -0
- data/lib/straddle/models/payment_summary_paged_v1.rb +9 -1
- data/lib/straddle/models.rb +3 -3
- data/lib/straddle/resources/bridge/link.rb +12 -4
- data/lib/straddle/resources/bridge.rb +3 -1
- data/lib/straddle/resources/customers/review.rb +37 -0
- data/lib/straddle/resources/customers.rb +0 -37
- data/lib/straddle/resources/embed/linked_bank_accounts.rb +15 -2
- data/lib/straddle/resources/funding_events.rb +4 -1
- data/lib/straddle/resources/paykeys/review.rb +128 -0
- data/lib/straddle/resources/paykeys.rb +36 -39
- data/lib/straddle/version.rb +1 -1
- data/lib/straddle.rb +8 -2
- data/manifest.yaml +1 -0
- data/rbi/straddle/internal/transport/base_client.rbi +5 -0
- data/rbi/straddle/internal/transport/pooled_net_requester.rbi +6 -2
- data/rbi/straddle/internal/type/base_model.rbi +8 -4
- data/rbi/straddle/models/bridge/link_bank_account_params.rbi +76 -1
- data/rbi/straddle/models/bridge/link_create_paykey_params.rbi +76 -1
- data/rbi/straddle/models/bridge/link_create_paykey_response.rbi +76 -1
- data/rbi/straddle/models/bridge/link_create_tan_params.rbi +76 -1
- data/rbi/straddle/models/bridge/link_create_tan_response.rbi +76 -1
- data/rbi/straddle/models/bridge/link_plaid_params.rbi +76 -1
- data/rbi/straddle/models/bridge_initialize_params.rbi +76 -1
- data/rbi/straddle/models/customers/review_refresh_review_params.rbi +76 -0
- data/rbi/straddle/models/embed/linked_bank_account_list_params.rbi +149 -0
- data/rbi/straddle/models/funding_event_list_params.rbi +8 -0
- data/rbi/straddle/models/funding_event_summary_item_v1.rbi +24 -0
- data/rbi/straddle/models/funding_event_summary_paged_v1.rbi +24 -0
- data/rbi/straddle/models/paykey_reveal_response.rbi +76 -1
- data/rbi/straddle/models/paykey_summary_paged_v1.rbi +76 -1
- data/rbi/straddle/models/paykey_unmasked_v1.rbi +76 -1
- data/rbi/straddle/models/{customer_refresh_review_params.rbi → paykey_update_balance_params.rbi} +2 -2
- data/rbi/straddle/models/paykey_v1.rbi +76 -1
- data/rbi/straddle/models/paykeys/review_decision_params.rbi +115 -0
- data/rbi/straddle/models/paykeys/review_get_params.rbi +67 -0
- data/rbi/straddle/models/paykeys/review_get_response.rbi +1524 -0
- data/rbi/straddle/models/paykeys/review_refresh_review_params.rbi +76 -0
- data/rbi/straddle/models/payment_summary_paged_v1.rbi +8 -0
- data/rbi/straddle/models.rbi +3 -3
- data/rbi/straddle/resources/bridge/link.rbi +16 -0
- data/rbi/straddle/resources/bridge.rbi +4 -0
- data/rbi/straddle/resources/customers/review.rbi +27 -0
- data/rbi/straddle/resources/customers.rbi +0 -27
- data/rbi/straddle/resources/embed/linked_bank_accounts.rbi +10 -0
- data/rbi/straddle/resources/funding_events.rbi +3 -0
- data/rbi/straddle/resources/paykeys/review.rbi +94 -0
- data/rbi/straddle/resources/paykeys.rbi +19 -21
- data/sig/straddle/internal/transport/base_client.rbs +2 -0
- data/sig/straddle/internal/transport/pooled_net_requester.rbs +4 -1
- data/sig/straddle/models/bridge/link_bank_account_params.rbs +28 -1
- data/sig/straddle/models/bridge/link_create_paykey_params.rbs +28 -1
- data/sig/straddle/models/bridge/link_create_paykey_response.rbs +28 -1
- data/sig/straddle/models/bridge/link_create_tan_params.rbs +28 -1
- data/sig/straddle/models/bridge/link_create_tan_response.rbs +28 -1
- data/sig/straddle/models/bridge/link_plaid_params.rbs +28 -1
- data/sig/straddle/models/bridge_initialize_params.rbs +28 -1
- data/sig/straddle/models/customers/review_refresh_review_params.rbs +51 -0
- data/sig/straddle/models/embed/linked_bank_account_list_params.rbs +46 -0
- data/sig/straddle/models/funding_event_list_params.rbs +5 -0
- data/sig/straddle/models/funding_event_summary_item_v1.rbs +15 -0
- data/sig/straddle/models/funding_event_summary_paged_v1.rbs +15 -0
- data/sig/straddle/models/paykey_reveal_response.rbs +28 -1
- data/sig/straddle/models/paykey_summary_paged_v1.rbs +28 -1
- data/sig/straddle/models/paykey_unmasked_v1.rbs +28 -1
- data/sig/straddle/models/{customer_refresh_review_params.rbs → paykey_update_balance_params.rbs} +2 -2
- data/sig/straddle/models/paykey_v1.rbs +28 -1
- data/sig/straddle/models/paykeys/review_decision_params.rbs +67 -0
- data/sig/straddle/models/paykeys/review_get_params.rbs +44 -0
- data/sig/straddle/models/paykeys/review_get_response.rbs +627 -0
- data/sig/straddle/models/paykeys/review_refresh_review_params.rbs +51 -0
- data/sig/straddle/models/payment_summary_paged_v1.rbs +5 -0
- data/sig/straddle/models.rbs +3 -3
- data/sig/straddle/resources/bridge/link.rbs +4 -0
- data/sig/straddle/resources/bridge.rbs +1 -0
- data/sig/straddle/resources/customers/review.rbs +9 -0
- data/sig/straddle/resources/customers.rbs +0 -9
- data/sig/straddle/resources/embed/linked_bank_accounts.rbs +2 -0
- data/sig/straddle/resources/funding_events.rbs +1 -0
- data/sig/straddle/resources/paykeys/review.rbs +36 -0
- data/sig/straddle/resources/paykeys.rbs +7 -6
- metadata +23 -8
- data/lib/straddle/models/paykey_review_params.rb +0 -54
- data/rbi/straddle/models/paykey_review_params.rbi +0 -98
- data/sig/straddle/models/paykey_review_params.rbs +0 -65
|
@@ -0,0 +1,642 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Straddle
|
|
4
|
+
module Models
|
|
5
|
+
module Paykeys
|
|
6
|
+
# @see Straddle::Resources::Paykeys::Review#get
|
|
7
|
+
class ReviewGetResponse < Straddle::Internal::Type::BaseModel
|
|
8
|
+
# @!attribute data
|
|
9
|
+
#
|
|
10
|
+
# @return [Straddle::Models::Paykeys::ReviewGetResponse::Data]
|
|
11
|
+
required :data, -> { Straddle::Models::Paykeys::ReviewGetResponse::Data }
|
|
12
|
+
|
|
13
|
+
# @!attribute meta
|
|
14
|
+
# Metadata about the API request, including an identifier and timestamp.
|
|
15
|
+
#
|
|
16
|
+
# @return [Straddle::Models::ResponseMetadata]
|
|
17
|
+
required :meta, -> { Straddle::ResponseMetadata }
|
|
18
|
+
|
|
19
|
+
# @!attribute response_type
|
|
20
|
+
# Indicates the structure of the returned content.
|
|
21
|
+
#
|
|
22
|
+
# - "object" means the `data` field contains a single JSON object.
|
|
23
|
+
# - "array" means the `data` field contains an array of objects.
|
|
24
|
+
# - "error" means the `data` field contains an error object with details of the
|
|
25
|
+
# issue.
|
|
26
|
+
# - "none" means no data is returned.
|
|
27
|
+
#
|
|
28
|
+
# @return [Symbol, Straddle::Models::Paykeys::ReviewGetResponse::ResponseType]
|
|
29
|
+
required :response_type, enum: -> { Straddle::Models::Paykeys::ReviewGetResponse::ResponseType }
|
|
30
|
+
|
|
31
|
+
# @!method initialize(data:, meta:, response_type:)
|
|
32
|
+
# Some parameter documentations has been truncated, see
|
|
33
|
+
# {Straddle::Models::Paykeys::ReviewGetResponse} for more details.
|
|
34
|
+
#
|
|
35
|
+
# @param data [Straddle::Models::Paykeys::ReviewGetResponse::Data]
|
|
36
|
+
#
|
|
37
|
+
# @param meta [Straddle::Models::ResponseMetadata] Metadata about the API request, including an identifier and timestamp.
|
|
38
|
+
#
|
|
39
|
+
# @param response_type [Symbol, Straddle::Models::Paykeys::ReviewGetResponse::ResponseType] Indicates the structure of the returned content.
|
|
40
|
+
|
|
41
|
+
# @see Straddle::Models::Paykeys::ReviewGetResponse#data
|
|
42
|
+
class Data < Straddle::Internal::Type::BaseModel
|
|
43
|
+
# @!attribute paykey_details
|
|
44
|
+
#
|
|
45
|
+
# @return [Straddle::Models::Paykeys::ReviewGetResponse::Data::PaykeyDetails]
|
|
46
|
+
required :paykey_details, -> { Straddle::Models::Paykeys::ReviewGetResponse::Data::PaykeyDetails }
|
|
47
|
+
|
|
48
|
+
# @!attribute verification_details
|
|
49
|
+
#
|
|
50
|
+
# @return [Straddle::Models::Paykeys::ReviewGetResponse::Data::VerificationDetails, nil]
|
|
51
|
+
optional :verification_details,
|
|
52
|
+
-> { Straddle::Models::Paykeys::ReviewGetResponse::Data::VerificationDetails }
|
|
53
|
+
|
|
54
|
+
# @!method initialize(paykey_details:, verification_details: nil)
|
|
55
|
+
# @param paykey_details [Straddle::Models::Paykeys::ReviewGetResponse::Data::PaykeyDetails]
|
|
56
|
+
# @param verification_details [Straddle::Models::Paykeys::ReviewGetResponse::Data::VerificationDetails]
|
|
57
|
+
|
|
58
|
+
# @see Straddle::Models::Paykeys::ReviewGetResponse::Data#paykey_details
|
|
59
|
+
class PaykeyDetails < Straddle::Internal::Type::BaseModel
|
|
60
|
+
# @!attribute id
|
|
61
|
+
# Unique identifier for the paykey.
|
|
62
|
+
#
|
|
63
|
+
# @return [String]
|
|
64
|
+
required :id, String
|
|
65
|
+
|
|
66
|
+
# @!attribute config
|
|
67
|
+
#
|
|
68
|
+
# @return [Straddle::Models::Paykeys::ReviewGetResponse::Data::PaykeyDetails::Config]
|
|
69
|
+
required :config, -> { Straddle::Models::Paykeys::ReviewGetResponse::Data::PaykeyDetails::Config }
|
|
70
|
+
|
|
71
|
+
# @!attribute created_at
|
|
72
|
+
# Timestamp of when the paykey was created.
|
|
73
|
+
#
|
|
74
|
+
# @return [Time]
|
|
75
|
+
required :created_at, Time
|
|
76
|
+
|
|
77
|
+
# @!attribute label
|
|
78
|
+
# Human-readable label used to represent this paykey in a UI.
|
|
79
|
+
#
|
|
80
|
+
# @return [String]
|
|
81
|
+
required :label, String
|
|
82
|
+
|
|
83
|
+
# @!attribute paykey
|
|
84
|
+
# The tokenized paykey value. This value is used to create payments and should be
|
|
85
|
+
# stored securely.
|
|
86
|
+
#
|
|
87
|
+
# @return [String]
|
|
88
|
+
required :paykey, String
|
|
89
|
+
|
|
90
|
+
# @!attribute source
|
|
91
|
+
#
|
|
92
|
+
# @return [Symbol, Straddle::Models::Paykeys::ReviewGetResponse::Data::PaykeyDetails::Source]
|
|
93
|
+
required :source, enum: -> { Straddle::Models::Paykeys::ReviewGetResponse::Data::PaykeyDetails::Source }
|
|
94
|
+
|
|
95
|
+
# @!attribute status
|
|
96
|
+
#
|
|
97
|
+
# @return [Symbol, Straddle::Models::Paykeys::ReviewGetResponse::Data::PaykeyDetails::Status]
|
|
98
|
+
required :status, enum: -> { Straddle::Models::Paykeys::ReviewGetResponse::Data::PaykeyDetails::Status }
|
|
99
|
+
|
|
100
|
+
# @!attribute updated_at
|
|
101
|
+
# Timestamp of the most recent update to the paykey.
|
|
102
|
+
#
|
|
103
|
+
# @return [Time]
|
|
104
|
+
required :updated_at, Time
|
|
105
|
+
|
|
106
|
+
# @!attribute balance
|
|
107
|
+
#
|
|
108
|
+
# @return [Straddle::Models::Paykeys::ReviewGetResponse::Data::PaykeyDetails::Balance, nil]
|
|
109
|
+
optional :balance, -> { Straddle::Models::Paykeys::ReviewGetResponse::Data::PaykeyDetails::Balance }
|
|
110
|
+
|
|
111
|
+
# @!attribute bank_data
|
|
112
|
+
#
|
|
113
|
+
# @return [Straddle::Models::Paykeys::ReviewGetResponse::Data::PaykeyDetails::BankData, nil]
|
|
114
|
+
optional :bank_data, -> { Straddle::Models::Paykeys::ReviewGetResponse::Data::PaykeyDetails::BankData }
|
|
115
|
+
|
|
116
|
+
# @!attribute customer_id
|
|
117
|
+
# Unique identifier of the related customer object.
|
|
118
|
+
#
|
|
119
|
+
# @return [String, nil]
|
|
120
|
+
optional :customer_id, String, nil?: true
|
|
121
|
+
|
|
122
|
+
# @!attribute expires_at
|
|
123
|
+
# Expiration date and time of the paykey, if applicable.
|
|
124
|
+
#
|
|
125
|
+
# @return [Time, nil]
|
|
126
|
+
optional :expires_at, Time, nil?: true
|
|
127
|
+
|
|
128
|
+
# @!attribute external_id
|
|
129
|
+
# Unique identifier for the paykey in your database, used for cross-referencing
|
|
130
|
+
# between Straddle and your systems.
|
|
131
|
+
#
|
|
132
|
+
# @return [String, nil]
|
|
133
|
+
optional :external_id, String, nil?: true
|
|
134
|
+
|
|
135
|
+
# @!attribute institution_name
|
|
136
|
+
# Name of the financial institution.
|
|
137
|
+
#
|
|
138
|
+
# @return [String, nil]
|
|
139
|
+
optional :institution_name, String, nil?: true
|
|
140
|
+
|
|
141
|
+
# @!attribute metadata
|
|
142
|
+
# Up to 20 additional user-defined key-value pairs. Useful for storing additional
|
|
143
|
+
# information about the paykey in a structured format.
|
|
144
|
+
#
|
|
145
|
+
# @return [Hash{Symbol=>String}, nil]
|
|
146
|
+
optional :metadata, Straddle::Internal::Type::HashOf[String], nil?: true
|
|
147
|
+
|
|
148
|
+
# @!attribute status_details
|
|
149
|
+
#
|
|
150
|
+
# @return [Straddle::Models::Paykeys::ReviewGetResponse::Data::PaykeyDetails::StatusDetails, nil]
|
|
151
|
+
optional :status_details,
|
|
152
|
+
-> { Straddle::Models::Paykeys::ReviewGetResponse::Data::PaykeyDetails::StatusDetails }
|
|
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)
|
|
155
|
+
# Some parameter documentations has been truncated, see
|
|
156
|
+
# {Straddle::Models::Paykeys::ReviewGetResponse::Data::PaykeyDetails} for more
|
|
157
|
+
# details.
|
|
158
|
+
#
|
|
159
|
+
# @param id [String] Unique identifier for the paykey.
|
|
160
|
+
#
|
|
161
|
+
# @param config [Straddle::Models::Paykeys::ReviewGetResponse::Data::PaykeyDetails::Config]
|
|
162
|
+
#
|
|
163
|
+
# @param created_at [Time] Timestamp of when the paykey was created.
|
|
164
|
+
#
|
|
165
|
+
# @param label [String] Human-readable label used to represent this paykey in a UI.
|
|
166
|
+
#
|
|
167
|
+
# @param paykey [String] The tokenized paykey value. This value is used to create payments and should be
|
|
168
|
+
#
|
|
169
|
+
# @param source [Symbol, Straddle::Models::Paykeys::ReviewGetResponse::Data::PaykeyDetails::Source]
|
|
170
|
+
#
|
|
171
|
+
# @param status [Symbol, Straddle::Models::Paykeys::ReviewGetResponse::Data::PaykeyDetails::Status]
|
|
172
|
+
#
|
|
173
|
+
# @param updated_at [Time] Timestamp of the most recent update to the paykey.
|
|
174
|
+
#
|
|
175
|
+
# @param balance [Straddle::Models::Paykeys::ReviewGetResponse::Data::PaykeyDetails::Balance]
|
|
176
|
+
#
|
|
177
|
+
# @param bank_data [Straddle::Models::Paykeys::ReviewGetResponse::Data::PaykeyDetails::BankData]
|
|
178
|
+
#
|
|
179
|
+
# @param customer_id [String, nil] Unique identifier of the related customer object.
|
|
180
|
+
#
|
|
181
|
+
# @param expires_at [Time, nil] Expiration date and time of the paykey, if applicable.
|
|
182
|
+
#
|
|
183
|
+
# @param external_id [String, nil] Unique identifier for the paykey in your database, used for cross-referencing be
|
|
184
|
+
#
|
|
185
|
+
# @param institution_name [String, nil] Name of the financial institution.
|
|
186
|
+
#
|
|
187
|
+
# @param metadata [Hash{Symbol=>String}, nil] Up to 20 additional user-defined key-value pairs. Useful for storing additional
|
|
188
|
+
#
|
|
189
|
+
# @param status_details [Straddle::Models::Paykeys::ReviewGetResponse::Data::PaykeyDetails::StatusDetails]
|
|
190
|
+
|
|
191
|
+
# @see Straddle::Models::Paykeys::ReviewGetResponse::Data::PaykeyDetails#config
|
|
192
|
+
class Config < Straddle::Internal::Type::BaseModel
|
|
193
|
+
# @!attribute processing_method
|
|
194
|
+
#
|
|
195
|
+
# @return [Symbol, Straddle::Models::Paykeys::ReviewGetResponse::Data::PaykeyDetails::Config::ProcessingMethod, nil]
|
|
196
|
+
optional :processing_method,
|
|
197
|
+
enum: -> { Straddle::Models::Paykeys::ReviewGetResponse::Data::PaykeyDetails::Config::ProcessingMethod }
|
|
198
|
+
|
|
199
|
+
# @!attribute sandbox_outcome
|
|
200
|
+
#
|
|
201
|
+
# @return [Symbol, Straddle::Models::Paykeys::ReviewGetResponse::Data::PaykeyDetails::Config::SandboxOutcome, nil]
|
|
202
|
+
optional :sandbox_outcome,
|
|
203
|
+
enum: -> { Straddle::Models::Paykeys::ReviewGetResponse::Data::PaykeyDetails::Config::SandboxOutcome }
|
|
204
|
+
|
|
205
|
+
# @!method initialize(processing_method: nil, sandbox_outcome: nil)
|
|
206
|
+
# @param processing_method [Symbol, Straddle::Models::Paykeys::ReviewGetResponse::Data::PaykeyDetails::Config::ProcessingMethod]
|
|
207
|
+
# @param sandbox_outcome [Symbol, Straddle::Models::Paykeys::ReviewGetResponse::Data::PaykeyDetails::Config::SandboxOutcome]
|
|
208
|
+
|
|
209
|
+
# @see Straddle::Models::Paykeys::ReviewGetResponse::Data::PaykeyDetails::Config#processing_method
|
|
210
|
+
module ProcessingMethod
|
|
211
|
+
extend Straddle::Internal::Type::Enum
|
|
212
|
+
|
|
213
|
+
INLINE = :inline
|
|
214
|
+
BACKGROUND = :background
|
|
215
|
+
SKIP = :skip
|
|
216
|
+
|
|
217
|
+
# @!method self.values
|
|
218
|
+
# @return [Array<Symbol>]
|
|
219
|
+
end
|
|
220
|
+
|
|
221
|
+
# @see Straddle::Models::Paykeys::ReviewGetResponse::Data::PaykeyDetails::Config#sandbox_outcome
|
|
222
|
+
module SandboxOutcome
|
|
223
|
+
extend Straddle::Internal::Type::Enum
|
|
224
|
+
|
|
225
|
+
STANDARD = :standard
|
|
226
|
+
ACTIVE = :active
|
|
227
|
+
REJECTED = :rejected
|
|
228
|
+
REVIEW = :review
|
|
229
|
+
|
|
230
|
+
# @!method self.values
|
|
231
|
+
# @return [Array<Symbol>]
|
|
232
|
+
end
|
|
233
|
+
end
|
|
234
|
+
|
|
235
|
+
# @see Straddle::Models::Paykeys::ReviewGetResponse::Data::PaykeyDetails#source
|
|
236
|
+
module Source
|
|
237
|
+
extend Straddle::Internal::Type::Enum
|
|
238
|
+
|
|
239
|
+
BANK_ACCOUNT = :bank_account
|
|
240
|
+
STRADDLE = :straddle
|
|
241
|
+
MX = :mx
|
|
242
|
+
PLAID = :plaid
|
|
243
|
+
TAN = :tan
|
|
244
|
+
QUILTT = :quiltt
|
|
245
|
+
|
|
246
|
+
# @!method self.values
|
|
247
|
+
# @return [Array<Symbol>]
|
|
248
|
+
end
|
|
249
|
+
|
|
250
|
+
# @see Straddle::Models::Paykeys::ReviewGetResponse::Data::PaykeyDetails#status
|
|
251
|
+
module Status
|
|
252
|
+
extend Straddle::Internal::Type::Enum
|
|
253
|
+
|
|
254
|
+
PENDING = :pending
|
|
255
|
+
ACTIVE = :active
|
|
256
|
+
INACTIVE = :inactive
|
|
257
|
+
REJECTED = :rejected
|
|
258
|
+
REVIEW = :review
|
|
259
|
+
|
|
260
|
+
# @!method self.values
|
|
261
|
+
# @return [Array<Symbol>]
|
|
262
|
+
end
|
|
263
|
+
|
|
264
|
+
# @see Straddle::Models::Paykeys::ReviewGetResponse::Data::PaykeyDetails#balance
|
|
265
|
+
class Balance < Straddle::Internal::Type::BaseModel
|
|
266
|
+
# @!attribute status
|
|
267
|
+
#
|
|
268
|
+
# @return [Symbol, Straddle::Models::Paykeys::ReviewGetResponse::Data::PaykeyDetails::Balance::Status]
|
|
269
|
+
required :status,
|
|
270
|
+
enum: -> { Straddle::Models::Paykeys::ReviewGetResponse::Data::PaykeyDetails::Balance::Status }
|
|
271
|
+
|
|
272
|
+
# @!attribute account_balance
|
|
273
|
+
# Account Balance when last retrieved
|
|
274
|
+
#
|
|
275
|
+
# @return [Integer, nil]
|
|
276
|
+
optional :account_balance, Integer, nil?: true
|
|
277
|
+
|
|
278
|
+
# @!attribute updated_at
|
|
279
|
+
# Last time account balance was updated.
|
|
280
|
+
#
|
|
281
|
+
# @return [Time, nil]
|
|
282
|
+
optional :updated_at, Time, nil?: true
|
|
283
|
+
|
|
284
|
+
# @!method initialize(status:, account_balance: nil, updated_at: nil)
|
|
285
|
+
# @param status [Symbol, Straddle::Models::Paykeys::ReviewGetResponse::Data::PaykeyDetails::Balance::Status]
|
|
286
|
+
#
|
|
287
|
+
# @param account_balance [Integer, nil] Account Balance when last retrieved
|
|
288
|
+
#
|
|
289
|
+
# @param updated_at [Time, nil] Last time account balance was updated.
|
|
290
|
+
|
|
291
|
+
# @see Straddle::Models::Paykeys::ReviewGetResponse::Data::PaykeyDetails::Balance#status
|
|
292
|
+
module Status
|
|
293
|
+
extend Straddle::Internal::Type::Enum
|
|
294
|
+
|
|
295
|
+
PENDING = :pending
|
|
296
|
+
COMPLETED = :completed
|
|
297
|
+
FAILED = :failed
|
|
298
|
+
|
|
299
|
+
# @!method self.values
|
|
300
|
+
# @return [Array<Symbol>]
|
|
301
|
+
end
|
|
302
|
+
end
|
|
303
|
+
|
|
304
|
+
# @see Straddle::Models::Paykeys::ReviewGetResponse::Data::PaykeyDetails#bank_data
|
|
305
|
+
class BankData < Straddle::Internal::Type::BaseModel
|
|
306
|
+
# @!attribute account_number
|
|
307
|
+
# Bank account number. This value is masked by default for security reasons. Use
|
|
308
|
+
# the /unmask endpoint to access the unmasked value.
|
|
309
|
+
#
|
|
310
|
+
# @return [String]
|
|
311
|
+
required :account_number, String
|
|
312
|
+
|
|
313
|
+
# @!attribute account_type
|
|
314
|
+
#
|
|
315
|
+
# @return [Symbol, Straddle::Models::Paykeys::ReviewGetResponse::Data::PaykeyDetails::BankData::AccountType]
|
|
316
|
+
required :account_type,
|
|
317
|
+
enum: -> { Straddle::Models::Paykeys::ReviewGetResponse::Data::PaykeyDetails::BankData::AccountType }
|
|
318
|
+
|
|
319
|
+
# @!attribute routing_number
|
|
320
|
+
# The routing number of the bank account.
|
|
321
|
+
#
|
|
322
|
+
# @return [String]
|
|
323
|
+
required :routing_number, String
|
|
324
|
+
|
|
325
|
+
# @!method initialize(account_number:, account_type:, routing_number:)
|
|
326
|
+
# Some parameter documentations has been truncated, see
|
|
327
|
+
# {Straddle::Models::Paykeys::ReviewGetResponse::Data::PaykeyDetails::BankData}
|
|
328
|
+
# for more details.
|
|
329
|
+
#
|
|
330
|
+
# @param account_number [String] Bank account number. This value is masked by default for security reasons. Use t
|
|
331
|
+
#
|
|
332
|
+
# @param account_type [Symbol, Straddle::Models::Paykeys::ReviewGetResponse::Data::PaykeyDetails::BankData::AccountType]
|
|
333
|
+
#
|
|
334
|
+
# @param routing_number [String] The routing number of the bank account.
|
|
335
|
+
|
|
336
|
+
# @see Straddle::Models::Paykeys::ReviewGetResponse::Data::PaykeyDetails::BankData#account_type
|
|
337
|
+
module AccountType
|
|
338
|
+
extend Straddle::Internal::Type::Enum
|
|
339
|
+
|
|
340
|
+
CHECKING = :checking
|
|
341
|
+
SAVINGS = :savings
|
|
342
|
+
|
|
343
|
+
# @!method self.values
|
|
344
|
+
# @return [Array<Symbol>]
|
|
345
|
+
end
|
|
346
|
+
end
|
|
347
|
+
|
|
348
|
+
# @see Straddle::Models::Paykeys::ReviewGetResponse::Data::PaykeyDetails#status_details
|
|
349
|
+
class StatusDetails < Straddle::Internal::Type::BaseModel
|
|
350
|
+
# @!attribute changed_at
|
|
351
|
+
# The time the status change occurred.
|
|
352
|
+
#
|
|
353
|
+
# @return [Time]
|
|
354
|
+
required :changed_at, Time
|
|
355
|
+
|
|
356
|
+
# @!attribute message
|
|
357
|
+
# A human-readable description of the current status.
|
|
358
|
+
#
|
|
359
|
+
# @return [String]
|
|
360
|
+
required :message, String
|
|
361
|
+
|
|
362
|
+
# @!attribute reason
|
|
363
|
+
#
|
|
364
|
+
# @return [Symbol, Straddle::Models::Paykeys::ReviewGetResponse::Data::PaykeyDetails::StatusDetails::Reason]
|
|
365
|
+
required :reason,
|
|
366
|
+
enum: -> { Straddle::Models::Paykeys::ReviewGetResponse::Data::PaykeyDetails::StatusDetails::Reason }
|
|
367
|
+
|
|
368
|
+
# @!attribute source
|
|
369
|
+
#
|
|
370
|
+
# @return [Symbol, Straddle::Models::Paykeys::ReviewGetResponse::Data::PaykeyDetails::StatusDetails::Source]
|
|
371
|
+
required :source,
|
|
372
|
+
enum: -> { Straddle::Models::Paykeys::ReviewGetResponse::Data::PaykeyDetails::StatusDetails::Source }
|
|
373
|
+
|
|
374
|
+
# @!attribute code
|
|
375
|
+
# The status code if applicable.
|
|
376
|
+
#
|
|
377
|
+
# @return [String, nil]
|
|
378
|
+
optional :code, String, nil?: true
|
|
379
|
+
|
|
380
|
+
# @!method initialize(changed_at:, message:, reason:, source:, code: nil)
|
|
381
|
+
# @param changed_at [Time] The time the status change occurred.
|
|
382
|
+
#
|
|
383
|
+
# @param message [String] A human-readable description of the current status.
|
|
384
|
+
#
|
|
385
|
+
# @param reason [Symbol, Straddle::Models::Paykeys::ReviewGetResponse::Data::PaykeyDetails::StatusDetails::Reason]
|
|
386
|
+
#
|
|
387
|
+
# @param source [Symbol, Straddle::Models::Paykeys::ReviewGetResponse::Data::PaykeyDetails::StatusDetails::Source]
|
|
388
|
+
#
|
|
389
|
+
# @param code [String, nil] The status code if applicable.
|
|
390
|
+
|
|
391
|
+
# @see Straddle::Models::Paykeys::ReviewGetResponse::Data::PaykeyDetails::StatusDetails#reason
|
|
392
|
+
module Reason
|
|
393
|
+
extend Straddle::Internal::Type::Enum
|
|
394
|
+
|
|
395
|
+
INSUFFICIENT_FUNDS = :insufficient_funds
|
|
396
|
+
CLOSED_BANK_ACCOUNT = :closed_bank_account
|
|
397
|
+
INVALID_BANK_ACCOUNT = :invalid_bank_account
|
|
398
|
+
INVALID_ROUTING = :invalid_routing
|
|
399
|
+
DISPUTED = :disputed
|
|
400
|
+
PAYMENT_STOPPED = :payment_stopped
|
|
401
|
+
OWNER_DECEASED = :owner_deceased
|
|
402
|
+
FROZEN_BANK_ACCOUNT = :frozen_bank_account
|
|
403
|
+
RISK_REVIEW = :risk_review
|
|
404
|
+
FRAUDULENT = :fraudulent
|
|
405
|
+
DUPLICATE_ENTRY = :duplicate_entry
|
|
406
|
+
INVALID_PAYKEY = :invalid_paykey
|
|
407
|
+
PAYMENT_BLOCKED = :payment_blocked
|
|
408
|
+
AMOUNT_TOO_LARGE = :amount_too_large
|
|
409
|
+
TOO_MANY_ATTEMPTS = :too_many_attempts
|
|
410
|
+
INTERNAL_SYSTEM_ERROR = :internal_system_error
|
|
411
|
+
USER_REQUEST = :user_request
|
|
412
|
+
OK = :ok
|
|
413
|
+
OTHER_NETWORK_RETURN = :other_network_return
|
|
414
|
+
PAYOUT_REFUSED = :payout_refused
|
|
415
|
+
|
|
416
|
+
# @!method self.values
|
|
417
|
+
# @return [Array<Symbol>]
|
|
418
|
+
end
|
|
419
|
+
|
|
420
|
+
# @see Straddle::Models::Paykeys::ReviewGetResponse::Data::PaykeyDetails::StatusDetails#source
|
|
421
|
+
module Source
|
|
422
|
+
extend Straddle::Internal::Type::Enum
|
|
423
|
+
|
|
424
|
+
WATCHTOWER = :watchtower
|
|
425
|
+
BANK_DECLINE = :bank_decline
|
|
426
|
+
CUSTOMER_DISPUTE = :customer_dispute
|
|
427
|
+
USER_ACTION = :user_action
|
|
428
|
+
SYSTEM = :system
|
|
429
|
+
|
|
430
|
+
# @!method self.values
|
|
431
|
+
# @return [Array<Symbol>]
|
|
432
|
+
end
|
|
433
|
+
end
|
|
434
|
+
end
|
|
435
|
+
|
|
436
|
+
# @see Straddle::Models::Paykeys::ReviewGetResponse::Data#verification_details
|
|
437
|
+
class VerificationDetails < Straddle::Internal::Type::BaseModel
|
|
438
|
+
# @!attribute id
|
|
439
|
+
# Unique identifier for the verification details.
|
|
440
|
+
#
|
|
441
|
+
# @return [String]
|
|
442
|
+
required :id, String
|
|
443
|
+
|
|
444
|
+
# @!attribute breakdown
|
|
445
|
+
#
|
|
446
|
+
# @return [Straddle::Models::Paykeys::ReviewGetResponse::Data::VerificationDetails::Breakdown]
|
|
447
|
+
required :breakdown,
|
|
448
|
+
-> { Straddle::Models::Paykeys::ReviewGetResponse::Data::VerificationDetails::Breakdown }
|
|
449
|
+
|
|
450
|
+
# @!attribute created_at
|
|
451
|
+
# Timestamp of when the verification was initiated.
|
|
452
|
+
#
|
|
453
|
+
# @return [Time]
|
|
454
|
+
required :created_at, Time
|
|
455
|
+
|
|
456
|
+
# @!attribute decision
|
|
457
|
+
#
|
|
458
|
+
# @return [Symbol, Straddle::Models::Paykeys::ReviewGetResponse::Data::VerificationDetails::Decision]
|
|
459
|
+
required :decision,
|
|
460
|
+
enum: -> { Straddle::Models::Paykeys::ReviewGetResponse::Data::VerificationDetails::Decision }
|
|
461
|
+
|
|
462
|
+
# @!attribute messages
|
|
463
|
+
# Dictionary of all messages from the paykey verification process.
|
|
464
|
+
#
|
|
465
|
+
# @return [Hash{Symbol=>String}]
|
|
466
|
+
required :messages, Straddle::Internal::Type::HashOf[String]
|
|
467
|
+
|
|
468
|
+
# @!attribute updated_at
|
|
469
|
+
# Timestamp of the most recent update to the verification details.
|
|
470
|
+
#
|
|
471
|
+
# @return [Time]
|
|
472
|
+
required :updated_at, Time
|
|
473
|
+
|
|
474
|
+
# @!method initialize(id:, breakdown:, created_at:, decision:, messages:, updated_at:)
|
|
475
|
+
# @param id [String] Unique identifier for the verification details.
|
|
476
|
+
#
|
|
477
|
+
# @param breakdown [Straddle::Models::Paykeys::ReviewGetResponse::Data::VerificationDetails::Breakdown]
|
|
478
|
+
#
|
|
479
|
+
# @param created_at [Time] Timestamp of when the verification was initiated.
|
|
480
|
+
#
|
|
481
|
+
# @param decision [Symbol, Straddle::Models::Paykeys::ReviewGetResponse::Data::VerificationDetails::Decision]
|
|
482
|
+
#
|
|
483
|
+
# @param messages [Hash{Symbol=>String}] Dictionary of all messages from the paykey verification process.
|
|
484
|
+
#
|
|
485
|
+
# @param updated_at [Time] Timestamp of the most recent update to the verification details.
|
|
486
|
+
|
|
487
|
+
# @see Straddle::Models::Paykeys::ReviewGetResponse::Data::VerificationDetails#breakdown
|
|
488
|
+
class Breakdown < Straddle::Internal::Type::BaseModel
|
|
489
|
+
# @!attribute account_validation
|
|
490
|
+
#
|
|
491
|
+
# @return [Straddle::Models::Paykeys::ReviewGetResponse::Data::VerificationDetails::Breakdown::AccountValidation, nil]
|
|
492
|
+
optional :account_validation,
|
|
493
|
+
-> { Straddle::Models::Paykeys::ReviewGetResponse::Data::VerificationDetails::Breakdown::AccountValidation }
|
|
494
|
+
|
|
495
|
+
# @!attribute name_match
|
|
496
|
+
#
|
|
497
|
+
# @return [Straddle::Models::Paykeys::ReviewGetResponse::Data::VerificationDetails::Breakdown::NameMatch, nil]
|
|
498
|
+
optional :name_match,
|
|
499
|
+
-> { Straddle::Models::Paykeys::ReviewGetResponse::Data::VerificationDetails::Breakdown::NameMatch }
|
|
500
|
+
|
|
501
|
+
# @!method initialize(account_validation: nil, name_match: nil)
|
|
502
|
+
# @param account_validation [Straddle::Models::Paykeys::ReviewGetResponse::Data::VerificationDetails::Breakdown::AccountValidation]
|
|
503
|
+
# @param name_match [Straddle::Models::Paykeys::ReviewGetResponse::Data::VerificationDetails::Breakdown::NameMatch]
|
|
504
|
+
|
|
505
|
+
# @see Straddle::Models::Paykeys::ReviewGetResponse::Data::VerificationDetails::Breakdown#account_validation
|
|
506
|
+
class AccountValidation < Straddle::Internal::Type::BaseModel
|
|
507
|
+
# @!attribute codes
|
|
508
|
+
#
|
|
509
|
+
# @return [Array<String>]
|
|
510
|
+
required :codes, Straddle::Internal::Type::ArrayOf[String]
|
|
511
|
+
|
|
512
|
+
# @!attribute decision
|
|
513
|
+
#
|
|
514
|
+
# @return [Symbol, Straddle::Models::Paykeys::ReviewGetResponse::Data::VerificationDetails::Breakdown::AccountValidation::Decision]
|
|
515
|
+
required :decision,
|
|
516
|
+
enum: -> { Straddle::Models::Paykeys::ReviewGetResponse::Data::VerificationDetails::Breakdown::AccountValidation::Decision }
|
|
517
|
+
|
|
518
|
+
# @!attribute reason
|
|
519
|
+
#
|
|
520
|
+
# @return [String, nil]
|
|
521
|
+
optional :reason, String, nil?: true
|
|
522
|
+
|
|
523
|
+
# @!method initialize(codes:, decision:, reason: nil)
|
|
524
|
+
# @param codes [Array<String>]
|
|
525
|
+
# @param decision [Symbol, Straddle::Models::Paykeys::ReviewGetResponse::Data::VerificationDetails::Breakdown::AccountValidation::Decision]
|
|
526
|
+
# @param reason [String, nil]
|
|
527
|
+
|
|
528
|
+
# @see Straddle::Models::Paykeys::ReviewGetResponse::Data::VerificationDetails::Breakdown::AccountValidation#decision
|
|
529
|
+
module Decision
|
|
530
|
+
extend Straddle::Internal::Type::Enum
|
|
531
|
+
|
|
532
|
+
UNKNOWN = :unknown
|
|
533
|
+
ACCEPT = :accept
|
|
534
|
+
REJECT = :reject
|
|
535
|
+
REVIEW = :review
|
|
536
|
+
|
|
537
|
+
# @!method self.values
|
|
538
|
+
# @return [Array<Symbol>]
|
|
539
|
+
end
|
|
540
|
+
end
|
|
541
|
+
|
|
542
|
+
# @see Straddle::Models::Paykeys::ReviewGetResponse::Data::VerificationDetails::Breakdown#name_match
|
|
543
|
+
class NameMatch < Straddle::Internal::Type::BaseModel
|
|
544
|
+
# @!attribute codes
|
|
545
|
+
#
|
|
546
|
+
# @return [Array<String>]
|
|
547
|
+
required :codes, Straddle::Internal::Type::ArrayOf[String]
|
|
548
|
+
|
|
549
|
+
# @!attribute decision
|
|
550
|
+
#
|
|
551
|
+
# @return [Symbol, Straddle::Models::Paykeys::ReviewGetResponse::Data::VerificationDetails::Breakdown::NameMatch::Decision]
|
|
552
|
+
required :decision,
|
|
553
|
+
enum: -> { Straddle::Models::Paykeys::ReviewGetResponse::Data::VerificationDetails::Breakdown::NameMatch::Decision }
|
|
554
|
+
|
|
555
|
+
# @!attribute correlation_score
|
|
556
|
+
#
|
|
557
|
+
# @return [Float, nil]
|
|
558
|
+
optional :correlation_score, Float, nil?: true
|
|
559
|
+
|
|
560
|
+
# @!attribute customer_name
|
|
561
|
+
#
|
|
562
|
+
# @return [String, nil]
|
|
563
|
+
optional :customer_name, String, nil?: true
|
|
564
|
+
|
|
565
|
+
# @!attribute matched_name
|
|
566
|
+
#
|
|
567
|
+
# @return [String, nil]
|
|
568
|
+
optional :matched_name, String, nil?: true
|
|
569
|
+
|
|
570
|
+
# @!attribute names_on_account
|
|
571
|
+
#
|
|
572
|
+
# @return [Array<String>, nil]
|
|
573
|
+
optional :names_on_account, Straddle::Internal::Type::ArrayOf[String], nil?: true
|
|
574
|
+
|
|
575
|
+
# @!attribute reason
|
|
576
|
+
#
|
|
577
|
+
# @return [String, nil]
|
|
578
|
+
optional :reason, String, nil?: true
|
|
579
|
+
|
|
580
|
+
# @!method initialize(codes:, decision:, correlation_score: nil, customer_name: nil, matched_name: nil, names_on_account: nil, reason: nil)
|
|
581
|
+
# @param codes [Array<String>]
|
|
582
|
+
# @param decision [Symbol, Straddle::Models::Paykeys::ReviewGetResponse::Data::VerificationDetails::Breakdown::NameMatch::Decision]
|
|
583
|
+
# @param correlation_score [Float, nil]
|
|
584
|
+
# @param customer_name [String, nil]
|
|
585
|
+
# @param matched_name [String, nil]
|
|
586
|
+
# @param names_on_account [Array<String>, nil]
|
|
587
|
+
# @param reason [String, nil]
|
|
588
|
+
|
|
589
|
+
# @see Straddle::Models::Paykeys::ReviewGetResponse::Data::VerificationDetails::Breakdown::NameMatch#decision
|
|
590
|
+
module Decision
|
|
591
|
+
extend Straddle::Internal::Type::Enum
|
|
592
|
+
|
|
593
|
+
UNKNOWN = :unknown
|
|
594
|
+
ACCEPT = :accept
|
|
595
|
+
REJECT = :reject
|
|
596
|
+
REVIEW = :review
|
|
597
|
+
|
|
598
|
+
# @!method self.values
|
|
599
|
+
# @return [Array<Symbol>]
|
|
600
|
+
end
|
|
601
|
+
end
|
|
602
|
+
end
|
|
603
|
+
|
|
604
|
+
# @see Straddle::Models::Paykeys::ReviewGetResponse::Data::VerificationDetails#decision
|
|
605
|
+
module Decision
|
|
606
|
+
extend Straddle::Internal::Type::Enum
|
|
607
|
+
|
|
608
|
+
UNKNOWN = :unknown
|
|
609
|
+
ACCEPT = :accept
|
|
610
|
+
REJECT = :reject
|
|
611
|
+
REVIEW = :review
|
|
612
|
+
|
|
613
|
+
# @!method self.values
|
|
614
|
+
# @return [Array<Symbol>]
|
|
615
|
+
end
|
|
616
|
+
end
|
|
617
|
+
end
|
|
618
|
+
|
|
619
|
+
# Indicates the structure of the returned content.
|
|
620
|
+
#
|
|
621
|
+
# - "object" means the `data` field contains a single JSON object.
|
|
622
|
+
# - "array" means the `data` field contains an array of objects.
|
|
623
|
+
# - "error" means the `data` field contains an error object with details of the
|
|
624
|
+
# issue.
|
|
625
|
+
# - "none" means no data is returned.
|
|
626
|
+
#
|
|
627
|
+
# @see Straddle::Models::Paykeys::ReviewGetResponse#response_type
|
|
628
|
+
module ResponseType
|
|
629
|
+
extend Straddle::Internal::Type::Enum
|
|
630
|
+
|
|
631
|
+
OBJECT = :object
|
|
632
|
+
ARRAY = :array
|
|
633
|
+
ERROR = :error
|
|
634
|
+
NONE = :none
|
|
635
|
+
|
|
636
|
+
# @!method self.values
|
|
637
|
+
# @return [Array<Symbol>]
|
|
638
|
+
end
|
|
639
|
+
end
|
|
640
|
+
end
|
|
641
|
+
end
|
|
642
|
+
end
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Straddle
|
|
4
|
+
module Models
|
|
5
|
+
module Paykeys
|
|
6
|
+
# @see Straddle::Resources::Paykeys::Review#refresh_review
|
|
7
|
+
class ReviewRefreshReviewParams < Straddle::Internal::Type::BaseModel
|
|
8
|
+
extend Straddle::Internal::Type::RequestParameters::Converter
|
|
9
|
+
include Straddle::Internal::Type::RequestParameters
|
|
10
|
+
|
|
11
|
+
# @!attribute correlation_id
|
|
12
|
+
#
|
|
13
|
+
# @return [String, nil]
|
|
14
|
+
optional :correlation_id, String
|
|
15
|
+
|
|
16
|
+
# @!attribute idempotency_key
|
|
17
|
+
#
|
|
18
|
+
# @return [String, nil]
|
|
19
|
+
optional :idempotency_key, String
|
|
20
|
+
|
|
21
|
+
# @!attribute request_id
|
|
22
|
+
#
|
|
23
|
+
# @return [String, nil]
|
|
24
|
+
optional :request_id, String
|
|
25
|
+
|
|
26
|
+
# @!attribute straddle_account_id
|
|
27
|
+
#
|
|
28
|
+
# @return [String, nil]
|
|
29
|
+
optional :straddle_account_id, String
|
|
30
|
+
|
|
31
|
+
# @!method initialize(correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
|
|
32
|
+
# @param correlation_id [String]
|
|
33
|
+
# @param idempotency_key [String]
|
|
34
|
+
# @param request_id [String]
|
|
35
|
+
# @param straddle_account_id [String]
|
|
36
|
+
# @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}]
|
|
37
|
+
end
|
|
38
|
+
end
|
|
39
|
+
end
|
|
40
|
+
end
|