postboost 1.7.0 → 1.14.0

package/api/apis.ts

@@ -1,9 +1,27 @@
 export * from './aIApi';
 import { AIApi } from './aIApi';
+export * from './accountGroupsApi';
+import { AccountGroupsApi } from './accountGroupsApi';
 export * from './accountsApi';
 import { AccountsApi } from './accountsApi';
+export * from './activityApi';
+import { ActivityApi } from './activityApi';
+export * from './agentsApi';
+import { AgentsApi } from './agentsApi';
+export * from './analyticsApi';
+import { AnalyticsApi } from './analyticsApi';
+export * from './competitorsApi';
+import { CompetitorsApi } from './competitorsApi';
+export * from './hashtagGroupsApi';
+import { HashtagGroupsApi } from './hashtagGroupsApi';
+export * from './inboxApi';
+import { InboxApi } from './inboxApi';
 export * from './mediaApi';
 import { MediaApi } from './mediaApi';
+export * from './mentionsApi';
+import { MentionsApi } from './mentionsApi';
+export * from './postingScheduleApi';
+import { PostingScheduleApi } from './postingScheduleApi';
 export * from './postsApi';
 import { PostsApi } from './postsApi';
 export * from './receiptsApi';
@@ -12,8 +30,12 @@ export * from './subscriptionsApi';
 import { SubscriptionsApi } from './subscriptionsApi';
 export * from './tagsApi';
 import { TagsApi } from './tagsApi';
+export * from './templatesApi';
+import { TemplatesApi } from './templatesApi';
 export * from './usersApi';
 import { UsersApi } from './usersApi';
+export * from './webhooksApi';
+import { WebhooksApi } from './webhooksApi';
 export * from './workspacesApi';
 import { WorkspacesApi } from './workspacesApi';
 import * as http from 'http';
@@ -27,4 +49,4 @@ export class HttpError extends Error {
 
 export { RequestFile } from '../model/models';
 
-export const APIS = [AIApi, AccountsApi, MediaApi, PostsApi, ReceiptsApi, SubscriptionsApi, TagsApi, UsersApi, WorkspacesApi];
+export const APIS = [AIApi, AccountGroupsApi, AccountsApi, ActivityApi, AgentsApi, AnalyticsApi, CompetitorsApi, HashtagGroupsApi, InboxApi, MediaApi, MentionsApi, PostingScheduleApi, PostsApi, ReceiptsApi, SubscriptionsApi, TagsApi, TemplatesApi, UsersApi, WebhooksApi, WorkspacesApi];

package/api/competitorsApi.ts

@@ -0,0 +1,412 @@
+/**
+ * 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.  ## 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.14.0
+ * Contact: hi@postboost.co
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+import localVarRequest from 'request';
+import http from 'http';
+
+/* tslint:disable:no-unused-locals */
+import { AddCompetitor202Response } from '../model/addCompetitor202Response';
+import { AddCompetitor409Response } from '../model/addCompetitor409Response';
+import { CompetitorInput } from '../model/competitorInput';
+import { GetCompetitor200Response } from '../model/getCompetitor200Response';
+import { ListCompetitors200Response } from '../model/listCompetitors200Response';
+
+import { ObjectSerializer, Authentication, VoidAuth, Interceptor } from '../model/models';
+import { HttpBasicAuth, HttpBearerAuth, ApiKeyAuth, OAuth } from '../model/models';
+
+import { HttpError, RequestFile } from './apis';
+
+let defaultBasePath = 'https://postboost.co/app/api';
+
+// ===============================================
+// This file is autogenerated - Please do not edit
+// ===============================================
+
+export enum CompetitorsApiApiKeys {
+}
+
+export class CompetitorsApi {
+    protected _basePath = defaultBasePath;
+    protected _defaultHeaders : any = {};
+    protected _useQuerystring : boolean = false;
+
+    protected authentications = {
+        'default': <Authentication>new VoidAuth(),
+        'bearerAuth': new HttpBearerAuth(),
+    }
+
+    protected interceptors: Interceptor[] = [];
+
+    constructor(basePath?: string);
+    constructor(basePathOrUsername: string, password?: string, basePath?: string) {
+        if (password) {
+            if (basePath) {
+                this.basePath = basePath;
+            }
+        } else {
+            if (basePathOrUsername) {
+                this.basePath = basePathOrUsername
+            }
+        }
+    }
+
+    set useQuerystring(value: boolean) {
+        this._useQuerystring = value;
+    }
+
+    set basePath(basePath: string) {
+        this._basePath = basePath;
+    }
+
+    set defaultHeaders(defaultHeaders: any) {
+        this._defaultHeaders = defaultHeaders;
+    }
+
+    get defaultHeaders() {
+        return this._defaultHeaders;
+    }
+
+    get basePath() {
+        return this._basePath;
+    }
+
+    public setDefaultAuthentication(auth: Authentication) {
+        this.authentications.default = auth;
+    }
+
+    public setApiKey(key: CompetitorsApiApiKeys, value: string) {
+        (this.authentications as any)[CompetitorsApiApiKeys[key]].apiKey = value;
+    }
+
+    set accessToken(accessToken: string | (() => string)) {
+        this.authentications.bearerAuth.accessToken = accessToken;
+    }
+
+    public addInterceptor(interceptor: Interceptor) {
+        this.interceptors.push(interceptor);
+    }
+
+    /**
+     * Starts tracking a public Instagram business or creator account from one of your Instagram accounts (connected through a Facebook Page). Returns `202` at once; followers, snapshots and recent media appear after the background import. `409` if that account already tracks the username. Admins and members only (not viewers). 
+     * @summary Track a competitor
+     * @param workspaceUuid UUID of the workspace.
+     * @param competitorInput 
+     */
+    public async addCompetitor (workspaceUuid: string, competitorInput: CompetitorInput, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body: AddCompetitor202Response;  }> {
+        const localVarPath = this.basePath + '/{workspaceUuid}/competitors'
+            .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 addCompetitor.');
+        }
+
+        // verify required parameter 'competitorInput' is not null or undefined
+        if (competitorInput === null || competitorInput === undefined) {
+            throw new Error('Required parameter competitorInput was null or undefined when calling addCompetitor.');
+        }
+
+        (<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(competitorInput, "CompetitorInput")
+        };
+
+        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) {
+                    (<any>localVarRequestOptions).formData = localVarFormParams;
+                } else {
+                    localVarRequestOptions.form = localVarFormParams;
+                }
+            }
+            return new Promise<{ response: http.IncomingMessage; body: AddCompetitor202Response;  }>((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, "AddCompetitor202Response");
+                            resolve({ response: response, body: body });
+                        } else {
+                            reject(new HttpError(response, body, response.statusCode));
+                        }
+                    }
+                });
+            });
+        });
+    }
+    /**
+     * Deletes the competitor with its snapshots and media. Admins and members only (not viewers). 
+     * @summary Stop tracking a competitor
+     * @param workspaceUuid UUID of the workspace.
+     * @param competitorId The competitor &#x60;id&#x60;.
+     */
+    public async deleteCompetitor (workspaceUuid: string, competitorId: number, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body?: any;  }> {
+        const localVarPath = this.basePath + '/{workspaceUuid}/competitors/{competitorId}'
+            .replace('{' + 'workspaceUuid' + '}', encodeURIComponent(String(workspaceUuid)))
+            .replace('{' + 'competitorId' + '}', encodeURIComponent(String(competitorId)));
+        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 deleteCompetitor.');
+        }
+
+        // verify required parameter 'competitorId' is not null or undefined
+        if (competitorId === null || competitorId === undefined) {
+            throw new Error('Required parameter competitorId was null or undefined when calling deleteCompetitor.');
+        }
+
+        (<any>Object).assign(localVarHeaderParams, options.headers);
+
+        let localVarUseFormData = false;
+
+        let localVarRequestOptions: localVarRequest.Options = {
+            method: 'DELETE',
+            qs: localVarQueryParameters,
+            headers: localVarHeaderParams,
+            uri: localVarPath,
+            useQuerystring: this._useQuerystring,
+            json: true,
+        };
+
+        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) {
+                    (<any>localVarRequestOptions).formData = localVarFormParams;
+                } else {
+                    localVarRequestOptions.form = localVarFormParams;
+                }
+            }
+            return new Promise<{ response: http.IncomingMessage; body?: any;  }>((resolve, reject) => {
+                localVarRequest(localVarRequestOptions, (error, response, body) => {
+                    if (error) {
+                        reject(error);
+                    } else {
+                        if (response.statusCode && response.statusCode >= 200 && response.statusCode <= 299) {
+                            resolve({ response: response, body: body });
+                        } else {
+                            reject(new HttpError(response, body, response.statusCode));
+                        }
+                    }
+                });
+            });
+        });
+    }
+    /**
+     * The competitor with daily follower snapshots for the last 90 days and its 12 most recent posts. 
+     * @summary Get a competitor
+     * @param workspaceUuid UUID of the workspace.
+     * @param competitorId The competitor &#x60;id&#x60;.
+     */
+    public async getCompetitor (workspaceUuid: string, competitorId: number, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body: GetCompetitor200Response;  }> {
+        const localVarPath = this.basePath + '/{workspaceUuid}/competitors/{competitorId}'
+            .replace('{' + 'workspaceUuid' + '}', encodeURIComponent(String(workspaceUuid)))
+            .replace('{' + 'competitorId' + '}', encodeURIComponent(String(competitorId)));
+        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 getCompetitor.');
+        }
+
+        // verify required parameter 'competitorId' is not null or undefined
+        if (competitorId === null || competitorId === undefined) {
+            throw new Error('Required parameter competitorId was null or undefined when calling getCompetitor.');
+        }
+
+        (<any>Object).assign(localVarHeaderParams, options.headers);
+
+        let localVarUseFormData = false;
+
+        let localVarRequestOptions: localVarRequest.Options = {
+            method: 'GET',
+            qs: localVarQueryParameters,
+            headers: localVarHeaderParams,
+            uri: localVarPath,
+            useQuerystring: this._useQuerystring,
+            json: true,
+        };
+
+        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) {
+                    (<any>localVarRequestOptions).formData = localVarFormParams;
+                } else {
+                    localVarRequestOptions.form = localVarFormParams;
+                }
+            }
+            return new Promise<{ response: http.IncomingMessage; body: GetCompetitor200Response;  }>((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, "GetCompetitor200Response");
+                            resolve({ response: response, body: body });
+                        } else {
+                            reject(new HttpError(response, body, response.statusCode));
+                        }
+                    }
+                });
+            });
+        });
+    }
+    /**
+     * Instagram business or creator accounts the workspace tracks, by follower count. 
+     * @summary List competitors
+     * @param workspaceUuid UUID of the workspace.
+     * @param accountId Only competitors tracked from this Instagram account &#x60;id&#x60;.
+     */
+    public async listCompetitors (workspaceUuid: string, accountId?: number, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body: ListCompetitors200Response;  }> {
+        const localVarPath = this.basePath + '/{workspaceUuid}/competitors'
+            .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 listCompetitors.');
+        }
+
+        if (accountId !== undefined) {
+            localVarQueryParameters['account_id'] = ObjectSerializer.serialize(accountId, "number");
+        }
+
+        (<any>Object).assign(localVarHeaderParams, options.headers);
+
+        let localVarUseFormData = false;
+
+        let localVarRequestOptions: localVarRequest.Options = {
+            method: 'GET',
+            qs: localVarQueryParameters,
+            headers: localVarHeaderParams,
+            uri: localVarPath,
+            useQuerystring: this._useQuerystring,
+            json: true,
+        };
+
+        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) {
+                    (<any>localVarRequestOptions).formData = localVarFormParams;
+                } else {
+                    localVarRequestOptions.form = localVarFormParams;
+                }
+            }
+            return new Promise<{ response: http.IncomingMessage; body: ListCompetitors200Response;  }>((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, "ListCompetitors200Response");
+                            resolve({ response: response, body: body });
+                        } else {
+                            reject(new HttpError(response, body, response.statusCode));
+                        }
+                    }
+                });
+            });
+        });
+    }
+}