pharmaobservatory 0.1.4 → 0.1.6

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 (325) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +118 -7
  3. data/docs/ApiV1WhoamiGet200Response.md +13 -1
  4. data/docs/ApiV1WhoamiGet200ResponseLimits.md +32 -0
  5. data/docs/ApiV1WhoamiGet200ResponseQuota.md +20 -0
  6. data/docs/ApiV1WhoamiGet200ResponseQuotaBuckets.md +28 -0
  7. data/docs/ApiV1WhoamiGet200ResponseQuotaBucketsRequestsPerMinute.md +28 -0
  8. data/docs/BiomarkerAssayEvidenceResponse.md +58 -0
  9. data/docs/{BiomarkerCdxAssertionsResponseBuild.md → BiomarkerAssayEvidenceResponseBuild.md} +2 -2
  10. data/docs/{BiomarkerCdxAssertionsResponseFreshness.md → BiomarkerAssayEvidenceResponseFreshness.md} +2 -2
  11. data/docs/{BiomarkerCdxAssertionsResponseScope.md → BiomarkerAssayEvidenceResponseScope.md} +2 -2
  12. data/docs/BiomarkerAssayEvidenceRow.md +68 -0
  13. data/docs/BiomarkerAssayWhitespaceResponse.md +58 -0
  14. data/docs/BiomarkerAssayWhitespaceRow.md +66 -0
  15. data/docs/BiomarkerBqpAssertionsResponse.md +3 -3
  16. data/docs/BiomarkerCdxAssertionsResponse.md +3 -3
  17. data/docs/BiomarkerEvidenceResponse.md +3 -3
  18. data/docs/BiomarkerLiteratureResponse.md +3 -3
  19. data/docs/BiomarkerPublishingCompaniesResponse.md +3 -3
  20. data/docs/BiomarkerPublishingCompaniesRow.md +9 -1
  21. data/docs/BiomarkerRelationsResponse.md +3 -3
  22. data/docs/BiomarkerSampleCoverageResponse.md +3 -3
  23. data/docs/BiomarkerSamplePrevalenceResponse.md +3 -3
  24. data/docs/BiomarkerValidationResponse.md +3 -3
  25. data/docs/BiomarkerVariantMentionsResponse.md +3 -3
  26. data/docs/BiomarkersApi.md +160 -0
  27. data/docs/BiomarkersRecord.md +2 -2
  28. data/docs/BiomarkersResponse.md +3 -3
  29. data/docs/BiomarkersRow.md +2 -0
  30. data/docs/CellLinesRecord.md +2 -2
  31. data/docs/CellLinesResponse.md +3 -3
  32. data/docs/CompaniesApi.md +246 -0
  33. data/docs/CompaniesRecord.md +2 -2
  34. data/docs/CompaniesResponse.md +3 -3
  35. data/docs/CompaniesRow.md +1 -1
  36. data/docs/CompanyAssetsResponse.md +3 -3
  37. data/docs/CompanyFundingEventsResponse.md +3 -3
  38. data/docs/CompanyFundingEventsRow.md +1 -1
  39. data/docs/CompanyFundingSummaryResponse.md +3 -3
  40. data/docs/CompanyMembersResponse.md +3 -3
  41. data/docs/CompanyProgramsResponse.md +3 -3
  42. data/docs/CompanyTargetsResponse.md +3 -3
  43. data/docs/CompanyTargetsRow.md +5 -1
  44. data/docs/ConditionAdverseEventsResponse.md +3 -3
  45. data/docs/ConditionBurdenResponse.md +3 -3
  46. data/docs/ConditionDeliveryResponse.md +3 -3
  47. data/docs/ConditionDrugsResponse.md +3 -3
  48. data/docs/ConditionPrevalenceResponse.md +3 -3
  49. data/docs/ConditionPrevalenceRow.md +1 -1
  50. data/docs/ConditionPublicationsResponse.md +3 -3
  51. data/docs/ConditionRecruitmentByPhaseResponse.md +58 -0
  52. data/docs/ConditionRecruitmentByPhaseRow.md +50 -0
  53. data/docs/ConditionRecruitmentDurationResponse.md +58 -0
  54. data/docs/ConditionRecruitmentDurationRow.md +86 -0
  55. data/docs/ConditionSitesResponse.md +3 -3
  56. data/docs/ConditionTrialStartForecastResponse.md +58 -0
  57. data/docs/ConditionTrialStartForecastRow.md +70 -0
  58. data/docs/ConditionTrialsResponse.md +3 -3
  59. data/docs/ConditionTrialsRow.md +4 -2
  60. data/docs/ConditionsApi.md +240 -0
  61. data/docs/ConditionsRecord.md +2 -2
  62. data/docs/ConditionsRecordAttributes.md +3 -1
  63. data/docs/ConditionsResponse.md +3 -3
  64. data/docs/DrugPatentCliffResponse.md +3 -3
  65. data/docs/InstitutionalHoldingsResponse.md +3 -3
  66. data/docs/InstitutionalHoldingsRow.md +7 -1
  67. data/docs/InvestorFundsResponse.md +58 -0
  68. data/docs/InvestorFundsRow.md +24 -0
  69. data/docs/InvestorPortfolioResponse.md +58 -0
  70. data/docs/InvestorPortfolioRow.md +42 -0
  71. data/docs/InvestorPrivateFundsResponse.md +58 -0
  72. data/docs/InvestorPrivateFundsRow.md +44 -0
  73. data/docs/InvestorsApi.md +633 -0
  74. data/docs/InvestorsRecord.md +38 -0
  75. data/docs/InvestorsResponse.md +58 -0
  76. data/docs/InvestorsRow.md +54 -0
  77. data/docs/LegalEntitiesApi.md +240 -0
  78. data/docs/LegalEntitiesRecord.md +2 -2
  79. data/docs/LegalEntitiesResponse.md +3 -3
  80. data/docs/LegalEntitiesRow.md +1 -1
  81. data/docs/ManagersApi.md +233 -0
  82. data/docs/ManagersRecord.md +38 -0
  83. data/docs/ManagersResponse.md +58 -0
  84. data/docs/ManagersRow.md +46 -0
  85. data/docs/OrgDisclosuresResponse.md +58 -0
  86. data/docs/OrgDisclosuresRow.md +56 -0
  87. data/docs/OrgRelationshipsResponse.md +58 -0
  88. data/docs/OrgRelationshipsRow.md +68 -0
  89. data/docs/OwnershipPositionsResponse.md +3 -3
  90. data/docs/OwnershipPositionsRow.md +16 -14
  91. data/docs/PdufaDatesResponse.md +3 -3
  92. data/docs/SiteBedsYearlyResponse.md +3 -3
  93. data/docs/SiteCroTrialsResponse.md +3 -3
  94. data/docs/SiteHospitalsResponse.md +3 -3
  95. data/docs/SiteInvestigatorsResponse.md +3 -3
  96. data/docs/SiteTrialConditionsResponse.md +3 -3
  97. data/docs/SiteTrialDrugsResponse.md +3 -3
  98. data/docs/SiteTrialsResponse.md +3 -3
  99. data/docs/SiteTrialsRow.md +3 -1
  100. data/docs/SitesRecord.md +2 -2
  101. data/docs/SitesResponse.md +3 -3
  102. data/docs/SponsorRecruitmentByPhaseResponse.md +3 -3
  103. data/docs/SponsorRecruitmentDurationResponse.md +3 -3
  104. data/docs/SponsorTrialStartForecastResponse.md +3 -3
  105. data/docs/SponsorTrialsResponse.md +3 -3
  106. data/docs/SponsorTrialsRow.md +4 -2
  107. data/docs/SupplierCapabilityEsgResponse.md +58 -0
  108. data/docs/SupplierCapabilityEsgRow.md +64 -0
  109. data/docs/SupplierServicesResponse.md +58 -0
  110. data/docs/SupplierServicesRow.md +30 -0
  111. data/docs/SupplierSitesResponse.md +58 -0
  112. data/docs/SupplierSitesRow.md +42 -0
  113. data/docs/SuppliersApi.md +313 -0
  114. data/docs/SuppliersRecord.md +38 -0
  115. data/docs/SuppliersResponse.md +58 -0
  116. data/docs/SuppliersRow.md +76 -0
  117. data/docs/TargetAssociationsResponse.md +58 -0
  118. data/docs/TargetAssociationsRow.md +26 -0
  119. data/docs/TargetCrowdingResponse.md +58 -0
  120. data/docs/TargetCrowdingRow.md +30 -0
  121. data/docs/TargetDrugsResponse.md +58 -0
  122. data/docs/TargetDrugsRow.md +38 -0
  123. data/docs/TargetEvidenceResponse.md +58 -0
  124. data/docs/TargetEvidenceRow.md +52 -0
  125. data/docs/TargetPatentMentionsResponse.md +58 -0
  126. data/docs/TargetPatentMentionsRow.md +34 -0
  127. data/docs/TargetProgramsResponse.md +58 -0
  128. data/docs/TargetProgramsRow.md +58 -0
  129. data/docs/TargetPublicationsResponse.md +58 -0
  130. data/docs/TargetPublicationsRow.md +32 -0
  131. data/docs/TargetRegulatoryPrecedentResponse.md +58 -0
  132. data/docs/TargetRegulatoryPrecedentRow.md +38 -0
  133. data/docs/TargetTrialsResponse.md +58 -0
  134. data/docs/TargetTrialsRow.md +46 -0
  135. data/docs/TargetsApi.md +1033 -0
  136. data/docs/TargetsRecord.md +38 -0
  137. data/docs/TargetsResponse.md +58 -0
  138. data/docs/TargetsRow.md +68 -0
  139. data/docs/TrialAdverseEventsResponse.md +3 -3
  140. data/docs/TrialChangesResponse.md +3 -3
  141. data/docs/TrialDeliveryResponse.md +3 -3
  142. data/docs/TrialDeliveryRow.md +7 -5
  143. data/docs/TrialDemographicsResponse.md +3 -3
  144. data/docs/TrialDrugClassesResponse.md +58 -0
  145. data/docs/TrialDrugClassesRow.md +28 -0
  146. data/docs/TrialDrugsResponse.md +3 -3
  147. data/docs/TrialEnrollmentHistoryResponse.md +3 -3
  148. data/docs/TrialEnrollmentRateResponse.md +3 -3
  149. data/docs/TrialEnrollmentRateRow.md +5 -3
  150. data/docs/TrialExtractedEndpointsResponse.md +3 -3
  151. data/docs/TrialKolsResponse.md +58 -0
  152. data/docs/TrialKolsRow.md +32 -0
  153. data/docs/TrialOutcomeMeasuresResponse.md +3 -3
  154. data/docs/TrialResearchPaymentsResponse.md +58 -0
  155. data/docs/TrialResearchPaymentsRow.md +44 -0
  156. data/docs/TrialSiteHistoryResponse.md +58 -0
  157. data/docs/TrialSiteHistoryRow.md +50 -0
  158. data/docs/TrialSitesResponse.md +3 -3
  159. data/docs/TrialsApi.md +320 -0
  160. data/docs/TrialsRecord.md +2 -2
  161. data/docs/TrialsResponse.md +3 -3
  162. data/docs/TrialsRow.md +3 -3
  163. data/lib/pharmaobservatory/api/biomarkers_api.rb +168 -0
  164. data/lib/pharmaobservatory/api/companies_api.rb +273 -0
  165. data/lib/pharmaobservatory/api/conditions_api.rb +252 -0
  166. data/lib/pharmaobservatory/api/investors_api.rb +665 -0
  167. data/lib/pharmaobservatory/api/legal_entities_api.rb +252 -0
  168. data/lib/pharmaobservatory/api/managers_api.rb +245 -0
  169. data/lib/pharmaobservatory/api/suppliers_api.rb +329 -0
  170. data/lib/pharmaobservatory/api/targets_api.rb +1085 -0
  171. data/lib/pharmaobservatory/api/trials_api.rb +336 -0
  172. data/lib/pharmaobservatory/models/api_v1_whoami_get200_response.rb +62 -4
  173. data/lib/pharmaobservatory/models/api_v1_whoami_get200_response_limits.rb +419 -0
  174. data/lib/pharmaobservatory/models/api_v1_whoami_get200_response_quota.rb +263 -0
  175. data/lib/pharmaobservatory/models/api_v1_whoami_get200_response_quota_buckets.rb +367 -0
  176. data/lib/pharmaobservatory/models/api_v1_whoami_get200_response_quota_buckets_requests_per_minute.rb +367 -0
  177. data/lib/pharmaobservatory/models/biomarker_assay_evidence_response.rb +478 -0
  178. data/lib/pharmaobservatory/models/{biomarker_cdx_assertions_response_build.rb → biomarker_assay_evidence_response_build.rb} +3 -3
  179. data/lib/pharmaobservatory/models/{biomarker_cdx_assertions_response_freshness.rb → biomarker_assay_evidence_response_freshness.rb} +3 -3
  180. data/lib/pharmaobservatory/models/{biomarker_cdx_assertions_response_scope.rb → biomarker_assay_evidence_response_scope.rb} +3 -3
  181. data/lib/pharmaobservatory/models/biomarker_assay_evidence_row.rb +506 -0
  182. data/lib/pharmaobservatory/models/biomarker_assay_whitespace_response.rb +478 -0
  183. data/lib/pharmaobservatory/models/biomarker_assay_whitespace_row.rb +499 -0
  184. data/lib/pharmaobservatory/models/biomarker_bqp_assertions_response.rb +3 -3
  185. data/lib/pharmaobservatory/models/biomarker_cdx_assertions_response.rb +3 -3
  186. data/lib/pharmaobservatory/models/biomarker_evidence_response.rb +3 -3
  187. data/lib/pharmaobservatory/models/biomarker_literature_response.rb +3 -3
  188. data/lib/pharmaobservatory/models/biomarker_publishing_companies_response.rb +3 -3
  189. data/lib/pharmaobservatory/models/biomarker_publishing_companies_row.rb +49 -5
  190. data/lib/pharmaobservatory/models/biomarker_relations_response.rb +3 -3
  191. data/lib/pharmaobservatory/models/biomarker_sample_coverage_response.rb +3 -3
  192. data/lib/pharmaobservatory/models/biomarker_sample_prevalence_response.rb +3 -3
  193. data/lib/pharmaobservatory/models/biomarker_validation_response.rb +3 -3
  194. data/lib/pharmaobservatory/models/biomarker_variant_mentions_response.rb +3 -3
  195. data/lib/pharmaobservatory/models/biomarkers_record.rb +2 -2
  196. data/lib/pharmaobservatory/models/biomarkers_response.rb +3 -3
  197. data/lib/pharmaobservatory/models/biomarkers_row.rb +12 -1
  198. data/lib/pharmaobservatory/models/cell_lines_record.rb +2 -2
  199. data/lib/pharmaobservatory/models/cell_lines_response.rb +3 -3
  200. data/lib/pharmaobservatory/models/companies_record.rb +2 -2
  201. data/lib/pharmaobservatory/models/companies_response.rb +3 -3
  202. data/lib/pharmaobservatory/models/companies_row.rb +1 -1
  203. data/lib/pharmaobservatory/models/company_assets_response.rb +3 -3
  204. data/lib/pharmaobservatory/models/company_funding_events_response.rb +3 -3
  205. data/lib/pharmaobservatory/models/company_funding_events_row.rb +1 -1
  206. data/lib/pharmaobservatory/models/company_funding_summary_response.rb +3 -3
  207. data/lib/pharmaobservatory/models/company_members_response.rb +3 -3
  208. data/lib/pharmaobservatory/models/company_programs_response.rb +3 -3
  209. data/lib/pharmaobservatory/models/company_targets_response.rb +3 -3
  210. data/lib/pharmaobservatory/models/company_targets_row.rb +27 -5
  211. data/lib/pharmaobservatory/models/condition_adverse_events_response.rb +3 -3
  212. data/lib/pharmaobservatory/models/condition_burden_response.rb +3 -3
  213. data/lib/pharmaobservatory/models/condition_delivery_response.rb +3 -3
  214. data/lib/pharmaobservatory/models/condition_drugs_response.rb +3 -3
  215. data/lib/pharmaobservatory/models/condition_prevalence_response.rb +3 -3
  216. data/lib/pharmaobservatory/models/condition_prevalence_row.rb +1 -1
  217. data/lib/pharmaobservatory/models/condition_publications_response.rb +3 -3
  218. data/lib/pharmaobservatory/models/condition_recruitment_by_phase_response.rb +478 -0
  219. data/lib/pharmaobservatory/models/condition_recruitment_by_phase_row.rb +399 -0
  220. data/lib/pharmaobservatory/models/condition_recruitment_duration_response.rb +478 -0
  221. data/lib/pharmaobservatory/models/condition_recruitment_duration_row.rb +597 -0
  222. data/lib/pharmaobservatory/models/condition_sites_response.rb +3 -3
  223. data/lib/pharmaobservatory/models/condition_trial_start_forecast_response.rb +478 -0
  224. data/lib/pharmaobservatory/models/condition_trial_start_forecast_row.rb +509 -0
  225. data/lib/pharmaobservatory/models/condition_trials_response.rb +3 -3
  226. data/lib/pharmaobservatory/models/condition_trials_row.rb +14 -3
  227. data/lib/pharmaobservatory/models/conditions_record.rb +2 -2
  228. data/lib/pharmaobservatory/models/conditions_record_attributes.rb +13 -4
  229. data/lib/pharmaobservatory/models/conditions_response.rb +3 -3
  230. data/lib/pharmaobservatory/models/drug_patent_cliff_response.rb +3 -3
  231. data/lib/pharmaobservatory/models/institutional_holdings_response.rb +3 -3
  232. data/lib/pharmaobservatory/models/institutional_holdings_row.rb +35 -2
  233. data/lib/pharmaobservatory/models/investor_funds_response.rb +478 -0
  234. data/lib/pharmaobservatory/models/investor_funds_row.rb +256 -0
  235. data/lib/pharmaobservatory/models/investor_portfolio_response.rb +478 -0
  236. data/lib/pharmaobservatory/models/investor_portfolio_row.rb +357 -0
  237. data/lib/pharmaobservatory/models/investor_private_funds_response.rb +478 -0
  238. data/lib/pharmaobservatory/models/investor_private_funds_row.rb +366 -0
  239. data/lib/pharmaobservatory/models/investors_record.rb +385 -0
  240. data/lib/pharmaobservatory/models/investors_response.rb +478 -0
  241. data/lib/pharmaobservatory/models/investors_row.rb +421 -0
  242. data/lib/pharmaobservatory/models/legal_entities_record.rb +2 -2
  243. data/lib/pharmaobservatory/models/legal_entities_response.rb +3 -3
  244. data/lib/pharmaobservatory/models/legal_entities_row.rb +1 -1
  245. data/lib/pharmaobservatory/models/managers_record.rb +385 -0
  246. data/lib/pharmaobservatory/models/managers_response.rb +478 -0
  247. data/lib/pharmaobservatory/models/managers_row.rb +377 -0
  248. data/lib/pharmaobservatory/models/org_disclosures_response.rb +478 -0
  249. data/lib/pharmaobservatory/models/org_disclosures_row.rb +432 -0
  250. data/lib/pharmaobservatory/models/org_relationships_response.rb +478 -0
  251. data/lib/pharmaobservatory/models/org_relationships_row.rb +498 -0
  252. data/lib/pharmaobservatory/models/ownership_positions_response.rb +3 -3
  253. data/lib/pharmaobservatory/models/ownership_positions_row.rb +26 -15
  254. data/lib/pharmaobservatory/models/pdufa_dates_response.rb +3 -3
  255. data/lib/pharmaobservatory/models/site_beds_yearly_response.rb +3 -3
  256. data/lib/pharmaobservatory/models/site_cro_trials_response.rb +3 -3
  257. data/lib/pharmaobservatory/models/site_hospitals_response.rb +3 -3
  258. data/lib/pharmaobservatory/models/site_investigators_response.rb +3 -3
  259. data/lib/pharmaobservatory/models/site_trial_conditions_response.rb +3 -3
  260. data/lib/pharmaobservatory/models/site_trial_drugs_response.rb +3 -3
  261. data/lib/pharmaobservatory/models/site_trials_response.rb +3 -3
  262. data/lib/pharmaobservatory/models/site_trials_row.rb +13 -2
  263. data/lib/pharmaobservatory/models/sites_record.rb +2 -2
  264. data/lib/pharmaobservatory/models/sites_response.rb +3 -3
  265. data/lib/pharmaobservatory/models/sponsor_recruitment_by_phase_response.rb +3 -3
  266. data/lib/pharmaobservatory/models/sponsor_recruitment_duration_response.rb +3 -3
  267. data/lib/pharmaobservatory/models/sponsor_trial_start_forecast_response.rb +3 -3
  268. data/lib/pharmaobservatory/models/sponsor_trials_response.rb +3 -3
  269. data/lib/pharmaobservatory/models/sponsor_trials_row.rb +14 -3
  270. data/lib/pharmaobservatory/models/supplier_capability_esg_response.rb +478 -0
  271. data/lib/pharmaobservatory/models/supplier_capability_esg_row.rb +480 -0
  272. data/lib/pharmaobservatory/models/supplier_services_response.rb +478 -0
  273. data/lib/pharmaobservatory/models/supplier_services_row.rb +289 -0
  274. data/lib/pharmaobservatory/models/supplier_sites_response.rb +478 -0
  275. data/lib/pharmaobservatory/models/supplier_sites_row.rb +357 -0
  276. data/lib/pharmaobservatory/models/suppliers_record.rb +385 -0
  277. data/lib/pharmaobservatory/models/suppliers_response.rb +478 -0
  278. data/lib/pharmaobservatory/models/suppliers_row.rb +544 -0
  279. data/lib/pharmaobservatory/models/target_associations_response.rb +478 -0
  280. data/lib/pharmaobservatory/models/target_associations_row.rb +267 -0
  281. data/lib/pharmaobservatory/models/target_crowding_response.rb +478 -0
  282. data/lib/pharmaobservatory/models/target_crowding_row.rb +289 -0
  283. data/lib/pharmaobservatory/models/target_drugs_response.rb +478 -0
  284. data/lib/pharmaobservatory/models/target_drugs_row.rb +335 -0
  285. data/lib/pharmaobservatory/models/target_evidence_response.rb +478 -0
  286. data/lib/pharmaobservatory/models/target_evidence_row.rb +410 -0
  287. data/lib/pharmaobservatory/models/target_patent_mentions_response.rb +478 -0
  288. data/lib/pharmaobservatory/models/target_patent_mentions_row.rb +311 -0
  289. data/lib/pharmaobservatory/models/target_programs_response.rb +478 -0
  290. data/lib/pharmaobservatory/models/target_programs_row.rb +447 -0
  291. data/lib/pharmaobservatory/models/target_publications_response.rb +478 -0
  292. data/lib/pharmaobservatory/models/target_publications_row.rb +300 -0
  293. data/lib/pharmaobservatory/models/target_regulatory_precedent_response.rb +478 -0
  294. data/lib/pharmaobservatory/models/target_regulatory_precedent_row.rb +333 -0
  295. data/lib/pharmaobservatory/models/target_trials_response.rb +478 -0
  296. data/lib/pharmaobservatory/models/target_trials_row.rb +377 -0
  297. data/lib/pharmaobservatory/models/targets_record.rb +385 -0
  298. data/lib/pharmaobservatory/models/targets_response.rb +478 -0
  299. data/lib/pharmaobservatory/models/targets_row.rb +498 -0
  300. data/lib/pharmaobservatory/models/trial_adverse_events_response.rb +3 -3
  301. data/lib/pharmaobservatory/models/trial_changes_response.rb +3 -3
  302. data/lib/pharmaobservatory/models/trial_delivery_response.rb +3 -3
  303. data/lib/pharmaobservatory/models/trial_delivery_row.rb +22 -11
  304. data/lib/pharmaobservatory/models/trial_demographics_response.rb +3 -3
  305. data/lib/pharmaobservatory/models/trial_drug_classes_response.rb +478 -0
  306. data/lib/pharmaobservatory/models/trial_drug_classes_row.rb +278 -0
  307. data/lib/pharmaobservatory/models/trial_drugs_response.rb +3 -3
  308. data/lib/pharmaobservatory/models/trial_enrollment_history_response.rb +3 -3
  309. data/lib/pharmaobservatory/models/trial_enrollment_rate_response.rb +3 -3
  310. data/lib/pharmaobservatory/models/trial_enrollment_rate_row.rb +15 -4
  311. data/lib/pharmaobservatory/models/trial_extracted_endpoints_response.rb +3 -3
  312. data/lib/pharmaobservatory/models/trial_kols_response.rb +478 -0
  313. data/lib/pharmaobservatory/models/trial_kols_row.rb +302 -0
  314. data/lib/pharmaobservatory/models/trial_outcome_measures_response.rb +3 -3
  315. data/lib/pharmaobservatory/models/trial_research_payments_response.rb +478 -0
  316. data/lib/pharmaobservatory/models/trial_research_payments_row.rb +366 -0
  317. data/lib/pharmaobservatory/models/trial_site_history_response.rb +478 -0
  318. data/lib/pharmaobservatory/models/trial_site_history_row.rb +401 -0
  319. data/lib/pharmaobservatory/models/trial_sites_response.rb +3 -3
  320. data/lib/pharmaobservatory/models/trials_record.rb +2 -2
  321. data/lib/pharmaobservatory/models/trials_response.rb +3 -3
  322. data/lib/pharmaobservatory/models/trials_row.rb +3 -3
  323. data/lib/pharmaobservatory/version.rb +1 -1
  324. data/lib/pharmaobservatory.rb +75 -3
  325. metadata +152 -8
@@ -0,0 +1,665 @@
1
+ =begin
2
+ #Pharma Observatory Public REST API
3
+
4
+ #Read-only REST API over the Pharma Observatory biomedical data platform. Reference: https://pharmaobservatory.com/api-reference
5
+
6
+ The version of the OpenAPI document: 1.0.0
7
+
8
+ Generated by: https://openapi-generator.tech
9
+ Generator version: 7.13.0
10
+
11
+ =end
12
+
13
+ require 'cgi'
14
+
15
+ module PharmaObservatory
16
+ class InvestorsApi
17
+ attr_accessor :api_client
18
+
19
+ def initialize(api_client = ApiClient.default)
20
+ @api_client = api_client
21
+ end
22
+ # One investor
23
+ # @param id [String]
24
+ # @param [Hash] opts the optional parameters
25
+ # @return [InvestorsRecord]
26
+ def investors_get(id, opts = {})
27
+ data, _status_code, _headers = investors_get_with_http_info(id, opts)
28
+ data
29
+ end
30
+
31
+ # One investor
32
+ # @param id [String]
33
+ # @param [Hash] opts the optional parameters
34
+ # @return [Array<(InvestorsRecord, Integer, Hash)>] InvestorsRecord data, response status code and response headers
35
+ def investors_get_with_http_info(id, opts = {})
36
+ if @api_client.config.debugging
37
+ @api_client.config.logger.debug 'Calling API: InvestorsApi.investors_get ...'
38
+ end
39
+ # verify the required parameter 'id' is set
40
+ if @api_client.config.client_side_validation && id.nil?
41
+ fail ArgumentError, "Missing the required parameter 'id' when calling InvestorsApi.investors_get"
42
+ end
43
+ # resource path
44
+ local_var_path = '/api/v1/investors/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
45
+
46
+ # query parameters
47
+ query_params = opts[:query_params] || {}
48
+
49
+ # header parameters
50
+ header_params = opts[:header_params] || {}
51
+ # HTTP header 'Accept' (if needed)
52
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
53
+
54
+ # form parameters
55
+ form_params = opts[:form_params] || {}
56
+
57
+ # http body (model)
58
+ post_body = opts[:debug_body]
59
+
60
+ # return_type
61
+ return_type = opts[:debug_return_type] || 'InvestorsRecord'
62
+
63
+ # auth_names
64
+ auth_names = opts[:debug_auth_names] || ['ApiBearerJwt']
65
+
66
+ new_options = opts.merge(
67
+ :operation => :"InvestorsApi.investors_get",
68
+ :header_params => header_params,
69
+ :query_params => query_params,
70
+ :form_params => form_params,
71
+ :body => post_body,
72
+ :auth_names => auth_names,
73
+ :return_type => return_type
74
+ )
75
+
76
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
77
+ if @api_client.config.debugging
78
+ @api_client.config.logger.debug "API called: InvestorsApi#investors_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
79
+ end
80
+ return data, status_code, headers
81
+ end
82
+
83
+ # Institutional holdings (SEC Form 13F)
84
+ # @param id [String]
85
+ # @param [Hash] opts the optional parameters
86
+ # @option opts [String] :cursor The next_cursor of the previous page. Opaque; it is bound to the filters and the warehouse build that issued it.
87
+ # @option opts [Integer] :limit Rows per page, up to 500 (default 50).
88
+ # @option opts [String] :sort Comma separated columns, a leading minus for descending: sort&#x3D;a,-b.
89
+ # @option opts [String] :group_by A dimension to group by; a date takes :year, :quarter or :month.
90
+ # @option opts [String] :measure count, sum(col), avg(col), min(col), max(col), median(col) or count_distinct(col).
91
+ # @return [InstitutionalHoldingsResponse]
92
+ def investors_institutional_holdings(id, opts = {})
93
+ data, _status_code, _headers = investors_institutional_holdings_with_http_info(id, opts)
94
+ data
95
+ end
96
+
97
+ # Institutional holdings (SEC Form 13F)
98
+ # @param id [String]
99
+ # @param [Hash] opts the optional parameters
100
+ # @option opts [String] :cursor The next_cursor of the previous page. Opaque; it is bound to the filters and the warehouse build that issued it.
101
+ # @option opts [Integer] :limit Rows per page, up to 500 (default 50).
102
+ # @option opts [String] :sort Comma separated columns, a leading minus for descending: sort&#x3D;a,-b.
103
+ # @option opts [String] :group_by A dimension to group by; a date takes :year, :quarter or :month.
104
+ # @option opts [String] :measure count, sum(col), avg(col), min(col), max(col), median(col) or count_distinct(col).
105
+ # @return [Array<(InstitutionalHoldingsResponse, Integer, Hash)>] InstitutionalHoldingsResponse data, response status code and response headers
106
+ def investors_institutional_holdings_with_http_info(id, opts = {})
107
+ if @api_client.config.debugging
108
+ @api_client.config.logger.debug 'Calling API: InvestorsApi.investors_institutional_holdings ...'
109
+ end
110
+ # verify the required parameter 'id' is set
111
+ if @api_client.config.client_side_validation && id.nil?
112
+ fail ArgumentError, "Missing the required parameter 'id' when calling InvestorsApi.investors_institutional_holdings"
113
+ end
114
+ if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 500
115
+ fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling InvestorsApi.investors_institutional_holdings, must be smaller than or equal to 500.'
116
+ end
117
+
118
+ if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
119
+ fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling InvestorsApi.investors_institutional_holdings, must be greater than or equal to 1.'
120
+ end
121
+
122
+ # resource path
123
+ local_var_path = '/api/v1/investors/{id}/institutional_holdings'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
124
+
125
+ # query parameters
126
+ query_params = opts[:query_params] || {}
127
+ query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
128
+ query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
129
+ query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
130
+ query_params[:'group_by'] = opts[:'group_by'] if !opts[:'group_by'].nil?
131
+ query_params[:'measure'] = opts[:'measure'] if !opts[:'measure'].nil?
132
+
133
+ # header parameters
134
+ header_params = opts[:header_params] || {}
135
+ # HTTP header 'Accept' (if needed)
136
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
137
+
138
+ # form parameters
139
+ form_params = opts[:form_params] || {}
140
+
141
+ # http body (model)
142
+ post_body = opts[:debug_body]
143
+
144
+ # return_type
145
+ return_type = opts[:debug_return_type] || 'InstitutionalHoldingsResponse'
146
+
147
+ # auth_names
148
+ auth_names = opts[:debug_auth_names] || ['ApiBearerJwt']
149
+
150
+ new_options = opts.merge(
151
+ :operation => :"InvestorsApi.investors_institutional_holdings",
152
+ :header_params => header_params,
153
+ :query_params => query_params,
154
+ :form_params => form_params,
155
+ :body => post_body,
156
+ :auth_names => auth_names,
157
+ :return_type => return_type
158
+ )
159
+
160
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
161
+ if @api_client.config.debugging
162
+ @api_client.config.logger.debug "API called: InvestorsApi#investors_institutional_holdings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
163
+ end
164
+ return data, status_code, headers
165
+ end
166
+
167
+ # Investor private funds by type
168
+ # @param id [String]
169
+ # @param [Hash] opts the optional parameters
170
+ # @option opts [String] :cursor The next_cursor of the previous page. Opaque; it is bound to the filters and the warehouse build that issued it.
171
+ # @option opts [Integer] :limit Rows per page, up to 500 (default 50).
172
+ # @option opts [String] :sort Comma separated columns, a leading minus for descending: sort&#x3D;a,-b.
173
+ # @option opts [String] :group_by A dimension to group by; a date takes :year, :quarter or :month.
174
+ # @option opts [String] :measure count, sum(col), avg(col), min(col), max(col), median(col) or count_distinct(col).
175
+ # @return [InvestorFundsResponse]
176
+ def investors_investor_funds(id, opts = {})
177
+ data, _status_code, _headers = investors_investor_funds_with_http_info(id, opts)
178
+ data
179
+ end
180
+
181
+ # Investor private funds by type
182
+ # @param id [String]
183
+ # @param [Hash] opts the optional parameters
184
+ # @option opts [String] :cursor The next_cursor of the previous page. Opaque; it is bound to the filters and the warehouse build that issued it.
185
+ # @option opts [Integer] :limit Rows per page, up to 500 (default 50).
186
+ # @option opts [String] :sort Comma separated columns, a leading minus for descending: sort&#x3D;a,-b.
187
+ # @option opts [String] :group_by A dimension to group by; a date takes :year, :quarter or :month.
188
+ # @option opts [String] :measure count, sum(col), avg(col), min(col), max(col), median(col) or count_distinct(col).
189
+ # @return [Array<(InvestorFundsResponse, Integer, Hash)>] InvestorFundsResponse data, response status code and response headers
190
+ def investors_investor_funds_with_http_info(id, opts = {})
191
+ if @api_client.config.debugging
192
+ @api_client.config.logger.debug 'Calling API: InvestorsApi.investors_investor_funds ...'
193
+ end
194
+ # verify the required parameter 'id' is set
195
+ if @api_client.config.client_side_validation && id.nil?
196
+ fail ArgumentError, "Missing the required parameter 'id' when calling InvestorsApi.investors_investor_funds"
197
+ end
198
+ if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 500
199
+ fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling InvestorsApi.investors_investor_funds, must be smaller than or equal to 500.'
200
+ end
201
+
202
+ if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
203
+ fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling InvestorsApi.investors_investor_funds, must be greater than or equal to 1.'
204
+ end
205
+
206
+ # resource path
207
+ local_var_path = '/api/v1/investors/{id}/investor_funds'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
208
+
209
+ # query parameters
210
+ query_params = opts[:query_params] || {}
211
+ query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
212
+ query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
213
+ query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
214
+ query_params[:'group_by'] = opts[:'group_by'] if !opts[:'group_by'].nil?
215
+ query_params[:'measure'] = opts[:'measure'] if !opts[:'measure'].nil?
216
+
217
+ # header parameters
218
+ header_params = opts[:header_params] || {}
219
+ # HTTP header 'Accept' (if needed)
220
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
221
+
222
+ # form parameters
223
+ form_params = opts[:form_params] || {}
224
+
225
+ # http body (model)
226
+ post_body = opts[:debug_body]
227
+
228
+ # return_type
229
+ return_type = opts[:debug_return_type] || 'InvestorFundsResponse'
230
+
231
+ # auth_names
232
+ auth_names = opts[:debug_auth_names] || ['ApiBearerJwt']
233
+
234
+ new_options = opts.merge(
235
+ :operation => :"InvestorsApi.investors_investor_funds",
236
+ :header_params => header_params,
237
+ :query_params => query_params,
238
+ :form_params => form_params,
239
+ :body => post_body,
240
+ :auth_names => auth_names,
241
+ :return_type => return_type
242
+ )
243
+
244
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
245
+ if @api_client.config.debugging
246
+ @api_client.config.logger.debug "API called: InvestorsApi#investors_investor_funds\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
247
+ end
248
+ return data, status_code, headers
249
+ end
250
+
251
+ # Investor portfolio (offering filings)
252
+ # @param id [String]
253
+ # @param [Hash] opts the optional parameters
254
+ # @option opts [String] :cursor The next_cursor of the previous page. Opaque; it is bound to the filters and the warehouse build that issued it.
255
+ # @option opts [Integer] :limit Rows per page, up to 500 (default 50).
256
+ # @option opts [String] :sort Comma separated columns, a leading minus for descending: sort&#x3D;a,-b.
257
+ # @option opts [String] :group_by A dimension to group by; a date takes :year, :quarter or :month.
258
+ # @option opts [String] :measure count, sum(col), avg(col), min(col), max(col), median(col) or count_distinct(col).
259
+ # @return [InvestorPortfolioResponse]
260
+ def investors_investor_portfolio(id, opts = {})
261
+ data, _status_code, _headers = investors_investor_portfolio_with_http_info(id, opts)
262
+ data
263
+ end
264
+
265
+ # Investor portfolio (offering filings)
266
+ # @param id [String]
267
+ # @param [Hash] opts the optional parameters
268
+ # @option opts [String] :cursor The next_cursor of the previous page. Opaque; it is bound to the filters and the warehouse build that issued it.
269
+ # @option opts [Integer] :limit Rows per page, up to 500 (default 50).
270
+ # @option opts [String] :sort Comma separated columns, a leading minus for descending: sort&#x3D;a,-b.
271
+ # @option opts [String] :group_by A dimension to group by; a date takes :year, :quarter or :month.
272
+ # @option opts [String] :measure count, sum(col), avg(col), min(col), max(col), median(col) or count_distinct(col).
273
+ # @return [Array<(InvestorPortfolioResponse, Integer, Hash)>] InvestorPortfolioResponse data, response status code and response headers
274
+ def investors_investor_portfolio_with_http_info(id, opts = {})
275
+ if @api_client.config.debugging
276
+ @api_client.config.logger.debug 'Calling API: InvestorsApi.investors_investor_portfolio ...'
277
+ end
278
+ # verify the required parameter 'id' is set
279
+ if @api_client.config.client_side_validation && id.nil?
280
+ fail ArgumentError, "Missing the required parameter 'id' when calling InvestorsApi.investors_investor_portfolio"
281
+ end
282
+ if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 500
283
+ fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling InvestorsApi.investors_investor_portfolio, must be smaller than or equal to 500.'
284
+ end
285
+
286
+ if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
287
+ fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling InvestorsApi.investors_investor_portfolio, must be greater than or equal to 1.'
288
+ end
289
+
290
+ # resource path
291
+ local_var_path = '/api/v1/investors/{id}/investor_portfolio'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
292
+
293
+ # query parameters
294
+ query_params = opts[:query_params] || {}
295
+ query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
296
+ query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
297
+ query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
298
+ query_params[:'group_by'] = opts[:'group_by'] if !opts[:'group_by'].nil?
299
+ query_params[:'measure'] = opts[:'measure'] if !opts[:'measure'].nil?
300
+
301
+ # header parameters
302
+ header_params = opts[:header_params] || {}
303
+ # HTTP header 'Accept' (if needed)
304
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
305
+
306
+ # form parameters
307
+ form_params = opts[:form_params] || {}
308
+
309
+ # http body (model)
310
+ post_body = opts[:debug_body]
311
+
312
+ # return_type
313
+ return_type = opts[:debug_return_type] || 'InvestorPortfolioResponse'
314
+
315
+ # auth_names
316
+ auth_names = opts[:debug_auth_names] || ['ApiBearerJwt']
317
+
318
+ new_options = opts.merge(
319
+ :operation => :"InvestorsApi.investors_investor_portfolio",
320
+ :header_params => header_params,
321
+ :query_params => query_params,
322
+ :form_params => form_params,
323
+ :body => post_body,
324
+ :auth_names => auth_names,
325
+ :return_type => return_type
326
+ )
327
+
328
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
329
+ if @api_client.config.debugging
330
+ @api_client.config.logger.debug "API called: InvestorsApi#investors_investor_portfolio\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
331
+ end
332
+ return data, status_code, headers
333
+ end
334
+
335
+ # Investor private funds
336
+ # @param id [String]
337
+ # @param [Hash] opts the optional parameters
338
+ # @option opts [String] :cursor The next_cursor of the previous page. Opaque; it is bound to the filters and the warehouse build that issued it.
339
+ # @option opts [Integer] :limit Rows per page, up to 500 (default 50).
340
+ # @option opts [String] :sort Comma separated columns, a leading minus for descending: sort&#x3D;a,-b.
341
+ # @option opts [String] :group_by A dimension to group by; a date takes :year, :quarter or :month.
342
+ # @option opts [String] :measure count, sum(col), avg(col), min(col), max(col), median(col) or count_distinct(col).
343
+ # @return [InvestorPrivateFundsResponse]
344
+ def investors_investor_private_funds(id, opts = {})
345
+ data, _status_code, _headers = investors_investor_private_funds_with_http_info(id, opts)
346
+ data
347
+ end
348
+
349
+ # Investor private funds
350
+ # @param id [String]
351
+ # @param [Hash] opts the optional parameters
352
+ # @option opts [String] :cursor The next_cursor of the previous page. Opaque; it is bound to the filters and the warehouse build that issued it.
353
+ # @option opts [Integer] :limit Rows per page, up to 500 (default 50).
354
+ # @option opts [String] :sort Comma separated columns, a leading minus for descending: sort&#x3D;a,-b.
355
+ # @option opts [String] :group_by A dimension to group by; a date takes :year, :quarter or :month.
356
+ # @option opts [String] :measure count, sum(col), avg(col), min(col), max(col), median(col) or count_distinct(col).
357
+ # @return [Array<(InvestorPrivateFundsResponse, Integer, Hash)>] InvestorPrivateFundsResponse data, response status code and response headers
358
+ def investors_investor_private_funds_with_http_info(id, opts = {})
359
+ if @api_client.config.debugging
360
+ @api_client.config.logger.debug 'Calling API: InvestorsApi.investors_investor_private_funds ...'
361
+ end
362
+ # verify the required parameter 'id' is set
363
+ if @api_client.config.client_side_validation && id.nil?
364
+ fail ArgumentError, "Missing the required parameter 'id' when calling InvestorsApi.investors_investor_private_funds"
365
+ end
366
+ if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 500
367
+ fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling InvestorsApi.investors_investor_private_funds, must be smaller than or equal to 500.'
368
+ end
369
+
370
+ if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
371
+ fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling InvestorsApi.investors_investor_private_funds, must be greater than or equal to 1.'
372
+ end
373
+
374
+ # resource path
375
+ local_var_path = '/api/v1/investors/{id}/investor_private_funds'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
376
+
377
+ # query parameters
378
+ query_params = opts[:query_params] || {}
379
+ query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
380
+ query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
381
+ query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
382
+ query_params[:'group_by'] = opts[:'group_by'] if !opts[:'group_by'].nil?
383
+ query_params[:'measure'] = opts[:'measure'] if !opts[:'measure'].nil?
384
+
385
+ # header parameters
386
+ header_params = opts[:header_params] || {}
387
+ # HTTP header 'Accept' (if needed)
388
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
389
+
390
+ # form parameters
391
+ form_params = opts[:form_params] || {}
392
+
393
+ # http body (model)
394
+ post_body = opts[:debug_body]
395
+
396
+ # return_type
397
+ return_type = opts[:debug_return_type] || 'InvestorPrivateFundsResponse'
398
+
399
+ # auth_names
400
+ auth_names = opts[:debug_auth_names] || ['ApiBearerJwt']
401
+
402
+ new_options = opts.merge(
403
+ :operation => :"InvestorsApi.investors_investor_private_funds",
404
+ :header_params => header_params,
405
+ :query_params => query_params,
406
+ :form_params => form_params,
407
+ :body => post_body,
408
+ :auth_names => auth_names,
409
+ :return_type => return_type
410
+ )
411
+
412
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
413
+ if @api_client.config.debugging
414
+ @api_client.config.logger.debug "API called: InvestorsApi#investors_investor_private_funds\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
415
+ end
416
+ return data, status_code, headers
417
+ end
418
+
419
+ # List investors
420
+ # @param [Hash] opts the optional parameters
421
+ # @option opts [String] :cursor The next_cursor of the previous page. Opaque; it is bound to the filters and the warehouse build that issued it.
422
+ # @option opts [Integer] :limit Rows per page, up to 500 (default 50).
423
+ # @option opts [String] :sort Comma separated columns, a leading minus for descending: sort&#x3D;a,-b.
424
+ # @option opts [String] :group_by A dimension to group by; a date takes :year, :quarter or :month.
425
+ # @option opts [String] :measure count, sum(col), avg(col), min(col), max(col), median(col) or count_distinct(col).
426
+ # @return [InvestorsResponse]
427
+ def investors_list(opts = {})
428
+ data, _status_code, _headers = investors_list_with_http_info(opts)
429
+ data
430
+ end
431
+
432
+ # List investors
433
+ # @param [Hash] opts the optional parameters
434
+ # @option opts [String] :cursor The next_cursor of the previous page. Opaque; it is bound to the filters and the warehouse build that issued it.
435
+ # @option opts [Integer] :limit Rows per page, up to 500 (default 50).
436
+ # @option opts [String] :sort Comma separated columns, a leading minus for descending: sort&#x3D;a,-b.
437
+ # @option opts [String] :group_by A dimension to group by; a date takes :year, :quarter or :month.
438
+ # @option opts [String] :measure count, sum(col), avg(col), min(col), max(col), median(col) or count_distinct(col).
439
+ # @return [Array<(InvestorsResponse, Integer, Hash)>] InvestorsResponse data, response status code and response headers
440
+ def investors_list_with_http_info(opts = {})
441
+ if @api_client.config.debugging
442
+ @api_client.config.logger.debug 'Calling API: InvestorsApi.investors_list ...'
443
+ end
444
+ if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 500
445
+ fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling InvestorsApi.investors_list, must be smaller than or equal to 500.'
446
+ end
447
+
448
+ if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
449
+ fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling InvestorsApi.investors_list, must be greater than or equal to 1.'
450
+ end
451
+
452
+ # resource path
453
+ local_var_path = '/api/v1/investors'
454
+
455
+ # query parameters
456
+ query_params = opts[:query_params] || {}
457
+ query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
458
+ query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
459
+ query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
460
+ query_params[:'group_by'] = opts[:'group_by'] if !opts[:'group_by'].nil?
461
+ query_params[:'measure'] = opts[:'measure'] if !opts[:'measure'].nil?
462
+
463
+ # header parameters
464
+ header_params = opts[:header_params] || {}
465
+ # HTTP header 'Accept' (if needed)
466
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
467
+
468
+ # form parameters
469
+ form_params = opts[:form_params] || {}
470
+
471
+ # http body (model)
472
+ post_body = opts[:debug_body]
473
+
474
+ # return_type
475
+ return_type = opts[:debug_return_type] || 'InvestorsResponse'
476
+
477
+ # auth_names
478
+ auth_names = opts[:debug_auth_names] || ['ApiBearerJwt']
479
+
480
+ new_options = opts.merge(
481
+ :operation => :"InvestorsApi.investors_list",
482
+ :header_params => header_params,
483
+ :query_params => query_params,
484
+ :form_params => form_params,
485
+ :body => post_body,
486
+ :auth_names => auth_names,
487
+ :return_type => return_type
488
+ )
489
+
490
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
491
+ if @api_client.config.debugging
492
+ @api_client.config.logger.debug "API called: InvestorsApi#investors_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
493
+ end
494
+ return data, status_code, headers
495
+ end
496
+
497
+ # Institutional managers (SEC Form 13F)
498
+ # @param id [String]
499
+ # @param [Hash] opts the optional parameters
500
+ # @option opts [String] :cursor The next_cursor of the previous page. Opaque; it is bound to the filters and the warehouse build that issued it.
501
+ # @option opts [Integer] :limit Rows per page, up to 500 (default 50).
502
+ # @option opts [String] :sort Comma separated columns, a leading minus for descending: sort&#x3D;a,-b.
503
+ # @option opts [String] :group_by A dimension to group by; a date takes :year, :quarter or :month.
504
+ # @option opts [String] :measure count, sum(col), avg(col), min(col), max(col), median(col) or count_distinct(col).
505
+ # @return [ManagersResponse]
506
+ def investors_managers(id, opts = {})
507
+ data, _status_code, _headers = investors_managers_with_http_info(id, opts)
508
+ data
509
+ end
510
+
511
+ # Institutional managers (SEC Form 13F)
512
+ # @param id [String]
513
+ # @param [Hash] opts the optional parameters
514
+ # @option opts [String] :cursor The next_cursor of the previous page. Opaque; it is bound to the filters and the warehouse build that issued it.
515
+ # @option opts [Integer] :limit Rows per page, up to 500 (default 50).
516
+ # @option opts [String] :sort Comma separated columns, a leading minus for descending: sort&#x3D;a,-b.
517
+ # @option opts [String] :group_by A dimension to group by; a date takes :year, :quarter or :month.
518
+ # @option opts [String] :measure count, sum(col), avg(col), min(col), max(col), median(col) or count_distinct(col).
519
+ # @return [Array<(ManagersResponse, Integer, Hash)>] ManagersResponse data, response status code and response headers
520
+ def investors_managers_with_http_info(id, opts = {})
521
+ if @api_client.config.debugging
522
+ @api_client.config.logger.debug 'Calling API: InvestorsApi.investors_managers ...'
523
+ end
524
+ # verify the required parameter 'id' is set
525
+ if @api_client.config.client_side_validation && id.nil?
526
+ fail ArgumentError, "Missing the required parameter 'id' when calling InvestorsApi.investors_managers"
527
+ end
528
+ if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 500
529
+ fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling InvestorsApi.investors_managers, must be smaller than or equal to 500.'
530
+ end
531
+
532
+ if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
533
+ fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling InvestorsApi.investors_managers, must be greater than or equal to 1.'
534
+ end
535
+
536
+ # resource path
537
+ local_var_path = '/api/v1/investors/{id}/managers'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
538
+
539
+ # query parameters
540
+ query_params = opts[:query_params] || {}
541
+ query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
542
+ query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
543
+ query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
544
+ query_params[:'group_by'] = opts[:'group_by'] if !opts[:'group_by'].nil?
545
+ query_params[:'measure'] = opts[:'measure'] if !opts[:'measure'].nil?
546
+
547
+ # header parameters
548
+ header_params = opts[:header_params] || {}
549
+ # HTTP header 'Accept' (if needed)
550
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
551
+
552
+ # form parameters
553
+ form_params = opts[:form_params] || {}
554
+
555
+ # http body (model)
556
+ post_body = opts[:debug_body]
557
+
558
+ # return_type
559
+ return_type = opts[:debug_return_type] || 'ManagersResponse'
560
+
561
+ # auth_names
562
+ auth_names = opts[:debug_auth_names] || ['ApiBearerJwt']
563
+
564
+ new_options = opts.merge(
565
+ :operation => :"InvestorsApi.investors_managers",
566
+ :header_params => header_params,
567
+ :query_params => query_params,
568
+ :form_params => form_params,
569
+ :body => post_body,
570
+ :auth_names => auth_names,
571
+ :return_type => return_type
572
+ )
573
+
574
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
575
+ if @api_client.config.debugging
576
+ @api_client.config.logger.debug "API called: InvestorsApi#investors_managers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
577
+ end
578
+ return data, status_code, headers
579
+ end
580
+
581
+ # Ownership and control positions
582
+ # @param id [String]
583
+ # @param [Hash] opts the optional parameters
584
+ # @option opts [String] :cursor The next_cursor of the previous page. Opaque; it is bound to the filters and the warehouse build that issued it.
585
+ # @option opts [Integer] :limit Rows per page, up to 500 (default 50).
586
+ # @option opts [String] :sort Comma separated columns, a leading minus for descending: sort&#x3D;a,-b.
587
+ # @option opts [String] :group_by A dimension to group by; a date takes :year, :quarter or :month.
588
+ # @option opts [String] :measure count, sum(col), avg(col), min(col), max(col), median(col) or count_distinct(col).
589
+ # @return [OwnershipPositionsResponse]
590
+ def investors_ownership_positions(id, opts = {})
591
+ data, _status_code, _headers = investors_ownership_positions_with_http_info(id, opts)
592
+ data
593
+ end
594
+
595
+ # Ownership and control positions
596
+ # @param id [String]
597
+ # @param [Hash] opts the optional parameters
598
+ # @option opts [String] :cursor The next_cursor of the previous page. Opaque; it is bound to the filters and the warehouse build that issued it.
599
+ # @option opts [Integer] :limit Rows per page, up to 500 (default 50).
600
+ # @option opts [String] :sort Comma separated columns, a leading minus for descending: sort&#x3D;a,-b.
601
+ # @option opts [String] :group_by A dimension to group by; a date takes :year, :quarter or :month.
602
+ # @option opts [String] :measure count, sum(col), avg(col), min(col), max(col), median(col) or count_distinct(col).
603
+ # @return [Array<(OwnershipPositionsResponse, Integer, Hash)>] OwnershipPositionsResponse data, response status code and response headers
604
+ def investors_ownership_positions_with_http_info(id, opts = {})
605
+ if @api_client.config.debugging
606
+ @api_client.config.logger.debug 'Calling API: InvestorsApi.investors_ownership_positions ...'
607
+ end
608
+ # verify the required parameter 'id' is set
609
+ if @api_client.config.client_side_validation && id.nil?
610
+ fail ArgumentError, "Missing the required parameter 'id' when calling InvestorsApi.investors_ownership_positions"
611
+ end
612
+ if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 500
613
+ fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling InvestorsApi.investors_ownership_positions, must be smaller than or equal to 500.'
614
+ end
615
+
616
+ if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
617
+ fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling InvestorsApi.investors_ownership_positions, must be greater than or equal to 1.'
618
+ end
619
+
620
+ # resource path
621
+ local_var_path = '/api/v1/investors/{id}/ownership_positions'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
622
+
623
+ # query parameters
624
+ query_params = opts[:query_params] || {}
625
+ query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
626
+ query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
627
+ query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
628
+ query_params[:'group_by'] = opts[:'group_by'] if !opts[:'group_by'].nil?
629
+ query_params[:'measure'] = opts[:'measure'] if !opts[:'measure'].nil?
630
+
631
+ # header parameters
632
+ header_params = opts[:header_params] || {}
633
+ # HTTP header 'Accept' (if needed)
634
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
635
+
636
+ # form parameters
637
+ form_params = opts[:form_params] || {}
638
+
639
+ # http body (model)
640
+ post_body = opts[:debug_body]
641
+
642
+ # return_type
643
+ return_type = opts[:debug_return_type] || 'OwnershipPositionsResponse'
644
+
645
+ # auth_names
646
+ auth_names = opts[:debug_auth_names] || ['ApiBearerJwt']
647
+
648
+ new_options = opts.merge(
649
+ :operation => :"InvestorsApi.investors_ownership_positions",
650
+ :header_params => header_params,
651
+ :query_params => query_params,
652
+ :form_params => form_params,
653
+ :body => post_body,
654
+ :auth_names => auth_names,
655
+ :return_type => return_type
656
+ )
657
+
658
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
659
+ if @api_client.config.debugging
660
+ @api_client.config.logger.debug "API called: InvestorsApi#investors_ownership_positions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
661
+ end
662
+ return data, status_code, headers
663
+ end
664
+ end
665
+ end