postboost 1.20.0 → 1.22.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.
- package/README.md +1 -1
- package/api/aIApi.ts +1 -1
- package/api/accountGroupsApi.ts +1 -1
- package/api/accountsApi.ts +1 -1
- package/api/activityApi.ts +1 -1
- package/api/agentsApi.ts +4 -4
- package/api/analyticsApi.ts +1 -1
- package/api/apis.ts +3 -1
- package/api/competitorsApi.ts +1 -1
- package/api/freeToolsApi.ts +584 -0
- package/api/hashtagGroupsApi.ts +1 -1
- package/api/inboxApi.ts +1 -1
- package/api/mediaApi.ts +1 -1
- package/api/mentionsApi.ts +1 -1
- package/api/postingScheduleApi.ts +1 -1
- package/api/postsApi.ts +1 -1
- package/api/receiptsApi.ts +1 -1
- package/api/subscriptionsApi.ts +1 -1
- package/api/tagsApi.ts +1 -1
- package/api/templatesApi.ts +1 -1
- package/api/usersApi.ts +1 -1
- package/api/webhooksApi.ts +1 -1
- package/api/workspacesApi.ts +1 -1
- package/model/aICredits.ts +1 -1
- package/model/aIUsage.ts +1 -1
- package/model/aIUsageText.ts +1 -1
- package/model/account.ts +1 -1
- package/model/accountAnalytics.ts +1 -1
- package/model/accountAnalyticsInitialSync.ts +1 -1
- package/model/accountConnectionHealth.ts +1 -1
- package/model/accountErrorsInner.ts +1 -1
- package/model/accountErrorsInnerOneOf.ts +1 -1
- package/model/accountGroup.ts +1 -1
- package/model/accountGroupInput.ts +1 -1
- package/model/accountHealth.ts +1 -1
- package/model/accountHealthDailyCap.ts +1 -1
- package/model/accountSchedule.ts +1 -1
- package/model/addCompetitor202Response.ts +1 -1
- package/model/addCompetitor409Response.ts +1 -1
- package/model/addGenericSubscriptionRequest.ts +1 -1
- package/model/addPostToQueueRequest.ts +1 -1
- package/model/agentPageMeta.ts +1 -1
- package/model/agentProposal.ts +6 -4
- package/model/agentProposalDecision.ts +1 -1
- package/model/agentRun.ts +1 -1
- package/model/analyticsPeriod.ts +1 -1
- package/model/analyticsSummary.ts +1 -1
- package/model/analyticsSummaryData.ts +1 -1
- package/model/apiActivity.ts +1 -1
- package/model/apiActivityOutcome.ts +1 -1
- package/model/apiKey.ts +1 -1
- package/model/apiKeyAbility.ts +1 -1
- package/model/apiKeyInput.ts +1 -1
- package/model/approveAgentProposal200Response.ts +1 -1
- package/model/approveAgentProposal409Response.ts +1 -1
- package/model/approveInboxReplyDraft403Response.ts +1 -1
- package/model/approvePostRequest.ts +1 -1
- package/model/bestPostingTimes.ts +1 -1
- package/model/bestPostingTimesTimesInner.ts +1 -1
- package/model/blogToSocial200Response.ts +1 -1
- package/model/blogToSocial429Response.ts +1 -1
- package/model/blogToSocialCaption.ts +1 -1
- package/model/blogToSocialInput.ts +1 -1
- package/model/blogToSocialMedia.ts +1 -1
- package/model/blogToSocialResponse.ts +1 -1
- package/model/brandVoice.ts +1 -1
- package/model/brandVoiceInput.ts +1 -1
- package/model/brandVoiceMeta.ts +1 -1
- package/model/cancelSubscription422Response.ts +1 -1
- package/model/cancelSubscription422ResponseErrors.ts +1 -1
- package/model/cancelSubscriptionRequest.ts +1 -1
- package/model/changeSubscriptionPlanRequest.ts +1 -1
- package/model/channelAccount.ts +1 -1
- package/model/checkoutSubscription200Response.ts +1 -1
- package/model/checkoutSubscriptionRequest.ts +1 -1
- package/model/codedError.ts +1 -1
- package/model/competitor.ts +1 -1
- package/model/competitorDetail.ts +1 -1
- package/model/competitorInput.ts +1 -1
- package/model/competitorMedia.ts +1 -1
- package/model/competitorSnapshot.ts +1 -1
- package/model/completeChunkedUploadRequest.ts +1 -1
- package/model/connectChannelInput.ts +1 -1
- package/model/createAccountGroup201Response.ts +1 -1
- package/model/createAgent201Response.ts +1 -1
- package/model/createApiKey201Response.ts +1 -1
- package/model/createApiKey201ResponseData.ts +1 -1
- package/model/createHashtagGroup201Response.ts +1 -1
- package/model/createInboxReplyDraft201Response.ts +1 -1
- package/model/createMediaFolderRequest.ts +1 -1
- package/model/createMention201Response.ts +1 -1
- package/model/createPost201Response.ts +1 -1
- package/model/createRecyclingRule201Response.ts +1 -1
- package/model/createReportExport201Response.ts +1 -1
- package/model/createResellerClient201Response.ts +1 -1
- package/model/createRssFeed201Response.ts +1 -1
- package/model/createTemplate201Response.ts +1 -1
- package/model/createWebhookSubscription201Response.ts +1 -1
- package/model/createWebhookSubscription201ResponseData.ts +1 -1
- package/model/deleteAgent200Response.ts +1 -1
- package/model/deleteMediaBulkRequest.ts +1 -1
- package/model/deleteMediaBulkRequestItemsInner.ts +1 -1
- package/model/deleteMediaFolderRequest.ts +1 -1
- package/model/deleteMode.ts +1 -1
- package/model/deletePostRequest.ts +1 -1
- package/model/deletePostsBulkRequest.ts +1 -1
- package/model/deleteReceiptsBulkRequest.ts +1 -1
- package/model/deleteResult.ts +1 -1
- package/model/deleteUser400Response.ts +1 -1
- package/model/deleteUsersBulkRequest.ts +1 -1
- package/model/deleteWorkspacesBulkRequest.ts +1 -1
- package/model/freeToolBuildUtmUrlRequest.ts +70 -0
- package/model/freeToolBuildUtmUrlResponse.ts +40 -0
- package/model/freeToolCalculateEngagementRateRequest.ts +89 -0
- package/model/freeToolCalculateEngagementRateResponse.ts +52 -0
- package/model/freeToolCountCharactersRequest.ts +59 -0
- package/model/freeToolCountCharactersResponse.ts +41 -0
- package/model/freeToolCountCharactersResponseNetworksInner.ts +61 -0
- package/model/freeToolError.ts +31 -0
- package/model/freeToolFormatLinkedInPostRequest.ts +72 -0
- package/model/freeToolFormatLinkedInPostResponse.ts +58 -0
- package/model/freeToolGenerateFancyTextRequest.ts +59 -0
- package/model/freeToolGenerateFancyTextResponse.ts +32 -0
- package/model/freeToolGenerateFancyTextResponseStylesInner.ts +46 -0
- package/model/freeToolList.ts +32 -0
- package/model/freeToolListItem.ts +78 -0
- package/model/freeToolSplitThreadRequest.ts +57 -0
- package/model/freeToolSplitThreadResponse.ts +38 -0
- package/model/freeToolSplitThreadResponsePostsInner.ts +40 -0
- package/model/getAccountHealth200Response.ts +1 -1
- package/model/getBrandVoice200Response.ts +1 -1
- package/model/getCompetitor200Response.ts +1 -1
- package/model/getInboxConversation200Response.ts +1 -1
- package/model/getPostingSchedule200Response.ts +1 -1
- package/model/getRemoteUploadStatus200Response.ts +1 -1
- package/model/getReportBranding200Response.ts +1 -1
- package/model/getRepurposeRun200Response.ts +1 -1
- package/model/guardrailError.ts +1 -1
- package/model/hashtagGroup.ts +1 -1
- package/model/hashtagGroupInput.ts +1 -1
- package/model/imageAltText200Response.ts +1 -1
- package/model/imageAltTextInput.ts +1 -1
- package/model/imageAltTextResponse.ts +1 -1
- package/model/imageCreditBalance.ts +1 -1
- package/model/imageEditInput.ts +1 -1
- package/model/imageGenerate200Response.ts +1 -1
- package/model/imageGenerate429Response.ts +1 -1
- package/model/imageGenerateInput.ts +1 -1
- package/model/imageGenerationResponse.ts +1 -1
- package/model/imagePrompt200Response.ts +1 -1
- package/model/imagePrompt429Response.ts +1 -1
- package/model/imagePromptInput.ts +1 -1
- package/model/imagePromptResponse.ts +1 -1
- package/model/imageVariations200Response.ts +1 -1
- package/model/imageVariationsInput.ts +1 -1
- package/model/imageVariationsResponse.ts +1 -1
- package/model/inboxAuthor.ts +1 -1
- package/model/inboxConversation.ts +1 -1
- package/model/inboxConversationAccount.ts +1 -1
- package/model/inboxConversationUpdate.ts +1 -1
- package/model/inboxMessage.ts +1 -1
- package/model/inboxMessageAuthor.ts +1 -1
- package/model/inboxReplyDraft.ts +1 -1
- package/model/inboxReplyDraftApprove.ts +1 -1
- package/model/inboxReplyDraftEdit.ts +1 -1
- package/model/inboxReplyDraftInput.ts +1 -1
- package/model/initiateChunkedUpload201Response.ts +1 -1
- package/model/initiateChunkedUploadRequest.ts +1 -1
- package/model/initiateRemoteUpload201Response.ts +1 -1
- package/model/initiateRemoteUpload201ResponseOneOf.ts +1 -1
- package/model/initiateRemoteUploadRequest.ts +1 -1
- package/model/learnBrandVoiceInput.ts +1 -1
- package/model/learnBrandVoiceResponse.ts +1 -1
- package/model/learnBrandVoiceResponseMeta.ts +1 -1
- package/model/listAccountGroups200Response.ts +1 -1
- package/model/listAccounts200Response.ts +1 -1
- package/model/listAgentProposals200Response.ts +1 -1
- package/model/listAgentRuns200Response.ts +1 -1
- package/model/listAgents200Response.ts +1 -1
- package/model/listApiActivity200Response.ts +1 -1
- package/model/listApiKeys200Response.ts +1 -1
- package/model/listCompetitors200Response.ts +1 -1
- package/model/listHashtagGroups200Response.ts +1 -1
- package/model/listInboxConversations200Response.ts +1 -1
- package/model/listInboxReplyDrafts200Response.ts +1 -1
- package/model/listMedia200Response.ts +1 -1
- package/model/listMediaFolders200Response.ts +1 -1
- package/model/listMentions200Response.ts +1 -1
- package/model/listMyWorkspaces200Response.ts +1 -1
- package/model/listPosts200Response.ts +1 -1
- package/model/listReceipts200Response.ts +1 -1
- package/model/listRecyclingRules200Response.ts +1 -1
- package/model/listRecyclingRuns200Response.ts +1 -1
- package/model/listReportExports200Response.ts +1 -1
- package/model/listResellerClients200Response.ts +1 -1
- package/model/listRssFeeds200Response.ts +1 -1
- package/model/listTags200Response.ts +1 -1
- package/model/listTemplates200Response.ts +1 -1
- package/model/listUsers200Response.ts +1 -1
- package/model/listWebhookSubscriptions200Response.ts +1 -1
- package/model/listWorkspaces200Response.ts +1 -1
- package/model/media.ts +1 -1
- package/model/mediaBase64Input.ts +1 -1
- package/model/mediaFolder.ts +1 -1
- package/model/mediaFolderInput.ts +1 -1
- package/model/mediaFolderRef.ts +1 -1
- package/model/mention.ts +1 -1
- package/model/mentionIdentity.ts +1 -1
- package/model/mentionIdentityInput.ts +1 -1
- package/model/mentionInput.ts +1 -1
- package/model/messageOnly.ts +1 -1
- package/model/models.ts +61 -0
- package/model/paginationMeta.ts +1 -1
- package/model/paginationMetaLinks.ts +1 -1
- package/model/paginationMetaMeta.ts +1 -1
- package/model/pollRssFeed200Response.ts +1 -1
- package/model/post.ts +1 -1
- package/model/postAnalytics.ts +1 -1
- package/model/postContent.ts +1 -1
- package/model/postInput.ts +1 -1
- package/model/postOptionsInstagram.ts +1 -1
- package/model/postOptionsTikTok.ts +1 -1
- package/model/postOptionsYoutube.ts +1 -1
- package/model/postStatus.ts +1 -1
- package/model/postVersion.ts +1 -1
- package/model/postVersionOptions.ts +1 -1
- package/model/postWarning.ts +1 -1
- package/model/postWarnings.ts +1 -1
- package/model/postingSchedule.ts +1 -1
- package/model/postingScheduleDay.ts +1 -1
- package/model/postingScheduleDayTimesInner.ts +1 -1
- package/model/postingScheduleInput.ts +1 -1
- package/model/postingTimeSlot.ts +1 -1
- package/model/postingTimes.ts +1 -1
- package/model/postingTimesBestInner.ts +1 -1
- package/model/postingTimesDayIntervalsInnerInner.ts +1 -1
- package/model/postingTimesDaysInner.ts +1 -1
- package/model/preflightResult.ts +1 -1
- package/model/publicWorkspace.ts +1 -1
- package/model/publicWorkspacePivot.ts +1 -1
- package/model/publishProgress.ts +1 -1
- package/model/queueSlots.ts +1 -1
- package/model/receipt.ts +1 -1
- package/model/receiptInput.ts +1 -1
- package/model/receiptUpdateInput.ts +1 -1
- package/model/recommendedPostingTimes.ts +1 -1
- package/model/reconnectLink.ts +1 -1
- package/model/recyclingRule.ts +1 -1
- package/model/recyclingRuleInput.ts +1 -1
- package/model/recyclingRuleSettings.ts +1 -1
- package/model/recyclingRuleUpdate.ts +1 -1
- package/model/recyclingRun.ts +1 -1
- package/model/removeGenericSubscription422Response.ts +1 -1
- package/model/removeUserFromWorkspaceRequest.ts +1 -1
- package/model/reportBranding.ts +1 -1
- package/model/reportBrandingInput.ts +1 -1
- package/model/reportExport.ts +1 -1
- package/model/reportExportInput.ts +1 -1
- package/model/repurposeContent200Response.ts +1 -1
- package/model/repurposeContent202Response.ts +1 -1
- package/model/repurposeContent500Response.ts +1 -1
- package/model/repurposeInput.ts +1 -1
- package/model/repurposeInputTheme.ts +1 -1
- package/model/repurposeResult.ts +1 -1
- package/model/repurposeResultMedia.ts +1 -1
- package/model/repurposeResultSource.ts +1 -1
- package/model/repurposeRun.ts +1 -1
- package/model/repurposeRunAccepted.ts +1 -1
- package/model/repurposeSlide.ts +1 -1
- package/model/resellerClient.ts +1 -1
- package/model/resellerClientInput.ts +1 -1
- package/model/resellerClientUsage.ts +1 -1
- package/model/retryPostAccountResult.ts +1 -1
- package/model/rssFeed.ts +1 -1
- package/model/rssFeedInput.ts +1 -1
- package/model/rssFeedUpdate.ts +1 -1
- package/model/runAgent202Response.ts +1 -1
- package/model/schedulePostRequest.ts +1 -1
- package/model/scheduleResult.ts +1 -1
- package/model/subscription.ts +1 -1
- package/model/subscriptionInput.ts +1 -1
- package/model/subscriptionStatus.ts +1 -1
- package/model/subscriptionUpdateInput.ts +1 -1
- package/model/tag.ts +1 -1
- package/model/tagInput.ts +1 -1
- package/model/template.ts +1 -1
- package/model/templateContentItem.ts +1 -1
- package/model/templateInput.ts +1 -1
- package/model/templateInputContentInner.ts +1 -1
- package/model/updateMediaRequest.ts +1 -1
- package/model/updatePost200Response.ts +1 -1
- package/model/uploadChunk201Response.ts +1 -1
- package/model/user.ts +1 -1
- package/model/userInput.ts +1 -1
- package/model/userUpdateInput.ts +1 -1
- package/model/webhookEventName.ts +1 -1
- package/model/webhookEventPayload.ts +1 -1
- package/model/webhookSubscription.ts +1 -1
- package/model/webhookSubscriptionInput.ts +1 -1
- package/model/workspace.ts +1 -1
- package/model/workspaceAgent.ts +3 -2
- package/model/workspaceAgentInput.ts +3 -2
- package/model/workspaceAgentSettings.ts +11 -2
- package/model/workspaceAgentUpdate.ts +1 -1
- package/model/workspaceInput.ts +1 -1
- package/model/workspaceUserInput.ts +1 -1
- package/model/xUsage.ts +1 -1
- package/model/xUsageCounter.ts +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -13,7 +13,7 @@ npm install postboost
|
|
|
13
13
|
| **npm** | [npmjs.com/package/postboost](https://www.npmjs.com/package/postboost) |
|
|
14
14
|
| **GitHub** | [postboost-co/postboost-node](https://github.com/postboost-co/postboost-node) |
|
|
15
15
|
| **Docs** | [postboost.co/docs/api](https://postboost.co/docs/api) |
|
|
16
|
-
| **Version** | v1.
|
|
16
|
+
| **Version** | v1.22.0 |
|
|
17
17
|
|
|
18
18
|
## Quick start
|
|
19
19
|
|
package/api/aIApi.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* PostBoost API
|
|
3
3
|
* 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 ```
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.
|
|
5
|
+
* The version of the OpenAPI document: 1.22.0
|
|
6
6
|
* Contact: hi@postboost.co
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/api/accountGroupsApi.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* PostBoost API
|
|
3
3
|
* 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 ```
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.
|
|
5
|
+
* The version of the OpenAPI document: 1.22.0
|
|
6
6
|
* Contact: hi@postboost.co
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/api/accountsApi.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* PostBoost API
|
|
3
3
|
* 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 ```
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.
|
|
5
|
+
* The version of the OpenAPI document: 1.22.0
|
|
6
6
|
* Contact: hi@postboost.co
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/api/activityApi.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* PostBoost API
|
|
3
3
|
* 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 ```
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.
|
|
5
|
+
* The version of the OpenAPI document: 1.22.0
|
|
6
6
|
* Contact: hi@postboost.co
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/api/agentsApi.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* PostBoost API
|
|
3
3
|
* 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 ```
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.
|
|
5
|
+
* The version of the OpenAPI document: 1.22.0
|
|
6
6
|
* Contact: hi@postboost.co
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -104,7 +104,7 @@ export class AgentsApi {
|
|
|
104
104
|
}
|
|
105
105
|
|
|
106
106
|
/**
|
|
107
|
-
* Applies the proposal at once: `hold_post` moves the post back to draft, `edit_caption` replaces the caption. When the post was edited, deleted or left the schedule since the proposal was made, nothing changes and the proposal becomes `stale`. Admins and members only.
|
|
107
|
+
* Applies the proposal at once: `hold_post` moves the post back to draft, `edit_caption` replaces the caption, `retry_account` saves the shortened caption (if any) on that account\'s version and publishes that account again, `reconnect_account` only records the decision. When the post was edited, deleted or left the schedule since the proposal was made (for `retry_account`: the account is no longer failed, the post is publishing, or the plan does not allow scheduling), nothing changes and the proposal becomes `stale`. Admins and members only.
|
|
108
108
|
* @summary Approve and apply an agent proposal
|
|
109
109
|
* @param workspaceUuid UUID of the workspace.
|
|
110
110
|
* @param proposalUuid
|
|
@@ -185,7 +185,7 @@ export class AgentsApi {
|
|
|
185
185
|
});
|
|
186
186
|
}
|
|
187
187
|
/**
|
|
188
|
-
* Creates an agent (one per type per workspace). It first runs within five minutes, then on its `schedule`. **Pre-publish checker** looks at posts scheduled in the next `horizon_hours` and proposes holding (back to draft) posts that would fail: disconnected accounts, network requirements, daily caps, the X allowance and links that answer an error. It proposes caption edits that drop `banned_phrases`. With `ai_review: true` it also asks AI to review up to `max_ai_reviews_per_run` posts per run (one AI credit each). Admins and members only.
|
|
188
|
+
* Creates an agent (one per type per workspace). It first runs within five minutes, then on its `schedule`. **Pre-publish checker** looks at posts scheduled in the next `horizon_hours` and proposes holding (back to draft) posts that would fail: disconnected accounts, network requirements, daily caps, the X allowance and links that answer an error. It proposes caption edits that drop `banned_phrases`. With `ai_review: true` it also asks AI to review up to `max_ai_reviews_per_run` posts per run (one AI credit each). **Failed-post fixer** looks at posts that failed on an account in the last `lookback_hours` and proposes, per post and account, `reconnect_account` (the account\'s token expired), or `retry_account`, with a caption trimmed to the network limit when the text is over it. One open proposal per post and account. It uses no AI. Admins and members only.
|
|
189
189
|
* @summary Switch on a background agent
|
|
190
190
|
* @param workspaceUuid UUID of the workspace.
|
|
191
191
|
* @param workspaceAgentInput
|
|
@@ -598,7 +598,7 @@ export class AgentsApi {
|
|
|
598
598
|
});
|
|
599
599
|
}
|
|
600
600
|
/**
|
|
601
|
-
* Background agents switched on for the workspace. Agents run on a schedule, record every run and never change a post themselves: each change is a proposal that a workspace admin or member approves. Available
|
|
601
|
+
* Background agents switched on for the workspace. Agents run on a schedule, record every run and never change a post themselves: each change is a proposal that a workspace admin or member approves. Available types: `pre_publish_checker`, `failed_post_fixer`.
|
|
602
602
|
* @summary List background agents
|
|
603
603
|
* @param workspaceUuid UUID of the workspace.
|
|
604
604
|
*/
|
package/api/analyticsApi.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* PostBoost API
|
|
3
3
|
* 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 ```
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.
|
|
5
|
+
* The version of the OpenAPI document: 1.22.0
|
|
6
6
|
* Contact: hi@postboost.co
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/api/apis.ts
CHANGED
|
@@ -12,6 +12,8 @@ export * from './analyticsApi';
|
|
|
12
12
|
import { AnalyticsApi } from './analyticsApi';
|
|
13
13
|
export * from './competitorsApi';
|
|
14
14
|
import { CompetitorsApi } from './competitorsApi';
|
|
15
|
+
export * from './freeToolsApi';
|
|
16
|
+
import { FreeToolsApi } from './freeToolsApi';
|
|
15
17
|
export * from './hashtagGroupsApi';
|
|
16
18
|
import { HashtagGroupsApi } from './hashtagGroupsApi';
|
|
17
19
|
export * from './inboxApi';
|
|
@@ -49,4 +51,4 @@ export class HttpError extends Error {
|
|
|
49
51
|
|
|
50
52
|
export { RequestFile } from '../model/models';
|
|
51
53
|
|
|
52
|
-
export const APIS = [AIApi, AccountGroupsApi, AccountsApi, ActivityApi, AgentsApi, AnalyticsApi, CompetitorsApi, HashtagGroupsApi, InboxApi, MediaApi, MentionsApi, PostingScheduleApi, PostsApi, ReceiptsApi, SubscriptionsApi, TagsApi, TemplatesApi, UsersApi, WebhooksApi, WorkspacesApi];
|
|
54
|
+
export const APIS = [AIApi, AccountGroupsApi, AccountsApi, ActivityApi, AgentsApi, AnalyticsApi, CompetitorsApi, FreeToolsApi, HashtagGroupsApi, InboxApi, MediaApi, MentionsApi, PostingScheduleApi, PostsApi, ReceiptsApi, SubscriptionsApi, TagsApi, TemplatesApi, UsersApi, WebhooksApi, WorkspacesApi];
|
package/api/competitorsApi.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* PostBoost API
|
|
3
3
|
* 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 ```
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.
|
|
5
|
+
* The version of the OpenAPI document: 1.22.0
|
|
6
6
|
* Contact: hi@postboost.co
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|