@simplyhomes/sos-sdk/dist/generated/src/apis/ContractorsAPIV4Api.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 { V4ContractorsCreateContractorBodyDto, V4ContractorsCreateContractorResponseDto, V4ContractorsDeleteContractorResponseDto, V4ContractorsGetContractorResponseDto, V4ContractorsGetContractorsInViewResponseDto, V4ContractorsGetContractorsResponseDto, V4ContractorsGetUniqueValuesResponseDto, V4ContractorsUpdateContractorBodyDto, V4ContractorsUpdateContractorResponseDto } from '../models/index';
export interface V4ContractorsControllerCreateContractorV4Request {
    v4ContractorsCreateContractorBodyDto: V4ContractorsCreateContractorBodyDto;
}
export interface V4ContractorsControllerDeleteContractorV4Request {
    contractorId: number;
}
export interface V4ContractorsControllerGetContractorV4Request {
    contractorId: number;
    viewId?: number;
    limit?: number;
    offset?: number;
    countOnly?: boolean;
}
export interface V4ContractorsControllerGetContractorsInViewV4Request {
    viewId: number;
    limit?: number;
    offset?: number;
    countOnly?: boolean;
}
export interface V4ContractorsControllerGetContractorsV4Request {
    viewId?: number;
    limit?: number;
    offset?: number;
    countOnly?: boolean;
}
export interface V4ContractorsControllerGetUniqueValuesV4Request {
    column: string;
    viewId?: number;
    offset?: number;
    limit?: number;
}
export interface V4ContractorsControllerUpdateContractorV4Request {
    contractorId: number;
    v4ContractorsUpdateContractorBodyDto: V4ContractorsUpdateContractorBodyDto;
}
/**
 * ContractorsAPIV4Api - interface
 *
 * @export
 * @interface ContractorsAPIV4ApiInterface
 */
export interface ContractorsAPIV4ApiInterface {
    /**
     * Create a new contractor in the system
     * @summary Create a new contractor
     * @param {V4ContractorsCreateContractorBodyDto} v4ContractorsCreateContractorBodyDto
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof ContractorsAPIV4ApiInterface
     */
    v4ContractorsControllerCreateContractorV4Raw(requestParameters: V4ContractorsControllerCreateContractorV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4ContractorsCreateContractorResponseDto>>;
    /**
     * Create a new contractor in the system
     * Create a new contractor
     */
    v4ContractorsControllerCreateContractorV4(requestParameters: V4ContractorsControllerCreateContractorV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4ContractorsCreateContractorResponseDto>;
    /**
     * Remove a contractor from the system
     * @summary Delete a contractor
     * @param {number} contractorId The unique identifier of the contractor to delete
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof ContractorsAPIV4ApiInterface
     */
    v4ContractorsControllerDeleteContractorV4Raw(requestParameters: V4ContractorsControllerDeleteContractorV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4ContractorsDeleteContractorResponseDto>>;
    /**
     * Remove a contractor from the system
     * Delete a contractor
     */
    v4ContractorsControllerDeleteContractorV4(requestParameters: V4ContractorsControllerDeleteContractorV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4ContractorsDeleteContractorResponseDto>;
    /**
     * Retrieve a single contractor with optional view filtering
     * @summary Get a single contractor by ID
     * @param {number} contractorId The unique identifier of the contractor
     * @param {number} [viewId] The ID of the view to filter the contractor 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 ContractorsAPIV4ApiInterface
     */
    v4ContractorsControllerGetContractorV4Raw(requestParameters: V4ContractorsControllerGetContractorV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4ContractorsGetContractorResponseDto>>;
    /**
     * Retrieve a single contractor with optional view filtering
     * Get a single contractor by ID
     */
    v4ContractorsControllerGetContractorV4(requestParameters: V4ContractorsControllerGetContractorV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4ContractorsGetContractorResponseDto>;
    /**
     * Retrieve contractors filtered by a specific view configuration
     * @summary Get contractors 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 ContractorsAPIV4ApiInterface
     */
    v4ContractorsControllerGetContractorsInViewV4Raw(requestParameters: V4ContractorsControllerGetContractorsInViewV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4ContractorsGetContractorsInViewResponseDto>>;
    /**
     * Retrieve contractors filtered by a specific view configuration
     * Get contractors with a specific viewId
     */
    v4ContractorsControllerGetContractorsInViewV4(requestParameters: V4ContractorsControllerGetContractorsInViewV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4ContractorsGetContractorsInViewResponseDto>;
    /**
     * Retrieve a list of contractors with optional view filtering
     * @summary Get contractors with optional viewId
     * @param {number} [viewId] The ID of the view to filter the contractors
     * @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 ContractorsAPIV4ApiInterface
     */
    v4ContractorsControllerGetContractorsV4Raw(requestParameters: V4ContractorsControllerGetContractorsV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4ContractorsGetContractorsResponseDto>>;
    /**
     * Retrieve a list of contractors with optional view filtering
     * Get contractors with optional viewId
     */
    v4ContractorsControllerGetContractorsV4(requestParameters: V4ContractorsControllerGetContractorsV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4ContractorsGetContractorsResponseDto>;
    /**
     * Retrieve unique values and their counts for a specific contractor 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 contractors
     * @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 ContractorsAPIV4ApiInterface
     */
    v4ContractorsControllerGetUniqueValuesV4Raw(requestParameters: V4ContractorsControllerGetUniqueValuesV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4ContractorsGetUniqueValuesResponseDto>>;
    /**
     * Retrieve unique values and their counts for a specific contractor column
     * Get unique values for a specific column
     */
    v4ContractorsControllerGetUniqueValuesV4(requestParameters: V4ContractorsControllerGetUniqueValuesV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4ContractorsGetUniqueValuesResponseDto>;
    /**
     * Update contractor details
     * @summary Update an existing contractor
     * @param {number} contractorId The unique identifier of the contractor to update
     * @param {V4ContractorsUpdateContractorBodyDto} v4ContractorsUpdateContractorBodyDto
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof ContractorsAPIV4ApiInterface
     */
    v4ContractorsControllerUpdateContractorV4Raw(requestParameters: V4ContractorsControllerUpdateContractorV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4ContractorsUpdateContractorResponseDto>>;
    /**
     * Update contractor details
     * Update an existing contractor
     */
    v4ContractorsControllerUpdateContractorV4(requestParameters: V4ContractorsControllerUpdateContractorV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4ContractorsUpdateContractorResponseDto>;
}
/**
 *
 */
export declare class ContractorsAPIV4Api extends runtime.BaseAPI implements ContractorsAPIV4ApiInterface {
    /**
     * Create a new contractor in the system
     * Create a new contractor
     */
    v4ContractorsControllerCreateContractorV4Raw(requestParameters: V4ContractorsControllerCreateContractorV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4ContractorsCreateContractorResponseDto>>;
    /**
     * Create a new contractor in the system
     * Create a new contractor
     */
    v4ContractorsControllerCreateContractorV4(requestParameters: V4ContractorsControllerCreateContractorV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4ContractorsCreateContractorResponseDto>;
    /**
     * Remove a contractor from the system
     * Delete a contractor
     */
    v4ContractorsControllerDeleteContractorV4Raw(requestParameters: V4ContractorsControllerDeleteContractorV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4ContractorsDeleteContractorResponseDto>>;
    /**
     * Remove a contractor from the system
     * Delete a contractor
     */
    v4ContractorsControllerDeleteContractorV4(requestParameters: V4ContractorsControllerDeleteContractorV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4ContractorsDeleteContractorResponseDto>;
    /**
     * Retrieve a single contractor with optional view filtering
     * Get a single contractor by ID
     */
    v4ContractorsControllerGetContractorV4Raw(requestParameters: V4ContractorsControllerGetContractorV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4ContractorsGetContractorResponseDto>>;
    /**
     * Retrieve a single contractor with optional view filtering
     * Get a single contractor by ID
     */
    v4ContractorsControllerGetContractorV4(requestParameters: V4ContractorsControllerGetContractorV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4ContractorsGetContractorResponseDto>;
    /**
     * Retrieve contractors filtered by a specific view configuration
     * Get contractors with a specific viewId
     */
    v4ContractorsControllerGetContractorsInViewV4Raw(requestParameters: V4ContractorsControllerGetContractorsInViewV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4ContractorsGetContractorsInViewResponseDto>>;
    /**
     * Retrieve contractors filtered by a specific view configuration
     * Get contractors with a specific viewId
     */
    v4ContractorsControllerGetContractorsInViewV4(requestParameters: V4ContractorsControllerGetContractorsInViewV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4ContractorsGetContractorsInViewResponseDto>;
    /**
     * Retrieve a list of contractors with optional view filtering
     * Get contractors with optional viewId
     */
    v4ContractorsControllerGetContractorsV4Raw(requestParameters: V4ContractorsControllerGetContractorsV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4ContractorsGetContractorsResponseDto>>;
    /**
     * Retrieve a list of contractors with optional view filtering
     * Get contractors with optional viewId
     */
    v4ContractorsControllerGetContractorsV4(requestParameters?: V4ContractorsControllerGetContractorsV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4ContractorsGetContractorsResponseDto>;
    /**
     * Retrieve unique values and their counts for a specific contractor column
     * Get unique values for a specific column
     */
    v4ContractorsControllerGetUniqueValuesV4Raw(requestParameters: V4ContractorsControllerGetUniqueValuesV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4ContractorsGetUniqueValuesResponseDto>>;
    /**
     * Retrieve unique values and their counts for a specific contractor column
     * Get unique values for a specific column
     */
    v4ContractorsControllerGetUniqueValuesV4(requestParameters: V4ContractorsControllerGetUniqueValuesV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4ContractorsGetUniqueValuesResponseDto>;
    /**
     * Update contractor details
     * Update an existing contractor
     */
    v4ContractorsControllerUpdateContractorV4Raw(requestParameters: V4ContractorsControllerUpdateContractorV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4ContractorsUpdateContractorResponseDto>>;
    /**
     * Update contractor details
     * Update an existing contractor
     */
    v4ContractorsControllerUpdateContractorV4(requestParameters: V4ContractorsControllerUpdateContractorV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4ContractorsUpdateContractorResponseDto>;
}
//# sourceMappingURL=ContractorsAPIV4Api.d.ts.map