postboost 1.7.0 → 1.14.0

package/api/inboxApi.ts

@@ -0,0 +1,957 @@
+/**
+ * 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 { ApproveInboxReplyDraft403Response } from '../model/approveInboxReplyDraft403Response';
+import { CreateInboxReplyDraft201Response } from '../model/createInboxReplyDraft201Response';
+import { GetInboxConversation200Response } from '../model/getInboxConversation200Response';
+import { InboxConversationUpdate } from '../model/inboxConversationUpdate';
+import { InboxReplyDraftApprove } from '../model/inboxReplyDraftApprove';
+import { InboxReplyDraftEdit } from '../model/inboxReplyDraftEdit';
+import { InboxReplyDraftInput } from '../model/inboxReplyDraftInput';
+import { ListInboxConversations200Response } from '../model/listInboxConversations200Response';
+import { ListInboxReplyDrafts200Response } from '../model/listInboxReplyDrafts200Response';
+import { MessageOnly } from '../model/messageOnly';
+
+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 InboxApiApiKeys {
+}
+
+export class InboxApi {
+    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: InboxApiApiKeys, value: string) {
+        (this.authentications as any)[InboxApiApiKeys[key]].apiKey = value;
+    }
+
+    set accessToken(accessToken: string | (() => string)) {
+        this.authentications.bearerAuth.accessToken = accessToken;
+    }
+
+    public addInterceptor(interceptor: Interceptor) {
+        this.interceptors.push(interceptor);
+    }
+
+    /**
+     * Sends the draft to the network (optionally with an edited `body`). Ends as `sent`, or `failed` with `error`. Needs the `publish` ability; the API key that wrote the draft cannot approve it (`403`, `code: self_approval`). A draft is sent at most once: approving again returns `409`. Requires the inbox API to be enabled for the workspace (otherwise `404`). Admins and members only. 
+     * @summary Approve and send a reply draft
+     * @param workspaceUuid UUID of the workspace.
+     * @param draftId The draft &#x60;id&#x60;.
+     * @param inboxReplyDraftApprove 
+     */
+    public async approveInboxReplyDraft (workspaceUuid: string, draftId: string, inboxReplyDraftApprove?: InboxReplyDraftApprove, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body: CreateInboxReplyDraft201Response;  }> {
+        const localVarPath = this.basePath + '/{workspaceUuid}/inbox/drafts/{draftId}/approve'
+            .replace('{' + 'workspaceUuid' + '}', encodeURIComponent(String(workspaceUuid)))
+            .replace('{' + 'draftId' + '}', encodeURIComponent(String(draftId)));
+        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 approveInboxReplyDraft.');
+        }
+
+        // verify required parameter 'draftId' is not null or undefined
+        if (draftId === null || draftId === undefined) {
+            throw new Error('Required parameter draftId was null or undefined when calling approveInboxReplyDraft.');
+        }
+
+        (<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(inboxReplyDraftApprove, "InboxReplyDraftApprove")
+        };
+
+        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: CreateInboxReplyDraft201Response;  }>((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, "CreateInboxReplyDraft201Response");
+                            resolve({ response: response, body: body });
+                        } else {
+                            reject(new HttpError(response, body, response.statusCode));
+                        }
+                    }
+                });
+            });
+        });
+    }
+    /**
+     * Proposes a reply. Nothing is posted: a person approves the draft in the app (Reply drafts page) or another API key with the `publish` ability approves it. `in_reply_to` defaults to the latest incoming message. The body limit depends on the network (Bluesky 300, Mastodon 500, LinkedIn 1250, Google 4000). Needs the `write` ability. Requires the inbox API to be enabled for the workspace (otherwise `404`). Admins and members only. 
+     * @summary Draft a reply
+     * @param workspaceUuid UUID of the workspace.
+     * @param conversationId The conversation &#x60;id&#x60;.
+     * @param inboxReplyDraftInput 
+     */
+    public async createInboxReplyDraft (workspaceUuid: string, conversationId: string, inboxReplyDraftInput: InboxReplyDraftInput, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body: CreateInboxReplyDraft201Response;  }> {
+        const localVarPath = this.basePath + '/{workspaceUuid}/inbox/conversations/{conversationId}/drafts'
+            .replace('{' + 'workspaceUuid' + '}', encodeURIComponent(String(workspaceUuid)))
+            .replace('{' + 'conversationId' + '}', encodeURIComponent(String(conversationId)));
+        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 createInboxReplyDraft.');
+        }
+
+        // verify required parameter 'conversationId' is not null or undefined
+        if (conversationId === null || conversationId === undefined) {
+            throw new Error('Required parameter conversationId was null or undefined when calling createInboxReplyDraft.');
+        }
+
+        // verify required parameter 'inboxReplyDraftInput' is not null or undefined
+        if (inboxReplyDraftInput === null || inboxReplyDraftInput === undefined) {
+            throw new Error('Required parameter inboxReplyDraftInput was null or undefined when calling createInboxReplyDraft.');
+        }
+
+        (<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(inboxReplyDraftInput, "InboxReplyDraftInput")
+        };
+
+        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: CreateInboxReplyDraft201Response;  }>((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, "CreateInboxReplyDraft201Response");
+                            resolve({ response: response, body: body });
+                        } else {
+                            reject(new HttpError(response, body, response.statusCode));
+                        }
+                    }
+                });
+            });
+        });
+    }
+    /**
+     * Deletes a pending draft. `409` once it was reviewed. Requires the inbox API to be enabled for the workspace (otherwise `404`). Admins and members only. 
+     * @summary Withdraw a reply draft
+     * @param workspaceUuid UUID of the workspace.
+     * @param draftId The draft &#x60;id&#x60;.
+     */
+    public async deleteInboxReplyDraft (workspaceUuid: string, draftId: string, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body?: any;  }> {
+        const localVarPath = this.basePath + '/{workspaceUuid}/inbox/drafts/{draftId}'
+            .replace('{' + 'workspaceUuid' + '}', encodeURIComponent(String(workspaceUuid)))
+            .replace('{' + 'draftId' + '}', encodeURIComponent(String(draftId)));
+        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 deleteInboxReplyDraft.');
+        }
+
+        // verify required parameter 'draftId' is not null or undefined
+        if (draftId === null || draftId === undefined) {
+            throw new Error('Required parameter draftId was null or undefined when calling deleteInboxReplyDraft.');
+        }
+
+        (<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 conversation with its 50 most recent messages, oldest first. Requires the inbox API to be enabled for the workspace (otherwise `404`). Admins and members only. 
+     * @summary Get an inbox conversation
+     * @param workspaceUuid UUID of the workspace.
+     * @param conversationId The conversation &#x60;id&#x60;.
+     */
+    public async getInboxConversation (workspaceUuid: string, conversationId: string, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body: GetInboxConversation200Response;  }> {
+        const localVarPath = this.basePath + '/{workspaceUuid}/inbox/conversations/{conversationId}'
+            .replace('{' + 'workspaceUuid' + '}', encodeURIComponent(String(workspaceUuid)))
+            .replace('{' + 'conversationId' + '}', encodeURIComponent(String(conversationId)));
+        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 getInboxConversation.');
+        }
+
+        // verify required parameter 'conversationId' is not null or undefined
+        if (conversationId === null || conversationId === undefined) {
+            throw new Error('Required parameter conversationId was null or undefined when calling getInboxConversation.');
+        }
+
+        (<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: GetInboxConversation200Response;  }>((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, "GetInboxConversation200Response");
+                            resolve({ response: response, body: body });
+                        } else {
+                            reject(new HttpError(response, body, response.statusCode));
+                        }
+                    }
+                });
+            });
+        });
+    }
+    /**
+     * One draft. Poll it to see whether it was approved and sent. Requires the inbox API to be enabled for the workspace (otherwise `404`). Admins and members only. 
+     * @summary Get a reply draft
+     * @param workspaceUuid UUID of the workspace.
+     * @param draftId The draft &#x60;id&#x60;.
+     */
+    public async getInboxReplyDraft (workspaceUuid: string, draftId: string, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body: CreateInboxReplyDraft201Response;  }> {
+        const localVarPath = this.basePath + '/{workspaceUuid}/inbox/drafts/{draftId}'
+            .replace('{' + 'workspaceUuid' + '}', encodeURIComponent(String(workspaceUuid)))
+            .replace('{' + 'draftId' + '}', encodeURIComponent(String(draftId)));
+        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 getInboxReplyDraft.');
+        }
+
+        // verify required parameter 'draftId' is not null or undefined
+        if (draftId === null || draftId === undefined) {
+            throw new Error('Required parameter draftId was null or undefined when calling getInboxReplyDraft.');
+        }
+
+        (<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: CreateInboxReplyDraft201Response;  }>((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, "CreateInboxReplyDraft201Response");
+                            resolve({ response: response, body: body });
+                        } else {
+                            reject(new HttpError(response, body, response.statusCode));
+                        }
+                    }
+                });
+            });
+        });
+    }
+    /**
+     * Comments, mentions and reviews on your accounts, most recent activity first, 25 per page. Available for Bluesky, Mastodon, LinkedIn Pages and Google Business Profile. Requires the inbox API to be enabled for the workspace (otherwise `404`). Admins and members only. 
+     * @summary List inbox conversations
+     * @param workspaceUuid UUID of the workspace.
+     * @param status Conversation status.
+     * @param accountId Account &#x60;id&#x60;.
+     * @param provider Network, for example &#x60;bluesky&#x60;.
+     * @param unread Only unread (&#x60;true&#x60;) or read (&#x60;false&#x60;) conversations.
+     * @param sentiment AI sentiment.
+     * @param aiLabel AI label.
+     * @param since Only conversations with activity at or after this time.
+     * @param page Page number.
+     */
+    public async listInboxConversations (workspaceUuid: string, status?: 'open' | 'resolved', accountId?: number, provider?: string, unread?: boolean, sentiment?: 'negative' | 'neutral' | 'positive', aiLabel?: 'question' | 'complaint' | 'praise' | 'lead' | 'other', since?: Date, page?: number, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body: ListInboxConversations200Response;  }> {
+        const localVarPath = this.basePath + '/{workspaceUuid}/inbox/conversations'
+            .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 listInboxConversations.');
+        }
+
+        if (status !== undefined) {
+            localVarQueryParameters['status'] = ObjectSerializer.serialize(status, "'open' | 'resolved'");
+        }
+
+        if (accountId !== undefined) {
+            localVarQueryParameters['account_id'] = ObjectSerializer.serialize(accountId, "number");
+        }
+
+        if (provider !== undefined) {
+            localVarQueryParameters['provider'] = ObjectSerializer.serialize(provider, "string");
+        }
+
+        if (unread !== undefined) {
+            localVarQueryParameters['unread'] = ObjectSerializer.serialize(unread, "boolean");
+        }
+
+        if (sentiment !== undefined) {
+            localVarQueryParameters['sentiment'] = ObjectSerializer.serialize(sentiment, "'negative' | 'neutral' | 'positive'");
+        }
+
+        if (aiLabel !== undefined) {
+            localVarQueryParameters['ai_label'] = ObjectSerializer.serialize(aiLabel, "'question' | 'complaint' | 'praise' | 'lead' | 'other'");
+        }
+
+        if (since !== undefined) {
+            localVarQueryParameters['since'] = ObjectSerializer.serialize(since, "Date");
+        }
+
+        if (page !== undefined) {
+            localVarQueryParameters['page'] = ObjectSerializer.serialize(page, "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: ListInboxConversations200Response;  }>((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, "ListInboxConversations200Response");
+                            resolve({ response: response, body: body });
+                        } else {
+                            reject(new HttpError(response, body, response.statusCode));
+                        }
+                    }
+                });
+            });
+        });
+    }
+    /**
+     * Reply drafts, newest first, 25 per page. Requires the inbox API to be enabled for the workspace (otherwise `404`). Admins and members only. 
+     * @summary List reply drafts
+     * @param workspaceUuid UUID of the workspace.
+     * @param status Draft status.
+     * @param conversationId Only drafts for this conversation &#x60;id&#x60;.
+     * @param page Page number.
+     */
+    public async listInboxReplyDrafts (workspaceUuid: string, status?: 'pending' | 'approved' | 'rejected' | 'sent' | 'failed', conversationId?: string, page?: number, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body: ListInboxReplyDrafts200Response;  }> {
+        const localVarPath = this.basePath + '/{workspaceUuid}/inbox/drafts'
+            .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 listInboxReplyDrafts.');
+        }
+
+        if (status !== undefined) {
+            localVarQueryParameters['status'] = ObjectSerializer.serialize(status, "'pending' | 'approved' | 'rejected' | 'sent' | 'failed'");
+        }
+
+        if (conversationId !== undefined) {
+            localVarQueryParameters['conversation_id'] = ObjectSerializer.serialize(conversationId, "string");
+        }
+
+        if (page !== undefined) {
+            localVarQueryParameters['page'] = ObjectSerializer.serialize(page, "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: ListInboxReplyDrafts200Response;  }>((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, "ListInboxReplyDrafts200Response");
+                            resolve({ response: response, body: body });
+                        } else {
+                            reject(new HttpError(response, body, response.statusCode));
+                        }
+                    }
+                });
+            });
+        });
+    }
+    /**
+     * Rejects a pending draft; nothing is sent. Needs the `publish` ability. Requires the inbox API to be enabled for the workspace (otherwise `404`). Admins and members only. 
+     * @summary Reject a reply draft
+     * @param workspaceUuid UUID of the workspace.
+     * @param draftId The draft &#x60;id&#x60;.
+     */
+    public async rejectInboxReplyDraft (workspaceUuid: string, draftId: string, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body: CreateInboxReplyDraft201Response;  }> {
+        const localVarPath = this.basePath + '/{workspaceUuid}/inbox/drafts/{draftId}/reject'
+            .replace('{' + 'workspaceUuid' + '}', encodeURIComponent(String(workspaceUuid)))
+            .replace('{' + 'draftId' + '}', encodeURIComponent(String(draftId)));
+        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 rejectInboxReplyDraft.');
+        }
+
+        // verify required parameter 'draftId' is not null or undefined
+        if (draftId === null || draftId === undefined) {
+            throw new Error('Required parameter draftId was null or undefined when calling rejectInboxReplyDraft.');
+        }
+
+        (<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,
+        };
+
+        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: CreateInboxReplyDraft201Response;  }>((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, "CreateInboxReplyDraft201Response");
+                            resolve({ response: response, body: body });
+                        } else {
+                            reject(new HttpError(response, body, response.statusCode));
+                        }
+                    }
+                });
+            });
+        });
+    }
+    /**
+     * Marks the conversation open or resolved, read or unread. Requires the inbox API to be enabled for the workspace (otherwise `404`). Admins and members only. 
+     * @summary Update an inbox conversation
+     * @param workspaceUuid UUID of the workspace.
+     * @param conversationId The conversation &#x60;id&#x60;.
+     * @param inboxConversationUpdate 
+     */
+    public async updateInboxConversation (workspaceUuid: string, conversationId: string, inboxConversationUpdate: InboxConversationUpdate, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body: GetInboxConversation200Response;  }> {
+        const localVarPath = this.basePath + '/{workspaceUuid}/inbox/conversations/{conversationId}'
+            .replace('{' + 'workspaceUuid' + '}', encodeURIComponent(String(workspaceUuid)))
+            .replace('{' + 'conversationId' + '}', encodeURIComponent(String(conversationId)));
+        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 updateInboxConversation.');
+        }
+
+        // verify required parameter 'conversationId' is not null or undefined
+        if (conversationId === null || conversationId === undefined) {
+            throw new Error('Required parameter conversationId was null or undefined when calling updateInboxConversation.');
+        }
+
+        // verify required parameter 'inboxConversationUpdate' is not null or undefined
+        if (inboxConversationUpdate === null || inboxConversationUpdate === undefined) {
+            throw new Error('Required parameter inboxConversationUpdate was null or undefined when calling updateInboxConversation.');
+        }
+
+        (<any>Object).assign(localVarHeaderParams, options.headers);
+
+        let localVarUseFormData = false;
+
+        let localVarRequestOptions: localVarRequest.Options = {
+            method: 'PATCH',
+            qs: localVarQueryParameters,
+            headers: localVarHeaderParams,
+            uri: localVarPath,
+            useQuerystring: this._useQuerystring,
+            json: true,
+            body: ObjectSerializer.serialize(inboxConversationUpdate, "InboxConversationUpdate")
+        };
+
+        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: GetInboxConversation200Response;  }>((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, "GetInboxConversation200Response");
+                            resolve({ response: response, body: body });
+                        } else {
+                            reject(new HttpError(response, body, response.statusCode));
+                        }
+                    }
+                });
+            });
+        });
+    }
+    /**
+     * Changes the text of a pending draft. `409` once it was reviewed. Requires the inbox API to be enabled for the workspace (otherwise `404`). Admins and members only. 
+     * @summary Edit a reply draft
+     * @param workspaceUuid UUID of the workspace.
+     * @param draftId The draft &#x60;id&#x60;.
+     * @param inboxReplyDraftEdit 
+     */
+    public async updateInboxReplyDraft (workspaceUuid: string, draftId: string, inboxReplyDraftEdit: InboxReplyDraftEdit, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body: CreateInboxReplyDraft201Response;  }> {
+        const localVarPath = this.basePath + '/{workspaceUuid}/inbox/drafts/{draftId}'
+            .replace('{' + 'workspaceUuid' + '}', encodeURIComponent(String(workspaceUuid)))
+            .replace('{' + 'draftId' + '}', encodeURIComponent(String(draftId)));
+        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 updateInboxReplyDraft.');
+        }
+
+        // verify required parameter 'draftId' is not null or undefined
+        if (draftId === null || draftId === undefined) {
+            throw new Error('Required parameter draftId was null or undefined when calling updateInboxReplyDraft.');
+        }
+
+        // verify required parameter 'inboxReplyDraftEdit' is not null or undefined
+        if (inboxReplyDraftEdit === null || inboxReplyDraftEdit === undefined) {
+            throw new Error('Required parameter inboxReplyDraftEdit was null or undefined when calling updateInboxReplyDraft.');
+        }
+
+        (<any>Object).assign(localVarHeaderParams, options.headers);
+
+        let localVarUseFormData = false;
+
+        let localVarRequestOptions: localVarRequest.Options = {
+            method: 'PUT',
+            qs: localVarQueryParameters,
+            headers: localVarHeaderParams,
+            uri: localVarPath,
+            useQuerystring: this._useQuerystring,
+            json: true,
+            body: ObjectSerializer.serialize(inboxReplyDraftEdit, "InboxReplyDraftEdit")
+        };
+
+        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: CreateInboxReplyDraft201Response;  }>((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, "CreateInboxReplyDraft201Response");
+                            resolve({ response: response, body: body });
+                        } else {
+                            reject(new HttpError(response, body, response.statusCode));
+                        }
+                    }
+                });
+            });
+        });
+    }
+}