@simplyhomes/sos-sdk/dist/generated/src/apis/TenantsAPIV4Api.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 { V4TenantsCreateTenantBodyDto, V4TenantsCreateTenantResponseDto, V4TenantsDeleteTenantResponseDto, V4TenantsGetTenantResponseDto, V4TenantsGetTenantsInViewResponseDto, V4TenantsGetTenantsResponseDto, V4TenantsGetUniqueValuesResponseDto, V4TenantsUpdateTenantBodyDto, V4TenantsUpdateTenantResponseDto } from '../models/index';
export interface V4TenantsControllerCreateTenantV4Request {
    v4TenantsCreateTenantBodyDto: V4TenantsCreateTenantBodyDto;
}
export interface V4TenantsControllerDeleteTenantV4Request {
    tenantId: number;
}
export interface V4TenantsControllerGetTenantV4Request {
    tenantId: number;
    viewId?: number;
}
export interface V4TenantsControllerGetTenantsInViewV4Request {
    viewId: number;
    limit?: number;
    offset?: number;
    countOnly?: boolean;
}
export interface V4TenantsControllerGetTenantsV4Request {
    viewId?: number;
    limit?: number;
    offset?: number;
    countOnly?: boolean;
}
export interface V4TenantsControllerGetUniqueValuesV4Request {
    column: string;
    viewId?: number;
    offset?: number;
    limit?: number;
}
export interface V4TenantsControllerUpdateTenantV4Request {
    tenantId: number;
    v4TenantsUpdateTenantBodyDto: V4TenantsUpdateTenantBodyDto;
}
/**
 * TenantsAPIV4Api - interface
 *
 * @export
 * @interface TenantsAPIV4ApiInterface
 */
export interface TenantsAPIV4ApiInterface {
    /**
     * Create a new tenant in the system
     * @summary Create a new tenant
     * @param {V4TenantsCreateTenantBodyDto} v4TenantsCreateTenantBodyDto
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof TenantsAPIV4ApiInterface
     */
    v4TenantsControllerCreateTenantV4Raw(requestParameters: V4TenantsControllerCreateTenantV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4TenantsCreateTenantResponseDto>>;
    /**
     * Create a new tenant in the system
     * Create a new tenant
     */
    v4TenantsControllerCreateTenantV4(requestParameters: V4TenantsControllerCreateTenantV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4TenantsCreateTenantResponseDto>;
    /**
     * Remove a tenant from the system
     * @summary Delete a tenant
     * @param {number} tenantId The unique identifier of the tenant to delete
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof TenantsAPIV4ApiInterface
     */
    v4TenantsControllerDeleteTenantV4Raw(requestParameters: V4TenantsControllerDeleteTenantV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4TenantsDeleteTenantResponseDto>>;
    /**
     * Remove a tenant from the system
     * Delete a tenant
     */
    v4TenantsControllerDeleteTenantV4(requestParameters: V4TenantsControllerDeleteTenantV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4TenantsDeleteTenantResponseDto>;
    /**
     * Retrieve a single tenant with optional view filtering
     * @summary Get a single tenant by ID
     * @param {number} tenantId The unique identifier of the tenant
     * @param {number} [viewId] Optional view ID to filter tenant data
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof TenantsAPIV4ApiInterface
     */
    v4TenantsControllerGetTenantV4Raw(requestParameters: V4TenantsControllerGetTenantV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4TenantsGetTenantResponseDto>>;
    /**
     * Retrieve a single tenant with optional view filtering
     * Get a single tenant by ID
     */
    v4TenantsControllerGetTenantV4(requestParameters: V4TenantsControllerGetTenantV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4TenantsGetTenantResponseDto>;
    /**
     * Retrieve tenants filtered by a specific view configuration
     * @summary Get tenants 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 TenantsAPIV4ApiInterface
     */
    v4TenantsControllerGetTenantsInViewV4Raw(requestParameters: V4TenantsControllerGetTenantsInViewV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4TenantsGetTenantsInViewResponseDto>>;
    /**
     * Retrieve tenants filtered by a specific view configuration
     * Get tenants with a specific viewId
     */
    v4TenantsControllerGetTenantsInViewV4(requestParameters: V4TenantsControllerGetTenantsInViewV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4TenantsGetTenantsInViewResponseDto>;
    /**
     * Retrieve a list of tenants with optional view filtering
     * @summary Get tenants with optional viewId
     * @param {number} [viewId] The ID of the view to filter the tenants
     * @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 TenantsAPIV4ApiInterface
     */
    v4TenantsControllerGetTenantsV4Raw(requestParameters: V4TenantsControllerGetTenantsV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4TenantsGetTenantsResponseDto>>;
    /**
     * Retrieve a list of tenants with optional view filtering
     * Get tenants with optional viewId
     */
    v4TenantsControllerGetTenantsV4(requestParameters: V4TenantsControllerGetTenantsV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4TenantsGetTenantsResponseDto>;
    /**
     * Retrieve unique values and their counts for a specific tenant column
     * @summary Get unique values for a specific column
     * @param {string} column The column name to get unique values for
     * @param {number} [viewId] The ID of the view to filter the tenants
     * @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 TenantsAPIV4ApiInterface
     */
    v4TenantsControllerGetUniqueValuesV4Raw(requestParameters: V4TenantsControllerGetUniqueValuesV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4TenantsGetUniqueValuesResponseDto>>;
    /**
     * Retrieve unique values and their counts for a specific tenant column
     * Get unique values for a specific column
     */
    v4TenantsControllerGetUniqueValuesV4(requestParameters: V4TenantsControllerGetUniqueValuesV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4TenantsGetUniqueValuesResponseDto>;
    /**
     * Update tenant details
     * @summary Update an existing tenant
     * @param {number} tenantId The unique identifier of the tenant to update
     * @param {V4TenantsUpdateTenantBodyDto} v4TenantsUpdateTenantBodyDto
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof TenantsAPIV4ApiInterface
     */
    v4TenantsControllerUpdateTenantV4Raw(requestParameters: V4TenantsControllerUpdateTenantV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4TenantsUpdateTenantResponseDto>>;
    /**
     * Update tenant details
     * Update an existing tenant
     */
    v4TenantsControllerUpdateTenantV4(requestParameters: V4TenantsControllerUpdateTenantV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4TenantsUpdateTenantResponseDto>;
}
/**
 *
 */
export declare class TenantsAPIV4Api extends runtime.BaseAPI implements TenantsAPIV4ApiInterface {
    /**
     * Create a new tenant in the system
     * Create a new tenant
     */
    v4TenantsControllerCreateTenantV4Raw(requestParameters: V4TenantsControllerCreateTenantV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4TenantsCreateTenantResponseDto>>;
    /**
     * Create a new tenant in the system
     * Create a new tenant
     */
    v4TenantsControllerCreateTenantV4(requestParameters: V4TenantsControllerCreateTenantV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4TenantsCreateTenantResponseDto>;
    /**
     * Remove a tenant from the system
     * Delete a tenant
     */
    v4TenantsControllerDeleteTenantV4Raw(requestParameters: V4TenantsControllerDeleteTenantV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4TenantsDeleteTenantResponseDto>>;
    /**
     * Remove a tenant from the system
     * Delete a tenant
     */
    v4TenantsControllerDeleteTenantV4(requestParameters: V4TenantsControllerDeleteTenantV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4TenantsDeleteTenantResponseDto>;
    /**
     * Retrieve a single tenant with optional view filtering
     * Get a single tenant by ID
     */
    v4TenantsControllerGetTenantV4Raw(requestParameters: V4TenantsControllerGetTenantV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4TenantsGetTenantResponseDto>>;
    /**
     * Retrieve a single tenant with optional view filtering
     * Get a single tenant by ID
     */
    v4TenantsControllerGetTenantV4(requestParameters: V4TenantsControllerGetTenantV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4TenantsGetTenantResponseDto>;
    /**
     * Retrieve tenants filtered by a specific view configuration
     * Get tenants with a specific viewId
     */
    v4TenantsControllerGetTenantsInViewV4Raw(requestParameters: V4TenantsControllerGetTenantsInViewV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4TenantsGetTenantsInViewResponseDto>>;
    /**
     * Retrieve tenants filtered by a specific view configuration
     * Get tenants with a specific viewId
     */
    v4TenantsControllerGetTenantsInViewV4(requestParameters: V4TenantsControllerGetTenantsInViewV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4TenantsGetTenantsInViewResponseDto>;
    /**
     * Retrieve a list of tenants with optional view filtering
     * Get tenants with optional viewId
     */
    v4TenantsControllerGetTenantsV4Raw(requestParameters: V4TenantsControllerGetTenantsV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4TenantsGetTenantsResponseDto>>;
    /**
     * Retrieve a list of tenants with optional view filtering
     * Get tenants with optional viewId
     */
    v4TenantsControllerGetTenantsV4(requestParameters?: V4TenantsControllerGetTenantsV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4TenantsGetTenantsResponseDto>;
    /**
     * Retrieve unique values and their counts for a specific tenant column
     * Get unique values for a specific column
     */
    v4TenantsControllerGetUniqueValuesV4Raw(requestParameters: V4TenantsControllerGetUniqueValuesV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4TenantsGetUniqueValuesResponseDto>>;
    /**
     * Retrieve unique values and their counts for a specific tenant column
     * Get unique values for a specific column
     */
    v4TenantsControllerGetUniqueValuesV4(requestParameters: V4TenantsControllerGetUniqueValuesV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4TenantsGetUniqueValuesResponseDto>;
    /**
     * Update tenant details
     * Update an existing tenant
     */
    v4TenantsControllerUpdateTenantV4Raw(requestParameters: V4TenantsControllerUpdateTenantV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4TenantsUpdateTenantResponseDto>>;
    /**
     * Update tenant details
     * Update an existing tenant
     */
    v4TenantsControllerUpdateTenantV4(requestParameters: V4TenantsControllerUpdateTenantV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4TenantsUpdateTenantResponseDto>;
}
//# sourceMappingURL=TenantsAPIV4Api.d.ts.map