@rundit-sdk/embed 0.1.2 → 0.3.0-rc.11
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/AGENTS.md +32 -9
- package/README.md +59 -9
- package/ai-manifest.json +216 -9
- package/dist/index.d.ts +575 -28
- package/dist/index.js +248 -24
- package/openapi.json +3337 -505
- package/package.json +5 -1
- package/skills/rundit-sdk-embed/SKILL.md +2 -2
package/dist/index.d.ts
CHANGED
|
@@ -16,7 +16,7 @@ export declare class RunditSdkError extends Error {
|
|
|
16
16
|
}
|
|
17
17
|
|
|
18
18
|
export interface CreateEmbedClientOptions {
|
|
19
|
-
baseUrl
|
|
19
|
+
baseUrl?: string
|
|
20
20
|
token: string
|
|
21
21
|
fetch?: typeof fetch
|
|
22
22
|
headers?: Record<string, string>
|
|
@@ -25,25 +25,131 @@ export interface CreateEmbedClientOptions {
|
|
|
25
25
|
export interface SdkCompanyDto {
|
|
26
26
|
id: number
|
|
27
27
|
name: string
|
|
28
|
-
type
|
|
28
|
+
type: string | null
|
|
29
|
+
website?: string | null
|
|
30
|
+
currency: string
|
|
31
|
+
logoImageFileUuid: string | null
|
|
29
32
|
legalName?: string | null
|
|
30
33
|
status?: string | null
|
|
31
|
-
|
|
34
|
+
description?: string | null
|
|
35
|
+
vision?: string | null
|
|
36
|
+
address?: string | null
|
|
37
|
+
city?: string | null
|
|
38
|
+
state?: string | null
|
|
39
|
+
country?: string | null
|
|
40
|
+
operatingCountries?: string[]
|
|
41
|
+
vatNumber?: string | null
|
|
42
|
+
foundingYear?: number | null
|
|
43
|
+
established?: string | null
|
|
44
|
+
fundingTotal?: number | null
|
|
32
45
|
companyGroupIds?: number[]
|
|
33
46
|
}
|
|
34
47
|
|
|
48
|
+
export interface SdkCompactCompanyDto {
|
|
49
|
+
id: number
|
|
50
|
+
name: string
|
|
51
|
+
type: string | null
|
|
52
|
+
website?: string | null
|
|
53
|
+
currency: string
|
|
54
|
+
logoImageFileUuid: string | null
|
|
55
|
+
}
|
|
56
|
+
|
|
57
|
+
export interface SdkPaginationMetaDto {
|
|
58
|
+
nextCursor: string | null
|
|
59
|
+
}
|
|
60
|
+
|
|
61
|
+
export interface SdkCompaniesListResponseDto {
|
|
62
|
+
data: SdkCompactCompanyDto[]
|
|
63
|
+
meta: SdkPaginationMetaDto
|
|
64
|
+
}
|
|
65
|
+
|
|
66
|
+
export interface SdkCompactCompanyGroupDto {
|
|
67
|
+
id: number
|
|
68
|
+
name: string
|
|
69
|
+
isDemo: boolean
|
|
70
|
+
colorId?: number | null
|
|
71
|
+
companyIds?: number[]
|
|
72
|
+
}
|
|
73
|
+
|
|
74
|
+
export interface SdkCompanyGroupsListResponseDto {
|
|
75
|
+
data: SdkCompactCompanyGroupDto[]
|
|
76
|
+
meta: SdkPaginationMetaDto
|
|
77
|
+
}
|
|
78
|
+
|
|
79
|
+
export interface SdkCompanyGroupBasicInformationDto {
|
|
80
|
+
fullName?: string | null
|
|
81
|
+
domicile?: string | null
|
|
82
|
+
managementCompany?: string | null
|
|
83
|
+
generalPartner?: string | null
|
|
84
|
+
vintageYear?: number | null
|
|
85
|
+
fundCurrency?: string | null
|
|
86
|
+
closingDates?: string[]
|
|
87
|
+
legalForm?: string | null
|
|
88
|
+
term?: string | null
|
|
89
|
+
endedness?: string | null
|
|
90
|
+
}
|
|
91
|
+
|
|
92
|
+
export interface SdkCompanyGroupInvestmentFocusDto {
|
|
93
|
+
investmentFocusAndPlan?: string | null
|
|
94
|
+
investmentFocusStage?: string | null
|
|
95
|
+
investmentFocusGeography?: string | null
|
|
96
|
+
investmentFocusIndustry?: string | null
|
|
97
|
+
maximumInvestment?: string | null
|
|
98
|
+
maximumLeverage?: string | null
|
|
99
|
+
investmentPeriod?: string | null
|
|
100
|
+
valuationPolicyGuidelines?: string | null
|
|
101
|
+
reInvestmentPolicy?: string | null
|
|
102
|
+
otherInvestmentRestrictions?: string | null
|
|
103
|
+
accountingPrinciples?: string | null
|
|
104
|
+
}
|
|
105
|
+
|
|
106
|
+
export interface SdkCompanyGroupKeyEconomicTermsDto {
|
|
107
|
+
hurdleRateAndCarry?: string | null
|
|
108
|
+
managementFees?: string | null
|
|
109
|
+
carriedInterest?: string | null
|
|
110
|
+
feeOffsets?: string | null
|
|
111
|
+
}
|
|
112
|
+
|
|
113
|
+
export interface SdkCompanyGroupAifmdDto {
|
|
114
|
+
financialConductAuthority?: string | null
|
|
115
|
+
depositary?: string | null
|
|
116
|
+
countryOfRegulation?: string | null
|
|
117
|
+
independentRiskManager?: string | null
|
|
118
|
+
independentValuer?: string | null
|
|
119
|
+
}
|
|
120
|
+
|
|
121
|
+
export interface SdkCompanyGroupServiceProvidersDto {
|
|
122
|
+
auditors?: string | null
|
|
123
|
+
administrator?: string | null
|
|
124
|
+
lawyer?: string | null
|
|
125
|
+
bankingFacilities?: string | null
|
|
126
|
+
taxAndRegulatory?: string | null
|
|
127
|
+
lpAdvisoryCommittee?: string | null
|
|
128
|
+
membersOfLpAdvisoryCommittee?: string | null
|
|
129
|
+
}
|
|
130
|
+
|
|
131
|
+
export interface SdkCompanyGroupDetailsDto {
|
|
132
|
+
basicInformation?: SdkCompanyGroupBasicInformationDto
|
|
133
|
+
investmentFocus?: SdkCompanyGroupInvestmentFocusDto
|
|
134
|
+
keyEconomicTerms?: SdkCompanyGroupKeyEconomicTermsDto
|
|
135
|
+
aifmd?: SdkCompanyGroupAifmdDto
|
|
136
|
+
serviceProviders?: SdkCompanyGroupServiceProvidersDto
|
|
137
|
+
}
|
|
138
|
+
|
|
35
139
|
export interface SdkCompanyGroupDto {
|
|
36
140
|
id: number
|
|
37
141
|
name: string
|
|
38
|
-
|
|
142
|
+
isDemo: boolean
|
|
143
|
+
colorId?: number | null
|
|
39
144
|
companyIds?: number[]
|
|
40
|
-
companies?:
|
|
145
|
+
companies?: SdkCompactCompanyDto[]
|
|
146
|
+
details?: SdkCompanyGroupDetailsDto
|
|
41
147
|
}
|
|
42
148
|
|
|
43
149
|
export interface SdkCompanyReferenceDto {
|
|
44
150
|
id: number
|
|
45
151
|
name: string
|
|
46
|
-
type
|
|
152
|
+
type: string | null
|
|
47
153
|
}
|
|
48
154
|
|
|
49
155
|
export interface SdkCompanyGroupReferenceDto {
|
|
@@ -117,6 +223,11 @@ export interface SdkCompanyPositionDto {
|
|
|
117
223
|
date: string
|
|
118
224
|
}
|
|
119
225
|
|
|
226
|
+
export interface SdkCompanyPositionsListResponseDto {
|
|
227
|
+
data: SdkCompanyPositionDto[]
|
|
228
|
+
meta: SdkPaginationMetaDto
|
|
229
|
+
}
|
|
230
|
+
|
|
120
231
|
export interface SdkPortfolioPositionDto {
|
|
121
232
|
companyIds?: number[]
|
|
122
233
|
currency: string
|
|
@@ -144,42 +255,366 @@ export interface SdkPortfolioPositionDto {
|
|
|
144
255
|
averageInvestmentAmount?: number | null
|
|
145
256
|
}
|
|
146
257
|
|
|
147
|
-
export interface
|
|
258
|
+
export interface SdkTransactionAdditionalInfoDto {
|
|
259
|
+
personResponsible?: string | null
|
|
260
|
+
rationale?: string | null
|
|
261
|
+
info?: string | null
|
|
262
|
+
warrant?: string | null
|
|
263
|
+
earnOut?: string | null
|
|
264
|
+
}
|
|
265
|
+
|
|
266
|
+
export interface SdkOtherInvestmentTransactionDto {
|
|
148
267
|
id: number
|
|
268
|
+
type: "OtherInvestment"
|
|
269
|
+
date: string
|
|
149
270
|
companyId: number
|
|
150
271
|
companyGroupId?: number | null
|
|
151
272
|
company?: SdkCompanyReferenceDto
|
|
152
273
|
companyGroup?: SdkCompanyGroupReferenceDto
|
|
153
|
-
|
|
274
|
+
currency?: string | null
|
|
275
|
+
additionalInfo?: SdkTransactionAdditionalInfoDto
|
|
276
|
+
children?: (SdkEquityTransactionDto | SdkConvertibleNoteTransactionDto | SdkFutureEquityAgreementTransactionDto | SdkExtendTransactionDto | SdkConversionTransactionDto | SdkExitTransactionDto | SdkValuationChangeTransactionDto | SdkInsolvencyTransactionDto | SdkOtherInvestmentTransactionDto)[]
|
|
277
|
+
invested: number
|
|
154
278
|
name?: string | null
|
|
279
|
+
}
|
|
280
|
+
|
|
281
|
+
export interface SdkInsolvencyTransactionDto {
|
|
282
|
+
id: number
|
|
283
|
+
type: "Insolvency"
|
|
155
284
|
date: string
|
|
156
|
-
|
|
157
|
-
|
|
285
|
+
companyId: number
|
|
286
|
+
companyGroupId?: number | null
|
|
287
|
+
company?: SdkCompanyReferenceDto
|
|
288
|
+
companyGroup?: SdkCompanyGroupReferenceDto
|
|
158
289
|
currency?: string | null
|
|
159
|
-
|
|
290
|
+
additionalInfo?: SdkTransactionAdditionalInfoDto
|
|
291
|
+
children?: (SdkEquityTransactionDto | SdkConvertibleNoteTransactionDto | SdkFutureEquityAgreementTransactionDto | SdkExtendTransactionDto | SdkConversionTransactionDto | SdkExitTransactionDto | SdkValuationChangeTransactionDto | SdkInsolvencyTransactionDto | SdkOtherInvestmentTransactionDto)[]
|
|
292
|
+
customSummaryFairValue?: number | null
|
|
293
|
+
}
|
|
294
|
+
|
|
295
|
+
export interface SdkValuationChangeTransactionDto {
|
|
296
|
+
id: number
|
|
297
|
+
type: "ValuationChange"
|
|
298
|
+
date: string
|
|
299
|
+
companyId: number
|
|
300
|
+
companyGroupId?: number | null
|
|
301
|
+
company?: SdkCompanyReferenceDto
|
|
302
|
+
companyGroup?: SdkCompanyGroupReferenceDto
|
|
303
|
+
currency?: string | null
|
|
304
|
+
additionalInfo?: SdkTransactionAdditionalInfoDto
|
|
305
|
+
children?: (SdkEquityTransactionDto | SdkConvertibleNoteTransactionDto | SdkFutureEquityAgreementTransactionDto | SdkExtendTransactionDto | SdkConversionTransactionDto | SdkExitTransactionDto | SdkValuationChangeTransactionDto | SdkInsolvencyTransactionDto | SdkOtherInvestmentTransactionDto)[]
|
|
306
|
+
companyPostMoneyValuation?: number | null
|
|
307
|
+
pricePerShare?: number | null
|
|
308
|
+
sharesIssuedTotalDiluted?: number | null
|
|
309
|
+
sharesIssuedTotalCurrent?: number | null
|
|
310
|
+
valuationMethod?: "Historical" | "NewFinancingRound" | "PubliclyListedSecurity" | "Realization" | "RecentTransactionMultiples" | "RecentMarketMultiples" | "RecentMarketAndTransactionMultiples" | "DiscountToPrimaryRound" | "ThirdPartyOpinion" | "Dcf" | "Other"
|
|
311
|
+
customSummaryFairValue?: number | null
|
|
312
|
+
}
|
|
313
|
+
|
|
314
|
+
export interface SdkTransactionPaymentDto {
|
|
315
|
+
amount: number
|
|
316
|
+
dueDate: string
|
|
317
|
+
}
|
|
318
|
+
|
|
319
|
+
export interface SdkExitTransactionDto {
|
|
320
|
+
id: number
|
|
321
|
+
type: "TradeSale" | "IPO" | "Auction" | "LimitedAuction" | "Proprietary" | "OtherExit" | "Dividend" | "OtherRealization"
|
|
322
|
+
date: string
|
|
323
|
+
companyId: number
|
|
324
|
+
companyGroupId?: number | null
|
|
325
|
+
company?: SdkCompanyReferenceDto
|
|
326
|
+
companyGroup?: SdkCompanyGroupReferenceDto
|
|
327
|
+
currency?: string | null
|
|
328
|
+
additionalInfo?: SdkTransactionAdditionalInfoDto
|
|
329
|
+
children?: (SdkEquityTransactionDto | SdkConvertibleNoteTransactionDto | SdkFutureEquityAgreementTransactionDto | SdkExtendTransactionDto | SdkConversionTransactionDto | SdkExitTransactionDto | SdkValuationChangeTransactionDto | SdkInsolvencyTransactionDto | SdkOtherInvestmentTransactionDto)[]
|
|
330
|
+
profit?: number | null
|
|
331
|
+
pricePerShare?: number | null
|
|
332
|
+
sharesAcquired?: number | null
|
|
333
|
+
companyPostMoneyValuation?: number | null
|
|
334
|
+
ticker?: string | null
|
|
335
|
+
name?: string | null
|
|
336
|
+
payments?: SdkTransactionPaymentDto[]
|
|
337
|
+
}
|
|
338
|
+
|
|
339
|
+
export interface SdkConversionTransactionDto {
|
|
340
|
+
id: number
|
|
341
|
+
type: "ConvertToEquity" | "Payback" | "WriteOff"
|
|
342
|
+
date: string
|
|
343
|
+
companyId: number
|
|
344
|
+
companyGroupId?: number | null
|
|
345
|
+
company?: SdkCompanyReferenceDto
|
|
346
|
+
companyGroup?: SdkCompanyGroupReferenceDto
|
|
347
|
+
currency?: string | null
|
|
348
|
+
additionalInfo?: SdkTransactionAdditionalInfoDto
|
|
349
|
+
children?: (SdkEquityTransactionDto | SdkConvertibleNoteTransactionDto | SdkFutureEquityAgreementTransactionDto | SdkExtendTransactionDto | SdkConversionTransactionDto | SdkExitTransactionDto | SdkValuationChangeTransactionDto | SdkInsolvencyTransactionDto | SdkOtherInvestmentTransactionDto)[]
|
|
350
|
+
parentId: number
|
|
351
|
+
convertedTransactionType?: "Auction" | "ConvertibleNote" | "ConvertToEquity" | "Dividend" | "EquityInvestment" | "EquityReceived" | "Extend" | "FutureEquityAgreement" | "Insolvency" | "IPO" | "LimitedAuction" | "OptionsReceived" | "OtherExit" | "OtherInvestment" | "OtherRealization" | "Payback" | "Proprietary" | "TradeSale" | "ValuationChange" | "WriteOff"
|
|
352
|
+
amountConverted?: number | null
|
|
353
|
+
writeOffAmount?: number | null
|
|
354
|
+
pricePerShare?: number | null
|
|
355
|
+
sharesAcquired?: number | null
|
|
356
|
+
payments?: SdkTransactionPaymentDto[]
|
|
357
|
+
}
|
|
358
|
+
|
|
359
|
+
export interface SdkExtendTransactionDto {
|
|
360
|
+
id: number
|
|
361
|
+
type: "Extend"
|
|
362
|
+
date: string
|
|
363
|
+
companyId: number
|
|
364
|
+
companyGroupId?: number | null
|
|
365
|
+
company?: SdkCompanyReferenceDto
|
|
366
|
+
companyGroup?: SdkCompanyGroupReferenceDto
|
|
367
|
+
currency?: string | null
|
|
368
|
+
additionalInfo?: SdkTransactionAdditionalInfoDto
|
|
369
|
+
children?: (SdkEquityTransactionDto | SdkConvertibleNoteTransactionDto | SdkFutureEquityAgreementTransactionDto | SdkExtendTransactionDto | SdkConversionTransactionDto | SdkExitTransactionDto | SdkValuationChangeTransactionDto | SdkInsolvencyTransactionDto | SdkOtherInvestmentTransactionDto)[]
|
|
370
|
+
parentId: number
|
|
371
|
+
maturityDate?: string | null
|
|
372
|
+
transactionFairValue?: number | null
|
|
373
|
+
}
|
|
374
|
+
|
|
375
|
+
export interface SdkFutureEquityAgreementTransactionDto {
|
|
376
|
+
id: number
|
|
377
|
+
type: "FutureEquityAgreement"
|
|
378
|
+
date: string
|
|
379
|
+
companyId: number
|
|
380
|
+
companyGroupId?: number | null
|
|
381
|
+
company?: SdkCompanyReferenceDto
|
|
382
|
+
companyGroup?: SdkCompanyGroupReferenceDto
|
|
383
|
+
currency?: string | null
|
|
384
|
+
additionalInfo?: SdkTransactionAdditionalInfoDto
|
|
385
|
+
children?: (SdkEquityTransactionDto | SdkConvertibleNoteTransactionDto | SdkFutureEquityAgreementTransactionDto | SdkExtendTransactionDto | SdkConversionTransactionDto | SdkExitTransactionDto | SdkValuationChangeTransactionDto | SdkInsolvencyTransactionDto | SdkOtherInvestmentTransactionDto)[]
|
|
386
|
+
invested: number
|
|
387
|
+
valuationCap?: number | null
|
|
388
|
+
discountRate?: number | null
|
|
389
|
+
valuationTiming?: string | null
|
|
390
|
+
companyPostMoneyValuation?: number | null
|
|
391
|
+
warrantedOwnership?: number | null
|
|
392
|
+
}
|
|
393
|
+
|
|
394
|
+
export interface SdkConvertibleNoteTransactionDto {
|
|
395
|
+
id: number
|
|
396
|
+
type: "ConvertibleNote"
|
|
397
|
+
date: string
|
|
398
|
+
companyId: number
|
|
399
|
+
companyGroupId?: number | null
|
|
400
|
+
company?: SdkCompanyReferenceDto
|
|
401
|
+
companyGroup?: SdkCompanyGroupReferenceDto
|
|
402
|
+
currency?: string | null
|
|
403
|
+
additionalInfo?: SdkTransactionAdditionalInfoDto
|
|
404
|
+
children?: (SdkEquityTransactionDto | SdkConvertibleNoteTransactionDto | SdkFutureEquityAgreementTransactionDto | SdkExtendTransactionDto | SdkConversionTransactionDto | SdkExitTransactionDto | SdkValuationChangeTransactionDto | SdkInsolvencyTransactionDto | SdkOtherInvestmentTransactionDto)[]
|
|
405
|
+
invested: number
|
|
406
|
+
valuationCap?: number | null
|
|
407
|
+
discountRate?: number | null
|
|
408
|
+
interestRate?: number | null
|
|
409
|
+
interestType?: string | null
|
|
410
|
+
compounded?: string | null
|
|
411
|
+
dayCountConvention?: string | null
|
|
412
|
+
maturityDate?: string | null
|
|
413
|
+
warrantedOwnership?: number | null
|
|
414
|
+
payments?: SdkTransactionPaymentDto[]
|
|
415
|
+
}
|
|
416
|
+
|
|
417
|
+
export interface SdkEquityTransactionDto {
|
|
418
|
+
id: number
|
|
419
|
+
type: "EquityInvestment" | "EquityReceived" | "OptionsReceived"
|
|
420
|
+
date: string
|
|
421
|
+
companyId: number
|
|
422
|
+
companyGroupId?: number | null
|
|
423
|
+
company?: SdkCompanyReferenceDto
|
|
424
|
+
companyGroup?: SdkCompanyGroupReferenceDto
|
|
425
|
+
currency?: string | null
|
|
426
|
+
additionalInfo?: SdkTransactionAdditionalInfoDto
|
|
427
|
+
children?: (SdkEquityTransactionDto | SdkConvertibleNoteTransactionDto | SdkFutureEquityAgreementTransactionDto | SdkExtendTransactionDto | SdkConversionTransactionDto | SdkExitTransactionDto | SdkValuationChangeTransactionDto | SdkInsolvencyTransactionDto | SdkOtherInvestmentTransactionDto)[]
|
|
428
|
+
invested?: number | null
|
|
429
|
+
pricePerShare?: number | null
|
|
430
|
+
sharesAcquired?: number | null
|
|
431
|
+
sharesIssuedTotalDiluted?: number | null
|
|
432
|
+
sharesIssuedTotalCurrent?: number | null
|
|
433
|
+
companyPostMoneyValuation?: number | null
|
|
434
|
+
}
|
|
435
|
+
|
|
436
|
+
export interface SdkTransactionsListResponseDto {
|
|
437
|
+
data: (SdkEquityTransactionDto | SdkConvertibleNoteTransactionDto | SdkFutureEquityAgreementTransactionDto | SdkExtendTransactionDto | SdkConversionTransactionDto | SdkExitTransactionDto | SdkValuationChangeTransactionDto | SdkInsolvencyTransactionDto | SdkOtherInvestmentTransactionDto)[]
|
|
438
|
+
meta: SdkPaginationMetaDto
|
|
439
|
+
}
|
|
440
|
+
|
|
441
|
+
export interface SdkMetricUnitDto {
|
|
442
|
+
unit: { }
|
|
443
|
+
currencyCode?: string | null
|
|
444
|
+
}
|
|
445
|
+
|
|
446
|
+
export interface SdkMetricTypeDto {
|
|
447
|
+
id: number
|
|
448
|
+
name: string
|
|
449
|
+
shortName?: string | null
|
|
450
|
+
description?: string | null
|
|
451
|
+
origin?: { }
|
|
452
|
+
aggMethod: { }
|
|
453
|
+
valueType?: { }
|
|
454
|
+
unit?: SdkMetricUnitDto
|
|
455
|
+
}
|
|
456
|
+
|
|
457
|
+
export interface SdkMetricTypesListResponseDto {
|
|
458
|
+
data: SdkMetricTypeDto[]
|
|
459
|
+
meta: SdkPaginationMetaDto
|
|
460
|
+
}
|
|
461
|
+
|
|
462
|
+
export interface SdkMetricPointDto {
|
|
463
|
+
date: string
|
|
464
|
+
timeframe: { }
|
|
465
|
+
value: number | null
|
|
466
|
+
valueError?: string | null
|
|
467
|
+
aggregated?: boolean
|
|
468
|
+
}
|
|
469
|
+
|
|
470
|
+
export interface SdkCompanyMetricDto {
|
|
471
|
+
id: number
|
|
472
|
+
metricType: SdkMetricTypeDto
|
|
473
|
+
points: SdkMetricPointDto[]
|
|
474
|
+
}
|
|
475
|
+
|
|
476
|
+
export interface SdkCompanyMetricsDto {
|
|
477
|
+
companyId: number
|
|
478
|
+
company: SdkCompanyReferenceDto
|
|
479
|
+
metrics: SdkCompanyMetricDto[]
|
|
480
|
+
}
|
|
481
|
+
|
|
482
|
+
export interface SdkCompanyMetricsListResponseDto {
|
|
483
|
+
data: SdkCompanyMetricsDto[]
|
|
484
|
+
meta: SdkPaginationMetaDto
|
|
485
|
+
}
|
|
486
|
+
|
|
487
|
+
export interface MetricSearchDto {
|
|
488
|
+
limit?: number
|
|
489
|
+
cursor?: string
|
|
490
|
+
companyIds?: number[]
|
|
491
|
+
companyGroupIds?: number[]
|
|
492
|
+
metricTypeIds?: number[]
|
|
493
|
+
timeframe?: "Month" | "Quarter" | "Year"
|
|
494
|
+
from?: string
|
|
495
|
+
to?: string
|
|
496
|
+
}
|
|
497
|
+
|
|
498
|
+
export interface SdkCompanyReportSummaryDto {
|
|
499
|
+
id: number
|
|
500
|
+
title: string
|
|
501
|
+
date: string
|
|
502
|
+
timeframe: { }
|
|
503
|
+
publishedAt?: string | null
|
|
504
|
+
company: SdkCompanyReferenceDto
|
|
505
|
+
}
|
|
506
|
+
|
|
507
|
+
export interface SdkCompanyReportsListResponseDto {
|
|
508
|
+
data: SdkCompanyReportSummaryDto[]
|
|
509
|
+
meta: SdkPaginationMetaDto
|
|
510
|
+
}
|
|
511
|
+
|
|
512
|
+
export interface SdkUserReferenceDto {
|
|
513
|
+
id: number
|
|
514
|
+
name: string
|
|
515
|
+
}
|
|
516
|
+
|
|
517
|
+
export interface SdkCompanyReportAttachmentDto {
|
|
518
|
+
id: number
|
|
519
|
+
name: string
|
|
520
|
+
url?: string | null
|
|
521
|
+
}
|
|
522
|
+
|
|
523
|
+
export interface SdkCompanyReportSectionDto {
|
|
524
|
+
id: number
|
|
525
|
+
type: { }
|
|
526
|
+
order: number
|
|
527
|
+
title: string
|
|
528
|
+
content?: string | null
|
|
529
|
+
file?: SdkCompanyReportAttachmentDto
|
|
530
|
+
imageUrl?: string | null
|
|
531
|
+
}
|
|
532
|
+
|
|
533
|
+
export interface SdkCompanyReportDto {
|
|
534
|
+
id: number
|
|
535
|
+
title: string
|
|
536
|
+
date: string
|
|
537
|
+
timeframe: { }
|
|
538
|
+
publishedAt?: string | null
|
|
539
|
+
company: SdkCompanyReferenceDto
|
|
540
|
+
createdBy?: SdkUserReferenceDto
|
|
541
|
+
sections: SdkCompanyReportSectionDto[]
|
|
542
|
+
attachments: SdkCompanyReportAttachmentDto[]
|
|
160
543
|
}
|
|
161
544
|
|
|
162
545
|
export type CompaniesGetOneResponse = SdkCompanyDto
|
|
163
546
|
|
|
164
|
-
export type CompaniesGetAllResponse =
|
|
547
|
+
export type CompaniesGetAllResponse = SdkCompaniesListResponseDto
|
|
165
548
|
|
|
166
|
-
export type CompanyGroupsGetAllResponse =
|
|
549
|
+
export type CompanyGroupsGetAllResponse = SdkCompanyGroupsListResponseDto
|
|
167
550
|
|
|
168
551
|
export type CompanyGroupsGetOneResponse = SdkCompanyGroupDto
|
|
169
552
|
|
|
170
|
-
export type PositionsGetCompanyPositionsResponse =
|
|
553
|
+
export type PositionsGetCompanyPositionsResponse = SdkCompanyPositionsListResponseDto
|
|
171
554
|
|
|
172
555
|
export type PositionsGetPortfolioPositionsResponse = SdkPortfolioPositionDto
|
|
173
556
|
|
|
174
|
-
export type TransactionsGetCompanyTransactionsResponse =
|
|
557
|
+
export type TransactionsGetCompanyTransactionsResponse = SdkTransactionsListResponseDto
|
|
558
|
+
|
|
559
|
+
export type TransactionsGetTransactionsResponse = SdkTransactionsListResponseDto
|
|
560
|
+
|
|
561
|
+
export type MetricsGetTypesResponse = SdkMetricTypesListResponseDto
|
|
175
562
|
|
|
176
|
-
export type
|
|
563
|
+
export type MetricsSearchResponse = SdkCompanyMetricsListResponseDto
|
|
564
|
+
|
|
565
|
+
export type MetricsSearchBody = MetricSearchDto
|
|
566
|
+
|
|
567
|
+
export type CompanyReportsListResponse = SdkCompanyReportsListResponseDto
|
|
568
|
+
|
|
569
|
+
export type CompanyReportsGetOneResponse = SdkCompanyReportDto
|
|
570
|
+
|
|
571
|
+
export interface CompaniesGetAllQuery {
|
|
572
|
+
/**
|
|
573
|
+
* Maximum items per page. Currently accepted but not enforced; reserved for future pagination.
|
|
574
|
+
*/
|
|
575
|
+
limit?: number
|
|
576
|
+
/**
|
|
577
|
+
* Opaque cursor from a previous response's meta.nextCursor. Currently accepted but ignored.
|
|
578
|
+
*/
|
|
579
|
+
cursor?: string
|
|
580
|
+
/**
|
|
581
|
+
* Restrict results to these company identifiers
|
|
582
|
+
*/
|
|
583
|
+
companyIds?: number[]
|
|
584
|
+
/**
|
|
585
|
+
* Restrict results to companies that belong to any of these company groups
|
|
586
|
+
*/
|
|
587
|
+
companyGroupIds?: number[]
|
|
588
|
+
}
|
|
589
|
+
|
|
590
|
+
export interface CompanyGroupsGetAllQuery {
|
|
591
|
+
/**
|
|
592
|
+
* Maximum items per page. Currently accepted but not enforced; reserved for future pagination.
|
|
593
|
+
*/
|
|
594
|
+
limit?: number
|
|
595
|
+
/**
|
|
596
|
+
* Opaque cursor from a previous response's meta.nextCursor. Currently accepted but ignored.
|
|
597
|
+
*/
|
|
598
|
+
cursor?: string
|
|
599
|
+
/**
|
|
600
|
+
* Restrict results to these company group identifiers
|
|
601
|
+
*/
|
|
602
|
+
companyGroupIds?: number[]
|
|
603
|
+
}
|
|
177
604
|
|
|
178
605
|
export interface PositionsGetCompanyPositionsQuery {
|
|
179
606
|
/**
|
|
180
|
-
*
|
|
607
|
+
* Maximum items per page. Currently accepted but not enforced; reserved for future pagination.
|
|
608
|
+
*/
|
|
609
|
+
limit?: number
|
|
610
|
+
/**
|
|
611
|
+
* Opaque cursor from a previous response's meta.nextCursor. Currently accepted but ignored.
|
|
612
|
+
*/
|
|
613
|
+
cursor?: string
|
|
614
|
+
/**
|
|
615
|
+
* Optional list of company group identifiers to filter the position breakdown
|
|
181
616
|
*/
|
|
182
|
-
|
|
617
|
+
companyGroupIds?: number[]
|
|
183
618
|
/**
|
|
184
619
|
* Reporting currency code
|
|
185
620
|
*/
|
|
@@ -195,6 +630,10 @@ export interface PositionsGetPortfolioPositionsQuery {
|
|
|
195
630
|
* Optional list of company group identifiers to filter the portfolio positions
|
|
196
631
|
*/
|
|
197
632
|
companyGroupIds?: number[]
|
|
633
|
+
/**
|
|
634
|
+
* Optional list of company identifiers to narrow the aggregation to
|
|
635
|
+
*/
|
|
636
|
+
companyIds?: number[]
|
|
198
637
|
/**
|
|
199
638
|
* Reporting currency code
|
|
200
639
|
*/
|
|
@@ -206,23 +645,86 @@ export interface PositionsGetPortfolioPositionsQuery {
|
|
|
206
645
|
}
|
|
207
646
|
|
|
208
647
|
export interface TransactionsGetCompanyTransactionsQuery {
|
|
648
|
+
/**
|
|
649
|
+
* Maximum items per page. Currently accepted but not enforced; reserved for future pagination.
|
|
650
|
+
*/
|
|
651
|
+
limit?: number
|
|
652
|
+
/**
|
|
653
|
+
* Opaque cursor from a previous response's meta.nextCursor. Currently accepted but ignored.
|
|
654
|
+
*/
|
|
655
|
+
cursor?: string
|
|
209
656
|
/**
|
|
210
657
|
* Optional company group identifiers to filter transactions by
|
|
211
658
|
*/
|
|
212
659
|
companyGroupIds?: number[]
|
|
660
|
+
/**
|
|
661
|
+
* Restrict results to these transaction types
|
|
662
|
+
*/
|
|
663
|
+
types?: ("Auction" | "ConvertibleNote" | "ConvertToEquity" | "Dividend" | "EquityInvestment" | "EquityReceived" | "Extend" | "FutureEquityAgreement" | "Insolvency" | "IPO" | "LimitedAuction" | "OptionsReceived" | "OtherExit" | "OtherInvestment" | "OtherRealization" | "Payback" | "Proprietary" | "TradeSale" | "ValuationChange" | "WriteOff")[]
|
|
664
|
+
/**
|
|
665
|
+
* Exclude transactions on or after this ISO 8601 date (cut-off filter)
|
|
666
|
+
*/
|
|
667
|
+
priorTo?: string
|
|
213
668
|
}
|
|
214
669
|
|
|
215
670
|
export interface TransactionsGetTransactionsQuery {
|
|
671
|
+
/**
|
|
672
|
+
* Maximum items per page. Currently accepted but not enforced; reserved for future pagination.
|
|
673
|
+
*/
|
|
674
|
+
limit?: number
|
|
675
|
+
/**
|
|
676
|
+
* Opaque cursor from a previous response's meta.nextCursor. Currently accepted but ignored.
|
|
677
|
+
*/
|
|
678
|
+
cursor?: string
|
|
216
679
|
/**
|
|
217
680
|
* Optional company group identifiers to filter transactions by
|
|
218
681
|
*/
|
|
219
682
|
companyGroupIds?: number[]
|
|
683
|
+
/**
|
|
684
|
+
* Restrict results to these transaction types
|
|
685
|
+
*/
|
|
686
|
+
types?: ("Auction" | "ConvertibleNote" | "ConvertToEquity" | "Dividend" | "EquityInvestment" | "EquityReceived" | "Extend" | "FutureEquityAgreement" | "Insolvency" | "IPO" | "LimitedAuction" | "OptionsReceived" | "OtherExit" | "OtherInvestment" | "OtherRealization" | "Payback" | "Proprietary" | "TradeSale" | "ValuationChange" | "WriteOff")[]
|
|
687
|
+
/**
|
|
688
|
+
* Exclude transactions on or after this ISO 8601 date (cut-off filter)
|
|
689
|
+
*/
|
|
690
|
+
priorTo?: string
|
|
220
691
|
/**
|
|
221
692
|
* Optional company identifiers to filter transactions by
|
|
222
693
|
*/
|
|
223
694
|
companyIds?: number[]
|
|
224
695
|
}
|
|
225
696
|
|
|
697
|
+
export interface CompanyReportsListQuery {
|
|
698
|
+
/**
|
|
699
|
+
* Maximum items per page. Currently accepted but not enforced; reserved for future pagination.
|
|
700
|
+
*/
|
|
701
|
+
limit?: number
|
|
702
|
+
/**
|
|
703
|
+
* Opaque cursor from a previous response's meta.nextCursor. Currently accepted but ignored.
|
|
704
|
+
*/
|
|
705
|
+
cursor?: string
|
|
706
|
+
/**
|
|
707
|
+
* Restrict results to these companies. Defaults to all companies the caller can access.
|
|
708
|
+
*/
|
|
709
|
+
companyIds?: number[]
|
|
710
|
+
/**
|
|
711
|
+
* Restrict to companies that belong to any of these company groups.
|
|
712
|
+
*/
|
|
713
|
+
companyGroupIds?: number[]
|
|
714
|
+
/**
|
|
715
|
+
* Restrict to a reporting period granularity (Month, Quarter, Year).
|
|
716
|
+
*/
|
|
717
|
+
timeframe?: "Month" | "Quarter" | "Year"
|
|
718
|
+
/**
|
|
719
|
+
* Lower bound for the reporting period date (ISO 8601, inclusive).
|
|
720
|
+
*/
|
|
721
|
+
from?: string
|
|
722
|
+
/**
|
|
723
|
+
* Upper bound for the reporting period date (ISO 8601, inclusive).
|
|
724
|
+
*/
|
|
725
|
+
to?: string
|
|
726
|
+
}
|
|
727
|
+
|
|
226
728
|
export interface CompaniesNamespace {
|
|
227
729
|
/**
|
|
228
730
|
* Get one company available to the SDK consumer
|
|
@@ -232,17 +734,19 @@ export interface CompaniesNamespace {
|
|
|
232
734
|
getOne(id: number, init?: RequestOptions): Promise<CompaniesGetOneResponse>
|
|
233
735
|
/**
|
|
234
736
|
* List companies available to the SDK consumer
|
|
737
|
+
* Parameters: query: limit? (number), cursor? (string), companyIds? (number[]), companyGroupIds? (number[])
|
|
235
738
|
* Returns: CompaniesGetAllResponse
|
|
236
739
|
*/
|
|
237
|
-
getAll(init?: RequestOptions): Promise<CompaniesGetAllResponse>
|
|
740
|
+
getAll(query?: CompaniesGetAllQuery, init?: RequestOptions): Promise<CompaniesGetAllResponse>
|
|
238
741
|
}
|
|
239
742
|
|
|
240
743
|
export interface CompanyGroupsNamespace {
|
|
241
744
|
/**
|
|
242
745
|
* List company groups available to the SDK consumer
|
|
746
|
+
* Parameters: query: limit? (number), cursor? (string), companyGroupIds? (number[])
|
|
243
747
|
* Returns: CompanyGroupsGetAllResponse
|
|
244
748
|
*/
|
|
245
|
-
getAll(init?: RequestOptions): Promise<CompanyGroupsGetAllResponse>
|
|
749
|
+
getAll(query?: CompanyGroupsGetAllQuery, init?: RequestOptions): Promise<CompanyGroupsGetAllResponse>
|
|
246
750
|
/**
|
|
247
751
|
* Get one company group available to the SDK consumer
|
|
248
752
|
* Parameters: path: id (number)
|
|
@@ -254,13 +758,13 @@ export interface CompanyGroupsNamespace {
|
|
|
254
758
|
export interface PositionsNamespace {
|
|
255
759
|
/**
|
|
256
760
|
* Get positions for one company
|
|
257
|
-
* Parameters: path: id (number); query:
|
|
761
|
+
* Parameters: path: id (number); query: limit? (number), cursor? (string), companyGroupIds? (number[]), currency (string), date? (string)
|
|
258
762
|
* Returns: PositionsGetCompanyPositionsResponse
|
|
259
763
|
*/
|
|
260
764
|
getCompanyPositions(id: number, query?: PositionsGetCompanyPositionsQuery, init?: RequestOptions): Promise<PositionsGetCompanyPositionsResponse>
|
|
261
765
|
/**
|
|
262
766
|
* Get portfolio positions
|
|
263
|
-
* Parameters: query: companyGroupIds? (number[]), currency (string), date? (string)
|
|
767
|
+
* Parameters: query: companyGroupIds? (number[]), companyIds? (number[]), currency (string), date? (string)
|
|
264
768
|
* Returns: PositionsGetPortfolioPositionsResponse
|
|
265
769
|
*/
|
|
266
770
|
getPortfolioPositions(query?: PositionsGetPortfolioPositionsQuery, init?: RequestOptions): Promise<PositionsGetPortfolioPositionsResponse>
|
|
@@ -269,23 +773,58 @@ export interface PositionsNamespace {
|
|
|
269
773
|
export interface TransactionsNamespace {
|
|
270
774
|
/**
|
|
271
775
|
* Get transactions for one company
|
|
272
|
-
* Parameters: path: id (number); query: companyGroupIds? (number[])
|
|
776
|
+
* Parameters: path: id (number); query: limit? (number), cursor? (string), companyGroupIds? (number[]), types? (("Auction" | "ConvertibleNote" | "ConvertToEquity" | "Dividend" | "EquityInvestment" | "EquityReceived" | "Extend" | "FutureEquityAgreement" | "Insolvency" | "IPO" | "LimitedAuction" | "OptionsReceived" | "OtherExit" | "OtherInvestment" | "OtherRealization" | "Payback" | "Proprietary" | "TradeSale" | "ValuationChange" | "WriteOff")[]), priorTo? (string)
|
|
273
777
|
* Returns: TransactionsGetCompanyTransactionsResponse
|
|
274
778
|
*/
|
|
275
779
|
getCompanyTransactions(id: number, query?: TransactionsGetCompanyTransactionsQuery, init?: RequestOptions): Promise<TransactionsGetCompanyTransactionsResponse>
|
|
276
780
|
/**
|
|
277
781
|
* Get transactions for multiple companies
|
|
278
|
-
* Parameters: query: companyGroupIds? (number[]), companyIds? (number[])
|
|
782
|
+
* Parameters: query: limit? (number), cursor? (string), companyGroupIds? (number[]), types? (("Auction" | "ConvertibleNote" | "ConvertToEquity" | "Dividend" | "EquityInvestment" | "EquityReceived" | "Extend" | "FutureEquityAgreement" | "Insolvency" | "IPO" | "LimitedAuction" | "OptionsReceived" | "OtherExit" | "OtherInvestment" | "OtherRealization" | "Payback" | "Proprietary" | "TradeSale" | "ValuationChange" | "WriteOff")[]), priorTo? (string), companyIds? (number[])
|
|
279
783
|
* Returns: TransactionsGetTransactionsResponse
|
|
280
784
|
*/
|
|
281
785
|
getTransactions(query?: TransactionsGetTransactionsQuery, init?: RequestOptions): Promise<TransactionsGetTransactionsResponse>
|
|
282
786
|
}
|
|
283
787
|
|
|
788
|
+
export interface MetricsNamespace {
|
|
789
|
+
/**
|
|
790
|
+
* List metric types available to the SDK consumer
|
|
791
|
+
* Returns predefined metric types plus user-defined metric types scoped to the caller — VC group custom types for VC users, company custom types for company users. Each entry includes a numeric id and a human-readable name suitable for display or LLM context.
|
|
792
|
+
* Returns: MetricsGetTypesResponse
|
|
793
|
+
*/
|
|
794
|
+
getTypes(init?: RequestOptions): Promise<MetricsGetTypesResponse>
|
|
795
|
+
/**
|
|
796
|
+
* Read metric values for accessible companies, grouped by company
|
|
797
|
+
* Returns metric data points for companies the caller can access (companies in the caller's VC group portfolio, or the caller's own company for company users). Each entry carries company and metric type references with id and human-readable name. Filter by company, company group, metric type, timeframe, and date range to narrow the response.
|
|
798
|
+
* Parameters: body: MetricsSearchBody
|
|
799
|
+
* Returns: MetricsSearchResponse
|
|
800
|
+
*/
|
|
801
|
+
search(body: MetricsSearchBody, init?: RequestOptions): Promise<MetricsSearchResponse>
|
|
802
|
+
}
|
|
803
|
+
|
|
804
|
+
export interface CompanyReportsNamespace {
|
|
805
|
+
/**
|
|
806
|
+
* List published company reports accessible to the caller (metadata only)
|
|
807
|
+
* Returns lightweight report metadata (id, title, period, publisher company reference). Use GET /company-reports/:id to fetch the full content of a specific report. Visibility is determined by the caller's roles — VC users see reports for managed-portfolio companies, company employees see their own company's reports, portfolio investors see Published reports shared with their visibility groups. Filters narrow the list by company ids and reporting period (timeframe + date range).
|
|
808
|
+
* Parameters: query: limit? (number), cursor? (string), companyIds? (number[]), companyGroupIds? (number[]), timeframe? ("Month" | "Quarter" | "Year"), from? (string), to? (string)
|
|
809
|
+
* Returns: CompanyReportsListResponse
|
|
810
|
+
*/
|
|
811
|
+
list(query?: CompanyReportsListQuery, init?: RequestOptions): Promise<CompanyReportsListResponse>
|
|
812
|
+
/**
|
|
813
|
+
* Fetch the full content of a single company report
|
|
814
|
+
* Returns the report metadata plus structured sections (text/markdown/image) and attachments with pre-signed URLs. Returns 404 if the report does not exist and 403 if the caller cannot access it under their role-based permissions.
|
|
815
|
+
* Parameters: path: id (number)
|
|
816
|
+
* Returns: CompanyReportsGetOneResponse
|
|
817
|
+
*/
|
|
818
|
+
getOne(id: number, init?: RequestOptions): Promise<CompanyReportsGetOneResponse>
|
|
819
|
+
}
|
|
820
|
+
|
|
284
821
|
export interface EmbedClient {
|
|
285
822
|
companies: CompaniesNamespace
|
|
286
823
|
companyGroups: CompanyGroupsNamespace
|
|
287
824
|
positions: PositionsNamespace
|
|
288
825
|
transactions: TransactionsNamespace
|
|
826
|
+
metrics: MetricsNamespace
|
|
827
|
+
companyReports: CompanyReportsNamespace
|
|
289
828
|
}
|
|
290
829
|
|
|
291
830
|
export declare function createEmbedClient(options: CreateEmbedClientOptions): EmbedClient
|
|
@@ -293,10 +832,10 @@ export declare function createEmbedClient(options: CreateEmbedClientOptions): Em
|
|
|
293
832
|
export declare const routeManifest: {
|
|
294
833
|
companies: {
|
|
295
834
|
getOne: { method: "GET"; path: "/companies/:id"; summary: "Get one company available to the SDK consumer"; description: null; exampleCall: "client.companies.getOne(123)"; responseType: "CompaniesGetOneResponse"; pathParams: { name: string; type: string; description: string | null }[]; queryParams: { name: string; type: string; required: boolean; description: string | null }[] }
|
|
296
|
-
getAll: { method: "GET"; path: "/companies"; summary: "List companies available to the SDK consumer"; description: null; exampleCall: "client.companies.getAll()"; responseType: "CompaniesGetAllResponse"; pathParams: { name: string; type: string; description: string | null }[]; queryParams: { name: string; type: string; required: boolean; description: string | null }[] }
|
|
835
|
+
getAll: { method: "GET"; path: "/companies"; summary: "List companies available to the SDK consumer"; description: null; exampleCall: "client.companies.getAll({ limit: 123 })"; responseType: "CompaniesGetAllResponse"; pathParams: { name: string; type: string; description: string | null }[]; queryParams: { name: string; type: string; required: boolean; description: string | null }[] }
|
|
297
836
|
}
|
|
298
837
|
companyGroups: {
|
|
299
|
-
getAll: { method: "GET"; path: "/company-groups"; summary: "List company groups available to the SDK consumer"; description: null; exampleCall: "client.companyGroups.getAll()"; responseType: "CompanyGroupsGetAllResponse"; pathParams: { name: string; type: string; description: string | null }[]; queryParams: { name: string; type: string; required: boolean; description: string | null }[] }
|
|
838
|
+
getAll: { method: "GET"; path: "/company-groups"; summary: "List company groups available to the SDK consumer"; description: null; exampleCall: "client.companyGroups.getAll({ limit: 123 })"; responseType: "CompanyGroupsGetAllResponse"; pathParams: { name: string; type: string; description: string | null }[]; queryParams: { name: string; type: string; required: boolean; description: string | null }[] }
|
|
300
839
|
getOne: { method: "GET"; path: "/company-groups/:id"; summary: "Get one company group available to the SDK consumer"; description: null; exampleCall: "client.companyGroups.getOne(123)"; responseType: "CompanyGroupsGetOneResponse"; pathParams: { name: string; type: string; description: string | null }[]; queryParams: { name: string; type: string; required: boolean; description: string | null }[] }
|
|
301
840
|
}
|
|
302
841
|
positions: {
|
|
@@ -304,7 +843,15 @@ export declare const routeManifest: {
|
|
|
304
843
|
getPortfolioPositions: { method: "GET"; path: "/positions/portfolio"; summary: "Get portfolio positions"; description: null; exampleCall: "client.positions.getPortfolioPositions({ currency: 'USD' })"; responseType: "PositionsGetPortfolioPositionsResponse"; pathParams: { name: string; type: string; description: string | null }[]; queryParams: { name: string; type: string; required: boolean; description: string | null }[] }
|
|
305
844
|
}
|
|
306
845
|
transactions: {
|
|
307
|
-
getCompanyTransactions: { method: "GET"; path: "/transactions/companies/:id"; summary: "Get transactions for one company"; description: null; exampleCall: "client.transactions.getCompanyTransactions(123, {
|
|
308
|
-
getTransactions: { method: "GET"; path: "/transactions"; summary: "Get transactions for multiple companies"; description: null; exampleCall: "client.transactions.getTransactions({
|
|
846
|
+
getCompanyTransactions: { method: "GET"; path: "/transactions/companies/:id"; summary: "Get transactions for one company"; description: null; exampleCall: "client.transactions.getCompanyTransactions(123, { limit: 123 })"; responseType: "TransactionsGetCompanyTransactionsResponse"; pathParams: { name: string; type: string; description: string | null }[]; queryParams: { name: string; type: string; required: boolean; description: string | null }[] }
|
|
847
|
+
getTransactions: { method: "GET"; path: "/transactions"; summary: "Get transactions for multiple companies"; description: null; exampleCall: "client.transactions.getTransactions({ limit: 123 })"; responseType: "TransactionsGetTransactionsResponse"; pathParams: { name: string; type: string; description: string | null }[]; queryParams: { name: string; type: string; required: boolean; description: string | null }[] }
|
|
848
|
+
}
|
|
849
|
+
metrics: {
|
|
850
|
+
getTypes: { method: "GET"; path: "/metrics/types"; summary: "List metric types available to the SDK consumer"; description: "Returns predefined metric types plus user-defined metric types scoped to the caller — VC group custom types for VC users, company custom types for company users. Each entry includes a numeric id and a human-readable name suitable for display or LLM context."; exampleCall: "client.metrics.getTypes()"; responseType: "MetricsGetTypesResponse"; pathParams: { name: string; type: string; description: string | null }[]; queryParams: { name: string; type: string; required: boolean; description: string | null }[] }
|
|
851
|
+
search: { method: "POST"; path: "/metrics"; summary: "Read metric values for accessible companies, grouped by company"; description: "Returns metric data points for companies the caller can access (companies in the caller's VC group portfolio, or the caller's own company for company users). Each entry carries company and metric type references with id and human-readable name. Filter by company, company group, metric type, timeframe, and date range to narrow the response."; exampleCall: "client.metrics.search({})"; responseType: "MetricsSearchResponse"; pathParams: { name: string; type: string; description: string | null }[]; queryParams: { name: string; type: string; required: boolean; description: string | null }[] }
|
|
852
|
+
}
|
|
853
|
+
companyReports: {
|
|
854
|
+
list: { method: "GET"; path: "/company-reports"; summary: "List published company reports accessible to the caller (metadata only)"; description: "Returns lightweight report metadata (id, title, period, publisher company reference). Use GET /company-reports/:id to fetch the full content of a specific report. Visibility is determined by the caller's roles — VC users see reports for managed-portfolio companies, company employees see their own company's reports, portfolio investors see Published reports shared with their visibility groups. Filters narrow the list by company ids and reporting period (timeframe + date range)."; exampleCall: "client.companyReports.list({ limit: 123 })"; responseType: "CompanyReportsListResponse"; pathParams: { name: string; type: string; description: string | null }[]; queryParams: { name: string; type: string; required: boolean; description: string | null }[] }
|
|
855
|
+
getOne: { method: "GET"; path: "/company-reports/:id"; summary: "Fetch the full content of a single company report"; description: "Returns the report metadata plus structured sections (text/markdown/image) and attachments with pre-signed URLs. Returns 404 if the report does not exist and 403 if the caller cannot access it under their role-based permissions."; exampleCall: "client.companyReports.getOne(123)"; responseType: "CompanyReportsGetOneResponse"; pathParams: { name: string; type: string; description: string | null }[]; queryParams: { name: string; type: string; required: boolean; description: string | null }[] }
|
|
309
856
|
}
|
|
310
857
|
}
|