@open-captable-protocol/canton 0.2.76 → 0.2.78

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 (315) hide show
  1. package/README.docs.md +2 -3
  2. package/README.md +29 -9
  3. package/dist/OcpClient.d.ts +19 -18
  4. package/dist/OcpClient.d.ts.map +1 -1
  5. package/dist/OcpClient.js +30 -30
  6. package/dist/OcpClient.js.map +1 -1
  7. package/dist/functions/companyValuationReport/addObserversToCompanyValuationReport.d.ts +3 -5
  8. package/dist/functions/companyValuationReport/addObserversToCompanyValuationReport.d.ts.map +1 -1
  9. package/dist/functions/companyValuationReport/addObserversToCompanyValuationReport.js +19 -17
  10. package/dist/functions/companyValuationReport/addObserversToCompanyValuationReport.js.map +1 -1
  11. package/dist/functions/companyValuationReport/createCompanyValuationReport.d.ts +21 -22
  12. package/dist/functions/companyValuationReport/createCompanyValuationReport.d.ts.map +1 -1
  13. package/dist/functions/companyValuationReport/createCompanyValuationReport.js +30 -32
  14. package/dist/functions/companyValuationReport/createCompanyValuationReport.js.map +1 -1
  15. package/dist/functions/companyValuationReport/updateCompanyValuationReport.d.ts +3 -5
  16. package/dist/functions/companyValuationReport/updateCompanyValuationReport.d.ts.map +1 -1
  17. package/dist/functions/companyValuationReport/updateCompanyValuationReport.js +19 -17
  18. package/dist/functions/companyValuationReport/updateCompanyValuationReport.js.map +1 -1
  19. package/dist/functions/convertibleIssuance/archiveConvertibleIssuanceByIssuer.d.ts +1 -1
  20. package/dist/functions/convertibleIssuance/archiveConvertibleIssuanceByIssuer.d.ts.map +1 -1
  21. package/dist/functions/convertibleIssuance/archiveConvertibleIssuanceByIssuer.js +2 -2
  22. package/dist/functions/convertibleIssuance/archiveConvertibleIssuanceByIssuer.js.map +1 -1
  23. package/dist/functions/convertibleIssuance/createConvertibleIssuance.d.ts +2 -2
  24. package/dist/functions/convertibleIssuance/createConvertibleIssuance.d.ts.map +1 -1
  25. package/dist/functions/convertibleIssuance/createConvertibleIssuance.js +109 -82
  26. package/dist/functions/convertibleIssuance/createConvertibleIssuance.js.map +1 -1
  27. package/dist/functions/convertibleIssuance/getConvertibleIssuanceAsOcf.d.ts +28 -26
  28. package/dist/functions/convertibleIssuance/getConvertibleIssuanceAsOcf.d.ts.map +1 -1
  29. package/dist/functions/convertibleIssuance/getConvertibleIssuanceAsOcf.js +167 -71
  30. package/dist/functions/convertibleIssuance/getConvertibleIssuanceAsOcf.js.map +1 -1
  31. package/dist/functions/convertibleIssuance/index.d.ts +1 -1
  32. package/dist/functions/convertibleIssuance/index.d.ts.map +1 -1
  33. package/dist/functions/convertibleIssuance/index.js +1 -1
  34. package/dist/functions/convertibleIssuance/index.js.map +1 -1
  35. package/dist/functions/document/archiveDocumentByIssuer.d.ts +1 -1
  36. package/dist/functions/document/archiveDocumentByIssuer.d.ts.map +1 -1
  37. package/dist/functions/document/archiveDocumentByIssuer.js +2 -2
  38. package/dist/functions/document/archiveDocumentByIssuer.js.map +1 -1
  39. package/dist/functions/document/createDocument.d.ts +4 -4
  40. package/dist/functions/document/createDocument.d.ts.map +1 -1
  41. package/dist/functions/document/createDocument.js +132 -71
  42. package/dist/functions/document/createDocument.js.map +1 -1
  43. package/dist/functions/document/getDocumentAsOcf.d.ts +4 -4
  44. package/dist/functions/document/getDocumentAsOcf.d.ts.map +1 -1
  45. package/dist/functions/document/getDocumentAsOcf.js +127 -66
  46. package/dist/functions/document/getDocumentAsOcf.js.map +1 -1
  47. package/dist/functions/document/index.d.ts +1 -1
  48. package/dist/functions/document/index.d.ts.map +1 -1
  49. package/dist/functions/document/index.js +1 -1
  50. package/dist/functions/document/index.js.map +1 -1
  51. package/dist/functions/equityCompensationExercise/archiveEquityCompensationExerciseByIssuer.d.ts +1 -1
  52. package/dist/functions/equityCompensationExercise/archiveEquityCompensationExerciseByIssuer.d.ts.map +1 -1
  53. package/dist/functions/equityCompensationExercise/archiveEquityCompensationExerciseByIssuer.js +2 -2
  54. package/dist/functions/equityCompensationExercise/archiveEquityCompensationExerciseByIssuer.js.map +1 -1
  55. package/dist/functions/equityCompensationExercise/createEquityCompensationExercise.d.ts +3 -11
  56. package/dist/functions/equityCompensationExercise/createEquityCompensationExercise.d.ts.map +1 -1
  57. package/dist/functions/equityCompensationExercise/createEquityCompensationExercise.js +20 -12
  58. package/dist/functions/equityCompensationExercise/createEquityCompensationExercise.js.map +1 -1
  59. package/dist/functions/equityCompensationExercise/getEquityCompensationExerciseEventAsOcf.d.ts +3 -3
  60. package/dist/functions/equityCompensationExercise/getEquityCompensationExerciseEventAsOcf.d.ts.map +1 -1
  61. package/dist/functions/equityCompensationExercise/getEquityCompensationExerciseEventAsOcf.js +7 -5
  62. package/dist/functions/equityCompensationExercise/getEquityCompensationExerciseEventAsOcf.js.map +1 -1
  63. package/dist/functions/equityCompensationExercise/index.d.ts +1 -1
  64. package/dist/functions/equityCompensationExercise/index.d.ts.map +1 -1
  65. package/dist/functions/equityCompensationExercise/index.js +1 -1
  66. package/dist/functions/equityCompensationExercise/index.js.map +1 -1
  67. package/dist/functions/equityCompensationIssuance/archiveEquityCompensationIssuanceByIssuer.d.ts +1 -1
  68. package/dist/functions/equityCompensationIssuance/archiveEquityCompensationIssuanceByIssuer.d.ts.map +1 -1
  69. package/dist/functions/equityCompensationIssuance/archiveEquityCompensationIssuanceByIssuer.js +2 -2
  70. package/dist/functions/equityCompensationIssuance/archiveEquityCompensationIssuanceByIssuer.js.map +1 -1
  71. package/dist/functions/equityCompensationIssuance/createEquityCompensationIssuance.d.ts +2 -2
  72. package/dist/functions/equityCompensationIssuance/createEquityCompensationIssuance.d.ts.map +1 -1
  73. package/dist/functions/equityCompensationIssuance/createEquityCompensationIssuance.js +71 -59
  74. package/dist/functions/equityCompensationIssuance/createEquityCompensationIssuance.js.map +1 -1
  75. package/dist/functions/equityCompensationIssuance/getEquityCompensationIssuanceEventAsOcf.d.ts +1 -1
  76. package/dist/functions/equityCompensationIssuance/getEquityCompensationIssuanceEventAsOcf.d.ts.map +1 -1
  77. package/dist/functions/equityCompensationIssuance/getEquityCompensationIssuanceEventAsOcf.js +53 -31
  78. package/dist/functions/equityCompensationIssuance/getEquityCompensationIssuanceEventAsOcf.js.map +1 -1
  79. package/dist/functions/equityCompensationIssuance/index.d.ts +1 -1
  80. package/dist/functions/equityCompensationIssuance/index.d.ts.map +1 -1
  81. package/dist/functions/equityCompensationIssuance/index.js +1 -1
  82. package/dist/functions/equityCompensationIssuance/index.js.map +1 -1
  83. package/dist/functions/index.d.ts +13 -13
  84. package/dist/functions/index.d.ts.map +1 -1
  85. package/dist/functions/index.js +13 -13
  86. package/dist/functions/index.js.map +1 -1
  87. package/dist/functions/issuer/archiveIssuerByIssuer.d.ts +1 -1
  88. package/dist/functions/issuer/archiveIssuerByIssuer.d.ts.map +1 -1
  89. package/dist/functions/issuer/archiveIssuerByIssuer.js +2 -2
  90. package/dist/functions/issuer/archiveIssuerByIssuer.js.map +1 -1
  91. package/dist/functions/issuer/createIssuer.d.ts +15 -14
  92. package/dist/functions/issuer/createIssuer.d.ts.map +1 -1
  93. package/dist/functions/issuer/createIssuer.js +40 -24
  94. package/dist/functions/issuer/createIssuer.js.map +1 -1
  95. package/dist/functions/issuer/getIssuerAsOcf.d.ts +5 -4
  96. package/dist/functions/issuer/getIssuerAsOcf.d.ts.map +1 -1
  97. package/dist/functions/issuer/getIssuerAsOcf.js +36 -19
  98. package/dist/functions/issuer/getIssuerAsOcf.js.map +1 -1
  99. package/dist/functions/issuer/index.d.ts +1 -1
  100. package/dist/functions/issuer/index.d.ts.map +1 -1
  101. package/dist/functions/issuer/index.js +1 -1
  102. package/dist/functions/issuer/index.js.map +1 -1
  103. package/dist/functions/issuerAuthorization/authorizeIssuer.d.ts +4 -3
  104. package/dist/functions/issuerAuthorization/authorizeIssuer.d.ts.map +1 -1
  105. package/dist/functions/issuerAuthorization/authorizeIssuer.js +14 -12
  106. package/dist/functions/issuerAuthorization/authorizeIssuer.js.map +1 -1
  107. package/dist/functions/issuerAuthorization/withdrawAuthorization.d.ts +2 -2
  108. package/dist/functions/issuerAuthorization/withdrawAuthorization.d.ts.map +1 -1
  109. package/dist/functions/issuerAuthorization/withdrawAuthorization.js +11 -7
  110. package/dist/functions/issuerAuthorization/withdrawAuthorization.js.map +1 -1
  111. package/dist/functions/issuerAuthorizedSharesAdjustment/archiveIssuerAuthorizedSharesAdjustmentByIssuer.d.ts +1 -1
  112. package/dist/functions/issuerAuthorizedSharesAdjustment/archiveIssuerAuthorizedSharesAdjustmentByIssuer.d.ts.map +1 -1
  113. package/dist/functions/issuerAuthorizedSharesAdjustment/archiveIssuerAuthorizedSharesAdjustmentByIssuer.js +2 -2
  114. package/dist/functions/issuerAuthorizedSharesAdjustment/archiveIssuerAuthorizedSharesAdjustmentByIssuer.js.map +1 -1
  115. package/dist/functions/issuerAuthorizedSharesAdjustment/createIssuerAuthorizedSharesAdjustment.d.ts +3 -11
  116. package/dist/functions/issuerAuthorizedSharesAdjustment/createIssuerAuthorizedSharesAdjustment.d.ts.map +1 -1
  117. package/dist/functions/issuerAuthorizedSharesAdjustment/createIssuerAuthorizedSharesAdjustment.js +20 -12
  118. package/dist/functions/issuerAuthorizedSharesAdjustment/createIssuerAuthorizedSharesAdjustment.js.map +1 -1
  119. package/dist/functions/issuerAuthorizedSharesAdjustment/getIssuerAuthorizedSharesAdjustmentEventAsOcf.d.ts +1 -1
  120. package/dist/functions/issuerAuthorizedSharesAdjustment/getIssuerAuthorizedSharesAdjustmentEventAsOcf.d.ts.map +1 -1
  121. package/dist/functions/issuerAuthorizedSharesAdjustment/getIssuerAuthorizedSharesAdjustmentEventAsOcf.js +17 -5
  122. package/dist/functions/issuerAuthorizedSharesAdjustment/getIssuerAuthorizedSharesAdjustmentEventAsOcf.js.map +1 -1
  123. package/dist/functions/issuerAuthorizedSharesAdjustment/index.d.ts +1 -1
  124. package/dist/functions/issuerAuthorizedSharesAdjustment/index.d.ts.map +1 -1
  125. package/dist/functions/issuerAuthorizedSharesAdjustment/index.js +1 -1
  126. package/dist/functions/issuerAuthorizedSharesAdjustment/index.js.map +1 -1
  127. package/dist/functions/stakeholder/archiveStakeholderByIssuer.d.ts +1 -1
  128. package/dist/functions/stakeholder/archiveStakeholderByIssuer.d.ts.map +1 -1
  129. package/dist/functions/stakeholder/archiveStakeholderByIssuer.js +2 -2
  130. package/dist/functions/stakeholder/archiveStakeholderByIssuer.js.map +1 -1
  131. package/dist/functions/stakeholder/createStakeholder.d.ts +2 -2
  132. package/dist/functions/stakeholder/createStakeholder.d.ts.map +1 -1
  133. package/dist/functions/stakeholder/createStakeholder.js +90 -63
  134. package/dist/functions/stakeholder/createStakeholder.js.map +1 -1
  135. package/dist/functions/stakeholder/getStakeholderAsOcf.d.ts +2 -4
  136. package/dist/functions/stakeholder/getStakeholderAsOcf.d.ts.map +1 -1
  137. package/dist/functions/stakeholder/getStakeholderAsOcf.js +111 -76
  138. package/dist/functions/stakeholder/getStakeholderAsOcf.js.map +1 -1
  139. package/dist/functions/stakeholder/index.d.ts +1 -1
  140. package/dist/functions/stakeholder/index.d.ts.map +1 -1
  141. package/dist/functions/stakeholder/index.js +1 -1
  142. package/dist/functions/stakeholder/index.js.map +1 -1
  143. package/dist/functions/stockCancellation/archiveStockCancellationByIssuer.d.ts +1 -1
  144. package/dist/functions/stockCancellation/archiveStockCancellationByIssuer.d.ts.map +1 -1
  145. package/dist/functions/stockCancellation/archiveStockCancellationByIssuer.js +2 -2
  146. package/dist/functions/stockCancellation/archiveStockCancellationByIssuer.js.map +1 -1
  147. package/dist/functions/stockCancellation/createStockCancellation.d.ts +3 -11
  148. package/dist/functions/stockCancellation/createStockCancellation.d.ts.map +1 -1
  149. package/dist/functions/stockCancellation/createStockCancellation.js +20 -12
  150. package/dist/functions/stockCancellation/createStockCancellation.js.map +1 -1
  151. package/dist/functions/stockCancellation/getStockCancellationEventAsOcf.d.ts +1 -1
  152. package/dist/functions/stockCancellation/getStockCancellationEventAsOcf.d.ts.map +1 -1
  153. package/dist/functions/stockCancellation/getStockCancellationEventAsOcf.js +16 -4
  154. package/dist/functions/stockCancellation/getStockCancellationEventAsOcf.js.map +1 -1
  155. package/dist/functions/stockCancellation/index.d.ts +1 -1
  156. package/dist/functions/stockCancellation/index.d.ts.map +1 -1
  157. package/dist/functions/stockCancellation/index.js +1 -1
  158. package/dist/functions/stockCancellation/index.js.map +1 -1
  159. package/dist/functions/stockClass/archiveStockClassByIssuer.d.ts +1 -1
  160. package/dist/functions/stockClass/archiveStockClassByIssuer.d.ts.map +1 -1
  161. package/dist/functions/stockClass/archiveStockClassByIssuer.js +2 -2
  162. package/dist/functions/stockClass/archiveStockClassByIssuer.js.map +1 -1
  163. package/dist/functions/stockClass/createStockClass.d.ts +20 -16
  164. package/dist/functions/stockClass/createStockClass.d.ts.map +1 -1
  165. package/dist/functions/stockClass/createStockClass.js +73 -41
  166. package/dist/functions/stockClass/createStockClass.js.map +1 -1
  167. package/dist/functions/stockClass/getStockClassAsOcf.d.ts +36 -29
  168. package/dist/functions/stockClass/getStockClassAsOcf.d.ts.map +1 -1
  169. package/dist/functions/stockClass/getStockClassAsOcf.js +122 -67
  170. package/dist/functions/stockClass/getStockClassAsOcf.js.map +1 -1
  171. package/dist/functions/stockClass/index.d.ts +1 -1
  172. package/dist/functions/stockClass/index.d.ts.map +1 -1
  173. package/dist/functions/stockClass/index.js +1 -1
  174. package/dist/functions/stockClass/index.js.map +1 -1
  175. package/dist/functions/stockClassAuthorizedSharesAdjustment/archiveStockClassAuthorizedSharesAdjustmentByIssuer.d.ts +1 -1
  176. package/dist/functions/stockClassAuthorizedSharesAdjustment/archiveStockClassAuthorizedSharesAdjustmentByIssuer.d.ts.map +1 -1
  177. package/dist/functions/stockClassAuthorizedSharesAdjustment/archiveStockClassAuthorizedSharesAdjustmentByIssuer.js +2 -2
  178. package/dist/functions/stockClassAuthorizedSharesAdjustment/archiveStockClassAuthorizedSharesAdjustmentByIssuer.js.map +1 -1
  179. package/dist/functions/stockClassAuthorizedSharesAdjustment/createStockClassAuthorizedSharesAdjustment.d.ts +3 -11
  180. package/dist/functions/stockClassAuthorizedSharesAdjustment/createStockClassAuthorizedSharesAdjustment.d.ts.map +1 -1
  181. package/dist/functions/stockClassAuthorizedSharesAdjustment/createStockClassAuthorizedSharesAdjustment.js +20 -12
  182. package/dist/functions/stockClassAuthorizedSharesAdjustment/createStockClassAuthorizedSharesAdjustment.js.map +1 -1
  183. package/dist/functions/stockClassAuthorizedSharesAdjustment/getStockClassAuthorizedSharesAdjustmentEventAsOcf.d.ts +1 -1
  184. package/dist/functions/stockClassAuthorizedSharesAdjustment/getStockClassAuthorizedSharesAdjustmentEventAsOcf.d.ts.map +1 -1
  185. package/dist/functions/stockClassAuthorizedSharesAdjustment/getStockClassAuthorizedSharesAdjustmentEventAsOcf.js +11 -3
  186. package/dist/functions/stockClassAuthorizedSharesAdjustment/getStockClassAuthorizedSharesAdjustmentEventAsOcf.js.map +1 -1
  187. package/dist/functions/stockClassAuthorizedSharesAdjustment/index.d.ts +1 -1
  188. package/dist/functions/stockClassAuthorizedSharesAdjustment/index.d.ts.map +1 -1
  189. package/dist/functions/stockClassAuthorizedSharesAdjustment/index.js +1 -1
  190. package/dist/functions/stockClassAuthorizedSharesAdjustment/index.js.map +1 -1
  191. package/dist/functions/stockIssuance/archiveStockIssuanceByIssuer.d.ts +1 -1
  192. package/dist/functions/stockIssuance/archiveStockIssuanceByIssuer.d.ts.map +1 -1
  193. package/dist/functions/stockIssuance/archiveStockIssuanceByIssuer.js +2 -2
  194. package/dist/functions/stockIssuance/archiveStockIssuanceByIssuer.js.map +1 -1
  195. package/dist/functions/stockIssuance/createStockIssuance.d.ts +2 -2
  196. package/dist/functions/stockIssuance/createStockIssuance.d.ts.map +1 -1
  197. package/dist/functions/stockIssuance/createStockIssuance.js +49 -58
  198. package/dist/functions/stockIssuance/createStockIssuance.js.map +1 -1
  199. package/dist/functions/stockIssuance/getStockIssuanceAsOcf.d.ts +13 -5
  200. package/dist/functions/stockIssuance/getStockIssuanceAsOcf.d.ts.map +1 -1
  201. package/dist/functions/stockIssuance/getStockIssuanceAsOcf.js +44 -30
  202. package/dist/functions/stockIssuance/getStockIssuanceAsOcf.js.map +1 -1
  203. package/dist/functions/stockIssuance/index.d.ts +1 -1
  204. package/dist/functions/stockIssuance/index.d.ts.map +1 -1
  205. package/dist/functions/stockIssuance/index.js +1 -1
  206. package/dist/functions/stockIssuance/index.js.map +1 -1
  207. package/dist/functions/stockLegendTemplate/archiveStockLegendTemplateByIssuer.d.ts +1 -1
  208. package/dist/functions/stockLegendTemplate/archiveStockLegendTemplateByIssuer.d.ts.map +1 -1
  209. package/dist/functions/stockLegendTemplate/archiveStockLegendTemplateByIssuer.js +2 -2
  210. package/dist/functions/stockLegendTemplate/archiveStockLegendTemplateByIssuer.js.map +1 -1
  211. package/dist/functions/stockLegendTemplate/createStockLegendTemplate.d.ts +2 -2
  212. package/dist/functions/stockLegendTemplate/createStockLegendTemplate.d.ts.map +1 -1
  213. package/dist/functions/stockLegendTemplate/createStockLegendTemplate.js +7 -6
  214. package/dist/functions/stockLegendTemplate/createStockLegendTemplate.js.map +1 -1
  215. package/dist/functions/stockLegendTemplate/getStockLegendTemplateAsOcf.d.ts +1 -1
  216. package/dist/functions/stockLegendTemplate/getStockLegendTemplateAsOcf.d.ts.map +1 -1
  217. package/dist/functions/stockLegendTemplate/getStockLegendTemplateAsOcf.js +11 -9
  218. package/dist/functions/stockLegendTemplate/getStockLegendTemplateAsOcf.js.map +1 -1
  219. package/dist/functions/stockLegendTemplate/index.d.ts +1 -1
  220. package/dist/functions/stockLegendTemplate/index.d.ts.map +1 -1
  221. package/dist/functions/stockLegendTemplate/index.js +1 -1
  222. package/dist/functions/stockLegendTemplate/index.js.map +1 -1
  223. package/dist/functions/stockPlan/archiveStockPlanByIssuer.d.ts +1 -1
  224. package/dist/functions/stockPlan/archiveStockPlanByIssuer.d.ts.map +1 -1
  225. package/dist/functions/stockPlan/archiveStockPlanByIssuer.js +2 -2
  226. package/dist/functions/stockPlan/archiveStockPlanByIssuer.js.map +1 -1
  227. package/dist/functions/stockPlan/createStockPlan.d.ts +2 -2
  228. package/dist/functions/stockPlan/createStockPlan.d.ts.map +1 -1
  229. package/dist/functions/stockPlan/createStockPlan.js +16 -11
  230. package/dist/functions/stockPlan/createStockPlan.js.map +1 -1
  231. package/dist/functions/stockPlan/getStockPlanAsOcf.d.ts +2 -1
  232. package/dist/functions/stockPlan/getStockPlanAsOcf.d.ts.map +1 -1
  233. package/dist/functions/stockPlan/getStockPlanAsOcf.js +29 -18
  234. package/dist/functions/stockPlan/getStockPlanAsOcf.js.map +1 -1
  235. package/dist/functions/stockPlan/index.d.ts +1 -1
  236. package/dist/functions/stockPlan/index.d.ts.map +1 -1
  237. package/dist/functions/stockPlan/index.js +1 -1
  238. package/dist/functions/stockPlan/index.js.map +1 -1
  239. package/dist/functions/stockPlanPoolAdjustment/archiveStockPlanPoolAdjustmentByIssuer.d.ts +1 -1
  240. package/dist/functions/stockPlanPoolAdjustment/archiveStockPlanPoolAdjustmentByIssuer.d.ts.map +1 -1
  241. package/dist/functions/stockPlanPoolAdjustment/archiveStockPlanPoolAdjustmentByIssuer.js +2 -2
  242. package/dist/functions/stockPlanPoolAdjustment/archiveStockPlanPoolAdjustmentByIssuer.js.map +1 -1
  243. package/dist/functions/stockPlanPoolAdjustment/createStockPlanPoolAdjustment.d.ts +3 -11
  244. package/dist/functions/stockPlanPoolAdjustment/createStockPlanPoolAdjustment.d.ts.map +1 -1
  245. package/dist/functions/stockPlanPoolAdjustment/createStockPlanPoolAdjustment.js +20 -12
  246. package/dist/functions/stockPlanPoolAdjustment/createStockPlanPoolAdjustment.js.map +1 -1
  247. package/dist/functions/stockPlanPoolAdjustment/getStockPlanPoolAdjustmentEventAsOcf.d.ts +1 -1
  248. package/dist/functions/stockPlanPoolAdjustment/getStockPlanPoolAdjustmentEventAsOcf.d.ts.map +1 -1
  249. package/dist/functions/stockPlanPoolAdjustment/getStockPlanPoolAdjustmentEventAsOcf.js +11 -3
  250. package/dist/functions/stockPlanPoolAdjustment/getStockPlanPoolAdjustmentEventAsOcf.js.map +1 -1
  251. package/dist/functions/stockPlanPoolAdjustment/index.d.ts +1 -1
  252. package/dist/functions/stockPlanPoolAdjustment/index.d.ts.map +1 -1
  253. package/dist/functions/stockPlanPoolAdjustment/index.js +1 -1
  254. package/dist/functions/stockPlanPoolAdjustment/index.js.map +1 -1
  255. package/dist/functions/vestingTerms/archiveVestingTermsByIssuer.d.ts +1 -1
  256. package/dist/functions/vestingTerms/archiveVestingTermsByIssuer.d.ts.map +1 -1
  257. package/dist/functions/vestingTerms/archiveVestingTermsByIssuer.js +2 -2
  258. package/dist/functions/vestingTerms/archiveVestingTermsByIssuer.js.map +1 -1
  259. package/dist/functions/vestingTerms/createVestingTerms.d.ts +3 -2
  260. package/dist/functions/vestingTerms/createVestingTerms.d.ts.map +1 -1
  261. package/dist/functions/vestingTerms/createVestingTerms.js +137 -50
  262. package/dist/functions/vestingTerms/createVestingTerms.js.map +1 -1
  263. package/dist/functions/vestingTerms/getVestingTermsAsOcf.d.ts +4 -2
  264. package/dist/functions/vestingTerms/getVestingTermsAsOcf.d.ts.map +1 -1
  265. package/dist/functions/vestingTerms/getVestingTermsAsOcf.js +98 -45
  266. package/dist/functions/vestingTerms/getVestingTermsAsOcf.js.map +1 -1
  267. package/dist/functions/vestingTerms/index.d.ts +1 -1
  268. package/dist/functions/vestingTerms/index.d.ts.map +1 -1
  269. package/dist/functions/vestingTerms/index.js +1 -1
  270. package/dist/functions/vestingTerms/index.js.map +1 -1
  271. package/dist/functions/warrantIssuance/archiveWarrantIssuanceByIssuer.d.ts +1 -1
  272. package/dist/functions/warrantIssuance/archiveWarrantIssuanceByIssuer.d.ts.map +1 -1
  273. package/dist/functions/warrantIssuance/archiveWarrantIssuanceByIssuer.js +2 -2
  274. package/dist/functions/warrantIssuance/archiveWarrantIssuanceByIssuer.js.map +1 -1
  275. package/dist/functions/warrantIssuance/createWarrantIssuance.d.ts +2 -2
  276. package/dist/functions/warrantIssuance/createWarrantIssuance.d.ts.map +1 -1
  277. package/dist/functions/warrantIssuance/createWarrantIssuance.js +56 -43
  278. package/dist/functions/warrantIssuance/createWarrantIssuance.js.map +1 -1
  279. package/dist/functions/warrantIssuance/getWarrantIssuanceAsOcf.d.ts +17 -17
  280. package/dist/functions/warrantIssuance/getWarrantIssuanceAsOcf.d.ts.map +1 -1
  281. package/dist/functions/warrantIssuance/getWarrantIssuanceAsOcf.js +100 -48
  282. package/dist/functions/warrantIssuance/getWarrantIssuanceAsOcf.js.map +1 -1
  283. package/dist/functions/warrantIssuance/index.d.ts +1 -1
  284. package/dist/functions/warrantIssuance/index.d.ts.map +1 -1
  285. package/dist/functions/warrantIssuance/index.js +1 -1
  286. package/dist/functions/warrantIssuance/index.js.map +1 -1
  287. package/dist/index.d.ts +1 -1
  288. package/dist/index.js +1 -1
  289. package/dist/types/index.d.ts +3 -3
  290. package/dist/types/index.d.ts.map +1 -1
  291. package/dist/types/native.d.ts +214 -135
  292. package/dist/types/native.d.ts.map +1 -1
  293. package/dist/types/native.js +2 -3
  294. package/dist/types/native.js.map +1 -1
  295. package/dist/utils/createOcfObject.d.ts +30 -32
  296. package/dist/utils/createOcfObject.d.ts.map +1 -1
  297. package/dist/utils/createOcfObject.js +53 -41
  298. package/dist/utils/createOcfObject.js.map +1 -1
  299. package/dist/utils/index.d.ts +4 -1
  300. package/dist/utils/index.d.ts.map +1 -1
  301. package/dist/utils/index.js +5 -0
  302. package/dist/utils/index.js.map +1 -1
  303. package/dist/utils/ocfMetadata.d.ts +19 -0
  304. package/dist/utils/ocfMetadata.d.ts.map +1 -0
  305. package/dist/utils/ocfMetadata.js +83 -0
  306. package/dist/utils/ocfMetadata.js.map +1 -0
  307. package/dist/utils/transactionHelpers.d.ts +58 -0
  308. package/dist/utils/transactionHelpers.d.ts.map +1 -0
  309. package/dist/utils/transactionHelpers.js +121 -0
  310. package/dist/utils/transactionHelpers.js.map +1 -0
  311. package/dist/utils/typeConversions.d.ts +32 -11
  312. package/dist/utils/typeConversions.d.ts.map +1 -1
  313. package/dist/utils/typeConversions.js +97 -22
  314. package/dist/utils/typeConversions.js.map +1 -1
  315. package/package.json +27 -12
@@ -1,5 +1,5 @@
1
- import { DisclosedContract } from '@fairmint/canton-node-sdk/build/src/clients/ledger-json-api/schemas/api/commands';
2
- import { OcfStockClassData, CommandWithDisclosedContracts } from '../../types';
1
+ import type { DisclosedContract } from '@fairmint/canton-node-sdk/build/src/clients/ledger-json-api/schemas/api/commands';
2
+ import type { CommandWithDisclosedContracts, OcfStockClassData } from '../../types';
3
3
  export interface CreateStockClassParams {
4
4
  /** Contract ID of the Issuer contract */
5
5
  issuerContractId: string;
@@ -11,20 +11,24 @@ export interface CreateStockClassParams {
11
11
  * Stock class data to create
12
12
  *
13
13
  * Schema: https://schema.opencaptablecoalition.com/v/1.2.0/objects/StockClass.schema.json
14
- * - name: Name for the stock type (e.g. Series A Preferred or Class A Common)
15
- * - class_type: The type of this stock class (e.g. Preferred or Common)
16
- * - default_id_prefix: Default prefix for certificate numbers in certificated shares (e.g. CS- in CS-1). If certificate IDs have a dash, the prefix should end in the dash like CS-
17
- * - initial_shares_authorized: The initial number of shares authorized for this stock class
18
- * - board_approval_date (optional): Date on which the board approved the stock class (YYYY-MM-DD)
19
- * - stockholder_approval_date (optional): Date on which the stockholders approved the stock class (YYYY-MM-DD)
20
- * - votes_per_share: The number of votes each share of this stock class gets
21
- * - par_value (optional): Per-share par value of this stock class
22
- * - price_per_share (optional): Per-share price this stock class was issued for
23
- * - seniority: Seniority of the stock - determines repayment priority. Seniority is ordered by increasing number so that stock classes with a higher seniority have higher repayment priority. Multiple stock classes can share the same seniority.
24
- * - conversion_rights (optional): List of stock class conversion rights possible for this stock class
25
- * - liquidation_preference_multiple (optional): The liquidation preference per share for this stock class
26
- * - participation_cap_multiple (optional): The participation cap multiple per share for this stock class
27
- * - comments (optional): Additional comments or notes about the stock class
14
+ *
15
+ * - Name: Name for the stock type (e.g. Series A Preferred or Class A Common)
16
+ * - Class_type: The type of this stock class (e.g. Preferred or Common)
17
+ * - Default_id_prefix: Default prefix for certificate numbers in certificated shares (e.g. CS- in CS-1). If certificate
18
+ * IDs have a dash, the prefix should end in the dash like CS-
19
+ * - Initial_shares_authorized: The initial number of shares authorized for this stock class
20
+ * - Board_approval_date (optional): Date on which the board approved the stock class (YYYY-MM-DD)
21
+ * - Stockholder_approval_date (optional): Date on which the stockholders approved the stock class (YYYY-MM-DD)
22
+ * - Votes_per_share: The number of votes each share of this stock class gets
23
+ * - Par_value (optional): Per-share par value of this stock class
24
+ * - Price_per_share (optional): Per-share price this stock class was issued for
25
+ * - Seniority: Seniority of the stock - determines repayment priority. Seniority is ordered by increasing number so
26
+ * that stock classes with a higher seniority have higher repayment priority. Multiple stock classes can share the
27
+ * same seniority.
28
+ * - Conversion_rights (optional): List of stock class conversion rights possible for this stock class
29
+ * - Liquidation_preference_multiple (optional): The liquidation preference per share for this stock class
30
+ * - Participation_cap_multiple (optional): The participation cap multiple per share for this stock class
31
+ * - Comments (optional): Additional comments or notes about the stock class
28
32
  */
29
33
  stockClassData: OcfStockClassData;
30
34
  }
@@ -1 +1 @@
1
- {"version":3,"file":"createStockClass.d.ts","sourceRoot":"","sources":["../../../src/functions/stockClass/createStockClass.ts"],"names":[],"mappings":"AAGA,OAAO,EAAW,iBAAiB,EAAE,MAAM,kFAAkF,CAAC;AAC9H,OAAO,EAAE,iBAAiB,EAAE,6BAA6B,EAAkB,MAAM,aAAa,CAAC;AA4F/F,MAAM,WAAW,sBAAsB;IACrC,yCAAyC;IACzC,gBAAgB,EAAE,MAAM,CAAC;IACzB,uEAAuE;IACvE,+BAA+B,EAAE,iBAAiB,CAAC;IACnD,4CAA4C;IAC5C,WAAW,EAAE,MAAM,CAAC;IACpB;;;;;;;;;;;;;;;;;;OAkBG;IACH,cAAc,EAAE,iBAAiB,CAAC;CACnC;AAED,wBAAgB,4BAA4B,CAAC,MAAM,EAAE,sBAAsB,GAAG,6BAA6B,CAwB1G"}
1
+ {"version":3,"file":"createStockClass.d.ts","sourceRoot":"","sources":["../../../src/functions/stockClass/createStockClass.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAEV,iBAAiB,EAClB,MAAM,kFAAkF,CAAC;AAE1F,OAAO,KAAK,EAAE,6BAA6B,EAAE,iBAAiB,EAAkB,MAAM,aAAa,CAAC;AA0IpG,MAAM,WAAW,sBAAsB;IACrC,yCAAyC;IACzC,gBAAgB,EAAE,MAAM,CAAC;IACzB,uEAAuE;IACvE,+BAA+B,EAAE,iBAAiB,CAAC;IACnD,4CAA4C;IAC5C,WAAW,EAAE,MAAM,CAAC;IACpB;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,cAAc,EAAE,iBAAiB,CAAC;CACnC;AAED,wBAAgB,4BAA4B,CAAC,MAAM,EAAE,sBAAsB,GAAG,6BAA6B,CAwB1G"}
@@ -9,30 +9,31 @@ function stockClassTypeToDaml(stockClassType) {
9
9
  return 'OcfStockClassTypePreferred';
10
10
  case 'COMMON':
11
11
  return 'OcfStockClassTypeCommon';
12
- default:
13
- throw new Error(`Unknown stock class type: ${stockClassType}`);
12
+ default: {
13
+ const exhaustiveCheck = stockClassType;
14
+ throw new Error(`Unknown stock class type: ${String(exhaustiveCheck)}`);
15
+ }
14
16
  }
15
17
  }
16
18
  function stockClassDataToDaml(stockClassData) {
17
- if (!stockClassData.id)
19
+ const d = stockClassData;
20
+ if (!d.id)
18
21
  throw new Error('stockClassData.id is required');
19
22
  return {
20
- id: stockClassData.id,
21
- name: stockClassData.name,
22
- class_type: stockClassTypeToDaml(stockClassData.class_type),
23
- default_id_prefix: stockClassData.default_id_prefix,
24
- initial_shares_authorized: typeof stockClassData.initial_shares_authorized === 'number'
25
- ? stockClassData.initial_shares_authorized.toString()
26
- : stockClassData.initial_shares_authorized,
27
- votes_per_share: typeof stockClassData.votes_per_share === 'number' ?
28
- stockClassData.votes_per_share.toString() : stockClassData.votes_per_share,
29
- seniority: typeof stockClassData.seniority === 'number' ?
30
- stockClassData.seniority.toString() : stockClassData.seniority,
31
- board_approval_date: stockClassData.board_approval_date ? (0, typeConversions_1.dateStringToDAMLTime)(stockClassData.board_approval_date) : null,
32
- stockholder_approval_date: stockClassData.stockholder_approval_date ? (0, typeConversions_1.dateStringToDAMLTime)(stockClassData.stockholder_approval_date) : null,
33
- par_value: stockClassData.par_value ? (0, typeConversions_1.monetaryToDaml)(stockClassData.par_value) : null,
34
- price_per_share: stockClassData.price_per_share ? (0, typeConversions_1.monetaryToDaml)(stockClassData.price_per_share) : null,
35
- conversion_rights: (stockClassData.conversion_rights || []).map((right) => {
23
+ id: d.id,
24
+ name: d.name,
25
+ class_type: stockClassTypeToDaml(d.class_type),
26
+ default_id_prefix: d.default_id_prefix,
27
+ initial_shares_authorized: typeof d.initial_shares_authorized === 'number'
28
+ ? d.initial_shares_authorized.toString()
29
+ : d.initial_shares_authorized,
30
+ votes_per_share: typeof d.votes_per_share === 'number' ? d.votes_per_share.toString() : d.votes_per_share,
31
+ seniority: typeof d.seniority === 'number' ? d.seniority.toString() : d.seniority,
32
+ board_approval_date: d.board_approval_date ? (0, typeConversions_1.dateStringToDAMLTime)(d.board_approval_date) : null,
33
+ stockholder_approval_date: d.stockholder_approval_date ? (0, typeConversions_1.dateStringToDAMLTime)(d.stockholder_approval_date) : null,
34
+ par_value: d.par_value ? (0, typeConversions_1.monetaryToDaml)(d.par_value) : null,
35
+ price_per_share: d.price_per_share ? (0, typeConversions_1.monetaryToDaml)(d.price_per_share) : null,
36
+ conversion_rights: (d.conversion_rights ?? []).map((right) => {
36
37
  const mechanism = right.conversion_mechanism === 'RATIO_CONVERSION'
37
38
  ? 'OcfConversionMechanismRatioConversion'
38
39
  : right.conversion_mechanism === 'PERCENT_CONVERSION'
@@ -55,10 +56,13 @@ function stockClassDataToDaml(stockClassData) {
55
56
  }
56
57
  })();
57
58
  let ratio = null;
58
- const numerator = right.ratio_numerator ?? (right.ratio !== undefined ? right.ratio : undefined);
59
+ const numerator = right.ratio_numerator ?? right.ratio;
59
60
  const denominator = right.ratio_denominator ?? (right.ratio !== undefined ? 1 : undefined);
60
61
  if (numerator !== undefined && denominator !== undefined) {
61
- ratio = { numerator: typeof numerator === 'number' ? numerator.toString() : String(numerator), denominator: typeof denominator === 'number' ? denominator.toString() : String(denominator) };
62
+ ratio = {
63
+ numerator: typeof numerator === 'number' ? numerator.toString() : String(numerator),
64
+ denominator: typeof denominator === 'number' ? denominator.toString() : String(denominator),
65
+ };
62
66
  }
63
67
  return {
64
68
  type_: right.type,
@@ -66,46 +70,74 @@ function stockClassDataToDaml(stockClassData) {
66
70
  conversion_trigger: trigger,
67
71
  converts_to_stock_class_id: right.converts_to_stock_class_id,
68
72
  ratio: ratio ? { tag: 'Some', value: ratio } : null,
69
- percent_of_capitalization: right.percent_of_capitalization !== undefined ? { tag: 'Some', value: typeof right.percent_of_capitalization === 'number' ? right.percent_of_capitalization.toString() : String(right.percent_of_capitalization) } : null,
70
- conversion_price: right.conversion_price ? { tag: 'Some', value: (0, typeConversions_1.monetaryToDaml)(right.conversion_price) } : null,
71
- reference_share_price: right.reference_share_price ? { tag: 'Some', value: (0, typeConversions_1.monetaryToDaml)(right.reference_share_price) } : null,
72
- reference_valuation_price_per_share: right.reference_valuation_price_per_share ? { tag: 'Some', value: (0, typeConversions_1.monetaryToDaml)(right.reference_valuation_price_per_share) } : null,
73
- discount_rate: right.discount_rate !== undefined ? { tag: 'Some', value: typeof right.discount_rate === 'number' ? right.discount_rate.toString() : String(right.discount_rate) } : null,
73
+ percent_of_capitalization: right.percent_of_capitalization !== undefined
74
+ ? {
75
+ tag: 'Some',
76
+ value: typeof right.percent_of_capitalization === 'number'
77
+ ? right.percent_of_capitalization.toString()
78
+ : String(right.percent_of_capitalization),
79
+ }
80
+ : null,
81
+ conversion_price: right.conversion_price
82
+ ? { tag: 'Some', value: (0, typeConversions_1.monetaryToDaml)(right.conversion_price) }
83
+ : null,
84
+ reference_share_price: right.reference_share_price
85
+ ? { tag: 'Some', value: (0, typeConversions_1.monetaryToDaml)(right.reference_share_price) }
86
+ : null,
87
+ reference_valuation_price_per_share: right.reference_valuation_price_per_share
88
+ ? { tag: 'Some', value: (0, typeConversions_1.monetaryToDaml)(right.reference_valuation_price_per_share) }
89
+ : null,
90
+ discount_rate: right.discount_rate !== undefined
91
+ ? {
92
+ tag: 'Some',
93
+ value: typeof right.discount_rate === 'number'
94
+ ? right.discount_rate.toString()
95
+ : String(right.discount_rate),
96
+ }
97
+ : null,
74
98
  valuation_cap: right.valuation_cap ? { tag: 'Some', value: (0, typeConversions_1.monetaryToDaml)(right.valuation_cap) } : null,
75
- floor_price_per_share: right.floor_price_per_share ? { tag: 'Some', value: (0, typeConversions_1.monetaryToDaml)(right.floor_price_per_share) } : null,
76
- ceiling_price_per_share: right.ceiling_price_per_share ? { tag: 'Some', value: (0, typeConversions_1.monetaryToDaml)(right.ceiling_price_per_share) } : null,
99
+ floor_price_per_share: right.floor_price_per_share
100
+ ? { tag: 'Some', value: (0, typeConversions_1.monetaryToDaml)(right.floor_price_per_share) }
101
+ : null,
102
+ ceiling_price_per_share: right.ceiling_price_per_share
103
+ ? { tag: 'Some', value: (0, typeConversions_1.monetaryToDaml)(right.ceiling_price_per_share) }
104
+ : null,
77
105
  custom_description: right.custom_description ? { tag: 'Some', value: right.custom_description } : null,
78
- expires_at: right.expires_at ? (0, typeConversions_1.dateStringToDAMLTime)(right.expires_at) : null
106
+ expires_at: right.expires_at ? (0, typeConversions_1.dateStringToDAMLTime)(right.expires_at) : null,
79
107
  };
80
108
  }),
81
- liquidation_preference_multiple: stockClassData.liquidation_preference_multiple ?
82
- (typeof stockClassData.liquidation_preference_multiple === 'number' ?
83
- stockClassData.liquidation_preference_multiple.toString() : stockClassData.liquidation_preference_multiple) : null,
84
- participation_cap_multiple: stockClassData.participation_cap_multiple ?
85
- (typeof stockClassData.participation_cap_multiple === 'number' ?
86
- stockClassData.participation_cap_multiple.toString() : stockClassData.participation_cap_multiple) : null,
87
- comments: stockClassData.comments || []
109
+ liquidation_preference_multiple: d.liquidation_preference_multiple
110
+ ? typeof d.liquidation_preference_multiple === 'number'
111
+ ? d.liquidation_preference_multiple.toString()
112
+ : d.liquidation_preference_multiple
113
+ : null,
114
+ participation_cap_multiple: d.participation_cap_multiple
115
+ ? typeof d.participation_cap_multiple === 'number'
116
+ ? d.participation_cap_multiple.toString()
117
+ : d.participation_cap_multiple
118
+ : null,
119
+ comments: (0, typeConversions_1.cleanComments)(d.comments),
88
120
  };
89
121
  }
90
122
  function buildCreateStockClassCommand(params) {
91
123
  const choiceArguments = {
92
- stock_class_data: stockClassDataToDaml(params.stockClassData)
124
+ stock_class_data: stockClassDataToDaml(params.stockClassData),
93
125
  };
94
126
  const command = {
95
127
  ExerciseCommand: {
96
128
  templateId: open_captable_protocol_daml_js_1.Fairmint.OpenCapTable.Issuer.Issuer.templateId,
97
129
  contractId: params.issuerContractId,
98
130
  choice: 'CreateStockClass',
99
- choiceArgument: choiceArguments
100
- }
131
+ choiceArgument: choiceArguments,
132
+ },
101
133
  };
102
134
  const disclosedContracts = [
103
135
  {
104
136
  templateId: params.featuredAppRightContractDetails.templateId,
105
137
  contractId: params.featuredAppRightContractDetails.contractId,
106
138
  createdEventBlob: params.featuredAppRightContractDetails.createdEventBlob,
107
- synchronizerId: params.featuredAppRightContractDetails.synchronizerId
108
- }
139
+ synchronizerId: params.featuredAppRightContractDetails.synchronizerId,
140
+ },
109
141
  ];
110
142
  return { command, disclosedContracts };
111
143
  }
@@ -1 +1 @@
1
- {"version":3,"file":"createStockClass.js","sourceRoot":"","sources":["../../../src/functions/stockClass/createStockClass.ts"],"names":[],"mappings":";;AA6HA,oEAwBC;AArJD,6FAAoE;AAKpE,iEAAmF;AAEnF,SAAS,oBAAoB,CAAC,cAA8B;IAC1D,QAAQ,cAAc,EAAE,CAAC;QACvB,KAAK,WAAW;YACd,OAAO,4BAA4B,CAAC;QACtC,KAAK,QAAQ;YACX,OAAO,yBAAyB,CAAC;QACnC;YACE,MAAM,IAAI,KAAK,CAAC,6BAA6B,cAAc,EAAE,CAAC,CAAC;IACnE,CAAC;AACH,CAAC;AAED,SAAS,oBAAoB,CAAC,cAAiC;IAC7D,IAAI,CAAC,cAAc,CAAC,EAAE;QAAE,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAC;IACzE,OAAO;QACL,EAAE,EAAE,cAAc,CAAC,EAAE;QACrB,IAAI,EAAE,cAAc,CAAC,IAAI;QACzB,UAAU,EAAE,oBAAoB,CAAC,cAAc,CAAC,UAAU,CAAC;QAC3D,iBAAiB,EAAE,cAAc,CAAC,iBAAiB;QACnD,yBAAyB,EAAE,OAAO,cAAc,CAAC,yBAAyB,KAAK,QAAQ;YACrF,CAAC,CAAC,cAAc,CAAC,yBAAyB,CAAC,QAAQ,EAAE;YACrD,CAAC,CAAC,cAAc,CAAC,yBAAyB;QAC5C,eAAe,EAAE,OAAO,cAAc,CAAC,eAAe,KAAK,QAAQ,CAAC,CAAC;YACnE,cAAc,CAAC,eAAe,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,cAAc,CAAC,eAAe;QAC5E,SAAS,EAAE,OAAO,cAAc,CAAC,SAAS,KAAK,QAAQ,CAAC,CAAC;YACvD,cAAc,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,cAAc,CAAC,SAAS;QAChE,mBAAmB,EAAE,cAAc,CAAC,mBAAmB,CAAC,CAAC,CAAC,IAAA,sCAAoB,EAAC,cAAc,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,IAAI;QACzH,yBAAyB,EAAE,cAAc,CAAC,yBAAyB,CAAC,CAAC,CAAC,IAAA,sCAAoB,EAAC,cAAc,CAAC,yBAAyB,CAAC,CAAC,CAAC,CAAC,IAAI;QAC3I,SAAS,EAAE,cAAc,CAAC,SAAS,CAAC,CAAC,CAAC,IAAA,gCAAc,EAAC,cAAc,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI;QACrF,eAAe,EAAE,cAAc,CAAC,eAAe,CAAC,CAAC,CAAC,IAAA,gCAAc,EAAC,cAAc,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,IAAI;QACvG,iBAAiB,EAAE,CAAC,cAAc,CAAC,iBAAiB,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;YACxE,MAAM,SAAS,GACb,KAAK,CAAC,oBAAoB,KAAK,kBAAkB;gBAC/C,CAAC,CAAC,uCAAuC;gBACzC,CAAC,CAAC,KAAK,CAAC,oBAAoB,KAAK,oBAAoB;oBACrD,CAAC,CAAC,uDAAuD;oBACzD,CAAC,CAAC,6CAA6C,CAAC;YAEpD,MAAM,OAAO,GAAQ,CAAC,GAAG,EAAE;gBACzB,QAAQ,KAAK,CAAC,kBAAkB,EAAE,CAAC;oBACjC,KAAK,wBAAwB;wBAC3B,OAAO,oCAAoC,CAAC;oBAC9C,KAAK,mBAAmB;wBACtB,OAAO,+BAA+B,CAAC;oBACzC,KAAK,kBAAkB;wBACrB,OAAO,8BAA8B,CAAC;oBACxC,KAAK,uBAAuB;wBAC1B,OAAO,mCAAmC,CAAC;oBAC7C,KAAK,kBAAkB;wBACrB,OAAO,8BAA8B,CAAC;oBACxC;wBACE,OAAO,oCAAoC,CAAC;gBAChD,CAAC;YACH,CAAC,CAAC,EAAE,CAAC;YAEL,IAAI,KAAK,GAAsD,IAAI,CAAC;YACpE,MAAM,SAAS,GAAG,KAAK,CAAC,eAAe,IAAI,CAAC,KAAK,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;YACjG,MAAM,WAAW,GAAG,KAAK,CAAC,iBAAiB,IAAI,CAAC,KAAK,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;YAC3F,IAAI,SAAS,KAAK,SAAS,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;gBACzD,KAAK,GAAG,EAAE,SAAS,EAAE,OAAO,SAAS,KAAK,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,WAAW,EAAE,OAAO,WAAW,KAAK,QAAQ,CAAC,CAAC,CAAC,WAAW,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,WAAW,CAAC,EAAE,CAAC;YAC/L,CAAC;YAED,OAAO;gBACL,KAAK,EAAE,KAAK,CAAC,IAAI;gBACjB,oBAAoB,EAAE,SAAS;gBAC/B,kBAAkB,EAAE,OAAO;gBAC3B,0BAA0B,EAAE,KAAK,CAAC,0BAA0B;gBAC5D,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,IAAI;gBACnD,yBAAyB,EAAE,KAAK,CAAC,yBAAyB,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,KAAK,CAAC,yBAAyB,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,yBAAyB,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,yBAAyB,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI;gBACpP,gBAAgB,EAAE,KAAK,CAAC,gBAAgB,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,IAAA,gCAAc,EAAC,KAAK,CAAC,gBAAgB,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI;gBAChH,qBAAqB,EAAE,KAAK,CAAC,qBAAqB,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,IAAA,gCAAc,EAAC,KAAK,CAAC,qBAAqB,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI;gBAC/H,mCAAmC,EAAE,KAAK,CAAC,mCAAmC,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,IAAA,gCAAc,EAAC,KAAK,CAAC,mCAAmC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI;gBACzK,aAAa,EAAE,KAAK,CAAC,aAAa,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,KAAK,CAAC,aAAa,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,aAAa,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI;gBACxL,aAAa,EAAE,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,IAAA,gCAAc,EAAC,KAAK,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI;gBACvG,qBAAqB,EAAE,KAAK,CAAC,qBAAqB,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,IAAA,gCAAc,EAAC,KAAK,CAAC,qBAAqB,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI;gBAC/H,uBAAuB,EAAE,KAAK,CAAC,uBAAuB,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,IAAA,gCAAc,EAAC,KAAK,CAAC,uBAAuB,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI;gBACrI,kBAAkB,EAAE,KAAK,CAAC,kBAAkB,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,CAAC,kBAAkB,EAAE,CAAC,CAAC,CAAC,IAAI;gBACtG,UAAU,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,IAAA,sCAAoB,EAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,IAAI;aAC7E,CAAC;QACJ,CAAC,CAAC;QACF,+BAA+B,EAAE,cAAc,CAAC,+BAA+B,CAAC,CAAC;YAC/E,CAAC,OAAO,cAAc,CAAC,+BAA+B,KAAK,QAAQ,CAAC,CAAC;gBACnE,cAAc,CAAC,+BAA+B,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,cAAc,CAAC,+BAA+B,CAAC,CAAC,CAAC,CAAC,IAAI;QACtH,0BAA0B,EAAE,cAAc,CAAC,0BAA0B,CAAC,CAAC;YACrE,CAAC,OAAO,cAAc,CAAC,0BAA0B,KAAK,QAAQ,CAAC,CAAC;gBAC9D,cAAc,CAAC,0BAA0B,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,cAAc,CAAC,0BAA0B,CAAC,CAAC,CAAC,CAAC,IAAI;QAC5G,QAAQ,EAAE,cAAc,CAAC,QAAQ,IAAI,EAAE;KACxC,CAAC;AACJ,CAAC;AA+BD,SAAgB,4BAA4B,CAAC,MAA8B;IACzE,MAAM,eAAe,GAAkD;QACrE,gBAAgB,EAAE,oBAAoB,CAAC,MAAM,CAAC,cAAc,CAAC;KAC9D,CAAC;IAEF,MAAM,OAAO,GAAY;QACvB,eAAe,EAAE;YACf,UAAU,EAAE,yCAAQ,CAAC,YAAY,CAAC,MAAM,CAAC,MAAM,CAAC,UAAU;YAC1D,UAAU,EAAE,MAAM,CAAC,gBAAgB;YACnC,MAAM,EAAE,kBAAkB;YAC1B,cAAc,EAAE,eAAsB;SACvC;KACF,CAAC;IAEF,MAAM,kBAAkB,GAAwB;QAC9C;YACE,UAAU,EAAE,MAAM,CAAC,+BAA+B,CAAC,UAAU;YAC7D,UAAU,EAAE,MAAM,CAAC,+BAA+B,CAAC,UAAU;YAC7D,gBAAgB,EAAE,MAAM,CAAC,+BAA+B,CAAC,gBAAgB;YACzE,cAAc,EAAE,MAAM,CAAC,+BAA+B,CAAC,cAAc;SACtE;KACF,CAAC;IAEF,OAAO,EAAE,OAAO,EAAE,kBAAkB,EAAE,CAAC;AACzC,CAAC"}
1
+ {"version":3,"file":"createStockClass.js","sourceRoot":"","sources":["../../../src/functions/stockClass/createStockClass.ts"],"names":[],"mappings":";;AAgLA,oEAwBC;AApMD,6FAAoE;AAEpE,iEAAkG;AAElG,SAAS,oBAAoB,CAC3B,cAA8B;IAE9B,QAAQ,cAAc,EAAE,CAAC;QACvB,KAAK,WAAW;YACd,OAAO,4BAA4B,CAAC;QACtC,KAAK,QAAQ;YACX,OAAO,yBAAyB,CAAC;QACnC,OAAO,CAAC,CAAC,CAAC;YACR,MAAM,eAAe,GAAU,cAAc,CAAC;YAC9C,MAAM,IAAI,KAAK,CAAC,6BAA6B,MAAM,CAAC,eAAe,CAAC,EAAE,CAAC,CAAC;QAC1E,CAAC;IACH,CAAC;AACH,CAAC;AAED,SAAS,oBAAoB,CAAC,cAAiC;IAC7D,MAAM,CAAC,GAAG,cAAc,CAAC;IACzB,IAAI,CAAC,CAAC,CAAC,EAAE;QAAE,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAC;IAC5D,OAAO;QACL,EAAE,EAAE,CAAC,CAAC,EAAE;QACR,IAAI,EAAE,CAAC,CAAC,IAAI;QACZ,UAAU,EAAE,oBAAoB,CAAC,CAAC,CAAC,UAAU,CAAC;QAC9C,iBAAiB,EAAE,CAAC,CAAC,iBAAiB;QACtC,yBAAyB,EACvB,OAAO,CAAC,CAAC,yBAAyB,KAAK,QAAQ;YAC7C,CAAC,CAAC,CAAC,CAAC,yBAAyB,CAAC,QAAQ,EAAE;YACxC,CAAC,CAAC,CAAC,CAAC,yBAAyB;QACjC,eAAe,EAAE,OAAO,CAAC,CAAC,eAAe,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,eAAe,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,eAAe;QACzG,SAAS,EAAE,OAAO,CAAC,CAAC,SAAS,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS;QACjF,mBAAmB,EAAE,CAAC,CAAC,mBAAmB,CAAC,CAAC,CAAC,IAAA,sCAAoB,EAAC,CAAC,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,IAAI;QAC/F,yBAAyB,EAAE,CAAC,CAAC,yBAAyB,CAAC,CAAC,CAAC,IAAA,sCAAoB,EAAC,CAAC,CAAC,yBAAyB,CAAC,CAAC,CAAC,CAAC,IAAI;QACjH,SAAS,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAA,gCAAc,EAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI;QAC3D,eAAe,EAAE,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,IAAA,gCAAc,EAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,IAAI;QAC7E,iBAAiB,EAAE,CAAC,CAAC,CAAC,iBAAiB,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;YAC3D,MAAM,SAAS,GAIb,KAAK,CAAC,oBAAoB,KAAK,kBAAkB;gBAC/C,CAAC,CAAC,uCAAuC;gBACzC,CAAC,CAAC,KAAK,CAAC,oBAAoB,KAAK,oBAAoB;oBACnD,CAAC,CAAC,uDAAuD;oBACzD,CAAC,CAAC,6CAA6C,CAAC;YAEtD,MAAM,OAAO,GAI6B,CAAC,GAAG,EAAE;gBAC9C,QAAQ,KAAK,CAAC,kBAAkB,EAAE,CAAC;oBACjC,KAAK,wBAAwB;wBAC3B,OAAO,oCAAoC,CAAC;oBAC9C,KAAK,mBAAmB;wBACtB,OAAO,+BAA+B,CAAC;oBACzC,KAAK,kBAAkB;wBACrB,OAAO,8BAA8B,CAAC;oBACxC,KAAK,uBAAuB;wBAC1B,OAAO,mCAAmC,CAAC;oBAC7C,KAAK,kBAAkB;wBACrB,OAAO,8BAA8B,CAAC;oBACxC;wBACE,OAAO,oCAAoC,CAAC;gBAChD,CAAC;YACH,CAAC,CAAC,EAAE,CAAC;YAEL,IAAI,KAAK,GAAsD,IAAI,CAAC;YACpE,MAAM,SAAS,GAAG,KAAK,CAAC,eAAe,IAAI,KAAK,CAAC,KAAK,CAAC;YACvD,MAAM,WAAW,GAAG,KAAK,CAAC,iBAAiB,IAAI,CAAC,KAAK,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;YAC3F,IAAI,SAAS,KAAK,SAAS,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;gBACzD,KAAK,GAAG;oBACN,SAAS,EAAE,OAAO,SAAS,KAAK,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC;oBACnF,WAAW,EAAE,OAAO,WAAW,KAAK,QAAQ,CAAC,CAAC,CAAC,WAAW,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,WAAW,CAAC;iBAC5F,CAAC;YACJ,CAAC;YAED,OAAO;gBACL,KAAK,EAAE,KAAK,CAAC,IAAI;gBACjB,oBAAoB,EAAE,SAAS;gBAC/B,kBAAkB,EAAE,OAAO;gBAC3B,0BAA0B,EAAE,KAAK,CAAC,0BAA0B;gBAC5D,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,IAAI;gBACnD,yBAAyB,EACvB,KAAK,CAAC,yBAAyB,KAAK,SAAS;oBAC3C,CAAC,CAAC;wBACE,GAAG,EAAE,MAAM;wBACX,KAAK,EACH,OAAO,KAAK,CAAC,yBAAyB,KAAK,QAAQ;4BACjD,CAAC,CAAC,KAAK,CAAC,yBAAyB,CAAC,QAAQ,EAAE;4BAC5C,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,yBAAyB,CAAC;qBAC9C;oBACH,CAAC,CAAC,IAAI;gBACV,gBAAgB,EAAE,KAAK,CAAC,gBAAgB;oBACtC,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,IAAA,gCAAc,EAAC,KAAK,CAAC,gBAAgB,CAAC,EAAE;oBAChE,CAAC,CAAC,IAAI;gBACR,qBAAqB,EAAE,KAAK,CAAC,qBAAqB;oBAChD,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,IAAA,gCAAc,EAAC,KAAK,CAAC,qBAAqB,CAAC,EAAE;oBACrE,CAAC,CAAC,IAAI;gBACR,mCAAmC,EAAE,KAAK,CAAC,mCAAmC;oBAC5E,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,IAAA,gCAAc,EAAC,KAAK,CAAC,mCAAmC,CAAC,EAAE;oBACnF,CAAC,CAAC,IAAI;gBACR,aAAa,EACX,KAAK,CAAC,aAAa,KAAK,SAAS;oBAC/B,CAAC,CAAC;wBACE,GAAG,EAAE,MAAM;wBACX,KAAK,EACH,OAAO,KAAK,CAAC,aAAa,KAAK,QAAQ;4BACrC,CAAC,CAAC,KAAK,CAAC,aAAa,CAAC,QAAQ,EAAE;4BAChC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,aAAa,CAAC;qBAClC;oBACH,CAAC,CAAC,IAAI;gBACV,aAAa,EAAE,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,IAAA,gCAAc,EAAC,KAAK,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI;gBACvG,qBAAqB,EAAE,KAAK,CAAC,qBAAqB;oBAChD,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,IAAA,gCAAc,EAAC,KAAK,CAAC,qBAAqB,CAAC,EAAE;oBACrE,CAAC,CAAC,IAAI;gBACR,uBAAuB,EAAE,KAAK,CAAC,uBAAuB;oBACpD,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,IAAA,gCAAc,EAAC,KAAK,CAAC,uBAAuB,CAAC,EAAE;oBACvE,CAAC,CAAC,IAAI;gBACR,kBAAkB,EAAE,KAAK,CAAC,kBAAkB,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,CAAC,kBAAkB,EAAE,CAAC,CAAC,CAAC,IAAI;gBACtG,UAAU,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,IAAA,sCAAoB,EAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,IAAI;aAC7E,CAAC;QACJ,CAAC,CAAC;QACF,+BAA+B,EAAE,CAAC,CAAC,+BAA+B;YAChE,CAAC,CAAC,OAAO,CAAC,CAAC,+BAA+B,KAAK,QAAQ;gBACrD,CAAC,CAAC,CAAC,CAAC,+BAA+B,CAAC,QAAQ,EAAE;gBAC9C,CAAC,CAAC,CAAC,CAAC,+BAA+B;YACrC,CAAC,CAAC,IAAI;QACR,0BAA0B,EAAE,CAAC,CAAC,0BAA0B;YACtD,CAAC,CAAC,OAAO,CAAC,CAAC,0BAA0B,KAAK,QAAQ;gBAChD,CAAC,CAAC,CAAC,CAAC,0BAA0B,CAAC,QAAQ,EAAE;gBACzC,CAAC,CAAC,CAAC,CAAC,0BAA0B;YAChC,CAAC,CAAC,IAAI;QACR,QAAQ,EAAE,IAAA,+BAAa,EAAC,CAAC,CAAC,QAAQ,CAAC;KACpC,CAAC;AACJ,CAAC;AAmCD,SAAgB,4BAA4B,CAAC,MAA8B;IACzE,MAAM,eAAe,GAAG;QACtB,gBAAgB,EAAE,oBAAoB,CAAC,MAAM,CAAC,cAAc,CAAC;KAC9D,CAAC;IAEF,MAAM,OAAO,GAAY;QACvB,eAAe,EAAE;YACf,UAAU,EAAE,yCAAQ,CAAC,YAAY,CAAC,MAAM,CAAC,MAAM,CAAC,UAAU;YAC1D,UAAU,EAAE,MAAM,CAAC,gBAAgB;YACnC,MAAM,EAAE,kBAAkB;YAC1B,cAAc,EAAE,eAAe;SAChC;KACF,CAAC;IAEF,MAAM,kBAAkB,GAAwB;QAC9C;YACE,UAAU,EAAE,MAAM,CAAC,+BAA+B,CAAC,UAAU;YAC7D,UAAU,EAAE,MAAM,CAAC,+BAA+B,CAAC,UAAU;YAC7D,gBAAgB,EAAE,MAAM,CAAC,+BAA+B,CAAC,gBAAgB;YACzE,cAAc,EAAE,MAAM,CAAC,+BAA+B,CAAC,cAAc;SACtE;KACF,CAAC;IAEF,OAAO,EAAE,OAAO,EAAE,kBAAkB,EAAE,CAAC;AACzC,CAAC"}
@@ -1,7 +1,8 @@
1
- import { LedgerJsonApiClient } from '@fairmint/canton-node-sdk';
1
+ import type { LedgerJsonApiClient } from '@fairmint/canton-node-sdk';
2
2
  /**
3
- * OCF Stock Class object according to the Open Cap Table Coalition schema
4
- * Object describing a class of stock issued by the issuer
3
+ * OCF Stock Class object according to the Open Cap Table Coalition schema Object describing a class of stock issued by
4
+ * the issuer
5
+ *
5
6
  * @see https://schema.opencaptablecoalition.com/v/1.2.0/objects/StockClass.schema.json
6
7
  */
7
8
  export interface OcfStockClass {
@@ -11,7 +12,10 @@ export interface OcfStockClass {
11
12
  name: string;
12
13
  /** The type of this stock class (e.g. Preferred or Common) */
13
14
  class_type: 'PREFERRED' | 'COMMON';
14
- /** Default prefix for certificate numbers in certificated shares (e.g. CS- in CS-1). If certificate IDs have a dash, the prefix should end in the dash like CS- */
15
+ /**
16
+ * Default prefix for certificate numbers in certificated shares (e.g. CS- in CS-1). If certificate IDs have a dash,
17
+ * the prefix should end in the dash like CS-
18
+ */
15
19
  default_id_prefix: string;
16
20
  /** The initial number of shares authorized for this stock class */
17
21
  initial_shares_authorized: string | number;
@@ -36,10 +40,14 @@ export interface OcfStockClass {
36
40
  currency: string;
37
41
  };
38
42
  /**
39
- * Seniority of the stock - determines repayment priority. Seniority is ordered by increasing number so that stock classes with a higher seniority have higher repayment priority. The following properties hold for all stock classes for a given company:
40
- * a) transitivity: stock classes are absolutely stackable by seniority and in increasing numerical order,
41
- * b) non-uniqueness: multiple stock classes can have the same Seniority number and therefore have the same liquidation/repayment order.
42
- * In practice, stock classes with same seniority may be created at different points in time and (for example, an extension of an existing preferred financing round), and also a new stock class can be created with seniority between two existing stock classes, in which case it is assigned some decimal number between the numbers representing seniority of the respective classes.
43
+ * Seniority of the stock - determines repayment priority. Seniority is ordered by increasing number so that stock
44
+ * classes with a higher seniority have higher repayment priority. The following properties hold for all stock classes
45
+ * for a given company: a) transitivity: stock classes are absolutely stackable by seniority and in increasing
46
+ * numerical order, b) non-uniqueness: multiple stock classes can have the same Seniority number and therefore have
47
+ * the same liquidation/repayment order. In practice, stock classes with same seniority may be created at different
48
+ * points in time and (for example, an extension of an existing preferred financing round), and also a new stock class
49
+ * can be created with seniority between two existing stock classes, in which case it is assigned some decimal number
50
+ * between the numbers representing seniority of the respective classes.
43
51
  */
44
52
  seniority: string | number;
45
53
  /** List of stock class conversion rights possible for this stock class */
@@ -47,7 +55,7 @@ export interface OcfStockClass {
47
55
  /** The type of conversion right */
48
56
  conversion_mechanism: string;
49
57
  /** Additional conversion right details */
50
- [key: string]: any;
58
+ [key: string]: unknown;
51
59
  }>;
52
60
  /** The liquidation preference per share for this stock class */
53
61
  liquidation_preference_multiple?: string | number;
@@ -71,33 +79,32 @@ export interface GetStockClassAsOcfResult {
71
79
  /**
72
80
  * Retrieve a stock class contract by ID and return it as an OCF JSON object
73
81
  *
74
- * This function fetches the stock class contract data from the ledger and transforms it
75
- * into the Open Cap Table Coalition (OCF) format according to the official schema.
76
- *
77
- * @see https://schema.opencaptablecoalition.com/v/1.2.0/objects/StockClass.schema.json
82
+ * This function fetches the stock class contract data from the ledger and transforms it into the Open Cap Table
83
+ * Coalition (OCF) format according to the official schema.
78
84
  *
79
85
  * @example
80
- * ```typescript
81
- * const result = await getStockClassAsOcf(client, {
82
- * contractId: "1234567890abcdef"
83
- * });
86
+ * ```typescript
87
+ * const result = await getStockClassAsOcf(client, {
88
+ * contractId: "1234567890abcdef"
89
+ * });
84
90
  *
85
- * console.log(result.stockClass);
86
- * // {
87
- * // object_type: "STOCK_CLASS",
88
- * // name: "Series A Preferred",
89
- * // class_type: "PREFERRED",
90
- * // default_id_prefix: "SA-",
91
- * // initial_shares_authorized: "1000000",
92
- * // votes_per_share: "1",
93
- * // seniority: "1",
94
- * // // ... other fields
95
- * // }
96
- * ```
91
+ * console.log(result.stockClass);
92
+ * // {
93
+ * // object_type: "STOCK_CLASS",
94
+ * // name: "Series A Preferred",
95
+ * // class_type: "PREFERRED",
96
+ * // default_id_prefix: "SA-",
97
+ * // initial_shares_authorized: "1000000",
98
+ * // votes_per_share: "1",
99
+ * // seniority: "1",
100
+ * // // ... other fields
101
+ * // }
102
+ * ```;
97
103
  *
98
104
  * @param client - The ledger JSON API client
99
105
  * @param params - Parameters for retrieving the stock class
100
106
  * @returns Promise resolving to the OCF StockClass object
107
+ * @see https://schema.opencaptablecoalition.com/v/1.2.0/objects/StockClass.schema.json
101
108
  */
102
109
  export declare function getStockClassAsOcf(client: LedgerJsonApiClient, params: GetStockClassAsOcfParams): Promise<GetStockClassAsOcfResult>;
103
110
  //# sourceMappingURL=getStockClassAsOcf.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"getStockClassAsOcf.d.ts","sourceRoot":"","sources":["../../../src/functions/stockClass/getStockClassAsOcf.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAC;AA2IhE;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC5B,qDAAqD;IACrD,WAAW,EAAE,aAAa,CAAC;IAE3B,0EAA0E;IAC1E,IAAI,EAAE,MAAM,CAAC;IAEb,8DAA8D;IAC9D,UAAU,EAAE,WAAW,GAAG,QAAQ,CAAC;IAEnC,mKAAmK;IACnK,iBAAiB,EAAE,MAAM,CAAC;IAE1B,mEAAmE;IACnE,yBAAyB,EAAE,MAAM,GAAG,MAAM,CAAC;IAE3C,2EAA2E;IAC3E,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B,kFAAkF;IAClF,yBAAyB,CAAC,EAAE,MAAM,CAAC;IAEnC,8DAA8D;IAC9D,eAAe,EAAE,MAAM,GAAG,MAAM,CAAC;IAEjC,8CAA8C;IAC9C,SAAS,CAAC,EAAE;QACV,uCAAuC;QACvC,MAAM,EAAE,MAAM,CAAC;QACf,0DAA0D;QAC1D,QAAQ,EAAE,MAAM,CAAC;KAClB,CAAC;IAEF,sDAAsD;IACtD,eAAe,CAAC,EAAE;QAChB,uCAAuC;QACvC,MAAM,EAAE,MAAM,CAAC;QACf,0DAA0D;QAC1D,QAAQ,EAAE,MAAM,CAAC;KAClB,CAAC;IAEF;;;;;OAKG;IACH,SAAS,EAAE,MAAM,GAAG,MAAM,CAAC;IAE3B,0EAA0E;IAC1E,iBAAiB,CAAC,EAAE,KAAK,CAAC;QACxB,mCAAmC;QACnC,oBAAoB,EAAE,MAAM,CAAC;QAC7B,0CAA0C;QAC1C,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;KACpB,CAAC,CAAC;IAEH,gEAAgE;IAChE,+BAA+B,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAElD,oEAAoE;IACpE,0BAA0B,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAE7C,mDAAmD;IACnD,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ,yDAAyD;IACzD,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;CACrB;AAED,MAAM,WAAW,wBAAwB;IACvC,yDAAyD;IACzD,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,wBAAwB;IACvC,gCAAgC;IAChC,UAAU,EAAE,aAAa,CAAC;IAC1B,+BAA+B;IAC/B,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,wBAAsB,kBAAkB,CACtC,MAAM,EAAE,mBAAmB,EAC3B,MAAM,EAAE,wBAAwB,GAC/B,OAAO,CAAC,wBAAwB,CAAC,CAmFnC"}
1
+ {"version":3,"file":"getStockClassAsOcf.d.ts","sourceRoot":"","sources":["../../../src/functions/stockClass/getStockClassAsOcf.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAC;AAuOrE;;;;;GAKG;AACH,MAAM,WAAW,aAAa;IAC5B,qDAAqD;IACrD,WAAW,EAAE,aAAa,CAAC;IAE3B,0EAA0E;IAC1E,IAAI,EAAE,MAAM,CAAC;IAEb,8DAA8D;IAC9D,UAAU,EAAE,WAAW,GAAG,QAAQ,CAAC;IAEnC;;;OAGG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B,mEAAmE;IACnE,yBAAyB,EAAE,MAAM,GAAG,MAAM,CAAC;IAE3C,2EAA2E;IAC3E,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B,kFAAkF;IAClF,yBAAyB,CAAC,EAAE,MAAM,CAAC;IAEnC,8DAA8D;IAC9D,eAAe,EAAE,MAAM,GAAG,MAAM,CAAC;IAEjC,8CAA8C;IAC9C,SAAS,CAAC,EAAE;QACV,uCAAuC;QACvC,MAAM,EAAE,MAAM,CAAC;QACf,0DAA0D;QAC1D,QAAQ,EAAE,MAAM,CAAC;KAClB,CAAC;IAEF,sDAAsD;IACtD,eAAe,CAAC,EAAE;QAChB,uCAAuC;QACvC,MAAM,EAAE,MAAM,CAAC;QACf,0DAA0D;QAC1D,QAAQ,EAAE,MAAM,CAAC;KAClB,CAAC;IAEF;;;;;;;;;OASG;IACH,SAAS,EAAE,MAAM,GAAG,MAAM,CAAC;IAE3B,0EAA0E;IAC1E,iBAAiB,CAAC,EAAE,KAAK,CAAC;QACxB,mCAAmC;QACnC,oBAAoB,EAAE,MAAM,CAAC;QAC7B,0CAA0C;QAC1C,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;KACxB,CAAC,CAAC;IAEH,gEAAgE;IAChE,+BAA+B,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAElD,oEAAoE;IACpE,0BAA0B,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAE7C,mDAAmD;IACnD,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ,yDAAyD;IACzD,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;CACrB;AAED,MAAM,WAAW,wBAAwB;IACvC,yDAAyD;IACzD,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,wBAAwB;IACvC,gCAAgC;IAChC,UAAU,EAAE,aAAa,CAAC;IAC1B,+BAA+B;IAC/B,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,wBAAsB,kBAAkB,CACtC,MAAM,EAAE,mBAAmB,EAC3B,MAAM,EAAE,wBAAwB,GAC/B,OAAO,CAAC,wBAAwB,CAAC,CA+FnC"}