@rundit-sdk/embed 0.2.0 → 0.3.0-rc.13

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/openapi.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "openapi": "3.0.0",
3
3
  "paths": {
4
- "/api/v1/sdk/companies/{id}": {
4
+ "/api/v2/sdk/companies/{id}": {
5
5
  "get": {
6
6
  "operationId": "companies.getOne",
7
7
  "parameters": [
@@ -50,20 +50,60 @@
50
50
  "x-sdk-operation": "getOne"
51
51
  }
52
52
  },
53
- "/api/v1/sdk/companies": {
53
+ "/api/v2/sdk/companies": {
54
54
  "get": {
55
55
  "operationId": "companies.getAll",
56
- "parameters": [],
56
+ "parameters": [
57
+ {
58
+ "name": "limit",
59
+ "required": false,
60
+ "in": "query",
61
+ "description": "Maximum items per page. Currently accepted but not enforced; reserved for future pagination.",
62
+ "schema": {
63
+ "type": "number"
64
+ }
65
+ },
66
+ {
67
+ "name": "cursor",
68
+ "required": false,
69
+ "in": "query",
70
+ "description": "Opaque cursor from a previous response's meta.nextCursor. Currently accepted but ignored.",
71
+ "schema": {
72
+ "type": "string"
73
+ }
74
+ },
75
+ {
76
+ "name": "companyIds",
77
+ "required": false,
78
+ "in": "query",
79
+ "description": "Restrict results to these company identifiers",
80
+ "schema": {
81
+ "type": "array",
82
+ "items": {
83
+ "type": "number"
84
+ }
85
+ }
86
+ },
87
+ {
88
+ "name": "companyGroupIds",
89
+ "required": false,
90
+ "in": "query",
91
+ "description": "Restrict results to companies that belong to any of these company groups",
92
+ "schema": {
93
+ "type": "array",
94
+ "items": {
95
+ "type": "number"
96
+ }
97
+ }
98
+ }
99
+ ],
57
100
  "responses": {
58
101
  "200": {
59
102
  "description": "",
60
103
  "content": {
61
104
  "application/json": {
62
105
  "schema": {
63
- "type": "array",
64
- "items": {
65
- "$ref": "#/components/schemas/SdkCompactCompanyDto"
66
- }
106
+ "$ref": "#/components/schemas/SdkCompaniesListResponseDto"
67
107
  }
68
108
  }
69
109
  }
@@ -92,20 +132,48 @@
92
132
  "x-sdk-operation": "getAll"
93
133
  }
94
134
  },
95
- "/api/v1/sdk/company-groups": {
135
+ "/api/v2/sdk/company-groups": {
96
136
  "get": {
97
137
  "operationId": "companyGroups.getAll",
98
- "parameters": [],
138
+ "parameters": [
139
+ {
140
+ "name": "limit",
141
+ "required": false,
142
+ "in": "query",
143
+ "description": "Maximum items per page. Currently accepted but not enforced; reserved for future pagination.",
144
+ "schema": {
145
+ "type": "number"
146
+ }
147
+ },
148
+ {
149
+ "name": "cursor",
150
+ "required": false,
151
+ "in": "query",
152
+ "description": "Opaque cursor from a previous response's meta.nextCursor. Currently accepted but ignored.",
153
+ "schema": {
154
+ "type": "string"
155
+ }
156
+ },
157
+ {
158
+ "name": "companyGroupIds",
159
+ "required": false,
160
+ "in": "query",
161
+ "description": "Restrict results to these company group identifiers",
162
+ "schema": {
163
+ "type": "array",
164
+ "items": {
165
+ "type": "number"
166
+ }
167
+ }
168
+ }
169
+ ],
99
170
  "responses": {
100
171
  "200": {
101
172
  "description": "",
102
173
  "content": {
103
174
  "application/json": {
104
175
  "schema": {
105
- "type": "array",
106
- "items": {
107
- "$ref": "#/components/schemas/SdkCompactCompanyGroupDto"
108
- }
176
+ "$ref": "#/components/schemas/SdkCompanyGroupsListResponseDto"
109
177
  }
110
178
  }
111
179
  }
@@ -134,7 +202,7 @@
134
202
  "x-sdk-operation": "getAll"
135
203
  }
136
204
  },
137
- "/api/v1/sdk/company-groups/{id}": {
205
+ "/api/v2/sdk/company-groups/{id}": {
138
206
  "get": {
139
207
  "operationId": "companyGroups.getOne",
140
208
  "parameters": [
@@ -183,7 +251,7 @@
183
251
  "x-sdk-operation": "getOne"
184
252
  }
185
253
  },
186
- "/api/v1/sdk/positions/companies/{id}": {
254
+ "/api/v2/sdk/positions/companies/{id}": {
187
255
  "get": {
188
256
  "operationId": "positions.getCompanyPositions",
189
257
  "parameters": [
@@ -197,14 +265,35 @@
197
265
  }
198
266
  },
199
267
  {
200
- "name": "companyGroupId",
268
+ "name": "limit",
201
269
  "required": false,
202
270
  "in": "query",
203
- "description": "Optional company group identifier to filter by",
271
+ "description": "Maximum items per page. Currently accepted but not enforced; reserved for future pagination.",
204
272
  "schema": {
205
273
  "type": "number"
206
274
  }
207
275
  },
276
+ {
277
+ "name": "cursor",
278
+ "required": false,
279
+ "in": "query",
280
+ "description": "Opaque cursor from a previous response's meta.nextCursor. Currently accepted but ignored.",
281
+ "schema": {
282
+ "type": "string"
283
+ }
284
+ },
285
+ {
286
+ "name": "companyGroupIds",
287
+ "required": false,
288
+ "in": "query",
289
+ "description": "Optional list of company group identifiers to filter the position breakdown",
290
+ "schema": {
291
+ "type": "array",
292
+ "items": {
293
+ "type": "number"
294
+ }
295
+ }
296
+ },
208
297
  {
209
298
  "name": "currency",
210
299
  "required": true,
@@ -230,10 +319,7 @@
230
319
  "content": {
231
320
  "application/json": {
232
321
  "schema": {
233
- "type": "array",
234
- "items": {
235
- "$ref": "#/components/schemas/SdkCompanyPositionDto"
236
- }
322
+ "$ref": "#/components/schemas/SdkCompanyPositionsListResponseDto"
237
323
  }
238
324
  }
239
325
  }
@@ -262,7 +348,7 @@
262
348
  "x-sdk-operation": "getCompanyPositions"
263
349
  }
264
350
  },
265
- "/api/v1/sdk/positions/portfolio": {
351
+ "/api/v2/sdk/positions/portfolio": {
266
352
  "get": {
267
353
  "operationId": "positions.getPortfolioPositions",
268
354
  "parameters": [
@@ -278,6 +364,18 @@
278
364
  }
279
365
  }
280
366
  },
367
+ {
368
+ "name": "companyIds",
369
+ "required": false,
370
+ "in": "query",
371
+ "description": "Optional list of company identifiers to narrow the aggregation to",
372
+ "schema": {
373
+ "type": "array",
374
+ "items": {
375
+ "type": "number"
376
+ }
377
+ }
378
+ },
281
379
  {
282
380
  "name": "currency",
283
381
  "required": true,
@@ -332,7 +430,7 @@
332
430
  "x-sdk-operation": "getPortfolioPositions"
333
431
  }
334
432
  },
335
- "/api/v1/sdk/transactions/companies/{id}": {
433
+ "/api/v2/sdk/transactions/companies/{id}": {
336
434
  "get": {
337
435
  "operationId": "transactions.getCompanyTransactions",
338
436
  "parameters": [
@@ -345,6 +443,24 @@
345
443
  "type": "number"
346
444
  }
347
445
  },
446
+ {
447
+ "name": "limit",
448
+ "required": false,
449
+ "in": "query",
450
+ "description": "Maximum items per page. Currently accepted but not enforced; reserved for future pagination.",
451
+ "schema": {
452
+ "type": "number"
453
+ }
454
+ },
455
+ {
456
+ "name": "cursor",
457
+ "required": false,
458
+ "in": "query",
459
+ "description": "Opaque cursor from a previous response's meta.nextCursor. Currently accepted but ignored.",
460
+ "schema": {
461
+ "type": "string"
462
+ }
463
+ },
348
464
  {
349
465
  "name": "companyGroupIds",
350
466
  "required": false,
@@ -356,6 +472,49 @@
356
472
  "type": "number"
357
473
  }
358
474
  }
475
+ },
476
+ {
477
+ "name": "types",
478
+ "required": false,
479
+ "in": "query",
480
+ "description": "Restrict results to these transaction types",
481
+ "schema": {
482
+ "type": "array",
483
+ "items": {
484
+ "type": "string",
485
+ "enum": [
486
+ "Auction",
487
+ "ConvertibleNote",
488
+ "ConvertToEquity",
489
+ "Dividend",
490
+ "EquityInvestment",
491
+ "EquityReceived",
492
+ "Extend",
493
+ "FutureEquityAgreement",
494
+ "Insolvency",
495
+ "IPO",
496
+ "LimitedAuction",
497
+ "OptionsReceived",
498
+ "OtherExit",
499
+ "OtherInvestment",
500
+ "OtherRealization",
501
+ "Payback",
502
+ "Proprietary",
503
+ "TradeSale",
504
+ "ValuationChange",
505
+ "WriteOff"
506
+ ]
507
+ }
508
+ }
509
+ },
510
+ {
511
+ "name": "priorTo",
512
+ "required": false,
513
+ "in": "query",
514
+ "description": "Exclude transactions on or after this ISO 8601 date (cut-off filter)",
515
+ "schema": {
516
+ "type": "string"
517
+ }
359
518
  }
360
519
  ],
361
520
  "responses": {
@@ -364,63 +523,7 @@
364
523
  "content": {
365
524
  "application/json": {
366
525
  "schema": {
367
- "type": "array",
368
- "items": {
369
- "oneOf": [
370
- {
371
- "$ref": "#/components/schemas/SdkEquityTransactionDto"
372
- },
373
- {
374
- "$ref": "#/components/schemas/SdkConvertibleNoteTransactionDto"
375
- },
376
- {
377
- "$ref": "#/components/schemas/SdkFutureEquityAgreementTransactionDto"
378
- },
379
- {
380
- "$ref": "#/components/schemas/SdkExtendTransactionDto"
381
- },
382
- {
383
- "$ref": "#/components/schemas/SdkConversionTransactionDto"
384
- },
385
- {
386
- "$ref": "#/components/schemas/SdkExitTransactionDto"
387
- },
388
- {
389
- "$ref": "#/components/schemas/SdkValuationChangeTransactionDto"
390
- },
391
- {
392
- "$ref": "#/components/schemas/SdkInsolvencyTransactionDto"
393
- },
394
- {
395
- "$ref": "#/components/schemas/SdkOtherInvestmentTransactionDto"
396
- }
397
- ],
398
- "discriminator": {
399
- "propertyName": "type",
400
- "mapping": {
401
- "EquityInvestment": "#/components/schemas/SdkEquityTransactionDto",
402
- "EquityReceived": "#/components/schemas/SdkEquityTransactionDto",
403
- "OptionsReceived": "#/components/schemas/SdkEquityTransactionDto",
404
- "ConvertibleNote": "#/components/schemas/SdkConvertibleNoteTransactionDto",
405
- "FutureEquityAgreement": "#/components/schemas/SdkFutureEquityAgreementTransactionDto",
406
- "Extend": "#/components/schemas/SdkExtendTransactionDto",
407
- "ConvertToEquity": "#/components/schemas/SdkConversionTransactionDto",
408
- "Payback": "#/components/schemas/SdkConversionTransactionDto",
409
- "WriteOff": "#/components/schemas/SdkConversionTransactionDto",
410
- "TradeSale": "#/components/schemas/SdkExitTransactionDto",
411
- "IPO": "#/components/schemas/SdkExitTransactionDto",
412
- "Auction": "#/components/schemas/SdkExitTransactionDto",
413
- "LimitedAuction": "#/components/schemas/SdkExitTransactionDto",
414
- "Proprietary": "#/components/schemas/SdkExitTransactionDto",
415
- "OtherExit": "#/components/schemas/SdkExitTransactionDto",
416
- "Dividend": "#/components/schemas/SdkExitTransactionDto",
417
- "OtherRealization": "#/components/schemas/SdkExitTransactionDto",
418
- "ValuationChange": "#/components/schemas/SdkValuationChangeTransactionDto",
419
- "Insolvency": "#/components/schemas/SdkInsolvencyTransactionDto",
420
- "OtherInvestment": "#/components/schemas/SdkOtherInvestmentTransactionDto"
421
- }
422
- }
423
- }
526
+ "$ref": "#/components/schemas/SdkTransactionsListResponseDto"
424
527
  }
425
528
  }
426
529
  }
@@ -449,10 +552,28 @@
449
552
  "x-sdk-operation": "getCompanyTransactions"
450
553
  }
451
554
  },
452
- "/api/v1/sdk/transactions": {
555
+ "/api/v2/sdk/transactions": {
453
556
  "get": {
454
557
  "operationId": "transactions.getTransactions",
455
558
  "parameters": [
559
+ {
560
+ "name": "limit",
561
+ "required": false,
562
+ "in": "query",
563
+ "description": "Maximum items per page. Currently accepted but not enforced; reserved for future pagination.",
564
+ "schema": {
565
+ "type": "number"
566
+ }
567
+ },
568
+ {
569
+ "name": "cursor",
570
+ "required": false,
571
+ "in": "query",
572
+ "description": "Opaque cursor from a previous response's meta.nextCursor. Currently accepted but ignored.",
573
+ "schema": {
574
+ "type": "string"
575
+ }
576
+ },
456
577
  {
457
578
  "name": "companyGroupIds",
458
579
  "required": false,
@@ -465,6 +586,49 @@
465
586
  }
466
587
  }
467
588
  },
589
+ {
590
+ "name": "types",
591
+ "required": false,
592
+ "in": "query",
593
+ "description": "Restrict results to these transaction types",
594
+ "schema": {
595
+ "type": "array",
596
+ "items": {
597
+ "type": "string",
598
+ "enum": [
599
+ "Auction",
600
+ "ConvertibleNote",
601
+ "ConvertToEquity",
602
+ "Dividend",
603
+ "EquityInvestment",
604
+ "EquityReceived",
605
+ "Extend",
606
+ "FutureEquityAgreement",
607
+ "Insolvency",
608
+ "IPO",
609
+ "LimitedAuction",
610
+ "OptionsReceived",
611
+ "OtherExit",
612
+ "OtherInvestment",
613
+ "OtherRealization",
614
+ "Payback",
615
+ "Proprietary",
616
+ "TradeSale",
617
+ "ValuationChange",
618
+ "WriteOff"
619
+ ]
620
+ }
621
+ }
622
+ },
623
+ {
624
+ "name": "priorTo",
625
+ "required": false,
626
+ "in": "query",
627
+ "description": "Exclude transactions on or after this ISO 8601 date (cut-off filter)",
628
+ "schema": {
629
+ "type": "string"
630
+ }
631
+ },
468
632
  {
469
633
  "name": "companyIds",
470
634
  "required": false,
@@ -484,63 +648,7 @@
484
648
  "content": {
485
649
  "application/json": {
486
650
  "schema": {
487
- "type": "array",
488
- "items": {
489
- "oneOf": [
490
- {
491
- "$ref": "#/components/schemas/SdkEquityTransactionDto"
492
- },
493
- {
494
- "$ref": "#/components/schemas/SdkConvertibleNoteTransactionDto"
495
- },
496
- {
497
- "$ref": "#/components/schemas/SdkFutureEquityAgreementTransactionDto"
498
- },
499
- {
500
- "$ref": "#/components/schemas/SdkExtendTransactionDto"
501
- },
502
- {
503
- "$ref": "#/components/schemas/SdkConversionTransactionDto"
504
- },
505
- {
506
- "$ref": "#/components/schemas/SdkExitTransactionDto"
507
- },
508
- {
509
- "$ref": "#/components/schemas/SdkValuationChangeTransactionDto"
510
- },
511
- {
512
- "$ref": "#/components/schemas/SdkInsolvencyTransactionDto"
513
- },
514
- {
515
- "$ref": "#/components/schemas/SdkOtherInvestmentTransactionDto"
516
- }
517
- ],
518
- "discriminator": {
519
- "propertyName": "type",
520
- "mapping": {
521
- "EquityInvestment": "#/components/schemas/SdkEquityTransactionDto",
522
- "EquityReceived": "#/components/schemas/SdkEquityTransactionDto",
523
- "OptionsReceived": "#/components/schemas/SdkEquityTransactionDto",
524
- "ConvertibleNote": "#/components/schemas/SdkConvertibleNoteTransactionDto",
525
- "FutureEquityAgreement": "#/components/schemas/SdkFutureEquityAgreementTransactionDto",
526
- "Extend": "#/components/schemas/SdkExtendTransactionDto",
527
- "ConvertToEquity": "#/components/schemas/SdkConversionTransactionDto",
528
- "Payback": "#/components/schemas/SdkConversionTransactionDto",
529
- "WriteOff": "#/components/schemas/SdkConversionTransactionDto",
530
- "TradeSale": "#/components/schemas/SdkExitTransactionDto",
531
- "IPO": "#/components/schemas/SdkExitTransactionDto",
532
- "Auction": "#/components/schemas/SdkExitTransactionDto",
533
- "LimitedAuction": "#/components/schemas/SdkExitTransactionDto",
534
- "Proprietary": "#/components/schemas/SdkExitTransactionDto",
535
- "OtherExit": "#/components/schemas/SdkExitTransactionDto",
536
- "Dividend": "#/components/schemas/SdkExitTransactionDto",
537
- "OtherRealization": "#/components/schemas/SdkExitTransactionDto",
538
- "ValuationChange": "#/components/schemas/SdkValuationChangeTransactionDto",
539
- "Insolvency": "#/components/schemas/SdkInsolvencyTransactionDto",
540
- "OtherInvestment": "#/components/schemas/SdkOtherInvestmentTransactionDto"
541
- }
542
- }
543
- }
651
+ "$ref": "#/components/schemas/SdkTransactionsListResponseDto"
544
652
  }
545
653
  }
546
654
  }
@@ -568,62 +676,318 @@
568
676
  "x-sdk-namespace": "transactions",
569
677
  "x-sdk-operation": "getTransactions"
570
678
  }
571
- }
572
- },
573
- "info": {
574
- "title": "SDK API",
575
- "description": "SDK API documentation for embedded and API key clients",
576
- "version": "v1",
577
- "contact": {}
578
- },
579
- "tags": [],
580
- "servers": [],
581
- "components": {
582
- "securitySchemes": {
583
- "sdk-embed-token": {
584
- "scheme": "bearer",
585
- "bearerFormat": "JWT",
586
- "type": "http",
587
- "description": "Embed bearer token for embedded SDK clients"
588
- },
589
- "sdk-client-api-key": {
590
- "type": "apiKey",
591
- "in": "header",
592
- "name": "X-API-Key",
593
- "description": "API key for external SDK clients"
594
- }
595
679
  },
596
- "schemas": {
597
- "SdkCompanyDto": {
598
- "type": "object",
599
- "properties": {
600
- "id": {
601
- "type": "number",
602
- "description": "Company identifier"
603
- },
604
- "name": {
605
- "type": "string",
606
- "description": "Company display name"
607
- },
608
- "type": {
609
- "type": "string",
610
- "description": "Company type"
680
+ "/api/v2/sdk/metrics/types": {
681
+ "get": {
682
+ "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.",
683
+ "operationId": "metrics.getTypes",
684
+ "parameters": [],
685
+ "responses": {
686
+ "200": {
687
+ "description": "",
688
+ "content": {
689
+ "application/json": {
690
+ "schema": {
691
+ "$ref": "#/components/schemas/SdkMetricTypesListResponseDto"
692
+ }
693
+ }
694
+ }
611
695
  },
612
- "website": {
613
- "type": "string",
614
- "description": "Company website URL",
615
- "nullable": true
696
+ "401": {
697
+ "description": "Missing or invalid SDK credentials"
698
+ }
699
+ },
700
+ "security": [
701
+ {
702
+ "sdk-embed-token": []
616
703
  },
617
- "currency": {
618
- "type": "string",
619
- "description": "Company reporting currency as ISO 4217 code (e.g. USD, EUR)"
704
+ {
705
+ "sdk-client-api-key": []
706
+ }
707
+ ],
708
+ "summary": "List metric types available to the SDK consumer",
709
+ "tags": [
710
+ "sdk-metrics"
711
+ ],
712
+ "x-sdk-audiences": [
713
+ "embed",
714
+ "client"
715
+ ],
716
+ "x-sdk-namespace": "metrics",
717
+ "x-sdk-operation": "getTypes"
718
+ }
719
+ },
720
+ "/api/v2/sdk/metrics": {
721
+ "post": {
722
+ "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.",
723
+ "operationId": "metrics.search",
724
+ "parameters": [],
725
+ "requestBody": {
726
+ "required": true,
727
+ "content": {
728
+ "application/json": {
729
+ "schema": {
730
+ "$ref": "#/components/schemas/MetricSearchDto"
731
+ }
732
+ }
733
+ }
734
+ },
735
+ "responses": {
736
+ "200": {
737
+ "description": "",
738
+ "content": {
739
+ "application/json": {
740
+ "schema": {
741
+ "$ref": "#/components/schemas/SdkCompanyMetricsListResponseDto"
742
+ }
743
+ }
744
+ }
620
745
  },
621
- "logoImageFileUuid": {
622
- "type": "string",
623
- "description": "Logo image file UUID",
624
- "nullable": true
746
+ "401": {
747
+ "description": "Missing or invalid SDK credentials"
748
+ }
749
+ },
750
+ "security": [
751
+ {
752
+ "sdk-embed-token": []
625
753
  },
626
- "legalName": {
754
+ {
755
+ "sdk-client-api-key": []
756
+ }
757
+ ],
758
+ "summary": "Read metric values for accessible companies, grouped by company",
759
+ "tags": [
760
+ "sdk-metrics"
761
+ ],
762
+ "x-sdk-audiences": [
763
+ "embed",
764
+ "client"
765
+ ],
766
+ "x-sdk-namespace": "metrics",
767
+ "x-sdk-operation": "search"
768
+ }
769
+ },
770
+ "/api/v2/sdk/company-reports": {
771
+ "get": {
772
+ "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).",
773
+ "operationId": "companyReports.list",
774
+ "parameters": [
775
+ {
776
+ "name": "limit",
777
+ "required": false,
778
+ "in": "query",
779
+ "description": "Maximum items per page. Currently accepted but not enforced; reserved for future pagination.",
780
+ "schema": {
781
+ "type": "number"
782
+ }
783
+ },
784
+ {
785
+ "name": "cursor",
786
+ "required": false,
787
+ "in": "query",
788
+ "description": "Opaque cursor from a previous response's meta.nextCursor. Currently accepted but ignored.",
789
+ "schema": {
790
+ "type": "string"
791
+ }
792
+ },
793
+ {
794
+ "name": "companyIds",
795
+ "required": false,
796
+ "in": "query",
797
+ "description": "Restrict results to these companies. Defaults to all companies the caller can access.",
798
+ "schema": {
799
+ "type": "array",
800
+ "items": {
801
+ "type": "number"
802
+ }
803
+ }
804
+ },
805
+ {
806
+ "name": "companyGroupIds",
807
+ "required": false,
808
+ "in": "query",
809
+ "description": "Restrict to companies that belong to any of these company groups.",
810
+ "schema": {
811
+ "type": "array",
812
+ "items": {
813
+ "type": "number"
814
+ }
815
+ }
816
+ },
817
+ {
818
+ "name": "timeframe",
819
+ "required": false,
820
+ "in": "query",
821
+ "description": "Restrict to a reporting period granularity (Month, Quarter, Year).",
822
+ "schema": {
823
+ "type": "string",
824
+ "enum": [
825
+ "Month",
826
+ "Quarter",
827
+ "Year"
828
+ ]
829
+ }
830
+ },
831
+ {
832
+ "name": "from",
833
+ "required": false,
834
+ "in": "query",
835
+ "description": "Lower bound for the reporting period date (ISO 8601, inclusive).",
836
+ "schema": {
837
+ "type": "string"
838
+ }
839
+ },
840
+ {
841
+ "name": "to",
842
+ "required": false,
843
+ "in": "query",
844
+ "description": "Upper bound for the reporting period date (ISO 8601, inclusive).",
845
+ "schema": {
846
+ "type": "string"
847
+ }
848
+ }
849
+ ],
850
+ "responses": {
851
+ "200": {
852
+ "description": "",
853
+ "content": {
854
+ "application/json": {
855
+ "schema": {
856
+ "$ref": "#/components/schemas/SdkCompanyReportsListResponseDto"
857
+ }
858
+ }
859
+ }
860
+ },
861
+ "401": {
862
+ "description": "Missing or invalid SDK credentials"
863
+ }
864
+ },
865
+ "security": [
866
+ {
867
+ "sdk-embed-token": []
868
+ },
869
+ {
870
+ "sdk-client-api-key": []
871
+ }
872
+ ],
873
+ "summary": "List published company reports accessible to the caller (metadata only)",
874
+ "tags": [
875
+ "sdk-company-reports"
876
+ ],
877
+ "x-sdk-audiences": [
878
+ "embed",
879
+ "client"
880
+ ],
881
+ "x-sdk-namespace": "companyReports",
882
+ "x-sdk-operation": "list"
883
+ }
884
+ },
885
+ "/api/v2/sdk/company-reports/{id}": {
886
+ "get": {
887
+ "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.",
888
+ "operationId": "companyReports.getOne",
889
+ "parameters": [
890
+ {
891
+ "name": "id",
892
+ "required": true,
893
+ "in": "path",
894
+ "description": "Report identifier",
895
+ "schema": {
896
+ "type": "number"
897
+ }
898
+ }
899
+ ],
900
+ "responses": {
901
+ "200": {
902
+ "description": "",
903
+ "content": {
904
+ "application/json": {
905
+ "schema": {
906
+ "$ref": "#/components/schemas/SdkCompanyReportDto"
907
+ }
908
+ }
909
+ }
910
+ },
911
+ "401": {
912
+ "description": "Missing or invalid SDK credentials"
913
+ }
914
+ },
915
+ "security": [
916
+ {
917
+ "sdk-embed-token": []
918
+ },
919
+ {
920
+ "sdk-client-api-key": []
921
+ }
922
+ ],
923
+ "summary": "Fetch the full content of a single company report",
924
+ "tags": [
925
+ "sdk-company-reports"
926
+ ],
927
+ "x-sdk-audiences": [
928
+ "embed",
929
+ "client"
930
+ ],
931
+ "x-sdk-namespace": "companyReports",
932
+ "x-sdk-operation": "getOne"
933
+ }
934
+ }
935
+ },
936
+ "info": {
937
+ "title": "SDK API",
938
+ "description": "SDK API documentation for embedded and API key clients",
939
+ "version": "v2",
940
+ "contact": {}
941
+ },
942
+ "tags": [],
943
+ "servers": [],
944
+ "components": {
945
+ "securitySchemes": {
946
+ "sdk-embed-token": {
947
+ "scheme": "bearer",
948
+ "bearerFormat": "JWT",
949
+ "type": "http",
950
+ "description": "Embed bearer token for embedded SDK clients"
951
+ },
952
+ "sdk-client-api-key": {
953
+ "type": "apiKey",
954
+ "in": "header",
955
+ "name": "X-API-Key",
956
+ "description": "API key for external SDK clients"
957
+ }
958
+ },
959
+ "schemas": {
960
+ "SdkCompanyDto": {
961
+ "type": "object",
962
+ "properties": {
963
+ "id": {
964
+ "type": "number",
965
+ "description": "Company identifier"
966
+ },
967
+ "name": {
968
+ "type": "string",
969
+ "description": "Company display name"
970
+ },
971
+ "type": {
972
+ "type": "string",
973
+ "description": "Company type",
974
+ "nullable": true
975
+ },
976
+ "website": {
977
+ "type": "string",
978
+ "description": "Company website URL",
979
+ "nullable": true
980
+ },
981
+ "currency": {
982
+ "type": "string",
983
+ "description": "Company reporting currency as ISO 4217 code (e.g. USD, EUR)"
984
+ },
985
+ "logoImageFileUuid": {
986
+ "type": "string",
987
+ "description": "Logo image file UUID",
988
+ "nullable": true
989
+ },
990
+ "legalName": {
627
991
  "type": "string",
628
992
  "description": "Legal company name",
629
993
  "nullable": true
@@ -701,7 +1065,9 @@
701
1065
  "required": [
702
1066
  "id",
703
1067
  "name",
704
- "currency"
1068
+ "type",
1069
+ "currency",
1070
+ "logoImageFileUuid"
705
1071
  ]
706
1072
  },
707
1073
  "SdkCompactCompanyDto": {
@@ -717,7 +1083,8 @@
717
1083
  },
718
1084
  "type": {
719
1085
  "type": "string",
720
- "description": "Company type"
1086
+ "description": "Company type",
1087
+ "nullable": true
721
1088
  },
722
1089
  "website": {
723
1090
  "type": "string",
@@ -737,7 +1104,40 @@
737
1104
  "required": [
738
1105
  "id",
739
1106
  "name",
740
- "currency"
1107
+ "type",
1108
+ "currency",
1109
+ "logoImageFileUuid"
1110
+ ]
1111
+ },
1112
+ "SdkPaginationMetaDto": {
1113
+ "type": "object",
1114
+ "properties": {
1115
+ "nextCursor": {
1116
+ "type": "string",
1117
+ "description": "Cursor for the next page; null when no more pages are available",
1118
+ "nullable": true
1119
+ }
1120
+ },
1121
+ "required": [
1122
+ "nextCursor"
1123
+ ]
1124
+ },
1125
+ "SdkCompaniesListResponseDto": {
1126
+ "type": "object",
1127
+ "properties": {
1128
+ "data": {
1129
+ "type": "array",
1130
+ "items": {
1131
+ "$ref": "#/components/schemas/SdkCompactCompanyDto"
1132
+ }
1133
+ },
1134
+ "meta": {
1135
+ "$ref": "#/components/schemas/SdkPaginationMetaDto"
1136
+ }
1137
+ },
1138
+ "required": [
1139
+ "data",
1140
+ "meta"
741
1141
  ]
742
1142
  },
743
1143
  "SdkCompactCompanyGroupDto": {
@@ -774,6 +1174,24 @@
774
1174
  "isDemo"
775
1175
  ]
776
1176
  },
1177
+ "SdkCompanyGroupsListResponseDto": {
1178
+ "type": "object",
1179
+ "properties": {
1180
+ "data": {
1181
+ "type": "array",
1182
+ "items": {
1183
+ "$ref": "#/components/schemas/SdkCompactCompanyGroupDto"
1184
+ }
1185
+ },
1186
+ "meta": {
1187
+ "$ref": "#/components/schemas/SdkPaginationMetaDto"
1188
+ }
1189
+ },
1190
+ "required": [
1191
+ "data",
1192
+ "meta"
1193
+ ]
1194
+ },
777
1195
  "SdkCompanyGroupBasicInformationDto": {
778
1196
  "type": "object",
779
1197
  "properties": {
@@ -1068,12 +1486,14 @@
1068
1486
  },
1069
1487
  "type": {
1070
1488
  "type": "string",
1071
- "description": "Company type"
1489
+ "description": "Company type",
1490
+ "nullable": true
1072
1491
  }
1073
1492
  },
1074
1493
  "required": [
1075
1494
  "id",
1076
- "name"
1495
+ "name",
1496
+ "type"
1077
1497
  ]
1078
1498
  },
1079
1499
  "SdkCompanyGroupReferenceDto": {
@@ -1321,7 +1741,7 @@
1321
1741
  },
1322
1742
  "customSummaryFairValue": {
1323
1743
  "type": "number",
1324
- "description": "Ownership percentage",
1744
+ "description": "Custom fair value override applied at summary level",
1325
1745
  "nullable": true
1326
1746
  },
1327
1747
  "askFairValue": {
@@ -1379,6 +1799,7 @@
1379
1799
  "roundInfo": {
1380
1800
  "description": "Funding round info",
1381
1801
  "nullable": true,
1802
+ "type": "object",
1382
1803
  "allOf": [
1383
1804
  {
1384
1805
  "$ref": "#/components/schemas/SdkFundingRoundInfoDto"
@@ -1515,6 +1936,24 @@
1515
1936
  "date"
1516
1937
  ]
1517
1938
  },
1939
+ "SdkCompanyPositionsListResponseDto": {
1940
+ "type": "object",
1941
+ "properties": {
1942
+ "data": {
1943
+ "type": "array",
1944
+ "items": {
1945
+ "$ref": "#/components/schemas/SdkCompanyPositionDto"
1946
+ }
1947
+ },
1948
+ "meta": {
1949
+ "$ref": "#/components/schemas/SdkPaginationMetaDto"
1950
+ }
1951
+ },
1952
+ "required": [
1953
+ "data",
1954
+ "meta"
1955
+ ]
1956
+ },
1518
1957
  "SdkPortfolioPositionDto": {
1519
1958
  "type": "object",
1520
1959
  "properties": {
@@ -1674,7 +2113,7 @@
1674
2113
  }
1675
2114
  }
1676
2115
  },
1677
- "SdkTransactionBaseDto": {
2116
+ "SdkEquityTransactionDto": {
1678
2117
  "type": "object",
1679
2118
  "properties": {
1680
2119
  "id": {
@@ -1683,97 +2122,7 @@
1683
2122
  },
1684
2123
  "type": {
1685
2124
  "type": "string",
1686
- "description": "Transaction type — discriminates the variant",
1687
- "enum": [
1688
- "Auction",
1689
- "ConvertibleNote",
1690
- "ConvertToEquity",
1691
- "Dividend",
1692
- "EquityInvestment",
1693
- "EquityReceived",
1694
- "Extend",
1695
- "FutureEquityAgreement",
1696
- "Insolvency",
1697
- "IPO",
1698
- "LimitedAuction",
1699
- "OptionsReceived",
1700
- "OtherExit",
1701
- "OtherInvestment",
1702
- "OtherRealization",
1703
- "Payback",
1704
- "Proprietary",
1705
- "TradeSale",
1706
- "ValuationChange",
1707
- "WriteOff"
1708
- ]
1709
- },
1710
- "date": {
1711
- "type": "string",
1712
- "description": "Transaction date (ISO 8601)"
1713
- },
1714
- "companyId": {
1715
- "type": "number",
1716
- "description": "Company identifier"
1717
- },
1718
- "companyGroupId": {
1719
- "type": "number",
1720
- "description": "Company group identifier",
1721
- "nullable": true
1722
- },
1723
- "company": {
1724
- "description": "Company reference",
1725
- "allOf": [
1726
- {
1727
- "$ref": "#/components/schemas/SdkCompanyReferenceDto"
1728
- }
1729
- ]
1730
- },
1731
- "companyGroup": {
1732
- "description": "Company group reference",
1733
- "allOf": [
1734
- {
1735
- "$ref": "#/components/schemas/SdkCompanyGroupReferenceDto"
1736
- }
1737
- ]
1738
- },
1739
- "currency": {
1740
- "type": "string",
1741
- "description": "Transaction currency as ISO 4217 code",
1742
- "nullable": true
1743
- },
1744
- "additionalInfo": {
1745
- "description": "Free-form annotations",
1746
- "allOf": [
1747
- {
1748
- "$ref": "#/components/schemas/SdkTransactionAdditionalInfoDto"
1749
- }
1750
- ]
1751
- },
1752
- "children": {
1753
- "description": "Child transactions. Each element is a transaction variant; narrow via its `type` field.",
1754
- "type": "array",
1755
- "items": {
1756
- "$ref": "#/components/schemas/SdkTransactionBaseDto"
1757
- }
1758
- }
1759
- },
1760
- "required": [
1761
- "id",
1762
- "type",
1763
- "date",
1764
- "companyId"
1765
- ]
1766
- },
1767
- "SdkEquityTransactionDto": {
1768
- "type": "object",
1769
- "properties": {
1770
- "id": {
1771
- "type": "number",
1772
- "description": "Transaction identifier"
1773
- },
1774
- "type": {
1775
- "type": "string",
1776
- "description": "Equity-family transaction type",
2125
+ "description": "Equity-family transaction type",
1777
2126
  "enum": [
1778
2127
  "EquityInvestment",
1779
2128
  "EquityReceived",
@@ -1823,10 +2172,63 @@
1823
2172
  ]
1824
2173
  },
1825
2174
  "children": {
1826
- "description": "Child transactions. Each element is a transaction variant; narrow via its `type` field.",
1827
2175
  "type": "array",
2176
+ "description": "Child transactions. Each element is a transaction variant; narrow via its `type` field.",
1828
2177
  "items": {
1829
- "$ref": "#/components/schemas/SdkTransactionBaseDto"
2178
+ "oneOf": [
2179
+ {
2180
+ "$ref": "#/components/schemas/SdkEquityTransactionDto"
2181
+ },
2182
+ {
2183
+ "$ref": "#/components/schemas/SdkConvertibleNoteTransactionDto"
2184
+ },
2185
+ {
2186
+ "$ref": "#/components/schemas/SdkFutureEquityAgreementTransactionDto"
2187
+ },
2188
+ {
2189
+ "$ref": "#/components/schemas/SdkExtendTransactionDto"
2190
+ },
2191
+ {
2192
+ "$ref": "#/components/schemas/SdkConversionTransactionDto"
2193
+ },
2194
+ {
2195
+ "$ref": "#/components/schemas/SdkExitTransactionDto"
2196
+ },
2197
+ {
2198
+ "$ref": "#/components/schemas/SdkValuationChangeTransactionDto"
2199
+ },
2200
+ {
2201
+ "$ref": "#/components/schemas/SdkInsolvencyTransactionDto"
2202
+ },
2203
+ {
2204
+ "$ref": "#/components/schemas/SdkOtherInvestmentTransactionDto"
2205
+ }
2206
+ ],
2207
+ "discriminator": {
2208
+ "propertyName": "type",
2209
+ "mapping": {
2210
+ "EquityInvestment": "#/components/schemas/SdkEquityTransactionDto",
2211
+ "EquityReceived": "#/components/schemas/SdkEquityTransactionDto",
2212
+ "OptionsReceived": "#/components/schemas/SdkEquityTransactionDto",
2213
+ "ConvertibleNote": "#/components/schemas/SdkConvertibleNoteTransactionDto",
2214
+ "FutureEquityAgreement": "#/components/schemas/SdkFutureEquityAgreementTransactionDto",
2215
+ "Extend": "#/components/schemas/SdkExtendTransactionDto",
2216
+ "ConvertToEquity": "#/components/schemas/SdkConversionTransactionDto",
2217
+ "Payback": "#/components/schemas/SdkConversionTransactionDto",
2218
+ "WriteOff": "#/components/schemas/SdkConversionTransactionDto",
2219
+ "TradeSale": "#/components/schemas/SdkExitTransactionDto",
2220
+ "IPO": "#/components/schemas/SdkExitTransactionDto",
2221
+ "Auction": "#/components/schemas/SdkExitTransactionDto",
2222
+ "LimitedAuction": "#/components/schemas/SdkExitTransactionDto",
2223
+ "Proprietary": "#/components/schemas/SdkExitTransactionDto",
2224
+ "OtherExit": "#/components/schemas/SdkExitTransactionDto",
2225
+ "Dividend": "#/components/schemas/SdkExitTransactionDto",
2226
+ "OtherRealization": "#/components/schemas/SdkExitTransactionDto",
2227
+ "ValuationChange": "#/components/schemas/SdkValuationChangeTransactionDto",
2228
+ "Insolvency": "#/components/schemas/SdkInsolvencyTransactionDto",
2229
+ "OtherInvestment": "#/components/schemas/SdkOtherInvestmentTransactionDto"
2230
+ }
2231
+ }
1830
2232
  }
1831
2233
  },
1832
2234
  "invested": {
@@ -1941,10 +2343,63 @@
1941
2343
  ]
1942
2344
  },
1943
2345
  "children": {
1944
- "description": "Child transactions. Each element is a transaction variant; narrow via its `type` field.",
1945
2346
  "type": "array",
2347
+ "description": "Child transactions. Each element is a transaction variant; narrow via its `type` field.",
1946
2348
  "items": {
1947
- "$ref": "#/components/schemas/SdkTransactionBaseDto"
2349
+ "oneOf": [
2350
+ {
2351
+ "$ref": "#/components/schemas/SdkEquityTransactionDto"
2352
+ },
2353
+ {
2354
+ "$ref": "#/components/schemas/SdkConvertibleNoteTransactionDto"
2355
+ },
2356
+ {
2357
+ "$ref": "#/components/schemas/SdkFutureEquityAgreementTransactionDto"
2358
+ },
2359
+ {
2360
+ "$ref": "#/components/schemas/SdkExtendTransactionDto"
2361
+ },
2362
+ {
2363
+ "$ref": "#/components/schemas/SdkConversionTransactionDto"
2364
+ },
2365
+ {
2366
+ "$ref": "#/components/schemas/SdkExitTransactionDto"
2367
+ },
2368
+ {
2369
+ "$ref": "#/components/schemas/SdkValuationChangeTransactionDto"
2370
+ },
2371
+ {
2372
+ "$ref": "#/components/schemas/SdkInsolvencyTransactionDto"
2373
+ },
2374
+ {
2375
+ "$ref": "#/components/schemas/SdkOtherInvestmentTransactionDto"
2376
+ }
2377
+ ],
2378
+ "discriminator": {
2379
+ "propertyName": "type",
2380
+ "mapping": {
2381
+ "EquityInvestment": "#/components/schemas/SdkEquityTransactionDto",
2382
+ "EquityReceived": "#/components/schemas/SdkEquityTransactionDto",
2383
+ "OptionsReceived": "#/components/schemas/SdkEquityTransactionDto",
2384
+ "ConvertibleNote": "#/components/schemas/SdkConvertibleNoteTransactionDto",
2385
+ "FutureEquityAgreement": "#/components/schemas/SdkFutureEquityAgreementTransactionDto",
2386
+ "Extend": "#/components/schemas/SdkExtendTransactionDto",
2387
+ "ConvertToEquity": "#/components/schemas/SdkConversionTransactionDto",
2388
+ "Payback": "#/components/schemas/SdkConversionTransactionDto",
2389
+ "WriteOff": "#/components/schemas/SdkConversionTransactionDto",
2390
+ "TradeSale": "#/components/schemas/SdkExitTransactionDto",
2391
+ "IPO": "#/components/schemas/SdkExitTransactionDto",
2392
+ "Auction": "#/components/schemas/SdkExitTransactionDto",
2393
+ "LimitedAuction": "#/components/schemas/SdkExitTransactionDto",
2394
+ "Proprietary": "#/components/schemas/SdkExitTransactionDto",
2395
+ "OtherExit": "#/components/schemas/SdkExitTransactionDto",
2396
+ "Dividend": "#/components/schemas/SdkExitTransactionDto",
2397
+ "OtherRealization": "#/components/schemas/SdkExitTransactionDto",
2398
+ "ValuationChange": "#/components/schemas/SdkValuationChangeTransactionDto",
2399
+ "Insolvency": "#/components/schemas/SdkInsolvencyTransactionDto",
2400
+ "OtherInvestment": "#/components/schemas/SdkOtherInvestmentTransactionDto"
2401
+ }
2402
+ }
1948
2403
  }
1949
2404
  },
1950
2405
  "invested": {
@@ -2064,10 +2519,63 @@
2064
2519
  ]
2065
2520
  },
2066
2521
  "children": {
2067
- "description": "Child transactions. Each element is a transaction variant; narrow via its `type` field.",
2068
2522
  "type": "array",
2523
+ "description": "Child transactions. Each element is a transaction variant; narrow via its `type` field.",
2069
2524
  "items": {
2070
- "$ref": "#/components/schemas/SdkTransactionBaseDto"
2525
+ "oneOf": [
2526
+ {
2527
+ "$ref": "#/components/schemas/SdkEquityTransactionDto"
2528
+ },
2529
+ {
2530
+ "$ref": "#/components/schemas/SdkConvertibleNoteTransactionDto"
2531
+ },
2532
+ {
2533
+ "$ref": "#/components/schemas/SdkFutureEquityAgreementTransactionDto"
2534
+ },
2535
+ {
2536
+ "$ref": "#/components/schemas/SdkExtendTransactionDto"
2537
+ },
2538
+ {
2539
+ "$ref": "#/components/schemas/SdkConversionTransactionDto"
2540
+ },
2541
+ {
2542
+ "$ref": "#/components/schemas/SdkExitTransactionDto"
2543
+ },
2544
+ {
2545
+ "$ref": "#/components/schemas/SdkValuationChangeTransactionDto"
2546
+ },
2547
+ {
2548
+ "$ref": "#/components/schemas/SdkInsolvencyTransactionDto"
2549
+ },
2550
+ {
2551
+ "$ref": "#/components/schemas/SdkOtherInvestmentTransactionDto"
2552
+ }
2553
+ ],
2554
+ "discriminator": {
2555
+ "propertyName": "type",
2556
+ "mapping": {
2557
+ "EquityInvestment": "#/components/schemas/SdkEquityTransactionDto",
2558
+ "EquityReceived": "#/components/schemas/SdkEquityTransactionDto",
2559
+ "OptionsReceived": "#/components/schemas/SdkEquityTransactionDto",
2560
+ "ConvertibleNote": "#/components/schemas/SdkConvertibleNoteTransactionDto",
2561
+ "FutureEquityAgreement": "#/components/schemas/SdkFutureEquityAgreementTransactionDto",
2562
+ "Extend": "#/components/schemas/SdkExtendTransactionDto",
2563
+ "ConvertToEquity": "#/components/schemas/SdkConversionTransactionDto",
2564
+ "Payback": "#/components/schemas/SdkConversionTransactionDto",
2565
+ "WriteOff": "#/components/schemas/SdkConversionTransactionDto",
2566
+ "TradeSale": "#/components/schemas/SdkExitTransactionDto",
2567
+ "IPO": "#/components/schemas/SdkExitTransactionDto",
2568
+ "Auction": "#/components/schemas/SdkExitTransactionDto",
2569
+ "LimitedAuction": "#/components/schemas/SdkExitTransactionDto",
2570
+ "Proprietary": "#/components/schemas/SdkExitTransactionDto",
2571
+ "OtherExit": "#/components/schemas/SdkExitTransactionDto",
2572
+ "Dividend": "#/components/schemas/SdkExitTransactionDto",
2573
+ "OtherRealization": "#/components/schemas/SdkExitTransactionDto",
2574
+ "ValuationChange": "#/components/schemas/SdkValuationChangeTransactionDto",
2575
+ "Insolvency": "#/components/schemas/SdkInsolvencyTransactionDto",
2576
+ "OtherInvestment": "#/components/schemas/SdkOtherInvestmentTransactionDto"
2577
+ }
2578
+ }
2071
2579
  }
2072
2580
  },
2073
2581
  "invested": {
@@ -2165,10 +2673,63 @@
2165
2673
  ]
2166
2674
  },
2167
2675
  "children": {
2168
- "description": "Child transactions. Each element is a transaction variant; narrow via its `type` field.",
2169
2676
  "type": "array",
2677
+ "description": "Child transactions. Each element is a transaction variant; narrow via its `type` field.",
2170
2678
  "items": {
2171
- "$ref": "#/components/schemas/SdkTransactionBaseDto"
2679
+ "oneOf": [
2680
+ {
2681
+ "$ref": "#/components/schemas/SdkEquityTransactionDto"
2682
+ },
2683
+ {
2684
+ "$ref": "#/components/schemas/SdkConvertibleNoteTransactionDto"
2685
+ },
2686
+ {
2687
+ "$ref": "#/components/schemas/SdkFutureEquityAgreementTransactionDto"
2688
+ },
2689
+ {
2690
+ "$ref": "#/components/schemas/SdkExtendTransactionDto"
2691
+ },
2692
+ {
2693
+ "$ref": "#/components/schemas/SdkConversionTransactionDto"
2694
+ },
2695
+ {
2696
+ "$ref": "#/components/schemas/SdkExitTransactionDto"
2697
+ },
2698
+ {
2699
+ "$ref": "#/components/schemas/SdkValuationChangeTransactionDto"
2700
+ },
2701
+ {
2702
+ "$ref": "#/components/schemas/SdkInsolvencyTransactionDto"
2703
+ },
2704
+ {
2705
+ "$ref": "#/components/schemas/SdkOtherInvestmentTransactionDto"
2706
+ }
2707
+ ],
2708
+ "discriminator": {
2709
+ "propertyName": "type",
2710
+ "mapping": {
2711
+ "EquityInvestment": "#/components/schemas/SdkEquityTransactionDto",
2712
+ "EquityReceived": "#/components/schemas/SdkEquityTransactionDto",
2713
+ "OptionsReceived": "#/components/schemas/SdkEquityTransactionDto",
2714
+ "ConvertibleNote": "#/components/schemas/SdkConvertibleNoteTransactionDto",
2715
+ "FutureEquityAgreement": "#/components/schemas/SdkFutureEquityAgreementTransactionDto",
2716
+ "Extend": "#/components/schemas/SdkExtendTransactionDto",
2717
+ "ConvertToEquity": "#/components/schemas/SdkConversionTransactionDto",
2718
+ "Payback": "#/components/schemas/SdkConversionTransactionDto",
2719
+ "WriteOff": "#/components/schemas/SdkConversionTransactionDto",
2720
+ "TradeSale": "#/components/schemas/SdkExitTransactionDto",
2721
+ "IPO": "#/components/schemas/SdkExitTransactionDto",
2722
+ "Auction": "#/components/schemas/SdkExitTransactionDto",
2723
+ "LimitedAuction": "#/components/schemas/SdkExitTransactionDto",
2724
+ "Proprietary": "#/components/schemas/SdkExitTransactionDto",
2725
+ "OtherExit": "#/components/schemas/SdkExitTransactionDto",
2726
+ "Dividend": "#/components/schemas/SdkExitTransactionDto",
2727
+ "OtherRealization": "#/components/schemas/SdkExitTransactionDto",
2728
+ "ValuationChange": "#/components/schemas/SdkValuationChangeTransactionDto",
2729
+ "Insolvency": "#/components/schemas/SdkInsolvencyTransactionDto",
2730
+ "OtherInvestment": "#/components/schemas/SdkOtherInvestmentTransactionDto"
2731
+ }
2732
+ }
2172
2733
  }
2173
2734
  },
2174
2735
  "parentId": {
@@ -2253,10 +2814,63 @@
2253
2814
  ]
2254
2815
  },
2255
2816
  "children": {
2256
- "description": "Child transactions. Each element is a transaction variant; narrow via its `type` field.",
2257
2817
  "type": "array",
2818
+ "description": "Child transactions. Each element is a transaction variant; narrow via its `type` field.",
2258
2819
  "items": {
2259
- "$ref": "#/components/schemas/SdkTransactionBaseDto"
2820
+ "oneOf": [
2821
+ {
2822
+ "$ref": "#/components/schemas/SdkEquityTransactionDto"
2823
+ },
2824
+ {
2825
+ "$ref": "#/components/schemas/SdkConvertibleNoteTransactionDto"
2826
+ },
2827
+ {
2828
+ "$ref": "#/components/schemas/SdkFutureEquityAgreementTransactionDto"
2829
+ },
2830
+ {
2831
+ "$ref": "#/components/schemas/SdkExtendTransactionDto"
2832
+ },
2833
+ {
2834
+ "$ref": "#/components/schemas/SdkConversionTransactionDto"
2835
+ },
2836
+ {
2837
+ "$ref": "#/components/schemas/SdkExitTransactionDto"
2838
+ },
2839
+ {
2840
+ "$ref": "#/components/schemas/SdkValuationChangeTransactionDto"
2841
+ },
2842
+ {
2843
+ "$ref": "#/components/schemas/SdkInsolvencyTransactionDto"
2844
+ },
2845
+ {
2846
+ "$ref": "#/components/schemas/SdkOtherInvestmentTransactionDto"
2847
+ }
2848
+ ],
2849
+ "discriminator": {
2850
+ "propertyName": "type",
2851
+ "mapping": {
2852
+ "EquityInvestment": "#/components/schemas/SdkEquityTransactionDto",
2853
+ "EquityReceived": "#/components/schemas/SdkEquityTransactionDto",
2854
+ "OptionsReceived": "#/components/schemas/SdkEquityTransactionDto",
2855
+ "ConvertibleNote": "#/components/schemas/SdkConvertibleNoteTransactionDto",
2856
+ "FutureEquityAgreement": "#/components/schemas/SdkFutureEquityAgreementTransactionDto",
2857
+ "Extend": "#/components/schemas/SdkExtendTransactionDto",
2858
+ "ConvertToEquity": "#/components/schemas/SdkConversionTransactionDto",
2859
+ "Payback": "#/components/schemas/SdkConversionTransactionDto",
2860
+ "WriteOff": "#/components/schemas/SdkConversionTransactionDto",
2861
+ "TradeSale": "#/components/schemas/SdkExitTransactionDto",
2862
+ "IPO": "#/components/schemas/SdkExitTransactionDto",
2863
+ "Auction": "#/components/schemas/SdkExitTransactionDto",
2864
+ "LimitedAuction": "#/components/schemas/SdkExitTransactionDto",
2865
+ "Proprietary": "#/components/schemas/SdkExitTransactionDto",
2866
+ "OtherExit": "#/components/schemas/SdkExitTransactionDto",
2867
+ "Dividend": "#/components/schemas/SdkExitTransactionDto",
2868
+ "OtherRealization": "#/components/schemas/SdkExitTransactionDto",
2869
+ "ValuationChange": "#/components/schemas/SdkValuationChangeTransactionDto",
2870
+ "Insolvency": "#/components/schemas/SdkInsolvencyTransactionDto",
2871
+ "OtherInvestment": "#/components/schemas/SdkOtherInvestmentTransactionDto"
2872
+ }
2873
+ }
2260
2874
  }
2261
2875
  },
2262
2876
  "parentId": {
@@ -2390,10 +3004,63 @@
2390
3004
  ]
2391
3005
  },
2392
3006
  "children": {
2393
- "description": "Child transactions. Each element is a transaction variant; narrow via its `type` field.",
2394
3007
  "type": "array",
3008
+ "description": "Child transactions. Each element is a transaction variant; narrow via its `type` field.",
2395
3009
  "items": {
2396
- "$ref": "#/components/schemas/SdkTransactionBaseDto"
3010
+ "oneOf": [
3011
+ {
3012
+ "$ref": "#/components/schemas/SdkEquityTransactionDto"
3013
+ },
3014
+ {
3015
+ "$ref": "#/components/schemas/SdkConvertibleNoteTransactionDto"
3016
+ },
3017
+ {
3018
+ "$ref": "#/components/schemas/SdkFutureEquityAgreementTransactionDto"
3019
+ },
3020
+ {
3021
+ "$ref": "#/components/schemas/SdkExtendTransactionDto"
3022
+ },
3023
+ {
3024
+ "$ref": "#/components/schemas/SdkConversionTransactionDto"
3025
+ },
3026
+ {
3027
+ "$ref": "#/components/schemas/SdkExitTransactionDto"
3028
+ },
3029
+ {
3030
+ "$ref": "#/components/schemas/SdkValuationChangeTransactionDto"
3031
+ },
3032
+ {
3033
+ "$ref": "#/components/schemas/SdkInsolvencyTransactionDto"
3034
+ },
3035
+ {
3036
+ "$ref": "#/components/schemas/SdkOtherInvestmentTransactionDto"
3037
+ }
3038
+ ],
3039
+ "discriminator": {
3040
+ "propertyName": "type",
3041
+ "mapping": {
3042
+ "EquityInvestment": "#/components/schemas/SdkEquityTransactionDto",
3043
+ "EquityReceived": "#/components/schemas/SdkEquityTransactionDto",
3044
+ "OptionsReceived": "#/components/schemas/SdkEquityTransactionDto",
3045
+ "ConvertibleNote": "#/components/schemas/SdkConvertibleNoteTransactionDto",
3046
+ "FutureEquityAgreement": "#/components/schemas/SdkFutureEquityAgreementTransactionDto",
3047
+ "Extend": "#/components/schemas/SdkExtendTransactionDto",
3048
+ "ConvertToEquity": "#/components/schemas/SdkConversionTransactionDto",
3049
+ "Payback": "#/components/schemas/SdkConversionTransactionDto",
3050
+ "WriteOff": "#/components/schemas/SdkConversionTransactionDto",
3051
+ "TradeSale": "#/components/schemas/SdkExitTransactionDto",
3052
+ "IPO": "#/components/schemas/SdkExitTransactionDto",
3053
+ "Auction": "#/components/schemas/SdkExitTransactionDto",
3054
+ "LimitedAuction": "#/components/schemas/SdkExitTransactionDto",
3055
+ "Proprietary": "#/components/schemas/SdkExitTransactionDto",
3056
+ "OtherExit": "#/components/schemas/SdkExitTransactionDto",
3057
+ "Dividend": "#/components/schemas/SdkExitTransactionDto",
3058
+ "OtherRealization": "#/components/schemas/SdkExitTransactionDto",
3059
+ "ValuationChange": "#/components/schemas/SdkValuationChangeTransactionDto",
3060
+ "Insolvency": "#/components/schemas/SdkInsolvencyTransactionDto",
3061
+ "OtherInvestment": "#/components/schemas/SdkOtherInvestmentTransactionDto"
3062
+ }
3063
+ }
2397
3064
  }
2398
3065
  },
2399
3066
  "profit": {
@@ -2498,10 +3165,63 @@
2498
3165
  ]
2499
3166
  },
2500
3167
  "children": {
2501
- "description": "Child transactions. Each element is a transaction variant; narrow via its `type` field.",
2502
3168
  "type": "array",
3169
+ "description": "Child transactions. Each element is a transaction variant; narrow via its `type` field.",
2503
3170
  "items": {
2504
- "$ref": "#/components/schemas/SdkTransactionBaseDto"
3171
+ "oneOf": [
3172
+ {
3173
+ "$ref": "#/components/schemas/SdkEquityTransactionDto"
3174
+ },
3175
+ {
3176
+ "$ref": "#/components/schemas/SdkConvertibleNoteTransactionDto"
3177
+ },
3178
+ {
3179
+ "$ref": "#/components/schemas/SdkFutureEquityAgreementTransactionDto"
3180
+ },
3181
+ {
3182
+ "$ref": "#/components/schemas/SdkExtendTransactionDto"
3183
+ },
3184
+ {
3185
+ "$ref": "#/components/schemas/SdkConversionTransactionDto"
3186
+ },
3187
+ {
3188
+ "$ref": "#/components/schemas/SdkExitTransactionDto"
3189
+ },
3190
+ {
3191
+ "$ref": "#/components/schemas/SdkValuationChangeTransactionDto"
3192
+ },
3193
+ {
3194
+ "$ref": "#/components/schemas/SdkInsolvencyTransactionDto"
3195
+ },
3196
+ {
3197
+ "$ref": "#/components/schemas/SdkOtherInvestmentTransactionDto"
3198
+ }
3199
+ ],
3200
+ "discriminator": {
3201
+ "propertyName": "type",
3202
+ "mapping": {
3203
+ "EquityInvestment": "#/components/schemas/SdkEquityTransactionDto",
3204
+ "EquityReceived": "#/components/schemas/SdkEquityTransactionDto",
3205
+ "OptionsReceived": "#/components/schemas/SdkEquityTransactionDto",
3206
+ "ConvertibleNote": "#/components/schemas/SdkConvertibleNoteTransactionDto",
3207
+ "FutureEquityAgreement": "#/components/schemas/SdkFutureEquityAgreementTransactionDto",
3208
+ "Extend": "#/components/schemas/SdkExtendTransactionDto",
3209
+ "ConvertToEquity": "#/components/schemas/SdkConversionTransactionDto",
3210
+ "Payback": "#/components/schemas/SdkConversionTransactionDto",
3211
+ "WriteOff": "#/components/schemas/SdkConversionTransactionDto",
3212
+ "TradeSale": "#/components/schemas/SdkExitTransactionDto",
3213
+ "IPO": "#/components/schemas/SdkExitTransactionDto",
3214
+ "Auction": "#/components/schemas/SdkExitTransactionDto",
3215
+ "LimitedAuction": "#/components/schemas/SdkExitTransactionDto",
3216
+ "Proprietary": "#/components/schemas/SdkExitTransactionDto",
3217
+ "OtherExit": "#/components/schemas/SdkExitTransactionDto",
3218
+ "Dividend": "#/components/schemas/SdkExitTransactionDto",
3219
+ "OtherRealization": "#/components/schemas/SdkExitTransactionDto",
3220
+ "ValuationChange": "#/components/schemas/SdkValuationChangeTransactionDto",
3221
+ "Insolvency": "#/components/schemas/SdkInsolvencyTransactionDto",
3222
+ "OtherInvestment": "#/components/schemas/SdkOtherInvestmentTransactionDto"
3223
+ }
3224
+ }
2505
3225
  }
2506
3226
  },
2507
3227
  "companyPostMoneyValuation": {
@@ -2612,10 +3332,63 @@
2612
3332
  ]
2613
3333
  },
2614
3334
  "children": {
2615
- "description": "Child transactions. Each element is a transaction variant; narrow via its `type` field.",
2616
3335
  "type": "array",
3336
+ "description": "Child transactions. Each element is a transaction variant; narrow via its `type` field.",
2617
3337
  "items": {
2618
- "$ref": "#/components/schemas/SdkTransactionBaseDto"
3338
+ "oneOf": [
3339
+ {
3340
+ "$ref": "#/components/schemas/SdkEquityTransactionDto"
3341
+ },
3342
+ {
3343
+ "$ref": "#/components/schemas/SdkConvertibleNoteTransactionDto"
3344
+ },
3345
+ {
3346
+ "$ref": "#/components/schemas/SdkFutureEquityAgreementTransactionDto"
3347
+ },
3348
+ {
3349
+ "$ref": "#/components/schemas/SdkExtendTransactionDto"
3350
+ },
3351
+ {
3352
+ "$ref": "#/components/schemas/SdkConversionTransactionDto"
3353
+ },
3354
+ {
3355
+ "$ref": "#/components/schemas/SdkExitTransactionDto"
3356
+ },
3357
+ {
3358
+ "$ref": "#/components/schemas/SdkValuationChangeTransactionDto"
3359
+ },
3360
+ {
3361
+ "$ref": "#/components/schemas/SdkInsolvencyTransactionDto"
3362
+ },
3363
+ {
3364
+ "$ref": "#/components/schemas/SdkOtherInvestmentTransactionDto"
3365
+ }
3366
+ ],
3367
+ "discriminator": {
3368
+ "propertyName": "type",
3369
+ "mapping": {
3370
+ "EquityInvestment": "#/components/schemas/SdkEquityTransactionDto",
3371
+ "EquityReceived": "#/components/schemas/SdkEquityTransactionDto",
3372
+ "OptionsReceived": "#/components/schemas/SdkEquityTransactionDto",
3373
+ "ConvertibleNote": "#/components/schemas/SdkConvertibleNoteTransactionDto",
3374
+ "FutureEquityAgreement": "#/components/schemas/SdkFutureEquityAgreementTransactionDto",
3375
+ "Extend": "#/components/schemas/SdkExtendTransactionDto",
3376
+ "ConvertToEquity": "#/components/schemas/SdkConversionTransactionDto",
3377
+ "Payback": "#/components/schemas/SdkConversionTransactionDto",
3378
+ "WriteOff": "#/components/schemas/SdkConversionTransactionDto",
3379
+ "TradeSale": "#/components/schemas/SdkExitTransactionDto",
3380
+ "IPO": "#/components/schemas/SdkExitTransactionDto",
3381
+ "Auction": "#/components/schemas/SdkExitTransactionDto",
3382
+ "LimitedAuction": "#/components/schemas/SdkExitTransactionDto",
3383
+ "Proprietary": "#/components/schemas/SdkExitTransactionDto",
3384
+ "OtherExit": "#/components/schemas/SdkExitTransactionDto",
3385
+ "Dividend": "#/components/schemas/SdkExitTransactionDto",
3386
+ "OtherRealization": "#/components/schemas/SdkExitTransactionDto",
3387
+ "ValuationChange": "#/components/schemas/SdkValuationChangeTransactionDto",
3388
+ "Insolvency": "#/components/schemas/SdkInsolvencyTransactionDto",
3389
+ "OtherInvestment": "#/components/schemas/SdkOtherInvestmentTransactionDto"
3390
+ }
3391
+ }
2619
3392
  }
2620
3393
  },
2621
3394
  "customSummaryFairValue": {
@@ -2688,10 +3461,63 @@
2688
3461
  ]
2689
3462
  },
2690
3463
  "children": {
2691
- "description": "Child transactions. Each element is a transaction variant; narrow via its `type` field.",
2692
3464
  "type": "array",
3465
+ "description": "Child transactions. Each element is a transaction variant; narrow via its `type` field.",
2693
3466
  "items": {
2694
- "$ref": "#/components/schemas/SdkTransactionBaseDto"
3467
+ "oneOf": [
3468
+ {
3469
+ "$ref": "#/components/schemas/SdkEquityTransactionDto"
3470
+ },
3471
+ {
3472
+ "$ref": "#/components/schemas/SdkConvertibleNoteTransactionDto"
3473
+ },
3474
+ {
3475
+ "$ref": "#/components/schemas/SdkFutureEquityAgreementTransactionDto"
3476
+ },
3477
+ {
3478
+ "$ref": "#/components/schemas/SdkExtendTransactionDto"
3479
+ },
3480
+ {
3481
+ "$ref": "#/components/schemas/SdkConversionTransactionDto"
3482
+ },
3483
+ {
3484
+ "$ref": "#/components/schemas/SdkExitTransactionDto"
3485
+ },
3486
+ {
3487
+ "$ref": "#/components/schemas/SdkValuationChangeTransactionDto"
3488
+ },
3489
+ {
3490
+ "$ref": "#/components/schemas/SdkInsolvencyTransactionDto"
3491
+ },
3492
+ {
3493
+ "$ref": "#/components/schemas/SdkOtherInvestmentTransactionDto"
3494
+ }
3495
+ ],
3496
+ "discriminator": {
3497
+ "propertyName": "type",
3498
+ "mapping": {
3499
+ "EquityInvestment": "#/components/schemas/SdkEquityTransactionDto",
3500
+ "EquityReceived": "#/components/schemas/SdkEquityTransactionDto",
3501
+ "OptionsReceived": "#/components/schemas/SdkEquityTransactionDto",
3502
+ "ConvertibleNote": "#/components/schemas/SdkConvertibleNoteTransactionDto",
3503
+ "FutureEquityAgreement": "#/components/schemas/SdkFutureEquityAgreementTransactionDto",
3504
+ "Extend": "#/components/schemas/SdkExtendTransactionDto",
3505
+ "ConvertToEquity": "#/components/schemas/SdkConversionTransactionDto",
3506
+ "Payback": "#/components/schemas/SdkConversionTransactionDto",
3507
+ "WriteOff": "#/components/schemas/SdkConversionTransactionDto",
3508
+ "TradeSale": "#/components/schemas/SdkExitTransactionDto",
3509
+ "IPO": "#/components/schemas/SdkExitTransactionDto",
3510
+ "Auction": "#/components/schemas/SdkExitTransactionDto",
3511
+ "LimitedAuction": "#/components/schemas/SdkExitTransactionDto",
3512
+ "Proprietary": "#/components/schemas/SdkExitTransactionDto",
3513
+ "OtherExit": "#/components/schemas/SdkExitTransactionDto",
3514
+ "Dividend": "#/components/schemas/SdkExitTransactionDto",
3515
+ "OtherRealization": "#/components/schemas/SdkExitTransactionDto",
3516
+ "ValuationChange": "#/components/schemas/SdkValuationChangeTransactionDto",
3517
+ "Insolvency": "#/components/schemas/SdkInsolvencyTransactionDto",
3518
+ "OtherInvestment": "#/components/schemas/SdkOtherInvestmentTransactionDto"
3519
+ }
3520
+ }
2695
3521
  }
2696
3522
  },
2697
3523
  "invested": {
@@ -2711,6 +3537,533 @@
2711
3537
  "companyId",
2712
3538
  "invested"
2713
3539
  ]
3540
+ },
3541
+ "SdkTransactionsListResponseDto": {
3542
+ "type": "object",
3543
+ "properties": {
3544
+ "data": {
3545
+ "type": "array",
3546
+ "items": {
3547
+ "oneOf": [
3548
+ {
3549
+ "$ref": "#/components/schemas/SdkEquityTransactionDto"
3550
+ },
3551
+ {
3552
+ "$ref": "#/components/schemas/SdkConvertibleNoteTransactionDto"
3553
+ },
3554
+ {
3555
+ "$ref": "#/components/schemas/SdkFutureEquityAgreementTransactionDto"
3556
+ },
3557
+ {
3558
+ "$ref": "#/components/schemas/SdkExtendTransactionDto"
3559
+ },
3560
+ {
3561
+ "$ref": "#/components/schemas/SdkConversionTransactionDto"
3562
+ },
3563
+ {
3564
+ "$ref": "#/components/schemas/SdkExitTransactionDto"
3565
+ },
3566
+ {
3567
+ "$ref": "#/components/schemas/SdkValuationChangeTransactionDto"
3568
+ },
3569
+ {
3570
+ "$ref": "#/components/schemas/SdkInsolvencyTransactionDto"
3571
+ },
3572
+ {
3573
+ "$ref": "#/components/schemas/SdkOtherInvestmentTransactionDto"
3574
+ }
3575
+ ],
3576
+ "discriminator": {
3577
+ "propertyName": "type",
3578
+ "mapping": {
3579
+ "EquityInvestment": "#/components/schemas/SdkEquityTransactionDto",
3580
+ "EquityReceived": "#/components/schemas/SdkEquityTransactionDto",
3581
+ "OptionsReceived": "#/components/schemas/SdkEquityTransactionDto",
3582
+ "ConvertibleNote": "#/components/schemas/SdkConvertibleNoteTransactionDto",
3583
+ "FutureEquityAgreement": "#/components/schemas/SdkFutureEquityAgreementTransactionDto",
3584
+ "Extend": "#/components/schemas/SdkExtendTransactionDto",
3585
+ "ConvertToEquity": "#/components/schemas/SdkConversionTransactionDto",
3586
+ "Payback": "#/components/schemas/SdkConversionTransactionDto",
3587
+ "WriteOff": "#/components/schemas/SdkConversionTransactionDto",
3588
+ "TradeSale": "#/components/schemas/SdkExitTransactionDto",
3589
+ "IPO": "#/components/schemas/SdkExitTransactionDto",
3590
+ "Auction": "#/components/schemas/SdkExitTransactionDto",
3591
+ "LimitedAuction": "#/components/schemas/SdkExitTransactionDto",
3592
+ "Proprietary": "#/components/schemas/SdkExitTransactionDto",
3593
+ "OtherExit": "#/components/schemas/SdkExitTransactionDto",
3594
+ "Dividend": "#/components/schemas/SdkExitTransactionDto",
3595
+ "OtherRealization": "#/components/schemas/SdkExitTransactionDto",
3596
+ "ValuationChange": "#/components/schemas/SdkValuationChangeTransactionDto",
3597
+ "Insolvency": "#/components/schemas/SdkInsolvencyTransactionDto",
3598
+ "OtherInvestment": "#/components/schemas/SdkOtherInvestmentTransactionDto"
3599
+ }
3600
+ }
3601
+ }
3602
+ },
3603
+ "meta": {
3604
+ "$ref": "#/components/schemas/SdkPaginationMetaDto"
3605
+ }
3606
+ },
3607
+ "required": [
3608
+ "data",
3609
+ "meta"
3610
+ ]
3611
+ },
3612
+ "SdkMetricUnitDto": {
3613
+ "type": "object",
3614
+ "properties": {
3615
+ "unit": {
3616
+ "type": "object",
3617
+ "description": "Unit category. Examples: \"Currency\", \"Percentage\", \"Number\", \"Day\", \"Month\", \"Quarter\", \"Year\"."
3618
+ },
3619
+ "currencyCode": {
3620
+ "type": "string",
3621
+ "description": "Currency code (ISO 4217), present only when the unit is \"Currency\".",
3622
+ "nullable": true
3623
+ }
3624
+ },
3625
+ "required": [
3626
+ "unit"
3627
+ ]
3628
+ },
3629
+ "SdkMetricTypeDto": {
3630
+ "type": "object",
3631
+ "properties": {
3632
+ "id": {
3633
+ "type": "number",
3634
+ "description": "Metric type identifier."
3635
+ },
3636
+ "name": {
3637
+ "type": "string",
3638
+ "description": "Metric type display name."
3639
+ },
3640
+ "shortName": {
3641
+ "type": "string",
3642
+ "description": "Short display name / abbreviation.",
3643
+ "nullable": true
3644
+ },
3645
+ "description": {
3646
+ "type": "string",
3647
+ "description": "Free-form description of what the metric represents.",
3648
+ "nullable": true
3649
+ },
3650
+ "origin": {
3651
+ "type": "object",
3652
+ "description": "Origin: predefined by Rundit or user-defined within the VC group."
3653
+ },
3654
+ "aggMethod": {
3655
+ "type": "object",
3656
+ "description": "How values aggregate across periods when rolled up (e.g. SUM, AVG, LAST_AVAILABLE, NONE)."
3657
+ },
3658
+ "valueType": {
3659
+ "type": "object",
3660
+ "description": "Value shape — \"numeric\" for measurements, \"option\" for enumerated choices."
3661
+ },
3662
+ "unit": {
3663
+ "description": "Unit of measurement.",
3664
+ "nullable": true,
3665
+ "type": "object",
3666
+ "allOf": [
3667
+ {
3668
+ "$ref": "#/components/schemas/SdkMetricUnitDto"
3669
+ }
3670
+ ]
3671
+ }
3672
+ },
3673
+ "required": [
3674
+ "id",
3675
+ "name",
3676
+ "aggMethod"
3677
+ ]
3678
+ },
3679
+ "SdkMetricTypesListResponseDto": {
3680
+ "type": "object",
3681
+ "properties": {
3682
+ "data": {
3683
+ "type": "array",
3684
+ "items": {
3685
+ "$ref": "#/components/schemas/SdkMetricTypeDto"
3686
+ }
3687
+ },
3688
+ "meta": {
3689
+ "$ref": "#/components/schemas/SdkPaginationMetaDto"
3690
+ }
3691
+ },
3692
+ "required": [
3693
+ "data",
3694
+ "meta"
3695
+ ]
3696
+ },
3697
+ "MetricSearchDto": {
3698
+ "type": "object",
3699
+ "properties": {
3700
+ "limit": {
3701
+ "type": "number",
3702
+ "description": "Maximum items per page. Currently accepted but not enforced; reserved for future pagination."
3703
+ },
3704
+ "cursor": {
3705
+ "type": "string",
3706
+ "description": "Opaque cursor from a previous response's meta.nextCursor. Currently accepted but ignored."
3707
+ },
3708
+ "companyIds": {
3709
+ "description": "Restrict results to these companies. Defaults to all companies the caller can access.",
3710
+ "type": "array",
3711
+ "items": {
3712
+ "type": "number"
3713
+ }
3714
+ },
3715
+ "companyGroupIds": {
3716
+ "description": "Restrict to companies that belong to any of these company groups.",
3717
+ "type": "array",
3718
+ "items": {
3719
+ "type": "number"
3720
+ }
3721
+ },
3722
+ "metricTypeIds": {
3723
+ "description": "Restrict to specific metric types (use GET /metrics/types to discover identifiers).",
3724
+ "type": "array",
3725
+ "items": {
3726
+ "type": "number"
3727
+ }
3728
+ },
3729
+ "timeframe": {
3730
+ "type": "string",
3731
+ "description": "Restrict to a reporting period granularity.",
3732
+ "enum": [
3733
+ "Month",
3734
+ "Quarter",
3735
+ "Year"
3736
+ ]
3737
+ },
3738
+ "from": {
3739
+ "type": "string",
3740
+ "description": "Lower bound for point date (ISO 8601, inclusive)."
3741
+ },
3742
+ "to": {
3743
+ "type": "string",
3744
+ "description": "Upper bound for point date (ISO 8601, inclusive)."
3745
+ }
3746
+ }
3747
+ },
3748
+ "SdkMetricPointDto": {
3749
+ "type": "object",
3750
+ "properties": {
3751
+ "date": {
3752
+ "type": "string",
3753
+ "description": "Period end date (ISO 8601, YYYY-MM-DD)."
3754
+ },
3755
+ "timeframe": {
3756
+ "type": "object",
3757
+ "description": "Reporting period granularity."
3758
+ },
3759
+ "value": {
3760
+ "type": "number",
3761
+ "description": "Reported value for the period. Null when the value could not be computed.",
3762
+ "nullable": true
3763
+ },
3764
+ "valueError": {
3765
+ "type": "string",
3766
+ "description": "Computation error message, if the value could not be calculated.",
3767
+ "nullable": true
3768
+ },
3769
+ "aggregated": {
3770
+ "type": "boolean",
3771
+ "description": "True when the point is derived (e.g. aggregated from sub-rows) rather than directly stored."
3772
+ }
3773
+ },
3774
+ "required": [
3775
+ "date",
3776
+ "timeframe",
3777
+ "value"
3778
+ ]
3779
+ },
3780
+ "SdkCompanyMetricDto": {
3781
+ "type": "object",
3782
+ "properties": {
3783
+ "id": {
3784
+ "type": "number",
3785
+ "description": "Metric instance identifier (unique per company)."
3786
+ },
3787
+ "metricType": {
3788
+ "description": "Metric type definition.",
3789
+ "allOf": [
3790
+ {
3791
+ "$ref": "#/components/schemas/SdkMetricTypeDto"
3792
+ }
3793
+ ]
3794
+ },
3795
+ "points": {
3796
+ "description": "Reported data points for this metric.",
3797
+ "type": "array",
3798
+ "items": {
3799
+ "$ref": "#/components/schemas/SdkMetricPointDto"
3800
+ }
3801
+ }
3802
+ },
3803
+ "required": [
3804
+ "id",
3805
+ "metricType",
3806
+ "points"
3807
+ ]
3808
+ },
3809
+ "SdkCompanyMetricsDto": {
3810
+ "type": "object",
3811
+ "properties": {
3812
+ "companyId": {
3813
+ "type": "number",
3814
+ "description": "Company identifier."
3815
+ },
3816
+ "company": {
3817
+ "description": "Company reference with id and human-readable name.",
3818
+ "allOf": [
3819
+ {
3820
+ "$ref": "#/components/schemas/SdkCompanyReferenceDto"
3821
+ }
3822
+ ]
3823
+ },
3824
+ "metrics": {
3825
+ "description": "Metrics reported for this company.",
3826
+ "type": "array",
3827
+ "items": {
3828
+ "$ref": "#/components/schemas/SdkCompanyMetricDto"
3829
+ }
3830
+ }
3831
+ },
3832
+ "required": [
3833
+ "companyId",
3834
+ "company",
3835
+ "metrics"
3836
+ ]
3837
+ },
3838
+ "SdkCompanyMetricsListResponseDto": {
3839
+ "type": "object",
3840
+ "properties": {
3841
+ "data": {
3842
+ "type": "array",
3843
+ "items": {
3844
+ "$ref": "#/components/schemas/SdkCompanyMetricsDto"
3845
+ }
3846
+ },
3847
+ "meta": {
3848
+ "$ref": "#/components/schemas/SdkPaginationMetaDto"
3849
+ }
3850
+ },
3851
+ "required": [
3852
+ "data",
3853
+ "meta"
3854
+ ]
3855
+ },
3856
+ "SdkCompanyReportSummaryDto": {
3857
+ "type": "object",
3858
+ "properties": {
3859
+ "id": {
3860
+ "type": "number",
3861
+ "description": "Report identifier."
3862
+ },
3863
+ "title": {
3864
+ "type": "string",
3865
+ "description": "Human-readable report title."
3866
+ },
3867
+ "date": {
3868
+ "type": "string",
3869
+ "description": "Reporting period end date (ISO 8601, YYYY-MM-DD)."
3870
+ },
3871
+ "timeframe": {
3872
+ "type": "object",
3873
+ "description": "Reporting period granularity."
3874
+ },
3875
+ "publishedAt": {
3876
+ "type": "string",
3877
+ "description": "When the report was published (ISO 8601).",
3878
+ "nullable": true
3879
+ },
3880
+ "company": {
3881
+ "description": "Company that published the report.",
3882
+ "allOf": [
3883
+ {
3884
+ "$ref": "#/components/schemas/SdkCompanyReferenceDto"
3885
+ }
3886
+ ]
3887
+ }
3888
+ },
3889
+ "required": [
3890
+ "id",
3891
+ "title",
3892
+ "date",
3893
+ "timeframe",
3894
+ "company"
3895
+ ]
3896
+ },
3897
+ "SdkCompanyReportsListResponseDto": {
3898
+ "type": "object",
3899
+ "properties": {
3900
+ "data": {
3901
+ "type": "array",
3902
+ "items": {
3903
+ "$ref": "#/components/schemas/SdkCompanyReportSummaryDto"
3904
+ }
3905
+ },
3906
+ "meta": {
3907
+ "$ref": "#/components/schemas/SdkPaginationMetaDto"
3908
+ }
3909
+ },
3910
+ "required": [
3911
+ "data",
3912
+ "meta"
3913
+ ]
3914
+ },
3915
+ "SdkUserReferenceDto": {
3916
+ "type": "object",
3917
+ "properties": {
3918
+ "id": {
3919
+ "type": "number",
3920
+ "description": "User identifier."
3921
+ },
3922
+ "name": {
3923
+ "type": "string",
3924
+ "description": "User display name (first + last name)."
3925
+ }
3926
+ },
3927
+ "required": [
3928
+ "id",
3929
+ "name"
3930
+ ]
3931
+ },
3932
+ "SdkCompanyReportAttachmentDto": {
3933
+ "type": "object",
3934
+ "properties": {
3935
+ "id": {
3936
+ "type": "number",
3937
+ "description": "Attachment identifier."
3938
+ },
3939
+ "name": {
3940
+ "type": "string",
3941
+ "description": "Original file name."
3942
+ },
3943
+ "url": {
3944
+ "type": "string",
3945
+ "description": "Pre-signed URL for download (time-limited).",
3946
+ "nullable": true
3947
+ }
3948
+ },
3949
+ "required": [
3950
+ "id",
3951
+ "name"
3952
+ ]
3953
+ },
3954
+ "SdkCompanyReportSectionDto": {
3955
+ "type": "object",
3956
+ "properties": {
3957
+ "id": {
3958
+ "type": "number",
3959
+ "description": "Section identifier."
3960
+ },
3961
+ "type": {
3962
+ "type": "object",
3963
+ "description": "Section type."
3964
+ },
3965
+ "order": {
3966
+ "type": "number",
3967
+ "description": "Position of the section within the report (0-based)."
3968
+ },
3969
+ "title": {
3970
+ "type": "string",
3971
+ "description": "Section title."
3972
+ },
3973
+ "content": {
3974
+ "type": "string",
3975
+ "description": "Section body. Plain text for Text sections, Markdown for Markdown sections.",
3976
+ "nullable": true
3977
+ },
3978
+ "file": {
3979
+ "description": "Attached file for File-typed sections.",
3980
+ "nullable": true,
3981
+ "type": "object",
3982
+ "allOf": [
3983
+ {
3984
+ "$ref": "#/components/schemas/SdkCompanyReportAttachmentDto"
3985
+ }
3986
+ ]
3987
+ },
3988
+ "imageUrl": {
3989
+ "type": "string",
3990
+ "description": "Embedded image URL for Image sections (pre-signed, time-limited).",
3991
+ "nullable": true
3992
+ }
3993
+ },
3994
+ "required": [
3995
+ "id",
3996
+ "type",
3997
+ "order",
3998
+ "title"
3999
+ ]
4000
+ },
4001
+ "SdkCompanyReportDto": {
4002
+ "type": "object",
4003
+ "properties": {
4004
+ "id": {
4005
+ "type": "number",
4006
+ "description": "Report identifier."
4007
+ },
4008
+ "title": {
4009
+ "type": "string",
4010
+ "description": "Human-readable report title."
4011
+ },
4012
+ "date": {
4013
+ "type": "string",
4014
+ "description": "Reporting period end date (ISO 8601, YYYY-MM-DD)."
4015
+ },
4016
+ "timeframe": {
4017
+ "type": "object",
4018
+ "description": "Reporting period granularity."
4019
+ },
4020
+ "publishedAt": {
4021
+ "type": "string",
4022
+ "description": "When the report was published (ISO 8601).",
4023
+ "nullable": true
4024
+ },
4025
+ "company": {
4026
+ "description": "Company that published the report.",
4027
+ "allOf": [
4028
+ {
4029
+ "$ref": "#/components/schemas/SdkCompanyReferenceDto"
4030
+ }
4031
+ ]
4032
+ },
4033
+ "createdBy": {
4034
+ "description": "Author of the report.",
4035
+ "nullable": true,
4036
+ "type": "object",
4037
+ "allOf": [
4038
+ {
4039
+ "$ref": "#/components/schemas/SdkUserReferenceDto"
4040
+ }
4041
+ ]
4042
+ },
4043
+ "sections": {
4044
+ "description": "Structured sections that compose the report body.",
4045
+ "type": "array",
4046
+ "items": {
4047
+ "$ref": "#/components/schemas/SdkCompanyReportSectionDto"
4048
+ }
4049
+ },
4050
+ "attachments": {
4051
+ "description": "Files attached at the report level (not inside a specific section).",
4052
+ "type": "array",
4053
+ "items": {
4054
+ "$ref": "#/components/schemas/SdkCompanyReportAttachmentDto"
4055
+ }
4056
+ }
4057
+ },
4058
+ "required": [
4059
+ "id",
4060
+ "title",
4061
+ "date",
4062
+ "timeframe",
4063
+ "company",
4064
+ "sections",
4065
+ "attachments"
4066
+ ]
2714
4067
  }
2715
4068
  }
2716
4069
  }