pharmaobservatory 0.1.12 → 0.1.14

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 (61) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +32 -4
  3. data/docs/BiomarkerValidationRow.md +1 -1
  4. data/docs/ChangesList200Response.md +26 -0
  5. data/docs/ChangesList200ResponseBuildState.md +20 -0
  6. data/docs/ChangesList200ResponseItemsInner.md +48 -0
  7. data/docs/ChangesList200ResponseItemsInnerEntryKeys.md +18 -0
  8. data/docs/CompaniesApi.md +328 -0
  9. data/docs/CompaniesRecordAttributes.md +2 -0
  10. data/docs/CompanyCompetitorsRow.md +3 -1
  11. data/docs/CompanyCosponsorsResponse.md +58 -0
  12. data/docs/CompanyCosponsorsRow.md +58 -0
  13. data/docs/CompanyFinancialsRow.md +18 -0
  14. data/docs/CompanyPeerProfileResponse.md +58 -0
  15. data/docs/CompanyPeerProfileRow.md +60 -0
  16. data/docs/CompanyPeersResponse.md +58 -0
  17. data/docs/CompanyPeersRow.md +54 -0
  18. data/docs/ConditionAdverseEventsRow.md +5 -1
  19. data/docs/InvestorPortfolioRow.md +2 -0
  20. data/docs/LegalEntitiesApi.md +80 -0
  21. data/docs/SubscriptionsApi.md +282 -0
  22. data/docs/SubscriptionsCreate201Response.md +22 -0
  23. data/docs/SubscriptionsCreate201ResponseSubscription.md +28 -0
  24. data/docs/SubscriptionsCreate201ResponseSubscriptionTarget.md +22 -0
  25. data/docs/SubscriptionsCreateRequest.md +20 -0
  26. data/docs/SubscriptionsDelete200Response.md +24 -0
  27. data/docs/SubscriptionsList200Response.md +22 -0
  28. data/docs/SubscriptionsList200ResponseSubscriptionsInner.md +28 -0
  29. data/docs/SubscriptionsList200ResponseSubscriptionsInnerTarget.md +26 -0
  30. data/docs/SubscriptionsList200ResponseSubscriptionsInnerTargetFilters.md +18 -0
  31. data/lib/pharmaobservatory/api/companies_api.rb +364 -0
  32. data/lib/pharmaobservatory/api/legal_entities_api.rb +84 -0
  33. data/lib/pharmaobservatory/api/subscriptions_api.rb +261 -0
  34. data/lib/pharmaobservatory/models/biomarker_validation_row.rb +1 -1
  35. data/lib/pharmaobservatory/models/changes_list200_response.rb +343 -0
  36. data/lib/pharmaobservatory/models/changes_list200_response_build_state.rb +263 -0
  37. data/lib/pharmaobservatory/models/changes_list200_response_items_inner.rb +627 -0
  38. data/lib/pharmaobservatory/models/changes_list200_response_items_inner_entry_keys.rb +237 -0
  39. data/lib/pharmaobservatory/models/companies_record_attributes.rb +10 -1
  40. data/lib/pharmaobservatory/models/company_competitors_row.rb +16 -5
  41. data/lib/pharmaobservatory/models/company_cosponsors_response.rb +478 -0
  42. data/lib/pharmaobservatory/models/company_cosponsors_row.rb +445 -0
  43. data/lib/pharmaobservatory/models/company_financials_row.rb +100 -1
  44. data/lib/pharmaobservatory/models/company_peer_profile_response.rb +478 -0
  45. data/lib/pharmaobservatory/models/company_peer_profile_row.rb +454 -0
  46. data/lib/pharmaobservatory/models/company_peers_response.rb +478 -0
  47. data/lib/pharmaobservatory/models/company_peers_row.rb +421 -0
  48. data/lib/pharmaobservatory/models/condition_adverse_events_row.rb +27 -5
  49. data/lib/pharmaobservatory/models/investor_portfolio_row.rb +12 -1
  50. data/lib/pharmaobservatory/models/subscriptions_create201_response.rb +289 -0
  51. data/lib/pharmaobservatory/models/subscriptions_create201_response_subscription.rb +369 -0
  52. data/lib/pharmaobservatory/models/subscriptions_create201_response_subscription_target.rb +289 -0
  53. data/lib/pharmaobservatory/models/subscriptions_create_request.rb +263 -0
  54. data/lib/pharmaobservatory/models/subscriptions_delete200_response.rb +315 -0
  55. data/lib/pharmaobservatory/models/subscriptions_list200_response.rb +291 -0
  56. data/lib/pharmaobservatory/models/subscriptions_list200_response_subscriptions_inner.rb +369 -0
  57. data/lib/pharmaobservatory/models/subscriptions_list200_response_subscriptions_inner_target.rb +277 -0
  58. data/lib/pharmaobservatory/models/subscriptions_list200_response_subscriptions_inner_target_filters.rb +237 -0
  59. data/lib/pharmaobservatory/version.rb +1 -1
  60. data/lib/pharmaobservatory.rb +20 -0
  61. metadata +42 -2
@@ -0,0 +1,58 @@
1
+ # PharmaObservatory::CompanyCosponsorsResponse
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** | [**AnimalWelfareAssurancesResponseScope**](AnimalWelfareAssurancesResponseScope.md) | | [optional] |
12
+ | **columns** | [**Array<DatasetColumn>**](DatasetColumn.md) | | |
13
+ | **rows** | [**Array<CompanyCosponsorsRow>**](CompanyCosponsorsRow.md) | | |
14
+ | **total** | **Integer** | The exact count of the filtered rows on an ungrouped read, carried by the cursor; null when grouped. | [optional] |
15
+ | **next_cursor** | **String** | | [optional] |
16
+ | **sort** | **Array<String>** | | [optional] |
17
+ | **filters** | **Array<Hash<String, Object>>** | | [optional] |
18
+ | **group_by** | **Array<String>** | | [optional] |
19
+ | **measures** | **Array<String>** | | [optional] |
20
+ | **attribution** | [**Array<DatasetAttribution>**](DatasetAttribution.md) | | [optional] |
21
+ | **source_credit** | **String** | | [optional] |
22
+ | **withheld_tiers** | **Array<String>** | | [optional] |
23
+ | **withheld_columns** | **Array<String>** | | [optional] |
24
+ | **freshness** | [**AnimalWelfareAssurancesResponseFreshness**](AnimalWelfareAssurancesResponseFreshness.md) | | [optional] |
25
+ | **build** | [**AnimalWelfareAssurancesResponseBuild**](AnimalWelfareAssurancesResponseBuild.md) | | [optional] |
26
+ | **build_state** | [**DatasetBuildState**](DatasetBuildState.md) | | [optional] |
27
+ | **restriction** | **Hash<String, Object>** | | [optional] |
28
+
29
+ ## Example
30
+
31
+ ```ruby
32
+ require 'pharmaobservatory'
33
+
34
+ instance = PharmaObservatory::CompanyCosponsorsResponse.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,58 @@
1
+ # PharmaObservatory::CompanyCosponsorsRow
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **company_id** | **String** | Company level: the company the row is about; the entry key for the companies object type. | [optional] |
8
+ | **company_name** | **String** | Display name of the company. | [optional] |
9
+ | **group_id** | **String** | Group level: the company's current ultimate parent; a root's group is itself. | [optional] |
10
+ | **group_name** | **String** | Display name of the group. | [optional] |
11
+ | **row_level** | **String** | root: the co-sponsor's ultimate parent company, with the distinct trials any company of that root shares with this company. member: a company under that root that itself co-sponsored, with its own count. Filter on one level; the two do not add. | [optional] |
12
+ | **cosponsor_company_id** | **String** | Company level: the co-sponsoring company. At row_level root this is the root company; at member it is the member company itself. | [optional] |
13
+ | **cosponsor_company_name** | **String** | Display name of the co-sponsoring company. | [optional] |
14
+ | **cosponsor_group_id** | **String** | Group level: the co-sponsor's current ultimate parent; a root's group is itself. | [optional] |
15
+ | **cosponsor_group_name** | **String** | Display name of the co-sponsor's group. | [optional] |
16
+ | **cosponsor_root_id** | **String** | The ultimate parent company of the co-sponsor, the ladder company's `coalesce(ultimate_parent_company_id, company_id)`. Equal to cosponsor_company_id at row_level root, and the root a member row sits under. | [optional] |
17
+ | **cosponsor_rank** | **Integer** | The rank of the ROOT among this company's co-sponsor roots by distinct shared trials (1 is the most; ties broken by root id). The same on a root row and on each of its member rows. | [optional] |
18
+ | **member_rank** | **Integer** | 0 on a root row; 1 and up on the member rows of that root, by the member's own shared trials. Order by cosponsor_rank then member_rank to list each root followed by its members. | [optional] |
19
+ | **n_members** | **Integer** | Member companies of this root that co-sponsored with this company, before the member cut. The same on a root row and its member rows. | [optional] |
20
+ | **n_candidates** | **Integer** | Distinct co-sponsor roots for this company before the top-25 cut; the same on every row of a company. | [optional] |
21
+ | **n_shared_trials** | **Integer** | Distinct trials that name both. At row_level root, the distinct trials of any company under the root (never a sum over members); at member, that company's own trials. | [optional] |
22
+ | **n_trials_company_lead** | **Integer** | Of the shared trials, those where an organization record of this company holds the ClinicalTrials.gov lead sponsor role. At most n_shared_trials; it may overlap n_trials_cosponsor_lead. | [optional] |
23
+ | **n_trials_cosponsor_lead** | **Integer** | Of the shared trials, those where the co-sponsor's organization record holds the lead sponsor role. At most n_shared_trials. | [optional] |
24
+ | **first_shared_start_year** | **Integer** | The earliest registered start year over the shared trials; null when none has a plausible year. | [optional] |
25
+ | **last_shared_start_year** | **Integer** | The latest registered start year over the shared trials; null when none has a plausible year. | [optional] |
26
+ | **n_shared_conditions** | **Integer** | Distinct specific MeSH disease areas over the shared trials. | [optional] |
27
+ | **top_shared_conditions** | **Array<String>** | Up to 5 MeSH disease names by shared-trial count then name. An empty list when none. | [optional] |
28
+
29
+ ## Example
30
+
31
+ ```ruby
32
+ require 'pharmaobservatory'
33
+
34
+ instance = PharmaObservatory::CompanyCosponsorsRow.new(
35
+ company_id: null,
36
+ company_name: null,
37
+ group_id: null,
38
+ group_name: null,
39
+ row_level: null,
40
+ cosponsor_company_id: null,
41
+ cosponsor_company_name: null,
42
+ cosponsor_group_id: null,
43
+ cosponsor_group_name: null,
44
+ cosponsor_root_id: null,
45
+ cosponsor_rank: null,
46
+ member_rank: null,
47
+ n_members: null,
48
+ n_candidates: null,
49
+ n_shared_trials: null,
50
+ n_trials_company_lead: null,
51
+ n_trials_cosponsor_lead: null,
52
+ first_shared_start_year: null,
53
+ last_shared_start_year: null,
54
+ n_shared_conditions: null,
55
+ top_shared_conditions: null
56
+ )
57
+ ```
58
+
@@ -19,6 +19,15 @@
19
19
  | **latest_shares_outstanding** | **Float** | The latest reported cover-page share count of the filer, repeated on every year row (the denominator of an ownership percentage). | [optional] |
20
20
  | **latest_shares_outstanding_fy** | **Integer** | The fiscal year of latest_shares_outstanding. | [optional] |
21
21
  | **latest_financial_fy** | **Integer** | The latest fiscal year the filer reported any line item. | [optional] |
22
+ | **quarter_end_date** | **Date** | The end of the latest reported quarter of the filer that has an operating cash flow figure (a 10-Q, or the Q4 derived from a 10-K); the date of the cash figure below. Repeated on every year row of the filer; null for a company with no quarterly SEC filings. | [optional] |
23
+ | **quarter_filed_date** | **Date** | The date SEC received the filing of that latest quarter. | [optional] |
24
+ | **cash_and_investments_latest_q** | **Float** | Cash plus short-term investments at quarter_end_date, in USD (non-current investments are not counted). | [optional] |
25
+ | **operating_cash_flow_latest_q** | **Float** | Net cash from operating activities of that latest quarter alone (year-to-date figures differenced; Q4 is the full year less nine months), in USD; negative means burning. | [optional] |
26
+ | **burn_basis_quarters** | **Integer** | How many contiguous quarters burn_basis_quarterly_usd averages over, 1 or 2. | [optional] |
27
+ | **burn_basis_quarterly_usd** | **Float** | The mean quarterly operating cash flow over the latest two contiguous quarters (the latest alone when no contiguous earlier quarter has a figure), in USD; negative means burning. | [optional] |
28
+ | **runway_months_quarterly** | **Float** | An estimate, derived not reported: cash_and_investments_latest_q divided by the monthly burn (burn_basis_quarterly_usd over 3), in months at quarter_end_date, rounded to 0.1. Null whenever runway_quarterly_null_reason is set. | [optional] |
29
+ | **runway_quarterly_method** | **String** | The version of the derivation behind runway_months_quarterly; trailing_quarter_mean_v1 is the mean of the latest two contiguous discrete quarters. | [optional] |
30
+ | **runway_quarterly_null_reason** | **String** | Why runway_months_quarterly is null, in precedence order: no_quarterly_facts (no 10-Q cash-flow facts: a private company or a 20-F/40-F filer), stale (the latest quarter ended over a year before the newest SEC filing loaded), no_fx_rate, no_cash_at_quarter_end, or positive_cash_flow (no burn to run out of). Null when the runway is published. | [optional] |
22
31
  | **revenue** | **Float** | Total revenue for the fiscal year, in USD (a non-USD filer is converted at the calendar-year average rate; null when no rate exists). | [optional] |
23
32
  | **net_income** | **Float** | Net income for the fiscal year, in USD. | [optional] |
24
33
  | **rnd** | **Float** | Research and development expense for the fiscal year, in USD. | [optional] |
@@ -72,6 +81,15 @@ instance = PharmaObservatory::CompanyFinancialsRow.new(
72
81
  latest_shares_outstanding: null,
73
82
  latest_shares_outstanding_fy: null,
74
83
  latest_financial_fy: null,
84
+ quarter_end_date: null,
85
+ quarter_filed_date: null,
86
+ cash_and_investments_latest_q: null,
87
+ operating_cash_flow_latest_q: null,
88
+ burn_basis_quarters: null,
89
+ burn_basis_quarterly_usd: null,
90
+ runway_months_quarterly: null,
91
+ runway_quarterly_method: null,
92
+ runway_quarterly_null_reason: null,
75
93
  revenue: null,
76
94
  net_income: null,
77
95
  rnd: null,
@@ -0,0 +1,58 @@
1
+ # PharmaObservatory::CompanyPeerProfileResponse
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** | [**AnimalWelfareAssurancesResponseScope**](AnimalWelfareAssurancesResponseScope.md) | | [optional] |
12
+ | **columns** | [**Array<DatasetColumn>**](DatasetColumn.md) | | |
13
+ | **rows** | [**Array<CompanyPeerProfileRow>**](CompanyPeerProfileRow.md) | | |
14
+ | **total** | **Integer** | The exact count of the filtered rows on an ungrouped read, carried by the cursor; null when grouped. | [optional] |
15
+ | **next_cursor** | **String** | | [optional] |
16
+ | **sort** | **Array<String>** | | [optional] |
17
+ | **filters** | **Array<Hash<String, Object>>** | | [optional] |
18
+ | **group_by** | **Array<String>** | | [optional] |
19
+ | **measures** | **Array<String>** | | [optional] |
20
+ | **attribution** | [**Array<DatasetAttribution>**](DatasetAttribution.md) | | [optional] |
21
+ | **source_credit** | **String** | | [optional] |
22
+ | **withheld_tiers** | **Array<String>** | | [optional] |
23
+ | **withheld_columns** | **Array<String>** | | [optional] |
24
+ | **freshness** | [**AnimalWelfareAssurancesResponseFreshness**](AnimalWelfareAssurancesResponseFreshness.md) | | [optional] |
25
+ | **build** | [**AnimalWelfareAssurancesResponseBuild**](AnimalWelfareAssurancesResponseBuild.md) | | [optional] |
26
+ | **build_state** | [**DatasetBuildState**](DatasetBuildState.md) | | [optional] |
27
+ | **restriction** | **Hash<String, Object>** | | [optional] |
28
+
29
+ ## Example
30
+
31
+ ```ruby
32
+ require 'pharmaobservatory'
33
+
34
+ instance = PharmaObservatory::CompanyPeerProfileResponse.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,60 @@
1
+ # PharmaObservatory::CompanyPeerProfileRow
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **company_id** | **String** | Company level: the company the row is about; the entry key for the companies object type. | [optional] |
8
+ | **company_name** | **String** | Display name of the company. | [optional] |
9
+ | **group_id** | **String** | Group level: the company's current ultimate parent; a root's group is itself. | [optional] |
10
+ | **group_name** | **String** | Display name of the group. | [optional] |
11
+ | **peer_state** | **String** | measured when the company has at least one peer; no_live_owned_program when it has no live owned program; phase_not_reported when its live owned programs carry no phase; no_candidates when stage and modality are known and no other company shares them. | [optional] |
12
+ | **n_live_owned_programs** | **Integer** | Distinct live owned (drug, condition) programs of the company's subtree. | [optional] |
13
+ | **n_live_owned_drugs** | **Integer** | Distinct live owned drugs of the company's subtree. | [optional] |
14
+ | **lead_stage** | **String** | Furthest phase of the live owned programs: approved, phase3, phase2 (Phase 2/3 included), phase1 (Phase 1/2 included) or early_phase1. Null when no program carries a phase. | [optional] |
15
+ | **lead_max_phase** | **Integer** | The phase code behind lead_stage: 6 Phase 4 or approved, 5 Phase 3, 4 Phase 2/3, 3 Phase 2, 2 Phase 1/2, 1 Phase 1, 0 Early Phase 1. | [optional] |
16
+ | **lead_drug_id** | **String** | The canonical drug id of the lead drug, the highest-phase live owned drug (ties: most trials, then drug id). | [optional] |
17
+ | **lead_drug_name** | **String** | Name of the lead drug. | [optional] |
18
+ | **n_biologic_drugs** | **Integer** | Live owned drugs whose GSRS substance type is protein or nucleic acid. | [optional] |
19
+ | **biologic_share** | **Float** | n_biologic_drugs over n_live_owned_drugs, 0 to 1. Null when the company has no live owned drug. | [optional] |
20
+ | **modality_band** | **String** | biologic when biologic_share is at least 0.5, else non_biologic. | [optional] |
21
+ | **primary_area** | **String** | MeSH top-level category with the most live owned program trials. | [optional] |
22
+ | **primary_area_trials** | **Integer** | Live owned program trials in primary_area. | [optional] |
23
+ | **num_lead_trials** | **Integer** | Distinct lead-sponsored trials of the company's subtree. | [optional] |
24
+ | **size_band** | **String** | Band of num_lead_trials: 1-4, 5-19, 20-99 or 100+. | [optional] |
25
+ | **n_cell_candidates** | **Integer** | Other measured companies outside the company's group that share stage, modality, area and size (match level 1), before the top 10 are kept. | [optional] |
26
+ | **n_peers** | **Integer** | Peer rows kept for the company, at most 10. | [optional] |
27
+ | **coverage_measured** | **Integer** | Companies in this dataset with peer_state measured. The same value on every row. | [optional] |
28
+ | **coverage_total** | **Integer** | Companies in this dataset. The same value on every row. | [optional] |
29
+
30
+ ## Example
31
+
32
+ ```ruby
33
+ require 'pharmaobservatory'
34
+
35
+ instance = PharmaObservatory::CompanyPeerProfileRow.new(
36
+ company_id: null,
37
+ company_name: null,
38
+ group_id: null,
39
+ group_name: null,
40
+ peer_state: null,
41
+ n_live_owned_programs: null,
42
+ n_live_owned_drugs: null,
43
+ lead_stage: null,
44
+ lead_max_phase: null,
45
+ lead_drug_id: null,
46
+ lead_drug_name: null,
47
+ n_biologic_drugs: null,
48
+ biologic_share: null,
49
+ modality_band: null,
50
+ primary_area: null,
51
+ primary_area_trials: null,
52
+ num_lead_trials: null,
53
+ size_band: null,
54
+ n_cell_candidates: null,
55
+ n_peers: null,
56
+ coverage_measured: null,
57
+ coverage_total: null
58
+ )
59
+ ```
60
+
@@ -0,0 +1,58 @@
1
+ # PharmaObservatory::CompanyPeersResponse
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** | [**AnimalWelfareAssurancesResponseScope**](AnimalWelfareAssurancesResponseScope.md) | | [optional] |
12
+ | **columns** | [**Array<DatasetColumn>**](DatasetColumn.md) | | |
13
+ | **rows** | [**Array<CompanyPeersRow>**](CompanyPeersRow.md) | | |
14
+ | **total** | **Integer** | The exact count of the filtered rows on an ungrouped read, carried by the cursor; null when grouped. | [optional] |
15
+ | **next_cursor** | **String** | | [optional] |
16
+ | **sort** | **Array<String>** | | [optional] |
17
+ | **filters** | **Array<Hash<String, Object>>** | | [optional] |
18
+ | **group_by** | **Array<String>** | | [optional] |
19
+ | **measures** | **Array<String>** | | [optional] |
20
+ | **attribution** | [**Array<DatasetAttribution>**](DatasetAttribution.md) | | [optional] |
21
+ | **source_credit** | **String** | | [optional] |
22
+ | **withheld_tiers** | **Array<String>** | | [optional] |
23
+ | **withheld_columns** | **Array<String>** | | [optional] |
24
+ | **freshness** | [**AnimalWelfareAssurancesResponseFreshness**](AnimalWelfareAssurancesResponseFreshness.md) | | [optional] |
25
+ | **build** | [**AnimalWelfareAssurancesResponseBuild**](AnimalWelfareAssurancesResponseBuild.md) | | [optional] |
26
+ | **build_state** | [**DatasetBuildState**](DatasetBuildState.md) | | [optional] |
27
+ | **restriction** | **Hash<String, Object>** | | [optional] |
28
+
29
+ ## Example
30
+
31
+ ```ruby
32
+ require 'pharmaobservatory'
33
+
34
+ instance = PharmaObservatory::CompanyPeersResponse.new(
35
+ dataset: null,
36
+ grain: null,
37
+ object_type: null,
38
+ id: null,
39
+ scope: null,
40
+ columns: null,
41
+ rows: null,
42
+ total: null,
43
+ next_cursor: null,
44
+ sort: null,
45
+ filters: null,
46
+ group_by: null,
47
+ measures: null,
48
+ attribution: null,
49
+ source_credit: null,
50
+ withheld_tiers: null,
51
+ withheld_columns: null,
52
+ freshness: null,
53
+ build: null,
54
+ build_state: null,
55
+ restriction: null
56
+ )
57
+ ```
58
+
@@ -0,0 +1,54 @@
1
+ # PharmaObservatory::CompanyPeersRow
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **company_id** | **String** | Company level: the company the row is about; the entry key for the companies object type. | [optional] |
8
+ | **company_name** | **String** | Display name of the company. | [optional] |
9
+ | **group_id** | **String** | Group level: the company's current ultimate parent; a root's group is itself. | [optional] |
10
+ | **group_name** | **String** | Display name of the group. | [optional] |
11
+ | **peer_company_id** | **String** | Company level: the peer company. | [optional] |
12
+ | **peer_company_name** | **String** | Display name of the peer company. | [optional] |
13
+ | **peer_group_id** | **String** | Group level: the peer's current ultimate parent; a root's group is itself. | [optional] |
14
+ | **peer_group_name** | **String** | Display name of the peer's group. | [optional] |
15
+ | **peer_rank** | **Integer** | The peer's rank for the company, 1 is the closest match: match_level first, then the closeness of lead-trial counts, then of biologic share. Dense 1 to N. | [optional] |
16
+ | **match_level** | **Integer** | What the peer matched the company on. 1 stage, modality, area and size; 2 stage, modality and area; 3 stage, modality and size; 4 stage and modality. Stage and modality always match. | [optional] |
17
+ | **matched_area** | **Boolean** | True when the peer shares the company's primary therapeutic area. | [optional] |
18
+ | **matched_size** | **Boolean** | True when the peer shares the company's size band. | [optional] |
19
+ | **lead_stage** | **String** | The peer's lead stage, the furthest phase of its live owned programs. Equal to the company's lead stage on every row. | [optional] |
20
+ | **lead_drug_name** | **String** | The peer's lead drug, the highest-phase live owned drug (ties: most trials). | [optional] |
21
+ | **biologic_share** | **Float** | Share, 0 to 1, of the peer's live owned drugs that are biologic (GSRS protein or nucleic acid substance type). | [optional] |
22
+ | **modality_band** | **String** | biologic when biologic_share is at least 0.5, else non_biologic. Equal to the company's band on every row. | [optional] |
23
+ | **primary_area** | **String** | The peer's primary therapeutic area: the MeSH top-level category with the most live owned program trials. | [optional] |
24
+ | **num_lead_trials** | **Integer** | Distinct lead-sponsored trials of the peer's subtree. | [optional] |
25
+ | **size_band** | **String** | Band of num_lead_trials: 1-4, 5-19, 20-99 or 100+. | [optional] |
26
+
27
+ ## Example
28
+
29
+ ```ruby
30
+ require 'pharmaobservatory'
31
+
32
+ instance = PharmaObservatory::CompanyPeersRow.new(
33
+ company_id: null,
34
+ company_name: null,
35
+ group_id: null,
36
+ group_name: null,
37
+ peer_company_id: null,
38
+ peer_company_name: null,
39
+ peer_group_id: null,
40
+ peer_group_name: null,
41
+ peer_rank: null,
42
+ match_level: null,
43
+ matched_area: null,
44
+ matched_size: null,
45
+ lead_stage: null,
46
+ lead_drug_name: null,
47
+ biologic_share: null,
48
+ modality_band: null,
49
+ primary_area: null,
50
+ num_lead_trials: null,
51
+ size_band: null
52
+ )
53
+ ```
54
+
@@ -8,6 +8,8 @@
8
8
  | **adverse_event_term** | **String** | The adverse event term as the trials report it. | [optional] |
9
9
  | **subjects_affected** | **Float** | Subjects affected, summed across the condition's trials. | [optional] |
10
10
  | **n_trials** | **Integer** | Trials for this condition that report the term. | [optional] |
11
+ | **n_terms_total** | **Integer** | Distinct serious adverse event terms across the condition's trials. The rows are only the top 10 of these, so a row count is not the term count; use this. | [optional] |
12
+ | **n_trials_total** | **Integer** | Results-posting trials of the condition that report at least one serious adverse event term. | [optional] |
11
13
 
12
14
  ## Example
13
15
 
@@ -18,7 +20,9 @@ instance = PharmaObservatory::ConditionAdverseEventsRow.new(
18
20
  condition_id: null,
19
21
  adverse_event_term: null,
20
22
  subjects_affected: null,
21
- n_trials: null
23
+ n_trials: null,
24
+ n_terms_total: null,
25
+ n_trials_total: null
22
26
  )
23
27
  ```
24
28
 
@@ -28,6 +28,7 @@
28
28
  | **status_on_page** | **String** | The status the investor's page states for the company, verbatim: current, realized, exited or unknown (the page listed it with no status). Null for a row only SEC filings name. | [optional] |
29
29
  | **status_date** | **String** | The date the page itself prints for the status, as printed (for example 2024 or March 2024). Null unless the page printed one. | [optional] |
30
30
  | **status_first_observed_at** | **Date** | The date we first saw this status for the company on the investor's page: an observation date, never the date the event happened. | [optional] |
31
+ | **site_evidence_verified** | **Boolean** | True when the quote behind a website listing was found on the investor's page, false when it was not, null when no verification flag was recorded and for a row only SEC filings name. | [optional] |
31
32
  | **source_url** | **String** | The address of the investor's portfolio page the listing was read from. Null for a row only SEC filings name. | [optional] |
32
33
  | **site_last_retrieved_at** | **Time** | When the investor's portfolio page was last retrieved with the company listed on it, in UTC. | [optional] |
33
34
  | **is_life_sciences_issuer** | **Boolean** | True when the issuer's SIC (Standard Industrial Classification) code is a life-sciences code, false when it is another code, null when the issuer has no SIC evidence. | [optional] |
@@ -62,6 +63,7 @@ instance = PharmaObservatory::InvestorPortfolioRow.new(
62
63
  status_on_page: null,
63
64
  status_date: null,
64
65
  status_first_observed_at: null,
66
+ site_evidence_verified: null,
65
67
  source_url: null,
66
68
  site_last_retrieved_at: null,
67
69
  is_life_sciences_issuer: null
@@ -22,6 +22,7 @@ All URIs are relative to *https://pharmaobservatory.com*
22
22
  | [**legal_entities_inspections**](LegalEntitiesApi.md#legal_entities_inspections) | **GET** /api/v1/legal_entities/{id}/inspections | FDA inspections |
23
23
  | [**legal_entities_institutional_holdings**](LegalEntitiesApi.md#legal_entities_institutional_holdings) | **GET** /api/v1/legal_entities/{id}/institutional_holdings | Institutional holdings (SEC Form 13F) |
24
24
  | [**legal_entities_institutional_quarter_totals**](LegalEntitiesApi.md#legal_entities_institutional_quarter_totals) | **GET** /api/v1/legal_entities/{id}/institutional_quarter_totals | Institutional quarter totals (SEC Form 13F) |
25
+ | [**legal_entities_investor_portfolio**](LegalEntitiesApi.md#legal_entities_investor_portfolio) | **GET** /api/v1/legal_entities/{id}/investor_portfolio | Investor portfolio (offering filings and investor websites) |
25
26
  | [**legal_entities_legal_entity_sec_filings**](LegalEntitiesApi.md#legal_entities_legal_entity_sec_filings) | **GET** /api/v1/legal_entities/{id}/legal_entity_sec_filings | SEC filer records |
26
27
  | [**legal_entities_list**](LegalEntitiesApi.md#legal_entities_list) | **GET** /api/v1/legal_entities | List legal entities |
27
28
  | [**legal_entities_org_disclosure_trend**](LegalEntitiesApi.md#legal_entities_org_disclosure_trend) | **GET** /api/v1/legal_entities/{id}/org_disclosure_trend | Organization disclosure trend |
@@ -1460,6 +1461,85 @@ end
1460
1461
  - **Accept**: application/json
1461
1462
 
1462
1463
 
1464
+ ## legal_entities_investor_portfolio
1465
+
1466
+ > <InvestorPortfolioResponse> legal_entities_investor_portfolio(id, opts)
1467
+
1468
+ Investor portfolio (offering filings and investor websites)
1469
+
1470
+ ### Examples
1471
+
1472
+ ```ruby
1473
+ require 'time'
1474
+ require 'pharmaobservatory'
1475
+ # setup authorization
1476
+ PharmaObservatory.configure do |config|
1477
+ # Configure Bearer authorization (JWT): ApiBearerJwt
1478
+ config.access_token = 'YOUR_BEARER_TOKEN'
1479
+ end
1480
+
1481
+ api_instance = PharmaObservatory::LegalEntitiesApi.new
1482
+ id = 'edgar:0001114448' # String |
1483
+ opts = {
1484
+ 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.
1485
+ limit: 56, # Integer | Rows per page, up to 500 (default 50).
1486
+ sort: 'sort_example', # String | Comma separated columns, a leading minus for descending: sort=a,-b.
1487
+ group_by: 'group_by_example', # String | A dimension to group by; a date takes :year, :quarter or :month.
1488
+ measure: 'measure_example' # String | count, sum(col), avg(col), min(col), max(col), median(col) or count_distinct(col).
1489
+ }
1490
+
1491
+ begin
1492
+ # Investor portfolio (offering filings and investor websites)
1493
+ result = api_instance.legal_entities_investor_portfolio(id, opts)
1494
+ p result
1495
+ rescue PharmaObservatory::ApiError => e
1496
+ puts "Error when calling LegalEntitiesApi->legal_entities_investor_portfolio: #{e}"
1497
+ end
1498
+ ```
1499
+
1500
+ #### Using the legal_entities_investor_portfolio_with_http_info variant
1501
+
1502
+ This returns an Array which contains the response data, status code and headers.
1503
+
1504
+ > <Array(<InvestorPortfolioResponse>, Integer, Hash)> legal_entities_investor_portfolio_with_http_info(id, opts)
1505
+
1506
+ ```ruby
1507
+ begin
1508
+ # Investor portfolio (offering filings and investor websites)
1509
+ data, status_code, headers = api_instance.legal_entities_investor_portfolio_with_http_info(id, opts)
1510
+ p status_code # => 2xx
1511
+ p headers # => { ... }
1512
+ p data # => <InvestorPortfolioResponse>
1513
+ rescue PharmaObservatory::ApiError => e
1514
+ puts "Error when calling LegalEntitiesApi->legal_entities_investor_portfolio_with_http_info: #{e}"
1515
+ end
1516
+ ```
1517
+
1518
+ ### Parameters
1519
+
1520
+ | Name | Type | Description | Notes |
1521
+ | ---- | ---- | ----------- | ----- |
1522
+ | **id** | **String** | | |
1523
+ | **cursor** | **String** | The next_cursor of the previous page. Opaque; it is bound to the filters and the warehouse build that issued it. | [optional] |
1524
+ | **limit** | **Integer** | Rows per page, up to 500 (default 50). | [optional] |
1525
+ | **sort** | **String** | Comma separated columns, a leading minus for descending: sort&#x3D;a,-b. | [optional] |
1526
+ | **group_by** | **String** | A dimension to group by; a date takes :year, :quarter or :month. | [optional] |
1527
+ | **measure** | **String** | count, sum(col), avg(col), min(col), max(col), median(col) or count_distinct(col). | [optional] |
1528
+
1529
+ ### Return type
1530
+
1531
+ [**InvestorPortfolioResponse**](InvestorPortfolioResponse.md)
1532
+
1533
+ ### Authorization
1534
+
1535
+ [ApiBearerJwt](../README.md#ApiBearerJwt)
1536
+
1537
+ ### HTTP request headers
1538
+
1539
+ - **Content-Type**: Not defined
1540
+ - **Accept**: application/json
1541
+
1542
+
1463
1543
  ## legal_entities_legal_entity_sec_filings
1464
1544
 
1465
1545
  > <LegalEntitySecFilingsResponse> legal_entities_legal_entity_sec_filings(id, opts)