postboost 1.8.0 → 1.14.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 (735) hide show
  1. checksums.yaml +4 -4
  2. data/CODE_OF_CONDUCT.md +7 -0
  3. data/CONTRIBUTING.md +31 -0
  4. data/README.md +134 -1
  5. data/SECURITY.md +9 -0
  6. data/docs/AIApi.md +432 -0
  7. data/docs/AIUsage.md +20 -0
  8. data/docs/AIUsageText.md +24 -0
  9. data/docs/Account.md +6 -2
  10. data/docs/AccountConnectionHealth.md +34 -0
  11. data/docs/AccountErrorsInner.md +49 -0
  12. data/docs/AccountErrorsInnerOneOf.md +24 -0
  13. data/docs/AccountGroup.md +24 -0
  14. data/docs/AccountGroupInput.md +20 -0
  15. data/docs/AccountGroupsApi.md +372 -0
  16. data/docs/AccountHealth.md +34 -0
  17. data/docs/AccountHealthDailyCap.md +20 -0
  18. data/docs/AccountsApi.md +216 -0
  19. data/docs/ActivityApi.md +87 -0
  20. data/docs/AddCompetitor202Response.md +20 -0
  21. data/docs/AddCompetitor409Response.md +20 -0
  22. data/docs/AgentPageMeta.md +24 -0
  23. data/docs/AgentProposal.md +44 -0
  24. data/docs/AgentProposalDecision.md +18 -0
  25. data/docs/AgentRun.md +44 -0
  26. data/docs/AgentsApi.md +745 -0
  27. data/docs/AnalyticsApi.md +498 -0
  28. data/docs/ApiActivity.md +36 -0
  29. data/docs/ApiActivityOutcome.md +15 -0
  30. data/docs/ApiKey.md +32 -0
  31. data/docs/ApiKeyAbility.md +15 -0
  32. data/docs/ApiKeyInput.md +24 -0
  33. data/docs/ApproveAgentProposal200Response.md +18 -0
  34. data/docs/ApproveAgentProposal409Response.md +20 -0
  35. data/docs/ApproveInboxReplyDraft403Response.md +20 -0
  36. data/docs/BlogToSocial200Response.md +3 -1
  37. data/docs/BlogToSocialInput.md +3 -1
  38. data/docs/BrandVoice.md +48 -0
  39. data/docs/BrandVoiceInput.md +46 -0
  40. data/docs/BrandVoiceMeta.md +18 -0
  41. data/docs/ChannelAccount.md +36 -0
  42. data/docs/CodedError.md +22 -0
  43. data/docs/Competitor.md +34 -0
  44. data/docs/CompetitorDetail.md +38 -0
  45. data/docs/CompetitorInput.md +20 -0
  46. data/docs/CompetitorMedia.md +28 -0
  47. data/docs/CompetitorSnapshot.md +22 -0
  48. data/docs/CompetitorsApi.md +296 -0
  49. data/docs/ConnectChannelInput.md +24 -0
  50. data/docs/CreateAccountGroup201Response.md +18 -0
  51. data/docs/CreateAgent201Response.md +18 -0
  52. data/docs/CreateApiKey201Response.md +18 -0
  53. data/docs/CreateApiKey201ResponseData.md +34 -0
  54. data/docs/CreateHashtagGroup201Response.md +18 -0
  55. data/docs/CreateInboxReplyDraft201Response.md +18 -0
  56. data/docs/CreateRecyclingRule201Response.md +18 -0
  57. data/docs/CreateReportExport201Response.md +18 -0
  58. data/docs/CreateResellerClient201Response.md +18 -0
  59. data/docs/CreateRssFeed201Response.md +18 -0
  60. data/docs/CreateTemplate201Response.md +18 -0
  61. data/docs/CreateWebhookSubscription201Response.md +18 -0
  62. data/docs/CreateWebhookSubscription201ResponseData.md +30 -0
  63. data/docs/DeleteAgent200Response.md +18 -0
  64. data/docs/GetAccountHealth200Response.md +18 -0
  65. data/docs/GetBrandVoice200Response.md +18 -0
  66. data/docs/GetCompetitor200Response.md +18 -0
  67. data/docs/GetInboxConversation200Response.md +18 -0
  68. data/docs/GetPostingSchedule200Response.md +18 -0
  69. data/docs/GetReportBranding200Response.md +18 -0
  70. data/docs/GuardrailError.md +28 -0
  71. data/docs/HashtagGroup.md +22 -0
  72. data/docs/HashtagGroupInput.md +20 -0
  73. data/docs/HashtagGroupsApi.md +372 -0
  74. data/docs/ImageCreditBalance.md +28 -0
  75. data/docs/ImageEditInput.md +2 -0
  76. data/docs/ImageGenerate200Response.md +3 -1
  77. data/docs/ImageGenerateInput.md +3 -1
  78. data/docs/ImagePrompt200Response.md +3 -1
  79. data/docs/ImagePromptInput.md +3 -1
  80. data/docs/InboxApi.md +758 -0
  81. data/docs/InboxAuthor.md +22 -0
  82. data/docs/InboxConversation.md +46 -0
  83. data/docs/InboxConversationAccount.md +24 -0
  84. data/docs/InboxConversationUpdate.md +20 -0
  85. data/docs/InboxMessage.md +32 -0
  86. data/docs/InboxMessageAuthor.md +22 -0
  87. data/docs/InboxReplyDraft.md +42 -0
  88. data/docs/InboxReplyDraftApprove.md +18 -0
  89. data/docs/InboxReplyDraftEdit.md +18 -0
  90. data/docs/InboxReplyDraftInput.md +20 -0
  91. data/docs/LearnBrandVoiceInput.md +24 -0
  92. data/docs/LearnBrandVoiceResponse.md +20 -0
  93. data/docs/LearnBrandVoiceResponseMeta.md +26 -0
  94. data/docs/ListAccountGroups200Response.md +22 -0
  95. data/docs/ListAgentProposals200Response.md +20 -0
  96. data/docs/ListAgentRuns200Response.md +20 -0
  97. data/docs/ListAgents200Response.md +18 -0
  98. data/docs/ListApiActivity200Response.md +22 -0
  99. data/docs/ListApiKeys200Response.md +18 -0
  100. data/docs/ListCompetitors200Response.md +18 -0
  101. data/docs/ListHashtagGroups200Response.md +22 -0
  102. data/docs/ListInboxConversations200Response.md +22 -0
  103. data/docs/ListInboxReplyDrafts200Response.md +22 -0
  104. data/docs/ListRecyclingRules200Response.md +18 -0
  105. data/docs/ListRecyclingRuns200Response.md +18 -0
  106. data/docs/ListReportExports200Response.md +18 -0
  107. data/docs/ListResellerClients200Response.md +20 -0
  108. data/docs/ListRssFeeds200Response.md +18 -0
  109. data/docs/ListTemplates200Response.md +22 -0
  110. data/docs/ListWebhookSubscriptions200Response.md +18 -0
  111. data/docs/MediaApi.md +103 -13
  112. data/docs/MediaBase64Input.md +24 -0
  113. data/docs/MentionsApi.md +8 -4
  114. data/docs/MessageOnly.md +18 -0
  115. data/docs/PollRssFeed200Response.md +22 -0
  116. data/docs/PostContent.md +1 -1
  117. data/docs/PostInput.md +5 -1
  118. data/docs/PostOptionsInstagram.md +22 -0
  119. data/docs/PostOptionsTikTok.md +34 -0
  120. data/docs/PostOptionsYoutube.md +24 -0
  121. data/docs/PostVersion.md +2 -2
  122. data/docs/PostVersionOptions.md +24 -0
  123. data/docs/PostingSchedule.md +28 -0
  124. data/docs/PostingScheduleApi.md +377 -0
  125. data/docs/PostingScheduleDay.md +22 -0
  126. data/docs/PostingScheduleDayTimesInner.md +18 -0
  127. data/docs/PostingScheduleInput.md +24 -0
  128. data/docs/PostsApi.md +1132 -110
  129. data/docs/PreflightResult.md +26 -0
  130. data/docs/QueueSlots.md +20 -0
  131. data/docs/RecommendedPostingTimes.md +26 -0
  132. data/docs/ReconnectLink.md +22 -0
  133. data/docs/RecyclingRule.md +42 -0
  134. data/docs/RecyclingRuleInput.md +34 -0
  135. data/docs/RecyclingRuleSettings.md +28 -0
  136. data/docs/RecyclingRuleUpdate.md +28 -0
  137. data/docs/RecyclingRun.md +28 -0
  138. data/docs/ReportBranding.md +28 -0
  139. data/docs/ReportBrandingInput.md +24 -0
  140. data/docs/ReportExport.md +42 -0
  141. data/docs/ReportExportInput.md +28 -0
  142. data/docs/RepurposeContent200Response.md +20 -0
  143. data/docs/RepurposeInput.md +54 -0
  144. data/docs/RepurposeInputTheme.md +22 -0
  145. data/docs/RepurposeResult.md +32 -0
  146. data/docs/RepurposeResultMedia.md +20 -0
  147. data/docs/RepurposeResultSource.md +22 -0
  148. data/docs/RepurposeSlide.md +20 -0
  149. data/docs/ResellerClient.md +32 -0
  150. data/docs/ResellerClientInput.md +18 -0
  151. data/docs/ResellerClientUsage.md +20 -0
  152. data/docs/RssFeed.md +38 -0
  153. data/docs/RssFeedInput.md +30 -0
  154. data/docs/RssFeedUpdate.md +30 -0
  155. data/docs/RunAgent202Response.md +18 -0
  156. data/docs/TagsApi.md +8 -4
  157. data/docs/Template.md +22 -0
  158. data/docs/TemplateContentItem.md +20 -0
  159. data/docs/TemplateInput.md +20 -0
  160. data/docs/TemplateInputContentInner.md +20 -0
  161. data/docs/TemplatesApi.md +372 -0
  162. data/docs/WebhookEventName.md +15 -0
  163. data/docs/WebhookEventPayload.md +20 -0
  164. data/docs/WebhookSubscription.md +28 -0
  165. data/docs/WebhookSubscriptionInput.md +24 -0
  166. data/docs/WebhooksApi.md +221 -0
  167. data/docs/WorkspaceAgent.md +34 -0
  168. data/docs/WorkspaceAgentInput.md +26 -0
  169. data/docs/WorkspaceAgentSettings.md +26 -0
  170. data/docs/WorkspaceAgentUpdate.md +24 -0
  171. data/docs/WorkspacesApi.md +426 -0
  172. data/docs/XUsage.md +28 -0
  173. data/docs/XUsageCounter.md +20 -0
  174. data/lib/postboost/api/account_groups_api.rb +395 -0
  175. data/lib/postboost/api/accounts_api.rb +219 -2
  176. data/lib/postboost/api/activity_api.rb +97 -0
  177. data/lib/postboost/api/agents_api.rb +771 -0
  178. data/lib/postboost/api/ai_api.rb +420 -2
  179. data/lib/postboost/api/analytics_api.rb +487 -2
  180. data/lib/postboost/api/competitors_api.rb +300 -0
  181. data/lib/postboost/api/hashtag_groups_api.rb +395 -0
  182. data/lib/postboost/api/inbox_api.rb +789 -0
  183. data/lib/postboost/api/media_api.rb +133 -4
  184. data/lib/postboost/api/mentions_api.rb +13 -2
  185. data/lib/postboost/api/posting_schedule_api.rb +389 -0
  186. data/lib/postboost/api/posts_api.rb +1149 -96
  187. data/lib/postboost/api/receipts_api.rb +2 -2
  188. data/lib/postboost/api/subscriptions_api.rb +2 -2
  189. data/lib/postboost/api/tags_api.rb +13 -2
  190. data/lib/postboost/api/templates_api.rb +395 -0
  191. data/lib/postboost/api/users_api.rb +2 -2
  192. data/lib/postboost/api/webhooks_api.rb +228 -0
  193. data/lib/postboost/api/workspaces_api.rb +408 -2
  194. data/lib/postboost/api_client.rb +2 -2
  195. data/lib/postboost/api_error.rb +2 -2
  196. data/lib/postboost/configuration.rb +2 -2
  197. data/lib/postboost/models/account.rb +28 -4
  198. data/lib/postboost/models/account_analytics.rb +2 -2
  199. data/lib/postboost/models/account_analytics_initial_sync.rb +2 -2
  200. data/lib/postboost/models/account_connection_health.rb +389 -0
  201. data/lib/postboost/models/account_errors_inner.rb +105 -0
  202. data/lib/postboost/models/account_errors_inner_one_of.rb +243 -0
  203. data/lib/postboost/models/account_group.rb +271 -0
  204. data/lib/postboost/models/account_group_input.rb +252 -0
  205. data/lib/postboost/models/account_health.rb +352 -0
  206. data/lib/postboost/models/account_health_daily_cap.rb +239 -0
  207. data/lib/postboost/models/account_schedule.rb +2 -2
  208. data/lib/postboost/models/add_competitor202_response.rb +271 -0
  209. data/lib/postboost/models/add_competitor409_response.rb +223 -0
  210. data/lib/postboost/models/add_generic_subscription_request.rb +2 -2
  211. data/lib/postboost/models/add_post_to_queue_request.rb +2 -2
  212. data/lib/postboost/models/agent_page_meta.rb +269 -0
  213. data/lib/postboost/models/agent_proposal.rb +444 -0
  214. data/lib/postboost/models/agent_proposal_decision.rb +233 -0
  215. data/lib/postboost/models/agent_run.rb +434 -0
  216. data/lib/postboost/models/ai_credits.rb +2 -2
  217. data/lib/postboost/models/ai_usage.rb +237 -0
  218. data/lib/postboost/models/ai_usage_text.rb +252 -0
  219. data/lib/postboost/models/analytics_period.rb +2 -2
  220. data/lib/postboost/models/analytics_summary.rb +2 -2
  221. data/lib/postboost/models/analytics_summary_data.rb +2 -2
  222. data/lib/postboost/models/api_activity.rb +359 -0
  223. data/lib/postboost/models/api_activity_outcome.rb +49 -0
  224. data/lib/postboost/models/api_key.rb +308 -0
  225. data/lib/postboost/models/api_key_ability.rb +43 -0
  226. data/lib/postboost/models/api_key_input.rb +316 -0
  227. data/lib/postboost/models/approve_agent_proposal200_response.rb +221 -0
  228. data/lib/postboost/models/approve_agent_proposal409_response.rb +237 -0
  229. data/lib/postboost/models/approve_inbox_reply_draft403_response.rb +264 -0
  230. data/lib/postboost/models/approve_post_request.rb +2 -2
  231. data/lib/postboost/models/best_posting_times.rb +2 -2
  232. data/lib/postboost/models/best_posting_times_times_inner.rb +2 -2
  233. data/lib/postboost/models/blog_to_social200_response.rb +15 -6
  234. data/lib/postboost/models/blog_to_social429_response.rb +2 -2
  235. data/lib/postboost/models/blog_to_social_caption.rb +2 -2
  236. data/lib/postboost/models/blog_to_social_input.rb +18 -6
  237. data/lib/postboost/models/blog_to_social_media.rb +2 -2
  238. data/lib/postboost/models/blog_to_social_response.rb +2 -2
  239. data/lib/postboost/models/brand_voice.rb +531 -0
  240. data/lib/postboost/models/brand_voice_input.rb +646 -0
  241. data/lib/postboost/models/brand_voice_meta.rb +222 -0
  242. data/lib/postboost/models/cancel_subscription422_response.rb +2 -2
  243. data/lib/postboost/models/cancel_subscription422_response_errors.rb +2 -2
  244. data/lib/postboost/models/cancel_subscription_request.rb +2 -2
  245. data/lib/postboost/models/change_subscription_plan_request.rb +2 -2
  246. data/lib/postboost/models/channel_account.rb +380 -0
  247. data/lib/postboost/models/checkout_subscription200_response.rb +2 -2
  248. data/lib/postboost/models/checkout_subscription_request.rb +2 -2
  249. data/lib/postboost/models/coded_error.rb +242 -0
  250. data/lib/postboost/models/competitor.rb +320 -0
  251. data/lib/postboost/models/competitor_detail.rb +358 -0
  252. data/lib/postboost/models/competitor_input.rb +258 -0
  253. data/lib/postboost/models/competitor_media.rb +263 -0
  254. data/lib/postboost/models/competitor_snapshot.rb +234 -0
  255. data/lib/postboost/models/complete_chunked_upload_request.rb +2 -2
  256. data/lib/postboost/models/connect_channel_input.rb +265 -0
  257. data/lib/postboost/models/create_account_group201_response.rb +221 -0
  258. data/lib/postboost/models/create_agent201_response.rb +221 -0
  259. data/lib/postboost/models/create_api_key201_response.rb +221 -0
  260. data/lib/postboost/models/create_api_key201_response_data.rb +327 -0
  261. data/lib/postboost/models/create_hashtag_group201_response.rb +221 -0
  262. data/lib/postboost/models/create_inbox_reply_draft201_response.rb +221 -0
  263. data/lib/postboost/models/create_media_folder_request.rb +2 -2
  264. data/lib/postboost/models/create_mention201_response.rb +2 -2
  265. data/lib/postboost/models/create_recycling_rule201_response.rb +221 -0
  266. data/lib/postboost/models/create_report_export201_response.rb +221 -0
  267. data/lib/postboost/models/create_reseller_client201_response.rb +221 -0
  268. data/lib/postboost/models/create_rss_feed201_response.rb +221 -0
  269. data/lib/postboost/models/create_template201_response.rb +221 -0
  270. data/lib/postboost/models/create_webhook_subscription201_response.rb +221 -0
  271. data/lib/postboost/models/create_webhook_subscription201_response_data.rb +320 -0
  272. data/lib/postboost/models/delete_agent200_response.rb +221 -0
  273. data/lib/postboost/models/delete_media_bulk_request.rb +2 -2
  274. data/lib/postboost/models/delete_media_bulk_request_items_inner.rb +2 -2
  275. data/lib/postboost/models/delete_media_folder_request.rb +2 -2
  276. data/lib/postboost/models/delete_mode.rb +2 -2
  277. data/lib/postboost/models/delete_post_request.rb +2 -2
  278. data/lib/postboost/models/delete_posts_bulk_request.rb +2 -2
  279. data/lib/postboost/models/delete_receipts_bulk_request.rb +2 -2
  280. data/lib/postboost/models/delete_result.rb +2 -2
  281. data/lib/postboost/models/delete_user400_response.rb +2 -2
  282. data/lib/postboost/models/delete_users_bulk_request.rb +2 -2
  283. data/lib/postboost/models/delete_workspaces_bulk_request.rb +2 -2
  284. data/lib/postboost/models/get_account_health200_response.rb +223 -0
  285. data/lib/postboost/models/get_brand_voice200_response.rb +217 -0
  286. data/lib/postboost/models/get_competitor200_response.rb +221 -0
  287. data/lib/postboost/models/get_inbox_conversation200_response.rb +221 -0
  288. data/lib/postboost/models/get_posting_schedule200_response.rb +221 -0
  289. data/lib/postboost/models/get_remote_upload_status200_response.rb +2 -2
  290. data/lib/postboost/models/get_report_branding200_response.rb +221 -0
  291. data/lib/postboost/models/guardrail_error.rb +304 -0
  292. data/lib/postboost/models/hashtag_group.rb +254 -0
  293. data/lib/postboost/models/hashtag_group_input.rb +275 -0
  294. data/lib/postboost/models/image_alt_text200_response.rb +2 -2
  295. data/lib/postboost/models/image_alt_text_input.rb +2 -2
  296. data/lib/postboost/models/image_alt_text_response.rb +2 -2
  297. data/lib/postboost/models/image_credit_balance.rb +295 -0
  298. data/lib/postboost/models/image_edit_input.rb +15 -3
  299. data/lib/postboost/models/image_generate200_response.rb +15 -6
  300. data/lib/postboost/models/image_generate429_response.rb +2 -2
  301. data/lib/postboost/models/image_generate_input.rb +35 -3
  302. data/lib/postboost/models/image_generation_response.rb +2 -2
  303. data/lib/postboost/models/image_prompt200_response.rb +15 -6
  304. data/lib/postboost/models/image_prompt429_response.rb +2 -2
  305. data/lib/postboost/models/image_prompt_input.rb +35 -3
  306. data/lib/postboost/models/image_prompt_response.rb +2 -2
  307. data/lib/postboost/models/image_variations200_response.rb +2 -2
  308. data/lib/postboost/models/image_variations_input.rb +2 -2
  309. data/lib/postboost/models/image_variations_response.rb +2 -2
  310. data/lib/postboost/models/inbox_author.rb +235 -0
  311. data/lib/postboost/models/inbox_conversation.rb +425 -0
  312. data/lib/postboost/models/inbox_conversation_account.rb +241 -0
  313. data/lib/postboost/models/inbox_conversation_update.rb +257 -0
  314. data/lib/postboost/models/inbox_message.rb +360 -0
  315. data/lib/postboost/models/inbox_message_author.rb +235 -0
  316. data/lib/postboost/models/inbox_reply_draft.rb +410 -0
  317. data/lib/postboost/models/inbox_reply_draft_approve.rb +215 -0
  318. data/lib/postboost/models/inbox_reply_draft_edit.rb +221 -0
  319. data/lib/postboost/models/inbox_reply_draft_input.rb +232 -0
  320. data/lib/postboost/models/initiate_chunked_upload201_response.rb +2 -2
  321. data/lib/postboost/models/initiate_chunked_upload_request.rb +2 -2
  322. data/lib/postboost/models/initiate_remote_upload201_response.rb +2 -2
  323. data/lib/postboost/models/initiate_remote_upload201_response_one_of.rb +2 -2
  324. data/lib/postboost/models/initiate_remote_upload_request.rb +2 -2
  325. data/lib/postboost/models/learn_brand_voice_input.rb +300 -0
  326. data/lib/postboost/models/learn_brand_voice_response.rb +237 -0
  327. data/lib/postboost/models/learn_brand_voice_response_meta.rb +281 -0
  328. data/lib/postboost/models/list_account_groups200_response.rb +248 -0
  329. data/lib/postboost/models/list_accounts200_response.rb +2 -2
  330. data/lib/postboost/models/list_agent_proposals200_response.rb +239 -0
  331. data/lib/postboost/models/list_agent_runs200_response.rb +239 -0
  332. data/lib/postboost/models/list_agents200_response.rb +223 -0
  333. data/lib/postboost/models/list_api_activity200_response.rb +241 -0
  334. data/lib/postboost/models/list_api_keys200_response.rb +223 -0
  335. data/lib/postboost/models/list_competitors200_response.rb +223 -0
  336. data/lib/postboost/models/list_hashtag_groups200_response.rb +248 -0
  337. data/lib/postboost/models/list_inbox_conversations200_response.rb +241 -0
  338. data/lib/postboost/models/list_inbox_reply_drafts200_response.rb +241 -0
  339. data/lib/postboost/models/list_media200_response.rb +2 -2
  340. data/lib/postboost/models/list_media_folders200_response.rb +2 -2
  341. data/lib/postboost/models/list_mentions200_response.rb +2 -2
  342. data/lib/postboost/models/list_my_workspaces200_response.rb +2 -2
  343. data/lib/postboost/models/list_posts200_response.rb +2 -2
  344. data/lib/postboost/models/list_receipts200_response.rb +2 -2
  345. data/lib/postboost/models/list_recycling_rules200_response.rb +223 -0
  346. data/lib/postboost/models/list_recycling_runs200_response.rb +223 -0
  347. data/lib/postboost/models/list_report_exports200_response.rb +223 -0
  348. data/lib/postboost/models/list_reseller_clients200_response.rb +239 -0
  349. data/lib/postboost/models/list_rss_feeds200_response.rb +223 -0
  350. data/lib/postboost/models/list_tags200_response.rb +2 -2
  351. data/lib/postboost/models/list_templates200_response.rb +248 -0
  352. data/lib/postboost/models/list_users200_response.rb +2 -2
  353. data/lib/postboost/models/list_webhook_subscriptions200_response.rb +223 -0
  354. data/lib/postboost/models/list_workspaces200_response.rb +2 -2
  355. data/lib/postboost/models/media.rb +2 -2
  356. data/lib/postboost/models/media_base64_input.rb +295 -0
  357. data/lib/postboost/models/media_folder.rb +2 -2
  358. data/lib/postboost/models/media_folder_input.rb +2 -2
  359. data/lib/postboost/models/media_folder_ref.rb +2 -2
  360. data/lib/postboost/models/mention.rb +2 -2
  361. data/lib/postboost/models/mention_identity.rb +2 -2
  362. data/lib/postboost/models/mention_identity_input.rb +2 -2
  363. data/lib/postboost/models/mention_input.rb +2 -2
  364. data/lib/postboost/models/message_only.rb +221 -0
  365. data/lib/postboost/models/pagination_meta.rb +2 -2
  366. data/lib/postboost/models/pagination_meta_links.rb +4 -2
  367. data/lib/postboost/models/pagination_meta_meta.rb +4 -2
  368. data/lib/postboost/models/poll_rss_feed200_response.rb +255 -0
  369. data/lib/postboost/models/post.rb +2 -2
  370. data/lib/postboost/models/post_analytics.rb +2 -2
  371. data/lib/postboost/models/post_content.rb +4 -3
  372. data/lib/postboost/models/post_input.rb +28 -6
  373. data/lib/postboost/models/post_options_instagram.rb +294 -0
  374. data/lib/postboost/models/post_options_tik_tok.rb +329 -0
  375. data/lib/postboost/models/post_options_youtube.rb +302 -0
  376. data/lib/postboost/models/post_status.rb +2 -2
  377. data/lib/postboost/models/post_version.rb +23 -4
  378. data/lib/postboost/models/post_version_options.rb +242 -0
  379. data/lib/postboost/models/posting_schedule.rb +303 -0
  380. data/lib/postboost/models/posting_schedule_day.rb +285 -0
  381. data/lib/postboost/models/posting_schedule_day_times_inner.rb +222 -0
  382. data/lib/postboost/models/posting_schedule_input.rb +312 -0
  383. data/lib/postboost/models/posting_time_slot.rb +2 -2
  384. data/lib/postboost/models/posting_times.rb +2 -2
  385. data/lib/postboost/models/posting_times_best_inner.rb +2 -2
  386. data/lib/postboost/models/posting_times_day_intervals_inner_inner.rb +2 -2
  387. data/lib/postboost/models/posting_times_days_inner.rb +2 -2
  388. data/lib/postboost/models/preflight_result.rb +291 -0
  389. data/lib/postboost/models/public_workspace.rb +2 -2
  390. data/lib/postboost/models/public_workspace_pivot.rb +2 -2
  391. data/lib/postboost/models/publish_progress.rb +2 -2
  392. data/lib/postboost/models/queue_slots.rb +237 -0
  393. data/lib/postboost/models/receipt.rb +2 -2
  394. data/lib/postboost/models/receipt_input.rb +2 -2
  395. data/lib/postboost/models/receipt_update_input.rb +2 -2
  396. data/lib/postboost/models/recommended_posting_times.rb +282 -0
  397. data/lib/postboost/models/reconnect_link.rb +254 -0
  398. data/lib/postboost/models/recycling_rule.rb +434 -0
  399. data/lib/postboost/models/recycling_rule_input.rb +435 -0
  400. data/lib/postboost/models/recycling_rule_settings.rb +381 -0
  401. data/lib/postboost/models/recycling_rule_update.rb +366 -0
  402. data/lib/postboost/models/recycling_run.rb +320 -0
  403. data/lib/postboost/models/remove_generic_subscription422_response.rb +2 -2
  404. data/lib/postboost/models/remove_user_from_workspace_request.rb +2 -2
  405. data/lib/postboost/models/report_branding.rb +285 -0
  406. data/lib/postboost/models/report_branding_input.rb +293 -0
  407. data/lib/postboost/models/report_export.rb +442 -0
  408. data/lib/postboost/models/report_export_input.rb +350 -0
  409. data/lib/postboost/models/repurpose_content200_response.rb +237 -0
  410. data/lib/postboost/models/repurpose_input.rb +667 -0
  411. data/lib/postboost/models/repurpose_input_theme.rb +296 -0
  412. data/lib/postboost/models/repurpose_result.rb +328 -0
  413. data/lib/postboost/models/repurpose_result_media.rb +224 -0
  414. data/lib/postboost/models/repurpose_result_source.rb +283 -0
  415. data/lib/postboost/models/repurpose_slide.rb +239 -0
  416. data/lib/postboost/models/reseller_client.rb +360 -0
  417. data/lib/postboost/models/reseller_client_input.rb +240 -0
  418. data/lib/postboost/models/reseller_client_usage.rb +239 -0
  419. data/lib/postboost/models/retry_post_account_result.rb +2 -2
  420. data/lib/postboost/models/rss_feed.rb +402 -0
  421. data/lib/postboost/models/rss_feed_input.rb +433 -0
  422. data/lib/postboost/models/rss_feed_update.rb +396 -0
  423. data/lib/postboost/models/run_agent202_response.rb +221 -0
  424. data/lib/postboost/models/schedule_post_request.rb +2 -2
  425. data/lib/postboost/models/schedule_result.rb +2 -2
  426. data/lib/postboost/models/subscription.rb +2 -2
  427. data/lib/postboost/models/subscription_input.rb +2 -2
  428. data/lib/postboost/models/subscription_status.rb +2 -2
  429. data/lib/postboost/models/subscription_update_input.rb +2 -2
  430. data/lib/postboost/models/tag.rb +2 -2
  431. data/lib/postboost/models/tag_input.rb +2 -2
  432. data/lib/postboost/models/template.rb +256 -0
  433. data/lib/postboost/models/template_content_item.rb +240 -0
  434. data/lib/postboost/models/template_input.rb +271 -0
  435. data/lib/postboost/models/template_input_content_inner.rb +227 -0
  436. data/lib/postboost/models/update_media_request.rb +2 -2
  437. data/lib/postboost/models/upload_chunk201_response.rb +2 -2
  438. data/lib/postboost/models/user.rb +2 -2
  439. data/lib/postboost/models/user_input.rb +2 -2
  440. data/lib/postboost/models/user_update_input.rb +2 -2
  441. data/lib/postboost/models/webhook_event_name.rb +50 -0
  442. data/lib/postboost/models/webhook_event_payload.rb +262 -0
  443. data/lib/postboost/models/webhook_subscription.rb +297 -0
  444. data/lib/postboost/models/webhook_subscription_input.rb +349 -0
  445. data/lib/postboost/models/workspace.rb +2 -2
  446. data/lib/postboost/models/workspace_agent.rb +381 -0
  447. data/lib/postboost/models/workspace_agent_input.rb +326 -0
  448. data/lib/postboost/models/workspace_agent_settings.rb +340 -0
  449. data/lib/postboost/models/workspace_agent_update.rb +294 -0
  450. data/lib/postboost/models/workspace_input.rb +2 -2
  451. data/lib/postboost/models/workspace_user_input.rb +2 -2
  452. data/lib/postboost/models/x_usage.rb +303 -0
  453. data/lib/postboost/models/x_usage_counter.rb +234 -0
  454. data/lib/postboost/version.rb +3 -3
  455. data/lib/postboost.rb +151 -2
  456. data/postboost.gemspec +3 -3
  457. data/spec/api/account_groups_api_spec.rb +102 -0
  458. data/spec/api/accounts_api_spec.rb +41 -2
  459. data/spec/api/activity_api_spec.rb +51 -0
  460. data/spec/api/agents_api_spec.rb +170 -0
  461. data/spec/api/ai_api_spec.rb +78 -2
  462. data/spec/api/analytics_api_spec.rb +90 -2
  463. data/spec/api/competitors_api_spec.rb +87 -0
  464. data/spec/api/hashtag_groups_api_spec.rb +102 -0
  465. data/spec/api/inbox_api_spec.rb +178 -0
  466. data/spec/api/media_api_spec.rb +21 -3
  467. data/spec/api/mentions_api_spec.rb +3 -2
  468. data/spec/api/posting_schedule_api_spec.rb +102 -0
  469. data/spec/api/posts_api_spec.rb +189 -3
  470. data/spec/api/receipts_api_spec.rb +2 -2
  471. data/spec/api/subscriptions_api_spec.rb +2 -2
  472. data/spec/api/tags_api_spec.rb +3 -2
  473. data/spec/api/templates_api_spec.rb +102 -0
  474. data/spec/api/users_api_spec.rb +2 -2
  475. data/spec/api/webhooks_api_spec.rb +73 -0
  476. data/spec/api/workspaces_api_spec.rb +77 -2
  477. data/spec/models/account_analytics_initial_sync_spec.rb +2 -2
  478. data/spec/models/account_analytics_spec.rb +2 -2
  479. data/spec/models/account_connection_health_spec.rb +92 -0
  480. data/spec/models/account_errors_inner_one_of_spec.rb +54 -0
  481. data/spec/models/account_errors_inner_spec.rb +32 -0
  482. data/spec/models/account_group_input_spec.rb +42 -0
  483. data/spec/models/account_group_spec.rb +54 -0
  484. data/spec/models/account_health_daily_cap_spec.rb +42 -0
  485. data/spec/models/account_health_spec.rb +84 -0
  486. data/spec/models/account_schedule_spec.rb +2 -2
  487. data/spec/models/account_spec.rb +14 -2
  488. data/spec/models/add_competitor202_response_spec.rb +46 -0
  489. data/spec/models/add_competitor409_response_spec.rb +42 -0
  490. data/spec/models/add_generic_subscription_request_spec.rb +2 -2
  491. data/spec/models/add_post_to_queue_request_spec.rb +2 -2
  492. data/spec/models/agent_page_meta_spec.rb +54 -0
  493. data/spec/models/agent_proposal_decision_spec.rb +36 -0
  494. data/spec/models/agent_proposal_spec.rb +126 -0
  495. data/spec/models/agent_run_spec.rb +122 -0
  496. data/spec/models/ai_credits_spec.rb +2 -2
  497. data/spec/models/ai_usage_spec.rb +42 -0
  498. data/spec/models/ai_usage_text_spec.rb +54 -0
  499. data/spec/models/analytics_period_spec.rb +2 -2
  500. data/spec/models/analytics_summary_data_spec.rb +2 -2
  501. data/spec/models/analytics_summary_spec.rb +2 -2
  502. data/spec/models/api_activity_outcome_spec.rb +30 -0
  503. data/spec/models/api_activity_spec.rb +90 -0
  504. data/spec/models/api_key_ability_spec.rb +30 -0
  505. data/spec/models/api_key_input_spec.rb +54 -0
  506. data/spec/models/api_key_spec.rb +78 -0
  507. data/spec/models/approve_agent_proposal200_response_spec.rb +36 -0
  508. data/spec/models/approve_agent_proposal409_response_spec.rb +42 -0
  509. data/spec/models/approve_inbox_reply_draft403_response_spec.rb +46 -0
  510. data/spec/models/approve_post_request_spec.rb +2 -2
  511. data/spec/models/best_posting_times_spec.rb +2 -2
  512. data/spec/models/best_posting_times_times_inner_spec.rb +2 -2
  513. data/spec/models/blog_to_social200_response_spec.rb +8 -2
  514. data/spec/models/blog_to_social429_response_spec.rb +2 -2
  515. data/spec/models/blog_to_social_caption_spec.rb +2 -2
  516. data/spec/models/blog_to_social_input_spec.rb +8 -2
  517. data/spec/models/blog_to_social_media_spec.rb +2 -2
  518. data/spec/models/blog_to_social_response_spec.rb +2 -2
  519. data/spec/models/brand_voice_input_spec.rb +128 -0
  520. data/spec/models/brand_voice_meta_spec.rb +36 -0
  521. data/spec/models/brand_voice_spec.rb +134 -0
  522. data/spec/models/cancel_subscription422_response_errors_spec.rb +2 -2
  523. data/spec/models/cancel_subscription422_response_spec.rb +2 -2
  524. data/spec/models/cancel_subscription_request_spec.rb +2 -2
  525. data/spec/models/change_subscription_plan_request_spec.rb +2 -2
  526. data/spec/models/channel_account_spec.rb +94 -0
  527. data/spec/models/checkout_subscription200_response_spec.rb +2 -2
  528. data/spec/models/checkout_subscription_request_spec.rb +2 -2
  529. data/spec/models/coded_error_spec.rb +48 -0
  530. data/spec/models/competitor_detail_spec.rb +96 -0
  531. data/spec/models/competitor_input_spec.rb +42 -0
  532. data/spec/models/competitor_media_spec.rb +66 -0
  533. data/spec/models/competitor_snapshot_spec.rb +48 -0
  534. data/spec/models/competitor_spec.rb +84 -0
  535. data/spec/models/complete_chunked_upload_request_spec.rb +2 -2
  536. data/spec/models/connect_channel_input_spec.rb +54 -0
  537. data/spec/models/create_account_group201_response_spec.rb +36 -0
  538. data/spec/models/create_agent201_response_spec.rb +36 -0
  539. data/spec/models/create_api_key201_response_data_spec.rb +84 -0
  540. data/spec/models/create_api_key201_response_spec.rb +36 -0
  541. data/spec/models/create_hashtag_group201_response_spec.rb +36 -0
  542. data/spec/models/create_inbox_reply_draft201_response_spec.rb +36 -0
  543. data/spec/models/create_media_folder_request_spec.rb +2 -2
  544. data/spec/models/create_mention201_response_spec.rb +2 -2
  545. data/spec/models/create_recycling_rule201_response_spec.rb +36 -0
  546. data/spec/models/create_report_export201_response_spec.rb +36 -0
  547. data/spec/models/create_reseller_client201_response_spec.rb +36 -0
  548. data/spec/models/create_rss_feed201_response_spec.rb +36 -0
  549. data/spec/models/create_template201_response_spec.rb +36 -0
  550. data/spec/models/create_webhook_subscription201_response_data_spec.rb +72 -0
  551. data/spec/models/create_webhook_subscription201_response_spec.rb +36 -0
  552. data/spec/models/delete_agent200_response_spec.rb +36 -0
  553. data/spec/models/delete_media_bulk_request_items_inner_spec.rb +2 -2
  554. data/spec/models/delete_media_bulk_request_spec.rb +2 -2
  555. data/spec/models/delete_media_folder_request_spec.rb +2 -2
  556. data/spec/models/delete_mode_spec.rb +2 -2
  557. data/spec/models/delete_post_request_spec.rb +2 -2
  558. data/spec/models/delete_posts_bulk_request_spec.rb +2 -2
  559. data/spec/models/delete_receipts_bulk_request_spec.rb +2 -2
  560. data/spec/models/delete_result_spec.rb +2 -2
  561. data/spec/models/delete_user400_response_spec.rb +2 -2
  562. data/spec/models/delete_users_bulk_request_spec.rb +2 -2
  563. data/spec/models/delete_workspaces_bulk_request_spec.rb +2 -2
  564. data/spec/models/get_account_health200_response_spec.rb +36 -0
  565. data/spec/models/get_brand_voice200_response_spec.rb +36 -0
  566. data/spec/models/get_competitor200_response_spec.rb +36 -0
  567. data/spec/models/get_inbox_conversation200_response_spec.rb +36 -0
  568. data/spec/models/get_posting_schedule200_response_spec.rb +36 -0
  569. data/spec/models/get_remote_upload_status200_response_spec.rb +2 -2
  570. data/spec/models/get_report_branding200_response_spec.rb +36 -0
  571. data/spec/models/guardrail_error_spec.rb +70 -0
  572. data/spec/models/hashtag_group_input_spec.rb +42 -0
  573. data/spec/models/hashtag_group_spec.rb +48 -0
  574. data/spec/models/image_alt_text200_response_spec.rb +2 -2
  575. data/spec/models/image_alt_text_input_spec.rb +2 -2
  576. data/spec/models/image_alt_text_response_spec.rb +2 -2
  577. data/spec/models/image_credit_balance_spec.rb +66 -0
  578. data/spec/models/image_edit_input_spec.rb +8 -2
  579. data/spec/models/image_generate200_response_spec.rb +8 -2
  580. data/spec/models/image_generate429_response_spec.rb +2 -2
  581. data/spec/models/image_generate_input_spec.rb +8 -2
  582. data/spec/models/image_generation_response_spec.rb +2 -2
  583. data/spec/models/image_prompt200_response_spec.rb +8 -2
  584. data/spec/models/image_prompt429_response_spec.rb +2 -2
  585. data/spec/models/image_prompt_input_spec.rb +8 -2
  586. data/spec/models/image_prompt_response_spec.rb +2 -2
  587. data/spec/models/image_variations200_response_spec.rb +2 -2
  588. data/spec/models/image_variations_input_spec.rb +2 -2
  589. data/spec/models/image_variations_response_spec.rb +2 -2
  590. data/spec/models/inbox_author_spec.rb +48 -0
  591. data/spec/models/inbox_conversation_account_spec.rb +54 -0
  592. data/spec/models/inbox_conversation_spec.rb +128 -0
  593. data/spec/models/inbox_conversation_update_spec.rb +46 -0
  594. data/spec/models/inbox_message_author_spec.rb +48 -0
  595. data/spec/models/inbox_message_spec.rb +90 -0
  596. data/spec/models/inbox_reply_draft_approve_spec.rb +36 -0
  597. data/spec/models/inbox_reply_draft_edit_spec.rb +36 -0
  598. data/spec/models/inbox_reply_draft_input_spec.rb +42 -0
  599. data/spec/models/inbox_reply_draft_spec.rb +116 -0
  600. data/spec/models/initiate_chunked_upload201_response_spec.rb +2 -2
  601. data/spec/models/initiate_chunked_upload_request_spec.rb +2 -2
  602. data/spec/models/initiate_remote_upload201_response_one_of_spec.rb +2 -2
  603. data/spec/models/initiate_remote_upload201_response_spec.rb +2 -2
  604. data/spec/models/initiate_remote_upload_request_spec.rb +2 -2
  605. data/spec/models/learn_brand_voice_input_spec.rb +54 -0
  606. data/spec/models/learn_brand_voice_response_meta_spec.rb +60 -0
  607. data/spec/models/learn_brand_voice_response_spec.rb +42 -0
  608. data/spec/models/list_account_groups200_response_spec.rb +48 -0
  609. data/spec/models/list_accounts200_response_spec.rb +2 -2
  610. data/spec/models/list_agent_proposals200_response_spec.rb +42 -0
  611. data/spec/models/list_agent_runs200_response_spec.rb +42 -0
  612. data/spec/models/list_agents200_response_spec.rb +36 -0
  613. data/spec/models/list_api_activity200_response_spec.rb +48 -0
  614. data/spec/models/list_api_keys200_response_spec.rb +36 -0
  615. data/spec/models/list_competitors200_response_spec.rb +36 -0
  616. data/spec/models/list_hashtag_groups200_response_spec.rb +48 -0
  617. data/spec/models/list_inbox_conversations200_response_spec.rb +48 -0
  618. data/spec/models/list_inbox_reply_drafts200_response_spec.rb +48 -0
  619. data/spec/models/list_media200_response_spec.rb +2 -2
  620. data/spec/models/list_media_folders200_response_spec.rb +2 -2
  621. data/spec/models/list_mentions200_response_spec.rb +2 -2
  622. data/spec/models/list_my_workspaces200_response_spec.rb +2 -2
  623. data/spec/models/list_posts200_response_spec.rb +2 -2
  624. data/spec/models/list_receipts200_response_spec.rb +2 -2
  625. data/spec/models/list_recycling_rules200_response_spec.rb +36 -0
  626. data/spec/models/list_recycling_runs200_response_spec.rb +36 -0
  627. data/spec/models/list_report_exports200_response_spec.rb +36 -0
  628. data/spec/models/list_reseller_clients200_response_spec.rb +42 -0
  629. data/spec/models/list_rss_feeds200_response_spec.rb +36 -0
  630. data/spec/models/list_tags200_response_spec.rb +2 -2
  631. data/spec/models/list_templates200_response_spec.rb +48 -0
  632. data/spec/models/list_users200_response_spec.rb +2 -2
  633. data/spec/models/list_webhook_subscriptions200_response_spec.rb +36 -0
  634. data/spec/models/list_workspaces200_response_spec.rb +2 -2
  635. data/spec/models/media_base64_input_spec.rb +54 -0
  636. data/spec/models/media_folder_input_spec.rb +2 -2
  637. data/spec/models/media_folder_ref_spec.rb +2 -2
  638. data/spec/models/media_folder_spec.rb +2 -2
  639. data/spec/models/media_spec.rb +2 -2
  640. data/spec/models/mention_identity_input_spec.rb +2 -2
  641. data/spec/models/mention_identity_spec.rb +2 -2
  642. data/spec/models/mention_input_spec.rb +2 -2
  643. data/spec/models/mention_spec.rb +2 -2
  644. data/spec/models/message_only_spec.rb +36 -0
  645. data/spec/models/pagination_meta_links_spec.rb +2 -2
  646. data/spec/models/pagination_meta_meta_spec.rb +2 -2
  647. data/spec/models/pagination_meta_spec.rb +2 -2
  648. data/spec/models/poll_rss_feed200_response_spec.rb +48 -0
  649. data/spec/models/post_analytics_spec.rb +2 -2
  650. data/spec/models/post_content_spec.rb +2 -2
  651. data/spec/models/post_input_spec.rb +14 -2
  652. data/spec/models/post_options_instagram_spec.rb +52 -0
  653. data/spec/models/post_options_tik_tok_spec.rb +88 -0
  654. data/spec/models/post_options_youtube_spec.rb +58 -0
  655. data/spec/models/post_spec.rb +2 -2
  656. data/spec/models/post_status_spec.rb +2 -2
  657. data/spec/models/post_version_options_spec.rb +54 -0
  658. data/spec/models/post_version_spec.rb +2 -2
  659. data/spec/models/posting_schedule_day_spec.rb +48 -0
  660. data/spec/models/posting_schedule_day_times_inner_spec.rb +36 -0
  661. data/spec/models/posting_schedule_input_spec.rb +54 -0
  662. data/spec/models/posting_schedule_spec.rb +66 -0
  663. data/spec/models/posting_time_slot_spec.rb +2 -2
  664. data/spec/models/posting_times_best_inner_spec.rb +2 -2
  665. data/spec/models/posting_times_day_intervals_inner_inner_spec.rb +2 -2
  666. data/spec/models/posting_times_days_inner_spec.rb +2 -2
  667. data/spec/models/posting_times_spec.rb +2 -2
  668. data/spec/models/preflight_result_spec.rb +60 -0
  669. data/spec/models/public_workspace_pivot_spec.rb +2 -2
  670. data/spec/models/public_workspace_spec.rb +2 -2
  671. data/spec/models/publish_progress_spec.rb +2 -2
  672. data/spec/models/queue_slots_spec.rb +42 -0
  673. data/spec/models/receipt_input_spec.rb +2 -2
  674. data/spec/models/receipt_spec.rb +2 -2
  675. data/spec/models/receipt_update_input_spec.rb +2 -2
  676. data/spec/models/recommended_posting_times_spec.rb +60 -0
  677. data/spec/models/reconnect_link_spec.rb +48 -0
  678. data/spec/models/recycling_rule_input_spec.rb +92 -0
  679. data/spec/models/recycling_rule_settings_spec.rb +70 -0
  680. data/spec/models/recycling_rule_spec.rb +116 -0
  681. data/spec/models/recycling_rule_update_spec.rb +70 -0
  682. data/spec/models/recycling_run_spec.rb +70 -0
  683. data/spec/models/remove_generic_subscription422_response_spec.rb +2 -2
  684. data/spec/models/remove_user_from_workspace_request_spec.rb +2 -2
  685. data/spec/models/report_branding_input_spec.rb +54 -0
  686. data/spec/models/report_branding_spec.rb +66 -0
  687. data/spec/models/report_export_input_spec.rb +78 -0
  688. data/spec/models/report_export_spec.rb +120 -0
  689. data/spec/models/repurpose_content200_response_spec.rb +42 -0
  690. data/spec/models/repurpose_input_spec.rb +164 -0
  691. data/spec/models/repurpose_input_theme_spec.rb +48 -0
  692. data/spec/models/repurpose_result_media_spec.rb +42 -0
  693. data/spec/models/repurpose_result_source_spec.rb +52 -0
  694. data/spec/models/repurpose_result_spec.rb +78 -0
  695. data/spec/models/repurpose_slide_spec.rb +42 -0
  696. data/spec/models/reseller_client_input_spec.rb +36 -0
  697. data/spec/models/reseller_client_spec.rb +82 -0
  698. data/spec/models/reseller_client_usage_spec.rb +42 -0
  699. data/spec/models/retry_post_account_result_spec.rb +2 -2
  700. data/spec/models/rss_feed_input_spec.rb +76 -0
  701. data/spec/models/rss_feed_spec.rb +100 -0
  702. data/spec/models/rss_feed_update_spec.rb +76 -0
  703. data/spec/models/run_agent202_response_spec.rb +36 -0
  704. data/spec/models/schedule_post_request_spec.rb +2 -2
  705. data/spec/models/schedule_result_spec.rb +2 -2
  706. data/spec/models/subscription_input_spec.rb +2 -2
  707. data/spec/models/subscription_spec.rb +2 -2
  708. data/spec/models/subscription_status_spec.rb +2 -2
  709. data/spec/models/subscription_update_input_spec.rb +2 -2
  710. data/spec/models/tag_input_spec.rb +2 -2
  711. data/spec/models/tag_spec.rb +2 -2
  712. data/spec/models/template_content_item_spec.rb +42 -0
  713. data/spec/models/template_input_content_inner_spec.rb +42 -0
  714. data/spec/models/template_input_spec.rb +42 -0
  715. data/spec/models/template_spec.rb +48 -0
  716. data/spec/models/update_media_request_spec.rb +2 -2
  717. data/spec/models/upload_chunk201_response_spec.rb +2 -2
  718. data/spec/models/user_input_spec.rb +2 -2
  719. data/spec/models/user_spec.rb +2 -2
  720. data/spec/models/user_update_input_spec.rb +2 -2
  721. data/spec/models/webhook_event_name_spec.rb +30 -0
  722. data/spec/models/webhook_event_payload_spec.rb +42 -0
  723. data/spec/models/webhook_subscription_input_spec.rb +58 -0
  724. data/spec/models/webhook_subscription_spec.rb +66 -0
  725. data/spec/models/workspace_agent_input_spec.rb +68 -0
  726. data/spec/models/workspace_agent_settings_spec.rb +60 -0
  727. data/spec/models/workspace_agent_spec.rb +92 -0
  728. data/spec/models/workspace_agent_update_spec.rb +58 -0
  729. data/spec/models/workspace_input_spec.rb +2 -2
  730. data/spec/models/workspace_spec.rb +2 -2
  731. data/spec/models/workspace_user_input_spec.rb +2 -2
  732. data/spec/models/x_usage_counter_spec.rb +42 -0
  733. data/spec/models/x_usage_spec.rb +66 -0
  734. data/spec/spec_helper.rb +2 -2
  735. metadata +615 -4
@@ -1,9 +1,9 @@
1
1
  =begin
2
2
  #PostBoost API
3
3
 
4
- #The PostBoost REST API lets you publish, schedule, and analyze social media posts across 12+ platforms from a single integration. No OAuth apps to maintain — PostBoost handles platform authorization for you. ## Base URL All workspace-scoped endpoints are prefixed with `/{workspaceUuid}`. Panel/admin endpoints are prefixed with `/panel`. ## Plan access Every workspace-scoped endpoint returns `403` when the workspace's plan does not include API access (capability `api`). ## Dates and times Post dates and times (`date`, `time`, `accounts_schedule`) are read in the request's `timezone` when one is given, otherwise in the workspace timezone. ## Authentication All requests require a Bearer token in the `Authorization` header. Generate tokens in your PostBoost dashboard under **Settings → Access Tokens**. ``` Authorization: Bearer YOUR_API_TOKEN ```
4
+ #The PostBoost REST API lets you publish, schedule, and analyze social media posts across 12+ platforms from a single integration. No OAuth apps to maintain — PostBoost handles platform authorization for you. ## Base URL All workspace-scoped endpoints are prefixed with `/{workspaceUuid}`. Panel/admin endpoints are prefixed with `/panel`. ## Plan access Every workspace-scoped endpoint returns `403` when the workspace's plan does not include API access (capability `api`). ## Dates and times Post dates and times (`date`, `time`, `accounts_schedule`) are read in the request's `timezone` when one is given, otherwise in the workspace timezone. ## Idempotent requests Send an `Idempotency-Key` header (any unique string, for example a UUID) with a `POST`. Repeating the request with the same key within 24 hours returns the stored response with `Idempotent-Replayed: true` and creates nothing new. Reusing a key with a different body returns `422`; a request still in progress with the same key returns `409`. `5xx` and `429` responses are not stored, so they can be retried with the same key. ## Guardrails for automated clients Create and update requests are checked before anything is written: a post whose content matches one created for the same account in the last 24 hours returns `409` (`code: duplicate_post`, override with `allow_duplicate: true`), scheduling past an account's daily cap returns `429` (`code: account_daily_cap_reached`), and scheduling to an account that must be reconnected returns `422` (`code: account_unauthorized` or `account_token_missing`). Use `POST /{workspaceUuid}/posts/validate` for a dry run and `GET /{workspaceUuid}/activity` to review what API clients did. ## Authentication All requests require a Bearer token in the `Authorization` header. Generate tokens in your PostBoost dashboard under **Settings → Access Tokens**. ``` Authorization: Bearer YOUR_API_TOKEN ```
5
5
 
6
- The version of the OpenAPI document: 1.8.0
6
+ The version of the OpenAPI document: 1.14.0
7
7
  Contact: hi@postboost.co
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.9.0
@@ -169,6 +169,7 @@ module PostBoost
169
169
  # @param workspace_uuid [String] UUID of the workspace.
170
170
  # @param create_media_folder_request [CreateMediaFolderRequest]
171
171
  # @param [Hash] opts the optional parameters
172
+ # @option opts [String] :idempotency_key Unique key (for example a UUID) that makes the request safe to retry. A repeat with the same key and body within 24 hours returns the stored response with `Idempotent-Replayed: true` and has no further effect. Keys are scoped to your user, the workspace, the method and the path.
172
173
  # @return [MediaFolder]
173
174
  def create_media_folder(workspace_uuid, create_media_folder_request, opts = {})
174
175
  data, _status_code, _headers = create_media_folder_with_http_info(workspace_uuid, create_media_folder_request, opts)
@@ -180,6 +181,7 @@ module PostBoost
180
181
  # @param workspace_uuid [String] UUID of the workspace.
181
182
  # @param create_media_folder_request [CreateMediaFolderRequest]
182
183
  # @param [Hash] opts the optional parameters
184
+ # @option opts [String] :idempotency_key Unique key (for example a UUID) that makes the request safe to retry. A repeat with the same key and body within 24 hours returns the stored response with `Idempotent-Replayed: true` and has no further effect. Keys are scoped to your user, the workspace, the method and the path.
183
185
  # @return [Array<(MediaFolder, Integer, Hash)>] MediaFolder data, response status code and response headers
184
186
  def create_media_folder_with_http_info(workspace_uuid, create_media_folder_request, opts = {})
185
187
  if @api_client.config.debugging
@@ -193,6 +195,14 @@ module PostBoost
193
195
  if @api_client.config.client_side_validation && create_media_folder_request.nil?
194
196
  fail ArgumentError, "Missing the required parameter 'create_media_folder_request' when calling MediaApi.create_media_folder"
195
197
  end
198
+ if @api_client.config.client_side_validation && !opts[:'idempotency_key'].nil? && opts[:'idempotency_key'].to_s.length > 255
199
+ fail ArgumentError, 'invalid value for "opts[:"idempotency_key"]" when calling MediaApi.create_media_folder, the character length must be smaller than or equal to 255.'
200
+ end
201
+
202
+ if @api_client.config.client_side_validation && !opts[:'idempotency_key'].nil? && opts[:'idempotency_key'].to_s.length < 1
203
+ fail ArgumentError, 'invalid value for "opts[:"idempotency_key"]" when calling MediaApi.create_media_folder, the character length must be great than or equal to 1.'
204
+ end
205
+
196
206
  # resource path
197
207
  local_var_path = '/{workspaceUuid}/media/folders'.sub('{' + 'workspaceUuid' + '}', CGI.escape(workspace_uuid.to_s))
198
208
 
@@ -208,6 +218,7 @@ module PostBoost
208
218
  if !content_type.nil?
209
219
  header_params['Content-Type'] = content_type
210
220
  end
221
+ header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
211
222
 
212
223
  # form parameters
213
224
  form_params = opts[:form_params] || {}
@@ -531,6 +542,7 @@ module PostBoost
531
542
  # @param workspace_uuid [String] UUID of the workspace.
532
543
  # @param initiate_chunked_upload_request [InitiateChunkedUploadRequest]
533
544
  # @param [Hash] opts the optional parameters
545
+ # @option opts [String] :idempotency_key Unique key (for example a UUID) that makes the request safe to retry. A repeat with the same key and body within 24 hours returns the stored response with &#x60;Idempotent-Replayed: true&#x60; and has no further effect. Keys are scoped to your user, the workspace, the method and the path.
534
546
  # @return [InitiateChunkedUpload201Response]
535
547
  def initiate_chunked_upload(workspace_uuid, initiate_chunked_upload_request, opts = {})
536
548
  data, _status_code, _headers = initiate_chunked_upload_with_http_info(workspace_uuid, initiate_chunked_upload_request, opts)
@@ -542,6 +554,7 @@ module PostBoost
542
554
  # @param workspace_uuid [String] UUID of the workspace.
543
555
  # @param initiate_chunked_upload_request [InitiateChunkedUploadRequest]
544
556
  # @param [Hash] opts the optional parameters
557
+ # @option opts [String] :idempotency_key Unique key (for example a UUID) that makes the request safe to retry. A repeat with the same key and body within 24 hours returns the stored response with &#x60;Idempotent-Replayed: true&#x60; and has no further effect. Keys are scoped to your user, the workspace, the method and the path.
545
558
  # @return [Array<(InitiateChunkedUpload201Response, Integer, Hash)>] InitiateChunkedUpload201Response data, response status code and response headers
546
559
  def initiate_chunked_upload_with_http_info(workspace_uuid, initiate_chunked_upload_request, opts = {})
547
560
  if @api_client.config.debugging
@@ -555,6 +568,14 @@ module PostBoost
555
568
  if @api_client.config.client_side_validation && initiate_chunked_upload_request.nil?
556
569
  fail ArgumentError, "Missing the required parameter 'initiate_chunked_upload_request' when calling MediaApi.initiate_chunked_upload"
557
570
  end
571
+ if @api_client.config.client_side_validation && !opts[:'idempotency_key'].nil? && opts[:'idempotency_key'].to_s.length > 255
572
+ fail ArgumentError, 'invalid value for "opts[:"idempotency_key"]" when calling MediaApi.initiate_chunked_upload, the character length must be smaller than or equal to 255.'
573
+ end
574
+
575
+ if @api_client.config.client_side_validation && !opts[:'idempotency_key'].nil? && opts[:'idempotency_key'].to_s.length < 1
576
+ fail ArgumentError, 'invalid value for "opts[:"idempotency_key"]" when calling MediaApi.initiate_chunked_upload, the character length must be great than or equal to 1.'
577
+ end
578
+
558
579
  # resource path
559
580
  local_var_path = '/{workspaceUuid}/media/chunked/initiate'.sub('{' + 'workspaceUuid' + '}', CGI.escape(workspace_uuid.to_s))
560
581
 
@@ -570,6 +591,7 @@ module PostBoost
570
591
  if !content_type.nil?
571
592
  header_params['Content-Type'] = content_type
572
593
  end
594
+ header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
573
595
 
574
596
  # form parameters
575
597
  form_params = opts[:form_params] || {}
@@ -605,6 +627,7 @@ module PostBoost
605
627
  # @param workspace_uuid [String] UUID of the workspace.
606
628
  # @param initiate_remote_upload_request [InitiateRemoteUploadRequest]
607
629
  # @param [Hash] opts the optional parameters
630
+ # @option opts [String] :idempotency_key Unique key (for example a UUID) that makes the request safe to retry. A repeat with the same key and body within 24 hours returns the stored response with &#x60;Idempotent-Replayed: true&#x60; and has no further effect. Keys are scoped to your user, the workspace, the method and the path.
608
631
  # @return [InitiateRemoteUpload201Response]
609
632
  def initiate_remote_upload(workspace_uuid, initiate_remote_upload_request, opts = {})
610
633
  data, _status_code, _headers = initiate_remote_upload_with_http_info(workspace_uuid, initiate_remote_upload_request, opts)
@@ -616,6 +639,7 @@ module PostBoost
616
639
  # @param workspace_uuid [String] UUID of the workspace.
617
640
  # @param initiate_remote_upload_request [InitiateRemoteUploadRequest]
618
641
  # @param [Hash] opts the optional parameters
642
+ # @option opts [String] :idempotency_key Unique key (for example a UUID) that makes the request safe to retry. A repeat with the same key and body within 24 hours returns the stored response with &#x60;Idempotent-Replayed: true&#x60; and has no further effect. Keys are scoped to your user, the workspace, the method and the path.
619
643
  # @return [Array<(InitiateRemoteUpload201Response, Integer, Hash)>] InitiateRemoteUpload201Response data, response status code and response headers
620
644
  def initiate_remote_upload_with_http_info(workspace_uuid, initiate_remote_upload_request, opts = {})
621
645
  if @api_client.config.debugging
@@ -629,6 +653,14 @@ module PostBoost
629
653
  if @api_client.config.client_side_validation && initiate_remote_upload_request.nil?
630
654
  fail ArgumentError, "Missing the required parameter 'initiate_remote_upload_request' when calling MediaApi.initiate_remote_upload"
631
655
  end
656
+ if @api_client.config.client_side_validation && !opts[:'idempotency_key'].nil? && opts[:'idempotency_key'].to_s.length > 255
657
+ fail ArgumentError, 'invalid value for "opts[:"idempotency_key"]" when calling MediaApi.initiate_remote_upload, the character length must be smaller than or equal to 255.'
658
+ end
659
+
660
+ if @api_client.config.client_side_validation && !opts[:'idempotency_key'].nil? && opts[:'idempotency_key'].to_s.length < 1
661
+ fail ArgumentError, 'invalid value for "opts[:"idempotency_key"]" when calling MediaApi.initiate_remote_upload, the character length must be great than or equal to 1.'
662
+ end
663
+
632
664
  # resource path
633
665
  local_var_path = '/{workspaceUuid}/media/remote/initiate'.sub('{' + 'workspaceUuid' + '}', CGI.escape(workspace_uuid.to_s))
634
666
 
@@ -644,6 +676,7 @@ module PostBoost
644
676
  if !content_type.nil?
645
677
  header_params['Content-Type'] = content_type
646
678
  end
679
+ header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
647
680
 
648
681
  # form parameters
649
682
  form_params = opts[:form_params] || {}
@@ -1092,10 +1125,11 @@ module PostBoost
1092
1125
  end
1093
1126
 
1094
1127
  # Upload media (binary)
1095
- # Upload a file directly as multipart form data.
1128
+ # Upload a file directly as multipart form data. Images and videos, plus a PDF (up to 100 MB) for LinkedIn document posts: a post that attaches a PDF must have it as the only media item and may only go to LinkedIn profiles and pages.
1096
1129
  # @param workspace_uuid [String] UUID of the workspace.
1097
1130
  # @param file [File] The file to upload.
1098
1131
  # @param [Hash] opts the optional parameters
1132
+ # @option opts [String] :idempotency_key Unique key (for example a UUID) that makes the request safe to retry. A repeat with the same key and body within 24 hours returns the stored response with &#x60;Idempotent-Replayed: true&#x60; and has no further effect. Keys are scoped to your user, the workspace, the method and the path.
1099
1133
  # @option opts [String] :alt_text Alternative text for accessibility.
1100
1134
  # @option opts [String] :folder UUID of the media folder to file the upload in. Omit or null for the library root.
1101
1135
  # @return [Media]
@@ -1105,10 +1139,11 @@ module PostBoost
1105
1139
  end
1106
1140
 
1107
1141
  # Upload media (binary)
1108
- # Upload a file directly as multipart form data.
1142
+ # Upload a file directly as multipart form data. Images and videos, plus a PDF (up to 100 MB) for LinkedIn document posts: a post that attaches a PDF must have it as the only media item and may only go to LinkedIn profiles and pages.
1109
1143
  # @param workspace_uuid [String] UUID of the workspace.
1110
1144
  # @param file [File] The file to upload.
1111
1145
  # @param [Hash] opts the optional parameters
1146
+ # @option opts [String] :idempotency_key Unique key (for example a UUID) that makes the request safe to retry. A repeat with the same key and body within 24 hours returns the stored response with &#x60;Idempotent-Replayed: true&#x60; and has no further effect. Keys are scoped to your user, the workspace, the method and the path.
1112
1147
  # @option opts [String] :alt_text Alternative text for accessibility.
1113
1148
  # @option opts [String] :folder UUID of the media folder to file the upload in. Omit or null for the library root.
1114
1149
  # @return [Array<(Media, Integer, Hash)>] Media data, response status code and response headers
@@ -1124,6 +1159,14 @@ module PostBoost
1124
1159
  if @api_client.config.client_side_validation && file.nil?
1125
1160
  fail ArgumentError, "Missing the required parameter 'file' when calling MediaApi.upload_media"
1126
1161
  end
1162
+ if @api_client.config.client_side_validation && !opts[:'idempotency_key'].nil? && opts[:'idempotency_key'].to_s.length > 255
1163
+ fail ArgumentError, 'invalid value for "opts[:"idempotency_key"]" when calling MediaApi.upload_media, the character length must be smaller than or equal to 255.'
1164
+ end
1165
+
1166
+ if @api_client.config.client_side_validation && !opts[:'idempotency_key'].nil? && opts[:'idempotency_key'].to_s.length < 1
1167
+ fail ArgumentError, 'invalid value for "opts[:"idempotency_key"]" when calling MediaApi.upload_media, the character length must be great than or equal to 1.'
1168
+ end
1169
+
1127
1170
  if @api_client.config.client_side_validation && !opts[:'alt_text'].nil? && opts[:'alt_text'].to_s.length > 255
1128
1171
  fail ArgumentError, 'invalid value for "opts[:"alt_text"]" when calling MediaApi.upload_media, the character length must be smaller than or equal to 255.'
1129
1172
  end
@@ -1143,6 +1186,7 @@ module PostBoost
1143
1186
  if !content_type.nil?
1144
1187
  header_params['Content-Type'] = content_type
1145
1188
  end
1189
+ header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
1146
1190
 
1147
1191
  # form parameters
1148
1192
  form_params = opts[:form_params] || {}
@@ -1175,5 +1219,90 @@ module PostBoost
1175
1219
  end
1176
1220
  return data, status_code, headers
1177
1221
  end
1222
+
1223
+ # Upload media (base64 JSON)
1224
+ # Upload a file as base64 inside a JSON body, for agents and tools that cannot send multipart form data. The decoded file is checked exactly like `POST media` (allowed types and size limits; a PDF is accepted for LinkedIn document posts). Decoded size is capped at 20 MB; for larger files use remote upload by URL or chunked upload.
1225
+ # @param workspace_uuid [String] UUID of the workspace.
1226
+ # @param media_base64_input [MediaBase64Input]
1227
+ # @param [Hash] opts the optional parameters
1228
+ # @option opts [String] :idempotency_key Unique key (for example a UUID) that makes the request safe to retry. A repeat with the same key and body within 24 hours returns the stored response with &#x60;Idempotent-Replayed: true&#x60; and has no further effect. Keys are scoped to your user, the workspace, the method and the path.
1229
+ # @return [Media]
1230
+ def upload_media_base64(workspace_uuid, media_base64_input, opts = {})
1231
+ data, _status_code, _headers = upload_media_base64_with_http_info(workspace_uuid, media_base64_input, opts)
1232
+ data
1233
+ end
1234
+
1235
+ # Upload media (base64 JSON)
1236
+ # Upload a file as base64 inside a JSON body, for agents and tools that cannot send multipart form data. The decoded file is checked exactly like &#x60;POST media&#x60; (allowed types and size limits; a PDF is accepted for LinkedIn document posts). Decoded size is capped at 20 MB; for larger files use remote upload by URL or chunked upload.
1237
+ # @param workspace_uuid [String] UUID of the workspace.
1238
+ # @param media_base64_input [MediaBase64Input]
1239
+ # @param [Hash] opts the optional parameters
1240
+ # @option opts [String] :idempotency_key Unique key (for example a UUID) that makes the request safe to retry. A repeat with the same key and body within 24 hours returns the stored response with &#x60;Idempotent-Replayed: true&#x60; and has no further effect. Keys are scoped to your user, the workspace, the method and the path.
1241
+ # @return [Array<(Media, Integer, Hash)>] Media data, response status code and response headers
1242
+ def upload_media_base64_with_http_info(workspace_uuid, media_base64_input, opts = {})
1243
+ if @api_client.config.debugging
1244
+ @api_client.config.logger.debug 'Calling API: MediaApi.upload_media_base64 ...'
1245
+ end
1246
+ # verify the required parameter 'workspace_uuid' is set
1247
+ if @api_client.config.client_side_validation && workspace_uuid.nil?
1248
+ fail ArgumentError, "Missing the required parameter 'workspace_uuid' when calling MediaApi.upload_media_base64"
1249
+ end
1250
+ # verify the required parameter 'media_base64_input' is set
1251
+ if @api_client.config.client_side_validation && media_base64_input.nil?
1252
+ fail ArgumentError, "Missing the required parameter 'media_base64_input' when calling MediaApi.upload_media_base64"
1253
+ end
1254
+ if @api_client.config.client_side_validation && !opts[:'idempotency_key'].nil? && opts[:'idempotency_key'].to_s.length > 255
1255
+ fail ArgumentError, 'invalid value for "opts[:"idempotency_key"]" when calling MediaApi.upload_media_base64, the character length must be smaller than or equal to 255.'
1256
+ end
1257
+
1258
+ if @api_client.config.client_side_validation && !opts[:'idempotency_key'].nil? && opts[:'idempotency_key'].to_s.length < 1
1259
+ fail ArgumentError, 'invalid value for "opts[:"idempotency_key"]" when calling MediaApi.upload_media_base64, the character length must be great than or equal to 1.'
1260
+ end
1261
+
1262
+ # resource path
1263
+ local_var_path = '/{workspaceUuid}/media/base64'.sub('{' + 'workspaceUuid' + '}', CGI.escape(workspace_uuid.to_s))
1264
+
1265
+ # query parameters
1266
+ query_params = opts[:query_params] || {}
1267
+
1268
+ # header parameters
1269
+ header_params = opts[:header_params] || {}
1270
+ # HTTP header 'Accept' (if needed)
1271
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
1272
+ # HTTP header 'Content-Type'
1273
+ content_type = @api_client.select_header_content_type(['application/json'])
1274
+ if !content_type.nil?
1275
+ header_params['Content-Type'] = content_type
1276
+ end
1277
+ header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
1278
+
1279
+ # form parameters
1280
+ form_params = opts[:form_params] || {}
1281
+
1282
+ # http body (model)
1283
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(media_base64_input)
1284
+
1285
+ # return_type
1286
+ return_type = opts[:debug_return_type] || 'Media'
1287
+
1288
+ # auth_names
1289
+ auth_names = opts[:debug_auth_names] || ['bearerAuth']
1290
+
1291
+ new_options = opts.merge(
1292
+ :operation => :"MediaApi.upload_media_base64",
1293
+ :header_params => header_params,
1294
+ :query_params => query_params,
1295
+ :form_params => form_params,
1296
+ :body => post_body,
1297
+ :auth_names => auth_names,
1298
+ :return_type => return_type
1299
+ )
1300
+
1301
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
1302
+ if @api_client.config.debugging
1303
+ @api_client.config.logger.debug "API called: MediaApi#upload_media_base64\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1304
+ end
1305
+ return data, status_code, headers
1306
+ end
1178
1307
  end
1179
1308
  end
@@ -1,9 +1,9 @@
1
1
  =begin
2
2
  #PostBoost API
3
3
 
4
- #The PostBoost REST API lets you publish, schedule, and analyze social media posts across 12+ platforms from a single integration. No OAuth apps to maintain — PostBoost handles platform authorization for you. ## Base URL All workspace-scoped endpoints are prefixed with `/{workspaceUuid}`. Panel/admin endpoints are prefixed with `/panel`. ## Plan access Every workspace-scoped endpoint returns `403` when the workspace's plan does not include API access (capability `api`). ## Dates and times Post dates and times (`date`, `time`, `accounts_schedule`) are read in the request's `timezone` when one is given, otherwise in the workspace timezone. ## Authentication All requests require a Bearer token in the `Authorization` header. Generate tokens in your PostBoost dashboard under **Settings → Access Tokens**. ``` Authorization: Bearer YOUR_API_TOKEN ```
4
+ #The PostBoost REST API lets you publish, schedule, and analyze social media posts across 12+ platforms from a single integration. No OAuth apps to maintain — PostBoost handles platform authorization for you. ## Base URL All workspace-scoped endpoints are prefixed with `/{workspaceUuid}`. Panel/admin endpoints are prefixed with `/panel`. ## Plan access Every workspace-scoped endpoint returns `403` when the workspace's plan does not include API access (capability `api`). ## Dates and times Post dates and times (`date`, `time`, `accounts_schedule`) are read in the request's `timezone` when one is given, otherwise in the workspace timezone. ## Idempotent requests Send an `Idempotency-Key` header (any unique string, for example a UUID) with a `POST`. Repeating the request with the same key within 24 hours returns the stored response with `Idempotent-Replayed: true` and creates nothing new. Reusing a key with a different body returns `422`; a request still in progress with the same key returns `409`. `5xx` and `429` responses are not stored, so they can be retried with the same key. ## Guardrails for automated clients Create and update requests are checked before anything is written: a post whose content matches one created for the same account in the last 24 hours returns `409` (`code: duplicate_post`, override with `allow_duplicate: true`), scheduling past an account's daily cap returns `429` (`code: account_daily_cap_reached`), and scheduling to an account that must be reconnected returns `422` (`code: account_unauthorized` or `account_token_missing`). Use `POST /{workspaceUuid}/posts/validate` for a dry run and `GET /{workspaceUuid}/activity` to review what API clients did. ## Authentication All requests require a Bearer token in the `Authorization` header. Generate tokens in your PostBoost dashboard under **Settings → Access Tokens**. ``` Authorization: Bearer YOUR_API_TOKEN ```
5
5
 
6
- The version of the OpenAPI document: 1.8.0
6
+ The version of the OpenAPI document: 1.14.0
7
7
  Contact: hi@postboost.co
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.9.0
@@ -24,6 +24,7 @@ module PostBoost
24
24
  # @param workspace_uuid [String] UUID of the workspace.
25
25
  # @param mention_input [MentionInput]
26
26
  # @param [Hash] opts the optional parameters
27
+ # @option opts [String] :idempotency_key Unique key (for example a UUID) that makes the request safe to retry. A repeat with the same key and body within 24 hours returns the stored response with &#x60;Idempotent-Replayed: true&#x60; and has no further effect. Keys are scoped to your user, the workspace, the method and the path.
27
28
  # @return [CreateMention201Response]
28
29
  def create_mention(workspace_uuid, mention_input, opts = {})
29
30
  data, _status_code, _headers = create_mention_with_http_info(workspace_uuid, mention_input, opts)
@@ -35,6 +36,7 @@ module PostBoost
35
36
  # @param workspace_uuid [String] UUID of the workspace.
36
37
  # @param mention_input [MentionInput]
37
38
  # @param [Hash] opts the optional parameters
39
+ # @option opts [String] :idempotency_key Unique key (for example a UUID) that makes the request safe to retry. A repeat with the same key and body within 24 hours returns the stored response with &#x60;Idempotent-Replayed: true&#x60; and has no further effect. Keys are scoped to your user, the workspace, the method and the path.
38
40
  # @return [Array<(CreateMention201Response, Integer, Hash)>] CreateMention201Response data, response status code and response headers
39
41
  def create_mention_with_http_info(workspace_uuid, mention_input, opts = {})
40
42
  if @api_client.config.debugging
@@ -48,6 +50,14 @@ module PostBoost
48
50
  if @api_client.config.client_side_validation && mention_input.nil?
49
51
  fail ArgumentError, "Missing the required parameter 'mention_input' when calling MentionsApi.create_mention"
50
52
  end
53
+ if @api_client.config.client_side_validation && !opts[:'idempotency_key'].nil? && opts[:'idempotency_key'].to_s.length > 255
54
+ fail ArgumentError, 'invalid value for "opts[:"idempotency_key"]" when calling MentionsApi.create_mention, the character length must be smaller than or equal to 255.'
55
+ end
56
+
57
+ if @api_client.config.client_side_validation && !opts[:'idempotency_key'].nil? && opts[:'idempotency_key'].to_s.length < 1
58
+ fail ArgumentError, 'invalid value for "opts[:"idempotency_key"]" when calling MentionsApi.create_mention, the character length must be great than or equal to 1.'
59
+ end
60
+
51
61
  # resource path
52
62
  local_var_path = '/{workspaceUuid}/mentions'.sub('{' + 'workspaceUuid' + '}', CGI.escape(workspace_uuid.to_s))
53
63
 
@@ -63,6 +73,7 @@ module PostBoost
63
73
  if !content_type.nil?
64
74
  header_params['Content-Type'] = content_type
65
75
  end
76
+ header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
66
77
 
67
78
  # form parameters
68
79
  form_params = opts[:form_params] || {}