@open-captable-protocol/canton 0.2.118 → 0.2.120

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 (96) hide show
  1. package/dist/functions/OpenCapTable/convertibleCancellation/createConvertibleCancellation.d.ts +2 -2
  2. package/dist/functions/OpenCapTable/convertibleCancellation/createConvertibleCancellation.d.ts.map +1 -1
  3. package/dist/functions/OpenCapTable/convertibleCancellation/createConvertibleCancellation.js.map +1 -1
  4. package/dist/functions/OpenCapTable/document/createDocument.d.ts +2 -2
  5. package/dist/functions/OpenCapTable/document/createDocument.d.ts.map +1 -1
  6. package/dist/functions/OpenCapTable/document/createDocument.js.map +1 -1
  7. package/dist/functions/OpenCapTable/document/getDocumentAsOcf.d.ts +2 -2
  8. package/dist/functions/OpenCapTable/document/getDocumentAsOcf.d.ts.map +1 -1
  9. package/dist/functions/OpenCapTable/equityCompensationCancellation/createEquityCompensationCancellation.d.ts +2 -2
  10. package/dist/functions/OpenCapTable/equityCompensationCancellation/createEquityCompensationCancellation.d.ts.map +1 -1
  11. package/dist/functions/OpenCapTable/equityCompensationCancellation/createEquityCompensationCancellation.js.map +1 -1
  12. package/dist/functions/OpenCapTable/equityCompensationExercise/createEquityCompensationExercise.d.ts +2 -2
  13. package/dist/functions/OpenCapTable/equityCompensationExercise/createEquityCompensationExercise.d.ts.map +1 -1
  14. package/dist/functions/OpenCapTable/equityCompensationExercise/createEquityCompensationExercise.js.map +1 -1
  15. package/dist/functions/OpenCapTable/equityCompensationExercise/getEquityCompensationExerciseEventAsOcf.d.ts +3 -2
  16. package/dist/functions/OpenCapTable/equityCompensationExercise/getEquityCompensationExerciseEventAsOcf.d.ts.map +1 -1
  17. package/dist/functions/OpenCapTable/equityCompensationExercise/getEquityCompensationExerciseEventAsOcf.js.map +1 -1
  18. package/dist/functions/OpenCapTable/equityCompensationIssuance/createEquityCompensationIssuance.d.ts +2 -2
  19. package/dist/functions/OpenCapTable/equityCompensationIssuance/createEquityCompensationIssuance.d.ts.map +1 -1
  20. package/dist/functions/OpenCapTable/issuer/createIssuer.d.ts +2 -2
  21. package/dist/functions/OpenCapTable/issuer/createIssuer.d.ts.map +1 -1
  22. package/dist/functions/OpenCapTable/issuer/createIssuer.js.map +1 -1
  23. package/dist/functions/OpenCapTable/issuer/getIssuerAsOcf.d.ts +3 -2
  24. package/dist/functions/OpenCapTable/issuer/getIssuerAsOcf.d.ts.map +1 -1
  25. package/dist/functions/OpenCapTable/issuer/getIssuerAsOcf.js.map +1 -1
  26. package/dist/functions/OpenCapTable/issuerAuthorizedSharesAdjustment/createIssuerAuthorizedSharesAdjustment.d.ts +2 -2
  27. package/dist/functions/OpenCapTable/issuerAuthorizedSharesAdjustment/createIssuerAuthorizedSharesAdjustment.d.ts.map +1 -1
  28. package/dist/functions/OpenCapTable/issuerAuthorizedSharesAdjustment/createIssuerAuthorizedSharesAdjustment.js.map +1 -1
  29. package/dist/functions/OpenCapTable/stakeholder/addStakeholder.d.ts +3 -3
  30. package/dist/functions/OpenCapTable/stakeholder/addStakeholder.d.ts.map +1 -1
  31. package/dist/functions/OpenCapTable/stakeholder/addStakeholder.js.map +1 -1
  32. package/dist/functions/OpenCapTable/stakeholder/editStakeholder.d.ts +2 -2
  33. package/dist/functions/OpenCapTable/stakeholder/editStakeholder.d.ts.map +1 -1
  34. package/dist/functions/OpenCapTable/stakeholder/getStakeholderAsOcf.d.ts +3 -2
  35. package/dist/functions/OpenCapTable/stakeholder/getStakeholderAsOcf.d.ts.map +1 -1
  36. package/dist/functions/OpenCapTable/stakeholder/getStakeholderAsOcf.js +2 -2
  37. package/dist/functions/OpenCapTable/stakeholder/getStakeholderAsOcf.js.map +1 -1
  38. package/dist/functions/OpenCapTable/stockCancellation/createStockCancellation.d.ts +2 -2
  39. package/dist/functions/OpenCapTable/stockCancellation/createStockCancellation.d.ts.map +1 -1
  40. package/dist/functions/OpenCapTable/stockCancellation/createStockCancellation.js.map +1 -1
  41. package/dist/functions/OpenCapTable/stockClass/addStockClass.d.ts +2 -2
  42. package/dist/functions/OpenCapTable/stockClass/addStockClass.d.ts.map +1 -1
  43. package/dist/functions/OpenCapTable/stockClass/editStockClass.d.ts +2 -2
  44. package/dist/functions/OpenCapTable/stockClass/editStockClass.d.ts.map +1 -1
  45. package/dist/functions/OpenCapTable/stockClass/getStockClassAsOcf.d.ts +3 -2
  46. package/dist/functions/OpenCapTable/stockClass/getStockClassAsOcf.d.ts.map +1 -1
  47. package/dist/functions/OpenCapTable/stockClass/getStockClassAsOcf.js +3 -2
  48. package/dist/functions/OpenCapTable/stockClass/getStockClassAsOcf.js.map +1 -1
  49. package/dist/functions/OpenCapTable/stockClass/stockClassDataToDaml.d.ts +2 -2
  50. package/dist/functions/OpenCapTable/stockClass/stockClassDataToDaml.d.ts.map +1 -1
  51. package/dist/functions/OpenCapTable/stockClass/stockClassDataToDaml.js.map +1 -1
  52. package/dist/functions/OpenCapTable/stockClassAuthorizedSharesAdjustment/createStockClassAuthorizedSharesAdjustment.d.ts +2 -2
  53. package/dist/functions/OpenCapTable/stockClassAuthorizedSharesAdjustment/createStockClassAuthorizedSharesAdjustment.d.ts.map +1 -1
  54. package/dist/functions/OpenCapTable/stockClassAuthorizedSharesAdjustment/createStockClassAuthorizedSharesAdjustment.js.map +1 -1
  55. package/dist/functions/OpenCapTable/stockIssuance/createStockIssuance.d.ts +2 -2
  56. package/dist/functions/OpenCapTable/stockIssuance/createStockIssuance.d.ts.map +1 -1
  57. package/dist/functions/OpenCapTable/stockIssuance/createStockIssuance.js.map +1 -1
  58. package/dist/functions/OpenCapTable/stockIssuance/getStockIssuanceAsOcf.d.ts +2 -2
  59. package/dist/functions/OpenCapTable/stockIssuance/getStockIssuanceAsOcf.d.ts.map +1 -1
  60. package/dist/functions/OpenCapTable/stockLegendTemplate/createStockLegendTemplate.d.ts +2 -2
  61. package/dist/functions/OpenCapTable/stockLegendTemplate/createStockLegendTemplate.d.ts.map +1 -1
  62. package/dist/functions/OpenCapTable/stockLegendTemplate/createStockLegendTemplate.js.map +1 -1
  63. package/dist/functions/OpenCapTable/stockLegendTemplate/getStockLegendTemplateAsOcf.d.ts +3 -2
  64. package/dist/functions/OpenCapTable/stockLegendTemplate/getStockLegendTemplateAsOcf.d.ts.map +1 -1
  65. package/dist/functions/OpenCapTable/stockLegendTemplate/getStockLegendTemplateAsOcf.js.map +1 -1
  66. package/dist/functions/OpenCapTable/stockPlan/createStockPlan.d.ts +2 -2
  67. package/dist/functions/OpenCapTable/stockPlan/createStockPlan.d.ts.map +1 -1
  68. package/dist/functions/OpenCapTable/stockPlan/createStockPlan.js.map +1 -1
  69. package/dist/functions/OpenCapTable/stockPlan/getStockPlanAsOcf.d.ts +4 -2
  70. package/dist/functions/OpenCapTable/stockPlan/getStockPlanAsOcf.d.ts.map +1 -1
  71. package/dist/functions/OpenCapTable/stockPlan/getStockPlanAsOcf.js.map +1 -1
  72. package/dist/functions/OpenCapTable/stockPlanPoolAdjustment/createStockPlanPoolAdjustment.d.ts +2 -2
  73. package/dist/functions/OpenCapTable/stockPlanPoolAdjustment/createStockPlanPoolAdjustment.d.ts.map +1 -1
  74. package/dist/functions/OpenCapTable/stockPlanPoolAdjustment/createStockPlanPoolAdjustment.js.map +1 -1
  75. package/dist/functions/OpenCapTable/stockRepurchase/createStockRepurchase.d.ts +3 -3
  76. package/dist/functions/OpenCapTable/stockRepurchase/createStockRepurchase.d.ts.map +1 -1
  77. package/dist/functions/OpenCapTable/stockRepurchase/createStockRepurchase.js.map +1 -1
  78. package/dist/functions/OpenCapTable/stockRepurchase/getStockRepurchaseAsOcf.d.ts +2 -2
  79. package/dist/functions/OpenCapTable/stockRepurchase/getStockRepurchaseAsOcf.d.ts.map +1 -1
  80. package/dist/functions/OpenCapTable/stockTransfer/createStockTransfer.d.ts +2 -2
  81. package/dist/functions/OpenCapTable/stockTransfer/createStockTransfer.d.ts.map +1 -1
  82. package/dist/functions/OpenCapTable/stockTransfer/createStockTransfer.js.map +1 -1
  83. package/dist/functions/OpenCapTable/stockTransfer/getStockTransferAsOcf.d.ts +2 -2
  84. package/dist/functions/OpenCapTable/stockTransfer/getStockTransferAsOcf.d.ts.map +1 -1
  85. package/dist/functions/OpenCapTable/vestingTerms/createVestingTerms.d.ts +2 -2
  86. package/dist/functions/OpenCapTable/vestingTerms/createVestingTerms.d.ts.map +1 -1
  87. package/dist/functions/OpenCapTable/vestingTerms/createVestingTerms.js.map +1 -1
  88. package/dist/functions/OpenCapTable/vestingTerms/getVestingTermsAsOcf.d.ts +3 -2
  89. package/dist/functions/OpenCapTable/vestingTerms/getVestingTermsAsOcf.d.ts.map +1 -1
  90. package/dist/functions/OpenCapTable/vestingTerms/getVestingTermsAsOcf.js.map +1 -1
  91. package/dist/functions/OpenCapTable/warrantCancellation/createWarrantCancellation.d.ts +2 -2
  92. package/dist/functions/OpenCapTable/warrantCancellation/createWarrantCancellation.d.ts.map +1 -1
  93. package/dist/functions/OpenCapTable/warrantCancellation/createWarrantCancellation.js.map +1 -1
  94. package/dist/types/native.d.ts +893 -28
  95. package/dist/types/native.d.ts.map +1 -1
  96. package/package.json +1 -1
@@ -54,6 +54,256 @@ export type ConversionMechanism = 'RATIO_CONVERSION' | 'PERCENT_CONVERSION' | 'F
54
54
  * https://raw.githubusercontent.com/Open-Cap-Table-Coalition/Open-Cap-Format-OCF/main/schema/enums/ConversionTriggerType.schema.json
55
55
  */
56
56
  export type ConversionTrigger = 'AUTOMATIC_ON_CONDITION' | 'AUTOMATIC_ON_DATE' | 'ELECTIVE_ON_CONDITION' | 'ELECTIVE_ON_DATE' | 'ELECTIVE_AT_WILL';
57
+ /**
58
+ * Extended Conversion Trigger Type for Warrants and Convertibles Includes additional trigger types used by these
59
+ * instruments
60
+ */
61
+ export type ConversionTriggerType = 'AUTOMATIC_ON_CONDITION' | 'AUTOMATIC_ON_DATE' | 'ELECTIVE_IN_RANGE' | 'ELECTIVE_ON_CONDITION' | 'ELECTIVE_AT_WILL' | 'UNSPECIFIED';
62
+ /** Type - Capitalization Definition Rules Rules for how capitalization is calculated for conversion purposes */
63
+ export interface CapitalizationDefinitionRules {
64
+ /** Include outstanding shares in capitalization calculation */
65
+ include_outstanding_shares?: boolean;
66
+ /** Include outstanding options in capitalization calculation */
67
+ include_outstanding_options?: boolean;
68
+ /** Include outstanding unissued options in capitalization calculation */
69
+ include_outstanding_unissued_options?: boolean;
70
+ /** Include this security in capitalization calculation */
71
+ include_this_security?: boolean;
72
+ /** Include other converting securities in capitalization calculation */
73
+ include_other_converting_securities?: boolean;
74
+ /** Include option pool top-up for promised options */
75
+ include_option_pool_topup_for_promised_options?: boolean;
76
+ /** Include additional option pool top-up */
77
+ include_additional_option_pool_topup?: boolean;
78
+ /** Include new money in capitalization calculation */
79
+ include_new_money?: boolean;
80
+ }
81
+ /** Warrant Conversion Mechanism - Custom Custom conversion description for non-standard warrant conversions */
82
+ export interface WarrantMechanismCustom {
83
+ type: 'CUSTOM_CONVERSION';
84
+ /** Description of custom conversion mechanism */
85
+ custom_conversion_description: string;
86
+ }
87
+ /** Warrant Conversion Mechanism - Fixed Percent of Capitalization Converts to a fixed percentage of capitalization */
88
+ export interface WarrantMechanismPercentCapitalization {
89
+ type: 'FIXED_PERCENT_OF_CAPITALIZATION_CONVERSION';
90
+ /** Percentage of capitalization to convert to (as decimal string, e.g., "0.05" for 5%) */
91
+ converts_to_percent: string;
92
+ /** Description of capitalization definition */
93
+ capitalization_definition?: string;
94
+ /** Rules for capitalization calculation */
95
+ capitalization_definition_rules?: CapitalizationDefinitionRules;
96
+ }
97
+ /** Warrant Conversion Mechanism - Fixed Amount Converts to a fixed quantity of shares */
98
+ export interface WarrantMechanismFixedAmount {
99
+ type: 'FIXED_AMOUNT_CONVERSION';
100
+ /** Fixed quantity of shares to convert to */
101
+ converts_to_quantity: string;
102
+ }
103
+ /** Warrant Conversion Mechanism - Valuation Based Conversion based on company valuation */
104
+ export interface WarrantMechanismValuationBased {
105
+ type: 'VALUATION_BASED_CONVERSION';
106
+ /** Type of valuation (e.g., "409A", "FMV") */
107
+ valuation_type?: string;
108
+ /** Valuation amount */
109
+ valuation_amount?: {
110
+ amount: string;
111
+ currency: string;
112
+ };
113
+ /** Description of capitalization definition */
114
+ capitalization_definition?: string;
115
+ /** Rules for capitalization calculation */
116
+ capitalization_definition_rules?: CapitalizationDefinitionRules;
117
+ }
118
+ /** Warrant Conversion Mechanism - Share Price Based Conversion based on share price with optional discount */
119
+ export interface WarrantMechanismSharePriceBased {
120
+ type: 'SHARE_PRICE_BASED_CONVERSION';
121
+ /** Description of the share price basis */
122
+ description?: string;
123
+ /** Whether a discount applies */
124
+ discount: boolean;
125
+ /** Discount percentage (as decimal string, e.g., "0.20" for 20%) */
126
+ discount_percentage?: string;
127
+ /** Fixed discount amount */
128
+ discount_amount?: {
129
+ amount: string;
130
+ currency: string;
131
+ };
132
+ }
133
+ /** Union type for all Warrant Conversion Mechanisms */
134
+ export type WarrantConversionMechanism = WarrantMechanismCustom | WarrantMechanismPercentCapitalization | WarrantMechanismFixedAmount | WarrantMechanismValuationBased | WarrantMechanismSharePriceBased;
135
+ /** Warrant Conversion Right Describes the conversion rights associated with a warrant */
136
+ export interface WarrantConversionRight {
137
+ type: 'WARRANT_CONVERSION_RIGHT';
138
+ /** Mechanism by which conversion occurs */
139
+ conversion_mechanism: WarrantConversionMechanism;
140
+ /** Whether this converts to a future financing round */
141
+ converts_to_future_round?: boolean;
142
+ /** Stock class ID to convert to (if not future round) */
143
+ converts_to_stock_class_id?: string;
144
+ }
145
+ /** Warrant Exercise Trigger Describes when and how a warrant can be exercised */
146
+ export interface WarrantExerciseTrigger {
147
+ /** Type of trigger */
148
+ type: ConversionTriggerType;
149
+ /** Unique identifier for this trigger */
150
+ trigger_id: string;
151
+ /** Conversion right associated with this trigger */
152
+ conversion_right: WarrantConversionRight;
153
+ /** Human-readable nickname for the trigger */
154
+ nickname?: string;
155
+ /** Description of trigger conditions */
156
+ trigger_description?: string;
157
+ /** Date when trigger becomes active (YYYY-MM-DD) */
158
+ trigger_date?: string;
159
+ /** Condition that activates the trigger */
160
+ trigger_condition?: string;
161
+ }
162
+ /** Convertible Conversion Mechanism - Custom Custom conversion description for non-standard conversions */
163
+ export interface ConvertibleMechanismCustom {
164
+ type: 'CUSTOM_CONVERSION';
165
+ /** Description of custom conversion mechanism */
166
+ custom_conversion_description?: string;
167
+ }
168
+ /** Exit Multiple Ratio Represents a multiplier as a fraction */
169
+ export interface ExitMultiple {
170
+ numerator: string;
171
+ denominator: string;
172
+ }
173
+ /** Convertible Conversion Mechanism - SAFE Conversion terms for Simple Agreement for Future Equity */
174
+ export interface ConvertibleMechanismSafe {
175
+ type: 'SAFE_CONVERSION';
176
+ /** Whether Most Favored Nation clause applies */
177
+ conversion_mfn: boolean;
178
+ /** Discount on conversion (as decimal string, e.g., "0.20" for 20%) */
179
+ conversion_discount?: string;
180
+ /** Valuation cap for conversion */
181
+ conversion_valuation_cap?: {
182
+ amount: string;
183
+ currency: string;
184
+ };
185
+ /** Timing of conversion relative to financing */
186
+ conversion_timing?: 'PRE_MONEY' | 'POST_MONEY';
187
+ /** Description of capitalization definition */
188
+ capitalization_definition?: string;
189
+ /** Rules for capitalization calculation */
190
+ capitalization_definition_rules?: CapitalizationDefinitionRules;
191
+ /** Exit multiple for liquidity events */
192
+ exit_multiple?: ExitMultiple;
193
+ }
194
+ /** Convertible Conversion Mechanism - Fixed Percent of Capitalization */
195
+ export interface ConvertibleMechanismPercentCapitalization {
196
+ type: 'FIXED_PERCENT_OF_CAPITALIZATION_CONVERSION';
197
+ /** Percentage of capitalization to convert to */
198
+ converts_to_percent: string;
199
+ /** Description of capitalization definition */
200
+ capitalization_definition?: string;
201
+ /** Rules for capitalization calculation */
202
+ capitalization_definition_rules?: CapitalizationDefinitionRules;
203
+ }
204
+ /** Convertible Conversion Mechanism - Fixed Amount */
205
+ export interface ConvertibleMechanismFixedAmount {
206
+ type: 'FIXED_AMOUNT_CONVERSION';
207
+ /** Fixed quantity to convert to */
208
+ converts_to_quantity: string;
209
+ }
210
+ /** Convertible Conversion Mechanism - Valuation Based */
211
+ export interface ConvertibleMechanismValuationBased {
212
+ type: 'VALUATION_BASED_CONVERSION';
213
+ /** Type of valuation */
214
+ valuation_type?: string;
215
+ /** Valuation amount */
216
+ valuation_amount?: {
217
+ amount: string;
218
+ currency: string;
219
+ };
220
+ /** Description of capitalization definition */
221
+ capitalization_definition?: string;
222
+ /** Rules for capitalization calculation */
223
+ capitalization_definition_rules?: CapitalizationDefinitionRules;
224
+ }
225
+ /** Convertible Conversion Mechanism - Share Price Based */
226
+ export interface ConvertibleMechanismSharePriceBased {
227
+ type: 'SHARE_PRICE_BASED_CONVERSION';
228
+ /** Description of the share price basis */
229
+ description?: string;
230
+ /** Whether a discount applies */
231
+ discount: boolean;
232
+ /** Discount percentage */
233
+ discount_percentage?: string;
234
+ /** Fixed discount amount */
235
+ discount_amount?: {
236
+ amount: string;
237
+ currency: string;
238
+ };
239
+ }
240
+ /** Interest Rate entry for Convertible Notes */
241
+ export interface ConvertibleInterestRate {
242
+ /** Interest rate (as decimal string, e.g., "0.08" for 8%) */
243
+ rate: string;
244
+ /** Date interest starts accruing (YYYY-MM-DD) */
245
+ accrual_start_date: string;
246
+ /** Date interest stops accruing (YYYY-MM-DD) */
247
+ accrual_end_date?: string;
248
+ }
249
+ /** Convertible Conversion Mechanism - Convertible Note Full conversion terms for convertible promissory notes */
250
+ export interface ConvertibleMechanismNote {
251
+ type: 'CONVERTIBLE_NOTE_CONVERSION';
252
+ /** Interest rate schedule */
253
+ interest_rates: ConvertibleInterestRate[] | null;
254
+ /** Day count convention for interest calculation */
255
+ day_count_convention?: 'ACTUAL_365' | '30_360';
256
+ /** How interest is paid */
257
+ interest_payout?: 'DEFERRED' | 'CASH';
258
+ /** Interest accrual period */
259
+ interest_accrual_period?: 'DAILY' | 'MONTHLY' | 'QUARTERLY' | 'SEMI_ANNUAL' | 'ANNUAL';
260
+ /** Type of interest compounding */
261
+ compounding_type?: 'SIMPLE' | 'COMPOUNDING';
262
+ /** Discount on conversion */
263
+ conversion_discount?: string;
264
+ /** Valuation cap for conversion */
265
+ conversion_valuation_cap?: {
266
+ amount: string;
267
+ currency: string;
268
+ };
269
+ /** Description of capitalization definition */
270
+ capitalization_definition?: string;
271
+ /** Rules for capitalization calculation */
272
+ capitalization_definition_rules?: CapitalizationDefinitionRules;
273
+ /** Exit multiple for liquidity events */
274
+ exit_multiple?: ExitMultiple | null;
275
+ /** Whether Most Favored Nation clause applies */
276
+ conversion_mfn?: boolean;
277
+ }
278
+ /** Union type for all Convertible Conversion Mechanisms */
279
+ export type ConvertibleConversionMechanism = ConvertibleMechanismCustom | ConvertibleMechanismSafe | ConvertibleMechanismPercentCapitalization | ConvertibleMechanismFixedAmount | ConvertibleMechanismValuationBased | ConvertibleMechanismSharePriceBased | ConvertibleMechanismNote;
280
+ /** Convertible Conversion Right Describes the conversion rights associated with a convertible instrument */
281
+ export interface ConvertibleConversionRight {
282
+ type: 'CONVERTIBLE_CONVERSION_RIGHT';
283
+ /** Mechanism by which conversion occurs */
284
+ conversion_mechanism: ConvertibleConversionMechanism;
285
+ /** Whether this converts to a future financing round */
286
+ converts_to_future_round?: boolean;
287
+ /** Stock class ID to convert to (if not future round) */
288
+ converts_to_stock_class_id?: string;
289
+ }
290
+ /** Convertible Conversion Trigger Describes when and how a convertible instrument can convert */
291
+ export interface ConvertibleConversionTrigger {
292
+ /** Type of trigger */
293
+ type: ConversionTriggerType;
294
+ /** Unique identifier for this trigger */
295
+ trigger_id: string;
296
+ /** Conversion right associated with this trigger */
297
+ conversion_right: ConvertibleConversionRight;
298
+ /** Human-readable nickname for the trigger */
299
+ nickname?: string;
300
+ /** Description of trigger conditions */
301
+ trigger_description?: string;
302
+ /** Date when trigger becomes active (YYYY-MM-DD) */
303
+ trigger_date?: string;
304
+ /** Condition that activates the trigger */
305
+ trigger_condition?: string;
306
+ }
57
307
  /**
58
308
  * Enum - Rounding Type Rounding method for numeric values OCF:
59
309
  * https://raw.githubusercontent.com/Open-Cap-Table-Coalition/Open-Cap-Format-OCF/main/schema/enums/RoundingType.schema.json
@@ -159,7 +409,7 @@ export interface StockClassConversionRight {
159
409
  * Object - Issuer Object describing the issuer of the cap table (the company whose cap table this is). OCF:
160
410
  * https://raw.githubusercontent.com/Open-Cap-Table-Coalition/Open-Cap-Format-OCF/main/schema/objects/Issuer.schema.json
161
411
  */
162
- export interface IssuerOcfData {
412
+ export interface OcfIssuer {
163
413
  /** Identifier for the object */
164
414
  id: string;
165
415
  /** Legal name of the issuer */
@@ -191,7 +441,7 @@ export interface IssuerOcfData {
191
441
  * Object - Stock Class Object describing a class of stock issued by the issuer OCF:
192
442
  * https://raw.githubusercontent.com/Open-Cap-Table-Coalition/Open-Cap-Format-OCF/main/schema/objects/StockClass.schema.json
193
443
  */
194
- export interface StockClassOcfData {
444
+ export interface OcfStockClass {
195
445
  /** Identifier for the object */
196
446
  id: string;
197
447
  /** The type of this stock class (e.g. Preferred or Common) */
@@ -266,7 +516,7 @@ export interface ContactInfoWithoutName {
266
516
  * Object - Stakeholder Object describing a stakeholder in the issuer's cap table OCF:
267
517
  * https://raw.githubusercontent.com/Open-Cap-Table-Coalition/Open-Cap-Format-OCF/main/schema/objects/Stakeholder.schema.json
268
518
  */
269
- export interface OcfStakeholderData {
519
+ export interface OcfStakeholder {
270
520
  /** Identifier for the object */
271
521
  id: string;
272
522
  /** Stakeholder's name */
@@ -294,7 +544,7 @@ export interface OcfStakeholderData {
294
544
  * Object - Stock Legend Template Object describing a stock legend template OCF:
295
545
  * https://raw.githubusercontent.com/Open-Cap-Table-Coalition/Open-Cap-Format-OCF/main/schema/objects/StockLegendTemplate.schema.json
296
546
  */
297
- export interface StockLegendTemplateOcfData {
547
+ export interface OcfStockLegendTemplate {
298
548
  /** Identifier for the object */
299
549
  id: string;
300
550
  /** Name for the stock legend template */
@@ -318,7 +568,7 @@ export interface OcfObjectReference {
318
568
  * Object - Document Object describing a document OCF:
319
569
  * https://raw.githubusercontent.com/Open-Cap-Table-Coalition/Open-Cap-Format-OCF/main/schema/objects/Document.schema.json
320
570
  */
321
- export interface DocumentOcfData {
571
+ export interface OcfDocument {
322
572
  /** Identifier for the object */
323
573
  id: string;
324
574
  /** Relative file path to the document within the OCF bundle */
@@ -341,7 +591,7 @@ export type ValuationType = '409A';
341
591
  * Object - Valuation Object describing a valuation used in the cap table OCF:
342
592
  * https://raw.githubusercontent.com/Open-Cap-Table-Coalition/Open-Cap-Format-OCF/main/schema/objects/Valuation.schema.json
343
593
  */
344
- export interface OcfValuationData {
594
+ export interface OcfValuation {
345
595
  /** Identifier for the object */
346
596
  id: string;
347
597
  /** Identifier of the stock class for this valuation */
@@ -380,7 +630,7 @@ export interface VestingSimple {
380
630
  /** Number of shares, units, or amount vesting */
381
631
  amount: string | number;
382
632
  }
383
- export interface StockIssuanceOcfData {
633
+ export interface OcfStockIssuance {
384
634
  /** Identifier for the object */
385
635
  id: string;
386
636
  /** Date on which the transaction occurred */
@@ -487,7 +737,7 @@ export interface VestingCondition {
487
737
  * Object - Vesting Terms Object describing the terms under which a security vests OCF:
488
738
  * https://raw.githubusercontent.com/Open-Cap-Table-Coalition/Open-Cap-Format-OCF/main/schema/objects/VestingTerms.schema.json
489
739
  */
490
- export interface VestingTermsOcfData {
740
+ export interface OcfVestingTerms {
491
741
  id: string;
492
742
  /** Concise name for the vesting schedule */
493
743
  name: string;
@@ -501,7 +751,7 @@ export interface VestingTermsOcfData {
501
751
  comments?: string[];
502
752
  }
503
753
  export type StockPlanCancellationBehavior = 'RETIRE' | 'RETURN_TO_POOL' | 'HOLD_AS_CAPITAL_STOCK' | 'DEFINED_PER_PLAN_SECURITY';
504
- export interface StockPlanOcfData {
754
+ export interface OcfStockPlan {
505
755
  id: string;
506
756
  /** Human-friendly name of the plan */
507
757
  plan_name: string;
@@ -534,7 +784,7 @@ export interface TerminationWindow {
534
784
  /** Unit of time for the termination window */
535
785
  period_type: PeriodType;
536
786
  }
537
- export interface OcfEquityCompensationIssuanceData {
787
+ export interface OcfEquityCompensationIssuance {
538
788
  id: string;
539
789
  date: string;
540
790
  security_id: string;
@@ -574,7 +824,7 @@ export type SimpleTrigger = 'AUTOMATIC' | 'OPTIONAL';
574
824
  * transaction by the issuer and held by a stakeholder OCF:
575
825
  * https://raw.githubusercontent.com/Open-Cap-Table-Coalition/Open-Cap-Format-OCF/main/schema/objects/transactions/issuance/ConvertibleIssuance.schema.json
576
826
  */
577
- export interface OcfConvertibleIssuanceDataNative {
827
+ export interface OcfConvertibleIssuance {
578
828
  id: string;
579
829
  date: string;
580
830
  security_id: string;
@@ -591,8 +841,8 @@ export interface OcfConvertibleIssuanceDataNative {
591
841
  investment_amount: Monetary;
592
842
  /** What kind of convertible instrument is this (of the supported, enumerated types) */
593
843
  convertible_type: ConvertibleType;
594
- /** Convertible - Conversion Trigger Array (simplified) */
595
- conversion_triggers: unknown[];
844
+ /** Convertible - Conversion Trigger Array */
845
+ conversion_triggers: ConvertibleConversionTrigger[];
596
846
  /** If different convertible instruments have seniority over one another, use this value to build a seniority stack */
597
847
  seniority: number;
598
848
  /** What pro-rata (if any) is the holder entitled to buy at the next round? */
@@ -605,7 +855,7 @@ export interface OcfConvertibleIssuanceDataNative {
605
855
  * and held by a stakeholder OCF:
606
856
  * https://raw.githubusercontent.com/Open-Cap-Table-Coalition/Open-Cap-Format-OCF/main/schema/objects/transactions/issuance/WarrantIssuance.schema.json
607
857
  */
608
- export interface WarrantIssuanceOcfDataNative {
858
+ export interface OcfWarrantIssuance {
609
859
  id: string;
610
860
  date: string;
611
861
  security_id: string;
@@ -628,18 +878,18 @@ export interface WarrantIssuanceOcfDataNative {
628
878
  exercise_price?: Monetary;
629
879
  /** Actual purchase price of the warrant (sum up purported value of all consideration, including in-kind) */
630
880
  purchase_price: Monetary;
631
- /** Warrant Issuance - Exercise Trigger Array (complex nested type) */
632
- exercise_triggers: unknown[];
881
+ /** Warrant Issuance - Exercise Trigger Array */
882
+ exercise_triggers: WarrantExerciseTrigger[];
633
883
  /** What is expiration date of the warrant (if applicable) */
634
884
  warrant_expiration_date?: string;
635
885
  /** Identifier of the VestingTerms to which this security is subject */
636
886
  vesting_terms_id?: string;
637
- /** Conversion triggers (complex nested type) */
638
- conversion_triggers?: unknown[];
887
+ /** Conversion triggers for automatic warrant conversion */
888
+ conversion_triggers?: WarrantExerciseTrigger[];
639
889
  /** Unstructured text comments related to and stored for the object */
640
890
  comments?: string[];
641
891
  }
642
- export interface OcfStockCancellationTxData {
892
+ export interface OcfStockCancellation {
643
893
  id: string;
644
894
  date: string;
645
895
  security_id: string;
@@ -652,7 +902,7 @@ export interface OcfStockCancellationTxData {
652
902
  * Object - Warrant Cancellation Transaction Object describing a warrant cancellation transaction OCF:
653
903
  * https://raw.githubusercontent.com/Open-Cap-Table-Coalition/Open-Cap-Format-OCF/main/schema/objects/transactions/cancellation/WarrantCancellation.schema.json
654
904
  */
655
- export interface OcfWarrantCancellationTxData {
905
+ export interface OcfWarrantCancellation {
656
906
  /** Identifier for the object */
657
907
  id: string;
658
908
  /** Date on which the transaction occurred */
@@ -672,7 +922,7 @@ export interface OcfWarrantCancellationTxData {
672
922
  * Object - Convertible Cancellation Transaction Object describing a convertible cancellation transaction OCF:
673
923
  * https://raw.githubusercontent.com/Open-Cap-Table-Coalition/Open-Cap-Format-OCF/main/schema/objects/transactions/cancellation/ConvertibleCancellation.schema.json
674
924
  */
675
- export interface OcfConvertibleCancellationTxData {
925
+ export interface OcfConvertibleCancellation {
676
926
  /** Identifier for the object */
677
927
  id: string;
678
928
  /** Date on which the transaction occurred */
@@ -691,7 +941,7 @@ export interface OcfConvertibleCancellationTxData {
691
941
  * transaction OCF:
692
942
  * https://raw.githubusercontent.com/Open-Cap-Table-Coalition/Open-Cap-Format-OCF/main/schema/objects/transactions/cancellation/EquityCompensationCancellation.schema.json
693
943
  */
694
- export interface OcfEquityCompensationCancellationTxData {
944
+ export interface OcfEquityCompensationCancellation {
695
945
  /** Identifier for the object */
696
946
  id: string;
697
947
  /** Date on which the transaction occurred */
@@ -707,7 +957,7 @@ export interface OcfEquityCompensationCancellationTxData {
707
957
  /** Unstructured text comments related to and stored for the object */
708
958
  comments?: string[];
709
959
  }
710
- export interface OcfIssuerAuthorizedSharesAdjustmentTxData {
960
+ export interface OcfIssuerAuthorizedSharesAdjustment {
711
961
  id: string;
712
962
  date: string;
713
963
  issuer_id: string;
@@ -716,7 +966,7 @@ export interface OcfIssuerAuthorizedSharesAdjustmentTxData {
716
966
  stockholder_approval_date?: string;
717
967
  comments?: string[];
718
968
  }
719
- export interface OcfStockClassAuthorizedSharesAdjustmentTxData {
969
+ export interface OcfStockClassAuthorizedSharesAdjustment {
720
970
  id: string;
721
971
  date: string;
722
972
  stock_class_id: string;
@@ -725,7 +975,7 @@ export interface OcfStockClassAuthorizedSharesAdjustmentTxData {
725
975
  stockholder_approval_date?: string;
726
976
  comments?: string[];
727
977
  }
728
- export interface OcfStockPlanPoolAdjustmentTxData {
978
+ export interface OcfStockPlanPoolAdjustment {
729
979
  id: string;
730
980
  date: string;
731
981
  stock_plan_id: string;
@@ -734,7 +984,7 @@ export interface OcfStockPlanPoolAdjustmentTxData {
734
984
  shares_reserved: string | number;
735
985
  comments?: string[];
736
986
  }
737
- export interface OcfEquityCompensationExerciseTxData {
987
+ export interface OcfEquityCompensationExercise {
738
988
  id: string;
739
989
  date: string;
740
990
  security_id: string;
@@ -747,7 +997,7 @@ export interface OcfEquityCompensationExerciseTxData {
747
997
  * Object - Stock Transfer Transaction Object describing a transfer or secondary sale of a stock security OCF:
748
998
  * https://raw.githubusercontent.com/Open-Cap-Table-Coalition/Open-Cap-Format-OCF/main/schema/objects/transactions/transfer/StockTransfer.schema.json
749
999
  */
750
- export interface OcfStockTransferTxData {
1000
+ export interface OcfStockTransfer {
751
1001
  /** Identifier for the object */
752
1002
  id: string;
753
1003
  /** Date on which the transaction occurred */
@@ -769,7 +1019,7 @@ export interface OcfStockTransferTxData {
769
1019
  * Object - Stock Repurchase Transaction Object describing a stock repurchase transaction OCF:
770
1020
  * https://raw.githubusercontent.com/Open-Cap-Table-Coalition/Open-Cap-Format-OCF/main/schema/objects/transactions/repurchase/StockRepurchase.schema.json
771
1021
  */
772
- export interface OcfStockRepurchaseTxData {
1022
+ export interface OcfStockRepurchase {
773
1023
  /** Identifier for the object */
774
1024
  id: string;
775
1025
  /** Date on which the transaction occurred */
@@ -787,4 +1037,619 @@ export interface OcfStockRepurchaseTxData {
787
1037
  /** Unstructured text comments related to and stored for the object */
788
1038
  comments?: string[];
789
1039
  }
1040
+ /**
1041
+ * Object - Warrant Transfer Transaction Object describing a warrant transfer transaction OCF:
1042
+ * https://raw.githubusercontent.com/Open-Cap-Table-Coalition/Open-Cap-Format-OCF/main/schema/objects/transactions/transfer/WarrantTransfer.schema.json
1043
+ */
1044
+ export interface OcfWarrantTransfer {
1045
+ /** Identifier for the object */
1046
+ id: string;
1047
+ /** Date on which the transaction occurred */
1048
+ date: string;
1049
+ /** Identifier for the security being transferred */
1050
+ security_id: string;
1051
+ /** Quantity of warrants being transferred */
1052
+ quantity: string | number;
1053
+ /** Array of identifiers for new securities created as a result of the transfer (min 1 item) */
1054
+ resulting_security_ids: string[];
1055
+ /** Identifier for the security that holds the remainder balance (for partial transfers) */
1056
+ balance_security_id?: string;
1057
+ /** Unstructured text description of consideration provided in exchange for security transfer */
1058
+ consideration_text?: string;
1059
+ /** Unstructured text comments related to and stored for the object */
1060
+ comments?: string[];
1061
+ }
1062
+ /**
1063
+ * Object - Convertible Transfer Transaction Object describing a convertible transfer transaction OCF:
1064
+ * https://raw.githubusercontent.com/Open-Cap-Table-Coalition/Open-Cap-Format-OCF/main/schema/objects/transactions/transfer/ConvertibleTransfer.schema.json
1065
+ */
1066
+ export interface OcfConvertibleTransfer {
1067
+ /** Identifier for the object */
1068
+ id: string;
1069
+ /** Date on which the transaction occurred */
1070
+ date: string;
1071
+ /** Identifier for the security being transferred */
1072
+ security_id: string;
1073
+ /** Amount of convertible being transferred */
1074
+ amount: Monetary;
1075
+ /** Array of identifiers for new securities created as a result of the transfer (min 1 item) */
1076
+ resulting_security_ids: string[];
1077
+ /** Identifier for the security that holds the remainder balance (for partial transfers) */
1078
+ balance_security_id?: string;
1079
+ /** Unstructured text description of consideration provided in exchange for security transfer */
1080
+ consideration_text?: string;
1081
+ /** Unstructured text comments related to and stored for the object */
1082
+ comments?: string[];
1083
+ }
1084
+ /**
1085
+ * Object - Equity Compensation Transfer Transaction Object describing an equity compensation transfer transaction OCF:
1086
+ * https://raw.githubusercontent.com/Open-Cap-Table-Coalition/Open-Cap-Format-OCF/main/schema/objects/transactions/transfer/EquityCompensationTransfer.schema.json
1087
+ */
1088
+ export interface OcfEquityCompensationTransfer {
1089
+ /** Identifier for the object */
1090
+ id: string;
1091
+ /** Date on which the transaction occurred */
1092
+ date: string;
1093
+ /** Identifier for the security being transferred */
1094
+ security_id: string;
1095
+ /** Quantity of equity compensation being transferred */
1096
+ quantity: string | number;
1097
+ /** Array of identifiers for new securities created as a result of the transfer (min 1 item) */
1098
+ resulting_security_ids: string[];
1099
+ /** Identifier for the security that holds the remainder balance (for partial transfers) */
1100
+ balance_security_id?: string;
1101
+ /** Unstructured text description of consideration provided in exchange for security transfer */
1102
+ consideration_text?: string;
1103
+ /** Unstructured text comments related to and stored for the object */
1104
+ comments?: string[];
1105
+ }
1106
+ /**
1107
+ * Object - Stock Acceptance Transaction Object describing a stock acceptance transaction OCF:
1108
+ * https://raw.githubusercontent.com/Open-Cap-Table-Coalition/Open-Cap-Format-OCF/main/schema/objects/transactions/acceptance/StockAcceptance.schema.json
1109
+ */
1110
+ export interface OcfStockAcceptance {
1111
+ /** Identifier for the object */
1112
+ id: string;
1113
+ /** Date on which the transaction occurred */
1114
+ date: string;
1115
+ /** Identifier for the security being accepted */
1116
+ security_id: string;
1117
+ /** Unstructured text comments related to and stored for the object */
1118
+ comments?: string[];
1119
+ }
1120
+ /**
1121
+ * Object - Warrant Acceptance Transaction Object describing a warrant acceptance transaction OCF:
1122
+ * https://raw.githubusercontent.com/Open-Cap-Table-Coalition/Open-Cap-Format-OCF/main/schema/objects/transactions/acceptance/WarrantAcceptance.schema.json
1123
+ */
1124
+ export interface OcfWarrantAcceptance {
1125
+ /** Identifier for the object */
1126
+ id: string;
1127
+ /** Date on which the transaction occurred */
1128
+ date: string;
1129
+ /** Identifier for the security being accepted */
1130
+ security_id: string;
1131
+ /** Unstructured text comments related to and stored for the object */
1132
+ comments?: string[];
1133
+ }
1134
+ /**
1135
+ * Object - Convertible Acceptance Transaction Object describing a convertible acceptance transaction OCF:
1136
+ * https://raw.githubusercontent.com/Open-Cap-Table-Coalition/Open-Cap-Format-OCF/main/schema/objects/transactions/acceptance/ConvertibleAcceptance.schema.json
1137
+ */
1138
+ export interface OcfConvertibleAcceptance {
1139
+ /** Identifier for the object */
1140
+ id: string;
1141
+ /** Date on which the transaction occurred */
1142
+ date: string;
1143
+ /** Identifier for the security being accepted */
1144
+ security_id: string;
1145
+ /** Unstructured text comments related to and stored for the object */
1146
+ comments?: string[];
1147
+ }
1148
+ /**
1149
+ * Object - Equity Compensation Acceptance Transaction Object describing an equity compensation acceptance transaction
1150
+ * OCF:
1151
+ * https://raw.githubusercontent.com/Open-Cap-Table-Coalition/Open-Cap-Format-OCF/main/schema/objects/transactions/acceptance/EquityCompensationAcceptance.schema.json
1152
+ */
1153
+ export interface OcfEquityCompensationAcceptance {
1154
+ /** Identifier for the object */
1155
+ id: string;
1156
+ /** Date on which the transaction occurred */
1157
+ date: string;
1158
+ /** Identifier for the security being accepted */
1159
+ security_id: string;
1160
+ /** Unstructured text comments related to and stored for the object */
1161
+ comments?: string[];
1162
+ }
1163
+ /**
1164
+ * Object - Stock Retraction Transaction Object describing a stock retraction transaction OCF:
1165
+ * https://raw.githubusercontent.com/Open-Cap-Table-Coalition/Open-Cap-Format-OCF/main/schema/objects/transactions/retraction/StockRetraction.schema.json
1166
+ */
1167
+ export interface OcfStockRetraction {
1168
+ /** Identifier for the object */
1169
+ id: string;
1170
+ /** Date on which the transaction occurred */
1171
+ date: string;
1172
+ /** Identifier for the security being retracted */
1173
+ security_id: string;
1174
+ /** Reason for the retraction */
1175
+ reason_text: string;
1176
+ /** Unstructured text comments related to and stored for the object */
1177
+ comments?: string[];
1178
+ }
1179
+ /**
1180
+ * Object - Warrant Retraction Transaction Object describing a warrant retraction transaction OCF:
1181
+ * https://raw.githubusercontent.com/Open-Cap-Table-Coalition/Open-Cap-Format-OCF/main/schema/objects/transactions/retraction/WarrantRetraction.schema.json
1182
+ */
1183
+ export interface OcfWarrantRetraction {
1184
+ /** Identifier for the object */
1185
+ id: string;
1186
+ /** Date on which the transaction occurred */
1187
+ date: string;
1188
+ /** Identifier for the security being retracted */
1189
+ security_id: string;
1190
+ /** Reason for the retraction */
1191
+ reason_text: string;
1192
+ /** Unstructured text comments related to and stored for the object */
1193
+ comments?: string[];
1194
+ }
1195
+ /**
1196
+ * Object - Convertible Retraction Transaction Object describing a convertible retraction transaction OCF:
1197
+ * https://raw.githubusercontent.com/Open-Cap-Table-Coalition/Open-Cap-Format-OCF/main/schema/objects/transactions/retraction/ConvertibleRetraction.schema.json
1198
+ */
1199
+ export interface OcfConvertibleRetraction {
1200
+ /** Identifier for the object */
1201
+ id: string;
1202
+ /** Date on which the transaction occurred */
1203
+ date: string;
1204
+ /** Identifier for the security being retracted */
1205
+ security_id: string;
1206
+ /** Reason for the retraction */
1207
+ reason_text: string;
1208
+ /** Unstructured text comments related to and stored for the object */
1209
+ comments?: string[];
1210
+ }
1211
+ /**
1212
+ * Object - Equity Compensation Retraction Transaction Object describing an equity compensation retraction transaction
1213
+ * OCF:
1214
+ * https://raw.githubusercontent.com/Open-Cap-Table-Coalition/Open-Cap-Format-OCF/main/schema/objects/transactions/retraction/EquityCompensationRetraction.schema.json
1215
+ */
1216
+ export interface OcfEquityCompensationRetraction {
1217
+ /** Identifier for the object */
1218
+ id: string;
1219
+ /** Date on which the transaction occurred */
1220
+ date: string;
1221
+ /** Identifier for the security being retracted */
1222
+ security_id: string;
1223
+ /** Reason for the retraction */
1224
+ reason_text: string;
1225
+ /** Unstructured text comments related to and stored for the object */
1226
+ comments?: string[];
1227
+ }
1228
+ /**
1229
+ * Object - Warrant Exercise Transaction Object describing a warrant exercise transaction OCF:
1230
+ * https://raw.githubusercontent.com/Open-Cap-Table-Coalition/Open-Cap-Format-OCF/main/schema/objects/transactions/exercise/WarrantExercise.schema.json
1231
+ */
1232
+ export interface OcfWarrantExercise {
1233
+ /** Identifier for the object */
1234
+ id: string;
1235
+ /** Date on which the transaction occurred */
1236
+ date: string;
1237
+ /** Identifier for the warrant security being exercised */
1238
+ security_id: string;
1239
+ /** Quantity of warrants being exercised */
1240
+ quantity: string | number;
1241
+ /** Array of identifiers for new securities resulting from the exercise */
1242
+ resulting_security_ids: string[];
1243
+ /** Identifier for the security that holds the remainder balance (for partial exercises) */
1244
+ balance_security_id?: string;
1245
+ /** Unstructured text description of consideration provided in exchange for security exercise */
1246
+ consideration_text?: string;
1247
+ /** Unstructured text comments related to and stored for the object */
1248
+ comments?: string[];
1249
+ }
1250
+ /**
1251
+ * Object - Stock Conversion Transaction Object describing a stock conversion transaction OCF:
1252
+ * https://raw.githubusercontent.com/Open-Cap-Table-Coalition/Open-Cap-Format-OCF/main/schema/objects/transactions/conversion/StockConversion.schema.json
1253
+ */
1254
+ export interface OcfStockConversion {
1255
+ /** Identifier for the object */
1256
+ id: string;
1257
+ /** Date on which the transaction occurred */
1258
+ date: string;
1259
+ /** Identifier for the stock security being converted */
1260
+ security_id: string;
1261
+ /** Quantity of stock being converted */
1262
+ quantity: string | number;
1263
+ /** Array of identifiers for new securities resulting from the conversion */
1264
+ resulting_security_ids: string[];
1265
+ /** Identifier for the security that holds the remainder balance (for partial conversions) */
1266
+ balance_security_id?: string;
1267
+ /** Unstructured text comments related to and stored for the object */
1268
+ comments?: string[];
1269
+ }
1270
+ /**
1271
+ * Object - Convertible Conversion Transaction Object describing a convertible conversion transaction OCF:
1272
+ * https://raw.githubusercontent.com/Open-Cap-Table-Coalition/Open-Cap-Format-OCF/main/schema/objects/transactions/conversion/ConvertibleConversion.schema.json
1273
+ */
1274
+ export interface OcfConvertibleConversion {
1275
+ /** Identifier for the object */
1276
+ id: string;
1277
+ /** Date on which the transaction occurred */
1278
+ date: string;
1279
+ /** Identifier for the convertible security being converted */
1280
+ security_id: string;
1281
+ /** Array of identifiers for new securities resulting from the conversion */
1282
+ resulting_security_ids: string[];
1283
+ /** Identifier for the security that holds the remainder balance (for partial conversions) */
1284
+ balance_security_id?: string;
1285
+ /** Identifier of the trigger that caused conversion */
1286
+ trigger_id?: string;
1287
+ /** Unstructured text comments related to and stored for the object */
1288
+ comments?: string[];
1289
+ }
1290
+ /**
1291
+ * Object - Equity Compensation Release Transaction Object describing an equity compensation release transaction OCF:
1292
+ * https://raw.githubusercontent.com/Open-Cap-Table-Coalition/Open-Cap-Format-OCF/main/schema/objects/transactions/release/EquityCompensationRelease.schema.json
1293
+ */
1294
+ export interface OcfEquityCompensationRelease {
1295
+ /** Identifier for the object */
1296
+ id: string;
1297
+ /** Date on which the transaction occurred */
1298
+ date: string;
1299
+ /** Identifier for the equity compensation security being released */
1300
+ security_id: string;
1301
+ /** Quantity of equity compensation being released */
1302
+ quantity: string | number;
1303
+ /** Array of identifiers for new securities resulting from the release */
1304
+ resulting_security_ids: string[];
1305
+ /** Identifier for the security that holds the remainder balance (for partial releases) */
1306
+ balance_security_id?: string;
1307
+ /** Settlement date for the release */
1308
+ settlement_date?: string;
1309
+ /** Unstructured text description of consideration provided */
1310
+ consideration_text?: string;
1311
+ /** Unstructured text comments related to and stored for the object */
1312
+ comments?: string[];
1313
+ }
1314
+ /**
1315
+ * Object - Vesting Start Transaction Object describing the start of vesting for a security OCF:
1316
+ * https://raw.githubusercontent.com/Open-Cap-Table-Coalition/Open-Cap-Format-OCF/main/schema/objects/transactions/vesting/VestingStart.schema.json
1317
+ */
1318
+ export interface OcfVestingStart {
1319
+ /** Identifier for the object */
1320
+ id: string;
1321
+ /** Date on which the transaction occurred */
1322
+ date: string;
1323
+ /** Identifier for the security whose vesting is starting */
1324
+ security_id: string;
1325
+ /** ID of the vesting condition that is satisfied by this vesting start event */
1326
+ vesting_condition_id: string;
1327
+ /** Unstructured text comments related to and stored for the object */
1328
+ comments?: string[];
1329
+ }
1330
+ /**
1331
+ * Object - Vesting Event Transaction Object describing a vesting event for a security OCF:
1332
+ * https://raw.githubusercontent.com/Open-Cap-Table-Coalition/Open-Cap-Format-OCF/main/schema/objects/transactions/vesting/VestingEvent.schema.json
1333
+ */
1334
+ export interface OcfVestingEvent {
1335
+ /** Identifier for the object */
1336
+ id: string;
1337
+ /** Date on which the transaction occurred */
1338
+ date: string;
1339
+ /** Identifier for the security whose vesting event is occurring */
1340
+ security_id: string;
1341
+ /** ID of the vesting condition that is satisfied by this vesting event */
1342
+ vesting_condition_id: string;
1343
+ /** Unstructured text comments related to and stored for the object */
1344
+ comments?: string[];
1345
+ }
1346
+ /**
1347
+ * Object - Vesting Acceleration Transaction Object describing a vesting acceleration for a security OCF:
1348
+ * https://raw.githubusercontent.com/Open-Cap-Table-Coalition/Open-Cap-Format-OCF/main/schema/objects/transactions/vesting/VestingAcceleration.schema.json
1349
+ */
1350
+ export interface OcfVestingAcceleration {
1351
+ /** Identifier for the object */
1352
+ id: string;
1353
+ /** Date on which the transaction occurred */
1354
+ date: string;
1355
+ /** Identifier for the security whose vesting is being accelerated */
1356
+ security_id: string;
1357
+ /** Quantity of shares/units being accelerated */
1358
+ quantity: string | number;
1359
+ /** Reason for the vesting acceleration */
1360
+ reason_text: string;
1361
+ /** Unstructured text comments related to and stored for the object */
1362
+ comments?: string[];
1363
+ }
1364
+ /**
1365
+ * Object - Stock Class Split Transaction Object describing a stock class split transaction OCF:
1366
+ * https://raw.githubusercontent.com/Open-Cap-Table-Coalition/Open-Cap-Format-OCF/main/schema/objects/transactions/adjustment/StockClassSplit.schema.json
1367
+ */
1368
+ export interface OcfStockClassSplit {
1369
+ /** Identifier for the object */
1370
+ id: string;
1371
+ /** Date on which the transaction occurred */
1372
+ date: string;
1373
+ /** Identifier for the stock class being split */
1374
+ stock_class_id: string;
1375
+ /** Split ratio - numerator (e.g., 2 for a 2-for-1 split) */
1376
+ split_ratio_numerator: string | number;
1377
+ /** Split ratio - denominator (e.g., 1 for a 2-for-1 split) */
1378
+ split_ratio_denominator: string | number;
1379
+ /** Date on which the board approved the split */
1380
+ board_approval_date?: string;
1381
+ /** Date on which stockholders approved the split */
1382
+ stockholder_approval_date?: string;
1383
+ /** Unstructured text comments related to and stored for the object */
1384
+ comments?: string[];
1385
+ }
1386
+ /**
1387
+ * Object - Stock Class Conversion Ratio Adjustment Transaction Object describing a conversion ratio adjustment OCF:
1388
+ * https://raw.githubusercontent.com/Open-Cap-Table-Coalition/Open-Cap-Format-OCF/main/schema/objects/transactions/adjustment/StockClassConversionRatioAdjustment.schema.json
1389
+ */
1390
+ export interface OcfStockClassConversionRatioAdjustment {
1391
+ /** Identifier for the object */
1392
+ id: string;
1393
+ /** Date on which the transaction occurred */
1394
+ date: string;
1395
+ /** Identifier for the stock class whose conversion ratio is being adjusted */
1396
+ stock_class_id: string;
1397
+ /** New conversion ratio - numerator */
1398
+ new_ratio_numerator: string | number;
1399
+ /** New conversion ratio - denominator */
1400
+ new_ratio_denominator: string | number;
1401
+ /** Date on which the board approved the adjustment */
1402
+ board_approval_date?: string;
1403
+ /** Date on which stockholders approved the adjustment */
1404
+ stockholder_approval_date?: string;
1405
+ /** Unstructured text comments related to and stored for the object */
1406
+ comments?: string[];
1407
+ }
1408
+ /**
1409
+ * Object - Stock Plan Return To Pool Transaction Object describing shares returned to the stock plan pool OCF:
1410
+ * https://raw.githubusercontent.com/Open-Cap-Table-Coalition/Open-Cap-Format-OCF/main/schema/objects/transactions/adjustment/StockPlanReturnToPool.schema.json
1411
+ */
1412
+ export interface OcfStockPlanReturnToPool {
1413
+ /** Identifier for the object */
1414
+ id: string;
1415
+ /** Date on which the transaction occurred */
1416
+ date: string;
1417
+ /** Identifier for the stock plan to which shares are being returned */
1418
+ stock_plan_id: string;
1419
+ /** Quantity of shares being returned to the pool */
1420
+ quantity: string | number;
1421
+ /** Reason for shares returning to pool */
1422
+ reason_text: string;
1423
+ /** Unstructured text comments related to and stored for the object */
1424
+ comments?: string[];
1425
+ }
1426
+ /**
1427
+ * Object - Stock Reissuance Transaction Object describing a stock reissuance transaction OCF:
1428
+ * https://raw.githubusercontent.com/Open-Cap-Table-Coalition/Open-Cap-Format-OCF/main/schema/objects/transactions/reissuance/StockReissuance.schema.json
1429
+ */
1430
+ export interface OcfStockReissuance {
1431
+ /** Identifier for the object */
1432
+ id: string;
1433
+ /** Date on which the transaction occurred */
1434
+ date: string;
1435
+ /** Identifier for the security being reissued */
1436
+ security_id: string;
1437
+ /** Array of identifiers for new securities resulting from the reissuance */
1438
+ resulting_security_ids: string[];
1439
+ /** Unstructured text comments related to and stored for the object */
1440
+ comments?: string[];
1441
+ }
1442
+ /**
1443
+ * Object - Stock Consolidation Transaction Object describing a stock consolidation transaction OCF:
1444
+ * https://raw.githubusercontent.com/Open-Cap-Table-Coalition/Open-Cap-Format-OCF/main/schema/objects/transactions/consolidation/StockConsolidation.schema.json
1445
+ */
1446
+ export interface OcfStockConsolidation {
1447
+ /** Identifier for the object */
1448
+ id: string;
1449
+ /** Date on which the transaction occurred */
1450
+ date: string;
1451
+ /** Array of identifiers for securities being consolidated */
1452
+ security_ids: string[];
1453
+ /** Array of identifiers for new securities resulting from the consolidation */
1454
+ resulting_security_ids: string[];
1455
+ /** Unstructured text comments related to and stored for the object */
1456
+ comments?: string[];
1457
+ }
1458
+ /**
1459
+ * Object - Equity Compensation Repricing Transaction Object describing an equity compensation repricing transaction
1460
+ * OCF:
1461
+ * https://raw.githubusercontent.com/Open-Cap-Table-Coalition/Open-Cap-Format-OCF/main/schema/objects/transactions/repricing/EquityCompensationRepricing.schema.json
1462
+ */
1463
+ export interface OcfEquityCompensationRepricing {
1464
+ /** Identifier for the object */
1465
+ id: string;
1466
+ /** Date on which the transaction occurred */
1467
+ date: string;
1468
+ /** Identifier for the security being repriced */
1469
+ security_id: string;
1470
+ /** Array of identifiers for new securities resulting from the repricing */
1471
+ resulting_security_ids: string[];
1472
+ /** Unstructured text comments related to and stored for the object */
1473
+ comments?: string[];
1474
+ }
1475
+ /**
1476
+ * Object - Plan Security Issuance Transaction Object describing a plan security issuance transaction OCF:
1477
+ * https://raw.githubusercontent.com/Open-Cap-Table-Coalition/Open-Cap-Format-OCF/main/schema/objects/transactions/issuance/PlanSecurityIssuance.schema.json
1478
+ */
1479
+ export interface OcfPlanSecurityIssuance {
1480
+ /** Identifier for the object */
1481
+ id: string;
1482
+ /** Date on which the transaction occurred */
1483
+ date: string;
1484
+ /** Identifier for the security being issued */
1485
+ security_id: string;
1486
+ /** A custom ID for this security */
1487
+ custom_id: string;
1488
+ /** Identifier for the stakeholder receiving the security */
1489
+ stakeholder_id: string;
1490
+ /** Identifier for the stock plan */
1491
+ stock_plan_id: string;
1492
+ /** Identifier for the stock class */
1493
+ stock_class_id?: string;
1494
+ /** Type of plan security */
1495
+ plan_security_type: 'OPTION' | 'RSU' | 'OTHER';
1496
+ /** Quantity of plan securities being issued */
1497
+ quantity: string | number;
1498
+ /** Exercise price per share/unit */
1499
+ exercise_price?: Monetary;
1500
+ /** Identifier for the vesting terms */
1501
+ vesting_terms_id?: string;
1502
+ /** Date on which the board approved the issuance */
1503
+ board_approval_date?: string;
1504
+ /** Date on which stockholders approved the issuance */
1505
+ stockholder_approval_date?: string;
1506
+ /** Unstructured text description of consideration */
1507
+ consideration_text?: string;
1508
+ /** Security law exemptions */
1509
+ security_law_exemptions?: SecurityExemption[];
1510
+ /** Unstructured text comments related to and stored for the object */
1511
+ comments?: string[];
1512
+ }
1513
+ /**
1514
+ * Object - Plan Security Exercise Transaction Object describing a plan security exercise transaction OCF:
1515
+ * https://raw.githubusercontent.com/Open-Cap-Table-Coalition/Open-Cap-Format-OCF/main/schema/objects/transactions/exercise/PlanSecurityExercise.schema.json
1516
+ */
1517
+ export interface OcfPlanSecurityExercise {
1518
+ /** Identifier for the object */
1519
+ id: string;
1520
+ /** Date on which the transaction occurred */
1521
+ date: string;
1522
+ /** Identifier for the plan security being exercised */
1523
+ security_id: string;
1524
+ /** Quantity being exercised */
1525
+ quantity: string | number;
1526
+ /** Array of identifiers for new securities resulting from the exercise */
1527
+ resulting_security_ids: string[];
1528
+ /** Identifier for the security that holds the remainder balance (for partial exercises) */
1529
+ balance_security_id?: string;
1530
+ /** Unstructured text description of consideration */
1531
+ consideration_text?: string;
1532
+ /** Unstructured text comments related to and stored for the object */
1533
+ comments?: string[];
1534
+ }
1535
+ /**
1536
+ * Object - Plan Security Cancellation Transaction Object describing a plan security cancellation transaction OCF:
1537
+ * https://raw.githubusercontent.com/Open-Cap-Table-Coalition/Open-Cap-Format-OCF/main/schema/objects/transactions/cancellation/PlanSecurityCancellation.schema.json
1538
+ */
1539
+ export interface OcfPlanSecurityCancellation {
1540
+ /** Identifier for the object */
1541
+ id: string;
1542
+ /** Date on which the transaction occurred */
1543
+ date: string;
1544
+ /** Identifier for the plan security being cancelled */
1545
+ security_id: string;
1546
+ /** Quantity being cancelled */
1547
+ quantity: string | number;
1548
+ /** Identifier for the security that holds the remainder balance (for partial cancellations) */
1549
+ balance_security_id?: string;
1550
+ /** Reason for the cancellation */
1551
+ reason_text: string;
1552
+ /** Unstructured text comments related to and stored for the object */
1553
+ comments?: string[];
1554
+ }
1555
+ /**
1556
+ * Object - Plan Security Acceptance Transaction Object describing a plan security acceptance transaction OCF:
1557
+ * https://raw.githubusercontent.com/Open-Cap-Table-Coalition/Open-Cap-Format-OCF/main/schema/objects/transactions/acceptance/PlanSecurityAcceptance.schema.json
1558
+ */
1559
+ export interface OcfPlanSecurityAcceptance {
1560
+ /** Identifier for the object */
1561
+ id: string;
1562
+ /** Date on which the transaction occurred */
1563
+ date: string;
1564
+ /** Identifier for the plan security being accepted */
1565
+ security_id: string;
1566
+ /** Unstructured text comments related to and stored for the object */
1567
+ comments?: string[];
1568
+ }
1569
+ /**
1570
+ * Object - Plan Security Release Transaction Object describing a plan security release transaction OCF:
1571
+ * https://raw.githubusercontent.com/Open-Cap-Table-Coalition/Open-Cap-Format-OCF/main/schema/objects/transactions/release/PlanSecurityRelease.schema.json
1572
+ */
1573
+ export interface OcfPlanSecurityRelease {
1574
+ /** Identifier for the object */
1575
+ id: string;
1576
+ /** Date on which the transaction occurred */
1577
+ date: string;
1578
+ /** Identifier for the plan security being released */
1579
+ security_id: string;
1580
+ /** Quantity being released */
1581
+ quantity: string | number;
1582
+ /** Array of identifiers for new securities resulting from the release */
1583
+ resulting_security_ids: string[];
1584
+ /** Identifier for the security that holds the remainder balance (for partial releases) */
1585
+ balance_security_id?: string;
1586
+ /** Settlement date for the release */
1587
+ settlement_date?: string;
1588
+ /** Unstructured text description of consideration */
1589
+ consideration_text?: string;
1590
+ /** Unstructured text comments related to and stored for the object */
1591
+ comments?: string[];
1592
+ }
1593
+ /**
1594
+ * Object - Plan Security Retraction Transaction Object describing a plan security retraction transaction OCF:
1595
+ * https://raw.githubusercontent.com/Open-Cap-Table-Coalition/Open-Cap-Format-OCF/main/schema/objects/transactions/retraction/PlanSecurityRetraction.schema.json
1596
+ */
1597
+ export interface OcfPlanSecurityRetraction {
1598
+ /** Identifier for the object */
1599
+ id: string;
1600
+ /** Date on which the transaction occurred */
1601
+ date: string;
1602
+ /** Identifier for the plan security being retracted */
1603
+ security_id: string;
1604
+ /** Reason for the retraction */
1605
+ reason_text: string;
1606
+ /** Unstructured text comments related to and stored for the object */
1607
+ comments?: string[];
1608
+ }
1609
+ /**
1610
+ * Object - Plan Security Transfer Transaction Object describing a plan security transfer transaction OCF:
1611
+ * https://raw.githubusercontent.com/Open-Cap-Table-Coalition/Open-Cap-Format-OCF/main/schema/objects/transactions/transfer/PlanSecurityTransfer.schema.json
1612
+ */
1613
+ export interface OcfPlanSecurityTransfer {
1614
+ /** Identifier for the object */
1615
+ id: string;
1616
+ /** Date on which the transaction occurred */
1617
+ date: string;
1618
+ /** Identifier for the plan security being transferred */
1619
+ security_id: string;
1620
+ /** Quantity being transferred */
1621
+ quantity: string | number;
1622
+ /** Array of identifiers for new securities resulting from the transfer */
1623
+ resulting_security_ids: string[];
1624
+ /** Identifier for the security that holds the remainder balance (for partial transfers) */
1625
+ balance_security_id?: string;
1626
+ /** Unstructured text description of consideration */
1627
+ consideration_text?: string;
1628
+ /** Unstructured text comments related to and stored for the object */
1629
+ comments?: string[];
1630
+ }
1631
+ /**
1632
+ * Object - Financing Object describing a financing round OCF:
1633
+ * https://raw.githubusercontent.com/Open-Cap-Table-Coalition/Open-Cap-Format-OCF/main/schema/objects/Financing.schema.json
1634
+ */
1635
+ export interface OcfFinancing {
1636
+ /** Identifier for the object */
1637
+ id: string;
1638
+ /** Name of the financing round */
1639
+ round_name: string;
1640
+ /** Date the financing round was announced or closed */
1641
+ financing_date: string;
1642
+ /** Type of financing round */
1643
+ financing_type?: 'PRE_SEED' | 'SEED' | 'SERIES_A' | 'SERIES_B' | 'SERIES_C' | 'SERIES_D' | 'SERIES_E' | 'SERIES_F' | 'BRIDGE' | 'CONVERTIBLE_NOTE' | 'SAFE' | 'OTHER';
1644
+ /** Total amount raised in this financing round */
1645
+ amount_raised?: Monetary;
1646
+ /** Pre-money valuation */
1647
+ pre_money_valuation?: Monetary;
1648
+ /** Post-money valuation */
1649
+ post_money_valuation?: Monetary;
1650
+ /** Identifier for the stock class created or used in this financing */
1651
+ stock_class_id?: string;
1652
+ /** Unstructured text comments related to and stored for the object */
1653
+ comments?: string[];
1654
+ }
790
1655
  //# sourceMappingURL=native.d.ts.map