postboost 1.27.1 → 1.29.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 +1 -1
- package/api/analyticsApi.ts +1 -1
- package/api/competitorsApi.ts +1 -1
- package/api/freeToolsApi.ts +149 -1
- 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 +1 -1
- 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/connectLink.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/createConnectLinkRequest.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 +1 -1
- package/model/freeToolBuildUtmUrlResponse.ts +1 -1
- package/model/freeToolCalculateEngagementRateRequest.ts +1 -1
- package/model/freeToolCalculateEngagementRateResponse.ts +1 -1
- package/model/freeToolCheckPostRequest.ts +1 -1
- package/model/freeToolCheckPostRequestMedia.ts +1 -1
- package/model/freeToolCheckPostResponse.ts +1 -1
- package/model/freeToolCheckPostResponseNetworksInner.ts +1 -1
- package/model/freeToolCheckPostResponseNetworksInnerErrorsInner.ts +1 -1
- package/model/freeToolCleanTextRequest.ts +1 -1
- package/model/freeToolCleanTextResponse.ts +1 -1
- package/model/freeToolCleanTextResponseChangesInner.ts +1 -1
- package/model/freeToolCleanTextResponseFlagsInner.ts +1 -1
- package/model/freeToolCountCharactersRequest.ts +1 -1
- package/model/freeToolCountCharactersResponse.ts +1 -1
- package/model/freeToolCountCharactersResponseNetworksInner.ts +1 -1
- package/model/freeToolError.ts +12 -3
- package/model/freeToolFormatLinkedInPostRequest.ts +1 -1
- package/model/freeToolFormatLinkedInPostResponse.ts +1 -1
- package/model/freeToolGenerateCaptionRequest.ts +107 -0
- package/model/freeToolGenerateCaptionResponse.ts +52 -0
- package/model/freeToolGenerateFancyTextRequest.ts +1 -1
- package/model/freeToolGenerateFancyTextResponse.ts +1 -1
- package/model/freeToolGenerateFancyTextResponseStylesInner.ts +1 -1
- package/model/freeToolGenerateHashtagsRequest.ts +71 -0
- package/model/freeToolGenerateHashtagsResponse.ts +52 -0
- package/model/freeToolList.ts +1 -1
- package/model/freeToolListItem.ts +1 -1
- package/model/freeToolSplitThreadRequest.ts +1 -1
- package/model/freeToolSplitThreadResponse.ts +1 -1
- package/model/freeToolSplitThreadResponsePostsInner.ts +1 -1
- 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 +16 -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 +5 -3
- 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 +1 -1
- package/model/workspaceAgentInput.ts +1 -1
- package/model/workspaceAgentSettings.ts +1 -1
- 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.29.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 on every supported network 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.29.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 on every supported network 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.29.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 on every supported network 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.29.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 on every supported network 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.29.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 on every supported network 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.29.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/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 on every supported network 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.29.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/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 on every supported network 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.29.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/freeToolsApi.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 on every supported network 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.29.0
|
|
6
6
|
* Contact: hi@postboost.co
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -28,8 +28,12 @@ import { FreeToolCountCharactersResponse } from '../model/freeToolCountCharacter
|
|
|
28
28
|
import { FreeToolError } from '../model/freeToolError';
|
|
29
29
|
import { FreeToolFormatLinkedInPostRequest } from '../model/freeToolFormatLinkedInPostRequest';
|
|
30
30
|
import { FreeToolFormatLinkedInPostResponse } from '../model/freeToolFormatLinkedInPostResponse';
|
|
31
|
+
import { FreeToolGenerateCaptionRequest } from '../model/freeToolGenerateCaptionRequest';
|
|
32
|
+
import { FreeToolGenerateCaptionResponse } from '../model/freeToolGenerateCaptionResponse';
|
|
31
33
|
import { FreeToolGenerateFancyTextRequest } from '../model/freeToolGenerateFancyTextRequest';
|
|
32
34
|
import { FreeToolGenerateFancyTextResponse } from '../model/freeToolGenerateFancyTextResponse';
|
|
35
|
+
import { FreeToolGenerateHashtagsRequest } from '../model/freeToolGenerateHashtagsRequest';
|
|
36
|
+
import { FreeToolGenerateHashtagsResponse } from '../model/freeToolGenerateHashtagsResponse';
|
|
33
37
|
import { FreeToolList } from '../model/freeToolList';
|
|
34
38
|
import { FreeToolSplitThreadRequest } from '../model/freeToolSplitThreadRequest';
|
|
35
39
|
import { FreeToolSplitThreadResponse } from '../model/freeToolSplitThreadResponse';
|
|
@@ -523,6 +527,78 @@ export class FreeToolsApi {
|
|
|
523
527
|
});
|
|
524
528
|
});
|
|
525
529
|
}
|
|
530
|
+
/**
|
|
531
|
+
* Write three post captions for a topic with AI (needs a token, spends AI credits). The same logic as the free web tool at https://postboost.co/tools/instagram-caption-generator. Needs an API token (a scoped key needs the `ai` ability and pays with its own workspace). A new generation spends 1 AI credit of the workspace you name (or your active workspace); a repeated identical request is answered from the cache for free.
|
|
532
|
+
* @summary Write three post captions for a topic with AI (needs a token, spends AI credits)
|
|
533
|
+
* @param freeToolGenerateCaptionRequest
|
|
534
|
+
*/
|
|
535
|
+
public async generateCaption (freeToolGenerateCaptionRequest: FreeToolGenerateCaptionRequest, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body: FreeToolGenerateCaptionResponse; }> {
|
|
536
|
+
const localVarPath = this.basePath + '/tools/instagram-caption-generator';
|
|
537
|
+
let localVarQueryParameters: any = {};
|
|
538
|
+
let localVarHeaderParams: any = (<any>Object).assign({}, this._defaultHeaders);
|
|
539
|
+
const produces = ['application/json'];
|
|
540
|
+
// give precedence to 'application/json'
|
|
541
|
+
if (produces.indexOf('application/json') >= 0) {
|
|
542
|
+
localVarHeaderParams.Accept = 'application/json';
|
|
543
|
+
} else {
|
|
544
|
+
localVarHeaderParams.Accept = produces.join(',');
|
|
545
|
+
}
|
|
546
|
+
let localVarFormParams: any = {};
|
|
547
|
+
|
|
548
|
+
// verify required parameter 'freeToolGenerateCaptionRequest' is not null or undefined
|
|
549
|
+
if (freeToolGenerateCaptionRequest === null || freeToolGenerateCaptionRequest === undefined) {
|
|
550
|
+
throw new Error('Required parameter freeToolGenerateCaptionRequest was null or undefined when calling generateCaption.');
|
|
551
|
+
}
|
|
552
|
+
|
|
553
|
+
(<any>Object).assign(localVarHeaderParams, options.headers);
|
|
554
|
+
|
|
555
|
+
let localVarUseFormData = false;
|
|
556
|
+
|
|
557
|
+
let localVarRequestOptions: localVarRequest.Options = {
|
|
558
|
+
method: 'POST',
|
|
559
|
+
qs: localVarQueryParameters,
|
|
560
|
+
headers: localVarHeaderParams,
|
|
561
|
+
uri: localVarPath,
|
|
562
|
+
useQuerystring: this._useQuerystring,
|
|
563
|
+
json: true,
|
|
564
|
+
body: ObjectSerializer.serialize(freeToolGenerateCaptionRequest, "FreeToolGenerateCaptionRequest")
|
|
565
|
+
};
|
|
566
|
+
|
|
567
|
+
let authenticationPromise = Promise.resolve();
|
|
568
|
+
if (this.authentications.bearerAuth.accessToken) {
|
|
569
|
+
authenticationPromise = authenticationPromise.then(() => this.authentications.bearerAuth.applyToRequest(localVarRequestOptions));
|
|
570
|
+
}
|
|
571
|
+
authenticationPromise = authenticationPromise.then(() => this.authentications.default.applyToRequest(localVarRequestOptions));
|
|
572
|
+
|
|
573
|
+
let interceptorPromise = authenticationPromise;
|
|
574
|
+
for (const interceptor of this.interceptors) {
|
|
575
|
+
interceptorPromise = interceptorPromise.then(() => interceptor(localVarRequestOptions));
|
|
576
|
+
}
|
|
577
|
+
|
|
578
|
+
return interceptorPromise.then(() => {
|
|
579
|
+
if (Object.keys(localVarFormParams).length) {
|
|
580
|
+
if (localVarUseFormData) {
|
|
581
|
+
(<any>localVarRequestOptions).formData = localVarFormParams;
|
|
582
|
+
} else {
|
|
583
|
+
localVarRequestOptions.form = localVarFormParams;
|
|
584
|
+
}
|
|
585
|
+
}
|
|
586
|
+
return new Promise<{ response: http.IncomingMessage; body: FreeToolGenerateCaptionResponse; }>((resolve, reject) => {
|
|
587
|
+
localVarRequest(localVarRequestOptions, (error, response, body) => {
|
|
588
|
+
if (error) {
|
|
589
|
+
reject(error);
|
|
590
|
+
} else {
|
|
591
|
+
if (response.statusCode && response.statusCode >= 200 && response.statusCode <= 299) {
|
|
592
|
+
body = ObjectSerializer.deserialize(body, "FreeToolGenerateCaptionResponse");
|
|
593
|
+
resolve({ response: response, body: body });
|
|
594
|
+
} else {
|
|
595
|
+
reject(new HttpError(response, body, response.statusCode));
|
|
596
|
+
}
|
|
597
|
+
}
|
|
598
|
+
});
|
|
599
|
+
});
|
|
600
|
+
});
|
|
601
|
+
}
|
|
526
602
|
/**
|
|
527
603
|
* Convert text to fancy Unicode styles. The same logic as the free web tool at https://postboost.co/tools/fancy-text-generator. No account needed: call it without a token, or with any API token.
|
|
528
604
|
* @summary Convert text to fancy Unicode styles
|
|
@@ -592,6 +668,78 @@ export class FreeToolsApi {
|
|
|
592
668
|
});
|
|
593
669
|
});
|
|
594
670
|
}
|
|
671
|
+
/**
|
|
672
|
+
* Generate hashtags for a post topic with AI (needs a token, spends AI credits). The same logic as the free web tool at https://postboost.co/tools/instagram-hashtag-generator. Needs an API token (a scoped key needs the `ai` ability and pays with its own workspace). A new generation spends 1 AI credit of the workspace you name (or your active workspace); a repeated identical request is answered from the cache for free.
|
|
673
|
+
* @summary Generate hashtags for a post topic with AI (needs a token, spends AI credits)
|
|
674
|
+
* @param freeToolGenerateHashtagsRequest
|
|
675
|
+
*/
|
|
676
|
+
public async generateHashtags (freeToolGenerateHashtagsRequest: FreeToolGenerateHashtagsRequest, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body: FreeToolGenerateHashtagsResponse; }> {
|
|
677
|
+
const localVarPath = this.basePath + '/tools/instagram-hashtag-generator';
|
|
678
|
+
let localVarQueryParameters: any = {};
|
|
679
|
+
let localVarHeaderParams: any = (<any>Object).assign({}, this._defaultHeaders);
|
|
680
|
+
const produces = ['application/json'];
|
|
681
|
+
// give precedence to 'application/json'
|
|
682
|
+
if (produces.indexOf('application/json') >= 0) {
|
|
683
|
+
localVarHeaderParams.Accept = 'application/json';
|
|
684
|
+
} else {
|
|
685
|
+
localVarHeaderParams.Accept = produces.join(',');
|
|
686
|
+
}
|
|
687
|
+
let localVarFormParams: any = {};
|
|
688
|
+
|
|
689
|
+
// verify required parameter 'freeToolGenerateHashtagsRequest' is not null or undefined
|
|
690
|
+
if (freeToolGenerateHashtagsRequest === null || freeToolGenerateHashtagsRequest === undefined) {
|
|
691
|
+
throw new Error('Required parameter freeToolGenerateHashtagsRequest was null or undefined when calling generateHashtags.');
|
|
692
|
+
}
|
|
693
|
+
|
|
694
|
+
(<any>Object).assign(localVarHeaderParams, options.headers);
|
|
695
|
+
|
|
696
|
+
let localVarUseFormData = false;
|
|
697
|
+
|
|
698
|
+
let localVarRequestOptions: localVarRequest.Options = {
|
|
699
|
+
method: 'POST',
|
|
700
|
+
qs: localVarQueryParameters,
|
|
701
|
+
headers: localVarHeaderParams,
|
|
702
|
+
uri: localVarPath,
|
|
703
|
+
useQuerystring: this._useQuerystring,
|
|
704
|
+
json: true,
|
|
705
|
+
body: ObjectSerializer.serialize(freeToolGenerateHashtagsRequest, "FreeToolGenerateHashtagsRequest")
|
|
706
|
+
};
|
|
707
|
+
|
|
708
|
+
let authenticationPromise = Promise.resolve();
|
|
709
|
+
if (this.authentications.bearerAuth.accessToken) {
|
|
710
|
+
authenticationPromise = authenticationPromise.then(() => this.authentications.bearerAuth.applyToRequest(localVarRequestOptions));
|
|
711
|
+
}
|
|
712
|
+
authenticationPromise = authenticationPromise.then(() => this.authentications.default.applyToRequest(localVarRequestOptions));
|
|
713
|
+
|
|
714
|
+
let interceptorPromise = authenticationPromise;
|
|
715
|
+
for (const interceptor of this.interceptors) {
|
|
716
|
+
interceptorPromise = interceptorPromise.then(() => interceptor(localVarRequestOptions));
|
|
717
|
+
}
|
|
718
|
+
|
|
719
|
+
return interceptorPromise.then(() => {
|
|
720
|
+
if (Object.keys(localVarFormParams).length) {
|
|
721
|
+
if (localVarUseFormData) {
|
|
722
|
+
(<any>localVarRequestOptions).formData = localVarFormParams;
|
|
723
|
+
} else {
|
|
724
|
+
localVarRequestOptions.form = localVarFormParams;
|
|
725
|
+
}
|
|
726
|
+
}
|
|
727
|
+
return new Promise<{ response: http.IncomingMessage; body: FreeToolGenerateHashtagsResponse; }>((resolve, reject) => {
|
|
728
|
+
localVarRequest(localVarRequestOptions, (error, response, body) => {
|
|
729
|
+
if (error) {
|
|
730
|
+
reject(error);
|
|
731
|
+
} else {
|
|
732
|
+
if (response.statusCode && response.statusCode >= 200 && response.statusCode <= 299) {
|
|
733
|
+
body = ObjectSerializer.deserialize(body, "FreeToolGenerateHashtagsResponse");
|
|
734
|
+
resolve({ response: response, body: body });
|
|
735
|
+
} else {
|
|
736
|
+
reject(new HttpError(response, body, response.statusCode));
|
|
737
|
+
}
|
|
738
|
+
}
|
|
739
|
+
});
|
|
740
|
+
});
|
|
741
|
+
});
|
|
742
|
+
}
|
|
595
743
|
/**
|
|
596
744
|
* Every free tool the API serves, with its operationId and web page. No token needed.
|
|
597
745
|
* @summary List the free tools
|
package/api/hashtagGroupsApi.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 on every supported network 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.29.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/inboxApi.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 on every supported network 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.29.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/mediaApi.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 on every supported network 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.29.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/mentionsApi.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 on every supported network 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.29.0
|
|
6
6
|
* Contact: hi@postboost.co
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* PostBoost API
|
|
3
3
|
* The PostBoost REST API lets you publish, schedule, and analyze social media posts on every supported network 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.29.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/postsApi.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 on every supported network 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.29.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/receiptsApi.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 on every supported network 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.29.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/subscriptionsApi.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 on every supported network 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.29.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/tagsApi.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 on every supported network 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.29.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/templatesApi.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 on every supported network 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.29.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/usersApi.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 on every supported network 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.29.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/webhooksApi.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 on every supported network 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.29.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/workspacesApi.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 on every supported network 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.29.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/model/aICredits.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 on every supported network 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.29.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/model/aIUsage.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 on every supported network 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.29.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/model/aIUsageText.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 on every supported network 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.29.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/model/account.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 on every supported network 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.29.0
|
|
6
6
|
* Contact: hi@postboost.co
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* PostBoost API
|
|
3
3
|
* The PostBoost REST API lets you publish, schedule, and analyze social media posts on every supported network 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.29.0
|
|
6
6
|
* Contact: hi@postboost.co
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* PostBoost API
|
|
3
3
|
* The PostBoost REST API lets you publish, schedule, and analyze social media posts on every supported network 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.29.0
|
|
6
6
|
* Contact: hi@postboost.co
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* PostBoost API
|
|
3
3
|
* The PostBoost REST API lets you publish, schedule, and analyze social media posts on every supported network 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.29.0
|
|
6
6
|
* Contact: hi@postboost.co
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* PostBoost API
|
|
3
3
|
* The PostBoost REST API lets you publish, schedule, and analyze social media posts on every supported network 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.29.0
|
|
6
6
|
* Contact: hi@postboost.co
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* PostBoost API
|
|
3
3
|
* The PostBoost REST API lets you publish, schedule, and analyze social media posts on every supported network 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.29.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/model/accountGroup.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 on every supported network 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.29.0
|
|
6
6
|
* Contact: hi@postboost.co
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|