postboost 1.0.0 → 1.8.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/README.md +119 -0
- data/docs/AIApi.md +439 -0
- data/docs/AICredits.md +22 -0
- data/docs/Account.md +14 -8
- data/docs/AccountAnalytics.md +28 -0
- data/docs/AccountAnalyticsInitialSync.md +20 -0
- data/docs/AccountSchedule.md +22 -0
- data/docs/AccountsApi.md +15 -5
- data/docs/AddPostToQueueRequest.md +18 -0
- data/docs/AnalyticsApi.md +401 -0
- data/docs/AnalyticsPeriod.md +24 -0
- data/docs/AnalyticsSummary.md +20 -0
- data/docs/AnalyticsSummaryData.md +38 -0
- data/docs/ApprovePostRequest.md +24 -0
- data/docs/BestPostingTimes.md +20 -0
- data/docs/BestPostingTimesTimesInner.md +24 -0
- data/docs/BlogToSocial200Response.md +18 -0
- data/docs/BlogToSocial429Response.md +18 -0
- data/docs/BlogToSocialCaption.md +28 -0
- data/docs/BlogToSocialInput.md +42 -0
- data/docs/BlogToSocialMedia.md +20 -0
- data/docs/BlogToSocialResponse.md +30 -0
- data/docs/CancelSubscription422Response.md +20 -0
- data/docs/CancelSubscription422ResponseErrors.md +18 -0
- data/docs/CancelSubscriptionRequest.md +18 -0
- data/docs/CompleteChunkedUploadRequest.md +20 -0
- data/docs/CreateMediaFolderRequest.md +20 -0
- data/docs/CreateMention201Response.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/ImageAltText200Response.md +18 -0
- data/docs/ImageAltTextInput.md +18 -0
- data/docs/ImageAltTextResponse.md +24 -0
- data/docs/ImageEditInput.md +28 -0
- data/docs/ImageGenerate200Response.md +18 -0
- data/docs/ImageGenerate429Response.md +18 -0
- data/docs/ImageGenerateInput.md +36 -0
- data/docs/ImageGenerationResponse.md +30 -0
- data/docs/ImagePrompt200Response.md +18 -0
- data/docs/ImagePrompt429Response.md +18 -0
- data/docs/ImagePromptInput.md +28 -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/{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/ListMediaFolders200Response.md +18 -0
- data/docs/ListMentions200Response.md +22 -0
- data/docs/ListMyWorkspaces200Response.md +18 -0
- data/docs/Media.md +22 -8
- data/docs/MediaApi.md +340 -26
- 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 +375 -0
- data/docs/Post.md +10 -8
- data/docs/PostAnalytics.md +22 -0
- data/docs/PostInput.md +3 -1
- data/docs/PostVersion.md +2 -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 +174 -14
- data/docs/PublicWorkspace.md +24 -0
- data/docs/PublicWorkspacePivot.md +22 -0
- data/docs/PublishProgress.md +22 -0
- data/docs/Receipt.md +8 -8
- data/docs/ReceiptsApi.md +15 -1
- data/docs/RemoveGenericSubscription422Response.md +18 -0
- data/docs/RetryPostAccountResult.md +22 -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 +10 -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/Workspace.md +8 -6
- data/docs/WorkspaceInput.md +1 -1
- data/docs/WorkspacesApi.md +156 -3
- data/lib/postboost/api/accounts_api.rb +16 -4
- data/lib/postboost/api/ai_api.rb +466 -0
- data/lib/postboost/api/analytics_api.rb +425 -0
- data/lib/postboost/api/media_api.rb +365 -22
- data/lib/postboost/api/mentions_api.rb +386 -0
- data/lib/postboost/api/posts_api.rb +176 -12
- 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 +12 -2
- data/lib/postboost/api/users_api.rb +17 -2
- data/lib/postboost/api/workspaces_api.rb +139 -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 +120 -3
- 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_schedule.rb +255 -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/ai_credits.rb +256 -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/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 +214 -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 +536 -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/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/checkout_subscription200_response.rb +2 -2
- data/lib/postboost/models/checkout_subscription_request.rb +2 -2
- data/lib/postboost/models/complete_chunked_upload_request.rb +243 -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/delete_media_bulk_request.rb +23 -4
- data/lib/postboost/models/{initiate_remote_upload200_response.rb → delete_media_bulk_request_items_inner.rb} +5 -5
- 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_remote_upload_status200_response.rb +2 -2
- 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_edit_input.rb +375 -0
- data/lib/postboost/models/image_generate200_response.rb +221 -0
- data/lib/postboost/models/image_generate429_response.rb +214 -0
- data/lib/postboost/models/image_generate_input.rb +447 -0
- data/lib/postboost/models/image_generation_response.rb +305 -0
- data/lib/postboost/models/image_prompt200_response.rb +221 -0
- data/lib/postboost/models/image_prompt429_response.rb +214 -0
- data/lib/postboost/models/image_prompt_input.rb +345 -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/{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_upload201_response.rb +105 -0
- 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/list_accounts200_response.rb +2 -2
- 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_tags200_response.rb +2 -2
- data/lib/postboost/models/list_users200_response.rb +2 -2
- data/lib/postboost/models/list_workspaces200_response.rb +2 -2
- data/lib/postboost/models/media.rb +128 -3
- 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/pagination_meta.rb +2 -2
- data/lib/postboost/models/pagination_meta_links.rb +2 -2
- data/lib/postboost/models/pagination_meta_meta.rb +2 -2
- data/lib/postboost/models/post.rb +69 -3
- data/lib/postboost/models/post_analytics.rb +252 -0
- data/lib/postboost/models/post_content.rb +2 -2
- data/lib/postboost/models/post_input.rb +16 -3
- data/lib/postboost/models/post_status.rb +6 -3
- data/lib/postboost/models/post_version.rb +32 -3
- 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/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/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/remove_generic_subscription422_response.rb +214 -0
- data/lib/postboost/models/remove_user_from_workspace_request.rb +2 -2
- data/lib/postboost/models/retry_post_account_result.rb +275 -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/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/workspace.rb +42 -3
- data/lib/postboost/models/workspace_input.rb +3 -9
- data/lib/postboost/models/workspace_user_input.rb +2 -2
- data/lib/postboost/version.rb +3 -3
- data/lib/postboost.rb +70 -6
- data/postboost.gemspec +3 -3
- data/spec/api/accounts_api_spec.rb +7 -3
- data/spec/api/ai_api_spec.rb +113 -0
- data/spec/api/analytics_api_spec.rb +113 -0
- data/spec/api/media_api_spec.rb +73 -10
- data/spec/api/mentions_api_spec.rb +103 -0
- data/spec/api/posts_api_spec.rb +38 -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 +7 -2
- data/spec/api/users_api_spec.rb +9 -2
- data/spec/api/workspaces_api_spec.rb +33 -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_schedule_spec.rb +48 -0
- data/spec/models/account_spec.rb +24 -2
- 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/ai_credits_spec.rb +48 -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/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 +36 -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 +128 -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/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/checkout_subscription200_response_spec.rb +2 -2
- data/spec/models/checkout_subscription_request_spec.rb +2 -2
- data/spec/models/complete_chunked_upload_request_spec.rb +42 -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/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_remote_upload_status200_response_spec.rb +2 -2
- 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_edit_input_spec.rb +74 -0
- data/spec/models/image_generate200_response_spec.rb +36 -0
- data/spec/models/image_generate429_response_spec.rb +36 -0
- data/spec/models/image_generate_input_spec.rb +102 -0
- data/spec/models/image_generation_response_spec.rb +72 -0
- data/spec/models/image_prompt200_response_spec.rb +36 -0
- data/spec/models/image_prompt429_response_spec.rb +36 -0
- data/spec/models/image_prompt_input_spec.rb +70 -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/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/list_accounts200_response_spec.rb +2 -2
- 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_tags200_response_spec.rb +2 -2
- data/spec/models/list_users200_response_spec.rb +2 -2
- data/spec/models/list_workspaces200_response_spec.rb +2 -2
- 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/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/post_analytics_spec.rb +48 -0
- data/spec/models/post_content_spec.rb +2 -2
- data/spec/models/post_input_spec.rb +8 -2
- data/spec/models/post_spec.rb +8 -2
- data/spec/models/post_status_spec.rb +2 -2
- data/spec/models/post_version_spec.rb +8 -2
- 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/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/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/remove_generic_subscription422_response_spec.rb +36 -0
- data/spec/models/remove_user_from_workspace_request_spec.rb +2 -2
- data/spec/models/retry_post_account_result_spec.rb +48 -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/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/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/spec_helper.rb +2 -2
- metadata +331 -75
- 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
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# PostBoost::AccountAnalyticsInitialSync
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **in_progress** | **Boolean** | | |
|
|
8
|
+
| **progress** | **Object** | | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'postboost'
|
|
14
|
+
|
|
15
|
+
instance = PostBoost::AccountAnalyticsInitialSync.new(
|
|
16
|
+
in_progress: null,
|
|
17
|
+
progress: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# PostBoost::AccountSchedule
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **account_id** | **Integer** | ID of one of the post's accounts. Entries for accounts the post does not carry are ignored. | |
|
|
8
|
+
| **date** | **Date** | | |
|
|
9
|
+
| **time** | **String** | H:i, read in the request `timezone`. Must not be in the past. | |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'postboost'
|
|
15
|
+
|
|
16
|
+
instance = PostBoost::AccountSchedule.new(
|
|
17
|
+
account_id: null,
|
|
18
|
+
date: 2026-11-01,
|
|
19
|
+
time: 14:30
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
data/docs/AccountsApi.md
CHANGED
|
@@ -81,11 +81,11 @@ end
|
|
|
81
81
|
|
|
82
82
|
## list_accounts
|
|
83
83
|
|
|
84
|
-
> <ListAccounts200Response> list_accounts(workspace_uuid)
|
|
84
|
+
> <ListAccounts200Response> list_accounts(workspace_uuid, opts)
|
|
85
85
|
|
|
86
86
|
List accounts
|
|
87
87
|
|
|
88
|
-
Returns all social media accounts connected to the workspace.
|
|
88
|
+
Returns all social media accounts connected to the workspace, newest first. Optional filters narrow the list.
|
|
89
89
|
|
|
90
90
|
### Examples
|
|
91
91
|
|
|
@@ -100,10 +100,16 @@ end
|
|
|
100
100
|
|
|
101
101
|
api_instance = PostBoost::AccountsApi.new
|
|
102
102
|
workspace_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the workspace.
|
|
103
|
+
opts = {
|
|
104
|
+
keyword: 'keyword_example', # String | Match the account name or username.
|
|
105
|
+
group: 'group_example', # String | Only accounts in this account group.
|
|
106
|
+
providers: ['inner_example'], # Array<String> | Only accounts of these providers (for example `instagram`, `linkedin`).
|
|
107
|
+
unauthorized: true # Boolean | When `true`, only accounts that need to be reconnected.
|
|
108
|
+
}
|
|
103
109
|
|
|
104
110
|
begin
|
|
105
111
|
# List accounts
|
|
106
|
-
result = api_instance.list_accounts(workspace_uuid)
|
|
112
|
+
result = api_instance.list_accounts(workspace_uuid, opts)
|
|
107
113
|
p result
|
|
108
114
|
rescue PostBoost::ApiError => e
|
|
109
115
|
puts "Error when calling AccountsApi->list_accounts: #{e}"
|
|
@@ -114,12 +120,12 @@ end
|
|
|
114
120
|
|
|
115
121
|
This returns an Array which contains the response data, status code and headers.
|
|
116
122
|
|
|
117
|
-
> <Array(<ListAccounts200Response>, Integer, Hash)> list_accounts_with_http_info(workspace_uuid)
|
|
123
|
+
> <Array(<ListAccounts200Response>, Integer, Hash)> list_accounts_with_http_info(workspace_uuid, opts)
|
|
118
124
|
|
|
119
125
|
```ruby
|
|
120
126
|
begin
|
|
121
127
|
# List accounts
|
|
122
|
-
data, status_code, headers = api_instance.list_accounts_with_http_info(workspace_uuid)
|
|
128
|
+
data, status_code, headers = api_instance.list_accounts_with_http_info(workspace_uuid, opts)
|
|
123
129
|
p status_code # => 2xx
|
|
124
130
|
p headers # => { ... }
|
|
125
131
|
p data # => <ListAccounts200Response>
|
|
@@ -133,6 +139,10 @@ end
|
|
|
133
139
|
| Name | Type | Description | Notes |
|
|
134
140
|
| ---- | ---- | ----------- | ----- |
|
|
135
141
|
| **workspace_uuid** | **String** | UUID of the workspace. | |
|
|
142
|
+
| **keyword** | **String** | Match the account name or username. | [optional] |
|
|
143
|
+
| **group** | **String** | Only accounts in this account group. | [optional] |
|
|
144
|
+
| **providers** | [**Array<String>**](String.md) | Only accounts of these providers (for example `instagram`, `linkedin`). | [optional] |
|
|
145
|
+
| **unauthorized** | **Boolean** | When `true`, only accounts that need to be reconnected. | [optional] |
|
|
136
146
|
|
|
137
147
|
### Return type
|
|
138
148
|
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# PostBoost::AddPostToQueueRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **timezone** | **String** | Accepted and validated for consistency with the other scheduling endpoints; queue slots are always taken from the workspace posting schedule. | [optional] |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'postboost'
|
|
13
|
+
|
|
14
|
+
instance = PostBoost::AddPostToQueueRequest.new(
|
|
15
|
+
timezone: America/New_York
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -0,0 +1,401 @@
|
|
|
1
|
+
# PostBoost::AnalyticsApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://postboost.co/app/api*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**get_account_analytics**](AnalyticsApi.md#get_account_analytics) | **GET** /{workspaceUuid}/analytics/accounts/{accountUuid} | Get account analytics |
|
|
8
|
+
| [**get_analytics_summary**](AnalyticsApi.md#get_analytics_summary) | **GET** /{workspaceUuid}/analytics | Get analytics summary |
|
|
9
|
+
| [**get_best_posting_times**](AnalyticsApi.md#get_best_posting_times) | **GET** /{workspaceUuid}/analytics/best-times | Get best posting times |
|
|
10
|
+
| [**get_post_analytics_0**](AnalyticsApi.md#get_post_analytics_0) | **GET** /{workspaceUuid}/posts/{postUuid}/analytics | Get post analytics |
|
|
11
|
+
| [**get_posting_times**](AnalyticsApi.md#get_posting_times) | **GET** /{workspaceUuid}/analytics/posting-times | Get posting times heatmap |
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
## get_account_analytics
|
|
15
|
+
|
|
16
|
+
> <AccountAnalytics> get_account_analytics(workspace_uuid, account_uuid, opts)
|
|
17
|
+
|
|
18
|
+
Get account analytics
|
|
19
|
+
|
|
20
|
+
Analytics for one account. `type` selects one of the tabs the account supports (listed in `tabs` of the response); returns `422` when the account does not support analytics.
|
|
21
|
+
|
|
22
|
+
### Examples
|
|
23
|
+
|
|
24
|
+
```ruby
|
|
25
|
+
require 'time'
|
|
26
|
+
require 'postboost'
|
|
27
|
+
# setup authorization
|
|
28
|
+
PostBoost.configure do |config|
|
|
29
|
+
# Configure Bearer authorization: bearerAuth
|
|
30
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
31
|
+
end
|
|
32
|
+
|
|
33
|
+
api_instance = PostBoost::AnalyticsApi.new
|
|
34
|
+
workspace_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the workspace.
|
|
35
|
+
account_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the social media account.
|
|
36
|
+
opts = {
|
|
37
|
+
period: 'this_week', # String | Preset reporting period. Ignored when `date_from` and `date_to` are given.
|
|
38
|
+
date_from: Date.parse('2013-10-20'), # Date | Start of a custom range (Y-m-d). Required with `date_to`; the range may span at most 366 days.
|
|
39
|
+
date_to: Date.parse('2013-10-20'), # Date | End of a custom range (Y-m-d). Required with `date_from`; must not be before it.
|
|
40
|
+
type: 'type_example', # String | Analytics tab. Defaults to the account's default tab.
|
|
41
|
+
page: 56, # Integer | Page for list-style tabs (for example per-post metrics).
|
|
42
|
+
per_page: 56, # Integer |
|
|
43
|
+
sort_by: 'sort_by_example', # String |
|
|
44
|
+
sort_dir: 'asc' # String |
|
|
45
|
+
}
|
|
46
|
+
|
|
47
|
+
begin
|
|
48
|
+
# Get account analytics
|
|
49
|
+
result = api_instance.get_account_analytics(workspace_uuid, account_uuid, opts)
|
|
50
|
+
p result
|
|
51
|
+
rescue PostBoost::ApiError => e
|
|
52
|
+
puts "Error when calling AnalyticsApi->get_account_analytics: #{e}"
|
|
53
|
+
end
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
#### Using the get_account_analytics_with_http_info variant
|
|
57
|
+
|
|
58
|
+
This returns an Array which contains the response data, status code and headers.
|
|
59
|
+
|
|
60
|
+
> <Array(<AccountAnalytics>, Integer, Hash)> get_account_analytics_with_http_info(workspace_uuid, account_uuid, opts)
|
|
61
|
+
|
|
62
|
+
```ruby
|
|
63
|
+
begin
|
|
64
|
+
# Get account analytics
|
|
65
|
+
data, status_code, headers = api_instance.get_account_analytics_with_http_info(workspace_uuid, account_uuid, opts)
|
|
66
|
+
p status_code # => 2xx
|
|
67
|
+
p headers # => { ... }
|
|
68
|
+
p data # => <AccountAnalytics>
|
|
69
|
+
rescue PostBoost::ApiError => e
|
|
70
|
+
puts "Error when calling AnalyticsApi->get_account_analytics_with_http_info: #{e}"
|
|
71
|
+
end
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
### Parameters
|
|
75
|
+
|
|
76
|
+
| Name | Type | Description | Notes |
|
|
77
|
+
| ---- | ---- | ----------- | ----- |
|
|
78
|
+
| **workspace_uuid** | **String** | UUID of the workspace. | |
|
|
79
|
+
| **account_uuid** | **String** | UUID of the social media account. | |
|
|
80
|
+
| **period** | **String** | Preset reporting period. Ignored when `date_from` and `date_to` are given. | [optional][default to 'this_month'] |
|
|
81
|
+
| **date_from** | **Date** | Start of a custom range (Y-m-d). Required with `date_to`; the range may span at most 366 days. | [optional] |
|
|
82
|
+
| **date_to** | **Date** | End of a custom range (Y-m-d). Required with `date_from`; must not be before it. | [optional] |
|
|
83
|
+
| **type** | **String** | Analytics tab. Defaults to the account's default tab. | [optional] |
|
|
84
|
+
| **page** | **Integer** | Page for list-style tabs (for example per-post metrics). | [optional][default to 1] |
|
|
85
|
+
| **per_page** | **Integer** | | [optional] |
|
|
86
|
+
| **sort_by** | **String** | | [optional] |
|
|
87
|
+
| **sort_dir** | **String** | | [optional][default to 'desc'] |
|
|
88
|
+
|
|
89
|
+
### Return type
|
|
90
|
+
|
|
91
|
+
[**AccountAnalytics**](AccountAnalytics.md)
|
|
92
|
+
|
|
93
|
+
### Authorization
|
|
94
|
+
|
|
95
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
96
|
+
|
|
97
|
+
### HTTP request headers
|
|
98
|
+
|
|
99
|
+
- **Content-Type**: Not defined
|
|
100
|
+
- **Accept**: application/json
|
|
101
|
+
|
|
102
|
+
|
|
103
|
+
## get_analytics_summary
|
|
104
|
+
|
|
105
|
+
> <AnalyticsSummary> get_analytics_summary(workspace_uuid, opts)
|
|
106
|
+
|
|
107
|
+
Get analytics summary
|
|
108
|
+
|
|
109
|
+
Cross-platform summary (followers, growth, posts, leaderboard, posting streak) over every account that supports analytics, for a preset period or a custom date range.
|
|
110
|
+
|
|
111
|
+
### Examples
|
|
112
|
+
|
|
113
|
+
```ruby
|
|
114
|
+
require 'time'
|
|
115
|
+
require 'postboost'
|
|
116
|
+
# setup authorization
|
|
117
|
+
PostBoost.configure do |config|
|
|
118
|
+
# Configure Bearer authorization: bearerAuth
|
|
119
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
120
|
+
end
|
|
121
|
+
|
|
122
|
+
api_instance = PostBoost::AnalyticsApi.new
|
|
123
|
+
workspace_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the workspace.
|
|
124
|
+
opts = {
|
|
125
|
+
period: 'this_week', # String | Preset reporting period. Ignored when `date_from` and `date_to` are given.
|
|
126
|
+
date_from: Date.parse('2013-10-20'), # Date | Start of a custom range (Y-m-d). Required with `date_to`; the range may span at most 366 days.
|
|
127
|
+
date_to: Date.parse('2013-10-20') # Date | End of a custom range (Y-m-d). Required with `date_from`; must not be before it.
|
|
128
|
+
}
|
|
129
|
+
|
|
130
|
+
begin
|
|
131
|
+
# Get analytics summary
|
|
132
|
+
result = api_instance.get_analytics_summary(workspace_uuid, opts)
|
|
133
|
+
p result
|
|
134
|
+
rescue PostBoost::ApiError => e
|
|
135
|
+
puts "Error when calling AnalyticsApi->get_analytics_summary: #{e}"
|
|
136
|
+
end
|
|
137
|
+
```
|
|
138
|
+
|
|
139
|
+
#### Using the get_analytics_summary_with_http_info variant
|
|
140
|
+
|
|
141
|
+
This returns an Array which contains the response data, status code and headers.
|
|
142
|
+
|
|
143
|
+
> <Array(<AnalyticsSummary>, Integer, Hash)> get_analytics_summary_with_http_info(workspace_uuid, opts)
|
|
144
|
+
|
|
145
|
+
```ruby
|
|
146
|
+
begin
|
|
147
|
+
# Get analytics summary
|
|
148
|
+
data, status_code, headers = api_instance.get_analytics_summary_with_http_info(workspace_uuid, opts)
|
|
149
|
+
p status_code # => 2xx
|
|
150
|
+
p headers # => { ... }
|
|
151
|
+
p data # => <AnalyticsSummary>
|
|
152
|
+
rescue PostBoost::ApiError => e
|
|
153
|
+
puts "Error when calling AnalyticsApi->get_analytics_summary_with_http_info: #{e}"
|
|
154
|
+
end
|
|
155
|
+
```
|
|
156
|
+
|
|
157
|
+
### Parameters
|
|
158
|
+
|
|
159
|
+
| Name | Type | Description | Notes |
|
|
160
|
+
| ---- | ---- | ----------- | ----- |
|
|
161
|
+
| **workspace_uuid** | **String** | UUID of the workspace. | |
|
|
162
|
+
| **period** | **String** | Preset reporting period. Ignored when `date_from` and `date_to` are given. | [optional][default to 'this_month'] |
|
|
163
|
+
| **date_from** | **Date** | Start of a custom range (Y-m-d). Required with `date_to`; the range may span at most 366 days. | [optional] |
|
|
164
|
+
| **date_to** | **Date** | End of a custom range (Y-m-d). Required with `date_from`; must not be before it. | [optional] |
|
|
165
|
+
|
|
166
|
+
### Return type
|
|
167
|
+
|
|
168
|
+
[**AnalyticsSummary**](AnalyticsSummary.md)
|
|
169
|
+
|
|
170
|
+
### Authorization
|
|
171
|
+
|
|
172
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
173
|
+
|
|
174
|
+
### HTTP request headers
|
|
175
|
+
|
|
176
|
+
- **Content-Type**: Not defined
|
|
177
|
+
- **Accept**: application/json
|
|
178
|
+
|
|
179
|
+
|
|
180
|
+
## get_best_posting_times
|
|
181
|
+
|
|
182
|
+
> <BestPostingTimes> get_best_posting_times(workspace_uuid, opts)
|
|
183
|
+
|
|
184
|
+
Get best posting times
|
|
185
|
+
|
|
186
|
+
The next recommended date and time per account, on or after `from` (never in the past), within the next 14 days.
|
|
187
|
+
|
|
188
|
+
### Examples
|
|
189
|
+
|
|
190
|
+
```ruby
|
|
191
|
+
require 'time'
|
|
192
|
+
require 'postboost'
|
|
193
|
+
# setup authorization
|
|
194
|
+
PostBoost.configure do |config|
|
|
195
|
+
# Configure Bearer authorization: bearerAuth
|
|
196
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
197
|
+
end
|
|
198
|
+
|
|
199
|
+
api_instance = PostBoost::AnalyticsApi.new
|
|
200
|
+
workspace_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the workspace.
|
|
201
|
+
opts = {
|
|
202
|
+
accounts: ['inner_example'], # Array<String> | Account UUIDs. Defaults to every account in the workspace.
|
|
203
|
+
from: Date.parse('2013-10-20'), # Date | Earliest date to recommend (Y-m-d). Defaults to now.
|
|
204
|
+
timezone: 'timezone_example' # String | Timezone for `from` and the returned times. Defaults to the workspace timezone.
|
|
205
|
+
}
|
|
206
|
+
|
|
207
|
+
begin
|
|
208
|
+
# Get best posting times
|
|
209
|
+
result = api_instance.get_best_posting_times(workspace_uuid, opts)
|
|
210
|
+
p result
|
|
211
|
+
rescue PostBoost::ApiError => e
|
|
212
|
+
puts "Error when calling AnalyticsApi->get_best_posting_times: #{e}"
|
|
213
|
+
end
|
|
214
|
+
```
|
|
215
|
+
|
|
216
|
+
#### Using the get_best_posting_times_with_http_info variant
|
|
217
|
+
|
|
218
|
+
This returns an Array which contains the response data, status code and headers.
|
|
219
|
+
|
|
220
|
+
> <Array(<BestPostingTimes>, Integer, Hash)> get_best_posting_times_with_http_info(workspace_uuid, opts)
|
|
221
|
+
|
|
222
|
+
```ruby
|
|
223
|
+
begin
|
|
224
|
+
# Get best posting times
|
|
225
|
+
data, status_code, headers = api_instance.get_best_posting_times_with_http_info(workspace_uuid, opts)
|
|
226
|
+
p status_code # => 2xx
|
|
227
|
+
p headers # => { ... }
|
|
228
|
+
p data # => <BestPostingTimes>
|
|
229
|
+
rescue PostBoost::ApiError => e
|
|
230
|
+
puts "Error when calling AnalyticsApi->get_best_posting_times_with_http_info: #{e}"
|
|
231
|
+
end
|
|
232
|
+
```
|
|
233
|
+
|
|
234
|
+
### Parameters
|
|
235
|
+
|
|
236
|
+
| Name | Type | Description | Notes |
|
|
237
|
+
| ---- | ---- | ----------- | ----- |
|
|
238
|
+
| **workspace_uuid** | **String** | UUID of the workspace. | |
|
|
239
|
+
| **accounts** | [**Array<String>**](String.md) | Account UUIDs. Defaults to every account in the workspace. | [optional] |
|
|
240
|
+
| **from** | **Date** | Earliest date to recommend (Y-m-d). Defaults to now. | [optional] |
|
|
241
|
+
| **timezone** | **String** | Timezone for `from` and the returned times. Defaults to the workspace timezone. | [optional] |
|
|
242
|
+
|
|
243
|
+
### Return type
|
|
244
|
+
|
|
245
|
+
[**BestPostingTimes**](BestPostingTimes.md)
|
|
246
|
+
|
|
247
|
+
### Authorization
|
|
248
|
+
|
|
249
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
250
|
+
|
|
251
|
+
### HTTP request headers
|
|
252
|
+
|
|
253
|
+
- **Content-Type**: Not defined
|
|
254
|
+
- **Accept**: application/json
|
|
255
|
+
|
|
256
|
+
|
|
257
|
+
## get_post_analytics_0
|
|
258
|
+
|
|
259
|
+
> <PostAnalytics> get_post_analytics_0(workspace_uuid, post_uuid)
|
|
260
|
+
|
|
261
|
+
Get post analytics
|
|
262
|
+
|
|
263
|
+
Engagement metrics for a published post across its accounts (also works for trashed posts), with totals, trends and the best-performing account.
|
|
264
|
+
|
|
265
|
+
### Examples
|
|
266
|
+
|
|
267
|
+
```ruby
|
|
268
|
+
require 'time'
|
|
269
|
+
require 'postboost'
|
|
270
|
+
# setup authorization
|
|
271
|
+
PostBoost.configure do |config|
|
|
272
|
+
# Configure Bearer authorization: bearerAuth
|
|
273
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
274
|
+
end
|
|
275
|
+
|
|
276
|
+
api_instance = PostBoost::AnalyticsApi.new
|
|
277
|
+
workspace_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the workspace.
|
|
278
|
+
post_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the post.
|
|
279
|
+
|
|
280
|
+
begin
|
|
281
|
+
# Get post analytics
|
|
282
|
+
result = api_instance.get_post_analytics_0(workspace_uuid, post_uuid)
|
|
283
|
+
p result
|
|
284
|
+
rescue PostBoost::ApiError => e
|
|
285
|
+
puts "Error when calling AnalyticsApi->get_post_analytics_0: #{e}"
|
|
286
|
+
end
|
|
287
|
+
```
|
|
288
|
+
|
|
289
|
+
#### Using the get_post_analytics_0_with_http_info variant
|
|
290
|
+
|
|
291
|
+
This returns an Array which contains the response data, status code and headers.
|
|
292
|
+
|
|
293
|
+
> <Array(<PostAnalytics>, Integer, Hash)> get_post_analytics_0_with_http_info(workspace_uuid, post_uuid)
|
|
294
|
+
|
|
295
|
+
```ruby
|
|
296
|
+
begin
|
|
297
|
+
# Get post analytics
|
|
298
|
+
data, status_code, headers = api_instance.get_post_analytics_0_with_http_info(workspace_uuid, post_uuid)
|
|
299
|
+
p status_code # => 2xx
|
|
300
|
+
p headers # => { ... }
|
|
301
|
+
p data # => <PostAnalytics>
|
|
302
|
+
rescue PostBoost::ApiError => e
|
|
303
|
+
puts "Error when calling AnalyticsApi->get_post_analytics_0_with_http_info: #{e}"
|
|
304
|
+
end
|
|
305
|
+
```
|
|
306
|
+
|
|
307
|
+
### Parameters
|
|
308
|
+
|
|
309
|
+
| Name | Type | Description | Notes |
|
|
310
|
+
| ---- | ---- | ----------- | ----- |
|
|
311
|
+
| **workspace_uuid** | **String** | UUID of the workspace. | |
|
|
312
|
+
| **post_uuid** | **String** | UUID of the post. | |
|
|
313
|
+
|
|
314
|
+
### Return type
|
|
315
|
+
|
|
316
|
+
[**PostAnalytics**](PostAnalytics.md)
|
|
317
|
+
|
|
318
|
+
### Authorization
|
|
319
|
+
|
|
320
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
321
|
+
|
|
322
|
+
### HTTP request headers
|
|
323
|
+
|
|
324
|
+
- **Content-Type**: Not defined
|
|
325
|
+
- **Accept**: application/json
|
|
326
|
+
|
|
327
|
+
|
|
328
|
+
## get_posting_times
|
|
329
|
+
|
|
330
|
+
> <PostingTimes> get_posting_times(workspace_uuid, opts)
|
|
331
|
+
|
|
332
|
+
Get posting times heatmap
|
|
333
|
+
|
|
334
|
+
Engagement scores per weekday and hour, merged across the given accounts (all accounts when none is given), in the requested timezone. Also returns up to three recommended slots.
|
|
335
|
+
|
|
336
|
+
### Examples
|
|
337
|
+
|
|
338
|
+
```ruby
|
|
339
|
+
require 'time'
|
|
340
|
+
require 'postboost'
|
|
341
|
+
# setup authorization
|
|
342
|
+
PostBoost.configure do |config|
|
|
343
|
+
# Configure Bearer authorization: bearerAuth
|
|
344
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
345
|
+
end
|
|
346
|
+
|
|
347
|
+
api_instance = PostBoost::AnalyticsApi.new
|
|
348
|
+
workspace_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the workspace.
|
|
349
|
+
opts = {
|
|
350
|
+
accounts: ['inner_example'], # Array<String> | Account UUIDs. Defaults to every account in the workspace.
|
|
351
|
+
timezone: 'Europe/Istanbul' # String | Timezone the grid is expressed in. Defaults to the workspace timezone.
|
|
352
|
+
}
|
|
353
|
+
|
|
354
|
+
begin
|
|
355
|
+
# Get posting times heatmap
|
|
356
|
+
result = api_instance.get_posting_times(workspace_uuid, opts)
|
|
357
|
+
p result
|
|
358
|
+
rescue PostBoost::ApiError => e
|
|
359
|
+
puts "Error when calling AnalyticsApi->get_posting_times: #{e}"
|
|
360
|
+
end
|
|
361
|
+
```
|
|
362
|
+
|
|
363
|
+
#### Using the get_posting_times_with_http_info variant
|
|
364
|
+
|
|
365
|
+
This returns an Array which contains the response data, status code and headers.
|
|
366
|
+
|
|
367
|
+
> <Array(<PostingTimes>, Integer, Hash)> get_posting_times_with_http_info(workspace_uuid, opts)
|
|
368
|
+
|
|
369
|
+
```ruby
|
|
370
|
+
begin
|
|
371
|
+
# Get posting times heatmap
|
|
372
|
+
data, status_code, headers = api_instance.get_posting_times_with_http_info(workspace_uuid, opts)
|
|
373
|
+
p status_code # => 2xx
|
|
374
|
+
p headers # => { ... }
|
|
375
|
+
p data # => <PostingTimes>
|
|
376
|
+
rescue PostBoost::ApiError => e
|
|
377
|
+
puts "Error when calling AnalyticsApi->get_posting_times_with_http_info: #{e}"
|
|
378
|
+
end
|
|
379
|
+
```
|
|
380
|
+
|
|
381
|
+
### Parameters
|
|
382
|
+
|
|
383
|
+
| Name | Type | Description | Notes |
|
|
384
|
+
| ---- | ---- | ----------- | ----- |
|
|
385
|
+
| **workspace_uuid** | **String** | UUID of the workspace. | |
|
|
386
|
+
| **accounts** | [**Array<String>**](String.md) | Account UUIDs. Defaults to every account in the workspace. | [optional] |
|
|
387
|
+
| **timezone** | **String** | Timezone the grid is expressed in. Defaults to the workspace timezone. | [optional] |
|
|
388
|
+
|
|
389
|
+
### Return type
|
|
390
|
+
|
|
391
|
+
[**PostingTimes**](PostingTimes.md)
|
|
392
|
+
|
|
393
|
+
### Authorization
|
|
394
|
+
|
|
395
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
396
|
+
|
|
397
|
+
### HTTP request headers
|
|
398
|
+
|
|
399
|
+
- **Content-Type**: Not defined
|
|
400
|
+
- **Accept**: application/json
|
|
401
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# PostBoost::AnalyticsPeriod
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **start_date** | **Date** | | |
|
|
8
|
+
| **end_date** | **Date** | | |
|
|
9
|
+
| **previous_start_date** | **Date** | Start of the equally long range before this one, used for comparisons. | |
|
|
10
|
+
| **previous_end_date** | **Date** | | |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'postboost'
|
|
16
|
+
|
|
17
|
+
instance = PostBoost::AnalyticsPeriod.new(
|
|
18
|
+
start_date: null,
|
|
19
|
+
end_date: null,
|
|
20
|
+
previous_start_date: null,
|
|
21
|
+
previous_end_date: null
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# PostBoost::AnalyticsSummary
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **period** | [**AnalyticsPeriod**](AnalyticsPeriod.md) | | |
|
|
8
|
+
| **data** | [**AnalyticsSummaryData**](AnalyticsSummaryData.md) | | |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'postboost'
|
|
14
|
+
|
|
15
|
+
instance = PostBoost::AnalyticsSummary.new(
|
|
16
|
+
period: null,
|
|
17
|
+
data: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
# PostBoost::AnalyticsSummaryData
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **total_followers** | **Integer** | | [optional] |
|
|
8
|
+
| **follower_growth** | **Hash<String, Object>** | Growth in the period with the change against the previous period. | [optional] |
|
|
9
|
+
| **total_posts** | **Hash<String, Object>** | Posts in the period with the change against the previous period. | [optional] |
|
|
10
|
+
| **best_account** | **Hash<String, Object>** | | [optional] |
|
|
11
|
+
| **needs_attention** | **Hash<String, Object>** | | [optional] |
|
|
12
|
+
| **audience_chart** | **Array<Hash<String, Object>>** | | [optional] |
|
|
13
|
+
| **leaderboard** | **Array<Hash<String, Object>>** | | [optional] |
|
|
14
|
+
| **most_active** | **Hash<String, Object>** | | [optional] |
|
|
15
|
+
| **least_active** | **Hash<String, Object>** | | [optional] |
|
|
16
|
+
| **follower_distribution** | **Array<Hash<String, Object>>** | | [optional] |
|
|
17
|
+
| **posting_streak** | **Hash<String, Object>** | | [optional] |
|
|
18
|
+
|
|
19
|
+
## Example
|
|
20
|
+
|
|
21
|
+
```ruby
|
|
22
|
+
require 'postboost'
|
|
23
|
+
|
|
24
|
+
instance = PostBoost::AnalyticsSummaryData.new(
|
|
25
|
+
total_followers: null,
|
|
26
|
+
follower_growth: null,
|
|
27
|
+
total_posts: null,
|
|
28
|
+
best_account: null,
|
|
29
|
+
needs_attention: null,
|
|
30
|
+
audience_chart: null,
|
|
31
|
+
leaderboard: null,
|
|
32
|
+
most_active: null,
|
|
33
|
+
least_active: null,
|
|
34
|
+
follower_distribution: null,
|
|
35
|
+
posting_streak: null
|
|
36
|
+
)
|
|
37
|
+
```
|
|
38
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# PostBoost::ApprovePostRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **date** | **Date** | New date for the post (Y-m-d). Use together with `time`. | [optional] |
|
|
8
|
+
| **time** | **String** | New time for the post (H:i). | [optional] |
|
|
9
|
+
| **timezone** | **String** | Timezone `date`, `time` and `accounts_schedule` are read in. Defaults to the workspace timezone. | [optional] |
|
|
10
|
+
| **accounts_schedule** | [**Array<AccountSchedule>**](AccountSchedule.md) | Per-account departure times. When omitted, accounts keep their offsets from the post time. | [optional] |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'postboost'
|
|
16
|
+
|
|
17
|
+
instance = PostBoost::ApprovePostRequest.new(
|
|
18
|
+
date: 2026-11-01,
|
|
19
|
+
time: 10:00,
|
|
20
|
+
timezone: America/New_York,
|
|
21
|
+
accounts_schedule: null
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# PostBoost::BestPostingTimes
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **timezone** | **String** | | |
|
|
8
|
+
| **times** | [**Array<BestPostingTimesTimesInner>**](BestPostingTimesTimesInner.md) | The next recommended time per account. Accounts without enough history are left out. | |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'postboost'
|
|
14
|
+
|
|
15
|
+
instance = PostBoost::BestPostingTimes.new(
|
|
16
|
+
timezone: null,
|
|
17
|
+
times: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# PostBoost::BestPostingTimesTimesInner
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **account_id** | **Integer** | | |
|
|
8
|
+
| **account_uuid** | **String** | | |
|
|
9
|
+
| **date** | **Date** | | |
|
|
10
|
+
| **time** | **String** | | |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'postboost'
|
|
16
|
+
|
|
17
|
+
instance = PostBoost::BestPostingTimesTimesInner.new(
|
|
18
|
+
account_id: null,
|
|
19
|
+
account_uuid: null,
|
|
20
|
+
date: null,
|
|
21
|
+
time: 18:00
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# PostBoost::BlogToSocial200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **data** | [**BlogToSocialResponse**](BlogToSocialResponse.md) | | [optional] |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'postboost'
|
|
13
|
+
|
|
14
|
+
instance = PostBoost::BlogToSocial200Response.new(
|
|
15
|
+
data: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|