@clear-street/clearstreet 0.102.0 → 0.104.0

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.
Files changed (132) hide show
  1. package/CHANGELOG.md +23 -0
  2. package/package.json +1 -1
  3. package/resources/v1/index.d.mts +2 -1
  4. package/resources/v1/index.d.mts.map +1 -1
  5. package/resources/v1/index.d.ts +2 -1
  6. package/resources/v1/index.d.ts.map +1 -1
  7. package/resources/v1/index.js +3 -1
  8. package/resources/v1/index.js.map +1 -1
  9. package/resources/v1/index.mjs +1 -0
  10. package/resources/v1/index.mjs.map +1 -1
  11. package/resources/v1/instrument-data/instrument-data.d.mts +22 -4
  12. package/resources/v1/instrument-data/instrument-data.d.mts.map +1 -1
  13. package/resources/v1/instrument-data/instrument-data.d.ts +22 -4
  14. package/resources/v1/instrument-data/instrument-data.d.ts.map +1 -1
  15. package/resources/v1/instrument-data/instrument-data.js.map +1 -1
  16. package/resources/v1/instrument-data/instrument-data.mjs.map +1 -1
  17. package/resources/v1/instrument-data/market-data.d.mts +21 -3
  18. package/resources/v1/instrument-data/market-data.d.mts.map +1 -1
  19. package/resources/v1/instrument-data/market-data.d.ts +21 -3
  20. package/resources/v1/instrument-data/market-data.d.ts.map +1 -1
  21. package/resources/v1/instrument-data/market-data.js +5 -0
  22. package/resources/v1/instrument-data/market-data.js.map +1 -1
  23. package/resources/v1/instrument-data/market-data.mjs +5 -0
  24. package/resources/v1/instrument-data/market-data.mjs.map +1 -1
  25. package/resources/v1/locates.d.mts +220 -0
  26. package/resources/v1/locates.d.mts.map +1 -0
  27. package/resources/v1/locates.d.ts +220 -0
  28. package/resources/v1/locates.d.ts.map +1 -0
  29. package/resources/v1/locates.js +81 -0
  30. package/resources/v1/locates.js.map +1 -0
  31. package/resources/v1/locates.mjs +77 -0
  32. package/resources/v1/locates.mjs.map +1 -0
  33. package/resources/v1/omni-ai/entitlements.d.mts +58 -10
  34. package/resources/v1/omni-ai/entitlements.d.mts.map +1 -1
  35. package/resources/v1/omni-ai/entitlements.d.ts +58 -10
  36. package/resources/v1/omni-ai/entitlements.d.ts.map +1 -1
  37. package/resources/v1/omni-ai/entitlements.js +35 -9
  38. package/resources/v1/omni-ai/entitlements.js.map +1 -1
  39. package/resources/v1/omni-ai/entitlements.mjs +35 -9
  40. package/resources/v1/omni-ai/entitlements.mjs.map +1 -1
  41. package/resources/v1/omni-ai/index.d.mts +1 -1
  42. package/resources/v1/omni-ai/index.d.mts.map +1 -1
  43. package/resources/v1/omni-ai/index.d.ts +1 -1
  44. package/resources/v1/omni-ai/index.d.ts.map +1 -1
  45. package/resources/v1/omni-ai/index.js.map +1 -1
  46. package/resources/v1/omni-ai/index.mjs.map +1 -1
  47. package/resources/v1/omni-ai/omni-ai.d.mts +6 -5
  48. package/resources/v1/omni-ai/omni-ai.d.mts.map +1 -1
  49. package/resources/v1/omni-ai/omni-ai.d.ts +6 -5
  50. package/resources/v1/omni-ai/omni-ai.d.ts.map +1 -1
  51. package/resources/v1/omni-ai/omni-ai.js.map +1 -1
  52. package/resources/v1/omni-ai/omni-ai.mjs.map +1 -1
  53. package/resources/v1/omni-ai/threads.d.mts +8 -2
  54. package/resources/v1/omni-ai/threads.d.mts.map +1 -1
  55. package/resources/v1/omni-ai/threads.d.ts +8 -2
  56. package/resources/v1/omni-ai/threads.d.ts.map +1 -1
  57. package/resources/v1/omni-ai/threads.js +4 -2
  58. package/resources/v1/omni-ai/threads.js.map +1 -1
  59. package/resources/v1/omni-ai/threads.mjs +4 -2
  60. package/resources/v1/omni-ai/threads.mjs.map +1 -1
  61. package/resources/v1/orders.d.mts +24 -6
  62. package/resources/v1/orders.d.mts.map +1 -1
  63. package/resources/v1/orders.d.ts +24 -6
  64. package/resources/v1/orders.d.ts.map +1 -1
  65. package/resources/v1/private-markets/index.d.mts +2 -4
  66. package/resources/v1/private-markets/index.d.mts.map +1 -1
  67. package/resources/v1/private-markets/index.d.ts +2 -4
  68. package/resources/v1/private-markets/index.d.ts.map +1 -1
  69. package/resources/v1/private-markets/index.js +1 -5
  70. package/resources/v1/private-markets/index.js.map +1 -1
  71. package/resources/v1/private-markets/index.mjs +0 -2
  72. package/resources/v1/private-markets/index.mjs.map +1 -1
  73. package/resources/v1/private-markets/iois.d.mts +151 -1
  74. package/resources/v1/private-markets/iois.d.mts.map +1 -1
  75. package/resources/v1/private-markets/iois.d.ts +151 -1
  76. package/resources/v1/private-markets/iois.d.ts.map +1 -1
  77. package/resources/v1/private-markets/iois.js +75 -0
  78. package/resources/v1/private-markets/iois.js.map +1 -1
  79. package/resources/v1/private-markets/iois.mjs +75 -0
  80. package/resources/v1/private-markets/iois.mjs.map +1 -1
  81. package/resources/v1/private-markets/private-markets.d.mts +494 -133
  82. package/resources/v1/private-markets/private-markets.d.mts.map +1 -1
  83. package/resources/v1/private-markets/private-markets.d.ts +494 -133
  84. package/resources/v1/private-markets/private-markets.d.ts.map +1 -1
  85. package/resources/v1/private-markets/private-markets.js +0 -76
  86. package/resources/v1/private-markets/private-markets.js.map +1 -1
  87. package/resources/v1/private-markets/private-markets.mjs +0 -76
  88. package/resources/v1/private-markets/private-markets.mjs.map +1 -1
  89. package/resources/v1/v1.d.mts +6 -2
  90. package/resources/v1/v1.d.mts.map +1 -1
  91. package/resources/v1/v1.d.ts +6 -2
  92. package/resources/v1/v1.d.ts.map +1 -1
  93. package/resources/v1/v1.js +4 -0
  94. package/resources/v1/v1.js.map +1 -1
  95. package/resources/v1/v1.mjs +4 -0
  96. package/resources/v1/v1.mjs.map +1 -1
  97. package/src/resources/v1/index.ts +41 -7
  98. package/src/resources/v1/instrument-data/instrument-data.ts +24 -4
  99. package/src/resources/v1/instrument-data/market-data.ts +23 -3
  100. package/src/resources/v1/locates.ts +294 -0
  101. package/src/resources/v1/omni-ai/entitlements.ts +84 -9
  102. package/src/resources/v1/omni-ai/index.ts +6 -0
  103. package/src/resources/v1/omni-ai/omni-ai.ts +16 -3
  104. package/src/resources/v1/omni-ai/threads.ts +8 -2
  105. package/src/resources/v1/orders.ts +31 -6
  106. package/src/resources/v1/private-markets/index.ts +32 -38
  107. package/src/resources/v1/private-markets/iois.ts +205 -1
  108. package/src/resources/v1/private-markets/private-markets.ts +622 -209
  109. package/src/resources/v1/v1.ts +86 -14
  110. package/src/version.ts +1 -1
  111. package/version.d.mts +1 -1
  112. package/version.d.ts +1 -1
  113. package/version.js +1 -1
  114. package/version.mjs +1 -1
  115. package/resources/v1/private-markets/companies.d.mts +0 -368
  116. package/resources/v1/private-markets/companies.d.mts.map +0 -1
  117. package/resources/v1/private-markets/companies.d.ts +0 -368
  118. package/resources/v1/private-markets/companies.d.ts.map +0 -1
  119. package/resources/v1/private-markets/companies.js +0 -9
  120. package/resources/v1/private-markets/companies.js.map +0 -1
  121. package/resources/v1/private-markets/companies.mjs +0 -5
  122. package/resources/v1/private-markets/companies.mjs.map +0 -1
  123. package/resources/v1/private-markets/spvs.d.mts +0 -158
  124. package/resources/v1/private-markets/spvs.d.mts.map +0 -1
  125. package/resources/v1/private-markets/spvs.d.ts +0 -158
  126. package/resources/v1/private-markets/spvs.d.ts.map +0 -1
  127. package/resources/v1/private-markets/spvs.js +0 -9
  128. package/resources/v1/private-markets/spvs.js.map +0 -1
  129. package/resources/v1/private-markets/spvs.mjs +0 -5
  130. package/resources/v1/private-markets/spvs.mjs.map +0 -1
  131. package/src/resources/v1/private-markets/companies.ts +0 -483
  132. package/src/resources/v1/private-markets/spvs.ts +0 -201
@@ -79,6 +79,23 @@ import {
79
79
  OptionsContractList,
80
80
  TickRule,
81
81
  } from './instruments';
82
+ import * as LocatesAPI from './locates';
83
+ import {
84
+ Locate,
85
+ LocateGetLocateByIDParams,
86
+ LocateGetLocateByIDResponse,
87
+ LocateGetLocateRateByIDResponse,
88
+ LocateGetLocateRatesParams,
89
+ LocateGetLocateRatesResponse,
90
+ LocateGetLocatesParams,
91
+ LocateGetLocatesResponse,
92
+ LocateList,
93
+ LocateRate,
94
+ LocateRateResult,
95
+ LocateRateResultList,
96
+ LocateStatus,
97
+ Locates,
98
+ } from './locates';
82
99
  import * as OmniFeedAPI from './omni-feed';
83
100
  import {
84
101
  FeedItem,
@@ -285,18 +302,36 @@ import {
285
302
  } from './omni-ai/omni-ai';
286
303
  import * as PrivateMarketsAPI from './private-markets/private-markets';
287
304
  import {
288
- PrivateMarketCreateIoiParams,
289
- PrivateMarketCreateIoiResponse,
290
- PrivateMarketDeleteIoiParams,
305
+ ChargedBy,
306
+ CompanyCategory,
307
+ CompanyCitation,
308
+ CompanyCustomer,
309
+ CompanyDetail,
310
+ CompanyDocumentPreview,
311
+ CompanyDocumentRelation,
312
+ CompanyDocumentResource,
313
+ CompanyDocumentType,
314
+ CompanyHeadquarters,
315
+ CompanyLegalEntity,
316
+ CompanyMetricPoint,
317
+ CompanyMetricSeries,
318
+ CompanyNarrativeSection,
319
+ CompanyPerson,
320
+ CompanyPersonRole,
321
+ CompanyProfileResource,
322
+ CompanySocialLink,
323
+ CompanySocialType,
324
+ FeeFrequency,
325
+ FeeType,
326
+ MetricFrequency,
327
+ MetricKey,
291
328
  PrivateMarketGetCompanyByIDParams,
292
329
  PrivateMarketGetCompanyByIDResponse,
293
- PrivateMarketGetIoisParams,
294
- PrivateMarketGetIoisResponse,
295
330
  PrivateMarketGetSpvByIDParams,
296
331
  PrivateMarketGetSpvByIDResponse,
297
- PrivateMarketUpdateIoiParams,
298
- PrivateMarketUpdateIoiResponse,
299
332
  PrivateMarkets,
333
+ SpvDetail,
334
+ SpvFeeTermResource,
300
335
  } from './private-markets/private-markets';
301
336
 
302
337
  export class V1 extends APIResource {
@@ -305,6 +340,7 @@ export class V1 extends APIResource {
305
340
  calendar: CalendarAPI.Calendar = new CalendarAPI.Calendar(this._client);
306
341
  instrumentData: InstrumentDataAPI.InstrumentData = new InstrumentDataAPI.InstrumentData(this._client);
307
342
  instruments: InstrumentsAPI.Instruments = new InstrumentsAPI.Instruments(this._client);
343
+ locates: LocatesAPI.Locates = new LocatesAPI.Locates(this._client);
308
344
  omniAI: OmniAIAPI.OmniAI = new OmniAIAPI.OmniAI(this._client);
309
345
  omniFeed: OmniFeedAPI.OmniFeed = new OmniFeedAPI.OmniFeed(this._client);
310
346
  orders: OrdersAPI.Orders = new OrdersAPI.Orders(this._client);
@@ -329,6 +365,7 @@ V1.APIVersion = APIVersion;
329
365
  V1.Calendar = Calendar;
330
366
  V1.InstrumentData = InstrumentData;
331
367
  V1.Instruments = Instruments;
368
+ V1.Locates = Locates;
332
369
  V1.OmniAI = OmniAI;
333
370
  V1.OmniFeed = OmniFeed;
334
371
  V1.Orders = Orders;
@@ -462,6 +499,23 @@ export declare namespace V1 {
462
499
  type InstrumentSearchInstrumentsParams as InstrumentSearchInstrumentsParams,
463
500
  };
464
501
 
502
+ export {
503
+ Locates as Locates,
504
+ type Locate as Locate,
505
+ type LocateList as LocateList,
506
+ type LocateRate as LocateRate,
507
+ type LocateRateResult as LocateRateResult,
508
+ type LocateRateResultList as LocateRateResultList,
509
+ type LocateStatus as LocateStatus,
510
+ type LocateGetLocateByIDResponse as LocateGetLocateByIDResponse,
511
+ type LocateGetLocateRateByIDResponse as LocateGetLocateRateByIDResponse,
512
+ type LocateGetLocateRatesResponse as LocateGetLocateRatesResponse,
513
+ type LocateGetLocatesResponse as LocateGetLocatesResponse,
514
+ type LocateGetLocateByIDParams as LocateGetLocateByIDParams,
515
+ type LocateGetLocateRatesParams as LocateGetLocateRatesParams,
516
+ type LocateGetLocatesParams as LocateGetLocatesParams,
517
+ };
518
+
465
519
  export {
466
520
  OmniAI as OmniAI,
467
521
  type ActionButton as ActionButton,
@@ -566,17 +620,35 @@ export declare namespace V1 {
566
620
 
567
621
  export {
568
622
  PrivateMarkets as PrivateMarkets,
569
- type PrivateMarketCreateIoiResponse as PrivateMarketCreateIoiResponse,
623
+ type ChargedBy as ChargedBy,
624
+ type CompanyCategory as CompanyCategory,
625
+ type CompanyCitation as CompanyCitation,
626
+ type CompanyCustomer as CompanyCustomer,
627
+ type CompanyDetail as CompanyDetail,
628
+ type CompanyDocumentPreview as CompanyDocumentPreview,
629
+ type CompanyDocumentRelation as CompanyDocumentRelation,
630
+ type CompanyDocumentResource as CompanyDocumentResource,
631
+ type CompanyDocumentType as CompanyDocumentType,
632
+ type CompanyHeadquarters as CompanyHeadquarters,
633
+ type CompanyLegalEntity as CompanyLegalEntity,
634
+ type CompanyMetricPoint as CompanyMetricPoint,
635
+ type CompanyMetricSeries as CompanyMetricSeries,
636
+ type CompanyNarrativeSection as CompanyNarrativeSection,
637
+ type CompanyPerson as CompanyPerson,
638
+ type CompanyPersonRole as CompanyPersonRole,
639
+ type CompanyProfileResource as CompanyProfileResource,
640
+ type CompanySocialLink as CompanySocialLink,
641
+ type CompanySocialType as CompanySocialType,
642
+ type FeeFrequency as FeeFrequency,
643
+ type FeeType as FeeType,
644
+ type MetricFrequency as MetricFrequency,
645
+ type MetricKey as MetricKey,
646
+ type SpvDetail as SpvDetail,
647
+ type SpvFeeTermResource as SpvFeeTermResource,
570
648
  type PrivateMarketGetCompanyByIDResponse as PrivateMarketGetCompanyByIDResponse,
571
- type PrivateMarketGetIoisResponse as PrivateMarketGetIoisResponse,
572
649
  type PrivateMarketGetSpvByIDResponse as PrivateMarketGetSpvByIDResponse,
573
- type PrivateMarketUpdateIoiResponse as PrivateMarketUpdateIoiResponse,
574
- type PrivateMarketCreateIoiParams as PrivateMarketCreateIoiParams,
575
- type PrivateMarketDeleteIoiParams as PrivateMarketDeleteIoiParams,
576
650
  type PrivateMarketGetCompanyByIDParams as PrivateMarketGetCompanyByIDParams,
577
- type PrivateMarketGetIoisParams as PrivateMarketGetIoisParams,
578
651
  type PrivateMarketGetSpvByIDParams as PrivateMarketGetSpvByIDParams,
579
- type PrivateMarketUpdateIoiParams as PrivateMarketUpdateIoiParams,
580
652
  };
581
653
 
582
654
  export {
package/src/version.ts CHANGED
@@ -1 +1 @@
1
- export const VERSION = '0.102.0'; // x-release-please-version
1
+ export const VERSION = '0.104.0'; // x-release-please-version
package/version.d.mts CHANGED
@@ -1,2 +1,2 @@
1
- export declare const VERSION = "0.102.0";
1
+ export declare const VERSION = "0.104.0";
2
2
  //# sourceMappingURL=version.d.mts.map
package/version.d.ts CHANGED
@@ -1,2 +1,2 @@
1
- export declare const VERSION = "0.102.0";
1
+ export declare const VERSION = "0.104.0";
2
2
  //# sourceMappingURL=version.d.ts.map
package/version.js CHANGED
@@ -1,5 +1,5 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.VERSION = void 0;
4
- exports.VERSION = '0.102.0'; // x-release-please-version
4
+ exports.VERSION = '0.104.0'; // x-release-please-version
5
5
  //# sourceMappingURL=version.js.map
package/version.mjs CHANGED
@@ -1,2 +1,2 @@
1
- export const VERSION = '0.102.0'; // x-release-please-version
1
+ export const VERSION = '0.104.0'; // x-release-please-version
2
2
  //# sourceMappingURL=version.mjs.map
@@ -1,368 +0,0 @@
1
- import { APIResource } from "../../../core/resource.mjs";
2
- import * as OfferingsAPI from "./offerings.mjs";
3
- export declare class Companies extends APIResource {
4
- }
5
- /**
6
- * A company category.
7
- */
8
- export interface CompanyCategory {
9
- /**
10
- * Display name.
11
- */
12
- name: string;
13
- /**
14
- * Stable lowercase category slug.
15
- */
16
- slug: string;
17
- }
18
- /**
19
- * A cited source.
20
- */
21
- export interface CompanyCitation {
22
- /**
23
- * Stable profile-local citation identifier.
24
- */
25
- id: string;
26
- /**
27
- * Source publisher or provider.
28
- */
29
- source: string;
30
- /**
31
- * Human-readable source title.
32
- */
33
- title: string;
34
- /**
35
- * Source URL.
36
- */
37
- url: string;
38
- /**
39
- * Source publication time, when known.
40
- */
41
- published_at?: string | null;
42
- }
43
- /**
44
- * A named company customer.
45
- */
46
- export interface CompanyCustomer {
47
- /**
48
- * Customer name.
49
- */
50
- name: string;
51
- /**
52
- * Customer logo, when supplied.
53
- */
54
- logo_url?: string | null;
55
- }
56
- /**
57
- * A company's identity and its complete published profile.
58
- */
59
- export interface CompanyDetail {
60
- /**
61
- * Stable company identifier.
62
- */
63
- id: string;
64
- /**
65
- * Display name.
66
- */
67
- name: string;
68
- /**
69
- * The complete versioned company profile.
70
- */
71
- profile: CompanyProfileResource;
72
- /**
73
- * Profile schema version discriminator.
74
- */
75
- profile_schema_version: number;
76
- /**
77
- * Short card/search description.
78
- */
79
- short_description: string;
80
- /**
81
- * Lowercase URL slug.
82
- */
83
- slug: string;
84
- /**
85
- * Company logo URL, when known.
86
- */
87
- logo_url?: string | null;
88
- /**
89
- * Canonical lowercase domain, when known.
90
- */
91
- primary_domain?: string | null;
92
- /**
93
- * Publication time.
94
- */
95
- published_at?: string | null;
96
- }
97
- /**
98
- * Optional document card preview.
99
- */
100
- export interface CompanyDocumentPreview {
101
- /**
102
- * Preview description.
103
- */
104
- description?: string | null;
105
- /**
106
- * Preview image URL.
107
- */
108
- image_url?: string | null;
109
- }
110
- /**
111
- * How a document relates to the company.
112
- */
113
- export type CompanyDocumentRelation = 'SUBJECT' | 'CONNECTED';
114
- /**
115
- * A company-level research or source document.
116
- */
117
- export interface CompanyDocumentResource {
118
- /**
119
- * Typed document kind.
120
- */
121
- document_type: CompanyDocumentType;
122
- /**
123
- * Relationship to this company.
124
- */
125
- relation: CompanyDocumentRelation;
126
- /**
127
- * Display title.
128
- */
129
- title: string;
130
- /**
131
- * Document URL.
132
- */
133
- url: string;
134
- /**
135
- * Optional source identifier retained for reconciliation.
136
- */
137
- external_id?: string | null;
138
- /**
139
- * Optional card preview.
140
- */
141
- preview?: CompanyDocumentPreview | null;
142
- /**
143
- * Publication time, when known.
144
- */
145
- published_at?: string | null;
146
- }
147
- /**
148
- * Company document kind.
149
- */
150
- export type CompanyDocumentType = 'COMPANY_PROFILE' | 'MARKET_RESEARCH' | 'INTERVIEW' | 'DEAL_SHEET' | 'PRESS_RELEASE' | 'NEWS' | 'OTHER';
151
- /**
152
- * Company headquarters.
153
- */
154
- export interface CompanyHeadquarters {
155
- /**
156
- * City.
157
- */
158
- city: string;
159
- /**
160
- * Country.
161
- */
162
- country: string;
163
- }
164
- /**
165
- * A legal entity associated with the company.
166
- */
167
- export interface CompanyLegalEntity {
168
- /**
169
- * Country name or ISO country code supplied by the source.
170
- */
171
- country: string;
172
- /**
173
- * Legal name.
174
- */
175
- name: string;
176
- }
177
- /**
178
- * One metric observation.
179
- */
180
- export interface CompanyMetricPoint {
181
- /**
182
- * Observation time.
183
- */
184
- observed_at: string;
185
- /**
186
- * Exact decimal value, serialized as a string.
187
- */
188
- value: string;
189
- /**
190
- * Historical or estimated classification.
191
- */
192
- value_type: OfferingsAPI.MetricValueType;
193
- /**
194
- * Profile-local citation ids supporting this point.
195
- */
196
- citation_ids?: Array<string>;
197
- /**
198
- * Optional source event identifier.
199
- */
200
- source_event_id?: string | null;
201
- /**
202
- * Optional provider reconciliation metadata.
203
- */
204
- source_metadata?: {
205
- [key: string]: string;
206
- } | null;
207
- }
208
- /**
209
- * A historical or estimated company metric series.
210
- */
211
- export interface CompanyMetricSeries {
212
- /**
213
- * Observation cadence.
214
- */
215
- frequency: MetricFrequency;
216
- /**
217
- * Display label.
218
- */
219
- label: string;
220
- /**
221
- * Canonical metric key.
222
- */
223
- metric_key: MetricKey;
224
- /**
225
- * Publisher/provider name.
226
- */
227
- source: string;
228
- /**
229
- * Value unit.
230
- */
231
- unit: OfferingsAPI.MetricUnit;
232
- /**
233
- * Optional source identifier retained for reconciliation.
234
- */
235
- external_id?: string | null;
236
- /**
237
- * Ordered observations.
238
- */
239
- points?: Array<CompanyMetricPoint>;
240
- /**
241
- * Source URL, when available.
242
- */
243
- source_url?: string | null;
244
- }
245
- /**
246
- * One ordered durable narrative block.
247
- */
248
- export interface CompanyNarrativeSection {
249
- /**
250
- * Plain-text section body.
251
- */
252
- body: string;
253
- /**
254
- * Stable display position within the profile.
255
- */
256
- display_order: number;
257
- /**
258
- * Section heading.
259
- */
260
- title: string;
261
- /**
262
- * Profile-local citation ids supporting this block.
263
- */
264
- citation_ids?: Array<string>;
265
- }
266
- /**
267
- * A key person associated with the company.
268
- */
269
- export interface CompanyPerson {
270
- /**
271
- * Display name.
272
- */
273
- name: string;
274
- /**
275
- * Optional source identifier retained for reconciliation.
276
- */
277
- external_id?: string | null;
278
- /**
279
- * One or more curated company roles.
280
- */
281
- roles?: Array<CompanyPersonRole>;
282
- }
283
- /**
284
- * A key person's relationship to the company.
285
- */
286
- export type CompanyPersonRole = 'FOUNDER' | 'CEO' | 'OTHER';
287
- /**
288
- * The complete versioned company profile (schema version one).
289
- */
290
- export interface CompanyProfileResource {
291
- /**
292
- * Company categories.
293
- */
294
- categories?: Array<CompanyCategory>;
295
- /**
296
- * Sources referenced by narrative sections and metrics.
297
- */
298
- citations?: Array<CompanyCitation>;
299
- /**
300
- * Named customers evidenced by the source material.
301
- */
302
- customers?: Array<CompanyCustomer>;
303
- /**
304
- * Company-level research and source documents.
305
- */
306
- documents?: Array<CompanyDocumentResource>;
307
- /**
308
- * Company headquarters, when known.
309
- */
310
- headquarters?: CompanyHeadquarters | null;
311
- /**
312
- * Known legal entities associated with the company.
313
- */
314
- legal_entities?: Array<CompanyLegalEntity>;
315
- /**
316
- * Historical and estimated metric series.
317
- */
318
- metric_series?: Array<CompanyMetricSeries>;
319
- /**
320
- * Ordered durable company fact and thesis blocks.
321
- */
322
- narrative_sections?: Array<CompanyNarrativeSection>;
323
- /**
324
- * Long company overview.
325
- */
326
- overview?: string | null;
327
- /**
328
- * Key people and their roles.
329
- */
330
- people?: Array<CompanyPerson>;
331
- /**
332
- * Social/profile links.
333
- */
334
- social?: Array<CompanySocialLink>;
335
- /**
336
- * Short durable positioning line used with the company name.
337
- */
338
- tagline?: string | null;
339
- }
340
- /**
341
- * A company social/profile link.
342
- */
343
- export interface CompanySocialLink {
344
- /**
345
- * Link type.
346
- */
347
- type: CompanySocialType;
348
- /**
349
- * Link URL.
350
- */
351
- url: string;
352
- }
353
- /**
354
- * Kind of company social/profile link.
355
- */
356
- export type CompanySocialType = 'WEBSITE' | 'LINKEDIN' | 'X' | 'FACEBOOK' | 'OTHER';
357
- /**
358
- * Observation cadence for a metric series.
359
- */
360
- export type MetricFrequency = 'YEAR' | 'QUARTER' | 'MONTH' | 'POINT_IN_TIME';
361
- /**
362
- * Canonical company metric key.
363
- */
364
- export type MetricKey = 'ANNUALIZED_REVENUE' | 'REVENUE_GROWTH' | 'VALUATION' | 'ISSUE_PRICE' | 'PRICE_PER_SHARE' | 'AMOUNT_RAISED' | 'ORDER_VOLUME' | 'PIPELINE_VALUE' | 'GROSS_MARGIN' | 'EBIT_MARGIN' | 'FCF_CONVERSION' | 'CONTRACTED_REVENUE_PERCENT' | 'NET_REVENUE_RETENTION' | 'CUSTOMER_COUNT' | 'MARKET_POSITION';
365
- export declare namespace Companies {
366
- export { type CompanyCategory as CompanyCategory, type CompanyCitation as CompanyCitation, type CompanyCustomer as CompanyCustomer, type CompanyDetail as CompanyDetail, type CompanyDocumentPreview as CompanyDocumentPreview, type CompanyDocumentRelation as CompanyDocumentRelation, type CompanyDocumentResource as CompanyDocumentResource, type CompanyDocumentType as CompanyDocumentType, type CompanyHeadquarters as CompanyHeadquarters, type CompanyLegalEntity as CompanyLegalEntity, type CompanyMetricPoint as CompanyMetricPoint, type CompanyMetricSeries as CompanyMetricSeries, type CompanyNarrativeSection as CompanyNarrativeSection, type CompanyPerson as CompanyPerson, type CompanyPersonRole as CompanyPersonRole, type CompanyProfileResource as CompanyProfileResource, type CompanySocialLink as CompanySocialLink, type CompanySocialType as CompanySocialType, type MetricFrequency as MetricFrequency, type MetricKey as MetricKey, };
367
- }
368
- //# sourceMappingURL=companies.d.mts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"companies.d.mts","sourceRoot":"","sources":["../../../src/resources/v1/private-markets/companies.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,mCAA+B;AACrD,OAAO,KAAK,YAAY,wBAAoB;AAE5C,qBAAa,SAAU,SAAQ,WAAW;CAAG;AAE7C;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,OAAO,EAAE,sBAAsB,CAAC;IAEhC;;OAEG;IACH,sBAAsB,EAAE,MAAM,CAAC;IAE/B;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,SAAS,GAAG,WAAW,CAAC;AAE9D;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,aAAa,EAAE,mBAAmB,CAAC;IAEnC;;OAEG;IACH,QAAQ,EAAE,uBAAuB,CAAC;IAElC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,OAAO,CAAC,EAAE,sBAAsB,GAAG,IAAI,CAAC;IAExC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAC3B,iBAAiB,GACjB,iBAAiB,GACjB,WAAW,GACX,YAAY,GACZ,eAAe,GACf,MAAM,GACN,OAAO,CAAC;AAEZ;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,UAAU,EAAE,YAAY,CAAC,eAAe,CAAC;IAEzC;;OAEG;IACH,YAAY,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE7B;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,eAAe,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,GAAG,IAAI,CAAC;CACpD;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,SAAS,EAAE,eAAe,CAAC;IAE3B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,UAAU,EAAE,SAAS,CAAC;IAEtB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,IAAI,EAAE,YAAY,CAAC,UAAU,CAAC;IAE9B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,kBAAkB,CAAC,CAAC;IAEnC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,YAAY,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC,iBAAiB,CAAC,CAAC;CAClC;AAED;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,SAAS,GAAG,KAAK,GAAG,OAAO,CAAC;AAE5D;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,eAAe,CAAC,CAAC;IAEpC;;OAEG;IACH,SAAS,CAAC,EAAE,KAAK,CAAC,eAAe,CAAC,CAAC;IAEnC;;OAEG;IACH,SAAS,CAAC,EAAE,KAAK,CAAC,eAAe,CAAC,CAAC;IAEnC;;OAEG;IACH,SAAS,CAAC,EAAE,KAAK,CAAC,uBAAuB,CAAC,CAAC;IAE3C;;OAEG;IACH,YAAY,CAAC,EAAE,mBAAmB,GAAG,IAAI,CAAC;IAE1C;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,kBAAkB,CAAC,CAAC;IAE3C;;OAEG;IACH,aAAa,CAAC,EAAE,KAAK,CAAC,mBAAmB,CAAC,CAAC;IAE3C;;OAEG;IACH,kBAAkB,CAAC,EAAE,KAAK,CAAC,uBAAuB,CAAC,CAAC;IAEpD;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC,CAAC;IAE9B;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,iBAAiB,CAAC,CAAC;IAElC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,IAAI,EAAE,iBAAiB,CAAC;IAExB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;CACb;AAED;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,SAAS,GAAG,UAAU,GAAG,GAAG,GAAG,UAAU,GAAG,OAAO,CAAC;AAEpF;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,MAAM,GAAG,SAAS,GAAG,OAAO,GAAG,eAAe,CAAC;AAE7E;;GAEG;AACH,MAAM,MAAM,SAAS,GACjB,oBAAoB,GACpB,gBAAgB,GAChB,WAAW,GACX,aAAa,GACb,iBAAiB,GACjB,eAAe,GACf,cAAc,GACd,gBAAgB,GAChB,cAAc,GACd,aAAa,GACb,gBAAgB,GAChB,4BAA4B,GAC5B,uBAAuB,GACvB,gBAAgB,GAChB,iBAAiB,CAAC;AAEtB,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,SAAS,IAAI,SAAS,GAC5B,CAAC;CACH"}