onlyfans 0.2.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +315 -0
- data/README.md +9 -4
- data/lib/onlyfans/client.rb +11 -3
- data/lib/onlyfans/internal/transport/base_client.rb +4 -1
- data/lib/onlyfans/models/analytics/financial/profitability_get_history_response.rb +114 -36
- data/lib/onlyfans/models/analytics/financial/profitability_get_profitability_response.rb +112 -46
- data/lib/onlyfans/models/authenticate_start_params.rb +1 -0
- data/lib/onlyfans/models/chat_list_media_params.rb +6 -2
- data/lib/onlyfans/models/chat_list_params.rb +8 -3
- data/lib/onlyfans/models/chats/message_list_params.rb +6 -6
- data/lib/onlyfans/models/chats/message_send_params.rb +41 -6
- data/lib/onlyfans/models/client_session_create_params.rb +1 -0
- data/lib/onlyfans/models/data_export_create_params.rb +36 -21
- data/lib/onlyfans/models/data_export_list_params.rb +5 -0
- data/lib/onlyfans/models/data_export_list_response.rb +7 -1
- data/lib/onlyfans/models/data_export_retrieve_response.rb +7 -1
- data/lib/onlyfans/models/engagement/message_get_message_buyers_params.rb +2 -2
- data/lib/onlyfans/models/engagement/message_get_top_message_params.rb +3 -3
- data/lib/onlyfans/models/engagement/messages/direct_message_chart_params.rb +2 -2
- data/lib/onlyfans/models/engagement/messages/direct_message_list_params.rb +3 -3
- data/lib/onlyfans/models/engagement/messages/mass_message_chart_params.rb +2 -2
- data/lib/onlyfans/models/engagement/messages/mass_message_list_params.rb +3 -3
- data/lib/onlyfans/models/fan_list_active_params.rb +55 -13
- data/lib/onlyfans/models/fan_list_all_params.rb +55 -13
- data/lib/onlyfans/models/fan_list_expired_params.rb +55 -13
- data/lib/onlyfans/models/fan_list_latest_params.rb +8 -8
- data/lib/onlyfans/models/fan_list_top_params.rb +6 -6
- data/lib/onlyfans/models/fans/summary_get_summary_response.rb +49 -2
- data/lib/onlyfans/models/following_list_active_params.rb +79 -1
- data/lib/onlyfans/models/following_list_all_params.rb +79 -1
- data/lib/onlyfans/models/following_list_expired_params.rb +79 -1
- data/lib/onlyfans/models/link_tag_list_params.rb +4 -3
- data/lib/onlyfans/models/mass_messaging_retrieve_overview_params.rb +3 -3
- data/lib/onlyfans/models/mass_messaging_send_params.rb +44 -6
- data/lib/onlyfans/models/mass_messaging_update_params.rb +34 -6
- data/lib/onlyfans/models/media/upload_get_status_response.rb +54 -27
- data/lib/onlyfans/models/media/vault/list_list_params.rb +14 -1
- data/lib/onlyfans/models/media/vault/list_list_response.rb +420 -202
- data/lib/onlyfans/models/media/vault/list_update_params.rb +11 -1
- data/lib/onlyfans/models/media/vault_upload_params.rb +3 -1
- data/lib/onlyfans/models/media_upload_params.rb +3 -1
- data/lib/onlyfans/models/notification_list_params.rb +3 -3
- data/lib/onlyfans/models/post_create_params.rb +29 -1
- data/lib/onlyfans/models/post_update_params.rb +29 -1
- data/lib/onlyfans/models/queue_list_params.rb +36 -15
- data/lib/onlyfans/models/release_form_list_taggable_users_response.rb +8 -8
- data/lib/onlyfans/models/shared_tracking_link_list_params.rb +75 -10
- data/lib/onlyfans/models/shared_trial_link_list_params.rb +26 -10
- data/lib/onlyfans/models/smart_link_create_response.rb +2 -2
- data/lib/onlyfans/models/smart_link_list_clicks_response.rb +19 -1
- data/lib/onlyfans/models/smart_link_list_conversions_params.rb +1 -0
- data/lib/onlyfans/models/smart_link_list_conversions_response.rb +19 -1
- data/lib/onlyfans/models/smart_link_list_fans_params.rb +21 -1
- data/lib/onlyfans/models/smart_link_list_fans_response.rb +99 -3
- data/lib/onlyfans/models/smart_link_list_params.rb +27 -9
- data/lib/onlyfans/models/smart_link_postback_create_params.rb +66 -4
- data/lib/onlyfans/models/smart_link_postback_create_response.rb +48 -1
- data/lib/onlyfans/models/smart_link_postback_list_response.rb +48 -1
- data/lib/onlyfans/models/smart_link_postback_retrieve_response.rb +48 -1
- data/lib/onlyfans/models/smart_link_postback_update_params.rb +65 -1
- data/lib/onlyfans/models/smart_link_postback_update_response.rb +48 -1
- data/lib/onlyfans/models/statistic_calculate_total_transactions_params.rb +5 -5
- data/lib/onlyfans/models/statistic_get_subscriber_metrics_params.rb +25 -1
- data/lib/onlyfans/models/statistics/reach_get_profile_visitors_params.rb +2 -2
- data/lib/onlyfans/models/statistics/statement_get_earnings_params.rb +10 -10
- data/lib/onlyfans/models/stored_list_tracking_links_response.rb +7 -1
- data/lib/onlyfans/models/stored_list_trial_links_response.rb +7 -1
- data/lib/onlyfans/models/story_create_params.rb +293 -6
- data/lib/onlyfans/models/story_create_response.rb +330 -7
- data/lib/onlyfans/models/tracking_link_get_stats_response.rb +7 -1
- data/lib/onlyfans/models/tracking_link_list_params.rb +58 -30
- data/lib/onlyfans/models/tracking_link_list_response.rb +7 -1
- data/lib/onlyfans/models/tracking_link_list_spenders_response.rb +7 -1
- data/lib/onlyfans/models/tracking_link_retrieve_response.rb +7 -1
- data/lib/onlyfans/models/transaction_list_params.rb +2 -2
- data/lib/onlyfans/models/trial_link_list_params.rb +44 -27
- data/lib/onlyfans/models/trial_link_list_response.rb +7 -1
- data/lib/onlyfans/models/trial_link_list_spenders_response.rb +7 -1
- data/lib/onlyfans/models/trial_link_retrieve_response.rb +7 -1
- data/lib/onlyfans/models/trial_link_retrieve_stats_response.rb +7 -1
- data/lib/onlyfans/models/user_list_list_params.rb +21 -1
- data/lib/onlyfans/models/user_lists/user_add_params.rb +18 -1
- data/lib/onlyfans/models/user_lists/user_add_response.rb +246 -88
- data/lib/onlyfans/models/webhook_create_params.rb +11 -7
- data/lib/onlyfans/models/webhook_update_params.rb +11 -7
- data/lib/onlyfans/models.rb +0 -2
- data/lib/onlyfans/resources/analytics/financial/profitability.rb +4 -4
- data/lib/onlyfans/resources/chats/messages.rb +47 -8
- data/lib/onlyfans/resources/chats.rb +7 -4
- data/lib/onlyfans/resources/data_exports.rb +1 -1
- data/lib/onlyfans/resources/engagement/messages/direct_messages.rb +2 -2
- data/lib/onlyfans/resources/engagement/messages/mass_messages.rb +2 -2
- data/lib/onlyfans/resources/engagement/messages.rb +2 -2
- data/lib/onlyfans/resources/fans.rb +43 -10
- data/lib/onlyfans/resources/following.rb +58 -12
- data/lib/onlyfans/resources/link_tags.rb +4 -4
- data/lib/onlyfans/resources/mass_messaging.rb +18 -9
- data/lib/onlyfans/resources/media/uploads.rb +6 -1
- data/lib/onlyfans/resources/media/vault/lists.rb +30 -5
- data/lib/onlyfans/resources/media.rb +14 -8
- data/lib/onlyfans/resources/messages.rb +0 -39
- data/lib/onlyfans/resources/notifications.rb +1 -1
- data/lib/onlyfans/resources/posts.rb +6 -2
- data/lib/onlyfans/resources/queue.rb +9 -6
- data/lib/onlyfans/resources/release_forms.rb +2 -1
- data/lib/onlyfans/resources/shared_tracking_links.rb +12 -5
- data/lib/onlyfans/resources/shared_trial_links.rb +6 -5
- data/lib/onlyfans/resources/smart_link_postbacks.rb +18 -3
- data/lib/onlyfans/resources/smart_links.rb +13 -4
- data/lib/onlyfans/resources/statistics/reach.rb +1 -1
- data/lib/onlyfans/resources/statistics/statements.rb +3 -3
- data/lib/onlyfans/resources/statistics.rb +5 -3
- data/lib/onlyfans/resources/stories.rb +13 -6
- data/lib/onlyfans/resources/tracking_links/tags.rb +5 -1
- data/lib/onlyfans/resources/tracking_links.rb +21 -11
- data/lib/onlyfans/resources/transactions.rb +1 -1
- data/lib/onlyfans/resources/trial_links/tags.rb +5 -1
- data/lib/onlyfans/resources/trial_links.rb +22 -10
- data/lib/onlyfans/resources/user_lists/users.rb +7 -2
- data/lib/onlyfans/resources/user_lists.rb +5 -2
- data/lib/onlyfans/resources/users.rb +4 -1
- data/lib/onlyfans/resources/webhooks.rb +6 -4
- data/lib/onlyfans/version.rb +1 -1
- data/lib/onlyfans.rb +0 -3
- data/rbi/onlyfans/client.rbi +11 -3
- data/rbi/onlyfans/models/analytics/financial/profitability_get_history_response.rbi +203 -63
- data/rbi/onlyfans/models/analytics/financial/profitability_get_profitability_response.rbi +201 -79
- data/rbi/onlyfans/models/authenticate_start_params.rbi +5 -0
- data/rbi/onlyfans/models/chat_list_media_params.rbi +4 -2
- data/rbi/onlyfans/models/chat_list_params.rbi +6 -3
- data/rbi/onlyfans/models/chats/message_list_params.rbi +8 -8
- data/rbi/onlyfans/models/chats/message_send_params.rbi +88 -6
- data/rbi/onlyfans/models/client_session_create_params.rbi +5 -0
- data/rbi/onlyfans/models/data_export_create_params.rbi +69 -37
- data/rbi/onlyfans/models/data_export_list_params.rbi +18 -0
- data/rbi/onlyfans/models/data_export_list_response.rbi +9 -0
- data/rbi/onlyfans/models/data_export_retrieve_response.rbi +9 -0
- data/rbi/onlyfans/models/engagement/message_get_message_buyers_params.rbi +2 -2
- data/rbi/onlyfans/models/engagement/message_get_top_message_params.rbi +4 -4
- data/rbi/onlyfans/models/engagement/messages/direct_message_chart_params.rbi +2 -2
- data/rbi/onlyfans/models/engagement/messages/direct_message_list_params.rbi +4 -4
- data/rbi/onlyfans/models/engagement/messages/mass_message_chart_params.rbi +2 -2
- data/rbi/onlyfans/models/engagement/messages/mass_message_list_params.rbi +4 -4
- data/rbi/onlyfans/models/fan_list_active_params.rbi +84 -13
- data/rbi/onlyfans/models/fan_list_all_params.rbi +84 -13
- data/rbi/onlyfans/models/fan_list_expired_params.rbi +84 -13
- data/rbi/onlyfans/models/fan_list_latest_params.rbi +10 -10
- data/rbi/onlyfans/models/fan_list_top_params.rbi +8 -8
- data/rbi/onlyfans/models/fans/summary_get_summary_response.rbi +96 -0
- data/rbi/onlyfans/models/following_list_active_params.rbi +160 -0
- data/rbi/onlyfans/models/following_list_all_params.rbi +155 -0
- data/rbi/onlyfans/models/following_list_expired_params.rbi +160 -0
- data/rbi/onlyfans/models/link_tag_list_params.rbi +5 -3
- data/rbi/onlyfans/models/mass_messaging_retrieve_overview_params.rbi +4 -4
- data/rbi/onlyfans/models/mass_messaging_send_params.rbi +91 -6
- data/rbi/onlyfans/models/mass_messaging_update_params.rbi +76 -6
- data/rbi/onlyfans/models/media/upload_get_status_response.rbi +79 -33
- data/rbi/onlyfans/models/media/vault/list_list_params.rbi +15 -0
- data/rbi/onlyfans/models/media/vault/list_list_response.rbi +972 -428
- data/rbi/onlyfans/models/media/vault/list_update_params.rbi +13 -1
- data/rbi/onlyfans/models/media/vault_upload_params.rbi +6 -2
- data/rbi/onlyfans/models/media_upload_params.rbi +6 -2
- data/rbi/onlyfans/models/notification_list_params.rbi +3 -3
- data/rbi/onlyfans/models/post_create_params.rbi +66 -0
- data/rbi/onlyfans/models/post_update_params.rbi +66 -0
- data/rbi/onlyfans/models/queue_list_params.rbi +59 -16
- data/rbi/onlyfans/models/release_form_list_taggable_users_response.rbi +12 -12
- data/rbi/onlyfans/models/shared_tracking_link_list_params.rbi +198 -11
- data/rbi/onlyfans/models/shared_trial_link_list_params.rbi +64 -11
- data/rbi/onlyfans/models/smart_link_create_response.rbi +6 -3
- data/rbi/onlyfans/models/smart_link_list_clicks_response.rbi +21 -3
- data/rbi/onlyfans/models/smart_link_list_conversions_params.rbi +5 -0
- data/rbi/onlyfans/models/smart_link_list_conversions_response.rbi +21 -3
- data/rbi/onlyfans/models/smart_link_list_fans_params.rbi +24 -0
- data/rbi/onlyfans/models/smart_link_list_fans_response.rbi +205 -3
- data/rbi/onlyfans/models/smart_link_list_params.rbi +45 -8
- data/rbi/onlyfans/models/smart_link_postback_create_params.rbi +139 -4
- data/rbi/onlyfans/models/smart_link_postback_create_response.rbi +96 -0
- data/rbi/onlyfans/models/smart_link_postback_list_response.rbi +96 -0
- data/rbi/onlyfans/models/smart_link_postback_retrieve_response.rbi +96 -0
- data/rbi/onlyfans/models/smart_link_postback_update_params.rbi +133 -0
- data/rbi/onlyfans/models/smart_link_postback_update_response.rbi +96 -0
- data/rbi/onlyfans/models/statistic_calculate_total_transactions_params.rbi +12 -6
- data/rbi/onlyfans/models/statistic_get_subscriber_metrics_params.rbi +63 -0
- data/rbi/onlyfans/models/statistics/reach_get_profile_visitors_params.rbi +2 -2
- data/rbi/onlyfans/models/statistics/statement_get_earnings_params.rbi +10 -13
- data/rbi/onlyfans/models/stored_list_tracking_links_response.rbi +9 -0
- data/rbi/onlyfans/models/stored_list_trial_links_response.rbi +9 -0
- data/rbi/onlyfans/models/story_create_params.rbi +548 -4
- data/rbi/onlyfans/models/story_create_response.rbi +670 -8
- data/rbi/onlyfans/models/tracking_link_get_stats_response.rbi +9 -0
- data/rbi/onlyfans/models/tracking_link_list_params.rbi +144 -45
- data/rbi/onlyfans/models/tracking_link_list_response.rbi +9 -0
- data/rbi/onlyfans/models/tracking_link_list_spenders_response.rbi +17 -5
- data/rbi/onlyfans/models/tracking_link_retrieve_response.rbi +9 -0
- data/rbi/onlyfans/models/transaction_list_params.rbi +2 -2
- data/rbi/onlyfans/models/trial_link_list_params.rbi +66 -33
- data/rbi/onlyfans/models/trial_link_list_response.rbi +9 -0
- data/rbi/onlyfans/models/trial_link_list_spenders_response.rbi +17 -5
- data/rbi/onlyfans/models/trial_link_retrieve_response.rbi +9 -0
- data/rbi/onlyfans/models/trial_link_retrieve_stats_response.rbi +9 -0
- data/rbi/onlyfans/models/user_list_list_params.rbi +33 -0
- data/rbi/onlyfans/models/user_lists/user_add_params.rbi +23 -0
- data/rbi/onlyfans/models/user_lists/user_add_response.rbi +596 -181
- data/rbi/onlyfans/models/webhook_create_params.rbi +16 -10
- data/rbi/onlyfans/models/webhook_update_params.rbi +16 -10
- data/rbi/onlyfans/models.rbi +0 -2
- data/rbi/onlyfans/resources/analytics/financial/profitability.rbi +2 -6
- data/rbi/onlyfans/resources/chats/messages.rbi +53 -10
- data/rbi/onlyfans/resources/chats.rbi +6 -5
- data/rbi/onlyfans/resources/data_exports.rbi +26 -17
- data/rbi/onlyfans/resources/engagement/messages/direct_messages.rbi +3 -3
- data/rbi/onlyfans/resources/engagement/messages/mass_messages.rbi +3 -3
- data/rbi/onlyfans/resources/engagement/messages.rbi +3 -3
- data/rbi/onlyfans/resources/fans.rbi +50 -17
- data/rbi/onlyfans/resources/following.rbi +122 -4
- data/rbi/onlyfans/resources/link_tags.rbi +4 -4
- data/rbi/onlyfans/resources/mass_messaging.rbi +32 -10
- data/rbi/onlyfans/resources/media/uploads.rbi +5 -0
- data/rbi/onlyfans/resources/media/vault/lists.rbi +28 -3
- data/rbi/onlyfans/resources/media/vault.rbi +3 -1
- data/rbi/onlyfans/resources/media.rbi +16 -7
- data/rbi/onlyfans/resources/messages.rbi +0 -29
- data/rbi/onlyfans/resources/notifications.rbi +1 -1
- data/rbi/onlyfans/resources/posts.rbi +14 -0
- data/rbi/onlyfans/resources/queue.rbi +15 -8
- data/rbi/onlyfans/resources/release_forms.rbi +2 -1
- data/rbi/onlyfans/resources/shared_tracking_links.rbi +21 -5
- data/rbi/onlyfans/resources/shared_trial_links.rbi +8 -5
- data/rbi/onlyfans/resources/smart_link_postbacks.rbi +27 -2
- data/rbi/onlyfans/resources/smart_links.rbi +12 -3
- data/rbi/onlyfans/resources/statistics/reach.rbi +1 -1
- data/rbi/onlyfans/resources/statistics/statements.rbi +4 -4
- data/rbi/onlyfans/resources/statistics.rbi +9 -2
- data/rbi/onlyfans/resources/stories.rbi +16 -3
- data/rbi/onlyfans/resources/tracking_links/tags.rbi +5 -1
- data/rbi/onlyfans/resources/tracking_links.rbi +30 -19
- data/rbi/onlyfans/resources/transactions.rbi +1 -1
- data/rbi/onlyfans/resources/trial_links/tags.rbi +5 -1
- data/rbi/onlyfans/resources/trial_links.rbi +29 -14
- data/rbi/onlyfans/resources/user_lists/users.rbi +10 -1
- data/rbi/onlyfans/resources/user_lists.rbi +6 -1
- data/rbi/onlyfans/resources/users.rbi +2 -1
- data/rbi/onlyfans/resources/webhooks.rbi +16 -10
- data/sig/onlyfans/models/analytics/financial/profitability_get_history_response.rbs +129 -40
- data/sig/onlyfans/models/analytics/financial/profitability_get_profitability_response.rbs +125 -50
- data/sig/onlyfans/models/authenticate_start_params.rbs +2 -1
- data/sig/onlyfans/models/chats/message_send_params.rbs +34 -6
- data/sig/onlyfans/models/client_session_create_params.rbs +2 -1
- data/sig/onlyfans/models/data_export_create_params.rbs +4 -0
- data/sig/onlyfans/models/data_export_list_params.rbs +10 -0
- data/sig/onlyfans/models/data_export_list_response.rbs +7 -0
- data/sig/onlyfans/models/data_export_retrieve_response.rbs +7 -0
- data/sig/onlyfans/models/fan_list_active_params.rbs +7 -0
- data/sig/onlyfans/models/fan_list_all_params.rbs +7 -0
- data/sig/onlyfans/models/fan_list_expired_params.rbs +7 -0
- data/sig/onlyfans/models/fans/summary_get_summary_response.rbs +53 -0
- data/sig/onlyfans/models/following_list_active_params.rbs +35 -1
- data/sig/onlyfans/models/following_list_all_params.rbs +35 -1
- data/sig/onlyfans/models/following_list_expired_params.rbs +35 -1
- data/sig/onlyfans/models/link_tag_list_params.rbs +2 -1
- data/sig/onlyfans/models/mass_messaging_send_params.rbs +33 -5
- data/sig/onlyfans/models/mass_messaging_update_params.rbs +26 -5
- data/sig/onlyfans/models/media/upload_get_status_response.rbs +65 -39
- data/sig/onlyfans/models/media/vault/list_list_params.rbs +13 -1
- data/sig/onlyfans/models/media/vault/list_list_response.rbs +519 -235
- data/sig/onlyfans/models/media/vault/list_update_params.rbs +5 -1
- data/sig/onlyfans/models/post_create_params.rbs +21 -0
- data/sig/onlyfans/models/post_update_params.rbs +21 -0
- data/sig/onlyfans/models/queue_list_params.rbs +28 -6
- data/sig/onlyfans/models/release_form_list_taggable_users_response.rbs +7 -10
- data/sig/onlyfans/models/shared_tracking_link_list_params.rbs +78 -4
- data/sig/onlyfans/models/shared_trial_link_list_params.rbs +31 -4
- data/sig/onlyfans/models/smart_link_create_response.rbs +6 -4
- data/sig/onlyfans/models/smart_link_list_clicks_response.rbs +18 -3
- data/sig/onlyfans/models/smart_link_list_conversions_params.rbs +2 -0
- data/sig/onlyfans/models/smart_link_list_conversions_response.rbs +18 -3
- data/sig/onlyfans/models/smart_link_list_fans_params.rbs +15 -1
- data/sig/onlyfans/models/smart_link_list_fans_response.rbs +125 -3
- data/sig/onlyfans/models/smart_link_list_params.rbs +27 -6
- data/sig/onlyfans/models/smart_link_postback_create_params.rbs +48 -0
- data/sig/onlyfans/models/smart_link_postback_create_response.rbs +53 -0
- data/sig/onlyfans/models/smart_link_postback_list_response.rbs +53 -0
- data/sig/onlyfans/models/smart_link_postback_retrieve_response.rbs +53 -0
- data/sig/onlyfans/models/smart_link_postback_update_params.rbs +48 -0
- data/sig/onlyfans/models/smart_link_postback_update_response.rbs +53 -0
- data/sig/onlyfans/models/statistic_calculate_total_transactions_params.rbs +8 -4
- data/sig/onlyfans/models/statistic_get_subscriber_metrics_params.rbs +23 -1
- data/sig/onlyfans/models/statistics/statement_get_earnings_params.rbs +5 -7
- data/sig/onlyfans/models/stored_list_tracking_links_response.rbs +7 -0
- data/sig/onlyfans/models/stored_list_trial_links_response.rbs +7 -0
- data/sig/onlyfans/models/story_create_params.rbs +271 -1
- data/sig/onlyfans/models/story_create_response.rbs +419 -9
- data/sig/onlyfans/models/tracking_link_get_stats_response.rbs +7 -0
- data/sig/onlyfans/models/tracking_link_list_params.rbs +75 -26
- data/sig/onlyfans/models/tracking_link_list_response.rbs +7 -0
- data/sig/onlyfans/models/tracking_link_list_spenders_response.rbs +16 -3
- data/sig/onlyfans/models/tracking_link_retrieve_response.rbs +7 -0
- data/sig/onlyfans/models/trial_link_list_params.rbs +42 -18
- data/sig/onlyfans/models/trial_link_list_response.rbs +7 -0
- data/sig/onlyfans/models/trial_link_list_spenders_response.rbs +16 -3
- data/sig/onlyfans/models/trial_link_retrieve_response.rbs +7 -0
- data/sig/onlyfans/models/trial_link_retrieve_stats_response.rbs +7 -0
- data/sig/onlyfans/models/user_list_list_params.rbs +24 -1
- data/sig/onlyfans/models/user_lists/user_add_params.rbs +12 -1
- data/sig/onlyfans/models/user_lists/user_add_response.rbs +300 -101
- data/sig/onlyfans/models.rbs +0 -2
- data/sig/onlyfans/resources/analytics/financial/profitability.rbs +2 -2
- data/sig/onlyfans/resources/chats/messages.rbs +3 -1
- data/sig/onlyfans/resources/following.rbs +6 -0
- data/sig/onlyfans/resources/mass_messaging.rbs +5 -2
- data/sig/onlyfans/resources/media/vault/lists.rbs +3 -1
- data/sig/onlyfans/resources/media.rbs +1 -1
- data/sig/onlyfans/resources/messages.rbs +0 -9
- data/sig/onlyfans/resources/posts.rbs +2 -0
- data/sig/onlyfans/resources/queue.rbs +2 -1
- data/sig/onlyfans/resources/shared_tracking_links.rbs +5 -1
- data/sig/onlyfans/resources/shared_trial_links.rbs +2 -1
- data/sig/onlyfans/resources/smart_link_postbacks.rbs +6 -0
- data/sig/onlyfans/resources/smart_links.rbs +4 -1
- data/sig/onlyfans/resources/statistics/statements.rbs +1 -1
- data/sig/onlyfans/resources/statistics.rbs +3 -2
- data/sig/onlyfans/resources/stories.rbs +4 -0
- data/sig/onlyfans/resources/tracking_links.rbs +7 -6
- data/sig/onlyfans/resources/trial_links.rbs +7 -5
- data/sig/onlyfans/resources/user_lists/users.rbs +2 -1
- data/sig/onlyfans/resources/user_lists.rbs +1 -0
- metadata +9 -15
- data/lib/onlyfans/models/media_download_response.rb +0 -7
- data/lib/onlyfans/models/message_attach_tags_params.rb +0 -52
- data/lib/onlyfans/models/message_attach_tags_response.rb +0 -125
- data/rbi/onlyfans/models/media_download_response.rbi +0 -7
- data/rbi/onlyfans/models/message_attach_tags_params.rbi +0 -80
- data/rbi/onlyfans/models/message_attach_tags_response.rbi +0 -308
- data/sig/onlyfans/models/media_download_response.rbs +0 -5
- data/sig/onlyfans/models/message_attach_tags_params.rbs +0 -52
- data/sig/onlyfans/models/message_attach_tags_response.rbs +0 -164
|
@@ -6,7 +6,8 @@ module Onlyfans
|
|
|
6
6
|
# Some parameter documentations has been truncated, see
|
|
7
7
|
# {Onlyfans::Models::MassMessagingRetrieveParams} for more details.
|
|
8
8
|
#
|
|
9
|
-
# Get the content of a mass message
|
|
9
|
+
# Get the content and settings of a mass message, including a message scheduled
|
|
10
|
+
# for later.
|
|
10
11
|
#
|
|
11
12
|
# @overload retrieve(id, account:, request_options: {})
|
|
12
13
|
#
|
|
@@ -36,9 +37,10 @@ module Onlyfans
|
|
|
36
37
|
# Some parameter documentations has been truncated, see
|
|
37
38
|
# {Onlyfans::Models::MassMessagingUpdateParams} for more details.
|
|
38
39
|
#
|
|
39
|
-
# Update
|
|
40
|
+
# Update the content, recipients, media, price, or scheduled send time of an
|
|
41
|
+
# existing mass message.
|
|
40
42
|
#
|
|
41
|
-
# @overload update(id, account:, text:, giphy_id: nil, locked_text: nil, media_files: nil, previews: nil, price: nil, scheduled_date: nil, user_ids: nil, user_lists: nil, request_options: {})
|
|
43
|
+
# @overload update(id, account:, text:, block_banned_words: nil, giphy_id: nil, locked_text: nil, media_files: nil, previews: nil, price: nil, scheduled_date: nil, user_ids: nil, user_lists: nil, request_options: {})
|
|
42
44
|
#
|
|
43
45
|
# @param id [String] Path param: The ID of the message queue item. Can be retrieved from the above st
|
|
44
46
|
#
|
|
@@ -46,6 +48,8 @@ module Onlyfans
|
|
|
46
48
|
#
|
|
47
49
|
# @param text [String] Body param: The message text content
|
|
48
50
|
#
|
|
51
|
+
# @param block_banned_words [Symbol, Onlyfans::Models::MassMessagingUpdateParams::BlockBannedWords] Body param: Screen `text` for OnlyFans banned words and block the update if any
|
|
52
|
+
#
|
|
49
53
|
# @param giphy_id [String] Body param: The ID of the Giphy GIF to attach to the message. Get IDs from the G
|
|
50
54
|
#
|
|
51
55
|
# @param locked_text [Boolean] Body param: Whether the text should be shown or hidden
|
|
@@ -54,7 +58,7 @@ module Onlyfans
|
|
|
54
58
|
#
|
|
55
59
|
# @param previews [Array<String>] Body param: Array of media file upload prefixed_ids, or OF media IDs (required i
|
|
56
60
|
#
|
|
57
|
-
# @param price [
|
|
61
|
+
# @param price [Float] Body param: Price for paid content in USD (0 or between 3-200). In case this is
|
|
58
62
|
#
|
|
59
63
|
# @param scheduled_date [String] Body param: Schedule the chat message in the future (UTC timezone).
|
|
60
64
|
#
|
|
@@ -82,7 +86,8 @@ module Onlyfans
|
|
|
82
86
|
)
|
|
83
87
|
end
|
|
84
88
|
|
|
85
|
-
# List
|
|
89
|
+
# List pending, scheduled, and recently sent mass messages. Use an item ID to
|
|
90
|
+
# retrieve, update, reschedule, delete, or unsend the message.
|
|
86
91
|
#
|
|
87
92
|
# @overload list(account, request_options: {})
|
|
88
93
|
#
|
|
@@ -142,7 +147,7 @@ module Onlyfans
|
|
|
142
147
|
#
|
|
143
148
|
# @param account [String] The Account ID
|
|
144
149
|
#
|
|
145
|
-
# @param end_date [String] The latest mass message to retrieve. Keep empty to get all.
|
|
150
|
+
# @param end_date [String] The latest mass message to retrieve. Keep empty to get all. It must be after `st
|
|
146
151
|
#
|
|
147
152
|
# @param limit [Integer] Number of mass messages to return (default = 10)
|
|
148
153
|
#
|
|
@@ -174,12 +179,14 @@ module Onlyfans
|
|
|
174
179
|
# `userIds` parameters to send the same message to both lists and individual
|
|
175
180
|
# users.
|
|
176
181
|
#
|
|
177
|
-
# @overload send_(account, text:, excluded_lists: nil, giphy_id: nil, locked_text: nil, media_files: nil, previews: nil, price: nil, rf_guest: nil, rf_partner: nil, rf_tag: nil, save_for_later: nil, scheduled_date: nil, user_ids: nil, user_lists: nil, request_options: {})
|
|
182
|
+
# @overload send_(account, text:, block_banned_words: nil, excluded_lists: nil, giphy_id: nil, locked_text: nil, media_files: nil, previews: nil, price: nil, rf_guest: nil, rf_partner: nil, rf_tag: nil, save_for_later: nil, scheduled_date: nil, subscribed_within_last_days: nil, user_ids: nil, user_lists: nil, request_options: {})
|
|
178
183
|
#
|
|
179
184
|
# @param account [String] The Account ID
|
|
180
185
|
#
|
|
181
186
|
# @param text [String] The message text content
|
|
182
187
|
#
|
|
188
|
+
# @param block_banned_words [Symbol, Onlyfans::Models::MassMessagingSendParams::BlockBannedWords] Screen `text` for OnlyFans banned words and block the send if any are found (ret
|
|
189
|
+
#
|
|
183
190
|
# @param excluded_lists [Array<String>] Array of user list IDs that the mass message will NOT be sent to.
|
|
184
191
|
#
|
|
185
192
|
# @param giphy_id [String] The ID of the Giphy GIF to attach to the message. Get IDs from the Giphy listing
|
|
@@ -190,8 +197,8 @@ module Onlyfans
|
|
|
190
197
|
#
|
|
191
198
|
# @param previews [Array<Object>] Direct file uploads, OFAPI `ofapi_media_` IDs, OF vault IDs, or integer indices
|
|
192
199
|
#
|
|
193
|
-
# @param price [
|
|
194
|
-
# \*\*
|
|
200
|
+
# @param price [Float] Price for paid content in USD (0 or between 3-200). In case this is not zero,
|
|
201
|
+
# \*\*
|
|
195
202
|
#
|
|
196
203
|
# @param rf_guest [String] Array of OnlyFans Release Form Guest IDs to tag in your mass message
|
|
197
204
|
#
|
|
@@ -203,6 +210,8 @@ module Onlyfans
|
|
|
203
210
|
#
|
|
204
211
|
# @param scheduled_date [String] Schedule the chat message in the future (UTC timezone).
|
|
205
212
|
#
|
|
213
|
+
# @param subscribed_within_last_days [Integer] Only send to fans who subscribed within the last N calendar days (1-30, includin
|
|
214
|
+
#
|
|
206
215
|
# @param user_ids [Array<String>] Array of user IDs that the mass message will be sent to.
|
|
207
216
|
#
|
|
208
217
|
# @param user_lists [Array<String>] Array of user list IDs that the mass message will be sent to.
|
|
@@ -14,6 +14,11 @@ module Onlyfans
|
|
|
14
14
|
# - `completed` — Upload finished, `media` and `credits_used` are included
|
|
15
15
|
# - `failed` — Upload failed, `error` is included
|
|
16
16
|
#
|
|
17
|
+
# Instead of polling, you can subscribe to the `media_uploads.completed` and
|
|
18
|
+
# `media_uploads.failed` webhook events. They carry the same fields as this
|
|
19
|
+
# endpoint and are only sent for async (`async=true`) uploads — synchronous
|
|
20
|
+
# uploads return their result directly.
|
|
21
|
+
#
|
|
17
22
|
# @overload get_status(upload, account:, request_options: {})
|
|
18
23
|
#
|
|
19
24
|
# @param upload [String] The prefixed ID of the upload.
|
|
@@ -22,7 +27,7 @@ module Onlyfans
|
|
|
22
27
|
#
|
|
23
28
|
# @param request_options [Onlyfans::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
24
29
|
#
|
|
25
|
-
# @return [Onlyfans::Models::Media::UploadGetStatusResponse::UnionMember0, Onlyfans::Models::Media::UploadGetStatusResponse::UnionMember1, Onlyfans::Models::Media::UploadGetStatusResponse::UnionMember2, Onlyfans::Models::Media::UploadGetStatusResponse::UnionMember3]
|
|
30
|
+
# @return [Onlyfans::Models::Media::UploadGetStatusResponse::UnionMember0, Onlyfans::Models::Media::UploadGetStatusResponse::UnionMember1, Onlyfans::Models::Media::UploadGetStatusResponse::UnionMember2, Onlyfans::Models::Media::UploadGetStatusResponse::UnionMember3, Onlyfans::Models::Media::UploadGetStatusResponse::UnionMember4]
|
|
26
31
|
#
|
|
27
32
|
# @see Onlyfans::Models::Media::UploadGetStatusParams
|
|
28
33
|
def get_status(upload, params)
|
|
@@ -59,13 +59,18 @@ module Onlyfans
|
|
|
59
59
|
)
|
|
60
60
|
end
|
|
61
61
|
|
|
62
|
+
# Some parameter documentations has been truncated, see
|
|
63
|
+
# {Onlyfans::Models::Media::Vault::ListUpdateParams} for more details.
|
|
64
|
+
#
|
|
62
65
|
# Rename a Vault list.
|
|
63
66
|
#
|
|
64
|
-
# @overload update(list_id, account:, request_options: {})
|
|
67
|
+
# @overload update(list_id, account:, name:, request_options: {})
|
|
65
68
|
#
|
|
66
|
-
# @param list_id [String] The ID of the list
|
|
69
|
+
# @param list_id [String] Path param: The ID of the list
|
|
67
70
|
#
|
|
68
|
-
# @param account [String] The Account ID
|
|
71
|
+
# @param account [String] Path param: The Account ID
|
|
72
|
+
#
|
|
73
|
+
# @param name [String] Body param: The new name for the vault list. Must not be greater than 255 charac
|
|
69
74
|
#
|
|
70
75
|
# @param request_options [Onlyfans::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
71
76
|
#
|
|
@@ -81,17 +86,37 @@ module Onlyfans
|
|
|
81
86
|
@client.request(
|
|
82
87
|
method: :put,
|
|
83
88
|
path: ["api/%1$s/media/vault/lists/%2$s", account, list_id],
|
|
89
|
+
body: parsed,
|
|
84
90
|
model: Onlyfans::Models::Media::Vault::ListUpdateResponse,
|
|
85
91
|
options: options
|
|
86
92
|
)
|
|
87
93
|
end
|
|
88
94
|
|
|
95
|
+
# Some parameter documentations has been truncated, see
|
|
96
|
+
# {Onlyfans::Models::Media::Vault::ListListParams} for more details.
|
|
97
|
+
#
|
|
89
98
|
# List your Vault lists (categories).
|
|
90
99
|
#
|
|
91
|
-
#
|
|
100
|
+
# Every response carries an `ETag` computed over the `data` payload. Send it back
|
|
101
|
+
# as `If-None-Match` on your next call and you will get a `304 Not Modified` with
|
|
102
|
+
# an empty body when nothing changed, so you can keep serving your cached copy
|
|
103
|
+
# instead of re-parsing the full list. Credits are debited either way — we still
|
|
104
|
+
# have to ask OnlyFans for the current state to know whether it changed.
|
|
105
|
+
#
|
|
106
|
+
# The `ETag` covers `data` only, never `_meta` — your credits balance changes on
|
|
107
|
+
# every call, so including it would mean the `ETag` never matches. Because a `304`
|
|
108
|
+
# has no body, it also has no `_meta`: read the current credits and rate-limit
|
|
109
|
+
# counters from the `X-OFAPI-Credits-Used`, `X-OFAPI-Credits-Balance`,
|
|
110
|
+
# `X-Rate-Limit-Limit-Minute` and `X-Rate-Limit-Remaining-Minute` response
|
|
111
|
+
# headers, which are sent on `304` responses too. The `_meta` inside a body you
|
|
112
|
+
# cached earlier is stale by definition.
|
|
113
|
+
#
|
|
114
|
+
# @overload list(account, lightweight: nil, limit: nil, offset: nil, query: nil, request_options: {})
|
|
92
115
|
#
|
|
93
116
|
# @param account [String] The Account ID
|
|
94
117
|
#
|
|
118
|
+
# @param lightweight [Boolean] Set to `true` to return only `id`, `name`, `type`, `canUpdate` and a rolled-up `
|
|
119
|
+
#
|
|
95
120
|
# @param limit [Integer] Number of media to return per page. Default: `24`
|
|
96
121
|
#
|
|
97
122
|
# @param offset [Integer] The offset used for pagination. Default `0`
|
|
@@ -100,7 +125,7 @@ module Onlyfans
|
|
|
100
125
|
#
|
|
101
126
|
# @param request_options [Onlyfans::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
102
127
|
#
|
|
103
|
-
# @return [Onlyfans::Models::Media::Vault::ListListResponse]
|
|
128
|
+
# @return [Onlyfans::Models::Media::Vault::ListListResponse::UnionMember0, Onlyfans::Models::Media::Vault::ListListResponse::UnionMember1]
|
|
104
129
|
#
|
|
105
130
|
# @see Onlyfans::Models::Media::Vault::ListListParams
|
|
106
131
|
def list(account, params = {})
|
|
@@ -12,11 +12,18 @@ module Onlyfans
|
|
|
12
12
|
# Some parameter documentations has been truncated, see
|
|
13
13
|
# {Onlyfans::Models::MediaDownloadParams} for more details.
|
|
14
14
|
#
|
|
15
|
-
# Downloads a file
|
|
16
|
-
#
|
|
17
|
-
# `
|
|
18
|
-
#
|
|
19
|
-
#
|
|
15
|
+
# Downloads a file from a `https://cdn*.onlyfans.com/*` URL through a `302`
|
|
16
|
+
# redirect. Follow redirects (`curl -L`). Cached `cdn.fansapi.com` files are free;
|
|
17
|
+
# otherwise `dl.fansapi.com` streams through the account proxy. Send one
|
|
18
|
+
# `Range: bytes=start-end` header to request a chunk for playback or a preview. A
|
|
19
|
+
# supported range returns `206`, `Content-Range`, and the chunk Content-Length; an
|
|
20
|
+
# upstream that ignores Range can return a full `200`, so check the response. Each
|
|
21
|
+
# nonempty transfer costs 3 credits per decimal MB streamed (minimum 1 credit).
|
|
22
|
+
# Credits for the selected response are reserved before streaming; unused reserved
|
|
23
|
+
# credits are released on completion, including an interrupted transfer. HEAD
|
|
24
|
+
# follows the same redirects and returns metadata without a body or download
|
|
25
|
+
# charge. HEAD does not populate the media cache. This regular endpoint does not
|
|
26
|
+
# decrypt DRM media.
|
|
20
27
|
#
|
|
21
28
|
# @overload download(cdn_url, account:, request_options: {})
|
|
22
29
|
#
|
|
@@ -27,7 +34,7 @@ module Onlyfans
|
|
|
27
34
|
#
|
|
28
35
|
# @param request_options [Onlyfans::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
29
36
|
#
|
|
30
|
-
# @return [
|
|
37
|
+
# @return [nil]
|
|
31
38
|
#
|
|
32
39
|
# @see Onlyfans::Models::MediaDownloadParams
|
|
33
40
|
def download(cdn_url, params)
|
|
@@ -39,8 +46,7 @@ module Onlyfans
|
|
|
39
46
|
@client.request(
|
|
40
47
|
method: :get,
|
|
41
48
|
path: ["api/%1$s/media/download/%2$s", account, cdn_url],
|
|
42
|
-
|
|
43
|
-
model: String,
|
|
49
|
+
model: NilClass,
|
|
44
50
|
options: options
|
|
45
51
|
)
|
|
46
52
|
end
|
|
@@ -3,45 +3,6 @@
|
|
|
3
3
|
module Onlyfans
|
|
4
4
|
module Resources
|
|
5
5
|
class Messages
|
|
6
|
-
# Some parameter documentations has been truncated, see
|
|
7
|
-
# {Onlyfans::Models::MessageAttachTagsParams} for more details.
|
|
8
|
-
#
|
|
9
|
-
# Attach Tags (Release Forms) to a message that has already been sent. Please
|
|
10
|
-
# note, that this is a "sync" operation - for example, if you provide empty
|
|
11
|
-
# `rfTag` it will remove all existing tags already attached to the message.
|
|
12
|
-
#
|
|
13
|
-
# @overload attach_tags(message_id, account:, rf_guest: nil, rf_partner: nil, rf_tag: nil, request_options: {})
|
|
14
|
-
#
|
|
15
|
-
# @param message_id [String] Path param: The ID of the message to attach the release forms to. This can be ON
|
|
16
|
-
#
|
|
17
|
-
# @param account [String] Path param: The Account ID
|
|
18
|
-
#
|
|
19
|
-
# @param rf_guest [String] Body param: Array of OnlyFans Release Form Guest IDs to tag in your message
|
|
20
|
-
#
|
|
21
|
-
# @param rf_partner [String] Body param: Array of OnlyFans Release Form Partners IDs to tag in your message
|
|
22
|
-
#
|
|
23
|
-
# @param rf_tag [String] Body param: Array of OnlyFans Creator User IDs to tag in your message
|
|
24
|
-
#
|
|
25
|
-
# @param request_options [Onlyfans::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
26
|
-
#
|
|
27
|
-
# @return [Onlyfans::Models::MessageAttachTagsResponse]
|
|
28
|
-
#
|
|
29
|
-
# @see Onlyfans::Models::MessageAttachTagsParams
|
|
30
|
-
def attach_tags(message_id, params)
|
|
31
|
-
parsed, options = Onlyfans::MessageAttachTagsParams.dump_request(params)
|
|
32
|
-
account =
|
|
33
|
-
parsed.delete(:account) do
|
|
34
|
-
raise ArgumentError.new("missing required path argument #{_1}")
|
|
35
|
-
end
|
|
36
|
-
@client.request(
|
|
37
|
-
method: :post,
|
|
38
|
-
path: ["api/%1$s/messages/%2$s/attach-tags", account, message_id],
|
|
39
|
-
body: parsed,
|
|
40
|
-
model: Onlyfans::Models::MessageAttachTagsResponse,
|
|
41
|
-
options: options
|
|
42
|
-
)
|
|
43
|
-
end
|
|
44
|
-
|
|
45
6
|
# @api private
|
|
46
7
|
#
|
|
47
8
|
# @param client [Onlyfans::Client]
|
|
@@ -21,7 +21,7 @@ module Onlyfans
|
|
|
21
21
|
#
|
|
22
22
|
# @param limit [Integer] The number of notifications. Default `10`
|
|
23
23
|
#
|
|
24
|
-
# @param skip_users [Symbol, Onlyfans::Models::NotificationListParams::SkipUsers] Whether to skip user details.
|
|
24
|
+
# @param skip_users [Symbol, Onlyfans::Models::NotificationListParams::SkipUsers] Whether to skip user details. Defaults to `all`.
|
|
25
25
|
#
|
|
26
26
|
# @param type [Symbol, Onlyfans::Models::NotificationListParams::Type] Filter notifications by a specific type
|
|
27
27
|
#
|
|
@@ -16,12 +16,14 @@ module Onlyfans
|
|
|
16
16
|
#
|
|
17
17
|
# Compose and send a new post to your OnlyFans account.
|
|
18
18
|
#
|
|
19
|
-
# @overload create(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: {})
|
|
19
|
+
# @overload create(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: {})
|
|
20
20
|
#
|
|
21
21
|
# @param account [String] The Account ID
|
|
22
22
|
#
|
|
23
23
|
# @param text [String] The post text content
|
|
24
24
|
#
|
|
25
|
+
# @param block_banned_words [Symbol, Onlyfans::Models::PostCreateParams::BlockBannedWords] Screen `text` for OnlyFans banned words and block the post if any are found (ret
|
|
26
|
+
#
|
|
25
27
|
# @param expire_days [Integer] Number of days after which the post will expire. Between 1 and 30 days. Keep emp
|
|
26
28
|
#
|
|
27
29
|
# @param fund_raising_target_amount [Integer] Add a fundraising target to your post. If present, value must be at least 10.
|
|
@@ -96,7 +98,7 @@ module Onlyfans
|
|
|
96
98
|
#
|
|
97
99
|
# Update a posted, queued, or "saved for later" post.
|
|
98
100
|
#
|
|
99
|
-
# @overload update(post_id, account:, 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: {})
|
|
101
|
+
# @overload update(post_id, 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, 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: {})
|
|
100
102
|
#
|
|
101
103
|
# @param post_id [Integer] Path param: The ID of the post
|
|
102
104
|
#
|
|
@@ -104,6 +106,8 @@ module Onlyfans
|
|
|
104
106
|
#
|
|
105
107
|
# @param text [String] Body param: The post text content
|
|
106
108
|
#
|
|
109
|
+
# @param block_banned_words [Symbol, Onlyfans::Models::PostUpdateParams::BlockBannedWords] Body param: Screen `text` for OnlyFans banned words and block the update if any
|
|
110
|
+
#
|
|
107
111
|
# @param expire_days [Integer] Body param: Number of days after which the post will expire. Between 1 and 30 da
|
|
108
112
|
#
|
|
109
113
|
# @param fund_raising_target_amount [Integer] Body param: Add a fundraising target to your post. If present, value must be at
|
|
@@ -6,19 +6,22 @@ module Onlyfans
|
|
|
6
6
|
# Some parameter documentations has been truncated, see
|
|
7
7
|
# {Onlyfans::Models::QueueListParams} for more details.
|
|
8
8
|
#
|
|
9
|
-
# List posts and messages
|
|
9
|
+
# List scheduled posts and mass messages for a date range. Use the type filter to
|
|
10
|
+
# return only posts, messages, or both.
|
|
10
11
|
#
|
|
11
|
-
# @overload list(account,
|
|
12
|
+
# @overload list(account, publish_date_end:, publish_date_start:, timezone:, limit: nil, type: nil, request_options: {})
|
|
12
13
|
#
|
|
13
14
|
# @param account [String] The Account ID
|
|
14
15
|
#
|
|
15
|
-
# @param
|
|
16
|
+
# @param publish_date_end [String] Latest publish date to return. Must be a valid date. Must be a valid date. Must
|
|
16
17
|
#
|
|
17
|
-
# @param
|
|
18
|
+
# @param publish_date_start [String] Earliest publish date to return (must be at least today). Must be a valid date.
|
|
18
19
|
#
|
|
19
|
-
# @param
|
|
20
|
+
# @param timezone [String] Timezone of the provided dates. [View available timezone values](https://www.php
|
|
20
21
|
#
|
|
21
|
-
# @param
|
|
22
|
+
# @param limit [Integer] Maximum number of queue items to return (default 20). Must be at least 1. Must n
|
|
23
|
+
#
|
|
24
|
+
# @param type [Array<Symbol, Onlyfans::Models::QueueListParams::Type>]
|
|
22
25
|
#
|
|
23
26
|
# @param request_options [Onlyfans::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
24
27
|
#
|
|
@@ -57,7 +57,8 @@ module Onlyfans
|
|
|
57
57
|
#
|
|
58
58
|
# Get a paginated list of users that can be tagged in release forms. These are
|
|
59
59
|
# verified creators who have signed release forms to appear in your content. Use
|
|
60
|
-
# `offset` and `limit` for pagination.
|
|
60
|
+
# `offset` and `limit` for pagination, following `_pagination.next_page` until it
|
|
61
|
+
# is `null`.
|
|
61
62
|
#
|
|
62
63
|
# @overload list_taggable_users(account, filter: nil, limit: nil, name: nil, offset: nil, sort: nil, sort_direction: nil, request_options: {})
|
|
63
64
|
#
|
|
@@ -16,16 +16,23 @@ module Onlyfans
|
|
|
16
16
|
# List all Tracking Links (campaigns) shared with the account by other OF
|
|
17
17
|
# creators. Calls OnlyFans live and syncs to our cache.
|
|
18
18
|
#
|
|
19
|
-
# @overload list(account, limit: nil, offset: nil, synchronous: nil, request_options: {})
|
|
19
|
+
# @overload list(account, limit: nil, offset: nil, pagination: nil, sorting_deleted: nil, stats: nil, synchronous: nil, with_deleted: nil, request_options: {})
|
|
20
20
|
#
|
|
21
21
|
# @param account [String] The Account ID
|
|
22
22
|
#
|
|
23
|
-
# @param limit [Integer] The number of shared tracking links to return. Default `10
|
|
23
|
+
# @param limit [Integer] The number of shared tracking links to return. Default `10`. Must be at least 1.
|
|
24
24
|
#
|
|
25
|
-
# @param offset [Integer] The offset used for pagination. Default `0
|
|
25
|
+
# @param offset [Integer] The offset used for pagination. Default `0`. Must be at least 0.
|
|
26
26
|
#
|
|
27
|
-
# @param
|
|
28
|
-
#
|
|
27
|
+
# @param pagination [Integer, Onlyfans::Models::SharedTrackingLinkListParams::Pagination] Whether pagination metadata is enabled. Default `1`.
|
|
28
|
+
#
|
|
29
|
+
# @param sorting_deleted [Integer, Onlyfans::Models::SharedTrackingLinkListParams::SortingDeleted] Whether deleted links participate in sorting. Default `1`.
|
|
30
|
+
#
|
|
31
|
+
# @param stats [String] Whether statistics are included. Default `true`. Must not be greater than 10 cha
|
|
32
|
+
#
|
|
33
|
+
# @param synchronous [Boolean] Wait for the database sync instead of processing it in the background.
|
|
34
|
+
#
|
|
35
|
+
# @param with_deleted [Integer, Onlyfans::Models::SharedTrackingLinkListParams::WithDeleted] Whether to include deleted shared tracking links. Default `1`.
|
|
29
36
|
#
|
|
30
37
|
# @param request_options [Onlyfans::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
31
38
|
#
|
|
@@ -16,16 +16,17 @@ module Onlyfans
|
|
|
16
16
|
# List all Free Trial Links shared with the account by other OF creators. Calls
|
|
17
17
|
# OnlyFans live and syncs to our cache.
|
|
18
18
|
#
|
|
19
|
-
# @overload list(account, limit: nil, offset: nil, synchronous: nil, request_options: {})
|
|
19
|
+
# @overload list(account, limit: nil, offset: nil, pagination: nil, synchronous: nil, request_options: {})
|
|
20
20
|
#
|
|
21
21
|
# @param account [String] The Account ID
|
|
22
22
|
#
|
|
23
|
-
# @param limit [Integer] The number of shared trial links to return. Default `10
|
|
23
|
+
# @param limit [Integer] The number of shared trial links to return. Default `10`. Must be at least 1. Mu
|
|
24
24
|
#
|
|
25
|
-
# @param offset [Integer] The offset used for pagination. Default `0
|
|
25
|
+
# @param offset [Integer] The offset used for pagination. Default `0`. Must be at least 0.
|
|
26
26
|
#
|
|
27
|
-
# @param
|
|
28
|
-
#
|
|
27
|
+
# @param pagination [Integer, Onlyfans::Models::SharedTrialLinkListParams::Pagination]
|
|
28
|
+
#
|
|
29
|
+
# @param synchronous [Boolean] Wait for the database sync instead of processing it in the background.
|
|
29
30
|
#
|
|
30
31
|
# @param request_options [Onlyfans::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
31
32
|
#
|
|
@@ -9,13 +9,19 @@ module Onlyfans
|
|
|
9
9
|
#
|
|
10
10
|
# Create a postback that fires for selected Smart Link conversion types
|
|
11
11
|
#
|
|
12
|
-
# @overload create(conversion_types:, smart_link_scope:, url:, smart_link_ids: nil, request_options: {})
|
|
12
|
+
# @overload create(conversion_types:, smart_link_scope:, url:, body: nil, headers: nil, http_method: nil, smart_link_ids: nil, request_options: {})
|
|
13
13
|
#
|
|
14
14
|
# @param conversion_types [Array<String>] One or more Smart Link conversion types that should trigger this postback.
|
|
15
15
|
#
|
|
16
16
|
# @param smart_link_scope [Symbol, Onlyfans::Models::SmartLinkPostbackCreateParams::SmartLinkScope] `global` fires for all Smart Links. `campaign_specific` fires only for selected
|
|
17
17
|
#
|
|
18
|
-
# @param url [String] The destination URL. Variables such as `{
|
|
18
|
+
# @param url [String] The destination URL. Variables such as `{external_click_id}`, `{fbclid}`, `{gcli
|
|
19
|
+
#
|
|
20
|
+
# @param body [String] Optional request body template for POST postbacks. Variables are replaced when t
|
|
21
|
+
#
|
|
22
|
+
# @param headers [Array<Onlyfans::Models::SmartLinkPostbackCreateParams::Header>] Optional request headers. Header values may include postback variables.
|
|
23
|
+
#
|
|
24
|
+
# @param http_method [Symbol, Onlyfans::Models::SmartLinkPostbackCreateParams::HTTPMethod] HTTP method used for the postback request. Defaults to `GET` when omitted.
|
|
19
25
|
#
|
|
20
26
|
# @param smart_link_ids [Array<String>] Smart Link ULIDs. Required when `smart_link_scope` is `campaign_specific`.
|
|
21
27
|
#
|
|
@@ -55,9 +61,12 @@ module Onlyfans
|
|
|
55
61
|
)
|
|
56
62
|
end
|
|
57
63
|
|
|
64
|
+
# Some parameter documentations has been truncated, see
|
|
65
|
+
# {Onlyfans::Models::SmartLinkPostbackUpdateParams} for more details.
|
|
66
|
+
#
|
|
58
67
|
# Update a Smart Link postback configuration
|
|
59
68
|
#
|
|
60
|
-
# @overload update(postback_id, conversion_types:, smart_link_scope:, url:, smart_link_ids: nil, request_options: {})
|
|
69
|
+
# @overload update(postback_id, conversion_types:, smart_link_scope:, url:, body: nil, headers: nil, http_method: nil, smart_link_ids: nil, request_options: {})
|
|
61
70
|
#
|
|
62
71
|
# @param postback_id [Integer] The postback ID
|
|
63
72
|
#
|
|
@@ -67,6 +76,12 @@ module Onlyfans
|
|
|
67
76
|
#
|
|
68
77
|
# @param url [String] The destination URL.
|
|
69
78
|
#
|
|
79
|
+
# @param body [String] Optional request body template for POST postbacks. Variables are replaced when t
|
|
80
|
+
#
|
|
81
|
+
# @param headers [Array<Onlyfans::Models::SmartLinkPostbackUpdateParams::Header>] Optional request headers. Header values may include postback variables.
|
|
82
|
+
#
|
|
83
|
+
# @param http_method [Symbol, Onlyfans::Models::SmartLinkPostbackUpdateParams::HTTPMethod] HTTP method used for the postback request. Existing value is kept when omitted.
|
|
84
|
+
#
|
|
70
85
|
# @param smart_link_ids [Array<String>] Smart Link ULIDs. Required when `smart_link_scope` is `campaign_specific`.
|
|
71
86
|
#
|
|
72
87
|
# @param request_options [Onlyfans::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
@@ -62,18 +62,20 @@ module Onlyfans
|
|
|
62
62
|
#
|
|
63
63
|
# List all Smart Links
|
|
64
64
|
#
|
|
65
|
-
# @overload list(account_ids: nil,
|
|
65
|
+
# @overload list(account_ids: nil, filter: nil, limit: nil, name: nil, offset: nil, pixel_ids: nil, request_options: {})
|
|
66
66
|
#
|
|
67
67
|
# @param account_ids [String, nil] Comma-separated account prefixed IDs to include.
|
|
68
68
|
#
|
|
69
|
-
# @param
|
|
69
|
+
# @param filter [Onlyfans::Models::SmartLinkListParams::Filter]
|
|
70
70
|
#
|
|
71
|
-
# @param
|
|
71
|
+
# @param limit [Integer] The number of Smart Links to return. Default `50`. Must be at least 1. Must not
|
|
72
72
|
#
|
|
73
73
|
# @param name [String, nil] Filter Smart Links by name. Must not be greater than 255 characters.
|
|
74
74
|
#
|
|
75
75
|
# @param offset [Integer] The offset used for pagination. Default `0`. Must be at least 0.
|
|
76
76
|
#
|
|
77
|
+
# @param pixel_ids [String, nil] Comma-separated ad platform Pixel IDs to include.
|
|
78
|
+
#
|
|
77
79
|
# @param request_options [Onlyfans::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
78
80
|
#
|
|
79
81
|
# @return [Onlyfans::Models::SmartLinkListResponse]
|
|
@@ -186,10 +188,13 @@ module Onlyfans
|
|
|
186
188
|
)
|
|
187
189
|
end
|
|
188
190
|
|
|
191
|
+
# Some parameter documentations has been truncated, see
|
|
192
|
+
# {Onlyfans::Models::SmartLinkListFansParams} for more details.
|
|
193
|
+
#
|
|
189
194
|
# Query attributed Smart Link fans with aggregate fan metrics and subscriber
|
|
190
195
|
# attribution metadata
|
|
191
196
|
#
|
|
192
|
-
# @overload list_fans(smart_link_id, has_messages: nil, limit: nil, min_messages_sent_by_fan: nil, min_revenue_net: nil, min_tips_net: nil, offset: nil, sort: nil, request_options: {})
|
|
197
|
+
# @overload list_fans(smart_link_id, has_messages: nil, limit: nil, min_messages_sent_by_fan: nil, min_revenue_net: nil, min_tips_net: nil, offset: nil, previously_subscribed: nil, sort: nil, subscribed_using_promo: nil, request_options: {})
|
|
193
198
|
#
|
|
194
199
|
# @param smart_link_id [String] The ID of the smart link.
|
|
195
200
|
#
|
|
@@ -205,8 +210,12 @@ module Onlyfans
|
|
|
205
210
|
#
|
|
206
211
|
# @param offset [Integer] Offset for pagination. Default `0`
|
|
207
212
|
#
|
|
213
|
+
# @param previously_subscribed [Boolean] Optional - Filter to returning subscribers (fans previously subscribed before th
|
|
214
|
+
#
|
|
208
215
|
# @param sort [Symbol, Onlyfans::Models::SmartLinkListFansParams::Sort] Optional sort field. Default `-revenue_net`
|
|
209
216
|
#
|
|
217
|
+
# @param subscribed_using_promo [Boolean] Optional - Filter to fans who subscribed via a promotion/offer
|
|
218
|
+
#
|
|
210
219
|
# @param request_options [Onlyfans::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
211
220
|
#
|
|
212
221
|
# @return [Onlyfans::Models::SmartLinkListFansResponse]
|
|
@@ -15,7 +15,7 @@ module Onlyfans
|
|
|
15
15
|
#
|
|
16
16
|
# @param end_date [String] The end date for the period.
|
|
17
17
|
#
|
|
18
|
-
# @param start_date [String] The start date for the period
|
|
18
|
+
# @param start_date [String] The start date for the period.
|
|
19
19
|
#
|
|
20
20
|
# @param filter [Symbol, Onlyfans::Models::Statistics::ReachGetProfileVisitorsParams::Filter, nil] Optionally, filter the results by `chart` or `topCountries`. See example respons
|
|
21
21
|
#
|
|
@@ -6,14 +6,14 @@ module Onlyfans
|
|
|
6
6
|
class Statements
|
|
7
7
|
# Get the earnings for a given period.
|
|
8
8
|
#
|
|
9
|
-
# @overload get_earnings(account, start_date:,
|
|
9
|
+
# @overload get_earnings(account, end_date:, start_date:, type: nil, request_options: {})
|
|
10
10
|
#
|
|
11
11
|
# @param account [String] The Account ID
|
|
12
12
|
#
|
|
13
|
-
# @param start_date [String] The start date for the period
|
|
14
|
-
#
|
|
15
13
|
# @param end_date [String] The end date for the period.
|
|
16
14
|
#
|
|
15
|
+
# @param start_date [String] The start date for the period.
|
|
16
|
+
#
|
|
17
17
|
# @param type [Symbol, Onlyfans::Models::Statistics::StatementGetEarningsParams::Type] Filter by All / Subscriptions / Tips / Posts / Messages / Streams
|
|
18
18
|
#
|
|
19
19
|
# @param request_options [Onlyfans::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
@@ -11,7 +11,7 @@ module Onlyfans
|
|
|
11
11
|
|
|
12
12
|
# Calculate the total transactions and amounts.
|
|
13
13
|
#
|
|
14
|
-
# @overload calculate_total_transactions(account, end_date
|
|
14
|
+
# @overload calculate_total_transactions(account, end_date: nil, start_date: nil, request_options: {})
|
|
15
15
|
#
|
|
16
16
|
# @param account [String] The Account ID
|
|
17
17
|
#
|
|
@@ -24,7 +24,7 @@ module Onlyfans
|
|
|
24
24
|
# @return [Onlyfans::Models::StatisticCalculateTotalTransactionsResponse]
|
|
25
25
|
#
|
|
26
26
|
# @see Onlyfans::Models::StatisticCalculateTotalTransactionsParams
|
|
27
|
-
def calculate_total_transactions(account, params)
|
|
27
|
+
def calculate_total_transactions(account, params = {})
|
|
28
28
|
parsed, options = Onlyfans::StatisticCalculateTotalTransactionsParams.dump_request(params)
|
|
29
29
|
query = Onlyfans::Internal::Util.encode_query_params(parsed)
|
|
30
30
|
@client.request(
|
|
@@ -75,7 +75,7 @@ module Onlyfans
|
|
|
75
75
|
# subscriptions for a specified timeframe. `unknown_subscriptions` indicates
|
|
76
76
|
# deleted fan accounts.
|
|
77
77
|
#
|
|
78
|
-
# @overload get_subscriber_metrics(account, end_date:, start_date:, detailed: nil, request_options: {})
|
|
78
|
+
# @overload get_subscriber_metrics(account, end_date:, start_date:, detailed: nil, detailed_type: nil, request_options: {})
|
|
79
79
|
#
|
|
80
80
|
# @param account [String] The Account ID
|
|
81
81
|
#
|
|
@@ -85,6 +85,8 @@ module Onlyfans
|
|
|
85
85
|
#
|
|
86
86
|
# @param detailed [Boolean, nil] Include paid and free fan metrics. Will slow down the response time, and might t
|
|
87
87
|
#
|
|
88
|
+
# @param detailed_type [Symbol, Onlyfans::Models::StatisticGetSubscriberMetricsParams::DetailedType, nil] Use only with `detailed=true` - otherwise, it has no effect. Filter the subscrib
|
|
89
|
+
#
|
|
88
90
|
# @param request_options [Onlyfans::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
89
91
|
#
|
|
90
92
|
# @return [Onlyfans::Models::StatisticGetSubscriberMetricsResponse]
|
|
@@ -8,16 +8,23 @@ module Onlyfans
|
|
|
8
8
|
# @return [Onlyfans::Resources::Stories::Highlights]
|
|
9
9
|
attr_reader :highlights
|
|
10
10
|
|
|
11
|
-
#
|
|
12
|
-
#
|
|
11
|
+
# Post a new media or vault file to your story, optionally with text overlays,
|
|
12
|
+
# @mentions, and a question sticker. Overlay elements are rendered by OnlyFans on
|
|
13
|
+
# top of your story media at view time.
|
|
13
14
|
#
|
|
14
|
-
#
|
|
15
|
-
#
|
|
16
|
-
# @overload create(account, media_files:, request_options: {})
|
|
15
|
+
# @overload create(account, media_files:, canvas_height: nil, canvas_width: nil, question: nil, texts: nil, request_options: {})
|
|
17
16
|
#
|
|
18
17
|
# @param account [String] The Account ID
|
|
19
18
|
#
|
|
20
|
-
# @param media_files [Array<String>] Array of media file upload prefixed_ids, or OF media IDs
|
|
19
|
+
# @param media_files [Array<String>] Array of media file upload prefixed_ids, or OF vault media IDs.
|
|
20
|
+
#
|
|
21
|
+
# @param canvas_height [Integer] Canvas height overlay positions are relative to. Default `1920`.
|
|
22
|
+
#
|
|
23
|
+
# @param canvas_width [Integer] Canvas width overlay positions are relative to. Default `1080`.
|
|
24
|
+
#
|
|
25
|
+
# @param question [Onlyfans::Models::StoryCreateParams::Question] Interactive question sticker viewers can answer.
|
|
26
|
+
#
|
|
27
|
+
# @param texts [Array<Onlyfans::Models::StoryCreateParams::Text>] Text and @mention overlays.
|
|
21
28
|
#
|
|
22
29
|
# @param request_options [Onlyfans::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
23
30
|
#
|
|
@@ -3,7 +3,11 @@
|
|
|
3
3
|
module Onlyfans
|
|
4
4
|
module Resources
|
|
5
5
|
class TrackingLinks
|
|
6
|
-
# APIs for managing tracking links
|
|
6
|
+
# APIs for managing tracking links. Revenue totals are net earnings after refunds
|
|
7
|
+
# and chargebacks. `revenue.chargebacks` (or `summary.chargebacks_total` in stats)
|
|
8
|
+
# is the positive cached net amount already excluded from revenue; do not subtract
|
|
9
|
+
# it again. Spender responses include chargebacks across all attributed periods
|
|
10
|
+
# for each fan with positive net revenue.
|
|
7
11
|
class Tags
|
|
8
12
|
# Get tags for a specific tracking link. This is a free endpoint.
|
|
9
13
|
#
|