pharmaobservatory 0.1.6 → 0.1.7

data/docs/BrandRevenueResponse.md

@@ -0,0 +1,58 @@
+# PharmaObservatory::BrandRevenueResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **dataset** | **String** |  |  |
+| **grain** | **String** |  | [optional] |
+| **object_type** | **String** |  | [optional] |
+| **id** | **String** |  | [optional] |
+| **scope** | [**BiomarkerAssayEvidenceResponseScope**](BiomarkerAssayEvidenceResponseScope.md) |  | [optional] |
+| **columns** | [**Array<DatasetColumn>**](DatasetColumn.md) |  |  |
+| **rows** | [**Array<BrandRevenueRow>**](BrandRevenueRow.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** | [**BiomarkerAssayEvidenceResponseFreshness**](BiomarkerAssayEvidenceResponseFreshness.md) |  | [optional] |
+| **build** | [**BiomarkerAssayEvidenceResponseBuild**](BiomarkerAssayEvidenceResponseBuild.md) |  | [optional] |
+| **build_state** | [**DatasetBuildState**](DatasetBuildState.md) |  | [optional] |
+| **restriction** | **Hash<String, Object>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'pharmaobservatory'
+
+instance = PharmaObservatory::BrandRevenueResponse.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/BrandRevenueRow.md

@@ -0,0 +1,60 @@
+# PharmaObservatory::BrandRevenueRow
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **molecule_id** | **String** | The molecule key: the resolved drug a brand, a salt form or an investigational arm resolves to, and the entry key for the drugs object type. A member id (a salt or a folded trial arm) is not a value here; it redirects to its molecule. | [optional] |
+| **brand_key** | **String** | The brand key: an upper-case alphanumeric trade-name token (the brand's leading name tokens), the same key the brands pages use. Not a display name; brand_name is the display form. | [optional] |
+| **product_name** | **String** | The product name as filed. | [optional] |
+| **reporter_org_id** | **String** | Legal-entity level: the SEC filer that reported the figure, as filed (edgar:<CIK>). | [optional] |
+| **reporter_company_id** | **String** | Company level: the reporting company's company (null when unresolved). | [optional] |
+| **reporter_company_name** | **String** | Display name of the reporting company's company. | [optional] |
+| **reporter_group_id** | **String** | Group level: the reporting company's current ultimate parent company; a root company's group is itself. | [optional] |
+| **reporter_group_name** | **String** | Display name of the reporting company's group. | [optional] |
+| **fiscal_year** | **Integer** | The fiscal year of the figure. | [optional] |
+| **revenue_basis** | **String** | The standardised basis: worldwide, us, ex_us, region or country. | [optional] |
+| **geography** | **String** | The normalised geography: worldwide, us or ex_us for the spine (equal to the basis), the filer's own label for a region or country line. | [optional] |
+| **revenue_usd_millions** | **Float** | The figure in USD millions (null where no unit or exchange rate is available). | [optional] |
+| **revenue_amount** | **Float** | The figure as reported, in reporting_unit and revenue_currency; can be negative for adjustment or return lines. | [optional] |
+| **revenue_currency** | **String** | The filing's currency (ISO code). | [optional] |
+| **reporting_unit** | **String** | The filing's reporting unit (units, thousands, millions or billions); null when the filing did not state a readable one. | [optional] |
+| **as_reported** | **Boolean** | True when the figure comes from the filing for its own fiscal year, false when it is a comparative year read from a later filing. | [optional] |
+| **n_filings** | **Integer** | Distinct filings that report the figure. | [optional] |
+| **restated** | **Boolean** | True when several filings report the figure and differ by more than one percent. | [optional] |
+| **confidence** | **Float** | The extraction's confidence in the line, 0 to 1. | [optional] |
+| **source_url** | **String** | The link to the SEC filing the figure was extracted from. | [optional] |
+| **evidence_quote** | **String** | The sentence of the filing the figure was extracted from. | [optional] |
+| **match_method** | **String** | How the product name matched the brand: alias_prefix, product_prefix or curated_alias. A label of the mechanism, not a confidence. | [optional] |
+
+## Example
+
+```ruby
+require 'pharmaobservatory'
+
+instance = PharmaObservatory::BrandRevenueRow.new(
+  molecule_id: null,
+  brand_key: null,
+  product_name: null,
+  reporter_org_id: null,
+  reporter_company_id: null,
+  reporter_company_name: null,
+  reporter_group_id: null,
+  reporter_group_name: null,
+  fiscal_year: null,
+  revenue_basis: null,
+  geography: null,
+  revenue_usd_millions: null,
+  revenue_amount: null,
+  revenue_currency: null,
+  reporting_unit: null,
+  as_reported: null,
+  n_filings: null,
+  restated: null,
+  confidence: null,
+  source_url: null,
+  evidence_quote: null,
+  match_method: null
+)
+```
+

data/docs/CatalystsResponse.md

@@ -0,0 +1,58 @@
+# PharmaObservatory::CatalystsResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **dataset** | **String** |  |  |
+| **grain** | **String** |  | [optional] |
+| **object_type** | **String** |  | [optional] |
+| **id** | **String** |  | [optional] |
+| **scope** | [**BiomarkerAssayEvidenceResponseScope**](BiomarkerAssayEvidenceResponseScope.md) |  | [optional] |
+| **columns** | [**Array<DatasetColumn>**](DatasetColumn.md) |  |  |
+| **rows** | [**Array<CatalystsRow>**](CatalystsRow.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** | [**BiomarkerAssayEvidenceResponseFreshness**](BiomarkerAssayEvidenceResponseFreshness.md) |  | [optional] |
+| **build** | [**BiomarkerAssayEvidenceResponseBuild**](BiomarkerAssayEvidenceResponseBuild.md) |  | [optional] |
+| **build_state** | [**DatasetBuildState**](DatasetBuildState.md) |  | [optional] |
+| **restriction** | **Hash<String, Object>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'pharmaobservatory'
+
+instance = PharmaObservatory::CatalystsResponse.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/CatalystsRow.md

@@ -0,0 +1,90 @@
+# PharmaObservatory::CatalystsRow
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **event_id** | **String** | The event key: event_type, a colon and source_record_id. Unique. | [optional] |
+| **event_type** | **String** | What the event is: readout (a trial's primary completion), patent_cliff (loss of exclusivity), pdufa (an FDA decision date or advisory committee) or press_release (a Benzinga press-release event). | [optional] |
+| **event_category** | **String** | The kind of event within its type. readout: primary_completion. patent_cliff: the cliff basis (curated_loe, orange_book_patent, pte_expiry, bpcia_exclusivity). pdufa: the calendar's own category (pdufa, advisory_committee and others). press_release: the Benzinga event token, lowercased (clinical_trial_result, pdufa_assignment, data_presentation and others). Open vocabulary on the last two. | [optional] |
+| **source** | **String** | The lane the row came from: ctgov (ClinicalTrials.gov), drug_exclusivity (the exclusivity registers), benzinga, both or sec_extraction (the PDUFA calendar, the same values as pdufa_dates) or benzinga_press_release. | [optional] |
+| **source_record_id** | **String** | The key of the row in its source, to join back to trials.trial_id, drug_patent_cliff.drug_id, pdufa_dates.pdufa_date_id or the press-release event id. | [optional] |
+| **restriction_tier** | **String** | none for an open row (ClinicalTrials.gov, the exclusivity registers, the SEC lane of the PDUFA calendar); licensable for a Benzinga row (the calendar or a press release). The api view gates rows on it. | [optional] |
+| **event_date** | **Date** | The date the calendar sorts on: a readout's primary completion date, the cliff date, the decision date, or the end of the press-release event's date window. | [optional] |
+| **event_year** | **Integer** | The calendar year of event_date; the x axis of a by-year count. | [optional] |
+| **date_start** | **Date** | Start of the date interval the source states (the first day of the month for a readout the registry filed by month). | [optional] |
+| **date_end** | **Date** | End of the date interval the source states. | [optional] |
+| **date_precision** | **String** | Precision of the date (day, month, quarter, half, year, fuzzy, relative). A readout is month where the registry filed only a month, in which case event_date is the last day of that month. | [optional] |
+| **date_phrase** | **String** | The date as the source words it (an ISO date for a readout and a cliff; the press release's own phrase, such as H2 2026). | [optional] |
+| **date_status** | **String** | For a readout, whether the registry's completion date is estimated or actual (an anticipated date counts as estimated); null on the other legs. | [optional] |
+| **trial_id** | **String** | The ClinicalTrials.gov registry id (readout rows). | [optional] |
+| **trial_title** | **String** | The trial's brief title (readout rows). | [optional] |
+| **phase** | **String** | The registry's phase code (readout rows). | [optional] |
+| **phase_label** | **String** | The trial phase as a display label (readout rows). | [optional] |
+| **overall_status** | **String** | The registry's overall status code (readout rows). | [optional] |
+| **related_trial_ids** | **Array<String>** | The registry ids a press-release event names; null on the other legs. | [optional] |
+| **outcome** | **String** | The outcome a press-release event reports (a decided event stays in the forward book); null on the other legs. | [optional] |
+| **indication_text** | **String** | The indication as the source words it (PDUFA and press-release rows). | [optional] |
+| **condition_id** | **String** | The condition key (PDUFA rows). | [optional] |
+| **condition_name** | **String** | The condition's name (PDUFA rows). | [optional] |
+| **source_type** | **String** | Kind of source document (SEC filing for the SEC lane, Press release for a press-release event); null on the open legs. | [optional] |
+| **source_url** | **String** | Link to the source document (PDUFA and press-release rows). | [optional] |
+| **drug_name** | **String** | The drug name as filed or its display name; null on a readout (its drugs are the list drug_ids). | [optional] |
+| **drug_id** | **String** | The drug key of a patent-cliff, PDUFA or press-release row; null on a readout and where the drug did not resolve. | [optional] |
+| **molecule_id** | **String** | The molecule key (PDUFA and press-release rows). | [optional] |
+| **drug_ids** | **Array<String>** | Every drug key of the event: a readout carries each drug of its trial, sorted; the other legs carry their one drug, or an empty array. The drug predicate of a watchlist is '<drug>' = ANY(drug_ids). | [optional] |
+| **sponsor_role** | **String** | What the organization is on the row: lead_sponsor (readout), applicant (patent cliff, the FDA applicant of record), sponsor (PDUFA) or issuer (press release, the company the ticker names). | [optional] |
+| **sponsor_name** | **String** | The organization's name as filed; null on a press-release row (the source names a ticker, not an organization). | [optional] |
+| **sponsor_org_id** | **String** | Legal-entity level: the organization record (a readout's lead sponsor, a cliff's applicant, a PDUFA row's filing organization; for a press release the identity hub's resolved entity for the ticker). Null when unresolved. | [optional] |
+| **sponsor_company_id** | **String** | Company level: the company the organization belongs to (null when unresolved). | [optional] |
+| **sponsor_company_name** | **String** | Display name of the organization's company. | [optional] |
+| **sponsor_group_id** | **String** | Group level: the organization's current ultimate parent company; a root company's group is itself. | [optional] |
+| **sponsor_group_name** | **String** | Display name of the organization's group. | [optional] |
+| **ticker** | **String** | Exchange ticker (PDUFA and press-release rows). | [optional] |
+
+## Example
+
+```ruby
+require 'pharmaobservatory'
+
+instance = PharmaObservatory::CatalystsRow.new(
+  event_id: null,
+  event_type: null,
+  event_category: null,
+  source: null,
+  source_record_id: null,
+  restriction_tier: null,
+  event_date: null,
+  event_year: null,
+  date_start: null,
+  date_end: null,
+  date_precision: null,
+  date_phrase: null,
+  date_status: null,
+  trial_id: null,
+  trial_title: null,
+  phase: null,
+  phase_label: null,
+  overall_status: null,
+  related_trial_ids: null,
+  outcome: null,
+  indication_text: null,
+  condition_id: null,
+  condition_name: null,
+  source_type: null,
+  source_url: null,
+  drug_name: null,
+  drug_id: null,
+  molecule_id: null,
+  drug_ids: null,
+  sponsor_role: null,
+  sponsor_name: null,
+  sponsor_org_id: null,
+  sponsor_company_id: null,
+  sponsor_company_name: null,
+  sponsor_group_id: null,
+  sponsor_group_name: null,
+  ticker: null
+)
+```
+

data/docs/CliaCertificatesResponse.md

@@ -0,0 +1,58 @@
+# PharmaObservatory::CliaCertificatesResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **dataset** | **String** |  |  |
+| **grain** | **String** |  | [optional] |
+| **object_type** | **String** |  | [optional] |
+| **id** | **String** |  | [optional] |
+| **scope** | [**BiomarkerAssayEvidenceResponseScope**](BiomarkerAssayEvidenceResponseScope.md) |  | [optional] |
+| **columns** | [**Array<DatasetColumn>**](DatasetColumn.md) |  |  |
+| **rows** | [**Array<CliaCertificatesRow>**](CliaCertificatesRow.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** | [**BiomarkerAssayEvidenceResponseFreshness**](BiomarkerAssayEvidenceResponseFreshness.md) |  | [optional] |
+| **build** | [**BiomarkerAssayEvidenceResponseBuild**](BiomarkerAssayEvidenceResponseBuild.md) |  | [optional] |
+| **build_state** | [**DatasetBuildState**](DatasetBuildState.md) |  | [optional] |
+| **restriction** | **Hash<String, Object>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'pharmaobservatory'
+
+instance = PharmaObservatory::CliaCertificatesResponse.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/CliaCertificatesRow.md

@@ -0,0 +1,80 @@
+# PharmaObservatory::CliaCertificatesRow
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **clia_number** | **String** | The ten-character CLIA certificate number. | [optional] |
+| **lab_name** | **String** | The laboratory's name as listed on the certificate. | [optional] |
+| **firm_name** | **String** | The organization the certificate resolved to (its canonical name). | [optional] |
+| **firm_org_id** | **String** | Legal-entity level: the organization record the firm resolved to (null when the firm did not resolve). | [optional] |
+| **firm_company_id** | **String** | Company level: the firm's company (null when unresolved); the entry key for the companies object type. | [optional] |
+| **firm_company_name** | **String** | Display name of the firm's company. | [optional] |
+| **firm_group_id** | **String** | Group level: the firm's current ultimate parent; a root's group is itself. | [optional] |
+| **firm_group_name** | **String** | Display name of the firm's group. | [optional] |
+| **match_tier** | **String** | How the certificate was attached to the organization: high, medium or low. | [optional] |
+| **match_confidence** | **Float** | The matcher's confidence, 0 to 1. | [optional] |
+| **city** | **String** | The laboratory's city. | [optional] |
+| **state_region** | **String** | The laboratory's state. | [optional] |
+| **postal5** | **String** | The five-digit postal code. | [optional] |
+| **country** | **String** | The country code. | [optional] |
+| **latitude** | **Float** | Latitude in degrees (WGS84), for the map tool. | [optional] |
+| **longitude** | **Float** | Longitude in degrees (WGS84), for the map tool. | [optional] |
+| **geocode_precision** | **String** | What a pin locates (an address, a postal code or a city). | [optional] |
+| **coord_source** | **String** | Where the coordinates came from. | [optional] |
+| **is_active** | **Boolean** | True when the certificate is active on the file. | [optional] |
+| **certificate_type** | **String** | The CLIA certificate type (for example Compliance, Accreditation or Waiver). | [optional] |
+| **complexity_ceiling** | **String** | The highest test complexity the certificate permits. | [optional] |
+| **accreditor_claimed** | **Array<String>** | The accreditation body the file names. | [optional] |
+| **accreditor_confirmed** | **Array<String>** | The accreditation body confirmed against the accreditor's own list. | [optional] |
+| **has_cap_accreditation** | **Boolean** | True when the laboratory holds College of American Pathologists (CAP) accreditation. | [optional] |
+| **has_ashi_accreditation** | **Boolean** | True when the laboratory holds American Society for Histocompatibility and Immunogenetics (ASHI) accreditation. | [optional] |
+| **has_aabb_accreditation** | **Boolean** | True when the laboratory holds AABB (formerly American Association of Blood Banks) accreditation. | [optional] |
+| **facility_type** | **String** | The laboratory's facility type on the file. | [optional] |
+| **annual_test_volume** | **Integer** | Reported annual test volume. | [optional] |
+| **test_volume_source** | **String** | Where the volume figure came from. | [optional] |
+| **lab_site_count** | **Integer** | How many sites the laboratory reports. | [optional] |
+| **pos_vintage** | **String** | The vintage of the CMS Provider of Services file. | [optional] |
+| **as_of** | **Date** | The build date of the figures. | [optional] |
+
+## Example
+
+```ruby
+require 'pharmaobservatory'
+
+instance = PharmaObservatory::CliaCertificatesRow.new(
+  clia_number: null,
+  lab_name: null,
+  firm_name: null,
+  firm_org_id: null,
+  firm_company_id: null,
+  firm_company_name: null,
+  firm_group_id: null,
+  firm_group_name: null,
+  match_tier: null,
+  match_confidence: null,
+  city: null,
+  state_region: null,
+  postal5: null,
+  country: null,
+  latitude: null,
+  longitude: null,
+  geocode_precision: null,
+  coord_source: null,
+  is_active: null,
+  certificate_type: null,
+  complexity_ceiling: null,
+  accreditor_claimed: null,
+  accreditor_confirmed: null,
+  has_cap_accreditation: null,
+  has_ashi_accreditation: null,
+  has_aabb_accreditation: null,
+  facility_type: null,
+  annual_test_volume: null,
+  test_volume_source: null,
+  lab_site_count: null,
+  pos_vintage: null,
+  as_of: null
+)
+```
+