pharmaobservatory 0.1.3 → 0.1.4

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 (175) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +101 -4
  3. data/docs/BiomarkerBqpAssertionsRow.md +1 -1
  4. data/docs/BiomarkerEvidenceRow.md +1 -1
  5. data/docs/BiomarkerLiteratureRow.md +1 -1
  6. data/docs/BiomarkerRelationsResponse.md +58 -0
  7. data/docs/BiomarkerRelationsRow.md +54 -0
  8. data/docs/BiomarkerSampleCoverageResponse.md +58 -0
  9. data/docs/BiomarkerSampleCoverageRow.md +36 -0
  10. data/docs/BiomarkerSamplePrevalenceResponse.md +58 -0
  11. data/docs/BiomarkerSamplePrevalenceRow.md +56 -0
  12. data/docs/BiomarkerValidationResponse.md +58 -0
  13. data/docs/BiomarkerValidationRow.md +70 -0
  14. data/docs/BiomarkersApi.md +320 -0
  15. data/docs/BiomarkersRow.md +2 -2
  16. data/docs/CellLinesRow.md +1 -1
  17. data/docs/CompaniesApi.md +410 -0
  18. data/docs/CompaniesRecord.md +1 -1
  19. data/docs/CompaniesRecordAttributes.md +18 -0
  20. data/docs/CompaniesRow.md +7 -3
  21. data/docs/CompanyAssetsResponse.md +58 -0
  22. data/docs/CompanyAssetsRow.md +42 -0
  23. data/docs/CompanyFundingEventsResponse.md +58 -0
  24. data/docs/CompanyFundingEventsRow.md +62 -0
  25. data/docs/CompanyFundingSummaryResponse.md +58 -0
  26. data/docs/CompanyFundingSummaryRow.md +46 -0
  27. data/docs/CompanyProgramsRow.md +2 -2
  28. data/docs/ConditionAdverseEventsResponse.md +58 -0
  29. data/docs/ConditionAdverseEventsRow.md +24 -0
  30. data/docs/ConditionBurdenResponse.md +58 -0
  31. data/docs/ConditionBurdenRow.md +32 -0
  32. data/docs/ConditionDeliveryResponse.md +58 -0
  33. data/docs/ConditionDeliveryRow.md +44 -0
  34. data/docs/ConditionDrugsResponse.md +58 -0
  35. data/docs/ConditionDrugsRow.md +26 -0
  36. data/docs/ConditionPrevalenceResponse.md +58 -0
  37. data/docs/ConditionPrevalenceRow.md +62 -0
  38. data/docs/ConditionPublicationsResponse.md +58 -0
  39. data/docs/ConditionPublicationsRow.md +32 -0
  40. data/docs/ConditionSitesResponse.md +58 -0
  41. data/docs/ConditionSitesRow.md +28 -0
  42. data/docs/ConditionTrialsResponse.md +58 -0
  43. data/docs/ConditionTrialsRow.md +58 -0
  44. data/docs/ConditionsApi.md +953 -0
  45. data/docs/ConditionsRecord.md +38 -0
  46. data/docs/ConditionsRecordAttributes.md +20 -0
  47. data/docs/ConditionsResponse.md +58 -0
  48. data/docs/ConditionsRow.md +32 -0
  49. data/docs/DrugPatentCliffRow.md +1 -1
  50. data/docs/InstitutionalHoldingsRow.md +3 -1
  51. data/docs/LegalEntitiesApi.md +160 -0
  52. data/docs/LegalEntitiesRow.md +1 -1
  53. data/docs/OwnershipPositionsResponse.md +58 -0
  54. data/docs/OwnershipPositionsRow.md +100 -0
  55. data/docs/PdufaDatesRow.md +2 -2
  56. data/docs/SiteCroTrialsRow.md +1 -1
  57. data/docs/SiteTrialConditionsRow.md +1 -1
  58. data/docs/SiteTrialDrugsRow.md +1 -1
  59. data/docs/SiteTrialsRow.md +1 -1
  60. data/docs/SponsorRecruitmentByPhaseRow.md +2 -2
  61. data/docs/SponsorRecruitmentDurationRow.md +1 -1
  62. data/docs/SponsorTrialsRow.md +2 -2
  63. data/docs/TrialAdverseEventsResponse.md +58 -0
  64. data/docs/TrialAdverseEventsRow.md +28 -0
  65. data/docs/TrialChangesResponse.md +58 -0
  66. data/docs/TrialChangesRow.md +36 -0
  67. data/docs/TrialDeliveryResponse.md +58 -0
  68. data/docs/TrialDeliveryRow.md +64 -0
  69. data/docs/TrialDemographicsResponse.md +58 -0
  70. data/docs/TrialDemographicsRow.md +32 -0
  71. data/docs/TrialDrugsResponse.md +58 -0
  72. data/docs/TrialDrugsRow.md +30 -0
  73. data/docs/TrialEnrollmentHistoryResponse.md +58 -0
  74. data/docs/TrialEnrollmentHistoryRow.md +36 -0
  75. data/docs/TrialEnrollmentRateResponse.md +58 -0
  76. data/docs/TrialEnrollmentRateRow.md +58 -0
  77. data/docs/TrialExtractedEndpointsResponse.md +58 -0
  78. data/docs/TrialExtractedEndpointsRow.md +40 -0
  79. data/docs/TrialOutcomeMeasuresResponse.md +58 -0
  80. data/docs/TrialOutcomeMeasuresRow.md +28 -0
  81. data/docs/TrialSitesResponse.md +58 -0
  82. data/docs/TrialSitesRow.md +46 -0
  83. data/docs/TrialsApi.md +1033 -0
  84. data/docs/TrialsRecord.md +38 -0
  85. data/docs/TrialsRecordAttributes.md +24 -0
  86. data/docs/TrialsResponse.md +58 -0
  87. data/docs/TrialsRow.md +116 -0
  88. data/lib/pharmaobservatory/api/biomarkers_api.rb +336 -0
  89. data/lib/pharmaobservatory/api/companies_api.rb +455 -0
  90. data/lib/pharmaobservatory/api/conditions_api.rb +1001 -0
  91. data/lib/pharmaobservatory/api/legal_entities_api.rb +168 -0
  92. data/lib/pharmaobservatory/api/trials_api.rb +1085 -0
  93. data/lib/pharmaobservatory/models/biomarker_bqp_assertions_row.rb +1 -1
  94. data/lib/pharmaobservatory/models/biomarker_evidence_row.rb +1 -1
  95. data/lib/pharmaobservatory/models/biomarker_literature_row.rb +1 -1
  96. data/lib/pharmaobservatory/models/biomarker_relations_response.rb +478 -0
  97. data/lib/pharmaobservatory/models/biomarker_relations_row.rb +421 -0
  98. data/lib/pharmaobservatory/models/biomarker_sample_coverage_response.rb +478 -0
  99. data/lib/pharmaobservatory/models/biomarker_sample_coverage_row.rb +322 -0
  100. data/lib/pharmaobservatory/models/biomarker_sample_prevalence_response.rb +478 -0
  101. data/lib/pharmaobservatory/models/biomarker_sample_prevalence_row.rb +436 -0
  102. data/lib/pharmaobservatory/models/biomarker_validation_response.rb +478 -0
  103. data/lib/pharmaobservatory/models/biomarker_validation_row.rb +509 -0
  104. data/lib/pharmaobservatory/models/biomarkers_row.rb +2 -2
  105. data/lib/pharmaobservatory/models/cell_lines_row.rb +1 -1
  106. data/lib/pharmaobservatory/models/companies_record.rb +1 -1
  107. data/lib/pharmaobservatory/models/companies_record_attributes.rb +220 -0
  108. data/lib/pharmaobservatory/models/companies_row.rb +29 -7
  109. data/lib/pharmaobservatory/models/company_assets_response.rb +478 -0
  110. data/lib/pharmaobservatory/models/company_assets_row.rb +355 -0
  111. data/lib/pharmaobservatory/models/company_funding_events_response.rb +478 -0
  112. data/lib/pharmaobservatory/models/company_funding_events_row.rb +465 -0
  113. data/lib/pharmaobservatory/models/company_funding_summary_response.rb +478 -0
  114. data/lib/pharmaobservatory/models/company_funding_summary_row.rb +377 -0
  115. data/lib/pharmaobservatory/models/company_programs_row.rb +2 -2
  116. data/lib/pharmaobservatory/models/condition_adverse_events_response.rb +478 -0
  117. data/lib/pharmaobservatory/models/condition_adverse_events_row.rb +256 -0
  118. data/lib/pharmaobservatory/models/condition_burden_response.rb +478 -0
  119. data/lib/pharmaobservatory/models/condition_burden_row.rb +300 -0
  120. data/lib/pharmaobservatory/models/condition_delivery_response.rb +478 -0
  121. data/lib/pharmaobservatory/models/condition_delivery_row.rb +366 -0
  122. data/lib/pharmaobservatory/models/condition_drugs_response.rb +478 -0
  123. data/lib/pharmaobservatory/models/condition_drugs_row.rb +267 -0
  124. data/lib/pharmaobservatory/models/condition_prevalence_response.rb +478 -0
  125. data/lib/pharmaobservatory/models/condition_prevalence_row.rb +465 -0
  126. data/lib/pharmaobservatory/models/condition_publications_response.rb +478 -0
  127. data/lib/pharmaobservatory/models/condition_publications_row.rb +300 -0
  128. data/lib/pharmaobservatory/models/condition_sites_response.rb +478 -0
  129. data/lib/pharmaobservatory/models/condition_sites_row.rb +278 -0
  130. data/lib/pharmaobservatory/models/condition_trials_response.rb +478 -0
  131. data/lib/pharmaobservatory/models/condition_trials_row.rb +443 -0
  132. data/lib/pharmaobservatory/models/conditions_record.rb +385 -0
  133. data/lib/pharmaobservatory/models/conditions_record_attributes.rb +229 -0
  134. data/lib/pharmaobservatory/models/conditions_response.rb +478 -0
  135. data/lib/pharmaobservatory/models/conditions_row.rb +304 -0
  136. data/lib/pharmaobservatory/models/drug_patent_cliff_row.rb +1 -1
  137. data/lib/pharmaobservatory/models/institutional_holdings_row.rb +13 -2
  138. data/lib/pharmaobservatory/models/legal_entities_row.rb +1 -1
  139. data/lib/pharmaobservatory/models/ownership_positions_response.rb +478 -0
  140. data/lib/pharmaobservatory/models/ownership_positions_row.rb +674 -0
  141. data/lib/pharmaobservatory/models/pdufa_dates_row.rb +2 -2
  142. data/lib/pharmaobservatory/models/site_cro_trials_row.rb +1 -1
  143. data/lib/pharmaobservatory/models/site_trial_conditions_row.rb +1 -1
  144. data/lib/pharmaobservatory/models/site_trial_drugs_row.rb +1 -1
  145. data/lib/pharmaobservatory/models/site_trials_row.rb +1 -1
  146. data/lib/pharmaobservatory/models/sponsor_recruitment_by_phase_row.rb +2 -2
  147. data/lib/pharmaobservatory/models/sponsor_recruitment_duration_row.rb +1 -1
  148. data/lib/pharmaobservatory/models/sponsor_trials_row.rb +2 -2
  149. data/lib/pharmaobservatory/models/trial_adverse_events_response.rb +478 -0
  150. data/lib/pharmaobservatory/models/trial_adverse_events_row.rb +278 -0
  151. data/lib/pharmaobservatory/models/trial_changes_response.rb +478 -0
  152. data/lib/pharmaobservatory/models/trial_changes_row.rb +328 -0
  153. data/lib/pharmaobservatory/models/trial_delivery_response.rb +478 -0
  154. data/lib/pharmaobservatory/models/trial_delivery_row.rb +476 -0
  155. data/lib/pharmaobservatory/models/trial_demographics_response.rb +478 -0
  156. data/lib/pharmaobservatory/models/trial_demographics_row.rb +300 -0
  157. data/lib/pharmaobservatory/models/trial_drugs_response.rb +478 -0
  158. data/lib/pharmaobservatory/models/trial_drugs_row.rb +291 -0
  159. data/lib/pharmaobservatory/models/trial_enrollment_history_response.rb +478 -0
  160. data/lib/pharmaobservatory/models/trial_enrollment_history_row.rb +322 -0
  161. data/lib/pharmaobservatory/models/trial_enrollment_rate_response.rb +478 -0
  162. data/lib/pharmaobservatory/models/trial_enrollment_rate_row.rb +443 -0
  163. data/lib/pharmaobservatory/models/trial_extracted_endpoints_response.rb +478 -0
  164. data/lib/pharmaobservatory/models/trial_extracted_endpoints_row.rb +346 -0
  165. data/lib/pharmaobservatory/models/trial_outcome_measures_response.rb +478 -0
  166. data/lib/pharmaobservatory/models/trial_outcome_measures_row.rb +278 -0
  167. data/lib/pharmaobservatory/models/trial_sites_response.rb +478 -0
  168. data/lib/pharmaobservatory/models/trial_sites_row.rb +377 -0
  169. data/lib/pharmaobservatory/models/trials_record.rb +385 -0
  170. data/lib/pharmaobservatory/models/trials_record_attributes.rb +247 -0
  171. data/lib/pharmaobservatory/models/trials_response.rb +478 -0
  172. data/lib/pharmaobservatory/models/trials_row.rb +784 -0
  173. data/lib/pharmaobservatory/version.rb +1 -1
  174. data/lib/pharmaobservatory.rb +63 -0
  175. metadata +127 -1
data/docs/CompaniesApi.md CHANGED
@@ -7,6 +7,10 @@ All URIs are relative to *https://pharmaobservatory.com*
7
7
  | [**companies_biomarker_bqp_assertions**](CompaniesApi.md#companies_biomarker_bqp_assertions) | **GET** /api/v1/companies/{id}/biomarker_bqp_assertions | FDA biomarker qualification projects |
8
8
  | [**companies_biomarker_cdx_assertions**](CompaniesApi.md#companies_biomarker_cdx_assertions) | **GET** /api/v1/companies/{id}/biomarker_cdx_assertions | FDA companion diagnostic assertions |
9
9
  | [**companies_biomarker_publishing_companies**](CompaniesApi.md#companies_biomarker_publishing_companies) | **GET** /api/v1/companies/{id}/biomarker_publishing_companies | Companies publishing on a biomarker |
10
+ | [**companies_biomarker_validation**](CompaniesApi.md#companies_biomarker_validation) | **GET** /api/v1/companies/{id}/biomarker_validation | Biomarker validation ladder |
11
+ | [**companies_company_assets**](CompaniesApi.md#companies_company_assets) | **GET** /api/v1/companies/{id}/company_assets | Company assets (approved and marketed drugs) |
12
+ | [**companies_company_funding_events**](CompaniesApi.md#companies_company_funding_events) | **GET** /api/v1/companies/{id}/company_funding_events | Company funding events |
13
+ | [**companies_company_funding_summary**](CompaniesApi.md#companies_company_funding_summary) | **GET** /api/v1/companies/{id}/company_funding_summary | Company funding summary |
10
14
  | [**companies_company_members**](CompaniesApi.md#companies_company_members) | **GET** /api/v1/companies/{id}/company_members | Company members |
11
15
  | [**companies_company_programs**](CompaniesApi.md#companies_company_programs) | **GET** /api/v1/companies/{id}/company_programs | Company programs |
12
16
  | [**companies_company_targets**](CompaniesApi.md#companies_company_targets) | **GET** /api/v1/companies/{id}/company_targets | Targets a company pursues |
@@ -15,6 +19,7 @@ All URIs are relative to *https://pharmaobservatory.com*
15
19
  | [**companies_institutional_holdings**](CompaniesApi.md#companies_institutional_holdings) | **GET** /api/v1/companies/{id}/institutional_holdings | Institutional holdings (SEC Form 13F) |
16
20
  | [**companies_legal_entities**](CompaniesApi.md#companies_legal_entities) | **GET** /api/v1/companies/{id}/legal_entities | Legal entities |
17
21
  | [**companies_list**](CompaniesApi.md#companies_list) | **GET** /api/v1/companies | List companies |
22
+ | [**companies_ownership_positions**](CompaniesApi.md#companies_ownership_positions) | **GET** /api/v1/companies/{id}/ownership_positions | Ownership and control positions |
18
23
  | [**companies_pdufa_dates**](CompaniesApi.md#companies_pdufa_dates) | **GET** /api/v1/companies/{id}/pdufa_dates | FDA decision dates (PDUFA) and catalysts |
19
24
  | [**companies_sponsor_recruitment_by_phase**](CompaniesApi.md#companies_sponsor_recruitment_by_phase) | **GET** /api/v1/companies/{id}/sponsor_recruitment_by_phase | Trial recruitment duration by sponsor and phase |
20
25
  | [**companies_sponsor_recruitment_duration**](CompaniesApi.md#companies_sponsor_recruitment_duration) | **GET** /api/v1/companies/{id}/sponsor_recruitment_duration | Trial recruitment duration by sponsor |
@@ -265,6 +270,330 @@ end
265
270
  - **Accept**: application/json
266
271
 
267
272
 
273
+ ## companies_biomarker_validation
274
+
275
+ > <BiomarkerValidationResponse> companies_biomarker_validation(id, opts)
276
+
277
+ Biomarker validation ladder
278
+
279
+ ### Examples
280
+
281
+ ```ruby
282
+ require 'time'
283
+ require 'pharmaobservatory'
284
+ # setup authorization
285
+ PharmaObservatory.configure do |config|
286
+ # Configure Bearer authorization (JWT): ApiBearerJwt
287
+ config.access_token = 'YOUR_BEARER_TOKEN'
288
+ end
289
+
290
+ api_instance = PharmaObservatory::CompaniesApi.new
291
+ id = 'company:c0185cf6c39a2536ad436cf6255494c0' # String |
292
+ opts = {
293
+ 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.
294
+ limit: 56, # Integer | Rows per page, up to 500 (default 50).
295
+ sort: 'sort_example', # String | Comma separated columns, a leading minus for descending: sort=a,-b.
296
+ group_by: 'group_by_example', # String | A dimension to group by; a date takes :year, :quarter or :month.
297
+ measure: 'measure_example', # String | count, sum(col), avg(col), min(col), max(col), median(col) or count_distinct(col).
298
+ scope: 'company' # String | company (this company only) or group (its corporate group).
299
+ }
300
+
301
+ begin
302
+ # Biomarker validation ladder
303
+ result = api_instance.companies_biomarker_validation(id, opts)
304
+ p result
305
+ rescue PharmaObservatory::ApiError => e
306
+ puts "Error when calling CompaniesApi->companies_biomarker_validation: #{e}"
307
+ end
308
+ ```
309
+
310
+ #### Using the companies_biomarker_validation_with_http_info variant
311
+
312
+ This returns an Array which contains the response data, status code and headers.
313
+
314
+ > <Array(<BiomarkerValidationResponse>, Integer, Hash)> companies_biomarker_validation_with_http_info(id, opts)
315
+
316
+ ```ruby
317
+ begin
318
+ # Biomarker validation ladder
319
+ data, status_code, headers = api_instance.companies_biomarker_validation_with_http_info(id, opts)
320
+ p status_code # => 2xx
321
+ p headers # => { ... }
322
+ p data # => <BiomarkerValidationResponse>
323
+ rescue PharmaObservatory::ApiError => e
324
+ puts "Error when calling CompaniesApi->companies_biomarker_validation_with_http_info: #{e}"
325
+ end
326
+ ```
327
+
328
+ ### Parameters
329
+
330
+ | Name | Type | Description | Notes |
331
+ | ---- | ---- | ----------- | ----- |
332
+ | **id** | **String** | | |
333
+ | **cursor** | **String** | The next_cursor of the previous page. Opaque; it is bound to the filters and the warehouse build that issued it. | [optional] |
334
+ | **limit** | **Integer** | Rows per page, up to 500 (default 50). | [optional] |
335
+ | **sort** | **String** | Comma separated columns, a leading minus for descending: sort&#x3D;a,-b. | [optional] |
336
+ | **group_by** | **String** | A dimension to group by; a date takes :year, :quarter or :month. | [optional] |
337
+ | **measure** | **String** | count, sum(col), avg(col), min(col), max(col), median(col) or count_distinct(col). | [optional] |
338
+ | **scope** | **String** | company (this company only) or group (its corporate group). | [optional] |
339
+
340
+ ### Return type
341
+
342
+ [**BiomarkerValidationResponse**](BiomarkerValidationResponse.md)
343
+
344
+ ### Authorization
345
+
346
+ [ApiBearerJwt](../README.md#ApiBearerJwt)
347
+
348
+ ### HTTP request headers
349
+
350
+ - **Content-Type**: Not defined
351
+ - **Accept**: application/json
352
+
353
+
354
+ ## companies_company_assets
355
+
356
+ > <CompanyAssetsResponse> companies_company_assets(id, opts)
357
+
358
+ Company assets (approved and marketed drugs)
359
+
360
+ ### Examples
361
+
362
+ ```ruby
363
+ require 'time'
364
+ require 'pharmaobservatory'
365
+ # setup authorization
366
+ PharmaObservatory.configure do |config|
367
+ # Configure Bearer authorization (JWT): ApiBearerJwt
368
+ config.access_token = 'YOUR_BEARER_TOKEN'
369
+ end
370
+
371
+ api_instance = PharmaObservatory::CompaniesApi.new
372
+ id = 'company:c0185cf6c39a2536ad436cf6255494c0' # String |
373
+ opts = {
374
+ 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.
375
+ limit: 56, # Integer | Rows per page, up to 500 (default 50).
376
+ sort: 'sort_example', # String | Comma separated columns, a leading minus for descending: sort=a,-b.
377
+ group_by: 'group_by_example', # String | A dimension to group by; a date takes :year, :quarter or :month.
378
+ measure: 'measure_example', # String | count, sum(col), avg(col), min(col), max(col), median(col) or count_distinct(col).
379
+ scope: 'company' # String | company (this company only) or group (its corporate group).
380
+ }
381
+
382
+ begin
383
+ # Company assets (approved and marketed drugs)
384
+ result = api_instance.companies_company_assets(id, opts)
385
+ p result
386
+ rescue PharmaObservatory::ApiError => e
387
+ puts "Error when calling CompaniesApi->companies_company_assets: #{e}"
388
+ end
389
+ ```
390
+
391
+ #### Using the companies_company_assets_with_http_info variant
392
+
393
+ This returns an Array which contains the response data, status code and headers.
394
+
395
+ > <Array(<CompanyAssetsResponse>, Integer, Hash)> companies_company_assets_with_http_info(id, opts)
396
+
397
+ ```ruby
398
+ begin
399
+ # Company assets (approved and marketed drugs)
400
+ data, status_code, headers = api_instance.companies_company_assets_with_http_info(id, opts)
401
+ p status_code # => 2xx
402
+ p headers # => { ... }
403
+ p data # => <CompanyAssetsResponse>
404
+ rescue PharmaObservatory::ApiError => e
405
+ puts "Error when calling CompaniesApi->companies_company_assets_with_http_info: #{e}"
406
+ end
407
+ ```
408
+
409
+ ### Parameters
410
+
411
+ | Name | Type | Description | Notes |
412
+ | ---- | ---- | ----------- | ----- |
413
+ | **id** | **String** | | |
414
+ | **cursor** | **String** | The next_cursor of the previous page. Opaque; it is bound to the filters and the warehouse build that issued it. | [optional] |
415
+ | **limit** | **Integer** | Rows per page, up to 500 (default 50). | [optional] |
416
+ | **sort** | **String** | Comma separated columns, a leading minus for descending: sort&#x3D;a,-b. | [optional] |
417
+ | **group_by** | **String** | A dimension to group by; a date takes :year, :quarter or :month. | [optional] |
418
+ | **measure** | **String** | count, sum(col), avg(col), min(col), max(col), median(col) or count_distinct(col). | [optional] |
419
+ | **scope** | **String** | company (this company only) or group (its corporate group). | [optional] |
420
+
421
+ ### Return type
422
+
423
+ [**CompanyAssetsResponse**](CompanyAssetsResponse.md)
424
+
425
+ ### Authorization
426
+
427
+ [ApiBearerJwt](../README.md#ApiBearerJwt)
428
+
429
+ ### HTTP request headers
430
+
431
+ - **Content-Type**: Not defined
432
+ - **Accept**: application/json
433
+
434
+
435
+ ## companies_company_funding_events
436
+
437
+ > <CompanyFundingEventsResponse> companies_company_funding_events(id, opts)
438
+
439
+ Company funding events
440
+
441
+ ### Examples
442
+
443
+ ```ruby
444
+ require 'time'
445
+ require 'pharmaobservatory'
446
+ # setup authorization
447
+ PharmaObservatory.configure do |config|
448
+ # Configure Bearer authorization (JWT): ApiBearerJwt
449
+ config.access_token = 'YOUR_BEARER_TOKEN'
450
+ end
451
+
452
+ api_instance = PharmaObservatory::CompaniesApi.new
453
+ id = 'company:c0185cf6c39a2536ad436cf6255494c0' # String |
454
+ opts = {
455
+ 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.
456
+ limit: 56, # Integer | Rows per page, up to 500 (default 50).
457
+ sort: 'sort_example', # String | Comma separated columns, a leading minus for descending: sort=a,-b.
458
+ group_by: 'group_by_example', # String | A dimension to group by; a date takes :year, :quarter or :month.
459
+ measure: 'measure_example', # String | count, sum(col), avg(col), min(col), max(col), median(col) or count_distinct(col).
460
+ scope: 'company' # String | company (this company only) or group (its corporate group).
461
+ }
462
+
463
+ begin
464
+ # Company funding events
465
+ result = api_instance.companies_company_funding_events(id, opts)
466
+ p result
467
+ rescue PharmaObservatory::ApiError => e
468
+ puts "Error when calling CompaniesApi->companies_company_funding_events: #{e}"
469
+ end
470
+ ```
471
+
472
+ #### Using the companies_company_funding_events_with_http_info variant
473
+
474
+ This returns an Array which contains the response data, status code and headers.
475
+
476
+ > <Array(<CompanyFundingEventsResponse>, Integer, Hash)> companies_company_funding_events_with_http_info(id, opts)
477
+
478
+ ```ruby
479
+ begin
480
+ # Company funding events
481
+ data, status_code, headers = api_instance.companies_company_funding_events_with_http_info(id, opts)
482
+ p status_code # => 2xx
483
+ p headers # => { ... }
484
+ p data # => <CompanyFundingEventsResponse>
485
+ rescue PharmaObservatory::ApiError => e
486
+ puts "Error when calling CompaniesApi->companies_company_funding_events_with_http_info: #{e}"
487
+ end
488
+ ```
489
+
490
+ ### Parameters
491
+
492
+ | Name | Type | Description | Notes |
493
+ | ---- | ---- | ----------- | ----- |
494
+ | **id** | **String** | | |
495
+ | **cursor** | **String** | The next_cursor of the previous page. Opaque; it is bound to the filters and the warehouse build that issued it. | [optional] |
496
+ | **limit** | **Integer** | Rows per page, up to 500 (default 50). | [optional] |
497
+ | **sort** | **String** | Comma separated columns, a leading minus for descending: sort&#x3D;a,-b. | [optional] |
498
+ | **group_by** | **String** | A dimension to group by; a date takes :year, :quarter or :month. | [optional] |
499
+ | **measure** | **String** | count, sum(col), avg(col), min(col), max(col), median(col) or count_distinct(col). | [optional] |
500
+ | **scope** | **String** | company (this company only) or group (its corporate group). | [optional] |
501
+
502
+ ### Return type
503
+
504
+ [**CompanyFundingEventsResponse**](CompanyFundingEventsResponse.md)
505
+
506
+ ### Authorization
507
+
508
+ [ApiBearerJwt](../README.md#ApiBearerJwt)
509
+
510
+ ### HTTP request headers
511
+
512
+ - **Content-Type**: Not defined
513
+ - **Accept**: application/json
514
+
515
+
516
+ ## companies_company_funding_summary
517
+
518
+ > <CompanyFundingSummaryResponse> companies_company_funding_summary(id, opts)
519
+
520
+ Company funding summary
521
+
522
+ ### Examples
523
+
524
+ ```ruby
525
+ require 'time'
526
+ require 'pharmaobservatory'
527
+ # setup authorization
528
+ PharmaObservatory.configure do |config|
529
+ # Configure Bearer authorization (JWT): ApiBearerJwt
530
+ config.access_token = 'YOUR_BEARER_TOKEN'
531
+ end
532
+
533
+ api_instance = PharmaObservatory::CompaniesApi.new
534
+ id = 'company:c0185cf6c39a2536ad436cf6255494c0' # String |
535
+ opts = {
536
+ 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.
537
+ limit: 56, # Integer | Rows per page, up to 500 (default 50).
538
+ sort: 'sort_example', # String | Comma separated columns, a leading minus for descending: sort=a,-b.
539
+ group_by: 'group_by_example', # String | A dimension to group by; a date takes :year, :quarter or :month.
540
+ measure: 'measure_example', # String | count, sum(col), avg(col), min(col), max(col), median(col) or count_distinct(col).
541
+ scope: 'company' # String | company (this company only) or group (its corporate group).
542
+ }
543
+
544
+ begin
545
+ # Company funding summary
546
+ result = api_instance.companies_company_funding_summary(id, opts)
547
+ p result
548
+ rescue PharmaObservatory::ApiError => e
549
+ puts "Error when calling CompaniesApi->companies_company_funding_summary: #{e}"
550
+ end
551
+ ```
552
+
553
+ #### Using the companies_company_funding_summary_with_http_info variant
554
+
555
+ This returns an Array which contains the response data, status code and headers.
556
+
557
+ > <Array(<CompanyFundingSummaryResponse>, Integer, Hash)> companies_company_funding_summary_with_http_info(id, opts)
558
+
559
+ ```ruby
560
+ begin
561
+ # Company funding summary
562
+ data, status_code, headers = api_instance.companies_company_funding_summary_with_http_info(id, opts)
563
+ p status_code # => 2xx
564
+ p headers # => { ... }
565
+ p data # => <CompanyFundingSummaryResponse>
566
+ rescue PharmaObservatory::ApiError => e
567
+ puts "Error when calling CompaniesApi->companies_company_funding_summary_with_http_info: #{e}"
568
+ end
569
+ ```
570
+
571
+ ### Parameters
572
+
573
+ | Name | Type | Description | Notes |
574
+ | ---- | ---- | ----------- | ----- |
575
+ | **id** | **String** | | |
576
+ | **cursor** | **String** | The next_cursor of the previous page. Opaque; it is bound to the filters and the warehouse build that issued it. | [optional] |
577
+ | **limit** | **Integer** | Rows per page, up to 500 (default 50). | [optional] |
578
+ | **sort** | **String** | Comma separated columns, a leading minus for descending: sort&#x3D;a,-b. | [optional] |
579
+ | **group_by** | **String** | A dimension to group by; a date takes :year, :quarter or :month. | [optional] |
580
+ | **measure** | **String** | count, sum(col), avg(col), min(col), max(col), median(col) or count_distinct(col). | [optional] |
581
+ | **scope** | **String** | company (this company only) or group (its corporate group). | [optional] |
582
+
583
+ ### Return type
584
+
585
+ [**CompanyFundingSummaryResponse**](CompanyFundingSummaryResponse.md)
586
+
587
+ ### Authorization
588
+
589
+ [ApiBearerJwt](../README.md#ApiBearerJwt)
590
+
591
+ ### HTTP request headers
592
+
593
+ - **Content-Type**: Not defined
594
+ - **Accept**: application/json
595
+
596
+
268
597
  ## companies_company_members
269
598
 
270
599
  > <CompanyMembersResponse> companies_company_members(id, opts)
@@ -895,6 +1224,87 @@ end
895
1224
  - **Accept**: application/json
896
1225
 
897
1226
 
1227
+ ## companies_ownership_positions
1228
+
1229
+ > <OwnershipPositionsResponse> companies_ownership_positions(id, opts)
1230
+
1231
+ Ownership and control positions
1232
+
1233
+ ### Examples
1234
+
1235
+ ```ruby
1236
+ require 'time'
1237
+ require 'pharmaobservatory'
1238
+ # setup authorization
1239
+ PharmaObservatory.configure do |config|
1240
+ # Configure Bearer authorization (JWT): ApiBearerJwt
1241
+ config.access_token = 'YOUR_BEARER_TOKEN'
1242
+ end
1243
+
1244
+ api_instance = PharmaObservatory::CompaniesApi.new
1245
+ id = 'company:c0185cf6c39a2536ad436cf6255494c0' # String |
1246
+ opts = {
1247
+ 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.
1248
+ limit: 56, # Integer | Rows per page, up to 500 (default 50).
1249
+ sort: 'sort_example', # String | Comma separated columns, a leading minus for descending: sort=a,-b.
1250
+ group_by: 'group_by_example', # String | A dimension to group by; a date takes :year, :quarter or :month.
1251
+ measure: 'measure_example', # String | count, sum(col), avg(col), min(col), max(col), median(col) or count_distinct(col).
1252
+ scope: 'company' # String | company (this company only) or group (its corporate group).
1253
+ }
1254
+
1255
+ begin
1256
+ # Ownership and control positions
1257
+ result = api_instance.companies_ownership_positions(id, opts)
1258
+ p result
1259
+ rescue PharmaObservatory::ApiError => e
1260
+ puts "Error when calling CompaniesApi->companies_ownership_positions: #{e}"
1261
+ end
1262
+ ```
1263
+
1264
+ #### Using the companies_ownership_positions_with_http_info variant
1265
+
1266
+ This returns an Array which contains the response data, status code and headers.
1267
+
1268
+ > <Array(<OwnershipPositionsResponse>, Integer, Hash)> companies_ownership_positions_with_http_info(id, opts)
1269
+
1270
+ ```ruby
1271
+ begin
1272
+ # Ownership and control positions
1273
+ data, status_code, headers = api_instance.companies_ownership_positions_with_http_info(id, opts)
1274
+ p status_code # => 2xx
1275
+ p headers # => { ... }
1276
+ p data # => <OwnershipPositionsResponse>
1277
+ rescue PharmaObservatory::ApiError => e
1278
+ puts "Error when calling CompaniesApi->companies_ownership_positions_with_http_info: #{e}"
1279
+ end
1280
+ ```
1281
+
1282
+ ### Parameters
1283
+
1284
+ | Name | Type | Description | Notes |
1285
+ | ---- | ---- | ----------- | ----- |
1286
+ | **id** | **String** | | |
1287
+ | **cursor** | **String** | The next_cursor of the previous page. Opaque; it is bound to the filters and the warehouse build that issued it. | [optional] |
1288
+ | **limit** | **Integer** | Rows per page, up to 500 (default 50). | [optional] |
1289
+ | **sort** | **String** | Comma separated columns, a leading minus for descending: sort&#x3D;a,-b. | [optional] |
1290
+ | **group_by** | **String** | A dimension to group by; a date takes :year, :quarter or :month. | [optional] |
1291
+ | **measure** | **String** | count, sum(col), avg(col), min(col), max(col), median(col) or count_distinct(col). | [optional] |
1292
+ | **scope** | **String** | company (this company only) or group (its corporate group). | [optional] |
1293
+
1294
+ ### Return type
1295
+
1296
+ [**OwnershipPositionsResponse**](OwnershipPositionsResponse.md)
1297
+
1298
+ ### Authorization
1299
+
1300
+ [ApiBearerJwt](../README.md#ApiBearerJwt)
1301
+
1302
+ ### HTTP request headers
1303
+
1304
+ - **Content-Type**: Not defined
1305
+ - **Accept**: application/json
1306
+
1307
+
898
1308
  ## companies_pdufa_dates
899
1309
 
900
1310
  > <PdufaDatesResponse> companies_pdufa_dates(id, opts)
@@ -7,7 +7,7 @@
7
7
  | **object_type** | **String** | | |
8
8
  | **id** | **String** | | |
9
9
  | **record** | [**CompaniesRow**](CompaniesRow.md) | | |
10
- | **attributes** | **Object** | | [optional] |
10
+ | **attributes** | [**CompaniesRecordAttributes**](CompaniesRecordAttributes.md) | | [optional] |
11
11
  | **datasets** | [**Array&lt;DatasetListing&gt;**](DatasetListing.md) | | |
12
12
  | **attribution** | [**Array&lt;DatasetAttribution&gt;**](DatasetAttribution.md) | | [optional] |
13
13
  | **source_credit** | **String** | | [optional] |
@@ -0,0 +1,18 @@
1
+ # PharmaObservatory::CompaniesRecordAttributes
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **company_funding_summary** | [**CompanyFundingSummaryRow**](CompanyFundingSummaryRow.md) | | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'pharmaobservatory'
13
+
14
+ instance = PharmaObservatory::CompaniesRecordAttributes.new(
15
+ company_funding_summary: null
16
+ )
17
+ ```
18
+
data/docs/CompaniesRow.md CHANGED
@@ -10,9 +10,9 @@
10
10
  | **country** | **String** | Country of the company&#39;s own legal entity, as the source states it. | [optional] |
11
11
  | **org_type** | **String** | The organization type of the company&#39;s representative record. | [optional] |
12
12
  | **org_kinds** | **Array&lt;String&gt;** | The roles the company&#39;s organizations play (Manufacturer, Sponsor and so on). | [optional] |
13
- | **edgar_cik** | **String** | SEC EDGAR central index key of the representative record, when it files. | [optional] |
13
+ | **edgar_cik** | **String** | Central index key (CIK) in EDGAR, the US Securities and Exchange Commission (SEC) filing system, of the representative record, when it files. | [optional] |
14
14
  | **edgar_ticker** | **String** | Exchange ticker of the representative record, when listed. | [optional] |
15
- | **representative_org_id** | **String** | Legal-entity level: the organization record the company page shows. | [optional] |
15
+ | **representative_org_id** | **String** | Legal-entity level: the organization record the company&#39;s page shows. | [optional] |
16
16
  | **parent_company_id** | **String** | The direct owner company (part_of), null for a root. | [optional] |
17
17
  | **parent_company_name** | **String** | Display name of the direct owner company. | [optional] |
18
18
  | **part_of_since** | **Date** | Date the ownership link began, when every hop is dated. | [optional] |
@@ -28,6 +28,8 @@
28
28
  | **total_lead_enrollment** | **Integer** | Planned enrollment across led trials. | [optional] |
29
29
  | **num_recent_lead_trials** | **Integer** | Led trials started in the recent window. | [optional] |
30
30
  | **activity_score** | **Float** | Trial activity score (interventional lead trials and enrollment, weighted toward recent). | [optional] |
31
+ | **is_admitted** | **Boolean** | True when the company is admitted to the company roster (lead-trial activity, more than one legal entity or a recorded manufacturer role); false rows carry null firmographic, trial-count and activity columns. | [optional] |
32
+ | **has_public_page** | **Boolean** | True when the company has a public organization page. | [optional] |
31
33
 
32
34
  ## Example
33
35
 
@@ -58,7 +60,9 @@ instance = PharmaObservatory::CompaniesRow.new(
58
60
  num_trials: null,
59
61
  total_lead_enrollment: null,
60
62
  num_recent_lead_trials: null,
61
- activity_score: null
63
+ activity_score: null,
64
+ is_admitted: null,
65
+ has_public_page: null
62
66
  )
63
67
  ```
64
68
 
@@ -0,0 +1,58 @@
1
+ # PharmaObservatory::CompanyAssetsResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **dataset** | **String** | | |
8
+ | **grain** | **String** | | [optional] |
9
+ | **object_type** | **String** | | [optional] |
10
+ | **id** | **String** | | [optional] |
11
+ | **scope** | [**BiomarkerCdxAssertionsResponseScope**](BiomarkerCdxAssertionsResponseScope.md) | | [optional] |
12
+ | **columns** | [**Array&lt;DatasetColumn&gt;**](DatasetColumn.md) | | |
13
+ | **rows** | [**Array&lt;CompanyAssetsRow&gt;**](CompanyAssetsRow.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** | [**BiomarkerCdxAssertionsResponseFreshness**](BiomarkerCdxAssertionsResponseFreshness.md) | | [optional] |
25
+ | **build** | [**BiomarkerCdxAssertionsResponseBuild**](BiomarkerCdxAssertionsResponseBuild.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::CompanyAssetsResponse.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,42 @@
1
+ # PharmaObservatory::CompanyAssetsRow
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **sponsor_org_id** | **String** | Legal-entity level: the lead sponsor&#39;s organization record. | [optional] |
8
+ | **sponsor_name** | **String** | The sponsor&#39;s organization name. | [optional] |
9
+ | **sponsor_company_id** | **String** | Company level: the sponsor&#39;s company (null when unresolved). | [optional] |
10
+ | **sponsor_company_name** | **String** | Display name of the sponsor&#39;s company. | [optional] |
11
+ | **sponsor_group_id** | **String** | Group level: the sponsor&#39;s current ultimate parent; a root&#39;s group is itself. | [optional] |
12
+ | **sponsor_group_name** | **String** | Display name of the sponsor&#39;s group. | [optional] |
13
+ | **drug_id** | **String** | The drug key. | [optional] |
14
+ | **drug_name** | **String** | The drug&#39;s name. | [optional] |
15
+ | **max_phase** | **Integer** | Highest phase the sponsor reached on the drug: 0 early phase 1 through 6 for phase 4 (marketed); -1 when unstated. | [optional] |
16
+ | **n_trials** | **Integer** | Distinct trials this sponsor leads on the drug. Counted once per trial within the sponsor organization, so it is not additive across a company&#39;s organizations. | [optional] |
17
+ | **n_active** | **Integer** | Of those trials, the number recruiting, not yet recruiting, active or enrolling by invitation. | [optional] |
18
+ | **last_year** | **Integer** | Latest start year among those trials. | [optional] |
19
+ | **withdrawn** | **Boolean** | True when the drug has been withdrawn from the market. | [optional] |
20
+
21
+ ## Example
22
+
23
+ ```ruby
24
+ require 'pharmaobservatory'
25
+
26
+ instance = PharmaObservatory::CompanyAssetsRow.new(
27
+ sponsor_org_id: null,
28
+ sponsor_name: null,
29
+ sponsor_company_id: null,
30
+ sponsor_company_name: null,
31
+ sponsor_group_id: null,
32
+ sponsor_group_name: null,
33
+ drug_id: null,
34
+ drug_name: null,
35
+ max_phase: null,
36
+ n_trials: null,
37
+ n_active: null,
38
+ last_year: null,
39
+ withdrawn: null
40
+ )
41
+ ```
42
+
@@ -0,0 +1,58 @@
1
+ # PharmaObservatory::CompanyFundingEventsResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **dataset** | **String** | | |
8
+ | **grain** | **String** | | [optional] |
9
+ | **object_type** | **String** | | [optional] |
10
+ | **id** | **String** | | [optional] |
11
+ | **scope** | [**BiomarkerCdxAssertionsResponseScope**](BiomarkerCdxAssertionsResponseScope.md) | | [optional] |
12
+ | **columns** | [**Array&lt;DatasetColumn&gt;**](DatasetColumn.md) | | |
13
+ | **rows** | [**Array&lt;CompanyFundingEventsRow&gt;**](CompanyFundingEventsRow.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** | [**BiomarkerCdxAssertionsResponseFreshness**](BiomarkerCdxAssertionsResponseFreshness.md) | | [optional] |
25
+ | **build** | [**BiomarkerCdxAssertionsResponseBuild**](BiomarkerCdxAssertionsResponseBuild.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::CompanyFundingEventsResponse.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
+