whop_sdk 0.0.23 → 0.0.24

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 (176) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +35 -0
  3. data/README.md +1 -1
  4. data/lib/whop_sdk/models/app_build_create_params.rb +16 -55
  5. data/lib/whop_sdk/models/app_create_params.rb +22 -1
  6. data/lib/whop_sdk/models/app_list_params.rb +5 -0
  7. data/lib/whop_sdk/models/app_update_params.rb +14 -53
  8. data/lib/whop_sdk/models/card_brands.rb +16 -0
  9. data/lib/whop_sdk/models/checkout_configuration_create_params.rb +32 -56
  10. data/lib/whop_sdk/models/company_create_params.rb +22 -1
  11. data/lib/whop_sdk/models/company_update_params.rb +28 -106
  12. data/lib/whop_sdk/models/course_create_params.rb +15 -62
  13. data/lib/whop_sdk/models/course_lesson_create_params.rb +14 -53
  14. data/lib/whop_sdk/models/course_lesson_update_params.rb +53 -214
  15. data/lib/whop_sdk/models/course_update_params.rb +14 -61
  16. data/lib/whop_sdk/models/dispute_update_evidence_params.rb +56 -212
  17. data/lib/whop_sdk/models/experience_create_params.rb +22 -1
  18. data/lib/whop_sdk/models/experience_update_params.rb +14 -53
  19. data/lib/whop_sdk/models/forum_post_create_params.rb +13 -52
  20. data/lib/whop_sdk/models/forum_post_update_params.rb +13 -52
  21. data/lib/whop_sdk/models/friendly_receipt_status.rb +23 -11
  22. data/lib/whop_sdk/models/ledger_account_retrieve_response.rb +1 -34
  23. data/lib/whop_sdk/models/member_list_response.rb +9 -1
  24. data/lib/whop_sdk/models/member_retrieve_response.rb +9 -1
  25. data/lib/whop_sdk/models/membership.rb +76 -2
  26. data/lib/whop_sdk/models/membership_list_response.rb +38 -2
  27. data/lib/whop_sdk/models/membership_uncancel_params.rb +14 -0
  28. data/lib/whop_sdk/models/message_create_params.rb +13 -52
  29. data/lib/whop_sdk/models/message_update_params.rb +14 -53
  30. data/lib/whop_sdk/models/payment.rb +17 -1
  31. data/lib/whop_sdk/models/payment_list_response.rb +17 -1
  32. data/lib/whop_sdk/models/payment_method_types.rb +58 -57
  33. data/lib/whop_sdk/models/payment_provider.rb +1 -0
  34. data/lib/whop_sdk/models/payout_method_created_webhook_event.rb +26 -1
  35. data/lib/whop_sdk/models/payout_method_list_response.rb +26 -1
  36. data/lib/whop_sdk/models/payout_method_retrieve_response.rb +26 -1
  37. data/lib/whop_sdk/models/plan_create_params.rb +14 -53
  38. data/lib/whop_sdk/models/plan_update_params.rb +14 -53
  39. data/lib/whop_sdk/models/withdrawal_create_params.rb +21 -1
  40. data/lib/whop_sdk/models/withdrawal_create_response.rb +2 -9
  41. data/lib/whop_sdk/models/withdrawal_created_webhook_event.rb +2 -9
  42. data/lib/whop_sdk/models/withdrawal_list_response.rb +1 -9
  43. data/lib/whop_sdk/models/withdrawal_retrieve_response.rb +2 -9
  44. data/lib/whop_sdk/models/withdrawal_updated_webhook_event.rb +2 -9
  45. data/lib/whop_sdk/models.rb +2 -2
  46. data/lib/whop_sdk/resources/app_builds.rb +1 -1
  47. data/lib/whop_sdk/resources/apps.rb +4 -2
  48. data/lib/whop_sdk/resources/checkout_configurations.rb +3 -1
  49. data/lib/whop_sdk/resources/companies.rb +5 -3
  50. data/lib/whop_sdk/resources/course_lessons.rb +4 -4
  51. data/lib/whop_sdk/resources/courses.rb +4 -8
  52. data/lib/whop_sdk/resources/disputes.rb +4 -4
  53. data/lib/whop_sdk/resources/experiences.rb +4 -2
  54. data/lib/whop_sdk/resources/forum_posts.rb +2 -2
  55. data/lib/whop_sdk/resources/memberships.rb +32 -0
  56. data/lib/whop_sdk/resources/messages.rb +2 -2
  57. data/lib/whop_sdk/resources/notifications.rb +4 -0
  58. data/lib/whop_sdk/resources/plans.rb +2 -2
  59. data/lib/whop_sdk/resources/withdrawals.rb +8 -1
  60. data/lib/whop_sdk/version.rb +1 -1
  61. data/lib/whop_sdk.rb +1 -1
  62. data/rbi/whop_sdk/models/app_build_create_params.rbi +26 -89
  63. data/rbi/whop_sdk/models/app_create_params.rbi +36 -0
  64. data/rbi/whop_sdk/models/app_list_params.rbi +10 -0
  65. data/rbi/whop_sdk/models/app_update_params.rbi +21 -93
  66. data/rbi/whop_sdk/models/card_brands.rbi +17 -0
  67. data/rbi/whop_sdk/models/checkout_configuration_create_params.rbi +45 -87
  68. data/rbi/whop_sdk/models/company_create_params.rbi +39 -0
  69. data/rbi/whop_sdk/models/company_update_params.rbi +47 -185
  70. data/rbi/whop_sdk/models/course_create_params.rbi +24 -101
  71. data/rbi/whop_sdk/models/course_lesson_create_params.rbi +25 -92
  72. data/rbi/whop_sdk/models/course_lesson_update_params.rbi +97 -359
  73. data/rbi/whop_sdk/models/course_update_params.rbi +24 -101
  74. data/rbi/whop_sdk/models/dispute_update_evidence_params.rbi +116 -340
  75. data/rbi/whop_sdk/models/experience_create_params.rbi +41 -0
  76. data/rbi/whop_sdk/models/experience_update_params.rbi +24 -93
  77. data/rbi/whop_sdk/models/forum_post_create_params.rbi +18 -94
  78. data/rbi/whop_sdk/models/forum_post_update_params.rbi +18 -94
  79. data/rbi/whop_sdk/models/friendly_receipt_status.rbi +62 -17
  80. data/rbi/whop_sdk/models/ledger_account_retrieve_response.rbi +0 -105
  81. data/rbi/whop_sdk/models/member_list_response.rbi +8 -0
  82. data/rbi/whop_sdk/models/member_retrieve_response.rbi +8 -0
  83. data/rbi/whop_sdk/models/membership.rbi +126 -4
  84. data/rbi/whop_sdk/models/membership_list_response.rbi +98 -4
  85. data/rbi/whop_sdk/models/membership_uncancel_params.rbi +27 -0
  86. data/rbi/whop_sdk/models/message_create_params.rbi +18 -94
  87. data/rbi/whop_sdk/models/message_update_params.rbi +18 -94
  88. data/rbi/whop_sdk/models/payment.rbi +16 -0
  89. data/rbi/whop_sdk/models/payment_list_response.rbi +16 -0
  90. data/rbi/whop_sdk/models/payment_method_types.rbi +66 -64
  91. data/rbi/whop_sdk/models/payment_provider.rbi +1 -0
  92. data/rbi/whop_sdk/models/payout_method_created_webhook_event.rbi +26 -0
  93. data/rbi/whop_sdk/models/payout_method_list_response.rbi +26 -0
  94. data/rbi/whop_sdk/models/payout_method_retrieve_response.rbi +26 -0
  95. data/rbi/whop_sdk/models/plan_create_params.rbi +21 -93
  96. data/rbi/whop_sdk/models/plan_update_params.rbi +21 -93
  97. data/rbi/whop_sdk/models/withdrawal_create_params.rbi +18 -0
  98. data/rbi/whop_sdk/models/withdrawal_create_response.rbi +8 -11
  99. data/rbi/whop_sdk/models/withdrawal_created_webhook_event.rbi +8 -11
  100. data/rbi/whop_sdk/models/withdrawal_list_response.rbi +3 -11
  101. data/rbi/whop_sdk/models/withdrawal_retrieve_response.rbi +8 -11
  102. data/rbi/whop_sdk/models/withdrawal_updated_webhook_event.rbi +8 -11
  103. data/rbi/whop_sdk/models.rbi +2 -2
  104. data/rbi/whop_sdk/resources/app_builds.rbi +1 -5
  105. data/rbi/whop_sdk/resources/apps.rbi +4 -7
  106. data/rbi/whop_sdk/resources/checkout_configurations.rbi +3 -0
  107. data/rbi/whop_sdk/resources/companies.rbi +5 -13
  108. data/rbi/whop_sdk/resources/course_lessons.rbi +4 -24
  109. data/rbi/whop_sdk/resources/courses.rbi +2 -20
  110. data/rbi/whop_sdk/resources/disputes.rbi +4 -16
  111. data/rbi/whop_sdk/resources/experiences.rbi +4 -7
  112. data/rbi/whop_sdk/resources/forum_posts.rbi +2 -12
  113. data/rbi/whop_sdk/resources/memberships.rbi +26 -0
  114. data/rbi/whop_sdk/resources/messages.rbi +2 -12
  115. data/rbi/whop_sdk/resources/notifications.rbi +4 -0
  116. data/rbi/whop_sdk/resources/plans.rbi +2 -14
  117. data/rbi/whop_sdk/resources/withdrawals.rbi +7 -0
  118. data/sig/whop_sdk/models/app_build_create_params.rbs +9 -30
  119. data/sig/whop_sdk/models/app_create_params.rbs +20 -1
  120. data/sig/whop_sdk/models/app_list_params.rbs +10 -0
  121. data/sig/whop_sdk/models/app_update_params.rbs +9 -30
  122. data/sig/whop_sdk/models/card_brands.rbs +32 -0
  123. data/sig/whop_sdk/models/checkout_configuration_create_params.rbs +19 -30
  124. data/sig/whop_sdk/models/company_create_params.rbs +15 -0
  125. data/sig/whop_sdk/models/company_update_params.rbs +18 -60
  126. data/sig/whop_sdk/models/course_create_params.rbs +9 -35
  127. data/sig/whop_sdk/models/course_lesson_create_params.rbs +9 -30
  128. data/sig/whop_sdk/models/course_lesson_update_params.rbs +36 -120
  129. data/sig/whop_sdk/models/course_update_params.rbs +9 -35
  130. data/sig/whop_sdk/models/dispute_update_evidence_params.rbs +36 -120
  131. data/sig/whop_sdk/models/experience_create_params.rbs +15 -0
  132. data/sig/whop_sdk/models/experience_update_params.rbs +9 -30
  133. data/sig/whop_sdk/models/forum_post_create_params.rbs +9 -30
  134. data/sig/whop_sdk/models/forum_post_update_params.rbs +9 -30
  135. data/sig/whop_sdk/models/friendly_receipt_status.rbs +46 -22
  136. data/sig/whop_sdk/models/ledger_account_retrieve_response.rbs +0 -38
  137. data/sig/whop_sdk/models/member_list_response.rbs +5 -0
  138. data/sig/whop_sdk/models/member_retrieve_response.rbs +5 -0
  139. data/sig/whop_sdk/models/membership.rbs +65 -4
  140. data/sig/whop_sdk/models/membership_list_response.rbs +45 -4
  141. data/sig/whop_sdk/models/membership_uncancel_params.rbs +15 -0
  142. data/sig/whop_sdk/models/message_create_params.rbs +9 -30
  143. data/sig/whop_sdk/models/message_update_params.rbs +9 -30
  144. data/sig/whop_sdk/models/payment.rbs +10 -0
  145. data/sig/whop_sdk/models/payment_list_response.rbs +10 -0
  146. data/sig/whop_sdk/models/payment_method_types.rbs +117 -115
  147. data/sig/whop_sdk/models/payment_provider.rbs +2 -0
  148. data/sig/whop_sdk/models/payout_method_created_webhook_event.rbs +15 -0
  149. data/sig/whop_sdk/models/payout_method_list_response.rbs +15 -0
  150. data/sig/whop_sdk/models/payout_method_retrieve_response.rbs +15 -0
  151. data/sig/whop_sdk/models/plan_create_params.rbs +9 -30
  152. data/sig/whop_sdk/models/plan_update_params.rbs +9 -30
  153. data/sig/whop_sdk/models/withdrawal_create_params.rbs +11 -1
  154. data/sig/whop_sdk/models/withdrawal_create_response.rbs +5 -8
  155. data/sig/whop_sdk/models/withdrawal_created_webhook_event.rbs +5 -8
  156. data/sig/whop_sdk/models/withdrawal_list_response.rbs +3 -8
  157. data/sig/whop_sdk/models/withdrawal_retrieve_response.rbs +5 -8
  158. data/sig/whop_sdk/models/withdrawal_updated_webhook_event.rbs +5 -8
  159. data/sig/whop_sdk/models.rbs +2 -2
  160. data/sig/whop_sdk/resources/app_builds.rbs +1 -1
  161. data/sig/whop_sdk/resources/apps.rbs +2 -1
  162. data/sig/whop_sdk/resources/checkout_configurations.rbs +1 -0
  163. data/sig/whop_sdk/resources/companies.rbs +3 -2
  164. data/sig/whop_sdk/resources/course_lessons.rbs +4 -4
  165. data/sig/whop_sdk/resources/courses.rbs +2 -4
  166. data/sig/whop_sdk/resources/disputes.rbs +4 -4
  167. data/sig/whop_sdk/resources/experiences.rbs +2 -1
  168. data/sig/whop_sdk/resources/forum_posts.rbs +2 -2
  169. data/sig/whop_sdk/resources/memberships.rbs +5 -0
  170. data/sig/whop_sdk/resources/messages.rbs +2 -2
  171. data/sig/whop_sdk/resources/plans.rbs +2 -2
  172. data/sig/whop_sdk/resources/withdrawals.rbs +2 -0
  173. metadata +19 -5
  174. data/lib/whop_sdk/models/withdrawal_types.rb +0 -16
  175. data/rbi/whop_sdk/models/withdrawal_types.rbi +0 -20
  176. data/sig/whop_sdk/models/withdrawal_types.rbs +0 -14
@@ -101,6 +101,12 @@ module WhopSDK
101
101
  # @return [Hash{Symbol=>Object}, nil]
102
102
  required :metadata, WhopSDK::Internal::Type::HashOf[WhopSDK::Internal::Type::Unknown], nil?: true
103
103
 
104
+ # @!attribute next_payment_attempt
105
+ # The time of the next schedule payment retry.
106
+ #
107
+ # @return [Time, nil]
108
+ required :next_payment_attempt, Time, nil?: true
109
+
104
110
  # @!attribute paid_at
105
111
  # The datetime the payment was paid
106
112
  #
@@ -119,6 +125,12 @@ module WhopSDK
119
125
  # @return [Symbol, WhopSDK::Models::PaymentMethodTypes, nil]
120
126
  required :payment_method_type, enum: -> { WhopSDK::PaymentMethodTypes }, nil?: true
121
127
 
128
+ # @!attribute payments_failed
129
+ # The number of failed payment attempts for the payment.
130
+ #
131
+ # @return [Integer, nil]
132
+ required :payments_failed, Integer, nil?: true
133
+
122
134
  # @!attribute plan
123
135
  # The plan attached to this payment.
124
136
  #
@@ -207,7 +219,7 @@ module WhopSDK
207
219
  # @return [Boolean]
208
220
  required :voidable, WhopSDK::Internal::Type::Boolean
209
221
 
210
- # @!method initialize(id:, amount_after_fees:, auto_refunded:, billing_address:, billing_reason:, card_brand:, card_last4:, company:, created_at:, currency:, dispute_alerted_at:, failure_message:, last_payment_attempt:, member:, membership:, metadata:, paid_at:, payment_method:, payment_method_type:, plan:, product:, promo_code:, refundable:, refunded_amount:, refunded_at:, retryable:, status:, substatus:, subtotal:, total:, usd_total:, user:, voidable:)
222
+ # @!method initialize(id:, amount_after_fees:, auto_refunded:, billing_address:, billing_reason:, card_brand:, card_last4:, company:, created_at:, currency:, dispute_alerted_at:, failure_message:, last_payment_attempt:, member:, membership:, metadata:, next_payment_attempt:, paid_at:, payment_method:, payment_method_type:, payments_failed:, plan:, product:, promo_code:, refundable:, refunded_amount:, refunded_at:, retryable:, status:, substatus:, subtotal:, total:, usd_total:, user:, voidable:)
211
223
  # Some parameter documentations has been truncated, see
212
224
  # {WhopSDK::Models::PaymentListResponse} for more details.
213
225
  #
@@ -245,12 +257,16 @@ module WhopSDK
245
257
  #
246
258
  # @param metadata [Hash{Symbol=>Object}, nil] The custom metadata stored on this payment. This will be copied over to the chec
247
259
  #
260
+ # @param next_payment_attempt [Time, nil] The time of the next schedule payment retry.
261
+ #
248
262
  # @param paid_at [Time, nil] The datetime the payment was paid
249
263
  #
250
264
  # @param payment_method [WhopSDK::Models::PaymentListResponse::PaymentMethod, nil] The payment method used for the payment, if available.
251
265
  #
252
266
  # @param payment_method_type [Symbol, WhopSDK::Models::PaymentMethodTypes, nil] The different types of payment methods that can be used.
253
267
  #
268
+ # @param payments_failed [Integer, nil] The number of failed payment attempts for the payment.
269
+ #
254
270
  # @param plan [WhopSDK::Models::PaymentListResponse::Plan, nil] The plan attached to this payment.
255
271
  #
256
272
  # @param product [WhopSDK::Models::PaymentListResponse::Product, nil] The product this payment was made for
@@ -6,91 +6,92 @@ module WhopSDK
6
6
  module PaymentMethodTypes
7
7
  extend WhopSDK::Internal::Type::Enum
8
8
 
9
+ ACSS_DEBIT = :acss_debit
10
+ AFFIRM = :affirm
9
11
  AFTERPAY_CLEARPAY = :afterpay_clearpay
10
12
  ALIPAY = :alipay
13
+ ALMA = :alma
11
14
  AMAZON_PAY = :amazon_pay
15
+ APPLE = :apple
12
16
  APPLE_PAY = :apple_pay
17
+ AU_BECS_DEBIT = :au_becs_debit
18
+ BACS_DEBIT = :bacs_debit
13
19
  BANCONTACT = :bancontact
20
+ BILLIE = :billie
21
+ BIZUM = :bizum
22
+ BLIK = :blik
23
+ BOLETO = :boleto
24
+ CAPCHASE_PAY = :capchase_pay
14
25
  CARD = :card
15
26
  CASHAPP = :cashapp
27
+ COINBASE = :coinbase
16
28
  CRYPTO = :crypto
29
+ CUSTOM = :custom
30
+ CUSTOMER_BALANCE = :customer_balance
31
+ DEMO_PAY = :demo_pay
32
+ EPS = :eps
33
+ EU_BANK_TRANSFER = :eu_bank_transfer
34
+ FPX = :fpx
35
+ GIROPAY = :giropay
17
36
  GOOGLE_PAY = :google_pay
37
+ GOPAY = :gopay
38
+ GRABPAY = :grabpay
39
+ ID_BANK_TRANSFER = :id_bank_transfer
18
40
  IDEAL = :ideal
41
+ KAKAO_PAY = :kakao_pay
19
42
  KLARNA = :klarna
43
+ KONBINI = :konbini
44
+ KR_CARD = :kr_card
45
+ KR_MARKET = :kr_market
46
+ KRIYA = :kriya
47
+ LINK = :link
48
+ MB_WAY = :mb_way
20
49
  MOBILEPAY = :mobilepay
21
- SEPA_DEBIT = :sepa_debit
22
- SWISH = :swish
23
- TWINT = :twint
24
- US_BANK_ACCOUNT = :us_bank_account
25
- ZIP = :zip
26
- VIPPS = :vipps
27
- PAYPAL = :paypal
28
- SEZZLE = :sezzle
29
- COINBASE = :coinbase
30
- SPLITIT = :splitit
31
- PLATFORM_BALANCE = :platform_balance
32
- APPLE = :apple
33
- VENMO = :venmo
34
- AFFIRM = :affirm
50
+ MONDU = :mondu
35
51
  MULTIBANCO = :multibanco
36
- WECHAT_PAY = :wechat_pay
37
52
  NAVER_PAY = :naver_pay
53
+ NETBANKING = :netbanking
54
+ NG_BANK = :ng_bank
55
+ NG_BANK_TRANSFER = :ng_bank_transfer
56
+ NG_CARD = :ng_card
57
+ NG_MARKET = :ng_market
58
+ NG_USSD = :ng_ussd
59
+ NG_WALLET = :ng_wallet
38
60
  NZ_BANK_ACCOUNT = :nz_bank_account
39
61
  OXXO = :oxxo
40
62
  P24 = :p24
41
63
  PAY_BY_BANK = :pay_by_bank
42
64
  PAYCO = :payco
43
65
  PAYNOW = :paynow
66
+ PAYPAL = :paypal
67
+ PAYPAY = :paypay
68
+ PAYTO = :payto
44
69
  PIX = :pix
70
+ PLATFORM_BALANCE = :platform_balance
45
71
  PROMPTPAY = :promptpay
72
+ QRIS = :qris
73
+ RECHNUNG = :rechnung
46
74
  REVOLUT_PAY = :revolut_pay
47
75
  SAMSUNG_PAY = :samsung_pay
48
76
  SATISPAY = :satispay
49
- SOFORT = :sofort
50
- KONBINI = :konbini
51
- KR_CARD = :kr_card
52
- LINK = :link
53
- GRABPAY = :grabpay
54
- KAKAO_PAY = :kakao_pay
55
- BILLIE = :billie
56
- BLIK = :blik
57
- BOLETO = :boleto
58
- EPS = :eps
59
- FPX = :fpx
60
- GIROPAY = :giropay
61
- ACSS_DEBIT = :acss_debit
62
- ALMA = :alma
63
- AU_BECS_DEBIT = :au_becs_debit
64
- BACS_DEBIT = :bacs_debit
65
- BIZUM = :bizum
66
- CAPCHASE_PAY = :capchase_pay
67
- KRIYA = :kriya
68
- MONDU = :mondu
69
- NG_WALLET = :ng_wallet
70
- PAYPAY = :paypay
71
- SEQURA = :sequra
72
77
  SCALAPAY = :scalapay
73
- CUSTOM = :custom
74
- CUSTOMER_BALANCE = :customer_balance
75
- GOPAY = :gopay
76
- MB_WAY = :mb_way
77
- NG_BANK = :ng_bank
78
- NG_BANK_TRANSFER = :ng_bank_transfer
79
- NG_CARD = :ng_card
80
- NG_MARKET = :ng_market
81
- NG_USSD = :ng_ussd
82
- PAYTO = :payto
83
- QRIS = :qris
84
- RECHNUNG = :rechnung
85
- SOUTH_KOREA_MARKET = :south_korea_market
86
- KR_MARKET = :kr_market
78
+ SEPA_DEBIT = :sepa_debit
79
+ SEQURA = :sequra
80
+ SEZZLE = :sezzle
81
+ SHOP_PAY = :shop_pay
87
82
  SHOPEEPAY = :shopeepay
88
- UPI = :upi
83
+ SOFORT = :sofort
84
+ SOUTH_KOREA_MARKET = :south_korea_market
85
+ SPLITIT = :splitit
89
86
  SUNBIT = :sunbit
90
- NETBANKING = :netbanking
91
- ID_BANK_TRANSFER = :id_bank_transfer
92
- DEMO_PAY = :demo_pay
93
- SHOP_PAY = :shop_pay
87
+ SWISH = :swish
88
+ TWINT = :twint
89
+ UPI = :upi
90
+ US_BANK_ACCOUNT = :us_bank_account
91
+ VENMO = :venmo
92
+ VIPPS = :vipps
93
+ WECHAT_PAY = :wechat_pay
94
+ ZIP = :zip
94
95
  UNKNOWN = :unknown
95
96
 
96
97
  # @!method self.values
@@ -14,6 +14,7 @@ module WhopSDK
14
14
  SPLITIT = :splitit
15
15
  PLATFORM_BALANCE = :platform_balance
16
16
  MULTI_PSP = :multi_psp
17
+ ADYEN = :adyen
17
18
 
18
19
  # @!method self.values
19
20
  # @return [Array<Symbol>]
@@ -60,12 +60,25 @@ module WhopSDK
60
60
  # @return [String]
61
61
  required :id, String
62
62
 
63
+ # @!attribute account_reference
64
+ # A reference to identify the payout destination, such as the last 4 digits of an
65
+ # account number or an email address.
66
+ #
67
+ # @return [String, nil]
68
+ required :account_reference, String, nil?: true
69
+
63
70
  # @!attribute company
64
71
  # The company associated with the payout token
65
72
  #
66
73
  # @return [WhopSDK::Models::PayoutMethodCreatedWebhookEvent::Data::Company, nil]
67
74
  required :company, -> { WhopSDK::PayoutMethodCreatedWebhookEvent::Data::Company }, nil?: true
68
75
 
76
+ # @!attribute created_at
77
+ # The date and time the payout token was created
78
+ #
79
+ # @return [Time]
80
+ required :created_at, Time
81
+
69
82
  # @!attribute currency
70
83
  # The currency code of the payout destination. This is the currency that payouts
71
84
  # will be made in for this token.
@@ -79,6 +92,12 @@ module WhopSDK
79
92
  # @return [WhopSDK::Models::PayoutMethodCreatedWebhookEvent::Data::Destination, nil]
80
93
  required :destination, -> { WhopSDK::PayoutMethodCreatedWebhookEvent::Data::Destination }, nil?: true
81
94
 
95
+ # @!attribute institution_name
96
+ # The name of the bank or financial institution.
97
+ #
98
+ # @return [String, nil]
99
+ required :institution_name, String, nil?: true
100
+
82
101
  # @!attribute is_default
83
102
  # Whether this payout token is the default for the payout account
84
103
  #
@@ -92,7 +111,7 @@ module WhopSDK
92
111
  # @return [String, nil]
93
112
  required :nickname, String, nil?: true
94
113
 
95
- # @!method initialize(id:, company:, currency:, destination:, is_default:, nickname:)
114
+ # @!method initialize(id:, account_reference:, company:, created_at:, currency:, destination:, institution_name:, is_default:, nickname:)
96
115
  # Some parameter documentations has been truncated, see
97
116
  # {WhopSDK::Models::PayoutMethodCreatedWebhookEvent::Data} for more details.
98
117
  #
@@ -100,12 +119,18 @@ module WhopSDK
100
119
  #
101
120
  # @param id [String] The ID of the payout token
102
121
  #
122
+ # @param account_reference [String, nil] A reference to identify the payout destination, such as the last 4 digits of an
123
+ #
103
124
  # @param company [WhopSDK::Models::PayoutMethodCreatedWebhookEvent::Data::Company, nil] The company associated with the payout token
104
125
  #
126
+ # @param created_at [Time] The date and time the payout token was created
127
+ #
105
128
  # @param currency [String] The currency code of the payout destination. This is the currency that payouts w
106
129
  #
107
130
  # @param destination [WhopSDK::Models::PayoutMethodCreatedWebhookEvent::Data::Destination, nil] The payout destination associated with the payout token
108
131
  #
132
+ # @param institution_name [String, nil] The name of the bank or financial institution.
133
+ #
109
134
  # @param is_default [Boolean] Whether this payout token is the default for the payout account
110
135
  #
111
136
  # @param nickname [String, nil] An optional nickname for the payout token to help the user identify it. This is
@@ -10,12 +10,25 @@ module WhopSDK
10
10
  # @return [String]
11
11
  required :id, String
12
12
 
13
+ # @!attribute account_reference
14
+ # A reference to identify the payout destination, such as the last 4 digits of an
15
+ # account number or an email address.
16
+ #
17
+ # @return [String, nil]
18
+ required :account_reference, String, nil?: true
19
+
13
20
  # @!attribute company
14
21
  # The company associated with the payout token
15
22
  #
16
23
  # @return [WhopSDK::Models::PayoutMethodListResponse::Company, nil]
17
24
  required :company, -> { WhopSDK::Models::PayoutMethodListResponse::Company }, nil?: true
18
25
 
26
+ # @!attribute created_at
27
+ # The date and time the payout token was created
28
+ #
29
+ # @return [Time]
30
+ required :created_at, Time
31
+
19
32
  # @!attribute currency
20
33
  # The currency code of the payout destination. This is the currency that payouts
21
34
  # will be made in for this token.
@@ -29,6 +42,12 @@ module WhopSDK
29
42
  # @return [WhopSDK::Models::PayoutMethodListResponse::Destination, nil]
30
43
  required :destination, -> { WhopSDK::Models::PayoutMethodListResponse::Destination }, nil?: true
31
44
 
45
+ # @!attribute institution_name
46
+ # The name of the bank or financial institution.
47
+ #
48
+ # @return [String, nil]
49
+ required :institution_name, String, nil?: true
50
+
32
51
  # @!attribute is_default
33
52
  # Whether this payout token is the default for the payout account
34
53
  #
@@ -42,7 +61,7 @@ module WhopSDK
42
61
  # @return [String, nil]
43
62
  required :nickname, String, nil?: true
44
63
 
45
- # @!method initialize(id:, company:, currency:, destination:, is_default:, nickname:)
64
+ # @!method initialize(id:, account_reference:, company:, created_at:, currency:, destination:, institution_name:, is_default:, nickname:)
46
65
  # Some parameter documentations has been truncated, see
47
66
  # {WhopSDK::Models::PayoutMethodListResponse} for more details.
48
67
  #
@@ -50,12 +69,18 @@ module WhopSDK
50
69
  #
51
70
  # @param id [String] The ID of the payout token
52
71
  #
72
+ # @param account_reference [String, nil] A reference to identify the payout destination, such as the last 4 digits of an
73
+ #
53
74
  # @param company [WhopSDK::Models::PayoutMethodListResponse::Company, nil] The company associated with the payout token
54
75
  #
76
+ # @param created_at [Time] The date and time the payout token was created
77
+ #
55
78
  # @param currency [String] The currency code of the payout destination. This is the currency that payouts w
56
79
  #
57
80
  # @param destination [WhopSDK::Models::PayoutMethodListResponse::Destination, nil] The payout destination associated with the payout token
58
81
  #
82
+ # @param institution_name [String, nil] The name of the bank or financial institution.
83
+ #
59
84
  # @param is_default [Boolean] Whether this payout token is the default for the payout account
60
85
  #
61
86
  # @param nickname [String, nil] An optional nickname for the payout token to help the user identify it. This is
@@ -10,12 +10,25 @@ module WhopSDK
10
10
  # @return [String]
11
11
  required :id, String
12
12
 
13
+ # @!attribute account_reference
14
+ # A reference to identify the payout destination, such as the last 4 digits of an
15
+ # account number or an email address.
16
+ #
17
+ # @return [String, nil]
18
+ required :account_reference, String, nil?: true
19
+
13
20
  # @!attribute company
14
21
  # The company associated with the payout token
15
22
  #
16
23
  # @return [WhopSDK::Models::PayoutMethodRetrieveResponse::Company, nil]
17
24
  required :company, -> { WhopSDK::Models::PayoutMethodRetrieveResponse::Company }, nil?: true
18
25
 
26
+ # @!attribute created_at
27
+ # The date and time the payout token was created
28
+ #
29
+ # @return [Time]
30
+ required :created_at, Time
31
+
19
32
  # @!attribute currency
20
33
  # The currency code of the payout destination. This is the currency that payouts
21
34
  # will be made in for this token.
@@ -29,6 +42,12 @@ module WhopSDK
29
42
  # @return [WhopSDK::Models::PayoutMethodRetrieveResponse::Destination, nil]
30
43
  required :destination, -> { WhopSDK::Models::PayoutMethodRetrieveResponse::Destination }, nil?: true
31
44
 
45
+ # @!attribute institution_name
46
+ # The name of the bank or financial institution.
47
+ #
48
+ # @return [String, nil]
49
+ required :institution_name, String, nil?: true
50
+
32
51
  # @!attribute is_default
33
52
  # Whether this payout token is the default for the payout account
34
53
  #
@@ -42,7 +61,7 @@ module WhopSDK
42
61
  # @return [String, nil]
43
62
  required :nickname, String, nil?: true
44
63
 
45
- # @!method initialize(id:, company:, currency:, destination:, is_default:, nickname:)
64
+ # @!method initialize(id:, account_reference:, company:, created_at:, currency:, destination:, institution_name:, is_default:, nickname:)
46
65
  # Some parameter documentations has been truncated, see
47
66
  # {WhopSDK::Models::PayoutMethodRetrieveResponse} for more details.
48
67
  #
@@ -50,12 +69,18 @@ module WhopSDK
50
69
  #
51
70
  # @param id [String] The ID of the payout token
52
71
  #
72
+ # @param account_reference [String, nil] A reference to identify the payout destination, such as the last 4 digits of an
73
+ #
53
74
  # @param company [WhopSDK::Models::PayoutMethodRetrieveResponse::Company, nil] The company associated with the payout token
54
75
  #
76
+ # @param created_at [Time] The date and time the payout token was created
77
+ #
55
78
  # @param currency [String] The currency code of the payout destination. This is the currency that payouts w
56
79
  #
57
80
  # @param destination [WhopSDK::Models::PayoutMethodRetrieveResponse::Destination, nil] The payout destination associated with the payout token
58
81
  #
82
+ # @param institution_name [String, nil] The name of the bank or financial institution.
83
+ #
59
84
  # @param is_default [Boolean] Whether this payout token is the default for the payout account
60
85
  #
61
86
  # @param nickname [String, nil] An optional nickname for the payout token to help the user identify it. This is
@@ -54,8 +54,8 @@ module WhopSDK
54
54
  # @!attribute image
55
55
  # An image for the plan. This will be visible on the product page to customers.
56
56
  #
57
- # @return [WhopSDK::Models::PlanCreateParams::Image::AttachmentInputWithDirectUploadID, WhopSDK::Models::PlanCreateParams::Image::AttachmentInputWithID, nil]
58
- optional :image, union: -> { WhopSDK::PlanCreateParams::Image }, nil?: true
57
+ # @return [WhopSDK::Models::PlanCreateParams::Image, nil]
58
+ optional :image, -> { WhopSDK::PlanCreateParams::Image }, nil?: true
59
59
 
60
60
  # @!attribute initial_price
61
61
  # An additional amount charged upon first purchase. Use only if a one time payment
@@ -166,7 +166,7 @@ module WhopSDK
166
166
  #
167
167
  # @param expiration_days [Integer, nil] The interval at which the plan expires and revokes access (expiration plans).
168
168
  #
169
- # @param image [WhopSDK::Models::PlanCreateParams::Image::AttachmentInputWithDirectUploadID, WhopSDK::Models::PlanCreateParams::Image::AttachmentInputWithID, nil] An image for the plan. This will be visible on the product page to customers.
169
+ # @param image [WhopSDK::Models::PlanCreateParams::Image, nil] An image for the plan. This will be visible on the product page to customers.
170
170
  #
171
171
  # @param initial_price [Float, nil] An additional amount charged upon first purchase. Use only if a one time payment
172
172
  #
@@ -249,56 +249,17 @@ module WhopSDK
249
249
  # @param field_type [Symbol, :text] The type of the custom field.
250
250
  end
251
251
 
252
- # An image for the plan. This will be visible on the product page to customers.
253
- module Image
254
- extend WhopSDK::Internal::Type::Union
255
-
256
- # Input for an attachment
257
- variant -> { WhopSDK::PlanCreateParams::Image::AttachmentInputWithDirectUploadID }
258
-
259
- # Input for an attachment
260
- variant -> { WhopSDK::PlanCreateParams::Image::AttachmentInputWithID }
261
-
262
- class AttachmentInputWithDirectUploadID < WhopSDK::Internal::Type::BaseModel
263
- # @!attribute direct_upload_id
264
- # This ID should be used the first time you upload an attachment. It is the ID of
265
- # the direct upload that was created when uploading the file to S3 via the
266
- # mediaDirectUpload mutation.
267
- #
268
- # @return [String]
269
- required :direct_upload_id, String
270
-
271
- # @!method initialize(direct_upload_id:)
272
- # Some parameter documentations has been truncated, see
273
- # {WhopSDK::Models::PlanCreateParams::Image::AttachmentInputWithDirectUploadID}
274
- # for more details.
275
- #
276
- # Input for an attachment
277
- #
278
- # @param direct_upload_id [String] This ID should be used the first time you upload an attachment. It is the ID of
279
- end
280
-
281
- class AttachmentInputWithID < WhopSDK::Internal::Type::BaseModel
282
- # @!attribute id
283
- # The ID of an existing attachment object. Use this when updating a resource and
284
- # keeping a subset of the attachments. Don't use this unless you know what you're
285
- # doing.
286
- #
287
- # @return [String]
288
- required :id, String
289
-
290
- # @!method initialize(id:)
291
- # Some parameter documentations has been truncated, see
292
- # {WhopSDK::Models::PlanCreateParams::Image::AttachmentInputWithID} for more
293
- # details.
294
- #
295
- # Input for an attachment
296
- #
297
- # @param id [String] The ID of an existing attachment object. Use this when updating a resource and k
298
- end
299
-
300
- # @!method self.variants
301
- # @return [Array(WhopSDK::Models::PlanCreateParams::Image::AttachmentInputWithDirectUploadID, WhopSDK::Models::PlanCreateParams::Image::AttachmentInputWithID)]
252
+ class Image < WhopSDK::Internal::Type::BaseModel
253
+ # @!attribute id
254
+ # The ID of an existing file object.
255
+ #
256
+ # @return [String]
257
+ required :id, String
258
+
259
+ # @!method initialize(id:)
260
+ # An image for the plan. This will be visible on the product page to customers.
261
+ #
262
+ # @param id [String] The ID of an existing file object.
302
263
  end
303
264
 
304
265
  class PaymentMethodConfiguration < WhopSDK::Internal::Type::BaseModel
@@ -42,8 +42,8 @@ module WhopSDK
42
42
  # @!attribute image
43
43
  # An image for the plan. This will be visible on the product page to customers.
44
44
  #
45
- # @return [WhopSDK::Models::PlanUpdateParams::Image::AttachmentInputWithDirectUploadID, WhopSDK::Models::PlanUpdateParams::Image::AttachmentInputWithID, nil]
46
- optional :image, union: -> { WhopSDK::PlanUpdateParams::Image }, nil?: true
45
+ # @return [WhopSDK::Models::PlanUpdateParams::Image, nil]
46
+ optional :image, -> { WhopSDK::PlanUpdateParams::Image }, nil?: true
47
47
 
48
48
  # @!attribute initial_price
49
49
  # An additional amount charged upon first purchase.
@@ -149,7 +149,7 @@ module WhopSDK
149
149
  #
150
150
  # @param expiration_days [Integer, nil] The interval at which the plan charges (expiration plans).
151
151
  #
152
- # @param image [WhopSDK::Models::PlanUpdateParams::Image::AttachmentInputWithDirectUploadID, WhopSDK::Models::PlanUpdateParams::Image::AttachmentInputWithID, nil] An image for the plan. This will be visible on the product page to customers.
152
+ # @param image [WhopSDK::Models::PlanUpdateParams::Image, nil] An image for the plan. This will be visible on the product page to customers.
153
153
  #
154
154
  # @param initial_price [Float, nil] An additional amount charged upon first purchase.
155
155
  #
@@ -232,56 +232,17 @@ module WhopSDK
232
232
  # @param field_type [Symbol, :text] The type of the custom field.
233
233
  end
234
234
 
235
- # An image for the plan. This will be visible on the product page to customers.
236
- module Image
237
- extend WhopSDK::Internal::Type::Union
238
-
239
- # Input for an attachment
240
- variant -> { WhopSDK::PlanUpdateParams::Image::AttachmentInputWithDirectUploadID }
241
-
242
- # Input for an attachment
243
- variant -> { WhopSDK::PlanUpdateParams::Image::AttachmentInputWithID }
244
-
245
- class AttachmentInputWithDirectUploadID < WhopSDK::Internal::Type::BaseModel
246
- # @!attribute direct_upload_id
247
- # This ID should be used the first time you upload an attachment. It is the ID of
248
- # the direct upload that was created when uploading the file to S3 via the
249
- # mediaDirectUpload mutation.
250
- #
251
- # @return [String]
252
- required :direct_upload_id, String
253
-
254
- # @!method initialize(direct_upload_id:)
255
- # Some parameter documentations has been truncated, see
256
- # {WhopSDK::Models::PlanUpdateParams::Image::AttachmentInputWithDirectUploadID}
257
- # for more details.
258
- #
259
- # Input for an attachment
260
- #
261
- # @param direct_upload_id [String] This ID should be used the first time you upload an attachment. It is the ID of
262
- end
263
-
264
- class AttachmentInputWithID < WhopSDK::Internal::Type::BaseModel
265
- # @!attribute id
266
- # The ID of an existing attachment object. Use this when updating a resource and
267
- # keeping a subset of the attachments. Don't use this unless you know what you're
268
- # doing.
269
- #
270
- # @return [String]
271
- required :id, String
272
-
273
- # @!method initialize(id:)
274
- # Some parameter documentations has been truncated, see
275
- # {WhopSDK::Models::PlanUpdateParams::Image::AttachmentInputWithID} for more
276
- # details.
277
- #
278
- # Input for an attachment
279
- #
280
- # @param id [String] The ID of an existing attachment object. Use this when updating a resource and k
281
- end
282
-
283
- # @!method self.variants
284
- # @return [Array(WhopSDK::Models::PlanUpdateParams::Image::AttachmentInputWithDirectUploadID, WhopSDK::Models::PlanUpdateParams::Image::AttachmentInputWithID)]
235
+ class Image < WhopSDK::Internal::Type::BaseModel
236
+ # @!attribute id
237
+ # The ID of an existing file object.
238
+ #
239
+ # @return [String]
240
+ required :id, String
241
+
242
+ # @!method initialize(id:)
243
+ # An image for the plan. This will be visible on the product page to customers.
244
+ #
245
+ # @param id [String] The ID of an existing file object.
285
246
  end
286
247
 
287
248
  class PaymentMethodConfiguration < WhopSDK::Internal::Type::BaseModel
@@ -31,7 +31,23 @@ module WhopSDK
31
31
  # @return [String, nil]
32
32
  optional :payout_method_id, String, nil?: true
33
33
 
34
- # @!method initialize(amount:, company_id:, currency:, payout_method_id: nil, request_options: {})
34
+ # @!attribute platform_covers_fees
35
+ # Whether the platform covers the payout fees instead of the connected account.
36
+ #
37
+ # @return [Boolean, nil]
38
+ optional :platform_covers_fees, WhopSDK::Internal::Type::Boolean, nil?: true
39
+
40
+ # @!attribute statement_descriptor
41
+ # Custom statement descriptor for the withdrawal. Must be between 5 and 22
42
+ # characters and contain only alphanumeric characters.
43
+ #
44
+ # @return [String, nil]
45
+ optional :statement_descriptor, String, nil?: true
46
+
47
+ # @!method initialize(amount:, company_id:, currency:, payout_method_id: nil, platform_covers_fees: nil, statement_descriptor: nil, request_options: {})
48
+ # Some parameter documentations has been truncated, see
49
+ # {WhopSDK::Models::WithdrawalCreateParams} for more details.
50
+ #
35
51
  # @param amount [Float] The amount to withdraw in the specified currency
36
52
  #
37
53
  # @param company_id [String] The ID of the company to withdraw from.
@@ -40,6 +56,10 @@ module WhopSDK
40
56
  #
41
57
  # @param payout_method_id [String, nil] The ID of the payout method to use for the withdrawal.
42
58
  #
59
+ # @param platform_covers_fees [Boolean, nil] Whether the platform covers the payout fees instead of the connected account.
60
+ #
61
+ # @param statement_descriptor [String, nil] Custom statement descriptor for the withdrawal. Must be between 5 and 22 charact
62
+ #
43
63
  # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
44
64
  end
45
65
  end
@@ -98,13 +98,7 @@ module WhopSDK
98
98
  # @return [String, nil]
99
99
  required :trace_code, String, nil?: true
100
100
 
101
- # @!attribute withdrawal_type
102
- # The type of withdrawal.
103
- #
104
- # @return [Symbol, WhopSDK::Models::WithdrawalTypes]
105
- required :withdrawal_type, enum: -> { WhopSDK::WithdrawalTypes }
106
-
107
- # @!method initialize(id:, amount:, created_at:, currency:, error_code:, error_message:, estimated_availability:, fee_amount:, fee_type:, ledger_account:, markup_fee:, payout_token:, speed:, status:, trace_code:, withdrawal_type:)
101
+ # @!method initialize(id:, amount:, created_at:, currency:, error_code:, error_message:, estimated_availability:, fee_amount:, fee_type:, ledger_account:, markup_fee:, payout_token:, speed:, status:, trace_code:)
108
102
  # Some parameter documentations has been truncated, see
109
103
  # {WhopSDK::Models::WithdrawalCreateResponse} for more details.
110
104
  #
@@ -139,8 +133,6 @@ module WhopSDK
139
133
  # @param status [Symbol, WhopSDK::Models::WithdrawalStatus] Status of the withdrawal.
140
134
  #
141
135
  # @param trace_code [String, nil] The trace code for the payout, if applicable. Provided on ACH transactions when
142
- #
143
- # @param withdrawal_type [Symbol, WhopSDK::Models::WithdrawalTypes] The type of withdrawal.
144
136
 
145
137
  # The different error codes a payout can be in.
146
138
  #
@@ -173,6 +165,7 @@ module WhopSDK
173
165
  INVALID_ACCOUNT_NUMBER = :invalid_account_number
174
166
  INVALID_BANK_CODE = :invalid_bank_code
175
167
  INVALID_BENEFICIARY = :invalid_beneficiary
168
+ INVALID_MAILING_ADDRESS = :invalid_mailing_address
176
169
  INVALID_BRANCH_NUMBER = :invalid_branch_number
177
170
  INVALID_BRANCH_CODE = :invalid_branch_code
178
171
  INVALID_PHONE_NUMBER = :invalid_phone_number