@simplyhomes/sos-sdk
Version:
TypeScript SDK for Simply Homes SoS API v4
353 lines (352 loc) • 18.5 kB
JavaScript
/* tslint:disable */
/* eslint-disable */
/**
* API v4
* Swagger documentation for API v4
*
* The version of the OpenAPI document: 4.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import * as runtime from '../runtime';
import { V4MessagesCreateMessageBodyDtoToJSON, V4MessagesCreateMessageResponseDtoFromJSON, V4MessagesDeleteMessageResponseDtoFromJSON, V4MessagesGetMessageResponseDtoFromJSON, V4MessagesGetMessagesFilteredByResponseDtoFromJSON, V4MessagesGetMessagesInViewResponseDtoFromJSON, V4MessagesGetMessagesResponseDtoFromJSON, V4MessagesGetUniqueValuesResponseDtoFromJSON, V4MessagesUpdateMessageBodyDtoToJSON, V4MessagesUpdateMessageResponseDtoFromJSON, } from '../models/index';
/**
*
*/
export class MessagesAPIV4Api extends runtime.BaseAPI {
/**
* Create a new message in the system. Supports @mention notifications. Can be called from SDK (JWT auth) or Lambda (API key + email query param). Returns the database message ID.
* Create a new message
*/
async v4MessagesControllerCreateMessageV4Raw(requestParameters, initOverrides) {
if (requestParameters['v4MessagesCreateMessageBodyDto'] == null) {
throw new runtime.RequiredError('v4MessagesCreateMessageBodyDto', 'Required parameter "v4MessagesCreateMessageBodyDto" was null or undefined when calling v4MessagesControllerCreateMessageV4().');
}
const queryParameters = {};
if (requestParameters['email'] != null) {
queryParameters['email'] = requestParameters['email'];
}
const headerParameters = {};
headerParameters['Content-Type'] = 'application/json';
if (this.configuration && this.configuration.apiKey) {
headerParameters["x-api-key"] = await this.configuration.apiKey("x-api-key"); // x-api-key authentication
}
if (this.configuration && this.configuration.apiKey) {
headerParameters["organization-id"] = await this.configuration.apiKey("organization-id"); // organization-id authentication
}
let urlPath = `/v4/messages`;
const response = await this.request({
path: urlPath,
method: 'POST',
headers: headerParameters,
query: queryParameters,
body: V4MessagesCreateMessageBodyDtoToJSON(requestParameters['v4MessagesCreateMessageBodyDto']),
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => V4MessagesCreateMessageResponseDtoFromJSON(jsonValue));
}
/**
* Create a new message in the system. Supports @mention notifications. Can be called from SDK (JWT auth) or Lambda (API key + email query param). Returns the database message ID.
* Create a new message
*/
async v4MessagesControllerCreateMessageV4(requestParameters, initOverrides) {
const response = await this.v4MessagesControllerCreateMessageV4Raw(requestParameters, initOverrides);
return await response.value();
}
/**
* Permanently delete a message from the system
* Delete a specific message by messageId
*/
async v4MessagesControllerDeleteMessageV4Raw(requestParameters, initOverrides) {
if (requestParameters['messageId'] == null) {
throw new runtime.RequiredError('messageId', 'Required parameter "messageId" was null or undefined when calling v4MessagesControllerDeleteMessageV4().');
}
const queryParameters = {};
const headerParameters = {};
if (this.configuration && this.configuration.apiKey) {
headerParameters["x-api-key"] = await this.configuration.apiKey("x-api-key"); // x-api-key authentication
}
if (this.configuration && this.configuration.apiKey) {
headerParameters["organization-id"] = await this.configuration.apiKey("organization-id"); // organization-id authentication
}
let urlPath = `/v4/messages/{messageId}`;
urlPath = urlPath.replace(`{${"messageId"}}`, encodeURIComponent(String(requestParameters['messageId'])));
const response = await this.request({
path: urlPath,
method: 'DELETE',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => V4MessagesDeleteMessageResponseDtoFromJSON(jsonValue));
}
/**
* Permanently delete a message from the system
* Delete a specific message by messageId
*/
async v4MessagesControllerDeleteMessageV4(requestParameters, initOverrides) {
const response = await this.v4MessagesControllerDeleteMessageV4Raw(requestParameters, initOverrides);
return await response.value();
}
/**
* Retrieve detailed information about a specific message
* Get a specific message by messageId
*/
async v4MessagesControllerGetMessageV4Raw(requestParameters, initOverrides) {
if (requestParameters['messageId'] == null) {
throw new runtime.RequiredError('messageId', 'Required parameter "messageId" was null or undefined when calling v4MessagesControllerGetMessageV4().');
}
const queryParameters = {};
if (requestParameters['viewId'] != null) {
queryParameters['viewId'] = requestParameters['viewId'];
}
const headerParameters = {};
if (this.configuration && this.configuration.apiKey) {
headerParameters["x-api-key"] = await this.configuration.apiKey("x-api-key"); // x-api-key authentication
}
if (this.configuration && this.configuration.apiKey) {
headerParameters["organization-id"] = await this.configuration.apiKey("organization-id"); // organization-id authentication
}
let urlPath = `/v4/messages/{messageId}`;
urlPath = urlPath.replace(`{${"messageId"}}`, encodeURIComponent(String(requestParameters['messageId'])));
const response = await this.request({
path: urlPath,
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => V4MessagesGetMessageResponseDtoFromJSON(jsonValue));
}
/**
* Retrieve detailed information about a specific message
* Get a specific message by messageId
*/
async v4MessagesControllerGetMessageV4(requestParameters, initOverrides) {
const response = await this.v4MessagesControllerGetMessageV4Raw(requestParameters, initOverrides);
return await response.value();
}
/**
* Retrieve messages filtered by column value with optional view and pagination
* Get messages filtered by a specific column and value
*/
async v4MessagesControllerGetMessagesFilteredByV4Raw(requestParameters, initOverrides) {
if (requestParameters['column'] == null) {
throw new runtime.RequiredError('column', 'Required parameter "column" was null or undefined when calling v4MessagesControllerGetMessagesFilteredByV4().');
}
if (requestParameters['value'] == null) {
throw new runtime.RequiredError('value', 'Required parameter "value" was null or undefined when calling v4MessagesControllerGetMessagesFilteredByV4().');
}
const queryParameters = {};
if (requestParameters['viewId'] != null) {
queryParameters['viewId'] = requestParameters['viewId'];
}
if (requestParameters['columns'] != null) {
queryParameters['columns'] = requestParameters['columns'];
}
if (requestParameters['limit'] != null) {
queryParameters['limit'] = requestParameters['limit'];
}
if (requestParameters['offset'] != null) {
queryParameters['offset'] = requestParameters['offset'];
}
if (requestParameters['countOnly'] != null) {
queryParameters['countOnly'] = requestParameters['countOnly'];
}
if (requestParameters['filterOperation'] != null) {
queryParameters['filterOperation'] = requestParameters['filterOperation'];
}
const headerParameters = {};
if (this.configuration && this.configuration.apiKey) {
headerParameters["x-api-key"] = await this.configuration.apiKey("x-api-key"); // x-api-key authentication
}
if (this.configuration && this.configuration.apiKey) {
headerParameters["organization-id"] = await this.configuration.apiKey("organization-id"); // organization-id authentication
}
let urlPath = `/v4/messages/filteredBy/{column}/{value}`;
urlPath = urlPath.replace(`{${"column"}}`, encodeURIComponent(String(requestParameters['column'])));
urlPath = urlPath.replace(`{${"value"}}`, encodeURIComponent(String(requestParameters['value'])));
const response = await this.request({
path: urlPath,
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => V4MessagesGetMessagesFilteredByResponseDtoFromJSON(jsonValue));
}
/**
* Retrieve messages filtered by column value with optional view and pagination
* Get messages filtered by a specific column and value
*/
async v4MessagesControllerGetMessagesFilteredByV4(requestParameters, initOverrides) {
const response = await this.v4MessagesControllerGetMessagesFilteredByV4Raw(requestParameters, initOverrides);
return await response.value();
}
/**
* Retrieve messages filtered by a specific view with pagination and count options
* Get messages with a specific viewId
*/
async v4MessagesControllerGetMessagesInViewV4Raw(requestParameters, initOverrides) {
if (requestParameters['viewId'] == null) {
throw new runtime.RequiredError('viewId', 'Required parameter "viewId" was null or undefined when calling v4MessagesControllerGetMessagesInViewV4().');
}
const queryParameters = {};
if (requestParameters['limit'] != null) {
queryParameters['limit'] = requestParameters['limit'];
}
if (requestParameters['offset'] != null) {
queryParameters['offset'] = requestParameters['offset'];
}
if (requestParameters['countOnly'] != null) {
queryParameters['countOnly'] = requestParameters['countOnly'];
}
const headerParameters = {};
if (this.configuration && this.configuration.apiKey) {
headerParameters["x-api-key"] = await this.configuration.apiKey("x-api-key"); // x-api-key authentication
}
if (this.configuration && this.configuration.apiKey) {
headerParameters["organization-id"] = await this.configuration.apiKey("organization-id"); // organization-id authentication
}
let urlPath = `/v4/messages/viewId/{viewId}`;
urlPath = urlPath.replace(`{${"viewId"}}`, encodeURIComponent(String(requestParameters['viewId'])));
const response = await this.request({
path: urlPath,
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => V4MessagesGetMessagesInViewResponseDtoFromJSON(jsonValue));
}
/**
* Retrieve messages filtered by a specific view with pagination and count options
* Get messages with a specific viewId
*/
async v4MessagesControllerGetMessagesInViewV4(requestParameters, initOverrides) {
const response = await this.v4MessagesControllerGetMessagesInViewV4Raw(requestParameters, initOverrides);
return await response.value();
}
/**
* Retrieve a list of messages with optional view filtering, pagination, and count options
* Get messages with optional viewId
*/
async v4MessagesControllerGetMessagesV4Raw(requestParameters, initOverrides) {
const queryParameters = {};
if (requestParameters['viewId'] != null) {
queryParameters['viewId'] = requestParameters['viewId'];
}
if (requestParameters['limit'] != null) {
queryParameters['limit'] = requestParameters['limit'];
}
if (requestParameters['offset'] != null) {
queryParameters['offset'] = requestParameters['offset'];
}
if (requestParameters['countOnly'] != null) {
queryParameters['countOnly'] = requestParameters['countOnly'];
}
const headerParameters = {};
if (this.configuration && this.configuration.apiKey) {
headerParameters["x-api-key"] = await this.configuration.apiKey("x-api-key"); // x-api-key authentication
}
if (this.configuration && this.configuration.apiKey) {
headerParameters["organization-id"] = await this.configuration.apiKey("organization-id"); // organization-id authentication
}
let urlPath = `/v4/messages`;
const response = await this.request({
path: urlPath,
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => V4MessagesGetMessagesResponseDtoFromJSON(jsonValue));
}
/**
* Retrieve a list of messages with optional view filtering, pagination, and count options
* Get messages with optional viewId
*/
async v4MessagesControllerGetMessagesV4(requestParameters = {}, initOverrides) {
const response = await this.v4MessagesControllerGetMessagesV4Raw(requestParameters, initOverrides);
return await response.value();
}
/**
* Retrieve unique values and their occurrence counts for a specified column
* Get unique values for a specific message column with counts
*/
async v4MessagesControllerGetUniqueValuesV4Raw(requestParameters, initOverrides) {
if (requestParameters['column'] == null) {
throw new runtime.RequiredError('column', 'Required parameter "column" was null or undefined when calling v4MessagesControllerGetUniqueValuesV4().');
}
const queryParameters = {};
if (requestParameters['limit'] != null) {
queryParameters['limit'] = requestParameters['limit'];
}
if (requestParameters['offset'] != null) {
queryParameters['offset'] = requestParameters['offset'];
}
if (requestParameters['viewId'] != null) {
queryParameters['viewId'] = requestParameters['viewId'];
}
const headerParameters = {};
if (this.configuration && this.configuration.apiKey) {
headerParameters["x-api-key"] = await this.configuration.apiKey("x-api-key"); // x-api-key authentication
}
if (this.configuration && this.configuration.apiKey) {
headerParameters["organization-id"] = await this.configuration.apiKey("organization-id"); // organization-id authentication
}
let urlPath = `/v4/messages/unique/{column}`;
urlPath = urlPath.replace(`{${"column"}}`, encodeURIComponent(String(requestParameters['column'])));
const response = await this.request({
path: urlPath,
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => V4MessagesGetUniqueValuesResponseDtoFromJSON(jsonValue));
}
/**
* Retrieve unique values and their occurrence counts for a specified column
* Get unique values for a specific message column with counts
*/
async v4MessagesControllerGetUniqueValuesV4(requestParameters, initOverrides) {
const response = await this.v4MessagesControllerGetUniqueValuesV4Raw(requestParameters, initOverrides);
return await response.value();
}
/**
* Update the content or properties of an existing message
* Update a specific message by messageId
*/
async v4MessagesControllerUpdateMessageV4Raw(requestParameters, initOverrides) {
if (requestParameters['messageId'] == null) {
throw new runtime.RequiredError('messageId', 'Required parameter "messageId" was null or undefined when calling v4MessagesControllerUpdateMessageV4().');
}
if (requestParameters['v4MessagesUpdateMessageBodyDto'] == null) {
throw new runtime.RequiredError('v4MessagesUpdateMessageBodyDto', 'Required parameter "v4MessagesUpdateMessageBodyDto" was null or undefined when calling v4MessagesControllerUpdateMessageV4().');
}
const queryParameters = {};
const headerParameters = {};
headerParameters['Content-Type'] = 'application/json';
if (this.configuration && this.configuration.apiKey) {
headerParameters["x-api-key"] = await this.configuration.apiKey("x-api-key"); // x-api-key authentication
}
if (this.configuration && this.configuration.apiKey) {
headerParameters["organization-id"] = await this.configuration.apiKey("organization-id"); // organization-id authentication
}
let urlPath = `/v4/messages/{messageId}`;
urlPath = urlPath.replace(`{${"messageId"}}`, encodeURIComponent(String(requestParameters['messageId'])));
const response = await this.request({
path: urlPath,
method: 'PATCH',
headers: headerParameters,
query: queryParameters,
body: V4MessagesUpdateMessageBodyDtoToJSON(requestParameters['v4MessagesUpdateMessageBodyDto']),
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => V4MessagesUpdateMessageResponseDtoFromJSON(jsonValue));
}
/**
* Update the content or properties of an existing message
* Update a specific message by messageId
*/
async v4MessagesControllerUpdateMessageV4(requestParameters, initOverrides) {
const response = await this.v4MessagesControllerUpdateMessageV4Raw(requestParameters, initOverrides);
return await response.value();
}
}