@fairmint/open-captable-protocol-daml-js 0.1.0 → 0.1.2

package/lib/Fairmint/OpenCapTable/Types/module.d.ts

@@ -7,6 +7,163 @@ import * as damlTypes from '@daml/types';
 /* eslint-disable-next-line @typescript-eslint/no-unused-vars */
 import * as damlLedger from '@daml/ledger';
 
+export declare type OcfCapitalizationDefinitionRules = {
+  include_outstanding_shares: boolean;
+  include_outstanding_options: boolean;
+  include_outstanding_unissued_options: boolean;
+  include_this_security: boolean;
+  include_other_converting_securities: boolean;
+  include_option_pool_topup_for_promised_options: boolean;
+  include_additional_option_pool_topup: boolean;
+  include_new_money: boolean;
+};
+
+export declare const OcfCapitalizationDefinitionRules:
+  damlTypes.Serializable<OcfCapitalizationDefinitionRules> & {
+  }
+;
+
+
+export declare type OcfCapitalizationDefinition = {
+  include_stock_class_ids: string[];
+  include_stock_plans_ids: string[];
+  include_security_ids: string[];
+  exclude_security_ids: string[];
+};
+
+export declare const OcfCapitalizationDefinition:
+  damlTypes.Serializable<OcfCapitalizationDefinition> & {
+  }
+;
+
+
+export declare type OcfStockParent = {
+  parent_object_type: OcfParentSecurityType;
+  parent_object_id: string;
+};
+
+export declare const OcfStockParent:
+  damlTypes.Serializable<OcfStockParent> & {
+  }
+;
+
+
+export declare type OcfShareNumberRange = {
+  starting_share_number: damlTypes.Numeric;
+  ending_share_number: damlTypes.Numeric;
+};
+
+export declare const OcfShareNumberRange:
+  damlTypes.Serializable<OcfShareNumberRange> & {
+  }
+;
+
+
+export declare type OcfSecurityExemption = {
+  description: string;
+  jurisdiction: string;
+};
+
+export declare const OcfSecurityExemption:
+  damlTypes.Serializable<OcfSecurityExemption> & {
+  }
+;
+
+
+export declare type OcfObjectReference = {
+  object_type: OcfObjectType;
+  object_id: string;
+};
+
+export declare const OcfObjectReference:
+  damlTypes.Serializable<OcfObjectReference> & {
+  }
+;
+
+
+export declare type OcfStakeholderRelationshipType =
+  | 'OcfRelEmployee'
+  | 'OcfRelAdvisor'
+  | 'OcfRelInvestor'
+  | 'OcfRelFounder'
+  | 'OcfRelBoardMember'
+  | 'OcfRelOfficer'
+  | 'OcfRelOther'
+;
+
+export declare const OcfStakeholderRelationshipType:
+  damlTypes.Serializable<OcfStakeholderRelationshipType> & {
+  }
+& { readonly keys: OcfStakeholderRelationshipType[] } & { readonly [e in OcfStakeholderRelationshipType]: e }
+;
+
+
+export declare type OcfObjectType =
+  | 'OcfObjIssuer'
+  | 'OcfObjStakeholder'
+  | 'OcfObjStockClass'
+  | 'OcfObjStockLegendTemplate'
+  | 'OcfObjStockPlan'
+  | 'OcfObjValuation'
+  | 'OcfObjVestingTerms'
+  | 'OcfObjFinancing'
+  | 'OcfObjDocument'
+  | 'OcfObjCeStakeholderRelationship'
+  | 'OcfObjCeStakeholderStatus'
+  | 'OcfObjTxIssuerAuthorizedSharesAdjustment'
+  | 'OcfObjTxStockClassConversionRatioAdjustment'
+  | 'OcfObjTxStockClassAuthorizedSharesAdjustment'
+  | 'OcfObjTxStockClassSplit'
+  | 'OcfObjTxStockPlanPoolAdjustment'
+  | 'OcfObjTxStockPlanReturnToPool'
+  | 'OcfObjTxConvertibleAcceptance'
+  | 'OcfObjTxConvertibleCancellation'
+  | 'OcfObjTxConvertibleConversion'
+  | 'OcfObjTxConvertibleIssuance'
+  | 'OcfObjTxConvertibleRetraction'
+  | 'OcfObjTxConvertibleTransfer'
+  | 'OcfObjTxEquityCompensationAcceptance'
+  | 'OcfObjTxEquityCompensationCancellation'
+  | 'OcfObjTxEquityCompensationExercise'
+  | 'OcfObjTxEquityCompensationIssuance'
+  | 'OcfObjTxEquityCompensationRelease'
+  | 'OcfObjTxEquityCompensationRetraction'
+  | 'OcfObjTxEquityCompensationTransfer'
+  | 'OcfObjTxEquityCompensationRepricing'
+  | 'OcfObjTxPlanSecurityAcceptance'
+  | 'OcfObjTxPlanSecurityCancellation'
+  | 'OcfObjTxPlanSecurityExercise'
+  | 'OcfObjTxPlanSecurityIssuance'
+  | 'OcfObjTxPlanSecurityRelease'
+  | 'OcfObjTxPlanSecurityRetraction'
+  | 'OcfObjTxPlanSecurityTransfer'
+  | 'OcfObjTxStockAcceptance'
+  | 'OcfObjTxStockCancellation'
+  | 'OcfObjTxStockConversion'
+  | 'OcfObjTxStockIssuance'
+  | 'OcfObjTxStockReissuance'
+  | 'OcfObjTxStockConsolidation'
+  | 'OcfObjTxStockRepurchase'
+  | 'OcfObjTxStockRetraction'
+  | 'OcfObjTxStockTransfer'
+  | 'OcfObjTxWarrantAcceptance'
+  | 'OcfObjTxWarrantCancellation'
+  | 'OcfObjTxWarrantExercise'
+  | 'OcfObjTxWarrantIssuance'
+  | 'OcfObjTxWarrantRetraction'
+  | 'OcfObjTxWarrantTransfer'
+  | 'OcfObjTxVestingAcceleration'
+  | 'OcfObjTxVestingStart'
+  | 'OcfObjTxVestingEvent'
+;
+
+export declare const OcfObjectType:
+  damlTypes.Serializable<OcfObjectType> & {
+  }
+& { readonly keys: OcfObjectType[] } & { readonly [e in OcfObjectType]: e }
+;
+
+
 export declare type TransferOperation = {
   recipient: damlTypes.Party;
   quantity: damlTypes.Numeric;
@@ -22,7 +179,8 @@ export declare type OcfStakeholderData = {
   name: string;
   stakeholder_type: OcfStakeholderType;
   issuer_assigned_id: damlTypes.Optional<string>;
-  current_relationship: damlTypes.Optional<string>;
+  current_relationships: string[];
+  current_status: damlTypes.Optional<OcfStakeholderStatusType>;
   primary_contact: damlTypes.Optional<OcfContactInfo>;
   contact_info: damlTypes.Optional<OcfContactInfoWithoutName>;
   addresses: OcfAddress[];
@@ -65,11 +223,12 @@ export declare type OcfIssuerData = {
   country_of_formation: string;
   dba: damlTypes.Optional<string>;
   country_subdivision_of_formation: damlTypes.Optional<string>;
+  country_subdivision_name_of_formation: damlTypes.Optional<string>;
   tax_ids: damlTypes.Optional<OcfTaxID[]>;
   email: damlTypes.Optional<OcfEmail>;
-  phone: damlTypes.Optional<string>;
+  phone: damlTypes.Optional<OcfPhone>;
   address: damlTypes.Optional<OcfAddress>;
-  initial_shares_authorized: damlTypes.Optional<damlTypes.Numeric>;
+  initial_shares_authorized: damlTypes.Optional<OcfInitialSharesAuthorized>;
   comments: damlTypes.Optional<string[]>;
 };
 
@@ -79,6 +238,25 @@ export declare const OcfIssuerData:
 ;
 
 
+export declare type OcfStakeholderStatusType =
+  | 'OcfStakeholderStatusActive'
+  | 'OcfStakeholderStatusLeaveOfAbsence'
+  | 'OcfStakeholderStatusTerminationVoluntaryOther'
+  | 'OcfStakeholderStatusTerminationVoluntaryGoodCause'
+  | 'OcfStakeholderStatusTerminationVoluntaryRetirement'
+  | 'OcfStakeholderStatusTerminationInvoluntaryOther'
+  | 'OcfStakeholderStatusTerminationInvoluntaryDeath'
+  | 'OcfStakeholderStatusTerminationInvoluntaryDisability'
+  | 'OcfStakeholderStatusTerminationInvoluntaryWithCause'
+;
+
+export declare const OcfStakeholderStatusType:
+  damlTypes.Serializable<OcfStakeholderStatusType> & {
+  }
+& { readonly keys: OcfStakeholderStatusType[] } & { readonly [e in OcfStakeholderStatusType]: e }
+;
+
+
 export declare type OcfStakeholderType =
   | 'OcfStakeholderTypeIndividual'
   | 'OcfStakeholderTypeInstitution'
@@ -93,7 +271,7 @@ export declare const OcfStakeholderType:
 
 export declare type OcfContactInfoWithoutName = {
   email: damlTypes.Optional<OcfEmail>;
-  phone: damlTypes.Optional<string>;
+  phone: damlTypes.Optional<OcfPhone>;
   address: damlTypes.Optional<OcfAddress>;
 };
 
@@ -106,7 +284,7 @@ export declare const OcfContactInfoWithoutName:
 export declare type OcfContactInfo = {
   name: string;
   email: damlTypes.Optional<OcfEmail>;
-  phone: damlTypes.Optional<string>;
+  phone: damlTypes.Optional<OcfPhone>;
   address: damlTypes.Optional<OcfAddress>;
 };
 
@@ -362,6 +540,74 @@ export declare const OcfValuationType:
 ;
 
 
+export declare type OcfValuationBasedFormulaType =
+  | 'OcfValuationFormulaFixed'
+  | 'OcfValuationFormulaActual'
+  | 'OcfValuationFormulaCap'
+;
+
+export declare const OcfValuationBasedFormulaType:
+  damlTypes.Serializable<OcfValuationBasedFormulaType> & {
+  }
+& { readonly keys: OcfValuationBasedFormulaType[] } & { readonly [e in OcfValuationBasedFormulaType]: e }
+;
+
+
+export declare type OcfStockIssuanceType =
+  | 'OcfStockIssuanceRSA'
+  | 'OcfStockIssuanceFounders'
+;
+
+export declare const OcfStockIssuanceType:
+  damlTypes.Serializable<OcfStockIssuanceType> & {
+  }
+& { readonly keys: OcfStockIssuanceType[] } & { readonly [e in OcfStockIssuanceType]: e }
+;
+
+
+export declare type OcfQuantitySourceType =
+  | 'OcfQuantityHumanEstimated'
+  | 'OcfQuantityMachineEstimated'
+  | 'OcfQuantityUnspecified'
+  | 'OcfQuantityInstrumentFixed'
+  | 'OcfQuantityInstrumentMax'
+  | 'OcfQuantityInstrumentMin'
+;
+
+export declare const OcfQuantitySourceType:
+  damlTypes.Serializable<OcfQuantitySourceType> & {
+  }
+& { readonly keys: OcfQuantitySourceType[] } & { readonly [e in OcfQuantitySourceType]: e }
+;
+
+
+export declare type OcfFinancing = {
+  name: string;
+  issuance_ids: string[];
+  date: damlTypes.Time;
+  comments: damlTypes.Optional<string[]>;
+};
+
+export declare const OcfFinancing:
+  damlTypes.Serializable<OcfFinancing> & {
+  }
+;
+
+
+export declare type OcfDocument = {
+  path: damlTypes.Optional<string>;
+  uri: damlTypes.Optional<string>;
+  md5: string;
+  related_objects: damlTypes.Optional<string[]>;
+  comments: damlTypes.Optional<string[]>;
+};
+
+export declare const OcfDocument:
+  damlTypes.Serializable<OcfDocument> & {
+  }
+;
+
+
 export declare type OcfStockClassConversionRight = {
   type_: string;
   conversion_mechanism: OcfConversionMechanism;
@@ -398,8 +644,12 @@ export declare const OcfRatio:
 
 
 export declare type OcfConversionTrigger =
-  | 'OcfConversionTriggerAutomatic'
-  | 'OcfConversionTriggerOptional'
+  | 'OcfTriggerAutomaticOnCondition'
+  | 'OcfTriggerAutomaticOnDate'
+  | 'OcfTriggerElectiveInRange'
+  | 'OcfTriggerElectiveOnCondition'
+  | 'OcfTriggerElectiveAtWill'
+  | 'OcfTriggerUnspecified'
 ;
 
 export declare const OcfConversionTrigger:
@@ -512,6 +762,17 @@ export declare const OcfTaxID:
 ;
 
 
+export declare type OcfPhone = {
+  phone_type: OcfPhoneType;
+  phone_number: string;
+};
+
+export declare const OcfPhone:
+  damlTypes.Serializable<OcfPhone> & {
+  }
+;
+
+
 export declare type OcfEmail = {
   email_type: OcfEmailType;
   email_address: string;
@@ -526,6 +787,7 @@ export declare const OcfEmail:
 export declare type OcfEmailType =
   | 'OcfEmailTypeBusiness'
   | 'OcfEmailTypePersonal'
+  | 'OcfEmailTypeOther'
 ;
 
 export declare const OcfEmailType:
@@ -643,6 +905,8 @@ export declare type OcfFileType =
   | 'OcfTransactionsFile'
   | 'OcfValuationsFile'
   | 'OcfVestingTermsFile'
+  | 'OcfFinancingsFile'
+  | 'OcfDocumentsFile'
 ;
 
 export declare const OcfFileType: