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
@@ -0,0 +1,126 @@
1
+ # frozen_string_literal: true
2
+
3
+ module WhopSDK
4
+ module Models
5
+ # @see WhopSDK::Resources::Bounties#create
6
+ class BountyCreateResponse < WhopSDK::Internal::Type::BaseModel
7
+ # @!attribute id
8
+ # The unique identifier for the bounty.
9
+ #
10
+ # @return [String]
11
+ required :id, String
12
+
13
+ # @!attribute bounty_type
14
+ # The underlying bounty implementation type.
15
+ #
16
+ # @return [Symbol, WhopSDK::Models::BountyCreateResponse::BountyType]
17
+ required :bounty_type, enum: -> { WhopSDK::Models::BountyCreateResponse::BountyType }
18
+
19
+ # @!attribute created_at
20
+ # The datetime the bounty was created.
21
+ #
22
+ # @return [Time]
23
+ required :created_at, Time
24
+
25
+ # @!attribute currency
26
+ # The currency used for the bounty funds.
27
+ #
28
+ # @return [Symbol, WhopSDK::Models::Currency]
29
+ required :currency, enum: -> { WhopSDK::Currency }
30
+
31
+ # @!attribute description
32
+ # The description of the bounty.
33
+ #
34
+ # @return [String]
35
+ required :description, String
36
+
37
+ # @!attribute status
38
+ # The current lifecycle status of the bounty.
39
+ #
40
+ # @return [Symbol, WhopSDK::Models::BountyCreateResponse::Status]
41
+ required :status, enum: -> { WhopSDK::Models::BountyCreateResponse::Status }
42
+
43
+ # @!attribute title
44
+ # The title of the bounty.
45
+ #
46
+ # @return [String]
47
+ required :title, String
48
+
49
+ # @!attribute total_available
50
+ # The total amount currently funded in the bounty pool for payout.
51
+ #
52
+ # @return [Float]
53
+ required :total_available, Float
54
+
55
+ # @!attribute total_paid
56
+ # The total amount paid out for this bounty.
57
+ #
58
+ # @return [Float]
59
+ required :total_paid, Float
60
+
61
+ # @!attribute updated_at
62
+ # The datetime the bounty was last updated.
63
+ #
64
+ # @return [Time]
65
+ required :updated_at, Time
66
+
67
+ # @!attribute vote_threshold
68
+ # The number of watcher votes required before the submission can resolve.
69
+ #
70
+ # @return [Integer]
71
+ required :vote_threshold, Integer
72
+
73
+ # @!method initialize(id:, bounty_type:, created_at:, currency:, description:, status:, title:, total_available:, total_paid:, updated_at:, vote_threshold:)
74
+ # A privately accessible bounty.
75
+ #
76
+ # @param id [String] The unique identifier for the bounty.
77
+ #
78
+ # @param bounty_type [Symbol, WhopSDK::Models::BountyCreateResponse::BountyType] The underlying bounty implementation type.
79
+ #
80
+ # @param created_at [Time] The datetime the bounty was created.
81
+ #
82
+ # @param currency [Symbol, WhopSDK::Models::Currency] The currency used for the bounty funds.
83
+ #
84
+ # @param description [String] The description of the bounty.
85
+ #
86
+ # @param status [Symbol, WhopSDK::Models::BountyCreateResponse::Status] The current lifecycle status of the bounty.
87
+ #
88
+ # @param title [String] The title of the bounty.
89
+ #
90
+ # @param total_available [Float] The total amount currently funded in the bounty pool for payout.
91
+ #
92
+ # @param total_paid [Float] The total amount paid out for this bounty.
93
+ #
94
+ # @param updated_at [Time] The datetime the bounty was last updated.
95
+ #
96
+ # @param vote_threshold [Integer] The number of watcher votes required before the submission can resolve.
97
+
98
+ # The underlying bounty implementation type.
99
+ #
100
+ # @see WhopSDK::Models::BountyCreateResponse#bounty_type
101
+ module BountyType
102
+ extend WhopSDK::Internal::Type::Enum
103
+
104
+ CLASSIC = :classic
105
+ USER_FUNDED = :user_funded
106
+ WORKFORCE = :workforce
107
+
108
+ # @!method self.values
109
+ # @return [Array<Symbol>]
110
+ end
111
+
112
+ # The current lifecycle status of the bounty.
113
+ #
114
+ # @see WhopSDK::Models::BountyCreateResponse#status
115
+ module Status
116
+ extend WhopSDK::Internal::Type::Enum
117
+
118
+ PUBLISHED = :published
119
+ ARCHIVED = :archived
120
+
121
+ # @!method self.values
122
+ # @return [Array<Symbol>]
123
+ end
124
+ end
125
+ end
126
+ end
@@ -0,0 +1,85 @@
1
+ # frozen_string_literal: true
2
+
3
+ module WhopSDK
4
+ module Models
5
+ # @see WhopSDK::Resources::Bounties#list
6
+ class BountyListParams < WhopSDK::Internal::Type::BaseModel
7
+ extend WhopSDK::Internal::Type::RequestParameters::Converter
8
+ include WhopSDK::Internal::Type::RequestParameters
9
+
10
+ # @!attribute after
11
+ # Returns the elements in the list that come after the specified cursor.
12
+ #
13
+ # @return [String, nil]
14
+ optional :after, String, nil?: true
15
+
16
+ # @!attribute before
17
+ # Returns the elements in the list that come before the specified cursor.
18
+ #
19
+ # @return [String, nil]
20
+ optional :before, String, nil?: true
21
+
22
+ # @!attribute direction
23
+ # The direction of the sort.
24
+ #
25
+ # @return [Symbol, WhopSDK::Models::Direction, nil]
26
+ optional :direction, enum: -> { WhopSDK::Direction }, nil?: true
27
+
28
+ # @!attribute experience_id
29
+ # The experience to list bounties for. When omitted, returns bounties with no
30
+ # experience.
31
+ #
32
+ # @return [String, nil]
33
+ optional :experience_id, String, nil?: true
34
+
35
+ # @!attribute first
36
+ # Returns the first _n_ elements from the list.
37
+ #
38
+ # @return [Integer, nil]
39
+ optional :first, Integer, nil?: true
40
+
41
+ # @!attribute last
42
+ # Returns the last _n_ elements from the list.
43
+ #
44
+ # @return [Integer, nil]
45
+ optional :last, Integer, nil?: true
46
+
47
+ # @!attribute status
48
+ # The available bounty statuses to choose from.
49
+ #
50
+ # @return [Symbol, WhopSDK::Models::BountyListParams::Status, nil]
51
+ optional :status, enum: -> { WhopSDK::BountyListParams::Status }, nil?: true
52
+
53
+ # @!method initialize(after: nil, before: nil, direction: nil, experience_id: nil, first: nil, last: nil, status: nil, request_options: {})
54
+ # Some parameter documentations has been truncated, see
55
+ # {WhopSDK::Models::BountyListParams} for more details.
56
+ #
57
+ # @param after [String, nil] Returns the elements in the list that come after the specified cursor.
58
+ #
59
+ # @param before [String, nil] Returns the elements in the list that come before the specified cursor.
60
+ #
61
+ # @param direction [Symbol, WhopSDK::Models::Direction, nil] The direction of the sort.
62
+ #
63
+ # @param experience_id [String, nil] The experience to list bounties for. When omitted, returns bounties with no expe
64
+ #
65
+ # @param first [Integer, nil] Returns the first _n_ elements from the list.
66
+ #
67
+ # @param last [Integer, nil] Returns the last _n_ elements from the list.
68
+ #
69
+ # @param status [Symbol, WhopSDK::Models::BountyListParams::Status, nil] The available bounty statuses to choose from.
70
+ #
71
+ # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
72
+
73
+ # The available bounty statuses to choose from.
74
+ module Status
75
+ extend WhopSDK::Internal::Type::Enum
76
+
77
+ PUBLISHED = :published
78
+ ARCHIVED = :archived
79
+
80
+ # @!method self.values
81
+ # @return [Array<Symbol>]
82
+ end
83
+ end
84
+ end
85
+ end
@@ -0,0 +1,126 @@
1
+ # frozen_string_literal: true
2
+
3
+ module WhopSDK
4
+ module Models
5
+ # @see WhopSDK::Resources::Bounties#list
6
+ class BountyListResponse < WhopSDK::Internal::Type::BaseModel
7
+ # @!attribute id
8
+ # The unique identifier for the bounty.
9
+ #
10
+ # @return [String]
11
+ required :id, String
12
+
13
+ # @!attribute bounty_type
14
+ # The underlying bounty implementation type.
15
+ #
16
+ # @return [Symbol, WhopSDK::Models::BountyListResponse::BountyType]
17
+ required :bounty_type, enum: -> { WhopSDK::Models::BountyListResponse::BountyType }
18
+
19
+ # @!attribute created_at
20
+ # The datetime the bounty was created.
21
+ #
22
+ # @return [Time]
23
+ required :created_at, Time
24
+
25
+ # @!attribute currency
26
+ # The currency used for the bounty funds.
27
+ #
28
+ # @return [Symbol, WhopSDK::Models::Currency]
29
+ required :currency, enum: -> { WhopSDK::Currency }
30
+
31
+ # @!attribute description
32
+ # The description of the bounty.
33
+ #
34
+ # @return [String]
35
+ required :description, String
36
+
37
+ # @!attribute status
38
+ # The current lifecycle status of the bounty.
39
+ #
40
+ # @return [Symbol, WhopSDK::Models::BountyListResponse::Status]
41
+ required :status, enum: -> { WhopSDK::Models::BountyListResponse::Status }
42
+
43
+ # @!attribute title
44
+ # The title of the bounty.
45
+ #
46
+ # @return [String]
47
+ required :title, String
48
+
49
+ # @!attribute total_available
50
+ # The total amount currently funded in the bounty pool for payout.
51
+ #
52
+ # @return [Float]
53
+ required :total_available, Float
54
+
55
+ # @!attribute total_paid
56
+ # The total amount paid out for this bounty.
57
+ #
58
+ # @return [Float]
59
+ required :total_paid, Float
60
+
61
+ # @!attribute updated_at
62
+ # The datetime the bounty was last updated.
63
+ #
64
+ # @return [Time]
65
+ required :updated_at, Time
66
+
67
+ # @!attribute vote_threshold
68
+ # The number of watcher votes required before the submission can resolve.
69
+ #
70
+ # @return [Integer]
71
+ required :vote_threshold, Integer
72
+
73
+ # @!method initialize(id:, bounty_type:, created_at:, currency:, description:, status:, title:, total_available:, total_paid:, updated_at:, vote_threshold:)
74
+ # A privately accessible bounty.
75
+ #
76
+ # @param id [String] The unique identifier for the bounty.
77
+ #
78
+ # @param bounty_type [Symbol, WhopSDK::Models::BountyListResponse::BountyType] The underlying bounty implementation type.
79
+ #
80
+ # @param created_at [Time] The datetime the bounty was created.
81
+ #
82
+ # @param currency [Symbol, WhopSDK::Models::Currency] The currency used for the bounty funds.
83
+ #
84
+ # @param description [String] The description of the bounty.
85
+ #
86
+ # @param status [Symbol, WhopSDK::Models::BountyListResponse::Status] The current lifecycle status of the bounty.
87
+ #
88
+ # @param title [String] The title of the bounty.
89
+ #
90
+ # @param total_available [Float] The total amount currently funded in the bounty pool for payout.
91
+ #
92
+ # @param total_paid [Float] The total amount paid out for this bounty.
93
+ #
94
+ # @param updated_at [Time] The datetime the bounty was last updated.
95
+ #
96
+ # @param vote_threshold [Integer] The number of watcher votes required before the submission can resolve.
97
+
98
+ # The underlying bounty implementation type.
99
+ #
100
+ # @see WhopSDK::Models::BountyListResponse#bounty_type
101
+ module BountyType
102
+ extend WhopSDK::Internal::Type::Enum
103
+
104
+ CLASSIC = :classic
105
+ USER_FUNDED = :user_funded
106
+ WORKFORCE = :workforce
107
+
108
+ # @!method self.values
109
+ # @return [Array<Symbol>]
110
+ end
111
+
112
+ # The current lifecycle status of the bounty.
113
+ #
114
+ # @see WhopSDK::Models::BountyListResponse#status
115
+ module Status
116
+ extend WhopSDK::Internal::Type::Enum
117
+
118
+ PUBLISHED = :published
119
+ ARCHIVED = :archived
120
+
121
+ # @!method self.values
122
+ # @return [Array<Symbol>]
123
+ end
124
+ end
125
+ end
126
+ end
@@ -0,0 +1,20 @@
1
+ # frozen_string_literal: true
2
+
3
+ module WhopSDK
4
+ module Models
5
+ # @see WhopSDK::Resources::Bounties#retrieve
6
+ class BountyRetrieveParams < WhopSDK::Internal::Type::BaseModel
7
+ extend WhopSDK::Internal::Type::RequestParameters::Converter
8
+ include WhopSDK::Internal::Type::RequestParameters
9
+
10
+ # @!attribute id
11
+ #
12
+ # @return [String]
13
+ required :id, String
14
+
15
+ # @!method initialize(id:, request_options: {})
16
+ # @param id [String]
17
+ # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
18
+ end
19
+ end
20
+ end
@@ -0,0 +1,126 @@
1
+ # frozen_string_literal: true
2
+
3
+ module WhopSDK
4
+ module Models
5
+ # @see WhopSDK::Resources::Bounties#retrieve
6
+ class BountyRetrieveResponse < WhopSDK::Internal::Type::BaseModel
7
+ # @!attribute id
8
+ # The unique identifier for the bounty.
9
+ #
10
+ # @return [String]
11
+ required :id, String
12
+
13
+ # @!attribute bounty_type
14
+ # The underlying bounty implementation type.
15
+ #
16
+ # @return [Symbol, WhopSDK::Models::BountyRetrieveResponse::BountyType]
17
+ required :bounty_type, enum: -> { WhopSDK::Models::BountyRetrieveResponse::BountyType }
18
+
19
+ # @!attribute created_at
20
+ # The datetime the bounty was created.
21
+ #
22
+ # @return [Time]
23
+ required :created_at, Time
24
+
25
+ # @!attribute currency
26
+ # The currency used for the bounty funds.
27
+ #
28
+ # @return [Symbol, WhopSDK::Models::Currency]
29
+ required :currency, enum: -> { WhopSDK::Currency }
30
+
31
+ # @!attribute description
32
+ # The description of the bounty.
33
+ #
34
+ # @return [String]
35
+ required :description, String
36
+
37
+ # @!attribute status
38
+ # The current lifecycle status of the bounty.
39
+ #
40
+ # @return [Symbol, WhopSDK::Models::BountyRetrieveResponse::Status]
41
+ required :status, enum: -> { WhopSDK::Models::BountyRetrieveResponse::Status }
42
+
43
+ # @!attribute title
44
+ # The title of the bounty.
45
+ #
46
+ # @return [String]
47
+ required :title, String
48
+
49
+ # @!attribute total_available
50
+ # The total amount currently funded in the bounty pool for payout.
51
+ #
52
+ # @return [Float]
53
+ required :total_available, Float
54
+
55
+ # @!attribute total_paid
56
+ # The total amount paid out for this bounty.
57
+ #
58
+ # @return [Float]
59
+ required :total_paid, Float
60
+
61
+ # @!attribute updated_at
62
+ # The datetime the bounty was last updated.
63
+ #
64
+ # @return [Time]
65
+ required :updated_at, Time
66
+
67
+ # @!attribute vote_threshold
68
+ # The number of watcher votes required before the submission can resolve.
69
+ #
70
+ # @return [Integer]
71
+ required :vote_threshold, Integer
72
+
73
+ # @!method initialize(id:, bounty_type:, created_at:, currency:, description:, status:, title:, total_available:, total_paid:, updated_at:, vote_threshold:)
74
+ # A privately accessible bounty.
75
+ #
76
+ # @param id [String] The unique identifier for the bounty.
77
+ #
78
+ # @param bounty_type [Symbol, WhopSDK::Models::BountyRetrieveResponse::BountyType] The underlying bounty implementation type.
79
+ #
80
+ # @param created_at [Time] The datetime the bounty was created.
81
+ #
82
+ # @param currency [Symbol, WhopSDK::Models::Currency] The currency used for the bounty funds.
83
+ #
84
+ # @param description [String] The description of the bounty.
85
+ #
86
+ # @param status [Symbol, WhopSDK::Models::BountyRetrieveResponse::Status] The current lifecycle status of the bounty.
87
+ #
88
+ # @param title [String] The title of the bounty.
89
+ #
90
+ # @param total_available [Float] The total amount currently funded in the bounty pool for payout.
91
+ #
92
+ # @param total_paid [Float] The total amount paid out for this bounty.
93
+ #
94
+ # @param updated_at [Time] The datetime the bounty was last updated.
95
+ #
96
+ # @param vote_threshold [Integer] The number of watcher votes required before the submission can resolve.
97
+
98
+ # The underlying bounty implementation type.
99
+ #
100
+ # @see WhopSDK::Models::BountyRetrieveResponse#bounty_type
101
+ module BountyType
102
+ extend WhopSDK::Internal::Type::Enum
103
+
104
+ CLASSIC = :classic
105
+ USER_FUNDED = :user_funded
106
+ WORKFORCE = :workforce
107
+
108
+ # @!method self.values
109
+ # @return [Array<Symbol>]
110
+ end
111
+
112
+ # The current lifecycle status of the bounty.
113
+ #
114
+ # @see WhopSDK::Models::BountyRetrieveResponse#status
115
+ module Status
116
+ extend WhopSDK::Internal::Type::Enum
117
+
118
+ PUBLISHED = :published
119
+ ARCHIVED = :archived
120
+
121
+ # @!method self.values
122
+ # @return [Array<Symbol>]
123
+ end
124
+ end
125
+ end
126
+ end
@@ -15,6 +15,13 @@ module WhopSDK
15
15
  # @return [String, nil]
16
16
  required :affiliate_code, String, nil?: true
17
17
 
18
+ # @!attribute allow_promo_codes
19
+ # Whether the checkout configuration allows promo codes. When false, the promo
20
+ # code input is hidden and promo codes are rejected.
21
+ #
22
+ # @return [Boolean]
23
+ required :allow_promo_codes, WhopSDK::Internal::Type::Boolean
24
+
18
25
  # @!attribute company_id
19
26
  # The ID of the company to use for the checkout configuration
20
27
  #
@@ -68,7 +75,7 @@ module WhopSDK
68
75
  # @return [String, nil]
69
76
  required :redirect_url, String, nil?: true
70
77
 
71
- # @!method initialize(id:, affiliate_code:, company_id:, currency:, metadata:, mode:, payment_method_configuration:, plan:, purchase_url:, redirect_url:)
78
+ # @!method initialize(id:, affiliate_code:, allow_promo_codes:, company_id:, currency:, metadata:, mode:, payment_method_configuration:, plan:, purchase_url:, redirect_url:)
72
79
  # Some parameter documentations has been truncated, see
73
80
  # {WhopSDK::Models::CheckoutConfiguration} for more details.
74
81
  #
@@ -80,6 +87,8 @@ module WhopSDK
80
87
  #
81
88
  # @param affiliate_code [String, nil] The affiliate code to use for the checkout configuration
82
89
  #
90
+ # @param allow_promo_codes [Boolean] Whether the checkout configuration allows promo codes. When false, the promo cod
91
+ #
83
92
  # @param company_id [String] The ID of the company to use for the checkout configuration
84
93
  #
85
94
  # @param currency [Symbol, WhopSDK::Models::Currency, nil] The available currencies on the platform
@@ -146,6 +155,13 @@ module WhopSDK
146
155
  # @return [String]
147
156
  required :id, String
148
157
 
158
+ # @!attribute adaptive_pricing_enabled
159
+ # Whether the creator has turned on adaptive pricing for this plan. Raw setting —
160
+ # does not check processor compatibility or feature flags.
161
+ #
162
+ # @return [Boolean]
163
+ required :adaptive_pricing_enabled, WhopSDK::Internal::Type::Boolean
164
+
149
165
  # @!attribute billing_period
150
166
  # The number of days between each recurring charge. Null for one-time plans. For
151
167
  # example, 30 for monthly or 365 for annual billing.
@@ -211,7 +227,7 @@ module WhopSDK
211
227
  # @return [Symbol, WhopSDK::Models::Visibility]
212
228
  required :visibility, enum: -> { WhopSDK::Visibility }
213
229
 
214
- # @!method initialize(id:, billing_period:, currency:, expiration_days:, initial_price:, plan_type:, release_method:, renewal_price:, trial_period_days:, visibility:)
230
+ # @!method initialize(id:, adaptive_pricing_enabled:, billing_period:, currency:, expiration_days:, initial_price:, plan_type:, release_method:, renewal_price:, trial_period_days:, visibility:)
215
231
  # Some parameter documentations has been truncated, see
216
232
  # {WhopSDK::Models::CheckoutConfiguration::Plan} for more details.
217
233
  #
@@ -219,6 +235,8 @@ module WhopSDK
219
235
  #
220
236
  # @param id [String] The unique identifier for the plan.
221
237
  #
238
+ # @param adaptive_pricing_enabled [Boolean] Whether the creator has turned on adaptive pricing for this plan. Raw setting —
239
+ #
222
240
  # @param billing_period [Integer, nil] The number of days between each recurring charge. Null for one-time plans. For e
223
241
  #
224
242
  # @param currency [Symbol, WhopSDK::Models::Currency] The currency used for all prices on this plan (e.g., 'usd', 'eur'). All monetary