postboost 1.8.0 → 1.14.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/CODE_OF_CONDUCT.md +7 -0
- data/CONTRIBUTING.md +31 -0
- data/README.md +134 -1
- data/SECURITY.md +9 -0
- data/docs/AIApi.md +432 -0
- data/docs/AIUsage.md +20 -0
- data/docs/AIUsageText.md +24 -0
- data/docs/Account.md +6 -2
- data/docs/AccountConnectionHealth.md +34 -0
- data/docs/AccountErrorsInner.md +49 -0
- data/docs/AccountErrorsInnerOneOf.md +24 -0
- data/docs/AccountGroup.md +24 -0
- data/docs/AccountGroupInput.md +20 -0
- data/docs/AccountGroupsApi.md +372 -0
- data/docs/AccountHealth.md +34 -0
- data/docs/AccountHealthDailyCap.md +20 -0
- data/docs/AccountsApi.md +216 -0
- data/docs/ActivityApi.md +87 -0
- data/docs/AddCompetitor202Response.md +20 -0
- data/docs/AddCompetitor409Response.md +20 -0
- data/docs/AgentPageMeta.md +24 -0
- data/docs/AgentProposal.md +44 -0
- data/docs/AgentProposalDecision.md +18 -0
- data/docs/AgentRun.md +44 -0
- data/docs/AgentsApi.md +745 -0
- data/docs/AnalyticsApi.md +498 -0
- data/docs/ApiActivity.md +36 -0
- data/docs/ApiActivityOutcome.md +15 -0
- data/docs/ApiKey.md +32 -0
- data/docs/ApiKeyAbility.md +15 -0
- data/docs/ApiKeyInput.md +24 -0
- data/docs/ApproveAgentProposal200Response.md +18 -0
- data/docs/ApproveAgentProposal409Response.md +20 -0
- data/docs/ApproveInboxReplyDraft403Response.md +20 -0
- data/docs/BlogToSocial200Response.md +3 -1
- data/docs/BlogToSocialInput.md +3 -1
- data/docs/BrandVoice.md +48 -0
- data/docs/BrandVoiceInput.md +46 -0
- data/docs/BrandVoiceMeta.md +18 -0
- data/docs/ChannelAccount.md +36 -0
- data/docs/CodedError.md +22 -0
- data/docs/Competitor.md +34 -0
- data/docs/CompetitorDetail.md +38 -0
- data/docs/CompetitorInput.md +20 -0
- data/docs/CompetitorMedia.md +28 -0
- data/docs/CompetitorSnapshot.md +22 -0
- data/docs/CompetitorsApi.md +296 -0
- data/docs/ConnectChannelInput.md +24 -0
- data/docs/CreateAccountGroup201Response.md +18 -0
- data/docs/CreateAgent201Response.md +18 -0
- data/docs/CreateApiKey201Response.md +18 -0
- data/docs/CreateApiKey201ResponseData.md +34 -0
- data/docs/CreateHashtagGroup201Response.md +18 -0
- data/docs/CreateInboxReplyDraft201Response.md +18 -0
- data/docs/CreateRecyclingRule201Response.md +18 -0
- data/docs/CreateReportExport201Response.md +18 -0
- data/docs/CreateResellerClient201Response.md +18 -0
- data/docs/CreateRssFeed201Response.md +18 -0
- data/docs/CreateTemplate201Response.md +18 -0
- data/docs/CreateWebhookSubscription201Response.md +18 -0
- data/docs/CreateWebhookSubscription201ResponseData.md +30 -0
- data/docs/DeleteAgent200Response.md +18 -0
- data/docs/GetAccountHealth200Response.md +18 -0
- data/docs/GetBrandVoice200Response.md +18 -0
- data/docs/GetCompetitor200Response.md +18 -0
- data/docs/GetInboxConversation200Response.md +18 -0
- data/docs/GetPostingSchedule200Response.md +18 -0
- data/docs/GetReportBranding200Response.md +18 -0
- data/docs/GuardrailError.md +28 -0
- data/docs/HashtagGroup.md +22 -0
- data/docs/HashtagGroupInput.md +20 -0
- data/docs/HashtagGroupsApi.md +372 -0
- data/docs/ImageCreditBalance.md +28 -0
- data/docs/ImageEditInput.md +2 -0
- data/docs/ImageGenerate200Response.md +3 -1
- data/docs/ImageGenerateInput.md +3 -1
- data/docs/ImagePrompt200Response.md +3 -1
- data/docs/ImagePromptInput.md +3 -1
- data/docs/InboxApi.md +758 -0
- data/docs/InboxAuthor.md +22 -0
- data/docs/InboxConversation.md +46 -0
- data/docs/InboxConversationAccount.md +24 -0
- data/docs/InboxConversationUpdate.md +20 -0
- data/docs/InboxMessage.md +32 -0
- data/docs/InboxMessageAuthor.md +22 -0
- data/docs/InboxReplyDraft.md +42 -0
- data/docs/InboxReplyDraftApprove.md +18 -0
- data/docs/InboxReplyDraftEdit.md +18 -0
- data/docs/InboxReplyDraftInput.md +20 -0
- data/docs/LearnBrandVoiceInput.md +24 -0
- data/docs/LearnBrandVoiceResponse.md +20 -0
- data/docs/LearnBrandVoiceResponseMeta.md +26 -0
- data/docs/ListAccountGroups200Response.md +22 -0
- data/docs/ListAgentProposals200Response.md +20 -0
- data/docs/ListAgentRuns200Response.md +20 -0
- data/docs/ListAgents200Response.md +18 -0
- data/docs/ListApiActivity200Response.md +22 -0
- data/docs/ListApiKeys200Response.md +18 -0
- data/docs/ListCompetitors200Response.md +18 -0
- data/docs/ListHashtagGroups200Response.md +22 -0
- data/docs/ListInboxConversations200Response.md +22 -0
- data/docs/ListInboxReplyDrafts200Response.md +22 -0
- data/docs/ListRecyclingRules200Response.md +18 -0
- data/docs/ListRecyclingRuns200Response.md +18 -0
- data/docs/ListReportExports200Response.md +18 -0
- data/docs/ListResellerClients200Response.md +20 -0
- data/docs/ListRssFeeds200Response.md +18 -0
- data/docs/ListTemplates200Response.md +22 -0
- data/docs/ListWebhookSubscriptions200Response.md +18 -0
- data/docs/MediaApi.md +103 -13
- data/docs/MediaBase64Input.md +24 -0
- data/docs/MentionsApi.md +8 -4
- data/docs/MessageOnly.md +18 -0
- data/docs/PollRssFeed200Response.md +22 -0
- data/docs/PostContent.md +1 -1
- data/docs/PostInput.md +5 -1
- data/docs/PostOptionsInstagram.md +22 -0
- data/docs/PostOptionsTikTok.md +34 -0
- data/docs/PostOptionsYoutube.md +24 -0
- data/docs/PostVersion.md +2 -2
- data/docs/PostVersionOptions.md +24 -0
- data/docs/PostingSchedule.md +28 -0
- data/docs/PostingScheduleApi.md +377 -0
- data/docs/PostingScheduleDay.md +22 -0
- data/docs/PostingScheduleDayTimesInner.md +18 -0
- data/docs/PostingScheduleInput.md +24 -0
- data/docs/PostsApi.md +1132 -110
- data/docs/PreflightResult.md +26 -0
- data/docs/QueueSlots.md +20 -0
- data/docs/RecommendedPostingTimes.md +26 -0
- data/docs/ReconnectLink.md +22 -0
- data/docs/RecyclingRule.md +42 -0
- data/docs/RecyclingRuleInput.md +34 -0
- data/docs/RecyclingRuleSettings.md +28 -0
- data/docs/RecyclingRuleUpdate.md +28 -0
- data/docs/RecyclingRun.md +28 -0
- data/docs/ReportBranding.md +28 -0
- data/docs/ReportBrandingInput.md +24 -0
- data/docs/ReportExport.md +42 -0
- data/docs/ReportExportInput.md +28 -0
- data/docs/RepurposeContent200Response.md +20 -0
- data/docs/RepurposeInput.md +54 -0
- data/docs/RepurposeInputTheme.md +22 -0
- data/docs/RepurposeResult.md +32 -0
- data/docs/RepurposeResultMedia.md +20 -0
- data/docs/RepurposeResultSource.md +22 -0
- data/docs/RepurposeSlide.md +20 -0
- data/docs/ResellerClient.md +32 -0
- data/docs/ResellerClientInput.md +18 -0
- data/docs/ResellerClientUsage.md +20 -0
- data/docs/RssFeed.md +38 -0
- data/docs/RssFeedInput.md +30 -0
- data/docs/RssFeedUpdate.md +30 -0
- data/docs/RunAgent202Response.md +18 -0
- data/docs/TagsApi.md +8 -4
- data/docs/Template.md +22 -0
- data/docs/TemplateContentItem.md +20 -0
- data/docs/TemplateInput.md +20 -0
- data/docs/TemplateInputContentInner.md +20 -0
- data/docs/TemplatesApi.md +372 -0
- data/docs/WebhookEventName.md +15 -0
- data/docs/WebhookEventPayload.md +20 -0
- data/docs/WebhookSubscription.md +28 -0
- data/docs/WebhookSubscriptionInput.md +24 -0
- data/docs/WebhooksApi.md +221 -0
- data/docs/WorkspaceAgent.md +34 -0
- data/docs/WorkspaceAgentInput.md +26 -0
- data/docs/WorkspaceAgentSettings.md +26 -0
- data/docs/WorkspaceAgentUpdate.md +24 -0
- data/docs/WorkspacesApi.md +426 -0
- data/docs/XUsage.md +28 -0
- data/docs/XUsageCounter.md +20 -0
- data/lib/postboost/api/account_groups_api.rb +395 -0
- data/lib/postboost/api/accounts_api.rb +219 -2
- data/lib/postboost/api/activity_api.rb +97 -0
- data/lib/postboost/api/agents_api.rb +771 -0
- data/lib/postboost/api/ai_api.rb +420 -2
- data/lib/postboost/api/analytics_api.rb +487 -2
- data/lib/postboost/api/competitors_api.rb +300 -0
- data/lib/postboost/api/hashtag_groups_api.rb +395 -0
- data/lib/postboost/api/inbox_api.rb +789 -0
- data/lib/postboost/api/media_api.rb +133 -4
- data/lib/postboost/api/mentions_api.rb +13 -2
- data/lib/postboost/api/posting_schedule_api.rb +389 -0
- data/lib/postboost/api/posts_api.rb +1149 -96
- data/lib/postboost/api/receipts_api.rb +2 -2
- data/lib/postboost/api/subscriptions_api.rb +2 -2
- data/lib/postboost/api/tags_api.rb +13 -2
- data/lib/postboost/api/templates_api.rb +395 -0
- data/lib/postboost/api/users_api.rb +2 -2
- data/lib/postboost/api/webhooks_api.rb +228 -0
- data/lib/postboost/api/workspaces_api.rb +408 -2
- data/lib/postboost/api_client.rb +2 -2
- data/lib/postboost/api_error.rb +2 -2
- data/lib/postboost/configuration.rb +2 -2
- data/lib/postboost/models/account.rb +28 -4
- data/lib/postboost/models/account_analytics.rb +2 -2
- data/lib/postboost/models/account_analytics_initial_sync.rb +2 -2
- data/lib/postboost/models/account_connection_health.rb +389 -0
- data/lib/postboost/models/account_errors_inner.rb +105 -0
- data/lib/postboost/models/account_errors_inner_one_of.rb +243 -0
- data/lib/postboost/models/account_group.rb +271 -0
- data/lib/postboost/models/account_group_input.rb +252 -0
- data/lib/postboost/models/account_health.rb +352 -0
- data/lib/postboost/models/account_health_daily_cap.rb +239 -0
- data/lib/postboost/models/account_schedule.rb +2 -2
- data/lib/postboost/models/add_competitor202_response.rb +271 -0
- data/lib/postboost/models/add_competitor409_response.rb +223 -0
- data/lib/postboost/models/add_generic_subscription_request.rb +2 -2
- data/lib/postboost/models/add_post_to_queue_request.rb +2 -2
- data/lib/postboost/models/agent_page_meta.rb +269 -0
- data/lib/postboost/models/agent_proposal.rb +444 -0
- data/lib/postboost/models/agent_proposal_decision.rb +233 -0
- data/lib/postboost/models/agent_run.rb +434 -0
- data/lib/postboost/models/ai_credits.rb +2 -2
- data/lib/postboost/models/ai_usage.rb +237 -0
- data/lib/postboost/models/ai_usage_text.rb +252 -0
- data/lib/postboost/models/analytics_period.rb +2 -2
- data/lib/postboost/models/analytics_summary.rb +2 -2
- data/lib/postboost/models/analytics_summary_data.rb +2 -2
- data/lib/postboost/models/api_activity.rb +359 -0
- data/lib/postboost/models/api_activity_outcome.rb +49 -0
- data/lib/postboost/models/api_key.rb +308 -0
- data/lib/postboost/models/api_key_ability.rb +43 -0
- data/lib/postboost/models/api_key_input.rb +316 -0
- data/lib/postboost/models/approve_agent_proposal200_response.rb +221 -0
- data/lib/postboost/models/approve_agent_proposal409_response.rb +237 -0
- data/lib/postboost/models/approve_inbox_reply_draft403_response.rb +264 -0
- data/lib/postboost/models/approve_post_request.rb +2 -2
- data/lib/postboost/models/best_posting_times.rb +2 -2
- data/lib/postboost/models/best_posting_times_times_inner.rb +2 -2
- data/lib/postboost/models/blog_to_social200_response.rb +15 -6
- data/lib/postboost/models/blog_to_social429_response.rb +2 -2
- data/lib/postboost/models/blog_to_social_caption.rb +2 -2
- data/lib/postboost/models/blog_to_social_input.rb +18 -6
- data/lib/postboost/models/blog_to_social_media.rb +2 -2
- data/lib/postboost/models/blog_to_social_response.rb +2 -2
- data/lib/postboost/models/brand_voice.rb +531 -0
- data/lib/postboost/models/brand_voice_input.rb +646 -0
- data/lib/postboost/models/brand_voice_meta.rb +222 -0
- data/lib/postboost/models/cancel_subscription422_response.rb +2 -2
- data/lib/postboost/models/cancel_subscription422_response_errors.rb +2 -2
- data/lib/postboost/models/cancel_subscription_request.rb +2 -2
- data/lib/postboost/models/change_subscription_plan_request.rb +2 -2
- data/lib/postboost/models/channel_account.rb +380 -0
- data/lib/postboost/models/checkout_subscription200_response.rb +2 -2
- data/lib/postboost/models/checkout_subscription_request.rb +2 -2
- data/lib/postboost/models/coded_error.rb +242 -0
- data/lib/postboost/models/competitor.rb +320 -0
- data/lib/postboost/models/competitor_detail.rb +358 -0
- data/lib/postboost/models/competitor_input.rb +258 -0
- data/lib/postboost/models/competitor_media.rb +263 -0
- data/lib/postboost/models/competitor_snapshot.rb +234 -0
- data/lib/postboost/models/complete_chunked_upload_request.rb +2 -2
- data/lib/postboost/models/connect_channel_input.rb +265 -0
- data/lib/postboost/models/create_account_group201_response.rb +221 -0
- data/lib/postboost/models/create_agent201_response.rb +221 -0
- data/lib/postboost/models/create_api_key201_response.rb +221 -0
- data/lib/postboost/models/create_api_key201_response_data.rb +327 -0
- data/lib/postboost/models/create_hashtag_group201_response.rb +221 -0
- data/lib/postboost/models/create_inbox_reply_draft201_response.rb +221 -0
- data/lib/postboost/models/create_media_folder_request.rb +2 -2
- data/lib/postboost/models/create_mention201_response.rb +2 -2
- data/lib/postboost/models/create_recycling_rule201_response.rb +221 -0
- data/lib/postboost/models/create_report_export201_response.rb +221 -0
- data/lib/postboost/models/create_reseller_client201_response.rb +221 -0
- data/lib/postboost/models/create_rss_feed201_response.rb +221 -0
- data/lib/postboost/models/create_template201_response.rb +221 -0
- data/lib/postboost/models/create_webhook_subscription201_response.rb +221 -0
- data/lib/postboost/models/create_webhook_subscription201_response_data.rb +320 -0
- data/lib/postboost/models/delete_agent200_response.rb +221 -0
- data/lib/postboost/models/delete_media_bulk_request.rb +2 -2
- data/lib/postboost/models/delete_media_bulk_request_items_inner.rb +2 -2
- data/lib/postboost/models/delete_media_folder_request.rb +2 -2
- data/lib/postboost/models/delete_mode.rb +2 -2
- data/lib/postboost/models/delete_post_request.rb +2 -2
- data/lib/postboost/models/delete_posts_bulk_request.rb +2 -2
- data/lib/postboost/models/delete_receipts_bulk_request.rb +2 -2
- data/lib/postboost/models/delete_result.rb +2 -2
- data/lib/postboost/models/delete_user400_response.rb +2 -2
- data/lib/postboost/models/delete_users_bulk_request.rb +2 -2
- data/lib/postboost/models/delete_workspaces_bulk_request.rb +2 -2
- data/lib/postboost/models/get_account_health200_response.rb +223 -0
- data/lib/postboost/models/get_brand_voice200_response.rb +217 -0
- data/lib/postboost/models/get_competitor200_response.rb +221 -0
- data/lib/postboost/models/get_inbox_conversation200_response.rb +221 -0
- data/lib/postboost/models/get_posting_schedule200_response.rb +221 -0
- data/lib/postboost/models/get_remote_upload_status200_response.rb +2 -2
- data/lib/postboost/models/get_report_branding200_response.rb +221 -0
- data/lib/postboost/models/guardrail_error.rb +304 -0
- data/lib/postboost/models/hashtag_group.rb +254 -0
- data/lib/postboost/models/hashtag_group_input.rb +275 -0
- data/lib/postboost/models/image_alt_text200_response.rb +2 -2
- data/lib/postboost/models/image_alt_text_input.rb +2 -2
- data/lib/postboost/models/image_alt_text_response.rb +2 -2
- data/lib/postboost/models/image_credit_balance.rb +295 -0
- data/lib/postboost/models/image_edit_input.rb +15 -3
- data/lib/postboost/models/image_generate200_response.rb +15 -6
- data/lib/postboost/models/image_generate429_response.rb +2 -2
- data/lib/postboost/models/image_generate_input.rb +35 -3
- data/lib/postboost/models/image_generation_response.rb +2 -2
- data/lib/postboost/models/image_prompt200_response.rb +15 -6
- data/lib/postboost/models/image_prompt429_response.rb +2 -2
- data/lib/postboost/models/image_prompt_input.rb +35 -3
- data/lib/postboost/models/image_prompt_response.rb +2 -2
- data/lib/postboost/models/image_variations200_response.rb +2 -2
- data/lib/postboost/models/image_variations_input.rb +2 -2
- data/lib/postboost/models/image_variations_response.rb +2 -2
- data/lib/postboost/models/inbox_author.rb +235 -0
- data/lib/postboost/models/inbox_conversation.rb +425 -0
- data/lib/postboost/models/inbox_conversation_account.rb +241 -0
- data/lib/postboost/models/inbox_conversation_update.rb +257 -0
- data/lib/postboost/models/inbox_message.rb +360 -0
- data/lib/postboost/models/inbox_message_author.rb +235 -0
- data/lib/postboost/models/inbox_reply_draft.rb +410 -0
- data/lib/postboost/models/inbox_reply_draft_approve.rb +215 -0
- data/lib/postboost/models/inbox_reply_draft_edit.rb +221 -0
- data/lib/postboost/models/inbox_reply_draft_input.rb +232 -0
- data/lib/postboost/models/initiate_chunked_upload201_response.rb +2 -2
- data/lib/postboost/models/initiate_chunked_upload_request.rb +2 -2
- data/lib/postboost/models/initiate_remote_upload201_response.rb +2 -2
- data/lib/postboost/models/initiate_remote_upload201_response_one_of.rb +2 -2
- data/lib/postboost/models/initiate_remote_upload_request.rb +2 -2
- data/lib/postboost/models/learn_brand_voice_input.rb +300 -0
- data/lib/postboost/models/learn_brand_voice_response.rb +237 -0
- data/lib/postboost/models/learn_brand_voice_response_meta.rb +281 -0
- data/lib/postboost/models/list_account_groups200_response.rb +248 -0
- data/lib/postboost/models/list_accounts200_response.rb +2 -2
- data/lib/postboost/models/list_agent_proposals200_response.rb +239 -0
- data/lib/postboost/models/list_agent_runs200_response.rb +239 -0
- data/lib/postboost/models/list_agents200_response.rb +223 -0
- data/lib/postboost/models/list_api_activity200_response.rb +241 -0
- data/lib/postboost/models/list_api_keys200_response.rb +223 -0
- data/lib/postboost/models/list_competitors200_response.rb +223 -0
- data/lib/postboost/models/list_hashtag_groups200_response.rb +248 -0
- data/lib/postboost/models/list_inbox_conversations200_response.rb +241 -0
- data/lib/postboost/models/list_inbox_reply_drafts200_response.rb +241 -0
- data/lib/postboost/models/list_media200_response.rb +2 -2
- data/lib/postboost/models/list_media_folders200_response.rb +2 -2
- data/lib/postboost/models/list_mentions200_response.rb +2 -2
- data/lib/postboost/models/list_my_workspaces200_response.rb +2 -2
- data/lib/postboost/models/list_posts200_response.rb +2 -2
- data/lib/postboost/models/list_receipts200_response.rb +2 -2
- data/lib/postboost/models/list_recycling_rules200_response.rb +223 -0
- data/lib/postboost/models/list_recycling_runs200_response.rb +223 -0
- data/lib/postboost/models/list_report_exports200_response.rb +223 -0
- data/lib/postboost/models/list_reseller_clients200_response.rb +239 -0
- data/lib/postboost/models/list_rss_feeds200_response.rb +223 -0
- data/lib/postboost/models/list_tags200_response.rb +2 -2
- data/lib/postboost/models/list_templates200_response.rb +248 -0
- data/lib/postboost/models/list_users200_response.rb +2 -2
- data/lib/postboost/models/list_webhook_subscriptions200_response.rb +223 -0
- data/lib/postboost/models/list_workspaces200_response.rb +2 -2
- data/lib/postboost/models/media.rb +2 -2
- data/lib/postboost/models/media_base64_input.rb +295 -0
- data/lib/postboost/models/media_folder.rb +2 -2
- data/lib/postboost/models/media_folder_input.rb +2 -2
- data/lib/postboost/models/media_folder_ref.rb +2 -2
- data/lib/postboost/models/mention.rb +2 -2
- data/lib/postboost/models/mention_identity.rb +2 -2
- data/lib/postboost/models/mention_identity_input.rb +2 -2
- data/lib/postboost/models/mention_input.rb +2 -2
- data/lib/postboost/models/message_only.rb +221 -0
- data/lib/postboost/models/pagination_meta.rb +2 -2
- data/lib/postboost/models/pagination_meta_links.rb +4 -2
- data/lib/postboost/models/pagination_meta_meta.rb +4 -2
- data/lib/postboost/models/poll_rss_feed200_response.rb +255 -0
- data/lib/postboost/models/post.rb +2 -2
- data/lib/postboost/models/post_analytics.rb +2 -2
- data/lib/postboost/models/post_content.rb +4 -3
- data/lib/postboost/models/post_input.rb +28 -6
- data/lib/postboost/models/post_options_instagram.rb +294 -0
- data/lib/postboost/models/post_options_tik_tok.rb +329 -0
- data/lib/postboost/models/post_options_youtube.rb +302 -0
- data/lib/postboost/models/post_status.rb +2 -2
- data/lib/postboost/models/post_version.rb +23 -4
- data/lib/postboost/models/post_version_options.rb +242 -0
- data/lib/postboost/models/posting_schedule.rb +303 -0
- data/lib/postboost/models/posting_schedule_day.rb +285 -0
- data/lib/postboost/models/posting_schedule_day_times_inner.rb +222 -0
- data/lib/postboost/models/posting_schedule_input.rb +312 -0
- data/lib/postboost/models/posting_time_slot.rb +2 -2
- data/lib/postboost/models/posting_times.rb +2 -2
- data/lib/postboost/models/posting_times_best_inner.rb +2 -2
- data/lib/postboost/models/posting_times_day_intervals_inner_inner.rb +2 -2
- data/lib/postboost/models/posting_times_days_inner.rb +2 -2
- data/lib/postboost/models/preflight_result.rb +291 -0
- data/lib/postboost/models/public_workspace.rb +2 -2
- data/lib/postboost/models/public_workspace_pivot.rb +2 -2
- data/lib/postboost/models/publish_progress.rb +2 -2
- data/lib/postboost/models/queue_slots.rb +237 -0
- data/lib/postboost/models/receipt.rb +2 -2
- data/lib/postboost/models/receipt_input.rb +2 -2
- data/lib/postboost/models/receipt_update_input.rb +2 -2
- data/lib/postboost/models/recommended_posting_times.rb +282 -0
- data/lib/postboost/models/reconnect_link.rb +254 -0
- data/lib/postboost/models/recycling_rule.rb +434 -0
- data/lib/postboost/models/recycling_rule_input.rb +435 -0
- data/lib/postboost/models/recycling_rule_settings.rb +381 -0
- data/lib/postboost/models/recycling_rule_update.rb +366 -0
- data/lib/postboost/models/recycling_run.rb +320 -0
- data/lib/postboost/models/remove_generic_subscription422_response.rb +2 -2
- data/lib/postboost/models/remove_user_from_workspace_request.rb +2 -2
- data/lib/postboost/models/report_branding.rb +285 -0
- data/lib/postboost/models/report_branding_input.rb +293 -0
- data/lib/postboost/models/report_export.rb +442 -0
- data/lib/postboost/models/report_export_input.rb +350 -0
- data/lib/postboost/models/repurpose_content200_response.rb +237 -0
- data/lib/postboost/models/repurpose_input.rb +667 -0
- data/lib/postboost/models/repurpose_input_theme.rb +296 -0
- data/lib/postboost/models/repurpose_result.rb +328 -0
- data/lib/postboost/models/repurpose_result_media.rb +224 -0
- data/lib/postboost/models/repurpose_result_source.rb +283 -0
- data/lib/postboost/models/repurpose_slide.rb +239 -0
- data/lib/postboost/models/reseller_client.rb +360 -0
- data/lib/postboost/models/reseller_client_input.rb +240 -0
- data/lib/postboost/models/reseller_client_usage.rb +239 -0
- data/lib/postboost/models/retry_post_account_result.rb +2 -2
- data/lib/postboost/models/rss_feed.rb +402 -0
- data/lib/postboost/models/rss_feed_input.rb +433 -0
- data/lib/postboost/models/rss_feed_update.rb +396 -0
- data/lib/postboost/models/run_agent202_response.rb +221 -0
- data/lib/postboost/models/schedule_post_request.rb +2 -2
- data/lib/postboost/models/schedule_result.rb +2 -2
- data/lib/postboost/models/subscription.rb +2 -2
- data/lib/postboost/models/subscription_input.rb +2 -2
- data/lib/postboost/models/subscription_status.rb +2 -2
- data/lib/postboost/models/subscription_update_input.rb +2 -2
- data/lib/postboost/models/tag.rb +2 -2
- data/lib/postboost/models/tag_input.rb +2 -2
- data/lib/postboost/models/template.rb +256 -0
- data/lib/postboost/models/template_content_item.rb +240 -0
- data/lib/postboost/models/template_input.rb +271 -0
- data/lib/postboost/models/template_input_content_inner.rb +227 -0
- data/lib/postboost/models/update_media_request.rb +2 -2
- data/lib/postboost/models/upload_chunk201_response.rb +2 -2
- data/lib/postboost/models/user.rb +2 -2
- data/lib/postboost/models/user_input.rb +2 -2
- data/lib/postboost/models/user_update_input.rb +2 -2
- data/lib/postboost/models/webhook_event_name.rb +50 -0
- data/lib/postboost/models/webhook_event_payload.rb +262 -0
- data/lib/postboost/models/webhook_subscription.rb +297 -0
- data/lib/postboost/models/webhook_subscription_input.rb +349 -0
- data/lib/postboost/models/workspace.rb +2 -2
- data/lib/postboost/models/workspace_agent.rb +381 -0
- data/lib/postboost/models/workspace_agent_input.rb +326 -0
- data/lib/postboost/models/workspace_agent_settings.rb +340 -0
- data/lib/postboost/models/workspace_agent_update.rb +294 -0
- data/lib/postboost/models/workspace_input.rb +2 -2
- data/lib/postboost/models/workspace_user_input.rb +2 -2
- data/lib/postboost/models/x_usage.rb +303 -0
- data/lib/postboost/models/x_usage_counter.rb +234 -0
- data/lib/postboost/version.rb +3 -3
- data/lib/postboost.rb +151 -2
- data/postboost.gemspec +3 -3
- data/spec/api/account_groups_api_spec.rb +102 -0
- data/spec/api/accounts_api_spec.rb +41 -2
- data/spec/api/activity_api_spec.rb +51 -0
- data/spec/api/agents_api_spec.rb +170 -0
- data/spec/api/ai_api_spec.rb +78 -2
- data/spec/api/analytics_api_spec.rb +90 -2
- data/spec/api/competitors_api_spec.rb +87 -0
- data/spec/api/hashtag_groups_api_spec.rb +102 -0
- data/spec/api/inbox_api_spec.rb +178 -0
- data/spec/api/media_api_spec.rb +21 -3
- data/spec/api/mentions_api_spec.rb +3 -2
- data/spec/api/posting_schedule_api_spec.rb +102 -0
- data/spec/api/posts_api_spec.rb +189 -3
- data/spec/api/receipts_api_spec.rb +2 -2
- data/spec/api/subscriptions_api_spec.rb +2 -2
- data/spec/api/tags_api_spec.rb +3 -2
- data/spec/api/templates_api_spec.rb +102 -0
- data/spec/api/users_api_spec.rb +2 -2
- data/spec/api/webhooks_api_spec.rb +73 -0
- data/spec/api/workspaces_api_spec.rb +77 -2
- data/spec/models/account_analytics_initial_sync_spec.rb +2 -2
- data/spec/models/account_analytics_spec.rb +2 -2
- data/spec/models/account_connection_health_spec.rb +92 -0
- data/spec/models/account_errors_inner_one_of_spec.rb +54 -0
- data/spec/models/account_errors_inner_spec.rb +32 -0
- data/spec/models/account_group_input_spec.rb +42 -0
- data/spec/models/account_group_spec.rb +54 -0
- data/spec/models/account_health_daily_cap_spec.rb +42 -0
- data/spec/models/account_health_spec.rb +84 -0
- data/spec/models/account_schedule_spec.rb +2 -2
- data/spec/models/account_spec.rb +14 -2
- data/spec/models/add_competitor202_response_spec.rb +46 -0
- data/spec/models/add_competitor409_response_spec.rb +42 -0
- data/spec/models/add_generic_subscription_request_spec.rb +2 -2
- data/spec/models/add_post_to_queue_request_spec.rb +2 -2
- data/spec/models/agent_page_meta_spec.rb +54 -0
- data/spec/models/agent_proposal_decision_spec.rb +36 -0
- data/spec/models/agent_proposal_spec.rb +126 -0
- data/spec/models/agent_run_spec.rb +122 -0
- data/spec/models/ai_credits_spec.rb +2 -2
- data/spec/models/ai_usage_spec.rb +42 -0
- data/spec/models/ai_usage_text_spec.rb +54 -0
- data/spec/models/analytics_period_spec.rb +2 -2
- data/spec/models/analytics_summary_data_spec.rb +2 -2
- data/spec/models/analytics_summary_spec.rb +2 -2
- data/spec/models/api_activity_outcome_spec.rb +30 -0
- data/spec/models/api_activity_spec.rb +90 -0
- data/spec/models/api_key_ability_spec.rb +30 -0
- data/spec/models/api_key_input_spec.rb +54 -0
- data/spec/models/api_key_spec.rb +78 -0
- data/spec/models/approve_agent_proposal200_response_spec.rb +36 -0
- data/spec/models/approve_agent_proposal409_response_spec.rb +42 -0
- data/spec/models/approve_inbox_reply_draft403_response_spec.rb +46 -0
- data/spec/models/approve_post_request_spec.rb +2 -2
- data/spec/models/best_posting_times_spec.rb +2 -2
- data/spec/models/best_posting_times_times_inner_spec.rb +2 -2
- data/spec/models/blog_to_social200_response_spec.rb +8 -2
- data/spec/models/blog_to_social429_response_spec.rb +2 -2
- data/spec/models/blog_to_social_caption_spec.rb +2 -2
- data/spec/models/blog_to_social_input_spec.rb +8 -2
- data/spec/models/blog_to_social_media_spec.rb +2 -2
- data/spec/models/blog_to_social_response_spec.rb +2 -2
- data/spec/models/brand_voice_input_spec.rb +128 -0
- data/spec/models/brand_voice_meta_spec.rb +36 -0
- data/spec/models/brand_voice_spec.rb +134 -0
- data/spec/models/cancel_subscription422_response_errors_spec.rb +2 -2
- data/spec/models/cancel_subscription422_response_spec.rb +2 -2
- data/spec/models/cancel_subscription_request_spec.rb +2 -2
- data/spec/models/change_subscription_plan_request_spec.rb +2 -2
- data/spec/models/channel_account_spec.rb +94 -0
- data/spec/models/checkout_subscription200_response_spec.rb +2 -2
- data/spec/models/checkout_subscription_request_spec.rb +2 -2
- data/spec/models/coded_error_spec.rb +48 -0
- data/spec/models/competitor_detail_spec.rb +96 -0
- data/spec/models/competitor_input_spec.rb +42 -0
- data/spec/models/competitor_media_spec.rb +66 -0
- data/spec/models/competitor_snapshot_spec.rb +48 -0
- data/spec/models/competitor_spec.rb +84 -0
- data/spec/models/complete_chunked_upload_request_spec.rb +2 -2
- data/spec/models/connect_channel_input_spec.rb +54 -0
- data/spec/models/create_account_group201_response_spec.rb +36 -0
- data/spec/models/create_agent201_response_spec.rb +36 -0
- data/spec/models/create_api_key201_response_data_spec.rb +84 -0
- data/spec/models/create_api_key201_response_spec.rb +36 -0
- data/spec/models/create_hashtag_group201_response_spec.rb +36 -0
- data/spec/models/create_inbox_reply_draft201_response_spec.rb +36 -0
- data/spec/models/create_media_folder_request_spec.rb +2 -2
- data/spec/models/create_mention201_response_spec.rb +2 -2
- data/spec/models/create_recycling_rule201_response_spec.rb +36 -0
- data/spec/models/create_report_export201_response_spec.rb +36 -0
- data/spec/models/create_reseller_client201_response_spec.rb +36 -0
- data/spec/models/create_rss_feed201_response_spec.rb +36 -0
- data/spec/models/create_template201_response_spec.rb +36 -0
- data/spec/models/create_webhook_subscription201_response_data_spec.rb +72 -0
- data/spec/models/create_webhook_subscription201_response_spec.rb +36 -0
- data/spec/models/delete_agent200_response_spec.rb +36 -0
- data/spec/models/delete_media_bulk_request_items_inner_spec.rb +2 -2
- data/spec/models/delete_media_bulk_request_spec.rb +2 -2
- data/spec/models/delete_media_folder_request_spec.rb +2 -2
- data/spec/models/delete_mode_spec.rb +2 -2
- data/spec/models/delete_post_request_spec.rb +2 -2
- data/spec/models/delete_posts_bulk_request_spec.rb +2 -2
- data/spec/models/delete_receipts_bulk_request_spec.rb +2 -2
- data/spec/models/delete_result_spec.rb +2 -2
- data/spec/models/delete_user400_response_spec.rb +2 -2
- data/spec/models/delete_users_bulk_request_spec.rb +2 -2
- data/spec/models/delete_workspaces_bulk_request_spec.rb +2 -2
- data/spec/models/get_account_health200_response_spec.rb +36 -0
- data/spec/models/get_brand_voice200_response_spec.rb +36 -0
- data/spec/models/get_competitor200_response_spec.rb +36 -0
- data/spec/models/get_inbox_conversation200_response_spec.rb +36 -0
- data/spec/models/get_posting_schedule200_response_spec.rb +36 -0
- data/spec/models/get_remote_upload_status200_response_spec.rb +2 -2
- data/spec/models/get_report_branding200_response_spec.rb +36 -0
- data/spec/models/guardrail_error_spec.rb +70 -0
- data/spec/models/hashtag_group_input_spec.rb +42 -0
- data/spec/models/hashtag_group_spec.rb +48 -0
- data/spec/models/image_alt_text200_response_spec.rb +2 -2
- data/spec/models/image_alt_text_input_spec.rb +2 -2
- data/spec/models/image_alt_text_response_spec.rb +2 -2
- data/spec/models/image_credit_balance_spec.rb +66 -0
- data/spec/models/image_edit_input_spec.rb +8 -2
- data/spec/models/image_generate200_response_spec.rb +8 -2
- data/spec/models/image_generate429_response_spec.rb +2 -2
- data/spec/models/image_generate_input_spec.rb +8 -2
- data/spec/models/image_generation_response_spec.rb +2 -2
- data/spec/models/image_prompt200_response_spec.rb +8 -2
- data/spec/models/image_prompt429_response_spec.rb +2 -2
- data/spec/models/image_prompt_input_spec.rb +8 -2
- data/spec/models/image_prompt_response_spec.rb +2 -2
- data/spec/models/image_variations200_response_spec.rb +2 -2
- data/spec/models/image_variations_input_spec.rb +2 -2
- data/spec/models/image_variations_response_spec.rb +2 -2
- data/spec/models/inbox_author_spec.rb +48 -0
- data/spec/models/inbox_conversation_account_spec.rb +54 -0
- data/spec/models/inbox_conversation_spec.rb +128 -0
- data/spec/models/inbox_conversation_update_spec.rb +46 -0
- data/spec/models/inbox_message_author_spec.rb +48 -0
- data/spec/models/inbox_message_spec.rb +90 -0
- data/spec/models/inbox_reply_draft_approve_spec.rb +36 -0
- data/spec/models/inbox_reply_draft_edit_spec.rb +36 -0
- data/spec/models/inbox_reply_draft_input_spec.rb +42 -0
- data/spec/models/inbox_reply_draft_spec.rb +116 -0
- data/spec/models/initiate_chunked_upload201_response_spec.rb +2 -2
- data/spec/models/initiate_chunked_upload_request_spec.rb +2 -2
- data/spec/models/initiate_remote_upload201_response_one_of_spec.rb +2 -2
- data/spec/models/initiate_remote_upload201_response_spec.rb +2 -2
- data/spec/models/initiate_remote_upload_request_spec.rb +2 -2
- data/spec/models/learn_brand_voice_input_spec.rb +54 -0
- data/spec/models/learn_brand_voice_response_meta_spec.rb +60 -0
- data/spec/models/learn_brand_voice_response_spec.rb +42 -0
- data/spec/models/list_account_groups200_response_spec.rb +48 -0
- data/spec/models/list_accounts200_response_spec.rb +2 -2
- data/spec/models/list_agent_proposals200_response_spec.rb +42 -0
- data/spec/models/list_agent_runs200_response_spec.rb +42 -0
- data/spec/models/list_agents200_response_spec.rb +36 -0
- data/spec/models/list_api_activity200_response_spec.rb +48 -0
- data/spec/models/list_api_keys200_response_spec.rb +36 -0
- data/spec/models/list_competitors200_response_spec.rb +36 -0
- data/spec/models/list_hashtag_groups200_response_spec.rb +48 -0
- data/spec/models/list_inbox_conversations200_response_spec.rb +48 -0
- data/spec/models/list_inbox_reply_drafts200_response_spec.rb +48 -0
- data/spec/models/list_media200_response_spec.rb +2 -2
- data/spec/models/list_media_folders200_response_spec.rb +2 -2
- data/spec/models/list_mentions200_response_spec.rb +2 -2
- data/spec/models/list_my_workspaces200_response_spec.rb +2 -2
- data/spec/models/list_posts200_response_spec.rb +2 -2
- data/spec/models/list_receipts200_response_spec.rb +2 -2
- data/spec/models/list_recycling_rules200_response_spec.rb +36 -0
- data/spec/models/list_recycling_runs200_response_spec.rb +36 -0
- data/spec/models/list_report_exports200_response_spec.rb +36 -0
- data/spec/models/list_reseller_clients200_response_spec.rb +42 -0
- data/spec/models/list_rss_feeds200_response_spec.rb +36 -0
- data/spec/models/list_tags200_response_spec.rb +2 -2
- data/spec/models/list_templates200_response_spec.rb +48 -0
- data/spec/models/list_users200_response_spec.rb +2 -2
- data/spec/models/list_webhook_subscriptions200_response_spec.rb +36 -0
- data/spec/models/list_workspaces200_response_spec.rb +2 -2
- data/spec/models/media_base64_input_spec.rb +54 -0
- data/spec/models/media_folder_input_spec.rb +2 -2
- data/spec/models/media_folder_ref_spec.rb +2 -2
- data/spec/models/media_folder_spec.rb +2 -2
- data/spec/models/media_spec.rb +2 -2
- data/spec/models/mention_identity_input_spec.rb +2 -2
- data/spec/models/mention_identity_spec.rb +2 -2
- data/spec/models/mention_input_spec.rb +2 -2
- data/spec/models/mention_spec.rb +2 -2
- data/spec/models/message_only_spec.rb +36 -0
- data/spec/models/pagination_meta_links_spec.rb +2 -2
- data/spec/models/pagination_meta_meta_spec.rb +2 -2
- data/spec/models/pagination_meta_spec.rb +2 -2
- data/spec/models/poll_rss_feed200_response_spec.rb +48 -0
- data/spec/models/post_analytics_spec.rb +2 -2
- data/spec/models/post_content_spec.rb +2 -2
- data/spec/models/post_input_spec.rb +14 -2
- data/spec/models/post_options_instagram_spec.rb +52 -0
- data/spec/models/post_options_tik_tok_spec.rb +88 -0
- data/spec/models/post_options_youtube_spec.rb +58 -0
- data/spec/models/post_spec.rb +2 -2
- data/spec/models/post_status_spec.rb +2 -2
- data/spec/models/post_version_options_spec.rb +54 -0
- data/spec/models/post_version_spec.rb +2 -2
- data/spec/models/posting_schedule_day_spec.rb +48 -0
- data/spec/models/posting_schedule_day_times_inner_spec.rb +36 -0
- data/spec/models/posting_schedule_input_spec.rb +54 -0
- data/spec/models/posting_schedule_spec.rb +66 -0
- data/spec/models/posting_time_slot_spec.rb +2 -2
- data/spec/models/posting_times_best_inner_spec.rb +2 -2
- data/spec/models/posting_times_day_intervals_inner_inner_spec.rb +2 -2
- data/spec/models/posting_times_days_inner_spec.rb +2 -2
- data/spec/models/posting_times_spec.rb +2 -2
- data/spec/models/preflight_result_spec.rb +60 -0
- data/spec/models/public_workspace_pivot_spec.rb +2 -2
- data/spec/models/public_workspace_spec.rb +2 -2
- data/spec/models/publish_progress_spec.rb +2 -2
- data/spec/models/queue_slots_spec.rb +42 -0
- data/spec/models/receipt_input_spec.rb +2 -2
- data/spec/models/receipt_spec.rb +2 -2
- data/spec/models/receipt_update_input_spec.rb +2 -2
- data/spec/models/recommended_posting_times_spec.rb +60 -0
- data/spec/models/reconnect_link_spec.rb +48 -0
- data/spec/models/recycling_rule_input_spec.rb +92 -0
- data/spec/models/recycling_rule_settings_spec.rb +70 -0
- data/spec/models/recycling_rule_spec.rb +116 -0
- data/spec/models/recycling_rule_update_spec.rb +70 -0
- data/spec/models/recycling_run_spec.rb +70 -0
- data/spec/models/remove_generic_subscription422_response_spec.rb +2 -2
- data/spec/models/remove_user_from_workspace_request_spec.rb +2 -2
- data/spec/models/report_branding_input_spec.rb +54 -0
- data/spec/models/report_branding_spec.rb +66 -0
- data/spec/models/report_export_input_spec.rb +78 -0
- data/spec/models/report_export_spec.rb +120 -0
- data/spec/models/repurpose_content200_response_spec.rb +42 -0
- data/spec/models/repurpose_input_spec.rb +164 -0
- data/spec/models/repurpose_input_theme_spec.rb +48 -0
- data/spec/models/repurpose_result_media_spec.rb +42 -0
- data/spec/models/repurpose_result_source_spec.rb +52 -0
- data/spec/models/repurpose_result_spec.rb +78 -0
- data/spec/models/repurpose_slide_spec.rb +42 -0
- data/spec/models/reseller_client_input_spec.rb +36 -0
- data/spec/models/reseller_client_spec.rb +82 -0
- data/spec/models/reseller_client_usage_spec.rb +42 -0
- data/spec/models/retry_post_account_result_spec.rb +2 -2
- data/spec/models/rss_feed_input_spec.rb +76 -0
- data/spec/models/rss_feed_spec.rb +100 -0
- data/spec/models/rss_feed_update_spec.rb +76 -0
- data/spec/models/run_agent202_response_spec.rb +36 -0
- data/spec/models/schedule_post_request_spec.rb +2 -2
- data/spec/models/schedule_result_spec.rb +2 -2
- data/spec/models/subscription_input_spec.rb +2 -2
- data/spec/models/subscription_spec.rb +2 -2
- data/spec/models/subscription_status_spec.rb +2 -2
- data/spec/models/subscription_update_input_spec.rb +2 -2
- data/spec/models/tag_input_spec.rb +2 -2
- data/spec/models/tag_spec.rb +2 -2
- data/spec/models/template_content_item_spec.rb +42 -0
- data/spec/models/template_input_content_inner_spec.rb +42 -0
- data/spec/models/template_input_spec.rb +42 -0
- data/spec/models/template_spec.rb +48 -0
- data/spec/models/update_media_request_spec.rb +2 -2
- data/spec/models/upload_chunk201_response_spec.rb +2 -2
- data/spec/models/user_input_spec.rb +2 -2
- data/spec/models/user_spec.rb +2 -2
- data/spec/models/user_update_input_spec.rb +2 -2
- data/spec/models/webhook_event_name_spec.rb +30 -0
- data/spec/models/webhook_event_payload_spec.rb +42 -0
- data/spec/models/webhook_subscription_input_spec.rb +58 -0
- data/spec/models/webhook_subscription_spec.rb +66 -0
- data/spec/models/workspace_agent_input_spec.rb +68 -0
- data/spec/models/workspace_agent_settings_spec.rb +60 -0
- data/spec/models/workspace_agent_spec.rb +92 -0
- data/spec/models/workspace_agent_update_spec.rb +58 -0
- data/spec/models/workspace_input_spec.rb +2 -2
- data/spec/models/workspace_spec.rb +2 -2
- data/spec/models/workspace_user_input_spec.rb +2 -2
- data/spec/models/x_usage_counter_spec.rb +42 -0
- data/spec/models/x_usage_spec.rb +66 -0
- data/spec/spec_helper.rb +2 -2
- metadata +615 -4
|
@@ -0,0 +1,178 @@
|
|
|
1
|
+
=begin
|
|
2
|
+
#PostBoost API
|
|
3
|
+
|
|
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
|
+
|
|
6
|
+
The version of the OpenAPI document: 1.14.0
|
|
7
|
+
Contact: hi@postboost.co
|
|
8
|
+
Generated by: https://openapi-generator.tech
|
|
9
|
+
Generator version: 7.9.0
|
|
10
|
+
|
|
11
|
+
=end
|
|
12
|
+
|
|
13
|
+
require 'spec_helper'
|
|
14
|
+
require 'json'
|
|
15
|
+
|
|
16
|
+
# Unit tests for PostBoost::InboxApi
|
|
17
|
+
# Automatically generated by openapi-generator (https://openapi-generator.tech)
|
|
18
|
+
# Please update as you see appropriate
|
|
19
|
+
describe 'InboxApi' do
|
|
20
|
+
before do
|
|
21
|
+
# run before each test
|
|
22
|
+
@api_instance = PostBoost::InboxApi.new
|
|
23
|
+
end
|
|
24
|
+
|
|
25
|
+
after do
|
|
26
|
+
# run after each test
|
|
27
|
+
end
|
|
28
|
+
|
|
29
|
+
describe 'test an instance of InboxApi' do
|
|
30
|
+
it 'should create an instance of InboxApi' do
|
|
31
|
+
expect(@api_instance).to be_instance_of(PostBoost::InboxApi)
|
|
32
|
+
end
|
|
33
|
+
end
|
|
34
|
+
|
|
35
|
+
# unit tests for approve_inbox_reply_draft
|
|
36
|
+
# Approve and send a reply draft
|
|
37
|
+
# Sends the draft to the network (optionally with an edited `body`). Ends as `sent`, or `failed` with `error`. Needs the `publish` ability; the API key that wrote the draft cannot approve it (`403`, `code: self_approval`). A draft is sent at most once: approving again returns `409`. Requires the inbox API to be enabled for the workspace (otherwise `404`). Admins and members only.
|
|
38
|
+
# @param workspace_uuid UUID of the workspace.
|
|
39
|
+
# @param draft_id The draft `id`.
|
|
40
|
+
# @param [Hash] opts the optional parameters
|
|
41
|
+
# @option opts [InboxReplyDraftApprove] :inbox_reply_draft_approve
|
|
42
|
+
# @return [CreateInboxReplyDraft201Response]
|
|
43
|
+
describe 'approve_inbox_reply_draft test' do
|
|
44
|
+
it 'should work' do
|
|
45
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
46
|
+
end
|
|
47
|
+
end
|
|
48
|
+
|
|
49
|
+
# unit tests for create_inbox_reply_draft
|
|
50
|
+
# Draft a reply
|
|
51
|
+
# Proposes a reply. Nothing is posted: a person approves the draft in the app (Reply drafts page) or another API key with the `publish` ability approves it. `in_reply_to` defaults to the latest incoming message. The body limit depends on the network (Bluesky 300, Mastodon 500, LinkedIn 1250, Google 4000). Needs the `write` ability. Requires the inbox API to be enabled for the workspace (otherwise `404`). Admins and members only.
|
|
52
|
+
# @param workspace_uuid UUID of the workspace.
|
|
53
|
+
# @param conversation_id The conversation `id`.
|
|
54
|
+
# @param inbox_reply_draft_input
|
|
55
|
+
# @param [Hash] opts the optional parameters
|
|
56
|
+
# @return [CreateInboxReplyDraft201Response]
|
|
57
|
+
describe 'create_inbox_reply_draft test' do
|
|
58
|
+
it 'should work' do
|
|
59
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
60
|
+
end
|
|
61
|
+
end
|
|
62
|
+
|
|
63
|
+
# unit tests for delete_inbox_reply_draft
|
|
64
|
+
# Withdraw a reply draft
|
|
65
|
+
# Deletes a pending draft. `409` once it was reviewed. Requires the inbox API to be enabled for the workspace (otherwise `404`). Admins and members only.
|
|
66
|
+
# @param workspace_uuid UUID of the workspace.
|
|
67
|
+
# @param draft_id The draft `id`.
|
|
68
|
+
# @param [Hash] opts the optional parameters
|
|
69
|
+
# @return [nil]
|
|
70
|
+
describe 'delete_inbox_reply_draft test' do
|
|
71
|
+
it 'should work' do
|
|
72
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
73
|
+
end
|
|
74
|
+
end
|
|
75
|
+
|
|
76
|
+
# unit tests for get_inbox_conversation
|
|
77
|
+
# Get an inbox conversation
|
|
78
|
+
# The conversation with its 50 most recent messages, oldest first. Requires the inbox API to be enabled for the workspace (otherwise `404`). Admins and members only.
|
|
79
|
+
# @param workspace_uuid UUID of the workspace.
|
|
80
|
+
# @param conversation_id The conversation `id`.
|
|
81
|
+
# @param [Hash] opts the optional parameters
|
|
82
|
+
# @return [GetInboxConversation200Response]
|
|
83
|
+
describe 'get_inbox_conversation test' do
|
|
84
|
+
it 'should work' do
|
|
85
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
86
|
+
end
|
|
87
|
+
end
|
|
88
|
+
|
|
89
|
+
# unit tests for get_inbox_reply_draft
|
|
90
|
+
# Get a reply draft
|
|
91
|
+
# One draft. Poll it to see whether it was approved and sent. Requires the inbox API to be enabled for the workspace (otherwise `404`). Admins and members only.
|
|
92
|
+
# @param workspace_uuid UUID of the workspace.
|
|
93
|
+
# @param draft_id The draft `id`.
|
|
94
|
+
# @param [Hash] opts the optional parameters
|
|
95
|
+
# @return [CreateInboxReplyDraft201Response]
|
|
96
|
+
describe 'get_inbox_reply_draft test' do
|
|
97
|
+
it 'should work' do
|
|
98
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
99
|
+
end
|
|
100
|
+
end
|
|
101
|
+
|
|
102
|
+
# unit tests for list_inbox_conversations
|
|
103
|
+
# List inbox conversations
|
|
104
|
+
# Comments, mentions and reviews on your accounts, most recent activity first, 25 per page. Available for Bluesky, Mastodon, LinkedIn Pages and Google Business Profile. Requires the inbox API to be enabled for the workspace (otherwise `404`). Admins and members only.
|
|
105
|
+
# @param workspace_uuid UUID of the workspace.
|
|
106
|
+
# @param [Hash] opts the optional parameters
|
|
107
|
+
# @option opts [String] :status Conversation status.
|
|
108
|
+
# @option opts [Integer] :account_id Account `id`.
|
|
109
|
+
# @option opts [String] :provider Network, for example `bluesky`.
|
|
110
|
+
# @option opts [Boolean] :unread Only unread (`true`) or read (`false`) conversations.
|
|
111
|
+
# @option opts [String] :sentiment AI sentiment.
|
|
112
|
+
# @option opts [String] :ai_label AI label.
|
|
113
|
+
# @option opts [Time] :since Only conversations with activity at or after this time.
|
|
114
|
+
# @option opts [Integer] :page Page number.
|
|
115
|
+
# @return [ListInboxConversations200Response]
|
|
116
|
+
describe 'list_inbox_conversations test' do
|
|
117
|
+
it 'should work' do
|
|
118
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
119
|
+
end
|
|
120
|
+
end
|
|
121
|
+
|
|
122
|
+
# unit tests for list_inbox_reply_drafts
|
|
123
|
+
# List reply drafts
|
|
124
|
+
# Reply drafts, newest first, 25 per page. Requires the inbox API to be enabled for the workspace (otherwise `404`). Admins and members only.
|
|
125
|
+
# @param workspace_uuid UUID of the workspace.
|
|
126
|
+
# @param [Hash] opts the optional parameters
|
|
127
|
+
# @option opts [String] :status Draft status.
|
|
128
|
+
# @option opts [String] :conversation_id Only drafts for this conversation `id`.
|
|
129
|
+
# @option opts [Integer] :page Page number.
|
|
130
|
+
# @return [ListInboxReplyDrafts200Response]
|
|
131
|
+
describe 'list_inbox_reply_drafts test' do
|
|
132
|
+
it 'should work' do
|
|
133
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
134
|
+
end
|
|
135
|
+
end
|
|
136
|
+
|
|
137
|
+
# unit tests for reject_inbox_reply_draft
|
|
138
|
+
# Reject a reply draft
|
|
139
|
+
# Rejects a pending draft; nothing is sent. Needs the `publish` ability. Requires the inbox API to be enabled for the workspace (otherwise `404`). Admins and members only.
|
|
140
|
+
# @param workspace_uuid UUID of the workspace.
|
|
141
|
+
# @param draft_id The draft `id`.
|
|
142
|
+
# @param [Hash] opts the optional parameters
|
|
143
|
+
# @return [CreateInboxReplyDraft201Response]
|
|
144
|
+
describe 'reject_inbox_reply_draft test' do
|
|
145
|
+
it 'should work' do
|
|
146
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
147
|
+
end
|
|
148
|
+
end
|
|
149
|
+
|
|
150
|
+
# unit tests for update_inbox_conversation
|
|
151
|
+
# Update an inbox conversation
|
|
152
|
+
# Marks the conversation open or resolved, read or unread. Requires the inbox API to be enabled for the workspace (otherwise `404`). Admins and members only.
|
|
153
|
+
# @param workspace_uuid UUID of the workspace.
|
|
154
|
+
# @param conversation_id The conversation `id`.
|
|
155
|
+
# @param inbox_conversation_update
|
|
156
|
+
# @param [Hash] opts the optional parameters
|
|
157
|
+
# @return [GetInboxConversation200Response]
|
|
158
|
+
describe 'update_inbox_conversation test' do
|
|
159
|
+
it 'should work' do
|
|
160
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
161
|
+
end
|
|
162
|
+
end
|
|
163
|
+
|
|
164
|
+
# unit tests for update_inbox_reply_draft
|
|
165
|
+
# Edit a reply draft
|
|
166
|
+
# Changes the text of a pending draft. `409` once it was reviewed. Requires the inbox API to be enabled for the workspace (otherwise `404`). Admins and members only.
|
|
167
|
+
# @param workspace_uuid UUID of the workspace.
|
|
168
|
+
# @param draft_id The draft `id`.
|
|
169
|
+
# @param inbox_reply_draft_edit
|
|
170
|
+
# @param [Hash] opts the optional parameters
|
|
171
|
+
# @return [CreateInboxReplyDraft201Response]
|
|
172
|
+
describe 'update_inbox_reply_draft test' do
|
|
173
|
+
it 'should work' do
|
|
174
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
175
|
+
end
|
|
176
|
+
end
|
|
177
|
+
|
|
178
|
+
end
|
data/spec/api/media_api_spec.rb
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#PostBoost API
|
|
3
3
|
|
|
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. ## 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 ```
|
|
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.14.0
|
|
7
7
|
Contact: hi@postboost.co
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
Generator version: 7.9.0
|
|
@@ -65,6 +65,7 @@ describe 'MediaApi' do
|
|
|
65
65
|
# @param workspace_uuid UUID of the workspace.
|
|
66
66
|
# @param create_media_folder_request
|
|
67
67
|
# @param [Hash] opts the optional parameters
|
|
68
|
+
# @option opts [String] :idempotency_key Unique key (for example a UUID) that makes the request safe to retry. A repeat with the same key and body within 24 hours returns the stored response with `Idempotent-Replayed: true` and has no further effect. Keys are scoped to your user, the workspace, the method and the path.
|
|
68
69
|
# @return [MediaFolder]
|
|
69
70
|
describe 'create_media_folder test' do
|
|
70
71
|
it 'should work' do
|
|
@@ -131,6 +132,7 @@ describe 'MediaApi' do
|
|
|
131
132
|
# @param workspace_uuid UUID of the workspace.
|
|
132
133
|
# @param initiate_chunked_upload_request
|
|
133
134
|
# @param [Hash] opts the optional parameters
|
|
135
|
+
# @option opts [String] :idempotency_key Unique key (for example a UUID) that makes the request safe to retry. A repeat with the same key and body within 24 hours returns the stored response with `Idempotent-Replayed: true` and has no further effect. Keys are scoped to your user, the workspace, the method and the path.
|
|
134
136
|
# @return [InitiateChunkedUpload201Response]
|
|
135
137
|
describe 'initiate_chunked_upload test' do
|
|
136
138
|
it 'should work' do
|
|
@@ -144,6 +146,7 @@ describe 'MediaApi' do
|
|
|
144
146
|
# @param workspace_uuid UUID of the workspace.
|
|
145
147
|
# @param initiate_remote_upload_request
|
|
146
148
|
# @param [Hash] opts the optional parameters
|
|
149
|
+
# @option opts [String] :idempotency_key Unique key (for example a UUID) that makes the request safe to retry. A repeat with the same key and body within 24 hours returns the stored response with `Idempotent-Replayed: true` and has no further effect. Keys are scoped to your user, the workspace, the method and the path.
|
|
147
150
|
# @return [InitiateRemoteUpload201Response]
|
|
148
151
|
describe 'initiate_remote_upload test' do
|
|
149
152
|
it 'should work' do
|
|
@@ -229,10 +232,11 @@ describe 'MediaApi' do
|
|
|
229
232
|
|
|
230
233
|
# unit tests for upload_media
|
|
231
234
|
# Upload media (binary)
|
|
232
|
-
# Upload a file directly as multipart form data.
|
|
235
|
+
# Upload a file directly as multipart form data. Images and videos, plus a PDF (up to 100 MB) for LinkedIn document posts: a post that attaches a PDF must have it as the only media item and may only go to LinkedIn profiles and pages.
|
|
233
236
|
# @param workspace_uuid UUID of the workspace.
|
|
234
237
|
# @param file The file to upload.
|
|
235
238
|
# @param [Hash] opts the optional parameters
|
|
239
|
+
# @option opts [String] :idempotency_key Unique key (for example a UUID) that makes the request safe to retry. A repeat with the same key and body within 24 hours returns the stored response with `Idempotent-Replayed: true` and has no further effect. Keys are scoped to your user, the workspace, the method and the path.
|
|
236
240
|
# @option opts [String] :alt_text Alternative text for accessibility.
|
|
237
241
|
# @option opts [String] :folder UUID of the media folder to file the upload in. Omit or null for the library root.
|
|
238
242
|
# @return [Media]
|
|
@@ -242,4 +246,18 @@ describe 'MediaApi' do
|
|
|
242
246
|
end
|
|
243
247
|
end
|
|
244
248
|
|
|
249
|
+
# unit tests for upload_media_base64
|
|
250
|
+
# Upload media (base64 JSON)
|
|
251
|
+
# Upload a file as base64 inside a JSON body, for agents and tools that cannot send multipart form data. The decoded file is checked exactly like `POST media` (allowed types and size limits; a PDF is accepted for LinkedIn document posts). Decoded size is capped at 20 MB; for larger files use remote upload by URL or chunked upload.
|
|
252
|
+
# @param workspace_uuid UUID of the workspace.
|
|
253
|
+
# @param media_base64_input
|
|
254
|
+
# @param [Hash] opts the optional parameters
|
|
255
|
+
# @option opts [String] :idempotency_key Unique key (for example a UUID) that makes the request safe to retry. A repeat with the same key and body within 24 hours returns the stored response with `Idempotent-Replayed: true` and has no further effect. Keys are scoped to your user, the workspace, the method and the path.
|
|
256
|
+
# @return [Media]
|
|
257
|
+
describe 'upload_media_base64 test' do
|
|
258
|
+
it 'should work' do
|
|
259
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
260
|
+
end
|
|
261
|
+
end
|
|
262
|
+
|
|
245
263
|
end
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#PostBoost API
|
|
3
3
|
|
|
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. ## 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 ```
|
|
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.14.0
|
|
7
7
|
Contact: hi@postboost.co
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
Generator version: 7.9.0
|
|
@@ -38,6 +38,7 @@ describe 'MentionsApi' do
|
|
|
38
38
|
# @param workspace_uuid UUID of the workspace.
|
|
39
39
|
# @param mention_input
|
|
40
40
|
# @param [Hash] opts the optional parameters
|
|
41
|
+
# @option opts [String] :idempotency_key Unique key (for example a UUID) that makes the request safe to retry. A repeat with the same key and body within 24 hours returns the stored response with `Idempotent-Replayed: true` and has no further effect. Keys are scoped to your user, the workspace, the method and the path.
|
|
41
42
|
# @return [CreateMention201Response]
|
|
42
43
|
describe 'create_mention test' do
|
|
43
44
|
it 'should work' do
|
|
@@ -0,0 +1,102 @@
|
|
|
1
|
+
=begin
|
|
2
|
+
#PostBoost API
|
|
3
|
+
|
|
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
|
+
|
|
6
|
+
The version of the OpenAPI document: 1.14.0
|
|
7
|
+
Contact: hi@postboost.co
|
|
8
|
+
Generated by: https://openapi-generator.tech
|
|
9
|
+
Generator version: 7.9.0
|
|
10
|
+
|
|
11
|
+
=end
|
|
12
|
+
|
|
13
|
+
require 'spec_helper'
|
|
14
|
+
require 'json'
|
|
15
|
+
|
|
16
|
+
# Unit tests for PostBoost::PostingScheduleApi
|
|
17
|
+
# Automatically generated by openapi-generator (https://openapi-generator.tech)
|
|
18
|
+
# Please update as you see appropriate
|
|
19
|
+
describe 'PostingScheduleApi' do
|
|
20
|
+
before do
|
|
21
|
+
# run before each test
|
|
22
|
+
@api_instance = PostBoost::PostingScheduleApi.new
|
|
23
|
+
end
|
|
24
|
+
|
|
25
|
+
after do
|
|
26
|
+
# run after each test
|
|
27
|
+
end
|
|
28
|
+
|
|
29
|
+
describe 'test an instance of PostingScheduleApi' do
|
|
30
|
+
it 'should create an instance of PostingScheduleApi' do
|
|
31
|
+
expect(@api_instance).to be_instance_of(PostBoost::PostingScheduleApi)
|
|
32
|
+
end
|
|
33
|
+
end
|
|
34
|
+
|
|
35
|
+
# unit tests for get_posting_schedule
|
|
36
|
+
# Get the posting schedule
|
|
37
|
+
# The queue's posting times: per weekday, a list of clock times in the schedule's timezone. `account_id=0` is the workspace schedule. An account without its own schedule follows the workspace one (`inherited: true`, `source_account_id: 0`). Posts added to the queue take the next free time.
|
|
38
|
+
# @param workspace_uuid UUID of the workspace.
|
|
39
|
+
# @param [Hash] opts the optional parameters
|
|
40
|
+
# @option opts [Integer] :account_id `0` (default) for the workspace schedule, or an account `id`.
|
|
41
|
+
# @return [GetPostingSchedule200Response]
|
|
42
|
+
describe 'get_posting_schedule test' do
|
|
43
|
+
it 'should work' do
|
|
44
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
45
|
+
end
|
|
46
|
+
end
|
|
47
|
+
|
|
48
|
+
# unit tests for get_recommended_posting_times
|
|
49
|
+
# Get recommended posting times
|
|
50
|
+
# Suggested posting times from past engagement, in the schedule's timezone. `has_data` is false until there is enough analytics history.
|
|
51
|
+
# @param workspace_uuid UUID of the workspace.
|
|
52
|
+
# @param [Hash] opts the optional parameters
|
|
53
|
+
# @option opts [Integer] :account_id `0` (default) for the workspace schedule, or an account `id`.
|
|
54
|
+
# @option opts [Integer] :slots_per_day Times to suggest per day (1 to 6).
|
|
55
|
+
# @return [RecommendedPostingTimes]
|
|
56
|
+
describe 'get_recommended_posting_times test' do
|
|
57
|
+
it 'should work' do
|
|
58
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
59
|
+
end
|
|
60
|
+
end
|
|
61
|
+
|
|
62
|
+
# unit tests for list_queue_slots
|
|
63
|
+
# List upcoming queue slots
|
|
64
|
+
# The queue read forward: upcoming posting times, filled by scheduled posts where they land on one. Page with `after` set to the previous `next_cursor`.
|
|
65
|
+
# @param workspace_uuid UUID of the workspace.
|
|
66
|
+
# @param [Hash] opts the optional parameters
|
|
67
|
+
# @option opts [Integer] :account_id `0` (default) for the workspace schedule, or an account `id`.
|
|
68
|
+
# @option opts [String] :after Start after this time (`Y-m-d H:i:s`, UTC), from `next_cursor`.
|
|
69
|
+
# @return [QueueSlots]
|
|
70
|
+
describe 'list_queue_slots test' do
|
|
71
|
+
it 'should work' do
|
|
72
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
73
|
+
end
|
|
74
|
+
end
|
|
75
|
+
|
|
76
|
+
# unit tests for reset_account_posting_schedule
|
|
77
|
+
# Reset an account schedule
|
|
78
|
+
# Removes the account's own schedule so it follows the workspace schedule again. Workspace admins only.
|
|
79
|
+
# @param workspace_uuid UUID of the workspace.
|
|
80
|
+
# @param account_id The account `id`.
|
|
81
|
+
# @param [Hash] opts the optional parameters
|
|
82
|
+
# @return [GetPostingSchedule200Response]
|
|
83
|
+
describe 'reset_account_posting_schedule test' do
|
|
84
|
+
it 'should work' do
|
|
85
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
86
|
+
end
|
|
87
|
+
end
|
|
88
|
+
|
|
89
|
+
# unit tests for update_posting_schedule
|
|
90
|
+
# Set the posting schedule
|
|
91
|
+
# Sets the workspace schedule (`account_id: 0`) or gives one account its own schedule. Send all seven weekdays (ids 1 to 6 for Monday to Saturday, 0 for Sunday). Workspace admins only.
|
|
92
|
+
# @param workspace_uuid UUID of the workspace.
|
|
93
|
+
# @param posting_schedule_input
|
|
94
|
+
# @param [Hash] opts the optional parameters
|
|
95
|
+
# @return [GetPostingSchedule200Response]
|
|
96
|
+
describe 'update_posting_schedule test' do
|
|
97
|
+
it 'should work' do
|
|
98
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
99
|
+
end
|
|
100
|
+
end
|
|
101
|
+
|
|
102
|
+
end
|
data/spec/api/posts_api_spec.rb
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#PostBoost API
|
|
3
3
|
|
|
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. ## 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 ```
|
|
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.14.0
|
|
7
7
|
Contact: hi@postboost.co
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
Generator version: 7.9.0
|
|
@@ -38,6 +38,7 @@ describe 'PostsApi' do
|
|
|
38
38
|
# @param workspace_uuid UUID of the workspace.
|
|
39
39
|
# @param post_uuid UUID of the post.
|
|
40
40
|
# @param [Hash] opts the optional parameters
|
|
41
|
+
# @option opts [String] :idempotency_key Unique key (for example a UUID) that makes the request safe to retry. A repeat with the same key and body within 24 hours returns the stored response with `Idempotent-Replayed: true` and has no further effect. Keys are scoped to your user, the workspace, the method and the path.
|
|
41
42
|
# @option opts [AddPostToQueueRequest] :add_post_to_queue_request
|
|
42
43
|
# @return [ScheduleResult]
|
|
43
44
|
describe 'add_post_to_queue test' do
|
|
@@ -52,6 +53,7 @@ describe 'PostsApi' do
|
|
|
52
53
|
# @param workspace_uuid UUID of the workspace.
|
|
53
54
|
# @param post_uuid UUID of the post.
|
|
54
55
|
# @param [Hash] opts the optional parameters
|
|
56
|
+
# @option opts [String] :idempotency_key Unique key (for example a UUID) that makes the request safe to retry. A repeat with the same key and body within 24 hours returns the stored response with `Idempotent-Replayed: true` and has no further effect. Keys are scoped to your user, the workspace, the method and the path.
|
|
55
57
|
# @option opts [ApprovePostRequest] :approve_post_request
|
|
56
58
|
# @return [ScheduleResult]
|
|
57
59
|
describe 'approve_post test' do
|
|
@@ -62,10 +64,11 @@ describe 'PostsApi' do
|
|
|
62
64
|
|
|
63
65
|
# unit tests for create_post
|
|
64
66
|
# Create post
|
|
65
|
-
# Create a new post. Use `schedule: true` with `date` and `time` to schedule, `schedule_now: true` to publish immediately, or `queue: true` to add to the smart publishing queue (each account gets its own queue slot). `date`, `time` and `accounts_schedule` are read in `timezone` when given, otherwise in the workspace timezone. Use `accounts_schedule` to give individual accounts their own departure time. Post bodies may reference mentions with `{{mention:<reference>}}` (see the Mentions endpoints). When the post is scheduled, provider requirements (for example a network that requires media) are validated up front and reported as `422`.
|
|
67
|
+
# Create a new post. Use `schedule: true` with `date` and `time` to schedule, `schedule_now: true` to publish immediately, or `queue: true` to add to the smart publishing queue (each account gets its own queue slot). `date`, `time` and `accounts_schedule` are read in `timezone` when given, otherwise in the workspace timezone. Use `accounts_schedule` to give individual accounts their own departure time. Post bodies may reference mentions with `{{mention:<reference>}}` (see the Mentions endpoints). When the post is scheduled, provider requirements (for example a network that requires media) are validated up front and reported as `422`. **First comment and threads.** A version's `content` is an ordered array. Item 0 is the post. Add a second item to publish a first comment on Facebook Page, Instagram and LinkedIn, or to continue a thread on X, Threads, Bluesky, Mastodon and Pixelfed: ```json { \"accounts\": [12], \"schedule_now\": true, \"versions\": [{ \"account_id\": 0, \"is_original\": true, \"content\": [ { \"body\": \"Our API 1.8 is live.\", \"media\": [345] }, { \"body\": \"Full changelog: https://postboost.co/docs/changelog/\" } ] }] } ``` The comment is posted right after the post goes live. If the comment fails, the post stays published and the account's entry on the post reports the error.
|
|
66
68
|
# @param workspace_uuid UUID of the workspace.
|
|
67
69
|
# @param post_input
|
|
68
70
|
# @param [Hash] opts the optional parameters
|
|
71
|
+
# @option opts [String] :idempotency_key Unique key (for example a UUID) that makes the request safe to retry. A repeat with the same key and body within 24 hours returns the stored response with `Idempotent-Replayed: true` and has no further effect. Keys are scoped to your user, the workspace, the method and the path.
|
|
69
72
|
# @return [Post]
|
|
70
73
|
describe 'create_post test' do
|
|
71
74
|
it 'should work' do
|
|
@@ -73,6 +76,32 @@ describe 'PostsApi' do
|
|
|
73
76
|
end
|
|
74
77
|
end
|
|
75
78
|
|
|
79
|
+
# unit tests for create_recycling_rule
|
|
80
|
+
# Create a recycling rule
|
|
81
|
+
# Recycles one post (`post_uuid`) or a tag pool (`type: tag_pool` + `tag_uuid`) every `interval_days`. The first run is `start_at`, or one interval from now. Copies are never published immediately: `placement: queue` (default) takes each account's next free queue slot, `same_time` schedules at the source post's time of day, `draft` leaves a draft. Copies pass the same guardrails as posts created through the API (duplicate guard, per-account daily caps, disconnected accounts, X monthly allowance). A refused copy is not created; the run is logged with the guard's code (see the runs endpoint). X accounts are left out of copies because X rejects repeated text. Admins and members only.
|
|
82
|
+
# @param workspace_uuid UUID of the workspace.
|
|
83
|
+
# @param recycling_rule_input
|
|
84
|
+
# @param [Hash] opts the optional parameters
|
|
85
|
+
# @return [CreateRecyclingRule201Response]
|
|
86
|
+
describe 'create_recycling_rule test' do
|
|
87
|
+
it 'should work' do
|
|
88
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
89
|
+
end
|
|
90
|
+
end
|
|
91
|
+
|
|
92
|
+
# unit tests for create_rss_feed
|
|
93
|
+
# Add an RSS feed
|
|
94
|
+
# Checks the feed every 30 minutes and turns each item published after the feed was added into a post for `account_ids`: a draft (`mode: draft`, default) or a queued post (`mode: queue`). The text comes from `template` with `{title}`, `{link}` and `{summary}` placeholders. Each item becomes at most one post, at most `max_items_per_run` per check and 20 per workspace per day. Posts pass the same guardrails as API-created posts. Only public http(s) URLs are accepted. Admins and members only.
|
|
95
|
+
# @param workspace_uuid UUID of the workspace.
|
|
96
|
+
# @param rss_feed_input
|
|
97
|
+
# @param [Hash] opts the optional parameters
|
|
98
|
+
# @return [CreateRssFeed201Response]
|
|
99
|
+
describe 'create_rss_feed test' do
|
|
100
|
+
it 'should work' do
|
|
101
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
102
|
+
end
|
|
103
|
+
end
|
|
104
|
+
|
|
76
105
|
# unit tests for delete_post
|
|
77
106
|
# Delete post
|
|
78
107
|
# Deletes a post. Use `delete_mode` to control whether to also remove the published content from social platforms.
|
|
@@ -100,6 +129,32 @@ describe 'PostsApi' do
|
|
|
100
129
|
end
|
|
101
130
|
end
|
|
102
131
|
|
|
132
|
+
# unit tests for delete_recycling_rule
|
|
133
|
+
# Delete a recycling rule
|
|
134
|
+
# Deletes the rule and its run log. Copies it already created stay. Admins and members only.
|
|
135
|
+
# @param workspace_uuid UUID of the workspace.
|
|
136
|
+
# @param rule_uuid UUID of the recycling rule.
|
|
137
|
+
# @param [Hash] opts the optional parameters
|
|
138
|
+
# @return [Object]
|
|
139
|
+
describe 'delete_recycling_rule test' do
|
|
140
|
+
it 'should work' do
|
|
141
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
142
|
+
end
|
|
143
|
+
end
|
|
144
|
+
|
|
145
|
+
# unit tests for delete_rss_feed
|
|
146
|
+
# Delete an RSS feed
|
|
147
|
+
# Stops the feed. Posts it already created stay. Admins and members only.
|
|
148
|
+
# @param workspace_uuid UUID of the workspace.
|
|
149
|
+
# @param feed_uuid UUID of the RSS feed.
|
|
150
|
+
# @param [Hash] opts the optional parameters
|
|
151
|
+
# @return [Object]
|
|
152
|
+
describe 'delete_rss_feed test' do
|
|
153
|
+
it 'should work' do
|
|
154
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
155
|
+
end
|
|
156
|
+
end
|
|
157
|
+
|
|
103
158
|
# unit tests for get_post
|
|
104
159
|
# Get post
|
|
105
160
|
# Returns a single post with all its versions and associated accounts.
|
|
@@ -126,6 +181,30 @@ describe 'PostsApi' do
|
|
|
126
181
|
end
|
|
127
182
|
end
|
|
128
183
|
|
|
184
|
+
# unit tests for get_recycling_rule
|
|
185
|
+
# Get a recycling rule
|
|
186
|
+
# @param workspace_uuid UUID of the workspace.
|
|
187
|
+
# @param rule_uuid UUID of the recycling rule.
|
|
188
|
+
# @param [Hash] opts the optional parameters
|
|
189
|
+
# @return [CreateRecyclingRule201Response]
|
|
190
|
+
describe 'get_recycling_rule test' do
|
|
191
|
+
it 'should work' do
|
|
192
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
193
|
+
end
|
|
194
|
+
end
|
|
195
|
+
|
|
196
|
+
# unit tests for get_rss_feed
|
|
197
|
+
# Get an RSS feed
|
|
198
|
+
# @param workspace_uuid UUID of the workspace.
|
|
199
|
+
# @param feed_uuid UUID of the RSS feed.
|
|
200
|
+
# @param [Hash] opts the optional parameters
|
|
201
|
+
# @return [CreateRssFeed201Response]
|
|
202
|
+
describe 'get_rss_feed test' do
|
|
203
|
+
it 'should work' do
|
|
204
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
205
|
+
end
|
|
206
|
+
end
|
|
207
|
+
|
|
129
208
|
# unit tests for list_posts
|
|
130
209
|
# List posts
|
|
131
210
|
# Returns a paginated list of posts in the workspace.
|
|
@@ -139,6 +218,70 @@ describe 'PostsApi' do
|
|
|
139
218
|
end
|
|
140
219
|
end
|
|
141
220
|
|
|
221
|
+
# unit tests for list_recycling_rules
|
|
222
|
+
# List recycling rules
|
|
223
|
+
# Evergreen recycling rules of the workspace, newest first. A rule copies a post (or the least recently recycled published post with a tag) every `interval_days` and places the copy in the queue. Copies are ordinary posts: they show in the calendar and the queue.
|
|
224
|
+
# @param workspace_uuid UUID of the workspace.
|
|
225
|
+
# @param [Hash] opts the optional parameters
|
|
226
|
+
# @return [ListRecyclingRules200Response]
|
|
227
|
+
describe 'list_recycling_rules test' do
|
|
228
|
+
it 'should work' do
|
|
229
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
230
|
+
end
|
|
231
|
+
end
|
|
232
|
+
|
|
233
|
+
# unit tests for list_recycling_runs
|
|
234
|
+
# List a recycling rule's runs
|
|
235
|
+
# The latest 100 runs of the rule, newest first: the copy each run created, or why it skipped (`source_unavailable`, `no_eligible_post`, `no_accounts`, `queue_full`, `x_skipped_identical_text`, or a guardrail code such as `duplicate_post` or `account_daily_cap_reached`).
|
|
236
|
+
# @param workspace_uuid UUID of the workspace.
|
|
237
|
+
# @param rule_uuid UUID of the recycling rule.
|
|
238
|
+
# @param [Hash] opts the optional parameters
|
|
239
|
+
# @return [ListRecyclingRuns200Response]
|
|
240
|
+
describe 'list_recycling_runs test' do
|
|
241
|
+
it 'should work' do
|
|
242
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
243
|
+
end
|
|
244
|
+
end
|
|
245
|
+
|
|
246
|
+
# unit tests for list_rss_feeds
|
|
247
|
+
# List RSS feeds
|
|
248
|
+
# RSS and Atom feeds whose new items become posts, newest first.
|
|
249
|
+
# @param workspace_uuid UUID of the workspace.
|
|
250
|
+
# @param [Hash] opts the optional parameters
|
|
251
|
+
# @return [ListRssFeeds200Response]
|
|
252
|
+
describe 'list_rss_feeds test' do
|
|
253
|
+
it 'should work' do
|
|
254
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
255
|
+
end
|
|
256
|
+
end
|
|
257
|
+
|
|
258
|
+
# unit tests for poll_rss_feed
|
|
259
|
+
# Check an RSS feed now
|
|
260
|
+
# Reads the feed immediately instead of waiting for the next check. Limited to 6 calls per minute. Admins and members only.
|
|
261
|
+
# @param workspace_uuid UUID of the workspace.
|
|
262
|
+
# @param feed_uuid UUID of the RSS feed.
|
|
263
|
+
# @param [Hash] opts the optional parameters
|
|
264
|
+
# @return [PollRssFeed200Response]
|
|
265
|
+
describe 'poll_rss_feed test' do
|
|
266
|
+
it 'should work' do
|
|
267
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
268
|
+
end
|
|
269
|
+
end
|
|
270
|
+
|
|
271
|
+
# unit tests for recycle_post
|
|
272
|
+
# Recycle a post on an interval
|
|
273
|
+
# Shortcut for creating a `post` recycling rule for this post. Same body as `createRecyclingRule` without `type`, `post_uuid` and `tag_uuid`. Admins and members only.
|
|
274
|
+
# @param workspace_uuid UUID of the workspace.
|
|
275
|
+
# @param post_uuid UUID of the post.
|
|
276
|
+
# @param recycling_rule_settings
|
|
277
|
+
# @param [Hash] opts the optional parameters
|
|
278
|
+
# @return [CreateRecyclingRule201Response]
|
|
279
|
+
describe 'recycle_post test' do
|
|
280
|
+
it 'should work' do
|
|
281
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
282
|
+
end
|
|
283
|
+
end
|
|
284
|
+
|
|
142
285
|
# unit tests for retry_post_account
|
|
143
286
|
# Retry publishing to one account
|
|
144
287
|
# Re-publishes a post to a single account whose publishing failed. Returns `422` when the account is not on the post, the post is still publishing, or the account did not fail.
|
|
@@ -146,6 +289,7 @@ describe 'PostsApi' do
|
|
|
146
289
|
# @param post_uuid UUID of the post.
|
|
147
290
|
# @param account_uuid UUID of the social media account.
|
|
148
291
|
# @param [Hash] opts the optional parameters
|
|
292
|
+
# @option opts [String] :idempotency_key Unique key (for example a UUID) that makes the request safe to retry. A repeat with the same key and body within 24 hours returns the stored response with `Idempotent-Replayed: true` and has no further effect. Keys are scoped to your user, the workspace, the method and the path.
|
|
149
293
|
# @return [RetryPostAccountResult]
|
|
150
294
|
describe 'retry_post_account test' do
|
|
151
295
|
it 'should work' do
|
|
@@ -160,6 +304,7 @@ describe 'PostsApi' do
|
|
|
160
304
|
# @param post_uuid UUID of the post.
|
|
161
305
|
# @param schedule_post_request
|
|
162
306
|
# @param [Hash] opts the optional parameters
|
|
307
|
+
# @option opts [String] :idempotency_key Unique key (for example a UUID) that makes the request safe to retry. A repeat with the same key and body within 24 hours returns the stored response with `Idempotent-Replayed: true` and has no further effect. Keys are scoped to your user, the workspace, the method and the path.
|
|
163
308
|
# @return [ScheduleResult]
|
|
164
309
|
describe 'schedule_post test' do
|
|
165
310
|
it 'should work' do
|
|
@@ -181,4 +326,45 @@ describe 'PostsApi' do
|
|
|
181
326
|
end
|
|
182
327
|
end
|
|
183
328
|
|
|
329
|
+
# unit tests for update_recycling_rule
|
|
330
|
+
# Update, pause or resume a recycling rule
|
|
331
|
+
# Changes the interval, limit, placement or accounts, or pauses (`active: false`) and resumes the rule. Fields you leave out keep their value. A rule that reached `max_runs` resumes only with a higher `max_runs`. Admins and members only.
|
|
332
|
+
# @param workspace_uuid UUID of the workspace.
|
|
333
|
+
# @param rule_uuid UUID of the recycling rule.
|
|
334
|
+
# @param recycling_rule_update
|
|
335
|
+
# @param [Hash] opts the optional parameters
|
|
336
|
+
# @return [CreateRecyclingRule201Response]
|
|
337
|
+
describe 'update_recycling_rule test' do
|
|
338
|
+
it 'should work' do
|
|
339
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
340
|
+
end
|
|
341
|
+
end
|
|
342
|
+
|
|
343
|
+
# unit tests for update_rss_feed
|
|
344
|
+
# Update, pause or resume an RSS feed
|
|
345
|
+
# Fields you leave out keep their value. Resuming (`active: true`) clears the error backoff. Admins and members only.
|
|
346
|
+
# @param workspace_uuid UUID of the workspace.
|
|
347
|
+
# @param feed_uuid UUID of the RSS feed.
|
|
348
|
+
# @param rss_feed_update
|
|
349
|
+
# @param [Hash] opts the optional parameters
|
|
350
|
+
# @return [CreateRssFeed201Response]
|
|
351
|
+
describe 'update_rss_feed test' do
|
|
352
|
+
it 'should work' do
|
|
353
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
354
|
+
end
|
|
355
|
+
end
|
|
356
|
+
|
|
357
|
+
# unit tests for validate_post
|
|
358
|
+
# Validate post (dry run)
|
|
359
|
+
# Runs everything create-post checks without creating anything: request validation, network requirements (text length, media count and type, links) for every given account, whether or not the post is scheduled, and the guardrails (duplicate content, daily caps, account health). Always answers `200`; read `valid`. Any workspace member, including viewers, may call it. Recommended agent loop: account health, validate, then create.
|
|
360
|
+
# @param workspace_uuid UUID of the workspace.
|
|
361
|
+
# @param post_input
|
|
362
|
+
# @param [Hash] opts the optional parameters
|
|
363
|
+
# @return [PreflightResult]
|
|
364
|
+
describe 'validate_post test' do
|
|
365
|
+
it 'should work' do
|
|
366
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
367
|
+
end
|
|
368
|
+
end
|
|
369
|
+
|
|
184
370
|
end
|