@fairmint/open-captable-protocol-daml-js 0.2.112 → 0.2.114

package/lib/Fairmint/OpenCapTable/Types/{module.d.ts → Conversion/module.d.ts}

@@ -1,10 +1,13 @@
-// Generated from Fairmint/OpenCapTable/Types.daml
+// Generated from Fairmint/OpenCapTable/Types/Conversion.daml
 /* eslint-disable @typescript-eslint/camelcase */
 /* eslint-disable @typescript-eslint/no-namespace */
 /* eslint-disable @typescript-eslint/no-use-before-define */
 import * as jtv from '@mojotech/json-type-validation';
 import * as damlTypes from '@daml/types';
 
+import * as Fairmint_OpenCapTable_Types_Monetary from '../../../../Fairmint/OpenCapTable/Types/Monetary/module';
+import * as Fairmint_OpenCapTable_Types_Stock from '../../../../Fairmint/OpenCapTable/Types/Stock/module';
+
 export declare type OcfConversionTrigger = {
   conversion_right: OcfAnyConversionRight;
   trigger_id: string;
@@ -33,19 +36,27 @@ export declare const OcfAnyConversionRight:
 ;
 
 
-export declare type OcfConversionTriggerType =
-  | 'OcfTriggerTypeTypeAutomaticOnCondition'
-  | 'OcfTriggerTypeTypeAutomaticOnDate'
-  | 'OcfTriggerTypeTypeElectiveInRange'
-  | 'OcfTriggerTypeTypeElectiveOnCondition'
-  | 'OcfTriggerTypeTypeElectiveAtWill'
-  | 'OcfTriggerTypeTypeUnspecified'
-;
+export declare type OcfStockClassConversionRight = {
+  conversion_mechanism: OcfConversionMechanism;
+  conversion_trigger: OcfConversionTrigger;
+  converts_to_stock_class_id: string;
+  type_: string;
+  ceiling_price_per_share: damlTypes.Optional<Fairmint_OpenCapTable_Types_Monetary.OcfMonetary>;
+  conversion_price: damlTypes.Optional<Fairmint_OpenCapTable_Types_Monetary.OcfMonetary>;
+  custom_description: damlTypes.Optional<string>;
+  discount_rate: damlTypes.Optional<damlTypes.Numeric>;
+  expires_at: damlTypes.Optional<damlTypes.Time>;
+  floor_price_per_share: damlTypes.Optional<Fairmint_OpenCapTable_Types_Monetary.OcfMonetary>;
+  percent_of_capitalization: damlTypes.Optional<damlTypes.Numeric>;
+  ratio: damlTypes.Optional<Fairmint_OpenCapTable_Types_Stock.OcfRatio>;
+  reference_share_price: damlTypes.Optional<Fairmint_OpenCapTable_Types_Monetary.OcfMonetary>;
+  reference_valuation_price_per_share: damlTypes.Optional<Fairmint_OpenCapTable_Types_Monetary.OcfMonetary>;
+  valuation_cap: damlTypes.Optional<Fairmint_OpenCapTable_Types_Monetary.OcfMonetary>;
+};
 
-export declare const OcfConversionTriggerType:
-  damlTypes.Serializable<OcfConversionTriggerType> & {
+export declare const OcfStockClassConversionRight:
+  damlTypes.Serializable<OcfStockClassConversionRight> & {
   }
-& { readonly keys: OcfConversionTriggerType[] } & { readonly [e in OcfConversionTriggerType]: e }
 ;
 
 
@@ -70,7 +81,7 @@ export declare type OcfConvertibleConversionMechanism =
   |  { tag: 'OcfConvMechFixedAmount'; value: OcfFixedAmountConversionMechanism }
   |  { tag: 'OcfConvMechSharePriceBased'; value: OcfSharePriceBasedConversionMechanism }
   |  { tag: 'OcfConvMechValuationBased'; value: OcfValuationBasedConversionMechanism }
-  |  { tag: 'OcfConvMechRatio'; value: OcfRatio }
+  |  { tag: 'OcfConvMechRatio'; value: Fairmint_OpenCapTable_Types_Stock.OcfRatio }
 ;
 
 export declare const OcfConvertibleConversionMechanism:
@@ -79,19 +90,6 @@ export declare const OcfConvertibleConversionMechanism:
 ;
 
 
-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 OcfWarrantConversionRight = {
   conversion_mechanism: OcfWarrantConversionMechanism;
   type_: string;
@@ -150,7 +148,7 @@ export namespace OcfWarrantConversionMechanism {
 export namespace OcfWarrantConversionMechanism {
   type OcfWarrantMechanismValuationBased = {
     valuation_type: string;
-    valuation_amount: damlTypes.Optional<OcfMonetary>;
+    valuation_amount: damlTypes.Optional<Fairmint_OpenCapTable_Types_Monetary.OcfMonetary>;
     capitalization_definition: damlTypes.Optional<string>;
     capitalization_definition_rules: damlTypes.Optional<OcfCapitalizationDefinitionRules>;
   };
@@ -162,11 +160,40 @@ export namespace OcfWarrantConversionMechanism {
     description: string;
     discount: boolean;
     discount_percentage: damlTypes.Optional<damlTypes.Numeric>;
-    discount_amount: damlTypes.Optional<OcfMonetary>;
+    discount_amount: damlTypes.Optional<Fairmint_OpenCapTable_Types_Monetary.OcfMonetary>;
   };
 } //namespace OcfWarrantConversionMechanism
 
 
+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 OcfConversionTriggerType =
+  | 'OcfTriggerTypeTypeAutomaticOnCondition'
+  | 'OcfTriggerTypeTypeAutomaticOnDate'
+  | 'OcfTriggerTypeTypeElectiveInRange'
+  | 'OcfTriggerTypeTypeElectiveOnCondition'
+  | 'OcfTriggerTypeTypeElectiveAtWill'
+  | 'OcfTriggerTypeTypeUnspecified'
+;
+
+export declare const OcfConversionTriggerType:
+  damlTypes.Serializable<OcfConversionTriggerType> & {
+  }
+& { readonly keys: OcfConversionTriggerType[] } & { readonly [e in OcfConversionTriggerType]: e }
+;
+
+
 export declare type OcfNoteConversionMechanism = {
   compounding_type: OcfCompoundingType;
   day_count_convention: OcfDayCountType;
@@ -177,8 +204,8 @@ export declare type OcfNoteConversionMechanism = {
   capitalization_definition_rules: damlTypes.Optional<OcfCapitalizationDefinitionRules>;
   conversion_discount: damlTypes.Optional<damlTypes.Numeric>;
   conversion_mfn: damlTypes.Optional<boolean>;
-  conversion_valuation_cap: damlTypes.Optional<OcfMonetary>;
-  exit_multiple: damlTypes.Optional<OcfRatio>;
+  conversion_valuation_cap: damlTypes.Optional<Fairmint_OpenCapTable_Types_Monetary.OcfMonetary>;
+  exit_multiple: damlTypes.Optional<Fairmint_OpenCapTable_Types_Stock.OcfRatio>;
 };
 
 export declare const OcfNoteConversionMechanism:
@@ -193,8 +220,8 @@ export declare type OcfSAFEConversionMechanism = {
   capitalization_definition_rules: damlTypes.Optional<OcfCapitalizationDefinitionRules>;
   conversion_discount: damlTypes.Optional<damlTypes.Numeric>;
   conversion_timing: damlTypes.Optional<string>;
-  conversion_valuation_cap: damlTypes.Optional<OcfMonetary>;
-  exit_multiple: damlTypes.Optional<OcfRatio>;
+  conversion_valuation_cap: damlTypes.Optional<Fairmint_OpenCapTable_Types_Monetary.OcfMonetary>;
+  exit_multiple: damlTypes.Optional<Fairmint_OpenCapTable_Types_Stock.OcfRatio>;
 };
 
 export declare const OcfSAFEConversionMechanism:
@@ -207,7 +234,7 @@ export declare type OcfValuationBasedConversionMechanism = {
   valuation_type: OcfValuationBasedFormulaType;
   capitalization_definition: damlTypes.Optional<string>;
   capitalization_definition_rules: damlTypes.Optional<OcfCapitalizationDefinitionRules>;
-  valuation_amount: damlTypes.Optional<OcfMonetary>;
+  valuation_amount: damlTypes.Optional<Fairmint_OpenCapTable_Types_Monetary.OcfMonetary>;
 };
 
 export declare const OcfValuationBasedConversionMechanism:
@@ -232,7 +259,7 @@ export declare const OcfValuationBasedFormulaType:
 export declare type OcfSharePriceBasedConversionMechanism = {
   description: string;
   discount: boolean;
-  discount_amount: damlTypes.Optional<OcfMonetary>;
+  discount_amount: damlTypes.Optional<Fairmint_OpenCapTable_Types_Monetary.OcfMonetary>;
   discount_percentage: damlTypes.Optional<damlTypes.Numeric>;
 };
 
@@ -274,6 +301,18 @@ export declare const OcfCustomConversionMechanism:
 ;
 
 
+export declare type OcfRatioConversionMechanism = {
+  conversion_price: Fairmint_OpenCapTable_Types_Monetary.OcfMonetary;
+  ratio: Fairmint_OpenCapTable_Types_Stock.OcfRatio;
+  rounding_type: OcfRoundingType;
+};
+
+export declare const OcfRatioConversionMechanism:
+  damlTypes.Serializable<OcfRatioConversionMechanism> & {
+  }
+;
+
+
 export declare type OcfConversionMechanism =
   | 'OcfConversionMechanismRatioConversion'
   | 'OcfConversionMechanismPercentCapitalizationConversion'
@@ -292,262 +331,6 @@ export declare const OcfConversionMechanism:
 ;
 
 
-export declare type OcfStockClassConversionRight = {
-  conversion_mechanism: OcfConversionMechanism;
-  conversion_trigger: OcfConversionTrigger;
-  converts_to_stock_class_id: string;
-  type_: string;
-  ceiling_price_per_share: damlTypes.Optional<OcfMonetary>;
-  conversion_price: damlTypes.Optional<OcfMonetary>;
-  custom_description: damlTypes.Optional<string>;
-  discount_rate: damlTypes.Optional<damlTypes.Numeric>;
-  expires_at: damlTypes.Optional<damlTypes.Time>;
-  floor_price_per_share: damlTypes.Optional<OcfMonetary>;
-  percent_of_capitalization: damlTypes.Optional<damlTypes.Numeric>;
-  ratio: damlTypes.Optional<OcfRatio>;
-  reference_share_price: damlTypes.Optional<OcfMonetary>;
-  reference_valuation_price_per_share: damlTypes.Optional<OcfMonetary>;
-  valuation_cap: damlTypes.Optional<OcfMonetary>;
-};
-
-export declare const OcfStockClassConversionRight:
-  damlTypes.Serializable<OcfStockClassConversionRight> & {
-  }
-;
-
-
-export declare type OcfRatioConversionMechanism = {
-  conversion_price: OcfMonetary;
-  ratio: OcfRatio;
-  rounding_type: OcfRoundingType;
-};
-
-export declare const OcfRatioConversionMechanism:
-  damlTypes.Serializable<OcfRatioConversionMechanism> & {
-  }
-;
-
-
-export declare type OcfRatio = {
-  numerator: damlTypes.Numeric;
-  denominator: damlTypes.Numeric;
-};
-
-export declare const OcfRatio:
-  damlTypes.Serializable<OcfRatio> & {
-  }
-;
-
-
-export declare type OcfStockClassType =
-  | 'OcfStockClassTypeCommon'
-  | 'OcfStockClassTypePreferred'
-;
-
-export declare const OcfStockClassType:
-  damlTypes.Serializable<OcfStockClassType> & {
-  }
-& { readonly keys: OcfStockClassType[] } & { readonly [e in OcfStockClassType]: e }
-;
-
-
-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 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 OcfStakeholderRelationshipType =
-  | 'OcfRelAdvisor'
-  | 'OcfRelBoardMember'
-  | 'OcfRelConsultant'
-  | 'OcfRelEmployee'
-  | 'OcfRelExAdvisor'
-  | 'OcfRelExConsultant'
-  | 'OcfRelExEmployee'
-  | 'OcfRelExecutive'
-  | 'OcfRelFounder'
-  | 'OcfRelInvestor'
-  | 'OcfRelNonUsEmployee'
-  | 'OcfRelOfficer'
-  | 'OcfRelOther'
-;
-
-export declare const OcfStakeholderRelationshipType:
-  damlTypes.Serializable<OcfStakeholderRelationshipType> & {
-  }
-& { readonly keys: OcfStakeholderRelationshipType[] } & { readonly [e in OcfStakeholderRelationshipType]: e }
-;
-
-
-export declare type TransferOperation = {
-  recipient: damlTypes.Party;
-  quantity: damlTypes.Numeric;
-};
-
-export declare const TransferOperation:
-  damlTypes.Serializable<TransferOperation> & {
-  }
-;
-
-
-export declare type Context = {
-  issuer: damlTypes.Party;
-  system_operator: damlTypes.Party;
-};
-
-export declare const Context:
-  damlTypes.Serializable<Context> & {
-  }
-;
-
-
-export declare type OcfEquityCompensationIssuanceData = {
-  compensation_type: OcfCompensationType;
-  quantity: damlTypes.Numeric;
-  comments: string[];
-  termination_exercise_windows: OcfTerminationWindow[];
-  vestings: OcfVesting[];
-  base_price: damlTypes.Optional<OcfMonetary>;
-  early_exercisable: damlTypes.Optional<boolean>;
-  exercise_price: damlTypes.Optional<OcfMonetary>;
-  expiration_date: damlTypes.Optional<damlTypes.Time>;
-};
-
-export declare const OcfEquityCompensationIssuanceData:
-  damlTypes.Serializable<OcfEquityCompensationIssuanceData> & {
-  }
-;
-
-
-export declare type OcfVesting = {
-  amount: damlTypes.Numeric;
-  date: damlTypes.Time;
-};
-
-export declare const OcfVesting:
-  damlTypes.Serializable<OcfVesting> & {
-  }
-;
-
-
-export declare type OcfTerminationWindow = {
-  period: damlTypes.Int;
-  period_type: OcfPeriodType;
-  reason: OcfTerminationWindowType;
-};
-
-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 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 = {
-  accrual_start_date: damlTypes.Time;
-  rate: damlTypes.Numeric;
-  accrual_end_date: damlTypes.Optional<damlTypes.Time>;
-};
-
-export declare const OcfInterestRate:
-  damlTypes.Serializable<OcfInterestRate> & {
-  }
-;
-
-
 export declare type OcfCapitalizationDefinitionRules = {
   include_additional_option_pool_topup: boolean;
   include_new_money: boolean;
@@ -578,133 +361,30 @@ export declare const OcfCapitalizationDefinition:
 ;
 
 
-export declare type OcfStockParent = {
-  parent_object_id: string;
-  parent_object_type: OcfParentSecurityType;
-};
-
-export declare const OcfStockParent:
-  damlTypes.Serializable<OcfStockParent> & {
-  }
-;
-
-
-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 OcfMonetary = {
-  amount: damlTypes.Numeric;
-  currency: string;
-};
-
-export declare const OcfMonetary:
-  damlTypes.Serializable<OcfMonetary> & {
-  }
-;
-
-
-export declare type OcfAddress = {
-  address_type: OcfAddressType;
-  country: string;
-  city: damlTypes.Optional<string>;
-  country_subdivision: damlTypes.Optional<string>;
-  postal_code: damlTypes.Optional<string>;
-  street_suite: damlTypes.Optional<string>;
-};
-
-export declare const OcfAddress:
-  damlTypes.Serializable<OcfAddress> & {
-  }
-;
-
-
-export declare type OcfAddressType =
-  | 'OcfAddressTypeLegal'
-  | 'OcfAddressTypeContact'
-  | 'OcfAddressTypeOther'
-;
-
-export declare const OcfAddressType:
-  damlTypes.Serializable<OcfAddressType> & {
-  }
-& { readonly keys: OcfAddressType[] } & { readonly [e in OcfAddressType]: e }
-;
-
-
-export declare type OcfTaxID = {
-  country: string;
-  tax_id: string;
-};
-
-export declare const OcfTaxID:
-  damlTypes.Serializable<OcfTaxID> & {
-  }
-;
-
-
-export declare type OcfPhone = {
-  phone_number: string;
-  phone_type: OcfPhoneType;
-};
-
-export declare const OcfPhone:
-  damlTypes.Serializable<OcfPhone> & {
-  }
-;
-
-
-export declare type OcfEmail = {
-  email_address: string;
-  email_type: OcfEmailType;
+export declare type OcfInterestRate = {
+  accrual_start_date: damlTypes.Time;
+  rate: damlTypes.Numeric;
+  accrual_end_date: damlTypes.Optional<damlTypes.Time>;
 };
 
-export declare const OcfEmail:
-  damlTypes.Serializable<OcfEmail> & {
-  }
-;
-
-
-export declare type OcfEmailType =
-  | 'OcfEmailTypeBusiness'
-  | 'OcfEmailTypePersonal'
-  | 'OcfEmailTypeOther'
-;
-
-export declare const OcfEmailType:
-  damlTypes.Serializable<OcfEmailType> & {
+export declare const OcfInterestRate:
+  damlTypes.Serializable<OcfInterestRate> & {
   }
-& { readonly keys: OcfEmailType[] } & { readonly [e in OcfEmailType]: e }
 ;
 
 
-export declare type OcfFileType =
-  | 'OcfManifestFile'
-  | 'OcfStakeholdersFile'
-  | 'OcfStockClassesFile'
-  | 'OcfStockLegendTemplatesFile'
-  | 'OcfStockPlansFile'
-  | 'OcfTransactionsFile'
-  | 'OcfValuationsFile'
-  | 'OcfVestingTermsFile'
-  | 'OcfFinancingsFile'
-  | 'OcfDocumentsFile'
+export declare type OcfAccrualPeriodType =
+  | 'OcfAccrualDaily'
+  | 'OcfAccrualMonthly'
+  | 'OcfAccrualQuarterly'
+  | 'OcfAccrualSemiAnnual'
+  | 'OcfAccrualAnnual'
 ;
 
-export declare const OcfFileType:
-  damlTypes.Serializable<OcfFileType> & {
+export declare const OcfAccrualPeriodType:
+  damlTypes.Serializable<OcfAccrualPeriodType> & {
   }
-& { readonly keys: OcfFileType[] } & { readonly [e in OcfFileType]: e }
+& { readonly keys: OcfAccrualPeriodType[] } & { readonly [e in OcfAccrualPeriodType]: e }
 ;
 
 
@@ -756,40 +436,3 @@ export declare const 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 }
-;
-
-
-export declare type OcfInitialSharesAuthorized =
-  |  { tag: 'OcfInitialSharesNumeric'; value: damlTypes.Numeric }
-  |  { tag: 'OcfInitialSharesEnum'; value: OcfAuthorizedShares }
-;
-
-export declare const OcfInitialSharesAuthorized:
-  damlTypes.Serializable<OcfInitialSharesAuthorized> & {
-  }
-;
-
-
-export declare type OcfAuthorizedShares =
-  | 'OcfAuthorizedSharesNotApplicable'
-  | 'OcfAuthorizedSharesUnlimited'
-;
-
-export declare const OcfAuthorizedShares:
-  damlTypes.Serializable<OcfAuthorizedShares> & {
-  }
-& { readonly keys: OcfAuthorizedShares[] } & { readonly [e in OcfAuthorizedShares]: e }
-;
-