postboost 1.0.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 +252 -0
- data/SECURITY.md +9 -0
- data/docs/AIApi.md +871 -0
- data/docs/AICredits.md +22 -0
- data/docs/AIUsage.md +20 -0
- data/docs/AIUsageText.md +24 -0
- data/docs/Account.md +19 -9
- data/docs/AccountAnalytics.md +28 -0
- data/docs/AccountAnalyticsInitialSync.md +20 -0
- 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/AccountSchedule.md +22 -0
- data/docs/AccountsApi.md +231 -5
- data/docs/ActivityApi.md +87 -0
- data/docs/AddCompetitor202Response.md +20 -0
- data/docs/AddCompetitor409Response.md +20 -0
- data/docs/AddPostToQueueRequest.md +18 -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 +899 -0
- data/docs/AnalyticsPeriod.md +24 -0
- data/docs/AnalyticsSummary.md +20 -0
- data/docs/AnalyticsSummaryData.md +38 -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/ApprovePostRequest.md +24 -0
- data/docs/BestPostingTimes.md +20 -0
- data/docs/BestPostingTimesTimesInner.md +24 -0
- data/docs/BlogToSocial200Response.md +20 -0
- data/docs/BlogToSocial429Response.md +18 -0
- data/docs/BlogToSocialCaption.md +28 -0
- data/docs/BlogToSocialInput.md +44 -0
- data/docs/BlogToSocialMedia.md +20 -0
- data/docs/BlogToSocialResponse.md +30 -0
- data/docs/BrandVoice.md +48 -0
- data/docs/BrandVoiceInput.md +46 -0
- data/docs/BrandVoiceMeta.md +18 -0
- data/docs/CancelSubscription422Response.md +20 -0
- data/docs/CancelSubscription422ResponseErrors.md +18 -0
- data/docs/CancelSubscriptionRequest.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/CompleteChunkedUploadRequest.md +20 -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/CreateMediaFolderRequest.md +20 -0
- data/docs/CreateMention201Response.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/DeleteMediaBulkRequest.md +1 -1
- data/docs/DeleteMediaBulkRequestItemsInner.md +49 -0
- data/docs/DeleteMediaFolderRequest.md +18 -0
- data/docs/DeleteResult.md +3 -3
- 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/ImageAltText200Response.md +18 -0
- data/docs/ImageAltTextInput.md +18 -0
- data/docs/ImageAltTextResponse.md +24 -0
- data/docs/ImageCreditBalance.md +28 -0
- data/docs/ImageEditInput.md +30 -0
- data/docs/ImageGenerate200Response.md +20 -0
- data/docs/ImageGenerate429Response.md +18 -0
- data/docs/ImageGenerateInput.md +38 -0
- data/docs/ImageGenerationResponse.md +30 -0
- data/docs/ImagePrompt200Response.md +20 -0
- data/docs/ImagePrompt429Response.md +18 -0
- data/docs/ImagePromptInput.md +30 -0
- data/docs/ImagePromptResponse.md +18 -0
- data/docs/ImageVariations200Response.md +18 -0
- data/docs/ImageVariationsInput.md +24 -0
- data/docs/ImageVariationsResponse.md +26 -0
- 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/{InitiateChunkedUpload200Response.md → InitiateChunkedUpload201Response.md} +2 -2
- data/docs/{InitiateRemoteUpload200Response.md → InitiateRemoteUpload201Response.md} +7 -7
- data/docs/{InitiateRemoteUpload200ResponseOneOf.md → InitiateRemoteUpload201ResponseOneOf.md} +2 -2
- data/docs/InitiateRemoteUploadRequest.md +3 -1
- 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/ListMediaFolders200Response.md +18 -0
- data/docs/ListMentions200Response.md +22 -0
- data/docs/ListMyWorkspaces200Response.md +18 -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/Media.md +22 -8
- data/docs/MediaApi.md +435 -31
- data/docs/MediaBase64Input.md +24 -0
- data/docs/MediaFolder.md +24 -0
- data/docs/MediaFolderInput.md +20 -0
- data/docs/MediaFolderRef.md +20 -0
- data/docs/Mention.md +28 -0
- data/docs/MentionIdentity.md +24 -0
- data/docs/MentionIdentityInput.md +26 -0
- data/docs/MentionInput.md +22 -0
- data/docs/MentionsApi.md +379 -0
- data/docs/MessageOnly.md +18 -0
- data/docs/PollRssFeed200Response.md +22 -0
- data/docs/Post.md +10 -8
- data/docs/PostAnalytics.md +22 -0
- data/docs/PostContent.md +1 -1
- data/docs/PostInput.md +8 -2
- data/docs/PostOptionsInstagram.md +22 -0
- data/docs/PostOptionsTikTok.md +34 -0
- data/docs/PostOptionsYoutube.md +24 -0
- data/docs/PostVersion.md +4 -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/PostingTimeSlot.md +22 -0
- data/docs/PostingTimes.md +32 -0
- data/docs/PostingTimesBestInner.md +24 -0
- data/docs/PostingTimesDayIntervalsInnerInner.md +28 -0
- data/docs/PostingTimesDaysInner.md +24 -0
- data/docs/PostsApi.md +1264 -82
- data/docs/PreflightResult.md +26 -0
- data/docs/PublicWorkspace.md +24 -0
- data/docs/PublicWorkspacePivot.md +22 -0
- data/docs/PublishProgress.md +22 -0
- data/docs/QueueSlots.md +20 -0
- data/docs/Receipt.md +8 -8
- data/docs/ReceiptsApi.md +15 -1
- 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/RemoveGenericSubscription422Response.md +18 -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/RetryPostAccountResult.md +22 -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/SchedulePostRequest.md +9 -1
- data/docs/ScheduleResult.md +4 -2
- data/docs/Subscription.md +5 -5
- data/docs/SubscriptionsApi.md +27 -5
- data/docs/Tag.md +4 -4
- data/docs/TagsApi.md +18 -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/UpdateMediaRequest.md +6 -2
- data/docs/{UploadChunk200Response.md → UploadChunk201Response.md} +2 -2
- data/docs/User.md +7 -5
- data/docs/UsersApi.md +15 -1
- 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/Workspace.md +8 -6
- 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/WorkspaceInput.md +1 -1
- data/docs/WorkspacesApi.md +582 -3
- 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 +233 -4
- 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 +884 -0
- data/lib/postboost/api/analytics_api.rb +910 -0
- 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 +496 -24
- data/lib/postboost/api/mentions_api.rb +397 -0
- data/lib/postboost/api/posting_schedule_api.rb +389 -0
- data/lib/postboost/api/posts_api.rb +1321 -104
- data/lib/postboost/api/receipts_api.rb +17 -2
- data/lib/postboost/api/subscriptions_api.rb +28 -3
- data/lib/postboost/api/tags_api.rb +23 -2
- data/lib/postboost/api/templates_api.rb +395 -0
- data/lib/postboost/api/users_api.rb +17 -2
- data/lib/postboost/api/webhooks_api.rb +228 -0
- data/lib/postboost/api/workspaces_api.rb +545 -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 +145 -4
- data/lib/postboost/models/account_analytics.rb +308 -0
- data/lib/postboost/models/account_analytics_initial_sync.rb +231 -0
- 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 +255 -0
- 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 +215 -0
- 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 +256 -0
- 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 +270 -0
- data/lib/postboost/models/analytics_summary.rb +237 -0
- data/lib/postboost/models/analytics_summary_data.rb +327 -0
- 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 +247 -0
- data/lib/postboost/models/best_posting_times.rb +240 -0
- data/lib/postboost/models/best_posting_times_times_inner.rb +269 -0
- data/lib/postboost/models/blog_to_social200_response.rb +223 -0
- data/lib/postboost/models/blog_to_social429_response.rb +214 -0
- data/lib/postboost/models/blog_to_social_caption.rb +265 -0
- data/lib/postboost/models/blog_to_social_input.rb +548 -0
- data/lib/postboost/models/blog_to_social_media.rb +226 -0
- data/lib/postboost/models/blog_to_social_response.rb +276 -0
- 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 +223 -0
- data/lib/postboost/models/cancel_subscription422_response_errors.rb +216 -0
- data/lib/postboost/models/cancel_subscription_request.rb +217 -0
- 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 +243 -0
- 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 +258 -0
- data/lib/postboost/models/create_mention201_response.rb +214 -0
- 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 +23 -4
- data/lib/postboost/models/delete_media_bulk_request_items_inner.rb +105 -0
- data/lib/postboost/models/delete_media_folder_request.rb +216 -0
- 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 +23 -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 +221 -0
- data/lib/postboost/models/image_alt_text_input.rb +221 -0
- data/lib/postboost/models/image_alt_text_response.rb +262 -0
- data/lib/postboost/models/image_credit_balance.rb +295 -0
- data/lib/postboost/models/image_edit_input.rb +387 -0
- data/lib/postboost/models/image_generate200_response.rb +230 -0
- data/lib/postboost/models/image_generate429_response.rb +214 -0
- data/lib/postboost/models/image_generate_input.rb +479 -0
- data/lib/postboost/models/image_generation_response.rb +305 -0
- data/lib/postboost/models/image_prompt200_response.rb +230 -0
- data/lib/postboost/models/image_prompt429_response.rb +214 -0
- data/lib/postboost/models/image_prompt_input.rb +377 -0
- data/lib/postboost/models/image_prompt_response.rb +221 -0
- data/lib/postboost/models/image_variations200_response.rb +221 -0
- data/lib/postboost/models/image_variations_input.rb +328 -0
- data/lib/postboost/models/image_variations_response.rb +280 -0
- 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_upload200_response.rb → initiate_chunked_upload201_response.rb} +5 -5
- data/lib/postboost/models/initiate_chunked_upload_request.rb +2 -2
- data/lib/postboost/models/{initiate_remote_upload200_response.rb → initiate_remote_upload201_response.rb} +4 -4
- data/lib/postboost/models/{initiate_remote_upload200_response_one_of.rb → initiate_remote_upload201_response_one_of.rb} +5 -5
- data/lib/postboost/models/initiate_remote_upload_request.rb +16 -6
- 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 +216 -0
- data/lib/postboost/models/list_mentions200_response.rb +241 -0
- data/lib/postboost/models/list_my_workspaces200_response.rb +216 -0
- 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 +128 -3
- data/lib/postboost/models/media_base64_input.rb +295 -0
- data/lib/postboost/models/media_folder.rb +271 -0
- data/lib/postboost/models/media_folder_input.rb +244 -0
- data/lib/postboost/models/media_folder_ref.rb +237 -0
- data/lib/postboost/models/mention.rb +290 -0
- data/lib/postboost/models/mention_identity.rb +257 -0
- data/lib/postboost/models/mention_identity_input.rb +325 -0
- data/lib/postboost/models/mention_input.rb +279 -0
- 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 +69 -3
- data/lib/postboost/models/post_analytics.rb +252 -0
- data/lib/postboost/models/post_content.rb +4 -3
- data/lib/postboost/models/post_input.rb +41 -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 +6 -3
- data/lib/postboost/models/post_version.rb +53 -5
- 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 +315 -0
- data/lib/postboost/models/posting_times.rb +362 -0
- data/lib/postboost/models/posting_times_best_inner.rb +269 -0
- data/lib/postboost/models/posting_times_day_intervals_inner_inner.rb +370 -0
- data/lib/postboost/models/posting_times_days_inner.rb +366 -0
- data/lib/postboost/models/preflight_result.rb +291 -0
- data/lib/postboost/models/public_workspace.rb +262 -0
- data/lib/postboost/models/public_workspace_pivot.rb +267 -0
- data/lib/postboost/models/publish_progress.rb +254 -0
- data/lib/postboost/models/queue_slots.rb +237 -0
- data/lib/postboost/models/receipt.rb +58 -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 +214 -0
- 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 +275 -0
- 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 +48 -6
- data/lib/postboost/models/schedule_result.rb +23 -6
- data/lib/postboost/models/subscription.rb +37 -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 +30 -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 +61 -11
- data/lib/postboost/models/{upload_chunk200_response.rb → upload_chunk201_response.rb} +5 -5
- data/lib/postboost/models/user.rb +48 -3
- 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 +42 -3
- 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 +3 -9
- 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 +219 -6
- data/postboost.gemspec +3 -3
- data/spec/api/account_groups_api_spec.rb +102 -0
- data/spec/api/accounts_api_spec.rb +46 -3
- 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 +189 -0
- data/spec/api/analytics_api_spec.rb +201 -0
- 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 +92 -11
- data/spec/api/mentions_api_spec.rb +104 -0
- data/spec/api/posting_schedule_api_spec.rb +102 -0
- data/spec/api/posts_api_spec.rb +224 -6
- data/spec/api/receipts_api_spec.rb +9 -2
- data/spec/api/subscriptions_api_spec.rb +12 -2
- data/spec/api/tags_api_spec.rb +8 -2
- data/spec/api/templates_api_spec.rb +102 -0
- data/spec/api/users_api_spec.rb +9 -2
- data/spec/api/webhooks_api_spec.rb +73 -0
- data/spec/api/workspaces_api_spec.rb +108 -2
- data/spec/models/account_analytics_initial_sync_spec.rb +42 -0
- data/spec/models/account_analytics_spec.rb +66 -0
- 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 +48 -0
- data/spec/models/account_spec.rb +36 -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 +36 -0
- 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 +48 -0
- 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 +54 -0
- data/spec/models/analytics_summary_data_spec.rb +96 -0
- data/spec/models/analytics_summary_spec.rb +42 -0
- 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 +54 -0
- data/spec/models/best_posting_times_spec.rb +42 -0
- data/spec/models/best_posting_times_times_inner_spec.rb +54 -0
- data/spec/models/blog_to_social200_response_spec.rb +42 -0
- data/spec/models/blog_to_social429_response_spec.rb +36 -0
- data/spec/models/blog_to_social_caption_spec.rb +66 -0
- data/spec/models/blog_to_social_input_spec.rb +134 -0
- data/spec/models/blog_to_social_media_spec.rb +42 -0
- data/spec/models/blog_to_social_response_spec.rb +72 -0
- 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 +36 -0
- data/spec/models/cancel_subscription422_response_spec.rb +42 -0
- data/spec/models/cancel_subscription_request_spec.rb +36 -0
- 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 +42 -0
- 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 +42 -0
- data/spec/models/create_mention201_response_spec.rb +36 -0
- 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 +32 -0
- data/spec/models/delete_media_bulk_request_spec.rb +2 -2
- data/spec/models/delete_media_folder_request_spec.rb +36 -0
- 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 +36 -0
- data/spec/models/image_alt_text_input_spec.rb +36 -0
- data/spec/models/image_alt_text_response_spec.rb +54 -0
- data/spec/models/image_credit_balance_spec.rb +66 -0
- data/spec/models/image_edit_input_spec.rb +80 -0
- data/spec/models/image_generate200_response_spec.rb +42 -0
- data/spec/models/image_generate429_response_spec.rb +36 -0
- data/spec/models/image_generate_input_spec.rb +108 -0
- data/spec/models/image_generation_response_spec.rb +72 -0
- data/spec/models/image_prompt200_response_spec.rb +42 -0
- data/spec/models/image_prompt429_response_spec.rb +36 -0
- data/spec/models/image_prompt_input_spec.rb +76 -0
- data/spec/models/image_prompt_response_spec.rb +36 -0
- data/spec/models/image_variations200_response_spec.rb +36 -0
- data/spec/models/image_variations_input_spec.rb +62 -0
- data/spec/models/image_variations_response_spec.rb +60 -0
- 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 +48 -0
- data/spec/models/initiate_chunked_upload_request_spec.rb +2 -2
- data/spec/models/initiate_remote_upload201_response_one_of_spec.rb +36 -0
- data/spec/models/initiate_remote_upload201_response_spec.rb +32 -0
- data/spec/models/initiate_remote_upload_request_spec.rb +8 -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 +36 -0
- data/spec/models/list_mentions200_response_spec.rb +48 -0
- data/spec/models/list_my_workspaces200_response_spec.rb +36 -0
- 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 +42 -0
- data/spec/models/media_folder_ref_spec.rb +42 -0
- data/spec/models/media_folder_spec.rb +54 -0
- data/spec/models/media_spec.rb +44 -2
- data/spec/models/mention_identity_input_spec.rb +60 -0
- data/spec/models/mention_identity_spec.rb +54 -0
- data/spec/models/mention_input_spec.rb +48 -0
- data/spec/models/mention_spec.rb +66 -0
- 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 +48 -0
- data/spec/models/post_content_spec.rb +2 -2
- data/spec/models/post_input_spec.rb +20 -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 +8 -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 +8 -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 +52 -0
- data/spec/models/posting_times_best_inner_spec.rb +54 -0
- data/spec/models/posting_times_day_intervals_inner_inner_spec.rb +70 -0
- data/spec/models/posting_times_days_inner_spec.rb +58 -0
- data/spec/models/posting_times_spec.rb +78 -0
- data/spec/models/preflight_result_spec.rb +60 -0
- data/spec/models/public_workspace_pivot_spec.rb +52 -0
- data/spec/models/public_workspace_spec.rb +54 -0
- data/spec/models/publish_progress_spec.rb +48 -0
- 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 +36 -0
- 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 +48 -0
- 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 +26 -2
- data/spec/models/schedule_result_spec.rb +8 -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 +14 -2
- data/spec/models/upload_chunk201_response_spec.rb +36 -0
- data/spec/models/user_input_spec.rb +2 -2
- data/spec/models/user_spec.rb +8 -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 +8 -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 +943 -76
- data/git_push.sh +0 -57
- data/spec/models/initiate_chunked_upload200_response_spec.rb +0 -48
- data/spec/models/initiate_remote_upload200_response_one_of_spec.rb +0 -36
- data/spec/models/initiate_remote_upload200_response_spec.rb +0 -32
- data/spec/models/upload_chunk200_response_spec.rb +0 -36
data/docs/WorkspacesApi.md
CHANGED
|
@@ -5,10 +5,18 @@ All URIs are relative to *https://postboost.co/app/api*
|
|
|
5
5
|
| Method | HTTP request | Description |
|
|
6
6
|
| ------ | ------------ | ----------- |
|
|
7
7
|
| [**add_user_to_workspace**](WorkspacesApi.md#add_user_to_workspace) | **POST** /panel/workspaces/{workspaceUuid}/users | Add user to workspace |
|
|
8
|
+
| [**create_api_key**](WorkspacesApi.md#create_api_key) | **POST** /{workspaceUuid}/api-keys | Create a scoped API key |
|
|
9
|
+
| [**create_reseller_client**](WorkspacesApi.md#create_reseller_client) | **POST** /{workspaceUuid}/clients | Create a client workspace |
|
|
8
10
|
| [**create_workspace**](WorkspacesApi.md#create_workspace) | **POST** /panel/workspaces | Create workspace |
|
|
11
|
+
| [**delete_api_key**](WorkspacesApi.md#delete_api_key) | **DELETE** /{workspaceUuid}/api-keys/{apiKeyId} | Revoke a scoped API key |
|
|
9
12
|
| [**delete_workspace**](WorkspacesApi.md#delete_workspace) | **DELETE** /panel/workspaces/{workspaceUuid} | Delete workspace |
|
|
10
13
|
| [**delete_workspaces_bulk**](WorkspacesApi.md#delete_workspaces_bulk) | **DELETE** /panel/workspaces | Delete workspaces (bulk) |
|
|
11
14
|
| [**get_workspace**](WorkspacesApi.md#get_workspace) | **GET** /panel/workspaces/{workspaceUuid} | Get workspace |
|
|
15
|
+
| [**get_workspace_ai_credits**](WorkspacesApi.md#get_workspace_ai_credits) | **GET** /panel/workspaces/{workspaceUuid}/ai-credits | Get workspace AI credits |
|
|
16
|
+
| [**get_x_usage**](WorkspacesApi.md#get_x_usage) | **GET** /{workspaceUuid}/usage/x | X (Twitter) usage |
|
|
17
|
+
| [**list_api_keys**](WorkspacesApi.md#list_api_keys) | **GET** /{workspaceUuid}/api-keys | List scoped API keys |
|
|
18
|
+
| [**list_my_workspaces**](WorkspacesApi.md#list_my_workspaces) | **GET** /workspaces | List my workspaces |
|
|
19
|
+
| [**list_reseller_clients**](WorkspacesApi.md#list_reseller_clients) | **GET** /{workspaceUuid}/clients | List client workspaces |
|
|
12
20
|
| [**list_workspaces**](WorkspacesApi.md#list_workspaces) | **GET** /panel/workspaces | List workspaces |
|
|
13
21
|
| [**remove_user_from_workspace**](WorkspacesApi.md#remove_user_from_workspace) | **DELETE** /panel/workspaces/{workspaceUuid}/users | Remove user from workspace |
|
|
14
22
|
| [**update_workspace**](WorkspacesApi.md#update_workspace) | **PUT** /panel/workspaces/{workspaceUuid} | Update workspace |
|
|
@@ -21,6 +29,8 @@ All URIs are relative to *https://postboost.co/app/api*
|
|
|
21
29
|
|
|
22
30
|
Add user to workspace
|
|
23
31
|
|
|
32
|
+
Adds an existing user to the workspace with a specified role. Admin only.
|
|
33
|
+
|
|
24
34
|
### Examples
|
|
25
35
|
|
|
26
36
|
```ruby
|
|
@@ -84,6 +94,148 @@ end
|
|
|
84
94
|
- **Accept**: application/json
|
|
85
95
|
|
|
86
96
|
|
|
97
|
+
## create_api_key
|
|
98
|
+
|
|
99
|
+
> <CreateApiKey201Response> create_api_key(workspace_uuid, api_key_input)
|
|
100
|
+
|
|
101
|
+
Create a scoped API key
|
|
102
|
+
|
|
103
|
+
Creates a least-privilege API key for the calling user, bound to this workspace. Pick the abilities it gets and, optionally, the accounts it may act on. The plain key is in `data.token` of this response only; store it safely. | Ability | Allows | |---|---| | `read` | Every `GET`, plus the `posts/validate` dry run | | `write` | Creating and changing drafts, media, tags, mentions, the brand voice | | `publish` | Scheduling, queueing, publishing now, approving and retrying posts, and editing a post that is already scheduled | | `ai` | The `/ai/*` endpoints, running agents and turning on agent AI review (they also need AI credits) | | `webhooks` | Webhook subscription endpoints | A scoped key is refused on other workspaces, on the admin panel, on API key management and on the app's built-in MCP endpoint (use `/mcp/postboost`). With `account_ids`, it may only name those accounts (in the URL, `accounts`, `account_ids` or post versions), cannot touch posts on other accounts, and `GET accounts` / `GET posts` only list matching items (pagination counts are computed before that filter). Workspace admins only, called with an unscoped key.
|
|
104
|
+
|
|
105
|
+
### Examples
|
|
106
|
+
|
|
107
|
+
```ruby
|
|
108
|
+
require 'time'
|
|
109
|
+
require 'postboost'
|
|
110
|
+
# setup authorization
|
|
111
|
+
PostBoost.configure do |config|
|
|
112
|
+
# Configure Bearer authorization: bearerAuth
|
|
113
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
114
|
+
end
|
|
115
|
+
|
|
116
|
+
api_instance = PostBoost::WorkspacesApi.new
|
|
117
|
+
workspace_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the workspace.
|
|
118
|
+
api_key_input = PostBoost::ApiKeyInput.new({name: 'name_example', abilities: [PostBoost::ApiKeyAbility::READ]}) # ApiKeyInput |
|
|
119
|
+
|
|
120
|
+
begin
|
|
121
|
+
# Create a scoped API key
|
|
122
|
+
result = api_instance.create_api_key(workspace_uuid, api_key_input)
|
|
123
|
+
p result
|
|
124
|
+
rescue PostBoost::ApiError => e
|
|
125
|
+
puts "Error when calling WorkspacesApi->create_api_key: #{e}"
|
|
126
|
+
end
|
|
127
|
+
```
|
|
128
|
+
|
|
129
|
+
#### Using the create_api_key_with_http_info variant
|
|
130
|
+
|
|
131
|
+
This returns an Array which contains the response data, status code and headers.
|
|
132
|
+
|
|
133
|
+
> <Array(<CreateApiKey201Response>, Integer, Hash)> create_api_key_with_http_info(workspace_uuid, api_key_input)
|
|
134
|
+
|
|
135
|
+
```ruby
|
|
136
|
+
begin
|
|
137
|
+
# Create a scoped API key
|
|
138
|
+
data, status_code, headers = api_instance.create_api_key_with_http_info(workspace_uuid, api_key_input)
|
|
139
|
+
p status_code # => 2xx
|
|
140
|
+
p headers # => { ... }
|
|
141
|
+
p data # => <CreateApiKey201Response>
|
|
142
|
+
rescue PostBoost::ApiError => e
|
|
143
|
+
puts "Error when calling WorkspacesApi->create_api_key_with_http_info: #{e}"
|
|
144
|
+
end
|
|
145
|
+
```
|
|
146
|
+
|
|
147
|
+
### Parameters
|
|
148
|
+
|
|
149
|
+
| Name | Type | Description | Notes |
|
|
150
|
+
| ---- | ---- | ----------- | ----- |
|
|
151
|
+
| **workspace_uuid** | **String** | UUID of the workspace. | |
|
|
152
|
+
| **api_key_input** | [**ApiKeyInput**](ApiKeyInput.md) | | |
|
|
153
|
+
|
|
154
|
+
### Return type
|
|
155
|
+
|
|
156
|
+
[**CreateApiKey201Response**](CreateApiKey201Response.md)
|
|
157
|
+
|
|
158
|
+
### Authorization
|
|
159
|
+
|
|
160
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
161
|
+
|
|
162
|
+
### HTTP request headers
|
|
163
|
+
|
|
164
|
+
- **Content-Type**: application/json
|
|
165
|
+
- **Accept**: application/json
|
|
166
|
+
|
|
167
|
+
|
|
168
|
+
## create_reseller_client
|
|
169
|
+
|
|
170
|
+
> <CreateResellerClient201Response> create_reseller_client(workspace_uuid, reseller_client_input)
|
|
171
|
+
|
|
172
|
+
Create a client workspace
|
|
173
|
+
|
|
174
|
+
Creates a client workspace on the Reseller client plan, with the caller as its owner and admin, and links it to this workspace. Fails with `422` and `code: client_limit_reached` once the plan's client limit is used (archived clients do not count). Archive clients on the Client workspaces page. Workspace admins with an unscoped key only.
|
|
175
|
+
|
|
176
|
+
### Examples
|
|
177
|
+
|
|
178
|
+
```ruby
|
|
179
|
+
require 'time'
|
|
180
|
+
require 'postboost'
|
|
181
|
+
# setup authorization
|
|
182
|
+
PostBoost.configure do |config|
|
|
183
|
+
# Configure Bearer authorization: bearerAuth
|
|
184
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
185
|
+
end
|
|
186
|
+
|
|
187
|
+
api_instance = PostBoost::WorkspacesApi.new
|
|
188
|
+
workspace_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the workspace.
|
|
189
|
+
reseller_client_input = PostBoost::ResellerClientInput.new({name: 'name_example'}) # ResellerClientInput |
|
|
190
|
+
|
|
191
|
+
begin
|
|
192
|
+
# Create a client workspace
|
|
193
|
+
result = api_instance.create_reseller_client(workspace_uuid, reseller_client_input)
|
|
194
|
+
p result
|
|
195
|
+
rescue PostBoost::ApiError => e
|
|
196
|
+
puts "Error when calling WorkspacesApi->create_reseller_client: #{e}"
|
|
197
|
+
end
|
|
198
|
+
```
|
|
199
|
+
|
|
200
|
+
#### Using the create_reseller_client_with_http_info variant
|
|
201
|
+
|
|
202
|
+
This returns an Array which contains the response data, status code and headers.
|
|
203
|
+
|
|
204
|
+
> <Array(<CreateResellerClient201Response>, Integer, Hash)> create_reseller_client_with_http_info(workspace_uuid, reseller_client_input)
|
|
205
|
+
|
|
206
|
+
```ruby
|
|
207
|
+
begin
|
|
208
|
+
# Create a client workspace
|
|
209
|
+
data, status_code, headers = api_instance.create_reseller_client_with_http_info(workspace_uuid, reseller_client_input)
|
|
210
|
+
p status_code # => 2xx
|
|
211
|
+
p headers # => { ... }
|
|
212
|
+
p data # => <CreateResellerClient201Response>
|
|
213
|
+
rescue PostBoost::ApiError => e
|
|
214
|
+
puts "Error when calling WorkspacesApi->create_reseller_client_with_http_info: #{e}"
|
|
215
|
+
end
|
|
216
|
+
```
|
|
217
|
+
|
|
218
|
+
### Parameters
|
|
219
|
+
|
|
220
|
+
| Name | Type | Description | Notes |
|
|
221
|
+
| ---- | ---- | ----------- | ----- |
|
|
222
|
+
| **workspace_uuid** | **String** | UUID of the workspace. | |
|
|
223
|
+
| **reseller_client_input** | [**ResellerClientInput**](ResellerClientInput.md) | | |
|
|
224
|
+
|
|
225
|
+
### Return type
|
|
226
|
+
|
|
227
|
+
[**CreateResellerClient201Response**](CreateResellerClient201Response.md)
|
|
228
|
+
|
|
229
|
+
### Authorization
|
|
230
|
+
|
|
231
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
232
|
+
|
|
233
|
+
### HTTP request headers
|
|
234
|
+
|
|
235
|
+
- **Content-Type**: application/json
|
|
236
|
+
- **Accept**: application/json
|
|
237
|
+
|
|
238
|
+
|
|
87
239
|
## create_workspace
|
|
88
240
|
|
|
89
241
|
> <Workspace> create_workspace(workspace_input)
|
|
@@ -104,7 +256,7 @@ PostBoost.configure do |config|
|
|
|
104
256
|
end
|
|
105
257
|
|
|
106
258
|
api_instance = PostBoost::WorkspacesApi.new
|
|
107
|
-
workspace_input = PostBoost::WorkspaceInput.new({name: 'name_example',
|
|
259
|
+
workspace_input = PostBoost::WorkspaceInput.new({name: 'name_example', access_status: 'subscription'}) # WorkspaceInput |
|
|
108
260
|
|
|
109
261
|
begin
|
|
110
262
|
# Create workspace
|
|
@@ -153,12 +305,85 @@ end
|
|
|
153
305
|
- **Accept**: application/json
|
|
154
306
|
|
|
155
307
|
|
|
308
|
+
## delete_api_key
|
|
309
|
+
|
|
310
|
+
> Object delete_api_key(workspace_uuid, api_key_id)
|
|
311
|
+
|
|
312
|
+
Revoke a scoped API key
|
|
313
|
+
|
|
314
|
+
Revokes a scoped key bound to this workspace. It stops working at once. Workspace admins only, called with an unscoped key.
|
|
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::WorkspacesApi.new
|
|
328
|
+
workspace_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the workspace.
|
|
329
|
+
api_key_id = 56 # Integer | The key's `id` from `GET api-keys`.
|
|
330
|
+
|
|
331
|
+
begin
|
|
332
|
+
# Revoke a scoped API key
|
|
333
|
+
result = api_instance.delete_api_key(workspace_uuid, api_key_id)
|
|
334
|
+
p result
|
|
335
|
+
rescue PostBoost::ApiError => e
|
|
336
|
+
puts "Error when calling WorkspacesApi->delete_api_key: #{e}"
|
|
337
|
+
end
|
|
338
|
+
```
|
|
339
|
+
|
|
340
|
+
#### Using the delete_api_key_with_http_info variant
|
|
341
|
+
|
|
342
|
+
This returns an Array which contains the response data, status code and headers.
|
|
343
|
+
|
|
344
|
+
> <Array(Object, Integer, Hash)> delete_api_key_with_http_info(workspace_uuid, api_key_id)
|
|
345
|
+
|
|
346
|
+
```ruby
|
|
347
|
+
begin
|
|
348
|
+
# Revoke a scoped API key
|
|
349
|
+
data, status_code, headers = api_instance.delete_api_key_with_http_info(workspace_uuid, api_key_id)
|
|
350
|
+
p status_code # => 2xx
|
|
351
|
+
p headers # => { ... }
|
|
352
|
+
p data # => Object
|
|
353
|
+
rescue PostBoost::ApiError => e
|
|
354
|
+
puts "Error when calling WorkspacesApi->delete_api_key_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
|
+
| **api_key_id** | **Integer** | The key's `id` from `GET api-keys`. | |
|
|
364
|
+
|
|
365
|
+
### Return type
|
|
366
|
+
|
|
367
|
+
**Object**
|
|
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
|
+
|
|
156
379
|
## delete_workspace
|
|
157
380
|
|
|
158
381
|
> Object delete_workspace(workspace_uuid)
|
|
159
382
|
|
|
160
383
|
Delete workspace
|
|
161
384
|
|
|
385
|
+
Permanently deletes a single workspace and all its associated data. Admin only.
|
|
386
|
+
|
|
162
387
|
### Examples
|
|
163
388
|
|
|
164
389
|
```ruby
|
|
@@ -226,6 +451,8 @@ end
|
|
|
226
451
|
|
|
227
452
|
Delete workspaces (bulk)
|
|
228
453
|
|
|
454
|
+
Permanently deletes one or more workspaces and all their associated data. Admin only.
|
|
455
|
+
|
|
229
456
|
### Examples
|
|
230
457
|
|
|
231
458
|
```ruby
|
|
@@ -293,6 +520,8 @@ end
|
|
|
293
520
|
|
|
294
521
|
Get workspace
|
|
295
522
|
|
|
523
|
+
Returns a single workspace by UUID including its subscription status. Admin only.
|
|
524
|
+
|
|
296
525
|
### Examples
|
|
297
526
|
|
|
298
527
|
```ruby
|
|
@@ -354,6 +583,348 @@ end
|
|
|
354
583
|
- **Accept**: application/json
|
|
355
584
|
|
|
356
585
|
|
|
586
|
+
## get_workspace_ai_credits
|
|
587
|
+
|
|
588
|
+
> <AICredits> get_workspace_ai_credits(workspace_uuid)
|
|
589
|
+
|
|
590
|
+
Get workspace AI credits
|
|
591
|
+
|
|
592
|
+
Returns whether the workspace can use AI credits, its remaining balance, and whether the balance is low. Admin only.
|
|
593
|
+
|
|
594
|
+
### Examples
|
|
595
|
+
|
|
596
|
+
```ruby
|
|
597
|
+
require 'time'
|
|
598
|
+
require 'postboost'
|
|
599
|
+
# setup authorization
|
|
600
|
+
PostBoost.configure do |config|
|
|
601
|
+
# Configure Bearer authorization: bearerAuth
|
|
602
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
603
|
+
end
|
|
604
|
+
|
|
605
|
+
api_instance = PostBoost::WorkspacesApi.new
|
|
606
|
+
workspace_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the workspace.
|
|
607
|
+
|
|
608
|
+
begin
|
|
609
|
+
# Get workspace AI credits
|
|
610
|
+
result = api_instance.get_workspace_ai_credits(workspace_uuid)
|
|
611
|
+
p result
|
|
612
|
+
rescue PostBoost::ApiError => e
|
|
613
|
+
puts "Error when calling WorkspacesApi->get_workspace_ai_credits: #{e}"
|
|
614
|
+
end
|
|
615
|
+
```
|
|
616
|
+
|
|
617
|
+
#### Using the get_workspace_ai_credits_with_http_info variant
|
|
618
|
+
|
|
619
|
+
This returns an Array which contains the response data, status code and headers.
|
|
620
|
+
|
|
621
|
+
> <Array(<AICredits>, Integer, Hash)> get_workspace_ai_credits_with_http_info(workspace_uuid)
|
|
622
|
+
|
|
623
|
+
```ruby
|
|
624
|
+
begin
|
|
625
|
+
# Get workspace AI credits
|
|
626
|
+
data, status_code, headers = api_instance.get_workspace_ai_credits_with_http_info(workspace_uuid)
|
|
627
|
+
p status_code # => 2xx
|
|
628
|
+
p headers # => { ... }
|
|
629
|
+
p data # => <AICredits>
|
|
630
|
+
rescue PostBoost::ApiError => e
|
|
631
|
+
puts "Error when calling WorkspacesApi->get_workspace_ai_credits_with_http_info: #{e}"
|
|
632
|
+
end
|
|
633
|
+
```
|
|
634
|
+
|
|
635
|
+
### Parameters
|
|
636
|
+
|
|
637
|
+
| Name | Type | Description | Notes |
|
|
638
|
+
| ---- | ---- | ----------- | ----- |
|
|
639
|
+
| **workspace_uuid** | **String** | UUID of the workspace. | |
|
|
640
|
+
|
|
641
|
+
### Return type
|
|
642
|
+
|
|
643
|
+
[**AICredits**](AICredits.md)
|
|
644
|
+
|
|
645
|
+
### Authorization
|
|
646
|
+
|
|
647
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
648
|
+
|
|
649
|
+
### HTTP request headers
|
|
650
|
+
|
|
651
|
+
- **Content-Type**: Not defined
|
|
652
|
+
- **Accept**: application/json
|
|
653
|
+
|
|
654
|
+
|
|
655
|
+
## get_x_usage
|
|
656
|
+
|
|
657
|
+
> <XUsage> get_x_usage(workspace_uuid)
|
|
658
|
+
|
|
659
|
+
X (Twitter) usage
|
|
660
|
+
|
|
661
|
+
The workspace's X posts this calendar month (UTC) against its monthly X allowance. Every thread part is one X post; a part with a link also counts as a link post. When the allowance is used up, scheduling to X is refused (`429`, `code: x_monthly_cap_reached`) and X posts that come due fail with \"Monthly X allowance reached\". Other networks are not affected. See the X policy in the developer docs.
|
|
662
|
+
|
|
663
|
+
### Examples
|
|
664
|
+
|
|
665
|
+
```ruby
|
|
666
|
+
require 'time'
|
|
667
|
+
require 'postboost'
|
|
668
|
+
# setup authorization
|
|
669
|
+
PostBoost.configure do |config|
|
|
670
|
+
# Configure Bearer authorization: bearerAuth
|
|
671
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
672
|
+
end
|
|
673
|
+
|
|
674
|
+
api_instance = PostBoost::WorkspacesApi.new
|
|
675
|
+
workspace_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the workspace.
|
|
676
|
+
|
|
677
|
+
begin
|
|
678
|
+
# X (Twitter) usage
|
|
679
|
+
result = api_instance.get_x_usage(workspace_uuid)
|
|
680
|
+
p result
|
|
681
|
+
rescue PostBoost::ApiError => e
|
|
682
|
+
puts "Error when calling WorkspacesApi->get_x_usage: #{e}"
|
|
683
|
+
end
|
|
684
|
+
```
|
|
685
|
+
|
|
686
|
+
#### Using the get_x_usage_with_http_info variant
|
|
687
|
+
|
|
688
|
+
This returns an Array which contains the response data, status code and headers.
|
|
689
|
+
|
|
690
|
+
> <Array(<XUsage>, Integer, Hash)> get_x_usage_with_http_info(workspace_uuid)
|
|
691
|
+
|
|
692
|
+
```ruby
|
|
693
|
+
begin
|
|
694
|
+
# X (Twitter) usage
|
|
695
|
+
data, status_code, headers = api_instance.get_x_usage_with_http_info(workspace_uuid)
|
|
696
|
+
p status_code # => 2xx
|
|
697
|
+
p headers # => { ... }
|
|
698
|
+
p data # => <XUsage>
|
|
699
|
+
rescue PostBoost::ApiError => e
|
|
700
|
+
puts "Error when calling WorkspacesApi->get_x_usage_with_http_info: #{e}"
|
|
701
|
+
end
|
|
702
|
+
```
|
|
703
|
+
|
|
704
|
+
### Parameters
|
|
705
|
+
|
|
706
|
+
| Name | Type | Description | Notes |
|
|
707
|
+
| ---- | ---- | ----------- | ----- |
|
|
708
|
+
| **workspace_uuid** | **String** | UUID of the workspace. | |
|
|
709
|
+
|
|
710
|
+
### Return type
|
|
711
|
+
|
|
712
|
+
[**XUsage**](XUsage.md)
|
|
713
|
+
|
|
714
|
+
### Authorization
|
|
715
|
+
|
|
716
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
717
|
+
|
|
718
|
+
### HTTP request headers
|
|
719
|
+
|
|
720
|
+
- **Content-Type**: Not defined
|
|
721
|
+
- **Accept**: application/json
|
|
722
|
+
|
|
723
|
+
|
|
724
|
+
## list_api_keys
|
|
725
|
+
|
|
726
|
+
> <ListApiKeys200Response> list_api_keys(workspace_uuid)
|
|
727
|
+
|
|
728
|
+
List scoped API keys
|
|
729
|
+
|
|
730
|
+
Scoped API keys bound to this workspace, newest first. The secret is never shown again after creation. Workspace admins only, called with an unscoped key (a scoped key gets `403` with `code: insufficient_scope`).
|
|
731
|
+
|
|
732
|
+
### Examples
|
|
733
|
+
|
|
734
|
+
```ruby
|
|
735
|
+
require 'time'
|
|
736
|
+
require 'postboost'
|
|
737
|
+
# setup authorization
|
|
738
|
+
PostBoost.configure do |config|
|
|
739
|
+
# Configure Bearer authorization: bearerAuth
|
|
740
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
741
|
+
end
|
|
742
|
+
|
|
743
|
+
api_instance = PostBoost::WorkspacesApi.new
|
|
744
|
+
workspace_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the workspace.
|
|
745
|
+
|
|
746
|
+
begin
|
|
747
|
+
# List scoped API keys
|
|
748
|
+
result = api_instance.list_api_keys(workspace_uuid)
|
|
749
|
+
p result
|
|
750
|
+
rescue PostBoost::ApiError => e
|
|
751
|
+
puts "Error when calling WorkspacesApi->list_api_keys: #{e}"
|
|
752
|
+
end
|
|
753
|
+
```
|
|
754
|
+
|
|
755
|
+
#### Using the list_api_keys_with_http_info variant
|
|
756
|
+
|
|
757
|
+
This returns an Array which contains the response data, status code and headers.
|
|
758
|
+
|
|
759
|
+
> <Array(<ListApiKeys200Response>, Integer, Hash)> list_api_keys_with_http_info(workspace_uuid)
|
|
760
|
+
|
|
761
|
+
```ruby
|
|
762
|
+
begin
|
|
763
|
+
# List scoped API keys
|
|
764
|
+
data, status_code, headers = api_instance.list_api_keys_with_http_info(workspace_uuid)
|
|
765
|
+
p status_code # => 2xx
|
|
766
|
+
p headers # => { ... }
|
|
767
|
+
p data # => <ListApiKeys200Response>
|
|
768
|
+
rescue PostBoost::ApiError => e
|
|
769
|
+
puts "Error when calling WorkspacesApi->list_api_keys_with_http_info: #{e}"
|
|
770
|
+
end
|
|
771
|
+
```
|
|
772
|
+
|
|
773
|
+
### Parameters
|
|
774
|
+
|
|
775
|
+
| Name | Type | Description | Notes |
|
|
776
|
+
| ---- | ---- | ----------- | ----- |
|
|
777
|
+
| **workspace_uuid** | **String** | UUID of the workspace. | |
|
|
778
|
+
|
|
779
|
+
### Return type
|
|
780
|
+
|
|
781
|
+
[**ListApiKeys200Response**](ListApiKeys200Response.md)
|
|
782
|
+
|
|
783
|
+
### Authorization
|
|
784
|
+
|
|
785
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
786
|
+
|
|
787
|
+
### HTTP request headers
|
|
788
|
+
|
|
789
|
+
- **Content-Type**: Not defined
|
|
790
|
+
- **Accept**: application/json
|
|
791
|
+
|
|
792
|
+
|
|
793
|
+
## list_my_workspaces
|
|
794
|
+
|
|
795
|
+
> <ListMyWorkspaces200Response> list_my_workspaces
|
|
796
|
+
|
|
797
|
+
List my workspaces
|
|
798
|
+
|
|
799
|
+
Returns the workspaces the authenticated user belongs to, most recently updated first, with the caller's role in each. Use a returned `uuid` as `workspaceUuid`.
|
|
800
|
+
|
|
801
|
+
### Examples
|
|
802
|
+
|
|
803
|
+
```ruby
|
|
804
|
+
require 'time'
|
|
805
|
+
require 'postboost'
|
|
806
|
+
# setup authorization
|
|
807
|
+
PostBoost.configure do |config|
|
|
808
|
+
# Configure Bearer authorization: bearerAuth
|
|
809
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
810
|
+
end
|
|
811
|
+
|
|
812
|
+
api_instance = PostBoost::WorkspacesApi.new
|
|
813
|
+
|
|
814
|
+
begin
|
|
815
|
+
# List my workspaces
|
|
816
|
+
result = api_instance.list_my_workspaces
|
|
817
|
+
p result
|
|
818
|
+
rescue PostBoost::ApiError => e
|
|
819
|
+
puts "Error when calling WorkspacesApi->list_my_workspaces: #{e}"
|
|
820
|
+
end
|
|
821
|
+
```
|
|
822
|
+
|
|
823
|
+
#### Using the list_my_workspaces_with_http_info variant
|
|
824
|
+
|
|
825
|
+
This returns an Array which contains the response data, status code and headers.
|
|
826
|
+
|
|
827
|
+
> <Array(<ListMyWorkspaces200Response>, Integer, Hash)> list_my_workspaces_with_http_info
|
|
828
|
+
|
|
829
|
+
```ruby
|
|
830
|
+
begin
|
|
831
|
+
# List my workspaces
|
|
832
|
+
data, status_code, headers = api_instance.list_my_workspaces_with_http_info
|
|
833
|
+
p status_code # => 2xx
|
|
834
|
+
p headers # => { ... }
|
|
835
|
+
p data # => <ListMyWorkspaces200Response>
|
|
836
|
+
rescue PostBoost::ApiError => e
|
|
837
|
+
puts "Error when calling WorkspacesApi->list_my_workspaces_with_http_info: #{e}"
|
|
838
|
+
end
|
|
839
|
+
```
|
|
840
|
+
|
|
841
|
+
### Parameters
|
|
842
|
+
|
|
843
|
+
This endpoint does not need any parameter.
|
|
844
|
+
|
|
845
|
+
### Return type
|
|
846
|
+
|
|
847
|
+
[**ListMyWorkspaces200Response**](ListMyWorkspaces200Response.md)
|
|
848
|
+
|
|
849
|
+
### Authorization
|
|
850
|
+
|
|
851
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
852
|
+
|
|
853
|
+
### HTTP request headers
|
|
854
|
+
|
|
855
|
+
- **Content-Type**: Not defined
|
|
856
|
+
- **Accept**: application/json
|
|
857
|
+
|
|
858
|
+
|
|
859
|
+
## list_reseller_clients
|
|
860
|
+
|
|
861
|
+
> <ListResellerClients200Response> list_reseller_clients(workspace_uuid)
|
|
862
|
+
|
|
863
|
+
List client workspaces
|
|
864
|
+
|
|
865
|
+
Client workspaces this workspace created on the Reseller plan, active first, then archived. `accounts_needing_reconnect` counts accounts whose connection must be renewed. `meta` gives the active clients and the plan's client limit. Workspace admins with an unscoped key only; other workspaces get `403` with `code: not_a_reseller`.
|
|
866
|
+
|
|
867
|
+
### Examples
|
|
868
|
+
|
|
869
|
+
```ruby
|
|
870
|
+
require 'time'
|
|
871
|
+
require 'postboost'
|
|
872
|
+
# setup authorization
|
|
873
|
+
PostBoost.configure do |config|
|
|
874
|
+
# Configure Bearer authorization: bearerAuth
|
|
875
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
876
|
+
end
|
|
877
|
+
|
|
878
|
+
api_instance = PostBoost::WorkspacesApi.new
|
|
879
|
+
workspace_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the workspace.
|
|
880
|
+
|
|
881
|
+
begin
|
|
882
|
+
# List client workspaces
|
|
883
|
+
result = api_instance.list_reseller_clients(workspace_uuid)
|
|
884
|
+
p result
|
|
885
|
+
rescue PostBoost::ApiError => e
|
|
886
|
+
puts "Error when calling WorkspacesApi->list_reseller_clients: #{e}"
|
|
887
|
+
end
|
|
888
|
+
```
|
|
889
|
+
|
|
890
|
+
#### Using the list_reseller_clients_with_http_info variant
|
|
891
|
+
|
|
892
|
+
This returns an Array which contains the response data, status code and headers.
|
|
893
|
+
|
|
894
|
+
> <Array(<ListResellerClients200Response>, Integer, Hash)> list_reseller_clients_with_http_info(workspace_uuid)
|
|
895
|
+
|
|
896
|
+
```ruby
|
|
897
|
+
begin
|
|
898
|
+
# List client workspaces
|
|
899
|
+
data, status_code, headers = api_instance.list_reseller_clients_with_http_info(workspace_uuid)
|
|
900
|
+
p status_code # => 2xx
|
|
901
|
+
p headers # => { ... }
|
|
902
|
+
p data # => <ListResellerClients200Response>
|
|
903
|
+
rescue PostBoost::ApiError => e
|
|
904
|
+
puts "Error when calling WorkspacesApi->list_reseller_clients_with_http_info: #{e}"
|
|
905
|
+
end
|
|
906
|
+
```
|
|
907
|
+
|
|
908
|
+
### Parameters
|
|
909
|
+
|
|
910
|
+
| Name | Type | Description | Notes |
|
|
911
|
+
| ---- | ---- | ----------- | ----- |
|
|
912
|
+
| **workspace_uuid** | **String** | UUID of the workspace. | |
|
|
913
|
+
|
|
914
|
+
### Return type
|
|
915
|
+
|
|
916
|
+
[**ListResellerClients200Response**](ListResellerClients200Response.md)
|
|
917
|
+
|
|
918
|
+
### Authorization
|
|
919
|
+
|
|
920
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
921
|
+
|
|
922
|
+
### HTTP request headers
|
|
923
|
+
|
|
924
|
+
- **Content-Type**: Not defined
|
|
925
|
+
- **Accept**: application/json
|
|
926
|
+
|
|
927
|
+
|
|
357
928
|
## list_workspaces
|
|
358
929
|
|
|
359
930
|
> <ListWorkspaces200Response> list_workspaces(opts)
|
|
@@ -377,7 +948,8 @@ api_instance = PostBoost::WorkspacesApi.new
|
|
|
377
948
|
opts = {
|
|
378
949
|
keyword: 'keyword_example', # String |
|
|
379
950
|
subscription_status: 'active', # String |
|
|
380
|
-
access_status: 'subscription' # String |
|
|
951
|
+
access_status: 'subscription', # String |
|
|
952
|
+
page: 56 # Integer | Page number (15 items per page).
|
|
381
953
|
}
|
|
382
954
|
|
|
383
955
|
begin
|
|
@@ -414,6 +986,7 @@ end
|
|
|
414
986
|
| **keyword** | **String** | | [optional] |
|
|
415
987
|
| **subscription_status** | **String** | | [optional] |
|
|
416
988
|
| **access_status** | **String** | | [optional] |
|
|
989
|
+
| **page** | **Integer** | Page number (15 items per page). | [optional][default to 1] |
|
|
417
990
|
|
|
418
991
|
### Return type
|
|
419
992
|
|
|
@@ -435,6 +1008,8 @@ end
|
|
|
435
1008
|
|
|
436
1009
|
Remove user from workspace
|
|
437
1010
|
|
|
1011
|
+
Removes a user's access to the workspace. The user account is not deleted. Admin only.
|
|
1012
|
+
|
|
438
1013
|
### Examples
|
|
439
1014
|
|
|
440
1015
|
```ruby
|
|
@@ -504,6 +1079,8 @@ end
|
|
|
504
1079
|
|
|
505
1080
|
Update workspace
|
|
506
1081
|
|
|
1082
|
+
Updates a workspace's name, owner, or access status. Admin only. `hex_color` is accepted but ignored.
|
|
1083
|
+
|
|
507
1084
|
### Examples
|
|
508
1085
|
|
|
509
1086
|
```ruby
|
|
@@ -517,7 +1094,7 @@ end
|
|
|
517
1094
|
|
|
518
1095
|
api_instance = PostBoost::WorkspacesApi.new
|
|
519
1096
|
workspace_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the workspace.
|
|
520
|
-
workspace_input = PostBoost::WorkspaceInput.new({name: 'name_example',
|
|
1097
|
+
workspace_input = PostBoost::WorkspaceInput.new({name: 'name_example', access_status: 'subscription'}) # WorkspaceInput |
|
|
521
1098
|
|
|
522
1099
|
begin
|
|
523
1100
|
# Update workspace
|
|
@@ -573,6 +1150,8 @@ end
|
|
|
573
1150
|
|
|
574
1151
|
Update user role in workspace
|
|
575
1152
|
|
|
1153
|
+
Changes a user's role or permissions within the workspace. Admin only.
|
|
1154
|
+
|
|
576
1155
|
### Examples
|
|
577
1156
|
|
|
578
1157
|
```ruby
|
data/docs/XUsage.md
ADDED
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# PostBoost::XUsage
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **period_start** | **Time** | | |
|
|
8
|
+
| **period_end** | **Time** | | |
|
|
9
|
+
| **enforced** | **Boolean** | Whether an allowance applies to this workspace. | |
|
|
10
|
+
| **posts** | [**XUsageCounter**](XUsageCounter.md) | | |
|
|
11
|
+
| **link_posts** | [**XUsageCounter**](XUsageCounter.md) | | |
|
|
12
|
+
| **estimated_cost_usd** | **Float** | PostBoost's estimate of what X charged for these posts. Informational; you are not billed per post. | |
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```ruby
|
|
17
|
+
require 'postboost'
|
|
18
|
+
|
|
19
|
+
instance = PostBoost::XUsage.new(
|
|
20
|
+
period_start: null,
|
|
21
|
+
period_end: null,
|
|
22
|
+
enforced: null,
|
|
23
|
+
posts: null,
|
|
24
|
+
link_posts: null,
|
|
25
|
+
estimated_cost_usd: null
|
|
26
|
+
)
|
|
27
|
+
```
|
|
28
|
+
|