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

followthemoney/schema/EconomicActivity.yaml

@@ -1,11 +1,10 @@
 EconomicActivity:
-  label: "Economic Activity"
-  plural: "Economic Activities"
-  description: "An economic activity"
+  label: "Customs declaration"
+  plural: "Customs declarations"
+  description: "A foreign economic activity"
   matchable: false
   extends:
     - Interval
-  icon: fa-truck
   featured:
     - sender
     - receiver
@@ -13,9 +12,13 @@ EconomicActivity:
     - goodsDescription
     - startDate
     - endDate
+  caption:
+    - summary
+    - goodsDescription
+    - ccdNumber
   properties:
     contract:
-      label: "Associated contract"
+      label: "Contract"
       reverse:
         name: economicActivityContract
         label: "Used in customs"
@@ -41,40 +44,40 @@ EconomicActivity:
       label: "FEAC Code description"
       description: "(Описание кода ТН ВЭД) Foreign Economic Activity Commodity Code description"
     goodsDescription:
-      label: "Description"
-      description: "Description of goods"
+      label: "Description of goods"
+      type: text
     declarant:
       label: "Declarant"
       description: "Customs declarant"
+      type: entity
+      range: LegalEntity
       reverse:
         name: economicActivityDeclarant
         label: "Customs declarations"
-      type: entity
-      range: LegalEntity
     sender:
       label: "Sender"
       description: "Origin of the goods"
+      type: entity
+      range: LegalEntity
       reverse:
         name: economicActivitySender
         label: "Goods originated"
-      type: entity
-      range: LegalEntity
     receiver:
       label: "Receiver"
       description: "Destination of the goods"
+      type: entity
+      range: LegalEntity
       reverse:
         name: economicActivityReceiver
         label: "Goods received"
-      type: entity
-      range: LegalEntity
     contractHolder:
       label: "Contract holder"
       description: "Customs formalities caretaker"
-      reverse:
-        name: economicActivityHolder
-        label: "Economic activities"
       type: entity
       range: LegalEntity
+      reverse:
+        name: economicActivityHolder
+        label: "Customs declarations facilitated"
     invoiceAmount:
       label: "Invoice Value Amount"
       description: "Invoice Value of goods"
@@ -105,18 +108,30 @@ EconomicActivity:
       description: "Bank account of the contract"
       type: entity
       range: BankAccount
+      reverse:
+        name: contractBankAccount
+        label: "Customs declarations"
     bankRub:
       label: "Rouble bank"
       description: "Bank account for payments in roubles"
       type: entity
       range: BankAccount
+      reverse:
+        name: rubBankAccount
+        label: "Customs declarations (as rouble bank)"
     bankForeign:
       label: "Foreign currency bank"
       description: "Bank account for payments in foreign currency"
       type: entity
       range: BankAccount
+      reverse:
+        name: foreignBankAccount
+        label: "Customs declarations (as foreign bank)"
     transport:
       label: "Transport"
       description: "Means of transportation"
       type: entity
-      range: Vehicle
+      range: Vehicle
+      reverse:
+        name: declaredCustoms
+        label: "Customs declarations"

followthemoney/schema/Email.yaml

@@ -0,0 +1,76 @@
+Email:
+  extends:
+    - Folder
+    - PlainText
+    - HyperText
+  label: E-Mail
+  plural: E-Mails
+  description:
+    An internet mail message. The body can be formatted as plain text and/or HTML,
+    and the message may have any number of attachments.
+  matchable: false
+  generated: true
+  featured:
+    - subject
+    - date
+    - from
+  caption:
+    - subject
+    - threadTopic
+    - title
+    - name
+    - fileName
+  properties:
+    subject:
+      label: Subject
+      type: string
+      caption: true
+    threadTopic:
+      label: Thread topic
+      type: string
+    sender:
+      label: "Sender"
+      type: string
+    from:
+      label: "From"
+      type: string
+    to:
+      label: "To"
+      type: string
+    cc:
+      label: "CC"
+      description: "Carbon copy"
+      type: string
+    bcc:
+      label: "BCC"
+      description: "Blind carbon copy"
+      type: string
+    emitters:
+      label: "Emitter"
+      type: entity
+      range: LegalEntity
+      reverse:
+        name: emailsSent
+        label: "E-Mails sent"
+    recipients:
+      label: "Recipients"
+      type: entity
+      range: LegalEntity
+      reverse:
+        name: emailsReceived
+        label: "E-Mails received"
+    inReplyTo:
+      label: "In Reply To"
+      description: "Message ID of the preceding email in the thread"
+      hidden: true
+    inReplyToEmail:
+      label: Responding to
+      type: entity
+      range: Email
+      reverse:
+        name: responses
+        label: "Responses"
+    headers:
+      label: "Raw headers"
+      hidden: true
+      type: json

followthemoney/schema/Employment.yaml

@@ -0,0 +1,39 @@
+Employment:
+  label: "Employment"
+  plural: "Employments"
+  extends:
+    - Interest
+  matchable: false
+  featured:
+    - employer
+    - employee
+    - role
+    - startDate
+    - endDate
+  required:
+    - employer
+    - employee
+  caption:
+    - role
+  edge:
+    source: employee
+    label: "works for"
+    target: employer
+    directed: true
+    caption:
+      - role
+  properties:
+    employer:
+      label: "Employer"
+      type: entity
+      range: Organization
+      reverse:
+        name: employees
+        label: "Employees"
+    employee:
+      label: "Employee"
+      type: entity
+      range: Person
+      reverse:
+        name: employers
+        label: "Employers"

followthemoney/schema/Event.yaml

@@ -1,11 +1,43 @@
 Event:
   label: "Event"
-  extends: Interval
-  icon: fa-calendar
+  plural: "Events"
+  extends:
+    - Interval
+    - Analyzable
+    - Thing
   matchable: false
+  # generated: true
+  caption:
+    - name
+    - summary
+    - date
+  required:
+    - name
+  featured:
+    - name
+    - summary
+    - date
+    - location
   properties:
     location:
       label: "Location"
+      type: address
     country:
       label: "Country"
-      type: country
+      type: country
+    important:
+      label: "Important"
+    organizer:
+      label: "Organizer"
+      type: entity
+      range: LegalEntity
+      reverse:
+        name: eventsOrganized
+        label: "Organized events"
+    involved:
+      label: "Involved"
+      type: entity
+      range: LegalEntity
+      reverse:
+        name: eventsInvolved
+        label: "Events"

followthemoney/schema/Family.yaml

@@ -0,0 +1,41 @@
+Family:
+  label: "Family"
+  plural: "Family members"
+  description: "Family relationship between two people"
+  extends:
+    - Interval
+  matchable: false
+  featured:
+    - person
+    - relative
+    - relationship
+  required:
+    - person
+    - relative
+  edge:
+    source: person
+    label: "related to"
+    target: relative
+    directed: false
+    caption:
+      - relationship
+  properties:
+    person:
+      label: "Person"
+      description: "The subject of the familial relation."
+      type: entity
+      range: Person
+      reverse:
+        name: familyPerson
+        label: "Family members"
+    relative:
+      label: "Relative"
+      type: entity
+      range: Person
+      reverse:
+        name: familyRelative
+        label: "Relatives"
+      description: "The relative of the subject person."
+    relationship:
+      label: "Relationship"
+      description: "Nature of the relationship, from the person's perspective eg. 'mother', where 'relative' is mother of 'person'."

followthemoney/schema/Folder.yaml

@@ -0,0 +1,13 @@
+Folder:
+  extends:
+    - Document
+  label: Folder
+  plural: Folders
+  matchable: false
+  generated: true
+  featured:
+    - title
+    - parent
+  caption:
+    - fileName
+    - title

followthemoney/schema/HyperText.yaml

@@ -0,0 +1,21 @@
+HyperText:
+  # HTML document
+  extends:
+    - Document
+  label: Web page
+  plural: Web pages
+  matchable: false
+  generated: true
+  featured:
+    - title
+    - fileName
+    - mimeType
+    - parent
+  caption:
+    - title
+    - fileName
+  properties:
+    bodyHtml:
+      label: "HTML"
+      type: html
+      hidden: true

followthemoney/schema/Identification.yaml

@@ -0,0 +1,40 @@
+Identification:
+  label: "Identification"
+  plural: "Identifications"
+  description: >
+    An form of identification associated with its holder and some issuing country. This
+    can be used for national ID cards, voter enrollments and similar instruments.
+  extends:
+    - Interval
+  matchable: false
+  featured:
+    - number
+    - country
+    - type
+    - holder
+    - startDate
+    - endDate
+  required:
+    - holder
+    - number
+  caption:
+    - number
+  properties:
+    holder:
+      label: "Identification holder"
+      type: entity
+      range: LegalEntity
+      reverse:
+        label: "Identifications"
+        name: identification
+    type:
+      label: "Type"
+    country:
+      label: "Country"
+      type: country
+    number:
+      label: "Document number"
+      type: identifier
+      maxLength: 64
+    authority:
+      label: "Authority"

followthemoney/schema/Image.yaml

@@ -0,0 +1,25 @@
+Image:
+  extends:
+    - Document
+  label: Image
+  plural: Images
+  description: >
+    An image file.
+  matchable: false
+  generated: true
+  featured:
+    - title
+    - fileName
+    - mimeType
+    - parent
+  caption:
+    - fileName
+    - title
+  properties:
+    pictured:
+      label: "Pictured"
+      reverse:
+        name: images
+        label: "Images"
+      type: entity
+      range: Person

followthemoney/schema/Interest.yaml

@@ -1,12 +1,9 @@
 Interest:
   label: "Interest"
-  extends: Interval
-  icon: fa-certificate
+  extends:
+    - Interval
   matchable: false
-  featured:
-    - role
-    - startDate
-    - endDate
+  abstract: true
   properties:
     role:
       label: "Role"

followthemoney/schema/Interval.yaml

@@ -1,10 +1,25 @@
 Interval:
+  # FOR THE LOVE OF ALL THAT IS GOOD AND BEAUTIFUL IN THIS UNVERSE:
+  #
+  # Intervals are not graph edges.
+  #
+  # Yes, many interval child schemata (e.g. Directorship, Ownership) can
+  # be interpreted as an edge between to Things. But that isn't intrinsic.
+  # If you write any code that assumes that Intervals == edges, it will
+  # be buggy and wrong. You will find there are intervals that link to
+  # only one thing (e.g. Sanction) or to much more than two (e.g. FEA).
+  # Just do not do it.
   label: "Interval"
-  icon: fa-clock-o
+  description: >
+    An object which is bounded in time.
   matchable: false
-  featured:
-    - startDate
-    - endDate
+  abstract: true
+  temporalExtent:
+    start:
+      - startDate
+      - date
+    end:
+      - endDate
   properties:
     startDate:
       label: "Start date"
@@ -17,7 +32,43 @@ Interval:
       type: date
     summary:
       label: "Summary"
+      type: text
+    description:
+      label: Description
+      type: text
     recordId:
       label: "Record ID"
     sourceUrl:
-      label: "Source URL"
+      label: "Source link"
+      type: url
+      matchable: false
+    publisher:
+      label: "Publishing source"
+    publisherUrl:
+      label: "Publishing source URL"
+      type: url
+      matchable: false
+    alephUrl:
+      label: Aleph URL
+      type: url
+      hidden: true
+      matchable: false
+    namesMentioned:
+      label: "Detected names"
+      hidden: true
+      type: name
+    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
+    modifiedAt:
+      label: "Modified on"
+      type: date
+    retrievedAt:
+      label: "Retrieved on"
+      type: date
+      matchable: false

followthemoney/schema/LegalEntity.yaml

@@ -1,14 +1,30 @@
 LegalEntity:
-  extends: Thing
+  extends:
+    - Thing
   label: Legal entity
   plural: Legal entities
-  icon: fa-user-secret
-  description: "A legal entity may be a person or a company."
+  description: >
+    Any party to legal proceedings, such as asset ownership, corporate governance
+    or social interactions. Often used when raw data does not specify if something
+    is a person or company.
   matchable: true
   featured:
     - name
-    - legalForm
     - country
+    - legalForm
+    - status
+  required:
+    - name
+  caption:
+    - name
+    - email
+    - phone
+    - registrationNumber
+  temporalExtent:
+    start:
+      - incorporationDate
+    end:
+      - dissolutionDate
   properties:
     email:
       label: E-Mail
@@ -18,6 +34,7 @@ LegalEntity:
       label: Phone
       type: phone
       description: "Phone number"
+      maxLength: 32
     website:
       label: Website
       type: url
@@ -25,6 +42,7 @@ LegalEntity:
     legalForm:
       label: Legal form
       # description: ""
+      matchable: false
     incorporationDate:
       label: Incorporation date
       type: date
@@ -36,15 +54,19 @@ LegalEntity:
     taxStatus:
       label: Tax status
       # description: "Tax status, eg. ??"
+      matchable: false
     status:
       label: Status
       # description: "Status, eg. ??"
+      matchable: false
     sector:
       label: Sector
       # description: "Sector, eg. ??"
+      matchable: false
     classification:
       label: Classification
       # description: "Classification, eg. ??"
+      matchable: false
     registrationNumber:
       label: Registration number
       type: identifier
@@ -54,9 +76,18 @@ LegalEntity:
       type: identifier
       description: "ID number of any applicable ID"
     taxNumber:
-      label: Tax ID Number
+      label: Tax Number
+      type: identifier
+      description: "Tax identification number"
+    licenseNumber:
+      label: License Number
       type: identifier
-      description: "Tax ID number"
+      description: "For licenses granted to an entity"
+    vatCode:
+      label: "V.A.T. Identifier"
+      description: "(EU) VAT number"
+      type: identifier
+      maxLength: 32
     jurisdiction:
       label: Jurisdiction
       type: country
@@ -78,26 +109,56 @@ LegalEntity:
       label: "OKPO"
       description: "Russian industry classifier"
       type: identifier
+      matchable: false
     innCode:
       label: "INN"
       description: "Russian company ID"
       type: identifier
+      format: inn
+      maxLength: 32
+    ogrnCode:
+      label: "OGRN"
+      description: "Major State Registration Number"
+      type: identifier
+      format: ogrn
+      maxLength: 32
+    leiCode:
+      # cf. https://www.gleif.org/en/about-lei/introducing-the-legal-entity-identifier-lei
+      label: "LEI"
+      description: "Legal Entity Identifier"
+      type: identifier
+      format: lei
+      maxLength: 32
+    dunsCode:
+      label: "DUNS"
+      description: "Data Universal Numbering System - Dun & Bradstreet identifier"
+      type: identifier
+      maxLength: 16
+    uniqueEntityId:
+      label: "Unique Entity ID"
+      description: "UEI from SAM.gov"
+      type: identifier
+      format: uei
+      maxLength: 32
+    npiCode:
+      label: "NPI"
+      description: "National Provider Identifier"
+      type: identifier
+      format: npi
+      maxLength: 16
+    swiftBic:
+      label: "SWIFT/BIC"
+      description: "Bank identifier code"
+      type: identifier
+      format: bic
+      maxLength: 16
     parent:
+      # Use `Ownership` link instead.
+      deprecated: true
       label: "Parent company"
-      reverse:
-        name: subsidiaries
-      type: entity
-      schema: LegalEntity
       description: "If this entity is a subsidiary, another entity (company or organisation) is its parent"
-    subsidiaries:
-      label: "Subsidiaries"
       reverse:
-        name: parent
+        label: "Subsidiaries"
+        name: subsidiaries
       type: entity
-      schema: LegalEntity
-    passport:
-      label: "Passports"
-      schema: Passport
-      reverse:
-        name: holder
-      type: entity
+      range: LegalEntity

followthemoney/schema/License.yaml

@@ -1,10 +1,9 @@
 License:
   label: License
-  description: "A grant of land, rights or property. A type of Contract"
   plural: Licenses
+  description: "A grant of land, rights or property. A type of Contract"
   extends:
     - Contract
-  icon: fa-certificate
   matchable: false
   featured:
     - name
@@ -12,10 +11,15 @@ License:
     - authority
     - contractDate
     - commodities
+  required:
+    - name
+    - authority
+  caption:
+    - name
   properties:
     area:
       label: "Area"
     commodities:
       label: "Commodities"
     reviewDate:
-      label: "License review date"
+      label: "License review date"