@clear-street/clearstreet 0.103.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 (113) hide show
  1. package/CHANGELOG.md +11 -0
  2. package/client.d.mts +0 -1
  3. package/client.d.mts.map +1 -1
  4. package/client.d.ts +0 -1
  5. package/client.d.ts.map +1 -1
  6. package/package.json +1 -1
  7. package/resources/shared.d.mts +3 -4
  8. package/resources/shared.d.mts.map +1 -1
  9. package/resources/shared.d.ts +3 -4
  10. package/resources/shared.d.ts.map +1 -1
  11. package/resources/v1/index.d.mts +2 -2
  12. package/resources/v1/index.d.mts.map +1 -1
  13. package/resources/v1/index.d.ts +2 -2
  14. package/resources/v1/index.d.ts.map +1 -1
  15. package/resources/v1/index.js.map +1 -1
  16. package/resources/v1/index.mjs.map +1 -1
  17. package/resources/v1/instrument-data/market-data.d.mts +2 -1
  18. package/resources/v1/instrument-data/market-data.d.mts.map +1 -1
  19. package/resources/v1/instrument-data/market-data.d.ts +2 -1
  20. package/resources/v1/instrument-data/market-data.d.ts.map +1 -1
  21. package/resources/v1/locates.d.mts +123 -1
  22. package/resources/v1/locates.d.mts.map +1 -1
  23. package/resources/v1/locates.d.ts +123 -1
  24. package/resources/v1/locates.d.ts.map +1 -1
  25. package/resources/v1/locates.js +33 -0
  26. package/resources/v1/locates.js.map +1 -1
  27. package/resources/v1/locates.mjs +33 -0
  28. package/resources/v1/locates.mjs.map +1 -1
  29. package/resources/v1/omni-ai/entitlements.d.mts +58 -10
  30. package/resources/v1/omni-ai/entitlements.d.mts.map +1 -1
  31. package/resources/v1/omni-ai/entitlements.d.ts +58 -10
  32. package/resources/v1/omni-ai/entitlements.d.ts.map +1 -1
  33. package/resources/v1/omni-ai/entitlements.js +35 -9
  34. package/resources/v1/omni-ai/entitlements.js.map +1 -1
  35. package/resources/v1/omni-ai/entitlements.mjs +35 -9
  36. package/resources/v1/omni-ai/entitlements.mjs.map +1 -1
  37. package/resources/v1/omni-ai/index.d.mts +1 -1
  38. package/resources/v1/omni-ai/index.d.mts.map +1 -1
  39. package/resources/v1/omni-ai/index.d.ts +1 -1
  40. package/resources/v1/omni-ai/index.d.ts.map +1 -1
  41. package/resources/v1/omni-ai/index.js.map +1 -1
  42. package/resources/v1/omni-ai/index.mjs.map +1 -1
  43. package/resources/v1/omni-ai/omni-ai.d.mts +2 -2
  44. package/resources/v1/omni-ai/omni-ai.d.mts.map +1 -1
  45. package/resources/v1/omni-ai/omni-ai.d.ts +2 -2
  46. package/resources/v1/omni-ai/omni-ai.d.ts.map +1 -1
  47. package/resources/v1/omni-ai/omni-ai.js.map +1 -1
  48. package/resources/v1/omni-ai/omni-ai.mjs.map +1 -1
  49. package/resources/v1/private-markets/index.d.mts +2 -4
  50. package/resources/v1/private-markets/index.d.mts.map +1 -1
  51. package/resources/v1/private-markets/index.d.ts +2 -4
  52. package/resources/v1/private-markets/index.d.ts.map +1 -1
  53. package/resources/v1/private-markets/index.js +1 -5
  54. package/resources/v1/private-markets/index.js.map +1 -1
  55. package/resources/v1/private-markets/index.mjs +0 -2
  56. package/resources/v1/private-markets/index.mjs.map +1 -1
  57. package/resources/v1/private-markets/iois.d.mts +151 -1
  58. package/resources/v1/private-markets/iois.d.mts.map +1 -1
  59. package/resources/v1/private-markets/iois.d.ts +151 -1
  60. package/resources/v1/private-markets/iois.d.ts.map +1 -1
  61. package/resources/v1/private-markets/iois.js +75 -0
  62. package/resources/v1/private-markets/iois.js.map +1 -1
  63. package/resources/v1/private-markets/iois.mjs +75 -0
  64. package/resources/v1/private-markets/iois.mjs.map +1 -1
  65. package/resources/v1/private-markets/private-markets.d.mts +494 -133
  66. package/resources/v1/private-markets/private-markets.d.mts.map +1 -1
  67. package/resources/v1/private-markets/private-markets.d.ts +494 -133
  68. package/resources/v1/private-markets/private-markets.d.ts.map +1 -1
  69. package/resources/v1/private-markets/private-markets.js +0 -76
  70. package/resources/v1/private-markets/private-markets.js.map +1 -1
  71. package/resources/v1/private-markets/private-markets.mjs +0 -76
  72. package/resources/v1/private-markets/private-markets.mjs.map +1 -1
  73. package/resources/v1/v1.d.mts +4 -4
  74. package/resources/v1/v1.d.mts.map +1 -1
  75. package/resources/v1/v1.d.ts +4 -4
  76. package/resources/v1/v1.d.ts.map +1 -1
  77. package/resources/v1/v1.js.map +1 -1
  78. package/resources/v1/v1.mjs.map +1 -1
  79. package/src/client.ts +0 -1
  80. package/src/resources/shared.ts +1 -3
  81. package/src/resources/v1/index.ts +32 -7
  82. package/src/resources/v1/instrument-data/market-data.ts +2 -1
  83. package/src/resources/v1/locates.ts +164 -0
  84. package/src/resources/v1/omni-ai/entitlements.ts +84 -9
  85. package/src/resources/v1/omni-ai/index.ts +6 -0
  86. package/src/resources/v1/omni-ai/omni-ai.ts +12 -0
  87. package/src/resources/v1/private-markets/index.ts +32 -38
  88. package/src/resources/v1/private-markets/iois.ts +205 -1
  89. package/src/resources/v1/private-markets/private-markets.ts +622 -209
  90. package/src/resources/v1/v1.ts +64 -14
  91. package/src/version.ts +1 -1
  92. package/version.d.mts +1 -1
  93. package/version.d.ts +1 -1
  94. package/version.js +1 -1
  95. package/version.mjs +1 -1
  96. package/resources/v1/private-markets/companies.d.mts +0 -368
  97. package/resources/v1/private-markets/companies.d.mts.map +0 -1
  98. package/resources/v1/private-markets/companies.d.ts +0 -368
  99. package/resources/v1/private-markets/companies.d.ts.map +0 -1
  100. package/resources/v1/private-markets/companies.js +0 -9
  101. package/resources/v1/private-markets/companies.js.map +0 -1
  102. package/resources/v1/private-markets/companies.mjs +0 -5
  103. package/resources/v1/private-markets/companies.mjs.map +0 -1
  104. package/resources/v1/private-markets/spvs.d.mts +0 -158
  105. package/resources/v1/private-markets/spvs.d.mts.map +0 -1
  106. package/resources/v1/private-markets/spvs.d.ts +0 -158
  107. package/resources/v1/private-markets/spvs.d.ts.map +0 -1
  108. package/resources/v1/private-markets/spvs.js +0 -9
  109. package/resources/v1/private-markets/spvs.js.map +0 -1
  110. package/resources/v1/private-markets/spvs.mjs +0 -5
  111. package/resources/v1/private-markets/spvs.mjs.map +0 -1
  112. package/src/resources/v1/private-markets/companies.ts +0 -483
  113. package/src/resources/v1/private-markets/spvs.ts +0 -201
@@ -2,30 +2,6 @@
2
2
 
3
3
  import { APIResource } from '../../../core/resource';
4
4
  import * as Shared from '../../shared';
5
- import * as CompaniesAPI from './companies';
6
- import {
7
- Companies,
8
- CompanyCategory,
9
- CompanyCitation,
10
- CompanyCustomer,
11
- CompanyDetail,
12
- CompanyDocumentPreview,
13
- CompanyDocumentRelation,
14
- CompanyDocumentResource,
15
- CompanyDocumentType,
16
- CompanyHeadquarters,
17
- CompanyLegalEntity,
18
- CompanyMetricPoint,
19
- CompanyMetricSeries,
20
- CompanyNarrativeSection,
21
- CompanyPerson,
22
- CompanyPersonRole,
23
- CompanyProfileResource,
24
- CompanySocialLink,
25
- CompanySocialType,
26
- MetricFrequency,
27
- MetricKey,
28
- } from './companies';
29
5
  import * as IoisAPI from './iois';
30
6
  import {
31
7
  IoiCompanyResource,
@@ -34,6 +10,13 @@ import {
34
10
  IoiOfferingResource,
35
11
  IoiResource,
36
12
  Iois,
13
+ IoisCreateIoiParams,
14
+ IoisCreateIoiResponse,
15
+ IoisDeleteIoiParams,
16
+ IoisGetIoisParams,
17
+ IoisGetIoisResponse,
18
+ IoisUpdateIoiParams,
19
+ IoisUpdateIoiResponse,
37
20
  NdaAcceptanceResource,
38
21
  } from './iois';
39
22
  import * as OfferingsAPI from './offerings';
@@ -62,10 +45,7 @@ import {
62
45
  SpvStatus,
63
46
  ValuationBasis,
64
47
  } from './offerings';
65
- import * as SpvsAPI from './spvs';
66
- import { ChargedBy, FeeFrequency, FeeType, SpvDetail, SpvFeeTermResource, Spvs } from './spvs';
67
48
  import { APIPromise } from '../../../core/api-promise';
68
- import { buildHeaders } from '../../../internal/headers';
69
49
  import { RequestOptions } from '../../../internal/request-options';
70
50
  import { path } from '../../../internal/utils/path';
71
51
 
@@ -73,50 +53,8 @@ import { path } from '../../../internal/utils/path';
73
53
  * Browse private-market offerings and their indicative terms. Access requires the account holder to hold an accreditation attestation.
74
54
  */
75
55
  export class PrivateMarkets extends APIResource {
76
- companies: CompaniesAPI.Companies = new CompaniesAPI.Companies(this._client);
77
56
  iois: IoisAPI.Iois = new IoisAPI.Iois(this._client);
78
57
  offerings: OfferingsAPI.Offerings = new OfferingsAPI.Offerings(this._client);
79
- spvs: SpvsAPI.Spvs = new SpvsAPI.Spvs(this._client);
80
-
81
- /**
82
- * Create an IOI for a visible upcoming offering.
83
- *
84
- * @example
85
- * ```ts
86
- * const response = await client.v1.privateMarkets.createIoi({
87
- * account_id: 0,
88
- * notional_amount: '100000.00',
89
- * offering_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
90
- * });
91
- * ```
92
- */
93
- createIoi(
94
- params: PrivateMarketCreateIoiParams,
95
- options?: RequestOptions,
96
- ): APIPromise<PrivateMarketCreateIoiResponse> {
97
- const { account_id, ...body } = params;
98
- return this._client.post('/v1/private-markets/iois', { query: { account_id }, body, ...options });
99
- }
100
-
101
- /**
102
- * Withdraw a live IOI. Repeating a withdrawal returns 404.
103
- *
104
- * @example
105
- * ```ts
106
- * await client.v1.privateMarkets.deleteIoi(
107
- * '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
108
- * { account_id: 0 },
109
- * );
110
- * ```
111
- */
112
- deleteIoi(ioiID: string, params: PrivateMarketDeleteIoiParams, options?: RequestOptions): APIPromise<void> {
113
- const { account_id } = params;
114
- return this._client.delete(path`/v1/private-markets/iois/${ioiID}`, {
115
- query: { account_id },
116
- ...options,
117
- headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
118
- });
119
- }
120
58
 
121
59
  /**
122
60
  * Fetch one published private-market company with its complete versioned profile.
@@ -140,23 +78,6 @@ export class PrivateMarkets extends APIResource {
140
78
  return this._client.get(path`/v1/private-markets/companies/${companyID}`, { query, ...options });
141
79
  }
142
80
 
143
- /**
144
- * List every live IOI for the caller's account-holder entity.
145
- *
146
- * @example
147
- * ```ts
148
- * const response = await client.v1.privateMarkets.getIois({
149
- * account_id: 0,
150
- * });
151
- * ```
152
- */
153
- getIois(
154
- query: PrivateMarketGetIoisParams,
155
- options?: RequestOptions,
156
- ): APIPromise<PrivateMarketGetIoisResponse> {
157
- return this._client.get('/v1/private-markets/iois', { query, ...options });
158
- }
159
-
160
81
  /**
161
82
  * Fetch one private-market SPV's complete economics and fee schedule. Requires the
162
83
  * account holder to have attested. Returns `404` unless the SPV is `OPEN` and
@@ -177,195 +98,681 @@ export class PrivateMarkets extends APIResource {
177
98
  ): APIPromise<PrivateMarketGetSpvByIDResponse> {
178
99
  return this._client.get(path`/v1/private-markets/spvs/${spvID}`, { query, ...options });
179
100
  }
101
+ }
180
102
 
103
+ /**
104
+ * Party charging a fee.
105
+ */
106
+ export type ChargedBy = 'FUND_MANAGER' | 'CLEAR_STREET' | 'THIRD_PARTY';
107
+
108
+ /**
109
+ * A company category.
110
+ */
111
+ export interface CompanyCategory {
181
112
  /**
182
- * Update an IOI's notional, accepting the current NDA revision when required.
183
- *
184
- * @example
185
- * ```ts
186
- * const response = await client.v1.privateMarkets.updateIoi(
187
- * '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
188
- * { account_id: 0, notional_amount: '125000.00' },
189
- * );
190
- * ```
113
+ * Display name.
191
114
  */
192
- updateIoi(
193
- ioiID: string,
194
- params: PrivateMarketUpdateIoiParams,
195
- options?: RequestOptions,
196
- ): APIPromise<PrivateMarketUpdateIoiResponse> {
197
- const { account_id, ...body } = params;
198
- return this._client.patch(path`/v1/private-markets/iois/${ioiID}`, {
199
- query: { account_id },
200
- body,
201
- ...options,
202
- });
203
- }
115
+ name: string;
116
+
117
+ /**
118
+ * Stable lowercase category slug.
119
+ */
120
+ slug: string;
204
121
  }
205
122
 
206
- export interface PrivateMarketCreateIoiResponse extends Shared.BaseResponse {
123
+ /**
124
+ * A cited source.
125
+ */
126
+ export interface CompanyCitation {
127
+ /**
128
+ * Stable profile-local citation identifier.
129
+ */
130
+ id: string;
131
+
207
132
  /**
208
- * IOI list item with the campaign identity needed to render it.
133
+ * Source publisher or provider.
209
134
  */
210
- data: IoisAPI.IoiListingResource;
135
+ source: string;
136
+
137
+ /**
138
+ * Human-readable source title.
139
+ */
140
+ title: string;
141
+
142
+ /**
143
+ * Source URL.
144
+ */
145
+ url: string;
146
+
147
+ /**
148
+ * Source publication time, when known.
149
+ */
150
+ published_at?: string | null;
211
151
  }
212
152
 
213
- export interface PrivateMarketGetCompanyByIDResponse extends Shared.BaseResponse {
153
+ /**
154
+ * A named company customer.
155
+ */
156
+ export interface CompanyCustomer {
214
157
  /**
215
- * A company's identity and its complete published profile.
158
+ * Customer name.
216
159
  */
217
- data: CompaniesAPI.CompanyDetail;
160
+ name: string;
161
+
162
+ /**
163
+ * Customer logo, when supplied.
164
+ */
165
+ logo_url?: string | null;
218
166
  }
219
167
 
220
- export interface PrivateMarketGetIoisResponse extends Shared.BaseResponse {
221
- data: IoisAPI.IoiListingResourceList;
168
+ /**
169
+ * A company's identity and its complete published profile.
170
+ */
171
+ export interface CompanyDetail {
172
+ /**
173
+ * Stable company identifier.
174
+ */
175
+ id: string;
176
+
177
+ /**
178
+ * Display name.
179
+ */
180
+ name: string;
181
+
182
+ /**
183
+ * The complete versioned company profile.
184
+ */
185
+ profile: CompanyProfileResource;
186
+
187
+ /**
188
+ * Profile schema version discriminator.
189
+ */
190
+ profile_schema_version: number;
191
+
192
+ /**
193
+ * Short card/search description.
194
+ */
195
+ short_description: string;
196
+
197
+ /**
198
+ * Lowercase URL slug.
199
+ */
200
+ slug: string;
201
+
202
+ /**
203
+ * Company logo URL, when known.
204
+ */
205
+ logo_url?: string | null;
206
+
207
+ /**
208
+ * Canonical lowercase domain, when known.
209
+ */
210
+ primary_domain?: string | null;
211
+
212
+ /**
213
+ * Publication time.
214
+ */
215
+ published_at?: string | null;
222
216
  }
223
217
 
224
- export interface PrivateMarketGetSpvByIDResponse extends Shared.BaseResponse {
218
+ /**
219
+ * Optional document card preview.
220
+ */
221
+ export interface CompanyDocumentPreview {
225
222
  /**
226
- * An OPEN SPV's identity, exact economics, and typed fee schedule.
223
+ * Preview description.
224
+ */
225
+ description?: string | null;
226
+
227
+ /**
228
+ * Preview image URL.
227
229
  */
228
- data: SpvsAPI.SpvDetail;
230
+ image_url?: string | null;
229
231
  }
230
232
 
231
- export interface PrivateMarketUpdateIoiResponse extends Shared.BaseResponse {
233
+ /**
234
+ * How a document relates to the company.
235
+ */
236
+ export type CompanyDocumentRelation = 'SUBJECT' | 'CONNECTED';
237
+
238
+ /**
239
+ * A company-level research or source document.
240
+ */
241
+ export interface CompanyDocumentResource {
242
+ /**
243
+ * Typed document kind.
244
+ */
245
+ document_type: CompanyDocumentType;
246
+
247
+ /**
248
+ * Relationship to this company.
249
+ */
250
+ relation: CompanyDocumentRelation;
251
+
252
+ /**
253
+ * Display title.
254
+ */
255
+ title: string;
256
+
257
+ /**
258
+ * Document URL.
259
+ */
260
+ url: string;
261
+
262
+ /**
263
+ * Optional source identifier retained for reconciliation.
264
+ */
265
+ external_id?: string | null;
266
+
232
267
  /**
233
- * IOI list item with the campaign identity needed to render it.
268
+ * Optional card preview.
234
269
  */
235
- data: IoisAPI.IoiListingResource;
270
+ preview?: CompanyDocumentPreview | null;
271
+
272
+ /**
273
+ * Publication time, when known.
274
+ */
275
+ published_at?: string | null;
236
276
  }
237
277
 
238
- export interface PrivateMarketCreateIoiParams {
278
+ /**
279
+ * Company document kind.
280
+ */
281
+ export type CompanyDocumentType =
282
+ | 'COMPANY_PROFILE'
283
+ | 'MARKET_RESEARCH'
284
+ | 'INTERVIEW'
285
+ | 'DEAL_SHEET'
286
+ | 'PRESS_RELEASE'
287
+ | 'NEWS'
288
+ | 'OTHER';
289
+
290
+ /**
291
+ * Company headquarters.
292
+ */
293
+ export interface CompanyHeadquarters {
239
294
  /**
240
- * Query param
295
+ * City.
241
296
  */
242
- account_id: number;
297
+ city: string;
243
298
 
244
299
  /**
245
- * Body param
300
+ * Country.
246
301
  */
247
- notional_amount: string;
302
+ country: string;
303
+ }
248
304
 
305
+ /**
306
+ * A legal entity associated with the company.
307
+ */
308
+ export interface CompanyLegalEntity {
249
309
  /**
250
- * Body param
310
+ * Country name or ISO country code supplied by the source.
251
311
  */
252
- offering_id: string;
312
+ country: string;
253
313
 
254
314
  /**
255
- * Body param: Required only when the offering's attached SPV has an NDA agreement.
315
+ * Legal name.
256
316
  */
257
- nda_acceptance?: PrivateMarketCreateIoiParams.NdaAcceptance | null;
317
+ name: string;
258
318
  }
259
319
 
260
- export namespace PrivateMarketCreateIoiParams {
320
+ /**
321
+ * One metric observation.
322
+ */
323
+ export interface CompanyMetricPoint {
261
324
  /**
262
- * Required only when the offering's attached SPV has an NDA agreement.
325
+ * Observation time.
263
326
  */
264
- export interface NdaAcceptance {
265
- /**
266
- * Must be true; confirms affirmative assent.
267
- */
268
- accepted: boolean;
327
+ observed_at: string;
269
328
 
270
- /**
271
- * Exact agreement id returned by offering detail.
272
- */
273
- agreement_id: string;
329
+ /**
330
+ * Exact decimal value, serialized as a string.
331
+ */
332
+ value: string;
274
333
 
275
- /**
276
- * Must be true; confirms the signer may bind the account-holder entity.
277
- */
278
- authority_confirmed: boolean;
279
- }
334
+ /**
335
+ * Historical or estimated classification.
336
+ */
337
+ value_type: OfferingsAPI.MetricValueType;
338
+
339
+ /**
340
+ * Profile-local citation ids supporting this point.
341
+ */
342
+ citation_ids?: Array<string>;
343
+
344
+ /**
345
+ * Optional source event identifier.
346
+ */
347
+ source_event_id?: string | null;
348
+
349
+ /**
350
+ * Optional provider reconciliation metadata.
351
+ */
352
+ source_metadata?: { [key: string]: string } | null;
280
353
  }
281
354
 
282
- export interface PrivateMarketDeleteIoiParams {
283
- account_id: number;
355
+ /**
356
+ * A historical or estimated company metric series.
357
+ */
358
+ export interface CompanyMetricSeries {
359
+ /**
360
+ * Observation cadence.
361
+ */
362
+ frequency: MetricFrequency;
363
+
364
+ /**
365
+ * Display label.
366
+ */
367
+ label: string;
368
+
369
+ /**
370
+ * Canonical metric key.
371
+ */
372
+ metric_key: MetricKey;
373
+
374
+ /**
375
+ * Publisher/provider name.
376
+ */
377
+ source: string;
378
+
379
+ /**
380
+ * Value unit.
381
+ */
382
+ unit: OfferingsAPI.MetricUnit;
383
+
384
+ /**
385
+ * Optional source identifier retained for reconciliation.
386
+ */
387
+ external_id?: string | null;
388
+
389
+ /**
390
+ * Ordered observations.
391
+ */
392
+ points?: Array<CompanyMetricPoint>;
393
+
394
+ /**
395
+ * Source URL, when available.
396
+ */
397
+ source_url?: string | null;
284
398
  }
285
399
 
286
- export interface PrivateMarketGetCompanyByIDParams {
400
+ /**
401
+ * One ordered durable narrative block.
402
+ */
403
+ export interface CompanyNarrativeSection {
287
404
  /**
288
- * Account whose account-holder entity must hold an accreditation attestation to
289
- * browse private-market offerings.
405
+ * Plain-text section body.
290
406
  */
291
- account_id: number;
407
+ body: string;
408
+
409
+ /**
410
+ * Stable display position within the profile.
411
+ */
412
+ display_order: number;
413
+
414
+ /**
415
+ * Section heading.
416
+ */
417
+ title: string;
418
+
419
+ /**
420
+ * Profile-local citation ids supporting this block.
421
+ */
422
+ citation_ids?: Array<string>;
292
423
  }
293
424
 
294
- export interface PrivateMarketGetIoisParams {
295
- account_id: number;
425
+ /**
426
+ * A key person associated with the company.
427
+ */
428
+ export interface CompanyPerson {
429
+ /**
430
+ * Display name.
431
+ */
432
+ name: string;
433
+
434
+ /**
435
+ * Optional source identifier retained for reconciliation.
436
+ */
437
+ external_id?: string | null;
438
+
439
+ /**
440
+ * One or more curated company roles.
441
+ */
442
+ roles?: Array<CompanyPersonRole>;
296
443
  }
297
444
 
298
- export interface PrivateMarketGetSpvByIDParams {
445
+ /**
446
+ * A key person's relationship to the company.
447
+ */
448
+ export type CompanyPersonRole = 'FOUNDER' | 'CEO' | 'OTHER';
449
+
450
+ /**
451
+ * The complete versioned company profile (schema version one).
452
+ */
453
+ export interface CompanyProfileResource {
299
454
  /**
300
- * Account whose account-holder entity must hold an accreditation attestation to
301
- * browse private-market offerings.
455
+ * Company categories.
302
456
  */
303
- account_id: number;
457
+ categories?: Array<CompanyCategory>;
458
+
459
+ /**
460
+ * Sources referenced by narrative sections and metrics.
461
+ */
462
+ citations?: Array<CompanyCitation>;
463
+
464
+ /**
465
+ * Named customers evidenced by the source material.
466
+ */
467
+ customers?: Array<CompanyCustomer>;
468
+
469
+ /**
470
+ * Company-level research and source documents.
471
+ */
472
+ documents?: Array<CompanyDocumentResource>;
473
+
474
+ /**
475
+ * Company headquarters, when known.
476
+ */
477
+ headquarters?: CompanyHeadquarters | null;
478
+
479
+ /**
480
+ * Known legal entities associated with the company.
481
+ */
482
+ legal_entities?: Array<CompanyLegalEntity>;
483
+
484
+ /**
485
+ * Historical and estimated metric series.
486
+ */
487
+ metric_series?: Array<CompanyMetricSeries>;
488
+
489
+ /**
490
+ * Ordered durable company fact and thesis blocks.
491
+ */
492
+ narrative_sections?: Array<CompanyNarrativeSection>;
493
+
494
+ /**
495
+ * Long company overview.
496
+ */
497
+ overview?: string | null;
498
+
499
+ /**
500
+ * Key people and their roles.
501
+ */
502
+ people?: Array<CompanyPerson>;
503
+
504
+ /**
505
+ * Social/profile links.
506
+ */
507
+ social?: Array<CompanySocialLink>;
508
+
509
+ /**
510
+ * Short durable positioning line used with the company name.
511
+ */
512
+ tagline?: string | null;
304
513
  }
305
514
 
306
- export interface PrivateMarketUpdateIoiParams {
515
+ /**
516
+ * A company social/profile link.
517
+ */
518
+ export interface CompanySocialLink {
307
519
  /**
308
- * Query param
520
+ * Link type.
309
521
  */
310
- account_id: number;
522
+ type: CompanySocialType;
523
+
524
+ /**
525
+ * Link URL.
526
+ */
527
+ url: string;
528
+ }
529
+
530
+ /**
531
+ * Kind of company social/profile link.
532
+ */
533
+ export type CompanySocialType = 'WEBSITE' | 'LINKEDIN' | 'X' | 'FACEBOOK' | 'OTHER';
534
+
535
+ /**
536
+ * Fee timing/cadence.
537
+ */
538
+ export type FeeFrequency = 'ONE_TIME' | 'ANNUAL' | 'AT_EXIT' | 'PASS_THROUGH';
539
+
540
+ /**
541
+ * Kind of SPV fee.
542
+ */
543
+ export type FeeType = 'MANAGEMENT' | 'CARRY' | 'PLACEMENT' | 'ADMINISTRATIVE' | 'OTHER';
544
+
545
+ /**
546
+ * Observation cadence for a metric series.
547
+ */
548
+ export type MetricFrequency = 'YEAR' | 'QUARTER' | 'MONTH' | 'POINT_IN_TIME';
549
+
550
+ /**
551
+ * Canonical company metric key.
552
+ */
553
+ export type MetricKey =
554
+ | 'ANNUALIZED_REVENUE'
555
+ | 'REVENUE_GROWTH'
556
+ | 'VALUATION'
557
+ | 'ISSUE_PRICE'
558
+ | 'PRICE_PER_SHARE'
559
+ | 'AMOUNT_RAISED'
560
+ | 'ORDER_VOLUME'
561
+ | 'PIPELINE_VALUE'
562
+ | 'GROSS_MARGIN'
563
+ | 'EBIT_MARGIN'
564
+ | 'FCF_CONVERSION'
565
+ | 'CONTRACTED_REVENUE_PERCENT'
566
+ | 'NET_REVENUE_RETENTION'
567
+ | 'CUSTOMER_COUNT'
568
+ | 'MARKET_POSITION';
569
+
570
+ /**
571
+ * An OPEN SPV's identity, exact economics, and typed fee schedule.
572
+ */
573
+ export interface SpvDetail {
574
+ /**
575
+ * Stable SPV identifier.
576
+ */
577
+ id: string;
578
+
579
+ /**
580
+ * Company whose shares the vehicle holds.
581
+ */
582
+ company_id: string;
583
+
584
+ /**
585
+ * Terms currency.
586
+ */
587
+ currency: OfferingsAPI.Currency;
588
+
589
+ /**
590
+ * Legal/display name.
591
+ */
592
+ name: string;
593
+
594
+ /**
595
+ * Lifecycle state.
596
+ */
597
+ status: OfferingsAPI.SpvStatus;
598
+
599
+ /**
600
+ * Price per share including fees.
601
+ */
602
+ all_in_price_per_share?: string | null;
603
+
604
+ /**
605
+ * Custodian.
606
+ */
607
+ custodian_name?: string | null;
608
+
609
+ /**
610
+ * Per-share fee.
611
+ */
612
+ fee_per_share?: string | null;
613
+
614
+ /**
615
+ * Typed fee schedule.
616
+ */
617
+ fee_terms?: Array<SpvFeeTermResource>;
618
+
619
+ /**
620
+ * Percentage of dollar allocation funded, derived from the allocation pair.
621
+ */
622
+ funded_percent?: string | null;
623
+
624
+ /**
625
+ * Funding deadline.
626
+ */
627
+ funding_deadline?: string | null;
628
+
629
+ /**
630
+ * SPV manager.
631
+ */
632
+ manager_name?: string | null;
633
+
634
+ /**
635
+ * Minimum investment amount.
636
+ */
637
+ minimum_investment_amount?: string | null;
638
+
639
+ /**
640
+ * Time the vehicle opened.
641
+ */
642
+ opened_at?: string | null;
643
+
644
+ /**
645
+ * Price per share excluding fees.
646
+ */
647
+ price_per_share?: string | null;
648
+
649
+ /**
650
+ * Remaining dollar allocation.
651
+ */
652
+ remaining_allocation_amount?: string | null;
653
+
654
+ /**
655
+ * Remaining share allocation.
656
+ */
657
+ remaining_share_allocation?: string | null;
311
658
 
312
659
  /**
313
- * Body param
660
+ * Underlying share class, when specified.
314
661
  */
315
- notional_amount: string;
662
+ share_class?: string | null;
316
663
 
317
664
  /**
318
- * Body param: Required when the SPV's current NDA version is newer than the IOI's
319
- * latest acceptance. Irrelevant acceptances are rejected.
665
+ * Plain-text vehicle structure.
320
666
  */
321
- nda_acceptance?: PrivateMarketUpdateIoiParams.NdaAcceptance | null;
667
+ structure_description?: string | null;
668
+
669
+ /**
670
+ * Total dollar allocation.
671
+ */
672
+ total_allocation_amount?: string | null;
673
+
674
+ /**
675
+ * Total share allocation.
676
+ */
677
+ total_share_allocation?: string | null;
678
+
679
+ /**
680
+ * Exact company valuation.
681
+ */
682
+ valuation?: string | null;
683
+
684
+ /**
685
+ * Meaning of `valuation`.
686
+ */
687
+ valuation_basis?: OfferingsAPI.ValuationBasis | null;
322
688
  }
323
689
 
324
- export namespace PrivateMarketUpdateIoiParams {
690
+ /**
691
+ * One typed SPV fee term.
692
+ */
693
+ export interface SpvFeeTermResource {
325
694
  /**
326
- * Required when the SPV's current NDA version is newer than the IOI's latest
327
- * acceptance. Irrelevant acceptances are rejected.
695
+ * Charging party.
328
696
  */
329
- export interface NdaAcceptance {
330
- /**
331
- * Must be true; confirms affirmative assent.
332
- */
333
- accepted: boolean;
697
+ charged_by: ChargedBy;
334
698
 
335
- /**
336
- * Exact agreement id returned by offering detail.
337
- */
338
- agreement_id: string;
699
+ /**
700
+ * Terms currency.
701
+ */
702
+ currency: OfferingsAPI.Currency;
339
703
 
340
- /**
341
- * Must be true; confirms the signer may bind the account-holder entity.
342
- */
343
- authority_confirmed: boolean;
344
- }
704
+ /**
705
+ * Plain-text fee disclosure.
706
+ */
707
+ description: string;
708
+
709
+ /**
710
+ * Fee kind.
711
+ */
712
+ fee_type: FeeType;
713
+
714
+ /**
715
+ * Timing/cadence.
716
+ */
717
+ frequency: FeeFrequency;
718
+
719
+ /**
720
+ * Exact fixed amount, when amount-based.
721
+ */
722
+ amount?: string | null;
723
+
724
+ /**
725
+ * Charge duration in years, when specified.
726
+ */
727
+ duration_years?: string | null;
728
+
729
+ /**
730
+ * Carry hurdle as a decimal fraction, when specified.
731
+ */
732
+ hurdle_rate?: string | null;
733
+
734
+ /**
735
+ * Decimal fraction between zero and one, when percentage-based.
736
+ */
737
+ rate?: string | null;
738
+ }
739
+
740
+ export interface PrivateMarketGetCompanyByIDResponse extends Shared.BaseResponse {
741
+ /**
742
+ * A company's identity and its complete published profile.
743
+ */
744
+ data: CompanyDetail;
745
+ }
746
+
747
+ export interface PrivateMarketGetSpvByIDResponse extends Shared.BaseResponse {
748
+ /**
749
+ * An OPEN SPV's identity, exact economics, and typed fee schedule.
750
+ */
751
+ data: SpvDetail;
752
+ }
753
+
754
+ export interface PrivateMarketGetCompanyByIDParams {
755
+ /**
756
+ * Account whose account-holder entity must hold an accreditation attestation to
757
+ * browse private-market offerings.
758
+ */
759
+ account_id: number;
760
+ }
761
+
762
+ export interface PrivateMarketGetSpvByIDParams {
763
+ /**
764
+ * Account whose account-holder entity must hold an accreditation attestation to
765
+ * browse private-market offerings.
766
+ */
767
+ account_id: number;
345
768
  }
346
769
 
347
- PrivateMarkets.Companies = Companies;
348
770
  PrivateMarkets.Iois = Iois;
349
771
  PrivateMarkets.Offerings = Offerings;
350
- PrivateMarkets.Spvs = Spvs;
351
772
 
352
773
  export declare namespace PrivateMarkets {
353
774
  export {
354
- type PrivateMarketCreateIoiResponse as PrivateMarketCreateIoiResponse,
355
- type PrivateMarketGetCompanyByIDResponse as PrivateMarketGetCompanyByIDResponse,
356
- type PrivateMarketGetIoisResponse as PrivateMarketGetIoisResponse,
357
- type PrivateMarketGetSpvByIDResponse as PrivateMarketGetSpvByIDResponse,
358
- type PrivateMarketUpdateIoiResponse as PrivateMarketUpdateIoiResponse,
359
- type PrivateMarketCreateIoiParams as PrivateMarketCreateIoiParams,
360
- type PrivateMarketDeleteIoiParams as PrivateMarketDeleteIoiParams,
361
- type PrivateMarketGetCompanyByIDParams as PrivateMarketGetCompanyByIDParams,
362
- type PrivateMarketGetIoisParams as PrivateMarketGetIoisParams,
363
- type PrivateMarketGetSpvByIDParams as PrivateMarketGetSpvByIDParams,
364
- type PrivateMarketUpdateIoiParams as PrivateMarketUpdateIoiParams,
365
- };
366
-
367
- export {
368
- Companies as Companies,
775
+ type ChargedBy as ChargedBy,
369
776
  type CompanyCategory as CompanyCategory,
370
777
  type CompanyCitation as CompanyCitation,
371
778
  type CompanyCustomer as CompanyCustomer,
@@ -384,8 +791,16 @@ export declare namespace PrivateMarkets {
384
791
  type CompanyProfileResource as CompanyProfileResource,
385
792
  type CompanySocialLink as CompanySocialLink,
386
793
  type CompanySocialType as CompanySocialType,
794
+ type FeeFrequency as FeeFrequency,
795
+ type FeeType as FeeType,
387
796
  type MetricFrequency as MetricFrequency,
388
797
  type MetricKey as MetricKey,
798
+ type SpvDetail as SpvDetail,
799
+ type SpvFeeTermResource as SpvFeeTermResource,
800
+ type PrivateMarketGetCompanyByIDResponse as PrivateMarketGetCompanyByIDResponse,
801
+ type PrivateMarketGetSpvByIDResponse as PrivateMarketGetSpvByIDResponse,
802
+ type PrivateMarketGetCompanyByIDParams as PrivateMarketGetCompanyByIDParams,
803
+ type PrivateMarketGetSpvByIDParams as PrivateMarketGetSpvByIDParams,
389
804
  };
390
805
 
391
806
  export {
@@ -396,6 +811,13 @@ export declare namespace PrivateMarkets {
396
811
  type IoiOfferingResource as IoiOfferingResource,
397
812
  type IoiResource as IoiResource,
398
813
  type NdaAcceptanceResource as NdaAcceptanceResource,
814
+ type IoisCreateIoiResponse as IoisCreateIoiResponse,
815
+ type IoisGetIoisResponse as IoisGetIoisResponse,
816
+ type IoisUpdateIoiResponse as IoisUpdateIoiResponse,
817
+ type IoisCreateIoiParams as IoisCreateIoiParams,
818
+ type IoisDeleteIoiParams as IoisDeleteIoiParams,
819
+ type IoisGetIoisParams as IoisGetIoisParams,
820
+ type IoisUpdateIoiParams as IoisUpdateIoiParams,
399
821
  };
400
822
 
401
823
  export {
@@ -423,13 +845,4 @@ export declare namespace PrivateMarkets {
423
845
  type OfferingGetOfferingByIDParams as OfferingGetOfferingByIDParams,
424
846
  type OfferingGetOfferingsParams as OfferingGetOfferingsParams,
425
847
  };
426
-
427
- export {
428
- Spvs as Spvs,
429
- type ChargedBy as ChargedBy,
430
- type FeeFrequency as FeeFrequency,
431
- type FeeType as FeeType,
432
- type SpvDetail as SpvDetail,
433
- type SpvFeeTermResource as SpvFeeTermResource,
434
- };
435
848
  }