@simplyhomes/sos-sdk/dist/generated/src/apis/RenovationsAPIV4Api.d.ts

TypeScript SDK for Simply Homes SoS API v4

/**
 * 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 type { V4RenovationsCreateRenovationBodyDto, V4RenovationsCreateRenovationResponseDto, V4RenovationsDeleteRenovationResponseDto, V4RenovationsGetRenovationResponseDto, V4RenovationsGetRenovationsInViewResponseDto, V4RenovationsGetRenovationsResponseDto, V4RenovationsGetUniqueValuesResponseDto, V4RenovationsUpdateRenovationBodyDto, V4RenovationsUpdateRenovationResponseDto } from '../models/index';
export interface V4RenovationsControllerCreateRenovationV4Request {
    v4RenovationsCreateRenovationBodyDto: V4RenovationsCreateRenovationBodyDto;
}
export interface V4RenovationsControllerDeleteRenovationV4Request {
    renovationId: number;
}
export interface V4RenovationsControllerGetRenovationV4Request {
    renovationId: number;
    viewId?: number;
    limit?: number;
    offset?: number;
    countOnly?: boolean;
}
export interface V4RenovationsControllerGetRenovationsInViewV4Request {
    viewId: number;
    limit?: number;
    offset?: number;
    countOnly?: boolean;
}
export interface V4RenovationsControllerGetRenovationsV4Request {
    viewId?: number;
    limit?: number;
    offset?: number;
    countOnly?: boolean;
}
export interface V4RenovationsControllerGetUniqueValuesV4Request {
    column: string;
    viewId?: number;
    offset?: number;
    limit?: number;
}
export interface V4RenovationsControllerUpdateRenovationV4Request {
    renovationId: number;
    v4RenovationsUpdateRenovationBodyDto: V4RenovationsUpdateRenovationBodyDto;
}
/**
 * RenovationsAPIV4Api - interface
 *
 * @export
 * @interface RenovationsAPIV4ApiInterface
 */
export interface RenovationsAPIV4ApiInterface {
    /**
     * Create a new renovation record in the system
     * @summary Create a new renovation
     * @param {V4RenovationsCreateRenovationBodyDto} v4RenovationsCreateRenovationBodyDto
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof RenovationsAPIV4ApiInterface
     */
    v4RenovationsControllerCreateRenovationV4Raw(requestParameters: V4RenovationsControllerCreateRenovationV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4RenovationsCreateRenovationResponseDto>>;
    /**
     * Create a new renovation record in the system
     * Create a new renovation
     */
    v4RenovationsControllerCreateRenovationV4(requestParameters: V4RenovationsControllerCreateRenovationV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4RenovationsCreateRenovationResponseDto>;
    /**
     * Remove a renovation record from the system
     * @summary Delete a specific renovation by renovationId
     * @param {number} renovationId The unique identifier of the renovation
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof RenovationsAPIV4ApiInterface
     */
    v4RenovationsControllerDeleteRenovationV4Raw(requestParameters: V4RenovationsControllerDeleteRenovationV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4RenovationsDeleteRenovationResponseDto>>;
    /**
     * Remove a renovation record from the system
     * Delete a specific renovation by renovationId
     */
    v4RenovationsControllerDeleteRenovationV4(requestParameters: V4RenovationsControllerDeleteRenovationV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4RenovationsDeleteRenovationResponseDto>;
    /**
     * Retrieve detailed information about a specific renovation
     * @summary Get a specific renovation by renovationId
     * @param {number} renovationId The unique identifier of the renovation
     * @param {number} [viewId] The ID of the view to filter the renovation data
     * @param {number} [limit] The maximum number of objects to return
     * @param {number} [offset] The offset for pagination, used to skip a number of objects
     * @param {boolean} [countOnly] Whether to return only the count of objects instead of the objects themselves
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof RenovationsAPIV4ApiInterface
     */
    v4RenovationsControllerGetRenovationV4Raw(requestParameters: V4RenovationsControllerGetRenovationV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4RenovationsGetRenovationResponseDto>>;
    /**
     * Retrieve detailed information about a specific renovation
     * Get a specific renovation by renovationId
     */
    v4RenovationsControllerGetRenovationV4(requestParameters: V4RenovationsControllerGetRenovationV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4RenovationsGetRenovationResponseDto>;
    /**
     * Retrieve renovations filtered by a specific view configuration
     * @summary Get renovations with a specific viewId
     * @param {number} viewId The unique identifier of the view
     * @param {number} [limit] The maximum number of objects to return
     * @param {number} [offset] The offset for pagination, used to skip a number of objects
     * @param {boolean} [countOnly] Whether to return only the count of objects instead of the objects themselves
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof RenovationsAPIV4ApiInterface
     */
    v4RenovationsControllerGetRenovationsInViewV4Raw(requestParameters: V4RenovationsControllerGetRenovationsInViewV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4RenovationsGetRenovationsInViewResponseDto>>;
    /**
     * Retrieve renovations filtered by a specific view configuration
     * Get renovations with a specific viewId
     */
    v4RenovationsControllerGetRenovationsInViewV4(requestParameters: V4RenovationsControllerGetRenovationsInViewV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4RenovationsGetRenovationsInViewResponseDto>;
    /**
     * Retrieve a list of renovations with optional view filtering
     * @summary Get renovations with optional viewId
     * @param {number} [viewId] The ID of the view to filter the renovations
     * @param {number} [limit] The maximum number of objects to return
     * @param {number} [offset] The offset for pagination, used to skip a number of objects
     * @param {boolean} [countOnly] Whether to return only the count of objects instead of the objects themselves
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof RenovationsAPIV4ApiInterface
     */
    v4RenovationsControllerGetRenovationsV4Raw(requestParameters: V4RenovationsControllerGetRenovationsV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4RenovationsGetRenovationsResponseDto>>;
    /**
     * Retrieve a list of renovations with optional view filtering
     * Get renovations with optional viewId
     */
    v4RenovationsControllerGetRenovationsV4(requestParameters: V4RenovationsControllerGetRenovationsV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4RenovationsGetRenovationsResponseDto>;
    /**
     * Retrieve unique values from a renovation column along with their occurrence counts
     * @summary Get unique values for a specific renovation column with counts
     * @param {string} column The name of the column to get unique values for
     * @param {number} [viewId] The ID of the view to filter the renovations
     * @param {number} [offset] Number of results to skip (for pagination)
     * @param {number} [limit] Maximum number of unique values to return
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof RenovationsAPIV4ApiInterface
     */
    v4RenovationsControllerGetUniqueValuesV4Raw(requestParameters: V4RenovationsControllerGetUniqueValuesV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4RenovationsGetUniqueValuesResponseDto>>;
    /**
     * Retrieve unique values from a renovation column along with their occurrence counts
     * Get unique values for a specific renovation column with counts
     */
    v4RenovationsControllerGetUniqueValuesV4(requestParameters: V4RenovationsControllerGetUniqueValuesV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4RenovationsGetUniqueValuesResponseDto>;
    /**
     * Update an existing renovation record with new data
     * @summary Update a specific renovation by renovationId
     * @param {number} renovationId The unique identifier of the renovation
     * @param {V4RenovationsUpdateRenovationBodyDto} v4RenovationsUpdateRenovationBodyDto
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof RenovationsAPIV4ApiInterface
     */
    v4RenovationsControllerUpdateRenovationV4Raw(requestParameters: V4RenovationsControllerUpdateRenovationV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4RenovationsUpdateRenovationResponseDto>>;
    /**
     * Update an existing renovation record with new data
     * Update a specific renovation by renovationId
     */
    v4RenovationsControllerUpdateRenovationV4(requestParameters: V4RenovationsControllerUpdateRenovationV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4RenovationsUpdateRenovationResponseDto>;
}
/**
 *
 */
export declare class RenovationsAPIV4Api extends runtime.BaseAPI implements RenovationsAPIV4ApiInterface {
    /**
     * Create a new renovation record in the system
     * Create a new renovation
     */
    v4RenovationsControllerCreateRenovationV4Raw(requestParameters: V4RenovationsControllerCreateRenovationV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4RenovationsCreateRenovationResponseDto>>;
    /**
     * Create a new renovation record in the system
     * Create a new renovation
     */
    v4RenovationsControllerCreateRenovationV4(requestParameters: V4RenovationsControllerCreateRenovationV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4RenovationsCreateRenovationResponseDto>;
    /**
     * Remove a renovation record from the system
     * Delete a specific renovation by renovationId
     */
    v4RenovationsControllerDeleteRenovationV4Raw(requestParameters: V4RenovationsControllerDeleteRenovationV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4RenovationsDeleteRenovationResponseDto>>;
    /**
     * Remove a renovation record from the system
     * Delete a specific renovation by renovationId
     */
    v4RenovationsControllerDeleteRenovationV4(requestParameters: V4RenovationsControllerDeleteRenovationV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4RenovationsDeleteRenovationResponseDto>;
    /**
     * Retrieve detailed information about a specific renovation
     * Get a specific renovation by renovationId
     */
    v4RenovationsControllerGetRenovationV4Raw(requestParameters: V4RenovationsControllerGetRenovationV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4RenovationsGetRenovationResponseDto>>;
    /**
     * Retrieve detailed information about a specific renovation
     * Get a specific renovation by renovationId
     */
    v4RenovationsControllerGetRenovationV4(requestParameters: V4RenovationsControllerGetRenovationV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4RenovationsGetRenovationResponseDto>;
    /**
     * Retrieve renovations filtered by a specific view configuration
     * Get renovations with a specific viewId
     */
    v4RenovationsControllerGetRenovationsInViewV4Raw(requestParameters: V4RenovationsControllerGetRenovationsInViewV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4RenovationsGetRenovationsInViewResponseDto>>;
    /**
     * Retrieve renovations filtered by a specific view configuration
     * Get renovations with a specific viewId
     */
    v4RenovationsControllerGetRenovationsInViewV4(requestParameters: V4RenovationsControllerGetRenovationsInViewV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4RenovationsGetRenovationsInViewResponseDto>;
    /**
     * Retrieve a list of renovations with optional view filtering
     * Get renovations with optional viewId
     */
    v4RenovationsControllerGetRenovationsV4Raw(requestParameters: V4RenovationsControllerGetRenovationsV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4RenovationsGetRenovationsResponseDto>>;
    /**
     * Retrieve a list of renovations with optional view filtering
     * Get renovations with optional viewId
     */
    v4RenovationsControllerGetRenovationsV4(requestParameters?: V4RenovationsControllerGetRenovationsV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4RenovationsGetRenovationsResponseDto>;
    /**
     * Retrieve unique values from a renovation column along with their occurrence counts
     * Get unique values for a specific renovation column with counts
     */
    v4RenovationsControllerGetUniqueValuesV4Raw(requestParameters: V4RenovationsControllerGetUniqueValuesV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4RenovationsGetUniqueValuesResponseDto>>;
    /**
     * Retrieve unique values from a renovation column along with their occurrence counts
     * Get unique values for a specific renovation column with counts
     */
    v4RenovationsControllerGetUniqueValuesV4(requestParameters: V4RenovationsControllerGetUniqueValuesV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4RenovationsGetUniqueValuesResponseDto>;
    /**
     * Update an existing renovation record with new data
     * Update a specific renovation by renovationId
     */
    v4RenovationsControllerUpdateRenovationV4Raw(requestParameters: V4RenovationsControllerUpdateRenovationV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4RenovationsUpdateRenovationResponseDto>>;
    /**
     * Update an existing renovation record with new data
     * Update a specific renovation by renovationId
     */
    v4RenovationsControllerUpdateRenovationV4(requestParameters: V4RenovationsControllerUpdateRenovationV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4RenovationsUpdateRenovationResponseDto>;
}
//# sourceMappingURL=RenovationsAPIV4Api.d.ts.map