pharmaobservatory 0.1.12 → 0.1.14
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 +32 -4
- data/docs/BiomarkerValidationRow.md +1 -1
- data/docs/ChangesList200Response.md +26 -0
- data/docs/ChangesList200ResponseBuildState.md +20 -0
- data/docs/ChangesList200ResponseItemsInner.md +48 -0
- data/docs/ChangesList200ResponseItemsInnerEntryKeys.md +18 -0
- data/docs/CompaniesApi.md +328 -0
- data/docs/CompaniesRecordAttributes.md +2 -0
- data/docs/CompanyCompetitorsRow.md +3 -1
- data/docs/CompanyCosponsorsResponse.md +58 -0
- data/docs/CompanyCosponsorsRow.md +58 -0
- data/docs/CompanyFinancialsRow.md +18 -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/ConditionAdverseEventsRow.md +5 -1
- data/docs/InvestorPortfolioRow.md +2 -0
- data/docs/LegalEntitiesApi.md +80 -0
- data/docs/SubscriptionsApi.md +282 -0
- data/docs/SubscriptionsCreate201Response.md +22 -0
- data/docs/SubscriptionsCreate201ResponseSubscription.md +28 -0
- data/docs/SubscriptionsCreate201ResponseSubscriptionTarget.md +22 -0
- data/docs/SubscriptionsCreateRequest.md +20 -0
- data/docs/SubscriptionsDelete200Response.md +24 -0
- data/docs/SubscriptionsList200Response.md +22 -0
- data/docs/SubscriptionsList200ResponseSubscriptionsInner.md +28 -0
- data/docs/SubscriptionsList200ResponseSubscriptionsInnerTarget.md +26 -0
- data/docs/SubscriptionsList200ResponseSubscriptionsInnerTargetFilters.md +18 -0
- data/lib/pharmaobservatory/api/companies_api.rb +364 -0
- data/lib/pharmaobservatory/api/legal_entities_api.rb +84 -0
- data/lib/pharmaobservatory/api/subscriptions_api.rb +261 -0
- data/lib/pharmaobservatory/models/biomarker_validation_row.rb +1 -1
- data/lib/pharmaobservatory/models/changes_list200_response.rb +343 -0
- data/lib/pharmaobservatory/models/changes_list200_response_build_state.rb +263 -0
- data/lib/pharmaobservatory/models/changes_list200_response_items_inner.rb +627 -0
- data/lib/pharmaobservatory/models/changes_list200_response_items_inner_entry_keys.rb +237 -0
- data/lib/pharmaobservatory/models/companies_record_attributes.rb +10 -1
- data/lib/pharmaobservatory/models/company_competitors_row.rb +16 -5
- 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_financials_row.rb +100 -1
- 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/condition_adverse_events_row.rb +27 -5
- data/lib/pharmaobservatory/models/investor_portfolio_row.rb +12 -1
- data/lib/pharmaobservatory/models/subscriptions_create201_response.rb +289 -0
- data/lib/pharmaobservatory/models/subscriptions_create201_response_subscription.rb +369 -0
- data/lib/pharmaobservatory/models/subscriptions_create201_response_subscription_target.rb +289 -0
- data/lib/pharmaobservatory/models/subscriptions_create_request.rb +263 -0
- data/lib/pharmaobservatory/models/subscriptions_delete200_response.rb +315 -0
- data/lib/pharmaobservatory/models/subscriptions_list200_response.rb +291 -0
- data/lib/pharmaobservatory/models/subscriptions_list200_response_subscriptions_inner.rb +369 -0
- data/lib/pharmaobservatory/models/subscriptions_list200_response_subscriptions_inner_target.rb +277 -0
- data/lib/pharmaobservatory/models/subscriptions_list200_response_subscriptions_inner_target_filters.rb +237 -0
- data/lib/pharmaobservatory/version.rb +1 -1
- data/lib/pharmaobservatory.rb +20 -0
- metadata +42 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: d76fa5cc1c282ee7fb0c9dbe0d8d175681590bde4ca83e0abc6094fbd30fdefd
|
|
4
|
+
data.tar.gz: fc31c5ca6e2375f4e310ee021fc8a052d7531da6a5f4bda30e86382888597717
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 1bbe8120007013c7a4c7f41f1c45d530b4dc5a8d69ad97a04586fe9a86fac92e5ab8fb881d3d5752a1d76154f83791331ed68420213aee3c9b0a2b6f79ae7cd3
|
|
7
|
+
data.tar.gz: 3deb79b544139548d2d8f134737b9a71141b68b92c2b0470fd85edbfc24e8a7e987efceda57a9dd01636771632f8f2cfaa7c6ff1d203d90044ec30f0468bb89d
|
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.14
|
|
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.14.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.14.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.14'
|
|
69
69
|
|
|
70
70
|
### Install from Git
|
|
71
71
|
|
|
@@ -150,11 +150,14 @@ Class | Method | HTTP request | Description
|
|
|
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
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
|
|
@@ -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
|
|
@@ -385,6 +390,10 @@ Class | Method | HTTP request | Description
|
|
|
385
390
|
*PharmaObservatory::SitesApi* | [**sites_site_trial_conditions**](docs/SitesApi.md#sites_site_trial_conditions) | **GET** /api/v1/sites/{id}/site_trial_conditions | Site trial conditions
|
|
386
391
|
*PharmaObservatory::SitesApi* | [**sites_site_trial_drugs**](docs/SitesApi.md#sites_site_trial_drugs) | **GET** /api/v1/sites/{id}/site_trial_drugs | Site trial drugs
|
|
387
392
|
*PharmaObservatory::SitesApi* | [**sites_site_trials**](docs/SitesApi.md#sites_site_trials) | **GET** /api/v1/sites/{id}/site_trials | Site trials
|
|
393
|
+
*PharmaObservatory::SubscriptionsApi* | [**changes_list**](docs/SubscriptionsApi.md#changes_list) | **GET** /api/v1/changes | Changes since a cursor
|
|
394
|
+
*PharmaObservatory::SubscriptionsApi* | [**subscriptions_create**](docs/SubscriptionsApi.md#subscriptions_create) | **POST** /api/v1/subscriptions | Follow an entity or a dataset query
|
|
395
|
+
*PharmaObservatory::SubscriptionsApi* | [**subscriptions_delete**](docs/SubscriptionsApi.md#subscriptions_delete) | **DELETE** /api/v1/subscriptions/{id} | Stop following
|
|
396
|
+
*PharmaObservatory::SubscriptionsApi* | [**subscriptions_list**](docs/SubscriptionsApi.md#subscriptions_list) | **GET** /api/v1/subscriptions | List your subscriptions
|
|
388
397
|
*PharmaObservatory::SuppliersApi* | [**suppliers_get**](docs/SuppliersApi.md#suppliers_get) | **GET** /api/v1/suppliers/{id} | One supplier
|
|
389
398
|
*PharmaObservatory::SuppliersApi* | [**suppliers_list**](docs/SuppliersApi.md#suppliers_list) | **GET** /api/v1/suppliers | List suppliers
|
|
390
399
|
*PharmaObservatory::SuppliersApi* | [**suppliers_supplier_services**](docs/SuppliersApi.md#suppliers_supplier_services) | **GET** /api/v1/suppliers/{id}/supplier_services | Supplier services
|
|
@@ -480,6 +489,10 @@ Class | Method | HTTP request | Description
|
|
|
480
489
|
- [PharmaObservatory::CellLinesRecord](docs/CellLinesRecord.md)
|
|
481
490
|
- [PharmaObservatory::CellLinesResponse](docs/CellLinesResponse.md)
|
|
482
491
|
- [PharmaObservatory::CellLinesRow](docs/CellLinesRow.md)
|
|
492
|
+
- [PharmaObservatory::ChangesList200Response](docs/ChangesList200Response.md)
|
|
493
|
+
- [PharmaObservatory::ChangesList200ResponseBuildState](docs/ChangesList200ResponseBuildState.md)
|
|
494
|
+
- [PharmaObservatory::ChangesList200ResponseItemsInner](docs/ChangesList200ResponseItemsInner.md)
|
|
495
|
+
- [PharmaObservatory::ChangesList200ResponseItemsInnerEntryKeys](docs/ChangesList200ResponseItemsInnerEntryKeys.md)
|
|
483
496
|
- [PharmaObservatory::CliaCertificatesResponse](docs/CliaCertificatesResponse.md)
|
|
484
497
|
- [PharmaObservatory::CliaCertificatesRow](docs/CliaCertificatesRow.md)
|
|
485
498
|
- [PharmaObservatory::CompaniesRecord](docs/CompaniesRecord.md)
|
|
@@ -496,6 +509,8 @@ Class | Method | HTTP request | Description
|
|
|
496
509
|
- [PharmaObservatory::CompanyCompetitorActivityRow](docs/CompanyCompetitorActivityRow.md)
|
|
497
510
|
- [PharmaObservatory::CompanyCompetitorsResponse](docs/CompanyCompetitorsResponse.md)
|
|
498
511
|
- [PharmaObservatory::CompanyCompetitorsRow](docs/CompanyCompetitorsRow.md)
|
|
512
|
+
- [PharmaObservatory::CompanyCosponsorsResponse](docs/CompanyCosponsorsResponse.md)
|
|
513
|
+
- [PharmaObservatory::CompanyCosponsorsRow](docs/CompanyCosponsorsRow.md)
|
|
499
514
|
- [PharmaObservatory::CompanyFinancialsResponse](docs/CompanyFinancialsResponse.md)
|
|
500
515
|
- [PharmaObservatory::CompanyFinancialsRow](docs/CompanyFinancialsRow.md)
|
|
501
516
|
- [PharmaObservatory::CompanyFirmographicsResponse](docs/CompanyFirmographicsResponse.md)
|
|
@@ -506,6 +521,10 @@ Class | Method | HTTP request | Description
|
|
|
506
521
|
- [PharmaObservatory::CompanyFundingSummaryRow](docs/CompanyFundingSummaryRow.md)
|
|
507
522
|
- [PharmaObservatory::CompanyMembersResponse](docs/CompanyMembersResponse.md)
|
|
508
523
|
- [PharmaObservatory::CompanyMembersRow](docs/CompanyMembersRow.md)
|
|
524
|
+
- [PharmaObservatory::CompanyPeerProfileResponse](docs/CompanyPeerProfileResponse.md)
|
|
525
|
+
- [PharmaObservatory::CompanyPeerProfileRow](docs/CompanyPeerProfileRow.md)
|
|
526
|
+
- [PharmaObservatory::CompanyPeersResponse](docs/CompanyPeersResponse.md)
|
|
527
|
+
- [PharmaObservatory::CompanyPeersRow](docs/CompanyPeersRow.md)
|
|
509
528
|
- [PharmaObservatory::CompanyProgramsResponse](docs/CompanyProgramsResponse.md)
|
|
510
529
|
- [PharmaObservatory::CompanyProgramsRow](docs/CompanyProgramsRow.md)
|
|
511
530
|
- [PharmaObservatory::CompanyRareDiseaseDeclarationsResponse](docs/CompanyRareDiseaseDeclarationsResponse.md)
|
|
@@ -807,6 +826,15 @@ Class | Method | HTTP request | Description
|
|
|
807
826
|
- [PharmaObservatory::SponsorTrialStartForecastRow](docs/SponsorTrialStartForecastRow.md)
|
|
808
827
|
- [PharmaObservatory::SponsorTrialsResponse](docs/SponsorTrialsResponse.md)
|
|
809
828
|
- [PharmaObservatory::SponsorTrialsRow](docs/SponsorTrialsRow.md)
|
|
829
|
+
- [PharmaObservatory::SubscriptionsCreate201Response](docs/SubscriptionsCreate201Response.md)
|
|
830
|
+
- [PharmaObservatory::SubscriptionsCreate201ResponseSubscription](docs/SubscriptionsCreate201ResponseSubscription.md)
|
|
831
|
+
- [PharmaObservatory::SubscriptionsCreate201ResponseSubscriptionTarget](docs/SubscriptionsCreate201ResponseSubscriptionTarget.md)
|
|
832
|
+
- [PharmaObservatory::SubscriptionsCreateRequest](docs/SubscriptionsCreateRequest.md)
|
|
833
|
+
- [PharmaObservatory::SubscriptionsDelete200Response](docs/SubscriptionsDelete200Response.md)
|
|
834
|
+
- [PharmaObservatory::SubscriptionsList200Response](docs/SubscriptionsList200Response.md)
|
|
835
|
+
- [PharmaObservatory::SubscriptionsList200ResponseSubscriptionsInner](docs/SubscriptionsList200ResponseSubscriptionsInner.md)
|
|
836
|
+
- [PharmaObservatory::SubscriptionsList200ResponseSubscriptionsInnerTarget](docs/SubscriptionsList200ResponseSubscriptionsInnerTarget.md)
|
|
837
|
+
- [PharmaObservatory::SubscriptionsList200ResponseSubscriptionsInnerTargetFilters](docs/SubscriptionsList200ResponseSubscriptionsInnerTargetFilters.md)
|
|
810
838
|
- [PharmaObservatory::SupplierCapabilityEsgResponse](docs/SupplierCapabilityEsgResponse.md)
|
|
811
839
|
- [PharmaObservatory::SupplierCapabilityEsgRow](docs/SupplierCapabilityEsgRow.md)
|
|
812
840
|
- [PharmaObservatory::SupplierServicesResponse](docs/SupplierServicesResponse.md)
|
|
@@ -26,7 +26,7 @@
|
|
|
26
26
|
| **evidence_ref_kind** | **String** | What kind of reference evidence_ref is. | [optional] |
|
|
27
27
|
| **trial_id** | **String** | The trial key (an NCT id) when the evidence is a trial; null otherwise. | [optional] |
|
|
28
28
|
| **citation_url** | **String** | A link to the cited record. | [optional] |
|
|
29
|
-
| **citation_verified** | **Boolean** |
|
|
29
|
+
| **citation_verified** | **Boolean** | True on every row. Kept for contract stability; the FDA Biomarker Qualification Program links were rebuilt on the current FDA host (#5778). | [optional] |
|
|
30
30
|
| **evidence_snippet** | **String** | The text span the evidence rests on, where the source gives one. | [optional] |
|
|
31
31
|
| **biomarker_role** | **String** | The biomarker's role in the evidence, where the source states it. | [optional] |
|
|
32
32
|
| **is_surrogate_endpoint_claim** | **Boolean** | True when the evidence is a claim that the biomarker is a surrogate endpoint. | [optional] |
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# PharmaObservatory::ChangesList200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **items** | [**Array<ChangesList200ResponseItemsInner>**](ChangesList200ResponseItemsInner.md) | | |
|
|
8
|
+
| **count** | **Integer** | | |
|
|
9
|
+
| **next_cursor** | **String** | | |
|
|
10
|
+
| **has_more** | **Boolean** | | |
|
|
11
|
+
| **build_state** | [**ChangesList200ResponseBuildState**](ChangesList200ResponseBuildState.md) | | |
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'pharmaobservatory'
|
|
17
|
+
|
|
18
|
+
instance = PharmaObservatory::ChangesList200Response.new(
|
|
19
|
+
items: null,
|
|
20
|
+
count: null,
|
|
21
|
+
next_cursor: null,
|
|
22
|
+
has_more: null,
|
|
23
|
+
build_state: null
|
|
24
|
+
)
|
|
25
|
+
```
|
|
26
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# PharmaObservatory::ChangesList200ResponseBuildState
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **built** | **Boolean** | | |
|
|
8
|
+
| **generation** | **String** | | |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'pharmaobservatory'
|
|
14
|
+
|
|
15
|
+
instance = PharmaObservatory::ChangesList200ResponseBuildState.new(
|
|
16
|
+
built: null,
|
|
17
|
+
generation: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
# PharmaObservatory::ChangesList200ResponseItemsInner
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **Integer** | | |
|
|
8
|
+
| **subscription_id** | **Integer** | | |
|
|
9
|
+
| **event_id** | **String** | | |
|
|
10
|
+
| **dataset** | **String** | | |
|
|
11
|
+
| **key** | **String** | | |
|
|
12
|
+
| **title** | **String** | | |
|
|
13
|
+
| **event_type** | **String** | | |
|
|
14
|
+
| **event_label** | **String** | | |
|
|
15
|
+
| **field** | **String** | | |
|
|
16
|
+
| **old_value** | **String** | | |
|
|
17
|
+
| **new_value** | **String** | | |
|
|
18
|
+
| **source_date** | **String** | | |
|
|
19
|
+
| **observed_at** | **String** | | |
|
|
20
|
+
| **match_kind** | **String** | | |
|
|
21
|
+
| **entry_keys** | [**ChangesList200ResponseItemsInnerEntryKeys**](ChangesList200ResponseItemsInnerEntryKeys.md) | | |
|
|
22
|
+
| **source_credit** | **String** | | |
|
|
23
|
+
|
|
24
|
+
## Example
|
|
25
|
+
|
|
26
|
+
```ruby
|
|
27
|
+
require 'pharmaobservatory'
|
|
28
|
+
|
|
29
|
+
instance = PharmaObservatory::ChangesList200ResponseItemsInner.new(
|
|
30
|
+
id: null,
|
|
31
|
+
subscription_id: null,
|
|
32
|
+
event_id: null,
|
|
33
|
+
dataset: null,
|
|
34
|
+
key: null,
|
|
35
|
+
title: null,
|
|
36
|
+
event_type: null,
|
|
37
|
+
event_label: null,
|
|
38
|
+
field: null,
|
|
39
|
+
old_value: null,
|
|
40
|
+
new_value: null,
|
|
41
|
+
source_date: null,
|
|
42
|
+
observed_at: null,
|
|
43
|
+
match_kind: null,
|
|
44
|
+
entry_keys: null,
|
|
45
|
+
source_credit: null
|
|
46
|
+
)
|
|
47
|
+
```
|
|
48
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# PharmaObservatory::ChangesList200ResponseItemsInnerEntryKeys
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **trials** | **String** | | |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'pharmaobservatory'
|
|
13
|
+
|
|
14
|
+
instance = PharmaObservatory::ChangesList200ResponseItemsInnerEntryKeys.new(
|
|
15
|
+
trials: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
data/docs/CompaniesApi.md
CHANGED
|
@@ -16,11 +16,14 @@ All URIs are relative to *https://pharmaobservatory.com*
|
|
|
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
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 |
|
|
@@ -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
|
```
|
|
@@ -31,6 +31,7 @@
|
|
|
31
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] |
|
|
32
32
|
| **top_shared_indications** | **Array<String>** | Up to 5 shared disease area names, by combined trial count. An empty list when none. | [optional] |
|
|
33
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] |
|
|
34
35
|
|
|
35
36
|
## Example
|
|
36
37
|
|
|
@@ -64,7 +65,8 @@ instance = PharmaObservatory::CompanyCompetitorsRow.new(
|
|
|
64
65
|
n_competitor_indications: null,
|
|
65
66
|
top_shared_targets: null,
|
|
66
67
|
top_shared_indications: null,
|
|
67
|
-
top_shared_mechanisms: null
|
|
68
|
+
top_shared_mechanisms: null,
|
|
69
|
+
n_cosponsored_trials: null
|
|
68
70
|
)
|
|
69
71
|
```
|
|
70
72
|
|