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
data/spec/api/media_api_spec.rb
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#PostBoost API
|
|
3
3
|
|
|
4
|
-
#The PostBoost REST API lets you publish, schedule, and analyze social media posts across
|
|
4
|
+
#The PostBoost REST API lets you publish, schedule, and analyze social media posts across 12+ platforms from a single integration. No OAuth apps to maintain — PostBoost handles platform authorization for you. ## Base URL All workspace-scoped endpoints are prefixed with `/{workspaceUuid}`. Panel/admin endpoints are prefixed with `/panel`. ## Plan access Every workspace-scoped endpoint returns `403` when the workspace's plan does not include API access (capability `api`). ## Dates and times Post dates and times (`date`, `time`, `accounts_schedule`) are read in the request's `timezone` when one is given, otherwise in the workspace timezone. ## Authentication All requests require a Bearer token in the `Authorization` header. Generate tokens in your PostBoost dashboard under **Settings → Access Tokens**. ``` Authorization: Bearer YOUR_API_TOKEN ```
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: 1.
|
|
6
|
+
The version of the OpenAPI document: 1.8.0
|
|
7
7
|
Contact: hi@postboost.co
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
Generator version: 7.9.0
|
|
@@ -47,10 +47,11 @@ describe 'MediaApi' do
|
|
|
47
47
|
|
|
48
48
|
# unit tests for complete_chunked_upload
|
|
49
49
|
# Complete chunked upload
|
|
50
|
-
# Signal that all chunks have been uploaded. Returns the final media object.
|
|
50
|
+
# 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.
|
|
51
51
|
# @param workspace_uuid UUID of the workspace.
|
|
52
52
|
# @param upload_uuid
|
|
53
53
|
# @param [Hash] opts the optional parameters
|
|
54
|
+
# @option opts [CompleteChunkedUploadRequest] :complete_chunked_upload_request
|
|
54
55
|
# @return [Media]
|
|
55
56
|
describe 'complete_chunked_upload test' do
|
|
56
57
|
it 'should work' do
|
|
@@ -58,9 +59,22 @@ describe 'MediaApi' do
|
|
|
58
59
|
end
|
|
59
60
|
end
|
|
60
61
|
|
|
62
|
+
# unit tests for create_media_folder
|
|
63
|
+
# Create media folder
|
|
64
|
+
# Creates a folder at the top level or under `parent`. The name must be unique among its siblings.
|
|
65
|
+
# @param workspace_uuid UUID of the workspace.
|
|
66
|
+
# @param create_media_folder_request
|
|
67
|
+
# @param [Hash] opts the optional parameters
|
|
68
|
+
# @return [MediaFolder]
|
|
69
|
+
describe 'create_media_folder test' do
|
|
70
|
+
it 'should work' do
|
|
71
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
72
|
+
end
|
|
73
|
+
end
|
|
74
|
+
|
|
61
75
|
# unit tests for delete_media_bulk
|
|
62
76
|
# Delete media (bulk)
|
|
63
|
-
# Delete one or more media items by their IDs.
|
|
77
|
+
# Delete one or more media items by their numeric IDs or UUIDs (both may be mixed, up to 500 per request).
|
|
64
78
|
# @param workspace_uuid UUID of the workspace.
|
|
65
79
|
# @param delete_media_bulk_request
|
|
66
80
|
# @param [Hash] opts the optional parameters
|
|
@@ -71,6 +85,20 @@ describe 'MediaApi' do
|
|
|
71
85
|
end
|
|
72
86
|
end
|
|
73
87
|
|
|
88
|
+
# unit tests for delete_media_folder
|
|
89
|
+
# Delete media folder
|
|
90
|
+
# 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.
|
|
91
|
+
# @param workspace_uuid UUID of the workspace.
|
|
92
|
+
# @param folder_uuid UUID of the media folder.
|
|
93
|
+
# @param [Hash] opts the optional parameters
|
|
94
|
+
# @option opts [DeleteMediaFolderRequest] :delete_media_folder_request
|
|
95
|
+
# @return [Object]
|
|
96
|
+
describe 'delete_media_folder test' do
|
|
97
|
+
it 'should work' do
|
|
98
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
99
|
+
end
|
|
100
|
+
end
|
|
101
|
+
|
|
74
102
|
# unit tests for get_media
|
|
75
103
|
# Get media
|
|
76
104
|
# Returns a single media asset.
|
|
@@ -103,7 +131,7 @@ describe 'MediaApi' do
|
|
|
103
131
|
# @param workspace_uuid UUID of the workspace.
|
|
104
132
|
# @param initiate_chunked_upload_request
|
|
105
133
|
# @param [Hash] opts the optional parameters
|
|
106
|
-
# @return [
|
|
134
|
+
# @return [InitiateChunkedUpload201Response]
|
|
107
135
|
describe 'initiate_chunked_upload test' do
|
|
108
136
|
it 'should work' do
|
|
109
137
|
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
@@ -116,7 +144,7 @@ describe 'MediaApi' do
|
|
|
116
144
|
# @param workspace_uuid UUID of the workspace.
|
|
117
145
|
# @param initiate_remote_upload_request
|
|
118
146
|
# @param [Hash] opts the optional parameters
|
|
119
|
-
# @return [
|
|
147
|
+
# @return [InitiateRemoteUpload201Response]
|
|
120
148
|
describe 'initiate_remote_upload test' do
|
|
121
149
|
it 'should work' do
|
|
122
150
|
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
@@ -125,10 +153,18 @@ describe 'MediaApi' do
|
|
|
125
153
|
|
|
126
154
|
# unit tests for list_media
|
|
127
155
|
# List media
|
|
128
|
-
# Returns a paginated list of media assets in the workspace library.
|
|
156
|
+
# 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`.
|
|
129
157
|
# @param workspace_uuid UUID of the workspace.
|
|
130
158
|
# @param [Hash] opts the optional parameters
|
|
131
|
-
# @option opts [Integer] :page Page number
|
|
159
|
+
# @option opts [Integer] :page Page number.
|
|
160
|
+
# @option opts [Integer] :limit Items per page. Values below 1 fall back to 50; values above 100 are capped at 100.
|
|
161
|
+
# @option opts [String] :folder Media folder UUID, or `root` for items not filed in any folder.
|
|
162
|
+
# @option opts [Array<String>] :mime_types Only these MIME types (for example `image/png`).
|
|
163
|
+
# @option opts [String] :type Only this media type.
|
|
164
|
+
# @option opts [String] :keyword Search media by name.
|
|
165
|
+
# @option opts [String] :usage Filter by how the media is used in posts.
|
|
166
|
+
# @option opts [Boolean] :favorite When `true`, only media the caller marked as favorite.
|
|
167
|
+
# @option opts [String] :sort
|
|
132
168
|
# @return [ListMedia200Response]
|
|
133
169
|
describe 'list_media test' do
|
|
134
170
|
it 'should work' do
|
|
@@ -136,9 +172,21 @@ describe 'MediaApi' do
|
|
|
136
172
|
end
|
|
137
173
|
end
|
|
138
174
|
|
|
175
|
+
# unit tests for list_media_folders
|
|
176
|
+
# List media folders
|
|
177
|
+
# Returns the whole folder tree of the media library in one response (not paginated). Rebuild the tree from each folder's `parent`.
|
|
178
|
+
# @param workspace_uuid UUID of the workspace.
|
|
179
|
+
# @param [Hash] opts the optional parameters
|
|
180
|
+
# @return [ListMediaFolders200Response]
|
|
181
|
+
describe 'list_media_folders test' do
|
|
182
|
+
it 'should work' do
|
|
183
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
184
|
+
end
|
|
185
|
+
end
|
|
186
|
+
|
|
139
187
|
# unit tests for update_media
|
|
140
188
|
# Update media
|
|
141
|
-
# Update the alt text of a media asset.
|
|
189
|
+
# 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.
|
|
142
190
|
# @param workspace_uuid UUID of the workspace.
|
|
143
191
|
# @param media_uuid UUID of the media asset.
|
|
144
192
|
# @param update_media_request
|
|
@@ -150,6 +198,20 @@ describe 'MediaApi' do
|
|
|
150
198
|
end
|
|
151
199
|
end
|
|
152
200
|
|
|
201
|
+
# unit tests for update_media_folder
|
|
202
|
+
# Update media folder
|
|
203
|
+
# 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.
|
|
204
|
+
# @param workspace_uuid UUID of the workspace.
|
|
205
|
+
# @param folder_uuid UUID of the media folder.
|
|
206
|
+
# @param media_folder_input
|
|
207
|
+
# @param [Hash] opts the optional parameters
|
|
208
|
+
# @return [MediaFolder]
|
|
209
|
+
describe 'update_media_folder test' do
|
|
210
|
+
it 'should work' do
|
|
211
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
212
|
+
end
|
|
213
|
+
end
|
|
214
|
+
|
|
153
215
|
# unit tests for upload_chunk
|
|
154
216
|
# Upload a chunk
|
|
155
217
|
# Upload a single chunk of a chunked upload session.
|
|
@@ -158,7 +220,7 @@ describe 'MediaApi' do
|
|
|
158
220
|
# @param chunk
|
|
159
221
|
# @param chunk_index Zero-based index of this chunk.
|
|
160
222
|
# @param [Hash] opts the optional parameters
|
|
161
|
-
# @return [
|
|
223
|
+
# @return [UploadChunk201Response]
|
|
162
224
|
describe 'upload_chunk test' do
|
|
163
225
|
it 'should work' do
|
|
164
226
|
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
@@ -172,6 +234,7 @@ describe 'MediaApi' do
|
|
|
172
234
|
# @param file The file to upload.
|
|
173
235
|
# @param [Hash] opts the optional parameters
|
|
174
236
|
# @option opts [String] :alt_text Alternative text for accessibility.
|
|
237
|
+
# @option opts [String] :folder UUID of the media folder to file the upload in. Omit or null for the library root.
|
|
175
238
|
# @return [Media]
|
|
176
239
|
describe 'upload_media test' do
|
|
177
240
|
it 'should work' do
|
|
@@ -0,0 +1,103 @@
|
|
|
1
|
+
=begin
|
|
2
|
+
#PostBoost API
|
|
3
|
+
|
|
4
|
+
#The PostBoost REST API lets you publish, schedule, and analyze social media posts across 12+ platforms from a single integration. No OAuth apps to maintain — PostBoost handles platform authorization for you. ## Base URL All workspace-scoped endpoints are prefixed with `/{workspaceUuid}`. Panel/admin endpoints are prefixed with `/panel`. ## Plan access Every workspace-scoped endpoint returns `403` when the workspace's plan does not include API access (capability `api`). ## Dates and times Post dates and times (`date`, `time`, `accounts_schedule`) are read in the request's `timezone` when one is given, otherwise in the workspace timezone. ## Authentication All requests require a Bearer token in the `Authorization` header. Generate tokens in your PostBoost dashboard under **Settings → Access Tokens**. ``` Authorization: Bearer YOUR_API_TOKEN ```
|
|
5
|
+
|
|
6
|
+
The version of the OpenAPI document: 1.8.0
|
|
7
|
+
Contact: hi@postboost.co
|
|
8
|
+
Generated by: https://openapi-generator.tech
|
|
9
|
+
Generator version: 7.9.0
|
|
10
|
+
|
|
11
|
+
=end
|
|
12
|
+
|
|
13
|
+
require 'spec_helper'
|
|
14
|
+
require 'json'
|
|
15
|
+
|
|
16
|
+
# Unit tests for PostBoost::MentionsApi
|
|
17
|
+
# Automatically generated by openapi-generator (https://openapi-generator.tech)
|
|
18
|
+
# Please update as you see appropriate
|
|
19
|
+
describe 'MentionsApi' do
|
|
20
|
+
before do
|
|
21
|
+
# run before each test
|
|
22
|
+
@api_instance = PostBoost::MentionsApi.new
|
|
23
|
+
end
|
|
24
|
+
|
|
25
|
+
after do
|
|
26
|
+
# run after each test
|
|
27
|
+
end
|
|
28
|
+
|
|
29
|
+
describe 'test an instance of MentionsApi' do
|
|
30
|
+
it 'should create an instance of MentionsApi' do
|
|
31
|
+
expect(@api_instance).to be_instance_of(PostBoost::MentionsApi)
|
|
32
|
+
end
|
|
33
|
+
end
|
|
34
|
+
|
|
35
|
+
# unit tests for create_mention
|
|
36
|
+
# Create mention
|
|
37
|
+
# Adds a person or page to the mention book. When one of the submitted identities already belongs to a stored mention, that mention is reused and the identities are added to it (status `200` instead of `201`).
|
|
38
|
+
# @param workspace_uuid UUID of the workspace.
|
|
39
|
+
# @param mention_input
|
|
40
|
+
# @param [Hash] opts the optional parameters
|
|
41
|
+
# @return [CreateMention201Response]
|
|
42
|
+
describe 'create_mention test' do
|
|
43
|
+
it 'should work' do
|
|
44
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
45
|
+
end
|
|
46
|
+
end
|
|
47
|
+
|
|
48
|
+
# unit tests for delete_mention
|
|
49
|
+
# Delete mention
|
|
50
|
+
# Removes a mention from the mention book. `success` is false when nothing was deleted.
|
|
51
|
+
# @param workspace_uuid UUID of the workspace.
|
|
52
|
+
# @param mention_id The mention's `id` (a UUID).
|
|
53
|
+
# @param [Hash] opts the optional parameters
|
|
54
|
+
# @return [Object]
|
|
55
|
+
describe 'delete_mention test' do
|
|
56
|
+
it 'should work' do
|
|
57
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
58
|
+
end
|
|
59
|
+
end
|
|
60
|
+
|
|
61
|
+
# unit tests for get_mention
|
|
62
|
+
# Get mention
|
|
63
|
+
# Returns a single mention with its identities.
|
|
64
|
+
# @param workspace_uuid UUID of the workspace.
|
|
65
|
+
# @param mention_id The mention's `id` (a UUID).
|
|
66
|
+
# @param [Hash] opts the optional parameters
|
|
67
|
+
# @return [CreateMention201Response]
|
|
68
|
+
describe 'get_mention test' do
|
|
69
|
+
it 'should work' do
|
|
70
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
71
|
+
end
|
|
72
|
+
end
|
|
73
|
+
|
|
74
|
+
# unit tests for list_mentions
|
|
75
|
+
# List mentions
|
|
76
|
+
# Returns a paginated list of the workspace's mention book, ranked, with each entry's network identities.
|
|
77
|
+
# @param workspace_uuid UUID of the workspace.
|
|
78
|
+
# @param [Hash] opts the optional parameters
|
|
79
|
+
# @option opts [String] :q Search keyword.
|
|
80
|
+
# @option opts [Integer] :per_page
|
|
81
|
+
# @option opts [Integer] :page
|
|
82
|
+
# @return [ListMentions200Response]
|
|
83
|
+
describe 'list_mentions test' do
|
|
84
|
+
it 'should work' do
|
|
85
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
86
|
+
end
|
|
87
|
+
end
|
|
88
|
+
|
|
89
|
+
# unit tests for update_mention
|
|
90
|
+
# Update mention
|
|
91
|
+
# Replaces the mention's name, avatar and identities. Identities for providers not in the payload are removed. An identity already held by another mention returns `422`.
|
|
92
|
+
# @param workspace_uuid UUID of the workspace.
|
|
93
|
+
# @param mention_id The mention's `id` (a UUID).
|
|
94
|
+
# @param mention_input
|
|
95
|
+
# @param [Hash] opts the optional parameters
|
|
96
|
+
# @return [CreateMention201Response]
|
|
97
|
+
describe 'update_mention test' do
|
|
98
|
+
it 'should work' do
|
|
99
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
100
|
+
end
|
|
101
|
+
end
|
|
102
|
+
|
|
103
|
+
end
|
data/spec/api/posts_api_spec.rb
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#PostBoost API
|
|
3
3
|
|
|
4
|
-
#The PostBoost REST API lets you publish, schedule, and analyze social media posts across
|
|
4
|
+
#The PostBoost REST API lets you publish, schedule, and analyze social media posts across 12+ platforms from a single integration. No OAuth apps to maintain — PostBoost handles platform authorization for you. ## Base URL All workspace-scoped endpoints are prefixed with `/{workspaceUuid}`. Panel/admin endpoints are prefixed with `/panel`. ## Plan access Every workspace-scoped endpoint returns `403` when the workspace's plan does not include API access (capability `api`). ## Dates and times Post dates and times (`date`, `time`, `accounts_schedule`) are read in the request's `timezone` when one is given, otherwise in the workspace timezone. ## Authentication All requests require a Bearer token in the `Authorization` header. Generate tokens in your PostBoost dashboard under **Settings → Access Tokens**. ``` Authorization: Bearer YOUR_API_TOKEN ```
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: 1.
|
|
6
|
+
The version of the OpenAPI document: 1.8.0
|
|
7
7
|
Contact: hi@postboost.co
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
Generator version: 7.9.0
|
|
@@ -34,10 +34,11 @@ describe 'PostsApi' do
|
|
|
34
34
|
|
|
35
35
|
# unit tests for add_post_to_queue
|
|
36
36
|
# Add post to queue
|
|
37
|
-
# Add an existing post to the smart publishing queue.
|
|
37
|
+
# Add an existing post to the smart publishing queue. Each account of the post gets its own next free queue slot. Returns `422` when the post has no accounts, the posting schedule has no available times, or provider requirements are not met.
|
|
38
38
|
# @param workspace_uuid UUID of the workspace.
|
|
39
39
|
# @param post_uuid UUID of the post.
|
|
40
40
|
# @param [Hash] opts the optional parameters
|
|
41
|
+
# @option opts [AddPostToQueueRequest] :add_post_to_queue_request
|
|
41
42
|
# @return [ScheduleResult]
|
|
42
43
|
describe 'add_post_to_queue test' do
|
|
43
44
|
it 'should work' do
|
|
@@ -47,10 +48,11 @@ describe 'PostsApi' do
|
|
|
47
48
|
|
|
48
49
|
# unit tests for approve_post
|
|
49
50
|
# Approve post
|
|
50
|
-
# Approve a post that is pending review.
|
|
51
|
+
# Approve a post that is pending review. The approver may move the post with `date`/`time` (read in `timezone`) and set per-account times with `accounts_schedule`; without them the post keeps the time it was submitted with. Provider requirements are validated and reported as `422`.
|
|
51
52
|
# @param workspace_uuid UUID of the workspace.
|
|
52
53
|
# @param post_uuid UUID of the post.
|
|
53
54
|
# @param [Hash] opts the optional parameters
|
|
55
|
+
# @option opts [ApprovePostRequest] :approve_post_request
|
|
54
56
|
# @return [ScheduleResult]
|
|
55
57
|
describe 'approve_post test' do
|
|
56
58
|
it 'should work' do
|
|
@@ -60,7 +62,7 @@ describe 'PostsApi' do
|
|
|
60
62
|
|
|
61
63
|
# unit tests for create_post
|
|
62
64
|
# Create post
|
|
63
|
-
# Create a new post. Use `schedule: true` with `date` and `time` to schedule, `schedule_now: true` to publish immediately, or `queue: true` to add to the smart publishing queue.
|
|
65
|
+
# Create a new post. Use `schedule: true` with `date` and `time` to schedule, `schedule_now: true` to publish immediately, or `queue: true` to add to the smart publishing queue (each account gets its own queue slot). `date`, `time` and `accounts_schedule` are read in `timezone` when given, otherwise in the workspace timezone. Use `accounts_schedule` to give individual accounts their own departure time. Post bodies may reference mentions with `{{mention:<reference>}}` (see the Mentions endpoints). When the post is scheduled, provider requirements (for example a network that requires media) are validated up front and reported as `422`.
|
|
64
66
|
# @param workspace_uuid UUID of the workspace.
|
|
65
67
|
# @param post_input
|
|
66
68
|
# @param [Hash] opts the optional parameters
|
|
@@ -73,6 +75,7 @@ describe 'PostsApi' do
|
|
|
73
75
|
|
|
74
76
|
# unit tests for delete_post
|
|
75
77
|
# Delete post
|
|
78
|
+
# Deletes a post. Use `delete_mode` to control whether to also remove the published content from social platforms.
|
|
76
79
|
# @param workspace_uuid UUID of the workspace.
|
|
77
80
|
# @param post_uuid UUID of the post.
|
|
78
81
|
# @param [Hash] opts the optional parameters
|
|
@@ -99,6 +102,7 @@ describe 'PostsApi' do
|
|
|
99
102
|
|
|
100
103
|
# unit tests for get_post
|
|
101
104
|
# Get post
|
|
105
|
+
# Returns a single post with all its versions and associated accounts.
|
|
102
106
|
# @param workspace_uuid UUID of the workspace.
|
|
103
107
|
# @param post_uuid UUID of the post.
|
|
104
108
|
# @param [Hash] opts the optional parameters
|
|
@@ -109,6 +113,19 @@ describe 'PostsApi' do
|
|
|
109
113
|
end
|
|
110
114
|
end
|
|
111
115
|
|
|
116
|
+
# unit tests for get_post_analytics
|
|
117
|
+
# Get post analytics
|
|
118
|
+
# Engagement metrics for a published post across its accounts (also works for trashed posts), with totals, trends and the best-performing account.
|
|
119
|
+
# @param workspace_uuid UUID of the workspace.
|
|
120
|
+
# @param post_uuid UUID of the post.
|
|
121
|
+
# @param [Hash] opts the optional parameters
|
|
122
|
+
# @return [PostAnalytics]
|
|
123
|
+
describe 'get_post_analytics test' do
|
|
124
|
+
it 'should work' do
|
|
125
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
126
|
+
end
|
|
127
|
+
end
|
|
128
|
+
|
|
112
129
|
# unit tests for list_posts
|
|
113
130
|
# List posts
|
|
114
131
|
# Returns a paginated list of posts in the workspace.
|
|
@@ -122,9 +139,23 @@ describe 'PostsApi' do
|
|
|
122
139
|
end
|
|
123
140
|
end
|
|
124
141
|
|
|
142
|
+
# unit tests for retry_post_account
|
|
143
|
+
# Retry publishing to one account
|
|
144
|
+
# Re-publishes a post to a single account whose publishing failed. Returns `422` when the account is not on the post, the post is still publishing, or the account did not fail.
|
|
145
|
+
# @param workspace_uuid UUID of the workspace.
|
|
146
|
+
# @param post_uuid UUID of the post.
|
|
147
|
+
# @param account_uuid UUID of the social media account.
|
|
148
|
+
# @param [Hash] opts the optional parameters
|
|
149
|
+
# @return [RetryPostAccountResult]
|
|
150
|
+
describe 'retry_post_account test' do
|
|
151
|
+
it 'should work' do
|
|
152
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
153
|
+
end
|
|
154
|
+
end
|
|
155
|
+
|
|
125
156
|
# unit tests for schedule_post
|
|
126
157
|
# Schedule post
|
|
127
|
-
# Schedule an existing post. Set `postNow: true` to publish immediately.
|
|
158
|
+
# Schedule an existing post. Optionally move it with `date`/`time` (read in `timezone`) and give accounts their own times with `accounts_schedule`. Set `postNow: true` to publish immediately; publishing starts within the request and any per-account times are dropped. Provider requirements are validated and reported as `422`.
|
|
128
159
|
# @param workspace_uuid UUID of the workspace.
|
|
129
160
|
# @param post_uuid UUID of the post.
|
|
130
161
|
# @param schedule_post_request
|
|
@@ -138,6 +169,7 @@ describe 'PostsApi' do
|
|
|
138
169
|
|
|
139
170
|
# unit tests for update_post
|
|
140
171
|
# Update post
|
|
172
|
+
# Replaces a post's versions, accounts, tags, and scheduling options. The post must not be in a published state. `timezone` is honoured: `date`, `time` and `accounts_schedule` are read in it. When the post stays scheduled, provider requirements are validated and reported as `422`.
|
|
141
173
|
# @param workspace_uuid UUID of the workspace.
|
|
142
174
|
# @param post_uuid UUID of the post.
|
|
143
175
|
# @param post_input
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#PostBoost API
|
|
3
3
|
|
|
4
|
-
#The PostBoost REST API lets you publish, schedule, and analyze social media posts across
|
|
4
|
+
#The PostBoost REST API lets you publish, schedule, and analyze social media posts across 12+ platforms from a single integration. No OAuth apps to maintain — PostBoost handles platform authorization for you. ## Base URL All workspace-scoped endpoints are prefixed with `/{workspaceUuid}`. Panel/admin endpoints are prefixed with `/panel`. ## Plan access Every workspace-scoped endpoint returns `403` when the workspace's plan does not include API access (capability `api`). ## Dates and times Post dates and times (`date`, `time`, `accounts_schedule`) are read in the request's `timezone` when one is given, otherwise in the workspace timezone. ## Authentication All requests require a Bearer token in the `Authorization` header. Generate tokens in your PostBoost dashboard under **Settings → Access Tokens**. ``` Authorization: Bearer YOUR_API_TOKEN ```
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: 1.
|
|
6
|
+
The version of the OpenAPI document: 1.8.0
|
|
7
7
|
Contact: hi@postboost.co
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
Generator version: 7.9.0
|
|
@@ -34,6 +34,7 @@ describe 'ReceiptsApi' do
|
|
|
34
34
|
|
|
35
35
|
# unit tests for create_receipt
|
|
36
36
|
# Create receipt
|
|
37
|
+
# Creates a billing receipt record for a workspace. Admin only.
|
|
37
38
|
# @param receipt_input
|
|
38
39
|
# @param [Hash] opts the optional parameters
|
|
39
40
|
# @return [Receipt]
|
|
@@ -45,6 +46,7 @@ describe 'ReceiptsApi' do
|
|
|
45
46
|
|
|
46
47
|
# unit tests for delete_receipt
|
|
47
48
|
# Delete receipt
|
|
49
|
+
# Permanently deletes a single receipt. Admin only.
|
|
48
50
|
# @param receipt_uuid UUID of the receipt.
|
|
49
51
|
# @param [Hash] opts the optional parameters
|
|
50
52
|
# @return [Object]
|
|
@@ -56,6 +58,7 @@ describe 'ReceiptsApi' do
|
|
|
56
58
|
|
|
57
59
|
# unit tests for delete_receipts_bulk
|
|
58
60
|
# Delete receipts (bulk)
|
|
61
|
+
# Permanently deletes one or more receipt records. Admin only.
|
|
59
62
|
# @param delete_receipts_bulk_request
|
|
60
63
|
# @param [Hash] opts the optional parameters
|
|
61
64
|
# @return [Object]
|
|
@@ -67,6 +70,7 @@ describe 'ReceiptsApi' do
|
|
|
67
70
|
|
|
68
71
|
# unit tests for get_receipt
|
|
69
72
|
# Get receipt
|
|
73
|
+
# Returns a single receipt by UUID. Admin only.
|
|
70
74
|
# @param receipt_uuid UUID of the receipt.
|
|
71
75
|
# @param [Hash] opts the optional parameters
|
|
72
76
|
# @return [Receipt]
|
|
@@ -78,9 +82,11 @@ describe 'ReceiptsApi' do
|
|
|
78
82
|
|
|
79
83
|
# unit tests for list_receipts
|
|
80
84
|
# List receipts
|
|
85
|
+
# Returns a paginated list of billing receipts. Filter by workspace UUID or invoice number. Admin only.
|
|
81
86
|
# @param [Hash] opts the optional parameters
|
|
82
87
|
# @option opts [String] :workspace_uuid
|
|
83
88
|
# @option opts [String] :invoice_number
|
|
89
|
+
# @option opts [Integer] :page Page number (15 items per page).
|
|
84
90
|
# @return [ListReceipts200Response]
|
|
85
91
|
describe 'list_receipts test' do
|
|
86
92
|
it 'should work' do
|
|
@@ -90,6 +96,7 @@ describe 'ReceiptsApi' do
|
|
|
90
96
|
|
|
91
97
|
# unit tests for update_receipt
|
|
92
98
|
# Update receipt
|
|
99
|
+
# Updates a receipt's transaction details, amount, or payment date. Admin only.
|
|
93
100
|
# @param receipt_uuid UUID of the receipt.
|
|
94
101
|
# @param receipt_update_input
|
|
95
102
|
# @param [Hash] opts the optional parameters
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#PostBoost API
|
|
3
3
|
|
|
4
|
-
#The PostBoost REST API lets you publish, schedule, and analyze social media posts across
|
|
4
|
+
#The PostBoost REST API lets you publish, schedule, and analyze social media posts across 12+ platforms from a single integration. No OAuth apps to maintain — PostBoost handles platform authorization for you. ## Base URL All workspace-scoped endpoints are prefixed with `/{workspaceUuid}`. Panel/admin endpoints are prefixed with `/panel`. ## Plan access Every workspace-scoped endpoint returns `403` when the workspace's plan does not include API access (capability `api`). ## Dates and times Post dates and times (`date`, `time`, `accounts_schedule`) are read in the request's `timezone` when one is given, otherwise in the workspace timezone. ## Authentication All requests require a Bearer token in the `Authorization` header. Generate tokens in your PostBoost dashboard under **Settings → Access Tokens**. ``` Authorization: Bearer YOUR_API_TOKEN ```
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: 1.
|
|
6
|
+
The version of the OpenAPI document: 1.8.0
|
|
7
7
|
Contact: hi@postboost.co
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
Generator version: 7.9.0
|
|
@@ -34,6 +34,7 @@ describe 'SubscriptionsApi' do
|
|
|
34
34
|
|
|
35
35
|
# unit tests for add_generic_subscription
|
|
36
36
|
# Add generic subscription
|
|
37
|
+
# Assigns a non-Stripe (generic) subscription plan to the workspace, optionally granting a trial period. Used for AppSumo-style lifetime deals. Admin only.
|
|
37
38
|
# @param workspace_uuid UUID of the workspace.
|
|
38
39
|
# @param add_generic_subscription_request
|
|
39
40
|
# @param [Hash] opts the optional parameters
|
|
@@ -46,8 +47,10 @@ describe 'SubscriptionsApi' do
|
|
|
46
47
|
|
|
47
48
|
# unit tests for cancel_subscription
|
|
48
49
|
# Cancel subscription
|
|
50
|
+
# Cancels the workspace's Stripe subscription at the end of the current billing period, or right away with `immediately: true`. Works for active and past-due subscriptions. Admin only.
|
|
49
51
|
# @param workspace_uuid UUID of the workspace.
|
|
50
52
|
# @param [Hash] opts the optional parameters
|
|
53
|
+
# @option opts [CancelSubscriptionRequest] :cancel_subscription_request
|
|
51
54
|
# @return [Object]
|
|
52
55
|
describe 'cancel_subscription test' do
|
|
53
56
|
it 'should work' do
|
|
@@ -57,6 +60,7 @@ describe 'SubscriptionsApi' do
|
|
|
57
60
|
|
|
58
61
|
# unit tests for change_subscription_plan
|
|
59
62
|
# Change subscription plan
|
|
63
|
+
# Switches the workspace to a different Stripe plan. Optionally prorates the change and bills immediately. Admin only.
|
|
60
64
|
# @param workspace_uuid UUID of the workspace.
|
|
61
65
|
# @param change_subscription_plan_request
|
|
62
66
|
# @param [Hash] opts the optional parameters
|
|
@@ -82,6 +86,7 @@ describe 'SubscriptionsApi' do
|
|
|
82
86
|
|
|
83
87
|
# unit tests for create_subscription
|
|
84
88
|
# Create subscription
|
|
89
|
+
# Manually creates a subscription record for the workspace (for external billing integrations). Admin only.
|
|
85
90
|
# @param workspace_uuid UUID of the workspace.
|
|
86
91
|
# @param subscription_input
|
|
87
92
|
# @param [Hash] opts the optional parameters
|
|
@@ -94,6 +99,7 @@ describe 'SubscriptionsApi' do
|
|
|
94
99
|
|
|
95
100
|
# unit tests for delete_subscription
|
|
96
101
|
# Delete subscription
|
|
102
|
+
# Removes the subscription record from the workspace. Admin only.
|
|
97
103
|
# @param workspace_uuid UUID of the workspace.
|
|
98
104
|
# @param [Hash] opts the optional parameters
|
|
99
105
|
# @return [Object]
|
|
@@ -105,6 +111,7 @@ describe 'SubscriptionsApi' do
|
|
|
105
111
|
|
|
106
112
|
# unit tests for get_subscription
|
|
107
113
|
# Get subscription
|
|
114
|
+
# Returns the active subscription for the workspace, or `null` if none exists. Admin only.
|
|
108
115
|
# @param workspace_uuid UUID of the workspace.
|
|
109
116
|
# @param [Hash] opts the optional parameters
|
|
110
117
|
# @return [Subscription]
|
|
@@ -116,6 +123,7 @@ describe 'SubscriptionsApi' do
|
|
|
116
123
|
|
|
117
124
|
# unit tests for remove_generic_subscription
|
|
118
125
|
# Remove generic subscription
|
|
126
|
+
# Removes the generic (non-Stripe) subscription from the workspace. Returns `422` when the workspace has no generic subscription. Admin only.
|
|
119
127
|
# @param workspace_uuid UUID of the workspace.
|
|
120
128
|
# @param [Hash] opts the optional parameters
|
|
121
129
|
# @return [Object]
|
|
@@ -127,6 +135,7 @@ describe 'SubscriptionsApi' do
|
|
|
127
135
|
|
|
128
136
|
# unit tests for resume_subscription
|
|
129
137
|
# Resume subscription
|
|
138
|
+
# Resumes a previously canceled subscription before it expires. Admin only.
|
|
130
139
|
# @param workspace_uuid UUID of the workspace.
|
|
131
140
|
# @param [Hash] opts the optional parameters
|
|
132
141
|
# @return [Object]
|
|
@@ -138,6 +147,7 @@ describe 'SubscriptionsApi' do
|
|
|
138
147
|
|
|
139
148
|
# unit tests for update_subscription
|
|
140
149
|
# Update subscription
|
|
150
|
+
# Updates the plan ID, status, or trial/pause dates of an existing subscription. Admin only.
|
|
141
151
|
# @param workspace_uuid UUID of the workspace.
|
|
142
152
|
# @param subscription_update_input
|
|
143
153
|
# @param [Hash] opts the optional parameters
|
data/spec/api/tags_api_spec.rb
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#PostBoost API
|
|
3
3
|
|
|
4
|
-
#The PostBoost REST API lets you publish, schedule, and analyze social media posts across
|
|
4
|
+
#The PostBoost REST API lets you publish, schedule, and analyze social media posts across 12+ platforms from a single integration. No OAuth apps to maintain — PostBoost handles platform authorization for you. ## Base URL All workspace-scoped endpoints are prefixed with `/{workspaceUuid}`. Panel/admin endpoints are prefixed with `/panel`. ## Plan access Every workspace-scoped endpoint returns `403` when the workspace's plan does not include API access (capability `api`). ## Dates and times Post dates and times (`date`, `time`, `accounts_schedule`) are read in the request's `timezone` when one is given, otherwise in the workspace timezone. ## Authentication All requests require a Bearer token in the `Authorization` header. Generate tokens in your PostBoost dashboard under **Settings → Access Tokens**. ``` Authorization: Bearer YOUR_API_TOKEN ```
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: 1.
|
|
6
|
+
The version of the OpenAPI document: 1.8.0
|
|
7
7
|
Contact: hi@postboost.co
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
Generator version: 7.9.0
|
|
@@ -34,6 +34,7 @@ describe 'TagsApi' do
|
|
|
34
34
|
|
|
35
35
|
# unit tests for create_tag
|
|
36
36
|
# Create tag
|
|
37
|
+
# Creates a new color-coded tag in the workspace for organizing posts.
|
|
37
38
|
# @param workspace_uuid UUID of the workspace.
|
|
38
39
|
# @param tag_input
|
|
39
40
|
# @param [Hash] opts the optional parameters
|
|
@@ -46,6 +47,7 @@ describe 'TagsApi' do
|
|
|
46
47
|
|
|
47
48
|
# unit tests for delete_tag
|
|
48
49
|
# Delete tag
|
|
50
|
+
# Permanently deletes a tag. Posts that had this tag attached are unaffected.
|
|
49
51
|
# @param workspace_uuid UUID of the workspace.
|
|
50
52
|
# @param tag_uuid UUID of the tag.
|
|
51
53
|
# @param [Hash] opts the optional parameters
|
|
@@ -58,6 +60,7 @@ describe 'TagsApi' do
|
|
|
58
60
|
|
|
59
61
|
# unit tests for get_tag
|
|
60
62
|
# Get tag
|
|
63
|
+
# Returns a single tag by UUID.
|
|
61
64
|
# @param workspace_uuid UUID of the workspace.
|
|
62
65
|
# @param tag_uuid UUID of the tag.
|
|
63
66
|
# @param [Hash] opts the optional parameters
|
|
@@ -70,6 +73,7 @@ describe 'TagsApi' do
|
|
|
70
73
|
|
|
71
74
|
# unit tests for list_tags
|
|
72
75
|
# List tags
|
|
76
|
+
# Returns all tags defined in the workspace.
|
|
73
77
|
# @param workspace_uuid UUID of the workspace.
|
|
74
78
|
# @param [Hash] opts the optional parameters
|
|
75
79
|
# @return [ListTags200Response]
|
|
@@ -81,6 +85,7 @@ describe 'TagsApi' do
|
|
|
81
85
|
|
|
82
86
|
# unit tests for update_tag
|
|
83
87
|
# Update tag
|
|
88
|
+
# Updates a tag's name or color.
|
|
84
89
|
# @param workspace_uuid UUID of the workspace.
|
|
85
90
|
# @param tag_uuid UUID of the tag.
|
|
86
91
|
# @param tag_input
|
data/spec/api/users_api_spec.rb
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#PostBoost API
|
|
3
3
|
|
|
4
|
-
#The PostBoost REST API lets you publish, schedule, and analyze social media posts across
|
|
4
|
+
#The PostBoost REST API lets you publish, schedule, and analyze social media posts across 12+ platforms from a single integration. No OAuth apps to maintain — PostBoost handles platform authorization for you. ## Base URL All workspace-scoped endpoints are prefixed with `/{workspaceUuid}`. Panel/admin endpoints are prefixed with `/panel`. ## Plan access Every workspace-scoped endpoint returns `403` when the workspace's plan does not include API access (capability `api`). ## Dates and times Post dates and times (`date`, `time`, `accounts_schedule`) are read in the request's `timezone` when one is given, otherwise in the workspace timezone. ## Authentication All requests require a Bearer token in the `Authorization` header. Generate tokens in your PostBoost dashboard under **Settings → Access Tokens**. ``` Authorization: Bearer YOUR_API_TOKEN ```
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: 1.
|
|
6
|
+
The version of the OpenAPI document: 1.8.0
|
|
7
7
|
Contact: hi@postboost.co
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
Generator version: 7.9.0
|
|
@@ -34,6 +34,7 @@ describe 'UsersApi' do
|
|
|
34
34
|
|
|
35
35
|
# unit tests for create_user
|
|
36
36
|
# Create user
|
|
37
|
+
# Creates a new user account on the platform. Admin only.
|
|
37
38
|
# @param user_input
|
|
38
39
|
# @param [Hash] opts the optional parameters
|
|
39
40
|
# @return [User]
|
|
@@ -45,6 +46,7 @@ describe 'UsersApi' do
|
|
|
45
46
|
|
|
46
47
|
# unit tests for delete_user
|
|
47
48
|
# Delete user
|
|
49
|
+
# Permanently deletes a user account. Returns 400 if you attempt to delete your own account. Admin only.
|
|
48
50
|
# @param user_id ID of the user.
|
|
49
51
|
# @param [Hash] opts the optional parameters
|
|
50
52
|
# @return [Object]
|
|
@@ -56,6 +58,7 @@ describe 'UsersApi' do
|
|
|
56
58
|
|
|
57
59
|
# unit tests for delete_users_bulk
|
|
58
60
|
# Delete users (bulk)
|
|
61
|
+
# Permanently deletes one or more user accounts. You cannot delete your own account. Admin only.
|
|
59
62
|
# @param delete_users_bulk_request
|
|
60
63
|
# @param [Hash] opts the optional parameters
|
|
61
64
|
# @return [Object]
|
|
@@ -67,6 +70,7 @@ describe 'UsersApi' do
|
|
|
67
70
|
|
|
68
71
|
# unit tests for get_user
|
|
69
72
|
# Get user
|
|
73
|
+
# Returns a single user account by ID. Admin only.
|
|
70
74
|
# @param user_id ID of the user.
|
|
71
75
|
# @param [Hash] opts the optional parameters
|
|
72
76
|
# @return [User]
|
|
@@ -78,8 +82,10 @@ describe 'UsersApi' do
|
|
|
78
82
|
|
|
79
83
|
# unit tests for list_users
|
|
80
84
|
# List users
|
|
85
|
+
# Returns a paginated list of all users on the platform. Optionally filter by name or email. Admin only.
|
|
81
86
|
# @param [Hash] opts the optional parameters
|
|
82
87
|
# @option opts [String] :keyword Search by name or email.
|
|
88
|
+
# @option opts [Integer] :page Page number (15 items per page).
|
|
83
89
|
# @return [ListUsers200Response]
|
|
84
90
|
describe 'list_users test' do
|
|
85
91
|
it 'should work' do
|
|
@@ -89,6 +95,7 @@ describe 'UsersApi' do
|
|
|
89
95
|
|
|
90
96
|
# unit tests for update_user
|
|
91
97
|
# Update user
|
|
98
|
+
# Updates a user's name, email, admin status, or password. Admin only.
|
|
92
99
|
# @param user_id ID of the user.
|
|
93
100
|
# @param user_update_input
|
|
94
101
|
# @param [Hash] opts the optional parameters
|