/* generated using openapi-typescript-codegen -- do not edit */ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ import type { BenchmarkListOut } from '../models/BenchmarkListOut'; import type { BenchmarkProjectOut } from '../models/BenchmarkProjectOut'; import type { MethodologyOut } from '../models/MethodologyOut'; import type { CancelablePromise } from '../core/CancelablePromise'; import { OpenAPI } from '../core/OpenAPI'; import { request as __request } from '../core/request'; export class DataBenchmarksService { /** * Discovery — per-project-type status + geographies available * Discovery endpoint — surfaces per-project status + latest period. * @returns BenchmarkListOut Successful Response * @throws ApiError */ public static benchmarksList(): CancelablePromise { return __request(OpenAPI, { method: 'GET', url: '/v1/benchmarks/list', }); } /** * Benchmark rows for one project type (optionally geo-filtered) * Return benchmark rows for one project_type with optional geo filter. * * Paginated per UX-7: ``limit`` (1-200, default 50) + ``offset`` (>=0, * default 0). Response includes ``total`` across all matched filters * (pre-pagination) plus the ``limit``+``offset`` applied to this page. * @returns BenchmarkProjectOut Successful Response * @throws ApiError */ public static benchmarksGetProject({ projectType, geographyTier, msa, limit = 50, offset, }: { /** * Project type slug (e.g. 'kitchen_remodel'); see /v1/benchmarks/list. */ projectType: string, /** * Geography tier filter: 'national' | 'state' | 'msa' | 'county' | 'zip' */ geographyTier?: (string | null), /** * 5-digit CBSA / MSA code (e.g. '19100' for Dallas-Fort Worth). */ msa?: (string | null), /** * Page size 1-200 */ limit?: number, /** * Skip N results */ offset?: number, }): CancelablePromise { return __request(OpenAPI, { method: 'GET', url: '/v1/benchmarks/projects/{project_type}', path: { 'project_type': projectType, }, query: { 'geography_tier': geographyTier, 'msa': msa, 'limit': limit, 'offset': offset, }, errors: { 422: `Validation Error`, }, }); } /** * Raw source-citation rows for (source_type, period) — audit hatch * Return all benchmark_sources rows for (source_type, period). * @returns any Successful Response * @throws ApiError */ public static benchmarksGetSources({ sourceType, period, }: { /** * Source-type slug (e.g. 'oews_msa', 'ppi_series'); see SOURCE_TYPES. */ sourceType: string, /** * Period identifier (YYYY / YYYY-Qn / YYYY-MM / YYYY-MM-DD) */ period: string, }): CancelablePromise> { return __request(OpenAPI, { method: 'GET', url: '/v1/benchmarks/sources/{source_type}/{period}', path: { 'source_type': sourceType, 'period': period, }, errors: { 422: `Validation Error`, }, }); } /** * Derivation formula + confidence + sources for a project type * Return the methodology.json entry for a project_type. * @returns MethodologyOut Successful Response * @throws ApiError */ public static benchmarksGetMethodology({ projectType, }: { /** * Project type slug (e.g. 'kitchen_remodel'); see /v1/benchmarks/list. */ projectType: string, }): CancelablePromise { return __request(OpenAPI, { method: 'GET', url: '/v1/benchmarks/methodology/{project_type}', path: { 'project_type': projectType, }, errors: { 422: `Validation Error`, }, }); } }