postboost 1.31.0 → 1.33.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 +143 -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/dist/api/freeToolsApi.d.ts +20 -0
- package/dist/api/freeToolsApi.js +122 -0
- package/dist/api/freeToolsApi.js.map +1 -1
- package/dist/model/freeToolCalculateAspectRatioRequest.d.ts +16 -0
- package/dist/model/freeToolCalculateAspectRatioRequest.js +28 -0
- package/dist/model/freeToolCalculateAspectRatioRequest.js.map +1 -0
- package/dist/model/freeToolCalculateAspectRatioResponse.d.ts +29 -0
- package/dist/model/freeToolCalculateAspectRatioResponse.js +56 -0
- package/dist/model/freeToolCalculateAspectRatioResponse.js.map +1 -0
- package/dist/model/freeToolCalculateAspectRatioResponseMatchesInner.d.ts +19 -0
- package/dist/model/freeToolCalculateAspectRatioResponseMatchesInner.js +43 -0
- package/dist/model/freeToolCalculateAspectRatioResponseMatchesInner.js.map +1 -0
- package/dist/model/freeToolCalculateAspectRatioResponseRounding.d.ts +22 -0
- package/dist/model/freeToolCalculateAspectRatioResponseRounding.js +35 -0
- package/dist/model/freeToolCalculateAspectRatioResponseRounding.js.map +1 -0
- package/dist/model/freeToolPreviewPostRequest.d.ts +24 -0
- package/dist/model/freeToolPreviewPostRequest.js +44 -0
- package/dist/model/freeToolPreviewPostRequest.js.map +1 -0
- package/dist/model/freeToolPreviewPostResponse.d.ts +15 -0
- package/dist/model/freeToolPreviewPostResponse.js +18 -0
- package/dist/model/freeToolPreviewPostResponse.js.map +1 -0
- package/dist/model/freeToolPreviewPostResponseNetworksInner.d.ts +31 -0
- package/dist/model/freeToolPreviewPostResponseNetworksInner.js +72 -0
- package/dist/model/freeToolPreviewPostResponseNetworksInner.js.map +1 -0
- package/dist/model/models.d.ts +7 -0
- package/dist/model/models.js +25 -0
- package/dist/model/models.js.map +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/accountConnectionHealthReconnectReason.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/freeToolCalculateAspectRatioRequest.ts +52 -0
- package/model/freeToolCalculateAspectRatioResponse.ts +85 -0
- package/model/freeToolCalculateAspectRatioResponseMatchesInner.ts +70 -0
- package/model/freeToolCalculateAspectRatioResponseRounding.ts +52 -0
- package/model/freeToolCalculateCropRequest.ts +1 -1
- package/model/freeToolCalculateCropResponse.ts +1 -1
- package/model/freeToolCalculateCropResponseCrop.ts +1 -1
- package/model/freeToolCalculateCropResponseImage.ts +1 -1
- package/model/freeToolCalculateCropResponseOutput.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 +1 -1
- package/model/freeToolFormatLinkedInPostRequest.ts +1 -1
- package/model/freeToolFormatLinkedInPostResponse.ts +1 -1
- package/model/freeToolGenerateCaptionRequest.ts +1 -1
- package/model/freeToolGenerateCaptionResponse.ts +1 -1
- package/model/freeToolGenerateFancyTextRequest.ts +1 -1
- package/model/freeToolGenerateFancyTextResponse.ts +1 -1
- package/model/freeToolGenerateFancyTextResponseStylesInner.ts +1 -1
- package/model/freeToolGenerateHashtagsRequest.ts +1 -1
- package/model/freeToolGenerateHashtagsResponse.ts +1 -1
- package/model/freeToolGetBestTimesToPostResponse.ts +1 -1
- package/model/freeToolGetBestTimesToPostResponseNetworksInner.ts +1 -1
- package/model/freeToolGetImageSizesResponse.ts +1 -1
- package/model/freeToolGetImageSizesResponseSizesInner.ts +1 -1
- package/model/freeToolGetImageSizesResponseSourcesInner.ts +1 -1
- package/model/freeToolList.ts +1 -1
- package/model/freeToolListItem.ts +1 -1
- package/model/freeToolPreviewPostRequest.ts +65 -0
- package/model/freeToolPreviewPostResponse.ts +32 -0
- package/model/freeToolPreviewPostResponseNetworksInner.ts +108 -0
- 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 +25 -0
- package/model/paginationMeta.ts +1 -1
- package/model/paginationMetaLinks.ts +1 -1
- package/model/paginationMetaMeta.ts +1 -1
- package/model/pollRssFeed200Response.ts +1 -1
- package/model/post.ts +1 -1
- package/model/postAnalytics.ts +1 -1
- package/model/postContent.ts +1 -1
- package/model/postInput.ts +1 -1
- package/model/postOptionsInstagram.ts +1 -1
- package/model/postOptionsTikTok.ts +1 -1
- package/model/postOptionsYoutube.ts +1 -1
- package/model/postStatus.ts +1 -1
- package/model/postVersion.ts +1 -1
- package/model/postVersionOptions.ts +1 -1
- package/model/postWarning.ts +1 -1
- package/model/postWarnings.ts +1 -1
- package/model/postingSchedule.ts +1 -1
- package/model/postingScheduleDay.ts +1 -1
- package/model/postingScheduleDayTimesInner.ts +1 -1
- package/model/postingScheduleInput.ts +1 -1
- package/model/postingTimeSlot.ts +1 -1
- package/model/postingTimes.ts +1 -1
- package/model/postingTimesBestInner.ts +1 -1
- package/model/postingTimesDayIntervalsInnerInner.ts +1 -1
- package/model/postingTimesDaysInner.ts +1 -1
- package/model/preflightResult.ts +1 -1
- package/model/publicWorkspace.ts +1 -1
- package/model/publicWorkspacePivot.ts +1 -1
- package/model/publishProgress.ts +1 -1
- package/model/queueSlots.ts +1 -1
- package/model/receipt.ts +1 -1
- package/model/receiptInput.ts +1 -1
- package/model/receiptUpdateInput.ts +1 -1
- package/model/recommendedPostingTimes.ts +1 -1
- package/model/reconnectLink.ts +1 -1
- package/model/recyclingRule.ts +1 -1
- package/model/recyclingRuleInput.ts +1 -1
- package/model/recyclingRuleSettings.ts +1 -1
- package/model/recyclingRuleUpdate.ts +1 -1
- package/model/recyclingRun.ts +1 -1
- package/model/removeGenericSubscription422Response.ts +1 -1
- package/model/removeUserFromWorkspaceRequest.ts +1 -1
- package/model/reportBranding.ts +1 -1
- package/model/reportBrandingInput.ts +1 -1
- package/model/reportExport.ts +1 -1
- package/model/reportExportInput.ts +1 -1
- package/model/repurposeContent200Response.ts +1 -1
- package/model/repurposeContent202Response.ts +1 -1
- package/model/repurposeContent500Response.ts +1 -1
- package/model/repurposeInput.ts +1 -1
- package/model/repurposeInputTheme.ts +1 -1
- package/model/repurposeResult.ts +1 -1
- package/model/repurposeResultMedia.ts +1 -1
- package/model/repurposeResultSource.ts +1 -1
- package/model/repurposeRun.ts +1 -1
- package/model/repurposeRunAccepted.ts +1 -1
- package/model/repurposeSlide.ts +1 -1
- package/model/resellerClient.ts +1 -1
- package/model/resellerClientInput.ts +1 -1
- package/model/resellerClientUsage.ts +1 -1
- package/model/retryPostAccountResult.ts +1 -1
- package/model/rssFeed.ts +1 -1
- package/model/rssFeedInput.ts +1 -1
- package/model/rssFeedUpdate.ts +1 -1
- package/model/runAgent202Response.ts +1 -1
- package/model/schedulePostRequest.ts +1 -1
- package/model/scheduleResult.ts +1 -1
- package/model/subscription.ts +1 -1
- package/model/subscriptionInput.ts +1 -1
- package/model/subscriptionStatus.ts +1 -1
- package/model/subscriptionUpdateInput.ts +1 -1
- package/model/tag.ts +1 -1
- package/model/tagInput.ts +1 -1
- package/model/template.ts +1 -1
- package/model/templateContentItem.ts +1 -1
- package/model/templateInput.ts +1 -1
- package/model/templateInputContentInner.ts +1 -1
- package/model/updateMediaRequest.ts +1 -1
- package/model/updatePost200Response.ts +1 -1
- package/model/uploadChunk201Response.ts +1 -1
- package/model/user.ts +1 -1
- package/model/userInput.ts +1 -1
- package/model/userUpdateInput.ts +1 -1
- package/model/webhookEventName.ts +1 -1
- package/model/webhookEventPayload.ts +1 -1
- package/model/webhookSubscription.ts +1 -1
- package/model/webhookSubscriptionInput.ts +1 -1
- package/model/workspace.ts +1 -1
- package/model/workspaceAgent.ts +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.33.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.33.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.33.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.33.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.33.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.33.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.33.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.33.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.33.0
|
|
6
6
|
* Contact: hi@postboost.co
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -17,6 +17,8 @@ import http from 'http';
|
|
|
17
17
|
/* tslint:disable:no-unused-locals */
|
|
18
18
|
import { FreeToolBuildUtmUrlRequest } from '../model/freeToolBuildUtmUrlRequest';
|
|
19
19
|
import { FreeToolBuildUtmUrlResponse } from '../model/freeToolBuildUtmUrlResponse';
|
|
20
|
+
import { FreeToolCalculateAspectRatioRequest } from '../model/freeToolCalculateAspectRatioRequest';
|
|
21
|
+
import { FreeToolCalculateAspectRatioResponse } from '../model/freeToolCalculateAspectRatioResponse';
|
|
20
22
|
import { FreeToolCalculateCropRequest } from '../model/freeToolCalculateCropRequest';
|
|
21
23
|
import { FreeToolCalculateCropResponse } from '../model/freeToolCalculateCropResponse';
|
|
22
24
|
import { FreeToolCalculateEngagementRateRequest } from '../model/freeToolCalculateEngagementRateRequest';
|
|
@@ -39,6 +41,8 @@ import { FreeToolGenerateHashtagsResponse } from '../model/freeToolGenerateHasht
|
|
|
39
41
|
import { FreeToolGetBestTimesToPostResponse } from '../model/freeToolGetBestTimesToPostResponse';
|
|
40
42
|
import { FreeToolGetImageSizesResponse } from '../model/freeToolGetImageSizesResponse';
|
|
41
43
|
import { FreeToolList } from '../model/freeToolList';
|
|
44
|
+
import { FreeToolPreviewPostRequest } from '../model/freeToolPreviewPostRequest';
|
|
45
|
+
import { FreeToolPreviewPostResponse } from '../model/freeToolPreviewPostResponse';
|
|
42
46
|
import { FreeToolSplitThreadRequest } from '../model/freeToolSplitThreadRequest';
|
|
43
47
|
import { FreeToolSplitThreadResponse } from '../model/freeToolSplitThreadResponse';
|
|
44
48
|
|
|
@@ -186,6 +190,75 @@ export class FreeToolsApi {
|
|
|
186
190
|
});
|
|
187
191
|
});
|
|
188
192
|
}
|
|
193
|
+
/**
|
|
194
|
+
* Calculate an aspect ratio, or the missing side of an image at a given ratio. The same logic as the free web tool at https://postboost.co/tools/aspect-ratio-calculator. No account needed: call it without a token, or with any API token.
|
|
195
|
+
* @summary Calculate an aspect ratio, or the missing side of an image at a given ratio
|
|
196
|
+
* @param freeToolCalculateAspectRatioRequest
|
|
197
|
+
*/
|
|
198
|
+
public async calculateAspectRatio (freeToolCalculateAspectRatioRequest: FreeToolCalculateAspectRatioRequest, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body: FreeToolCalculateAspectRatioResponse; }> {
|
|
199
|
+
const localVarPath = this.basePath + '/tools/aspect-ratio-calculator';
|
|
200
|
+
let localVarQueryParameters: any = {};
|
|
201
|
+
let localVarHeaderParams: any = (<any>Object).assign({}, this._defaultHeaders);
|
|
202
|
+
const produces = ['application/json'];
|
|
203
|
+
// give precedence to 'application/json'
|
|
204
|
+
if (produces.indexOf('application/json') >= 0) {
|
|
205
|
+
localVarHeaderParams.Accept = 'application/json';
|
|
206
|
+
} else {
|
|
207
|
+
localVarHeaderParams.Accept = produces.join(',');
|
|
208
|
+
}
|
|
209
|
+
let localVarFormParams: any = {};
|
|
210
|
+
|
|
211
|
+
// verify required parameter 'freeToolCalculateAspectRatioRequest' is not null or undefined
|
|
212
|
+
if (freeToolCalculateAspectRatioRequest === null || freeToolCalculateAspectRatioRequest === undefined) {
|
|
213
|
+
throw new Error('Required parameter freeToolCalculateAspectRatioRequest was null or undefined when calling calculateAspectRatio.');
|
|
214
|
+
}
|
|
215
|
+
|
|
216
|
+
(<any>Object).assign(localVarHeaderParams, options.headers);
|
|
217
|
+
|
|
218
|
+
let localVarUseFormData = false;
|
|
219
|
+
|
|
220
|
+
let localVarRequestOptions: localVarRequest.Options = {
|
|
221
|
+
method: 'POST',
|
|
222
|
+
qs: localVarQueryParameters,
|
|
223
|
+
headers: localVarHeaderParams,
|
|
224
|
+
uri: localVarPath,
|
|
225
|
+
useQuerystring: this._useQuerystring,
|
|
226
|
+
json: true,
|
|
227
|
+
body: ObjectSerializer.serialize(freeToolCalculateAspectRatioRequest, "FreeToolCalculateAspectRatioRequest")
|
|
228
|
+
};
|
|
229
|
+
|
|
230
|
+
let authenticationPromise = Promise.resolve();
|
|
231
|
+
authenticationPromise = authenticationPromise.then(() => this.authentications.default.applyToRequest(localVarRequestOptions));
|
|
232
|
+
|
|
233
|
+
let interceptorPromise = authenticationPromise;
|
|
234
|
+
for (const interceptor of this.interceptors) {
|
|
235
|
+
interceptorPromise = interceptorPromise.then(() => interceptor(localVarRequestOptions));
|
|
236
|
+
}
|
|
237
|
+
|
|
238
|
+
return interceptorPromise.then(() => {
|
|
239
|
+
if (Object.keys(localVarFormParams).length) {
|
|
240
|
+
if (localVarUseFormData) {
|
|
241
|
+
(<any>localVarRequestOptions).formData = localVarFormParams;
|
|
242
|
+
} else {
|
|
243
|
+
localVarRequestOptions.form = localVarFormParams;
|
|
244
|
+
}
|
|
245
|
+
}
|
|
246
|
+
return new Promise<{ response: http.IncomingMessage; body: FreeToolCalculateAspectRatioResponse; }>((resolve, reject) => {
|
|
247
|
+
localVarRequest(localVarRequestOptions, (error, response, body) => {
|
|
248
|
+
if (error) {
|
|
249
|
+
reject(error);
|
|
250
|
+
} else {
|
|
251
|
+
if (response.statusCode && response.statusCode >= 200 && response.statusCode <= 299) {
|
|
252
|
+
body = ObjectSerializer.deserialize(body, "FreeToolCalculateAspectRatioResponse");
|
|
253
|
+
resolve({ response: response, body: body });
|
|
254
|
+
} else {
|
|
255
|
+
reject(new HttpError(response, body, response.statusCode));
|
|
256
|
+
}
|
|
257
|
+
}
|
|
258
|
+
});
|
|
259
|
+
});
|
|
260
|
+
});
|
|
261
|
+
}
|
|
189
262
|
/**
|
|
190
263
|
* Calculate the crop box that fits an image to a social media size. The same logic as the free web tool at https://postboost.co/tools/social-media-image-sizes. No account needed: call it without a token, or with any API token.
|
|
191
264
|
* @summary Calculate the crop box that fits an image to a social media size
|
|
@@ -1009,6 +1082,75 @@ export class FreeToolsApi {
|
|
|
1009
1082
|
});
|
|
1010
1083
|
});
|
|
1011
1084
|
}
|
|
1085
|
+
/**
|
|
1086
|
+
* Preview where a post folds and when its image is cropped on Instagram, X, LinkedIn and Facebook. The same logic as the free web tool at https://postboost.co/tools/social-media-post-preview. No account needed: call it without a token, or with any API token.
|
|
1087
|
+
* @summary Preview where a post folds and when its image is cropped on Instagram, X, LinkedIn and Facebook
|
|
1088
|
+
* @param freeToolPreviewPostRequest
|
|
1089
|
+
*/
|
|
1090
|
+
public async previewPost (freeToolPreviewPostRequest: FreeToolPreviewPostRequest, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body: FreeToolPreviewPostResponse; }> {
|
|
1091
|
+
const localVarPath = this.basePath + '/tools/social-media-post-preview';
|
|
1092
|
+
let localVarQueryParameters: any = {};
|
|
1093
|
+
let localVarHeaderParams: any = (<any>Object).assign({}, this._defaultHeaders);
|
|
1094
|
+
const produces = ['application/json'];
|
|
1095
|
+
// give precedence to 'application/json'
|
|
1096
|
+
if (produces.indexOf('application/json') >= 0) {
|
|
1097
|
+
localVarHeaderParams.Accept = 'application/json';
|
|
1098
|
+
} else {
|
|
1099
|
+
localVarHeaderParams.Accept = produces.join(',');
|
|
1100
|
+
}
|
|
1101
|
+
let localVarFormParams: any = {};
|
|
1102
|
+
|
|
1103
|
+
// verify required parameter 'freeToolPreviewPostRequest' is not null or undefined
|
|
1104
|
+
if (freeToolPreviewPostRequest === null || freeToolPreviewPostRequest === undefined) {
|
|
1105
|
+
throw new Error('Required parameter freeToolPreviewPostRequest was null or undefined when calling previewPost.');
|
|
1106
|
+
}
|
|
1107
|
+
|
|
1108
|
+
(<any>Object).assign(localVarHeaderParams, options.headers);
|
|
1109
|
+
|
|
1110
|
+
let localVarUseFormData = false;
|
|
1111
|
+
|
|
1112
|
+
let localVarRequestOptions: localVarRequest.Options = {
|
|
1113
|
+
method: 'POST',
|
|
1114
|
+
qs: localVarQueryParameters,
|
|
1115
|
+
headers: localVarHeaderParams,
|
|
1116
|
+
uri: localVarPath,
|
|
1117
|
+
useQuerystring: this._useQuerystring,
|
|
1118
|
+
json: true,
|
|
1119
|
+
body: ObjectSerializer.serialize(freeToolPreviewPostRequest, "FreeToolPreviewPostRequest")
|
|
1120
|
+
};
|
|
1121
|
+
|
|
1122
|
+
let authenticationPromise = Promise.resolve();
|
|
1123
|
+
authenticationPromise = authenticationPromise.then(() => this.authentications.default.applyToRequest(localVarRequestOptions));
|
|
1124
|
+
|
|
1125
|
+
let interceptorPromise = authenticationPromise;
|
|
1126
|
+
for (const interceptor of this.interceptors) {
|
|
1127
|
+
interceptorPromise = interceptorPromise.then(() => interceptor(localVarRequestOptions));
|
|
1128
|
+
}
|
|
1129
|
+
|
|
1130
|
+
return interceptorPromise.then(() => {
|
|
1131
|
+
if (Object.keys(localVarFormParams).length) {
|
|
1132
|
+
if (localVarUseFormData) {
|
|
1133
|
+
(<any>localVarRequestOptions).formData = localVarFormParams;
|
|
1134
|
+
} else {
|
|
1135
|
+
localVarRequestOptions.form = localVarFormParams;
|
|
1136
|
+
}
|
|
1137
|
+
}
|
|
1138
|
+
return new Promise<{ response: http.IncomingMessage; body: FreeToolPreviewPostResponse; }>((resolve, reject) => {
|
|
1139
|
+
localVarRequest(localVarRequestOptions, (error, response, body) => {
|
|
1140
|
+
if (error) {
|
|
1141
|
+
reject(error);
|
|
1142
|
+
} else {
|
|
1143
|
+
if (response.statusCode && response.statusCode >= 200 && response.statusCode <= 299) {
|
|
1144
|
+
body = ObjectSerializer.deserialize(body, "FreeToolPreviewPostResponse");
|
|
1145
|
+
resolve({ response: response, body: body });
|
|
1146
|
+
} else {
|
|
1147
|
+
reject(new HttpError(response, body, response.statusCode));
|
|
1148
|
+
}
|
|
1149
|
+
}
|
|
1150
|
+
});
|
|
1151
|
+
});
|
|
1152
|
+
});
|
|
1153
|
+
}
|
|
1012
1154
|
/**
|
|
1013
1155
|
* Split long text into a thread. The same logic as the free web tool at https://postboost.co/tools/x-thread-maker. No account needed: call it without a token, or with any API token.
|
|
1014
1156
|
* @summary Split long text into a thread
|
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.33.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.33.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.33.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.33.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.33.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.33.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.33.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.33.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.33.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.33.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.33.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.33.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.33.0
|
|
6
6
|
* Contact: hi@postboost.co
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -1,6 +1,8 @@
|
|
|
1
1
|
import http from 'http';
|
|
2
2
|
import { FreeToolBuildUtmUrlRequest } from '../model/freeToolBuildUtmUrlRequest';
|
|
3
3
|
import { FreeToolBuildUtmUrlResponse } from '../model/freeToolBuildUtmUrlResponse';
|
|
4
|
+
import { FreeToolCalculateAspectRatioRequest } from '../model/freeToolCalculateAspectRatioRequest';
|
|
5
|
+
import { FreeToolCalculateAspectRatioResponse } from '../model/freeToolCalculateAspectRatioResponse';
|
|
4
6
|
import { FreeToolCalculateCropRequest } from '../model/freeToolCalculateCropRequest';
|
|
5
7
|
import { FreeToolCalculateCropResponse } from '../model/freeToolCalculateCropResponse';
|
|
6
8
|
import { FreeToolCalculateEngagementRateRequest } from '../model/freeToolCalculateEngagementRateRequest';
|
|
@@ -22,6 +24,8 @@ import { FreeToolGenerateHashtagsResponse } from '../model/freeToolGenerateHasht
|
|
|
22
24
|
import { FreeToolGetBestTimesToPostResponse } from '../model/freeToolGetBestTimesToPostResponse';
|
|
23
25
|
import { FreeToolGetImageSizesResponse } from '../model/freeToolGetImageSizesResponse';
|
|
24
26
|
import { FreeToolList } from '../model/freeToolList';
|
|
27
|
+
import { FreeToolPreviewPostRequest } from '../model/freeToolPreviewPostRequest';
|
|
28
|
+
import { FreeToolPreviewPostResponse } from '../model/freeToolPreviewPostResponse';
|
|
25
29
|
import { FreeToolSplitThreadRequest } from '../model/freeToolSplitThreadRequest';
|
|
26
30
|
import { FreeToolSplitThreadResponse } from '../model/freeToolSplitThreadResponse';
|
|
27
31
|
import { Authentication, Interceptor } from '../model/models';
|
|
@@ -55,6 +59,14 @@ export declare class FreeToolsApi {
|
|
|
55
59
|
response: http.IncomingMessage;
|
|
56
60
|
body: FreeToolBuildUtmUrlResponse;
|
|
57
61
|
}>;
|
|
62
|
+
calculateAspectRatio(freeToolCalculateAspectRatioRequest: FreeToolCalculateAspectRatioRequest, options?: {
|
|
63
|
+
headers: {
|
|
64
|
+
[name: string]: string;
|
|
65
|
+
};
|
|
66
|
+
}): Promise<{
|
|
67
|
+
response: http.IncomingMessage;
|
|
68
|
+
body: FreeToolCalculateAspectRatioResponse;
|
|
69
|
+
}>;
|
|
58
70
|
calculateCrop(freeToolCalculateCropRequest: FreeToolCalculateCropRequest, options?: {
|
|
59
71
|
headers: {
|
|
60
72
|
[name: string]: string;
|
|
@@ -151,6 +163,14 @@ export declare class FreeToolsApi {
|
|
|
151
163
|
response: http.IncomingMessage;
|
|
152
164
|
body: FreeToolList;
|
|
153
165
|
}>;
|
|
166
|
+
previewPost(freeToolPreviewPostRequest: FreeToolPreviewPostRequest, options?: {
|
|
167
|
+
headers: {
|
|
168
|
+
[name: string]: string;
|
|
169
|
+
};
|
|
170
|
+
}): Promise<{
|
|
171
|
+
response: http.IncomingMessage;
|
|
172
|
+
body: FreeToolPreviewPostResponse;
|
|
173
|
+
}>;
|
|
154
174
|
splitThread(freeToolSplitThreadRequest: FreeToolSplitThreadRequest, options?: {
|
|
155
175
|
headers: {
|
|
156
176
|
[name: string]: string;
|