@simplyhomes/sos-sdk/dist/generated/src/apis/RentalListingsAPIV4Api.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 { V4RentalListingsCreateRentalListingBodyDto, V4RentalListingsCreateRentalListingResponseDto, V4RentalListingsDeleteRentalListingResponseDto, V4RentalListingsGetRentalListingResponseDto, V4RentalListingsGetRentalListingsInViewResponseDto, V4RentalListingsGetRentalListingsResponseDto, V4RentalListingsGetUniqueValuesResponseDto, V4RentalListingsUpdateRentalListingBodyDto, V4RentalListingsUpdateRentalListingResponseDto } from '../models/index';
export interface V4RentalListingsControllerCreateRentalListingV4Request {
    v4RentalListingsCreateRentalListingBodyDto: V4RentalListingsCreateRentalListingBodyDto;
}
export interface V4RentalListingsControllerDeleteRentalListingV4Request {
    rentalListingId: number;
}
export interface V4RentalListingsControllerGetRentalListingV4Request {
    rentalListingId: number;
    viewId?: number;
    limit?: number;
    offset?: number;
    countOnly?: boolean;
}
export interface V4RentalListingsControllerGetRentalListingsInViewV4Request {
    viewId: number;
    limit?: number;
    offset?: number;
    countOnly?: boolean;
}
export interface V4RentalListingsControllerGetRentalListingsV4Request {
    viewId?: number;
    limit?: number;
    offset?: number;
    countOnly?: boolean;
}
export interface V4RentalListingsControllerGetUniqueValuesV4Request {
    column: string;
    viewId?: number;
    offset?: number;
    limit?: number;
}
export interface V4RentalListingsControllerUpdateRentalListingV4Request {
    rentalListingId: number;
    v4RentalListingsUpdateRentalListingBodyDto: V4RentalListingsUpdateRentalListingBodyDto;
}
/**
 * RentalListingsAPIV4Api - interface
 *
 * @export
 * @interface RentalListingsAPIV4ApiInterface
 */
export interface RentalListingsAPIV4ApiInterface {
    /**
     * Create a new rental listing in the system
     * @summary Create a new rental listing
     * @param {V4RentalListingsCreateRentalListingBodyDto} v4RentalListingsCreateRentalListingBodyDto
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof RentalListingsAPIV4ApiInterface
     */
    v4RentalListingsControllerCreateRentalListingV4Raw(requestParameters: V4RentalListingsControllerCreateRentalListingV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4RentalListingsCreateRentalListingResponseDto>>;
    /**
     * Create a new rental listing in the system
     * Create a new rental listing
     */
    v4RentalListingsControllerCreateRentalListingV4(requestParameters: V4RentalListingsControllerCreateRentalListingV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4RentalListingsCreateRentalListingResponseDto>;
    /**
     * Delete a rental listing by its ID
     * @summary Delete a rental listing
     * @param {number} rentalListingId The unique identifier of the rental listing to delete
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof RentalListingsAPIV4ApiInterface
     */
    v4RentalListingsControllerDeleteRentalListingV4Raw(requestParameters: V4RentalListingsControllerDeleteRentalListingV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4RentalListingsDeleteRentalListingResponseDto>>;
    /**
     * Delete a rental listing by its ID
     * Delete a rental listing
     */
    v4RentalListingsControllerDeleteRentalListingV4(requestParameters: V4RentalListingsControllerDeleteRentalListingV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4RentalListingsDeleteRentalListingResponseDto>;
    /**
     * Retrieve a single rental listing by its unique identifier
     * @summary Get a specific rental listing by ID
     * @param {number} rentalListingId The unique identifier of the rental listing
     * @param {number} [viewId] The ID of the view to filter the rental listing 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 RentalListingsAPIV4ApiInterface
     */
    v4RentalListingsControllerGetRentalListingV4Raw(requestParameters: V4RentalListingsControllerGetRentalListingV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4RentalListingsGetRentalListingResponseDto>>;
    /**
     * Retrieve a single rental listing by its unique identifier
     * Get a specific rental listing by ID
     */
    v4RentalListingsControllerGetRentalListingV4(requestParameters: V4RentalListingsControllerGetRentalListingV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4RentalListingsGetRentalListingResponseDto>;
    /**
     * Retrieve rental listings filtered by a specific view configuration
     * @summary Get rental listings 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 RentalListingsAPIV4ApiInterface
     */
    v4RentalListingsControllerGetRentalListingsInViewV4Raw(requestParameters: V4RentalListingsControllerGetRentalListingsInViewV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4RentalListingsGetRentalListingsInViewResponseDto>>;
    /**
     * Retrieve rental listings filtered by a specific view configuration
     * Get rental listings with a specific viewId
     */
    v4RentalListingsControllerGetRentalListingsInViewV4(requestParameters: V4RentalListingsControllerGetRentalListingsInViewV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4RentalListingsGetRentalListingsInViewResponseDto>;
    /**
     * Retrieve a list of rental listings with optional view filtering
     * @summary Get rental listings with optional viewId
     * @param {number} [viewId] The ID of the view to filter the rental listings
     * @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 RentalListingsAPIV4ApiInterface
     */
    v4RentalListingsControllerGetRentalListingsV4Raw(requestParameters: V4RentalListingsControllerGetRentalListingsV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4RentalListingsGetRentalListingsResponseDto>>;
    /**
     * Retrieve a list of rental listings with optional view filtering
     * Get rental listings with optional viewId
     */
    v4RentalListingsControllerGetRentalListingsV4(requestParameters: V4RentalListingsControllerGetRentalListingsV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4RentalListingsGetRentalListingsResponseDto>;
    /**
     * Retrieve unique values and their counts for a specific column
     * @summary Get unique values for a column
     * @param {string} column The column name to get unique values for
     * @param {number} [viewId] The ID of the view to filter the rental listings
     * @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 RentalListingsAPIV4ApiInterface
     */
    v4RentalListingsControllerGetUniqueValuesV4Raw(requestParameters: V4RentalListingsControllerGetUniqueValuesV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4RentalListingsGetUniqueValuesResponseDto>>;
    /**
     * Retrieve unique values and their counts for a specific column
     * Get unique values for a column
     */
    v4RentalListingsControllerGetUniqueValuesV4(requestParameters: V4RentalListingsControllerGetUniqueValuesV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4RentalListingsGetUniqueValuesResponseDto>;
    /**
     * Update an existing rental listing by its ID
     * @summary Update a rental listing
     * @param {number} rentalListingId The unique identifier of the rental listing to update
     * @param {V4RentalListingsUpdateRentalListingBodyDto} v4RentalListingsUpdateRentalListingBodyDto
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof RentalListingsAPIV4ApiInterface
     */
    v4RentalListingsControllerUpdateRentalListingV4Raw(requestParameters: V4RentalListingsControllerUpdateRentalListingV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4RentalListingsUpdateRentalListingResponseDto>>;
    /**
     * Update an existing rental listing by its ID
     * Update a rental listing
     */
    v4RentalListingsControllerUpdateRentalListingV4(requestParameters: V4RentalListingsControllerUpdateRentalListingV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4RentalListingsUpdateRentalListingResponseDto>;
}
/**
 *
 */
export declare class RentalListingsAPIV4Api extends runtime.BaseAPI implements RentalListingsAPIV4ApiInterface {
    /**
     * Create a new rental listing in the system
     * Create a new rental listing
     */
    v4RentalListingsControllerCreateRentalListingV4Raw(requestParameters: V4RentalListingsControllerCreateRentalListingV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4RentalListingsCreateRentalListingResponseDto>>;
    /**
     * Create a new rental listing in the system
     * Create a new rental listing
     */
    v4RentalListingsControllerCreateRentalListingV4(requestParameters: V4RentalListingsControllerCreateRentalListingV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4RentalListingsCreateRentalListingResponseDto>;
    /**
     * Delete a rental listing by its ID
     * Delete a rental listing
     */
    v4RentalListingsControllerDeleteRentalListingV4Raw(requestParameters: V4RentalListingsControllerDeleteRentalListingV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4RentalListingsDeleteRentalListingResponseDto>>;
    /**
     * Delete a rental listing by its ID
     * Delete a rental listing
     */
    v4RentalListingsControllerDeleteRentalListingV4(requestParameters: V4RentalListingsControllerDeleteRentalListingV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4RentalListingsDeleteRentalListingResponseDto>;
    /**
     * Retrieve a single rental listing by its unique identifier
     * Get a specific rental listing by ID
     */
    v4RentalListingsControllerGetRentalListingV4Raw(requestParameters: V4RentalListingsControllerGetRentalListingV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4RentalListingsGetRentalListingResponseDto>>;
    /**
     * Retrieve a single rental listing by its unique identifier
     * Get a specific rental listing by ID
     */
    v4RentalListingsControllerGetRentalListingV4(requestParameters: V4RentalListingsControllerGetRentalListingV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4RentalListingsGetRentalListingResponseDto>;
    /**
     * Retrieve rental listings filtered by a specific view configuration
     * Get rental listings with a specific viewId
     */
    v4RentalListingsControllerGetRentalListingsInViewV4Raw(requestParameters: V4RentalListingsControllerGetRentalListingsInViewV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4RentalListingsGetRentalListingsInViewResponseDto>>;
    /**
     * Retrieve rental listings filtered by a specific view configuration
     * Get rental listings with a specific viewId
     */
    v4RentalListingsControllerGetRentalListingsInViewV4(requestParameters: V4RentalListingsControllerGetRentalListingsInViewV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4RentalListingsGetRentalListingsInViewResponseDto>;
    /**
     * Retrieve a list of rental listings with optional view filtering
     * Get rental listings with optional viewId
     */
    v4RentalListingsControllerGetRentalListingsV4Raw(requestParameters: V4RentalListingsControllerGetRentalListingsV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4RentalListingsGetRentalListingsResponseDto>>;
    /**
     * Retrieve a list of rental listings with optional view filtering
     * Get rental listings with optional viewId
     */
    v4RentalListingsControllerGetRentalListingsV4(requestParameters?: V4RentalListingsControllerGetRentalListingsV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4RentalListingsGetRentalListingsResponseDto>;
    /**
     * Retrieve unique values and their counts for a specific column
     * Get unique values for a column
     */
    v4RentalListingsControllerGetUniqueValuesV4Raw(requestParameters: V4RentalListingsControllerGetUniqueValuesV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4RentalListingsGetUniqueValuesResponseDto>>;
    /**
     * Retrieve unique values and their counts for a specific column
     * Get unique values for a column
     */
    v4RentalListingsControllerGetUniqueValuesV4(requestParameters: V4RentalListingsControllerGetUniqueValuesV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4RentalListingsGetUniqueValuesResponseDto>;
    /**
     * Update an existing rental listing by its ID
     * Update a rental listing
     */
    v4RentalListingsControllerUpdateRentalListingV4Raw(requestParameters: V4RentalListingsControllerUpdateRentalListingV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4RentalListingsUpdateRentalListingResponseDto>>;
    /**
     * Update an existing rental listing by its ID
     * Update a rental listing
     */
    v4RentalListingsControllerUpdateRentalListingV4(requestParameters: V4RentalListingsControllerUpdateRentalListingV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4RentalListingsUpdateRentalListingResponseDto>;
}
//# sourceMappingURL=RentalListingsAPIV4Api.d.ts.map