@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
@@ -1,48 +1,17 @@
1
1
  import { APIResource } from "../../../core/resource.mjs";
2
2
  import * as Shared from "../../shared.mjs";
3
- import * as CompaniesAPI from "./companies.mjs";
4
- import { Companies, CompanyCategory, CompanyCitation, CompanyCustomer, CompanyDetail, CompanyDocumentPreview, CompanyDocumentRelation, CompanyDocumentResource, CompanyDocumentType, CompanyHeadquarters, CompanyLegalEntity, CompanyMetricPoint, CompanyMetricSeries, CompanyNarrativeSection, CompanyPerson, CompanyPersonRole, CompanyProfileResource, CompanySocialLink, CompanySocialType, MetricFrequency, MetricKey } from "./companies.mjs";
5
3
  import * as IoisAPI from "./iois.mjs";
6
- import { IoiCompanyResource, IoiListingResource, IoiListingResourceList, IoiOfferingResource, IoiResource, Iois, NdaAcceptanceResource } from "./iois.mjs";
4
+ import { IoiCompanyResource, IoiListingResource, IoiListingResourceList, IoiOfferingResource, IoiResource, Iois, IoisCreateIoiParams, IoisCreateIoiResponse, IoisDeleteIoiParams, IoisGetIoisParams, IoisGetIoisResponse, IoisUpdateIoiParams, IoisUpdateIoiResponse, NdaAcceptanceResource } from "./iois.mjs";
7
5
  import * as OfferingsAPI from "./offerings.mjs";
8
6
  import { Currency, MetricUnit, MetricValueType, NdaAgreementResource, OfferingCard, OfferingCardList, OfferingClass, OfferingCompany, OfferingDetail, OfferingDocumentResource, OfferingDocumentType, OfferingGetOfferingByIDParams, OfferingGetOfferingByIDResponse, OfferingGetOfferingsParams, OfferingGetOfferingsResponse, OfferingHighlight, OfferingKeyRisk, OfferingParticipantResource, OfferingSpv, Offerings, ParticipantRole, SpvStatus, ValuationBasis } from "./offerings.mjs";
9
- import * as SpvsAPI from "./spvs.mjs";
10
- import { ChargedBy, FeeFrequency, FeeType, SpvDetail, SpvFeeTermResource, Spvs } from "./spvs.mjs";
11
7
  import { APIPromise } from "../../../core/api-promise.mjs";
12
8
  import { RequestOptions } from "../../../internal/request-options.mjs";
13
9
  /**
14
10
  * Browse private-market offerings and their indicative terms. Access requires the account holder to hold an accreditation attestation.
15
11
  */
16
12
  export declare class PrivateMarkets extends APIResource {
17
- companies: CompaniesAPI.Companies;
18
13
  iois: IoisAPI.Iois;
19
14
  offerings: OfferingsAPI.Offerings;
20
- spvs: SpvsAPI.Spvs;
21
- /**
22
- * Create an IOI for a visible upcoming offering.
23
- *
24
- * @example
25
- * ```ts
26
- * const response = await client.v1.privateMarkets.createIoi({
27
- * account_id: 0,
28
- * notional_amount: '100000.00',
29
- * offering_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
30
- * });
31
- * ```
32
- */
33
- createIoi(params: PrivateMarketCreateIoiParams, options?: RequestOptions): APIPromise<PrivateMarketCreateIoiResponse>;
34
- /**
35
- * Withdraw a live IOI. Repeating a withdrawal returns 404.
36
- *
37
- * @example
38
- * ```ts
39
- * await client.v1.privateMarkets.deleteIoi(
40
- * '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
41
- * { account_id: 0 },
42
- * );
43
- * ```
44
- */
45
- deleteIoi(ioiID: string, params: PrivateMarketDeleteIoiParams, options?: RequestOptions): APIPromise<void>;
46
15
  /**
47
16
  * Fetch one published private-market company with its complete versioned profile.
48
17
  * Requires the account holder to have attested. Returns `404` when the company
@@ -58,17 +27,6 @@ export declare class PrivateMarkets extends APIResource {
58
27
  * ```
59
28
  */
60
29
  getCompanyByID(companyID: string, query: PrivateMarketGetCompanyByIDParams, options?: RequestOptions): APIPromise<PrivateMarketGetCompanyByIDResponse>;
61
- /**
62
- * List every live IOI for the caller's account-holder entity.
63
- *
64
- * @example
65
- * ```ts
66
- * const response = await client.v1.privateMarkets.getIois({
67
- * account_id: 0,
68
- * });
69
- * ```
70
- */
71
- getIois(query: PrivateMarketGetIoisParams, options?: RequestOptions): APIPromise<PrivateMarketGetIoisResponse>;
72
30
  /**
73
31
  * Fetch one private-market SPV's complete economics and fee schedule. Requires the
74
32
  * account holder to have attested. Returns `404` unless the SPV is `OPEN` and
@@ -83,143 +41,546 @@ export declare class PrivateMarkets extends APIResource {
83
41
  * ```
84
42
  */
85
43
  getSpvByID(spvID: string, query: PrivateMarketGetSpvByIDParams, options?: RequestOptions): APIPromise<PrivateMarketGetSpvByIDResponse>;
44
+ }
45
+ /**
46
+ * Party charging a fee.
47
+ */
48
+ export type ChargedBy = 'FUND_MANAGER' | 'CLEAR_STREET' | 'THIRD_PARTY';
49
+ /**
50
+ * A company category.
51
+ */
52
+ export interface CompanyCategory {
86
53
  /**
87
- * Update an IOI's notional, accepting the current NDA revision when required.
88
- *
89
- * @example
90
- * ```ts
91
- * const response = await client.v1.privateMarkets.updateIoi(
92
- * '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
93
- * { account_id: 0, notional_amount: '125000.00' },
94
- * );
95
- * ```
54
+ * Display name.
96
55
  */
97
- updateIoi(ioiID: string, params: PrivateMarketUpdateIoiParams, options?: RequestOptions): APIPromise<PrivateMarketUpdateIoiResponse>;
56
+ name: string;
57
+ /**
58
+ * Stable lowercase category slug.
59
+ */
60
+ slug: string;
98
61
  }
99
- export interface PrivateMarketCreateIoiResponse extends Shared.BaseResponse {
62
+ /**
63
+ * A cited source.
64
+ */
65
+ export interface CompanyCitation {
100
66
  /**
101
- * IOI list item with the campaign identity needed to render it.
67
+ * Stable profile-local citation identifier.
102
68
  */
103
- data: IoisAPI.IoiListingResource;
69
+ id: string;
70
+ /**
71
+ * Source publisher or provider.
72
+ */
73
+ source: string;
74
+ /**
75
+ * Human-readable source title.
76
+ */
77
+ title: string;
78
+ /**
79
+ * Source URL.
80
+ */
81
+ url: string;
82
+ /**
83
+ * Source publication time, when known.
84
+ */
85
+ published_at?: string | null;
104
86
  }
105
- export interface PrivateMarketGetCompanyByIDResponse extends Shared.BaseResponse {
87
+ /**
88
+ * A named company customer.
89
+ */
90
+ export interface CompanyCustomer {
106
91
  /**
107
- * A company's identity and its complete published profile.
92
+ * Customer name.
93
+ */
94
+ name: string;
95
+ /**
96
+ * Customer logo, when supplied.
108
97
  */
109
- data: CompaniesAPI.CompanyDetail;
98
+ logo_url?: string | null;
110
99
  }
111
- export interface PrivateMarketGetIoisResponse extends Shared.BaseResponse {
112
- data: IoisAPI.IoiListingResourceList;
100
+ /**
101
+ * A company's identity and its complete published profile.
102
+ */
103
+ export interface CompanyDetail {
104
+ /**
105
+ * Stable company identifier.
106
+ */
107
+ id: string;
108
+ /**
109
+ * Display name.
110
+ */
111
+ name: string;
112
+ /**
113
+ * The complete versioned company profile.
114
+ */
115
+ profile: CompanyProfileResource;
116
+ /**
117
+ * Profile schema version discriminator.
118
+ */
119
+ profile_schema_version: number;
120
+ /**
121
+ * Short card/search description.
122
+ */
123
+ short_description: string;
124
+ /**
125
+ * Lowercase URL slug.
126
+ */
127
+ slug: string;
128
+ /**
129
+ * Company logo URL, when known.
130
+ */
131
+ logo_url?: string | null;
132
+ /**
133
+ * Canonical lowercase domain, when known.
134
+ */
135
+ primary_domain?: string | null;
136
+ /**
137
+ * Publication time.
138
+ */
139
+ published_at?: string | null;
113
140
  }
114
- export interface PrivateMarketGetSpvByIDResponse extends Shared.BaseResponse {
141
+ /**
142
+ * Optional document card preview.
143
+ */
144
+ export interface CompanyDocumentPreview {
115
145
  /**
116
- * An OPEN SPV's identity, exact economics, and typed fee schedule.
146
+ * Preview description.
147
+ */
148
+ description?: string | null;
149
+ /**
150
+ * Preview image URL.
117
151
  */
118
- data: SpvsAPI.SpvDetail;
152
+ image_url?: string | null;
119
153
  }
120
- export interface PrivateMarketUpdateIoiResponse extends Shared.BaseResponse {
154
+ /**
155
+ * How a document relates to the company.
156
+ */
157
+ export type CompanyDocumentRelation = 'SUBJECT' | 'CONNECTED';
158
+ /**
159
+ * A company-level research or source document.
160
+ */
161
+ export interface CompanyDocumentResource {
162
+ /**
163
+ * Typed document kind.
164
+ */
165
+ document_type: CompanyDocumentType;
166
+ /**
167
+ * Relationship to this company.
168
+ */
169
+ relation: CompanyDocumentRelation;
170
+ /**
171
+ * Display title.
172
+ */
173
+ title: string;
174
+ /**
175
+ * Document URL.
176
+ */
177
+ url: string;
178
+ /**
179
+ * Optional source identifier retained for reconciliation.
180
+ */
181
+ external_id?: string | null;
182
+ /**
183
+ * Optional card preview.
184
+ */
185
+ preview?: CompanyDocumentPreview | null;
121
186
  /**
122
- * IOI list item with the campaign identity needed to render it.
187
+ * Publication time, when known.
123
188
  */
124
- data: IoisAPI.IoiListingResource;
189
+ published_at?: string | null;
125
190
  }
126
- export interface PrivateMarketCreateIoiParams {
191
+ /**
192
+ * Company document kind.
193
+ */
194
+ export type CompanyDocumentType = 'COMPANY_PROFILE' | 'MARKET_RESEARCH' | 'INTERVIEW' | 'DEAL_SHEET' | 'PRESS_RELEASE' | 'NEWS' | 'OTHER';
195
+ /**
196
+ * Company headquarters.
197
+ */
198
+ export interface CompanyHeadquarters {
127
199
  /**
128
- * Query param
200
+ * City.
129
201
  */
130
- account_id: number;
202
+ city: string;
131
203
  /**
132
- * Body param
204
+ * Country.
133
205
  */
134
- notional_amount: string;
206
+ country: string;
207
+ }
208
+ /**
209
+ * A legal entity associated with the company.
210
+ */
211
+ export interface CompanyLegalEntity {
135
212
  /**
136
- * Body param
213
+ * Country name or ISO country code supplied by the source.
137
214
  */
138
- offering_id: string;
215
+ country: string;
139
216
  /**
140
- * Body param: Required only when the offering's attached SPV has an NDA agreement.
217
+ * Legal name.
141
218
  */
142
- nda_acceptance?: PrivateMarketCreateIoiParams.NdaAcceptance | null;
219
+ name: string;
143
220
  }
144
- export declare namespace PrivateMarketCreateIoiParams {
221
+ /**
222
+ * One metric observation.
223
+ */
224
+ export interface CompanyMetricPoint {
145
225
  /**
146
- * Required only when the offering's attached SPV has an NDA agreement.
226
+ * Observation time.
147
227
  */
148
- interface NdaAcceptance {
149
- /**
150
- * Must be true; confirms affirmative assent.
151
- */
152
- accepted: boolean;
153
- /**
154
- * Exact agreement id returned by offering detail.
155
- */
156
- agreement_id: string;
157
- /**
158
- * Must be true; confirms the signer may bind the account-holder entity.
159
- */
160
- authority_confirmed: boolean;
161
- }
228
+ observed_at: string;
229
+ /**
230
+ * Exact decimal value, serialized as a string.
231
+ */
232
+ value: string;
233
+ /**
234
+ * Historical or estimated classification.
235
+ */
236
+ value_type: OfferingsAPI.MetricValueType;
237
+ /**
238
+ * Profile-local citation ids supporting this point.
239
+ */
240
+ citation_ids?: Array<string>;
241
+ /**
242
+ * Optional source event identifier.
243
+ */
244
+ source_event_id?: string | null;
245
+ /**
246
+ * Optional provider reconciliation metadata.
247
+ */
248
+ source_metadata?: {
249
+ [key: string]: string;
250
+ } | null;
162
251
  }
163
- export interface PrivateMarketDeleteIoiParams {
164
- account_id: number;
252
+ /**
253
+ * A historical or estimated company metric series.
254
+ */
255
+ export interface CompanyMetricSeries {
256
+ /**
257
+ * Observation cadence.
258
+ */
259
+ frequency: MetricFrequency;
260
+ /**
261
+ * Display label.
262
+ */
263
+ label: string;
264
+ /**
265
+ * Canonical metric key.
266
+ */
267
+ metric_key: MetricKey;
268
+ /**
269
+ * Publisher/provider name.
270
+ */
271
+ source: string;
272
+ /**
273
+ * Value unit.
274
+ */
275
+ unit: OfferingsAPI.MetricUnit;
276
+ /**
277
+ * Optional source identifier retained for reconciliation.
278
+ */
279
+ external_id?: string | null;
280
+ /**
281
+ * Ordered observations.
282
+ */
283
+ points?: Array<CompanyMetricPoint>;
284
+ /**
285
+ * Source URL, when available.
286
+ */
287
+ source_url?: string | null;
165
288
  }
166
- export interface PrivateMarketGetCompanyByIDParams {
289
+ /**
290
+ * One ordered durable narrative block.
291
+ */
292
+ export interface CompanyNarrativeSection {
167
293
  /**
168
- * Account whose account-holder entity must hold an accreditation attestation to
169
- * browse private-market offerings.
294
+ * Plain-text section body.
170
295
  */
171
- account_id: number;
296
+ body: string;
297
+ /**
298
+ * Stable display position within the profile.
299
+ */
300
+ display_order: number;
301
+ /**
302
+ * Section heading.
303
+ */
304
+ title: string;
305
+ /**
306
+ * Profile-local citation ids supporting this block.
307
+ */
308
+ citation_ids?: Array<string>;
172
309
  }
173
- export interface PrivateMarketGetIoisParams {
174
- account_id: number;
310
+ /**
311
+ * A key person associated with the company.
312
+ */
313
+ export interface CompanyPerson {
314
+ /**
315
+ * Display name.
316
+ */
317
+ name: string;
318
+ /**
319
+ * Optional source identifier retained for reconciliation.
320
+ */
321
+ external_id?: string | null;
322
+ /**
323
+ * One or more curated company roles.
324
+ */
325
+ roles?: Array<CompanyPersonRole>;
175
326
  }
176
- export interface PrivateMarketGetSpvByIDParams {
327
+ /**
328
+ * A key person's relationship to the company.
329
+ */
330
+ export type CompanyPersonRole = 'FOUNDER' | 'CEO' | 'OTHER';
331
+ /**
332
+ * The complete versioned company profile (schema version one).
333
+ */
334
+ export interface CompanyProfileResource {
177
335
  /**
178
- * Account whose account-holder entity must hold an accreditation attestation to
179
- * browse private-market offerings.
336
+ * Company categories.
180
337
  */
181
- account_id: number;
338
+ categories?: Array<CompanyCategory>;
339
+ /**
340
+ * Sources referenced by narrative sections and metrics.
341
+ */
342
+ citations?: Array<CompanyCitation>;
343
+ /**
344
+ * Named customers evidenced by the source material.
345
+ */
346
+ customers?: Array<CompanyCustomer>;
347
+ /**
348
+ * Company-level research and source documents.
349
+ */
350
+ documents?: Array<CompanyDocumentResource>;
351
+ /**
352
+ * Company headquarters, when known.
353
+ */
354
+ headquarters?: CompanyHeadquarters | null;
355
+ /**
356
+ * Known legal entities associated with the company.
357
+ */
358
+ legal_entities?: Array<CompanyLegalEntity>;
359
+ /**
360
+ * Historical and estimated metric series.
361
+ */
362
+ metric_series?: Array<CompanyMetricSeries>;
363
+ /**
364
+ * Ordered durable company fact and thesis blocks.
365
+ */
366
+ narrative_sections?: Array<CompanyNarrativeSection>;
367
+ /**
368
+ * Long company overview.
369
+ */
370
+ overview?: string | null;
371
+ /**
372
+ * Key people and their roles.
373
+ */
374
+ people?: Array<CompanyPerson>;
375
+ /**
376
+ * Social/profile links.
377
+ */
378
+ social?: Array<CompanySocialLink>;
379
+ /**
380
+ * Short durable positioning line used with the company name.
381
+ */
382
+ tagline?: string | null;
182
383
  }
183
- export interface PrivateMarketUpdateIoiParams {
384
+ /**
385
+ * A company social/profile link.
386
+ */
387
+ export interface CompanySocialLink {
184
388
  /**
185
- * Query param
389
+ * Link type.
186
390
  */
187
- account_id: number;
391
+ type: CompanySocialType;
392
+ /**
393
+ * Link URL.
394
+ */
395
+ url: string;
396
+ }
397
+ /**
398
+ * Kind of company social/profile link.
399
+ */
400
+ export type CompanySocialType = 'WEBSITE' | 'LINKEDIN' | 'X' | 'FACEBOOK' | 'OTHER';
401
+ /**
402
+ * Fee timing/cadence.
403
+ */
404
+ export type FeeFrequency = 'ONE_TIME' | 'ANNUAL' | 'AT_EXIT' | 'PASS_THROUGH';
405
+ /**
406
+ * Kind of SPV fee.
407
+ */
408
+ export type FeeType = 'MANAGEMENT' | 'CARRY' | 'PLACEMENT' | 'ADMINISTRATIVE' | 'OTHER';
409
+ /**
410
+ * Observation cadence for a metric series.
411
+ */
412
+ export type MetricFrequency = 'YEAR' | 'QUARTER' | 'MONTH' | 'POINT_IN_TIME';
413
+ /**
414
+ * Canonical company metric key.
415
+ */
416
+ 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';
417
+ /**
418
+ * An OPEN SPV's identity, exact economics, and typed fee schedule.
419
+ */
420
+ export interface SpvDetail {
421
+ /**
422
+ * Stable SPV identifier.
423
+ */
424
+ id: string;
425
+ /**
426
+ * Company whose shares the vehicle holds.
427
+ */
428
+ company_id: string;
429
+ /**
430
+ * Terms currency.
431
+ */
432
+ currency: OfferingsAPI.Currency;
433
+ /**
434
+ * Legal/display name.
435
+ */
436
+ name: string;
437
+ /**
438
+ * Lifecycle state.
439
+ */
440
+ status: OfferingsAPI.SpvStatus;
441
+ /**
442
+ * Price per share including fees.
443
+ */
444
+ all_in_price_per_share?: string | null;
445
+ /**
446
+ * Custodian.
447
+ */
448
+ custodian_name?: string | null;
449
+ /**
450
+ * Per-share fee.
451
+ */
452
+ fee_per_share?: string | null;
453
+ /**
454
+ * Typed fee schedule.
455
+ */
456
+ fee_terms?: Array<SpvFeeTermResource>;
457
+ /**
458
+ * Percentage of dollar allocation funded, derived from the allocation pair.
459
+ */
460
+ funded_percent?: string | null;
461
+ /**
462
+ * Funding deadline.
463
+ */
464
+ funding_deadline?: string | null;
465
+ /**
466
+ * SPV manager.
467
+ */
468
+ manager_name?: string | null;
469
+ /**
470
+ * Minimum investment amount.
471
+ */
472
+ minimum_investment_amount?: string | null;
473
+ /**
474
+ * Time the vehicle opened.
475
+ */
476
+ opened_at?: string | null;
477
+ /**
478
+ * Price per share excluding fees.
479
+ */
480
+ price_per_share?: string | null;
481
+ /**
482
+ * Remaining dollar allocation.
483
+ */
484
+ remaining_allocation_amount?: string | null;
485
+ /**
486
+ * Remaining share allocation.
487
+ */
488
+ remaining_share_allocation?: string | null;
489
+ /**
490
+ * Underlying share class, when specified.
491
+ */
492
+ share_class?: string | null;
493
+ /**
494
+ * Plain-text vehicle structure.
495
+ */
496
+ structure_description?: string | null;
497
+ /**
498
+ * Total dollar allocation.
499
+ */
500
+ total_allocation_amount?: string | null;
188
501
  /**
189
- * Body param
502
+ * Total share allocation.
190
503
  */
191
- notional_amount: string;
504
+ total_share_allocation?: string | null;
192
505
  /**
193
- * Body param: Required when the SPV's current NDA version is newer than the IOI's
194
- * latest acceptance. Irrelevant acceptances are rejected.
506
+ * Exact company valuation.
195
507
  */
196
- nda_acceptance?: PrivateMarketUpdateIoiParams.NdaAcceptance | null;
508
+ valuation?: string | null;
509
+ /**
510
+ * Meaning of `valuation`.
511
+ */
512
+ valuation_basis?: OfferingsAPI.ValuationBasis | null;
197
513
  }
198
- export declare namespace PrivateMarketUpdateIoiParams {
514
+ /**
515
+ * One typed SPV fee term.
516
+ */
517
+ export interface SpvFeeTermResource {
199
518
  /**
200
- * Required when the SPV's current NDA version is newer than the IOI's latest
201
- * acceptance. Irrelevant acceptances are rejected.
519
+ * Charging party.
202
520
  */
203
- interface NdaAcceptance {
204
- /**
205
- * Must be true; confirms affirmative assent.
206
- */
207
- accepted: boolean;
208
- /**
209
- * Exact agreement id returned by offering detail.
210
- */
211
- agreement_id: string;
212
- /**
213
- * Must be true; confirms the signer may bind the account-holder entity.
214
- */
215
- authority_confirmed: boolean;
216
- }
521
+ charged_by: ChargedBy;
522
+ /**
523
+ * Terms currency.
524
+ */
525
+ currency: OfferingsAPI.Currency;
526
+ /**
527
+ * Plain-text fee disclosure.
528
+ */
529
+ description: string;
530
+ /**
531
+ * Fee kind.
532
+ */
533
+ fee_type: FeeType;
534
+ /**
535
+ * Timing/cadence.
536
+ */
537
+ frequency: FeeFrequency;
538
+ /**
539
+ * Exact fixed amount, when amount-based.
540
+ */
541
+ amount?: string | null;
542
+ /**
543
+ * Charge duration in years, when specified.
544
+ */
545
+ duration_years?: string | null;
546
+ /**
547
+ * Carry hurdle as a decimal fraction, when specified.
548
+ */
549
+ hurdle_rate?: string | null;
550
+ /**
551
+ * Decimal fraction between zero and one, when percentage-based.
552
+ */
553
+ rate?: string | null;
554
+ }
555
+ export interface PrivateMarketGetCompanyByIDResponse extends Shared.BaseResponse {
556
+ /**
557
+ * A company's identity and its complete published profile.
558
+ */
559
+ data: CompanyDetail;
560
+ }
561
+ export interface PrivateMarketGetSpvByIDResponse extends Shared.BaseResponse {
562
+ /**
563
+ * An OPEN SPV's identity, exact economics, and typed fee schedule.
564
+ */
565
+ data: SpvDetail;
566
+ }
567
+ export interface PrivateMarketGetCompanyByIDParams {
568
+ /**
569
+ * Account whose account-holder entity must hold an accreditation attestation to
570
+ * browse private-market offerings.
571
+ */
572
+ account_id: number;
573
+ }
574
+ export interface PrivateMarketGetSpvByIDParams {
575
+ /**
576
+ * Account whose account-holder entity must hold an accreditation attestation to
577
+ * browse private-market offerings.
578
+ */
579
+ account_id: number;
217
580
  }
218
581
  export declare namespace PrivateMarkets {
219
- export { type PrivateMarketCreateIoiResponse as PrivateMarketCreateIoiResponse, type PrivateMarketGetCompanyByIDResponse as PrivateMarketGetCompanyByIDResponse, type PrivateMarketGetIoisResponse as PrivateMarketGetIoisResponse, type PrivateMarketGetSpvByIDResponse as PrivateMarketGetSpvByIDResponse, type PrivateMarketUpdateIoiResponse as PrivateMarketUpdateIoiResponse, type PrivateMarketCreateIoiParams as PrivateMarketCreateIoiParams, type PrivateMarketDeleteIoiParams as PrivateMarketDeleteIoiParams, type PrivateMarketGetCompanyByIDParams as PrivateMarketGetCompanyByIDParams, type PrivateMarketGetIoisParams as PrivateMarketGetIoisParams, type PrivateMarketGetSpvByIDParams as PrivateMarketGetSpvByIDParams, type PrivateMarketUpdateIoiParams as PrivateMarketUpdateIoiParams, };
220
- export { Companies as Companies, 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, };
221
- export { Iois as Iois, type IoiCompanyResource as IoiCompanyResource, type IoiListingResource as IoiListingResource, type IoiListingResourceList as IoiListingResourceList, type IoiOfferingResource as IoiOfferingResource, type IoiResource as IoiResource, type NdaAcceptanceResource as NdaAcceptanceResource, };
582
+ export { type ChargedBy as ChargedBy, 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 FeeFrequency as FeeFrequency, type FeeType as FeeType, type MetricFrequency as MetricFrequency, type MetricKey as MetricKey, type SpvDetail as SpvDetail, type SpvFeeTermResource as SpvFeeTermResource, type PrivateMarketGetCompanyByIDResponse as PrivateMarketGetCompanyByIDResponse, type PrivateMarketGetSpvByIDResponse as PrivateMarketGetSpvByIDResponse, type PrivateMarketGetCompanyByIDParams as PrivateMarketGetCompanyByIDParams, type PrivateMarketGetSpvByIDParams as PrivateMarketGetSpvByIDParams, };
583
+ export { Iois as Iois, type IoiCompanyResource as IoiCompanyResource, type IoiListingResource as IoiListingResource, type IoiListingResourceList as IoiListingResourceList, type IoiOfferingResource as IoiOfferingResource, type IoiResource as IoiResource, type NdaAcceptanceResource as NdaAcceptanceResource, type IoisCreateIoiResponse as IoisCreateIoiResponse, type IoisGetIoisResponse as IoisGetIoisResponse, type IoisUpdateIoiResponse as IoisUpdateIoiResponse, type IoisCreateIoiParams as IoisCreateIoiParams, type IoisDeleteIoiParams as IoisDeleteIoiParams, type IoisGetIoisParams as IoisGetIoisParams, type IoisUpdateIoiParams as IoisUpdateIoiParams, };
222
584
  export { Offerings as Offerings, type Currency as Currency, type MetricUnit as MetricUnit, type MetricValueType as MetricValueType, type NdaAgreementResource as NdaAgreementResource, type OfferingCard as OfferingCard, type OfferingCardList as OfferingCardList, type OfferingClass as OfferingClass, type OfferingCompany as OfferingCompany, type OfferingDetail as OfferingDetail, type OfferingDocumentResource as OfferingDocumentResource, type OfferingDocumentType as OfferingDocumentType, type OfferingHighlight as OfferingHighlight, type OfferingKeyRisk as OfferingKeyRisk, type OfferingParticipantResource as OfferingParticipantResource, type OfferingSpv as OfferingSpv, type ParticipantRole as ParticipantRole, type SpvStatus as SpvStatus, type ValuationBasis as ValuationBasis, type OfferingGetOfferingByIDResponse as OfferingGetOfferingByIDResponse, type OfferingGetOfferingsResponse as OfferingGetOfferingsResponse, type OfferingGetOfferingByIDParams as OfferingGetOfferingByIDParams, type OfferingGetOfferingsParams as OfferingGetOfferingsParams, };
223
- export { Spvs as Spvs, type ChargedBy as ChargedBy, type FeeFrequency as FeeFrequency, type FeeType as FeeType, type SpvDetail as SpvDetail, type SpvFeeTermResource as SpvFeeTermResource, };
224
585
  }
225
586
  //# sourceMappingURL=private-markets.d.mts.map