pharmaobservatory 0.1.10 → 0.1.12

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (26) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +6 -6
  3. data/docs/BiomarkerAssayProvidersRow.md +43 -9
  4. data/docs/BiomarkersRow.md +2 -2
  5. data/docs/CompaniesApi.md +4 -4
  6. data/docs/CompaniesRow.md +1 -1
  7. data/docs/CompanyAssetsRow.md +5 -1
  8. data/docs/CompanyCompetitorsRow.md +5 -1
  9. data/docs/CompanyProgramsRow.md +4 -0
  10. data/docs/InvestorPortfolioRow.md +39 -11
  11. data/docs/InvestorsApi.md +4 -4
  12. data/docs/InvestorsRow.md +3 -1
  13. data/docs/ProgramLicensingCandidatesRow.md +4 -0
  14. data/lib/pharmaobservatory/api/companies_api.rb +2 -2
  15. data/lib/pharmaobservatory/api/investors_api.rb +2 -2
  16. data/lib/pharmaobservatory/models/biomarker_assay_providers_row.rb +221 -28
  17. data/lib/pharmaobservatory/models/biomarkers_row.rb +9 -9
  18. data/lib/pharmaobservatory/models/companies_row.rb +1 -1
  19. data/lib/pharmaobservatory/models/company_assets_row.rb +27 -5
  20. data/lib/pharmaobservatory/models/company_competitors_row.rb +25 -3
  21. data/lib/pharmaobservatory/models/company_programs_row.rb +23 -1
  22. data/lib/pharmaobservatory/models/investor_portfolio_row.rb +169 -13
  23. data/lib/pharmaobservatory/models/investors_row.rb +13 -2
  24. data/lib/pharmaobservatory/models/program_licensing_candidates_row.rb +23 -1
  25. data/lib/pharmaobservatory/version.rb +1 -1
  26. metadata +2 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: cb60f4f5f451e27e537257b6d86965701340469a40f7bfa77d3ae745adb57e0a
4
- data.tar.gz: 98732eeb9ce5e5a62ea64e8d2b4107d9f87b9906fb6af6ac745bdff31737ec83
3
+ metadata.gz: 7f2fb64138e2ac6d5b57fb0efcde57a01e731d5562b1fb68973a55caf4a4e51d
4
+ data.tar.gz: 2115a990ac60d9a4f92b8c63b4e7a7f321774e64d5a3655c7c1ea5065b703e32
5
5
  SHA512:
6
- metadata.gz: 136f34fd85a1bace41b692a0cec2b48540f177f89df1dbfc5f26d147ce5c4a6f0ce26c9c197fc9fa5683064db6e90e1006999e1fe8cc30f1defa91452b31af42
7
- data.tar.gz: 580857430af54263843e1c2d10b4c713b11b12b4fa0aebcc45cc367af1875b65b2a58e1b02ee8cd6a693a4121bbb5b56a5aa1ffd315bc17c342c846c1b2971b0
6
+ metadata.gz: f6ed24d7384703935d059d3eef6d14521f1398eea9077c9e34b453914e9cafe2af0b836fd78b7e9740efe801d2847c801477b924b0157b579189c34aa997c694
7
+ data.tar.gz: 36652385ac2bca0d192fd5adab4ebb5e3f287461ba19be1efa429af97f7df03806e968e2d361071a54434710b5685ff4ce76e83dfcf597630309ef1ba72296e9
data/README.md CHANGED
@@ -39,7 +39,7 @@ Read-only REST API over the Pharma Observatory biomedical data platform. Referen
39
39
  This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
40
40
 
41
41
  - API version: 1.0.0
42
- - Package version: 0.1.10
42
+ - Package version: 0.1.12
43
43
  - Generator version: 7.13.0
44
44
  - Build package: org.openapitools.codegen.languages.RubyClientCodegen
45
45
 
@@ -56,16 +56,16 @@ gem build pharmaobservatory.gemspec
56
56
  Then either install the gem locally:
57
57
 
58
58
  ```shell
59
- gem install ./pharmaobservatory-0.1.10.gem
59
+ gem install ./pharmaobservatory-0.1.12.gem
60
60
  ```
61
61
 
62
- (for development, run `gem install --dev ./pharmaobservatory-0.1.10.gem` to install the development dependencies)
62
+ (for development, run `gem install --dev ./pharmaobservatory-0.1.12.gem` to install the development dependencies)
63
63
 
64
64
  or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
65
65
 
66
66
  Finally add this to the Gemfile:
67
67
 
68
- gem 'pharmaobservatory', '~> 0.1.10'
68
+ gem 'pharmaobservatory', '~> 0.1.12'
69
69
 
70
70
  ### Install from Git
71
71
 
@@ -149,7 +149,7 @@ Class | Method | HTTP request | Description
149
149
  *PharmaObservatory::CompaniesApi* | [**companies_company_biomarker_capability**](docs/CompaniesApi.md#companies_company_biomarker_capability) | **GET** /api/v1/companies/{id}/company_biomarker_capability | Company biomarker capability
150
150
  *PharmaObservatory::CompaniesApi* | [**companies_company_collaborators**](docs/CompaniesApi.md#companies_company_collaborators) | **GET** /api/v1/companies/{id}/company_collaborators | Company study collaborators by disease area
151
151
  *PharmaObservatory::CompaniesApi* | [**companies_company_competitor_activity**](docs/CompaniesApi.md#companies_company_competitor_activity) | **GET** /api/v1/companies/{id}/company_competitor_activity | Company competitor activity by disease area
152
- *PharmaObservatory::CompaniesApi* | [**companies_company_competitors**](docs/CompaniesApi.md#companies_company_competitors) | **GET** /api/v1/companies/{id}/company_competitors | Company competitors
152
+ *PharmaObservatory::CompaniesApi* | [**companies_company_competitors**](docs/CompaniesApi.md#companies_company_competitors) | **GET** /api/v1/companies/{id}/company_competitors | Company program overlap
153
153
  *PharmaObservatory::CompaniesApi* | [**companies_company_financials**](docs/CompaniesApi.md#companies_company_financials) | **GET** /api/v1/companies/{id}/company_financials | Company SEC financials
154
154
  *PharmaObservatory::CompaniesApi* | [**companies_company_firmographics**](docs/CompaniesApi.md#companies_company_firmographics) | **GET** /api/v1/companies/{id}/company_firmographics | Company firmographics
155
155
  *PharmaObservatory::CompaniesApi* | [**companies_company_funding_events**](docs/CompaniesApi.md#companies_company_funding_events) | **GET** /api/v1/companies/{id}/company_funding_events | Company funding events
@@ -276,7 +276,7 @@ Class | Method | HTTP request | Description
276
276
  *PharmaObservatory::InvestorsApi* | [**investors_get**](docs/InvestorsApi.md#investors_get) | **GET** /api/v1/investors/{id} | One investor
277
277
  *PharmaObservatory::InvestorsApi* | [**investors_institutional_holdings**](docs/InvestorsApi.md#investors_institutional_holdings) | **GET** /api/v1/investors/{id}/institutional_holdings | Institutional holdings (SEC Form 13F)
278
278
  *PharmaObservatory::InvestorsApi* | [**investors_investor_funds**](docs/InvestorsApi.md#investors_investor_funds) | **GET** /api/v1/investors/{id}/investor_funds | Investor private funds by type
279
- *PharmaObservatory::InvestorsApi* | [**investors_investor_portfolio**](docs/InvestorsApi.md#investors_investor_portfolio) | **GET** /api/v1/investors/{id}/investor_portfolio | Investor portfolio (offering filings)
279
+ *PharmaObservatory::InvestorsApi* | [**investors_investor_portfolio**](docs/InvestorsApi.md#investors_investor_portfolio) | **GET** /api/v1/investors/{id}/investor_portfolio | Investor portfolio (offering filings and investor websites)
280
280
  *PharmaObservatory::InvestorsApi* | [**investors_investor_private_funds**](docs/InvestorsApi.md#investors_investor_private_funds) | **GET** /api/v1/investors/{id}/investor_private_funds | Investor private funds
281
281
  *PharmaObservatory::InvestorsApi* | [**investors_list**](docs/InvestorsApi.md#investors_list) | **GET** /api/v1/investors | List investors
282
282
  *PharmaObservatory::InvestorsApi* | [**investors_managers**](docs/InvestorsApi.md#investors_managers) | **GET** /api/v1/investors/{id}/managers | Institutional managers (SEC Form 13F)
data/docs/BiomarkerAssayProvidersRow.md CHANGED
@@ -12,9 +12,9 @@
12
12
  | **provider_key** | **String** | The provider the rows are grouped on. org: followed by the organization key when the company resolves to an organization, otherwise name: followed by the normalised company name. | [optional] |
13
13
  | **provider_role** | **String** | What the papers name the provider as. assay_or_test_maker makes the assay or test; testing_service runs it as a service; both when the pair has papers of each kind. | [optional] |
14
14
  | **provider_name** | **String** | The provider company name as it appears in the papers. | [optional] |
15
- | **provider_org_id** | **String** | The provider's legal entity key, where the marketplace match resolves one. | [optional] |
16
- | **provider_org_match_tier** | **String** | How the provider was resolved to an organization. rx_provider_link: through its marketplace supplier. unresolved: no organization, the provider stays a name. The remaining values are reserved for resolution rungs that have not shipped. | [optional] |
17
- | **provider_parent_org_id** | **String** | The ultimate parent organization of the provider's organization; null when the provider has no organization. | [optional] |
15
+ | **provider_org_id** | **String** | The organization the provider's company name resolved to (the member organization, not its parent); null when the provider is ambiguous or unresolved. Reached by the rung named in provider_org_match_tier. | [optional] |
16
+ | **provider_org_match_tier** | **String** | How the provider was resolved to an organization, first rung that yields one organization wins. alias_exact: a reviewed brand alias, then exactly one organization carries the name. name_exact: exactly one organization carries the name. parent_unanimous: several organizations carry the name and all roll up to one parent, which is the organization. sponsor_key: the name is a trial-sponsor key. rx_provider_link: through its marketplace supplier. ambiguous: organizations under more than one parent carry the name, so none is chosen. unresolved: no organization, the provider stays a name. | [optional] |
17
+ | **provider_parent_org_id** | **String** | The resolved parent of provider_org_id in the organization hierarchy (the organization itself when it has none); null when the provider has no organization. The hierarchy is not guaranteed correct for every company, so read it with provider_org_match_tier. | [optional] |
18
18
  | **provider_company_id** | **String** | The provider's company key. | [optional] |
19
19
  | **provider_company_name** | **String** | The provider's company name. | [optional] |
20
20
  | **provider_group_id** | **String** | The provider's current ultimate parent group key. | [optional] |
@@ -32,9 +32,26 @@
32
32
  | **most_recent_pmid** | **String** | The PubMed id of the most recent dated paper. | [optional] |
33
33
  | **most_recent_title** | **String** | The title of that paper. | [optional] |
34
34
  | **meets_curated_threshold** | **Boolean** | True when the provider matches a marketplace supplier or at least two papers name the pair. | [optional] |
35
- | **assay_provider_class** | **String** | The company-level class. diagnostic_provider makes or supplies the diagnostic assay; reagent_supplier is the vendor whose kit appears in a methods section; context_dependent, pharma_or_other and not_a_company are the other decisions; unclassified means no decision yet. | [optional] |
36
- | **assay_provider_class_source** | **String** | Where the class decision came from; null when unclassified. | [optional] |
37
- | **assay_provider_class_decided_at** | **Time** | When the class was decided, in UTC; null when unclassified. | [optional] |
35
+ | **regulatory_evidence_kind** | **String** | The strongest US FDA or CMS record found for the pair. companion_diagnostic: the provider holds an FDA companion diagnostic for the biomarker. fda_cleared_specific_assay: a cleared or approved device of the provider that the paper names and that measures the biomarker. fda_cleared_for_biomarker: the provider holds a cleared or approved IVD under a product code for the biomarker. clia_testing_service: the provider is named as a testing service and its own organization holds a CLIA certificate. fda_ivd_company_only: the provider holds some cleared or approved IVD, none matched to the biomarker. none: no FDA record found. | [optional] |
36
+ | **has_fda_record_for_biomarker** | **Boolean** | True when regulatory_evidence_kind is one of the first four kinds, a record that concerns the biomarker rather than only the company. | [optional] |
37
+ | **regulatory_evidence_reasons** | **Array<String>** | Every level that held for the pair, strongest first; empty when none did. | [optional] |
38
+ | **n_fda_ivd_510k** | **Integer** | The 510(k) clearances in the in-vitro diagnostic review panels held by the provider's organization (or, when it holds none, by organizations under its parent; fda_company_match_rung says which). Null for a provider that did not resolve to an organization. | [optional] |
39
+ | **n_fda_ivd_pma** | **Integer** | The PMA approvals (distinct approval numbers) in the in-vitro diagnostic review panels held by the provider's organization or its parent family, on the same rung as n_fda_ivd_510k. Null for a provider that did not resolve to an organization. | [optional] |
40
+ | **fda_company_match_rung** | **String** | org: the counted records are held by the provider's own organization. parent: by organizations under the same resolved parent. Null when the provider holds none. | [optional] |
41
+ | **n_fda_analyte_510k** | **Integer** | The provider's 510(k) clearances under a product code mapped to this biomarker. Null when the provider or the biomarker did not resolve. | [optional] |
42
+ | **n_fda_analyte_pma** | **Integer** | The provider's PMA approvals under a product code mapped to this biomarker. Null when the provider or the biomarker did not resolve. | [optional] |
43
+ | **fda_analyte_product_codes** | **Array<String>** | The FDA product codes behind n_fda_analyte_510k and n_fda_analyte_pma. | [optional] |
44
+ | **fda_analyte_fda_url** | **String** | The FDA database page of the provider's most recent record under a product code for this biomarker. | [optional] |
45
+ | **specific_assay_matched** | **Boolean** | True when a paper names a cleared or approved device of this provider that measures this biomarker. The device name matches the paper's assay name, or the company's own quote, and the device's analyte agrees with the biomarker. | [optional] |
46
+ | **specific_assay_device_name** | **String** | The 510(k) device name or PMA trade name of the matched device; the best match when several matched. Null when no device matched. | [optional] |
47
+ | **specific_assay_k_number** | **String** | The 510(k) number of the matched device; null when the match is a PMA or there is none. | [optional] |
48
+ | **specific_assay_pma_number** | **String** | The PMA number of the matched device; null when the match is a 510(k) or there is none. | [optional] |
49
+ | **specific_assay_fda_url** | **String** | The FDA database page of the matched device. | [optional] |
50
+ | **specific_assay_similarity** | **Float** | The trigram text similarity (0 to 1) of the larger of the two text clauses that matched the device, the paper's assay name or the company's quote against the device name. | [optional] |
51
+ | **n_cdx_entries** | **Integer** | The FDA companion diagnostic list entries for this biomarker from this provider's organization (or its parent family). Null when the provider or the biomarker did not resolve. | [optional] |
52
+ | **cdx_diagnostic_names** | **Array<String>** | The names of those companion diagnostics. | [optional] |
53
+ | **n_clia_certificates** | **Integer** | The CLIA (US clinical laboratory) certificates held by the provider's organization, or by organizations under its parent when it holds none (clia_match_rung says which). A certificate licenses a lab; it is not evidence that any named assay is run. Null for a provider that did not resolve to an organization. | [optional] |
54
+ | **clia_match_rung** | **String** | org: the counted certificates are held by the provider's own organization. parent: by organizations under the same resolved parent. Null when the provider holds none. | [optional] |
38
55
 
39
56
  ## Example
40
57
 
@@ -70,9 +87,26 @@ instance = PharmaObservatory::BiomarkerAssayProvidersRow.new(
70
87
  most_recent_pmid: null,
71
88
  most_recent_title: null,
72
89
  meets_curated_threshold: null,
73
- assay_provider_class: null,
74
- assay_provider_class_source: null,
75
- assay_provider_class_decided_at: null
90
+ regulatory_evidence_kind: null,
91
+ has_fda_record_for_biomarker: null,
92
+ regulatory_evidence_reasons: null,
93
+ n_fda_ivd_510k: null,
94
+ n_fda_ivd_pma: null,
95
+ fda_company_match_rung: null,
96
+ n_fda_analyte_510k: null,
97
+ n_fda_analyte_pma: null,
98
+ fda_analyte_product_codes: null,
99
+ fda_analyte_fda_url: null,
100
+ specific_assay_matched: null,
101
+ specific_assay_device_name: null,
102
+ specific_assay_k_number: null,
103
+ specific_assay_pma_number: null,
104
+ specific_assay_fda_url: null,
105
+ specific_assay_similarity: null,
106
+ n_cdx_entries: null,
107
+ cdx_diagnostic_names: null,
108
+ n_clia_certificates: null,
109
+ clia_match_rung: null
76
110
  )
77
111
  ```
78
112
 
data/docs/BiomarkersRow.md CHANGED
@@ -30,7 +30,7 @@
30
30
  | **has_analytical_validation_evidence** | **Boolean** | Whether analytical validation evidence exists. | [optional] |
31
31
  | **n_assay_provider_papers** | **Integer** | Papers naming an assay provider for the biomarker. | [optional] |
32
32
  | **n_assay_provider_suppliers** | **Integer** | Assay-provider suppliers named. | [optional] |
33
- | **n_diagnostic_provider_suppliers** | **Integer** | Of those, diagnostic providers. | [optional] |
33
+ | **n_fda_evidence_providers** | **Integer** | Of those, providers with an FDA record found for the biomarker (a companion diagnostic, a cleared or approved device the paper names, a cleared or approved IVD under the analyte's product code, or a CLIA-certified lab that ran the test). US only; no record found is not a statement about validation. Null when no assay provider is named for the biomarker. | [optional] |
34
34
 
35
35
  ## Example
36
36
 
@@ -64,7 +64,7 @@ instance = PharmaObservatory::BiomarkersRow.new(
64
64
  has_analytical_validation_evidence: null,
65
65
  n_assay_provider_papers: null,
66
66
  n_assay_provider_suppliers: null,
67
- n_diagnostic_provider_suppliers: null
67
+ n_fda_evidence_providers: null
68
68
  )
69
69
  ```
70
70
 
data/docs/CompaniesApi.md CHANGED
@@ -15,7 +15,7 @@ All URIs are relative to *https://pharmaobservatory.com*
15
15
  | [**companies_company_biomarker_capability**](CompaniesApi.md#companies_company_biomarker_capability) | **GET** /api/v1/companies/{id}/company_biomarker_capability | Company biomarker capability |
16
16
  | [**companies_company_collaborators**](CompaniesApi.md#companies_company_collaborators) | **GET** /api/v1/companies/{id}/company_collaborators | Company study collaborators by disease area |
17
17
  | [**companies_company_competitor_activity**](CompaniesApi.md#companies_company_competitor_activity) | **GET** /api/v1/companies/{id}/company_competitor_activity | Company competitor activity by disease area |
18
- | [**companies_company_competitors**](CompaniesApi.md#companies_company_competitors) | **GET** /api/v1/companies/{id}/company_competitors | Company competitors |
18
+ | [**companies_company_competitors**](CompaniesApi.md#companies_company_competitors) | **GET** /api/v1/companies/{id}/company_competitors | Company program overlap |
19
19
  | [**companies_company_financials**](CompaniesApi.md#companies_company_financials) | **GET** /api/v1/companies/{id}/company_financials | Company SEC financials |
20
20
  | [**companies_company_firmographics**](CompaniesApi.md#companies_company_firmographics) | **GET** /api/v1/companies/{id}/company_firmographics | Company firmographics |
21
21
  | [**companies_company_funding_events**](CompaniesApi.md#companies_company_funding_events) | **GET** /api/v1/companies/{id}/company_funding_events | Company funding events |
@@ -965,7 +965,7 @@ end
965
965
 
966
966
  > <CompanyCompetitorsResponse> companies_company_competitors(id, opts)
967
967
 
968
- Company competitors
968
+ Company program overlap
969
969
 
970
970
  ### Examples
971
971
 
@@ -990,7 +990,7 @@ opts = {
990
990
  }
991
991
 
992
992
  begin
993
- # Company competitors
993
+ # Company program overlap
994
994
  result = api_instance.companies_company_competitors(id, opts)
995
995
  p result
996
996
  rescue PharmaObservatory::ApiError => e
@@ -1006,7 +1006,7 @@ This returns an Array which contains the response data, status code and headers.
1006
1006
 
1007
1007
  ```ruby
1008
1008
  begin
1009
- # Company competitors
1009
+ # Company program overlap
1010
1010
  data, status_code, headers = api_instance.companies_company_competitors_with_http_info(id, opts)
1011
1011
  p status_code # => 2xx
1012
1012
  p headers # => { ... }
data/docs/CompaniesRow.md CHANGED
@@ -6,7 +6,7 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **company_id** | **String** | The company key (company:&lt;key&gt;). | [optional] |
8
8
  | **company_name** | **String** | The company&#39;s display name: its own legal entity&#39;s name where one is known. | [optional] |
9
- | **name_basis** | **String** | Which source supplied the name: gleif_legal_name, edgar_registrant, ror or sponsor_display_name. | [optional] |
9
+ | **name_basis** | **String** | Which source supplied the name: gleif_legal_name, edgar_registrant, ror, edgar_current_name or sponsor_display_name. | [optional] |
10
10
  | **country** | **String** | Country of the company&#39;s own legal entity, as the source states it. | [optional] |
11
11
  | **org_type** | **String** | The organization type of the company&#39;s representative record: Academic, Government, Hospital, Industry, Nonprofit or Other (from the Research Organization Registry (ROR) record or the filing), or the lowercase tags investor and manufacturer that mark a minted adviser or manufacturer record. | [optional] |
12
12
  | **org_kinds** | **Array&lt;String&gt;** | The roles the company&#39;s organizations play (Manufacturer, Sponsor and so on). | [optional] |
data/docs/CompanyAssetsRow.md CHANGED
@@ -17,6 +17,8 @@
17
17
  | **n_active** | **Integer** | Of those trials, the number recruiting, not yet recruiting, active or enrolling by invitation. | [optional] |
18
18
  | **last_year** | **Integer** | Latest start year among those trials. | [optional] |
19
19
  | **withdrawn** | **Boolean** | True when the drug has been withdrawn from the market. | [optional] |
20
+ | **owned** | **Boolean** | True when the sponsor is judged to develop the drug (an experimental arm, a regulatory holder, or an inferred lead); false when it is the backbone or comparator of a combination, one of many leads of a crowded drug, or not the holder of a generic. Every row is kept; this column labels it. | [optional] |
21
+ | **ownership_basis** | **String** | Why owned is what it is: experimental_arm, regulatory_holder or inferred_lead (owned), or backbone, comparator, crowded_not_lead or generic_not_holder (not owned). inferred_lead is an inference made where the trials give no arm evidence either way. | [optional] |
20
22
 
21
23
  ## Example
22
24
 
@@ -36,7 +38,9 @@ instance = PharmaObservatory::CompanyAssetsRow.new(
36
38
  n_trials: null,
37
39
  n_active: null,
38
40
  last_year: null,
39
- withdrawn: null
41
+ withdrawn: null,
42
+ owned: null,
43
+ ownership_basis: null
40
44
  )
41
45
  ```
42
46
 
data/docs/CompanyCompetitorsRow.md CHANGED
@@ -12,7 +12,9 @@
12
12
  | **competitor_company_name** | **String** | Display name of the competitor&#39;s company. | [optional] |
13
13
  | **competitor_group_id** | **String** | Group level: the competitor&#39;s current ultimate parent; a root&#39;s group is itself. | [optional] |
14
14
  | **competitor_group_name** | **String** | Display name of the competitor&#39;s group. | [optional] |
15
- | **competitor_rank** | **Integer** | The competitor&#39;s rank for the company by competitor_score (1 is the highest). | [optional] |
15
+ | **competitor_class** | **String** | The competitor&#39;s class: industry, or non_industry (not classed as industry by the sponsor-class rule: academic, hospital, government, nonprofit, and any record the rule does not reach). competitor_rank restarts at 1 within each class, so filter or sort on this column first. | [optional] |
16
+ | **n_class_candidates** | **Integer** | How many companies of this competitor_class were candidates (a shared target, or an indication overlap above the similarity floor) before the top 25 were kept. The same value on every row of one company and class. | [optional] |
17
+ | **competitor_rank** | **Integer** | The competitor&#39;s rank within its competitor_class for the company by competitor_score (1 is the highest). | [optional] |
16
18
  | **competitor_score** | **Float** | 100 times the weighted mean of the four similarities below, rounded to four places. | [optional] |
17
19
  | **target_sim** | **Float** | Jaccard similarity, 0 to 1, of the two companies&#39; molecular target sets. | [optional] |
18
20
  | **mechanism_sim** | **Float** | Jaccard similarity, 0 to 1, of their mechanism sets (a target and its action). | [optional] |
@@ -44,6 +46,8 @@ instance = PharmaObservatory::CompanyCompetitorsRow.new(
44
46
  competitor_company_name: null,
45
47
  competitor_group_id: null,
46
48
  competitor_group_name: null,
49
+ competitor_class: null,
50
+ n_class_candidates: null,
47
51
  competitor_rank: null,
48
52
  competitor_score: null,
49
53
  target_sim: null,
data/docs/CompanyProgramsRow.md CHANGED
@@ -20,6 +20,8 @@
20
20
  | **last_year** | **Integer** | Latest trial start year. | [optional] |
21
21
  | **withdrawn** | **Boolean** | True when the drug has been withdrawn. | [optional] |
22
22
  | **lifecycle** | **String** | approved, active or abandoned. | [optional] |
23
+ | **owned** | **Boolean** | True when the sponsor is judged to develop the drug (an experimental arm, a regulatory holder, or an inferred lead); false when it is the backbone or comparator of a combination, one of many leads of a crowded drug, or not the holder of a generic. Every row is kept; this column labels it. | [optional] |
24
+ | **ownership_basis** | **String** | Why owned is what it is: experimental_arm, regulatory_holder or inferred_lead (owned), or backbone, comparator, crowded_not_lead or generic_not_holder (not owned). inferred_lead is an inference made where the trials give no arm evidence either way. | [optional] |
23
25
  | **dalys_millions** | **Float** | Disability-adjusted life years (DALYs, millions) of the condition&#39;s global burden, from the Global Burden of Disease (GBD) 2021 study of the Institute for Health Metrics and Evaluation (IHME). Null for a caller without the licence for this column; see withheld_columns. | [optional] |
24
26
 
25
27
  ## Example
@@ -44,6 +46,8 @@ instance = PharmaObservatory::CompanyProgramsRow.new(
44
46
  last_year: null,
45
47
  withdrawn: null,
46
48
  lifecycle: null,
49
+ owned: null,
50
+ ownership_basis: null,
47
51
  dalys_millions: null
48
52
  )
49
53
  ```
data/docs/InvestorPortfolioRow.md CHANGED
@@ -5,17 +5,31 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **investor_id** | **String** | The investor key. | [optional] |
8
- | **issuer_cik** | **String** | The issuer&#39;s SEC Central Index Key (CIK), ten digits. | [optional] |
9
- | **issuer_name** | **String** | The issuer&#39;s name: its organization record&#39;s name, else the SEC company name. | [optional] |
10
- | **issuer_org_id** | **String** | Legal-entity level: the issuer&#39;s organization record (null when unresolved). | [optional] |
11
- | **issuer_company_id** | **String** | Company level: the issuer&#39;s company (null when unresolved). | [optional] |
12
- | **issuer_company_name** | **String** | Display name of the issuer&#39;s company. | [optional] |
13
- | **issuer_group_id** | **String** | Group level: the issuer&#39;s current ultimate parent; a root&#39;s group is itself. | [optional] |
14
- | **issuer_group_name** | **String** | Display name of the issuer&#39;s group. | [optional] |
15
- | **relationship_types** | **Array&lt;String&gt;** | How the investor is named against the issuer: holder_5pct (a 5 percent holder) or selling_stockholder. | [optional] |
16
- | **edge_count** | **Integer** | Filing mentions behind the row, across every filing and relationship type. | [optional] |
17
- | **first_observed_date** | **Date** | The earliest filing date the investor was named against the issuer. | [optional] |
18
- | **last_observed_date** | **Date** | The latest filing date the investor was named against the issuer. | [optional] |
8
+ | **company_key** | **String** | The company&#39;s key on this dataset: its organization id where it resolves, else the SEC CIK, else investor_site: followed by the normalized name as printed on the investor&#39;s page. | [optional] |
9
+ | **company_key_kind** | **String** | What company_key is: org, cik or investor_site. | [optional] |
10
+ | **sources** | **Array&lt;String&gt;** | Where the row comes from: sec_edgar (S-1 and 424B holder tables), investor_site (the investor&#39;s own portfolio page), or both. | [optional] |
11
+ | **issuer_cik** | **String** | The issuer&#39;s SEC Central Index Key (CIK), ten digits. Null for a row only the investor&#39;s website names. | [optional] |
12
+ | **issuer_name** | **String** | The company&#39;s name: its organization record&#39;s name, else the SEC company name, else the name as printed on the investor&#39;s page. | [optional] |
13
+ | **company_name_as_listed** | **String** | The company&#39;s name as printed on the investor&#39;s own portfolio page. Null for a row only SEC filings name. | [optional] |
14
+ | **company_website_url** | **String** | The company&#39;s website as linked on the investor&#39;s own portfolio page. Null when the page gave none. | [optional] |
15
+ | **issuer_org_id** | **String** | Legal-entity level: the company&#39;s organization record (null when unresolved). | [optional] |
16
+ | **issuer_company_id** | **String** | Company level: the company&#39;s record (null when unresolved). | [optional] |
17
+ | **issuer_company_name** | **String** | Display name of the company. | [optional] |
18
+ | **issuer_group_id** | **String** | Group level: the company&#39;s current ultimate parent; a root&#39;s group is itself. | [optional] |
19
+ | **issuer_group_name** | **String** | Display name of the company&#39;s group. | [optional] |
20
+ | **relationship_types** | **Array&lt;String&gt;** | How the investor is tied to the company: holder_5pct (a 5 percent holder) or selling_stockholder from filings, and portfolio_listed_current, portfolio_listed_realized, portfolio_listed_exited or portfolio_listed (no status printed) from the investor&#39;s own page. | [optional] |
21
+ | **edge_count** | **Integer** | Filing mentions behind the row, across every filing and relationship type. 0 for a row only the investor&#39;s website names. | [optional] |
22
+ | **first_observed_date** | **Date** | The earliest filing date the investor was named against the issuer. Null for a row only the investor&#39;s website names. | [optional] |
23
+ | **last_observed_date** | **Date** | The latest filing date the investor was named against the issuer. Null for a row only the investor&#39;s website names. | [optional] |
24
+ | **listed_from** | **Date** | The retrieval date of the first crawl of the investor&#39;s own portfolio page that listed the company (a crawl date, not an investment date). Null for a row only SEC filings name. | [optional] |
25
+ | **listed_to** | **Date** | The retrieval date of the first later crawl that did not list the company, or the date the page went away. Null while the company is still listed, and for a row only SEC filings name. | [optional] |
26
+ | **removal_reason** | **String** | Why listed_to is set: absent_from_later_version (a later crawl of the page omitted the company) or page_gone (the page went away). Null exactly when listed_to is null. | [optional] |
27
+ | **is_removed** | **Boolean** | True when the investor&#39;s own page no longer lists the company (listed_to is set). SEC filings do not reopen it. | [optional] |
28
+ | **status_on_page** | **String** | The status the investor&#39;s page states for the company, verbatim: current, realized, exited or unknown (the page listed it with no status). Null for a row only SEC filings name. | [optional] |
29
+ | **status_date** | **String** | The date the page itself prints for the status, as printed (for example 2024 or March 2024). Null unless the page printed one. | [optional] |
30
+ | **status_first_observed_at** | **Date** | The date we first saw this status for the company on the investor&#39;s page: an observation date, never the date the event happened. | [optional] |
31
+ | **source_url** | **String** | The address of the investor&#39;s portfolio page the listing was read from. Null for a row only SEC filings name. | [optional] |
32
+ | **site_last_retrieved_at** | **Time** | When the investor&#39;s portfolio page was last retrieved with the company listed on it, in UTC. | [optional] |
19
33
  | **is_life_sciences_issuer** | **Boolean** | True when the issuer&#39;s SIC (Standard Industrial Classification) code is a life-sciences code, false when it is another code, null when the issuer has no SIC evidence. | [optional] |
20
34
 
21
35
  ## Example
@@ -25,8 +39,13 @@ require 'pharmaobservatory'
25
39
 
26
40
  instance = PharmaObservatory::InvestorPortfolioRow.new(
27
41
  investor_id: null,
42
+ company_key: null,
43
+ company_key_kind: null,
44
+ sources: null,
28
45
  issuer_cik: null,
29
46
  issuer_name: null,
47
+ company_name_as_listed: null,
48
+ company_website_url: null,
30
49
  issuer_org_id: null,
31
50
  issuer_company_id: null,
32
51
  issuer_company_name: null,
@@ -36,6 +55,15 @@ instance = PharmaObservatory::InvestorPortfolioRow.new(
36
55
  edge_count: null,
37
56
  first_observed_date: null,
38
57
  last_observed_date: null,
58
+ listed_from: null,
59
+ listed_to: null,
60
+ removal_reason: null,
61
+ is_removed: null,
62
+ status_on_page: null,
63
+ status_date: null,
64
+ status_first_observed_at: null,
65
+ source_url: null,
66
+ site_last_retrieved_at: null,
39
67
  is_life_sciences_issuer: null
40
68
  )
41
69
  ```
data/docs/InvestorsApi.md CHANGED
@@ -7,7 +7,7 @@ All URIs are relative to *https://pharmaobservatory.com*
7
7
  | [**investors_get**](InvestorsApi.md#investors_get) | **GET** /api/v1/investors/{id} | One investor |
8
8
  | [**investors_institutional_holdings**](InvestorsApi.md#investors_institutional_holdings) | **GET** /api/v1/investors/{id}/institutional_holdings | Institutional holdings (SEC Form 13F) |
9
9
  | [**investors_investor_funds**](InvestorsApi.md#investors_investor_funds) | **GET** /api/v1/investors/{id}/investor_funds | Investor private funds by type |
10
- | [**investors_investor_portfolio**](InvestorsApi.md#investors_investor_portfolio) | **GET** /api/v1/investors/{id}/investor_portfolio | Investor portfolio (offering filings) |
10
+ | [**investors_investor_portfolio**](InvestorsApi.md#investors_investor_portfolio) | **GET** /api/v1/investors/{id}/investor_portfolio | Investor portfolio (offering filings and investor websites) |
11
11
  | [**investors_investor_private_funds**](InvestorsApi.md#investors_investor_private_funds) | **GET** /api/v1/investors/{id}/investor_private_funds | Investor private funds |
12
12
  | [**investors_list**](InvestorsApi.md#investors_list) | **GET** /api/v1/investors | List investors |
13
13
  | [**investors_managers**](InvestorsApi.md#investors_managers) | **GET** /api/v1/investors/{id}/managers | Institutional managers (SEC Form 13F) |
@@ -243,7 +243,7 @@ end
243
243
 
244
244
  > <InvestorPortfolioResponse> investors_investor_portfolio(id, opts)
245
245
 
246
- Investor portfolio (offering filings)
246
+ Investor portfolio (offering filings and investor websites)
247
247
 
248
248
  ### Examples
249
249
 
@@ -267,7 +267,7 @@ opts = {
267
267
  }
268
268
 
269
269
  begin
270
- # Investor portfolio (offering filings)
270
+ # Investor portfolio (offering filings and investor websites)
271
271
  result = api_instance.investors_investor_portfolio(id, opts)
272
272
  p result
273
273
  rescue PharmaObservatory::ApiError => e
@@ -283,7 +283,7 @@ This returns an Array which contains the response data, status code and headers.
283
283
 
284
284
  ```ruby
285
285
  begin
286
- # Investor portfolio (offering filings)
286
+ # Investor portfolio (offering filings and investor websites)
287
287
  data, status_code, headers = api_instance.investors_investor_portfolio_with_http_info(id, opts)
288
288
  p status_code # => 2xx
289
289
  p headers # => { ... }
data/docs/InvestorsRow.md CHANGED
@@ -16,7 +16,8 @@
16
16
  | **is_life_sciences_focused_basis** | **String** | Where is_life_sciences_focused came from: human or agent (a recorded classification), override (a curator&#39;s call), edge_share (the share of its portfolio edges in life-sciences issuers) or classifier (the Form 13F biomedical value share). Null exactly when the flag is null. | [optional] |
17
17
  | **private_fund_count** | **Integer** | Private funds the adviser reports on Form ADV Item 7.B. | [optional] |
18
18
  | **total_private_fund_gav** | **Float** | The adviser&#39;s total private-fund gross asset value (GAV) in whole US dollars, a firm-level figure. | [optional] |
19
- | **portfolio_co_count** | **Integer** | Distinct portfolio companies named against the investor in S-1 and 424B offering holder tables. 0 usually means no named-holder link was observed. | [optional] |
19
+ | **portfolio_co_count** | **Integer** | Distinct portfolio companies named against the investor in S-1 and 424B offering holder tables or listed on the investor&#39;s own portfolio page, not marked removed there. 0 usually means no named-holder link or website listing was observed. | [optional] |
20
+ | **portfolio_co_removed_count** | **Integer** | Distinct portfolio companies the investor&#39;s own portfolio page listed in an earlier crawl and no longer lists. portfolio_co_count and this count sum to the investor&#39;s rows in investor_portfolio. | [optional] |
20
21
  | **holdings_position_count** | **Integer** | Current Form 13F positions reported by the managers that resolve to this investor, summed over its manager keys. 0 when none resolves. | [optional] |
21
22
  | **website_url** | **String** | The adviser&#39;s own website from Form ADV Schedule D Section 1.I (scheme and host lower-cased, path kept). Null for an agency and for an adviser whose only listed pages are social-media pages. | [optional] |
22
23
  | **website_domain** | **String** | The host of website_url with the scheme, any port and a leading www stripped, lower-cased. It is never a social-media host. | [optional] |
@@ -46,6 +47,7 @@ instance = PharmaObservatory::InvestorsRow.new(
46
47
  private_fund_count: null,
47
48
  total_private_fund_gav: null,
48
49
  portfolio_co_count: null,
50
+ portfolio_co_removed_count: null,
49
51
  holdings_position_count: null,
50
52
  website_url: null,
51
53
  website_domain: null,
data/docs/ProgramLicensingCandidatesRow.md CHANGED
@@ -21,6 +21,8 @@
21
21
  | **last_year** | **Integer** | Latest trial start year. | [optional] |
22
22
  | **last_update_year** | **Integer** | Year the program&#39;s most recently updated trial record was posted. | [optional] |
23
23
  | **withdrawn** | **Boolean** | True when the drug has been withdrawn. | [optional] |
24
+ | **owned** | **Boolean** | True when the sponsor is judged to develop the drug (an experimental arm, a regulatory holder, or an inferred lead); false when it is the backbone or comparator of a combination, one of many leads of a crowded drug, or not the holder of a generic. Every row is kept; this column labels it. | [optional] |
25
+ | **ownership_basis** | **String** | Why owned is what it is: experimental_arm, regulatory_holder or inferred_lead (owned), or backbone, comparator, crowded_not_lead or generic_not_holder (not owned). inferred_lead is an inference made where the trials give no arm evidence either way. | [optional] |
24
26
  | **cause_name** | **String** | The Global Burden of Disease cause matched to the condition. | [optional] |
25
27
  | **dalys_millions** | **Float** | Global disability-adjusted life years for the matched cause, in millions. | [optional] |
26
28
  | **deaths_millions** | **Float** | Global deaths for the matched cause, in millions. | [optional] |
@@ -49,6 +51,8 @@ instance = PharmaObservatory::ProgramLicensingCandidatesRow.new(
49
51
  last_year: null,
50
52
  last_update_year: null,
51
53
  withdrawn: null,
54
+ owned: null,
55
+ ownership_basis: null,
52
56
  cause_name: null,
53
57
  dalys_millions: null,
54
58
  deaths_millions: null,
data/lib/pharmaobservatory/api/companies_api.rb CHANGED
@@ -1020,7 +1020,7 @@ module PharmaObservatory
1020
1020
  return data, status_code, headers
1021
1021
  end
1022
1022
 
1023
- # Company competitors
1023
+ # Company program overlap
1024
1024
  # @param id [String]
1025
1025
  # @param [Hash] opts the optional parameters
1026
1026
  # @option opts [String] :cursor The next_cursor of the previous page. Opaque; it is bound to the filters and the warehouse build that issued it.
@@ -1035,7 +1035,7 @@ module PharmaObservatory
1035
1035
  data
1036
1036
  end
1037
1037
 
1038
- # Company competitors
1038
+ # Company program overlap
1039
1039
  # @param id [String]
1040
1040
  # @param [Hash] opts the optional parameters
1041
1041
  # @option opts [String] :cursor The next_cursor of the previous page. Opaque; it is bound to the filters and the warehouse build that issued it.
data/lib/pharmaobservatory/api/investors_api.rb CHANGED
@@ -248,7 +248,7 @@ module PharmaObservatory
248
248
  return data, status_code, headers
249
249
  end
250
250
 
251
- # Investor portfolio (offering filings)
251
+ # Investor portfolio (offering filings and investor websites)
252
252
  # @param id [String]
253
253
  # @param [Hash] opts the optional parameters
254
254
  # @option opts [String] :cursor The next_cursor of the previous page. Opaque; it is bound to the filters and the warehouse build that issued it.
@@ -262,7 +262,7 @@ module PharmaObservatory
262
262
  data
263
263
  end
264
264
 
265
- # Investor portfolio (offering filings)
265
+ # Investor portfolio (offering filings and investor websites)
266
266
  # @param id [String]
267
267
  # @param [Hash] opts the optional parameters
268
268
  # @option opts [String] :cursor The next_cursor of the previous page. Opaque; it is bound to the filters and the warehouse build that issued it.