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,108 @@
1
+ module WhopSDK
2
+ module Models
3
+ type ad_group_update_response =
4
+ {
5
+ id: String,
6
+ ad_campaign: WhopSDK::Models::AdGroupUpdateResponse::AdCampaign,
7
+ budget: Float?,
8
+ budget_type: WhopSDK::Models::AdGroupUpdateResponse::budget_type?,
9
+ created_at: Time,
10
+ platform: WhopSDK::Models::AdGroupUpdateResponse::platform,
11
+ status: WhopSDK::Models::AdGroupUpdateResponse::status,
12
+ title: String?,
13
+ updated_at: Time
14
+ }
15
+
16
+ class AdGroupUpdateResponse < WhopSDK::Internal::Type::BaseModel
17
+ attr_accessor id: String
18
+
19
+ attr_accessor ad_campaign: WhopSDK::Models::AdGroupUpdateResponse::AdCampaign
20
+
21
+ attr_accessor budget: Float?
22
+
23
+ attr_accessor budget_type: WhopSDK::Models::AdGroupUpdateResponse::budget_type?
24
+
25
+ attr_accessor created_at: Time
26
+
27
+ attr_accessor platform: WhopSDK::Models::AdGroupUpdateResponse::platform
28
+
29
+ attr_accessor status: WhopSDK::Models::AdGroupUpdateResponse::status
30
+
31
+ attr_accessor title: String?
32
+
33
+ attr_accessor updated_at: Time
34
+
35
+ def initialize: (
36
+ id: String,
37
+ ad_campaign: WhopSDK::Models::AdGroupUpdateResponse::AdCampaign,
38
+ budget: Float?,
39
+ budget_type: WhopSDK::Models::AdGroupUpdateResponse::budget_type?,
40
+ created_at: Time,
41
+ platform: WhopSDK::Models::AdGroupUpdateResponse::platform,
42
+ status: WhopSDK::Models::AdGroupUpdateResponse::status,
43
+ title: String?,
44
+ updated_at: Time
45
+ ) -> void
46
+
47
+ def to_hash: -> {
48
+ id: String,
49
+ ad_campaign: WhopSDK::Models::AdGroupUpdateResponse::AdCampaign,
50
+ budget: Float?,
51
+ budget_type: WhopSDK::Models::AdGroupUpdateResponse::budget_type?,
52
+ created_at: Time,
53
+ platform: WhopSDK::Models::AdGroupUpdateResponse::platform,
54
+ status: WhopSDK::Models::AdGroupUpdateResponse::status,
55
+ title: String?,
56
+ updated_at: Time
57
+ }
58
+
59
+ type ad_campaign = { id: String }
60
+
61
+ class AdCampaign < WhopSDK::Internal::Type::BaseModel
62
+ attr_accessor id: String
63
+
64
+ def initialize: (id: String) -> void
65
+
66
+ def to_hash: -> { id: String }
67
+ end
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::AdGroupUpdateResponse::budget_type]
78
+ end
79
+
80
+ type platform = :meta | :tiktok
81
+
82
+ module Platform
83
+ extend WhopSDK::Internal::Type::Enum
84
+
85
+ META: :meta
86
+ TIKTOK: :tiktok
87
+
88
+ def self?.values: -> ::Array[WhopSDK::Models::AdGroupUpdateResponse::platform]
89
+ end
90
+
91
+ type status =
92
+ :active | :paused | :inactive | :in_review | :rejected | :flagged
93
+
94
+ module Status
95
+ extend WhopSDK::Internal::Type::Enum
96
+
97
+ ACTIVE: :active
98
+ PAUSED: :paused
99
+ INACTIVE: :inactive
100
+ IN_REVIEW: :in_review
101
+ REJECTED: :rejected
102
+ FLAGGED: :flagged
103
+
104
+ def self?.values: -> ::Array[WhopSDK::Models::AdGroupUpdateResponse::status]
105
+ end
106
+ end
107
+ end
108
+ end
@@ -0,0 +1,87 @@
1
+ module WhopSDK
2
+ module Models
3
+ type ad_list_params =
4
+ {
5
+ ad_group_id: String?,
6
+ after: String?,
7
+ before: String?,
8
+ campaign_id: String?,
9
+ company_id: String?,
10
+ created_after: Time?,
11
+ created_before: Time?,
12
+ first: Integer?,
13
+ last: Integer?,
14
+ status: WhopSDK::Models::AdListParams::status?
15
+ }
16
+ & WhopSDK::Internal::Type::request_parameters
17
+
18
+ class AdListParams < WhopSDK::Internal::Type::BaseModel
19
+ extend WhopSDK::Internal::Type::RequestParameters::Converter
20
+ include WhopSDK::Internal::Type::RequestParameters
21
+
22
+ attr_accessor ad_group_id: String?
23
+
24
+ attr_accessor after: String?
25
+
26
+ attr_accessor before: String?
27
+
28
+ attr_accessor campaign_id: String?
29
+
30
+ attr_accessor company_id: String?
31
+
32
+ attr_accessor created_after: Time?
33
+
34
+ attr_accessor created_before: Time?
35
+
36
+ attr_accessor first: Integer?
37
+
38
+ attr_accessor last: Integer?
39
+
40
+ attr_accessor status: WhopSDK::Models::AdListParams::status?
41
+
42
+ def initialize: (
43
+ ?ad_group_id: String?,
44
+ ?after: String?,
45
+ ?before: String?,
46
+ ?campaign_id: String?,
47
+ ?company_id: String?,
48
+ ?created_after: Time?,
49
+ ?created_before: Time?,
50
+ ?first: Integer?,
51
+ ?last: Integer?,
52
+ ?status: WhopSDK::Models::AdListParams::status?,
53
+ ?request_options: WhopSDK::request_opts
54
+ ) -> void
55
+
56
+ def to_hash: -> {
57
+ ad_group_id: String?,
58
+ after: String?,
59
+ before: String?,
60
+ campaign_id: String?,
61
+ company_id: String?,
62
+ created_after: Time?,
63
+ created_before: Time?,
64
+ first: Integer?,
65
+ last: Integer?,
66
+ status: WhopSDK::Models::AdListParams::status?,
67
+ request_options: WhopSDK::RequestOptions
68
+ }
69
+
70
+ type status =
71
+ :active | :paused | :inactive | :in_review | :rejected | :flagged
72
+
73
+ module Status
74
+ extend WhopSDK::Internal::Type::Enum
75
+
76
+ ACTIVE: :active
77
+ PAUSED: :paused
78
+ INACTIVE: :inactive
79
+ IN_REVIEW: :in_review
80
+ REJECTED: :rejected
81
+ FLAGGED: :flagged
82
+
83
+ def self?.values: -> ::Array[WhopSDK::Models::AdListParams::status]
84
+ end
85
+ end
86
+ end
87
+ end
@@ -0,0 +1,72 @@
1
+ module WhopSDK
2
+ module Models
3
+ type ad_list_response =
4
+ {
5
+ id: String,
6
+ created_at: Time,
7
+ platform: WhopSDK::Models::AdListResponse::platform,
8
+ status: WhopSDK::Models::AdListResponse::status,
9
+ title: String?,
10
+ updated_at: Time
11
+ }
12
+
13
+ class AdListResponse < WhopSDK::Internal::Type::BaseModel
14
+ attr_accessor id: String
15
+
16
+ attr_accessor created_at: Time
17
+
18
+ attr_accessor platform: WhopSDK::Models::AdListResponse::platform
19
+
20
+ attr_accessor status: WhopSDK::Models::AdListResponse::status
21
+
22
+ attr_accessor title: String?
23
+
24
+ attr_accessor updated_at: Time
25
+
26
+ def initialize: (
27
+ id: String,
28
+ created_at: Time,
29
+ platform: WhopSDK::Models::AdListResponse::platform,
30
+ status: WhopSDK::Models::AdListResponse::status,
31
+ title: String?,
32
+ updated_at: Time
33
+ ) -> void
34
+
35
+ def to_hash: -> {
36
+ id: String,
37
+ created_at: Time,
38
+ platform: WhopSDK::Models::AdListResponse::platform,
39
+ status: WhopSDK::Models::AdListResponse::status,
40
+ title: String?,
41
+ updated_at: Time
42
+ }
43
+
44
+ type platform = :meta | :tiktok
45
+
46
+ module Platform
47
+ extend WhopSDK::Internal::Type::Enum
48
+
49
+ META: :meta
50
+ TIKTOK: :tiktok
51
+
52
+ def self?.values: -> ::Array[WhopSDK::Models::AdListResponse::platform]
53
+ end
54
+
55
+ type status =
56
+ :active | :paused | :inactive | :in_review | :rejected | :flagged
57
+
58
+ module Status
59
+ extend WhopSDK::Internal::Type::Enum
60
+
61
+ ACTIVE: :active
62
+ PAUSED: :paused
63
+ INACTIVE: :inactive
64
+ IN_REVIEW: :in_review
65
+ REJECTED: :rejected
66
+ FLAGGED: :flagged
67
+
68
+ def self?.values: -> ::Array[WhopSDK::Models::AdListResponse::status]
69
+ end
70
+ end
71
+ end
72
+ end
@@ -0,0 +1,56 @@
1
+ module WhopSDK
2
+ module Models
3
+ type ad_report_retrieve_params =
4
+ {
5
+ from: Time,
6
+ to: Time,
7
+ ad_campaign_id: String?,
8
+ ad_group_id: String?,
9
+ ad_id: String?,
10
+ currency: String?,
11
+ include_daily: bool?
12
+ }
13
+ & WhopSDK::Internal::Type::request_parameters
14
+
15
+ class AdReportRetrieveParams < WhopSDK::Internal::Type::BaseModel
16
+ extend WhopSDK::Internal::Type::RequestParameters::Converter
17
+ include WhopSDK::Internal::Type::RequestParameters
18
+
19
+ attr_accessor from: Time
20
+
21
+ attr_accessor to: Time
22
+
23
+ attr_accessor ad_campaign_id: String?
24
+
25
+ attr_accessor ad_group_id: String?
26
+
27
+ attr_accessor ad_id: String?
28
+
29
+ attr_accessor currency: String?
30
+
31
+ attr_accessor include_daily: bool?
32
+
33
+ def initialize: (
34
+ from: Time,
35
+ to: Time,
36
+ ?ad_campaign_id: String?,
37
+ ?ad_group_id: String?,
38
+ ?ad_id: String?,
39
+ ?currency: String?,
40
+ ?include_daily: bool?,
41
+ ?request_options: WhopSDK::request_opts
42
+ ) -> void
43
+
44
+ def to_hash: -> {
45
+ from: Time,
46
+ to: Time,
47
+ ad_campaign_id: String?,
48
+ ad_group_id: String?,
49
+ ad_id: String?,
50
+ currency: String?,
51
+ include_daily: bool?,
52
+ request_options: WhopSDK::RequestOptions
53
+ }
54
+ end
55
+ end
56
+ end
@@ -0,0 +1,278 @@
1
+ module WhopSDK
2
+ module Models
3
+ type ad_report_retrieve_response =
4
+ {
5
+ daily: ::Array[WhopSDK::Models::AdReportRetrieveResponse::Daily]?,
6
+ summary: WhopSDK::Models::AdReportRetrieveResponse::Summary
7
+ }
8
+
9
+ class AdReportRetrieveResponse < WhopSDK::Internal::Type::BaseModel
10
+ attr_accessor daily: ::Array[WhopSDK::Models::AdReportRetrieveResponse::Daily]?
11
+
12
+ attr_accessor summary: WhopSDK::Models::AdReportRetrieveResponse::Summary
13
+
14
+ def initialize: (
15
+ daily: ::Array[WhopSDK::Models::AdReportRetrieveResponse::Daily]?,
16
+ summary: WhopSDK::Models::AdReportRetrieveResponse::Summary
17
+ ) -> void
18
+
19
+ def to_hash: -> {
20
+ daily: ::Array[WhopSDK::Models::AdReportRetrieveResponse::Daily]?,
21
+ summary: WhopSDK::Models::AdReportRetrieveResponse::Summary
22
+ }
23
+
24
+ type daily =
25
+ {
26
+ clicks: Integer,
27
+ impressions: Integer,
28
+ reach: Integer,
29
+ result_count: Integer?,
30
+ result_label_key: WhopSDK::Models::AdReportRetrieveResponse::Daily::result_label_key?,
31
+ result_label_override: String?,
32
+ spend: Float,
33
+ spend_currency: WhopSDK::Models::currency,
34
+ stat_date: Time
35
+ }
36
+
37
+ class Daily < WhopSDK::Internal::Type::BaseModel
38
+ attr_accessor clicks: Integer
39
+
40
+ attr_accessor impressions: Integer
41
+
42
+ attr_accessor reach: Integer
43
+
44
+ attr_accessor result_count: Integer?
45
+
46
+ attr_accessor result_label_key: WhopSDK::Models::AdReportRetrieveResponse::Daily::result_label_key?
47
+
48
+ attr_accessor result_label_override: String?
49
+
50
+ attr_accessor spend: Float
51
+
52
+ attr_accessor spend_currency: WhopSDK::Models::currency
53
+
54
+ attr_accessor stat_date: Time
55
+
56
+ def initialize: (
57
+ clicks: Integer,
58
+ impressions: Integer,
59
+ reach: Integer,
60
+ result_count: Integer?,
61
+ result_label_key: WhopSDK::Models::AdReportRetrieveResponse::Daily::result_label_key?,
62
+ result_label_override: String?,
63
+ spend: Float,
64
+ spend_currency: WhopSDK::Models::currency,
65
+ stat_date: Time
66
+ ) -> void
67
+
68
+ def to_hash: -> {
69
+ clicks: Integer,
70
+ impressions: Integer,
71
+ reach: Integer,
72
+ result_count: Integer?,
73
+ result_label_key: WhopSDK::Models::AdReportRetrieveResponse::Daily::result_label_key?,
74
+ result_label_override: String?,
75
+ spend: Float,
76
+ spend_currency: WhopSDK::Models::currency,
77
+ stat_date: Time
78
+ }
79
+
80
+ type result_label_key =
81
+ :app_installs
82
+ | :messaging_conversations_started
83
+ | :post_engagement
84
+ | :event_responses
85
+ | :impressions
86
+ | :website_purchases
87
+ | :landing_page_views
88
+ | :leads
89
+ | :link_clicks
90
+ | :quality_calls
91
+ | :appointments_booked
92
+ | :messaging_purchases
93
+ | :page_likes
94
+ | :instagram_profile_visits
95
+ | :reach
96
+ | :reminders_set
97
+ | :new_subscribers
98
+ | :video_views
99
+ | :registrations
100
+ | :content_views
101
+ | :searches
102
+ | :website_schedules
103
+ | :website_submit_applications
104
+ | :custom
105
+
106
+ module ResultLabelKey
107
+ extend WhopSDK::Internal::Type::Enum
108
+
109
+ APP_INSTALLS: :app_installs
110
+ MESSAGING_CONVERSATIONS_STARTED: :messaging_conversations_started
111
+ POST_ENGAGEMENT: :post_engagement
112
+ EVENT_RESPONSES: :event_responses
113
+ IMPRESSIONS: :impressions
114
+ WEBSITE_PURCHASES: :website_purchases
115
+ LANDING_PAGE_VIEWS: :landing_page_views
116
+ LEADS: :leads
117
+ LINK_CLICKS: :link_clicks
118
+ QUALITY_CALLS: :quality_calls
119
+ APPOINTMENTS_BOOKED: :appointments_booked
120
+ MESSAGING_PURCHASES: :messaging_purchases
121
+ PAGE_LIKES: :page_likes
122
+ INSTAGRAM_PROFILE_VISITS: :instagram_profile_visits
123
+ REACH: :reach
124
+ REMINDERS_SET: :reminders_set
125
+ NEW_SUBSCRIBERS: :new_subscribers
126
+ VIDEO_VIEWS: :video_views
127
+ REGISTRATIONS: :registrations
128
+ CONTENT_VIEWS: :content_views
129
+ SEARCHES: :searches
130
+ WEBSITE_SCHEDULES: :website_schedules
131
+ WEBSITE_SUBMIT_APPLICATIONS: :website_submit_applications
132
+ CUSTOM: :custom
133
+
134
+ def self?.values: -> ::Array[WhopSDK::Models::AdReportRetrieveResponse::Daily::result_label_key]
135
+ end
136
+ end
137
+
138
+ type summary =
139
+ {
140
+ clicks: Integer,
141
+ cost_per_result: Float?,
142
+ cpc: Float,
143
+ cpm: Float?,
144
+ ctr: Float,
145
+ frequency: Float?,
146
+ impressions: Integer,
147
+ reach: Integer,
148
+ result_count: Integer?,
149
+ result_label_key: WhopSDK::Models::AdReportRetrieveResponse::Summary::result_label_key?,
150
+ result_label_override: String?,
151
+ roas: Float?,
152
+ spend: Float,
153
+ spend_currency: WhopSDK::Models::currency?
154
+ }
155
+
156
+ class Summary < WhopSDK::Internal::Type::BaseModel
157
+ attr_accessor clicks: Integer
158
+
159
+ attr_accessor cost_per_result: Float?
160
+
161
+ attr_accessor cpc: Float
162
+
163
+ attr_accessor cpm: Float?
164
+
165
+ attr_accessor ctr: Float
166
+
167
+ attr_accessor frequency: Float?
168
+
169
+ attr_accessor impressions: Integer
170
+
171
+ attr_accessor reach: Integer
172
+
173
+ attr_accessor result_count: Integer?
174
+
175
+ attr_accessor result_label_key: WhopSDK::Models::AdReportRetrieveResponse::Summary::result_label_key?
176
+
177
+ attr_accessor result_label_override: String?
178
+
179
+ attr_accessor roas: Float?
180
+
181
+ attr_accessor spend: Float
182
+
183
+ attr_accessor spend_currency: WhopSDK::Models::currency?
184
+
185
+ def initialize: (
186
+ clicks: Integer,
187
+ cost_per_result: Float?,
188
+ cpc: Float,
189
+ cpm: Float?,
190
+ ctr: Float,
191
+ frequency: Float?,
192
+ impressions: Integer,
193
+ reach: Integer,
194
+ result_count: Integer?,
195
+ result_label_key: WhopSDK::Models::AdReportRetrieveResponse::Summary::result_label_key?,
196
+ result_label_override: String?,
197
+ roas: Float?,
198
+ spend: Float,
199
+ spend_currency: WhopSDK::Models::currency?
200
+ ) -> void
201
+
202
+ def to_hash: -> {
203
+ clicks: Integer,
204
+ cost_per_result: Float?,
205
+ cpc: Float,
206
+ cpm: Float?,
207
+ ctr: Float,
208
+ frequency: Float?,
209
+ impressions: Integer,
210
+ reach: Integer,
211
+ result_count: Integer?,
212
+ result_label_key: WhopSDK::Models::AdReportRetrieveResponse::Summary::result_label_key?,
213
+ result_label_override: String?,
214
+ roas: Float?,
215
+ spend: Float,
216
+ spend_currency: WhopSDK::Models::currency?
217
+ }
218
+
219
+ type result_label_key =
220
+ :app_installs
221
+ | :messaging_conversations_started
222
+ | :post_engagement
223
+ | :event_responses
224
+ | :impressions
225
+ | :website_purchases
226
+ | :landing_page_views
227
+ | :leads
228
+ | :link_clicks
229
+ | :quality_calls
230
+ | :appointments_booked
231
+ | :messaging_purchases
232
+ | :page_likes
233
+ | :instagram_profile_visits
234
+ | :reach
235
+ | :reminders_set
236
+ | :new_subscribers
237
+ | :video_views
238
+ | :registrations
239
+ | :content_views
240
+ | :searches
241
+ | :website_schedules
242
+ | :website_submit_applications
243
+ | :custom
244
+
245
+ module ResultLabelKey
246
+ extend WhopSDK::Internal::Type::Enum
247
+
248
+ APP_INSTALLS: :app_installs
249
+ MESSAGING_CONVERSATIONS_STARTED: :messaging_conversations_started
250
+ POST_ENGAGEMENT: :post_engagement
251
+ EVENT_RESPONSES: :event_responses
252
+ IMPRESSIONS: :impressions
253
+ WEBSITE_PURCHASES: :website_purchases
254
+ LANDING_PAGE_VIEWS: :landing_page_views
255
+ LEADS: :leads
256
+ LINK_CLICKS: :link_clicks
257
+ QUALITY_CALLS: :quality_calls
258
+ APPOINTMENTS_BOOKED: :appointments_booked
259
+ MESSAGING_PURCHASES: :messaging_purchases
260
+ PAGE_LIKES: :page_likes
261
+ INSTAGRAM_PROFILE_VISITS: :instagram_profile_visits
262
+ REACH: :reach
263
+ REMINDERS_SET: :reminders_set
264
+ NEW_SUBSCRIBERS: :new_subscribers
265
+ VIDEO_VIEWS: :video_views
266
+ REGISTRATIONS: :registrations
267
+ CONTENT_VIEWS: :content_views
268
+ SEARCHES: :searches
269
+ WEBSITE_SCHEDULES: :website_schedules
270
+ WEBSITE_SUBMIT_APPLICATIONS: :website_submit_applications
271
+ CUSTOM: :custom
272
+
273
+ def self?.values: -> ::Array[WhopSDK::Models::AdReportRetrieveResponse::Summary::result_label_key]
274
+ end
275
+ end
276
+ end
277
+ end
278
+ end
@@ -0,0 +1,20 @@
1
+ module WhopSDK
2
+ module Models
3
+ type ad_retrieve_params =
4
+ { id: String } & WhopSDK::Internal::Type::request_parameters
5
+
6
+ class AdRetrieveParams < 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