postboost 1.8.0 → 1.14.0

package/api/mediaApi.ts

@@ -1,8 +1,8 @@
 /**
  * PostBoost API
- * The PostBoost REST API lets you publish, schedule, and analyze social media posts across 12+ platforms from a single integration. No OAuth apps to maintain — PostBoost handles platform authorization for you.  ## Base URL All workspace-scoped endpoints are prefixed with `/{workspaceUuid}`. Panel/admin endpoints are prefixed with `/panel`.  ## Plan access Every workspace-scoped endpoint returns `403` when the workspace\'s plan does not include API access (capability `api`).  ## Dates and times Post dates and times (`date`, `time`, `accounts_schedule`) are read in the request\'s `timezone` when one is given, otherwise in the workspace timezone.  ## Authentication All requests require a Bearer token in the `Authorization` header. Generate tokens in your PostBoost dashboard under **Settings → Access Tokens**.  ``` Authorization: Bearer YOUR_API_TOKEN ``` 
+ * The PostBoost REST API lets you publish, schedule, and analyze social media posts across 12+ platforms from a single integration. No OAuth apps to maintain — PostBoost handles platform authorization for you.  ## Base URL All workspace-scoped endpoints are prefixed with `/{workspaceUuid}`. Panel/admin endpoints are prefixed with `/panel`.  ## Plan access Every workspace-scoped endpoint returns `403` when the workspace\'s plan does not include API access (capability `api`).  ## Dates and times Post dates and times (`date`, `time`, `accounts_schedule`) are read in the request\'s `timezone` when one is given, otherwise in the workspace timezone.  ## Idempotent requests Send an `Idempotency-Key` header (any unique string, for example a UUID) with a `POST`. Repeating the request with the same key within 24 hours returns the stored response with `Idempotent-Replayed: true` and creates nothing new. Reusing a key with a different body returns `422`; a request still in progress with the same key returns `409`. `5xx` and `429` responses are not stored, so they can be retried with the same key.  ## Guardrails for automated clients Create and update requests are checked before anything is written: a post whose content matches one created for the same account in the last 24 hours returns `409` (`code: duplicate_post`, override with `allow_duplicate: true`), scheduling past an account\'s daily cap returns `429` (`code: account_daily_cap_reached`), and scheduling to an account that must be reconnected returns `422` (`code: account_unauthorized` or `account_token_missing`). Use `POST /{workspaceUuid}/posts/validate` for a dry run and `GET /{workspaceUuid}/activity` to review what API clients did.  ## Authentication All requests require a Bearer token in the `Authorization` header. Generate tokens in your PostBoost dashboard under **Settings → Access Tokens**.  ``` Authorization: Bearer YOUR_API_TOKEN ``` 
  *
- * The version of the OpenAPI document: 1.8.0
+ * The version of the OpenAPI document: 1.14.0
  * Contact: hi@postboost.co
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -27,6 +27,7 @@ import { InitiateRemoteUploadRequest } from '../model/initiateRemoteUploadReques
 import { ListMedia200Response } from '../model/listMedia200Response';
 import { ListMediaFolders200Response } from '../model/listMediaFolders200Response';
 import { Media } from '../model/media';
+import { MediaBase64Input } from '../model/mediaBase64Input';
 import { MediaFolder } from '../model/mediaFolder';
 import { MediaFolderInput } from '../model/mediaFolderInput';
 import { UpdateMediaRequest } from '../model/updateMediaRequest';
@@ -271,8 +272,9 @@ export class MediaApi {
      * @summary Create media folder
      * @param workspaceUuid UUID of the workspace.
      * @param createMediaFolderRequest 
+     * @param idempotencyKey Unique key (for example a UUID) that makes the request safe to retry. A repeat with the same key and body within 24 hours returns the stored response with `Idempotent-Replayed: true` and has no further effect. Keys are scoped to your user, the workspace, the method and the path. 
      */
-    public async createMediaFolder (workspaceUuid: string, createMediaFolderRequest: CreateMediaFolderRequest, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body: MediaFolder;  }> {
+    public async createMediaFolder (workspaceUuid: string, createMediaFolderRequest: CreateMediaFolderRequest, idempotencyKey?: string, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body: MediaFolder;  }> {
         const localVarPath = this.basePath + '/{workspaceUuid}/media/folders'
             .replace('{' + 'workspaceUuid' + '}', encodeURIComponent(String(workspaceUuid)));
         let localVarQueryParameters: any = {};
@@ -296,6 +298,7 @@ export class MediaApi {
             throw new Error('Required parameter createMediaFolderRequest was null or undefined when calling createMediaFolder.');
         }
 
+        localVarHeaderParams['Idempotency-Key'] = ObjectSerializer.serialize(idempotencyKey, "string");
         (<any>Object).assign(localVarHeaderParams, options.headers);
 
         let localVarUseFormData = false;
@@ -668,8 +671,9 @@ export class MediaApi {
      * @summary Initiate chunked upload
      * @param workspaceUuid UUID of the workspace.
      * @param initiateChunkedUploadRequest 
+     * @param idempotencyKey Unique key (for example a UUID) that makes the request safe to retry. A repeat with the same key and body within 24 hours returns the stored response with &#x60;Idempotent-Replayed: true&#x60; and has no further effect. Keys are scoped to your user, the workspace, the method and the path. 
      */
-    public async initiateChunkedUpload (workspaceUuid: string, initiateChunkedUploadRequest: InitiateChunkedUploadRequest, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body: InitiateChunkedUpload201Response;  }> {
+    public async initiateChunkedUpload (workspaceUuid: string, initiateChunkedUploadRequest: InitiateChunkedUploadRequest, idempotencyKey?: string, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body: InitiateChunkedUpload201Response;  }> {
         const localVarPath = this.basePath + '/{workspaceUuid}/media/chunked/initiate'
             .replace('{' + 'workspaceUuid' + '}', encodeURIComponent(String(workspaceUuid)));
         let localVarQueryParameters: any = {};
@@ -693,6 +697,7 @@ export class MediaApi {
             throw new Error('Required parameter initiateChunkedUploadRequest was null or undefined when calling initiateChunkedUpload.');
         }
 
+        localVarHeaderParams['Idempotency-Key'] = ObjectSerializer.serialize(idempotencyKey, "string");
         (<any>Object).assign(localVarHeaderParams, options.headers);
 
         let localVarUseFormData = false;
@@ -747,8 +752,9 @@ export class MediaApi {
      * @summary Initiate remote upload
      * @param workspaceUuid UUID of the workspace.
      * @param initiateRemoteUploadRequest 
+     * @param idempotencyKey Unique key (for example a UUID) that makes the request safe to retry. A repeat with the same key and body within 24 hours returns the stored response with &#x60;Idempotent-Replayed: true&#x60; and has no further effect. Keys are scoped to your user, the workspace, the method and the path. 
      */
-    public async initiateRemoteUpload (workspaceUuid: string, initiateRemoteUploadRequest: InitiateRemoteUploadRequest, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body: InitiateRemoteUpload201Response;  }> {
+    public async initiateRemoteUpload (workspaceUuid: string, initiateRemoteUploadRequest: InitiateRemoteUploadRequest, idempotencyKey?: string, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body: InitiateRemoteUpload201Response;  }> {
         const localVarPath = this.basePath + '/{workspaceUuid}/media/remote/initiate'
             .replace('{' + 'workspaceUuid' + '}', encodeURIComponent(String(workspaceUuid)));
         let localVarQueryParameters: any = {};
@@ -772,6 +778,7 @@ export class MediaApi {
             throw new Error('Required parameter initiateRemoteUploadRequest was null or undefined when calling initiateRemoteUpload.');
         }
 
+        localVarHeaderParams['Idempotency-Key'] = ObjectSerializer.serialize(idempotencyKey, "string");
         (<any>Object).assign(localVarHeaderParams, options.headers);
 
         let localVarUseFormData = false;
@@ -1283,14 +1290,15 @@ export class MediaApi {
         });
     }
     /**
-     * Upload a file directly as multipart form data.
+     * Upload a file directly as multipart form data. Images and videos, plus a PDF (up to 100 MB) for LinkedIn document posts: a post that attaches a PDF must have it as the only media item and may only go to LinkedIn profiles and pages. 
      * @summary Upload media (binary)
      * @param workspaceUuid UUID of the workspace.
      * @param file The file to upload.
+     * @param idempotencyKey Unique key (for example a UUID) that makes the request safe to retry. A repeat with the same key and body within 24 hours returns the stored response with &#x60;Idempotent-Replayed: true&#x60; and has no further effect. Keys are scoped to your user, the workspace, the method and the path. 
      * @param altText Alternative text for accessibility.
      * @param folder UUID of the media folder to file the upload in. Omit or null for the library root.
      */
-    public async uploadMedia (workspaceUuid: string, file: RequestFile, altText?: string, folder?: string, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body: Media;  }> {
+    public async uploadMedia (workspaceUuid: string, file: RequestFile, idempotencyKey?: string, altText?: string, folder?: string, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body: Media;  }> {
         const localVarPath = this.basePath + '/{workspaceUuid}/media'
             .replace('{' + 'workspaceUuid' + '}', encodeURIComponent(String(workspaceUuid)));
         let localVarQueryParameters: any = {};
@@ -1314,6 +1322,7 @@ export class MediaApi {
             throw new Error('Required parameter file was null or undefined when calling uploadMedia.');
         }
 
+        localVarHeaderParams['Idempotency-Key'] = ObjectSerializer.serialize(idempotencyKey, "string");
         (<any>Object).assign(localVarHeaderParams, options.headers);
 
         let localVarUseFormData = false;
@@ -1351,6 +1360,87 @@ export class MediaApi {
             interceptorPromise = interceptorPromise.then(() => interceptor(localVarRequestOptions));
         }
 
+        return interceptorPromise.then(() => {
+            if (Object.keys(localVarFormParams).length) {
+                if (localVarUseFormData) {
+                    (<any>localVarRequestOptions).formData = localVarFormParams;
+                } else {
+                    localVarRequestOptions.form = localVarFormParams;
+                }
+            }
+            return new Promise<{ response: http.IncomingMessage; body: Media;  }>((resolve, reject) => {
+                localVarRequest(localVarRequestOptions, (error, response, body) => {
+                    if (error) {
+                        reject(error);
+                    } else {
+                        if (response.statusCode && response.statusCode >= 200 && response.statusCode <= 299) {
+                            body = ObjectSerializer.deserialize(body, "Media");
+                            resolve({ response: response, body: body });
+                        } else {
+                            reject(new HttpError(response, body, response.statusCode));
+                        }
+                    }
+                });
+            });
+        });
+    }
+    /**
+     * Upload a file as base64 inside a JSON body, for agents and tools that cannot send multipart form data. The decoded file is checked exactly like `POST media` (allowed types and size limits; a PDF is accepted for LinkedIn document posts). Decoded size is capped at 20 MB; for larger files use remote upload by URL or chunked upload. 
+     * @summary Upload media (base64 JSON)
+     * @param workspaceUuid UUID of the workspace.
+     * @param mediaBase64Input 
+     * @param idempotencyKey Unique key (for example a UUID) that makes the request safe to retry. A repeat with the same key and body within 24 hours returns the stored response with &#x60;Idempotent-Replayed: true&#x60; and has no further effect. Keys are scoped to your user, the workspace, the method and the path. 
+     */
+    public async uploadMediaBase64 (workspaceUuid: string, mediaBase64Input: MediaBase64Input, idempotencyKey?: string, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body: Media;  }> {
+        const localVarPath = this.basePath + '/{workspaceUuid}/media/base64'
+            .replace('{' + 'workspaceUuid' + '}', encodeURIComponent(String(workspaceUuid)));
+        let localVarQueryParameters: any = {};
+        let localVarHeaderParams: any = (<any>Object).assign({}, this._defaultHeaders);
+        const produces = ['application/json'];
+        // give precedence to 'application/json'
+        if (produces.indexOf('application/json') >= 0) {
+            localVarHeaderParams.Accept = 'application/json';
+        } else {
+            localVarHeaderParams.Accept = produces.join(',');
+        }
+        let localVarFormParams: any = {};
+
+        // verify required parameter 'workspaceUuid' is not null or undefined
+        if (workspaceUuid === null || workspaceUuid === undefined) {
+            throw new Error('Required parameter workspaceUuid was null or undefined when calling uploadMediaBase64.');
+        }
+
+        // verify required parameter 'mediaBase64Input' is not null or undefined
+        if (mediaBase64Input === null || mediaBase64Input === undefined) {
+            throw new Error('Required parameter mediaBase64Input was null or undefined when calling uploadMediaBase64.');
+        }
+
+        localVarHeaderParams['Idempotency-Key'] = ObjectSerializer.serialize(idempotencyKey, "string");
+        (<any>Object).assign(localVarHeaderParams, options.headers);
+
+        let localVarUseFormData = false;
+
+        let localVarRequestOptions: localVarRequest.Options = {
+            method: 'POST',
+            qs: localVarQueryParameters,
+            headers: localVarHeaderParams,
+            uri: localVarPath,
+            useQuerystring: this._useQuerystring,
+            json: true,
+            body: ObjectSerializer.serialize(mediaBase64Input, "MediaBase64Input")
+        };
+
+        let authenticationPromise = Promise.resolve();
+        if (this.authentications.bearerAuth.accessToken) {
+            authenticationPromise = authenticationPromise.then(() => this.authentications.bearerAuth.applyToRequest(localVarRequestOptions));
+        }
+        authenticationPromise = authenticationPromise.then(() => this.authentications.default.applyToRequest(localVarRequestOptions));
+
+        let interceptorPromise = authenticationPromise;
+        for (const interceptor of this.interceptors) {
+            interceptorPromise = interceptorPromise.then(() => interceptor(localVarRequestOptions));
+        }
+
         return interceptorPromise.then(() => {
             if (Object.keys(localVarFormParams).length) {
                 if (localVarUseFormData) {

package/api/mentionsApi.ts

@@ -1,8 +1,8 @@
 /**
  * PostBoost API
- * The PostBoost REST API lets you publish, schedule, and analyze social media posts across 12+ platforms from a single integration. No OAuth apps to maintain — PostBoost handles platform authorization for you.  ## Base URL All workspace-scoped endpoints are prefixed with `/{workspaceUuid}`. Panel/admin endpoints are prefixed with `/panel`.  ## Plan access Every workspace-scoped endpoint returns `403` when the workspace\'s plan does not include API access (capability `api`).  ## Dates and times Post dates and times (`date`, `time`, `accounts_schedule`) are read in the request\'s `timezone` when one is given, otherwise in the workspace timezone.  ## Authentication All requests require a Bearer token in the `Authorization` header. Generate tokens in your PostBoost dashboard under **Settings → Access Tokens**.  ``` Authorization: Bearer YOUR_API_TOKEN ``` 
+ * The PostBoost REST API lets you publish, schedule, and analyze social media posts across 12+ platforms from a single integration. No OAuth apps to maintain — PostBoost handles platform authorization for you.  ## Base URL All workspace-scoped endpoints are prefixed with `/{workspaceUuid}`. Panel/admin endpoints are prefixed with `/panel`.  ## Plan access Every workspace-scoped endpoint returns `403` when the workspace\'s plan does not include API access (capability `api`).  ## Dates and times Post dates and times (`date`, `time`, `accounts_schedule`) are read in the request\'s `timezone` when one is given, otherwise in the workspace timezone.  ## Idempotent requests Send an `Idempotency-Key` header (any unique string, for example a UUID) with a `POST`. Repeating the request with the same key within 24 hours returns the stored response with `Idempotent-Replayed: true` and creates nothing new. Reusing a key with a different body returns `422`; a request still in progress with the same key returns `409`. `5xx` and `429` responses are not stored, so they can be retried with the same key.  ## Guardrails for automated clients Create and update requests are checked before anything is written: a post whose content matches one created for the same account in the last 24 hours returns `409` (`code: duplicate_post`, override with `allow_duplicate: true`), scheduling past an account\'s daily cap returns `429` (`code: account_daily_cap_reached`), and scheduling to an account that must be reconnected returns `422` (`code: account_unauthorized` or `account_token_missing`). Use `POST /{workspaceUuid}/posts/validate` for a dry run and `GET /{workspaceUuid}/activity` to review what API clients did.  ## Authentication All requests require a Bearer token in the `Authorization` header. Generate tokens in your PostBoost dashboard under **Settings → Access Tokens**.  ``` Authorization: Bearer YOUR_API_TOKEN ``` 
  *
- * The version of the OpenAPI document: 1.8.0
+ * The version of the OpenAPI document: 1.14.0
  * Contact: hi@postboost.co
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -99,8 +99,9 @@ export class MentionsApi {
      * @summary Create mention
      * @param workspaceUuid UUID of the workspace.
      * @param mentionInput 
+     * @param idempotencyKey Unique key (for example a UUID) that makes the request safe to retry. A repeat with the same key and body within 24 hours returns the stored response with `Idempotent-Replayed: true` and has no further effect. Keys are scoped to your user, the workspace, the method and the path. 
      */
-    public async createMention (workspaceUuid: string, mentionInput: MentionInput, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body: CreateMention201Response;  }> {
+    public async createMention (workspaceUuid: string, mentionInput: MentionInput, idempotencyKey?: string, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body: CreateMention201Response;  }> {
         const localVarPath = this.basePath + '/{workspaceUuid}/mentions'
             .replace('{' + 'workspaceUuid' + '}', encodeURIComponent(String(workspaceUuid)));
         let localVarQueryParameters: any = {};
@@ -124,6 +125,7 @@ export class MentionsApi {
             throw new Error('Required parameter mentionInput was null or undefined when calling createMention.');
         }
 
+        localVarHeaderParams['Idempotency-Key'] = ObjectSerializer.serialize(idempotencyKey, "string");
         (<any>Object).assign(localVarHeaderParams, options.headers);
 
         let localVarUseFormData = false;