pharmaobservatory 0.1.12 → 0.1.13

data/docs/CompanyPeerProfileResponse.md

@@ -0,0 +1,58 @@
+# PharmaObservatory::CompanyPeerProfileResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **dataset** | **String** |  |  |
+| **grain** | **String** |  | [optional] |
+| **object_type** | **String** |  | [optional] |
+| **id** | **String** |  | [optional] |
+| **scope** | [**AnimalWelfareAssurancesResponseScope**](AnimalWelfareAssurancesResponseScope.md) |  | [optional] |
+| **columns** | [**Array<DatasetColumn>**](DatasetColumn.md) |  |  |
+| **rows** | [**Array<CompanyPeerProfileRow>**](CompanyPeerProfileRow.md) |  |  |
+| **total** | **Integer** | The exact count of the filtered rows on an ungrouped read, carried by the cursor; null when grouped. | [optional] |
+| **next_cursor** | **String** |  | [optional] |
+| **sort** | **Array<String>** |  | [optional] |
+| **filters** | **Array<Hash<String, Object>>** |  | [optional] |
+| **group_by** | **Array<String>** |  | [optional] |
+| **measures** | **Array<String>** |  | [optional] |
+| **attribution** | [**Array<DatasetAttribution>**](DatasetAttribution.md) |  | [optional] |
+| **source_credit** | **String** |  | [optional] |
+| **withheld_tiers** | **Array<String>** |  | [optional] |
+| **withheld_columns** | **Array<String>** |  | [optional] |
+| **freshness** | [**AnimalWelfareAssurancesResponseFreshness**](AnimalWelfareAssurancesResponseFreshness.md) |  | [optional] |
+| **build** | [**AnimalWelfareAssurancesResponseBuild**](AnimalWelfareAssurancesResponseBuild.md) |  | [optional] |
+| **build_state** | [**DatasetBuildState**](DatasetBuildState.md) |  | [optional] |
+| **restriction** | **Hash<String, Object>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'pharmaobservatory'
+
+instance = PharmaObservatory::CompanyPeerProfileResponse.new(
+  dataset: null,
+  grain: null,
+  object_type: null,
+  id: null,
+  scope: null,
+  columns: null,
+  rows: null,
+  total: null,
+  next_cursor: null,
+  sort: null,
+  filters: null,
+  group_by: null,
+  measures: null,
+  attribution: null,
+  source_credit: null,
+  withheld_tiers: null,
+  withheld_columns: null,
+  freshness: null,
+  build: null,
+  build_state: null,
+  restriction: null
+)
+```
+

data/docs/CompanyPeerProfileRow.md

@@ -0,0 +1,60 @@
+# PharmaObservatory::CompanyPeerProfileRow
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **company_id** | **String** | Company level: the company the row is about; the entry key for the companies object type. | [optional] |
+| **company_name** | **String** | Display name of the company. | [optional] |
+| **group_id** | **String** | Group level: the company's current ultimate parent; a root's group is itself. | [optional] |
+| **group_name** | **String** | Display name of the group. | [optional] |
+| **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] |
+| **n_live_owned_programs** | **Integer** | Distinct live owned (drug, condition) programs of the company's subtree. | [optional] |
+| **n_live_owned_drugs** | **Integer** | Distinct live owned drugs of the company's subtree. | [optional] |
+| **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] |
+| **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] |
+| **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] |
+| **lead_drug_name** | **String** | Name of the lead drug. | [optional] |
+| **n_biologic_drugs** | **Integer** | Live owned drugs whose GSRS substance type is protein or nucleic acid. | [optional] |
+| **biologic_share** | **Float** | n_biologic_drugs over n_live_owned_drugs, 0 to 1. Null when the company has no live owned drug. | [optional] |
+| **modality_band** | **String** | biologic when biologic_share is at least 0.5, else non_biologic. | [optional] |
+| **primary_area** | **String** | MeSH top-level category with the most live owned program trials. | [optional] |
+| **primary_area_trials** | **Integer** | Live owned program trials in primary_area. | [optional] |
+| **num_lead_trials** | **Integer** | Distinct lead-sponsored trials of the company's subtree. | [optional] |
+| **size_band** | **String** | Band of num_lead_trials: 1-4, 5-19, 20-99 or 100+. | [optional] |
+| **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] |
+| **n_peers** | **Integer** | Peer rows kept for the company, at most 10. | [optional] |
+| **coverage_measured** | **Integer** | Companies in this dataset with peer_state measured. The same value on every row. | [optional] |
+| **coverage_total** | **Integer** | Companies in this dataset. The same value on every row. | [optional] |
+
+## Example
+
+```ruby
+require 'pharmaobservatory'
+
+instance = PharmaObservatory::CompanyPeerProfileRow.new(
+  company_id: null,
+  company_name: null,
+  group_id: null,
+  group_name: null,
+  peer_state: null,
+  n_live_owned_programs: null,
+  n_live_owned_drugs: null,
+  lead_stage: null,
+  lead_max_phase: null,
+  lead_drug_id: null,
+  lead_drug_name: null,
+  n_biologic_drugs: null,
+  biologic_share: null,
+  modality_band: null,
+  primary_area: null,
+  primary_area_trials: null,
+  num_lead_trials: null,
+  size_band: null,
+  n_cell_candidates: null,
+  n_peers: null,
+  coverage_measured: null,
+  coverage_total: null
+)
+```
+

data/docs/CompanyPeersResponse.md

@@ -0,0 +1,58 @@
+# PharmaObservatory::CompanyPeersResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **dataset** | **String** |  |  |
+| **grain** | **String** |  | [optional] |
+| **object_type** | **String** |  | [optional] |
+| **id** | **String** |  | [optional] |
+| **scope** | [**AnimalWelfareAssurancesResponseScope**](AnimalWelfareAssurancesResponseScope.md) |  | [optional] |
+| **columns** | [**Array<DatasetColumn>**](DatasetColumn.md) |  |  |
+| **rows** | [**Array<CompanyPeersRow>**](CompanyPeersRow.md) |  |  |
+| **total** | **Integer** | The exact count of the filtered rows on an ungrouped read, carried by the cursor; null when grouped. | [optional] |
+| **next_cursor** | **String** |  | [optional] |
+| **sort** | **Array<String>** |  | [optional] |
+| **filters** | **Array<Hash<String, Object>>** |  | [optional] |
+| **group_by** | **Array<String>** |  | [optional] |
+| **measures** | **Array<String>** |  | [optional] |
+| **attribution** | [**Array<DatasetAttribution>**](DatasetAttribution.md) |  | [optional] |
+| **source_credit** | **String** |  | [optional] |
+| **withheld_tiers** | **Array<String>** |  | [optional] |
+| **withheld_columns** | **Array<String>** |  | [optional] |
+| **freshness** | [**AnimalWelfareAssurancesResponseFreshness**](AnimalWelfareAssurancesResponseFreshness.md) |  | [optional] |
+| **build** | [**AnimalWelfareAssurancesResponseBuild**](AnimalWelfareAssurancesResponseBuild.md) |  | [optional] |
+| **build_state** | [**DatasetBuildState**](DatasetBuildState.md) |  | [optional] |
+| **restriction** | **Hash<String, Object>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'pharmaobservatory'
+
+instance = PharmaObservatory::CompanyPeersResponse.new(
+  dataset: null,
+  grain: null,
+  object_type: null,
+  id: null,
+  scope: null,
+  columns: null,
+  rows: null,
+  total: null,
+  next_cursor: null,
+  sort: null,
+  filters: null,
+  group_by: null,
+  measures: null,
+  attribution: null,
+  source_credit: null,
+  withheld_tiers: null,
+  withheld_columns: null,
+  freshness: null,
+  build: null,
+  build_state: null,
+  restriction: null
+)
+```
+

data/docs/CompanyPeersRow.md

@@ -0,0 +1,54 @@
+# PharmaObservatory::CompanyPeersRow
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **company_id** | **String** | Company level: the company the row is about; the entry key for the companies object type. | [optional] |
+| **company_name** | **String** | Display name of the company. | [optional] |
+| **group_id** | **String** | Group level: the company's current ultimate parent; a root's group is itself. | [optional] |
+| **group_name** | **String** | Display name of the group. | [optional] |
+| **peer_company_id** | **String** | Company level: the peer company. | [optional] |
+| **peer_company_name** | **String** | Display name of the peer company. | [optional] |
+| **peer_group_id** | **String** | Group level: the peer's current ultimate parent; a root's group is itself. | [optional] |
+| **peer_group_name** | **String** | Display name of the peer's group. | [optional] |
+| **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] |
+| **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] |
+| **matched_area** | **Boolean** | True when the peer shares the company's primary therapeutic area. | [optional] |
+| **matched_size** | **Boolean** | True when the peer shares the company's size band. | [optional] |
+| **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] |
+| **lead_drug_name** | **String** | The peer's lead drug, the highest-phase live owned drug (ties: most trials). | [optional] |
+| **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] |
+| **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] |
+| **primary_area** | **String** | The peer's primary therapeutic area: the MeSH top-level category with the most live owned program trials. | [optional] |
+| **num_lead_trials** | **Integer** | Distinct lead-sponsored trials of the peer's subtree. | [optional] |
+| **size_band** | **String** | Band of num_lead_trials: 1-4, 5-19, 20-99 or 100+. | [optional] |
+
+## Example
+
+```ruby
+require 'pharmaobservatory'
+
+instance = PharmaObservatory::CompanyPeersRow.new(
+  company_id: null,
+  company_name: null,
+  group_id: null,
+  group_name: null,
+  peer_company_id: null,
+  peer_company_name: null,
+  peer_group_id: null,
+  peer_group_name: null,
+  peer_rank: null,
+  match_level: null,
+  matched_area: null,
+  matched_size: null,
+  lead_stage: null,
+  lead_drug_name: null,
+  biologic_share: null,
+  modality_band: null,
+  primary_area: null,
+  num_lead_trials: null,
+  size_band: null
+)
+```
+

data/docs/InvestorPortfolioRow.md

@@ -28,6 +28,7 @@
 | **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] |
 | **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] |
 | **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] |
+| **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] |
 | **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] |
 | **site_last_retrieved_at** | **Time** | When the investor's portfolio page was last retrieved with the company listed on it, in UTC. | [optional] |
 | **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(
   status_on_page: null,
   status_date: null,
   status_first_observed_at: null,
+  site_evidence_verified: null,
   source_url: null,
   site_last_retrieved_at: null,
   is_life_sciences_issuer: null

data/docs/LegalEntitiesApi.md

@@ -22,6 +22,7 @@ All URIs are relative to *https://pharmaobservatory.com*
 | [**legal_entities_inspections**](LegalEntitiesApi.md#legal_entities_inspections) | **GET** /api/v1/legal_entities/{id}/inspections | FDA inspections |
 | [**legal_entities_institutional_holdings**](LegalEntitiesApi.md#legal_entities_institutional_holdings) | **GET** /api/v1/legal_entities/{id}/institutional_holdings | Institutional holdings (SEC Form 13F) |
 | [**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) |
+| [**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) |
 | [**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 |
 | [**legal_entities_list**](LegalEntitiesApi.md#legal_entities_list) | **GET** /api/v1/legal_entities | List legal entities |
 | [**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
 - **Accept**: application/json
 
 
+## legal_entities_investor_portfolio
+
+> <InvestorPortfolioResponse> legal_entities_investor_portfolio(id, opts)
+
+Investor portfolio (offering filings and investor websites)
+
+### Examples
+
+```ruby
+require 'time'
+require 'pharmaobservatory'
+# setup authorization
+PharmaObservatory.configure do |config|
+  # Configure Bearer authorization (JWT): ApiBearerJwt
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = PharmaObservatory::LegalEntitiesApi.new
+id = 'edgar:0001114448' # String | 
+opts = {
+  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.
+  limit: 56, # Integer | Rows per page, up to 500 (default 50).
+  sort: 'sort_example', # String | Comma separated columns, a leading minus for descending: sort=a,-b.
+  group_by: 'group_by_example', # String | A dimension to group by; a date takes :year, :quarter or :month.
+  measure: 'measure_example' # String | count, sum(col), avg(col), min(col), max(col), median(col) or count_distinct(col).
+}
+
+begin
+  # Investor portfolio (offering filings and investor websites)
+  result = api_instance.legal_entities_investor_portfolio(id, opts)
+  p result
+rescue PharmaObservatory::ApiError => e
+  puts "Error when calling LegalEntitiesApi->legal_entities_investor_portfolio: #{e}"
+end
+```
+
+#### Using the legal_entities_investor_portfolio_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<InvestorPortfolioResponse>, Integer, Hash)> legal_entities_investor_portfolio_with_http_info(id, opts)
+
+```ruby
+begin
+  # Investor portfolio (offering filings and investor websites)
+  data, status_code, headers = api_instance.legal_entities_investor_portfolio_with_http_info(id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <InvestorPortfolioResponse>
+rescue PharmaObservatory::ApiError => e
+  puts "Error when calling LegalEntitiesApi->legal_entities_investor_portfolio_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **cursor** | **String** | The next_cursor of the previous page. Opaque; it is bound to the filters and the warehouse build that issued it. | [optional] |
+| **limit** | **Integer** | Rows per page, up to 500 (default 50). | [optional] |
+| **sort** | **String** | Comma separated columns, a leading minus for descending: sort&#x3D;a,-b. | [optional] |
+| **group_by** | **String** | A dimension to group by; a date takes :year, :quarter or :month. | [optional] |
+| **measure** | **String** | count, sum(col), avg(col), min(col), max(col), median(col) or count_distinct(col). | [optional] |
+
+### Return type
+
+[**InvestorPortfolioResponse**](InvestorPortfolioResponse.md)
+
+### Authorization
+
+[ApiBearerJwt](../README.md#ApiBearerJwt)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## legal_entities_legal_entity_sec_filings
 
 > <LegalEntitySecFilingsResponse> legal_entities_legal_entity_sec_filings(id, opts)