pyocf.files.ocfmanifestfile

Top-level schema describing the OCF Manifest, which holds issuer information and references ocf files containing transactions, stakeholders, stock classes, etc.

pydantic model pyocf.files.ocfmanifestfile.OCFManifestFile

Top-level schema describing the OCF Manifest, which holds issuer information and references ocf files containing transactions, stakeholders, stock classes, etc.

field as_of: Annotated[Date, FieldInfo(annotation=NoneType, required=True, description='The point-in-time represented by this OCF Package')] [Required]

The point-in-time represented by this OCF Package

field comments: Annotated[list[str], FieldInfo(annotation=NoneType, required=True, description='Unstructured text comments related to and stored for the cap table')] | None = None

field documents_files: Annotated[list[File], FieldInfo(annotation=NoneType, required=True, description='List of files containing lists of document paths, indexed from the filecontaining the first such object created to the file containing the last (Seeseparate /schema/files/documents_file schema to validate loaded files)')] | None = None

field file_type: Annotated[Literal['OCF_MANIFEST_FILE'], FieldInfo(annotation=NoneType, required=True, description='')] = 'OCF_MANIFEST_FILE'

field financings_files: Annotated[list[File], FieldInfo(annotation=NoneType, required=True, description='List of files containing lists of financings, indexed from the file containingthe first such object created to the file containing the last (See separate/schema/files/financings_file schema to validate loaded files)')] | None = None

field generated_at: Annotated[str, FieldInfo(annotation=NoneType, required=True, description='Timestamp of when the package was generated. Useful when determining which setof data is most up-to-date, if presented with two packages that have the same`as_of` date, but different cap table data.')] [Required]

Timestamp of when the package was generated. Useful when determining which setof data is most up-to-date, if presented with two packages that have the same`as_of` date, but different cap table data.

field issuer: Annotated[Issuer, FieldInfo(annotation=NoneType, required=True, description='Issuer for the cap table')] [Required]

Issuer for the cap table

field ocf_version: Annotated[Literal['1.2.0'], FieldInfo(annotation=NoneType, required=True, description='OCF Version Identifier -- the current semantic version(https://semver.org/spec/v2.0.0.html)')] = '1.2.0'

OCF Version Identifier – the current semantic version(https://semver.org/spec/v2.0.0.html)

field stakeholders_files: Annotated[list[File], FieldInfo(annotation=NoneType, required=True, description='List of files containing lists of issuer stakeholders, indexed from the filecontaining the first such object created to the file containing the last (Seeseparate /schema/files/stakeholders_file schema to validate loaded files)')] [Required]

List of files containing lists of issuer stakeholders, indexed from the filecontaining the first such object created to the file containing the last (Seeseparate /schema/files/stakeholders_file schema to validate loaded files)

field stock_classes_files: Annotated[list[File], FieldInfo(annotation=NoneType, required=True, description='List of files containing lists of issuer stock classes, indexed from the filecontaining the first such object created to the file containing the last (Seeseparate /schema/files/stock_classes_file schema to validate loaded files)')] [Required]

List of files containing lists of issuer stock classes, indexed from the filecontaining the first such object created to the file containing the last (Seeseparate /schema/files/stock_classes_file schema to validate loaded files)

field stock_legend_templates_files: Annotated[list[File], FieldInfo(annotation=NoneType, required=True, description='List of files containing lists of issuer stock legend templates, indexed fromthe file containing the first such object created to the file containing thelast (See separate /schema/files/stock_legend_templates_file schema to validateloaded files)')] [Required]

List of files containing lists of issuer stock legend templates, indexed fromthe file containing the first such object created to the file containing thelast (See separate /schema/files/stock_legend_templates_file schema to validateloaded files)

field stock_plans_files: Annotated[list[File], FieldInfo(annotation=NoneType, required=True, description='List of files containing lists of issuer stock plans, indexed from the filecontaining the first such object created to the file containing the last (Seeseparate /schema/files/stock_plans_file schema to validate loaded files)')] [Required]

List of files containing lists of issuer stock plans, indexed from the filecontaining the first such object created to the file containing the last (Seeseparate /schema/files/stock_plans_file schema to validate loaded files)

field transactions_files: Annotated[list[File], FieldInfo(annotation=NoneType, required=True, description='List of files containing lists of issuer transactions, indexed from the filecontaining the first such object created to the file containing the last (Seeseparate /schema/files/transactions_file schema to validate loaded files)')] [Required]

List of files containing lists of issuer transactions, indexed from the filecontaining the first such object created to the file containing the last (Seeseparate /schema/files/transactions_file schema to validate loaded files)

field valuations_files: Annotated[list[File], FieldInfo(annotation=NoneType, required=True, description='List of files containing lists of issuer valuations, indexed from the filecontaining the first such object created to the file containing the last (Seeseparate /schema/files/valuations_file schema to validate loaded files)')] [Required]

List of files containing lists of issuer valuations, indexed from the filecontaining the first such object created to the file containing the last (Seeseparate /schema/files/valuations_file schema to validate loaded files)

field vesting_terms_files: Annotated[list[File], FieldInfo(annotation=NoneType, required=True, description='List of files containing lists of issuer vesting terms, indexed from the filecontaining the first such object created to the file containing the last (Seeseparate /schema/files/vesting_terms_file schema to validate loaded files)')] [Required]

List of files containing lists of issuer vesting terms, indexed from the filecontaining the first such object created to the file containing the last (Seeseparate /schema/files/vesting_terms_file schema to validate loaded files)