@fairmint/open-captable-protocol-daml-js 0.1.3 → 0.2.0

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

@@ -7,6 +7,8 @@ import * as damlTypes from '@daml/types';
 /* eslint-disable-next-line @typescript-eslint/no-unused-vars */
 import * as damlLedger from '@daml/ledger';
 
+import * as pkg7804375fe5e4c6d5afe067bd314c42fe0b7d005a1300019c73154dd939da4dda from '../../../Splice/Api/FeaturedAppRightV1';
+
 export declare type OcfCapitalizationDefinitionRules = {
   include_outstanding_shares: boolean;
   include_outstanding_options: boolean;
@@ -70,17 +72,6 @@ export declare const OcfSecurityExemption:
 ;
 
 
-export declare type OcfObjectReference = {
-  object_type: OcfObjectType;
-  object_id: string;
-};
-
-export declare const OcfObjectReference:
-  damlTypes.Serializable<OcfObjectReference> & {
-  }
-;
-
-
 export declare type OcfStakeholderRelationshipType =
   | 'OcfRelEmployee'
   | 'OcfRelAdvisor'
@@ -98,72 +89,6 @@ export declare const OcfStakeholderRelationshipType:
 ;
 
 
-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;
@@ -175,254 +100,15 @@ export declare const TransferOperation:
 ;
 
 
-export declare type OcfStakeholderData = {
-  name: string;
-  stakeholder_type: OcfStakeholderType;
-  issuer_assigned_id: damlTypes.Optional<string>;
-  current_relationships: string[];
-  current_status: damlTypes.Optional<OcfStakeholderStatusType>;
-  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;
-  default_id_prefix: string;
-  initial_shares_authorized: damlTypes.Numeric;
-  votes_per_share: damlTypes.Numeric;
-  seniority: damlTypes.Numeric;
-  board_approval_date: damlTypes.Optional<damlTypes.Time>;
-  stockholder_approval_date: damlTypes.Optional<damlTypes.Time>;
-  par_value: damlTypes.Optional<OcfMonetary>;
-  price_per_share: damlTypes.Optional<OcfMonetary>;
-  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:
-  damlTypes.Serializable<OcfStockClassData> & {
-  }
-;
-
-
-export declare type OcfIssuerData = {
-  legal_name: string;
-  formation_date: damlTypes.Optional<damlTypes.Time>;
-  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<OcfPhone>;
-  address: damlTypes.Optional<OcfAddress>;
-  initial_shares_authorized: damlTypes.Optional<OcfInitialSharesAuthorized>;
-  comments: damlTypes.Optional<string[]>;
-};
-
-export declare const OcfIssuerData:
-  damlTypes.Serializable<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'
-;
-
-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<OcfPhone>;
-  address: damlTypes.Optional<OcfAddress>;
-};
-
-export declare const OcfContactInfoWithoutName:
-  damlTypes.Serializable<OcfContactInfoWithoutName> & {
-  }
-;
-
-
-export declare type OcfContactInfo = {
-  name: string;
-  email: damlTypes.Optional<OcfEmail>;
-  phone: damlTypes.Optional<OcfPhone>;
-  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 type Context = {
+  issuer: damlTypes.Party;
+  system_operator: damlTypes.Party;
+  featured_app_right: damlTypes.ContractId<pkg7804375fe5e4c6d5afe067bd314c42fe0b7d005a1300019c73154dd939da4dda.Splice.Api.FeaturedAppRightV1.FeaturedAppRight>;
 };
 
-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> & {
+export declare const Context:
+  damlTypes.Serializable<Context> & {
   }
-& { readonly keys: OcfAllocationType[] } & { readonly [e in OcfAllocationType]: e }
 ;
 
 
@@ -513,193 +199,6 @@ export declare const OcfCompensationType:
 ;
 
 
-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 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;
-  conversion_trigger: OcfConversionTrigger;
-  converts_to_stock_class_id: string;
-  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>;
-};
-
-export declare const OcfStockClassConversionRight:
-  damlTypes.Serializable<OcfStockClassConversionRight> & {
-  }
-;
-
-
-export declare type OcfRatio = {
-  numerator: damlTypes.Numeric;
-  denominator: damlTypes.Numeric;
-};
-
-export declare const OcfRatio:
-  damlTypes.Serializable<OcfRatio> & {
-  }
-;
-
-
-export declare type OcfConversionTrigger =
-  | 'OcfTriggerAutomaticOnCondition'
-  | 'OcfTriggerAutomaticOnDate'
-  | 'OcfTriggerElectiveInRange'
-  | 'OcfTriggerElectiveOnCondition'
-  | 'OcfTriggerElectiveAtWill'
-  | 'OcfTriggerUnspecified'
-;
-
-export declare const OcfConversionTrigger:
-  damlTypes.Serializable<OcfConversionTrigger> & {
-  }
-& { readonly keys: OcfConversionTrigger[] } & { readonly [e in OcfConversionTrigger]: e }
-;
-
-
-export declare type OcfConversionMechanism =
-  | 'OcfConversionMechanismRatioConversion'
-  | 'OcfConversionMechanismPercentCapitalizationConversion'
-  | 'OcfConversionMechanismFixedAmountConversion'
-  | 'OcfConversionMechanismValuationBasedConversion'
-  | 'OcfConversionMechanismSharePriceBasedConversion'
-  | 'OcfConversionMechanismSAFEConversion'
-  | 'OcfConversionMechanismNoteConversion'
-  | 'OcfConversionMechanismCustomConversion'
-;
-
-export declare const OcfConversionMechanism:
-  damlTypes.Serializable<OcfConversionMechanism> & {
-  }
-& { readonly keys: OcfConversionMechanism[] } & { readonly [e in OcfConversionMechanism]: 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 }
-;
-
-
 export declare type OcfMonetary = {
   amount: damlTypes.Numeric;
   currency: string;
@@ -711,18 +210,6 @@ export declare const OcfMonetary:
 ;
 
 
-export declare type OcfStockClassType =
-  | 'OcfStockClassTypeCommon'
-  | 'OcfStockClassTypePreferred'
-;
-
-export declare const OcfStockClassType:
-  damlTypes.Serializable<OcfStockClassType> & {
-  }
-& { readonly keys: OcfStockClassType[] } & { readonly [e in OcfStockClassType]: e }
-;
-
-
 export declare type OcfAddress = {
   address_type: OcfAddressType;
   street_suite: damlTypes.Optional<string>;
@@ -797,50 +284,6 @@ export declare const OcfEmailType:
 ;
 
 
-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'