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
|
@@ -0,0 +1,526 @@
|
|
|
1
|
+
=begin
|
|
2
|
+
#Peal API
|
|
3
|
+
|
|
4
|
+
#Schedule posts across social platforms, follow how they did, and manage a Peal workspace's channels, media and members.
|
|
5
|
+
|
|
6
|
+
The version of the OpenAPI document: 0.0.1
|
|
7
|
+
Contact: hello@peal.social
|
|
8
|
+
Generated by: https://openapi-generator.tech
|
|
9
|
+
Generator version: 7.27.0
|
|
10
|
+
|
|
11
|
+
=end
|
|
12
|
+
|
|
13
|
+
require 'cgi'
|
|
14
|
+
|
|
15
|
+
module Peal
|
|
16
|
+
class MediaApi
|
|
17
|
+
attr_accessor :api_client
|
|
18
|
+
|
|
19
|
+
def initialize(api_client = ApiClient.default)
|
|
20
|
+
@api_client = api_client
|
|
21
|
+
end
|
|
22
|
+
# Complete an upload
|
|
23
|
+
# Checks that the file reached the store with the declared size and type, joining its parts first, then probes it: the media is ready, or stays uploaded with why it could not be probed. Calling it again is safe, and probes an uploaded file again. Needs media:upload.
|
|
24
|
+
# @param workspace_id [String]
|
|
25
|
+
# @param media_id [String]
|
|
26
|
+
# @param [Hash] opts the optional parameters
|
|
27
|
+
# @return [Media]
|
|
28
|
+
def media_complete(workspace_id, media_id, opts = {})
|
|
29
|
+
data, _status_code, _headers = media_complete_with_http_info(workspace_id, media_id, opts)
|
|
30
|
+
data
|
|
31
|
+
end
|
|
32
|
+
|
|
33
|
+
# Complete an upload
|
|
34
|
+
# Checks that the file reached the store with the declared size and type, joining its parts first, then probes it: the media is ready, or stays uploaded with why it could not be probed. Calling it again is safe, and probes an uploaded file again. Needs media:upload.
|
|
35
|
+
# @param workspace_id [String]
|
|
36
|
+
# @param media_id [String]
|
|
37
|
+
# @param [Hash] opts the optional parameters
|
|
38
|
+
# @return [Array<(Media, Integer, Hash)>] Media data, response status code and response headers
|
|
39
|
+
def media_complete_with_http_info(workspace_id, media_id, opts = {})
|
|
40
|
+
if @api_client.config.debugging
|
|
41
|
+
@api_client.config.logger.debug 'Calling API: MediaApi.media_complete ...'
|
|
42
|
+
end
|
|
43
|
+
# verify the required parameter 'workspace_id' is set
|
|
44
|
+
if @api_client.config.client_side_validation && workspace_id.nil?
|
|
45
|
+
fail ArgumentError, "Missing the required parameter 'workspace_id' when calling MediaApi.media_complete"
|
|
46
|
+
end
|
|
47
|
+
# verify the required parameter 'media_id' is set
|
|
48
|
+
if @api_client.config.client_side_validation && media_id.nil?
|
|
49
|
+
fail ArgumentError, "Missing the required parameter 'media_id' when calling MediaApi.media_complete"
|
|
50
|
+
end
|
|
51
|
+
# resource path
|
|
52
|
+
local_var_path = '/api/workspaces/{workspaceId}/media/{mediaId}/complete'.sub('{workspaceId}', CGI.escape(workspace_id.to_s)).sub('{mediaId}', CGI.escape(media_id.to_s))
|
|
53
|
+
|
|
54
|
+
# query parameters
|
|
55
|
+
query_params = opts[:query_params] || {}
|
|
56
|
+
|
|
57
|
+
# header parameters
|
|
58
|
+
header_params = opts[:header_params] || {}
|
|
59
|
+
# HTTP header 'Accept' (if needed)
|
|
60
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
61
|
+
|
|
62
|
+
# form parameters
|
|
63
|
+
form_params = opts[:form_params] || {}
|
|
64
|
+
|
|
65
|
+
# http body (model)
|
|
66
|
+
post_body = opts[:debug_body]
|
|
67
|
+
|
|
68
|
+
# return_type
|
|
69
|
+
return_type = opts[:debug_return_type] || 'Media'
|
|
70
|
+
|
|
71
|
+
# auth_names
|
|
72
|
+
auth_names = opts[:debug_auth_names] || ['bearer']
|
|
73
|
+
|
|
74
|
+
new_options = opts.merge(
|
|
75
|
+
:operation => :"MediaApi.media_complete",
|
|
76
|
+
:header_params => header_params,
|
|
77
|
+
:query_params => query_params,
|
|
78
|
+
:form_params => form_params,
|
|
79
|
+
:body => post_body,
|
|
80
|
+
:auth_names => auth_names,
|
|
81
|
+
:return_type => return_type
|
|
82
|
+
)
|
|
83
|
+
|
|
84
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
85
|
+
if @api_client.config.debugging
|
|
86
|
+
@api_client.config.logger.debug "API called: MediaApi#media_complete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
87
|
+
end
|
|
88
|
+
return data, status_code, headers
|
|
89
|
+
end
|
|
90
|
+
|
|
91
|
+
# Start an upload
|
|
92
|
+
# Records pending media and signs the upload of its file: one PUT for an image or a video up to 16 MiB, one PUT per part for a larger video. Send the file with them, then complete the upload. The requests only take the declared size and content type. Needs media:upload.
|
|
93
|
+
# @param workspace_id [String]
|
|
94
|
+
# @param new_upload [NewUpload]
|
|
95
|
+
# @param [Hash] opts the optional parameters
|
|
96
|
+
# @return [PreparedUpload]
|
|
97
|
+
def media_create(workspace_id, new_upload, opts = {})
|
|
98
|
+
data, _status_code, _headers = media_create_with_http_info(workspace_id, new_upload, opts)
|
|
99
|
+
data
|
|
100
|
+
end
|
|
101
|
+
|
|
102
|
+
# Start an upload
|
|
103
|
+
# Records pending media and signs the upload of its file: one PUT for an image or a video up to 16 MiB, one PUT per part for a larger video. Send the file with them, then complete the upload. The requests only take the declared size and content type. Needs media:upload.
|
|
104
|
+
# @param workspace_id [String]
|
|
105
|
+
# @param new_upload [NewUpload]
|
|
106
|
+
# @param [Hash] opts the optional parameters
|
|
107
|
+
# @return [Array<(PreparedUpload, Integer, Hash)>] PreparedUpload data, response status code and response headers
|
|
108
|
+
def media_create_with_http_info(workspace_id, new_upload, opts = {})
|
|
109
|
+
if @api_client.config.debugging
|
|
110
|
+
@api_client.config.logger.debug 'Calling API: MediaApi.media_create ...'
|
|
111
|
+
end
|
|
112
|
+
# verify the required parameter 'workspace_id' is set
|
|
113
|
+
if @api_client.config.client_side_validation && workspace_id.nil?
|
|
114
|
+
fail ArgumentError, "Missing the required parameter 'workspace_id' when calling MediaApi.media_create"
|
|
115
|
+
end
|
|
116
|
+
# verify the required parameter 'new_upload' is set
|
|
117
|
+
if @api_client.config.client_side_validation && new_upload.nil?
|
|
118
|
+
fail ArgumentError, "Missing the required parameter 'new_upload' when calling MediaApi.media_create"
|
|
119
|
+
end
|
|
120
|
+
# resource path
|
|
121
|
+
local_var_path = '/api/workspaces/{workspaceId}/media'.sub('{workspaceId}', CGI.escape(workspace_id.to_s))
|
|
122
|
+
|
|
123
|
+
# query parameters
|
|
124
|
+
query_params = opts[:query_params] || {}
|
|
125
|
+
|
|
126
|
+
# header parameters
|
|
127
|
+
header_params = opts[:header_params] || {}
|
|
128
|
+
# HTTP header 'Accept' (if needed)
|
|
129
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
130
|
+
# HTTP header 'Content-Type'
|
|
131
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
132
|
+
if !content_type.nil?
|
|
133
|
+
header_params['Content-Type'] = content_type
|
|
134
|
+
end
|
|
135
|
+
|
|
136
|
+
# form parameters
|
|
137
|
+
form_params = opts[:form_params] || {}
|
|
138
|
+
|
|
139
|
+
# http body (model)
|
|
140
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(new_upload)
|
|
141
|
+
|
|
142
|
+
# return_type
|
|
143
|
+
return_type = opts[:debug_return_type] || 'PreparedUpload'
|
|
144
|
+
|
|
145
|
+
# auth_names
|
|
146
|
+
auth_names = opts[:debug_auth_names] || ['bearer']
|
|
147
|
+
|
|
148
|
+
new_options = opts.merge(
|
|
149
|
+
:operation => :"MediaApi.media_create",
|
|
150
|
+
:header_params => header_params,
|
|
151
|
+
:query_params => query_params,
|
|
152
|
+
:form_params => form_params,
|
|
153
|
+
:body => post_body,
|
|
154
|
+
:auth_names => auth_names,
|
|
155
|
+
:return_type => return_type
|
|
156
|
+
)
|
|
157
|
+
|
|
158
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
159
|
+
if @api_client.config.debugging
|
|
160
|
+
@api_client.config.logger.debug "API called: MediaApi#media_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
161
|
+
end
|
|
162
|
+
return data, status_code, headers
|
|
163
|
+
end
|
|
164
|
+
|
|
165
|
+
# Delete media
|
|
166
|
+
# Deletes the media and its file, and cancels its upload if it is still pending. Drafts that show it lose it. Posts scheduled or publishing that show it refuse the deletion (`MediaInUse`, listing them): take them back to draft first. Needs media:delete.
|
|
167
|
+
# @param workspace_id [String]
|
|
168
|
+
# @param media_id [String]
|
|
169
|
+
# @param [Hash] opts the optional parameters
|
|
170
|
+
# @return [nil]
|
|
171
|
+
def media_delete(workspace_id, media_id, opts = {})
|
|
172
|
+
media_delete_with_http_info(workspace_id, media_id, opts)
|
|
173
|
+
nil
|
|
174
|
+
end
|
|
175
|
+
|
|
176
|
+
# Delete media
|
|
177
|
+
# Deletes the media and its file, and cancels its upload if it is still pending. Drafts that show it lose it. Posts scheduled or publishing that show it refuse the deletion (`MediaInUse`, listing them): take them back to draft first. Needs media:delete.
|
|
178
|
+
# @param workspace_id [String]
|
|
179
|
+
# @param media_id [String]
|
|
180
|
+
# @param [Hash] opts the optional parameters
|
|
181
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
182
|
+
def media_delete_with_http_info(workspace_id, media_id, opts = {})
|
|
183
|
+
if @api_client.config.debugging
|
|
184
|
+
@api_client.config.logger.debug 'Calling API: MediaApi.media_delete ...'
|
|
185
|
+
end
|
|
186
|
+
# verify the required parameter 'workspace_id' is set
|
|
187
|
+
if @api_client.config.client_side_validation && workspace_id.nil?
|
|
188
|
+
fail ArgumentError, "Missing the required parameter 'workspace_id' when calling MediaApi.media_delete"
|
|
189
|
+
end
|
|
190
|
+
# verify the required parameter 'media_id' is set
|
|
191
|
+
if @api_client.config.client_side_validation && media_id.nil?
|
|
192
|
+
fail ArgumentError, "Missing the required parameter 'media_id' when calling MediaApi.media_delete"
|
|
193
|
+
end
|
|
194
|
+
# resource path
|
|
195
|
+
local_var_path = '/api/workspaces/{workspaceId}/media/{mediaId}'.sub('{workspaceId}', CGI.escape(workspace_id.to_s)).sub('{mediaId}', CGI.escape(media_id.to_s))
|
|
196
|
+
|
|
197
|
+
# query parameters
|
|
198
|
+
query_params = opts[:query_params] || {}
|
|
199
|
+
|
|
200
|
+
# header parameters
|
|
201
|
+
header_params = opts[:header_params] || {}
|
|
202
|
+
# HTTP header 'Accept' (if needed)
|
|
203
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
204
|
+
|
|
205
|
+
# form parameters
|
|
206
|
+
form_params = opts[:form_params] || {}
|
|
207
|
+
|
|
208
|
+
# http body (model)
|
|
209
|
+
post_body = opts[:debug_body]
|
|
210
|
+
|
|
211
|
+
# return_type
|
|
212
|
+
return_type = opts[:debug_return_type]
|
|
213
|
+
|
|
214
|
+
# auth_names
|
|
215
|
+
auth_names = opts[:debug_auth_names] || ['bearer']
|
|
216
|
+
|
|
217
|
+
new_options = opts.merge(
|
|
218
|
+
:operation => :"MediaApi.media_delete",
|
|
219
|
+
:header_params => header_params,
|
|
220
|
+
:query_params => query_params,
|
|
221
|
+
:form_params => form_params,
|
|
222
|
+
:body => post_body,
|
|
223
|
+
:auth_names => auth_names,
|
|
224
|
+
:return_type => return_type
|
|
225
|
+
)
|
|
226
|
+
|
|
227
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
|
228
|
+
if @api_client.config.debugging
|
|
229
|
+
@api_client.config.logger.debug "API called: MediaApi#media_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
230
|
+
end
|
|
231
|
+
return data, status_code, headers
|
|
232
|
+
end
|
|
233
|
+
|
|
234
|
+
# Describe media
|
|
235
|
+
# Sets the media's description, which platforms show to people who cannot see it. It can be written while the file uploads. Needs media:upload.
|
|
236
|
+
# @param workspace_id [String]
|
|
237
|
+
# @param media_id [String]
|
|
238
|
+
# @param media_description [MediaDescription]
|
|
239
|
+
# @param [Hash] opts the optional parameters
|
|
240
|
+
# @return [Media]
|
|
241
|
+
def media_describe(workspace_id, media_id, media_description, opts = {})
|
|
242
|
+
data, _status_code, _headers = media_describe_with_http_info(workspace_id, media_id, media_description, opts)
|
|
243
|
+
data
|
|
244
|
+
end
|
|
245
|
+
|
|
246
|
+
# Describe media
|
|
247
|
+
# Sets the media's description, which platforms show to people who cannot see it. It can be written while the file uploads. Needs media:upload.
|
|
248
|
+
# @param workspace_id [String]
|
|
249
|
+
# @param media_id [String]
|
|
250
|
+
# @param media_description [MediaDescription]
|
|
251
|
+
# @param [Hash] opts the optional parameters
|
|
252
|
+
# @return [Array<(Media, Integer, Hash)>] Media data, response status code and response headers
|
|
253
|
+
def media_describe_with_http_info(workspace_id, media_id, media_description, opts = {})
|
|
254
|
+
if @api_client.config.debugging
|
|
255
|
+
@api_client.config.logger.debug 'Calling API: MediaApi.media_describe ...'
|
|
256
|
+
end
|
|
257
|
+
# verify the required parameter 'workspace_id' is set
|
|
258
|
+
if @api_client.config.client_side_validation && workspace_id.nil?
|
|
259
|
+
fail ArgumentError, "Missing the required parameter 'workspace_id' when calling MediaApi.media_describe"
|
|
260
|
+
end
|
|
261
|
+
# verify the required parameter 'media_id' is set
|
|
262
|
+
if @api_client.config.client_side_validation && media_id.nil?
|
|
263
|
+
fail ArgumentError, "Missing the required parameter 'media_id' when calling MediaApi.media_describe"
|
|
264
|
+
end
|
|
265
|
+
# verify the required parameter 'media_description' is set
|
|
266
|
+
if @api_client.config.client_side_validation && media_description.nil?
|
|
267
|
+
fail ArgumentError, "Missing the required parameter 'media_description' when calling MediaApi.media_describe"
|
|
268
|
+
end
|
|
269
|
+
# resource path
|
|
270
|
+
local_var_path = '/api/workspaces/{workspaceId}/media/{mediaId}'.sub('{workspaceId}', CGI.escape(workspace_id.to_s)).sub('{mediaId}', CGI.escape(media_id.to_s))
|
|
271
|
+
|
|
272
|
+
# query parameters
|
|
273
|
+
query_params = opts[:query_params] || {}
|
|
274
|
+
|
|
275
|
+
# header parameters
|
|
276
|
+
header_params = opts[:header_params] || {}
|
|
277
|
+
# HTTP header 'Accept' (if needed)
|
|
278
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
279
|
+
# HTTP header 'Content-Type'
|
|
280
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
281
|
+
if !content_type.nil?
|
|
282
|
+
header_params['Content-Type'] = content_type
|
|
283
|
+
end
|
|
284
|
+
|
|
285
|
+
# form parameters
|
|
286
|
+
form_params = opts[:form_params] || {}
|
|
287
|
+
|
|
288
|
+
# http body (model)
|
|
289
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(media_description)
|
|
290
|
+
|
|
291
|
+
# return_type
|
|
292
|
+
return_type = opts[:debug_return_type] || 'Media'
|
|
293
|
+
|
|
294
|
+
# auth_names
|
|
295
|
+
auth_names = opts[:debug_auth_names] || ['bearer']
|
|
296
|
+
|
|
297
|
+
new_options = opts.merge(
|
|
298
|
+
:operation => :"MediaApi.media_describe",
|
|
299
|
+
:header_params => header_params,
|
|
300
|
+
:query_params => query_params,
|
|
301
|
+
:form_params => form_params,
|
|
302
|
+
:body => post_body,
|
|
303
|
+
:auth_names => auth_names,
|
|
304
|
+
:return_type => return_type
|
|
305
|
+
)
|
|
306
|
+
|
|
307
|
+
data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
|
|
308
|
+
if @api_client.config.debugging
|
|
309
|
+
@api_client.config.logger.debug "API called: MediaApi#media_describe\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
310
|
+
end
|
|
311
|
+
return data, status_code, headers
|
|
312
|
+
end
|
|
313
|
+
|
|
314
|
+
# Get media
|
|
315
|
+
# Shows one of the workspace's media. Needs media:read.
|
|
316
|
+
# @param workspace_id [String]
|
|
317
|
+
# @param media_id [String]
|
|
318
|
+
# @param [Hash] opts the optional parameters
|
|
319
|
+
# @return [Media]
|
|
320
|
+
def media_get(workspace_id, media_id, opts = {})
|
|
321
|
+
data, _status_code, _headers = media_get_with_http_info(workspace_id, media_id, opts)
|
|
322
|
+
data
|
|
323
|
+
end
|
|
324
|
+
|
|
325
|
+
# Get media
|
|
326
|
+
# Shows one of the workspace's media. Needs media:read.
|
|
327
|
+
# @param workspace_id [String]
|
|
328
|
+
# @param media_id [String]
|
|
329
|
+
# @param [Hash] opts the optional parameters
|
|
330
|
+
# @return [Array<(Media, Integer, Hash)>] Media data, response status code and response headers
|
|
331
|
+
def media_get_with_http_info(workspace_id, media_id, opts = {})
|
|
332
|
+
if @api_client.config.debugging
|
|
333
|
+
@api_client.config.logger.debug 'Calling API: MediaApi.media_get ...'
|
|
334
|
+
end
|
|
335
|
+
# verify the required parameter 'workspace_id' is set
|
|
336
|
+
if @api_client.config.client_side_validation && workspace_id.nil?
|
|
337
|
+
fail ArgumentError, "Missing the required parameter 'workspace_id' when calling MediaApi.media_get"
|
|
338
|
+
end
|
|
339
|
+
# verify the required parameter 'media_id' is set
|
|
340
|
+
if @api_client.config.client_side_validation && media_id.nil?
|
|
341
|
+
fail ArgumentError, "Missing the required parameter 'media_id' when calling MediaApi.media_get"
|
|
342
|
+
end
|
|
343
|
+
# resource path
|
|
344
|
+
local_var_path = '/api/workspaces/{workspaceId}/media/{mediaId}'.sub('{workspaceId}', CGI.escape(workspace_id.to_s)).sub('{mediaId}', CGI.escape(media_id.to_s))
|
|
345
|
+
|
|
346
|
+
# query parameters
|
|
347
|
+
query_params = opts[:query_params] || {}
|
|
348
|
+
|
|
349
|
+
# header parameters
|
|
350
|
+
header_params = opts[:header_params] || {}
|
|
351
|
+
# HTTP header 'Accept' (if needed)
|
|
352
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
353
|
+
|
|
354
|
+
# form parameters
|
|
355
|
+
form_params = opts[:form_params] || {}
|
|
356
|
+
|
|
357
|
+
# http body (model)
|
|
358
|
+
post_body = opts[:debug_body]
|
|
359
|
+
|
|
360
|
+
# return_type
|
|
361
|
+
return_type = opts[:debug_return_type] || 'Media'
|
|
362
|
+
|
|
363
|
+
# auth_names
|
|
364
|
+
auth_names = opts[:debug_auth_names] || ['bearer']
|
|
365
|
+
|
|
366
|
+
new_options = opts.merge(
|
|
367
|
+
:operation => :"MediaApi.media_get",
|
|
368
|
+
:header_params => header_params,
|
|
369
|
+
:query_params => query_params,
|
|
370
|
+
:form_params => form_params,
|
|
371
|
+
:body => post_body,
|
|
372
|
+
:auth_names => auth_names,
|
|
373
|
+
:return_type => return_type
|
|
374
|
+
)
|
|
375
|
+
|
|
376
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
377
|
+
if @api_client.config.debugging
|
|
378
|
+
@api_client.config.logger.debug "API called: MediaApi#media_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
379
|
+
end
|
|
380
|
+
return data, status_code, headers
|
|
381
|
+
end
|
|
382
|
+
|
|
383
|
+
# List media
|
|
384
|
+
# Lists the workspace's media, newest first, 30 a page unless `limit` (at most 100) says otherwise. Pass the page's `nextCursor` as `cursor` for the next one. Needs media:read.
|
|
385
|
+
# @param workspace_id [String]
|
|
386
|
+
# @param [Hash] opts the optional parameters
|
|
387
|
+
# @option opts [String] :cursor
|
|
388
|
+
# @option opts [String] :limit
|
|
389
|
+
# @return [MediaPage]
|
|
390
|
+
def media_list(workspace_id, opts = {})
|
|
391
|
+
data, _status_code, _headers = media_list_with_http_info(workspace_id, opts)
|
|
392
|
+
data
|
|
393
|
+
end
|
|
394
|
+
|
|
395
|
+
# List media
|
|
396
|
+
# Lists the workspace's media, newest first, 30 a page unless `limit` (at most 100) says otherwise. Pass the page's `nextCursor` as `cursor` for the next one. Needs media:read.
|
|
397
|
+
# @param workspace_id [String]
|
|
398
|
+
# @param [Hash] opts the optional parameters
|
|
399
|
+
# @option opts [String] :cursor
|
|
400
|
+
# @option opts [String] :limit
|
|
401
|
+
# @return [Array<(MediaPage, Integer, Hash)>] MediaPage data, response status code and response headers
|
|
402
|
+
def media_list_with_http_info(workspace_id, opts = {})
|
|
403
|
+
if @api_client.config.debugging
|
|
404
|
+
@api_client.config.logger.debug 'Calling API: MediaApi.media_list ...'
|
|
405
|
+
end
|
|
406
|
+
# verify the required parameter 'workspace_id' is set
|
|
407
|
+
if @api_client.config.client_side_validation && workspace_id.nil?
|
|
408
|
+
fail ArgumentError, "Missing the required parameter 'workspace_id' when calling MediaApi.media_list"
|
|
409
|
+
end
|
|
410
|
+
pattern = Regexp.new(/^[+-]?(?:\d+(?:\.\d+)?|\.\d+)(?:[Ee][+-]?\d+)?$/)
|
|
411
|
+
if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] !~ pattern
|
|
412
|
+
fail ArgumentError, "invalid value for 'opts[:\"limit\"]' when calling MediaApi.media_list, must conform to the pattern #{pattern}."
|
|
413
|
+
end
|
|
414
|
+
|
|
415
|
+
# resource path
|
|
416
|
+
local_var_path = '/api/workspaces/{workspaceId}/media'.sub('{workspaceId}', CGI.escape(workspace_id.to_s))
|
|
417
|
+
|
|
418
|
+
# query parameters
|
|
419
|
+
query_params = opts[:query_params] || {}
|
|
420
|
+
query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
|
|
421
|
+
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
|
|
422
|
+
|
|
423
|
+
# header parameters
|
|
424
|
+
header_params = opts[:header_params] || {}
|
|
425
|
+
# HTTP header 'Accept' (if needed)
|
|
426
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
427
|
+
|
|
428
|
+
# form parameters
|
|
429
|
+
form_params = opts[:form_params] || {}
|
|
430
|
+
|
|
431
|
+
# http body (model)
|
|
432
|
+
post_body = opts[:debug_body]
|
|
433
|
+
|
|
434
|
+
# return_type
|
|
435
|
+
return_type = opts[:debug_return_type] || 'MediaPage'
|
|
436
|
+
|
|
437
|
+
# auth_names
|
|
438
|
+
auth_names = opts[:debug_auth_names] || ['bearer']
|
|
439
|
+
|
|
440
|
+
new_options = opts.merge(
|
|
441
|
+
:operation => :"MediaApi.media_list",
|
|
442
|
+
:header_params => header_params,
|
|
443
|
+
:query_params => query_params,
|
|
444
|
+
:form_params => form_params,
|
|
445
|
+
:body => post_body,
|
|
446
|
+
:auth_names => auth_names,
|
|
447
|
+
:return_type => return_type
|
|
448
|
+
)
|
|
449
|
+
|
|
450
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
451
|
+
if @api_client.config.debugging
|
|
452
|
+
@api_client.config.logger.debug "API called: MediaApi#media_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
453
|
+
end
|
|
454
|
+
return data, status_code, headers
|
|
455
|
+
end
|
|
456
|
+
|
|
457
|
+
# Get where media is used
|
|
458
|
+
# Lists the posts that show the media: drafts, which lose it if it is deleted, and posts scheduled or publishing, which keep it from being deleted. Needs media:read.
|
|
459
|
+
# @param workspace_id [String]
|
|
460
|
+
# @param media_id [String]
|
|
461
|
+
# @param [Hash] opts the optional parameters
|
|
462
|
+
# @return [MediaUsage]
|
|
463
|
+
def media_usage(workspace_id, media_id, opts = {})
|
|
464
|
+
data, _status_code, _headers = media_usage_with_http_info(workspace_id, media_id, opts)
|
|
465
|
+
data
|
|
466
|
+
end
|
|
467
|
+
|
|
468
|
+
# Get where media is used
|
|
469
|
+
# Lists the posts that show the media: drafts, which lose it if it is deleted, and posts scheduled or publishing, which keep it from being deleted. Needs media:read.
|
|
470
|
+
# @param workspace_id [String]
|
|
471
|
+
# @param media_id [String]
|
|
472
|
+
# @param [Hash] opts the optional parameters
|
|
473
|
+
# @return [Array<(MediaUsage, Integer, Hash)>] MediaUsage data, response status code and response headers
|
|
474
|
+
def media_usage_with_http_info(workspace_id, media_id, opts = {})
|
|
475
|
+
if @api_client.config.debugging
|
|
476
|
+
@api_client.config.logger.debug 'Calling API: MediaApi.media_usage ...'
|
|
477
|
+
end
|
|
478
|
+
# verify the required parameter 'workspace_id' is set
|
|
479
|
+
if @api_client.config.client_side_validation && workspace_id.nil?
|
|
480
|
+
fail ArgumentError, "Missing the required parameter 'workspace_id' when calling MediaApi.media_usage"
|
|
481
|
+
end
|
|
482
|
+
# verify the required parameter 'media_id' is set
|
|
483
|
+
if @api_client.config.client_side_validation && media_id.nil?
|
|
484
|
+
fail ArgumentError, "Missing the required parameter 'media_id' when calling MediaApi.media_usage"
|
|
485
|
+
end
|
|
486
|
+
# resource path
|
|
487
|
+
local_var_path = '/api/workspaces/{workspaceId}/media/{mediaId}/usage'.sub('{workspaceId}', CGI.escape(workspace_id.to_s)).sub('{mediaId}', CGI.escape(media_id.to_s))
|
|
488
|
+
|
|
489
|
+
# query parameters
|
|
490
|
+
query_params = opts[:query_params] || {}
|
|
491
|
+
|
|
492
|
+
# header parameters
|
|
493
|
+
header_params = opts[:header_params] || {}
|
|
494
|
+
# HTTP header 'Accept' (if needed)
|
|
495
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
496
|
+
|
|
497
|
+
# form parameters
|
|
498
|
+
form_params = opts[:form_params] || {}
|
|
499
|
+
|
|
500
|
+
# http body (model)
|
|
501
|
+
post_body = opts[:debug_body]
|
|
502
|
+
|
|
503
|
+
# return_type
|
|
504
|
+
return_type = opts[:debug_return_type] || 'MediaUsage'
|
|
505
|
+
|
|
506
|
+
# auth_names
|
|
507
|
+
auth_names = opts[:debug_auth_names] || ['bearer']
|
|
508
|
+
|
|
509
|
+
new_options = opts.merge(
|
|
510
|
+
:operation => :"MediaApi.media_usage",
|
|
511
|
+
:header_params => header_params,
|
|
512
|
+
:query_params => query_params,
|
|
513
|
+
:form_params => form_params,
|
|
514
|
+
:body => post_body,
|
|
515
|
+
:auth_names => auth_names,
|
|
516
|
+
:return_type => return_type
|
|
517
|
+
)
|
|
518
|
+
|
|
519
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
520
|
+
if @api_client.config.debugging
|
|
521
|
+
@api_client.config.logger.debug "API called: MediaApi#media_usage\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
522
|
+
end
|
|
523
|
+
return data, status_code, headers
|
|
524
|
+
end
|
|
525
|
+
end
|
|
526
|
+
end
|
|
@@ -0,0 +1,85 @@
|
|
|
1
|
+
=begin
|
|
2
|
+
#Peal API
|
|
3
|
+
|
|
4
|
+
#Schedule posts across social platforms, follow how they did, and manage a Peal workspace's channels, media and members.
|
|
5
|
+
|
|
6
|
+
The version of the OpenAPI document: 0.0.1
|
|
7
|
+
Contact: hello@peal.social
|
|
8
|
+
Generated by: https://openapi-generator.tech
|
|
9
|
+
Generator version: 7.27.0
|
|
10
|
+
|
|
11
|
+
=end
|
|
12
|
+
|
|
13
|
+
require 'cgi'
|
|
14
|
+
|
|
15
|
+
module Peal
|
|
16
|
+
class MembersApi
|
|
17
|
+
attr_accessor :api_client
|
|
18
|
+
|
|
19
|
+
def initialize(api_client = ApiClient.default)
|
|
20
|
+
@api_client = api_client
|
|
21
|
+
end
|
|
22
|
+
# List members
|
|
23
|
+
# Lists the workspace's members, in the order they joined, with their name, email address and role. Every member may see them, as the workspace's settings show them; an API key may not, as members' addresses are not a script's to read.
|
|
24
|
+
# @param workspace_id [String]
|
|
25
|
+
# @param [Hash] opts the optional parameters
|
|
26
|
+
# @return [Array<WorkspaceMember>]
|
|
27
|
+
def members_list(workspace_id, opts = {})
|
|
28
|
+
data, _status_code, _headers = members_list_with_http_info(workspace_id, opts)
|
|
29
|
+
data
|
|
30
|
+
end
|
|
31
|
+
|
|
32
|
+
# List members
|
|
33
|
+
# Lists the workspace's members, in the order they joined, with their name, email address and role. Every member may see them, as the workspace's settings show them; an API key may not, as members' addresses are not a script's to read.
|
|
34
|
+
# @param workspace_id [String]
|
|
35
|
+
# @param [Hash] opts the optional parameters
|
|
36
|
+
# @return [Array<(Array<WorkspaceMember>, Integer, Hash)>] Array<WorkspaceMember> data, response status code and response headers
|
|
37
|
+
def members_list_with_http_info(workspace_id, opts = {})
|
|
38
|
+
if @api_client.config.debugging
|
|
39
|
+
@api_client.config.logger.debug 'Calling API: MembersApi.members_list ...'
|
|
40
|
+
end
|
|
41
|
+
# verify the required parameter 'workspace_id' is set
|
|
42
|
+
if @api_client.config.client_side_validation && workspace_id.nil?
|
|
43
|
+
fail ArgumentError, "Missing the required parameter 'workspace_id' when calling MembersApi.members_list"
|
|
44
|
+
end
|
|
45
|
+
# resource path
|
|
46
|
+
local_var_path = '/api/workspaces/{workspaceId}/members'.sub('{workspaceId}', CGI.escape(workspace_id.to_s))
|
|
47
|
+
|
|
48
|
+
# query parameters
|
|
49
|
+
query_params = opts[:query_params] || {}
|
|
50
|
+
|
|
51
|
+
# header parameters
|
|
52
|
+
header_params = opts[:header_params] || {}
|
|
53
|
+
# HTTP header 'Accept' (if needed)
|
|
54
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
55
|
+
|
|
56
|
+
# form parameters
|
|
57
|
+
form_params = opts[:form_params] || {}
|
|
58
|
+
|
|
59
|
+
# http body (model)
|
|
60
|
+
post_body = opts[:debug_body]
|
|
61
|
+
|
|
62
|
+
# return_type
|
|
63
|
+
return_type = opts[:debug_return_type] || 'Array<WorkspaceMember>'
|
|
64
|
+
|
|
65
|
+
# auth_names
|
|
66
|
+
auth_names = opts[:debug_auth_names] || ['bearer']
|
|
67
|
+
|
|
68
|
+
new_options = opts.merge(
|
|
69
|
+
:operation => :"MembersApi.members_list",
|
|
70
|
+
:header_params => header_params,
|
|
71
|
+
:query_params => query_params,
|
|
72
|
+
:form_params => form_params,
|
|
73
|
+
:body => post_body,
|
|
74
|
+
:auth_names => auth_names,
|
|
75
|
+
:return_type => return_type
|
|
76
|
+
)
|
|
77
|
+
|
|
78
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
79
|
+
if @api_client.config.debugging
|
|
80
|
+
@api_client.config.logger.debug "API called: MembersApi#members_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
81
|
+
end
|
|
82
|
+
return data, status_code, headers
|
|
83
|
+
end
|
|
84
|
+
end
|
|
85
|
+
end
|