whop_sdk 0.0.11 → 0.0.12

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 (43) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +10 -0
  3. data/README.md +1 -1
  4. data/lib/whop_sdk/models/checkout_configuration_create_params.rb +9 -1
  5. data/lib/whop_sdk/models/plan.rb +9 -1
  6. data/lib/whop_sdk/models/plan_create_params.rb +9 -1
  7. data/lib/whop_sdk/models/plan_list_response.rb +9 -1
  8. data/lib/whop_sdk/models/product_create_params.rb +2 -2
  9. data/lib/whop_sdk/models/unwrap_webhook_event.rb +5 -1
  10. data/lib/whop_sdk/models/withdrawal_created_webhook_event.rb +309 -0
  11. data/lib/whop_sdk/models/withdrawal_retrieve_response.rb +111 -166
  12. data/lib/whop_sdk/models/withdrawal_updated_webhook_event.rb +309 -0
  13. data/lib/whop_sdk/models.rb +4 -0
  14. data/lib/whop_sdk/resources/plans.rb +3 -1
  15. data/lib/whop_sdk/resources/products.rb +1 -1
  16. data/lib/whop_sdk/resources/webhooks.rb +1 -1
  17. data/lib/whop_sdk/version.rb +1 -1
  18. data/lib/whop_sdk.rb +2 -0
  19. data/rbi/whop_sdk/models/checkout_configuration_create_params.rbi +8 -0
  20. data/rbi/whop_sdk/models/plan.rbi +8 -0
  21. data/rbi/whop_sdk/models/plan_create_params.rbi +8 -0
  22. data/rbi/whop_sdk/models/plan_list_response.rbi +8 -0
  23. data/rbi/whop_sdk/models/product_create_params.rbi +2 -2
  24. data/rbi/whop_sdk/models/unwrap_webhook_event.rbi +2 -0
  25. data/rbi/whop_sdk/models/withdrawal_created_webhook_event.rbi +633 -0
  26. data/rbi/whop_sdk/models/withdrawal_retrieve_response.rbi +326 -480
  27. data/rbi/whop_sdk/models/withdrawal_updated_webhook_event.rbi +633 -0
  28. data/rbi/whop_sdk/models.rbi +4 -0
  29. data/rbi/whop_sdk/resources/plans.rbi +3 -0
  30. data/rbi/whop_sdk/resources/products.rbi +1 -1
  31. data/rbi/whop_sdk/resources/webhooks.rbi +2 -0
  32. data/sig/whop_sdk/models/checkout_configuration_create_params.rbs +5 -0
  33. data/sig/whop_sdk/models/plan.rbs +5 -0
  34. data/sig/whop_sdk/models/plan_create_params.rbs +5 -0
  35. data/sig/whop_sdk/models/plan_list_response.rbs +5 -0
  36. data/sig/whop_sdk/models/unwrap_webhook_event.rbs +2 -0
  37. data/sig/whop_sdk/models/withdrawal_created_webhook_event.rbs +275 -0
  38. data/sig/whop_sdk/models/withdrawal_retrieve_response.rbs +132 -191
  39. data/sig/whop_sdk/models/withdrawal_updated_webhook_event.rbs +275 -0
  40. data/sig/whop_sdk/models.rbs +4 -0
  41. data/sig/whop_sdk/resources/plans.rbs +1 -0
  42. data/sig/whop_sdk/resources/webhooks.rbs +2 -0
  43. metadata +8 -2
@@ -27,6 +27,24 @@ module WhopSDK
27
27
  sig { returns(WhopSDK::Currency::TaggedSymbol) }
28
28
  attr_accessor :currency
29
29
 
30
+ # The different error codes a payout can be in.
31
+ sig do
32
+ returns(
33
+ T.nilable(
34
+ WhopSDK::Models::WithdrawalRetrieveResponse::ErrorCode::TaggedSymbol
35
+ )
36
+ )
37
+ end
38
+ attr_accessor :error_code
39
+
40
+ # The error message for the withdrawal, if any.
41
+ sig { returns(T.nilable(String)) }
42
+ attr_accessor :error_message
43
+
44
+ # The estimated availability date for the withdrawal, if any.
45
+ sig { returns(T.nilable(Time)) }
46
+ attr_accessor :estimated_availability
47
+
30
48
  # The fee amount that was charged for the withdrawal. This is in the same currency
31
49
  # as the withdrawal amount.
32
50
  sig { returns(Float) }
@@ -36,23 +54,19 @@ module WhopSDK
36
54
  sig { returns(T.nilable(WhopSDK::WithdrawalFeeTypes::TaggedSymbol)) }
37
55
  attr_accessor :fee_type
38
56
 
39
- # The latest payout associated with this withdrawal, if any.
57
+ # The ledger account associated with the withdrawal.
40
58
  sig do
41
- returns(
42
- T.nilable(WhopSDK::Models::WithdrawalRetrieveResponse::LatestPayout)
43
- )
59
+ returns(WhopSDK::Models::WithdrawalRetrieveResponse::LedgerAccount)
44
60
  end
45
- attr_reader :latest_payout
61
+ attr_reader :ledger_account
46
62
 
47
63
  sig do
48
64
  params(
49
- latest_payout:
50
- T.nilable(
51
- WhopSDK::Models::WithdrawalRetrieveResponse::LatestPayout::OrHash
52
- )
65
+ ledger_account:
66
+ WhopSDK::Models::WithdrawalRetrieveResponse::LedgerAccount::OrHash
53
67
  ).void
54
68
  end
55
- attr_writer :latest_payout
69
+ attr_writer :ledger_account
56
70
 
57
71
  # The payout token used for the withdrawal, if applicable.
58
72
  sig do
@@ -80,6 +94,11 @@ module WhopSDK
80
94
  sig { returns(WhopSDK::WithdrawalStatus::TaggedSymbol) }
81
95
  attr_accessor :status
82
96
 
97
+ # The trace code for the payout, if applicable. Provided on ACH transactions when
98
+ # available.
99
+ sig { returns(T.nilable(String)) }
100
+ attr_accessor :trace_code
101
+
83
102
  # The type of withdrawal.
84
103
  sig { returns(WhopSDK::WithdrawalTypes::TaggedSymbol) }
85
104
  attr_accessor :withdrawal_type
@@ -91,18 +110,23 @@ module WhopSDK
91
110
  amount: Float,
92
111
  created_at: Time,
93
112
  currency: WhopSDK::Currency::OrSymbol,
94
- fee_amount: Float,
95
- fee_type: T.nilable(WhopSDK::WithdrawalFeeTypes::OrSymbol),
96
- latest_payout:
113
+ error_code:
97
114
  T.nilable(
98
- WhopSDK::Models::WithdrawalRetrieveResponse::LatestPayout::OrHash
115
+ WhopSDK::Models::WithdrawalRetrieveResponse::ErrorCode::OrSymbol
99
116
  ),
117
+ error_message: T.nilable(String),
118
+ estimated_availability: T.nilable(Time),
119
+ fee_amount: Float,
120
+ fee_type: T.nilable(WhopSDK::WithdrawalFeeTypes::OrSymbol),
121
+ ledger_account:
122
+ WhopSDK::Models::WithdrawalRetrieveResponse::LedgerAccount::OrHash,
100
123
  payout_token:
101
124
  T.nilable(
102
125
  WhopSDK::Models::WithdrawalRetrieveResponse::PayoutToken::OrHash
103
126
  ),
104
127
  speed: WhopSDK::WithdrawalSpeeds::OrSymbol,
105
128
  status: WhopSDK::WithdrawalStatus::OrSymbol,
129
+ trace_code: T.nilable(String),
106
130
  withdrawal_type: WhopSDK::WithdrawalTypes::OrSymbol
107
131
  ).returns(T.attached_class)
108
132
  end
@@ -115,19 +139,28 @@ module WhopSDK
115
139
  created_at:,
116
140
  # The currency of the withdrawal request.
117
141
  currency:,
142
+ # The different error codes a payout can be in.
143
+ error_code:,
144
+ # The error message for the withdrawal, if any.
145
+ error_message:,
146
+ # The estimated availability date for the withdrawal, if any.
147
+ estimated_availability:,
118
148
  # The fee amount that was charged for the withdrawal. This is in the same currency
119
149
  # as the withdrawal amount.
120
150
  fee_amount:,
121
151
  # The different fee types for a withdrawal.
122
152
  fee_type:,
123
- # The latest payout associated with this withdrawal, if any.
124
- latest_payout:,
153
+ # The ledger account associated with the withdrawal.
154
+ ledger_account:,
125
155
  # The payout token used for the withdrawal, if applicable.
126
156
  payout_token:,
127
157
  # The speed of the withdrawal.
128
158
  speed:,
129
159
  # Status of the withdrawal.
130
160
  status:,
161
+ # The trace code for the payout, if applicable. Provided on ACH transactions when
162
+ # available.
163
+ trace_code:,
131
164
  # The type of withdrawal.
132
165
  withdrawal_type:
133
166
  )
@@ -140,18 +173,23 @@ module WhopSDK
140
173
  amount: Float,
141
174
  created_at: Time,
142
175
  currency: WhopSDK::Currency::TaggedSymbol,
143
- fee_amount: Float,
144
- fee_type: T.nilable(WhopSDK::WithdrawalFeeTypes::TaggedSymbol),
145
- latest_payout:
176
+ error_code:
146
177
  T.nilable(
147
- WhopSDK::Models::WithdrawalRetrieveResponse::LatestPayout
178
+ WhopSDK::Models::WithdrawalRetrieveResponse::ErrorCode::TaggedSymbol
148
179
  ),
180
+ error_message: T.nilable(String),
181
+ estimated_availability: T.nilable(Time),
182
+ fee_amount: Float,
183
+ fee_type: T.nilable(WhopSDK::WithdrawalFeeTypes::TaggedSymbol),
184
+ ledger_account:
185
+ WhopSDK::Models::WithdrawalRetrieveResponse::LedgerAccount,
149
186
  payout_token:
150
187
  T.nilable(
151
188
  WhopSDK::Models::WithdrawalRetrieveResponse::PayoutToken
152
189
  ),
153
190
  speed: WhopSDK::WithdrawalSpeeds::TaggedSymbol,
154
191
  status: WhopSDK::WithdrawalStatus::TaggedSymbol,
192
+ trace_code: T.nilable(String),
155
193
  withdrawal_type: WhopSDK::WithdrawalTypes::TaggedSymbol
156
194
  }
157
195
  )
@@ -159,436 +197,290 @@ module WhopSDK
159
197
  def to_hash
160
198
  end
161
199
 
162
- class LatestPayout < WhopSDK::Internal::Type::BaseModel
163
- OrHash =
200
+ # The different error codes a payout can be in.
201
+ module ErrorCode
202
+ extend WhopSDK::Internal::Type::Enum
203
+
204
+ TaggedSymbol =
164
205
  T.type_alias do
165
- T.any(
166
- WhopSDK::Models::WithdrawalRetrieveResponse::LatestPayout,
167
- WhopSDK::Internal::AnyHash
206
+ T.all(
207
+ Symbol,
208
+ WhopSDK::Models::WithdrawalRetrieveResponse::ErrorCode
168
209
  )
169
210
  end
211
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
170
212
 
171
- # The internal ID of the payout.
172
- sig { returns(String) }
173
- attr_accessor :id
174
-
175
- # The date and time the payout was created.
176
- sig { returns(Time) }
177
- attr_accessor :created_at
213
+ ACCOUNT_CLOSED =
214
+ T.let(
215
+ :account_closed,
216
+ WhopSDK::Models::WithdrawalRetrieveResponse::ErrorCode::TaggedSymbol
217
+ )
218
+ ACCOUNT_DOES_NOT_EXIST =
219
+ T.let(
220
+ :account_does_not_exist,
221
+ WhopSDK::Models::WithdrawalRetrieveResponse::ErrorCode::TaggedSymbol
222
+ )
223
+ ACCOUNT_INFORMATION_INVALID =
224
+ T.let(
225
+ :account_information_invalid,
226
+ WhopSDK::Models::WithdrawalRetrieveResponse::ErrorCode::TaggedSymbol
227
+ )
228
+ ACCOUNT_NUMBER_INVALID_REGION =
229
+ T.let(
230
+ :account_number_invalid_region,
231
+ WhopSDK::Models::WithdrawalRetrieveResponse::ErrorCode::TaggedSymbol
232
+ )
233
+ ACCOUNT_FROZEN =
234
+ T.let(
235
+ :account_frozen,
236
+ WhopSDK::Models::WithdrawalRetrieveResponse::ErrorCode::TaggedSymbol
237
+ )
238
+ ACCOUNT_LOOKUP_FAILED =
239
+ T.let(
240
+ :account_lookup_failed,
241
+ WhopSDK::Models::WithdrawalRetrieveResponse::ErrorCode::TaggedSymbol
242
+ )
243
+ ACCOUNT_NOT_FOUND =
244
+ T.let(
245
+ :account_not_found,
246
+ WhopSDK::Models::WithdrawalRetrieveResponse::ErrorCode::TaggedSymbol
247
+ )
248
+ AMOUNT_OUT_OF_BOUNDS =
249
+ T.let(
250
+ :amount_out_of_bounds,
251
+ WhopSDK::Models::WithdrawalRetrieveResponse::ErrorCode::TaggedSymbol
252
+ )
253
+ ATTRIBUTES_NOT_VALIDATED =
254
+ T.let(
255
+ :attributes_not_validated,
256
+ WhopSDK::Models::WithdrawalRetrieveResponse::ErrorCode::TaggedSymbol
257
+ )
258
+ B2B_PAYMENTS_PROHIBITED =
259
+ T.let(
260
+ :b2b_payments_prohibited,
261
+ WhopSDK::Models::WithdrawalRetrieveResponse::ErrorCode::TaggedSymbol
262
+ )
263
+ BANK_STATEMENT_REQUIRED =
264
+ T.let(
265
+ :bank_statement_required,
266
+ WhopSDK::Models::WithdrawalRetrieveResponse::ErrorCode::TaggedSymbol
267
+ )
268
+ COMPLIANCE_REVIEW =
269
+ T.let(
270
+ :compliance_review,
271
+ WhopSDK::Models::WithdrawalRetrieveResponse::ErrorCode::TaggedSymbol
272
+ )
273
+ CURRENCY_NOT_SUPPORTED =
274
+ T.let(
275
+ :currency_not_supported,
276
+ WhopSDK::Models::WithdrawalRetrieveResponse::ErrorCode::TaggedSymbol
277
+ )
278
+ DEPOSIT_CANCELED =
279
+ T.let(
280
+ :deposit_canceled,
281
+ WhopSDK::Models::WithdrawalRetrieveResponse::ErrorCode::TaggedSymbol
282
+ )
283
+ DEPOSIT_FAILED =
284
+ T.let(
285
+ :deposit_failed,
286
+ WhopSDK::Models::WithdrawalRetrieveResponse::ErrorCode::TaggedSymbol
287
+ )
288
+ DEPOSIT_REJECTED =
289
+ T.let(
290
+ :deposit_rejected,
291
+ WhopSDK::Models::WithdrawalRetrieveResponse::ErrorCode::TaggedSymbol
292
+ )
293
+ DESTINATION_UNAVAILABLE =
294
+ T.let(
295
+ :destination_unavailable,
296
+ WhopSDK::Models::WithdrawalRetrieveResponse::ErrorCode::TaggedSymbol
297
+ )
298
+ EXCEEDED_ACCOUNT_LIMIT =
299
+ T.let(
300
+ :exceeded_account_limit,
301
+ WhopSDK::Models::WithdrawalRetrieveResponse::ErrorCode::TaggedSymbol
302
+ )
303
+ EXPIRED_QUOTE =
304
+ T.let(
305
+ :expired_quote,
306
+ WhopSDK::Models::WithdrawalRetrieveResponse::ErrorCode::TaggedSymbol
307
+ )
308
+ GENERIC_PAYOUT_ERROR =
309
+ T.let(
310
+ :generic_payout_error,
311
+ WhopSDK::Models::WithdrawalRetrieveResponse::ErrorCode::TaggedSymbol
312
+ )
313
+ TECHNICAL_PROBLEM =
314
+ T.let(
315
+ :technical_problem,
316
+ WhopSDK::Models::WithdrawalRetrieveResponse::ErrorCode::TaggedSymbol
317
+ )
318
+ IDENTIFICATION_NUMBER_INVALID =
319
+ T.let(
320
+ :identification_number_invalid,
321
+ WhopSDK::Models::WithdrawalRetrieveResponse::ErrorCode::TaggedSymbol
322
+ )
323
+ INVALID_ACCOUNT_NUMBER =
324
+ T.let(
325
+ :invalid_account_number,
326
+ WhopSDK::Models::WithdrawalRetrieveResponse::ErrorCode::TaggedSymbol
327
+ )
328
+ INVALID_BANK_CODE =
329
+ T.let(
330
+ :invalid_bank_code,
331
+ WhopSDK::Models::WithdrawalRetrieveResponse::ErrorCode::TaggedSymbol
332
+ )
333
+ INVALID_BENEFICIARY =
334
+ T.let(
335
+ :invalid_beneficiary,
336
+ WhopSDK::Models::WithdrawalRetrieveResponse::ErrorCode::TaggedSymbol
337
+ )
338
+ INVALID_BRANCH_NUMBER =
339
+ T.let(
340
+ :invalid_branch_number,
341
+ WhopSDK::Models::WithdrawalRetrieveResponse::ErrorCode::TaggedSymbol
342
+ )
343
+ INVALID_BRANCH_CODE =
344
+ T.let(
345
+ :invalid_branch_code,
346
+ WhopSDK::Models::WithdrawalRetrieveResponse::ErrorCode::TaggedSymbol
347
+ )
348
+ INVALID_PHONE_NUMBER =
349
+ T.let(
350
+ :invalid_phone_number,
351
+ WhopSDK::Models::WithdrawalRetrieveResponse::ErrorCode::TaggedSymbol
352
+ )
353
+ INVALID_ROUTING_NUMBER =
354
+ T.let(
355
+ :invalid_routing_number,
356
+ WhopSDK::Models::WithdrawalRetrieveResponse::ErrorCode::TaggedSymbol
357
+ )
358
+ INVALID_SWIFT_CODE =
359
+ T.let(
360
+ :invalid_swift_code,
361
+ WhopSDK::Models::WithdrawalRetrieveResponse::ErrorCode::TaggedSymbol
362
+ )
363
+ INVALID_COMPANY_DETAILS =
364
+ T.let(
365
+ :invalid_company_details,
366
+ WhopSDK::Models::WithdrawalRetrieveResponse::ErrorCode::TaggedSymbol
367
+ )
368
+ MANUAL_CANCELATION =
369
+ T.let(
370
+ :manual_cancelation,
371
+ WhopSDK::Models::WithdrawalRetrieveResponse::ErrorCode::TaggedSymbol
372
+ )
373
+ MISC_ERROR =
374
+ T.let(
375
+ :misc_error,
376
+ WhopSDK::Models::WithdrawalRetrieveResponse::ErrorCode::TaggedSymbol
377
+ )
378
+ MISSING_CITY_AND_COUNTRY =
379
+ T.let(
380
+ :missing_city_and_country,
381
+ WhopSDK::Models::WithdrawalRetrieveResponse::ErrorCode::TaggedSymbol
382
+ )
383
+ MISSING_PHONE_NUMBER =
384
+ T.let(
385
+ :missing_phone_number,
386
+ WhopSDK::Models::WithdrawalRetrieveResponse::ErrorCode::TaggedSymbol
387
+ )
388
+ MISSING_REMITTANCE_INFO =
389
+ T.let(
390
+ :missing_remittance_info,
391
+ WhopSDK::Models::WithdrawalRetrieveResponse::ErrorCode::TaggedSymbol
392
+ )
393
+ PAYEE_NAME_INVALID =
394
+ T.let(
395
+ :payee_name_invalid,
396
+ WhopSDK::Models::WithdrawalRetrieveResponse::ErrorCode::TaggedSymbol
397
+ )
398
+ RECEIVING_ACCOUNT_LOCKED =
399
+ T.let(
400
+ :receiving_account_locked,
401
+ WhopSDK::Models::WithdrawalRetrieveResponse::ErrorCode::TaggedSymbol
402
+ )
403
+ REJECTED_BY_COMPLIANCE =
404
+ T.let(
405
+ :rejected_by_compliance,
406
+ WhopSDK::Models::WithdrawalRetrieveResponse::ErrorCode::TaggedSymbol
407
+ )
408
+ RTP_NOT_SUPPORTED =
409
+ T.let(
410
+ :rtp_not_supported,
411
+ WhopSDK::Models::WithdrawalRetrieveResponse::ErrorCode::TaggedSymbol
412
+ )
413
+ NON_TRANSACTION_ACCOUNT =
414
+ T.let(
415
+ :non_transaction_account,
416
+ WhopSDK::Models::WithdrawalRetrieveResponse::ErrorCode::TaggedSymbol
417
+ )
418
+ SOURCE_TOKEN_INSUFFICIENT_FUNDS =
419
+ T.let(
420
+ :source_token_insufficient_funds,
421
+ WhopSDK::Models::WithdrawalRetrieveResponse::ErrorCode::TaggedSymbol
422
+ )
423
+ SSN_INVALID =
424
+ T.let(
425
+ :ssn_invalid,
426
+ WhopSDK::Models::WithdrawalRetrieveResponse::ErrorCode::TaggedSymbol
427
+ )
428
+ WALLET_SCREENSHOT_REQUIRED =
429
+ T.let(
430
+ :wallet_screenshot_required,
431
+ WhopSDK::Models::WithdrawalRetrieveResponse::ErrorCode::TaggedSymbol
432
+ )
433
+ UNSUPPORTED_REGION =
434
+ T.let(
435
+ :unsupported_region,
436
+ WhopSDK::Models::WithdrawalRetrieveResponse::ErrorCode::TaggedSymbol
437
+ )
178
438
 
179
- # The different error codes a payout can be in.
180
439
  sig do
181
- returns(
182
- T.nilable(
183
- WhopSDK::Models::WithdrawalRetrieveResponse::LatestPayout::ErrorCode::TaggedSymbol
184
- )
440
+ override.returns(
441
+ T::Array[
442
+ WhopSDK::Models::WithdrawalRetrieveResponse::ErrorCode::TaggedSymbol
443
+ ]
185
444
  )
186
445
  end
187
- attr_accessor :error_code
446
+ def self.values
447
+ end
448
+ end
188
449
 
189
- # The error message for the payout.
190
- sig { returns(T.nilable(String)) }
191
- attr_accessor :error_message
450
+ class LedgerAccount < WhopSDK::Internal::Type::BaseModel
451
+ OrHash =
452
+ T.type_alias do
453
+ T.any(
454
+ WhopSDK::Models::WithdrawalRetrieveResponse::LedgerAccount,
455
+ WhopSDK::Internal::AnyHash
456
+ )
457
+ end
192
458
 
193
- # The estimated availability date of the payout.
194
- sig { returns(T.nilable(Time)) }
195
- attr_accessor :estimated_availability
459
+ # The ID of the LedgerAccount.
460
+ sig { returns(String) }
461
+ attr_accessor :id
196
462
 
197
- # The name of the payer for the payout.
463
+ # The ID of the company associated with this ledger account.
198
464
  sig { returns(T.nilable(String)) }
199
- attr_accessor :payer_name
465
+ attr_accessor :company_id
200
466
 
201
- # The status of the payout.
467
+ # The ledger account associated with the withdrawal.
202
468
  sig do
203
- returns(
204
- WhopSDK::Models::WithdrawalRetrieveResponse::LatestPayout::Status::TaggedSymbol
469
+ params(id: String, company_id: T.nilable(String)).returns(
470
+ T.attached_class
205
471
  )
206
472
  end
207
- attr_accessor :status
208
-
209
- # The trace code for the payout, if applicable. Provided on ACH transactions when
210
- # available.
211
- sig { returns(T.nilable(String)) }
212
- attr_accessor :trace_code
213
-
214
- # The latest payout associated with this withdrawal, if any.
215
- sig do
216
- params(
217
- id: String,
218
- created_at: Time,
219
- error_code:
220
- T.nilable(
221
- WhopSDK::Models::WithdrawalRetrieveResponse::LatestPayout::ErrorCode::OrSymbol
222
- ),
223
- error_message: T.nilable(String),
224
- estimated_availability: T.nilable(Time),
225
- payer_name: T.nilable(String),
226
- status:
227
- WhopSDK::Models::WithdrawalRetrieveResponse::LatestPayout::Status::OrSymbol,
228
- trace_code: T.nilable(String)
229
- ).returns(T.attached_class)
230
- end
231
473
  def self.new(
232
- # The internal ID of the payout.
474
+ # The ID of the LedgerAccount.
233
475
  id:,
234
- # The date and time the payout was created.
235
- created_at:,
236
- # The different error codes a payout can be in.
237
- error_code:,
238
- # The error message for the payout.
239
- error_message:,
240
- # The estimated availability date of the payout.
241
- estimated_availability:,
242
- # The name of the payer for the payout.
243
- payer_name:,
244
- # The status of the payout.
245
- status:,
246
- # The trace code for the payout, if applicable. Provided on ACH transactions when
247
- # available.
248
- trace_code:
476
+ # The ID of the company associated with this ledger account.
477
+ company_id:
249
478
  )
250
479
  end
251
480
 
252
- sig do
253
- override.returns(
254
- {
255
- id: String,
256
- created_at: Time,
257
- error_code:
258
- T.nilable(
259
- WhopSDK::Models::WithdrawalRetrieveResponse::LatestPayout::ErrorCode::TaggedSymbol
260
- ),
261
- error_message: T.nilable(String),
262
- estimated_availability: T.nilable(Time),
263
- payer_name: T.nilable(String),
264
- status:
265
- WhopSDK::Models::WithdrawalRetrieveResponse::LatestPayout::Status::TaggedSymbol,
266
- trace_code: T.nilable(String)
267
- }
268
- )
269
- end
481
+ sig { override.returns({ id: String, company_id: T.nilable(String) }) }
270
482
  def to_hash
271
483
  end
272
-
273
- # The different error codes a payout can be in.
274
- module ErrorCode
275
- extend WhopSDK::Internal::Type::Enum
276
-
277
- TaggedSymbol =
278
- T.type_alias do
279
- T.all(
280
- Symbol,
281
- WhopSDK::Models::WithdrawalRetrieveResponse::LatestPayout::ErrorCode
282
- )
283
- end
284
- OrSymbol = T.type_alias { T.any(Symbol, String) }
285
-
286
- ACCOUNT_CLOSED =
287
- T.let(
288
- :account_closed,
289
- WhopSDK::Models::WithdrawalRetrieveResponse::LatestPayout::ErrorCode::TaggedSymbol
290
- )
291
- ACCOUNT_DOES_NOT_EXIST =
292
- T.let(
293
- :account_does_not_exist,
294
- WhopSDK::Models::WithdrawalRetrieveResponse::LatestPayout::ErrorCode::TaggedSymbol
295
- )
296
- ACCOUNT_INFORMATION_INVALID =
297
- T.let(
298
- :account_information_invalid,
299
- WhopSDK::Models::WithdrawalRetrieveResponse::LatestPayout::ErrorCode::TaggedSymbol
300
- )
301
- ACCOUNT_NUMBER_INVALID_REGION =
302
- T.let(
303
- :account_number_invalid_region,
304
- WhopSDK::Models::WithdrawalRetrieveResponse::LatestPayout::ErrorCode::TaggedSymbol
305
- )
306
- ACCOUNT_FROZEN =
307
- T.let(
308
- :account_frozen,
309
- WhopSDK::Models::WithdrawalRetrieveResponse::LatestPayout::ErrorCode::TaggedSymbol
310
- )
311
- ACCOUNT_LOOKUP_FAILED =
312
- T.let(
313
- :account_lookup_failed,
314
- WhopSDK::Models::WithdrawalRetrieveResponse::LatestPayout::ErrorCode::TaggedSymbol
315
- )
316
- ACCOUNT_NOT_FOUND =
317
- T.let(
318
- :account_not_found,
319
- WhopSDK::Models::WithdrawalRetrieveResponse::LatestPayout::ErrorCode::TaggedSymbol
320
- )
321
- AMOUNT_OUT_OF_BOUNDS =
322
- T.let(
323
- :amount_out_of_bounds,
324
- WhopSDK::Models::WithdrawalRetrieveResponse::LatestPayout::ErrorCode::TaggedSymbol
325
- )
326
- ATTRIBUTES_NOT_VALIDATED =
327
- T.let(
328
- :attributes_not_validated,
329
- WhopSDK::Models::WithdrawalRetrieveResponse::LatestPayout::ErrorCode::TaggedSymbol
330
- )
331
- B2B_PAYMENTS_PROHIBITED =
332
- T.let(
333
- :b2b_payments_prohibited,
334
- WhopSDK::Models::WithdrawalRetrieveResponse::LatestPayout::ErrorCode::TaggedSymbol
335
- )
336
- BANK_STATEMENT_REQUIRED =
337
- T.let(
338
- :bank_statement_required,
339
- WhopSDK::Models::WithdrawalRetrieveResponse::LatestPayout::ErrorCode::TaggedSymbol
340
- )
341
- COMPLIANCE_REVIEW =
342
- T.let(
343
- :compliance_review,
344
- WhopSDK::Models::WithdrawalRetrieveResponse::LatestPayout::ErrorCode::TaggedSymbol
345
- )
346
- CURRENCY_NOT_SUPPORTED =
347
- T.let(
348
- :currency_not_supported,
349
- WhopSDK::Models::WithdrawalRetrieveResponse::LatestPayout::ErrorCode::TaggedSymbol
350
- )
351
- DEPOSIT_CANCELED =
352
- T.let(
353
- :deposit_canceled,
354
- WhopSDK::Models::WithdrawalRetrieveResponse::LatestPayout::ErrorCode::TaggedSymbol
355
- )
356
- DEPOSIT_FAILED =
357
- T.let(
358
- :deposit_failed,
359
- WhopSDK::Models::WithdrawalRetrieveResponse::LatestPayout::ErrorCode::TaggedSymbol
360
- )
361
- DEPOSIT_REJECTED =
362
- T.let(
363
- :deposit_rejected,
364
- WhopSDK::Models::WithdrawalRetrieveResponse::LatestPayout::ErrorCode::TaggedSymbol
365
- )
366
- DESTINATION_UNAVAILABLE =
367
- T.let(
368
- :destination_unavailable,
369
- WhopSDK::Models::WithdrawalRetrieveResponse::LatestPayout::ErrorCode::TaggedSymbol
370
- )
371
- EXCEEDED_ACCOUNT_LIMIT =
372
- T.let(
373
- :exceeded_account_limit,
374
- WhopSDK::Models::WithdrawalRetrieveResponse::LatestPayout::ErrorCode::TaggedSymbol
375
- )
376
- EXPIRED_QUOTE =
377
- T.let(
378
- :expired_quote,
379
- WhopSDK::Models::WithdrawalRetrieveResponse::LatestPayout::ErrorCode::TaggedSymbol
380
- )
381
- GENERIC_PAYOUT_ERROR =
382
- T.let(
383
- :generic_payout_error,
384
- WhopSDK::Models::WithdrawalRetrieveResponse::LatestPayout::ErrorCode::TaggedSymbol
385
- )
386
- TECHNICAL_PROBLEM =
387
- T.let(
388
- :technical_problem,
389
- WhopSDK::Models::WithdrawalRetrieveResponse::LatestPayout::ErrorCode::TaggedSymbol
390
- )
391
- IDENTIFICATION_NUMBER_INVALID =
392
- T.let(
393
- :identification_number_invalid,
394
- WhopSDK::Models::WithdrawalRetrieveResponse::LatestPayout::ErrorCode::TaggedSymbol
395
- )
396
- INVALID_ACCOUNT_NUMBER =
397
- T.let(
398
- :invalid_account_number,
399
- WhopSDK::Models::WithdrawalRetrieveResponse::LatestPayout::ErrorCode::TaggedSymbol
400
- )
401
- INVALID_BANK_CODE =
402
- T.let(
403
- :invalid_bank_code,
404
- WhopSDK::Models::WithdrawalRetrieveResponse::LatestPayout::ErrorCode::TaggedSymbol
405
- )
406
- INVALID_BENEFICIARY =
407
- T.let(
408
- :invalid_beneficiary,
409
- WhopSDK::Models::WithdrawalRetrieveResponse::LatestPayout::ErrorCode::TaggedSymbol
410
- )
411
- INVALID_BRANCH_NUMBER =
412
- T.let(
413
- :invalid_branch_number,
414
- WhopSDK::Models::WithdrawalRetrieveResponse::LatestPayout::ErrorCode::TaggedSymbol
415
- )
416
- INVALID_BRANCH_CODE =
417
- T.let(
418
- :invalid_branch_code,
419
- WhopSDK::Models::WithdrawalRetrieveResponse::LatestPayout::ErrorCode::TaggedSymbol
420
- )
421
- INVALID_PHONE_NUMBER =
422
- T.let(
423
- :invalid_phone_number,
424
- WhopSDK::Models::WithdrawalRetrieveResponse::LatestPayout::ErrorCode::TaggedSymbol
425
- )
426
- INVALID_ROUTING_NUMBER =
427
- T.let(
428
- :invalid_routing_number,
429
- WhopSDK::Models::WithdrawalRetrieveResponse::LatestPayout::ErrorCode::TaggedSymbol
430
- )
431
- INVALID_SWIFT_CODE =
432
- T.let(
433
- :invalid_swift_code,
434
- WhopSDK::Models::WithdrawalRetrieveResponse::LatestPayout::ErrorCode::TaggedSymbol
435
- )
436
- INVALID_COMPANY_DETAILS =
437
- T.let(
438
- :invalid_company_details,
439
- WhopSDK::Models::WithdrawalRetrieveResponse::LatestPayout::ErrorCode::TaggedSymbol
440
- )
441
- MANUAL_CANCELATION =
442
- T.let(
443
- :manual_cancelation,
444
- WhopSDK::Models::WithdrawalRetrieveResponse::LatestPayout::ErrorCode::TaggedSymbol
445
- )
446
- MISC_ERROR =
447
- T.let(
448
- :misc_error,
449
- WhopSDK::Models::WithdrawalRetrieveResponse::LatestPayout::ErrorCode::TaggedSymbol
450
- )
451
- MISSING_CITY_AND_COUNTRY =
452
- T.let(
453
- :missing_city_and_country,
454
- WhopSDK::Models::WithdrawalRetrieveResponse::LatestPayout::ErrorCode::TaggedSymbol
455
- )
456
- MISSING_PHONE_NUMBER =
457
- T.let(
458
- :missing_phone_number,
459
- WhopSDK::Models::WithdrawalRetrieveResponse::LatestPayout::ErrorCode::TaggedSymbol
460
- )
461
- MISSING_REMITTANCE_INFO =
462
- T.let(
463
- :missing_remittance_info,
464
- WhopSDK::Models::WithdrawalRetrieveResponse::LatestPayout::ErrorCode::TaggedSymbol
465
- )
466
- PAYEE_NAME_INVALID =
467
- T.let(
468
- :payee_name_invalid,
469
- WhopSDK::Models::WithdrawalRetrieveResponse::LatestPayout::ErrorCode::TaggedSymbol
470
- )
471
- RECEIVING_ACCOUNT_LOCKED =
472
- T.let(
473
- :receiving_account_locked,
474
- WhopSDK::Models::WithdrawalRetrieveResponse::LatestPayout::ErrorCode::TaggedSymbol
475
- )
476
- REJECTED_BY_COMPLIANCE =
477
- T.let(
478
- :rejected_by_compliance,
479
- WhopSDK::Models::WithdrawalRetrieveResponse::LatestPayout::ErrorCode::TaggedSymbol
480
- )
481
- RTP_NOT_SUPPORTED =
482
- T.let(
483
- :rtp_not_supported,
484
- WhopSDK::Models::WithdrawalRetrieveResponse::LatestPayout::ErrorCode::TaggedSymbol
485
- )
486
- NON_TRANSACTION_ACCOUNT =
487
- T.let(
488
- :non_transaction_account,
489
- WhopSDK::Models::WithdrawalRetrieveResponse::LatestPayout::ErrorCode::TaggedSymbol
490
- )
491
- SOURCE_TOKEN_INSUFFICIENT_FUNDS =
492
- T.let(
493
- :source_token_insufficient_funds,
494
- WhopSDK::Models::WithdrawalRetrieveResponse::LatestPayout::ErrorCode::TaggedSymbol
495
- )
496
- SSN_INVALID =
497
- T.let(
498
- :ssn_invalid,
499
- WhopSDK::Models::WithdrawalRetrieveResponse::LatestPayout::ErrorCode::TaggedSymbol
500
- )
501
- WALLET_SCREENSHOT_REQUIRED =
502
- T.let(
503
- :wallet_screenshot_required,
504
- WhopSDK::Models::WithdrawalRetrieveResponse::LatestPayout::ErrorCode::TaggedSymbol
505
- )
506
- UNSUPPORTED_REGION =
507
- T.let(
508
- :unsupported_region,
509
- WhopSDK::Models::WithdrawalRetrieveResponse::LatestPayout::ErrorCode::TaggedSymbol
510
- )
511
-
512
- sig do
513
- override.returns(
514
- T::Array[
515
- WhopSDK::Models::WithdrawalRetrieveResponse::LatestPayout::ErrorCode::TaggedSymbol
516
- ]
517
- )
518
- end
519
- def self.values
520
- end
521
- end
522
-
523
- # The status of the payout.
524
- module Status
525
- extend WhopSDK::Internal::Type::Enum
526
-
527
- TaggedSymbol =
528
- T.type_alias do
529
- T.all(
530
- Symbol,
531
- WhopSDK::Models::WithdrawalRetrieveResponse::LatestPayout::Status
532
- )
533
- end
534
- OrSymbol = T.type_alias { T.any(Symbol, String) }
535
-
536
- SCHEDULED =
537
- T.let(
538
- :scheduled,
539
- WhopSDK::Models::WithdrawalRetrieveResponse::LatestPayout::Status::TaggedSymbol
540
- )
541
- PENDING =
542
- T.let(
543
- :pending,
544
- WhopSDK::Models::WithdrawalRetrieveResponse::LatestPayout::Status::TaggedSymbol
545
- )
546
- PROCESSING =
547
- T.let(
548
- :processing,
549
- WhopSDK::Models::WithdrawalRetrieveResponse::LatestPayout::Status::TaggedSymbol
550
- )
551
- COMPLETED =
552
- T.let(
553
- :completed,
554
- WhopSDK::Models::WithdrawalRetrieveResponse::LatestPayout::Status::TaggedSymbol
555
- )
556
- CANCELED =
557
- T.let(
558
- :canceled,
559
- WhopSDK::Models::WithdrawalRetrieveResponse::LatestPayout::Status::TaggedSymbol
560
- )
561
- READY_FOR_PICKUP =
562
- T.let(
563
- :ready_for_pickup,
564
- WhopSDK::Models::WithdrawalRetrieveResponse::LatestPayout::Status::TaggedSymbol
565
- )
566
- HOLD =
567
- T.let(
568
- :hold,
569
- WhopSDK::Models::WithdrawalRetrieveResponse::LatestPayout::Status::TaggedSymbol
570
- )
571
- ERROR =
572
- T.let(
573
- :error,
574
- WhopSDK::Models::WithdrawalRetrieveResponse::LatestPayout::Status::TaggedSymbol
575
- )
576
- EXPIRED =
577
- T.let(
578
- :expired,
579
- WhopSDK::Models::WithdrawalRetrieveResponse::LatestPayout::Status::TaggedSymbol
580
- )
581
-
582
- sig do
583
- override.returns(
584
- T::Array[
585
- WhopSDK::Models::WithdrawalRetrieveResponse::LatestPayout::Status::TaggedSymbol
586
- ]
587
- )
588
- end
589
- def self.values
590
- end
591
- end
592
484
  end
593
485
 
594
486
  class PayoutToken < WhopSDK::Internal::Type::BaseModel
@@ -618,13 +510,9 @@ module WhopSDK
618
510
  sig { returns(T.nilable(String)) }
619
511
  attr_accessor :nickname
620
512
 
621
- # The status of the payout token.
622
- sig do
623
- returns(
624
- WhopSDK::Models::WithdrawalRetrieveResponse::PayoutToken::Status::TaggedSymbol
625
- )
626
- end
627
- attr_accessor :status
513
+ # The name of the payer associated with the payout token.
514
+ sig { returns(T.nilable(String)) }
515
+ attr_accessor :payer_name
628
516
 
629
517
  # The payout token used for the withdrawal, if applicable.
630
518
  sig do
@@ -633,8 +521,7 @@ module WhopSDK
633
521
  created_at: Time,
634
522
  destination_currency_code: String,
635
523
  nickname: T.nilable(String),
636
- status:
637
- WhopSDK::Models::WithdrawalRetrieveResponse::PayoutToken::Status::OrSymbol
524
+ payer_name: T.nilable(String)
638
525
  ).returns(T.attached_class)
639
526
  end
640
527
  def self.new(
@@ -648,8 +535,8 @@ module WhopSDK
648
535
  # An optional nickname for the payout token to help the user identify it. This is
649
536
  # not used by the provider and is only for the user's reference.
650
537
  nickname:,
651
- # The status of the payout token.
652
- status:
538
+ # The name of the payer associated with the payout token.
539
+ payer_name:
653
540
  )
654
541
  end
655
542
 
@@ -660,53 +547,12 @@ module WhopSDK
660
547
  created_at: Time,
661
548
  destination_currency_code: String,
662
549
  nickname: T.nilable(String),
663
- status:
664
- WhopSDK::Models::WithdrawalRetrieveResponse::PayoutToken::Status::TaggedSymbol
550
+ payer_name: T.nilable(String)
665
551
  }
666
552
  )
667
553
  end
668
554
  def to_hash
669
555
  end
670
-
671
- # The status of the payout token.
672
- module Status
673
- extend WhopSDK::Internal::Type::Enum
674
-
675
- TaggedSymbol =
676
- T.type_alias do
677
- T.all(
678
- Symbol,
679
- WhopSDK::Models::WithdrawalRetrieveResponse::PayoutToken::Status
680
- )
681
- end
682
- OrSymbol = T.type_alias { T.any(Symbol, String) }
683
-
684
- CREATED =
685
- T.let(
686
- :created,
687
- WhopSDK::Models::WithdrawalRetrieveResponse::PayoutToken::Status::TaggedSymbol
688
- )
689
- ACTIVE =
690
- T.let(
691
- :active,
692
- WhopSDK::Models::WithdrawalRetrieveResponse::PayoutToken::Status::TaggedSymbol
693
- )
694
- BROKEN =
695
- T.let(
696
- :broken,
697
- WhopSDK::Models::WithdrawalRetrieveResponse::PayoutToken::Status::TaggedSymbol
698
- )
699
-
700
- sig do
701
- override.returns(
702
- T::Array[
703
- WhopSDK::Models::WithdrawalRetrieveResponse::PayoutToken::Status::TaggedSymbol
704
- ]
705
- )
706
- end
707
- def self.values
708
- end
709
- end
710
556
  end
711
557
  end
712
558
  end