peal 0.2.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 (528) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +171 -320
  3. data/lib/peal/analytics/client.rb +120 -0
  4. data/lib/peal/analytics/types/post_analytics_request.rb +13 -0
  5. data/lib/peal/analytics/types/summary_analytics_request.rb +17 -0
  6. data/lib/peal/api_keys/client.rb +153 -0
  7. data/lib/peal/api_keys/types/list_api_keys_request.rb +11 -0
  8. data/lib/peal/api_keys/types/new_api_key.rb +17 -0
  9. data/lib/peal/api_keys/types/revoke_api_keys_request.rb +13 -0
  10. data/lib/peal/assistant/client.rb +112 -0
  11. data/lib/peal/assistant/types/status_assistant_request.rb +11 -0
  12. data/lib/peal/assistant/types/suggestion_request.rb +15 -0
  13. data/lib/peal/billing/client.rb +58 -0
  14. data/lib/peal/billing/types/get_billing_request.rb +11 -0
  15. data/lib/peal/channels/client.rb +366 -0
  16. data/lib/peal/channels/types/choose_accounts.rb +17 -0
  17. data/lib/peal/channels/types/connect_callback.rb +21 -0
  18. data/lib/peal/channels/types/connect_channel.rb +17 -0
  19. data/lib/peal/channels/types/disconnect_channels_request.rb +13 -0
  20. data/lib/peal/channels/types/list_channels_request.rb +11 -0
  21. data/lib/peal/channels/types/platforms_channels_request.rb +11 -0
  22. data/lib/peal/channels/types/reconnect_channels_request.rb +13 -0
  23. data/lib/peal/client.rb +93 -0
  24. data/lib/peal/environment.rb +7 -0
  25. data/lib/peal/errors/api_error.rb +8 -0
  26. data/lib/peal/errors/client_error.rb +17 -0
  27. data/lib/peal/errors/connection_error.rb +11 -0
  28. data/lib/peal/errors/redirect_error.rb +8 -0
  29. data/lib/peal/errors/response_error.rb +65 -0
  30. data/lib/peal/errors/server_error.rb +11 -0
  31. data/lib/peal/errors/timeout_error.rb +8 -0
  32. data/lib/peal/internal/errors/constraint_error.rb +10 -0
  33. data/lib/peal/internal/errors/type_error.rb +10 -0
  34. data/lib/peal/internal/http/base_request.rb +83 -0
  35. data/lib/peal/internal/http/raw_client.rb +297 -0
  36. data/lib/peal/internal/iterators/cursor_item_iterator.rb +33 -0
  37. data/lib/peal/internal/iterators/cursor_page_iterator.rb +126 -0
  38. data/lib/peal/internal/iterators/item_iterator.rb +120 -0
  39. data/lib/peal/internal/iterators/offset_item_iterator.rb +35 -0
  40. data/lib/peal/internal/iterators/offset_page_iterator.rb +160 -0
  41. data/lib/peal/internal/json/request.rb +51 -0
  42. data/lib/peal/internal/json/serializable.rb +25 -0
  43. data/lib/peal/internal/multipart/multipart_encoder.rb +141 -0
  44. data/lib/peal/internal/multipart/multipart_form_data.rb +84 -0
  45. data/lib/peal/internal/multipart/multipart_form_data_part.rb +51 -0
  46. data/lib/peal/internal/multipart/multipart_request.rb +42 -0
  47. data/lib/peal/internal/types/array.rb +47 -0
  48. data/lib/peal/internal/types/boolean.rb +34 -0
  49. data/lib/peal/internal/types/enum.rb +56 -0
  50. data/lib/peal/internal/types/hash.rb +36 -0
  51. data/lib/peal/internal/types/model/field.rb +38 -0
  52. data/lib/peal/internal/types/model.rb +258 -0
  53. data/lib/peal/internal/types/type.rb +35 -0
  54. data/lib/peal/internal/types/union.rb +161 -0
  55. data/lib/peal/internal/types/unknown.rb +15 -0
  56. data/lib/peal/internal/types/utils.rb +144 -0
  57. data/lib/peal/invitations/client.rb +160 -0
  58. data/lib/peal/invitations/types/list_invitations_request.rb +11 -0
  59. data/lib/peal/invitations/types/new_invitation.rb +15 -0
  60. data/lib/peal/invitations/types/revoke_invitations_request.rb +13 -0
  61. data/lib/peal/media/client.rb +360 -0
  62. data/lib/peal/media/types/complete_media_request.rb +13 -0
  63. data/lib/peal/media/types/delete_media_request.rb +13 -0
  64. data/lib/peal/media/types/get_media_request.rb +13 -0
  65. data/lib/peal/media/types/list_media_request.rb +15 -0
  66. data/lib/peal/media/types/media_description.rb +15 -0
  67. data/lib/peal/media/types/new_upload.rb +17 -0
  68. data/lib/peal/media/types/usage_media_request.rb +13 -0
  69. data/lib/peal/members/client.rb +58 -0
  70. data/lib/peal/members/types/list_members_request.rb +11 -0
  71. data/lib/peal/notices/client.rb +189 -0
  72. data/lib/peal/notices/types/list_notices_request.rb +13 -0
  73. data/lib/peal/notices/types/mark_notices_read.rb +11 -0
  74. data/lib/peal/notification_preferences/client.rb +100 -0
  75. data/lib/peal/notification_preferences/types/notification_preferences_change.rb +13 -0
  76. data/lib/peal/notification_preferences/types/notification_preferences_change_email.rb +19 -0
  77. data/lib/peal/posts/client.rb +703 -0
  78. data/lib/peal/posts/types/attempts_posts_request.rb +13 -0
  79. data/lib/peal/posts/types/cancel_posts_request.rb +13 -0
  80. data/lib/peal/posts/types/confirm_posts_request.rb +17 -0
  81. data/lib/peal/posts/types/create_posts_request.rb +13 -0
  82. data/lib/peal/posts/types/discard_posts_request.rb +13 -0
  83. data/lib/peal/posts/types/drafts_posts_request.rb +15 -0
  84. data/lib/peal/posts/types/get_posts_request.rb +13 -0
  85. data/lib/peal/posts/types/list_posts_request.rb +15 -0
  86. data/lib/peal/posts/types/repost_posts_request.rb +15 -0
  87. data/lib/peal/posts/types/reschedule_posts_request.rb +15 -0
  88. data/lib/peal/posts/types/schedule_post.rb +19 -0
  89. data/lib/peal/posts/types/unschedule_posts_request.rb +13 -0
  90. data/lib/peal/posts/types/update_posts_request.rb +15 -0
  91. data/lib/peal/session/client.rb +55 -0
  92. data/lib/peal/system/client.rb +82 -0
  93. data/lib/peal/tiktok/client.rb +62 -0
  94. data/lib/peal/tiktok/types/creator_tiktok_request.rb +13 -0
  95. data/lib/peal/types/already_member_encoded.rb +9 -0
  96. data/lib/peal/types/alt_text_too_long_encoded.rb +13 -0
  97. data/lib/peal/types/alt_text_too_long_encoded_tag.rb +13 -0
  98. data/lib/peal/types/analytics_summary.rb +23 -0
  99. data/lib/peal/types/api_key.rb +21 -0
  100. data/lib/peal/types/api_key_not_found_encoded.rb +9 -0
  101. data/lib/peal/types/assistant_action.rb +21 -0
  102. data/lib/peal/types/assistant_action_hashtags.rb +9 -0
  103. data/lib/peal/types/assistant_action_rewrite.rb +11 -0
  104. data/lib/peal/types/assistant_action_shorten.rb +11 -0
  105. data/lib/peal/types/assistant_action_translate.rb +11 -0
  106. data/lib/peal/types/assistant_failed_encoded.rb +13 -0
  107. data/lib/peal/types/assistant_failed_encoded_reason.rb +16 -0
  108. data/lib/peal/types/assistant_failed_encoded_tag.rb +13 -0
  109. data/lib/peal/types/assistant_input_rejected_encoded.rb +15 -0
  110. data/lib/peal/types/assistant_input_rejected_encoded_reason.rb +14 -0
  111. data/lib/peal/types/assistant_input_rejected_encoded_tag.rb +13 -0
  112. data/lib/peal/types/assistant_quota_exceeded_encoded.rb +15 -0
  113. data/lib/peal/types/assistant_quota_exceeded_encoded_tag.rb +13 -0
  114. data/lib/peal/types/assistant_status.rb +19 -0
  115. data/lib/peal/types/assistant_tone.rb +17 -0
  116. data/lib/peal/types/assistant_unavailable_encoded.rb +11 -0
  117. data/lib/peal/types/assistant_unavailable_encoded_tag.rb +13 -0
  118. data/lib/peal/types/attempt_result.rb +24 -0
  119. data/lib/peal/types/authorization.rb +11 -0
  120. data/lib/peal/types/billing.rb +21 -0
  121. data/lib/peal/types/billing_subscription.rb +17 -0
  122. data/lib/peal/types/calendar_day.rb +25 -0
  123. data/lib/peal/types/channel.rb +23 -0
  124. data/lib/peal/types/channel_cannot_post_encoded.rb +13 -0
  125. data/lib/peal/types/channel_cannot_post_encoded_reason.rb +14 -0
  126. data/lib/peal/types/channel_cannot_post_encoded_tag.rb +13 -0
  127. data/lib/peal/types/channel_metrics.rb +23 -0
  128. data/lib/peal/types/channel_not_found_encoded.rb +9 -0
  129. data/lib/peal/types/channel_options.rb +13 -0
  130. data/lib/peal/types/channel_status.rb +19 -0
  131. data/lib/peal/types/channel_status_active.rb +9 -0
  132. data/lib/peal/types/channel_status_disabled.rb +11 -0
  133. data/lib/peal/types/channel_status_refresh_needed.rb +9 -0
  134. data/lib/peal/types/choosable_account.rb +19 -0
  135. data/lib/peal/types/conflict_error_body.rb +17 -0
  136. data/lib/peal/types/connect_failed_encoded.rb +13 -0
  137. data/lib/peal/types/connect_failed_encoded_tag.rb +13 -0
  138. data/lib/peal/types/connect_failure_reason.rb +22 -0
  139. data/lib/peal/types/connect_outcome.rb +17 -0
  140. data/lib/peal/types/connect_outcome_choose.rb +15 -0
  141. data/lib/peal/types/connect_outcome_connected.rb +11 -0
  142. data/lib/peal/types/connectable_platforms.rb +11 -0
  143. data/lib/peal/types/content_violation.rb +65 -0
  144. data/lib/peal/types/content_violation_alt_text_too_long.rb +19 -0
  145. data/lib/peal/types/content_violation_aspect_ratio_unsupported.rb +23 -0
  146. data/lib/peal/types/content_violation_aspect_ratio_unsupported_maximum.rb +15 -0
  147. data/lib/peal/types/content_violation_aspect_ratio_unsupported_minimum.rb +15 -0
  148. data/lib/peal/types/content_violation_empty.rb +13 -0
  149. data/lib/peal/types/content_violation_forbidden_characters.rb +15 -0
  150. data/lib/peal/types/content_violation_media_required.rb +13 -0
  151. data/lib/peal/types/content_violation_media_too_large.rb +19 -0
  152. data/lib/peal/types/content_violation_media_too_small.rb +19 -0
  153. data/lib/peal/types/content_violation_media_type_unsupported.rb +17 -0
  154. data/lib/peal/types/content_violation_mixed_media.rb +13 -0
  155. data/lib/peal/types/content_violation_no_channels.rb +9 -0
  156. data/lib/peal/types/content_violation_option_invalid.rb +15 -0
  157. data/lib/peal/types/content_violation_option_missing.rb +15 -0
  158. data/lib/peal/types/content_violation_option_too_long.rb +19 -0
  159. data/lib/peal/types/content_violation_options_for_other_platform.rb +15 -0
  160. data/lib/peal/types/content_violation_options_without_channel.rb +11 -0
  161. data/lib/peal/types/content_violation_override_without_channel.rb +11 -0
  162. data/lib/peal/types/content_violation_side_out_of_range.rb +23 -0
  163. data/lib/peal/types/content_violation_text_too_long.rb +19 -0
  164. data/lib/peal/types/content_violation_too_many_hashtags.rb +17 -0
  165. data/lib/peal/types/content_violation_too_many_links.rb +17 -0
  166. data/lib/peal/types/content_violation_too_many_media.rb +17 -0
  167. data/lib/peal/types/content_violation_too_many_mentions.rb +17 -0
  168. data/lib/peal/types/content_violation_too_many_pixels.rb +21 -0
  169. data/lib/peal/types/content_violation_too_many_videos.rb +17 -0
  170. data/lib/peal/types/content_violation_video_too_long.rb +19 -0
  171. data/lib/peal/types/content_violation_video_too_short.rb +19 -0
  172. data/lib/peal/types/created_api_key.rb +13 -0
  173. data/lib/peal/types/database_unavailable_encoded.rb +11 -0
  174. data/lib/peal/types/database_unavailable_encoded_tag.rb +13 -0
  175. data/lib/peal/types/draft_page.rb +13 -0
  176. data/lib/peal/types/effect_http_api_error_bad_request_encoded.rb +11 -0
  177. data/lib/peal/types/effect_http_api_error_bad_request_encoded_tag.rb +13 -0
  178. data/lib/peal/types/engagement_day.rb +19 -0
  179. data/lib/peal/types/failure_reason.rb +24 -0
  180. data/lib/peal/types/forbidden_encoded.rb +11 -0
  181. data/lib/peal/types/forbidden_encoded_tag.rb +13 -0
  182. data/lib/peal/types/invalid_date_range_encoded.rb +11 -0
  183. data/lib/peal/types/invalid_date_range_encoded_tag.rb +13 -0
  184. data/lib/peal/types/invalid_time_range_encoded.rb +11 -0
  185. data/lib/peal/types/invalid_time_range_encoded_tag.rb +13 -0
  186. data/lib/peal/types/invalid_time_zone_encoded.rb +13 -0
  187. data/lib/peal/types/invalid_time_zone_encoded_tag.rb +13 -0
  188. data/lib/peal/types/invitation.rb +21 -0
  189. data/lib/peal/types/invitation_not_found_encoded.rb +9 -0
  190. data/lib/peal/types/me.rb +15 -0
  191. data/lib/peal/types/me_user.rb +21 -0
  192. data/lib/peal/types/me_user_locale.rb +14 -0
  193. data/lib/peal/types/media.rb +33 -0
  194. data/lib/peal/types/media_attachment.rb +13 -0
  195. data/lib/peal/types/media_content_type.rb +18 -0
  196. data/lib/peal/types/media_dimensions.rb +13 -0
  197. data/lib/peal/types/media_in_use_encoded.rb +13 -0
  198. data/lib/peal/types/media_in_use_encoded_tag.rb +13 -0
  199. data/lib/peal/types/media_kind.rb +14 -0
  200. data/lib/peal/types/media_not_found_encoded.rb +9 -0
  201. data/lib/peal/types/media_page.rb +13 -0
  202. data/lib/peal/types/media_status.rb +21 -0
  203. data/lib/peal/types/media_status_pending.rb +9 -0
  204. data/lib/peal/types/media_status_ready.rb +9 -0
  205. data/lib/peal/types/media_status_rejected.rb +11 -0
  206. data/lib/peal/types/media_status_uploaded.rb +11 -0
  207. data/lib/peal/types/media_store_unavailable_encoded.rb +11 -0
  208. data/lib/peal/types/media_store_unavailable_encoded_tag.rb +13 -0
  209. data/lib/peal/types/media_too_large_encoded.rb +15 -0
  210. data/lib/peal/types/media_too_large_encoded_kind.rb +14 -0
  211. data/lib/peal/types/media_usage.rb +13 -0
  212. data/lib/peal/types/membership.rb +19 -0
  213. data/lib/peal/types/metric_totals.rb +21 -0
  214. data/lib/peal/types/metrics_snapshot.rb +13 -0
  215. data/lib/peal/types/non_finite_number.rb +14 -0
  216. data/lib/peal/types/not_found_error_body.rb +17 -0
  217. data/lib/peal/types/notice.rb +19 -0
  218. data/lib/peal/types/notice_channel.rb +13 -0
  219. data/lib/peal/types/notice_event.rb +23 -0
  220. data/lib/peal/types/notice_event_channel_reconnect_required.rb +11 -0
  221. data/lib/peal/types/notice_event_channel_reconnect_soon.rb +13 -0
  222. data/lib/peal/types/notice_event_post_failed.rb +15 -0
  223. data/lib/peal/types/notice_event_post_published.rb +15 -0
  224. data/lib/peal/types/notice_event_post_unconfirmed.rb +13 -0
  225. data/lib/peal/types/notice_page.rb +13 -0
  226. data/lib/peal/types/notification_preferences.rb +13 -0
  227. data/lib/peal/types/notification_preferences_email.rb +17 -0
  228. data/lib/peal/types/paid_plan.rb +14 -0
  229. data/lib/peal/types/period_usage.rb +13 -0
  230. data/lib/peal/types/permission.rb +40 -0
  231. data/lib/peal/types/plan.rb +15 -0
  232. data/lib/peal/types/plan_allowances.rb +17 -0
  233. data/lib/peal/types/plan_limit.rb +16 -0
  234. data/lib/peal/types/plan_limit_reached_encoded.rb +15 -0
  235. data/lib/peal/types/plan_limit_reached_encoded_tag.rb +13 -0
  236. data/lib/peal/types/plan_offer.rb +13 -0
  237. data/lib/peal/types/platform.rb +22 -0
  238. data/lib/peal/types/platform_unreachable_encoded.rb +11 -0
  239. data/lib/peal/types/platform_unreachable_encoded_tag.rb +13 -0
  240. data/lib/peal/types/post.rb +23 -0
  241. data/lib/peal/types/post_analytics.rb +13 -0
  242. data/lib/peal/types/post_content.rb +15 -0
  243. data/lib/peal/types/post_content_invalid_encoded.rb +11 -0
  244. data/lib/peal/types/post_draft.rb +15 -0
  245. data/lib/peal/types/post_metrics.rb +19 -0
  246. data/lib/peal/types/post_not_found_encoded.rb +9 -0
  247. data/lib/peal/types/post_outcome.rb +17 -0
  248. data/lib/peal/types/post_schedule.rb +13 -0
  249. data/lib/peal/types/post_status.rb +17 -0
  250. data/lib/peal/types/post_status_conflict_encoded.rb +13 -0
  251. data/lib/peal/types/post_status_conflict_encoded_tag.rb +13 -0
  252. data/lib/peal/types/post_target.rb +29 -0
  253. data/lib/peal/types/post_target_status.rb +18 -0
  254. data/lib/peal/types/prepared_upload.rb +13 -0
  255. data/lib/peal/types/probe_state.rb +18 -0
  256. data/lib/peal/types/publication_attempt.rb +23 -0
  257. data/lib/peal/types/rejection_reason.rb +14 -0
  258. data/lib/peal/types/role.rb +17 -0
  259. data/lib/peal/types/schedule_in_past_encoded.rb +9 -0
  260. data/lib/peal/types/signed_request.rb +15 -0
  261. data/lib/peal/types/signed_request_method.rb +13 -0
  262. data/lib/peal/types/subscription_status.rb +20 -0
  263. data/lib/peal/types/suggestion.rb +17 -0
  264. data/lib/peal/types/suggestion_hashtags.rb +11 -0
  265. data/lib/peal/types/suggestion_text.rb +11 -0
  266. data/lib/peal/types/target_confirmation.rb +17 -0
  267. data/lib/peal/types/target_confirmation_not_published.rb +9 -0
  268. data/lib/peal/types/target_confirmation_published.rb +11 -0
  269. data/lib/peal/types/target_metrics.rb +25 -0
  270. data/lib/peal/types/target_options.rb +19 -0
  271. data/lib/peal/types/target_status_conflict_encoded.rb +11 -0
  272. data/lib/peal/types/text_override.rb +13 -0
  273. data/lib/peal/types/text_unit.rb +18 -0
  274. data/lib/peal/types/tik_tok_account.rb +13 -0
  275. data/lib/peal/types/tik_tok_account_posting.rb +17 -0
  276. data/lib/peal/types/tik_tok_account_posting_blocked.rb +11 -0
  277. data/lib/peal/types/tik_tok_account_posting_ready.rb +11 -0
  278. data/lib/peal/types/tik_tok_block.rb +15 -0
  279. data/lib/peal/types/tik_tok_creator.rb +25 -0
  280. data/lib/peal/types/tik_tok_options.rb +26 -0
  281. data/lib/peal/types/tik_tok_privacy_level.rb +16 -0
  282. data/lib/peal/types/too_many_invitations_encoded.rb +9 -0
  283. data/lib/peal/types/top_post.rb +23 -0
  284. data/lib/peal/types/translation_language.rb +22 -0
  285. data/lib/peal/types/unauthenticated_encoded.rb +11 -0
  286. data/lib/peal/types/unauthenticated_encoded_tag.rb +13 -0
  287. data/lib/peal/types/unconfirmed_reason.rb +16 -0
  288. data/lib/peal/types/unknown_channels_encoded.rb +11 -0
  289. data/lib/peal/types/unknown_media_encoded.rb +11 -0
  290. data/lib/peal/types/unprocessable_entity_error_body.rb +19 -0
  291. data/lib/peal/types/unread_notices.rb +11 -0
  292. data/lib/peal/types/unsupported_media_type_encoded.rb +11 -0
  293. data/lib/peal/types/upload_incomplete_encoded.rb +11 -0
  294. data/lib/peal/types/upload_incomplete_encoded_tag.rb +13 -0
  295. data/lib/peal/types/upload_part.rb +15 -0
  296. data/lib/peal/types/upload_rejected_encoded.rb +13 -0
  297. data/lib/peal/types/upload_rejected_encoded_tag.rb +13 -0
  298. data/lib/peal/types/upload_target.rb +17 -0
  299. data/lib/peal/types/upload_target_multipart.rb +15 -0
  300. data/lib/peal/types/upload_target_single.rb +13 -0
  301. data/lib/peal/types/usage.rb +17 -0
  302. data/lib/peal/types/workspace_member.rb +19 -0
  303. data/lib/peal/types/workspace_not_found_encoded.rb +11 -0
  304. data/lib/peal/types/workspace_not_found_encoded_tag.rb +13 -0
  305. data/lib/peal/types/you_tube_options.rb +24 -0
  306. data/lib/peal/types/you_tube_privacy.rb +15 -0
  307. data/lib/peal/version.rb +2 -12
  308. data/lib/peal.rb +315 -248
  309. metadata +312 -292
  310. data/lib/peal/api/analytics_api.rb +0 -185
  311. data/lib/peal/api/api_keys_api.rb +0 -228
  312. data/lib/peal/api/assistant_api.rb +0 -159
  313. data/lib/peal/api/billing_api.rb +0 -85
  314. data/lib/peal/api/channels_api.rb +0 -526
  315. data/lib/peal/api/invitations_api.rb +0 -228
  316. data/lib/peal/api/media_api.rb +0 -526
  317. data/lib/peal/api/members_api.rb +0 -85
  318. data/lib/peal/api/notices_api.rb +0 -272
  319. data/lib/peal/api/notification_preferences_api.rb +0 -147
  320. data/lib/peal/api/posts_api.rb +0 -993
  321. data/lib/peal/api/session_api.rb +0 -79
  322. data/lib/peal/api/system_api.rb +0 -134
  323. data/lib/peal/api/tiktok_api.rb +0 -91
  324. data/lib/peal/api_client.rb +0 -441
  325. data/lib/peal/api_error.rb +0 -58
  326. data/lib/peal/api_model_base.rb +0 -88
  327. data/lib/peal/configuration.rb +0 -392
  328. data/lib/peal/models/already_member_encoded.rb +0 -201
  329. data/lib/peal/models/alt_text_too_long_encoded.rb +0 -245
  330. data/lib/peal/models/analytics_summary.rb +0 -361
  331. data/lib/peal/models/api_key.rb +0 -281
  332. data/lib/peal/models/api_key_not_found_encoded.rb +0 -201
  333. data/lib/peal/models/api_keys_revoke404_response.rb +0 -103
  334. data/lib/peal/models/assistant_action.rb +0 -105
  335. data/lib/peal/models/assistant_action_any_of.rb +0 -227
  336. data/lib/peal/models/assistant_action_any_of1.rb +0 -227
  337. data/lib/peal/models/assistant_action_any_of2.rb +0 -227
  338. data/lib/peal/models/assistant_action_any_of3.rb +0 -201
  339. data/lib/peal/models/assistant_failed_encoded.rb +0 -229
  340. data/lib/peal/models/assistant_input_rejected_encoded.rb +0 -273
  341. data/lib/peal/models/assistant_quota_exceeded_encoded.rb +0 -271
  342. data/lib/peal/models/assistant_status.rb +0 -335
  343. data/lib/peal/models/assistant_tone.rb +0 -43
  344. data/lib/peal/models/assistant_unavailable_encoded.rb +0 -201
  345. data/lib/peal/models/attempt_result.rb +0 -50
  346. data/lib/peal/models/authorization.rb +0 -177
  347. data/lib/peal/models/billing.rb +0 -303
  348. data/lib/peal/models/billing_subscription.rb +0 -263
  349. data/lib/peal/models/channel.rb +0 -313
  350. data/lib/peal/models/channel_cannot_post_encoded.rb +0 -229
  351. data/lib/peal/models/channel_metrics.rb +0 -425
  352. data/lib/peal/models/channel_not_found_encoded.rb +0 -201
  353. data/lib/peal/models/channel_options.rb +0 -203
  354. data/lib/peal/models/channel_status.rb +0 -104
  355. data/lib/peal/models/channel_status_any_of.rb +0 -201
  356. data/lib/peal/models/channel_status_any_of1.rb +0 -201
  357. data/lib/peal/models/channel_status_any_of2.rb +0 -227
  358. data/lib/peal/models/channels_complete_connect404_response.rb +0 -103
  359. data/lib/peal/models/choosable_account.rb +0 -253
  360. data/lib/peal/models/choose_accounts.rb +0 -241
  361. data/lib/peal/models/connect_callback.rb +0 -279
  362. data/lib/peal/models/connect_channel.rb +0 -207
  363. data/lib/peal/models/connect_failed_encoded.rb +0 -227
  364. data/lib/peal/models/connect_failure_reason.rb +0 -48
  365. data/lib/peal/models/connect_outcome.rb +0 -103
  366. data/lib/peal/models/connect_outcome_any_of.rb +0 -227
  367. data/lib/peal/models/connect_outcome_any_of1.rb +0 -281
  368. data/lib/peal/models/connectable_platforms.rb +0 -179
  369. data/lib/peal/models/content_violation.rb +0 -127
  370. data/lib/peal/models/content_violation_any_of.rb +0 -201
  371. data/lib/peal/models/content_violation_any_of1.rb +0 -227
  372. data/lib/peal/models/content_violation_any_of10.rb +0 -341
  373. data/lib/peal/models/content_violation_any_of11.rb +0 -253
  374. data/lib/peal/models/content_violation_any_of12.rb +0 -341
  375. data/lib/peal/models/content_violation_any_of13.rb +0 -341
  376. data/lib/peal/models/content_violation_any_of14.rb +0 -341
  377. data/lib/peal/models/content_violation_any_of15.rb +0 -341
  378. data/lib/peal/models/content_violation_any_of16.rb +0 -253
  379. data/lib/peal/models/content_violation_any_of17.rb +0 -305
  380. data/lib/peal/models/content_violation_any_of18.rb +0 -367
  381. data/lib/peal/models/content_violation_any_of19.rb +0 -367
  382. data/lib/peal/models/content_violation_any_of2.rb +0 -227
  383. data/lib/peal/models/content_violation_any_of20.rb +0 -367
  384. data/lib/peal/models/content_violation_any_of21.rb +0 -367
  385. data/lib/peal/models/content_violation_any_of22.rb +0 -411
  386. data/lib/peal/models/content_violation_any_of23.rb +0 -455
  387. data/lib/peal/models/content_violation_any_of24.rb +0 -419
  388. data/lib/peal/models/content_violation_any_of24_maximum.rb +0 -103
  389. data/lib/peal/models/content_violation_any_of25.rb +0 -367
  390. data/lib/peal/models/content_violation_any_of3.rb +0 -279
  391. data/lib/peal/models/content_violation_any_of4.rb +0 -279
  392. data/lib/peal/models/content_violation_any_of5.rb +0 -367
  393. data/lib/peal/models/content_violation_any_of6.rb +0 -279
  394. data/lib/peal/models/content_violation_any_of7.rb +0 -253
  395. data/lib/peal/models/content_violation_any_of8.rb +0 -367
  396. data/lib/peal/models/content_violation_any_of9.rb +0 -281
  397. data/lib/peal/models/created_api_key.rb +0 -203
  398. data/lib/peal/models/database_unavailable_encoded.rb +0 -201
  399. data/lib/peal/models/draft_page.rb +0 -191
  400. data/lib/peal/models/effect_http_api_error_bad_request_encoded.rb +0 -201
  401. data/lib/peal/models/engagement_day.rb +0 -364
  402. data/lib/peal/models/failure_reason.rb +0 -50
  403. data/lib/peal/models/forbidden_encoded.rb +0 -201
  404. data/lib/peal/models/invalid_date_range_encoded.rb +0 -201
  405. data/lib/peal/models/invalid_time_range_encoded.rb +0 -201
  406. data/lib/peal/models/invalid_time_zone_encoded.rb +0 -227
  407. data/lib/peal/models/invitation.rb +0 -307
  408. data/lib/peal/models/invitation_not_found_encoded.rb +0 -201
  409. data/lib/peal/models/invitations_create409_response.rb +0 -103
  410. data/lib/peal/models/invitations_revoke404_response.rb +0 -103
  411. data/lib/peal/models/mark_notices_read.rb +0 -197
  412. data/lib/peal/models/me.rb +0 -217
  413. data/lib/peal/models/me_user.rb +0 -317
  414. data/lib/peal/models/media.rb +0 -457
  415. data/lib/peal/models/media_attachment.rb +0 -212
  416. data/lib/peal/models/media_content_type.rb +0 -44
  417. data/lib/peal/models/media_create422_response.rb +0 -104
  418. data/lib/peal/models/media_description.rb +0 -163
  419. data/lib/peal/models/media_dimensions.rb +0 -239
  420. data/lib/peal/models/media_get404_response.rb +0 -103
  421. data/lib/peal/models/media_in_use_encoded.rb +0 -229
  422. data/lib/peal/models/media_kind.rb +0 -40
  423. data/lib/peal/models/media_not_found_encoded.rb +0 -201
  424. data/lib/peal/models/media_page.rb +0 -191
  425. data/lib/peal/models/media_status.rb +0 -105
  426. data/lib/peal/models/media_status_any_of.rb +0 -201
  427. data/lib/peal/models/media_status_any_of1.rb +0 -227
  428. data/lib/peal/models/media_status_any_of2.rb +0 -201
  429. data/lib/peal/models/media_status_any_of3.rb +0 -227
  430. data/lib/peal/models/media_store_unavailable_encoded.rb +0 -201
  431. data/lib/peal/models/media_too_large_encoded.rb +0 -317
  432. data/lib/peal/models/media_usage.rb +0 -207
  433. data/lib/peal/models/membership.rb +0 -283
  434. data/lib/peal/models/metric_totals.rb +0 -399
  435. data/lib/peal/models/metrics_snapshot.rb +0 -203
  436. data/lib/peal/models/new_api_key.rb +0 -269
  437. data/lib/peal/models/new_invitation.rb +0 -245
  438. data/lib/peal/models/new_upload.rb +0 -231
  439. data/lib/peal/models/non_finite_number.rb +0 -41
  440. data/lib/peal/models/notice.rb +0 -267
  441. data/lib/peal/models/notice_channel.rb +0 -225
  442. data/lib/peal/models/notice_event.rb +0 -106
  443. data/lib/peal/models/notice_event_any_of.rb +0 -251
  444. data/lib/peal/models/notice_event_any_of1.rb +0 -265
  445. data/lib/peal/models/notice_event_any_of2.rb +0 -239
  446. data/lib/peal/models/notice_event_any_of3.rb +0 -227
  447. data/lib/peal/models/notice_event_any_of4.rb +0 -253
  448. data/lib/peal/models/notice_page.rb +0 -191
  449. data/lib/peal/models/notification_preferences.rb +0 -203
  450. data/lib/peal/models/notification_preferences_change.rb +0 -169
  451. data/lib/peal/models/notification_preferences_change_email.rb +0 -187
  452. data/lib/peal/models/notification_preferences_email.rb +0 -255
  453. data/lib/peal/models/paid_plan.rb +0 -40
  454. data/lib/peal/models/period_usage.rb +0 -221
  455. data/lib/peal/models/permission.rb +0 -66
  456. data/lib/peal/models/plan.rb +0 -41
  457. data/lib/peal/models/plan_allowances.rb +0 -295
  458. data/lib/peal/models/plan_limit.rb +0 -42
  459. data/lib/peal/models/plan_limit_reached_encoded.rb +0 -271
  460. data/lib/peal/models/plan_offer.rb +0 -225
  461. data/lib/peal/models/platform.rb +0 -48
  462. data/lib/peal/models/platform_unreachable_encoded.rb +0 -201
  463. data/lib/peal/models/post.rb +0 -315
  464. data/lib/peal/models/post_analytics.rb +0 -205
  465. data/lib/peal/models/post_content.rb +0 -251
  466. data/lib/peal/models/post_content_invalid_encoded.rb +0 -229
  467. data/lib/peal/models/post_draft.rb +0 -216
  468. data/lib/peal/models/post_metrics.rb +0 -355
  469. data/lib/peal/models/post_not_found_encoded.rb +0 -201
  470. data/lib/peal/models/post_outcome.rb +0 -43
  471. data/lib/peal/models/post_schedule.rb +0 -203
  472. data/lib/peal/models/post_status.rb +0 -43
  473. data/lib/peal/models/post_status_conflict_encoded.rb +0 -227
  474. data/lib/peal/models/post_target.rb +0 -364
  475. data/lib/peal/models/post_target_status.rb +0 -44
  476. data/lib/peal/models/posts_create422_response.rb +0 -104
  477. data/lib/peal/models/posts_get404_response.rb +0 -103
  478. data/lib/peal/models/posts_repost409_response.rb +0 -103
  479. data/lib/peal/models/posts_schedule422_response.rb +0 -106
  480. data/lib/peal/models/prepared_upload.rb +0 -203
  481. data/lib/peal/models/probe_state.rb +0 -44
  482. data/lib/peal/models/publication_attempt.rb +0 -377
  483. data/lib/peal/models/rejection_reason.rb +0 -40
  484. data/lib/peal/models/role.rb +0 -43
  485. data/lib/peal/models/schedule_in_past_encoded.rb +0 -201
  486. data/lib/peal/models/schedule_post.rb +0 -240
  487. data/lib/peal/models/signed_request.rb +0 -255
  488. data/lib/peal/models/subscription_status.rb +0 -46
  489. data/lib/peal/models/suggestion.rb +0 -103
  490. data/lib/peal/models/suggestion_any_of.rb +0 -227
  491. data/lib/peal/models/suggestion_any_of1.rb +0 -229
  492. data/lib/peal/models/suggestion_request.rb +0 -212
  493. data/lib/peal/models/target_confirmation.rb +0 -103
  494. data/lib/peal/models/target_confirmation_any_of.rb +0 -228
  495. data/lib/peal/models/target_confirmation_any_of1.rb +0 -201
  496. data/lib/peal/models/target_metrics.rb +0 -319
  497. data/lib/peal/models/target_options.rb +0 -104
  498. data/lib/peal/models/target_status_conflict_encoded.rb +0 -227
  499. data/lib/peal/models/text_override.rb +0 -221
  500. data/lib/peal/models/text_unit.rb +0 -44
  501. data/lib/peal/models/tik_tok_account.rb +0 -203
  502. data/lib/peal/models/tik_tok_account_posting.rb +0 -103
  503. data/lib/peal/models/tik_tok_account_posting_any_of.rb +0 -227
  504. data/lib/peal/models/tik_tok_account_posting_any_of1.rb +0 -227
  505. data/lib/peal/models/tik_tok_block.rb +0 -41
  506. data/lib/peal/models/tik_tok_creator.rb +0 -357
  507. data/lib/peal/models/tik_tok_options.rb +0 -274
  508. data/lib/peal/models/tik_tok_privacy_level.rb +0 -42
  509. data/lib/peal/models/too_many_invitations_encoded.rb +0 -201
  510. data/lib/peal/models/top_post.rb +0 -337
  511. data/lib/peal/models/translation_language.rb +0 -48
  512. data/lib/peal/models/unauthenticated_encoded.rb +0 -201
  513. data/lib/peal/models/unconfirmed_reason.rb +0 -42
  514. data/lib/peal/models/unknown_channels_encoded.rb +0 -229
  515. data/lib/peal/models/unknown_media_encoded.rb +0 -229
  516. data/lib/peal/models/unread_notices.rb +0 -195
  517. data/lib/peal/models/unsupported_media_type_encoded.rb +0 -227
  518. data/lib/peal/models/upload_incomplete_encoded.rb +0 -201
  519. data/lib/peal/models/upload_part.rb +0 -265
  520. data/lib/peal/models/upload_rejected_encoded.rb +0 -227
  521. data/lib/peal/models/upload_target.rb +0 -103
  522. data/lib/peal/models/upload_target_any_of.rb +0 -253
  523. data/lib/peal/models/upload_target_any_of1.rb +0 -299
  524. data/lib/peal/models/usage.rb +0 -291
  525. data/lib/peal/models/workspace_member.rb +0 -281
  526. data/lib/peal/models/workspace_not_found_encoded.rb +0 -201
  527. data/lib/peal/models/you_tube_options.rb +0 -324
  528. data/lib/peal/models/you_tube_privacy.rb +0 -41
@@ -1,526 +0,0 @@
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 (&#x60;MediaInUse&#x60;, 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&#39;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&#39;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&#39;s media, newest first, 30 a page unless &#x60;limit&#x60; (at most 100) says otherwise. Pass the page&#39;s &#x60;nextCursor&#x60; as &#x60;cursor&#x60; 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
@@ -1,85 +0,0 @@
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&#39;s members, in the order they joined, with their name, email address and role. Every member may see them, as the workspace&#39;s settings show them; an API key may not, as members&#39; addresses are not a script&#39;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