index.d.ts

/* tslint:disable */
/* eslint-disable */

/* auto-generated by NAPI-RS */

export interface Form13F {
  schemaVersion?: string
  headerData: HeaderData
  formData: FormData
}
export interface HeaderData {
  submissionType: string
  filerInfo: FilerInfo
}
export interface FilerInfo {
  liveTestFlag: string
  flags?: Flags
  filer: Filer
  contact?: Contact
  notifications?: Notifications
  periodOfReport: string
  denovoRequest?: boolean
}
export interface Flags {
  confirmingCopyFlag?: boolean
  returnCopyFlag?: boolean
  overrideInternetFlag?: boolean
}
export interface Filer {
  credentials: Credentials
  fileNumber?: string
}
export interface Credentials {
  cik: string
  ccc: string
}
export interface Contact {
  name?: string
  phoneNumber?: string
  emailAddress?: string
}
export interface Notifications {
  emailAddress?: string
}
export interface FormData {
  coverPage: CoverPage
  signatureBlock: SignatureBlock
  summaryPage?: SummaryPage
  documents?: Array<OtherDocument>
}
export interface CoverPage {
  reportCalendarOrQuarter: string
  isAmendment?: boolean
  amendmentNumber?: number
  amendmentInfo?: AmendmentInfo
  filingManager: FilingManager
  reportType: string
  form13FFileNumber?: string
  crdNumber?: number
  secFileNumber?: string
  otherManagersInfo?: OtherManagersInfo
  provideInfoForInstruction5: boolean
  additionalInformation?: string
}
export interface AmendmentInfo {
  amendmentType?: string
  confDeniedExpired?: boolean
  dataDeniedExpired?: string
  dateReported?: string
  reasonForNonConfidentiality?: string
}
export interface FilingManager {
  name: string
  address: Address
}
export interface Address {
  street1: string
  street2?: string
  city: string
  stateOrCountry: string
  zipCode: string
}
export interface OtherManagersInfo {
  otherManager?: OtherManager
}
export interface OtherManager {
  cik?: string
  name?: string
  form13FFileNumber?: string
  crdNumber?: number
  secFileNumber?: string
}
export interface SignatureBlock {
  name: string
  title: string
  phone: string
  signature: string
  city: string
  stateOrCountry: string
  signatureDate: string
}
export interface SummaryPage {
  otherIncludedManagersCount: number
  tableEntryTotal: number
  tableValueTotal: number
  isConfidentialOmitted?: boolean
  otherManagers: Array<OtherManagerWithSequence>
}
export interface OtherManagerWithSequence {
  sequenceNumber?: number
  manager?: OtherManager
}
export interface OtherDocument {
  conformedName?: string
  conformedDocumentType?: string
  description?: string
  contents?: string
}
export interface Form13FTable {
  entries: Array<TableEntry>
}
export interface TableEntry {
  nameOfIssuer: string
  titleOfClass: string
  cusip: string
  figi?: string
  value: number
  sharesOrPrintAmount: SharesOrPrintAmount
  putCall?: string
  investmentDiscretion: string
  otherManager?: Array<number>
  votingAuthority: VotingAuthority
}
export interface SharesOrPrintAmount {
  amount: number
  sharesOrPrintType: string
}
export interface VotingAuthority {
  sole: number
  shared: number
  none: number
}
export function parseForm13F(form: string): Form13F
export function parseForm13FTable(table: string): Form13FTable
export interface OwnershipForm {
  schemaVersion?: string
  documentType: string
  periodOfReport: string
  dateOfOriginalSubmission?: string
  noSecuritiesOwned?: boolean
  notSubjectToSection16?: boolean
  form3HoldingsReported?: boolean
  form4TransactionsReported?: boolean
  issuer: Issuer
  reportingOwners: Array<ReportingOwner>
  aff10B5One?: boolean
  nonDerivativeTable?: NonDerivativeTable
  derivativeTable?: DerivativeTable
  footnotes: Array<Footnote>
  remarks?: string
  ownerSignatures: Array<OwnerSignature>
}
export interface Issuer {
  cik: string
  name?: string
  tradingSymbol: string
}
export interface ReportingOwner {
  id: ReportingOwnerID
  address?: ReportingOwnerAddress
  relationship?: ReportingOwnerRelationship
}
export interface ReportingOwnerID {
  cik: string
  ccc?: string
  name?: string
}
export interface ReportingOwnerAddress {
  street1?: string
  street2?: string
  city?: string
  state?: string
  zipCode?: string
  stateDescription?: string
}
export interface ReportingOwnerRelationship {
  isDirector?: boolean
  isOfficer?: boolean
  isTenPercentOwner?: boolean
  isOther?: boolean
  officerTitle?: string
  otherText?: string
}
export interface NonDerivativeTable {
  transactions: Array<NonDerivativeTransaction>
  holdings: Array<NonDerivativeHolding>
}
export interface DerivativeTable {
  transactions: Array<DerivativeTransaction>
  holdings: Array<DerivativeHolding>
}
export interface NonDerivativeTransaction {
  securityTitle?: ValueFootnotes
  transactionDate?: ValueFootnotes
  deemedExecutionDate?: ValueFootnotes
  transactionCoding?: TransactionCoding
  transactionTimeliness?: ValueFootnotes
  transactionAmounts?: TransactionAmounts
  postTransactionAmounts?: PostTransactionAmounts
  ownershipNature?: OwnershipNature
}
export interface DerivativeTransaction {
  securityTitle?: ValueFootnotes
  conversionOrExercisePrice?: ValueFootnotes
  deemedExecutionDate?: ValueFootnotes
  transactionDate?: ValueFootnotes
  transactionCoding?: TransactionCoding
  transactionTimeliness?: ValueFootnotes
  transactionAmounts?: DerivativeTransactionAmounts
  exerciseDate?: ValueFootnotes
  expirationDate?: ValueFootnotes
  underlyingSecurity?: UnderlyingSecurity
  postTransactionAmounts?: PostTransactionAmounts
  ownershipNature?: OwnershipNature
}
export interface NonDerivativeHolding {
  securityTitle?: ValueFootnotes
  transactionCoding?: HoldingCoding
  postTransactionAmounts?: PostTransactionAmounts
  ownershipNature?: OwnershipNature
}
export interface DerivativeHolding {
  securityTitle?: ValueFootnotes
  conversionOrExercisePrice?: ValueFootnotes
  transactionCoding?: HoldingCoding
  exerciseDate?: ValueFootnotes
  expirationDate?: ValueFootnotes
  underlyingSecurity?: UnderlyingSecurity
  postTransactionAmounts?: PostTransactionAmounts
  ownershipNature?: OwnershipNature
}
export interface TransactionCoding {
  formType?: string
  transactionCode?: string
  equitySwapInvolved?: boolean
  footnoteIds?: Array<string>
}
export interface HoldingCoding {
  formType?: string
  footnoteIds?: Array<string>
}
export interface TransactionAmounts {
  shares?: ValueFootnotes
  pricePerShare?: ValueFootnotes
  acquiredDisposedCode?: ValueFootnotes
}
export interface DerivativeTransactionAmounts {
  shares?: ValueFootnotes
  pricePerShare?: ValueFootnotes
  totalValue?: ValueFootnotes
  acquiredDisposedCode?: ValueFootnotes
}
export interface UnderlyingSecurity {
  title?: ValueFootnotes
  shares?: ValueFootnotes
  value?: ValueFootnotes
}
export interface PostTransactionAmounts {
  sharesOwnedFollowingTransaction?: ValueFootnotes
  valueOwnedFollowingTransaction?: ValueFootnotes
}
export interface OwnershipNature {
  directOrIndirectOwnership?: ValueFootnotes
  natureOfOwnership?: ValueFootnotes
}
export interface Footnote {
  id?: string
  note?: string
}
export interface OwnerSignature {
  name: string
  date: string
}
export interface ValueFootnotes {
  value?: unknown
  footnoteIds?: Array<string>
}
export function parseOwnershipForm(form: string): OwnershipForm
export interface Xbrl {
  facts: Array<Fact>
}
export interface Fact {
  context: Context
  concept: string
  value: unknown
  decimals?: string
  unit?: string
}
export interface Context {
  entity: string
  segments: Array<Segment>
  period: Period
}
export interface Segment {
  dimension: string
  member: string
}
export interface Period {
  instant?: string
  startDate?: string
  endDate?: string
}
export function parseXbrl(xbrl: string): Xbrl