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
@@ -8,12 +8,54 @@ module WhopSDK
8
8
  sig do
9
9
  params(
10
10
  id: String,
11
+ company_id: T.nilable(String),
11
12
  request_options: WhopSDK::RequestOptions::OrHash
12
13
  ).returns(WhopSDK::User)
13
14
  end
14
15
  def retrieve(
15
16
  # The unique identifier or username of the user.
16
17
  id,
18
+ # When provided, returns the user's company-specific profile overrides (name,
19
+ # profile picture) instead of their global profile.
20
+ company_id: nil,
21
+ request_options: {}
22
+ )
23
+ end
24
+
25
+ # Update a user's profile by their ID.
26
+ #
27
+ # Required permissions:
28
+ #
29
+ # - `user:profile:update`
30
+ sig do
31
+ params(
32
+ id: String,
33
+ bio: T.nilable(String),
34
+ company_id: T.nilable(String),
35
+ name: T.nilable(String),
36
+ profile_picture:
37
+ T.nilable(WhopSDK::UserUpdateParams::ProfilePicture::OrHash),
38
+ username: T.nilable(String),
39
+ request_options: WhopSDK::RequestOptions::OrHash
40
+ ).returns(WhopSDK::User)
41
+ end
42
+ def update(
43
+ # The unique identifier of the user to update. Accepts 'me', a user tag, or a
44
+ # username.
45
+ id,
46
+ # A short biography displayed on the user's public profile.
47
+ bio: nil,
48
+ # When provided, updates the user's profile overrides for this company instead of
49
+ # the global profile. Pass name and profile_picture to set overrides, or null to
50
+ # clear them.
51
+ company_id: nil,
52
+ # The user's display name shown on their public profile. Maximum 100 characters.
53
+ name: nil,
54
+ # The user's profile picture image attachment.
55
+ profile_picture: nil,
56
+ # The user's unique username. Alphanumeric characters and hyphens only. Maximum 42
57
+ # characters.
58
+ username: nil,
17
59
  request_options: {}
18
60
  )
19
61
  end
@@ -66,35 +108,6 @@ module WhopSDK
66
108
  )
67
109
  end
68
110
 
69
- # Update the currently authenticated user's profile.
70
- #
71
- # Required permissions:
72
- #
73
- # - `user:profile:update`
74
- sig do
75
- params(
76
- bio: T.nilable(String),
77
- name: T.nilable(String),
78
- profile_picture:
79
- T.nilable(WhopSDK::UserUpdateProfileParams::ProfilePicture::OrHash),
80
- username: T.nilable(String),
81
- request_options: WhopSDK::RequestOptions::OrHash
82
- ).returns(WhopSDK::User)
83
- end
84
- def update_profile(
85
- # A short biography displayed on the user's public profile.
86
- bio: nil,
87
- # The user's display name shown on their public profile. Maximum 100 characters.
88
- name: nil,
89
- # The user's profile picture image attachment.
90
- profile_picture: nil,
91
- # The user's unique username. Alphanumeric characters and hyphens only. Maximum 42
92
- # characters.
93
- username: nil,
94
- request_options: {}
95
- )
96
- end
97
-
98
111
  # @api private
99
112
  sig { params(client: WhopSDK::Client).returns(T.attached_class) }
100
113
  def self.new(client:)
@@ -120,6 +120,18 @@ module WhopSDK
120
120
 
121
121
  attr_reader affiliates: WhopSDK::Resources::Affiliates
122
122
 
123
+ attr_reader bounties: WhopSDK::Resources::Bounties
124
+
125
+ attr_reader ad_campaigns: WhopSDK::Resources::AdCampaigns
126
+
127
+ attr_reader ad_groups: WhopSDK::Resources::AdGroups
128
+
129
+ attr_reader ads: WhopSDK::Resources::Ads
130
+
131
+ attr_reader conversions: WhopSDK::Resources::Conversions
132
+
133
+ attr_reader ad_reports: WhopSDK::Resources::AdReports
134
+
123
135
  private def auth_headers: -> ::Hash[String, String]
124
136
 
125
137
  def initialize: (
@@ -0,0 +1,82 @@
1
+ module WhopSDK
2
+ module Models
3
+ type ad_campaign_list_params =
4
+ {
5
+ company_id: String,
6
+ after: String?,
7
+ before: String?,
8
+ created_after: Time?,
9
+ created_before: Time?,
10
+ first: Integer?,
11
+ last: Integer?,
12
+ query: String?,
13
+ status: WhopSDK::Models::AdCampaignListParams::status?
14
+ }
15
+ & WhopSDK::Internal::Type::request_parameters
16
+
17
+ class AdCampaignListParams < WhopSDK::Internal::Type::BaseModel
18
+ extend WhopSDK::Internal::Type::RequestParameters::Converter
19
+ include WhopSDK::Internal::Type::RequestParameters
20
+
21
+ attr_accessor company_id: String
22
+
23
+ attr_accessor after: String?
24
+
25
+ attr_accessor before: String?
26
+
27
+ attr_accessor created_after: Time?
28
+
29
+ attr_accessor created_before: Time?
30
+
31
+ attr_accessor first: Integer?
32
+
33
+ attr_accessor last: Integer?
34
+
35
+ attr_accessor query: String?
36
+
37
+ attr_accessor status: WhopSDK::Models::AdCampaignListParams::status?
38
+
39
+ def initialize: (
40
+ company_id: String,
41
+ ?after: String?,
42
+ ?before: String?,
43
+ ?created_after: Time?,
44
+ ?created_before: Time?,
45
+ ?first: Integer?,
46
+ ?last: Integer?,
47
+ ?query: String?,
48
+ ?status: WhopSDK::Models::AdCampaignListParams::status?,
49
+ ?request_options: WhopSDK::request_opts
50
+ ) -> void
51
+
52
+ def to_hash: -> {
53
+ company_id: String,
54
+ after: String?,
55
+ before: String?,
56
+ created_after: Time?,
57
+ created_before: Time?,
58
+ first: Integer?,
59
+ last: Integer?,
60
+ query: String?,
61
+ status: WhopSDK::Models::AdCampaignListParams::status?,
62
+ request_options: WhopSDK::RequestOptions
63
+ }
64
+
65
+ type status =
66
+ :active | :paused | :payment_failed | :draft | :in_review | :flagged
67
+
68
+ module Status
69
+ extend WhopSDK::Internal::Type::Enum
70
+
71
+ ACTIVE: :active
72
+ PAUSED: :paused
73
+ PAYMENT_FAILED: :payment_failed
74
+ DRAFT: :draft
75
+ IN_REVIEW: :in_review
76
+ FLAGGED: :flagged
77
+
78
+ def self?.values: -> ::Array[WhopSDK::Models::AdCampaignListParams::status]
79
+ end
80
+ end
81
+ end
82
+ end
@@ -0,0 +1,98 @@
1
+ module WhopSDK
2
+ module Models
3
+ type ad_campaign_list_response =
4
+ {
5
+ id: String,
6
+ budget: Float?,
7
+ budget_type: WhopSDK::Models::AdCampaignListResponse::budget_type?,
8
+ created_at: Time,
9
+ platform: WhopSDK::Models::AdCampaignListResponse::platform,
10
+ status: WhopSDK::Models::AdCampaignListResponse::status,
11
+ title: String,
12
+ total_spend: Float,
13
+ updated_at: Time
14
+ }
15
+
16
+ class AdCampaignListResponse < WhopSDK::Internal::Type::BaseModel
17
+ attr_accessor id: String
18
+
19
+ attr_accessor budget: Float?
20
+
21
+ attr_accessor budget_type: WhopSDK::Models::AdCampaignListResponse::budget_type?
22
+
23
+ attr_accessor created_at: Time
24
+
25
+ attr_accessor platform: WhopSDK::Models::AdCampaignListResponse::platform
26
+
27
+ attr_accessor status: WhopSDK::Models::AdCampaignListResponse::status
28
+
29
+ attr_accessor title: String
30
+
31
+ attr_accessor total_spend: Float
32
+
33
+ attr_accessor updated_at: Time
34
+
35
+ def initialize: (
36
+ id: String,
37
+ budget: Float?,
38
+ budget_type: WhopSDK::Models::AdCampaignListResponse::budget_type?,
39
+ created_at: Time,
40
+ platform: WhopSDK::Models::AdCampaignListResponse::platform,
41
+ status: WhopSDK::Models::AdCampaignListResponse::status,
42
+ title: String,
43
+ total_spend: Float,
44
+ updated_at: Time
45
+ ) -> void
46
+
47
+ def to_hash: -> {
48
+ id: String,
49
+ budget: Float?,
50
+ budget_type: WhopSDK::Models::AdCampaignListResponse::budget_type?,
51
+ created_at: Time,
52
+ platform: WhopSDK::Models::AdCampaignListResponse::platform,
53
+ status: WhopSDK::Models::AdCampaignListResponse::status,
54
+ title: String,
55
+ total_spend: Float,
56
+ updated_at: Time
57
+ }
58
+
59
+ type budget_type = :daily | :lifetime
60
+
61
+ module BudgetType
62
+ extend WhopSDK::Internal::Type::Enum
63
+
64
+ DAILY: :daily
65
+ LIFETIME: :lifetime
66
+
67
+ def self?.values: -> ::Array[WhopSDK::Models::AdCampaignListResponse::budget_type]
68
+ end
69
+
70
+ type platform = :meta | :tiktok
71
+
72
+ module Platform
73
+ extend WhopSDK::Internal::Type::Enum
74
+
75
+ META: :meta
76
+ TIKTOK: :tiktok
77
+
78
+ def self?.values: -> ::Array[WhopSDK::Models::AdCampaignListResponse::platform]
79
+ end
80
+
81
+ type status =
82
+ :active | :paused | :payment_failed | :draft | :in_review | :flagged
83
+
84
+ module Status
85
+ extend WhopSDK::Internal::Type::Enum
86
+
87
+ ACTIVE: :active
88
+ PAUSED: :paused
89
+ PAYMENT_FAILED: :payment_failed
90
+ DRAFT: :draft
91
+ IN_REVIEW: :in_review
92
+ FLAGGED: :flagged
93
+
94
+ def self?.values: -> ::Array[WhopSDK::Models::AdCampaignListResponse::status]
95
+ end
96
+ end
97
+ end
98
+ end
@@ -0,0 +1,20 @@
1
+ module WhopSDK
2
+ module Models
3
+ type ad_campaign_pause_params =
4
+ { id: String } & WhopSDK::Internal::Type::request_parameters
5
+
6
+ class AdCampaignPauseParams < WhopSDK::Internal::Type::BaseModel
7
+ extend WhopSDK::Internal::Type::RequestParameters::Converter
8
+ include WhopSDK::Internal::Type::RequestParameters
9
+
10
+ attr_accessor id: String
11
+
12
+ def initialize: (
13
+ id: String,
14
+ ?request_options: WhopSDK::request_opts
15
+ ) -> void
16
+
17
+ def to_hash: -> { id: String, request_options: WhopSDK::RequestOptions }
18
+ end
19
+ end
20
+ end
@@ -0,0 +1,232 @@
1
+ module WhopSDK
2
+ module Models
3
+ type ad_campaign_pause_response =
4
+ {
5
+ id: String,
6
+ budget: Float?,
7
+ budget_type: WhopSDK::Models::AdCampaignPauseResponse::budget_type?,
8
+ created_at: Time,
9
+ created_by_user: WhopSDK::Models::AdCampaignPauseResponse::CreatedByUser,
10
+ meta_config: WhopSDK::Models::AdCampaignPauseResponse::MetaConfig?,
11
+ platform: WhopSDK::Models::AdCampaignPauseResponse::platform,
12
+ status: WhopSDK::Models::AdCampaignPauseResponse::status,
13
+ title: String,
14
+ total_spend: Float,
15
+ updated_at: Time
16
+ }
17
+
18
+ class AdCampaignPauseResponse < WhopSDK::Internal::Type::BaseModel
19
+ attr_accessor id: String
20
+
21
+ attr_accessor budget: Float?
22
+
23
+ attr_accessor budget_type: WhopSDK::Models::AdCampaignPauseResponse::budget_type?
24
+
25
+ attr_accessor created_at: Time
26
+
27
+ attr_accessor created_by_user: WhopSDK::Models::AdCampaignPauseResponse::CreatedByUser
28
+
29
+ attr_accessor meta_config: WhopSDK::Models::AdCampaignPauseResponse::MetaConfig?
30
+
31
+ attr_accessor platform: WhopSDK::Models::AdCampaignPauseResponse::platform
32
+
33
+ attr_accessor status: WhopSDK::Models::AdCampaignPauseResponse::status
34
+
35
+ attr_accessor title: String
36
+
37
+ attr_accessor total_spend: Float
38
+
39
+ attr_accessor updated_at: Time
40
+
41
+ def initialize: (
42
+ id: String,
43
+ budget: Float?,
44
+ budget_type: WhopSDK::Models::AdCampaignPauseResponse::budget_type?,
45
+ created_at: Time,
46
+ created_by_user: WhopSDK::Models::AdCampaignPauseResponse::CreatedByUser,
47
+ meta_config: WhopSDK::Models::AdCampaignPauseResponse::MetaConfig?,
48
+ platform: WhopSDK::Models::AdCampaignPauseResponse::platform,
49
+ status: WhopSDK::Models::AdCampaignPauseResponse::status,
50
+ title: String,
51
+ total_spend: Float,
52
+ updated_at: Time
53
+ ) -> void
54
+
55
+ def to_hash: -> {
56
+ id: String,
57
+ budget: Float?,
58
+ budget_type: WhopSDK::Models::AdCampaignPauseResponse::budget_type?,
59
+ created_at: Time,
60
+ created_by_user: WhopSDK::Models::AdCampaignPauseResponse::CreatedByUser,
61
+ meta_config: WhopSDK::Models::AdCampaignPauseResponse::MetaConfig?,
62
+ platform: WhopSDK::Models::AdCampaignPauseResponse::platform,
63
+ status: WhopSDK::Models::AdCampaignPauseResponse::status,
64
+ title: String,
65
+ total_spend: Float,
66
+ updated_at: Time
67
+ }
68
+
69
+ type budget_type = :daily | :lifetime
70
+
71
+ module BudgetType
72
+ extend WhopSDK::Internal::Type::Enum
73
+
74
+ DAILY: :daily
75
+ LIFETIME: :lifetime
76
+
77
+ def self?.values: -> ::Array[WhopSDK::Models::AdCampaignPauseResponse::budget_type]
78
+ end
79
+
80
+ type created_by_user = { id: String, name: String?, username: String }
81
+
82
+ class CreatedByUser < WhopSDK::Internal::Type::BaseModel
83
+ attr_accessor id: String
84
+
85
+ attr_accessor name: String?
86
+
87
+ attr_accessor username: String
88
+
89
+ def initialize: (id: String, name: String?, username: String) -> void
90
+
91
+ def to_hash: -> { id: String, name: String?, username: String }
92
+ end
93
+
94
+ type meta_config =
95
+ {
96
+ bid_amount: Integer?,
97
+ bid_strategy: WhopSDK::Models::AdCampaignPauseResponse::MetaConfig::bid_strategy?,
98
+ budget_optimization: bool?,
99
+ effective_status: WhopSDK::Models::AdCampaignPauseResponse::MetaConfig::effective_status?,
100
+ end_time: String?,
101
+ objective: WhopSDK::Models::AdCampaignPauseResponse::MetaConfig::objective?,
102
+ special_categories: ::Array[String]?,
103
+ start_time: String?,
104
+ status: WhopSDK::Models::AdCampaignPauseResponse::MetaConfig::status?
105
+ }
106
+
107
+ class MetaConfig < WhopSDK::Internal::Type::BaseModel
108
+ attr_accessor bid_amount: Integer?
109
+
110
+ attr_accessor bid_strategy: WhopSDK::Models::AdCampaignPauseResponse::MetaConfig::bid_strategy?
111
+
112
+ attr_accessor budget_optimization: bool?
113
+
114
+ attr_accessor effective_status: WhopSDK::Models::AdCampaignPauseResponse::MetaConfig::effective_status?
115
+
116
+ attr_accessor end_time: String?
117
+
118
+ attr_accessor objective: WhopSDK::Models::AdCampaignPauseResponse::MetaConfig::objective?
119
+
120
+ attr_accessor special_categories: ::Array[String]?
121
+
122
+ attr_accessor start_time: String?
123
+
124
+ attr_accessor status: WhopSDK::Models::AdCampaignPauseResponse::MetaConfig::status?
125
+
126
+ def initialize: (
127
+ bid_amount: Integer?,
128
+ bid_strategy: WhopSDK::Models::AdCampaignPauseResponse::MetaConfig::bid_strategy?,
129
+ budget_optimization: bool?,
130
+ effective_status: WhopSDK::Models::AdCampaignPauseResponse::MetaConfig::effective_status?,
131
+ end_time: String?,
132
+ objective: WhopSDK::Models::AdCampaignPauseResponse::MetaConfig::objective?,
133
+ special_categories: ::Array[String]?,
134
+ start_time: String?,
135
+ status: WhopSDK::Models::AdCampaignPauseResponse::MetaConfig::status?
136
+ ) -> void
137
+
138
+ def to_hash: -> {
139
+ bid_amount: Integer?,
140
+ bid_strategy: WhopSDK::Models::AdCampaignPauseResponse::MetaConfig::bid_strategy?,
141
+ budget_optimization: bool?,
142
+ effective_status: WhopSDK::Models::AdCampaignPauseResponse::MetaConfig::effective_status?,
143
+ end_time: String?,
144
+ objective: WhopSDK::Models::AdCampaignPauseResponse::MetaConfig::objective?,
145
+ special_categories: ::Array[String]?,
146
+ start_time: String?,
147
+ status: WhopSDK::Models::AdCampaignPauseResponse::MetaConfig::status?
148
+ }
149
+
150
+ type bid_strategy = :lowest_cost | :bid_cap | :cost_cap
151
+
152
+ module BidStrategy
153
+ extend WhopSDK::Internal::Type::Enum
154
+
155
+ LOWEST_COST: :lowest_cost
156
+ BID_CAP: :bid_cap
157
+ COST_CAP: :cost_cap
158
+
159
+ def self?.values: -> ::Array[WhopSDK::Models::AdCampaignPauseResponse::MetaConfig::bid_strategy]
160
+ end
161
+
162
+ type effective_status =
163
+ :active | :paused | :deleted | :in_review | :rejected | :with_issues
164
+
165
+ module EffectiveStatus
166
+ extend WhopSDK::Internal::Type::Enum
167
+
168
+ ACTIVE: :active
169
+ PAUSED: :paused
170
+ DELETED: :deleted
171
+ IN_REVIEW: :in_review
172
+ REJECTED: :rejected
173
+ WITH_ISSUES: :with_issues
174
+
175
+ def self?.values: -> ::Array[WhopSDK::Models::AdCampaignPauseResponse::MetaConfig::effective_status]
176
+ end
177
+
178
+ type objective = :awareness | :traffic | :engagement | :leads | :sales
179
+
180
+ module Objective
181
+ extend WhopSDK::Internal::Type::Enum
182
+
183
+ AWARENESS: :awareness
184
+ TRAFFIC: :traffic
185
+ ENGAGEMENT: :engagement
186
+ LEADS: :leads
187
+ SALES: :sales
188
+
189
+ def self?.values: -> ::Array[WhopSDK::Models::AdCampaignPauseResponse::MetaConfig::objective]
190
+ end
191
+
192
+ type status = :active | :paused
193
+
194
+ module Status
195
+ extend WhopSDK::Internal::Type::Enum
196
+
197
+ ACTIVE: :active
198
+ PAUSED: :paused
199
+
200
+ def self?.values: -> ::Array[WhopSDK::Models::AdCampaignPauseResponse::MetaConfig::status]
201
+ end
202
+ end
203
+
204
+ type platform = :meta | :tiktok
205
+
206
+ module Platform
207
+ extend WhopSDK::Internal::Type::Enum
208
+
209
+ META: :meta
210
+ TIKTOK: :tiktok
211
+
212
+ def self?.values: -> ::Array[WhopSDK::Models::AdCampaignPauseResponse::platform]
213
+ end
214
+
215
+ type status =
216
+ :active | :paused | :payment_failed | :draft | :in_review | :flagged
217
+
218
+ module Status
219
+ extend WhopSDK::Internal::Type::Enum
220
+
221
+ ACTIVE: :active
222
+ PAUSED: :paused
223
+ PAYMENT_FAILED: :payment_failed
224
+ DRAFT: :draft
225
+ IN_REVIEW: :in_review
226
+ FLAGGED: :flagged
227
+
228
+ def self?.values: -> ::Array[WhopSDK::Models::AdCampaignPauseResponse::status]
229
+ end
230
+ end
231
+ end
232
+ end
@@ -0,0 +1,20 @@
1
+ module WhopSDK
2
+ module Models
3
+ type ad_campaign_retrieve_params =
4
+ { id: String } & WhopSDK::Internal::Type::request_parameters
5
+
6
+ class AdCampaignRetrieveParams < WhopSDK::Internal::Type::BaseModel
7
+ extend WhopSDK::Internal::Type::RequestParameters::Converter
8
+ include WhopSDK::Internal::Type::RequestParameters
9
+
10
+ attr_accessor id: String
11
+
12
+ def initialize: (
13
+ id: String,
14
+ ?request_options: WhopSDK::request_opts
15
+ ) -> void
16
+
17
+ def to_hash: -> { id: String, request_options: WhopSDK::RequestOptions }
18
+ end
19
+ end
20
+ end