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