pharmaobservatory 0.1.6 → 0.1.7

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 (357) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +269 -4
  3. data/docs/BrandCompaniesResponse.md +58 -0
  4. data/docs/BrandCompaniesRow.md +50 -0
  5. data/docs/BrandRevenueResponse.md +58 -0
  6. data/docs/BrandRevenueRow.md +60 -0
  7. data/docs/CatalystsResponse.md +58 -0
  8. data/docs/CatalystsRow.md +90 -0
  9. data/docs/CliaCertificatesResponse.md +58 -0
  10. data/docs/CliaCertificatesRow.md +80 -0
  11. data/docs/CompaniesApi.md +1675 -117
  12. data/docs/CompaniesRecordAttributes.md +3 -1
  13. data/docs/CompanyFundingEventsRow.md +2 -0
  14. data/docs/CompanyTrialGeographyResponse.md +58 -0
  15. data/docs/CompanyTrialGeographyRow.md +52 -0
  16. data/docs/CompanyTrialSitesResponse.md +58 -0
  17. data/docs/CompanyTrialSitesRow.md +52 -0
  18. data/docs/ConditionsApi.md +320 -0
  19. data/docs/CroFootprintResponse.md +58 -0
  20. data/docs/CroFootprintRow.md +34 -0
  21. data/docs/CroTrialsResponse.md +58 -0
  22. data/docs/CroTrialsRow.md +46 -0
  23. data/docs/DebarmentsResponse.md +58 -0
  24. data/docs/DebarmentsRow.md +44 -0
  25. data/docs/DrugApprovalsResponse.md +58 -0
  26. data/docs/DrugApprovalsRow.md +28 -0
  27. data/docs/DrugAspCodesResponse.md +58 -0
  28. data/docs/DrugAspCodesRow.md +28 -0
  29. data/docs/DrugBrandsResponse.md +58 -0
  30. data/docs/DrugBrandsRow.md +60 -0
  31. data/docs/DrugCombinationsResponse.md +58 -0
  32. data/docs/DrugCombinationsRow.md +32 -0
  33. data/docs/DrugDeclaredPatentsResponse.md +58 -0
  34. data/docs/DrugDeclaredPatentsRow.md +58 -0
  35. data/docs/DrugLabelSafetyResponse.md +58 -0
  36. data/docs/DrugLabelSafetyRow.md +32 -0
  37. data/docs/DrugMedicareSpendResponse.md +58 -0
  38. data/docs/DrugMedicareSpendRow.md +28 -0
  39. data/docs/DrugPatentCliffRow.md +3 -1
  40. data/docs/DrugPatentMentionsResponse.md +58 -0
  41. data/docs/DrugPatentMentionsRow.md +28 -0
  42. data/docs/DrugPatentOwnersResponse.md +58 -0
  43. data/docs/DrugPatentOwnersRow.md +42 -0
  44. data/docs/DrugPricingResponse.md +58 -0
  45. data/docs/DrugPricingRow.md +32 -0
  46. data/docs/DrugRecallsResponse.md +58 -0
  47. data/docs/DrugRecallsRow.md +34 -0
  48. data/docs/DrugRegulatoryResponse.md +58 -0
  49. data/docs/DrugRegulatoryRow.md +38 -0
  50. data/docs/DrugSitesResponse.md +58 -0
  51. data/docs/DrugSitesRow.md +28 -0
  52. data/docs/DrugTargetsResponse.md +58 -0
  53. data/docs/DrugTargetsRow.md +36 -0
  54. data/docs/DrugTrialConditionsResponse.md +58 -0
  55. data/docs/DrugTrialConditionsRow.md +30 -0
  56. data/docs/DrugTrialsResponse.md +58 -0
  57. data/docs/DrugTrialsRow.md +58 -0
  58. data/docs/DrugVariantsResponse.md +58 -0
  59. data/docs/DrugVariantsRow.md +38 -0
  60. data/docs/DrugsApi.md +2153 -0
  61. data/docs/DrugsRecord.md +38 -0
  62. data/docs/DrugsRecordAttributes.md +20 -0
  63. data/docs/DrugsResponse.md +58 -0
  64. data/docs/DrugsRow.md +82 -0
  65. data/docs/EnforcementEventsResponse.md +58 -0
  66. data/docs/EnforcementEventsRow.md +64 -0
  67. data/docs/GxpFacilitiesResponse.md +58 -0
  68. data/docs/GxpFacilitiesRow.md +152 -0
  69. data/docs/HospitalBedsYearlyResponse.md +58 -0
  70. data/docs/HospitalBedsYearlyRow.md +28 -0
  71. data/docs/HospitalFacilityChangesResponse.md +58 -0
  72. data/docs/HospitalFacilityChangesRow.md +30 -0
  73. data/docs/HospitalsApi.md +393 -0
  74. data/docs/HospitalsRecord.md +38 -0
  75. data/docs/HospitalsResponse.md +58 -0
  76. data/docs/HospitalsRow.md +40 -0
  77. data/docs/ImportRefusalsResponse.md +58 -0
  78. data/docs/ImportRefusalsRow.md +60 -0
  79. data/docs/InspectionFindingsResponse.md +58 -0
  80. data/docs/InspectionFindingsRow.md +48 -0
  81. data/docs/InspectionsResponse.md +58 -0
  82. data/docs/InspectionsRow.md +60 -0
  83. data/docs/InstitutionalQuarterTotalsResponse.md +58 -0
  84. data/docs/InstitutionalQuarterTotalsRow.md +58 -0
  85. data/docs/LegalEntitiesApi.md +1379 -179
  86. data/docs/LegalEntitiesRecordAttributes.md +2 -0
  87. data/docs/OrgRelationshipsRow.md +1 -1
  88. data/docs/OwnershipPercentagesResponse.md +58 -0
  89. data/docs/OwnershipPercentagesRow.md +74 -0
  90. data/docs/PdufaDatesRow.md +1 -1
  91. data/docs/ProgramLicensingCandidatesResponse.md +58 -0
  92. data/docs/ProgramLicensingCandidatesRow.md +58 -0
  93. data/docs/ProgramsResponse.md +58 -0
  94. data/docs/ProgramsRow.md +46 -0
  95. data/docs/RareDiseaseGenesResponse.md +58 -0
  96. data/docs/RareDiseaseGenesRow.md +50 -0
  97. data/docs/RareDiseaseHierarchyResponse.md +58 -0
  98. data/docs/RareDiseaseHierarchyRow.md +40 -0
  99. data/docs/RareDiseaseInvestigatorCoverageResponse.md +58 -0
  100. data/docs/RareDiseaseInvestigatorCoverageRow.md +38 -0
  101. data/docs/RareDiseaseInvestigatorsResponse.md +58 -0
  102. data/docs/RareDiseaseInvestigatorsRow.md +56 -0
  103. data/docs/RareDiseaseMappingsResponse.md +58 -0
  104. data/docs/RareDiseaseMappingsRow.md +44 -0
  105. data/docs/RareDiseaseOrganizationsResponse.md +58 -0
  106. data/docs/RareDiseaseOrganizationsRow.md +60 -0
  107. data/docs/RareDiseasePrevalenceResponse.md +58 -0
  108. data/docs/RareDiseasePrevalenceRow.md +62 -0
  109. data/docs/RareDiseaseRarityEvidenceResponse.md +58 -0
  110. data/docs/RareDiseaseRarityEvidenceRow.md +36 -0
  111. data/docs/RareDiseaseRarityResponse.md +58 -0
  112. data/docs/RareDiseaseRarityRow.md +54 -0
  113. data/docs/RareDiseaseReplacementsResponse.md +58 -0
  114. data/docs/RareDiseaseReplacementsRow.md +40 -0
  115. data/docs/RareDiseaseSiteCoverageResponse.md +58 -0
  116. data/docs/RareDiseaseSiteCoverageRow.md +54 -0
  117. data/docs/RareDiseaseSponsorsResponse.md +58 -0
  118. data/docs/RareDiseaseSponsorsRow.md +82 -0
  119. data/docs/RareDiseaseTrialCoverageResponse.md +58 -0
  120. data/docs/RareDiseaseTrialCoverageRow.md +58 -0
  121. data/docs/RareDiseaseTrialSitesResponse.md +58 -0
  122. data/docs/RareDiseaseTrialSitesRow.md +52 -0
  123. data/docs/RareDiseaseTrialsResponse.md +58 -0
  124. data/docs/RareDiseaseTrialsRow.md +90 -0
  125. data/docs/RareDiseasesApi.md +1353 -0
  126. data/docs/RareDiseasesRecord.md +38 -0
  127. data/docs/RareDiseasesRecordAttributes.md +22 -0
  128. data/docs/RareDiseasesResponse.md +58 -0
  129. data/docs/RareDiseasesRow.md +68 -0
  130. data/docs/RecallsResponse.md +58 -0
  131. data/docs/RecallsRow.md +54 -0
  132. data/docs/RwdCoverageResponse.md +58 -0
  133. data/docs/RwdCoverageRow.md +52 -0
  134. data/docs/RwdRegisterProvenanceResponse.md +58 -0
  135. data/docs/RwdRegisterProvenanceRow.md +74 -0
  136. data/docs/RwdRegistersApi.md +313 -0
  137. data/docs/RwdRegistersRecord.md +38 -0
  138. data/docs/RwdSourceAgeBandsResponse.md +58 -0
  139. data/docs/RwdSourceAgeBandsRow.md +40 -0
  140. data/docs/RwdSourceConditionsResponse.md +58 -0
  141. data/docs/RwdSourceConditionsRow.md +68 -0
  142. data/docs/RwdSourceEtlMappingsResponse.md +58 -0
  143. data/docs/RwdSourceEtlMappingsRow.md +44 -0
  144. data/docs/RwdSourceLinkagesResponse.md +58 -0
  145. data/docs/RwdSourceLinkagesRow.md +64 -0
  146. data/docs/RwdSourceTypesResponse.md +58 -0
  147. data/docs/RwdSourceTypesRow.md +34 -0
  148. data/docs/RwdSourceVocabulariesResponse.md +58 -0
  149. data/docs/RwdSourceVocabulariesRow.md +42 -0
  150. data/docs/RwdSourcesApi.md +713 -0
  151. data/docs/RwdSourcesRecord.md +38 -0
  152. data/docs/RwdSourcesResponse.md +58 -0
  153. data/docs/RwdSourcesRow.md +280 -0
  154. data/docs/RwdStudiesApi.md +473 -0
  155. data/docs/RwdStudiesRecord.md +38 -0
  156. data/docs/RwdStudiesResponse.md +58 -0
  157. data/docs/RwdStudiesRow.md +180 -0
  158. data/docs/RwdStudyConditionsResponse.md +58 -0
  159. data/docs/RwdStudyConditionsRow.md +54 -0
  160. data/docs/RwdStudyDataSourcesResponse.md +58 -0
  161. data/docs/RwdStudyDataSourcesRow.md +54 -0
  162. data/docs/RwdStudyDrugsResponse.md +58 -0
  163. data/docs/RwdStudyDrugsRow.md +50 -0
  164. data/docs/RwdStudyMilestonesResponse.md +58 -0
  165. data/docs/RwdStudyMilestonesRow.md +54 -0
  166. data/docs/RwdWithheldFieldsResponse.md +58 -0
  167. data/docs/RwdWithheldFieldsRow.md +36 -0
  168. data/docs/SecPdufaDatesResponse.md +58 -0
  169. data/docs/SecPdufaDatesRow.md +64 -0
  170. data/docs/TrialChangesRow.md +5 -1
  171. data/docs/TrialsApi.md +80 -0
  172. data/docs/TrialsRow.md +9 -1
  173. data/docs/UnmatchedProductRevenueResponse.md +58 -0
  174. data/docs/UnmatchedProductRevenueRow.md +80 -0
  175. data/docs/UntitledLettersResponse.md +58 -0
  176. data/docs/UntitledLettersRow.md +44 -0
  177. data/docs/WarningLettersResponse.md +58 -0
  178. data/docs/WarningLettersRow.md +50 -0
  179. data/lib/pharmaobservatory/api/companies_api.rb +1936 -207
  180. data/lib/pharmaobservatory/api/conditions_api.rb +336 -0
  181. data/lib/pharmaobservatory/api/drugs_api.rb +2261 -0
  182. data/lib/pharmaobservatory/api/hospitals_api.rb +413 -0
  183. data/lib/pharmaobservatory/api/legal_entities_api.rb +1442 -182
  184. data/lib/pharmaobservatory/api/rare_diseases_api.rb +1421 -0
  185. data/lib/pharmaobservatory/api/rwd_registers_api.rb +329 -0
  186. data/lib/pharmaobservatory/api/rwd_sources_api.rb +749 -0
  187. data/lib/pharmaobservatory/api/rwd_studies_api.rb +497 -0
  188. data/lib/pharmaobservatory/api/trials_api.rb +84 -0
  189. data/lib/pharmaobservatory/models/brand_companies_response.rb +478 -0
  190. data/lib/pharmaobservatory/models/brand_companies_row.rb +401 -0
  191. data/lib/pharmaobservatory/models/brand_revenue_response.rb +478 -0
  192. data/lib/pharmaobservatory/models/brand_revenue_row.rb +454 -0
  193. data/lib/pharmaobservatory/models/catalysts_response.rb +478 -0
  194. data/lib/pharmaobservatory/models/catalysts_row.rb +623 -0
  195. data/lib/pharmaobservatory/models/clia_certificates_response.rb +478 -0
  196. data/lib/pharmaobservatory/models/clia_certificates_row.rb +568 -0
  197. data/lib/pharmaobservatory/models/companies_record_attributes.rb +13 -4
  198. data/lib/pharmaobservatory/models/company_funding_events_row.rb +12 -1
  199. data/lib/pharmaobservatory/models/company_trial_geography_response.rb +478 -0
  200. data/lib/pharmaobservatory/models/company_trial_geography_row.rb +410 -0
  201. data/lib/pharmaobservatory/models/company_trial_sites_response.rb +478 -0
  202. data/lib/pharmaobservatory/models/company_trial_sites_row.rb +410 -0
  203. data/lib/pharmaobservatory/models/cro_footprint_response.rb +478 -0
  204. data/lib/pharmaobservatory/models/cro_footprint_row.rb +311 -0
  205. data/lib/pharmaobservatory/models/cro_trials_response.rb +478 -0
  206. data/lib/pharmaobservatory/models/cro_trials_row.rb +381 -0
  207. data/lib/pharmaobservatory/models/debarments_response.rb +478 -0
  208. data/lib/pharmaobservatory/models/debarments_row.rb +366 -0
  209. data/lib/pharmaobservatory/models/drug_approvals_response.rb +478 -0
  210. data/lib/pharmaobservatory/models/drug_approvals_row.rb +278 -0
  211. data/lib/pharmaobservatory/models/drug_asp_codes_response.rb +478 -0
  212. data/lib/pharmaobservatory/models/drug_asp_codes_row.rb +278 -0
  213. data/lib/pharmaobservatory/models/drug_brands_response.rb +478 -0
  214. data/lib/pharmaobservatory/models/drug_brands_row.rb +454 -0
  215. data/lib/pharmaobservatory/models/drug_combinations_response.rb +478 -0
  216. data/lib/pharmaobservatory/models/drug_combinations_row.rb +300 -0
  217. data/lib/pharmaobservatory/models/drug_declared_patents_response.rb +478 -0
  218. data/lib/pharmaobservatory/models/drug_declared_patents_row.rb +447 -0
  219. data/lib/pharmaobservatory/models/drug_label_safety_response.rb +478 -0
  220. data/lib/pharmaobservatory/models/drug_label_safety_row.rb +300 -0
  221. data/lib/pharmaobservatory/models/drug_medicare_spend_response.rb +478 -0
  222. data/lib/pharmaobservatory/models/drug_medicare_spend_row.rb +280 -0
  223. data/lib/pharmaobservatory/models/drug_patent_cliff_row.rb +13 -2
  224. data/lib/pharmaobservatory/models/drug_patent_mentions_response.rb +478 -0
  225. data/lib/pharmaobservatory/models/drug_patent_mentions_row.rb +278 -0
  226. data/lib/pharmaobservatory/models/drug_patent_owners_response.rb +478 -0
  227. data/lib/pharmaobservatory/models/drug_patent_owners_row.rb +357 -0
  228. data/lib/pharmaobservatory/models/drug_pricing_response.rb +478 -0
  229. data/lib/pharmaobservatory/models/drug_pricing_row.rb +300 -0
  230. data/lib/pharmaobservatory/models/drug_recalls_response.rb +478 -0
  231. data/lib/pharmaobservatory/models/drug_recalls_row.rb +311 -0
  232. data/lib/pharmaobservatory/models/drug_regulatory_response.rb +478 -0
  233. data/lib/pharmaobservatory/models/drug_regulatory_row.rb +333 -0
  234. data/lib/pharmaobservatory/models/drug_sites_response.rb +478 -0
  235. data/lib/pharmaobservatory/models/drug_sites_row.rb +278 -0
  236. data/lib/pharmaobservatory/models/drug_targets_response.rb +478 -0
  237. data/lib/pharmaobservatory/models/drug_targets_row.rb +324 -0
  238. data/lib/pharmaobservatory/models/drug_trial_conditions_response.rb +478 -0
  239. data/lib/pharmaobservatory/models/drug_trial_conditions_row.rb +289 -0
  240. data/lib/pharmaobservatory/models/drug_trials_response.rb +478 -0
  241. data/lib/pharmaobservatory/models/drug_trials_row.rb +445 -0
  242. data/lib/pharmaobservatory/models/drug_variants_response.rb +478 -0
  243. data/lib/pharmaobservatory/models/drug_variants_row.rb +333 -0
  244. data/lib/pharmaobservatory/models/drugs_record.rb +385 -0
  245. data/lib/pharmaobservatory/models/drugs_record_attributes.rb +229 -0
  246. data/lib/pharmaobservatory/models/drugs_response.rb +478 -0
  247. data/lib/pharmaobservatory/models/drugs_row.rb +581 -0
  248. data/lib/pharmaobservatory/models/enforcement_events_response.rb +478 -0
  249. data/lib/pharmaobservatory/models/enforcement_events_row.rb +476 -0
  250. data/lib/pharmaobservatory/models/gxp_facilities_response.rb +478 -0
  251. data/lib/pharmaobservatory/models/gxp_facilities_row.rb +968 -0
  252. data/lib/pharmaobservatory/models/hospital_beds_yearly_response.rb +478 -0
  253. data/lib/pharmaobservatory/models/hospital_beds_yearly_row.rb +278 -0
  254. data/lib/pharmaobservatory/models/hospital_facility_changes_response.rb +478 -0
  255. data/lib/pharmaobservatory/models/hospital_facility_changes_row.rb +289 -0
  256. data/lib/pharmaobservatory/models/hospitals_record.rb +385 -0
  257. data/lib/pharmaobservatory/models/hospitals_response.rb +478 -0
  258. data/lib/pharmaobservatory/models/hospitals_row.rb +344 -0
  259. data/lib/pharmaobservatory/models/import_refusals_response.rb +478 -0
  260. data/lib/pharmaobservatory/models/import_refusals_row.rb +454 -0
  261. data/lib/pharmaobservatory/models/inspection_findings_response.rb +478 -0
  262. data/lib/pharmaobservatory/models/inspection_findings_row.rb +388 -0
  263. data/lib/pharmaobservatory/models/inspections_response.rb +478 -0
  264. data/lib/pharmaobservatory/models/inspections_row.rb +454 -0
  265. data/lib/pharmaobservatory/models/institutional_quarter_totals_response.rb +478 -0
  266. data/lib/pharmaobservatory/models/institutional_quarter_totals_row.rb +443 -0
  267. data/lib/pharmaobservatory/models/legal_entities_record_attributes.rb +10 -1
  268. data/lib/pharmaobservatory/models/org_relationships_row.rb +1 -1
  269. data/lib/pharmaobservatory/models/ownership_percentages_response.rb +478 -0
  270. data/lib/pharmaobservatory/models/ownership_percentages_row.rb +531 -0
  271. data/lib/pharmaobservatory/models/pdufa_dates_row.rb +1 -1
  272. data/lib/pharmaobservatory/models/program_licensing_candidates_response.rb +478 -0
  273. data/lib/pharmaobservatory/models/program_licensing_candidates_row.rb +445 -0
  274. data/lib/pharmaobservatory/models/programs_response.rb +478 -0
  275. data/lib/pharmaobservatory/models/programs_row.rb +377 -0
  276. data/lib/pharmaobservatory/models/rare_disease_genes_response.rb +478 -0
  277. data/lib/pharmaobservatory/models/rare_disease_genes_row.rb +399 -0
  278. data/lib/pharmaobservatory/models/rare_disease_hierarchy_response.rb +478 -0
  279. data/lib/pharmaobservatory/models/rare_disease_hierarchy_row.rb +344 -0
  280. data/lib/pharmaobservatory/models/rare_disease_investigator_coverage_response.rb +478 -0
  281. data/lib/pharmaobservatory/models/rare_disease_investigator_coverage_row.rb +333 -0
  282. data/lib/pharmaobservatory/models/rare_disease_investigators_response.rb +478 -0
  283. data/lib/pharmaobservatory/models/rare_disease_investigators_row.rb +436 -0
  284. data/lib/pharmaobservatory/models/rare_disease_mappings_response.rb +478 -0
  285. data/lib/pharmaobservatory/models/rare_disease_mappings_row.rb +366 -0
  286. data/lib/pharmaobservatory/models/rare_disease_organizations_response.rb +478 -0
  287. data/lib/pharmaobservatory/models/rare_disease_organizations_row.rb +454 -0
  288. data/lib/pharmaobservatory/models/rare_disease_prevalence_response.rb +478 -0
  289. data/lib/pharmaobservatory/models/rare_disease_prevalence_row.rb +465 -0
  290. data/lib/pharmaobservatory/models/rare_disease_rarity_evidence_response.rb +478 -0
  291. data/lib/pharmaobservatory/models/rare_disease_rarity_evidence_row.rb +322 -0
  292. data/lib/pharmaobservatory/models/rare_disease_rarity_response.rb +478 -0
  293. data/lib/pharmaobservatory/models/rare_disease_rarity_row.rb +421 -0
  294. data/lib/pharmaobservatory/models/rare_disease_replacements_response.rb +478 -0
  295. data/lib/pharmaobservatory/models/rare_disease_replacements_row.rb +344 -0
  296. data/lib/pharmaobservatory/models/rare_disease_site_coverage_response.rb +478 -0
  297. data/lib/pharmaobservatory/models/rare_disease_site_coverage_row.rb +421 -0
  298. data/lib/pharmaobservatory/models/rare_disease_sponsors_response.rb +478 -0
  299. data/lib/pharmaobservatory/models/rare_disease_sponsors_row.rb +575 -0
  300. data/lib/pharmaobservatory/models/rare_disease_trial_coverage_response.rb +478 -0
  301. data/lib/pharmaobservatory/models/rare_disease_trial_coverage_row.rb +449 -0
  302. data/lib/pharmaobservatory/models/rare_disease_trial_sites_response.rb +478 -0
  303. data/lib/pharmaobservatory/models/rare_disease_trial_sites_row.rb +412 -0
  304. data/lib/pharmaobservatory/models/rare_disease_trials_response.rb +478 -0
  305. data/lib/pharmaobservatory/models/rare_disease_trials_row.rb +623 -0
  306. data/lib/pharmaobservatory/models/rare_diseases_record.rb +385 -0
  307. data/lib/pharmaobservatory/models/rare_diseases_record_attributes.rb +238 -0
  308. data/lib/pharmaobservatory/models/rare_diseases_response.rb +478 -0
  309. data/lib/pharmaobservatory/models/rare_diseases_row.rb +500 -0
  310. data/lib/pharmaobservatory/models/recalls_response.rb +478 -0
  311. data/lib/pharmaobservatory/models/recalls_row.rb +421 -0
  312. data/lib/pharmaobservatory/models/rwd_coverage_response.rb +478 -0
  313. data/lib/pharmaobservatory/models/rwd_coverage_row.rb +410 -0
  314. data/lib/pharmaobservatory/models/rwd_register_provenance_response.rb +478 -0
  315. data/lib/pharmaobservatory/models/rwd_register_provenance_row.rb +531 -0
  316. data/lib/pharmaobservatory/models/rwd_registers_record.rb +385 -0
  317. data/lib/pharmaobservatory/models/rwd_source_age_bands_response.rb +478 -0
  318. data/lib/pharmaobservatory/models/rwd_source_age_bands_row.rb +344 -0
  319. data/lib/pharmaobservatory/models/rwd_source_conditions_response.rb +478 -0
  320. data/lib/pharmaobservatory/models/rwd_source_conditions_row.rb +502 -0
  321. data/lib/pharmaobservatory/models/rwd_source_etl_mappings_response.rb +478 -0
  322. data/lib/pharmaobservatory/models/rwd_source_etl_mappings_row.rb +366 -0
  323. data/lib/pharmaobservatory/models/rwd_source_linkages_response.rb +478 -0
  324. data/lib/pharmaobservatory/models/rwd_source_linkages_row.rb +476 -0
  325. data/lib/pharmaobservatory/models/rwd_source_types_response.rb +478 -0
  326. data/lib/pharmaobservatory/models/rwd_source_types_row.rb +311 -0
  327. data/lib/pharmaobservatory/models/rwd_source_vocabularies_response.rb +478 -0
  328. data/lib/pharmaobservatory/models/rwd_source_vocabularies_row.rb +355 -0
  329. data/lib/pharmaobservatory/models/rwd_sources_record.rb +385 -0
  330. data/lib/pharmaobservatory/models/rwd_sources_response.rb +478 -0
  331. data/lib/pharmaobservatory/models/rwd_sources_row.rb +1674 -0
  332. data/lib/pharmaobservatory/models/rwd_studies_record.rb +385 -0
  333. data/lib/pharmaobservatory/models/rwd_studies_response.rb +478 -0
  334. data/lib/pharmaobservatory/models/rwd_studies_row.rb +1138 -0
  335. data/lib/pharmaobservatory/models/rwd_study_conditions_response.rb +478 -0
  336. data/lib/pharmaobservatory/models/rwd_study_conditions_row.rb +421 -0
  337. data/lib/pharmaobservatory/models/rwd_study_data_sources_response.rb +478 -0
  338. data/lib/pharmaobservatory/models/rwd_study_data_sources_row.rb +423 -0
  339. data/lib/pharmaobservatory/models/rwd_study_drugs_response.rb +478 -0
  340. data/lib/pharmaobservatory/models/rwd_study_drugs_row.rb +401 -0
  341. data/lib/pharmaobservatory/models/rwd_study_milestones_response.rb +478 -0
  342. data/lib/pharmaobservatory/models/rwd_study_milestones_row.rb +421 -0
  343. data/lib/pharmaobservatory/models/rwd_withheld_fields_response.rb +478 -0
  344. data/lib/pharmaobservatory/models/rwd_withheld_fields_row.rb +322 -0
  345. data/lib/pharmaobservatory/models/sec_pdufa_dates_response.rb +478 -0
  346. data/lib/pharmaobservatory/models/sec_pdufa_dates_row.rb +476 -0
  347. data/lib/pharmaobservatory/models/trial_changes_row.rb +24 -2
  348. data/lib/pharmaobservatory/models/trials_row.rb +47 -3
  349. data/lib/pharmaobservatory/models/unmatched_product_revenue_response.rb +478 -0
  350. data/lib/pharmaobservatory/models/unmatched_product_revenue_row.rb +564 -0
  351. data/lib/pharmaobservatory/models/untitled_letters_response.rb +478 -0
  352. data/lib/pharmaobservatory/models/untitled_letters_row.rb +366 -0
  353. data/lib/pharmaobservatory/models/warning_letters_response.rb +478 -0
  354. data/lib/pharmaobservatory/models/warning_letters_row.rb +399 -0
  355. data/lib/pharmaobservatory/version.rb +1 -1
  356. data/lib/pharmaobservatory.rb +164 -0
  357. metadata +330 -2
@@ -0,0 +1,38 @@
1
+ # PharmaObservatory::RareDiseasesRecord
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **object_type** | **String** | | |
8
+ | **id** | **String** | | |
9
+ | **record** | [**RareDiseasesRow**](RareDiseasesRow.md) | | |
10
+ | **attributes** | [**RareDiseasesRecordAttributes**](RareDiseasesRecordAttributes.md) | | [optional] |
11
+ | **datasets** | [**Array<DatasetListing>**](DatasetListing.md) | | |
12
+ | **attribution** | [**Array<DatasetAttribution>**](DatasetAttribution.md) | | [optional] |
13
+ | **source_credit** | **String** | | [optional] |
14
+ | **freshness** | [**BiomarkerAssayEvidenceResponseFreshness**](BiomarkerAssayEvidenceResponseFreshness.md) | | [optional] |
15
+ | **build** | [**BiomarkerAssayEvidenceResponseBuild**](BiomarkerAssayEvidenceResponseBuild.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::RareDiseasesRecord.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,22 @@
1
+ # PharmaObservatory::RareDiseasesRecordAttributes
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **rare_disease_investigator_coverage** | [**RareDiseaseInvestigatorCoverageRow**](RareDiseaseInvestigatorCoverageRow.md) | | [optional] |
8
+ | **rare_disease_site_coverage** | [**RareDiseaseSiteCoverageRow**](RareDiseaseSiteCoverageRow.md) | | [optional] |
9
+ | **rare_disease_trial_coverage** | [**RareDiseaseTrialCoverageRow**](RareDiseaseTrialCoverageRow.md) | | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'pharmaobservatory'
15
+
16
+ instance = PharmaObservatory::RareDiseasesRecordAttributes.new(
17
+ rare_disease_investigator_coverage: null,
18
+ rare_disease_site_coverage: null,
19
+ rare_disease_trial_coverage: null
20
+ )
21
+ ```
22
+
@@ -0,0 +1,58 @@
1
+ # PharmaObservatory::RareDiseasesResponse
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** | [**BiomarkerAssayEvidenceResponseScope**](BiomarkerAssayEvidenceResponseScope.md) | | [optional] |
12
+ | **columns** | [**Array<DatasetColumn>**](DatasetColumn.md) | | |
13
+ | **rows** | [**Array<RareDiseasesRow>**](RareDiseasesRow.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** | [**BiomarkerAssayEvidenceResponseFreshness**](BiomarkerAssayEvidenceResponseFreshness.md) | | [optional] |
25
+ | **build** | [**BiomarkerAssayEvidenceResponseBuild**](BiomarkerAssayEvidenceResponseBuild.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::RareDiseasesResponse.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,68 @@
1
+ # PharmaObservatory::RareDiseasesRow
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **orpha_code** | **String** | The ORPHA code of the disease, the digits in the web page address (/rare-diseases/558). The entry key of the rare_diseases object type. | [optional] |
8
+ | **disease_key** | **String** | The disease key (orpha: plus the ORPHA code). An attribute, not an id: the entry key is orpha_code. | [optional] |
9
+ | **preferred_name** | **String** | The disease's preferred English name. | [optional] |
10
+ | **aliases** | **Array<String>** | English synonyms Orphanet lists for the disease. | [optional] |
11
+ | **concept_type** | **String** | Whether the concept is a group of disorders, a disorder or a subtype. | [optional] |
12
+ | **status** | **String** | The concept's lifecycle state in Orphanet (active or deprecated). | [optional] |
13
+ | **ordo_entity_type** | **String** | The entity type the Orphanet Rare Disease Ontology gives the concept. | [optional] |
14
+ | **orphanet_disorder_type** | **String** | The disorder type in Orphanet's classification of rare diseases. | [optional] |
15
+ | **orphanet_disorder_group** | **String** | The disorder group in Orphanet's classification of rare diseases. | [optional] |
16
+ | **gene_evidence_state** | **String** | known_causal when at least one gene assertion is a disease-causing mutation assessed by Orphanet, weaker_only when only other gene assertions exist, none when there is no gene assertion. | [optional] |
17
+ | **n_genes** | **Integer** | Distinct genes asserted for the disease. | [optional] |
18
+ | **n_known_causal_genes** | **Integer** | Distinct genes whose assertion is a disease-causing mutation assessed by Orphanet. | [optional] |
19
+ | **prevalence_band** | **String** | The Orphanet point-prevalence band chosen for the disease, one of six literals; null when no documented band exists. | [optional] |
20
+ | **rarity_status_gb** | **String** | The disease's rarity status under the UK definition, from the latest assessment (rare, not_rare, unknown or conflicting); null when not assessed. | [optional] |
21
+ | **rarity_status_eu** | **String** | The disease's rarity status under the European Union definition, from the latest assessment (rare, not_rare, unknown or conflicting); null when not assessed. | [optional] |
22
+ | **trial_coverage_state** | **String** | no_bridge when the disease maps to no MeSH condition, bridged_no_trials when it maps to a condition with no trial, trials when at least one trial is linked. | [optional] |
23
+ | **n_trials_exact_direct** | **Integer** | Trials linked through an exact mapping whose own condition list names the disease. Count within this column only. | [optional] |
24
+ | **n_trials_exact_broader** | **Integer** | Trials linked through an exact mapping to a broader condition than the trial studies. Count within this column only. | [optional] |
25
+ | **n_trials_unspecified** | **Integer** | Trials linked through a MONDO cross-reference that states no relation. Count within this column only. | [optional] |
26
+ | **n_exact_mesh_conditions** | **Integer** | MeSH conditions the disease maps to with an exact relation. | [optional] |
27
+ | **merges_into_condition_id** | **String** | The single MeSH condition the web merges this disease into, set only when exactly one exact MeSH match exists. | [optional] |
28
+ | **icd10_coding_state** | **String** | How Orphanet aligns the disease to ICD-10: exact, directional, unstated or unaligned. | [optional] |
29
+ | **icd11_coding_state** | **String** | How Orphanet aligns the disease to ICD-11: exact, directional, unstated or unaligned. | [optional] |
30
+ | **source_release** | **String** | The Orphadata Science release the row was read from. | [optional] |
31
+ | **license_name** | **String** | The licence of the Orphadata Science release. | [optional] |
32
+ | **attribution** | **String** | The attribution line the source requires; quote it with any figure taken from the row. | [optional] |
33
+
34
+ ## Example
35
+
36
+ ```ruby
37
+ require 'pharmaobservatory'
38
+
39
+ instance = PharmaObservatory::RareDiseasesRow.new(
40
+ orpha_code: null,
41
+ disease_key: null,
42
+ preferred_name: null,
43
+ aliases: null,
44
+ concept_type: null,
45
+ status: null,
46
+ ordo_entity_type: null,
47
+ orphanet_disorder_type: null,
48
+ orphanet_disorder_group: null,
49
+ gene_evidence_state: null,
50
+ n_genes: null,
51
+ n_known_causal_genes: null,
52
+ prevalence_band: null,
53
+ rarity_status_gb: null,
54
+ rarity_status_eu: null,
55
+ trial_coverage_state: null,
56
+ n_trials_exact_direct: null,
57
+ n_trials_exact_broader: null,
58
+ n_trials_unspecified: null,
59
+ n_exact_mesh_conditions: null,
60
+ merges_into_condition_id: null,
61
+ icd10_coding_state: null,
62
+ icd11_coding_state: null,
63
+ source_release: null,
64
+ license_name: null,
65
+ attribution: null
66
+ )
67
+ ```
68
+
@@ -0,0 +1,58 @@
1
+ # PharmaObservatory::RecallsResponse
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** | [**BiomarkerAssayEvidenceResponseScope**](BiomarkerAssayEvidenceResponseScope.md) | | [optional] |
12
+ | **columns** | [**Array<DatasetColumn>**](DatasetColumn.md) | | |
13
+ | **rows** | [**Array<RecallsRow>**](RecallsRow.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** | [**BiomarkerAssayEvidenceResponseFreshness**](BiomarkerAssayEvidenceResponseFreshness.md) | | [optional] |
25
+ | **build** | [**BiomarkerAssayEvidenceResponseBuild**](BiomarkerAssayEvidenceResponseBuild.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::RecallsResponse.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::RecallsRow
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **recall_number** | **String** | The FDA recall number. | [optional] |
8
+ | **domain** | **String** | The regulatory domain of the recalled product (drug or device here). | [optional] |
9
+ | **status** | **String** | The recall status (Ongoing, Completed or Terminated). | [optional] |
10
+ | **recall_class** | **String** | The severity class: Class I, II or III. | [optional] |
11
+ | **product_type** | **String** | The product type the FDA reports (Drugs, Devices and so on). | [optional] |
12
+ | **firm_name** | **String** | The firm's name as filed with the regulator (the recalling firm). | [optional] |
13
+ | **firm_org_id** | **String** | Legal-entity level: the organization record the firm resolved to (null when the firm did not resolve). | [optional] |
14
+ | **firm_company_id** | **String** | Company level: the firm's company (null when unresolved); the entry key for the companies object type. | [optional] |
15
+ | **firm_company_name** | **String** | Display name of the firm's company. | [optional] |
16
+ | **firm_group_id** | **String** | Group level: the firm's current ultimate parent; a root's group is itself. | [optional] |
17
+ | **firm_group_name** | **String** | Display name of the firm's group. | [optional] |
18
+ | **is_org_resolved** | **Boolean** | True when the firm was attached to an organization. A false row is kept with null firm ids and the name as filed, so an empty read for a company is not proof of no enforcement history. | [optional] |
19
+ | **match_tier** | **String** | How well the firm name was attached to an organization: high, medium or low name-and-geography matches, registry (the operating firm of a registered facility), ambiguous (several candidates, none chosen) or unresolved. Warning letters, untitled letters and debarments attach by firm name alone. | [optional] |
20
+ | **org_resolution_method** | **String** | The route that attached the firm: fei_bridge (the FDA establishment identifier, FEI, bridge), fei_firm_mint or fei_firm_fold (the operating firm's registry record), firm_name_geo (name and geography), firm_name_only (name alone) or unresolved. | [optional] |
21
+ | **product_description** | **String** | The recalled product as described in the report. | [optional] |
22
+ | **reason_for_recall** | **String** | The reason the FDA gives for the recall. | [optional] |
23
+ | **recall_initiation_date** | **Date** | The date the firm began the recall. | [optional] |
24
+ | **report_date** | **Date** | The date the FDA reported the recall. | [optional] |
25
+ | **termination_date** | **Date** | The date the recall was terminated, where it was. | [optional] |
26
+
27
+ ## Example
28
+
29
+ ```ruby
30
+ require 'pharmaobservatory'
31
+
32
+ instance = PharmaObservatory::RecallsRow.new(
33
+ recall_number: null,
34
+ domain: null,
35
+ status: null,
36
+ recall_class: null,
37
+ product_type: null,
38
+ firm_name: null,
39
+ firm_org_id: null,
40
+ firm_company_id: null,
41
+ firm_company_name: null,
42
+ firm_group_id: null,
43
+ firm_group_name: null,
44
+ is_org_resolved: null,
45
+ match_tier: null,
46
+ org_resolution_method: null,
47
+ product_description: null,
48
+ reason_for_recall: null,
49
+ recall_initiation_date: null,
50
+ report_date: null,
51
+ termination_date: null
52
+ )
53
+ ```
54
+
@@ -0,0 +1,58 @@
1
+ # PharmaObservatory::RwdCoverageResponse
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** | [**BiomarkerAssayEvidenceResponseScope**](BiomarkerAssayEvidenceResponseScope.md) | | [optional] |
12
+ | **columns** | [**Array<DatasetColumn>**](DatasetColumn.md) | | |
13
+ | **rows** | [**Array<RwdCoverageRow>**](RwdCoverageRow.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** | [**BiomarkerAssayEvidenceResponseFreshness**](BiomarkerAssayEvidenceResponseFreshness.md) | | [optional] |
25
+ | **build** | [**BiomarkerAssayEvidenceResponseBuild**](BiomarkerAssayEvidenceResponseBuild.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::RwdCoverageResponse.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,52 @@
1
+ # PharmaObservatory::RwdCoverageRow
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **chain_key** | **String** | Which denominator chain the row belongs to. | [optional] |
8
+ | **chain_label** | **String** | The chain's plain-words label. | [optional] |
9
+ | **chain_is_a_partition** | **Boolean** | True when the chain's steps partition the denominator (they sum to it); false when steps overlap. | [optional] |
10
+ | **step_ordinal** | **Integer** | The step's position in the chain; 0 is the denominator itself, published as a step so the chain reads top to bottom. | [optional] |
11
+ | **step_key** | **String** | The step's key. | [optional] |
12
+ | **step_label** | **String** | The step's plain-words label. | [optional] |
13
+ | **register_key** | **String** | Which of the five exports the row concerns: study, data_source_human, data_source_veterinary, institution or network. The entry key of the rwd_registers object type. | [optional] |
14
+ | **measured_value** | **Integer** | The measured count at this step. | [optional] |
15
+ | **denominator_key** | **String** | Which denominator the step is read against. | [optional] |
16
+ | **denominator_label** | **String** | The denominator's plain-words label. | [optional] |
17
+ | **denominator_value** | **Integer** | The denominator's value. | [optional] |
18
+ | **share_of_denominator** | **Float** | measured_value over denominator_value, as a fraction. | [optional] |
19
+ | **derivation_note** | **String** | How the step is derived. | [optional] |
20
+ | **snapshot_label** | **String** | The label of the catalogue snapshot the row was read from (a date). | [optional] |
21
+ | **snapshot_date** | **Date** | The date of the catalogue snapshot. | [optional] |
22
+ | **accessed_month** | **String** | The month and year the catalogue was accessed (YYYY-MM), which EMA's site asks to be cited with its URL. | [optional] |
23
+ | **restriction_tier** | **String** | The license restriction tier of the row's source. Every row of this dataset is licensable (PROVISIONAL, legal read pending). | [optional] |
24
+ | **attribution** | **String** | The attribution line EMA requires, including the catalogue URL and the access month; quote it with any figure taken from the row. | [optional] |
25
+
26
+ ## Example
27
+
28
+ ```ruby
29
+ require 'pharmaobservatory'
30
+
31
+ instance = PharmaObservatory::RwdCoverageRow.new(
32
+ chain_key: null,
33
+ chain_label: null,
34
+ chain_is_a_partition: null,
35
+ step_ordinal: null,
36
+ step_key: null,
37
+ step_label: null,
38
+ register_key: null,
39
+ measured_value: null,
40
+ denominator_key: null,
41
+ denominator_label: null,
42
+ denominator_value: null,
43
+ share_of_denominator: null,
44
+ derivation_note: null,
45
+ snapshot_label: null,
46
+ snapshot_date: null,
47
+ accessed_month: null,
48
+ restriction_tier: null,
49
+ attribution: null
50
+ )
51
+ ```
52
+
@@ -0,0 +1,58 @@
1
+ # PharmaObservatory::RwdRegisterProvenanceResponse
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** | [**BiomarkerAssayEvidenceResponseScope**](BiomarkerAssayEvidenceResponseScope.md) | | [optional] |
12
+ | **columns** | [**Array<DatasetColumn>**](DatasetColumn.md) | | |
13
+ | **rows** | [**Array<RwdRegisterProvenanceRow>**](RwdRegisterProvenanceRow.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** | [**BiomarkerAssayEvidenceResponseFreshness**](BiomarkerAssayEvidenceResponseFreshness.md) | | [optional] |
25
+ | **build** | [**BiomarkerAssayEvidenceResponseBuild**](BiomarkerAssayEvidenceResponseBuild.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::RwdRegisterProvenanceResponse.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,74 @@
1
+ # PharmaObservatory::RwdRegisterProvenanceRow
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **register_key** | **String** | Which of the five exports the row concerns: study, data_source_human, data_source_veterinary, institution or network. The entry key of the rwd_registers object type. | [optional] |
8
+ | **register_label** | **String** | The register's plain-words label. | [optional] |
9
+ | **register_ordinal** | **Integer** | The register's position in the lane's order. | [optional] |
10
+ | **provenance_source** | **String** | The landed source name of the export. | [optional] |
11
+ | **export_is_empty_at_source** | **Boolean** | True when the export held no rows at the source. | [optional] |
12
+ | **landed_rows** | **Integer** | How many rows the export landed. | [optional] |
13
+ | **build_status** | **String** | The status of the latest landing run. | [optional] |
14
+ | **build_snapshot_id** | **String** | The snapshot id of the latest landing run. | [optional] |
15
+ | **build_row_count** | **Integer** | The row count of the latest landing run. | [optional] |
16
+ | **build_started_at** | **Time** | When the latest landing run started (UTC). | [optional] |
17
+ | **build_finished_at** | **Time** | When the latest landing run finished (UTC). | [optional] |
18
+ | **last_completed_snapshot_id** | **String** | The snapshot id of the last completed landing. | [optional] |
19
+ | **last_completed_row_count** | **Integer** | The row count of the last completed landing. | [optional] |
20
+ | **last_completed_at** | **Time** | When the last completed landing finished (UTC). | [optional] |
21
+ | **registrant_clock_asof** | **Date** | The cutoff of the registrant clock: the snapshot date less twelve months; a record last updated before it counts as older than twelve months. | [optional] |
22
+ | **register_publishes_update_date** | **Boolean** | Whether the export carries an update date column. | [optional] |
23
+ | **records_with_an_update_date** | **Integer** | How many records carry an update date. | [optional] |
24
+ | **records_updated_over_twelve_months** | **Integer** | How many records were last updated more than twelve months before the snapshot. | [optional] |
25
+ | **share_updated_over_twelve_months** | **Float** | The share of records with an update date that are older than twelve months. | [optional] |
26
+ | **register_publishes_outdated_flag** | **Boolean** | Whether the export carries EMA's Outdated flag. | [optional] |
27
+ | **records_ema_flags_outdated** | **Integer** | How many records EMA flags Outdated. | [optional] |
28
+ | **records_outdated_flag_blank** | **Integer** | How many records have no Outdated flag value. | [optional] |
29
+ | **columns_landed** | **Integer** | How many columns of the export this lane lands. | [optional] |
30
+ | **columns_withheld** | **Integer** | How many columns of the export the lane withholds (contact details of named individuals). | [optional] |
31
+ | **snapshot_label** | **String** | The label of the catalogue snapshot the row was read from (a date). | [optional] |
32
+ | **snapshot_date** | **Date** | The date of the catalogue snapshot. | [optional] |
33
+ | **accessed_month** | **String** | The month and year the catalogue was accessed (YYYY-MM), which EMA's site asks to be cited with its URL. | [optional] |
34
+ | **restriction_tier** | **String** | The license restriction tier of the row's source. Every row of this dataset is licensable (PROVISIONAL, legal read pending). | [optional] |
35
+ | **attribution** | **String** | The attribution line EMA requires, including the catalogue URL and the access month; quote it with any figure taken from the row. | [optional] |
36
+
37
+ ## Example
38
+
39
+ ```ruby
40
+ require 'pharmaobservatory'
41
+
42
+ instance = PharmaObservatory::RwdRegisterProvenanceRow.new(
43
+ register_key: null,
44
+ register_label: null,
45
+ register_ordinal: null,
46
+ provenance_source: null,
47
+ export_is_empty_at_source: null,
48
+ landed_rows: null,
49
+ build_status: null,
50
+ build_snapshot_id: null,
51
+ build_row_count: null,
52
+ build_started_at: null,
53
+ build_finished_at: null,
54
+ last_completed_snapshot_id: null,
55
+ last_completed_row_count: null,
56
+ last_completed_at: null,
57
+ registrant_clock_asof: null,
58
+ register_publishes_update_date: null,
59
+ records_with_an_update_date: null,
60
+ records_updated_over_twelve_months: null,
61
+ share_updated_over_twelve_months: null,
62
+ register_publishes_outdated_flag: null,
63
+ records_ema_flags_outdated: null,
64
+ records_outdated_flag_blank: null,
65
+ columns_landed: null,
66
+ columns_withheld: null,
67
+ snapshot_label: null,
68
+ snapshot_date: null,
69
+ accessed_month: null,
70
+ restriction_tier: null,
71
+ attribution: null
72
+ )
73
+ ```
74
+