import {z} from 'zod' export type RefProgram = string; export type CreateApiInstrumentsActionSearchArgs = {page?: number | undefined, size?: number | undefined, include?: string | undefined, body: {ein?: string | undefined, program?: RefProgram | undefined, registryAssignedId?: string | undefined, upn?: string | undefined, id?: number | undefined}}; export type CreateApiInstrumentsActionSearchOptions = {baseUrl?: string | undefined, bearerToken?: string | undefined, fetch?: typeof fetch | undefined}; export const refInstrumentType = z.string(); export const refProgram = z.string(); export const vintage = z.object({year: z.number().int(), month: z.number().int().optional()}); export const refExecutionVenue = z.string(); export const market = z.object({name: z.string().optional(), apiCode: z.string().optional(), applicableExecutionVenues: z.array(refExecutionVenue).optional(), applicablePrograms: z.array(refProgram).optional()}); export const refCurrency = z.string().min(3); export const marketModelInstrumentPrice = z.object({amount: z.number().optional(), currency: refCurrency.optional(), lastUpdatedDate: z.string().optional()}); export const marketModelInstrument = z.object({ein: z.string().optional(), description: z.string().optional(), price: marketModelInstrumentPrice.optional()}); export const instrumentMarket = z.object({market: market.optional(), marketModelInstrument: marketModelInstrument.optional()}); export const refCertification = z.string(); export const issuanceCertification = z.object({code: refCertification.optional(), vintageYears: z.array(z.number().int()).optional()}); export const projectCertification = z.object({code: refCertification.optional(), projectCertificationDateRanges: z.array(z.object({certificationStart: z.string().optional(), certificationEnd: z.string().optional()})).optional()}); export const refCarbonProgram = z.string(); export const refProjectRegistryStatus = z.string(); export const refCreditType = z.string(); export const refProjectType = z.string(); export const refBaselineMethodology = z.string(); export const refProjectStatus = z.string(); export const refCountry = z.string(); export const location = z.object({latitude: z.number().optional(), longitude: z.number().optional()}); export const project = z.object({id: z.number().int().optional(), upn: z.string().optional(), name: z.string(), programs: z.array(z.object({program: refCarbonProgram, programName: z.string().optional(), registryAssignedId: z.string(), registryAccountHolderName: z.string().optional(), status: refProjectRegistryStatus, creditType: refCreditType, projectType: refProjectType, baselineMethodologies: z.array(refBaselineMethodology).optional(), creditingPeriodBegin: z.string().optional(), creditingPeriodEnd: z.string().optional()})), description: z.string().optional(), status: refProjectStatus.optional(), country: refCountry.optional(), stateProvince: z.string().optional(), city: z.string().optional(), location: location.optional(), annualAverageOffsetQty: z.number().int().optional(), projectCertifications: z.array(projectCertification).optional(), issuanceCertifications: z.array(issuanceCertification).optional()}); export const carbonInstrument = z.object({type: refInstrumentType, id: z.number().int().optional(), ein: z.string(), description: z.string().optional(), program: refProgram, vintage: vintage, markets: z.array(instrumentMarket).optional(), creditType: z.string(), serialNumber: z.string().optional(), issuanceCertifications: z.array(issuanceCertification).optional(), projectCertifications: z.array(projectCertification).optional(), reportingPeriodStart: z.string().optional(), reportingPeriodEnd: z.string().optional(), project: project}); export const refFuelType = z.string(); export const fuelType = z.object({name: z.string().optional(), type: refFuelType.optional(), fuelSource: z.string().optional()}); export const refStateEligibilityType = z.string(); export const refVoluntaryEligibilityType = z.string(); export const voluntaryEligibility = z.object({name: z.string().optional(), type: refVoluntaryEligibilityType.optional(), effectiveDate: z.string().optional(), expirationDate: z.string().optional()}); export const refRecProgram = z.string(); export const refGeneratorStatus = z.string(); export const refStateProvince = z.string(); export const stateEligibility = z.object({name: z.string().optional(), type: refStateEligibilityType.optional(), stateIdentifier: z.string().optional()}); export const generator = z.object({id: z.number().int().optional(), upn: z.string().optional(), name: z.string(), program: refRecProgram.optional(), registryAssignedId: z.string().optional(), status: refGeneratorStatus.optional(), siteCode: z.string().optional(), unitName: z.string().optional(), controlArea: z.string().optional(), parentCompanyName: z.string().optional(), powerCompanyName: z.string().optional(), powerCompanyCode: z.string().optional(), ownerName: z.string().optional(), ownershipType: z.string().optional(), countyName: z.string().optional(), stateProvince: refStateProvince.optional(), country: refCountry.optional(), contactInfo: z.string().optional(), registryAcctHolderName: z.string().optional(), commencedDt: z.string().optional(), nameplateCapacity: z.number().optional(), facNoncompetitiveCertData: z.string().optional(), fuelTypes: z.array(z.object({fuelType: fuelType, stateEligibilities: z.array(stateEligibility).optional(), voluntaryEligibilities: z.array(voluntaryEligibility).optional()})).optional()}); export const recInstrument = z.object({type: refInstrumentType, id: z.number().int().optional(), ein: z.string(), description: z.string().optional(), program: refProgram, vintage: vintage, markets: z.array(instrumentMarket).optional(), creditType: z.string(), fuelType: fuelType.optional(), stateEligibilities: z.array(z.object({name: z.string().optional(), type: refStateEligibilityType.optional()})).optional(), voluntaryEligibilities: z.array(voluntaryEligibility).optional(), generator: generator}); export const refResourceInType = z.string(); export const refResourceOutType = z.string(); export const refResourceProgram = z.string(); export const refResourceProjectStatus = z.string(); export const childResourceProject = z.object({id: z.number().int().optional(), upn: z.string().optional(), name: z.string(), accountName: z.string().optional(), inOutTypes: z.array(z.object({inType: refResourceInType, outType: refResourceOutType})).optional(), programs: z.array(z.object({program: refResourceProgram, programName: z.string().optional(), registryAssignedId: z.string()})).optional()}); export const resourceProject = z.object({id: z.number().int().optional(), upn: z.string().optional(), name: z.string(), programs: z.array(z.object({program: refResourceProgram, programName: z.string().optional(), registryAssignedId: z.string()})), status: refResourceProjectStatus.optional(), country: refCountry.optional(), accountName: z.string().optional(), classification1: z.string().optional(), classification2: z.string().optional(), classification3: z.string().optional(), childResourceProject: childResourceProject.optional(), inOutTypes: z.array(z.object({inType: refResourceInType, outType: refResourceOutType})).optional(), typeName: z.string().optional()}); export const resourceInstrument = z.object({type: refInstrumentType, id: z.number().int().optional(), ein: z.string(), description: z.string().optional(), program: refProgram, vintage: vintage, markets: z.array(instrumentMarket).optional(), creditType: z.string(), serialNumber: z.string().optional(), inType: refResourceInType.optional(), outType: refResourceOutType.optional(), resourceProject: resourceProject}); export const instrument = z.union([carbonInstrument, recInstrument, resourceInstrument]); export const createApiInstrumentsActionSearchResponse = z.object({page: z.number().int(), size: z.number().int(), totalPages: z.number().int(), totalElements: z.number().int(), content: z.array(instrument)}); 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 }; /** * Instruments search * * POST /instruments/action/search */ export const createApiInstrumentsActionSearch = async (args: CreateApiInstrumentsActionSearchArgs, options?: CreateApiInstrumentsActionSearchOptions) => { const {baseUrl = "https://sandbox.preprod.connect.xpansiv.com/app/api/v1", fetch: fetchFn = fetch, bearerToken} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('content-type', "application/json") headers.set('accept', "application/json") if (args.page != null) query.append("page", String(args.page)) if (args.size != null) query.append("size", String(args.size)) if (args.include != null) query.append("include", String(args.include)) if (bearerToken !== undefined) headers.set('authorization', `Bearer ${bearerToken}`) const url = `${baseUrl.replace(/\/+$/, '')}/instruments/action/search${query.size > 0 ? `?${query}` : ''}` const res = await fetchFn(url, {method: "POST", headers, body: JSON.stringify(args.body)}) if (!res.ok) throw new Error(`Request failed with status ${res.status}`, {cause: {status: res.status, body: await res.text()}}) return validateResponse(createApiInstrumentsActionSearchResponse, await res.json()) };