pharmaobservatory 0.1.3 → 0.1.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (175) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +101 -4
  3. data/docs/BiomarkerBqpAssertionsRow.md +1 -1
  4. data/docs/BiomarkerEvidenceRow.md +1 -1
  5. data/docs/BiomarkerLiteratureRow.md +1 -1
  6. data/docs/BiomarkerRelationsResponse.md +58 -0
  7. data/docs/BiomarkerRelationsRow.md +54 -0
  8. data/docs/BiomarkerSampleCoverageResponse.md +58 -0
  9. data/docs/BiomarkerSampleCoverageRow.md +36 -0
  10. data/docs/BiomarkerSamplePrevalenceResponse.md +58 -0
  11. data/docs/BiomarkerSamplePrevalenceRow.md +56 -0
  12. data/docs/BiomarkerValidationResponse.md +58 -0
  13. data/docs/BiomarkerValidationRow.md +70 -0
  14. data/docs/BiomarkersApi.md +320 -0
  15. data/docs/BiomarkersRow.md +2 -2
  16. data/docs/CellLinesRow.md +1 -1
  17. data/docs/CompaniesApi.md +410 -0
  18. data/docs/CompaniesRecord.md +1 -1
  19. data/docs/CompaniesRecordAttributes.md +18 -0
  20. data/docs/CompaniesRow.md +7 -3
  21. data/docs/CompanyAssetsResponse.md +58 -0
  22. data/docs/CompanyAssetsRow.md +42 -0
  23. data/docs/CompanyFundingEventsResponse.md +58 -0
  24. data/docs/CompanyFundingEventsRow.md +62 -0
  25. data/docs/CompanyFundingSummaryResponse.md +58 -0
  26. data/docs/CompanyFundingSummaryRow.md +46 -0
  27. data/docs/CompanyProgramsRow.md +2 -2
  28. data/docs/ConditionAdverseEventsResponse.md +58 -0
  29. data/docs/ConditionAdverseEventsRow.md +24 -0
  30. data/docs/ConditionBurdenResponse.md +58 -0
  31. data/docs/ConditionBurdenRow.md +32 -0
  32. data/docs/ConditionDeliveryResponse.md +58 -0
  33. data/docs/ConditionDeliveryRow.md +44 -0
  34. data/docs/ConditionDrugsResponse.md +58 -0
  35. data/docs/ConditionDrugsRow.md +26 -0
  36. data/docs/ConditionPrevalenceResponse.md +58 -0
  37. data/docs/ConditionPrevalenceRow.md +62 -0
  38. data/docs/ConditionPublicationsResponse.md +58 -0
  39. data/docs/ConditionPublicationsRow.md +32 -0
  40. data/docs/ConditionSitesResponse.md +58 -0
  41. data/docs/ConditionSitesRow.md +28 -0
  42. data/docs/ConditionTrialsResponse.md +58 -0
  43. data/docs/ConditionTrialsRow.md +58 -0
  44. data/docs/ConditionsApi.md +953 -0
  45. data/docs/ConditionsRecord.md +38 -0
  46. data/docs/ConditionsRecordAttributes.md +20 -0
  47. data/docs/ConditionsResponse.md +58 -0
  48. data/docs/ConditionsRow.md +32 -0
  49. data/docs/DrugPatentCliffRow.md +1 -1
  50. data/docs/InstitutionalHoldingsRow.md +3 -1
  51. data/docs/LegalEntitiesApi.md +160 -0
  52. data/docs/LegalEntitiesRow.md +1 -1
  53. data/docs/OwnershipPositionsResponse.md +58 -0
  54. data/docs/OwnershipPositionsRow.md +100 -0
  55. data/docs/PdufaDatesRow.md +2 -2
  56. data/docs/SiteCroTrialsRow.md +1 -1
  57. data/docs/SiteTrialConditionsRow.md +1 -1
  58. data/docs/SiteTrialDrugsRow.md +1 -1
  59. data/docs/SiteTrialsRow.md +1 -1
  60. data/docs/SponsorRecruitmentByPhaseRow.md +2 -2
  61. data/docs/SponsorRecruitmentDurationRow.md +1 -1
  62. data/docs/SponsorTrialsRow.md +2 -2
  63. data/docs/TrialAdverseEventsResponse.md +58 -0
  64. data/docs/TrialAdverseEventsRow.md +28 -0
  65. data/docs/TrialChangesResponse.md +58 -0
  66. data/docs/TrialChangesRow.md +36 -0
  67. data/docs/TrialDeliveryResponse.md +58 -0
  68. data/docs/TrialDeliveryRow.md +64 -0
  69. data/docs/TrialDemographicsResponse.md +58 -0
  70. data/docs/TrialDemographicsRow.md +32 -0
  71. data/docs/TrialDrugsResponse.md +58 -0
  72. data/docs/TrialDrugsRow.md +30 -0
  73. data/docs/TrialEnrollmentHistoryResponse.md +58 -0
  74. data/docs/TrialEnrollmentHistoryRow.md +36 -0
  75. data/docs/TrialEnrollmentRateResponse.md +58 -0
  76. data/docs/TrialEnrollmentRateRow.md +58 -0
  77. data/docs/TrialExtractedEndpointsResponse.md +58 -0
  78. data/docs/TrialExtractedEndpointsRow.md +40 -0
  79. data/docs/TrialOutcomeMeasuresResponse.md +58 -0
  80. data/docs/TrialOutcomeMeasuresRow.md +28 -0
  81. data/docs/TrialSitesResponse.md +58 -0
  82. data/docs/TrialSitesRow.md +46 -0
  83. data/docs/TrialsApi.md +1033 -0
  84. data/docs/TrialsRecord.md +38 -0
  85. data/docs/TrialsRecordAttributes.md +24 -0
  86. data/docs/TrialsResponse.md +58 -0
  87. data/docs/TrialsRow.md +116 -0
  88. data/lib/pharmaobservatory/api/biomarkers_api.rb +336 -0
  89. data/lib/pharmaobservatory/api/companies_api.rb +455 -0
  90. data/lib/pharmaobservatory/api/conditions_api.rb +1001 -0
  91. data/lib/pharmaobservatory/api/legal_entities_api.rb +168 -0
  92. data/lib/pharmaobservatory/api/trials_api.rb +1085 -0
  93. data/lib/pharmaobservatory/models/biomarker_bqp_assertions_row.rb +1 -1
  94. data/lib/pharmaobservatory/models/biomarker_evidence_row.rb +1 -1
  95. data/lib/pharmaobservatory/models/biomarker_literature_row.rb +1 -1
  96. data/lib/pharmaobservatory/models/biomarker_relations_response.rb +478 -0
  97. data/lib/pharmaobservatory/models/biomarker_relations_row.rb +421 -0
  98. data/lib/pharmaobservatory/models/biomarker_sample_coverage_response.rb +478 -0
  99. data/lib/pharmaobservatory/models/biomarker_sample_coverage_row.rb +322 -0
  100. data/lib/pharmaobservatory/models/biomarker_sample_prevalence_response.rb +478 -0
  101. data/lib/pharmaobservatory/models/biomarker_sample_prevalence_row.rb +436 -0
  102. data/lib/pharmaobservatory/models/biomarker_validation_response.rb +478 -0
  103. data/lib/pharmaobservatory/models/biomarker_validation_row.rb +509 -0
  104. data/lib/pharmaobservatory/models/biomarkers_row.rb +2 -2
  105. data/lib/pharmaobservatory/models/cell_lines_row.rb +1 -1
  106. data/lib/pharmaobservatory/models/companies_record.rb +1 -1
  107. data/lib/pharmaobservatory/models/companies_record_attributes.rb +220 -0
  108. data/lib/pharmaobservatory/models/companies_row.rb +29 -7
  109. data/lib/pharmaobservatory/models/company_assets_response.rb +478 -0
  110. data/lib/pharmaobservatory/models/company_assets_row.rb +355 -0
  111. data/lib/pharmaobservatory/models/company_funding_events_response.rb +478 -0
  112. data/lib/pharmaobservatory/models/company_funding_events_row.rb +465 -0
  113. data/lib/pharmaobservatory/models/company_funding_summary_response.rb +478 -0
  114. data/lib/pharmaobservatory/models/company_funding_summary_row.rb +377 -0
  115. data/lib/pharmaobservatory/models/company_programs_row.rb +2 -2
  116. data/lib/pharmaobservatory/models/condition_adverse_events_response.rb +478 -0
  117. data/lib/pharmaobservatory/models/condition_adverse_events_row.rb +256 -0
  118. data/lib/pharmaobservatory/models/condition_burden_response.rb +478 -0
  119. data/lib/pharmaobservatory/models/condition_burden_row.rb +300 -0
  120. data/lib/pharmaobservatory/models/condition_delivery_response.rb +478 -0
  121. data/lib/pharmaobservatory/models/condition_delivery_row.rb +366 -0
  122. data/lib/pharmaobservatory/models/condition_drugs_response.rb +478 -0
  123. data/lib/pharmaobservatory/models/condition_drugs_row.rb +267 -0
  124. data/lib/pharmaobservatory/models/condition_prevalence_response.rb +478 -0
  125. data/lib/pharmaobservatory/models/condition_prevalence_row.rb +465 -0
  126. data/lib/pharmaobservatory/models/condition_publications_response.rb +478 -0
  127. data/lib/pharmaobservatory/models/condition_publications_row.rb +300 -0
  128. data/lib/pharmaobservatory/models/condition_sites_response.rb +478 -0
  129. data/lib/pharmaobservatory/models/condition_sites_row.rb +278 -0
  130. data/lib/pharmaobservatory/models/condition_trials_response.rb +478 -0
  131. data/lib/pharmaobservatory/models/condition_trials_row.rb +443 -0
  132. data/lib/pharmaobservatory/models/conditions_record.rb +385 -0
  133. data/lib/pharmaobservatory/models/conditions_record_attributes.rb +229 -0
  134. data/lib/pharmaobservatory/models/conditions_response.rb +478 -0
  135. data/lib/pharmaobservatory/models/conditions_row.rb +304 -0
  136. data/lib/pharmaobservatory/models/drug_patent_cliff_row.rb +1 -1
  137. data/lib/pharmaobservatory/models/institutional_holdings_row.rb +13 -2
  138. data/lib/pharmaobservatory/models/legal_entities_row.rb +1 -1
  139. data/lib/pharmaobservatory/models/ownership_positions_response.rb +478 -0
  140. data/lib/pharmaobservatory/models/ownership_positions_row.rb +674 -0
  141. data/lib/pharmaobservatory/models/pdufa_dates_row.rb +2 -2
  142. data/lib/pharmaobservatory/models/site_cro_trials_row.rb +1 -1
  143. data/lib/pharmaobservatory/models/site_trial_conditions_row.rb +1 -1
  144. data/lib/pharmaobservatory/models/site_trial_drugs_row.rb +1 -1
  145. data/lib/pharmaobservatory/models/site_trials_row.rb +1 -1
  146. data/lib/pharmaobservatory/models/sponsor_recruitment_by_phase_row.rb +2 -2
  147. data/lib/pharmaobservatory/models/sponsor_recruitment_duration_row.rb +1 -1
  148. data/lib/pharmaobservatory/models/sponsor_trials_row.rb +2 -2
  149. data/lib/pharmaobservatory/models/trial_adverse_events_response.rb +478 -0
  150. data/lib/pharmaobservatory/models/trial_adverse_events_row.rb +278 -0
  151. data/lib/pharmaobservatory/models/trial_changes_response.rb +478 -0
  152. data/lib/pharmaobservatory/models/trial_changes_row.rb +328 -0
  153. data/lib/pharmaobservatory/models/trial_delivery_response.rb +478 -0
  154. data/lib/pharmaobservatory/models/trial_delivery_row.rb +476 -0
  155. data/lib/pharmaobservatory/models/trial_demographics_response.rb +478 -0
  156. data/lib/pharmaobservatory/models/trial_demographics_row.rb +300 -0
  157. data/lib/pharmaobservatory/models/trial_drugs_response.rb +478 -0
  158. data/lib/pharmaobservatory/models/trial_drugs_row.rb +291 -0
  159. data/lib/pharmaobservatory/models/trial_enrollment_history_response.rb +478 -0
  160. data/lib/pharmaobservatory/models/trial_enrollment_history_row.rb +322 -0
  161. data/lib/pharmaobservatory/models/trial_enrollment_rate_response.rb +478 -0
  162. data/lib/pharmaobservatory/models/trial_enrollment_rate_row.rb +443 -0
  163. data/lib/pharmaobservatory/models/trial_extracted_endpoints_response.rb +478 -0
  164. data/lib/pharmaobservatory/models/trial_extracted_endpoints_row.rb +346 -0
  165. data/lib/pharmaobservatory/models/trial_outcome_measures_response.rb +478 -0
  166. data/lib/pharmaobservatory/models/trial_outcome_measures_row.rb +278 -0
  167. data/lib/pharmaobservatory/models/trial_sites_response.rb +478 -0
  168. data/lib/pharmaobservatory/models/trial_sites_row.rb +377 -0
  169. data/lib/pharmaobservatory/models/trials_record.rb +385 -0
  170. data/lib/pharmaobservatory/models/trials_record_attributes.rb +247 -0
  171. data/lib/pharmaobservatory/models/trials_response.rb +478 -0
  172. data/lib/pharmaobservatory/models/trials_row.rb +784 -0
  173. data/lib/pharmaobservatory/version.rb +1 -1
  174. data/lib/pharmaobservatory.rb +63 -0
  175. metadata +127 -1
@@ -0,0 +1,38 @@
1
+ # PharmaObservatory::TrialsRecord
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **object_type** | **String** | | |
8
+ | **id** | **String** | | |
9
+ | **record** | [**TrialsRow**](TrialsRow.md) | | |
10
+ | **attributes** | [**TrialsRecordAttributes**](TrialsRecordAttributes.md) | | [optional] |
11
+ | **datasets** | [**Array<DatasetListing>**](DatasetListing.md) | | |
12
+ | **attribution** | [**Array<DatasetAttribution>**](DatasetAttribution.md) | | [optional] |
13
+ | **source_credit** | **String** | | [optional] |
14
+ | **freshness** | [**BiomarkerCdxAssertionsResponseFreshness**](BiomarkerCdxAssertionsResponseFreshness.md) | | [optional] |
15
+ | **build** | [**BiomarkerCdxAssertionsResponseBuild**](BiomarkerCdxAssertionsResponseBuild.md) | | [optional] |
16
+ | **build_state** | [**DatasetBuildState**](DatasetBuildState.md) | | [optional] |
17
+ | **restriction** | **Hash<String, Object>** | | [optional] |
18
+
19
+ ## Example
20
+
21
+ ```ruby
22
+ require 'pharmaobservatory'
23
+
24
+ instance = PharmaObservatory::TrialsRecord.new(
25
+ object_type: null,
26
+ id: null,
27
+ record: null,
28
+ attributes: null,
29
+ datasets: null,
30
+ attribution: null,
31
+ source_credit: null,
32
+ freshness: null,
33
+ build: null,
34
+ build_state: null,
35
+ restriction: null
36
+ )
37
+ ```
38
+
@@ -0,0 +1,24 @@
1
+ # PharmaObservatory::TrialsRecordAttributes
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **trial_delivery** | [**TrialDeliveryRow**](TrialDeliveryRow.md) | | [optional] |
8
+ | **trial_demographics** | [**TrialDemographicsRow**](TrialDemographicsRow.md) | | [optional] |
9
+ | **trial_enrollment_rate** | [**TrialEnrollmentRateRow**](TrialEnrollmentRateRow.md) | | [optional] |
10
+ | **trial_extracted_endpoints** | [**TrialExtractedEndpointsRow**](TrialExtractedEndpointsRow.md) | | [optional] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'pharmaobservatory'
16
+
17
+ instance = PharmaObservatory::TrialsRecordAttributes.new(
18
+ trial_delivery: null,
19
+ trial_demographics: null,
20
+ trial_enrollment_rate: null,
21
+ trial_extracted_endpoints: null
22
+ )
23
+ ```
24
+
@@ -0,0 +1,58 @@
1
+ # PharmaObservatory::TrialsResponse
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<TrialsRow>**](TrialsRow.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::TrialsResponse.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
+
data/docs/TrialsRow.md ADDED
@@ -0,0 +1,116 @@
1
+ # PharmaObservatory::TrialsRow
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **trial_id** | **String** | The trial's ClinicalTrials.gov registry id (NCT, National Clinical Trial, number). | [optional] |
8
+ | **brief_title** | **String** | The trial's brief title. | [optional] |
9
+ | **official_title** | **String** | The trial's official title. | [optional] |
10
+ | **study_type** | **String** | INTERVENTIONAL, OBSERVATIONAL or EXPANDED_ACCESS. | [optional] |
11
+ | **overall_status** | **String** | The registry's overall status code (RECRUITING, COMPLETED, TERMINATED and so on). | [optional] |
12
+ | **overall_status_summary** | **String** | A coarse status label derived from the overall status (Recruiting, Completed, Discontinued and so on). | [optional] |
13
+ | **phase** | **String** | The registry's phase code (PHASE1, PHASE2, PHASE2/PHASE3, NA). | [optional] |
14
+ | **phase_label** | **String** | The trial phase as a label (Phase 2, Phase 3, Observational, Not applicable). | [optional] |
15
+ | **phase_by_status** | **String** | The phase code and the status summary joined with a colon (PHASE2:Completed). | [optional] |
16
+ | **enrollment** | **Integer** | Enrollment as registered: a planned target or an achieved count (see enrollment_type). | [optional] |
17
+ | **enrollment_type** | **String** | ACTUAL (a count of enrolled participants) or ESTIMATED (a planned target). | [optional] |
18
+ | **enrollment_is_plausible** | **Boolean** | False when the registered enrollment is a placeholder value rather than a count. | [optional] |
19
+ | **enrollment_flag_reason** | **String** | Why the registered enrollment was marked a placeholder (null when it was not). | [optional] |
20
+ | **start_date** | **Date** | Trial start date. | [optional] |
21
+ | **start_year** | **Integer** | Year of the trial start. | [optional] |
22
+ | **primary_completion_date** | **Date** | Primary completion date. | [optional] |
23
+ | **primary_completion_date_type** | **String** | ACTUAL (a date that has occurred) or ESTIMATED (a planned date). | [optional] |
24
+ | **completion_date** | **Date** | Completion date. | [optional] |
25
+ | **completion_date_type** | **String** | ACTUAL (a date that has occurred) or ESTIMATED (a planned date). | [optional] |
26
+ | **study_first_posted_date** | **Date** | Date the study was first posted to the registry. | [optional] |
27
+ | **last_update_posted_date** | **Date** | Date the registry record was last updated. | [optional] |
28
+ | **why_stopped** | **String** | The sponsor's stated reason a trial was stopped early, as filed. | [optional] |
29
+ | **number_of_arms** | **Integer** | Number of study arms. | [optional] |
30
+ | **were_results_reported** | **Boolean** | Whether results are posted to the registry. | [optional] |
31
+ | **gender** | **String** | Eligible sex: ALL, FEMALE or MALE. | [optional] |
32
+ | **minimum_age** | **String** | Minimum eligible age, as filed (for example 18 Years). | [optional] |
33
+ | **maximum_age** | **String** | Maximum eligible age, as filed (for example 65 Years). | [optional] |
34
+ | **healthy_volunteers** | **Boolean** | Whether healthy volunteers are accepted. | [optional] |
35
+ | **eligibility_criteria** | **String** | The inclusion and exclusion criteria text, as filed. | [optional] |
36
+ | **lead_sponsor_name** | **String** | The lead sponsor name as filed. | [optional] |
37
+ | **lead_sponsor_org_id** | **String** | Legal-entity level: the organization record the lead sponsor resolved to (null when unresolved). | [optional] |
38
+ | **lead_sponsor_company_id** | **String** | Company level: the company the lead sponsor belongs to (null when unresolved). | [optional] |
39
+ | **lead_sponsor_company_name** | **String** | Display name of the lead sponsor's company. | [optional] |
40
+ | **lead_sponsor_group_id** | **String** | Group level: the lead sponsor's current ultimate parent company; a root company's group is itself. | [optional] |
41
+ | **lead_sponsor_group_name** | **String** | Display name of the lead sponsor's group. | [optional] |
42
+ | **collaborators** | **Array<String>** | Collaborating sponsor names, as filed. | [optional] |
43
+ | **participating_sponsors** | **Array<String>** | Names of the lead sponsor and the collaborators, as filed. | [optional] |
44
+ | **conditions** | **Array<String>** | Conditions studied, as registered. | [optional] |
45
+ | **condition_mesh** | **Array<String>** | Conditions studied, as Medical Subject Headings (MeSH) terms the registry assigns. | [optional] |
46
+ | **interventions** | **Array<String>** | Interventions, as registered. | [optional] |
47
+ | **intervention_mesh** | **Array<String>** | Interventions as Medical Subject Headings (MeSH) terms the registry assigns. | [optional] |
48
+ | **intervention_types** | **Array<String>** | Intervention types (DRUG, BIOLOGICAL, DEVICE and so on). | [optional] |
49
+ | **number_of_facilities** | **Integer** | Number of study sites the registry record states. | [optional] |
50
+ | **facility_count** | **Integer** | Number of study sites listed on the record. | [optional] |
51
+ | **has_us_facility** | **Boolean** | Whether any listed site is in the United States. | [optional] |
52
+ | **facility_country_count** | **Integer** | Number of countries with a listed site. | [optional] |
53
+ | **facility_countries** | **Array<String>** | Countries with a listed site. | [optional] |
54
+ | **condition_ids** | **Array<String>** | MeSH condition ids the trial is linked to, direct and through the MeSH tree. Filter on one id to match the trials that carry it. | [optional] |
55
+ | **drug_ids** | **Array<String>** | Drug ids the trial's interventions resolved to. Filter on one id to match the trials that carry it. | [optional] |
56
+ | **sponsor_org_ids** | **Array<String>** | Organization record ids of the sponsors on the trial, lead and collaborator. Filter on one id to match the trials that carry it. | [optional] |
57
+
58
+ ## Example
59
+
60
+ ```ruby
61
+ require 'pharmaobservatory'
62
+
63
+ instance = PharmaObservatory::TrialsRow.new(
64
+ trial_id: null,
65
+ brief_title: null,
66
+ official_title: null,
67
+ study_type: null,
68
+ overall_status: null,
69
+ overall_status_summary: null,
70
+ phase: null,
71
+ phase_label: null,
72
+ phase_by_status: null,
73
+ enrollment: null,
74
+ enrollment_type: null,
75
+ enrollment_is_plausible: null,
76
+ enrollment_flag_reason: null,
77
+ start_date: null,
78
+ start_year: null,
79
+ primary_completion_date: null,
80
+ primary_completion_date_type: null,
81
+ completion_date: null,
82
+ completion_date_type: null,
83
+ study_first_posted_date: null,
84
+ last_update_posted_date: null,
85
+ why_stopped: null,
86
+ number_of_arms: null,
87
+ were_results_reported: null,
88
+ gender: null,
89
+ minimum_age: null,
90
+ maximum_age: null,
91
+ healthy_volunteers: null,
92
+ eligibility_criteria: null,
93
+ lead_sponsor_name: null,
94
+ lead_sponsor_org_id: null,
95
+ lead_sponsor_company_id: null,
96
+ lead_sponsor_company_name: null,
97
+ lead_sponsor_group_id: null,
98
+ lead_sponsor_group_name: null,
99
+ collaborators: null,
100
+ participating_sponsors: null,
101
+ conditions: null,
102
+ condition_mesh: null,
103
+ interventions: null,
104
+ intervention_mesh: null,
105
+ intervention_types: null,
106
+ number_of_facilities: null,
107
+ facility_count: null,
108
+ has_us_facility: null,
109
+ facility_country_count: null,
110
+ facility_countries: null,
111
+ condition_ids: null,
112
+ drug_ids: null,
113
+ sponsor_org_ids: null
114
+ )
115
+ ```
116
+
@@ -439,6 +439,342 @@ module PharmaObservatory
439
439
  return data, status_code, headers
440
440
  end
441
441
 
442
+ # Literature-extracted relations
443
+ # @param id [String]
444
+ # @param [Hash] opts the optional parameters
445
+ # @option opts [String] :cursor The next_cursor of the previous page. Opaque; it is bound to the filters and the warehouse build that issued it.
446
+ # @option opts [Integer] :limit Rows per page, up to 500 (default 50).
447
+ # @option opts [String] :sort Comma separated columns, a leading minus for descending: sort=a,-b.
448
+ # @option opts [String] :group_by A dimension to group by; a date takes :year, :quarter or :month.
449
+ # @option opts [String] :measure count, sum(col), avg(col), min(col), max(col), median(col) or count_distinct(col).
450
+ # @return [BiomarkerRelationsResponse]
451
+ def biomarkers_biomarker_relations(id, opts = {})
452
+ data, _status_code, _headers = biomarkers_biomarker_relations_with_http_info(id, opts)
453
+ data
454
+ end
455
+
456
+ # Literature-extracted relations
457
+ # @param id [String]
458
+ # @param [Hash] opts the optional parameters
459
+ # @option opts [String] :cursor The next_cursor of the previous page. Opaque; it is bound to the filters and the warehouse build that issued it.
460
+ # @option opts [Integer] :limit Rows per page, up to 500 (default 50).
461
+ # @option opts [String] :sort Comma separated columns, a leading minus for descending: sort=a,-b.
462
+ # @option opts [String] :group_by A dimension to group by; a date takes :year, :quarter or :month.
463
+ # @option opts [String] :measure count, sum(col), avg(col), min(col), max(col), median(col) or count_distinct(col).
464
+ # @return [Array<(BiomarkerRelationsResponse, Integer, Hash)>] BiomarkerRelationsResponse data, response status code and response headers
465
+ def biomarkers_biomarker_relations_with_http_info(id, opts = {})
466
+ if @api_client.config.debugging
467
+ @api_client.config.logger.debug 'Calling API: BiomarkersApi.biomarkers_biomarker_relations ...'
468
+ end
469
+ # verify the required parameter 'id' is set
470
+ if @api_client.config.client_side_validation && id.nil?
471
+ fail ArgumentError, "Missing the required parameter 'id' when calling BiomarkersApi.biomarkers_biomarker_relations"
472
+ end
473
+ if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 500
474
+ fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling BiomarkersApi.biomarkers_biomarker_relations, must be smaller than or equal to 500.'
475
+ end
476
+
477
+ if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
478
+ fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling BiomarkersApi.biomarkers_biomarker_relations, must be greater than or equal to 1.'
479
+ end
480
+
481
+ # resource path
482
+ local_var_path = '/api/v1/biomarkers/{id}/biomarker_relations'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
483
+
484
+ # query parameters
485
+ query_params = opts[:query_params] || {}
486
+ query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
487
+ query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
488
+ query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
489
+ query_params[:'group_by'] = opts[:'group_by'] if !opts[:'group_by'].nil?
490
+ query_params[:'measure'] = opts[:'measure'] if !opts[:'measure'].nil?
491
+
492
+ # header parameters
493
+ header_params = opts[:header_params] || {}
494
+ # HTTP header 'Accept' (if needed)
495
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
496
+
497
+ # form parameters
498
+ form_params = opts[:form_params] || {}
499
+
500
+ # http body (model)
501
+ post_body = opts[:debug_body]
502
+
503
+ # return_type
504
+ return_type = opts[:debug_return_type] || 'BiomarkerRelationsResponse'
505
+
506
+ # auth_names
507
+ auth_names = opts[:debug_auth_names] || ['ApiBearerJwt']
508
+
509
+ new_options = opts.merge(
510
+ :operation => :"BiomarkersApi.biomarkers_biomarker_relations",
511
+ :header_params => header_params,
512
+ :query_params => query_params,
513
+ :form_params => form_params,
514
+ :body => post_body,
515
+ :auth_names => auth_names,
516
+ :return_type => return_type
517
+ )
518
+
519
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
520
+ if @api_client.config.debugging
521
+ @api_client.config.logger.debug "API called: BiomarkersApi#biomarkers_biomarker_relations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
522
+ end
523
+ return data, status_code, headers
524
+ end
525
+
526
+ # Human sample screening coverage (GDC)
527
+ # @param id [String]
528
+ # @param [Hash] opts the optional parameters
529
+ # @option opts [String] :cursor The next_cursor of the previous page. Opaque; it is bound to the filters and the warehouse build that issued it.
530
+ # @option opts [Integer] :limit Rows per page, up to 500 (default 50).
531
+ # @option opts [String] :sort Comma separated columns, a leading minus for descending: sort&#x3D;a,-b.
532
+ # @option opts [String] :group_by A dimension to group by; a date takes :year, :quarter or :month.
533
+ # @option opts [String] :measure count, sum(col), avg(col), min(col), max(col), median(col) or count_distinct(col).
534
+ # @return [BiomarkerSampleCoverageResponse]
535
+ def biomarkers_biomarker_sample_coverage(id, opts = {})
536
+ data, _status_code, _headers = biomarkers_biomarker_sample_coverage_with_http_info(id, opts)
537
+ data
538
+ end
539
+
540
+ # Human sample screening coverage (GDC)
541
+ # @param id [String]
542
+ # @param [Hash] opts the optional parameters
543
+ # @option opts [String] :cursor The next_cursor of the previous page. Opaque; it is bound to the filters and the warehouse build that issued it.
544
+ # @option opts [Integer] :limit Rows per page, up to 500 (default 50).
545
+ # @option opts [String] :sort Comma separated columns, a leading minus for descending: sort&#x3D;a,-b.
546
+ # @option opts [String] :group_by A dimension to group by; a date takes :year, :quarter or :month.
547
+ # @option opts [String] :measure count, sum(col), avg(col), min(col), max(col), median(col) or count_distinct(col).
548
+ # @return [Array<(BiomarkerSampleCoverageResponse, Integer, Hash)>] BiomarkerSampleCoverageResponse data, response status code and response headers
549
+ def biomarkers_biomarker_sample_coverage_with_http_info(id, opts = {})
550
+ if @api_client.config.debugging
551
+ @api_client.config.logger.debug 'Calling API: BiomarkersApi.biomarkers_biomarker_sample_coverage ...'
552
+ end
553
+ # verify the required parameter 'id' is set
554
+ if @api_client.config.client_side_validation && id.nil?
555
+ fail ArgumentError, "Missing the required parameter 'id' when calling BiomarkersApi.biomarkers_biomarker_sample_coverage"
556
+ end
557
+ if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 500
558
+ fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling BiomarkersApi.biomarkers_biomarker_sample_coverage, must be smaller than or equal to 500.'
559
+ end
560
+
561
+ if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
562
+ fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling BiomarkersApi.biomarkers_biomarker_sample_coverage, must be greater than or equal to 1.'
563
+ end
564
+
565
+ # resource path
566
+ local_var_path = '/api/v1/biomarkers/{id}/biomarker_sample_coverage'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
567
+
568
+ # query parameters
569
+ query_params = opts[:query_params] || {}
570
+ query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
571
+ query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
572
+ query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
573
+ query_params[:'group_by'] = opts[:'group_by'] if !opts[:'group_by'].nil?
574
+ query_params[:'measure'] = opts[:'measure'] if !opts[:'measure'].nil?
575
+
576
+ # header parameters
577
+ header_params = opts[:header_params] || {}
578
+ # HTTP header 'Accept' (if needed)
579
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
580
+
581
+ # form parameters
582
+ form_params = opts[:form_params] || {}
583
+
584
+ # http body (model)
585
+ post_body = opts[:debug_body]
586
+
587
+ # return_type
588
+ return_type = opts[:debug_return_type] || 'BiomarkerSampleCoverageResponse'
589
+
590
+ # auth_names
591
+ auth_names = opts[:debug_auth_names] || ['ApiBearerJwt']
592
+
593
+ new_options = opts.merge(
594
+ :operation => :"BiomarkersApi.biomarkers_biomarker_sample_coverage",
595
+ :header_params => header_params,
596
+ :query_params => query_params,
597
+ :form_params => form_params,
598
+ :body => post_body,
599
+ :auth_names => auth_names,
600
+ :return_type => return_type
601
+ )
602
+
603
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
604
+ if @api_client.config.debugging
605
+ @api_client.config.logger.debug "API called: BiomarkersApi#biomarkers_biomarker_sample_coverage\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
606
+ end
607
+ return data, status_code, headers
608
+ end
609
+
610
+ # Human sample screening reference (GDC cohorts)
611
+ # @param id [String]
612
+ # @param [Hash] opts the optional parameters
613
+ # @option opts [String] :cursor The next_cursor of the previous page. Opaque; it is bound to the filters and the warehouse build that issued it.
614
+ # @option opts [Integer] :limit Rows per page, up to 500 (default 50).
615
+ # @option opts [String] :sort Comma separated columns, a leading minus for descending: sort&#x3D;a,-b.
616
+ # @option opts [String] :group_by A dimension to group by; a date takes :year, :quarter or :month.
617
+ # @option opts [String] :measure count, sum(col), avg(col), min(col), max(col), median(col) or count_distinct(col).
618
+ # @return [BiomarkerSamplePrevalenceResponse]
619
+ def biomarkers_biomarker_sample_prevalence(id, opts = {})
620
+ data, _status_code, _headers = biomarkers_biomarker_sample_prevalence_with_http_info(id, opts)
621
+ data
622
+ end
623
+
624
+ # Human sample screening reference (GDC cohorts)
625
+ # @param id [String]
626
+ # @param [Hash] opts the optional parameters
627
+ # @option opts [String] :cursor The next_cursor of the previous page. Opaque; it is bound to the filters and the warehouse build that issued it.
628
+ # @option opts [Integer] :limit Rows per page, up to 500 (default 50).
629
+ # @option opts [String] :sort Comma separated columns, a leading minus for descending: sort&#x3D;a,-b.
630
+ # @option opts [String] :group_by A dimension to group by; a date takes :year, :quarter or :month.
631
+ # @option opts [String] :measure count, sum(col), avg(col), min(col), max(col), median(col) or count_distinct(col).
632
+ # @return [Array<(BiomarkerSamplePrevalenceResponse, Integer, Hash)>] BiomarkerSamplePrevalenceResponse data, response status code and response headers
633
+ def biomarkers_biomarker_sample_prevalence_with_http_info(id, opts = {})
634
+ if @api_client.config.debugging
635
+ @api_client.config.logger.debug 'Calling API: BiomarkersApi.biomarkers_biomarker_sample_prevalence ...'
636
+ end
637
+ # verify the required parameter 'id' is set
638
+ if @api_client.config.client_side_validation && id.nil?
639
+ fail ArgumentError, "Missing the required parameter 'id' when calling BiomarkersApi.biomarkers_biomarker_sample_prevalence"
640
+ end
641
+ if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 500
642
+ fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling BiomarkersApi.biomarkers_biomarker_sample_prevalence, must be smaller than or equal to 500.'
643
+ end
644
+
645
+ if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
646
+ fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling BiomarkersApi.biomarkers_biomarker_sample_prevalence, must be greater than or equal to 1.'
647
+ end
648
+
649
+ # resource path
650
+ local_var_path = '/api/v1/biomarkers/{id}/biomarker_sample_prevalence'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
651
+
652
+ # query parameters
653
+ query_params = opts[:query_params] || {}
654
+ query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
655
+ query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
656
+ query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
657
+ query_params[:'group_by'] = opts[:'group_by'] if !opts[:'group_by'].nil?
658
+ query_params[:'measure'] = opts[:'measure'] if !opts[:'measure'].nil?
659
+
660
+ # header parameters
661
+ header_params = opts[:header_params] || {}
662
+ # HTTP header 'Accept' (if needed)
663
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
664
+
665
+ # form parameters
666
+ form_params = opts[:form_params] || {}
667
+
668
+ # http body (model)
669
+ post_body = opts[:debug_body]
670
+
671
+ # return_type
672
+ return_type = opts[:debug_return_type] || 'BiomarkerSamplePrevalenceResponse'
673
+
674
+ # auth_names
675
+ auth_names = opts[:debug_auth_names] || ['ApiBearerJwt']
676
+
677
+ new_options = opts.merge(
678
+ :operation => :"BiomarkersApi.biomarkers_biomarker_sample_prevalence",
679
+ :header_params => header_params,
680
+ :query_params => query_params,
681
+ :form_params => form_params,
682
+ :body => post_body,
683
+ :auth_names => auth_names,
684
+ :return_type => return_type
685
+ )
686
+
687
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
688
+ if @api_client.config.debugging
689
+ @api_client.config.logger.debug "API called: BiomarkersApi#biomarkers_biomarker_sample_prevalence\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
690
+ end
691
+ return data, status_code, headers
692
+ end
693
+
694
+ # Biomarker validation ladder
695
+ # @param id [String]
696
+ # @param [Hash] opts the optional parameters
697
+ # @option opts [String] :cursor The next_cursor of the previous page. Opaque; it is bound to the filters and the warehouse build that issued it.
698
+ # @option opts [Integer] :limit Rows per page, up to 500 (default 50).
699
+ # @option opts [String] :sort Comma separated columns, a leading minus for descending: sort&#x3D;a,-b.
700
+ # @option opts [String] :group_by A dimension to group by; a date takes :year, :quarter or :month.
701
+ # @option opts [String] :measure count, sum(col), avg(col), min(col), max(col), median(col) or count_distinct(col).
702
+ # @return [BiomarkerValidationResponse]
703
+ def biomarkers_biomarker_validation(id, opts = {})
704
+ data, _status_code, _headers = biomarkers_biomarker_validation_with_http_info(id, opts)
705
+ data
706
+ end
707
+
708
+ # Biomarker validation ladder
709
+ # @param id [String]
710
+ # @param [Hash] opts the optional parameters
711
+ # @option opts [String] :cursor The next_cursor of the previous page. Opaque; it is bound to the filters and the warehouse build that issued it.
712
+ # @option opts [Integer] :limit Rows per page, up to 500 (default 50).
713
+ # @option opts [String] :sort Comma separated columns, a leading minus for descending: sort&#x3D;a,-b.
714
+ # @option opts [String] :group_by A dimension to group by; a date takes :year, :quarter or :month.
715
+ # @option opts [String] :measure count, sum(col), avg(col), min(col), max(col), median(col) or count_distinct(col).
716
+ # @return [Array<(BiomarkerValidationResponse, Integer, Hash)>] BiomarkerValidationResponse data, response status code and response headers
717
+ def biomarkers_biomarker_validation_with_http_info(id, opts = {})
718
+ if @api_client.config.debugging
719
+ @api_client.config.logger.debug 'Calling API: BiomarkersApi.biomarkers_biomarker_validation ...'
720
+ end
721
+ # verify the required parameter 'id' is set
722
+ if @api_client.config.client_side_validation && id.nil?
723
+ fail ArgumentError, "Missing the required parameter 'id' when calling BiomarkersApi.biomarkers_biomarker_validation"
724
+ end
725
+ if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 500
726
+ fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling BiomarkersApi.biomarkers_biomarker_validation, must be smaller than or equal to 500.'
727
+ end
728
+
729
+ if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
730
+ fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling BiomarkersApi.biomarkers_biomarker_validation, must be greater than or equal to 1.'
731
+ end
732
+
733
+ # resource path
734
+ local_var_path = '/api/v1/biomarkers/{id}/biomarker_validation'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
735
+
736
+ # query parameters
737
+ query_params = opts[:query_params] || {}
738
+ query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
739
+ query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
740
+ query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
741
+ query_params[:'group_by'] = opts[:'group_by'] if !opts[:'group_by'].nil?
742
+ query_params[:'measure'] = opts[:'measure'] if !opts[:'measure'].nil?
743
+
744
+ # header parameters
745
+ header_params = opts[:header_params] || {}
746
+ # HTTP header 'Accept' (if needed)
747
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
748
+
749
+ # form parameters
750
+ form_params = opts[:form_params] || {}
751
+
752
+ # http body (model)
753
+ post_body = opts[:debug_body]
754
+
755
+ # return_type
756
+ return_type = opts[:debug_return_type] || 'BiomarkerValidationResponse'
757
+
758
+ # auth_names
759
+ auth_names = opts[:debug_auth_names] || ['ApiBearerJwt']
760
+
761
+ new_options = opts.merge(
762
+ :operation => :"BiomarkersApi.biomarkers_biomarker_validation",
763
+ :header_params => header_params,
764
+ :query_params => query_params,
765
+ :form_params => form_params,
766
+ :body => post_body,
767
+ :auth_names => auth_names,
768
+ :return_type => return_type
769
+ )
770
+
771
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
772
+ if @api_client.config.debugging
773
+ @api_client.config.logger.debug "API called: BiomarkersApi#biomarkers_biomarker_validation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
774
+ end
775
+ return data, status_code, headers
776
+ end
777
+
442
778
  # Protein variant mentions
443
779
  # @param id [String]
444
780
  # @param [Hash] opts the optional parameters