turbot-runner-morph 0.0.1

data/schema/schemas/includes/company.json

@@ -0,0 +1,25 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "description": "A company which is the subject of a statement",
+  "type": "object",
+  "properties": {
+    "name": {
+      "type": "string"
+    },
+    "jurisdiction": {
+      "type": "string"
+    },
+    "company_number": {
+      "type": "string"
+    },
+    "identifier": {
+      "type": "string",
+      "description": "An official identifier paired with a code for the issuer of the identifier, e.g sec/12345",
+      "pattern": "^[^/]+/[^/]+$"
+    }
+  },
+  "required": [
+    "name",
+    "jurisdiction"
+  ]
+}

data/schema/schemas/includes/entity.json

@@ -0,0 +1,58 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "type": "object",
+  "required": [
+    "entity_type",
+    "entity_properties"
+  ],
+  "oneOf": [
+    {
+      "properties": {
+        "entity_type": {
+          "enum": [
+            "company"
+          ]
+        },
+        "entity_properties": {
+          "$ref": "company-for-nesting.json"
+        }
+      }
+    },
+    {
+      "properties": {
+        "entity_type": {
+          "enum": [
+            "person"
+          ]
+        },
+        "entity_properties": {
+          "$ref": "person.json"
+        }
+      }
+    },
+    {
+      "properties": {
+        "entity_type": {
+          "enum": [
+            "organisation"
+          ]
+        },
+        "entity_properties": {
+          "$ref": "organisation.json"
+        }
+      }
+    },
+    {
+      "properties": {
+        "entity_type": {
+          "enum": [
+            "unknown"
+          ]
+        },
+        "entity_properties": {
+          "$ref": "unknown_entity_type.json"
+        }
+      }
+    }
+  ]
+}

data/schema/schemas/includes/filing.json

@@ -0,0 +1,52 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "description": "A statutory filing",
+  "type": "object",
+  "properties": {
+    "title": {
+      "type": "string"
+    },
+    "date": {
+      "type": "string",
+      "format": "date"
+    },
+    "description": {
+      "type": "string"
+    },
+    "uid": {
+      "type": "string"
+    },
+    "url": {
+      "type": "string"
+    },
+    "filing_type_code": {
+      "type": "string"
+    },
+    "filing_type_name": {
+      "type": "string"
+    },
+    "other_attributes": {
+      "type": "object"
+    }
+  },
+  "required": [
+    "date"
+  ],
+  "anyOf": [
+    {
+      "required": [
+        "title"
+      ]
+    },
+    {
+      "required": [
+        "description"
+      ]
+    },
+    {
+      "required": [
+        "filing_type_name"
+      ]
+    }
+  ]
+}

data/schema/schemas/includes/financial-payment-data-object.json

@@ -0,0 +1,112 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "type": "object",
+  "properties": {
+    "data_type": {
+      "enum": [
+        "financial_payment"
+      ]
+    },
+    "source_url": {
+      "type": "string"
+    },
+    "confidence": {
+      "type": "string"
+    },
+    "properties": {
+      "type": "object",
+      "properties": {
+        "value": {
+          "description": "The amount transacted (e.g. 19.95)",
+          "type": "string"
+        },
+        "payee_name": {
+          "description": "The name of the payee (the entity that received the money)",
+          "type": "string"
+        },
+        "currency": {
+          "description": "The currency of the payment (three letter symbol, e.g. USD, GBP, EUR)",
+          "type": "string"
+        },
+        "date": {
+          "description": "The date on which the payment was made",
+          "type": "date"
+        },
+        "transaction_number": {
+          "description": "The unique identifier for the transaction, scoped to this bot",
+          "type": "string"
+        },
+        "jurisdiction": {
+          "description": "The jurisdiction of the body that made the payment, eg. UK, France, Delaware, Manchester",
+          "type": "string"
+        },
+        "more_details_url": {
+          "description": "A url from which more details can be seen (may be the same as the source_url)",
+          "type": [
+            "string",
+            null
+          ]
+        },
+        "description": {
+          "description": "The description of the transaction as given in the raw data",
+          "type": [
+            "string",
+            null
+          ]
+        },
+        "expense_type": {
+          "description": "The type of expense -- can be either capital, revenue (i.e. current expenditure) or null",
+          "enum": [
+            "capital",
+            "revenue",
+            null
+          ]
+        },
+        "expense_area": {
+          "description": "category (in words) of the expenditure",
+          "type": [
+            "string",
+            null
+          ]
+        },
+        "entity_name": {
+          "description": "The name of the government entity that made the payment, e.g. Environment Agency",
+          "type": "string"
+        },
+        "entity_uri": {
+          "description": "A unique URL (ideally a dereferencable URI) for the government entity",
+          "type": [
+            "string",
+            null
+          ]
+        },
+        "department_name": {
+          "description": "The name of the government department which the entity belongs to (if relevant), e.g. Department of Health",
+          "type": [
+            "string",
+            null
+          ]
+        },
+        "csv_line_number": {
+          "description": "If the source for the data is a CSV file, you can optionally include the line number of the CSV from which this data was retrieved",
+          "type": [
+            "string",
+            null
+          ]
+        }
+      },
+      "required": [
+        "value",
+        "payee_name",
+        "date",
+        "currency"
+      ]
+    }
+  },
+  "required": [
+    "data_type",
+    "properties",
+    "source_url",
+    "confidence"
+  ]
+}

data/schema/schemas/includes/identifier.json

@@ -0,0 +1,20 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "description": "An identifier for an entity (possibly other things, e.g. securities in the future). Examples are tax IDs, non-profit IDs, SEC CIK numbers, Federal Reserve RSSD id. The main requirements for an identifier is that they should be well-defined, and issued by a government or have statutory standing",
+  "type": "object",
+  "properties": {
+    "uid": {
+      "type": "string",
+      "description": "The unique identifier given by the identifier system – it should be unique in the context of the identifier_system",
+      "minLength": 1
+    },
+    "identifier_system_code": {
+      "type": "string",
+      "description": "An identifier representing the identifier scheme. Some examples of this are us_fein (US Federal tax number), us_sec_cik (US Securities and Exchange Commission CIK), uk_ew_cc (Charity Commission of England & Wales), lei (Global Legal Entity Identifier System)"
+    }
+  },
+  "required": [
+    "uid",
+    "identifier_system_code"
+  ]
+}

data/schema/schemas/includes/industry_code.json

@@ -0,0 +1,29 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "description": "An industry code from a standard code list (e.g. NAICS 2007 or NACE 2)",
+  "type": "object",
+  "properties": {
+    "name": {
+      "type": "string"
+    },
+    "code": {
+      "type": "string"
+    },
+    "code_scheme_id": {
+      "type": "string",
+      "description": "An identifier representing industry code scheme. At the moment these are eu_nace_2, uk_sic_2003, uk_sic_2007, us_naics_2002, us_naics_2007, be_nace_2008, dk_db_2007, nz_bic_2006, no_sic_2007, anz_sic_2006, nz_bic_2006, in_nic_2004_mca, ca_qc_cae, lu_nace_2. For other code schemes, or details of these, contact info@opencorporates.com"
+    },
+    "start_date": {
+      "type": "string",
+      "format": "date"
+    },
+    "end_date": {
+      "type": "string",
+      "format": "date"
+    }
+  },
+  "required": [
+    "code",
+    "code_scheme_id"
+  ]
+}

data/schema/schemas/includes/licence-data-object.json

@@ -0,0 +1,63 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "type": "object",
+  "properties": {
+    "data_type": {
+      "enum": [
+        "licence"
+      ]
+    },
+    "source_url": {
+      "type": "string"
+    },
+    "confidence": {
+      "type": "string"
+    },
+    "properties": {
+      "type": "object",
+      "properties": {
+        "regulator": {
+          "description": "The regulating body that issued the licence",
+          "type": "string"
+        },
+        "category": {
+          "description": "The category of licence. Current possible values are: 'Financial','Business'",
+          "enum": [
+            "Financial",
+            "Business"
+          ]
+        },
+        "jurisdiction_code": {
+          "description": "The jurisdiction for which licence was issued",
+          "type": "string"
+        },
+        "licence_number": {
+          "description": "Licence number or code (can be null)",
+          "type": [
+            "string",
+            null
+          ]
+        },
+        "jurisdiction_classification": {
+          "type": "array",
+          "description": "The local classification given by the regulator",
+          "minItems": 1
+        },
+        "oc_classification": {
+          "type": "array"
+        }
+      },
+      "required": [
+        "jurisdiction_code",
+        "jurisdiction_classification",
+        "category"
+      ]
+    }
+  },
+  "required": [
+    "data_type",
+    "properties",
+    "source_url",
+    "confidence"
+  ]
+}

data/schema/schemas/includes/officer.json

@@ -0,0 +1,70 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "description": "An officer (director, senior executive) of a company",
+  "type": "object",
+  "properties": {
+    "name": {
+      "type": "string",
+      "minLength": 1
+    },
+    "start_date": {
+      "anyOf": [
+        {
+          "type": "string",
+          "format": "date"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "end_date": {
+      "anyOf": [
+        {
+          "type": "string",
+          "format": "date"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "position": {
+      "type": "string"
+    },
+    "uid": {
+      "type": "string",
+      "description": "a unique identifier given to the officership"
+    },
+    "other_attributes": {
+      "type": "object",
+      "properties": {
+        "date_of_birth": {
+          "type": "string",
+          "format": "date"
+        },
+        "nationality": {
+          "type": "string"
+        },
+        "person_uid": {
+          "type": "string",
+          "description": "a unique identifier given to the individual (as opposed to the officership)"
+        },
+        "address": {
+          "type": "string"
+        },
+        "type": {
+          "type": "string",
+          "enum": [
+            "Person",
+            "Company"
+          ],
+          "description": "The type of entity that is the officer (either 'Person' or 'Company')"
+        }
+      }
+    }
+  },
+  "required": [
+    "name"
+  ]
+}

data/schema/schemas/includes/organisation.json

@@ -0,0 +1,58 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "description": "An entity which is a distinct organisation, but is not a company nor an individual. Examples include governments and governmental entities (e.g. Multilateral Devoelpment Banks, Government Departments, municipalities, etc), and also membership organisations",
+  "type": "object",
+  "properties": {
+    "name": {
+      "type": "string",
+      "description": "Name of the entity",
+      "minLength": 1
+    },
+    "jurisdiction": {
+      "type": "string",
+      "description": "Name of the jurisdiction in which the entity is incorporated/domiciled (use global for global entities, e.g. UN)"
+    },
+    "website": {
+      "type": "string",
+      "minLength": 5
+    },
+    "telephone_number": {
+      "type": "string",
+      "minLength": 4
+    },
+    "fax_number": {
+      "type": "string",
+      "minLength": 4
+    },
+    "registered_address": {
+      "$ref": "address.json"
+    },
+    "headquarters_address": {
+      "$ref": "address.json"
+    },
+    "mailing_address": {
+      "$ref": "address.json"
+    },
+    "industry_codes": {
+      "type": "array",
+      "items": {
+        "$ref": "industry_code.json"
+      }
+    },
+    "previous_names": {
+      "type": "array",
+      "items": {
+        "$ref": "previous_name.json"
+      }
+    },
+    "alternative_names": {
+      "type": "array",
+      "items": {
+        "$ref": "alternative_name.json"
+      }
+    }
+  },
+  "required": [
+    "name"
+  ]
+}