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
|
@@ -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
|
|
@@ -20,6 +20,7 @@ module PostBoost
|
|
|
20
20
|
@api_client = api_client
|
|
21
21
|
end
|
|
22
22
|
# Create tag
|
|
23
|
+
# Creates a new color-coded tag in the workspace for organizing posts.
|
|
23
24
|
# @param workspace_uuid [String] UUID of the workspace.
|
|
24
25
|
# @param tag_input [TagInput]
|
|
25
26
|
# @param [Hash] opts the optional parameters
|
|
@@ -30,6 +31,7 @@ module PostBoost
|
|
|
30
31
|
end
|
|
31
32
|
|
|
32
33
|
# Create tag
|
|
34
|
+
# Creates a new color-coded tag in the workspace for organizing posts.
|
|
33
35
|
# @param workspace_uuid [String] UUID of the workspace.
|
|
34
36
|
# @param tag_input [TagInput]
|
|
35
37
|
# @param [Hash] opts the optional parameters
|
|
@@ -92,6 +94,7 @@ module PostBoost
|
|
|
92
94
|
end
|
|
93
95
|
|
|
94
96
|
# Delete tag
|
|
97
|
+
# Permanently deletes a tag. Posts that had this tag attached are unaffected.
|
|
95
98
|
# @param workspace_uuid [String] UUID of the workspace.
|
|
96
99
|
# @param tag_uuid [String] UUID of the tag.
|
|
97
100
|
# @param [Hash] opts the optional parameters
|
|
@@ -102,6 +105,7 @@ module PostBoost
|
|
|
102
105
|
end
|
|
103
106
|
|
|
104
107
|
# Delete tag
|
|
108
|
+
# Permanently deletes a tag. Posts that had this tag attached are unaffected.
|
|
105
109
|
# @param workspace_uuid [String] UUID of the workspace.
|
|
106
110
|
# @param tag_uuid [String] UUID of the tag.
|
|
107
111
|
# @param [Hash] opts the optional parameters
|
|
@@ -159,6 +163,7 @@ module PostBoost
|
|
|
159
163
|
end
|
|
160
164
|
|
|
161
165
|
# Get tag
|
|
166
|
+
# Returns a single tag by UUID.
|
|
162
167
|
# @param workspace_uuid [String] UUID of the workspace.
|
|
163
168
|
# @param tag_uuid [String] UUID of the tag.
|
|
164
169
|
# @param [Hash] opts the optional parameters
|
|
@@ -169,6 +174,7 @@ module PostBoost
|
|
|
169
174
|
end
|
|
170
175
|
|
|
171
176
|
# Get tag
|
|
177
|
+
# Returns a single tag by UUID.
|
|
172
178
|
# @param workspace_uuid [String] UUID of the workspace.
|
|
173
179
|
# @param tag_uuid [String] UUID of the tag.
|
|
174
180
|
# @param [Hash] opts the optional parameters
|
|
@@ -226,6 +232,7 @@ module PostBoost
|
|
|
226
232
|
end
|
|
227
233
|
|
|
228
234
|
# List tags
|
|
235
|
+
# Returns all tags defined in the workspace.
|
|
229
236
|
# @param workspace_uuid [String] UUID of the workspace.
|
|
230
237
|
# @param [Hash] opts the optional parameters
|
|
231
238
|
# @return [ListTags200Response]
|
|
@@ -235,6 +242,7 @@ module PostBoost
|
|
|
235
242
|
end
|
|
236
243
|
|
|
237
244
|
# List tags
|
|
245
|
+
# Returns all tags defined in the workspace.
|
|
238
246
|
# @param workspace_uuid [String] UUID of the workspace.
|
|
239
247
|
# @param [Hash] opts the optional parameters
|
|
240
248
|
# @return [Array<(ListTags200Response, Integer, Hash)>] ListTags200Response data, response status code and response headers
|
|
@@ -287,6 +295,7 @@ module PostBoost
|
|
|
287
295
|
end
|
|
288
296
|
|
|
289
297
|
# Update tag
|
|
298
|
+
# Updates a tag's name or color.
|
|
290
299
|
# @param workspace_uuid [String] UUID of the workspace.
|
|
291
300
|
# @param tag_uuid [String] UUID of the tag.
|
|
292
301
|
# @param tag_input [TagInput]
|
|
@@ -298,6 +307,7 @@ module PostBoost
|
|
|
298
307
|
end
|
|
299
308
|
|
|
300
309
|
# Update tag
|
|
310
|
+
# Updates a tag's name or color.
|
|
301
311
|
# @param workspace_uuid [String] UUID of the workspace.
|
|
302
312
|
# @param tag_uuid [String] UUID of the tag.
|
|
303
313
|
# @param tag_input [TagInput]
|
|
@@ -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
|
|
@@ -20,6 +20,7 @@ module PostBoost
|
|
|
20
20
|
@api_client = api_client
|
|
21
21
|
end
|
|
22
22
|
# Create user
|
|
23
|
+
# Creates a new user account on the platform. Admin only.
|
|
23
24
|
# @param user_input [UserInput]
|
|
24
25
|
# @param [Hash] opts the optional parameters
|
|
25
26
|
# @return [User]
|
|
@@ -29,6 +30,7 @@ module PostBoost
|
|
|
29
30
|
end
|
|
30
31
|
|
|
31
32
|
# Create user
|
|
33
|
+
# Creates a new user account on the platform. Admin only.
|
|
32
34
|
# @param user_input [UserInput]
|
|
33
35
|
# @param [Hash] opts the optional parameters
|
|
34
36
|
# @return [Array<(User, Integer, Hash)>] User data, response status code and response headers
|
|
@@ -86,6 +88,7 @@ module PostBoost
|
|
|
86
88
|
end
|
|
87
89
|
|
|
88
90
|
# Delete user
|
|
91
|
+
# Permanently deletes a user account. Returns 400 if you attempt to delete your own account. Admin only.
|
|
89
92
|
# @param user_id [Integer] ID of the user.
|
|
90
93
|
# @param [Hash] opts the optional parameters
|
|
91
94
|
# @return [Object]
|
|
@@ -95,6 +98,7 @@ module PostBoost
|
|
|
95
98
|
end
|
|
96
99
|
|
|
97
100
|
# Delete user
|
|
101
|
+
# Permanently deletes a user account. Returns 400 if you attempt to delete your own account. Admin only.
|
|
98
102
|
# @param user_id [Integer] ID of the user.
|
|
99
103
|
# @param [Hash] opts the optional parameters
|
|
100
104
|
# @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
|
|
@@ -147,6 +151,7 @@ module PostBoost
|
|
|
147
151
|
end
|
|
148
152
|
|
|
149
153
|
# Delete users (bulk)
|
|
154
|
+
# Permanently deletes one or more user accounts. You cannot delete your own account. Admin only.
|
|
150
155
|
# @param delete_users_bulk_request [DeleteUsersBulkRequest]
|
|
151
156
|
# @param [Hash] opts the optional parameters
|
|
152
157
|
# @return [Object]
|
|
@@ -156,6 +161,7 @@ module PostBoost
|
|
|
156
161
|
end
|
|
157
162
|
|
|
158
163
|
# Delete users (bulk)
|
|
164
|
+
# Permanently deletes one or more user accounts. You cannot delete your own account. Admin only.
|
|
159
165
|
# @param delete_users_bulk_request [DeleteUsersBulkRequest]
|
|
160
166
|
# @param [Hash] opts the optional parameters
|
|
161
167
|
# @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
|
|
@@ -213,6 +219,7 @@ module PostBoost
|
|
|
213
219
|
end
|
|
214
220
|
|
|
215
221
|
# Get user
|
|
222
|
+
# Returns a single user account by ID. Admin only.
|
|
216
223
|
# @param user_id [Integer] ID of the user.
|
|
217
224
|
# @param [Hash] opts the optional parameters
|
|
218
225
|
# @return [User]
|
|
@@ -222,6 +229,7 @@ module PostBoost
|
|
|
222
229
|
end
|
|
223
230
|
|
|
224
231
|
# Get user
|
|
232
|
+
# Returns a single user account by ID. Admin only.
|
|
225
233
|
# @param user_id [Integer] ID of the user.
|
|
226
234
|
# @param [Hash] opts the optional parameters
|
|
227
235
|
# @return [Array<(User, Integer, Hash)>] User data, response status code and response headers
|
|
@@ -274,8 +282,10 @@ module PostBoost
|
|
|
274
282
|
end
|
|
275
283
|
|
|
276
284
|
# List users
|
|
285
|
+
# Returns a paginated list of all users on the platform. Optionally filter by name or email. Admin only.
|
|
277
286
|
# @param [Hash] opts the optional parameters
|
|
278
287
|
# @option opts [String] :keyword Search by name or email.
|
|
288
|
+
# @option opts [Integer] :page Page number (15 items per page). (default to 1)
|
|
279
289
|
# @return [ListUsers200Response]
|
|
280
290
|
def list_users(opts = {})
|
|
281
291
|
data, _status_code, _headers = list_users_with_http_info(opts)
|
|
@@ -283,8 +293,10 @@ module PostBoost
|
|
|
283
293
|
end
|
|
284
294
|
|
|
285
295
|
# List users
|
|
296
|
+
# Returns a paginated list of all users on the platform. Optionally filter by name or email. Admin only.
|
|
286
297
|
# @param [Hash] opts the optional parameters
|
|
287
298
|
# @option opts [String] :keyword Search by name or email.
|
|
299
|
+
# @option opts [Integer] :page Page number (15 items per page). (default to 1)
|
|
288
300
|
# @return [Array<(ListUsers200Response, Integer, Hash)>] ListUsers200Response data, response status code and response headers
|
|
289
301
|
def list_users_with_http_info(opts = {})
|
|
290
302
|
if @api_client.config.debugging
|
|
@@ -296,6 +308,7 @@ module PostBoost
|
|
|
296
308
|
# query parameters
|
|
297
309
|
query_params = opts[:query_params] || {}
|
|
298
310
|
query_params[:'keyword'] = opts[:'keyword'] if !opts[:'keyword'].nil?
|
|
311
|
+
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
|
299
312
|
|
|
300
313
|
# header parameters
|
|
301
314
|
header_params = opts[:header_params] || {}
|
|
@@ -332,6 +345,7 @@ module PostBoost
|
|
|
332
345
|
end
|
|
333
346
|
|
|
334
347
|
# Update user
|
|
348
|
+
# Updates a user's name, email, admin status, or password. Admin only.
|
|
335
349
|
# @param user_id [Integer] ID of the user.
|
|
336
350
|
# @param user_update_input [UserUpdateInput]
|
|
337
351
|
# @param [Hash] opts the optional parameters
|
|
@@ -342,6 +356,7 @@ module PostBoost
|
|
|
342
356
|
end
|
|
343
357
|
|
|
344
358
|
# Update user
|
|
359
|
+
# Updates a user's name, email, admin status, or password. Admin only.
|
|
345
360
|
# @param user_id [Integer] ID of the user.
|
|
346
361
|
# @param user_update_input [UserUpdateInput]
|
|
347
362
|
# @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
|
|
@@ -20,6 +20,7 @@ module PostBoost
|
|
|
20
20
|
@api_client = api_client
|
|
21
21
|
end
|
|
22
22
|
# Add user to workspace
|
|
23
|
+
# Adds an existing user to the workspace with a specified role. Admin only.
|
|
23
24
|
# @param workspace_uuid [String] UUID of the workspace.
|
|
24
25
|
# @param workspace_user_input [WorkspaceUserInput]
|
|
25
26
|
# @param [Hash] opts the optional parameters
|
|
@@ -30,6 +31,7 @@ module PostBoost
|
|
|
30
31
|
end
|
|
31
32
|
|
|
32
33
|
# Add user to workspace
|
|
34
|
+
# Adds an existing user to the workspace with a specified role. Admin only.
|
|
33
35
|
# @param workspace_uuid [String] UUID of the workspace.
|
|
34
36
|
# @param workspace_user_input [WorkspaceUserInput]
|
|
35
37
|
# @param [Hash] opts the optional parameters
|
|
@@ -160,6 +162,7 @@ module PostBoost
|
|
|
160
162
|
end
|
|
161
163
|
|
|
162
164
|
# Delete workspace
|
|
165
|
+
# Permanently deletes a single workspace and all its associated data. Admin only.
|
|
163
166
|
# @param workspace_uuid [String] UUID of the workspace.
|
|
164
167
|
# @param [Hash] opts the optional parameters
|
|
165
168
|
# @return [Object]
|
|
@@ -169,6 +172,7 @@ module PostBoost
|
|
|
169
172
|
end
|
|
170
173
|
|
|
171
174
|
# Delete workspace
|
|
175
|
+
# Permanently deletes a single workspace and all its associated data. Admin only.
|
|
172
176
|
# @param workspace_uuid [String] UUID of the workspace.
|
|
173
177
|
# @param [Hash] opts the optional parameters
|
|
174
178
|
# @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
|
|
@@ -221,6 +225,7 @@ module PostBoost
|
|
|
221
225
|
end
|
|
222
226
|
|
|
223
227
|
# Delete workspaces (bulk)
|
|
228
|
+
# Permanently deletes one or more workspaces and all their associated data. Admin only.
|
|
224
229
|
# @param delete_workspaces_bulk_request [DeleteWorkspacesBulkRequest]
|
|
225
230
|
# @param [Hash] opts the optional parameters
|
|
226
231
|
# @return [Object]
|
|
@@ -230,6 +235,7 @@ module PostBoost
|
|
|
230
235
|
end
|
|
231
236
|
|
|
232
237
|
# Delete workspaces (bulk)
|
|
238
|
+
# Permanently deletes one or more workspaces and all their associated data. Admin only.
|
|
233
239
|
# @param delete_workspaces_bulk_request [DeleteWorkspacesBulkRequest]
|
|
234
240
|
# @param [Hash] opts the optional parameters
|
|
235
241
|
# @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
|
|
@@ -287,6 +293,7 @@ module PostBoost
|
|
|
287
293
|
end
|
|
288
294
|
|
|
289
295
|
# Get workspace
|
|
296
|
+
# Returns a single workspace by UUID including its subscription status. Admin only.
|
|
290
297
|
# @param workspace_uuid [String] UUID of the workspace.
|
|
291
298
|
# @param [Hash] opts the optional parameters
|
|
292
299
|
# @return [Workspace]
|
|
@@ -296,6 +303,7 @@ module PostBoost
|
|
|
296
303
|
end
|
|
297
304
|
|
|
298
305
|
# Get workspace
|
|
306
|
+
# Returns a single workspace by UUID including its subscription status. Admin only.
|
|
299
307
|
# @param workspace_uuid [String] UUID of the workspace.
|
|
300
308
|
# @param [Hash] opts the optional parameters
|
|
301
309
|
# @return [Array<(Workspace, Integer, Hash)>] Workspace data, response status code and response headers
|
|
@@ -347,12 +355,133 @@ module PostBoost
|
|
|
347
355
|
return data, status_code, headers
|
|
348
356
|
end
|
|
349
357
|
|
|
358
|
+
# Get workspace AI credits
|
|
359
|
+
# Returns whether the workspace can use AI credits, its remaining balance, and whether the balance is low. Admin only.
|
|
360
|
+
# @param workspace_uuid [String] UUID of the workspace.
|
|
361
|
+
# @param [Hash] opts the optional parameters
|
|
362
|
+
# @return [AICredits]
|
|
363
|
+
def get_workspace_ai_credits(workspace_uuid, opts = {})
|
|
364
|
+
data, _status_code, _headers = get_workspace_ai_credits_with_http_info(workspace_uuid, opts)
|
|
365
|
+
data
|
|
366
|
+
end
|
|
367
|
+
|
|
368
|
+
# Get workspace AI credits
|
|
369
|
+
# Returns whether the workspace can use AI credits, its remaining balance, and whether the balance is low. Admin only.
|
|
370
|
+
# @param workspace_uuid [String] UUID of the workspace.
|
|
371
|
+
# @param [Hash] opts the optional parameters
|
|
372
|
+
# @return [Array<(AICredits, Integer, Hash)>] AICredits data, response status code and response headers
|
|
373
|
+
def get_workspace_ai_credits_with_http_info(workspace_uuid, opts = {})
|
|
374
|
+
if @api_client.config.debugging
|
|
375
|
+
@api_client.config.logger.debug 'Calling API: WorkspacesApi.get_workspace_ai_credits ...'
|
|
376
|
+
end
|
|
377
|
+
# verify the required parameter 'workspace_uuid' is set
|
|
378
|
+
if @api_client.config.client_side_validation && workspace_uuid.nil?
|
|
379
|
+
fail ArgumentError, "Missing the required parameter 'workspace_uuid' when calling WorkspacesApi.get_workspace_ai_credits"
|
|
380
|
+
end
|
|
381
|
+
# resource path
|
|
382
|
+
local_var_path = '/panel/workspaces/{workspaceUuid}/ai-credits'.sub('{' + 'workspaceUuid' + '}', CGI.escape(workspace_uuid.to_s))
|
|
383
|
+
|
|
384
|
+
# query parameters
|
|
385
|
+
query_params = opts[:query_params] || {}
|
|
386
|
+
|
|
387
|
+
# header parameters
|
|
388
|
+
header_params = opts[:header_params] || {}
|
|
389
|
+
# HTTP header 'Accept' (if needed)
|
|
390
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
391
|
+
|
|
392
|
+
# form parameters
|
|
393
|
+
form_params = opts[:form_params] || {}
|
|
394
|
+
|
|
395
|
+
# http body (model)
|
|
396
|
+
post_body = opts[:debug_body]
|
|
397
|
+
|
|
398
|
+
# return_type
|
|
399
|
+
return_type = opts[:debug_return_type] || 'AICredits'
|
|
400
|
+
|
|
401
|
+
# auth_names
|
|
402
|
+
auth_names = opts[:debug_auth_names] || ['bearerAuth']
|
|
403
|
+
|
|
404
|
+
new_options = opts.merge(
|
|
405
|
+
:operation => :"WorkspacesApi.get_workspace_ai_credits",
|
|
406
|
+
:header_params => header_params,
|
|
407
|
+
:query_params => query_params,
|
|
408
|
+
:form_params => form_params,
|
|
409
|
+
:body => post_body,
|
|
410
|
+
:auth_names => auth_names,
|
|
411
|
+
:return_type => return_type
|
|
412
|
+
)
|
|
413
|
+
|
|
414
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
415
|
+
if @api_client.config.debugging
|
|
416
|
+
@api_client.config.logger.debug "API called: WorkspacesApi#get_workspace_ai_credits\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
417
|
+
end
|
|
418
|
+
return data, status_code, headers
|
|
419
|
+
end
|
|
420
|
+
|
|
421
|
+
# List my workspaces
|
|
422
|
+
# Returns the workspaces the authenticated user belongs to, most recently updated first, with the caller's role in each. Use a returned `uuid` as `workspaceUuid`.
|
|
423
|
+
# @param [Hash] opts the optional parameters
|
|
424
|
+
# @return [ListMyWorkspaces200Response]
|
|
425
|
+
def list_my_workspaces(opts = {})
|
|
426
|
+
data, _status_code, _headers = list_my_workspaces_with_http_info(opts)
|
|
427
|
+
data
|
|
428
|
+
end
|
|
429
|
+
|
|
430
|
+
# List my workspaces
|
|
431
|
+
# Returns the workspaces the authenticated user belongs to, most recently updated first, with the caller's role in each. Use a returned `uuid` as `workspaceUuid`.
|
|
432
|
+
# @param [Hash] opts the optional parameters
|
|
433
|
+
# @return [Array<(ListMyWorkspaces200Response, Integer, Hash)>] ListMyWorkspaces200Response data, response status code and response headers
|
|
434
|
+
def list_my_workspaces_with_http_info(opts = {})
|
|
435
|
+
if @api_client.config.debugging
|
|
436
|
+
@api_client.config.logger.debug 'Calling API: WorkspacesApi.list_my_workspaces ...'
|
|
437
|
+
end
|
|
438
|
+
# resource path
|
|
439
|
+
local_var_path = '/workspaces'
|
|
440
|
+
|
|
441
|
+
# query parameters
|
|
442
|
+
query_params = opts[:query_params] || {}
|
|
443
|
+
|
|
444
|
+
# header parameters
|
|
445
|
+
header_params = opts[:header_params] || {}
|
|
446
|
+
# HTTP header 'Accept' (if needed)
|
|
447
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
448
|
+
|
|
449
|
+
# form parameters
|
|
450
|
+
form_params = opts[:form_params] || {}
|
|
451
|
+
|
|
452
|
+
# http body (model)
|
|
453
|
+
post_body = opts[:debug_body]
|
|
454
|
+
|
|
455
|
+
# return_type
|
|
456
|
+
return_type = opts[:debug_return_type] || 'ListMyWorkspaces200Response'
|
|
457
|
+
|
|
458
|
+
# auth_names
|
|
459
|
+
auth_names = opts[:debug_auth_names] || ['bearerAuth']
|
|
460
|
+
|
|
461
|
+
new_options = opts.merge(
|
|
462
|
+
:operation => :"WorkspacesApi.list_my_workspaces",
|
|
463
|
+
:header_params => header_params,
|
|
464
|
+
:query_params => query_params,
|
|
465
|
+
:form_params => form_params,
|
|
466
|
+
:body => post_body,
|
|
467
|
+
:auth_names => auth_names,
|
|
468
|
+
:return_type => return_type
|
|
469
|
+
)
|
|
470
|
+
|
|
471
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
472
|
+
if @api_client.config.debugging
|
|
473
|
+
@api_client.config.logger.debug "API called: WorkspacesApi#list_my_workspaces\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
474
|
+
end
|
|
475
|
+
return data, status_code, headers
|
|
476
|
+
end
|
|
477
|
+
|
|
350
478
|
# List workspaces
|
|
351
479
|
# Returns a paginated list of all workspaces. Admin only.
|
|
352
480
|
# @param [Hash] opts the optional parameters
|
|
353
481
|
# @option opts [String] :keyword
|
|
354
482
|
# @option opts [String] :subscription_status
|
|
355
483
|
# @option opts [String] :access_status
|
|
484
|
+
# @option opts [Integer] :page Page number (15 items per page). (default to 1)
|
|
356
485
|
# @return [ListWorkspaces200Response]
|
|
357
486
|
def list_workspaces(opts = {})
|
|
358
487
|
data, _status_code, _headers = list_workspaces_with_http_info(opts)
|
|
@@ -365,6 +494,7 @@ module PostBoost
|
|
|
365
494
|
# @option opts [String] :keyword
|
|
366
495
|
# @option opts [String] :subscription_status
|
|
367
496
|
# @option opts [String] :access_status
|
|
497
|
+
# @option opts [Integer] :page Page number (15 items per page). (default to 1)
|
|
368
498
|
# @return [Array<(ListWorkspaces200Response, Integer, Hash)>] ListWorkspaces200Response data, response status code and response headers
|
|
369
499
|
def list_workspaces_with_http_info(opts = {})
|
|
370
500
|
if @api_client.config.debugging
|
|
@@ -386,6 +516,7 @@ module PostBoost
|
|
|
386
516
|
query_params[:'keyword'] = opts[:'keyword'] if !opts[:'keyword'].nil?
|
|
387
517
|
query_params[:'subscription_status'] = opts[:'subscription_status'] if !opts[:'subscription_status'].nil?
|
|
388
518
|
query_params[:'access_status'] = opts[:'access_status'] if !opts[:'access_status'].nil?
|
|
519
|
+
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
|
389
520
|
|
|
390
521
|
# header parameters
|
|
391
522
|
header_params = opts[:header_params] || {}
|
|
@@ -422,6 +553,7 @@ module PostBoost
|
|
|
422
553
|
end
|
|
423
554
|
|
|
424
555
|
# Remove user from workspace
|
|
556
|
+
# Removes a user's access to the workspace. The user account is not deleted. Admin only.
|
|
425
557
|
# @param workspace_uuid [String] UUID of the workspace.
|
|
426
558
|
# @param remove_user_from_workspace_request [RemoveUserFromWorkspaceRequest]
|
|
427
559
|
# @param [Hash] opts the optional parameters
|
|
@@ -432,6 +564,7 @@ module PostBoost
|
|
|
432
564
|
end
|
|
433
565
|
|
|
434
566
|
# Remove user from workspace
|
|
567
|
+
# Removes a user's access to the workspace. The user account is not deleted. Admin only.
|
|
435
568
|
# @param workspace_uuid [String] UUID of the workspace.
|
|
436
569
|
# @param remove_user_from_workspace_request [RemoveUserFromWorkspaceRequest]
|
|
437
570
|
# @param [Hash] opts the optional parameters
|
|
@@ -494,6 +627,7 @@ module PostBoost
|
|
|
494
627
|
end
|
|
495
628
|
|
|
496
629
|
# Update workspace
|
|
630
|
+
# Updates a workspace's name, owner, or access status. Admin only. `hex_color` is accepted but ignored.
|
|
497
631
|
# @param workspace_uuid [String] UUID of the workspace.
|
|
498
632
|
# @param workspace_input [WorkspaceInput]
|
|
499
633
|
# @param [Hash] opts the optional parameters
|
|
@@ -504,6 +638,7 @@ module PostBoost
|
|
|
504
638
|
end
|
|
505
639
|
|
|
506
640
|
# Update workspace
|
|
641
|
+
# Updates a workspace's name, owner, or access status. Admin only. `hex_color` is accepted but ignored.
|
|
507
642
|
# @param workspace_uuid [String] UUID of the workspace.
|
|
508
643
|
# @param workspace_input [WorkspaceInput]
|
|
509
644
|
# @param [Hash] opts the optional parameters
|
|
@@ -566,6 +701,7 @@ module PostBoost
|
|
|
566
701
|
end
|
|
567
702
|
|
|
568
703
|
# Update user role in workspace
|
|
704
|
+
# Changes a user's role or permissions within the workspace. Admin only.
|
|
569
705
|
# @param workspace_uuid [String] UUID of the workspace.
|
|
570
706
|
# @param workspace_user_input [WorkspaceUserInput]
|
|
571
707
|
# @param [Hash] opts the optional parameters
|
|
@@ -576,6 +712,7 @@ module PostBoost
|
|
|
576
712
|
end
|
|
577
713
|
|
|
578
714
|
# Update user role in workspace
|
|
715
|
+
# Changes a user's role or permissions within the workspace. Admin only.
|
|
579
716
|
# @param workspace_uuid [String] UUID of the workspace.
|
|
580
717
|
# @param workspace_user_input [WorkspaceUserInput]
|
|
581
718
|
# @param [Hash] opts the optional parameters
|
data/lib/postboost/api_client.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
|
data/lib/postboost/api_error.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
|
|
@@ -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
|