@simplyhomes/sos-sdk
Version:
TypeScript SDK for Simply Homes SoS API v4
303 lines (302 loc) • 15.4 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 { V4WorkOrdersCreateWorkOrderBodyDtoToJSON, V4WorkOrdersCreateWorkOrderResponseDtoFromJSON, V4WorkOrdersDeleteWorkOrderResponseDtoFromJSON, V4WorkOrdersGetUniqueValuesResponseDtoFromJSON, V4WorkOrdersGetWorkOrderResponseDtoFromJSON, V4WorkOrdersGetWorkOrdersInViewResponseDtoFromJSON, V4WorkOrdersGetWorkOrdersResponseDtoFromJSON, V4WorkOrdersUpdateWorkOrderBodyDtoToJSON, V4WorkOrdersUpdateWorkOrderResponseDtoFromJSON, } from '../models/index';
/**
*
*/
export class WorkOrdersAPIV4Api extends runtime.BaseAPI {
/**
* Create a new work order in the system
* Create a new work order
*/
async v4WorkOrdersControllerCreateWorkOrderV4Raw(requestParameters, initOverrides) {
if (requestParameters['v4WorkOrdersCreateWorkOrderBodyDto'] == null) {
throw new runtime.RequiredError('v4WorkOrdersCreateWorkOrderBodyDto', 'Required parameter "v4WorkOrdersCreateWorkOrderBodyDto" was null or undefined when calling v4WorkOrdersControllerCreateWorkOrderV4().');
}
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/work-orders`;
const response = await this.request({
path: urlPath,
method: 'POST',
headers: headerParameters,
query: queryParameters,
body: V4WorkOrdersCreateWorkOrderBodyDtoToJSON(requestParameters['v4WorkOrdersCreateWorkOrderBodyDto']),
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => V4WorkOrdersCreateWorkOrderResponseDtoFromJSON(jsonValue));
}
/**
* Create a new work order in the system
* Create a new work order
*/
async v4WorkOrdersControllerCreateWorkOrderV4(requestParameters, initOverrides) {
const response = await this.v4WorkOrdersControllerCreateWorkOrderV4Raw(requestParameters, initOverrides);
return await response.value();
}
/**
* Remove a work order from the system
* Delete a work order
*/
async v4WorkOrdersControllerDeleteWorkOrderV4Raw(requestParameters, initOverrides) {
if (requestParameters['workOrderId'] == null) {
throw new runtime.RequiredError('workOrderId', 'Required parameter "workOrderId" was null or undefined when calling v4WorkOrdersControllerDeleteWorkOrderV4().');
}
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/work-orders/{workOrderId}`;
urlPath = urlPath.replace(`{${"workOrderId"}}`, encodeURIComponent(String(requestParameters['workOrderId'])));
const response = await this.request({
path: urlPath,
method: 'DELETE',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => V4WorkOrdersDeleteWorkOrderResponseDtoFromJSON(jsonValue));
}
/**
* Remove a work order from the system
* Delete a work order
*/
async v4WorkOrdersControllerDeleteWorkOrderV4(requestParameters, initOverrides) {
const response = await this.v4WorkOrdersControllerDeleteWorkOrderV4Raw(requestParameters, initOverrides);
return await response.value();
}
/**
* Retrieve unique values and their counts for a specific work order column
* Get unique values for a specific column
*/
async v4WorkOrdersControllerGetUniqueValuesV4Raw(requestParameters, initOverrides) {
if (requestParameters['column'] == null) {
throw new runtime.RequiredError('column', 'Required parameter "column" was null or undefined when calling v4WorkOrdersControllerGetUniqueValuesV4().');
}
const queryParameters = {};
if (requestParameters['viewId'] != null) {
queryParameters['viewId'] = requestParameters['viewId'];
}
if (requestParameters['offset'] != null) {
queryParameters['offset'] = requestParameters['offset'];
}
if (requestParameters['limit'] != null) {
queryParameters['limit'] = requestParameters['limit'];
}
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/work-orders/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) => V4WorkOrdersGetUniqueValuesResponseDtoFromJSON(jsonValue));
}
/**
* Retrieve unique values and their counts for a specific work order column
* Get unique values for a specific column
*/
async v4WorkOrdersControllerGetUniqueValuesV4(requestParameters, initOverrides) {
const response = await this.v4WorkOrdersControllerGetUniqueValuesV4Raw(requestParameters, initOverrides);
return await response.value();
}
/**
* Retrieve a single work order with optional view filtering
* Get a single work order by ID
*/
async v4WorkOrdersControllerGetWorkOrderV4Raw(requestParameters, initOverrides) {
if (requestParameters['workOrderId'] == null) {
throw new runtime.RequiredError('workOrderId', 'Required parameter "workOrderId" was null or undefined when calling v4WorkOrdersControllerGetWorkOrderV4().');
}
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/work-orders/{workOrderId}`;
urlPath = urlPath.replace(`{${"workOrderId"}}`, encodeURIComponent(String(requestParameters['workOrderId'])));
const response = await this.request({
path: urlPath,
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => V4WorkOrdersGetWorkOrderResponseDtoFromJSON(jsonValue));
}
/**
* Retrieve a single work order with optional view filtering
* Get a single work order by ID
*/
async v4WorkOrdersControllerGetWorkOrderV4(requestParameters, initOverrides) {
const response = await this.v4WorkOrdersControllerGetWorkOrderV4Raw(requestParameters, initOverrides);
return await response.value();
}
/**
* Retrieve work orders filtered by a specific view configuration
* Get work orders with a specific viewId
*/
async v4WorkOrdersControllerGetWorkOrdersInViewV4Raw(requestParameters, initOverrides) {
if (requestParameters['viewId'] == null) {
throw new runtime.RequiredError('viewId', 'Required parameter "viewId" was null or undefined when calling v4WorkOrdersControllerGetWorkOrdersInViewV4().');
}
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/work-orders/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) => V4WorkOrdersGetWorkOrdersInViewResponseDtoFromJSON(jsonValue));
}
/**
* Retrieve work orders filtered by a specific view configuration
* Get work orders with a specific viewId
*/
async v4WorkOrdersControllerGetWorkOrdersInViewV4(requestParameters, initOverrides) {
const response = await this.v4WorkOrdersControllerGetWorkOrdersInViewV4Raw(requestParameters, initOverrides);
return await response.value();
}
/**
* Retrieve a list of work orders with optional view filtering
* Get work orders with optional viewId
*/
async v4WorkOrdersControllerGetWorkOrdersV4Raw(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/work-orders`;
const response = await this.request({
path: urlPath,
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => V4WorkOrdersGetWorkOrdersResponseDtoFromJSON(jsonValue));
}
/**
* Retrieve a list of work orders with optional view filtering
* Get work orders with optional viewId
*/
async v4WorkOrdersControllerGetWorkOrdersV4(requestParameters = {}, initOverrides) {
const response = await this.v4WorkOrdersControllerGetWorkOrdersV4Raw(requestParameters, initOverrides);
return await response.value();
}
/**
* Update work order details
* Update an existing work order
*/
async v4WorkOrdersControllerUpdateWorkOrderV4Raw(requestParameters, initOverrides) {
if (requestParameters['workOrderId'] == null) {
throw new runtime.RequiredError('workOrderId', 'Required parameter "workOrderId" was null or undefined when calling v4WorkOrdersControllerUpdateWorkOrderV4().');
}
if (requestParameters['v4WorkOrdersUpdateWorkOrderBodyDto'] == null) {
throw new runtime.RequiredError('v4WorkOrdersUpdateWorkOrderBodyDto', 'Required parameter "v4WorkOrdersUpdateWorkOrderBodyDto" was null or undefined when calling v4WorkOrdersControllerUpdateWorkOrderV4().');
}
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/work-orders/{workOrderId}`;
urlPath = urlPath.replace(`{${"workOrderId"}}`, encodeURIComponent(String(requestParameters['workOrderId'])));
const response = await this.request({
path: urlPath,
method: 'PATCH',
headers: headerParameters,
query: queryParameters,
body: V4WorkOrdersUpdateWorkOrderBodyDtoToJSON(requestParameters['v4WorkOrdersUpdateWorkOrderBodyDto']),
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => V4WorkOrdersUpdateWorkOrderResponseDtoFromJSON(jsonValue));
}
/**
* Update work order details
* Update an existing work order
*/
async v4WorkOrdersControllerUpdateWorkOrderV4(requestParameters, initOverrides) {
const response = await this.v4WorkOrdersControllerUpdateWorkOrderV4Raw(requestParameters, initOverrides);
return await response.value();
}
}