pharmaobservatory 0.1.11 → 0.1.13
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.
- checksums.yaml +4 -4
- data/README.md +17 -6
- data/docs/CompaniesApi.md +332 -4
- data/docs/CompaniesRecordAttributes.md +2 -0
- data/docs/CompaniesRow.md +1 -1
- data/docs/CompanyAssetsRow.md +5 -1
- data/docs/CompanyCompetitorsRow.md +8 -2
- data/docs/CompanyCosponsorsResponse.md +58 -0
- data/docs/CompanyCosponsorsRow.md +58 -0
- data/docs/CompanyPeerProfileResponse.md +58 -0
- data/docs/CompanyPeerProfileRow.md +60 -0
- data/docs/CompanyPeersResponse.md +58 -0
- data/docs/CompanyPeersRow.md +54 -0
- data/docs/CompanyProgramsRow.md +4 -0
- data/docs/InvestorPortfolioRow.md +41 -11
- data/docs/InvestorsApi.md +4 -4
- data/docs/InvestorsRow.md +3 -1
- data/docs/LegalEntitiesApi.md +80 -0
- data/docs/ProgramLicensingCandidatesRow.md +4 -0
- data/lib/pharmaobservatory/api/companies_api.rb +366 -2
- data/lib/pharmaobservatory/api/investors_api.rb +2 -2
- data/lib/pharmaobservatory/api/legal_entities_api.rb +84 -0
- data/lib/pharmaobservatory/models/companies_record_attributes.rb +10 -1
- data/lib/pharmaobservatory/models/companies_row.rb +1 -1
- data/lib/pharmaobservatory/models/company_assets_row.rb +27 -5
- data/lib/pharmaobservatory/models/company_competitors_row.rb +40 -7
- data/lib/pharmaobservatory/models/company_cosponsors_response.rb +478 -0
- data/lib/pharmaobservatory/models/company_cosponsors_row.rb +445 -0
- data/lib/pharmaobservatory/models/company_peer_profile_response.rb +478 -0
- data/lib/pharmaobservatory/models/company_peer_profile_row.rb +454 -0
- data/lib/pharmaobservatory/models/company_peers_response.rb +478 -0
- data/lib/pharmaobservatory/models/company_peers_row.rb +421 -0
- data/lib/pharmaobservatory/models/company_programs_row.rb +23 -1
- data/lib/pharmaobservatory/models/investor_portfolio_row.rb +180 -13
- data/lib/pharmaobservatory/models/investors_row.rb +13 -2
- data/lib/pharmaobservatory/models/program_licensing_candidates_row.rb +23 -1
- data/lib/pharmaobservatory/version.rb +1 -1
- data/lib/pharmaobservatory.rb +6 -0
- metadata +14 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 71ae86e3ce01b4372a57a9c70f1180e1e31b489d07e8f65aeddf8ae48094f0a9
|
|
4
|
+
data.tar.gz: '095ecccdb148e450846277245dbadaa0dcea2af294d5f07545686abd6ff8790d'
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: c60cd42981cbb37923a33487258e78c2f0e6391efb9a905a0f742bceb1a61ec516667c2ba971b24a48552b304d212e01a1abf67c58092260fdada00b204f106e
|
|
7
|
+
data.tar.gz: 01ac5654d2b5eb644ca9cc3184ddab4934fe1e4057956eca641507f15574bffaf705519fbcb5e20a7f14a7188fd459ea743834ff10b21200b83ecfc2aa0879b3
|
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.
|
|
42
|
+
- Package version: 0.1.13
|
|
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.
|
|
59
|
+
gem install ./pharmaobservatory-0.1.13.gem
|
|
60
60
|
```
|
|
61
61
|
|
|
62
|
-
(for development, run `gem install --dev ./pharmaobservatory-0.1.
|
|
62
|
+
(for development, run `gem install --dev ./pharmaobservatory-0.1.13.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.
|
|
68
|
+
gem 'pharmaobservatory', '~> 0.1.13'
|
|
69
69
|
|
|
70
70
|
### Install from Git
|
|
71
71
|
|
|
@@ -149,12 +149,15 @@ 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
|
|
152
|
+
*PharmaObservatory::CompaniesApi* | [**companies_company_competitors**](docs/CompaniesApi.md#companies_company_competitors) | **GET** /api/v1/companies/{id}/company_competitors | Company program overlap
|
|
153
|
+
*PharmaObservatory::CompaniesApi* | [**companies_company_cosponsors**](docs/CompaniesApi.md#companies_company_cosponsors) | **GET** /api/v1/companies/{id}/company_cosponsors | Company co-sponsors
|
|
153
154
|
*PharmaObservatory::CompaniesApi* | [**companies_company_financials**](docs/CompaniesApi.md#companies_company_financials) | **GET** /api/v1/companies/{id}/company_financials | Company SEC financials
|
|
154
155
|
*PharmaObservatory::CompaniesApi* | [**companies_company_firmographics**](docs/CompaniesApi.md#companies_company_firmographics) | **GET** /api/v1/companies/{id}/company_firmographics | Company firmographics
|
|
155
156
|
*PharmaObservatory::CompaniesApi* | [**companies_company_funding_events**](docs/CompaniesApi.md#companies_company_funding_events) | **GET** /api/v1/companies/{id}/company_funding_events | Company funding events
|
|
156
157
|
*PharmaObservatory::CompaniesApi* | [**companies_company_funding_summary**](docs/CompaniesApi.md#companies_company_funding_summary) | **GET** /api/v1/companies/{id}/company_funding_summary | Company funding summary
|
|
157
158
|
*PharmaObservatory::CompaniesApi* | [**companies_company_members**](docs/CompaniesApi.md#companies_company_members) | **GET** /api/v1/companies/{id}/company_members | Company members
|
|
159
|
+
*PharmaObservatory::CompaniesApi* | [**companies_company_peer_profile**](docs/CompaniesApi.md#companies_company_peer_profile) | **GET** /api/v1/companies/{id}/company_peer_profile | Company peer profile
|
|
160
|
+
*PharmaObservatory::CompaniesApi* | [**companies_company_peers**](docs/CompaniesApi.md#companies_company_peers) | **GET** /api/v1/companies/{id}/company_peers | Company peers
|
|
158
161
|
*PharmaObservatory::CompaniesApi* | [**companies_company_programs**](docs/CompaniesApi.md#companies_company_programs) | **GET** /api/v1/companies/{id}/company_programs | Company programs
|
|
159
162
|
*PharmaObservatory::CompaniesApi* | [**companies_company_rare_disease_declarations**](docs/CompaniesApi.md#companies_company_rare_disease_declarations) | **GET** /api/v1/companies/{id}/company_rare_disease_declarations | Organization-wide rare disease declarations
|
|
160
163
|
*PharmaObservatory::CompaniesApi* | [**companies_company_targets**](docs/CompaniesApi.md#companies_company_targets) | **GET** /api/v1/companies/{id}/company_targets | Targets a company pursues
|
|
@@ -174,6 +177,7 @@ Class | Method | HTTP request | Description
|
|
|
174
177
|
*PharmaObservatory::CompaniesApi* | [**companies_inspections**](docs/CompaniesApi.md#companies_inspections) | **GET** /api/v1/companies/{id}/inspections | FDA inspections
|
|
175
178
|
*PharmaObservatory::CompaniesApi* | [**companies_institutional_holdings**](docs/CompaniesApi.md#companies_institutional_holdings) | **GET** /api/v1/companies/{id}/institutional_holdings | Institutional holdings (SEC Form 13F)
|
|
176
179
|
*PharmaObservatory::CompaniesApi* | [**companies_institutional_quarter_totals**](docs/CompaniesApi.md#companies_institutional_quarter_totals) | **GET** /api/v1/companies/{id}/institutional_quarter_totals | Institutional quarter totals (SEC Form 13F)
|
|
180
|
+
*PharmaObservatory::CompaniesApi* | [**companies_investor_portfolio**](docs/CompaniesApi.md#companies_investor_portfolio) | **GET** /api/v1/companies/{id}/investor_portfolio | Investor portfolio (offering filings and investor websites)
|
|
177
181
|
*PharmaObservatory::CompaniesApi* | [**companies_legal_entities**](docs/CompaniesApi.md#companies_legal_entities) | **GET** /api/v1/companies/{id}/legal_entities | Legal entities
|
|
178
182
|
*PharmaObservatory::CompaniesApi* | [**companies_legal_entity_sec_filings**](docs/CompaniesApi.md#companies_legal_entity_sec_filings) | **GET** /api/v1/companies/{id}/legal_entity_sec_filings | SEC filer records
|
|
179
183
|
*PharmaObservatory::CompaniesApi* | [**companies_list**](docs/CompaniesApi.md#companies_list) | **GET** /api/v1/companies | List companies
|
|
@@ -276,7 +280,7 @@ Class | Method | HTTP request | Description
|
|
|
276
280
|
*PharmaObservatory::InvestorsApi* | [**investors_get**](docs/InvestorsApi.md#investors_get) | **GET** /api/v1/investors/{id} | One investor
|
|
277
281
|
*PharmaObservatory::InvestorsApi* | [**investors_institutional_holdings**](docs/InvestorsApi.md#investors_institutional_holdings) | **GET** /api/v1/investors/{id}/institutional_holdings | Institutional holdings (SEC Form 13F)
|
|
278
282
|
*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)
|
|
283
|
+
*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
284
|
*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
285
|
*PharmaObservatory::InvestorsApi* | [**investors_list**](docs/InvestorsApi.md#investors_list) | **GET** /api/v1/investors | List investors
|
|
282
286
|
*PharmaObservatory::InvestorsApi* | [**investors_managers**](docs/InvestorsApi.md#investors_managers) | **GET** /api/v1/investors/{id}/managers | Institutional managers (SEC Form 13F)
|
|
@@ -299,6 +303,7 @@ Class | Method | HTTP request | Description
|
|
|
299
303
|
*PharmaObservatory::LegalEntitiesApi* | [**legal_entities_inspections**](docs/LegalEntitiesApi.md#legal_entities_inspections) | **GET** /api/v1/legal_entities/{id}/inspections | FDA inspections
|
|
300
304
|
*PharmaObservatory::LegalEntitiesApi* | [**legal_entities_institutional_holdings**](docs/LegalEntitiesApi.md#legal_entities_institutional_holdings) | **GET** /api/v1/legal_entities/{id}/institutional_holdings | Institutional holdings (SEC Form 13F)
|
|
301
305
|
*PharmaObservatory::LegalEntitiesApi* | [**legal_entities_institutional_quarter_totals**](docs/LegalEntitiesApi.md#legal_entities_institutional_quarter_totals) | **GET** /api/v1/legal_entities/{id}/institutional_quarter_totals | Institutional quarter totals (SEC Form 13F)
|
|
306
|
+
*PharmaObservatory::LegalEntitiesApi* | [**legal_entities_investor_portfolio**](docs/LegalEntitiesApi.md#legal_entities_investor_portfolio) | **GET** /api/v1/legal_entities/{id}/investor_portfolio | Investor portfolio (offering filings and investor websites)
|
|
302
307
|
*PharmaObservatory::LegalEntitiesApi* | [**legal_entities_legal_entity_sec_filings**](docs/LegalEntitiesApi.md#legal_entities_legal_entity_sec_filings) | **GET** /api/v1/legal_entities/{id}/legal_entity_sec_filings | SEC filer records
|
|
303
308
|
*PharmaObservatory::LegalEntitiesApi* | [**legal_entities_list**](docs/LegalEntitiesApi.md#legal_entities_list) | **GET** /api/v1/legal_entities | List legal entities
|
|
304
309
|
*PharmaObservatory::LegalEntitiesApi* | [**legal_entities_org_disclosure_trend**](docs/LegalEntitiesApi.md#legal_entities_org_disclosure_trend) | **GET** /api/v1/legal_entities/{id}/org_disclosure_trend | Organization disclosure trend
|
|
@@ -496,6 +501,8 @@ Class | Method | HTTP request | Description
|
|
|
496
501
|
- [PharmaObservatory::CompanyCompetitorActivityRow](docs/CompanyCompetitorActivityRow.md)
|
|
497
502
|
- [PharmaObservatory::CompanyCompetitorsResponse](docs/CompanyCompetitorsResponse.md)
|
|
498
503
|
- [PharmaObservatory::CompanyCompetitorsRow](docs/CompanyCompetitorsRow.md)
|
|
504
|
+
- [PharmaObservatory::CompanyCosponsorsResponse](docs/CompanyCosponsorsResponse.md)
|
|
505
|
+
- [PharmaObservatory::CompanyCosponsorsRow](docs/CompanyCosponsorsRow.md)
|
|
499
506
|
- [PharmaObservatory::CompanyFinancialsResponse](docs/CompanyFinancialsResponse.md)
|
|
500
507
|
- [PharmaObservatory::CompanyFinancialsRow](docs/CompanyFinancialsRow.md)
|
|
501
508
|
- [PharmaObservatory::CompanyFirmographicsResponse](docs/CompanyFirmographicsResponse.md)
|
|
@@ -506,6 +513,10 @@ Class | Method | HTTP request | Description
|
|
|
506
513
|
- [PharmaObservatory::CompanyFundingSummaryRow](docs/CompanyFundingSummaryRow.md)
|
|
507
514
|
- [PharmaObservatory::CompanyMembersResponse](docs/CompanyMembersResponse.md)
|
|
508
515
|
- [PharmaObservatory::CompanyMembersRow](docs/CompanyMembersRow.md)
|
|
516
|
+
- [PharmaObservatory::CompanyPeerProfileResponse](docs/CompanyPeerProfileResponse.md)
|
|
517
|
+
- [PharmaObservatory::CompanyPeerProfileRow](docs/CompanyPeerProfileRow.md)
|
|
518
|
+
- [PharmaObservatory::CompanyPeersResponse](docs/CompanyPeersResponse.md)
|
|
519
|
+
- [PharmaObservatory::CompanyPeersRow](docs/CompanyPeersRow.md)
|
|
509
520
|
- [PharmaObservatory::CompanyProgramsResponse](docs/CompanyProgramsResponse.md)
|
|
510
521
|
- [PharmaObservatory::CompanyProgramsRow](docs/CompanyProgramsRow.md)
|
|
511
522
|
- [PharmaObservatory::CompanyRareDiseaseDeclarationsResponse](docs/CompanyRareDiseaseDeclarationsResponse.md)
|
data/docs/CompaniesApi.md
CHANGED
|
@@ -15,12 +15,15 @@ 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
|
|
18
|
+
| [**companies_company_competitors**](CompaniesApi.md#companies_company_competitors) | **GET** /api/v1/companies/{id}/company_competitors | Company program overlap |
|
|
19
|
+
| [**companies_company_cosponsors**](CompaniesApi.md#companies_company_cosponsors) | **GET** /api/v1/companies/{id}/company_cosponsors | Company co-sponsors |
|
|
19
20
|
| [**companies_company_financials**](CompaniesApi.md#companies_company_financials) | **GET** /api/v1/companies/{id}/company_financials | Company SEC financials |
|
|
20
21
|
| [**companies_company_firmographics**](CompaniesApi.md#companies_company_firmographics) | **GET** /api/v1/companies/{id}/company_firmographics | Company firmographics |
|
|
21
22
|
| [**companies_company_funding_events**](CompaniesApi.md#companies_company_funding_events) | **GET** /api/v1/companies/{id}/company_funding_events | Company funding events |
|
|
22
23
|
| [**companies_company_funding_summary**](CompaniesApi.md#companies_company_funding_summary) | **GET** /api/v1/companies/{id}/company_funding_summary | Company funding summary |
|
|
23
24
|
| [**companies_company_members**](CompaniesApi.md#companies_company_members) | **GET** /api/v1/companies/{id}/company_members | Company members |
|
|
25
|
+
| [**companies_company_peer_profile**](CompaniesApi.md#companies_company_peer_profile) | **GET** /api/v1/companies/{id}/company_peer_profile | Company peer profile |
|
|
26
|
+
| [**companies_company_peers**](CompaniesApi.md#companies_company_peers) | **GET** /api/v1/companies/{id}/company_peers | Company peers |
|
|
24
27
|
| [**companies_company_programs**](CompaniesApi.md#companies_company_programs) | **GET** /api/v1/companies/{id}/company_programs | Company programs |
|
|
25
28
|
| [**companies_company_rare_disease_declarations**](CompaniesApi.md#companies_company_rare_disease_declarations) | **GET** /api/v1/companies/{id}/company_rare_disease_declarations | Organization-wide rare disease declarations |
|
|
26
29
|
| [**companies_company_targets**](CompaniesApi.md#companies_company_targets) | **GET** /api/v1/companies/{id}/company_targets | Targets a company pursues |
|
|
@@ -40,6 +43,7 @@ All URIs are relative to *https://pharmaobservatory.com*
|
|
|
40
43
|
| [**companies_inspections**](CompaniesApi.md#companies_inspections) | **GET** /api/v1/companies/{id}/inspections | FDA inspections |
|
|
41
44
|
| [**companies_institutional_holdings**](CompaniesApi.md#companies_institutional_holdings) | **GET** /api/v1/companies/{id}/institutional_holdings | Institutional holdings (SEC Form 13F) |
|
|
42
45
|
| [**companies_institutional_quarter_totals**](CompaniesApi.md#companies_institutional_quarter_totals) | **GET** /api/v1/companies/{id}/institutional_quarter_totals | Institutional quarter totals (SEC Form 13F) |
|
|
46
|
+
| [**companies_investor_portfolio**](CompaniesApi.md#companies_investor_portfolio) | **GET** /api/v1/companies/{id}/investor_portfolio | Investor portfolio (offering filings and investor websites) |
|
|
43
47
|
| [**companies_legal_entities**](CompaniesApi.md#companies_legal_entities) | **GET** /api/v1/companies/{id}/legal_entities | Legal entities |
|
|
44
48
|
| [**companies_legal_entity_sec_filings**](CompaniesApi.md#companies_legal_entity_sec_filings) | **GET** /api/v1/companies/{id}/legal_entity_sec_filings | SEC filer records |
|
|
45
49
|
| [**companies_list**](CompaniesApi.md#companies_list) | **GET** /api/v1/companies | List companies |
|
|
@@ -965,7 +969,7 @@ end
|
|
|
965
969
|
|
|
966
970
|
> <CompanyCompetitorsResponse> companies_company_competitors(id, opts)
|
|
967
971
|
|
|
968
|
-
Company
|
|
972
|
+
Company program overlap
|
|
969
973
|
|
|
970
974
|
### Examples
|
|
971
975
|
|
|
@@ -990,7 +994,7 @@ opts = {
|
|
|
990
994
|
}
|
|
991
995
|
|
|
992
996
|
begin
|
|
993
|
-
# Company
|
|
997
|
+
# Company program overlap
|
|
994
998
|
result = api_instance.companies_company_competitors(id, opts)
|
|
995
999
|
p result
|
|
996
1000
|
rescue PharmaObservatory::ApiError => e
|
|
@@ -1006,7 +1010,7 @@ This returns an Array which contains the response data, status code and headers.
|
|
|
1006
1010
|
|
|
1007
1011
|
```ruby
|
|
1008
1012
|
begin
|
|
1009
|
-
# Company
|
|
1013
|
+
# Company program overlap
|
|
1010
1014
|
data, status_code, headers = api_instance.companies_company_competitors_with_http_info(id, opts)
|
|
1011
1015
|
p status_code # => 2xx
|
|
1012
1016
|
p headers # => { ... }
|
|
@@ -1042,6 +1046,87 @@ end
|
|
|
1042
1046
|
- **Accept**: application/json
|
|
1043
1047
|
|
|
1044
1048
|
|
|
1049
|
+
## companies_company_cosponsors
|
|
1050
|
+
|
|
1051
|
+
> <CompanyCosponsorsResponse> companies_company_cosponsors(id, opts)
|
|
1052
|
+
|
|
1053
|
+
Company co-sponsors
|
|
1054
|
+
|
|
1055
|
+
### Examples
|
|
1056
|
+
|
|
1057
|
+
```ruby
|
|
1058
|
+
require 'time'
|
|
1059
|
+
require 'pharmaobservatory'
|
|
1060
|
+
# setup authorization
|
|
1061
|
+
PharmaObservatory.configure do |config|
|
|
1062
|
+
# Configure Bearer authorization (JWT): ApiBearerJwt
|
|
1063
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1064
|
+
end
|
|
1065
|
+
|
|
1066
|
+
api_instance = PharmaObservatory::CompaniesApi.new
|
|
1067
|
+
id = 'company:c0185cf6c39a2536ad436cf6255494c0' # String |
|
|
1068
|
+
opts = {
|
|
1069
|
+
cursor: 'cursor_example', # String | The next_cursor of the previous page. Opaque; it is bound to the filters and the warehouse build that issued it.
|
|
1070
|
+
limit: 56, # Integer | Rows per page, up to 500 (default 50).
|
|
1071
|
+
sort: 'sort_example', # String | Comma separated columns, a leading minus for descending: sort=a,-b.
|
|
1072
|
+
group_by: 'group_by_example', # String | A dimension to group by; a date takes :year, :quarter or :month.
|
|
1073
|
+
measure: 'measure_example', # String | count, sum(col), avg(col), min(col), max(col), median(col) or count_distinct(col).
|
|
1074
|
+
scope: 'company' # String | company (this company only) or group (its corporate group).
|
|
1075
|
+
}
|
|
1076
|
+
|
|
1077
|
+
begin
|
|
1078
|
+
# Company co-sponsors
|
|
1079
|
+
result = api_instance.companies_company_cosponsors(id, opts)
|
|
1080
|
+
p result
|
|
1081
|
+
rescue PharmaObservatory::ApiError => e
|
|
1082
|
+
puts "Error when calling CompaniesApi->companies_company_cosponsors: #{e}"
|
|
1083
|
+
end
|
|
1084
|
+
```
|
|
1085
|
+
|
|
1086
|
+
#### Using the companies_company_cosponsors_with_http_info variant
|
|
1087
|
+
|
|
1088
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1089
|
+
|
|
1090
|
+
> <Array(<CompanyCosponsorsResponse>, Integer, Hash)> companies_company_cosponsors_with_http_info(id, opts)
|
|
1091
|
+
|
|
1092
|
+
```ruby
|
|
1093
|
+
begin
|
|
1094
|
+
# Company co-sponsors
|
|
1095
|
+
data, status_code, headers = api_instance.companies_company_cosponsors_with_http_info(id, opts)
|
|
1096
|
+
p status_code # => 2xx
|
|
1097
|
+
p headers # => { ... }
|
|
1098
|
+
p data # => <CompanyCosponsorsResponse>
|
|
1099
|
+
rescue PharmaObservatory::ApiError => e
|
|
1100
|
+
puts "Error when calling CompaniesApi->companies_company_cosponsors_with_http_info: #{e}"
|
|
1101
|
+
end
|
|
1102
|
+
```
|
|
1103
|
+
|
|
1104
|
+
### Parameters
|
|
1105
|
+
|
|
1106
|
+
| Name | Type | Description | Notes |
|
|
1107
|
+
| ---- | ---- | ----------- | ----- |
|
|
1108
|
+
| **id** | **String** | | |
|
|
1109
|
+
| **cursor** | **String** | The next_cursor of the previous page. Opaque; it is bound to the filters and the warehouse build that issued it. | [optional] |
|
|
1110
|
+
| **limit** | **Integer** | Rows per page, up to 500 (default 50). | [optional] |
|
|
1111
|
+
| **sort** | **String** | Comma separated columns, a leading minus for descending: sort=a,-b. | [optional] |
|
|
1112
|
+
| **group_by** | **String** | A dimension to group by; a date takes :year, :quarter or :month. | [optional] |
|
|
1113
|
+
| **measure** | **String** | count, sum(col), avg(col), min(col), max(col), median(col) or count_distinct(col). | [optional] |
|
|
1114
|
+
| **scope** | **String** | company (this company only) or group (its corporate group). | [optional] |
|
|
1115
|
+
|
|
1116
|
+
### Return type
|
|
1117
|
+
|
|
1118
|
+
[**CompanyCosponsorsResponse**](CompanyCosponsorsResponse.md)
|
|
1119
|
+
|
|
1120
|
+
### Authorization
|
|
1121
|
+
|
|
1122
|
+
[ApiBearerJwt](../README.md#ApiBearerJwt)
|
|
1123
|
+
|
|
1124
|
+
### HTTP request headers
|
|
1125
|
+
|
|
1126
|
+
- **Content-Type**: Not defined
|
|
1127
|
+
- **Accept**: application/json
|
|
1128
|
+
|
|
1129
|
+
|
|
1045
1130
|
## companies_company_financials
|
|
1046
1131
|
|
|
1047
1132
|
> <CompanyFinancialsResponse> companies_company_financials(id, opts)
|
|
@@ -1447,6 +1532,168 @@ end
|
|
|
1447
1532
|
- **Accept**: application/json
|
|
1448
1533
|
|
|
1449
1534
|
|
|
1535
|
+
## companies_company_peer_profile
|
|
1536
|
+
|
|
1537
|
+
> <CompanyPeerProfileResponse> companies_company_peer_profile(id, opts)
|
|
1538
|
+
|
|
1539
|
+
Company peer profile
|
|
1540
|
+
|
|
1541
|
+
### Examples
|
|
1542
|
+
|
|
1543
|
+
```ruby
|
|
1544
|
+
require 'time'
|
|
1545
|
+
require 'pharmaobservatory'
|
|
1546
|
+
# setup authorization
|
|
1547
|
+
PharmaObservatory.configure do |config|
|
|
1548
|
+
# Configure Bearer authorization (JWT): ApiBearerJwt
|
|
1549
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1550
|
+
end
|
|
1551
|
+
|
|
1552
|
+
api_instance = PharmaObservatory::CompaniesApi.new
|
|
1553
|
+
id = 'company:c0185cf6c39a2536ad436cf6255494c0' # String |
|
|
1554
|
+
opts = {
|
|
1555
|
+
cursor: 'cursor_example', # String | The next_cursor of the previous page. Opaque; it is bound to the filters and the warehouse build that issued it.
|
|
1556
|
+
limit: 56, # Integer | Rows per page, up to 500 (default 50).
|
|
1557
|
+
sort: 'sort_example', # String | Comma separated columns, a leading minus for descending: sort=a,-b.
|
|
1558
|
+
group_by: 'group_by_example', # String | A dimension to group by; a date takes :year, :quarter or :month.
|
|
1559
|
+
measure: 'measure_example', # String | count, sum(col), avg(col), min(col), max(col), median(col) or count_distinct(col).
|
|
1560
|
+
scope: 'company' # String | company (this company only) or group (its corporate group).
|
|
1561
|
+
}
|
|
1562
|
+
|
|
1563
|
+
begin
|
|
1564
|
+
# Company peer profile
|
|
1565
|
+
result = api_instance.companies_company_peer_profile(id, opts)
|
|
1566
|
+
p result
|
|
1567
|
+
rescue PharmaObservatory::ApiError => e
|
|
1568
|
+
puts "Error when calling CompaniesApi->companies_company_peer_profile: #{e}"
|
|
1569
|
+
end
|
|
1570
|
+
```
|
|
1571
|
+
|
|
1572
|
+
#### Using the companies_company_peer_profile_with_http_info variant
|
|
1573
|
+
|
|
1574
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1575
|
+
|
|
1576
|
+
> <Array(<CompanyPeerProfileResponse>, Integer, Hash)> companies_company_peer_profile_with_http_info(id, opts)
|
|
1577
|
+
|
|
1578
|
+
```ruby
|
|
1579
|
+
begin
|
|
1580
|
+
# Company peer profile
|
|
1581
|
+
data, status_code, headers = api_instance.companies_company_peer_profile_with_http_info(id, opts)
|
|
1582
|
+
p status_code # => 2xx
|
|
1583
|
+
p headers # => { ... }
|
|
1584
|
+
p data # => <CompanyPeerProfileResponse>
|
|
1585
|
+
rescue PharmaObservatory::ApiError => e
|
|
1586
|
+
puts "Error when calling CompaniesApi->companies_company_peer_profile_with_http_info: #{e}"
|
|
1587
|
+
end
|
|
1588
|
+
```
|
|
1589
|
+
|
|
1590
|
+
### Parameters
|
|
1591
|
+
|
|
1592
|
+
| Name | Type | Description | Notes |
|
|
1593
|
+
| ---- | ---- | ----------- | ----- |
|
|
1594
|
+
| **id** | **String** | | |
|
|
1595
|
+
| **cursor** | **String** | The next_cursor of the previous page. Opaque; it is bound to the filters and the warehouse build that issued it. | [optional] |
|
|
1596
|
+
| **limit** | **Integer** | Rows per page, up to 500 (default 50). | [optional] |
|
|
1597
|
+
| **sort** | **String** | Comma separated columns, a leading minus for descending: sort=a,-b. | [optional] |
|
|
1598
|
+
| **group_by** | **String** | A dimension to group by; a date takes :year, :quarter or :month. | [optional] |
|
|
1599
|
+
| **measure** | **String** | count, sum(col), avg(col), min(col), max(col), median(col) or count_distinct(col). | [optional] |
|
|
1600
|
+
| **scope** | **String** | company (this company only) or group (its corporate group). | [optional] |
|
|
1601
|
+
|
|
1602
|
+
### Return type
|
|
1603
|
+
|
|
1604
|
+
[**CompanyPeerProfileResponse**](CompanyPeerProfileResponse.md)
|
|
1605
|
+
|
|
1606
|
+
### Authorization
|
|
1607
|
+
|
|
1608
|
+
[ApiBearerJwt](../README.md#ApiBearerJwt)
|
|
1609
|
+
|
|
1610
|
+
### HTTP request headers
|
|
1611
|
+
|
|
1612
|
+
- **Content-Type**: Not defined
|
|
1613
|
+
- **Accept**: application/json
|
|
1614
|
+
|
|
1615
|
+
|
|
1616
|
+
## companies_company_peers
|
|
1617
|
+
|
|
1618
|
+
> <CompanyPeersResponse> companies_company_peers(id, opts)
|
|
1619
|
+
|
|
1620
|
+
Company peers
|
|
1621
|
+
|
|
1622
|
+
### Examples
|
|
1623
|
+
|
|
1624
|
+
```ruby
|
|
1625
|
+
require 'time'
|
|
1626
|
+
require 'pharmaobservatory'
|
|
1627
|
+
# setup authorization
|
|
1628
|
+
PharmaObservatory.configure do |config|
|
|
1629
|
+
# Configure Bearer authorization (JWT): ApiBearerJwt
|
|
1630
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1631
|
+
end
|
|
1632
|
+
|
|
1633
|
+
api_instance = PharmaObservatory::CompaniesApi.new
|
|
1634
|
+
id = 'company:c0185cf6c39a2536ad436cf6255494c0' # String |
|
|
1635
|
+
opts = {
|
|
1636
|
+
cursor: 'cursor_example', # String | The next_cursor of the previous page. Opaque; it is bound to the filters and the warehouse build that issued it.
|
|
1637
|
+
limit: 56, # Integer | Rows per page, up to 500 (default 50).
|
|
1638
|
+
sort: 'sort_example', # String | Comma separated columns, a leading minus for descending: sort=a,-b.
|
|
1639
|
+
group_by: 'group_by_example', # String | A dimension to group by; a date takes :year, :quarter or :month.
|
|
1640
|
+
measure: 'measure_example', # String | count, sum(col), avg(col), min(col), max(col), median(col) or count_distinct(col).
|
|
1641
|
+
scope: 'company' # String | company (this company only) or group (its corporate group).
|
|
1642
|
+
}
|
|
1643
|
+
|
|
1644
|
+
begin
|
|
1645
|
+
# Company peers
|
|
1646
|
+
result = api_instance.companies_company_peers(id, opts)
|
|
1647
|
+
p result
|
|
1648
|
+
rescue PharmaObservatory::ApiError => e
|
|
1649
|
+
puts "Error when calling CompaniesApi->companies_company_peers: #{e}"
|
|
1650
|
+
end
|
|
1651
|
+
```
|
|
1652
|
+
|
|
1653
|
+
#### Using the companies_company_peers_with_http_info variant
|
|
1654
|
+
|
|
1655
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1656
|
+
|
|
1657
|
+
> <Array(<CompanyPeersResponse>, Integer, Hash)> companies_company_peers_with_http_info(id, opts)
|
|
1658
|
+
|
|
1659
|
+
```ruby
|
|
1660
|
+
begin
|
|
1661
|
+
# Company peers
|
|
1662
|
+
data, status_code, headers = api_instance.companies_company_peers_with_http_info(id, opts)
|
|
1663
|
+
p status_code # => 2xx
|
|
1664
|
+
p headers # => { ... }
|
|
1665
|
+
p data # => <CompanyPeersResponse>
|
|
1666
|
+
rescue PharmaObservatory::ApiError => e
|
|
1667
|
+
puts "Error when calling CompaniesApi->companies_company_peers_with_http_info: #{e}"
|
|
1668
|
+
end
|
|
1669
|
+
```
|
|
1670
|
+
|
|
1671
|
+
### Parameters
|
|
1672
|
+
|
|
1673
|
+
| Name | Type | Description | Notes |
|
|
1674
|
+
| ---- | ---- | ----------- | ----- |
|
|
1675
|
+
| **id** | **String** | | |
|
|
1676
|
+
| **cursor** | **String** | The next_cursor of the previous page. Opaque; it is bound to the filters and the warehouse build that issued it. | [optional] |
|
|
1677
|
+
| **limit** | **Integer** | Rows per page, up to 500 (default 50). | [optional] |
|
|
1678
|
+
| **sort** | **String** | Comma separated columns, a leading minus for descending: sort=a,-b. | [optional] |
|
|
1679
|
+
| **group_by** | **String** | A dimension to group by; a date takes :year, :quarter or :month. | [optional] |
|
|
1680
|
+
| **measure** | **String** | count, sum(col), avg(col), min(col), max(col), median(col) or count_distinct(col). | [optional] |
|
|
1681
|
+
| **scope** | **String** | company (this company only) or group (its corporate group). | [optional] |
|
|
1682
|
+
|
|
1683
|
+
### Return type
|
|
1684
|
+
|
|
1685
|
+
[**CompanyPeersResponse**](CompanyPeersResponse.md)
|
|
1686
|
+
|
|
1687
|
+
### Authorization
|
|
1688
|
+
|
|
1689
|
+
[ApiBearerJwt](../README.md#ApiBearerJwt)
|
|
1690
|
+
|
|
1691
|
+
### HTTP request headers
|
|
1692
|
+
|
|
1693
|
+
- **Content-Type**: Not defined
|
|
1694
|
+
- **Accept**: application/json
|
|
1695
|
+
|
|
1696
|
+
|
|
1450
1697
|
## companies_company_programs
|
|
1451
1698
|
|
|
1452
1699
|
> <CompanyProgramsResponse> companies_company_programs(id, opts)
|
|
@@ -2972,6 +3219,87 @@ end
|
|
|
2972
3219
|
- **Accept**: application/json
|
|
2973
3220
|
|
|
2974
3221
|
|
|
3222
|
+
## companies_investor_portfolio
|
|
3223
|
+
|
|
3224
|
+
> <InvestorPortfolioResponse> companies_investor_portfolio(id, opts)
|
|
3225
|
+
|
|
3226
|
+
Investor portfolio (offering filings and investor websites)
|
|
3227
|
+
|
|
3228
|
+
### Examples
|
|
3229
|
+
|
|
3230
|
+
```ruby
|
|
3231
|
+
require 'time'
|
|
3232
|
+
require 'pharmaobservatory'
|
|
3233
|
+
# setup authorization
|
|
3234
|
+
PharmaObservatory.configure do |config|
|
|
3235
|
+
# Configure Bearer authorization (JWT): ApiBearerJwt
|
|
3236
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
3237
|
+
end
|
|
3238
|
+
|
|
3239
|
+
api_instance = PharmaObservatory::CompaniesApi.new
|
|
3240
|
+
id = 'company:c0185cf6c39a2536ad436cf6255494c0' # String |
|
|
3241
|
+
opts = {
|
|
3242
|
+
cursor: 'cursor_example', # String | The next_cursor of the previous page. Opaque; it is bound to the filters and the warehouse build that issued it.
|
|
3243
|
+
limit: 56, # Integer | Rows per page, up to 500 (default 50).
|
|
3244
|
+
sort: 'sort_example', # String | Comma separated columns, a leading minus for descending: sort=a,-b.
|
|
3245
|
+
group_by: 'group_by_example', # String | A dimension to group by; a date takes :year, :quarter or :month.
|
|
3246
|
+
measure: 'measure_example', # String | count, sum(col), avg(col), min(col), max(col), median(col) or count_distinct(col).
|
|
3247
|
+
scope: 'company' # String | company (this company only) or group (its corporate group).
|
|
3248
|
+
}
|
|
3249
|
+
|
|
3250
|
+
begin
|
|
3251
|
+
# Investor portfolio (offering filings and investor websites)
|
|
3252
|
+
result = api_instance.companies_investor_portfolio(id, opts)
|
|
3253
|
+
p result
|
|
3254
|
+
rescue PharmaObservatory::ApiError => e
|
|
3255
|
+
puts "Error when calling CompaniesApi->companies_investor_portfolio: #{e}"
|
|
3256
|
+
end
|
|
3257
|
+
```
|
|
3258
|
+
|
|
3259
|
+
#### Using the companies_investor_portfolio_with_http_info variant
|
|
3260
|
+
|
|
3261
|
+
This returns an Array which contains the response data, status code and headers.
|
|
3262
|
+
|
|
3263
|
+
> <Array(<InvestorPortfolioResponse>, Integer, Hash)> companies_investor_portfolio_with_http_info(id, opts)
|
|
3264
|
+
|
|
3265
|
+
```ruby
|
|
3266
|
+
begin
|
|
3267
|
+
# Investor portfolio (offering filings and investor websites)
|
|
3268
|
+
data, status_code, headers = api_instance.companies_investor_portfolio_with_http_info(id, opts)
|
|
3269
|
+
p status_code # => 2xx
|
|
3270
|
+
p headers # => { ... }
|
|
3271
|
+
p data # => <InvestorPortfolioResponse>
|
|
3272
|
+
rescue PharmaObservatory::ApiError => e
|
|
3273
|
+
puts "Error when calling CompaniesApi->companies_investor_portfolio_with_http_info: #{e}"
|
|
3274
|
+
end
|
|
3275
|
+
```
|
|
3276
|
+
|
|
3277
|
+
### Parameters
|
|
3278
|
+
|
|
3279
|
+
| Name | Type | Description | Notes |
|
|
3280
|
+
| ---- | ---- | ----------- | ----- |
|
|
3281
|
+
| **id** | **String** | | |
|
|
3282
|
+
| **cursor** | **String** | The next_cursor of the previous page. Opaque; it is bound to the filters and the warehouse build that issued it. | [optional] |
|
|
3283
|
+
| **limit** | **Integer** | Rows per page, up to 500 (default 50). | [optional] |
|
|
3284
|
+
| **sort** | **String** | Comma separated columns, a leading minus for descending: sort=a,-b. | [optional] |
|
|
3285
|
+
| **group_by** | **String** | A dimension to group by; a date takes :year, :quarter or :month. | [optional] |
|
|
3286
|
+
| **measure** | **String** | count, sum(col), avg(col), min(col), max(col), median(col) or count_distinct(col). | [optional] |
|
|
3287
|
+
| **scope** | **String** | company (this company only) or group (its corporate group). | [optional] |
|
|
3288
|
+
|
|
3289
|
+
### Return type
|
|
3290
|
+
|
|
3291
|
+
[**InvestorPortfolioResponse**](InvestorPortfolioResponse.md)
|
|
3292
|
+
|
|
3293
|
+
### Authorization
|
|
3294
|
+
|
|
3295
|
+
[ApiBearerJwt](../README.md#ApiBearerJwt)
|
|
3296
|
+
|
|
3297
|
+
### HTTP request headers
|
|
3298
|
+
|
|
3299
|
+
- **Content-Type**: Not defined
|
|
3300
|
+
- **Accept**: application/json
|
|
3301
|
+
|
|
3302
|
+
|
|
2975
3303
|
## companies_legal_entities
|
|
2976
3304
|
|
|
2977
3305
|
> <LegalEntitiesResponse> companies_legal_entities(id, opts)
|
|
@@ -6,6 +6,7 @@
|
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **company_firmographics** | [**CompanyFirmographicsRow**](CompanyFirmographicsRow.md) | | [optional] |
|
|
8
8
|
| **company_funding_summary** | [**CompanyFundingSummaryRow**](CompanyFundingSummaryRow.md) | | [optional] |
|
|
9
|
+
| **company_peer_profile** | [**CompanyPeerProfileRow**](CompanyPeerProfileRow.md) | | [optional] |
|
|
9
10
|
| **company_trial_geography** | [**CompanyTrialGeographyRow**](CompanyTrialGeographyRow.md) | | [optional] |
|
|
10
11
|
|
|
11
12
|
## Example
|
|
@@ -16,6 +17,7 @@ require 'pharmaobservatory'
|
|
|
16
17
|
instance = PharmaObservatory::CompaniesRecordAttributes.new(
|
|
17
18
|
company_firmographics: null,
|
|
18
19
|
company_funding_summary: null,
|
|
20
|
+
company_peer_profile: null,
|
|
19
21
|
company_trial_geography: null
|
|
20
22
|
)
|
|
21
23
|
```
|
data/docs/CompaniesRow.md
CHANGED
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **company_id** | **String** | The company key (company:<key>). | [optional] |
|
|
8
8
|
| **company_name** | **String** | The company's display name: its own legal entity'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's own legal entity, as the source states it. | [optional] |
|
|
11
11
|
| **org_type** | **String** | The organization type of the company'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<String>** | The roles the company'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
|
|
|
@@ -12,7 +12,9 @@
|
|
|
12
12
|
| **competitor_company_name** | **String** | Display name of the competitor's company. | [optional] |
|
|
13
13
|
| **competitor_group_id** | **String** | Group level: the competitor's current ultimate parent; a root's group is itself. | [optional] |
|
|
14
14
|
| **competitor_group_name** | **String** | Display name of the competitor's group. | [optional] |
|
|
15
|
-
| **
|
|
15
|
+
| **competitor_class** | **String** | The competitor'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'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' molecular target sets. | [optional] |
|
|
18
20
|
| **mechanism_sim** | **Float** | Jaccard similarity, 0 to 1, of their mechanism sets (a target and its action). | [optional] |
|
|
@@ -29,6 +31,7 @@
|
|
|
29
31
|
| **top_shared_targets** | **Array<String>** | Up to 5 shared target gene symbols, by combined phase then combined trials. An empty list when none. | [optional] |
|
|
30
32
|
| **top_shared_indications** | **Array<String>** | Up to 5 shared disease area names, by combined trial count. An empty list when none. | [optional] |
|
|
31
33
|
| **top_shared_mechanisms** | **Array<String>** | Up to 3 shared mechanisms written as a gene symbol and an action, by combined phase then combined trials. An empty list when none. | [optional] |
|
|
34
|
+
| **n_cosponsored_trials** | **Integer** | Distinct trials on which the company and the competitor are both named as sponsors, counted over their subtrees; 0 when none. A consortium trial (more than 25 sponsor companies) is left out. | [optional] |
|
|
32
35
|
|
|
33
36
|
## Example
|
|
34
37
|
|
|
@@ -44,6 +47,8 @@ instance = PharmaObservatory::CompanyCompetitorsRow.new(
|
|
|
44
47
|
competitor_company_name: null,
|
|
45
48
|
competitor_group_id: null,
|
|
46
49
|
competitor_group_name: null,
|
|
50
|
+
competitor_class: null,
|
|
51
|
+
n_class_candidates: null,
|
|
47
52
|
competitor_rank: null,
|
|
48
53
|
competitor_score: null,
|
|
49
54
|
target_sim: null,
|
|
@@ -60,7 +65,8 @@ instance = PharmaObservatory::CompanyCompetitorsRow.new(
|
|
|
60
65
|
n_competitor_indications: null,
|
|
61
66
|
top_shared_targets: null,
|
|
62
67
|
top_shared_indications: null,
|
|
63
|
-
top_shared_mechanisms: null
|
|
68
|
+
top_shared_mechanisms: null,
|
|
69
|
+
n_cosponsored_trials: null
|
|
64
70
|
)
|
|
65
71
|
```
|
|
66
72
|
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
# PharmaObservatory::CompanyCosponsorsResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **dataset** | **String** | | |
|
|
8
|
+
| **grain** | **String** | | [optional] |
|
|
9
|
+
| **object_type** | **String** | | [optional] |
|
|
10
|
+
| **id** | **String** | | [optional] |
|
|
11
|
+
| **scope** | [**AnimalWelfareAssurancesResponseScope**](AnimalWelfareAssurancesResponseScope.md) | | [optional] |
|
|
12
|
+
| **columns** | [**Array<DatasetColumn>**](DatasetColumn.md) | | |
|
|
13
|
+
| **rows** | [**Array<CompanyCosponsorsRow>**](CompanyCosponsorsRow.md) | | |
|
|
14
|
+
| **total** | **Integer** | The exact count of the filtered rows on an ungrouped read, carried by the cursor; null when grouped. | [optional] |
|
|
15
|
+
| **next_cursor** | **String** | | [optional] |
|
|
16
|
+
| **sort** | **Array<String>** | | [optional] |
|
|
17
|
+
| **filters** | **Array<Hash<String, Object>>** | | [optional] |
|
|
18
|
+
| **group_by** | **Array<String>** | | [optional] |
|
|
19
|
+
| **measures** | **Array<String>** | | [optional] |
|
|
20
|
+
| **attribution** | [**Array<DatasetAttribution>**](DatasetAttribution.md) | | [optional] |
|
|
21
|
+
| **source_credit** | **String** | | [optional] |
|
|
22
|
+
| **withheld_tiers** | **Array<String>** | | [optional] |
|
|
23
|
+
| **withheld_columns** | **Array<String>** | | [optional] |
|
|
24
|
+
| **freshness** | [**AnimalWelfareAssurancesResponseFreshness**](AnimalWelfareAssurancesResponseFreshness.md) | | [optional] |
|
|
25
|
+
| **build** | [**AnimalWelfareAssurancesResponseBuild**](AnimalWelfareAssurancesResponseBuild.md) | | [optional] |
|
|
26
|
+
| **build_state** | [**DatasetBuildState**](DatasetBuildState.md) | | [optional] |
|
|
27
|
+
| **restriction** | **Hash<String, Object>** | | [optional] |
|
|
28
|
+
|
|
29
|
+
## Example
|
|
30
|
+
|
|
31
|
+
```ruby
|
|
32
|
+
require 'pharmaobservatory'
|
|
33
|
+
|
|
34
|
+
instance = PharmaObservatory::CompanyCosponsorsResponse.new(
|
|
35
|
+
dataset: null,
|
|
36
|
+
grain: null,
|
|
37
|
+
object_type: null,
|
|
38
|
+
id: null,
|
|
39
|
+
scope: null,
|
|
40
|
+
columns: null,
|
|
41
|
+
rows: null,
|
|
42
|
+
total: null,
|
|
43
|
+
next_cursor: null,
|
|
44
|
+
sort: null,
|
|
45
|
+
filters: null,
|
|
46
|
+
group_by: null,
|
|
47
|
+
measures: null,
|
|
48
|
+
attribution: null,
|
|
49
|
+
source_credit: null,
|
|
50
|
+
withheld_tiers: null,
|
|
51
|
+
withheld_columns: null,
|
|
52
|
+
freshness: null,
|
|
53
|
+
build: null,
|
|
54
|
+
build_state: null,
|
|
55
|
+
restriction: null
|
|
56
|
+
)
|
|
57
|
+
```
|
|
58
|
+
|