@simplyhomes/sos-sdk
Version:
TypeScript SDK for Simply Homes SoS API v4
55 lines • 3.11 kB
TypeScript
import type { Configuration } from '../generated';
import { WorkOrdersAPIV4Api } from '../generated';
import type { V4WorkOrdersControllerDeleteWorkOrderV4Request, V4WorkOrdersControllerGetUniqueValuesV4Request, V4WorkOrdersControllerGetWorkOrderV4Request, V4WorkOrdersControllerGetWorkOrdersInViewV4Request, V4WorkOrdersControllerGetWorkOrdersV4Request, V4WorkOrdersControllerUpdateWorkOrderV4Request, V4WorkOrdersCreateWorkOrderBodyDto, V4WorkOrdersCreateWorkOrderResponseDto, V4WorkOrdersDeleteWorkOrderResponseDto, V4WorkOrdersGetUniqueValuesResponseDto, V4WorkOrdersGetWorkOrderResponseDto, V4WorkOrdersGetWorkOrdersInViewResponseDto, V4WorkOrdersGetWorkOrdersResponseDto, V4WorkOrdersUpdateWorkOrderBodyDto, V4WorkOrdersUpdateWorkOrderResponseDto } from '../generated';
export declare class WorkOrders {
readonly list: WorkOrdersList;
readonly create: WorkOrdersCreate;
readonly update: WorkOrdersUpdate;
readonly delete: WorkOrdersDelete;
constructor(config: Configuration);
}
export declare class WorkOrdersList {
private api;
constructor(api: WorkOrdersAPIV4Api);
/**
* uniqueValues - get /v4/work-orders/unique/{column}
*/
uniqueValues(column: V4WorkOrdersControllerGetUniqueValuesV4Request['column'], options?: Omit<V4WorkOrdersControllerGetUniqueValuesV4Request, 'column'>): Promise<V4WorkOrdersGetUniqueValuesResponseDto>;
/**
* one - get /v4/work-orders/{workOrderId}
*/
one(workOrderId: V4WorkOrdersControllerGetWorkOrderV4Request['workOrderId'], options?: Omit<V4WorkOrdersControllerGetWorkOrderV4Request, 'workOrderId'>): Promise<V4WorkOrdersGetWorkOrderResponseDto>;
/**
* all - get /v4/work-orders
*/
all(options?: V4WorkOrdersControllerGetWorkOrdersV4Request): Promise<V4WorkOrdersGetWorkOrdersResponseDto>;
/**
* withView - get /v4/work-orders/viewId/{viewId}
*/
withView(viewId: V4WorkOrdersControllerGetWorkOrdersInViewV4Request['viewId'], options?: Omit<V4WorkOrdersControllerGetWorkOrdersInViewV4Request, 'viewId'>): Promise<V4WorkOrdersGetWorkOrdersInViewResponseDto>;
}
export declare class WorkOrdersCreate {
private api;
constructor(api: WorkOrdersAPIV4Api);
/**
* one - post /v4/work-orders
*/
one(body: V4WorkOrdersCreateWorkOrderBodyDto): Promise<V4WorkOrdersCreateWorkOrderResponseDto>;
}
export declare class WorkOrdersUpdate {
private api;
constructor(api: WorkOrdersAPIV4Api);
/**
* one - patch /v4/work-orders/{workOrderId}
*/
one(workOrderId: V4WorkOrdersControllerUpdateWorkOrderV4Request['workOrderId'], body: V4WorkOrdersUpdateWorkOrderBodyDto): Promise<V4WorkOrdersUpdateWorkOrderResponseDto>;
}
export declare class WorkOrdersDelete {
private api;
constructor(api: WorkOrdersAPIV4Api);
/**
* one - delete /v4/work-orders/{workOrderId}
*/
one(workOrderId: V4WorkOrdersControllerDeleteWorkOrderV4Request['workOrderId'], options?: Omit<V4WorkOrdersControllerDeleteWorkOrderV4Request, 'workOrderId'>): Promise<V4WorkOrdersDeleteWorkOrderResponseDto>;
}
//# sourceMappingURL=workOrders.d.ts.map