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

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

@@ -9,7 +9,7 @@ import * as damlLedger from '@daml/ledger';
 
 export declare type TransferOperation = {
   recipient: damlTypes.Party;
-  quantity: damlTypes.Int;
+  quantity: damlTypes.Numeric;
 };
 
 export declare const TransferOperation:
@@ -18,6 +18,24 @@ export declare const TransferOperation:
 ;
 
 
+export declare type OcfStakeholderData = {
+  name: string;
+  stakeholder_type: OcfStakeholderType;
+  issuer_assigned_id: damlTypes.Optional<string>;
+  current_relationship: damlTypes.Optional<string>;
+  primary_contact: damlTypes.Optional<OcfContactInfo>;
+  contact_info: damlTypes.Optional<OcfContactInfoWithoutName>;
+  addresses: OcfAddress[];
+  tax_ids: OcfTaxID[];
+  comments: damlTypes.Optional<string[]>;
+};
+
+export declare const OcfStakeholderData:
+  damlTypes.Serializable<OcfStakeholderData> & {
+  }
+;
+
+
 export declare type OcfStockClassData = {
   name: string;
   class_type: OcfStockClassType;
@@ -32,6 +50,7 @@ export declare type OcfStockClassData = {
   liquidation_preference_multiple: damlTypes.Optional<damlTypes.Numeric>;
   participation_cap_multiple: damlTypes.Optional<damlTypes.Numeric>;
   conversion_rights: OcfStockClassConversionRight[];
+  comments: damlTypes.Optional<string[]>;
 };
 
 export declare const OcfStockClassData:
@@ -51,6 +70,7 @@ export declare type OcfIssuerData = {
   phone: damlTypes.Optional<string>;
   address: damlTypes.Optional<OcfAddress>;
   initial_shares_authorized: damlTypes.Optional<damlTypes.Numeric>;
+  comments: damlTypes.Optional<string[]>;
 };
 
 export declare const OcfIssuerData:
@@ -59,13 +79,304 @@ export declare const OcfIssuerData:
 ;
 
 
+export declare type OcfStakeholderType =
+  | 'OcfStakeholderTypeIndividual'
+  | 'OcfStakeholderTypeInstitution'
+;
+
+export declare const OcfStakeholderType:
+  damlTypes.Serializable<OcfStakeholderType> & {
+  }
+& { readonly keys: OcfStakeholderType[] } & { readonly [e in OcfStakeholderType]: e }
+;
+
+
+export declare type OcfContactInfoWithoutName = {
+  email: damlTypes.Optional<OcfEmail>;
+  phone: damlTypes.Optional<string>;
+  address: damlTypes.Optional<OcfAddress>;
+};
+
+export declare const OcfContactInfoWithoutName:
+  damlTypes.Serializable<OcfContactInfoWithoutName> & {
+  }
+;
+
+
+export declare type OcfContactInfo = {
+  name: string;
+  email: damlTypes.Optional<OcfEmail>;
+  phone: damlTypes.Optional<string>;
+  address: damlTypes.Optional<OcfAddress>;
+};
+
+export declare const OcfContactInfo:
+  damlTypes.Serializable<OcfContactInfo> & {
+  }
+;
+
+
+export declare type OcfStockPlanData = {
+  plan_name: string;
+  board_approval_date: damlTypes.Optional<damlTypes.Time>;
+  stockholder_approval_date: damlTypes.Optional<damlTypes.Time>;
+  initial_shares_reserved: damlTypes.Numeric;
+  default_cancellation_behavior: damlTypes.Optional<OcfStockPlanCancellationBehaviorType>;
+  comments: damlTypes.Optional<string[]>;
+};
+
+export declare const OcfStockPlanData:
+  damlTypes.Serializable<OcfStockPlanData> & {
+  }
+;
+
+
+export declare type OcfStockPlanCancellationBehaviorType =
+  | 'OcfPlanCancelRetire'
+  | 'OcfPlanCancelReturnToPool'
+  | 'OcfPlanCancelHoldAsCapitalStock'
+  | 'OcfPlanCancelDefinedPerPlanSecurity'
+;
+
+export declare const OcfStockPlanCancellationBehaviorType:
+  damlTypes.Serializable<OcfStockPlanCancellationBehaviorType> & {
+  }
+& { readonly keys: OcfStockPlanCancellationBehaviorType[] } & { readonly [e in OcfStockPlanCancellationBehaviorType]: e }
+;
+
+
+export declare type OcfStockLegendTemplateData = {
+  name: string;
+  text: string;
+  comments: damlTypes.Optional<string[]>;
+};
+
+export declare const OcfStockLegendTemplateData:
+  damlTypes.Serializable<OcfStockLegendTemplateData> & {
+  }
+;
+
+
+export declare type OcfVestingTermsData = {
+  name: string;
+  description: string;
+  allocation_type: OcfAllocationType;
+  vesting_conditions: OcfVestingCondition[];
+  comments: damlTypes.Optional<string[]>;
+};
+
+export declare const OcfVestingTermsData:
+  damlTypes.Serializable<OcfVestingTermsData> & {
+  }
+;
+
+
+export declare type OcfVestingCondition = {
+  id_: string;
+  description: damlTypes.Optional<string>;
+  portion: damlTypes.Optional<OcfVestingConditionPortion>;
+  quantity: damlTypes.Optional<damlTypes.Numeric>;
+  trigger: OcfVestingTrigger;
+  next_condition_ids: string[];
+};
+
+export declare const OcfVestingCondition:
+  damlTypes.Serializable<OcfVestingCondition> & {
+  }
+;
+
+
+export declare type OcfVestingConditionPortion = {
+  numerator: damlTypes.Numeric;
+  denominator: damlTypes.Numeric;
+  remainder: boolean;
+};
+
+export declare const OcfVestingConditionPortion:
+  damlTypes.Serializable<OcfVestingConditionPortion> & {
+  }
+;
+
+
+export declare type OcfVestingTrigger =
+  |  { tag: 'OcfVestingStartTrigger'; value: {} }
+  |  { tag: 'OcfVestingScheduleAbsoluteTrigger'; value: damlTypes.Time }
+  |  { tag: 'OcfVestingScheduleRelativeTrigger'; value: OcfVestingTrigger.OcfVestingScheduleRelativeTrigger }
+  |  { tag: 'OcfVestingEventTrigger'; value: {} }
+;
+
+export declare const OcfVestingTrigger:
+  damlTypes.Serializable<OcfVestingTrigger> & {
+  OcfVestingScheduleRelativeTrigger: damlTypes.Serializable<OcfVestingTrigger.OcfVestingScheduleRelativeTrigger>;
+  }
+;
+
+
+export namespace OcfVestingTrigger {
+  type OcfVestingScheduleRelativeTrigger = {
+    period: OcfVestingPeriod;
+    relative_to_condition_id: string;
+  };
+} //namespace OcfVestingTrigger
+
+
+export declare type OcfVestingPeriod =
+  |  { tag: 'OcfVestingPeriodDays'; value: damlTypes.Int }
+  |  { tag: 'OcfVestingPeriodMonths'; value: damlTypes.Int }
+;
+
+export declare const OcfVestingPeriod:
+  damlTypes.Serializable<OcfVestingPeriod> & {
+  }
+;
+
+
+export declare type OcfAllocationType =
+  | 'OcfAllocationCumulativeRounding'
+  | 'OcfAllocationCumulativeRoundDown'
+  | 'OcfAllocationFrontLoaded'
+  | 'OcfAllocationBackLoaded'
+  | 'OcfAllocationFrontLoadedToSingleTranche'
+  | 'OcfAllocationBackLoadedToSingleTranche'
+  | 'OcfAllocationFractional'
+;
+
+export declare const OcfAllocationType:
+  damlTypes.Serializable<OcfAllocationType> & {
+  }
+& { readonly keys: OcfAllocationType[] } & { readonly [e in OcfAllocationType]: e }
+;
+
+
+export declare type OcfEquityCompensationIssuanceData = {
+  compensation_type: OcfCompensationType;
+  quantity: damlTypes.Numeric;
+  exercise_price: damlTypes.Optional<OcfMonetary>;
+  base_price: damlTypes.Optional<OcfMonetary>;
+  early_exercisable: damlTypes.Optional<boolean>;
+  vestings: damlTypes.Optional<OcfVesting[]>;
+  expiration_date: damlTypes.Optional<damlTypes.Time>;
+  termination_exercise_windows: OcfTerminationWindow[];
+  comments: damlTypes.Optional<string[]>;
+};
+
+export declare const OcfEquityCompensationIssuanceData:
+  damlTypes.Serializable<OcfEquityCompensationIssuanceData> & {
+  }
+;
+
+
+export declare type OcfVesting = {
+  date: damlTypes.Time;
+  amount: damlTypes.Numeric;
+};
+
+export declare const OcfVesting:
+  damlTypes.Serializable<OcfVesting> & {
+  }
+;
+
+
+export declare type OcfTerminationWindow = {
+  reason: OcfTerminationWindowType;
+  period: damlTypes.Int;
+  period_type: OcfPeriodType;
+};
+
+export declare const OcfTerminationWindow:
+  damlTypes.Serializable<OcfTerminationWindow> & {
+  }
+;
+
+
+export declare type OcfTerminationWindowType =
+  | 'OcfTermVoluntaryOther'
+  | 'OcfTermVoluntaryGoodCause'
+  | 'OcfTermVoluntaryRetirement'
+  | 'OcfTermInvoluntaryOther'
+  | 'OcfTermInvoluntaryDeath'
+  | 'OcfTermInvoluntaryDisability'
+  | 'OcfTermInvoluntaryWithCause'
+;
+
+export declare const OcfTerminationWindowType:
+  damlTypes.Serializable<OcfTerminationWindowType> & {
+  }
+& { readonly keys: OcfTerminationWindowType[] } & { readonly [e in OcfTerminationWindowType]: e }
+;
+
+
+export declare type OcfPeriodType =
+  | 'OcfPeriodDays'
+  | 'OcfPeriodMonths'
+  | 'OcfPeriodYears'
+;
+
+export declare const OcfPeriodType:
+  damlTypes.Serializable<OcfPeriodType> & {
+  }
+& { readonly keys: OcfPeriodType[] } & { readonly [e in OcfPeriodType]: e }
+;
+
+
+export declare type OcfCompensationType =
+  | 'OcfCompensationTypeOptionNSO'
+  | 'OcfCompensationTypeOptionISO'
+  | 'OcfCompensationTypeOption'
+  | 'OcfCompensationTypeRSU'
+  | 'OcfCompensationTypeCSAR'
+  | 'OcfCompensationTypeSSAR'
+;
+
+export declare const OcfCompensationType:
+  damlTypes.Serializable<OcfCompensationType> & {
+  }
+& { readonly keys: OcfCompensationType[] } & { readonly [e in OcfCompensationType]: e }
+;
+
+
+export declare type OcfValuationData = {
+  provider: damlTypes.Optional<string>;
+  board_approval_date: damlTypes.Optional<damlTypes.Time>;
+  stockholder_approval_date: damlTypes.Optional<damlTypes.Time>;
+  comments: damlTypes.Optional<string[]>;
+  price_per_share: OcfMonetary;
+  effective_date: damlTypes.Time;
+  valuation_type: OcfValuationType;
+};
+
+export declare const OcfValuationData:
+  damlTypes.Serializable<OcfValuationData> & {
+  }
+;
+
+
+export declare type OcfValuationType =
+  | 'OcfValuationType409A'
+;
+
+export declare const OcfValuationType:
+  damlTypes.Serializable<OcfValuationType> & {
+  }
+& { readonly keys: OcfValuationType[] } & { readonly [e in OcfValuationType]: e }
+;
+
+
 export declare type OcfStockClassConversionRight = {
   type_: string;
   conversion_mechanism: OcfConversionMechanism;
   conversion_trigger: OcfConversionTrigger;
   converts_to_stock_class_id: string;
-  conversion_rate: damlTypes.Optional<damlTypes.Numeric>;
+  ratio: damlTypes.Optional<OcfRatio>;
+  percent_of_capitalization: damlTypes.Optional<damlTypes.Numeric>;
   conversion_price: damlTypes.Optional<OcfMonetary>;
+  reference_share_price: damlTypes.Optional<OcfMonetary>;
+  reference_valuation_price_per_share: damlTypes.Optional<OcfMonetary>;
+  discount_rate: damlTypes.Optional<damlTypes.Numeric>;
+  valuation_cap: damlTypes.Optional<OcfMonetary>;
+  floor_price_per_share: damlTypes.Optional<OcfMonetary>;
+  ceiling_price_per_share: damlTypes.Optional<OcfMonetary>;
+  custom_description: damlTypes.Optional<string>;
   expires_at: damlTypes.Optional<damlTypes.Time>;
 };
 
@@ -75,6 +386,17 @@ export declare const OcfStockClassConversionRight:
 ;
 
 
+export declare type OcfRatio = {
+  numerator: damlTypes.Numeric;
+  denominator: damlTypes.Numeric;
+};
+
+export declare const OcfRatio:
+  damlTypes.Serializable<OcfRatio> & {
+  }
+;
+
+
 export declare type OcfConversionTrigger =
   | 'OcfConversionTriggerAutomatic'
   | 'OcfConversionTriggerOptional'
@@ -89,8 +411,13 @@ export declare const OcfConversionTrigger:
 
 export declare type OcfConversionMechanism =
   | 'OcfConversionMechanismRatioConversion'
-  | 'OcfConversionMechanismPercentConversion'
+  | 'OcfConversionMechanismPercentCapitalizationConversion'
   | 'OcfConversionMechanismFixedAmountConversion'
+  | 'OcfConversionMechanismValuationBasedConversion'
+  | 'OcfConversionMechanismSharePriceBasedConversion'
+  | 'OcfConversionMechanismSAFEConversion'
+  | 'OcfConversionMechanismNoteConversion'
+  | 'OcfConversionMechanismCustomConversion'
 ;
 
 export declare const OcfConversionMechanism:
@@ -207,3 +534,183 @@ export declare const OcfEmailType:
 & { readonly keys: OcfEmailType[] } & { readonly [e in OcfEmailType]: e }
 ;
 
+
+export declare type OcfWarrantIssuanceData = {
+  quantity: damlTypes.Numeric;
+  exercise_price: OcfMonetary;
+  purchase_price: OcfMonetary;
+  exercise_triggers: OcfConversionTrigger[];
+  warrant_expiration_date: damlTypes.Optional<damlTypes.Time>;
+  vesting_terms_id: damlTypes.Optional<string>;
+  comments: damlTypes.Optional<string[]>;
+};
+
+export declare const OcfWarrantIssuanceData:
+  damlTypes.Serializable<OcfWarrantIssuanceData> & {
+  }
+;
+
+
+export declare type OcfConvertibleIssuanceData = {
+  investment_amount: OcfMonetary;
+  convertible_type: OcfConvertibleType;
+  conversion_triggers: OcfConversionTrigger[];
+  seniority: damlTypes.Int;
+  pro_rata: damlTypes.Optional<damlTypes.Numeric>;
+  comments: damlTypes.Optional<string[]>;
+};
+
+export declare const OcfConvertibleIssuanceData:
+  damlTypes.Serializable<OcfConvertibleIssuanceData> & {
+  }
+;
+
+
+export declare type OcfConvertibleType =
+  | 'OcfConvertibleNote'
+  | 'OcfConvertibleSafe'
+  | 'OcfConvertibleSecurity'
+;
+
+export declare const OcfConvertibleType:
+  damlTypes.Serializable<OcfConvertibleType> & {
+  }
+& { readonly keys: OcfConvertibleType[] } & { readonly [e in OcfConvertibleType]: e }
+;
+
+
+export declare type OcfParentSecurityType =
+  | 'OcfParentStockPlan'
+  | 'OcfParentStock'
+  | 'OcfParentWarrant'
+  | 'OcfParentConvertible'
+;
+
+export declare const OcfParentSecurityType:
+  damlTypes.Serializable<OcfParentSecurityType> & {
+  }
+& { readonly keys: OcfParentSecurityType[] } & { readonly [e in OcfParentSecurityType]: e }
+;
+
+
+export declare type OcfOptionType =
+  | 'OcfOptionNSO'
+  | 'OcfOptionISO'
+  | 'OcfOptionIntl'
+;
+
+export declare const OcfOptionType:
+  damlTypes.Serializable<OcfOptionType> & {
+  }
+& { readonly keys: OcfOptionType[] } & { readonly [e in OcfOptionType]: e }
+;
+
+
+export declare type OcfAccrualPeriodType =
+  | 'OcfAccrualDaily'
+  | 'OcfAccrualMonthly'
+  | 'OcfAccrualQuarterly'
+  | 'OcfAccrualSemiAnnual'
+  | 'OcfAccrualAnnual'
+;
+
+export declare const OcfAccrualPeriodType:
+  damlTypes.Serializable<OcfAccrualPeriodType> & {
+  }
+& { readonly keys: OcfAccrualPeriodType[] } & { readonly [e in OcfAccrualPeriodType]: e }
+;
+
+
+export declare type OcfInterestRate = {
+  rate: damlTypes.Numeric;
+  payout_type: OcfInterestPayoutType;
+  compounding_type: OcfCompoundingType;
+  day_count_type: OcfDayCountType;
+};
+
+export declare const OcfInterestRate:
+  damlTypes.Serializable<OcfInterestRate> & {
+  }
+;
+
+
+export declare type OcfFileType =
+  | 'OcfManifestFile'
+  | 'OcfStakeholdersFile'
+  | 'OcfStockClassesFile'
+  | 'OcfStockLegendTemplatesFile'
+  | 'OcfStockPlansFile'
+  | 'OcfTransactionsFile'
+  | 'OcfValuationsFile'
+  | 'OcfVestingTermsFile'
+;
+
+export declare const OcfFileType:
+  damlTypes.Serializable<OcfFileType> & {
+  }
+& { readonly keys: OcfFileType[] } & { readonly [e in OcfFileType]: e }
+;
+
+
+export declare type OcfRoundingType =
+  | 'OcfRoundingCeiling'
+  | 'OcfRoundingFloor'
+  | 'OcfRoundingNormal'
+;
+
+export declare const OcfRoundingType:
+  damlTypes.Serializable<OcfRoundingType> & {
+  }
+& { readonly keys: OcfRoundingType[] } & { readonly [e in OcfRoundingType]: e }
+;
+
+
+export declare type OcfDayCountType =
+  | 'OcfDayCountActual365'
+  | 'OcfDayCount30_360'
+;
+
+export declare const OcfDayCountType:
+  damlTypes.Serializable<OcfDayCountType> & {
+  }
+& { readonly keys: OcfDayCountType[] } & { readonly [e in OcfDayCountType]: e }
+;
+
+
+export declare type OcfCompoundingType =
+  | 'OcfCompounding'
+  | 'OcfSimple'
+;
+
+export declare const OcfCompoundingType:
+  damlTypes.Serializable<OcfCompoundingType> & {
+  }
+& { readonly keys: OcfCompoundingType[] } & { readonly [e in OcfCompoundingType]: e }
+;
+
+
+export declare type OcfInterestPayoutType =
+  | 'OcfInterestPayoutDeferred'
+  | 'OcfInterestPayoutCash'
+;
+
+export declare const OcfInterestPayoutType:
+  damlTypes.Serializable<OcfInterestPayoutType> & {
+  }
+& { readonly keys: OcfInterestPayoutType[] } & { readonly [e in OcfInterestPayoutType]: e }
+;
+
+
+export declare type OcfPhoneType =
+  | 'OcfPhoneHome'
+  | 'OcfPhoneMobile'
+  | 'OcfPhoneBusiness'
+  | 'OcfPhoneOther'
+;
+
+export declare const OcfPhoneType:
+  damlTypes.Serializable<OcfPhoneType> & {
+  }
+& { readonly keys: OcfPhoneType[] } & { readonly [e in OcfPhoneType]: e }
+;
+