followthemoney 1.3.7__py3-none-any.whl → 3.8.0__py3-none-any.whl

followthemoney/schema/Membership.yaml

@@ -1,24 +1,39 @@
 Membership:
   label: "Membership"
-  extends: Interest
-  icon: fa-id-badge
+  plural: "Memberships"
+  extends:
+    - Interest
   matchable: false
   featured:
     - member
     - organization
     - role
+    - startDate
+    - endDate
+  required:
+    - member
+    - organization
+  caption:
+    - role
+  edge:
+    source: member
+    label: "belongs to"
+    target: organization
+    directed: true
+    caption:
+      - role
   properties:
     member:
       label: "Member"
       type: entity
-      schema: LegalEntity
+      range: LegalEntity
       reverse:
         name: membershipMember
         label: "Memberships"
     organization:
       label: "Organization"
       type: entity
-      schema: Organization
+      range: Organization
       reverse:
         name: membershipOrganization
         label: "Members"

followthemoney/schema/Mention.yaml

@@ -0,0 +1,54 @@
+Mention:
+  label: Mention
+  plural: Mentions
+  abstract: false
+  matchable: false
+  generated: true
+  hidden: true
+  featured:
+    - document
+    - name
+    - resolved
+  required:
+    - document
+    - name
+  caption:
+    - name
+  properties:
+    document:
+      label: "Document"
+      reverse:
+        name: mentionedEntities
+        label: "Extracted names"
+        hidden: true
+      type: entity
+      range: Document
+    resolved:
+      label: "Entity"
+      reverse:
+        name: mentionedBy
+        label: "Document mentions"
+      type: entity
+      range: LegalEntity
+    name:
+      label: "Name"
+      type: name
+    detectedSchema:
+      label: "Detected entity type"
+      hidden: true
+      matchable: false
+    contextCountry:
+      label: "Co-occurring countries"
+      hidden: true
+      type: country
+      matchable: false
+    contextPhone:
+      label: "Co-occurring phone numbers"
+      hidden: true
+      type: phone
+      matchable: false
+    contextEmail:
+      label: "Co-occurring e-mail addresses"
+      hidden: true
+      type: email
+      matchable: false

followthemoney/schema/Message.yaml

@@ -0,0 +1,73 @@
+Message:
+  extends:
+    - Interval
+    - Folder
+    - PlainText
+    - HyperText
+  label: Message
+  plural: Messages
+  matchable: false
+  generated: true
+  featured:
+    - subject
+    - date
+    - sender
+    - recipients
+  required:
+    - bodyText
+    - sender
+  caption:
+    - subject
+    - title
+    - threadTopic
+    - fileName
+  properties:
+    subject:
+      label: Subject
+      type: string
+    threadTopic:
+      label: Thread topic
+      type: string
+    sender:
+      label: "Sender"
+      type: entity
+      range: LegalEntity
+      reverse:
+        name: messagesSent
+        label: "Messages sent"
+    senderAccount:
+      label: "Sender Account"
+      type: entity
+      range: UserAccount
+      reverse:
+        name: messagesSent
+        label: "Messages sent"
+    recipients:
+      label: "Recipients"
+      type: entity
+      range: LegalEntity
+      reverse:
+        name: messagesReceived
+        label: "Messages received"
+    recipientAccount:
+      label: "Recipient Account"
+      type: entity
+      range: UserAccount
+      reverse:
+        name: messagesReceived
+        label: "Messages received"
+    inReplyTo:
+      label: "In Reply To"
+      description: "Message ID of the preceding message in the thread"
+      hidden: true
+    inReplyToMessage:
+      label: Responding to
+      type: entity
+      range: Message
+      reverse:
+        name: responses
+        label: "Responses"
+    metadata:
+      label: "Metadata"
+      hidden: true
+      type: json

followthemoney/schema/Note.yaml

@@ -0,0 +1,23 @@
+Note:
+  extends:
+    - Thing
+    - Analyzable
+  label: Note
+  plural: Notes
+  description: >
+    An annotation that applies to a document or entity.
+  matchable: false
+  # generated: true
+  featured:
+    - description
+    - entity
+  caption:
+    - description
+  properties:
+    entity:
+      label: "Entity"
+      type: entity
+      range: Thing
+      reverse:
+        name: noteEntities
+        label: "Notes"

followthemoney/schema/Occupancy.yaml

@@ -0,0 +1,40 @@
+Occupancy:
+  label: "Occupancy"
+  plural: "Occupancies"
+  extends:
+    - Interval
+  matchable: false
+  description: >
+    The occupation of a position by a person for a specific period of time.
+  featured:
+    - holder
+    - post
+  required:
+    - holder
+    - post
+  edge:
+    source: holder
+    label: holds
+    target: post
+    directed: true
+    caption:
+      - startDate
+      - endDate
+  properties:
+    holder:
+      label: "Holder"
+      reverse:
+        name: positionOccupancies
+        label: "Positions held"
+      type: entity
+      range: Person
+    post:
+      label: "Position occupied"
+      reverse:
+        name: occupancies
+        label: "Position holders"
+      type: entity
+      range: Position
+    status:
+      label: "Status"
+      type: string

followthemoney/schema/Organization.yaml

@@ -1,6 +1,41 @@
 Organization:
-  extends: LegalEntity
+  extends:
+    - LegalEntity
   label: Organization
   plural: Organizations
-  icon: fa-university
-  matchable: true
+  description: >
+    Any type of incorporated entity that cannot be owned by another (see Company). This
+    might include charities, foundations or state-owned enterprises, depending on their
+    jurisdiction.
+  matchable: true
+  featured:
+    - name
+    - country
+    - legalForm
+    - status
+  required:
+    - name
+  caption:
+    - name
+  properties:
+    cageCode:
+      label: CAGE
+      description: Commercial and Government Entity Code (CAGE)
+      type: identifier
+      maxLength: 16
+    permId:
+      label: PermID
+      description: LSEG/Refinitiv code for a company
+      type: identifier
+      maxLength: 16
+    imoNumber:
+      label: IMO Number
+      type: identifier
+      format: imo
+      maxLength: 16
+    giiNumber:
+      # cf. https://www.irs.gov/businesses/corporations/fatca-registration-and-ffi-list-giin-composition-information
+      label: GIIN
+      description: Global Intermediary Identification Number
+      type: identifier
+      maxLength: 20

followthemoney/schema/Ownership.yaml

@@ -1,7 +1,8 @@
 Ownership:
   label: "Ownership"
-  extends: Interest
-  icon: fa-shopping-bag
+  plural: "Ownerships"
+  extends:
+    - Interest
   matchable: false
   featured:
     - owner
@@ -9,6 +10,16 @@ Ownership:
     - percentage
     - startDate
     - endDate
+  required:
+    - owner
+    - asset
+  edge: # OWNER owns ASSET
+    source: owner
+    label: "owns"
+    target: asset
+    directed: true
+    caption:
+      - percentage
   properties:
     owner:
       label: "Owner"
@@ -16,14 +27,14 @@ Ownership:
         name: ownershipOwner
         label: "Assets and shares"
       type: entity
-      schema: LegalEntity
+      range: LegalEntity
     asset:
       label: "Asset"
       reverse:
         name: ownershipAsset
         label: "Owners"
       type: entity
-      schema: Asset
+      range: Asset
     percentage:
       label: "Percentage held"
     sharesCount:
@@ -38,3 +49,4 @@ Ownership:
       label: "Legal basis"
     ownershipType:
       label: "Type of ownership"
+      # e.g. "beneficial", "direct", "indirect", "ultimate"

followthemoney/schema/Package.yaml

@@ -0,0 +1,17 @@
+Package:
+  extends:
+    - Folder
+  label: Package
+  plural: Packages
+  description: >
+    A bundle of files that have been packaged together into some form of archive.
+  matchable: false
+  generated: true
+  featured:
+    - title
+    - fileName
+    - mimeType
+    - parent
+  caption:
+    - fileName
+    - title

followthemoney/schema/Page.yaml

@@ -0,0 +1,43 @@
+Page:
+  # Be careful: Not derived from anything!
+  label: Page
+  plural: Pages
+  matchable: false
+  generated: true
+  hidden: true
+  properties:
+    index:
+      label: "Index"
+      type: number
+    bodyText:
+      label: "Text"
+      hidden: true
+      type: text
+    document:
+      label: "Document"
+      type: entity
+      range: Pages
+      reverse:
+        name: pages
+        label: "Pages"
+        hidden: true
+      rdf: http://purl.org/dc/terms/isPartOf
+    detectedLanguage:
+      label: "Detected language"
+      type: language
+      hidden: true
+    translatedText:
+      label: "Translated version of the body text"
+      hidden: true
+      type: text
+    translatedTextLanguage:
+      label: "The language of the translated text"
+      hidden: true
+    indexText:
+      # This is a leaked abstraction from aleph. The idea is to have some
+      # additional text field that can be used to associate searchable text
+      # with an entity. This will be removed as a property upon indexing so
+      # that it can never be retrieved.
+      label: Index text
+      hidden: true
+      type: text

followthemoney/schema/Pages.yaml

@@ -0,0 +1,23 @@
+Pages:
+  extends:
+    - Document
+  label: Document
+  description: >
+    A multi-page document, such as a PDF or Word file or slide-show presentation.
+  plural: Documents
+  matchable: false
+  generated: true
+  featured:
+    - title
+    - fileName
+    - mimeType
+    - parent
+  caption:
+    - fileName
+    - title
+  properties:
+    pdfHash:
+      label: "PDF alternative version checksum"
+      hidden: true
+      type: checksum
+      matchable: false

followthemoney/schema/Passport.yaml

@@ -1,36 +1,36 @@
 Passport:
   label: "Passport"
   plural: "Passports"
-  description: "Passport"
-  extends: Interval
-  icon: fa-id-card-o
+  description: >
+    An passport held by a person.
+  extends:
+    - Identification
   matchable: false
   featured:
+    - number
+    - country
     - type
     - holder
     - startDate
     - endDate
+  required:
+    - holder
+    - number
+  caption:
+    - passportNumber
+    - number
   properties:
-    holder:
-      label: "Document holder"
-      type: entity
-      range: LegalEntity
-      reverse:
-        name: passport
-    type:
-      label: "Document type"
-    country:
-      label: "Country"
-      type: country
     passportNumber:
+      # FIXME: Use `number` from `Identification` instead!!
       label: "Passport number"
       type: identifier
+      hidden: true
     surname:
       label: "Surname"
     givenName:
       label: "Given name"
     birthDate:
-      label: "Date of birth"
+      label: "Birth date"
       type: date
     birthPlace:
       label: "Place of birth"
@@ -39,5 +39,3 @@ Passport:
     personalNumber:
       label: "Personal number"
       type: identifier
-    authority:
-      label: "Authority"

followthemoney/schema/Payment.yaml

@@ -1,15 +1,31 @@
 Payment:
   label: "Payment"
-  extends: 
+  plural: "Payments"
+  description: "A monetary payment between two parties."
+  matchable: false
+  extends:
     - Interval
     - Value
-  icon: fa-usd
-  matchable: false
   featured:
     - payer
     - beneficiary
+    - date
     - amount
     - purpose
+  required:
+    - payer
+    - beneficiary
+  caption:
+    - amount
+  edge:
+    source: payer
+    label: "paid"
+    target: beneficiary
+    directed: true
+    caption:
+      - amount
+      - date
+      - purpose
   properties:
     sequenceNumber:
       label: "Sequence number"
@@ -17,6 +33,7 @@ Payment:
       label: "Transaction number"
     purpose:
       label: "Payment purpose"
+      type: text
     programme:
       label: "Payment programme"
       description: "Programme name, funding code, category identifier, etc."
@@ -26,25 +43,39 @@ Payment:
         name: paymentPayer
         label: "Payments made"
       type: entity
-      schema: LegalEntity
+      range: LegalEntity
     payerAccount:
       label: "Payer bank account"
       reverse:
         name: paymentPayerAccount
         label: "Payments made"
       type: entity
-      schema: BankAccount
+      range: BankAccount
     beneficiary:
       label: "Beneficiary"
       reverse:
         name: paymentBeneficiary
         label: "Payments received"
       type: entity
-      schema: LegalEntity
+      range: LegalEntity
     beneficiaryAccount:
       label: "Beneficiary bank account"
       reverse:
         name: paymentBeneficiaryAccount
         label: "Payments received"
       type: entity
-      schema: BankAccount
+      range: BankAccount
+    contract:
+      label: "Contract"
+      reverse:
+        name: paymentContract
+        label: "Contractual payments"
+      type: entity
+      range: Contract
+    project:
+      label: "Project"
+      reverse:
+        name: payments
+        label: "Payments"
+      type: entity
+      range: Project

followthemoney/schema/Person.yaml

@@ -1,18 +1,36 @@
 Person:
-  extends: LegalEntity
+  extends:
+    - LegalEntity
   label: Person
   plural: People
-  icon: fa-user
+  description: >
+    A natural person, as opposed to a corporation of some type.
   matchable: true
   rdf: http://xmlns.com/foaf/0.1/Person
   featured:
     - name
     - nationality
     - birthDate
+  required:
+    - name
+  caption:
+    - name
+    - lastName
+    - email
+    - phone
+  temporalExtent:
+    start:
+      - birthDate
+    end:
+      - deathDate
   properties:
     title:
       label: Title
       rdf: http://xmlns.com/foaf/0.1/title
+    # The `firstName`, `lastName`, `secondName` etc. properties intentionally do not use
+    # the `name` property type. Many FtM tools (including Aleph) use name properties to
+    # compare/match entities, but matching entites just on e.g. a first name would lead to
+    # too many false positives.
     firstName:
       label: First name
       rdf: http://xmlns.com/foaf/0.1/givenName
@@ -27,22 +45,60 @@ Person:
     lastName:
       label: Last name
       rdf: http://xmlns.com/foaf/0.1/lastName
+    nameSuffix:
+      label: Name suffix
     birthDate:
       label: Birth date
       type: date
       rdf: http://xmlns.com/foaf/0.1/birthday
     birthPlace:
       label: Place of birth
+    birthCountry:
+      label: Country of birth
+      type: country
     deathDate:
       label: Death date
       type: date
     position:
       label: Position
+      matchable: false
     nationality:
       label: Nationality
       type: country
-    gender:
-      label: Gender
+    citizenship:
+      label: Citizenship
+      type: country
     passportNumber:
-      label: Passport
+      label: Passport number
+      type: identifier
+    # Awkward data section below
+    socialSecurityNumber:
+      label: Social security number
       type: identifier
+      format: ssn
+    gender:
+      label: Gender
+      type: gender
+    ethnicity:
+      label: Ethnicity
+    height:
+      label: Height
+      type: number
+    weight:
+      label: Weight
+      type: number
+    eyeColor:
+      label: Eye color
+    hairColor:
+      label: Hair color
+    appearance:
+      label: Physical appearance
+    religion:
+      label: Religion
+    political:
+      label: Political association
+    education:
+      label: Education
+    spokenLanguage:
+      label: Spoken language
+      type: language

followthemoney/schema/PlainText.yaml

@@ -0,0 +1,17 @@
+PlainText:
+  extends:
+    - Document
+  label: Text file
+  plural: Text files
+  description: >
+    Text files, like .txt or source code.
+  matchable: false
+  generated: true
+  featured:
+    - title
+    - fileName
+    - mimeType
+    - parent
+  caption:
+    - fileName
+    - title