pharmaobservatory 0.1.3 → 0.1.5
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 +105 -4
- data/docs/ApiV1WhoamiGet200Response.md +13 -1
- data/docs/ApiV1WhoamiGet200ResponseLimits.md +32 -0
- data/docs/ApiV1WhoamiGet200ResponseQuota.md +20 -0
- data/docs/ApiV1WhoamiGet200ResponseQuotaBuckets.md +28 -0
- data/docs/ApiV1WhoamiGet200ResponseQuotaBucketsRequestsPerMinute.md +28 -0
- data/docs/BiomarkerBqpAssertionsRow.md +1 -1
- data/docs/BiomarkerEvidenceRow.md +1 -1
- data/docs/BiomarkerLiteratureRow.md +1 -1
- data/docs/BiomarkerRelationsResponse.md +58 -0
- data/docs/BiomarkerRelationsRow.md +54 -0
- data/docs/BiomarkerSampleCoverageResponse.md +58 -0
- data/docs/BiomarkerSampleCoverageRow.md +36 -0
- data/docs/BiomarkerSamplePrevalenceResponse.md +58 -0
- data/docs/BiomarkerSamplePrevalenceRow.md +56 -0
- data/docs/BiomarkerValidationResponse.md +58 -0
- data/docs/BiomarkerValidationRow.md +70 -0
- data/docs/BiomarkersApi.md +320 -0
- data/docs/BiomarkersRow.md +2 -2
- data/docs/CellLinesRow.md +1 -1
- data/docs/CompaniesApi.md +410 -0
- data/docs/CompaniesRecord.md +1 -1
- data/docs/CompaniesRecordAttributes.md +18 -0
- data/docs/CompaniesRow.md +8 -4
- data/docs/CompanyAssetsResponse.md +58 -0
- data/docs/CompanyAssetsRow.md +42 -0
- data/docs/CompanyFundingEventsResponse.md +58 -0
- data/docs/CompanyFundingEventsRow.md +62 -0
- data/docs/CompanyFundingSummaryResponse.md +58 -0
- data/docs/CompanyFundingSummaryRow.md +46 -0
- data/docs/CompanyProgramsRow.md +2 -2
- data/docs/ConditionAdverseEventsResponse.md +58 -0
- data/docs/ConditionAdverseEventsRow.md +24 -0
- data/docs/ConditionBurdenResponse.md +58 -0
- data/docs/ConditionBurdenRow.md +32 -0
- data/docs/ConditionDeliveryResponse.md +58 -0
- data/docs/ConditionDeliveryRow.md +44 -0
- data/docs/ConditionDrugsResponse.md +58 -0
- data/docs/ConditionDrugsRow.md +26 -0
- data/docs/ConditionPrevalenceResponse.md +58 -0
- data/docs/ConditionPrevalenceRow.md +62 -0
- data/docs/ConditionPublicationsResponse.md +58 -0
- data/docs/ConditionPublicationsRow.md +32 -0
- data/docs/ConditionSitesResponse.md +58 -0
- data/docs/ConditionSitesRow.md +28 -0
- data/docs/ConditionTrialsResponse.md +58 -0
- data/docs/ConditionTrialsRow.md +60 -0
- data/docs/ConditionsApi.md +953 -0
- data/docs/ConditionsRecord.md +38 -0
- data/docs/ConditionsRecordAttributes.md +20 -0
- data/docs/ConditionsResponse.md +58 -0
- data/docs/ConditionsRow.md +32 -0
- data/docs/DrugPatentCliffRow.md +1 -1
- data/docs/InstitutionalHoldingsRow.md +3 -1
- data/docs/LegalEntitiesApi.md +160 -0
- data/docs/LegalEntitiesRow.md +2 -2
- data/docs/OwnershipPositionsResponse.md +58 -0
- data/docs/OwnershipPositionsRow.md +100 -0
- data/docs/PdufaDatesRow.md +2 -2
- data/docs/SiteCroTrialsRow.md +1 -1
- data/docs/SiteTrialConditionsRow.md +1 -1
- data/docs/SiteTrialDrugsRow.md +1 -1
- data/docs/SiteTrialsRow.md +4 -2
- data/docs/SponsorRecruitmentByPhaseRow.md +2 -2
- data/docs/SponsorRecruitmentDurationRow.md +1 -1
- data/docs/SponsorTrialsRow.md +5 -3
- data/docs/TrialAdverseEventsResponse.md +58 -0
- data/docs/TrialAdverseEventsRow.md +28 -0
- data/docs/TrialChangesResponse.md +58 -0
- data/docs/TrialChangesRow.md +36 -0
- data/docs/TrialDeliveryResponse.md +58 -0
- data/docs/TrialDeliveryRow.md +66 -0
- data/docs/TrialDemographicsResponse.md +58 -0
- data/docs/TrialDemographicsRow.md +32 -0
- data/docs/TrialDrugsResponse.md +58 -0
- data/docs/TrialDrugsRow.md +30 -0
- data/docs/TrialEnrollmentHistoryResponse.md +58 -0
- data/docs/TrialEnrollmentHistoryRow.md +36 -0
- data/docs/TrialEnrollmentRateResponse.md +58 -0
- data/docs/TrialEnrollmentRateRow.md +60 -0
- data/docs/TrialExtractedEndpointsResponse.md +58 -0
- data/docs/TrialExtractedEndpointsRow.md +40 -0
- data/docs/TrialOutcomeMeasuresResponse.md +58 -0
- data/docs/TrialOutcomeMeasuresRow.md +28 -0
- data/docs/TrialSitesResponse.md +58 -0
- data/docs/TrialSitesRow.md +46 -0
- data/docs/TrialsApi.md +1033 -0
- data/docs/TrialsRecord.md +38 -0
- data/docs/TrialsRecordAttributes.md +24 -0
- data/docs/TrialsResponse.md +58 -0
- data/docs/TrialsRow.md +116 -0
- data/lib/pharmaobservatory/api/biomarkers_api.rb +336 -0
- data/lib/pharmaobservatory/api/companies_api.rb +455 -0
- data/lib/pharmaobservatory/api/conditions_api.rb +1001 -0
- data/lib/pharmaobservatory/api/legal_entities_api.rb +168 -0
- data/lib/pharmaobservatory/api/trials_api.rb +1085 -0
- data/lib/pharmaobservatory/models/api_v1_whoami_get200_response.rb +62 -4
- data/lib/pharmaobservatory/models/api_v1_whoami_get200_response_limits.rb +419 -0
- data/lib/pharmaobservatory/models/api_v1_whoami_get200_response_quota.rb +263 -0
- data/lib/pharmaobservatory/models/api_v1_whoami_get200_response_quota_buckets.rb +367 -0
- data/lib/pharmaobservatory/models/api_v1_whoami_get200_response_quota_buckets_requests_per_minute.rb +367 -0
- data/lib/pharmaobservatory/models/biomarker_bqp_assertions_row.rb +1 -1
- data/lib/pharmaobservatory/models/biomarker_evidence_row.rb +1 -1
- data/lib/pharmaobservatory/models/biomarker_literature_row.rb +1 -1
- data/lib/pharmaobservatory/models/biomarker_relations_response.rb +478 -0
- data/lib/pharmaobservatory/models/biomarker_relations_row.rb +421 -0
- data/lib/pharmaobservatory/models/biomarker_sample_coverage_response.rb +478 -0
- data/lib/pharmaobservatory/models/biomarker_sample_coverage_row.rb +322 -0
- data/lib/pharmaobservatory/models/biomarker_sample_prevalence_response.rb +478 -0
- data/lib/pharmaobservatory/models/biomarker_sample_prevalence_row.rb +436 -0
- data/lib/pharmaobservatory/models/biomarker_validation_response.rb +478 -0
- data/lib/pharmaobservatory/models/biomarker_validation_row.rb +509 -0
- data/lib/pharmaobservatory/models/biomarkers_row.rb +2 -2
- data/lib/pharmaobservatory/models/cell_lines_row.rb +1 -1
- data/lib/pharmaobservatory/models/companies_record.rb +1 -1
- data/lib/pharmaobservatory/models/companies_record_attributes.rb +220 -0
- data/lib/pharmaobservatory/models/companies_row.rb +30 -8
- data/lib/pharmaobservatory/models/company_assets_response.rb +478 -0
- data/lib/pharmaobservatory/models/company_assets_row.rb +355 -0
- data/lib/pharmaobservatory/models/company_funding_events_response.rb +478 -0
- data/lib/pharmaobservatory/models/company_funding_events_row.rb +465 -0
- data/lib/pharmaobservatory/models/company_funding_summary_response.rb +478 -0
- data/lib/pharmaobservatory/models/company_funding_summary_row.rb +377 -0
- data/lib/pharmaobservatory/models/company_programs_row.rb +2 -2
- data/lib/pharmaobservatory/models/condition_adverse_events_response.rb +478 -0
- data/lib/pharmaobservatory/models/condition_adverse_events_row.rb +256 -0
- data/lib/pharmaobservatory/models/condition_burden_response.rb +478 -0
- data/lib/pharmaobservatory/models/condition_burden_row.rb +300 -0
- data/lib/pharmaobservatory/models/condition_delivery_response.rb +478 -0
- data/lib/pharmaobservatory/models/condition_delivery_row.rb +366 -0
- data/lib/pharmaobservatory/models/condition_drugs_response.rb +478 -0
- data/lib/pharmaobservatory/models/condition_drugs_row.rb +267 -0
- data/lib/pharmaobservatory/models/condition_prevalence_response.rb +478 -0
- data/lib/pharmaobservatory/models/condition_prevalence_row.rb +465 -0
- data/lib/pharmaobservatory/models/condition_publications_response.rb +478 -0
- data/lib/pharmaobservatory/models/condition_publications_row.rb +300 -0
- data/lib/pharmaobservatory/models/condition_sites_response.rb +478 -0
- data/lib/pharmaobservatory/models/condition_sites_row.rb +278 -0
- data/lib/pharmaobservatory/models/condition_trials_response.rb +478 -0
- data/lib/pharmaobservatory/models/condition_trials_row.rb +454 -0
- data/lib/pharmaobservatory/models/conditions_record.rb +385 -0
- data/lib/pharmaobservatory/models/conditions_record_attributes.rb +229 -0
- data/lib/pharmaobservatory/models/conditions_response.rb +478 -0
- data/lib/pharmaobservatory/models/conditions_row.rb +304 -0
- data/lib/pharmaobservatory/models/drug_patent_cliff_row.rb +1 -1
- data/lib/pharmaobservatory/models/institutional_holdings_row.rb +13 -2
- data/lib/pharmaobservatory/models/legal_entities_row.rb +2 -2
- data/lib/pharmaobservatory/models/ownership_positions_response.rb +478 -0
- data/lib/pharmaobservatory/models/ownership_positions_row.rb +674 -0
- data/lib/pharmaobservatory/models/pdufa_dates_row.rb +2 -2
- data/lib/pharmaobservatory/models/site_cro_trials_row.rb +1 -1
- data/lib/pharmaobservatory/models/site_trial_conditions_row.rb +1 -1
- data/lib/pharmaobservatory/models/site_trial_drugs_row.rb +1 -1
- data/lib/pharmaobservatory/models/site_trials_row.rb +14 -3
- data/lib/pharmaobservatory/models/sponsor_recruitment_by_phase_row.rb +2 -2
- data/lib/pharmaobservatory/models/sponsor_recruitment_duration_row.rb +1 -1
- data/lib/pharmaobservatory/models/sponsor_trials_row.rb +15 -4
- data/lib/pharmaobservatory/models/trial_adverse_events_response.rb +478 -0
- data/lib/pharmaobservatory/models/trial_adverse_events_row.rb +278 -0
- data/lib/pharmaobservatory/models/trial_changes_response.rb +478 -0
- data/lib/pharmaobservatory/models/trial_changes_row.rb +328 -0
- data/lib/pharmaobservatory/models/trial_delivery_response.rb +478 -0
- data/lib/pharmaobservatory/models/trial_delivery_row.rb +487 -0
- data/lib/pharmaobservatory/models/trial_demographics_response.rb +478 -0
- data/lib/pharmaobservatory/models/trial_demographics_row.rb +300 -0
- data/lib/pharmaobservatory/models/trial_drugs_response.rb +478 -0
- data/lib/pharmaobservatory/models/trial_drugs_row.rb +291 -0
- data/lib/pharmaobservatory/models/trial_enrollment_history_response.rb +478 -0
- data/lib/pharmaobservatory/models/trial_enrollment_history_row.rb +322 -0
- data/lib/pharmaobservatory/models/trial_enrollment_rate_response.rb +478 -0
- data/lib/pharmaobservatory/models/trial_enrollment_rate_row.rb +454 -0
- data/lib/pharmaobservatory/models/trial_extracted_endpoints_response.rb +478 -0
- data/lib/pharmaobservatory/models/trial_extracted_endpoints_row.rb +346 -0
- data/lib/pharmaobservatory/models/trial_outcome_measures_response.rb +478 -0
- data/lib/pharmaobservatory/models/trial_outcome_measures_row.rb +278 -0
- data/lib/pharmaobservatory/models/trial_sites_response.rb +478 -0
- data/lib/pharmaobservatory/models/trial_sites_row.rb +377 -0
- data/lib/pharmaobservatory/models/trials_record.rb +385 -0
- data/lib/pharmaobservatory/models/trials_record_attributes.rb +247 -0
- data/lib/pharmaobservatory/models/trials_response.rb +478 -0
- data/lib/pharmaobservatory/models/trials_row.rb +784 -0
- data/lib/pharmaobservatory/version.rb +1 -1
- data/lib/pharmaobservatory.rb +67 -0
- metadata +136 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 6ffeec6b419dc15d5c32a280ef1469a180de04fc445f3a3e87e826d99ce4b197
|
|
4
|
+
data.tar.gz: 35d53c85a65df008e5b13a37d219f4a4928454cdabab5862c590fb43f1e34849
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 964df18c43a0df959d7f0d3760e46fe4f0eb1dd7b9757ef3f43b1de864f102d9f42c1c9ebfc5c7ecb9e773f89b4c63e3119740d33003aebcf1b62ab023664832
|
|
7
|
+
data.tar.gz: b8a4ab84755f06f307e02f6b92641bd3fbf0f5c308169585631ba2d300df790340e558a91d9c8cb1f333bd137cb4cc7bd0086c64bfaec59939687f132fe54ca5
|
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.5
|
|
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.5.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.5.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.5'
|
|
69
69
|
|
|
70
70
|
### Install from Git
|
|
71
71
|
|
|
@@ -123,6 +123,10 @@ Class | Method | HTTP request | Description
|
|
|
123
123
|
*PharmaObservatory::BiomarkersApi* | [**biomarkers_biomarker_evidence**](docs/BiomarkersApi.md#biomarkers_biomarker_evidence) | **GET** /api/v1/biomarkers/{id}/biomarker_evidence | Biomarker evidence
|
|
124
124
|
*PharmaObservatory::BiomarkersApi* | [**biomarkers_biomarker_literature**](docs/BiomarkersApi.md#biomarkers_biomarker_literature) | **GET** /api/v1/biomarkers/{id}/biomarker_literature | Trial-cited literature mentions
|
|
125
125
|
*PharmaObservatory::BiomarkersApi* | [**biomarkers_biomarker_publishing_companies**](docs/BiomarkersApi.md#biomarkers_biomarker_publishing_companies) | **GET** /api/v1/biomarkers/{id}/biomarker_publishing_companies | Companies publishing on a biomarker
|
|
126
|
+
*PharmaObservatory::BiomarkersApi* | [**biomarkers_biomarker_relations**](docs/BiomarkersApi.md#biomarkers_biomarker_relations) | **GET** /api/v1/biomarkers/{id}/biomarker_relations | Literature-extracted relations
|
|
127
|
+
*PharmaObservatory::BiomarkersApi* | [**biomarkers_biomarker_sample_coverage**](docs/BiomarkersApi.md#biomarkers_biomarker_sample_coverage) | **GET** /api/v1/biomarkers/{id}/biomarker_sample_coverage | Human sample screening coverage (GDC)
|
|
128
|
+
*PharmaObservatory::BiomarkersApi* | [**biomarkers_biomarker_sample_prevalence**](docs/BiomarkersApi.md#biomarkers_biomarker_sample_prevalence) | **GET** /api/v1/biomarkers/{id}/biomarker_sample_prevalence | Human sample screening reference (GDC cohorts)
|
|
129
|
+
*PharmaObservatory::BiomarkersApi* | [**biomarkers_biomarker_validation**](docs/BiomarkersApi.md#biomarkers_biomarker_validation) | **GET** /api/v1/biomarkers/{id}/biomarker_validation | Biomarker validation ladder
|
|
126
130
|
*PharmaObservatory::BiomarkersApi* | [**biomarkers_biomarker_variant_mentions**](docs/BiomarkersApi.md#biomarkers_biomarker_variant_mentions) | **GET** /api/v1/biomarkers/{id}/biomarker_variant_mentions | Protein variant mentions
|
|
127
131
|
*PharmaObservatory::BiomarkersApi* | [**biomarkers_get**](docs/BiomarkersApi.md#biomarkers_get) | **GET** /api/v1/biomarkers/{id} | One biomarker
|
|
128
132
|
*PharmaObservatory::BiomarkersApi* | [**biomarkers_list**](docs/BiomarkersApi.md#biomarkers_list) | **GET** /api/v1/biomarkers | List biomarkers
|
|
@@ -131,6 +135,10 @@ Class | Method | HTTP request | Description
|
|
|
131
135
|
*PharmaObservatory::CompaniesApi* | [**companies_biomarker_bqp_assertions**](docs/CompaniesApi.md#companies_biomarker_bqp_assertions) | **GET** /api/v1/companies/{id}/biomarker_bqp_assertions | FDA biomarker qualification projects
|
|
132
136
|
*PharmaObservatory::CompaniesApi* | [**companies_biomarker_cdx_assertions**](docs/CompaniesApi.md#companies_biomarker_cdx_assertions) | **GET** /api/v1/companies/{id}/biomarker_cdx_assertions | FDA companion diagnostic assertions
|
|
133
137
|
*PharmaObservatory::CompaniesApi* | [**companies_biomarker_publishing_companies**](docs/CompaniesApi.md#companies_biomarker_publishing_companies) | **GET** /api/v1/companies/{id}/biomarker_publishing_companies | Companies publishing on a biomarker
|
|
138
|
+
*PharmaObservatory::CompaniesApi* | [**companies_biomarker_validation**](docs/CompaniesApi.md#companies_biomarker_validation) | **GET** /api/v1/companies/{id}/biomarker_validation | Biomarker validation ladder
|
|
139
|
+
*PharmaObservatory::CompaniesApi* | [**companies_company_assets**](docs/CompaniesApi.md#companies_company_assets) | **GET** /api/v1/companies/{id}/company_assets | Company assets (approved and marketed drugs)
|
|
140
|
+
*PharmaObservatory::CompaniesApi* | [**companies_company_funding_events**](docs/CompaniesApi.md#companies_company_funding_events) | **GET** /api/v1/companies/{id}/company_funding_events | Company funding events
|
|
141
|
+
*PharmaObservatory::CompaniesApi* | [**companies_company_funding_summary**](docs/CompaniesApi.md#companies_company_funding_summary) | **GET** /api/v1/companies/{id}/company_funding_summary | Company funding summary
|
|
134
142
|
*PharmaObservatory::CompaniesApi* | [**companies_company_members**](docs/CompaniesApi.md#companies_company_members) | **GET** /api/v1/companies/{id}/company_members | Company members
|
|
135
143
|
*PharmaObservatory::CompaniesApi* | [**companies_company_programs**](docs/CompaniesApi.md#companies_company_programs) | **GET** /api/v1/companies/{id}/company_programs | Company programs
|
|
136
144
|
*PharmaObservatory::CompaniesApi* | [**companies_company_targets**](docs/CompaniesApi.md#companies_company_targets) | **GET** /api/v1/companies/{id}/company_targets | Targets a company pursues
|
|
@@ -139,18 +147,33 @@ Class | Method | HTTP request | Description
|
|
|
139
147
|
*PharmaObservatory::CompaniesApi* | [**companies_institutional_holdings**](docs/CompaniesApi.md#companies_institutional_holdings) | **GET** /api/v1/companies/{id}/institutional_holdings | Institutional holdings (SEC Form 13F)
|
|
140
148
|
*PharmaObservatory::CompaniesApi* | [**companies_legal_entities**](docs/CompaniesApi.md#companies_legal_entities) | **GET** /api/v1/companies/{id}/legal_entities | Legal entities
|
|
141
149
|
*PharmaObservatory::CompaniesApi* | [**companies_list**](docs/CompaniesApi.md#companies_list) | **GET** /api/v1/companies | List companies
|
|
150
|
+
*PharmaObservatory::CompaniesApi* | [**companies_ownership_positions**](docs/CompaniesApi.md#companies_ownership_positions) | **GET** /api/v1/companies/{id}/ownership_positions | Ownership and control positions
|
|
142
151
|
*PharmaObservatory::CompaniesApi* | [**companies_pdufa_dates**](docs/CompaniesApi.md#companies_pdufa_dates) | **GET** /api/v1/companies/{id}/pdufa_dates | FDA decision dates (PDUFA) and catalysts
|
|
143
152
|
*PharmaObservatory::CompaniesApi* | [**companies_sponsor_recruitment_by_phase**](docs/CompaniesApi.md#companies_sponsor_recruitment_by_phase) | **GET** /api/v1/companies/{id}/sponsor_recruitment_by_phase | Trial recruitment duration by sponsor and phase
|
|
144
153
|
*PharmaObservatory::CompaniesApi* | [**companies_sponsor_recruitment_duration**](docs/CompaniesApi.md#companies_sponsor_recruitment_duration) | **GET** /api/v1/companies/{id}/sponsor_recruitment_duration | Trial recruitment duration by sponsor
|
|
145
154
|
*PharmaObservatory::CompaniesApi* | [**companies_sponsor_trial_start_forecast**](docs/CompaniesApi.md#companies_sponsor_trial_start_forecast) | **GET** /api/v1/companies/{id}/sponsor_trial_start_forecast | Trial-start forecast by sponsor
|
|
146
155
|
*PharmaObservatory::CompaniesApi* | [**companies_sponsor_trials**](docs/CompaniesApi.md#companies_sponsor_trials) | **GET** /api/v1/companies/{id}/sponsor_trials | Sponsor trials
|
|
156
|
+
*PharmaObservatory::ConditionsApi* | [**conditions_company_programs**](docs/ConditionsApi.md#conditions_company_programs) | **GET** /api/v1/conditions/{id}/company_programs | Company programs
|
|
157
|
+
*PharmaObservatory::ConditionsApi* | [**conditions_condition_adverse_events**](docs/ConditionsApi.md#conditions_condition_adverse_events) | **GET** /api/v1/conditions/{id}/condition_adverse_events | Condition adverse events
|
|
158
|
+
*PharmaObservatory::ConditionsApi* | [**conditions_condition_burden**](docs/ConditionsApi.md#conditions_condition_burden) | **GET** /api/v1/conditions/{id}/condition_burden | Condition burden
|
|
159
|
+
*PharmaObservatory::ConditionsApi* | [**conditions_condition_delivery**](docs/ConditionsApi.md#conditions_condition_delivery) | **GET** /api/v1/conditions/{id}/condition_delivery | Condition delivery
|
|
160
|
+
*PharmaObservatory::ConditionsApi* | [**conditions_condition_drugs**](docs/ConditionsApi.md#conditions_condition_drugs) | **GET** /api/v1/conditions/{id}/condition_drugs | Condition drugs
|
|
161
|
+
*PharmaObservatory::ConditionsApi* | [**conditions_condition_prevalence**](docs/ConditionsApi.md#conditions_condition_prevalence) | **GET** /api/v1/conditions/{id}/condition_prevalence | Condition prevalence
|
|
162
|
+
*PharmaObservatory::ConditionsApi* | [**conditions_condition_publications**](docs/ConditionsApi.md#conditions_condition_publications) | **GET** /api/v1/conditions/{id}/condition_publications | Condition publications
|
|
163
|
+
*PharmaObservatory::ConditionsApi* | [**conditions_condition_sites**](docs/ConditionsApi.md#conditions_condition_sites) | **GET** /api/v1/conditions/{id}/condition_sites | Condition sites
|
|
164
|
+
*PharmaObservatory::ConditionsApi* | [**conditions_condition_trials**](docs/ConditionsApi.md#conditions_condition_trials) | **GET** /api/v1/conditions/{id}/condition_trials | Condition trials
|
|
165
|
+
*PharmaObservatory::ConditionsApi* | [**conditions_get**](docs/ConditionsApi.md#conditions_get) | **GET** /api/v1/conditions/{id} | One condition
|
|
166
|
+
*PharmaObservatory::ConditionsApi* | [**conditions_list**](docs/ConditionsApi.md#conditions_list) | **GET** /api/v1/conditions | List conditions
|
|
167
|
+
*PharmaObservatory::ConditionsApi* | [**conditions_pdufa_dates**](docs/ConditionsApi.md#conditions_pdufa_dates) | **GET** /api/v1/conditions/{id}/pdufa_dates | FDA decision dates (PDUFA) and catalysts
|
|
147
168
|
*PharmaObservatory::DatasetsApi* | [**datasets_get**](docs/DatasetsApi.md#datasets_get) | **GET** /api/v1/datasets/{name} | Describe a dataset
|
|
148
169
|
*PharmaObservatory::DatasetsApi* | [**datasets_list**](docs/DatasetsApi.md#datasets_list) | **GET** /api/v1/datasets | List the datasets
|
|
170
|
+
*PharmaObservatory::LegalEntitiesApi* | [**legal_entities_company_assets**](docs/LegalEntitiesApi.md#legal_entities_company_assets) | **GET** /api/v1/legal_entities/{id}/company_assets | Company assets (approved and marketed drugs)
|
|
149
171
|
*PharmaObservatory::LegalEntitiesApi* | [**legal_entities_company_programs**](docs/LegalEntitiesApi.md#legal_entities_company_programs) | **GET** /api/v1/legal_entities/{id}/company_programs | Company programs
|
|
150
172
|
*PharmaObservatory::LegalEntitiesApi* | [**legal_entities_drug_patent_cliff**](docs/LegalEntitiesApi.md#legal_entities_drug_patent_cliff) | **GET** /api/v1/legal_entities/{id}/drug_patent_cliff | Patent-cliff exposure
|
|
151
173
|
*PharmaObservatory::LegalEntitiesApi* | [**legal_entities_get**](docs/LegalEntitiesApi.md#legal_entities_get) | **GET** /api/v1/legal_entities/{id} | One legal entity
|
|
152
174
|
*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)
|
|
153
175
|
*PharmaObservatory::LegalEntitiesApi* | [**legal_entities_list**](docs/LegalEntitiesApi.md#legal_entities_list) | **GET** /api/v1/legal_entities | List legal entities
|
|
176
|
+
*PharmaObservatory::LegalEntitiesApi* | [**legal_entities_ownership_positions**](docs/LegalEntitiesApi.md#legal_entities_ownership_positions) | **GET** /api/v1/legal_entities/{id}/ownership_positions | Ownership and control positions
|
|
154
177
|
*PharmaObservatory::LegalEntitiesApi* | [**legal_entities_pdufa_dates**](docs/LegalEntitiesApi.md#legal_entities_pdufa_dates) | **GET** /api/v1/legal_entities/{id}/pdufa_dates | FDA decision dates (PDUFA) and catalysts
|
|
155
178
|
*PharmaObservatory::LegalEntitiesApi* | [**legal_entities_sponsor_recruitment_by_phase**](docs/LegalEntitiesApi.md#legal_entities_sponsor_recruitment_by_phase) | **GET** /api/v1/legal_entities/{id}/sponsor_recruitment_by_phase | Trial recruitment duration by sponsor and phase
|
|
156
179
|
*PharmaObservatory::LegalEntitiesApi* | [**legal_entities_sponsor_recruitment_duration**](docs/LegalEntitiesApi.md#legal_entities_sponsor_recruitment_duration) | **GET** /api/v1/legal_entities/{id}/sponsor_recruitment_duration | Trial recruitment duration by sponsor
|
|
@@ -167,11 +190,28 @@ Class | Method | HTTP request | Description
|
|
|
167
190
|
*PharmaObservatory::SitesApi* | [**sites_site_trial_conditions**](docs/SitesApi.md#sites_site_trial_conditions) | **GET** /api/v1/sites/{id}/site_trial_conditions | Site trial conditions
|
|
168
191
|
*PharmaObservatory::SitesApi* | [**sites_site_trial_drugs**](docs/SitesApi.md#sites_site_trial_drugs) | **GET** /api/v1/sites/{id}/site_trial_drugs | Site trial drugs
|
|
169
192
|
*PharmaObservatory::SitesApi* | [**sites_site_trials**](docs/SitesApi.md#sites_site_trials) | **GET** /api/v1/sites/{id}/site_trials | Site trials
|
|
193
|
+
*PharmaObservatory::TrialsApi* | [**trials_get**](docs/TrialsApi.md#trials_get) | **GET** /api/v1/trials/{id} | One trial
|
|
194
|
+
*PharmaObservatory::TrialsApi* | [**trials_list**](docs/TrialsApi.md#trials_list) | **GET** /api/v1/trials | List trials
|
|
195
|
+
*PharmaObservatory::TrialsApi* | [**trials_sponsor_trials**](docs/TrialsApi.md#trials_sponsor_trials) | **GET** /api/v1/trials/{id}/sponsor_trials | Sponsor trials
|
|
196
|
+
*PharmaObservatory::TrialsApi* | [**trials_trial_adverse_events**](docs/TrialsApi.md#trials_trial_adverse_events) | **GET** /api/v1/trials/{id}/trial_adverse_events | Trial adverse events
|
|
197
|
+
*PharmaObservatory::TrialsApi* | [**trials_trial_changes**](docs/TrialsApi.md#trials_trial_changes) | **GET** /api/v1/trials/{id}/trial_changes | Trial changes
|
|
198
|
+
*PharmaObservatory::TrialsApi* | [**trials_trial_delivery**](docs/TrialsApi.md#trials_trial_delivery) | **GET** /api/v1/trials/{id}/trial_delivery | Trial delivery
|
|
199
|
+
*PharmaObservatory::TrialsApi* | [**trials_trial_demographics**](docs/TrialsApi.md#trials_trial_demographics) | **GET** /api/v1/trials/{id}/trial_demographics | Trial demographics
|
|
200
|
+
*PharmaObservatory::TrialsApi* | [**trials_trial_drugs**](docs/TrialsApi.md#trials_trial_drugs) | **GET** /api/v1/trials/{id}/trial_drugs | Trial drugs
|
|
201
|
+
*PharmaObservatory::TrialsApi* | [**trials_trial_enrollment_history**](docs/TrialsApi.md#trials_trial_enrollment_history) | **GET** /api/v1/trials/{id}/trial_enrollment_history | Trial enrollment history
|
|
202
|
+
*PharmaObservatory::TrialsApi* | [**trials_trial_enrollment_rate**](docs/TrialsApi.md#trials_trial_enrollment_rate) | **GET** /api/v1/trials/{id}/trial_enrollment_rate | Trial enrollment rate
|
|
203
|
+
*PharmaObservatory::TrialsApi* | [**trials_trial_extracted_endpoints**](docs/TrialsApi.md#trials_trial_extracted_endpoints) | **GET** /api/v1/trials/{id}/trial_extracted_endpoints | Trial extracted endpoints
|
|
204
|
+
*PharmaObservatory::TrialsApi* | [**trials_trial_outcome_measures**](docs/TrialsApi.md#trials_trial_outcome_measures) | **GET** /api/v1/trials/{id}/trial_outcome_measures | Trial outcome measures
|
|
205
|
+
*PharmaObservatory::TrialsApi* | [**trials_trial_sites**](docs/TrialsApi.md#trials_trial_sites) | **GET** /api/v1/trials/{id}/trial_sites | Trial sites
|
|
170
206
|
|
|
171
207
|
|
|
172
208
|
## Documentation for Models
|
|
173
209
|
|
|
174
210
|
- [PharmaObservatory::ApiV1WhoamiGet200Response](docs/ApiV1WhoamiGet200Response.md)
|
|
211
|
+
- [PharmaObservatory::ApiV1WhoamiGet200ResponseLimits](docs/ApiV1WhoamiGet200ResponseLimits.md)
|
|
212
|
+
- [PharmaObservatory::ApiV1WhoamiGet200ResponseQuota](docs/ApiV1WhoamiGet200ResponseQuota.md)
|
|
213
|
+
- [PharmaObservatory::ApiV1WhoamiGet200ResponseQuotaBuckets](docs/ApiV1WhoamiGet200ResponseQuotaBuckets.md)
|
|
214
|
+
- [PharmaObservatory::ApiV1WhoamiGet200ResponseQuotaBucketsRequestsPerMinute](docs/ApiV1WhoamiGet200ResponseQuotaBucketsRequestsPerMinute.md)
|
|
175
215
|
- [PharmaObservatory::AuthError](docs/AuthError.md)
|
|
176
216
|
- [PharmaObservatory::BiomarkerBqpAssertionsResponse](docs/BiomarkerBqpAssertionsResponse.md)
|
|
177
217
|
- [PharmaObservatory::BiomarkerBqpAssertionsRow](docs/BiomarkerBqpAssertionsRow.md)
|
|
@@ -186,6 +226,14 @@ Class | Method | HTTP request | Description
|
|
|
186
226
|
- [PharmaObservatory::BiomarkerLiteratureRow](docs/BiomarkerLiteratureRow.md)
|
|
187
227
|
- [PharmaObservatory::BiomarkerPublishingCompaniesResponse](docs/BiomarkerPublishingCompaniesResponse.md)
|
|
188
228
|
- [PharmaObservatory::BiomarkerPublishingCompaniesRow](docs/BiomarkerPublishingCompaniesRow.md)
|
|
229
|
+
- [PharmaObservatory::BiomarkerRelationsResponse](docs/BiomarkerRelationsResponse.md)
|
|
230
|
+
- [PharmaObservatory::BiomarkerRelationsRow](docs/BiomarkerRelationsRow.md)
|
|
231
|
+
- [PharmaObservatory::BiomarkerSampleCoverageResponse](docs/BiomarkerSampleCoverageResponse.md)
|
|
232
|
+
- [PharmaObservatory::BiomarkerSampleCoverageRow](docs/BiomarkerSampleCoverageRow.md)
|
|
233
|
+
- [PharmaObservatory::BiomarkerSamplePrevalenceResponse](docs/BiomarkerSamplePrevalenceResponse.md)
|
|
234
|
+
- [PharmaObservatory::BiomarkerSamplePrevalenceRow](docs/BiomarkerSamplePrevalenceRow.md)
|
|
235
|
+
- [PharmaObservatory::BiomarkerValidationResponse](docs/BiomarkerValidationResponse.md)
|
|
236
|
+
- [PharmaObservatory::BiomarkerValidationRow](docs/BiomarkerValidationRow.md)
|
|
189
237
|
- [PharmaObservatory::BiomarkerVariantMentionsResponse](docs/BiomarkerVariantMentionsResponse.md)
|
|
190
238
|
- [PharmaObservatory::BiomarkerVariantMentionsRow](docs/BiomarkerVariantMentionsRow.md)
|
|
191
239
|
- [PharmaObservatory::BiomarkersRecord](docs/BiomarkersRecord.md)
|
|
@@ -195,14 +243,41 @@ Class | Method | HTTP request | Description
|
|
|
195
243
|
- [PharmaObservatory::CellLinesResponse](docs/CellLinesResponse.md)
|
|
196
244
|
- [PharmaObservatory::CellLinesRow](docs/CellLinesRow.md)
|
|
197
245
|
- [PharmaObservatory::CompaniesRecord](docs/CompaniesRecord.md)
|
|
246
|
+
- [PharmaObservatory::CompaniesRecordAttributes](docs/CompaniesRecordAttributes.md)
|
|
198
247
|
- [PharmaObservatory::CompaniesResponse](docs/CompaniesResponse.md)
|
|
199
248
|
- [PharmaObservatory::CompaniesRow](docs/CompaniesRow.md)
|
|
249
|
+
- [PharmaObservatory::CompanyAssetsResponse](docs/CompanyAssetsResponse.md)
|
|
250
|
+
- [PharmaObservatory::CompanyAssetsRow](docs/CompanyAssetsRow.md)
|
|
251
|
+
- [PharmaObservatory::CompanyFundingEventsResponse](docs/CompanyFundingEventsResponse.md)
|
|
252
|
+
- [PharmaObservatory::CompanyFundingEventsRow](docs/CompanyFundingEventsRow.md)
|
|
253
|
+
- [PharmaObservatory::CompanyFundingSummaryResponse](docs/CompanyFundingSummaryResponse.md)
|
|
254
|
+
- [PharmaObservatory::CompanyFundingSummaryRow](docs/CompanyFundingSummaryRow.md)
|
|
200
255
|
- [PharmaObservatory::CompanyMembersResponse](docs/CompanyMembersResponse.md)
|
|
201
256
|
- [PharmaObservatory::CompanyMembersRow](docs/CompanyMembersRow.md)
|
|
202
257
|
- [PharmaObservatory::CompanyProgramsResponse](docs/CompanyProgramsResponse.md)
|
|
203
258
|
- [PharmaObservatory::CompanyProgramsRow](docs/CompanyProgramsRow.md)
|
|
204
259
|
- [PharmaObservatory::CompanyTargetsResponse](docs/CompanyTargetsResponse.md)
|
|
205
260
|
- [PharmaObservatory::CompanyTargetsRow](docs/CompanyTargetsRow.md)
|
|
261
|
+
- [PharmaObservatory::ConditionAdverseEventsResponse](docs/ConditionAdverseEventsResponse.md)
|
|
262
|
+
- [PharmaObservatory::ConditionAdverseEventsRow](docs/ConditionAdverseEventsRow.md)
|
|
263
|
+
- [PharmaObservatory::ConditionBurdenResponse](docs/ConditionBurdenResponse.md)
|
|
264
|
+
- [PharmaObservatory::ConditionBurdenRow](docs/ConditionBurdenRow.md)
|
|
265
|
+
- [PharmaObservatory::ConditionDeliveryResponse](docs/ConditionDeliveryResponse.md)
|
|
266
|
+
- [PharmaObservatory::ConditionDeliveryRow](docs/ConditionDeliveryRow.md)
|
|
267
|
+
- [PharmaObservatory::ConditionDrugsResponse](docs/ConditionDrugsResponse.md)
|
|
268
|
+
- [PharmaObservatory::ConditionDrugsRow](docs/ConditionDrugsRow.md)
|
|
269
|
+
- [PharmaObservatory::ConditionPrevalenceResponse](docs/ConditionPrevalenceResponse.md)
|
|
270
|
+
- [PharmaObservatory::ConditionPrevalenceRow](docs/ConditionPrevalenceRow.md)
|
|
271
|
+
- [PharmaObservatory::ConditionPublicationsResponse](docs/ConditionPublicationsResponse.md)
|
|
272
|
+
- [PharmaObservatory::ConditionPublicationsRow](docs/ConditionPublicationsRow.md)
|
|
273
|
+
- [PharmaObservatory::ConditionSitesResponse](docs/ConditionSitesResponse.md)
|
|
274
|
+
- [PharmaObservatory::ConditionSitesRow](docs/ConditionSitesRow.md)
|
|
275
|
+
- [PharmaObservatory::ConditionTrialsResponse](docs/ConditionTrialsResponse.md)
|
|
276
|
+
- [PharmaObservatory::ConditionTrialsRow](docs/ConditionTrialsRow.md)
|
|
277
|
+
- [PharmaObservatory::ConditionsRecord](docs/ConditionsRecord.md)
|
|
278
|
+
- [PharmaObservatory::ConditionsRecordAttributes](docs/ConditionsRecordAttributes.md)
|
|
279
|
+
- [PharmaObservatory::ConditionsResponse](docs/ConditionsResponse.md)
|
|
280
|
+
- [PharmaObservatory::ConditionsRow](docs/ConditionsRow.md)
|
|
206
281
|
- [PharmaObservatory::DatasetAttribution](docs/DatasetAttribution.md)
|
|
207
282
|
- [PharmaObservatory::DatasetBuildState](docs/DatasetBuildState.md)
|
|
208
283
|
- [PharmaObservatory::DatasetColumn](docs/DatasetColumn.md)
|
|
@@ -217,6 +292,8 @@ Class | Method | HTTP request | Description
|
|
|
217
292
|
- [PharmaObservatory::LegalEntitiesRecordAttributes](docs/LegalEntitiesRecordAttributes.md)
|
|
218
293
|
- [PharmaObservatory::LegalEntitiesResponse](docs/LegalEntitiesResponse.md)
|
|
219
294
|
- [PharmaObservatory::LegalEntitiesRow](docs/LegalEntitiesRow.md)
|
|
295
|
+
- [PharmaObservatory::OwnershipPositionsResponse](docs/OwnershipPositionsResponse.md)
|
|
296
|
+
- [PharmaObservatory::OwnershipPositionsRow](docs/OwnershipPositionsRow.md)
|
|
220
297
|
- [PharmaObservatory::PdufaDatesResponse](docs/PdufaDatesResponse.md)
|
|
221
298
|
- [PharmaObservatory::PdufaDatesRow](docs/PdufaDatesRow.md)
|
|
222
299
|
- [PharmaObservatory::QueryError](docs/QueryError.md)
|
|
@@ -250,6 +327,30 @@ Class | Method | HTTP request | Description
|
|
|
250
327
|
- [PharmaObservatory::SponsorTrialStartForecastRow](docs/SponsorTrialStartForecastRow.md)
|
|
251
328
|
- [PharmaObservatory::SponsorTrialsResponse](docs/SponsorTrialsResponse.md)
|
|
252
329
|
- [PharmaObservatory::SponsorTrialsRow](docs/SponsorTrialsRow.md)
|
|
330
|
+
- [PharmaObservatory::TrialAdverseEventsResponse](docs/TrialAdverseEventsResponse.md)
|
|
331
|
+
- [PharmaObservatory::TrialAdverseEventsRow](docs/TrialAdverseEventsRow.md)
|
|
332
|
+
- [PharmaObservatory::TrialChangesResponse](docs/TrialChangesResponse.md)
|
|
333
|
+
- [PharmaObservatory::TrialChangesRow](docs/TrialChangesRow.md)
|
|
334
|
+
- [PharmaObservatory::TrialDeliveryResponse](docs/TrialDeliveryResponse.md)
|
|
335
|
+
- [PharmaObservatory::TrialDeliveryRow](docs/TrialDeliveryRow.md)
|
|
336
|
+
- [PharmaObservatory::TrialDemographicsResponse](docs/TrialDemographicsResponse.md)
|
|
337
|
+
- [PharmaObservatory::TrialDemographicsRow](docs/TrialDemographicsRow.md)
|
|
338
|
+
- [PharmaObservatory::TrialDrugsResponse](docs/TrialDrugsResponse.md)
|
|
339
|
+
- [PharmaObservatory::TrialDrugsRow](docs/TrialDrugsRow.md)
|
|
340
|
+
- [PharmaObservatory::TrialEnrollmentHistoryResponse](docs/TrialEnrollmentHistoryResponse.md)
|
|
341
|
+
- [PharmaObservatory::TrialEnrollmentHistoryRow](docs/TrialEnrollmentHistoryRow.md)
|
|
342
|
+
- [PharmaObservatory::TrialEnrollmentRateResponse](docs/TrialEnrollmentRateResponse.md)
|
|
343
|
+
- [PharmaObservatory::TrialEnrollmentRateRow](docs/TrialEnrollmentRateRow.md)
|
|
344
|
+
- [PharmaObservatory::TrialExtractedEndpointsResponse](docs/TrialExtractedEndpointsResponse.md)
|
|
345
|
+
- [PharmaObservatory::TrialExtractedEndpointsRow](docs/TrialExtractedEndpointsRow.md)
|
|
346
|
+
- [PharmaObservatory::TrialOutcomeMeasuresResponse](docs/TrialOutcomeMeasuresResponse.md)
|
|
347
|
+
- [PharmaObservatory::TrialOutcomeMeasuresRow](docs/TrialOutcomeMeasuresRow.md)
|
|
348
|
+
- [PharmaObservatory::TrialSitesResponse](docs/TrialSitesResponse.md)
|
|
349
|
+
- [PharmaObservatory::TrialSitesRow](docs/TrialSitesRow.md)
|
|
350
|
+
- [PharmaObservatory::TrialsRecord](docs/TrialsRecord.md)
|
|
351
|
+
- [PharmaObservatory::TrialsRecordAttributes](docs/TrialsRecordAttributes.md)
|
|
352
|
+
- [PharmaObservatory::TrialsResponse](docs/TrialsResponse.md)
|
|
353
|
+
- [PharmaObservatory::TrialsRow](docs/TrialsRow.md)
|
|
253
354
|
|
|
254
355
|
|
|
255
356
|
## Documentation for Authorization
|
|
@@ -7,6 +7,12 @@
|
|
|
7
7
|
| **ok** | **Boolean** | | |
|
|
8
8
|
| **sub** | **String** | | |
|
|
9
9
|
| **roles** | **Array<String>** | | |
|
|
10
|
+
| **name** | **Object** | | [optional] |
|
|
11
|
+
| **email** | **Object** | | [optional] |
|
|
12
|
+
| **organization** | **Object** | | [optional] |
|
|
13
|
+
| **plan** | **Object** | | [optional] |
|
|
14
|
+
| **limits** | [**ApiV1WhoamiGet200ResponseLimits**](ApiV1WhoamiGet200ResponseLimits.md) | | [optional] |
|
|
15
|
+
| **quota** | [**ApiV1WhoamiGet200ResponseQuota**](ApiV1WhoamiGet200ResponseQuota.md) | | [optional] |
|
|
10
16
|
|
|
11
17
|
## Example
|
|
12
18
|
|
|
@@ -16,7 +22,13 @@ require 'pharmaobservatory'
|
|
|
16
22
|
instance = PharmaObservatory::ApiV1WhoamiGet200Response.new(
|
|
17
23
|
ok: null,
|
|
18
24
|
sub: null,
|
|
19
|
-
roles: null
|
|
25
|
+
roles: null,
|
|
26
|
+
name: null,
|
|
27
|
+
email: null,
|
|
28
|
+
organization: null,
|
|
29
|
+
plan: null,
|
|
30
|
+
limits: null,
|
|
31
|
+
quota: null
|
|
20
32
|
)
|
|
21
33
|
```
|
|
22
34
|
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# PharmaObservatory::ApiV1WhoamiGet200ResponseLimits
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **defaults_from** | **String** | | |
|
|
8
|
+
| **requests_per_minute** | **Integer** | | |
|
|
9
|
+
| **requests_per_day** | **Integer** | | |
|
|
10
|
+
| **rows_per_day** | **Integer** | | |
|
|
11
|
+
| **paging_depth** | **Integer** | | |
|
|
12
|
+
| **rwd_catalogue_calls_per_day** | **Integer** | | |
|
|
13
|
+
| **benzinga_calls_per_day** | **Integer** | | |
|
|
14
|
+
| **query_seconds_per_day** | **Integer** | | |
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```ruby
|
|
19
|
+
require 'pharmaobservatory'
|
|
20
|
+
|
|
21
|
+
instance = PharmaObservatory::ApiV1WhoamiGet200ResponseLimits.new(
|
|
22
|
+
defaults_from: null,
|
|
23
|
+
requests_per_minute: null,
|
|
24
|
+
requests_per_day: null,
|
|
25
|
+
rows_per_day: null,
|
|
26
|
+
paging_depth: null,
|
|
27
|
+
rwd_catalogue_calls_per_day: null,
|
|
28
|
+
benzinga_calls_per_day: null,
|
|
29
|
+
query_seconds_per_day: null
|
|
30
|
+
)
|
|
31
|
+
```
|
|
32
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# PharmaObservatory::ApiV1WhoamiGet200ResponseQuota
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **keyed_by** | **String** | | |
|
|
8
|
+
| **buckets** | [**ApiV1WhoamiGet200ResponseQuotaBuckets**](ApiV1WhoamiGet200ResponseQuotaBuckets.md) | | |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'pharmaobservatory'
|
|
14
|
+
|
|
15
|
+
instance = PharmaObservatory::ApiV1WhoamiGet200ResponseQuota.new(
|
|
16
|
+
keyed_by: null,
|
|
17
|
+
buckets: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# PharmaObservatory::ApiV1WhoamiGet200ResponseQuotaBuckets
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **requests_per_minute** | [**ApiV1WhoamiGet200ResponseQuotaBucketsRequestsPerMinute**](ApiV1WhoamiGet200ResponseQuotaBucketsRequestsPerMinute.md) | | |
|
|
8
|
+
| **requests_per_day** | [**ApiV1WhoamiGet200ResponseQuotaBucketsRequestsPerMinute**](ApiV1WhoamiGet200ResponseQuotaBucketsRequestsPerMinute.md) | | |
|
|
9
|
+
| **rows_per_day** | [**ApiV1WhoamiGet200ResponseQuotaBucketsRequestsPerMinute**](ApiV1WhoamiGet200ResponseQuotaBucketsRequestsPerMinute.md) | | |
|
|
10
|
+
| **rwd_catalogue_calls_per_day** | [**ApiV1WhoamiGet200ResponseQuotaBucketsRequestsPerMinute**](ApiV1WhoamiGet200ResponseQuotaBucketsRequestsPerMinute.md) | | |
|
|
11
|
+
| **benzinga_calls_per_day** | [**ApiV1WhoamiGet200ResponseQuotaBucketsRequestsPerMinute**](ApiV1WhoamiGet200ResponseQuotaBucketsRequestsPerMinute.md) | | |
|
|
12
|
+
| **query_seconds_per_day** | [**ApiV1WhoamiGet200ResponseQuotaBucketsRequestsPerMinute**](ApiV1WhoamiGet200ResponseQuotaBucketsRequestsPerMinute.md) | | |
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```ruby
|
|
17
|
+
require 'pharmaobservatory'
|
|
18
|
+
|
|
19
|
+
instance = PharmaObservatory::ApiV1WhoamiGet200ResponseQuotaBuckets.new(
|
|
20
|
+
requests_per_minute: null,
|
|
21
|
+
requests_per_day: null,
|
|
22
|
+
rows_per_day: null,
|
|
23
|
+
rwd_catalogue_calls_per_day: null,
|
|
24
|
+
benzinga_calls_per_day: null,
|
|
25
|
+
query_seconds_per_day: null
|
|
26
|
+
)
|
|
27
|
+
```
|
|
28
|
+
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# PharmaObservatory::ApiV1WhoamiGet200ResponseQuotaBucketsRequestsPerMinute
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **unit** | **String** | | |
|
|
8
|
+
| **window** | **String** | | |
|
|
9
|
+
| **limit** | **Integer** | | |
|
|
10
|
+
| **used** | **Integer** | | |
|
|
11
|
+
| **remaining** | **Integer** | | |
|
|
12
|
+
| **resets_at** | **String** | | |
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```ruby
|
|
17
|
+
require 'pharmaobservatory'
|
|
18
|
+
|
|
19
|
+
instance = PharmaObservatory::ApiV1WhoamiGet200ResponseQuotaBucketsRequestsPerMinute.new(
|
|
20
|
+
unit: null,
|
|
21
|
+
window: null,
|
|
22
|
+
limit: null,
|
|
23
|
+
used: null,
|
|
24
|
+
remaining: null,
|
|
25
|
+
resets_at: null
|
|
26
|
+
)
|
|
27
|
+
```
|
|
28
|
+
|
|
@@ -7,7 +7,7 @@
|
|
|
7
7
|
| **source_assertion_id** | **String** | The assertion id. | [optional] |
|
|
8
8
|
| **route_key** | **String** | The biomarker's route key, the entry key for the biomarkers object type. | [optional] |
|
|
9
9
|
| **biomarker_id** | **String** | The biomarker key. | [optional] |
|
|
10
|
-
| **ddt_number** | **String** | The
|
|
10
|
+
| **ddt_number** | **String** | The drug development tool number the US Food and Drug Administration (FDA) assigns the project. | [optional] |
|
|
11
11
|
| **ddt_project_id** | **String** | The FDA project id. | [optional] |
|
|
12
12
|
| **project_name** | **String** | The project's name. | [optional] |
|
|
13
13
|
| **bqp_signal** | **String** | The source status of the project. Only qualified means FDA-qualified; every other value is a project status. | [optional] |
|
|
@@ -17,7 +17,7 @@
|
|
|
17
17
|
| **therapeutic_area** | **String** | The therapeutic area. | [optional] |
|
|
18
18
|
| **drug_name** | **String** | The drug as filed. | [optional] |
|
|
19
19
|
| **drug_id** | **String** | The drug key. | [optional] |
|
|
20
|
-
| **molecule_id** | **String** | The molecule key. Null
|
|
20
|
+
| **molecule_id** | **String** | The molecule key. Null on every row: no evidence row carries a molecule. | [optional] |
|
|
21
21
|
| **response** | **String** | The reported response (for example Responsive, Resistant). | [optional] |
|
|
22
22
|
| **score** | **Float** | The association score, for an Open Targets row. | [optional] |
|
|
23
23
|
| **variant_count** | **Integer** | Variants the assertion covers. | [optional] |
|
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
| **pmid** | **String** | The PubMed id. | [optional] |
|
|
10
10
|
| **evidence_type** | **String** | The evidence type (a publication mention). | [optional] |
|
|
11
11
|
| **title** | **String** | The paper's title. | [optional] |
|
|
12
|
-
| **journal_nlm_id** | **String** | The journal's NLM id. | [optional] |
|
|
12
|
+
| **journal_nlm_id** | **String** | The journal's National Library of Medicine (NLM) id. | [optional] |
|
|
13
13
|
| **journal_title** | **String** | The journal's title. | [optional] |
|
|
14
14
|
| **pub_year** | **Integer** | The publication year. | [optional] |
|
|
15
15
|
| **citation_count** | **Integer** | Citations, where iCite carries them (null is not measured, never zero). | [optional] |
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
# PharmaObservatory::BiomarkerRelationsResponse
|
|
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** | [**BiomarkerCdxAssertionsResponseScope**](BiomarkerCdxAssertionsResponseScope.md) | | [optional] |
|
|
12
|
+
| **columns** | [**Array<DatasetColumn>**](DatasetColumn.md) | | |
|
|
13
|
+
| **rows** | [**Array<BiomarkerRelationsRow>**](BiomarkerRelationsRow.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** | [**BiomarkerCdxAssertionsResponseFreshness**](BiomarkerCdxAssertionsResponseFreshness.md) | | [optional] |
|
|
25
|
+
| **build** | [**BiomarkerCdxAssertionsResponseBuild**](BiomarkerCdxAssertionsResponseBuild.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::BiomarkerRelationsResponse.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
|
+
|
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
# PharmaObservatory::BiomarkerRelationsRow
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **route_key** | **String** | The biomarker's own route key, the entry key for the biomarkers object type (the gene symbol for a gene, the variant key for a protein variant). | [optional] |
|
|
8
|
+
| **biomarker_id** | **String** | The biomarker's key. | [optional] |
|
|
9
|
+
| **biomarker_kind** | **String** | Whether the row describes a gene or a protein variant. | [optional] |
|
|
10
|
+
| **gene_symbol** | **String** | The gene symbol. | [optional] |
|
|
11
|
+
| **amino_acid_change** | **String** | The protein change, for a variant. | [optional] |
|
|
12
|
+
| **related_entity_kind** | **String** | The kind of the related entity (gene, drug or condition). | [optional] |
|
|
13
|
+
| **related_entity_id** | **String** | The related entity's key in its own vocabulary (a gene symbol, a drug id such as unii:..., or a condition key). | [optional] |
|
|
14
|
+
| **related_display_name** | **String** | The related entity's name. | [optional] |
|
|
15
|
+
| **relation_type** | **String** | The source's relation label, as the source states it. | [optional] |
|
|
16
|
+
| **pmid** | **String** | The PubMed id of the paper the relation was extracted from. | [optional] |
|
|
17
|
+
| **title** | **String** | The paper's title. | [optional] |
|
|
18
|
+
| **journal_nlm_id** | **String** | The journal's National Library of Medicine (NLM) id. | [optional] |
|
|
19
|
+
| **journal_title** | **String** | The journal's title. | [optional] |
|
|
20
|
+
| **pub_year** | **Integer** | The paper's publication year. | [optional] |
|
|
21
|
+
| **n_source_assertions** | **Integer** | Source assertions of this relation in the paper. | [optional] |
|
|
22
|
+
| **n_relation_papers** | **Integer** | Papers that carry this biomarker, related entity and relation label. | [optional] |
|
|
23
|
+
| **evidence_type** | **String** | The evidence type (a text-mined relation, never a clinical claim). | [optional] |
|
|
24
|
+
| **source** | **String** | The source of the evidence. | [optional] |
|
|
25
|
+
| **display_order** | **Integer** | The order the web page lists the relation in within its kind. | [optional] |
|
|
26
|
+
|
|
27
|
+
## Example
|
|
28
|
+
|
|
29
|
+
```ruby
|
|
30
|
+
require 'pharmaobservatory'
|
|
31
|
+
|
|
32
|
+
instance = PharmaObservatory::BiomarkerRelationsRow.new(
|
|
33
|
+
route_key: null,
|
|
34
|
+
biomarker_id: null,
|
|
35
|
+
biomarker_kind: null,
|
|
36
|
+
gene_symbol: null,
|
|
37
|
+
amino_acid_change: null,
|
|
38
|
+
related_entity_kind: null,
|
|
39
|
+
related_entity_id: null,
|
|
40
|
+
related_display_name: null,
|
|
41
|
+
relation_type: null,
|
|
42
|
+
pmid: null,
|
|
43
|
+
title: null,
|
|
44
|
+
journal_nlm_id: null,
|
|
45
|
+
journal_title: null,
|
|
46
|
+
pub_year: null,
|
|
47
|
+
n_source_assertions: null,
|
|
48
|
+
n_relation_papers: null,
|
|
49
|
+
evidence_type: null,
|
|
50
|
+
source: null,
|
|
51
|
+
display_order: null
|
|
52
|
+
)
|
|
53
|
+
```
|
|
54
|
+
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
# PharmaObservatory::BiomarkerSampleCoverageResponse
|
|
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** | [**BiomarkerCdxAssertionsResponseScope**](BiomarkerCdxAssertionsResponseScope.md) | | [optional] |
|
|
12
|
+
| **columns** | [**Array<DatasetColumn>**](DatasetColumn.md) | | |
|
|
13
|
+
| **rows** | [**Array<BiomarkerSampleCoverageRow>**](BiomarkerSampleCoverageRow.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** | [**BiomarkerCdxAssertionsResponseFreshness**](BiomarkerCdxAssertionsResponseFreshness.md) | | [optional] |
|
|
25
|
+
| **build** | [**BiomarkerCdxAssertionsResponseBuild**](BiomarkerCdxAssertionsResponseBuild.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::BiomarkerSampleCoverageResponse.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
|
+
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
# PharmaObservatory::BiomarkerSampleCoverageRow
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **route_key** | **String** | The route key of the gene the variants belong to, the entry key for the biomarkers object type. | [optional] |
|
|
8
|
+
| **gene_symbol** | **String** | The gene symbol. | [optional] |
|
|
9
|
+
| **variant_biomarker_id** | **String** | The variant's own biomarker key. | [optional] |
|
|
10
|
+
| **variant_route_key** | **String** | The variant's own route key (the id its web page uses). | [optional] |
|
|
11
|
+
| **amino_acid_change** | **String** | The protein change, for example p.V600E. | [optional] |
|
|
12
|
+
| **gdc_data_release** | **String** | The Genomic Data Commons data release the match was made against. | [optional] |
|
|
13
|
+
| **normalization_status** | **String** | How the variant matched: resolved_single_ssm, no_exact_ssm, multiple_exact_ssms or source_error. | [optional] |
|
|
14
|
+
| **match_count** | **Integer** | Somatic mutations in the catalogue that encode the same protein change. | [optional] |
|
|
15
|
+
| **resolution_reason** | **String** | The reason for the status, in words. | [optional] |
|
|
16
|
+
| **measured_project_count** | **Integer** | Research projects with an observed frequency for the variant in biomarker_sample_prevalence. | [optional] |
|
|
17
|
+
|
|
18
|
+
## Example
|
|
19
|
+
|
|
20
|
+
```ruby
|
|
21
|
+
require 'pharmaobservatory'
|
|
22
|
+
|
|
23
|
+
instance = PharmaObservatory::BiomarkerSampleCoverageRow.new(
|
|
24
|
+
route_key: null,
|
|
25
|
+
gene_symbol: null,
|
|
26
|
+
variant_biomarker_id: null,
|
|
27
|
+
variant_route_key: null,
|
|
28
|
+
amino_acid_change: null,
|
|
29
|
+
gdc_data_release: null,
|
|
30
|
+
normalization_status: null,
|
|
31
|
+
match_count: null,
|
|
32
|
+
resolution_reason: null,
|
|
33
|
+
measured_project_count: null
|
|
34
|
+
)
|
|
35
|
+
```
|
|
36
|
+
|