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/docs/MediaApi.md
CHANGED
|
@@ -6,13 +6,17 @@ All URIs are relative to *https://postboost.co/app/api*
|
|
|
6
6
|
| ------ | ------------ | ----------- |
|
|
7
7
|
| [**abort_chunked_upload**](MediaApi.md#abort_chunked_upload) | **DELETE** /{workspaceUuid}/media/chunked/{uploadUuid} | Abort chunked upload |
|
|
8
8
|
| [**complete_chunked_upload**](MediaApi.md#complete_chunked_upload) | **POST** /{workspaceUuid}/media/chunked/{uploadUuid}/complete | Complete chunked upload |
|
|
9
|
+
| [**create_media_folder**](MediaApi.md#create_media_folder) | **POST** /{workspaceUuid}/media/folders | Create media folder |
|
|
9
10
|
| [**delete_media_bulk**](MediaApi.md#delete_media_bulk) | **DELETE** /{workspaceUuid}/media | Delete media (bulk) |
|
|
11
|
+
| [**delete_media_folder**](MediaApi.md#delete_media_folder) | **DELETE** /{workspaceUuid}/media/folders/{folderUuid} | Delete media folder |
|
|
10
12
|
| [**get_media**](MediaApi.md#get_media) | **GET** /{workspaceUuid}/media/{mediaUuid} | Get media |
|
|
11
13
|
| [**get_remote_upload_status**](MediaApi.md#get_remote_upload_status) | **GET** /{workspaceUuid}/media/remote/{downloadId}/status | Get remote upload status |
|
|
12
14
|
| [**initiate_chunked_upload**](MediaApi.md#initiate_chunked_upload) | **POST** /{workspaceUuid}/media/chunked/initiate | Initiate chunked upload |
|
|
13
15
|
| [**initiate_remote_upload**](MediaApi.md#initiate_remote_upload) | **POST** /{workspaceUuid}/media/remote/initiate | Initiate remote upload |
|
|
14
16
|
| [**list_media**](MediaApi.md#list_media) | **GET** /{workspaceUuid}/media | List media |
|
|
17
|
+
| [**list_media_folders**](MediaApi.md#list_media_folders) | **GET** /{workspaceUuid}/media/folders | List media folders |
|
|
15
18
|
| [**update_media**](MediaApi.md#update_media) | **PUT** /{workspaceUuid}/media/{mediaUuid} | Update media |
|
|
19
|
+
| [**update_media_folder**](MediaApi.md#update_media_folder) | **PUT** /{workspaceUuid}/media/folders/{folderUuid} | Update media folder |
|
|
16
20
|
| [**upload_chunk**](MediaApi.md#upload_chunk) | **POST** /{workspaceUuid}/media/chunked/{uploadUuid}/upload | Upload a chunk |
|
|
17
21
|
| [**upload_media**](MediaApi.md#upload_media) | **POST** /{workspaceUuid}/media | Upload media (binary) |
|
|
18
22
|
|
|
@@ -89,11 +93,11 @@ nil (empty response body)
|
|
|
89
93
|
|
|
90
94
|
## complete_chunked_upload
|
|
91
95
|
|
|
92
|
-
> <Media> complete_chunked_upload(workspace_uuid, upload_uuid)
|
|
96
|
+
> <Media> complete_chunked_upload(workspace_uuid, upload_uuid, opts)
|
|
93
97
|
|
|
94
98
|
Complete chunked upload
|
|
95
99
|
|
|
96
|
-
Signal that all chunks have been uploaded. Returns the final media object.
|
|
100
|
+
Signal that all chunks have been uploaded. Returns the final media object. A video may come back with `is_processing` set to `true` while its conversion runs.
|
|
97
101
|
|
|
98
102
|
### Examples
|
|
99
103
|
|
|
@@ -109,10 +113,13 @@ end
|
|
|
109
113
|
api_instance = PostBoost::MediaApi.new
|
|
110
114
|
workspace_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the workspace.
|
|
111
115
|
upload_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
|
116
|
+
opts = {
|
|
117
|
+
complete_chunked_upload_request: PostBoost::CompleteChunkedUploadRequest.new # CompleteChunkedUploadRequest |
|
|
118
|
+
}
|
|
112
119
|
|
|
113
120
|
begin
|
|
114
121
|
# Complete chunked upload
|
|
115
|
-
result = api_instance.complete_chunked_upload(workspace_uuid, upload_uuid)
|
|
122
|
+
result = api_instance.complete_chunked_upload(workspace_uuid, upload_uuid, opts)
|
|
116
123
|
p result
|
|
117
124
|
rescue PostBoost::ApiError => e
|
|
118
125
|
puts "Error when calling MediaApi->complete_chunked_upload: #{e}"
|
|
@@ -123,12 +130,12 @@ end
|
|
|
123
130
|
|
|
124
131
|
This returns an Array which contains the response data, status code and headers.
|
|
125
132
|
|
|
126
|
-
> <Array(<Media>, Integer, Hash)> complete_chunked_upload_with_http_info(workspace_uuid, upload_uuid)
|
|
133
|
+
> <Array(<Media>, Integer, Hash)> complete_chunked_upload_with_http_info(workspace_uuid, upload_uuid, opts)
|
|
127
134
|
|
|
128
135
|
```ruby
|
|
129
136
|
begin
|
|
130
137
|
# Complete chunked upload
|
|
131
|
-
data, status_code, headers = api_instance.complete_chunked_upload_with_http_info(workspace_uuid, upload_uuid)
|
|
138
|
+
data, status_code, headers = api_instance.complete_chunked_upload_with_http_info(workspace_uuid, upload_uuid, opts)
|
|
132
139
|
p status_code # => 2xx
|
|
133
140
|
p headers # => { ... }
|
|
134
141
|
p data # => <Media>
|
|
@@ -143,6 +150,7 @@ end
|
|
|
143
150
|
| ---- | ---- | ----------- | ----- |
|
|
144
151
|
| **workspace_uuid** | **String** | UUID of the workspace. | |
|
|
145
152
|
| **upload_uuid** | **String** | | |
|
|
153
|
+
| **complete_chunked_upload_request** | [**CompleteChunkedUploadRequest**](CompleteChunkedUploadRequest.md) | | [optional] |
|
|
146
154
|
|
|
147
155
|
### Return type
|
|
148
156
|
|
|
@@ -154,7 +162,78 @@ end
|
|
|
154
162
|
|
|
155
163
|
### HTTP request headers
|
|
156
164
|
|
|
157
|
-
- **Content-Type**:
|
|
165
|
+
- **Content-Type**: application/json
|
|
166
|
+
- **Accept**: application/json
|
|
167
|
+
|
|
168
|
+
|
|
169
|
+
## create_media_folder
|
|
170
|
+
|
|
171
|
+
> <MediaFolder> create_media_folder(workspace_uuid, create_media_folder_request)
|
|
172
|
+
|
|
173
|
+
Create media folder
|
|
174
|
+
|
|
175
|
+
Creates a folder at the top level or under `parent`. The name must be unique among its siblings.
|
|
176
|
+
|
|
177
|
+
### Examples
|
|
178
|
+
|
|
179
|
+
```ruby
|
|
180
|
+
require 'time'
|
|
181
|
+
require 'postboost'
|
|
182
|
+
# setup authorization
|
|
183
|
+
PostBoost.configure do |config|
|
|
184
|
+
# Configure Bearer authorization: bearerAuth
|
|
185
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
186
|
+
end
|
|
187
|
+
|
|
188
|
+
api_instance = PostBoost::MediaApi.new
|
|
189
|
+
workspace_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the workspace.
|
|
190
|
+
create_media_folder_request = PostBoost::CreateMediaFolderRequest.new({name: 'name_example'}) # CreateMediaFolderRequest |
|
|
191
|
+
|
|
192
|
+
begin
|
|
193
|
+
# Create media folder
|
|
194
|
+
result = api_instance.create_media_folder(workspace_uuid, create_media_folder_request)
|
|
195
|
+
p result
|
|
196
|
+
rescue PostBoost::ApiError => e
|
|
197
|
+
puts "Error when calling MediaApi->create_media_folder: #{e}"
|
|
198
|
+
end
|
|
199
|
+
```
|
|
200
|
+
|
|
201
|
+
#### Using the create_media_folder_with_http_info variant
|
|
202
|
+
|
|
203
|
+
This returns an Array which contains the response data, status code and headers.
|
|
204
|
+
|
|
205
|
+
> <Array(<MediaFolder>, Integer, Hash)> create_media_folder_with_http_info(workspace_uuid, create_media_folder_request)
|
|
206
|
+
|
|
207
|
+
```ruby
|
|
208
|
+
begin
|
|
209
|
+
# Create media folder
|
|
210
|
+
data, status_code, headers = api_instance.create_media_folder_with_http_info(workspace_uuid, create_media_folder_request)
|
|
211
|
+
p status_code # => 2xx
|
|
212
|
+
p headers # => { ... }
|
|
213
|
+
p data # => <MediaFolder>
|
|
214
|
+
rescue PostBoost::ApiError => e
|
|
215
|
+
puts "Error when calling MediaApi->create_media_folder_with_http_info: #{e}"
|
|
216
|
+
end
|
|
217
|
+
```
|
|
218
|
+
|
|
219
|
+
### Parameters
|
|
220
|
+
|
|
221
|
+
| Name | Type | Description | Notes |
|
|
222
|
+
| ---- | ---- | ----------- | ----- |
|
|
223
|
+
| **workspace_uuid** | **String** | UUID of the workspace. | |
|
|
224
|
+
| **create_media_folder_request** | [**CreateMediaFolderRequest**](CreateMediaFolderRequest.md) | | |
|
|
225
|
+
|
|
226
|
+
### Return type
|
|
227
|
+
|
|
228
|
+
[**MediaFolder**](MediaFolder.md)
|
|
229
|
+
|
|
230
|
+
### Authorization
|
|
231
|
+
|
|
232
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
233
|
+
|
|
234
|
+
### HTTP request headers
|
|
235
|
+
|
|
236
|
+
- **Content-Type**: application/json
|
|
158
237
|
- **Accept**: application/json
|
|
159
238
|
|
|
160
239
|
|
|
@@ -164,7 +243,7 @@ end
|
|
|
164
243
|
|
|
165
244
|
Delete media (bulk)
|
|
166
245
|
|
|
167
|
-
Delete one or more media items by their IDs.
|
|
246
|
+
Delete one or more media items by their numeric IDs or UUIDs (both may be mixed, up to 500 per request).
|
|
168
247
|
|
|
169
248
|
### Examples
|
|
170
249
|
|
|
@@ -179,7 +258,7 @@ end
|
|
|
179
258
|
|
|
180
259
|
api_instance = PostBoost::MediaApi.new
|
|
181
260
|
workspace_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the workspace.
|
|
182
|
-
delete_media_bulk_request = PostBoost::DeleteMediaBulkRequest.new({items: [
|
|
261
|
+
delete_media_bulk_request = PostBoost::DeleteMediaBulkRequest.new({items: [nil]}) # DeleteMediaBulkRequest |
|
|
183
262
|
|
|
184
263
|
begin
|
|
185
264
|
# Delete media (bulk)
|
|
@@ -229,6 +308,81 @@ end
|
|
|
229
308
|
- **Accept**: application/json
|
|
230
309
|
|
|
231
310
|
|
|
311
|
+
## delete_media_folder
|
|
312
|
+
|
|
313
|
+
> Object delete_media_folder(workspace_uuid, folder_uuid, opts)
|
|
314
|
+
|
|
315
|
+
Delete media folder
|
|
316
|
+
|
|
317
|
+
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.
|
|
318
|
+
|
|
319
|
+
### Examples
|
|
320
|
+
|
|
321
|
+
```ruby
|
|
322
|
+
require 'time'
|
|
323
|
+
require 'postboost'
|
|
324
|
+
# setup authorization
|
|
325
|
+
PostBoost.configure do |config|
|
|
326
|
+
# Configure Bearer authorization: bearerAuth
|
|
327
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
328
|
+
end
|
|
329
|
+
|
|
330
|
+
api_instance = PostBoost::MediaApi.new
|
|
331
|
+
workspace_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the workspace.
|
|
332
|
+
folder_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the media folder.
|
|
333
|
+
opts = {
|
|
334
|
+
delete_media_folder_request: PostBoost::DeleteMediaFolderRequest.new # DeleteMediaFolderRequest |
|
|
335
|
+
}
|
|
336
|
+
|
|
337
|
+
begin
|
|
338
|
+
# Delete media folder
|
|
339
|
+
result = api_instance.delete_media_folder(workspace_uuid, folder_uuid, opts)
|
|
340
|
+
p result
|
|
341
|
+
rescue PostBoost::ApiError => e
|
|
342
|
+
puts "Error when calling MediaApi->delete_media_folder: #{e}"
|
|
343
|
+
end
|
|
344
|
+
```
|
|
345
|
+
|
|
346
|
+
#### Using the delete_media_folder_with_http_info variant
|
|
347
|
+
|
|
348
|
+
This returns an Array which contains the response data, status code and headers.
|
|
349
|
+
|
|
350
|
+
> <Array(Object, Integer, Hash)> delete_media_folder_with_http_info(workspace_uuid, folder_uuid, opts)
|
|
351
|
+
|
|
352
|
+
```ruby
|
|
353
|
+
begin
|
|
354
|
+
# Delete media folder
|
|
355
|
+
data, status_code, headers = api_instance.delete_media_folder_with_http_info(workspace_uuid, folder_uuid, opts)
|
|
356
|
+
p status_code # => 2xx
|
|
357
|
+
p headers # => { ... }
|
|
358
|
+
p data # => Object
|
|
359
|
+
rescue PostBoost::ApiError => e
|
|
360
|
+
puts "Error when calling MediaApi->delete_media_folder_with_http_info: #{e}"
|
|
361
|
+
end
|
|
362
|
+
```
|
|
363
|
+
|
|
364
|
+
### Parameters
|
|
365
|
+
|
|
366
|
+
| Name | Type | Description | Notes |
|
|
367
|
+
| ---- | ---- | ----------- | ----- |
|
|
368
|
+
| **workspace_uuid** | **String** | UUID of the workspace. | |
|
|
369
|
+
| **folder_uuid** | **String** | UUID of the media folder. | |
|
|
370
|
+
| **delete_media_folder_request** | [**DeleteMediaFolderRequest**](DeleteMediaFolderRequest.md) | | [optional] |
|
|
371
|
+
|
|
372
|
+
### Return type
|
|
373
|
+
|
|
374
|
+
**Object**
|
|
375
|
+
|
|
376
|
+
### Authorization
|
|
377
|
+
|
|
378
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
379
|
+
|
|
380
|
+
### HTTP request headers
|
|
381
|
+
|
|
382
|
+
- **Content-Type**: application/json
|
|
383
|
+
- **Accept**: application/json
|
|
384
|
+
|
|
385
|
+
|
|
232
386
|
## get_media
|
|
233
387
|
|
|
234
388
|
> <Media> get_media(workspace_uuid, media_uuid)
|
|
@@ -373,7 +527,7 @@ end
|
|
|
373
527
|
|
|
374
528
|
## initiate_chunked_upload
|
|
375
529
|
|
|
376
|
-
> <
|
|
530
|
+
> <InitiateChunkedUpload201Response> initiate_chunked_upload(workspace_uuid, initiate_chunked_upload_request)
|
|
377
531
|
|
|
378
532
|
Initiate chunked upload
|
|
379
533
|
|
|
@@ -407,7 +561,7 @@ end
|
|
|
407
561
|
|
|
408
562
|
This returns an Array which contains the response data, status code and headers.
|
|
409
563
|
|
|
410
|
-
> <Array(<
|
|
564
|
+
> <Array(<InitiateChunkedUpload201Response>, Integer, Hash)> initiate_chunked_upload_with_http_info(workspace_uuid, initiate_chunked_upload_request)
|
|
411
565
|
|
|
412
566
|
```ruby
|
|
413
567
|
begin
|
|
@@ -415,7 +569,7 @@ begin
|
|
|
415
569
|
data, status_code, headers = api_instance.initiate_chunked_upload_with_http_info(workspace_uuid, initiate_chunked_upload_request)
|
|
416
570
|
p status_code # => 2xx
|
|
417
571
|
p headers # => { ... }
|
|
418
|
-
p data # => <
|
|
572
|
+
p data # => <InitiateChunkedUpload201Response>
|
|
419
573
|
rescue PostBoost::ApiError => e
|
|
420
574
|
puts "Error when calling MediaApi->initiate_chunked_upload_with_http_info: #{e}"
|
|
421
575
|
end
|
|
@@ -430,7 +584,7 @@ end
|
|
|
430
584
|
|
|
431
585
|
### Return type
|
|
432
586
|
|
|
433
|
-
[**
|
|
587
|
+
[**InitiateChunkedUpload201Response**](InitiateChunkedUpload201Response.md)
|
|
434
588
|
|
|
435
589
|
### Authorization
|
|
436
590
|
|
|
@@ -444,7 +598,7 @@ end
|
|
|
444
598
|
|
|
445
599
|
## initiate_remote_upload
|
|
446
600
|
|
|
447
|
-
> <
|
|
601
|
+
> <InitiateRemoteUpload201Response> initiate_remote_upload(workspace_uuid, initiate_remote_upload_request)
|
|
448
602
|
|
|
449
603
|
Initiate remote upload
|
|
450
604
|
|
|
@@ -478,7 +632,7 @@ end
|
|
|
478
632
|
|
|
479
633
|
This returns an Array which contains the response data, status code and headers.
|
|
480
634
|
|
|
481
|
-
> <Array(<
|
|
635
|
+
> <Array(<InitiateRemoteUpload201Response>, Integer, Hash)> initiate_remote_upload_with_http_info(workspace_uuid, initiate_remote_upload_request)
|
|
482
636
|
|
|
483
637
|
```ruby
|
|
484
638
|
begin
|
|
@@ -486,7 +640,7 @@ begin
|
|
|
486
640
|
data, status_code, headers = api_instance.initiate_remote_upload_with_http_info(workspace_uuid, initiate_remote_upload_request)
|
|
487
641
|
p status_code # => 2xx
|
|
488
642
|
p headers # => { ... }
|
|
489
|
-
p data # => <
|
|
643
|
+
p data # => <InitiateRemoteUpload201Response>
|
|
490
644
|
rescue PostBoost::ApiError => e
|
|
491
645
|
puts "Error when calling MediaApi->initiate_remote_upload_with_http_info: #{e}"
|
|
492
646
|
end
|
|
@@ -501,7 +655,7 @@ end
|
|
|
501
655
|
|
|
502
656
|
### Return type
|
|
503
657
|
|
|
504
|
-
[**
|
|
658
|
+
[**InitiateRemoteUpload201Response**](InitiateRemoteUpload201Response.md)
|
|
505
659
|
|
|
506
660
|
### Authorization
|
|
507
661
|
|
|
@@ -519,7 +673,7 @@ end
|
|
|
519
673
|
|
|
520
674
|
List media
|
|
521
675
|
|
|
522
|
-
Returns a paginated list of media assets in the workspace library.
|
|
676
|
+
Returns a paginated list of media assets in the workspace library. Without `folder` every item is listed, whatever folder it is filed in. A `keyword` search always looks at the whole library and ignores `folder` and `favorite`.
|
|
523
677
|
|
|
524
678
|
### Examples
|
|
525
679
|
|
|
@@ -535,7 +689,15 @@ end
|
|
|
535
689
|
api_instance = PostBoost::MediaApi.new
|
|
536
690
|
workspace_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the workspace.
|
|
537
691
|
opts = {
|
|
538
|
-
page: 56 # Integer | Page number
|
|
692
|
+
page: 56, # Integer | Page number.
|
|
693
|
+
limit: 56, # Integer | Items per page. Values below 1 fall back to 50; values above 100 are capped at 100.
|
|
694
|
+
folder: 'folder_example', # String | Media folder UUID, or `root` for items not filed in any folder.
|
|
695
|
+
mime_types: ['inner_example'], # Array<String> | Only these MIME types (for example `image/png`).
|
|
696
|
+
type: 'image', # String | Only this media type.
|
|
697
|
+
keyword: 'keyword_example', # String | Search media by name.
|
|
698
|
+
usage: 'unused', # String | Filter by how the media is used in posts.
|
|
699
|
+
favorite: true, # Boolean | When `true`, only media the caller marked as favorite.
|
|
700
|
+
sort: 'newest' # String |
|
|
539
701
|
}
|
|
540
702
|
|
|
541
703
|
begin
|
|
@@ -570,7 +732,15 @@ end
|
|
|
570
732
|
| Name | Type | Description | Notes |
|
|
571
733
|
| ---- | ---- | ----------- | ----- |
|
|
572
734
|
| **workspace_uuid** | **String** | UUID of the workspace. | |
|
|
573
|
-
| **page** | **Integer** | Page number
|
|
735
|
+
| **page** | **Integer** | Page number. | [optional][default to 1] |
|
|
736
|
+
| **limit** | **Integer** | Items per page. Values below 1 fall back to 50; values above 100 are capped at 100. | [optional][default to 50] |
|
|
737
|
+
| **folder** | **String** | Media folder UUID, or `root` for items not filed in any folder. | [optional] |
|
|
738
|
+
| **mime_types** | [**Array<String>**](String.md) | Only these MIME types (for example `image/png`). | [optional] |
|
|
739
|
+
| **type** | **String** | Only this media type. | [optional] |
|
|
740
|
+
| **keyword** | **String** | Search media by name. | [optional] |
|
|
741
|
+
| **usage** | **String** | Filter by how the media is used in posts. | [optional] |
|
|
742
|
+
| **favorite** | **Boolean** | When `true`, only media the caller marked as favorite. | [optional] |
|
|
743
|
+
| **sort** | **String** | | [optional][default to 'newest'] |
|
|
574
744
|
|
|
575
745
|
### Return type
|
|
576
746
|
|
|
@@ -586,13 +756,82 @@ end
|
|
|
586
756
|
- **Accept**: application/json
|
|
587
757
|
|
|
588
758
|
|
|
759
|
+
## list_media_folders
|
|
760
|
+
|
|
761
|
+
> <ListMediaFolders200Response> list_media_folders(workspace_uuid)
|
|
762
|
+
|
|
763
|
+
List media folders
|
|
764
|
+
|
|
765
|
+
Returns the whole folder tree of the media library in one response (not paginated). Rebuild the tree from each folder's `parent`.
|
|
766
|
+
|
|
767
|
+
### Examples
|
|
768
|
+
|
|
769
|
+
```ruby
|
|
770
|
+
require 'time'
|
|
771
|
+
require 'postboost'
|
|
772
|
+
# setup authorization
|
|
773
|
+
PostBoost.configure do |config|
|
|
774
|
+
# Configure Bearer authorization: bearerAuth
|
|
775
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
776
|
+
end
|
|
777
|
+
|
|
778
|
+
api_instance = PostBoost::MediaApi.new
|
|
779
|
+
workspace_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the workspace.
|
|
780
|
+
|
|
781
|
+
begin
|
|
782
|
+
# List media folders
|
|
783
|
+
result = api_instance.list_media_folders(workspace_uuid)
|
|
784
|
+
p result
|
|
785
|
+
rescue PostBoost::ApiError => e
|
|
786
|
+
puts "Error when calling MediaApi->list_media_folders: #{e}"
|
|
787
|
+
end
|
|
788
|
+
```
|
|
789
|
+
|
|
790
|
+
#### Using the list_media_folders_with_http_info variant
|
|
791
|
+
|
|
792
|
+
This returns an Array which contains the response data, status code and headers.
|
|
793
|
+
|
|
794
|
+
> <Array(<ListMediaFolders200Response>, Integer, Hash)> list_media_folders_with_http_info(workspace_uuid)
|
|
795
|
+
|
|
796
|
+
```ruby
|
|
797
|
+
begin
|
|
798
|
+
# List media folders
|
|
799
|
+
data, status_code, headers = api_instance.list_media_folders_with_http_info(workspace_uuid)
|
|
800
|
+
p status_code # => 2xx
|
|
801
|
+
p headers # => { ... }
|
|
802
|
+
p data # => <ListMediaFolders200Response>
|
|
803
|
+
rescue PostBoost::ApiError => e
|
|
804
|
+
puts "Error when calling MediaApi->list_media_folders_with_http_info: #{e}"
|
|
805
|
+
end
|
|
806
|
+
```
|
|
807
|
+
|
|
808
|
+
### Parameters
|
|
809
|
+
|
|
810
|
+
| Name | Type | Description | Notes |
|
|
811
|
+
| ---- | ---- | ----------- | ----- |
|
|
812
|
+
| **workspace_uuid** | **String** | UUID of the workspace. | |
|
|
813
|
+
|
|
814
|
+
### Return type
|
|
815
|
+
|
|
816
|
+
[**ListMediaFolders200Response**](ListMediaFolders200Response.md)
|
|
817
|
+
|
|
818
|
+
### Authorization
|
|
819
|
+
|
|
820
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
821
|
+
|
|
822
|
+
### HTTP request headers
|
|
823
|
+
|
|
824
|
+
- **Content-Type**: Not defined
|
|
825
|
+
- **Accept**: application/json
|
|
826
|
+
|
|
827
|
+
|
|
589
828
|
## update_media
|
|
590
829
|
|
|
591
830
|
> Object update_media(workspace_uuid, media_uuid, update_media_request)
|
|
592
831
|
|
|
593
832
|
Update media
|
|
594
833
|
|
|
595
|
-
Update the alt text of a media asset.
|
|
834
|
+
Update the name, alt text, or folder of a media asset. Only the keys present in the body are written. Sending `folder: null` moves the item to the library root; omitting `folder` leaves it where it is.
|
|
596
835
|
|
|
597
836
|
### Examples
|
|
598
837
|
|
|
@@ -608,7 +847,7 @@ end
|
|
|
608
847
|
api_instance = PostBoost::MediaApi.new
|
|
609
848
|
workspace_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the workspace.
|
|
610
849
|
media_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the media asset.
|
|
611
|
-
update_media_request = PostBoost::UpdateMediaRequest.new
|
|
850
|
+
update_media_request = PostBoost::UpdateMediaRequest.new # UpdateMediaRequest |
|
|
612
851
|
|
|
613
852
|
begin
|
|
614
853
|
# Update media
|
|
@@ -659,9 +898,82 @@ end
|
|
|
659
898
|
- **Accept**: application/json
|
|
660
899
|
|
|
661
900
|
|
|
901
|
+
## update_media_folder
|
|
902
|
+
|
|
903
|
+
> <MediaFolder> update_media_folder(workspace_uuid, folder_uuid, media_folder_input)
|
|
904
|
+
|
|
905
|
+
Update media folder
|
|
906
|
+
|
|
907
|
+
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.
|
|
908
|
+
|
|
909
|
+
### Examples
|
|
910
|
+
|
|
911
|
+
```ruby
|
|
912
|
+
require 'time'
|
|
913
|
+
require 'postboost'
|
|
914
|
+
# setup authorization
|
|
915
|
+
PostBoost.configure do |config|
|
|
916
|
+
# Configure Bearer authorization: bearerAuth
|
|
917
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
918
|
+
end
|
|
919
|
+
|
|
920
|
+
api_instance = PostBoost::MediaApi.new
|
|
921
|
+
workspace_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the workspace.
|
|
922
|
+
folder_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the media folder.
|
|
923
|
+
media_folder_input = PostBoost::MediaFolderInput.new # MediaFolderInput |
|
|
924
|
+
|
|
925
|
+
begin
|
|
926
|
+
# Update media folder
|
|
927
|
+
result = api_instance.update_media_folder(workspace_uuid, folder_uuid, media_folder_input)
|
|
928
|
+
p result
|
|
929
|
+
rescue PostBoost::ApiError => e
|
|
930
|
+
puts "Error when calling MediaApi->update_media_folder: #{e}"
|
|
931
|
+
end
|
|
932
|
+
```
|
|
933
|
+
|
|
934
|
+
#### Using the update_media_folder_with_http_info variant
|
|
935
|
+
|
|
936
|
+
This returns an Array which contains the response data, status code and headers.
|
|
937
|
+
|
|
938
|
+
> <Array(<MediaFolder>, Integer, Hash)> update_media_folder_with_http_info(workspace_uuid, folder_uuid, media_folder_input)
|
|
939
|
+
|
|
940
|
+
```ruby
|
|
941
|
+
begin
|
|
942
|
+
# Update media folder
|
|
943
|
+
data, status_code, headers = api_instance.update_media_folder_with_http_info(workspace_uuid, folder_uuid, media_folder_input)
|
|
944
|
+
p status_code # => 2xx
|
|
945
|
+
p headers # => { ... }
|
|
946
|
+
p data # => <MediaFolder>
|
|
947
|
+
rescue PostBoost::ApiError => e
|
|
948
|
+
puts "Error when calling MediaApi->update_media_folder_with_http_info: #{e}"
|
|
949
|
+
end
|
|
950
|
+
```
|
|
951
|
+
|
|
952
|
+
### Parameters
|
|
953
|
+
|
|
954
|
+
| Name | Type | Description | Notes |
|
|
955
|
+
| ---- | ---- | ----------- | ----- |
|
|
956
|
+
| **workspace_uuid** | **String** | UUID of the workspace. | |
|
|
957
|
+
| **folder_uuid** | **String** | UUID of the media folder. | |
|
|
958
|
+
| **media_folder_input** | [**MediaFolderInput**](MediaFolderInput.md) | | |
|
|
959
|
+
|
|
960
|
+
### Return type
|
|
961
|
+
|
|
962
|
+
[**MediaFolder**](MediaFolder.md)
|
|
963
|
+
|
|
964
|
+
### Authorization
|
|
965
|
+
|
|
966
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
967
|
+
|
|
968
|
+
### HTTP request headers
|
|
969
|
+
|
|
970
|
+
- **Content-Type**: application/json
|
|
971
|
+
- **Accept**: application/json
|
|
972
|
+
|
|
973
|
+
|
|
662
974
|
## upload_chunk
|
|
663
975
|
|
|
664
|
-
> <
|
|
976
|
+
> <UploadChunk201Response> upload_chunk(workspace_uuid, upload_uuid, chunk, chunk_index)
|
|
665
977
|
|
|
666
978
|
Upload a chunk
|
|
667
979
|
|
|
@@ -697,7 +1009,7 @@ end
|
|
|
697
1009
|
|
|
698
1010
|
This returns an Array which contains the response data, status code and headers.
|
|
699
1011
|
|
|
700
|
-
> <Array(<
|
|
1012
|
+
> <Array(<UploadChunk201Response>, Integer, Hash)> upload_chunk_with_http_info(workspace_uuid, upload_uuid, chunk, chunk_index)
|
|
701
1013
|
|
|
702
1014
|
```ruby
|
|
703
1015
|
begin
|
|
@@ -705,7 +1017,7 @@ begin
|
|
|
705
1017
|
data, status_code, headers = api_instance.upload_chunk_with_http_info(workspace_uuid, upload_uuid, chunk, chunk_index)
|
|
706
1018
|
p status_code # => 2xx
|
|
707
1019
|
p headers # => { ... }
|
|
708
|
-
p data # => <
|
|
1020
|
+
p data # => <UploadChunk201Response>
|
|
709
1021
|
rescue PostBoost::ApiError => e
|
|
710
1022
|
puts "Error when calling MediaApi->upload_chunk_with_http_info: #{e}"
|
|
711
1023
|
end
|
|
@@ -722,7 +1034,7 @@ end
|
|
|
722
1034
|
|
|
723
1035
|
### Return type
|
|
724
1036
|
|
|
725
|
-
[**
|
|
1037
|
+
[**UploadChunk201Response**](UploadChunk201Response.md)
|
|
726
1038
|
|
|
727
1039
|
### Authorization
|
|
728
1040
|
|
|
@@ -757,7 +1069,8 @@ api_instance = PostBoost::MediaApi.new
|
|
|
757
1069
|
workspace_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the workspace.
|
|
758
1070
|
file = File.new('/path/to/some/file') # File | The file to upload.
|
|
759
1071
|
opts = {
|
|
760
|
-
alt_text: 'alt_text_example' # String | Alternative text for accessibility.
|
|
1072
|
+
alt_text: 'alt_text_example', # String | Alternative text for accessibility.
|
|
1073
|
+
folder: '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the media folder to file the upload in. Omit or null for the library root.
|
|
761
1074
|
}
|
|
762
1075
|
|
|
763
1076
|
begin
|
|
@@ -794,6 +1107,7 @@ end
|
|
|
794
1107
|
| **workspace_uuid** | **String** | UUID of the workspace. | |
|
|
795
1108
|
| **file** | **File** | The file to upload. | |
|
|
796
1109
|
| **alt_text** | **String** | Alternative text for accessibility. | [optional] |
|
|
1110
|
+
| **folder** | **String** | UUID of the media folder to file the upload in. Omit or null for the library root. | [optional] |
|
|
797
1111
|
|
|
798
1112
|
### Return type
|
|
799
1113
|
|
data/docs/MediaFolder.md
ADDED
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# PostBoost::MediaFolder
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **uuid** | **String** | | |
|
|
8
|
+
| **name** | **String** | | |
|
|
9
|
+
| **parent** | **String** | UUID of the parent folder; null for a top-level folder. | |
|
|
10
|
+
| **media_count** | **Integer** | Media filed anywhere below the folder, including its sub-folders. | |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'postboost'
|
|
16
|
+
|
|
17
|
+
instance = PostBoost::MediaFolder.new(
|
|
18
|
+
uuid: null,
|
|
19
|
+
name: Campaign assets,
|
|
20
|
+
parent: null,
|
|
21
|
+
media_count: null
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# PostBoost::MediaFolderInput
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **name** | **String** | Folder name; must be unique among its siblings (case-insensitive). | [optional] |
|
|
8
|
+
| **parent** | **String** | UUID of the parent folder, or null for the top level. Folders nest to a limited depth. | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'postboost'
|
|
14
|
+
|
|
15
|
+
instance = PostBoost::MediaFolderInput.new(
|
|
16
|
+
name: null,
|
|
17
|
+
parent: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# PostBoost::MediaFolderRef
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **uuid** | **String** | | |
|
|
8
|
+
| **name** | **String** | | |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'postboost'
|
|
14
|
+
|
|
15
|
+
instance = PostBoost::MediaFolderRef.new(
|
|
16
|
+
uuid: null,
|
|
17
|
+
name: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
data/docs/Mention.md
ADDED
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# PostBoost::Mention
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | | |
|
|
8
|
+
| **reference** | **Integer** | Write `{{mention:<reference>}}` in a post body to mention this entry; it is resolved to each network's identity at publish time. | |
|
|
9
|
+
| **name** | **String** | | |
|
|
10
|
+
| **avatar** | **String** | | [optional] |
|
|
11
|
+
| **identities** | [**Array<MentionIdentity>**](MentionIdentity.md) | | [optional] |
|
|
12
|
+
| **created_at** | **Time** | | |
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```ruby
|
|
17
|
+
require 'postboost'
|
|
18
|
+
|
|
19
|
+
instance = PostBoost::Mention.new(
|
|
20
|
+
id: null,
|
|
21
|
+
reference: null,
|
|
22
|
+
name: Jane Doe,
|
|
23
|
+
avatar: null,
|
|
24
|
+
identities: null,
|
|
25
|
+
created_at: null
|
|
26
|
+
)
|
|
27
|
+
```
|
|
28
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# PostBoost::MentionIdentity
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **provider** | **String** | Mention provider key (network family). | |
|
|
8
|
+
| **provider_id** | **String** | The profile's network ID, when resolved. Never accepted from clients. | [optional] |
|
|
9
|
+
| **handle** | **String** | | |
|
|
10
|
+
| **label** | **String** | | [optional] |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'postboost'
|
|
16
|
+
|
|
17
|
+
instance = PostBoost::MentionIdentity.new(
|
|
18
|
+
provider: linkedin,
|
|
19
|
+
provider_id: null,
|
|
20
|
+
handle: janedoe,
|
|
21
|
+
label: null
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|