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
@@ -19,6 +19,12 @@ module WhopSDK
19
19
  # @return [String]
20
20
  required :product_id, String
21
21
 
22
+ # @!attribute adaptive_pricing_enabled
23
+ # Whether this plan accepts local currency payments via adaptive pricing.
24
+ #
25
+ # @return [Boolean, nil]
26
+ optional :adaptive_pricing_enabled, WhopSDK::Internal::Type::Boolean, nil?: true
27
+
22
28
  # @!attribute billing_period
23
29
  # The number of days between recurring charges. For example, 30 for monthly or 365
24
30
  # for yearly.
@@ -159,7 +165,7 @@ module WhopSDK
159
165
  # @return [Symbol, WhopSDK::Models::Visibility, nil]
160
166
  optional :visibility, enum: -> { WhopSDK::Visibility }, nil?: true
161
167
 
162
- # @!method initialize(company_id:, product_id:, billing_period: nil, checkout_styling: nil, currency: nil, custom_fields: nil, description: nil, expiration_days: nil, image: nil, initial_price: nil, internal_notes: nil, legacy_payment_method_controls: nil, override_tax_type: nil, payment_method_configuration: nil, plan_type: nil, release_method: nil, renewal_price: nil, split_pay_required_payments: nil, stock: nil, title: nil, trial_period_days: nil, unlimited_stock: nil, visibility: nil, request_options: {})
168
+ # @!method initialize(company_id:, product_id:, adaptive_pricing_enabled: nil, billing_period: nil, checkout_styling: nil, currency: nil, custom_fields: nil, description: nil, expiration_days: nil, image: nil, initial_price: nil, internal_notes: nil, legacy_payment_method_controls: nil, override_tax_type: nil, payment_method_configuration: nil, plan_type: nil, release_method: nil, renewal_price: nil, split_pay_required_payments: nil, stock: nil, title: nil, trial_period_days: nil, unlimited_stock: nil, visibility: nil, request_options: {})
163
169
  # Some parameter documentations has been truncated, see
164
170
  # {WhopSDK::Models::PlanCreateParams} for more details.
165
171
  #
@@ -167,6 +173,8 @@ module WhopSDK
167
173
  #
168
174
  # @param product_id [String] The unique identifier of the product to attach this plan to.
169
175
  #
176
+ # @param adaptive_pricing_enabled [Boolean, nil] Whether this plan accepts local currency payments via adaptive pricing.
177
+ #
170
178
  # @param billing_period [Integer, nil] The number of days between recurring charges. For example, 30 for monthly or 365
171
179
  #
172
180
  # @param checkout_styling [WhopSDK::Models::PlanCreateParams::CheckoutStyling, nil] Checkout styling overrides for this plan. Pass null to inherit from the company
@@ -212,6 +220,13 @@ module WhopSDK
212
220
  # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
213
221
 
214
222
  class CheckoutStyling < WhopSDK::Internal::Type::BaseModel
223
+ # @!attribute background_color
224
+ # A hex color code for the checkout page background, applied to the order summary
225
+ # panel (e.g. #F4F4F5).
226
+ #
227
+ # @return [String, nil]
228
+ optional :background_color, String, nil?: true
229
+
215
230
  # @!attribute border_style
216
231
  # The different border-radius styles available for checkout pages.
217
232
  #
@@ -230,10 +245,15 @@ module WhopSDK
230
245
  # @return [Symbol, WhopSDK::Models::CheckoutFont, nil]
231
246
  optional :font_family, enum: -> { WhopSDK::CheckoutFont }, nil?: true
232
247
 
233
- # @!method initialize(border_style: nil, button_color: nil, font_family: nil)
248
+ # @!method initialize(background_color: nil, border_style: nil, button_color: nil, font_family: nil)
249
+ # Some parameter documentations has been truncated, see
250
+ # {WhopSDK::Models::PlanCreateParams::CheckoutStyling} for more details.
251
+ #
234
252
  # Checkout styling overrides for this plan. Pass null to inherit from the company
235
253
  # default.
236
254
  #
255
+ # @param background_color [String, nil] A hex color code for the checkout page background, applied to the order summary
256
+ #
237
257
  # @param border_style [Symbol, WhopSDK::Models::CheckoutShape, nil] The different border-radius styles available for checkout pages.
238
258
  #
239
259
  # @param button_color [String, nil] A hex color code for the button color (e.g. #FF5733).
@@ -327,10 +347,10 @@ module WhopSDK
327
347
  # in this configuration. The full list of default payment methods can be found in
328
348
  # the documentation at docs.whop.com/payments.
329
349
  #
330
- # @return [Boolean]
331
- required :include_platform_defaults, WhopSDK::Internal::Type::Boolean
350
+ # @return [Boolean, nil]
351
+ optional :include_platform_defaults, WhopSDK::Internal::Type::Boolean, nil?: true
332
352
 
333
- # @!method initialize(disabled:, enabled:, include_platform_defaults:)
353
+ # @!method initialize(disabled:, enabled:, include_platform_defaults: nil)
334
354
  # Some parameter documentations has been truncated, see
335
355
  # {WhopSDK::Models::PlanCreateParams::PaymentMethodConfiguration} for more
336
356
  # details.
@@ -342,7 +362,7 @@ module WhopSDK
342
362
  #
343
363
  # @param enabled [Array<Symbol, WhopSDK::Models::PaymentMethodTypes>] An array of payment method identifiers that are explicitly enabled. This means t
344
364
  #
345
- # @param include_platform_defaults [Boolean] Whether Whop's platform default payment method enablement settings are included
365
+ # @param include_platform_defaults [Boolean, nil] Whether Whop's platform default payment method enablement settings are included
346
366
  end
347
367
  end
348
368
  end
@@ -10,6 +10,13 @@ module WhopSDK
10
10
  # @return [String]
11
11
  required :id, String
12
12
 
13
+ # @!attribute adaptive_pricing_enabled
14
+ # Whether the creator has turned on adaptive pricing for this plan. Raw setting —
15
+ # does not check processor compatibility or feature flags.
16
+ #
17
+ # @return [Boolean]
18
+ required :adaptive_pricing_enabled, WhopSDK::Internal::Type::Boolean
19
+
13
20
  # @!attribute billing_period
14
21
  # The number of days between each recurring charge. Null for one-time plans. For
15
22
  # example, 30 for monthly or 365 for annual billing.
@@ -38,7 +45,7 @@ module WhopSDK
38
45
  required :currency, enum: -> { WhopSDK::Currency }
39
46
 
40
47
  # @!attribute description
41
- # A text description of the plan visible to customers. Maximum 500 characters.
48
+ # A text description of the plan visible to customers. Maximum 1000 characters.
42
49
  # Null if no description is set.
43
50
  #
44
51
  # @return [String, nil]
@@ -173,7 +180,7 @@ module WhopSDK
173
180
  # @return [Symbol, WhopSDK::Models::Visibility]
174
181
  required :visibility, enum: -> { WhopSDK::Visibility }
175
182
 
176
- # @!method initialize(id:, billing_period:, company:, created_at:, currency:, 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:, title:, trial_period_days:, unlimited_stock:, updated_at:, visibility:)
183
+ # @!method initialize(id:, adaptive_pricing_enabled:, billing_period:, company:, created_at:, currency:, 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:, title:, trial_period_days:, unlimited_stock:, updated_at:, visibility:)
177
184
  # Some parameter documentations has been truncated, see
178
185
  # {WhopSDK::Models::PlanListResponse} for more details.
179
186
  #
@@ -183,6 +190,8 @@ module WhopSDK
183
190
  #
184
191
  # @param id [String] The unique identifier for the plan.
185
192
  #
193
+ # @param adaptive_pricing_enabled [Boolean] Whether the creator has turned on adaptive pricing for this plan. Raw setting —
194
+ #
186
195
  # @param billing_period [Integer, nil] The number of days between each recurring charge. Null for one-time plans. For e
187
196
  #
188
197
  # @param company [WhopSDK::Models::PlanListResponse::Company, nil] The company that sells this plan. Null for standalone invoice plans not linked t
@@ -191,7 +200,7 @@ module WhopSDK
191
200
  #
192
201
  # @param currency [Symbol, WhopSDK::Models::Currency] The currency used for all prices on this plan (e.g., 'usd', 'eur'). All monetary
193
202
  #
194
- # @param description [String, nil] A text description of the plan visible to customers. Maximum 500 characters. Nul
203
+ # @param description [String, nil] A text description of the plan visible to customers. Maximum 1000 characters. Nu
195
204
  #
196
205
  # @param expiration_days [Integer, nil] The number of days until the membership expires (for expiration-based plans). Fo
197
206
  #
@@ -12,6 +12,12 @@ module WhopSDK
12
12
  # @return [String]
13
13
  required :id, String
14
14
 
15
+ # @!attribute adaptive_pricing_enabled
16
+ # Whether this plan accepts local currency payments via adaptive pricing.
17
+ #
18
+ # @return [Boolean, nil]
19
+ optional :adaptive_pricing_enabled, WhopSDK::Internal::Type::Boolean, nil?: true
20
+
15
21
  # @!attribute billing_period
16
22
  # The number of days between recurring charges. For example, 30 for monthly or 365
17
23
  # for yearly.
@@ -152,12 +158,14 @@ module WhopSDK
152
158
  # @return [Symbol, WhopSDK::Models::Visibility, nil]
153
159
  optional :visibility, enum: -> { WhopSDK::Visibility }, nil?: true
154
160
 
155
- # @!method initialize(id:, billing_period: nil, checkout_styling: nil, currency: nil, custom_fields: nil, description: nil, expiration_days: nil, image: nil, initial_price: nil, internal_notes: nil, legacy_payment_method_controls: nil, offer_cancel_discount: nil, override_tax_type: nil, payment_method_configuration: nil, renewal_price: nil, stock: nil, strike_through_initial_price: nil, strike_through_renewal_price: nil, title: nil, trial_period_days: nil, unlimited_stock: nil, visibility: nil, request_options: {})
161
+ # @!method initialize(id:, adaptive_pricing_enabled: nil, billing_period: nil, checkout_styling: nil, currency: nil, custom_fields: nil, description: nil, expiration_days: nil, image: nil, initial_price: nil, internal_notes: nil, legacy_payment_method_controls: nil, offer_cancel_discount: nil, override_tax_type: nil, payment_method_configuration: nil, renewal_price: nil, stock: nil, strike_through_initial_price: nil, strike_through_renewal_price: nil, title: nil, trial_period_days: nil, unlimited_stock: nil, visibility: nil, request_options: {})
156
162
  # Some parameter documentations has been truncated, see
157
163
  # {WhopSDK::Models::PlanUpdateParams} for more details.
158
164
  #
159
165
  # @param id [String]
160
166
  #
167
+ # @param adaptive_pricing_enabled [Boolean, nil] Whether this plan accepts local currency payments via adaptive pricing.
168
+ #
161
169
  # @param billing_period [Integer, nil] The number of days between recurring charges. For example, 30 for monthly or 365
162
170
  #
163
171
  # @param checkout_styling [WhopSDK::Models::PlanUpdateParams::CheckoutStyling, nil] Checkout styling overrides for this plan. Pass null to remove all overrides and
@@ -203,6 +211,13 @@ module WhopSDK
203
211
  # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
204
212
 
205
213
  class CheckoutStyling < WhopSDK::Internal::Type::BaseModel
214
+ # @!attribute background_color
215
+ # A hex color code for the checkout page background, applied to the order summary
216
+ # panel (e.g. #F4F4F5).
217
+ #
218
+ # @return [String, nil]
219
+ optional :background_color, String, nil?: true
220
+
206
221
  # @!attribute border_style
207
222
  # The different border-radius styles available for checkout pages.
208
223
  #
@@ -221,10 +236,15 @@ module WhopSDK
221
236
  # @return [Symbol, WhopSDK::Models::CheckoutFont, nil]
222
237
  optional :font_family, enum: -> { WhopSDK::CheckoutFont }, nil?: true
223
238
 
224
- # @!method initialize(border_style: nil, button_color: nil, font_family: nil)
239
+ # @!method initialize(background_color: nil, border_style: nil, button_color: nil, font_family: nil)
240
+ # Some parameter documentations has been truncated, see
241
+ # {WhopSDK::Models::PlanUpdateParams::CheckoutStyling} for more details.
242
+ #
225
243
  # Checkout styling overrides for this plan. Pass null to remove all overrides and
226
244
  # inherit from the company default.
227
245
  #
246
+ # @param background_color [String, nil] A hex color code for the checkout page background, applied to the order summary
247
+ #
228
248
  # @param border_style [Symbol, WhopSDK::Models::CheckoutShape, nil] The different border-radius styles available for checkout pages.
229
249
  #
230
250
  # @param button_color [String, nil] A hex color code for the button color (e.g. #FF5733).
@@ -318,10 +338,10 @@ module WhopSDK
318
338
  # in this configuration. The full list of default payment methods can be found in
319
339
  # the documentation at docs.whop.com/payments.
320
340
  #
321
- # @return [Boolean]
322
- required :include_platform_defaults, WhopSDK::Internal::Type::Boolean
341
+ # @return [Boolean, nil]
342
+ optional :include_platform_defaults, WhopSDK::Internal::Type::Boolean, nil?: true
323
343
 
324
- # @!method initialize(disabled:, enabled:, include_platform_defaults:)
344
+ # @!method initialize(disabled:, enabled:, include_platform_defaults: nil)
325
345
  # Some parameter documentations has been truncated, see
326
346
  # {WhopSDK::Models::PlanUpdateParams::PaymentMethodConfiguration} for more
327
347
  # details.
@@ -333,7 +353,7 @@ module WhopSDK
333
353
  #
334
354
  # @param enabled [Array<Symbol, WhopSDK::Models::PaymentMethodTypes>] An array of payment method identifiers that are explicitly enabled. This means t
335
355
  #
336
- # @param include_platform_defaults [Boolean] Whether Whop's platform default payment method enablement settings are included
356
+ # @param include_platform_defaults [Boolean, nil] Whether Whop's platform default payment method enablement settings are included
337
357
  end
338
358
  end
339
359
  end
@@ -7,12 +7,6 @@ module WhopSDK
7
7
  extend WhopSDK::Internal::Type::RequestParameters::Converter
8
8
  include WhopSDK::Internal::Type::RequestParameters
9
9
 
10
- # @!attribute company_id
11
- # The unique identifier of the company to list support channels for.
12
- #
13
- # @return [String]
14
- required :company_id, String
15
-
16
10
  # @!attribute after
17
11
  # Returns the elements in the list that come after the specified cursor.
18
12
  #
@@ -25,6 +19,14 @@ module WhopSDK
25
19
  # @return [String, nil]
26
20
  optional :before, String, nil?: true
27
21
 
22
+ # @!attribute company_id
23
+ # The unique identifier of the company to list support channels for. Includes
24
+ # channels of child companies. When omitted, returns support channels across all
25
+ # companies the user has access to.
26
+ #
27
+ # @return [String, nil]
28
+ optional :company_id, String, nil?: true
29
+
28
30
  # @!attribute direction
29
31
  # The direction of the sort.
30
32
  #
@@ -56,16 +58,22 @@ module WhopSDK
56
58
  # @return [Symbol, WhopSDK::Models::SupportChannelListParams::Order, nil]
57
59
  optional :order, enum: -> { WhopSDK::SupportChannelListParams::Order }, nil?: true
58
60
 
59
- # @!method initialize(company_id:, after: nil, before: nil, direction: nil, first: nil, last: nil, open_: nil, order: nil, request_options: {})
61
+ # @!attribute view
62
+ # The perspective to filter support channels by.
63
+ #
64
+ # @return [Symbol, WhopSDK::Models::SupportChannelListParams::View, nil]
65
+ optional :view, enum: -> { WhopSDK::SupportChannelListParams::View }, nil?: true
66
+
67
+ # @!method initialize(after: nil, before: nil, company_id: nil, direction: nil, first: nil, last: nil, open_: nil, order: nil, view: nil, request_options: {})
60
68
  # Some parameter documentations has been truncated, see
61
69
  # {WhopSDK::Models::SupportChannelListParams} for more details.
62
70
  #
63
- # @param company_id [String] The unique identifier of the company to list support channels for.
64
- #
65
71
  # @param after [String, nil] Returns the elements in the list that come after the specified cursor.
66
72
  #
67
73
  # @param before [String, nil] Returns the elements in the list that come before the specified cursor.
68
74
  #
75
+ # @param company_id [String, nil] The unique identifier of the company to list support channels for. Includes chan
76
+ #
69
77
  # @param direction [Symbol, WhopSDK::Models::Direction, nil] The direction of the sort.
70
78
  #
71
79
  # @param first [Integer, nil] Returns the first _n_ elements from the list.
@@ -76,6 +84,8 @@ module WhopSDK
76
84
  #
77
85
  # @param order [Symbol, WhopSDK::Models::SupportChannelListParams::Order, nil] Sort options for message channels
78
86
  #
87
+ # @param view [Symbol, WhopSDK::Models::SupportChannelListParams::View, nil] The perspective to filter support channels by.
88
+ #
79
89
  # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
80
90
 
81
91
  # Sort options for message channels
@@ -88,6 +98,18 @@ module WhopSDK
88
98
  # @!method self.values
89
99
  # @return [Array<Symbol>]
90
100
  end
101
+
102
+ # The perspective to filter support channels by.
103
+ module View
104
+ extend WhopSDK::Internal::Type::Enum
105
+
106
+ ALL = :all
107
+ ADMIN = :admin
108
+ CUSTOMER = :customer
109
+
110
+ # @!method self.values
111
+ # @return [Array<Symbol>]
112
+ end
91
113
  end
92
114
  end
93
115
  end
@@ -12,8 +12,21 @@ module WhopSDK
12
12
  # @return [String]
13
13
  required :id, String
14
14
 
15
- # @!method initialize(id:, request_options: {})
15
+ # @!attribute company_id
16
+ # When provided, returns the user's company-specific profile overrides (name,
17
+ # profile picture) instead of their global profile.
18
+ #
19
+ # @return [String, nil]
20
+ optional :company_id, String, nil?: true
21
+
22
+ # @!method initialize(id:, company_id: nil, request_options: {})
23
+ # Some parameter documentations has been truncated, see
24
+ # {WhopSDK::Models::UserRetrieveParams} for more details.
25
+ #
16
26
  # @param id [String]
27
+ #
28
+ # @param company_id [String, nil] When provided, returns the user's company-specific profile overrides (name, prof
29
+ #
17
30
  # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
18
31
  end
19
32
  end
@@ -2,17 +2,30 @@
2
2
 
3
3
  module WhopSDK
4
4
  module Models
5
- # @see WhopSDK::Resources::Users#update_profile
6
- class UserUpdateProfileParams < WhopSDK::Internal::Type::BaseModel
5
+ # @see WhopSDK::Resources::Users#update
6
+ class UserUpdateParams < WhopSDK::Internal::Type::BaseModel
7
7
  extend WhopSDK::Internal::Type::RequestParameters::Converter
8
8
  include WhopSDK::Internal::Type::RequestParameters
9
9
 
10
+ # @!attribute id
11
+ #
12
+ # @return [String]
13
+ required :id, String
14
+
10
15
  # @!attribute bio
11
16
  # A short biography displayed on the user's public profile.
12
17
  #
13
18
  # @return [String, nil]
14
19
  optional :bio, String, nil?: true
15
20
 
21
+ # @!attribute company_id
22
+ # When provided, updates the user's profile overrides for this company instead of
23
+ # the global profile. Pass name and profile_picture to set overrides, or null to
24
+ # clear them.
25
+ #
26
+ # @return [String, nil]
27
+ optional :company_id, String, nil?: true
28
+
16
29
  # @!attribute name
17
30
  # The user's display name shown on their public profile. Maximum 100 characters.
18
31
  #
@@ -22,8 +35,8 @@ module WhopSDK
22
35
  # @!attribute profile_picture
23
36
  # The user's profile picture image attachment.
24
37
  #
25
- # @return [WhopSDK::Models::UserUpdateProfileParams::ProfilePicture, nil]
26
- optional :profile_picture, -> { WhopSDK::UserUpdateProfileParams::ProfilePicture }, nil?: true
38
+ # @return [WhopSDK::Models::UserUpdateParams::ProfilePicture, nil]
39
+ optional :profile_picture, -> { WhopSDK::UserUpdateParams::ProfilePicture }, nil?: true
27
40
 
28
41
  # @!attribute username
29
42
  # The user's unique username. Alphanumeric characters and hyphens only. Maximum 42
@@ -32,15 +45,19 @@ module WhopSDK
32
45
  # @return [String, nil]
33
46
  optional :username, String, nil?: true
34
47
 
35
- # @!method initialize(bio: nil, name: nil, profile_picture: nil, username: nil, request_options: {})
48
+ # @!method initialize(id:, bio: nil, company_id: nil, name: nil, profile_picture: nil, username: nil, request_options: {})
36
49
  # Some parameter documentations has been truncated, see
37
- # {WhopSDK::Models::UserUpdateProfileParams} for more details.
50
+ # {WhopSDK::Models::UserUpdateParams} for more details.
51
+ #
52
+ # @param id [String]
38
53
  #
39
54
  # @param bio [String, nil] A short biography displayed on the user's public profile.
40
55
  #
56
+ # @param company_id [String, nil] When provided, updates the user's profile overrides for this company instead of
57
+ #
41
58
  # @param name [String, nil] The user's display name shown on their public profile. Maximum 100 characters.
42
59
  #
43
- # @param profile_picture [WhopSDK::Models::UserUpdateProfileParams::ProfilePicture, nil] The user's profile picture image attachment.
60
+ # @param profile_picture [WhopSDK::Models::UserUpdateParams::ProfilePicture, nil] The user's profile picture image attachment.
44
61
  #
45
62
  # @param username [String, nil] The user's unique username. Alphanumeric characters and hyphens only. Maximum 42
46
63
  #
@@ -5,7 +5,7 @@ module WhopSDK
5
5
  # @see WhopSDK::Resources::Verifications#list
6
6
  class VerificationListResponse < WhopSDK::Internal::Type::BaseModel
7
7
  # @!attribute id
8
- # The unique identifier for the verification.
8
+ # The numeric id of the verification record.
9
9
  #
10
10
  # @return [String]
11
11
  required :id, String
@@ -36,7 +36,7 @@ module WhopSDK
36
36
  # An identity verification session used to confirm a person or entity's identity
37
37
  # for payout account eligibility.
38
38
  #
39
- # @param id [String] The unique identifier for the verification.
39
+ # @param id [String] The numeric id of the verification record.
40
40
  #
41
41
  # @param last_error_code [Symbol, WhopSDK::Models::VerificationErrorCode, nil] An error code for a verification attempt.
42
42
  #
@@ -5,7 +5,7 @@ module WhopSDK
5
5
  # @see WhopSDK::Resources::Verifications#retrieve
6
6
  class VerificationRetrieveResponse < WhopSDK::Internal::Type::BaseModel
7
7
  # @!attribute id
8
- # The unique identifier for the verification.
8
+ # The numeric id of the verification record.
9
9
  #
10
10
  # @return [String]
11
11
  required :id, String
@@ -36,7 +36,7 @@ module WhopSDK
36
36
  # An identity verification session used to confirm a person or entity's identity
37
37
  # for payout account eligibility.
38
38
  #
39
- # @param id [String] The unique identifier for the verification.
39
+ # @param id [String] The numeric id of the verification record.
40
40
  #
41
41
  # @param last_error_code [Symbol, WhopSDK::Models::VerificationErrorCode, nil] An error code for a verification attempt.
42
42
  #
@@ -19,6 +19,7 @@ module WhopSDK
19
19
  EXPIRED = :expired
20
20
  ABANDONED = :abandoned
21
21
  REVIEW = :review
22
+ ACTION_REQUIRED = :action_required
22
23
 
23
24
  # @!method self.values
24
25
  # @return [Array<Symbol>]
@@ -59,7 +59,7 @@ module WhopSDK
59
59
  # @see WhopSDK::Models::VerificationSucceededWebhookEvent#data
60
60
  class Data < WhopSDK::Internal::Type::BaseModel
61
61
  # @!attribute id
62
- # The unique identifier for the verification.
62
+ # The numeric id of the verification record.
63
63
  #
64
64
  # @return [String]
65
65
  required :id, String
@@ -90,7 +90,7 @@ module WhopSDK
90
90
  # An identity verification session used to confirm a person or entity's identity
91
91
  # for payout account eligibility.
92
92
  #
93
- # @param id [String] The unique identifier for the verification.
93
+ # @param id [String] The numeric id of the verification record.
94
94
  #
95
95
  # @param last_error_code [Symbol, WhopSDK::Models::VerificationErrorCode, nil] An error code for a verification attempt.
96
96
  #
@@ -47,6 +47,30 @@ module WhopSDK
47
47
 
48
48
  AccountLinkCreateParams = WhopSDK::Models::AccountLinkCreateParams
49
49
 
50
+ AdCampaignListParams = WhopSDK::Models::AdCampaignListParams
51
+
52
+ AdCampaignPauseParams = WhopSDK::Models::AdCampaignPauseParams
53
+
54
+ AdCampaignRetrieveParams = WhopSDK::Models::AdCampaignRetrieveParams
55
+
56
+ AdCampaignUnpauseParams = WhopSDK::Models::AdCampaignUnpauseParams
57
+
58
+ AdCampaignUpdateParams = WhopSDK::Models::AdCampaignUpdateParams
59
+
60
+ AdGroupDeleteParams = WhopSDK::Models::AdGroupDeleteParams
61
+
62
+ AdGroupListParams = WhopSDK::Models::AdGroupListParams
63
+
64
+ AdGroupRetrieveParams = WhopSDK::Models::AdGroupRetrieveParams
65
+
66
+ AdGroupUpdateParams = WhopSDK::Models::AdGroupUpdateParams
67
+
68
+ AdListParams = WhopSDK::Models::AdListParams
69
+
70
+ AdReportRetrieveParams = WhopSDK::Models::AdReportRetrieveParams
71
+
72
+ AdRetrieveParams = WhopSDK::Models::AdRetrieveParams
73
+
50
74
  Affiliate = WhopSDK::Models::Affiliate
51
75
 
52
76
  AffiliateArchiveParams = WhopSDK::Models::AffiliateArchiveParams
@@ -121,6 +145,12 @@ module WhopSDK
121
145
 
122
146
  BillingReasons = WhopSDK::Models::BillingReasons
123
147
 
148
+ BountyCreateParams = WhopSDK::Models::BountyCreateParams
149
+
150
+ BountyListParams = WhopSDK::Models::BountyListParams
151
+
152
+ BountyRetrieveParams = WhopSDK::Models::BountyRetrieveParams
153
+
124
154
  CancelOptions = WhopSDK::Models::CancelOptions
125
155
 
126
156
  CardBrands = WhopSDK::Models::CardBrands
@@ -151,6 +181,8 @@ module WhopSDK
151
181
 
152
182
  Company = WhopSDK::Models::Company
153
183
 
184
+ CompanyCreateAPIKeyParams = WhopSDK::Models::CompanyCreateAPIKeyParams
185
+
154
186
  CompanyCreateParams = WhopSDK::Models::CompanyCreateParams
155
187
 
156
188
  CompanyListParams = WhopSDK::Models::CompanyListParams
@@ -169,6 +201,8 @@ module WhopSDK
169
201
 
170
202
  CompanyUpdateParams = WhopSDK::Models::CompanyUpdateParams
171
203
 
204
+ ConversionCreateParams = WhopSDK::Models::ConversionCreateParams
205
+
172
206
  Course = WhopSDK::Models::Course
173
207
 
174
208
  CourseChapter = WhopSDK::Models::CourseChapter
@@ -681,7 +715,7 @@ module WhopSDK
681
715
 
682
716
  UserRetrieveParams = WhopSDK::Models::UserRetrieveParams
683
717
 
684
- UserUpdateProfileParams = WhopSDK::Models::UserUpdateProfileParams
718
+ UserUpdateParams = WhopSDK::Models::UserUpdateParams
685
719
 
686
720
  VerificationErrorCode = WhopSDK::Models::VerificationErrorCode
687
721