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/MediaApi.md
CHANGED
|
@@ -6,15 +6,20 @@ All URIs are relative to *https://postboost.co/app/api*
|
|
|
6
6
|
| ------ | ------------ | ----------- |
|
|
7
7
|
| [**abort_chunked_upload**](MediaApi.md#abort_chunked_upload) | **DELETE** /{workspaceUuid}/media/chunked/{uploadUuid} | Abort chunked upload |
|
|
8
8
|
| [**complete_chunked_upload**](MediaApi.md#complete_chunked_upload) | **POST** /{workspaceUuid}/media/chunked/{uploadUuid}/complete | Complete chunked upload |
|
|
9
|
+
| [**create_media_folder**](MediaApi.md#create_media_folder) | **POST** /{workspaceUuid}/media/folders | Create media folder |
|
|
9
10
|
| [**delete_media_bulk**](MediaApi.md#delete_media_bulk) | **DELETE** /{workspaceUuid}/media | Delete media (bulk) |
|
|
11
|
+
| [**delete_media_folder**](MediaApi.md#delete_media_folder) | **DELETE** /{workspaceUuid}/media/folders/{folderUuid} | Delete media folder |
|
|
10
12
|
| [**get_media**](MediaApi.md#get_media) | **GET** /{workspaceUuid}/media/{mediaUuid} | Get media |
|
|
11
13
|
| [**get_remote_upload_status**](MediaApi.md#get_remote_upload_status) | **GET** /{workspaceUuid}/media/remote/{downloadId}/status | Get remote upload status |
|
|
12
14
|
| [**initiate_chunked_upload**](MediaApi.md#initiate_chunked_upload) | **POST** /{workspaceUuid}/media/chunked/initiate | Initiate chunked upload |
|
|
13
15
|
| [**initiate_remote_upload**](MediaApi.md#initiate_remote_upload) | **POST** /{workspaceUuid}/media/remote/initiate | Initiate remote upload |
|
|
14
16
|
| [**list_media**](MediaApi.md#list_media) | **GET** /{workspaceUuid}/media | List media |
|
|
17
|
+
| [**list_media_folders**](MediaApi.md#list_media_folders) | **GET** /{workspaceUuid}/media/folders | List media folders |
|
|
15
18
|
| [**update_media**](MediaApi.md#update_media) | **PUT** /{workspaceUuid}/media/{mediaUuid} | Update media |
|
|
19
|
+
| [**update_media_folder**](MediaApi.md#update_media_folder) | **PUT** /{workspaceUuid}/media/folders/{folderUuid} | Update media folder |
|
|
16
20
|
| [**upload_chunk**](MediaApi.md#upload_chunk) | **POST** /{workspaceUuid}/media/chunked/{uploadUuid}/upload | Upload a chunk |
|
|
17
21
|
| [**upload_media**](MediaApi.md#upload_media) | **POST** /{workspaceUuid}/media | Upload media (binary) |
|
|
22
|
+
| [**upload_media_base64**](MediaApi.md#upload_media_base64) | **POST** /{workspaceUuid}/media/base64 | Upload media (base64 JSON) |
|
|
18
23
|
|
|
19
24
|
|
|
20
25
|
## abort_chunked_upload
|
|
@@ -89,11 +94,11 @@ nil (empty response body)
|
|
|
89
94
|
|
|
90
95
|
## complete_chunked_upload
|
|
91
96
|
|
|
92
|
-
> <Media> complete_chunked_upload(workspace_uuid, upload_uuid)
|
|
97
|
+
> <Media> complete_chunked_upload(workspace_uuid, upload_uuid, opts)
|
|
93
98
|
|
|
94
99
|
Complete chunked upload
|
|
95
100
|
|
|
96
|
-
Signal that all chunks have been uploaded. Returns the final media object.
|
|
101
|
+
Signal that all chunks have been uploaded. Returns the final media object. A video may come back with `is_processing` set to `true` while its conversion runs.
|
|
97
102
|
|
|
98
103
|
### Examples
|
|
99
104
|
|
|
@@ -109,10 +114,13 @@ end
|
|
|
109
114
|
api_instance = PostBoost::MediaApi.new
|
|
110
115
|
workspace_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the workspace.
|
|
111
116
|
upload_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
|
117
|
+
opts = {
|
|
118
|
+
complete_chunked_upload_request: PostBoost::CompleteChunkedUploadRequest.new # CompleteChunkedUploadRequest |
|
|
119
|
+
}
|
|
112
120
|
|
|
113
121
|
begin
|
|
114
122
|
# Complete chunked upload
|
|
115
|
-
result = api_instance.complete_chunked_upload(workspace_uuid, upload_uuid)
|
|
123
|
+
result = api_instance.complete_chunked_upload(workspace_uuid, upload_uuid, opts)
|
|
116
124
|
p result
|
|
117
125
|
rescue PostBoost::ApiError => e
|
|
118
126
|
puts "Error when calling MediaApi->complete_chunked_upload: #{e}"
|
|
@@ -123,12 +131,12 @@ end
|
|
|
123
131
|
|
|
124
132
|
This returns an Array which contains the response data, status code and headers.
|
|
125
133
|
|
|
126
|
-
> <Array(<Media>, Integer, Hash)> complete_chunked_upload_with_http_info(workspace_uuid, upload_uuid)
|
|
134
|
+
> <Array(<Media>, Integer, Hash)> complete_chunked_upload_with_http_info(workspace_uuid, upload_uuid, opts)
|
|
127
135
|
|
|
128
136
|
```ruby
|
|
129
137
|
begin
|
|
130
138
|
# Complete chunked upload
|
|
131
|
-
data, status_code, headers = api_instance.complete_chunked_upload_with_http_info(workspace_uuid, upload_uuid)
|
|
139
|
+
data, status_code, headers = api_instance.complete_chunked_upload_with_http_info(workspace_uuid, upload_uuid, opts)
|
|
132
140
|
p status_code # => 2xx
|
|
133
141
|
p headers # => { ... }
|
|
134
142
|
p data # => <Media>
|
|
@@ -143,6 +151,7 @@ end
|
|
|
143
151
|
| ---- | ---- | ----------- | ----- |
|
|
144
152
|
| **workspace_uuid** | **String** | UUID of the workspace. | |
|
|
145
153
|
| **upload_uuid** | **String** | | |
|
|
154
|
+
| **complete_chunked_upload_request** | [**CompleteChunkedUploadRequest**](CompleteChunkedUploadRequest.md) | | [optional] |
|
|
146
155
|
|
|
147
156
|
### Return type
|
|
148
157
|
|
|
@@ -154,7 +163,82 @@ end
|
|
|
154
163
|
|
|
155
164
|
### HTTP request headers
|
|
156
165
|
|
|
157
|
-
- **Content-Type**:
|
|
166
|
+
- **Content-Type**: application/json
|
|
167
|
+
- **Accept**: application/json
|
|
168
|
+
|
|
169
|
+
|
|
170
|
+
## create_media_folder
|
|
171
|
+
|
|
172
|
+
> <MediaFolder> create_media_folder(workspace_uuid, create_media_folder_request, opts)
|
|
173
|
+
|
|
174
|
+
Create media folder
|
|
175
|
+
|
|
176
|
+
Creates a folder at the top level or under `parent`. The name must be unique among its siblings.
|
|
177
|
+
|
|
178
|
+
### Examples
|
|
179
|
+
|
|
180
|
+
```ruby
|
|
181
|
+
require 'time'
|
|
182
|
+
require 'postboost'
|
|
183
|
+
# setup authorization
|
|
184
|
+
PostBoost.configure do |config|
|
|
185
|
+
# Configure Bearer authorization: bearerAuth
|
|
186
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
187
|
+
end
|
|
188
|
+
|
|
189
|
+
api_instance = PostBoost::MediaApi.new
|
|
190
|
+
workspace_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the workspace.
|
|
191
|
+
create_media_folder_request = PostBoost::CreateMediaFolderRequest.new({name: 'name_example'}) # CreateMediaFolderRequest |
|
|
192
|
+
opts = {
|
|
193
|
+
idempotency_key: 'idempotency_key_example' # String | Unique key (for example a UUID) that makes the request safe to retry. A repeat with the same key and body within 24 hours returns the stored response with `Idempotent-Replayed: true` and has no further effect. Keys are scoped to your user, the workspace, the method and the path.
|
|
194
|
+
}
|
|
195
|
+
|
|
196
|
+
begin
|
|
197
|
+
# Create media folder
|
|
198
|
+
result = api_instance.create_media_folder(workspace_uuid, create_media_folder_request, opts)
|
|
199
|
+
p result
|
|
200
|
+
rescue PostBoost::ApiError => e
|
|
201
|
+
puts "Error when calling MediaApi->create_media_folder: #{e}"
|
|
202
|
+
end
|
|
203
|
+
```
|
|
204
|
+
|
|
205
|
+
#### Using the create_media_folder_with_http_info variant
|
|
206
|
+
|
|
207
|
+
This returns an Array which contains the response data, status code and headers.
|
|
208
|
+
|
|
209
|
+
> <Array(<MediaFolder>, Integer, Hash)> create_media_folder_with_http_info(workspace_uuid, create_media_folder_request, opts)
|
|
210
|
+
|
|
211
|
+
```ruby
|
|
212
|
+
begin
|
|
213
|
+
# Create media folder
|
|
214
|
+
data, status_code, headers = api_instance.create_media_folder_with_http_info(workspace_uuid, create_media_folder_request, opts)
|
|
215
|
+
p status_code # => 2xx
|
|
216
|
+
p headers # => { ... }
|
|
217
|
+
p data # => <MediaFolder>
|
|
218
|
+
rescue PostBoost::ApiError => e
|
|
219
|
+
puts "Error when calling MediaApi->create_media_folder_with_http_info: #{e}"
|
|
220
|
+
end
|
|
221
|
+
```
|
|
222
|
+
|
|
223
|
+
### Parameters
|
|
224
|
+
|
|
225
|
+
| Name | Type | Description | Notes |
|
|
226
|
+
| ---- | ---- | ----------- | ----- |
|
|
227
|
+
| **workspace_uuid** | **String** | UUID of the workspace. | |
|
|
228
|
+
| **create_media_folder_request** | [**CreateMediaFolderRequest**](CreateMediaFolderRequest.md) | | |
|
|
229
|
+
| **idempotency_key** | **String** | Unique key (for example a UUID) that makes the request safe to retry. A repeat with the same key and body within 24 hours returns the stored response with `Idempotent-Replayed: true` and has no further effect. Keys are scoped to your user, the workspace, the method and the path. | [optional] |
|
|
230
|
+
|
|
231
|
+
### Return type
|
|
232
|
+
|
|
233
|
+
[**MediaFolder**](MediaFolder.md)
|
|
234
|
+
|
|
235
|
+
### Authorization
|
|
236
|
+
|
|
237
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
238
|
+
|
|
239
|
+
### HTTP request headers
|
|
240
|
+
|
|
241
|
+
- **Content-Type**: application/json
|
|
158
242
|
- **Accept**: application/json
|
|
159
243
|
|
|
160
244
|
|
|
@@ -164,7 +248,7 @@ end
|
|
|
164
248
|
|
|
165
249
|
Delete media (bulk)
|
|
166
250
|
|
|
167
|
-
Delete one or more media items by their IDs.
|
|
251
|
+
Delete one or more media items by their numeric IDs or UUIDs (both may be mixed, up to 500 per request).
|
|
168
252
|
|
|
169
253
|
### Examples
|
|
170
254
|
|
|
@@ -179,7 +263,7 @@ end
|
|
|
179
263
|
|
|
180
264
|
api_instance = PostBoost::MediaApi.new
|
|
181
265
|
workspace_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the workspace.
|
|
182
|
-
delete_media_bulk_request = PostBoost::DeleteMediaBulkRequest.new({items: [
|
|
266
|
+
delete_media_bulk_request = PostBoost::DeleteMediaBulkRequest.new({items: [nil]}) # DeleteMediaBulkRequest |
|
|
183
267
|
|
|
184
268
|
begin
|
|
185
269
|
# Delete media (bulk)
|
|
@@ -229,6 +313,81 @@ end
|
|
|
229
313
|
- **Accept**: application/json
|
|
230
314
|
|
|
231
315
|
|
|
316
|
+
## delete_media_folder
|
|
317
|
+
|
|
318
|
+
> Object delete_media_folder(workspace_uuid, folder_uuid, opts)
|
|
319
|
+
|
|
320
|
+
Delete media folder
|
|
321
|
+
|
|
322
|
+
Deletes a folder. By default its media and sub-folders move up to the folder's parent; with `delete_media` set to true every media item below the folder is deleted as well.
|
|
323
|
+
|
|
324
|
+
### Examples
|
|
325
|
+
|
|
326
|
+
```ruby
|
|
327
|
+
require 'time'
|
|
328
|
+
require 'postboost'
|
|
329
|
+
# setup authorization
|
|
330
|
+
PostBoost.configure do |config|
|
|
331
|
+
# Configure Bearer authorization: bearerAuth
|
|
332
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
333
|
+
end
|
|
334
|
+
|
|
335
|
+
api_instance = PostBoost::MediaApi.new
|
|
336
|
+
workspace_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the workspace.
|
|
337
|
+
folder_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the media folder.
|
|
338
|
+
opts = {
|
|
339
|
+
delete_media_folder_request: PostBoost::DeleteMediaFolderRequest.new # DeleteMediaFolderRequest |
|
|
340
|
+
}
|
|
341
|
+
|
|
342
|
+
begin
|
|
343
|
+
# Delete media folder
|
|
344
|
+
result = api_instance.delete_media_folder(workspace_uuid, folder_uuid, opts)
|
|
345
|
+
p result
|
|
346
|
+
rescue PostBoost::ApiError => e
|
|
347
|
+
puts "Error when calling MediaApi->delete_media_folder: #{e}"
|
|
348
|
+
end
|
|
349
|
+
```
|
|
350
|
+
|
|
351
|
+
#### Using the delete_media_folder_with_http_info variant
|
|
352
|
+
|
|
353
|
+
This returns an Array which contains the response data, status code and headers.
|
|
354
|
+
|
|
355
|
+
> <Array(Object, Integer, Hash)> delete_media_folder_with_http_info(workspace_uuid, folder_uuid, opts)
|
|
356
|
+
|
|
357
|
+
```ruby
|
|
358
|
+
begin
|
|
359
|
+
# Delete media folder
|
|
360
|
+
data, status_code, headers = api_instance.delete_media_folder_with_http_info(workspace_uuid, folder_uuid, opts)
|
|
361
|
+
p status_code # => 2xx
|
|
362
|
+
p headers # => { ... }
|
|
363
|
+
p data # => Object
|
|
364
|
+
rescue PostBoost::ApiError => e
|
|
365
|
+
puts "Error when calling MediaApi->delete_media_folder_with_http_info: #{e}"
|
|
366
|
+
end
|
|
367
|
+
```
|
|
368
|
+
|
|
369
|
+
### Parameters
|
|
370
|
+
|
|
371
|
+
| Name | Type | Description | Notes |
|
|
372
|
+
| ---- | ---- | ----------- | ----- |
|
|
373
|
+
| **workspace_uuid** | **String** | UUID of the workspace. | |
|
|
374
|
+
| **folder_uuid** | **String** | UUID of the media folder. | |
|
|
375
|
+
| **delete_media_folder_request** | [**DeleteMediaFolderRequest**](DeleteMediaFolderRequest.md) | | [optional] |
|
|
376
|
+
|
|
377
|
+
### Return type
|
|
378
|
+
|
|
379
|
+
**Object**
|
|
380
|
+
|
|
381
|
+
### Authorization
|
|
382
|
+
|
|
383
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
384
|
+
|
|
385
|
+
### HTTP request headers
|
|
386
|
+
|
|
387
|
+
- **Content-Type**: application/json
|
|
388
|
+
- **Accept**: application/json
|
|
389
|
+
|
|
390
|
+
|
|
232
391
|
## get_media
|
|
233
392
|
|
|
234
393
|
> <Media> get_media(workspace_uuid, media_uuid)
|
|
@@ -373,7 +532,7 @@ end
|
|
|
373
532
|
|
|
374
533
|
## initiate_chunked_upload
|
|
375
534
|
|
|
376
|
-
> <
|
|
535
|
+
> <InitiateChunkedUpload201Response> initiate_chunked_upload(workspace_uuid, initiate_chunked_upload_request, opts)
|
|
377
536
|
|
|
378
537
|
Initiate chunked upload
|
|
379
538
|
|
|
@@ -393,10 +552,13 @@ end
|
|
|
393
552
|
api_instance = PostBoost::MediaApi.new
|
|
394
553
|
workspace_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the workspace.
|
|
395
554
|
initiate_chunked_upload_request = PostBoost::InitiateChunkedUploadRequest.new({filename: 'filename_example', mime_type: 'video/mp4', total_size: 37}) # InitiateChunkedUploadRequest |
|
|
555
|
+
opts = {
|
|
556
|
+
idempotency_key: 'idempotency_key_example' # String | Unique key (for example a UUID) that makes the request safe to retry. A repeat with the same key and body within 24 hours returns the stored response with `Idempotent-Replayed: true` and has no further effect. Keys are scoped to your user, the workspace, the method and the path.
|
|
557
|
+
}
|
|
396
558
|
|
|
397
559
|
begin
|
|
398
560
|
# Initiate chunked upload
|
|
399
|
-
result = api_instance.initiate_chunked_upload(workspace_uuid, initiate_chunked_upload_request)
|
|
561
|
+
result = api_instance.initiate_chunked_upload(workspace_uuid, initiate_chunked_upload_request, opts)
|
|
400
562
|
p result
|
|
401
563
|
rescue PostBoost::ApiError => e
|
|
402
564
|
puts "Error when calling MediaApi->initiate_chunked_upload: #{e}"
|
|
@@ -407,15 +569,15 @@ end
|
|
|
407
569
|
|
|
408
570
|
This returns an Array which contains the response data, status code and headers.
|
|
409
571
|
|
|
410
|
-
> <Array(<
|
|
572
|
+
> <Array(<InitiateChunkedUpload201Response>, Integer, Hash)> initiate_chunked_upload_with_http_info(workspace_uuid, initiate_chunked_upload_request, opts)
|
|
411
573
|
|
|
412
574
|
```ruby
|
|
413
575
|
begin
|
|
414
576
|
# Initiate chunked upload
|
|
415
|
-
data, status_code, headers = api_instance.initiate_chunked_upload_with_http_info(workspace_uuid, initiate_chunked_upload_request)
|
|
577
|
+
data, status_code, headers = api_instance.initiate_chunked_upload_with_http_info(workspace_uuid, initiate_chunked_upload_request, opts)
|
|
416
578
|
p status_code # => 2xx
|
|
417
579
|
p headers # => { ... }
|
|
418
|
-
p data # => <
|
|
580
|
+
p data # => <InitiateChunkedUpload201Response>
|
|
419
581
|
rescue PostBoost::ApiError => e
|
|
420
582
|
puts "Error when calling MediaApi->initiate_chunked_upload_with_http_info: #{e}"
|
|
421
583
|
end
|
|
@@ -427,10 +589,11 @@ end
|
|
|
427
589
|
| ---- | ---- | ----------- | ----- |
|
|
428
590
|
| **workspace_uuid** | **String** | UUID of the workspace. | |
|
|
429
591
|
| **initiate_chunked_upload_request** | [**InitiateChunkedUploadRequest**](InitiateChunkedUploadRequest.md) | | |
|
|
592
|
+
| **idempotency_key** | **String** | Unique key (for example a UUID) that makes the request safe to retry. A repeat with the same key and body within 24 hours returns the stored response with `Idempotent-Replayed: true` and has no further effect. Keys are scoped to your user, the workspace, the method and the path. | [optional] |
|
|
430
593
|
|
|
431
594
|
### Return type
|
|
432
595
|
|
|
433
|
-
[**
|
|
596
|
+
[**InitiateChunkedUpload201Response**](InitiateChunkedUpload201Response.md)
|
|
434
597
|
|
|
435
598
|
### Authorization
|
|
436
599
|
|
|
@@ -444,7 +607,7 @@ end
|
|
|
444
607
|
|
|
445
608
|
## initiate_remote_upload
|
|
446
609
|
|
|
447
|
-
> <
|
|
610
|
+
> <InitiateRemoteUpload201Response> initiate_remote_upload(workspace_uuid, initiate_remote_upload_request, opts)
|
|
448
611
|
|
|
449
612
|
Initiate remote upload
|
|
450
613
|
|
|
@@ -464,10 +627,13 @@ end
|
|
|
464
627
|
api_instance = PostBoost::MediaApi.new
|
|
465
628
|
workspace_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the workspace.
|
|
466
629
|
initiate_remote_upload_request = PostBoost::InitiateRemoteUploadRequest.new({url: 'url_example'}) # InitiateRemoteUploadRequest |
|
|
630
|
+
opts = {
|
|
631
|
+
idempotency_key: 'idempotency_key_example' # String | Unique key (for example a UUID) that makes the request safe to retry. A repeat with the same key and body within 24 hours returns the stored response with `Idempotent-Replayed: true` and has no further effect. Keys are scoped to your user, the workspace, the method and the path.
|
|
632
|
+
}
|
|
467
633
|
|
|
468
634
|
begin
|
|
469
635
|
# Initiate remote upload
|
|
470
|
-
result = api_instance.initiate_remote_upload(workspace_uuid, initiate_remote_upload_request)
|
|
636
|
+
result = api_instance.initiate_remote_upload(workspace_uuid, initiate_remote_upload_request, opts)
|
|
471
637
|
p result
|
|
472
638
|
rescue PostBoost::ApiError => e
|
|
473
639
|
puts "Error when calling MediaApi->initiate_remote_upload: #{e}"
|
|
@@ -478,15 +644,15 @@ end
|
|
|
478
644
|
|
|
479
645
|
This returns an Array which contains the response data, status code and headers.
|
|
480
646
|
|
|
481
|
-
> <Array(<
|
|
647
|
+
> <Array(<InitiateRemoteUpload201Response>, Integer, Hash)> initiate_remote_upload_with_http_info(workspace_uuid, initiate_remote_upload_request, opts)
|
|
482
648
|
|
|
483
649
|
```ruby
|
|
484
650
|
begin
|
|
485
651
|
# Initiate remote upload
|
|
486
|
-
data, status_code, headers = api_instance.initiate_remote_upload_with_http_info(workspace_uuid, initiate_remote_upload_request)
|
|
652
|
+
data, status_code, headers = api_instance.initiate_remote_upload_with_http_info(workspace_uuid, initiate_remote_upload_request, opts)
|
|
487
653
|
p status_code # => 2xx
|
|
488
654
|
p headers # => { ... }
|
|
489
|
-
p data # => <
|
|
655
|
+
p data # => <InitiateRemoteUpload201Response>
|
|
490
656
|
rescue PostBoost::ApiError => e
|
|
491
657
|
puts "Error when calling MediaApi->initiate_remote_upload_with_http_info: #{e}"
|
|
492
658
|
end
|
|
@@ -498,10 +664,11 @@ end
|
|
|
498
664
|
| ---- | ---- | ----------- | ----- |
|
|
499
665
|
| **workspace_uuid** | **String** | UUID of the workspace. | |
|
|
500
666
|
| **initiate_remote_upload_request** | [**InitiateRemoteUploadRequest**](InitiateRemoteUploadRequest.md) | | |
|
|
667
|
+
| **idempotency_key** | **String** | Unique key (for example a UUID) that makes the request safe to retry. A repeat with the same key and body within 24 hours returns the stored response with `Idempotent-Replayed: true` and has no further effect. Keys are scoped to your user, the workspace, the method and the path. | [optional] |
|
|
501
668
|
|
|
502
669
|
### Return type
|
|
503
670
|
|
|
504
|
-
[**
|
|
671
|
+
[**InitiateRemoteUpload201Response**](InitiateRemoteUpload201Response.md)
|
|
505
672
|
|
|
506
673
|
### Authorization
|
|
507
674
|
|
|
@@ -519,7 +686,7 @@ end
|
|
|
519
686
|
|
|
520
687
|
List media
|
|
521
688
|
|
|
522
|
-
Returns a paginated list of media assets in the workspace library.
|
|
689
|
+
Returns a paginated list of media assets in the workspace library. Without `folder` every item is listed, whatever folder it is filed in. A `keyword` search always looks at the whole library and ignores `folder` and `favorite`.
|
|
523
690
|
|
|
524
691
|
### Examples
|
|
525
692
|
|
|
@@ -535,7 +702,15 @@ end
|
|
|
535
702
|
api_instance = PostBoost::MediaApi.new
|
|
536
703
|
workspace_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the workspace.
|
|
537
704
|
opts = {
|
|
538
|
-
page: 56 # Integer | Page number
|
|
705
|
+
page: 56, # Integer | Page number.
|
|
706
|
+
limit: 56, # Integer | Items per page. Values below 1 fall back to 50; values above 100 are capped at 100.
|
|
707
|
+
folder: 'folder_example', # String | Media folder UUID, or `root` for items not filed in any folder.
|
|
708
|
+
mime_types: ['inner_example'], # Array<String> | Only these MIME types (for example `image/png`).
|
|
709
|
+
type: 'image', # String | Only this media type.
|
|
710
|
+
keyword: 'keyword_example', # String | Search media by name.
|
|
711
|
+
usage: 'unused', # String | Filter by how the media is used in posts.
|
|
712
|
+
favorite: true, # Boolean | When `true`, only media the caller marked as favorite.
|
|
713
|
+
sort: 'newest' # String |
|
|
539
714
|
}
|
|
540
715
|
|
|
541
716
|
begin
|
|
@@ -570,7 +745,15 @@ end
|
|
|
570
745
|
| Name | Type | Description | Notes |
|
|
571
746
|
| ---- | ---- | ----------- | ----- |
|
|
572
747
|
| **workspace_uuid** | **String** | UUID of the workspace. | |
|
|
573
|
-
| **page** | **Integer** | Page number
|
|
748
|
+
| **page** | **Integer** | Page number. | [optional][default to 1] |
|
|
749
|
+
| **limit** | **Integer** | Items per page. Values below 1 fall back to 50; values above 100 are capped at 100. | [optional][default to 50] |
|
|
750
|
+
| **folder** | **String** | Media folder UUID, or `root` for items not filed in any folder. | [optional] |
|
|
751
|
+
| **mime_types** | [**Array<String>**](String.md) | Only these MIME types (for example `image/png`). | [optional] |
|
|
752
|
+
| **type** | **String** | Only this media type. | [optional] |
|
|
753
|
+
| **keyword** | **String** | Search media by name. | [optional] |
|
|
754
|
+
| **usage** | **String** | Filter by how the media is used in posts. | [optional] |
|
|
755
|
+
| **favorite** | **Boolean** | When `true`, only media the caller marked as favorite. | [optional] |
|
|
756
|
+
| **sort** | **String** | | [optional][default to 'newest'] |
|
|
574
757
|
|
|
575
758
|
### Return type
|
|
576
759
|
|
|
@@ -586,13 +769,82 @@ end
|
|
|
586
769
|
- **Accept**: application/json
|
|
587
770
|
|
|
588
771
|
|
|
772
|
+
## list_media_folders
|
|
773
|
+
|
|
774
|
+
> <ListMediaFolders200Response> list_media_folders(workspace_uuid)
|
|
775
|
+
|
|
776
|
+
List media folders
|
|
777
|
+
|
|
778
|
+
Returns the whole folder tree of the media library in one response (not paginated). Rebuild the tree from each folder's `parent`.
|
|
779
|
+
|
|
780
|
+
### Examples
|
|
781
|
+
|
|
782
|
+
```ruby
|
|
783
|
+
require 'time'
|
|
784
|
+
require 'postboost'
|
|
785
|
+
# setup authorization
|
|
786
|
+
PostBoost.configure do |config|
|
|
787
|
+
# Configure Bearer authorization: bearerAuth
|
|
788
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
789
|
+
end
|
|
790
|
+
|
|
791
|
+
api_instance = PostBoost::MediaApi.new
|
|
792
|
+
workspace_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the workspace.
|
|
793
|
+
|
|
794
|
+
begin
|
|
795
|
+
# List media folders
|
|
796
|
+
result = api_instance.list_media_folders(workspace_uuid)
|
|
797
|
+
p result
|
|
798
|
+
rescue PostBoost::ApiError => e
|
|
799
|
+
puts "Error when calling MediaApi->list_media_folders: #{e}"
|
|
800
|
+
end
|
|
801
|
+
```
|
|
802
|
+
|
|
803
|
+
#### Using the list_media_folders_with_http_info variant
|
|
804
|
+
|
|
805
|
+
This returns an Array which contains the response data, status code and headers.
|
|
806
|
+
|
|
807
|
+
> <Array(<ListMediaFolders200Response>, Integer, Hash)> list_media_folders_with_http_info(workspace_uuid)
|
|
808
|
+
|
|
809
|
+
```ruby
|
|
810
|
+
begin
|
|
811
|
+
# List media folders
|
|
812
|
+
data, status_code, headers = api_instance.list_media_folders_with_http_info(workspace_uuid)
|
|
813
|
+
p status_code # => 2xx
|
|
814
|
+
p headers # => { ... }
|
|
815
|
+
p data # => <ListMediaFolders200Response>
|
|
816
|
+
rescue PostBoost::ApiError => e
|
|
817
|
+
puts "Error when calling MediaApi->list_media_folders_with_http_info: #{e}"
|
|
818
|
+
end
|
|
819
|
+
```
|
|
820
|
+
|
|
821
|
+
### Parameters
|
|
822
|
+
|
|
823
|
+
| Name | Type | Description | Notes |
|
|
824
|
+
| ---- | ---- | ----------- | ----- |
|
|
825
|
+
| **workspace_uuid** | **String** | UUID of the workspace. | |
|
|
826
|
+
|
|
827
|
+
### Return type
|
|
828
|
+
|
|
829
|
+
[**ListMediaFolders200Response**](ListMediaFolders200Response.md)
|
|
830
|
+
|
|
831
|
+
### Authorization
|
|
832
|
+
|
|
833
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
834
|
+
|
|
835
|
+
### HTTP request headers
|
|
836
|
+
|
|
837
|
+
- **Content-Type**: Not defined
|
|
838
|
+
- **Accept**: application/json
|
|
839
|
+
|
|
840
|
+
|
|
589
841
|
## update_media
|
|
590
842
|
|
|
591
843
|
> Object update_media(workspace_uuid, media_uuid, update_media_request)
|
|
592
844
|
|
|
593
845
|
Update media
|
|
594
846
|
|
|
595
|
-
Update the alt text of a media asset.
|
|
847
|
+
Update the name, alt text, or folder of a media asset. Only the keys present in the body are written. Sending `folder: null` moves the item to the library root; omitting `folder` leaves it where it is.
|
|
596
848
|
|
|
597
849
|
### Examples
|
|
598
850
|
|
|
@@ -608,7 +860,7 @@ end
|
|
|
608
860
|
api_instance = PostBoost::MediaApi.new
|
|
609
861
|
workspace_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the workspace.
|
|
610
862
|
media_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the media asset.
|
|
611
|
-
update_media_request = PostBoost::UpdateMediaRequest.new
|
|
863
|
+
update_media_request = PostBoost::UpdateMediaRequest.new # UpdateMediaRequest |
|
|
612
864
|
|
|
613
865
|
begin
|
|
614
866
|
# Update media
|
|
@@ -659,9 +911,82 @@ end
|
|
|
659
911
|
- **Accept**: application/json
|
|
660
912
|
|
|
661
913
|
|
|
914
|
+
## update_media_folder
|
|
915
|
+
|
|
916
|
+
> <MediaFolder> update_media_folder(workspace_uuid, folder_uuid, media_folder_input)
|
|
917
|
+
|
|
918
|
+
Update media folder
|
|
919
|
+
|
|
920
|
+
Renames a folder and/or moves it. Sending `parent` moves the folder (null = top level); omitting it keeps the current parent. A folder cannot be moved into itself or one of its descendants.
|
|
921
|
+
|
|
922
|
+
### Examples
|
|
923
|
+
|
|
924
|
+
```ruby
|
|
925
|
+
require 'time'
|
|
926
|
+
require 'postboost'
|
|
927
|
+
# setup authorization
|
|
928
|
+
PostBoost.configure do |config|
|
|
929
|
+
# Configure Bearer authorization: bearerAuth
|
|
930
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
931
|
+
end
|
|
932
|
+
|
|
933
|
+
api_instance = PostBoost::MediaApi.new
|
|
934
|
+
workspace_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the workspace.
|
|
935
|
+
folder_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the media folder.
|
|
936
|
+
media_folder_input = PostBoost::MediaFolderInput.new # MediaFolderInput |
|
|
937
|
+
|
|
938
|
+
begin
|
|
939
|
+
# Update media folder
|
|
940
|
+
result = api_instance.update_media_folder(workspace_uuid, folder_uuid, media_folder_input)
|
|
941
|
+
p result
|
|
942
|
+
rescue PostBoost::ApiError => e
|
|
943
|
+
puts "Error when calling MediaApi->update_media_folder: #{e}"
|
|
944
|
+
end
|
|
945
|
+
```
|
|
946
|
+
|
|
947
|
+
#### Using the update_media_folder_with_http_info variant
|
|
948
|
+
|
|
949
|
+
This returns an Array which contains the response data, status code and headers.
|
|
950
|
+
|
|
951
|
+
> <Array(<MediaFolder>, Integer, Hash)> update_media_folder_with_http_info(workspace_uuid, folder_uuid, media_folder_input)
|
|
952
|
+
|
|
953
|
+
```ruby
|
|
954
|
+
begin
|
|
955
|
+
# Update media folder
|
|
956
|
+
data, status_code, headers = api_instance.update_media_folder_with_http_info(workspace_uuid, folder_uuid, media_folder_input)
|
|
957
|
+
p status_code # => 2xx
|
|
958
|
+
p headers # => { ... }
|
|
959
|
+
p data # => <MediaFolder>
|
|
960
|
+
rescue PostBoost::ApiError => e
|
|
961
|
+
puts "Error when calling MediaApi->update_media_folder_with_http_info: #{e}"
|
|
962
|
+
end
|
|
963
|
+
```
|
|
964
|
+
|
|
965
|
+
### Parameters
|
|
966
|
+
|
|
967
|
+
| Name | Type | Description | Notes |
|
|
968
|
+
| ---- | ---- | ----------- | ----- |
|
|
969
|
+
| **workspace_uuid** | **String** | UUID of the workspace. | |
|
|
970
|
+
| **folder_uuid** | **String** | UUID of the media folder. | |
|
|
971
|
+
| **media_folder_input** | [**MediaFolderInput**](MediaFolderInput.md) | | |
|
|
972
|
+
|
|
973
|
+
### Return type
|
|
974
|
+
|
|
975
|
+
[**MediaFolder**](MediaFolder.md)
|
|
976
|
+
|
|
977
|
+
### Authorization
|
|
978
|
+
|
|
979
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
980
|
+
|
|
981
|
+
### HTTP request headers
|
|
982
|
+
|
|
983
|
+
- **Content-Type**: application/json
|
|
984
|
+
- **Accept**: application/json
|
|
985
|
+
|
|
986
|
+
|
|
662
987
|
## upload_chunk
|
|
663
988
|
|
|
664
|
-
> <
|
|
989
|
+
> <UploadChunk201Response> upload_chunk(workspace_uuid, upload_uuid, chunk, chunk_index)
|
|
665
990
|
|
|
666
991
|
Upload a chunk
|
|
667
992
|
|
|
@@ -697,7 +1022,7 @@ end
|
|
|
697
1022
|
|
|
698
1023
|
This returns an Array which contains the response data, status code and headers.
|
|
699
1024
|
|
|
700
|
-
> <Array(<
|
|
1025
|
+
> <Array(<UploadChunk201Response>, Integer, Hash)> upload_chunk_with_http_info(workspace_uuid, upload_uuid, chunk, chunk_index)
|
|
701
1026
|
|
|
702
1027
|
```ruby
|
|
703
1028
|
begin
|
|
@@ -705,7 +1030,7 @@ begin
|
|
|
705
1030
|
data, status_code, headers = api_instance.upload_chunk_with_http_info(workspace_uuid, upload_uuid, chunk, chunk_index)
|
|
706
1031
|
p status_code # => 2xx
|
|
707
1032
|
p headers # => { ... }
|
|
708
|
-
p data # => <
|
|
1033
|
+
p data # => <UploadChunk201Response>
|
|
709
1034
|
rescue PostBoost::ApiError => e
|
|
710
1035
|
puts "Error when calling MediaApi->upload_chunk_with_http_info: #{e}"
|
|
711
1036
|
end
|
|
@@ -722,7 +1047,7 @@ end
|
|
|
722
1047
|
|
|
723
1048
|
### Return type
|
|
724
1049
|
|
|
725
|
-
[**
|
|
1050
|
+
[**UploadChunk201Response**](UploadChunk201Response.md)
|
|
726
1051
|
|
|
727
1052
|
### Authorization
|
|
728
1053
|
|
|
@@ -740,7 +1065,7 @@ end
|
|
|
740
1065
|
|
|
741
1066
|
Upload media (binary)
|
|
742
1067
|
|
|
743
|
-
Upload a file directly as multipart form data.
|
|
1068
|
+
Upload a file directly as multipart form data. Images and videos, plus a PDF (up to 100 MB) for LinkedIn document posts: a post that attaches a PDF must have it as the only media item and may only go to LinkedIn profiles and pages.
|
|
744
1069
|
|
|
745
1070
|
### Examples
|
|
746
1071
|
|
|
@@ -757,7 +1082,9 @@ api_instance = PostBoost::MediaApi.new
|
|
|
757
1082
|
workspace_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the workspace.
|
|
758
1083
|
file = File.new('/path/to/some/file') # File | The file to upload.
|
|
759
1084
|
opts = {
|
|
760
|
-
|
|
1085
|
+
idempotency_key: 'idempotency_key_example', # String | Unique key (for example a UUID) that makes the request safe to retry. A repeat with the same key and body within 24 hours returns the stored response with `Idempotent-Replayed: true` and has no further effect. Keys are scoped to your user, the workspace, the method and the path.
|
|
1086
|
+
alt_text: 'alt_text_example', # String | Alternative text for accessibility.
|
|
1087
|
+
folder: '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the media folder to file the upload in. Omit or null for the library root.
|
|
761
1088
|
}
|
|
762
1089
|
|
|
763
1090
|
begin
|
|
@@ -793,7 +1120,9 @@ end
|
|
|
793
1120
|
| ---- | ---- | ----------- | ----- |
|
|
794
1121
|
| **workspace_uuid** | **String** | UUID of the workspace. | |
|
|
795
1122
|
| **file** | **File** | The file to upload. | |
|
|
1123
|
+
| **idempotency_key** | **String** | Unique key (for example a UUID) that makes the request safe to retry. A repeat with the same key and body within 24 hours returns the stored response with `Idempotent-Replayed: true` and has no further effect. Keys are scoped to your user, the workspace, the method and the path. | [optional] |
|
|
796
1124
|
| **alt_text** | **String** | Alternative text for accessibility. | [optional] |
|
|
1125
|
+
| **folder** | **String** | UUID of the media folder to file the upload in. Omit or null for the library root. | [optional] |
|
|
797
1126
|
|
|
798
1127
|
### Return type
|
|
799
1128
|
|
|
@@ -808,3 +1137,78 @@ end
|
|
|
808
1137
|
- **Content-Type**: multipart/form-data
|
|
809
1138
|
- **Accept**: application/json
|
|
810
1139
|
|
|
1140
|
+
|
|
1141
|
+
## upload_media_base64
|
|
1142
|
+
|
|
1143
|
+
> <Media> upload_media_base64(workspace_uuid, media_base64_input, opts)
|
|
1144
|
+
|
|
1145
|
+
Upload media (base64 JSON)
|
|
1146
|
+
|
|
1147
|
+
Upload a file as base64 inside a JSON body, for agents and tools that cannot send multipart form data. The decoded file is checked exactly like `POST media` (allowed types and size limits; a PDF is accepted for LinkedIn document posts). Decoded size is capped at 20 MB; for larger files use remote upload by URL or chunked upload.
|
|
1148
|
+
|
|
1149
|
+
### Examples
|
|
1150
|
+
|
|
1151
|
+
```ruby
|
|
1152
|
+
require 'time'
|
|
1153
|
+
require 'postboost'
|
|
1154
|
+
# setup authorization
|
|
1155
|
+
PostBoost.configure do |config|
|
|
1156
|
+
# Configure Bearer authorization: bearerAuth
|
|
1157
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1158
|
+
end
|
|
1159
|
+
|
|
1160
|
+
api_instance = PostBoost::MediaApi.new
|
|
1161
|
+
workspace_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the workspace.
|
|
1162
|
+
media_base64_input = PostBoost::MediaBase64Input.new({content: 'content_example', filename: 'cover.png'}) # MediaBase64Input |
|
|
1163
|
+
opts = {
|
|
1164
|
+
idempotency_key: 'idempotency_key_example' # String | Unique key (for example a UUID) that makes the request safe to retry. A repeat with the same key and body within 24 hours returns the stored response with `Idempotent-Replayed: true` and has no further effect. Keys are scoped to your user, the workspace, the method and the path.
|
|
1165
|
+
}
|
|
1166
|
+
|
|
1167
|
+
begin
|
|
1168
|
+
# Upload media (base64 JSON)
|
|
1169
|
+
result = api_instance.upload_media_base64(workspace_uuid, media_base64_input, opts)
|
|
1170
|
+
p result
|
|
1171
|
+
rescue PostBoost::ApiError => e
|
|
1172
|
+
puts "Error when calling MediaApi->upload_media_base64: #{e}"
|
|
1173
|
+
end
|
|
1174
|
+
```
|
|
1175
|
+
|
|
1176
|
+
#### Using the upload_media_base64_with_http_info variant
|
|
1177
|
+
|
|
1178
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1179
|
+
|
|
1180
|
+
> <Array(<Media>, Integer, Hash)> upload_media_base64_with_http_info(workspace_uuid, media_base64_input, opts)
|
|
1181
|
+
|
|
1182
|
+
```ruby
|
|
1183
|
+
begin
|
|
1184
|
+
# Upload media (base64 JSON)
|
|
1185
|
+
data, status_code, headers = api_instance.upload_media_base64_with_http_info(workspace_uuid, media_base64_input, opts)
|
|
1186
|
+
p status_code # => 2xx
|
|
1187
|
+
p headers # => { ... }
|
|
1188
|
+
p data # => <Media>
|
|
1189
|
+
rescue PostBoost::ApiError => e
|
|
1190
|
+
puts "Error when calling MediaApi->upload_media_base64_with_http_info: #{e}"
|
|
1191
|
+
end
|
|
1192
|
+
```
|
|
1193
|
+
|
|
1194
|
+
### Parameters
|
|
1195
|
+
|
|
1196
|
+
| Name | Type | Description | Notes |
|
|
1197
|
+
| ---- | ---- | ----------- | ----- |
|
|
1198
|
+
| **workspace_uuid** | **String** | UUID of the workspace. | |
|
|
1199
|
+
| **media_base64_input** | [**MediaBase64Input**](MediaBase64Input.md) | | |
|
|
1200
|
+
| **idempotency_key** | **String** | Unique key (for example a UUID) that makes the request safe to retry. A repeat with the same key and body within 24 hours returns the stored response with `Idempotent-Replayed: true` and has no further effect. Keys are scoped to your user, the workspace, the method and the path. | [optional] |
|
|
1201
|
+
|
|
1202
|
+
### Return type
|
|
1203
|
+
|
|
1204
|
+
[**Media**](Media.md)
|
|
1205
|
+
|
|
1206
|
+
### Authorization
|
|
1207
|
+
|
|
1208
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1209
|
+
|
|
1210
|
+
### HTTP request headers
|
|
1211
|
+
|
|
1212
|
+
- **Content-Type**: application/json
|
|
1213
|
+
- **Accept**: application/json
|
|
1214
|
+
|