peal 0.1.0 → 0.3.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.
Files changed (747) hide show
  1. checksums.yaml +4 -4
  2. data/NOTICE +4 -0
  3. data/README.md +171 -319
  4. data/lib/peal/analytics/client.rb +120 -0
  5. data/lib/peal/analytics/types/post_analytics_request.rb +13 -0
  6. data/lib/peal/analytics/types/summary_analytics_request.rb +17 -0
  7. data/lib/peal/api_keys/client.rb +153 -0
  8. data/lib/peal/api_keys/types/list_api_keys_request.rb +11 -0
  9. data/lib/peal/api_keys/types/new_api_key.rb +17 -0
  10. data/lib/peal/api_keys/types/revoke_api_keys_request.rb +13 -0
  11. data/lib/peal/assistant/client.rb +112 -0
  12. data/lib/peal/assistant/types/status_assistant_request.rb +11 -0
  13. data/lib/peal/assistant/types/suggestion_request.rb +15 -0
  14. data/lib/peal/billing/client.rb +58 -0
  15. data/lib/peal/billing/types/get_billing_request.rb +11 -0
  16. data/lib/peal/channels/client.rb +366 -0
  17. data/lib/peal/channels/types/choose_accounts.rb +17 -0
  18. data/lib/peal/channels/types/connect_callback.rb +21 -0
  19. data/lib/peal/channels/types/connect_channel.rb +17 -0
  20. data/lib/peal/channels/types/disconnect_channels_request.rb +13 -0
  21. data/lib/peal/channels/types/list_channels_request.rb +11 -0
  22. data/lib/peal/channels/types/platforms_channels_request.rb +11 -0
  23. data/lib/peal/channels/types/reconnect_channels_request.rb +13 -0
  24. data/lib/peal/client.rb +93 -0
  25. data/lib/peal/environment.rb +7 -0
  26. data/lib/peal/errors/api_error.rb +8 -0
  27. data/lib/peal/errors/client_error.rb +17 -0
  28. data/lib/peal/errors/connection_error.rb +11 -0
  29. data/lib/peal/errors/redirect_error.rb +8 -0
  30. data/lib/peal/errors/response_error.rb +65 -0
  31. data/lib/peal/errors/server_error.rb +11 -0
  32. data/lib/peal/errors/timeout_error.rb +8 -0
  33. data/lib/peal/internal/errors/constraint_error.rb +10 -0
  34. data/lib/peal/internal/errors/type_error.rb +10 -0
  35. data/lib/peal/internal/http/base_request.rb +83 -0
  36. data/lib/peal/internal/http/raw_client.rb +297 -0
  37. data/lib/peal/internal/iterators/cursor_item_iterator.rb +33 -0
  38. data/lib/peal/internal/iterators/cursor_page_iterator.rb +126 -0
  39. data/lib/peal/internal/iterators/item_iterator.rb +120 -0
  40. data/lib/peal/internal/iterators/offset_item_iterator.rb +35 -0
  41. data/lib/peal/internal/iterators/offset_page_iterator.rb +160 -0
  42. data/lib/peal/internal/json/request.rb +51 -0
  43. data/lib/peal/internal/json/serializable.rb +25 -0
  44. data/lib/peal/internal/multipart/multipart_encoder.rb +141 -0
  45. data/lib/peal/internal/multipart/multipart_form_data.rb +84 -0
  46. data/lib/peal/internal/multipart/multipart_form_data_part.rb +51 -0
  47. data/lib/peal/internal/multipart/multipart_request.rb +42 -0
  48. data/lib/peal/internal/types/array.rb +47 -0
  49. data/lib/peal/internal/types/boolean.rb +34 -0
  50. data/lib/peal/internal/types/enum.rb +56 -0
  51. data/lib/peal/internal/types/hash.rb +36 -0
  52. data/lib/peal/internal/types/model/field.rb +38 -0
  53. data/lib/peal/internal/types/model.rb +258 -0
  54. data/lib/peal/internal/types/type.rb +35 -0
  55. data/lib/peal/internal/types/union.rb +161 -0
  56. data/lib/peal/internal/types/unknown.rb +15 -0
  57. data/lib/peal/internal/types/utils.rb +144 -0
  58. data/lib/peal/invitations/client.rb +160 -0
  59. data/lib/peal/invitations/types/list_invitations_request.rb +11 -0
  60. data/lib/peal/invitations/types/new_invitation.rb +15 -0
  61. data/lib/peal/invitations/types/revoke_invitations_request.rb +13 -0
  62. data/lib/peal/media/client.rb +360 -0
  63. data/lib/peal/media/types/complete_media_request.rb +13 -0
  64. data/lib/peal/media/types/delete_media_request.rb +13 -0
  65. data/lib/peal/media/types/get_media_request.rb +13 -0
  66. data/lib/peal/media/types/list_media_request.rb +15 -0
  67. data/lib/peal/media/types/media_description.rb +15 -0
  68. data/lib/peal/media/types/new_upload.rb +17 -0
  69. data/lib/peal/media/types/usage_media_request.rb +13 -0
  70. data/lib/peal/members/client.rb +58 -0
  71. data/lib/peal/members/types/list_members_request.rb +11 -0
  72. data/lib/peal/notices/client.rb +189 -0
  73. data/lib/peal/notices/types/list_notices_request.rb +13 -0
  74. data/lib/peal/notices/types/mark_notices_read.rb +11 -0
  75. data/lib/peal/notification_preferences/client.rb +100 -0
  76. data/lib/peal/notification_preferences/types/notification_preferences_change.rb +13 -0
  77. data/lib/peal/notification_preferences/types/notification_preferences_change_email.rb +19 -0
  78. data/lib/peal/posts/client.rb +703 -0
  79. data/lib/peal/posts/types/attempts_posts_request.rb +13 -0
  80. data/lib/peal/posts/types/cancel_posts_request.rb +13 -0
  81. data/lib/peal/posts/types/confirm_posts_request.rb +17 -0
  82. data/lib/peal/posts/types/create_posts_request.rb +13 -0
  83. data/lib/peal/posts/types/discard_posts_request.rb +13 -0
  84. data/lib/peal/posts/types/drafts_posts_request.rb +15 -0
  85. data/lib/peal/posts/types/get_posts_request.rb +13 -0
  86. data/lib/peal/posts/types/list_posts_request.rb +15 -0
  87. data/lib/peal/posts/types/repost_posts_request.rb +15 -0
  88. data/lib/peal/posts/types/reschedule_posts_request.rb +15 -0
  89. data/lib/peal/posts/types/schedule_post.rb +19 -0
  90. data/lib/peal/posts/types/unschedule_posts_request.rb +13 -0
  91. data/lib/peal/posts/types/update_posts_request.rb +15 -0
  92. data/lib/peal/session/client.rb +55 -0
  93. data/lib/peal/system/client.rb +82 -0
  94. data/lib/peal/tiktok/client.rb +62 -0
  95. data/lib/peal/tiktok/types/creator_tiktok_request.rb +13 -0
  96. data/lib/peal/types/already_member_encoded.rb +9 -0
  97. data/lib/peal/types/alt_text_too_long_encoded.rb +13 -0
  98. data/lib/peal/types/alt_text_too_long_encoded_tag.rb +13 -0
  99. data/lib/peal/types/analytics_summary.rb +23 -0
  100. data/lib/peal/types/api_key.rb +21 -0
  101. data/lib/peal/types/api_key_not_found_encoded.rb +9 -0
  102. data/lib/peal/types/assistant_action.rb +21 -0
  103. data/lib/peal/types/assistant_action_hashtags.rb +9 -0
  104. data/lib/peal/types/assistant_action_rewrite.rb +11 -0
  105. data/lib/peal/types/assistant_action_shorten.rb +11 -0
  106. data/lib/peal/types/assistant_action_translate.rb +11 -0
  107. data/lib/peal/types/assistant_failed_encoded.rb +13 -0
  108. data/lib/peal/types/assistant_failed_encoded_reason.rb +16 -0
  109. data/lib/peal/types/assistant_failed_encoded_tag.rb +13 -0
  110. data/lib/peal/types/assistant_input_rejected_encoded.rb +15 -0
  111. data/lib/peal/types/assistant_input_rejected_encoded_reason.rb +14 -0
  112. data/lib/peal/types/assistant_input_rejected_encoded_tag.rb +13 -0
  113. data/lib/peal/types/assistant_quota_exceeded_encoded.rb +15 -0
  114. data/lib/peal/types/assistant_quota_exceeded_encoded_tag.rb +13 -0
  115. data/lib/peal/types/assistant_status.rb +19 -0
  116. data/lib/peal/types/assistant_tone.rb +17 -0
  117. data/lib/peal/types/assistant_unavailable_encoded.rb +11 -0
  118. data/lib/peal/types/assistant_unavailable_encoded_tag.rb +13 -0
  119. data/lib/peal/types/attempt_result.rb +24 -0
  120. data/lib/peal/types/authorization.rb +11 -0
  121. data/lib/peal/types/billing.rb +21 -0
  122. data/lib/peal/types/billing_subscription.rb +17 -0
  123. data/lib/peal/types/calendar_day.rb +25 -0
  124. data/lib/peal/types/channel.rb +23 -0
  125. data/lib/peal/types/channel_cannot_post_encoded.rb +13 -0
  126. data/lib/peal/types/channel_cannot_post_encoded_reason.rb +14 -0
  127. data/lib/peal/types/channel_cannot_post_encoded_tag.rb +13 -0
  128. data/lib/peal/types/channel_metrics.rb +23 -0
  129. data/lib/peal/types/channel_not_found_encoded.rb +9 -0
  130. data/lib/peal/types/channel_options.rb +13 -0
  131. data/lib/peal/types/channel_status.rb +19 -0
  132. data/lib/peal/types/channel_status_active.rb +9 -0
  133. data/lib/peal/types/channel_status_disabled.rb +11 -0
  134. data/lib/peal/types/channel_status_refresh_needed.rb +9 -0
  135. data/lib/peal/types/choosable_account.rb +19 -0
  136. data/lib/peal/types/conflict_error_body.rb +17 -0
  137. data/lib/peal/types/connect_failed_encoded.rb +13 -0
  138. data/lib/peal/types/connect_failed_encoded_tag.rb +13 -0
  139. data/lib/peal/types/connect_failure_reason.rb +22 -0
  140. data/lib/peal/types/connect_outcome.rb +17 -0
  141. data/lib/peal/types/connect_outcome_choose.rb +15 -0
  142. data/lib/peal/types/connect_outcome_connected.rb +11 -0
  143. data/lib/peal/types/connectable_platforms.rb +11 -0
  144. data/lib/peal/types/content_violation.rb +65 -0
  145. data/lib/peal/types/content_violation_alt_text_too_long.rb +19 -0
  146. data/lib/peal/types/content_violation_aspect_ratio_unsupported.rb +23 -0
  147. data/lib/peal/types/content_violation_aspect_ratio_unsupported_maximum.rb +15 -0
  148. data/lib/peal/types/content_violation_aspect_ratio_unsupported_minimum.rb +15 -0
  149. data/lib/peal/types/content_violation_empty.rb +13 -0
  150. data/lib/peal/types/content_violation_forbidden_characters.rb +15 -0
  151. data/lib/peal/types/content_violation_media_required.rb +13 -0
  152. data/lib/peal/types/content_violation_media_too_large.rb +19 -0
  153. data/lib/peal/types/content_violation_media_too_small.rb +19 -0
  154. data/lib/peal/types/content_violation_media_type_unsupported.rb +17 -0
  155. data/lib/peal/types/content_violation_mixed_media.rb +13 -0
  156. data/lib/peal/types/content_violation_no_channels.rb +9 -0
  157. data/lib/peal/types/content_violation_option_invalid.rb +15 -0
  158. data/lib/peal/types/content_violation_option_missing.rb +15 -0
  159. data/lib/peal/types/content_violation_option_too_long.rb +19 -0
  160. data/lib/peal/types/content_violation_options_for_other_platform.rb +15 -0
  161. data/lib/peal/types/content_violation_options_without_channel.rb +11 -0
  162. data/lib/peal/types/content_violation_override_without_channel.rb +11 -0
  163. data/lib/peal/types/content_violation_side_out_of_range.rb +23 -0
  164. data/lib/peal/types/content_violation_text_too_long.rb +19 -0
  165. data/lib/peal/types/content_violation_too_many_hashtags.rb +17 -0
  166. data/lib/peal/types/content_violation_too_many_links.rb +17 -0
  167. data/lib/peal/types/content_violation_too_many_media.rb +17 -0
  168. data/lib/peal/types/content_violation_too_many_mentions.rb +17 -0
  169. data/lib/peal/types/content_violation_too_many_pixels.rb +21 -0
  170. data/lib/peal/types/content_violation_too_many_videos.rb +17 -0
  171. data/lib/peal/types/content_violation_video_too_long.rb +19 -0
  172. data/lib/peal/types/content_violation_video_too_short.rb +19 -0
  173. data/lib/peal/types/created_api_key.rb +13 -0
  174. data/lib/peal/types/database_unavailable_encoded.rb +11 -0
  175. data/lib/peal/types/database_unavailable_encoded_tag.rb +13 -0
  176. data/lib/peal/types/draft_page.rb +13 -0
  177. data/lib/peal/types/effect_http_api_error_bad_request_encoded.rb +11 -0
  178. data/lib/peal/types/effect_http_api_error_bad_request_encoded_tag.rb +13 -0
  179. data/lib/peal/types/engagement_day.rb +19 -0
  180. data/lib/peal/types/failure_reason.rb +24 -0
  181. data/lib/peal/types/forbidden_encoded.rb +11 -0
  182. data/lib/peal/types/forbidden_encoded_tag.rb +13 -0
  183. data/lib/peal/types/invalid_date_range_encoded.rb +11 -0
  184. data/lib/peal/types/invalid_date_range_encoded_tag.rb +13 -0
  185. data/lib/peal/types/invalid_time_range_encoded.rb +11 -0
  186. data/lib/peal/types/invalid_time_range_encoded_tag.rb +13 -0
  187. data/lib/peal/types/invalid_time_zone_encoded.rb +13 -0
  188. data/lib/peal/types/invalid_time_zone_encoded_tag.rb +13 -0
  189. data/lib/peal/types/invitation.rb +21 -0
  190. data/lib/peal/types/invitation_not_found_encoded.rb +9 -0
  191. data/lib/peal/types/me.rb +15 -0
  192. data/lib/peal/types/me_user.rb +21 -0
  193. data/lib/peal/types/me_user_locale.rb +14 -0
  194. data/lib/peal/types/media.rb +33 -0
  195. data/lib/peal/types/media_attachment.rb +13 -0
  196. data/lib/peal/types/media_content_type.rb +18 -0
  197. data/lib/peal/types/media_dimensions.rb +13 -0
  198. data/lib/peal/types/media_in_use_encoded.rb +13 -0
  199. data/lib/peal/types/media_in_use_encoded_tag.rb +13 -0
  200. data/lib/peal/types/media_kind.rb +14 -0
  201. data/lib/peal/types/media_not_found_encoded.rb +9 -0
  202. data/lib/peal/types/media_page.rb +13 -0
  203. data/lib/peal/types/media_status.rb +21 -0
  204. data/lib/peal/types/media_status_pending.rb +9 -0
  205. data/lib/peal/types/media_status_ready.rb +9 -0
  206. data/lib/peal/types/media_status_rejected.rb +11 -0
  207. data/lib/peal/types/media_status_uploaded.rb +11 -0
  208. data/lib/peal/types/media_store_unavailable_encoded.rb +11 -0
  209. data/lib/peal/types/media_store_unavailable_encoded_tag.rb +13 -0
  210. data/lib/peal/types/media_too_large_encoded.rb +15 -0
  211. data/lib/peal/types/media_too_large_encoded_kind.rb +14 -0
  212. data/lib/peal/types/media_usage.rb +13 -0
  213. data/lib/peal/types/membership.rb +19 -0
  214. data/lib/peal/types/metric_totals.rb +21 -0
  215. data/lib/peal/types/metrics_snapshot.rb +13 -0
  216. data/lib/peal/types/non_finite_number.rb +14 -0
  217. data/lib/peal/types/not_found_error_body.rb +17 -0
  218. data/lib/peal/types/notice.rb +19 -0
  219. data/lib/peal/types/notice_channel.rb +13 -0
  220. data/lib/peal/types/notice_event.rb +23 -0
  221. data/lib/peal/types/notice_event_channel_reconnect_required.rb +11 -0
  222. data/lib/peal/types/notice_event_channel_reconnect_soon.rb +13 -0
  223. data/lib/peal/types/notice_event_post_failed.rb +15 -0
  224. data/lib/peal/types/notice_event_post_published.rb +15 -0
  225. data/lib/peal/types/notice_event_post_unconfirmed.rb +13 -0
  226. data/lib/peal/types/notice_page.rb +13 -0
  227. data/lib/peal/types/notification_preferences.rb +13 -0
  228. data/lib/peal/types/notification_preferences_email.rb +17 -0
  229. data/lib/peal/types/paid_plan.rb +14 -0
  230. data/lib/peal/types/period_usage.rb +13 -0
  231. data/lib/peal/types/permission.rb +40 -0
  232. data/lib/peal/types/plan.rb +15 -0
  233. data/lib/peal/types/plan_allowances.rb +17 -0
  234. data/lib/peal/types/plan_limit.rb +16 -0
  235. data/lib/peal/types/plan_limit_reached_encoded.rb +15 -0
  236. data/lib/peal/types/plan_limit_reached_encoded_tag.rb +13 -0
  237. data/lib/peal/types/plan_offer.rb +13 -0
  238. data/lib/peal/types/platform.rb +22 -0
  239. data/lib/peal/types/platform_unreachable_encoded.rb +11 -0
  240. data/lib/peal/types/platform_unreachable_encoded_tag.rb +13 -0
  241. data/lib/peal/types/post.rb +23 -0
  242. data/lib/peal/types/post_analytics.rb +13 -0
  243. data/lib/peal/types/post_content.rb +15 -0
  244. data/lib/peal/types/post_content_invalid_encoded.rb +11 -0
  245. data/lib/peal/types/post_draft.rb +15 -0
  246. data/lib/peal/types/post_metrics.rb +19 -0
  247. data/lib/peal/types/post_not_found_encoded.rb +9 -0
  248. data/lib/peal/types/post_outcome.rb +17 -0
  249. data/lib/peal/types/post_schedule.rb +13 -0
  250. data/lib/peal/types/post_status.rb +17 -0
  251. data/lib/peal/types/post_status_conflict_encoded.rb +13 -0
  252. data/lib/peal/types/post_status_conflict_encoded_tag.rb +13 -0
  253. data/lib/peal/types/post_target.rb +29 -0
  254. data/lib/peal/types/post_target_status.rb +18 -0
  255. data/lib/peal/types/prepared_upload.rb +13 -0
  256. data/lib/peal/types/probe_state.rb +18 -0
  257. data/lib/peal/types/publication_attempt.rb +23 -0
  258. data/lib/peal/types/rejection_reason.rb +14 -0
  259. data/lib/peal/types/role.rb +17 -0
  260. data/lib/peal/types/schedule_in_past_encoded.rb +9 -0
  261. data/lib/peal/types/signed_request.rb +15 -0
  262. data/lib/peal/types/signed_request_method.rb +13 -0
  263. data/lib/peal/types/subscription_status.rb +20 -0
  264. data/lib/peal/types/suggestion.rb +17 -0
  265. data/lib/peal/types/suggestion_hashtags.rb +11 -0
  266. data/lib/peal/types/suggestion_text.rb +11 -0
  267. data/lib/peal/types/target_confirmation.rb +17 -0
  268. data/lib/peal/types/target_confirmation_not_published.rb +9 -0
  269. data/lib/peal/types/target_confirmation_published.rb +11 -0
  270. data/lib/peal/types/target_metrics.rb +25 -0
  271. data/lib/peal/types/target_options.rb +19 -0
  272. data/lib/peal/types/target_status_conflict_encoded.rb +11 -0
  273. data/lib/peal/types/text_override.rb +13 -0
  274. data/lib/peal/types/text_unit.rb +18 -0
  275. data/lib/peal/types/tik_tok_account.rb +13 -0
  276. data/lib/peal/types/tik_tok_account_posting.rb +17 -0
  277. data/lib/peal/types/tik_tok_account_posting_blocked.rb +11 -0
  278. data/lib/peal/types/tik_tok_account_posting_ready.rb +11 -0
  279. data/lib/peal/types/tik_tok_block.rb +15 -0
  280. data/lib/peal/types/tik_tok_creator.rb +25 -0
  281. data/lib/peal/types/tik_tok_options.rb +26 -0
  282. data/lib/peal/types/tik_tok_privacy_level.rb +16 -0
  283. data/lib/peal/types/too_many_invitations_encoded.rb +9 -0
  284. data/lib/peal/types/top_post.rb +23 -0
  285. data/lib/peal/types/translation_language.rb +22 -0
  286. data/lib/peal/types/unauthenticated_encoded.rb +11 -0
  287. data/lib/peal/types/unauthenticated_encoded_tag.rb +13 -0
  288. data/lib/peal/types/unconfirmed_reason.rb +16 -0
  289. data/lib/peal/types/unknown_channels_encoded.rb +11 -0
  290. data/lib/peal/types/unknown_media_encoded.rb +11 -0
  291. data/lib/peal/types/unprocessable_entity_error_body.rb +19 -0
  292. data/lib/peal/types/unread_notices.rb +11 -0
  293. data/lib/peal/types/unsupported_media_type_encoded.rb +11 -0
  294. data/lib/peal/types/upload_incomplete_encoded.rb +11 -0
  295. data/lib/peal/types/upload_incomplete_encoded_tag.rb +13 -0
  296. data/lib/peal/types/upload_part.rb +15 -0
  297. data/lib/peal/types/upload_rejected_encoded.rb +13 -0
  298. data/lib/peal/types/upload_rejected_encoded_tag.rb +13 -0
  299. data/lib/peal/types/upload_target.rb +17 -0
  300. data/lib/peal/types/upload_target_multipart.rb +15 -0
  301. data/lib/peal/types/upload_target_single.rb +13 -0
  302. data/lib/peal/types/usage.rb +17 -0
  303. data/lib/peal/types/workspace_member.rb +19 -0
  304. data/lib/peal/types/workspace_not_found_encoded.rb +11 -0
  305. data/lib/peal/types/workspace_not_found_encoded_tag.rb +13 -0
  306. data/lib/peal/types/you_tube_options.rb +24 -0
  307. data/lib/peal/types/you_tube_privacy.rb +15 -0
  308. data/lib/peal/version.rb +2 -12
  309. data/lib/peal.rb +315 -247
  310. metadata +313 -510
  311. data/Gemfile +0 -9
  312. data/Gemfile.lock +0 -136
  313. data/Rakefile +0 -10
  314. data/docs/AlreadyMemberEncoded.md +0 -18
  315. data/docs/AltTextTooLongEncoded.md +0 -20
  316. data/docs/AnalyticsApi.md +0 -155
  317. data/docs/AnalyticsSummary.md +0 -30
  318. data/docs/ApiKey.md +0 -28
  319. data/docs/ApiKeyNotFoundEncoded.md +0 -18
  320. data/docs/ApiKeysApi.md +0 -220
  321. data/docs/ApiKeysRevoke404Response.md +0 -18
  322. data/docs/AssistantAction.md +0 -24
  323. data/docs/AssistantActionAnyOf.md +0 -20
  324. data/docs/AssistantActionAnyOf1.md +0 -20
  325. data/docs/AssistantActionAnyOf2.md +0 -20
  326. data/docs/AssistantActionAnyOf3.md +0 -18
  327. data/docs/AssistantApi.md +0 -149
  328. data/docs/AssistantFailedEncoded.md +0 -20
  329. data/docs/AssistantInputRejectedEncoded.md +0 -22
  330. data/docs/AssistantQuotaExceededEncoded.md +0 -22
  331. data/docs/AssistantStatus.md +0 -26
  332. data/docs/AssistantTone.md +0 -15
  333. data/docs/AssistantUnavailableEncoded.md +0 -18
  334. data/docs/AttemptResult.md +0 -15
  335. data/docs/Authorization.md +0 -18
  336. data/docs/Billing.md +0 -28
  337. data/docs/BillingApi.md +0 -77
  338. data/docs/BillingSubscription.md +0 -24
  339. data/docs/Channel.md +0 -30
  340. data/docs/ChannelCannotPostEncoded.md +0 -20
  341. data/docs/ChannelMetrics.md +0 -30
  342. data/docs/ChannelNotFoundEncoded.md +0 -18
  343. data/docs/ChannelOptions.md +0 -20
  344. data/docs/ChannelStatus.md +0 -20
  345. data/docs/ChannelStatusAnyOf.md +0 -18
  346. data/docs/ChannelStatusAnyOf1.md +0 -18
  347. data/docs/ChannelStatusAnyOf2.md +0 -20
  348. data/docs/ChannelsApi.md +0 -512
  349. data/docs/ChannelsCompleteConnect404Response.md +0 -18
  350. data/docs/ChoosableAccount.md +0 -26
  351. data/docs/ChooseAccounts.md +0 -20
  352. data/docs/ConnectCallback.md +0 -24
  353. data/docs/ConnectChannel.md +0 -20
  354. data/docs/ConnectFailedEncoded.md +0 -20
  355. data/docs/ConnectFailureReason.md +0 -15
  356. data/docs/ConnectOutcome.md +0 -26
  357. data/docs/ConnectOutcomeAnyOf.md +0 -20
  358. data/docs/ConnectOutcomeAnyOf1.md +0 -24
  359. data/docs/ConnectablePlatforms.md +0 -18
  360. data/docs/ContentViolation.md +0 -54
  361. data/docs/ContentViolationAnyOf.md +0 -18
  362. data/docs/ContentViolationAnyOf1.md +0 -20
  363. data/docs/ContentViolationAnyOf10.md +0 -26
  364. data/docs/ContentViolationAnyOf11.md +0 -22
  365. data/docs/ContentViolationAnyOf12.md +0 -26
  366. data/docs/ContentViolationAnyOf13.md +0 -26
  367. data/docs/ContentViolationAnyOf14.md +0 -26
  368. data/docs/ContentViolationAnyOf15.md +0 -26
  369. data/docs/ContentViolationAnyOf16.md +0 -22
  370. data/docs/ContentViolationAnyOf17.md +0 -26
  371. data/docs/ContentViolationAnyOf18.md +0 -28
  372. data/docs/ContentViolationAnyOf19.md +0 -28
  373. data/docs/ContentViolationAnyOf2.md +0 -20
  374. data/docs/ContentViolationAnyOf20.md +0 -28
  375. data/docs/ContentViolationAnyOf21.md +0 -28
  376. data/docs/ContentViolationAnyOf22.md +0 -30
  377. data/docs/ContentViolationAnyOf23.md +0 -32
  378. data/docs/ContentViolationAnyOf24.md +0 -32
  379. data/docs/ContentViolationAnyOf24Maximum.md +0 -15
  380. data/docs/ContentViolationAnyOf25.md +0 -28
  381. data/docs/ContentViolationAnyOf3.md +0 -24
  382. data/docs/ContentViolationAnyOf4.md +0 -24
  383. data/docs/ContentViolationAnyOf5.md +0 -28
  384. data/docs/ContentViolationAnyOf6.md +0 -24
  385. data/docs/ContentViolationAnyOf7.md +0 -22
  386. data/docs/ContentViolationAnyOf8.md +0 -28
  387. data/docs/ContentViolationAnyOf9.md +0 -24
  388. data/docs/CreatedApiKey.md +0 -20
  389. data/docs/DatabaseUnavailableEncoded.md +0 -18
  390. data/docs/DraftPage.md +0 -20
  391. data/docs/EffectHttpApiErrorBadRequestEncoded.md +0 -18
  392. data/docs/EngagementDay.md +0 -26
  393. data/docs/FailureReason.md +0 -15
  394. data/docs/ForbiddenEncoded.md +0 -18
  395. data/docs/InvalidDateRangeEncoded.md +0 -18
  396. data/docs/InvalidTimeRangeEncoded.md +0 -18
  397. data/docs/InvalidTimeZoneEncoded.md +0 -20
  398. data/docs/Invitation.md +0 -28
  399. data/docs/InvitationNotFoundEncoded.md +0 -18
  400. data/docs/InvitationsApi.md +0 -220
  401. data/docs/InvitationsCreate409Response.md +0 -18
  402. data/docs/InvitationsRevoke404Response.md +0 -18
  403. data/docs/MarkNoticesRead.md +0 -18
  404. data/docs/Me.md +0 -22
  405. data/docs/MeUser.md +0 -28
  406. data/docs/Media.md +0 -40
  407. data/docs/MediaApi.md +0 -516
  408. data/docs/MediaAttachment.md +0 -20
  409. data/docs/MediaContentType.md +0 -15
  410. data/docs/MediaCreate422Response.md +0 -28
  411. data/docs/MediaDescription.md +0 -18
  412. data/docs/MediaDimensions.md +0 -20
  413. data/docs/MediaGet404Response.md +0 -18
  414. data/docs/MediaInUseEncoded.md +0 -20
  415. data/docs/MediaKind.md +0 -15
  416. data/docs/MediaNotFoundEncoded.md +0 -18
  417. data/docs/MediaPage.md +0 -20
  418. data/docs/MediaStatus.md +0 -22
  419. data/docs/MediaStatusAnyOf.md +0 -18
  420. data/docs/MediaStatusAnyOf1.md +0 -20
  421. data/docs/MediaStatusAnyOf2.md +0 -18
  422. data/docs/MediaStatusAnyOf3.md +0 -20
  423. data/docs/MediaStoreUnavailableEncoded.md +0 -18
  424. data/docs/MediaTooLargeEncoded.md +0 -24
  425. data/docs/MediaUsage.md +0 -20
  426. data/docs/MembersApi.md +0 -77
  427. data/docs/Membership.md +0 -26
  428. data/docs/MetricTotals.md +0 -28
  429. data/docs/MetricsSnapshot.md +0 -20
  430. data/docs/NewApiKey.md +0 -22
  431. data/docs/NewInvitation.md +0 -20
  432. data/docs/NewUpload.md +0 -22
  433. data/docs/NonFiniteNumber.md +0 -15
  434. data/docs/Notice.md +0 -26
  435. data/docs/NoticeChannel.md +0 -20
  436. data/docs/NoticeEvent.md +0 -28
  437. data/docs/NoticeEventAnyOf.md +0 -24
  438. data/docs/NoticeEventAnyOf1.md +0 -24
  439. data/docs/NoticeEventAnyOf2.md +0 -22
  440. data/docs/NoticeEventAnyOf3.md +0 -20
  441. data/docs/NoticeEventAnyOf4.md +0 -22
  442. data/docs/NoticePage.md +0 -20
  443. data/docs/NoticesApi.md +0 -285
  444. data/docs/NotificationPreferences.md +0 -20
  445. data/docs/NotificationPreferencesApi.md +0 -144
  446. data/docs/NotificationPreferencesChange.md +0 -20
  447. data/docs/NotificationPreferencesChangeEmail.md +0 -24
  448. data/docs/NotificationPreferencesEmail.md +0 -24
  449. data/docs/PaidPlan.md +0 -15
  450. data/docs/PeriodUsage.md +0 -20
  451. data/docs/Plan.md +0 -15
  452. data/docs/PlanAllowances.md +0 -24
  453. data/docs/PlanLimit.md +0 -15
  454. data/docs/PlanLimitReachedEncoded.md +0 -22
  455. data/docs/PlanOffer.md +0 -20
  456. data/docs/Platform.md +0 -15
  457. data/docs/PlatformUnreachableEncoded.md +0 -18
  458. data/docs/Post.md +0 -30
  459. data/docs/PostAnalytics.md +0 -20
  460. data/docs/PostContent.md +0 -22
  461. data/docs/PostContentInvalidEncoded.md +0 -20
  462. data/docs/PostDraft.md +0 -22
  463. data/docs/PostMetrics.md +0 -26
  464. data/docs/PostNotFoundEncoded.md +0 -18
  465. data/docs/PostOutcome.md +0 -15
  466. data/docs/PostSchedule.md +0 -20
  467. data/docs/PostStatus.md +0 -15
  468. data/docs/PostStatusConflictEncoded.md +0 -20
  469. data/docs/PostTarget.md +0 -36
  470. data/docs/PostTargetStatus.md +0 -15
  471. data/docs/PostsApi.md +0 -960
  472. data/docs/PostsCreate422Response.md +0 -24
  473. data/docs/PostsGet404Response.md +0 -18
  474. data/docs/PostsRepost409Response.md +0 -20
  475. data/docs/PostsSchedule422Response.md +0 -26
  476. data/docs/PreparedUpload.md +0 -20
  477. data/docs/ProbeState.md +0 -15
  478. data/docs/PublicationAttempt.md +0 -30
  479. data/docs/RejectionReason.md +0 -15
  480. data/docs/Role.md +0 -15
  481. data/docs/ScheduleInPastEncoded.md +0 -18
  482. data/docs/SchedulePost.md +0 -22
  483. data/docs/SessionApi.md +0 -74
  484. data/docs/SignedRequest.md +0 -22
  485. data/docs/SubscriptionStatus.md +0 -15
  486. data/docs/Suggestion.md +0 -22
  487. data/docs/SuggestionAnyOf.md +0 -20
  488. data/docs/SuggestionAnyOf1.md +0 -20
  489. data/docs/SuggestionRequest.md +0 -20
  490. data/docs/SystemApi.md +0 -129
  491. data/docs/TargetConfirmation.md +0 -20
  492. data/docs/TargetConfirmationAnyOf.md +0 -20
  493. data/docs/TargetConfirmationAnyOf1.md +0 -18
  494. data/docs/TargetMetrics.md +0 -32
  495. data/docs/TargetOptions.md +0 -48
  496. data/docs/TargetStatusConflictEncoded.md +0 -20
  497. data/docs/TextOverride.md +0 -20
  498. data/docs/TextUnit.md +0 -15
  499. data/docs/TikTokAccount.md +0 -20
  500. data/docs/TikTokAccountPosting.md +0 -22
  501. data/docs/TikTokAccountPostingAnyOf.md +0 -20
  502. data/docs/TikTokAccountPostingAnyOf1.md +0 -20
  503. data/docs/TikTokBlock.md +0 -15
  504. data/docs/TikTokCreator.md +0 -32
  505. data/docs/TikTokOptions.md +0 -34
  506. data/docs/TikTokPrivacyLevel.md +0 -15
  507. data/docs/TiktokApi.md +0 -79
  508. data/docs/TooManyInvitationsEncoded.md +0 -18
  509. data/docs/TopPost.md +0 -30
  510. data/docs/TranslationLanguage.md +0 -15
  511. data/docs/UnauthenticatedEncoded.md +0 -18
  512. data/docs/UnconfirmedReason.md +0 -15
  513. data/docs/UnknownChannelsEncoded.md +0 -20
  514. data/docs/UnknownMediaEncoded.md +0 -20
  515. data/docs/UnreadNotices.md +0 -18
  516. data/docs/UnsupportedMediaTypeEncoded.md +0 -20
  517. data/docs/UploadIncompleteEncoded.md +0 -18
  518. data/docs/UploadPart.md +0 -22
  519. data/docs/UploadRejectedEncoded.md +0 -20
  520. data/docs/UploadTarget.md +0 -26
  521. data/docs/UploadTargetAnyOf.md +0 -22
  522. data/docs/UploadTargetAnyOf1.md +0 -24
  523. data/docs/Usage.md +0 -24
  524. data/docs/WorkspaceMember.md +0 -26
  525. data/docs/WorkspaceNotFoundEncoded.md +0 -18
  526. data/docs/YouTubeOptions.md +0 -32
  527. data/docs/YouTubePrivacy.md +0 -15
  528. data/lib/peal/api/analytics_api.rb +0 -185
  529. data/lib/peal/api/api_keys_api.rb +0 -228
  530. data/lib/peal/api/assistant_api.rb +0 -159
  531. data/lib/peal/api/billing_api.rb +0 -85
  532. data/lib/peal/api/channels_api.rb +0 -526
  533. data/lib/peal/api/invitations_api.rb +0 -228
  534. data/lib/peal/api/media_api.rb +0 -526
  535. data/lib/peal/api/members_api.rb +0 -85
  536. data/lib/peal/api/notices_api.rb +0 -272
  537. data/lib/peal/api/notification_preferences_api.rb +0 -147
  538. data/lib/peal/api/posts_api.rb +0 -993
  539. data/lib/peal/api/session_api.rb +0 -79
  540. data/lib/peal/api/system_api.rb +0 -134
  541. data/lib/peal/api/tiktok_api.rb +0 -91
  542. data/lib/peal/api_client.rb +0 -441
  543. data/lib/peal/api_error.rb +0 -58
  544. data/lib/peal/api_model_base.rb +0 -88
  545. data/lib/peal/configuration.rb +0 -392
  546. data/lib/peal/models/already_member_encoded.rb +0 -201
  547. data/lib/peal/models/alt_text_too_long_encoded.rb +0 -245
  548. data/lib/peal/models/analytics_summary.rb +0 -361
  549. data/lib/peal/models/api_key.rb +0 -293
  550. data/lib/peal/models/api_key_not_found_encoded.rb +0 -201
  551. data/lib/peal/models/api_keys_revoke404_response.rb +0 -103
  552. data/lib/peal/models/assistant_action.rb +0 -105
  553. data/lib/peal/models/assistant_action_any_of.rb +0 -227
  554. data/lib/peal/models/assistant_action_any_of1.rb +0 -227
  555. data/lib/peal/models/assistant_action_any_of2.rb +0 -227
  556. data/lib/peal/models/assistant_action_any_of3.rb +0 -201
  557. data/lib/peal/models/assistant_failed_encoded.rb +0 -229
  558. data/lib/peal/models/assistant_input_rejected_encoded.rb +0 -273
  559. data/lib/peal/models/assistant_quota_exceeded_encoded.rb +0 -271
  560. data/lib/peal/models/assistant_status.rb +0 -335
  561. data/lib/peal/models/assistant_tone.rb +0 -43
  562. data/lib/peal/models/assistant_unavailable_encoded.rb +0 -201
  563. data/lib/peal/models/attempt_result.rb +0 -50
  564. data/lib/peal/models/authorization.rb +0 -177
  565. data/lib/peal/models/billing.rb +0 -303
  566. data/lib/peal/models/billing_subscription.rb +0 -263
  567. data/lib/peal/models/channel.rb +0 -313
  568. data/lib/peal/models/channel_cannot_post_encoded.rb +0 -229
  569. data/lib/peal/models/channel_metrics.rb +0 -425
  570. data/lib/peal/models/channel_not_found_encoded.rb +0 -201
  571. data/lib/peal/models/channel_options.rb +0 -203
  572. data/lib/peal/models/channel_status.rb +0 -104
  573. data/lib/peal/models/channel_status_any_of.rb +0 -201
  574. data/lib/peal/models/channel_status_any_of1.rb +0 -201
  575. data/lib/peal/models/channel_status_any_of2.rb +0 -227
  576. data/lib/peal/models/channels_complete_connect404_response.rb +0 -103
  577. data/lib/peal/models/choosable_account.rb +0 -253
  578. data/lib/peal/models/choose_accounts.rb +0 -241
  579. data/lib/peal/models/connect_callback.rb +0 -279
  580. data/lib/peal/models/connect_channel.rb +0 -207
  581. data/lib/peal/models/connect_failed_encoded.rb +0 -227
  582. data/lib/peal/models/connect_failure_reason.rb +0 -48
  583. data/lib/peal/models/connect_outcome.rb +0 -103
  584. data/lib/peal/models/connect_outcome_any_of.rb +0 -227
  585. data/lib/peal/models/connect_outcome_any_of1.rb +0 -281
  586. data/lib/peal/models/connectable_platforms.rb +0 -179
  587. data/lib/peal/models/content_violation.rb +0 -127
  588. data/lib/peal/models/content_violation_any_of.rb +0 -201
  589. data/lib/peal/models/content_violation_any_of1.rb +0 -227
  590. data/lib/peal/models/content_violation_any_of10.rb +0 -341
  591. data/lib/peal/models/content_violation_any_of11.rb +0 -253
  592. data/lib/peal/models/content_violation_any_of12.rb +0 -341
  593. data/lib/peal/models/content_violation_any_of13.rb +0 -341
  594. data/lib/peal/models/content_violation_any_of14.rb +0 -341
  595. data/lib/peal/models/content_violation_any_of15.rb +0 -341
  596. data/lib/peal/models/content_violation_any_of16.rb +0 -253
  597. data/lib/peal/models/content_violation_any_of17.rb +0 -305
  598. data/lib/peal/models/content_violation_any_of18.rb +0 -367
  599. data/lib/peal/models/content_violation_any_of19.rb +0 -367
  600. data/lib/peal/models/content_violation_any_of2.rb +0 -227
  601. data/lib/peal/models/content_violation_any_of20.rb +0 -367
  602. data/lib/peal/models/content_violation_any_of21.rb +0 -367
  603. data/lib/peal/models/content_violation_any_of22.rb +0 -411
  604. data/lib/peal/models/content_violation_any_of23.rb +0 -455
  605. data/lib/peal/models/content_violation_any_of24.rb +0 -419
  606. data/lib/peal/models/content_violation_any_of24_maximum.rb +0 -103
  607. data/lib/peal/models/content_violation_any_of25.rb +0 -367
  608. data/lib/peal/models/content_violation_any_of3.rb +0 -279
  609. data/lib/peal/models/content_violation_any_of4.rb +0 -279
  610. data/lib/peal/models/content_violation_any_of5.rb +0 -367
  611. data/lib/peal/models/content_violation_any_of6.rb +0 -279
  612. data/lib/peal/models/content_violation_any_of7.rb +0 -253
  613. data/lib/peal/models/content_violation_any_of8.rb +0 -367
  614. data/lib/peal/models/content_violation_any_of9.rb +0 -281
  615. data/lib/peal/models/created_api_key.rb +0 -203
  616. data/lib/peal/models/database_unavailable_encoded.rb +0 -201
  617. data/lib/peal/models/draft_page.rb +0 -191
  618. data/lib/peal/models/effect_http_api_error_bad_request_encoded.rb +0 -201
  619. data/lib/peal/models/engagement_day.rb +0 -364
  620. data/lib/peal/models/failure_reason.rb +0 -50
  621. data/lib/peal/models/forbidden_encoded.rb +0 -201
  622. data/lib/peal/models/invalid_date_range_encoded.rb +0 -201
  623. data/lib/peal/models/invalid_time_range_encoded.rb +0 -201
  624. data/lib/peal/models/invalid_time_zone_encoded.rb +0 -227
  625. data/lib/peal/models/invitation.rb +0 -307
  626. data/lib/peal/models/invitation_not_found_encoded.rb +0 -201
  627. data/lib/peal/models/invitations_create409_response.rb +0 -103
  628. data/lib/peal/models/invitations_revoke404_response.rb +0 -103
  629. data/lib/peal/models/mark_notices_read.rb +0 -197
  630. data/lib/peal/models/me.rb +0 -217
  631. data/lib/peal/models/me_user.rb +0 -317
  632. data/lib/peal/models/media.rb +0 -457
  633. data/lib/peal/models/media_attachment.rb +0 -212
  634. data/lib/peal/models/media_content_type.rb +0 -44
  635. data/lib/peal/models/media_create422_response.rb +0 -104
  636. data/lib/peal/models/media_description.rb +0 -163
  637. data/lib/peal/models/media_dimensions.rb +0 -239
  638. data/lib/peal/models/media_get404_response.rb +0 -103
  639. data/lib/peal/models/media_in_use_encoded.rb +0 -229
  640. data/lib/peal/models/media_kind.rb +0 -40
  641. data/lib/peal/models/media_not_found_encoded.rb +0 -201
  642. data/lib/peal/models/media_page.rb +0 -191
  643. data/lib/peal/models/media_status.rb +0 -105
  644. data/lib/peal/models/media_status_any_of.rb +0 -201
  645. data/lib/peal/models/media_status_any_of1.rb +0 -227
  646. data/lib/peal/models/media_status_any_of2.rb +0 -201
  647. data/lib/peal/models/media_status_any_of3.rb +0 -227
  648. data/lib/peal/models/media_store_unavailable_encoded.rb +0 -201
  649. data/lib/peal/models/media_too_large_encoded.rb +0 -317
  650. data/lib/peal/models/media_usage.rb +0 -207
  651. data/lib/peal/models/membership.rb +0 -295
  652. data/lib/peal/models/metric_totals.rb +0 -399
  653. data/lib/peal/models/metrics_snapshot.rb +0 -203
  654. data/lib/peal/models/new_api_key.rb +0 -277
  655. data/lib/peal/models/new_invitation.rb +0 -245
  656. data/lib/peal/models/new_upload.rb +0 -231
  657. data/lib/peal/models/non_finite_number.rb +0 -41
  658. data/lib/peal/models/notice.rb +0 -267
  659. data/lib/peal/models/notice_channel.rb +0 -225
  660. data/lib/peal/models/notice_event.rb +0 -106
  661. data/lib/peal/models/notice_event_any_of.rb +0 -251
  662. data/lib/peal/models/notice_event_any_of1.rb +0 -265
  663. data/lib/peal/models/notice_event_any_of2.rb +0 -239
  664. data/lib/peal/models/notice_event_any_of3.rb +0 -227
  665. data/lib/peal/models/notice_event_any_of4.rb +0 -253
  666. data/lib/peal/models/notice_page.rb +0 -191
  667. data/lib/peal/models/notification_preferences.rb +0 -203
  668. data/lib/peal/models/notification_preferences_change.rb +0 -169
  669. data/lib/peal/models/notification_preferences_change_email.rb +0 -187
  670. data/lib/peal/models/notification_preferences_email.rb +0 -255
  671. data/lib/peal/models/paid_plan.rb +0 -40
  672. data/lib/peal/models/period_usage.rb +0 -221
  673. data/lib/peal/models/plan.rb +0 -41
  674. data/lib/peal/models/plan_allowances.rb +0 -295
  675. data/lib/peal/models/plan_limit.rb +0 -42
  676. data/lib/peal/models/plan_limit_reached_encoded.rb +0 -271
  677. data/lib/peal/models/plan_offer.rb +0 -225
  678. data/lib/peal/models/platform.rb +0 -48
  679. data/lib/peal/models/platform_unreachable_encoded.rb +0 -201
  680. data/lib/peal/models/post.rb +0 -315
  681. data/lib/peal/models/post_analytics.rb +0 -205
  682. data/lib/peal/models/post_content.rb +0 -251
  683. data/lib/peal/models/post_content_invalid_encoded.rb +0 -229
  684. data/lib/peal/models/post_draft.rb +0 -216
  685. data/lib/peal/models/post_metrics.rb +0 -355
  686. data/lib/peal/models/post_not_found_encoded.rb +0 -201
  687. data/lib/peal/models/post_outcome.rb +0 -43
  688. data/lib/peal/models/post_schedule.rb +0 -203
  689. data/lib/peal/models/post_status.rb +0 -43
  690. data/lib/peal/models/post_status_conflict_encoded.rb +0 -227
  691. data/lib/peal/models/post_target.rb +0 -364
  692. data/lib/peal/models/post_target_status.rb +0 -44
  693. data/lib/peal/models/posts_create422_response.rb +0 -104
  694. data/lib/peal/models/posts_get404_response.rb +0 -103
  695. data/lib/peal/models/posts_repost409_response.rb +0 -103
  696. data/lib/peal/models/posts_schedule422_response.rb +0 -106
  697. data/lib/peal/models/prepared_upload.rb +0 -203
  698. data/lib/peal/models/probe_state.rb +0 -44
  699. data/lib/peal/models/publication_attempt.rb +0 -377
  700. data/lib/peal/models/rejection_reason.rb +0 -40
  701. data/lib/peal/models/role.rb +0 -43
  702. data/lib/peal/models/schedule_in_past_encoded.rb +0 -201
  703. data/lib/peal/models/schedule_post.rb +0 -240
  704. data/lib/peal/models/signed_request.rb +0 -255
  705. data/lib/peal/models/subscription_status.rb +0 -46
  706. data/lib/peal/models/suggestion.rb +0 -103
  707. data/lib/peal/models/suggestion_any_of.rb +0 -227
  708. data/lib/peal/models/suggestion_any_of1.rb +0 -229
  709. data/lib/peal/models/suggestion_request.rb +0 -212
  710. data/lib/peal/models/target_confirmation.rb +0 -103
  711. data/lib/peal/models/target_confirmation_any_of.rb +0 -228
  712. data/lib/peal/models/target_confirmation_any_of1.rb +0 -201
  713. data/lib/peal/models/target_metrics.rb +0 -319
  714. data/lib/peal/models/target_options.rb +0 -104
  715. data/lib/peal/models/target_status_conflict_encoded.rb +0 -227
  716. data/lib/peal/models/text_override.rb +0 -221
  717. data/lib/peal/models/text_unit.rb +0 -44
  718. data/lib/peal/models/tik_tok_account.rb +0 -203
  719. data/lib/peal/models/tik_tok_account_posting.rb +0 -103
  720. data/lib/peal/models/tik_tok_account_posting_any_of.rb +0 -227
  721. data/lib/peal/models/tik_tok_account_posting_any_of1.rb +0 -227
  722. data/lib/peal/models/tik_tok_block.rb +0 -41
  723. data/lib/peal/models/tik_tok_creator.rb +0 -357
  724. data/lib/peal/models/tik_tok_options.rb +0 -274
  725. data/lib/peal/models/tik_tok_privacy_level.rb +0 -42
  726. data/lib/peal/models/too_many_invitations_encoded.rb +0 -201
  727. data/lib/peal/models/top_post.rb +0 -337
  728. data/lib/peal/models/translation_language.rb +0 -48
  729. data/lib/peal/models/unauthenticated_encoded.rb +0 -201
  730. data/lib/peal/models/unconfirmed_reason.rb +0 -42
  731. data/lib/peal/models/unknown_channels_encoded.rb +0 -229
  732. data/lib/peal/models/unknown_media_encoded.rb +0 -229
  733. data/lib/peal/models/unread_notices.rb +0 -195
  734. data/lib/peal/models/unsupported_media_type_encoded.rb +0 -227
  735. data/lib/peal/models/upload_incomplete_encoded.rb +0 -201
  736. data/lib/peal/models/upload_part.rb +0 -265
  737. data/lib/peal/models/upload_rejected_encoded.rb +0 -227
  738. data/lib/peal/models/upload_target.rb +0 -103
  739. data/lib/peal/models/upload_target_any_of.rb +0 -253
  740. data/lib/peal/models/upload_target_any_of1.rb +0 -299
  741. data/lib/peal/models/usage.rb +0 -291
  742. data/lib/peal/models/workspace_member.rb +0 -281
  743. data/lib/peal/models/workspace_not_found_encoded.rb +0 -201
  744. data/lib/peal/models/you_tube_options.rb +0 -324
  745. data/lib/peal/models/you_tube_privacy.rb +0 -41
  746. data/peal.gemspec +0 -41
  747. data/project.json +0 -17
data/docs/PostsApi.md DELETED
@@ -1,960 +0,0 @@
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&lt;PublicationAttempt&gt;**](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&lt;Post&gt;**](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
-