Type Alias OcfObject

OcfObject:
    | OcfIssuerOutput
    | OcfStakeholderOutput
    | OcfStockClassOutput
    | OcfStockLegendTemplateOutput
    | OcfStockPlanOutput
    | OcfVestingTermsOutput
    | OcfValuationOutput
    | OcfDocumentOutput
    | OcfStockIssuanceOutput
    | OcfEquityCompensationIssuanceOutput
    | OcfWarrantIssuanceOutput
    | OcfConvertibleIssuanceOutput
    | OcfStockTransferOutput
    | OcfWarrantTransferOutput
    | OcfConvertibleTransferOutput
    | OcfEquityCompensationTransferOutput
    | OcfStockCancellationOutput
    | OcfWarrantCancellationOutput
    | OcfConvertibleCancellationOutput
    | OcfEquityCompensationCancellationOutput
    | OcfEquityCompensationExerciseOutput
    | OcfWarrantExerciseOutput
    | OcfStockConversionOutput
    | OcfConvertibleConversionOutput
    | OcfStockAcceptanceOutput
    | OcfWarrantAcceptanceOutput
    | OcfConvertibleAcceptanceOutput
    | OcfEquityCompensationAcceptanceOutput
    | OcfIssuerAuthorizedSharesAdjustmentOutput
    | OcfStockClassAuthorizedSharesAdjustmentOutput
    | OcfStockClassConversionRatioAdjustmentOutput
    | OcfStockClassSplitOutput
    | OcfStockPlanPoolAdjustmentOutput
    | OcfStockRepurchaseOutput
    | OcfStockConsolidationOutput
    | OcfStockReissuanceOutput
    | OcfVestingStartOutput
    | OcfVestingEventOutput
    | OcfVestingAccelerationOutput
    | OcfStakeholderRelationshipChangeEventOutput
    | OcfStakeholderStatusChangeEventOutput

Union of all OCF output types.

Discriminated by the object_type field, enabling exhaustive pattern matching.

Example

function processEntity(entity: OcfObject) {
  switch (entity.object_type) {
    case 'ISSUER':
      return entity.legal_name;
    case 'STAKEHOLDER':
      return entity.name.legal_name;
    case 'TX_STOCK_ISSUANCE':
      return entity.quantity;
    // ... TypeScript will warn about unhandled cases
  }
}