Updated schema to 1.2.0

Author: Lennart Regebro

Makefile

@@ -7,8 +7,8 @@ ifndef NO_VENV
 bin_dir := $(root_dir)/ve/bin/
 python_exe := $(bin_dir)python3
 endif
-git_source := https://github.com/Open-Cap-Table-Coalition/Open-Cap-Format-OCF.git
-git_branch := release-v1.1.0
+git_source := https://github.com/regebro/Open-Cap-Format-OCF.git
+git_branch := lregebro-v1.2.0
 
 all: devenv fetch build
 

docs/source/using.rst

@@ -51,8 +51,8 @@ but you then need to create ``File`` objects for each file, with dummy md5 hashe
     ... )
 
     >>> cap.transactions.append(
-    ...     api.PlanSecurityIssuance(
-    ...             object_type="TX_PLAN_SECURITY_ISSUANCE",
+    ...     api.EquityCompensationIssuance(
+    ...             object_type="TX_EQUITY_COMPENSATION_ISSUANCE",
     ...             stock_plan_id="test",
     ...             id="Success OPTION",
     ...             custom_id="test",
@@ -65,6 +65,7 @@ but you then need to create ``File`` objects for each file, with dummy md5 hashe
     ...             security_id="",
     ...             date="2022-12-12",
     ...             security_law_exemptions=[],
+    ...             expiration_date=None,
     ...      )
     ... )
 
@@ -105,9 +106,9 @@ A captable will then be created and Python objects will be stored in it.
     object_type='STAKEHOLDER', name=Name(legal_name='Person Y', first_name=None,
     last_name=None), stakeholder_type=<StakeholderType.ENUM_INDIVIDUAL:
     'INDIVIDUAL'>, issuer_assigned_id=None, current_relationship=None,
-    primary_contact=None, addresses=None, tax_ids=None),
+    primary_contact=None, contact_info=None, addresses=None, tax_ids=None),
     Stakeholder(id='d6c49a5a-257d-4b41-9f1d-073a77dfe719', comments=[],
     object_type='STAKEHOLDER', name=Name(legal_name='Person Y', first_name=None,
     last_name=None), stakeholder_type=<StakeholderType.ENUM_INDIVIDUAL:
     'INDIVIDUAL'>, issuer_assigned_id=None, current_relationship=None,
-    primary_contact=None, addresses=None, tax_ids=None)]
+    primary_contact=None, contact_info=None, addresses=None, tax_ids=None)]

src/pyocf/api.py

@@ -6,6 +6,7 @@
 from pyocf.enums.accrualperiodtype import AccrualPeriodType
 from pyocf.enums.addresstype import AddressType
 from pyocf.enums.allocationtype import AllocationType
+from pyocf.enums.authorizedshares import AuthorizedShares
 from pyocf.enums.compensationtype import CompensationType
 from pyocf.enums.compoundingtype import CompoundingType
 from pyocf.enums.conversionmechanismtype import ConversionMechanismType
@@ -22,6 +23,7 @@
 from pyocf.enums.parentsecuritytype import ParentSecurityType
 from pyocf.enums.periodtype import PeriodType
 from pyocf.enums.phonetype import PhoneType
+from pyocf.enums.quantitysourcetype import QuantitySourceType
 from pyocf.enums.roundingtype import RoundingType
 from pyocf.enums.stakeholderrelationshiptype import StakeholderRelationshipType
 from pyocf.enums.stakeholdertype import StakeholderType
@@ -31,9 +33,12 @@
     StockPlanCancellationBehaviorType,
 )
 from pyocf.enums.terminationwindowtype import TerminationWindowType
+from pyocf.enums.valuationbasedformulatype import ValuationBasedFormulaType
 from pyocf.enums.valuationtype import ValuationType
 from pyocf.enums.vestingdayofmonth import VestingDayOfMonth
 from pyocf.enums.vestingtriggertype import VestingTriggerType
+from pyocf.files.documentsfile import DocumentsFile
+from pyocf.files.financingsfile import FinancingsFile
 from pyocf.files.ocfmanifestfile import OCFManifestFile
 from pyocf.files.stakeholdersfile import StakeholdersFile
 from pyocf.files.stockclassesfile import StockClassesFile
@@ -42,6 +47,8 @@
 from pyocf.files.transactionsfile import TransactionsFile
 from pyocf.files.valuationsfile import ValuationsFile
 from pyocf.files.vestingtermsfile import VestingTermsFile
+from pyocf.objects.document import Document
+from pyocf.objects.financing import Financing
 from pyocf.objects.issuer import Issuer
 from pyocf.objects.stakeholder import Stakeholder
 from pyocf.objects.stockclass import StockClass
@@ -58,6 +65,9 @@
 )
 from pyocf.objects.transactions.acceptance.stockacceptance import StockAcceptance
 from pyocf.objects.transactions.acceptance.warrantacceptance import WarrantAcceptance
+from pyocf.objects.transactions.adjustment.issuerauthorizedsharesadjustment import (
+    IssuerAuthorizedSharesAdjustment,
+)
 from pyocf.objects.transactions.adjustment.stockclassauthorizedsharesadjustment import (
     StockClassAuthorizedSharesAdjustment,
 )
@@ -142,6 +152,7 @@
 from pyocf.primitives.objects.transactions.conversion.conversion import Conversion
 from pyocf.primitives.objects.transactions.exercise.exercise import Exercise
 from pyocf.primitives.objects.transactions.issuance.issuance import Issuance
+from pyocf.primitives.objects.transactions.issuertransaction import IssuerTransaction
 from pyocf.primitives.objects.transactions.reissuance.reissuance import Reissuance
 from pyocf.primitives.objects.transactions.release.release import Release
 from pyocf.primitives.objects.transactions.repurchase.repurchase import Repurchase
@@ -194,6 +205,12 @@
 from pyocf.types.conversion_mechanisms.safeconversionmechanism import (
     SAFEConversionMechanism,
 )
+from pyocf.types.conversion_mechanisms.sharepricebasedconversionmechanism import (
+    SharePriceBasedConversionMechanism,
+)
+from pyocf.types.conversion_mechanisms.valuationbasedconversionmechanism import (
+    ValuationBasedConversionMechanism,
+)
 from pyocf.types.conversion_rights.convertibleconversionright import (
     ConvertibleConversionRight,
 )
@@ -230,6 +247,7 @@
 from pyocf.types.monetary import Monetary
 from pyocf.types.name import Name
 from pyocf.types.numeric import Numeric
+from pyocf.types.objectreference import ObjectReference
 from pyocf.types.percentage import Percentage
 from pyocf.types.phone import Phone
 from pyocf.types.ratio import Ratio
@@ -238,6 +256,7 @@
 from pyocf.types.stockparent import StockParent
 from pyocf.types.taxid import TaxID
 from pyocf.types.terminationwindow import TerminationWindow
+from pyocf.types.vesting import Vesting
 from pyocf.types.vesting.vestingcondition import VestingCondition
 from pyocf.types.vesting.vestingconditionportion import VestingConditionPortion
 from pyocf.types.vesting.vestingeventtrigger import VestingEventTrigger
@@ -257,6 +276,7 @@
     Address,
     AddressType,
     AllocationType,
+    AuthorizedShares,
     AutomaticConversionOnConditionTrigger,
     AutomaticConversionOnDateTrigger,
     Cancellation,
@@ -288,6 +308,8 @@
     CustomConversionMechanism,
     Date,
     DayCountType,
+    Document,
+    DocumentsFile,
     ElectiveConversionAtWillTrigger,
     ElectiveConversionInDateRangeTrigger,
     ElectiveConversionOnConditionTrigger,
@@ -304,18 +326,23 @@
     File,
     FileObject,
     FileType,
+    Financing,
+    FinancingsFile,
     FixedAmountConversionMechanism,
     InterestPayoutType,
     InterestRate,
     Issuance,
     Issuer,
+    IssuerAuthorizedSharesAdjustment,
+    IssuerTransaction,
     Md5,
     Monetary,
     Name,
     NoteConversionMechanism,
     Numeric,
     OCFManifestFile,
     Object,
+    ObjectReference,
     ObjectType,
     OptionType,
     ParentSecurityType,
@@ -331,6 +358,7 @@
     PlanSecurityRelease,
     PlanSecurityRetraction,
     PlanSecurityTransfer,
+    QuantitySourceType,
     Ratio,
     RatioConversionMechanism,
     Reissuance,
@@ -343,6 +371,7 @@
     SecurityExemption,
     SecurityTransaction,
     ShareNumberRange,
+    SharePriceBasedConversionMechanism,
     Stakeholder,
     StakeholderRelationshipType,
     StakeholderType,
@@ -381,8 +410,11 @@
     Transfer,
     UnspecifiedConversionTrigger,
     Valuation,
+    ValuationBasedConversionMechanism,
+    ValuationBasedFormulaType,
     ValuationType,
     ValuationsFile,
+    Vesting,
     VestingAcceleration,
     VestingCondition,
     VestingConditionPortion,

src/pyocf/enums/accrualperiodtype.py

@@ -4,9 +4,9 @@
 # Copyright © 2023 FMR LLC
 #
 # Based on the Open Captable Format schema:
-# Copyright © 2023 Open Cap Table Coalition (https://opencaptablecoalition.com) /
+# Copyright © 2024 Open Cap Table Coalition (https://opencaptablecoalition.com) /
 # Original File: https://github.com/Open-Cap-Table-Coalition/Open-Cap-Format-
-# OCF/tree/v1.1.0/schema/enums/AccrualPeriodType.schema.json
+# OCF/tree/v1.2.0/schema/enums/AccrualPeriodType.schema.json
 
 from enum import Enum
 

src/pyocf/enums/addresstype.py

@@ -4,9 +4,9 @@
 # Copyright © 2023 FMR LLC
 #
 # Based on the Open Captable Format schema:
-# Copyright © 2023 Open Cap Table Coalition (https://opencaptablecoalition.com) /
+# Copyright © 2024 Open Cap Table Coalition (https://opencaptablecoalition.com) /
 # Original File: https://github.com/Open-Cap-Table-Coalition/Open-Cap-Format-
-# OCF/tree/v1.1.0/schema/enums/AddressType.schema.json
+# OCF/tree/v1.2.0/schema/enums/AddressType.schema.json
 
 from enum import Enum
 

src/pyocf/enums/allocationtype.py

@@ -13,9 +13,9 @@
 # Copyright © 2023 FMR LLC
 #
 # Based on the Open Captable Format schema:
-# Copyright © 2023 Open Cap Table Coalition (https://opencaptablecoalition.com) /
+# Copyright © 2024 Open Cap Table Coalition (https://opencaptablecoalition.com) /
 # Original File: https://github.com/Open-Cap-Table-Coalition/Open-Cap-Format-
-# OCF/tree/v1.1.0/schema/enums/AllocationType.schema.json
+# OCF/tree/v1.2.0/schema/enums/AllocationType.schema.json
 
 from enum import Enum
 

src/pyocf/enums/authorizedshares.py

@@ -0,0 +1,18 @@
+"""Enumeration of authorized shares types"""
+
+# Autogenerated, do not edit.
+# Copyright © 2023 FMR LLC
+#
+# Based on the Open Captable Format schema:
+# Copyright © 2024 Open Cap Table Coalition (https://opencaptablecoalition.com) /
+# Original File: https://github.com/Open-Cap-Table-Coalition/Open-Cap-Format-
+# OCF/tree/v1.2.0/schema/enums/AuthorizedShares.schema.json
+
+from enum import Enum
+
+
+class AuthorizedShares(Enum):
+    """Enumeration of authorized shares types"""
+
+    ENUM_NOTAPPLICABLE = "NOT APPLICABLE"
+    ENUM_UNLIMITED = "UNLIMITED"

src/pyocf/enums/compensationtype.py

@@ -15,9 +15,9 @@
 # Copyright © 2023 FMR LLC
 #
 # Based on the Open Captable Format schema:
-# Copyright © 2023 Open Cap Table Coalition (https://opencaptablecoalition.com) /
+# Copyright © 2024 Open Cap Table Coalition (https://opencaptablecoalition.com) /
 # Original File: https://github.com/Open-Cap-Table-Coalition/Open-Cap-Format-
-# OCF/tree/v1.1.0/schema/enums/CompensationType.schema.json
+# OCF/tree/v1.2.0/schema/enums/CompensationType.schema.json
 
 from enum import Enum
 

src/pyocf/enums/compoundingtype.py

@@ -4,9 +4,9 @@
 # Copyright © 2023 FMR LLC
 #
 # Based on the Open Captable Format schema:
-# Copyright © 2023 Open Cap Table Coalition (https://opencaptablecoalition.com) /
+# Copyright © 2024 Open Cap Table Coalition (https://opencaptablecoalition.com) /
 # Original File: https://github.com/Open-Cap-Table-Coalition/Open-Cap-Format-
-# OCF/tree/v1.1.0/schema/enums/CompoundingType.schema.json
+# OCF/tree/v1.2.0/schema/enums/CompoundingType.schema.json
 
 from enum import Enum
 

src/pyocf/enums/conversionmechanismtype.py

@@ -4,9 +4,9 @@
 # Copyright © 2023 FMR LLC
 #
 # Based on the Open Captable Format schema:
-# Copyright © 2023 Open Cap Table Coalition (https://opencaptablecoalition.com) /
+# Copyright © 2024 Open Cap Table Coalition (https://opencaptablecoalition.com) /
 # Original File: https://github.com/Open-Cap-Table-Coalition/Open-Cap-Format-
-# OCF/tree/v1.1.0/schema/enums/ConversionMechanismType.schema.json
+# OCF/tree/v1.2.0/schema/enums/ConversionMechanismType.schema.json
 
 from enum import Enum
 
@@ -20,5 +20,7 @@ class ConversionMechanismType(Enum):
     )
     ENUM_RATIO_CONVERSION = "RATIO_CONVERSION"
     ENUM_SAFE_CONVERSION = "SAFE_CONVERSION"
+    ENUM_VALUATION_BASED_CONVERSION = "VALUATION_BASED_CONVERSION"
     ENUM_CONVERTIBLE_NOTE_CONVERSION = "CONVERTIBLE_NOTE_CONVERSION"
     ENUM_CUSTOM_CONVERSION = "CUSTOM_CONVERSION"
+    ENUM_PPS_BASED_CONVERSION = "PPS_BASED_CONVERSION"