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
data/docs/InboxApi.md
ADDED
|
@@ -0,0 +1,758 @@
|
|
|
1
|
+
# PostBoost::InboxApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://postboost.co/app/api*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**approve_inbox_reply_draft**](InboxApi.md#approve_inbox_reply_draft) | **POST** /{workspaceUuid}/inbox/drafts/{draftId}/approve | Approve and send a reply draft |
|
|
8
|
+
| [**create_inbox_reply_draft**](InboxApi.md#create_inbox_reply_draft) | **POST** /{workspaceUuid}/inbox/conversations/{conversationId}/drafts | Draft a reply |
|
|
9
|
+
| [**delete_inbox_reply_draft**](InboxApi.md#delete_inbox_reply_draft) | **DELETE** /{workspaceUuid}/inbox/drafts/{draftId} | Withdraw a reply draft |
|
|
10
|
+
| [**get_inbox_conversation**](InboxApi.md#get_inbox_conversation) | **GET** /{workspaceUuid}/inbox/conversations/{conversationId} | Get an inbox conversation |
|
|
11
|
+
| [**get_inbox_reply_draft**](InboxApi.md#get_inbox_reply_draft) | **GET** /{workspaceUuid}/inbox/drafts/{draftId} | Get a reply draft |
|
|
12
|
+
| [**list_inbox_conversations**](InboxApi.md#list_inbox_conversations) | **GET** /{workspaceUuid}/inbox/conversations | List inbox conversations |
|
|
13
|
+
| [**list_inbox_reply_drafts**](InboxApi.md#list_inbox_reply_drafts) | **GET** /{workspaceUuid}/inbox/drafts | List reply drafts |
|
|
14
|
+
| [**reject_inbox_reply_draft**](InboxApi.md#reject_inbox_reply_draft) | **POST** /{workspaceUuid}/inbox/drafts/{draftId}/reject | Reject a reply draft |
|
|
15
|
+
| [**update_inbox_conversation**](InboxApi.md#update_inbox_conversation) | **PATCH** /{workspaceUuid}/inbox/conversations/{conversationId} | Update an inbox conversation |
|
|
16
|
+
| [**update_inbox_reply_draft**](InboxApi.md#update_inbox_reply_draft) | **PUT** /{workspaceUuid}/inbox/drafts/{draftId} | Edit a reply draft |
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
## approve_inbox_reply_draft
|
|
20
|
+
|
|
21
|
+
> <CreateInboxReplyDraft201Response> approve_inbox_reply_draft(workspace_uuid, draft_id, opts)
|
|
22
|
+
|
|
23
|
+
Approve and send a reply draft
|
|
24
|
+
|
|
25
|
+
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.
|
|
26
|
+
|
|
27
|
+
### Examples
|
|
28
|
+
|
|
29
|
+
```ruby
|
|
30
|
+
require 'time'
|
|
31
|
+
require 'postboost'
|
|
32
|
+
# setup authorization
|
|
33
|
+
PostBoost.configure do |config|
|
|
34
|
+
# Configure Bearer authorization: bearerAuth
|
|
35
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
36
|
+
end
|
|
37
|
+
|
|
38
|
+
api_instance = PostBoost::InboxApi.new
|
|
39
|
+
workspace_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the workspace.
|
|
40
|
+
draft_id = 'draft_id_example' # String | The draft `id`.
|
|
41
|
+
opts = {
|
|
42
|
+
inbox_reply_draft_approve: PostBoost::InboxReplyDraftApprove.new # InboxReplyDraftApprove |
|
|
43
|
+
}
|
|
44
|
+
|
|
45
|
+
begin
|
|
46
|
+
# Approve and send a reply draft
|
|
47
|
+
result = api_instance.approve_inbox_reply_draft(workspace_uuid, draft_id, opts)
|
|
48
|
+
p result
|
|
49
|
+
rescue PostBoost::ApiError => e
|
|
50
|
+
puts "Error when calling InboxApi->approve_inbox_reply_draft: #{e}"
|
|
51
|
+
end
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
#### Using the approve_inbox_reply_draft_with_http_info variant
|
|
55
|
+
|
|
56
|
+
This returns an Array which contains the response data, status code and headers.
|
|
57
|
+
|
|
58
|
+
> <Array(<CreateInboxReplyDraft201Response>, Integer, Hash)> approve_inbox_reply_draft_with_http_info(workspace_uuid, draft_id, opts)
|
|
59
|
+
|
|
60
|
+
```ruby
|
|
61
|
+
begin
|
|
62
|
+
# Approve and send a reply draft
|
|
63
|
+
data, status_code, headers = api_instance.approve_inbox_reply_draft_with_http_info(workspace_uuid, draft_id, opts)
|
|
64
|
+
p status_code # => 2xx
|
|
65
|
+
p headers # => { ... }
|
|
66
|
+
p data # => <CreateInboxReplyDraft201Response>
|
|
67
|
+
rescue PostBoost::ApiError => e
|
|
68
|
+
puts "Error when calling InboxApi->approve_inbox_reply_draft_with_http_info: #{e}"
|
|
69
|
+
end
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
### Parameters
|
|
73
|
+
|
|
74
|
+
| Name | Type | Description | Notes |
|
|
75
|
+
| ---- | ---- | ----------- | ----- |
|
|
76
|
+
| **workspace_uuid** | **String** | UUID of the workspace. | |
|
|
77
|
+
| **draft_id** | **String** | The draft `id`. | |
|
|
78
|
+
| **inbox_reply_draft_approve** | [**InboxReplyDraftApprove**](InboxReplyDraftApprove.md) | | [optional] |
|
|
79
|
+
|
|
80
|
+
### Return type
|
|
81
|
+
|
|
82
|
+
[**CreateInboxReplyDraft201Response**](CreateInboxReplyDraft201Response.md)
|
|
83
|
+
|
|
84
|
+
### Authorization
|
|
85
|
+
|
|
86
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
87
|
+
|
|
88
|
+
### HTTP request headers
|
|
89
|
+
|
|
90
|
+
- **Content-Type**: application/json
|
|
91
|
+
- **Accept**: application/json
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
## create_inbox_reply_draft
|
|
95
|
+
|
|
96
|
+
> <CreateInboxReplyDraft201Response> create_inbox_reply_draft(workspace_uuid, conversation_id, inbox_reply_draft_input)
|
|
97
|
+
|
|
98
|
+
Draft a reply
|
|
99
|
+
|
|
100
|
+
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.
|
|
101
|
+
|
|
102
|
+
### Examples
|
|
103
|
+
|
|
104
|
+
```ruby
|
|
105
|
+
require 'time'
|
|
106
|
+
require 'postboost'
|
|
107
|
+
# setup authorization
|
|
108
|
+
PostBoost.configure do |config|
|
|
109
|
+
# Configure Bearer authorization: bearerAuth
|
|
110
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
111
|
+
end
|
|
112
|
+
|
|
113
|
+
api_instance = PostBoost::InboxApi.new
|
|
114
|
+
workspace_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the workspace.
|
|
115
|
+
conversation_id = 'conversation_id_example' # String | The conversation `id`.
|
|
116
|
+
inbox_reply_draft_input = PostBoost::InboxReplyDraftInput.new({body: 'body_example'}) # InboxReplyDraftInput |
|
|
117
|
+
|
|
118
|
+
begin
|
|
119
|
+
# Draft a reply
|
|
120
|
+
result = api_instance.create_inbox_reply_draft(workspace_uuid, conversation_id, inbox_reply_draft_input)
|
|
121
|
+
p result
|
|
122
|
+
rescue PostBoost::ApiError => e
|
|
123
|
+
puts "Error when calling InboxApi->create_inbox_reply_draft: #{e}"
|
|
124
|
+
end
|
|
125
|
+
```
|
|
126
|
+
|
|
127
|
+
#### Using the create_inbox_reply_draft_with_http_info variant
|
|
128
|
+
|
|
129
|
+
This returns an Array which contains the response data, status code and headers.
|
|
130
|
+
|
|
131
|
+
> <Array(<CreateInboxReplyDraft201Response>, Integer, Hash)> create_inbox_reply_draft_with_http_info(workspace_uuid, conversation_id, inbox_reply_draft_input)
|
|
132
|
+
|
|
133
|
+
```ruby
|
|
134
|
+
begin
|
|
135
|
+
# Draft a reply
|
|
136
|
+
data, status_code, headers = api_instance.create_inbox_reply_draft_with_http_info(workspace_uuid, conversation_id, inbox_reply_draft_input)
|
|
137
|
+
p status_code # => 2xx
|
|
138
|
+
p headers # => { ... }
|
|
139
|
+
p data # => <CreateInboxReplyDraft201Response>
|
|
140
|
+
rescue PostBoost::ApiError => e
|
|
141
|
+
puts "Error when calling InboxApi->create_inbox_reply_draft_with_http_info: #{e}"
|
|
142
|
+
end
|
|
143
|
+
```
|
|
144
|
+
|
|
145
|
+
### Parameters
|
|
146
|
+
|
|
147
|
+
| Name | Type | Description | Notes |
|
|
148
|
+
| ---- | ---- | ----------- | ----- |
|
|
149
|
+
| **workspace_uuid** | **String** | UUID of the workspace. | |
|
|
150
|
+
| **conversation_id** | **String** | The conversation `id`. | |
|
|
151
|
+
| **inbox_reply_draft_input** | [**InboxReplyDraftInput**](InboxReplyDraftInput.md) | | |
|
|
152
|
+
|
|
153
|
+
### Return type
|
|
154
|
+
|
|
155
|
+
[**CreateInboxReplyDraft201Response**](CreateInboxReplyDraft201Response.md)
|
|
156
|
+
|
|
157
|
+
### Authorization
|
|
158
|
+
|
|
159
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
160
|
+
|
|
161
|
+
### HTTP request headers
|
|
162
|
+
|
|
163
|
+
- **Content-Type**: application/json
|
|
164
|
+
- **Accept**: application/json
|
|
165
|
+
|
|
166
|
+
|
|
167
|
+
## delete_inbox_reply_draft
|
|
168
|
+
|
|
169
|
+
> delete_inbox_reply_draft(workspace_uuid, draft_id)
|
|
170
|
+
|
|
171
|
+
Withdraw a reply draft
|
|
172
|
+
|
|
173
|
+
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.
|
|
174
|
+
|
|
175
|
+
### Examples
|
|
176
|
+
|
|
177
|
+
```ruby
|
|
178
|
+
require 'time'
|
|
179
|
+
require 'postboost'
|
|
180
|
+
# setup authorization
|
|
181
|
+
PostBoost.configure do |config|
|
|
182
|
+
# Configure Bearer authorization: bearerAuth
|
|
183
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
184
|
+
end
|
|
185
|
+
|
|
186
|
+
api_instance = PostBoost::InboxApi.new
|
|
187
|
+
workspace_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the workspace.
|
|
188
|
+
draft_id = 'draft_id_example' # String | The draft `id`.
|
|
189
|
+
|
|
190
|
+
begin
|
|
191
|
+
# Withdraw a reply draft
|
|
192
|
+
api_instance.delete_inbox_reply_draft(workspace_uuid, draft_id)
|
|
193
|
+
rescue PostBoost::ApiError => e
|
|
194
|
+
puts "Error when calling InboxApi->delete_inbox_reply_draft: #{e}"
|
|
195
|
+
end
|
|
196
|
+
```
|
|
197
|
+
|
|
198
|
+
#### Using the delete_inbox_reply_draft_with_http_info variant
|
|
199
|
+
|
|
200
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
201
|
+
|
|
202
|
+
> <Array(nil, Integer, Hash)> delete_inbox_reply_draft_with_http_info(workspace_uuid, draft_id)
|
|
203
|
+
|
|
204
|
+
```ruby
|
|
205
|
+
begin
|
|
206
|
+
# Withdraw a reply draft
|
|
207
|
+
data, status_code, headers = api_instance.delete_inbox_reply_draft_with_http_info(workspace_uuid, draft_id)
|
|
208
|
+
p status_code # => 2xx
|
|
209
|
+
p headers # => { ... }
|
|
210
|
+
p data # => nil
|
|
211
|
+
rescue PostBoost::ApiError => e
|
|
212
|
+
puts "Error when calling InboxApi->delete_inbox_reply_draft_with_http_info: #{e}"
|
|
213
|
+
end
|
|
214
|
+
```
|
|
215
|
+
|
|
216
|
+
### Parameters
|
|
217
|
+
|
|
218
|
+
| Name | Type | Description | Notes |
|
|
219
|
+
| ---- | ---- | ----------- | ----- |
|
|
220
|
+
| **workspace_uuid** | **String** | UUID of the workspace. | |
|
|
221
|
+
| **draft_id** | **String** | The draft `id`. | |
|
|
222
|
+
|
|
223
|
+
### Return type
|
|
224
|
+
|
|
225
|
+
nil (empty response body)
|
|
226
|
+
|
|
227
|
+
### Authorization
|
|
228
|
+
|
|
229
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
230
|
+
|
|
231
|
+
### HTTP request headers
|
|
232
|
+
|
|
233
|
+
- **Content-Type**: Not defined
|
|
234
|
+
- **Accept**: application/json
|
|
235
|
+
|
|
236
|
+
|
|
237
|
+
## get_inbox_conversation
|
|
238
|
+
|
|
239
|
+
> <GetInboxConversation200Response> get_inbox_conversation(workspace_uuid, conversation_id)
|
|
240
|
+
|
|
241
|
+
Get an inbox conversation
|
|
242
|
+
|
|
243
|
+
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.
|
|
244
|
+
|
|
245
|
+
### Examples
|
|
246
|
+
|
|
247
|
+
```ruby
|
|
248
|
+
require 'time'
|
|
249
|
+
require 'postboost'
|
|
250
|
+
# setup authorization
|
|
251
|
+
PostBoost.configure do |config|
|
|
252
|
+
# Configure Bearer authorization: bearerAuth
|
|
253
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
254
|
+
end
|
|
255
|
+
|
|
256
|
+
api_instance = PostBoost::InboxApi.new
|
|
257
|
+
workspace_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the workspace.
|
|
258
|
+
conversation_id = 'conversation_id_example' # String | The conversation `id`.
|
|
259
|
+
|
|
260
|
+
begin
|
|
261
|
+
# Get an inbox conversation
|
|
262
|
+
result = api_instance.get_inbox_conversation(workspace_uuid, conversation_id)
|
|
263
|
+
p result
|
|
264
|
+
rescue PostBoost::ApiError => e
|
|
265
|
+
puts "Error when calling InboxApi->get_inbox_conversation: #{e}"
|
|
266
|
+
end
|
|
267
|
+
```
|
|
268
|
+
|
|
269
|
+
#### Using the get_inbox_conversation_with_http_info variant
|
|
270
|
+
|
|
271
|
+
This returns an Array which contains the response data, status code and headers.
|
|
272
|
+
|
|
273
|
+
> <Array(<GetInboxConversation200Response>, Integer, Hash)> get_inbox_conversation_with_http_info(workspace_uuid, conversation_id)
|
|
274
|
+
|
|
275
|
+
```ruby
|
|
276
|
+
begin
|
|
277
|
+
# Get an inbox conversation
|
|
278
|
+
data, status_code, headers = api_instance.get_inbox_conversation_with_http_info(workspace_uuid, conversation_id)
|
|
279
|
+
p status_code # => 2xx
|
|
280
|
+
p headers # => { ... }
|
|
281
|
+
p data # => <GetInboxConversation200Response>
|
|
282
|
+
rescue PostBoost::ApiError => e
|
|
283
|
+
puts "Error when calling InboxApi->get_inbox_conversation_with_http_info: #{e}"
|
|
284
|
+
end
|
|
285
|
+
```
|
|
286
|
+
|
|
287
|
+
### Parameters
|
|
288
|
+
|
|
289
|
+
| Name | Type | Description | Notes |
|
|
290
|
+
| ---- | ---- | ----------- | ----- |
|
|
291
|
+
| **workspace_uuid** | **String** | UUID of the workspace. | |
|
|
292
|
+
| **conversation_id** | **String** | The conversation `id`. | |
|
|
293
|
+
|
|
294
|
+
### Return type
|
|
295
|
+
|
|
296
|
+
[**GetInboxConversation200Response**](GetInboxConversation200Response.md)
|
|
297
|
+
|
|
298
|
+
### Authorization
|
|
299
|
+
|
|
300
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
301
|
+
|
|
302
|
+
### HTTP request headers
|
|
303
|
+
|
|
304
|
+
- **Content-Type**: Not defined
|
|
305
|
+
- **Accept**: application/json
|
|
306
|
+
|
|
307
|
+
|
|
308
|
+
## get_inbox_reply_draft
|
|
309
|
+
|
|
310
|
+
> <CreateInboxReplyDraft201Response> get_inbox_reply_draft(workspace_uuid, draft_id)
|
|
311
|
+
|
|
312
|
+
Get a reply draft
|
|
313
|
+
|
|
314
|
+
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.
|
|
315
|
+
|
|
316
|
+
### Examples
|
|
317
|
+
|
|
318
|
+
```ruby
|
|
319
|
+
require 'time'
|
|
320
|
+
require 'postboost'
|
|
321
|
+
# setup authorization
|
|
322
|
+
PostBoost.configure do |config|
|
|
323
|
+
# Configure Bearer authorization: bearerAuth
|
|
324
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
325
|
+
end
|
|
326
|
+
|
|
327
|
+
api_instance = PostBoost::InboxApi.new
|
|
328
|
+
workspace_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the workspace.
|
|
329
|
+
draft_id = 'draft_id_example' # String | The draft `id`.
|
|
330
|
+
|
|
331
|
+
begin
|
|
332
|
+
# Get a reply draft
|
|
333
|
+
result = api_instance.get_inbox_reply_draft(workspace_uuid, draft_id)
|
|
334
|
+
p result
|
|
335
|
+
rescue PostBoost::ApiError => e
|
|
336
|
+
puts "Error when calling InboxApi->get_inbox_reply_draft: #{e}"
|
|
337
|
+
end
|
|
338
|
+
```
|
|
339
|
+
|
|
340
|
+
#### Using the get_inbox_reply_draft_with_http_info variant
|
|
341
|
+
|
|
342
|
+
This returns an Array which contains the response data, status code and headers.
|
|
343
|
+
|
|
344
|
+
> <Array(<CreateInboxReplyDraft201Response>, Integer, Hash)> get_inbox_reply_draft_with_http_info(workspace_uuid, draft_id)
|
|
345
|
+
|
|
346
|
+
```ruby
|
|
347
|
+
begin
|
|
348
|
+
# Get a reply draft
|
|
349
|
+
data, status_code, headers = api_instance.get_inbox_reply_draft_with_http_info(workspace_uuid, draft_id)
|
|
350
|
+
p status_code # => 2xx
|
|
351
|
+
p headers # => { ... }
|
|
352
|
+
p data # => <CreateInboxReplyDraft201Response>
|
|
353
|
+
rescue PostBoost::ApiError => e
|
|
354
|
+
puts "Error when calling InboxApi->get_inbox_reply_draft_with_http_info: #{e}"
|
|
355
|
+
end
|
|
356
|
+
```
|
|
357
|
+
|
|
358
|
+
### Parameters
|
|
359
|
+
|
|
360
|
+
| Name | Type | Description | Notes |
|
|
361
|
+
| ---- | ---- | ----------- | ----- |
|
|
362
|
+
| **workspace_uuid** | **String** | UUID of the workspace. | |
|
|
363
|
+
| **draft_id** | **String** | The draft `id`. | |
|
|
364
|
+
|
|
365
|
+
### Return type
|
|
366
|
+
|
|
367
|
+
[**CreateInboxReplyDraft201Response**](CreateInboxReplyDraft201Response.md)
|
|
368
|
+
|
|
369
|
+
### Authorization
|
|
370
|
+
|
|
371
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
372
|
+
|
|
373
|
+
### HTTP request headers
|
|
374
|
+
|
|
375
|
+
- **Content-Type**: Not defined
|
|
376
|
+
- **Accept**: application/json
|
|
377
|
+
|
|
378
|
+
|
|
379
|
+
## list_inbox_conversations
|
|
380
|
+
|
|
381
|
+
> <ListInboxConversations200Response> list_inbox_conversations(workspace_uuid, opts)
|
|
382
|
+
|
|
383
|
+
List inbox conversations
|
|
384
|
+
|
|
385
|
+
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.
|
|
386
|
+
|
|
387
|
+
### Examples
|
|
388
|
+
|
|
389
|
+
```ruby
|
|
390
|
+
require 'time'
|
|
391
|
+
require 'postboost'
|
|
392
|
+
# setup authorization
|
|
393
|
+
PostBoost.configure do |config|
|
|
394
|
+
# Configure Bearer authorization: bearerAuth
|
|
395
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
396
|
+
end
|
|
397
|
+
|
|
398
|
+
api_instance = PostBoost::InboxApi.new
|
|
399
|
+
workspace_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the workspace.
|
|
400
|
+
opts = {
|
|
401
|
+
status: 'open', # String | Conversation status.
|
|
402
|
+
account_id: 56, # Integer | Account `id`.
|
|
403
|
+
provider: 'provider_example', # String | Network, for example `bluesky`.
|
|
404
|
+
unread: true, # Boolean | Only unread (`true`) or read (`false`) conversations.
|
|
405
|
+
sentiment: 'negative', # String | AI sentiment.
|
|
406
|
+
ai_label: 'question', # String | AI label.
|
|
407
|
+
since: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Only conversations with activity at or after this time.
|
|
408
|
+
page: 56 # Integer | Page number.
|
|
409
|
+
}
|
|
410
|
+
|
|
411
|
+
begin
|
|
412
|
+
# List inbox conversations
|
|
413
|
+
result = api_instance.list_inbox_conversations(workspace_uuid, opts)
|
|
414
|
+
p result
|
|
415
|
+
rescue PostBoost::ApiError => e
|
|
416
|
+
puts "Error when calling InboxApi->list_inbox_conversations: #{e}"
|
|
417
|
+
end
|
|
418
|
+
```
|
|
419
|
+
|
|
420
|
+
#### Using the list_inbox_conversations_with_http_info variant
|
|
421
|
+
|
|
422
|
+
This returns an Array which contains the response data, status code and headers.
|
|
423
|
+
|
|
424
|
+
> <Array(<ListInboxConversations200Response>, Integer, Hash)> list_inbox_conversations_with_http_info(workspace_uuid, opts)
|
|
425
|
+
|
|
426
|
+
```ruby
|
|
427
|
+
begin
|
|
428
|
+
# List inbox conversations
|
|
429
|
+
data, status_code, headers = api_instance.list_inbox_conversations_with_http_info(workspace_uuid, opts)
|
|
430
|
+
p status_code # => 2xx
|
|
431
|
+
p headers # => { ... }
|
|
432
|
+
p data # => <ListInboxConversations200Response>
|
|
433
|
+
rescue PostBoost::ApiError => e
|
|
434
|
+
puts "Error when calling InboxApi->list_inbox_conversations_with_http_info: #{e}"
|
|
435
|
+
end
|
|
436
|
+
```
|
|
437
|
+
|
|
438
|
+
### Parameters
|
|
439
|
+
|
|
440
|
+
| Name | Type | Description | Notes |
|
|
441
|
+
| ---- | ---- | ----------- | ----- |
|
|
442
|
+
| **workspace_uuid** | **String** | UUID of the workspace. | |
|
|
443
|
+
| **status** | **String** | Conversation status. | [optional] |
|
|
444
|
+
| **account_id** | **Integer** | Account `id`. | [optional] |
|
|
445
|
+
| **provider** | **String** | Network, for example `bluesky`. | [optional] |
|
|
446
|
+
| **unread** | **Boolean** | Only unread (`true`) or read (`false`) conversations. | [optional] |
|
|
447
|
+
| **sentiment** | **String** | AI sentiment. | [optional] |
|
|
448
|
+
| **ai_label** | **String** | AI label. | [optional] |
|
|
449
|
+
| **since** | **Time** | Only conversations with activity at or after this time. | [optional] |
|
|
450
|
+
| **page** | **Integer** | Page number. | [optional][default to 1] |
|
|
451
|
+
|
|
452
|
+
### Return type
|
|
453
|
+
|
|
454
|
+
[**ListInboxConversations200Response**](ListInboxConversations200Response.md)
|
|
455
|
+
|
|
456
|
+
### Authorization
|
|
457
|
+
|
|
458
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
459
|
+
|
|
460
|
+
### HTTP request headers
|
|
461
|
+
|
|
462
|
+
- **Content-Type**: Not defined
|
|
463
|
+
- **Accept**: application/json
|
|
464
|
+
|
|
465
|
+
|
|
466
|
+
## list_inbox_reply_drafts
|
|
467
|
+
|
|
468
|
+
> <ListInboxReplyDrafts200Response> list_inbox_reply_drafts(workspace_uuid, opts)
|
|
469
|
+
|
|
470
|
+
List reply drafts
|
|
471
|
+
|
|
472
|
+
Reply drafts, newest first, 25 per page. Requires the inbox API to be enabled for the workspace (otherwise `404`). Admins and members only.
|
|
473
|
+
|
|
474
|
+
### Examples
|
|
475
|
+
|
|
476
|
+
```ruby
|
|
477
|
+
require 'time'
|
|
478
|
+
require 'postboost'
|
|
479
|
+
# setup authorization
|
|
480
|
+
PostBoost.configure do |config|
|
|
481
|
+
# Configure Bearer authorization: bearerAuth
|
|
482
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
483
|
+
end
|
|
484
|
+
|
|
485
|
+
api_instance = PostBoost::InboxApi.new
|
|
486
|
+
workspace_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the workspace.
|
|
487
|
+
opts = {
|
|
488
|
+
status: 'pending', # String | Draft status.
|
|
489
|
+
conversation_id: 'conversation_id_example', # String | Only drafts for this conversation `id`.
|
|
490
|
+
page: 56 # Integer | Page number.
|
|
491
|
+
}
|
|
492
|
+
|
|
493
|
+
begin
|
|
494
|
+
# List reply drafts
|
|
495
|
+
result = api_instance.list_inbox_reply_drafts(workspace_uuid, opts)
|
|
496
|
+
p result
|
|
497
|
+
rescue PostBoost::ApiError => e
|
|
498
|
+
puts "Error when calling InboxApi->list_inbox_reply_drafts: #{e}"
|
|
499
|
+
end
|
|
500
|
+
```
|
|
501
|
+
|
|
502
|
+
#### Using the list_inbox_reply_drafts_with_http_info variant
|
|
503
|
+
|
|
504
|
+
This returns an Array which contains the response data, status code and headers.
|
|
505
|
+
|
|
506
|
+
> <Array(<ListInboxReplyDrafts200Response>, Integer, Hash)> list_inbox_reply_drafts_with_http_info(workspace_uuid, opts)
|
|
507
|
+
|
|
508
|
+
```ruby
|
|
509
|
+
begin
|
|
510
|
+
# List reply drafts
|
|
511
|
+
data, status_code, headers = api_instance.list_inbox_reply_drafts_with_http_info(workspace_uuid, opts)
|
|
512
|
+
p status_code # => 2xx
|
|
513
|
+
p headers # => { ... }
|
|
514
|
+
p data # => <ListInboxReplyDrafts200Response>
|
|
515
|
+
rescue PostBoost::ApiError => e
|
|
516
|
+
puts "Error when calling InboxApi->list_inbox_reply_drafts_with_http_info: #{e}"
|
|
517
|
+
end
|
|
518
|
+
```
|
|
519
|
+
|
|
520
|
+
### Parameters
|
|
521
|
+
|
|
522
|
+
| Name | Type | Description | Notes |
|
|
523
|
+
| ---- | ---- | ----------- | ----- |
|
|
524
|
+
| **workspace_uuid** | **String** | UUID of the workspace. | |
|
|
525
|
+
| **status** | **String** | Draft status. | [optional] |
|
|
526
|
+
| **conversation_id** | **String** | Only drafts for this conversation `id`. | [optional] |
|
|
527
|
+
| **page** | **Integer** | Page number. | [optional][default to 1] |
|
|
528
|
+
|
|
529
|
+
### Return type
|
|
530
|
+
|
|
531
|
+
[**ListInboxReplyDrafts200Response**](ListInboxReplyDrafts200Response.md)
|
|
532
|
+
|
|
533
|
+
### Authorization
|
|
534
|
+
|
|
535
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
536
|
+
|
|
537
|
+
### HTTP request headers
|
|
538
|
+
|
|
539
|
+
- **Content-Type**: Not defined
|
|
540
|
+
- **Accept**: application/json
|
|
541
|
+
|
|
542
|
+
|
|
543
|
+
## reject_inbox_reply_draft
|
|
544
|
+
|
|
545
|
+
> <CreateInboxReplyDraft201Response> reject_inbox_reply_draft(workspace_uuid, draft_id)
|
|
546
|
+
|
|
547
|
+
Reject a reply draft
|
|
548
|
+
|
|
549
|
+
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.
|
|
550
|
+
|
|
551
|
+
### Examples
|
|
552
|
+
|
|
553
|
+
```ruby
|
|
554
|
+
require 'time'
|
|
555
|
+
require 'postboost'
|
|
556
|
+
# setup authorization
|
|
557
|
+
PostBoost.configure do |config|
|
|
558
|
+
# Configure Bearer authorization: bearerAuth
|
|
559
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
560
|
+
end
|
|
561
|
+
|
|
562
|
+
api_instance = PostBoost::InboxApi.new
|
|
563
|
+
workspace_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the workspace.
|
|
564
|
+
draft_id = 'draft_id_example' # String | The draft `id`.
|
|
565
|
+
|
|
566
|
+
begin
|
|
567
|
+
# Reject a reply draft
|
|
568
|
+
result = api_instance.reject_inbox_reply_draft(workspace_uuid, draft_id)
|
|
569
|
+
p result
|
|
570
|
+
rescue PostBoost::ApiError => e
|
|
571
|
+
puts "Error when calling InboxApi->reject_inbox_reply_draft: #{e}"
|
|
572
|
+
end
|
|
573
|
+
```
|
|
574
|
+
|
|
575
|
+
#### Using the reject_inbox_reply_draft_with_http_info variant
|
|
576
|
+
|
|
577
|
+
This returns an Array which contains the response data, status code and headers.
|
|
578
|
+
|
|
579
|
+
> <Array(<CreateInboxReplyDraft201Response>, Integer, Hash)> reject_inbox_reply_draft_with_http_info(workspace_uuid, draft_id)
|
|
580
|
+
|
|
581
|
+
```ruby
|
|
582
|
+
begin
|
|
583
|
+
# Reject a reply draft
|
|
584
|
+
data, status_code, headers = api_instance.reject_inbox_reply_draft_with_http_info(workspace_uuid, draft_id)
|
|
585
|
+
p status_code # => 2xx
|
|
586
|
+
p headers # => { ... }
|
|
587
|
+
p data # => <CreateInboxReplyDraft201Response>
|
|
588
|
+
rescue PostBoost::ApiError => e
|
|
589
|
+
puts "Error when calling InboxApi->reject_inbox_reply_draft_with_http_info: #{e}"
|
|
590
|
+
end
|
|
591
|
+
```
|
|
592
|
+
|
|
593
|
+
### Parameters
|
|
594
|
+
|
|
595
|
+
| Name | Type | Description | Notes |
|
|
596
|
+
| ---- | ---- | ----------- | ----- |
|
|
597
|
+
| **workspace_uuid** | **String** | UUID of the workspace. | |
|
|
598
|
+
| **draft_id** | **String** | The draft `id`. | |
|
|
599
|
+
|
|
600
|
+
### Return type
|
|
601
|
+
|
|
602
|
+
[**CreateInboxReplyDraft201Response**](CreateInboxReplyDraft201Response.md)
|
|
603
|
+
|
|
604
|
+
### Authorization
|
|
605
|
+
|
|
606
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
607
|
+
|
|
608
|
+
### HTTP request headers
|
|
609
|
+
|
|
610
|
+
- **Content-Type**: Not defined
|
|
611
|
+
- **Accept**: application/json
|
|
612
|
+
|
|
613
|
+
|
|
614
|
+
## update_inbox_conversation
|
|
615
|
+
|
|
616
|
+
> <GetInboxConversation200Response> update_inbox_conversation(workspace_uuid, conversation_id, inbox_conversation_update)
|
|
617
|
+
|
|
618
|
+
Update an inbox conversation
|
|
619
|
+
|
|
620
|
+
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.
|
|
621
|
+
|
|
622
|
+
### Examples
|
|
623
|
+
|
|
624
|
+
```ruby
|
|
625
|
+
require 'time'
|
|
626
|
+
require 'postboost'
|
|
627
|
+
# setup authorization
|
|
628
|
+
PostBoost.configure do |config|
|
|
629
|
+
# Configure Bearer authorization: bearerAuth
|
|
630
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
631
|
+
end
|
|
632
|
+
|
|
633
|
+
api_instance = PostBoost::InboxApi.new
|
|
634
|
+
workspace_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the workspace.
|
|
635
|
+
conversation_id = 'conversation_id_example' # String | The conversation `id`.
|
|
636
|
+
inbox_conversation_update = PostBoost::InboxConversationUpdate.new # InboxConversationUpdate |
|
|
637
|
+
|
|
638
|
+
begin
|
|
639
|
+
# Update an inbox conversation
|
|
640
|
+
result = api_instance.update_inbox_conversation(workspace_uuid, conversation_id, inbox_conversation_update)
|
|
641
|
+
p result
|
|
642
|
+
rescue PostBoost::ApiError => e
|
|
643
|
+
puts "Error when calling InboxApi->update_inbox_conversation: #{e}"
|
|
644
|
+
end
|
|
645
|
+
```
|
|
646
|
+
|
|
647
|
+
#### Using the update_inbox_conversation_with_http_info variant
|
|
648
|
+
|
|
649
|
+
This returns an Array which contains the response data, status code and headers.
|
|
650
|
+
|
|
651
|
+
> <Array(<GetInboxConversation200Response>, Integer, Hash)> update_inbox_conversation_with_http_info(workspace_uuid, conversation_id, inbox_conversation_update)
|
|
652
|
+
|
|
653
|
+
```ruby
|
|
654
|
+
begin
|
|
655
|
+
# Update an inbox conversation
|
|
656
|
+
data, status_code, headers = api_instance.update_inbox_conversation_with_http_info(workspace_uuid, conversation_id, inbox_conversation_update)
|
|
657
|
+
p status_code # => 2xx
|
|
658
|
+
p headers # => { ... }
|
|
659
|
+
p data # => <GetInboxConversation200Response>
|
|
660
|
+
rescue PostBoost::ApiError => e
|
|
661
|
+
puts "Error when calling InboxApi->update_inbox_conversation_with_http_info: #{e}"
|
|
662
|
+
end
|
|
663
|
+
```
|
|
664
|
+
|
|
665
|
+
### Parameters
|
|
666
|
+
|
|
667
|
+
| Name | Type | Description | Notes |
|
|
668
|
+
| ---- | ---- | ----------- | ----- |
|
|
669
|
+
| **workspace_uuid** | **String** | UUID of the workspace. | |
|
|
670
|
+
| **conversation_id** | **String** | The conversation `id`. | |
|
|
671
|
+
| **inbox_conversation_update** | [**InboxConversationUpdate**](InboxConversationUpdate.md) | | |
|
|
672
|
+
|
|
673
|
+
### Return type
|
|
674
|
+
|
|
675
|
+
[**GetInboxConversation200Response**](GetInboxConversation200Response.md)
|
|
676
|
+
|
|
677
|
+
### Authorization
|
|
678
|
+
|
|
679
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
680
|
+
|
|
681
|
+
### HTTP request headers
|
|
682
|
+
|
|
683
|
+
- **Content-Type**: application/json
|
|
684
|
+
- **Accept**: application/json
|
|
685
|
+
|
|
686
|
+
|
|
687
|
+
## update_inbox_reply_draft
|
|
688
|
+
|
|
689
|
+
> <CreateInboxReplyDraft201Response> update_inbox_reply_draft(workspace_uuid, draft_id, inbox_reply_draft_edit)
|
|
690
|
+
|
|
691
|
+
Edit a reply draft
|
|
692
|
+
|
|
693
|
+
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.
|
|
694
|
+
|
|
695
|
+
### Examples
|
|
696
|
+
|
|
697
|
+
```ruby
|
|
698
|
+
require 'time'
|
|
699
|
+
require 'postboost'
|
|
700
|
+
# setup authorization
|
|
701
|
+
PostBoost.configure do |config|
|
|
702
|
+
# Configure Bearer authorization: bearerAuth
|
|
703
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
704
|
+
end
|
|
705
|
+
|
|
706
|
+
api_instance = PostBoost::InboxApi.new
|
|
707
|
+
workspace_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the workspace.
|
|
708
|
+
draft_id = 'draft_id_example' # String | The draft `id`.
|
|
709
|
+
inbox_reply_draft_edit = PostBoost::InboxReplyDraftEdit.new({body: 'body_example'}) # InboxReplyDraftEdit |
|
|
710
|
+
|
|
711
|
+
begin
|
|
712
|
+
# Edit a reply draft
|
|
713
|
+
result = api_instance.update_inbox_reply_draft(workspace_uuid, draft_id, inbox_reply_draft_edit)
|
|
714
|
+
p result
|
|
715
|
+
rescue PostBoost::ApiError => e
|
|
716
|
+
puts "Error when calling InboxApi->update_inbox_reply_draft: #{e}"
|
|
717
|
+
end
|
|
718
|
+
```
|
|
719
|
+
|
|
720
|
+
#### Using the update_inbox_reply_draft_with_http_info variant
|
|
721
|
+
|
|
722
|
+
This returns an Array which contains the response data, status code and headers.
|
|
723
|
+
|
|
724
|
+
> <Array(<CreateInboxReplyDraft201Response>, Integer, Hash)> update_inbox_reply_draft_with_http_info(workspace_uuid, draft_id, inbox_reply_draft_edit)
|
|
725
|
+
|
|
726
|
+
```ruby
|
|
727
|
+
begin
|
|
728
|
+
# Edit a reply draft
|
|
729
|
+
data, status_code, headers = api_instance.update_inbox_reply_draft_with_http_info(workspace_uuid, draft_id, inbox_reply_draft_edit)
|
|
730
|
+
p status_code # => 2xx
|
|
731
|
+
p headers # => { ... }
|
|
732
|
+
p data # => <CreateInboxReplyDraft201Response>
|
|
733
|
+
rescue PostBoost::ApiError => e
|
|
734
|
+
puts "Error when calling InboxApi->update_inbox_reply_draft_with_http_info: #{e}"
|
|
735
|
+
end
|
|
736
|
+
```
|
|
737
|
+
|
|
738
|
+
### Parameters
|
|
739
|
+
|
|
740
|
+
| Name | Type | Description | Notes |
|
|
741
|
+
| ---- | ---- | ----------- | ----- |
|
|
742
|
+
| **workspace_uuid** | **String** | UUID of the workspace. | |
|
|
743
|
+
| **draft_id** | **String** | The draft `id`. | |
|
|
744
|
+
| **inbox_reply_draft_edit** | [**InboxReplyDraftEdit**](InboxReplyDraftEdit.md) | | |
|
|
745
|
+
|
|
746
|
+
### Return type
|
|
747
|
+
|
|
748
|
+
[**CreateInboxReplyDraft201Response**](CreateInboxReplyDraft201Response.md)
|
|
749
|
+
|
|
750
|
+
### Authorization
|
|
751
|
+
|
|
752
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
753
|
+
|
|
754
|
+
### HTTP request headers
|
|
755
|
+
|
|
756
|
+
- **Content-Type**: application/json
|
|
757
|
+
- **Accept**: application/json
|
|
758
|
+
|