pharmaobservatory 0.1.6 → 0.1.8

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 (455) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +348 -4
  3. data/docs/BiomarkerAlleleFrequenciesResponse.md +58 -0
  4. data/docs/BiomarkerAlleleFrequenciesRow.md +62 -0
  5. data/docs/BiomarkerAssayProvidersResponse.md +58 -0
  6. data/docs/BiomarkerAssayProvidersRow.md +72 -0
  7. data/docs/BiomarkerEvidenceByYearResponse.md +58 -0
  8. data/docs/BiomarkerEvidenceByYearRow.md +32 -0
  9. data/docs/BiomarkerTraversalStatusResponse.md +58 -0
  10. data/docs/BiomarkerTraversalStatusRow.md +36 -0
  11. data/docs/BiomarkersApi.md +320 -0
  12. data/docs/BrandCompaniesResponse.md +58 -0
  13. data/docs/BrandCompaniesRow.md +50 -0
  14. data/docs/BrandRevenueResponse.md +58 -0
  15. data/docs/BrandRevenueRow.md +60 -0
  16. data/docs/CatalystsResponse.md +58 -0
  17. data/docs/CatalystsRow.md +90 -0
  18. data/docs/CliaCertificatesResponse.md +58 -0
  19. data/docs/CliaCertificatesRow.md +80 -0
  20. data/docs/CompaniesApi.md +2656 -196
  21. data/docs/CompaniesRecordAttributes.md +3 -1
  22. data/docs/CompanyAssetsRow.md +5 -1
  23. data/docs/CompanyBiomarkerCapabilityResponse.md +58 -0
  24. data/docs/CompanyBiomarkerCapabilityRow.md +68 -0
  25. data/docs/CompanyFundingEventsRow.md +2 -0
  26. data/docs/CompanyProgramsRow.md +5 -1
  27. data/docs/CompanyRareDiseaseDeclarationsResponse.md +58 -0
  28. data/docs/CompanyRareDiseaseDeclarationsRow.md +52 -0
  29. data/docs/CompanyTrialGeographyResponse.md +58 -0
  30. data/docs/CompanyTrialGeographyRow.md +52 -0
  31. data/docs/CompanyTrialSitesResponse.md +58 -0
  32. data/docs/CompanyTrialSitesRow.md +52 -0
  33. data/docs/ConditionsApi.md +320 -0
  34. data/docs/CroFootprintResponse.md +58 -0
  35. data/docs/CroFootprintRow.md +34 -0
  36. data/docs/CroTrialsResponse.md +58 -0
  37. data/docs/CroTrialsRow.md +46 -0
  38. data/docs/DebarmentsResponse.md +58 -0
  39. data/docs/DebarmentsRow.md +44 -0
  40. data/docs/DrugApprovalsResponse.md +58 -0
  41. data/docs/DrugApprovalsRow.md +28 -0
  42. data/docs/DrugAspCodesResponse.md +58 -0
  43. data/docs/DrugAspCodesRow.md +28 -0
  44. data/docs/DrugBrandsResponse.md +58 -0
  45. data/docs/DrugBrandsRow.md +60 -0
  46. data/docs/DrugCombinationsResponse.md +58 -0
  47. data/docs/DrugCombinationsRow.md +32 -0
  48. data/docs/DrugDeclaredPatentsResponse.md +58 -0
  49. data/docs/DrugDeclaredPatentsRow.md +58 -0
  50. data/docs/DrugLabelSafetyResponse.md +58 -0
  51. data/docs/DrugLabelSafetyRow.md +32 -0
  52. data/docs/DrugMedicareSpendResponse.md +58 -0
  53. data/docs/DrugMedicareSpendRow.md +28 -0
  54. data/docs/DrugPatentCliffRow.md +3 -1
  55. data/docs/DrugPatentMentionsResponse.md +58 -0
  56. data/docs/DrugPatentMentionsRow.md +28 -0
  57. data/docs/DrugPatentOwnersResponse.md +58 -0
  58. data/docs/DrugPatentOwnersRow.md +42 -0
  59. data/docs/DrugPricingResponse.md +58 -0
  60. data/docs/DrugPricingRow.md +32 -0
  61. data/docs/DrugRecallsResponse.md +58 -0
  62. data/docs/DrugRecallsRow.md +34 -0
  63. data/docs/DrugRegulatoryResponse.md +58 -0
  64. data/docs/DrugRegulatoryRow.md +38 -0
  65. data/docs/DrugSitesResponse.md +58 -0
  66. data/docs/DrugSitesRow.md +28 -0
  67. data/docs/DrugTargetsResponse.md +58 -0
  68. data/docs/DrugTargetsRow.md +36 -0
  69. data/docs/DrugTrialConditionsResponse.md +58 -0
  70. data/docs/DrugTrialConditionsRow.md +30 -0
  71. data/docs/DrugTrialsResponse.md +58 -0
  72. data/docs/DrugTrialsRow.md +58 -0
  73. data/docs/DrugVariantsResponse.md +58 -0
  74. data/docs/DrugVariantsRow.md +38 -0
  75. data/docs/DrugsApi.md +2153 -0
  76. data/docs/DrugsRecord.md +38 -0
  77. data/docs/DrugsRecordAttributes.md +20 -0
  78. data/docs/DrugsResponse.md +58 -0
  79. data/docs/DrugsRow.md +82 -0
  80. data/docs/EnforcementEventsResponse.md +58 -0
  81. data/docs/EnforcementEventsRow.md +64 -0
  82. data/docs/GxpFacilitiesResponse.md +58 -0
  83. data/docs/GxpFacilitiesRow.md +174 -0
  84. data/docs/HospitalBedsYearlyResponse.md +58 -0
  85. data/docs/HospitalBedsYearlyRow.md +28 -0
  86. data/docs/HospitalFacilityChangesResponse.md +58 -0
  87. data/docs/HospitalFacilityChangesRow.md +30 -0
  88. data/docs/HospitalsApi.md +393 -0
  89. data/docs/HospitalsRecord.md +38 -0
  90. data/docs/HospitalsResponse.md +58 -0
  91. data/docs/HospitalsRow.md +40 -0
  92. data/docs/ImportRefusalsResponse.md +58 -0
  93. data/docs/ImportRefusalsRow.md +60 -0
  94. data/docs/InspectionFindingsResponse.md +58 -0
  95. data/docs/InspectionFindingsRow.md +48 -0
  96. data/docs/InspectionsResponse.md +58 -0
  97. data/docs/InspectionsRow.md +60 -0
  98. data/docs/InstitutionalQuarterTotalsResponse.md +58 -0
  99. data/docs/InstitutionalQuarterTotalsRow.md +58 -0
  100. data/docs/LegalEntitiesApi.md +2257 -177
  101. data/docs/LegalEntitiesRecordAttributes.md +8 -0
  102. data/docs/LegalEntitySecFilingsResponse.md +58 -0
  103. data/docs/LegalEntitySecFilingsRow.md +44 -0
  104. data/docs/OrgDisclosureTrendResponse.md +58 -0
  105. data/docs/OrgDisclosureTrendRow.md +62 -0
  106. data/docs/OrgRelationshipsRow.md +1 -1
  107. data/docs/OwnershipPercentagesResponse.md +58 -0
  108. data/docs/OwnershipPercentagesRow.md +74 -0
  109. data/docs/OwnershipSourceCoverageResponse.md +58 -0
  110. data/docs/OwnershipSourceCoverageRow.md +62 -0
  111. data/docs/PdufaDatesRow.md +1 -1
  112. data/docs/ProgramLicensingCandidatesResponse.md +58 -0
  113. data/docs/ProgramLicensingCandidatesRow.md +62 -0
  114. data/docs/ProgramsResponse.md +58 -0
  115. data/docs/ProgramsRow.md +46 -0
  116. data/docs/RareDiseaseGenesResponse.md +58 -0
  117. data/docs/RareDiseaseGenesRow.md +50 -0
  118. data/docs/RareDiseaseHierarchyResponse.md +58 -0
  119. data/docs/RareDiseaseHierarchyRow.md +40 -0
  120. data/docs/RareDiseaseInvestigatorCoverageResponse.md +58 -0
  121. data/docs/RareDiseaseInvestigatorCoverageRow.md +38 -0
  122. data/docs/RareDiseaseInvestigatorsResponse.md +58 -0
  123. data/docs/RareDiseaseInvestigatorsRow.md +56 -0
  124. data/docs/RareDiseaseMappingsResponse.md +58 -0
  125. data/docs/RareDiseaseMappingsRow.md +44 -0
  126. data/docs/RareDiseaseOrganizationsResponse.md +58 -0
  127. data/docs/RareDiseaseOrganizationsRow.md +60 -0
  128. data/docs/RareDiseasePrevalenceResponse.md +58 -0
  129. data/docs/RareDiseasePrevalenceRow.md +62 -0
  130. data/docs/RareDiseaseRarityEvidenceResponse.md +58 -0
  131. data/docs/RareDiseaseRarityEvidenceRow.md +36 -0
  132. data/docs/RareDiseaseRarityResponse.md +58 -0
  133. data/docs/RareDiseaseRarityRow.md +54 -0
  134. data/docs/RareDiseaseReplacementsResponse.md +58 -0
  135. data/docs/RareDiseaseReplacementsRow.md +40 -0
  136. data/docs/RareDiseaseSiteCoverageResponse.md +58 -0
  137. data/docs/RareDiseaseSiteCoverageRow.md +54 -0
  138. data/docs/RareDiseaseSponsorsResponse.md +58 -0
  139. data/docs/RareDiseaseSponsorsRow.md +82 -0
  140. data/docs/RareDiseaseTrialCoverageResponse.md +58 -0
  141. data/docs/RareDiseaseTrialCoverageRow.md +58 -0
  142. data/docs/RareDiseaseTrialSitesResponse.md +58 -0
  143. data/docs/RareDiseaseTrialSitesRow.md +52 -0
  144. data/docs/RareDiseaseTrialsResponse.md +58 -0
  145. data/docs/RareDiseaseTrialsRow.md +90 -0
  146. data/docs/RareDiseasesApi.md +1353 -0
  147. data/docs/RareDiseasesRecord.md +38 -0
  148. data/docs/RareDiseasesRecordAttributes.md +22 -0
  149. data/docs/RareDiseasesResponse.md +58 -0
  150. data/docs/RareDiseasesRow.md +68 -0
  151. data/docs/RecallsResponse.md +58 -0
  152. data/docs/RecallsRow.md +54 -0
  153. data/docs/RwdConductorDeliveryResponse.md +58 -0
  154. data/docs/RwdConductorDeliveryRow.md +74 -0
  155. data/docs/RwdConductorFootprintResponse.md +58 -0
  156. data/docs/RwdConductorFootprintRow.md +40 -0
  157. data/docs/RwdConductorStudiesResponse.md +58 -0
  158. data/docs/RwdConductorStudiesRow.md +42 -0
  159. data/docs/RwdConductorsApi.md +393 -0
  160. data/docs/RwdConductorsRecord.md +38 -0
  161. data/docs/RwdConductorsResponse.md +58 -0
  162. data/docs/RwdConductorsRow.md +72 -0
  163. data/docs/RwdCoverageResponse.md +58 -0
  164. data/docs/RwdCoverageRow.md +52 -0
  165. data/docs/RwdInstitutionsApi.md +153 -0
  166. data/docs/RwdInstitutionsRecord.md +38 -0
  167. data/docs/RwdInstitutionsResponse.md +58 -0
  168. data/docs/RwdInstitutionsRow.md +154 -0
  169. data/docs/RwdNetworksApi.md +153 -0
  170. data/docs/RwdNetworksRecord.md +38 -0
  171. data/docs/RwdNetworksResponse.md +58 -0
  172. data/docs/RwdNetworksRow.md +110 -0
  173. data/docs/RwdRegisterProvenanceResponse.md +58 -0
  174. data/docs/RwdRegisterProvenanceRow.md +74 -0
  175. data/docs/RwdRegistersApi.md +313 -0
  176. data/docs/RwdRegistersRecord.md +38 -0
  177. data/docs/RwdSourceAgeBandsResponse.md +58 -0
  178. data/docs/RwdSourceAgeBandsRow.md +40 -0
  179. data/docs/RwdSourceConditionsResponse.md +58 -0
  180. data/docs/RwdSourceConditionsRow.md +68 -0
  181. data/docs/RwdSourceEtlMappingsResponse.md +58 -0
  182. data/docs/RwdSourceEtlMappingsRow.md +44 -0
  183. data/docs/RwdSourceLinkagesResponse.md +58 -0
  184. data/docs/RwdSourceLinkagesRow.md +64 -0
  185. data/docs/RwdSourceTypesResponse.md +58 -0
  186. data/docs/RwdSourceTypesRow.md +34 -0
  187. data/docs/RwdSourceVocabulariesResponse.md +58 -0
  188. data/docs/RwdSourceVocabulariesRow.md +42 -0
  189. data/docs/RwdSourcesApi.md +713 -0
  190. data/docs/RwdSourcesRecord.md +38 -0
  191. data/docs/RwdSourcesResponse.md +58 -0
  192. data/docs/RwdSourcesRow.md +280 -0
  193. data/docs/RwdStudiesApi.md +553 -0
  194. data/docs/RwdStudiesRecord.md +38 -0
  195. data/docs/RwdStudiesResponse.md +58 -0
  196. data/docs/RwdStudiesRow.md +180 -0
  197. data/docs/RwdStudyConditionsResponse.md +58 -0
  198. data/docs/RwdStudyConditionsRow.md +54 -0
  199. data/docs/RwdStudyDataSourcesResponse.md +58 -0
  200. data/docs/RwdStudyDataSourcesRow.md +54 -0
  201. data/docs/RwdStudyDrugsResponse.md +58 -0
  202. data/docs/RwdStudyDrugsRow.md +50 -0
  203. data/docs/RwdStudyMilestonesResponse.md +58 -0
  204. data/docs/RwdStudyMilestonesRow.md +54 -0
  205. data/docs/RwdWithheldFieldsResponse.md +58 -0
  206. data/docs/RwdWithheldFieldsRow.md +36 -0
  207. data/docs/SbtiCrosscheckResponse.md +58 -0
  208. data/docs/SbtiCrosscheckRow.md +48 -0
  209. data/docs/SecPdufaDatesResponse.md +58 -0
  210. data/docs/SecPdufaDatesRow.md +64 -0
  211. data/docs/SponsorDeliveryResponse.md +58 -0
  212. data/docs/SponsorDeliveryRow.md +52 -0
  213. data/docs/SponsorPatentMentionsResponse.md +58 -0
  214. data/docs/SponsorPatentMentionsRow.md +42 -0
  215. data/docs/SponsorTrialConditionsResponse.md +58 -0
  216. data/docs/SponsorTrialConditionsRow.md +36 -0
  217. data/docs/SponsorTrialDrugsResponse.md +58 -0
  218. data/docs/SponsorTrialDrugsRow.md +34 -0
  219. data/docs/TrialChangesRow.md +5 -1
  220. data/docs/TrialsApi.md +80 -0
  221. data/docs/TrialsRow.md +9 -1
  222. data/docs/UnmatchedProductRevenueResponse.md +58 -0
  223. data/docs/UnmatchedProductRevenueRow.md +80 -0
  224. data/docs/UntitledLettersResponse.md +58 -0
  225. data/docs/UntitledLettersRow.md +44 -0
  226. data/docs/WarningLettersResponse.md +58 -0
  227. data/docs/WarningLettersRow.md +50 -0
  228. data/lib/pharmaobservatory/api/biomarkers_api.rb +336 -0
  229. data/lib/pharmaobservatory/api/companies_api.rb +3026 -296
  230. data/lib/pharmaobservatory/api/conditions_api.rb +336 -0
  231. data/lib/pharmaobservatory/api/drugs_api.rb +2261 -0
  232. data/lib/pharmaobservatory/api/hospitals_api.rb +413 -0
  233. data/lib/pharmaobservatory/api/legal_entities_api.rb +2376 -192
  234. data/lib/pharmaobservatory/api/rare_diseases_api.rb +1421 -0
  235. data/lib/pharmaobservatory/api/rwd_conductors_api.rb +413 -0
  236. data/lib/pharmaobservatory/api/rwd_institutions_api.rb +161 -0
  237. data/lib/pharmaobservatory/api/rwd_networks_api.rb +161 -0
  238. data/lib/pharmaobservatory/api/rwd_registers_api.rb +329 -0
  239. data/lib/pharmaobservatory/api/rwd_sources_api.rb +749 -0
  240. data/lib/pharmaobservatory/api/rwd_studies_api.rb +581 -0
  241. data/lib/pharmaobservatory/api/trials_api.rb +84 -0
  242. data/lib/pharmaobservatory/models/biomarker_allele_frequencies_response.rb +478 -0
  243. data/lib/pharmaobservatory/models/biomarker_allele_frequencies_row.rb +465 -0
  244. data/lib/pharmaobservatory/models/biomarker_assay_providers_response.rb +478 -0
  245. data/lib/pharmaobservatory/models/biomarker_assay_providers_row.rb +520 -0
  246. data/lib/pharmaobservatory/models/biomarker_evidence_by_year_response.rb +478 -0
  247. data/lib/pharmaobservatory/models/biomarker_evidence_by_year_row.rb +300 -0
  248. data/lib/pharmaobservatory/models/biomarker_traversal_status_response.rb +478 -0
  249. data/lib/pharmaobservatory/models/biomarker_traversal_status_row.rb +322 -0
  250. data/lib/pharmaobservatory/models/brand_companies_response.rb +478 -0
  251. data/lib/pharmaobservatory/models/brand_companies_row.rb +401 -0
  252. data/lib/pharmaobservatory/models/brand_revenue_response.rb +478 -0
  253. data/lib/pharmaobservatory/models/brand_revenue_row.rb +454 -0
  254. data/lib/pharmaobservatory/models/catalysts_response.rb +478 -0
  255. data/lib/pharmaobservatory/models/catalysts_row.rb +623 -0
  256. data/lib/pharmaobservatory/models/clia_certificates_response.rb +478 -0
  257. data/lib/pharmaobservatory/models/clia_certificates_row.rb +568 -0
  258. data/lib/pharmaobservatory/models/companies_record_attributes.rb +13 -4
  259. data/lib/pharmaobservatory/models/company_assets_row.rb +24 -2
  260. data/lib/pharmaobservatory/models/company_biomarker_capability_response.rb +478 -0
  261. data/lib/pharmaobservatory/models/company_biomarker_capability_row.rb +498 -0
  262. data/lib/pharmaobservatory/models/company_funding_events_row.rb +12 -1
  263. data/lib/pharmaobservatory/models/company_programs_row.rb +24 -2
  264. data/lib/pharmaobservatory/models/company_rare_disease_declarations_response.rb +478 -0
  265. data/lib/pharmaobservatory/models/company_rare_disease_declarations_row.rb +410 -0
  266. data/lib/pharmaobservatory/models/company_trial_geography_response.rb +478 -0
  267. data/lib/pharmaobservatory/models/company_trial_geography_row.rb +410 -0
  268. data/lib/pharmaobservatory/models/company_trial_sites_response.rb +478 -0
  269. data/lib/pharmaobservatory/models/company_trial_sites_row.rb +410 -0
  270. data/lib/pharmaobservatory/models/cro_footprint_response.rb +478 -0
  271. data/lib/pharmaobservatory/models/cro_footprint_row.rb +311 -0
  272. data/lib/pharmaobservatory/models/cro_trials_response.rb +478 -0
  273. data/lib/pharmaobservatory/models/cro_trials_row.rb +381 -0
  274. data/lib/pharmaobservatory/models/debarments_response.rb +478 -0
  275. data/lib/pharmaobservatory/models/debarments_row.rb +366 -0
  276. data/lib/pharmaobservatory/models/drug_approvals_response.rb +478 -0
  277. data/lib/pharmaobservatory/models/drug_approvals_row.rb +278 -0
  278. data/lib/pharmaobservatory/models/drug_asp_codes_response.rb +478 -0
  279. data/lib/pharmaobservatory/models/drug_asp_codes_row.rb +278 -0
  280. data/lib/pharmaobservatory/models/drug_brands_response.rb +478 -0
  281. data/lib/pharmaobservatory/models/drug_brands_row.rb +454 -0
  282. data/lib/pharmaobservatory/models/drug_combinations_response.rb +478 -0
  283. data/lib/pharmaobservatory/models/drug_combinations_row.rb +300 -0
  284. data/lib/pharmaobservatory/models/drug_declared_patents_response.rb +478 -0
  285. data/lib/pharmaobservatory/models/drug_declared_patents_row.rb +447 -0
  286. data/lib/pharmaobservatory/models/drug_label_safety_response.rb +478 -0
  287. data/lib/pharmaobservatory/models/drug_label_safety_row.rb +300 -0
  288. data/lib/pharmaobservatory/models/drug_medicare_spend_response.rb +478 -0
  289. data/lib/pharmaobservatory/models/drug_medicare_spend_row.rb +280 -0
  290. data/lib/pharmaobservatory/models/drug_patent_cliff_row.rb +13 -2
  291. data/lib/pharmaobservatory/models/drug_patent_mentions_response.rb +478 -0
  292. data/lib/pharmaobservatory/models/drug_patent_mentions_row.rb +278 -0
  293. data/lib/pharmaobservatory/models/drug_patent_owners_response.rb +478 -0
  294. data/lib/pharmaobservatory/models/drug_patent_owners_row.rb +357 -0
  295. data/lib/pharmaobservatory/models/drug_pricing_response.rb +478 -0
  296. data/lib/pharmaobservatory/models/drug_pricing_row.rb +300 -0
  297. data/lib/pharmaobservatory/models/drug_recalls_response.rb +478 -0
  298. data/lib/pharmaobservatory/models/drug_recalls_row.rb +311 -0
  299. data/lib/pharmaobservatory/models/drug_regulatory_response.rb +478 -0
  300. data/lib/pharmaobservatory/models/drug_regulatory_row.rb +333 -0
  301. data/lib/pharmaobservatory/models/drug_sites_response.rb +478 -0
  302. data/lib/pharmaobservatory/models/drug_sites_row.rb +278 -0
  303. data/lib/pharmaobservatory/models/drug_targets_response.rb +478 -0
  304. data/lib/pharmaobservatory/models/drug_targets_row.rb +324 -0
  305. data/lib/pharmaobservatory/models/drug_trial_conditions_response.rb +478 -0
  306. data/lib/pharmaobservatory/models/drug_trial_conditions_row.rb +289 -0
  307. data/lib/pharmaobservatory/models/drug_trials_response.rb +478 -0
  308. data/lib/pharmaobservatory/models/drug_trials_row.rb +445 -0
  309. data/lib/pharmaobservatory/models/drug_variants_response.rb +478 -0
  310. data/lib/pharmaobservatory/models/drug_variants_row.rb +333 -0
  311. data/lib/pharmaobservatory/models/drugs_record.rb +385 -0
  312. data/lib/pharmaobservatory/models/drugs_record_attributes.rb +229 -0
  313. data/lib/pharmaobservatory/models/drugs_response.rb +478 -0
  314. data/lib/pharmaobservatory/models/drugs_row.rb +581 -0
  315. data/lib/pharmaobservatory/models/enforcement_events_response.rb +478 -0
  316. data/lib/pharmaobservatory/models/enforcement_events_row.rb +476 -0
  317. data/lib/pharmaobservatory/models/gxp_facilities_response.rb +478 -0
  318. data/lib/pharmaobservatory/models/gxp_facilities_row.rb +1089 -0
  319. data/lib/pharmaobservatory/models/hospital_beds_yearly_response.rb +478 -0
  320. data/lib/pharmaobservatory/models/hospital_beds_yearly_row.rb +278 -0
  321. data/lib/pharmaobservatory/models/hospital_facility_changes_response.rb +478 -0
  322. data/lib/pharmaobservatory/models/hospital_facility_changes_row.rb +289 -0
  323. data/lib/pharmaobservatory/models/hospitals_record.rb +385 -0
  324. data/lib/pharmaobservatory/models/hospitals_response.rb +478 -0
  325. data/lib/pharmaobservatory/models/hospitals_row.rb +344 -0
  326. data/lib/pharmaobservatory/models/import_refusals_response.rb +478 -0
  327. data/lib/pharmaobservatory/models/import_refusals_row.rb +454 -0
  328. data/lib/pharmaobservatory/models/inspection_findings_response.rb +478 -0
  329. data/lib/pharmaobservatory/models/inspection_findings_row.rb +388 -0
  330. data/lib/pharmaobservatory/models/inspections_response.rb +478 -0
  331. data/lib/pharmaobservatory/models/inspections_row.rb +454 -0
  332. data/lib/pharmaobservatory/models/institutional_quarter_totals_response.rb +478 -0
  333. data/lib/pharmaobservatory/models/institutional_quarter_totals_row.rb +443 -0
  334. data/lib/pharmaobservatory/models/legal_entities_record_attributes.rb +37 -1
  335. data/lib/pharmaobservatory/models/legal_entity_sec_filings_response.rb +478 -0
  336. data/lib/pharmaobservatory/models/legal_entity_sec_filings_row.rb +370 -0
  337. data/lib/pharmaobservatory/models/org_disclosure_trend_response.rb +478 -0
  338. data/lib/pharmaobservatory/models/org_disclosure_trend_row.rb +465 -0
  339. data/lib/pharmaobservatory/models/org_relationships_row.rb +1 -1
  340. data/lib/pharmaobservatory/models/ownership_percentages_response.rb +478 -0
  341. data/lib/pharmaobservatory/models/ownership_percentages_row.rb +531 -0
  342. data/lib/pharmaobservatory/models/ownership_source_coverage_response.rb +478 -0
  343. data/lib/pharmaobservatory/models/ownership_source_coverage_row.rb +465 -0
  344. data/lib/pharmaobservatory/models/pdufa_dates_row.rb +1 -1
  345. data/lib/pharmaobservatory/models/program_licensing_candidates_response.rb +478 -0
  346. data/lib/pharmaobservatory/models/program_licensing_candidates_row.rb +467 -0
  347. data/lib/pharmaobservatory/models/programs_response.rb +478 -0
  348. data/lib/pharmaobservatory/models/programs_row.rb +377 -0
  349. data/lib/pharmaobservatory/models/rare_disease_genes_response.rb +478 -0
  350. data/lib/pharmaobservatory/models/rare_disease_genes_row.rb +399 -0
  351. data/lib/pharmaobservatory/models/rare_disease_hierarchy_response.rb +478 -0
  352. data/lib/pharmaobservatory/models/rare_disease_hierarchy_row.rb +344 -0
  353. data/lib/pharmaobservatory/models/rare_disease_investigator_coverage_response.rb +478 -0
  354. data/lib/pharmaobservatory/models/rare_disease_investigator_coverage_row.rb +333 -0
  355. data/lib/pharmaobservatory/models/rare_disease_investigators_response.rb +478 -0
  356. data/lib/pharmaobservatory/models/rare_disease_investigators_row.rb +436 -0
  357. data/lib/pharmaobservatory/models/rare_disease_mappings_response.rb +478 -0
  358. data/lib/pharmaobservatory/models/rare_disease_mappings_row.rb +366 -0
  359. data/lib/pharmaobservatory/models/rare_disease_organizations_response.rb +478 -0
  360. data/lib/pharmaobservatory/models/rare_disease_organizations_row.rb +454 -0
  361. data/lib/pharmaobservatory/models/rare_disease_prevalence_response.rb +478 -0
  362. data/lib/pharmaobservatory/models/rare_disease_prevalence_row.rb +465 -0
  363. data/lib/pharmaobservatory/models/rare_disease_rarity_evidence_response.rb +478 -0
  364. data/lib/pharmaobservatory/models/rare_disease_rarity_evidence_row.rb +322 -0
  365. data/lib/pharmaobservatory/models/rare_disease_rarity_response.rb +478 -0
  366. data/lib/pharmaobservatory/models/rare_disease_rarity_row.rb +421 -0
  367. data/lib/pharmaobservatory/models/rare_disease_replacements_response.rb +478 -0
  368. data/lib/pharmaobservatory/models/rare_disease_replacements_row.rb +344 -0
  369. data/lib/pharmaobservatory/models/rare_disease_site_coverage_response.rb +478 -0
  370. data/lib/pharmaobservatory/models/rare_disease_site_coverage_row.rb +421 -0
  371. data/lib/pharmaobservatory/models/rare_disease_sponsors_response.rb +478 -0
  372. data/lib/pharmaobservatory/models/rare_disease_sponsors_row.rb +575 -0
  373. data/lib/pharmaobservatory/models/rare_disease_trial_coverage_response.rb +478 -0
  374. data/lib/pharmaobservatory/models/rare_disease_trial_coverage_row.rb +449 -0
  375. data/lib/pharmaobservatory/models/rare_disease_trial_sites_response.rb +478 -0
  376. data/lib/pharmaobservatory/models/rare_disease_trial_sites_row.rb +412 -0
  377. data/lib/pharmaobservatory/models/rare_disease_trials_response.rb +478 -0
  378. data/lib/pharmaobservatory/models/rare_disease_trials_row.rb +623 -0
  379. data/lib/pharmaobservatory/models/rare_diseases_record.rb +385 -0
  380. data/lib/pharmaobservatory/models/rare_diseases_record_attributes.rb +238 -0
  381. data/lib/pharmaobservatory/models/rare_diseases_response.rb +478 -0
  382. data/lib/pharmaobservatory/models/rare_diseases_row.rb +500 -0
  383. data/lib/pharmaobservatory/models/recalls_response.rb +478 -0
  384. data/lib/pharmaobservatory/models/recalls_row.rb +421 -0
  385. data/lib/pharmaobservatory/models/rwd_conductor_delivery_response.rb +478 -0
  386. data/lib/pharmaobservatory/models/rwd_conductor_delivery_row.rb +537 -0
  387. data/lib/pharmaobservatory/models/rwd_conductor_footprint_response.rb +478 -0
  388. data/lib/pharmaobservatory/models/rwd_conductor_footprint_row.rb +346 -0
  389. data/lib/pharmaobservatory/models/rwd_conductor_studies_response.rb +478 -0
  390. data/lib/pharmaobservatory/models/rwd_conductor_studies_row.rb +355 -0
  391. data/lib/pharmaobservatory/models/rwd_conductors_record.rb +385 -0
  392. data/lib/pharmaobservatory/models/rwd_conductors_response.rb +478 -0
  393. data/lib/pharmaobservatory/models/rwd_conductors_row.rb +526 -0
  394. data/lib/pharmaobservatory/models/rwd_coverage_response.rb +478 -0
  395. data/lib/pharmaobservatory/models/rwd_coverage_row.rb +410 -0
  396. data/lib/pharmaobservatory/models/rwd_institutions_record.rb +385 -0
  397. data/lib/pharmaobservatory/models/rwd_institutions_response.rb +478 -0
  398. data/lib/pharmaobservatory/models/rwd_institutions_row.rb +981 -0
  399. data/lib/pharmaobservatory/models/rwd_networks_record.rb +385 -0
  400. data/lib/pharmaobservatory/models/rwd_networks_response.rb +478 -0
  401. data/lib/pharmaobservatory/models/rwd_networks_row.rb +733 -0
  402. data/lib/pharmaobservatory/models/rwd_register_provenance_response.rb +478 -0
  403. data/lib/pharmaobservatory/models/rwd_register_provenance_row.rb +531 -0
  404. data/lib/pharmaobservatory/models/rwd_registers_record.rb +385 -0
  405. data/lib/pharmaobservatory/models/rwd_source_age_bands_response.rb +478 -0
  406. data/lib/pharmaobservatory/models/rwd_source_age_bands_row.rb +344 -0
  407. data/lib/pharmaobservatory/models/rwd_source_conditions_response.rb +478 -0
  408. data/lib/pharmaobservatory/models/rwd_source_conditions_row.rb +502 -0
  409. data/lib/pharmaobservatory/models/rwd_source_etl_mappings_response.rb +478 -0
  410. data/lib/pharmaobservatory/models/rwd_source_etl_mappings_row.rb +366 -0
  411. data/lib/pharmaobservatory/models/rwd_source_linkages_response.rb +478 -0
  412. data/lib/pharmaobservatory/models/rwd_source_linkages_row.rb +476 -0
  413. data/lib/pharmaobservatory/models/rwd_source_types_response.rb +478 -0
  414. data/lib/pharmaobservatory/models/rwd_source_types_row.rb +311 -0
  415. data/lib/pharmaobservatory/models/rwd_source_vocabularies_response.rb +478 -0
  416. data/lib/pharmaobservatory/models/rwd_source_vocabularies_row.rb +355 -0
  417. data/lib/pharmaobservatory/models/rwd_sources_record.rb +385 -0
  418. data/lib/pharmaobservatory/models/rwd_sources_response.rb +478 -0
  419. data/lib/pharmaobservatory/models/rwd_sources_row.rb +1674 -0
  420. data/lib/pharmaobservatory/models/rwd_studies_record.rb +385 -0
  421. data/lib/pharmaobservatory/models/rwd_studies_response.rb +478 -0
  422. data/lib/pharmaobservatory/models/rwd_studies_row.rb +1138 -0
  423. data/lib/pharmaobservatory/models/rwd_study_conditions_response.rb +478 -0
  424. data/lib/pharmaobservatory/models/rwd_study_conditions_row.rb +421 -0
  425. data/lib/pharmaobservatory/models/rwd_study_data_sources_response.rb +478 -0
  426. data/lib/pharmaobservatory/models/rwd_study_data_sources_row.rb +423 -0
  427. data/lib/pharmaobservatory/models/rwd_study_drugs_response.rb +478 -0
  428. data/lib/pharmaobservatory/models/rwd_study_drugs_row.rb +401 -0
  429. data/lib/pharmaobservatory/models/rwd_study_milestones_response.rb +478 -0
  430. data/lib/pharmaobservatory/models/rwd_study_milestones_row.rb +421 -0
  431. data/lib/pharmaobservatory/models/rwd_withheld_fields_response.rb +478 -0
  432. data/lib/pharmaobservatory/models/rwd_withheld_fields_row.rb +322 -0
  433. data/lib/pharmaobservatory/models/sbti_crosscheck_response.rb +478 -0
  434. data/lib/pharmaobservatory/models/sbti_crosscheck_row.rb +388 -0
  435. data/lib/pharmaobservatory/models/sec_pdufa_dates_response.rb +478 -0
  436. data/lib/pharmaobservatory/models/sec_pdufa_dates_row.rb +476 -0
  437. data/lib/pharmaobservatory/models/sponsor_delivery_response.rb +478 -0
  438. data/lib/pharmaobservatory/models/sponsor_delivery_row.rb +410 -0
  439. data/lib/pharmaobservatory/models/sponsor_patent_mentions_response.rb +478 -0
  440. data/lib/pharmaobservatory/models/sponsor_patent_mentions_row.rb +355 -0
  441. data/lib/pharmaobservatory/models/sponsor_trial_conditions_response.rb +478 -0
  442. data/lib/pharmaobservatory/models/sponsor_trial_conditions_row.rb +322 -0
  443. data/lib/pharmaobservatory/models/sponsor_trial_drugs_response.rb +478 -0
  444. data/lib/pharmaobservatory/models/sponsor_trial_drugs_row.rb +311 -0
  445. data/lib/pharmaobservatory/models/trial_changes_row.rb +24 -2
  446. data/lib/pharmaobservatory/models/trials_row.rb +47 -3
  447. data/lib/pharmaobservatory/models/unmatched_product_revenue_response.rb +478 -0
  448. data/lib/pharmaobservatory/models/unmatched_product_revenue_row.rb +564 -0
  449. data/lib/pharmaobservatory/models/untitled_letters_response.rb +478 -0
  450. data/lib/pharmaobservatory/models/untitled_letters_row.rb +366 -0
  451. data/lib/pharmaobservatory/models/warning_letters_response.rb +478 -0
  452. data/lib/pharmaobservatory/models/warning_letters_row.rb +399 -0
  453. data/lib/pharmaobservatory/version.rb +1 -1
  454. data/lib/pharmaobservatory.rb +210 -0
  455. metadata +422 -2
@@ -0,0 +1,110 @@
1
+ # PharmaObservatory::RwdNetworksRow
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **network_id** | **String** | The register's own Network ID. The entry key of the rwd_networks object type. | [optional] |
8
+ | **network_name** | **String** | The network's name as the register spells it. | [optional] |
9
+ | **network_name_key** | **String** | The normalised name key the study and member edges join on. | [optional] |
10
+ | **register_state** | **String** | self_registered_profile when the entry declares at least one of description, countries, therapeutic areas or funding source, catalogue_name_entry otherwise. is_encepp_partner is null on a catalogue name entry. | [optional] |
11
+ | **is_self_registered_profile** | **Boolean** | True when registration_state is self_registered_profile. | [optional] |
12
+ | **declared_profile_fields** | **Integer** | How many of the declarable profile fields the entry answered. | [optional] |
13
+ | **declarable_profile_fields** | **Integer** | How many profile fields the register offers; the denominator of declared_profile_fields. | [optional] |
14
+ | **network_countries** | **String** | The country text the network declares, as typed. | [optional] |
15
+ | **primary_therapeutic_disease_areas** | **String** | The primary therapeutic and disease areas the network declares, as typed; blank on most networks, so a facet over it would remove the largest networks. | [optional] |
16
+ | **has_declared_therapeutic_area** | **Boolean** | Whether the network declares a therapeutic area at all (the blank is the registrant's silence). | [optional] |
17
+ | **sources_of_funding** | **String** | The sources of funding the network declares, as typed. | [optional] |
18
+ | **network_website** | **String** | The network's website as the register holds it. | [optional] |
19
+ | **catalogue_url** | **String** | The address of this entry on the HMA-EMA catalogue site (the register's URL LINK). | [optional] |
20
+ | **is_encepp_partner** | **Boolean** | Whether the entry declares an ENCePP partnership; null on a catalogue name entry, where the export writes a default No that is not an answer. | [optional] |
21
+ | **declared_member_count** | **Integer** | How many member institutions the network's own list names; zero says the network named nobody, not that it has no members. | [optional] |
22
+ | **declared_member_name_keys** | **Array<String>** | The normalised name keys of the declared members. | [optional] |
23
+ | **declared_member_names** | **Array<String>** | The names of the declared members as the register spells them. | [optional] |
24
+ | **lists_any_member** | **Boolean** | Whether the network's own list names at least one member. | [optional] |
25
+ | **delivered_studies_lifetime** | **Integer** | Distinct registered studies that named the network. Declared membership and delivered work are different facts and never share a column. | [optional] |
26
+ | **delivered_studies_last_5_years** | **Integer** | Delivered studies that started within five years of the snapshot. | [optional] |
27
+ | **delivered_studies_ongoing** | **Integer** | Delivered studies whose status is Ongoing. | [optional] |
28
+ | **delivered_studies_planned** | **Integer** | Delivered studies whose status is Planned. | [optional] |
29
+ | **most_recent_study_start_on** | **Date** | The latest actual start date among the studies it conducted (or delivered, for a network). | [optional] |
30
+ | **record_updated_at** | **Time** | When the registrant last edited this catalogue entry. A different clock from last_refreshed_on: it dates the web form, not the database. | [optional] |
31
+ | **record_updated_is_mass_edit** | **Boolean** | True when the record's last update date is a mass-edit date: one shared by an outsized part of the register, so it dates a migration and not the registrant. | [optional] |
32
+ | **record_updated_at_attested** | **Time** | record_updated_at with the mass-edit dates removed (null for a mass-edit date or no timestamp): the column to sort a freshness question on. | [optional] |
33
+ | **record_updated_date_share** | **Float** | The share of the register whose last update carries the same date, on every row so a mass-edit date is visible. | [optional] |
34
+ | **record_first_published_at** | **Time** | When the catalogue entry was first published. | [optional] |
35
+ | **is_outdated** | **Boolean** | EMA's own Outdated flag, carried through untouched; the register flags none of the data sources, so read false as EMA's answer and not as a currency finding. | [optional] |
36
+ | **network_register_total** | **Integer** | The number of networks in the whole network register at the snapshot. | [optional] |
37
+ | **networks_listing_any_member** | **Integer** | How many register networks list at least one member. | [optional] |
38
+ | **membership_edge_total** | **Integer** | How many network-to-institution membership edges the member lists hold. | [optional] |
39
+ | **institutions_in_any_member_list** | **Integer** | How many register institutions at least one network member list names. | [optional] |
40
+ | **institution_name_key_total** | **Integer** | How many distinct institution name keys the register holds. | [optional] |
41
+ | **networks_declaring_a_therapeutic_area** | **Integer** | How many register networks declare a therapeutic area. | [optional] |
42
+ | **networks_with_any_delivered_study** | **Integer** | How many register networks at least one registered study named. | [optional] |
43
+ | **self_registered_profile_total** | **Integer** | How many register entries are self-registered profiles. | [optional] |
44
+ | **catalogue_name_entry_total** | **Integer** | How many register entries are catalogue name entries. | [optional] |
45
+ | **self_registered_profile_encepp_yes_total** | **Integer** | How many self-registered networks declare an ENCePP partnership. | [optional] |
46
+ | **catalogue_name_entry_encepp_yes_total** | **Integer** | How many catalogue name entries declare one (the mart nulls the declaration there, so this is the false-No check). | [optional] |
47
+ | **register_source_count** | **Integer** | The number of data sources in the whole data source register at the snapshot: the denominator every source count is over. Not a count of real-world data sources in the world. | [optional] |
48
+ | **study_register_total** | **Integer** | The number of studies in the whole study register at the snapshot. | [optional] |
49
+ | **studies_naming_a_registered_source** | **Integer** | How many registered studies name at least one data source that is itself registered; the denominator under study_count. | [optional] |
50
+ | **snapshot_label** | **String** | The label of the catalogue snapshot the row was read from (a date). | [optional] |
51
+ | **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] |
52
+ | **restriction_tier** | **String** | The license restriction tier of the row's source. Every row of this dataset is licensable (PROVISIONAL, legal read pending). | [optional] |
53
+ | **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] |
54
+
55
+ ## Example
56
+
57
+ ```ruby
58
+ require 'pharmaobservatory'
59
+
60
+ instance = PharmaObservatory::RwdNetworksRow.new(
61
+ network_id: null,
62
+ network_name: null,
63
+ network_name_key: null,
64
+ register_state: null,
65
+ is_self_registered_profile: null,
66
+ declared_profile_fields: null,
67
+ declarable_profile_fields: null,
68
+ network_countries: null,
69
+ primary_therapeutic_disease_areas: null,
70
+ has_declared_therapeutic_area: null,
71
+ sources_of_funding: null,
72
+ network_website: null,
73
+ catalogue_url: null,
74
+ is_encepp_partner: null,
75
+ declared_member_count: null,
76
+ declared_member_name_keys: null,
77
+ declared_member_names: null,
78
+ lists_any_member: null,
79
+ delivered_studies_lifetime: null,
80
+ delivered_studies_last_5_years: null,
81
+ delivered_studies_ongoing: null,
82
+ delivered_studies_planned: null,
83
+ most_recent_study_start_on: null,
84
+ record_updated_at: null,
85
+ record_updated_is_mass_edit: null,
86
+ record_updated_at_attested: null,
87
+ record_updated_date_share: null,
88
+ record_first_published_at: null,
89
+ is_outdated: null,
90
+ network_register_total: null,
91
+ networks_listing_any_member: null,
92
+ membership_edge_total: null,
93
+ institutions_in_any_member_list: null,
94
+ institution_name_key_total: null,
95
+ networks_declaring_a_therapeutic_area: null,
96
+ networks_with_any_delivered_study: null,
97
+ self_registered_profile_total: null,
98
+ catalogue_name_entry_total: null,
99
+ self_registered_profile_encepp_yes_total: null,
100
+ catalogue_name_entry_encepp_yes_total: null,
101
+ register_source_count: null,
102
+ study_register_total: null,
103
+ studies_naming_a_registered_source: null,
104
+ snapshot_label: null,
105
+ accessed_month: null,
106
+ restriction_tier: null,
107
+ attribution: null
108
+ )
109
+ ```
110
+
@@ -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
+
@@ -0,0 +1,313 @@
1
+ # PharmaObservatory::RwdRegistersApi
2
+
3
+ All URIs are relative to *https://pharmaobservatory.com*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**rwd_registers_get**](RwdRegistersApi.md#rwd_registers_get) | **GET** /api/v1/rwd_registers/{id} | One real-world data register |
8
+ | [**rwd_registers_list**](RwdRegistersApi.md#rwd_registers_list) | **GET** /api/v1/rwd_registers | List real-world data registers |
9
+ | [**rwd_registers_rwd_coverage**](RwdRegistersApi.md#rwd_registers_rwd_coverage) | **GET** /api/v1/rwd_registers/{id}/rwd_coverage | HMA-EMA catalogue denominator chains |
10
+ | [**rwd_registers_rwd_withheld_fields**](RwdRegistersApi.md#rwd_registers_rwd_withheld_fields) | **GET** /api/v1/rwd_registers/{id}/rwd_withheld_fields | HMA-EMA catalogue columns withheld from publication |
11
+
12
+
13
+ ## rwd_registers_get
14
+
15
+ > <RwdRegistersRecord> rwd_registers_get(id)
16
+
17
+ One real-world data register
18
+
19
+ ### Examples
20
+
21
+ ```ruby
22
+ require 'time'
23
+ require 'pharmaobservatory'
24
+ # setup authorization
25
+ PharmaObservatory.configure do |config|
26
+ # Configure Bearer authorization (JWT): ApiBearerJwt
27
+ config.access_token = 'YOUR_BEARER_TOKEN'
28
+ end
29
+
30
+ api_instance = PharmaObservatory::RwdRegistersApi.new
31
+ id = 'study' # String |
32
+
33
+ begin
34
+ # One real-world data register
35
+ result = api_instance.rwd_registers_get(id)
36
+ p result
37
+ rescue PharmaObservatory::ApiError => e
38
+ puts "Error when calling RwdRegistersApi->rwd_registers_get: #{e}"
39
+ end
40
+ ```
41
+
42
+ #### Using the rwd_registers_get_with_http_info variant
43
+
44
+ This returns an Array which contains the response data, status code and headers.
45
+
46
+ > <Array(<RwdRegistersRecord>, Integer, Hash)> rwd_registers_get_with_http_info(id)
47
+
48
+ ```ruby
49
+ begin
50
+ # One real-world data register
51
+ data, status_code, headers = api_instance.rwd_registers_get_with_http_info(id)
52
+ p status_code # => 2xx
53
+ p headers # => { ... }
54
+ p data # => <RwdRegistersRecord>
55
+ rescue PharmaObservatory::ApiError => e
56
+ puts "Error when calling RwdRegistersApi->rwd_registers_get_with_http_info: #{e}"
57
+ end
58
+ ```
59
+
60
+ ### Parameters
61
+
62
+ | Name | Type | Description | Notes |
63
+ | ---- | ---- | ----------- | ----- |
64
+ | **id** | **String** | | |
65
+
66
+ ### Return type
67
+
68
+ [**RwdRegistersRecord**](RwdRegistersRecord.md)
69
+
70
+ ### Authorization
71
+
72
+ [ApiBearerJwt](../README.md#ApiBearerJwt)
73
+
74
+ ### HTTP request headers
75
+
76
+ - **Content-Type**: Not defined
77
+ - **Accept**: application/json
78
+
79
+
80
+ ## rwd_registers_list
81
+
82
+ > <RwdRegisterProvenanceResponse> rwd_registers_list(opts)
83
+
84
+ List real-world data registers
85
+
86
+ ### Examples
87
+
88
+ ```ruby
89
+ require 'time'
90
+ require 'pharmaobservatory'
91
+ # setup authorization
92
+ PharmaObservatory.configure do |config|
93
+ # Configure Bearer authorization (JWT): ApiBearerJwt
94
+ config.access_token = 'YOUR_BEARER_TOKEN'
95
+ end
96
+
97
+ api_instance = PharmaObservatory::RwdRegistersApi.new
98
+ opts = {
99
+ cursor: 'cursor_example', # String | The next_cursor of the previous page. Opaque; it is bound to the filters and the warehouse build that issued it.
100
+ limit: 56, # Integer | Rows per page, up to 500 (default 50).
101
+ sort: 'sort_example', # String | Comma separated columns, a leading minus for descending: sort=a,-b.
102
+ group_by: 'group_by_example', # String | A dimension to group by; a date takes :year, :quarter or :month.
103
+ measure: 'measure_example' # String | count, sum(col), avg(col), min(col), max(col), median(col) or count_distinct(col).
104
+ }
105
+
106
+ begin
107
+ # List real-world data registers
108
+ result = api_instance.rwd_registers_list(opts)
109
+ p result
110
+ rescue PharmaObservatory::ApiError => e
111
+ puts "Error when calling RwdRegistersApi->rwd_registers_list: #{e}"
112
+ end
113
+ ```
114
+
115
+ #### Using the rwd_registers_list_with_http_info variant
116
+
117
+ This returns an Array which contains the response data, status code and headers.
118
+
119
+ > <Array(<RwdRegisterProvenanceResponse>, Integer, Hash)> rwd_registers_list_with_http_info(opts)
120
+
121
+ ```ruby
122
+ begin
123
+ # List real-world data registers
124
+ data, status_code, headers = api_instance.rwd_registers_list_with_http_info(opts)
125
+ p status_code # => 2xx
126
+ p headers # => { ... }
127
+ p data # => <RwdRegisterProvenanceResponse>
128
+ rescue PharmaObservatory::ApiError => e
129
+ puts "Error when calling RwdRegistersApi->rwd_registers_list_with_http_info: #{e}"
130
+ end
131
+ ```
132
+
133
+ ### Parameters
134
+
135
+ | Name | Type | Description | Notes |
136
+ | ---- | ---- | ----------- | ----- |
137
+ | **cursor** | **String** | The next_cursor of the previous page. Opaque; it is bound to the filters and the warehouse build that issued it. | [optional] |
138
+ | **limit** | **Integer** | Rows per page, up to 500 (default 50). | [optional] |
139
+ | **sort** | **String** | Comma separated columns, a leading minus for descending: sort&#x3D;a,-b. | [optional] |
140
+ | **group_by** | **String** | A dimension to group by; a date takes :year, :quarter or :month. | [optional] |
141
+ | **measure** | **String** | count, sum(col), avg(col), min(col), max(col), median(col) or count_distinct(col). | [optional] |
142
+
143
+ ### Return type
144
+
145
+ [**RwdRegisterProvenanceResponse**](RwdRegisterProvenanceResponse.md)
146
+
147
+ ### Authorization
148
+
149
+ [ApiBearerJwt](../README.md#ApiBearerJwt)
150
+
151
+ ### HTTP request headers
152
+
153
+ - **Content-Type**: Not defined
154
+ - **Accept**: application/json
155
+
156
+
157
+ ## rwd_registers_rwd_coverage
158
+
159
+ > <RwdCoverageResponse> rwd_registers_rwd_coverage(id, opts)
160
+
161
+ HMA-EMA catalogue denominator chains
162
+
163
+ ### Examples
164
+
165
+ ```ruby
166
+ require 'time'
167
+ require 'pharmaobservatory'
168
+ # setup authorization
169
+ PharmaObservatory.configure do |config|
170
+ # Configure Bearer authorization (JWT): ApiBearerJwt
171
+ config.access_token = 'YOUR_BEARER_TOKEN'
172
+ end
173
+
174
+ api_instance = PharmaObservatory::RwdRegistersApi.new
175
+ id = 'study' # String |
176
+ opts = {
177
+ cursor: 'cursor_example', # String | The next_cursor of the previous page. Opaque; it is bound to the filters and the warehouse build that issued it.
178
+ limit: 56, # Integer | Rows per page, up to 500 (default 50).
179
+ sort: 'sort_example', # String | Comma separated columns, a leading minus for descending: sort=a,-b.
180
+ group_by: 'group_by_example', # String | A dimension to group by; a date takes :year, :quarter or :month.
181
+ measure: 'measure_example' # String | count, sum(col), avg(col), min(col), max(col), median(col) or count_distinct(col).
182
+ }
183
+
184
+ begin
185
+ # HMA-EMA catalogue denominator chains
186
+ result = api_instance.rwd_registers_rwd_coverage(id, opts)
187
+ p result
188
+ rescue PharmaObservatory::ApiError => e
189
+ puts "Error when calling RwdRegistersApi->rwd_registers_rwd_coverage: #{e}"
190
+ end
191
+ ```
192
+
193
+ #### Using the rwd_registers_rwd_coverage_with_http_info variant
194
+
195
+ This returns an Array which contains the response data, status code and headers.
196
+
197
+ > <Array(<RwdCoverageResponse>, Integer, Hash)> rwd_registers_rwd_coverage_with_http_info(id, opts)
198
+
199
+ ```ruby
200
+ begin
201
+ # HMA-EMA catalogue denominator chains
202
+ data, status_code, headers = api_instance.rwd_registers_rwd_coverage_with_http_info(id, opts)
203
+ p status_code # => 2xx
204
+ p headers # => { ... }
205
+ p data # => <RwdCoverageResponse>
206
+ rescue PharmaObservatory::ApiError => e
207
+ puts "Error when calling RwdRegistersApi->rwd_registers_rwd_coverage_with_http_info: #{e}"
208
+ end
209
+ ```
210
+
211
+ ### Parameters
212
+
213
+ | Name | Type | Description | Notes |
214
+ | ---- | ---- | ----------- | ----- |
215
+ | **id** | **String** | | |
216
+ | **cursor** | **String** | The next_cursor of the previous page. Opaque; it is bound to the filters and the warehouse build that issued it. | [optional] |
217
+ | **limit** | **Integer** | Rows per page, up to 500 (default 50). | [optional] |
218
+ | **sort** | **String** | Comma separated columns, a leading minus for descending: sort&#x3D;a,-b. | [optional] |
219
+ | **group_by** | **String** | A dimension to group by; a date takes :year, :quarter or :month. | [optional] |
220
+ | **measure** | **String** | count, sum(col), avg(col), min(col), max(col), median(col) or count_distinct(col). | [optional] |
221
+
222
+ ### Return type
223
+
224
+ [**RwdCoverageResponse**](RwdCoverageResponse.md)
225
+
226
+ ### Authorization
227
+
228
+ [ApiBearerJwt](../README.md#ApiBearerJwt)
229
+
230
+ ### HTTP request headers
231
+
232
+ - **Content-Type**: Not defined
233
+ - **Accept**: application/json
234
+
235
+
236
+ ## rwd_registers_rwd_withheld_fields
237
+
238
+ > <RwdWithheldFieldsResponse> rwd_registers_rwd_withheld_fields(id, opts)
239
+
240
+ HMA-EMA catalogue columns withheld from publication
241
+
242
+ ### Examples
243
+
244
+ ```ruby
245
+ require 'time'
246
+ require 'pharmaobservatory'
247
+ # setup authorization
248
+ PharmaObservatory.configure do |config|
249
+ # Configure Bearer authorization (JWT): ApiBearerJwt
250
+ config.access_token = 'YOUR_BEARER_TOKEN'
251
+ end
252
+
253
+ api_instance = PharmaObservatory::RwdRegistersApi.new
254
+ id = 'study' # String |
255
+ opts = {
256
+ cursor: 'cursor_example', # String | The next_cursor of the previous page. Opaque; it is bound to the filters and the warehouse build that issued it.
257
+ limit: 56, # Integer | Rows per page, up to 500 (default 50).
258
+ sort: 'sort_example', # String | Comma separated columns, a leading minus for descending: sort=a,-b.
259
+ group_by: 'group_by_example', # String | A dimension to group by; a date takes :year, :quarter or :month.
260
+ measure: 'measure_example' # String | count, sum(col), avg(col), min(col), max(col), median(col) or count_distinct(col).
261
+ }
262
+
263
+ begin
264
+ # HMA-EMA catalogue columns withheld from publication
265
+ result = api_instance.rwd_registers_rwd_withheld_fields(id, opts)
266
+ p result
267
+ rescue PharmaObservatory::ApiError => e
268
+ puts "Error when calling RwdRegistersApi->rwd_registers_rwd_withheld_fields: #{e}"
269
+ end
270
+ ```
271
+
272
+ #### Using the rwd_registers_rwd_withheld_fields_with_http_info variant
273
+
274
+ This returns an Array which contains the response data, status code and headers.
275
+
276
+ > <Array(<RwdWithheldFieldsResponse>, Integer, Hash)> rwd_registers_rwd_withheld_fields_with_http_info(id, opts)
277
+
278
+ ```ruby
279
+ begin
280
+ # HMA-EMA catalogue columns withheld from publication
281
+ data, status_code, headers = api_instance.rwd_registers_rwd_withheld_fields_with_http_info(id, opts)
282
+ p status_code # => 2xx
283
+ p headers # => { ... }
284
+ p data # => <RwdWithheldFieldsResponse>
285
+ rescue PharmaObservatory::ApiError => e
286
+ puts "Error when calling RwdRegistersApi->rwd_registers_rwd_withheld_fields_with_http_info: #{e}"
287
+ end
288
+ ```
289
+
290
+ ### Parameters
291
+
292
+ | Name | Type | Description | Notes |
293
+ | ---- | ---- | ----------- | ----- |
294
+ | **id** | **String** | | |
295
+ | **cursor** | **String** | The next_cursor of the previous page. Opaque; it is bound to the filters and the warehouse build that issued it. | [optional] |
296
+ | **limit** | **Integer** | Rows per page, up to 500 (default 50). | [optional] |
297
+ | **sort** | **String** | Comma separated columns, a leading minus for descending: sort&#x3D;a,-b. | [optional] |
298
+ | **group_by** | **String** | A dimension to group by; a date takes :year, :quarter or :month. | [optional] |
299
+ | **measure** | **String** | count, sum(col), avg(col), min(col), max(col), median(col) or count_distinct(col). | [optional] |
300
+
301
+ ### Return type
302
+
303
+ [**RwdWithheldFieldsResponse**](RwdWithheldFieldsResponse.md)
304
+
305
+ ### Authorization
306
+
307
+ [ApiBearerJwt](../README.md#ApiBearerJwt)
308
+
309
+ ### HTTP request headers
310
+
311
+ - **Content-Type**: Not defined
312
+ - **Accept**: application/json
313
+
@@ -0,0 +1,38 @@
1
+ # PharmaObservatory::RwdRegistersRecord
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **object_type** | **String** | | |
8
+ | **id** | **String** | | |
9
+ | **record** | [**RwdRegisterProvenanceRow**](RwdRegisterProvenanceRow.md) | | |
10
+ | **attributes** | **Object** | | [optional] |
11
+ | **datasets** | [**Array&lt;DatasetListing&gt;**](DatasetListing.md) | | |
12
+ | **attribution** | [**Array&lt;DatasetAttribution&gt;**](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&lt;String, Object&gt;** | | [optional] |
18
+
19
+ ## Example
20
+
21
+ ```ruby
22
+ require 'pharmaobservatory'
23
+
24
+ instance = PharmaObservatory::RwdRegistersRecord.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,58 @@
1
+ # PharmaObservatory::RwdSourceAgeBandsResponse
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&lt;DatasetColumn&gt;**](DatasetColumn.md) | | |
13
+ | **rows** | [**Array&lt;RwdSourceAgeBandsRow&gt;**](RwdSourceAgeBandsRow.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&lt;String&gt;** | | [optional] |
17
+ | **filters** | **Array&lt;Hash&lt;String, Object&gt;&gt;** | | [optional] |
18
+ | **group_by** | **Array&lt;String&gt;** | | [optional] |
19
+ | **measures** | **Array&lt;String&gt;** | | [optional] |
20
+ | **attribution** | [**Array&lt;DatasetAttribution&gt;**](DatasetAttribution.md) | | [optional] |
21
+ | **source_credit** | **String** | | [optional] |
22
+ | **withheld_tiers** | **Array&lt;String&gt;** | | [optional] |
23
+ | **withheld_columns** | **Array&lt;String&gt;** | | [optional] |
24
+ | **freshness** | [**BiomarkerAssayEvidenceResponseFreshness**](BiomarkerAssayEvidenceResponseFreshness.md) | | [optional] |
25
+ | **build** | [**BiomarkerAssayEvidenceResponseBuild**](BiomarkerAssayEvidenceResponseBuild.md) | | [optional] |
26
+ | **build_state** | [**DatasetBuildState**](DatasetBuildState.md) | | [optional] |
27
+ | **restriction** | **Hash&lt;String, Object&gt;** | | [optional] |
28
+
29
+ ## Example
30
+
31
+ ```ruby
32
+ require 'pharmaobservatory'
33
+
34
+ instance = PharmaObservatory::RwdSourceAgeBandsResponse.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
+