import {z} from 'zod' export type BaselineScenarioID = string; export type BusinessEntityID = string; export type GetApiV1BaselineForecastsActivityProjectionsArgs = {baseline_scenario_id: BaselineScenarioID, business_entity_id?: BusinessEntityID | undefined, offset?: number | undefined, limit?: number | undefined}; export type GetApiV1BaselineForecastsActivityProjectionsOptions = {baseUrl?: string | undefined, OAuth2ClientCredentialsProduction?: string | undefined, fetch?: typeof fetch | undefined}; export const activityDataProjectionID = z.string(); export const baselineScenarioID = z.string(); export const businessEntityID = z.string(); export const emissionsSourceID = z.string(); export const emissionsSourceTypeID = z.string(); export const emissionsModelID = z.string(); export const activityTypeID = z.string(); export const activityType = z.string(); export const emissionsScope = z.union([z.literal(1), z.literal(2), z.literal(21), z.literal(22), z.literal(3), z.literal(-1)]); export const year = z.string(); export const yearData = z.object({year: year, value: z.number()}); export const activityDataProjectionValueProjectionMethod = z.union([z.object({projectionMethod: z.literal("HISTORICAL_AVERAGE_GROWTH_RATE"), baseYear: year, historicalPeriodStart: year, historicalPeriodEnd: year}), z.object({projectionMethod: z.literal("HISTORICAL_AVERAGE_VALUE"), historicalPeriodStart: year, historicalPeriodEnd: year}), z.object({projectionMethod: z.literal("HISTORICAL_FIXED_VALUE"), baseYear: year}), z.object({projectionMethod: z.literal("CUSTOM_DATA"), yearlyValues: z.array(yearData)}), z.object({projectionMethod: z.literal("CUSTOM_GROWTH_RATE"), baseYear: year, customGrowthRate: z.number()}), z.object({projectionMethod: z.literal("CUSTOM_YEARLY_PERCENTAGE_CHANGES"), baseYear: year, yearlyValues: z.array(yearData)})]); export const activityDataProjectionEmissionsProjectionMethod = z.union([z.object({projectionMethod: z.literal("HISTORICAL_AVERAGE_GROWTH_RATE"), baseYear: year, historicalPeriodStart: year, historicalPeriodEnd: year}), z.object({projectionMethod: z.literal("HISTORICAL_AVERAGE_VALUE"), historicalPeriodStart: year, historicalPeriodEnd: year}), z.object({projectionMethod: z.literal("HISTORICAL_FIXED_VALUE"), baseYear: year}), z.object({projectionMethod: z.literal("CUSTOM_DATA"), yearlyValues: z.array(yearData)}), z.object({projectionMethod: z.literal("CUSTOM_GROWTH_RATE"), baseYear: year, customGrowthRate: z.number()}), z.object({projectionMethod: z.literal("CUSTOM_YEARLY_PERCENTAGE_CHANGES"), baseYear: year, yearlyValues: z.array(yearData)})]); export const unit = z.string(); export const emissionsFactorOverride = z.object({key: z.string(), value: z.number(), unit: unit}); export const secondaryActivityValueOverride = z.object({displayName: z.string(), key: z.string(), value: z.number(), unit: unit}); export const activityDataProjectionConfig = z.object({id: activityDataProjectionID, scenarioID: baselineScenarioID, processID: businessEntityID, emissionsSourceID: emissionsSourceID, emissionsSourceTypeID: emissionsSourceTypeID, emissionsModelID: emissionsModelID, activityTypeID: activityTypeID, activityType: activityType, scope: emissionsScope, startYear: year, endYear: year, valueProjectionMethod: activityDataProjectionValueProjectionMethod, emissionsProjectionMethod: activityDataProjectionEmissionsProjectionMethod, emissionsFactorsOverrides: z.array(emissionsFactorOverride), secondaryActivityValueOverrides: z.array(secondaryActivityValueOverride)}); export const activityDataProjectionData = z.object({id: activityDataProjectionID, processID: businessEntityID, emissionsSourceID: emissionsSourceID, emissionsSourceTypeID: emissionsSourceTypeID, emissionsModelID: emissionsModelID, activityTypeID: activityTypeID, activityType: activityType, scope: emissionsScope, startYear: year, endYear: year, serverUnit: unit, displayUnit: unit, emissionsUnit: unit, secondaryActivityValues: z.array(yearData), historicalActivityValues: z.array(yearData), projectedActivityValues: z.array(yearData), historicalScopeEmissions: z.array(yearData), projectedScopeEmissions: z.array(yearData), historicalBioCO2Emissions: z.array(yearData), projectedBioCO2Emissions: z.array(yearData)}); export const activityDataProjection = z.object({config: activityDataProjectionConfig, projection: activityDataProjectionData}); export const paginationResult = z.object({offset: z.number().int(), limit: z.number().int(), total: z.number().int(), hasMore: z.boolean(), nextOffset: z.number().int().nullable().optional(), previousOffset: z.number().int().nullable().optional()}); export const getApiV1BaselineForecastsActivityProjectionsResponse = z.object({projections: z.array(activityDataProjection).optional(), pagination: paginationResult.optional()}); export const validateResponse = async ( schema: { readonly '~standard': { readonly validate: (value: unknown) => ({ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }) | Promise<{ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }> } }, value: unknown ): Promise => { const result = await schema['~standard'].validate(value) if (result.issues !== undefined) { const detail = result.issues .map(({ message, path }) => path?.length ? `${path.map((segment) => String(typeof segment === 'object' ? segment.key : segment)).join('.')}: ${message}` : message ) .join('; ') throw new Error(`Response does not match the schema: ${detail}`, { cause: { issues: result.issues } }) } return result.value }; /** * Get activity projections * * GET /v1/baseline_forecasts/activity_projections * * Also accepts auth: OAuth2AuthCodeProduction */ export const getApiV1BaselineForecastsActivityProjections = async (args: GetApiV1BaselineForecastsActivityProjectionsArgs, options?: GetApiV1BaselineForecastsActivityProjectionsOptions) => { const {baseUrl = "https://api.sinai.com", fetch: fetchFn = fetch, OAuth2ClientCredentialsProduction} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.baseline_scenario_id != null) query.append("baseline_scenario_id", String(args.baseline_scenario_id)) if (args.business_entity_id != null) query.append("business_entity_id", String(args.business_entity_id)) if (args.offset != null) query.append("offset", String(args.offset)) if (args.limit != null) query.append("limit", String(args.limit)) if (OAuth2ClientCredentialsProduction !== undefined) headers.set('authorization', `Bearer ${OAuth2ClientCredentialsProduction}`) const url = `${baseUrl.replace(/\/+$/, '')}/v1/baseline_forecasts/activity_projections${query.size > 0 ? `?${query}` : ''}` const res = await fetchFn(url, {method: "GET", headers}) if (!res.ok) throw new Error(`Request failed with status ${res.status}`, {cause: {status: res.status, body: await res.text()}}) return validateResponse(getApiV1BaselineForecastsActivityProjectionsResponse, await res.json()) };