import {z} from 'zod' export type GetApiV1StocksTickerDebtInstrumentsInstrumentIdArgs = {ticker: string, instrumentId: string, historyLimit?: number | undefined, historyOffset?: number | undefined, covenantLimit?: number | undefined, covenantOffset?: number | undefined, documentLimit?: number | undefined, documentOffset?: number | undefined}; export type GetApiV1StocksTickerDebtInstrumentsInstrumentIdOptions = {baseUrl?: string | undefined, ApiKey?: string | undefined, fetch?: typeof fetch | undefined}; export const debtProfileCoverageDto = z.object({readLimitReached: z.boolean().optional(), filingStartDate: z.string().nullable().optional(), examinedThrough: z.string().nullable().optional(), latestProcessedFilingDate: z.string().nullable().optional(), annualBaselineAsOf: z.string().nullable().optional(), unresolvedObservationCount: z.number().int().optional(), incompleteEvidenceFilingCount: z.number().int().optional(), incompleteLegalArtifactCount: z.number().int().optional(), incompleteCovenantArtifactCount: z.number().int().optional(), pendingFilingFailureCount: z.number().int().optional(), parkedFilingFailureCount: z.number().int().optional(), pendingCovenantFailureCount: z.number().int().optional(), parkedCovenantFailureCount: z.number().int().optional(), unprocessedFilingCount: z.number().int().optional(), unprocessedCovenantArtifactCount: z.number().int().optional(), isRegisteredFund: z.boolean().optional(), exclusionNotice: z.string().nullable().optional()}); export const debtProfileAliasDto = z.object({type: z.string().nullable().optional(), value: z.string().nullable().optional()}); export const pageMeta = z.object({limit: z.number().int().optional(), offset: z.number().int().optional(), count: z.number().int().optional(), hasMore: z.boolean().optional(), total: z.number().int().nullable().optional()}); export const debtProfileObservationDto = z.object({eventType: z.string().nullable().optional(), effectiveDate: z.string().nullable().optional(), asOfDate: z.string().nullable().optional(), outstandingPrincipal: z.number().nullable().optional(), carryingAmount: z.number().nullable().optional(), fairValue: z.number().nullable().optional(), commitment: z.number().nullable().optional(), availability: z.number().nullable().optional(), couponRatePercent: z.number().nullable().optional(), variableRateTerms: z.string().nullable().optional(), form: z.string().nullable().optional(), filedDate: z.string().optional(), filingUrl: z.string().nullable().optional(), sourceUrl: z.string().nullable().optional(), instrumentReference: z.string().nullable().optional(), legalIssuerQuote: z.string().nullable().optional(), sourceQuote: z.string().nullable().optional(), contextQuotes: z.array(z.string()).nullable().optional()}); export const debtProfileCovenantDefinedTermDto = z.object({term: z.string().nullable().optional(), definition: z.string().nullable().optional(), sourceQuote: z.string().nullable().optional()}); export const debtProfileCovenantDto = z.object({id: z.string().optional(), appliesToEveryAgreementSeries: z.boolean().optional(), provisionReference: z.string().nullable().optional(), category: z.string().nullable().optional(), categoryText: z.string().nullable().optional(), summary: z.string().nullable().optional(), metric: z.string().nullable().optional(), operator: z.string().nullable().optional(), threshold: z.number().nullable().optional(), thresholdUnit: z.string().nullable().optional(), testingFrequency: z.string().nullable().optional(), isSpringing: z.boolean().nullable().optional(), springingTrigger: z.string().nullable().optional(), exceptions: z.string().nullable().optional(), definedTerms: z.array(debtProfileCovenantDefinedTermDto).nullable().optional(), effectiveFrom: z.string().nullable().optional(), effectiveTo: z.string().nullable().optional(), supersedesPriorVersion: z.boolean().optional(), supersedesProvisionReference: z.string().nullable().optional(), supersessionQuote: z.string().nullable().optional(), sourceSection: z.string().nullable().optional(), sourceQuote: z.string().nullable().optional(), targetIdentityQuotes: z.array(z.string()).nullable().optional(), targetScopeQuotes: z.array(z.string()).nullable().optional(), governingContextQuotes: z.array(z.string()).nullable().optional(), sourceUrl: z.string().nullable().optional()}); export const debtProfileDocumentDto = z.object({role: z.string().nullable().optional(), formOrExhibitType: z.string().nullable().optional(), description: z.string().nullable().optional(), filedDate: z.string().optional(), effectiveDate: z.string().nullable().optional(), sourceUrl: z.string().nullable().optional()}); export const debtProfileInstrumentDto = z.object({id: z.string().optional(), instrumentType: z.string().nullable().optional(), status: z.string().nullable().optional(), legalIssuer: z.string().nullable().optional(), instrumentReference: z.string().nullable().optional(), seriesDesignation: z.string().nullable().optional(), agreementTitle: z.string().nullable().optional(), originalAgreementDate: z.string().nullable().optional(), maturityDate: z.string().nullable().optional(), currency: z.string().nullable().optional(), originalPrincipal: z.number().nullable().optional(), outstandingPrincipal: z.number().nullable().optional(), carryingAmount: z.number().nullable().optional(), commitment: z.number().nullable().optional(), availability: z.number().nullable().optional(), balanceAsOf: z.string().nullable().optional(), aliases: z.array(debtProfileAliasDto).nullable().optional(), aliasesMeta: pageMeta.optional(), history: z.array(debtProfileObservationDto).nullable().optional(), historyMeta: pageMeta.optional(), covenants: z.array(debtProfileCovenantDto).nullable().optional(), covenantsMeta: pageMeta.optional(), documents: z.array(debtProfileDocumentDto).nullable().optional(), documentsMeta: pageMeta.optional()}); export const debtInstrumentResponse = z.object({ticker: z.string().nullable().optional(), companyName: z.string().nullable().optional(), coverage: debtProfileCoverageDto.optional(), data: debtProfileInstrumentDto.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 one durable debt instrument by its Equibles identifier, including every linked filing observation, verified covenant term, and governing or amending document. * * GET /v1/stocks/{ticker}/debt-instruments/{instrumentId} */ export const getApiV1StocksTickerDebtInstrumentsInstrumentId = async (args: GetApiV1StocksTickerDebtInstrumentsInstrumentIdArgs, options?: GetApiV1StocksTickerDebtInstrumentsInstrumentIdOptions) => { const {baseUrl = "https://api.equibles.com", fetch: fetchFn = fetch, ApiKey} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.historyLimit != null) query.append("historyLimit", String(args.historyLimit)) if (args.historyOffset != null) query.append("historyOffset", String(args.historyOffset)) if (args.covenantLimit != null) query.append("covenantLimit", String(args.covenantLimit)) if (args.covenantOffset != null) query.append("covenantOffset", String(args.covenantOffset)) if (args.documentLimit != null) query.append("documentLimit", String(args.documentLimit)) if (args.documentOffset != null) query.append("documentOffset", String(args.documentOffset)) if (ApiKey !== undefined) headers.set('authorization', `Bearer ${ApiKey}`) const url = `${baseUrl.replace(/\/+$/, '')}/v1/stocks/${encodeURIComponent(String(args.ticker))}/debt-instruments/${encodeURIComponent(String(args.instrumentId))}${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(debtInstrumentResponse, await res.json()) };