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.
Files changed (185) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +105 -4
  3. data/docs/ApiV1WhoamiGet200Response.md +13 -1
  4. data/docs/ApiV1WhoamiGet200ResponseLimits.md +32 -0
  5. data/docs/ApiV1WhoamiGet200ResponseQuota.md +20 -0
  6. data/docs/ApiV1WhoamiGet200ResponseQuotaBuckets.md +28 -0
  7. data/docs/ApiV1WhoamiGet200ResponseQuotaBucketsRequestsPerMinute.md +28 -0
  8. data/docs/BiomarkerBqpAssertionsRow.md +1 -1
  9. data/docs/BiomarkerEvidenceRow.md +1 -1
  10. data/docs/BiomarkerLiteratureRow.md +1 -1
  11. data/docs/BiomarkerRelationsResponse.md +58 -0
  12. data/docs/BiomarkerRelationsRow.md +54 -0
  13. data/docs/BiomarkerSampleCoverageResponse.md +58 -0
  14. data/docs/BiomarkerSampleCoverageRow.md +36 -0
  15. data/docs/BiomarkerSamplePrevalenceResponse.md +58 -0
  16. data/docs/BiomarkerSamplePrevalenceRow.md +56 -0
  17. data/docs/BiomarkerValidationResponse.md +58 -0
  18. data/docs/BiomarkerValidationRow.md +70 -0
  19. data/docs/BiomarkersApi.md +320 -0
  20. data/docs/BiomarkersRow.md +2 -2
  21. data/docs/CellLinesRow.md +1 -1
  22. data/docs/CompaniesApi.md +410 -0
  23. data/docs/CompaniesRecord.md +1 -1
  24. data/docs/CompaniesRecordAttributes.md +18 -0
  25. data/docs/CompaniesRow.md +8 -4
  26. data/docs/CompanyAssetsResponse.md +58 -0
  27. data/docs/CompanyAssetsRow.md +42 -0
  28. data/docs/CompanyFundingEventsResponse.md +58 -0
  29. data/docs/CompanyFundingEventsRow.md +62 -0
  30. data/docs/CompanyFundingSummaryResponse.md +58 -0
  31. data/docs/CompanyFundingSummaryRow.md +46 -0
  32. data/docs/CompanyProgramsRow.md +2 -2
  33. data/docs/ConditionAdverseEventsResponse.md +58 -0
  34. data/docs/ConditionAdverseEventsRow.md +24 -0
  35. data/docs/ConditionBurdenResponse.md +58 -0
  36. data/docs/ConditionBurdenRow.md +32 -0
  37. data/docs/ConditionDeliveryResponse.md +58 -0
  38. data/docs/ConditionDeliveryRow.md +44 -0
  39. data/docs/ConditionDrugsResponse.md +58 -0
  40. data/docs/ConditionDrugsRow.md +26 -0
  41. data/docs/ConditionPrevalenceResponse.md +58 -0
  42. data/docs/ConditionPrevalenceRow.md +62 -0
  43. data/docs/ConditionPublicationsResponse.md +58 -0
  44. data/docs/ConditionPublicationsRow.md +32 -0
  45. data/docs/ConditionSitesResponse.md +58 -0
  46. data/docs/ConditionSitesRow.md +28 -0
  47. data/docs/ConditionTrialsResponse.md +58 -0
  48. data/docs/ConditionTrialsRow.md +60 -0
  49. data/docs/ConditionsApi.md +953 -0
  50. data/docs/ConditionsRecord.md +38 -0
  51. data/docs/ConditionsRecordAttributes.md +20 -0
  52. data/docs/ConditionsResponse.md +58 -0
  53. data/docs/ConditionsRow.md +32 -0
  54. data/docs/DrugPatentCliffRow.md +1 -1
  55. data/docs/InstitutionalHoldingsRow.md +3 -1
  56. data/docs/LegalEntitiesApi.md +160 -0
  57. data/docs/LegalEntitiesRow.md +2 -2
  58. data/docs/OwnershipPositionsResponse.md +58 -0
  59. data/docs/OwnershipPositionsRow.md +100 -0
  60. data/docs/PdufaDatesRow.md +2 -2
  61. data/docs/SiteCroTrialsRow.md +1 -1
  62. data/docs/SiteTrialConditionsRow.md +1 -1
  63. data/docs/SiteTrialDrugsRow.md +1 -1
  64. data/docs/SiteTrialsRow.md +4 -2
  65. data/docs/SponsorRecruitmentByPhaseRow.md +2 -2
  66. data/docs/SponsorRecruitmentDurationRow.md +1 -1
  67. data/docs/SponsorTrialsRow.md +5 -3
  68. data/docs/TrialAdverseEventsResponse.md +58 -0
  69. data/docs/TrialAdverseEventsRow.md +28 -0
  70. data/docs/TrialChangesResponse.md +58 -0
  71. data/docs/TrialChangesRow.md +36 -0
  72. data/docs/TrialDeliveryResponse.md +58 -0
  73. data/docs/TrialDeliveryRow.md +66 -0
  74. data/docs/TrialDemographicsResponse.md +58 -0
  75. data/docs/TrialDemographicsRow.md +32 -0
  76. data/docs/TrialDrugsResponse.md +58 -0
  77. data/docs/TrialDrugsRow.md +30 -0
  78. data/docs/TrialEnrollmentHistoryResponse.md +58 -0
  79. data/docs/TrialEnrollmentHistoryRow.md +36 -0
  80. data/docs/TrialEnrollmentRateResponse.md +58 -0
  81. data/docs/TrialEnrollmentRateRow.md +60 -0
  82. data/docs/TrialExtractedEndpointsResponse.md +58 -0
  83. data/docs/TrialExtractedEndpointsRow.md +40 -0
  84. data/docs/TrialOutcomeMeasuresResponse.md +58 -0
  85. data/docs/TrialOutcomeMeasuresRow.md +28 -0
  86. data/docs/TrialSitesResponse.md +58 -0
  87. data/docs/TrialSitesRow.md +46 -0
  88. data/docs/TrialsApi.md +1033 -0
  89. data/docs/TrialsRecord.md +38 -0
  90. data/docs/TrialsRecordAttributes.md +24 -0
  91. data/docs/TrialsResponse.md +58 -0
  92. data/docs/TrialsRow.md +116 -0
  93. data/lib/pharmaobservatory/api/biomarkers_api.rb +336 -0
  94. data/lib/pharmaobservatory/api/companies_api.rb +455 -0
  95. data/lib/pharmaobservatory/api/conditions_api.rb +1001 -0
  96. data/lib/pharmaobservatory/api/legal_entities_api.rb +168 -0
  97. data/lib/pharmaobservatory/api/trials_api.rb +1085 -0
  98. data/lib/pharmaobservatory/models/api_v1_whoami_get200_response.rb +62 -4
  99. data/lib/pharmaobservatory/models/api_v1_whoami_get200_response_limits.rb +419 -0
  100. data/lib/pharmaobservatory/models/api_v1_whoami_get200_response_quota.rb +263 -0
  101. data/lib/pharmaobservatory/models/api_v1_whoami_get200_response_quota_buckets.rb +367 -0
  102. data/lib/pharmaobservatory/models/api_v1_whoami_get200_response_quota_buckets_requests_per_minute.rb +367 -0
  103. data/lib/pharmaobservatory/models/biomarker_bqp_assertions_row.rb +1 -1
  104. data/lib/pharmaobservatory/models/biomarker_evidence_row.rb +1 -1
  105. data/lib/pharmaobservatory/models/biomarker_literature_row.rb +1 -1
  106. data/lib/pharmaobservatory/models/biomarker_relations_response.rb +478 -0
  107. data/lib/pharmaobservatory/models/biomarker_relations_row.rb +421 -0
  108. data/lib/pharmaobservatory/models/biomarker_sample_coverage_response.rb +478 -0
  109. data/lib/pharmaobservatory/models/biomarker_sample_coverage_row.rb +322 -0
  110. data/lib/pharmaobservatory/models/biomarker_sample_prevalence_response.rb +478 -0
  111. data/lib/pharmaobservatory/models/biomarker_sample_prevalence_row.rb +436 -0
  112. data/lib/pharmaobservatory/models/biomarker_validation_response.rb +478 -0
  113. data/lib/pharmaobservatory/models/biomarker_validation_row.rb +509 -0
  114. data/lib/pharmaobservatory/models/biomarkers_row.rb +2 -2
  115. data/lib/pharmaobservatory/models/cell_lines_row.rb +1 -1
  116. data/lib/pharmaobservatory/models/companies_record.rb +1 -1
  117. data/lib/pharmaobservatory/models/companies_record_attributes.rb +220 -0
  118. data/lib/pharmaobservatory/models/companies_row.rb +30 -8
  119. data/lib/pharmaobservatory/models/company_assets_response.rb +478 -0
  120. data/lib/pharmaobservatory/models/company_assets_row.rb +355 -0
  121. data/lib/pharmaobservatory/models/company_funding_events_response.rb +478 -0
  122. data/lib/pharmaobservatory/models/company_funding_events_row.rb +465 -0
  123. data/lib/pharmaobservatory/models/company_funding_summary_response.rb +478 -0
  124. data/lib/pharmaobservatory/models/company_funding_summary_row.rb +377 -0
  125. data/lib/pharmaobservatory/models/company_programs_row.rb +2 -2
  126. data/lib/pharmaobservatory/models/condition_adverse_events_response.rb +478 -0
  127. data/lib/pharmaobservatory/models/condition_adverse_events_row.rb +256 -0
  128. data/lib/pharmaobservatory/models/condition_burden_response.rb +478 -0
  129. data/lib/pharmaobservatory/models/condition_burden_row.rb +300 -0
  130. data/lib/pharmaobservatory/models/condition_delivery_response.rb +478 -0
  131. data/lib/pharmaobservatory/models/condition_delivery_row.rb +366 -0
  132. data/lib/pharmaobservatory/models/condition_drugs_response.rb +478 -0
  133. data/lib/pharmaobservatory/models/condition_drugs_row.rb +267 -0
  134. data/lib/pharmaobservatory/models/condition_prevalence_response.rb +478 -0
  135. data/lib/pharmaobservatory/models/condition_prevalence_row.rb +465 -0
  136. data/lib/pharmaobservatory/models/condition_publications_response.rb +478 -0
  137. data/lib/pharmaobservatory/models/condition_publications_row.rb +300 -0
  138. data/lib/pharmaobservatory/models/condition_sites_response.rb +478 -0
  139. data/lib/pharmaobservatory/models/condition_sites_row.rb +278 -0
  140. data/lib/pharmaobservatory/models/condition_trials_response.rb +478 -0
  141. data/lib/pharmaobservatory/models/condition_trials_row.rb +454 -0
  142. data/lib/pharmaobservatory/models/conditions_record.rb +385 -0
  143. data/lib/pharmaobservatory/models/conditions_record_attributes.rb +229 -0
  144. data/lib/pharmaobservatory/models/conditions_response.rb +478 -0
  145. data/lib/pharmaobservatory/models/conditions_row.rb +304 -0
  146. data/lib/pharmaobservatory/models/drug_patent_cliff_row.rb +1 -1
  147. data/lib/pharmaobservatory/models/institutional_holdings_row.rb +13 -2
  148. data/lib/pharmaobservatory/models/legal_entities_row.rb +2 -2
  149. data/lib/pharmaobservatory/models/ownership_positions_response.rb +478 -0
  150. data/lib/pharmaobservatory/models/ownership_positions_row.rb +674 -0
  151. data/lib/pharmaobservatory/models/pdufa_dates_row.rb +2 -2
  152. data/lib/pharmaobservatory/models/site_cro_trials_row.rb +1 -1
  153. data/lib/pharmaobservatory/models/site_trial_conditions_row.rb +1 -1
  154. data/lib/pharmaobservatory/models/site_trial_drugs_row.rb +1 -1
  155. data/lib/pharmaobservatory/models/site_trials_row.rb +14 -3
  156. data/lib/pharmaobservatory/models/sponsor_recruitment_by_phase_row.rb +2 -2
  157. data/lib/pharmaobservatory/models/sponsor_recruitment_duration_row.rb +1 -1
  158. data/lib/pharmaobservatory/models/sponsor_trials_row.rb +15 -4
  159. data/lib/pharmaobservatory/models/trial_adverse_events_response.rb +478 -0
  160. data/lib/pharmaobservatory/models/trial_adverse_events_row.rb +278 -0
  161. data/lib/pharmaobservatory/models/trial_changes_response.rb +478 -0
  162. data/lib/pharmaobservatory/models/trial_changes_row.rb +328 -0
  163. data/lib/pharmaobservatory/models/trial_delivery_response.rb +478 -0
  164. data/lib/pharmaobservatory/models/trial_delivery_row.rb +487 -0
  165. data/lib/pharmaobservatory/models/trial_demographics_response.rb +478 -0
  166. data/lib/pharmaobservatory/models/trial_demographics_row.rb +300 -0
  167. data/lib/pharmaobservatory/models/trial_drugs_response.rb +478 -0
  168. data/lib/pharmaobservatory/models/trial_drugs_row.rb +291 -0
  169. data/lib/pharmaobservatory/models/trial_enrollment_history_response.rb +478 -0
  170. data/lib/pharmaobservatory/models/trial_enrollment_history_row.rb +322 -0
  171. data/lib/pharmaobservatory/models/trial_enrollment_rate_response.rb +478 -0
  172. data/lib/pharmaobservatory/models/trial_enrollment_rate_row.rb +454 -0
  173. data/lib/pharmaobservatory/models/trial_extracted_endpoints_response.rb +478 -0
  174. data/lib/pharmaobservatory/models/trial_extracted_endpoints_row.rb +346 -0
  175. data/lib/pharmaobservatory/models/trial_outcome_measures_response.rb +478 -0
  176. data/lib/pharmaobservatory/models/trial_outcome_measures_row.rb +278 -0
  177. data/lib/pharmaobservatory/models/trial_sites_response.rb +478 -0
  178. data/lib/pharmaobservatory/models/trial_sites_row.rb +377 -0
  179. data/lib/pharmaobservatory/models/trials_record.rb +385 -0
  180. data/lib/pharmaobservatory/models/trials_record_attributes.rb +247 -0
  181. data/lib/pharmaobservatory/models/trials_response.rb +478 -0
  182. data/lib/pharmaobservatory/models/trials_row.rb +784 -0
  183. data/lib/pharmaobservatory/version.rb +1 -1
  184. data/lib/pharmaobservatory.rb +67 -0
  185. metadata +136 -2
@@ -4,7 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **trial_id** | **String** | The trial's registry id (NCT number). | [optional] |
7
+ | **trial_id** | **String** | The trial's ClinicalTrials.gov registry id (NCT, National Clinical Trial, number). | [optional] |
8
8
  | **sponsor_role** | **String** | lead or collaborator. | [optional] |
9
9
  | **sponsor_name** | **String** | The sponsor name as filed. | [optional] |
10
10
  | **sponsor_org_id** | **String** | Legal-entity level: the organization record the sponsor resolved to (null when unresolved). | [optional] |
@@ -12,11 +12,12 @@
12
12
  | **sponsor_company_name** | **String** | Display name of the sponsor's company. | [optional] |
13
13
  | **sponsor_group_id** | **String** | Group level: the sponsor's current ultimate parent company; a root company's group is itself. | [optional] |
14
14
  | **sponsor_group_name** | **String** | Display name of the sponsor's group. | [optional] |
15
- | **sponsor_agency_class** | **String** | The registry's agency class for the sponsor (INDUSTRY, NIH, OTHER ...). | [optional] |
15
+ | **sponsor_agency_class** | **String** | The funder class the registry declared for the sponsor (INDUSTRY, NIH, FED, OTHER_GOV, NETWORK, OTHER, INDIV, AMBIG, UNKNOWN). UNKNOWN is the registry's own code for a class it does not state. | [optional] |
16
16
  | **sponsor_resolution_method** | **String** | How the sponsor name was resolved to an organization record. | [optional] |
17
17
  | **trial_title** | **String** | The trial's brief title. | [optional] |
18
18
  | **study_type** | **String** | INTERVENTIONAL or OBSERVATIONAL. | [optional] |
19
- | **phase** | **String** | The trial phase label. | [optional] |
19
+ | **phase** | **String** | The registry's phase code (PHASE1, PHASE2, PHASE2/PHASE3, NA and so on). Null when the registry gives no phase (observational and expanded-access trials); phase_label carries the display label for those. | [optional] |
20
+ | **phase_label** | **String** | The trial phase as a display label (Phase 2, Phase 3, Observational, Not applicable, Expanded access, Unknown). The same trial's phase column holds the registry code. | [optional] |
20
21
  | **overall_status** | **String** | The registry's overall status. | [optional] |
21
22
  | **start_date** | **Date** | Trial start date. | [optional] |
22
23
  | **start_year** | **Integer** | Year of the trial start. | [optional] |
@@ -45,6 +46,7 @@ instance = PharmaObservatory::SponsorTrialsRow.new(
45
46
  trial_title: null,
46
47
  study_type: null,
47
48
  phase: null,
49
+ phase_label: null,
48
50
  overall_status: null,
49
51
  start_date: null,
50
52
  start_year: null,
@@ -0,0 +1,58 @@
1
+ # PharmaObservatory::TrialAdverseEventsResponse
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<TrialAdverseEventsRow>**](TrialAdverseEventsRow.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::TrialAdverseEventsResponse.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,28 @@
1
+ # PharmaObservatory::TrialAdverseEventsRow
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
+ | **event_type** | **String** | serious or other. | [optional] |
9
+ | **organ_system** | **String** | The organ system class, as filed ((unspecified) where the filing gives none). | [optional] |
10
+ | **adverse_event_term** | **String** | The adverse event term, as filed. | [optional] |
11
+ | **subjects_affected** | **Integer** | Participants affected, summed over the trial's groups. | [optional] |
12
+ | **subjects_at_risk** | **Integer** | Participants at risk, summed over the trial's groups. | [optional] |
13
+
14
+ ## Example
15
+
16
+ ```ruby
17
+ require 'pharmaobservatory'
18
+
19
+ instance = PharmaObservatory::TrialAdverseEventsRow.new(
20
+ trial_id: null,
21
+ event_type: null,
22
+ organ_system: null,
23
+ adverse_event_term: null,
24
+ subjects_affected: null,
25
+ subjects_at_risk: null
26
+ )
27
+ ```
28
+
@@ -0,0 +1,58 @@
1
+ # PharmaObservatory::TrialChangesResponse
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<TrialChangesRow>**](TrialChangesRow.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::TrialChangesResponse.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::TrialChangesRow
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
+ | **observed_at** | **Time** | When the platform observed the change. | [optional] |
9
+ | **event_type** | **String** | The kind of event (first_seen, status_change and so on). | [optional] |
10
+ | **field** | **String** | The record field that changed (null for a first_seen event). | [optional] |
11
+ | **old_value** | **String** | The value before the change. | [optional] |
12
+ | **new_value** | **String** | The value after the change. | [optional] |
13
+ | **trial_title** | **String** | The trial's brief title. | [optional] |
14
+ | **condition_ids** | **Array<String>** | MeSH (Medical Subject Headings) condition ids the trial is linked to, direct and through the MeSH tree. Filter on one id to scope changes to a condition's trials. | [optional] |
15
+ | **drug_ids** | **Array<String>** | Drug ids the trial's interventions resolved to. Filter on one id to scope changes to a drug's trials. | [optional] |
16
+ | **sponsor_org_ids** | **Array<String>** | Organization record ids of the sponsors on the trial, lead and collaborator. Filter on one id to scope changes to a sponsor's trials. | [optional] |
17
+
18
+ ## Example
19
+
20
+ ```ruby
21
+ require 'pharmaobservatory'
22
+
23
+ instance = PharmaObservatory::TrialChangesRow.new(
24
+ trial_id: null,
25
+ observed_at: null,
26
+ event_type: null,
27
+ field: null,
28
+ old_value: null,
29
+ new_value: null,
30
+ trial_title: null,
31
+ condition_ids: null,
32
+ drug_ids: null,
33
+ sponsor_org_ids: null
34
+ )
35
+ ```
36
+
@@ -0,0 +1,58 @@
1
+ # PharmaObservatory::TrialDeliveryResponse
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<TrialDeliveryRow>**](TrialDeliveryRow.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::TrialDeliveryResponse.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,66 @@
1
+ # PharmaObservatory::TrialDeliveryRow
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
+ | **lead_sponsor_name** | **String** | The lead sponsor name as filed. | [optional] |
9
+ | **overall_status_summary** | **String** | A coarse status label (Recruiting, Completed and so on). | [optional] |
10
+ | **study_type** | **String** | INTERVENTIONAL, OBSERVATIONAL or EXPANDED_ACCESS. | [optional] |
11
+ | **phase** | **String** | The registry's phase code (PHASE1, PHASE2, PHASE2/PHASE3, NA and so on). Null when the registry gives no phase (observational and expanded-access trials); phase_label carries the display label for those. | [optional] |
12
+ | **phase_label** | **String** | The trial phase as a display label (Phase 2, Phase 3, Observational, Not applicable, Expanded access, Unknown). The same trial's phase column holds the registry code. | [optional] |
13
+ | **planned_enrollment** | **Integer** | Planned enrollment from the earliest snapshot typed ESTIMATED. | [optional] |
14
+ | **actual_enrollment** | **Integer** | Enrollment from the latest observation typed ACTUAL. | [optional] |
15
+ | **enrollment_type** | **String** | Enrollment type on the current record (ACTUAL or ESTIMATED). | [optional] |
16
+ | **enrollment_delta** | **Integer** | Actual minus planned enrollment (null without both). | [optional] |
17
+ | **enrollment_attainment_pct** | **Float** | Actual as a percentage of planned enrollment (null without both). | [optional] |
18
+ | **enrollment_met** | **Boolean** | Whether actual enrollment reached the plan (null without both). | [optional] |
19
+ | **enrollment_delta_known** | **Boolean** | Whether a planned and an actual enrollment are both recorded. | [optional] |
20
+ | **planned_basis** | **String** | Where the planned enrollment came from: history_earliest_estimated, type_estimated_current or none. | [optional] |
21
+ | **actual_basis** | **String** | How the actual enrollment was taken (from the snapshot history, from the current record, or none). | [optional] |
22
+ | **planned_primary_completion_date** | **Date** | Planned primary completion date from the earliest snapshot typed ESTIMATED. | [optional] |
23
+ | **actual_primary_completion_date** | **Date** | Primary completion date once typed ACTUAL. | [optional] |
24
+ | **planned_completion_date** | **Date** | Planned completion date from the earliest snapshot typed ESTIMATED. | [optional] |
25
+ | **actual_completion_date** | **Date** | Completion date once typed ACTUAL. | [optional] |
26
+ | **primary_completion_date_type** | **String** | ACTUAL (a date that has occurred) or ESTIMATED (a planned date). The registry's older ANTICIPATED is published as ESTIMATED. | [optional] |
27
+ | **completion_date_type** | **String** | ACTUAL (a date that has occurred) or ESTIMATED (a planned date). The registry's older ANTICIPATED is published as ESTIMATED. | [optional] |
28
+ | **primary_completion_slip_days** | **Integer** | Actual minus planned primary completion date; positive is later than planned (null without both). | [optional] |
29
+ | **completion_slip_days** | **Integer** | Actual minus planned completion date; positive is later than planned (null without both). | [optional] |
30
+ | **completion_slipped** | **Boolean** | Whether the primary completion came later than planned (null without both). | [optional] |
31
+ | **has_completion_delta** | **Boolean** | Whether a planned and an actual primary completion date are both recorded. | [optional] |
32
+
33
+ ## Example
34
+
35
+ ```ruby
36
+ require 'pharmaobservatory'
37
+
38
+ instance = PharmaObservatory::TrialDeliveryRow.new(
39
+ trial_id: null,
40
+ lead_sponsor_name: null,
41
+ overall_status_summary: null,
42
+ study_type: null,
43
+ phase: null,
44
+ phase_label: null,
45
+ planned_enrollment: null,
46
+ actual_enrollment: null,
47
+ enrollment_type: null,
48
+ enrollment_delta: null,
49
+ enrollment_attainment_pct: null,
50
+ enrollment_met: null,
51
+ enrollment_delta_known: null,
52
+ planned_basis: null,
53
+ actual_basis: null,
54
+ planned_primary_completion_date: null,
55
+ actual_primary_completion_date: null,
56
+ planned_completion_date: null,
57
+ actual_completion_date: null,
58
+ primary_completion_date_type: null,
59
+ completion_date_type: null,
60
+ primary_completion_slip_days: null,
61
+ completion_slip_days: null,
62
+ completion_slipped: null,
63
+ has_completion_delta: null
64
+ )
65
+ ```
66
+
@@ -0,0 +1,58 @@
1
+ # PharmaObservatory::TrialDemographicsResponse
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<TrialDemographicsRow>**](TrialDemographicsRow.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::TrialDemographicsResponse.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,32 @@
1
+ # PharmaObservatory::TrialDemographicsRow
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
+ | **has_sex_data** | **Boolean** | Whether a sex baseline breakdown was posted. | [optional] |
9
+ | **has_race_data** | **Boolean** | Whether a race baseline breakdown was posted. | [optional] |
10
+ | **has_ethnicity_data** | **Boolean** | Whether an ethnicity baseline breakdown was posted. | [optional] |
11
+ | **has_age_data** | **Boolean** | Whether a categorical age baseline breakdown was posted. | [optional] |
12
+ | **pct_female** | **Float** | Percent of baseline participants recorded as female (null when sex was not posted). | [optional] |
13
+ | **race_breakdown** | **String** | A JSON object of race category to percent of baseline participants, as posted. | [optional] |
14
+ | **n_analyzed** | **Integer** | Baseline participants analyzed. | [optional] |
15
+
16
+ ## Example
17
+
18
+ ```ruby
19
+ require 'pharmaobservatory'
20
+
21
+ instance = PharmaObservatory::TrialDemographicsRow.new(
22
+ trial_id: null,
23
+ has_sex_data: null,
24
+ has_race_data: null,
25
+ has_ethnicity_data: null,
26
+ has_age_data: null,
27
+ pct_female: null,
28
+ race_breakdown: null,
29
+ n_analyzed: null
30
+ )
31
+ ```
32
+
@@ -0,0 +1,58 @@
1
+ # PharmaObservatory::TrialDrugsResponse
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<TrialDrugsRow>**](TrialDrugsRow.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::TrialDrugsResponse.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,30 @@
1
+ # PharmaObservatory::TrialDrugsRow
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
+ | **drug_key** | **String** | The molecule key, or the drug name as registered prefixed unresolved: for a drug that reached no molecule. | [optional] |
9
+ | **molecule_id** | **String** | The molecule key the drugs resolved to (null for a drug with no molecule). | [optional] |
10
+ | **molecule_name** | **String** | The molecule's display name (null for a drug with no molecule). | [optional] |
11
+ | **registered_as** | **Array<String>** | The drug names as registered on the trial that led to this row. | [optional] |
12
+ | **matched_from_name_part** | **Boolean** | Whether every match to the molecule came from one part of a multi-part drug name. | [optional] |
13
+ | **brand_count** | **Integer** | Number of brand names recorded for the molecule. | [optional] |
14
+
15
+ ## Example
16
+
17
+ ```ruby
18
+ require 'pharmaobservatory'
19
+
20
+ instance = PharmaObservatory::TrialDrugsRow.new(
21
+ trial_id: null,
22
+ drug_key: null,
23
+ molecule_id: null,
24
+ molecule_name: null,
25
+ registered_as: null,
26
+ matched_from_name_part: null,
27
+ brand_count: null
28
+ )
29
+ ```
30
+
@@ -0,0 +1,58 @@
1
+ # PharmaObservatory::TrialEnrollmentHistoryResponse
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<TrialEnrollmentHistoryRow>**](TrialEnrollmentHistoryRow.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::TrialEnrollmentHistoryResponse.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::TrialEnrollmentHistoryRow
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
+ | **as_of** | **Date** | The registry snapshot date this row describes. | [optional] |
9
+ | **enrollment** | **Integer** | Enrollment registered at the snapshot (a planned target or an achieved count, see enrollment_type). | [optional] |
10
+ | **enrollment_type** | **String** | ACTUAL or ESTIMATED at the snapshot. | [optional] |
11
+ | **overall_status** | **String** | The trial's overall status code at the snapshot. | [optional] |
12
+ | **start_date** | **Date** | Start date at the snapshot. | [optional] |
13
+ | **primary_completion_date** | **Date** | Primary completion date at the snapshot. | [optional] |
14
+ | **completion_date** | **Date** | Completion date at the snapshot. | [optional] |
15
+ | **enrollment_is_plausible** | **Boolean** | False when the registered enrollment is a placeholder value rather than a count. | [optional] |
16
+ | **enrollment_flag_reason** | **String** | Why the enrollment was marked a placeholder (null when it was not). | [optional] |
17
+
18
+ ## Example
19
+
20
+ ```ruby
21
+ require 'pharmaobservatory'
22
+
23
+ instance = PharmaObservatory::TrialEnrollmentHistoryRow.new(
24
+ trial_id: null,
25
+ as_of: null,
26
+ enrollment: null,
27
+ enrollment_type: null,
28
+ overall_status: null,
29
+ start_date: null,
30
+ primary_completion_date: null,
31
+ completion_date: null,
32
+ enrollment_is_plausible: null,
33
+ enrollment_flag_reason: null
34
+ )
35
+ ```
36
+