whop_sdk 0.0.37 → 0.0.39

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 (248) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +61 -0
  3. data/README.md +1 -1
  4. data/lib/whop_sdk/client.rb +76 -10
  5. data/lib/whop_sdk/helpers/verify_user_token.rb +166 -34
  6. data/lib/whop_sdk/models/ad_campaign_list_params.rb +101 -0
  7. data/lib/whop_sdk/models/ad_campaign_list_response.rb +126 -0
  8. data/lib/whop_sdk/models/ad_campaign_pause_params.rb +20 -0
  9. data/lib/whop_sdk/models/ad_campaign_pause_response.rb +328 -0
  10. data/lib/whop_sdk/models/ad_campaign_retrieve_params.rb +20 -0
  11. data/lib/whop_sdk/models/ad_campaign_retrieve_response.rb +328 -0
  12. data/lib/whop_sdk/models/ad_campaign_unpause_params.rb +20 -0
  13. data/lib/whop_sdk/models/ad_campaign_unpause_response.rb +328 -0
  14. data/lib/whop_sdk/models/ad_campaign_update_params.rb +33 -0
  15. data/lib/whop_sdk/models/ad_campaign_update_response.rb +328 -0
  16. data/lib/whop_sdk/models/ad_group_delete_params.rb +20 -0
  17. data/lib/whop_sdk/models/ad_group_delete_response.rb +8 -0
  18. data/lib/whop_sdk/models/ad_group_list_params.rb +109 -0
  19. data/lib/whop_sdk/models/ad_group_list_response.rb +118 -0
  20. data/lib/whop_sdk/models/ad_group_retrieve_params.rb +20 -0
  21. data/lib/whop_sdk/models/ad_group_retrieve_response.rb +140 -0
  22. data/lib/whop_sdk/models/ad_group_update_params.rb +3207 -0
  23. data/lib/whop_sdk/models/ad_group_update_response.rb +140 -0
  24. data/lib/whop_sdk/models/ad_list_params.rb +115 -0
  25. data/lib/whop_sdk/models/ad_list_response.rb +89 -0
  26. data/lib/whop_sdk/models/ad_report_retrieve_params.rb +77 -0
  27. data/lib/whop_sdk/models/ad_report_retrieve_response.rb +312 -0
  28. data/lib/whop_sdk/models/ad_retrieve_params.rb +20 -0
  29. data/lib/whop_sdk/models/ad_retrieve_response.rb +133 -0
  30. data/lib/whop_sdk/models/authorized_user_roles.rb +1 -0
  31. data/lib/whop_sdk/models/bounty_create_params.rb +105 -0
  32. data/lib/whop_sdk/models/bounty_create_response.rb +126 -0
  33. data/lib/whop_sdk/models/bounty_list_params.rb +85 -0
  34. data/lib/whop_sdk/models/bounty_list_response.rb +126 -0
  35. data/lib/whop_sdk/models/bounty_retrieve_params.rb +20 -0
  36. data/lib/whop_sdk/models/bounty_retrieve_response.rb +126 -0
  37. data/lib/whop_sdk/models/checkout_configuration.rb +20 -2
  38. data/lib/whop_sdk/models/checkout_configuration_create_params.rb +97 -23
  39. data/lib/whop_sdk/models/checkout_configuration_list_response.rb +20 -2
  40. data/lib/whop_sdk/models/company_create_api_key_params.rb +109 -0
  41. data/lib/whop_sdk/models/company_create_api_key_response.rb +35 -0
  42. data/lib/whop_sdk/models/conversion_create_params.rb +462 -0
  43. data/lib/whop_sdk/models/conversion_create_response.rb +19 -0
  44. data/lib/whop_sdk/models/currency.rb +1 -0
  45. data/lib/whop_sdk/models/file_create_params.rb +22 -1
  46. data/lib/whop_sdk/models/file_create_response.rb +26 -3
  47. data/lib/whop_sdk/models/file_retrieve_response.rb +26 -3
  48. data/lib/whop_sdk/models/forum_post_list_params.rb +9 -1
  49. data/lib/whop_sdk/models/forum_update_params.rb +10 -1
  50. data/lib/whop_sdk/models/invoice_create_params.rb +36 -18
  51. data/lib/whop_sdk/models/invoice_update_params.rb +29 -7
  52. data/lib/whop_sdk/models/ledger_account_retrieve_response.rb +2 -2
  53. data/lib/whop_sdk/models/membership.rb +11 -1
  54. data/lib/whop_sdk/models/membership_list_response.rb +11 -1
  55. data/lib/whop_sdk/models/payment.rb +47 -2
  56. data/lib/whop_sdk/models/payment_list_response.rb +29 -2
  57. data/lib/whop_sdk/models/payment_method_types.rb +16 -0
  58. data/lib/whop_sdk/models/payment_refund_params.rb +4 -3
  59. data/lib/whop_sdk/models/payout_account_retrieve_response.rb +2 -2
  60. data/lib/whop_sdk/models/payout_account_status_updated_webhook_event.rb +2 -2
  61. data/lib/whop_sdk/models/plan.rb +12 -3
  62. data/lib/whop_sdk/models/plan_create_params.rb +26 -6
  63. data/lib/whop_sdk/models/plan_list_response.rb +12 -3
  64. data/lib/whop_sdk/models/plan_update_params.rb +26 -6
  65. data/lib/whop_sdk/models/support_channel_list_params.rb +31 -9
  66. data/lib/whop_sdk/models/user_retrieve_params.rb +14 -1
  67. data/lib/whop_sdk/models/{user_update_profile_params.rb → user_update_params.rb} +24 -7
  68. data/lib/whop_sdk/models/verification_list_response.rb +2 -2
  69. data/lib/whop_sdk/models/verification_retrieve_response.rb +2 -2
  70. data/lib/whop_sdk/models/verification_status.rb +1 -0
  71. data/lib/whop_sdk/models/verification_succeeded_webhook_event.rb +2 -2
  72. data/lib/whop_sdk/models.rb +35 -1
  73. data/lib/whop_sdk/resources/ad_campaigns.rb +163 -0
  74. data/lib/whop_sdk/resources/ad_groups.rb +151 -0
  75. data/lib/whop_sdk/resources/ad_reports.rb +59 -0
  76. data/lib/whop_sdk/resources/ads.rb +88 -0
  77. data/lib/whop_sdk/resources/bounties.rb +124 -0
  78. data/lib/whop_sdk/resources/companies.rb +34 -0
  79. data/lib/whop_sdk/resources/conversions.rb +67 -0
  80. data/lib/whop_sdk/resources/files.rb +3 -1
  81. data/lib/whop_sdk/resources/forum_posts.rb +3 -1
  82. data/lib/whop_sdk/resources/forums.rb +3 -1
  83. data/lib/whop_sdk/resources/invoices.rb +9 -2
  84. data/lib/whop_sdk/resources/payments.rb +1 -1
  85. data/lib/whop_sdk/resources/plans.rb +6 -2
  86. data/lib/whop_sdk/resources/support_channels.rb +6 -4
  87. data/lib/whop_sdk/resources/users.rb +49 -37
  88. data/lib/whop_sdk/version.rb +1 -1
  89. data/lib/whop_sdk.rb +41 -1
  90. data/rbi/whop_sdk/client.rbi +24 -0
  91. data/rbi/whop_sdk/models/ad_campaign_list_params.rbi +142 -0
  92. data/rbi/whop_sdk/models/ad_campaign_list_response.rbi +239 -0
  93. data/rbi/whop_sdk/models/ad_campaign_pause_params.rbi +35 -0
  94. data/rbi/whop_sdk/models/ad_campaign_pause_response.rbi +668 -0
  95. data/rbi/whop_sdk/models/ad_campaign_retrieve_params.rbi +35 -0
  96. data/rbi/whop_sdk/models/ad_campaign_retrieve_response.rbi +679 -0
  97. data/rbi/whop_sdk/models/ad_campaign_unpause_params.rbi +35 -0
  98. data/rbi/whop_sdk/models/ad_campaign_unpause_response.rbi +675 -0
  99. data/rbi/whop_sdk/models/ad_campaign_update_params.rbi +51 -0
  100. data/rbi/whop_sdk/models/ad_campaign_update_response.rbi +670 -0
  101. data/rbi/whop_sdk/models/ad_group_delete_params.rbi +35 -0
  102. data/rbi/whop_sdk/models/ad_group_delete_response.rbi +8 -0
  103. data/rbi/whop_sdk/models/ad_group_list_params.rbi +145 -0
  104. data/rbi/whop_sdk/models/ad_group_list_response.rbi +228 -0
  105. data/rbi/whop_sdk/models/ad_group_retrieve_params.rbi +35 -0
  106. data/rbi/whop_sdk/models/ad_group_retrieve_response.rbi +277 -0
  107. data/rbi/whop_sdk/models/ad_group_update_params.rbi +6133 -0
  108. data/rbi/whop_sdk/models/ad_group_update_response.rbi +274 -0
  109. data/rbi/whop_sdk/models/ad_list_params.rbi +146 -0
  110. data/rbi/whop_sdk/models/ad_list_response.rbi +146 -0
  111. data/rbi/whop_sdk/models/ad_report_retrieve_params.rbi +99 -0
  112. data/rbi/whop_sdk/models/ad_report_retrieve_response.rbi +629 -0
  113. data/rbi/whop_sdk/models/ad_retrieve_params.rbi +35 -0
  114. data/rbi/whop_sdk/models/ad_retrieve_response.rbi +245 -0
  115. data/rbi/whop_sdk/models/authorized_user_roles.rbi +2 -0
  116. data/rbi/whop_sdk/models/bounty_create_params.rbi +129 -0
  117. data/rbi/whop_sdk/models/bounty_create_response.rbi +196 -0
  118. data/rbi/whop_sdk/models/bounty_list_params.rbi +115 -0
  119. data/rbi/whop_sdk/models/bounty_list_response.rbi +189 -0
  120. data/rbi/whop_sdk/models/bounty_retrieve_params.rbi +35 -0
  121. data/rbi/whop_sdk/models/bounty_retrieve_response.rbi +199 -0
  122. data/rbi/whop_sdk/models/checkout_configuration.rbi +20 -0
  123. data/rbi/whop_sdk/models/checkout_configuration_create_params.rbi +84 -16
  124. data/rbi/whop_sdk/models/checkout_configuration_list_response.rbi +20 -0
  125. data/rbi/whop_sdk/models/company_create_api_key_params.rbi +184 -0
  126. data/rbi/whop_sdk/models/company_create_api_key_response.rbi +51 -0
  127. data/rbi/whop_sdk/models/conversion_create_params.rbi +661 -0
  128. data/rbi/whop_sdk/models/conversion_create_response.rbi +31 -0
  129. data/rbi/whop_sdk/models/currency.rbi +1 -0
  130. data/rbi/whop_sdk/models/file_create_params.rbi +41 -1
  131. data/rbi/whop_sdk/models/file_create_response.rbi +52 -5
  132. data/rbi/whop_sdk/models/file_retrieve_response.rbi +53 -5
  133. data/rbi/whop_sdk/models/forum_post_list_params.rbi +8 -0
  134. data/rbi/whop_sdk/models/forum_update_params.rbi +10 -0
  135. data/rbi/whop_sdk/models/invoice_create_params.rbi +46 -26
  136. data/rbi/whop_sdk/models/invoice_update_params.rbi +28 -6
  137. data/rbi/whop_sdk/models/ledger_account_retrieve_response.rbi +2 -2
  138. data/rbi/whop_sdk/models/membership.rbi +12 -0
  139. data/rbi/whop_sdk/models/membership_list_response.rbi +12 -0
  140. data/rbi/whop_sdk/models/payment.rbi +57 -3
  141. data/rbi/whop_sdk/models/payment_list_response.rbi +37 -3
  142. data/rbi/whop_sdk/models/payment_method_types.rbi +31 -0
  143. data/rbi/whop_sdk/models/payment_refund_params.rbi +6 -4
  144. data/rbi/whop_sdk/models/payout_account_retrieve_response.rbi +2 -2
  145. data/rbi/whop_sdk/models/payout_account_status_updated_webhook_event.rbi +2 -2
  146. data/rbi/whop_sdk/models/plan.rbi +12 -2
  147. data/rbi/whop_sdk/models/plan_create_params.rbi +22 -4
  148. data/rbi/whop_sdk/models/plan_list_response.rbi +12 -2
  149. data/rbi/whop_sdk/models/plan_update_params.rbi +22 -4
  150. data/rbi/whop_sdk/models/support_channel_list_params.rbi +50 -8
  151. data/rbi/whop_sdk/models/user_retrieve_params.rbi +18 -2
  152. data/rbi/whop_sdk/models/{user_update_profile_params.rbi → user_update_params.rbi} +25 -9
  153. data/rbi/whop_sdk/models/verification_list_response.rbi +2 -2
  154. data/rbi/whop_sdk/models/verification_retrieve_response.rbi +2 -2
  155. data/rbi/whop_sdk/models/verification_status.rbi +2 -0
  156. data/rbi/whop_sdk/models/verification_succeeded_webhook_event.rbi +2 -2
  157. data/rbi/whop_sdk/models.rbi +35 -1
  158. data/rbi/whop_sdk/resources/ad_campaigns.rbi +134 -0
  159. data/rbi/whop_sdk/resources/ad_groups.rbi +139 -0
  160. data/rbi/whop_sdk/resources/ad_reports.rbi +55 -0
  161. data/rbi/whop_sdk/resources/ads.rbi +81 -0
  162. data/rbi/whop_sdk/resources/bounties.rbi +116 -0
  163. data/rbi/whop_sdk/resources/companies.rbi +32 -0
  164. data/rbi/whop_sdk/resources/conversions.rbi +71 -0
  165. data/rbi/whop_sdk/resources/files.rbi +5 -0
  166. data/rbi/whop_sdk/resources/forum_posts.rbi +3 -0
  167. data/rbi/whop_sdk/resources/forums.rbi +4 -0
  168. data/rbi/whop_sdk/resources/invoices.rbi +10 -1
  169. data/rbi/whop_sdk/resources/payments.rbi +3 -2
  170. data/rbi/whop_sdk/resources/plans.rbi +6 -0
  171. data/rbi/whop_sdk/resources/support_channels.rbi +8 -3
  172. data/rbi/whop_sdk/resources/users.rbi +42 -29
  173. data/sig/whop_sdk/client.rbs +12 -0
  174. data/sig/whop_sdk/models/ad_campaign_list_params.rbs +82 -0
  175. data/sig/whop_sdk/models/ad_campaign_list_response.rbs +98 -0
  176. data/sig/whop_sdk/models/ad_campaign_pause_params.rbs +20 -0
  177. data/sig/whop_sdk/models/ad_campaign_pause_response.rbs +232 -0
  178. data/sig/whop_sdk/models/ad_campaign_retrieve_params.rbs +20 -0
  179. data/sig/whop_sdk/models/ad_campaign_retrieve_response.rbs +232 -0
  180. data/sig/whop_sdk/models/ad_campaign_unpause_params.rbs +20 -0
  181. data/sig/whop_sdk/models/ad_campaign_unpause_response.rbs +232 -0
  182. data/sig/whop_sdk/models/ad_campaign_update_params.rbs +28 -0
  183. data/sig/whop_sdk/models/ad_campaign_update_response.rbs +232 -0
  184. data/sig/whop_sdk/models/ad_group_delete_params.rbs +20 -0
  185. data/sig/whop_sdk/models/ad_group_delete_response.rbs +5 -0
  186. data/sig/whop_sdk/models/ad_group_list_params.rbs +87 -0
  187. data/sig/whop_sdk/models/ad_group_list_response.rbs +93 -0
  188. data/sig/whop_sdk/models/ad_group_retrieve_params.rbs +20 -0
  189. data/sig/whop_sdk/models/ad_group_retrieve_response.rbs +108 -0
  190. data/sig/whop_sdk/models/ad_group_update_params.rbs +2439 -0
  191. data/sig/whop_sdk/models/ad_group_update_response.rbs +108 -0
  192. data/sig/whop_sdk/models/ad_list_params.rbs +87 -0
  193. data/sig/whop_sdk/models/ad_list_response.rbs +72 -0
  194. data/sig/whop_sdk/models/ad_report_retrieve_params.rbs +56 -0
  195. data/sig/whop_sdk/models/ad_report_retrieve_response.rbs +278 -0
  196. data/sig/whop_sdk/models/ad_retrieve_params.rbs +20 -0
  197. data/sig/whop_sdk/models/ad_retrieve_response.rbs +102 -0
  198. data/sig/whop_sdk/models/authorized_user_roles.rbs +2 -0
  199. data/sig/whop_sdk/models/bounty_create_params.rbs +71 -0
  200. data/sig/whop_sdk/models/bounty_create_response.rbs +93 -0
  201. data/sig/whop_sdk/models/bounty_list_params.rbs +67 -0
  202. data/sig/whop_sdk/models/bounty_list_response.rbs +93 -0
  203. data/sig/whop_sdk/models/bounty_retrieve_params.rbs +20 -0
  204. data/sig/whop_sdk/models/bounty_retrieve_response.rbs +93 -0
  205. data/sig/whop_sdk/models/checkout_configuration.rbs +10 -0
  206. data/sig/whop_sdk/models/checkout_configuration_create_params.rbs +51 -16
  207. data/sig/whop_sdk/models/checkout_configuration_list_response.rbs +10 -0
  208. data/sig/whop_sdk/models/company_create_api_key_params.rbs +83 -0
  209. data/sig/whop_sdk/models/company_create_api_key_response.rbs +18 -0
  210. data/sig/whop_sdk/models/conversion_create_params.rbs +349 -0
  211. data/sig/whop_sdk/models/conversion_create_response.rbs +13 -0
  212. data/sig/whop_sdk/models/currency.rbs +2 -0
  213. data/sig/whop_sdk/models/file_create_params.rbs +20 -1
  214. data/sig/whop_sdk/models/file_create_response.rbs +19 -3
  215. data/sig/whop_sdk/models/file_retrieve_response.rbs +19 -3
  216. data/sig/whop_sdk/models/forum_post_list_params.rbs +5 -0
  217. data/sig/whop_sdk/models/forum_update_params.rbs +5 -0
  218. data/sig/whop_sdk/models/invoice_create_params.rbs +24 -14
  219. data/sig/whop_sdk/models/invoice_update_params.rbs +15 -5
  220. data/sig/whop_sdk/models/membership.rbs +5 -0
  221. data/sig/whop_sdk/models/membership_list_response.rbs +5 -0
  222. data/sig/whop_sdk/models/payment.rbs +25 -3
  223. data/sig/whop_sdk/models/payment_list_response.rbs +15 -3
  224. data/sig/whop_sdk/models/payment_method_types.rbs +32 -0
  225. data/sig/whop_sdk/models/plan.rbs +5 -0
  226. data/sig/whop_sdk/models/plan_create_params.rbs +14 -4
  227. data/sig/whop_sdk/models/plan_list_response.rbs +5 -0
  228. data/sig/whop_sdk/models/plan_update_params.rbs +14 -4
  229. data/sig/whop_sdk/models/support_channel_list_params.rbs +23 -6
  230. data/sig/whop_sdk/models/user_retrieve_params.rbs +10 -2
  231. data/sig/whop_sdk/models/{user_update_profile_params.rbs → user_update_params.rbs} +16 -6
  232. data/sig/whop_sdk/models/verification_status.rbs +2 -0
  233. data/sig/whop_sdk/models.rbs +35 -1
  234. data/sig/whop_sdk/resources/ad_campaigns.rbs +41 -0
  235. data/sig/whop_sdk/resources/ad_groups.rbs +40 -0
  236. data/sig/whop_sdk/resources/ad_reports.rbs +18 -0
  237. data/sig/whop_sdk/resources/ads.rbs +26 -0
  238. data/sig/whop_sdk/resources/bounties.rbs +37 -0
  239. data/sig/whop_sdk/resources/companies.rbs +9 -0
  240. data/sig/whop_sdk/resources/conversions.rbs +25 -0
  241. data/sig/whop_sdk/resources/files.rbs +1 -0
  242. data/sig/whop_sdk/resources/forum_posts.rbs +1 -0
  243. data/sig/whop_sdk/resources/forums.rbs +1 -0
  244. data/sig/whop_sdk/resources/invoices.rbs +2 -0
  245. data/sig/whop_sdk/resources/plans.rbs +2 -0
  246. data/sig/whop_sdk/resources/support_channels.rbs +2 -1
  247. data/sig/whop_sdk/resources/users.rbs +11 -8
  248. metadata +125 -5
@@ -57,9 +57,9 @@ module WhopSDK
57
57
  required :product, -> { WhopSDK::InvoiceCreateParams::Body::CreateInvoiceInputWithProduct::Product }
58
58
 
59
59
  # @!attribute automatically_finalizes_at
60
- # The date and time when the invoice will be automatically finalized and charged.
61
- # Only valid when collection_method is charge_automatically. If not provided, the
62
- # charge will be processed immediately.
60
+ # The date and time when the invoice will be automatically finalized. For
61
+ # charge_automatically, triggers an automatic charge. For send_invoice, sends the
62
+ # invoice email to the customer at the specified time.
63
63
  #
64
64
  # @return [Time, nil]
65
65
  optional :automatically_finalizes_at, Time, nil?: true
@@ -146,7 +146,14 @@ module WhopSDK
146
146
  # @return [Boolean, nil]
147
147
  optional :save_as_draft, WhopSDK::Internal::Type::Boolean, nil?: true
148
148
 
149
- # @!method initialize(collection_method:, company_id:, plan:, product:, automatically_finalizes_at: nil, billing_address: nil, charge_buyer_fee: nil, customer_name: nil, due_date: nil, email_address: nil, line_items: nil, mailing_address_id: nil, member_id: nil, payment_method_id: nil, payment_token_id: nil, save_as_draft: nil)
149
+ # @!attribute subscription_billing_anchor_at
150
+ # The date that defines when the subscription billing cycle should start. When set
151
+ # on a renewal plan invoice, this anchors all future billing periods to this date.
152
+ #
153
+ # @return [Time, nil]
154
+ optional :subscription_billing_anchor_at, Time, nil?: true
155
+
156
+ # @!method initialize(collection_method:, company_id:, plan:, product:, automatically_finalizes_at: nil, billing_address: nil, charge_buyer_fee: nil, customer_name: nil, due_date: nil, email_address: nil, line_items: nil, mailing_address_id: nil, member_id: nil, payment_method_id: nil, payment_token_id: nil, save_as_draft: nil, subscription_billing_anchor_at: nil)
150
157
  # Some parameter documentations has been truncated, see
151
158
  # {WhopSDK::Models::InvoiceCreateParams::Body::CreateInvoiceInputWithProduct} for
152
159
  # more details.
@@ -161,7 +168,7 @@ module WhopSDK
161
168
  #
162
169
  # @param product [WhopSDK::Models::InvoiceCreateParams::Body::CreateInvoiceInputWithProduct::Product] The properties of the product to create for this invoice. Provide this to create
163
170
  #
164
- # @param automatically_finalizes_at [Time, nil] The date and time when the invoice will be automatically finalized and charged.
171
+ # @param automatically_finalizes_at [Time, nil] The date and time when the invoice will be automatically finalized. For charge_a
165
172
  #
166
173
  # @param billing_address [WhopSDK::Models::InvoiceCreateParams::Body::CreateInvoiceInputWithProduct::BillingAddress, nil] Inline billing address to create a new mailing address for this invoice. Cannot
167
174
  #
@@ -185,6 +192,8 @@ module WhopSDK
185
192
  # @param payment_token_id [String, nil] The payment token ID to use for this invoice. If using charge_automatically, you
186
193
  #
187
194
  # @param save_as_draft [Boolean, nil] When true, creates the invoice as a draft without sending or charging. Relaxes c
195
+ #
196
+ # @param subscription_billing_anchor_at [Time, nil] The date that defines when the subscription billing cycle should start. When set
188
197
 
189
198
  # @see WhopSDK::Models::InvoiceCreateParams::Body::CreateInvoiceInputWithProduct#plan
190
199
  class Plan < WhopSDK::Internal::Type::BaseModel
@@ -404,10 +413,10 @@ module WhopSDK
404
413
  # in this configuration. The full list of default payment methods can be found in
405
414
  # the documentation at docs.whop.com/payments.
406
415
  #
407
- # @return [Boolean]
408
- required :include_platform_defaults, WhopSDK::Internal::Type::Boolean
416
+ # @return [Boolean, nil]
417
+ optional :include_platform_defaults, WhopSDK::Internal::Type::Boolean, nil?: true
409
418
 
410
- # @!method initialize(disabled:, enabled:, include_platform_defaults:)
419
+ # @!method initialize(disabled:, enabled:, include_platform_defaults: nil)
411
420
  # Some parameter documentations has been truncated, see
412
421
  # {WhopSDK::Models::InvoiceCreateParams::Body::CreateInvoiceInputWithProduct::Plan::PaymentMethodConfiguration}
413
422
  # for more details.
@@ -419,7 +428,7 @@ module WhopSDK
419
428
  #
420
429
  # @param enabled [Array<Symbol, WhopSDK::Models::PaymentMethodTypes>] An array of payment method identifiers that are explicitly enabled. This means t
421
430
  #
422
- # @param include_platform_defaults [Boolean] Whether Whop's platform default payment method enablement settings are included
431
+ # @param include_platform_defaults [Boolean, nil] Whether Whop's platform default payment method enablement settings are included
423
432
  end
424
433
  end
425
434
 
@@ -597,9 +606,9 @@ module WhopSDK
597
606
  required :product_id, String
598
607
 
599
608
  # @!attribute automatically_finalizes_at
600
- # The date and time when the invoice will be automatically finalized and charged.
601
- # Only valid when collection_method is charge_automatically. If not provided, the
602
- # charge will be processed immediately.
609
+ # The date and time when the invoice will be automatically finalized. For
610
+ # charge_automatically, triggers an automatic charge. For send_invoice, sends the
611
+ # invoice email to the customer at the specified time.
603
612
  #
604
613
  # @return [Time, nil]
605
614
  optional :automatically_finalizes_at, Time, nil?: true
@@ -686,7 +695,14 @@ module WhopSDK
686
695
  # @return [Boolean, nil]
687
696
  optional :save_as_draft, WhopSDK::Internal::Type::Boolean, nil?: true
688
697
 
689
- # @!method initialize(collection_method:, company_id:, plan:, product_id:, automatically_finalizes_at: nil, billing_address: nil, charge_buyer_fee: nil, customer_name: nil, due_date: nil, email_address: nil, line_items: nil, mailing_address_id: nil, member_id: nil, payment_method_id: nil, payment_token_id: nil, save_as_draft: nil)
698
+ # @!attribute subscription_billing_anchor_at
699
+ # The date that defines when the subscription billing cycle should start. When set
700
+ # on a renewal plan invoice, this anchors all future billing periods to this date.
701
+ #
702
+ # @return [Time, nil]
703
+ optional :subscription_billing_anchor_at, Time, nil?: true
704
+
705
+ # @!method initialize(collection_method:, company_id:, plan:, product_id:, automatically_finalizes_at: nil, billing_address: nil, charge_buyer_fee: nil, customer_name: nil, due_date: nil, email_address: nil, line_items: nil, mailing_address_id: nil, member_id: nil, payment_method_id: nil, payment_token_id: nil, save_as_draft: nil, subscription_billing_anchor_at: nil)
690
706
  # Some parameter documentations has been truncated, see
691
707
  # {WhopSDK::Models::InvoiceCreateParams::Body::CreateInvoiceInputWithProductID}
692
708
  # for more details.
@@ -701,7 +717,7 @@ module WhopSDK
701
717
  #
702
718
  # @param product_id [String] The unique identifier of an existing product to create this invoice for.
703
719
  #
704
- # @param automatically_finalizes_at [Time, nil] The date and time when the invoice will be automatically finalized and charged.
720
+ # @param automatically_finalizes_at [Time, nil] The date and time when the invoice will be automatically finalized. For charge_a
705
721
  #
706
722
  # @param billing_address [WhopSDK::Models::InvoiceCreateParams::Body::CreateInvoiceInputWithProductID::BillingAddress, nil] Inline billing address to create a new mailing address for this invoice. Cannot
707
723
  #
@@ -725,6 +741,8 @@ module WhopSDK
725
741
  # @param payment_token_id [String, nil] The payment token ID to use for this invoice. If using charge_automatically, you
726
742
  #
727
743
  # @param save_as_draft [Boolean, nil] When true, creates the invoice as a draft without sending or charging. Relaxes c
744
+ #
745
+ # @param subscription_billing_anchor_at [Time, nil] The date that defines when the subscription billing cycle should start. When set
728
746
 
729
747
  # @see WhopSDK::Models::InvoiceCreateParams::Body::CreateInvoiceInputWithProductID#plan
730
748
  class Plan < WhopSDK::Internal::Type::BaseModel
@@ -944,10 +962,10 @@ module WhopSDK
944
962
  # in this configuration. The full list of default payment methods can be found in
945
963
  # the documentation at docs.whop.com/payments.
946
964
  #
947
- # @return [Boolean]
948
- required :include_platform_defaults, WhopSDK::Internal::Type::Boolean
965
+ # @return [Boolean, nil]
966
+ optional :include_platform_defaults, WhopSDK::Internal::Type::Boolean, nil?: true
949
967
 
950
- # @!method initialize(disabled:, enabled:, include_platform_defaults:)
968
+ # @!method initialize(disabled:, enabled:, include_platform_defaults: nil)
951
969
  # Some parameter documentations has been truncated, see
952
970
  # {WhopSDK::Models::InvoiceCreateParams::Body::CreateInvoiceInputWithProductID::Plan::PaymentMethodConfiguration}
953
971
  # for more details.
@@ -959,7 +977,7 @@ module WhopSDK
959
977
  #
960
978
  # @param enabled [Array<Symbol, WhopSDK::Models::PaymentMethodTypes>] An array of payment method identifiers that are explicitly enabled. This means t
961
979
  #
962
- # @param include_platform_defaults [Boolean] Whether Whop's platform default payment method enablement settings are included
980
+ # @param include_platform_defaults [Boolean, nil] Whether Whop's platform default payment method enablement settings are included
963
981
  end
964
982
  end
965
983
 
@@ -13,7 +13,9 @@ module WhopSDK
13
13
  required :id, String
14
14
 
15
15
  # @!attribute automatically_finalizes_at
16
- # The date and time when the invoice will be automatically finalized and charged.
16
+ # The date and time when the invoice will be automatically finalized. For
17
+ # charge_automatically, triggers an automatic charge. For send_invoice, sends the
18
+ # invoice email at the specified time.
17
19
  #
18
20
  # @return [Time, nil]
19
21
  optional :automatically_finalizes_at, Time, nil?: true
@@ -86,10 +88,26 @@ module WhopSDK
86
88
  # @return [WhopSDK::Models::InvoiceUpdateParams::Plan, nil]
87
89
  optional :plan, -> { WhopSDK::InvoiceUpdateParams::Plan }, nil?: true
88
90
 
89
- # @!method initialize(id:, automatically_finalizes_at: nil, billing_address: nil, charge_buyer_fee: nil, collection_method: nil, customer_name: nil, due_date: nil, email_address: nil, line_items: nil, mailing_address_id: nil, member_id: nil, payment_method_id: nil, plan: nil, request_options: {})
91
+ # @!attribute product_id
92
+ # The unique identifier of an existing product to attach to this invoice. Only
93
+ # allowed while the invoice is still a draft.
94
+ #
95
+ # @return [String, nil]
96
+ optional :product_id, String, nil?: true
97
+
98
+ # @!attribute subscription_billing_anchor_at
99
+ # The date that defines when the subscription billing cycle should start.
100
+ #
101
+ # @return [Time, nil]
102
+ optional :subscription_billing_anchor_at, Time, nil?: true
103
+
104
+ # @!method initialize(id:, automatically_finalizes_at: nil, billing_address: nil, charge_buyer_fee: nil, collection_method: nil, customer_name: nil, due_date: nil, email_address: nil, line_items: nil, mailing_address_id: nil, member_id: nil, payment_method_id: nil, plan: nil, product_id: nil, subscription_billing_anchor_at: nil, request_options: {})
105
+ # Some parameter documentations has been truncated, see
106
+ # {WhopSDK::Models::InvoiceUpdateParams} for more details.
107
+ #
90
108
  # @param id [String]
91
109
  #
92
- # @param automatically_finalizes_at [Time, nil] The date and time when the invoice will be automatically finalized and charged.
110
+ # @param automatically_finalizes_at [Time, nil] The date and time when the invoice will be automatically finalized. For charge_a
93
111
  #
94
112
  # @param billing_address [WhopSDK::Models::InvoiceUpdateParams::BillingAddress, nil] Inline billing address to create or update a mailing address for this invoice.
95
113
  #
@@ -113,6 +131,10 @@ module WhopSDK
113
131
  #
114
132
  # @param plan [WhopSDK::Models::InvoiceUpdateParams::Plan, nil] Updated plan attributes.
115
133
  #
134
+ # @param product_id [String, nil] The unique identifier of an existing product to attach to this invoice. Only all
135
+ #
136
+ # @param subscription_billing_anchor_at [Time, nil] The date that defines when the subscription billing cycle should start.
137
+ #
116
138
  # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
117
139
 
118
140
  class BillingAddress < WhopSDK::Internal::Type::BaseModel
@@ -445,10 +467,10 @@ module WhopSDK
445
467
  # in this configuration. The full list of default payment methods can be found in
446
468
  # the documentation at docs.whop.com/payments.
447
469
  #
448
- # @return [Boolean]
449
- required :include_platform_defaults, WhopSDK::Internal::Type::Boolean
470
+ # @return [Boolean, nil]
471
+ optional :include_platform_defaults, WhopSDK::Internal::Type::Boolean, nil?: true
450
472
 
451
- # @!method initialize(disabled:, enabled:, include_platform_defaults:)
473
+ # @!method initialize(disabled:, enabled:, include_platform_defaults: nil)
452
474
  # Some parameter documentations has been truncated, see
453
475
  # {WhopSDK::Models::InvoiceUpdateParams::Plan::PaymentMethodConfiguration} for
454
476
  # more details.
@@ -460,7 +482,7 @@ module WhopSDK
460
482
  #
461
483
  # @param enabled [Array<Symbol, WhopSDK::Models::PaymentMethodTypes>] An array of payment method identifiers that are explicitly enabled. This means t
462
484
  #
463
- # @param include_platform_defaults [Boolean] Whether Whop's platform default payment method enablement settings are included
485
+ # @param include_platform_defaults [Boolean, nil] Whether Whop's platform default payment method enablement settings are included
464
486
  end
465
487
  end
466
488
  end
@@ -412,7 +412,7 @@ module WhopSDK
412
412
  # @see WhopSDK::Models::LedgerAccountRetrieveResponse::PayoutAccountDetails#latest_verification
413
413
  class LatestVerification < WhopSDK::Internal::Type::BaseModel
414
414
  # @!attribute id
415
- # The unique identifier for the verification.
415
+ # The numeric id of the verification record.
416
416
  #
417
417
  # @return [String]
418
418
  required :id, String
@@ -443,7 +443,7 @@ module WhopSDK
443
443
  #
444
444
  # The latest verification for the connected account.
445
445
  #
446
- # @param id [String] The unique identifier for the verification.
446
+ # @param id [String] The numeric id of the verification record.
447
447
  #
448
448
  # @param last_error_code [Symbol, WhopSDK::Models::VerificationErrorCode, nil] An error code for a verification attempt.
449
449
  #
@@ -37,6 +37,14 @@ module WhopSDK
37
37
  # @return [String, nil]
38
38
  required :cancellation_reason, String, nil?: true
39
39
 
40
+ # @!attribute checkout_configuration_id
41
+ # The ID of the checkout session/configuration that produced this membership, if
42
+ # any. Use this to map memberships back to the checkout configuration that created
43
+ # them.
44
+ #
45
+ # @return [String, nil]
46
+ required :checkout_configuration_id, String, nil?: true
47
+
40
48
  # @!attribute company
41
49
  # The company this membership belongs to.
42
50
  #
@@ -157,7 +165,7 @@ module WhopSDK
157
165
  # @return [WhopSDK::Models::Membership::User, nil]
158
166
  required :user, -> { WhopSDK::Membership::User }, nil?: true
159
167
 
160
- # @!method initialize(id:, cancel_at_period_end:, cancel_option:, canceled_at:, cancellation_reason:, company:, created_at:, currency:, custom_field_responses:, joined_at:, license_key:, manage_url:, member:, metadata:, payment_collection_paused:, plan:, product:, promo_code:, renewal_period_end:, renewal_period_start:, status:, updated_at:, user:)
168
+ # @!method initialize(id:, cancel_at_period_end:, cancel_option:, canceled_at:, cancellation_reason:, checkout_configuration_id:, company:, created_at:, currency:, custom_field_responses:, joined_at:, license_key:, manage_url:, member:, metadata:, payment_collection_paused:, plan:, product:, promo_code:, renewal_period_end:, renewal_period_start:, status:, updated_at:, user:)
161
169
  # Some parameter documentations has been truncated, see
162
170
  # {WhopSDK::Models::Membership} for more details.
163
171
  #
@@ -174,6 +182,8 @@ module WhopSDK
174
182
  #
175
183
  # @param cancellation_reason [String, nil] Free-text explanation provided by the customer when canceling. Null if the custo
176
184
  #
185
+ # @param checkout_configuration_id [String, nil] The ID of the checkout session/configuration that produced this membership, if a
186
+ #
177
187
  # @param company [WhopSDK::Models::Membership::Company] The company this membership belongs to.
178
188
  #
179
189
  # @param created_at [Time] The datetime the membership was created.
@@ -38,6 +38,14 @@ module WhopSDK
38
38
  # @return [String, nil]
39
39
  required :cancellation_reason, String, nil?: true
40
40
 
41
+ # @!attribute checkout_configuration_id
42
+ # The ID of the checkout session/configuration that produced this membership, if
43
+ # any. Use this to map memberships back to the checkout configuration that created
44
+ # them.
45
+ #
46
+ # @return [String, nil]
47
+ required :checkout_configuration_id, String, nil?: true
48
+
41
49
  # @!attribute company
42
50
  # The company this membership belongs to.
43
51
  #
@@ -150,7 +158,7 @@ module WhopSDK
150
158
  # @return [WhopSDK::Models::MembershipListResponse::User, nil]
151
159
  required :user, -> { WhopSDK::Models::MembershipListResponse::User }, nil?: true
152
160
 
153
- # @!method initialize(id:, cancel_at_period_end:, cancel_option:, canceled_at:, cancellation_reason:, company:, created_at:, currency:, joined_at:, license_key:, manage_url:, member:, metadata:, payment_collection_paused:, plan:, product:, promo_code:, renewal_period_end:, renewal_period_start:, status:, updated_at:, user:)
161
+ # @!method initialize(id:, cancel_at_period_end:, cancel_option:, canceled_at:, cancellation_reason:, checkout_configuration_id:, company:, created_at:, currency:, joined_at:, license_key:, manage_url:, member:, metadata:, payment_collection_paused:, plan:, product:, promo_code:, renewal_period_end:, renewal_period_start:, status:, updated_at:, user:)
154
162
  # Some parameter documentations has been truncated, see
155
163
  # {WhopSDK::Models::MembershipListResponse} for more details.
156
164
  #
@@ -167,6 +175,8 @@ module WhopSDK
167
175
  #
168
176
  # @param cancellation_reason [String, nil] Free-text explanation provided by the customer when canceling. Null if the custo
169
177
  #
178
+ # @param checkout_configuration_id [String, nil] The ID of the checkout session/configuration that produced this membership, if a
179
+ #
170
180
  # @param company [WhopSDK::Models::MembershipListResponse::Company] The company this membership belongs to.
171
181
  #
172
182
  # @param created_at [Time] The datetime the membership was created.
@@ -52,6 +52,13 @@ module WhopSDK
52
52
  # @return [String, nil]
53
53
  required :card_last4, String, nil?: true
54
54
 
55
+ # @!attribute checkout_configuration_id
56
+ # The ID of the checkout session/configuration that produced this payment, if any.
57
+ # Use this to map payments back to the checkout configuration that created them.
58
+ #
59
+ # @return [String, nil]
60
+ required :checkout_configuration_id, String, nil?: true
61
+
55
62
  # @!attribute company
56
63
  # The company for the payment.
57
64
  #
@@ -214,6 +221,28 @@ module WhopSDK
214
221
  # @return [Boolean]
215
222
  required :retryable, WhopSDK::Internal::Type::Boolean
216
223
 
224
+ # @!attribute settlement_amount
225
+ # The payment amount in the creator's settlement currency (what the creator priced
226
+ # in). Equal to final_amount for single-currency payments.
227
+ #
228
+ # @return [Float]
229
+ required :settlement_amount, Float
230
+
231
+ # @!attribute settlement_currency
232
+ # The currency in which the creator receives payouts and fees are charged (e.g.,
233
+ # 'usd', 'eur'). For multi-currency payments this differs from the payment
234
+ # currency.
235
+ #
236
+ # @return [String]
237
+ required :settlement_currency, String
238
+
239
+ # @!attribute settlement_exchange_rate
240
+ # The locked exchange rate used to convert from the buyer's payment currency to
241
+ # the creator's settlement currency. Null for single-currency payments.
242
+ #
243
+ # @return [Float, nil]
244
+ required :settlement_exchange_rate, Float, nil?: true
245
+
217
246
  # @!attribute status
218
247
  # The status of a receipt
219
248
  #
@@ -282,7 +311,7 @@ module WhopSDK
282
311
  # @return [Boolean]
283
312
  required :voidable, WhopSDK::Internal::Type::Boolean
284
313
 
285
- # @!method initialize(id:, amount_after_fees:, application_fee:, auto_refunded:, billing_address:, billing_reason:, card_brand:, card_last4:, company:, created_at:, currency:, dispute_alerted_at:, disputes:, failure_message:, financing_installments_count:, financing_transactions:, 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:, resolutions:, retryable:, status:, substatus:, subtotal:, tax_amount:, tax_behavior:, tax_refunded_amount:, total:, updated_at:, usd_total:, user:, voidable:)
314
+ # @!method initialize(id:, amount_after_fees:, application_fee:, auto_refunded:, billing_address:, billing_reason:, card_brand:, card_last4:, checkout_configuration_id:, company:, created_at:, currency:, dispute_alerted_at:, disputes:, failure_message:, financing_installments_count:, financing_transactions:, 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:, resolutions:, retryable:, settlement_amount:, settlement_currency:, settlement_exchange_rate:, status:, substatus:, subtotal:, tax_amount:, tax_behavior:, tax_refunded_amount:, total:, updated_at:, usd_total:, user:, voidable:)
286
315
  # Some parameter documentations has been truncated, see {WhopSDK::Models::Payment}
287
316
  # for more details.
288
317
  #
@@ -305,6 +334,8 @@ module WhopSDK
305
334
  #
306
335
  # @param card_last4 [String, nil] The last four digits of the card used to make this payment. Null if the payment
307
336
  #
337
+ # @param checkout_configuration_id [String, nil] The ID of the checkout session/configuration that produced this payment, if any.
338
+ #
308
339
  # @param company [WhopSDK::Models::Payment::Company, nil] The company for the payment.
309
340
  #
310
341
  # @param created_at [Time] The datetime the payment was created.
@@ -355,6 +386,12 @@ module WhopSDK
355
386
  #
356
387
  # @param retryable [Boolean] True when the payment status is `open` and its membership is in one of the retry
357
388
  #
389
+ # @param settlement_amount [Float] The payment amount in the creator's settlement currency (what the creator priced
390
+ #
391
+ # @param settlement_currency [String] The currency in which the creator receives payouts and fees are charged (e.g., '
392
+ #
393
+ # @param settlement_exchange_rate [Float, nil] The locked exchange rate used to convert from the buyer's payment currency to th
394
+ #
358
395
  # @param status [Symbol, WhopSDK::Models::ReceiptStatus, nil] The status of a receipt
359
396
  #
360
397
  # @param substatus [Symbol, WhopSDK::Models::FriendlyReceiptStatus] The friendly status of the payment.
@@ -826,10 +863,18 @@ module WhopSDK
826
863
  # @return [String]
827
864
  required :id, String
828
865
 
829
- # @!method initialize(id:)
866
+ # @!attribute internal_notes
867
+ # A personal description or notes section for the business.
868
+ #
869
+ # @return [String, nil]
870
+ required :internal_notes, String, nil?: true
871
+
872
+ # @!method initialize(id:, internal_notes:)
830
873
  # The plan attached to this payment.
831
874
  #
832
875
  # @param id [String] The unique identifier for the plan.
876
+ #
877
+ # @param internal_notes [String, nil] A personal description or notes section for the business.
833
878
  end
834
879
 
835
880
  # @see WhopSDK::Models::Payment#product
@@ -53,6 +53,13 @@ module WhopSDK
53
53
  # @return [String, nil]
54
54
  required :card_last4, String, nil?: true
55
55
 
56
+ # @!attribute checkout_configuration_id
57
+ # The ID of the checkout session/configuration that produced this payment, if any.
58
+ # Use this to map payments back to the checkout configuration that created them.
59
+ #
60
+ # @return [String, nil]
61
+ required :checkout_configuration_id, String, nil?: true
62
+
56
63
  # @!attribute company
57
64
  # The company for the payment.
58
65
  #
@@ -185,6 +192,14 @@ module WhopSDK
185
192
  # @return [Boolean]
186
193
  required :retryable, WhopSDK::Internal::Type::Boolean
187
194
 
195
+ # @!attribute settlement_currency
196
+ # The currency in which the creator receives payouts and fees are charged (e.g.,
197
+ # 'usd', 'eur'). For multi-currency payments this differs from the payment
198
+ # currency.
199
+ #
200
+ # @return [String]
201
+ required :settlement_currency, String
202
+
188
203
  # @!attribute status
189
204
  # The status of a receipt
190
205
  #
@@ -247,7 +262,7 @@ module WhopSDK
247
262
  # @return [Boolean]
248
263
  required :voidable, WhopSDK::Internal::Type::Boolean
249
264
 
250
- # @!method initialize(id:, amount_after_fees:, application_fee:, 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:, tax_amount:, tax_behavior:, total:, updated_at:, usd_total:, user:, voidable:)
265
+ # @!method initialize(id:, amount_after_fees:, application_fee:, auto_refunded:, billing_address:, billing_reason:, card_brand:, card_last4:, checkout_configuration_id:, 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:, settlement_currency:, status:, substatus:, subtotal:, tax_amount:, tax_behavior:, total:, updated_at:, usd_total:, user:, voidable:)
251
266
  # Some parameter documentations has been truncated, see
252
267
  # {WhopSDK::Models::PaymentListResponse} for more details.
253
268
  #
@@ -270,6 +285,8 @@ module WhopSDK
270
285
  #
271
286
  # @param card_last4 [String, nil] The last four digits of the card used to make this payment. Null if the payment
272
287
  #
288
+ # @param checkout_configuration_id [String, nil] The ID of the checkout session/configuration that produced this payment, if any.
289
+ #
273
290
  # @param company [WhopSDK::Models::PaymentListResponse::Company, nil] The company for the payment.
274
291
  #
275
292
  # @param created_at [Time] The datetime the payment was created.
@@ -312,6 +329,8 @@ module WhopSDK
312
329
  #
313
330
  # @param retryable [Boolean] True when the payment status is `open` and its membership is in one of the retry
314
331
  #
332
+ # @param settlement_currency [String] The currency in which the creator receives payouts and fees are charged (e.g., '
333
+ #
315
334
  # @param status [Symbol, WhopSDK::Models::ReceiptStatus, nil] The status of a receipt
316
335
  #
317
336
  # @param substatus [Symbol, WhopSDK::Models::FriendlyReceiptStatus] The friendly status of the payment.
@@ -614,10 +633,18 @@ module WhopSDK
614
633
  # @return [String]
615
634
  required :id, String
616
635
 
617
- # @!method initialize(id:)
636
+ # @!attribute internal_notes
637
+ # A personal description or notes section for the business.
638
+ #
639
+ # @return [String, nil]
640
+ required :internal_notes, String, nil?: true
641
+
642
+ # @!method initialize(id:, internal_notes:)
618
643
  # The plan attached to this payment.
619
644
  #
620
645
  # @param id [String] The unique identifier for the plan.
646
+ #
647
+ # @param internal_notes [String, nil] A personal description or notes section for the business.
621
648
  end
622
649
 
623
650
  # @see WhopSDK::Models::PaymentListResponse#product
@@ -14,6 +14,7 @@ module WhopSDK
14
14
  AMAZON_PAY = :amazon_pay
15
15
  APPLE = :apple
16
16
  APPLE_PAY = :apple_pay
17
+ AU_BANK_TRANSFER = :au_bank_transfer
17
18
  AU_BECS_DEBIT = :au_becs_debit
18
19
  BACS_DEBIT = :bacs_debit
19
20
  BANCOLOMBIA = :bancolombia
@@ -22,8 +23,13 @@ module WhopSDK
22
23
  BIZUM = :bizum
23
24
  BLIK = :blik
24
25
  BOLETO = :boleto
26
+ BRE_B = :bre_b
27
+ CA_BANK_TRANSFER = :ca_bank_transfer
25
28
  CAPCHASE_PAY = :capchase_pay
26
29
  CARD = :card
30
+ CARD_INSTALLMENTS_THREE = :card_installments_three
31
+ CARD_INSTALLMENTS_SIX = :card_installments_six
32
+ CARD_INSTALLMENTS_TWELVE = :card_installments_twelve
27
33
  CASHAPP = :cashapp
28
34
  CLARITYPAY = :claritypay
29
35
  COINBASE = :coinbase
@@ -35,6 +41,7 @@ module WhopSDK
35
41
  EPS = :eps
36
42
  EU_BANK_TRANSFER = :eu_bank_transfer
37
43
  FPX = :fpx
44
+ GB_BANK_TRANSFER = :gb_bank_transfer
38
45
  GIROPAY = :giropay
39
46
  GOOGLE_PAY = :google_pay
40
47
  GOPAY = :gopay
@@ -44,12 +51,15 @@ module WhopSDK
44
51
  INTERAC = :interac
45
52
  KAKAO_PAY = :kakao_pay
46
53
  KLARNA = :klarna
54
+ KLARNA_PAY_NOW = :klarna_pay_now
47
55
  KONBINI = :konbini
48
56
  KR_CARD = :kr_card
49
57
  KR_MARKET = :kr_market
50
58
  KRIYA = :kriya
59
+ KUESKI = :kueski
51
60
  LINK = :link
52
61
  MB_WAY = :mb_way
62
+ M_PESA = :m_pesa
53
63
  MERCADO_PAGO = :mercado_pago
54
64
  MOBILEPAY = :mobilepay
55
65
  MONDU = :mondu
@@ -66,6 +76,7 @@ module WhopSDK
66
76
  NZ_BANK_ACCOUNT = :nz_bank_account
67
77
  OXXO = :oxxo
68
78
  P24 = :p24
79
+ PAGO_EFECTIVO = :pago_efectivo
69
80
  PSE = :pse
70
81
  PAY_BY_BANK = :pay_by_bank
71
82
  PAYCO = :payco
@@ -82,8 +93,10 @@ module WhopSDK
82
93
  SAMSUNG_PAY = :samsung_pay
83
94
  SATISPAY = :satispay
84
95
  SCALAPAY = :scalapay
96
+ SENCILLITO = :sencillito
85
97
  SEPA_DEBIT = :sepa_debit
86
98
  SEQURA = :sequra
99
+ SERVIPAG = :servipag
87
100
  SEZZLE = :sezzle
88
101
  SHOP_PAY = :shop_pay
89
102
  SHOPEEPAY = :shopeepay
@@ -97,9 +110,12 @@ module WhopSDK
97
110
  TWINT = :twint
98
111
  UPI = :upi
99
112
  US_BANK_ACCOUNT = :us_bank_account
113
+ US_BANK_TRANSFER = :us_bank_transfer
100
114
  VENMO = :venmo
101
115
  VIPPS = :vipps
116
+ WEBPAY = :webpay
102
117
  WECHAT_PAY = :wechat_pay
118
+ YAPE = :yape
103
119
  ZIP = :zip
104
120
  COINFLOW = :coinflow
105
121
  UNKNOWN = :unknown
@@ -13,8 +13,9 @@ module WhopSDK
13
13
  required :id, String
14
14
 
15
15
  # @!attribute partial_amount
16
- # The amount to refund in the payment currency. If omitted, the full payment
17
- # amount is refunded.
16
+ # The amount to refund. For multi-currency payments, this is in the charge
17
+ # currency (what the buyer paid). For single-currency, this is in the payment
18
+ # currency. If omitted, the full payment amount is refunded.
18
19
  #
19
20
  # @return [Float, nil]
20
21
  optional :partial_amount, Float, nil?: true
@@ -25,7 +26,7 @@ module WhopSDK
25
26
  #
26
27
  # @param id [String]
27
28
  #
28
- # @param partial_amount [Float, nil] The amount to refund in the payment currency. If omitted, the full payment amoun
29
+ # @param partial_amount [Float, nil] The amount to refund. For multi-currency payments, this is in the charge currenc
29
30
  #
30
31
  # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
31
32
  end
@@ -179,7 +179,7 @@ module WhopSDK
179
179
  # @see WhopSDK::Models::PayoutAccountRetrieveResponse#latest_verification
180
180
  class LatestVerification < WhopSDK::Internal::Type::BaseModel
181
181
  # @!attribute id
182
- # The unique identifier for the verification.
182
+ # The numeric id of the verification record.
183
183
  #
184
184
  # @return [String]
185
185
  required :id, String
@@ -210,7 +210,7 @@ module WhopSDK
210
210
  #
211
211
  # The latest verification for the connected account.
212
212
  #
213
- # @param id [String] The unique identifier for the verification.
213
+ # @param id [String] The numeric id of the verification record.
214
214
  #
215
215
  # @param last_error_code [Symbol, WhopSDK::Models::VerificationErrorCode, nil] An error code for a verification attempt.
216
216
  #
@@ -230,7 +230,7 @@ module WhopSDK
230
230
  # @see WhopSDK::Models::PayoutAccountStatusUpdatedWebhookEvent::Data#latest_verification
231
231
  class LatestVerification < WhopSDK::Internal::Type::BaseModel
232
232
  # @!attribute id
233
- # The unique identifier for the verification.
233
+ # The numeric id of the verification record.
234
234
  #
235
235
  # @return [String]
236
236
  required :id, String
@@ -261,7 +261,7 @@ module WhopSDK
261
261
  #
262
262
  # The latest verification for the connected account.
263
263
  #
264
- # @param id [String] The unique identifier for the verification.
264
+ # @param id [String] The numeric id of the verification record.
265
265
  #
266
266
  # @param last_error_code [Symbol, WhopSDK::Models::VerificationErrorCode, nil] An error code for a verification attempt.
267
267
  #
@@ -9,6 +9,13 @@ module WhopSDK
9
9
  # @return [String]
10
10
  required :id, String
11
11
 
12
+ # @!attribute adaptive_pricing_enabled
13
+ # Whether the creator has turned on adaptive pricing for this plan. Raw setting —
14
+ # does not check processor compatibility or feature flags.
15
+ #
16
+ # @return [Boolean]
17
+ required :adaptive_pricing_enabled, WhopSDK::Internal::Type::Boolean
18
+
12
19
  # @!attribute billing_period
13
20
  # The number of days between each recurring charge. Null for one-time plans. For
14
21
  # example, 30 for monthly or 365 for annual billing.
@@ -51,7 +58,7 @@ module WhopSDK
51
58
  required :custom_fields, -> { WhopSDK::Internal::Type::ArrayOf[WhopSDK::Plan::CustomField] }
52
59
 
53
60
  # @!attribute description
54
- # A text description of the plan visible to customers. Maximum 500 characters.
61
+ # A text description of the plan visible to customers. Maximum 1000 characters.
55
62
  # Null if no description is set.
56
63
  #
57
64
  # @return [String, nil]
@@ -191,7 +198,7 @@ module WhopSDK
191
198
  # @return [Symbol, WhopSDK::Models::Visibility]
192
199
  required :visibility, enum: -> { WhopSDK::Visibility }
193
200
 
194
- # @!method initialize(id:, billing_period:, collect_tax:, company:, created_at:, currency:, custom_fields:, description:, expiration_days:, initial_price:, internal_notes:, invoice:, member_count:, payment_method_configuration:, plan_type:, product:, purchase_url:, release_method:, renewal_price:, split_pay_required_payments:, stock:, tax_type:, title:, trial_period_days:, unlimited_stock:, updated_at:, visibility:)
201
+ # @!method initialize(id:, adaptive_pricing_enabled:, billing_period:, collect_tax:, company:, created_at:, currency:, custom_fields:, description:, expiration_days:, initial_price:, internal_notes:, invoice:, member_count:, payment_method_configuration:, plan_type:, product:, purchase_url:, release_method:, renewal_price:, split_pay_required_payments:, stock:, tax_type:, title:, trial_period_days:, unlimited_stock:, updated_at:, visibility:)
195
202
  # Some parameter documentations has been truncated, see {WhopSDK::Models::Plan}
196
203
  # for more details.
197
204
  #
@@ -201,6 +208,8 @@ module WhopSDK
201
208
  #
202
209
  # @param id [String] The unique identifier for the plan.
203
210
  #
211
+ # @param adaptive_pricing_enabled [Boolean] Whether the creator has turned on adaptive pricing for this plan. Raw setting —
212
+ #
204
213
  # @param billing_period [Integer, nil] The number of days between each recurring charge. Null for one-time plans. For e
205
214
  #
206
215
  # @param collect_tax [Boolean] Whether tax is collected on purchases of this plan, based on the company's tax c
@@ -213,7 +222,7 @@ module WhopSDK
213
222
  #
214
223
  # @param custom_fields [Array<WhopSDK::Models::Plan::CustomField>] Custom input fields displayed on the checkout form that collect additional infor
215
224
  #
216
- # @param description [String, nil] A text description of the plan visible to customers. Maximum 500 characters. Nul
225
+ # @param description [String, nil] A text description of the plan visible to customers. Maximum 1000 characters. Nu
217
226
  #
218
227
  # @param expiration_days [Integer, nil] The number of days until the membership expires (for expiration-based plans). Fo
219
228
  #