postboost 1.21.0 → 1.22.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/README.md +8 -1
- data/docs/FreeToolBuildUtmUrlRequest.md +30 -0
- data/docs/FreeToolBuildUtmUrlResponse.md +20 -0
- data/docs/FreeToolCalculateEngagementRateRequest.md +32 -0
- data/docs/FreeToolCalculateEngagementRateResponse.md +24 -0
- data/docs/FreeToolCountCharactersRequest.md +20 -0
- data/docs/FreeToolCountCharactersResponse.md +20 -0
- data/docs/FreeToolCountCharactersResponseNetworksInner.md +28 -0
- data/docs/FreeToolError.md +18 -0
- data/docs/FreeToolFormatLinkedInPostRequest.md +22 -0
- data/docs/FreeToolFormatLinkedInPostResponse.md +26 -0
- data/docs/FreeToolGenerateFancyTextRequest.md +20 -0
- data/docs/FreeToolGenerateFancyTextResponse.md +18 -0
- data/docs/FreeToolGenerateFancyTextResponseStylesInner.md +22 -0
- data/docs/FreeToolList.md +18 -0
- data/docs/FreeToolListItem.md +30 -0
- data/docs/FreeToolSplitThreadRequest.md +22 -0
- data/docs/FreeToolSplitThreadResponse.md +20 -0
- data/docs/FreeToolSplitThreadResponsePostsInner.md +20 -0
- data/docs/FreeToolsApi.md +459 -0
- data/lib/postboost/api/account_groups_api.rb +1 -1
- data/lib/postboost/api/accounts_api.rb +1 -1
- data/lib/postboost/api/activity_api.rb +1 -1
- data/lib/postboost/api/agents_api.rb +1 -1
- data/lib/postboost/api/ai_api.rb +1 -1
- data/lib/postboost/api/analytics_api.rb +1 -1
- data/lib/postboost/api/competitors_api.rb +1 -1
- data/lib/postboost/api/free_tools_api.rb +487 -0
- data/lib/postboost/api/hashtag_groups_api.rb +1 -1
- data/lib/postboost/api/inbox_api.rb +1 -1
- data/lib/postboost/api/media_api.rb +1 -1
- data/lib/postboost/api/mentions_api.rb +1 -1
- data/lib/postboost/api/posting_schedule_api.rb +1 -1
- data/lib/postboost/api/posts_api.rb +1 -1
- data/lib/postboost/api/receipts_api.rb +1 -1
- data/lib/postboost/api/subscriptions_api.rb +1 -1
- data/lib/postboost/api/tags_api.rb +1 -1
- data/lib/postboost/api/templates_api.rb +1 -1
- data/lib/postboost/api/users_api.rb +1 -1
- data/lib/postboost/api/webhooks_api.rb +1 -1
- data/lib/postboost/api/workspaces_api.rb +1 -1
- data/lib/postboost/api_client.rb +1 -1
- data/lib/postboost/api_error.rb +1 -1
- data/lib/postboost/configuration.rb +1 -1
- data/lib/postboost/models/account.rb +1 -1
- data/lib/postboost/models/account_analytics.rb +1 -1
- data/lib/postboost/models/account_analytics_initial_sync.rb +1 -1
- data/lib/postboost/models/account_connection_health.rb +1 -1
- data/lib/postboost/models/account_errors_inner.rb +1 -1
- data/lib/postboost/models/account_errors_inner_one_of.rb +1 -1
- data/lib/postboost/models/account_group.rb +1 -1
- data/lib/postboost/models/account_group_input.rb +1 -1
- data/lib/postboost/models/account_health.rb +1 -1
- data/lib/postboost/models/account_health_daily_cap.rb +1 -1
- data/lib/postboost/models/account_schedule.rb +1 -1
- data/lib/postboost/models/add_competitor202_response.rb +1 -1
- data/lib/postboost/models/add_competitor409_response.rb +1 -1
- data/lib/postboost/models/add_generic_subscription_request.rb +1 -1
- data/lib/postboost/models/add_post_to_queue_request.rb +1 -1
- data/lib/postboost/models/agent_page_meta.rb +1 -1
- data/lib/postboost/models/agent_proposal.rb +1 -1
- data/lib/postboost/models/agent_proposal_decision.rb +1 -1
- data/lib/postboost/models/agent_run.rb +1 -1
- data/lib/postboost/models/ai_credits.rb +1 -1
- data/lib/postboost/models/ai_usage.rb +1 -1
- data/lib/postboost/models/ai_usage_text.rb +1 -1
- data/lib/postboost/models/analytics_period.rb +1 -1
- data/lib/postboost/models/analytics_summary.rb +1 -1
- data/lib/postboost/models/analytics_summary_data.rb +1 -1
- data/lib/postboost/models/api_activity.rb +1 -1
- data/lib/postboost/models/api_activity_outcome.rb +1 -1
- data/lib/postboost/models/api_key.rb +1 -1
- data/lib/postboost/models/api_key_ability.rb +1 -1
- data/lib/postboost/models/api_key_input.rb +1 -1
- data/lib/postboost/models/approve_agent_proposal200_response.rb +1 -1
- data/lib/postboost/models/approve_agent_proposal409_response.rb +1 -1
- data/lib/postboost/models/approve_inbox_reply_draft403_response.rb +1 -1
- data/lib/postboost/models/approve_post_request.rb +1 -1
- data/lib/postboost/models/best_posting_times.rb +1 -1
- data/lib/postboost/models/best_posting_times_times_inner.rb +1 -1
- data/lib/postboost/models/blog_to_social200_response.rb +1 -1
- data/lib/postboost/models/blog_to_social429_response.rb +1 -1
- data/lib/postboost/models/blog_to_social_caption.rb +1 -1
- data/lib/postboost/models/blog_to_social_input.rb +1 -1
- data/lib/postboost/models/blog_to_social_media.rb +1 -1
- data/lib/postboost/models/blog_to_social_response.rb +1 -1
- data/lib/postboost/models/brand_voice.rb +1 -1
- data/lib/postboost/models/brand_voice_input.rb +1 -1
- data/lib/postboost/models/brand_voice_meta.rb +1 -1
- data/lib/postboost/models/cancel_subscription422_response.rb +1 -1
- data/lib/postboost/models/cancel_subscription422_response_errors.rb +1 -1
- data/lib/postboost/models/cancel_subscription_request.rb +1 -1
- data/lib/postboost/models/change_subscription_plan_request.rb +1 -1
- data/lib/postboost/models/channel_account.rb +1 -1
- data/lib/postboost/models/checkout_subscription200_response.rb +1 -1
- data/lib/postboost/models/checkout_subscription_request.rb +1 -1
- data/lib/postboost/models/coded_error.rb +1 -1
- data/lib/postboost/models/competitor.rb +1 -1
- data/lib/postboost/models/competitor_detail.rb +1 -1
- data/lib/postboost/models/competitor_input.rb +1 -1
- data/lib/postboost/models/competitor_media.rb +1 -1
- data/lib/postboost/models/competitor_snapshot.rb +1 -1
- data/lib/postboost/models/complete_chunked_upload_request.rb +1 -1
- data/lib/postboost/models/connect_channel_input.rb +1 -1
- data/lib/postboost/models/create_account_group201_response.rb +1 -1
- data/lib/postboost/models/create_agent201_response.rb +1 -1
- data/lib/postboost/models/create_api_key201_response.rb +1 -1
- data/lib/postboost/models/create_api_key201_response_data.rb +1 -1
- data/lib/postboost/models/create_hashtag_group201_response.rb +1 -1
- data/lib/postboost/models/create_inbox_reply_draft201_response.rb +1 -1
- data/lib/postboost/models/create_media_folder_request.rb +1 -1
- data/lib/postboost/models/create_mention201_response.rb +1 -1
- data/lib/postboost/models/create_post201_response.rb +1 -1
- data/lib/postboost/models/create_recycling_rule201_response.rb +1 -1
- data/lib/postboost/models/create_report_export201_response.rb +1 -1
- data/lib/postboost/models/create_reseller_client201_response.rb +1 -1
- data/lib/postboost/models/create_rss_feed201_response.rb +1 -1
- data/lib/postboost/models/create_template201_response.rb +1 -1
- data/lib/postboost/models/create_webhook_subscription201_response.rb +1 -1
- data/lib/postboost/models/create_webhook_subscription201_response_data.rb +1 -1
- data/lib/postboost/models/delete_agent200_response.rb +1 -1
- data/lib/postboost/models/delete_media_bulk_request.rb +1 -1
- data/lib/postboost/models/delete_media_bulk_request_items_inner.rb +1 -1
- data/lib/postboost/models/delete_media_folder_request.rb +1 -1
- data/lib/postboost/models/delete_mode.rb +1 -1
- data/lib/postboost/models/delete_post_request.rb +1 -1
- data/lib/postboost/models/delete_posts_bulk_request.rb +1 -1
- data/lib/postboost/models/delete_receipts_bulk_request.rb +1 -1
- data/lib/postboost/models/delete_result.rb +1 -1
- data/lib/postboost/models/delete_user400_response.rb +1 -1
- data/lib/postboost/models/delete_users_bulk_request.rb +1 -1
- data/lib/postboost/models/delete_workspaces_bulk_request.rb +1 -1
- data/lib/postboost/models/free_tool_build_utm_url_request.rb +420 -0
- data/lib/postboost/models/free_tool_build_utm_url_response.rb +226 -0
- data/lib/postboost/models/free_tool_calculate_engagement_rate_request.rb +468 -0
- data/lib/postboost/models/free_tool_calculate_engagement_rate_response.rb +242 -0
- data/lib/postboost/models/free_tool_count_characters_request.rb +280 -0
- data/lib/postboost/models/free_tool_count_characters_response.rb +226 -0
- data/lib/postboost/models/free_tool_count_characters_response_networks_inner.rb +259 -0
- data/lib/postboost/models/free_tool_error.rb +221 -0
- data/lib/postboost/models/free_tool_format_linked_in_post_request.rb +306 -0
- data/lib/postboost/models/free_tool_format_linked_in_post_response.rb +251 -0
- data/lib/postboost/models/free_tool_generate_fancy_text_request.rb +284 -0
- data/lib/postboost/models/free_tool_generate_fancy_text_response.rb +216 -0
- data/lib/postboost/models/free_tool_generate_fancy_text_response_styles_inner.rb +233 -0
- data/lib/postboost/models/free_tool_list.rb +223 -0
- data/lib/postboost/models/free_tool_list_item.rb +344 -0
- data/lib/postboost/models/free_tool_split_thread_request.rb +293 -0
- data/lib/postboost/models/free_tool_split_thread_response.rb +225 -0
- data/lib/postboost/models/free_tool_split_thread_response_posts_inner.rb +224 -0
- data/lib/postboost/models/get_account_health200_response.rb +1 -1
- data/lib/postboost/models/get_brand_voice200_response.rb +1 -1
- data/lib/postboost/models/get_competitor200_response.rb +1 -1
- data/lib/postboost/models/get_inbox_conversation200_response.rb +1 -1
- data/lib/postboost/models/get_posting_schedule200_response.rb +1 -1
- data/lib/postboost/models/get_remote_upload_status200_response.rb +1 -1
- data/lib/postboost/models/get_report_branding200_response.rb +1 -1
- data/lib/postboost/models/get_repurpose_run200_response.rb +1 -1
- data/lib/postboost/models/guardrail_error.rb +1 -1
- data/lib/postboost/models/hashtag_group.rb +1 -1
- data/lib/postboost/models/hashtag_group_input.rb +1 -1
- data/lib/postboost/models/image_alt_text200_response.rb +1 -1
- data/lib/postboost/models/image_alt_text_input.rb +1 -1
- data/lib/postboost/models/image_alt_text_response.rb +1 -1
- data/lib/postboost/models/image_credit_balance.rb +1 -1
- data/lib/postboost/models/image_edit_input.rb +1 -1
- data/lib/postboost/models/image_generate200_response.rb +1 -1
- data/lib/postboost/models/image_generate429_response.rb +1 -1
- data/lib/postboost/models/image_generate_input.rb +1 -1
- data/lib/postboost/models/image_generation_response.rb +1 -1
- data/lib/postboost/models/image_prompt200_response.rb +1 -1
- data/lib/postboost/models/image_prompt429_response.rb +1 -1
- data/lib/postboost/models/image_prompt_input.rb +1 -1
- data/lib/postboost/models/image_prompt_response.rb +1 -1
- data/lib/postboost/models/image_variations200_response.rb +1 -1
- data/lib/postboost/models/image_variations_input.rb +1 -1
- data/lib/postboost/models/image_variations_response.rb +1 -1
- data/lib/postboost/models/inbox_author.rb +1 -1
- data/lib/postboost/models/inbox_conversation.rb +1 -1
- data/lib/postboost/models/inbox_conversation_account.rb +1 -1
- data/lib/postboost/models/inbox_conversation_update.rb +1 -1
- data/lib/postboost/models/inbox_message.rb +1 -1
- data/lib/postboost/models/inbox_message_author.rb +1 -1
- data/lib/postboost/models/inbox_reply_draft.rb +1 -1
- data/lib/postboost/models/inbox_reply_draft_approve.rb +1 -1
- data/lib/postboost/models/inbox_reply_draft_edit.rb +1 -1
- data/lib/postboost/models/inbox_reply_draft_input.rb +1 -1
- data/lib/postboost/models/initiate_chunked_upload201_response.rb +1 -1
- data/lib/postboost/models/initiate_chunked_upload_request.rb +1 -1
- data/lib/postboost/models/initiate_remote_upload201_response.rb +1 -1
- data/lib/postboost/models/initiate_remote_upload201_response_one_of.rb +1 -1
- data/lib/postboost/models/initiate_remote_upload_request.rb +1 -1
- data/lib/postboost/models/learn_brand_voice_input.rb +1 -1
- data/lib/postboost/models/learn_brand_voice_response.rb +1 -1
- data/lib/postboost/models/learn_brand_voice_response_meta.rb +1 -1
- data/lib/postboost/models/list_account_groups200_response.rb +1 -1
- data/lib/postboost/models/list_accounts200_response.rb +1 -1
- data/lib/postboost/models/list_agent_proposals200_response.rb +1 -1
- data/lib/postboost/models/list_agent_runs200_response.rb +1 -1
- data/lib/postboost/models/list_agents200_response.rb +1 -1
- data/lib/postboost/models/list_api_activity200_response.rb +1 -1
- data/lib/postboost/models/list_api_keys200_response.rb +1 -1
- data/lib/postboost/models/list_competitors200_response.rb +1 -1
- data/lib/postboost/models/list_hashtag_groups200_response.rb +1 -1
- data/lib/postboost/models/list_inbox_conversations200_response.rb +1 -1
- data/lib/postboost/models/list_inbox_reply_drafts200_response.rb +1 -1
- data/lib/postboost/models/list_media200_response.rb +1 -1
- data/lib/postboost/models/list_media_folders200_response.rb +1 -1
- data/lib/postboost/models/list_mentions200_response.rb +1 -1
- data/lib/postboost/models/list_my_workspaces200_response.rb +1 -1
- data/lib/postboost/models/list_posts200_response.rb +1 -1
- data/lib/postboost/models/list_receipts200_response.rb +1 -1
- data/lib/postboost/models/list_recycling_rules200_response.rb +1 -1
- data/lib/postboost/models/list_recycling_runs200_response.rb +1 -1
- data/lib/postboost/models/list_report_exports200_response.rb +1 -1
- data/lib/postboost/models/list_reseller_clients200_response.rb +1 -1
- data/lib/postboost/models/list_rss_feeds200_response.rb +1 -1
- data/lib/postboost/models/list_tags200_response.rb +1 -1
- data/lib/postboost/models/list_templates200_response.rb +1 -1
- data/lib/postboost/models/list_users200_response.rb +1 -1
- data/lib/postboost/models/list_webhook_subscriptions200_response.rb +1 -1
- data/lib/postboost/models/list_workspaces200_response.rb +1 -1
- data/lib/postboost/models/media.rb +1 -1
- data/lib/postboost/models/media_base64_input.rb +1 -1
- data/lib/postboost/models/media_folder.rb +1 -1
- data/lib/postboost/models/media_folder_input.rb +1 -1
- data/lib/postboost/models/media_folder_ref.rb +1 -1
- data/lib/postboost/models/mention.rb +1 -1
- data/lib/postboost/models/mention_identity.rb +1 -1
- data/lib/postboost/models/mention_identity_input.rb +1 -1
- data/lib/postboost/models/mention_input.rb +1 -1
- data/lib/postboost/models/message_only.rb +1 -1
- data/lib/postboost/models/pagination_meta.rb +1 -1
- data/lib/postboost/models/pagination_meta_links.rb +1 -1
- data/lib/postboost/models/pagination_meta_meta.rb +1 -1
- data/lib/postboost/models/poll_rss_feed200_response.rb +1 -1
- data/lib/postboost/models/post.rb +1 -1
- data/lib/postboost/models/post_analytics.rb +1 -1
- data/lib/postboost/models/post_content.rb +1 -1
- data/lib/postboost/models/post_input.rb +1 -1
- data/lib/postboost/models/post_options_instagram.rb +1 -1
- data/lib/postboost/models/post_options_tik_tok.rb +1 -1
- data/lib/postboost/models/post_options_youtube.rb +1 -1
- data/lib/postboost/models/post_status.rb +1 -1
- data/lib/postboost/models/post_version.rb +1 -1
- data/lib/postboost/models/post_version_options.rb +1 -1
- data/lib/postboost/models/post_warning.rb +1 -1
- data/lib/postboost/models/post_warnings.rb +1 -1
- data/lib/postboost/models/posting_schedule.rb +1 -1
- data/lib/postboost/models/posting_schedule_day.rb +1 -1
- data/lib/postboost/models/posting_schedule_day_times_inner.rb +1 -1
- data/lib/postboost/models/posting_schedule_input.rb +1 -1
- data/lib/postboost/models/posting_time_slot.rb +1 -1
- data/lib/postboost/models/posting_times.rb +1 -1
- data/lib/postboost/models/posting_times_best_inner.rb +1 -1
- data/lib/postboost/models/posting_times_day_intervals_inner_inner.rb +1 -1
- data/lib/postboost/models/posting_times_days_inner.rb +1 -1
- data/lib/postboost/models/preflight_result.rb +1 -1
- data/lib/postboost/models/public_workspace.rb +1 -1
- data/lib/postboost/models/public_workspace_pivot.rb +1 -1
- data/lib/postboost/models/publish_progress.rb +1 -1
- data/lib/postboost/models/queue_slots.rb +1 -1
- data/lib/postboost/models/receipt.rb +1 -1
- data/lib/postboost/models/receipt_input.rb +1 -1
- data/lib/postboost/models/receipt_update_input.rb +1 -1
- data/lib/postboost/models/recommended_posting_times.rb +1 -1
- data/lib/postboost/models/reconnect_link.rb +1 -1
- data/lib/postboost/models/recycling_rule.rb +1 -1
- data/lib/postboost/models/recycling_rule_input.rb +1 -1
- data/lib/postboost/models/recycling_rule_settings.rb +1 -1
- data/lib/postboost/models/recycling_rule_update.rb +1 -1
- data/lib/postboost/models/recycling_run.rb +1 -1
- data/lib/postboost/models/remove_generic_subscription422_response.rb +1 -1
- data/lib/postboost/models/remove_user_from_workspace_request.rb +1 -1
- data/lib/postboost/models/report_branding.rb +1 -1
- data/lib/postboost/models/report_branding_input.rb +1 -1
- data/lib/postboost/models/report_export.rb +1 -1
- data/lib/postboost/models/report_export_input.rb +1 -1
- data/lib/postboost/models/repurpose_content200_response.rb +1 -1
- data/lib/postboost/models/repurpose_content202_response.rb +1 -1
- data/lib/postboost/models/repurpose_content500_response.rb +1 -1
- data/lib/postboost/models/repurpose_input.rb +1 -1
- data/lib/postboost/models/repurpose_input_theme.rb +1 -1
- data/lib/postboost/models/repurpose_result.rb +1 -1
- data/lib/postboost/models/repurpose_result_media.rb +1 -1
- data/lib/postboost/models/repurpose_result_source.rb +1 -1
- data/lib/postboost/models/repurpose_run.rb +1 -1
- data/lib/postboost/models/repurpose_run_accepted.rb +1 -1
- data/lib/postboost/models/repurpose_slide.rb +1 -1
- data/lib/postboost/models/reseller_client.rb +1 -1
- data/lib/postboost/models/reseller_client_input.rb +1 -1
- data/lib/postboost/models/reseller_client_usage.rb +1 -1
- data/lib/postboost/models/retry_post_account_result.rb +1 -1
- data/lib/postboost/models/rss_feed.rb +1 -1
- data/lib/postboost/models/rss_feed_input.rb +1 -1
- data/lib/postboost/models/rss_feed_update.rb +1 -1
- data/lib/postboost/models/run_agent202_response.rb +1 -1
- data/lib/postboost/models/schedule_post_request.rb +1 -1
- data/lib/postboost/models/schedule_result.rb +1 -1
- data/lib/postboost/models/subscription.rb +1 -1
- data/lib/postboost/models/subscription_input.rb +1 -1
- data/lib/postboost/models/subscription_status.rb +1 -1
- data/lib/postboost/models/subscription_update_input.rb +1 -1
- data/lib/postboost/models/tag.rb +1 -1
- data/lib/postboost/models/tag_input.rb +1 -1
- data/lib/postboost/models/template.rb +1 -1
- data/lib/postboost/models/template_content_item.rb +1 -1
- data/lib/postboost/models/template_input.rb +1 -1
- data/lib/postboost/models/template_input_content_inner.rb +1 -1
- data/lib/postboost/models/update_media_request.rb +1 -1
- data/lib/postboost/models/update_post200_response.rb +1 -1
- data/lib/postboost/models/upload_chunk201_response.rb +1 -1
- data/lib/postboost/models/user.rb +1 -1
- data/lib/postboost/models/user_input.rb +1 -1
- data/lib/postboost/models/user_update_input.rb +1 -1
- data/lib/postboost/models/webhook_event_name.rb +1 -1
- data/lib/postboost/models/webhook_event_payload.rb +1 -1
- data/lib/postboost/models/webhook_subscription.rb +1 -1
- data/lib/postboost/models/webhook_subscription_input.rb +1 -1
- data/lib/postboost/models/workspace.rb +1 -1
- data/lib/postboost/models/workspace_agent.rb +1 -1
- data/lib/postboost/models/workspace_agent_input.rb +1 -1
- data/lib/postboost/models/workspace_agent_settings.rb +1 -1
- data/lib/postboost/models/workspace_agent_update.rb +1 -1
- data/lib/postboost/models/workspace_input.rb +1 -1
- data/lib/postboost/models/workspace_user_input.rb +1 -1
- data/lib/postboost/models/x_usage.rb +1 -1
- data/lib/postboost/models/x_usage_counter.rb +1 -1
- data/lib/postboost/version.rb +2 -2
- data/lib/postboost.rb +20 -1
- data/postboost.gemspec +1 -1
- data/spec/api/account_groups_api_spec.rb +1 -1
- data/spec/api/accounts_api_spec.rb +1 -1
- data/spec/api/activity_api_spec.rb +1 -1
- data/spec/api/agents_api_spec.rb +1 -1
- data/spec/api/ai_api_spec.rb +1 -1
- data/spec/api/analytics_api_spec.rb +1 -1
- data/spec/api/competitors_api_spec.rb +1 -1
- data/spec/api/free_tools_api_spec.rb +118 -0
- data/spec/api/hashtag_groups_api_spec.rb +1 -1
- data/spec/api/inbox_api_spec.rb +1 -1
- data/spec/api/media_api_spec.rb +1 -1
- data/spec/api/mentions_api_spec.rb +1 -1
- data/spec/api/posting_schedule_api_spec.rb +1 -1
- data/spec/api/posts_api_spec.rb +1 -1
- data/spec/api/receipts_api_spec.rb +1 -1
- data/spec/api/subscriptions_api_spec.rb +1 -1
- data/spec/api/tags_api_spec.rb +1 -1
- data/spec/api/templates_api_spec.rb +1 -1
- data/spec/api/users_api_spec.rb +1 -1
- data/spec/api/webhooks_api_spec.rb +1 -1
- data/spec/api/workspaces_api_spec.rb +1 -1
- data/spec/models/account_analytics_initial_sync_spec.rb +1 -1
- data/spec/models/account_analytics_spec.rb +1 -1
- data/spec/models/account_connection_health_spec.rb +1 -1
- data/spec/models/account_errors_inner_one_of_spec.rb +1 -1
- data/spec/models/account_errors_inner_spec.rb +1 -1
- data/spec/models/account_group_input_spec.rb +1 -1
- data/spec/models/account_group_spec.rb +1 -1
- data/spec/models/account_health_daily_cap_spec.rb +1 -1
- data/spec/models/account_health_spec.rb +1 -1
- data/spec/models/account_schedule_spec.rb +1 -1
- data/spec/models/account_spec.rb +1 -1
- data/spec/models/add_competitor202_response_spec.rb +1 -1
- data/spec/models/add_competitor409_response_spec.rb +1 -1
- data/spec/models/add_generic_subscription_request_spec.rb +1 -1
- data/spec/models/add_post_to_queue_request_spec.rb +1 -1
- data/spec/models/agent_page_meta_spec.rb +1 -1
- data/spec/models/agent_proposal_decision_spec.rb +1 -1
- data/spec/models/agent_proposal_spec.rb +1 -1
- data/spec/models/agent_run_spec.rb +1 -1
- data/spec/models/ai_credits_spec.rb +1 -1
- data/spec/models/ai_usage_spec.rb +1 -1
- data/spec/models/ai_usage_text_spec.rb +1 -1
- data/spec/models/analytics_period_spec.rb +1 -1
- data/spec/models/analytics_summary_data_spec.rb +1 -1
- data/spec/models/analytics_summary_spec.rb +1 -1
- data/spec/models/api_activity_outcome_spec.rb +1 -1
- data/spec/models/api_activity_spec.rb +1 -1
- data/spec/models/api_key_ability_spec.rb +1 -1
- data/spec/models/api_key_input_spec.rb +1 -1
- data/spec/models/api_key_spec.rb +1 -1
- data/spec/models/approve_agent_proposal200_response_spec.rb +1 -1
- data/spec/models/approve_agent_proposal409_response_spec.rb +1 -1
- data/spec/models/approve_inbox_reply_draft403_response_spec.rb +1 -1
- data/spec/models/approve_post_request_spec.rb +1 -1
- data/spec/models/best_posting_times_spec.rb +1 -1
- data/spec/models/best_posting_times_times_inner_spec.rb +1 -1
- data/spec/models/blog_to_social200_response_spec.rb +1 -1
- data/spec/models/blog_to_social429_response_spec.rb +1 -1
- data/spec/models/blog_to_social_caption_spec.rb +1 -1
- data/spec/models/blog_to_social_input_spec.rb +1 -1
- data/spec/models/blog_to_social_media_spec.rb +1 -1
- data/spec/models/blog_to_social_response_spec.rb +1 -1
- data/spec/models/brand_voice_input_spec.rb +1 -1
- data/spec/models/brand_voice_meta_spec.rb +1 -1
- data/spec/models/brand_voice_spec.rb +1 -1
- data/spec/models/cancel_subscription422_response_errors_spec.rb +1 -1
- data/spec/models/cancel_subscription422_response_spec.rb +1 -1
- data/spec/models/cancel_subscription_request_spec.rb +1 -1
- data/spec/models/change_subscription_plan_request_spec.rb +1 -1
- data/spec/models/channel_account_spec.rb +1 -1
- data/spec/models/checkout_subscription200_response_spec.rb +1 -1
- data/spec/models/checkout_subscription_request_spec.rb +1 -1
- data/spec/models/coded_error_spec.rb +1 -1
- data/spec/models/competitor_detail_spec.rb +1 -1
- data/spec/models/competitor_input_spec.rb +1 -1
- data/spec/models/competitor_media_spec.rb +1 -1
- data/spec/models/competitor_snapshot_spec.rb +1 -1
- data/spec/models/competitor_spec.rb +1 -1
- data/spec/models/complete_chunked_upload_request_spec.rb +1 -1
- data/spec/models/connect_channel_input_spec.rb +1 -1
- data/spec/models/create_account_group201_response_spec.rb +1 -1
- data/spec/models/create_agent201_response_spec.rb +1 -1
- data/spec/models/create_api_key201_response_data_spec.rb +1 -1
- data/spec/models/create_api_key201_response_spec.rb +1 -1
- data/spec/models/create_hashtag_group201_response_spec.rb +1 -1
- data/spec/models/create_inbox_reply_draft201_response_spec.rb +1 -1
- data/spec/models/create_media_folder_request_spec.rb +1 -1
- data/spec/models/create_mention201_response_spec.rb +1 -1
- data/spec/models/create_post201_response_spec.rb +1 -1
- data/spec/models/create_recycling_rule201_response_spec.rb +1 -1
- data/spec/models/create_report_export201_response_spec.rb +1 -1
- data/spec/models/create_reseller_client201_response_spec.rb +1 -1
- data/spec/models/create_rss_feed201_response_spec.rb +1 -1
- data/spec/models/create_template201_response_spec.rb +1 -1
- data/spec/models/create_webhook_subscription201_response_data_spec.rb +1 -1
- data/spec/models/create_webhook_subscription201_response_spec.rb +1 -1
- data/spec/models/delete_agent200_response_spec.rb +1 -1
- data/spec/models/delete_media_bulk_request_items_inner_spec.rb +1 -1
- data/spec/models/delete_media_bulk_request_spec.rb +1 -1
- data/spec/models/delete_media_folder_request_spec.rb +1 -1
- data/spec/models/delete_mode_spec.rb +1 -1
- data/spec/models/delete_post_request_spec.rb +1 -1
- data/spec/models/delete_posts_bulk_request_spec.rb +1 -1
- data/spec/models/delete_receipts_bulk_request_spec.rb +1 -1
- data/spec/models/delete_result_spec.rb +1 -1
- data/spec/models/delete_user400_response_spec.rb +1 -1
- data/spec/models/delete_users_bulk_request_spec.rb +1 -1
- data/spec/models/delete_workspaces_bulk_request_spec.rb +1 -1
- data/spec/models/free_tool_build_utm_url_request_spec.rb +72 -0
- data/spec/models/free_tool_build_utm_url_response_spec.rb +42 -0
- data/spec/models/free_tool_calculate_engagement_rate_request_spec.rb +82 -0
- data/spec/models/free_tool_calculate_engagement_rate_response_spec.rb +54 -0
- data/spec/models/free_tool_count_characters_request_spec.rb +46 -0
- data/spec/models/free_tool_count_characters_response_networks_inner_spec.rb +66 -0
- data/spec/models/free_tool_count_characters_response_spec.rb +42 -0
- data/spec/models/free_tool_error_spec.rb +36 -0
- data/spec/models/free_tool_format_linked_in_post_request_spec.rb +56 -0
- data/spec/models/free_tool_format_linked_in_post_response_spec.rb +60 -0
- data/spec/models/free_tool_generate_fancy_text_request_spec.rb +46 -0
- data/spec/models/free_tool_generate_fancy_text_response_spec.rb +36 -0
- data/spec/models/free_tool_generate_fancy_text_response_styles_inner_spec.rb +48 -0
- data/spec/models/free_tool_list_item_spec.rb +76 -0
- data/spec/models/free_tool_list_spec.rb +36 -0
- data/spec/models/free_tool_split_thread_request_spec.rb +52 -0
- data/spec/models/free_tool_split_thread_response_posts_inner_spec.rb +42 -0
- data/spec/models/free_tool_split_thread_response_spec.rb +42 -0
- data/spec/models/get_account_health200_response_spec.rb +1 -1
- data/spec/models/get_brand_voice200_response_spec.rb +1 -1
- data/spec/models/get_competitor200_response_spec.rb +1 -1
- data/spec/models/get_inbox_conversation200_response_spec.rb +1 -1
- data/spec/models/get_posting_schedule200_response_spec.rb +1 -1
- data/spec/models/get_remote_upload_status200_response_spec.rb +1 -1
- data/spec/models/get_report_branding200_response_spec.rb +1 -1
- data/spec/models/get_repurpose_run200_response_spec.rb +1 -1
- data/spec/models/guardrail_error_spec.rb +1 -1
- data/spec/models/hashtag_group_input_spec.rb +1 -1
- data/spec/models/hashtag_group_spec.rb +1 -1
- data/spec/models/image_alt_text200_response_spec.rb +1 -1
- data/spec/models/image_alt_text_input_spec.rb +1 -1
- data/spec/models/image_alt_text_response_spec.rb +1 -1
- data/spec/models/image_credit_balance_spec.rb +1 -1
- data/spec/models/image_edit_input_spec.rb +1 -1
- data/spec/models/image_generate200_response_spec.rb +1 -1
- data/spec/models/image_generate429_response_spec.rb +1 -1
- data/spec/models/image_generate_input_spec.rb +1 -1
- data/spec/models/image_generation_response_spec.rb +1 -1
- data/spec/models/image_prompt200_response_spec.rb +1 -1
- data/spec/models/image_prompt429_response_spec.rb +1 -1
- data/spec/models/image_prompt_input_spec.rb +1 -1
- data/spec/models/image_prompt_response_spec.rb +1 -1
- data/spec/models/image_variations200_response_spec.rb +1 -1
- data/spec/models/image_variations_input_spec.rb +1 -1
- data/spec/models/image_variations_response_spec.rb +1 -1
- data/spec/models/inbox_author_spec.rb +1 -1
- data/spec/models/inbox_conversation_account_spec.rb +1 -1
- data/spec/models/inbox_conversation_spec.rb +1 -1
- data/spec/models/inbox_conversation_update_spec.rb +1 -1
- data/spec/models/inbox_message_author_spec.rb +1 -1
- data/spec/models/inbox_message_spec.rb +1 -1
- data/spec/models/inbox_reply_draft_approve_spec.rb +1 -1
- data/spec/models/inbox_reply_draft_edit_spec.rb +1 -1
- data/spec/models/inbox_reply_draft_input_spec.rb +1 -1
- data/spec/models/inbox_reply_draft_spec.rb +1 -1
- data/spec/models/initiate_chunked_upload201_response_spec.rb +1 -1
- data/spec/models/initiate_chunked_upload_request_spec.rb +1 -1
- data/spec/models/initiate_remote_upload201_response_one_of_spec.rb +1 -1
- data/spec/models/initiate_remote_upload201_response_spec.rb +1 -1
- data/spec/models/initiate_remote_upload_request_spec.rb +1 -1
- data/spec/models/learn_brand_voice_input_spec.rb +1 -1
- data/spec/models/learn_brand_voice_response_meta_spec.rb +1 -1
- data/spec/models/learn_brand_voice_response_spec.rb +1 -1
- data/spec/models/list_account_groups200_response_spec.rb +1 -1
- data/spec/models/list_accounts200_response_spec.rb +1 -1
- data/spec/models/list_agent_proposals200_response_spec.rb +1 -1
- data/spec/models/list_agent_runs200_response_spec.rb +1 -1
- data/spec/models/list_agents200_response_spec.rb +1 -1
- data/spec/models/list_api_activity200_response_spec.rb +1 -1
- data/spec/models/list_api_keys200_response_spec.rb +1 -1
- data/spec/models/list_competitors200_response_spec.rb +1 -1
- data/spec/models/list_hashtag_groups200_response_spec.rb +1 -1
- data/spec/models/list_inbox_conversations200_response_spec.rb +1 -1
- data/spec/models/list_inbox_reply_drafts200_response_spec.rb +1 -1
- data/spec/models/list_media200_response_spec.rb +1 -1
- data/spec/models/list_media_folders200_response_spec.rb +1 -1
- data/spec/models/list_mentions200_response_spec.rb +1 -1
- data/spec/models/list_my_workspaces200_response_spec.rb +1 -1
- data/spec/models/list_posts200_response_spec.rb +1 -1
- data/spec/models/list_receipts200_response_spec.rb +1 -1
- data/spec/models/list_recycling_rules200_response_spec.rb +1 -1
- data/spec/models/list_recycling_runs200_response_spec.rb +1 -1
- data/spec/models/list_report_exports200_response_spec.rb +1 -1
- data/spec/models/list_reseller_clients200_response_spec.rb +1 -1
- data/spec/models/list_rss_feeds200_response_spec.rb +1 -1
- data/spec/models/list_tags200_response_spec.rb +1 -1
- data/spec/models/list_templates200_response_spec.rb +1 -1
- data/spec/models/list_users200_response_spec.rb +1 -1
- data/spec/models/list_webhook_subscriptions200_response_spec.rb +1 -1
- data/spec/models/list_workspaces200_response_spec.rb +1 -1
- data/spec/models/media_base64_input_spec.rb +1 -1
- data/spec/models/media_folder_input_spec.rb +1 -1
- data/spec/models/media_folder_ref_spec.rb +1 -1
- data/spec/models/media_folder_spec.rb +1 -1
- data/spec/models/media_spec.rb +1 -1
- data/spec/models/mention_identity_input_spec.rb +1 -1
- data/spec/models/mention_identity_spec.rb +1 -1
- data/spec/models/mention_input_spec.rb +1 -1
- data/spec/models/mention_spec.rb +1 -1
- data/spec/models/message_only_spec.rb +1 -1
- data/spec/models/pagination_meta_links_spec.rb +1 -1
- data/spec/models/pagination_meta_meta_spec.rb +1 -1
- data/spec/models/pagination_meta_spec.rb +1 -1
- data/spec/models/poll_rss_feed200_response_spec.rb +1 -1
- data/spec/models/post_analytics_spec.rb +1 -1
- data/spec/models/post_content_spec.rb +1 -1
- data/spec/models/post_input_spec.rb +1 -1
- data/spec/models/post_options_instagram_spec.rb +1 -1
- data/spec/models/post_options_tik_tok_spec.rb +1 -1
- data/spec/models/post_options_youtube_spec.rb +1 -1
- data/spec/models/post_spec.rb +1 -1
- data/spec/models/post_status_spec.rb +1 -1
- data/spec/models/post_version_options_spec.rb +1 -1
- data/spec/models/post_version_spec.rb +1 -1
- data/spec/models/post_warning_spec.rb +1 -1
- data/spec/models/post_warnings_spec.rb +1 -1
- data/spec/models/posting_schedule_day_spec.rb +1 -1
- data/spec/models/posting_schedule_day_times_inner_spec.rb +1 -1
- data/spec/models/posting_schedule_input_spec.rb +1 -1
- data/spec/models/posting_schedule_spec.rb +1 -1
- data/spec/models/posting_time_slot_spec.rb +1 -1
- data/spec/models/posting_times_best_inner_spec.rb +1 -1
- data/spec/models/posting_times_day_intervals_inner_inner_spec.rb +1 -1
- data/spec/models/posting_times_days_inner_spec.rb +1 -1
- data/spec/models/posting_times_spec.rb +1 -1
- data/spec/models/preflight_result_spec.rb +1 -1
- data/spec/models/public_workspace_pivot_spec.rb +1 -1
- data/spec/models/public_workspace_spec.rb +1 -1
- data/spec/models/publish_progress_spec.rb +1 -1
- data/spec/models/queue_slots_spec.rb +1 -1
- data/spec/models/receipt_input_spec.rb +1 -1
- data/spec/models/receipt_spec.rb +1 -1
- data/spec/models/receipt_update_input_spec.rb +1 -1
- data/spec/models/recommended_posting_times_spec.rb +1 -1
- data/spec/models/reconnect_link_spec.rb +1 -1
- data/spec/models/recycling_rule_input_spec.rb +1 -1
- data/spec/models/recycling_rule_settings_spec.rb +1 -1
- data/spec/models/recycling_rule_spec.rb +1 -1
- data/spec/models/recycling_rule_update_spec.rb +1 -1
- data/spec/models/recycling_run_spec.rb +1 -1
- data/spec/models/remove_generic_subscription422_response_spec.rb +1 -1
- data/spec/models/remove_user_from_workspace_request_spec.rb +1 -1
- data/spec/models/report_branding_input_spec.rb +1 -1
- data/spec/models/report_branding_spec.rb +1 -1
- data/spec/models/report_export_input_spec.rb +1 -1
- data/spec/models/report_export_spec.rb +1 -1
- data/spec/models/repurpose_content200_response_spec.rb +1 -1
- data/spec/models/repurpose_content202_response_spec.rb +1 -1
- data/spec/models/repurpose_content500_response_spec.rb +1 -1
- data/spec/models/repurpose_input_spec.rb +1 -1
- data/spec/models/repurpose_input_theme_spec.rb +1 -1
- data/spec/models/repurpose_result_media_spec.rb +1 -1
- data/spec/models/repurpose_result_source_spec.rb +1 -1
- data/spec/models/repurpose_result_spec.rb +1 -1
- data/spec/models/repurpose_run_accepted_spec.rb +1 -1
- data/spec/models/repurpose_run_spec.rb +1 -1
- data/spec/models/repurpose_slide_spec.rb +1 -1
- data/spec/models/reseller_client_input_spec.rb +1 -1
- data/spec/models/reseller_client_spec.rb +1 -1
- data/spec/models/reseller_client_usage_spec.rb +1 -1
- data/spec/models/retry_post_account_result_spec.rb +1 -1
- data/spec/models/rss_feed_input_spec.rb +1 -1
- data/spec/models/rss_feed_spec.rb +1 -1
- data/spec/models/rss_feed_update_spec.rb +1 -1
- data/spec/models/run_agent202_response_spec.rb +1 -1
- data/spec/models/schedule_post_request_spec.rb +1 -1
- data/spec/models/schedule_result_spec.rb +1 -1
- data/spec/models/subscription_input_spec.rb +1 -1
- data/spec/models/subscription_spec.rb +1 -1
- data/spec/models/subscription_status_spec.rb +1 -1
- data/spec/models/subscription_update_input_spec.rb +1 -1
- data/spec/models/tag_input_spec.rb +1 -1
- data/spec/models/tag_spec.rb +1 -1
- data/spec/models/template_content_item_spec.rb +1 -1
- data/spec/models/template_input_content_inner_spec.rb +1 -1
- data/spec/models/template_input_spec.rb +1 -1
- data/spec/models/template_spec.rb +1 -1
- data/spec/models/update_media_request_spec.rb +1 -1
- data/spec/models/update_post200_response_spec.rb +1 -1
- data/spec/models/upload_chunk201_response_spec.rb +1 -1
- data/spec/models/user_input_spec.rb +1 -1
- data/spec/models/user_spec.rb +1 -1
- data/spec/models/user_update_input_spec.rb +1 -1
- data/spec/models/webhook_event_name_spec.rb +1 -1
- data/spec/models/webhook_event_payload_spec.rb +1 -1
- data/spec/models/webhook_subscription_input_spec.rb +1 -1
- data/spec/models/webhook_subscription_spec.rb +1 -1
- data/spec/models/workspace_agent_input_spec.rb +1 -1
- data/spec/models/workspace_agent_settings_spec.rb +1 -1
- data/spec/models/workspace_agent_spec.rb +1 -1
- data/spec/models/workspace_agent_update_spec.rb +1 -1
- data/spec/models/workspace_input_spec.rb +1 -1
- data/spec/models/workspace_spec.rb +1 -1
- data/spec/models/workspace_user_input_spec.rb +1 -1
- data/spec/models/x_usage_counter_spec.rb +1 -1
- data/spec/models/x_usage_spec.rb +1 -1
- data/spec/spec_helper.rb +1 -1
- metadata +77 -1
|
@@ -0,0 +1,459 @@
|
|
|
1
|
+
# PostBoost::FreeToolsApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://postboost.co/app/api*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**build_utm_url**](FreeToolsApi.md#build_utm_url) | **POST** /tools/utm-builder | Build a UTM-tagged campaign URL |
|
|
8
|
+
| [**calculate_engagement_rate**](FreeToolsApi.md#calculate_engagement_rate) | **POST** /tools/engagement-rate-calculator | Calculate an engagement rate |
|
|
9
|
+
| [**count_characters**](FreeToolsApi.md#count_characters) | **POST** /tools/social-media-character-counter | Count characters as each network counts them |
|
|
10
|
+
| [**format_linked_in_post**](FreeToolsApi.md#format_linked_in_post) | **POST** /tools/linkedin-post-formatter | Format a LinkedIn post with bold, italic and lists |
|
|
11
|
+
| [**generate_fancy_text**](FreeToolsApi.md#generate_fancy_text) | **POST** /tools/fancy-text-generator | Convert text to fancy Unicode styles |
|
|
12
|
+
| [**list_free_tools**](FreeToolsApi.md#list_free_tools) | **GET** /tools | List the free tools |
|
|
13
|
+
| [**split_thread**](FreeToolsApi.md#split_thread) | **POST** /tools/x-thread-maker | Split long text into a thread |
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
## build_utm_url
|
|
17
|
+
|
|
18
|
+
> <FreeToolBuildUtmUrlResponse> build_utm_url(free_tool_build_utm_url_request)
|
|
19
|
+
|
|
20
|
+
Build a UTM-tagged campaign URL
|
|
21
|
+
|
|
22
|
+
Build a UTM-tagged campaign URL. The same logic as the free web tool at https://postboost.co/tools/utm-builder. No account needed: call it without a token, or with any API token.
|
|
23
|
+
|
|
24
|
+
### Examples
|
|
25
|
+
|
|
26
|
+
```ruby
|
|
27
|
+
require 'time'
|
|
28
|
+
require 'postboost'
|
|
29
|
+
|
|
30
|
+
api_instance = PostBoost::FreeToolsApi.new
|
|
31
|
+
free_tool_build_utm_url_request = PostBoost::FreeToolBuildUtmUrlRequest.new({url: 'url_example'}) # FreeToolBuildUtmUrlRequest |
|
|
32
|
+
|
|
33
|
+
begin
|
|
34
|
+
# Build a UTM-tagged campaign URL
|
|
35
|
+
result = api_instance.build_utm_url(free_tool_build_utm_url_request)
|
|
36
|
+
p result
|
|
37
|
+
rescue PostBoost::ApiError => e
|
|
38
|
+
puts "Error when calling FreeToolsApi->build_utm_url: #{e}"
|
|
39
|
+
end
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
#### Using the build_utm_url_with_http_info variant
|
|
43
|
+
|
|
44
|
+
This returns an Array which contains the response data, status code and headers.
|
|
45
|
+
|
|
46
|
+
> <Array(<FreeToolBuildUtmUrlResponse>, Integer, Hash)> build_utm_url_with_http_info(free_tool_build_utm_url_request)
|
|
47
|
+
|
|
48
|
+
```ruby
|
|
49
|
+
begin
|
|
50
|
+
# Build a UTM-tagged campaign URL
|
|
51
|
+
data, status_code, headers = api_instance.build_utm_url_with_http_info(free_tool_build_utm_url_request)
|
|
52
|
+
p status_code # => 2xx
|
|
53
|
+
p headers # => { ... }
|
|
54
|
+
p data # => <FreeToolBuildUtmUrlResponse>
|
|
55
|
+
rescue PostBoost::ApiError => e
|
|
56
|
+
puts "Error when calling FreeToolsApi->build_utm_url_with_http_info: #{e}"
|
|
57
|
+
end
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
### Parameters
|
|
61
|
+
|
|
62
|
+
| Name | Type | Description | Notes |
|
|
63
|
+
| ---- | ---- | ----------- | ----- |
|
|
64
|
+
| **free_tool_build_utm_url_request** | [**FreeToolBuildUtmUrlRequest**](FreeToolBuildUtmUrlRequest.md) | | |
|
|
65
|
+
|
|
66
|
+
### Return type
|
|
67
|
+
|
|
68
|
+
[**FreeToolBuildUtmUrlResponse**](FreeToolBuildUtmUrlResponse.md)
|
|
69
|
+
|
|
70
|
+
### Authorization
|
|
71
|
+
|
|
72
|
+
No authorization required
|
|
73
|
+
|
|
74
|
+
### HTTP request headers
|
|
75
|
+
|
|
76
|
+
- **Content-Type**: application/json
|
|
77
|
+
- **Accept**: application/json
|
|
78
|
+
|
|
79
|
+
|
|
80
|
+
## calculate_engagement_rate
|
|
81
|
+
|
|
82
|
+
> <FreeToolCalculateEngagementRateResponse> calculate_engagement_rate(free_tool_calculate_engagement_rate_request)
|
|
83
|
+
|
|
84
|
+
Calculate an engagement rate
|
|
85
|
+
|
|
86
|
+
Calculate an engagement rate. The same logic as the free web tool at https://postboost.co/tools/engagement-rate-calculator. No account needed: call it without a token, or with any API token.
|
|
87
|
+
|
|
88
|
+
### Examples
|
|
89
|
+
|
|
90
|
+
```ruby
|
|
91
|
+
require 'time'
|
|
92
|
+
require 'postboost'
|
|
93
|
+
|
|
94
|
+
api_instance = PostBoost::FreeToolsApi.new
|
|
95
|
+
free_tool_calculate_engagement_rate_request = PostBoost::FreeToolCalculateEngagementRateRequest.new({base: 37}) # FreeToolCalculateEngagementRateRequest |
|
|
96
|
+
|
|
97
|
+
begin
|
|
98
|
+
# Calculate an engagement rate
|
|
99
|
+
result = api_instance.calculate_engagement_rate(free_tool_calculate_engagement_rate_request)
|
|
100
|
+
p result
|
|
101
|
+
rescue PostBoost::ApiError => e
|
|
102
|
+
puts "Error when calling FreeToolsApi->calculate_engagement_rate: #{e}"
|
|
103
|
+
end
|
|
104
|
+
```
|
|
105
|
+
|
|
106
|
+
#### Using the calculate_engagement_rate_with_http_info variant
|
|
107
|
+
|
|
108
|
+
This returns an Array which contains the response data, status code and headers.
|
|
109
|
+
|
|
110
|
+
> <Array(<FreeToolCalculateEngagementRateResponse>, Integer, Hash)> calculate_engagement_rate_with_http_info(free_tool_calculate_engagement_rate_request)
|
|
111
|
+
|
|
112
|
+
```ruby
|
|
113
|
+
begin
|
|
114
|
+
# Calculate an engagement rate
|
|
115
|
+
data, status_code, headers = api_instance.calculate_engagement_rate_with_http_info(free_tool_calculate_engagement_rate_request)
|
|
116
|
+
p status_code # => 2xx
|
|
117
|
+
p headers # => { ... }
|
|
118
|
+
p data # => <FreeToolCalculateEngagementRateResponse>
|
|
119
|
+
rescue PostBoost::ApiError => e
|
|
120
|
+
puts "Error when calling FreeToolsApi->calculate_engagement_rate_with_http_info: #{e}"
|
|
121
|
+
end
|
|
122
|
+
```
|
|
123
|
+
|
|
124
|
+
### Parameters
|
|
125
|
+
|
|
126
|
+
| Name | Type | Description | Notes |
|
|
127
|
+
| ---- | ---- | ----------- | ----- |
|
|
128
|
+
| **free_tool_calculate_engagement_rate_request** | [**FreeToolCalculateEngagementRateRequest**](FreeToolCalculateEngagementRateRequest.md) | | |
|
|
129
|
+
|
|
130
|
+
### Return type
|
|
131
|
+
|
|
132
|
+
[**FreeToolCalculateEngagementRateResponse**](FreeToolCalculateEngagementRateResponse.md)
|
|
133
|
+
|
|
134
|
+
### Authorization
|
|
135
|
+
|
|
136
|
+
No authorization required
|
|
137
|
+
|
|
138
|
+
### HTTP request headers
|
|
139
|
+
|
|
140
|
+
- **Content-Type**: application/json
|
|
141
|
+
- **Accept**: application/json
|
|
142
|
+
|
|
143
|
+
|
|
144
|
+
## count_characters
|
|
145
|
+
|
|
146
|
+
> <FreeToolCountCharactersResponse> count_characters(free_tool_count_characters_request)
|
|
147
|
+
|
|
148
|
+
Count characters as each network counts them
|
|
149
|
+
|
|
150
|
+
Count characters as each network counts them. The same logic as the free web tool at https://postboost.co/tools/social-media-character-counter. No account needed: call it without a token, or with any API token.
|
|
151
|
+
|
|
152
|
+
### Examples
|
|
153
|
+
|
|
154
|
+
```ruby
|
|
155
|
+
require 'time'
|
|
156
|
+
require 'postboost'
|
|
157
|
+
|
|
158
|
+
api_instance = PostBoost::FreeToolsApi.new
|
|
159
|
+
free_tool_count_characters_request = PostBoost::FreeToolCountCharactersRequest.new # FreeToolCountCharactersRequest |
|
|
160
|
+
|
|
161
|
+
begin
|
|
162
|
+
# Count characters as each network counts them
|
|
163
|
+
result = api_instance.count_characters(free_tool_count_characters_request)
|
|
164
|
+
p result
|
|
165
|
+
rescue PostBoost::ApiError => e
|
|
166
|
+
puts "Error when calling FreeToolsApi->count_characters: #{e}"
|
|
167
|
+
end
|
|
168
|
+
```
|
|
169
|
+
|
|
170
|
+
#### Using the count_characters_with_http_info variant
|
|
171
|
+
|
|
172
|
+
This returns an Array which contains the response data, status code and headers.
|
|
173
|
+
|
|
174
|
+
> <Array(<FreeToolCountCharactersResponse>, Integer, Hash)> count_characters_with_http_info(free_tool_count_characters_request)
|
|
175
|
+
|
|
176
|
+
```ruby
|
|
177
|
+
begin
|
|
178
|
+
# Count characters as each network counts them
|
|
179
|
+
data, status_code, headers = api_instance.count_characters_with_http_info(free_tool_count_characters_request)
|
|
180
|
+
p status_code # => 2xx
|
|
181
|
+
p headers # => { ... }
|
|
182
|
+
p data # => <FreeToolCountCharactersResponse>
|
|
183
|
+
rescue PostBoost::ApiError => e
|
|
184
|
+
puts "Error when calling FreeToolsApi->count_characters_with_http_info: #{e}"
|
|
185
|
+
end
|
|
186
|
+
```
|
|
187
|
+
|
|
188
|
+
### Parameters
|
|
189
|
+
|
|
190
|
+
| Name | Type | Description | Notes |
|
|
191
|
+
| ---- | ---- | ----------- | ----- |
|
|
192
|
+
| **free_tool_count_characters_request** | [**FreeToolCountCharactersRequest**](FreeToolCountCharactersRequest.md) | | |
|
|
193
|
+
|
|
194
|
+
### Return type
|
|
195
|
+
|
|
196
|
+
[**FreeToolCountCharactersResponse**](FreeToolCountCharactersResponse.md)
|
|
197
|
+
|
|
198
|
+
### Authorization
|
|
199
|
+
|
|
200
|
+
No authorization required
|
|
201
|
+
|
|
202
|
+
### HTTP request headers
|
|
203
|
+
|
|
204
|
+
- **Content-Type**: application/json
|
|
205
|
+
- **Accept**: application/json
|
|
206
|
+
|
|
207
|
+
|
|
208
|
+
## format_linked_in_post
|
|
209
|
+
|
|
210
|
+
> <FreeToolFormatLinkedInPostResponse> format_linked_in_post(free_tool_format_linked_in_post_request)
|
|
211
|
+
|
|
212
|
+
Format a LinkedIn post with bold, italic and lists
|
|
213
|
+
|
|
214
|
+
Format a LinkedIn post with bold, italic and lists. The same logic as the free web tool at https://postboost.co/tools/linkedin-post-formatter. No account needed: call it without a token, or with any API token.
|
|
215
|
+
|
|
216
|
+
### Examples
|
|
217
|
+
|
|
218
|
+
```ruby
|
|
219
|
+
require 'time'
|
|
220
|
+
require 'postboost'
|
|
221
|
+
|
|
222
|
+
api_instance = PostBoost::FreeToolsApi.new
|
|
223
|
+
free_tool_format_linked_in_post_request = PostBoost::FreeToolFormatLinkedInPostRequest.new({text: 'text_example'}) # FreeToolFormatLinkedInPostRequest |
|
|
224
|
+
|
|
225
|
+
begin
|
|
226
|
+
# Format a LinkedIn post with bold, italic and lists
|
|
227
|
+
result = api_instance.format_linked_in_post(free_tool_format_linked_in_post_request)
|
|
228
|
+
p result
|
|
229
|
+
rescue PostBoost::ApiError => e
|
|
230
|
+
puts "Error when calling FreeToolsApi->format_linked_in_post: #{e}"
|
|
231
|
+
end
|
|
232
|
+
```
|
|
233
|
+
|
|
234
|
+
#### Using the format_linked_in_post_with_http_info variant
|
|
235
|
+
|
|
236
|
+
This returns an Array which contains the response data, status code and headers.
|
|
237
|
+
|
|
238
|
+
> <Array(<FreeToolFormatLinkedInPostResponse>, Integer, Hash)> format_linked_in_post_with_http_info(free_tool_format_linked_in_post_request)
|
|
239
|
+
|
|
240
|
+
```ruby
|
|
241
|
+
begin
|
|
242
|
+
# Format a LinkedIn post with bold, italic and lists
|
|
243
|
+
data, status_code, headers = api_instance.format_linked_in_post_with_http_info(free_tool_format_linked_in_post_request)
|
|
244
|
+
p status_code # => 2xx
|
|
245
|
+
p headers # => { ... }
|
|
246
|
+
p data # => <FreeToolFormatLinkedInPostResponse>
|
|
247
|
+
rescue PostBoost::ApiError => e
|
|
248
|
+
puts "Error when calling FreeToolsApi->format_linked_in_post_with_http_info: #{e}"
|
|
249
|
+
end
|
|
250
|
+
```
|
|
251
|
+
|
|
252
|
+
### Parameters
|
|
253
|
+
|
|
254
|
+
| Name | Type | Description | Notes |
|
|
255
|
+
| ---- | ---- | ----------- | ----- |
|
|
256
|
+
| **free_tool_format_linked_in_post_request** | [**FreeToolFormatLinkedInPostRequest**](FreeToolFormatLinkedInPostRequest.md) | | |
|
|
257
|
+
|
|
258
|
+
### Return type
|
|
259
|
+
|
|
260
|
+
[**FreeToolFormatLinkedInPostResponse**](FreeToolFormatLinkedInPostResponse.md)
|
|
261
|
+
|
|
262
|
+
### Authorization
|
|
263
|
+
|
|
264
|
+
No authorization required
|
|
265
|
+
|
|
266
|
+
### HTTP request headers
|
|
267
|
+
|
|
268
|
+
- **Content-Type**: application/json
|
|
269
|
+
- **Accept**: application/json
|
|
270
|
+
|
|
271
|
+
|
|
272
|
+
## generate_fancy_text
|
|
273
|
+
|
|
274
|
+
> <FreeToolGenerateFancyTextResponse> generate_fancy_text(free_tool_generate_fancy_text_request)
|
|
275
|
+
|
|
276
|
+
Convert text to fancy Unicode styles
|
|
277
|
+
|
|
278
|
+
Convert text to fancy Unicode styles. The same logic as the free web tool at https://postboost.co/tools/fancy-text-generator. No account needed: call it without a token, or with any API token.
|
|
279
|
+
|
|
280
|
+
### Examples
|
|
281
|
+
|
|
282
|
+
```ruby
|
|
283
|
+
require 'time'
|
|
284
|
+
require 'postboost'
|
|
285
|
+
|
|
286
|
+
api_instance = PostBoost::FreeToolsApi.new
|
|
287
|
+
free_tool_generate_fancy_text_request = PostBoost::FreeToolGenerateFancyTextRequest.new({text: 'text_example'}) # FreeToolGenerateFancyTextRequest |
|
|
288
|
+
|
|
289
|
+
begin
|
|
290
|
+
# Convert text to fancy Unicode styles
|
|
291
|
+
result = api_instance.generate_fancy_text(free_tool_generate_fancy_text_request)
|
|
292
|
+
p result
|
|
293
|
+
rescue PostBoost::ApiError => e
|
|
294
|
+
puts "Error when calling FreeToolsApi->generate_fancy_text: #{e}"
|
|
295
|
+
end
|
|
296
|
+
```
|
|
297
|
+
|
|
298
|
+
#### Using the generate_fancy_text_with_http_info variant
|
|
299
|
+
|
|
300
|
+
This returns an Array which contains the response data, status code and headers.
|
|
301
|
+
|
|
302
|
+
> <Array(<FreeToolGenerateFancyTextResponse>, Integer, Hash)> generate_fancy_text_with_http_info(free_tool_generate_fancy_text_request)
|
|
303
|
+
|
|
304
|
+
```ruby
|
|
305
|
+
begin
|
|
306
|
+
# Convert text to fancy Unicode styles
|
|
307
|
+
data, status_code, headers = api_instance.generate_fancy_text_with_http_info(free_tool_generate_fancy_text_request)
|
|
308
|
+
p status_code # => 2xx
|
|
309
|
+
p headers # => { ... }
|
|
310
|
+
p data # => <FreeToolGenerateFancyTextResponse>
|
|
311
|
+
rescue PostBoost::ApiError => e
|
|
312
|
+
puts "Error when calling FreeToolsApi->generate_fancy_text_with_http_info: #{e}"
|
|
313
|
+
end
|
|
314
|
+
```
|
|
315
|
+
|
|
316
|
+
### Parameters
|
|
317
|
+
|
|
318
|
+
| Name | Type | Description | Notes |
|
|
319
|
+
| ---- | ---- | ----------- | ----- |
|
|
320
|
+
| **free_tool_generate_fancy_text_request** | [**FreeToolGenerateFancyTextRequest**](FreeToolGenerateFancyTextRequest.md) | | |
|
|
321
|
+
|
|
322
|
+
### Return type
|
|
323
|
+
|
|
324
|
+
[**FreeToolGenerateFancyTextResponse**](FreeToolGenerateFancyTextResponse.md)
|
|
325
|
+
|
|
326
|
+
### Authorization
|
|
327
|
+
|
|
328
|
+
No authorization required
|
|
329
|
+
|
|
330
|
+
### HTTP request headers
|
|
331
|
+
|
|
332
|
+
- **Content-Type**: application/json
|
|
333
|
+
- **Accept**: application/json
|
|
334
|
+
|
|
335
|
+
|
|
336
|
+
## list_free_tools
|
|
337
|
+
|
|
338
|
+
> <FreeToolList> list_free_tools
|
|
339
|
+
|
|
340
|
+
List the free tools
|
|
341
|
+
|
|
342
|
+
Every free tool the API serves, with its operationId and web page. No token needed.
|
|
343
|
+
|
|
344
|
+
### Examples
|
|
345
|
+
|
|
346
|
+
```ruby
|
|
347
|
+
require 'time'
|
|
348
|
+
require 'postboost'
|
|
349
|
+
|
|
350
|
+
api_instance = PostBoost::FreeToolsApi.new
|
|
351
|
+
|
|
352
|
+
begin
|
|
353
|
+
# List the free tools
|
|
354
|
+
result = api_instance.list_free_tools
|
|
355
|
+
p result
|
|
356
|
+
rescue PostBoost::ApiError => e
|
|
357
|
+
puts "Error when calling FreeToolsApi->list_free_tools: #{e}"
|
|
358
|
+
end
|
|
359
|
+
```
|
|
360
|
+
|
|
361
|
+
#### Using the list_free_tools_with_http_info variant
|
|
362
|
+
|
|
363
|
+
This returns an Array which contains the response data, status code and headers.
|
|
364
|
+
|
|
365
|
+
> <Array(<FreeToolList>, Integer, Hash)> list_free_tools_with_http_info
|
|
366
|
+
|
|
367
|
+
```ruby
|
|
368
|
+
begin
|
|
369
|
+
# List the free tools
|
|
370
|
+
data, status_code, headers = api_instance.list_free_tools_with_http_info
|
|
371
|
+
p status_code # => 2xx
|
|
372
|
+
p headers # => { ... }
|
|
373
|
+
p data # => <FreeToolList>
|
|
374
|
+
rescue PostBoost::ApiError => e
|
|
375
|
+
puts "Error when calling FreeToolsApi->list_free_tools_with_http_info: #{e}"
|
|
376
|
+
end
|
|
377
|
+
```
|
|
378
|
+
|
|
379
|
+
### Parameters
|
|
380
|
+
|
|
381
|
+
This endpoint does not need any parameter.
|
|
382
|
+
|
|
383
|
+
### Return type
|
|
384
|
+
|
|
385
|
+
[**FreeToolList**](FreeToolList.md)
|
|
386
|
+
|
|
387
|
+
### Authorization
|
|
388
|
+
|
|
389
|
+
No authorization required
|
|
390
|
+
|
|
391
|
+
### HTTP request headers
|
|
392
|
+
|
|
393
|
+
- **Content-Type**: Not defined
|
|
394
|
+
- **Accept**: application/json
|
|
395
|
+
|
|
396
|
+
|
|
397
|
+
## split_thread
|
|
398
|
+
|
|
399
|
+
> <FreeToolSplitThreadResponse> split_thread(free_tool_split_thread_request)
|
|
400
|
+
|
|
401
|
+
Split long text into a thread
|
|
402
|
+
|
|
403
|
+
Split long text into a thread. The same logic as the free web tool at https://postboost.co/tools/x-thread-maker. No account needed: call it without a token, or with any API token.
|
|
404
|
+
|
|
405
|
+
### Examples
|
|
406
|
+
|
|
407
|
+
```ruby
|
|
408
|
+
require 'time'
|
|
409
|
+
require 'postboost'
|
|
410
|
+
|
|
411
|
+
api_instance = PostBoost::FreeToolsApi.new
|
|
412
|
+
free_tool_split_thread_request = PostBoost::FreeToolSplitThreadRequest.new # FreeToolSplitThreadRequest |
|
|
413
|
+
|
|
414
|
+
begin
|
|
415
|
+
# Split long text into a thread
|
|
416
|
+
result = api_instance.split_thread(free_tool_split_thread_request)
|
|
417
|
+
p result
|
|
418
|
+
rescue PostBoost::ApiError => e
|
|
419
|
+
puts "Error when calling FreeToolsApi->split_thread: #{e}"
|
|
420
|
+
end
|
|
421
|
+
```
|
|
422
|
+
|
|
423
|
+
#### Using the split_thread_with_http_info variant
|
|
424
|
+
|
|
425
|
+
This returns an Array which contains the response data, status code and headers.
|
|
426
|
+
|
|
427
|
+
> <Array(<FreeToolSplitThreadResponse>, Integer, Hash)> split_thread_with_http_info(free_tool_split_thread_request)
|
|
428
|
+
|
|
429
|
+
```ruby
|
|
430
|
+
begin
|
|
431
|
+
# Split long text into a thread
|
|
432
|
+
data, status_code, headers = api_instance.split_thread_with_http_info(free_tool_split_thread_request)
|
|
433
|
+
p status_code # => 2xx
|
|
434
|
+
p headers # => { ... }
|
|
435
|
+
p data # => <FreeToolSplitThreadResponse>
|
|
436
|
+
rescue PostBoost::ApiError => e
|
|
437
|
+
puts "Error when calling FreeToolsApi->split_thread_with_http_info: #{e}"
|
|
438
|
+
end
|
|
439
|
+
```
|
|
440
|
+
|
|
441
|
+
### Parameters
|
|
442
|
+
|
|
443
|
+
| Name | Type | Description | Notes |
|
|
444
|
+
| ---- | ---- | ----------- | ----- |
|
|
445
|
+
| **free_tool_split_thread_request** | [**FreeToolSplitThreadRequest**](FreeToolSplitThreadRequest.md) | | |
|
|
446
|
+
|
|
447
|
+
### Return type
|
|
448
|
+
|
|
449
|
+
[**FreeToolSplitThreadResponse**](FreeToolSplitThreadResponse.md)
|
|
450
|
+
|
|
451
|
+
### Authorization
|
|
452
|
+
|
|
453
|
+
No authorization required
|
|
454
|
+
|
|
455
|
+
### HTTP request headers
|
|
456
|
+
|
|
457
|
+
- **Content-Type**: application/json
|
|
458
|
+
- **Accept**: application/json
|
|
459
|
+
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
|
|
4
4
|
#The PostBoost REST API lets you publish, schedule, and analyze social media posts across 12+ platforms from a single integration. No OAuth apps to maintain — PostBoost handles platform authorization for you. ## Base URL All workspace-scoped endpoints are prefixed with `/{workspaceUuid}`. Panel/admin endpoints are prefixed with `/panel`. ## Plan access Every workspace-scoped endpoint returns `403` when the workspace's plan does not include API access (capability `api`). ## Dates and times Post dates and times (`date`, `time`, `accounts_schedule`) are read in the request's `timezone` when one is given, otherwise in the workspace timezone. ## Idempotent requests Send an `Idempotency-Key` header (any unique string, for example a UUID) with a `POST`. Repeating the request with the same key within 24 hours returns the stored response with `Idempotent-Replayed: true` and creates nothing new. Reusing a key with a different body returns `422`; a request still in progress with the same key returns `409`. `5xx` and `429` responses are not stored, so they can be retried with the same key. ## Guardrails for automated clients Create and update requests are checked before anything is written: a post whose content matches one created for the same account in the last 24 hours returns `409` (`code: duplicate_post`, override with `allow_duplicate: true`), scheduling past an account's daily cap returns `429` (`code: account_daily_cap_reached`), and scheduling to an account that must be reconnected returns `422` (`code: account_unauthorized` or `account_token_missing`). Use `POST /{workspaceUuid}/posts/validate` for a dry run and `GET /{workspaceUuid}/activity` to review what API clients did. ## Authentication All requests require a Bearer token in the `Authorization` header. Generate tokens in your PostBoost dashboard under **Settings → Access Tokens**. ``` Authorization: Bearer YOUR_API_TOKEN ```
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: 1.
|
|
6
|
+
The version of the OpenAPI document: 1.22.0
|
|
7
7
|
Contact: hi@postboost.co
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
Generator version: 7.9.0
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
|
|
4
4
|
#The PostBoost REST API lets you publish, schedule, and analyze social media posts across 12+ platforms from a single integration. No OAuth apps to maintain — PostBoost handles platform authorization for you. ## Base URL All workspace-scoped endpoints are prefixed with `/{workspaceUuid}`. Panel/admin endpoints are prefixed with `/panel`. ## Plan access Every workspace-scoped endpoint returns `403` when the workspace's plan does not include API access (capability `api`). ## Dates and times Post dates and times (`date`, `time`, `accounts_schedule`) are read in the request's `timezone` when one is given, otherwise in the workspace timezone. ## Idempotent requests Send an `Idempotency-Key` header (any unique string, for example a UUID) with a `POST`. Repeating the request with the same key within 24 hours returns the stored response with `Idempotent-Replayed: true` and creates nothing new. Reusing a key with a different body returns `422`; a request still in progress with the same key returns `409`. `5xx` and `429` responses are not stored, so they can be retried with the same key. ## Guardrails for automated clients Create and update requests are checked before anything is written: a post whose content matches one created for the same account in the last 24 hours returns `409` (`code: duplicate_post`, override with `allow_duplicate: true`), scheduling past an account's daily cap returns `429` (`code: account_daily_cap_reached`), and scheduling to an account that must be reconnected returns `422` (`code: account_unauthorized` or `account_token_missing`). Use `POST /{workspaceUuid}/posts/validate` for a dry run and `GET /{workspaceUuid}/activity` to review what API clients did. ## Authentication All requests require a Bearer token in the `Authorization` header. Generate tokens in your PostBoost dashboard under **Settings → Access Tokens**. ``` Authorization: Bearer YOUR_API_TOKEN ```
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: 1.
|
|
6
|
+
The version of the OpenAPI document: 1.22.0
|
|
7
7
|
Contact: hi@postboost.co
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
Generator version: 7.9.0
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
|
|
4
4
|
#The PostBoost REST API lets you publish, schedule, and analyze social media posts across 12+ platforms from a single integration. No OAuth apps to maintain — PostBoost handles platform authorization for you. ## Base URL All workspace-scoped endpoints are prefixed with `/{workspaceUuid}`. Panel/admin endpoints are prefixed with `/panel`. ## Plan access Every workspace-scoped endpoint returns `403` when the workspace's plan does not include API access (capability `api`). ## Dates and times Post dates and times (`date`, `time`, `accounts_schedule`) are read in the request's `timezone` when one is given, otherwise in the workspace timezone. ## Idempotent requests Send an `Idempotency-Key` header (any unique string, for example a UUID) with a `POST`. Repeating the request with the same key within 24 hours returns the stored response with `Idempotent-Replayed: true` and creates nothing new. Reusing a key with a different body returns `422`; a request still in progress with the same key returns `409`. `5xx` and `429` responses are not stored, so they can be retried with the same key. ## Guardrails for automated clients Create and update requests are checked before anything is written: a post whose content matches one created for the same account in the last 24 hours returns `409` (`code: duplicate_post`, override with `allow_duplicate: true`), scheduling past an account's daily cap returns `429` (`code: account_daily_cap_reached`), and scheduling to an account that must be reconnected returns `422` (`code: account_unauthorized` or `account_token_missing`). Use `POST /{workspaceUuid}/posts/validate` for a dry run and `GET /{workspaceUuid}/activity` to review what API clients did. ## Authentication All requests require a Bearer token in the `Authorization` header. Generate tokens in your PostBoost dashboard under **Settings → Access Tokens**. ``` Authorization: Bearer YOUR_API_TOKEN ```
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: 1.
|
|
6
|
+
The version of the OpenAPI document: 1.22.0
|
|
7
7
|
Contact: hi@postboost.co
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
Generator version: 7.9.0
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
|
|
4
4
|
#The PostBoost REST API lets you publish, schedule, and analyze social media posts across 12+ platforms from a single integration. No OAuth apps to maintain — PostBoost handles platform authorization for you. ## Base URL All workspace-scoped endpoints are prefixed with `/{workspaceUuid}`. Panel/admin endpoints are prefixed with `/panel`. ## Plan access Every workspace-scoped endpoint returns `403` when the workspace's plan does not include API access (capability `api`). ## Dates and times Post dates and times (`date`, `time`, `accounts_schedule`) are read in the request's `timezone` when one is given, otherwise in the workspace timezone. ## Idempotent requests Send an `Idempotency-Key` header (any unique string, for example a UUID) with a `POST`. Repeating the request with the same key within 24 hours returns the stored response with `Idempotent-Replayed: true` and creates nothing new. Reusing a key with a different body returns `422`; a request still in progress with the same key returns `409`. `5xx` and `429` responses are not stored, so they can be retried with the same key. ## Guardrails for automated clients Create and update requests are checked before anything is written: a post whose content matches one created for the same account in the last 24 hours returns `409` (`code: duplicate_post`, override with `allow_duplicate: true`), scheduling past an account's daily cap returns `429` (`code: account_daily_cap_reached`), and scheduling to an account that must be reconnected returns `422` (`code: account_unauthorized` or `account_token_missing`). Use `POST /{workspaceUuid}/posts/validate` for a dry run and `GET /{workspaceUuid}/activity` to review what API clients did. ## Authentication All requests require a Bearer token in the `Authorization` header. Generate tokens in your PostBoost dashboard under **Settings → Access Tokens**. ``` Authorization: Bearer YOUR_API_TOKEN ```
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: 1.
|
|
6
|
+
The version of the OpenAPI document: 1.22.0
|
|
7
7
|
Contact: hi@postboost.co
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
Generator version: 7.9.0
|
data/lib/postboost/api/ai_api.rb
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
|
|
4
4
|
#The PostBoost REST API lets you publish, schedule, and analyze social media posts across 12+ platforms from a single integration. No OAuth apps to maintain — PostBoost handles platform authorization for you. ## Base URL All workspace-scoped endpoints are prefixed with `/{workspaceUuid}`. Panel/admin endpoints are prefixed with `/panel`. ## Plan access Every workspace-scoped endpoint returns `403` when the workspace's plan does not include API access (capability `api`). ## Dates and times Post dates and times (`date`, `time`, `accounts_schedule`) are read in the request's `timezone` when one is given, otherwise in the workspace timezone. ## Idempotent requests Send an `Idempotency-Key` header (any unique string, for example a UUID) with a `POST`. Repeating the request with the same key within 24 hours returns the stored response with `Idempotent-Replayed: true` and creates nothing new. Reusing a key with a different body returns `422`; a request still in progress with the same key returns `409`. `5xx` and `429` responses are not stored, so they can be retried with the same key. ## Guardrails for automated clients Create and update requests are checked before anything is written: a post whose content matches one created for the same account in the last 24 hours returns `409` (`code: duplicate_post`, override with `allow_duplicate: true`), scheduling past an account's daily cap returns `429` (`code: account_daily_cap_reached`), and scheduling to an account that must be reconnected returns `422` (`code: account_unauthorized` or `account_token_missing`). Use `POST /{workspaceUuid}/posts/validate` for a dry run and `GET /{workspaceUuid}/activity` to review what API clients did. ## Authentication All requests require a Bearer token in the `Authorization` header. Generate tokens in your PostBoost dashboard under **Settings → Access Tokens**. ``` Authorization: Bearer YOUR_API_TOKEN ```
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: 1.
|
|
6
|
+
The version of the OpenAPI document: 1.22.0
|
|
7
7
|
Contact: hi@postboost.co
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
Generator version: 7.9.0
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
|
|
4
4
|
#The PostBoost REST API lets you publish, schedule, and analyze social media posts across 12+ platforms from a single integration. No OAuth apps to maintain — PostBoost handles platform authorization for you. ## Base URL All workspace-scoped endpoints are prefixed with `/{workspaceUuid}`. Panel/admin endpoints are prefixed with `/panel`. ## Plan access Every workspace-scoped endpoint returns `403` when the workspace's plan does not include API access (capability `api`). ## Dates and times Post dates and times (`date`, `time`, `accounts_schedule`) are read in the request's `timezone` when one is given, otherwise in the workspace timezone. ## Idempotent requests Send an `Idempotency-Key` header (any unique string, for example a UUID) with a `POST`. Repeating the request with the same key within 24 hours returns the stored response with `Idempotent-Replayed: true` and creates nothing new. Reusing a key with a different body returns `422`; a request still in progress with the same key returns `409`. `5xx` and `429` responses are not stored, so they can be retried with the same key. ## Guardrails for automated clients Create and update requests are checked before anything is written: a post whose content matches one created for the same account in the last 24 hours returns `409` (`code: duplicate_post`, override with `allow_duplicate: true`), scheduling past an account's daily cap returns `429` (`code: account_daily_cap_reached`), and scheduling to an account that must be reconnected returns `422` (`code: account_unauthorized` or `account_token_missing`). Use `POST /{workspaceUuid}/posts/validate` for a dry run and `GET /{workspaceUuid}/activity` to review what API clients did. ## Authentication All requests require a Bearer token in the `Authorization` header. Generate tokens in your PostBoost dashboard under **Settings → Access Tokens**. ``` Authorization: Bearer YOUR_API_TOKEN ```
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: 1.
|
|
6
|
+
The version of the OpenAPI document: 1.22.0
|
|
7
7
|
Contact: hi@postboost.co
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
Generator version: 7.9.0
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
|
|
4
4
|
#The PostBoost REST API lets you publish, schedule, and analyze social media posts across 12+ platforms from a single integration. No OAuth apps to maintain — PostBoost handles platform authorization for you. ## Base URL All workspace-scoped endpoints are prefixed with `/{workspaceUuid}`. Panel/admin endpoints are prefixed with `/panel`. ## Plan access Every workspace-scoped endpoint returns `403` when the workspace's plan does not include API access (capability `api`). ## Dates and times Post dates and times (`date`, `time`, `accounts_schedule`) are read in the request's `timezone` when one is given, otherwise in the workspace timezone. ## Idempotent requests Send an `Idempotency-Key` header (any unique string, for example a UUID) with a `POST`. Repeating the request with the same key within 24 hours returns the stored response with `Idempotent-Replayed: true` and creates nothing new. Reusing a key with a different body returns `422`; a request still in progress with the same key returns `409`. `5xx` and `429` responses are not stored, so they can be retried with the same key. ## Guardrails for automated clients Create and update requests are checked before anything is written: a post whose content matches one created for the same account in the last 24 hours returns `409` (`code: duplicate_post`, override with `allow_duplicate: true`), scheduling past an account's daily cap returns `429` (`code: account_daily_cap_reached`), and scheduling to an account that must be reconnected returns `422` (`code: account_unauthorized` or `account_token_missing`). Use `POST /{workspaceUuid}/posts/validate` for a dry run and `GET /{workspaceUuid}/activity` to review what API clients did. ## Authentication All requests require a Bearer token in the `Authorization` header. Generate tokens in your PostBoost dashboard under **Settings → Access Tokens**. ``` Authorization: Bearer YOUR_API_TOKEN ```
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: 1.
|
|
6
|
+
The version of the OpenAPI document: 1.22.0
|
|
7
7
|
Contact: hi@postboost.co
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
Generator version: 7.9.0
|