@simplyhomes/sos-sdk
Version:
TypeScript SDK for Simply Homes SoS API v4
63 lines • 2.7 kB
TypeScript
/**
* 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 type { SoSViewEntityDataSort } from './SoSViewEntityDataSort';
import type { SoSViewEntityDataRelation } from './SoSViewEntityDataRelation';
import type { SoSViewEntityDataColumn } from './SoSViewEntityDataColumn';
import type { SoSViewEntityDataFilter } from './SoSViewEntityDataFilter';
/**
*
* @export
* @interface V4ViewsViewDataDto
*/
export interface V4ViewsViewDataDto {
/**
* Filters to apply to the view
* @type {Array<SoSViewEntityDataColumn>}
* @memberof V4ViewsViewDataDto
*/
columns?: Array<SoSViewEntityDataColumn>;
/**
* Filters to apply to the view
* - Operation must be one of the following:
* + For string: contains, does not contain, is, is not, is any of, is none of
* + For number: =, !=, >, <, >=, <=, is any of, is none of
* + For array: contains all of, contains any of, contains none of, is empty, is not empty
* + For boolean: is
* + For date: is, is not, is before, is after, is on or before, is on or after, is between, is any of, is none of
* - For "is any of" operation, value should be an array
* - For "is between" operation on dates, value should be an array of two dates [startDate, endDate]
* @type {Array<SoSViewEntityDataFilter>}
* @memberof V4ViewsViewDataDto
*/
filters?: Array<SoSViewEntityDataFilter>;
/**
* Sorts to apply to the view
* @type {Array<SoSViewEntityDataSort>}
* @memberof V4ViewsViewDataDto
*/
sorts?: Array<SoSViewEntityDataSort>;
/**
* Relations to include in the view
* @type {Array<SoSViewEntityDataRelation>}
* @memberof V4ViewsViewDataDto
*/
relations?: Array<SoSViewEntityDataRelation>;
}
/**
* Check if a given object implements the V4ViewsViewDataDto interface.
*/
export declare function instanceOfV4ViewsViewDataDto(value: object): value is V4ViewsViewDataDto;
export declare function V4ViewsViewDataDtoFromJSON(json: any): V4ViewsViewDataDto;
export declare function V4ViewsViewDataDtoFromJSONTyped(json: any, ignoreDiscriminator: boolean): V4ViewsViewDataDto;
export declare function V4ViewsViewDataDtoToJSON(json: any): V4ViewsViewDataDto;
export declare function V4ViewsViewDataDtoToJSONTyped(value?: V4ViewsViewDataDto | null, ignoreDiscriminator?: boolean): any;
//# sourceMappingURL=V4ViewsViewDataDto.d.ts.map