peal 0.1.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 +7 -0
- data/Gemfile +9 -0
- data/Gemfile.lock +136 -0
- data/LICENSE +202 -0
- data/README.md +353 -0
- data/Rakefile +10 -0
- data/docs/AlreadyMemberEncoded.md +18 -0
- data/docs/AltTextTooLongEncoded.md +20 -0
- data/docs/AnalyticsApi.md +155 -0
- data/docs/AnalyticsSummary.md +30 -0
- data/docs/ApiKey.md +28 -0
- data/docs/ApiKeyNotFoundEncoded.md +18 -0
- data/docs/ApiKeysApi.md +220 -0
- data/docs/ApiKeysRevoke404Response.md +18 -0
- data/docs/AssistantAction.md +24 -0
- data/docs/AssistantActionAnyOf.md +20 -0
- data/docs/AssistantActionAnyOf1.md +20 -0
- data/docs/AssistantActionAnyOf2.md +20 -0
- data/docs/AssistantActionAnyOf3.md +18 -0
- data/docs/AssistantApi.md +149 -0
- data/docs/AssistantFailedEncoded.md +20 -0
- data/docs/AssistantInputRejectedEncoded.md +22 -0
- data/docs/AssistantQuotaExceededEncoded.md +22 -0
- data/docs/AssistantStatus.md +26 -0
- data/docs/AssistantTone.md +15 -0
- data/docs/AssistantUnavailableEncoded.md +18 -0
- data/docs/AttemptResult.md +15 -0
- data/docs/Authorization.md +18 -0
- data/docs/Billing.md +28 -0
- data/docs/BillingApi.md +77 -0
- data/docs/BillingSubscription.md +24 -0
- data/docs/Channel.md +30 -0
- data/docs/ChannelCannotPostEncoded.md +20 -0
- data/docs/ChannelMetrics.md +30 -0
- data/docs/ChannelNotFoundEncoded.md +18 -0
- data/docs/ChannelOptions.md +20 -0
- data/docs/ChannelStatus.md +20 -0
- data/docs/ChannelStatusAnyOf.md +18 -0
- data/docs/ChannelStatusAnyOf1.md +18 -0
- data/docs/ChannelStatusAnyOf2.md +20 -0
- data/docs/ChannelsApi.md +512 -0
- data/docs/ChannelsCompleteConnect404Response.md +18 -0
- data/docs/ChoosableAccount.md +26 -0
- data/docs/ChooseAccounts.md +20 -0
- data/docs/ConnectCallback.md +24 -0
- data/docs/ConnectChannel.md +20 -0
- data/docs/ConnectFailedEncoded.md +20 -0
- data/docs/ConnectFailureReason.md +15 -0
- data/docs/ConnectOutcome.md +26 -0
- data/docs/ConnectOutcomeAnyOf.md +20 -0
- data/docs/ConnectOutcomeAnyOf1.md +24 -0
- data/docs/ConnectablePlatforms.md +18 -0
- data/docs/ContentViolation.md +54 -0
- data/docs/ContentViolationAnyOf.md +18 -0
- data/docs/ContentViolationAnyOf1.md +20 -0
- data/docs/ContentViolationAnyOf10.md +26 -0
- data/docs/ContentViolationAnyOf11.md +22 -0
- data/docs/ContentViolationAnyOf12.md +26 -0
- data/docs/ContentViolationAnyOf13.md +26 -0
- data/docs/ContentViolationAnyOf14.md +26 -0
- data/docs/ContentViolationAnyOf15.md +26 -0
- data/docs/ContentViolationAnyOf16.md +22 -0
- data/docs/ContentViolationAnyOf17.md +26 -0
- data/docs/ContentViolationAnyOf18.md +28 -0
- data/docs/ContentViolationAnyOf19.md +28 -0
- data/docs/ContentViolationAnyOf2.md +20 -0
- data/docs/ContentViolationAnyOf20.md +28 -0
- data/docs/ContentViolationAnyOf21.md +28 -0
- data/docs/ContentViolationAnyOf22.md +30 -0
- data/docs/ContentViolationAnyOf23.md +32 -0
- data/docs/ContentViolationAnyOf24.md +32 -0
- data/docs/ContentViolationAnyOf24Maximum.md +15 -0
- data/docs/ContentViolationAnyOf25.md +28 -0
- data/docs/ContentViolationAnyOf3.md +24 -0
- data/docs/ContentViolationAnyOf4.md +24 -0
- data/docs/ContentViolationAnyOf5.md +28 -0
- data/docs/ContentViolationAnyOf6.md +24 -0
- data/docs/ContentViolationAnyOf7.md +22 -0
- data/docs/ContentViolationAnyOf8.md +28 -0
- data/docs/ContentViolationAnyOf9.md +24 -0
- data/docs/CreatedApiKey.md +20 -0
- data/docs/DatabaseUnavailableEncoded.md +18 -0
- data/docs/DraftPage.md +20 -0
- data/docs/EffectHttpApiErrorBadRequestEncoded.md +18 -0
- data/docs/EngagementDay.md +26 -0
- data/docs/FailureReason.md +15 -0
- data/docs/ForbiddenEncoded.md +18 -0
- data/docs/InvalidDateRangeEncoded.md +18 -0
- data/docs/InvalidTimeRangeEncoded.md +18 -0
- data/docs/InvalidTimeZoneEncoded.md +20 -0
- data/docs/Invitation.md +28 -0
- data/docs/InvitationNotFoundEncoded.md +18 -0
- data/docs/InvitationsApi.md +220 -0
- data/docs/InvitationsCreate409Response.md +18 -0
- data/docs/InvitationsRevoke404Response.md +18 -0
- data/docs/MarkNoticesRead.md +18 -0
- data/docs/Me.md +22 -0
- data/docs/MeUser.md +28 -0
- data/docs/Media.md +40 -0
- data/docs/MediaApi.md +516 -0
- data/docs/MediaAttachment.md +20 -0
- data/docs/MediaContentType.md +15 -0
- data/docs/MediaCreate422Response.md +28 -0
- data/docs/MediaDescription.md +18 -0
- data/docs/MediaDimensions.md +20 -0
- data/docs/MediaGet404Response.md +18 -0
- data/docs/MediaInUseEncoded.md +20 -0
- data/docs/MediaKind.md +15 -0
- data/docs/MediaNotFoundEncoded.md +18 -0
- data/docs/MediaPage.md +20 -0
- data/docs/MediaStatus.md +22 -0
- data/docs/MediaStatusAnyOf.md +18 -0
- data/docs/MediaStatusAnyOf1.md +20 -0
- data/docs/MediaStatusAnyOf2.md +18 -0
- data/docs/MediaStatusAnyOf3.md +20 -0
- data/docs/MediaStoreUnavailableEncoded.md +18 -0
- data/docs/MediaTooLargeEncoded.md +24 -0
- data/docs/MediaUsage.md +20 -0
- data/docs/MembersApi.md +77 -0
- data/docs/Membership.md +26 -0
- data/docs/MetricTotals.md +28 -0
- data/docs/MetricsSnapshot.md +20 -0
- data/docs/NewApiKey.md +22 -0
- data/docs/NewInvitation.md +20 -0
- data/docs/NewUpload.md +22 -0
- data/docs/NonFiniteNumber.md +15 -0
- data/docs/Notice.md +26 -0
- data/docs/NoticeChannel.md +20 -0
- data/docs/NoticeEvent.md +28 -0
- data/docs/NoticeEventAnyOf.md +24 -0
- data/docs/NoticeEventAnyOf1.md +24 -0
- data/docs/NoticeEventAnyOf2.md +22 -0
- data/docs/NoticeEventAnyOf3.md +20 -0
- data/docs/NoticeEventAnyOf4.md +22 -0
- data/docs/NoticePage.md +20 -0
- data/docs/NoticesApi.md +285 -0
- data/docs/NotificationPreferences.md +20 -0
- data/docs/NotificationPreferencesApi.md +144 -0
- data/docs/NotificationPreferencesChange.md +20 -0
- data/docs/NotificationPreferencesChangeEmail.md +24 -0
- data/docs/NotificationPreferencesEmail.md +24 -0
- data/docs/PaidPlan.md +15 -0
- data/docs/PeriodUsage.md +20 -0
- data/docs/Plan.md +15 -0
- data/docs/PlanAllowances.md +24 -0
- data/docs/PlanLimit.md +15 -0
- data/docs/PlanLimitReachedEncoded.md +22 -0
- data/docs/PlanOffer.md +20 -0
- data/docs/Platform.md +15 -0
- data/docs/PlatformUnreachableEncoded.md +18 -0
- data/docs/Post.md +30 -0
- data/docs/PostAnalytics.md +20 -0
- data/docs/PostContent.md +22 -0
- data/docs/PostContentInvalidEncoded.md +20 -0
- data/docs/PostDraft.md +22 -0
- data/docs/PostMetrics.md +26 -0
- data/docs/PostNotFoundEncoded.md +18 -0
- data/docs/PostOutcome.md +15 -0
- data/docs/PostSchedule.md +20 -0
- data/docs/PostStatus.md +15 -0
- data/docs/PostStatusConflictEncoded.md +20 -0
- data/docs/PostTarget.md +36 -0
- data/docs/PostTargetStatus.md +15 -0
- data/docs/PostsApi.md +960 -0
- data/docs/PostsCreate422Response.md +24 -0
- data/docs/PostsGet404Response.md +18 -0
- data/docs/PostsRepost409Response.md +20 -0
- data/docs/PostsSchedule422Response.md +26 -0
- data/docs/PreparedUpload.md +20 -0
- data/docs/ProbeState.md +15 -0
- data/docs/PublicationAttempt.md +30 -0
- data/docs/RejectionReason.md +15 -0
- data/docs/Role.md +15 -0
- data/docs/ScheduleInPastEncoded.md +18 -0
- data/docs/SchedulePost.md +22 -0
- data/docs/SessionApi.md +74 -0
- data/docs/SignedRequest.md +22 -0
- data/docs/SubscriptionStatus.md +15 -0
- data/docs/Suggestion.md +22 -0
- data/docs/SuggestionAnyOf.md +20 -0
- data/docs/SuggestionAnyOf1.md +20 -0
- data/docs/SuggestionRequest.md +20 -0
- data/docs/SystemApi.md +129 -0
- data/docs/TargetConfirmation.md +20 -0
- data/docs/TargetConfirmationAnyOf.md +20 -0
- data/docs/TargetConfirmationAnyOf1.md +18 -0
- data/docs/TargetMetrics.md +32 -0
- data/docs/TargetOptions.md +48 -0
- data/docs/TargetStatusConflictEncoded.md +20 -0
- data/docs/TextOverride.md +20 -0
- data/docs/TextUnit.md +15 -0
- data/docs/TikTokAccount.md +20 -0
- data/docs/TikTokAccountPosting.md +22 -0
- data/docs/TikTokAccountPostingAnyOf.md +20 -0
- data/docs/TikTokAccountPostingAnyOf1.md +20 -0
- data/docs/TikTokBlock.md +15 -0
- data/docs/TikTokCreator.md +32 -0
- data/docs/TikTokOptions.md +34 -0
- data/docs/TikTokPrivacyLevel.md +15 -0
- data/docs/TiktokApi.md +79 -0
- data/docs/TooManyInvitationsEncoded.md +18 -0
- data/docs/TopPost.md +30 -0
- data/docs/TranslationLanguage.md +15 -0
- data/docs/UnauthenticatedEncoded.md +18 -0
- data/docs/UnconfirmedReason.md +15 -0
- data/docs/UnknownChannelsEncoded.md +20 -0
- data/docs/UnknownMediaEncoded.md +20 -0
- data/docs/UnreadNotices.md +18 -0
- data/docs/UnsupportedMediaTypeEncoded.md +20 -0
- data/docs/UploadIncompleteEncoded.md +18 -0
- data/docs/UploadPart.md +22 -0
- data/docs/UploadRejectedEncoded.md +20 -0
- data/docs/UploadTarget.md +26 -0
- data/docs/UploadTargetAnyOf.md +22 -0
- data/docs/UploadTargetAnyOf1.md +24 -0
- data/docs/Usage.md +24 -0
- data/docs/WorkspaceMember.md +26 -0
- data/docs/WorkspaceNotFoundEncoded.md +18 -0
- data/docs/YouTubeOptions.md +32 -0
- data/docs/YouTubePrivacy.md +15 -0
- data/lib/peal/api/analytics_api.rb +185 -0
- data/lib/peal/api/api_keys_api.rb +228 -0
- data/lib/peal/api/assistant_api.rb +159 -0
- data/lib/peal/api/billing_api.rb +85 -0
- data/lib/peal/api/channels_api.rb +526 -0
- data/lib/peal/api/invitations_api.rb +228 -0
- data/lib/peal/api/media_api.rb +526 -0
- data/lib/peal/api/members_api.rb +85 -0
- data/lib/peal/api/notices_api.rb +272 -0
- data/lib/peal/api/notification_preferences_api.rb +147 -0
- data/lib/peal/api/posts_api.rb +993 -0
- data/lib/peal/api/session_api.rb +79 -0
- data/lib/peal/api/system_api.rb +134 -0
- data/lib/peal/api/tiktok_api.rb +91 -0
- data/lib/peal/api_client.rb +441 -0
- data/lib/peal/api_error.rb +58 -0
- data/lib/peal/api_model_base.rb +88 -0
- data/lib/peal/configuration.rb +392 -0
- data/lib/peal/models/already_member_encoded.rb +201 -0
- data/lib/peal/models/alt_text_too_long_encoded.rb +245 -0
- data/lib/peal/models/analytics_summary.rb +361 -0
- data/lib/peal/models/api_key.rb +293 -0
- data/lib/peal/models/api_key_not_found_encoded.rb +201 -0
- data/lib/peal/models/api_keys_revoke404_response.rb +103 -0
- data/lib/peal/models/assistant_action.rb +105 -0
- data/lib/peal/models/assistant_action_any_of.rb +227 -0
- data/lib/peal/models/assistant_action_any_of1.rb +227 -0
- data/lib/peal/models/assistant_action_any_of2.rb +227 -0
- data/lib/peal/models/assistant_action_any_of3.rb +201 -0
- data/lib/peal/models/assistant_failed_encoded.rb +229 -0
- data/lib/peal/models/assistant_input_rejected_encoded.rb +273 -0
- data/lib/peal/models/assistant_quota_exceeded_encoded.rb +271 -0
- data/lib/peal/models/assistant_status.rb +335 -0
- data/lib/peal/models/assistant_tone.rb +43 -0
- data/lib/peal/models/assistant_unavailable_encoded.rb +201 -0
- data/lib/peal/models/attempt_result.rb +50 -0
- data/lib/peal/models/authorization.rb +177 -0
- data/lib/peal/models/billing.rb +303 -0
- data/lib/peal/models/billing_subscription.rb +263 -0
- data/lib/peal/models/channel.rb +313 -0
- data/lib/peal/models/channel_cannot_post_encoded.rb +229 -0
- data/lib/peal/models/channel_metrics.rb +425 -0
- data/lib/peal/models/channel_not_found_encoded.rb +201 -0
- data/lib/peal/models/channel_options.rb +203 -0
- data/lib/peal/models/channel_status.rb +104 -0
- data/lib/peal/models/channel_status_any_of.rb +201 -0
- data/lib/peal/models/channel_status_any_of1.rb +201 -0
- data/lib/peal/models/channel_status_any_of2.rb +227 -0
- data/lib/peal/models/channels_complete_connect404_response.rb +103 -0
- data/lib/peal/models/choosable_account.rb +253 -0
- data/lib/peal/models/choose_accounts.rb +241 -0
- data/lib/peal/models/connect_callback.rb +279 -0
- data/lib/peal/models/connect_channel.rb +207 -0
- data/lib/peal/models/connect_failed_encoded.rb +227 -0
- data/lib/peal/models/connect_failure_reason.rb +48 -0
- data/lib/peal/models/connect_outcome.rb +103 -0
- data/lib/peal/models/connect_outcome_any_of.rb +227 -0
- data/lib/peal/models/connect_outcome_any_of1.rb +281 -0
- data/lib/peal/models/connectable_platforms.rb +179 -0
- data/lib/peal/models/content_violation.rb +127 -0
- data/lib/peal/models/content_violation_any_of.rb +201 -0
- data/lib/peal/models/content_violation_any_of1.rb +227 -0
- data/lib/peal/models/content_violation_any_of10.rb +341 -0
- data/lib/peal/models/content_violation_any_of11.rb +253 -0
- data/lib/peal/models/content_violation_any_of12.rb +341 -0
- data/lib/peal/models/content_violation_any_of13.rb +341 -0
- data/lib/peal/models/content_violation_any_of14.rb +341 -0
- data/lib/peal/models/content_violation_any_of15.rb +341 -0
- data/lib/peal/models/content_violation_any_of16.rb +253 -0
- data/lib/peal/models/content_violation_any_of17.rb +305 -0
- data/lib/peal/models/content_violation_any_of18.rb +367 -0
- data/lib/peal/models/content_violation_any_of19.rb +367 -0
- data/lib/peal/models/content_violation_any_of2.rb +227 -0
- data/lib/peal/models/content_violation_any_of20.rb +367 -0
- data/lib/peal/models/content_violation_any_of21.rb +367 -0
- data/lib/peal/models/content_violation_any_of22.rb +411 -0
- data/lib/peal/models/content_violation_any_of23.rb +455 -0
- data/lib/peal/models/content_violation_any_of24.rb +419 -0
- data/lib/peal/models/content_violation_any_of24_maximum.rb +103 -0
- data/lib/peal/models/content_violation_any_of25.rb +367 -0
- data/lib/peal/models/content_violation_any_of3.rb +279 -0
- data/lib/peal/models/content_violation_any_of4.rb +279 -0
- data/lib/peal/models/content_violation_any_of5.rb +367 -0
- data/lib/peal/models/content_violation_any_of6.rb +279 -0
- data/lib/peal/models/content_violation_any_of7.rb +253 -0
- data/lib/peal/models/content_violation_any_of8.rb +367 -0
- data/lib/peal/models/content_violation_any_of9.rb +281 -0
- data/lib/peal/models/created_api_key.rb +203 -0
- data/lib/peal/models/database_unavailable_encoded.rb +201 -0
- data/lib/peal/models/draft_page.rb +191 -0
- data/lib/peal/models/effect_http_api_error_bad_request_encoded.rb +201 -0
- data/lib/peal/models/engagement_day.rb +364 -0
- data/lib/peal/models/failure_reason.rb +50 -0
- data/lib/peal/models/forbidden_encoded.rb +201 -0
- data/lib/peal/models/invalid_date_range_encoded.rb +201 -0
- data/lib/peal/models/invalid_time_range_encoded.rb +201 -0
- data/lib/peal/models/invalid_time_zone_encoded.rb +227 -0
- data/lib/peal/models/invitation.rb +307 -0
- data/lib/peal/models/invitation_not_found_encoded.rb +201 -0
- data/lib/peal/models/invitations_create409_response.rb +103 -0
- data/lib/peal/models/invitations_revoke404_response.rb +103 -0
- data/lib/peal/models/mark_notices_read.rb +197 -0
- data/lib/peal/models/me.rb +217 -0
- data/lib/peal/models/me_user.rb +317 -0
- data/lib/peal/models/media.rb +457 -0
- data/lib/peal/models/media_attachment.rb +212 -0
- data/lib/peal/models/media_content_type.rb +44 -0
- data/lib/peal/models/media_create422_response.rb +104 -0
- data/lib/peal/models/media_description.rb +163 -0
- data/lib/peal/models/media_dimensions.rb +239 -0
- data/lib/peal/models/media_get404_response.rb +103 -0
- data/lib/peal/models/media_in_use_encoded.rb +229 -0
- data/lib/peal/models/media_kind.rb +40 -0
- data/lib/peal/models/media_not_found_encoded.rb +201 -0
- data/lib/peal/models/media_page.rb +191 -0
- data/lib/peal/models/media_status.rb +105 -0
- data/lib/peal/models/media_status_any_of.rb +201 -0
- data/lib/peal/models/media_status_any_of1.rb +227 -0
- data/lib/peal/models/media_status_any_of2.rb +201 -0
- data/lib/peal/models/media_status_any_of3.rb +227 -0
- data/lib/peal/models/media_store_unavailable_encoded.rb +201 -0
- data/lib/peal/models/media_too_large_encoded.rb +317 -0
- data/lib/peal/models/media_usage.rb +207 -0
- data/lib/peal/models/membership.rb +295 -0
- data/lib/peal/models/metric_totals.rb +399 -0
- data/lib/peal/models/metrics_snapshot.rb +203 -0
- data/lib/peal/models/new_api_key.rb +277 -0
- data/lib/peal/models/new_invitation.rb +245 -0
- data/lib/peal/models/new_upload.rb +231 -0
- data/lib/peal/models/non_finite_number.rb +41 -0
- data/lib/peal/models/notice.rb +267 -0
- data/lib/peal/models/notice_channel.rb +225 -0
- data/lib/peal/models/notice_event.rb +106 -0
- data/lib/peal/models/notice_event_any_of.rb +251 -0
- data/lib/peal/models/notice_event_any_of1.rb +265 -0
- data/lib/peal/models/notice_event_any_of2.rb +239 -0
- data/lib/peal/models/notice_event_any_of3.rb +227 -0
- data/lib/peal/models/notice_event_any_of4.rb +253 -0
- data/lib/peal/models/notice_page.rb +191 -0
- data/lib/peal/models/notification_preferences.rb +203 -0
- data/lib/peal/models/notification_preferences_change.rb +169 -0
- data/lib/peal/models/notification_preferences_change_email.rb +187 -0
- data/lib/peal/models/notification_preferences_email.rb +255 -0
- data/lib/peal/models/paid_plan.rb +40 -0
- data/lib/peal/models/period_usage.rb +221 -0
- data/lib/peal/models/plan.rb +41 -0
- data/lib/peal/models/plan_allowances.rb +295 -0
- data/lib/peal/models/plan_limit.rb +42 -0
- data/lib/peal/models/plan_limit_reached_encoded.rb +271 -0
- data/lib/peal/models/plan_offer.rb +225 -0
- data/lib/peal/models/platform.rb +48 -0
- data/lib/peal/models/platform_unreachable_encoded.rb +201 -0
- data/lib/peal/models/post.rb +315 -0
- data/lib/peal/models/post_analytics.rb +205 -0
- data/lib/peal/models/post_content.rb +251 -0
- data/lib/peal/models/post_content_invalid_encoded.rb +229 -0
- data/lib/peal/models/post_draft.rb +216 -0
- data/lib/peal/models/post_metrics.rb +355 -0
- data/lib/peal/models/post_not_found_encoded.rb +201 -0
- data/lib/peal/models/post_outcome.rb +43 -0
- data/lib/peal/models/post_schedule.rb +203 -0
- data/lib/peal/models/post_status.rb +43 -0
- data/lib/peal/models/post_status_conflict_encoded.rb +227 -0
- data/lib/peal/models/post_target.rb +364 -0
- data/lib/peal/models/post_target_status.rb +44 -0
- data/lib/peal/models/posts_create422_response.rb +104 -0
- data/lib/peal/models/posts_get404_response.rb +103 -0
- data/lib/peal/models/posts_repost409_response.rb +103 -0
- data/lib/peal/models/posts_schedule422_response.rb +106 -0
- data/lib/peal/models/prepared_upload.rb +203 -0
- data/lib/peal/models/probe_state.rb +44 -0
- data/lib/peal/models/publication_attempt.rb +377 -0
- data/lib/peal/models/rejection_reason.rb +40 -0
- data/lib/peal/models/role.rb +43 -0
- data/lib/peal/models/schedule_in_past_encoded.rb +201 -0
- data/lib/peal/models/schedule_post.rb +240 -0
- data/lib/peal/models/signed_request.rb +255 -0
- data/lib/peal/models/subscription_status.rb +46 -0
- data/lib/peal/models/suggestion.rb +103 -0
- data/lib/peal/models/suggestion_any_of.rb +227 -0
- data/lib/peal/models/suggestion_any_of1.rb +229 -0
- data/lib/peal/models/suggestion_request.rb +212 -0
- data/lib/peal/models/target_confirmation.rb +103 -0
- data/lib/peal/models/target_confirmation_any_of.rb +228 -0
- data/lib/peal/models/target_confirmation_any_of1.rb +201 -0
- data/lib/peal/models/target_metrics.rb +319 -0
- data/lib/peal/models/target_options.rb +104 -0
- data/lib/peal/models/target_status_conflict_encoded.rb +227 -0
- data/lib/peal/models/text_override.rb +221 -0
- data/lib/peal/models/text_unit.rb +44 -0
- data/lib/peal/models/tik_tok_account.rb +203 -0
- data/lib/peal/models/tik_tok_account_posting.rb +103 -0
- data/lib/peal/models/tik_tok_account_posting_any_of.rb +227 -0
- data/lib/peal/models/tik_tok_account_posting_any_of1.rb +227 -0
- data/lib/peal/models/tik_tok_block.rb +41 -0
- data/lib/peal/models/tik_tok_creator.rb +357 -0
- data/lib/peal/models/tik_tok_options.rb +274 -0
- data/lib/peal/models/tik_tok_privacy_level.rb +42 -0
- data/lib/peal/models/too_many_invitations_encoded.rb +201 -0
- data/lib/peal/models/top_post.rb +337 -0
- data/lib/peal/models/translation_language.rb +48 -0
- data/lib/peal/models/unauthenticated_encoded.rb +201 -0
- data/lib/peal/models/unconfirmed_reason.rb +42 -0
- data/lib/peal/models/unknown_channels_encoded.rb +229 -0
- data/lib/peal/models/unknown_media_encoded.rb +229 -0
- data/lib/peal/models/unread_notices.rb +195 -0
- data/lib/peal/models/unsupported_media_type_encoded.rb +227 -0
- data/lib/peal/models/upload_incomplete_encoded.rb +201 -0
- data/lib/peal/models/upload_part.rb +265 -0
- data/lib/peal/models/upload_rejected_encoded.rb +227 -0
- data/lib/peal/models/upload_target.rb +103 -0
- data/lib/peal/models/upload_target_any_of.rb +253 -0
- data/lib/peal/models/upload_target_any_of1.rb +299 -0
- data/lib/peal/models/usage.rb +291 -0
- data/lib/peal/models/workspace_member.rb +281 -0
- data/lib/peal/models/workspace_not_found_encoded.rb +201 -0
- data/lib/peal/models/you_tube_options.rb +324 -0
- data/lib/peal/models/you_tube_privacy.rb +41 -0
- data/lib/peal/version.rb +15 -0
- data/lib/peal.rb +254 -0
- data/peal.gemspec +41 -0
- data/project.json +17 -0
- metadata +549 -0
data/docs/PostsApi.md
ADDED
|
@@ -0,0 +1,960 @@
|
|
|
1
|
+
# Peal::PostsApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://app.peal.social*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**posts_attempts**](PostsApi.md#posts_attempts) | **GET** /api/workspaces/{workspaceId}/posts/{postId}/attempts | List a post's attempts |
|
|
8
|
+
| [**posts_cancel**](PostsApi.md#posts_cancel) | **POST** /api/workspaces/{workspaceId}/posts/{postId}/cancel | Cancel a post |
|
|
9
|
+
| [**posts_confirm**](PostsApi.md#posts_confirm) | **POST** /api/workspaces/{workspaceId}/posts/{postId}/targets/{targetId}/confirm | Confirm a post on a channel |
|
|
10
|
+
| [**posts_create**](PostsApi.md#posts_create) | **POST** /api/workspaces/{workspaceId}/posts | Create a draft |
|
|
11
|
+
| [**posts_discard**](PostsApi.md#posts_discard) | **DELETE** /api/workspaces/{workspaceId}/posts/{postId} | Discard a draft |
|
|
12
|
+
| [**posts_drafts**](PostsApi.md#posts_drafts) | **GET** /api/workspaces/{workspaceId}/posts/drafts | List drafts |
|
|
13
|
+
| [**posts_get**](PostsApi.md#posts_get) | **GET** /api/workspaces/{workspaceId}/posts/{postId} | Get a post |
|
|
14
|
+
| [**posts_list**](PostsApi.md#posts_list) | **GET** /api/workspaces/{workspaceId}/posts | List scheduled posts |
|
|
15
|
+
| [**posts_repost**](PostsApi.md#posts_repost) | **POST** /api/workspaces/{workspaceId}/posts/{postId}/targets/{targetId}/repost | Repost on a channel |
|
|
16
|
+
| [**posts_reschedule**](PostsApi.md#posts_reschedule) | **POST** /api/workspaces/{workspaceId}/posts/{postId}/reschedule | Reschedule a post |
|
|
17
|
+
| [**posts_schedule**](PostsApi.md#posts_schedule) | **POST** /api/workspaces/{workspaceId}/posts/{postId}/schedule | Schedule a draft |
|
|
18
|
+
| [**posts_unschedule**](PostsApi.md#posts_unschedule) | **POST** /api/workspaces/{workspaceId}/posts/{postId}/unschedule | Unschedule a post |
|
|
19
|
+
| [**posts_update**](PostsApi.md#posts_update) | **PUT** /api/workspaces/{workspaceId}/posts/{postId} | Update a draft |
|
|
20
|
+
|
|
21
|
+
|
|
22
|
+
## posts_attempts
|
|
23
|
+
|
|
24
|
+
> <Array<PublicationAttempt>> posts_attempts(workspace_id, post_id)
|
|
25
|
+
|
|
26
|
+
List a post's attempts
|
|
27
|
+
|
|
28
|
+
Lists every attempt Peal made at publishing the post, by channel, round and attempt, with how each ended. An attempt still in progress is not listed yet. Needs post:read.
|
|
29
|
+
|
|
30
|
+
### Examples
|
|
31
|
+
|
|
32
|
+
```ruby
|
|
33
|
+
require 'time'
|
|
34
|
+
require 'peal'
|
|
35
|
+
# setup authorization
|
|
36
|
+
Peal.configure do |config|
|
|
37
|
+
# Configure Bearer authorization: bearer
|
|
38
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
39
|
+
end
|
|
40
|
+
|
|
41
|
+
api_instance = Peal::PostsApi.new
|
|
42
|
+
workspace_id = 'workspace_id_example' # String |
|
|
43
|
+
post_id = 'post_id_example' # String |
|
|
44
|
+
|
|
45
|
+
begin
|
|
46
|
+
# List a post's attempts
|
|
47
|
+
result = api_instance.posts_attempts(workspace_id, post_id)
|
|
48
|
+
p result
|
|
49
|
+
rescue Peal::ApiError => e
|
|
50
|
+
puts "Error when calling PostsApi->posts_attempts: #{e}"
|
|
51
|
+
end
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
#### Using the posts_attempts_with_http_info variant
|
|
55
|
+
|
|
56
|
+
This returns an Array which contains the response data, status code and headers.
|
|
57
|
+
|
|
58
|
+
> <Array(<Array<PublicationAttempt>>, Integer, Hash)> posts_attempts_with_http_info(workspace_id, post_id)
|
|
59
|
+
|
|
60
|
+
```ruby
|
|
61
|
+
begin
|
|
62
|
+
# List a post's attempts
|
|
63
|
+
data, status_code, headers = api_instance.posts_attempts_with_http_info(workspace_id, post_id)
|
|
64
|
+
p status_code # => 2xx
|
|
65
|
+
p headers # => { ... }
|
|
66
|
+
p data # => <Array<PublicationAttempt>>
|
|
67
|
+
rescue Peal::ApiError => e
|
|
68
|
+
puts "Error when calling PostsApi->posts_attempts_with_http_info: #{e}"
|
|
69
|
+
end
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
### Parameters
|
|
73
|
+
|
|
74
|
+
| Name | Type | Description | Notes |
|
|
75
|
+
| ---- | ---- | ----------- | ----- |
|
|
76
|
+
| **workspace_id** | **String** | | |
|
|
77
|
+
| **post_id** | **String** | | |
|
|
78
|
+
|
|
79
|
+
### Return type
|
|
80
|
+
|
|
81
|
+
[**Array<PublicationAttempt>**](PublicationAttempt.md)
|
|
82
|
+
|
|
83
|
+
### Authorization
|
|
84
|
+
|
|
85
|
+
[bearer](../README.md#bearer)
|
|
86
|
+
|
|
87
|
+
### HTTP request headers
|
|
88
|
+
|
|
89
|
+
- **Content-Type**: Not defined
|
|
90
|
+
- **Accept**: application/json
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
## posts_cancel
|
|
94
|
+
|
|
95
|
+
> <Post> posts_cancel(workspace_id, post_id)
|
|
96
|
+
|
|
97
|
+
Cancel a post
|
|
98
|
+
|
|
99
|
+
Cancels a draft or a scheduled post. A post already publishing finishes with what its channels did: those not yet sent are cancelled. Needs post:schedule.
|
|
100
|
+
|
|
101
|
+
### Examples
|
|
102
|
+
|
|
103
|
+
```ruby
|
|
104
|
+
require 'time'
|
|
105
|
+
require 'peal'
|
|
106
|
+
# setup authorization
|
|
107
|
+
Peal.configure do |config|
|
|
108
|
+
# Configure Bearer authorization: bearer
|
|
109
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
110
|
+
end
|
|
111
|
+
|
|
112
|
+
api_instance = Peal::PostsApi.new
|
|
113
|
+
workspace_id = 'workspace_id_example' # String |
|
|
114
|
+
post_id = 'post_id_example' # String |
|
|
115
|
+
|
|
116
|
+
begin
|
|
117
|
+
# Cancel a post
|
|
118
|
+
result = api_instance.posts_cancel(workspace_id, post_id)
|
|
119
|
+
p result
|
|
120
|
+
rescue Peal::ApiError => e
|
|
121
|
+
puts "Error when calling PostsApi->posts_cancel: #{e}"
|
|
122
|
+
end
|
|
123
|
+
```
|
|
124
|
+
|
|
125
|
+
#### Using the posts_cancel_with_http_info variant
|
|
126
|
+
|
|
127
|
+
This returns an Array which contains the response data, status code and headers.
|
|
128
|
+
|
|
129
|
+
> <Array(<Post>, Integer, Hash)> posts_cancel_with_http_info(workspace_id, post_id)
|
|
130
|
+
|
|
131
|
+
```ruby
|
|
132
|
+
begin
|
|
133
|
+
# Cancel a post
|
|
134
|
+
data, status_code, headers = api_instance.posts_cancel_with_http_info(workspace_id, post_id)
|
|
135
|
+
p status_code # => 2xx
|
|
136
|
+
p headers # => { ... }
|
|
137
|
+
p data # => <Post>
|
|
138
|
+
rescue Peal::ApiError => e
|
|
139
|
+
puts "Error when calling PostsApi->posts_cancel_with_http_info: #{e}"
|
|
140
|
+
end
|
|
141
|
+
```
|
|
142
|
+
|
|
143
|
+
### Parameters
|
|
144
|
+
|
|
145
|
+
| Name | Type | Description | Notes |
|
|
146
|
+
| ---- | ---- | ----------- | ----- |
|
|
147
|
+
| **workspace_id** | **String** | | |
|
|
148
|
+
| **post_id** | **String** | | |
|
|
149
|
+
|
|
150
|
+
### Return type
|
|
151
|
+
|
|
152
|
+
[**Post**](Post.md)
|
|
153
|
+
|
|
154
|
+
### Authorization
|
|
155
|
+
|
|
156
|
+
[bearer](../README.md#bearer)
|
|
157
|
+
|
|
158
|
+
### HTTP request headers
|
|
159
|
+
|
|
160
|
+
- **Content-Type**: Not defined
|
|
161
|
+
- **Accept**: application/json
|
|
162
|
+
|
|
163
|
+
|
|
164
|
+
## posts_confirm
|
|
165
|
+
|
|
166
|
+
> <Post> posts_confirm(workspace_id, post_id, target_id, target_confirmation)
|
|
167
|
+
|
|
168
|
+
Confirm a post on a channel
|
|
169
|
+
|
|
170
|
+
Says what you found on the platform for a post unconfirmed on one channel: `published`, with its address if you have it, or `notPublished`, which fails it there so it can be reposted. Its notifications are marked read. Needs post:schedule.
|
|
171
|
+
|
|
172
|
+
### Examples
|
|
173
|
+
|
|
174
|
+
```ruby
|
|
175
|
+
require 'time'
|
|
176
|
+
require 'peal'
|
|
177
|
+
# setup authorization
|
|
178
|
+
Peal.configure do |config|
|
|
179
|
+
# Configure Bearer authorization: bearer
|
|
180
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
181
|
+
end
|
|
182
|
+
|
|
183
|
+
api_instance = Peal::PostsApi.new
|
|
184
|
+
workspace_id = 'workspace_id_example' # String |
|
|
185
|
+
post_id = 'post_id_example' # String |
|
|
186
|
+
target_id = 'target_id_example' # String |
|
|
187
|
+
target_confirmation = Peal::TargetConfirmation.new({_tag: 'notPublished', permalink: 'permalink_example'}) # TargetConfirmation |
|
|
188
|
+
|
|
189
|
+
begin
|
|
190
|
+
# Confirm a post on a channel
|
|
191
|
+
result = api_instance.posts_confirm(workspace_id, post_id, target_id, target_confirmation)
|
|
192
|
+
p result
|
|
193
|
+
rescue Peal::ApiError => e
|
|
194
|
+
puts "Error when calling PostsApi->posts_confirm: #{e}"
|
|
195
|
+
end
|
|
196
|
+
```
|
|
197
|
+
|
|
198
|
+
#### Using the posts_confirm_with_http_info variant
|
|
199
|
+
|
|
200
|
+
This returns an Array which contains the response data, status code and headers.
|
|
201
|
+
|
|
202
|
+
> <Array(<Post>, Integer, Hash)> posts_confirm_with_http_info(workspace_id, post_id, target_id, target_confirmation)
|
|
203
|
+
|
|
204
|
+
```ruby
|
|
205
|
+
begin
|
|
206
|
+
# Confirm a post on a channel
|
|
207
|
+
data, status_code, headers = api_instance.posts_confirm_with_http_info(workspace_id, post_id, target_id, target_confirmation)
|
|
208
|
+
p status_code # => 2xx
|
|
209
|
+
p headers # => { ... }
|
|
210
|
+
p data # => <Post>
|
|
211
|
+
rescue Peal::ApiError => e
|
|
212
|
+
puts "Error when calling PostsApi->posts_confirm_with_http_info: #{e}"
|
|
213
|
+
end
|
|
214
|
+
```
|
|
215
|
+
|
|
216
|
+
### Parameters
|
|
217
|
+
|
|
218
|
+
| Name | Type | Description | Notes |
|
|
219
|
+
| ---- | ---- | ----------- | ----- |
|
|
220
|
+
| **workspace_id** | **String** | | |
|
|
221
|
+
| **post_id** | **String** | | |
|
|
222
|
+
| **target_id** | **String** | | |
|
|
223
|
+
| **target_confirmation** | [**TargetConfirmation**](TargetConfirmation.md) | | |
|
|
224
|
+
|
|
225
|
+
### Return type
|
|
226
|
+
|
|
227
|
+
[**Post**](Post.md)
|
|
228
|
+
|
|
229
|
+
### Authorization
|
|
230
|
+
|
|
231
|
+
[bearer](../README.md#bearer)
|
|
232
|
+
|
|
233
|
+
### HTTP request headers
|
|
234
|
+
|
|
235
|
+
- **Content-Type**: application/json
|
|
236
|
+
- **Accept**: application/json
|
|
237
|
+
|
|
238
|
+
|
|
239
|
+
## posts_create
|
|
240
|
+
|
|
241
|
+
> <Post> posts_create(workspace_id, post_draft)
|
|
242
|
+
|
|
243
|
+
Create a draft
|
|
244
|
+
|
|
245
|
+
Creates a draft for some of the workspace's channels, possibly none yet, with options on those whose platform takes them (`TargetOptions`, of the channel's platform). Its media must be the workspace's, and ready. Its text, media and options are checked against each platform's rules when it is scheduled, not before. Needs post:create, channel:read, and media:read when it shows media.
|
|
246
|
+
|
|
247
|
+
### Examples
|
|
248
|
+
|
|
249
|
+
```ruby
|
|
250
|
+
require 'time'
|
|
251
|
+
require 'peal'
|
|
252
|
+
# setup authorization
|
|
253
|
+
Peal.configure do |config|
|
|
254
|
+
# Configure Bearer authorization: bearer
|
|
255
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
256
|
+
end
|
|
257
|
+
|
|
258
|
+
api_instance = Peal::PostsApi.new
|
|
259
|
+
workspace_id = 'workspace_id_example' # String |
|
|
260
|
+
post_draft = Peal::PostDraft.new({channel_ids: ['channel_ids_example'], content: Peal::PostContent.new({media: [Peal::MediaAttachment.new({alt_text: 'alt_text_example', media_id: 'media_id_example'})], overrides: [Peal::TextOverride.new({channel_id: 'channel_id_example', text: 'text_example'})], text: 'text_example'})}) # PostDraft |
|
|
261
|
+
|
|
262
|
+
begin
|
|
263
|
+
# Create a draft
|
|
264
|
+
result = api_instance.posts_create(workspace_id, post_draft)
|
|
265
|
+
p result
|
|
266
|
+
rescue Peal::ApiError => e
|
|
267
|
+
puts "Error when calling PostsApi->posts_create: #{e}"
|
|
268
|
+
end
|
|
269
|
+
```
|
|
270
|
+
|
|
271
|
+
#### Using the posts_create_with_http_info variant
|
|
272
|
+
|
|
273
|
+
This returns an Array which contains the response data, status code and headers.
|
|
274
|
+
|
|
275
|
+
> <Array(<Post>, Integer, Hash)> posts_create_with_http_info(workspace_id, post_draft)
|
|
276
|
+
|
|
277
|
+
```ruby
|
|
278
|
+
begin
|
|
279
|
+
# Create a draft
|
|
280
|
+
data, status_code, headers = api_instance.posts_create_with_http_info(workspace_id, post_draft)
|
|
281
|
+
p status_code # => 2xx
|
|
282
|
+
p headers # => { ... }
|
|
283
|
+
p data # => <Post>
|
|
284
|
+
rescue Peal::ApiError => e
|
|
285
|
+
puts "Error when calling PostsApi->posts_create_with_http_info: #{e}"
|
|
286
|
+
end
|
|
287
|
+
```
|
|
288
|
+
|
|
289
|
+
### Parameters
|
|
290
|
+
|
|
291
|
+
| Name | Type | Description | Notes |
|
|
292
|
+
| ---- | ---- | ----------- | ----- |
|
|
293
|
+
| **workspace_id** | **String** | | |
|
|
294
|
+
| **post_draft** | [**PostDraft**](PostDraft.md) | | |
|
|
295
|
+
|
|
296
|
+
### Return type
|
|
297
|
+
|
|
298
|
+
[**Post**](Post.md)
|
|
299
|
+
|
|
300
|
+
### Authorization
|
|
301
|
+
|
|
302
|
+
[bearer](../README.md#bearer)
|
|
303
|
+
|
|
304
|
+
### HTTP request headers
|
|
305
|
+
|
|
306
|
+
- **Content-Type**: application/json
|
|
307
|
+
- **Accept**: application/json
|
|
308
|
+
|
|
309
|
+
|
|
310
|
+
## posts_discard
|
|
311
|
+
|
|
312
|
+
> posts_discard(workspace_id, post_id)
|
|
313
|
+
|
|
314
|
+
Discard a draft
|
|
315
|
+
|
|
316
|
+
Deletes a draft. A post scheduled or sent is a conflict: cancel it instead. Needs post:delete, or post:update for the user who created the draft.
|
|
317
|
+
|
|
318
|
+
### Examples
|
|
319
|
+
|
|
320
|
+
```ruby
|
|
321
|
+
require 'time'
|
|
322
|
+
require 'peal'
|
|
323
|
+
# setup authorization
|
|
324
|
+
Peal.configure do |config|
|
|
325
|
+
# Configure Bearer authorization: bearer
|
|
326
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
327
|
+
end
|
|
328
|
+
|
|
329
|
+
api_instance = Peal::PostsApi.new
|
|
330
|
+
workspace_id = 'workspace_id_example' # String |
|
|
331
|
+
post_id = 'post_id_example' # String |
|
|
332
|
+
|
|
333
|
+
begin
|
|
334
|
+
# Discard a draft
|
|
335
|
+
api_instance.posts_discard(workspace_id, post_id)
|
|
336
|
+
rescue Peal::ApiError => e
|
|
337
|
+
puts "Error when calling PostsApi->posts_discard: #{e}"
|
|
338
|
+
end
|
|
339
|
+
```
|
|
340
|
+
|
|
341
|
+
#### Using the posts_discard_with_http_info variant
|
|
342
|
+
|
|
343
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
344
|
+
|
|
345
|
+
> <Array(nil, Integer, Hash)> posts_discard_with_http_info(workspace_id, post_id)
|
|
346
|
+
|
|
347
|
+
```ruby
|
|
348
|
+
begin
|
|
349
|
+
# Discard a draft
|
|
350
|
+
data, status_code, headers = api_instance.posts_discard_with_http_info(workspace_id, post_id)
|
|
351
|
+
p status_code # => 2xx
|
|
352
|
+
p headers # => { ... }
|
|
353
|
+
p data # => nil
|
|
354
|
+
rescue Peal::ApiError => e
|
|
355
|
+
puts "Error when calling PostsApi->posts_discard_with_http_info: #{e}"
|
|
356
|
+
end
|
|
357
|
+
```
|
|
358
|
+
|
|
359
|
+
### Parameters
|
|
360
|
+
|
|
361
|
+
| Name | Type | Description | Notes |
|
|
362
|
+
| ---- | ---- | ----------- | ----- |
|
|
363
|
+
| **workspace_id** | **String** | | |
|
|
364
|
+
| **post_id** | **String** | | |
|
|
365
|
+
|
|
366
|
+
### Return type
|
|
367
|
+
|
|
368
|
+
nil (empty response body)
|
|
369
|
+
|
|
370
|
+
### Authorization
|
|
371
|
+
|
|
372
|
+
[bearer](../README.md#bearer)
|
|
373
|
+
|
|
374
|
+
### HTTP request headers
|
|
375
|
+
|
|
376
|
+
- **Content-Type**: Not defined
|
|
377
|
+
- **Accept**: application/json
|
|
378
|
+
|
|
379
|
+
|
|
380
|
+
## posts_drafts
|
|
381
|
+
|
|
382
|
+
> <DraftPage> posts_drafts(workspace_id, opts)
|
|
383
|
+
|
|
384
|
+
List drafts
|
|
385
|
+
|
|
386
|
+
Lists the workspace's drafts, newest first, 20 a page unless `limit` (at most 50) says otherwise. Pass the page's `nextCursor` as `cursor` for the next one. Needs post:read.
|
|
387
|
+
|
|
388
|
+
### Examples
|
|
389
|
+
|
|
390
|
+
```ruby
|
|
391
|
+
require 'time'
|
|
392
|
+
require 'peal'
|
|
393
|
+
# setup authorization
|
|
394
|
+
Peal.configure do |config|
|
|
395
|
+
# Configure Bearer authorization: bearer
|
|
396
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
397
|
+
end
|
|
398
|
+
|
|
399
|
+
api_instance = Peal::PostsApi.new
|
|
400
|
+
workspace_id = 'workspace_id_example' # String |
|
|
401
|
+
opts = {
|
|
402
|
+
cursor: 'cursor_example', # String |
|
|
403
|
+
limit: 'limit_example' # String |
|
|
404
|
+
}
|
|
405
|
+
|
|
406
|
+
begin
|
|
407
|
+
# List drafts
|
|
408
|
+
result = api_instance.posts_drafts(workspace_id, opts)
|
|
409
|
+
p result
|
|
410
|
+
rescue Peal::ApiError => e
|
|
411
|
+
puts "Error when calling PostsApi->posts_drafts: #{e}"
|
|
412
|
+
end
|
|
413
|
+
```
|
|
414
|
+
|
|
415
|
+
#### Using the posts_drafts_with_http_info variant
|
|
416
|
+
|
|
417
|
+
This returns an Array which contains the response data, status code and headers.
|
|
418
|
+
|
|
419
|
+
> <Array(<DraftPage>, Integer, Hash)> posts_drafts_with_http_info(workspace_id, opts)
|
|
420
|
+
|
|
421
|
+
```ruby
|
|
422
|
+
begin
|
|
423
|
+
# List drafts
|
|
424
|
+
data, status_code, headers = api_instance.posts_drafts_with_http_info(workspace_id, opts)
|
|
425
|
+
p status_code # => 2xx
|
|
426
|
+
p headers # => { ... }
|
|
427
|
+
p data # => <DraftPage>
|
|
428
|
+
rescue Peal::ApiError => e
|
|
429
|
+
puts "Error when calling PostsApi->posts_drafts_with_http_info: #{e}"
|
|
430
|
+
end
|
|
431
|
+
```
|
|
432
|
+
|
|
433
|
+
### Parameters
|
|
434
|
+
|
|
435
|
+
| Name | Type | Description | Notes |
|
|
436
|
+
| ---- | ---- | ----------- | ----- |
|
|
437
|
+
| **workspace_id** | **String** | | |
|
|
438
|
+
| **cursor** | **String** | | [optional] |
|
|
439
|
+
| **limit** | **String** | | [optional] |
|
|
440
|
+
|
|
441
|
+
### Return type
|
|
442
|
+
|
|
443
|
+
[**DraftPage**](DraftPage.md)
|
|
444
|
+
|
|
445
|
+
### Authorization
|
|
446
|
+
|
|
447
|
+
[bearer](../README.md#bearer)
|
|
448
|
+
|
|
449
|
+
### HTTP request headers
|
|
450
|
+
|
|
451
|
+
- **Content-Type**: Not defined
|
|
452
|
+
- **Accept**: application/json
|
|
453
|
+
|
|
454
|
+
|
|
455
|
+
## posts_get
|
|
456
|
+
|
|
457
|
+
> <Post> posts_get(workspace_id, post_id)
|
|
458
|
+
|
|
459
|
+
Get a post
|
|
460
|
+
|
|
461
|
+
Answers with a post of the workspace. Needs post:read.
|
|
462
|
+
|
|
463
|
+
### Examples
|
|
464
|
+
|
|
465
|
+
```ruby
|
|
466
|
+
require 'time'
|
|
467
|
+
require 'peal'
|
|
468
|
+
# setup authorization
|
|
469
|
+
Peal.configure do |config|
|
|
470
|
+
# Configure Bearer authorization: bearer
|
|
471
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
472
|
+
end
|
|
473
|
+
|
|
474
|
+
api_instance = Peal::PostsApi.new
|
|
475
|
+
workspace_id = 'workspace_id_example' # String |
|
|
476
|
+
post_id = 'post_id_example' # String |
|
|
477
|
+
|
|
478
|
+
begin
|
|
479
|
+
# Get a post
|
|
480
|
+
result = api_instance.posts_get(workspace_id, post_id)
|
|
481
|
+
p result
|
|
482
|
+
rescue Peal::ApiError => e
|
|
483
|
+
puts "Error when calling PostsApi->posts_get: #{e}"
|
|
484
|
+
end
|
|
485
|
+
```
|
|
486
|
+
|
|
487
|
+
#### Using the posts_get_with_http_info variant
|
|
488
|
+
|
|
489
|
+
This returns an Array which contains the response data, status code and headers.
|
|
490
|
+
|
|
491
|
+
> <Array(<Post>, Integer, Hash)> posts_get_with_http_info(workspace_id, post_id)
|
|
492
|
+
|
|
493
|
+
```ruby
|
|
494
|
+
begin
|
|
495
|
+
# Get a post
|
|
496
|
+
data, status_code, headers = api_instance.posts_get_with_http_info(workspace_id, post_id)
|
|
497
|
+
p status_code # => 2xx
|
|
498
|
+
p headers # => { ... }
|
|
499
|
+
p data # => <Post>
|
|
500
|
+
rescue Peal::ApiError => e
|
|
501
|
+
puts "Error when calling PostsApi->posts_get_with_http_info: #{e}"
|
|
502
|
+
end
|
|
503
|
+
```
|
|
504
|
+
|
|
505
|
+
### Parameters
|
|
506
|
+
|
|
507
|
+
| Name | Type | Description | Notes |
|
|
508
|
+
| ---- | ---- | ----------- | ----- |
|
|
509
|
+
| **workspace_id** | **String** | | |
|
|
510
|
+
| **post_id** | **String** | | |
|
|
511
|
+
|
|
512
|
+
### Return type
|
|
513
|
+
|
|
514
|
+
[**Post**](Post.md)
|
|
515
|
+
|
|
516
|
+
### Authorization
|
|
517
|
+
|
|
518
|
+
[bearer](../README.md#bearer)
|
|
519
|
+
|
|
520
|
+
### HTTP request headers
|
|
521
|
+
|
|
522
|
+
- **Content-Type**: Not defined
|
|
523
|
+
- **Accept**: application/json
|
|
524
|
+
|
|
525
|
+
|
|
526
|
+
## posts_list
|
|
527
|
+
|
|
528
|
+
> <Array<Post>> posts_list(workspace_id, from, to)
|
|
529
|
+
|
|
530
|
+
List scheduled posts
|
|
531
|
+
|
|
532
|
+
Lists the posts scheduled from `from` (included) to `to` (excluded), at most 62 days apart, by scheduled instant, with their channels and how each went. Drafts have no time and are not listed; cancelled posts are, with the time they had. Needs post:read.
|
|
533
|
+
|
|
534
|
+
### Examples
|
|
535
|
+
|
|
536
|
+
```ruby
|
|
537
|
+
require 'time'
|
|
538
|
+
require 'peal'
|
|
539
|
+
# setup authorization
|
|
540
|
+
Peal.configure do |config|
|
|
541
|
+
# Configure Bearer authorization: bearer
|
|
542
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
543
|
+
end
|
|
544
|
+
|
|
545
|
+
api_instance = Peal::PostsApi.new
|
|
546
|
+
workspace_id = 'workspace_id_example' # String |
|
|
547
|
+
from = 'from_example' # String |
|
|
548
|
+
to = 'to_example' # String |
|
|
549
|
+
|
|
550
|
+
begin
|
|
551
|
+
# List scheduled posts
|
|
552
|
+
result = api_instance.posts_list(workspace_id, from, to)
|
|
553
|
+
p result
|
|
554
|
+
rescue Peal::ApiError => e
|
|
555
|
+
puts "Error when calling PostsApi->posts_list: #{e}"
|
|
556
|
+
end
|
|
557
|
+
```
|
|
558
|
+
|
|
559
|
+
#### Using the posts_list_with_http_info variant
|
|
560
|
+
|
|
561
|
+
This returns an Array which contains the response data, status code and headers.
|
|
562
|
+
|
|
563
|
+
> <Array(<Array<Post>>, Integer, Hash)> posts_list_with_http_info(workspace_id, from, to)
|
|
564
|
+
|
|
565
|
+
```ruby
|
|
566
|
+
begin
|
|
567
|
+
# List scheduled posts
|
|
568
|
+
data, status_code, headers = api_instance.posts_list_with_http_info(workspace_id, from, to)
|
|
569
|
+
p status_code # => 2xx
|
|
570
|
+
p headers # => { ... }
|
|
571
|
+
p data # => <Array<Post>>
|
|
572
|
+
rescue Peal::ApiError => e
|
|
573
|
+
puts "Error when calling PostsApi->posts_list_with_http_info: #{e}"
|
|
574
|
+
end
|
|
575
|
+
```
|
|
576
|
+
|
|
577
|
+
### Parameters
|
|
578
|
+
|
|
579
|
+
| Name | Type | Description | Notes |
|
|
580
|
+
| ---- | ---- | ----------- | ----- |
|
|
581
|
+
| **workspace_id** | **String** | | |
|
|
582
|
+
| **from** | **String** | | |
|
|
583
|
+
| **to** | **String** | | |
|
|
584
|
+
|
|
585
|
+
### Return type
|
|
586
|
+
|
|
587
|
+
[**Array<Post>**](Post.md)
|
|
588
|
+
|
|
589
|
+
### Authorization
|
|
590
|
+
|
|
591
|
+
[bearer](../README.md#bearer)
|
|
592
|
+
|
|
593
|
+
### HTTP request headers
|
|
594
|
+
|
|
595
|
+
- **Content-Type**: Not defined
|
|
596
|
+
- **Accept**: application/json
|
|
597
|
+
|
|
598
|
+
|
|
599
|
+
## posts_repost
|
|
600
|
+
|
|
601
|
+
> <Post> posts_repost(workspace_id, post_id, target_id)
|
|
602
|
+
|
|
603
|
+
Repost on a channel
|
|
604
|
+
|
|
605
|
+
Sends the post again, now, on one channel where it failed or is unconfirmed: a new round, with its own attempts. Check the platform first when it is unconfirmed, as it may be live already. Needs post:schedule.
|
|
606
|
+
|
|
607
|
+
### Examples
|
|
608
|
+
|
|
609
|
+
```ruby
|
|
610
|
+
require 'time'
|
|
611
|
+
require 'peal'
|
|
612
|
+
# setup authorization
|
|
613
|
+
Peal.configure do |config|
|
|
614
|
+
# Configure Bearer authorization: bearer
|
|
615
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
616
|
+
end
|
|
617
|
+
|
|
618
|
+
api_instance = Peal::PostsApi.new
|
|
619
|
+
workspace_id = 'workspace_id_example' # String |
|
|
620
|
+
post_id = 'post_id_example' # String |
|
|
621
|
+
target_id = 'target_id_example' # String |
|
|
622
|
+
|
|
623
|
+
begin
|
|
624
|
+
# Repost on a channel
|
|
625
|
+
result = api_instance.posts_repost(workspace_id, post_id, target_id)
|
|
626
|
+
p result
|
|
627
|
+
rescue Peal::ApiError => e
|
|
628
|
+
puts "Error when calling PostsApi->posts_repost: #{e}"
|
|
629
|
+
end
|
|
630
|
+
```
|
|
631
|
+
|
|
632
|
+
#### Using the posts_repost_with_http_info variant
|
|
633
|
+
|
|
634
|
+
This returns an Array which contains the response data, status code and headers.
|
|
635
|
+
|
|
636
|
+
> <Array(<Post>, Integer, Hash)> posts_repost_with_http_info(workspace_id, post_id, target_id)
|
|
637
|
+
|
|
638
|
+
```ruby
|
|
639
|
+
begin
|
|
640
|
+
# Repost on a channel
|
|
641
|
+
data, status_code, headers = api_instance.posts_repost_with_http_info(workspace_id, post_id, target_id)
|
|
642
|
+
p status_code # => 2xx
|
|
643
|
+
p headers # => { ... }
|
|
644
|
+
p data # => <Post>
|
|
645
|
+
rescue Peal::ApiError => e
|
|
646
|
+
puts "Error when calling PostsApi->posts_repost_with_http_info: #{e}"
|
|
647
|
+
end
|
|
648
|
+
```
|
|
649
|
+
|
|
650
|
+
### Parameters
|
|
651
|
+
|
|
652
|
+
| Name | Type | Description | Notes |
|
|
653
|
+
| ---- | ---- | ----------- | ----- |
|
|
654
|
+
| **workspace_id** | **String** | | |
|
|
655
|
+
| **post_id** | **String** | | |
|
|
656
|
+
| **target_id** | **String** | | |
|
|
657
|
+
|
|
658
|
+
### Return type
|
|
659
|
+
|
|
660
|
+
[**Post**](Post.md)
|
|
661
|
+
|
|
662
|
+
### Authorization
|
|
663
|
+
|
|
664
|
+
[bearer](../README.md#bearer)
|
|
665
|
+
|
|
666
|
+
### HTTP request headers
|
|
667
|
+
|
|
668
|
+
- **Content-Type**: Not defined
|
|
669
|
+
- **Accept**: application/json
|
|
670
|
+
|
|
671
|
+
|
|
672
|
+
## posts_reschedule
|
|
673
|
+
|
|
674
|
+
> <Post> posts_reschedule(workspace_id, post_id, post_schedule)
|
|
675
|
+
|
|
676
|
+
Reschedule a post
|
|
677
|
+
|
|
678
|
+
Moves a scheduled post to another instant, or schedules a draft on the channels it has. Moved to another month, or scheduled, it must fit that month's posts in the workspace's plan (PlanLimitReached). Needs post:schedule, and channel:read for a draft.
|
|
679
|
+
|
|
680
|
+
### Examples
|
|
681
|
+
|
|
682
|
+
```ruby
|
|
683
|
+
require 'time'
|
|
684
|
+
require 'peal'
|
|
685
|
+
# setup authorization
|
|
686
|
+
Peal.configure do |config|
|
|
687
|
+
# Configure Bearer authorization: bearer
|
|
688
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
689
|
+
end
|
|
690
|
+
|
|
691
|
+
api_instance = Peal::PostsApi.new
|
|
692
|
+
workspace_id = 'workspace_id_example' # String |
|
|
693
|
+
post_id = 'post_id_example' # String |
|
|
694
|
+
post_schedule = Peal::PostSchedule.new({at: 'at_example', time_zone: 'time_zone_example'}) # PostSchedule |
|
|
695
|
+
|
|
696
|
+
begin
|
|
697
|
+
# Reschedule a post
|
|
698
|
+
result = api_instance.posts_reschedule(workspace_id, post_id, post_schedule)
|
|
699
|
+
p result
|
|
700
|
+
rescue Peal::ApiError => e
|
|
701
|
+
puts "Error when calling PostsApi->posts_reschedule: #{e}"
|
|
702
|
+
end
|
|
703
|
+
```
|
|
704
|
+
|
|
705
|
+
#### Using the posts_reschedule_with_http_info variant
|
|
706
|
+
|
|
707
|
+
This returns an Array which contains the response data, status code and headers.
|
|
708
|
+
|
|
709
|
+
> <Array(<Post>, Integer, Hash)> posts_reschedule_with_http_info(workspace_id, post_id, post_schedule)
|
|
710
|
+
|
|
711
|
+
```ruby
|
|
712
|
+
begin
|
|
713
|
+
# Reschedule a post
|
|
714
|
+
data, status_code, headers = api_instance.posts_reschedule_with_http_info(workspace_id, post_id, post_schedule)
|
|
715
|
+
p status_code # => 2xx
|
|
716
|
+
p headers # => { ... }
|
|
717
|
+
p data # => <Post>
|
|
718
|
+
rescue Peal::ApiError => e
|
|
719
|
+
puts "Error when calling PostsApi->posts_reschedule_with_http_info: #{e}"
|
|
720
|
+
end
|
|
721
|
+
```
|
|
722
|
+
|
|
723
|
+
### Parameters
|
|
724
|
+
|
|
725
|
+
| Name | Type | Description | Notes |
|
|
726
|
+
| ---- | ---- | ----------- | ----- |
|
|
727
|
+
| **workspace_id** | **String** | | |
|
|
728
|
+
| **post_id** | **String** | | |
|
|
729
|
+
| **post_schedule** | [**PostSchedule**](PostSchedule.md) | | |
|
|
730
|
+
|
|
731
|
+
### Return type
|
|
732
|
+
|
|
733
|
+
[**Post**](Post.md)
|
|
734
|
+
|
|
735
|
+
### Authorization
|
|
736
|
+
|
|
737
|
+
[bearer](../README.md#bearer)
|
|
738
|
+
|
|
739
|
+
### HTTP request headers
|
|
740
|
+
|
|
741
|
+
- **Content-Type**: application/json
|
|
742
|
+
- **Accept**: application/json
|
|
743
|
+
|
|
744
|
+
|
|
745
|
+
## posts_schedule
|
|
746
|
+
|
|
747
|
+
> <Post> posts_schedule(workspace_id, post_id, schedule_post)
|
|
748
|
+
|
|
749
|
+
Schedule a draft
|
|
750
|
+
|
|
751
|
+
Schedules a draft on some of the workspace's channels at an instant, kept with the IANA time zone it was chosen in. The content must fit each platform's rules, its media included: file types, sizes, durations, dimensions, alt text, how many videos, and whether images and videos go together. A channel whose platform takes options needs those it requires, as the draft gives them on that channel: a channel the draft was not for has none yet. A time up to a minute ago publishes now. On a server that bills, the posts going out in that month (UTC) must fit the workspace's plan (PlanLimitReached). Needs post:schedule and channel:read, and media:read when it shows media.
|
|
752
|
+
|
|
753
|
+
### Examples
|
|
754
|
+
|
|
755
|
+
```ruby
|
|
756
|
+
require 'time'
|
|
757
|
+
require 'peal'
|
|
758
|
+
# setup authorization
|
|
759
|
+
Peal.configure do |config|
|
|
760
|
+
# Configure Bearer authorization: bearer
|
|
761
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
762
|
+
end
|
|
763
|
+
|
|
764
|
+
api_instance = Peal::PostsApi.new
|
|
765
|
+
workspace_id = 'workspace_id_example' # String |
|
|
766
|
+
post_id = 'post_id_example' # String |
|
|
767
|
+
schedule_post = Peal::SchedulePost.new({at: 'at_example', channel_ids: ['channel_ids_example'], time_zone: 'time_zone_example'}) # SchedulePost |
|
|
768
|
+
|
|
769
|
+
begin
|
|
770
|
+
# Schedule a draft
|
|
771
|
+
result = api_instance.posts_schedule(workspace_id, post_id, schedule_post)
|
|
772
|
+
p result
|
|
773
|
+
rescue Peal::ApiError => e
|
|
774
|
+
puts "Error when calling PostsApi->posts_schedule: #{e}"
|
|
775
|
+
end
|
|
776
|
+
```
|
|
777
|
+
|
|
778
|
+
#### Using the posts_schedule_with_http_info variant
|
|
779
|
+
|
|
780
|
+
This returns an Array which contains the response data, status code and headers.
|
|
781
|
+
|
|
782
|
+
> <Array(<Post>, Integer, Hash)> posts_schedule_with_http_info(workspace_id, post_id, schedule_post)
|
|
783
|
+
|
|
784
|
+
```ruby
|
|
785
|
+
begin
|
|
786
|
+
# Schedule a draft
|
|
787
|
+
data, status_code, headers = api_instance.posts_schedule_with_http_info(workspace_id, post_id, schedule_post)
|
|
788
|
+
p status_code # => 2xx
|
|
789
|
+
p headers # => { ... }
|
|
790
|
+
p data # => <Post>
|
|
791
|
+
rescue Peal::ApiError => e
|
|
792
|
+
puts "Error when calling PostsApi->posts_schedule_with_http_info: #{e}"
|
|
793
|
+
end
|
|
794
|
+
```
|
|
795
|
+
|
|
796
|
+
### Parameters
|
|
797
|
+
|
|
798
|
+
| Name | Type | Description | Notes |
|
|
799
|
+
| ---- | ---- | ----------- | ----- |
|
|
800
|
+
| **workspace_id** | **String** | | |
|
|
801
|
+
| **post_id** | **String** | | |
|
|
802
|
+
| **schedule_post** | [**SchedulePost**](SchedulePost.md) | | |
|
|
803
|
+
|
|
804
|
+
### Return type
|
|
805
|
+
|
|
806
|
+
[**Post**](Post.md)
|
|
807
|
+
|
|
808
|
+
### Authorization
|
|
809
|
+
|
|
810
|
+
[bearer](../README.md#bearer)
|
|
811
|
+
|
|
812
|
+
### HTTP request headers
|
|
813
|
+
|
|
814
|
+
- **Content-Type**: application/json
|
|
815
|
+
- **Accept**: application/json
|
|
816
|
+
|
|
817
|
+
|
|
818
|
+
## posts_unschedule
|
|
819
|
+
|
|
820
|
+
> <Post> posts_unschedule(workspace_id, post_id)
|
|
821
|
+
|
|
822
|
+
Unschedule a post
|
|
823
|
+
|
|
824
|
+
Takes a scheduled post back to draft, so its text and media can change: it goes out at no time until it is scheduled again. A post already publishing is a conflict. Needs post:schedule.
|
|
825
|
+
|
|
826
|
+
### Examples
|
|
827
|
+
|
|
828
|
+
```ruby
|
|
829
|
+
require 'time'
|
|
830
|
+
require 'peal'
|
|
831
|
+
# setup authorization
|
|
832
|
+
Peal.configure do |config|
|
|
833
|
+
# Configure Bearer authorization: bearer
|
|
834
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
835
|
+
end
|
|
836
|
+
|
|
837
|
+
api_instance = Peal::PostsApi.new
|
|
838
|
+
workspace_id = 'workspace_id_example' # String |
|
|
839
|
+
post_id = 'post_id_example' # String |
|
|
840
|
+
|
|
841
|
+
begin
|
|
842
|
+
# Unschedule a post
|
|
843
|
+
result = api_instance.posts_unschedule(workspace_id, post_id)
|
|
844
|
+
p result
|
|
845
|
+
rescue Peal::ApiError => e
|
|
846
|
+
puts "Error when calling PostsApi->posts_unschedule: #{e}"
|
|
847
|
+
end
|
|
848
|
+
```
|
|
849
|
+
|
|
850
|
+
#### Using the posts_unschedule_with_http_info variant
|
|
851
|
+
|
|
852
|
+
This returns an Array which contains the response data, status code and headers.
|
|
853
|
+
|
|
854
|
+
> <Array(<Post>, Integer, Hash)> posts_unschedule_with_http_info(workspace_id, post_id)
|
|
855
|
+
|
|
856
|
+
```ruby
|
|
857
|
+
begin
|
|
858
|
+
# Unschedule a post
|
|
859
|
+
data, status_code, headers = api_instance.posts_unschedule_with_http_info(workspace_id, post_id)
|
|
860
|
+
p status_code # => 2xx
|
|
861
|
+
p headers # => { ... }
|
|
862
|
+
p data # => <Post>
|
|
863
|
+
rescue Peal::ApiError => e
|
|
864
|
+
puts "Error when calling PostsApi->posts_unschedule_with_http_info: #{e}"
|
|
865
|
+
end
|
|
866
|
+
```
|
|
867
|
+
|
|
868
|
+
### Parameters
|
|
869
|
+
|
|
870
|
+
| Name | Type | Description | Notes |
|
|
871
|
+
| ---- | ---- | ----------- | ----- |
|
|
872
|
+
| **workspace_id** | **String** | | |
|
|
873
|
+
| **post_id** | **String** | | |
|
|
874
|
+
|
|
875
|
+
### Return type
|
|
876
|
+
|
|
877
|
+
[**Post**](Post.md)
|
|
878
|
+
|
|
879
|
+
### Authorization
|
|
880
|
+
|
|
881
|
+
[bearer](../README.md#bearer)
|
|
882
|
+
|
|
883
|
+
### HTTP request headers
|
|
884
|
+
|
|
885
|
+
- **Content-Type**: Not defined
|
|
886
|
+
- **Accept**: application/json
|
|
887
|
+
|
|
888
|
+
|
|
889
|
+
## posts_update
|
|
890
|
+
|
|
891
|
+
> <Post> posts_update(workspace_id, post_id, post_draft)
|
|
892
|
+
|
|
893
|
+
Update a draft
|
|
894
|
+
|
|
895
|
+
Replaces a draft's content, channels and options: options left out are removed. A post that is no longer a draft is a conflict. Needs post:update, channel:read, and media:read when it shows media.
|
|
896
|
+
|
|
897
|
+
### Examples
|
|
898
|
+
|
|
899
|
+
```ruby
|
|
900
|
+
require 'time'
|
|
901
|
+
require 'peal'
|
|
902
|
+
# setup authorization
|
|
903
|
+
Peal.configure do |config|
|
|
904
|
+
# Configure Bearer authorization: bearer
|
|
905
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
906
|
+
end
|
|
907
|
+
|
|
908
|
+
api_instance = Peal::PostsApi.new
|
|
909
|
+
workspace_id = 'workspace_id_example' # String |
|
|
910
|
+
post_id = 'post_id_example' # String |
|
|
911
|
+
post_draft = Peal::PostDraft.new({channel_ids: ['channel_ids_example'], content: Peal::PostContent.new({media: [Peal::MediaAttachment.new({alt_text: 'alt_text_example', media_id: 'media_id_example'})], overrides: [Peal::TextOverride.new({channel_id: 'channel_id_example', text: 'text_example'})], text: 'text_example'})}) # PostDraft |
|
|
912
|
+
|
|
913
|
+
begin
|
|
914
|
+
# Update a draft
|
|
915
|
+
result = api_instance.posts_update(workspace_id, post_id, post_draft)
|
|
916
|
+
p result
|
|
917
|
+
rescue Peal::ApiError => e
|
|
918
|
+
puts "Error when calling PostsApi->posts_update: #{e}"
|
|
919
|
+
end
|
|
920
|
+
```
|
|
921
|
+
|
|
922
|
+
#### Using the posts_update_with_http_info variant
|
|
923
|
+
|
|
924
|
+
This returns an Array which contains the response data, status code and headers.
|
|
925
|
+
|
|
926
|
+
> <Array(<Post>, Integer, Hash)> posts_update_with_http_info(workspace_id, post_id, post_draft)
|
|
927
|
+
|
|
928
|
+
```ruby
|
|
929
|
+
begin
|
|
930
|
+
# Update a draft
|
|
931
|
+
data, status_code, headers = api_instance.posts_update_with_http_info(workspace_id, post_id, post_draft)
|
|
932
|
+
p status_code # => 2xx
|
|
933
|
+
p headers # => { ... }
|
|
934
|
+
p data # => <Post>
|
|
935
|
+
rescue Peal::ApiError => e
|
|
936
|
+
puts "Error when calling PostsApi->posts_update_with_http_info: #{e}"
|
|
937
|
+
end
|
|
938
|
+
```
|
|
939
|
+
|
|
940
|
+
### Parameters
|
|
941
|
+
|
|
942
|
+
| Name | Type | Description | Notes |
|
|
943
|
+
| ---- | ---- | ----------- | ----- |
|
|
944
|
+
| **workspace_id** | **String** | | |
|
|
945
|
+
| **post_id** | **String** | | |
|
|
946
|
+
| **post_draft** | [**PostDraft**](PostDraft.md) | | |
|
|
947
|
+
|
|
948
|
+
### Return type
|
|
949
|
+
|
|
950
|
+
[**Post**](Post.md)
|
|
951
|
+
|
|
952
|
+
### Authorization
|
|
953
|
+
|
|
954
|
+
[bearer](../README.md#bearer)
|
|
955
|
+
|
|
956
|
+
### HTTP request headers
|
|
957
|
+
|
|
958
|
+
- **Content-Type**: application/json
|
|
959
|
+
- **Accept**: application/json
|
|
960
|
+
|