onlyfans 0.1.0 → 0.3.0

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 (338) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +323 -0
  3. data/README.md +9 -4
  4. data/lib/onlyfans/client.rb +11 -3
  5. data/lib/onlyfans/internal/transport/base_client.rb +4 -1
  6. data/lib/onlyfans/models/analytics/financial/profitability_get_history_response.rb +114 -36
  7. data/lib/onlyfans/models/analytics/financial/profitability_get_profitability_response.rb +112 -46
  8. data/lib/onlyfans/models/authenticate_start_params.rb +1 -0
  9. data/lib/onlyfans/models/chat_list_media_params.rb +6 -2
  10. data/lib/onlyfans/models/chat_list_params.rb +8 -3
  11. data/lib/onlyfans/models/chats/message_list_params.rb +6 -6
  12. data/lib/onlyfans/models/chats/message_send_params.rb +41 -6
  13. data/lib/onlyfans/models/client_session_create_params.rb +1 -0
  14. data/lib/onlyfans/models/data_export_create_params.rb +36 -21
  15. data/lib/onlyfans/models/data_export_list_params.rb +5 -0
  16. data/lib/onlyfans/models/data_export_list_response.rb +7 -1
  17. data/lib/onlyfans/models/data_export_retrieve_response.rb +7 -1
  18. data/lib/onlyfans/models/engagement/message_get_message_buyers_params.rb +2 -2
  19. data/lib/onlyfans/models/engagement/message_get_top_message_params.rb +3 -3
  20. data/lib/onlyfans/models/engagement/messages/direct_message_chart_params.rb +2 -2
  21. data/lib/onlyfans/models/engagement/messages/direct_message_list_params.rb +3 -3
  22. data/lib/onlyfans/models/engagement/messages/mass_message_chart_params.rb +2 -2
  23. data/lib/onlyfans/models/engagement/messages/mass_message_list_params.rb +3 -3
  24. data/lib/onlyfans/models/fan_list_active_params.rb +55 -13
  25. data/lib/onlyfans/models/fan_list_all_params.rb +55 -13
  26. data/lib/onlyfans/models/fan_list_expired_params.rb +55 -13
  27. data/lib/onlyfans/models/fan_list_latest_params.rb +8 -8
  28. data/lib/onlyfans/models/fan_list_top_params.rb +6 -6
  29. data/lib/onlyfans/models/fans/summary_get_summary_response.rb +49 -2
  30. data/lib/onlyfans/models/following_list_active_params.rb +79 -1
  31. data/lib/onlyfans/models/following_list_all_params.rb +79 -1
  32. data/lib/onlyfans/models/following_list_expired_params.rb +79 -1
  33. data/lib/onlyfans/models/link_tag_list_params.rb +4 -3
  34. data/lib/onlyfans/models/mass_messaging_retrieve_overview_params.rb +3 -3
  35. data/lib/onlyfans/models/mass_messaging_send_params.rb +44 -6
  36. data/lib/onlyfans/models/mass_messaging_update_params.rb +34 -6
  37. data/lib/onlyfans/models/media/upload_get_status_response.rb +54 -27
  38. data/lib/onlyfans/models/media/vault/list_list_params.rb +14 -1
  39. data/lib/onlyfans/models/media/vault/list_list_response.rb +420 -202
  40. data/lib/onlyfans/models/media/vault/list_update_params.rb +11 -1
  41. data/lib/onlyfans/models/media/vault_upload_params.rb +3 -1
  42. data/lib/onlyfans/models/media_upload_params.rb +3 -1
  43. data/lib/onlyfans/models/notification_list_params.rb +3 -3
  44. data/lib/onlyfans/models/post_create_params.rb +29 -1
  45. data/lib/onlyfans/models/post_update_params.rb +29 -1
  46. data/lib/onlyfans/models/queue_list_params.rb +36 -15
  47. data/lib/onlyfans/models/release_form_list_taggable_users_response.rb +8 -8
  48. data/lib/onlyfans/models/shared_tracking_link_list_params.rb +75 -10
  49. data/lib/onlyfans/models/shared_trial_link_list_params.rb +26 -10
  50. data/lib/onlyfans/models/smart_link_create_response.rb +2 -2
  51. data/lib/onlyfans/models/smart_link_list_clicks_response.rb +19 -1
  52. data/lib/onlyfans/models/smart_link_list_conversions_params.rb +1 -0
  53. data/lib/onlyfans/models/smart_link_list_conversions_response.rb +19 -1
  54. data/lib/onlyfans/models/smart_link_list_fans_params.rb +21 -1
  55. data/lib/onlyfans/models/smart_link_list_fans_response.rb +99 -3
  56. data/lib/onlyfans/models/smart_link_list_params.rb +27 -9
  57. data/lib/onlyfans/models/smart_link_postback_create_params.rb +66 -4
  58. data/lib/onlyfans/models/smart_link_postback_create_response.rb +48 -1
  59. data/lib/onlyfans/models/smart_link_postback_list_response.rb +48 -1
  60. data/lib/onlyfans/models/smart_link_postback_retrieve_response.rb +48 -1
  61. data/lib/onlyfans/models/smart_link_postback_update_params.rb +65 -1
  62. data/lib/onlyfans/models/smart_link_postback_update_response.rb +48 -1
  63. data/lib/onlyfans/models/statistic_calculate_total_transactions_params.rb +5 -5
  64. data/lib/onlyfans/models/statistic_get_subscriber_metrics_params.rb +25 -1
  65. data/lib/onlyfans/models/statistics/reach_get_profile_visitors_params.rb +2 -2
  66. data/lib/onlyfans/models/statistics/statement_get_earnings_params.rb +10 -10
  67. data/lib/onlyfans/models/stored_list_tracking_links_response.rb +7 -1
  68. data/lib/onlyfans/models/stored_list_trial_links_response.rb +7 -1
  69. data/lib/onlyfans/models/story_create_params.rb +293 -6
  70. data/lib/onlyfans/models/story_create_response.rb +330 -7
  71. data/lib/onlyfans/models/tracking_link_get_stats_response.rb +7 -1
  72. data/lib/onlyfans/models/tracking_link_list_params.rb +58 -30
  73. data/lib/onlyfans/models/tracking_link_list_response.rb +7 -1
  74. data/lib/onlyfans/models/tracking_link_list_spenders_response.rb +7 -1
  75. data/lib/onlyfans/models/tracking_link_retrieve_response.rb +7 -1
  76. data/lib/onlyfans/models/transaction_list_params.rb +2 -2
  77. data/lib/onlyfans/models/trial_link_list_params.rb +44 -27
  78. data/lib/onlyfans/models/trial_link_list_response.rb +7 -1
  79. data/lib/onlyfans/models/trial_link_list_spenders_response.rb +7 -1
  80. data/lib/onlyfans/models/trial_link_retrieve_response.rb +7 -1
  81. data/lib/onlyfans/models/trial_link_retrieve_stats_response.rb +7 -1
  82. data/lib/onlyfans/models/user_list_list_params.rb +21 -1
  83. data/lib/onlyfans/models/user_lists/user_add_params.rb +18 -1
  84. data/lib/onlyfans/models/user_lists/user_add_response.rb +246 -88
  85. data/lib/onlyfans/models/webhook_create_params.rb +11 -7
  86. data/lib/onlyfans/models/webhook_update_params.rb +11 -7
  87. data/lib/onlyfans/models.rb +0 -2
  88. data/lib/onlyfans/resources/analytics/financial/profitability.rb +4 -4
  89. data/lib/onlyfans/resources/chats/messages.rb +47 -8
  90. data/lib/onlyfans/resources/chats.rb +7 -4
  91. data/lib/onlyfans/resources/data_exports.rb +1 -1
  92. data/lib/onlyfans/resources/engagement/messages/direct_messages.rb +2 -2
  93. data/lib/onlyfans/resources/engagement/messages/mass_messages.rb +2 -2
  94. data/lib/onlyfans/resources/engagement/messages.rb +2 -2
  95. data/lib/onlyfans/resources/fans.rb +43 -10
  96. data/lib/onlyfans/resources/following.rb +58 -12
  97. data/lib/onlyfans/resources/link_tags.rb +4 -4
  98. data/lib/onlyfans/resources/mass_messaging.rb +18 -9
  99. data/lib/onlyfans/resources/media/uploads.rb +6 -1
  100. data/lib/onlyfans/resources/media/vault/lists.rb +30 -5
  101. data/lib/onlyfans/resources/media.rb +14 -8
  102. data/lib/onlyfans/resources/messages.rb +0 -39
  103. data/lib/onlyfans/resources/notifications.rb +1 -1
  104. data/lib/onlyfans/resources/posts.rb +6 -2
  105. data/lib/onlyfans/resources/queue.rb +9 -6
  106. data/lib/onlyfans/resources/release_forms.rb +2 -1
  107. data/lib/onlyfans/resources/shared_tracking_links.rb +12 -5
  108. data/lib/onlyfans/resources/shared_trial_links.rb +6 -5
  109. data/lib/onlyfans/resources/smart_link_postbacks.rb +18 -3
  110. data/lib/onlyfans/resources/smart_links.rb +13 -4
  111. data/lib/onlyfans/resources/statistics/reach.rb +1 -1
  112. data/lib/onlyfans/resources/statistics/statements.rb +3 -3
  113. data/lib/onlyfans/resources/statistics.rb +5 -3
  114. data/lib/onlyfans/resources/stories.rb +13 -6
  115. data/lib/onlyfans/resources/tracking_links/tags.rb +5 -1
  116. data/lib/onlyfans/resources/tracking_links.rb +21 -11
  117. data/lib/onlyfans/resources/transactions.rb +1 -1
  118. data/lib/onlyfans/resources/trial_links/tags.rb +5 -1
  119. data/lib/onlyfans/resources/trial_links.rb +22 -10
  120. data/lib/onlyfans/resources/user_lists/users.rb +7 -2
  121. data/lib/onlyfans/resources/user_lists.rb +5 -2
  122. data/lib/onlyfans/resources/users.rb +4 -1
  123. data/lib/onlyfans/resources/webhooks.rb +6 -4
  124. data/lib/onlyfans/version.rb +1 -1
  125. data/lib/onlyfans.rb +0 -3
  126. data/rbi/onlyfans/client.rbi +11 -3
  127. data/rbi/onlyfans/models/analytics/financial/profitability_get_history_response.rbi +203 -63
  128. data/rbi/onlyfans/models/analytics/financial/profitability_get_profitability_response.rbi +201 -79
  129. data/rbi/onlyfans/models/authenticate_start_params.rbi +5 -0
  130. data/rbi/onlyfans/models/chat_list_media_params.rbi +4 -2
  131. data/rbi/onlyfans/models/chat_list_params.rbi +6 -3
  132. data/rbi/onlyfans/models/chats/message_list_params.rbi +8 -8
  133. data/rbi/onlyfans/models/chats/message_send_params.rbi +88 -6
  134. data/rbi/onlyfans/models/client_session_create_params.rbi +5 -0
  135. data/rbi/onlyfans/models/data_export_create_params.rbi +69 -37
  136. data/rbi/onlyfans/models/data_export_list_params.rbi +18 -0
  137. data/rbi/onlyfans/models/data_export_list_response.rbi +9 -0
  138. data/rbi/onlyfans/models/data_export_retrieve_response.rbi +9 -0
  139. data/rbi/onlyfans/models/engagement/message_get_message_buyers_params.rbi +2 -2
  140. data/rbi/onlyfans/models/engagement/message_get_top_message_params.rbi +4 -4
  141. data/rbi/onlyfans/models/engagement/messages/direct_message_chart_params.rbi +2 -2
  142. data/rbi/onlyfans/models/engagement/messages/direct_message_list_params.rbi +4 -4
  143. data/rbi/onlyfans/models/engagement/messages/mass_message_chart_params.rbi +2 -2
  144. data/rbi/onlyfans/models/engagement/messages/mass_message_list_params.rbi +4 -4
  145. data/rbi/onlyfans/models/fan_list_active_params.rbi +84 -13
  146. data/rbi/onlyfans/models/fan_list_all_params.rbi +84 -13
  147. data/rbi/onlyfans/models/fan_list_expired_params.rbi +84 -13
  148. data/rbi/onlyfans/models/fan_list_latest_params.rbi +10 -10
  149. data/rbi/onlyfans/models/fan_list_top_params.rbi +8 -8
  150. data/rbi/onlyfans/models/fans/summary_get_summary_response.rbi +96 -0
  151. data/rbi/onlyfans/models/following_list_active_params.rbi +160 -0
  152. data/rbi/onlyfans/models/following_list_all_params.rbi +155 -0
  153. data/rbi/onlyfans/models/following_list_expired_params.rbi +160 -0
  154. data/rbi/onlyfans/models/link_tag_list_params.rbi +5 -3
  155. data/rbi/onlyfans/models/mass_messaging_retrieve_overview_params.rbi +4 -4
  156. data/rbi/onlyfans/models/mass_messaging_send_params.rbi +91 -6
  157. data/rbi/onlyfans/models/mass_messaging_update_params.rbi +76 -6
  158. data/rbi/onlyfans/models/media/upload_get_status_response.rbi +79 -33
  159. data/rbi/onlyfans/models/media/vault/list_list_params.rbi +15 -0
  160. data/rbi/onlyfans/models/media/vault/list_list_response.rbi +972 -428
  161. data/rbi/onlyfans/models/media/vault/list_update_params.rbi +13 -1
  162. data/rbi/onlyfans/models/media/vault_upload_params.rbi +6 -2
  163. data/rbi/onlyfans/models/media_upload_params.rbi +6 -2
  164. data/rbi/onlyfans/models/notification_list_params.rbi +3 -3
  165. data/rbi/onlyfans/models/post_create_params.rbi +66 -0
  166. data/rbi/onlyfans/models/post_update_params.rbi +66 -0
  167. data/rbi/onlyfans/models/queue_list_params.rbi +59 -16
  168. data/rbi/onlyfans/models/release_form_list_taggable_users_response.rbi +12 -12
  169. data/rbi/onlyfans/models/shared_tracking_link_list_params.rbi +198 -11
  170. data/rbi/onlyfans/models/shared_trial_link_list_params.rbi +64 -11
  171. data/rbi/onlyfans/models/smart_link_create_response.rbi +6 -3
  172. data/rbi/onlyfans/models/smart_link_list_clicks_response.rbi +21 -3
  173. data/rbi/onlyfans/models/smart_link_list_conversions_params.rbi +5 -0
  174. data/rbi/onlyfans/models/smart_link_list_conversions_response.rbi +21 -3
  175. data/rbi/onlyfans/models/smart_link_list_fans_params.rbi +24 -0
  176. data/rbi/onlyfans/models/smart_link_list_fans_response.rbi +205 -3
  177. data/rbi/onlyfans/models/smart_link_list_params.rbi +45 -8
  178. data/rbi/onlyfans/models/smart_link_postback_create_params.rbi +139 -4
  179. data/rbi/onlyfans/models/smart_link_postback_create_response.rbi +96 -0
  180. data/rbi/onlyfans/models/smart_link_postback_list_response.rbi +96 -0
  181. data/rbi/onlyfans/models/smart_link_postback_retrieve_response.rbi +96 -0
  182. data/rbi/onlyfans/models/smart_link_postback_update_params.rbi +133 -0
  183. data/rbi/onlyfans/models/smart_link_postback_update_response.rbi +96 -0
  184. data/rbi/onlyfans/models/statistic_calculate_total_transactions_params.rbi +12 -6
  185. data/rbi/onlyfans/models/statistic_get_subscriber_metrics_params.rbi +63 -0
  186. data/rbi/onlyfans/models/statistics/reach_get_profile_visitors_params.rbi +2 -2
  187. data/rbi/onlyfans/models/statistics/statement_get_earnings_params.rbi +10 -13
  188. data/rbi/onlyfans/models/stored_list_tracking_links_response.rbi +9 -0
  189. data/rbi/onlyfans/models/stored_list_trial_links_response.rbi +9 -0
  190. data/rbi/onlyfans/models/story_create_params.rbi +548 -4
  191. data/rbi/onlyfans/models/story_create_response.rbi +670 -8
  192. data/rbi/onlyfans/models/tracking_link_get_stats_response.rbi +9 -0
  193. data/rbi/onlyfans/models/tracking_link_list_params.rbi +144 -45
  194. data/rbi/onlyfans/models/tracking_link_list_response.rbi +9 -0
  195. data/rbi/onlyfans/models/tracking_link_list_spenders_response.rbi +17 -5
  196. data/rbi/onlyfans/models/tracking_link_retrieve_response.rbi +9 -0
  197. data/rbi/onlyfans/models/transaction_list_params.rbi +2 -2
  198. data/rbi/onlyfans/models/trial_link_list_params.rbi +66 -33
  199. data/rbi/onlyfans/models/trial_link_list_response.rbi +9 -0
  200. data/rbi/onlyfans/models/trial_link_list_spenders_response.rbi +17 -5
  201. data/rbi/onlyfans/models/trial_link_retrieve_response.rbi +9 -0
  202. data/rbi/onlyfans/models/trial_link_retrieve_stats_response.rbi +9 -0
  203. data/rbi/onlyfans/models/user_list_list_params.rbi +33 -0
  204. data/rbi/onlyfans/models/user_lists/user_add_params.rbi +23 -0
  205. data/rbi/onlyfans/models/user_lists/user_add_response.rbi +596 -181
  206. data/rbi/onlyfans/models/webhook_create_params.rbi +16 -10
  207. data/rbi/onlyfans/models/webhook_update_params.rbi +16 -10
  208. data/rbi/onlyfans/models.rbi +0 -2
  209. data/rbi/onlyfans/resources/analytics/financial/profitability.rbi +2 -6
  210. data/rbi/onlyfans/resources/chats/messages.rbi +53 -10
  211. data/rbi/onlyfans/resources/chats.rbi +6 -5
  212. data/rbi/onlyfans/resources/data_exports.rbi +26 -17
  213. data/rbi/onlyfans/resources/engagement/messages/direct_messages.rbi +3 -3
  214. data/rbi/onlyfans/resources/engagement/messages/mass_messages.rbi +3 -3
  215. data/rbi/onlyfans/resources/engagement/messages.rbi +3 -3
  216. data/rbi/onlyfans/resources/fans.rbi +50 -17
  217. data/rbi/onlyfans/resources/following.rbi +122 -4
  218. data/rbi/onlyfans/resources/link_tags.rbi +4 -4
  219. data/rbi/onlyfans/resources/mass_messaging.rbi +32 -10
  220. data/rbi/onlyfans/resources/media/uploads.rbi +5 -0
  221. data/rbi/onlyfans/resources/media/vault/lists.rbi +28 -3
  222. data/rbi/onlyfans/resources/media/vault.rbi +3 -1
  223. data/rbi/onlyfans/resources/media.rbi +16 -7
  224. data/rbi/onlyfans/resources/messages.rbi +0 -29
  225. data/rbi/onlyfans/resources/notifications.rbi +1 -1
  226. data/rbi/onlyfans/resources/posts.rbi +14 -0
  227. data/rbi/onlyfans/resources/queue.rbi +15 -8
  228. data/rbi/onlyfans/resources/release_forms.rbi +2 -1
  229. data/rbi/onlyfans/resources/shared_tracking_links.rbi +21 -5
  230. data/rbi/onlyfans/resources/shared_trial_links.rbi +8 -5
  231. data/rbi/onlyfans/resources/smart_link_postbacks.rbi +27 -2
  232. data/rbi/onlyfans/resources/smart_links.rbi +12 -3
  233. data/rbi/onlyfans/resources/statistics/reach.rbi +1 -1
  234. data/rbi/onlyfans/resources/statistics/statements.rbi +4 -4
  235. data/rbi/onlyfans/resources/statistics.rbi +9 -2
  236. data/rbi/onlyfans/resources/stories.rbi +16 -3
  237. data/rbi/onlyfans/resources/tracking_links/tags.rbi +5 -1
  238. data/rbi/onlyfans/resources/tracking_links.rbi +30 -19
  239. data/rbi/onlyfans/resources/transactions.rbi +1 -1
  240. data/rbi/onlyfans/resources/trial_links/tags.rbi +5 -1
  241. data/rbi/onlyfans/resources/trial_links.rbi +29 -14
  242. data/rbi/onlyfans/resources/user_lists/users.rbi +10 -1
  243. data/rbi/onlyfans/resources/user_lists.rbi +6 -1
  244. data/rbi/onlyfans/resources/users.rbi +2 -1
  245. data/rbi/onlyfans/resources/webhooks.rbi +16 -10
  246. data/sig/onlyfans/models/analytics/financial/profitability_get_history_response.rbs +129 -40
  247. data/sig/onlyfans/models/analytics/financial/profitability_get_profitability_response.rbs +125 -50
  248. data/sig/onlyfans/models/authenticate_start_params.rbs +2 -1
  249. data/sig/onlyfans/models/chats/message_send_params.rbs +34 -6
  250. data/sig/onlyfans/models/client_session_create_params.rbs +2 -1
  251. data/sig/onlyfans/models/data_export_create_params.rbs +4 -0
  252. data/sig/onlyfans/models/data_export_list_params.rbs +10 -0
  253. data/sig/onlyfans/models/data_export_list_response.rbs +7 -0
  254. data/sig/onlyfans/models/data_export_retrieve_response.rbs +7 -0
  255. data/sig/onlyfans/models/fan_list_active_params.rbs +7 -0
  256. data/sig/onlyfans/models/fan_list_all_params.rbs +7 -0
  257. data/sig/onlyfans/models/fan_list_expired_params.rbs +7 -0
  258. data/sig/onlyfans/models/fans/summary_get_summary_response.rbs +53 -0
  259. data/sig/onlyfans/models/following_list_active_params.rbs +35 -1
  260. data/sig/onlyfans/models/following_list_all_params.rbs +35 -1
  261. data/sig/onlyfans/models/following_list_expired_params.rbs +35 -1
  262. data/sig/onlyfans/models/link_tag_list_params.rbs +2 -1
  263. data/sig/onlyfans/models/mass_messaging_send_params.rbs +33 -5
  264. data/sig/onlyfans/models/mass_messaging_update_params.rbs +26 -5
  265. data/sig/onlyfans/models/media/upload_get_status_response.rbs +65 -39
  266. data/sig/onlyfans/models/media/vault/list_list_params.rbs +13 -1
  267. data/sig/onlyfans/models/media/vault/list_list_response.rbs +519 -235
  268. data/sig/onlyfans/models/media/vault/list_update_params.rbs +5 -1
  269. data/sig/onlyfans/models/post_create_params.rbs +21 -0
  270. data/sig/onlyfans/models/post_update_params.rbs +21 -0
  271. data/sig/onlyfans/models/queue_list_params.rbs +28 -6
  272. data/sig/onlyfans/models/release_form_list_taggable_users_response.rbs +7 -10
  273. data/sig/onlyfans/models/shared_tracking_link_list_params.rbs +78 -4
  274. data/sig/onlyfans/models/shared_trial_link_list_params.rbs +31 -4
  275. data/sig/onlyfans/models/smart_link_create_response.rbs +6 -4
  276. data/sig/onlyfans/models/smart_link_list_clicks_response.rbs +18 -3
  277. data/sig/onlyfans/models/smart_link_list_conversions_params.rbs +2 -0
  278. data/sig/onlyfans/models/smart_link_list_conversions_response.rbs +18 -3
  279. data/sig/onlyfans/models/smart_link_list_fans_params.rbs +15 -1
  280. data/sig/onlyfans/models/smart_link_list_fans_response.rbs +125 -3
  281. data/sig/onlyfans/models/smart_link_list_params.rbs +27 -6
  282. data/sig/onlyfans/models/smart_link_postback_create_params.rbs +48 -0
  283. data/sig/onlyfans/models/smart_link_postback_create_response.rbs +53 -0
  284. data/sig/onlyfans/models/smart_link_postback_list_response.rbs +53 -0
  285. data/sig/onlyfans/models/smart_link_postback_retrieve_response.rbs +53 -0
  286. data/sig/onlyfans/models/smart_link_postback_update_params.rbs +48 -0
  287. data/sig/onlyfans/models/smart_link_postback_update_response.rbs +53 -0
  288. data/sig/onlyfans/models/statistic_calculate_total_transactions_params.rbs +8 -4
  289. data/sig/onlyfans/models/statistic_get_subscriber_metrics_params.rbs +23 -1
  290. data/sig/onlyfans/models/statistics/statement_get_earnings_params.rbs +5 -7
  291. data/sig/onlyfans/models/stored_list_tracking_links_response.rbs +7 -0
  292. data/sig/onlyfans/models/stored_list_trial_links_response.rbs +7 -0
  293. data/sig/onlyfans/models/story_create_params.rbs +271 -1
  294. data/sig/onlyfans/models/story_create_response.rbs +419 -9
  295. data/sig/onlyfans/models/tracking_link_get_stats_response.rbs +7 -0
  296. data/sig/onlyfans/models/tracking_link_list_params.rbs +75 -26
  297. data/sig/onlyfans/models/tracking_link_list_response.rbs +7 -0
  298. data/sig/onlyfans/models/tracking_link_list_spenders_response.rbs +16 -3
  299. data/sig/onlyfans/models/tracking_link_retrieve_response.rbs +7 -0
  300. data/sig/onlyfans/models/trial_link_list_params.rbs +42 -18
  301. data/sig/onlyfans/models/trial_link_list_response.rbs +7 -0
  302. data/sig/onlyfans/models/trial_link_list_spenders_response.rbs +16 -3
  303. data/sig/onlyfans/models/trial_link_retrieve_response.rbs +7 -0
  304. data/sig/onlyfans/models/trial_link_retrieve_stats_response.rbs +7 -0
  305. data/sig/onlyfans/models/user_list_list_params.rbs +24 -1
  306. data/sig/onlyfans/models/user_lists/user_add_params.rbs +12 -1
  307. data/sig/onlyfans/models/user_lists/user_add_response.rbs +300 -101
  308. data/sig/onlyfans/models.rbs +0 -2
  309. data/sig/onlyfans/resources/analytics/financial/profitability.rbs +2 -2
  310. data/sig/onlyfans/resources/chats/messages.rbs +3 -1
  311. data/sig/onlyfans/resources/following.rbs +6 -0
  312. data/sig/onlyfans/resources/mass_messaging.rbs +5 -2
  313. data/sig/onlyfans/resources/media/vault/lists.rbs +3 -1
  314. data/sig/onlyfans/resources/media.rbs +1 -1
  315. data/sig/onlyfans/resources/messages.rbs +0 -9
  316. data/sig/onlyfans/resources/posts.rbs +2 -0
  317. data/sig/onlyfans/resources/queue.rbs +2 -1
  318. data/sig/onlyfans/resources/shared_tracking_links.rbs +5 -1
  319. data/sig/onlyfans/resources/shared_trial_links.rbs +2 -1
  320. data/sig/onlyfans/resources/smart_link_postbacks.rbs +6 -0
  321. data/sig/onlyfans/resources/smart_links.rbs +4 -1
  322. data/sig/onlyfans/resources/statistics/statements.rbs +1 -1
  323. data/sig/onlyfans/resources/statistics.rbs +3 -2
  324. data/sig/onlyfans/resources/stories.rbs +4 -0
  325. data/sig/onlyfans/resources/tracking_links.rbs +7 -6
  326. data/sig/onlyfans/resources/trial_links.rbs +7 -5
  327. data/sig/onlyfans/resources/user_lists/users.rbs +2 -1
  328. data/sig/onlyfans/resources/user_lists.rbs +1 -0
  329. metadata +9 -15
  330. data/lib/onlyfans/models/media_download_response.rb +0 -7
  331. data/lib/onlyfans/models/message_attach_tags_params.rb +0 -52
  332. data/lib/onlyfans/models/message_attach_tags_response.rb +0 -125
  333. data/rbi/onlyfans/models/media_download_response.rbi +0 -7
  334. data/rbi/onlyfans/models/message_attach_tags_params.rbi +0 -80
  335. data/rbi/onlyfans/models/message_attach_tags_response.rbi +0 -308
  336. data/sig/onlyfans/models/media_download_response.rbs +0 -5
  337. data/sig/onlyfans/models/message_attach_tags_params.rbs +0 -52
  338. data/sig/onlyfans/models/message_attach_tags_response.rbs +0 -164
@@ -19,9 +19,19 @@ module Onlyfans
19
19
  # @return [String]
20
20
  required :list_id, String
21
21
 
22
- # @!method initialize(account:, list_id:, request_options: {})
22
+ # @!attribute name
23
+ # The new name for the vault list. Must not be greater than 255 characters.
24
+ #
25
+ # @return [String]
26
+ required :name, String
27
+
28
+ # @!method initialize(account:, list_id:, name:, request_options: {})
23
29
  # @param account [String]
30
+ #
24
31
  # @param list_id [String]
32
+ #
33
+ # @param name [String] The new name for the vault list. Must not be greater than 255 characters.
34
+ #
25
35
  # @param request_options [Onlyfans::RequestOptions, Hash{Symbol=>Object}]
26
36
  end
27
37
  end
@@ -15,7 +15,9 @@ module Onlyfans
15
15
 
16
16
  # @!attribute async
17
17
  # Set to `true` to process uploads in the background. Returns a `polling_url` to
18
- # check status. Recommended for large files.
18
+ # check status. Recommended for large files. Instead of polling, you can subscribe
19
+ # to the `media_uploads.completed` and `media_uploads.failed` webhook events —
20
+ # they only fire for async uploads.
19
21
  #
20
22
  # @return [Boolean, nil]
21
23
  optional :async, Onlyfans::Internal::Type::Boolean
@@ -14,7 +14,9 @@ module Onlyfans
14
14
 
15
15
  # @!attribute async
16
16
  # Set to `true` to process uploads in the background. Returns a `polling_url` to
17
- # check status. Recommended for large files.
17
+ # check status. Recommended for large files. Instead of polling, you can subscribe
18
+ # to the `media_uploads.completed` and `media_uploads.failed` webhook events —
19
+ # they only fire for async uploads.
18
20
  #
19
21
  # @return [Boolean, nil]
20
22
  optional :async, Onlyfans::Internal::Type::Boolean
@@ -26,7 +26,7 @@ module Onlyfans
26
26
  optional :limit, Integer
27
27
 
28
28
  # @!attribute skip_users
29
- # Whether to skip user details. Default `all`
29
+ # Whether to skip user details. Defaults to `all`.
30
30
  #
31
31
  # @return [Symbol, Onlyfans::Models::NotificationListParams::SkipUsers, nil]
32
32
  optional :skip_users, enum: -> { Onlyfans::NotificationListParams::SkipUsers }
@@ -47,13 +47,13 @@ module Onlyfans
47
47
  #
48
48
  # @param limit [Integer] The number of notifications. Default `10`
49
49
  #
50
- # @param skip_users [Symbol, Onlyfans::Models::NotificationListParams::SkipUsers] Whether to skip user details. Default `all`
50
+ # @param skip_users [Symbol, Onlyfans::Models::NotificationListParams::SkipUsers] Whether to skip user details. Defaults to `all`.
51
51
  #
52
52
  # @param type [Symbol, Onlyfans::Models::NotificationListParams::Type] Filter notifications by a specific type
53
53
  #
54
54
  # @param request_options [Onlyfans::RequestOptions, Hash{Symbol=>Object}]
55
55
 
56
- # Whether to skip user details. Default `all`
56
+ # Whether to skip user details. Defaults to `all`.
57
57
  module SkipUsers
58
58
  extend Onlyfans::Internal::Type::Enum
59
59
 
@@ -18,6 +18,17 @@ module Onlyfans
18
18
  # @return [String]
19
19
  required :text, String
20
20
 
21
+ # @!attribute block_banned_words
22
+ # Screen `text` for OnlyFans banned words and block the post if any are found
23
+ # (returns a 422 listing the offending words). `strict_ban` blocks all tiers,
24
+ # `risky` blocks Risky + Replace/soften, `replace_soften` blocks Replace/soften
25
+ # only. Omit to disable screening.
26
+ #
27
+ # @return [Symbol, Onlyfans::Models::PostCreateParams::BlockBannedWords, nil]
28
+ optional :block_banned_words,
29
+ enum: -> { Onlyfans::PostCreateParams::BlockBannedWords },
30
+ api_name: :blockBannedWords
31
+
21
32
  # @!attribute expire_days
22
33
  # Number of days after which the post will expire. Between 1 and 30 days. Keep
23
34
  # empty for no expiration.
@@ -107,7 +118,7 @@ module Onlyfans
107
118
  # @return [Symbol, Onlyfans::Models::PostCreateParams::VotingType, nil]
108
119
  optional :voting_type, enum: -> { Onlyfans::PostCreateParams::VotingType }, api_name: :votingType
109
120
 
110
- # @!method initialize(account:, text:, expire_days: nil, fund_raising_target_amount: nil, fund_raising_tips_presets: nil, label_ids: nil, media_files: nil, previews: nil, rf_tag: nil, save_for_later: nil, scheduled_date: nil, voting_correct_index: nil, voting_due: nil, voting_options: nil, voting_type: nil, request_options: {})
121
+ # @!method initialize(account:, text:, block_banned_words: nil, expire_days: nil, fund_raising_target_amount: nil, fund_raising_tips_presets: nil, label_ids: nil, media_files: nil, previews: nil, rf_tag: nil, save_for_later: nil, scheduled_date: nil, voting_correct_index: nil, voting_due: nil, voting_options: nil, voting_type: nil, request_options: {})
111
122
  # Some parameter documentations has been truncated, see
112
123
  # {Onlyfans::Models::PostCreateParams} for more details.
113
124
  #
@@ -115,6 +126,8 @@ module Onlyfans
115
126
  #
116
127
  # @param text [String] The post text content
117
128
  #
129
+ # @param block_banned_words [Symbol, Onlyfans::Models::PostCreateParams::BlockBannedWords] Screen `text` for OnlyFans banned words and block the post if any are found (ret
130
+ #
118
131
  # @param expire_days [Integer] Number of days after which the post will expire. Between 1 and 30 days. Keep emp
119
132
  #
120
133
  # @param fund_raising_target_amount [Integer] Add a fundraising target to your post. If present, value must be at least 10.
@@ -143,6 +156,21 @@ module Onlyfans
143
156
  #
144
157
  # @param request_options [Onlyfans::RequestOptions, Hash{Symbol=>Object}]
145
158
 
159
+ # Screen `text` for OnlyFans banned words and block the post if any are found
160
+ # (returns a 422 listing the offending words). `strict_ban` blocks all tiers,
161
+ # `risky` blocks Risky + Replace/soften, `replace_soften` blocks Replace/soften
162
+ # only. Omit to disable screening.
163
+ module BlockBannedWords
164
+ extend Onlyfans::Internal::Type::Enum
165
+
166
+ STRICT_BAN = :strict_ban
167
+ RISKY = :risky
168
+ REPLACE_SOFTEN = :replace_soften
169
+
170
+ # @!method self.values
171
+ # @return [Array<Symbol>]
172
+ end
173
+
146
174
  # Include a poll or quiz within your post.
147
175
  module VotingType
148
176
  extend Onlyfans::Internal::Type::Enum
@@ -23,6 +23,17 @@ module Onlyfans
23
23
  # @return [String]
24
24
  required :text, String
25
25
 
26
+ # @!attribute block_banned_words
27
+ # Screen `text` for OnlyFans banned words and block the update if any are found
28
+ # (returns a 422 listing the offending words). `strict_ban` blocks all tiers,
29
+ # `risky` blocks Risky + Replace/soften, `replace_soften` blocks Replace/soften
30
+ # only. Omit to disable screening.
31
+ #
32
+ # @return [Symbol, Onlyfans::Models::PostUpdateParams::BlockBannedWords, nil]
33
+ optional :block_banned_words,
34
+ enum: -> { Onlyfans::PostUpdateParams::BlockBannedWords },
35
+ api_name: :blockBannedWords
36
+
26
37
  # @!attribute expire_days
27
38
  # Number of days after which the post will expire. Between 1 and 30 days. Keep
28
39
  # empty for no expiration.
@@ -109,7 +120,7 @@ module Onlyfans
109
120
  # @return [Symbol, Onlyfans::Models::PostUpdateParams::VotingType, nil]
110
121
  optional :voting_type, enum: -> { Onlyfans::PostUpdateParams::VotingType }, api_name: :votingType
111
122
 
112
- # @!method initialize(account:, post_id:, text:, expire_days: nil, fund_raising_target_amount: nil, fund_raising_tips_presets: nil, label_ids: nil, media_files: nil, price: nil, rf_tag: nil, save_for_later: nil, scheduled_date: nil, voting_correct_index: nil, voting_due: nil, voting_options: nil, voting_type: nil, request_options: {})
123
+ # @!method initialize(account:, post_id:, text:, block_banned_words: nil, expire_days: nil, fund_raising_target_amount: nil, fund_raising_tips_presets: nil, label_ids: nil, media_files: nil, price: nil, rf_tag: nil, save_for_later: nil, scheduled_date: nil, voting_correct_index: nil, voting_due: nil, voting_options: nil, voting_type: nil, request_options: {})
113
124
  # Some parameter documentations has been truncated, see
114
125
  # {Onlyfans::Models::PostUpdateParams} for more details.
115
126
  #
@@ -119,6 +130,8 @@ module Onlyfans
119
130
  #
120
131
  # @param text [String] The post text content
121
132
  #
133
+ # @param block_banned_words [Symbol, Onlyfans::Models::PostUpdateParams::BlockBannedWords] Screen `text` for OnlyFans banned words and block the update if any are found (r
134
+ #
122
135
  # @param expire_days [Integer] Number of days after which the post will expire. Between 1 and 30 days. Keep emp
123
136
  #
124
137
  # @param fund_raising_target_amount [Integer] Add a fundraising target to your post. If present, value must be at least 10.
@@ -148,6 +161,21 @@ module Onlyfans
148
161
  #
149
162
  # @param request_options [Onlyfans::RequestOptions, Hash{Symbol=>Object}]
150
163
 
164
+ # Screen `text` for OnlyFans banned words and block the update if any are found
165
+ # (returns a 422 listing the offending words). `strict_ban` blocks all tiers,
166
+ # `risky` blocks Risky + Replace/soften, `replace_soften` blocks Replace/soften
167
+ # only. Omit to disable screening.
168
+ module BlockBannedWords
169
+ extend Onlyfans::Internal::Type::Enum
170
+
171
+ STRICT_BAN = :strict_ban
172
+ RISKY = :risky
173
+ REPLACE_SOFTEN = :replace_soften
174
+
175
+ # @!method self.values
176
+ # @return [Array<Symbol>]
177
+ end
178
+
151
179
  # Include a poll or quiz within your post.
152
180
  module VotingType
153
181
  extend Onlyfans::Internal::Type::Enum
@@ -12,46 +12,67 @@ module Onlyfans
12
12
  # @return [String]
13
13
  required :account, String
14
14
 
15
- # @!attribute limit
16
- # Maximum number of queue items to return (default = 20)
17
- #
18
- # @return [Integer]
19
- required :limit, Integer
20
-
21
15
  # @!attribute publish_date_end
22
- # Latest publish date to return
16
+ # Latest publish date to return. Must be a valid date. Must be a valid date. Must
17
+ # be a date after or equal to <code>publishDateStart</code>.
23
18
  #
24
19
  # @return [String]
25
20
  required :publish_date_end, String
26
21
 
27
22
  # @!attribute publish_date_start
28
- # Earliest publish date to return (must be at least today)
23
+ # Earliest publish date to return (must be at least today). Must be a valid date.
24
+ # Must be a valid date. Must be a date after or equal to <code>today</code>.
29
25
  #
30
26
  # @return [String]
31
27
  required :publish_date_start, String
32
28
 
33
29
  # @!attribute timezone
34
- # Time timezone of the provided dates.
35
- # [View available timezone values](https://www.php.net/manual/en/timezones.php)
30
+ # Timezone of the provided dates.
31
+ # [View available timezone values](https://www.php.net/manual/en/timezones.php).
32
+ # Must be a valid time zone, such as <code>Africa/Accra</code>.
36
33
  #
37
34
  # @return [String]
38
35
  required :timezone, String
39
36
 
40
- # @!method initialize(account:, limit:, publish_date_end:, publish_date_start:, timezone:, request_options: {})
37
+ # @!attribute limit
38
+ # Maximum number of queue items to return (default 20). Must be at least 1. Must
39
+ # not be greater than 100.
40
+ #
41
+ # @return [Integer, nil]
42
+ optional :limit, Integer
43
+
44
+ # @!attribute type
45
+ #
46
+ # @return [Array<Symbol, Onlyfans::Models::QueueListParams::Type>, nil]
47
+ optional :type, -> { Onlyfans::Internal::Type::ArrayOf[enum: Onlyfans::QueueListParams::Type] }
48
+
49
+ # @!method initialize(account:, publish_date_end:, publish_date_start:, timezone:, limit: nil, type: nil, request_options: {})
41
50
  # Some parameter documentations has been truncated, see
42
51
  # {Onlyfans::Models::QueueListParams} for more details.
43
52
  #
44
53
  # @param account [String]
45
54
  #
46
- # @param limit [Integer] Maximum number of queue items to return (default = 20)
55
+ # @param publish_date_end [String] Latest publish date to return. Must be a valid date. Must be a valid date. Must
56
+ #
57
+ # @param publish_date_start [String] Earliest publish date to return (must be at least today). Must be a valid date.
47
58
  #
48
- # @param publish_date_end [String] Latest publish date to return
59
+ # @param timezone [String] Timezone of the provided dates. [View available timezone values](https://www.php
49
60
  #
50
- # @param publish_date_start [String] Earliest publish date to return (must be at least today)
61
+ # @param limit [Integer] Maximum number of queue items to return (default 20). Must be at least 1. Must n
51
62
  #
52
- # @param timezone [String] Time timezone of the provided dates. [View available timezone values](https://ww
63
+ # @param type [Array<Symbol, Onlyfans::Models::QueueListParams::Type>]
53
64
  #
54
65
  # @param request_options [Onlyfans::RequestOptions, Hash{Symbol=>Object}]
66
+
67
+ module Type
68
+ extend Onlyfans::Internal::Type::Enum
69
+
70
+ CHAT = :chat
71
+ POST = :post
72
+
73
+ # @!method self.values
74
+ # @return [Array<Symbol>]
75
+ end
55
76
  end
56
77
  end
57
78
  end
@@ -123,25 +123,25 @@ module Onlyfans
123
123
  # @return [String, nil]
124
124
  optional :next_page, String
125
125
 
126
- # @!method initialize(next_page: nil)
126
+ # @!attribute notice
127
+ #
128
+ # @return [String, nil]
129
+ optional :notice, String
130
+
131
+ # @!method initialize(next_page: nil, notice: nil)
127
132
  # @param next_page [String]
133
+ # @param notice [String]
128
134
  end
129
135
 
130
136
  # @see Onlyfans::Models::ReleaseFormListTaggableUsersResponse#data
131
137
  class Data < Onlyfans::Internal::Type::BaseModel
132
- # @!attribute has_more
133
- #
134
- # @return [Boolean, nil]
135
- optional :has_more, Onlyfans::Internal::Type::Boolean, api_name: :hasMore
136
-
137
138
  # @!attribute items
138
139
  #
139
140
  # @return [Array<Onlyfans::Models::ReleaseFormListTaggableUsersResponse::Data::Item>, nil]
140
141
  optional :items,
141
142
  -> { Onlyfans::Internal::Type::ArrayOf[Onlyfans::Models::ReleaseFormListTaggableUsersResponse::Data::Item] }
142
143
 
143
- # @!method initialize(has_more: nil, items: nil)
144
- # @param has_more [Boolean]
144
+ # @!method initialize(items: nil)
145
145
  # @param items [Array<Onlyfans::Models::ReleaseFormListTaggableUsersResponse::Data::Item>]
146
146
 
147
147
  class Item < Onlyfans::Internal::Type::BaseModel
@@ -13,38 +13,103 @@ module Onlyfans
13
13
  required :account, String
14
14
 
15
15
  # @!attribute limit
16
- # The number of shared tracking links to return. Default `10`
16
+ # The number of shared tracking links to return. Default `10`. Must be at least 1.
17
+ # Must not be greater than 100.
17
18
  #
18
19
  # @return [Integer, nil]
19
20
  optional :limit, Integer
20
21
 
21
22
  # @!attribute offset
22
- # The offset used for pagination. Default `0`
23
+ # The offset used for pagination. Default `0`. Must be at least 0.
23
24
  #
24
25
  # @return [Integer, nil]
25
26
  optional :offset, Integer
26
27
 
28
+ # @!attribute pagination
29
+ # Whether pagination metadata is enabled. Default `1`.
30
+ #
31
+ # @return [Integer, Onlyfans::Models::SharedTrackingLinkListParams::Pagination, nil]
32
+ optional :pagination, enum: -> { Onlyfans::SharedTrackingLinkListParams::Pagination }
33
+
34
+ # @!attribute sorting_deleted
35
+ # Whether deleted links participate in sorting. Default `1`.
36
+ #
37
+ # @return [Integer, Onlyfans::Models::SharedTrackingLinkListParams::SortingDeleted, nil]
38
+ optional :sorting_deleted, enum: -> { Onlyfans::SharedTrackingLinkListParams::SortingDeleted }
39
+
40
+ # @!attribute stats
41
+ # Whether statistics are included. Default `true`. Must not be greater than 10
42
+ # characters.
43
+ #
44
+ # @return [String, nil]
45
+ optional :stats, String
46
+
27
47
  # @!attribute synchronous
28
- # Wait for the database sync to finish, instead of running it in the background.
29
- # **Will result in longer response times, use with caution**. Default `false`
48
+ # Wait for the database sync instead of processing it in the background.
30
49
  #
31
50
  # @return [Boolean, nil]
32
- optional :synchronous, Onlyfans::Internal::Type::Boolean, nil?: true
51
+ optional :synchronous, Onlyfans::Internal::Type::Boolean
33
52
 
34
- # @!method initialize(account:, limit: nil, offset: nil, synchronous: nil, request_options: {})
53
+ # @!attribute with_deleted
54
+ # Whether to include deleted shared tracking links. Default `1`.
55
+ #
56
+ # @return [Integer, Onlyfans::Models::SharedTrackingLinkListParams::WithDeleted, nil]
57
+ optional :with_deleted, enum: -> { Onlyfans::SharedTrackingLinkListParams::WithDeleted }
58
+
59
+ # @!method initialize(account:, limit: nil, offset: nil, pagination: nil, sorting_deleted: nil, stats: nil, synchronous: nil, with_deleted: nil, request_options: {})
35
60
  # Some parameter documentations has been truncated, see
36
61
  # {Onlyfans::Models::SharedTrackingLinkListParams} for more details.
37
62
  #
38
63
  # @param account [String]
39
64
  #
40
- # @param limit [Integer] The number of shared tracking links to return. Default `10`
65
+ # @param limit [Integer] The number of shared tracking links to return. Default `10`. Must be at least 1.
66
+ #
67
+ # @param offset [Integer] The offset used for pagination. Default `0`. Must be at least 0.
68
+ #
69
+ # @param pagination [Integer, Onlyfans::Models::SharedTrackingLinkListParams::Pagination] Whether pagination metadata is enabled. Default `1`.
70
+ #
71
+ # @param sorting_deleted [Integer, Onlyfans::Models::SharedTrackingLinkListParams::SortingDeleted] Whether deleted links participate in sorting. Default `1`.
41
72
  #
42
- # @param offset [Integer] The offset used for pagination. Default `0`
73
+ # @param stats [String] Whether statistics are included. Default `true`. Must not be greater than 10 cha
43
74
  #
44
- # @param synchronous [Boolean, nil] Wait for the database sync to finish, instead of running it in the
45
- # background. \*
75
+ # @param synchronous [Boolean] Wait for the database sync instead of processing it in the background.
76
+ #
77
+ # @param with_deleted [Integer, Onlyfans::Models::SharedTrackingLinkListParams::WithDeleted] Whether to include deleted shared tracking links. Default `1`.
46
78
  #
47
79
  # @param request_options [Onlyfans::RequestOptions, Hash{Symbol=>Object}]
80
+
81
+ # Whether pagination metadata is enabled. Default `1`.
82
+ module Pagination
83
+ extend Onlyfans::Internal::Type::Enum
84
+
85
+ PAGINATION_0 = 0
86
+ PAGINATION_1 = 1
87
+
88
+ # @!method self.values
89
+ # @return [Array<Integer>]
90
+ end
91
+
92
+ # Whether deleted links participate in sorting. Default `1`.
93
+ module SortingDeleted
94
+ extend Onlyfans::Internal::Type::Enum
95
+
96
+ SORTING_DELETED_0 = 0
97
+ SORTING_DELETED_1 = 1
98
+
99
+ # @!method self.values
100
+ # @return [Array<Integer>]
101
+ end
102
+
103
+ # Whether to include deleted shared tracking links. Default `1`.
104
+ module WithDeleted
105
+ extend Onlyfans::Internal::Type::Enum
106
+
107
+ WITH_DELETED_0 = 0
108
+ WITH_DELETED_1 = 1
109
+
110
+ # @!method self.values
111
+ # @return [Array<Integer>]
112
+ end
48
113
  end
49
114
  end
50
115
  end
@@ -13,38 +13,54 @@ module Onlyfans
13
13
  required :account, String
14
14
 
15
15
  # @!attribute limit
16
- # The number of shared trial links to return. Default `10`
16
+ # The number of shared trial links to return. Default `10`. Must be at least 1.
17
+ # Must not be greater than 100.
17
18
  #
18
19
  # @return [Integer, nil]
19
20
  optional :limit, Integer
20
21
 
21
22
  # @!attribute offset
22
- # The offset used for pagination. Default `0`
23
+ # The offset used for pagination. Default `0`. Must be at least 0.
23
24
  #
24
25
  # @return [Integer, nil]
25
26
  optional :offset, Integer
26
27
 
28
+ # @!attribute pagination
29
+ #
30
+ # @return [Integer, Onlyfans::Models::SharedTrialLinkListParams::Pagination, nil]
31
+ optional :pagination, enum: -> { Onlyfans::SharedTrialLinkListParams::Pagination }
32
+
27
33
  # @!attribute synchronous
28
- # Wait for the database sync to finish, instead of running it in the background.
29
- # **Will result in longer response times, use with caution**. Default `false`
34
+ # Wait for the database sync instead of processing it in the background.
30
35
  #
31
36
  # @return [Boolean, nil]
32
- optional :synchronous, Onlyfans::Internal::Type::Boolean, nil?: true
37
+ optional :synchronous, Onlyfans::Internal::Type::Boolean
33
38
 
34
- # @!method initialize(account:, limit: nil, offset: nil, synchronous: nil, request_options: {})
39
+ # @!method initialize(account:, limit: nil, offset: nil, pagination: nil, synchronous: nil, request_options: {})
35
40
  # Some parameter documentations has been truncated, see
36
41
  # {Onlyfans::Models::SharedTrialLinkListParams} for more details.
37
42
  #
38
43
  # @param account [String]
39
44
  #
40
- # @param limit [Integer] The number of shared trial links to return. Default `10`
45
+ # @param limit [Integer] The number of shared trial links to return. Default `10`. Must be at least 1. Mu
46
+ #
47
+ # @param offset [Integer] The offset used for pagination. Default `0`. Must be at least 0.
41
48
  #
42
- # @param offset [Integer] The offset used for pagination. Default `0`
49
+ # @param pagination [Integer, Onlyfans::Models::SharedTrialLinkListParams::Pagination]
43
50
  #
44
- # @param synchronous [Boolean, nil] Wait for the database sync to finish, instead of running it in the
45
- # background. \*
51
+ # @param synchronous [Boolean] Wait for the database sync instead of processing it in the background.
46
52
  #
47
53
  # @param request_options [Onlyfans::RequestOptions, Hash{Symbol=>Object}]
54
+
55
+ module Pagination
56
+ extend Onlyfans::Internal::Type::Enum
57
+
58
+ PAGINATION_0 = 0
59
+ PAGINATION_1 = 1
60
+
61
+ # @!method self.values
62
+ # @return [Array<Integer>]
63
+ end
48
64
  end
49
65
  end
50
66
  end
@@ -160,7 +160,7 @@ module Onlyfans
160
160
  # @!attribute revenue
161
161
  #
162
162
  # @return [String, nil]
163
- optional :revenue, String, nil?: true
163
+ optional :revenue, String
164
164
 
165
165
  # @!attribute subscribers_count
166
166
  #
@@ -187,7 +187,7 @@ module Onlyfans
187
187
  # @param free_trial_days [Integer]
188
188
  # @param link_type [String]
189
189
  # @param name [String]
190
- # @param revenue [String, nil]
190
+ # @param revenue [String]
191
191
  # @param subscribers_count [Integer]
192
192
  # @param traffic_redirect_url [String]
193
193
  # @param updated_at [String]
@@ -233,6 +233,11 @@ module Onlyfans
233
233
  # @return [String, nil]
234
234
  optional :fbclid, String, nil?: true
235
235
 
236
+ # @!attribute gbraid
237
+ #
238
+ # @return [String, nil]
239
+ optional :gbraid, String, nil?: true
240
+
236
241
  # @!attribute gclid
237
242
  #
238
243
  # @return [String, nil]
@@ -263,6 +268,11 @@ module Onlyfans
263
268
  # @return [String, nil]
264
269
  optional :referrer, String
265
270
 
271
+ # @!attribute sccid
272
+ #
273
+ # @return [String, nil]
274
+ optional :sccid, String, nil?: true
275
+
266
276
  # @!attribute ttclid
267
277
  #
268
278
  # @return [String, nil]
@@ -298,7 +308,12 @@ module Onlyfans
298
308
  # @return [String, nil]
299
309
  optional :utm_term, String
300
310
 
301
- # @!method initialize(id: nil, aff_s1: nil, aff_s2: nil, aff_s3: nil, aff_s4: nil, aff_s5: nil, browser_device_type: nil, browser_family: nil, browser_name: nil, browser_platform: nil, country_code: nil, created_at: nil, external_click_id: nil, fbclid: nil, gclid: nil, gross_clicks: nil, ip_address: nil, is_bot: nil, is_duplicate: nil, referrer: nil, ttclid: nil, user_agent: nil, utm_campaign: nil, utm_content: nil, utm_medium: nil, utm_source: nil, utm_term: nil)
311
+ # @!attribute wbraid
312
+ #
313
+ # @return [String, nil]
314
+ optional :wbraid, String, nil?: true
315
+
316
+ # @!method initialize(id: nil, aff_s1: nil, aff_s2: nil, aff_s3: nil, aff_s4: nil, aff_s5: nil, browser_device_type: nil, browser_family: nil, browser_name: nil, browser_platform: nil, country_code: nil, created_at: nil, external_click_id: nil, fbclid: nil, gbraid: nil, gclid: nil, gross_clicks: nil, ip_address: nil, is_bot: nil, is_duplicate: nil, referrer: nil, sccid: nil, ttclid: nil, user_agent: nil, utm_campaign: nil, utm_content: nil, utm_medium: nil, utm_source: nil, utm_term: nil, wbraid: nil)
302
317
  # @param id [String]
303
318
  # @param aff_s1 [String]
304
319
  # @param aff_s2 [String, nil]
@@ -313,12 +328,14 @@ module Onlyfans
313
328
  # @param created_at [String]
314
329
  # @param external_click_id [String]
315
330
  # @param fbclid [String, nil]
331
+ # @param gbraid [String, nil]
316
332
  # @param gclid [String]
317
333
  # @param gross_clicks [Integer]
318
334
  # @param ip_address [String]
319
335
  # @param is_bot [Boolean]
320
336
  # @param is_duplicate [Boolean]
321
337
  # @param referrer [String]
338
+ # @param sccid [String, nil]
322
339
  # @param ttclid [String]
323
340
  # @param user_agent [String]
324
341
  # @param utm_campaign [String]
@@ -326,6 +343,7 @@ module Onlyfans
326
343
  # @param utm_medium [String]
327
344
  # @param utm_source [String]
328
345
  # @param utm_term [String]
346
+ # @param wbraid [String, nil]
329
347
  end
330
348
 
331
349
  # @see Onlyfans::Models::SmartLinkListClicksResponse::Data#summary
@@ -88,6 +88,7 @@ module Onlyfans
88
88
  NEW_SUBSCRIBER = :new_subscriber
89
89
  NEW_TRANSACTION = :new_transaction
90
90
  MESSAGE_RECEIVED = :message_received
91
+ FAN_SENT_1_MESSAGE = :fan_sent_1_message
91
92
  FAN_SENT_3_MESSAGES = :fan_sent_3_messages
92
93
 
93
94
  # @!method self.values
@@ -291,6 +291,11 @@ module Onlyfans
291
291
  # @return [String, nil]
292
292
  optional :fbclid, String, nil?: true
293
293
 
294
+ # @!attribute gbraid
295
+ #
296
+ # @return [String, nil]
297
+ optional :gbraid, String, nil?: true
298
+
294
299
  # @!attribute gclid
295
300
  #
296
301
  # @return [String, nil]
@@ -321,6 +326,11 @@ module Onlyfans
321
326
  # @return [String, nil]
322
327
  optional :referrer, String
323
328
 
329
+ # @!attribute sccid
330
+ #
331
+ # @return [String, nil]
332
+ optional :sccid, String, nil?: true
333
+
324
334
  # @!attribute ttclid
325
335
  #
326
336
  # @return [String, nil]
@@ -356,7 +366,12 @@ module Onlyfans
356
366
  # @return [String, nil]
357
367
  optional :utm_term, String
358
368
 
359
- # @!method initialize(id: nil, aff_s1: nil, aff_s2: nil, aff_s3: nil, aff_s4: nil, aff_s5: nil, browser_device_type: nil, browser_family: nil, browser_name: nil, browser_platform: nil, country_code: nil, created_at: nil, external_click_id: nil, fbclid: nil, gclid: nil, gross_clicks: nil, ip_address: nil, is_bot: nil, is_duplicate: nil, referrer: nil, ttclid: nil, user_agent: nil, utm_campaign: nil, utm_content: nil, utm_medium: nil, utm_source: nil, utm_term: nil)
369
+ # @!attribute wbraid
370
+ #
371
+ # @return [String, nil]
372
+ optional :wbraid, String, nil?: true
373
+
374
+ # @!method initialize(id: nil, aff_s1: nil, aff_s2: nil, aff_s3: nil, aff_s4: nil, aff_s5: nil, browser_device_type: nil, browser_family: nil, browser_name: nil, browser_platform: nil, country_code: nil, created_at: nil, external_click_id: nil, fbclid: nil, gbraid: nil, gclid: nil, gross_clicks: nil, ip_address: nil, is_bot: nil, is_duplicate: nil, referrer: nil, sccid: nil, ttclid: nil, user_agent: nil, utm_campaign: nil, utm_content: nil, utm_medium: nil, utm_source: nil, utm_term: nil, wbraid: nil)
360
375
  # @param id [String]
361
376
  # @param aff_s1 [String]
362
377
  # @param aff_s2 [String, nil]
@@ -371,12 +386,14 @@ module Onlyfans
371
386
  # @param created_at [String]
372
387
  # @param external_click_id [String]
373
388
  # @param fbclid [String, nil]
389
+ # @param gbraid [String, nil]
374
390
  # @param gclid [String]
375
391
  # @param gross_clicks [Integer]
376
392
  # @param ip_address [String]
377
393
  # @param is_bot [Boolean]
378
394
  # @param is_duplicate [Boolean]
379
395
  # @param referrer [String]
396
+ # @param sccid [String, nil]
380
397
  # @param ttclid [String]
381
398
  # @param user_agent [String]
382
399
  # @param utm_campaign [String]
@@ -384,6 +401,7 @@ module Onlyfans
384
401
  # @param utm_medium [String]
385
402
  # @param utm_source [String]
386
403
  # @param utm_term [String]
404
+ # @param wbraid [String, nil]
387
405
  end
388
406
 
389
407
  # @see Onlyfans::Models::SmartLinkListConversionsResponse::Data::Row#fan