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,58 @@
1
+ # PharmaObservatory::SponsorTrialDrugsResponse
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<SponsorTrialDrugsRow>**](SponsorTrialDrugsRow.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::SponsorTrialDrugsResponse.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,34 @@
1
+ # PharmaObservatory::SponsorTrialDrugsRow
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **sponsor_org_id** | **String** | Legal-entity level: the organization record of the sponsor as filed. | [optional] |
8
+ | **sponsor_name** | **String** | Display name of the sponsor organization record. | [optional] |
9
+ | **sponsor_company_id** | **String** | Company level: the company the sponsor belongs to (null when unresolved). | [optional] |
10
+ | **sponsor_company_name** | **String** | Display name of the sponsor's company. | [optional] |
11
+ | **sponsor_group_id** | **String** | Group level: the sponsor's current ultimate parent company; a root company's group is itself. | [optional] |
12
+ | **sponsor_group_name** | **String** | Display name of the sponsor's group. | [optional] |
13
+ | **sponsor_role** | **String** | lead or collaborator. | [optional] |
14
+ | **trial_id** | **String** | The trial's ClinicalTrials.gov registry id (NCT, National Clinical Trial, number). | [optional] |
15
+ | **drug_name** | **String** | The drug intervention name as the trial registers it. | [optional] |
16
+
17
+ ## Example
18
+
19
+ ```ruby
20
+ require 'pharmaobservatory'
21
+
22
+ instance = PharmaObservatory::SponsorTrialDrugsRow.new(
23
+ sponsor_org_id: null,
24
+ sponsor_name: null,
25
+ sponsor_company_id: null,
26
+ sponsor_company_name: null,
27
+ sponsor_group_id: null,
28
+ sponsor_group_name: null,
29
+ sponsor_role: null,
30
+ trial_id: null,
31
+ drug_name: null
32
+ )
33
+ ```
34
+
@@ -4,7 +4,9 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **trial_id** | **String** | The trial's ClinicalTrials.gov registry id (NCT, National Clinical Trial, number). | [optional] |
7
+ | **trial_id** | **String** | The trial's id: the ClinicalTrials.gov registry id (NCT, National Clinical Trial, number), or the WHO TrialID of a trial registered only with a WHO ICTRP member registry. | [optional] |
8
+ | **source_registry** | **String** | The registry source of the trial: clinicaltrials or ictrp (a trial registered only with a WHO ICTRP member registry). | [optional] |
9
+ | **restriction_tier** | **String** | none for a change to a ClinicalTrials.gov trial; licensable for a change to a WHO ICTRP trial, which only a caller holding the licensable tier receives. | [optional] |
8
10
  | **observed_at** | **Time** | When the platform observed the change. | [optional] |
9
11
  | **event_type** | **String** | The kind of event (first_seen, status_change and so on). | [optional] |
10
12
  | **field** | **String** | The record field that changed (null for a first_seen event). | [optional] |
@@ -22,6 +24,8 @@ require 'pharmaobservatory'
22
24
 
23
25
  instance = PharmaObservatory::TrialChangesRow.new(
24
26
  trial_id: null,
27
+ source_registry: null,
28
+ restriction_tier: null,
25
29
  observed_at: null,
26
30
  event_type: null,
27
31
  field: null,
data/docs/TrialsApi.md CHANGED
@@ -4,6 +4,7 @@ All URIs are relative to *https://pharmaobservatory.com*
4
4
 
5
5
  | Method | HTTP request | Description |
6
6
  | ------ | ------------ | ----------- |
7
+ | [**trials_cro_trials**](TrialsApi.md#trials_cro_trials) | **GET** /api/v1/trials/{id}/cro_trials | CRO trials |
7
8
  | [**trials_get**](TrialsApi.md#trials_get) | **GET** /api/v1/trials/{id} | One trial |
8
9
  | [**trials_list**](TrialsApi.md#trials_list) | **GET** /api/v1/trials | List trials |
9
10
  | [**trials_sponsor_trials**](TrialsApi.md#trials_sponsor_trials) | **GET** /api/v1/trials/{id}/sponsor_trials | Sponsor trials |
@@ -23,6 +24,85 @@ All URIs are relative to *https://pharmaobservatory.com*
23
24
  | [**trials_trial_sites**](TrialsApi.md#trials_trial_sites) | **GET** /api/v1/trials/{id}/trial_sites | Trial sites |
24
25
 
25
26
 
27
+ ## trials_cro_trials
28
+
29
+ > <CroTrialsResponse> trials_cro_trials(id, opts)
30
+
31
+ CRO trials
32
+
33
+ ### Examples
34
+
35
+ ```ruby
36
+ require 'time'
37
+ require 'pharmaobservatory'
38
+ # setup authorization
39
+ PharmaObservatory.configure do |config|
40
+ # Configure Bearer authorization (JWT): ApiBearerJwt
41
+ config.access_token = 'YOUR_BEARER_TOKEN'
42
+ end
43
+
44
+ api_instance = PharmaObservatory::TrialsApi.new
45
+ id = 'NCT00000125' # String |
46
+ opts = {
47
+ 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.
48
+ limit: 56, # Integer | Rows per page, up to 500 (default 50).
49
+ sort: 'sort_example', # String | Comma separated columns, a leading minus for descending: sort=a,-b.
50
+ group_by: 'group_by_example', # String | A dimension to group by; a date takes :year, :quarter or :month.
51
+ measure: 'measure_example' # String | count, sum(col), avg(col), min(col), max(col), median(col) or count_distinct(col).
52
+ }
53
+
54
+ begin
55
+ # CRO trials
56
+ result = api_instance.trials_cro_trials(id, opts)
57
+ p result
58
+ rescue PharmaObservatory::ApiError => e
59
+ puts "Error when calling TrialsApi->trials_cro_trials: #{e}"
60
+ end
61
+ ```
62
+
63
+ #### Using the trials_cro_trials_with_http_info variant
64
+
65
+ This returns an Array which contains the response data, status code and headers.
66
+
67
+ > <Array(<CroTrialsResponse>, Integer, Hash)> trials_cro_trials_with_http_info(id, opts)
68
+
69
+ ```ruby
70
+ begin
71
+ # CRO trials
72
+ data, status_code, headers = api_instance.trials_cro_trials_with_http_info(id, opts)
73
+ p status_code # => 2xx
74
+ p headers # => { ... }
75
+ p data # => <CroTrialsResponse>
76
+ rescue PharmaObservatory::ApiError => e
77
+ puts "Error when calling TrialsApi->trials_cro_trials_with_http_info: #{e}"
78
+ end
79
+ ```
80
+
81
+ ### Parameters
82
+
83
+ | Name | Type | Description | Notes |
84
+ | ---- | ---- | ----------- | ----- |
85
+ | **id** | **String** | | |
86
+ | **cursor** | **String** | The next_cursor of the previous page. Opaque; it is bound to the filters and the warehouse build that issued it. | [optional] |
87
+ | **limit** | **Integer** | Rows per page, up to 500 (default 50). | [optional] |
88
+ | **sort** | **String** | Comma separated columns, a leading minus for descending: sort&#x3D;a,-b. | [optional] |
89
+ | **group_by** | **String** | A dimension to group by; a date takes :year, :quarter or :month. | [optional] |
90
+ | **measure** | **String** | count, sum(col), avg(col), min(col), max(col), median(col) or count_distinct(col). | [optional] |
91
+
92
+ ### Return type
93
+
94
+ [**CroTrialsResponse**](CroTrialsResponse.md)
95
+
96
+ ### Authorization
97
+
98
+ [ApiBearerJwt](../README.md#ApiBearerJwt)
99
+
100
+ ### HTTP request headers
101
+
102
+ - **Content-Type**: Not defined
103
+ - **Accept**: application/json
104
+
105
+
26
106
  ## trials_get
27
107
 
28
108
  > <TrialsRecord> trials_get(id)
data/docs/TrialsRow.md CHANGED
@@ -4,7 +4,11 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **trial_id** | **String** | The trial&#39;s ClinicalTrials.gov registry id (NCT, National Clinical Trial, number). | [optional] |
7
+ | **trial_id** | **String** | The trial&#39;s id: the ClinicalTrials.gov registry id (NCT, National Clinical Trial, number), or the WHO TrialID of a trial registered only with a WHO ICTRP member registry. | [optional] |
8
+ | **nct_id** | **String** | The ClinicalTrials.gov registry id; null for a trial registered only with a WHO ICTRP member registry. | [optional] |
9
+ | **source_registry** | **String** | The registry source of the row: clinicaltrials or ictrp (a trial registered only with a WHO ICTRP member registry). | [optional] |
10
+ | **registry** | **String** | The registry that holds the record: NCT for ClinicalTrials.gov, or a WHO ICTRP member registry (ChiCTR, ISRCTN, CTIS, ACTRN, NL, KCT, EUCTR and so on). | [optional] |
11
+ | **restriction_tier** | **String** | none for a ClinicalTrials.gov trial; licensable for a WHO ICTRP trial, which only a caller holding the licensable tier receives. | [optional] |
8
12
  | **brief_title** | **String** | The trial&#39;s brief title. | [optional] |
9
13
  | **official_title** | **String** | The trial&#39;s official title. | [optional] |
10
14
  | **study_type** | **String** | INTERVENTIONAL, OBSERVATIONAL or EXPANDED_ACCESS. | [optional] |
@@ -62,6 +66,10 @@ require 'pharmaobservatory'
62
66
 
63
67
  instance = PharmaObservatory::TrialsRow.new(
64
68
  trial_id: null,
69
+ nct_id: null,
70
+ source_registry: null,
71
+ registry: null,
72
+ restriction_tier: null,
65
73
  brief_title: null,
66
74
  official_title: null,
67
75
  study_type: null,
@@ -0,0 +1,58 @@
1
+ # PharmaObservatory::UnmatchedProductRevenueResponse
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;UnmatchedProductRevenueRow&gt;**](UnmatchedProductRevenueRow.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::UnmatchedProductRevenueResponse.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,80 @@
1
+ # PharmaObservatory::UnmatchedProductRevenueRow
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **revenue_line_id** | **String** | The revenue line id: a hash of the document, product name, fiscal year, basis and geography. | [optional] |
8
+ | **filer_cik** | **String** | The filer&#39;s SEC Central Index Key, ten digits. | [optional] |
9
+ | **filer_name** | **String** | The filer&#39;s name as filed (the reporting company of the document). | [optional] |
10
+ | **filer_org_id** | **String** | Legal-entity level: the filer&#39;s organization record, edgar:&lt;cik&gt; when that record exists, else the single record carrying the CIK (null when none; the CIK is kept). | [optional] |
11
+ | **filer_company_id** | **String** | Company level: the filer&#39;s company (null when the organization does not resolve to a company). | [optional] |
12
+ | **filer_company_name** | **String** | Display name of the filer&#39;s company. | [optional] |
13
+ | **filer_group_id** | **String** | Group level: the filer&#39;s current ultimate parent company; a root company&#39;s group is itself. | [optional] |
14
+ | **filer_group_name** | **String** | Display name of the filer&#39;s group. | [optional] |
15
+ | **document_id** | **String** | The extracted filing document id. | [optional] |
16
+ | **accession_number** | **String** | The SEC accession number of the filing. | [optional] |
17
+ | **form** | **String** | The SEC form the line was extracted from (10-K or 20-F). | [optional] |
18
+ | **filing_date** | **Date** | The filing date of the document. | [optional] |
19
+ | **fiscal_year_covered** | **Integer** | The fiscal year the document covers, as the extraction states it. | [optional] |
20
+ | **product_name** | **String** | The product name as filed, never a drug name: the brand gate did not claim it, and devices, services and apparel that share a word with a drug land here by design. | [optional] |
21
+ | **cleaned_key** | **String** | The product name reduced to its brand-alias key, the form the nearest-name pointer compares. | [optional] |
22
+ | **fiscal_year** | **Integer** | The fiscal year the line reports revenue for. | [optional] |
23
+ | **revenue_basis** | **String** | What the line&#39;s revenue covers, as the extraction states it: worldwide, us, ex_us, region or country. | [optional] |
24
+ | **geography** | **String** | The region or country the line covers, as filed; null for a worldwide or us line. | [optional] |
25
+ | **revenue_amount** | **Float** | The revenue as filed, in the currency and unit the line states (revenue_currency and reporting_unit). | [optional] |
26
+ | **revenue_currency** | **String** | The currency the line states its revenue in. | [optional] |
27
+ | **reporting_unit** | **String** | The unit the document states its amounts in (units, thousands, millions or billions). | [optional] |
28
+ | **revenue_usd_millions** | **Float** | The line&#39;s revenue in US dollars millions: the amount normalized by reporting_unit, then converted at the annual average exchange rate of the filing&#39;s fiscal year. Null when the unit is unreadable or no rate exists for that currency and year. The extractor&#39;s own USD figure is not published, because it reads 0 for a non-USD line. | [optional] |
29
+ | **is_latest_worldwide_line** | **Boolean** | True for the single worldwide line per filer and product with a USD figure from the latest fiscal year (the line the residual mart takes as the product&#39;s latest worldwide figure; ties broken by the headline filing, then the earlier filing date). | [optional] |
30
+ | **product_line_count** | **Integer** | How many extracted lines the product has, repeated on every line of the product. | [optional] |
31
+ | **best_alias_key** | **String** | The nearest trade-name alias by trigram similarity: a pointer for a person to decide on, not a match. Null when no alias is close enough. | [optional] |
32
+ | **best_alias_brand_key** | **String** | The brand key of the nearest alias. | [optional] |
33
+ | **best_alias_similarity** | **Float** | The trigram similarity between cleaned_key and best_alias_key, 0 to 1. | [optional] |
34
+ | **brand_or_generic** | **String** | The extraction&#39;s own label for the product (brand, generic, franchise and so on). | [optional] |
35
+ | **indication** | **String** | The indication the extraction attached to the product, as filed. | [optional] |
36
+ | **evidence_quote** | **String** | The filing&#39;s own text the line was extracted from. | [optional] |
37
+ | **extraction_confidence** | **Float** | The language model&#39;s self-reported confidence for the line, 0 to 1; not a reliability measure. | [optional] |
38
+ | **source_url** | **String** | The link to the filing on SEC EDGAR. | [optional] |
39
+
40
+ ## Example
41
+
42
+ ```ruby
43
+ require 'pharmaobservatory'
44
+
45
+ instance = PharmaObservatory::UnmatchedProductRevenueRow.new(
46
+ revenue_line_id: null,
47
+ filer_cik: null,
48
+ filer_name: null,
49
+ filer_org_id: null,
50
+ filer_company_id: null,
51
+ filer_company_name: null,
52
+ filer_group_id: null,
53
+ filer_group_name: null,
54
+ document_id: null,
55
+ accession_number: null,
56
+ form: null,
57
+ filing_date: null,
58
+ fiscal_year_covered: null,
59
+ product_name: null,
60
+ cleaned_key: null,
61
+ fiscal_year: null,
62
+ revenue_basis: null,
63
+ geography: null,
64
+ revenue_amount: null,
65
+ revenue_currency: null,
66
+ reporting_unit: null,
67
+ revenue_usd_millions: null,
68
+ is_latest_worldwide_line: null,
69
+ product_line_count: null,
70
+ best_alias_key: null,
71
+ best_alias_brand_key: null,
72
+ best_alias_similarity: null,
73
+ brand_or_generic: null,
74
+ indication: null,
75
+ evidence_quote: null,
76
+ extraction_confidence: null,
77
+ source_url: null
78
+ )
79
+ ```
80
+
@@ -0,0 +1,58 @@
1
+ # PharmaObservatory::UntitledLettersResponse
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;UntitledLettersRow&gt;**](UntitledLettersRow.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::UntitledLettersResponse.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,44 @@
1
+ # PharmaObservatory::UntitledLettersRow
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **letter_id** | **String** | The letter id. | [optional] |
8
+ | **letter_url** | **String** | The FDA page of the letter. | [optional] |
9
+ | **firm_name** | **String** | The firm&#39;s name as filed with the regulator. | [optional] |
10
+ | **firm_org_id** | **String** | Legal-entity level: the organization record the firm resolved to (null when the firm did not resolve). | [optional] |
11
+ | **firm_company_id** | **String** | Company level: the firm&#39;s company (null when unresolved); the entry key for the companies object type. | [optional] |
12
+ | **firm_company_name** | **String** | Display name of the firm&#39;s company. | [optional] |
13
+ | **firm_group_id** | **String** | Group level: the firm&#39;s current ultimate parent; a root&#39;s group is itself. | [optional] |
14
+ | **firm_group_name** | **String** | Display name of the firm&#39;s group. | [optional] |
15
+ | **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] |
16
+ | **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] |
17
+ | **product_issue** | **String** | The product and the issue the letter raises (for example the promotional claim). | [optional] |
18
+ | **issue_date** | **Date** | The date the letter was issued. | [optional] |
19
+ | **response_letter_url** | **String** | The firm&#39;s response letter on the FDA site, where one is posted. | [optional] |
20
+ | **closeout_letter_url** | **String** | The FDA close-out letter, where one is posted. | [optional] |
21
+
22
+ ## Example
23
+
24
+ ```ruby
25
+ require 'pharmaobservatory'
26
+
27
+ instance = PharmaObservatory::UntitledLettersRow.new(
28
+ letter_id: null,
29
+ letter_url: null,
30
+ firm_name: null,
31
+ firm_org_id: null,
32
+ firm_company_id: null,
33
+ firm_company_name: null,
34
+ firm_group_id: null,
35
+ firm_group_name: null,
36
+ is_org_resolved: null,
37
+ match_tier: null,
38
+ product_issue: null,
39
+ issue_date: null,
40
+ response_letter_url: null,
41
+ closeout_letter_url: null
42
+ )
43
+ ```
44
+
@@ -0,0 +1,58 @@
1
+ # PharmaObservatory::WarningLettersResponse
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;WarningLettersRow&gt;**](WarningLettersRow.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::WarningLettersResponse.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,50 @@
1
+ # PharmaObservatory::WarningLettersRow
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **letter_id** | **String** | The letter id. | [optional] |
8
+ | **letter_url** | **String** | The FDA page of the letter. | [optional] |
9
+ | **firm_name** | **String** | The firm&#39;s name as filed with the regulator. | [optional] |
10
+ | **firm_org_id** | **String** | Legal-entity level: the organization record the firm resolved to (null when the firm did not resolve). | [optional] |
11
+ | **firm_company_id** | **String** | Company level: the firm&#39;s company (null when unresolved); the entry key for the companies object type. | [optional] |
12
+ | **firm_company_name** | **String** | Display name of the firm&#39;s company. | [optional] |
13
+ | **firm_group_id** | **String** | Group level: the firm&#39;s current ultimate parent; a root&#39;s group is itself. | [optional] |
14
+ | **firm_group_name** | **String** | Display name of the firm&#39;s group. | [optional] |
15
+ | **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] |
16
+ | **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] |
17
+ | **issuing_office** | **String** | The FDA office that issued the letter (a center or a district office). | [optional] |
18
+ | **subject** | **String** | The letter&#39;s subject line. | [optional] |
19
+ | **excerpt** | **String** | An excerpt of the letter text. | [optional] |
20
+ | **issue_date** | **Date** | The date the letter was issued. | [optional] |
21
+ | **posted_date** | **Date** | The date the letter was posted on the FDA site. | [optional] |
22
+ | **response_letter_url** | **String** | The firm&#39;s response letter on the FDA site, where one is posted. | [optional] |
23
+ | **closeout_letter_url** | **String** | The FDA close-out letter, where one is posted. | [optional] |
24
+
25
+ ## Example
26
+
27
+ ```ruby
28
+ require 'pharmaobservatory'
29
+
30
+ instance = PharmaObservatory::WarningLettersRow.new(
31
+ letter_id: null,
32
+ letter_url: null,
33
+ firm_name: null,
34
+ firm_org_id: null,
35
+ firm_company_id: null,
36
+ firm_company_name: null,
37
+ firm_group_id: null,
38
+ firm_group_name: null,
39
+ is_org_resolved: null,
40
+ match_tier: null,
41
+ issuing_office: null,
42
+ subject: null,
43
+ excerpt: null,
44
+ issue_date: null,
45
+ posted_date: null,
46
+ response_letter_url: null,
47
+ closeout_letter_url: null
48
+ )
49
+ ```
50
+